diff --git a/marked/Rel-16/24_series/24010/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/Rel-16/24_series/24010/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd8c935149a42822f2c6bc07209d28ef7ee7de5e --- /dev/null +++ b/marked/Rel-16/24_series/24010/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2def51db8ebc123235e7cfc0cb9c24634dbfddc1c5a355cabe903ba855ffeb9b +size 72832 diff --git a/marked/Rel-16/24_series/24010/523ab7b925beb555f88b2e1e1336974f_img.jpg b/marked/Rel-16/24_series/24010/523ab7b925beb555f88b2e1e1336974f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d62ae64cef306d285781f3ad0ee7603ef724886 --- /dev/null +++ b/marked/Rel-16/24_series/24010/523ab7b925beb555f88b2e1e1336974f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b3a15556967a254fc88eca1c467d4c3685cd1553822baaab21985997b7d54be +size 53498 diff --git a/marked/Rel-16/24_series/24010/6ca05954842b17f14dfd52f26b9d43d2_img.jpg b/marked/Rel-16/24_series/24010/6ca05954842b17f14dfd52f26b9d43d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..861ba78eda19c3a99fdd9d53355b65d01153a19e --- /dev/null +++ b/marked/Rel-16/24_series/24010/6ca05954842b17f14dfd52f26b9d43d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:768f42c8162bb29f6ba7feb856c6b8f3871bcea1971a6c9b31395317f5e5add7 +size 16131 diff --git a/marked/Rel-16/24_series/24010/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg b/marked/Rel-16/24_series/24010/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d60db156943507306de6db7db2ac7a2ca79d45a --- /dev/null +++ b/marked/Rel-16/24_series/24010/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b276e9a3ec3974c0cfdb779066d4910f9109d269918426f923302c2628db5d5 +size 34211 diff --git a/marked/Rel-16/24_series/24010/db395493033edacd83e212049fd55715_img.jpg b/marked/Rel-16/24_series/24010/db395493033edacd83e212049fd55715_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e6a58ecd00378658d6d4ed60aa7a748ada9b2a6 --- /dev/null +++ b/marked/Rel-16/24_series/24010/db395493033edacd83e212049fd55715_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da728c11dd1eb5268a51115058b94ef04d82bfe3a5a8a054002653d5f595c2dd +size 29848 diff --git a/marked/Rel-16/24_series/24010/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/marked/Rel-16/24_series/24010/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6c56ed8006ccff190eef49424d5861a3be3abef9 --- /dev/null +++ b/marked/Rel-16/24_series/24010/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9313d62e9b2bcf4325b556499eb7c300947b39e42899db67ce583099a38e4ade +size 71998 diff --git a/marked/Rel-16/24_series/24010/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/24_series/24010/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e9e0ee63a0eb044a1564d6d3572f9fe5439eedc --- /dev/null +++ b/marked/Rel-16/24_series/24010/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6cb2e0f112b45e7b2ef42c0314e83a61b731ed6de35e22a9bcb5da37aa3de799 +size 140833 diff --git a/marked/Rel-16/24_series/24010/e90987faabad6a6665cd8ed1151dc474_img.jpg b/marked/Rel-16/24_series/24010/e90987faabad6a6665cd8ed1151dc474_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..64293e3ae8c7654b180d4933b9ec2d910510b00a --- /dev/null +++ b/marked/Rel-16/24_series/24010/e90987faabad6a6665cd8ed1151dc474_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a3f3ec3861731558c79f56f8ac4819254b9d6020d469d31d52f3775b47ff400 +size 24139 diff --git a/marked/Rel-16/24_series/24010/raw.md b/marked/Rel-16/24_series/24010/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c58c8919cb9163525190c5556e39fec9caa7088a --- /dev/null +++ b/marked/Rel-16/24_series/24010/raw.md @@ -0,0 +1,1053 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 1.1 References ..... | 6 | +| 1.2 Abbreviations ..... | 8 | +| 2 Generic procedures for the control of supplementary services..... | 9 | +| 2.1 Overview of the generic protocol and its scope ..... | 9 | +| 2.2 Functional procedures for the control of supplementary services..... | 9 | +| 2.2.1 General ..... | 9 | +| 2.2.2 Separate Messages Category ..... | 10 | +| 2.2.3 Common Information Element Category ..... | 10 | +| 2.2.4 Call related supplementary service procedures ..... | 10 | +| 2.2.4.1 Supplementary service procedures at call establishment or call clearing..... | 10 | +| 2.2.4.1.1 Encoding of the Facility IEI for different supplementary services ..... | 11 | +| 2.2.4.1.2 Supplementary service procedures at network initiated mobile originating call establishment ..... | 11 | +| 2.2.4.2 Supplementary service procedures during the call ..... | 12 | +| 2.2.4.3 Handling of protocol errors in call related SS procedures ..... | 12 | +| 2.2.4.4 Handling of other errors in call related SS procedures ..... | 12 | +| 2.2.5 Call independent supplementary service procedures..... | 13 | +| 2.2.5.1 Introduction..... | 13 | +| 2.2.5.2 Handling of protocol errors in call independent SS procedures ..... | 13 | +| 2.2.5.3 Handling of other errors in call independent SS procedures ..... | 13 | +| 2.2.6 Multiple supplementary service invocations ..... | 13 | +| 2.2.6.1 Call related supplementary service procedures ..... | 13 | +| 2.2.6.2 Call independent supplementary service procedures..... | 14 | +| 2.2.7 Recovery procedures ..... | 14 | +| 2.2.7.1 Call related supplementary service recovery procedures ..... | 14 | +| 2.2.7.2 Call independent supplementary service recovery procedures..... | 14 | +| 2.2.8 Generic protocol error handling for the component part of supplementary services operations ..... | 14 | +| 2.2.8.1 Call related component errors..... | 14 | +| 2.2.8.2 Call independent component errors ..... | 14 | +| 2.2.8.2.1 Single component errors..... | 14 | +| 2.2.8.2.2 Multiple component errors ..... | 15 | +| 3 Supplementary service support procedures..... | 15 | +| 3.1 General ..... | 15 | +| 3.2 Supplementary service support establishment ..... | 15 | +| 3.2.1 Supplementary service support establishment at the originating side..... | 15 | +| 3.2.2 Supplementary service support establishment at the terminating side..... | 15 | +| 3.3 Supplementary service support information transfer phase ..... | 15 | +| 3.4 Supplementary service support release ..... | 15 | +| 3.5 Recovery procedures..... | 16 | +| 3.6 Message flow (single operation example)..... | 16 | +| 3.6.1 Mobile station initiated supplementary service transaction ..... | 16 | +| 3.6.2 Network initiated supplementary service transaction..... | 17 | +| 3.7 Handling of unknown, unforeseen, and erroneous protocol data..... | 17 | +| 3.7.1 General ..... | 17 | +| 3.7.2 Message too short..... | 18 | +| 3.7.3 Unknown or unforeseen transaction identifier ..... | 18 | +| 3.7.4 Unknown or unforeseen message type ..... | 18 | +| 3.7.5 Non-semantical mandatory Information Element Error ..... | 18 | +| 3.7.6 Unknown and Unforeseen IEs in the non-imperative part ..... | 19 | +| 3.7.6.1 IEs unknown in the message ..... | 19 | +| 3.7.6.2 Out of sequence IEs ..... | 19 | +| 3.7.6.3 Repeated IEs ..... | 19 | +| 3.7.7 Non-imperative message part errors..... | 19 | +| 3.7.7.1 Syntactically incorrect optional IEs (other than Facility) ..... | 19 | +| 3.7.7.2 Conditional IE errors ..... | 19 | + +| | | | +|-------------------------------|------------------------------------------------------------------------------|-----------| +| 4 | Password management..... | 20 | +| 4.1 | Password check..... | 20 | +| 4.1.1 | Successful procedure..... | 20 | +| 4.1.2 | Error cases ..... | 20 | +| 4.2 | Password registration ..... | 21 | +| 4.2.1 | Successful procedure..... | 21 | +| 4.2.2 | Error cases ..... | 21 | +| 4.3 | Cross phase compatibility ..... | 22 | +| 5 | Supplementary service cross phase compatibility ..... | 23 | +| 5.1 | Cross phase, or cross protocol version, interworking ..... | 23 | +| 5.2 | Objectives..... | 23 | +| 5.3 | Supplementary service compatibility philosophy ..... | 23 | +| 5.4 | Compatibility mechanisms..... | 24 | +| 5.4.1 | SS screening indicator ..... | 24 | +| 5.4.2 | SS version indicator..... | 24 | +| 5.4.3 | Protocol extension mechanism..... | 24 | +| 5.5 | SS compatibility procedures..... | 24 | +| 5.5.1 | Screening indicator procedures ..... | 24 | +| 5.5.1.1 | MS procedure..... | 24 | +| 5.5.1.2 | Network procedure ..... | 25 | +| 5.5.2 | SS version indicator procedures ..... | 25 | +| 5.5.2.1 | MS procedure..... | 25 | +| 5.5.2.1.1 | MS procedure for version 3 or higher operations ..... | 25 | +| 5.5.2.2 | Network procedure ..... | 26 | +| 5.5.2.2.1 | Call independent SS activity ..... | 26 | +| 5.5.2.2.2 | Call related SS activity..... | 26 | +| 5.5.3 | Extension mechanism procedures ..... | 26 | +| 5.5.4 | SS version indicator - MAP context interworking ..... | 26 | +| 5.5.4.1 | Call independent interworking..... | 26 | +| 5.5.4.2 | Call related interworking ..... | 27 | +| 5.6 | Development of future protocol versions..... | 27 | +| 6 | Forward Check SS Indication ..... | 27 | +| Annex A (normative): | Notation used for stage 3 description of supplementary services ..... | 28 | +| A.1 | General structure of the SS stage 3 diagrams ..... | 28 | +| A.1.1 | Exceptional release procedures ..... | 29 | +| A.2 | Messages used to transport operations..... | 29 | +| A.3 | Contents of messages..... | 29 | +| Annex B (informative): | Change history..... | 31 | + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3rd Generation Partnership Project (3GPP). + +The present document defines the general aspects of the specification of supplementary services at the layer 3 radio interface within the 3GPP system. + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document gives the general aspects of the specification of supplementary services at the layer 3 radio interface. + +3GPP TS 24.08x and 24.09x-series specify the procedures used at the radio interface (reference point Um as defined in 3GPP 24.002) for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of supplementary services. Provision and withdrawal of supplementary services is an administrative matter between the mobile subscriber and the service provider and cause no signalling on the radio interface. + +3GPP TS 24.008 [48] and 3GPP TS 24.080 [27] specifies the formats and coding for the supplementary services. + +Definitions and descriptions of supplementary services are given in 3GPP TS 22.004 and 3GPP TS 22.08x and 22.09x-series. + +Technical realization of supplementary services is described in 3GPP TS 23.011 and GSM 23.08x and 23.09x-series. + +The procedures for Call Control, Mobility Management and Radio Resource management at the layer 3 radio interface are defined in 3GPP TS 24.007 [49] and 3GPP TS 24.008 [48]. + +## 1.1 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 21.905: "Abbreviations and acronyms". +- [2] 3GPP TS 22.004: "General on supplementary services". +- [3] 3GPP TS 22.081: "Line identification supplementary services - Stage 1". +- [4] 3GPP TS 22.082: "Call Forwarding (CF) supplementary services - Stage 1". +- [5] 3GPP TS 22.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 1". +- [6] 3GPP TS 22.084: "MultiParty (MPTY) supplementary services - Stage 1". +- [7] 3GPP TS 22.085: "Closed User Group (CUG) supplementary services - Stage 1". +- [8] 3GPP TS 22.086: "Advice of charge (AoC) supplementary services - Stage 1". +- [9] 3GPP TS 22.088: "Call Barring (CB) supplementary services - Stage 1". +- [10] 3GPP TS 22.090: "Unstructured Supplementary Services Data (USSD) - Stage 1". +- [11] 3GPP TS 22.091: "Explicit Call Transfer (ECT) supplementary service - Stage 1". +- [12] 3GPP TS 23.011: "Technical realization of supplementary services". +- [13] 3GPP TS 23.081: "Line identification supplementary services - Stage 2". +- [14] 3GPP TS 23.082: "Call Forwarding (CF) supplementary services - Stage 2". +- [15] 3GPP TS 23.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 2". +- [16] 3GPP TS 23.084: "MultiParty (MPTY) supplementary services - Stage 2". + +- [17] 3GPP TS 23.085: "Closed User Group (CUG) supplementary services - Stage 2". +- [18] 3GPP TS 23.086: "Advice of Charge (AoC) supplementary services - Stage 2". +- [19] 3GPP TS 23.088: "Call Barring (CB) supplementary services - Stage 2". +- [20] 3GPP TS 23.090: "Unstructured supplementary services operation - Stage 2". +- [21] 3GPP TS 23.091: "Explicit Call Transfer (ECT) supplementary service - Stage 2". +- [22] 3GPP TS 24.002: "GSM Public Land Mobile Network (PLMN) access reference configuration". +- [23] 3GPP TS 24.003: "Mobile Station - Base Stations system (MS - BSS) interface; Channel structures and access capabilities". +- [24] 3GPP TS 24.004: "Layer 1; General requirements". +- [25] 3GPP TS 44.005: "Data Link (DL) layer; General aspects". +- [26] 3GPP TS 44.006: "Mobile Station - Base Station System (MS - BSS) interface; Data Link (DL) layer specification". +- [27] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [28] 3GPP TS 24.081: "Line identification supplementary services - Stage 3". +- [29] 3GPP TS 24.082: "Call Forwarding (CF) supplementary services - Stage 3". +- [30] 3GPP TS 24.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 3". +- [31] 3GPP TS 24.084: "MultiParty (MPTY) supplementary services - Stage 3". +- [32] 3GPP TS 24.085: "Closed User Group (CUG) supplementary services - Stage 3". +- [33] 3GPP TS 24.086: "Advice of Charge (AoC) supplementary services - Stage 3". +- [34] 3GPP TS 24.088: "Call Barring (CB) supplementary services - Stage 3". +- [35] 3GPP TS 24.090: "Unstructured supplementary services operation - Stage 3". +- [36] 3GPP TS 24.091: "Explicit Call Transfer (ECT) supplementary service - Stage 3". +- [37] 3GPP TS 45.001: "Physical layer on the radio path; General description". +- [38] 3GPP TS 45.002: "Multiplexing and multiple access on the radio path". +- [39] 3GPP TS 45.003: "Channel coding". +- [40] 3GPP TS 45.004: "Modulation". +- [41] 3GPP TS 45.005: "Radio transmission and reception". +- [42] 3GPP TS 45.008: "Radio subsystem link control". +- [43] 3GPP TS 45.010: "Radio subsystem synchronization". +- [44] GSM 05.90: "Digital cellular telecommunications system; GSM Electro Magnetic Compatibility (EMC) considerations". +- [45] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [46] 3GPP TS 29.011: "Signalling interworking for supplementary services". +- [47] CCITT Recommendation Q.774 (White Book): "Specifications of Signalling System No.7; Transaction capabilities procedures". +- [48] 3GPP TS 24.008: "Core network protocols; Stage 3". + +[49] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". + +## 1.2 Abbreviations + +Abbreviations used in the present document are listed in 3GPP TS 21.905. + +# --- 2 Generic procedures for the control of supplementary services + +## 2.1 Overview of the generic protocol and its scope + +One generic protocol is defined for the control of supplementary services at the radio interface. This protocol operates at layer 3 of the radio interface and assumes the use of layers 1 and 2 conform to 3GPP TS 45-series and 3GPP TS 44.004, 3GPP TS 44.005 and 3GPP TS 44.006. The generic protocol uses the acknowledged information transfer service available at the layer 2 - layer 3 interface. + +The Functional protocol is based on the use of the Facility information element and the FACILITY message as well as other specific functional messages specified in 3GPP TS 24.080 [27]. + +Standardised services use a functional protocol. A transparent protocol is also provided. The functional protocol requires the knowledge of the related supplementary service by the mobile equipment supporting it. This facilitates mobile equipment operation without human intervention by defining semantics for the protocol elements which the mobile equipment can process on its own. + +## 2.2 Functional procedures for the control of supplementary services + +### 2.2.1 General + +This clause specifies the functional signalling procedures for the control of supplementary services at the radio interface. + +The Functional protocol utilises functions and services provided by 3GPP TS 24.008 [48] basic call control procedures and the functions of the data link layer as defined in 3GPP TS 44.00. + +In UMTS only, integrity protected signalling (see TS 24.008 [48], subclause 'Integrity Protection of Signalling Messages,' and in general, see 3GPP TS 33.102) is mandatory. In UMTS only, all protocols shall use integrity protected signalling. Integrity protection of all SS signalling messages is the responsibility of lower layers. It is the network which activates integrity protection. This is done using the security mode control procedure (TS 25.331). + +The defined procedures specify the basic methodology for the control (e.g. registration, erasure, invocation, etc.) of supplementary services. + +The first category, called the Separate Message Category utilises separate message types to indicate a desired function. The hold and retrieve families of messages are identified for this category. + +The second category called the Common Information Element Category utilises the Facility information element to transport the protocol defined in 3GPP TS 24.080 [27]. The use of the Facility information element is common to many services, and its contents indicates what type of procedure is being requested. This category can be signalled both in the mobile to network and the network to mobile directions. + +The control of supplementary services includes the following cases: + +- a) the request of supplementary service procedures during the establishment of a call; +- b) the request of supplementary service procedures during the clearing of a call; +- c) the request of call related supplementary service procedures during the active state of a call; +- d) the request of supplementary service procedures independent from an active call; +- e) the request of multiple, different supplementary service procedures within a single message; +- f) the request of supplementary service procedures related to different calls. + +The correlation of a call related supplementary service operation and the call which it modifies is provided by use of the transaction identifier (cases a, b, c, e and f). + +The correlation of supplementary service operations and their responses, is provided by the combination of the transaction identifier of the messages containing the Facility information element and the Invoke identifier present within the Facility information element itself (cases a, b, c, d, e and f). + +The identification of different supplementary service operations within one single message is provided by the Invoke identifier present within the Facility information element itself (case e). + +The identification of supplementary service related operations to different calls is provided by using different messages with the corresponding transaction identifier of the appropriate call (case f), i.e. different transaction identifier values are used to identify each call individually. + +### 2.2.2 Separate Messages Category + +The messages defined in this clause are specified as separate functional messages for the request, acknowledgement and rejection of specific procedures. These procedures can only be performed during the active phase of a call. The functions of these messages are not to be duplicated or overlapped by the ones of the Common Information Element Category. + +The following separate messages are defined: + +| | | +|------------------|----------------------| +| HOLD | RETRIEVE | +| HOLD ACKNOWLEDGE | RETRIEVE ACKNOWLEDGE | +| HOLD REJECT | RETRIEVE REJECT. | + +For detailed description of the Hold and Retrieve functions see 3GPP TS 24.083. + +### 2.2.3 Common Information Element Category + +The Common Information Element Category uses operations defined in 3GPP TS 24.080 [27] for supplementary services signalling. Procedures are initiated by sending an operation including an invoke component. The invoke component may yield a Return Error, Return Result or Reject component (also included in an operation) depending on the outcome of the procedure. + +The operation state machines, and procedures for management of Invoke IDs specified in CCITT Recommendation Q.774 White Book are used. + +A REGISTER message, a FACILITY message or certain existing 3GPP TS 24.008 [48] Call Control message is used to carry the Facility information element which includes these operations. These operations request, acknowledge or reject the desired supplementary service procedure. + +### 2.2.4 Call related supplementary service procedures + +#### 2.2.4.1 Supplementary service procedures at call establishment or call clearing + +For call related supplementary service procedures initiated at call establishment or call clearing, the messages for call control specified in 3GPP TS 24.008 [48] are utilised to transport Facility information elements. This enables, for example the originating mobile user to send a supplementary service invoke component within a SETUP message and to receive from the network a Return result, Return error, or Reject component type within the Facility information element in an ALERTING message, CONNECT message, or any other appropriate message. + +When a supplementary service invoke component is included within a SETUP message, the originating mobile station shall encode the Facility information element identifier according to one of the three possible ways (see 3GPP TS 24.008 [48]): + +- simple recall alignment; +- advanced recall alignment; +- recall alignment not essential. + +Encoding of the Facility IEI within the SETUP message for different supplementary services is described in the subclause 2.2.4.1.1. + +The three different ways of encoding are required to support the network initiated mobile originating call establishment (see subclause 2.2.4.1.2 and 3GPP TS 24.008 [48]). + +##### 2.2.4.1.1 Encoding of the Facility IEI for different supplementary services + +The table 2.1 shows the encoding of the Facility IEI within the SETUP message for different supplementary services. + +**Table 2.1: Encoding of the Facility IE within the SETUP message** + +| Service | Facility IE Encoding | +|---------|---------------------------| +| CUG | simple recall alignment | +| UUS | Advanced recall alignment | + +##### 2.2.4.1.2 Supplementary service procedures at network initiated mobile originating call establishment + +The Facility and SS Version IE received in the set-up container of the CC\_ESTABLISHMENT message shall be handled according to the following rules: + +The mobile station shall examine the IEI of the Facility IE. + +If the Facility IEI coding is "simple recall alignment", the mobile station shall copy the Facility IE and SS Version IE from the set-up container to the SETUP message without verifying or modifying the contents of these information elements. + +If the Facility IEI is encoded as "advanced recall alignment", the mobile station shall examine the SS Version IE. + +If the mobile station recognises the protocol defined by the SS Version IE, it shall attempt to decode the Facility IE. If the decoding is successful, and the operation is supported by the mobile station, the mobile station shall copy this Facility IE and SS Version IE to the SETUP message. The mobile station shall also store relevant supplementary service information contained within the Facility IE so that any reply to this Facility IE sent by the network will be properly understood and processed. + +If the mobile station does not recognise the SS Version IE, or the decoding of the Facility IE is unsuccessful, then the call is rejected as described in 3GPP TS 24.008 [48]. + +If the Facility IE is encoded as "recall alignment not essential", the mobile station shall examine the SS Version IE . + +If the mobile station recognises the protocol defined by the SS Version IE, it shall attempt to decode the Facility IE. + +If the decoding is successful, and the operation is supported by the mobile station, the mobile station shall copy this Facility IE and SS Version IE into the SETUP message. The mobile station shall also store relevant supplementary service information contained within the Facility IE so that any reply to this Facility IE sent by the network will be properly understood and processed. + +If the mobile station does not recognise the SS Version IE, or the decoding of the Facility IE is unsuccessful, then the SS Version IE and Facility IE are discarded, and NOT copied into the SETUP message. + +NOTE: A mobile station may include a Facility IE without an associated SS Version IE. This would indicate that the SS operation is encoded using Phase 1 protocols. + +#### 2.2.4.2 Supplementary service procedures during the call + +For call related supplementary service procedures during the active state of a call, the FACILITY message is used for the exchange of the Facility information elements. + +Note that the FACILITY message can also be used for this purpose in all states after the SETUP message has been sent. + +If the supplementary service procedure is related only to a single call, the FACILITY message will use the transaction identifier and protocol discriminator of this call. + +If the supplementary service procedure affects more than one call, the FACILITY message may use the transaction identifier and protocol discriminator of one of these calls. + +If a call related FACILITY message is sent using the transaction identifier of a call in progress, and this call is cleared due to call related causes, then the transaction identifier may not be cleared simultaneously in all cases. Depending upon the supplementary service invoked, one of the following will occur: + +- the network or mobile user may retain both the connection and the transaction identifier association and may send a response within a Facility information element in a FACILITY message prior to the initiation of the normal call clearing procedures; or +- the network or mobile user may send a response with a Facility information element in the first clearing message (i.e. DISCONNECT, RELEASE or RELEASE COMPLETE message). + +#### 2.2.4.3 Handling of protocol errors in call related SS procedures + +Messages containing a Facility information element shall be checked for protocol errors before the contents of the Facility IE is acted on. The checks shall be performed in the following order: + +- 1) The message carrying the Facility IE shall be checked for protocol errors as specified in 3GPP TS 24.008 [48]. If a protocol error is found then the procedures in 3GPP TS 24.008 [48] apply. +- 2) The contents of the Facility IE shall be checked for protocol errors as specified in subclause 2.2.8. If a protocol error is found then the procedures in subclause 2.2.8 apply. + +#### 2.2.4.4 Handling of other errors in call related SS procedures + +If the tests specified in subclause 2.2.4.3 have been passed without the detection of a protocol error, the receiver will attempt to process the contents of the Facility Information Element. If errors occur during this processing (e.g. system failure, or information in the Facility IE is incompatible with the requested operation) then the procedures specified in the individual service specifications apply. + +Examples of the behaviour that could occur in this case are: + +- the network or MS clears the call and rejects the supplementary services request by means of a clearing message which contains a Return Error component with the appropriate parameter in the Facility Information Element; +- the network and MS continue to process the call according to normal 3GPP TS 24.008 [48] call control procedures. The supplementary services request is rejected by means of a FACILITY message or appropriate call control message containing a Return Error component with the appropriate parameter in the Facility Information Element; +- the network and MS continue to process the call according to the normal 3GPP TS 24.008 [48] call control procedures. The supplementary services request is ignored. + +### 2.2.5 Call independent supplementary service procedures + +#### 2.2.5.1 Introduction + +For supplementary service procedures independent of any call, the initiating side must establish a MM-connection between the network and the MS according to the rules given in 3GPP TS 24.007 [49] and 3GPP TS 24.008 [48]. The call independent supplementary service procedures shall apply to both CS and PS domain for some specific services. On PS domain, a PS-signalling connection shall be established between the network and the MS instead of a MM-connection. Throughout this specification, the term MM-connection is used to denote a MM-connection for CS domain or PS-signalling connection for PS domain, as appropriate. The MS or the network starts the transaction by transferring a REGISTER message across the radio interface. This transaction is identified by the transaction identifier associated with the REGISTER message, and the Invoke identifier present in the component part of the Facility information element. Following the REGISTER message one or more FACILITY messages may be transmitted, all of them related by the use of the same transaction identifier. If the transaction is no longer used, it shall be released by sending a RELEASE COMPLETE message. This procedure is specified in detail in clause 3, and the text in clause 3 takes precedence over this introduction. + +To convey the supplementary service invocation, the Facility information element is used. The Facility information element present either in the REGISTER message or a subsequent message identifies the supplementary service involved and the type of component (i.e. Invoke, Return result, Return error or Reject component). + +When the REGISTER or FACILITY message contains a Facility information element and the requested service is available, a FACILITY message containing a Facility information element may be returned. One or more exchanges of FACILITY messages may subsequently occur. To terminate the service interaction and release the transaction identifier value, a RELEASE COMPLETE message is sent as specified for the specific supplementary service procedure. The RELEASE COMPLETE message may also contain the Facility information element. + +#### 2.2.5.2 Handling of protocol errors in call independent SS procedures + +Messages containing a Facility information element shall be checked for protocol errors before the contents of the Facility IE is acted on. The checks shall be performed in the following order: + +- 1) The message carrying the Facility IE shall be checked for protocol errors as specified in subclause 3.7. If a protocol error is found then the procedures in subclause 3.7 apply. +- 2) The contents of the Facility IE shall be checked for protocol errors as specified in subclause 2.2.8. If a protocol error is found then the procedures in subclause 2.2.8 apply. + +#### 2.2.5.3 Handling of other errors in call independent SS procedures + +If the tests specified in subclause 2.2.5.2 have been passed without the detection of a protocol error, the receiver will attempt to process the contents of the Facility Information Element. If errors occur during this processing (e.g. system failure, or information in the Facility IE is incompatible with the requested operation) then the procedures specified in the individual service specifications apply. + +An example of the behaviour that could occur in this case is: + +- the MS or network sends a Facility information element containing a return error component in a FACILITY or RELEASE COMPLETE message. If the FACILITY message is used then the MM Connection may continue to be used for further signalling. + +### 2.2.6 Multiple supplementary service invocations + +#### 2.2.6.1 Call related supplementary service procedures + +Simultaneous requests for different supplementary service procedures (i.e. using more than one operation in the Facility information element) are permitted. Interactions between different operations shall be managed by processing the operations in the order in which they appear in the Facility information element. + +#### 2.2.6.2 Call independent supplementary service procedures + +Where permitted by the relevant stage 3 specification, multiple operations may be sent on the same transaction. + +It is possible for several call independent SS transactions to be used simultaneously. Call independent SS transactions can also exist in parallel with other CM-Layer and MM transactions. The handling of multiple MM connections is defined in 3GPP TS 24.007 [49] and 3GPP TS 24.008 [48]. + +For call independent operations a single Facility Information Element shall not contain more than one component. + +### 2.2.7 Recovery procedures + +#### 2.2.7.1 Call related supplementary service recovery procedures + +There are no additional recovery procedures for call related supplementary service signalling on the radio path. The recovery procedures as specified for the basic service apply. + +#### 2.2.7.2 Call independent supplementary service recovery procedures + +In case a transaction is not terminated according to the normal procedure as described in technical specifications 3GPP TS 24.08x and 24.09x-series, the network side has to ensure that the transaction is terminated e.g. by a supervision timer. + +### 2.2.8 Generic protocol error handling for the component part of supplementary services operations + +If (according to the rules specified in 3GPP TS 29.002 [45]) a supplementary service operation is to be rejected the operation will be denied, and provided the transaction is still in progress, an appropriate reject component will be returned in a Facility Information Element. + +The handling of the transaction depends on whether the operation is call related or call independent. + +#### 2.2.8.1 Call related component errors + +If the call related transaction is still in progress then a reject component shall be sent. Any message which contains a Facility Information Element may be used. In general, the transaction (call) associated with the rejected operation shall not be automatically released by the entity that detects the error. The transaction (call) may be released in some exceptional cases where security related services are involved (e.g. Advice of Charge (Charging)). If this behaviour is required, then it will be specified in the relevant specification for the individual service. + +When a reject component for a call related operation is received by a MS or MSC then it may initiate release of the transaction (call) if this is a specified action for the service the SS operation relates to. + +Note that this behaviour is intended to allow security related services to release calls if one entity in the system does not support the service. The normal action should be to allow the call to continue. + +If the call related transaction has terminated before the operation has been rejected (e.g. the component containing the error was sent in a RELEASE COMPLETE message) then the contents of the component shall be ignored, and no reject component is sent. + +#### 2.2.8.2 Call independent component errors + +##### 2.2.8.2.1 Single component errors + +The reject component shall be sent in a RELEASE COMPLETE message. + +If the component containing the error was itself sent in a RELEASE COMPLETE message then the contents of the component shall be ignored, and no reject component is sent. + +##### 2.2.8.2.2 Multiple component errors + +If a single Facility IE contains more than one component then a RELEASE COMPLETE message with the cause "Facility rejected" and without any component shall be sent. + +# --- 3 Supplementary service support procedures + +## 3.1 General + +This clause describes the supplementary service support procedures at the radio interface. These procedures are provided by the supplementary service support entity defined in 3GPP TS 24.007 [49]. The supplementary service support procedures provide the means to transfer messages for the call independent supplementary service procedures. These procedures are regarded as the user of the supplementary service support. + +## 3.2 Supplementary service support establishment + +At the beginning of each call independent supplementary service procedure a supplementary service support must be established. + +### 3.2.1 Supplementary service support establishment at the originating side + +If the entity that uses the supplementary support procedures wants to send a REGISTER message, the supplementary service support entity shall first request the establishment of an MM-connection. This MM-connection is established according to 3GPP TS 24.008 [48] and 04.07. If the network is the initiating side then MM-connection establishment may involve paging the MS. + +The supplementary service support entity shall send the REGISTER message as the first CM-message on the MM-connection. The REGISTER message is sent to the corresponding peer entity on the MM-connection and the supplementary service support shall be regarded as being established. + +### 3.2.2 Supplementary service support establishment at the terminating side + +At the terminating side a supplementary service support is regarded as being established when an MM-connection is established. According 3GPP TS 24.008 [48] this can be ascertained by the receipt of the first message, with a new transaction identifier. For successful establishment of supplementary service support this message shall be a REGISTER message. + +If the terminating side wishes to reject the establishment of supplementary services support then it may be immediately initiate supplementary services support release (see subclause 3.4). + +## 3.3 Supplementary service support information transfer phase + +Upon the establishment of the supplementary service support both users may exchange FACILITY messages by use of the supplementary service support. + +## 3.4 Supplementary service support release + +At the end of each call independent supplementary service procedure the established supplementary service support is released. + +The side closing the transaction shall release the transaction by sending the RELEASE COMPLETE message to its corresponding peer entity. + +Both supplementary service support entities release the MM-connection locally. + +## 3.5 Recovery procedures + +The supplementary service support does not provide recovery procedures, i.e. the operations are transparent to the supplementary service support. + +## 3.6 Message flow (single operation example) + +This subclause contains examples of message flows for a single transaction consisting of a single operation. These examples may not show all possibilities. + +### 3.6.1 Mobile station initiated supplementary service transaction + +![Sequence diagram showing a mobile station initiated supplementary service transaction between MS and Network. The sequence includes REGISTER, Facility (Invoke), RELEASE COMPLETE, Facility (Return result), Facility (Return error), Facility (Reject), and multiple RELEASE COMPLETE (note) messages.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: REGISTER + MS->>Network: Facility (Invoke = Operation (Supplementary service code, Parameter(s))) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Return result = Operation (Parameter(s))) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Return error (Error)) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Reject (Invoke_problem)) + Note right of Network: RELEASE COMPLETE (note) + Network-->>MS: + Note right of Network: RELEASE COMPLETE (note) + Network-->>MS: + +``` + +Sequence diagram showing a mobile station initiated supplementary service transaction between MS and Network. The sequence includes REGISTER, Facility (Invoke), RELEASE COMPLETE, Facility (Return result), Facility (Return error), Facility (Reject), and multiple RELEASE COMPLETE (note) messages. + +NOTE: To prevent transactions being kept open following exceptional cases, either side of the transaction may release it by sending a RELEASE COMPLETE message without a Facility IE. + +**Figure 3.1: Mobile station initiated supplementary service transaction** + +### 3.6.2 Network initiated supplementary service transaction + +![Sequence diagram of network initiated supplementary service transaction between MS and Network. The process starts with REGISTER from MS to Network. The Network responds with Facility (Invoke = Operation (Supplementary service code, Parameter(s))). The MS then responds with RELEASE COMPLETE. The Network then sends Facility (Return result = Operation (Parameter(s))), to which the MS responds with RELEASE COMPLETE. Alternatively, the Network could send Facility (Return error (Error)) or Facility (Reject (Invoke_problem)), both of which the MS responds to with RELEASE COMPLETE. Finally, the MS sends RELEASE COMPLETE (note 1, note 3) to the Network, and the Network responds with RELEASE COMPLETE (note 3).](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +MS Network + +REGISTER + +<----- +Facility (Invoke = Operation (Supplementary service code, Parameter(s))) + +RELEASE COMPLETE +-----> +Facility (Return result = Operation (Parameter(s))) + +RELEASE COMPLETE +-----> +Facility (Return error (Error)) + +RELEASE COMPLETE +-----> +Facility (Reject (Invoke\_problem)) + +RELEASE COMPLETE (note 1, note 3) +-----> + +RELEASE COMPLETE (note 3) +<----- + +Sequence diagram of network initiated supplementary service transaction between MS and Network. The process starts with REGISTER from MS to Network. The Network responds with Facility (Invoke = Operation (Supplementary service code, Parameter(s))). The MS then responds with RELEASE COMPLETE. The Network then sends Facility (Return result = Operation (Parameter(s))), to which the MS responds with RELEASE COMPLETE. Alternatively, the Network could send Facility (Return error (Error)) or Facility (Reject (Invoke\_problem)), both of which the MS responds to with RELEASE COMPLETE. Finally, the MS sends RELEASE COMPLETE (note 1, note 3) to the Network, and the Network responds with RELEASE COMPLETE (note 3). + +NOTE 1: If the network initiated operation does not require a result, reject or error to be returned then the MS shall release the transaction by sending a RELEASE COMPLETE message without a Facility Information Element. + +NOTE 2: For network initiated unstructured SS data alternative procedures for connection release apply; refer to 3GPP TS 23.090 [20] and 3GPP TS 24.090 [35]. + +NOTE 3: To prevent transactions being kept open following exceptional cases, either side of the transaction may release it by sending a RELEASE COMPLETE message without a Facility IE. + +**Figure 3.2: Network initiated supplementary service transaction** + +## 3.7 Handling of unknown, unforeseen, and erroneous protocol data + +### 3.7.1 General + +These procedures only apply to messages where the protocol discriminator is set to indicate call independent SS operations according to the rules in 3GPP TS 24.007 [49] and 3GPP TS 24.080 [27]. Messages that do not meet this criteria are treated according to other GSM technical specifications. + +This subclause specifies procedures for handling of unknown, unforeseen and erroneous protocol data by the receiving entity. The procedures are called "error handling procedures", but they also define a compatibility mechanism for future extension of the protocol. + +Most error handling procedures are mandatory in the MS, but optional in the network. Detailed error handling procedures may vary from PLMN to PLMN. + +In this subclause, the following terminology is used: + +- An IE is defined to be syntactically incorrect in a message if it contains at least one value defined as "reserved" in 3GPP TS 24.080 [27] or 3GPP TS 24.008 [48]. However, it is not a syntactical error if a type 4 IE specifies a length indicator greater than that defined. The component part of the Facility information element is handled by a separate mechanism, and errors in the component part are not covered by this subclause. + +The following procedures are listed in order of precedence. + +Handling of errors in the contents of the Facility IE is described in subclause 2.2.8, and is outside the scope of this subclause. + +### 3.7.2 Message too short + +When a message is received that is too short to contain a complete message type information element, that message shall be ignored. + +### 3.7.3 Unknown or unforeseen transaction identifier + +The MS shall ignore messages with the transaction identifier value set to "111". + +If the transaction identifier value is not "111" the following procedures shall apply to the MS: + +- a) If a RELEASE COMPLETE message is received specifying a transaction identifier that is not recognised as relating to a call independent SS transaction that is in progress then the message shall be ignored. +- b) If a FACILITY message is received specifying a transaction identifier that is not recognised as relating to a call independent SS transaction that is in progress then a RELEASE COMPLETE message shall be sent with cause value #81 "invalid call reference value". +- c) If a REGISTER message is received specifying a transaction identifier that is not recognised as relating to a call independent SS transaction that is in progress and with a transaction identifier flag incorrectly set to "1", this message shall be ignored. + +The network may follow the same procedures. + +### 3.7.4 Unknown or unforeseen message type + +If the MS receives a message type not defined for the protocol discriminator or not implemented by the receiver, then a RELEASE COMPLETE message shall be sent with cause value #97 "message type non-existent or not implemented". + +If the MS receives a message type not consistent with the transaction state then a RELEASE COMPLETE message shall be sent with cause value #98 "message not compatible with control state". + +The network may follow the same procedures. + +### 3.7.5 Non-semantical mandatory Information Element Error + +When on receipt of a message: + +- an "imperative message part" error; or +- a "missing mandatory IE" error; + +is diagnosed, or when a message containing: + +- a syntactically incorrect mandatory IE; or +- an IE unknown in the message, but encoded as "comprehension required" (see 3GPP TS 24.008 [48]); or +- an out of sequence IE encoded as "comprehension required"; + +is received, the MS shall proceed as follows: + +- a) If the message is not RELEASE COMPLETE it shall send a RELEASE COMPLETE message with cause "#96 - Invalid mandatory information". +- b) If the message is RELEASE COMPLETE, it shall be treated as a normal RELEASE COMPLETE message. + +The network may follow the same procedures. + +### 3.7.6 Unknown and Unforeseen IEs in the non-imperative part + +#### 3.7.6.1 IEs unknown in the message + +The MS shall ignore all IEs unknown in the message which are not encoded as "comprehension required". + +The network shall take the same approach. + +#### 3.7.6.2 Out of sequence IEs + +The MS shall ignore all out of sequence IEs in a message which are not encoded as "comprehension required". + +The network may take the same approach. + +#### 3.7.6.3 Repeated IEs + +If an information element with format T, TV or TLV (see 3GPP TS 24.007 [49]) is repeated in a message in which repetition of the information element is not specified, only the contents of the information element appearing first shall be handled and all subsequent repetitions of the information element shall be ignored. When repetition of information elements is specified, only the contents of specified repeated information elements shall be handled. If the limit on repetition of information elements is exceeded, the contents of information elements appearing first up to the limit of repetitions shall be handled and all subsequent repetitions of the information element shall be ignored. + +The network may follow the same procedures. + +### 3.7.7 Non-imperative message part errors + +This category includes: + +- syntactically incorrect optional IEs; +- conditional IE errors. + +Errors in the content of the Facility IE are handled according to subclause 2.2.8. + +#### 3.7.7.1 Syntactically incorrect optional IEs (other than Facility) + +The MS shall treat all optional IEs that are syntactically incorrect in a message as not present in the message + +The network shall take the same approach. + +#### 3.7.7.2 Conditional IE errors + +When the MS upon receipt of a message diagnoses a "missing conditional IE" error, or an "unexpected conditional IE error", or when it receives a message containing at least one syntactically incorrect conditional IE (other than Facility), it shall send a RELEASE COMPLETE message with cause #100 "conditional IE error". + +The network may follow the same procedure. + +# --- 4 Password management + +The password management procedures consist of two independent procedures: + +- password check; +- password registration. + +## 4.1 Password check + +### 4.1.1 Successful procedure + +When the password check procedure is invoked by a parent procedure (e.g. for service activation, service deactivation, password registration), the network sends to the MS an invoke component of the operation "get password" with + +"password" as the value of the mandatory GuidanceInfo information element. This invoke component is embedded in a FACILITY message, since the password check procedure is always invoked during an existing transaction. The MS will return to the network the required password in the return result component of the operation. This return result component is embedded in a FACILITY message, see figure 4.1. If the provided password is right the password check procedure returns to the parent procedure an indication of successful password check. + +![Sequence diagram showing the successful password check procedure between MS and Network.](523ab7b925beb555f88b2e1e1336974f_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: REGISTER (note) + MS->>Network: Facility + Network-->>MS: FACILITY + Note left of MS: Facility (Invoke = GetPassword (GuidanceInfo = "password")) + Network-->>MS: FACILITY + Note right of Network: Facility (Return result = GetPassword (Password)) + Network-->>MS: RELEASE COMPLETE (note) + +``` + +The diagram illustrates the interaction between a Mobile Station (MS) and a Network for a successful password check. It begins with a 'REGISTER (note)' from the Network. The MS sends a 'Facility' message to the Network. The Network responds with a 'FACILITY' message. A note on the Network side indicates this message contains 'Facility (Invoke = GetPassword (GuidanceInfo = "password"))'. The Network then sends another 'FACILITY' message. A note on the Network side indicates this message contains 'Facility (Return result = GetPassword (Password))'. Finally, the Network sends a 'RELEASE COMPLETE (note)' message to the MS. + +Sequence diagram showing the successful password check procedure between MS and Network. + +NOTE: This message is part of the initiating SS operation. + +**Figure 4.1: Password check: successful procedure** + +### 4.1.2 Error cases + +If no result is returned by the MS for the "Get password" operation invoked by the network, the password check procedure is terminated. + +If the password value which is returned by the MS does not match the password value registered in the network, the network increments a counter and sends to the MS a Return Error component indicating "Negative Password Check". The counter is reset as soon as the right password is returned. + +If the served mobile subscriber enters a wrong call barring "password" three consecutive times, the subscription option "control of services" is set to "by the service provider" in the network: thus the network makes the use of password impossible for any subscriber operation. The password check procedure returns to the parent procedure an indication of Password Attempts Violation. The password can be made valid by the service provider only. + +## 4.2 Password registration + +If the served mobile subscriber is given the possibility to control the service by the use of a password, the service provider has to register a password at provision time. Furthermore, the served mobile subscriber can change the call barring password at any time. + +The password registration procedure is as follows: + +When the mobile subscriber wants to register a new password the old password, the new password and the repeat of the new password shall be entered into the MS. Then the MS sends to the network an invoke component of the operation "register password". + +The common SS-code for call restriction services shall be used, but if the service code is not entered by the user the MS shall include the SS-code referring to all supplementary services. + +### 4.2.1 Successful procedure + +The successful procedure consists of three steps: + +- the password registration procedure invokes first the password check procedure as it is described above; + +- if the password check procedure has returned an indication of successful password check, the network sends secondly to the MS, in an invoke component of the operation "get password" with "new password?" as the value of the mandatory GuidanceInfo information element. This invoke component is embedded in a FACILITY message. The MS will return to the network the required new password in the return result component of the operation. This return result component is embedded in a FACILITY message; +- the network sends thirdly to the MS an invoke component of the operation "get password" with "new password again?" as the value of the mandatory GuidanceInfo information element. This invoke component is embedded in a FACILITY message. The MS will return again to the network the required new password in the return result component of the operation. This return result component is embedded in a FACILITY message. + +If the two values of the provided passwords are identical, the network confirms the registration of the new password by sending to the MS the return result component of the operation "register password", with the new password as a mandatory information element, see figure 4.2. + +### 4.2.2 Error cases + +If the subscription option "control of services" is set to "by the service provider" or if the WPA is greater than 3 an attempt to register a password will be denied by the network (see 3GPP TS 23.011). If the counter for wrong password attempts is smaller than four, the network will return to the MS an error component with the error value "SS\_SubscriptionViolation". If the counter is larger than three, the error value "Password Attempts Violation" is returned. + +If the password check procedure returns an indication of negative password check, the network will send to the MS a return error component of the operation "register password" with the error value "negativePasswordCheck". + +If the new password is not repeated twice identically by the mobile subscriber, the network returns to the MS an error component of the "register password" operation with the error value "passwordRegistrationFailure". The diagnostic "newPasswordsMismatch" may be passed as an error parameter. The old password remains registered. + +If no result is returned by the MS for the "Get password" operation invoked by the network the "register password" procedure is terminated, and the old password remains registered. + +If the format of a new password which is returned by the MS is invalid (e.g. the value does not belong to the [0000-9999] range), the network sends to the MS an error component of the "register password" operation with the error value "passwordRegistrationFailure". The diagnostic "invalidFormat" may be passed as an error parameter. The old password remains registered. + +![Sequence diagram showing the Password registration procedure between MS and Network. The steps include REGISTER, multiple FACILITY messages for GetPassword and Register Password, and RELEASE COMPLETE messages.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: REGISTER + MS->>Network: Facility (Invoke = Register Password (SS-Code)) + Note right of Network: FACILITY + Network-->>MS: Facility (Invoke = GetPassword (GuidanceInfo = "password")) + Note right of Network: FACILITY + Network-->>MS: Facility (Return result = GetPassword (Password)) + Note right of Network: FACILITY + Network-->>MS: Facility (Invoke = GetPassword (GuidanceInfo = "new password")) + Note right of Network: FACILITY + Network-->>MS: Facility (Return result = GetPassword (Password)) + Note right of Network: FACILITY + Network-->>MS: Facility (Invoke = GetPassword (GuidanceInfo = "new password again")) + Note right of Network: FACILITY + Network-->>MS: Facility (Return result = GetPassword (Password)) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility(Return result = Register Password (Password)) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Return error (Error)) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the Password registration procedure between MS and Network. The steps include REGISTER, multiple FACILITY messages for GetPassword and Register Password, and RELEASE COMPLETE messages. + +NOTE: The figure illustrates successful outcome only. In case of input errors by the mobile subscriber, the information flow may be interrupted as defined in 3GPP TS 23.011. + +**Figure 4.2: Password registration procedure** + +## 4.3 Cross phase compatibility + +When password procedures are initiated by an MS which does not provide an SS version indicator and where errors occur in password procedures, the network shall not send the protocol error values "DataMissing", "CallBarred" or "NumberOfPWAttemptsViolation". + +When an MS that supports version 2 of the SS-protocol receives the guidance values "badPW-TryAgain" or "badPW-FormatTryAgain" it shall release the transaction and notify the mobile user in the same way as if the error value "negativePasswordCheck" has been returned by the network in reply to the parent operation. + +# 5 Supplementary service cross phase compatibility + +## 5.1 Cross phase, or cross protocol version, interworking + +Due to the phased approach to GSM standardisation it is possible for a service to be changed, or new services to be added, between different versions of the standard. Since GSM supports the features "terminal mobility" and "roaming" and is a system of open interfaces, it is possible for entities supporting different versions of the standards to have to interwork. This clause describes the supplementary service procedures which provide this interworking. + +This clause describes compatibility procedures for radio interface SS operations. In this clause the term "SS operation" refers to one of the operations sent in the Facility IE as defined in 3GPP TS 24.080 [27] and 3GPP TS 29.002 [45]. An "MS initiated operation" is an SS operation where the MS sends the invoke component. A corresponding definition applies to network initiated operations. + +## 5.2 Objectives + +The objectives of these procedures are as follows: + +- to allow flexibility of implementation, i.e. allow different combinations of services to be supported at different versions within a single entity; +- to allow SSs to evolve from version to version of the standards; +- to decouple SS protocol from other protocols; +- to guarantee the best quality of service in situations where different entities support different versions of that service. + +## 5.3 Supplementary service compatibility philosophy + +The purpose of the SS compatibility procedures is to ensure that when a service is invoked the highest common version of the service protocol is used in the entities supporting that service. The highest protocol version gives the best level of service to the subscriber. The commonality of versions between entities provides compatibility. + +The basic philosophy is that the MS shall provide the network with information about its capabilities in order that the network may adjust to the capabilities of the MS. This ensures that compatible information is sent to the MS. This process is not required in the other direction, i.e. the network does not provide the MS with capability information. The network is expected to be able to cope with unexpected information cleanly and due to network evolution will generally be more advanced than operating MSs. + +In this description the terms "phase" and "version" are used with respect to supplementary services. In this context "phase" means a particular collection of GSM standards or an implementation according to that phase of standards. In each phase of GSM standards "versions" of a service or protocol are described. Therefore it is sometimes applicable to refer to which version of a service is supported. + +## 5.4 Compatibility mechanisms + +Two signalling indicators are used in the MS to network direction to provide information on the general capabilities of the MS and on specific SS protocol versions. A protocol extension mechanism is also used for protocol evolution. + +- NOTE: These compatibility mechanisms are flexible, and could be applied in ways outside the scope of this standard. In general, MSs and networks should support complete implementations of supplementary services (e.g. mobile initiated USSD) including all elements that are not explicitly indicated as manufacturer or operator options. Complete support for a service also implies that the necessary compatibility indicators are set to appropriate values. If the MS or network does not implement all the elements necessary to support a service then the user may receive only a subset of the complete service. Such a MS or network is outside the scope of this standard and may: +- provide a version of the service that is unpredictable or inconsistent; + - fail to meet important service requirements; + - be incompatible with other entities. + +### 5.4.1 SS screening indicator + +The SS screening indicator is sent by the MS at the beginning of the radio connection to allow the network to assess the capabilities of the MS and hence determine, + +- whether a particular network initiated SS operation may be invoked; or +- what version of a network initiated SS operation should be invoked. + +The SS screening indicator is only relevant to network initiated SS operation and is valid for the duration of a radio connection. The coding of the SS screening indicator is described in 3GPP TS 24.008 [48] and 3GPP TS 24.080 [27]. + +### 5.4.2 SS version indicator + +The SS version indicator is sent by the MS and is associated with one or more related SS operations. It indicates to the network the correct version of radio interface protocol and procedures to use for those SS operations. For call related SSs the version indicator is valid for the invocation period of the SS operation to which it was attached (i.e. the validity of the invoke ID). For call independent SSs the indicator is valid for the duration of the call independent transaction. The SS version indicator takes precedence over the screening indicator during its period of validity. The coding of the SS version indicator is described in 3GPP TS 24.008 [48] and 3GPP TS 24.080 [27]. + +### 5.4.3 Protocol extension mechanism + +A protocol extension mechanism is used in the common information element category supplementary service protocol to allow controlled evolution of the protocol. The purpose of this mechanism is to allow optional information to be introduced into operations without causing receiving entities, who do not recognise this information, to reject the entire operation. + +## 5.5 SS compatibility procedures + +### 5.5.1 Screening indicator procedures + +#### 5.5.1.1 MS procedure + +If a MS supports Phase 2 3GPP TS 24.010 error handling and the Phase 2 3GPP TS 24.080 [27] extension mechanism it shall send the screening indicator to the network during layer 3 connection establishment. The value of the indicator shall indicate Phase 2. The sending of the screening indicator does not depend upon the invocation of any supplementary service. + +#### 5.5.1.2 Network procedure + +At layer 3 connection establishment with the MS, the network shall check for the SS screening indicator and note, for the duration of the connection, whether the indicator was sent, and if sent, the value of the indicator. + +On invocation of any network initiated SS operation (unless an SS version indicator has taken precedence over the screening indicator) the network shall check the screening indicator status. If the screening indicator was not sent, the network shall screen information sent to the MS, i.e. invoke the Phase 1 version of the operation or abort the invocation if only a Phase 2 version is available. If the screening indicator was received, indicating that Phase 2 error handling and extension mechanisms are supported at the MS, the network shall invoke the highest supported version of the operation toward the MS. + +According to this version of the standards the highest version is Phase 2. However when the next version of standards is available, new services may also be invoked. If the MS does not support the service the error handling or extension mechanism will handle unrecognised information cleanly. + +If in the future a new value is assigned to the screening indicator, new screening procedures may also be defined for networks of similar or higher capability. These procedures cannot be predicted and no definition is required in this version of the standards. + +If the value of the screening indicator is unrecognised the network shall attempt to handle network initiated SS operations as if the MS had indicated the highest values supported by the network. + +The indicator has been defined in such a way that it is ignored when received by a Phase 1 network therefore no Phase 1 procedures are described. + +### 5.5.2 SS version indicator procedures + +#### 5.5.2.1 MS procedure + +If an SS operation has been initiated at the MS, and the MS supports Phase 2 3GPP TS 24.010 error handling and the Phase 2 3GPP TS 24.080 [27] extension mechanism and the operations used by the mobile initiated procedure are implemented according to the Phase 2 GSM standards, then: + +- in the case of call independent activity, the MS shall send the SS version indicator at the beginning of the transaction indicating the version of the SS operation being invoked. No further indication shall be sent by the MS during the transaction. No operations shall be sent within the same transaction which are not compliant with the SS version indicated. +- in the case of call related activity, the MS shall send the SS version indicator in the 3GPP TS 24.008 [48] message containing the invoke component of the related operation. The version of the service being invoked is indicated. This procedure applies on a per operation basis and shall be repeated for each call related operation. + +##### 5.5.2.1.1 MS procedure for version 3 or higher operations + +The relevant stage 3 specification for each service shall state if the operation requires the use of SS version 3 or higher for MS initiated operations. + +The SS version indicator is used within the network to define the MAP Application Context used for a specific operation (see 3GPP TS 29.002 [45]). An MS initiating an SS version 3 or higher operation must be able to decode all of the possible returned information from the MAP Version 3 Application Context of the operation invoked. + +If an SS version 3 or higher operation has been initiated at the MS, then: + +- in the case of call independent activity, the MS shall send the SS version 3 or higher indicator at the beginning of the transaction indicating the version of the SS operation being invoked. No further indication shall be sent by the MS during the transaction. No operations shall be sent within the same transaction which are not compliant with the SS version indicated. +- in the case of call related activity, the MS shall send the SS version 3 or higher indicator in the 3GPP TS 24.008 [48] message containing the invoke component of the related operation. The version of the service being invoked is indicated. This procedure applies on a per operation basis and shall be repeated for each call related operation. + +#### 5.5.2.2 Network procedure + +##### 5.5.2.2.1 Call independent SS activity + +When a new transaction is set up for call independent SS activity the network shall check for the SS version indicator and note, for the duration of the transaction, whether the indicator was present, and if present, the value of the indicator. + +The network shall use this indication to establish the correct MAP application context in the network for the processing of all operations made on that transaction. The network shall discard this information at the end of the transaction. If the indicator was not present the network shall operate according to Phase 1. If the indicator was present and indicates Phase 2 the network shall operate according to the Phase 2 standards. If the value of the indicator is unrecognised the network shall attempt to handle the communication at its highest possible version. The detailed interworking for this situation is described in subclause 5.5.4. + +The screening indicator shall not be taken into account for processing transactions that start with MS initiated operations. + +Special procedures concerning SS version indicator values other than Phase 2 will be described in future standards if required. + +##### 5.5.2.2.2 Call related SS activity + +When a call related common information element SS operation is received by the network, the network shall check the 3GPP TS 24.008 [48] carrier message for the SS version indicator. The network shall note whether the indicator was present, and if present, what value was provided. + +The network shall use this information to operate in a compatible way and set up compatible contexts in the fixed network. If the indicator was not present the network shall operate according to Phase 1. If the indicator was present and indicates Phase 2 the network shall operate according to the Phase 2 standards. If the value of the indicator is unrecognised the network shall attempt to handle the communication at its highest possible version. + +The network shall discard the indicated information when the operation has been completed, i.e. when a result, error or reject is provided. If no response is expected to an operation the indicator is discarded immediately after the operation has been processed. + +The screening indicator shall not be taken into account for processing MS initiated operations. + +If the version indicator is received but no supplementary service information is supplied the network shall ignore the indicator. + +Special procedures concerning SS version indicator values other than Phase 2 will be described in future versions of the standards if required. + +### 5.5.3 Extension mechanism procedures + +The handling of the extension mechanism (ellipsis) is a detailed protocol matter and is described in the MAP version 2, 3GPP TS 29.002 [45]. + +### 5.5.4 SS version indicator - MAP context interworking + +#### 5.5.4.1 Call independent interworking + +The compatibility mechanisms described in these subclauses concern the radio interface. The fixed network protocol MAP also specifies compatibility mechanisms. The interworking between these mechanisms occurs at the MSC/VLR. + +The MSC shall operate and set up contexts according to the version indicated by the MS wherever possible. If the MS signals a higher version than the MSC/VLR is capable of supporting, the MSC/VLR shall attempt to support service at the highest version which is supported. If this is not possible then the communication is rejected. + +Detailed interworking is described in 3GPP TS 29.011. + +#### 5.5.4.2 Call related interworking + +No interworking identified. + +## 5.6 Development of future protocol versions + +As a general rule all future versions of protocol should be designed such that they are a superset of the previous protocol. This provides backward compatibility. + +Optional information shall be introduced, where appropriate, in the extensible parts of operations. + +Non-compatible protocol changes, i.e. the introduction of mandatory protocol elements or new operations shall cause an increment in the protocol version. This shall be reflected in the use of the SS version indicator. Amendments to the Phase 2 services shall specify in the relevant stage 3 specification which value of the SS version indicator to use for MS initiated operations. + +The extension mechanism shall be introduced wherever possible in new operations or new constructed data types of the common information element SS protocol. + +Care should also be taken that functional service changes are made in a backwards compatible manner. + +# --- 6 Forward Check SS Indication + +The forward check SS indication procedure is used when supplementary services data in the HLR may have become corrupted. The procedure is initiated by the network to inform the user to verify his supplementary services data. The procedure consists of the network sending the ForwardCheckSSIndication operation on a call independent SS transaction. The procedure shall create a new network initiated transaction. + +The new transaction may be used on its own, or in parallel with other call independent SS transactions. The message flow is shown in figure 6.1. + +![Sequence diagram showing message flow between MS and Network. The MS sends a REGISTER message to the Network. The Network responds with a Facility message (Invoke = ForwardCheckSSIndication). The MS then sends a RELEASE COMPLETE message to the Network.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` +sequenceDiagram + participant MS + participant Network + Note right of Network: REGISTER + MS->>Network: Facility (Invoke = ForwardCheckSSIndication) + Note right of Network: RELEASE COMPLETE + Network-->>MS: +``` + +Sequence diagram showing message flow between MS and Network. The MS sends a REGISTER message to the Network. The Network responds with a Facility message (Invoke = ForwardCheckSSIndication). The MS then sends a RELEASE COMPLETE message to the Network. + +**Figure 6.1: ForwardCheckSSIndication sent on new transaction** + +# --- Annex A (normative): Notation used for stage 3 description of supplementary services + +The structure of the signalling used for supplementary services on the Um Interface is defined using diagrams in 3GPP TS 24.010 and the 3GPP TS 24.08x and 24.09x-series of technical specifications. These SS stage 3 diagrams show example message flows between the MS and the network. + +Separate diagrams specify how supplementary services signalling shall be used to perform each defined supplementary service function. For signalling that uses the common information element approach, these diagrams are the normative definition of a number of important aspects of the supplementary services signalling: + +- the diagrams normatively define the allowed responses to each supplementary service operation shown; +- the diagrams normatively define which 3GPP TS 24.008 [48] or 3GPP TS 24.080 [27] message is to be used to transport the supplementary services operations in the Facility IE; +- The diagrams normatively define which parameters are allowed and required in the invocation and response of each operation. + +## --- A.1 General structure of the SS stage 3 diagrams + +In the SS stage 3 diagrams the messages that correspond to the normal case with successful outcome are shown using solid arrows. Messages for exceptional, or unsuccessful cases are shown using dashed arrows. In general, the diagrams show the initiating operation together with all possible outcomes. Obviously, in practice only one of the possible outcomes shown in the diagrams will occur when the operation is used. An example is given in figure A.1. + +![Sequence diagram showing the general structure of SS stage 3 diagrams between MS and Network. It includes an initiating operation, a normal successful outcome, and two unsuccessful outcomes.](9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: Initiating Operation + MS-->>Network: + Note over MS, Network: Normal, Successful Outcome + Network-->>MS: + Note over MS, Network: Unsuccessful Outcome 1 + Network-->>MS: + Note over MS, Network: Unsuccessful Outcome 2 + Network-->>MS: + +``` + +Sequence diagram showing the general structure of SS stage 3 diagrams between MS and Network. It includes an initiating operation, a normal successful outcome, and two unsuccessful outcomes. + +**Figure A.1: Example of the general structure of the SS stage 3 diagrams** + +### A.1.1 Exceptional release procedures + +To prevent transactions being kept open following exceptional cases, either side of the transaction may release it by sending a RELEASE COMPLETE message without a Facility IE. This procedure can be used to release any call independent SS procedure, at any time while supplementary service support is established. For clarity this is not shown on the specific diagrams in the 3GPP TS 24.08x and 24.09x series, though it is still available. + +![Diagram showing exceptional release procedures between MS and Network. Two dashed arrows labeled 'RELEASE COMPLETE' point in opposite directions, with '- or -' between them.](6ca05954842b17f14dfd52f26b9d43d2_img.jpg) + +``` + +MS Network + <----- RELEASE COMPLETE + - or - + ----- RELEASE COMPLETE -----> + +``` + +Diagram showing exceptional release procedures between MS and Network. Two dashed arrows labeled 'RELEASE COMPLETE' point in opposite directions, with '- or -' between them. + +Figure A.2: Exceptional release procedures + +## A.2 Messages used to transport operations + +The message used to transport the supplementary service operation is shown above the arrow. If a single message or a list of messages is specified then only these messages shall be used to transport the operation shown in the context shown. If the letters "e.g." are included before the message name or a list of messages then the messages shown are only suggested examples. If "e.g." is used then any message that carries the Facility information element which is consistent with the transaction state may be used for the SS operation. + +## A.3 Contents of messages + +The contents of messages is specified below the arrow. The diagrams do not show the SS version indicator, or other parts of the message contents unless they are directly related to the service shown. The names of relevant information elements are shown, and the associated contents is shown in brackets. + +If the information element is the Facility IE then the contents information includes: + +- the type of component that shall be used for the operation (e.g. invoke, return result, return error, reject); +- the name of the operation to be used (for the invoke and return result components only); +- the parameters that shall be included in the operation. For the function described by the diagram, only those parameters shown in the diagram are allowed. Unless stated otherwise all the parameters shown in the diagram shall be present when the operation is used for the function described by the diagram. + +The detailed encoding of the operations and parameters shown in the diagrams is defined in 3GPP TS 24.080 [27] and 3GPP TS 29.002 [45]. Appropriate ASN.1 structures from these specifications shall be used to align with the diagrams. + +The examples in figure A.2 illustrate the encoding. The first example shows a common information element operation where the operation name is shown. The second example shows a common information element operation where the operation name is not shown. Items in italics would be substituted with the appropriate identifiers. + +![Two diagrams showing message contents. The first shows 'MESSAGE NAME' above a dashed arrow pointing to 'Facility (Component Type = OperationName (parameters))'. The second shows 'MESSAGE NAME' above a dashed arrow pointing to 'Facility (Component Type (parameters))'.](db395493033edacd83e212049fd55715_img.jpg) + +``` + +MESSAGE NAME +-----> +Facility (Component Type = OperationName (parameters)) + +MESSAGE NAME +-----> +Facility (Component Type (parameters)) + +``` + +Two diagrams showing message contents. The first shows 'MESSAGE NAME' above a dashed arrow pointing to 'Facility (Component Type = OperationName (parameters))'. The second shows 'MESSAGE NAME' above a dashed arrow pointing to 'Facility (Component Type (parameters))'. + +Figure A.2: Examples of the contents of messages + +# Annex B (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|----------|-----------|-------|---------|-------------|-------------------------------------------------------------------------| +| Apr 1999 | GSM 04.10 | | | | Transferred to 3GPP CN1 | +| CN#03 | 24.010 | | R99 | 3.0.0 | Approved at CN#03 | +| CN#08 | 24.010 | 001 | R99 | 3.1.0 | Alignment of SS protocol with current MM/GMM integrity protection rules | +| CN#11 | 24.010 | | Rel-4 | 4.0.0 | Version increased from R99 to Rel-4 after CN#11 | +| CN#11 | 24.010 | 002r1 | Rel-4 | 4.0.0 | Adaptation of SS to PS domain | +| CN#13 | 24.010 | 003 | Rel-4 | 4.1.0 | Clarification on the signalling connection for PS domain | +| CN#14 | 24.010 | 005 | Rel-4 | 4.2.0 | Usage of SS Version Indicator | +| CN#16 | 24.010 | | Rel-5 | 5.0.0 | Version increased from Rel-4 to Rel-5 after CN#16 | +| CN#26 | 24.010 | | Rel-6 | 6.0.0 | Version increased from Rel-5 to Rel-6 after CN#26 | +| CT#36 | 24.010 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 24.010 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 24.010 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 24.010 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2011-06 | 24.010 | | Rel-10 | 10.1.0 | Correction of references to non-existent specifications | +| 2012-09 | 24.010 | | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 24.010 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 24.010 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 24.010 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 24.010 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 24.010 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24011/08f6ace0c83e7394657fa372b47aec04_img.jpg b/marked/Rel-16/24_series/24011/08f6ace0c83e7394657fa372b47aec04_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..74855506ed02f4b6f750215f8e8be6f46118fcf6 --- /dev/null +++ b/marked/Rel-16/24_series/24011/08f6ace0c83e7394657fa372b47aec04_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:510fff066eca7a663430de58eb4609bae6b8059752c98d907fe68c90c824c986 +size 115362 diff --git a/marked/Rel-16/24_series/24011/0931f3e098bd4539041de11c50cec2d2_img.jpg b/marked/Rel-16/24_series/24011/0931f3e098bd4539041de11c50cec2d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5fd6bd75bd23f33ca9f811f1445dfff99ce50e0e --- /dev/null +++ b/marked/Rel-16/24_series/24011/0931f3e098bd4539041de11c50cec2d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b607114ff7945cf3a79a08576f290450061b96c02e13be056833da3d88a5861 +size 81318 diff --git a/marked/Rel-16/24_series/24011/0a06de972d61ab9bb901bd74dd4ff51f_img.jpg b/marked/Rel-16/24_series/24011/0a06de972d61ab9bb901bd74dd4ff51f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3686fb1dd0f5b04ad75a4297b330f03469a833b2 --- /dev/null +++ b/marked/Rel-16/24_series/24011/0a06de972d61ab9bb901bd74dd4ff51f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5083f3d4b839595b055347e1e97e3c6766a5c60680f9a4d0c243ca18b63402ab +size 115766 diff --git a/marked/Rel-16/24_series/24011/0b998e3ad8f9d104768642612605cb35_img.jpg b/marked/Rel-16/24_series/24011/0b998e3ad8f9d104768642612605cb35_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9e6a74e501f5b664f3b22c9f6520b55671a175f6 --- /dev/null +++ b/marked/Rel-16/24_series/24011/0b998e3ad8f9d104768642612605cb35_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51cf4e1b63e6356a3883df0a68b7d1850801a16cc19bd669e67b48fed552d8e8 +size 26681 diff --git a/marked/Rel-16/24_series/24011/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg b/marked/Rel-16/24_series/24011/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e06a4cdf0a4af4c174bf8e92ae7842b5fa1c52a --- /dev/null +++ b/marked/Rel-16/24_series/24011/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e03bc79c40bf328d46c5fce1f209b3beeede6b03e8f794430374bc6448fd490a +size 82514 diff --git a/marked/Rel-16/24_series/24011/0f1767577a073167eb9628d72034e083_img.jpg b/marked/Rel-16/24_series/24011/0f1767577a073167eb9628d72034e083_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5350fa74539b78e8e67c984e6ed4c95edb70110a --- /dev/null +++ b/marked/Rel-16/24_series/24011/0f1767577a073167eb9628d72034e083_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ecdc1f709c404f9d6e4e5ce9a71761b853c786c62c7c7a28bd8cb9c07bbbcc6a +size 90132 diff --git a/marked/Rel-16/24_series/24011/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg b/marked/Rel-16/24_series/24011/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2e22122229f7e7850be5a98f546077570e380558 --- /dev/null +++ b/marked/Rel-16/24_series/24011/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6403118cb849b98fc3a654c23514529819563366f634abbe052b7685e8ca530a +size 39463 diff --git a/marked/Rel-16/24_series/24011/11f18bf0233d812ad2604f88f3385d60_img.jpg b/marked/Rel-16/24_series/24011/11f18bf0233d812ad2604f88f3385d60_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8cd54bf23d9ca197febee39ad542b74c1da80156 --- /dev/null +++ b/marked/Rel-16/24_series/24011/11f18bf0233d812ad2604f88f3385d60_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14c807171c82669383dea56b1533d1d8aba7b2cf9a1ff6c991c572643da4a269 +size 77937 diff --git a/marked/Rel-16/24_series/24011/17431d8b59408f09df7552d8bdbaa015_img.jpg b/marked/Rel-16/24_series/24011/17431d8b59408f09df7552d8bdbaa015_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3af35cd52fa0e9c21fce301c91b71054e0cecefe --- /dev/null +++ b/marked/Rel-16/24_series/24011/17431d8b59408f09df7552d8bdbaa015_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1889c6abb081274127ae82a4367ddf8c7431c38ffa51107455ffcf3cb736d68e +size 68945 diff --git a/marked/Rel-16/24_series/24011/18003425d0e8638dde4acc9c5c468c5c_img.jpg b/marked/Rel-16/24_series/24011/18003425d0e8638dde4acc9c5c468c5c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f24e522c3cadb13945832ae38dbb97524c542ea0 --- /dev/null +++ b/marked/Rel-16/24_series/24011/18003425d0e8638dde4acc9c5c468c5c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64b18df550290216b57d624bfaeb308f3d6ed34f787337d709232ea14eeebd06 +size 26508 diff --git a/marked/Rel-16/24_series/24011/18bb06865e2dada3656ea3d57f290f7f_img.jpg b/marked/Rel-16/24_series/24011/18bb06865e2dada3656ea3d57f290f7f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d400b2494018c0f9abecef24ef460036b5413eaf --- /dev/null +++ b/marked/Rel-16/24_series/24011/18bb06865e2dada3656ea3d57f290f7f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2794da54a8236b4cb43405eeb27de269616982d41e484cf30c123d08c0776258 +size 44177 diff --git a/marked/Rel-16/24_series/24011/195611c20b2dc7ed0fa3033392e22908_img.jpg b/marked/Rel-16/24_series/24011/195611c20b2dc7ed0fa3033392e22908_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..deb292440e4ca14beed59377938dd62feca8148a --- /dev/null +++ b/marked/Rel-16/24_series/24011/195611c20b2dc7ed0fa3033392e22908_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d36572b7c53454c2a923a00be6894db6b55a07bc410866737e73d060b3cd549a +size 117492 diff --git a/marked/Rel-16/24_series/24011/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/24_series/24011/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1a274e9497bf53df183d32b1131d68e34a45fc89 --- /dev/null +++ b/marked/Rel-16/24_series/24011/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48a25bff6947a411b9b6330a0115d6e546f8d73c81b88d519035ea50de3c3b30 +size 40421 diff --git a/marked/Rel-16/24_series/24011/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg b/marked/Rel-16/24_series/24011/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bef59ff11fbb44af678b42b78e563ce2002f376f --- /dev/null +++ b/marked/Rel-16/24_series/24011/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9468018d39a4934eef624220cf0146b4460985b0627de07305d97e162ade6f40 +size 44623 diff --git a/marked/Rel-16/24_series/24011/1f3389a0b9ef108721bdc3b3a6e364b7_img.jpg b/marked/Rel-16/24_series/24011/1f3389a0b9ef108721bdc3b3a6e364b7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54afae57624077b0bafc57fc6c4b8a5aab185b92 --- /dev/null +++ b/marked/Rel-16/24_series/24011/1f3389a0b9ef108721bdc3b3a6e364b7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3363824e24338543dfde2080c46b20c8a87aac3a2457a8df4ac1a3ccdf37d429 +size 64944 diff --git a/marked/Rel-16/24_series/24011/245166735676c675f98f535bc4c6f0a1_img.jpg b/marked/Rel-16/24_series/24011/245166735676c675f98f535bc4c6f0a1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b1b9cd9bffb43e7880ec9b4ca92ed27bfcab71a6 --- /dev/null +++ b/marked/Rel-16/24_series/24011/245166735676c675f98f535bc4c6f0a1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8f667b544177f4c5073e4805990887395a998256a1ffcd16b3a5fde940940bb1 +size 118339 diff --git a/marked/Rel-16/24_series/24011/24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg b/marked/Rel-16/24_series/24011/24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8db391a814c84b4e592299db5989edff9666b937 --- /dev/null +++ b/marked/Rel-16/24_series/24011/24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:069da7fc2d1184ff22250cbf45e646930eefa74e7a8b85533a2191ebeb4e5361 +size 85187 diff --git a/marked/Rel-16/24_series/24011/257c8341b41f1f4a287f27d33227974c_img.jpg b/marked/Rel-16/24_series/24011/257c8341b41f1f4a287f27d33227974c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..27414a1db6b373fc4e4f4870e97e30dfe0408377 --- /dev/null +++ b/marked/Rel-16/24_series/24011/257c8341b41f1f4a287f27d33227974c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa26fb31fa52a6720534bc2bb9ceffd435859efe6f7e04db9af26990f049aabd +size 15679 diff --git a/marked/Rel-16/24_series/24011/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/24_series/24011/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db14a215f9582ec5a0057f095d9eaaf2b8336fdd --- /dev/null +++ b/marked/Rel-16/24_series/24011/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74b9d7deabd5ec2b97baea03ab2c78694f34f316aab497b4128832de11127035 +size 36475 diff --git a/marked/Rel-16/24_series/24011/2a476a0b3dbc3429436246db4784ff9f_img.jpg b/marked/Rel-16/24_series/24011/2a476a0b3dbc3429436246db4784ff9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ae2a1574de52900c03b68befa5b3c2ca57ecb1a --- /dev/null +++ b/marked/Rel-16/24_series/24011/2a476a0b3dbc3429436246db4784ff9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15903cef485936bfca71bb1c8fac4353361bd4b9600e45ecab820a6ada7b4d66 +size 61018 diff --git a/marked/Rel-16/24_series/24011/2b00743506f6a3bbd17af764162dc76d_img.jpg b/marked/Rel-16/24_series/24011/2b00743506f6a3bbd17af764162dc76d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2fa391e536a2a706a23457098fd79615e0344f60 --- /dev/null +++ b/marked/Rel-16/24_series/24011/2b00743506f6a3bbd17af764162dc76d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf1398105c55a48cff45779b999ff3b882f3c3843dc896c37dadb56decf51bde +size 61382 diff --git a/marked/Rel-16/24_series/24011/2f587210e4f97c32758c5972e2e83d20_img.jpg b/marked/Rel-16/24_series/24011/2f587210e4f97c32758c5972e2e83d20_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9da04cc372c2408ef30b3319ede28d932dd0779f --- /dev/null +++ b/marked/Rel-16/24_series/24011/2f587210e4f97c32758c5972e2e83d20_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba91103f3c8147f42d6a22f7f08813227d7cb985031899e7656c13248339881b +size 23253 diff --git a/marked/Rel-16/24_series/24011/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg b/marked/Rel-16/24_series/24011/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..37d638605d443c6e6829c9ad06a7c8515abc4fc9 --- /dev/null +++ b/marked/Rel-16/24_series/24011/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ecb15e00d72cf8623e2b3eb70f5b5b4522d7f17e0c2d189ce300356a133808da +size 59460 diff --git a/marked/Rel-16/24_series/24011/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg b/marked/Rel-16/24_series/24011/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..414be149ecfb450d6c859528b1a6e433e5efbe48 --- /dev/null +++ b/marked/Rel-16/24_series/24011/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:156be8abd4db32760def26180105acf410e0ec0514a63163671820e4560a8ee1 +size 91095 diff --git a/marked/Rel-16/24_series/24011/347010b7ac06d3ae97927fde0f784d7c_img.jpg b/marked/Rel-16/24_series/24011/347010b7ac06d3ae97927fde0f784d7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da58b4f69d26ef4cda78f7e49c069fd20cab5a3b --- /dev/null +++ b/marked/Rel-16/24_series/24011/347010b7ac06d3ae97927fde0f784d7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d7907a10392f517b6ce7c68bc71654a6ec2752659de484a91af7c70c6d5be02 +size 78223 diff --git a/marked/Rel-16/24_series/24011/3750b0149a6380885998ab3ca6a8787c_img.jpg b/marked/Rel-16/24_series/24011/3750b0149a6380885998ab3ca6a8787c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..193c8c07deb17b07151bf24b4509174af05e1217 --- /dev/null +++ b/marked/Rel-16/24_series/24011/3750b0149a6380885998ab3ca6a8787c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27fe6c043c7dc98223bf07efd86bcadf15fc914dda46683c1edcef0181f47c96 +size 26746 diff --git a/marked/Rel-16/24_series/24011/38d82ffe820e339811b396206f40a201_img.jpg b/marked/Rel-16/24_series/24011/38d82ffe820e339811b396206f40a201_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28bef4c0be67bd12e5b358407d87ba78c7bd004e --- /dev/null +++ b/marked/Rel-16/24_series/24011/38d82ffe820e339811b396206f40a201_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:36477932d760ae8d05012bcd690a880c531157cb786777bddc7d08a1118eff24 +size 90676 diff --git a/marked/Rel-16/24_series/24011/4806f9f95fff13a30d6523bd6ffeac63_img.jpg b/marked/Rel-16/24_series/24011/4806f9f95fff13a30d6523bd6ffeac63_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..579ae4e50a464ba6c771148a66cd1c5b0a7bdd7e --- /dev/null +++ b/marked/Rel-16/24_series/24011/4806f9f95fff13a30d6523bd6ffeac63_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65553c196e734f821c2176f2f5c3c26564707cdd306b0b296b789315328ee5e4 +size 24229 diff --git a/marked/Rel-16/24_series/24011/49fe8fe978c0f7e73112d231feb377eb_img.jpg b/marked/Rel-16/24_series/24011/49fe8fe978c0f7e73112d231feb377eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac2550eac34b6ab758b82155c972e11176df5ec5 --- /dev/null +++ b/marked/Rel-16/24_series/24011/49fe8fe978c0f7e73112d231feb377eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:002a5e175b7d19ea2376aab9dd3fef6ea1cbc4fb164248e6c620b250a161643e +size 24099 diff --git a/marked/Rel-16/24_series/24011/4b398c5e8c4fd656d5b7a61806400650_img.jpg b/marked/Rel-16/24_series/24011/4b398c5e8c4fd656d5b7a61806400650_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bac33c2d47308ff142376eb19fbde5bd4eda6a5e --- /dev/null +++ b/marked/Rel-16/24_series/24011/4b398c5e8c4fd656d5b7a61806400650_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2429654a01a037c00310db75119964f6193d4616a06e98e488563b0a0341e9c9 +size 140353 diff --git a/marked/Rel-16/24_series/24011/536768a30136cd5c2d57f46c25d1d804_img.jpg b/marked/Rel-16/24_series/24011/536768a30136cd5c2d57f46c25d1d804_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..22cdf2f07cc3ca3d6d4a67879170551559fc3a20 --- /dev/null +++ b/marked/Rel-16/24_series/24011/536768a30136cd5c2d57f46c25d1d804_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc3c606717d1628b2b07e2e9e1c7a4d90b6bb37d078fe2db17e3191550af4fba +size 86050 diff --git a/marked/Rel-16/24_series/24011/56a5265d174ce056c1dbe5e7a60839fc_img.jpg b/marked/Rel-16/24_series/24011/56a5265d174ce056c1dbe5e7a60839fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f99272e0277bb3b6b39efe214e2d5684d9d9d9df --- /dev/null +++ b/marked/Rel-16/24_series/24011/56a5265d174ce056c1dbe5e7a60839fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:96008bc7c1d2777964c01460316274a9e3f8a0b10ae8774253e424b974f0fb13 +size 46879 diff --git a/marked/Rel-16/24_series/24011/575d7d345b3ec04393bb2ec720ebabca_img.jpg b/marked/Rel-16/24_series/24011/575d7d345b3ec04393bb2ec720ebabca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..70439c6052d53a55f2748bafbb2c6a1768f12d71 --- /dev/null +++ b/marked/Rel-16/24_series/24011/575d7d345b3ec04393bb2ec720ebabca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b872d57d34b429866d5e7f3fd117ad550d040f880d77ed5512d5ac0912b4a76b +size 118103 diff --git a/marked/Rel-16/24_series/24011/57939c16065211317c5442cf2a4009e0_img.jpg b/marked/Rel-16/24_series/24011/57939c16065211317c5442cf2a4009e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da85c5b27d11f1e4e72d4ef7c081a5390de3fe61 --- /dev/null +++ b/marked/Rel-16/24_series/24011/57939c16065211317c5442cf2a4009e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c2fa5830e3e63853c4fe24c213e651ca01979133448cce251b2627d4b760f12 +size 51300 diff --git a/marked/Rel-16/24_series/24011/5801c19431e76330430e92a598cc7a16_img.jpg b/marked/Rel-16/24_series/24011/5801c19431e76330430e92a598cc7a16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aee640a3217e0ae9ba450d160130e1f118de656c --- /dev/null +++ b/marked/Rel-16/24_series/24011/5801c19431e76330430e92a598cc7a16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bbb19e72cea849cfca0d28fb87f48309a0343f8aedb7041831f8cc3b600caf8a +size 70255 diff --git a/marked/Rel-16/24_series/24011/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/24_series/24011/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..65c0a101fb0e5506a491525ab33fd91f39814e77 --- /dev/null +++ b/marked/Rel-16/24_series/24011/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c5026a8e0d7d3a6234f1f5bba15d506d4f9c0071c11db3071ab00f43f3512fb +size 26600 diff --git a/marked/Rel-16/24_series/24011/5cf80bac69830ea773ac17c87e0ae24d_img.jpg b/marked/Rel-16/24_series/24011/5cf80bac69830ea773ac17c87e0ae24d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c56a032f11e259c61b050d398faed72647a4220f --- /dev/null +++ b/marked/Rel-16/24_series/24011/5cf80bac69830ea773ac17c87e0ae24d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0732a3858ee7a22881e548a6253247aefb5d22da1161305c10155aa629d96623 +size 79434 diff --git a/marked/Rel-16/24_series/24011/5e9af8986a5845504f251d3079da8078_img.jpg b/marked/Rel-16/24_series/24011/5e9af8986a5845504f251d3079da8078_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cbc52834651f6aa863efa6bd5375a7c17f5ade88 --- /dev/null +++ b/marked/Rel-16/24_series/24011/5e9af8986a5845504f251d3079da8078_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef27dc6bcc89c0da8948ea155e4083c573b056895325605851708f63eefd941e +size 75994 diff --git a/marked/Rel-16/24_series/24011/61a7f401eb46fe99a71f27bc37493f04_img.jpg b/marked/Rel-16/24_series/24011/61a7f401eb46fe99a71f27bc37493f04_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9a877c89d9e2e9fbb47d6d5d10eb66fa2b7f6471 --- /dev/null +++ b/marked/Rel-16/24_series/24011/61a7f401eb46fe99a71f27bc37493f04_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d29da6fd7de56e66f00776a1ca203ad3420e59e504e8116addc594be03081f3 +size 70214 diff --git a/marked/Rel-16/24_series/24011/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg b/marked/Rel-16/24_series/24011/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..66c20a8d1f9492c71af8be3a42ee3fd6068434b1 --- /dev/null +++ b/marked/Rel-16/24_series/24011/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00a6e1f98c25a64c2c4a1a22c62cab42e14c16e2233a08e3b7b40992ef56400f +size 156253 diff --git a/marked/Rel-16/24_series/24011/65e8c0628536d6d4245e9ab46ba070c3_img.jpg b/marked/Rel-16/24_series/24011/65e8c0628536d6d4245e9ab46ba070c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6272cdf582ad5084e3911dd41e9c3a69d3fe96bb --- /dev/null +++ b/marked/Rel-16/24_series/24011/65e8c0628536d6d4245e9ab46ba070c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c8cc0089b5d84558b8c859f6902b6a2f5cb3d1e6df2711efce3462443951e6ba +size 84754 diff --git a/marked/Rel-16/24_series/24011/684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg b/marked/Rel-16/24_series/24011/684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..935e5cd225788ba70a115993e3697c1ab0420c69 --- /dev/null +++ b/marked/Rel-16/24_series/24011/684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d264339b1dc7583fe1078b0dc1bd798ebe515f736b2fc0f69f03302c9a388861 +size 168251 diff --git a/marked/Rel-16/24_series/24011/686b6779045a75d57a4cff59aed11dc8_img.jpg b/marked/Rel-16/24_series/24011/686b6779045a75d57a4cff59aed11dc8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..27285d1a6949c089fd1d2a81a8c4dca5b4efa6b2 --- /dev/null +++ b/marked/Rel-16/24_series/24011/686b6779045a75d57a4cff59aed11dc8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:226a560eb78ca8e361af01a5204407b97972757835b97573905a28870236bae7 +size 19311 diff --git a/marked/Rel-16/24_series/24011/69467ece0a576b4c2ec3e0c89ba61527_img.jpg b/marked/Rel-16/24_series/24011/69467ece0a576b4c2ec3e0c89ba61527_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d18fbf7876787a11c6f136c83be8569cf4d55e24 --- /dev/null +++ b/marked/Rel-16/24_series/24011/69467ece0a576b4c2ec3e0c89ba61527_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc3527b0b981aef68bc753c43b5b6f8f4cd87426f2284cac84841f3e6feb6f3d +size 89981 diff --git a/marked/Rel-16/24_series/24011/694df81535f89c7bfb9ef0df6f130dc0_img.jpg b/marked/Rel-16/24_series/24011/694df81535f89c7bfb9ef0df6f130dc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59aa3d43a589830c0474f5aaec51ddcd02dd5c20 --- /dev/null +++ b/marked/Rel-16/24_series/24011/694df81535f89c7bfb9ef0df6f130dc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b18d440b7cc5ad779cb9b39edc8e8479b044d4ae3b374824e756ef8d88888b9d +size 47026 diff --git a/marked/Rel-16/24_series/24011/6a993bfdf2e00cfad01c4d2188a75d86_img.jpg b/marked/Rel-16/24_series/24011/6a993bfdf2e00cfad01c4d2188a75d86_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c35e32285e6736d9e562158254a19c2adc97552 --- /dev/null +++ b/marked/Rel-16/24_series/24011/6a993bfdf2e00cfad01c4d2188a75d86_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe0c1178453382d6f8de2fb79c9a44253cc269c6a0f3da4e3bddd002dc22cda8 +size 22599 diff --git a/marked/Rel-16/24_series/24011/6e9d059430baba0c363e33749f68b107_img.jpg b/marked/Rel-16/24_series/24011/6e9d059430baba0c363e33749f68b107_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..763595f7bdc90733a233ee0e12e1aabf4e101ce4 --- /dev/null +++ b/marked/Rel-16/24_series/24011/6e9d059430baba0c363e33749f68b107_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6efc622b92101c3ccc0fa776988fe1eb92a4f3bf76fb7a9c4a8a554d4aa9f76b +size 52056 diff --git a/marked/Rel-16/24_series/24011/704082cc3e11776bda29595c76411362_img.jpg b/marked/Rel-16/24_series/24011/704082cc3e11776bda29595c76411362_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5bf227d3d75703aa49b1b762495b90cebe3a2011 --- /dev/null +++ b/marked/Rel-16/24_series/24011/704082cc3e11776bda29595c76411362_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cdf525c840741dc71af276cbe4432628bfe523c5511b378a3d6768cc7e00ad19 +size 47464 diff --git a/marked/Rel-16/24_series/24011/719ef0f734259484038b2434e5dc3f24_img.jpg b/marked/Rel-16/24_series/24011/719ef0f734259484038b2434e5dc3f24_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7918009eb04815e52e3720ccf353239e908268c --- /dev/null +++ b/marked/Rel-16/24_series/24011/719ef0f734259484038b2434e5dc3f24_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d844eddcf479372049cfcf3e54d347f1b29add224403d2784c1c5ab6cfe6df79 +size 24312 diff --git a/marked/Rel-16/24_series/24011/72d448a65347c51989171748789c7d4b_img.jpg b/marked/Rel-16/24_series/24011/72d448a65347c51989171748789c7d4b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93f5631602647d8ef02acaecc9863a375ba531f2 --- /dev/null +++ b/marked/Rel-16/24_series/24011/72d448a65347c51989171748789c7d4b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ebcc75df6d19bdfb7db954ddce591b31273cc8080e53b1fa91aa97fb587c6556 +size 77602 diff --git a/marked/Rel-16/24_series/24011/750b1652a4f4791b84c02aa755a1dedd_img.jpg b/marked/Rel-16/24_series/24011/750b1652a4f4791b84c02aa755a1dedd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..45c088027ea0f6da3f5cc6696b2e9e1d7665c7d7 --- /dev/null +++ b/marked/Rel-16/24_series/24011/750b1652a4f4791b84c02aa755a1dedd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:284b752ac763ebb4201cb1120d9d2d99e875ecb5c23141c8dc7f1745a0dbca61 +size 76640 diff --git a/marked/Rel-16/24_series/24011/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-16/24_series/24011/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a09987b47b1876d97f2d466d086c2afe6a8ae6ef --- /dev/null +++ b/marked/Rel-16/24_series/24011/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a47628853e544a3e020d807f0bf80af09c7ad8f9aba581f59b375c2fe2d35e9f +size 35863 diff --git a/marked/Rel-16/24_series/24011/8b5a2bf5517051acf8bcc2587bcb73a1_img.jpg b/marked/Rel-16/24_series/24011/8b5a2bf5517051acf8bcc2587bcb73a1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfa43d9e7a75f0b020bd7fe8fe5cda18fd8912e1 --- /dev/null +++ b/marked/Rel-16/24_series/24011/8b5a2bf5517051acf8bcc2587bcb73a1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9765c6d09e5374b50ac462980fca698e8ac1b64799a80e95c3597d96bf20887 +size 11499 diff --git a/marked/Rel-16/24_series/24011/8c880d6b715587bd710a9ba8414469b1_img.jpg b/marked/Rel-16/24_series/24011/8c880d6b715587bd710a9ba8414469b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0e46608ff1a00527ac97b177d45abfa8dd4f5509 --- /dev/null +++ b/marked/Rel-16/24_series/24011/8c880d6b715587bd710a9ba8414469b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d4cb8d86eecb5ee8f539be7231fbc590aa3ecbc7726784620106017bc0b25f40 +size 26508 diff --git a/marked/Rel-16/24_series/24011/921f8fa0f7ce2c9956f20d33162c13a2_img.jpg b/marked/Rel-16/24_series/24011/921f8fa0f7ce2c9956f20d33162c13a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..badf1907d2bc840bcd325b45096117171091e8f7 --- /dev/null +++ b/marked/Rel-16/24_series/24011/921f8fa0f7ce2c9956f20d33162c13a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7d73816505c348b027295c31dfe229975522b2d2d57d36feb521938733cc3825 +size 51493 diff --git a/marked/Rel-16/24_series/24011/92724c769da9d46b730fde1a6dccb023_img.jpg b/marked/Rel-16/24_series/24011/92724c769da9d46b730fde1a6dccb023_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..601923ebdf1ed6fbbee9374b702baa05542ffd42 --- /dev/null +++ b/marked/Rel-16/24_series/24011/92724c769da9d46b730fde1a6dccb023_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:891fc19f061eec42e972cd398ae264295723d0d5964f5f18c391430b3ce64beb +size 40362 diff --git a/marked/Rel-16/24_series/24011/93bd00a00fa28558486f0664550699b1_img.jpg b/marked/Rel-16/24_series/24011/93bd00a00fa28558486f0664550699b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f66f407c51b1048e5963ad8c260b5ad5e46adb71 --- /dev/null +++ b/marked/Rel-16/24_series/24011/93bd00a00fa28558486f0664550699b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b765db8af8d402b289aa010dcb7cb2810a18d38df35165eba5b0048fb374bd7 +size 150334 diff --git a/marked/Rel-16/24_series/24011/9b1ec0090070bdf52ea28763b8d52477_img.jpg b/marked/Rel-16/24_series/24011/9b1ec0090070bdf52ea28763b8d52477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4528776a7488b52ed5bf2ad741967e7252ca63b6 --- /dev/null +++ b/marked/Rel-16/24_series/24011/9b1ec0090070bdf52ea28763b8d52477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:171f38c07dff560dba6db7978f9ad9c256a99637bc34bfa8c26f50f880dccdb5 +size 75072 diff --git a/marked/Rel-16/24_series/24011/9ba75f891de20483c291538e38701d96_img.jpg b/marked/Rel-16/24_series/24011/9ba75f891de20483c291538e38701d96_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..805ab7e71369ad779275e4ba9938d4b0b56746ef --- /dev/null +++ b/marked/Rel-16/24_series/24011/9ba75f891de20483c291538e38701d96_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f79ffb3e431357a29040aaadbed3f04bb2ec19eb1b27c6958f37d46ce9dd9d4b +size 92574 diff --git a/marked/Rel-16/24_series/24011/9c45844d796e85ae05505870a54e4eb4_img.jpg b/marked/Rel-16/24_series/24011/9c45844d796e85ae05505870a54e4eb4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0ef9d7bf1d2bd4ccd8d57bc3bcdf55e0626aa33 --- /dev/null +++ b/marked/Rel-16/24_series/24011/9c45844d796e85ae05505870a54e4eb4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0cec67626970c7e4a6feed2a885e8296d4657a26664c0a37235871f506ecfba9 +size 44210 diff --git a/marked/Rel-16/24_series/24011/9e3c3a68ea23d6b0c0243f2baa1cb99f_img.jpg b/marked/Rel-16/24_series/24011/9e3c3a68ea23d6b0c0243f2baa1cb99f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7b05d2c116e9299252464b11e75ea3b5645cdea1 --- /dev/null +++ b/marked/Rel-16/24_series/24011/9e3c3a68ea23d6b0c0243f2baa1cb99f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dab1a90abe8e1384b1373e55b61d7727ccfc6eba6154704032a52443bc8d1290 +size 81954 diff --git a/marked/Rel-16/24_series/24011/9f51a76cae7309a296cbc6997941eb3f_img.jpg b/marked/Rel-16/24_series/24011/9f51a76cae7309a296cbc6997941eb3f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..852c6562cf3aad3abcf741e4c37ff8dcda69a940 --- /dev/null +++ b/marked/Rel-16/24_series/24011/9f51a76cae7309a296cbc6997941eb3f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6d8b446f33496abf3c03b626d8e4f846e21f0ba42873c379382563bc7761dc20 +size 58756 diff --git a/marked/Rel-16/24_series/24011/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/24_series/24011/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9ab79cc14bd92066ca1a8527871d1dffc91a0301 --- /dev/null +++ b/marked/Rel-16/24_series/24011/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b136c01bd8a6c3183b727b5824e6c501d7c5d45ff0de3ef8c168cc3f858e4ab1 +size 35520 diff --git a/marked/Rel-16/24_series/24011/a5404b7275b06497eecf9b5883604753_img.jpg b/marked/Rel-16/24_series/24011/a5404b7275b06497eecf9b5883604753_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4827d732dc43820e9c070869991dd95346b07080 --- /dev/null +++ b/marked/Rel-16/24_series/24011/a5404b7275b06497eecf9b5883604753_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44ded825ada0c8e6f0902c3e65e31bbdc80cfbd213d6b1b915894dce8a38e255 +size 44013 diff --git a/marked/Rel-16/24_series/24011/a70e0adcabc973b01b413b6a141884f3_img.jpg b/marked/Rel-16/24_series/24011/a70e0adcabc973b01b413b6a141884f3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..79d8a5bc1d29f03cac3a9e2c6ed2124613975a5a --- /dev/null +++ b/marked/Rel-16/24_series/24011/a70e0adcabc973b01b413b6a141884f3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:963b5f5688dfb3c579476f13e8725bc7a55a79dc136ce400603b9bb55097e133 +size 73221 diff --git a/marked/Rel-16/24_series/24011/a7450c80e88ad3f6ca1427ad84020998_img.jpg b/marked/Rel-16/24_series/24011/a7450c80e88ad3f6ca1427ad84020998_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07a2ec77ce6d1d315d42be31465dbaf1ff65d81f --- /dev/null +++ b/marked/Rel-16/24_series/24011/a7450c80e88ad3f6ca1427ad84020998_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:89e84f1b49a70f9c3152b1fcfbdee2a65c5c5e0c376ae19a657ac1695a3addec +size 26161 diff --git a/marked/Rel-16/24_series/24011/a7c51c18111139f9aca2805114108565_img.jpg b/marked/Rel-16/24_series/24011/a7c51c18111139f9aca2805114108565_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b1274b06ffd94b8b8d6dffb46a6e255fd16e5a23 --- /dev/null +++ b/marked/Rel-16/24_series/24011/a7c51c18111139f9aca2805114108565_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59341a413fdd85413747c51b1f820fb819905d8417cce280fe7e2647701b0b72 +size 59492 diff --git a/marked/Rel-16/24_series/24011/a963ca41bde1669b18a4b783616f228b_img.jpg b/marked/Rel-16/24_series/24011/a963ca41bde1669b18a4b783616f228b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c619712bf35f6ce95bb886f9326b3573e2afcd61 --- /dev/null +++ b/marked/Rel-16/24_series/24011/a963ca41bde1669b18a4b783616f228b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e130f2107792275d2c6f60cb84aa19d6c327f0ce4d326dd3c605e23c21a8715 +size 52349 diff --git a/marked/Rel-16/24_series/24011/b0211cee4b20034939d883ac0d70f696_img.jpg b/marked/Rel-16/24_series/24011/b0211cee4b20034939d883ac0d70f696_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f048d0785c917e1b1638f6a0d702cc3397f3b25a --- /dev/null +++ b/marked/Rel-16/24_series/24011/b0211cee4b20034939d883ac0d70f696_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47c95f77dd1aed6ce9b3977247cdb46abe920a78880843e28ae4c4fb2503b63a +size 29461 diff --git a/marked/Rel-16/24_series/24011/b02ba0b73e95416eb547976f6145b169_img.jpg b/marked/Rel-16/24_series/24011/b02ba0b73e95416eb547976f6145b169_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ca12c63c4c5d998f416e8a65050c3bf8c3f0fde --- /dev/null +++ b/marked/Rel-16/24_series/24011/b02ba0b73e95416eb547976f6145b169_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:177da821409736a643d1d8e93838f52a4105ee6f29c5b6ce00fcca74a2cc67ef +size 146925 diff --git a/marked/Rel-16/24_series/24011/b13465efdac63129aef9b6f1787d0d00_img.jpg b/marked/Rel-16/24_series/24011/b13465efdac63129aef9b6f1787d0d00_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b044192362a8b8dfe8bb23234ab751dd2bcdb9b3 --- /dev/null +++ b/marked/Rel-16/24_series/24011/b13465efdac63129aef9b6f1787d0d00_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e26ae881cef46d8090d7390460b1c4d3701a5e79f24dafc070052c6e684ab68 +size 117730 diff --git a/marked/Rel-16/24_series/24011/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg b/marked/Rel-16/24_series/24011/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63b82488e6b2bc61aaec47bea28c5c00829c5f2b --- /dev/null +++ b/marked/Rel-16/24_series/24011/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ffbd838bf4a38ed1560440db1223bae7be40106a78c6f1b6fd67c656a28c0611 +size 141098 diff --git a/marked/Rel-16/24_series/24011/b50f38be091844d58b11e3d47bc71e73_img.jpg b/marked/Rel-16/24_series/24011/b50f38be091844d58b11e3d47bc71e73_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..51b0d25be3242005c400cb4d2e3c62151bae8563 --- /dev/null +++ b/marked/Rel-16/24_series/24011/b50f38be091844d58b11e3d47bc71e73_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4579e769742f495aaf1f5e907c75d19691f81821e72e0cd431d3de9b6c093b8c +size 65189 diff --git a/marked/Rel-16/24_series/24011/b63f41ca262d8ce9ef8affb62607f32b_img.jpg b/marked/Rel-16/24_series/24011/b63f41ca262d8ce9ef8affb62607f32b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..41940c2b9877a380f8c67a0900be7be03cbe60bf --- /dev/null +++ b/marked/Rel-16/24_series/24011/b63f41ca262d8ce9ef8affb62607f32b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc3b3a514760a162575945fda06b1e27a969e1a55845c8ec22e8702ec8900892 +size 39346 diff --git a/marked/Rel-16/24_series/24011/ba676d18b6a00f27c5bfaec9eeec20be_img.jpg b/marked/Rel-16/24_series/24011/ba676d18b6a00f27c5bfaec9eeec20be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..65554cc807921b1a548896f1d484df7556f6129d --- /dev/null +++ b/marked/Rel-16/24_series/24011/ba676d18b6a00f27c5bfaec9eeec20be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d1928af357c87589e4127f288174a846699b4aa44187e4873d71b511056a4fa8 +size 76080 diff --git a/marked/Rel-16/24_series/24011/bccc028d0e75bc30c41528056f581545_img.jpg b/marked/Rel-16/24_series/24011/bccc028d0e75bc30c41528056f581545_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eb8f318028bca3a7b876ee5b815671153bfa8a52 --- /dev/null +++ b/marked/Rel-16/24_series/24011/bccc028d0e75bc30c41528056f581545_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40785b0ae4257de1794072c54e7cd36b81feb8aaba25ad7121eb34ad79af9071 +size 127648 diff --git a/marked/Rel-16/24_series/24011/c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg b/marked/Rel-16/24_series/24011/c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b3d59c8b1324b9b7b3eb4a97346e03c1a1096d4c --- /dev/null +++ b/marked/Rel-16/24_series/24011/c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e356b49fde52cb00a3b838553bbd34e3753b48e2722003c79e5428363a8b34d +size 75883 diff --git a/marked/Rel-16/24_series/24011/c07e21a8d65991db04263322f859c94f_img.jpg b/marked/Rel-16/24_series/24011/c07e21a8d65991db04263322f859c94f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4708f878dc3d486fc3976ed0692d564fd075dab2 --- /dev/null +++ b/marked/Rel-16/24_series/24011/c07e21a8d65991db04263322f859c94f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc0fca9bb50b39c43e257a6cf77f6456008d3ebd507a02eff277ca34db8746cf +size 94932 diff --git a/marked/Rel-16/24_series/24011/c0ca823603794512478906b302176bca_img.jpg b/marked/Rel-16/24_series/24011/c0ca823603794512478906b302176bca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..86255a1677767955a395e4f65730b5b314ee6fd1 --- /dev/null +++ b/marked/Rel-16/24_series/24011/c0ca823603794512478906b302176bca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65ed5bac9d72a1e23c0324d108b578a17a4a2ec3efd843bbf89ff5c2e66646ea +size 69414 diff --git a/marked/Rel-16/24_series/24011/c21bad844b5cb6026c067a1f43ce67c3_img.jpg b/marked/Rel-16/24_series/24011/c21bad844b5cb6026c067a1f43ce67c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..416ea55b4f3ed22f73be269bbef44a894c2bff5b --- /dev/null +++ b/marked/Rel-16/24_series/24011/c21bad844b5cb6026c067a1f43ce67c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7f8ddc580e0d841c87bfaf4529d2357f510f466e11bc00a747a0a20aeffae48 +size 65196 diff --git a/marked/Rel-16/24_series/24011/c2fc2621e8206d24427b56bcb2398fc0_img.jpg b/marked/Rel-16/24_series/24011/c2fc2621e8206d24427b56bcb2398fc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b5474fb38e66a3cdbfb73855b0c50d4bab4c1308 --- /dev/null +++ b/marked/Rel-16/24_series/24011/c2fc2621e8206d24427b56bcb2398fc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aea3491ddd1c72c8e71b23ddf3b0c4323d50bb817e61e2d27b2939f008f23b9f +size 33277 diff --git a/marked/Rel-16/24_series/24011/c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg b/marked/Rel-16/24_series/24011/c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f080ca214248114522a0bd2bb198d1b9e88ad204 --- /dev/null +++ b/marked/Rel-16/24_series/24011/c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4009f58f45448baad39e06e19a13e769b89c9a3536c4ac8db9db5de218ca6d71 +size 125602 diff --git a/marked/Rel-16/24_series/24011/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/marked/Rel-16/24_series/24011/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c7a3105c897def36042f183acda114dfca5bfbc --- /dev/null +++ b/marked/Rel-16/24_series/24011/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1494c1a8866f98c7b53d0ea51953c088623e6ccb5ce7aeb9336810dc4e873eb5 +size 25903 diff --git a/marked/Rel-16/24_series/24011/cc7baa8e5118f4b42c01166637c738ea_img.jpg b/marked/Rel-16/24_series/24011/cc7baa8e5118f4b42c01166637c738ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc6ce8276a3d6dc9d7e5f7c87dcd03c0cf8578b7 --- /dev/null +++ b/marked/Rel-16/24_series/24011/cc7baa8e5118f4b42c01166637c738ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a3d95f13f32dcbe30dface8bd72c19d313a4e054da4e69610d085964c947826 +size 69452 diff --git a/marked/Rel-16/24_series/24011/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg b/marked/Rel-16/24_series/24011/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36724b4f0281f9bd096208f9acb143e488ac089d --- /dev/null +++ b/marked/Rel-16/24_series/24011/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e01a98bf759498deb571856de63cb611af0719cae50d23f9fc1ddca0477d70d7 +size 156884 diff --git a/marked/Rel-16/24_series/24011/d2417b04116c354deccb25d98a84a0fb_img.jpg b/marked/Rel-16/24_series/24011/d2417b04116c354deccb25d98a84a0fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..feaf74a9a0ae017b2da1edca14e4ac47a384140b --- /dev/null +++ b/marked/Rel-16/24_series/24011/d2417b04116c354deccb25d98a84a0fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01fc6df046097e7295650963941659e5bb20afb8085015048518d2a58e45f359 +size 77630 diff --git a/marked/Rel-16/24_series/24011/db39acbd11df5eb7e79ab84562fb8f74_img.jpg b/marked/Rel-16/24_series/24011/db39acbd11df5eb7e79ab84562fb8f74_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8b14618ea721d2cb67e6585dbb611db9f7ca9bf7 --- /dev/null +++ b/marked/Rel-16/24_series/24011/db39acbd11df5eb7e79ab84562fb8f74_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e66d20228f4f8a3edef0bb2b4b596e1dc7b1c7f6267a940133446a62179ab413 +size 123187 diff --git a/marked/Rel-16/24_series/24011/dbd4bab54b57e8d1abf80e3de6471130_img.jpg b/marked/Rel-16/24_series/24011/dbd4bab54b57e8d1abf80e3de6471130_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fd72f37d603efce4b2353127792f1f98f297d0cf --- /dev/null +++ b/marked/Rel-16/24_series/24011/dbd4bab54b57e8d1abf80e3de6471130_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:822f4e9ca282696e77de54c181d3d4af0b70f55fa5b10fb5f791f59f7d90c971 +size 44581 diff --git a/marked/Rel-16/24_series/24011/de63e4b6d8b0aa76b85e1fe3236eac27_img.jpg b/marked/Rel-16/24_series/24011/de63e4b6d8b0aa76b85e1fe3236eac27_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4272c6aa6f68149c43035a14525c4d9ad56b35a0 --- /dev/null +++ b/marked/Rel-16/24_series/24011/de63e4b6d8b0aa76b85e1fe3236eac27_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:004ccff1870c1916e046c01634fd300a753d603518a8a7fd5d8de5d938b1ff32 +size 23978 diff --git a/marked/Rel-16/24_series/24011/e16bfa31d748f4d99ec4ae3d16656926_img.jpg b/marked/Rel-16/24_series/24011/e16bfa31d748f4d99ec4ae3d16656926_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f4faf769b98b7babbc0621e81bc447f662b02089 --- /dev/null +++ b/marked/Rel-16/24_series/24011/e16bfa31d748f4d99ec4ae3d16656926_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5cb48808a5fc7e78bda49a0b346ccc158114d85ffb8b21c3e545008538813eac +size 62532 diff --git a/marked/Rel-16/24_series/24011/e18841eb4a995df8354a793459e12fd0_img.jpg b/marked/Rel-16/24_series/24011/e18841eb4a995df8354a793459e12fd0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..81ff4271846cdf39e88e8a760cc4096529caad61 --- /dev/null +++ b/marked/Rel-16/24_series/24011/e18841eb4a995df8354a793459e12fd0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df999099767dcc53483d1b00ecc767f499ae7a9476d546f7106bf80c8423e62c +size 44907 diff --git a/marked/Rel-16/24_series/24011/e2c120be98ede6deb60dd341f5a9803b_img.jpg b/marked/Rel-16/24_series/24011/e2c120be98ede6deb60dd341f5a9803b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24cd3a7abbc0adf200e3b9dc143ce3ced988ae95 --- /dev/null +++ b/marked/Rel-16/24_series/24011/e2c120be98ede6deb60dd341f5a9803b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3a17d8db4bb696398fbc78068cad24e04bde02101bc1e810133cf5fd75fb5a12 +size 96251 diff --git a/marked/Rel-16/24_series/24011/e7010c66da16316c2935dfbbef5056b3_img.jpg b/marked/Rel-16/24_series/24011/e7010c66da16316c2935dfbbef5056b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a83eaadff96b6f1e0e4153aaa3a0b76a430de96e --- /dev/null +++ b/marked/Rel-16/24_series/24011/e7010c66da16316c2935dfbbef5056b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85091b9c75fdd65f06347acd1d176e1445309085a1bd0902d31204b0b4a86f45 +size 77782 diff --git a/marked/Rel-16/24_series/24011/eabcb2f8b9acedb194571d5bc734b463_img.jpg b/marked/Rel-16/24_series/24011/eabcb2f8b9acedb194571d5bc734b463_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf03975459a095536c13247887f1bebf03eeb06f --- /dev/null +++ b/marked/Rel-16/24_series/24011/eabcb2f8b9acedb194571d5bc734b463_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07338904f16e580b97d55824f5d9013c8876d13184d666b946713bd11f429e67 +size 23743 diff --git a/marked/Rel-16/24_series/24011/ef45b00396c293be0b18d32b97118bf4_img.jpg b/marked/Rel-16/24_series/24011/ef45b00396c293be0b18d32b97118bf4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49dd5371edb6c209a313c3b03427b166c2a92436 --- /dev/null +++ b/marked/Rel-16/24_series/24011/ef45b00396c293be0b18d32b97118bf4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:500320532953ff5811419b38242c7b69e970cd0e925426f42fa988fc79e5e124 +size 43336 diff --git a/marked/Rel-16/24_series/24011/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg b/marked/Rel-16/24_series/24011/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ce644ea5fcbba12834dfa8697ac7e997ea8e0164 --- /dev/null +++ b/marked/Rel-16/24_series/24011/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0aba6a4050bdb46666272a95796c3d22e5cc645a2205d081119cb9a12a0e898d +size 97582 diff --git a/marked/Rel-16/24_series/24011/f61d0925551545b5938b3a4d1bbf63c3_img.jpg b/marked/Rel-16/24_series/24011/f61d0925551545b5938b3a4d1bbf63c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a41073c6788ad283f4703f967007ef0bd0e89f8 --- /dev/null +++ b/marked/Rel-16/24_series/24011/f61d0925551545b5938b3a4d1bbf63c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d0fbc79ccac94b1e32016733537966cc5cae52600b3ac4da512a855b5a20d56 +size 41295 diff --git a/marked/Rel-16/24_series/24011/fb4274c4b7882a4059103f1dbca9b111_img.jpg b/marked/Rel-16/24_series/24011/fb4274c4b7882a4059103f1dbca9b111_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..37dcf0b06948ddd3643746dfdbab49b7fcdd3dce --- /dev/null +++ b/marked/Rel-16/24_series/24011/fb4274c4b7882a4059103f1dbca9b111_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b67d2b32610fb5406f59cd37b3ff2a1c248dbf44d7d6ed02210d7ec033e6e0f +size 114569 diff --git a/marked/Rel-16/24_series/24011/fc3e2b49a9f850951570e502393b697f_img.jpg b/marked/Rel-16/24_series/24011/fc3e2b49a9f850951570e502393b697f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28e88a9763193bf6455266afc4e5d903a68cbe7c --- /dev/null +++ b/marked/Rel-16/24_series/24011/fc3e2b49a9f850951570e502393b697f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f95e55a4d80f0b3f77f66f03fbad4053224e540c13eb6f8448692e123cbfd14d +size 44120 diff --git a/marked/Rel-16/24_series/24011/fcc757566216206ceddbd6c775e8db02_img.jpg b/marked/Rel-16/24_series/24011/fcc757566216206ceddbd6c775e8db02_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76508df6fe299e0a21b683bdecc4b184d2c723a2 --- /dev/null +++ b/marked/Rel-16/24_series/24011/fcc757566216206ceddbd6c775e8db02_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d742751ebd7b4b6f1cedb17c2f2004edf86e0e715283c75ca1e6151ed6eea86 +size 39137 diff --git a/marked/Rel-16/24_series/24011/fd3cbb53e991f8209ba17b398f426e13_img.jpg b/marked/Rel-16/24_series/24011/fd3cbb53e991f8209ba17b398f426e13_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..833489d4a3dc48750b91a42d4744981132eabd71 --- /dev/null +++ b/marked/Rel-16/24_series/24011/fd3cbb53e991f8209ba17b398f426e13_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8826c9f4e915c4fdb6dc2ed4be98854e59caea0365498f03b8af2eb729839a88 +size 65076 diff --git a/marked/Rel-16/24_series/24011/fe7304192caf64cda93b580c5e7e5c06_img.jpg b/marked/Rel-16/24_series/24011/fe7304192caf64cda93b580c5e7e5c06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1979882daf60b59bc7e698093092894e785af779 --- /dev/null +++ b/marked/Rel-16/24_series/24011/fe7304192caf64cda93b580c5e7e5c06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:881bf012caabead95967be611be98e0f9fdcca29e0073bddfb25dadf27a8812f +size 126059 diff --git a/marked/Rel-16/24_series/24011/ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg b/marked/Rel-16/24_series/24011/ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ccab4ba37bce2c7cd0ac300b97e9c08474d4e0b6 --- /dev/null +++ b/marked/Rel-16/24_series/24011/ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b76e0b61f29d86b08767b14f6c411d046b5a186daa508f08377b1843490da828 +size 65655 diff --git a/marked/Rel-16/24_series/24011/ffb6acd27b8e3a54392840948a75869f_img.jpg b/marked/Rel-16/24_series/24011/ffb6acd27b8e3a54392840948a75869f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9421b17f3ca46798c12d5e40e09249649ca9b53 --- /dev/null +++ b/marked/Rel-16/24_series/24011/ffb6acd27b8e3a54392840948a75869f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:902c634bba984d57f65b1480b7769ee57ae37c2b056a0fa76c2c913c9847ab0b +size 79030 diff --git a/marked/Rel-16/24_series/24011/ffe0fef452a0ae9a20253c319c54e13c_img.jpg b/marked/Rel-16/24_series/24011/ffe0fef452a0ae9a20253c319c54e13c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d0d7f62788791f514edf5b934e6709aa3663e4a7 --- /dev/null +++ b/marked/Rel-16/24_series/24011/ffe0fef452a0ae9a20253c319c54e13c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0075c577598d45bb2e98c443acd80102ea1c78daaf8bee7bd117b54a29078b17 +size 72248 diff --git a/marked/Rel-16/24_series/24011/raw.md b/marked/Rel-16/24_series/24011/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2e0d3141ac9f6fddf7ddff477ab2e072359b0afb --- /dev/null +++ b/marked/Rel-16/24_series/24011/raw.md @@ -0,0 +1,5057 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 1.1 References ..... | 8 | +| 1.2 Abbreviations ..... | 9 | +| 2 Overview of Short Message Service (SMS) support ..... | 9 | +| 2.1 Protocols and protocol architecture..... | 10 | +| 2.2 Use of channels (A/Gb mode only)..... | 12 | +| 2.3 Layer 2 SAPI 3 handling for circuit switched in A/Gb mode ..... | 13 | +| 2.4 Layer 2 (LLC) GPRS support (A/Gb mode only)..... | 13 | +| 2.5 GSMS entity in Iu mode..... | 14 | +| 2.5A ESMS entity in S1 mode ..... | 15 | +| 2.5B 5GSMS entity in N1 mode ..... | 15 | +| 2.6 MS support for SMS over GPRS ..... | 16 | +| 2.7 MS support for device triggering short message..... | 16 | +| 3 Service definition ..... | 16 | +| 3.1 General ..... | 16 | +| 3.2 Service provided by the CM-sublayer..... | 17 | +| 3.2.1 Definition of primitives on the MS side ..... | 17 | +| 3.2.1.1 MNSMS-ABORT-REQuest ..... | 17 | +| 3.2.1.2 MNSMS-DATA-REQuest..... | 18 | +| 3.2.1.3 MNSMS-DATA-INDication ..... | 18 | +| 3.2.1.4 MNSMS-ESTablish-RERequest ..... | 18 | +| 3.2.1.5 MNSMS-ESTablish-INDication..... | 18 | +| 3.2.1.6 MNSMS-ERROR-INDication ..... | 18 | +| 3.2.1.7 MNSMS-RELease-RERequest ..... | 18 | +| 3.2.2 Definition of primitives on the network side..... | 18 | +| 3.2.2.1 MNSMS-ABORT-RERequest ..... | 19 | +| 3.2.2.2 MNSMS-DATA-RERequest..... | 19 | +| 3.2.2.3 MNSMS-DATA-INDication ..... | 19 | +| 3.2.2.4 MNSMS-ESTablish-RERequest ..... | 19 | +| 3.2.2.5 MNSMS-ESTablish-INDication..... | 19 | +| 3.2.2.6 MNSMS-ERROR-INDication ..... | 20 | +| 3.2.2.7 MNSMS-RELease-RERequest ..... | 20 | +| 3.3 Service provided by SM-RL ..... | 20 | +| 3.3.1 Definition of primitives on the MS side ..... | 20 | +| 3.3.1.1 SM-RL-DATA-RERequest..... | 20 | +| 3.3.1.2 SM-RL-DATA-INDication ..... | 21 | +| 3.3.1.3 SM-RL-MEMORY-AVAILABLE-RERequest ..... | 21 | +| 3.3.1.4 SM-RL-REPORT-RERequest..... | 21 | +| 3.3.1.5 SM-RL-REPORT-INDication ..... | 21 | +| 3.3.2 Definition of primitives on the network side..... | 21 | +| 3.3.2.1 SM-RL-DATA-RERequest..... | 22 | +| 3.3.2.2 SM-RL-DATA-INDication ..... | 22 | +| 3.3.2.3 SM-RL-MEMORY-AVAILABLE-INDication ..... | 22 | +| 3.3.2.4 SM-RL-REPORT-RERequest..... | 22 | +| 3.3.2.5 SM-RL-REPORT-INDication ..... | 22 | +| 4 Void..... | 22 | +| 5 CM-procedures..... | 22 | +| 5.1 General ..... | 22 | +| 5.2 Short Message Control states ..... | 23 | +| 5.2.1 SMC-CS states at the MS side of the radio interface ..... | 23 | +| 5.2.1.1 Mobile Originating Case..... | 23 | +| 5.2.1.1.1 MO-Idle (State 0) ..... | 23 | +| 5.2.1.1.2 MO-MM-connection pending (State 1)..... | 23 | +| 5.2.1.1.3 MO-Wait for CP-ACK (State 2) ..... | 23 | +| 5.2.1.1.4 MO-MM-connection established (State 3)..... | 23 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 5.2.1.2 | Mobile Terminating case ..... | 23 | +| 5.2.1.2.1 | MT-Idle (State 0)..... | 23 | +| 5.2.1.2.2 | MT-Wait for CP-ACK (State 2)..... | 23 | +| 5.2.1.2.3 | MT-MM-connection established (State 3)..... | 23 | +| 5.2.2 | SMC-GP, SMC-EP and SMC-5G states at the MS side of the radio interface ..... | 24 | +| 5.2.2.1 | Mobile Originating Case..... | 24 | +| 5.2.2.1.1 | MO-Idle (State 0) ..... | 24 | +| 5.2.2.1.2 | MO-GMM-connection pending (State 1) (Iu mode only)..... | 24 | +| 5.2.2.1.3 | MO-Wait for CP-ACK (State 2) ..... | 24 | +| 5.2.2.1.4 | MO-Wait for CP-Data (State 3) ..... | 24 | +| 5.2.2.1.5 | MO-EMM-connection pending (State 4) (S1 mode only) ..... | 24 | +| 5.2.2.2 | Mobile Terminating case ..... | 24 | +| 5.2.2.2.1 | MT-Idle (State 0)..... | 24 | +| 5.2.2.2.2 | MT-Wait for RP-ACK (State 1)..... | 24 | +| 5.2.2.2.3 | MT-Wait for CP-ACK (State 2)..... | 24 | +| 5.2.3 | SMC-CS states at the network side of the radio interface..... | 24 | +| 5.2.3.1 | Mobile Originating Case..... | 24 | +| 5.2.3.1.1 | MO-Idle (State 0) ..... | 25 | +| 5.2.3.1.2 | MO-Wait for CP-ACK (State 2) ..... | 25 | +| 5.2.3.1.3 | MO-MM-connection established (State 3)..... | 25 | +| 5.2.3.2 | Mobile Terminating Case ..... | 25 | +| 5.2.3.2.1 | MT-Idle (State 0)..... | 25 | +| 5.2.3.2.2 | MT-MM-connection pending (State 1)..... | 25 | +| 5.2.3.2.3 | MT-Wait for CP-ACK (State 2)..... | 25 | +| 5.2.3.2.4 | MT-MM-connection established (State 3)..... | 25 | +| 5.2.4 | SMC-GP, SMC-EP and SMC-5G states at the network side of the radio interface..... | 25 | +| 5.2.4.1 | Mobile Originating Case..... | 25 | +| 5.2.4.1.1 | MO-Idle (State 0) ..... | 25 | +| 5.2.4.1.2 | MO-Wait for RP-ACK (State 1) ..... | 26 | +| 5.2.4.1.3 | MO-Wait for CP-ACK(State 2) ..... | 26 | +| 5.2.4.2 | Mobile Terminating Case ..... | 26 | +| 5.2.4.2.1 | MT-Idle (State 0)..... | 26 | +| 5.2.4.2.2 | MT-Wait for CP-ACK (State 1)..... | 26 | +| 5.2.4.2.3 | MT-Wait for CP DATA (State 2) ..... | 26 | +| 5.3 | Short Message Control procedures ..... | 26 | +| 5.3.1 | MM-connection establishment for circuit switched service..... | 26 | +| 5.3.2 | RPDU transfer ..... | 27 | +| 5.3.2.1 | RPDU transfer for circuit switched service ..... | 27 | +| 5.3.2.2 | RPDU transfer for GPRS, EPS and 5GS ..... | 27 | +| 5.3.3 | Release of MM and CM connections ..... | 29 | +| 5.3.4 | Abnormal cases ..... | 29 | +| 5.4 | Concatenating short message or notification transfers..... | 30 | +| 6 | SM-RL-procedures..... | 31 | +| 6.1 | General ..... | 31 | +| 6.2 | Transition states of SMR entity..... | 31 | +| 6.2.1 | SMR-states at the MS-side of the radio interface..... | 31 | +| 6.2.1.1 | Idle (State 0)..... | 31 | +| 6.2.1.2 | Wait for RP-ACK (State 1)..... | 32 | +| 6.2.1.2a | Wait to send RP-ACK (State 3)..... | 32 | +| 6.2.1.3 | Wait for RETRANS TIMER (State 4)..... | 32 | +| 6.2.2 | SMR-states at the network side of the radio interface..... | 32 | +| 6.2.2.1 | Idle (State 0)..... | 32 | +| 6.2.2.2 | Wait for RP-ACK (State 1)..... | 32 | +| 6.2.2.3 | Wait to send RP-ACK (State 3)..... | 32 | +| 6.3 | Short Message Relay procedures ..... | 32 | +| 6.3.1 | TPDU relaying..... | 32 | +| 6.3.2 | [Void] ..... | 33 | +| 6.3.3 | Notification relaying..... | 33 | +| 6.3.3.1 | MS side ..... | 33 | +| 6.3.3.1.1 | Idle state ..... | 33 | +| 6.3.3.1.2 | Wait for RP-ACK state ..... | 33 | + +| | | | +|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 6.3.3.1.3 | Wait for RETRANS Timer state ..... | 34 | +| 6.3.3.2 | Network side ..... | 34 | +| 6.3.3.2.1 | Idle state ..... | 34 | +| 6.3.3.2.2 | Wait to Send RP-ACK state ..... | 34 | +| 6.3.4 | Abnormal cases ..... | 35 | +| 7 | Message functional definitions and content ..... | 35 | +| 7.1 | General ..... | 35 | +| 7.2 | Messages for short message or notification transfer on CM ..... | 35 | +| 7.2.1 | CP-DATA ..... | 35 | +| 7.2.2 | CP-ACK ..... | 35 | +| 7.2.3 | CP-ERROR ..... | 36 | +| 7.3 | Messages for short message and notification transfer on SM-RL ..... | 36 | +| 7.3.1 | RP-DATA ..... | 36 | +| 7.3.1.1 | RP-DATA (Network to Mobile Station) ..... | 36 | +| 7.3.1.2 | RP-DATA (Mobile Station to Network) ..... | 36 | +| 7.3.2 | RP-SMMA ..... | 37 | +| 7.3.3 | RP-ACK ..... | 37 | +| 7.3.4 | RP-ERROR ..... | 37 | +| 8 | Message format and information elements coding ..... | 38 | +| 8.1 | CP-messages ..... | 38 | +| 8.1.1 | General ..... | 38 | +| 8.1.2 | Protocol Discriminator and Transaction Identifier ..... | 38 | +| 8.1.3 | Message type ..... | 38 | +| 8.1.4 | Other required information elements ..... | 38 | +| 8.1.4.1 | CP-User data element ..... | 38 | +| 8.1.4.2 | CP-Cause element ..... | 39 | +| 8.2 | RP-messages ..... | 39 | +| 8.2.1 | General ..... | 39 | +| 8.2.2 | Message type indicator (MTI) ..... | 40 | +| 8.2.3 | Message reference ..... | 40 | +| 8.2.4 | Void ..... | 40 | +| 8.2.5 | Other required information elements ..... | 40 | +| 8.2.5.1 | Originator address element ..... | 40 | +| 8.2.5.2 | Destination address element ..... | 41 | +| 8.2.5.3 | RP-User data element ..... | 42 | +| 8.2.5.4 | RP-Cause element ..... | 42 | +| 9 | Handling of unknown, unforeseen, and erroneous protocol data ..... | 44 | +| 9.1 | General ..... | 44 | +| 9.2 | CP Error Handling ..... | 44 | +| 9.2.1 | Message too short ..... | 45 | +| 9.2.2 | Unknown or unforeseen transaction identifier ..... | 45 | +| 9.2.3 | Unknown or unforeseen message type ..... | 45 | +| 9.2.4 | Non-semantical mandatory information element errors ..... | 45 | +| 9.2.5 | Messages with semantically incorrect contents ..... | 46 | +| 9.3 | RP Error Handling ..... | 46 | +| 9.3.1 | Message too short ..... | 46 | +| 9.3.2 | Unknown or unforeseen Message Reference ..... | 46 | +| 9.3.3 | Unknown or unforeseen message type ..... | 46 | +| 9.3.4 | Non-semantical mandatory information element errors ..... | 47 | +| 9.3.5 | Messages with semantically incorrect contents ..... | 47 | +| 10 | Timers ..... | 47 | +| 10.1 | Timers when the MS is not using EPS services with control plane CIoT EPS optimization and not using 5GS services with control plane CIoT 5GS optimization ..... | 47 | +| 10.2 | Timers when the MS is using EPS services with control plane CIoT EPS optimization or using 5GS services with control plane CIoT 5GS optimization ..... | 47 | + +| | | | +|-------------------------------|--------------------------------------------------------------|------------| +| Annex A (informative): | Arrow diagrams..... | 49 | +| Annex B (normative): | SDL-description of the CM-layer ..... | 60 | +| B.1 | Introduction..... | 60 | +| Annex C (informative): | Arrow diagrams..... | 121 | +| Annex D (normative): | SDL-description of the short message relay layer..... | 127 | +| D.1 | Introduction..... | 127 | +| Annex E (informative): | Cause definition ..... | 135 | +| Annex F (informative): | LAPDm SAPI 3 handling for short message service..... | 140 | +| Annex G (informative): | Change history..... | 147 | + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3rd Generation Partnership Project (3GPP). + +The present document defines the Short Message Service (SMS) support on mobile radio interface within the 3GPP system. + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the procedures used across the mobile radio interface by the signalling layer 3 function Short Message Control (SMC) and Short Message Relay function (SM-RL) for circuit switched in A/Gb mode, GPRS, EPS, and 5GS. + +## 1.1 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] Void. +- [1a] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS) Point-to-Point (PP)". +- [3a] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [3] 3GPP TS 44.006: "Mobile Station - Base Station System (MS - BSS) interface; Data Link (DL) layer specification". +- [4] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [5] 3GPP TS 24.008: "Mobile radio interface layer 3 specification". +- [5a] 3GPP TS 25.331: "Radio Resource Control (RRC); Protocol Specification". +- [5b] 3GPP TS 33.102: "3G Security; Security Architecture". +- [5c] 3GPP TS 42.017: "Subscriber Identity Modules (SIM); Functional characteristics". +- [6a] 3GPP TS 44.064: "General Packet Radio Service (GPRS); Logical Link Control (LLC) layer specification". +- [6] ISO 7498: "Information processing systems - Open Systems Interconnection - Basic Reference Model". +- [7] 3GPP TS 44.018: "Mobile radio interface layer 3 specification; Radio Resource Control Protocol". +- [8] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [9] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access" +- [10] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3" +- [11] 3GPP TS 23.272: "Circuit Switched Fallback in Evolved Packet System; Stage 2" +- [12] 3GPP TS 29.118: "Mobility Management Entity (MME) – Visitor Location Register (VLR) SGs interface specification" +- [13] 3GPP TS 23.501: " System Architecture for the 5G System; Stage 2". +- [14] 3GPP TS 23.502: " Procedures for the 5G System; Stage 2". + +- [15] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [16] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [17] 3GPP TS 29.540: "5G System; SMS Services; Stage 3". + +## 1.2 Abbreviations + +For the purpose of the present document, the abbreviations given in 3GPP TR 21.905 [1a] and the following apply: + +**RR connection:** a RR connection is a dedicated physical circuit switched domain connection used by the two RR or RRC peer entities to support the upper layers' exchange of information flows. + +**PS signalling connection:** is a peer to peer UMTS connection between MS and CN packet domain node. + +**GPRS:** Packet Services for GSM and UMTS system. + +The label **(A/Gb mode only):** indicates this section or paragraph applies only to GSM system. For multi system case this is determined by the current serving radio access network. + +The label **(Iu mode only):** indicates this section or paragraph applies only to UMTS system. For multi system case this is determined by the current serving radio access network. + +The label **(S1 mode only):** indicates this section or paragraph applies only to Evolved Packet Core (EPC) and E-UTRAN access. For multi system case this is determined by the current serving radio access network. + +**In A/Gb mode,....:** Indicates this paragraph applies only to GSM System. For multi system case this is determined by the current serving radio access network. + +**In Iu mode,....:** Indicates this paragraph applies only to UMTS System. For multi system case this is determined by the current serving radio access network. + +**In S1 mode,....:** Indicates this paragraph applies only to Evolved Packet Core and E-UTRAN access. For multi system case this is determined by the current serving radio access network. + +**In N1 mode:** Indicates this paragraph applies only to 5G core network and NG-RAN access. For multi system case this is determined by the current serving radio access network. + +**SIM:** Subscriber Identity Module (see 3GPP TS 42.017 [5c]). This specification makes no distinction between SIM and USIM. + +**MS:** Mobile Station. This specification makes no distinction between MS and UE. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.301 [10] apply: + +**UE using EPS services with control plane CIoT EPS optimization** + +# --- 2 Overview of Short Message Service (SMS) support + +The purpose of the Short Message Service is to provide the means to transfer messages between a GSM PLMN Mobile Station (MS) and a Short Message Entity via a Service Centre, as described in 3GPP TS 23.040 [2]. The terms "MO" - Mobile Originating - and "MT" - Mobile Terminating - are used to indicate the direction in which the short message is sent. + +The present document describes the procedures necessary to support the Short Message Service between the MS and the MSC or SGSN or MME or SMSF and vice versa, as described in 3GPP TS 23.040 [2]. + +The procedures are based on services provided by the Mobility Management sublayer as described in 3GPP TS 24.007 [4]/3GPP TS 24.008 [5] for CS in A/Gb mode and CS/PS services in Iu mode, 3GPP 24.301 [10] for CS/PS services in S1 mode, 3GPP TS 24.501 [15] for N1 mode and the Logical Link Control layer described in 3GPP TS 44.064 [6a] for GPRS services. For CS/PS service in S1 mode, depending on network configuration and UE subscription data, network may choose to use either packet-switched service or circuit-switched service to provide SMS + +service. If circuit-switched service is used instead of packet-switched service, then the messages are tunneled through the MME. In this case the network also uses procedures described in 3GPP 29.118 [12]. + +## 2.1 Protocols and protocol architecture + +In Iu mode only, integrity protected signalling (see 3GPP TS 24.008 [5], subclause 'Integrity Protection of Signalling Messages' and in general, see 3GPP TS 33.102 [5b]) is mandatory. In Iu mode only, all protocols shall use integrity protected signalling. Integrity protection of all SMS signalling messages is the responsibility of lower layers. It is the network which activates integrity protection. This is done using the security mode control procedure (3GPP TS 25.331 [5a]). + +The hierarchical model in figure 2.1a shows the layer structure of the MSC and the MS in A/Gb mode. The hierarchical model in figure 2.1c shows the layer structure of the SGSN and the MS in Iu mode. The hierarchical model in figure 2.1d shows the layer structure of the MSC and the MS in S1 mode. The hierarchical model in figure 2.1e shows the layer structure of the MME and the MS in S1 mode. + +![Figure 2.1a: Protocol hierarchy for circuit-switched service. The diagram shows the protocol layers for an MSC (Mobile Switching Center) and an MS (Mobile Station) in A/Gb mode. The MSC has layers SM-AL, SM-TL, SM-RL, CM-sublayer, MM-sublayer, and RR-sublayer. The MS has layers SMR, SMC, and a bottom layer. The SM-RL layer of the MSC is connected to the SMR layer of the MS via the SM-RP protocol. The CM-sublayer of the MSC is connected to the SMC layer of the MS via the SM-CP protocol.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +| MSC | | MS | +|-------------|-----|-----| +| SM-AL | | | +| SM-TL | | | +| SM-RL | SMR | SMR | +| CM-sublayer | SMC | SMC | +| MM-sublayer | | | +| RR-sublayer | | | + +Protocol connections: + +- SM-RP protocol: SM-RL (MSC) ↔ SMR (MS) +- SM-CP protocol: CM-sublayer (MSC) ↔ SMC (MS) + +Figure 2.1a: Protocol hierarchy for circuit-switched service. The diagram shows the protocol layers for an MSC (Mobile Switching Center) and an MS (Mobile Station) in A/Gb mode. The MSC has layers SM-AL, SM-TL, SM-RL, CM-sublayer, MM-sublayer, and RR-sublayer. The MS has layers SMR, SMC, and a bottom layer. The SM-RL layer of the MSC is connected to the SMR layer of the MS via the SM-RP protocol. The CM-sublayer of the MSC is connected to the SMC layer of the MS via the SM-CP protocol. + +Figure 2.1a/3GPP TS 24.011: Protocol hierarchy for circuit-switched service + +The hierarchical model in figure 2.1b shows the layer structure of the SGSN and the MS in A/Gb mode. + +![Figure 2.1b: Protocol hierarchy for GPRS in A/Gb mode. The diagram shows the protocol layers for an SGSN (Serving GPRS Support Node) and an MS (Mobile Station) in A/Gb mode. The SGSN has layers SM-AL, SM-TL, SM-RL, CM-sublayer, LLC-sublayer, and GRR-sublayer. The MS has layers SMR, SMC, and a bottom layer. The SM-RL layer of the SGSN is connected to the SMR layer of the MS via the SM-RP protocol. The CM-sublayer of the SGSN is connected to the SMC layer of the MS via the SM-CP protocol.](b0211cee4b20034939d883ac0d70f696_img.jpg) + +| SGSN | | MS | +|--------------|-----|-----| +| SM-AL | | | +| SM-TL | | | +| SM-RL | SMR | SMR | +| CM-sublayer | SMC | SMC | +| LLC-sublayer | | | +| GRR-sublayer | | | + +Protocol connections: + +- SM-RP protocol: SM-RL (SGSN) ↔ SMR (MS) +- SM-CP protocol: CM-sublayer (SGSN) ↔ SMC (MS) + +Figure 2.1b: Protocol hierarchy for GPRS in A/Gb mode. The diagram shows the protocol layers for an SGSN (Serving GPRS Support Node) and an MS (Mobile Station) in A/Gb mode. The SGSN has layers SM-AL, SM-TL, SM-RL, CM-sublayer, LLC-sublayer, and GRR-sublayer. The MS has layers SMR, SMC, and a bottom layer. The SM-RL layer of the SGSN is connected to the SMR layer of the MS via the SM-RP protocol. The CM-sublayer of the SGSN is connected to the SMC layer of the MS via the SM-CP protocol. + +Figure 2.1b/3GPP TS 24.011: Protocol hierarchy for GPRS in A/Gb mode + +![Protocol hierarchy diagram for packet-switched service in Iu mode between SGSN and MS.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +This diagram illustrates the protocol hierarchy for packet-switched service in Iu mode between an SGSN and an MS. The SGSN stack, from top to bottom, consists of SM-AL, SM-TL, SM-RL, CM-sublayer, and GMM-sublayer. Below these layers, the SGSN contains SMR and SMC entities. The MS stack, from top to bottom, consists of SMR and SMC entities. Horizontal double-headed arrows indicate the SM-RP protocol between the SMR entities and the SM-CP protocol between the SMC entities. + +Protocol hierarchy diagram for packet-switched service in Iu mode between SGSN and MS. + +Figure 2.1c/3GPP TS 24.011: Protocol hierarchy for packet-switched service in Iu mode + +![Protocol hierarchy diagram for circuit-switched service in S1 mode between MSC and MS.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +This diagram illustrates the protocol hierarchy for circuit-switched service in S1 mode between an MSC and an MS. The MSC stack, from top to bottom, consists of SM-AL, SM-TL, SM-RL, CM-sublayer, and SGs layer. Below these layers, the MSC contains SMR and SMC entities. The MS stack, from top to bottom, consists of SM-AL, SM-TL, SM-RL, CM-sublayer, and EMM-sublayer. Below these layers, the MS contains SMR and SMC entities. Horizontal double-headed arrows indicate the SM-RP protocol between the SMR entities and the SM-CP protocol between the SMC entities. + +Protocol hierarchy diagram for circuit-switched service in S1 mode between MSC and MS. + +NOTE: SM-CP messages are transferred between the MSC and the MS through the MME. The protocol stack on the MME is not shown. + +Figure 2.1d/3GPP TS 24.011: Protocol hierarchy for circuit-switched service in S1 mode + +![Protocol hierarchy diagram for packet-switched service in S1 mode between MME and MS.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +This diagram illustrates the protocol hierarchy for packet-switched service in S1 mode between an MME and an MS. The MME stack, from top to bottom, consists of SM-AL, SM-TL, SM-RL, CM-sublayer, and EMM-sublayer. Below these layers, the MME contains SMR and SMC entities. The MS stack, from top to bottom, consists of SMR and SMC entities. Horizontal double-headed arrows indicate the SM-RP protocol between the SMR entities and the SM-CP protocol between the SMC entities. + +Protocol hierarchy diagram for packet-switched service in S1 mode between MME and MS. + +Figure 2.1e/3GPP TS 24.011: Protocol hierarchy for packet-switched service in S1 mode + +![Figure 2.1f/3GPP TS 24.011: Protocol hierarchy in N1 mode. The diagram shows the protocol stacks for SMSF and MS. The SMSF stack includes SM-AL, SM-TL, SM-RL, SMR, SMC, and N20-layer. The MS stack includes SM-AL, SM-TL, SM-RL, SMR, SMC, and 5GMM-sublayer. Arrows indicate the SM-CP and SM-RP protocols between the SMC and SMR entities of the SMSF and MS respectively.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +Figure 2.1f/3GPP TS 24.011: Protocol hierarchy in N1 mode. The diagram shows the protocol stacks for SMSF and MS. The SMSF stack includes SM-AL, SM-TL, SM-RL, SMR, SMC, and N20-layer. The MS stack includes SM-AL, SM-TL, SM-RL, SMR, SMC, and 5GMM-sublayer. Arrows indicate the SM-CP and SM-RP protocols between the SMC and SMR entities of the SMSF and MS respectively. + +NOTE: SM-CP messages are transferred between the SMSF and the MS through the AMF. The protocol stack on the AMF is not shown. + +**Figure 2.1f/3GPP TS 24.011: Protocol hierarchy in N1 mode** + +The CM-sublayer, in terms of the Short Message Service Support, provides services to the Short Message Relay Layer. + +On the MS-side the Short Message Relay Layer provides services to the Short Message Transfer Layer. The Short Message Relay Layer is the upper layer on the network side (MSC or SGSN or MME), and the SM-user information elements are mapped to TCAP/MAP. + +The peer protocol between two SMC entities is denoted SM-CP, and between two SMR entities, SM-RP. + +Abbreviations: + +| | | +|----------|-------------------------------------| +| SM-AL | Short Message Application Layer | +| SM-TL | Short Message Transfer Layer | +| SM-RL | Short Message Relay Layer | +| SM-RP | Short Message Relay Protocol | +| SMR | Short Message Relay (entity) | +| CM-sub | Connection Management sublayer | +| SM-CP | Short Message Control Protocol | +| SMC | Short Message Control (entity) | +| MM-sub | Mobility Management sublayer | +| GMM-sub | GPRS Mobility Management sublayer | +| RR-sub | Radio Resource Management sublayer | +| LLC-sub | Logical Link Control sublayer | +| GRR-sub | GPRS Radio Resource sublayer in GSM | +| EMM-sub | EPS Mobility Management sublayer | +| 5GMM-sub | 5G Mobility Management sublayer | + +## 2.2 Use of channels (A/Gb mode only) + +Table 2.1/3GPP TS 24.011 summarizes the use of channels for the short message service for circuit switched in A/Gb mode. Arrows indicate changes of channel. + +**Table 2.1/3GPP TS 24.011: Channels used for short message transfer over circuit switched in A/Gb mode** + +| Channel dependency | Channel used | +|------------------------------------|----------------------------------------| +| TCH not allocated | SDCCH | +| TCH not allocated -> TCH allocated | SDCCH -> SACCH | +| TCH allocated | SACCH | +| TCH allocated -> TCH not allocated | SACCH -> SACCH opt. SDCCH 3 | + +The short message service for GPRS shall be supported by a PDTCH. + +## 2.3 Layer 2 SAPI 3 handling for circuit switched in A/Gb mode + +General rule: + +- the Radio Resource Management (RR reference 3GPP TS 44.018 [7]) in the Mobile Station and on the network side (i.e. in the BSC) shall establish the acknowledged mode of operation on SAPI 3 whenever needed, i.e. when a message requiring SAPI 3 transfer shall be transmitted; +- RR shall control the layer 2 also for SAPI 3, and keep knowledge of the mode; +- the network side may initiate release of the acknowledged mode for SAPI 3 either explicitly (by the use of DISC- and UA-frames, see 3GPP TS 44.006 [3]) or indirectly by channel release (see 3GPP TS 44.018 [7]). + +This means: + +- the Mobile Station side will initiate establishment of SAPI 3 acknowledged mode in the case of mobile originating short message transfer; +- the network side will initiate establishment of SAPI 3 acknowledged mode in the case of mobile terminating short message transfer; +- the network side may choose to keep the channel and the acknowledged mode of operation to facilitate transfer of several short messages for or from the same Mobile Station. The queuing and scheduling function for this should reside in the MSC. + +## 2.4 Layer 2 (LLC) GPRS support (A/Gb mode only) + +It shall be possible for a GPRS-attached MS of any class (A, B, C) to send and receive short messages over GPRS radio channels. + +GPRS shall use the unacknowledged mode of LLC frame transfer as described in 3GPP TS 44.064 [6a], and shall use SAPI 7 to identify the SMS Logical Link Entity within the LLC layer. + +A description of the different GPRS MS classes can be found in 3GPP TS 23.060 [3a], and a brief overview is given below: + +- class A/B MSs may be able to send and receive short messages using either the MM sublayer (using SACCH or SDCCH) or the LLC layer (using PDTCH); +- class C MSs may be able to send and receive short messages using only the LLC layer (using the PDTCH). The capability for GPRS-attached class-C MSs to receive and transmit SMS messages is optional. + +The GSMS entity for GPRS class A/B MS is shown in figure 2.2. The GSMS shall communicate with the MM entity via the GMMSMS-SAP for GPRS Class A/B MO SMS, in order to ascertain which transport service to use. + +SMS delivery via GPRS is normally a more radio resource efficient method than SMS delivery via CS in A/Gb mode. The delivery path for MO SMS is selected by the MS. + +![Figure 2.2/3GPP TS 24.011: GSMS entity for GPRS Class A/B MS. The diagram shows a central 'SMSMM' block connected to 'SMC-GP' and 'SMC-CS' blocks. Above 'SMSMM' is the 'MNSMS-SAP' interface. Below 'SMC-GP' is the 'LLSMS-SAP' interface. Below 'SMC-CS' is the 'MMMSMS-SAP' interface. A common 'GMMSMS-SAP' interface is shown at the bottom, connected to both 'SMC-GP' and 'SMC-CS'.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +Figure 2.2/3GPP TS 24.011: GSMS entity for GPRS Class A/B MS. The diagram shows a central 'SMSMM' block connected to 'SMC-GP' and 'SMC-CS' blocks. Above 'SMSMM' is the 'MNSMS-SAP' interface. Below 'SMC-GP' is the 'LLSMS-SAP' interface. Below 'SMC-CS' is the 'MMMSMS-SAP' interface. A common 'GMMSMS-SAP' interface is shown at the bottom, connected to both 'SMC-GP' and 'SMC-CS'. + +Figure 2.2/3GPP TS 24.011: GSMS entity for GPRS Class A/B MS + +## 2.5 GSMS entity in Iu mode + +It shall be possible for a PS-attached MS of any mode of operation to send and receive short messages in Iu mode. + +A description of the different mode of operation UMTS MS can be found in 3GPP TS 23.060 [3a], and a brief overview is given below: + +- CS/PS mode of operation MSs may be able to send and receive short messages using either the MM sublayer or the GMM sublayer; +- PS mode of operation MSs may be able to send and receive short messages using only GMM sublayer. + +The GSMS entity for CS/PS mode of operation MS is shown in figure 2.3. The GSMS shall communicate with the MM entity via the GMMSMS-SAP for CS/PS mode of operation MO SMS in Iu mode, in order to ascertain which transport service to use. + +The delivery path for MO SMS is selected by the MS. + +![Figure 2.3/3GPP TS 24.011: GSMS entity for CS/PS mode of operation MS in Iu mode. The diagram shows a central 'SMSMM' block connected to 'SMC-GP' and 'SMC-CS' blocks. Above 'SMSMM' is the 'MNSMS-SAP' interface. Below 'SMC-GP' is the 'PMMSMS-SAP' interface. Below 'SMC-CS' is the 'MMMSMS-SAP' interface. A common 'GMMSMS-SAP' interface is shown at the bottom, connected to both 'SMC-GP' and 'SMC-CS'.](704082cc3e11776bda29595c76411362_img.jpg) + +Figure 2.3/3GPP TS 24.011: GSMS entity for CS/PS mode of operation MS in Iu mode. The diagram shows a central 'SMSMM' block connected to 'SMC-GP' and 'SMC-CS' blocks. Above 'SMSMM' is the 'MNSMS-SAP' interface. Below 'SMC-GP' is the 'PMMSMS-SAP' interface. Below 'SMC-CS' is the 'MMMSMS-SAP' interface. A common 'GMMSMS-SAP' interface is shown at the bottom, connected to both 'SMC-GP' and 'SMC-CS'. + +Figure 2.3/3GPP TS 24.011: GSMS entity for CS/PS mode of operation MS in Iu mode + +The Radio Resource Management shall use the 'low priority' class for the downlink transfer of SMS signalling messages. This means the core network shall set the SAPI value to 3 in RANAP Direct Transfer messages (see 3GPP TS 25.413 [8]) when sending SMS signalling messages over the Iu interface. + +## 2.5A ESMS entity in S1 mode + +It shall be possible for an MS that is attached to CS and PS or attached for PS to send and receive short messages in S1 mode. + +A description of the different modes of operation for E-UTRAN MS can be found in 3GPP TS 24.301 [10]: + +- if the MS is attached to CS and PS, an overview of SMS services in S1 mode can be found in 3GPP TS 23.272 [11]. In S1 mode, the network may choose to use either circuit-switched service or packet-switched service to provide SMS services (see subclause 2.1). If circuit-switched service is used by the network, then messages are tunnelled through the PS domain between the MS and the MSC, and otherwise have no impact on PS domain operation. If packet-switched service is used by the network, then messages are transferred between the MS and the MME. +- if the MS is attached for PS (see 3GPP TS 24.301 [10]), the MS may be able to send and receive short messages using only EMM sublayer. In this case, short messages are transferred between the MS and the MME. + +NOTE: If the MS is attached for PS with CIoT optimizations and the MS has requested "SMS only" and the MS is in NB-S1 mode, the MS sends and receives short messages using only EMM sublayer. + +The ESMS entity for CS/PS mode of operation MS is shown in figure 2.5A. + +![Diagram of the ESMS entity for MS in S1 mode. At the top, a vertical line connects to the 'MNSMS-SAP'. Below this is a large rectangular box containing three sub-components: 'SMSMM' at the top, 'SMC-GP' on the left, 'SMC-CS' in the center, and 'SMC-EP' on the right. The 'SMSMM' component is connected to each of the three sub-components below it. Below the large box, three vertical lines extend downwards from the sub-components: the left line from 'SMC-GP' is labeled 'PMSMS-SAP', the middle line from 'SMC-CS' is labeled 'MMSMS-SAP', and the right line from 'SMC-EP' is labeled 'EMMSMS-SAP'. All three lines converge to a single vertical line at the bottom, which is labeled 'GMMSMS-SAP'.](a7c51c18111139f9aca2805114108565_img.jpg) + +Diagram of the ESMS entity for MS in S1 mode. At the top, a vertical line connects to the 'MNSMS-SAP'. Below this is a large rectangular box containing three sub-components: 'SMSMM' at the top, 'SMC-GP' on the left, 'SMC-CS' in the center, and 'SMC-EP' on the right. The 'SMSMM' component is connected to each of the three sub-components below it. Below the large box, three vertical lines extend downwards from the sub-components: the left line from 'SMC-GP' is labeled 'PMSMS-SAP', the middle line from 'SMC-CS' is labeled 'MMSMS-SAP', and the right line from 'SMC-EP' is labeled 'EMMSMS-SAP'. All three lines converge to a single vertical line at the bottom, which is labeled 'GMMSMS-SAP'. + +Figure 2.5A/3GPP TS 24.011: ESMS entity for MS in S1 mode + +## 2.5B 5GSMS entity in N1 mode + +It shall be possible for an MS in N1 mode that is attached to the 5GCN to send and receive short messages. + +The 5GSMS entity for an MS in N1 mode is shown in figure 2.5B. + +![Diagram of 5GSMS entity for MS in N1 mode](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +The diagram illustrates the 5GSMS entity for an MS in N1 mode. It shows a vertical stack of components. At the top, the label **MNSMS-SAP** is connected to a vertical line. This line passes through a large rectangular box containing two stacked green rectangular blocks labeled **SMSMM** and **SMC-5G**. Below the box, the label **5GMM SMS-SAP** is connected to the same vertical line. + +Diagram of 5GSMS entity for MS in N1 mode + +Figure 2.5B/3GPP TS 24.011: 5GSMS entity for MS in N1 mode + +## 2.6 MS support for SMS over GPRS + +If the MS is attached to GPRS and the circuit-switched domain, and an SMS transfer via GPRS fails either due to a reception of an RP-ERROR message with cause #69 or due to the complete lack of network response, then the MS shall take the following actions: + +- The MS shall use the circuit-switched domain instead of GPRS for SMS transfer for an implementation dependent time. When a different PLMN is selected, if the MS preferred method is the sending of SMS over GPRS, the MS shall revert to trying an SMS transfer via GPRS. +- If the SMS transfer failed in both GPRS and the circuit-switched domain, the user shall be informed. + +As an implementation option, the MS may also use the circuit-switched domain instead of GPRS for SMS transfer due to a reception of an RP-ERROR message with a cause different than #69. + +## 2.7 MS support for device triggering short message + +If the UE is attached for EPS services, supports non-IP PDN type as specified in 3GPP TS 24.301 [10] and supports the device triggering short message as specified in 3GPP TS 23.040 [2], then upon receiving a device triggering short message with the Application port addressing information element set to "trigger to establish a PDN connection of non-IP PDN type using the default APN" as specified in 3GPP TS 23.040 [2], the UE shall send to the ESM entity as specified in 3GPP TS 24.007 [4] an indication requesting establishment of a PDN connection for non-IP PDN type using the default APN. + +# --- 3 Service definition + +## 3.1 General + +The layer service is described as a set of service primitives. These service primitives are abstractions and attempt to capture only those details of the interaction between the entities that are aspects of the layer service itself. A service primitive neither specifies nor constrains the implementation of entities or the interface between them. + +The general syntax of a primitive and the initials of them are in line with the 24-series of 3GPP Technical Specifications. + +NOTE: In order to limit the number of primitives and state definitions to a reasonable amount, a description method has been chosen which does not claim to be totally in line with the formal description method of the layered ISO reference model (ISO 7498) for Open Systems Interconnection. + +## 3.2 Service provided by the CM-sublayer + +In order to support the Short Message Service, the CM-sublayer provides services to the Short Message Relay Layer. + +The CM-sublayer services are provided using layer specific functions and lower layer services offered to the CM-sublayer, controlled by short message service control entities called SMCs. + +An SMC entity in the MS communicates with an SMC entity in the MSC or the SGSN or the MME or the SMSF by means of a peer protocol, SM-CP (Short Message Service Control Protocol). The arrow diagrams in annex A give an overview of the messaging on the CM-sublayer during a short message transfer. + +A mobile station supporting the Short Message Service shall have a minimum of two SMC entities per service type (i.e. two for CS GSM and two for GPRS). This enables the MS to receive MT messages during an MO message transfer. + +To ensure that an MS having the minimum of two SMC entities is able to receive MT messages during an MO message transfer, and to send MO messages during MT message transfer, parallel message transfer in the same direction is prohibited. This means that the SMC entities shall not simultaneously perform messaging in the same direction. The rules for concatenation of message transfers are described in subclause 5.4. + +The MSC or the SGSN or the MME or the SMSF shall have a minimum of two SMC entities available each during an MT message transfer to a mobile station, one being reserved for MO message transfer. In an MO message transfer, the MSC or the SGSN or the MME or the SMSF shall have one SMC entity reserved for handling of an MT message. + +### 3.2.1 Definition of primitives on the MS side + +This subclause defines the service primitives used on the MS side. Table 3.1/3GPP TS 24.011 gives an overview of the service primitives and main parameter linked to the primitives. All necessary control parameters to be used in the Short Message Service are defined in clause 7. All MNSMS service primitives defined in this subclause are passed to an SMC-entity. + +**Table 3.1/3GPP TS 24.011: MNSMS service primitives on the MS-side** + +| SERVICE PRIMITIVES | | PARAMETER | +|--------------------|------|-----------| +| NAME | TYPE | | +| MNSMS-ABORT- | Req | Cause | +| MNSMS-DATA | Req | MT RPDUs | +| | Ind | MO RPDUs | +| MNSMS-EST- | Req | MO RPDUs | +| | Ind | MT RPDUs | +| MNSMS-ERROR- | Ind | Cause | +| MNSMS-REL- | Req | Cause | + +#### 3.2.1.1 MNSMS-ABORT-REquest + +A request from an SMR entity to release a CM-connection in abnormal cases. + +When the CM-sublayer receives this request, and if the MM connection exists, it shall form and send the CP-ERROR message. Irrespective of whether or not the CP-ERROR message was sent, the CM-sublayer shall then release the lower layer services. + +#### 3.2.1.2 MNSMS-DATA-REquest + +A request from an SMR entity to send a RPDUs on the established CM-connection. + +The SMC entity forms the CP-DATA message, the user information element being the RPDU, and transfers the message by means of the lower layer services. + +NOTE: After reception of an incoming RP-DATA, the SMR entity typically returns the acknowledgement RP-ACK, or an error indication, RP-ERROR, to the Service Centre. + +#### 3.2.1.3 MNSMS-DATA-INDication + +An indication used by the SMC entity to pass the user information element (RPDU) of a received CP-DATA message to SM-RL. + +NOTE: The RPDU is typically an RP-ACK or an RP-ERROR. Normally this service is used to report the outcome of either a MO message transfer attempt or a mobile station memory available notification attempt. + +#### 3.2.1.4 MNSMS-ESTablish-REQuest + +A request from an SMR entity to establish a CM-connection. The request contains a RP-DATA UNIT as a parameter. It implies the: + +- establishment of a CM-connection for this SMR entity; +- forming of the CP-DATA message containing the RPDU; and +- passing of CP-DATA to the MM-sublayer. + +#### 3.2.1.5 MNSMS-ESTablish-INDication + +An indication used by the SMC entity to pass the SM-user information (RPDU) of a received CP-DATA message to SM-RL. It implies completion of the establishment of the CM-connection for this SMR entity. + +#### 3.2.1.6 MNSMS-ERROR-INDication + +An indication used by the SMC entity to pass error information to SM-RL. The error information may be local or relayed by the CP-ERROR message. + +Use of this service primitive implies release of both CM and MM-connection. + +#### 3.2.1.7 MNSMS-RELease-REQuest + +A request to release the CM-connection (if it still exists). + +Use of this service primitive implies release of the associated CM and MM-connections. + +### 3.2.2 Definition of primitives on the network side + +This subclause defines the service primitives used on the network side. + +Table 3.2/3GPP TS 24.011 gives an overview of the service primitives and linked main parameter. All MNSMS service primitives defined in this subclause are passed to an SMC-entity. + +**Table 3.2/3GPP TS 24.011: MNSMS service primitives on the network side** + +| SERVICE PRIMITIVES | | PARAMETER | +|---------------------------|-------------|------------------| +| NAME | TYPE | | +| MNSMS-ABORT- | Req | Cause | +| MNSMS-DATA | Req | MO RPDUs | +| | Ind | MT RPDUs | +| MNSMS-EST- | Req | MT RPDUs | +| | Ind | MO RPDUs | +| MNSMS-ERROR- | Ind | Cause | +| MNSMS-REL- | Req | Cause | + +#### 3.2.2.1 MNSMS-ABORT-REQuest + +A request from an SMR entity to release a CM-connection in abnormal cases. + +When the CM-sublayer receives this request, it may form and send the CP-ERROR message to release the connection. Irrespective of whether or not the CP-ERROR message was sent, the CM-sublayer shall then release the lower layer services. + +#### 3.2.2.2 MNSMS-DATA-REQuest + +A request from an SMR entity to send a RPDUs on the established CM-connection. + +The SMC entity forms the CP-DATA message, the user information element being the RPDUs, and transfers the message by means of the lower layer services. + +NOTE: After reception of an incoming RP-DATA or RP-SMMA the RPDUs typically returns the acknowledgement, RP-ACK, or an error indication RP-ERROR, to the Mobile Station. + +#### 3.2.2.3 MNSMS-DATA-INDication + +An indication used by the SMC entity to pass the user information element (RPDU) of a received CP-DATA message to SM-RL. + +NOTE: The RPDUs is typically an RP-ACK or an RP-ERROR. Normally this is used to report the outcome of a MT messaging attempt. + +#### 3.2.2.4 MNSMS-ESTablish-REQuest + +A request from an SMR entity to transmit a RPDUs, containing the SM-user information element; it implies the: + +- establishment of a CM-connection for this SMR entity; +- forming of the CP-DATA message containing the RPDUs; and +- passing of CP-DATA to the MM-sublayer. + +#### 3.2.2.5 MNSMS-ESTablish-INDication + +An indication used by the SMC entity to pass the SM-user information (RPDU) of a received CP-DATA message to SM-RL; it implies completion of the establishment of the CM-connection for this SMR entity. + +#### 3.2.2.6 MNSMS-ERROR-INDication + +An indication used by the SMC entity to pass error information to SM-RL. The error information may be local or relayed by the CP-ERROR message. + +Use of the service primitive implies release of both CM and MM-connection. + +#### 3.2.2.7 MNSMS-RELease-REQuest + +A request to release the CM-connection (if it still exists). + +Use of this service implies release of the associated CM and MM-connections. + +## 3.3 Service provided by SM-RL + +In order to support the Short Message Service, the Short Message Relay Layer provides services to the Short Message Transfer Layer. + +The Short Message Relay Layer services are provided using layer specific functions and lower layer services offered to the Short Message Relay Layer, controlled by short message control entities called SMRs. + +An SMR entity in the MS communicates with an SMR entity in the MSC by means of a peer protocol, SM-RP (Short Message Relay Protocol). The arrow diagrams in annex C give an overview of the messaging on the Short Message Relay Layer used for the Short Message Service. The diagrams in annex C indicate a layer RL. This is not a layer, but the functional interface to the fixed network. The SM-RL is the upper layer in the MSC. Consequently the service primitives passed between SM-RL and RL indicate the interworking function. + +The requirements on the SM-RL are the same as for the CM-sublayer. This means that there is exactly one SMR entity for each SMC entity, operating as described in subclause 3.2. + +### 3.3.1 Definition of primitives on the MS side + +This subclause defines the service primitives used on the MS side. Table 3.3/3GPP TS 24.011 gives an overview of the service primitives and linked main parameters. All SM-RL service primitives defined in this subclause are passed on an SM-RL-connection. + +**Table 3.3/3GPP TS 24.011: SM-RL service primitives on the mobile station side** + +| SERVICE PRIMITIVES | | PARAMETER | +|---------------------------|------|-----------------------| +| NAME | TYPE | | +| SM-RL-DATA- | Req | MO SMS-TPDU | +| | Ind | MT SMS-TPDU | +| SM-RL-MEMORY
AVAILABLE | Req | See subclause 3.3.1.3 | +| SM-RL-REPORT- | Req | See subclause 3.3.1.4 | +| | Ind | See subclause 3.3.1.5 | + +#### 3.3.1.1 SM-RL-DATA-REQuest + +A request from the SM-TL entity to pass the SMS-TPDU and necessary control information to SM-RL; it implies: + +- establishment of an SM-RL connection for MO message transfer; +- forming of the RP-DATA message, containing the SMS-TPDU; +- transfer of the RP-DATA message as an RPDU in an MNSMS-EST-Req. + +The purpose of this service is to relay the SMS-TPDU from the mobile station to the peer entity in the MSC. + +#### 3.3.1.2 SM-RL-DATA-INDication + +An indication used by the SMR entity to pass the SMS-TPDU and necessary control information of a received RP-DATA message to SM-TL. + +#### 3.3.1.3 SM-RL-MEMORY-AVAILABLE-REQuest + +When received without a parameter, this is a request from the SM-TL entity to pass the necessary control information to SM-RL; it implies: + +- establishment of an SM-RL-connection for transfer of the notification to the network that the mobile has memory available to receive one or more short messages; +- forming the RP-SM-MEMORY-AVAILABLE message; and +- transfer of the RP-SM-MEMORY-AVAILABLE message as an RPDU in an MNSMS-EST-Req. + +The SM-TL entity may abort the transmission of an RP-SM-MEMORY-AVAILABLE message by use of a SM-RL-MEMORY-AVAILABLE-REQuest with the added parameter, SMS-MEM-NOTIF-ABORT, being present. This parameter is, of course, defined only on the interface between the SM-TL and SMR entities within the mobile station. Use of this request with the added parameter will have no effect on messages already given to the lower layers for transmission, but will only abort retransmission of the RP-SM-MEMORY-AVAILABLE message by the SMR entity. + +#### 3.3.1.4 SM-RL-REPORT-REQuest + +A request used by the SM-TL to relay the RP-ACK or RP-ERROR message from the mobile station to the network. This implies transfer of the RP-ACK or RP-ERROR message as an RPDU in an MNSMS-DATA-Req. + +#### 3.3.1.5 SM-RL-REPORT-INDication + +An indication used by the SMR entity to pass an acknowledgement (RP-ACK) or error information to SM-TL. The error information may be local or relayed by the RP-ERROR message; it consists of an appropriate cause and optionally extended diagnostic information. + +### 3.3.2 Definition of primitives on the network side + +This subclause defines the service primitives used on the network side. + +Table 3.4/3GPP TS 24.011 gives an overview of the service primitives and linked main parameter. All SM-RL service primitives defined in this subclause are passed on an SM-RL-connection. + +**Table 3.4/3GPP TS 24.011: SM-RL service primitives on the network side** + +| SERVICE PRIMITIVES | | PARAMETER | +|---------------------------|------|-----------------------| +| NAME | TYPE | | +| SM-RL-DATA- | Req | MT SMS-TPDU | +| | Ind | MO SMS-TPDU | +| SM-RL-MEMORY
AVAILABLE | Ind | None | +| SM-RL-REPORT- | Req | See subclause 3.3.2.4 | +| | Ind | See subclause 3.3.2.5 | + +#### 3.3.2.1 SM-RL-DATA-REQuest + +A request from RL to pass the SMS-TPDU to SM-RL; it implies: + +- establishment of a SM-RL-connection for MT message transfer; +- forming of the RP-DATA message, containing the SMS-TPDU; and +- transfer of the RP-DATA message as an RPDU in an MNSMS-EST-Req. + +The purpose of this service is to relay the SMS-TPDU from the MSC to the peer entity in the mobile station. + +#### 3.3.2.2 SM-RL-DATA-INDication + +An indication used by the SMR entity to pass the SMS-TPDU of a received RP-DATA message to RL. + +#### 3.3.2.3 SM-RL-MEMORY-AVAILABLE-INDication + +An indication used by the SMR entity to pass to RL the notification to the network that the mobile has memory available to receive one or more short messages. + +#### 3.3.2.4 SM-RL-REPORT-REQuest + +A request used by RL (the network interworking function) to relay the RP-ACK or RP-ERROR message from the network to the mobile station. This implies transfer of the RP-ACK or RP-ERROR message as an RPDU in an MNSMS-DATA-Req. + +#### 3.3.2.5 SM-RL-REPORT-INDication + +An indication used by the SMR entity to pass an acknowledgement (RP-ACK) or error information to RL. The error information may be local or relayed by the RP-ERROR message. + +# --- 4 Void + +# 5 CM-procedures + +## 5.1 General + +This clause describes the procedures used by the SMC entity on the Connection Management sublayer. An SMC entity communicates with a corresponding peer entity using an MM-connection for CS in A/Gb and Iu mode, or the LLC layer for GPRS in A/Gb mode, or the GMM-connection for PS in Iu mode, or the EMM-connection for EPS in S1 mode if packet-switched service is used, or through the MME for S1 mode if circuit-switched service is used, or through the AMF for N1 mode. + +Multiple MM-connections may be established at the same time, allowing parallel transactions. The description of the procedures is related to one single transaction. + +For circuit switched service, the CM-procedures described can only be performed if an MM-connection has been established between the mobile station and the network. + +For GPRS, no connection has to be established, and thus the CM procedures for GPRS reflect this. Detailed SDL diagrams for SMC entities are contained in annex B. + +For EPS when packet-switched service is used, detailed SDL diagrams for SMC entities are contained in annex B. + +## 5.2 Short Message Control states + +The state transition diagrams for the MO and MT SMC entities on both the MS side and network side are contained in annex B. + +### 5.2.1 SMC-CS states at the MS side of the radio interface + +#### 5.2.1.1 Mobile Originating Case + +The states described in this clause are for an SMC entity in an MS handling mobile originating short message transfer and notification to the network that the mobile has memory available to receive one or more short messages (referred to below as "notification"). + +##### 5.2.1.1.1 MO-Idle (State 0) + +This state exists when the MO-SMC entity is in idle mode, or when an MO short message transfer or notification ends in a normal or abnormal way. + +##### 5.2.1.1.2 MO-MM-connection pending (State 1) + +This state exists when the MO-SMC has requested the establishment of an MM-connection. + +##### 5.2.1.1.3 MO-Wait for CP-ACK (State 2) + +This state exists after the MO-SMC has initiated the transfer of a CP-DATA message. + +##### 5.2.1.1.4 MO-MM-connection established (State 3) + +This state exists when the MO-SMC has: + +- received the acknowledgement, CP-ACK; or +- received the message CP-DATA (including sending of the associated CP-ACK). + +#### 5.2.1.2 Mobile Terminating case + +The states described in this subclause are for an SMC entity in an MS handling mobile terminating short message transfer. + +##### 5.2.1.2.1 MT-Idle (State 0) + +This state exists when the MT-SMC entity is in idle mode, or when a short message transfer ends in a normal or abnormal way. + +##### 5.2.1.2.2 MT-Wait for CP-ACK (State 2) + +This state exists after the MT-SMC has initiated the transfer of a CP-DATA message. + +##### 5.2.1.2.3 MT-MM-connection established (State 3) + +This state exists when the MT-SMC has: + +- received the acknowledgement, CP-ACK; or +- received the message CP-DATA (including sending of the associated CP-ACK). + +### 5.2.2 SMC-GP, SMC-EP and SMC-5G states at the MS side of the radio interface + +#### 5.2.2.1 Mobile Originating Case + +The states described in this clause are for an SMC-GP entity in a GPRS MS, and for an SMC-EP entity in an EPS MS, and for an SMC-5G entity in a 5GS MS handling mobile originating short message transfer and notification to the network that the mobile has memory available to receive one or more short messages (referred to below as "notification"). + +##### 5.2.2.1.1 MO-Idle (State 0) + +This state exists when the MO-SMC entity is in idle mode, or when an MO short message transfer or notification ends in a normal or abnormal way. + +##### 5.2.2.1.2 MO-GMM-connection pending (State 1) (lu mode only) + +This state exists when the MO-SMC has requested the establishment of a PS signalling connection. + +##### 5.2.2.1.3 MO-Wait for CP-ACK (State 2) + +This state exists after the MO-SMC has initiated the transfer of a CP-DATA message. + +##### 5.2.2.1.4 MO-Wait for CP-Data (State 3) + +This state exists when the MO-SMC has received the acknowledgement, CP-ACK. + +##### 5.2.2.1.5 MO-EMM-connection pending (State 4) (S1 mode only) + +This state exists when the MO-SMC has requested the establishment of a NAS signalling connection. + +#### 5.2.2.2 Mobile Terminating case + +The states described in this subclause are for an SMC-GP entity in an GPRS MS handling mobile terminating short message transfer. + +##### 5.2.2.2.1 MT-Idle (State 0) + +This state exists when the MT-SMC entity is in idle mode, or when a short message transfer ends in a normal or abnormal way. + +##### 5.2.2.2.2 MT-Wait for RP-ACK (State 1) + +This state exists after the MT-SMC has received the message CP-DATA (including sending of the associated CP-ACK). + +##### 5.2.2.2.3 MT-Wait for CP-ACK (State 2) + +This state exists when the MT-SMC has initiated the transfer of the CP DATA message. + +### 5.2.3 SMC-CS states at the network side of the radio interface + +#### 5.2.3.1 Mobile Originating Case + +The states described in this subclause are for an SMC entity in an MSC handling both mobile originating short message transfer and notification to the network that the mobile has memory available to receive one or more short messages (referred to below as "notification"). + +##### 5.2.3.1.1 MO-Idle (State 0) + +This state exists when the MO-SMC entity is in idle mode, or when a short message transfer or notification ends in a normal or abnormal way. + +##### 5.2.3.1.2 MO-Wait for CP-ACK (State 2) + +This state exists after the MO-SMC has initiated the transfer of a CP-DATA message. + +##### 5.2.3.1.3 MO-MM-connection established (State 3) + +This state exists when the SMC has: + +- received the acknowledgement, CP-ACK; or +- received the message CP-DATA (including sending of the associated CP-ACK). + +#### 5.2.3.2 Mobile Terminating Case + +The states described in this subclause are for an SMC entity in an MSC handling mobile terminating short message transfer. + +##### 5.2.3.2.1 MT-Idle (State 0) + +This state exists when the MT-SMC entity is in idle mode, or when a short message transfer ends in a normal or abnormal way. + +##### 5.2.3.2.2 MT-MM-connection pending (State 1) + +This state exists when the MT-SMC has requested an MM-connection for mobile terminating short message transfer. + +##### 5.2.3.2.3 MT-Wait for CP-ACK (State 2) + +This state exists after the SMC has initiated the transfer of a CP-DATA message. + +##### 5.2.3.2.4 MT-MM-connection established (State 3) + +This state exists when the SMC has: + +- received the acknowledgement, CP-ACK; or + +- received the message CP-DATA (including sending of the associated CP-ACK). + +### 5.2.4 SMC-GP, SMC-EP and SMC-5G states at the network side of the radio interface + +#### 5.2.4.1 Mobile Originating Case + +The states described in this subclause are for an SMC-GP entity in an SGSN and for an SMC-EP entity in an MSC or an MME and an SMC-5G entity in a SMSF handling both mobile originating short message transfer and notification to the network that the mobile has memory available to receive one or more short messages (referred to below as "notification"). + +##### 5.2.4.1.1 MO-Idle (State 0) + +This state exists when the MO-SMC entity is in idle mode, or when a short message transfer or notification ends in a normal or abnormal way. + +##### 5.2.4.1.2 MO-Wait for RP-ACK (State 1) + +This state exists after the MO-SMC has received the message CP-DATA (including sending of the associated CP-ACK). + +##### 5.2.4.1.3 MO-Wait for CP-ACK(State 2) + +This state exists when the SMC has received the RP acknowledgement, RP-ACK + +#### 5.2.4.2 Mobile Terminating Case + +The states described in this subclause are for an SMC-GP entity in an SGSN and the SMC-EP entity in the MSC or the MME handling mobile terminating short message transfer. + +##### 5.2.4.2.1 MT-Idle (State 0) + +This state exists when the MT-SMC entity is in idle mode, or when a short message transfer ends in a normal or abnormal way. + +##### 5.2.4.2.2 MT-Wait for CP-ACK (State 1) + +This state exists after the SMC has initiated the transfer of a CP-DATA message. + +##### 5.2.4.2.3 MT-Wait for CP DATA (State 2) + +This state exists when the SMC has received the acknowledgement, CP-ACK. + +## 5.3 Short Message Control procedures + +The procedures needed for short message control are: + +- connection establishment procedures; +- RP Data Unit (RPDU) transfer procedures; +- connection release procedures; and +- procedures for abnormal cases. + +The procedures of subclause 5.3 are described with respect to one particular instance of an SMC entity. Different SMC entities are identified by their Transaction Identifier. Messages with Transaction Identifiers that do not correspond to this particular instance of the SMC entity are not treated by it. + +### 5.3.1 MM-connection establishment for circuit switched service + +When an SMC entity is in the Idle state and transfer of an RPDU is requested, the peer to peer connection between the MM-sublayers in the MS and the network (MSC) has to be established. + +The SMC entity on the originating side requests the MM-sublayer to establish an MM-connection, and enters the MM-Connection Pending state. + +After completion of the MM-connection establishment, a confirmation is given to the originating side to indicate that the MM sublayer is ready for RPDU transfer. + +The MM-connection establishment is indicated to the SMC entity at the destination side when the CP-DATA message has been received by the MM-sublayer (in line with 3GPP TS 24.008 [5]). The destination side SMC entity then sends a CP-ACK and enters the MM-Connection Established state. + +### 5.3.2 RPDU transfer + +#### 5.3.2.1 RPDU transfer for circuit switched service + +When an SMC entity in the MM-Connection Pending state is informed that an MM-connection has been established, the SMC entity forwards the CP-DATA message containing the RPDU, sets the timer TC1\* and enters the Wait for CP-ACK state. + +The value of TC1\* may vary with the length of the CP-DATA message and the channel type that is being used for its transmission. However, the value of TC1\* shall be sufficiently great to allow the lower layers to transmit the CP-DATA and CP-ACK messages and to allow for some retransmissions of layer 2 frames. + +If an SMC entity in the Wait for CP-ACK state gets an indication that the CP-DATA message has probably been lost (e.g. due to dedicated channel assignment, hand over, assignment failure, hand over failure, or a SAPI 3 data link failure) then, as an implementation option, that SMC entity may reduce the time until expiry of TC1\*. + +If the timer TC1\* expires in the Wait for CP-ACK state, the CP-DATA message is retransmitted and the state Wait for CP-ACK is re-entered. The maximum number of CP-DATA message retransmissions is an implementation option but shall be either 1, 2 or 3. If the timer TC1\* expires after the maximum number of retransmission attempts, an error indication is passed to SM-RL and an MM-connection release request is passed to the MM-sublayer. The Idle state is then entered. + +On receipt of the CP-ACK message in the Wait for CP-ACK state, the SMC resets the timer TC1\* and enters the MM-Connection Established state. + +When receiving a CP-DATA message in the MM-Connection Established state, the SMC entity checks the parameters relevant to the CP protocol. If these are valid, the RPDU is passed to the SM-RL, the CP-ACK message is sent and the state MM-Connection Established is re-entered. + +If an SMC entity in the Idle state is unable to accept a CP-DATA message, it sends a CP-ERROR message followed by an MM-connection release request and then enters the Idle state. + +When receiving a MNSMS-DATA-Req primitive in the MM-Connection Established state, the SMC entity forwards a CP-DATA message containing the RPDU to the MM-sublayer, sets the timer TC1\* and enters the Wait for CP-ACK state. + +#### 5.3.2.2 RPDU transfer for GPRS, EPS and 5GS + +In A/Gb mode, when an SMC-GP or SMC-EP entity is in the Idle state and transfer of an RPDU is requested, the SMC-GP or SMC-EP entity on the originating side forwards the CP-DATA message containing the R-PDU to the lower layer, and sets the timer TC1\* and enters the Wait for CP-ACK state. In A/Gb mode, for the SMC-GP entity, the lower layer is the LLC sublayer. For the SMC-EP entity on the MS side, the lower layer is EMM. For the SMC-EP entity on the network side, the lower layer can be either the SGs association as described in 3GPP TS 29.118 [12] or the EMM sublayer. For the SMC-5G entity on the MS side, the lower layer is 5GMM. For the SMC-5G entity on the network side the lower layer is provided by the Namf Service Based Interface as described in 3GPP TS 29.518 [16] and by the Nsmf Service Based Interface as described in 3GPP TS 29.540 [17]. + +In Iu mode, when an SMC-GP entity in the MS side is in the Idle state and transfer of an RPDU is requested: + +- the SMC-GP entity on the originating side requests the GMM sublayer to establish a PS signalling connection, and enters the GMM-Connection Pending state. +- after completion of the PS signalling connection establishment, a confirmation is given to the originating side to indicate that the GMM sublayer is ready for RPDU transfer; and. + +- after confirmation of the PS signalling connection establishment, the SMC-GP entity on the originating side forwards the CP-DATA message to the GMM sublayer. This contains the RPDU, and also the SMC-GP entity sets the timer TC1\* and enters the Wait for CP-ACK state. + +In S1 mode, when an SMC-EP entity in the MS side is in the Idle state and transfer of an RPDU is requested: + +- if the MS is not using Control plane CIoT EPS optimization: + - 1) the SMC-EP entity on the originating side requests the EMM sublayer to establish a NAS signalling connection, and enters the EMM-Connection Pending state; + - 2) after completion of the NAS signalling connection establishment, a confirmation is given to the originating side to indicate that the EMM sublayer is ready for RPDU transfer; and + - 3) after confirmation of the NAS signalling connection establishment, the SMC-EP entity on the originating side forwards the CP-DATA message to the EMM sublayer. This contains the RPDU, and also the SMC-EP entity sets the timer TC1\* and enters the Wait for CP-ACK state; or +- if the MS is using Control plane CIoT EPS optimization, the SMC-EP entity on the originating side forwards the CP-DATA message that contains the RPDU to the EMM sublayer when requesting the EMM sublayer to establish a NAS signalling connection. The SMC-EP entity then sets the timer TC1\* and enters the Wait for CP-ACK state immediately. + +NOTE 1: If the MS in idle mode is using Control plane CIoT optimization, the first CP-DATA message is sent by piggybacking on the CONTROL PLANE SERVICE REQUEST message during the service request procedure as specified in 3GPP 24.301 [10]. + +In N1 mode, when an SMC-5G entity in the MS side is in the Idle state and transfer of an RPDU is requested: + +- if the MS is not using Control plane CIoT 5GS optimization: + - 1) the SMC-5G entity on the originating side requests the 5GMM sublayer to establish a NAS signalling connection; + - 2) after completion of the NAS signalling connection establishment, a confirmation is given to the originating side to indicate that the 5GMM sublayer is ready for RPDU transfer; and + - 3) after confirmation of the NAS signalling connection establishment, the SMC-5G entity on the originating side forwards the CP-DATA message to the 5GMM sublayer. This contains the RPDU, and also the SMC-5G entity sets the timer TC1\* and enters the Wait for CP-ACK state; and +- if the MS is using Control plane CIoT 5GS optimization, the SMC-5G entity on the originating side forwards the CP-DATA message that contains the RPDU to the 5GMM sublayer when requesting the 5GMM sublayer to establish a NAS signalling connection. The SMC-5G entity then sets the timer TC1\* and enters the Wait for CP-ACK state immediately. + +NOTE2: If the MS in idle mode is using Control plane CIoT optimization, the first CP-DATA message is sent by piggybacking on the CONTROL PLANE SERVICE REQUEST message during the service request procedure as specified in 3GPP 24.501 [15]. + +In Iu mode, when an SMC-GP entity in the network side is in Idle state and transfer of an RPDU is requested, the SMC-GP entity on the originating side forwards the CP-DATA message to the GMM sublayer. This contains the RPDU, and also the SMC-GP entity sets the timer TC1\* and enters the Wait for CP-ACK state. + +In S1 mode and the circuit-switched service is used, when an SMC-EP entity in the network side is in Idle state and transfer of an RPDU is requested, the SMC-EP entity on the MSC forwards the CP-DATA message to the SGs sublayer. This contains the RPDU, and also the SMC-EP entity sets the timer TC1\* and enters the Wait for CP-ACK state. The SGs layer transfers the CP-DATA message by using the procedures specified in 3GPP 24.301 [10]. + +In S1 mode and the packet-switched service is used, when an SMC-EP entity in the network side is in Idle state and transfer of an RPDU is requested, the SMC-EP entity on the originating side forwards the CP-DATA message to the EMM sublayer. This contains the RPDU, and also the SMC-GP entity sets the timer TC1\* and enters the Wait for CP-ACK state. + +In N1 mode and the packet-switched service is used, when an SMC-5G entity in the network side is in Idle state and transfer of an RPDU is requested, the SMC-5G entity on the SMSF forwards the CP-DATA message to the N20 + +sublayer. This contains the RPDU, and also the SMC-5G entity sets the timer TC1\* and enters the Wait for CP-ACK state. + +The value of TC1\* may vary with the length of the CP-DATA. However, the value of TC1\* shall be sufficiently great to allow the lower layers to transmit the CP-DATA and CP-ACK messages and to allow for some re-transmissions of layer 2 frames. + +If an SMC entity in the Wait for CP-ACK state gets an indication that the CP-DATA message has probably been lost then, as an implementation option, that SMC-GP entity may reduce the time until expiry of TC1\*. + +If the timer TC1\* expires in the Wait for CP-ACK state, the CP-DATA message is retransmitted and the state Wait for CP-ACK is re-entered. The maximum number of CP-DATA message re-transmissions is an implementation option but shall be either 1, 2 or 3. If the timer TC1\* expires after the maximum number of retransmission attempts, an error indication is passed to SM-RL. The Idle state is then entered. + +On receipt of the CP-ACK message in response to the CP-DATA (RP DATA) message in the Wait for CP-ACK state, the SMC-GP resets the timer TC1\* and enters the Wait for CP DATA state. + +On receipt of the CP-ACK message in response to the CP-DATA (RP ACK) message in the Wait for CP-ACK state, the SMC-GP resets the timer TC1\* and enters the Idle State. + +On receipt of the CP-ACK message in response to the CP-DATA (RP DATA) message in the Wait for CP-ACK state, the SMC-5G resets the timer TC1\* and enters the Wait for CP DATA state. + +On receipt of the CP-ACK message in response to the CP-DATA (RP ACK) message in the Wait for CP-ACK state, the SMC-5G resets the timer TC1\* and enters the Idle State. + +In A/Gb mode or S1 mode, when receiving a CP-DATA message from the lower layer, the SMC-GP or SMC-EP entity checks the parameters relevant to the CP protocol. If these are valid, the RPDU is passed to the SM-RL, the CP-ACK message is sent. + +In Iu mode, when receiving a CP-DATA message from the GMM sublayer, the SMC-GP entity checks the parameters relevant to the CP protocol. If these are valid, the RPDU is passed to the SM-RL, the CP-ACK message is sent. + +In S1 mode, when receiving a CP-DATA message from the lower layer, the SMC-EP entity checks the parameters relevant to the CP protocol. If these are valid, the RPDU is passed to the SM-RL, the CP-ACK message is sent. + +In N1 mode, when receiving a CP--DATA message from the lower layer, the SMC-5G entity checks the parameters relevant to the CP protocol. If these are valid, the RPDU is passed to the SM--RL, the CP--ACK message is sent + +If an SMC entity in the Idle state is unable to accept a CP-DATA message, it sends a CP-ERROR message and then enters the Idle state. + +### 5.3.3 Release of MM and CM connections + +With the exception of error situations, release of the MM and CM connection is controlled by the SM-RL. + +When an SMC entity in the Wait for CP-ACK state receives a release request from SM-RL, this request is stored until the next state (either MM Connection Established or Idle) is entered. If the Idle state is entered, the request is discarded. If the MM Connection Established state is entered, or if the SMC entity receives a release request from SM-RL in this state, an MM-connection release request is sent to the MM-sublayer and the SMC entity enters the Idle state. + +### 5.3.4 Abnormal cases + +Abnormal cases that shall be handled by the SMC entity in any state can be classified into five cases: + +- **Upper Layer Abort:** errors occurring in the SM-RL may cause the SM-RL to send an MNSMS-ABORT Request to the SMC entity; +- **CP-Layer Abort:** errors occurring within the SMC entity itself may require termination of all activities related to that transaction identifier; +- **Lower Layer Abort:** errors occurring within the layers beneath the CP-layer may cause an MMSM-ERROR Indication or a GMMSMS-ERROR Indication to be sent to the SMC entity; + +- **CP-Layer Protocol Errors:** errors occurring within the protocol exchange between the SMC entities may result in the sending of a CP-ERROR message between the entities; +- **Lower Layer Release:** events occurring within the layers beneath the CP layer may cause an MM-connection release request, without indication of release cause, is passed to the MM-sublayer. The SMC entity in the network then enters the Idle state. + +When the CM-sublayer in the network receives an Upper Layer Abort, it may form and send the CP-ERROR message to release the connection. Irrespective of whether or not the CP-ERROR message was sent, an MM-connection release request, without indication of release cause, is passed to the MM-sublayer. The SMC entity in the network then enters the Idle state. + +When the CM-sublayer in the MS receives an Upper Layer Abort and if the MM connection exists, it shall form and send the CP-ERROR message. Irrespective of whether or not the CP-ERROR message was sent, an MM-connection release request, without indication of release cause, is passed to the MM-sublayer. The SMC entity in the mobile station then enters the Idle state. + +In the case of a CP-Layer Abort, an error indication is passed to SM-RL. If possible, a CP-ERROR message is sent to the partner SMC entity to indicate the error situation. Then the SMC entity enters the Idle state. + +In the case of a Lower Layer Abort, the SMC entity passes an error indication to SM-RL, an MM-connection release request is passed to the MM-sublayer, and the SMC entity immediately enters the Idle state. + +In the case of the reception of a CP-ERROR message from the partner SMC entity, an error indication is passed to SM-RL, an MM-connection release request, without indication of release cause, is passed to the MM-sublayer, and the SMC entity enters the Idle state. + +In the case of a lower layer release, the SMC entity passes an MN-connection release request to SM-RL and then enters the Idle state. + +In all cases, if the timer TC1\* is running, it is reset. + +It is possible that the CP-ACK of a short message transfer might not be received (e.g. due to hand over). If the first CP-ACK (acknowledging the CP-DATA that carried the first RPDU) is not received the reception of CP-DATA may be interpreted as the reception of the awaited CP-ACK and CP-DATA message. + +## 5.4 Concatenating short message or notification transfers + +If an entity has more than one short message or notification to send, then it is useful to maintain the Radio Resource (RR) connection (in A/Gb mode) or the signalling connection (in Iu mode and in S1 mode if packet-switched service is used, and in N1 mode) in between transfers. For mobile terminated short messages this is simple because the network decides when, and whether, to release the RR connection (in A/Gb mode) or the signalling connection (in Iu mode and in S1 mode if packet-switched service is used, and in N1 mode). However, for mobile originated transfers, the network does not know whether or not the mobile has more messages to transfer. For short message transfer through the EPS in S1 mode if circuit-switched service is used, the network side has no knowledge of the signalling connection in for both mobile originated and mobile terminated transfers. + +If another short message or a memory available notification is to be sent, an originating SMR entity in the MS may choose to continue to use the same RR connection (in A/Gb mode) or the same signalling connection (in Iu mode or in N1 mode). + +In the case of a SMS transfer via the CS domain, when the MS chooses to use the same RR connection (in A/Gb mode) or CS signalling connection (in Iu mode), then: + +- the MS shall transmit a CM SERVICE REQUEST for the new CM connection before the final CP-ACK (i.e. the one that acknowledges the CP-DATA that carried the RP-ACK) for the old MM connection is transmitted; +- before transmission of the first CP-DATA on the new MM connection, the MS may transmit the CP-ACK for the old MM connection; the MS shall not transmit the final CP-ACK after the new CP-DATA; +- the Transaction Identifier used on the new MM connection shall be different to that used on the old MM connection; and +- the MS shall not initiate establishment of the new MM connection before the final CP-DATA (e.g. the one carrying the RP-ACK) has been received. + +In the case of a SMS transfer via the PS domain, when the MS chooses to use the same PS signalling connection (in Iu mode and in S1 mode if packet-switched service is used); or in the case of a SMS transfer via the PS domain in A/Gb mode; or in the case of SMS transfer through the EPS, or in the case of SMS transfer in N1 mode, then: + +- the MS shall transmit the CP-DATA for the successive RPDU and shall not transmit the final CP-ACK for the current SMS (i.e. the one that acknowledges the CP-DATA that carried the RP-ACK); +- the Transaction Identifier used for the successive RPDU shall be different to that used for the current RPDU; and +- the MS shall not transmit the CP-DATA for the successive RPDU before the final CP-DATA (i.e. the one that carried the RP-ACK) has been received. + +NOTE: When an MS sends successive memory available notifications and/or mobile originated short messages on different RR connections (in A/Gb mode) or signalling connections (in Iu mode and S1 mode), the MS is strongly recommended to use different Transaction Identifiers for the old and new MM connections. + +It is possible that the final CP-ACK of a short message transfer may not be received (e.g. due to transmission errors and/or hand overs). + +For mobile terminated transfers, if the CP-ACK is lost, the reception of a CP-DATA with a different transaction identifier and carrying an RPDU shall be interpreted as the implicit reception of the awaited CP-ACK followed by the reception of the new CP-DATA message. + +For mobile originated transfers, if the CP-ACK is lost or not sent by the MS, the following events shall be interpreted as the implicit reception of the awaited CP-ACK: + +- in the case of a SMS transfer via the CS domain,, the reception of a CM SERVICE REQUEST followed by a CP-DATA with a different transaction identifier and carrying an RPDU; or +- in the case of a SMS transfer via the PS domain, the reception of a CP-DATA with a different transaction identifier and carrying an RPDU. + +# --- 6 SM-RL-procedures + +## 6.1 General + +This clause describes the procedures used by the SMR entity for short message and notification support on the Short Message Relay Layer. An SMR entity communicates with a corresponding peer entity using a CM-connection. + +Multiple CM-connections may be established at the same time, allowing parallel transactions. There is a functional one to one relation between the SMR entity and the SMC entity of the CM-sublayer. The descriptions of the procedures are related to one single transaction. + +The RL-procedures described in this subclause can only be performed if a CM-connection has been established between the mobile station and the network. Detailed SDL-diagrams for short message control on SM-RL are contained in annex D. + +## 6.2 Transition states of SMR entity + +The state transition diagram for the SMR entities on both MS-side and network side are contained in annex D. + +### 6.2.1 SMR-states at the MS-side of the radio interface + +The states described in this subclause are for a SMR entity in a MS, handling mobile originating- and mobile terminating short messages and notification transfer. + +#### 6.2.1.1 Idle (State 0) + +This state exists when the SMR entity is in idle mode, or when a short message or notification transfer ends in a normal or abnormal way. + +#### 6.2.1.2 Wait for RP-ACK (State 1) + +This state exists for mobile originating short message or notification transfer when the SMR has passed the RP-DATA or RP-SMMA to the SMC entity and set the timer TR1M. + +##### 6.2.1.2a Wait to send RP-ACK (State 3) + +This state exists for mobile terminating short message transfer. The SMR entity will enter this state after passing a received RP-DATA message to TL and setting the timer TR2M. + +#### 6.2.1.3 Wait for RETRANS TIMER (State 4) + +This state exists for memory available notification when the SMR is waiting to retransmit the RP-SMMA message. Timer TRAM has been set. The possibility of an abort of the sending of the memory available notification by the SM-TL exists. No underlying connection exists. + +### 6.2.2 SMR-states at the network side of the radio interface + +The states described in this subclause are for a SMR entity in a MSC, handling mobile originating- and mobile terminating short message and notification transfer. + +#### 6.2.2.1 Idle (State 0) + +This state exists when the SMR entity is in idle mode, or when a short message transfer or notification end in a normal or abnormal way. + +#### 6.2.2.2 Wait for RP-ACK (State 1) + +This state exists for a mobile terminating short message transfer when the SMR has passed the RP-DATA message to the SMC entity and set the timer TR1N. + +#### 6.2.2.3 Wait to send RP-ACK (State 3) + +This state exists for mobile originating short message or notification transfer. The SMR entity will enter this state after passing a received RP-DATA or RP-SMMA message to TL and setting the timer TR2N. + +## 6.3 Short Message Relay procedures + +The procedures needed for short message and notification relaying are: + +- TP Data Unit (TPDU) relay procedures; +- notification relay procedures; +- procedures for abnormal cases. + +### 6.3.1 TPDU relaying + +When the SMR entity is in the Idle state and receives a request from SM-TL to relay a TPDU, it forms and transfers the RP-DATA message (containing the TPDU), sets the timer TR1\* and enters the state Wait for RP-ACK. + +Retransmission of RP data units by the CM-sublayer is described in clause 5. + +When the SMR entity is in the "Wait for RP-ACK" state, the following situations may occur: + +- a) reception of an RP-ACK or RP-ERROR message (containing the same reference number as the transmitted RP-DATA message); +- b) reception of an error indication from the CM-sublayer; +- c) the timer TR1\* expires. + +In case a) or b), the timer TR1\* is reset, a report indication is passed to SM-TL, a request to release the CM-connection is passed to CM-sublayer, and the SMR entity enters the Idle state. + +In case a) when the SMR entity in the MS receives an RP-ERROR message, the MS shall then take one of the following actions depending upon the received RP-ERROR cause: + +#69 "Requested facility not implemented" + +If this RP-ERROR cause was received in reaction to an SMS transfer via GPRS, the MS shall proceed as specified in the subclause 2.6. + +In case c), a request to abort the CM-connection is passed to the CM-sublayer, a report indication is passed to SM-TL, and the SMR entity enters the Idle state. + +When the SMR entity is in the Idle state and receives an MNSMS-EST-Ind containing a valid RP-DATA message, it passes the SMS-TPDU to the SM-TL, starts timer TR2\*, and enters the state "Wait to Send RP-ACK". + +When the SMR entity in the SGSN is in the Idle state and receives an MNSMS-EST-Ind containing a valid RP-DATA message, but the delivery of SMS via GPRS is not activated, the network shall return an RP-ERROR message with cause #69 "Requested facility not implemented" and remain in the Idle state. + +When the SMR entity is in the state "Wait to Send RP-ACK" and the SMR entity receives the SM-RL-Report-Request, the timer TR2\* is reset, the RP-message (RP-ACK or RP-ERROR) is generated and relayed to the peer entity, a CM-connection release request is passed to the CM-sublayer, and the SMR entity enters the Idle state. + +When the SMR entity is in the state "Wait to Send RP-ACK" and the SMR entity receives an error indication from the CM-sublayer, the timer TR2\* is reset, a report indication is passed to the SM-TL and the SMR entity enters the Idle state. + +When the SMR entity is in the state "Wait to send RP-ACK" and the timer TR2\* expires, the SMR entity passes a CM-connection abort request to the CM-sublayer, a report indication is passed to the SM-TL, and the SMR entity enters the Idle state. + +### 6.3.2 [Void] + +### 6.3.3 Notification relaying + +#### 6.3.3.1 MS side + +##### 6.3.3.1.1 Idle state + +When the SMR entity in the MS in the Idle state receives a request from the SM-TL to relay a notification to the network, it forms and transfers the RP-SMMA message, starts timer TR1M, and enters the state Wait for RP-ACK. + +##### 6.3.3.1.2 Wait for RP-ACK state + +When the SMR entity in the MS is in the Wait for RP-ACK state and it receives either: + +- an RP-ACK (containing the same reference number as the last transmitted RP-SMMA message); or +- an RP-ERROR (containing the same reference number as the last transmitted RP-SMMA message) with a permanent failure indication; or +- an error indication from the CP-sublayer; + +then the MS shall reset timer TR1M, pass a report indication to SM-TL, give a CM-connection release request to the CM-sublayer, and enter the Idle state. If set, timer TRAM and the RETRANS flag are also reset. + +If the SMR entity in the MS is in the Wait for RP-ACK state and receives an RP-ERROR message, the MS shall then take one of the following actions depending upon the received RP-ERROR cause: + +#69 "Requested facility not implemented" + +If this RP-ERROR cause was received in reaction to an SMS transfer via GPRS, the MS shall proceed as specified in the subclause 2.6. + +When the SMR entity in the MS is in the Wait for RP-ACK state and either: + +- it receives an RP-ERROR (containing the same reference number as the last transmitted RP-SMMA message) with a temporary failure indication; or +- timer TR1M expires; + +then the MS shall examine the RETRANS flag: + +- if the RETRANS flag is set (i.e. no more transmissions of the RP-SMMA message are permitted) then: + - the MS shall pass a report indication to SM-TL, give a CM-connection release request to the CM-sublayer, reset the RETRANS flag, reset TR1M, and enter the Idle state. +- If the RETRANS flag is not set (i.e. at least another transmission of the RP-SMMA message is currently permitted) then: + - the MS shall give a CM-connection release request to the CM-sublayer, set the RETRANS flag, reset TR1M, start timer TRAM and enter the Wait for Retrans Timer state. + +When the SMR entity in the MS is in the Wait for RP-ACK state and it receives an SM-RL-MEMORY-AVAILABLE-Req (SMS-MEM-NOTIF-ABORT) primitive, then the MS shall set the RETRANS flag and reenter the Wait for RP-ACK state. + +##### 6.3.3.1.3 Wait for RETRANS Timer state + +When the SMR entity in the MS is in the Wait for Retrans Timer state and timer TRAM expires then, the MS shall form and transfer an RP-SMMA message, start timer TR1M, and enter the state Wait for RP-ACK. The RP-Message Reference in this RP-SMMA message shall be different from that in the previous RP-SMMA message. + +When the SMR entity in the MS is in the Wait for Retrans Timer state and it receives an SM-RL-MEMORY-AVAILABLE-Req (SMS-MEM-NOTIF-ABORT) primitive, then the MS shall reset the RETRANS flag, reset timer TRAM, pass a report indication to SM-TL, and enter the Idle state. + +#### 6.3.3.2 Network side + +##### 6.3.3.2.1 Idle state + +When the SMR entity in the network is in the Idle state and receives an MNSMS-EST-Ind containing a valid RP-SMMA message, it passes the SMS-TPDU to the SM-TL, starts timer TR2N, and enters the state "Wait to send RP-ACK". + +When the SMR entity in the SGSN is in the Idle state and receives an MNSMS-EST-Ind containing a valid RP-SMMA message, but the delivery of SMS via GPRS is not activated, the network shall return an RP-ERROR message with cause #69 "Requested facility not implemented" and remain in the Idle state. + +##### 6.3.3.2.2 Wait to Send RP-ACK state + +When the SMR entity in the network is in the state "Wait to Send RP-ACK" and the SMR entity receives the SM-RL-Report-Request, timer TR2N is reset, the RP-message (RP-ACK or RP-ERROR) is generated and relayed to the MS, a CM-connection release request is passed to the CM-sublayer, and the SMR entity enters the Idle state. + +When the SMR entity in the network is in the state "Wait to Send RP-ACK" and the SMR entity receives an error indication from the CM-sublayer, timer TR2N is reset, a report indication is passed to the SM-TL and the SMR entity enters the Idle state. + +When the SMR entity in the network is in the state "Wait to Send RP-ACK" and the timer TR2N expires, the SMR entity passes a CM-connection abort request to the CM-sublayer, a report indication is passed to the SM-TL, and the SMR entity enters the Idle state. + +### 6.3.4 Abnormal cases + +Format errors etc.: + +If the SMR entity upon receipt of an RP-DATA or RP-SMMA message detects an erroneous condition which it can act on, (e.g. format errors, invalid parameters etc.) it shall return an RP-ERROR message with an appropriate + +cause value and possibly extended diagnostic information, release or abort the CM-connection, and enter the Idle state. + +# 7 Message functional definitions and content + +## 7.1 General + +The notation used is as used in 3GPP TS 24.008 [5]/clause 9, and each definition includes: + +- a) A brief description of the message direction and use. +- b) A table listing the information elements in the order of their appearance in the message. For each information element the table indicates: + - 1) A reference to the (sub)clause/Technical Specification describing the information element. + - 2) The presence requirement indication (M, C, or O) for the IE as defined in 3GPP TS 24.007 [4]. + - 3) The format of the information element (T, V, TV, LV, TLV) as defined in 3GPP TS 24.007 [4]. + - 4) The length of the information element (or permissible range of lengths), in octets, in the messages. + +## 7.2 Messages for short message or notification transfer on CM + +This subclause describes the functional definition and content of the messages sent between two SMC entities. + +There are three messages defined: CP-DATA, CP-ACK and CP-ERROR. + +### 7.2.1 CP-DATA + +The CP-DATA message is sent between an MSC and an MS, in both directions. The message contains the user data to be relayed between the CM-users, and associated parameters. See table 7.1/ 3GPP TS 24.011. + +**Table 7.1/3GPP TS 24.011: CP-DATA message content** + +| | Information element | Reference | Presence | Format | Length | +|--|------------------------|-------------------|----------|--------|--------------| +| | Protocol discriminator | 3GPP TS 24.007 | M | V | 1/2 octet | +| | Transaction identifier | 3GPP TS 24.007 | M | V | 1/2 octet | +| | Message type | Subclause 8.1.3 | M | V | 1 octet | +| | CP-User data | Subclause 8.1.4.1 | M | LV | ≤ 249 octets | + +### 7.2.2 CP-ACK + +The CP-ACK message is sent between an MSC and an MS, in both directions, and is used to acknowledge the reception of a CP-DATA message. See table 7.2/3GPP TS 24.011. + +**Table 7.2/3GPP TS 24.011: CP-ACK message content** + +| | Information element | Reference | Presence | Format | Length | +|--|------------------------|-----------------|----------|--------|-----------| +| | Protocol discriminator | 3GPP TS 24.007 | M | V | 1/2 octet | +| | Transaction identifier | 3GPP TS 24.007 | M | V | 1/2 octet | +| | Message type | Subclause 8.1.3 | M | V | 1 octet | + +### 7.2.3 CP-ERROR + +The CP-ERROR message is sent between an MSC and an MS, in both directions, and used to convey error information. See table 7.3/3GPP TS 24.011. + +**Table 7.3/3GPP TS 24.011: CP-ERROR message content** + +| | Information element | Reference | Presence | Format | Length | +|--|------------------------|-------------------|----------|--------|-----------| +| | Protocol discriminator | 3GPP TS 24.007 | M | V | 1/2 octet | +| | Transaction identifier | 3GPP TS 24.007 | M | V | 1/2 octet | +| | Message type | Subclause 8.1.3 | M | V | 1 octet | +| | CP-Cause | Subclause 8.1.4.2 | M | V | 1 octet | + +## 7.3 Messages for short message and notification transfer on SM-RL + +This subclause describes the functional definition and content of the messages sent between two SMR entities. + +There are 4 messages defined: RP-DATA, RP-SMMA, RP-ACK and RP-ERROR. + +### 7.3.1 RP-DATA + +A phase 2 entity shall not reject a RP-DATA message where both address elements have a length greater than 0. + +#### 7.3.1.1 RP-DATA (Network to Mobile Station) + +This message is sent in MSC -> MS direction. The message is used to relay the TPDU. The information elements are in line with 3GPP TS 23.040. See table 7.4/3GPP TS 24.011. + +**Table 7.4/3GPP TS 24.011: RP-DATA message content** + +| | Information element | Reference | Presence | Format | Length | +|--|------------------------|-------------------|----------|--------|--------------| +| | RP-Message Type | Subclause 8.2.2 | M | V | 3 bits | +| | RP-Message Reference | Subclause 8.2.3 | M | V | 1 octet | +| | RP-Originator Address | Subclause 8.2.5.1 | M | LV | 1-12 octets | +| | RP-Destination Address | Subclause 8.2.5.2 | M | LV | 1 octet | +| | RP-User Data | Subclause 8.2.5.3 | M | LV | ≤ 233 octets | + +#### 7.3.1.2 RP-DATA (Mobile Station to Network) + +This message is sent in MS -> MSC direction. The message is used to relay the TPDU. The information elements are in line with 3GPP TS 23.040. See table 7.5/3GPP TS 24.011. + +**Table 7.5/3GPP TS 24.011: RP-DATA message content** + +| | Information element | Reference | Presence | Format | Length | +|--|------------------------|-------------------|----------|--------|--------------| +| | RP-Message Type | Subclause 8.2.2 | M | V | 3 bits | +| | RP-Message Reference | Subclause 8.2.3 | M | V | 1 octet | +| | RP-Originator Address | Subclause 8.2.5.1 | M | LV | 1 octet | +| | RP-Destination Address | Subclause 8.2.5.2 | M | LV | 1-12 octets | +| | RP-User Data | Subclause 8.2.5.3 | M | LV | ≤ 233 octets | + +### 7.3.2 RP-SMMA + +This message is sent by the mobile station to relay a notification to the network that the mobile has memory available to receive one or more short messages. The information elements are in line with 3GPP TS 23.040. See table 7.6/3GPP TS 24.011. + +**Table 7.6/3GPP TS 24.011: RP-SMMA message content** + +| | Information element | Reference | Presence | Format | Length | +|--|----------------------|-----------------|----------|--------|---------| +| | RP-Message Type | Subclause 8.2.2 | M | V | 3 bits | +| | RP-Message Reference | Subclause 8.2.3 | M | V | 1 octet | + +### 7.3.3 RP-ACK + +This message is sent between the MSC and the mobile station in both directions and used to relay the acknowledgement of a RP-DATA or RP-SMMA message reception. The information elements are in line with 3GPP TS 23.040. See table 7.7/3GPP TS 24.011. + +**Table 7.7/3GPP TS 24.011: RP-ACK message content** + +| IEI | Information element | Reference | Presence | Format | Length | +|-----|----------------------|-------------------|----------|--------|--------------| +| | RP-Message Type | Subclause 8.2.2 | M | V | 3 bits | +| | RP-Message Reference | Subclause 8.2.3 | M | V | 1 octet | +| 41 | RP-User Data | Subclause 8.2.5.3 | O | TLV | ≤ 234 octets | + +### 7.3.4 RP-ERROR + +This message is sent between the MSC and the mobile station in both directions and used to relay an error cause from an erroneous short message or notification transfer attempt. The information elements are in line with 3GPP TS 23.040. See table 7.8/3GPP TS 24.011. + +The contents of the cause field are given in subclause 8.2.5.4. + +**Table 7.8/3GPP TS 24.011: RP-ERROR message content** + +| IEI | Information element | Reference | Presence | Format | Length | +|-----|----------------------|-------------------|----------|--------|--------------| +| | RP-Message Type | Subclause 8.2.2 | M | V | 3 bits | +| | RP-Message Reference | Subclause 8.2.3 | M | V | 1 octet | +| | RP-Cause | Subclause 8.2.5.4 | M | LV | 2-3 octets | +| 41 | RP-User Data | Subclause 8.2.5.3 | O | TLV | ≤ 234 octets | + +# 8 Message format and information elements coding + +## 8.1 CP-messages + +### 8.1.1 General + +The message format and information elements coding is in line with 3GPP TS 24.007 [4] and 3GPP TS 24.008 [5]. + +The message shall consist of the following parts: + +- protocol discriminator; +- transaction identifier; +- message type; +- other required information elements. + +This organization is illustrated in the example shown in figure 8.1/3GPP TS 24.011. + +![](686b6779045a75d57a4cff59aed11dc8_img.jpg) + +| | | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-----------------|--------------|--|----------------------------|--| +| 8    7    6    5    4    3    2    1 | | | | | | | +|
Transaction Id. Protocol Discr.
Message Type
Other Information Elements
| Transaction Id. | Protocol Discr. | Message Type | | Other Information Elements | | +| Transaction Id. | Protocol Discr. | | | | | | +| Message Type | | | | | | | +| Other Information Elements | | | | | | | + +**Figure 8.1/3GPP TS 24.011** + +### 8.1.2 Protocol Discriminator and Transaction Identifier + +The Protocol Discriminator and Transaction Identifier is described in 3GPP TS 24.007 [4]. + +### 8.1.3 Message type + +The purpose of the message type, together with the protocol discriminator, is to identify the function of the message being sent. The coding of message types is shown in table 8.1/3GPP TS 24.011. + +**Table 8.1/3GPP TS 24.011: Message types for short message and notification transfer on CM** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|----------| +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | CP-DATA | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | CP-ACK | +| 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | CP-ERROR | + +### 8.1.4 Other required information elements + +#### 8.1.4.1 CP-User data element + +The CP-User data element is used to carry the RPDUs. It has an information element identifier, a length indicator and a data field. The data field will contain the RPDUs. The maximum length of the data field is 248 octets. The layout is indicated in figure 8.2/3GPP TS 24.011. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +|-----------------------------------|---|---|---|---|---|---|---|--------------------------|---------| +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | CP-User Data IEI 1 octet | | +| Length indicator | | | | | | | | | 1 octet | +| RPDU
Maximum length 248 octets | | | | | | | | | ? octet | + +**Figure 8.2/3GPP TS 24.011: CP-User data element layout** + +#### 8.1.4.2 CP-Cause element + +This element is included in the CP-ERROR message, the layout is given in figure 8.3/3GPP TS 24.011. The error causes are listed in table 8.2/3GPP TS 24.011. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +|-------------|---|---|---|---|---|---|---|----------------------|---------| +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | CP-Cause IEI 1 octet | | +| Cause value | | | | | | | | | 1 octet | + +**Figure 8.3/3GPP TS 24.011: CP-Cause element layout** + +**Table 8.2/3GPP TS 24.011: Content and coding of CP-Cause** + +| Cause value | Cause nr. | Cause | +|--------------------------------------------------------------|-----------|--------------------------------------------------------------| +| 7 6 5 4 3 2 1 | # | | +| 0 0 1 0 0 0 1 | 17 | Network failure | +| 0 0 1 0 1 1 0 | 22 | Congestion | +| 1 0 1 0 0 0 1 | 81 | Invalid Transaction Identifier value | +| 1 0 1 1 1 1 1 | 95 | Semantically incorrect message | +| 1 1 0 0 0 0 0 | 96 | Invalid mandatory information | +| 1 1 0 0 0 0 1 | 97 | Message type non-existent or not implemented | +| 1 1 0 0 0 1 0 | 98 | Message not compatible with the short message protocol state | +| 1 1 0 0 0 1 1 | 99 | Information element non-existent or not implemented | +| 1 1 0 1 1 1 1 | 111 | Protocol error, unspecified | +| All other cause values shall be treated as cause number 111. | | | + +## 8.2 RP-messages + +### 8.2.1 General + +The message shall consist of the following parts: + +- message type indicator; +- message reference; +- other required information elements. + +This organization is illustrated in the example shown in figure 8.4/3GPP TS 24.011: + +![](257c8341b41f1f4a287f27d33227974c_img.jpg) + +| | | | | | | | | +|----------------------------|---|---|---|---|-----|---|---| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| spare | | | | | MTI | | | +| 0 | 0 | 0 | 0 | 0 | | | | +| Message reference | | | | | | | | +| Other Information Elements | | | | | | | | + +**Figure 8.4/3GPP TS 24.011** + +### 8.2.2 Message type indicator (MTI) + +The message type indicator, MTI, is a 3-bit field, located in the first octet of all RP-messages. The coding of the MTI is defined by table 8.3/3GPP TS 24.011. + +**Table 8.3/3GPP TS 24.011: Coding of Message Type Indicator** + +| Bit value | Direction | RP-Message | +|-----------|-----------|------------| +| | | 3 2 1 | +| 0 0 0 | ms -> n | RP-DATA | +| 0 0 0 | n -> ms | Reserved | +| 0 0 1 | ms -> n | Reserved | +| 0 0 1 | n -> ms | RP-DATA | +| 0 1 0 | ms -> n | RP-ACK | +| 0 1 0 | n -> ms | Reserved | +| 0 1 1 | ms -> n | Reserved | +| 0 1 1 | n -> ms | RP-ACK | +| 1 0 0 | ms -> n | RP-ERROR | +| 1 0 0 | n -> ms | Reserved | +| 1 0 1 | ms -> n | Reserved | +| 1 0 1 | n -> ms | RP-ERROR | +| 1 1 0 | ms -> n | RP-SMMA | +| 1 1 0 | n -> ms | Reserved | +| 1 1 1 | ms -> n | Reserved | +| 1 1 1 | n -> ms | Reserved | + +### 8.2.3 Message reference + +The message reference field contains a sequence number in the range 0 through 255, and is used to link an RP-ACK message or RP-ERROR message to the associated (preceding) RP-DATA or RP-SMMA message transfer attempt. + +### 8.2.4 Void + +### 8.2.5 Other required information elements + +#### 8.2.5.1 Originator address element + +In the case of MT transfer this element contains the originating Service Centre address. + +The RP-Originator Address information element is coded as shown in figure 8.5/3GPP TS 24.011. + +The RP-Originator Address is a type 4 information element. In the network to mobile station direction the minimum value of the length octet is 2 and the maximum value is 11. In the mobile station to network direction the value of the length octet of the element is set to 0. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | +|------------------------------------------|---------------------------|---|-------------------------------|----------------|---|---|---|---------|--|--| +| | RP-Originator Address IEI | | | | | | | octet 1 | | | +| Length of RP-Originator Address contents | | | | | | | | octet 2 | | | +| 1 ext | type of number | | Numbering plan identification | | | | | octet 3 | | | +| Number digit 2 | | | | Number digit 1 | | | | octet 4 | | | +| Number digit 4 | | | | Number digit 3 | | | | octet 5 | | | +| | | | | | | | | : | | | +| | | | | | | | | : | | | + +**Figure 8.5/3GPP TS 24.011: RP-Originator Address information element** + +If the RP-Originator Address contains an odd number of digits, bits 5 to 8 of the last octet shall be filled with an end mark coded as "1111". + +The contents of octets 3, 4, etc. are the same as those defined for the Called Party BCD Number IE defined in 3GPP TS 24.008 [5]. + +#### 8.2.5.2 Destination address element + +In the case of MO transfer, this element contains the destination Service Centre address. + +The RP-Destination Address information element is coded as shown in figure 8.6/3GPP TS 24.011. + +The RP-Destination Address is a type 4 information element. In the mobile station to network direction the minimum value of the length octet is 2 and the maximum value is 11. In the network to mobile station direction, the value of the length octet of the element is set to 0. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +|-------------------------------------------|-----------------------------------|---|---|-------------------------------|---|---|---|---------|--|--|--| +| | RP-Destination Address number IEI | | | | | | | octet 1 | | | | +| Length of RP-Destination Address contents | | | | | | | | octet 2 | | | | +| 1 ext | type of number | | | Numbering plan identification | | | | octet 3 | | | | +| Number digit 2 | | | | Number digit 1 | | | | octet 4 | | | | +| Number digit 4 | | | | Number digit 3 | | | | octet 5 | | | | +| | | | | | | | | : | | | | +| | | | | | | | | : | | | | + +**Figure 8.6/3GPP TS 24.011: RP-Destination Address information element** + +The number digit(s) in octet 4 precede the digit(s) in octet 5 etc. The number digit which would be entered first is located in octet 4, bits 1 to 4. + +If the RP-Destination Address contains an odd number of digits, bits 5 to 8 of the last octet shall be filled with an end mark coded as "1111". + +Since the information element contains the complete RP-Destination Address there is no need for an additional complete indication. + +The contents of octets 3, 4, etc. are the same as those defined for the Called Party BCD Number IE defined in 3GPP TS 24.008 [5]. + +#### 8.2.5.3 RP-User data element + +The RP-User data field contains the TPDU and is mandatory in a RP-DATA message. RP-User data is also optionally carried in an RP-Error message. In a RP DATA message, the element has a variable length, up to 233 octets, and in a RP ERROR and in a RP ACK message the length is up to 234 octets. + +RP-User data in an RP-Error message is conveyed as diagnostic information within the "SM-DeliveryFailureCause" response to a MAP Forward-Short-Message procedure (see 3GPP TS 29.002). The diagnostic information may be sent in both directions, and shall always be forwarded by the MSC if it is received. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------------|---|---|---|---|---|---|---|---------| +| 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 octet | +| RP-User Data IEI | | | | | | | | | +| Length indicator | | | | | | | | 1 octet | +| TPDU | | | | | | | | | +| Maximum length 232 octets | | | | | | | | | + +**Figure 8.7/3GPP TS 24.011: RP-User data element layout** + +#### 8.2.5.4 RP-Cause element + +This element is a variable length element always included in the RP-ERROR message, conveying a negative result of a RP-DATA message transfer attempt or RP-SMMA notification attempt. The element contains a cause value and optionally a diagnostic field giving further details of the error cause. + +The coding of the cause value is given in table 8.4/3GPP TS 24.011. The mapping between error causes in 3GPP TS 24.011 and 3GPP TS 29.002 (MAP) is specified in 3GPP TS 23.040. Parameters included in the return error from MAP (e.g. System Failure) are mapped directly into the diagnostic field. + +![](8c880d6b715587bd710a9ba8414469b1_img.jpg) + +| | | | | | | | | | | +|--|------------------|-------------|---|---|---|---|---|---|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 1 octet | +| | RP-Cause IEI | | | | | | | | | +| | Length indicator | | | | | | | | 1 octet | +| | 0 ext | Cause value | | | | | | | 1 octet | +| | | Cause value | | | | | | | | +| | Diagnostic field | | | | | | | | 1 octet * | + +Figure 8.8/3GPP TS 24.011: RP-Cause element layout + +Table 8.4/3GPP TS 24.011 (part 1): Cause values that may be contained in an RP-ERROR message in a mobile originating SM-transfer attempt + +| Cause value | Cause | Cause | +|----------------------------------------------------------------------------------|--------|----------------------------------------------------------| +| Class value | number | | +| 7 6 5 4 3 2 1 | # | | +| 0 0 0 0 0 0 1 | 1 | Unassigned (unallocated) number | +| 0 0 0 1 0 0 0 | 8 | Operator determined barring | +| 0 0 0 1 0 1 0 | 10 | Call barred | +| 0 0 0 1 0 1 1 | 11 | Reserved | +| 0 0 1 0 1 0 1 | 21 | Short message transfer rejected | +| 0 0 1 1 0 1 1 | 27 | Destination out of order | +| 0 0 1 1 1 0 0 | 28 | Unidentified subscriber | +| 0 0 1 1 1 0 1 | 29 | Facility rejected | +| 0 0 1 1 1 1 0 | 30 | Unknown subscriber | +| 0 1 0 0 1 1 0 | 38 | Network out of order | +| 0 1 0 1 0 0 1 | 41 | Temporary failure | +| 0 1 0 1 0 1 0 | 42 | Congestion | +| 0 1 0 1 1 1 1 | 47 | Resources unavailable, unspecified | +| 0 1 1 0 0 1 0 | 50 | Requested facility not subscribed | +| 1 0 0 0 1 0 1 | 69 | Requested facility not implemented | +| 1 0 1 0 0 0 1 | 81 | Invalid short message transfer reference value | +| 1 0 1 1 1 1 1 | 95 | Semantically incorrect message | +| 1 1 0 0 0 0 0 | 96 | Invalid mandatory information | +| 1 1 0 0 0 0 1 | 97 | Message type non-existent or not implemented | +| 1 1 0 0 0 1 0 | 98 | Message not compatible with short message protocol state | +| 1 1 0 0 0 1 1 | 99 | Information element non-existent or not implemented | +| 1 1 0 1 1 1 1 | 111 | Protocol error, unspecified | +| 1 1 1 1 1 1 1 | 127 | Interworking, unspecified | +| All other cause values shall be treated as cause number 41, "Temporary Failure". | | | + +**Table 8.4/3GPP TS 24.011 (part 2): Cause values that may be contained in an RP-ERROR message in a mobile terminating SM-transfer attempt** + +| Cause value | Cause | Cause | +|---------------------------------------------------------------------------------------------|--------|----------------------------------------------------------| +| Class value | number | | +| 7 6 5 4 3 2 1 | # | | +| 0 0 1 0 1 1 0 | 22 | Memory capacity exceeded | +| 1 0 1 0 0 0 1 | 81 | Invalid short message transfer reference value | +| 1 0 1 1 1 1 1 | 95 | Semantically incorrect message | +| 1 1 0 0 0 0 0 | 96 | Invalid mandatory information | +| 1 1 0 0 0 0 1 | 97 | Message type non-existent or not implemented | +| 1 1 0 0 0 1 0 | 98 | Message not compatible with short message protocol state | +| 1 1 0 0 0 1 1 | 99 | Information element non-existent or not implemented | +| 1 1 0 1 1 1 1 | 111 | Protocol error, unspecified | +| All other cause values shall be treated as cause number 111, "Protocol error, unspecified". | | | + +**Table 8.4/3GPP TS 24.011 (part 3): Cause values that may be contained in an RP-ERROR message in a memory available notification attempt** + +| Cause value | Cause | Cause | Cause | +|------------------------------------------------------------------------------------------------------------------------|--------|-------|----------------------------------------------------------| +| Class value | number | type | | +| 7 6 5 4 3 2 1 | # | | | +| 0 0 1 1 1 1 0 | 30 | P | Unknown Subscriber | +| 0 1 0 0 1 1 0 | 38 | T | Network out of order | +| 0 1 0 1 0 0 1 | 41 | T | Temporary failure | +| 0 1 0 1 0 1 0 | 42 | T | Congestion | +| 0 1 0 1 1 1 1 | 47 | T | Resources unavailable, unspecified | +| 1 0 0 0 1 0 1 | 69 | P | Requested facility not implemented | +| 1 0 1 1 1 1 1 | 95 | P | Semantically incorrect message | +| 1 1 0 0 0 0 0 | 96 | P | Invalid mandatory information | +| 1 1 0 0 0 0 1 | 97 | P | Message type non-existent or not implemented | +| 1 1 0 0 0 1 0 | 98 | P | Message not compatible with short message protocol state | +| 1 1 0 0 0 1 1 | 99 | P | Information element non-existent or not implemented | +| 1 1 0 1 1 1 1 | 111 | P | Protocol error, unspecified | +| 1 1 1 1 1 1 1 | 127 | P | Interworking, unspecified | +| All other cause values are treated as cause number 41, "Temporary failure". | | | | +| Each cause is classified as "Temporary" or "Permanent", as indicated by T and P respectively in the cause type column. | | | | + +# 9 Handling of unknown, unforeseen, and erroneous protocol data + +## 9.1 General + +This subclause specifies procedures for handling of unknown, unforeseen, and erroneous protocol data by the receiving entity. These procedures are called "error handling procedures", but in addition to providing recovery mechanisms for error situations they define a compatibility mechanism for future extensions of the protocols. + +Most error handling procedures are mandatory for the MS but optional for the network. Detailed error handling procedures in the network are implementation dependent and may vary from PLMN to PLMN. + +In this subclause the following terminology is used: + +- an IE is defined to be syntactically incorrect in a message if it contains at least one value defined as "reserved", or if its value part violates rules. However it is not a syntactical error that a type 4 IE specifies in its length indicator a greater length than defined; +- a message is defined to have semantically incorrect contents if it contains information which, possibly dependant on the state of the receiver, is in contradiction to the resources of the receiver and/or to the procedural part of 3GPP TS 24.011. + +## 9.2 CP Error Handling + +Upon receiving a CP-ERROR message the SMC-CS entity (in any state) shall pass an error indication to SM-RL, pass an MM-connection release request to the MM-sublayer, and enter the Idle State. + +After sending a CP-ERROR message the SMC-CS entity (in any state) shall pass an MM-connection release request to the MM sublayer and then enter the Idle State. + +Upon receiving a CP-ERROR message the SMC-GP entity (in any state) shall pass an error indication to SM-RL and enter the Idle State. + +After sending a CP-ERROR message the SMC-GP entity (in any state) shall enter the Idle State. + +### 9.2.1 Message too short + +When a message is received that is too short to contain a complete message type information element, that message shall be ignored, see 3GPP TS 24.007 [4]. + +### 9.2.2 Unknown or unforeseen transaction identifier + +The Mobile Station shall ignore a CP message (CP-DATA, CP-ACK, CP-ERROR) received with TI value "111". Whenever a CP-ACK message is received specifying a Transaction Identifier which is not associated with an active SM transfer, the mobile station shall discard the message and return a CP-ERROR message with cause #81, "Invalid Transaction Identifier" using the received Transaction Identifier, if an appropriate connection exists. The Mobile Station shall ignore a CP-ERROR message that is received specifying a Transaction Identifier which is not associated with an active SM transfer. The Mobile Station shall ignore a CP-DATA message that is received specifying a Transaction Identifier which is not associated with an active SM transfer and with transaction identifier flag set to "1". + +The same procedures may apply to the network. + +### 9.2.3 Unknown or unforeseen message type + +If the Mobile Station receives a message with message type not defined for the PD or not implemented by the receiver, it shall ignore the message and return a CP-ERROR message with cause #97 "message type non-existent or not implemented", if an appropriate connection exists. + +NOTE: A message type not defined for the PD in the given direction is regarded by the receiver as a message type not defined for the PD, see 3GPP TS 24.007 [4]. + +If the Mobile Station receives a message not consistent with the protocol state, the Mobile Station shall ignore the message and return a CP-ERROR message with cause #98 "Message type not compatible with the short message protocol state", if an appropriate connection exists. + +The network may follow the same procedures. + +### 9.2.4 Non-semantical mandatory information element errors + +When on receipt of a message: + +- an "imperative message part" error; or +- a "missing mandatory IE" error. + +is diagnosed or when a message containing a syntactically incorrect mandatory IE is received, the mobile station shall proceed as follows. + +When the corresponding SM transfer is not seen as successfully transferred, i.e. the transaction is not completed, the mobile station shall ignore the message and return a CP-ERROR message with cause #96 "invalid mandatory information", if an appropriate connection exists. + +When the SM transfer is seen as successfully transferred, the mobile station shall ignore the message and enter the Idle State. + +In the case that the message received is a CP-ERROR message, the mobile station shall ignore the message and enter the Idle State. + +The network may follow the applicable procedures defined in this subclause. + +### 9.2.5 Messages with semantically incorrect contents + +When a message with semantically incorrect contents is received, the foreseen reactions of the procedural part of 3GPP TS 24.011 are performed. If however no such reactions are specified, the mobile station shall proceed as follows: + +- when the corresponding SM transfer is not seen as successfully transferred, the mobile station shall ignore the message and return a CP-ERROR message with cause value #95 "semantically incorrect message", if an appropriate connection exists; +- when the SM transfer is seen as successfully transferred, the mobile station shall ignore the message and enter the Idle State; +- in the case that the message received is a CP-ERROR message, the mobile station shall ignore the message and enter the Idle State. + +The network may follow the same procedure. + +## 9.3 RP Error Handling + +Upon receiving or sending an RP-ERROR message the SMR entity shall behave as described in the procedural description in clause 6. + +### 9.3.1 Message too short + +When a message is received that is too short to contain a complete message type information element and Message Reference, that message shall be ignored. + +### 9.3.2 Unknown or unforeseen Message Reference + +Whenever any RP-ACK message is received specifying a Message Reference which is not associated with an active SM transfer, the mobile station shall discard the message and return an RP-ERROR message with cause #81, "Invalid short message transfer reference value" using the received Message Reference, if an appropriate connection exists. + +When an RP-ERROR message is received specifying a Message Reference which is not associated with an active SM transfer, the mobile station shall discard the message. If that discarded RP-ERROR message was part of MT SM transaction a request to abort the CM-connection shall be passed to the CM-sublayer. + +When the mobile station's SMR entity is not in the Idle state, and it receives an RP-DATA message specifying a Message Reference which is not associated with the active SM transfer, then it shall either: + +- send an RP-ERROR message with cause #81, "Invalid short message transfer reference value" using the received Message Reference, if an appropriate connection exists; or +- behave as described below for the receipt of an message not consistent with the protocol state. + +The same procedures may apply to the network. + +### 9.3.3 Unknown or unforeseen message type + +If the Mobile Station receives a RP-message indicating a value of the message type indicator (MTI) defined as reserved, it shall ignore the message and return an RP-ERROR message with cause #97 "message type non-existent or not implemented", if an appropriate connection exists. + +If the Mobile Station receives a message (except RP-ERROR) not consistent with the protocol state, the Mobile Station shall ignore the message and return a RP-ERROR message with cause #98 "Message type not compatible with Short Message protocol state", if an appropriate connection exists. + +If the Mobile Station receives an RP-ERROR message not consistent with the protocol state, the Mobile Station shall ignore the message. If that discarded RP-ERROR message was part of MT SM transaction a request to abort the CM-connection shall be passed to the CM-sublayer. + +The network may follow the same procedures. + +### 9.3.4 Non-semantical mandatory information element errors + +When on receipt of a message: + +- an "imperative message part" error; or +- a "missing mandatory IE" error; + +is diagnosed or when a message containing a syntactically incorrect mandatory IE is received, the mobile station shall (except for the case of a reserved value of the MTI as defined above) proceed as follows: + +- when the message is an RP-DATA or RP-ACK, the mobile station shall ignore the message and return an RP-ERROR message with cause #96 "invalid mandatory information", if an appropriate connection exists; +- when the message is an RP-ERROR, the mobile station shall treat the message as an RP-ERROR message carrying RP-Cause value 111 without any diagnostic field, and with no RP-User Data. + +The network may follow the applicable procedures defined in this subclause. + +### 9.3.5 Messages with semantically incorrect contents + +When a message with semantically incorrect contents is received, the foreseen reactions of the procedural part of 3GPP TS 24.011 are performed. If however no such reactions are specified then: + +- if the message was not an RP-ERROR message, the MS shall ignore the message and return an RP-ERROR message with cause value #95 "semantically incorrect message", if an appropriate connection exists; while +- if the message was an RP-ERROR message, the mobile station shall treat the message as an RP-ERROR message carrying RP-Cause value #111 without any diagnostic field, and with no RP-User Data. + +The network may follow the same procedure. + +# --- 10 Timers + +## 10.1 Timers when the MS is not using EPS services with control plane CLoT EPS optimization and not using 5GS services with control plane CLoT 5GS optimization + +The present document places the following requirements on the timers described in the present document: + +- timer TR1M shall be greater than 35 seconds and less than 45 seconds; +- the value of timer TRAM shall be greater than 25 seconds and less than 35 seconds; +- timer TR2M shall be greater than 12 seconds and less than 20 seconds. + +## 10.2 Timers when the MS is using EPS services with control plane CLoT EPS optimization or using 5GS services with control plane CLoT 5GS optimization + +For timer TR2M and TRAM, requirements remain the same as described in subclause 10.1. + +For timer TR1M, the requirement is as follows: + +- if an MS is in NB-S1 mode (see 3GPP TS 24.301 [10]) or NB-N1 mode (see 3GPP TS 24.501 [15]): + - timer TR1M shall be greater than 35+360 seconds and less than 45+360 seconds; and +- if an MS supports CE mode B and operates in WB-S1 mode in either CE mode A or CE mode B (see 3GPP TS 24.301 [10]), or operates in WB-N1 mode in either CE mode A or CE mode B (see 3GPP TS 24.501 [15]): + - timer TR1M shall be greater than 195 seconds and less than 205 seconds; + +Timer TC1\* typically varies with the length of the CP-DATA: + +- if an MS is in NB-S1 mode or NB-N1 mode, then for the first transmission of the CP-DATA the value of timer TC1\* needs to be increased by 240 seconds from the normal value used based on the length of the CP-DATA and for the CP-DATA retransmissions the value of timer TC1\* needs to be increased by 40 seconds from normal value value; and +- if an MS supports CE mode B and operates in WB-S1 mode in either CE mode A or CE mode B, or operates in WB-N1 mode in either CE mode A or CE mode B, then the value of timer TC1\* needs to be increased by 40 seconds from the normal value used based on the length of the CP-DATA. + +# --- Annex A (informative): Arrow diagrams + +## Arrow diagram A1: + +The diagram shows CS MO-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +## Arrow diagram A2: + +The diagram shows CS MT-messaging by means of interlayer service primitives and the actual messages being transferred between the layer entities in A/Gb mode. + +## Arrow diagram A5: + +The diagram shows GPRS MO-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- LLSMS-primitives indicate services provided by LLC to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledge CP-DATA reception on CM. + +## Arrow diagram A6: + +The diagram shows GPRS MT-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities in A/Gb mode. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- LLSMS-primitives indicate services provided by LLC to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledge CP-DATA reception on CM. + +## Arrow diagram A7: + +The diagram shows Iu mode PS MO-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- PMMSMS-primitives indicate services provided by GMM to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledge CP-DATA reception on CM. + +## Arrow diagram A8: + +The diagram shows Iu mode PS MT-messaging by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- PMMSMS-primitives indicate services provided by GMM to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledge CP-DATA reception on CM. + +NOTE: Diagrams for supporting SMS through the EPS are not provided. + +Arrow diagram A9: + +The diagram shows if packet-switched service is used, S1 mode EPS MO-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- EMMSMS-primitives indicate services provided by EMM to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledges CP-DATA reception on CM. + +Arrow diagram A9a: + +The diagram shows if packet-switched service is used and the UE is using EPS services with control plane CIoT EPS optimization, S1 mode EPS MO-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- EMMSMS-primitives indicate services provided by EMM to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledges CP-DATA reception on CM. + +Arrow diagram A10: + +The diagram shows if packet-switched service is used, S1 mode EPS MT-messaging by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- MNSMS-primitives indicate services provided by CM to SM-RL. +- EMMSMS-primitives indicate services provided by EMM to CM. +- CP-DATA is the CM-message carrying SM-RP data units. +- CP-ACK acknowledges CP-DATA reception on CM. + +## **Mobile Originated Messaging on CM-sublayer** + +![Sequence diagram for Mobile Originated Messaging on CM-sublayer. It shows interactions between SM-RL, CM, and MM layers on both the Mobile Station Side and the Network Side. The process involves MN SMS EST-Req, MMSMS EST-Req, CP-DATA, CP-ACK, MN SMS EST-Ind, MN SMS DATA-Req, MN SMS DATA-Ind, and MN SMS REL-Req messages.](0f1767577a073167eb9628d72034e083_img.jpg) + +``` +sequenceDiagram + participant SM-RL as SM-RL + participant CM as CM + participant MM as MM + Note right of MM: Network Side + Note left of CM: Mobile Station Side + + SM-RL->>CM: MN SMS-EST-Req (RP-DATA) + CM->>MM: MMSMS-EST-Req + MM-->>CM: MMSMS-EST-Conf + CM->>MM: CP-DATA + MM-->>CM: CP-ACK + CM->>MM: MMSMS-EST-Ind + MM-->>CM: MN SMS-EST-Ind (RP-DATA) + CM->>SM-RL: MN SMS-DATA-Req (RP-ACK) + SM-RL-->>CM: MN SMS-DATA-Ind (RP-ACK) + CM->>MM: CP-DATA + MM-->>CM: CP-ACK + SM-RL->>CM: MN SMS-REL-Req + CM->>MM: MMSMS-REL-Req + MM-->>CM: MMSMS-REL-Req + CM-->>SM-RL: MN SMS-REL-Req +``` + +Sequence diagram for Mobile Originated Messaging on CM-sublayer. It shows interactions between SM-RL, CM, and MM layers on both the Mobile Station Side and the Network Side. The process involves MN SMS EST-Req, MMSMS EST-Req, CP-DATA, CP-ACK, MN SMS EST-Ind, MN SMS DATA-Req, MN SMS DATA-Ind, and MN SMS REL-Req messages. + +**Arrow diagram A1** + +## **Mobile Terminated Messaging on CM-sublayer** + +![Sequence diagram showing Mobile Station Side and Network Side interactions with lifelines SM-RL, CM, and MM.](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +The diagram illustrates a sequence of interactions between the Mobile Station Side and the Network Side. The Mobile Station Side has three lifelines: SM-RL, CM, and MM. The Network Side also has three lifelines: MM, CM, and SM-RL. The sequence of messages is as follows: + +- Network Side (SM-RL) to Network Side (CM):** MN SMS-EST-Req (RP-DATA) +- Network Side (CM) to Network Side (MM):** MM SMS-EST-Req +- Network Side (MM) to Network Side (CM):** MM SMS-EST-Conf +- Network Side (CM) to Mobile Station Side (CM):** MM SMS-EST-Ind +- Network Side (CM) to Mobile Station Side (SM-RL):** MN SMS-EST-Ind (RP-DATA) +- Network Side (CM) to Network Side (MM):** CP-DATA +- Network Side (MM) to Network Side (CM):** CP-ACK +- Mobile Station Side (SM-RL) to Mobile Station Side (CM):** MN SMS-DATA-Req (RP-ACK) +- Network Side (CM) to Network Side (MM):** CP-DATA +- Network Side (MM) to Network Side (CM):** CP-ACK +- Network Side (CM) to Network Side (SM-RL):** MN SMS-DATA-Ind (RP-ACK) +- Mobile Station Side (SM-RL) to Mobile Station Side (CM):** MN SMS-REL-Req +- Mobile Station Side (CM) to Mobile Station Side (MM):** MM SMS-REL-Req +- Network Side (SM-RL) to Network Side (CM):** MN SMS-REL-Req +- Network Side (CM) to Network Side (MM):** MM SMS-REL-Req + +Sequence diagram showing Mobile Station Side and Network Side interactions with lifelines SM-RL, CM, and MM. + +Arrow diagram A2 + +### **GPRS Mobile Originated Messaging on CM-sublayer in A/Gb mode** + +![Sequence diagram for GPRS Mobile Originated Messaging on CM-sublayer in A/Gb mode. It shows the interaction between Mobile Station Side (SM-RL, CM, LLC) and Network Side (LLC, CM, SM-RL).](08f6ace0c83e7394657fa372b47aec04_img.jpg) + +The diagram illustrates the sequence of messages for GPRS Mobile Originated Messaging on the CM-sublayer in A/Gb mode. It is divided into two main sections: Mobile Station Side and Network Side. + +**Mobile Station Side:** Contains lifelines for SM-RL, CM, and LLC. The sequence starts with an **MNSMS-EST-Req (RP-DATA)** from SM-RL to CM. CM then sends an **LL-UNITDATA - Req (TLLI, CP DATA)** to LLC. LLC responds with **LLC-UI (CP DATA)** to CM. CM receives **LL-UNITDATA - Ind (TLLI, CP ACK)** from LLC and sends **MNSMS-DATA-Ind (RP-ACK)** to SM-RL. SM-RL then sends **MNSMS-REL-req** to CM. CM sends **LL-UNITDATA - Req (TLLI, CP ACK)** to LLC, which responds with **LLC-UI (CP ACK)** to CM. CM receives **LL-UNITDATA - Ind (TLLI, CP DATA)** from LLC. + +**Network Side:** Contains lifelines for LLC, CM, and SM-RL. LLC receives **LL-UNITDATA - Ind (TLLI, CP DATA)** from the Mobile Station Side's LLC and sends **MNSMS-EST-Ind (RP-DATA)** to SM-RL. SM-RL sends **LL-UNITDATA - Req (TLLI, CP ACK)** to CM, which responds with **LLC-UI (CP ACK)** to LLC. LLC receives **LL-UNITDATA - Req (TLLI, CP DATA)** from CM and sends **MNSMS-DATA-Req (RP-ACK)** to SM-RL. SM-RL sends **LL-UNITDATA - Ind (TLLI, CP ACK)** to CM, which responds with **LLC-UI (CP DATA)** to LLC. LLC receives **LL-UNITDATA - Ind (TLLI, CP ACK)** from CM and sends **MNSMS-REL-req** to SM-RL. + +Sequence diagram for GPRS Mobile Originated Messaging on CM-sublayer in A/Gb mode. It shows the interaction between Mobile Station Side (SM-RL, CM, LLC) and Network Side (LLC, CM, SM-RL). + +Arrow diagram A5 + +### **GPRS Mobile Terminated Messaging on CM-sublayer in A/Gb mode** + +![Sequence diagram for GPRS Mobile Terminated Messaging on CM-sublayer in A/Gb mode. It shows interactions between SM-RL, CM, and LLC layers on both Mobile Station Side and Network Side.](fb4274c4b7882a4059103f1dbca9b111_img.jpg) + +The diagram illustrates the sequence of messages for GPRS Mobile Terminated Messaging on the CM-sublayer in A/Gb mode. It is divided into two main sections: Mobile Station Side and Network Side, each with three protocol layers: SM-RL, CM, and LLC. + +**Sequence of Messages:** + +- Network Side:** SM-RL sends **MNSMS-EST- Req (RP DATA)** to CM. +- CM (Network Side) to LLC (Network Side):** **LL-UNITDATA - Req (TLLI, CP DATA)** +- LLC (Network Side) to LLC (Mobile Station Side):** **LLC-UI (CP DATA)** +- LLC (Mobile Station Side) to CM (Mobile Station Side):** **LL-UNITDATA - Ind (TLLI, CP DATA)** +- CM (Mobile Station Side) to SM-RL (Mobile Station Side):** **MNSMS-EST- Ind (RP DATA)** +- SM-RL (Mobile Station Side) to CM (Mobile Station Side):** **LL-UNITDATA - Req (TLLI, CP ACK)** +- CM (Mobile Station Side) to LLC (Mobile Station Side):** **LLC-UI (CP ACK)** +- LLC (Mobile Station Side) to LLC (Network Side):** **LL-UNITDATA - Ind (TLLI, CP ACK)** +- LLC (Network Side) to CM (Network Side):** **LL-UNITDATA - Req (TLLI, CP DATA)** +- CM (Network Side) to SM-RL (Network Side):** **MNSMS-DATA- Ind (RP ACK)** +- SM-RL (Mobile Station Side) to CM (Mobile Station Side):** **MNSMS-DATA- Req (RP ACK)** +- CM (Mobile Station Side) to LLC (Mobile Station Side):** **LL-UNITDATA - Req (TLLI, CP DATA)** +- LLC (Mobile Station Side) to LLC (Network Side):** **LLC-UI (CP DATA)** +- LLC (Network Side) to CM (Network Side):** **LL-UNITDATA - Ind (TLLI, CP DATA)** +- LLC (Network Side) to CM (Network Side):** **LL-UNITDATA - Req (TLLI, CP ACK)** +- CM (Network Side) to SM-RL (Network Side):** **MNSMS-REL-req** +- LLC (Network Side) to LLC (Mobile Station Side):** **LLC-UI (CP ACK)** +- LLC (Mobile Station Side) to CM (Mobile Station Side):** **LL-UNITDATA - Ind (TLLI, CP ACK)** +- CM (Mobile Station Side) to SM-RL (Mobile Station Side):** **MNSMS-REL-req** + +Sequence diagram for GPRS Mobile Terminated Messaging on CM-sublayer in A/Gb mode. It shows interactions between SM-RL, CM, and LLC layers on both Mobile Station Side and Network Side. + +**Arrow diagram A6** + +### GPRS Mobile Originated Messaging on CM-sublayer in lu mode + +![Sequence diagram showing GPRS Mobile Originated Messaging on CM-sublayer in lu mode. The diagram is divided into Mobile Station Side (SM-RL, CM, GMM) and Network Side (GMM, CM, SM-RL). It details the interaction for message establishment, data transfer, and release.](bccc028d0e75bc30c41528056f581545_img.jpg) + +``` + +sequenceDiagram + participant SM-RL as SM-RL + participant CM as CM + participant GMM as GMM + Note right of GMM: Service Request Procedure* + Note left of GMM: Service Request Procedure may not be initiated + + Note over Mobile Station Side: Mobile Station Side + Note over Network Side: Network Side + + SM-RL->>CM: MNSMS-EST-Req(RP DATA) + CM->>GMM: PMMSMS-Est-Req + GMM->>GMM: Service Request Procedure* + GMM->>CM: PMMSMS-Est-Cnf + CM->>GMM: PMMSMS-UNITDATA-Req (CP-DATA) + GMM->>GMM: CP-DATA + GMM->>CM: PMMSMS-UNITDATA-Ind (CP-DATA) + CM->>SM-RL: MNSMS-EST-Ind (RP DATA) + CM->>GMM: PMMSMS-UNITDATA-Req (CP-ACK) + GMM->>GMM: CP ACK + GMM->>CM: PMMSMS-UNITDATA-Ind (CP-ACK) + CM->>SM-RL: MNSMS-DATA-Ind (RP ACK) + CM->>GMM: PMMSMS-UNITDATA-Req (CP-DATA) + GMM->>GMM: CP DATA + GMM->>CM: PMMSMS-UNITDATA-Ind (CP-DATA) + SM-RL->>CM: MNSMS-REL-req + CM->>GMM: PMMSMS-UNITDATA-Req (CP-ACK) + GMM->>GMM: CP ACK + GMM->>CM: PMMSMS-UNITDATA-Ind (CP-ACK) + CM->>SM-RL: MNSMS-REL-req + CM->>GMM: PMMSMS-REL-Req + +``` + +Sequence diagram showing GPRS Mobile Originated Messaging on CM-sublayer in lu mode. The diagram is divided into Mobile Station Side (SM-RL, CM, GMM) and Network Side (GMM, CM, SM-RL). It details the interaction for message establishment, data transfer, and release. + +NOTE: Service Request Procedure may not be initiated + +Arrow diagram A7 + +### GPRS Mobile Terminated Messaging on CM-sublayer in Iu mode + +![Sequence diagram for GPRS Mobile Terminated Messaging on CM-sublayer in Iu mode. The diagram shows interactions between SM-RL, CM, and GMM on both the Mobile Station Side and the Network Side. The sequence includes messages like PMMSMS-UNITDATA-Req, PMMSMS-UNITDATA-Ind, CP-DATA, CP-ACK, CP DATA, CP ACK, MNSMS-EST-Req, MNSMS-EST-Ind, MNSMS-DATA-Ind, and MNSMS-REL-req.](195611c20b2dc7ed0fa3033392e22908_img.jpg) + +``` +sequenceDiagram + participant SM-RL as SM-RL + participant CM as CM + participant GMM as GMM + Note left of SM-RL: Mobile Station Side + Note right of SM-RL: Network Side + SM-RL->>CM: MNSMS-REL-req + CM->>GMM: PMMSMS-UNITDATA-Req (CP-ACK) + GMM->>CM: CP ACK + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-ACK) + GMM->>CM: CP DATA + CM->>GMM: PMMSMS-UNITDATA-Req (CP-DATA) + GMM->>CM: CP DATA + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-DATA) + GMM->>CM: CP ACK + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-ACK) + GMM->>CM: CP ACK + SM-RL->>CM: MNSMS-EST-Ind (RP DATA) + CM->>GMM: PMMSMS-UNITDATA-Req (CP-DATA) + GMM->>CM: CP DATA + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-DATA) + GMM->>CM: CP ACK + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-ACK) + GMM->>CM: CP ACK + SM-RL->>CM: MNSMS-DATA-Ind (RP ACK) + CM->>GMM: PMMSMS-UNITDATA-Req (CP-ACK) + GMM->>CM: CP ACK + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-ACK) + GMM->>CM: CP ACK + Note right of SM-RL: Network Side + SM-RL->>CM: MNSMS-EST-Req(RP DATA) + CM->>GMM: PMMSMS-UNITDATA-Req (CP-DATA) + GMM->>CM: CP DATA + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-DATA) + GMM->>CM: CP ACK + CM->>GMM: PMMSMS-UNITDATA-Req (CP-ACK) + GMM->>CM: CP ACK + SM-RL->>CM: MNSMS-DATA-Ind (RP ACK) + CM->>GMM: PMMSMS-UNITDATA-Req (CP-DATA) + GMM->>CM: CP DATA + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-DATA) + GMM->>CM: CP ACK + CM->>GMM: PMMSMS-UNITDATA-Ind (CP-ACK) + GMM->>CM: CP ACK + SM-RL->>CM: MNSMS-REL-req + CM->>GMM: PMMSMS-REL-Req +``` + +Sequence diagram for GPRS Mobile Terminated Messaging on CM-sublayer in Iu mode. The diagram shows interactions between SM-RL, CM, and GMM on both the Mobile Station Side and the Network Side. The sequence includes messages like PMMSMS-UNITDATA-Req, PMMSMS-UNITDATA-Ind, CP-DATA, CP-ACK, CP DATA, CP ACK, MNSMS-EST-Req, MNSMS-EST-Ind, MNSMS-DATA-Ind, and MNSMS-REL-req. + +Arrow diagram A8 + +### **LTE Mobile Originated Messaging on CM-sublayer in S1 mode if packet-switched service is used** + +![Sequence diagram showing LTE Mobile Originated Messaging on CM-sublayer in S1 mode. Lifelines: SM-RL, CM, EMM for UE and SM-RL, CM, EMM for MME. The diagram shows the flow of messages for SMS establishment, data transfer, and release.](fe7304192caf64cda93b580c5e7e5c06_img.jpg) + +``` +sequenceDiagram + participant SM-RL_UE as SM-RL + participant CM_UE as CM + participant EMM_UE as EMM + participant EMM_MME as EMM + participant CM_MME as CM + participant SM-RL_MME as SM-RL + + Note right of SM-RL_UE: Service Request Procedure* + + SM-RL_UE->>CM_UE: MNSMS-EST-Req(RP DATA) + CM_UE->>EMM_UE: EMMSMS-Est -Req + EMM_UE->>EMM_MME: Service Request Procedure* + EMM_MME->>EMM_UE: EMMSMS-Est -Cnf + CM_UE->>EMM_UE: EMMSMS-UNITDATA-Req (CP-DATA) + EMM_UE->>EMM_MME: CP-DATA + EMM_MME->>CM_MME: EMMSMS-UNITDATA-Ind (CP-DATA) + CM_MME->>SM-RL_MME: MNSMS-EST-Ind (RP DATA) + SM-RL_MME->>CM_MME: EMMSMS-UNITDATA-Req (CP-ACK) + CM_MME->>EMM_MME: CP ACK + EMM_MME->>EMM_UE: EMMSMS-UNITDATA-Ind (CP-ACK) + CM_UE->>SM-RL_UE: MNSMS-DATA-Ind (RP ACK) + SM-RL_MME->>CM_MME: MNSMS-DATA-Req (RP ACK) + CM_MME->>EMM_MME: EMMSMS-UNITDATA-Req (CP-DATA) + EMM_MME->>EMM_UE: CP DATA + CM_UE->>SM-RL_UE: EMMSMS-UNITDATA-Ind (CP-DATA) + CM_UE->>EMM_UE: EMMSMS-UNITDATA-Req (CP-ACK) + EMM_UE->>EMM_MME: CP ACK + EMM_MME->>CM_MME: EMMSMS-UNITDATA-Ind (CP-ACK) + SM-RL_UE->>CM_UE: MNSMS-REL-req + CM_MME->>SM-RL_MME: MNSMS-REL-req + SM-RL_MME->>EMM_MME: EMMSMS-REL-Req +``` + +Sequence diagram showing LTE Mobile Originated Messaging on CM-sublayer in S1 mode. Lifelines: SM-RL, CM, EMM for UE and SM-RL, CM, EMM for MME. The diagram shows the flow of messages for SMS establishment, data transfer, and release. + +NOTE: Service Request Procedure may not be initiated if RRC connection already exists + +**Arrow diagram A9** + +### **LTE Mobile Originated Messaging on CM-sublayer in S1 mode if packet-switched service is used and the UE is using EPS services with control plane CIoT EPS optimization** + +![Sequence diagram showing LTE Mobile Originated Messaging between UE and MME. Lifelines: SM-RL, CM, EMM on both sides. The process involves MN SMS EST-Req, Service Request Procedure, EMMSMS-UNITDATA messages, and MN SMS REL-req.](c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg) + +``` +sequenceDiagram + participant SM-RL_UE as SM-RL + participant CM_UE as CM + participant EMM_UE as EMM + participant EMM_MME as EMM + participant CM_MME as CM + participant SM-RL_MME as SM-RL + + Note left of SM-RL_UE: MN SMS EST-Req (RP DATA) + SM-RL_UE->>CM_UE: MN SMS EST-Req (RP DATA) + CM_UE->>EMM_UE: EMMSMS-UNITDATA-Req (CP-DATA) + EMM_UE->>EMM_MME: Service Request Procedure* (Control Plane Service Req) (CP-DATA) + EMM_MME->>CM_MME: EMMSMS-UNITDATA-Ind (CP-DATA) + CM_MME->>SM-RL_MME: MN SMS-EST-Ind (RP DATA) + SM-RL_MME->>CM_MME: MN SMS-DATA-Req (RP ACK) + CM_MME->>EMM_MME: EMMSMS-UNITDATA-Req (CP-ACK) + EMM_MME->>EMM_UE: CP ACK + EMM_UE->>CM_UE: EMMSMS-UNITDATA-Ind (CP-ACK) + CM_UE->>SM-RL_UE: MN SMS-DATA-Ind (RP ACK) + SM-RL_UE->>CM_UE: MN SMS-REL-req + CM_UE->>EMM_UE: EMMSMS-UNITDATA-Req (CP-ACK) + EMM_UE->>EMM_MME: CP ACK + EMM_MME->>CM_MME: EMMSMS-UNITDATA-Ind (CP-ACK) + CM_MME->>SM-RL_MME: MN SMS-REL-req + SM-RL_MME->>EMM_MME: EMMSMS-REL-Req +``` + +Sequence diagram showing LTE Mobile Originated Messaging between UE and MME. Lifelines: SM-RL, CM, EMM on both sides. The process involves MN SMS EST-Req, Service Request Procedure, EMMSMS-UNITDATA messages, and MN SMS REL-req. + +NOTE: Service Request Procedure may not be initiated if RRC connection already exists + +**Arrow diagram A9a** + +### **LTE Mobile Terminated Messaging on CM-sublayer in S1 mode if packet-switched service is used** + +![Sequence diagram showing LTE Mobile Terminated Messaging on CM-sublayer in S1 mode. Lifelines: SM-RL, CM, EMM for UE; EMM, CM, SM-RL for MME. The diagram illustrates the exchange of messages for SMS establishment, data transfer, and release between the UE and MME.](0a06de972d61ab9bb901bd74dd4ff51f_img.jpg) + +``` +sequenceDiagram + participant SM-RL_UE as SM-RL + participant CM_UE as CM + participant EMM_UE as EMM + participant EMM_MME as EMM + participant CM_MME as CM + participant SM-RL_MME as SM-RL + + Note right of SM-RL_MME: MNSMS-EST-Req(RP DATA) + SM-RL_MME->>CM_MME: MNSMS-EST-Req(RP DATA) + CM_MME->>EMM_MME: EMMSMS-UNITDATA-Req (CP-DATA) + EMM_MME->>EMM_UE: CP-DATA + EMM_UE->>CM_UE: EMMSMS-UNITDATA-Ind (CP-DATA) + CM_UE->>SM-RL_UE: MNSMS-EST-Ind (RP DATA) + CM_UE->>EMM_UE: EMMSMS-UNITDATA-Req (CP-ACK) + EMM_UE->>EMM_MME: CP ACK + EMM_MME->>CM_MME: EMMSMS-UNITDATA-Ind (CP-ACK) + CM_MME->>SM-RL_MME: MNSMS-DATA-Ind (RP ACK) + SM-RL_MME->>CM_MME: MNSMS-REL-req + CM_MME->>EMM_MME: EMMSMS-REL-Req + EMM_MME->>EMM_UE: CP ACK + EMM_UE->>CM_UE: EMMSMS-UNITDATA-Ind (CP-ACK) + CM_UE->>SM-RL_UE: MNSMS-REL-req +``` + +The diagram illustrates the sequence of messages for LTE Mobile Terminated Messaging on the CM-sublayer in S1 mode. It involves two main entities: the User Equipment (UE) and the Mobility Management Entity (MME). The UE has three protocol layers: SM-RL, CM, and EMM. The MME also has three protocol layers: EMM, CM, and SM-RL. The sequence of messages is as follows: 1. The SM-RL layer in the MME sends an MNSMS-EST-Req(RP DATA) message to the CM layer. 2. The CM layer in the MME sends an EMMSMS-UNITDATA-Req (CP-DATA) message to the EMM layer. 3. The EMM layer in the MME sends a CP-DATA message to the EMM layer in the UE. 4. The EMM layer in the UE sends an EMMSMS-UNITDATA-Ind (CP-DATA) message to the CM layer. 5. The CM layer in the UE sends an MNSMS-EST-Ind (RP DATA) message to the SM-RL layer. 6. The CM layer in the UE sends an EMMSMS-UNITDATA-Req (CP-ACK) message to the EMM layer. 7. The EMM layer in the UE sends a CP ACK message to the EMM layer in the MME. 8. The EMM layer in the MME sends an EMMSMS-UNITDATA-Ind (CP-ACK) message to the CM layer. 9. The CM layer in the MME sends an MNSMS-DATA-Ind (RP ACK) message to the SM-RL layer. 10. The SM-RL layer in the MME sends an MNSMS-REL-req message to the CM layer. 11. The CM layer in the MME sends an EMMSMS-REL-Req message to the EMM layer. 12. The EMM layer in the MME sends a CP ACK message to the EMM layer in the UE. 13. The EMM layer in the UE sends an EMMSMS-UNITDATA-Ind (CP-ACK) message to the CM layer. 14. The CM layer in the UE sends an MNSMS-REL-req message to the SM-RL layer. + +Sequence diagram showing LTE Mobile Terminated Messaging on CM-sublayer in S1 mode. Lifelines: SM-RL, CM, EMM for UE; EMM, CM, SM-RL for MME. The diagram illustrates the exchange of messages for SMS establishment, data transfer, and release between the UE and MME. + +Arrow diagram A10 + +# Annex B (normative): SDL-description of the CM-layer + +## B.1 Introduction + +This annex contains an SDL-description of the Connection Management Sublayer in terms of the Short Message Service Support. The CM- sublayer provides services to Short Message Relay Layer. + +The SDLs contain a mixture of peer to peer messages and conceptual primitives between the layers SM-RL, CM, MM and LLC, as viewed by the SMC entities. SDL-1/2/3 show the CS SMC entity on MS-side for Mobile Originated (MO) short message transfer, SDL-4/5/6 show the CS SMC entity on MS-side for Mobile Terminated (MT) short message transfer, SDL-7/8/9 show the CS SMC entity on the network side for Mobile Originated (MO) short message transfer, and SDL-10/11/12 show the CS SMC entity on the network side for Mobile Terminated (MT) short message transfer. + +SDL-13/14/15 show the GPRS SMC entity on MS-side for Mobile Originated (MO) short message transfer, SDL-16/17/18 show the GPRS SMC entity on MS-side for Mobile Terminated (MT) short message transfer, SDL-19/20/21 show the GPRS SMC entity on the network side for Mobile Originated (MO) short message transfer, and SDL-22/23/24 show the GPRS SMC entity on the network side for Mobile Terminated (MT) short message transfer. + +SDL-25/26/27 show the EPS SMC entity on network side for Mobile Originated (MO) short message transfer, SDL-28/29/30 show the EPS SMC entity on network side for Mobile Terminated (MT) short message transfer, SDL-31/32/33 show the EPS SMC entity on the MS-side for Mobile Originated (MO) short message transfer, and SDL-34/35/36 show the EPS SMC entity on the MS-side for Mobile Terminated (MT) short message transfer. + +SDL-37/38/39 show the 5GS SMC entity on network side for Mobile Originated (MO) short message transfer, SDL-40/41/42 show the 5GS SMC entity on network side for Mobile Terminated (MT) short message transfer, SDL-43/44/45 show the 5GS SMC entity on the MS-side for Mobile Originated (MO) short message transfer, and SDL-46/47/48 show the 5GS SMC entity on the MS-side for Mobile Terminated (MT) short message transfer. + +The lower layers (below MM, GMM, EMM and LLC) are transparent to an SMC entity. + +![State transition diagram for MO-SMC-CP-entity on MS-side. It starts at state 0 (MO-IDLE), transitions through MN SMS EST-Req (RPDU) and MMSM EST-Req to state 1 (MO-MM-Connection Pending). From state 1, it can transition to MMSM EST-Conf, MMSM REL-Ind, or MN SMS ABORT-Req. MMSM EST-Conf leads to CP-DATA, SET TC1M, and state 2 (MO-Wait for CP-ACK). MMSM REL-Ind and MN SMS ABORT-Req both lead to MN SMS ERROR-Ind, which then leads back to state 0 (MO-IDLE).](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-IDLE : 0 + MO-IDLE --> MNSMS-EST-Req : RPDU + MNSMS-EST-Req --> MMSM-EST-Req + MMSM-EST-Req --> MO-MM-Connection-Pending : 1 + MO-MM-Connection-Pending --> MMSM-EST-Conf + MO-MM-Connection-Pending --> MMSM-REL-Ind + MO-MM-Connection-Pending --> MNSMS-ABORT-Req + MMSM-EST-Conf --> CP-DATA + CP-DATA --> SET-TC1M + SET-TC1M --> MO-Wait-for-CP-ACK : 2 + MMSM-REL-Ind --> MNSMS-ERROR-Ind + MNSMS-ABORT-Req --> MMSM-REL-Req + MMSM-REL-Req --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> MO-IDLE : 0 +``` + +State transition diagram for MO-SMC-CP-entity on MS-side. It starts at state 0 (MO-IDLE), transitions through MN SMS EST-Req (RPDU) and MMSM EST-Req to state 1 (MO-MM-Connection Pending). From state 1, it can transition to MMSM EST-Conf, MMSM REL-Ind, or MN SMS ABORT-Req. MMSM EST-Conf leads to CP-DATA, SET TC1M, and state 2 (MO-Wait for CP-ACK). MMSM REL-Ind and MN SMS ABORT-Req both lead to MN SMS ERROR-Ind, which then leads back to state 0 (MO-IDLE). + +MO-SMC-CP-entity on MS-side +SDL-1 + +![SDL diagram for MO-SMC-CP-entity on MS-side, showing transitions from state 2 (MO-Wait for CP-ACK) to state 3 (MO-MM-Connection Established) or state 0 (MO-IDLE) based on various inputs like CP-DATA, CP-ACK, and timers.](b34c69e1ec326b01c3a485b27b1df5f6_img.jpg) + +``` + + graph TD + State2([2 MO-Wait for CP-ACK]) + State2 --> CP_DATA[/CP-DATA/] + State2 --> CP_ACK[/CP-ACK/] + State2 --> MMSM_ERR_IND[/MMSM-ERROR-Ind/] + State2 --> CP_ERR_IN[/CP-ERROR/] + State2 --> TC1M[/TC1M/] + State2 --> MNSMS_REL_REQ[/MNSMS-REL-Req/] + State2 --> MNSMS_ABORT_REQ[/MNSMS-ABORT-Req/] + + CP_DATA --> CP_DATA_SUP{CP-DATA Supported in this state} + CP_DATA_SUP -- No --> State2 + CP_DATA_SUP -- Yes --> RESET_TC1M_1[RESET TC1M] + RESET_TC1M_1 --> SET_RETX_0_1[Set retx = zero] + SET_RETX_0_1 --> MNSMS_DATA_IND[/MNSMS DATA-Ind RPDU/] + MNSMS_DATA_IND --> CP_ACK_OUT[/CP-ACK/] + CP_ACK_OUT --> State3 + + CP_ACK --> RESET_TC1M_2[RESET TC1M] + RESET_TC1M_2 --> SET_RETX_0_2[Set retx = zero] + SET_RETX_0_2 --> State3([3 MO-MM-Connection Established]) + + MMSM_ERR_IND --> RESET_TC1M_3[RESET TC1M] + RESET_TC1M_3 --> MNSMS_ERR_IND_OUT[/MNSMS-ERROR-Ind/] + + CP_ERR_IN --> MMSM_REL_REQ_OUT1[/MMSM-REL-Req/] + MMSM_REL_REQ_OUT1 --> MNSMS_ERR_IND_OUT + + TC1M --> RETX_MAX{retx = maximum?} + RETX_MAX -- No --> RETX_INC[retx = retx + 1] + RETX_INC --> CONN1((1)) + CONN1 --> State2 + RETX_MAX -- Yes --> MMSM_REL_REQ_OUT2[/MMSM-REL-Req/] + MMSM_REL_REQ_OUT2 --> MNSMS_ERR_IND_OUT + + MNSMS_REL_REQ --> Note[Note] + Note --> MNSMS_ERR_IND_OUT + + MNSMS_ABORT_REQ --> CP_ERR_OUT[/CP-ERROR/] + CP_ERR_OUT --> RESET_TC1M_4[RESET TC1M] + RESET_TC1M_4 --> MMSM_REL_REQ_OUT3[/MMSM-REL-Req/] + MMSM_REL_REQ_OUT3 --> MNSMS_ERR_IND_OUT + + MNSMS_ERR_IND_OUT --> SET_RETX_0_3[Set retx = zero] + SET_RETX_0_3 --> State0([0 MO-IDLE]) + +``` + +SDL diagram for MO-SMC-CP-entity on MS-side, showing transitions from state 2 (MO-Wait for CP-ACK) to state 3 (MO-MM-Connection Established) or state 0 (MO-IDLE) based on various inputs like CP-DATA, CP-ACK, and timers. + +NOTE: The release is delayed until the next state + +MO-SMC-CP-entity on MS-side +SDL-2 + +![State transition diagram for MO-SMC-CP-entity on MS-side. It shows transitions between states like MO-MM-Connection Established, MO-IDLE, and CP-DATA based on events like MMSM-REL-Ind, CP-DATA, MNSMS-REL-Req, and MNSMS-ABORT-Req.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +The diagram illustrates the state transitions for the MO-SMC-CP-entity on the MS-side. It starts in the **MO-MM-Connection Established** state (state 3). From this state, four transitions are possible: + +- MMSM-REL-Ind** leads to **MNSMS-ERROR-Ind**, which then leads to the **MO-IDLE** state (state 0). +- CP-DATA** leads to **MNSMS-DATA-Ind (RPDU)**. From here, a note indicates: "If another MO SMS is pending, the CM SERVICE REQUEST is sent at this time." The transition then leads to **CP-ACK**, which returns to the **MO-MM-Connection Established** state (state 3). +- MNSMS-REL-Req** leads to **MMSM-REL-Req**, which then leads to the **MO-IDLE** state (state 0). +- MNSMS-ABORT-Req** leads to **CP-ERROR**, which then leads to **MMSM-REL-Req**, which finally leads to the **MO-IDLE** state (state 0). + +State transition diagram for MO-SMC-CP-entity on MS-side. It shows transitions between states like MO-MM-Connection Established, MO-IDLE, and CP-DATA based on events like MMSM-REL-Ind, CP-DATA, MNSMS-REL-Req, and MNSMS-ABORT-Req. + +**MO-SMC-CP-entity on MS-side** +**SDL-3** + +![State transition diagram for MO-SMC-CP-entity on MS-side. It shows four states: 0 MO-IDLE, 1 MO-MM-Connection Pending, 2 MO-Wait for CP-ACK, and 3 MO-MM-Connection Established. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, and 3 to 0. State 2 has a self-loop, and state 3 has a self-loop.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 : MO-IDLE + 0 --> 1 : MO-MM-Connection Pending + 1 --> 0 + 1 --> 2 : MO-Wait for CP-ACK + 2 --> 0 + 2 --> 3 : MO-MM-Connection Established + 3 --> 0 + 2 --> 2 + 3 --> 3 +``` + +State transition diagram for MO-SMC-CP-entity on MS-side. It shows four states: 0 MO-IDLE, 1 MO-MM-Connection Pending, 2 MO-Wait for CP-ACK, and 3 MO-MM-Connection Established. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, and 3 to 0. State 2 has a self-loop, and state 3 has a self-loop. + +**MO-SMC-CP-entity on MS-side +State transition diagram** + +![State transition diagram for MT-SMC-CP-entity on MS-side. It starts at MT-IDLE (0), goes to MMSM-EST-Ind (CP-DATA), then to a decision 'CP-Data Accepted?'. If 'Yes', it goes to MNSMS-EST-Ind (RPDU), then CP-ACK, then MT-MM-Connection Established (3). If 'No', it goes to CP-ERROR, then MMSM-REL-Req, then MT-IDLE (0). A separate path starts at connector 1, goes to CP-DATA, then SET TC1M, then MT-Wait for CP-ACK (2).](fd3cbb53e991f8209ba17b398f426e13_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT_IDLE_0 : 0 + MT_IDLE_0 --> MMSM_EST_Ind_CP_DATA : MMSM-EST-Ind (CP-DATA) + MMSM_EST_Ind_CP_DATA --> CP_Data_Accepted{CP-Data Accepted?} + CP_Data_Accepted -- Yes --> MNSMS_EST_Ind_RPDU : MNSMS-EST-Ind (RPDU) + MNSMS_EST_Ind_RPDU --> CP_ACK : CP-ACK + CP_ACK --> MT_MM_Connection_Established : 3 + CP_Data_Accepted -- No --> CP_ERROR : CP-ERROR + CP_ERROR --> MMSM_REL_Req : MMSM-REL-Req + MMSM_REL_Req --> MT_IDLE_0_2 : 0 + [*] --> Connector_1 : 1 + Connector_1 --> CP_DATA : CP-DATA + CP_DATA --> SET_TC1M : SET TC1M + SET_TC1M --> MT_Wait_CP_ACK : 2 +``` + +State transition diagram for MT-SMC-CP-entity on MS-side. It starts at MT-IDLE (0), goes to MMSM-EST-Ind (CP-DATA), then to a decision 'CP-Data Accepted?'. If 'Yes', it goes to MNSMS-EST-Ind (RPDU), then CP-ACK, then MT-MM-Connection Established (3). If 'No', it goes to CP-ERROR, then MMSM-REL-Req, then MT-IDLE (0). A separate path starts at connector 1, goes to CP-DATA, then SET TC1M, then MT-Wait for CP-ACK (2). + +**MT-SMC-CP-entity on MS-side +Initiating message transfer +SDL-4** + +![SDL diagram for MT-SMC-CP-entity on MS-side showing transitions from state 2 (MT-Wait for CP-ACK) to state 3 (MT-MM-Connection Established) or state 0 (MT-IDLE).](575d7d345b3ec04393bb2ec720ebabca_img.jpg) + +``` + +stateDiagram-v2 + state "2 MT-Wait for CP-ACK" as s2 + state "3 MT-MM-Connection Established" as s3 + state "0 MT-IDLE" as s0 + state "retx=maximum?" as d1 <> + + s2 --> CP_ACK : CP-ACK + CP_ACK --> RESET_TC1M_1 : RESET TC1M + RESET_TC1M_1 --> SET_RETX_ZERO_1 : Set retx = zero + SET_RETX_ZERO_1 --> s3 + + s2 --> MMSM_ERROR_Ind : MMSM-ERROR-Ind + MMSM_ERROR_Ind --> RESET_TC1M_2 : RESET TC1M + RESET_TC1M_2 --> MNSMS_ERROR_Ind + + s2 --> CP_ERROR_IN : CP-ERROR + CP_ERROR_IN --> MMSM_REL_Req_1 : MMSM-REL-Req + MMSM_REL_Req_1 --> RESET_TC1M_2 + + s2 --> TC1M : TC1M + TC1M --> d1 + d1 --> MMSM_REL_Req_2 : Yes + MMSM_REL_Req_2 --> MNSMS_ERROR_Ind + d1 --> RETX_INC : No + RETX_INC --> c1 : retx = retx + 1 + c1 --> MNSMS_ERROR_Ind + + s2 --> MNSMS_REL_Req : MNSMS-REL-Req (Note) + MNSMS_REL_Req --> MNSMS_ERROR_Ind + + s2 --> MNSMS_ABORT_Req : MNSMS-ABORT-Req + MNSMS_ABORT_Req --> CP_ERROR_OUT : CP-ERROR + CP_ERROR_OUT --> RESET_TC1M_3 : RESET TC1M + RESET_TC1M_3 --> MMSM_REL_Req_3 : MMSM-REL-Req + MMSM_REL_Req_3 --> MNSMS_ERROR_Ind + + MNSMS_ERROR_Ind --> SET_RETX_ZERO_2 : MNSMS-ERROR-Ind + SET_RETX_ZERO_2 --> s0 : Set retx = zero + +``` + +The diagram is a Specification and Description Language (SDL) flow for the MT-SMC-CP-entity on the MS-side. It starts at state 2, **MT-Wait for CP-ACK**. + - If **CP-ACK** is received: **RESET TC1M**, then **Set retx = zero**, and transition to state 3, **MT-MM-Connection Established**. + - If **MMSM-ERROR-Ind** is received: **RESET TC1M**, then **MNSMS-ERROR-Ind**, **Set retx = zero**, and transition to state 0, **MT-IDLE**. + - If **CP-ERROR** is received: **MMSM-REL-Req**, then **RESET TC1M**, **MNSMS-ERROR-Ind**, **Set retx = zero**, and transition to state 0. + - If timer **TC1M** expires: check if **retx=maximum?**. If Yes, **MMSM-REL-Req**, then **MNSMS-ERROR-Ind**, **Set retx = zero**, and transition to state 0. If No, **retx = retx + 1**, then via connector 1 to **MNSMS-ERROR-Ind**, **Set retx = zero**, and transition to state 0. + - If **MNSMS-REL-Req** (with Note) is received: **MNSMS-ERROR-Ind**, **Set retx = zero**, and transition to state 0. + - If **MNSMS-ABORT-Req** is received: **CP-ERROR**, **RESET TC1M**, **MMSM-REL-Req**, then **MNSMS-ERROR-Ind**, **Set retx = zero**, and transition to state 0. + +SDL diagram for MT-SMC-CP-entity on MS-side showing transitions from state 2 (MT-Wait for CP-ACK) to state 3 (MT-MM-Connection Established) or state 0 (MT-IDLE). + +NOTE: The release is delayed until the next state + +**MT-SMC-CP-entity on MS-side** +**MM-connection established** +**SDL-5** + +![State transition diagram for MT-SMC-CP-entity on MS-side. It starts at state 3 (MT-MM-Connection Established) and branches into four paths based on MMREL-Ind, MNSMS-REL-Req, MNSMS-ABORT-Req, and MNSMS-DATA-Req (RPDU). The first path leads to MNSMS-ERROR-Ind and then to state 0 (MT-IDLE). The second path leads to MMREL-Req and then to state 0 (MT-IDLE). The third path leads to CP-ERROR and then to MMREL-Req. The fourth path leads to CP-DATA, SET TC1M, and then to state 2 (MT-Wait for CP-ACK).](61a7f401eb46fe99a71f27bc37493f04_img.jpg) + +``` +stateDiagram-v2 + [*] --> 3: MT-MM-Connection Established + 3 --> MMREL-Ind + 3 --> MNSMS-REL-Req + 3 --> MNSMS-ABORT-Req + 3 --> MNSMS-DATA-Req_RPDU: MNSMS-DATA-Req (RPDU) + MMREL-Ind --> MNSMS-ERROR-Ind + MNSMS-REL-Req --> MMREL-Req + MNSMS-ABORT-Req --> CP-ERROR + MNSMS-DATA-Req_RPDU --> CP-DATA + MNSMS-ERROR-Ind --> 0: MT-IDLE + CP-ERROR --> MMREL-Req + CP-DATA --> SET_TC1M: SET TC1M + SET_TC1M --> 2: MT-Wait for CP-ACK + MMREL-Req --> 0: MT-IDLE +``` + +State transition diagram for MT-SMC-CP-entity on MS-side. It starts at state 3 (MT-MM-Connection Established) and branches into four paths based on MMREL-Ind, MNSMS-REL-Req, MNSMS-ABORT-Req, and MNSMS-DATA-Req (RPDU). The first path leads to MNSMS-ERROR-Ind and then to state 0 (MT-IDLE). The second path leads to MMREL-Req and then to state 0 (MT-IDLE). The third path leads to CP-ERROR and then to MMREL-Req. The fourth path leads to CP-DATA, SET TC1M, and then to state 2 (MT-Wait for CP-ACK). + +**MT-SMC-CP-entity on MS-side +MM-connection released +SDL-6** + +![State transition diagram for MT-SMC-CP-entity on MS-side showing three states: 0 MT-IDLE, 2 MT-Wait for CP-ACK, and 3 MT-MM-Connection Established with various transitions between them.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMT-IDLE" as S0 + state "2\nMT-Wait\nfor\nCP-ACK" as S2 + state "3\nMT-MM-\nConnection\nEstablished" as S3 + + S0 --> S0 + S0 --> S2 + S0 --> S3 + S2 --> S0 + S2 --> S2 + S2 --> S3 + S3 --> S0 + S3 --> S2 + +``` + +State transition diagram for MT-SMC-CP-entity on MS-side showing three states: 0 MT-IDLE, 2 MT-Wait for CP-ACK, and 3 MT-MM-Connection Established with various transitions between them. + +**MT-SMC-CP-entity on MS-side +State transition diagram** + +![State transition diagram for MO-SMC-CP-entity on Network-side. It shows states MO-IDLE (0), MO-MM-Connection Established (3), and MO-Wait for CP-ACK (2). Transitions include MMSM-EST-Ind (CP-DATA), CP-Data Accepted?, MNSMS-EST-Ind (RPDU), CP-ACK, CP-ERROR, MMSM-REL-Req, CP-DATA, and SET TC1N.](5801c19431e76330430e92a598cc7a16_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-IDLE : 0 + MO-IDLE --> MMSM-EST-Ind : (CP-DATA) + MMSM-EST-Ind --> CP-Data-Accepted{CP-Data Accepted?} + CP-Data-Accepted -- No --> CP-ERROR + CP-Data-Accepted -- Yes --> MNSMS-EST-Ind : (RPDU) + MNSMS-EST-Ind --> CP-ACK + CP-ACK --> MO-MM-Connection-Established : 3 + CP-ERROR --> MMSM-REL-Req + MMSM-REL-Req --> MO-IDLE : 0 + MO-IDLE --> CP-DATA : 1 + CP-DATA --> SET-TC1N : SET TC1N + SET-TC1N --> MO-Wait-for-CP-ACK : 2 +``` + +State transition diagram for MO-SMC-CP-entity on Network-side. It shows states MO-IDLE (0), MO-MM-Connection Established (3), and MO-Wait for CP-ACK (2). Transitions include MMSM-EST-Ind (CP-DATA), CP-Data Accepted?, MNSMS-EST-Ind (RPDU), CP-ACK, CP-ERROR, MMSM-REL-Req, CP-DATA, and SET TC1N. + +MO-SMC-CP-entity on Network-side +SDL-7 + +![State transition diagram for MO-SMC-CP-entity on Network-side. It starts at state 2 (MO-Wait for CP-ACK) and transitions through various events like CP-ACK, MMSM-ERROR-Ind, CP-ERROR, TC1N, MNSMS-REL-Req, and MNSMS-ABORT-Req to reach state 0 (MO-IDLE).](db39acbd11df5eb7e79ab84562fb8f74_img.jpg) + +The diagram is a state transition graph for the MO-SMC-CP-entity on the Network-side. It begins at state 2, labeled 'MO-Wait for CP-ACK'. From this state, several transitions are possible: + +- CP-ACK**: Leads to 'RESET TC1N', then 'Set retx = zero', and finally to state 3, 'MO-MM-Connection Established'. +- MMSM-ERROR-Ind**: Leads to 'RESET TC1N', which then connects to the 'Set retx = zero' block before state 0. +- CP-ERROR**: Leads to 'MMSM-REL-Req', which then connects to the 'Set retx = zero' block before state 0. +- TC1N**: Leads to a decision 'retx = maximum?'. + - If **No**: Leads to 'retx = retx + 1', which then leads to connector 1. + - If **Yes**: Leads to 'MMSM-REL-Req', which then leads to 'MNSMS-ERROR-Ind', then 'Set retx = zero', and finally to state 0, 'MO-IDLE'. +- MNSMS-REL-Req**: A note indicates the release is delayed until the next state. This transition leads directly to the 'Set retx = zero' block before state 0. +- MNSMS-ABORT-Req**: Leads to a decision 'CP layer wishes to send CP-ERROR?'. + - If **Yes**: Leads to 'CP-ERROR', which then connects to the 'Set retx = zero' block before state 0. + - If **No**: Leads to 'RESET TC1N', then 'MMSM-REL-Req', which then leads to the 'Set retx = zero' block before state 0. + +Connector 1 leads to the 'Set retx = zero' block before state 0. + +State transition diagram for MO-SMC-CP-entity on Network-side. It starts at state 2 (MO-Wait for CP-ACK) and transitions through various events like CP-ACK, MMSM-ERROR-Ind, CP-ERROR, TC1N, MNSMS-REL-Req, and MNSMS-ABORT-Req to reach state 0 (MO-IDLE). + +NOTE: The release is delayed until the next state + +MO-SMC-CP-entity on Network-side +SDL-8 + +![State transition diagram for MO-MM entity. It starts at state 3 (MO-MM-Connection Established) and branches into four paths based on input messages: MNSMS-DATA-Req (RPDU), MMSM-ERROR-Ind, MNSMS-REL-Req, and MNSMS-ABORT-Req. The first path leads to CP-DATA, SET TC1N, and state 2 (MO-Wait for CP-ACK). The second path leads to MNSMS-ERROR-Ind and state 0 (MO-IDLE). The third path leads to MMSM-REL-Req and state 0 (MO-IDLE). The fourth path leads to a decision 'CP layer wishes to send CP-ERROR?'. If Yes, it goes to CP-ERROR and then to state 0 (MO-IDLE). If No, it goes to CP-DATA (with a Note), CP-ACK, and state 3 (MO-MM-Connection Established).](e2c120be98ede6deb60dd341f5a9803b_img.jpg) + +``` +stateDiagram-v2 + [*] --> s3 : 3 MO-MM-Connection Established + s3 --> MNSMS-DATA-Req : MNSMS-DATA-Req (RPDU) + s3 --> MMSM-ERROR-Ind : MMSM-ERROR-Ind + s3 --> MNSMS-REL-Req : MNSMS-REL-Req + s3 --> MNSMS-ABORT-Req : MNSMS-ABORT-Req + MNSMS-DATA-Req --> CP-DATA : CP-DATA + CP-DATA --> SET_TC1N : SET TC1N + SET_TC1N --> s2 : 2 MO-Wait for CP-ACK + MMSM-ERROR-Ind --> MNSMS-ERROR-Ind : MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> s0 : 0 MO-IDLE + MNSMS-REL-Req --> MMSM-REL-Req : MMSM-REL-Req + MMSM-REL-Req --> s0 : 0 MO-IDLE + MNSMS-ABORT-Req --> CP_layer_wishes_to_send_CP_ERROR : CP layer wishes to send CP-ERROR? + CP_layer_wishes_to_send_CP_ERROR -- Yes --> CP_ERROR : CP-ERROR + CP_layer_wishes_to_send_CP_ERROR -- No --> CP_DATA_Note : CP-DATA Note + CP_ERROR --> s0 : 0 MO-IDLE + CP_DATA_Note --> CP_ACK : CP-ACK + CP_ACK --> s3 : 3 MO-MM-Connection Established +``` + +State transition diagram for MO-MM entity. It starts at state 3 (MO-MM-Connection Established) and branches into four paths based on input messages: MNSMS-DATA-Req (RPDU), MMSM-ERROR-Ind, MNSMS-REL-Req, and MNSMS-ABORT-Req. The first path leads to CP-DATA, SET TC1N, and state 2 (MO-Wait for CP-ACK). The second path leads to MNSMS-ERROR-Ind and state 0 (MO-IDLE). The third path leads to MMSM-REL-Req and state 0 (MO-IDLE). The fourth path leads to a decision 'CP layer wishes to send CP-ERROR?'. If Yes, it goes to CP-ERROR and then to state 0 (MO-IDLE). If No, it goes to CP-DATA (with a Note), CP-ACK, and state 3 (MO-MM-Connection Established). + +NOTE: This message is a retransmission from the MS +**MO-SMC-CP-entity on Network-side** +**SDL-9** + +![State transition diagram for MO-SMC-CP-entity on Network-side. It shows three states: 0 MO-IDLE, 2 MO-Wait for CP-ACK, and 3 MO-MM-Connection Established. Transitions include self-loops on states 0 and 2, and bidirectional transitions between states 2 and 3.](0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 0 + 0 --> 2 + 0 --> 3 + 2 --> 0 + 2 --> 2 + 2 --> 3 + 3 --> 0 + 3 --> 2 +``` + +State transition diagram for MO-SMC-CP-entity on Network-side. It shows three states: 0 MO-IDLE, 2 MO-Wait for CP-ACK, and 3 MO-MM-Connection Established. Transitions include self-loops on states 0 and 2, and bidirectional transitions between states 2 and 3. + +**MO-SMC-CP-entity on Network-side +State transition diagram** + +![State transition diagram for MT-SMC-CP-entity on Network-side. It starts at MT-IDLE (0), transitions through MNSMS-EST-Req (RPDU) and MMSM-EST-Req to MT-MM-Connection Pending (1). From there, it branches into MMSM-EST-Conf, MMSM-REL-Ind, and MNSMS-ABORT-Req. MMSM-EST-Conf leads to CP-DATA, then SET TC1N, and finally MT-Wait for CP-ACK (2). MMSM-REL-Ind and MNSMS-ABORT-Req both lead to MNSMS-ERROR-Ind, which then leads back to MT-IDLE (0). A connector '1' is shown on the left side of the diagram.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-IDLE_0 : 0 + MT-IDLE_0 --> MNSMS-EST-Req_RPDU : MNSMS-EST-Req (RPDU) + MNSMS-EST-Req_RPDU --> MMSM-EST-Req + MMSM-EST-Req --> MT-MM-Connection_Pending : 1 + MT-MM-Connection_Pending --> MMSM-EST-Conf + MT-MM-Connection_Pending --> MMSM-REL-Ind + MT-MM-Connection_Pending --> MNSMS-ABORT-Req + MMSM-EST-Conf --> CP-DATA + CP-DATA --> SET_TC1N : SET TC1N + SET_TC1N --> MT-Wait_CP_ACK : 2 + MMSM-REL-Ind --> MNSMS-ERROR-Ind + MNSMS-ABORT-Req --> MMSM-REL-Req + MMSM-REL-Req --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> MT-IDLE_0 : 0 +``` + +State transition diagram for MT-SMC-CP-entity on Network-side. It starts at MT-IDLE (0), transitions through MNSMS-EST-Req (RPDU) and MMSM-EST-Req to MT-MM-Connection Pending (1). From there, it branches into MMSM-EST-Conf, MMSM-REL-Ind, and MNSMS-ABORT-Req. MMSM-EST-Conf leads to CP-DATA, then SET TC1N, and finally MT-Wait for CP-ACK (2). MMSM-REL-Ind and MNSMS-ABORT-Req both lead to MNSMS-ERROR-Ind, which then leads back to MT-IDLE (0). A connector '1' is shown on the left side of the diagram. + +MT-SMC-CP-entity on Network-side +SDL-10 + +![State transition diagram for MT-SMC-CP-entity on Network-side. The diagram shows transitions between states MT-Wait for CP-ACK, MT-IDLE, and MT-MM-Connection Established based on various inputs like CP-DATA, CP-ACK, MMSM-ERROR-Ind, CP-ERROR, TC1N, MNSMS-REL-Req, and MNSMS-ABORT-Req. It includes decision diamonds for 'CP-DATA Supported in this state', 'retx = maximum?', and 'CP layer wishes to send CP-ERROR?'. Actions include RESET TC1N, RESET TC1M, Set retx = zero, MMSM-REL-Req, and MNSMS DATA-Ind (RPDU). Transitions are labeled with 'Yes' or 'No'.](4b398c5e8c4fd656d5b7a61806400650_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MT-Wait for CP-ACK : 2 + MT-Wait for CP-ACK --> CP-DATA + MT-Wait for CP-ACK --> CP-ACK + MT-Wait for CP-ACK --> MMSM-ERROR-Ind + MT-Wait for CP-ACK --> CP-ERROR + MT-Wait for CP-ACK --> TC1N + MT-Wait for CP-ACK --> MNSMS-REL-Req : Note + MT-Wait for CP-ACK --> MNSMS-ABORT-Req + + CP-DATA --> CP-DATA-Supported{CP-DATA Supported in this state} + CP-DATA-Supported -- No --> [*] + CP-DATA-Supported -- Yes --> RESET-TC1M[RESET TC1M] + RESET-TC1M --> Set-retx-zero-1[Set retx = zero] + Set-retx-zero-1 --> MNSMS-DATA-Ind{MNSMS DATA-Ind (RPDU)} + MNSMS-DATA-Ind --> CP-ACK + CP-ACK --> MT-MM-Connection-Established : 3 + + CP-ACK --> RESET-TC1N-1[RESET TC1N] + RESET-TC1N-1 --> Set-retx-zero-2[Set retx = zero] + Set-retx-zero-2 --> MT-MM-Connection-Established + + MMSM-ERROR-Ind --> RESET-TC1N-2[RESET TC1N] + RESET-TC1N-2 --> MNSMS-ERROR-Ind{MNSMS-ERROR-Ind} + + CP-ERROR --> MMSM-REL-Req-1{MMSM-REL-Req} + MMSM-REL-Req-1 --> MNSMS-ERROR-Ind + + TC1N --> retx-maximum{retx = maximum?} + retx-maximum -- No --> retx-plus-one[retx = retx + 1] + retx-plus-one --> 1 + retx-maximum -- Yes --> MMSM-REL-Req-2{MMSM-REL-Req} + MMSM-REL-Req-2 --> MNSMS-ERROR-Ind + + MNSMS-REL-Req -- Note --> MNSMS-ERROR-Ind + + MNSMS-ABORT-Req --> CP-layer-wishes{CP layer wishes to send CP-ERROR?} + CP-layer-wishes -- No --> CP-ERROR + CP-layer-wishes -- Yes --> CP-ERROR + CP-ERROR --> RESET-TC1N-3[RESET TC1N] + RESET-TC1N-3 --> MMSM-REL-Req-3{MMSM-REL-Req} + MMSM-REL-Req-3 --> MNSMS-ERROR-Ind + + MNSMS-ERROR-Ind --> Set-retx-zero-3[Set retx = zero] + Set-retx-zero-3 --> MT-IDLE : 0 + +``` + +State transition diagram for MT-SMC-CP-entity on Network-side. The diagram shows transitions between states MT-Wait for CP-ACK, MT-IDLE, and MT-MM-Connection Established based on various inputs like CP-DATA, CP-ACK, MMSM-ERROR-Ind, CP-ERROR, TC1N, MNSMS-REL-Req, and MNSMS-ABORT-Req. It includes decision diamonds for 'CP-DATA Supported in this state', 'retx = maximum?', and 'CP layer wishes to send CP-ERROR?'. Actions include RESET TC1N, RESET TC1M, Set retx = zero, MMSM-REL-Req, and MNSMS DATA-Ind (RPDU). Transitions are labeled with 'Yes' or 'No'. + +NOTE: The release is delayed until the next state + +### **MT-SMC-CP-entity on Network-side MM-connection established SDL-11** + +![State transition diagram for MT-SMC-CP-entity on Network-side. It shows transitions between states like MT-MM-Connection Established, CP-DATA, MMSM-ERROR-Ind, MNSMS-REL-Req, MNSMS-ABORT-Req, CP-ERROR, MT-IDLE, and CP-ACK. Transitions are triggered by events like CP-DATA, MMSM-ERROR-Ind, MNSMS-REL-Req, and MNSMS-ABORT-Req, leading to actions like MNSMS-DATA-Ind (RPDU), CP-ACK, CP-ERROR, or MT-IDLE.](347010b7ac06d3ae97927fde0f784d7c_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-MM-Connection-Established-3 : MT-MM-Connection Established + MT-MM-Connection-Established-3 --> CP-DATA + MT-MM-Connection-Established-3 --> MMSM-ERROR-Ind + MT-MM-Connection-Established-3 --> MNSMS-REL-Req + MT-MM-Connection-Established-3 --> MNSMS-ABORT-Req + CP-DATA --> MNSMS-DATA-Ind-RPDU : MNSMS-DATA-Ind (RPDU) + MNSMS-DATA-Ind-RPDU --> CP-ACK + CP-ACK --> MT-MM-Connection-Established-3 + MMSM-ERROR-Ind --> MT-IDLE-0 : MT-IDLE + MNSMS-REL-Req --> MT-IDLE-0 + MNSMS-ABORT-Req --> CP-layer-wishes-to-send-CP-ERROR : CP layer wishes to send CP-ERROR ? + CP-layer-wishes-to-send-CP-ERROR -- Yes --> CP-ERROR + CP-layer-wishes-to-send-CP-ERROR -- No --> MT-IDLE-0 + CP-ERROR --> MT-IDLE-0 +``` + +State transition diagram for MT-SMC-CP-entity on Network-side. It shows transitions between states like MT-MM-Connection Established, CP-DATA, MMSM-ERROR-Ind, MNSMS-REL-Req, MNSMS-ABORT-Req, CP-ERROR, MT-IDLE, and CP-ACK. Transitions are triggered by events like CP-DATA, MMSM-ERROR-Ind, MNSMS-REL-Req, and MNSMS-ABORT-Req, leading to actions like MNSMS-DATA-Ind (RPDU), CP-ACK, CP-ERROR, or MT-IDLE. + +**MT-SMC-CP-entity on Network-side +Message transfer active +SDL-12** + +![State transition diagram for MT-SMC-CP-entity on Network-side. It shows four states: 0 MT-IDLE, 1 MT-MM-Connection Pending, 2 MT-Wait for CP-ACK, and 3 MT-MM-Connection Established. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, and self-loops on 2 and 3.](694df81535f89c7bfb9ef0df6f130dc0_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 : MT-IDLE + 0 --> 1 : MT-MM-Connection Pending + 1 --> 0 + 1 --> 2 : MT-Wait for CP-ACK + 2 --> 0 + 2 --> 3 : MT-MM-Connection Established + 2 --> 2 + 3 --> 3 +``` + +State transition diagram for MT-SMC-CP-entity on Network-side. It shows four states: 0 MT-IDLE, 1 MT-MM-Connection Pending, 2 MT-Wait for CP-ACK, and 3 MT-MM-Connection Established. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, and self-loops on 2 and 3. + +**MT-SMC-CP-entity on Network-side +State transition diagram** + +![Sequence diagram for MO-SMC-GP entity on MS-side for GPRS. The process starts at MO-Idle, sends an MN SMS EST-Req (RP DATA), then checks if it can Access RAN. If GSM, it goes to PMMSMS-EST-Req, then MO-GMM-Connection Pending, then PMMSMS-EST-Conf, then CP-DATA, then SET TC1M, and finally MO-Wait For CP-ACK. If UMTS, it goes to PMMSMS-EST-Req, then PMMSMS-EST-Conf, then CP-DATA, then SET TC1M, and finally MO-Wait For CP-ACK. If the RAN access fails, it goes to PMMSMS-ERROR-ind, then MN SMS-ERROR-ind, and finally back to MO-Idle. Alternatively, it can go to MN SMS-ABORT-Req, then MN SMS-ERROR-ind, and finally back to MO-Idle.](2a476a0b3dbc3429436246db4784ff9f_img.jpg) + +``` +sequenceDiagram + participant MS + Note right of MS: MO-Idle + MS->>MS: MN SMS EST-Req (RP DATA) + Note right of MS: Access RAN + alt GSM + Note right of MS: PMMSMS-EST-Req + Note right of MS: MO-GMM-Connection Pending + Note right of MS: PMMSMS-EST-Conf + Note right of MS: CP-DATA + Note right of MS: SET TC1M + Note right of MS: MO-Wait For CP-ACK + else UMTS + Note right of MS: PMMSMS-EST-Req + Note right of MS: PMMSMS-EST-Conf + Note right of MS: CP-DATA + Note right of MS: SET TC1M + Note right of MS: MO-Wait For CP-ACK + else Error/Abort + Note right of MS: PMMSMS-ERROR-ind + Note right of MS: MN SMS-ERROR-ind + Note right of MS: MO-Idle + Note right of MS: MN SMS-ABORT-Req + Note right of MS: MN SMS-ERROR-ind + Note right of MS: MO-Idle + end +``` + +Sequence diagram for MO-SMC-GP entity on MS-side for GPRS. The process starts at MO-Idle, sends an MN SMS EST-Req (RP DATA), then checks if it can Access RAN. If GSM, it goes to PMMSMS-EST-Req, then MO-GMM-Connection Pending, then PMMSMS-EST-Conf, then CP-DATA, then SET TC1M, and finally MO-Wait For CP-ACK. If UMTS, it goes to PMMSMS-EST-Req, then PMMSMS-EST-Conf, then CP-DATA, then SET TC1M, and finally MO-Wait For CP-ACK. If the RAN access fails, it goes to PMMSMS-ERROR-ind, then MN SMS-ERROR-ind, and finally back to MO-Idle. Alternatively, it can go to MN SMS-ABORT-Req, then MN SMS-ERROR-ind, and finally back to MO-Idle. + +**MO-SMC-GP entity on MS-side for GPRS +SDL-13** + +![State transition diagram for MO-Wait For CP-ACK entity.](0931f3e098bd4539041de11c50cec2d2_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MO-Wait For CP-ACK + MO-Wait For CP-ACK --> CP-ACK + MO-Wait For CP-ACK --> TC1M Expired + MO-Wait For CP-ACK --> PMMSMS-ERROR-Ind + MO-Wait For CP-ACK --> CP-ERROR + MO-Wait For CP-ACK --> MNMSMS-ABORT-Req + + CP-ACK --> Reset TC1M + Reset TC1M --> Set retx = Zero + Set retx = Zero --> MO-Wait For CP-DATA + + TC1M Expired --> retx = max + retx = max --> Access RAN + Access RAN --> PMMSMS-REL-Req + retx = max --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> MNMSMS-ERROR-Ind + + PMMSMS-ERROR-Ind --> Reset TC1M + Reset TC1M --> MNMSMS-ERROR-Ind + + CP-ERROR --> CP-ERROR + CP-ERROR --> Reset TC1M + Reset TC1M --> MNMSMS-ERROR-Ind + + MNMSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> Reset TC1M + Reset TC1M --> MNMSMS-ERROR-Ind + + MNMSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MO-Idle + +``` + +State transition diagram for MO-Wait For CP-ACK entity. + +MO-SMC-GP entity on MS-side for GPRS +SDL-14 + +![State transition diagram for MO-Wait For CP-DATA entity.](57939c16065211317c5442cf2a4009e0_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MO-Wait For CP-DATA + MO-Wait For CP-DATA --> CP-DATA + MO-Wait For CP-DATA --> CP-ERROR + MO-Wait For CP-DATA --> MNMSMS-REL-Req + MO-Wait For CP-DATA --> MNMSMS-ABORT-Req + MO-Wait For CP-DATA --> PMMSMS-ERROR-Ind + + CP-DATA --> MNMSMS-DATA-Ind (RPDU) + MNMSMS-DATA-Ind (RPDU) --> CP ACK + CP ACK --> MO-Idle + + CP-ERROR --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> MO-Idle + + MNMSMS-REL-Req --> MO-Idle + + MNMSMS-ABORT-Req --> CP ERROR + CP ERROR --> MO-Idle + + PMMSMS-ERROR-Ind --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> MO-Idle + +``` + +State transition diagram for MO-Wait For CP-DATA entity. + +MO-SMC-GP entity on MS-side for GPRS +SDL-15 + +![State transition diagram for MO-SMC-GP entity on MS-side for GPRS. States: 0 MO_IDLE, 1 MO_GMM Connection Pending (shaded), 2 MO_Wait for CP ACK, 3 MO_Wait for CP DATA. Transitions include self-loops and directed edges between states.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMO_IDLE" as S0 + state "1\nMO_GMM\nConnection\nPending" as S1 + state "2\nMO_Wait\nfor CP ACK" as S2 + state "3\nMO_Wait\nfor CP DATA" as S3 + + S0 --> S1 + S1 --> S0 + S1 --> S2 + S2 --> S0 + S2 --> S2 + S2 --> S3 + S3 --> S0 + S0 --> S2: *1 + +``` + +The diagram illustrates the state transitions for the MO-SMC-GP entity on the MS-side for GPRS. It consists of four states: 0 MO\_IDLE, 1 MO\_GMM Connection Pending (shaded gray), 2 MO\_Wait for CP ACK, and 3 MO\_Wait for CP DATA. Transitions are as follows: from 0 to 1, from 1 to 0, from 1 to 2, from 2 to 0, a self-loop on 2, from 2 to 3, and from 3 to 0. A long curved arrow labeled \*1 points from 0 to 2. + +State transition diagram for MO-SMC-GP entity on MS-side for GPRS. States: 0 MO\_IDLE, 1 MO\_GMM Connection Pending (shaded), 2 MO\_Wait for CP ACK, 3 MO\_Wait for CP DATA. Transitions include self-loops and directed edges between states. + +NOTE: The gray shaded area is applicable to UMTS only. + +\*1:The arrow from MO\_IDLE to MO\_Wait for CP\_ACK is for GSM only. + +**MO-SMC-GP entity on MS-side for GPRS +State transition diagram** + +![State transition diagram for MT-IDLE state.](719ef0f734259484038b2434e5dc3f24_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-IDLE + MT-IDLE --> CP_DATA + CP_DATA --> MNSMS_DATA_Ind + MNSMS_DATA_Ind --> CP_ACK + CP_ACK --> MT_Wait_RP_ACK +``` + +This diagram shows a sequence of states and transitions for an MT (Mobile Terminal) entity. It starts with an initial state (circle with dot) leading to the MT-IDLE state (oval). A transition arrow points to a CP DATA state (rectangle with a chevron on the right). From there, an arrow points to an MNSMS-DATA-Ind (RP DATA) state (diamond with a chevron on the right). Next is a CP ACK state (rectangle with a chevron on the right). The sequence ends at an MT - Wait for RP ACK state (oval with a small square in the top-left corner containing the number 1). + +State transition diagram for MT-IDLE state. + +**MT-SMC-GP entity on MS-side for GPRS +SDL-16** + +![State transition diagram for MT-Wait For RP ACK state.](b63f41ca262d8ce9ef8affb62607f32b_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait_For_RP_ACK + MT-Wait_For_RP_ACK --> MNSMS_DATA_Req + MT-Wait_For_RP_ACK --> MNSMS_ABORT_Req + MT-Wait_For_RP_ACK --> PMMSMS_ERROR_Ind + MNSMS_DATA_Req --> CP_DATA + CP_DATA --> Set_TC1M + Set_TC1M --> MT_Wait_CP_ACK + MNSMS_ABORT_Req --> CP_ERROR + PMMSMS_ERROR_Ind --> MNSMS_ERROR_Ind + CP_ERROR --> MT_Idle + MNSMS_ERROR_Ind --> CP_ERROR +``` + +This diagram shows transitions from the MT-Wait For RP ACK state (oval). A horizontal line connects this state to three possible transitions: MNSMS-DATA-Req (PR ACK) (diamond with a chevron on the right), MNSMS-ABORT-Req (rectangle), and PMMSMS-ERROR-Ind (diamond with a chevron on the right). The MNSMS-DATA-Req transition leads to a CP-DATA state (rectangle with a chevron on the right), which then leads to a Set TC1M state (rectangle), which finally leads to an MT-Wait For CP ACK state (oval with a small square in the top-left corner containing the number 1). The MNSMS-ABORT-Req transition leads to a CP-ERROR state (rectangle with a chevron on the right), which leads to an MT-Idle state (oval). The PMMSMS-ERROR-Ind transition leads to an MNSMS-ERROR-Ind state (diamond with a chevron on the right), which also leads to the CP-ERROR state. A circle with the number 1 is connected to the MNSMS-DATA-Req transition. + +State transition diagram for MT-Wait For RP ACK state. + +**MT-SMC-GP entity on MS-side for GPRS +SDL-17** + +![State transition diagram for MT-Wait For CP ACK. Transitions include CP ACK, TC1M Expired, PMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-REL-Req. Actions include Reset TC1M, Set retx = Zero, and retx = retx + 1. Ends at MT-Idle.](3198cdf0dbe501c46fe0e4073c7d8451_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-WaitForCPACK : MT-Wait For CP ACK + MT-WaitForCPACK --> CPACK : CP ACK + MT-WaitForCPACK --> TC1MExpired : TC1M Expired + MT-WaitForCPACK --> PMMSMSERRORInd : PMMSMS-ERROR-Ind + MT-WaitForCPACK --> CPERROR : CP-ERROR + MT-WaitForCPACK --> MNSMSRELReq : MNSMS-REL-Req + CPACK --> ResetTC1M1 : Reset TC1M + ResetTC1M1 --> SetRetxZero1 : Set retx = Zero + SetRetxZero1 --> MTIdle : MT-Idle + TC1MExpired --> retxMax : retx = max + retxMax -- NO --> retxPlus1 : retx = retx + 1 + retxPlus1 --> 1 + 1 --> MNSMSERRORInd : MNSMS-ERROR-Ind + MNSMSERRORInd --> SetRetxZero2 : Set retx = Zero + SetRetxZero2 --> MTIdle + PMMSMSERRORInd --> ResetTC1M2 : Reset TC1M + ResetTC1M2 --> MNSMSERRORInd + CPERROR --> MNSMSERRORInd +``` + +State transition diagram for MT-Wait For CP ACK. Transitions include CP ACK, TC1M Expired, PMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-REL-Req. Actions include Reset TC1M, Set retx = Zero, and retx = retx + 1. Ends at MT-Idle. + +Note: The MNSMS-REL-Req is delayed until the next state + +### **MT-SMC-GP entity on MS-side for GPRS SDL-18** + +![State transition diagram for MT-SMC-GP entity on MS-side for GPRS. It shows three states: 0 MT_IDLE, 1 MT_Wait for RP ACK, and 2 MT_Wait for CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, and 2 to 0. State 2 has a self-loop.](18bb06865e2dada3656ea3d57f290f7f_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMT_IDLE" as S0 + state "1\nMT_Wait\nfor RP ACK" as S1 + state "2\nMT_Wait\nfor CP ACK" as S2 + + S0 --> S1 + S1 --> S0 + S1 --> S2 + S2 --> S0 + S2 --> S2 + +``` + +State transition diagram for MT-SMC-GP entity on MS-side for GPRS. It shows three states: 0 MT\_IDLE, 1 MT\_Wait for RP ACK, and 2 MT\_Wait for CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, and 2 to 0. State 2 has a self-loop. + +**MT-SMC-GP entity on MS-side for GPRS +State transition diagram** + +![Sequence diagram for MO-IDLE state transition.](2f587210e4f97c32758c5972e2e83d20_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MO-IDLE + MO-IDLE --> CP DATA + CP DATA --> MNSMS-EST-Ind (RP DATA) + MNSMS-EST-Ind (RP DATA) --> CP ACK + CP ACK --> MO-Wait for RP ACK + +``` + +Sequence diagram for MO-IDLE state transition. + +**MO-SMC-GP entity on Network side for GPRS +SDL-19** + +![State transition diagram for MO-SMC-GP entity on Network side for GPRS (SDL-19).](a70e0adcabc973b01b413b6a141884f3_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MO-Wait For RP ACK + MO-Wait For RP ACK --> MNSMS-DATA-Req (RP ACK) + MO-Wait For RP ACK --> MNSMS-ABORT-Req + MO-Wait For RP ACK --> MNSMS-REL-Req + MO-Wait For RP ACK --> PMMSMS-ERROR-Ind + MO-Wait For RP ACK --> CP-ERROR + MNSMS-DATA-Req (RP ACK) --> CP DATA + CP DATA --> Set TC1N + Set TC1N --> MO-Wait For CP ACK + MNSMS-ABORT-Req --> CP ERROR + CP ERROR --> Access RAN + Access RAN --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MO-Idle + MNSMS-REL-Req --> PMMSMS-REL-Req + PMMSMS-ERROR-Ind --> MNSMS-ERROR-Ind + CP-ERROR --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MO-Idle + state "Access RAN" as Access RAN + Access RAN --> GSM + Access RAN --> UMTS + GSM --> PMMSMS-REL-Req + UMTS --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MO-Idle + +``` + +State transition diagram for MO-SMC-GP entity on Network side for GPRS (SDL-19). + +**MO-SMC-GP entity on Network side for GPRS +SDL-20** + +![State transition diagram for MO-Wait For CP ACK state. Transitions include CP-ACK, TC1N Expired, PMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-REL-Req leading to MO-Idle or other states.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP ACK + MO-Wait For CP ACK --> CP-ACK + MO-Wait For CP ACK --> TC1N Expired + MO-Wait For CP ACK --> PMMSMS-ERROR-Ind + MO-Wait For CP ACK --> CP-ERROR + MO-Wait For CP ACK --> MNSMS-REL-Req + + CP-ACK --> Reset TC1N + Reset TC1N --> Set retx = Zero + Set retx = Zero --> MO-Idle + + TC1N Expired --> retx = max + retx = max --> Access RAN + Access RAN --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MO-Idle + + PMMSMS-ERROR-Ind --> Reset TC1N + Reset TC1N --> MO-Idle + + CP-ERROR --> GSM Access RAN + GSM Access RAN --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MO-Idle + + MNSMS-REL-Req --> MO-Idle +``` + +State transition diagram for MO-Wait For CP ACK state. Transitions include CP-ACK, TC1N Expired, PMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-REL-Req leading to MO-Idle or other states. + +Note: The MNSMS-REL-Req is delayed until next state + +### **MO-SMC-GP entity on Network side for GPRS SDL-21** + +![State transition diagram for MO-SMC-GP entity on Network-side for GPRS. It shows three states: 0 MO_IDLE, 1 MO_Wait for RP ACK, and 2 MO_Wait for CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, and 2 to 0. State 2 has a self-loop.](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMO_IDLE" as S0 + state "1\nMO_Wait\nfor RP ACK" as S1 + state "2\nMO_Wait\nfor CP ACK" as S2 + + S0 --> S1 + S1 --> S0 + S1 --> S2 + S2 --> S0 + S2 --> S2 + +``` + +State transition diagram for MO-SMC-GP entity on Network-side for GPRS. It shows three states: 0 MO\_IDLE, 1 MO\_Wait for RP ACK, and 2 MO\_Wait for CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, and 2 to 0. State 2 has a self-loop. + +**MO-SMC-GP entity on Network-side for GPRS +State transition diagram** + +![State transition diagram for MT-SMC-GP entity on Network-side for GPRS SDL-22. The diagram shows a sequence of states and transitions: MT-IDLE (state 0) -> MNSMS-EST-Req (RP DATA) -> CP DATA -> Set TC1N -> MT-Wait for CP ACK (state 1). An external transition labeled '1' points to the transition between MT-IDLE and MNSMS-EST-Req.](4806f9f95fff13a30d6523bd6ffeac63_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-IDLE : 0 + MT-IDLE --> MNSMS-EST-Req : RP DATA + MNSMS-EST-Req --> CP DATA + CP DATA --> Set TC1N + Set TC1N --> MT-Wait : 1 + MT-Wait --> [*] : CP ACK +``` + +State transition diagram for MT-SMC-GP entity on Network-side for GPRS SDL-22. The diagram shows a sequence of states and transitions: MT-IDLE (state 0) -> MNSMS-EST-Req (RP DATA) -> CP DATA -> Set TC1N -> MT-Wait for CP ACK (state 1). An external transition labeled '1' points to the transition between MT-IDLE and MNSMS-EST-Req. + +**MT-SMC-GP entity on Network-side for GPRS +SDL-22** + +![State transition diagram for MT-Wait For CP-ACK entity.](c07e21a8d65991db04263322f859c94f_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MT-Wait For CP-ACK + MT-Wait For CP-ACK --> CP-ACK + MT-Wait For CP-ACK --> TC1N Expired + MT-Wait For CP-ACK --> PMMSMS-ERROR-Ind + MT-Wait For CP-ACK --> CP-ERROR + MT-Wait For CP-ACK --> MNMSMS-ABORT-Req + + CP-ACK --> Reset TC1N + Reset TC1N --> Set retx = Zero + Set retx = Zero --> MT-Wait For CP-DATA + + TC1N Expired --> retx = max + retx = max --> Access RAN + Access RAN --> PMMSMS-REL-Req + retx = max --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> MT-Idle + + PMMSMS-ERROR-Ind --> Reset TC1N + Reset TC1N --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + + CP-ERROR --> Access RAN + Access RAN --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + + MNMSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> Reset TC1N + Reset TC1N --> Access RAN + Access RAN --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + +``` + +State transition diagram for MT-Wait For CP-ACK entity. + +MT-SMC-GP entity on Network-side for GPRS +SDL-23 + +![State transition diagram for MT-SMC-GP entity on Network-side for GPRS SDL-23.](9f51a76cae7309a296cbc6997941eb3f_img.jpg) + +``` + +stateDiagram-v2 + [*] --> MT-Wait For CP-DATA + MT-Wait For CP-DATA --> CP-DATA + MT-Wait For CP-DATA --> CP-ERROR + MT-Wait For CP-DATA --> MNMSMS-REL-Req + MT-Wait For CP-DATA --> MNMSMS-ABORT-Req + MT-Wait For CP-DATA --> PMMSMS-ERROR-Ind + + CP-DATA --> MNMSMS-DATA-Ind (RPDU) + MNMSMS-DATA-Ind (RPDU) --> CP-ACK + CP-ACK --> MT-Idle + + CP-ERROR --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> Access RAN + Access RAN --> PMMSMS-REL-Req + PMMSMS-REL-Req --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> MT-Idle + + MNMSMS-REL-Req --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> MT-Idle + + MNMSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> MT-Idle + + PMMSMS-ERROR-Ind --> MNMSMS-ERROR-Ind + MNMSMS-ERROR-Ind --> MT-Idle + +``` + +State transition diagram for MT-SMC-GP entity on Network-side for GPRS SDL-23. + +MT-SMC-GP entity on Network-side for GPRS +SDL-24 + +![State transition diagram for MT-SMC-GP entity on Network-side for GPRS. It shows three states: 0 MT_IDLE, 1 MT_Wait for CP ACK, and 2 MT_Wait for CP DATA. Transitions include a self-loop on state 1, and directed edges between states 0, 1, and 2.](9c45844d796e85ae05505870a54e4eb4_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMT_IDLE" as S0 + state "1\nMT_Wait\nfor CP ACK" as S1 + state "2\nMT_Wait\nfor CP DATA" as S2 + + S0 --> S1 + S1 --> S0 + S1 --> S1 + S1 --> S2 + S2 --> S0 + +``` + +The diagram illustrates the state transitions for the MT-SMC-GP entity on the network side for GPRS. It consists of three states represented by circles: **0 MT\_IDLE** at the top, **1 MT\_Wait for CP ACK** on the left, and **2 MT\_Wait for CP DATA** on the right. State 0 is the initial state. There is a self-loop transition on state 1. Transitions are as follows: from state 0 to state 1 (curved arrow pointing down-left), from state 1 to state 0 (curved arrow pointing up), from state 1 to state 2 (curved arrow pointing down-right), and from state 2 to state 0 (long curved arrow pointing up-left). + +State transition diagram for MT-SMC-GP entity on Network-side for GPRS. It shows three states: 0 MT\_IDLE, 1 MT\_Wait for CP ACK, and 2 MT\_Wait for CP DATA. Transitions include a self-loop on state 1, and directed edges between states 0, 1, and 2. + +**MT-SMC-GP entity on Network-side for GPRS +State transition diagram** + +![Flowchart showing the sequence of messages for MO-SMC-EP entity on Network side for EPS when packet-switched service is used. The sequence starts at state 0 (MO-Idle), followed by CP DATA, MNSMS-EST-Ind (RP DATA), CP-ACK, and ends at state 1 (MO-Wait for RP-ACK).](49fe8fe978c0f7e73112d231feb377eb_img.jpg) + +``` +graph TD; 0((0 MO-Idle)) --> CPDATA[CP DATA]; CPDATA --> MNSMS[MNSMS-EST-Ind (RP DATA)]; MNSMS --> CPACK[CP-ACK]; CPACK --> 1((1 MO-Wait for RP-ACK)); +``` + +Flowchart showing the sequence of messages for MO-SMC-EP entity on Network side for EPS when packet-switched service is used. The sequence starts at state 0 (MO-Idle), followed by CP DATA, MNSMS-EST-Ind (RP DATA), CP-ACK, and ends at state 1 (MO-Wait for RP-ACK). + +**MO-SMC-EP entity on Network side for EPS when packet-switched service is used** +**SDL-25** + +![SDL diagram for MO-Wait For RP ACK state transition logic.](5cf80bac69830ea773ac17c87e0ae24d_img.jpg) + +``` + +stateDiagram-v2 + state "MO-Wait\nFor RP ACK" as State1 + state "CP-DATA" as CP_DATA + state "SET TC1N" as SET_TC1N + state "MO-Wait For\nCP-ACK" as State2 + state "CP-\nERROR" as CP_ERROR_BOX + state "EMMSMS-\nREL-Req" as EMMSMS_REL_REQ + state "MO-Idle" as MO_IDLE + state "MNSMS-\nERROR-\nInd" as MNSMS_ERROR_IND1 + state "MNSMS-\nERROR-\nInd" as MNSMS_ERROR_IND2 + state "EMMSMS-\nREL-Req" as EMMSMS_REL_REQ2 + + [*] --> State1 + + State1 --> MNSMS_DATA_REQ : MNSMS-DATA-Req\n(RP ACK) + 1 --> CP_DATA + MNSMS_DATA_REQ --> CP_DATA + CP_DATA --> SET_TC1N + SET_TC1N --> State2 + + State1 --> MNSMS_ABORT_REQ : MNSMS-ABORT-Req + MNSMS_ABORT_REQ --> CP_ERROR_BOX + CP_ERROR_BOX --> EMMSMS_REL_REQ + EMMSMS_REL_REQ --> MO_IDLE + + State1 --> MNSMS_REL_REQ : MNSMS-REL-Req + MNSMS_REL_REQ --> MO_IDLE + + State1 --> EMMSMS_ERROR_IND : EMMSMS-ERROR-Ind + EMMSMS_ERROR_IND --> MNSMS_ERROR_IND1 + MNSMS_ERROR_IND1 --> MO_IDLE + + State1 --> CP_ERROR_IN : CP-ERROR + CP_ERROR_IN --> MNSMS_ERROR_IND2 + MNSMS_ERROR_IND2 --> EMMSMS_REL_REQ2 + EMMSMS_REL_REQ2 --> MO_IDLE + +``` + +SDL diagram for MO-Wait For RP ACK state transition logic. + +**MO-SMC-EP entity on Network side for EPS when packet-switched service is used** +**SDL-26** + +![State transition diagram for MO-Wait For CP-ACK. Transitions include CP-ACK, TC1N Expired, EMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-REL-Req leading to MO-Idle or back to waiting.](750b1652a4f4791b84c02aa755a1dedd_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP-ACK + MO-Wait For CP-ACK --> CP-ACK + MO-Wait For CP-ACK --> TC1N Expired + MO-Wait For CP-ACK --> EMMSMS-ERROR-Ind + MO-Wait For CP-ACK --> CP-ERROR + MO-Wait For CP-ACK --> MNSMS-REL-Req + CP-ACK --> Reset TC1N + Reset TC1N --> Set retx = Zero + Set retx = Zero --> MO-Idle + TC1N Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> EMMSMS-REL-Req + Retx=max? -- Yes --> EMMSMS-REL-Req + EMMSMS-REL-Req --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MO-Idle + EMMSMS-ERROR-Ind --> Reset TC1N + CP-ERROR --> EMMSMS-REL-Req + EMMSMS-REL-Req --> Reset TC1N + Reset TC1N --> MO-Idle +``` + +State transition diagram for MO-Wait For CP-ACK. Transitions include CP-ACK, TC1N Expired, EMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-REL-Req leading to MO-Idle or back to waiting. + +MO-SMC-EP entity on Network side for EPS when packet-switched service is used +SDL-27 + +![State transition diagram for MO-SMC-EP entity on Network-side for EPS when packet-switched service is used. The diagram shows three states: 0 MO-IDLE, 1 MO_Wait For RP ACK, and 2 MO-Wait For CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, and a self-loop on 2.](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMO-IDLE" as S0 + state "1\nMO_Wait\nFor RP ACK" as S1 + state "2\nMO-Wait\nFor CP ACK" as S2 + + S0 --> S1 + S1 --> S0 + S1 --> S2 + S2 --> S0 + S2 --> S2 + +``` + +State transition diagram for MO-SMC-EP entity on Network-side for EPS when packet-switched service is used. The diagram shows three states: 0 MO-IDLE, 1 MO\_Wait For RP ACK, and 2 MO-Wait For CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, and a self-loop on 2. + +**MO-SMC-EP entity on Network-side for EPS when packet-switched service is used +State transition diagram** + +![SDL diagram for MT-SMC-EP entity on Network-side for EPS. It starts at state 0 (MT-Idle), receives MNSMS-EST-Req (RP DATA), sends CP-DATA, sets timer TC1N, and enters state 1 (MT-Wait For CP-ACK).](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMT-Idle" as S0 + state "1\nMT-Wait For CP-ACK" as S1 + + [*] --> S0 + S0 --> MNSMS_EST_Req : MNSMS-EST-Req\n(RP DATA) + MNSMS_EST_Req --> CP_DATA : CP-DATA + CP_DATA --> SET_TC1N : SET TC1N + SET_TC1N --> S1 + +``` + +SDL diagram for MT-SMC-EP entity on Network-side for EPS. It starts at state 0 (MT-Idle), receives MNSMS-EST-Req (RP DATA), sends CP-DATA, sets timer TC1N, and enters state 1 (MT-Wait For CP-ACK). + +**MT-SMC-EP entity on Network-side for EPS when packet-switched service is used +SDL-28** + +![State transition diagram for MT-Wait For CP-ACK. It shows transitions for CP-ACK, TC1N Expired, EMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-ABORT-Req leading to various states like MT-Wait For CP-DATA, MT-Idle, and back to MT-Wait For CP-ACK.](38d82ffe820e339811b396206f40a201_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For CP-ACK + MT-Wait For CP-ACK --> CP-ACK + MT-Wait For CP-ACK --> TC1N Expired + MT-Wait For CP-ACK --> EMMSMS-ERROR-Ind + MT-Wait For CP-ACK --> CP-ERROR + MT-Wait For CP-ACK --> MNSMS-ABORT-Req + + CP-ACK --> Reset TC1N + Reset TC1N --> Set retx = Zero + Set retx = Zero --> MT-Wait For CP-DATA + + TC1N Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> MT-Wait For CP-ACK + Retx=max? -- Yes --> EMMSMS-REL-Req + EMMSMS-REL-Req --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + + EMMSMS-ERROR-Ind --> Reset TC1N + Reset TC1N --> EMMSMS-REL-Req + EMMSMS-REL-Req --> MT-Wait For CP-ACK + + CP-ERROR --> EMMSMS-REL-Req + EMMSMS-REL-Req --> MT-Wait For CP-ACK + + MNSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> Reset TC1N + Reset TC1N --> EMMSMS-REL-Req + EMMSMS-REL-Req --> MT-Wait For CP-ACK +``` + +State transition diagram for MT-Wait For CP-ACK. It shows transitions for CP-ACK, TC1N Expired, EMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-ABORT-Req leading to various states like MT-Wait For CP-DATA, MT-Idle, and back to MT-Wait For CP-ACK. + +MT-SMC-EP entity on Network-side for EPS when packet-switched service is used +SDL-29 + +![SDL-30 diagram for MT-SMC-EP entity on Network-side for EPS. It shows transitions from 'MT-Wait For CP-DATA' to 'MT-Idle' based on various inputs like CP-DATA, CP-ERROR, MNSMS-REL-Req, MNSMS-ABORT-Req, and EMMSMS-ERROR-Ind.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +``` + +graph TD + Start([MT-Wait For CP-DATA]) + + Start --> CP_DATA[/CP-DATA/] + CP_DATA --> MNSMS_DATA_Ind[MNSMS-DATA-Ind +(RPDU)] + MNSMS_DATA_Ind --> CP_ACK[CP-ACK] + CP_ACK --> End([MT-Idle]) + + Start --> CP_ERROR_In[/CP-ERROR/] + CP_ERROR_In --> MNSMS_ERROR_Ind1[MNSMS-ERROR-Ind] + MNSMS_ERROR_Ind1 --> EMMSMS_REL_Req[EMMSMS-REL-Req] + EMMSMS_REL_Req --> End + + Start --> MNSMS_REL_Req_In[/MNSMS-REL-Req/] + MNSMS_REL_Req_In --> End + + Start --> MNSMS_ABORT_Req_In[/MNSMS-ABORT-Req/] + MNSMS_ABORT_Req_In --> CP_ERROR_Out[CP-ERROR] + CP_ERROR_Out --> End + + Start --> EMMSMS_ERROR_Ind_In[/EMMSMS-ERROR-Ind/] + EMMSMS_ERROR_Ind_In --> MNSMS_ERROR_Ind2[MNSMS-ERROR-Ind] + MNSMS_ERROR_Ind2 --> End + +``` + +SDL-30 diagram for MT-SMC-EP entity on Network-side for EPS. It shows transitions from 'MT-Wait For CP-DATA' to 'MT-Idle' based on various inputs like CP-DATA, CP-ERROR, MNSMS-REL-Req, MNSMS-ABORT-Req, and EMMSMS-ERROR-Ind. + +**MT-SMC-EP entity on Network-side for EPS when packet-switched service is used +SDL-30** + +![State transition diagram for MT-SMC-EP entity on Network-side for EPS when packet-switched service is used. The diagram shows three states: 0 MT-IDLE, 1 MT_Wait For CP ACK, and 2 MT-Wait For CP DATA. Transitions are: 0 to 1, 1 to 0, 1 to 1 (self-loop), 1 to 2, and 2 to 0.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 1 + 1 --> 0 + 1 --> 1 + 1 --> 2 + 2 --> 0 +``` + +State transition diagram for MT-SMC-EP entity on Network-side for EPS when packet-switched service is used. The diagram shows three states: 0 MT-IDLE, 1 MT\_Wait For CP ACK, and 2 MT-Wait For CP DATA. Transitions are: 0 to 1, 1 to 0, 1 to 1 (self-loop), 1 to 2, and 2 to 0. + +MT-SMC-EP entity on Network-side for EPS when packet-switched service is used +State transition diagram + +![State transition diagram for MO-SMC-EP entity on MS-side for EPS. The diagram shows a sequence of states and transitions starting from MO-Idle (state 0) through various request and response messages to reach either MO-Wait For CP-ACK or back to MO-Idle.](d2417b04116c354deccb25d98a84a0fb_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Idle : 0 + MO-Idle --> MNSMS-EST-Req : (RP DATA) + MNSMS-EST-Req --> EMMSMS-EST-Req + EMMSMS-EST-Req --> MO-EMM-Connection Pending + MO-EMM-Connection Pending --> EMMSMS-EST-Conf + MO-EMM-Connection Pending --> EMMSMS-ERROR-Ind + MO-EMM-Connection Pending --> MNSMS-ABORT-Req + EMMSMS-EST-Conf --> CP-DATA : 1 + CP-DATA --> SET TC1M + SET TC1M --> MO-Wait For CP-ACK + EMMSMS-ERROR-Ind --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> MO-Idle + MNSMS-ABORT-Req --> MO-Idle +``` + +State transition diagram for MO-SMC-EP entity on MS-side for EPS. The diagram shows a sequence of states and transitions starting from MO-Idle (state 0) through various request and response messages to reach either MO-Wait For CP-ACK or back to MO-Idle. + +**MO-SMC-EP entity on MS-side for EPS when the UE is not using EPS services with control plane +CIoT EPS optimization +SDL-31** + +![Flowchart showing the sequence of operations for MO-SMC-EP entity on MS-side for EPS. The steps are: 0 MO-Idle, MNSMS-EST-Req (RP DATA), EMMSMS-EST-Req (CP-DATA), SET TC1M, and MO-Wait For CP-ACK.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +``` +graph TD; A([0 MO-Idle]) --> B[/MNSMS-EST-Req (RP DATA)/]; B --> C[/EMMSMS-EST-Req (CP-DATA)/]; C --> D[SET TC1M]; D --> E([MO-Wait For CP-ACK]); +``` + +Flowchart showing the sequence of operations for MO-SMC-EP entity on MS-side for EPS. The steps are: 0 MO-Idle, MNSMS-EST-Req (RP DATA), EMMSMS-EST-Req (CP-DATA), SET TC1M, and MO-Wait For CP-ACK. + +**MO-SMC-EP entity on MS-side for EPS when the UE is using EPS services with control plane CLoT +EPS optimization +SDL-31a** + +![State transition diagram for MO-Wait For CP-ACK. It shows transitions for CP-ACK, TC1M Expired, EMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-ABORT-Req leading to various states like MO-Wait For CP-DATA, MO-Idle, and intermediate processing steps like Reset TC1M and Set retx = Zero.](0dfdff10c725fe9c332b07ade9d23a5e_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP-ACK + MO-Wait For CP-ACK --> CP-ACK + MO-Wait For CP-ACK --> TC1M Expired + MO-Wait For CP-ACK --> EMMSMS-ERROR-Ind + MO-Wait For CP-ACK --> CP-ERROR + MO-Wait For CP-ACK --> MNSMS-ABORT-Req + CP-ACK --> Reset TC1M + Reset TC1M --> Set retx = Zero + Set retx = Zero --> MO-Wait For CP-DATA + TC1M Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> EMMSMS-REL-Req + Retx=max? -- Yes --> EMMSMS-REL-Req + EMMSMS-REL-Req --> MNSMS-ERROR-Ind + EMMSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MO-Idle + EMMSMS-ERROR-Ind --> Reset TC1M + CP-ERROR --> Reset TC1M + MNSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> Reset TC1M + Reset TC1M --> Set retx = Zero + Set retx = Zero --> MO-Idle +``` + +State transition diagram for MO-Wait For CP-ACK. It shows transitions for CP-ACK, TC1M Expired, EMMSMS-ERROR-Ind, CP-ERROR, and MNSMS-ABORT-Req leading to various states like MO-Wait For CP-DATA, MO-Idle, and intermediate processing steps like Reset TC1M and Set retx = Zero. + +**MO-SMC-EP entity on MS-side for EPS +SDL-32** + +![State transition diagram for MO-Wait For CP-DATA state. Transitions include CP-DATA leading to MNSMS-DATA-Ind (RPDU) then CP-ACK to MO-Idle; CP-ERROR leading to MNSMS-ERROR-Ind; MNSMS-REL-Req; MNSMS-ABORT-Req leading to CP-ERROR; and EMMSMS-ERROR-Ind leading to MNSMS-ERROR-Ind. All paths eventually lead to MO-Idle.](ffe0fef452a0ae9a20253c319c54e13c_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP-DATA + MO-Wait For CP-DATA --> CP-DATA + MO-Wait For CP-DATA --> CP-ERROR + MO-Wait For CP-DATA --> MNSMS-REL-Req + MO-Wait For CP-DATA --> MNSMS-ABORT-Req + MO-Wait For CP-DATA --> EMMSMS-ERROR-Ind + CP-DATA --> MNSMS-DATA-Ind (RPDU) + MNSMS-DATA-Ind (RPDU) --> CP-ACK + CP-ACK --> MO-Idle + CP-ERROR --> MNSMS-ERROR-Ind + MNSMS-REL-Req --> MO-Idle + MNSMS-ABORT-Req --> CP-ERROR + EMMSMS-ERROR-Ind --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> MO-Idle +``` + +State transition diagram for MO-Wait For CP-DATA state. Transitions include CP-DATA leading to MNSMS-DATA-Ind (RPDU) then CP-ACK to MO-Idle; CP-ERROR leading to MNSMS-ERROR-Ind; MNSMS-REL-Req; MNSMS-ABORT-Req leading to CP-ERROR; and EMMSMS-ERROR-Ind leading to MNSMS-ERROR-Ind. All paths eventually lead to MO-Idle. + +**MO-SMC-EP entity on MS-side for EPS +SDL-33** + +![State transition diagram for MO-SMC-EP entity on MS-side for EPS. It shows four states: 0 MO-IDLE, 1 MO-EMM Connection Pending, 2 MO_Wait For CP ACK, and 3 MO-Wait For CP DATA. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, and 3 to 0. State 2 has a self-loop transition.](a963ca41bde1669b18a4b783616f228b_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 : MO-IDLE + 0 --> 1 : MO-EMM Connection Pending + 1 --> 0 + 1 --> 2 : MO_Wait For CP ACK + 2 --> 0 + 2 --> 3 : MO-Wait For CP DATA + 3 --> 0 + 2 --> 2 +``` + +State transition diagram for MO-SMC-EP entity on MS-side for EPS. It shows four states: 0 MO-IDLE, 1 MO-EMM Connection Pending, 2 MO\_Wait For CP ACK, and 3 MO-Wait For CP DATA. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, and 3 to 0. State 2 has a self-loop transition. + +MO-SMC-EP entity on MS-side for EPS +State transition diagram + +![Flowchart of MT-SMC-EP entity on MS-side for EPS. The sequence starts at state 0 (MT-Idle), followed by CP DATA, MNSMS-DATA-Ind (RP DATA), CP-ACK, and finally MT-Wait For RP-ACK.](de63e4b6d8b0aa76b85e1fe3236eac27_img.jpg) + +``` + +graph TD + State0([0 +MT-Idle]) + Input1[/CP DATA/] + Task1[MNSMS- +DATA-Ind +(RP DATA)] + Output1[/CP-ACK/] + State1([MT-Wait For +RP-ACK]) + + State0 --> Input1 + Input1 --> Task1 + Task1 --> Output1 + Output1 --> State1 + +``` + +Flowchart of MT-SMC-EP entity on MS-side for EPS. The sequence starts at state 0 (MT-Idle), followed by CP DATA, MNSMS-DATA-Ind (RP DATA), CP-ACK, and finally MT-Wait For RP-ACK. + +**MT-SMC-EP entity on MS-side for EPS +SDL-34** + +![State transition diagram for MT-SMC-EP entity on MS-side for EPS. It starts at MT-Wait For RP ACK and branches into three paths: one for MN SMS DATA-Req (RP ACK) leading to CP-DATA, SET TC1M, and MT-Wait For CP-ACK; another for MN SMS ABORT-Req leading to CP-ERROR and MT-Idle; and a third for EMMSMS ERROR-Ind leading to MN SMS ERROR-Ind and MT-Idle. A connector '1' is on the first path.](e16bfa31d748f4d99ec4ae3d16656926_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For RP ACK + MT-Wait For RP ACK --> MN SMS DATA-Req (RP ACK) + MT-Wait For RP ACK --> MN SMS ABORT-Req + MT-Wait For RP ACK --> EMMSMS ERROR-Ind + MN SMS DATA-Req (RP ACK) --> CP-DATA + MN SMS ABORT-Req --> CP-ERROR + EMMSMS ERROR-Ind --> MN SMS ERROR-Ind + CP-DATA --> SET TC1M + CP-ERROR --> MT-Idle + MN SMS ERROR-Ind --> MT-Idle + SET TC1M --> MT-Wait For CP-ACK +``` + +State transition diagram for MT-SMC-EP entity on MS-side for EPS. It starts at MT-Wait For RP ACK and branches into three paths: one for MN SMS DATA-Req (RP ACK) leading to CP-DATA, SET TC1M, and MT-Wait For CP-ACK; another for MN SMS ABORT-Req leading to CP-ERROR and MT-Idle; and a third for EMMSMS ERROR-Ind leading to MN SMS ERROR-Ind and MT-Idle. A connector '1' is on the first path. + +MT-SMC-EP entity on MS-side for EPS +SDL-35 + +![State transition diagram for MT-Wait For CP-ACK](c0ca823603794512478906b302176bca_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For CP-ACK + MT-Wait For CP-ACK --> CP-ACK + MT-Wait For CP-ACK --> TC1M Expired + MT-Wait For CP-ACK --> EMMSMS-ERROR-Ind + MT-Wait For CP-ACK --> CP-ERROR + MT-Wait For CP-ACK --> MNSMS-REL-Req + CP-ACK --> Reset TC1M + Reset TC1M --> Set retx = Zero + Set retx = Zero --> MT-Idle + TC1M Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> MT-Idle + Retx=max? -- Yes --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + EMMSMS-ERROR-Ind --> Reset TC1M + CP-ERROR --> Reset TC1M + MNSMS-REL-Req --> MT-Idle +``` + +The diagram illustrates the state transitions for the MT-Wait For CP-ACK state. It starts with a vertical line from the state leading to five horizontal branches. The first branch contains three stacked boxes: CP-ACK, Reset TC1M, and Set retx = Zero, ending at the MT-Idle state. The second branch contains a TC1M Expired box leading to a Retx=max? decision diamond. The 'No' path goes to a retx = retx + 1 box, then to a circle with the number 1, and finally to MT-Idle. The 'Yes' path goes to an MNSMS-ERROR-Ind box, then to a Set retx = Zero box, and finally to MT-Idle. The third branch contains an EMMSMS-ERROR-Ind box leading to a Reset TC1M box. The fourth branch contains a CP-ERROR box leading to the same Reset TC1M box. The fifth branch contains an MNSMS-REL-Req box leading directly to MT-Idle. + +State transition diagram for MT-Wait For CP-ACK + +**MT-SMC-EP entity on MS-side for EPS +SDL-36** + +![State transition diagram for MT-SMC-EP entity on MS-side for EPS. It shows three states: 0 MT-IDLE, 1 MT_Wait For RP ACK, and 2 MT-Wait For CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, and 2 to 0. State 1 has a self-loop transition.](fc3e2b49a9f850951570e502393b697f_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 1 + 1 --> 0 + 1 --> 1 + 1 --> 2 + 2 --> 0 +``` + +State transition diagram for MT-SMC-EP entity on MS-side for EPS. It shows three states: 0 MT-IDLE, 1 MT\_Wait For RP ACK, and 2 MT-Wait For CP ACK. Transitions are: 0 to 1, 1 to 0, 1 to 2, and 2 to 0. State 1 has a self-loop transition. + +MT-SMC-EP entity on MS-side for EPS +State transition diagram + +![State transition diagram for MO-Idle state.](6a993bfdf2e00cfad01c4d2188a75d86_img.jpg) + +This state transition diagram shows the flow for an MO-Idle state. It begins at state 0 (MO-Idle), which transitions to a CP DATA message. This is followed by an MNSMS-EST-Ind (RP DATA) message, then a CP-ACK message, and finally transitions to state 1 (MO-Wait for RP-ACK). + +State transition diagram for MO-Idle state. + +**MO-SMC-5G entity on Network side for 5GS when packet-switched service is used** +**SDL-37** + +![State transition diagram for MO-SMC-5G entity on Network side.](ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg) + +This state transition diagram illustrates the network-side logic for the MO-SMC-5G entity. It starts at state 1 (MO-Wait For RP ACK). From this state, five possible transitions are shown: 1) MNSMS-DATA-Req (RP ACK) leads to CP DATA, then Set TC1N, then MO-Wait For CP ACK. 2) MNSMS-ABORT-Req leads to CP ERROR. 3) MNSMS-REL-Req leads to CP ERROR. 4) 5GMMSMS-ERROR-Ind leads to MNSMS-ERROR-Ind. 5) CP-ERROR leads to MNSMS-ERROR-Ind. All five resulting states (MO-Wait For CP ACK, CP ERROR, MNSMS-ERROR-Ind, and 5GMMSMS-REL-Req) eventually lead to the final state, MO-Idle. + +State transition diagram for MO-SMC-5G entity on Network side. + +### **MO-SMC-5G entity on Network side for 5GS when packet-switched service is used SDL-38** + +![State transition diagram for MO-SMC-5G entity on Network side for 5GS when packet-switched service is used (SDL-38).](c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP-ACK + MO-Wait For CP-ACK --> CP-ACK + MO-Wait For CP-ACK --> TC1N Expired + MO-Wait For CP-ACK --> 5GMMSMS ERROR - Ind + MO-Wait For CP-ACK --> CP - ERROR + MO-Wait For CP-ACK --> MNSMS-REL-Req + CP-ACK --> Reset TC 1N + Reset TC 1N --> Set retx = Zero + Set retx = Zero --> MO-Idle + TC1N Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> 5GMMSMS REL-Req + Retx=max? -- Yes --> 5GMMSMS REL-Req + 5GMMSMS REL-Req --> MNSMS - ERROR - Ind + MNSMS - ERROR - Ind --> Set retx = Zero + Set retx = Zero --> MO-Idle + 5GMMSMS ERROR - Ind --> Reset TC 1N + Reset TC 1N --> MO-Idle + CP - ERROR --> 5GMMSMS REL-Req + 5GMMSMS REL-Req --> MO-Idle + MNSMS-REL-Req --> MO-Idle +``` + +The diagram illustrates the state transitions for the MO-SMC-5G entity on the Network side for 5GS when packet-switched service is used (SDL-38). It starts in the initial state, leading to the 'MO-Wait For CP-ACK' state. From this state, five possible transitions are shown: 'CP-ACK', 'TC1N Expired', '5GMMSMS ERROR - Ind', 'CP - ERROR', and 'MNSMS-REL-Req'. The 'CP-ACK' path leads to 'Reset TC 1N', then 'Set retx = Zero', and finally to the 'MO-Idle' state. The 'TC1N Expired' path leads to a decision 'Retx=max?'. If 'No', it goes to 'retx = retx + 1', then to a connector '1', then to '5GMMSMS REL-Req', then to 'MNSMS - ERROR - Ind', then to 'Set retx = Zero', and finally to 'MO-Idle'. If 'Yes', it goes directly to '5GMMSMS REL-Req', then to 'MNSMS - ERROR - Ind', then to 'Set retx = Zero', and finally to 'MO-Idle'. The '5GMMSMS ERROR - Ind' path leads to 'Reset TC 1N', which then leads to 'MO-Idle'. The 'CP - ERROR' path leads to '5GMMSMS REL-Req', which then leads to 'MO-Idle'. The 'MNSMS-REL-Req' path leads directly to 'MO-Idle'. + +State transition diagram for MO-SMC-5G entity on Network side for 5GS when packet-switched service is used (SDL-38). + +### **MO-SMC-5G entity on Network side for 5GS when packet-switched service is used SDL-39** + +![State transition diagram for MO-SMC-5G entity on Network-side for 5GS when packet-switched service is used. The diagram shows three states: 0 MO-IDLE, 1 MO_Wait For RP ACK, and 2 MO_Wait For CP ACK. Transitions exist between 0 and 1, 1 and 2, and back to 0.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMO-IDLE" as S0 + state "1\nMO_Wait\nFor RP ACK" as S1 + state "2\nMO-Wait\nFor CP ACK" as S2 + + S0 --> S1 + S1 --> S0 + S1 --> S1 + S1 --> S2 + S2 --> S0 + +``` + +State transition diagram for MO-SMC-5G entity on Network-side for 5GS when packet-switched service is used. The diagram shows three states: 0 MO-IDLE, 1 MO\_Wait For RP ACK, and 2 MO\_Wait For CP ACK. Transitions exist between 0 and 1, 1 and 2, and back to 0. + +**MO-SMC-5G entity on Network-side for 5GS when packet-switched service is used +State transition diagram** + +![State transition diagram for MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used. The diagram shows a sequence of states and transitions: MT-Idle (state 0) -> MN SMS-EST-Req (RP DATA) -> CP-DATA -> SET TC1N -> MT-Wait For CP-ACK (state 1). A transition arrow labeled '1' points to the transition between MN SMS-EST-Req and CP-DATA.](0b998e3ad8f9d104768642612605cb35_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Idle : 0 + MT-Idle --> MN_SMS_EST_Req : MN SMS-EST-Req (RP DATA) + MN_SMS_EST_Req --> CP_DATA : 1 + CP_DATA --> SET_TC1N + SET_TC1N --> MT_Wait_For_CP_ACK : 1 +``` + +State transition diagram for MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used. The diagram shows a sequence of states and transitions: MT-Idle (state 0) -> MN SMS-EST-Req (RP DATA) -> CP-DATA -> SET TC1N -> MT-Wait For CP-ACK (state 1). A transition arrow labeled '1' points to the transition between MN SMS-EST-Req and CP-DATA. + +**MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used +SDL-40** + +![State transition diagram for MT-Wait For CP-ACK. It shows transitions for CP-ACK, TC1N Expired, 5GMM SMS ERROR Ind, CP-ERROR, and MNSMS-ABORT-Req leading to various states like MT-Wait For CP-DATA, MT-Idle, and Reset TC 1N.](69467ece0a576b4c2ec3e0c89ba61527_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For CP-ACK + MT-Wait For CP-ACK --> CP-ACK + MT-Wait For CP-ACK --> TC1N Expired + MT-Wait For CP-ACK --> 5GMM SMS ERROR Ind + MT-Wait For CP-ACK --> CP-ERROR + MT-Wait For CP-ACK --> MNSMS-ABORT-Req + CP-ACK --> Reset TC 1N + Reset TC 1N --> Set retx = Zero + Set retx = Zero --> MT-Wait For CP-DATA + TC1N Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> MT-Wait For CP-ACK + Retx=max? -- Yes --> 5GMM SMS REL-Req + 5GMM SMS REL-Req --> MNSMS-ERROR Ind + MNSMS-ERROR Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + 5GMM SMS ERROR Ind --> Reset TC 1N + CP-ERROR --> 5GMM SMS REL-Req + MNSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> Reset TC 1N + Reset TC 1N --> 5GMM SMS REL-Req +``` + +State transition diagram for MT-Wait For CP-ACK. It shows transitions for CP-ACK, TC1N Expired, 5GMM SMS ERROR Ind, CP-ERROR, and MNSMS-ABORT-Req leading to various states like MT-Wait For CP-DATA, MT-Idle, and Reset TC 1N. + +MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used +SDL-41 + +![State transition diagram for MT-SMC-5G entity on Network-side for EPS when packet-switched service is used. The diagram shows transitions from MT-Wait For CP-DATA to various states based on input events like CP-DATA, CP-ERROR, MNSMS-REL-Req, MNSMS-ABORT-Req, and 5GMMSMS ERROR-Ind. It includes intermediate states like MNSMS-DATA-Ind (RPDU), MNSMS-ERROR-Ind, CP-ACK, and 5GMMSMS REL-Req, leading to the MT-Idle state.](ba676d18b6a00f27c5bfaec9eeec20be_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For CP-DATA + MT-Wait For CP-DATA --> CP-DATA + MT-Wait For CP-DATA --> CP-ERROR + MT-Wait For CP-DATA --> MNSMS-REL-Req + MT-Wait For CP-DATA --> MNSMS-ABORT-Req + MT-Wait For CP-DATA --> 5GMMSMS ERROR-Ind + CP-DATA --> MNSMS-DATA-Ind (RPDU) + CP-ERROR --> MNSMS-ERROR-Ind + MNSMS-REL-Req --> MNSMS-ERROR-Ind + MNSMS-ABORT-Req --> CP-ERROR + 5GMMSMS ERROR-Ind --> MNSMS-ERROR-Ind + MNSMS-DATA-Ind (RPDU) --> CP-ACK + CP-ACK --> MT-Idle + MNSMS-ERROR-Ind --> 5GMMSMS REL-Req + 5GMMSMS REL-Req --> MT-Idle +``` + +State transition diagram for MT-SMC-5G entity on Network-side for EPS when packet-switched service is used. The diagram shows transitions from MT-Wait For CP-DATA to various states based on input events like CP-DATA, CP-ERROR, MNSMS-REL-Req, MNSMS-ABORT-Req, and 5GMMSMS ERROR-Ind. It includes intermediate states like MNSMS-DATA-Ind (RPDU), MNSMS-ERROR-Ind, CP-ACK, and 5GMMSMS REL-Req, leading to the MT-Idle state. + +MT-SMC-5G entity on Network-side for EPS when packet-switched service is used +SDL-41 + +![State transition diagram for MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used. The diagram shows three states: 0 MT-IDLE, 1 MT_Wait For CP ACK, and 2 MT-Wait For CP DATA. State 0 is the initial state. Transitions are: 0 to 1 (curved arrow), 1 to 0 (curved arrow), 1 to 1 (self-loop), 1 to 2 (curved arrow), and 2 to 0 (curved arrow).](a5404b7275b06497eecf9b5883604753_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 1 + 1 --> 0 + 1 --> 1 + 1 --> 2 + 2 --> 0 +``` + +State transition diagram for MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used. The diagram shows three states: 0 MT-IDLE, 1 MT\_Wait For CP ACK, and 2 MT-Wait For CP DATA. State 0 is the initial state. Transitions are: 0 to 1 (curved arrow), 1 to 0 (curved arrow), 1 to 1 (self-loop), 1 to 2 (curved arrow), and 2 to 0 (curved arrow). + +MT-SMC-5G entity on Network-side for 5GS when packet-switched service is used +State transition diagram + +![Flowchart of MO-SMC-EP entity on MS-side for EPS](a7450c80e88ad3f6ca1427ad84020998_img.jpg) + +``` + +graph TD + State1([0 MO-Idle]) + Input1[/MNSMS-EST-Req +(RP DATA)/] + Input2[/5GMMMSMS +EST-Req +(CP-DATA)/] + Process1[SET TC1M] + State2([MO-Wait For +CP-ACK]) + + State1 --> Input1 + Input1 --> Input2 + Input2 --> Process1 + Process1 --> State2 + +``` + +The flowchart illustrates the sequence of operations for the MO-SMC-EP entity on the MS-side for EPS. It begins with an initial state labeled '0 MO-Idle'. The first step is an input/output operation 'MNSMS-EST-Req (RP DATA)'. This is followed by another input/output operation '5GMMMSMS EST-Req (CP-DATA)'. The next step is a process 'SET TC1M'. The final state reached is 'MO-Wait For CP-ACK'. + +Flowchart of MO-SMC-EP entity on MS-side for EPS + +**MO-SMC-EP entity on MS-side for EPS +SDL-42** + +![State transition diagram for MO-Wait For CP-ACK state.](9e3c3a68ea23d6b0c0243f2baa1cb99f_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP-ACK + MO-Wait For CP-ACK --> CP-ACK + MO-Wait For CP-ACK --> TC1M Expired + MO-Wait For CP-ACK --> 5GMMSMS ERROR - Ind + MO-Wait For CP-ACK --> CP-ERROR + MO-Wait For CP-ACK --> MNSMS-ABORT-Req + CP-ACK --> Reset TC1M + Reset TC1M --> Set retx= Zero + Set retx= Zero --> MO-Wait For CP-DATA + TC1M Expired --> Retx=max? + Retx=max? -- No --> retx = retx + 1 + retx = retx + 1 --> 1 + 1 --> MO-Wait For CP-ACK + Retx=max? -- Yes --> 5GMMSMS REL-Req + 5GMMSMS REL-Req --> MNSMS-ERROR-Ind + MNSMS-ERROR-Ind --> Set retx = Zero + Set retx = Zero --> MO-Idle + 5GMMSMS ERROR - Ind --> Reset TC 1M + CP-ERROR --> CP-ERROR + MNSMS-ABORT-Req --> CP-ERROR + CP-ERROR --> Reset TC 1M + Reset TC 1M --> MO-Idle +``` + +The diagram illustrates the state transitions for the MO-Wait For CP-ACK state. It starts with an initial state leading to MO-Wait For CP-ACK. From this state, five transitions are possible: CP-ACK, TC1M Expired, 5GMMSMS ERROR - Ind, CP-ERROR, and MNSMS-ABORT-Req. The CP-ACK path leads to Reset TC1M, Set retx= Zero, and MO-Wait For CP-DATA. The TC1M Expired path leads to a decision Retx=max?. If No, it goes to retx = retx + 1, then to a connector 1, and back to MO-Wait For CP-ACK. If Yes, it goes to 5GMMSMS REL-Req, then to MNSMS-ERROR-Ind, then to Set retx = Zero, and finally to MO-Idle. The 5GMMSMS ERROR - Ind path leads to Reset TC 1M, which then leads to MO-Idle. The CP-ERROR and MNSMS-ABORT-Req paths both lead to a CP-ERROR state, which then leads to Reset TC 1M, and finally to MO-Idle. + +State transition diagram for MO-Wait For CP-ACK state. + +**MO-SMC-5G entity on MS-side for 5GS +SDL-43** + +![State transition diagram for MO-Wait For CP-DATA state. Transitions include CP-DATA leading to MNSMS-DATA -Ind (RPDU) then CP-ACK; CP-ERROR leading to MNSMS-ERROR -Ind; MNSMS-REL-Req; MNSMS-ABORT -Req leading to CP-ERROR; and 5GMMSMS ERROR-Ind leading to MNSMS-ERROR -Ind. All paths lead to MO-Idle.](17431d8b59408f09df7552d8bdbaa015_img.jpg) + +``` +stateDiagram-v2 + [*] --> MO-Wait For CP-DATA + MO-Wait For CP-DATA --> CP-DATA + MO-Wait For CP-DATA --> CP-ERROR + MO-Wait For CP-DATA --> MNSMS-REL-Req + MO-Wait For CP-DATA --> MNSMS-ABORT -Req + MO-Wait For CP-DATA --> 5GMMSMS ERROR-Ind + CP-DATA --> MNSMS-DATA -Ind (RPDU) + MNSMS-DATA -Ind (RPDU) --> CP-ACK + CP-ACK --> MO-Idle + CP-ERROR --> MNSMS-ERROR -Ind + MNSMS-REL-Req --> MO-Idle + MNSMS-ABORT -Req --> CP-ERROR + 5GMMSMS ERROR-Ind --> MNSMS-ERROR -Ind + MNSMS-ERROR -Ind --> MO-Idle +``` + +State transition diagram for MO-Wait For CP-DATA state. Transitions include CP-DATA leading to MNSMS-DATA -Ind (RPDU) then CP-ACK; CP-ERROR leading to MNSMS-ERROR -Ind; MNSMS-REL-Req; MNSMS-ABORT -Req leading to CP-ERROR; and 5GMMSMS ERROR-Ind leading to MNSMS-ERROR -Ind. All paths lead to MO-Idle. + +**MO-SMC-5G entity on MS-side for 5GS +SDL-44** + +![State transition diagram for MO-SMC-5G entity on MS-side for 5GS. It shows four states: 0 MO-IDLE, 1 MO-5GMM Connection Pending, 2 MO_Wait For CP ACK, and 3 MO-Wait For CP DATA. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, 3 to 0, and a self-loop on 2.](6e9d059430baba0c363e33749f68b107_img.jpg) + +``` + +stateDiagram-v2 + state "0\nMO-IDLE" as S0 + state "1\nMO-5GMM\nConnection\nPending" as S1 + state "2\nMO_Wait\nFor CP ACK" as S2 + state "3\nMO-Wait\nFor CP DATA" as S3 + + S0 --> S1 + S1 --> S0 + S1 --> S2 + S2 --> S0 + S2 --> S3 + S3 --> S0 + S2 --> S2 + +``` + +State transition diagram for MO-SMC-5G entity on MS-side for 5GS. It shows four states: 0 MO-IDLE, 1 MO-5GMM Connection Pending, 2 MO\_Wait For CP ACK, and 3 MO-Wait For CP DATA. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, 2 to 3, 3 to 0, and a self-loop on 2. + +**MO-SMC-5G entity on MS-side for 5GS +State transition diagram** + +![SDL diagram for MT-SMC-5G entity on MS-side for 5GS showing the transition from MT-Idle to MT-Wait For RP-ACK via CP DATA, MNSMS-DATA-Ind, and CP-ACK.](eabcb2f8b9acedb194571d5bc734b463_img.jpg) + +``` + +graph TD + State0(["0 +MT-Idle"]) + Input1["CP DATA"] + Process1["MNSMS- +DATA-Ind +(RP DATA)"] + Output1["CP-ACK"] + State1(["MT-Wait For +RP-ACK"]) + + State0 --> Input1 + Input1 --> Process1 + Process1 --> Output1 + Output1 --> State1 + +``` + +SDL diagram for MT-SMC-5G entity on MS-side for 5GS showing the transition from MT-Idle to MT-Wait For RP-ACK via CP DATA, MNSMS-DATA-Ind, and CP-ACK. + +**MT-SMC-5G entity on MS-side for 5GS +SDL-45** + +![State transition diagram for MT-SMC-5G entity on MS-side for 5GS. The diagram shows transitions between states MT-Wait For RP ACK, MT-Wait For CP-ACK, and MT-Idle based on various input and output messages.](2b00743506f6a3bbd17af764162dc76d_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For RP ACK + MT-Wait For RP ACK --> MT-Wait For CP-ACK : MNSMS-DATA -Req (RP ACK) + MT-Wait For RP ACK --> MT-Idle : MNSMS-ABORT-Req + MT-Wait For RP ACK --> MT-Idle : 5GMMSMS ERROR-Ind + MT-Wait For CP-ACK --> MT-Idle : CP-ERROR + MT-Wait For CP-ACK --> MT-Idle : MNSMS-ERROR-Ind +``` + +The diagram illustrates the state transitions for the MT-SMC-5G entity on the MS-side for 5GS. It starts at the initial state (represented by a circle with an arrow) leading to the state **MT-Wait For RP ACK**. From this state, three possible transitions are shown: 1) An input **MNSMS-DATA -Req (RP ACK)** leads to the state **MT-Wait For CP-ACK** via an output **CP-DATA** and a **SET TC1M** action. 2) An input **MNSMS-ABORT-Req** leads to the state **MT-Idle** via an output **CP-ERROR**. 3) An input **5GMMSMS ERROR-Ind** leads to the state **MT-Idle** via an output **MNSMS-ERROR-Ind**. A connector labeled '1' is shown on the left side of the first transition path. + +State transition diagram for MT-SMC-5G entity on MS-side for 5GS. The diagram shows transitions between states MT-Wait For RP ACK, MT-Wait For CP-ACK, and MT-Idle based on various input and output messages. + +**MT-SMC-5G entity on MS-side for 5GS +SDL-46** + +![State transition diagram for MT-Wait For CP-ACK. Transitions include CP-ACK, TC1M Expired, 5GMMSMS ERROR - Ind, CP-ERROR, and MNSMS - REL-Req. Includes actions like Reset TC 1M, Set retx = Zero, and a loop for retransmission.](cc7baa8e5118f4b42c01166637c738ea_img.jpg) + +``` +stateDiagram-v2 + [*] --> MT-Wait For CP-ACK + MT-Wait For CP-ACK --> CP-ACK + MT-Wait For CP-ACK --> TC1M Expired + MT-Wait For CP-ACK --> 5GMMSMS ERROR - Ind + MT-Wait For CP-ACK --> CP-ERROR + MT-Wait For CP-ACK --> MNSMS - REL-Req + CP-ACK --> Reset TC 1M + Reset TC 1M --> Set retx = Zero + Set retx = Zero --> MT-Idle + TC1M Expired --> Retx_max_Q{Retx = max ?} + Retx_max_Q -- No --> retx_increment[retx = retx + 1] + retx_increment --> 1((1)) + 1 --> MT-Idle + Retx_max_Q -- Yes --> MNSMS_ERROR_Ind{MNSMS - ERROR - Ind} + MNSMS_ERROR_Ind --> Set retx = Zero + Set retx = Zero --> MT-Idle + 5GMMSMS ERROR - Ind --> Reset TC 1M + Reset TC 1M --> MT-Idle + CP-ERROR --> MT-Idle + MNSMS - REL-Req --> MT-Idle +``` + +State transition diagram for MT-Wait For CP-ACK. Transitions include CP-ACK, TC1M Expired, 5GMMSMS ERROR - Ind, CP-ERROR, and MNSMS - REL-Req. Includes actions like Reset TC 1M, Set retx = Zero, and a loop for retransmission. + +**MT-SMC-EP entity on MS-side for EPS +SDL-47** + +![State transition diagram for MT-SMC-5G entity on MS-side for 5GS. It shows three states: 0 MO-IDLE, 1 MO_Wait For RP ACK, and 2 MO-Wait For CP DATA. State 0 is the initial state. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, and a self-loop on state 2.](ef45b00396c293be0b18d32b97118bf4_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 1 + 1 --> 0 + 1 --> 2 + 2 --> 0 + 2 --> 2 +``` + +State transition diagram for MT-SMC-5G entity on MS-side for 5GS. It shows three states: 0 MO-IDLE, 1 MO\_Wait For RP ACK, and 2 MO-Wait For CP DATA. State 0 is the initial state. Transitions are: 0 to 1, 1 to 0, 1 to 2, 2 to 0, and a self-loop on state 2. + +MT-SMC-5G entity on MS-side for 5GS +State transition diagram + +# --- Annex C (informative): Arrow diagrams + +Arrow diagram C1: + +The diagram reflects MO-message transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- SM-RL-primitives indicate services provided by SM-RL to SM-TL and RL (\* see note). +- MNSMS-primitives indicate services provided by CM to SM-RL. +- RP-DATA is the SM-RL message carrying SM-TP data units. +- RP-ACK acknowledges RP-DATA reception on SM-RL. + +Arrow diagram C2: + +The diagram reflects MT-messaging by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- SM-RL-primitives indicate services provided by SM-RL to SM-TL and RL (\* see note). +- MNSMS-primitives indicate services provided by CM to SM-RL. +- RP-DATA is the SM-RL message carrying SM-TP data units. +- RP-ACK acknowledges RP-DATA reception on SM-RL. + +Arrow diagram C3: + +The diagram reflects memory available notification transfer by means of interlayer service primitives and the actual messages being transferred between the layer entities. + +- SM-RL-primitives indicate services provided by SM-RL to SM-TL and RL (\* see note). +- MNSMS-primitives indicate services provided by CM to SM-RL. +- RP-SMMA is the SM-RL message indicating that the mobile has memory available to receive one or more short messages. +- RP-ACK acknowledges RP-SMMA reception on SM-RL. +- RP-ERROR reports a failure in the notification procedure on the network side. + +Arrow diagram C4: + +The diagram reflects the abort of any retransmission of a memory available notification by SM-RL by means of the SM-RL-MEMORY-AVAILABLE interlayer service primitive request with the SM-MEM-NOTIF-ABORT parameter present. The use of this primitive and the associated parameter are, of course, local to the mobile station. + +- SM-RL-primitives indicate services provided by SM-RL to SM-TL and RL (note). +- MNSMS-primitives indicate services provided by CM to SM-RL. +- RP-SMMA is the SM-RL message indicating that the mobile has memory available to receive one or more short messages. +- RP-ACK acknowledges RP-SMMA reception on SM-RL. +- RP-ERROR reports a failure in the notification procedure on the network side. + +NOTE: The SM-RL being the upper layer in the MSC, an interworking function between SM-RL-procedures and MAP-procedure is necessary. The term "RL" is used in the diagrams to indicate this function (see figure). + +![Diagram showing the interworking function between SM-RL-proc. and MAP-proc. within the SM-RL layer.](8b5a2bf5517051acf8bcc2587bcb73a1_img.jpg) + +The diagram illustrates the internal structure of the SM-RL layer. It consists of a horizontal line at the top and bottom. Between these lines, on the left, is the label 'SM-RL'. To the right of 'SM-RL' is a large rectangle divided into two side-by-side boxes. The left box is labeled 'SM-RL-proc.' and the right box is labeled 'MAP-proc.'. Above these two boxes, centered, is a smaller rectangle labeled 'Interw. func.'. + +Diagram showing the interworking function between SM-RL-proc. and MAP-proc. within the SM-RL layer. + +## **Mobile Originated Messaging on SM-RL** + +![Sequence diagram for Mobile Originated Messaging on SM-RL. Lifelines: SM-TL, SM-RL, CM, CM, SM-RL, RL. The diagram shows the flow of data from the Mobile Station Side to the Network side and back.](1f3389a0b9ef108721bdc3b3a6e364b7_img.jpg) + +``` +sequenceDiagram + participant SM-TL + participant SM-RL + participant CM1 as CM + participant CM2 as CM + participant SM-RL_Net as SM-RL + participant RL + + Note left of SM-TL: Mobile Station Side + Note right of SM-RL_Net: Network side + + SM-TL->>SM-RL: SM-RL-DATA-Req (SMS-SUBMIT) + SM-RL->>SM-RL_Net: RP-DATA + SM-RL_Net->>RL: SM-RL-DATA-Ind (SMS-SUBMIT) + RL->>SM-RL_Net: SM-RL-REPORT-Req + SM-RL_Net->>SM-RL: RP-ACK + SM-RL->>SM-TL: SM-RL-REPORT-Ind +``` + +The diagram illustrates the interaction for Mobile Originated Messaging on SM-RL. It is divided into two sides: Mobile Station Side and Network side. The Mobile Station Side contains lifelines SM-TL and SM-RL. The Network side contains lifelines CM, CM, SM-RL, and RL. The sequence of messages is: SM-TL sends SM-RL-DATA-Req (SMS-SUBMIT) to SM-RL; SM-RL sends RP-DATA to the first CM; the first CM passes it to the second CM; the second CM sends it to the SM-RL lifeline on the network side; the network SM-RL sends SM-RL-DATA-Ind (SMS-SUBMIT) to the RL lifeline; the RL lifeline sends SM-RL-REPORT-Req back to the network SM-RL; the network SM-RL sends RP-ACK back to the SM-RL lifeline on the mobile station side; finally, the SM-RL lifeline sends SM-RL-REPORT-Ind to the SM-TL lifeline. + +Sequence diagram for Mobile Originated Messaging on SM-RL. Lifelines: SM-TL, SM-RL, CM, CM, SM-RL, RL. The diagram shows the flow of data from the Mobile Station Side to the Network side and back. + +**Arrow diagram C1** + +## **Mobile Terminated Messaging on SM-RL** + +![Sequence diagram titled 'Arrow diagram C2' showing interactions between Mobile Station Side (SM-TL, SM-RL, CM) and Network side (CM, SM-RL, RL).](c21bad844b5cb6026c067a1f43ce67c3_img.jpg) + +``` + +sequenceDiagram + participant SM-TL as SM-TL (MS) + participant SM-RL_MS as SM-RL (MS) + participant CM_MS as CM (MS) + participant CM_NW as CM (NW) + participant SM-RL_NW as SM-RL (NW) + participant RL_NW as RL (NW) + + Note over SM-TL, CM_MS: Mobile Station Side + Note over CM_NW, RL_NW: Network side + + SM-RL_NW->>SM-RL_NW: SM-RL-DATA-Req (SMS-DELIVER) + SM-RL_NW->>SM-RL_MS: RP-DATA + SM-RL_MS->>SM-TL: SM-RL-DATA-Ind (SMS-DELIVER) + SM-TL->>SM-RL_MS: SM-RL-REPORT-Req + SM-RL_MS->>SM-RL_NW: RP-ACK + SM-RL_NW->>RL_NW: SM-RL-REPORT-Ind + +``` + +Sequence diagram titled 'Arrow diagram C2' showing interactions between Mobile Station Side (SM-TL, SM-RL, CM) and Network side (CM, SM-RL, RL). + +**Arrow diagram C2** + +**Memory Available Notification on SM-RL** + +![Sequence diagram titled 'Arrow diagram C3' showing 'Memory Available Notification Abort on SM-RL'. It is divided into 'Mobile Station Side' (SM-TL, SM-RL, CM) and 'Network side' (CM, SM-RL, RL).](b50f38be091844d58b11e3d47bc71e73_img.jpg) + +``` + +sequenceDiagram + participant MS_SM_TL as SM-TL + participant MS_SM_RL as SM-RL + participant MS_CM as CM + participant NW_CM as CM + participant NW_SM_RL as SM-RL + participant NW_RL as RL + + Note over MS_SM_TL, MS_CM: Mobile Station Side + Note over NW_CM, NW_RL: Network side + + MS_SM_TL->>MS_SM_RL: SM-RL-MEMORY AVAILABLE-Req + MS_SM_RL->>NW_SM_RL: RP-SMMA + NW_SM_RL->>NW_RL: SM-RL-MEMORY-AVAILABLE-Ind + NW_RL->>NW_SM_RL: SM-RL-REPORT-Req + NW_SM_RL->>MS_SM_RL: RP-ACK / RP-ERROR + MS_SM_RL->>MS_SM_TL: SM-RL-REPORT-Ind + +``` + +Sequence diagram titled 'Arrow diagram C3' showing 'Memory Available Notification Abort on SM-RL'. It is divided into 'Mobile Station Side' (SM-TL, SM-RL, CM) and 'Network side' (CM, SM-RL, RL). + +**Arrow diagram C3** + +**Memory Available Notification Abort on SM-RL** + +![Sequence diagram Arrow diagram C4 showing message exchange between Mobile Station Side (SM-TL, SM-RL, CM) and Network side (CM, SM-RL, RL).](72d448a65347c51989171748789c7d4b_img.jpg) + +``` + +sequenceDiagram + participant SM-TL + participant SM-RL_MS as SM-RL (MS) + participant CM_MS as CM (MS) + participant CM_NW as CM (NW) + participant SM-RL_NW as SM-RL (NW) + participant RL + + Note over SM-TL, CM_MS: Mobile Station Side + Note over CM_NW, RL: Network side + + SM-TL->>SM-RL_MS: SM-RL-MEMORY AVAILABLE-Req + SM-RL_MS-->>SM-TL: SM-RL-MEMORY AVAILABLE-Req (SMS-MEM-NOTIF-ABORT) + SM-RL_MS-->>SM-RL_NW: RP-SMMA + SM-RL_NW-->>RL: SM-RL-MEMORY-AVAILABLE-Ind + RL-->>SM-RL_NW: SM-RL-REPORT-Req + SM-RL_MS->>SM-TL: SM-RL-REPORT-Ind + SM-RL_NW-->>SM-RL_MS: RP-ACK / RP-ERROR + +``` + +Sequence diagram Arrow diagram C4 showing message exchange between Mobile Station Side (SM-TL, SM-RL, CM) and Network side (CM, SM-RL, RL). + +NOTE: Dashed lines indicates messages that may be sent, even though an abort request was given + +**Arrow diagram C4** + +# --- Annex D (normative): SDL-description of the short message relay layer + +## D.1 Introduction + +This annex contains an SDL-description of the Short Message Relay Layer in terms of the Short Message Service Support. The Short Message Relay Layer provides services to Short Message Transfer Layer. + +The SDLs contain a mixture of peer to peer messages and conceptual primitives between the layers SM-TL, SM-RL and CM, as viewed by the SMR entities. SDL-1/2/3 show the SMR entity on MS-side, and SDL-4/5 on the network side. + +The lower layers (below CM) are transparent to an SMR entity. + +![State transition diagram for SMR-entity on MS-side. It starts at IDLE (0), goes through SM-RL-DATA-Req (SMS-SUBMIT), MNSMS-EST-Req (RP-DATA), SET TR1M, and Wait for RP-ACK (1). From the wait state, it branches into RP-ACK, RP-ERROR, MNSMS-ERROR-Ind, or TM. RP-ACK leads to RESET TR1M, SM-RL-Report-Ind, MNSMS-REL-Req, and back to IDLE (0). The other three branches lead to MNSMS-ABORT-Req, SM-RL-REPORT-Ind, and IDLE (0).](24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg) + +``` +stateDiagram-v2 + [*] --> IDLE_0 : 0 IDLE + IDLE_0 --> SM-RL-DATA-Req : SM-RL-DATA-Req (SMS-SUBMIT) + SM-RL-DATA-Req --> MNSMS-EST-Req : MNSMS-EST-Req (RP-DATA) + MNSMS-EST-Req --> SET_TR1M : SET TR1M + SET_TR1M --> Wait_1 : 1 Wait for RP-ACK + state "Wait for RP-ACK" as Wait_1 + Wait_1 --> RP_ACK + Wait_1 --> RP_ERROR + Wait_1 --> MNSMS_ERROR_Ind + Wait_1 --> TM + RP_ACK --> RESET_TR1M : RESET TR1M + RESET_TR1M --> SM-RL_Report_Ind : SM-RL-Report-Ind + SM-RL_Report_Ind --> MNSMS_REL_Req : MNSMS-REL-Req + MNSMS_REL_Req --> IDLE_0_2 : 0 IDLE + TM --> MNSMS_ABORT_Req : MNSMS-ABORT-Req + MNSMS_ABORT_Req --> SM-RL_REPORT_Ind : SM-RL-REPORT-Ind + SM-RL_REPORT_Ind --> IDLE_0_3 : 0 IDLE +``` + +State transition diagram for SMR-entity on MS-side. It starts at IDLE (0), goes through SM-RL-DATA-Req (SMS-SUBMIT), MNSMS-EST-Req (RP-DATA), SET TR1M, and Wait for RP-ACK (1). From the wait state, it branches into RP-ACK, RP-ERROR, MNSMS-ERROR-Ind, or TM. RP-ACK leads to RESET TR1M, SM-RL-Report-Ind, MNSMS-REL-Req, and back to IDLE (0). The other three branches lead to MNSMS-ABORT-Req, SM-RL-REPORT-Ind, and IDLE (0). + +**SMR-entity on MS-side +MO Short Message transfer +SDL-1** + +![State transition diagram for SMR-entity on MS-side MT Short Message transfer SDL-2. The diagram shows states (IDLE, Wait to send RP-ACK) and transitions (MNSMS-EST-Ind, RP-DATA Accepted?, SM-RL-DATA-Ind, SET TR2M, SM-RL-REPORT-Req, RESET TR2M, RP-ACK, RP-ERROR, MNSMS-REL-Req, MNSMS-ABORT-Req, Severe errors?, MNSMS-ERROR-Ind, TR2M).](b13465efdac63129aef9b6f1787d0d00_img.jpg) + +``` +stateDiagram-v2 + [*] --> IDLE + IDLE --> MNSMS-EST-Ind + MNSMS-EST-Ind --> RP-DATA-Accepted{RP-DATA Accepted?} + RP-DATA-Accepted -- No --> Severe-errors{Severe errors?} + Severe-errors -- Yes --> MNSMS-ABORT-Req + Severe-errors -- No --> RP-ERROR + RP-ERROR --> MNSMS-REL-Req + MNSMS-REL-Req --> IDLE + RP-DATA-Accepted -- Yes --> SM-RL-DATA-Ind + SM-RL-DATA-Ind --> SET-TR2M[SET TR2M] + SET-TR2M --> Wait-to-send-RP-ACK{Wait to send RP-ACK} + Wait-to-send-RP-ACK --> SM-RL-REPORT-Req-RP-ACK{SM-RL-REPORT-Req (RP-ACK)} + Wait-to-send-RP-ACK --> SM-RL-REPORT-Req-RP-ERROR{SM-RL-REPORT-Req (RP-ERROR)} + Wait-to-send-RP-ACK --> MNSMS-ERROR-Ind{MNSMS-ERROR-Ind} + Wait-to-send-RP-ACK --> TR2M{TR2M} + SM-RL-REPORT-Req-RP-ACK --> RESET-TR2M-1[RESET TR2M] + SM-RL-REPORT-Req-RP-ERROR --> RESET-TR2M-2[RESET TR2M] + MNSMS-ERROR-Ind --> RESET-TR2M-3[RESET TR2M] + TR2M --> MNSMS-ABORT-Req + RESET-TR2M-1 --> RP-ACK + RESET-TR2M-2 --> RP-ERROR + RESET-TR2M-3 --> SM-RL-REPORT-Ind{SM-RL-REPORT-Ind} + RP-ACK --> MNSMS-REL-Req + RP-ERROR --> MNSMS-REL-Req + SM-RL-REPORT-Ind --> IDLE + MNSMS-REL-Req --> IDLE +``` + +State transition diagram for SMR-entity on MS-side MT Short Message transfer SDL-2. The diagram shows states (IDLE, Wait to send RP-ACK) and transitions (MNSMS-EST-Ind, RP-DATA Accepted?, SM-RL-DATA-Ind, SET TR2M, SM-RL-REPORT-Req, RESET TR2M, RP-ACK, RP-ERROR, MNSMS-REL-Req, MNSMS-ABORT-Req, Severe errors?, MNSMS-ERROR-Ind, TR2M). + +**SMR-entity on MS-side +MT Short Message transfer +SDL-2** + +![SDL diagram for SMR-entity on MS-side Memory Available Notification. The diagram illustrates the state transitions and signal handling for memory available notifications, including handling of timers TR1M and TRAM, and retransmission flags.](684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg) + +``` + +stateDiagram-v2 + state "0\nIDLE" as IDLE0 + state "1\nWait for RP-ACK" as WaitRPACK + state "0\nIDLE" as IDLE1 + state "0\nIDLE" as IDLE2 + state "4\nWAIT FOR RETRANS TIMER" as WaitRetrans + state "0\nIDLE" as IDLE3 + + [*] --> IDLE0 + IDLE0 --> SM_RL_MEM_AVAIL_Req + SM_RL_MEM_AVAIL_Req --> C + + C --> MNSMS_EST_Req_RP_SMMA + MNSMS_EST_Req_RP_SMMA --> SET_TR1M + SET_TR1M --> A + + A --> WaitRPACK + WaitRPACK --> RP_ACK + RP_ACK --> MNSMS_REL_Req + MNSMS_REL_Req --> RESET_TR1M_RETRANS + RESET_TR1M_RETRANS --> SM_RL_Report_Ind + SM_RL_Report_Ind --> IDLE1 + + WaitRPACK --> CP_LAYER_ERROR + CP_LAYER_ERROR --> SM_RL_MEM_AVAIL_Req_2 + SM_RL_MEM_AVAIL_Req_2 --> C + + WaitRPACK --> RP_ERROR + RP_ERROR --> TEMP_NET_FAIL_DECISION + TEMP_NET_FAIL_DECISION --> YES : YES + YES --> B + TEMP_NET_FAIL_DECISION --> NO : NO + NO --> SET_RETRANS_FLAG + SET_RETRANS_FLAG --> A + + WaitRPACK --> TR1M_TIMEOUT + TR1M_TIMEOUT --> B + + B --> RETRANS_FLAG_SET_DECISION + RETRANS_FLAG_SET_DECISION --> YES_RETRANS : YES + YES_RETRANS --> SM_RL_Report_Ind_2 + SM_RL_Report_Ind_2 --> RESET_RETRANS_FLAG_TR1M + RESET_RETRANS_FLAG_TR1M --> MNSMS_REL_Req_2 + MNSMS_REL_Req_2 --> IDLE2 + + RETRANS_FLAG_SET_DECISION --> NO_RETRANS : NO + NO_RETRANS --> SET_RETRANS_FLAG_TRAM_RESET_TR1M + SET_RETRANS_FLAG_TRAM_RESET_TR1M --> MNSMS_REL_Req_3 + MNSMS_REL_Req_3 --> WaitRetrans + WaitRetrans --> TRAM_TIMEOUT + TRAM_TIMEOUT --> C + + WaitRPACK --> SM_RL_MEM_AVAIL_Req_ABORT + SM_RL_MEM_AVAIL_Req_ABORT --> RESET_RETRANS_FLAG_TRAM + RESET_RETRANS_FLAG_TRAM --> SM_RL_Report_Ind_3 + SM_RL_Report_Ind_3 --> IDLE3 + +``` + +SDL diagram for SMR-entity on MS-side Memory Available Notification. The diagram illustrates the state transitions and signal handling for memory available notifications, including handling of timers TR1M and TRAM, and retransmission flags. + +**SMR-entity on MS-side +Memory Available Notification +SDL-3** + +![State transition diagram for SMR-entity on MS-side. States: 0 IDLE, 1 Wait for RP-ACK, 3 Wait to Send RP-ACK, 4 Wait for RETRANS Timer. Transitions: 0 to 0 (self-loop), 0 to 1, 1 to 0, 0 to 3, 3 to 0, 0 to 4, 4 to 0, 4 to 1.](921f8fa0f7ce2c9956f20d33162c13a2_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 0 + 0 --> 1 + 1 --> 0 + 0 --> 3 + 3 --> 0 + 0 --> 4 + 4 --> 0 + 4 --> 1 +``` + +State transition diagram for SMR-entity on MS-side. States: 0 IDLE, 1 Wait for RP-ACK, 3 Wait to Send RP-ACK, 4 Wait for RETRANS Timer. Transitions: 0 to 0 (self-loop), 0 to 1, 1 to 0, 0 to 3, 3 to 0, 0 to 4, 4 to 0, 4 to 1. + +**SMR-entity on MS-side +State transition diagram** + +![State transition diagram for SMR-entity on Network-side MT Short Message transfer SDL-4. The diagram shows a sequence of states and transitions starting from IDLE (0) through various request and response messages like SM-RL-DATA-Req, MNSMS-EST-Req, SET TR1N, Wait for RP-ACK, RP-ACK, RP-ERROR, MNSMS-ERROR-Ind, TRN, RESET TR1N, MNSMS-REL-Req, SM-RL-Report-Ind, MNSMS-ABORT-Req, and SM-RL-REPORT-Ind, ending at IDLE (0).](536768a30136cd5c2d57f46c25d1d804_img.jpg) + +``` +stateDiagram-v2 + [*] --> IDLE_0 : 0 IDLE + IDLE_0 --> SM-RL-DATA-Req : SM-RL-DATA-Req (RP-DATA) + SM-RL-DATA-Req --> MNSMS-EST-Req : MNSMS-EST-Req (RP-DATA) + MNSMS-EST-Req --> SET_TR1N : SET TR1N + SET_TR1N --> Wait_1 : 1 Wait for RP-ACK + Wait_1 --> RP_ACK + Wait_1 --> RP_ERROR + Wait_1 --> MNSMS_ERROR_Ind + Wait_1 --> TRN + RP_ACK --> RESET_TR1N : RESET TR1N + RESET_TR1N --> MNSMS_REL_Req : MNSMS-REL-Req + MNSMS_REL_Req --> SM-RL_Report_Ind : SM-RL-Report-Ind + SM-RL_Report_Ind --> IDLE_0_2 : 0 IDLE + TRN --> MNSMS_ABORT_Req : MNSMS-ABORT-Req + MNSMS_ABORT_Req --> SM-RL_REPORT_Ind : SM-RL-REPORT-Ind + SM-RL_REPORT_Ind --> IDLE_0_3 : 0 IDLE +``` + +State transition diagram for SMR-entity on Network-side MT Short Message transfer SDL-4. The diagram shows a sequence of states and transitions starting from IDLE (0) through various request and response messages like SM-RL-DATA-Req, MNSMS-EST-Req, SET TR1N, Wait for RP-ACK, RP-ACK, RP-ERROR, MNSMS-ERROR-Ind, TRN, RESET TR1N, MNSMS-REL-Req, SM-RL-Report-Ind, MNSMS-ABORT-Req, and SM-RL-REPORT-Ind, ending at IDLE (0). + +**SMR-entity on Network-side +MT Short Message transfer +SDL-4** + +![State transition diagram for SMR-entity on Network-side. It starts at IDLE (0), receives MNSMS-EST-Ind (RPDU), checks if RPDUs are accepted. If yes, it sends SM-RL-DATA-Ind and SET TR2N, then waits to send RP-ACK. If no, it checks for severe errors. If no severe errors, it sends RP-ERROR and MNSMS-REL-Req, returning to IDLE (0). If severe errors, it sends MNSMS-ABORT-Req, returning to IDLE (0). From the wait state, it handles SM-RL-REPORT-Req (RP-ACK), SM-RL-REPORT-Req (RP-ERROR), MNSMS-ERROR-Ind, or TR2N. RP-ACK leads to RESET TR2N, then RP-ACK, then MNSMS-REL-Req, then IDLE (0). RP-ERROR leads to RESET TR2N, then RP-ERROR. MNSMS-ERROR-Ind leads to RESET TR2N, then SM-RL-REPORT-Ind, then IDLE (0). TR2N leads to MNSMS-ABORT-Req, which then leads to SM-RL-REPORT-Ind, then IDLE (0).](245166735676c675f98f535bc4c6f0a1_img.jpg) + +``` +stateDiagram-v2 + [*] --> IDLE_0_1 : 0 IDLE + IDLE_0_1 --> MNSMS_EST_Ind : MNSMS-EST-Ind (RPDU) + MNSMS_EST_Ind --> RPDUs_Accepted : RPDUs Accepted? + RPDUs_Accepted --> SM_RL_DATA_Ind : Yes + RPDUs_Accepted --> Severe_Errors : No + SM_RL_DATA_Ind --> SET_TR2N : SM-RL-DATA-Ind (RP-DATA or RP-SMMA) + SET_TR2N --> Wait_RP_ACK : SET TR2N + Wait_RP_ACK --> SM_RL_REPORT_Req_RP_ACK : 3 Wait to send RP-ACK + Wait_RP_ACK --> SM_RL_REPORT_Req_RP_ERROR : SM-RL-REPORT-Req (RP-ERROR) + Wait_RP_ACK --> MNSMS_ERROR_Ind : MNSMS-ERROR-Ind + Wait_RP_ACK --> TR2N : TR2N + Severe_Errors --> MNSMS_ABORT_Req_1 : Yes + Severe_Errors --> RP_ERROR_1 : No + MNSMS_ABORT_Req_1 --> IDLE_0_2 : 0 IDLE + RP_ERROR_1 --> RP_ERROR_1 + RP_ERROR_1 --> MNSMS_REL_Req_1 : MNSMS-REL-Req + MNSMS_REL_Req_1 --> IDLE_0_3 : 0 IDLE + SM_RL_REPORT_Req_RP_ACK --> RESET_TR2N_1 : RESET TR2N + RESET_TR2N_1 --> RP_ACK : RP-ACK + RP_ACK --> MNSMS_REL_Req_2 : MNSMS-REL-Req + MNSMS_REL_Req_2 --> IDLE_0_4 : 0 IDLE + SM_RL_REPORT_Req_RP_ERROR --> RESET_TR2N_2 : RESET TR2N + RESET_TR2N_2 --> RP_ERROR_2 : RP-ERROR + MNSMS_ERROR_Ind --> RESET_TR2N_3 : RESET TR2N + RESET_TR2N_3 --> SM_RL_REPORT_Ind : SM-RL-REPORT-Ind + SM_RL_REPORT_Ind --> IDLE_0_5 : 0 IDLE + TR2N --> MNSMS_ABORT_Req_2 : MNSMS-ABORT-Req + MNSMS_ABORT_Req_2 --> SM_RL_REPORT_Ind : SM-RL-REPORT-Ind + SM_RL_REPORT_Ind --> IDLE_0_5 : 0 IDLE +``` + +State transition diagram for SMR-entity on Network-side. It starts at IDLE (0), receives MNSMS-EST-Ind (RPDU), checks if RPDUs are accepted. If yes, it sends SM-RL-DATA-Ind and SET TR2N, then waits to send RP-ACK. If no, it checks for severe errors. If no severe errors, it sends RP-ERROR and MNSMS-REL-Req, returning to IDLE (0). If severe errors, it sends MNSMS-ABORT-Req, returning to IDLE (0). From the wait state, it handles SM-RL-REPORT-Req (RP-ACK), SM-RL-REPORT-Req (RP-ERROR), MNSMS-ERROR-Ind, or TR2N. RP-ACK leads to RESET TR2N, then RP-ACK, then MNSMS-REL-Req, then IDLE (0). RP-ERROR leads to RESET TR2N, then RP-ERROR. MNSMS-ERROR-Ind leads to RESET TR2N, then SM-RL-REPORT-Ind, then IDLE (0). TR2N leads to MNSMS-ABORT-Req, which then leads to SM-RL-REPORT-Ind, then IDLE (0). + +**SMR-entity on Network-side +MO Short Message and Notification transfer +SDL-5** + +![State transition diagram for SMR-entity on Network-side. It features three states: 0 IDLE (initial state with a self-loop), 1 Wait for RP-ACK, and 3 Wait to send RP-ACK. Transitions are: 0 to 1, 1 to 0, 0 to 3, and 3 to 0.](92724c769da9d46b730fde1a6dccb023_img.jpg) + +``` +stateDiagram-v2 + [*] --> 0 + 0 --> 0 + 0 --> 1 + 1 --> 0 + 0 --> 3 + 3 --> 0 +``` + +The diagram illustrates a state machine with three states represented by circles. State 0 is labeled 'IDLE' and has a self-looping arrow at the top. State 1 is labeled 'Wait for RP-ACK' and is positioned at the bottom left. State 3 is labeled 'Wait to send RP-ACK' and is positioned at the bottom right. Arrows indicate the following transitions: from state 0 to state 1, from state 1 back to state 0, from state 0 to state 3, and from state 3 back to state 0. + +State transition diagram for SMR-entity on Network-side. It features three states: 0 IDLE (initial state with a self-loop), 1 Wait for RP-ACK, and 3 Wait to send RP-ACK. Transitions are: 0 to 1, 1 to 0, 0 to 3, and 3 to 0. + +**SMR-entity on Network-side +State transition diagram** + +# --- Annex E (informative): Cause definition + +## E-1: CP-cause definition. + +Cause no. 17: "Network failure". + +This cause is sent to the MS if the MSC cannot service an MS generated request because of PLMN failures, e.g. problems in MAP. + +Cause no. 22: "Congestion". + +This cause is sent if the service request cannot be actioned because of congestion (e.g. no channel, facility busy/congested etc.). + +Cause no. 81: "Invalid Transaction Identifier". + +This cause indicates that the equipment sending this cause has received a message with a Transaction Identifier which is currently not used on the MS - network interface. + +Cause no. 95: "Semantically incorrect message". + +This cause is used to report the receipt of a message with semantically incorrect content. + +Cause no. 96: "Invalid mandatory information". + +This cause indicates that the equipment sending this cause has received a message with non-semantical mandatory information element errors. + +Cause no. 97: "Message type non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message with a message type it does not recognize either because this is a message not defined or defined but not implemented by the equipment sending this cause. + +Cause no. 98: "Message not compatible with short message protocol state". + +This cause indicates that the equipment sending this cause has received a message not compatible with the Short Message protocol state. + +Cause no. 99: "Information element non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message which includes information elements not recognized because the information element identifier is not defined or it is defined but not implemented by the equipment sending the cause. + +However, the information element is not required to be present in the message in order for the equipment sending the cause to process the message. + +Cause no. 111: "Protocol error, unspecified". + +This cause is used to report a protocol error event only when no other cause applies. + +## E-2: RP-cause definition mobile originating SM-transfer. + +Cause no. 1: "Unassigned (unallocated) number". + +This cause indicates that the destination requested by the Mobile Station cannot be reached because, although the number is in a valid format, it is not currently assigned (allocated). + +Cause no. 8: "Operator determined barring". + +This cause indicates that the MS has tried to send a mobile originating short message when the MS's network operator or service provider has forbidden such transactions. + +### Cause no. 10: "Call barred". + +This cause indicates that the outgoing call barred service applies to the short message service for the called destination. + +### Cause no. 21: "Short message transfer rejected". + +This cause indicates that the equipment sending this cause does not wish to accept this short message, although it could have accepted the short message since the equipment sending this cause is neither busy nor incompatible. + +### Cause no. 27: "Destination out of service". + +This cause indicates that the destination indicated by the Mobile Station cannot be reached because the interface to the destination is not functioning correctly. The term "not functioning correctly" indicates that a signalling message was unable to be delivered to the remote user; e.g., a physical layer or data link layer failure at the remote user, user equipment off-line, etc. + +### Cause no. 28: "Unidentified subscriber". + +This cause indicates that the subscriber is not registered in the PLMN (i.e. IMSI not known). + +### Cause no. 29: "Facility rejected". + +This cause indicates that the facility requested by the Mobile Station is not supported by the PLMN. + +### Cause no. 30: "Unknown subscriber". + +This cause indicates that the subscriber is not registered in the HLR (i.e. IMSI or directory number is not allocated to a subscriber). + +Cause no. 38: "Network out of order". + +This cause indicates that the network is not functioning correctly and that the condition is likely to last a relatively long period of time; e.g., immediately reattempting the short message transfer is not likely to be successful. + +Cause no. 41: "Temporary failure". + +This cause indicates that the network is not functioning correctly and that the condition is not likely to last a long period of time; e.g., the Mobile Station may wish to try another short message transfer attempt almost immediately. + +Cause no. 42: "Congestion". + +This cause indicates that the short message service cannot be serviced because of high traffic. + +Cause no. 47: "Resources unavailable, unspecified". + +This cause is used to report a resource unavailable event only when no other cause applies. + +Cause no. 50: "Requested facility not subscribed". + +This cause indicates that the requested short message service could not be provided by the network because the user has not completed the necessary administrative arrangements with its supporting networks. + +Cause no. 69: "Requested facility not implemented". + +This cause indicates that the network is unable to provide the requested short message service. + +Cause no. 81: "Invalid short message transfer reference value". + +This cause indicates that the equipment sending this cause has received a message with a short message reference which is not currently in use on the MS-network interface. + +Cause no. 95: "Invalid message, unspecified". + +This cause is used to report an invalid message event only when no other cause in the invalid message class applies. + +Cause no. 96: "Invalid mandatory information". + +This cause indicates that the equipment sending this cause has received a message where a mandatory information element is missing and/or has a content error (the two cases are indistinguishable). + +Cause no. 97: "Message type non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message with a message type it does not recognize either because this is a message not defined or defined but not implemented by the equipment sending this cause. + +Cause no. 98: "Message not compatible with short message protocol state". + +This cause indicates that the equipment sending this cause has received a message such that the procedures do not indicate that this is a permissible message to receive while in the short message transfer state. + +Cause no. 99: "Information element non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message which includes information elements not recognized because the information element identifier is not defined or it is defined but not implemented by the equipment sending the cause. + +However, the information element is not required to be present in the message in order for the equipment sending the cause to process the message. + +Cause no. 111: "Protocol error, unspecified". + +This cause is used to report a protocol error event only when no other cause applies. + +Cause no. 127: "Interworking, unspecified". + +This cause indicates that there has been interworking with a network which does not provide causes for actions it takes; thus, the precise cause for a message which is being sent cannot be ascertained. + +E-3: RP-cause definition mobile terminating SM-transfer. + +Cause no. 22: "Memory capacity exceeded". + +This cause indicates that the mobile station cannot store the incoming short message due to lack of storage capacity. + +Cause no. 81: "Invalid short message reference value". + +This cause indicates that the equipment sending this cause has received a message with a short message reference which is not currently in use on the MS-network interface. + +Cause no. 95: "Invalid message, unspecified". + +This cause is used to report an invalid message event only when no other cause in the invalid message class applies. + +Cause no. 96: "Invalid mandatory information". + +This cause indicates that the equipment sending this cause has received a message where a mandatory information element is missing and/or has a content error (the two cases are indistinguishable). + +Cause no. 97: "Message type non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message with a message type it does not recognize either because this is a message not defined or defined but not implemented by the equipment sending this cause. + +Cause no. 98: "Message not compatible with short message protocol state". + +This cause indicates that the equipment sending this cause has received a message such that the procedures do not indicate that this is a permissible message to receive while in the short message transfer state. + +Cause no. 99: "Information element non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message which includes information elements not recognized because the information element identifier is not defined or it is defined but not implemented by the equipment sending the cause. + +However, the information element is not required to be present in the message in order for the equipment sending the cause to process the message. + +Cause no. 111: "Protocol error, unspecified". + +This cause is used to report a protocol error event only when no other cause applies. + +E-4: RP-Cause definition memory available notification. + +Cause no. 30: "Unknown Subscriber". + +This cause indicates that the subscriber is not registered in the HLR (i.e. IMSI or directory number is not allocated to a subscriber). + +Cause no. 38: "Network out of order". + +This cause indicates that the network is not functioning correctly and that the condition is likely to last a relatively long period of time; e.g., immediately reattempting the short message transfer is not likely to be successful. + +Cause no. 41: "Temporary failure". + +This cause indicates that the network is not functioning correctly and that the condition is not likely to last a long period of time; e.g., the Mobile Station may wish to try another short message transfer attempt almost immediately. + +Cause no. 42: "Congestion". + +This cause indicates that the short message service cannot be serviced because of high traffic. + +Cause no. 47: "Resources unavailable, unspecified". + +This cause is used to report a resource unavailable event only when no other cause applies. + +Cause no. 69: "Requested facility not implemented". + +This cause indicates that the network is unable to provide the requested memory available notification service. + +Cause no. 95: "Invalid message, unspecified". + +This cause is used to report an invalid message event only when no other cause in the invalid message class applies. + +Cause no. 96: "Invalid mandatory information". + +This cause indicates that the equipment sending this cause has received a message where a mandatory information element is missing and/or has a content error (the two cases are indistinguishable). + +Cause no. 97: "Message type non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message with a message type it does not recognize either because this is a message not defined or defined but not implemented by the equipment sending this cause. + +Cause no. 98: "Message not compatible with short message protocol state". + +This cause indicates that the equipment sending this cause has received a message such that the procedures do not indicate that this is a permissible message to receive while in the short message transfer state. + +Cause no. 99: "Information element non-existent or not implemented". + +This cause indicates that the equipment sending this cause has received a message which includes information elements not recognized because the information element identifier is not defined or it is defined but not implemented by the equipment sending the cause. + +However, the information element is not required to be present in the message in order for the equipment sending the cause to process the message. + +Cause no. 111: "Protocol error, unspecified". + +This cause is used to report a protocol error event only when no other cause applies. + +Cause no. 127: "Interworking, unspecified". + +This cause indicates that there has been interworking with a network which does not provide causes for actions it takes; thus, the precise cause for a message which is being send cannot be ascertained. + +--- + +## Annex F (informative): LAPDm SAPI 3 handling for short message service + +This annex describes several typical SMS message transfer scenarios for circuit switched GSM. + +For GPRS SMS transfer, refer to 3GPP TS 23.060 [3a] for channel set up and upper layer message flow. + +Case A: Mobile originating short message transfer, no parallel call. + +The mobile station side will initiate SAPI 3 establishment by a SABM command on the SDCCH after the cipher mode has been set. If no hand over occurs, the SAPI 3 link will stay up until the last CP-ACK is received by the MSC, and the clearing procedure is invoked. + +Case B: Mobile terminating short message transfer, no parallel call. + +The network side, i.e. the BSS will initiate SAPI3 establishment by a SABM command on the SDCCH when the first CP-Data message is received from the MSC. If no hand over occurs, the link will stay up until the MSC has given the last CP-ack and invokes the clearing procedure. + +Case C: Mobile originating short message transfer, parallel call. + +The mobile station will send a SABM command on the SACCH when a CM\_SERV\_ACC message has been received from the network, allowing the short message transfer to start. If no hand over occurs the link will stay up until the MSC orders a explicit release, or the clearing procedure is invoked. If the parallel call is cleared before the short message transfer is finalized, the MSC will delay the clearing procedure toward the BSS, i.e. the channel release procedure is delayed. + +Case D: Mobile terminating short message transfer, parallel call. + +The network side, i.e. the BSS will initiate SAPI3 establishment by a SABM command on the SACCH when the first CP-DATA message is received from the MSC. The further handling is exactly as described for case C. + +Case E: Mobile terminating short message transfer together with Inter-MSC hand over, parallel call. + +The MAP procedures "Forward access signalling" and "Process access signalling" will be used between the two MSCs to transfer the CP-DATA, CP-ACK and CP-ERROR messages. + +Case F: Mobile terminating short message transfer on SDCCH channel together with Inter-MSC hand over. + +The MAP procedures "Forward access signalling" and "Process access signalling" will be used between the two MSC's to transfer the CP-DATA, CP-ACK and CP-ERROR messages. + +![Sequence diagram showing Mobile originated Short Message on SDCCH. Lifelines: MS, BTS, BSC, MSC. The process involves channel request, activation, and subsequent data transfer on SDCCH.](93bd00a00fa28558486f0664550699b1_img.jpg) + +The sequence diagram illustrates the interaction for a mobile-originated short message on SDCCH. It begins with the MS sending a CHANNEL REQUEST on the RACH to the BTS. The BTS responds with a CHAN RQD to the BSC, which then sends CHAN ACTIV and CHAN ACTIV ACK back to the BTS. The BTS sends an IMM ASSIGN to the MS on the AGCH. Next, the MS sends a SABM (CM-SERV-REQ) on the SDCCH to the BTS. The BTS sends an EST IND (CM-SERV-REQ) to the BSC, which in turn sends a CR (CM-SERV-REQ) to the MSC. The MS then sends a UA (CM-SERV-REQ) to the BTS. The BSC sends a CC (AUTH REQ) to the MSC, which returns an AUTH RES. The MSC sends a CIPH MODE CMD to the BSC, which sends an ENCR CMD to the BTS, which then sends a CIPH MODE CMD to the MS. The MS sends a CIPH MODE COM to the BTS. The BTS sends an EST IND (SAPI=3) to the BSC, which sends a SABM (SAPI=3) to the MS. The MS sends a UA (SAPI=3) to the BTS. The MS then sends CP-DATA to the BTS, which is forwarded to the SC. The SC returns CP-ACK, which is forwarded back to the MS. The MS sends another CP-DATA to the BTS, which is forwarded to the SC. The SC returns CP-ACK, which is forwarded back to the MS. The MS sends a CHAN RELEASE to the BTS. The BSC sends a CLEAR CMD to the MSC. The BTS sends a DEACT SACCH to the BSC. The MS sends a DISC (SAPI=0) to the BTS. The BSC sends a REL IND to the MS. The MS sends a UA (SAPI=0) to the BTS. Finally, the MS performs a Local release SAPI=3, and the BTS sends an RF CHAN REL to the BSC, which sends a CLEAR COM to the MSC. + +``` +sequenceDiagram + participant MS + participant BTS + participant BSC + participant MSC + Note left of MS: CHANNEL: RACH + MS->>BTS: CHANNEL REQUEST + BTS->>BSC: CHAN RQD + BSC->>BTS: CHAN ACTIV + BTS->>BSC: CHAN ACTIV ACK + Note left of MS: AGCH + BTS->>MS: IMM ASSIGN + Note left of MS: SDCCH + MS->>BTS: SABM (CM-SERV-REQ) + BTS->>BSC: EST IND (CM-SERV-REQ) + BSC->>MSC: CR (CM-SERV-REQ) + MS->>BTS: UA (CM-SERV-REQ) + BSC->>MSC: CC (AUTH REQ) + MSC->>MS: AUTH RES + MSC->>BSC: CIPH MODE CMD + BSC->>BTS: ENCR CMD + BTS->>MS: CIPH MODE CMD + MS->>BTS: CIPH MODE COM + BTS->>BSC: EST IND (SAPI=3) + BSC->>MS: SABM (SAPI=3) + MS->>BTS: UA (SAPI=3) + MS->>BTS: CP-DATA + Note right of MSC: To SC + MSC->>SC: + Note right of SC: From SC + SC->>MSC: + MSC->>MS: CP-ACK + MS->>BTS: CP-DATA + Note right of MSC: To SC + MSC->>SC: + Note right of SC: From SC + SC->>MSC: + MSC->>MS: CP-ACK + MS->>BTS: CHAN RELEASE + BSC->>MSC: CLEAR CMD + BTS->>BSC: DEACT SACCH + MS->>BTS: DISC (SAPI=0) + BSC->>MS: REL IND + MS->>BTS: UA (SAPI=0) + Note left of MS: Local release SAPI=3 + BTS->>BSC: RF CHAN REL + BSC->>MSC: CLEAR COM +``` + +Sequence diagram showing Mobile originated Short Message on SDCCH. Lifelines: MS, BTS, BSC, MSC. The process involves channel request, activation, and subsequent data transfer on SDCCH. + +Figure F1/3GPP TS 24.011: Mobile originated Short Message on SDCCH + +![Sequence diagram for Mobile terminated Short Message on SDCCH. Lifelines: MS, BTS, BSC, MSC. The diagram shows the interaction between these entities for delivering a short message to the mobile station.](d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg) + +``` + +sequenceDiagram + participant MS + participant BTS + participant BSC + participant MSC + Note left of MS: CHANNEL: +PCH +RACH +AGCH +SDCCH + + Note right of MSC: From SC + + MSC->>BSC: PAGING + BSC->>BTS: PAGING COMMAND + BTS->>MS: PAGE REQUEST + MS->>BTS: CHANNEL REQUEST + BTS->>BSC: CHAN RQD + BSC->>BTS: CHAN ACTIV + BTS->>BSC: CHAN ACTIV ACK + BSC->>MS: IMM ASSIGN + MS->>BTS: SABM (PAGE RESP) + BTS->>BSC: EST IND (PAGE RESP) + BSC->>MSC: CR (PAGE RESP) + MS->>BTS: UA (PAGE RESP) + MS->>BSC: AUTH REQ + BSC->>MSC: CC (AUTH REQ) + MSC->>MS: AUTH RES + MS->>BTS: CIPH MODE CMD + BTS->>BSC: ENCR CMD + BSC->>MSC: CIPH MODE CMD + MSC->>BSC: CIPH MODE COM + BSC->>BTS: CIPH MODE COM + MS->>BTS: SABM (SAPI=3) + BTS->>BSC: EST REQ (SAPI=3) + BSC->>MSC: CP-DATA + MS->>BTS: UA (SAPI=3) + BTS->>BSC: EST CONF (SAPI=3) + BSC->>MS: CP-DATA + MS->>BSC: CP-ACK + BSC->>MSC: CP-DATA + MSC->>To SC: + MS->>BTS: CP-ACK + MS->>BTS: CHAN RELEASE + BSC->>MSC: CLEAR CMD + BTS->>BSC: DEACT SACCH + MS->>BTS: DISC (SAPI=0) + BTS->>BSC: REL IND (SAPI=0) + BSC->>MS: UA (SAPI=0) + Note left of MS: Local release +SAPI=3 + BTS->>BSC: RF CHAN REL + BSC->>MSC: CLEAR COM + +``` + +Sequence diagram for Mobile terminated Short Message on SDCCH. Lifelines: MS, BTS, BSC, MSC. The diagram shows the interaction between these entities for delivering a short message to the mobile station. + +Figure F2/3GPP TS 24.011: Mobile terminated Short Message on SDCCH + +![Sequence diagram showing Mobile originated Short Message on SACCH. Lifelines: MS, BTS, BSC, MSC. The diagram shows an 'ACTIVE CALL' phase, followed by FACCH messages (CM SERV REQ, CM SERV ACC), then SACCH messages (SABM, EST IND, UA, CP-DATA, CP-ACK) between MS and BSC, with data being forwarded to the SC via the MSC.](f4e5a86da5c799372a7c1ea2397dedb7_img.jpg) + +The diagram illustrates the interaction for a mobile-originated short message during an active call. It features four lifelines: MS (Mobile Station), BTS (Base Transceiver Station), BSC (Base Station Controller), and MSC (Mobile Switching Center). The process begins with an 'ACTIVE CALL' phase spanning across all lifelines. Following this, the MS sends a 'CM SERV REQ' on the FACCH to the MSC. The MSC responds with 'CM SERV ACC' on the FACCH back to the MS. The MS then initiates the SACCH procedure by sending 'SABM (SAPI=3)' to the BTS. The BTS forwards this as 'EST IND (SAPI=3)' to the BSC. The MS receives 'UA (SAPI=3)' from the BTS. Data transfer begins with 'CP-DATA' from the MS to the MSC (which then goes 'To SC'), followed by 'CP-ACK' from the MS to the BTS. The SC sends 'CP-DATA' 'From SC' to the MSC, which is then received by the MS as 'CP-ACK'. The sequence concludes with another 'ACTIVE CALL' phase. + +``` +sequenceDiagram + participant MS + participant BTS + participant BSC + participant MSC + Note over MS, BSC: ACTIVE CALL + MS->>MSC: CM SERV REQ (FACCH) + MSC-->>MS: CM SERV ACC (FACCH) + MS->>BTS: SABM (SAPI=3) (SACCH) + BTS->>BSC: EST IND (SAPI=3) (SACCH) + MS-->>BTS: UA (SAPI=3) (SACCH) + MS->>MSC: CP-DATA (SACCH) + Note right of MSC: To SC + MSC-->>BTS: CP-ACK (SACCH) + Note right of MSC: From SC + MSC->>MS: CP-DATA (SACCH) + MS-->>MSC: CP-ACK (SACCH) + Note over MS, BSC: ACTIVE CALL +``` + +Sequence diagram showing Mobile originated Short Message on SACCH. Lifelines: MS, BTS, BSC, MSC. The diagram shows an 'ACTIVE CALL' phase, followed by FACCH messages (CM SERV REQ, CM SERV ACC), then SACCH messages (SABM, EST IND, UA, CP-DATA, CP-ACK) between MS and BSC, with data being forwarded to the SC via the MSC. + +Figure F3/3GPP TS 24.011: Mobile originated Short Message on SACCH + +![Sequence diagram showing Mobile terminated Short Message on SACCH. Lifelines: MS, BTS, BSC, MSC. The diagram shows an 'ACTIVE CALL' phase, followed by a message exchange on the SACCH channel involving SABM, UA, CP-DATA, and CP-ACK messages between the MS and BSC, with the BSC receiving CP-DATA from the MSC (From SC) and sending it to the MS (To SC).](9ba75f891de20483c291538e38701d96_img.jpg) + +The diagram illustrates the interaction for a mobile terminated short message (MT-SM) over the SACCH channel during an active call. The lifelines are MS (Mobile Station), BTS (Base Transceiver Station), BSC (Base Station Controller), and MSC (Mobile Switching Center). The process starts with an 'ACTIVE CALL' phase. When a short message arrives at the MSC from the SC (From SC), it is sent as CP-DATA to the BSC. The BSC then initiates the transfer to the MS using a SABM (SAPI=3) frame on the SACCH. The MS responds with a UA (SAPI=3) frame. The BSC confirms the establishment to the MSC with an EST CONF (SAPI=3) message. The CP-DATA is then transferred from the BSC to the MS. The MS receives the CP-DATA and responds with a CP-ACK. The BSC receives the CP-ACK and forwards the CP-DATA to the MSC (To SC). The MSC receives the CP-DATA and responds with a CP-ACK. The BSC receives the CP-ACK and confirms the transfer to the MS. The MS receives the CP-ACK and the process ends with another 'ACTIVE CALL' phase. + +``` +sequenceDiagram + participant MS + participant BTS + participant BSC + participant MSC + Note over MS, BSC: ACTIVE CALL + Note right of MSC: From SC + MSC->>BSC: CP-DATA + BSC->>MS: SABM (SAPI=3) + MS-->>BSC: UA (SAPI=3) + BSC->>MSC: EST CONF (SAPI=3) + BSC->>MS: CP-DATA + MS-->>BSC: CP-ACK + BSC->>MSC: CP-DATA + Note right of MSC: To SC + MSC-->>BSC: CP-ACK + BSC-->>MS: CP-ACK + Note over MS, BSC: ACTIVE CALL +``` + +Sequence diagram showing Mobile terminated Short Message on SACCH. Lifelines: MS, BTS, BSC, MSC. The diagram shows an 'ACTIVE CALL' phase, followed by a message exchange on the SACCH channel involving SABM, UA, CP-DATA, and CP-ACK messages between the MS and BSC, with the BSC receiving CP-DATA from the MSC (From SC) and sending it to the MS (To SC). + +Figure F4/3GPP TS 24.011: Mobile terminated Short Message on SACCH + +![Sequence diagram of Inter/MSC handover during Short Message transfer on SACCH. Lifelines: MS, BTS-A, BSC-A, MSC-A, MSC-B, BSC-B, BTS-B, MS. The diagram shows the flow of signaling messages for a handover between two MSCs while a short message is being transferred on the SACCH channel.](61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg) + +The sequence diagram illustrates the Inter/MSC handover process during a Short Message transfer on the SACCH channel. The lifelines involved are MS, BTS-A, BSC-A, MSC-A, MSC-B, BSC-B, BTS-B, and MS. + +**Initial State:** The MS is sending CP-DATA on the SACCH channel. The MSC-A is forwarding this data to the SC (Service Center). The MSC-A receives a CP-ACK from the SC and sends it back to the MS via the SACCH channel. + +**Handover Initiation:** The BSC-A sends a HANDO RQD (Handover Request) to the MSC-A. The MSC-A sends a PREPARE HANDOVER message to the MSC-B. The MSC-B sends a HANDO RQT (Handover Request) to the BSC-B. The BSC-B sends a CHAN ACTIV (Channel Activation) message to the BTS-B. The BTS-B sends a CHAN ACT ACK (Channel Activation Acknowledge) message to the BSC-B. The BSC-B sends a HANDO RQT ACK (Handover Request Acknowledge) message to the MSC-B. The MSC-B sends a PREPARE HANDOVER ACK (Prepare Handover Acknowledge) message to the MSC-A. The MSC-A sends an IAM (Initial Address Message) to the MSC-B. The MSC-B sends an ACM (Answer Call Message) to the MSC-A. The MSC-A sends a HANDO CMD (Handover Command) to the BSC-A. The BSC-A sends a HANDO CMD to the BTS-A. The BTS-A sends a HANDO CMD to the MS. The MS sends a SUSPEND SAPI=0 and LOCAL REL SAPI=3 message to the BTS-A. + +**Access Signaling and Channel Switching:** The MSC-A sends a PROCESS ACCESS SIGNALLING message to the MSC-B. The MSC-B sends a HANDO DET (Handover Detection) message to the BSC-B. The BSC-B sends a HANDO DET message to the BTS-B. The BTS-B sends a PHYSICAL INF (Physical Information) message to the MS. The MS sends a SABM (SABM (SAPI=0)) message to the BTS-B. The BTS-B sends a UA (UA (SAPI=0)) message to the MS. The MS sends a HANDO COM (Handover Complete) message to the BTS-B. The BTS-B sends a HANDO COM message to the BSC-B. The BSC-B sends a SEND END SIGNAL message to the MSC-B. The MSC-B sends an ANSWER message to the MSC-A. The MSC-A sends a FROM SC (From Service Center) message to the MSC-B. The MSC-B sends a FORWARD ACCESS SIGNALLING message to the MSC-A. The MSC-A sends a CP-DATA message to the MSC-B. The MSC-B sends an EST REQ (3) (Establish Request (3)) message to the BSC-B. The BSC-B sends a SABM (SABM (SAPI=3)) message to the BTS-B. The BTS-B sends a UA (UA (SAPI=3)) message to the MS. The MS sends a CP-DATA message to the BTS-B. The BTS-B sends a CP-ACK message to the MS. The MSC-A sends a PROCESS ACCESS SIGNALLING message to the MSC-B. The MSC-A sends a TO SC (To Service Center) message to the MSC-B. + +**Resource Release:** The MSC-A sends a CLEAR CMD (Clear Command) message to the BSC-A. The BSC-A sends a REL RF CHAN (Release Radio Channel) message to the BTS-A. The BTS-A sends an RF CHAN REL ACK (Radio Channel Release Acknowledge) message to the BSC-A. The BSC-A sends a CLEAR COM (Clear Command) message to the MSC-A. + +Sequence diagram of Inter/MSC handover during Short Message transfer on SACCH. Lifelines: MS, BTS-A, BSC-A, MSC-A, MSC-B, BSC-B, BTS-B, MS. The diagram shows the flow of signaling messages for a handover between two MSCs while a short message is being transferred on the SACCH channel. + +Figure F5/3GPP TS 24.011: Inter/MSC handover during Short Message transfer on SACCH + +![Sequence diagram of Inter/MSC handover during Short Message transfer on SDCCH. Lifelines: MS, BTS-A, BSC-A, MSC-A, MSC-B, BSC-B, BTS-B, MS. The diagram shows the flow of messages for CP-DATA, CP-ACK, HANDO RQD, PREPARE HANDOVER, HANDO CMD, REL RF CHAN, CLEAR CMD, RF CHAN REL ACK, CLEAR COM, PROCESS ACCESS SIGNALLING, HANDO DET, EST IND(0), SABM (SAPI=0), UA (SAPI=0), HANDO ACC, PHYSICAL INF, HANDO COM, CP-DATA, EST REQ (3), EST CONF (3), SABM (SAPI=3), UA (SAPI=3), and To SC messages.](b02ba0b73e95416eb547976f6145b169_img.jpg) + +The sequence diagram illustrates the Inter/MSC handover process during Short Message transfer on SDCCH. The lifelines involved are MS, BTS-A, BSC-A, MSC-A, MSC-B, BSC-B, BTS-B, and MS. + +**Sequence of Messages:** + +- CHANNEL: SDCCH** + - MS → MSC-A: CP-DATA + - MSC-A → To SC: CP-DATA + - MSC-A → MS: CP-ACK +- BSC-A → MSC-A: HANDO RQD +- MSC-A → MSC-B: PREPARE HANDOVER +- MSC-B → BSC-B: HANDO RQT +- BSC-B → BTS-B: CHAN ACTIV +- BSC-B → MSC-B: CHAN ACT ACK +- MSC-B → MSC-A: HANDO RQT ACK +- MSC-A → BSC-A: PREPARE HANDOVER ACK +- BSC-A → MS: HANDO CMD +- MS → BTS-A: HANDO CMD +- BTS-A → BSC-A: REL RF CHAN +- BSC-A → MSC-A: CLEAR CMD +- BSC-A → BTS-A: RF CHAN REL ACK +- BSC-A → MSC-A: CLEAR COM +- MSC-A → To SC: Send end signal +- MSC-B → BSC-B: HANDO DET +- BSC-B → MSC-B: HANDO DET +- BSC-B → BTS-B: EST IND(0) +- BSC-B → BTS-B: SABM (SAPI=0) +- BTS-B → MS: PHYSICAL INF +- BTS-B → MS: UA (SAPI=0) +- BTS-B → MS: HANDO ACC +- MSC-B → MSC-A: HANDO COM +- MSC-A → From SC: CP-DATA +- MSC-A → BSC-B: FORWARD ACCESS SIGNALLING +- BSC-B → MSC-B: EST REQ (3) +- BSC-B → BTS-B: SABM (SAPI=3) +- BSC-B → BTS-B: EST CONF (3) +- BSC-B → BTS-B: UA (SAPI=3) +- BSC-B → BTS-B: CP-DATA +- BSC-B → BTS-B: CP-ACK +- MSC-A → To SC: PROCESS ACCESS SIGNALLING +- MSC-A → To SC: To SC + +Sequence diagram of Inter/MSC handover during Short Message transfer on SDCCH. Lifelines: MS, BTS-A, BSC-A, MSC-A, MSC-B, BSC-B, BTS-B, MS. The diagram shows the flow of messages for CP-DATA, CP-ACK, HANDO RQD, PREPARE HANDOVER, HANDO CMD, REL RF CHAN, CLEAR CMD, RF CHAN REL ACK, CLEAR COM, PROCESS ACCESS SIGNALLING, HANDO DET, EST IND(0), SABM (SAPI=0), UA (SAPI=0), HANDO ACC, PHYSICAL INF, HANDO COM, CP-DATA, EST REQ (3), EST CONF (3), SABM (SAPI=3), UA (SAPI=3), and To SC messages. + +Figure F6/3GPP TS 24.011: Inter/MSC handover during Short Message transfer on SDCCH + +## Annex G (informative): Change history + +| Change history | | | | | | | +|----------------|-----------|---------|-------|---------|-------------|--------------------------------------------------------------------------| +| TSG SA# | Spec | Version | CR | | New Version | Subject/Comment | +| Jun 1999 | GSM 04.11 | 7.0.0 | | | | Transferred to 3GPP CN1 | +| CN#04 | 24.011 | | | | 3.0.0 | Transferred to TSG CN at ETSI SMG#29.
Under TSG TSG CN Change Control | +| CN#06 | 24.011 | 3.0.0 | 001r6 | R99 | 3.1.0 | Using MM sublayer for PS-SMS message transfer | +| CN#07 | 24.011 | 3.1.0 | 003r1 | R99 | 3.2.0 | SMC-GP SDL modification to transfer SMS messages via GMM | +| CN#07 | 24.011 | 3.1.0 | 004r1 | R99 | 3.2.0 | Reintroduction of deleted arrow diagrams | +| CN#07 | 24.011 | 3.1.0 | 005 | R99 | 3.2.0 | Cleaning up the References | + +| TSGN | TSGN-number | WG Number | CR | Rev | Rel | Old version | New version | Title | WI | Date | +|-------|-------------|-----------|-----|-----|-------|-------------|-------------|--------------------------------------------------------------------------|----------|---------| +| CN#08 | NP-000273 | N1-000747 | 006 | 1 | R99 | C 3.2.0 | 3.3.0 | Alignment of SMS protocol with current MM/GMM integrity protection rules | Security | 06-2000 | +| CN#09 | NP-000440 | N1-000943 | 008 | | R99 | A 3.3.0 | 3.4.0 | Corrections of CP/RP-DATA IE lengths | TEI | 09-2000 | +| NP-10 | NP-000674 | N1-001376 | 011 | 1 | R99 | F 3.4.0 | 3.5.0 | Terminology CR | TEI | 12-2000 | +| NP-10 | NP-000673 | N1-001220 | 012 | | R99 | F 3.4.0 | 3.5.0 | Modifications of references | TEI | 12-2000 | +| NP-11 | NP-010206 | N1-010428 | 022 | | R99 | F 3.5.0 | 3.6.0 | Missing SMR state | TEI | 03-2001 | +| NP-11 | NP-010124 | N1-010066 | 021 | | Rel-4 | B 3.6.0 | 4.0.0 | Multipel SMS for PS in Iu mode | TEI4 | 03-2001 | +| NP-15 | NP-020040 | N1-020266 | 023 | | Rel-4 | F 4.0.0 | 4.1.0 | Fixing references to 04.08 and to other GSM TS/TRs | TEI4 | 03-2002 | +| NP-16 | | | | | Rel-5 | 4.1.0 | 5.0.0 | TSGN#16 decided to update this TS also to release 5. | | 06-2002 | +| NP-18 | NP-020570 | N1-022498 | 024 | 2 | Rel-5 | F 5.0.0 | 5.1.0 | SMS over GPRS disabled | TEI5 | 12-2002 | +| NP-20 | NP-030282 | N1-030925 | 027 | 2 | Rel-5 | F 5.1.0 | 5.2.0 | UE behaviour when sending SMS over GPRS | TEI5 | 06-2003 | +| NP-21 | NP-030420 | N1-031325 | 031 | | Rel-6 | F 5.2.0 | 6.0.0 | Unspecified SAPI value in RANAP message for MT SMS (Iu interface only) | TEI6 | 09-2003 | +| CP-28 | CP-050068 | C1-050546 | 033 | | Rel-6 | F 6.0.0 | 6.1.0 | Multiple SMS via Gb mode | TEI6 | 06-2005 | +| | | | | | | 6.1.0 | 7.0.0 | Upgraded to Rel-7 by MCC | | 06-2007 | +| | | | | | | 7.0.0 | 8.0.0 | Upgraded to Rel-8 by MCC | | 12-2008 | + +| | | | | | | | | | | | | +|-------|-----------|-----------|------|---|--------|---|--------|--------|-------------------------------------------------------------------------|---------------------------|---------| +| CP-43 | CP-090153 | C1-091384 | 0034 | 2 | Rel-8 | B | 8.0.0 | 8.1.0 | Support for SMS through the EPC | SAES-CSFB | 03-2009 | +| CP-43 | | | | | Rel-8 | | 8.0.0 | 8.1.0 | Editorial cleanup by MCC | | 03-2009 | +| CP-44 | CP-090404 | C1-091630 | 0036 | | Rel-8 | A | 8.1.0 | 8.2.0 | Wrong implementation of CR 24.011-001 rev 6 | TEI7 | 06-2009 | +| CP-44 | CP-090424 | C1-091863 | 0037 | | Rel-8 | F | 8.1.0 | 8.2.0 | Correction to RP-Error handling procedures | TEI8 | 06-2009 | +| CP-46 | | | | | Rel-9 | | 8.2.0 | 9.0.0 | Upgrade to Rel-9 by MCC | | 12-2009 | +| | | | | | Rel-9 | | 9.0.0 | 9.0.1 | Addition of missing fields in the change history | | 02-2010 | +| CP-51 | | | | | Rel-10 | | 9.0.1 | 10.0.0 | Upgrade to Rel-10 by MCC | | 03-2011 | +| CP-56 | CP-120315 | C1-122327 | 0038 | 4 | Rel-11 | B | 10.0.0 | 11.0.0 | Support of point to point direct SMS service via the MME | SIMTC-PS_Only, SAES2-CSFB | 06-2012 | +| CP-56 | CP-120315 | C1-122328 | 0039 | 4 | Rel-11 | B | 10.0.0 | 11.0.0 | MME CM-Layer SDL description when SMS in MME is used | SIMTC-PS_Only, SAES2-CSFB | 06-2012 | +| CP-56 | CP-120315 | C1-122431 | 0040 | 5 | Rel-11 | B | 10.0.0 | 11.0.0 | Transfer of SMS between the UE and the MME | SIMTC-PS_Only, SAES2-CSFB | 06-2012 | +| CP-56 | CP-120309 | C1-122383 | 0041 | 1 | Rel-11 | B | 10.0.0 | 11.0.0 | Missing CM-Layer SDL description on UE side for supporting SMS over SGs | TEI11 | 06-2012 | +| CP-57 | CP-120589 | C1-122722 | 0042 | | Rel-11 | B | 11.0.0 | 11.1.0 | SMS in MME terminology usage consistency | SIMTC-PS_Only | 09-2012 | +| CP-65 | | | | | | | 11.1.0 | 12.0.0 | Upgrade to Rel-12 by MCC | | 09-2014 | +| CP-70 | | | | | | | 12.0.0 | 13.0.0 | Upgrade to Rel-13 by MCC | | 12-2015 | +| CP-71 | CP-160071 | C1-161533 | 0044 | 5 | Rel-13 | B | 13.0.0 | 13.1.0 | SMS with no combined attach for CIoT device | CIoT-CT | 03-2016 | + +| Change history | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|----------------------------------------------------------------------------------------------------------------------|--------------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160489 | 0045 | 2 | F | RPDU transfer for EPS using Control Plane CLoT Optimization | 13.2.0 | +| 2016-12 | CT#74 | CP-160723 | 0046 | 2 | F | SMS timer extension to support NB-S1 mode | 13.3.0 | +| 2017-03 | CT#75 | CP-170110 | 0047 | 3 | F | SMS timer extension for the MS in WB-S1 mode | 13.4.0 | +| 2017-03 | CT#75 | CP-170110 | 0048 | 2 | B | CM layer SDL updates for SMS transfer using Control Plane CLoT Optimization | 13.4.0 | +| 2017-03 | CT#75 | CP-170110 | 0049 | | F | SMS arrow diagram for SMS transfer using Control Plane CLoT Optimization | 13.4.0 | +| 2017-03 | SA#75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-06 | CT#76 | CP-171092 | 0051 | 1 | F | Conditions on supporting SMS transfer when MS is attached for PS | 14.1.0 | +| 2017-12 | CT#78 | CP-173050 | 0054 | 2 | A | Correction to SMS timers in NB-IoT | 14.2.0 | +| 2017-12 | CT#78 | CP-173054 | 0056 | 1 | A | Correction to SMS timers for CE mode UE | 14.2.0 | +| 2018-03 | CT#79 | CP-180077 | 0057 | 1 | B | Support for SMS in 5GS | 15.0.0 | +| 2018-06 | CT#80 | CP-181058 | 0058 | 1 | C | Removal of one-step SMS | 15.1.0 | +| 2018-09 | CT#81 | CP-182122 | 0060 | | A | Correction on state transition diagrams for EPS when packet-switched service is used | 15.2.0 | +| 2018-09 | CT#81 | CP-182128 | 0061 | | F | SDL description CM layer for 5G | 15.2.0 | +| 2019-03 | CT#83 | CP-190100 | 0064 | 1 | F | Usage of trigger to establish a PDN connection of non-IP type using the default APN to send indication to ESM entity | 15.3.0 | +| 2020-06 | CT#88e | CP-201133 | 0066 | | F | SMS timer extension for the MS using CP CLoT 5GS optimization | 16.0.0 | +| 2020-06 | CT#88e | CP-201133 | 0067 | 1 | F | RPDU transfer for 5GS using Control Plane CLoT Optimization | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24072/1c953f32bd34345dfd68fddf8a3736d6_img.jpg b/marked/Rel-16/24_series/24072/1c953f32bd34345dfd68fddf8a3736d6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0a4dd50a02eb57f601296807680e0ca0352b1194 --- /dev/null +++ b/marked/Rel-16/24_series/24072/1c953f32bd34345dfd68fddf8a3736d6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:128ff58ed743ee6530c2418c814bafa0b099448cf949df86a690fac6b084ba58 +size 21596 diff --git a/marked/Rel-16/24_series/24072/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/24_series/24072/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5979c3cff7b7108df4d3c94551444f2cbf802370 --- /dev/null +++ b/marked/Rel-16/24_series/24072/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7df6de592cb5bf841a72f1d8f80a8a4650441b27cf1b79a764eea499944f881 +size 32724 diff --git a/marked/Rel-16/24_series/24072/f6d72d7c790e7f585532140f3971639a_img.jpg b/marked/Rel-16/24_series/24072/f6d72d7c790e7f585532140f3971639a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..690a8ac0cbcb90d88c0a86fa09a9545e85e88d6c --- /dev/null +++ b/marked/Rel-16/24_series/24072/f6d72d7c790e7f585532140f3971639a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8e542367962f6df7d8e40fdb118557b62ce6e66237a89056f9d2b6d259df86a +size 73311 diff --git a/marked/Rel-16/24_series/24072/raw.md b/marked/Rel-16/24_series/24072/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..eaf7a2c2ee50cf286b83f21b030ffbba33953136 --- /dev/null +++ b/marked/Rel-16/24_series/24072/raw.md @@ -0,0 +1,194 @@ + + + + + + +# --- Contents + +- Foreword ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Abbreviations ..... 5 +- 4 Call Deflection (CD)..... 6 + - 4.1 Normal operation..... 6 + - 4.1.1 Served mobile subscriber side..... 6 + - 4.1.2 Deflected-to mobile subscriber side ..... 7 + - 4.1.3 Calling mobile subscriber side ..... 7 +- Annex A (informative): Change history..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS describes procedures on the radio interface for the call deflection supplementary service within the 3GPP system. + +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: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# --- 1 Scope + +This Global System for Mobile communications Technical Specification specifies the procedures used at the radio interface (reference point Um as defined in 3GPP TS 24.002) for normal operation of Call Deflection (CD) supplementary service. Provision and withdrawal of supplementary services is an administrative matter between the mobile subscriber and the service provider and cause no signalling on the radio interface. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.072: "Call Deflection (CD) supplementary service Stage 1". +- [3] 3GPP TS 24.002: "GSM Public Land Mobile Network (PLMN) access reference configuration". +- [4] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [5] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". + +# --- 3 Definitions and abbreviations + +## 3.1 Abbreviations + +Abbreviations used in this specification are listed in 3GPP TS 21.905. + +# --- 4 Call Deflection (CD) + +## 4.1 Normal operation + +### 4.1.1 Served mobile subscriber side + +The served mobile subscriber may invoke the call deflection supplementary service if an incoming call is offered. According to 3GPP TS 22.072 this may happen as an automatic response from the mobile station if the call is offered or as the result of a subscriber action. + +The mobile station shall invoke the call deflection supplementary service by initiating call clearing with a DISCONNECT message including the call deflection request (refer to figure 4.1). The call deflection request shall contain the DeflectedToNumber which may be accompanied by a DeflectedToSubAddress. + +The MS may invoke the call deflection supplementary service at every time after call confirmation until the call is accepted (refer to 3GPP TS 24.008). If the network accepts the call deflection request, it shall continue call clearing. The result indication shall be returned to the mobile station in the RELEASE message. + +If the network cannot accept the call deflection request, it shall continue call clearing. The corresponding error indication shall be returned to the mobile station in the RELEASE message. Error values are specified in 3GPP TS 24.080. + +During the call deflection request the MS shall run a timer TCD. This timer is started when the call deflection request is sent and stopped when a response is received from the network. If this timer expires the MS shall assume that the call deflection request has failed, locally release the invokeID, inform the user of the failure and continue call clearing as defined in 3GPP TS 24.008. + +![Sequence diagram illustrating the call deflection invocation for an incoming call between a Mobile Station (MS) and a Network.](f6d72d7c790e7f585532140f3971639a_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: SETUP + Network-->>MS: + Note over MS, Network: CALL CONFIRMED + MS-->>Network: + Note over MS, Network: • +• +• + Note over MS, Network: DISCONNECT + MS-->>Network: + Note over MS, Network: Facility (Invoke = CallDeflection (DeflectedToNumber, DeflectedToSubAddress)) + Network-->>MS: + Note over MS, Network: RELEASE + MS-->>Network: + Note over MS, Network: Facility (Return result) + Network-->>MS: + Note over MS, Network: RELEASE + MS-->>Network: + Note over MS, Network: Facility (Return error (Error)) + Network-->>MS: + Note over MS, Network: RELEASE + MS-->>Network: + Note over MS, Network: Facility (Reject = (Invoke Problem)) + Network-->>MS: + Note over MS, Network: RELEASE COMPLETE + MS-->>Network: + +``` + +Sequence diagram illustrating the call deflection invocation for an incoming call between a Mobile Station (MS) and a Network. + +**Figure 4.1: Call deflection invocation for an incoming call** + +### 4.1.2 Deflected-to mobile subscriber side + +As for the call forwarding supplementary services the deflected-to mobile subscriber will receive a NotifySS operation containing the SS Notification indicating that the incoming call is a forwarded call. When available, the SS Code of the Call Deflection supplementary service is included, see figure 4.2. + +When multiple diversions occurs the value of the SS Code shall relate to the last invoked diversion service. + +In addition the deflected-to subscriber will receive the redirecting party BCD number and optionally, a redirecting party subaddress. + +The redirecting party BCD number information element is made up of a number of information units as defined in 3GPP TS 24.008. + +In addition to or instead of the redirecting party's digits, the subscriber may be given the following information: + +- screening indicator; +- presentation indicator. + +Indicator values are given in 3GPP TS 24.008. + +The redirecting party subaddress information element is made up of a number of information units as defined in 3GPP TS 24.008. + +![Sequence diagram showing a SETUP message from Network to MS with Facility (Invoke = NotifySS (CD, SS-Notification)), Redirecting party BCD number (screening indicator, presentation indicator, redirecting party digits), and Redirecting party subaddress.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +MS Network + +SETUP + +<----- + +Facility (Invoke = NotifySS (CD, SS-Notification)), +Redirecting party BCD number (screening indicator, presentation indicator, redirecting party digits), +Redirecting party subaddress + +Sequence diagram showing a SETUP message from Network to MS with Facility (Invoke = NotifySS (CD, SS-Notification)), Redirecting party BCD number (screening indicator, presentation indicator, redirecting party digits), and Redirecting party subaddress. + +**Figure 4.2: Notification to the forwarded to mobile subscriber that the incoming call is a forwarded call** + +### 4.1.3 Calling mobile subscriber side + +As a subscription option, the served mobile subscriber can request that the calling mobile subscriber receives a NotifySS operation containing the SS Notification indicating that the call has been deflected. When available, the SS Code of the call deflection supplementary service is included, see figure 4.3. + +![Sequence diagram showing a SETUP message from MS to Network followed by a FACILITY message from Network to MS with Facility (Invoke = NotifySS (CD, SS-Notification)).](1c953f32bd34345dfd68fddf8a3736d6_img.jpg) + +MS Network + +SETUP + +-----> + +FACILITY + +<----- + +Facility (Invoke = NotifySS (CD, SS-Notification)) + +Sequence diagram showing a SETUP message from MS to Network followed by a FACILITY message from Network to MS with Facility (Invoke = NotifySS (CD, SS-Notification)). + +**Figure 4.3: Notification to the calling mobile subscriber that the call is forwarded** + +# --- Annex A (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|----------|-----------|----|---------|-------------|--------------------------------| +| Apr 1999 | GSM 04.72 | | | | Transferred to 3GPP CN1 | +| CN#03 | 24.072 | | R99 | 3.0.0 | Approved at CN#03 | +| CN#11 | 24.072 | | Rel-4 | 4.0.0 | Release 4 after CN#11 | +| CN#15 | 24.072 | | Rel-4 | 4.0.1 | References updated | +| CN#16 | 24.072 | | Rel-5 | 5.0.0 | Release 5 after CN#16 | +| CN#26 | 24.072 | | Rel-6 | 6.0.0 | Release 6 after CN#26 | +| CT#36 | 24.072 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 24.072 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 24.072 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 24.072 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2012-09 | 24.072 | - | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 24.072 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 24.072 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 24.072 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 24.072 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 24.072 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24080/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/24_series/24080/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d190f74f5c903a26929f59c4079db7fcd5dcb08c --- /dev/null +++ b/marked/Rel-16/24_series/24080/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddb866f3ab5252b6a6538392c2577aff2e49e2157207ae00f24795f0fb0e21d4 +size 9471 diff --git a/marked/Rel-16/24_series/24080/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/24_series/24080/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b99d1e354c5b7c9c96e6ecfb04026097b54cfcd9 --- /dev/null +++ b/marked/Rel-16/24_series/24080/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f4df63415fad68585d88be02a3bbe4615486f77e8559f33f75a2bb5eb748b7f1 +size 5841 diff --git a/marked/Rel-16/24_series/24080/raw.md b/marked/Rel-16/24_series/24080/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0440406a768959e4ed276f7abf52f63fd12c1441 --- /dev/null +++ b/marked/Rel-16/24_series/24080/raw.md @@ -0,0 +1,2839 @@ + + +# 3GPP TS 24.080 V16.5.0 (2022-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mobile radio interface layer 3 Supplementary services specification; Formats and coding (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" is a green graphic element consisting of three curved lines of increasing height, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected at the top by a single horizontal line. Below the "P" is a red graphic element consisting of three curved lines of increasing height, resembling a signal strength indicator or a stylized wave. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 1.1 References ..... | 8 | +| 1.2 Abbreviations ..... | 9 | +| 2 Message functional definitions and contents ..... | 9 | +| 2.1 General ..... | 9 | +| 2.2 Messages for supplementary services control..... | 10 | +| 2.3 Facility..... | 10 | +| 2.4 Register..... | 10 | +| 2.4.1 Register (network to MS direction)..... | 10 | +| 2.4.2 Register (MS to network direction)..... | 11 | +| 2.4.2.1 SS version ..... | 11 | +| 2.5 Release complete..... | 11 | +| 2.5.1 Cause ..... | 12 | +| 2.5.2 Facility ..... | 12 | +| 3 General message format and information elements coding..... | 12 | +| 3.1 Overview ..... | 12 | +| 3.2 Protocol discriminator ..... | 12 | +| 3.3 Transaction identifier ..... | 12 | +| 3.4 Message type..... | 13 | +| 3.5 Other information elements..... | 13 | +| 3.6 Facility information element ..... | 13 | +| 3.6.1 Component (octet 3 etc.) ..... | 14 | +| 3.6.2 Component type tag..... | 15 | +| 3.6.3 Component ID tag ..... | 15 | +| 3.6.4 Operation Code..... | 16 | +| 3.6.5 Sequence and Set tags ..... | 16 | +| 3.6.6 Error Code ..... | 16 | +| 3.6.7 Problem Code ..... | 17 | +| 3.7 Version handling for supplementary services ..... | 18 | +| 3.7.1 Supplementary service screening indicator ..... | 18 | +| 3.7.2 Supplementary service version indicator..... | 18 | +| 4 Supplementary services operation specifications ..... | 19 | +| 4.1 General ..... | 19 | +| 4.2 Operation types ..... | 19 | +| 4.2.1 Void ..... | 25 | +| 4.2.2 Operations description..... | 25 | +| 4.2.2.1 registerSS (MS --> network)..... | 25 | +| 4.2.2.2 eraseSS (MS --> network) ..... | 25 | +| 4.2.2.3 activateSS (MS --> network) ..... | 25 | +| 4.2.2.4 deactivateSS (MS --> network) ..... | 25 | +| 4.2.2.5 interrogateSS (MS --> network) ..... | 25 | +| 4.2.2.6 notifySS (network --> MS) ..... | 25 | +| 4.2.2.7 registerPassword (MS --> network)..... | 25 | +| 4.2.2.8 getPassword (network --> MS)..... | 26 | +| 4.2.2.9 processUnstructuredSS-Data (MS --> network)..... | 26 | +| 4.2.2.10 processUnstructuredSS-Request (MS --> network) ..... | 26 | +| 4.2.2.11 unstructuredSS-Request (network --> MS) ..... | 26 | +| 4.2.2.12 unstructuredSS-Notify (network --> MS)..... | 26 | +| 4.2.2.13 forwardCheckSSIndication (network --> MS) ..... | 26 | +| 4.2.2.14 forwardChargeAdvice (network --> MS) ..... | 26 | +| 4.2.2.15 buildMPTY (MS --> network)..... | 26 | +| 4.2.2.16 holdMPTY (MS --> network)..... | 26 | +| 4.2.2.17 retrieveMPTY (MS --> network)..... | 26 | +| 4.2.2.18 splitMPTY (MS --> network)..... | 26 | + +| | | | +|----------|---------------------------------------------------------|----| +| 4.2.2.19 | forwardCUG-Info (MS --> network) ..... | 26 | +| 4.2.2.20 | explicitCT (MS --> Network) ..... | 26 | +| 4.2.2.21 | accessRegisterCCEntry (MS --> Network) ..... | 27 | +| 4.2.2.22 | callDeflection (MS --> Network) ..... | 27 | +| 4.2.2.23 | userUserService (MS --> Network, Network --> MS) ..... | 27 | +| 4.2.2.24 | lcs-LocationNotification (network --> MS) ..... | 27 | +| 4.2.2.25 | lcs-MOLR (MS --> Network) ..... | 27 | +| 4.2.2.26 | lcs-AreaEventRequest (network --> MS) ..... | 27 | +| 4.2.2.27 | lcs-AreaEventReport (MS --> network) ..... | 27 | +| 4.2.2.28 | lcs-AreaEventCancellation (network --> MS) ..... | 27 | +| 4.2.2.29 | lcs-PeriodicLocationRequest (network --> MS) ..... | 27 | +| 4.2.2.30 | lcs-LocationUpdate (network --> MS) ..... | 27 | +| 4.2.2.31 | lcs-PeriodicLocationCancellation (network --> MS) ..... | 27 | +| 4.2.2.32 | lcs-PeriodicTriggeredInvoke (network --> MS) ..... | 28 | +| 4.2.2.33 | lcs-EventReport (MS --> Network) ..... | 28 | +| 4.2.2.34 | lcs-CancelDeferredLocation (network --> MS) ..... | 28 | +| 4.2.2.35 | lcs-MSCancelDeferredLocation (MS --> network) ..... | 28 | +| 4.2.2.36 | lcs-LocationPrivacySetting (MS --> network) ..... | 28 | +| 4.3 | Errors ..... | 28 | +| 4.3.1 | Errors ASN.1 specification ..... | 28 | +| 4.3.2 | Errors description ..... | 29 | +| 4.3.2.1 | unknownSubscriber ..... | 29 | +| 4.3.2.2 | bearerServiceNotProvisioned ..... | 29 | +| 4.3.2.3 | teleServiceNotProvisioned ..... | 29 | +| 4.3.2.4 | illegalSS-Operation ..... | 29 | +| 4.3.2.5 | ss-ErrorStatus ..... | 29 | +| 4.3.2.6 | ss-NotAvailable ..... | 29 | +| 4.3.2.7 | ss-SubscriptionViolation ..... | 29 | +| 4.3.2.8 | ss-Incompatibility ..... | 29 | +| 4.3.2.9 | systemFailure ..... | 30 | +| 4.3.2.10 | dataMissing ..... | 30 | +| 4.3.2.11 | unexpectedDataValue ..... | 30 | +| 4.3.2.12 | passwordRegistrationFailure ..... | 30 | +| 4.3.2.13 | negativePasswordCheck ..... | 30 | +| 4.3.2.14 | facilityNotSupported ..... | 30 | +| 4.3.2.15 | resourcesNotAvailable ..... | 30 | +| 4.3.2.16 | maxNumberOfMPPTY-ParticipantsExceeded ..... | 30 | +| 4.3.2.17 | callBarred ..... | 30 | +| 4.3.2.18 | numberOfPW-AttemptsViolation ..... | 30 | +| 4.3.2.19 | absentSubscriber ..... | 30 | +| 4.3.2.20 | illegalSubscriber ..... | 30 | +| 4.3.2.21 | illegalEquipment ..... | 31 | +| 4.3.2.22 | ussd-Busy ..... | 31 | +| 4.3.2.23 | unknownAlphabet ..... | 31 | +| 4.3.2.24 | invalidDeflectedToNumber ..... | 31 | +| 4.3.2.25 | specialServiceCode ..... | 31 | +| 4.3.2.26 | deflectionToServedSubscriber ..... | 31 | +| 4.3.2.27 | rejectedByNetwork ..... | 31 | +| 4.3.2.28 | rejectedByUser ..... | 31 | +| 4.3.2.29 | positionMethodFailure ..... | 31 | +| 4.3.2.30 | resourceLimitation ..... | 31 | +| 4.4 | Data types and identifiers ..... | 31 | +| 4.4.1 | General ..... | 31 | +| 4.4.2 | ASN.1 data types ..... | 32 | +| 4.4.3 | Identifiers definition ..... | 41 | +| 4.4.3.1 | chargingInformation ..... | 41 | +| 4.4.3.2 | e1 ..... | 41 | +| 4.4.3.3 | e2 ..... | 41 | +| 4.4.3.4 | e3 ..... | 41 | +| 4.4.3.5 | e4 ..... | 41 | +| 4.4.3.6 | e5 ..... | 41 | +| 4.4.3.7 | e6 ..... | 42 | + +| | | | +|----------|-------------------------------------------|----| +| 4.4.3.8 | e7..... | 42 | +| 4.4.3.9 | ss-Code..... | 42 | +| 4.4.3.10 | ss-Notification..... | 42 | +| 4.4.3.11 | ss-Status ..... | 42 | +| 4.4.3.12 | callIsWaiting-Indicator ..... | 42 | +| 4.4.3.13 | callOnhold-Indicator ..... | 42 | +| 4.4.3.14 | mpty-Indicator ..... | 42 | +| 4.4.3.15 | forwardCUG-InfoArg ..... | 42 | +| 4.4.3.16 | cug-Index ..... | 42 | +| 4.4.3.17 | suppressPrefCUG..... | 42 | +| 4.4.3.18 | suppressOA..... | 42 | +| 4.4.3.19 | clrSuppressionRejected..... | 43 | +| 4.4.3.20 | ect-Indicator ..... | 43 | +| 4.4.3.21 | ect-CallState..... | 43 | +| 4.4.3.22 | rdn ..... | 43 | +| 4.4.3.23 | presentationAllowedAddress ..... | 43 | +| 4.4.3.24 | presentationRestricted..... | 43 | +| 4.4.3.25 | numberNotAvailableDueToInterworking..... | 43 | +| 4.4.3.26 | presentationRestrictedAddress..... | 43 | +| 4.4.3.27 | partyNumber ..... | 43 | +| 4.4.3.28 | partyNumberSubaddress ..... | 43 | +| 4.4.3.29 | nameIndicator ..... | 43 | +| 4.4.3.30 | namePresentationAllowed ..... | 43 | +| 4.4.3.31 | nameUnavailable ..... | 44 | +| 4.4.3.32 | namePresentationRestricted..... | 44 | +| 4.4.3.33 | deflectedToNumber ..... | 44 | +| 4.4.3.34 | deflectedToSubaddress ..... | 44 | +| 4.4.3.35 | uUS-Service ..... | 44 | +| 4.4.3.36 | uUS-Required ..... | 44 | +| 4.4.3.37 | locationNotificationArg ..... | 44 | +| 4.4.3.38 | notificationType..... | 44 | +| 4.4.3.39 | locationNotificationRes ..... | 44 | +| 4.4.3.40 | verificationResponse..... | 44 | +| 4.4.3.41 | lcs-MOLRArg..... | 44 | +| 4.4.3.42 | molr-Type ..... | 44 | +| 4.4.3.43 | locationMethod ..... | 44 | +| 4.4.3.44 | gpsAssistanceData ..... | 45 | +| 4.4.3.45 | lcs-MOLRRes ..... | 45 | +| 4.4.3.46 | decipheringKeys ..... | 45 | +| 4.4.3.47 | multicall-Indicator ..... | 45 | +| 4.4.3.48 | pseudonymIndicator..... | 45 | +| 4.4.3.49 | LCS-PeriodicLocationRequestArg ..... | 45 | +| 4.4.3.50 | LCS-PeriodicLocationRequestRes ..... | 45 | +| 4.4.3.51 | LCS-LocationUpdateArg..... | 45 | +| 4.4.3.52 | LCS-LocationUpdateRes ..... | 45 | +| 4.4.3.53 | LCS-PeriodicLocationCancellationArg ..... | 45 | +| 4.4.3.54 | terminationCause ..... | 45 | +| 4.4.3.55 | mo-lrShortCircuit..... | 45 | +| 4.4.3.56 | locationUpdateRequest ..... | 45 | +| 4.4.3.57 | ganssAssistanceData..... | 46 | +| 4.4.3.58 | positioningProtocolPDU ..... | 46 | +| 4.4.3.59 | multiplePositioningProtocolPDUs..... | 46 | +| 4.4.3.60 | LCS-Periodic TriggeredInvokeArg ..... | 46 | +| 4.4.3.61 | LCS-Periodic TriggeredInvokeRes..... | 46 | +| 4.4.3.62 | periodicLocation ..... | 46 | +| 4.4.3.63 | areaEventReporting ..... | 46 | +| 4.4.3.64 | areaList..... | 46 | +| 4.4.3.65 | area..... | 46 | +| 4.4.3.66 | areaType..... | 46 | +| 4.4.3.67 | areaIdentification ..... | 46 | +| 4.4.3.68 | maximumInterval..... | 46 | +| 4.4.3.69 | samplingInterval ..... | 47 | + +| | | | +|-------------------------------|--------------------------------------------------|-----------| +| 4.4.3.70 | duration ..... | 47 | +| 4.4.3.71 | location-Info..... | 47 | +| 4.4.3.72 | motionEventReporting..... | 47 | +| 4.4.3.73 | linearDistance ..... | 47 | +| 4.4.3.74 | LCS-EventReportArg ..... | 47 | +| 4.4.3.75 | LCS-EventReportRes..... | 47 | +| 4.4.3.76 | LCS-CancelDeferredLocationArg ..... | 47 | +| 4.4.3.77 | eventType..... | 47 | +| 4.4.3.78 | referenceNumberExt..... | 47 | +| 4.4.3.79 | h-gmlc-callBackUri ..... | 47 | +| 4.4.3.80 | supportedGADShapes..... | 47 | +| 4.4.3.81 | lcs-QoS..... | 47 | +| 4.4.3.82 | controlPlane-CIoT-5GS-Optimisation..... | 48 | +| 4.4.3.83 | LCS-LocationPrivacySettingArg..... | 48 | +| 4.4.3.84 | locationPrivacyIndication ..... | 48 | +| 4.4.3.85 | validTimePeriod..... | 48 | +| 4.4.3.86 | endTime ..... | 48 | +| 4.5 | Operations and errors implementation ..... | 48 | +| Annex A (informative): | Expanded ASN.1 Module "SS-Protocol" ..... | 50 | +| Annex B (informative): | Change history..... | 51 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document contains the coding of information necessary for support of supplementary service operation on the mobile radio interface layer 3. + +Clause 2 gives the functional definitions and contents of messages for call independent supplementary service operations. Messages necessary for support of call related supplementary service operations are defined in TS 24.008. + +Clause 3 gives the general format and coding for messages used for call independent supplementary service and the format and coding of information elements used for both call related and call independent supplementary service operations. + +Clause 4 gives the specification of the call related and call independent supplementary service operations. + +## 1.1 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "3G Vocabulary". +- [2] 3GPP TS 22.024: "Description of Charge Advice Information (CAI)". +- [3] 3GPP TS 44.006: "Mobile Station - Base Station System (MS - BSS) interface Data Link (DL) layer specification". +- [4] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [5] 3GPP TS 24.008: "Mobile radio interface layer 3 specification". +- [6] 3GPP TS 24.010: "Mobile radio interface layer 3; Supplementary services specification; General aspects". +- [7] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [8] 3GPP TS 24.090: "Unstructured supplementary services operation - Stage 3". +- [9] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [10] 3GPP TS 29.011: "Signalling interworking for supplementary services". + +- [11] ITU-T Recommendation X.680: "Information technology – Abstract Syntax Notation One (ASN.1): Specification of basic notation". +- [11b] ITU-T Recommendation X.681: "Information technology – Abstract Syntax Notation One (ASN.1): Information object specification". +- [12] ITU-T Recommendation X.690: "Information technology – ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [13] ITU-T Recommendation X.880: "Data networks and open system communication - Open System Interconnection - Service definitions - Remote operations: Concepts, model and notation". +- [14] 3GPP TS 49.031: "Location Services (LCS); Base Station Application Part LCS Extension (BSSAP-LE)". +- [15] 3GPP TS 24.171: "NAS Signalling for Control Plane LCS in Evolved Packet System". +- [16] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS)". +- [17] 3GPP TS 36.355: "Evolved Universal Terrestrial Radio Access (E-UTRA); LTE Positioning Protocol (LPP)". +- [18] RFC 3339: "Date and Time on the Internet: Timestamps ". +- [19] 3GPP TS 24.571: "Control plane Location Services (LCS) procedures; Stage 3". + +## 1.2 Abbreviations + +Abbreviations used in the present document are listed in TR 21.905 [1] and below. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-----|-------------------------------| +| GAD | Geographical Area Description | +| LDR | Location Deferred Request | + +# --- 2 Message functional definitions and contents + +## 2.1 General + +This clause defines the structure of the messages of the layer 3 protocol defined in TS 24.080. These messages are standard L3 messages as defined in TS 24.007. + +Each definition includes: + +- a) a brief description of the message; +- b) a table listing the information elements in the order of their appearance in the message. In a sequence of consecutive IEs with half octet length, the first IE occupies bits 1 to 4 of octet N, the second bits 5 to 8 of octet N, the third bits 1 to 4 of octet N+1 etc.. + +For each IE the table indicates: + +- 1) the information element identifier, in hexadecimal notation, if the IE has format T, TV or TLV. If the IEI has half octet length, it is specified by a notation representing the IEI as a hexadecimal digit followed by a "-" (example: B-); +- 2) the name of the IE (which gives an idea of the semantics of the element), which is used in this and other specifications as a reference to the IE within the message; +- 3) the name of the type of the IE (which indicates the coding of the value part of the IE), and a reference to a description of the value part of the IE; + +- 4) the presence requirement indication (M, C or O) for the IE, as defined in TS 24.007; + - 5) the format of the IE (T, V, TV, LV, TLV) as defined in TS 24.007; + - 6) the length of the IE (or permissible range of lengths), in octets, in the message, where "?" means that the maximum length of the IE is only constrained by the link layer protocol, and in the case of the facility IE by possible further considerations specified in TS 24.010. This indication is non-normative. +- c) Clauses specifying conditions for IEs with presence requirement C or O in the relevant message. Together with other conditions specified in TS 24.080, TS 24.010 or TS 24.08x and 24.09x-series this defines when the IE shall be included or not, what non-presence of such IEs means, and (for IEs with presence requirement C) the static conditions for presence and/or non-presence of the IEs (see TS 24.007). + +## 2.2 Messages for supplementary services control + +Table 2.1 summarizes the messages for call independent supplementary services control (see TS 24.010 for a detailed description of call independent supplementary service messages). + +**Table 2.1: Messages for call independent supplementary service control** + +| Messages for supplementary service control | Reference | +|--------------------------------------------|-----------| +| FACILITY | 2.3 | +| REGISTER | 2.4 | +| RELEASE COMPLETE | 2.5 | + +## 2.3 Facility + +This message is sent by the mobile station or the network to request or acknowledge a supplementary service. It is used when information is to be conveyed and the transaction already exists, but is not to be released. The supplementary service to be invoked, and its associated parameters, are specified in the Facility information element (see table 2.2). + +**Table 2.2: FACILITY message content** + +| IEI | Information element | Type / Reference | Presence | Format | Length | +|-----|----------------------------------------------|-------------------------------|----------|--------|--------| +| | Supplementary service protocol discriminator | Protocol discriminator
3.2 | M | V | 1/2 | +| | Transaction identifier | Transaction identifier
3.3 | M | V | 1/2 | +| | Facility message type | Message type
3.4 | M | V | 1 | +| | Facility | Facility
3.6 | M | LV | 2-? | + +## 2.4 Register + +### 2.4.1 Register (network to MS direction) + +This message is sent by the network to the mobile station to assign a new transaction identifier for call independent supplementary service control and to request or acknowledge a supplementary service (see table 2.3). + +**Table 2.3: REGISTER message content (network to MS direction)** + +| IEI | Information element | Type / Reference | Presence | Format | Length | +|-----|----------------------------------------------|-------------------------------|----------|--------|--------| +| | Supplementary service protocol discriminator | Protocol discriminator
3.2 | M | V | 1/2 | +| | Transaction identifier | Transaction identifier
3.3 | M | V | 1/2 | +| | Register message type | Message type
3.4 | M | V | 1 | +| 1C | Facility | Facility
3.6 | M | TLV | 2-? | + +### 2.4.2 Register (MS to network direction) + +This message is sent by the mobile station to the network to assign a new transaction identifier for call independent supplementary service control and to request or acknowledge a supplementary service (see table 2.4). + +**Table 2.4: REGISTER message content (MS to network direction)** + +| IEI | Information element | Type / Reference | Presence | Format | Length | +|-----|----------------------------------------------|-------------------------------|----------|--------|--------| +| | Supplementary service protocol discriminator | Protocol discriminator
3.2 | M | V | 1/2 | +| | Transaction identifier | Transaction identifier
3.3 | M | V | 1/2 | +| | Register message type | Message type
3.4 | M | V | 1 | +| 1C | Facility | Facility
3.6 | M | TLV | 2-? | +| 7F | SS version | SS version indicator
3.7.2 | O | TLV | 3 | + +#### 2.4.2.1 SS version + +This information element shall be included if the supplementary service operation being invoked is implemented according to the phase 2 or higher protocol version. + +## 2.5 Release complete + +This message is sent by the mobile station or the network to release a transaction used for call independent supplementary service control. It may also request or acknowledge a supplementary service (see table 2.5). + +**Table 2.5: RELEASE COMPLETE message content** + +| IEI | Information element | Type / Reference | Presence | Format | Length | +|-----|----------------------------------------------|-------------------------------|----------|--------|--------| +| | Supplementary service protocol discriminator | Protocol discriminator
3.2 | M | V | 1/2 | +| | Transaction identifier | Transaction identifier
3.3 | M | V | 1/2 | +| | Release Complete message type | Message type
3.4 | M | V | 1 | +| 08 | Cause | Cause
TS 24.008 | O | TLV | 4-32 | +| 1C | Facility | Facility
3.6 | O | TLV | 2-? | + +### 2.5.1 Cause + +This information element shall be included when the functional handling of the Cause IE is specified in the service description or TS 29.011. If the functional handling of the Cause IE is not specified, the receiving entity may ignore the IE. + +### 2.5.2 Facility + +This information element shall be included as required by the service description and the procedures defined in TS 24.010. + +# --- 3 General message format and information elements coding + +The figures and text in this clause describe message contents. Within each octet, the bit designated "bit 1" is transmitted first, followed by bits 2, 3, 4, etc. Similarly, the octet shown at the top of each figure is sent first. + +## 3.1 Overview + +Within the layer 3 protocol defined in TS 24.080, every message is a standard L3 message as defined in TS 24.007. This means that the message consists of the following parts: + +- a) protocol discriminator; +- b) transaction identifier; +- c) message type; +- d) other information elements, as required. + +Unless specified otherwise, a particular information element may be present only once in a given message. + +When a field extends over more than one octet, the order of bit values progressively decreases as the octet number increases. The least significant bit of the field is represented by the lowest numbered bit of the highest numbered octet of the field. + +## 3.2 Protocol discriminator + +The Protocol Discriminator (PD) and its use are defined in TS 24.007. TS 24.080 defines the protocols relating to the PD values: + +1 0 1 1 supplementary services (call independent). + +## 3.3 Transaction identifier + +For general rules, format and coding of transaction identifier values, see TS 24.008. + +## 3.4 Message type + +The message type IE and its use are defined in TS 24.007. Table 3.1 defines the value part of the message type IE used in the supplementary service protocol. + +**Table 3.1: Message types** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Message types | +|---|---|---|---|---|---|---|---|----------------------------------------------------------| +| x | x | 1 | 0 | . | . | . | . | Clearing messages:
- RELEASE COMPLETE | +| x | x | 1 | 1 | . | . | . | . | Miscellaneous message group:
- FACILITY
- REGISTER | + +For messages transmitted via CS domain the following applies: + +- When the radio connection started with a core network node of earlier than R99, bit 8 shall be set to 0 and bit 7 is reserved for the send sequence number in messages sent from the mobile station. In messages sent from the network, bits 7 and 8 are coded with a "0". See 3GPP TS 24.007 [4]. +- When the radio connection started with a core network node of R'99 or later, bits 7 and 8 are reserved for the send sequence number in messages sent from the mobile station. In messages sent from the network, bits 7 and 8 are coded with a "0". See 3GPP TS 24.007 [4]. + +For messages transmitted via PS domain the following applies: + +- No sequence number shall be used. Bits 7 and 8 shall be coded with a "0". See 3GPP TS 24.007 [4]. If a sequence number is received on the network side it shall be ignored. + +## 3.5 Other information elements + +These information elements are coded according to the general coding rules as defined in TS 24.008. + +Table 3.2 contains the code-points allocated to the information elements used in messages defined in this specification. All IEs are defined in TS 24.008, but the content of the Facility and SS version indicator IEs are defined within this specification. + +**Table 3.2: Information elements specific to call independent supplementary service control** + +| 8 7 6 5 4 3 2 1 | Reference (IE content) | +|-----------------|-----------------------------------| +| 0 . . . . . . . | Type 3 and 4 information elements | +| 0 0 0 1 0 0 0 | Cause TS 24.008 | +| 0 0 1 1 1 0 0 | Facility 3.6 | +| 1 1 1 1 1 1 1 | SS version indicator 3.8.2 | + +## 3.6 Facility information element + +The purpose of the Facility information element is to indicate the invocation and operation of supplementary services, identified by the corresponding operation code within the Facility information element. + +The Facility information element is coded as shown in figure 3.1 and tables 3.3 to 3.17. + +The Facility is a type 4 information element with no upper length limit except that given by the maximum number of octets in a L3 message, see 3GPP TS 44.006. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---------| +| 0 | 0 | 0 | 1 | 1 | 1 | 0 | 0 | octet 1 | +| Facility IEI | | | | | | | | | +| Length of Facility contents | | | | | | | | | +| Component(s) (note) | | | | | | | | | +| NOTE: One or more components may be included depending on specific service requirements. | | | | | | | | | + +Figure 3.1: Facility information element + +### 3.6.1 Component (octet 3 etc.) + +This clause provides the formats and encoding of components in the Facility information element. Formats and encoding methods make use of and is a subset of ITU-T Rec. Q.773 (Transaction Capabilities formats and Encoding) and T/S 43/BB. The used part of ITU-T Rec. Q.773 respectively T/S 43/BB is almost the same as the Component Portion of TC messages. The only difference is that returnResultNotLast is not used. + +This clause is further based on: + +- ITU-T Rec. X.680 (Abstract Syntax Notation One (ASN.1): Specification of Basic Notation); +- ITU-T Rec. X.690 (Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)); + +and is consistent with these ITU-T Recommendations. + +The parameters in tables 3.3 to 3.6 may be one of the following: + +- a Sequence of Parameters; +- a Set of Parameters; +- a specific Parameter with its own tag (i.e. not part of a Sequence or Set); +- nothing at all (i.e. absent). + +NOTE: Concerning the general rules for encoding (structure of encoding, identifier octets, length octets, etc.) see ITU-T Rec. X.690. For these general rules the same exceptions apply as stated in TS 29.002. This holds also for tables 3.3 to 3.6. + +Table 3.3: Invoke component + +| Invoke component | Reference | Mandatory indication | +|-----------------------|-----------|----------------------| +| Component type tag | 3.6.2 | M | +| Component length | X.690 | | +| Invoke ID tag | 3.6.3 | | +| Invoke ID length | X.690 | M | +| Invoke ID | 3.6.3 | | +| Linked ID tag | 3.6.3 | | +| Linked ID length | X.690 | O | +| Linked ID | 3.6.3 | | +| Operation Code tag | 3.6.4 | | +| Operation Code length | X.690 | M | +| Operation Code | 3.6.4 | | +| Parameters | 4 | O | + +Table 3.4: Return Result component + +| Return Result component | Reference | Mandatory indication | +|-------------------------------------------------------------------------------|-----------|----------------------| +| Component type tag | 3.6.2 | M | +| Component length | X.690 | | +| Invoke ID tag | 3.6.3 | | +| Invoke ID length | X.690 | M | +| Invoke ID | 3.6.3 | | +| Sequence tag | 3.6.5 | O (note) | +| Sequence length | X.690 | | +| Operation Code tag | 3.6.4 | | +| Operation Code length | X.690 | O (note) | +| Operation Code | 3.6.4 | | +| Parameters | 4 | O (note) | +| NOTE: Omitted if the Return Result component does not include any parameters. | | | + +Table 3.5: Return Error component + +| Return Error component | Reference | Mandatory indication | +|------------------------|-----------|----------------------| +| Component type tag | 3.6.2 | M | +| Component length | X.690 | | +| Invoke ID tag | 3.6.3 | | +| Invoke ID length | X.690 | M | +| Invoke ID | 3.6.3 | | +| Error Code tag | 3.6.6 | | +| Error Code length | X.690 | M | +| Error Code | 3.6.6 | | +| Parameters | 4 | O | + +Table 3.6: Reject component + +| Reject component | Reference | Mandatory indication | +|----------------------------------------------------------------------------------------------------|-----------|----------------------| +| Component type tag | 3.6.2 | M | +| Component length | X.690 | | +| Invoke ID tag (note) | 3.6.3 | | +| Invoke ID length | X.690 | M | +| Invoke ID | 3.6.3 | | +| Problem Code tag | 3.6.7 | | +| Problem Code length | X.690 | M | +| Problem Code | 3.6.7 | | +| NOTE: If the Invoke ID is not available, Universal Null (table 3.9) with length = 0 shall be used. | | | + +### 3.6.2 Component type tag + +The Component type tag is coded context-specific, constructor as indicated in table 3.7. + +Table 3.7: Coding of Component type tag + +| Component type tag | 8 7 6 5 4 3 2 1 | +|--------------------|-----------------| +| Invoke | 1 0 1 0 0 0 0 1 | +| Return Result | 1 0 1 0 0 0 1 0 | +| Return Error | 1 0 1 0 0 0 1 1 | +| Reject | 1 0 1 0 0 1 0 0 | + +### 3.6.3 Component ID tag + +The term Component ID refers to the Invoke ID or the Linked ID. The Component ID tag is coded as shown in table 3.8. + +**Table 3.8: Coding of Component ID tag** + +| Component ID tag | 8 7 6 5 4 3 2 1 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| Invoke ID | 0 0 0 0 0 0 1 0 | +| Linked ID (note) | 1 0 0 0 0 0 0 0 | +| NOTE: This tag differs from the Invoke ID tag, which is coded as a Universal INTEGER, in order to distinguish it from the following tag (Operation Code) which is also coded as a Universal INTEGER. | | + +The length of a Component ID is 1 octet. + +An Invoke Component has one or two Component IDs: an Invoke ID, and if it is desired to associate the Invoke with a previous Invoke, then the Linked ID is provided in addition to the Invoke ID. + +Return Result and Return Error Components have one Component ID, called an Invoke ID which is the reflection of the Invoke ID of the Invoke Component to which they are responding. + +The Reject Component uses as its Invoke ID, the Invoke ID in the Component being rejected. If this ID is unavailable (e.g. due to mutilation of the message not detected by lower layers), then the Invoke ID tag is replaced with a universal NULL tag as shown in table 3.9. Universal NULL has always length = 0. + +Any kind of component, except a reject component, may be rejected. + +**Table 3.9: Coding of NULL tag** + +| | 8 7 6 5 4 3 2 1 | +|----------|-----------------| +| NULL tag | 0 0 0 0 0 1 0 1 | + +If an Invoke containing both Invoke and Linked IDs is being rejected, only the Invoke ID is used in the Reject Component. + +### 3.6.4 Operation Code + +Each Operation is assigned an Operation Code to identify it. An Operation Code follows an Operation Code tag and Operation Code length. The Operation Code tag is coded as shown in table 3.10. + +**Table 3.10: Coding of Operation Code tag** + +| | 8 7 6 5 4 3 2 1 | +|--------------------|-----------------| +| Operation Code tag | 0 0 0 0 0 0 1 0 | + +The Operation Codes for the different Operations are defined in clause 4.5. + +### 3.6.5 Sequence and Set tags + +When there is more than one parameter in a Component (applicable to all Component types), they follow the Sequence or Set tag, which are coded universal, constructor as shown in table 3.11. + +**Table 3.11: Coding of Sequence and set tags** + +| Sequence and set tags | 8 7 6 5 4 3 2 1 | +|-----------------------|-----------------| +| Sequence tag | 0 0 1 1 0 0 0 0 | +| Set tag | 0 0 1 1 0 0 0 1 | + +### 3.6.6 Error Code + +Each Error is assigned a value (Error Code) to identify it. + +An Error Code follows an Error Code tag and Error Code length. The Error Code tag is coded as shown in table 3.12. + +**Table 3.12: Coding of Error Code tag** + +| | 8 7 6 5 4 3 2 1 | +|----------------|------------------------| +| Error Code tag | 0 0 0 0 0 0 1 0 | + +The Error Codes for the different Errors are defined in clause 4.5. + +### 3.6.7 Problem Code + +The Problem Code consists of one of the four elements: General Problem, Invoke Problem, Return Result Problem or Return Error Problem. The tags for these elements are coded as shown in table 3.13. + +**Table 3.13: Coding of Problem tags** + +| Problem tags | 8 7 6 5 4 3 2 1 | +|---------------------------|------------------------| +| General Problem tag | 1 0 0 0 0 0 0 0 | +| Invoke Problem tag | 1 0 0 0 0 0 0 1 | +| Return Result Problem tag | 1 0 0 0 0 0 1 0 | +| Return Error Problem tag | 1 0 0 0 0 0 1 1 | + +The Problem Codes for the different Problems are shown in tables 3.14 to 3.17. + +**Table 3.14: Coding of General Problem Codes** + +| General Problem Codes | 8 7 6 5 4 3 2 1 | +|------------------------------|------------------------| +| Unrecognized Component | 0 0 0 0 0 0 0 0 | +| Mistyped Component | 0 0 0 0 0 0 0 1 | +| Badly Structured Component | 0 0 0 0 0 0 1 0 | + +**Table 3.15: Coding of Invoke Problem Codes** + +| Invoke Problem Codes | 8 7 6 5 4 3 2 1 | +|-----------------------------|------------------------| +| Duplicate Invoke ID | 0 0 0 0 0 0 0 0 | +| Unrecognized Operation | 0 0 0 0 0 0 0 1 | +| Mistyped Parameter | 0 0 0 0 0 0 1 0 | +| Resource Limitation | 0 0 0 0 0 0 1 1 | +| Initiating Release | 0 0 0 0 0 1 0 0 | +| Unrecognized Linked ID | 0 0 0 0 0 1 0 1 | +| Linked Response Unexpected | 0 0 0 0 0 1 1 0 | +| Unexpected Linked Operation | 0 0 0 0 0 1 1 1 | + +**Table 3.16: Coding of Return Result Problem Codes** + +| Return Result Problem Codes | 8 7 6 5 4 3 2 1 | +|------------------------------------|------------------------| +| Unrecognized Invoke ID | 0 0 0 0 0 0 0 0 | +| Return Result Unexpected | 0 0 0 0 0 0 0 1 | +| Mistyped Parameter | 0 0 0 0 0 0 1 0 | + +**Table 3.17: Coding of Return Error Problem Codes** + +| Return Error Problem Codes | 8 7 6 5 4 3 2 1 | +|-----------------------------------|------------------------| +| Unrecognized Invoke ID | 0 0 0 0 0 0 0 0 | +| Return Error Unexpected | 0 0 0 0 0 0 0 1 | +| Unrecognized Error | 0 0 0 0 0 0 1 0 | +| Unexpected Error | 0 0 0 0 0 0 1 1 | +| Mistyped Parameter | 0 0 0 0 0 1 0 0 | + +## 3.7 Version handling for supplementary services + +### 3.7.1 Supplementary service screening indicator + +The purpose of the supplementary service screening indicator is to allow the network to assess the capabilities of the MS in advance of a network initiated SS activity. The SS screening indicator is sent in the mobile station classmark 2 as defined in TS 24.008. The handling of the SS screening indicator is described in TS 24.010. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------|--------|------------------------|---|--------|---|---|---| +| (note) | (note) | SS screening indicator | | (note) | | | | + +NOTE: Values not relevant to supplementary services. + +**Figure 3.2: Coding of SS screening indicator in mobile station classmark 2** + +**Table 3.18: Coding of SS screening indicator in mobile station classmark 2** + +| SS screening indicator in mobile station classmark 2 | 6 | 5 | +|-----------------------------------------------------------------------------------------------------------------|---|---| +| default value of phase 1 | 0 | 0 | +| capability of handling of ellipsis notation and phase 2 error handling (note 1) | 0 | 1 | +| for future use (note 2) | 1 | 0 | +| for future use (note 2) | 1 | 1 | +| NOTE 1: Ellipsis notation is described in TS 24.010 and TS 29.002. SS Error handling is described in TS 24.010. | | | +| NOTE 2: The network shall interpret these values the same as "01". | | | + +### 3.7.2 Supplementary service version indicator + +The purpose of the supplementary service version indicator is to allow the network to select the correct version of a protocol for a specific supplementary service. The SS version indicator is included in messages as defined in TS 24.008 and TS 24.080. The coding described in table 3.19 refers to the first octet received in the SS version indicator. Any other octets received shall be ignored. The handling of the SS version indicator is described in TS 24.010. + +**Table 3.19: Coding of SS version indicator** + +| SS version indicator | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---| +| phase 2 service, ellipsis notation, and
phase 2 error handling is supported (note 1) | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| SS-Protocol version 3 is supported, and
phase 2 error handling is supported (note 1)
all other values are for future use (note 2) | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | +| NOTE 1: Ellipsis notation is described in TS 24.010 and TS 29.002. SS Error handling is described in TS 24.010. | | | | | | | | | +| NOTE 2: The network shall interpret all higher values of the SS version indicator the same as "00000001". | | | | | | | | | + +# 4 Supplementary services operation specifications + +## 4.1 General + +This clause specifies the abstract syntax for the Supplementary Service protocol using the Abstract Syntax Notation One (ASN.1), defined in ITU-T Rec. X.680 and X.681. + +The mapping of OPERATION and ERROR to components is defined in clause 3 of this specification. + +The encoding rules which are applicable to the defined abstract syntax are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Rec. X.690 with the same exceptions as stated in TS 29.002. For each Supplementary Service parameter which has to be transferred by a Supplementary Service message, there is a PDU field (an ASN.1 NamedType) whose ASN.1 identifier has the same name as the corresponding parameter, except for the differences required by the ASN.1 notation (blanks between words are removed, the first letter of the first word is lower-case and the first letter of the following words are capitalized (e.g. "bearer service" is mapped to "bearerService")). In addition some words may be abbreviated as follows: + +- ms mobile subscriber; +- ss supplementary services; +- cug closed user group. + +The ASN.1 data type which follows the words "ARGUMENT", "PARAMETER" or "RESULT" (for information objects of class "OPERATION" and "ERROR") is always optional from a syntactic point of view. However, except specific mention, it has to be considered as mandatory from a semantic point of view. When in an invoke component, a mandatory element is missing in any component or inner data structure, a reject component is returned with the problem code "Mistyped Parameter". When an optional element is missing in an invoke component or in an inner data structure while it is required by the context, an error component is returned; the associated type of error is "DataMissing". + +In case an element is defined as mandatory in the protocol description (TS 24.080 including imports from TS 29.002), but is not present according to the service description (stage 1 to stage 3), the ASN.1 protocol description takes precedence over the diagrams in the TS 24.08x and 24.09x-series of technical specifications. + +When possible operations and errors are imported from TS 29.002 thereby making the MSC transparent to most of the messages sent to or from the MS. + +Timer values for operations which require timers are shown as ASN.1 comments. + +The extension marker "..." shall be used in the same way as described in TS 29.002 and shall be supported on the radio interface by the MS and the network for all operations defined in this specification including those imported from TS 29.002. + +## 4.2 Operation types + +Table 4.1 summarizes the operations defined for supplementary services in this specification and shows which of these operations are call related and call independent. The terms "call related" and "call independent" are defined in 3GPP TS 24.010 [6]. Refer to 3GPP TS 24.171 [15] for operations for E-UTRAN LCS, and 3GPP TS 24.571 [19] for operation for 5G LCS. + +Table 4.1: Relevance of supplementary service operations + +| Operation name | Call related SS | Call independent SS | +|----------------------------------|-----------------|---------------------| +| registerSS | - | + | +| eraseSS | - | + | +| activateSS | - | + | +| deactivateSS | - | + | +| interrogateSS | - | + | +| registerPassword | - | + | +| getPassword | - | + | +| processUnstructuredSS-Data | + | + | +| forwardCheckSS-Indication | - | + | +| processUnstructuredSS-Request | - | + | +| unstructuredSS-Request | - | + | +| unstructuredSS-Notify | - | + | +| forwardChargeAdvice | + | - | +| notifySS | + | - | +| forwardCUG-Info | + | - | +| buildMPTY | + | - | +| holdMPTY | + | - | +| retrieveMPTY | + | - | +| splitMPTY | + | - | +| explicitCT | + | - | +| accessRegisterCCEntry | + | - | +| eraseCCEntry | - | + | +| callDeflection | + | - | +| userUserService | + | - | +| lcs-LocationNotification | - | + | +| lcs-MOLR | - | + | +| lcs-AreaEventRequest | - | + | +| lcs-AreaEventReport | - | + | +| lcs-AreaEventCancellation | - | + | +| lcs-PeriodicLocationRequest | - | + | +| lcs-LocationUpdate | - | + | +| lcs-PeriodicLocationCancellation | - | + | +| lcs-PeriodicTriggeredInvoke | - | + | +| lcs-EventReport | - | + | +| lcs-CancelDeferredLocation | - | + | +| lcs-MSCancelDeferredLocation | - | + | +| lcs-LocationPrivacySetting | - | + | + +NOTE: The processUnstructuredSS-Data operation may be used call related by a GSM Phase 1 MS. + +The following ASN.1 module defines operations by allocating them a local value. For the involved operations the same local values as in MAP are allocated. + +``` + +SS-Operations { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Access (2) modules (3) + ss-Operations (0) version15 (15)} + +DEFINITIONS ::= +BEGIN + +EXPORTS + + -- exports operations + + -- operations defined in this specification + processUnstructuredSS-Data, notifySS, forwardChargeAdvice, forwardCUG-Info, buildMPTY, holdMPTY, + retrieveMPTY, splitMPTY, explicitCT, accessRegisterCCEntry, callDeflection, userUserService, + lcs-LocationNotification, lcs-MOLR, lcs-AreaEventRequest, lcs-AreaEventReport, lcs- + AreaEventCancellation, lcs-PeriodicLocationRequest, lcs-LocationUpdate, lcs- + PeriodicLocationCancellation, + lcs-PeriodicTriggeredInvoke, lcs-EventReport, lcs-CancelDeferredLocation, lcs- + MSCancelDeferredLocation, lcs-LocationPrivacySetting; + +IMPORTS + +OPERATION FROM +Remote-Operations-Information-Objects { + +``` + +``` + + joint-iso-itu-t remote-operations(4) + informationObjects(5) version1(0)} + +-- The MAP operations: +-- registerSS, eraseSS, activateSS, deactivateSS, interrogateSS, registerPassword, +-- getPassword, processUnstructuredSS-Request, unstructuredSS-Request, unstructuredSS-Notify +-- forwardChargeSS-Indication +-- are imported from MAP-Operations in SS-Protocol module. + +-- imports SS-data types +NotifySS-Arg, +ForwardChargeAdviceArg, +ForwardCUG-InfoArg, +SS-UserData, +AccessRegisterCCEntryArg, +CallDeflectionArg, +UserUserServiceArg, +LocationNotificationArg, +LocationNotificationRes, +LCS-MOLRArg, +LCS-MOLRRes, +LCS-AreaEventRequestArg, +LCS-AreaEventReportArg, +LCS-AreaEventCancellationArg, +LCS-PeriodicLocationRequestArg, +LCS-PeriodicLocationRequestRes, +LCS-LocationUpdateArg, +LCS-LocationUpdateRes, +LCS-PeriodicLocationCancellationArg, +LCS-PeriodicTriggeredInvokeArg, +LCS-PeriodicTriggeredInvokeRes, +LCS-EventReportArg, +LCS-EventReportRes, +LCS-CancelDeferredLocationArg, +LCS-LocationPrivacySettingArg + +FROM SS-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Access (2) modules (3) + ss-DataTypes (2) version15 (15)} + +-- imports MAP-SS-data types +RegisterCC-EntryRes +FROM MAP-SS-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) + gsm-Network (1) modules (3) map-SS-DataTypes (14) version19 (19)} + +-- imports MAP-errors +illegalSS-Operation, ss-ErrorStatus, ss-NotAvailable, ss-SubscriptionViolation, +ss-Incompatibility, systemFailure, facilityNotSupported, callBarred, unexpectedDataValue, +shortTermDenial, longTermDenial, dataMissing, forwardingViolation, forwardingFailed, +positionMethodFailure, resourceLimitation +FROM MAP-Errors { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-Errors (10) version19 (19)} + +-- imports SS-Errors +resourcesNotAvailable, maxNumberOfMPTY-ParticipantsExceeded, deflectionToServedSubscriber, +invalidDeflectedToNumber, specialServiceCode, rejectedByUser, rejectedByNetwork +FROM SS-Errors { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Access (2) modules (3) + ss-Errors (1) version15 (15)} +; + +-- operations definition + +processUnstructuredSS-Data OPERATION ::= { -- Timer T(PUSSD)= 15s to 30s + ARGUMENT SS-UserData + RESULT SS-UserData + -- optional + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local:19 } + +notifySS OPERATION ::= { + ARGUMENT NotifySS-Arg + CODE local:16 } + +``` + +``` +forwardChargeAdvice OPERATION ::= { -- Timer T(AoC)= 1s to 40s + ARGUMENT ForwardChargeAdviceArg + RETURN RESULT TRUE + CODE local:125 } + +forwardCUG-Info OPERATION ::= { + ARGUMENT ForwardCUG-InfoArg + CODE local:120 } + +buildMPTY OPERATION ::= { -- Timer T(BuildMPTY)= 5s to 30s + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-NotAvailable | + ss-Incompatibility | + systemFailure | + resourcesNotAvailable | + maxNumberOfMPTY-ParticipantsExceeded} + CODE local:124 } + +holdMPTY OPERATION ::= { -- Timer T(HoldMPTY)= 5s to 30s + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-Incompatibility | + facilityNotSupported | + systemFailure} + CODE local:123 } + +retrieveMPTY OPERATION ::= { -- Timer T(RetrieveMPTY)= 5s to 30s + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-Incompatibility | + facilityNotSupported | + systemFailure} + CODE local:122 } + +splitMPTY OPERATION ::= { -- Timer T(SplitMPTY)= 5s to 30s + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-Incompatibility | + facilityNotSupported | + systemFailure} + CODE local:121 } + +explicitCT OPERATION ::= { -- Timer T(ECT)= 5s to 15s + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-NotAvailable | + ss-Incompatibility | + facilityNotSupported | + systemFailure | + resourcesNotAvailable | + callBarred} + CODE local:126 } + +accessRegisterCCEntry OPERATION ::= { -- Timer T(AccRegCCEntry)= 30s + ARGUMENT AccessRegisterCCEntryArg + RESULT RegisterCC-EntryRes + ERRORS { + systemFailure | + dataMissing | + unexpectedDataValue | + callBarred | + illegalSS-Operation | + ss-ErrorStatus | + ss-Incompatibility | + shortTermDenial | + longTermDenial | + facilityNotSupported} +``` + +``` + +CODE local:119 } + +-- the timer value is defined by T308, see also in TS 24.008 for definition of timer T308 + +callDeflection OPERATION ::= { -- Timer T(CD)= 30s + ARGUMENT CallDeflectionArg + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-NotAvailable | + ss-Incompatibility | + facilityNotSupported | + systemFailure | + resourcesNotAvailable | + forwardingViolation | + callBarred | + deflectionToServedSubscriber | + invalidDeflectedToNumber | + specialServiceCode | + forwardingFailed} + CODE local:117 } + +-- the timer value is defined by T305, see also in TS 24.008 for definition of timer T305 +-- extensionContainer shall not be used with this operation + +userUserService OPERATION ::= { -- Timer T(UUS3)= 10s + ARGUMENT UserUserServiceArg + RETURN RESULT TRUE + ERRORS { + illegalSS-Operation | + ss-ErrorStatus | + ss-NotAvailable | + ss-Incompatibility | + facilityNotSupported | + systemFailure | + resourcesNotAvailable | + rejectedByNetwork | + rejectedByUser} + CODE local:118 } + +-- The timer value for UUS3 is 10s; it is applicable only if UUS3 is activated by FACILITY +-- message. If UUS service (UUS1, UUS2 or UUS3) is activated by SETUP message, no timers are +-- needed. In those cases Return Result or Return Error must be received within certain call +-- control messages, see 3GPP TS 24.087. +-- extensionContainer shall not be used with this operation. + +lcs-LocationNotification OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LocationNotificationArg + RESULT LocationNotificationRes + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local:116 } + +lcs-MOLR OPERATION ::= { -- Timer T(LCSL)= 10s to 300s + ARGUMENT LCS-MOLRArg + RESULT LCS-MOLRRes + ERRORS { + systemFailure | + unexpectedDataValue | + dataMissing | + facilityNotSupported | + ss-SubscriptionViolation | + positionMethodFailure} + CODE local:115 } + +lcs-AreaEventRequest OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-AreaEventRequestArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + facilityNotSupported | + unexpectedDataValue} + CODE local:114 } + +``` + +``` +lcs-AreaEventReport OPERATION ::= { -- Timer T(LCSL)= 10s to 300s + ARGUMENT LCS-AreaEventReportArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + unexpectedDataValue | + facilityNotSupported} + CODE local:113 } + +lcs-AreaEventCancellation OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-AreaEventCancellationArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + facilityNotSupported | + unexpectedDataValue} + CODE local:112 } + +lcs-PeriodicLocationRequest OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-PeriodicLocationRequestArg + RESULT LCS-PeriodicLocationRequestRes + ERRORS { + systemFailure | + facilityNotSupported | + unexpectedDataValue | + dataMissing } + CODE local: 111 } + +lcs-LocationUpdate OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-LocationUpdateArg + RESULT LCS-LocationUpdateRes + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local: 110 } + +lcs-PeriodicLocationCancellation OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-PeriodicLocationCancellationArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local: 109 } + +lcs-PeriodicTriggeredInvoke OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-PeriodicTriggeredInvokeArg + RESULT LCS-PeriodicTriggeredInvokeRes + ERRORS { + systemFailure | + facilityNotSupported | + unexpectedDataValue | + dataMissing | + resourceLimitation } + CODE local: 108 } + +lcs-EventReport OPERATION ::= { -- Timer T(LCSL)= 10s to 300s + ARGUMENT LCS-EventReportArg + RESULT LCS-EventReportRes + ERRORS { + systemFailure | + facilityNotSupported | + ss-SubscriptionViolation | + unexpectedDataValue | + dataMissing | + resourceLimitation } + CODE local: 107 } + +lcs-CancelDeferredLocation OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-CancelDeferredLocationArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local: 106 } +``` + +``` + +lcs-MSCancelDeferredLocation OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-CancelDeferredLocationArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local: 105 } + +lcs-LocationPrivacySetting OPERATION ::= { -- Timer T(LCSN)= 10s to 20s + ARGUMENT LCS-LocationPrivacySettingArg + RETURN RESULT TRUE + ERRORS { + systemFailure | + unexpectedDataValue} + CODE local: 104 } + +END + +``` + +### 4.2.1 Void + +### 4.2.2 Operations description + +For each operation this clause provides a brief prose description. + +#### 4.2.2.1 registerSS (MS --> network) + +This operation is invoked by an MS to register data related to a supplementary service in the network. When no BasicService parameter is provided, the registration applies to all provisioned and applicable basic services. + +#### 4.2.2.2 eraseSS (MS --> network) + +This operation is invoked by an MS to erase data related to a supplementary service in the network. When no BasicService parameter is provided, the erasure applies to all provisioned and applicable basic services. + +#### 4.2.2.3 activateSS (MS --> network) + +This operation is invoked by an MS to request the network for a supplementary service activation. When no BasicService parameter is provided, the activation applies to all provisioned and applicable basic services. + +#### 4.2.2.4 deactivateSS (MS --> network) + +This operation is invoked by an MS to request the network for a supplementary service deactivation. When no BasicService parameter is provided, the deactivation applies to all provisioned and applicable basic services. + +#### 4.2.2.5 interrogateSS (MS --> network) + +This operation is invoked by an MS to request the network for a supplementary service interrogation. When no BasicService parameter is provided, the interrogation applies to all provisioned and applicable basic services. + +#### 4.2.2.6 notifySS (network --> MS) + +This operation is invoked by the network to forward a supplementary service notification towards a mobile subscriber. + +#### 4.2.2.7 registerPassword (MS --> network) + +This operation is invoked by an MS to register a new password related to the management by the subscriber himself of subscription data in the HLR. The operation "Register password" will be successful if the subscriber can provide the old password, the new password and the new password again as results of 3 subsequent operations "Get password". + +#### 4.2.2.8 getPassword (network --> MS) + +This operation is invoked by the network to request a password from the mobile subscriber. It may be used to allow the registration of a new password or the management of subscription data by the subscriber himself (e.g. modification of call barring activation status). + +#### 4.2.2.9 processUnstructuredSS-Data (MS --> network) + +This operation is invoked by an MS to relay unstructured information in order to allow end to end SS operation between the MS and the network following specific rules (e.g. embedding of keypad commands). The operation is used in order to provide backward compatibility (see TS 24.090). + +#### 4.2.2.10 processUnstructuredSS-Request (MS --> network) + +This operation is invoked by an MS to start an unstructured supplementary service data application in the network. + +#### 4.2.2.11 unstructuredSS-Request (network --> MS) + +This operation is invoked by the network to request unstructured information from the MS in order to perform an unstructured supplementary service data application. + +#### 4.2.2.12 unstructuredSS-Notify (network --> MS) + +This operation is invoked by the network to give an unstructured supplementary service notification to the mobile user. + +#### 4.2.2.13 forwardCheckSSIndication (network --> MS) + +This operation is invoked by the network to indicate to the mobile subscriber that the status of supplementary services may not be correct in the network. The procedures for initiating ForwardCheckSSIndication are specified in TS 29.002. + +#### 4.2.2.14 forwardChargeAdvice (network --> MS) + +This operation is invoked by the network to forward Advice of Charge information to the mobile subscriber. + +#### 4.2.2.15 buildMPTY (MS --> network) + +This operation is invoked by an MS to request the network to connect calls in a multi party call. + +#### 4.2.2.16 holdMPTY (MS --> network) + +This operation is invoked by an MS to put the MS-connection to a multi party call (invoked by that MS) on hold. + +#### 4.2.2.17 retrieveMPTY (MS --> network) + +This operation is invoked by an MS to request retrieval of a multi party call held by that MS. + +#### 4.2.2.18 splitMPTY (MS --> network) + +This operation is invoked by an MS to request a private communication with one of the remote parties in a multi party call invoked by that MS. + +#### 4.2.2.19 forwardCUG-Info (MS --> network) + +This operation is used by an MS to explicitly invoke a CUG call. + +#### 4.2.2.20 explicitCT (MS --> Network) + +This operation is invoked by an MS to request the network to connect the two calls of the subscriber. + +#### **4.2.2.21 accessRegisterCCEntry (MS --> Network)** + +This operation is invoked by an MS to activate a CCBS request in the network. + +#### **4.2.2.22 callDeflection (MS --> Network)** + +This operation is invoked by an MS to request the network to deflect the incoming call to a specified destination. + +#### **4.2.2.23 userUserService (MS --> Network, Network --> MS)** + +This operation is invoked by an MS to request the network to allow an MS to send/receive information to/from another subscriber in association with a call. + +#### **4.2.2.24 lcs-LocationNotification (network --> MS)** + +This operation is invoked by the network to request a verification from the mobile subscriber for the attempted location request or to notify the subscriber about authorized location request. + +Refer to 3GPP TS 24.171 [15] for lcs-LocationNotification operations for E-UTRAN LCS. + +Refer to 3GPP TS 24.571 [19] for lcs-LocationNotification operations for 5G LCS. + +#### **4.2.2.25 lcs-MOLR (MS --> Network)** + +This operation is invoked by an MS to request the network to start location procedure, which is used to provide the MS location estimate, location assistance data or deciphering keys for broadcast assistance data. + +Refer to 3GPP TS 24.171 [15] for lcs-MOLR operations for E-UTRAN LCS. + +Refer to 3GPP TS 24.571 [19] for lcs-MOLR operations for 5G LCS. + +#### **4.2.2.26 lcs-AreaEventRequest (network --> MS)** + +This operation is invoked by the network to request a mobile to start the deferred MT-LR Area Event procedure. + +#### **4.2.2.27 lcs-AreaEventReport (MS --> network)** + +This operation is invoked by an MS to respond that the requested Area Event has occurred. + +#### **4.2.2.28 lcs-AreaEventCancellation (network --> MS)** + +This operation is invoked by the network to request a mobile to cancel the deferred MT-LR Area Event procedure. + +#### **4.2.2.29 lcs-PeriodicLocationRequest (network --> MS)** + +This operation is invoked by the network to request a mobile to start periodic reporting procedure. + +#### **4.2.2.30 lcs-LocationUpdate (network --> MS)** + +This operation is invoked by the network to notify the mobile about the delivery of location estimates to an external LCS Client, or to deliver a location estimate to the mobile in a periodic location procedure. + +#### **4.2.2.31 lcs-PeriodicLocationCancellation (network --> MS)** + +This operation is invoked by the network to request a mobile to cancel the periodic or triggered reporting procedure. This operation is applicable to EPS. + +#### 4.2.2.32 lcs-PeriodicTriggeredInvoke (network --> MS) + +This operation is invoked by the network to request a mobile to start a periodic and triggered reporting procedure. This operation is applicable to EPS and 5GS. + +#### 4.2.2.33 lcs-EventReport (MS --> Network) + +This operation is invoked by an MS to report a periodic or triggered location related event to the network or to cancel location related event reporting. This operation is applicable to 5GS. + +#### 4.2.2.34 lcs-CancelDeferredLocation (network --> MS) + +This operation is invoked by the network to request a mobile to cancel a periodic or triggered reporting procedure. This operation is applicable to 5GS. + +#### 4.2.2.35 lcs-MSCancelDeferredLocation (MS --> network) + +This operation is invoked by an MS to request the network to cancel a periodic or triggered reporting procedure. This operation is applicable to 5GS. + +#### 4.2.2.36 lcs-LocationPrivacySetting (MS --> network) + +This operation is invoked by an MS to request network to update its Location Privacy Indication information. This operation is applicable to 5GS. + +## 4.3 Errors + +### 4.3.1 Errors ASN.1 specification + +The following ASN.1 module provides an ASN.1 specification of errors. Errors from MAP are imported in the SS-Protocol module in clause 4.5. The module defines errors by allocating them a local value. For the involved errors the same local values as in MAP are allocated. + +``` +SS-Errors { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Access (2) modules (3) + ss-Errors (1) version15 (15)} + +DEFINITIONS ::= + +BEGIN + +IMPORTS + +ERROR FROM +Remote-Operations-Information-Objects {joint-iso-itu-t remote-operations(4) + informationObjects(5) version1(0)}; + +-- The MAP errors +-- unknownSubscriber, bearerServiceNotProvisioned, teleserviceNotProvisioned, +-- illegalSS-Operation, ss-ErrorStatus, ss-NotAvailable, ss-SubscriptionViolation, +-- ss-Incompatibility, systemFailure, dataMissing, unexpectedDataValue, facilityNotSupported, +-- pw-RegistrationFailure, negativePW-Check, callBarred, numberOfPW-AttemptsViolation, +-- absentSubscriber, illegalSubscriber, illegalEquipment, ussd-Busy, unknownAlphabet, +-- forwardingViolation, forwardingFailed, resourceLimitation +-- are imported from MAP-Errors in SS-Protocol module. + +-- errors definition +resourcesNotAvailable ERROR ::= { + CODE local:127 } +maxNumberOfMPTY-ParticipantsExceeded ERROR ::= { + CODE local:126 } +invalidDeflectedToNumber ERROR ::= { + CODE local:125 } +specialServiceCode ERROR ::= { +``` + +``` + CODE local:124 } +deflectionToServedSubscriber ERROR ::= { + CODE local:123 } +rejectedByNetwork ERROR ::= { + CODE local:122 } +rejectedByUser ERROR ::= { + CODE local:121 } +END +``` + +### 4.3.2 Errors description + +For each error this clause provides a brief prose description. + +#### 4.3.2.1 unknownSubscriber + +This error is returned by the network when it is requested to perform an operation concerning an unknown subscriber. + +#### 4.3.2.2 bearerServiceNotProvisioned + +This error is returned by the network when it is requested to perform an operation on a supplementary service and not even a subset of the requested bearer service group has been subscribed to. + +#### 4.3.2.3 teleServiceNotProvisioned + +This error is returned by the network when it is requested to perform an operation on a supplementary service and not even a subset of the requested teleservice group has been subscribed to. + +#### 4.3.2.4 illegalSS-Operation + +This error is returned by the network when it is requested to perform an illegal operation which is defined as not applicable for the relevant supplementary service(s) (e.g. registration request for a service which must be registered by the administration). For the definition of the allowed operations for the individual supplementary services, see TS 24.08x and 24.09x-series of technical specifications. + +#### 4.3.2.5 ss-ErrorStatus + +This error is returned by the network when it is requested to perform an operation which is not compatible with the current status of the relevant supplementary service. The current status may be given as additional information by use of the SS-parameter. + +#### 4.3.2.6 ss-NotAvailable + +This error is returned by the network when it is requested to perform an operation on a supplementary service which is not available in the current location area. + +#### 4.3.2.7 ss-SubscriptionViolation + +This error is returned by the network when it is requested to perform an operation on a supplementary service, transgressing the subscription restrictions. The nature of the restriction or the transgressed options may be sent as parameters. + +#### 4.3.2.8 ss-Incompatibility + +This error is returned by the network when it is requested for a supplementary service operation incompatible with the status of an other supplementary service or with the teleservice or bearer service for which the operation is requested. This error shall only be used if the operation is not compatible for even a subset of the teleservice group or bearer service group specified in the request. The identity and status of the conflicting service may also be indicated. The additional information may contain the SS-code parameter, the Basic Service Group parameter and the SS-status parameter. + +#### 4.3.2.9 systemFailure + +This error is returned by the network, when it cannot perform an operation because of a failure in the network. + +#### 4.3.2.10 dataMissing + +This error is returned by the network when an optional parameter is missing in an invoke component or an inner data structure, while it is required by the context of the request. + +#### 4.3.2.11 unexpectedDataValue + +This error is returned by the network when it receives a parameter with an unexpected value, without type violation. + +#### 4.3.2.12 passwordRegistrationFailure + +This error is returned when a password registration procedure fails because of abnormal subscriber inputs. A more specific diagnostic may be passed as error parameter and indicates situations such as: + +- invalid password format; +- new passwords mismatch. + +#### 4.3.2.13 negativePasswordCheck + +This error is returned to indicate the negative result of a password check because the subscriber has not provided the required password or has provided a password which does not match the valid one. + +#### 4.3.2.14 facilityNotSupported + +This error is returned by the network receiving a request about a facility which is not supported in the PLMN. + +#### 4.3.2.15 resourcesNotAvailable + +This error is returned by the network to the MS if temporarily there are no resources to support e.g. a multi party call available in the network. + +#### 4.3.2.16 maxNumberOfMPTY-ParticipantsExceeded + +This error is returned by the network to the MS if the request must be rejected because the number of subscribers to join a multi party call would exceed the maximum value. + +#### 4.3.2.17 callBarred + +This error is returned by the network to the MS when call independent subscriber control procedures are barred by the operator. The parameter "operator barring" shall be included. + +#### 4.3.2.18 numberOfPW-AttemptsViolation + +This error is returned by the network to the MS when the maximum number of wrong password attempts is exceeded. + +#### 4.3.2.19 absentSubscriber + +This error is returned when the subscriber has activated the detach service or the system detects the absence condition. This error is not used on the radio interface but only between network entities. + +#### 4.3.2.20 illegalSubscriber + +This error is returned when illegality of the access has been established by use of authentication procedure. This error is not used on the radio interface but only between network entities. + +#### 4.3.2.21 illegalEquipment + +This error is returned when the IMEI check procedure has shown that the IMEI is blacklisted or not white-listed. This error is not used on the radio interface but only between network entities. + +#### 4.3.2.22 ussd-Busy + +This error is returned by the MS to the network when the MS is not able to process the unstructured supplementary service data operation due to an on-going MMI input of the user or an already existing call independent supplementary service transaction. + +#### 4.3.2.23 unknownAlphabet + +This error is returned by the MS or the network when the alphabet/language used for the unstructured supplementary service data operation is not known by the network or the MS. + +#### 4.3.2.24 invalidDeflectedToNumber + +This error is returned if the requested deflected-to number is invalid. + +#### 4.3.2.25 specialServiceCode + +This error is returned if diversion to a special service code was requested. + +#### 4.3.2.26 deflectionToServedSubscriber + +This error is returned if a diversion to the served subscriber's number was requested. + +#### 4.3.2.27 rejectedByNetwork + +This error is returned by the network when the network rejects User-to-User Signalling service request. + +#### 4.3.2.28 rejectedByUser + +This error is returned by the remote party when the remote party rejects User-to-User Signalling service request. + +#### 4.3.2.29 positionMethodFailure + +This error is returned by the network when the network is unable to obtain any of the location information requested or none of the information obtained satisfies the requested LCS QoS or if requested LCS assistance data could not be transferred or requested deciphering keys for broadcast assistance data could not be returned. + +#### 4.3.2.30 resourceLimitation + +This error is returned when a requested operation cannot be performed due to insufficient resources. + +## 4.4 Data types and identifiers + +### 4.4.1 General + +The data types used in the SS protocol specifications are described in the ASN.1 module provided in clause 4.4.2, while clause 4.4.3 provides an overview of the identifiers used in SS ASN.1 specifications. + +Named values have been defined in the following module for the upper boundaries of the value ranges associated to several sub-type specifications. + +### 4.4.2 ASN.1 data types + +This clause provides an ASN.1 module defining the abstract data types in operations and errors specification. Only data types which are specific for this specification are defined. All other data types are imported from MAP together with the import of operations and errors. + +``` + +SS-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Access (2) modules (3) + ss-DataTypes (2) version15 (15)} + +DEFINITIONS + +IMPLICIT TAGS ::= + +BEGIN + +-- exports all data types defined in this module + +IMPORTS + +SS-Code +FROM MAP-SS-Code { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-SS-Code (15) version19 (19)} + +-- imports MAP-SS-DataTypes +SS-Status, USSD-DataCodingScheme, USSD-String, CCBS-Feature +-- USSD-DataCodingScheme, USSD-String were introduced because of CNAP. +FROM MAP-SS-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-SS-DataTypes (14) version19 (19)} + +CUG-Index, +NotificationToMSUser +FROM MAP-MS-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-MS-DataTypes (11) version19 (19)} + +maxSignalInfoLength, +ISDN-AddressString, +ISDN-SubaddressString, +AlertingPattern, +LCSClientExternalID, +AddressString, +LCSServiceTypeID, +AgeOfLocationInformation, +GSN-Address +FROM MAP-CommonDataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-CommonDataTypes (18) version19 (19)} + +LocationType, +DeferredLocationEventType, +LCSClientName, +LCS-QoS, +Horizontal-Accuracy, +ResponseTime, +Ext-GeographicalInformation, +VelocityEstimate, +SupportedGADShapes, +Add-GeographicalInformation, +LCSRequestorID, +LCS-ReferenceNumber, +LCSCodeword, +AreaEventInfo, +ReportingPLMNList, +PeriodicLDRInfo, +SequenceNumber, +OccurrenceInfo, +IntervalTime + +FROM MAP-LCS-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) + gsm-Network (1) modules (3) map-LCS-DataTypes (25) version19 (19)} + +; + +``` + +``` + +-- data types definition + +SS-UserData ::= IA5String (SIZE (1.. maxSignalInfoLength)) + +NotifySS-Arg ::= SEQUENCE{ + ss-Code [1] SS-Code OPTIONAL, + ss-Status [4] SS-Status OPTIONAL, + ss-Notification [5] SS-Notification OPTIONAL, + callIsWaiting-Indicator [14] NULL OPTIONAL, + callOnHold-Indicator [15] CallOnHold-Indicator OPTIONAL, + mpty-Indicator [16] NULL OPTIONAL, + cug-Index [17] CUG-Index OPTIONAL, + clirSuppressionRejected [18] NULL OPTIONAL, + ... , + ect-Indicator [19] ECT-Indicator OPTIONAL, + nameIndicator [20] NameIndicator OPTIONAL, + ccbs-Feature [21] CCBS-Feature OPTIONAL, + alertingPattern [22] AlertingPattern OPTIONAL, + multicall-Indicator [23] Multicall-Indicator OPTIONAL} + +-- The nameIndicator is defined because of CNAP. + +Multicall-Indicator ::= ENUMERATED { + nbr-SNexceeded (0), + nbr-Userexceeded (1)} + +ForwardChargeAdviceArg ::= SEQUENCE{ + ss-Code [0] SS-Code, + chargingInformation [1] ChargingInformation, + ...} + +SS-Notification ::= OCTET STRING (SIZE (1)) + +-- Bit 8 7 6 5 4 00000 (Unused) + +-- Bit 3 Call is forwarded indication to A-subscriber +-- (calling subscriber) +-- 0 No information content +-- 1 Outgoing call has been forwarded to C + +-- Bit 2 Call is forwarded indication to B-subscriber +-- (forwarding subscriber) +-- 0 No information content +-- 1 Incoming call has been forwarded to C + +-- Bit 1 Call is forwarded indication to C-subscriber +-- (forwarded-to subscriber) +-- 0 No information content +-- 1 Incoming call is a forwarded call + +ChargingInformation ::= SEQUENCE{ + e1 [1] E1 OPTIONAL, + e2 [2] E2 OPTIONAL, + e3 [3] E3 OPTIONAL, + e4 [4] E4 OPTIONAL, + e5 [5] E5 OPTIONAL, + e6 [6] E6 OPTIONAL, + e7 [7] E7 OPTIONAL, + ...} + +E1 ::= INTEGER (0..max10TimesUnitsPerTime) +max10TimesUnitsPerTime INTEGER ::= 8191 + +E2 ::= INTEGER (0..max10TimesTimeInterval) +max10TimesTimeInterval INTEGER ::= 8191 + +E3 ::= INTEGER (0..max100TimesScalingFactor) +max100TimesScalingFactor INTEGER ::= 8191 + +E4 ::= INTEGER (0..max10TimesIncrement) +max10TimesIncrement INTEGER ::= 8191 + +E5 ::= INTEGER (0..max10TimesIncrementPerDataInterval) +max10TimesIncrementPerDataInterval INTEGER ::= 8191 + +E6 ::= INTEGER (0..maxNumberOfSegmentsPerDataInterval) +maxNumberOfSegmentsPerDataInterval INTEGER ::= 8191 + +``` + +``` + +E7 ::= INTEGER (0..max10TimesInitialTime) +max10TimesInitialTime INTEGER ::= 8191 + +CallOnHold-Indicator ::= ENUMERATED { + callRetrieved (0), + callOnHold (1)} + +ForwardCUG-InfoArg ::= SEQUENCE { + cug-Index [0] CUG-Index OPTIONAL, + suppressPrefCUG [1] NULL OPTIONAL, + suppressOA [2] NULL OPTIONAL, + ...} + +ECT-Indicator ::= SEQUENCE { + ect-CallState [0] ECT-CallState, + rdn [1] RDN OPTIONAL, + ...} + +ECT-CallState ::= ENUMERATED { + alerting (0), + active (1)} + +NameIndicator ::= SEQUENCE { + callingName [0] Name OPTIONAL, + ...} + +Name ::= CHOICE { + namePresentationAllowed [0] NameSet, + presentationRestricted [1] NULL, + nameUnavailable [2] NULL, + namePresentationRestricted [3] NameSet} + +NameSet ::= SEQUENCE { + dataCodingScheme [0] USSD-DataCodingScheme, + lengthInCharacters [1] INTEGER, + nameString [2] USSD-String, + ...} + +-- NameIndicator, Name and NameSet are defined because of CNAP. +-- The USSD-DataCodingScheme shall indicate use of the default alphabet through the +-- following encoding: +-- bit 7 6 5 4 3 2 1 0 +-- | 0 0 0 0 | 1 1 1 1| + +RDN ::= CHOICE { + presentationAllowedAddress [0] RemotePartyNumber, + presentationRestricted [1] NULL, + numberNotAvailableDueToInterworking [2] NULL, + presentationRestrictedAddress [3] RemotePartyNumber} + +RemotePartyNumber ::= SEQUENCE { + partyNumber [0] ISDN-AddressString, + partyNumberSubaddress [1] ISDN-SubaddressString OPTIONAL, + ...} + +AccessRegisterCCEntryArg ::= SEQUENCE { + ...} + +CallDeflectionArg ::= SEQUENCE { + deflectedToNumber [0] AddressString, + deflectedToSubaddress [1] ISDN-SubaddressString OPTIONAL, + ...} + +UserUserServiceArg ::= SEQUENCE { + uUS-Service [0] UUS-Service, + uUS-Required [1] BOOLEAN, + ... } + +UUS-Service ::= ENUMERATED { + uUS1 (1), + uUS2 (2), + uUS3 (3), + ... } + +-- exception handling: +-- In case of UUS-Service with any other value, indicated as "UUS required", +-- but not understood by the MS, the call will be cleared. + +``` + +``` + +LocationNotificationArg ::= SEQUENCE { + notificationType [0] NotificationToMSUser, + locationType [1] LocationType, + lcsClientExternalID [2] LCSClientExternalID OPTIONAL, + lcsClientName [3] LCSClientName OPTIONAL, + ... , + lcsRequestorID [4] LCSRequestorID OPTIONAL, + lcsCodeword [5] LCSCodeword OPTIONAL, + lcsServiceTypeID [6] LCSServiceTypeID OPTIONAL, + deferredLocationExt [7] DeferredLocationExt OPTIONAL } + +-- The notificationType may only be set to notifyLocationAllowed, +-- notifyAndVerify-LocationAllowedIfNoResponse, +-- or notifyAndVerify-LocationNotAllowedIfNoResponse. +-- The locationEstimateType field of the locationType may only be set to +-- currentLocation, currentOrLastKnownLocation, +-- notificationVerificationOnly, or activateDeferredLocation. +-- The deferredLocationEventType field of the locationType may only be set to +-- enteringIntoArea, and/or leavingFromArea, and/or beingInsideArea, +-- and/or periodicLDR. +-- For LCS location notification of MT-LR for current location, the +-- locationEstimateType field of the locationType shall be set to currentLocation. +-- For LCS location notification of MT-LR for current or last known location, the +-- locationEstimateType field of the locationType shall be set to currentOrLastKnownLocation. +-- For the LCS location notification for the LDR of MS available event, +-- the locationEstimateType field of the locationType shall be set to currentLocation. +-- For LCS location notification for the LDR of change of area event, +-- the locationEstimateType field of the locationType shall be set to +-- activateDeferredLocation, and the deferredLocationEventType shall be +-- set to enteringIntoArea, and/or leavingFromArea, and/or beingInsideArea. +-- For the post positioning LCS location notification, the locationEstimateType +-- field of the locationType shall be set to notificationVerificationOnly. +-- For LCS location notification for the LDR of periodic location event, +-- the locationEstimateType field of the locationType shall be set to +-- activateDeferredLocation, and the +-- deferredLocationEventType shall be set to periodicLDR. +-- For LCS location notification for the LDR of the motion event, +-- the locationEstimateType field of the locationType shall be set to +-- activateDeferredLocation, the deferredLocationEventType shall be omitted +-- and the deferredLocationExt shall be set to motionEvent. + +-- exception handling: +-- At reception of an unrecognised notificationType value the receiver shall reject the +-- operation with a return error cause of unexpected data value. +-- At reception of an unrecognised locationType value the receiver shall reject the +-- operation with a return error cause of unexpected data value. +-- At reception of an unallowed notificationType value the receiver shall either ignore the +-- received operation or reject the operation with a return error cause of unexpected +-- data value. +-- At reception of an unallowed locationType value the receiver shall either ignore the +-- received operation or reject the operation with a return error cause of unexpected +-- data value. + +DeferredLocationExt ::= BIT STRING { + motionEvent (0) } (SIZE (1..16)) +-- A bit set to one indicates that the corresponding deferred location type is present. +-- A bit set to zero indicates that the corresponding deferred location type is absent. + +LocationNotificationRes ::= SEQUENCE { + verificationResponse [0] VerificationResponse OPTIONAL, + locationPrivacyIndication [1] LCS-LocationPrivacyIndication OPTIONAL, + validTimePeriod [2] LCS-ValidTimePeriod OPTIONAL, + ... } +-- Parameters locationPrivacyIndication or validTimePeriod may be included by a UE for 5GS +-- access. Parameter validTimePeriod only may be included if parameter locatonPrivacyIndication +-- is included. + +VerificationResponse ::= ENUMERATED { + permissionDenied (0), + permissionGranted (1), + ... } + +-- exception handling: +-- an unrecognized value shall be treated the same as value 0 (permissionDenied) + +LCS-MOLRArg ::= SEQUENCE { + +``` + +``` + + molr-Type [0] MOLR-Type, + locationMethod [1] LocationMethod OPTIONAL, + lcs-QoS [2] LCS-QoS OPTIONAL, + lcsClientExternalID [3] LCSClientExternalID OPTIONAL, + mlc-Number [4] ISDN-AddressString OPTIONAL, + gpsAssistanceData [5] GPSAssistanceData OPTIONAL, + .... + supportedGADShapes [6] SupportedGADShapes OPTIONAL, + lcsServiceTypeID [7] LCSServiceTypeID OPTIONAL, + ageOfLocationInfo [8] AgeOfLocationInformation OPTIONAL, + locationType [9] LocationType OPTIONAL, + pseudonymIndicator [10] NULL OPTIONAL, + h-gmlc-address [11] GSN-Address OPTIONAL, + locationEstimate [12] Ext-GeographicalInformation OPTIONAL, + velocityEstimate [13] VelocityEstimate OPTIONAL, + referenceNumber [14] LCS-ReferenceNumber OPTIONAL, + periodicLDRInfo [15] PeriodicLDRInfo OPTIONAL, + locationUpdateRequest [16] NULL OPTIONAL, + sequenceNumber [17] SequenceNumber OPTIONAL, + terminationCause [18] TerminationCause OPTIONAL, + mo-lrShortCircuit [19] NULL OPTIONAL, + ganssAssistanceData [20] GANSSAssistanceData OPTIONAL, + multiplePositioningProtocolPDUs [21] MultiplePositioningProtocolPDUs OPTIONAL, + locationInfo [22] LocationInfo OPTIONAL } +-- The parameter locationMethod shall be included if and only if the molr-Type is set to value +-- deCipheringKeys or assistanceData. +-- The parameter gpsAssistanceData shall be included if and only if the molr-Type is set to value +-- assistanceData and locationMethod is set to value assistedGPS or assistedGPSandGANSS. +-- The parameter ganssAssistanceData shall be included if and only if the molr-Type is set to value +-- assistanceData and locationMethod is set to value assistedGANSS or assistedGPSandGANSS. +-- supportedGADShapes shall not be included for deferred MO-LR initiation or deferred MO-LR or MT-LR +-- responses +-- multiplePositioningProtocolPDUs may only be included for E-UTRAN access for an EPC-MO-LR. +-- locationMethod shall not be included for E-UTRAN and 5G access. +-- gpsAssistanceData shall not be included for E-UTRAN access. +-- velocityEstimate shall not be included for E-UTRAN access. +-- periodicLDRInfo shall not be included for E-UTRAN access. +-- locationUpdateRequest shall not be included for E-UTRAN access. +-- sequenceNumber shall not be included for E-UTRAN access. +-- mo-lrShortCircuit shall not be included for E-UTRAN access. +-- ganssAssistanceData shall not be included for E-UTRAN access. +-- locationInfo shall be included if available for E-UTRAN access for a periodic and triggered +-- event report. +-- Only mlc-number could be used to represent the address of H-GMLC of the UE, h-gmlc-address shall +not be used for this purpose. + +``` + +``` + +MOLR-Type::= ENUMERATED { + locationEstimate (0), + assistanceData (1), + deCipheringKeys (2), + ... , + deferredMo-lrTTTPInitiation (3), + deferredMo-lrSelfLocationInitiation (4), + deferredMt-lrOrmo-lrTTTPLocationEstimate (5), + deferredMt-lrOrmo-lrCancellation (6), + periodicEvent (7), + enteringAreaEvent (8), + leavingAreaEvent (9), + beingInsideAreaEvent (10), + motionEvent (11), + maximumIntervalExpirationEvent (12) } +-- exception handling: +-- an unrecognized value shall be rejected by the receiver with a return error cause of +-- unexpected data value. +-- For E-UTRAN access, only locationEstimate, assistanceData, periodicEvent, +-- deferredMt-lrOrmo-lrCancellation, enteringAreaEvent, leavingAreaEvent, beingInsideAreaEvent, +-- motionEvent or maximumIntervalExpirationEvent shall be included + +``` + +``` + +LocationMethod::= ENUMERATED { + msBasedEOTD (0), + msAssistedEOTD (1), + assistedGPS (2), + ... , + msBasedOTDOA (3), + assistedGANSS (4), + assistedGPSandGANSS (5) } + +``` + +``` + + } + -- exception handling: + -- When this parameter is received with value msBasedEOTD or msAssistedEOTD and the MS + -- is camped on an UMTS Service Area then the receiver shall reject it + -- with a return error cause of unexpected data value. + -- When this parameter is received with value msBasedOTDOA and the MS + -- is camped on a GSM Cell then the receiver shall reject it with a return error cause of + -- unexpected data value. + -- an unrecognized value shall be rejected by the receiver with a return error cause of + -- unexpected data value. + + GPSAssistanceData ::= OCTET STRING (SIZE (1..38)) + -- Octets 1 to 38 are coded in the same way as the octets 3 to 7+2n of Requested GPS Data IE + -- in 3GPP TS 49.031 [14]. + + GANSSAssistanceData ::= OCTET STRING (SIZE (1..40)) + -- Octets 1 to 40 are coded in the same way as the octets 3 to 9+2n of Requested GANSS Data IE + -- in 3GPP TS 49.031 [14] . + + TerminationCause ::= ENUMERATED { + subscriberTermination (0), + uETermination (1), + ..., + normalTermination (2), + networkTermination (3) } + -- normalTermination shall be included for a normal end to periodic or triggered event + -- reporting + + MultiplePositioningProtocolPDUs ::= SEQUENCE (SIZE (1..maxNumLPPMsg)) OF PositioningProtocolPDU + + PositioningProtocolPDU ::= OCTET STRING + -- PositioningProtocolPDU contains a LPP message defined in 3GPP TS 36.355 [17]. + + maxNumLPPMsg INTEGER ::= 3 + + LCS-MOLRRes ::= SEQUENCE { + locationEstimate [0] Ext-GeographicalInformation OPTIONAL, + decipheringKeys [1] DecipheringKeys OPTIONAL, + ..., + add-LocationEstimate [2] Add-GeographicalInformation OPTIONAL, + velocityEstimate [3] VelocityEstimate OPTIONAL, + referenceNumber [4] LCS-ReferenceNumber OPTIONAL, + h-gmlc-address [5] GSN-Address OPTIONAL, + mo-lrShortCircuit [6] NULL OPTIONAL, + reportingPLMNList [7] ReportingPLMNList OPTIONAL + } + -- Parameters locationEstimate or add-LocationEstimate (one but not both) + -- shall be included if and only if the + -- molr-Type in LocationRequestArg was set to value locationEstimate. + -- Parameter add-LocationEstimate shall not be included if the supportedGADShapes + -- parameter was not received in the LCS-MOLRArg. + -- The locationEstimate and the add-LocationEstimate parameters shall not be sent if + -- the supportedGADShapes parameter has been received in LCS-MOLRArg + -- and the shape encoded in locationEstimate or add-LocationEstimate is not marked + -- as supported in supportedGADShapes. In such a case LCS-MOLRArg + -- shall be rejected with error FacilityNotSupported with additional indication + -- shapeOfLocationEstimateNotSupported. + -- Parameter decipheringKeys shall be included if and only if the molr-Type + -- in LocationRequestArg was set to value deCipheringKeys. + -- Parameter velocityEstimate may only be included if the lcs-QoS in LCS-MOLRArg includes + -- velocityRequest + -- decipheringKeys shall not be included for E-UTRAN access. + -- referenceNumber shall not be included for E-UTRAN access. + -- h-gmlc-address shall not be included for E-UTRAN access. + -- mo-lrShortCircuit shall not be included for E-UTRAN access. + -- reportingPLMNList shall not be included for E-UTRAN access. + + DecipheringKeys ::= OCTET STRING (SIZE (15)) + -- Octets in DecipheringKeys are coded in the same way as the octets 3 to 17 of Deciphering Key IE + -- in 3GPP TS 49.031 [14]. I.e. these octets contain Current Deciphering Key, Next Deciphering Key + -- and + -- Ciphering Key Flag. + + LCS-AreaEventRequestArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber, + } + +``` + +``` + + h-gmlc-address [1] GSN-Address, + deferredLocationEventType [3] DeferredLocationEventType, + areaEventInfo [4] AreaEventInfo, + ... } + +-- the msAvailableValue in the DeferredLocationEventType is not applicable for this procedure + +LCS-AreaEventReportArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber, + h-gmlc-address [1] GSN-Address, + ... } + +LCS-AreaEventCancellationArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber, + h-gmlc-address [1] GSN-Address, + ... } + +LCS-PeriodicLocationRequestArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber, + periodicLDRInfo [1] PeriodicLDRInfo, + lcsClientExternalID [2] LcsClientExternalID, + qos [3] LCS-QoS OPTIONAL, + h-gmlc-address [4] GSN-Address OPTIONAL, + mo-lrShortCircuit [5] NULL OPTIONAL, + reportingPLMNList [6] ReportingPLMNList OPTIONAL, + ... } + +LCS-PeriodicLocationRequestRes ::= SEQUENCE { + mo-lrShortCircuit [0] NULL OPTIONAL, + ... } + +LCS-LocationUpdateArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber OPTIONAL, + add-LocationEstimate [1] Add-GeographicalInformation OPTIONAL, + velocityEstimate [2] VelocityEstimate OPTIONAL, + sequenceNumber [3] SequenceNumber OPTIONAL, + ... } +-- add-LocationEstimate shall be included if and only if a location estimate was successfully +-- transferred towards an External LCS Client or was successfully obtained for UE self location +-- velocityEstimate may only be included if add-LocationEstimate is included + +LCS-LocationUpdateRes ::= SEQUENCE { + terminationCause [0] TerminationCause OPTIONAL, + ... } + +LCS-PeriodicLocationCancellationArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber, + h-gmlc-address [1] GSN-Address OPTIONAL, + ... } + +LCS-PeriodicTriggeredInvokeArg ::= SEQUENCE { + referenceNumber [0] LCS-ReferenceNumber, + h-gmlc-address [1] GSN-Address, + qos [2] LCS-QoS OPTIONAL, + reportingPLMNList [3] ReportingPLMNList OPTIONAL, + periodicLocation [4] PeriodicLocation OPTIONAL, + areaEventReporting [5] AreaEventReporting OPTIONAL, + motionEventReporting [6] MotionEventReporting OPTIONAL, + ..., + referenceNumberExt [7] LCS-ReferenceNumberExt OPTIONAL, + h-gmlc-callBackUri [8] UTF8String OPTIONAL, + supportedGADShapes [9] SupportedGADShapes OPTIONAL, + deferredRoutingIdentifier [10] OCTET STRING OPTIONAL, + reportingAccessTypes [11] ReportingAccessTypes OPTIONAL, + multiplePositioningProtocolPDUs [12] MultiplePositioningProtocolPDUs OPTIONAL, + controlPlane-CIoT-5GS-Optimisation [13] ControlPlane-CIoT-5GS-Optimisation OPTIONAL } +-- Only one of periodicLocation, areaEventReporting and motionEventReporting shall be included. +-- responseTime and velocityRequest are not applicable in LCS-QoS. +-- reportingPLMNList provides a list of PLMNs in which event reporting is allowed. +-- If referenceNumberExt is included, an MS shall ignore referenceNumber. +-- h-gmlc-address shall be ignored by a UE for 5GS access. +-- referenceNumberExt, h-gmlc-callBackUri, supportedGADShapes, deferredRoutingIdentifier, +-- reportingAccessTypes, multiplePositioningProtocolPDUs and controlPlane-CIoT-5GS-Optimisation +-- shall not be included for E-UTRA access to EPC. +-- reportingPLMNList shall not be included for 5GS access. + +``` + +``` + +PeriodicLocation := SEQUENCE { + periodicLDRInfo [0] PeriodicLDRInfo, + ... } + +AreaEventReporting := SEQUENCE { + deferredLocationEventType [0] DeferredLocationEventType, + areaList [1] AreaList, + occurrenceInfo [2] OccurrenceInfo OPTIONAL, + intervalTime [3] IntervalTime OPTIONAL, + maximumInterval [4] MaximumInterval OPTIONAL, + samplingInterval [5] SamplingInterval OPTIONAL, + duration [6] Duration OPTIONAL, + locationInfo [7] LocationInfo OPTIONAL, + ... } +-- msAvailable and periodicLDR in DeferredLocationEventType are not applicable. +-- intervalTime and maximumInterval are not applicable when OccurenceInfo is present with +-- the value of oneTimeEvent. + +AreaList := SEQUENCE SIZE (1..maxAreas) OF Area + +maxAreas INTEGER := 250 + +Area := SEQUENCE { + areaType [0] AreaType, + areaIdentification [1] AreaIdentification, + ..., + areaIdentificationExt [2] AreaIdentificationExt } + +AreaType := ENUMERATED { + trackingArea (0), + ecgi (1), + ..., + trackingArea5GS (2), + ncgi (3) } +-- trackingArea5GS and ncgi shall not be included for an MS without 5GS access + +AreaIdentification := OCTET STRING (SIZE (5..7)) +-- The internal structure is defined as follows: +-- octet 1 bits 4321 Mobile Country Code 1st digit +-- bits 8765 Mobile Country Code 2nd digit +-- octet 2 bits 4321 Mobile Country Code 3rd digit +-- bits 8765 Mobile Network Code 3rd digit if 3 digit MNC included +-- or filler (1111) +-- octet 3 bits 4321 Mobile Network Code 1st digit +-- bits 8765 Mobile Network Code 2nd digit +-- octets 4 and 5 Tracking Area Code for an EPS Tracking Area (bit 8 of octet 4 is the +-- most significant bit and bit 1 of octet 5 the least significant bit) +-- octets 4 until 7 E-UTRAN Cell Identity for an ECGI (bit 8 of octet 4 is the most +-- significant bit and bit 5 of octet 7 the least significant bit) +-- octets 4 until 6 Tracking Area Code for a 5GS Tracking Area (bit 8 of octet 4 is the +-- most significant bit and bit 1 of octet 6 the least significant bit) +-- octets 4 until 7 Cell Identity for an NCGI (bit 8 of octet 4 is the most +-- significant bit and bit 1 of octet 7 the fifth least significant bit. The 4 least +-- significant bits are included in areaIdentificationExt) + +AreaIdentificationExt := OCTET STRING (SIZE (1)) +-- contains the 4 least significant bits of an NCGI in bits 8765 with bit 8 containing the +-- the most significant bit + +OccurrenceInfo := ENUMERATED { + oneTimeEvent (0), + multipleTimeEvent (1), + ... } +-- exception handling: +-- an unrecognized value shall be rejected by the receiver with a return error cause of +-- unexpected data value. + +MaximumInterval := INTEGER (1..86400) +-- maximum time interval between consecutive event reports in seconds. + +SamplingInterval := INTEGER (1..3600) +-- maximum time interval between consecutive evaluations by a UE of a trigger event, +-- in seconds. + +``` + +``` + +Duration ::= INTEGER (1..8640000) +-- maximum duration of event reporting by a UE, in seconds + +LocationInfo ::= BIT STRING { + locationEstimate (0) } (SIZE (1..32)) +-- A bit set to one indicates that the corresponding requirement is present. +-- A bit set to zero indicates that the corresponding requirement is absent. +-- The locationEstimate is a requirement to provide the UE location for an event report to +-- the external client, but the location may be provided by either the UE or network. + +MotionEventReporting ::= SEQUENCE { + linearDistance [0] LinearDistance, + occurrenceInfo [1] OccurrenceInfo OPTIONAL, + intervalTime [2] IntervalTime OPTIONAL, + maximumInterval [3] MaximumInterval OPTIONAL, + samplingInterval [4] SamplingInterval OPTIONAL, + duration [5] Duration OPTIONAL, + locationInfo [6] LocationInfo OPTIONAL, + ... } +-- intervalTime and maximumInterval are not applicable when OccurenceInfo is present with +-- the value of oneTimeEvent. + +LinearDistance ::= INTEGER (1..10000) +-- the minimum straight line distance moved by a UE to trigger a motion event report, in meters. + +LCS-ReferenceNumberExt ::= OCTET STRING (SIZE (1..255)) + +ReportingAccessTypes ::= BIT STRING { + nR (0), + eUTRAConnectedTo5GC (1), + non3GPPConnectedTo5GC (2) } (SIZE (1..16)) +-- A bit set to one indicates that the access type is allowed for event reporting. +-- A bit set to zero or omitted indicates that the access types is not allowed. + +LCS-PeriodicTriggeredInvokeRes ::= SEQUENCE { + ... } + +LCS-EventReportArg ::= SEQUENCE { + eventType [0] EventType, + referenceNumberExt [1] LCS-ReferenceNumberExt, + h-gmlc-callBackUri [2] UTF8String, + locationInfo [3] LocationInfo OPTIONAL, + supportedGADShapes [4] SupportedGADShapes OPTIONAL, + lcs-QoS [5] LCS-QoS OPTIONAL, + multiplePositioningProtocolPDUs [6] MultiplePositioningProtocolPDUs OPTIONAL, + terminationCause [7] TerminationCause OPTIONAL, + ... } +-- inclusion of the terminationCause signifies termination of event reporting by the MS + +EventType ::= ENUMERATED { + periodicEvent (0), + enteringAreaEvent (1), + leavingAreaEvent (2), + beingInsideAreaEvent (3), + motionEvent (4), + maximumIntervalExpirationEvent (5), + locationCancellationEvent (6), + ... } +-- exception handling: +-- an unrecognized value shall be rejected by the receiver with a return error cause of +-- unexpected data value. + +ControlPlane-CIoT-5GS-Optimisation ::= SEQUENCE { + maximumDuration [0] MaximumDuration OPTIONAL, + maximumConsecutiveEventReports [1] MaximumConsecutiveEventReports OPTIONAL, + ... } + +MaximumDuration ::= INTEGER (1..10080) +-- maximum duration for use of Control Plane CIoT 5GS Optimisation. + +MaximumConsecutiveEventReports ::= INTEGER (1..1023) +-- maximum number of consecutive event reports for Control Plane CIoT 5GS Optimisation. + +LCS-EventReportRes ::= SEQUENCE { + deferredRoutingIdentifier [0] OCTET STRING OPTIONAL, + terminationCause [1] TerminationCause OPTIONAL, + ... } + +``` + +``` + +LCS-CancelDeferredLocationArg ::= SEQUENCE { + referenceNumberExt [0] LCS-ReferenceNumberExt, + h-gmlc-callBackUri [2] UTF8String, + ... } + +LCS-LocationPrivacySettingArg ::= SEQUENCE { + locationPrivacyIndication [0] LCS-LocationPrivacyIndication, + validTimePeriod [1] LCS-ValidTimePeriod OPTIONAL, + ... } + +LCS-LocationPrivacyIndication ::= ENUMERATED { + locationDisallowed (0), + locationAllowed (1), + ... } + +LCS-ValidTimePeriod ::= SEQUENCE { + startTime [0] DateTime OPTIONAL, + endTime [1] DateTime OPTIONAL, + ... } + +DateTime ::= OCTET STRING (SIZE (30)) +-- The timestamp at which certain event occurs. Octets are coded according to RFC 3339 [18] + +END + +``` + +### 4.4.3 Identifiers definition + +The parameters which are described in the following clauses correspond to the identifiers used in operation and error descriptions. + +#### 4.4.3.1 chargingInformation + +The chargingInformation identifier refers to the necessary information for the Advice of Charge supplementary service (see TS 22.024). + +#### 4.4.3.2 e1 + +The e1 identifier refers to 10 times the number of LPLMN units per time interval in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.3 e2 + +The e2 identifier refers to 10 times the length of the time interval in seconds in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.4 e3 + +The e3 identifier refers to 100 times the scaling factor to convert from LPLMN units to HPLMN units in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.5 e4 + +The e4 identifier refers to 10 times the LPLMN increment in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.6 e5 + +The e5 identifier refers to 10 times the number of LPLMN units incremented per data interval in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.7 e6 + +The e6 identifier refers to the number of segments per data interval in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.8 e7 + +The e7 identifier refers to 10 times the length of the initial time interval in seconds in connection with the Advice of Charge supplementary service, see TS 22.024. + +#### 4.4.3.9 ss-Code + +The ss-Code identifier refers to the code which identify a supplementary service or a group of supplementary services. + +#### 4.4.3.10 ss-Notification + +The ss-Notification identifier refers to one or several supplementary service notifications which have to be forwarded to a mobile subscriber. + +#### 4.4.3.11 ss-Status + +The ss-Status identifier refers to the status of a supplementary service. + +#### 4.4.3.12 callIsWaiting-Indicator + +The callIsWaiting-Indicator identifier refers to the indication given to the mobile station that the call is waiting. + +#### 4.4.3.13 callOnhold-Indicator + +The callOnHold-Indicator identifier refers to the indication given to the mobile station that the call has been put on hold or has been retrieved. + +#### 4.4.3.14 mpty-Indicator + +The mpty-Indicator identifier refers to the indication given to the mobile station that the multi party call has been invoked. + +#### 4.4.3.15 forwardCUG-InfoArg + +The forwardCUG-InfoArg identifier refers to the indication given from the mobile subscriber to the network in connection with explicit invocation of a CUG call. + +#### 4.4.3.16 cug-Index + +The cug-Index identifier refers to the index of a CUG given in an explicit invocation of a CUG call. + +#### 4.4.3.17 suppressPrefCUG + +The suppressPrefCUG identifier refers to the mobile subscribers request to the network to prohibit the use of the preferential CUG. + +#### 4.4.3.18 suppressOA + +The suppressOA identifier refers to the mobile subscribers request to the network to prohibit the use of the subscriber option "OA allowed". + +#### 4.4.3.19 **clirSuppressionRejected** + +The clirSuppressionRejected identifier refers to the indication given to the mobile station that the CLIR suppression request has been rejected. + +#### 4.4.3.20 **ect-Indicator** + +The ect-Indicator identifier refers to the indication given to the mobile station that the call was transferred. + +#### 4.4.3.21 **ect-CallState** + +The ect-CallState identifier refers to the state of the call to the other remote party in which Explicit Call Transfer was invoked. + +#### 4.4.3.22 **rdn** + +The Rdn identifier refers to the line identity information of the other remote party. + +#### 4.4.3.23 **presentationAllowedAddress** + +The presentationAllowedAddress identifier refers to the line identity of the other remote party that is allowed to be presented. + +#### 4.4.3.24 **presentationRestricted** + +The presentationRestricted identifier refers to the restriction of presentation of the line identity of the other remote party. + +Also, the identifier refers to the restriction of presentation of the name identity of the calling party to the called party. + +#### 4.4.3.25 **numberNotAvailableDueToInterworking** + +The numberNotAvailableDueToInterworking identifier refers to the unavailability of the line identity of the other remote party. + +#### 4.4.3.26 **presentationRestrictedAddress** + +The presentationRestrictedAddress identifier refers to the line identity of the other remote party which presentation restriction is overridden. + +#### 4.4.3.27 **partyNumber** + +The partyNumber identifier refers to the remote party number. + +#### 4.4.3.28 **partyNumberSubaddress** + +The partyNumberSubaddress identifier refers to remote party number subaddress. + +#### 4.4.3.29 **nameIndicator** + +The nameIndicator identifier refers to the indication given to the mobile station that the name presentation has been invoked. + +#### 4.4.3.30 **namePresentationAllowed** + +The namePresentationAllowed identifier refers to the presentation of the calling party's name identity to the called party. + +#### 4.4.3.31 nameUnavailable + +The nameUnavailable identifier refers to the unavailability of the calling party's name identity to be offered to the called party. + +#### 4.4.3.32 namePresentationRestricted + +The namePresentationRestricted identifier refers to the calling party's name identity to be offered to the called party with which presentation restriction is overridden. + +#### 4.4.3.33 deflectedToNumber + +The DeflectedToNumber identifier refers to a party an incoming shall be deflected to. + +#### 4.4.3.34 deflectedToSubaddress + +The DeflectedToSubaddress identifier refers to a subaddress an incoming call shall be deflected to. + +#### 4.4.3.35 uUS-Service + +The uUS-Service identifier refers to the UUS service (service 1, service 2 or service 3) to be requested. + +#### 4.4.3.36 uUS-Required + +The uUS-Required identifier refers to the option ("UUS required" or "UUS not required") given when requesting the UUS service. + +#### 4.4.3.37 locationNotificationArg + +The locationNotificationArg identifier refers to the location notification request which is sent to the MS by the network. + +#### 4.4.3.38 notificationType + +The notificationType identifier refers to the type of location notification (notification or privacy verification). + +#### 4.4.3.39 locationNotificationRes + +The locationNotificationRes identifier refers to the location notification response which is sent to the network by the MS. + +#### 4.4.3.40 verificationResponse + +The VerificationResponse identifier refers to the privacy verification response given by the MS user. + +#### 4.4.3.41 lcs-MOLRArg + +The lcs-MOLRArg identifier refers to the MO-LR request parameters which are sent to the network by the MS. + +#### 4.4.3.42 molr-Type + +The molr-Type identifier refers to the type of MO-LR. + +#### 4.4.3.43 locationMethod + +The locationMethod identifier refers to the location method, for which assistance data is requested by the MS. + +#### 4.4.3.44 gpsAssistanceData + +The gpsAssistanceData identifier refers to the indication, which GPS assistance data is requested by the MS. + +#### 4.4.3.45 lcs-MOLRRes + +The lcs-MOLRRes identifier refers to the MO-LR response parameters which are sent to the MS by the network. + +#### 4.4.3.46 decipheringKeys + +The decipheringKeys identifier refers to the set of deciphering keys, that contains Current Deciphering Key, Next Deciphering Key and Ciphering Key Flag. + +#### 4.4.3.47 multicall-Indicator + +The multicall-Indicator identifier refers to the indication given to the mobile station that the number of active bearers has exceeded the maximum number. + +#### 4.4.3.48 pseudonymIndicator + +The pseudonymIndicator identifier refers to the indication given to the LCS server that the pseudonym is needed. + +#### 4.4.3.49 LCS-PeriodicLocationRequestArg + +The LCS-PeriodicLocationRequestArg identifier refers to the LCS periodic location request sent to the MS by the network. + +#### 4.4.3.50 LCS-PeriodicLocationRequestRes + +The LCS-PeriodicLocationRequestRes identifier refers to the LCS Periodic Location response sent by the MS to the network. + +#### 4.4.3.51 LCS-LocationUpdateArg + +The LCS-LocationUpdateArg identifier refers to the location update request sent to the MS by the network. + +#### 4.4.3.52 LCS-LocationUpdateRes + +The LCS-LocationUpdateRes identifier refers to the location update response sent to the network by the MS. + +#### 4.4.3.53 LCS-PeriodicLocationCancellationArg + +The LCS-PeriodicLocationCancellationArg identifier refers to the periodic location cancel request sent to the MS by the network. + +#### 4.4.3.54 terminationCause + +The terminationCause identifier refers to the cause of cancellation or termination of the periodic or triggered location procedure by the MS or by the network. + +#### 4.4.3.55 mo-lrShortCircuit + +The mo-lrShortCircuit identifier indicates use of MO-LR Short Circuit. + +#### 4.4.3.56 locationUpdateRequest + +The locationUpdateRequest identifier indicates location update are required. + +#### 4.4.3.57 ganssAssistanceData + +The ganssAssistanceData identifier refers to the indication, which GANSS assistance data is requested by the MS. + +#### 4.4.3.58 positioningProtocolPDU + +The positioningProtocolPDU identifier refers to the positioning information (in LPP message format see 3GPP TS 36.355 [17]) passed in a lcs-MOLR Invoke for E-UTRA connected to EPC LCS or in an lcs-PeriodicTriggeredInvoke or lcs-EventReport for 5GS. + +#### 4.4.3.59 multiplePositioningProtocolPDUs + +The multiplePositioningProtocolPDUs identifier refers to a set of Positioning Protocol PDUs passed in a lcs-MOLRInvoke for E-UTRA connected to EPC LCS or in an lcs-PeriodicTriggeredInvoke or lcs-EventReport for 5GS. + +#### 4.4.3.60 LCS-PeriodicTriggeredInvokeArg + +The LCS-PeriodicTriggeredInvokeArg identifier refers to the LCS periodic and triggered location invoke sent to the MS by the network for EPS or 5GS. + +#### 4.4.3.61 LCS-PeriodicTriggeredInvokeRes + +The LCS-PeriodicTriggeredInvokeRes identifier refers to the LCS periodic and triggered location response sent by the MS to the network for EPS or 5GS. + +#### 4.4.3.62 periodicLocation + +The periodicLocation identifier refers to parameters for periodic location of the MS. + +#### 4.4.3.63 areaEventReporting + +The areaEventReporting identifier refers to parameters for periodic and triggered area event reporting for the MS. + +#### 4.4.3.64 areaList + +The areaList identifier refers to a set of one or more areas for periodic and triggered area event reporting for the MS. + +#### 4.4.3.65 area + +The area identifier refers to parameters for a single area for periodic and triggered area event reporting for the MS. + +#### 4.4.3.66 areaType + +The areaType identifier refers to the type of an area for periodic and triggered area event reporting for the MS. + +#### 4.4.3.67 areaIdentification + +The areaIdentification identifier refers to an identification of an area for periodic and triggered area event reporting for the MS. + +#### 4.4.3.68 maximumInterval + +The maximumInterval identifier refers to the maximum time interval between consecutive periodic and triggered event reports for the MS. + +#### 4.4.3.69 samplingInterval + +The samplingInterval identifier refers to the maximum evaluation interval for determining periodic and triggered event reports for the MS. + +#### 4.4.3.70 duration + +The duration identifier refers to the maximum duration for periodic and triggered event reports for the MS. + +#### 4.4.3.71 location-Info + +The location-Info identifier refers to requirements for obtaining location information for periodic and triggered event reports for the MS for EPS or 5GS. + +#### 4.4.3.72 motionEventReporting + +The motionEventReporting identifier refers to parameters for periodic and triggered motion event reporting for the MS. + +#### 4.4.3.73 linearDistance + +The linearDistance identifier refers to a minimum linear distance for periodic and triggered motion event reporting for the MS. + +#### 4.4.3.74 LCS-EventReportArg + +The LCS-EventReportArg identifier refers to the LCS event report invoke sent to the MS by the network for 5GS for periodic and triggered location. + +#### 4.4.3.75 LCS-EventReportRes + +The LCS-EventReportRes identifier refers to the LCS event report response sent by the MS to the network for 5GS for periodic and triggered location. + +#### 4.4.3.76 LCS-CancelDeferredLocationArg + +The LCS-CancelDeferredLocationArg identifier refers to the location cancel request sent to the MS by the network or sent to the network by the MS for deferred periodic or triggered location for 5GS. + +#### 4.4.3.77 eventType + +The eventType identifier refers to the type of event report. + +#### 4.4.3.78 referenceNumberExt + +The referenceNumberExt identifier refers to the LDR reference number for a 5GC GMLC. + +#### 4.4.3.79 h-gmlc-callBackUri + +The h-gmlc-callBackUri identifier refers to the UTF-8 encoded URI for a 5GC GMLC. + +#### 4.4.3.80 supportedGADShapes + +The supportedGADShapes identifier refers to GAD shapes supported by a GMLC. + +### 4.4.3.81 lcs-QoS + +The lcs-QoS identifier refers to the QoS requirements for a location estimate. + +#### 4.4.3.82 controlPlane-CIoT-5GS-Optimisation + +The controlPlane-CIoT-5GS-Optimisation identifier indicates the MS is allowed to use Control Plane CIoT 5GS Optimisation for sending event reports for triggered and periodic location. + +#### 4.4.3.83 LCS-LocationPrivacySettingArg + +The LCS-LocationPrivacySettingArg identifier refers to parameter(s) for the MS indicated Location Privacy Indication information and optional validity time for the indication sent to the network by the MS. + +#### 4.4.3.84 locationPrivacyIndication + +The LocationPrivacyIndication identifier refers to MS indicated Location Privacy Indication. + +#### 4.4.3.85 validTimePeriod + +The validTimePeriod identifier refers to validity period for the MS indicated Location Privacy Indication. + +#### 4.4.3.86 endTime + +The endTime identifier refers to the validity time (in UTC time) when MS indicated Location Privacy Indication become invalid. + +### 4.5 Operations and errors implementation + +For the actual implementation of supplementary services, operations and errors have to be defined by value. The following ASN.1 module, imports operation from the ASN.1 module described in clause 4.2 and operations and errors from MAP. + +``` + +SS-Protocol { + itu-t identified-organization (4) etsi (0) mobileDomain (0) + gsm-Access (2) modules (3) ss-Protocol (3) version15 (15)} + +DEFINITIONS ::= +BEGIN + +IMPORTS + +OPERATION +FROM Remote-Operations-Information-Objects { + joint-iso-itu-t remote-operations(4) informationObjects(5) version1(0)} + +-- imports operations + +-- imports operation from MAP-MobileServiceOperations +forwardCheckSS-Indication +FROM MAP-MobileServiceOperations { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-MobileServiceOperations (5) version19 (19)} + +-- imports operations from MAP-SupplementaryServiceOperations +registerSS, eraseSS, activateSS, deactivateSS, interrogateSS, registerPassword, getPassword, +processUnstructuredSS-Request, unstructuredSS-Request, unstructuredSS-Notify, eraseCC-Entry +FROM MAP-SupplementaryServiceOperations { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) + map-SupplementaryServiceOperations (8) version19 (19)} + +-- imports operations from SS-Operations +processUnstructuredSS-Data, notifySS, forwardChargeAdvice, buildMPTY, holdMPTY, retrieveMPTY, +splitMPTY, explicitCT, forwardCUG-Info, accessRegisterCCEntry, callDeflection, userUserService, +lcs-LocationNotification, lcs-MOLR, lcs-AreaEventRequest, lcs-AreaEventReport, +lcs-AreaEventCancellation, lcs-PeriodicLocationRequest, lcs-LocationUpdate, +lcs-PeriodicLocationCancellation, lcs-PeriodicTriggeredInvoke, lcs-EventReport, +lcs-CancelDeferredLocation +FROM SS-Operations { + itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Access (2) modules (3) + ss-Operations (0) version15 (15)} + +``` + +; + +Supported-SS-Operations OPERATION ::= { forwardCheckSS-Indication | registerSS | eraseSS | +activateSS | deactivateSS | interrogateSS | registerPassword | getPassword | +processUnstructuredSS-Request | unstructuredSS-Request | unstructuredSS-Notify | eraseCC-Entry | +processUnstructuredSS-Data | notifySS | forwardChargeAdvice | buildMPTY | holdMPTY | +retrieveMPTY | splitMPTY | explicitCT | forwardCUG-Info | accessRegisterCCEntry | +callDeflection | userUserService | lcs-LocationNotification | lcs-MOLR | lcs-AreaEventRequest | +lcs-AreaEventReport | lcs-AreaEventCancellation | lcs-PeriodicLocationRequest | +lcs-LocationUpdate | lcs-PeriodicLocationCancellation | lcs-PeriodicTriggeredInvoke | +lcs-EventReport | lcs-CancelDeferredLocation } + +END + +--- + +## Annex A (informative): Expanded ASN.1 Module "SS-Protocol" + +The fully expanded ASN.1 sources of the SS protocol is provided for information at [http://www.3gpp.org/ftp/Specs/archive/24\\_series/24.080/ASN.1/](http://www.3gpp.org/ftp/Specs/archive/24_series/24.080/ASN.1/). + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|------|-------|-----|-----|-----------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| Apr 1999 | | | | | | Transferred to 3GPP CN1 | | +| CN#03 | CN#03 | | | 1 | | Approved at CN#03 | 3.0.0 | +| CN#06 | CN#06 | | 001 | | | Addition of LCS operations | 3.1.0 | +| CN#07 | CN#07 | | 002r1 | 1 | | Correction to Location Notification Type and LCS-MOLR errors | 3.2.0 | +| CN#08 | CN#08 | | 004 | | | Correction of definition of Deflected-to number | 3.3.0 | +| CN#09 | CN#09 | | 005r1 | | | Message type: Alignment to 24.007 and 24.008 | 3.4.0 | +| CN#09 | CN#09 | | 006 | | | Addition of error type description for PositionMethodFailure | 3.4.0 | +| | | | | | | Update of Annex A | 3.4.1 | +| CN#11 | CN#11 | | | | | Release 4 after CN#11 | 4.0.0 | +| CN#12 | CN#12 | | 008 | - | | Add support in DTAP for all shapes defined in 23.032 | 4.1.0 | +| CN#12 | CN#12 | | 009 | - | | OTDOA location method to be added | 4.1.0 | +| CN#12 | CN#12 | | 011r1 | 1 | | Addition of the description for Multicall missing from 24.080 | 4.1.0 | +| CN#14 | CN#14 | | 014 | - | | Message type: completion of alignment to 24.007 and 24.008 | 4.2.0 | +| CN#15 | CN#15 | | 015r1 | 1 | | Introduction of the "Requestor ID" | 5.0.0 | +| CN#16 | CN#16 | | 023 | - | | LCS: error handling if shape not supported by MS | 5.1.0 | +| CN#16 | CN#16 | | 018 | - | | LCS: Error handling if wrong method requested in LCS-MOLR | 5.1.0 | +| CN#16 | CN#16 | | 016 | - | | LCS: Codeword and Service Type | 5.1.0 | +| CN#16 | CN#16 | | 020 | - | | Correction of Object Identifiers for ASN.1 modules | 5.1.0 | +| CN#17 | CN#17 | | 019r3 | 3 | | Compatible upgrade to ASN.1:1997 of 24.080 | 5.2.0 | +| CN#17 | CN#17 | | 024 | - | | Correction of references to FACILITY information element | 5.2.0 | +| CN#18 | CN#18 | | 026 | 2 | | LCS: Exception handling for positioning methods MS Assisted E-OTD and MS Assisted OTDOA | 5.3.0 | +| CN#21 | CN#21 | | 029 | - | | Reduce maximum length of "LCS Requestor ID" and "LCS Codeword". | 5.4.0 | +| CN#21 | CN#21 | | | - | | A wrong SS version indicator link corrected in table 2.4. | 5.4.0 | +| CN#22 | CN#22 | | 031 | 2 | | Deferred MT-LR Area Event | 6.0.0 | +| CN#23 | CN#23 | | 034 | - | | Removal of R-GMLC Address | 6.1.0 | +| CN#23 | CN#23 | | 033 | 1 | | MO-LR Service Identity support | 6.1.0 | +| CN#26 | CN#26 | | 042 | 1 | | Sequence numbering for SS via PS | 6.2.0 | +| CN#26 | CN#26 | | 038 | - | | Correction of setting for timer T(LCSL) | 6.2.0 | +| CN#27 | CN#27 | | 043 | 1 | | Miss alignment with stage 2 on reuse mechanism | 6.3.0 | +| CN#27 | CN#27 | | 044 | - | | Pseudonym indicator support in MO-LR | 6.3.0 | +| CT#29 | CT#29 | | 0045 | 2 | | Enabling the Providing of Velocity | 7.0.0 | +| CT#29 | CT#29 | | 0046 | - | | ASN.1 module version update | 7.0.0 | +| CT#31 | CT#31 | | 0047 | - | | Addition of Periodic Location Feature Support | 7.1.0 | +| CT#33 | CT#33 | | 0048 | 1 | | Removal of ASN.1 Expanded Source | 7.2.0 | +| CT#36 | CT#36 | | 0053 | 2 | | Add Assisted GANSS as a New Positioning Method | 7.3.0 | +| CT#37 | CT#37 | | 0057 | 1 | | Clarification of SS LCS Location Notification | 7.4.0 | +| CT#37 | CT#37 | | 0056 | 1 | | Correction to GANSS Location Method | 7.4.0 | +| CT#42 | CT#42 | | | - | | Upgraded unchanged from Rel-7 | 8.0.0 | +| 2009-12 | | | - | - | | Update to Rel-9 version (MCC) | 9.0.0 | +| CT#47 | | | 0059 | 1 | | E-UTRAN LCS Support | 9.1.0 | +| CT#48 | | | 0063 | - | | ASN.1 Module Version Update | 9.2.0 | +| 2011-03 | | | - | - | | Update to Rel-10 version (MCC) | 10.0.0 | +| 2012-06 | | | - | - | | Update to Rel-11 version (MCC) | 11.0.0 | +| 2014-09 | | | - | - | | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | | | - | - | | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | | - | - | | Update to Rel-14 version (MCC) | 14.0.0 | +| 2017-06 | CT#76 | | 0064 | 2 | | Enhancements to Location Services for CIoT | 14.1.0 | +| 2018-06 | CT#80 | | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-06 | CT#84 | | 0066 | - | | ASN.1 corrections | 15.1.0 | +| 2019-09 | CT#85 | | 0067 | 1 | | Supplementary services for a deferred 5GC-MT-LR | 16.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------|--------| +| 2020-06 | CT#88e | | 0068 | 1 | B | Supplementary LCS Service Operations | 16.1.0 | +| 2020-09 | CT#89e | CP-202112 | 0069 | - | F | ASN.1 Corrections | 16.2.0 | +| 2021-06 | CT#92e | CP-211074 | 0072 | | F | ASN.1 module version update | 16.3.0 | +| 2021-12 | CT#94e | CP-213135 | 0074 | - | F | Reference to 24.571 | 16.4.0 | +| 2022-03 | CT#95e | CP-220083 | 0088 | 1 | F | Remove h-gmlc-address from LCS-MOLRArg | 16.5.0 | +| 2022-03 | CT#95e | CP-220083 | 0091 | 1 | F | locationMethod in LCS-MOLRArg | 16.5.0 | +| 2022-03 | CT#95e | CP-220085 | 0094 | - | F | DateTime re-coding | 16.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24081/28d250125d6a79bb23a8a3d459f54cb6_img.jpg b/marked/Rel-16/24_series/24081/28d250125d6a79bb23a8a3d459f54cb6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab6c3c94a68664fdc802431f19be819943438116 --- /dev/null +++ b/marked/Rel-16/24_series/24081/28d250125d6a79bb23a8a3d459f54cb6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:493cc665cb57168e044e08365a106e01bf6b9c3e908a324f77818d51d6840fdc +size 24480 diff --git a/marked/Rel-16/24_series/24081/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/24_series/24081/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac54193f51b0440a82e3f881d183e03b608ff650 --- /dev/null +++ b/marked/Rel-16/24_series/24081/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9171c6e80d677ec22c354473eb6f85b1362679a966e5006a8f2f10b89beab6ab +size 54927 diff --git a/marked/Rel-16/24_series/24081/9283a3f6b39120df9dc9aee4712b3a0a_img.jpg b/marked/Rel-16/24_series/24081/9283a3f6b39120df9dc9aee4712b3a0a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7bdf476eabdd0a0758611d663025df5a8899deff --- /dev/null +++ b/marked/Rel-16/24_series/24081/9283a3f6b39120df9dc9aee4712b3a0a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:472790e0fc452bf21cdb93498897b9953b57b93c0773a7f20e6e6f8e58c38f76 +size 21463 diff --git a/marked/Rel-16/24_series/24081/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg b/marked/Rel-16/24_series/24081/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..714dae4e42d47860faae6cabe55edac361f7bd9f --- /dev/null +++ b/marked/Rel-16/24_series/24081/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f7416d83102ae5d5dba8875080a560a601a2196b59d4e5fc6e20cd598315207 +size 52168 diff --git a/marked/Rel-16/24_series/24081/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/24_series/24081/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f72bd2e9f9c577751e4c0e71568a3293619da0b --- /dev/null +++ b/marked/Rel-16/24_series/24081/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db65359bc9146c4a675ae6613a94c31810ae5713b6147db38d537f9f2bd7ca6d +size 25646 diff --git a/marked/Rel-16/24_series/24081/e1a0d046fbe7f28f5e93a47091851747_img.jpg b/marked/Rel-16/24_series/24081/e1a0d046fbe7f28f5e93a47091851747_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42572af56895380edc64c77e30f75bbb261bcdec --- /dev/null +++ b/marked/Rel-16/24_series/24081/e1a0d046fbe7f28f5e93a47091851747_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc21b83927b691f50aca3ab8442d8b7fd33bca650cb15f6c33cbcb7a1fd7a4bb +size 30316 diff --git a/marked/Rel-16/24_series/24081/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/24_series/24081/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9dae1f1f0d136fe05de4aa2f9e0e2a884711b0e5 --- /dev/null +++ b/marked/Rel-16/24_series/24081/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c512651afb7a6dc4e7d0f232a527dbb42c8f108a2d7497e4d5faa6f2c06d906 +size 53903 diff --git a/marked/Rel-16/24_series/24081/ef7a88e04d1939ee09bafd5c3072adf8_img.jpg b/marked/Rel-16/24_series/24081/ef7a88e04d1939ee09bafd5c3072adf8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dcfba190e862be734cfccde13e991b3f8b5cfdb8 --- /dev/null +++ b/marked/Rel-16/24_series/24081/ef7a88e04d1939ee09bafd5c3072adf8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03ea175cd43c20fa8753f765594dddcb0cddd48407b8ed0c8c80f81dcb3e3c2b +size 52890 diff --git a/marked/Rel-16/24_series/24081/raw.md b/marked/Rel-16/24_series/24081/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2f22ed7c31488fdcaa1f38b973b4f8e69575e411 --- /dev/null +++ b/marked/Rel-16/24_series/24081/raw.md @@ -0,0 +1,398 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 0 Scope..... | 5 | +| 0.1 References ..... | 5 | +| 0.2 Abbreviations ..... | 6 | +| 1 Calling Line Identification Presentation (CLIP) ..... | 6 | +| 1.1 Normal operation..... | 6 | +| 1.2 Interrogation ..... | 7 | +| 1.3 Activation, deactivation, registration and erasure..... | 7 | +| 2 Calling Line Identification Restriction (CLIR)..... | 7 | +| 2.1 Normal Operation..... | 7 | +| 2.2 Requesting presentation of CLI..... | 8 | +| 2.3 Requesting restriction of CLI presentation ..... | 8 | +| 2.4 Interrogation ..... | 8 | +| 2.5 Activation, deactivation, registration and erasure..... | 9 | +| 3 Connected Line Identification Presentation (COLP) ..... | 9 | +| 3.1 Normal operation..... | 9 | +| 3.2 Interrogation ..... | 10 | +| 3.3 Activation, deactivation, registration and erasure..... | 10 | +| 4 Connected Line Identification Restriction (COLR)..... | 10 | +| 4.1 Normal operation..... | 10 | +| 4.2 Interrogation ..... | 11 | +| 4.3 Activation, deactivation, registration and erasure..... | 11 | +| Annex A (informative): Change history..... | 12 | + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS specifies the procedures used at the radio interface for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of line identification supplementary services within the 3GPP system. + +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: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# 0 Scope + +The present document specifies the procedures used at the radio interface for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of line identification supplementary services. Provision and withdrawal of supplementary services is an administrative matter between the mobile subscriber and the service provider and cause no signalling on the radio interface. + +In 3GPP TS 24.010 the general aspects of the specification of supplementary services at the layer 3 radio interface are given. + +3GPP TS 24.080 specifies the formats and coding for the supplementary services. + +Definitions and descriptions of supplementary services are given in 3GPP TS 22.004 and 3GPP TS 22.08x and 3GPP TS 22.09x-series. 3GPP TS 22.081 is related specially to line identification supplementary services. + +Technical realization of supplementary services is described in 3GPP TS 23.011 and 3GPP TS 23.08x and 3GPP TS 23.09x-series. 3GPP TS 23.081 is related specially to line identification supplementary services. + +The procedures for Call Control, Mobility Management and Radio Resource management at the layer 3 radio interface are defined in 3GPP TS 24.007 and 3GPP TS 24.008. + +The following supplementary services belong to the line identification supplementary services and are described in the present document: + +- | | | | +|----------------------------------------------|--------|-------------| +| - Calling line identification presentation | (CLIP) | (clause 1); | +| - Calling line identification restriction | (CLIR) | (clause 2); | +| - Connected line identification presentation | (COLP) | (clause 3); | +| - Connected line identification restriction | (COLR) | (clause 4). | + +## 0.1 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications ". +- [2] 3GPP TS 22.081: "General on supplementary services". +- [3] 3GPP TS 22.081: "Line identification supplementary services - Stage 1". +- [4] 3GPP TS 22.082: "Call Forwarding (CF) supplementary services - Stage 1". +- [5] 3GPP TS 22.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 1". +- [6] 3GPP TS 22.084: "MultiParty (MPTY) supplementary services - Stage 1". +- [7] 3GPP TS 22.085: "Closed User Group (CUG) supplementary services - Stage 1". +- [8] 3GPP TS 22.086: "Advice of Charge (AoC) supplementary services - Stage 1". +- [9] 3GPP TS 22.088: "Call Barring (CB) supplementary services - Stage 1". +- [10] 3GPP TS 22.090: "Unstructured Supplementary Service Data (USSD) - Stage 1". + +- [11] 3GPP TS 23.011: "Technical realization of supplementary services". +- [12] 3GPP TS 23.081: "Line identification supplementary services - Stage 2". +- [13] 3GPP TS 23.082: "Call Forwarding (CF) supplementary services - Stage 2". +- [14] 3GPP TS 23.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 2". +- [15] 3GPP TS 23.084 "MultiParty (MPTY) supplementary services - Stage 2". +- [16] 3GPP TS 23.085: "Closed User Group (CUG) supplementary services - Stage 2". +- [17] 3GPP TS 23.086: "Advice of Charge (AoC) supplementary services - Stage 2". +- [18] 3GPP TS 23.088: "Call Barring (CB) supplementary services - Stage 2". +- [19] 3GPP TS 23.090: "Unstructured supplementary services operation - Stage 2". +- [20] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [21] 3GPP TS 24.008: "Mobile radio interface layer 3 specification". +- [22] 3GPP TS 24.010: "Mobile radio interface layer 3; Supplementary services specification; General aspects". +- [23] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". + +## 0.2 Abbreviations + +Abbreviations used in the present document are listed in 3GPP TR 21.905. + +# 1 Calling Line Identification Presentation (CLIP) + +## 1.1 Normal operation + +The calling line identity consists of a calling party BCD number and optionally, a calling party subaddress and/or a cause of no CLI. + +The calling party BCD number information element is made up of a number of information units as indicated in 3GPP TS 24.008. + +In addition to or instead of the calling party's digits, the subscriber may be given the following information: + +- screening indicator; +- presentation indicator. + +Indicator values are given in 3GPP TS 24.008. + +The calling party subaddress information element is made up of a number of information units as indicated in 3GPP TS 24.008. + +The cause of no CLI information element is made up of a detailed cause of no CLI as indicated in TS 24.008. + +A called mobile subscriber subscribing to calling line identification presentation service receives the call with the information indicated above, see figure 1.1. + +![Sequence diagram showing a SETUP message from Network to MSb containing calling party details.](28d250125d6a79bb23a8a3d459f54cb6_img.jpg) + +``` + +sequenceDiagram + participant MSb + participant Network + Network-->>MSb: SETUP (Calling party BCD number (screening indicator, presentation indicator, calling party digits), Calling party subaddress, Cause of No CLI) + +``` + +Sequence diagram showing a SETUP message from Network to MSb containing calling party details. + +NOTE: The calling party subaddress is passed to MSb if it is received from the originating network. + +**Figure 1.1: Notification by the network to the called mobile subscriber** + +When the calling line identity is not available, the presentation indicator which is given to the called mobile subscriber takes the value of "number not available". + +## 1.2 Interrogation + +### Status Check + +The mobile subscriber can request the status of the supplementary service and be informed if the service is provided to him. + +![Sequence diagram showing the interrogation of calling line identification presentation between MSa and Network. The sequence starts with MSa sending a REGISTER message to Network. Network responds with Facility (Invoke = InterrogateSS (CLIP)) and RELEASE COMPLETE. MSa then sends Facility (Return Result = InterrogateSS (SS-Status)) and RELEASE COMPLETE. Network responds with Facility (Return Error (Error)) and RELEASE COMPLETE. Finally, MSa sends Facility (Reject (Invoke_problem)).](ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg) + +``` + +sequenceDiagram + participant MSa + participant Network + Note right of Network: REGISTER + MSa->>Network: Facility (Invoke = InterrogateSS (CLIP)) + Network-->>MSa: RELEASE COMPLETE + Note left of Network: Facility (Return Result = InterrogateSS (SS-Status)) + MSa-->>Network: RELEASE COMPLETE + Note right of Network: Facility (Return Error (Error)) + Network-->>MSa: RELEASE COMPLETE + Note left of Network: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the interrogation of calling line identification presentation between MSa and Network. The sequence starts with MSa sending a REGISTER message to Network. Network responds with Facility (Invoke = InterrogateSS (CLIP)) and RELEASE COMPLETE. MSa then sends Facility (Return Result = InterrogateSS (SS-Status)) and RELEASE COMPLETE. Network responds with Facility (Return Error (Error)) and RELEASE COMPLETE. Finally, MSa sends Facility (Reject (Invoke\_problem)). + +**Figure 1.2: Interrogation of calling line identification presentation** + +## 1.3 Activation, deactivation, registration and erasure + +Activation, deactivation, registration and erasure of the supplementary service calling line identification presentation are not applicable. + +# 2 Calling Line Identification Restriction (CLIR) + +## 2.1 Normal Operation + +When calling line identification restriction is applicable, the originating network provides the destination network with a notification that the calling party's ISDN number, with possible additional address information, is not allowed to be presented to the called party. + +If the called mobile user subscribes to calling line identification presentation and the calling party has calling line identification restriction applied, the called mobile party shall receive the presentation indicator showing "presentation restricted" in the calling party BCD field of the SETUP message, see figure 1.1. In this case, the calling party's number (digits) will not be sent towards the called subscriber. + +## 2.2 Requesting presentation of CLI + +When the CLIR presentation mode is temporary (presentation restricted), it is possible for the subscriber to present his CLI on a per call basis. The MS shall send a CLIR suppression information element to the network. + +If the subscriber tries to override CLIR (i.e. requests that the CLI is displayed), when he has subscribed to permanent mode a NotifySS shall be sent to the MS in order to inform that the override has not been performed and the call set-up shall continue. + +![Sequence diagram showing the request for CLIR presentation. MSa sends a SETUP message to Network. Network responds with CLIR suppression FACILITY. MSa then sends a Facility (Invoke = NotifySS (CLIR, CLIR Suppression Rejected)) message.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +sequenceDiagram + participant MSa + participant Network + Note right of Network: SETUP + Network-->>MSa: CLIR suppression FACILITY + Note left of MSa: Facility (Invoke = NotifySS (CLIR, CLIR Suppression Rejected)) + +``` + +Sequence diagram showing the request for CLIR presentation. MSa sends a SETUP message to Network. Network responds with CLIR suppression FACILITY. MSa then sends a Facility (Invoke = NotifySS (CLIR, CLIR Suppression Rejected)) message. + +**Figure 2.1: Requesting presentation of CLI** + +## 2.3 Requesting restriction of CLI presentation + +When the CLIR presentation mode is temporary (presentation allowed), it is possible for the subscriber to restrict the CLI on a per call basis. The MS shall send a CLIR invocation information element to the network. + +If the subscriber has not subscribed to CLIR and tries to invoke CLIR (i.e. requests that the CLI is not displayed), the SETUP shall be rejected. The MS and the network shall act in accordance with 3GPP TS 24.008 network initiated call clearing procedure, see figure 2.2. + +![Sequence diagram showing the request for restriction of CLI presentation. MSa sends a SETUP message to Network. Network responds with CLIR invocation DISCONNECT/RELEASE/RELEASE COMPLETE. MSa then sends a Cause #50 (Facility not subscribed, diagnostic = CLIR not subscribed) message.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +``` + +sequenceDiagram + participant MSa + participant Network + Note right of Network: SETUP + Network-->>MSa: CLIR invocation DISCONNECT/RELEASE/RELEASE COMPLETE + Note left of MSa: Cause #50 (Facility not subscribed, diagnostic = CLIR not subscribed) + +``` + +Sequence diagram showing the request for restriction of CLI presentation. MSa sends a SETUP message to Network. Network responds with CLIR invocation DISCONNECT/RELEASE/RELEASE COMPLETE. MSa then sends a Cause #50 (Facility not subscribed, diagnostic = CLIR not subscribed) message. + +**Figure 2.2: Requesting restriction of CLI presentation** + +## 2.4 Interrogation + +### Data request + +The mobile subscriber can request the data of the supplementary service. + +If the service is not provisioned the network shall sent a return result including the SS-Status parameter. + +If the service is provisioned the network shall sent a return result including the SS-Status and the CLI Restriction Option parameters. + +![Sequence diagram showing the interrogation of calling line identification restriction. MSa sends a REGISTER message to Network. Network responds with Facility (Invoke = InterrogateSS (CLIR)) RELEASE COMPLETE. MSa then sends Facility (Return Result = InterrogateSS (SS-Status, CLI Restriction Option)) RELEASE COMPLETE. Network responds with Facility (Return Error (Error)) RELEASE COMPLETE. MSa then sends Facility (Reject (Invoke_problem)) message.](ef7a88e04d1939ee09bafd5c3072adf8_img.jpg) + +``` + +sequenceDiagram + participant MSa + participant Network + Note right of Network: REGISTER + Network-->>MSa: Facility (Invoke = InterrogateSS (CLIR)) RELEASE COMPLETE + Note left of MSa: Facility (Return Result = InterrogateSS (SS-Status, CLI Restriction Option)) RELEASE COMPLETE + Network-->>MSa: Facility (Return Error (Error)) RELEASE COMPLETE + Note left of MSa: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the interrogation of calling line identification restriction. MSa sends a REGISTER message to Network. Network responds with Facility (Invoke = InterrogateSS (CLIR)) RELEASE COMPLETE. MSa then sends Facility (Return Result = InterrogateSS (SS-Status, CLI Restriction Option)) RELEASE COMPLETE. Network responds with Facility (Return Error (Error)) RELEASE COMPLETE. MSa then sends Facility (Reject (Invoke\_problem)) message. + +**Figure 2.3: Interrogation of calling line identification restriction** + +## 2.5 Activation, deactivation, registration and erasure + +Activation, deactivation, registration and erasure of the supplementary service calling line identification restriction are not applicable. + +# 3 Connected Line Identification Presentation (COLP) + +## 3.1 Normal operation + +The connected line identity consists of a connected number and optionally, a connected subaddress. + +The connected number is made up of a number of information units as indicated in 3GPP TS 24.008. + +In addition to or instead of the connected number digits, the subscriber may be given the following information: + +- screening indicator; +- presentation indicator. + +Indicator values are given in 3GPP TS 24.008. + +In the call set-up phase the calling mobile subscriber receives the information at the end of the call set-up. + +The connected subaddress information element is made up of a number of information units as indicated in 3GPP TS 24.008. + +A calling mobile subscriber subscribing to connected line identification presentation receives a message with the information indicated above, see figure 3.1. + +![Diagram showing the notification from the network to the calling mobile subscriber (MSa) via CONNECT message.](9283a3f6b39120df9dc9aee4712b3a0a_img.jpg) + +The diagram illustrates the flow of information from the Network to the MSa. At the top, 'MSa' is on the left and 'Network' is on the right. A dashed horizontal line with a left-pointing arrowhead spans between them. Above this line, the word 'CONNECT' is centered. Below the line, the message content is described: 'Connectednumber (Screening-indicator, Presentation-indicator, Connected number digits), Connected subaddress'. + +Diagram showing the notification from the network to the calling mobile subscriber (MSa) via CONNECT message. + +NOTE: The connected subaddress is passed to MSa if it is received from the terminating network. + +**Figure 3.1: Notification by the network to the calling mobile subscriber** + +When the connected line identity is not available (due to interworking or presentation restrictions), appropriate indication information is given to the calling mobile subscriber. + +## 3.2 Interrogation + +### Status Check + +The mobile subscriber can request the status of the supplementary service and be informed if the service is provided to him. + +![Sequence diagram showing the interrogation of connected line identification presentation between MSa and Network. The diagram includes messages for REGISTER, Facility (Invoke = InterrogateSS (COLP)), RELEASE COMPLETE, Facility (Return Result = Interrogate SS (SS-status)), Facility (Return Error (Error)), and Facility (Reject (Invoke_problem)).](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant MSa + participant Network + Note over MSa, Network: REGISTER + MSa->>Network: Facility (Invoke = InterrogateSS (COLP)) + Network-->>MSa: RELEASE COMPLETE + Network-->>MSa: Facility (Return Result = Interrogate SS (SS-status)) + Network-->>MSa: RELEASE COMPLETE + Network-->>MSa: Facility (Return Error (Error)) + Network-->>MSa: RELEASE COMPLETE + Network-->>MSa: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the interrogation of connected line identification presentation between MSa and Network. The diagram includes messages for REGISTER, Facility (Invoke = InterrogateSS (COLP)), RELEASE COMPLETE, Facility (Return Result = Interrogate SS (SS-status)), Facility (Return Error (Error)), and Facility (Reject (Invoke\_problem)). + +Figure 3.2: Interrogation of connected line identification presentation + +## 3.3 Activation, deactivation, registration and erasure + +Activation, deactivation, registration and erasure of the supplementary service connected line identification presentation is not applicable. + +# 4 Connected Line Identification Restriction (COLR) + +## 4.1 Normal operation + +When connected line identification restriction is applicable the destination network provides the originating network with a notification that the connected party's ISDN number, with possible additional address information, is not allowed to be presented to the calling party. + +If the calling mobile user subscribes to connected line identification presentation and the connected party has connected line identification restriction applied, the calling mobile party shall receive the presentation indicator showing "presentation restricted", see figure 3.1. In this case, the connected number will not be sent towards the calling subscriber. + +## 4.2 Interrogation + +### Status Check + +The mobile subscriber can request the status of the supplementary service and be informed if the service is provided to him. + +![Sequence diagram showing MSa and Network interaction for REGISTER. The diagram shows four message exchanges: 1. MSa to Network: Facility (Invoke = InterrogateSS (COLR)) followed by RELEASE COMPLETE. 2. Network to MSa: Facility (Return Result = InterrogateSS (SS-Status)) followed by RELEASE COMPLETE. 3. Network to MSa: Facility (Return Error (Error)) followed by RELEASE COMPLETE. 4. Network to MSa: Facility (Reject (Invoke_problem)).](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant MSa + participant Network + Note over MSa, Network: REGISTER + MSa->>Network: Facility (Invoke = InterrogateSS (COLR)) + Note right of Network: RELEASE COMPLETE + Network-->>MSa: Facility (Return Result = InterrogateSS (SS-Status)) + Note right of Network: RELEASE COMPLETE + Network-->>MSa: Facility (Return Error (Error)) + Note right of Network: RELEASE COMPLETE + Network-->>MSa: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing MSa and Network interaction for REGISTER. The diagram shows four message exchanges: 1. MSa to Network: Facility (Invoke = InterrogateSS (COLR)) followed by RELEASE COMPLETE. 2. Network to MSa: Facility (Return Result = InterrogateSS (SS-Status)) followed by RELEASE COMPLETE. 3. Network to MSa: Facility (Return Error (Error)) followed by RELEASE COMPLETE. 4. Network to MSa: Facility (Reject (Invoke\_problem)). + +**Figure 4.1: Interrogation of connected line identification restriction** + +## 4.3 Activation, deactivation, registration and erasure + +Activation, deactivation, registration and erasure of the supplementary service connected line identification restriction are not applicable. + +# --- Annex A (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|----------|-----------|-----|---------|-------------|--------------------------------| +| Apr 1999 | GSM 04.81 | | | | Transferred to 3GPP CN1 | +| CN#03 | 24.081 | | | 3.0.0 | Approved at CN#03 | +| CN#08 | 24.081 | 001 | R99 | 3.1.0 | Cause of no CLI indication | +| CN#11 | 24.081 | | Rel-4 | 4.0.0 | Release 4 after CN#11 | +| CN#15 | 24.081 | | Rel-4 | 4.0.1 | References updated | +| CN#16 | 24.081 | | Rel-5 | 5.0.0 | Release 5 after CN#16 | +| CN#26 | 24.081 | | Rel-6 | 6.0.0 | Release 6 after CN#26 | +| CT#36 | 24.081 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 24.081 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 24.081 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 24.081 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2012-09 | 24.081 | - | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 24.081 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 24.081 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 24.081 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 24.081 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 24.081 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24086/0b87abe67b21a93777287649c33e755d_img.jpg b/marked/Rel-16/24_series/24086/0b87abe67b21a93777287649c33e755d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b8becc65e7d6fb1a4c3ed105de863229a26a46bb --- /dev/null +++ b/marked/Rel-16/24_series/24086/0b87abe67b21a93777287649c33e755d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:566de19de702e1d5dfec674b98308f380f661ec8d384626006af15197b001799 +size 28991 diff --git a/marked/Rel-16/24_series/24086/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg b/marked/Rel-16/24_series/24086/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5fd754bc6d33afd91a77aa1c956c02e35783056a --- /dev/null +++ b/marked/Rel-16/24_series/24086/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:427581d9cdb77ff5de818af596317eba6072157fce2194da02357ae7826288bc +size 19022 diff --git a/marked/Rel-16/24_series/24086/1c953f32bd34345dfd68fddf8a3736d6_img.jpg b/marked/Rel-16/24_series/24086/1c953f32bd34345dfd68fddf8a3736d6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d45e5078b3b860c51912b1bf7426bb3b6fc9fa34 --- /dev/null +++ b/marked/Rel-16/24_series/24086/1c953f32bd34345dfd68fddf8a3736d6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a7d83e51cafc7b77d641115b4066daa34a2f3b53f607037703a5812886e12e43 +size 36471 diff --git a/marked/Rel-16/24_series/24086/6f119d066b5e51370df585ce69c94fb4_img.jpg b/marked/Rel-16/24_series/24086/6f119d066b5e51370df585ce69c94fb4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..273e8c4f713303b4d6ac2a0df3fd014f07ab468b --- /dev/null +++ b/marked/Rel-16/24_series/24086/6f119d066b5e51370df585ce69c94fb4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff621663a6cb4ee3502288fee4f441774f94421fc3215a25e63cf60c3fa18ad7 +size 37024 diff --git a/marked/Rel-16/24_series/24086/9283a3f6b39120df9dc9aee4712b3a0a_img.jpg b/marked/Rel-16/24_series/24086/9283a3f6b39120df9dc9aee4712b3a0a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..118146ed38e9f9afd39334ba229ab15652ef0102 --- /dev/null +++ b/marked/Rel-16/24_series/24086/9283a3f6b39120df9dc9aee4712b3a0a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:78b17dfad547ac5b20b2e02ea36535984a9e00203748eb92ba2a2a38131f6835 +size 16200 diff --git a/marked/Rel-16/24_series/24086/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/24_series/24086/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..feda7740210e13a910a5ff87c1c1f5da3a2f1e70 --- /dev/null +++ b/marked/Rel-16/24_series/24086/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a835e0d921ba426322e5523054a59606dbc5fef24c57beea02d74172abce062c +size 41007 diff --git a/marked/Rel-16/24_series/24086/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/24_series/24086/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1526fdc7db29e5ec98ca3c07a5d7f2c67457ba74 --- /dev/null +++ b/marked/Rel-16/24_series/24086/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7359cb6a796a513efd8ca74e45ef81e7e922f72e5d8722bb4654c6e994281190 +size 41593 diff --git a/marked/Rel-16/24_series/24086/c9d8a18a6137ad054b841d7a614afb48_img.jpg b/marked/Rel-16/24_series/24086/c9d8a18a6137ad054b841d7a614afb48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4004f781b739a9753bfcc93f3615cb8a3e0c51b3 --- /dev/null +++ b/marked/Rel-16/24_series/24086/c9d8a18a6137ad054b841d7a614afb48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:817570efd2eca622239e2c4027dc24699632c45ba80bfbf8071146cf71937cec +size 27659 diff --git a/marked/Rel-16/24_series/24086/raw.md b/marked/Rel-16/24_series/24086/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8167cd9adc3f9f4dc4f862879915fdd602c7cd83 --- /dev/null +++ b/marked/Rel-16/24_series/24086/raw.md @@ -0,0 +1,372 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 0 Scope..... | 5 | +| 0.1 References ..... | 5 | +| 0.2 Abbreviations ..... | 6 | +| 1 Advice of Charge (Information) (AoCI)..... | 6 | +| 1.1 Normal operation with successful outcome ..... | 6 | +| 1.1.1 Call re-establishment..... | 6 | +| 1.1.2 MS originated call ..... | 7 | +| 1.1.3 MS terminated call ..... | 7 | +| 1.1.4 Change of charging information..... | 7 | +| 1.2 Normal operation with unsuccessful outcome ..... | 8 | +| 1.3 Activation, deactivation and invocation..... | 8 | +| 1.4 Interrogation, registration and erasure ..... | 8 | +| 2 Advice of Charge (Charging) (AoCC)..... | 8 | +| 2.1 Normal operation with successful outcome ..... | 8 | +| 2.1.1 Call re-establishment..... | 8 | +| 2.1.2 MS originated call ..... | 8 | +| 2.1.3 MS terminated call ..... | 9 | +| 2.1.4 Change of charging information..... | 9 | +| 2.2 Normal operation with unsuccessful outcome ..... | 10 | +| 2.3 Accumulated Call Meter is equal to or greater than ACMmax..... | 10 | +| 2.4 Activation, deactivation and invocation..... | 10 | +| 2.5 Interrogation, registration and erasure ..... | 10 | +| Annex A (informative): Change history..... | 11 | + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS specifies the procedures used at the radio interface for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of charging supplementary services within the 3GPP system. + +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: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# 0 Scope + +The present document specifies the procedures used at the radio interface (reference point Um as defined in 3GPP TS 24.002) for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of charging supplementary services. The provision and withdrawal of supplementary services is an administrative matter between the mobile subscriber and the service provider and causes no signalling on the radio interface. + +In 3GPP TS 24.010 the general aspects of the specification of supplementary services at the layer 3 radio interface are given. + +3GPP TS 24.080 specifies the formats and coding for the supplementary services. + +Definitions and descriptions of supplementary services are given in 3GPP TS 22.004 and 3GPP TS 22.08x and 3GPP TS 22.09x-series. 3GPP TS 22.024 and 02.86 are related to the charging supplementary services. + +Technical realization of supplementary services is described in 3GPP TS 23.011 and 3GPP TS 23.08x and 3GPP TS 23.09x-series. 3GPP TS 23.086 is related to the charging supplementary services. + +The procedures for Call Control, Mobility Management and Radio Resource management at the layer 3 radio interface are defined in 3GPP TS 24.007 and 3GPP TS 24.008. + +The following supplementary services belong to the charging supplementary services and are described in the present document: + +- Advice of Charge (Information) (AoCI) (clause 1); +- Advice of Charge (Charging) (AoCC) (clause 2). + +## 0.1 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.004: "General on supplementary services". +- [3] 3GPP TS 22.024: "Description of Charge Advice Information (CAI)". +- [4] 3GPP TS 22.081: "Line identification supplementary services - Stage 1". +- [5] 3GPP TS 22.082: "Call Forwarding (CF) supplementary services - Stage 1". +- [6] 3GPP TS 22.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 1". +- [7] 3GPP TS 22.084: "MultiParty (MPTY) supplementary services - Stage 1". +- [8] 3GPP TS 22.085: "Closed User Group (CUG) supplementary services - Stage 1". +- [9] 3GPP TS 22.086: "Advice of Charge (AoC) supplementary services - Stage 1". +- [10] 3GPP TS 22.088: "Call Barring (CB) supplementary services - Stage 1". +- [11] 3GPP TS 22.090: "Unstructured Supplementary Services Data (USSD) - Stage 1". +- [12] 3GPP TS 23.002: "Network architecture". + +- [13] 3GPP TS 23.011: "Technical realization of supplementary services". +- [14] 3GPP TS 23.081: "Line identification supplementary services - Stage 2". +- [15] 3GPP TS 23.082: "Call Forwarding (CF) supplementary services - Stage 2". +- [16] 3GPP TS 23.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 2". +- [17] 3GPP TS 23.084: "MultiParty (MPTY) supplementary services - Stage 2". +- [18] 3GPP TS 23.085: "Closed User Group (CUG) supplementary services - Stage 2". +- [19] 3GPP TS 23.086: "Advice of Charge (AoC) supplementary services - Stage 2". +- [20] 3GPP TS 23.088: "Call Barring (CB) supplementary services - Stage 2". +- [21] 3GPP TS 23.090: "Unstructured supplementary services operation - Stage 2". +- [22] 3GPP TS 24.002: "GSM-UMTS Public Land Mobile Network (PLMN) Access Reference Configuration". +- [23] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [24] 3GPP TS 24.008: "Mobile radio interface layer 3 specification". +- [25] 3GPP TS 24.010: "Mobile radio interface layer 3; Supplementary services specification; General aspects". +- [26] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". + +## 0.2 Abbreviations + +Abbreviations used in the present document are listed in 3GPP TR 21.905. + +# --- 1 Advice of Charge (Information) (AoCI) + +## 1.1 Normal operation with successful outcome + +On every successful request for an applicable telecommunications service, the served Mobile Station (MS) will be provided with charging information. + +The network sends the Charge Advice Information (CAI) to the MS according to 3GPP TS 22.024, 3GPP TS 22.086 and 3GPP TS 23.086. With this information the MS is able to calculate the units associated with the requested service in real time. In the case where the served mobile is to be charged for multi party calls, separate processes within the MS are used to calculate units appropriate to each call. For unit calculation, each call is treated in the same way as a normal "two-party" call. Any change in the charging rate during a call may be indicated to the MS. + +### 1.1.1 Call re-establishment + +When the MS detects a radio link failure, the Chargeable Duration (CDUR) shall be suspended. + +If a call re-establishment procedure is attempted, the MS shall resume the CDUR when: + +- an MM connection has been successfully completed; and +- a TCH has been successfully seized in the appropriate mode. + +### 1.1.2 MS originated call + +For an MS originated call, charging information is transferred to the MS as shown in figure 1.1. The charging information is acknowledged in a FACILITY message only if the MS supports the AoCI functionality specified in 3GPP TS 22.024 and 3GPP TS 22.086. AoCI refers to the Advice of Charge (Information) service. + +![Sequence diagram for Figure 1.1: Notification to the served mobile subscriber of the charging information in case of an originated call set up. The diagram shows the interaction between the MS and the Network. The MS sends a SETUP message to the Network. The Network responds with 'etc.'. The Network then sends a CONNECT/FACILITY message to the MS. The MS responds with a Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) message. The Network then sends a FACILITY/DISCONNECT message to the MS. The MS responds with a Facility (Return result) message.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: etc. + MS->>Network: SETUP + Network-->>MS: CONNECT/FACILITY + Note left of MS: Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) + MS->>Network: FACILITY/DISCONNECT + Note right of Network: Facility (Return result) + +``` + +Sequence diagram for Figure 1.1: Notification to the served mobile subscriber of the charging information in case of an originated call set up. The diagram shows the interaction between the MS and the Network. The MS sends a SETUP message to the Network. The Network responds with 'etc.'. The Network then sends a CONNECT/FACILITY message to the MS. The MS responds with a Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) message. The Network then sends a FACILITY/DISCONNECT message to the MS. The MS responds with a Facility (Return result) message. + +**Figure 1.1: Notification to the served mobile subscriber of the charging information in case of an originated call set up** + +### 1.1.3 MS terminated call + +For an MS terminated call, where required, charging information is transferred to the MS as shown in figure 1.2. The charging information is acknowledged only if the MS supports the AoCI functionality specified in 3GPP TS 22.024 and 3GPP TS 22.086. + +![Sequence diagram for Figure 1.2: Notification to the served mobile subscriber of the charging information in case of a terminated call set-up. The diagram shows the interaction between the MS and the Network. The MS sends a CONNECT message to the Network. The Network responds with a FACILITY message. The MS then sends a Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) message to the Network. The Network then sends a FACILITY/DISCONNECT message to the MS. The MS responds with a Facility (Return result) message.](1c953f32bd34345dfd68fddf8a3736d6_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + MS->>Network: CONNECT + Network-->>MS: FACILITY + Note left of MS: Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) + MS->>Network: FACILITY/DISCONNECT + Note right of Network: Facility (Return result) + +``` + +Sequence diagram for Figure 1.2: Notification to the served mobile subscriber of the charging information in case of a terminated call set-up. The diagram shows the interaction between the MS and the Network. The MS sends a CONNECT message to the Network. The Network responds with a FACILITY message. The MS then sends a Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) message to the Network. The Network then sends a FACILITY/DISCONNECT message to the MS. The MS responds with a Facility (Return result) message. + +**Figure 1.2: Notification to the served mobile subscriber of the charging information in case of a terminated call set-up** + +### 1.1.4 Change of charging information + +To inform the MS of a change in charging information the procedure of figure 1.3 is performed. The charging information is acknowledged only if the MS supports the AoCI functionality specified in 3GPP TS 22.024 and 3GPP TS 22.086. + +![Sequence diagram for Figure 1.3: Notification to the served mobile subscriber of a change in the charging information. The diagram shows the interaction between the MS and the Network. The MS sends a FACILITY message to the Network. The Network responds with a Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) message. The MS then sends a FACILITY/DISCONNECT message to the Network. The Network responds with a Facility (Return result) message.](c9d8a18a6137ad054b841d7a614afb48_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + MS->>Network: FACILITY + Note right of Network: Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) + MS->>Network: FACILITY/DISCONNECT + Note right of Network: Facility (Return result) + +``` + +Sequence diagram for Figure 1.3: Notification to the served mobile subscriber of a change in the charging information. The diagram shows the interaction between the MS and the Network. The MS sends a FACILITY message to the Network. The Network responds with a Facility (Invoke = ForwardChargeAdvice (AoCI, ChargingInformation)) message. The MS then sends a FACILITY/DISCONNECT message to the Network. The Network responds with a Facility (Return result) message. + +**Figure 1.3: Notification to the served mobile subscriber of a change in the charging information** + +## 1.2 Normal operation with unsuccessful outcome + +No signalling is performed by the network if a MS fails to acknowledge receipt of charging Information. + +## 1.3 Activation, deactivation and invocation + +Activation, deactivation and invocation of the Advice of Charge (Information) supplementary service are not applicable. + +## 1.4 Interrogation, registration and erasure + +Interrogation, registration and erasure of the Advice of Charge (Information) supplementary service are not applicable. + +# 2 Advice of Charge (Charging) (AoCC) + +## 2.1 Normal operation with successful outcome + +On every successful request for an applicable telecommunications service, the served MS will be provided with charging information. + +The network sends the Charge Advice Information (CAI) to the MS according to 3GPP TS 22.024, 3GPP TS 22.086 and 3GPP TS 23.086. With this information the MS is able to calculate the units associated with the requested service in real time. In the case where the served mobile is to be charged for multi party calls, separate processes within the MS are used to calculate units appropriate to each call. For unit calculation, each call is treated in the same way as a normal "two-party" call. Any change in the charging rate during a call may be indicated to the MS. + +### 2.1.1 Call re-establishment + +When the MS detects a radio link failure, the Chargeable Duration (CDUR) shall be suspended. + +If a call re-establishment procedure is attempted, the MS shall resume the CDUR when: + +- an MM connection has been successfully completed; and +- a TCH has been successfully seized in the appropriate mode. + +### 2.1.2 MS originated call + +For an MS originated call, charging information is transferred to the MS as shown in figure 2.1. The charging information is acknowledged in a FACILITY message only if the MS supports the AoCC functionality specified in 3GPP TS 22.024 and 3GPP TS 22.086. AoCC refers to the Advice of Charge (Charging) service. + +![Sequence diagram showing the notification to the served mobile subscriber of the charging information in case of an originated call set up. The diagram shows three messages between the MS and the Network: SETUP (MS to Network), CONNECT/FACILITY (Network to MS), and FACILITY/DISCONNECT (MS to Network). The CONNECT/FACILITY message contains the Facility (Invoke = ForwardChargeAdvice (AoCC, ChargingInformation)).](6f119d066b5e51370df585ce69c94fb4_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: etc. + MS->>Network: SETUP + Note left of Network: CONNECT/FACILITY + Network-->>MS: Facility (Invoke = ForwardChargeAdvice (AoCC, ChargingInformation)) + Note right of Network: FACILITY/DISCONNECT + MS-->>Network: Facility (Return result) + +``` + +Sequence diagram showing the notification to the served mobile subscriber of the charging information in case of an originated call set up. The diagram shows three messages between the MS and the Network: SETUP (MS to Network), CONNECT/FACILITY (Network to MS), and FACILITY/DISCONNECT (MS to Network). The CONNECT/FACILITY message contains the Facility (Invoke = ForwardChargeAdvice (AoCC, ChargingInformation)). + +**Figure 2.1: Notification to the served mobile subscriber of the charging information in case of an originated call set up** + +### 2.1.3 MS terminated call + +For an MS terminated call, where required, charging information is transferred to the MS as shown in figure 2.2. The charging information is acknowledged only if the MS supports the AoCC functionality specified in 3GPP TS 22.024 and 3GPP TS 22.086. + +![Sequence diagram showing notification to the served mobile subscriber of the charging information in case of a terminated call set up. The diagram shows messages between MS and Network: CONNECT (MS to Network), FACILITY (Network to MS), and FACILITY/DISCONNECT (MS to Network) with a return result.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: CONNECT + MS->>Network: + Note over MS, Network: FACILITY + Network->>MS: + Note over MS, Network: Facility (Invoke = ForwardChargeAdvice (AoCC, ChargingInformation)) + Note over MS, Network: FACILITY/DISCONNECT + MS->>Network: + Note over MS, Network: Facility (Return result) + +``` + +Sequence diagram showing notification to the served mobile subscriber of the charging information in case of a terminated call set up. The diagram shows messages between MS and Network: CONNECT (MS to Network), FACILITY (Network to MS), and FACILITY/DISCONNECT (MS to Network) with a return result. + +**Figure 2.2: Notification to the served mobile subscriber of the charging information in case of a terminated call set up** + +### 2.1.4 Change of charging information + +To inform the MS of a change in charging information the procedure of figure 2.3 is performed. The charging information is acknowledged only if the MS supports the AoCC functionality specified in 3GPP TS 22.024 and 3GPP TS 22.086. + +![Sequence diagram showing notification to the served mobile subscriber of a change in the charging information. The diagram shows FACILITY (Network to MS) and FACILITY/DISCONNECT (MS to Network) messages.](0b87abe67b21a93777287649c33e755d_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: FACILITY + Network->>MS: + Note over MS, Network: Facility (Invoke = ForwardChargeAdvice (AoCC, ChargingInformation)) + Note over MS, Network: FACILITY/DISCONNECT + MS->>Network: + Note over MS, Network: Facility (Return result) + +``` + +Sequence diagram showing notification to the served mobile subscriber of a change in the charging information. The diagram shows FACILITY (Network to MS) and FACILITY/DISCONNECT (MS to Network) messages. + +**Figure 2.3: Notification to the served mobile subscriber of a change in the charging information** + +## 2.2 Normal operation with unsuccessful outcome + +If timer T(AoC) (see 3GPP TS 23.086) expires before the Charge Advice Information is acknowledged, the network shall release the call. The MS and network shall act in accordance with 3GPP TS 24.008 network initiated call clearing procedures (see figure 2.4). + +![Sequence diagram showing network release due to unsuccessful operation. Network sends DISCONNECT/RELEASE/RELEASE COMPLETE to MS with Cause #69.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: DISCONNECT/RELEASE/RELEASE COMPLETE + Network->>MS: + Note over MS, Network: ....Cause #69 (Requested facility not implemented).... + +``` + +Sequence diagram showing network release due to unsuccessful operation. Network sends DISCONNECT/RELEASE/RELEASE COMPLETE to MS with Cause #69. + +**Figure 2.4: Network release due to unsuccessful operation of Advice of Charge (Charging) service** + +## 2.3 Accumulated Call Meter is equal to or greater than ACMmax + +If the change stored in the Accumulated Call Meter (ACM) is equal to or greater than the maximum value specified by ACMmax, then the MS shall initiate call clearing giving a specific cause value for this situation as indicated in figure 2.5. + +![Sequence diagram showing MS releasing the call due to ACM limit. MS sends DISCONNECT to Network with Cause #68.](9283a3f6b39120df9dc9aee4712b3a0a_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: DISCONNECT + MS->>Network: + Note over MS, Network: ....Cause #68 (ACM equal to or greater than ACMmax).... + +``` + +Sequence diagram showing MS releasing the call due to ACM limit. MS sends DISCONNECT to Network with Cause #68. + +**Figure 2.5: Mobile station releases the call due to ACM being equal to or greater than ACMmax** + +## 2.4 Activation, deactivation and invocation + +Activation, deactivation and invocation of the Advice of Charge (Charging) supplementary service are not applicable. + +## 2.5 Interrogation, registration and erasure + +Interrogation, registration and erasure of the Advice of Charge (Charging) supplementary service are not applicable. + +# --- Annex A (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|----------|-----------|----|---------|-------------|--------------------------------| +| Apr 1999 | GSM 04.86 | | | | Transferred to 3GPP CN1 | +| CN#03 | 24.086 | | R99 | 3.0.0 | Approved at CN#03 | +| CN#11 | 24.086 | | Rel-4 | 4.0.0 | Release 4 after CN#11 | +| CN#16 | 24.086 | | Rel-4 | 4.0.1 | References updated | +| CN#16 | 24.086 | | Rel-5 | 5.0.0 | Release 5 created after CN#16 | +| CN#26 | 24.086 | | Rel-6 | 6.0.0 | Release 6 created after CN#26 | +| CT#36 | 24.086 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 24.086 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 24.086 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 24.086 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2012-09 | 24.086 | - | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 24.086 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 24.086 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 24.086 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 24.086 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 24.086 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24087/0236eff05bcb8f3a343ea7933aaa306b_img.jpg b/marked/Rel-16/24_series/24087/0236eff05bcb8f3a343ea7933aaa306b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9e9f87ff4384268d3fca39cf42378dece1886e0b --- /dev/null +++ b/marked/Rel-16/24_series/24087/0236eff05bcb8f3a343ea7933aaa306b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1afbbf037a75524e89e9c389892f6a4fc65290cc66a8ed72b9009667ce710728 +size 54222 diff --git a/marked/Rel-16/24_series/24087/2119293733c74fc64de88aefd597f4bb_img.jpg b/marked/Rel-16/24_series/24087/2119293733c74fc64de88aefd597f4bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..172dde179f2ced76f7f503c60e448796367ea765 --- /dev/null +++ b/marked/Rel-16/24_series/24087/2119293733c74fc64de88aefd597f4bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e80b72f88095cdce337b2857a1fb587061aa9907e17563489b0cd7c84d0a4a2f +size 38025 diff --git a/marked/Rel-16/24_series/24087/367926125450c2bc3f4bdca9d59a62ba_img.jpg b/marked/Rel-16/24_series/24087/367926125450c2bc3f4bdca9d59a62ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00ba739e75d05cc8e417d53023f4353bce34adc6 --- /dev/null +++ b/marked/Rel-16/24_series/24087/367926125450c2bc3f4bdca9d59a62ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28093d780759ea8c3c6660b558e6e77fea369a21a38b7344daee1a2bca00a7cc +size 77653 diff --git a/marked/Rel-16/24_series/24087/3da1a07cb87051bf616c9876db958cf0_img.jpg b/marked/Rel-16/24_series/24087/3da1a07cb87051bf616c9876db958cf0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1aaa07ef0c2cdb6701028ab61345c867451405c6 --- /dev/null +++ b/marked/Rel-16/24_series/24087/3da1a07cb87051bf616c9876db958cf0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b1b792116cfce5c06b3962f3590f0de8ee984865591b6685ca6f9cd208fa029 +size 74087 diff --git a/marked/Rel-16/24_series/24087/4356776ca004ecba5d599667a155d7d4_img.jpg b/marked/Rel-16/24_series/24087/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..436740281a4cc5d7ac5a70e87e4d6cdb0c384e31 --- /dev/null +++ b/marked/Rel-16/24_series/24087/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a0a4ee31b87c6b00122ec4a562379070be9b03a3cf56191cb498c33dff40f67 +size 61521 diff --git a/marked/Rel-16/24_series/24087/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg b/marked/Rel-16/24_series/24087/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..890c1874bff7c494b31cab128abeb66d58d608a6 --- /dev/null +++ b/marked/Rel-16/24_series/24087/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:554acd0d9d6ed90f4c9a3979ede4dc203c309bc90034c73d7da4593cf2b89cba +size 71187 diff --git a/marked/Rel-16/24_series/24087/704082cc3e11776bda29595c76411362_img.jpg b/marked/Rel-16/24_series/24087/704082cc3e11776bda29595c76411362_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d55dc4cf05f31487e19d78741a4ebdc6d7dbbe61 --- /dev/null +++ b/marked/Rel-16/24_series/24087/704082cc3e11776bda29595c76411362_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa9aa7a7e944a057c28955ef7d24987b8b2d6b8e76aa401f4032e45feb6dda59 +size 41628 diff --git a/marked/Rel-16/24_series/24087/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg b/marked/Rel-16/24_series/24087/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dacdab659fea24e79edd304ef01e498ed20c0ccd --- /dev/null +++ b/marked/Rel-16/24_series/24087/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:910b7c93672d6f544bf34e4b4dd3fb094bd5e2171ca77b41adf66a9b52918f28 +size 62403 diff --git a/marked/Rel-16/24_series/24087/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg b/marked/Rel-16/24_series/24087/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c527e40e7b2d20a11b67e2e6960d7e73c4887c31 --- /dev/null +++ b/marked/Rel-16/24_series/24087/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:446d498ab78d5be7caebc05f5d634a3795e6a32485cce574a12f00bc4c0f8e2d +size 47141 diff --git a/marked/Rel-16/24_series/24087/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-16/24_series/24087/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d21ae070f964f2a291910d7a8045feb88f16da8 --- /dev/null +++ b/marked/Rel-16/24_series/24087/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:267df1655be40a05c62c2e38e67460b0c5208f289b137e93f2de9a18c344fe01 +size 70504 diff --git a/marked/Rel-16/24_series/24087/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/24_series/24087/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f80e7d5e08f501caec426c95a4b75312b82ab70 --- /dev/null +++ b/marked/Rel-16/24_series/24087/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a67847ee3f0cd9e482685f4f69e408dbc54baa1336ab835221687b5cc26206c +size 64989 diff --git a/marked/Rel-16/24_series/24087/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/24_series/24087/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f5b1188cc4688bd6769f96311068329e6691d14 --- /dev/null +++ b/marked/Rel-16/24_series/24087/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7d4691634f2961b29603c58e9ca97537bea803c6517e33ad35a577ee4945f28e +size 86473 diff --git a/marked/Rel-16/24_series/24087/86b4670fc1a5a694821ee92b99c1209a_img.jpg b/marked/Rel-16/24_series/24087/86b4670fc1a5a694821ee92b99c1209a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0aa276312c9d357a841ad3c7f922f4e67423b18 --- /dev/null +++ b/marked/Rel-16/24_series/24087/86b4670fc1a5a694821ee92b99c1209a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5c3a0f506748d7a21d5e0f100263e1635d9bbb68da893197778a1bb86cf7231 +size 44473 diff --git a/marked/Rel-16/24_series/24087/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/24_series/24087/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..18336c5fd9f792c676de7a9d3f5ffe71241003db --- /dev/null +++ b/marked/Rel-16/24_series/24087/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f66ceeccd4a9b9a19e0f2330397a5643627e67d477633e996a7bfde38488298a +size 46274 diff --git a/marked/Rel-16/24_series/24087/a734898ce18e972938949637c32a34f4_img.jpg b/marked/Rel-16/24_series/24087/a734898ce18e972938949637c32a34f4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..73bafb39ac38f742b8181b808c68a442ef2e2fd5 --- /dev/null +++ b/marked/Rel-16/24_series/24087/a734898ce18e972938949637c32a34f4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a41071b054a1a7d3e7962acc25b70c2735404604b678ba0e045d591b72b6dfd5 +size 81867 diff --git a/marked/Rel-16/24_series/24087/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/marked/Rel-16/24_series/24087/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8984209796623b1b58f6db8bacbcfd061452a430 --- /dev/null +++ b/marked/Rel-16/24_series/24087/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64d9446937515a152c3b492fa4c1e05e8c2580ac4453585164faa5f669d4423f +size 39441 diff --git a/marked/Rel-16/24_series/24087/bffdddb47fced140f8d17fdc2a29f592_img.jpg b/marked/Rel-16/24_series/24087/bffdddb47fced140f8d17fdc2a29f592_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59ad2e70dbd0714c1cdf97a7a4fdea79d6bd91b1 --- /dev/null +++ b/marked/Rel-16/24_series/24087/bffdddb47fced140f8d17fdc2a29f592_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:442cf4fc7bb5e912b8a0aea2a900b7156004571bb61c9a302437d1c0d3755165 +size 48393 diff --git a/marked/Rel-16/24_series/24087/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-16/24_series/24087/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..576045965cdc1527fc58837805f2cedbb3574431 --- /dev/null +++ b/marked/Rel-16/24_series/24087/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24b3556e2f2c2242fb0845b1282d0a17ab9b7221a708c242c38daede934156a3 +size 79440 diff --git a/marked/Rel-16/24_series/24087/raw.md b/marked/Rel-16/24_series/24087/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c50031cda83c9e675ae0d0304cdf2533dd1d9886 --- /dev/null +++ b/marked/Rel-16/24_series/24087/raw.md @@ -0,0 +1,846 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 User-to-User Signalling (UUS); served mobile subscriber side ..... | 6 | +| 4.1 UUS1..... | 6 | +| 4.1.1 Operation when implicitly activated..... | 7 | +| 4.1.2 Operation when explicitly activated..... | 7 | +| 4.1.2.1 UUS required ..... | 8 | +| 4.1.2.2 UUS not required ..... | 9 | +| 4.2 UUS2..... | 9 | +| 4.2.1 Operation ..... | 10 | +| 4.2.1.1 UUS required ..... | 11 | +| 4.2.1.2 UUS not required ..... | 12 | +| 4.3 UUS3..... | 12 | +| 4.3.1 Activation when originating a call ..... | 13 | +| 4.3.1.1 UUS required ..... | 14 | +| 4.3.1.2 UUS not required ..... | 14 | +| 4.3.2 Activation during an active call..... | 15 | +| 4.3.3 Invocation and operation ..... | 16 | +| 4.3.4 Flow Control..... | 16 | +| 4.4 Combination of UUS Services ..... | 17 | +| 5 User-to-User Signalling (UUS); remote mobile subscriber side ..... | 18 | +| 5.1 UUS1..... | 19 | +| 5.1.1 Operation when explicitly activated, UUS required..... | 19 | +| 5.1.2 Operation when explicitly activated, UUS not required..... | 20 | +| 5.2 UUS2..... | 21 | +| 5.2.1 Operation, UUS required..... | 21 | +| 5.2.2 Operation, UUS not required..... | 22 | +| 5.3 UUS3..... | 23 | +| 5.3.1 Activation when originating a call ..... | 23 | +| 5.3.1.1 UUS required ..... | 23 | +| 5.3.1.2 UUS not required ..... | 23 | +| 5.3.2 Activation during an active call..... | 24 | +| 6 Identification of parallel transactions in UUS..... | 24 | +| Annex A (normative): Cause values used in UUS supplementary service ..... | 25 | +| Annex B (informative):      Change history..... | 26 | + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS gives the stage 3 description of the User-to-User signalling supplementary services within the 3GPP system. + +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: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# --- 1 Scope + +This Technical Specification gives the stage 3 description of the User-to-User signalling supplementary services. + +The User-to-user supplementary service is divided into 3 different services: + +- Service 1 (UUS1) +- Service 2 (UUS2) +- Service 3 (UUS3) + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.087: "Digital cellular telecommunications system (Phase 2+); User-to-User Signalling (UUS); Stage 2". +- [3] 3GPP TS 24.008: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 specification ". +- [4] 3GPP TS 24.080: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 supplementary services specification; Formats and coding". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following definitions apply: + +**Remote party:** For service 1 and 2 the remote party is the called party of a call to which the served subscriber activates the UUS supplementary service. For service 3 the remote party can be either the called or the calling party of an established call to whom the use of the UUS supplementary service is requested by the served subscriber. + +**Served subscriber:** The subscriber who has a provision of the UUS supplementary service and who activates the UUS supplementary service. For service 1 and 2 the served subscriber is always the calling subscriber, for service 3 either the calling or the called subscriber can be the served subscriber. + +**User-to-User Information (UUI):** The information transferred by using the UUS supplementary service. + +**UUS not required:** If the "UUS not required" indication is given by the subscriber, the call will be completed even if UUI cannot be passed to the called subscriber. + +**UUS required:** If the "UUS required" indication is given by the subscriber, the call shall not be completed if UUI cannot be passed to the called subscriber. + +**UUS Service:** The UUS services (Service 1, 2 and 3) are components of the UUS supplementary service. If the UUS supplementary service is provided to a subscriber, he can handle the UUS services independently within a call. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|---------------------------------------------------------------| +| MS A | Mobile Station A, the mobile station of the served subscriber | +| MS B | Mobile Station B, the mobile station of the remote subscriber | +| UUI | User-to-User Information | +| UUS | User-to-User Signalling | +| UUS1 | User-to-User Signalling Service 1 | +| UUS2 | User-to-User Signalling Service 2 | +| UUS3 | User-to-User Signalling Service 3 | + +Further GSM related abbreviations are listed in 3GPP TR 21.905. + +# --- 4 User-to-User Signalling (UUS); served mobile subscriber side + +## 4.1 UUS1 + +For UUS1, both parties may exchange UUI during the set-up and the clearing phases of a call by including User-user information element(s) in basic call control messages (ALERTING, CONNECT, DISCONNECT, PROGRESS, RELEASE, RELEASE COMPLETE, SETUP). + +UUS1 can be activated implicitly or explicitly. When UUS1 has been activated, either subscriber may include UUI when accepting, rejecting or terminating the call. + +UUS1 is automatically deactivated when the call is cleared. + +### 4.1.1 Operation when implicitly activated + +To activate UUS1 implicitly, the MS A shall include a User-user information element in the SETUP message as part of a normal call request. See 3GPP TS 24.008. Implicitly activated UUS1 is active for the duration of the call; i.e. the remote party is not required to send a response to the implicit activation request. However, the remote party may include a User-user information element in the call response. + +The served subscriber or the remote party may terminate the call before a connection is established. + +![Sequence diagram showing the operation of UUS1 when implicitly activated between MS A and NETWORK.](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note right of MS A: . + MS A->>NETWORK: SETUP + Note right of NETWORK: User-user + Note right of NETWORK: . + NETWORK-->>MS A: ALERTING + Note right of NETWORK: User-user (Note 1) + Note right of NETWORK: . + NETWORK-->>MS A: CONNECT + Note right of NETWORK: User-user (Note 1) + Note right of NETWORK: . + Note right of NETWORK: . + NETWORK-->>MS A: DISCONNECT / RELEASE / RELEASE COMPLETE + Note right of NETWORK: User-user (Note 1), (Note 2) + +``` + +The diagram illustrates the message exchange for UUS1 activation when implicitly activated. It starts with MS A sending a SETUP message to the NETWORK, which includes a 'User-user' information element. The NETWORK responds with an ALERTING message, also containing the 'User-user' element (Note 1). This is followed by a CONNECT message from the NETWORK to MS A, again with the 'User-user' element (Note 1). Finally, the NETWORK sends a DISCONNECT / RELEASE / RELEASE COMPLETE message to MS A, which includes the 'User-user' element (Note 1) and potentially another instance (Note 2). Vertical dots indicate the sequence of messages and the active state of the information element throughout the call. + +Sequence diagram showing the operation of UUS1 when implicitly activated between MS A and NETWORK. + +**Figure 1: UUS1 when implicitly activated** + +NOTE 1: The User-user information element is optional. + +NOTE 2: Under normal conditions DISCONNECT message is used for clearing the call, but also RELEASE or RELEASE COMPLETE message may be used as the first call clearing message. + +### 4.1.2 Operation when explicitly activated + +UUS1 is explicitly requested by the MS A when including a Facility information element with a UserUserService invoke component in the SETUP message. See 3GPP TS 24.008, 3GPP TS 24.080. The UserUserService invoke component shall indicate whether the service is "UUS required" or "UUS not required". + +If the remote party accepts the request, the network shall include a Facility information element with a UserUserService Return Result component in the ALERTING or the CONNECT message sent to the MS A. + +If the request is not accepted, the network shall include a Facility information element with a UserUserService Return Error component in the DISCONNECT message (when UUS required) or in the ALERTING or in the CONNECT message (when UUS not required) sent to the MS A. See errors in 3GPP TS 24.080. + +An explicit activation request may include UUI. The network may include User-user information element when accepting the activation request. + +The served subscriber or the remote party may terminate the call before a connection is established. + +For UUS1 explicit activation SS Version Indicator value 3 or above has to be used. + +#### 4.1.2.1 UUS required + +If the MS A gives the "UUS required" indication, the call shall not be completed if UUI cannot be passed to the remote party. + +![Sequence diagram showing the request for explicit activation of UUS1, UUS required. The diagram shows message exchanges between MS A and NETWORK. 1. MS A sends SETUP to NETWORK with Facility (Invoke=UserUserService (UUS1, UUS required)) and User-user (Note 1). 2. NETWORK sends ALERTING to MS A with Facility (Return Result) and User-user (Note 1), (Note 2). 3. NETWORK sends DISCONNECT / RELEASE COMPLETE to MS A with Facility (Return Error (Error), Cause (Note 3)). 4. NETWORK sends CONNECT to MS A with User-user (Note 1), (Note 2), (Note 4). 5. MS A sends DISCONNECT / RELEASE / RELEASE COMPLETE to NETWORK with User-user (Note 1), (Note 5).](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note over MS A, NETWORK: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS1, UUS required)), User-user (Note 1) + Note over MS A, NETWORK: . + Note over MS A, NETWORK: . + Note over MS A, NETWORK: ALERTING + NETWORK-->>MS A: Facility (Return Result), User-user (Note 1), (Note 2) + Note over MS A, NETWORK: DISCONNECT / RELEASE COMPLETE + NETWORK-->>MS A: Facility (Return Error (Error), Cause (Note 3)) + Note over MS A, NETWORK: CONNECT + NETWORK-->>MS A: User-user (Note 1), (Note 2), (Note 4) + Note over MS A, NETWORK: . + Note over MS A, NETWORK: . + Note over MS A, NETWORK: DISCONNECT / RELEASE / RELEASE COMPLETE + MS A->>NETWORK: User-user (Note 1), (Note 5) + +``` + +Sequence diagram showing the request for explicit activation of UUS1, UUS required. The diagram shows message exchanges between MS A and NETWORK. 1. MS A sends SETUP to NETWORK with Facility (Invoke=UserUserService (UUS1, UUS required)) and User-user (Note 1). 2. NETWORK sends ALERTING to MS A with Facility (Return Result) and User-user (Note 1), (Note 2). 3. NETWORK sends DISCONNECT / RELEASE COMPLETE to MS A with Facility (Return Error (Error), Cause (Note 3)). 4. NETWORK sends CONNECT to MS A with User-user (Note 1), (Note 2), (Note 4). 5. MS A sends DISCONNECT / RELEASE / RELEASE COMPLETE to NETWORK with User-user (Note 1), (Note 5). + +**Figure 2: Request for explicit activation of UUS1, UUS required** + +NOTE 1: The User-user information element is optional. + +NOTE 2: The Return Result component in the Facility information element shall be sent either in the ALERTING or in the CONNECT message. + +NOTE 3: If the remote party rejects the service request or does not respond with an explicit service 1 acceptance or rejection, DISCONNECT message is sent to the MS A with Facility information element including Return Error component with error value "rejectedByUser". If the network rejects the request, the error value shall be "rejectedByNetwork". See information on Cause values in Annex A. + +NOTE 4: If the MS A does not receive an explicit service 1 acceptance or rejection in the ALERTING or the CONNECT message, the MS A shall clear the call. UUS1 is not activated. + +NOTE 5: Under normal conditions DISCONNECT message is used for clearing the call, but also RELEASE or RELEASE COMPLETE message may be used as the first call clearing message. + +#### 4.1.2.2 UUS not required + +If the MS A gives the "UUS not required" indication, the call will be completed even if UUI cannot be passed to the remote party. + +![Sequence diagram showing the interaction between MS A and NETWORK for UUS1 activation where UUS is not required.](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note right of NETWORK: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS1, UUS not required)), User-user (Note 1) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: ALERTING + NETWORK-->>MS A: Facility (Return Result), User-user (Note 1), (Note 2) + Note right of NETWORK: ALERTING / CONNECT + NETWORK-->>MS A: Facility (Return Error (Error) (Note 3)) + Note right of NETWORK: CONNECT + NETWORK-->>MS A: User-user (Note 1), (Note 2) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: DISCONNECT / RELEASE / RELEASE COMPLETE + NETWORK-->>MS A: User-user (Note 1), (Note 4) + +``` + +Sequence diagram showing the interaction between MS A and NETWORK for UUS1 activation where UUS is not required. + +**Figure 3: Request for explicit activation of UUS1, UUS not required** + +NOTE 1: The User-user information element is optional. + +NOTE 2: The Return Result component in the Facility information element shall be sent either in the ALERTING or in the CONNECT message. + +NOTE 3: If the MS A does not receive an explicit service 1 acceptance or rejection in the ALERTING or the CONNECT message, the served subscriber shall continue normal call handling. UUS1 is not activated. + +NOTE 4: Under normal conditions DISCONNECT message is used for clearing the call, but also RELEASE or RELEASE COMPLETE message may be used as the first call clearing message. + +## 4.2 UUS2 + +For UUS2, both parties may send UUI after the alerting indication has been sent/received and until the connect indication has been sent/received. The UUI is sent in USER INFORMATION message and is limited to two messages in each direction. + +UUS2 is automatically deactivated when the called subscriber is no longer being informed of the call, i.e. if the call is established or released. + +### 4.2.1 Operation + +In order to activate UUS2 the MS A shall include a Facility information element with a UserUserService invoke component indicating service 2 in the SETUP message. See 3GPP TS 24.008, 3GPP TS 24.080. The UserUserService invoke component shall also indicate whether the service is "UUS required" or "UUS not required". + +If the remote party accepts the request, the network shall include a Facility information element with a UserUserService Return Result component in the ALERTING message received by the MS A. + +If the request is not accepted, the network shall include a Facility information element with a UserUserService Return Error component in the DISCONNECT message (when UUS required) or in the ALERTING or in the CONNECT message (when UUS not required) sent to the MS A. See errors in 3GPP TS 24.080. + +At any time between the activation of UUS2 and the connection is being established, either subscriber may transfer up to two USER INFORMATION messages in each direction to the other subscriber involved in the call. + +User-user information element is mandatory in USER INFORMATION message (refer 3GPP TS 24.008). More data information element may be included in USER INFORMATION message indicating that another USER INFORMATION message pertaining to the same message block will follow. + +For UUS2 activation SS Version Indicator value 3 or above has to be used. + +#### 4.2.1.1 UUS required + +If the MS A gives the "UUS required" indication, the call shall not be completed if UUI cannot be passed to the remote party. + +![Sequence diagram showing the request for explicit activation of UUS2, UUS required. The diagram illustrates the interaction between MS A and the NETWORK. The sequence starts with a SETUP message from MS A to NETWORK. The NETWORK responds with an ALERTING message. MS A then sends a DISCONNECT / RELEASE COMPLETE / RELEASE message to the NETWORK. The NETWORK responds with a USER INFORMATION message. Finally, the NETWORK sends a CONNECT message to MS A. The diagram includes several notes: Note 1 (Facility (Return Result)), Note 2 (Facility (Return Error (Error), Cause)), and Note 3 (User-user, More data).](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note right of MS A: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS2, UUS required)) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: ALERTING + NETWORK-->>MS A: Facility (Return Result) (Note 1) + Note right of MS A: DISCONNECT / RELEASE COMPLETE / RELEASE + MS A-->>NETWORK: Facility (Return Error (Error), Cause (Note 2)) + Note right of NETWORK: USER INFORMATION + NETWORK-->>MS A: User-user, More data (Note 3) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: CONNECT + NETWORK-->>MS A: (Note 1) + +``` + +Sequence diagram showing the request for explicit activation of UUS2, UUS required. The diagram illustrates the interaction between MS A and the NETWORK. The sequence starts with a SETUP message from MS A to NETWORK. The NETWORK responds with an ALERTING message. MS A then sends a DISCONNECT / RELEASE COMPLETE / RELEASE message to the NETWORK. The NETWORK responds with a USER INFORMATION message. Finally, the NETWORK sends a CONNECT message to MS A. The diagram includes several notes: Note 1 (Facility (Return Result)), Note 2 (Facility (Return Error (Error), Cause)), and Note 3 (User-user, More data). + +**Figure 4: Request for explicit activation of UUS2, UUS required** + +NOTE 1: If the MS A does not receive an explicit service 2 acceptance or rejection in the ALERTING message or does not receive an ALERTING message before receiving the CONNECT message, the served subscriber shall clear the call. UUS2 is not activated. + +NOTE 2: If the remote party rejects the service request or does not respond with an explicit service 2 acceptance or rejection, DISCONNECT message is sent to the MS A with Facility information element including Return Error component with error value "rejectedByUser". If the network rejects the request, the error value shall be "rejectedByNetwork". See information on Cause values in Annex A. + +NOTE 3: User-user information element is mandatory and More data information element is optional in USER INFORMATION message. + +#### 4.2.1.2 UUS not required + +If the MS A gives the "UUS not required" indication, the call will be completed even if UUI cannot be passed to the remote party. + +![Sequence diagram showing the request for explicit activation of UUS2 with UUS not required. The diagram shows interactions between MS A and NETWORK. MS A sends a SETUP message with Facility (Invoke=UserUserService (UUS2, UUS not required)). NETWORK responds with ALERTING and Facility (Return Result) (Note 1). MS A then sends another ALERTING message and Facility (Return Error (Error)). NETWORK responds with USER INFORMATION and User-user, More data (Note 2). Finally, NETWORK sends CONNECT and (Note 1).](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note right of MS A: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS2, UUS not required)) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: ALERTING + NETWORK-->>MS A: Facility (Return Result) (Note 1) + Note right of MS A: ALERTING + MS A-->>NETWORK: Facility (Return Error (Error)) + Note right of NETWORK: USER INFORMATION + NETWORK-->>MS A: User-user, More data (Note 2) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: CONNECT + NETWORK-->>MS A: (Note 1) + +``` + +Sequence diagram showing the request for explicit activation of UUS2 with UUS not required. The diagram shows interactions between MS A and NETWORK. MS A sends a SETUP message with Facility (Invoke=UserUserService (UUS2, UUS not required)). NETWORK responds with ALERTING and Facility (Return Result) (Note 1). MS A then sends another ALERTING message and Facility (Return Error (Error)). NETWORK responds with USER INFORMATION and User-user, More data (Note 2). Finally, NETWORK sends CONNECT and (Note 1). + +**Figure 5: Request for explicit activation of UUS2, UUS not required** + +NOTE 1: If the MS A does not receive an explicit service 2 acceptance or rejection in the ALERTING message or does not receive an ALERTING message before receiving the CONNECT message, the served subscriber shall continue normal call handling. UUS2 is not activated. + +NOTE 2: User-user information element is mandatory and More data information element is optional in USER INFORMATION message. + +## 4.3 UUS3 + +For UUS3, both parties may send UUI in the active phase of a call using USER INFORMATION messages. + +UUS3 shall be activated explicitly, when a call is originated or after the connection has been established. + +After UUS3 has been activated, either subscriber may transfer UUI in USER INFORMATION messages to the other subscriber on the call. + +UUS3 is automatically deactivated when the call is released. + +For UUS3 activation SS Version Indicator value 3 or above has to be used. + +### 4.3.1 Activation when originating a call + +When UUS3 is activated during call establishment, the MS A shall include Facility information element with UserUserService operation in an Invoke component indicating UUS3 in the SETUP message. See 3GPP TS 24.008, + +3GPP TS 24.080. The UserUserService operation shall also indicate whether the service is "UUS required" or "UUS not required". + +If the remote party accepts the request, the network shall include a Facility information element with a UserUserService Return Result component in the CONNECT message sent to the MS A. + +If the request is not accepted, the network shall include a Facility information element with a UserUserService Return Error component in the DISCONNECT message (when UUS required) or in the CONNECT message (when UUS not required) sent to the MS A. See errors in 3GPP TS 24.080. + +#### 4.3.1.1 UUS required + +If the MS A gives the "UUS required" indication, the call shall not be completed if UUI cannot be passed to the remote party. + +![Sequence diagram for UUS required call flow between MS A and NETWORK.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note right of NETWORK: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS3, UUS required)) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: CONNECT + NETWORK-->>MS A: Facility (Return Result) (Note 1) + Note right of NETWORK: DISCONNECT / RELEASE COMPLETE / RELEASE + NETWORK-->>MS A: Facility (Return Error (Error), Cause (Note 2)) + +``` + +Sequence diagram for UUS required call flow between MS A and NETWORK. + +**Figure 6: Request for explicit activation of UUS3 when originating a call, UUS required** + +NOTE 1: If the MS A does not receive an explicit service 3 acceptance or rejection in the CONNECT message, the MS A shall clear the call. + +NOTE 2: If the remote party rejects the service request or does not respond with an explicit service 3 acceptance or rejection, DISCONNECT message is sent to the MS A with Facility information element including Return Error component with error value "rejectedByUser". If the network rejects the request, the error value shall be "rejectedByNetwork". See information on Cause values in Annex A. + +#### 4.3.1.2 UUS not required + +If the MS A gives the "UUS not required" indication, the call will be completed even if UUI cannot be passed to the remote party. + +![Sequence diagram for UUS not required call flow between MS A and NETWORK.](704082cc3e11776bda29595c76411362_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note right of NETWORK: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS3, UUS not required)) + Note right of NETWORK: . + Note right of NETWORK: . + Note right of NETWORK: CONNECT + NETWORK-->>MS A: Facility (Return Result) + Note right of NETWORK: CONNECT + NETWORK-->>MS A: Facility (Return Error (Error)) (Note 1) + +``` + +Sequence diagram for UUS not required call flow between MS A and NETWORK. + +**Figure 7: Request for explicit activation of UUS3 when originating a call, UUS not required** + +NOTE 1: If the MS A does not receive an explicit service 3 acceptance or rejection in the CONNECT message, the MS A shall continue normal call handling and assume that service 3 is not activated. + +### 4.3.2 Activation during an active call + +When UUS3 is activated during an active call, the MS A shall include a Facility information element with a UserUserService invoke component indicating service 3 in a FACILITY message. See 3GPP TS 24.008, 3GPP TS 24.080. The UserUserService operation shall indicate that the service is "UUS not required". + +If the remote party accepts the request, the network shall include a Facility information element with a UserUserService Return Result component in the FACILITY message sent to the MS A. + +If the request is not accepted, the network shall include a Facility information element with a UserUserService Return Error component in the FACILITY message sent to the MS A. See errors in 3GPP TS 24.080. + +![Sequence diagram showing the request for explicit activation of UUS3 during an active call between MS A and NETWORK. The diagram shows three possible FACILITY message exchanges: an initial request, a successful return result, or a return error.](bffdddb47fced140f8d17fdc2a29f592_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note over MS A, NETWORK: Active call + MS A->>NETWORK: FACILITY + Note right of MS A: Facility (Invoke=UserUserService (UUS3, UUS not required)) + NETWORK-->>MS A: FACILITY + Note left of NETWORK: Facility (Return Result) + NETWORK-->>MS A: FACILITY + Note left of NETWORK: Facility (Return Error (Error)) (Note 1) + +``` + +Sequence diagram showing the request for explicit activation of UUS3 during an active call between MS A and NETWORK. The diagram shows three possible FACILITY message exchanges: an initial request, a successful return result, or a return error. + +**Figure 8: Request for explicit activation of UUS3 during an active call** + +NOTE 1: If the remote party rejects the service request or does not respond with an explicit service 3 acceptance of rejection, the FACILITY message includes Facility information element with Return Error component indicating error "rejectedByUser". If the network rejects the request, the error value shall be "rejectedByNetwork". + +### 4.3.3 Invocation and operation + +After Service 3 has been activated, either subscriber may transfer UUI in USER INFORMATION messages to the other subscriber on the call after the connection has been established. User-user information element is mandatory in USER INFORMATION message. More data information element may be included in USER INFORMATION message indicating that another USER INFORMATION message pertaining to the same message block will follow. + +![Sequence diagram showing the exchange of USER INFORMATION messages between MS A and NETWORK during an active call.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +The diagram illustrates the message flow between MS A and NETWORK during an active call. It consists of three horizontal dashed lines representing message exchanges: + +- The first dashed line is labeled "Active call" and spans between MS A and NETWORK. +- The second dashed line is labeled "USER INFORMATION" and "User-user, More data (Note 1)". It also spans between MS A and NETWORK. +- The third dashed line is labeled "DISCONNECT / RELEASE / RELEASE COMPLETE" and "(Note 2)". It also spans between MS A and NETWORK. + +Between the second and third dashed lines, there are two vertical dots, indicating a continuation of the sequence. + +Sequence diagram showing the exchange of USER INFORMATION messages between MS A and NETWORK during an active call. + +**Figure 9: Sending USER INFORMATION messages when UUS3 has been activated** + +NOTE 1: User-user information element is mandatory and More data information element is optional in USER INFORMATION message. + +NOTE 2: Under normal conditions DISCONNECT message is used for clearing the call, but also RELEASE or RELEASE COMPLETE message may be used as the first call clearing message. + +### 4.3.4 Flow Control + +Network flow control mechanisms shall exist after the call has entered the Active call state to control USER INFORMATION message flow in each direction. + +If USER INFORMATION messages are received at a rate which exceeds the flow control limit set by the network, the network shall discard the USER INFORMATION messages that cannot be handled and respond to the first discarded USER INFORMATION message with a control indication. + +If USER INFORMATION message has been discarded due to flow control, a CONGESTION CONTROL message shall be sent to the MS. + +When the flow control restrictions are removed, and a USER INFORMATION message has been discarded due to that restriction, an indication that further USER INFORMATION messages can be accepted shall be given. + +![Sequence diagram showing flow control between MS A and NETWORK. It includes messages for Active call, USER INFORMATION (User-user, More data), and CONGESTION CONTROL (Congestion level = receiver not ready/ready).](8307f6b04df072c9332f9987e034272c_img.jpg) + +The diagram illustrates a sequence of messages between MS A and NETWORK: + +- Active call**: Initial message from MS A to NETWORK. +- USER INFORMATION**: Message from MS A to NETWORK containing "User-user, More data (Note 1)". +- USER INFORMATION**: Another message from MS A to NETWORK containing "User-user, More data (Note 1), (Note 2)". This message is discarded due to flow control. +- CONGESTION CONTROL**: Message from NETWORK to MS A indicating "Congestion level = receiver not ready, Cause #43 (access information discarded)". +- USER INFORMATION**: Message from MS A to NETWORK containing "User-user, More data (Note 1), (Note 2)". +- CONGESTION CONTROL**: Message from NETWORK to MS A indicating "Congestion level = receiver ready". + +Sequence diagram showing flow control between MS A and NETWORK. It includes messages for Active call, USER INFORMATION (User-user, More data), and CONGESTION CONTROL (Congestion level = receiver not ready/ready). + +**Figure 10: UUS3, Flow control** + +NOTE 1: User-user information element is mandatory and More data information element is optional in USER INFORMATION message. + +NOTE 2: Due to the flow control the USER INFORMATION message is discarded. + +A more detailed presentation of flow control mechanisms is given in UUS Stage 2. + +## 4.4 Combination of UUS Services + +Depending on the served subscriber's subscription to the UUS supplementary service and the provision of the UUS services by the service provider, UUS1 implicit or explicit, UUS2 and UUS3 can be activated individually or in combination. + +The following figure is an example of the situation, when UUS1, UUS2 and UUS3 are simultaneously activated as "UUS required". + +![Sequence diagram showing SETUP message from MS A to NETWORK with UUS1, UUS2, and UUS3 activation requests, followed by ALERTING and CONNECT messages from NETWORK to MS A containing Return Results.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant MS A + participant NETWORK + Note over MS A, NETWORK: SETUP + MS A->>NETWORK: Facility (Invoke=UserUserService (UUS1, UUS required), Invoke=UserUserService (UUS2, UUS required), Invoke=UserUserService (UUS3, UUS required)), User-user (Note 1) + Note over MS A, NETWORK: . + Note over MS A, NETWORK: . + Note over MS A, NETWORK: ALERTING + NETWORK-->>MS A: Facility (Return Result, Return Result), User-user (Note 1), (Note 2) + Note over MS A, NETWORK: . + Note over MS A, NETWORK: . + Note over MS A, NETWORK: . + Note over MS A, NETWORK: CONNECT + NETWORK-->>MS A: Facility (Return Result), User-user (Note 1), (Note 2) + +``` + +Sequence diagram showing SETUP message from MS A to NETWORK with UUS1, UUS2, and UUS3 activation requests, followed by ALERTING and CONNECT messages from NETWORK to MS A containing Return Results. + +**Figure 11: Request for explicit activation of UUS1, UUS2 and UUS3 simultaneously** + +NOTE 1: The User-user information element is optional. + +NOTE 2: For UUS1 the Return Result component in the Facility information element may be sent either in the ALERTING or in the CONNECT message. For UUS2 the Return Result component in the Facility information element is sent in the ALERTING message. For UUS3 the Return Result component in the Facility information element is sent in the CONNECT message. + +# 5 User-to-User Signalling (UUS); remote mobile subscriber side + +If the network has received a non-zero SS screening indicator from the remote MS, the description in the subclauses 5.1 to 5.3 applies. + +If the network has received a zero SS screening indicator from the remote MS, three cases exist: + +If UUS service was requested as „UUS required" during the call establishment, then the SETUP message will not be sent to the remote MS. + +If UUS service was requested as „UUS not required" during the call establishment, then the SETUP message will be sent to the remote MS without the Facility information element including the UUS service activation request. + +If UUS service was requested during an active call, then the Facility information element including the request of UUS service activation will not be sent to the remote MS. + +## 5.1 UUS1 + +### 5.1.1 Operation when explicitly activated, UUS required + +In this subclause the operation of UUS1, explicitly activated and with the indication "UUS required", is described at the remote mobile subscriber side. + +![Sequence diagram showing the interaction between MS B and NETWORK for UUS1 activation. The sequence starts with a SETUP message from NETWORK to MS B. MS B responds with a Facility message containing Invoke=UserUserService (UUS1, UUS required) and User-user (Note 1). The NETWORK then sends an ALERTING message. MS B responds with a Facility (Return Result) message containing User-user (Note 1) and (Note 2). The NETWORK then sends another ALERTING message, to which MS B responds with (Note 3). The NETWORK then sends a CONNECT message. MS B responds with a User-user message containing (Note 1) and (Note 2). The NETWORK then sends another CONNECT message, to which MS B responds with (Note 3). Finally, the NETWORK sends a DISCONNECT / RELEASE COMPLETE / RELEASE message. MS B responds with a User-user message containing (Note 1), (Note 3), and (Note 4).](a734898ce18e972938949637c32a34f4_img.jpg) + +``` + +sequenceDiagram + participant MS B + participant NETWORK + Note right of NETWORK: SETUP + NETWORK->>MS B: Facility (Invoke=UserUserService (UUS1, UUS required)), User-user (Note 1) + Note right of MS B: . + Note right of MS B: . + Note right of NETWORK: ALERTING + MS B->>NETWORK: Facility (Return Result), User-user (Note 1), (Note 2) + Note right of NETWORK: ALERTING + MS B->>NETWORK: (Note 3) + Note right of NETWORK: CONNECT + MS B->>NETWORK: User-user (Note 1), (Note 2) + Note right of NETWORK: CONNECT + MS B->>NETWORK: (Note 3) + Note right of MS B: . + Note right of MS B: . + Note right of NETWORK: DISCONNECT / RELEASE COMPLETE / RELEASE + MS B->>NETWORK: User-user (Note 1), (Note 3), (Note 4) + +``` + +Sequence diagram showing the interaction between MS B and NETWORK for UUS1 activation. The sequence starts with a SETUP message from NETWORK to MS B. MS B responds with a Facility message containing Invoke=UserUserService (UUS1, UUS required) and User-user (Note 1). The NETWORK then sends an ALERTING message. MS B responds with a Facility (Return Result) message containing User-user (Note 1) and (Note 2). The NETWORK then sends another ALERTING message, to which MS B responds with (Note 3). The NETWORK then sends a CONNECT message. MS B responds with a User-user message containing (Note 1) and (Note 2). The NETWORK then sends another CONNECT message, to which MS B responds with (Note 3). Finally, the NETWORK sends a DISCONNECT / RELEASE COMPLETE / RELEASE message. MS B responds with a User-user message containing (Note 1), (Note 3), and (Note 4). + +**Figure 12: Request for explicit activation of UUS1, UUS required** + +NOTE 1: The User-user information element is optional. + +NOTE 2: The Return Result component in the Facility information element may be sent either in the ALERTING or in the CONNECT message. + +NOTE 3: If the MS B does not respond with an explicit service 1 acceptance or rejection, ALERTING or CONNECT message does not include a Return Result component. The following DISCONNECT message clears the call. See information on Cause values in Annex A. + +NOTE 4: Under normal conditions DISCONNECT message is used for clearing the call, but also RELEASE or RELEASE COMPLETE message may be used as the first call clearing message. + +### 5.1.2 Operation when explicitly activated, UUS not required + +In this subclause the operation of UUS1, explicitly activated and with the indication "UUS not required", is described at the remote mobile subscriber side. + +![Sequence diagram showing the interaction between MS B and NETWORK for UUS1 activation. The sequence includes SETUP, ALERTING, CONNECT, and DISCONNECT / RELEASE COMPLETE / RELEASE messages with associated Facility and User-user information elements.](3da1a07cb87051bf616c9876db958cf0_img.jpg) + +``` +sequenceDiagram + participant MS B + participant NETWORK + Note right of NETWORK: SETUP + MS B->>NETWORK: Facility (Invoke=UserUserService (UUS1, UUS not required)), User-user (Note 1) + Note right of NETWORK: ALERTING + NETWORK-->>MS B: Facility (Return Result), User-user (Note 1), (Note 2) + Note right of NETWORK: ALERTING / CONNECT + NETWORK-->>MS B: Facility (Return Error) + Note right of NETWORK: CONNECT + NETWORK-->>MS B: User-user (Note 1), (Note 2) + Note right of NETWORK: DISCONNECT / RELEASE COMPLETE / RELEASE + NETWORK-->>MS B: User-user (Note 1), (Note 3) +``` + +Sequence diagram showing the interaction between MS B and NETWORK for UUS1 activation. The sequence includes SETUP, ALERTING, CONNECT, and DISCONNECT / RELEASE COMPLETE / RELEASE messages with associated Facility and User-user information elements. + +**Figure 13: Request for explicit activation of UUS1, UUS not required** + +NOTE 1: The User-user information element is optional. + +NOTE 2: The Return Result component in the Facility information element may be sent either in the ALERTING or in the CONNECT message. + +NOTE 3: Under normal conditions DISCONNECT message is used for clearing the call, but also RELEASE or RELEASE COMPLETE message may be used as the first call clearing message. + +## 5.2 UUS2 + +### 5.2.1 Operation, UUS required + +In this subclause the operation of UUS2, with the indication "UUS required", is described at the remote mobile subscriber side. + +![Sequence diagram showing the interaction between MS B and the NETWORK for UUS2 activation. The sequence starts with a SETUP message from MS B to NETWORK. The NETWORK responds with a Facility (Invoke=UserUserService (UUS2, UUS required)) message. MS B then sends an ALERTING message to NETWORK. The NETWORK responds with a Facility (Return Result) message. MS B then sends another ALERTING message to NETWORK. The NETWORK responds with (Note 1). MS B then sends a DISCONNECT / RELEASE COMPLETE / RELEASE message to NETWORK. The NETWORK responds with a Cause (Note 1) message. MS B then sends a USER INFORMATION message to NETWORK. The NETWORK responds with a User-user, More data (Note 2) message. MS B then sends a CONNECT message to NETWORK.](4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg) + +``` + +sequenceDiagram + participant MS B + participant NETWORK + Note over MS B, NETWORK: SETUP + MS B->>NETWORK: Facility (Invoke=UserUserService (UUS2, UUS required)) + Note right of MS B: . + Note right of MS B: . + Note over MS B, NETWORK: ALERTING + MS B->>NETWORK: Facility (Return Result) + Note over MS B, NETWORK: ALERTING + MS B->>NETWORK: (Note 1) + Note over MS B, NETWORK: DISCONNECT / RELEASE COMPLETE / RELEASE + NETWORK->>MS B: Cause (Note 1) + Note over MS B, NETWORK: USER INFORMATION + MS B->>NETWORK: User-user, More data (Note 2) + Note right of MS B: . + Note right of MS B: . + Note over MS B, NETWORK: CONNECT + +``` + +Sequence diagram showing the interaction between MS B and the NETWORK for UUS2 activation. The sequence starts with a SETUP message from MS B to NETWORK. The NETWORK responds with a Facility (Invoke=UserUserService (UUS2, UUS required)) message. MS B then sends an ALERTING message to NETWORK. The NETWORK responds with a Facility (Return Result) message. MS B then sends another ALERTING message to NETWORK. The NETWORK responds with (Note 1). MS B then sends a DISCONNECT / RELEASE COMPLETE / RELEASE message to NETWORK. The NETWORK responds with a Cause (Note 1) message. MS B then sends a USER INFORMATION message to NETWORK. The NETWORK responds with a User-user, More data (Note 2) message. MS B then sends a CONNECT message to NETWORK. + +**Figure 14: Request for explicit activation of UUS2, UUS required** + +NOTE 1: If the MS B does not respond with an explicit service 2 acceptance or rejection, ALERTING message does not include a Return Result component. The following DISCONNECT message clears the call. See information on Cause values in Annex A. + +NOTE 2: User-user information element is mandatory and More data information element is optional in USER INFORMATION message. + +### 5.2.2 Operation, UUS not required + +In this subclause the operation of UUS2, with the indication "UUS not required", is described at the remote mobile subscriber side. + +![Sequence diagram showing the interaction between MS B and NETWORK for UUS2 activation. The sequence includes SETUP, ALERTING, USER INFORMATION, and CONNECT messages.](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` +sequenceDiagram + participant MS B + participant NETWORK + Note over MS B, NETWORK: SETUP + MS B->>NETWORK: Facility (Invoke=UserUserService (UUS2, UUS not required)) + Note over MS B, NETWORK: . + Note over MS B, NETWORK: . + Note over MS B, NETWORK: ALERTING + NETWORK-->>MS B: Facility (Return Result) + Note over MS B, NETWORK: ALERTING + NETWORK-->>MS B: Facility (Return Error) + Note over MS B, NETWORK: USER INFORMATION + MS B->>NETWORK: User-user, More data (Note 1) + Note over MS B, NETWORK: . + Note over MS B, NETWORK: . + Note over MS B, NETWORK: CONNECT +``` + +Sequence diagram showing the interaction between MS B and NETWORK for UUS2 activation. The sequence includes SETUP, ALERTING, USER INFORMATION, and CONNECT messages. + +**Figure 15: Request for explicit activation of UUS2, UUS not required** + +NOTE 1: User-user information element is mandatory and More data information element is optional in USER INFORMATION message. + +## 5.3 UUS3 + +### 5.3.1 Activation when originating a call + +#### 5.3.1.1 UUS required + +In this subclause the activation of UUS3 when originating a call, with the indication "UUS required", is described at the remote mobile subscriber side. + +![Sequence diagram for UUS3 activation when originating a call, UUS required. It shows the interaction between MS B and the NETWORK. The sequence starts with a SETUP message from MS B to NETWORK containing 'Facility (Invoke=UserUserService (UUS3, UUS required))'. The NETWORK responds with a CONNECT message. MS B then receives a 'Facility (Return Result)' message. Finally, the NETWORK sends another CONNECT message, followed by a DISCONNECT message from the NETWORK to MS B containing 'Cause (Note 1)'.](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +``` + +sequenceDiagram + participant MS B + participant NETWORK + Note right of NETWORK: SETUP + MS B->>NETWORK: Facility (Invoke=UserUserService (UUS3, UUS required)) + Note right of NETWORK: CONNECT + NETWORK-->>MS B: Facility (Return Result) + Note right of NETWORK: CONNECT + NETWORK-->>MS B: DISCONNECT + Note right of NETWORK: Cause (Note 1) + +``` + +Sequence diagram for UUS3 activation when originating a call, UUS required. It shows the interaction between MS B and the NETWORK. The sequence starts with a SETUP message from MS B to NETWORK containing 'Facility (Invoke=UserUserService (UUS3, UUS required))'. The NETWORK responds with a CONNECT message. MS B then receives a 'Facility (Return Result)' message. Finally, the NETWORK sends another CONNECT message, followed by a DISCONNECT message from the NETWORK to MS B containing 'Cause (Note 1)'. + +**Figure 16: Request for explicit activation of UUS3 when originating a call, UUS required** + +NOTE 1: If the MS B does not respond with an explicit service 3 acceptance or rejection, DISCONNECT message is sent to the MS B to clear the call. See information on Cause values in Annex A. + +#### 5.3.1.2 UUS not required + +In this subclause the activation of UUS3 when originating a call, with the indication "UUS not required", is described at the remote mobile subscriber side. + +![Sequence diagram for UUS3 activation when originating a call, UUS not required. It shows the interaction between MS B and the NETWORK. The sequence starts with a SETUP message from MS B to NETWORK containing 'Facility (Invoke=UserUserService (UUS3, UUS not required))'. The NETWORK responds with a CONNECT message. MS B then receives a 'Facility (Return Result)' message. Finally, the NETWORK sends a CONNECT message, followed by a 'Facility (Return Error)' message from the NETWORK to MS B.](2119293733c74fc64de88aefd597f4bb_img.jpg) + +``` + +sequenceDiagram + participant MS B + participant NETWORK + Note right of NETWORK: SETUP + MS B->>NETWORK: Facility (Invoke=UserUserService (UUS3, UUS not required)) + Note right of NETWORK: CONNECT + NETWORK-->>MS B: Facility (Return Result) + Note right of NETWORK: CONNECT + NETWORK-->>MS B: Facility (Return Error) + +``` + +Sequence diagram for UUS3 activation when originating a call, UUS not required. It shows the interaction between MS B and the NETWORK. The sequence starts with a SETUP message from MS B to NETWORK containing 'Facility (Invoke=UserUserService (UUS3, UUS not required))'. The NETWORK responds with a CONNECT message. MS B then receives a 'Facility (Return Result)' message. Finally, the NETWORK sends a CONNECT message, followed by a 'Facility (Return Error)' message from the NETWORK to MS B. + +**Figure 17: Request for explicit activation of UUS3 when originating a call, UUS not required** + +### 5.3.2 Activation during an active call + +In this subclause the activation of UUS3 during an active call is described at the remote mobile subscriber side. + +![Sequence diagram showing the request for explicit activation of UUS3 during an active call between MS B and NETWORK.](7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg) + +``` + +sequenceDiagram + participant MS B + participant NETWORK + Note over MS B, NETWORK: Active call + MS B->>NETWORK: FACILITY + Note right of MS B: Facility (Invoke=UserUserService (UUS3, UUS not required)) + Note over MS B, NETWORK: . + NETWORK-->>MS B: FACILITY + Note left of NETWORK: Facility (Return Result) + Note over MS B, NETWORK: . + NETWORK-->>MS B: FACILITY + Note left of NETWORK: Facility (Return Error (Error)) (Note 1) + +``` + +The diagram illustrates a sequence of messages between MS B and the NETWORK during an active call. +1. A solid line with an arrow pointing from MS B to NETWORK represents the 'FACILITY' message with 'Facility (Invoke=UserUserService (UUS3, UUS not required))'. +2. A dashed line with an arrow pointing from NETWORK to MS B represents the 'FACILITY' message with 'Facility (Return Result)'. +3. A dashed line with an arrow pointing from NETWORK to MS B represents the 'FACILITY' message with 'Facility (Return Error (Error)) (Note 1)'. +Above the first message, the text 'Active call' is centered between two horizontal lines. There are also vertical dots between the first and second messages, and between the second and third messages. + +Sequence diagram showing the request for explicit activation of UUS3 during an active call between MS B and NETWORK. + +**Figure 18: Request for explicit activation of UUS3 during an active call** + +NOTE 1: If the remote party rejects the service request or does not respond with an explicit service 3 acceptance of rejection, the FACILITY message includes Facility information element with Return Error component indicating error "rejectedByUser". If the network rejects the request, the error value shall be "rejectedByNetwork". + +# 6 Identification of parallel transactions in UUS + +If more than one parallel CC transaction is active, UUS operations are directed to the desired transaction identified by the pertaining transaction identifier. + +# Annex A (normative): Cause values used in UUS supplementary service + +| Cause value | Situation | Information on usage | +|----------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| #29 facility rejected | To served mobile subscriber side, call clearing | If the remote party rejects the activation request of a UUS service, the Cause value #29 is sent to the served subscriber. | +| #47 resource unavailable, unspecified | To served mobile subscriber side, call clearing | If the network rejects the activation request of a UUS service, the Cause value #47 or #50 is sent to the served subscriber. | +| #50 requested facility not subscribed | To served mobile subscriber side, call clearing | If the network rejects the activation request of a UUS service, the Cause value #47 or #50 is sent to the served subscriber. | +| #69 requested facility not implemented | To served mobile subscriber side, call clearing | If the remote party does not respond with an explicit UUS service acceptance or rejection to the activation request, the Cause value #69 is sent to the served subscriber. | +| #31 normal, unspecified | To remote mobile subscriber side, call clearing | If the remote party does not respond with an explicit UUS service acceptance or rejection, the Cause value #31 is sent to him. | +| #43 access information discarded | To served mobile subscriber side, flow control | The Cause value #43 is sent within CONGESTION CONTROL message to the served subscriber. | + +# --- Annex B (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|----------|-----------|----|---------|-------------|--------------------------------| +| Apr 1999 | GSM 04.87 | | | | Transferred to 3GPP CN1 | +| CN#03 | 24.087 | | R99 | 3.0.0 | Approved at CN#03 | +| CN#11 | 24.087 | | Rel-4 | 4.0.0 | Approved at CN#11 | +| CN#16 | 24.087 | | Rel-4 | 4.0.1 | References updated | +| CN#16 | 24.087 | | Rel-5 | 5.0.0 | Rel-5 created after CN#16 | +| CN#26 | 24.087 | | Rel-6 | 6.0.0 | Rel-6 created after CN#26 | +| CT#36 | 24.087 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 24.087 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 24.087 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 24.087 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2012-09 | 24.087 | - | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 24.087 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 24.087 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 24.087 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 24.087 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 24.087 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24088/21c78ed8eb23eb76d4a2c9edbe5626bb_img.jpg b/marked/Rel-16/24_series/24088/21c78ed8eb23eb76d4a2c9edbe5626bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f58fc17787e1476284ebcefe9a9d16270b0d5b52 --- /dev/null +++ b/marked/Rel-16/24_series/24088/21c78ed8eb23eb76d4a2c9edbe5626bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:968c68fdcf9570f0d24dfa13eed267ba54ed1e59362dd814799d632de257d936 +size 17186 diff --git a/marked/Rel-16/24_series/24088/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/24_series/24088/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..936f2de453e9dc21eea694b6f1b0edb8da93fb31 --- /dev/null +++ b/marked/Rel-16/24_series/24088/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8ffe36a379785ddb909df2b77366b30c878af34f8c533f217e2ad5359d2fb29 +size 31886 diff --git a/marked/Rel-16/24_series/24088/34f788b0e5bc8af774fa5561c22e6d01_img.jpg b/marked/Rel-16/24_series/24088/34f788b0e5bc8af774fa5561c22e6d01_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c40c56cd14d71c91b2472c6f2341b8f0990dea8 --- /dev/null +++ b/marked/Rel-16/24_series/24088/34f788b0e5bc8af774fa5561c22e6d01_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6d4741594d7dfa9b8daebb127a6d4cdb62e4e4333e5c0e24d3c15bea53e467b4 +size 25306 diff --git a/marked/Rel-16/24_series/24088/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/24_series/24088/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7cae4c00970cf259e2a3781f110d4f3d503e80d5 --- /dev/null +++ b/marked/Rel-16/24_series/24088/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:19d0ff7edcf018278f920461a1b14bc94cbe942cd65a67497096f17be7143164 +size 65962 diff --git a/marked/Rel-16/24_series/24088/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/24_series/24088/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95fa07140a8b3d2cd78ae69f2de49663ca975575 --- /dev/null +++ b/marked/Rel-16/24_series/24088/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e892b41f5e6f7aee21daa400bc1dcfd8d5a807afb2018244cedfb42656e844f +size 70430 diff --git a/marked/Rel-16/24_series/24088/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/24_series/24088/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7875aea3f0c6f2ef782c1e35a0c5c59315fe1f9c --- /dev/null +++ b/marked/Rel-16/24_series/24088/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2999cfbaff8ad7d59d4149050fb6d447e3c7ad499c5930ac5df84916b349ef9c +size 70291 diff --git a/marked/Rel-16/24_series/24088/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/24_series/24088/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9ba76702bb4fadcb5e4105d9e834183e27f3a94 --- /dev/null +++ b/marked/Rel-16/24_series/24088/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e3ab287cb15d50abef16e99768577c18fbef35fb35871975930846c45046642 +size 73145 diff --git a/marked/Rel-16/24_series/24088/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/24_series/24088/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..829d9599a773f11c0c84f509fd2d29ffe262cb8a --- /dev/null +++ b/marked/Rel-16/24_series/24088/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcb5f8050d012eb483da8c2dca84b8a60df8296aa3f1b88fe380a16c60f837c0 +size 70124 diff --git a/marked/Rel-16/24_series/24088/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/24_series/24088/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec514c1784ff2ed11bb29c2794be7b3ba6aaec8d --- /dev/null +++ b/marked/Rel-16/24_series/24088/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:257f6f18ac622c3575e6ebee8bbc6b62ac36303472d0dabf145bcd22b53ac5d9 +size 69623 diff --git a/marked/Rel-16/24_series/24088/raw.md b/marked/Rel-16/24_series/24088/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fa41e5bfff778ba105d662839175844b7cc6d45b --- /dev/null +++ b/marked/Rel-16/24_series/24088/raw.md @@ -0,0 +1,526 @@ + + + + + + +# --- Contents + +| | | +|---------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 0 Scope..... | 6 | +| 0.1 Normative references ..... | 6 | +| 0.2 Abbreviations ..... | 7 | +| 0.3 Cross phase compatibility ..... | 7 | +| 1 Barring of outgoing calls..... | 7 | +| 1.1 Normal operation..... | 7 | +| 1.2 Registration ..... | 8 | +| 1.3 Activation..... | 8 | +| 1.4 Deactivation ..... | 9 | +| 1.5 Interrogation ..... | 10 | +| 1.6 Invocation and erasure ..... | 11 | +| 1.7 Cross phase compatibility ..... | 11 | +| 1.7.1 Network only supports GSM Phase 1 control of SS by the subscriber ..... | 11 | +| 1.7.2 MS only supports protocol version 1 control of SS by the subscriber ..... | 11 | +| 2 Barring of incoming calls other than Anonymous Call Rejection ..... | 11 | +| 2.1 Normal operation..... | 11 | +| 2.2 Registration ..... | 12 | +| 2.3 Activation..... | 12 | +| 2.4 Deactivation ..... | 13 | +| 2.5 Interrogation ..... | 14 | +| 2.6 Invocation and erasure ..... | 15 | +| 2.7 Cross phase compatibility ..... | 15 | +| 2.7.1 Network only supports GSM Phase 1 control of SS by the subscriber ..... | 15 | +| 2.7.2 MS only supports protocol version 1 control of SS by the subscriber ..... | 15 | +| 3 Anonymous Call Rejection ..... | 15 | +| Annex A (informative): Change history..... | 16 | + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS specifies the procedures used at the radio interface for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of call barring supplementary services within the 3GPP system. + +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: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# --- Introduction + +The present document includes references to features which are not part of the Phase 2+ Release 96 of the GSM Technical specifications. All subclauses which were changed as a result of these features contain a marker (see table below) relevant to the particular feature. GSM 10.01 defines the correspondence between these features and GSM yearly releases. + +The following table lists all features that were introduced after Release 96. + +| Feature | Designator | +|---------------|--------------| +| CAMEL Phase 2 | \$(CAMEL2)\$ | + +# 0 Scope + +This Technical Specification (TS) specifies the procedures used at the radio interface (reference point Um as defined in 3GPP TS 24.002) for normal operation, registration, erasure, activation, deactivation, invocation and interrogation of call barring supplementary services. Provision and withdrawal of supplementary services is an administrative matter between the mobile subscriber and the service provider and cause no signalling on the radio interface. + +In 3GPP TS 24.010 the general aspects of the specification of supplementary services at the layer 3 radio interface are given. + +3GPP TS 24.080 specifies the formats and coding for the supplementary services. + +Definitions and descriptions of supplementary services are given in 3GPP TS 22.004, GSM 02.8x and GSM 02.9x-series. + +Technical realization of supplementary services is described in 3GPP TS 23.011, GSM 03.8x and GSM 03.9x-series. + +The procedures for Call Control, Mobility Management and Radio Resource management at the layer 3 radio interface are defined in 3GPP TS 24.007 and 3GPP TS 24.008. + +The following supplementary services belong to the call restriction supplementary services and are described in this specification: + +- | | | | +|------------------------------------------------------------------------------------------|-------------|----------------------| +| - Barring of outgoing calls | | (clause 1): | +| - Barring of all outgoing calls | (BAOC) | (Barring program 1); | +| - Barring of outgoing international calls | (BOIC) | (Barring program 2); | +| - Barring of outgoing international calls EXCEPT those directed to the home PLMN country | (BOIC-exHC) | (Barring program 3). | +| - Barring of incoming calls | | (clause 2): | +| - Barring of all incoming calls | (BAIC) | (Barring program 1); | +| - Barring of incoming calls when roaming outside the home PLMN country | (BIC-Roam) | (Barring program 2); | +| - Anonymous Call Rejection | (ACR) | (Barring program 3). | + +## 0.1 Normative references + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.004: "General on supplementary services". +- [3] 3GPP TS 23.011: "Technical realization of supplementary services". +- [4] 3GPP TS 24.002: "GSM Public Land Mobile Network (PLMN) access reference configuration". +- [5] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [6] 3GPP TS 24.008: "Mobile radio interface layer 3 specification". +- [7] 3GPP TS 24.010: "Mobile radio interface layer 3; Supplementary services specification; General aspects". + +- [8] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [9] 3GPP TS 23.088: "Call Barring (CB) Supplementary Service; Stage 2". + +## 0.2 Abbreviations + +Abbreviations used in this specification are listed in 3GPP TR 21.905. + +## 0.3 Cross phase compatibility + +For the following supplementary services, a number of changes exist between this specification and the protocol version 1 specification: + +- Barring of outgoing calls; +- Barring of incoming calls. + +The main body of this specification assumes that all network entities comply with this version of the service. In each case an additional subclauses 1.7 and 2.7 defines the additional requirements for when one or more network entities or the MS complies with the protocol version 1 specifications for the supplementary service procedures. + +# 1 Barring of outgoing calls + +## 1.1 Normal operation + +When a barring program relating to outgoing calls is active and operative for a basic service, each call set up related to that basic service and not allowed by the barring program will be refused by the network. In this case a NotifySS operation containing the SS-Status indicating that a barring program relating to outgoing calls is currently active and operative will be sent to the served mobile subscriber in a clearing message (see figure 1.1). For SMS, RP cause "Call barred" shall be sent to MS (see figure 1.2). + +![Sequence diagram showing a SETUP message from MS to Network, followed by a DISCONNECT/RELEASE/RELEASE COMPLETE message and a Facility invocation from Network to MS.](34f788b0e5bc8af774fa5561c22e6d01_img.jpg) + +MSNetwork + +SETUP + +------------------------------------------------------------------------------------------------------------------------------------> + +DISCONNECT/RELEASE/RELEASE COMPLETE + +<------------------------------------------------------------------------------------------------------------------------------------ + +Facility (Invoke = NotifySS (SS-Code, SS-Status)) + +Sequence diagram showing a SETUP message from MS to Network, followed by a DISCONNECT/RELEASE/RELEASE COMPLETE message and a Facility invocation from Network to MS. + +NOTE 1: The SS-Code will be the common code for outgoing barring services. + +NOTE 2: \$(CAMEL2)\$ The DISCONNECT and RELEASE messages were introduced because of CAMEL Phase 2. + +**Figure 1.1: Notification to the served mobile subscriber that barring of outgoing circuit switched calls is active** + +![Sequence diagram showing an RP-DATA message from MS to Network, followed by an RP-ERROR (RP-cause) message from Network to MS.](21c78ed8eb23eb76d4a2c9edbe5626bb_img.jpg) + +MSNetwork + +RP-DATA + +------------------------------------------------------------------------------------------------------------------------------------> + +RP-ERROR (RP-cause) + +<------------------------------------------------------------------------------------------------------------------------------------ + +Sequence diagram showing an RP-DATA message from MS to Network, followed by an RP-ERROR (RP-cause) message from Network to MS. + +**Figure 1.2: Notification to the served mobile subscriber that barring of MO SMS is active** + +When a barring program is active (operative or quiescent), the ability of the served mobile subscriber to set up emergency calls is not affected, irrespective of the basic service to which the barring program applies. + +When a barring program relating to outgoing calls is active (operative or quiescent), the ability of the served mobile subscriber to receive calls is not affected. + +## 1.2 Registration + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by subscriber using password", the subscriber has to register a call barring password at provision time. Furthermore the served mobile subscriber can change the call barring password by a registration procedure at any time. + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by service provider", an attempt to register a new call barring password will be denied. + +The procedure to register a new password is specified in 3GPP TS 24.010. + +## 1.3 Activation + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by subscriber using password", the supplementary service is activated for a basic service if the subscriber has requested so by means of an activation procedure for that basic service. If the subscriber does not indicate a specific basic service, the activation applies to all basic services. The subscriber may use the call barring password at activation (see figure 1.2). + +If the activation is successful, the service will be activated. The network will then send a return result indicating acceptance of the request. The result is formatted according to the options shown below: + +- The result includes the Basic Service group Code(s) to which the service is activated. The result may also contain an SS-Code and SS-Status parameter. If the MS does not send an SS Version Indicator in the invocation request then these parameters shall be presented in the result. If the MS does send an SS Version Indicator in the invocation request then these parameters are optional in the result. If the SS-Status is included the network shall set it to reflect the state of the service. If the SS-Code is included then it shall contain the SS-Code of the service which has been activated. The MS shall ignore the contents of the SS-Code and SS-Status parameters if they are received. + +Note that the use of SS-Code and SS-Status is to provide backwards compatibility with GSM Phase 1. + +- If the request did not include a BasicServiceCode, and the activation was successful for all basic services, the network may send an empty return result to the MS. This option applies whether or not an SS Version Indicator is received from the MS. + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by service provider", an attempt to activate the service will be denied and the served mobile subscriber receives an error indication (see figure 1.3). + +Error values are specified in 3GPP TS 24.080. + +![Sequence diagram showing the activation of a barring program. The MS sends a REGISTER message with Facility (Invoke = ActivateSS (SS-Code, BasicServiceCode)). A dashed box indicates a password procedure according to 3GPP TS 24.010. The Network responds with RELEASE COMPLETE and Facility (Return result = ActivateSS (SS-Code, BasicServiceCode, SS-Status)). The MS then sends another RELEASE COMPLETE and Facility (Return error (Error)). Finally, the Network sends RELEASE COMPLETE and Facility (Reject (Invoke_problem)).](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +MS Network + +REGISTER + +-----> + +Facility (Invoke = ActivateSS (SS-Code, BasicServiceCode)) + +Password procedure according to 3GPP TS 24.010 + +-----> + +RELEASE COMPLETE + +<----- + +Facility (Return result = ActivateSS (SS-Code, BasicServiceCode, SS-Status)) + +RELEASE COMPLETE + +<----- + +Facility (Return error (Error)) + +RELEASE COMPLETE + +<----- + +Facility (Reject (Invoke\_problem)) + +Sequence diagram showing the activation of a barring program. The MS sends a REGISTER message with Facility (Invoke = ActivateSS (SS-Code, BasicServiceCode)). A dashed box indicates a password procedure according to 3GPP TS 24.010. The Network responds with RELEASE COMPLETE and Facility (Return result = ActivateSS (SS-Code, BasicServiceCode, SS-Status)). The MS then sends another RELEASE COMPLETE and Facility (Return error (Error)). Finally, the Network sends RELEASE COMPLETE and Facility (Reject (Invoke\_problem)). + +**Figure 1.2: Activation of a barring program** + +NOTE: The SS-Code will be one of the specific outgoing barring codes. If BasicServiceCode is not included it applies to all basic services. The SS-Code and SS-Status may not be included in the result in all cases (see text). + +## 1.4 Deactivation + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by subscriber using password", the supplementary service is deactivated for a basic service if the subscriber has requested deactivation by means of a deactivation procedure for that basic service. The subscriber may use the call barring password at deactivation (see figure 1.3). + +The deactivation request of a barring program may specify the basic service. If the subscriber does not indicate a specific basic service, the deactivation applies to all basic services (see figure 1.3). + +If the deactivation is successful, the service will be deactivated. The network will then send a return result indicating acceptance of the request. The result is formatted according to the options shown below: + +- The result includes the Basic Service group Code(s) to which the service is deactivated. The result may also contain an SS-Code and SS-Status parameter. If the MS does not send an SS Version Indicator in the invocation request then these parameters shall be presented in the result. If the MS does send an SS Version Indicator in the invocation request then these parameters are optional in the result. If the SS-Status is included the network shall set it to reflect the state of the service. If the SS-Code is included then it shall contain the SS-Code of the service which has been deactivated. The MS shall ignore the contents of the SS-Code and SS-Status parameters if they are received. + +Note that the use of SS-Code and SS-Status is to provide backwards compatibility with GSM Phase 1. + +- If the request did not include a BasicServiceCode, and the deactivation was successful for all basic services, the network may send an empty return result to the MS. This option applies whether or not an SS Version Indicator is received from the MS. + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by service provider", an attempt to deactivate the supplementary service will be denied and the served mobile subscriber receives an error indication (see figure 1.3). Error values are specified in 3GPP TS 24.080. + +![Sequence diagram showing the deactivation of barring of outgoing calls between MS and Network. The process involves a REGISTER message, a password procedure, and subsequent RELEASE COMPLETE messages with facility details.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: Password procedure according to 3GPP TS 24.010 + MS->>Network: Facility (Invoke = DeactivateSS (SS-Code, BasicServiceCode)) + Network-->>MS: RELEASE COMPLETE + Note right of Network: Facility (Return result = DeactivateSS (SS-Code, BasicServiceCode, SS-Status)) + Network-->>MS: RELEASE COMPLETE + Note right of Network: Facility (Return error (Error)) + Network-->>MS: RELEASE COMPLETE + Note right of Network: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the deactivation of barring of outgoing calls between MS and Network. The process involves a REGISTER message, a password procedure, and subsequent RELEASE COMPLETE messages with facility details. + +**Figure 1.3: Deactivation of barring of outgoing calls** + +**NOTE:** The SS-Code may be one of the specific outgoing barring codes, the common code for the outgoing barring services, or the SS-Code for all call barring services. If BasicServiceCode is not included it applies to all basic services. The SS-Code and SS-Status may not be included in the result in all cases (see text). + +## 1.5 Interrogation + +The interrogation procedure enables the mobile subscriber to obtain information about data stored in the PLMN. After having requested this procedure the network shall return a list of all basic service groups for which the service is active (see figure 1.4). + +If there is no basic service group for which the service is active, an SS-Status will be returned indicating that the service is "deactivated". + +![Sequence diagram showing the interrogation of a barring program between MS and Network. The diagram shows four possible response paths from the Network to the MS after a REGISTER message is sent. Path 1: REGISTER -> Facility (Invoke = InterrogateSS (SS-Code)) -> RELEASE COMPLETE -> Facility (Return result = InterrogateSS (BasicServiceCode)). Path 2: REGISTER -> RELEASE COMPLETE -> Facility (Return result = InterrogateSS (SS-Status)). Path 3: REGISTER -> RELEASE COMPLETE -> Facility (Return error (Error)). Path 4: REGISTER -> RELEASE COMPLETE -> Facility (Reject (Invoke_problem)).](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: REGISTER + MS->>Network: Facility (Invoke = InterrogateSS (SS-Code)) + Network-->>MS: RELEASE COMPLETE + Network-->>MS: Facility (Return result = InterrogateSS (BasicServiceCode)) + Note over MS, Network: or + Network-->>MS: RELEASE COMPLETE + Network-->>MS: Facility (Return result = InterrogateSS (SS-Status)) + Note over MS, Network: RELEASE COMPLETE + Network-->>MS: Facility (Return error (Error)) + Note over MS, Network: RELEASE COMPLETE + Network-->>MS: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the interrogation of a barring program between MS and Network. The diagram shows four possible response paths from the Network to the MS after a REGISTER message is sent. Path 1: REGISTER -> Facility (Invoke = InterrogateSS (SS-Code)) -> RELEASE COMPLETE -> Facility (Return result = InterrogateSS (BasicServiceCode)). Path 2: REGISTER -> RELEASE COMPLETE -> Facility (Return result = InterrogateSS (SS-Status)). Path 3: REGISTER -> RELEASE COMPLETE -> Facility (Return error (Error)). Path 4: REGISTER -> RELEASE COMPLETE -> Facility (Reject (Invoke\_problem)). + +**Figure 1.4: Interrogation of a barring program** + +NOTE: The SS-Code may be one of the specific outgoing barring codes. + +## 1.6 Invocation and erasure + +Invocation and erasure are not applicable to barring programs. + +## 1.7 Cross phase compatibility + +### 1.7.1 Network only supports GSM Phase 1 control of SS by the subscriber + +In this case there is no relevant cross phase compatibility problem. + +### 1.7.2 MS only supports protocol version 1 control of SS by the subscriber + +In this case there is no relevant cross phase compatibility problem. + +# --- 2 Barring of incoming calls other than Anonymous Call Rejection + +## 2.1 Normal operation + +When a barring program relating to incoming calls is active and operative for a basic service, each incoming call set-up related to that basic service and not allowed by the barring program will be refused by the network. In this case a NotifySS operation containing the SS-Status indicating that a barring program relating to incoming calls is currently active and operative will be sent to the calling mobile subscriber in a clearing message (see figure 2.1). + +![Sequence diagram showing communication between MS and Network. A dashed arrow labeled 'SETUP' points from MS to Network. A dashed arrow labeled 'DISCONNECT/RELEASE/RELEASE COMPLETE' points from Network to MS. Below the return arrow, the text 'Facility (Invoke = NotifySS (SS-Code, SS-Status))' is shown.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note over MS, Network: SETUP + MS->>Network: SETUP + Note over Network, MS: DISCONNECT/RELEASE/RELEASE COMPLETE + Network-->>MS: DISCONNECT/RELEASE/RELEASE COMPLETE + Note right of Network: Facility (Invoke = NotifySS (SS-Code, SS-Status)) + +``` + +Sequence diagram showing communication between MS and Network. A dashed arrow labeled 'SETUP' points from MS to Network. A dashed arrow labeled 'DISCONNECT/RELEASE/RELEASE COMPLETE' points from Network to MS. Below the return arrow, the text 'Facility (Invoke = NotifySS (SS-Code, SS-Status))' is shown. + +**Figure 2.1: Notification to the calling mobile subscriber that at the called subscriber side barring is active** + +NOTE: The SS-Code will be the common code for incoming barring services. + +When barring of incoming calls is active (operative or quiescent), the ability of the served mobile subscriber to originate calls is not affected. + +## 2.2 Registration + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by subscriber using password", the subscriber has to register a call barring password at provision time. Furthermore the served mobile subscriber can change the call barring password by a registration procedure at any time. + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by service provider", an attempt to register a new call barring password will be denied. + +The procedure to register a new password is specified in 3GPP TS 24.010. + +## 2.3 Activation + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by subscriber using password", the supplementary service is activated for a basic service if the subscriber has requested so by means of an activation procedure for that basic service. If the subscriber does not indicate a specific basic service, the activation applies to all basic services. The subscriber may use the call barring password at activation (see figure 2.2). + +If the activation is successful, the service will be activated. The network will then send a return result indicating acceptance of the request. The result is formatted according to the options shown below: + +- The result includes the Basic Service group Code(s) to which the service is activated. The result may also contain an SS-Code and SS-Status parameter. If the MS does not send an SS Version Indicator in the invocation request then these parameters shall be presented in the result. If the MS does send an SS Version Indicator in the invocation request then these parameters are optional in the result. If the SS-Status is included the network shall set it to reflect the state of the service. If the SS-Code is included then it shall contain the SS-Code of the service which has been activated. The MS shall ignore the contents of the SS-Code and SS-Status parameters if they are received. + +Note that the use of SS-Code and SS-Status is to provide backwards compatibility with GSM Phase 1. + +- If the request did not include a BasicServiceCode, and the activation was successful for all basic services, the network may send an empty return result to the MS. This option applies whether or not an SS Version Indicator is received from the MS. + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by service provider", an attempt to activate the service will be denied and the served mobile subscriber receives an error indication (see figure 2.2). + +Error values are specified in 3GPP TS 24.080. + +![Sequence diagram showing the activation of a barring program. The MS sends a REGISTER message to the Network. The Network responds with a Facility (Invoke = ActivateSS) message. A box indicates a password procedure according to 3GPP TS 24.010. The Network then sends a RELEASE COMPLETE message with a Facility (Return result = ActivateSS) message. The MS responds with a RELEASE COMPLETE message. The Network then sends a Facility (Return error (Error)) message. The MS responds with a RELEASE COMPLETE message. The Network then sends a Facility (Reject (Invoke_problem)) message.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +MS Network + +REGISTER + +-----> + +Facility (Invoke = ActivateSS (SS-Code, BasicServiceCode)) + +Password procedure according to 3GPP TS 24.010 + +<----- + +RELEASE COMPLETE + +Facility (Return result = ActivateSS (SS-Code, BasicServiceCode, SS-Status)) + +<----- + +RELEASE COMPLETE + +Facility (Return error (Error)) + +<----- + +RELEASE COMPLETE + +Facility (Reject (Invoke\_problem)) + +Sequence diagram showing the activation of a barring program. The MS sends a REGISTER message to the Network. The Network responds with a Facility (Invoke = ActivateSS) message. A box indicates a password procedure according to 3GPP TS 24.010. The Network then sends a RELEASE COMPLETE message with a Facility (Return result = ActivateSS) message. The MS responds with a RELEASE COMPLETE message. The Network then sends a Facility (Return error (Error)) message. The MS responds with a RELEASE COMPLETE message. The Network then sends a Facility (Reject (Invoke\_problem)) message. + +**Figure 2.2: Activation of a barring program** + +NOTE: The SS-Code will be one of the specific incoming barring codes. If BasicServiceCode is not included it applies to all basic services. The SS-Code and SS-Status may not be included in the result in all cases (see text). + +## 2.4 Deactivation + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by subscriber using password", the supplementary service is deactivated for a basic service if the subscriber has requested deactivation by means of a deactivation procedure for that basic service. The subscriber may use the call barring password at deactivation (see figure 2.3). + +If the deactivation is successful, the service will be deactivated. The network will then send a return result indicating acceptance of the request. The result is formatted according to the options shown below: + +- The result includes the Basic Service group Code(s) to which the service is deactivated. The result may also contain an SS-Code and SS-Status parameter. If the MS does not send an SS Version Indicator in the invocation request then these parameters shall be presented in the result. If the MS does send an SS Version Indicator in the invocation request then these parameters are optional in the result. If the SS-Status is included the network shall set it to reflect the state of the service. If the SS-Code is included then it shall contain the SS-Code of the service which has been deactivated. The MS shall ignore the contents of the SS-Code and SS-Status parameters if they are received. + +Note that the use of SS-Code and SS-Status is to provide backwards compatibility with GSM Phase 1. + +- If the request did not include a BasicServiceCode, and the deactivation was successful for all basic services, the network may send an empty return result to the MS. This option applies whether or not an SS Version Indicator is received from the MS. + +If the served mobile subscriber at provision time has selected the subscription option "control of barring service: by service provider", an attempt to deactivate the supplementary service will be denied and the served mobile subscriber receives an error indication (see figure 2.3). + +Error values are specified in 3GPP TS 24.080. + +![Sequence diagram showing the deactivation of barring of incoming calls between MS and Network. The process starts with a REGISTER message from MS to Network. The Network responds with a Facility (Invoke = DeactivateSS) message. A box labeled 'Password procedure according to 3GPP TS 24.010' is shown. The Network then sends a RELEASE COMPLETE message with Facility (Return result = DeactivateSS). The MS responds with RELEASE COMPLETE and Facility (Return error (Error)). Finally, the Network sends another RELEASE COMPLETE message with Facility (Reject (Invoke_problem)).](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: Password procedure according to 3GPP TS 24.010 + MS->>Network: REGISTER + Network-->>MS: Facility (Invoke = DeactivateSS (SS-Code, BasicServiceCode)) + Network-->>MS: RELEASE COMPLETE + MS-->>Network: RELEASE COMPLETE + MS-->>Network: Facility (Return error (Error)) + Network-->>MS: RELEASE COMPLETE + Network-->>MS: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the deactivation of barring of incoming calls between MS and Network. The process starts with a REGISTER message from MS to Network. The Network responds with a Facility (Invoke = DeactivateSS) message. A box labeled 'Password procedure according to 3GPP TS 24.010' is shown. The Network then sends a RELEASE COMPLETE message with Facility (Return result = DeactivateSS). The MS responds with RELEASE COMPLETE and Facility (Return error (Error)). Finally, the Network sends another RELEASE COMPLETE message with Facility (Reject (Invoke\_problem)). + +**Figure 2.3: Deactivation of barring of incoming calls** + +NOTE: The SS-Code may be one of the specific incoming barring codes, the common code for the incoming barring services, or the SS-Code for all call barring services. If BasicServiceCode is not included it applies to all basic services. The SS-Code and SS-Status may not be included in the result in all cases (see text). + +## 2.5 Interrogation + +The interrogation procedure enables the mobile subscriber to obtain information about the data stored in the PLMN. After having requested this procedure the network shall return a list of all basic service groups for which the service is active (see figure 2.4). + +If there is no basic service group for which the service is active, an SS-Status will be returned indicating that the service is "deactivated". + +![Sequence diagram showing the interrogation of a barring program between MS and Network. The diagram shows a REGISTER message from MS to Network, followed by a Facility (Invoke = InterrogateSS (SS-Code)) message. The Network responds with a RELEASE COMPLETE message containing a Facility (Return result = InterrogateSS (BasicServiceCode)) message. Alternatively, the Network can respond with a RELEASE COMPLETE message containing a Facility (Return result = InterrogateSS (SS-Status)) message, or a RELEASE COMPLETE message containing a Facility (Return error (Error)) message, or a RELEASE COMPLETE message containing a Facility (Reject (Invoke_problem)) message.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Network + Note right of Network: REGISTER + MS->>Network: Facility (Invoke = InterrogateSS (SS-Code)) + Network-->>MS: RELEASE COMPLETE + Note left of MS: Facility (Return result = InterrogateSS (BasicServiceCode)) + Note right of Network: or + Network-->>MS: RELEASE COMPLETE + Note left of MS: Facility (Return result = InterrogateSS (SS-Status)) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Return error (Error)) + Note right of Network: RELEASE COMPLETE + Network-->>MS: Facility (Reject (Invoke_problem)) + +``` + +Sequence diagram showing the interrogation of a barring program between MS and Network. The diagram shows a REGISTER message from MS to Network, followed by a Facility (Invoke = InterrogateSS (SS-Code)) message. The Network responds with a RELEASE COMPLETE message containing a Facility (Return result = InterrogateSS (BasicServiceCode)) message. Alternatively, the Network can respond with a RELEASE COMPLETE message containing a Facility (Return result = InterrogateSS (SS-Status)) message, or a RELEASE COMPLETE message containing a Facility (Return error (Error)) message, or a RELEASE COMPLETE message containing a Facility (Reject (Invoke\_problem)) message. + +**Figure 2.4: Interrogation of a barring program** + +NOTE: The SS-Code may be one of the specific incoming barring codes. + +## 2.6 Invocation and erasure + +Invocation and erasure are not applicable to barring programs. + +## 2.7 Cross phase compatibility + +### 2.7.1 Network only supports GSM Phase 1 control of SS by the subscriber + +In this case there is no relevant cross phase compatibility problem. + +### 2.7.2 MS only supports protocol version 1 control of SS by the subscriber + +The NotifySS operation containing the SS-Status indicating that a barring program relating to incoming calls is currently active and operative shall be sent to the calling subscriber only in the RELEASE COMPLETE message, if the MS only supports GSM Phase 1. + +# --- 3 Anonymous Call Rejection + +Activation, deactivation and interrogation of the status of the ACR supplementary service are supported by USSD procedure (see 3GPP TS 23.088 [9]). + +Normal operation is also specified in 3GPP TS 23.088 [9]. + +# Annex A (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|----------|-----------|--------|---------|-------------|-------------------------------------------------------| +| Apr 1999 | GSM 04.88 | | | | Transferred to 3GPP CN1 | +| CN#03 | 24.088 | | R99 | 3.0.0 | Approved at CN#03 | +| CN#11 | 24.088 | | Rel-4 | 4.0.0 | Approved at CN#11 | +| CN#16 | 24.088 | | Rel-4 | 4.0.1 | References updated | +| CN#16 | 24.088 | | Rel-5 | 5.0.0 | Rel-5 created after CN#16 | +| CN#19 | 24.088 | 0001r2 | Rel-6 | 6.0.0 | Introducing SMS Call Barring in PS domain | +| CT#36 | 24.088 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 24.088 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 24.088 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 24.088 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| CT#53 | 24.088 | 0002r1 | Rel-11 | 11.0.0 | Addition of Anonymous Call Rejection in the CS domain | +| 2014-09 | 24.088 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 24.088 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 24.088 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 24.088 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 24.088 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24109/0a73b03fba21af142d619a9a662e6490_img.jpg b/marked/Rel-16/24_series/24109/0a73b03fba21af142d619a9a662e6490_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..43eb892c073bac7a4779d4e4fb49c4289cc09fcc --- /dev/null +++ b/marked/Rel-16/24_series/24109/0a73b03fba21af142d619a9a662e6490_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65b699b36ca916ee0ad00bf30aebcf3261c3db0110c38ec268ca89939d469ab8 +size 130993 diff --git a/marked/Rel-16/24_series/24109/1eadbbe42cfcac5c0023577110aec5e3_img.jpg b/marked/Rel-16/24_series/24109/1eadbbe42cfcac5c0023577110aec5e3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..79fd0513b1214b16e01541b9954048ef7b2edfbc --- /dev/null +++ b/marked/Rel-16/24_series/24109/1eadbbe42cfcac5c0023577110aec5e3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fdf2219bb7c510716f909d81c7cefb3d35a1750bdd7fe1da42c7c8b629ec3324 +size 26073 diff --git a/marked/Rel-16/24_series/24109/32ff77da4286b58c4778033acaa10836_img.jpg b/marked/Rel-16/24_series/24109/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8b936ccaf33e9fe1b2fdedefe12c8f61d95d4caf --- /dev/null +++ b/marked/Rel-16/24_series/24109/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:758e32b9764c326a908cabf41130534943a54b948f9df80b2e6fd8d4e41c432c +size 63545 diff --git a/marked/Rel-16/24_series/24109/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg b/marked/Rel-16/24_series/24109/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f3ee6557d499a0df1fe37b6916c31f06d6f5339 --- /dev/null +++ b/marked/Rel-16/24_series/24109/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:261e9dc4d406a71c2475a26ab74f93f32d3e9f294a4d0f0dfab623edfe2e513b +size 57036 diff --git a/marked/Rel-16/24_series/24109/64fd8bd804acee34ea91bdde28997fe3_img.jpg b/marked/Rel-16/24_series/24109/64fd8bd804acee34ea91bdde28997fe3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c436cf397daa1449f2bf6966ad2f706d3aea062 --- /dev/null +++ b/marked/Rel-16/24_series/24109/64fd8bd804acee34ea91bdde28997fe3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d1ac4481f3ef09d950a54060cca0ed903a5d965e0c29c0f4a3bc0da8e0e1e80 +size 25078 diff --git a/marked/Rel-16/24_series/24109/65e8c0628536d6d4245e9ab46ba070c3_img.jpg b/marked/Rel-16/24_series/24109/65e8c0628536d6d4245e9ab46ba070c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c992167367ce307046409139c533bed65edf107 --- /dev/null +++ b/marked/Rel-16/24_series/24109/65e8c0628536d6d4245e9ab46ba070c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31bf29f5a75eac20afc114a072f1eab9594e7904e4bbca2412c576f99e795946 +size 55421 diff --git a/marked/Rel-16/24_series/24109/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg b/marked/Rel-16/24_series/24109/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2068a321e1716af4ffdefe40e5fd5874d1dc09aa --- /dev/null +++ b/marked/Rel-16/24_series/24109/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf8ca15d554dfa8ea38183c0b5a9670fde401a5115022892cccdb683ee41da57 +size 48015 diff --git a/marked/Rel-16/24_series/24109/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/marked/Rel-16/24_series/24109/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2816ddf84fd2ca3c8a07cee6b921d5221bfbdc2f --- /dev/null +++ b/marked/Rel-16/24_series/24109/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:363aad5dd451c063d9ed02143ce76b1a3cf92eb95862e8c888ec0ca56e3f7d9c +size 58763 diff --git a/marked/Rel-16/24_series/24109/74d23510f27b21403a7be84820821863_img.jpg b/marked/Rel-16/24_series/24109/74d23510f27b21403a7be84820821863_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f23950561e0a2dae9f561613360cb4545d8e0c14 --- /dev/null +++ b/marked/Rel-16/24_series/24109/74d23510f27b21403a7be84820821863_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:91fd69fe5ddb1904a346eadbc42969e9b6c1c1ddd1cf65b207b8052130ff7db0 +size 88018 diff --git a/marked/Rel-16/24_series/24109/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/24_series/24109/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b512cb3873bb14aaeace417c6be615773a8aae5 --- /dev/null +++ b/marked/Rel-16/24_series/24109/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d463b039172be2e2d180e2ff35d6f94f4165acd72f787ab0fa892e11e7ae830 +size 25541 diff --git a/marked/Rel-16/24_series/24109/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/24_series/24109/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95d79779fc87a4d84b87899f50e3b6d410acdc7d --- /dev/null +++ b/marked/Rel-16/24_series/24109/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddf3d0ee9cc3e0fb5ad56363d38b51ada05c147714d795cc8f665ab7052da74d +size 68468 diff --git a/marked/Rel-16/24_series/24109/ddcdc1712375261ba1d89165fdf12aa6_img.jpg b/marked/Rel-16/24_series/24109/ddcdc1712375261ba1d89165fdf12aa6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2928f06419d26d70beb18bb71f6cc4f377e31ee3 --- /dev/null +++ b/marked/Rel-16/24_series/24109/ddcdc1712375261ba1d89165fdf12aa6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95e0f57a012f26b54b9014b45619c91a5ac27f4d1a01636bcc2a8487650ca8e8 +size 17851 diff --git a/marked/Rel-16/24_series/24109/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/marked/Rel-16/24_series/24109/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9fe0511768fb93417edc88c01b194b36dee4f437 --- /dev/null +++ b/marked/Rel-16/24_series/24109/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aff4b2e0f22666fbc4822e59f02cd2bd814a274363f01d10928f95b56d88cf4a +size 24935 diff --git a/marked/Rel-16/24_series/24109/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/24_series/24109/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..237c1a785309dbc83920236f749a56eccd2817ea --- /dev/null +++ b/marked/Rel-16/24_series/24109/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e17741973341d1c62308ca6cd4ca9e6b7456534c2187110acab183f1a35c0e23 +size 68123 diff --git a/marked/Rel-16/24_series/24109/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/24_series/24109/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39154e44cecc906eaafa509be23a1c12ed31b58d --- /dev/null +++ b/marked/Rel-16/24_series/24109/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcbb4fdd9a282050d5f1dc714052b505e990758cb29391c2b3d06facdf642efb +size 27290 diff --git a/marked/Rel-16/24_series/24109/raw.md b/marked/Rel-16/24_series/24109/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ff7ff0c93aa7ed7ed2c45df0d84d6fc0d5df6db2 --- /dev/null +++ b/marked/Rel-16/24_series/24109/raw.md @@ -0,0 +1,3158 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 Generic Bootstrapping Architecture; Ub interface ..... | 10 | +| 4.1 Introduction ..... | 10 | +| 4.2 Bootstrapping procedure ..... | 11 | +| 4.3 User authentication failure ..... | 12 | +| 4.4 Network authentication failure..... | 12 | +| 4.5 Synchronization failure ..... | 12 | +| 4A Generic Bootstrapping Architecture Push; Upa ..... | 12 | +| 4A.1 Introduction ..... | 12 | +| 4A.2 Bootstrapping procedure ..... | 13 | +| 4A.3 User authentication failure ..... | 14 | +| 4A.4 Network authentication failure..... | 14 | +| 4A.5 Synchronization failure ..... | 14 | +| 5 Network application function; Ua interface..... | 14 | +| 5.1 Introduction ..... | 14 | +| 5.2 HTTP Digest authentication..... | 14 | +| 5.2.1 General ..... | 14 | +| 5.2.2 Authentication procedure ..... | 15 | +| 5.2.2.1 General..... | 15 | +| 5.2.3 Authentication failures ..... | 16 | +| 5.2.4 Bootstrapping required indication ..... | 16 | +| 5.2.5 Bootstrapping renegotiation indication ..... | 16 | +| 5.2.6 Integrity protection ..... | 16 | +| 5.3 UE and NAF authentication using HTTPS ..... | 16 | +| 5.3.1 General ..... | 16 | +| 5.3.2 Shared key-based UE authentication with certificate-based NAF authentication..... | 17 | +| 5.3.2.1 Authentication procedure..... | 17 | +| 5.3.2.2 Authentication failures..... | 17 | +| 5.3.2.3 Bootstrapping required indication ..... | 18 | +| 5.3.2.4 Bootstrapping renegotiation indication..... | 18 | +| 5.3.3 Shared key-based mutual authentication between UE and NAF..... | 18 | +| 5.3.3.1 Authentication procedure..... | 18 | +| 5.3.3.2 Authentication failures..... | 19 | +| 5.3.3.3 Bootstrapping required indication ..... | 19 | +| 5.3.3.4 Bootstrapping renegotiation indication..... | 19 | +| 5.3.4 Certificate based mutual authentication between UE and application server ..... | 19 | +| 5.3.5 Integrity protection ..... | 20 | +| 6 PKI portal, Ua interface ..... | 20 | +| 6.1 Introduction ..... | 20 | +| 6.2 Subscriber certificate enrolment..... | 20 | +| 6.2.1 Enrolment procedure ..... | 20 | +| 6.2.2 WIM specific authentication code for key generation..... | 22 | +| 6.2.3 WIM specific authentication code for proof of key origin..... | 22 | +| 6.2.4 Error situations ..... | 23 | +| 6.3 CA certificate delivery ..... | 23 | +| 6.3.1 CA certificate delivery procedure..... | 24 | +| 6.3.2 Error situations ..... | 24 | +| 7 Authentication Proxy ..... | 25 | +| 7.1 Introduction ..... | 25 | + +| | | | +|--------------------------------|----------------------------------------------------------------------------------------------------|-----------| +| 7.2 | Authentication ..... | 26 | +| 7.3 | Authorization..... | 26 | +| Annex A (informative): | Signalling flows of bootstrapping procedure ..... | 27 | +| A.1 | Scope of signalling flows..... | 27 | +| A.2 | Introduction..... | 27 | +| A.2.1 | General ..... | 27 | +| A.2.2 | Key required to interpret signalling flows..... | 27 | +| A.3 | Signalling flows demonstrating a successful bootstrapping procedure ..... | 27 | +| A.4 | Signalling flows demonstrating a synchronization failure in the bootstrapping procedure..... | 31 | +| Annex A1 (informative): | Signalling flows of GBA Push procedure ..... | 34 | +| A1.1 | Scope of signalling flows..... | 34 | +| A1.2 | Introduction..... | 34 | +| A1.2.1 | General ..... | 34 | +| A1.2.2 | Key required to interpret signalling flows..... | 34 | +| A1.3 | Signalling flows demonstrating a successful GBA Push procedure ..... | 34 | +| Annex B (informative): | Signalling flows for HTTP Digest Authentication with bootstrapped security association..... | 37 | +| B.1 | Scope of signalling flows..... | 37 | +| B.2 | Introduction..... | 37 | +| B.2.1 | General ..... | 37 | +| B.2.2 | Key required to interpret signalling flows..... | 37 | +| B.3 | Signalling flows demonstrating a successful authentication procedure..... | 37 | +| Annex C (normative): | XML Schema Definition ..... | 42 | +| C.1 | Introduction..... | 42 | +| Annex D (informative): | Signalling flows for Authentication Proxy ..... | 43 | +| D.1 | Scope of signalling flows..... | 43 | +| D.2 | Introduction..... | 43 | +| D.2.1 | Key required to interpret signalling flows..... | 43 | +| D.3 | Signalling flow demonstrating a successful authentication procedure ..... | 43 | +| Annex E (informative): | Signalling flows for PKI portal ..... | 49 | +| E.1 | Scope of signalling flows..... | 49 | +| E.2 | Introduction..... | 49 | +| E.2.1 | General ..... | 49 | +| E.2.2 | Key required to interpret signalling flows..... | 49 | +| E.3 | Signalling flows demonstrating a successful subscriber certificate enrolment..... | 49 | +| E.3.1 | Simple subscriber certificate enrolment..... | 49 | +| E.3.2 | Subscriber certificate enrolment with WIM authentication codes ..... | 53 | +| E.4 | Signalling flows demonstrating a failure in subscriber certificate enrolment ..... | 60 | +| E.5 | Signalling flows demonstrating a successful CA certificate delivery..... | 60 | +| E.6 | Signalling flows demonstrating a failure in CA certificate delivery ..... | 64 | +| Annex F (informative): | Signalling flows for PSK TLS with bootstrapped security association .... | 65 | +| F.1 | Scope of signalling flows..... | 65 | + +| | | | +|-----------------------------|----------------------------------------------------------------------------------|-----------| +| F.2 | Introduction..... | 65 | +| F.2.1 | General ..... | 65 | +| F.2.2 | Key required to interpret signalling flows..... | 65 | +| F.3 | Signalling flow demonstrating a successful PSK TLS authentication procedure..... | 66 | +| Annex G (normative): | 3GPP specific extension-headers for HTTP entity-header fields..... | 68 | +| G.1 | General ..... | 68 | +| G.2 | X-3GPP-Intended-Identity extension-header..... | 68 | +| G.3 | X-3GPP-Asserted-Identity extension-header..... | 68 | +| G.4 | X-3GPP-Authorization-Flags extension-header ..... | 69 | +| Annex H (normative): | 2G GBA ..... | 69 | +| H.1 | Introduction ..... | 69 | +| H.2 | 2G GBA bootstrapping procedure..... | 69 | +| H.3 | User authentication failure ..... | 70 | +| H.4 | Network authentication failure..... | 70 | +| Annex I (normative): | GBA_Digest..... | 71 | +| I.1 | Introduction ..... | 71 | +| I.2 | GBA_Digest bootstrapping procedure ..... | 71 | +| I.3 | User authentication failure ..... | 72 | +| I.4 | Network authentication failure..... | 72 | +| Annex J (Normative): | Realization of GBA Push delivery ..... | 72 | +| J.1 | Introduction..... | 72 | +| J.2 | GPI delivery using WAP Push..... | 72 | +| J.2.1 | General ..... | 72 | +| J.2.2 | Push-NAF procedures ..... | 72 | +| J.2.3 | UE procedures ..... | 73 | +| J.2.3.1 | Reception of GPI in push message..... | 73 | +| J.3 | PDUs and parameters specific to the present document..... | 74 | +| J.3.1 | GPI envelope ..... | 74 | +| J.3.1.1 | General ..... | 74 | +| J.3.1.2 | Structure ..... | 74 | +| J.3.1.3 | GPI envelope short code values ..... | 74 | +| J.3.1.4 | IANA registration template ..... | 75 | +| Annex K (informative): | Change history..... | 76 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +x the first digit: + +- 1 presented to TSG for information; +- 2 presented to TSG for approval; +- 3 or greater indicates TSG approved document under change control. + +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document defines stage 3 for the HTTP Digest AKA [6] based implementation of Ub interface (UE-BSF), the Disposable-Ks model based implementation of Upa interface (NAF-UE) and the HTTP Digest [9] and the PSK TLS based implementation of bootstrapped security association usage over Ua interface (UE-NAF) in Generic Authentication Architecture (GAA) as specified in 3GPP TS 33.220 [1]. The purpose of the Ub interface is to create a security association between UE and BSF for further usage in GAA applications. The purpose of the Upa interface is to provide a push mechanism to create a bootstrapped security association between the UE and NAF for secure communication of pushed messages. The purpose of the Ua interface is to use the so created bootstrapped security association between UE and NAF for secure communication. + +The present document also defines stage 3 for the Authentication Proxy usage as specified in 3GPP TS 33.222 [5]. + +The present document also defines stage 3 for the subscriber certificate enrolment as specified in 3GPP TS 33.221 [4] which is one realization of the Ua interface. The subscriber certificate enrolment uses the HTTP Digest based implementation of bootstrapped security association usage to enrol a subscriber certificate and the delivery of a CA certificate. + +# --- 2 References + +The following documents contain provisions, which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 33.220: "Generic Authentication Architecture (GAA); Generic bootstrapping architecture". +- [2] 3GPP TR 33.919: "Generic Authentication Architecture (GAA); System description". +- [3] 3GPP TS 29.109: "Generic Authentication Architecture (GAA); Zh and Zn Interfaces based on the Diameter protocol; Protocol details". +- [4] 3GPP TS 33.221: "Generic Authentication Architecture (GAA); Support for Subscriber Certificates". +- [5] 3GPP TS 33.222: "Generic Authentication Architecture (GAA); Access to network application functions using Hypertext Transfer Protocol over Transport Layer Security (HTTPS)". +- [6] IETF RFC 3310: "Hypertext Transfer Protocol (HTTP) Digest Authentication Using Authentication and Key Agreement (AKA)". +- [7] 3GPP TS 23.003: "Numbering, addressing and identification". +- [8] IETF RFC 3023: "XML Media Types". +- [9] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". +- [10] IETF RFC 3548: "The Base16, Base32, and Base64 Data Encodings". +- [11] Void. +- [12] IETF RFC 2818: "HTTP over TLS". +- [13] 3GPP TS 24.228 Release 5: "Signalling flows for the IP multimedia call control based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". + +- [14] IETF RFC 2616: "Hypertext Transfer Protocol -- HTTP/1.1". +- [15] Void. +- [16] PKCS#10 v1.7: "Certification Request Syntax Standard". +- NOTE: [ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-10/pkcs-10v1\\_7.pdf](ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-10/pkcs-10v1_7.pdf) +- [17] WAP Forum: "WPKI: Wireless Application Protocol; Public Key Infrastructure Definition" +- NOTE: . +- [18] Void. +- [19] Open Mobile Alliance: "ECMAScript Crypto Object" +- NOTE: . +- [20] Open Mobile Alliance: "WPKI" +- NOTE: [http://member.openmobilealliance.org/ftp/public\\_documents/SEC/Permanent\\_documents/](http://member.openmobilealliance.org/ftp/public_documents/SEC/Permanent_documents/). +- [21] 3GPP TS 33.203: "3G security; Access security for IP-based services". +- [22] IETF RFC 2234: "Augmented BNF for Syntax Specifications: ABNF". +- [23] Void. +- [24] 3GPP TS 33.223: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push function". +- [25] 3GPP TS 33.310: "Network Domain Security (NDS); Authentication Framework (AF)". +- [26] Open Mobile Alliance Push Enabler Release v2.2: "Push Over the Air". +- NOTE: [http://www.openmobilealliance.org/Technical/release\\_program/push\\_v2\\_2.aspx](http://www.openmobilealliance.org/Technical/release_program/push_v2_2.aspx). +- [27] Open Mobile Alliance Push Enabler Release v 2.2: "Push Message Specification". +- NOTE: [http://www.openmobilealliance.org/Technical/release\\_program/push\\_v2\\_2.aspx](http://www.openmobilealliance.org/Technical/release_program/push_v2_2.aspx). +- [28] Open Mobile Alliance Device Management Enabler Release v1.2: "Enabler Release Definition for OMA Device Management". +- NOTE: [http://www.openmobilealliance.org/Technical/release\\_program/dm\\_v1\\_2.aspx](http://www.openmobilealliance.org/Technical/release_program/dm_v1_2.aspx). +- [29] 3GPP TS 33.303: "Proximity-based Services (ProSe); Security aspects". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Bootstrapping information:** set of parameters that have been established during bootstrapping procedure. The information consists of a bootstrapping transaction identifier (B-TID), key material (Ks), and a group of application specific security parameters related to the subscriber. + +**Bootstrapped security association:** association between a UE and a BSF that is established by running bootstrapping procedure between them. The association is identified by a bootstrapping transaction identifier (B-TID) and consists of bootstrapping information. + +**CA certificate:** The Certificate Authority public key is itself contained within a certificate, called a CA certificate. The CA sign all certificates that it issues with the private key that corresponds to the public key in the CA certificate. + +**Delivery of CA certificate:** procedure during which UE requests a root certificate from PKI portal, who delivers the certificate to the UE. The procedure is secured by using GBA. + +**PKI portal:** certification authority (or registration authority) operated by a cellular operator + +**Reverse proxy:** a reverse proxy is a gateway for servers, and enables one server (i.e., reverse proxy) to provide content from another server transparently, e.g., when UE's request for a particular information is received at a reverse proxy, the reverse proxy is configured to request the information from another server. The reverse proxy functionality is transparent to the UE, i.e., the UE does not know that the request is being forwarded to another server by the reverse proxy. + +**Root certificate:** a certificate that an entity explicitly trusts, typically a self-signed CA certificate + +**Subscriber certificate:** certificate issued to a subscriber + +It contains the subscriber's own public key and possibly other information such as the subscriber's identity in some form. + +**Subscriber certificate enrolment:** procedure during which UE sends certification request to PKI portal and who issues a certificate to UE. The procedure is secured by using GBA. + +**WAP Identity Module (WIM):** used in performing WTLS, TLS, and application level security functions, and especially, to store and process information needed for user identification and authentication +The WPKI may use the WIM for secure storage of certificates and keys (see 3GPP TS 33.221 [4], OMA ECMAScript [19], and OMA WPKI [20] specifications). + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 33.220 [1] apply: + +### **Temporary IP Multimedia Private Identity** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 33.223 [24] apply: + +### **Disposable-Ks model** + +### **Push-message** + +### **Push-NAF** + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|----------------------------------------| +| AKA | Authentication and Key Agreement | +| AP | Authentication Proxy | +| AS | Application Server | +| AUTN | Authentication Token | +| AUTS | Re-synchronisation Token | +| AV | Authentication Vector | +| BSF | BootStrapping Function | +| B-TID | Bootstrapping - Transaction IDentifier | +| CA | Certification Authority | +| CK | Confidentiality Key | +| DER | Distinguished Encoding Rules | +| FQDN | Fully Qualified Domain Name | +| GAA | Generic Authentication Architecture | +| GBA | Generic Bootstrapping Architecture | +| GBA_ME | ME-based GBA | +| GBA_U | GBA with UICC-based enhancements | +| GPI | GBA Push Info | +| GUSS | GBA User Security Settings | +| HSS | Home Subscriber System | +| HTTP | Hypertext Transfer Protocol | +| HTTPS | HTTP over TLS | +| IK | Integrity Key | +| IMPI | IP Multimedia Private Identity | +| IMPU | IP Multimedia PUblic identity | +| Ks | Key material | + +| | | +|--------|------------------------------------------| +| Ks_NAF | NAF specific key material | +| MAC | Message Authentication Code | +| ME | Mobile Equipment | +| NAF | Network Application Function | +| PKCS | Public-Key Cryptography Standards | +| PKI | Public Key Infrastructure | +| PSK | Pre-Shared Secret | +| RAND | RANDom challenge | +| RES | authentication Response | +| SA | Security Association | +| SQN | SeQuence Number | +| TLS | Transport Layer Security | +| TMPI | Temporary IP Multimedia Private Identity | +| UE | User Equipment | +| UICC | Universal Integrated Circuit Card | +| URI | Uniform Resource Identifier | +| URN | Uniform Resource Name | +| USIM | User Service Identity Module | +| USS | User Security Settings | +| UTC | Coordinated Universal Time | +| WIM | Wireless Identity Module | +| WPKI | Wireless PKI | +| WTLS | Wireless Transport Layer Security | +| XRES | Expected authentication response | + +# 4 Generic Bootstrapping Architecture; Ub interface + +## 4.1 Introduction + +Generic Authentication Architecture (GAA) is based on shared secrets provided by generic bootstrapping architecture (GBA). The stage 2 description of GAA framework is described in 3GPP TR 33.919 [2] and the GBA procedures in 3GPP TS 33.220 [1]. + +The GBA related to the Ub interface is between the UE and bootstrapping server function (BSF). During the bootstrapping procedure BSF also uses the Zh interface to request authentication vectors from HSS. The Zh interface is defined in 3GPP TS 29.109 [3]. The end result of the bootstrapping procedure is that both BSF and an UE have a security association in a form of a bootstrapping transaction identifier (B-TID) and key material (Ks). + +According to 3GPP TS 33.220 [1] the bootstrapping procedure shall be based on HTTP Digest AKA as described in RFC 3310 [6]. The protocol stack of the Ub interface in bootstrapping procedure is presented in figure 4.1-1. The details are defined in the following subclauses. + +![Figure 4.1-1: Protocol stack of Ub interface. The diagram shows two protocol stacks connected by a horizontal line labeled 'Ub'. The left stack (UE) has five layers: Bootstrapping application logic in UE, HTTP Digest AKA, HTTP, TCP, and IP. The right stack (BSF) has five layers: Bootstrapping application logic in BSF, HTTP Digest AKA, HTTP, TCP, and IP. The layers are aligned horizontally, and the Ub interface line connects the bottom IP layers of both stacks.](1eadbbe42cfcac5c0023577110aec5e3_img.jpg) + +| | | | +|---------------------------------------|----|----------------------------------------| +| Bootstrapping application logic in UE | | Bootstrapping application logic in BSF | +| HTTP Digest AKA | | HTTP Digest AKA | +| HTTP | | HTTP | +| TCP | | TCP | +| IP | Ub | IP | + +Figure 4.1-1: Protocol stack of Ub interface. The diagram shows two protocol stacks connected by a horizontal line labeled 'Ub'. The left stack (UE) has five layers: Bootstrapping application logic in UE, HTTP Digest AKA, HTTP, TCP, and IP. The right stack (BSF) has five layers: Bootstrapping application logic in BSF, HTTP Digest AKA, HTTP, TCP, and IP. The layers are aligned horizontally, and the Ub interface line connects the bottom IP layers of both stacks. + +**Figure 4.1-1: Protocol stack of Ub interface** + +The bootstrapping procedure described in the present document can result to different key materials depending on whether ME-based or UICC-based GBA is used. However, the bootstrapping procedure itself is the same for both ME-based GBA (GBA\_ME), and UICC-based GBA (GBA\_U). + +The bootstrapping procedure can also be based on SIM, i.e., 2G GBA. The 2G GBA bootstrapping procedure is specified in Annex H. + +The bootstrapping procedures can also be based on GBA\_Digest. The GBA\_Digest bootstrapping procedures is specified in annex I. + +## 4.2 Bootstrapping procedure + +The UE shall initiate the bootstrapping procedure when: + +- a) the UE wants to interact with a NAF and bootstrapping is required; +- b) a NAF has requested bootstrapping required indication as described in subclause 5.2.4 or bootstrapping renegotiation indication as described in subclause 5.2.5; or +- c) the lifetime of the key has expired in the UE if one or more applications are using that key. + +A UE and the BSF shall establish bootstrapped security association between them by running bootstrapping procedure. Bootstrapping security association consists of a bootstrapping transaction identifier (B-TID) and key material Ks. Bootstrapping session on the BSF also includes security related information about subscriber (e.g. user's private identity). Bootstrapping session is valid for a certain time period, and shall be deleted in the BSF when the session becomes invalid. + +Bootstrapping procedure shall be based on HTTP Digest AKA as described in 3GPP TS 33.220 [1] and in RFC 3310 [6] with the modifications described below. + +The BSF address is derived from the IMPI or IMSI according to 3GPP TS 23.003 [7]. + +A UE shall indicate to the BSF that it supports the use of TMPI as defined in 3GPP 33.220 [1] by including a "product" token in the "User-Agent" header field (cf. RFC 2616 [14]) that is set to a static string "3gpp-gba-tmpi" in HTTP requests sent to the BSF. + +A BSF shall indicate to the UE that it supports the use of TMPI as defined in 3GPP 33.220 [1] by including a "product" token in the "Server" header field (cf. RFC 2616 [14]) that is set to a static string "3gpp-gba-tmpi" in HTTP responses sent to the UE. + +In the bootstrapping procedure, Authorization, WWW-Authenticate, and Authentication-Info HTTP headers shall be used as described in RFC 3310 [6] with following exceptions: + +- a) the "realm" parameter shall contain the network name where the username is authenticated; +- b) the quality of protection ("qop") parameter shall be "auth-int"; and +- c) the "username" parameter shall contain user's private identity (IMPI). + +NOTE: If the UE does not have an ISIM application with an IMPI, the IMPI will be constructed from IMSI, according to 3GPP TS 23.003 [7]. + +In addition to RFC 3310 [6], the following apply: + +- a) In the initial request from the UE to the BSF, the UE shall include Authorization header with following parameters: + - the username directive, set to + - 1) the value of the TMPI if one has been associated with the private user identity as described in 3GPP 33.220 [1]; or + - 2) the value of the private user identity; + - the realm directive, set to the BSF address derived from the IMPI or IMSI according to 3GPP TS 23.003 [7]; + - the uri directive, set to either absoluteURL "http:///" or abs\_path "/", and which one is used is specified in RFC 2617 [9]; + - the nonce directive, set to an empty value; and + - the response directive, set to an empty value; + +- b) In the challenge response from the BSF to the UE, the BSF shall include parameters to WWW-Authenticate header as specified in RFC 3310 [6] with following clarifications: + - the realm directive, set to the BSF address derived from the IMPI or IMSI according to 3GPP TS 23.003 [7]; +- c) In the message from the BSF to the UE, the BSF shall include bootstrapping transaction identifier (B-TID) and the key lifetime to an XML document in the HTTP response payload. The BSF may also include additional server specific data to the XML document. The XML schema definition of this XML document is given in Annex C. +- d) When responding to a challenge from the BSF, the UE shall include an Authorization header containing a realm directive set to the value as received in the realm directive in the WWW-Authenticate header. +- e) Authentication-Info header shall be included into the subsequent HTTP response after the BSF concluded that the UE has been authenticated. Authentication-Info header shall include the "rspauth" parameter. + +After successful bootstrapping procedure the UE and the BSF shall contain the key material (Ks) and the B-TID. The key material shall be derived from AKA parameters as specified in 3GPP TS 33.220 [1]. In addition, BSF shall also contain a set of security specific attributes related to the UE. + +An example flow of successful bootstrapping procedure can be found in clause A.3. + +## 4.3 User authentication failure + +If the response returned by the UE is different than expected, the BSF may challenge the UE again with a new AKA challenge. After N consecutive incorrect responses from the UE, the BSF shall indicate a failure to the UE. The exact value of N is defined by local policy. + +## 4.4 Network authentication failure + +In case the UE fails at authenticating the network, the UE shall abort the bootstrapping procedure. + +## 4.5 Synchronization failure + +If the UE considers the sequence number in the challenge not to be in the correct, the UE shall send a synchronization failure indication back to the BSF as specified RFC 3310 [6]. + +An example flow can be found in clause A.4. + +# --- 4A Generic Bootstrapping Architecture Push; Upa + +## 4A.1 Introduction + +Generic Authentication Architecture (GAA) is based on shared secrets provided by generic bootstrapping architecture (GBA). The stage 2 description of GAA framework is described in 3GPP TR 33.919 [2] and the GBA-Push procedures in 3GPP TS 33.223 [24]. + +The GBA-Push related to the Upa interface is between a NAF and UE. GBA-Push is a mechanism to bootstrap the security between a NAF and a UE, without forcing the UE to contact the BSF to initiate the bootstrapping. GBA-Push is closely related to and builds upon GBA as specified in 3GPP TS 33.220 [1]. GBA-Push is intended for both GBA\_U and GBA\_ME environments. The end result of the bootstrapping procedure is that the NAF and the UE have security associations, called NAF SAs, in the form of unique identifiers for uplink and downlink references and NAF-key material as defined in 3GPP TS 33.223 [24]. The unique identifiers take the following forms: + +RAND@'naf': Identifies NAF SA in the UE (used by NAF). + +Value of P-TID: Identifies NAF SA in the NAF (used by UE). + +The GBA-Push procedure shall be based on a disposable-Ks model as described in 3GPP TS 33.223 [24]. The protocol stack of the Upa interface in GBA-Push procedure is presented in figure 4A.1-1. The details are defined in the following subclauses. + +![Figure 4A.1-1: Protocol stack of Upa interface. The diagram shows two stacked boxes representing the protocol stacks on the NAF and UE sides. Each box has two layers: 'GBA-Push application logic' at the top and 'Unspecified (e.g. SMS, MMS, SIP Message, etc)' at the bottom. A horizontal line labeled 'Upa' connects the two boxes between their unspecified layers.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +Figure 4A.1-1: Protocol stack of Upa interface. The diagram shows two stacked boxes representing the protocol stacks on the NAF and UE sides. Each box has two layers: 'GBA-Push application logic' at the top and 'Unspecified (e.g. SMS, MMS, SIP Message, etc)' at the bottom. A horizontal line labeled 'Upa' connects the two boxes between their unspecified layers. + +**Figure 4A.1-1: Protocol stack of Upa interface** + +The bootstrapping procedure described in the present document can result in different key materials depending on whether ME-based or UICC-based GBA is used. However, the bootstrapping procedure over Upa interface itself is the same for both ME-based GBA (GBA\_ME), and UICC-based GBA (GBA\_U). + +## 4A.2 Bootstrapping procedure + +The Push-NAF may initiate the bootstrapping procedure when: + +- the UE is registered for the intended service; and +- the UE does not or can not perform a bootstrapping procedure directly with the BSF. + +According to local policy, the Push-NAF may refresh the NAF SA before the expiry time of the NAF SA. + +A Push-NAF and UE shall establish the NAF SA between them by running the bootstrapping procedure. The NAF SA consists of a NAF SA identifier, NAF-key material and additional information as defined in 3GPP TS 33.223 [24]. The NAF SA is only valid for a certain time period, as determined by the NAF-key lifetime, and shall be deleted in the Push-NAF when the session expires. + +The bootstrapping procedure shall be based on disposable Ks model and GBA-Push-Info (GPI) as defined in 3GPP TS 33.223 [24]. The Push-NAF pushes the GPI to the UE. The processing of GPI is defined in 3GPP TS 33.223 [24]. + +No specific transport method is mandated for transport of the GPI from the Push-NAF to the UE. However, when using specific transport methods, the transport address shall be determined as described in table 4A.2.1. + +**Table 4A.2.1: Transport addresses for Push message from Push-NAF to UE** + +| | Transport Method | | Transport Address | +|-------------|-------------------------|------------|--------------------------| +| SMS | | MSISDN | | +| MMS | | MSISDN | | +| SIP MESSAGE | | IMPU | | +| UDP | | IP-Address | | + +Annex J specifies the protocol details when using WAP Push via SMS for the transport of the GPI from the Push-NAF to the UE. + +After a successful bootstrapping procedure and processing of the GPI, the UE and the Push-NAF have established NAF SAs as described in 3GPP TS 33.223 [24]. + +An example flow of a successful bootstrapping procedure can be found in subclause A1.3. + +## 4A.3 User authentication failure + +User authentication is not applicable to GBA Push since all messages over the Upa interface are network initiated. + +## 4A.4 Network authentication failure + +In case the UE fails to authenticate the network, the UE shall abort the bootstrapping procedure. + +## 4A.5 Synchronization failure + +A disposable Ks model is used for GBA Push in order to avoid many synchronization problems. One situation when an out-of-synch problem will appear even with the adoption of the disposable Ks model is when the BSF may erase a valid Ks while the UE keeps it due to that the GBA Push message can not be validated at the UE. This will lead to an error situation if the UE tries to use a NAF specific key (Ks\_(ext/int)\_NAF) which is derived from such a Ks. + +When this situation occurs, the Push-NAF will receive an error message from the BSF indicating that the Ks\_(ext/int)\_NAF (indicated by B-TID) is not available. The Push-NAF shall send this error message to the terminal. Upon receipt of the error message, indicating that the NAF specific key material is not available at the BSF, the UE shall perform a new bootstrap. + +# --- 5 Network application function; Ua interface + +## 5.1 Introduction + +The usage of bootstrapped security association i.e. B-TID and Ks\_NAF (or Ks\_ext\_NAF or Ks\_int\_NAF) over Ua interface depends on the application protocol used between UE and NAF. + +The Ua interface is used to supply the B-TID, generated during the bootstrapping procedure, to the network application function (NAF), and Zn interface is used by the NAF to retrieve the Ks\_NAF or Ks\_ext\_NAF or Ks\_int\_NAF from BSF. The default is the use of Ks\_(ext)\_NAF, but the usage of Ks\_int\_NAF in Ua interface is possible. The Ua interface depends on type of NAF. The Zn interface is defined in 3GPP TS 29.109 [3]. This clause describes how B-TID and Ks\_NAF or Ks\_ext\_NAF or Ks\_int\_NAF can be utilized, as specified in 3GPP TS 33.220 [1], and in the context of more specific Ua usage, as specified for deployment of HTTPS in 3GPP TS 33.222 [5], or for a PKI portal in 3GPP TS 33.221 [4]). + +## 5.2 HTTP Digest authentication + +### 5.2.1 General + +The HTTP Digest authentication model as described in RFC 2617 [9] can be used with bootstrapped security association as the authentication and integrity protection method, if the application protocol used over Ua interface between UE and NAF is based on HTTP. The HTTP Digest authentication may be used for all protocols that have adopted the HTTP authentication framework to mutually authenticate the UE and the NAF, and also optionally integrity protect any payload being transferred between them. + +The UE shall indicate to an application server (i.e. a NAF) that it supports 3GPP-bootstrapping based HTTP Digest authentication by including a "product" token to the "User-Agent" header (cf. RFC 2616 [14]) in outgoing HTTP requests. If the UE supports + +- a) AKA based authentication, then the "product" token is a static string "3gpp-gba" if the HTTP client application resides in the ME, or "3gpp-gba-uicc" if the HTTP client application resides in the UICC; or +- b) GBA\_Digest, then the "product" token is "3gpp-gba-digest". + +The UE may indicate multiple GBA modes by inserting multiple "product" tokens in the User-Agent header field. The User-Agent header field with GBA related "product" tokens shall be added to each outgoing HTTP request if the UE supports GBA-based authentication using HTTP Digest. + +Upon receiving GBA related "product" tokens, the application server if it supports NAF functionality may decide to authenticate the UE using GBA-based shared secret by executing the authentication procedure. If multiple GBA modes have been indicated in the User-Agent header field, then the NAF selects one GBA mode and indicates the selected mode in responses to the UE in the "realm" parameter of the WWW-Authenticate header field. In the selection of the GBA mode by the UE, AKA-based modes shall take priority over GBA\_Digest. + +The protocol stack of the Ua interface when HTTP Digest authentication is used is presented in figure 5.2-1. The details are defined in the following subclauses. + +![Diagram showing the protocol stack of the Ua interface between a UE and a NAF. Both stacks consist of five layers: Application logic (in the UE/NAF), HTTP Digest, HTTP (Note 1), TCP, and IP. The stacks are connected by a horizontal line labeled 'Ua' between the IP layers.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +| | | | +|--------------------------------|----|---------------------------------| +| Application logic
in the UE | | Application logic
in the NAF | +| HTTP Digest | | HTTP Digest | +| HTTP (Note 1) | | HTTP (Note 1) | +| TCP | | TCP | +| IP | Ua | IP | + +Diagram showing the protocol stack of the Ua interface between a UE and a NAF. Both stacks consist of five layers: Application logic (in the UE/NAF), HTTP Digest, HTTP (Note 1), TCP, and IP. The stacks are connected by a horizontal line labeled 'Ua' between the IP layers. + +NOTE 1: HTTP is not the only protocol that can be used. Other protocols can also be used as long as the protocol has adopted the HTTP authentication framework. + +**Figure 5.2-1: Protocol stack of Ua interface with HTTP Digest authentication** + +### 5.2.2 Authentication procedure + +#### 5.2.2.1 General + +HTTP Digest authentication [9] shall be used with previously bootstrapped security association as follows: + +- 1) the "username" parameter shall be the bootstrapping transaction identifier (B-TID); +- 2) the password used in the digest calculations shall be + - a) in case of GBA\_ME the NAF specific key material (Ks\_NAF); + - b) in case of GBA\_U the NAF specific ME based key material (Ks\_ext\_NAF) or the NAF specific UICC-based key material (Ks\_int\_NAF);and + - c) in case of GBA\_Digest the NAF specific key material (Ks\_NAF); + +NOTE 1: The NAF specific key material (Ks\_NAF or Ks\_ext\_NAF or Ks\_int\_NAF) is derived from the key material (Ks) using key derivation function as specified in 3GPP TS 33.220 [1]. + +The NAF specific key material (Ks\_NAF or Ks\_ext\_NAF or Ks\_int\_NAF) is Base64 encoded as specified in RFC 3548 [10]. + +- 3) the "realm" parameter shall contain two parts delimited by "@" sign. The first part is the constant string "3GPP-bootstrapping" (in case of a ME-based application) , "3GPP-bootstrapping-uicc" (in case of a UICC-based application) or "3GPP-bootstrapping-digest" (in case of GBA\_Digest), and the latter part shall be the FQDN of the NAF (e.g. "3GPP-bootstrapping@naf1.operator.com" or "3GPP-bootstrapping-uicc@naf1.operator.com" or "3GPP-bootstrapping-digest@naf1.operator.com"). + +In the case of GBA\_U, the NAF shall indicate to the UE which NAF specific key was selected to be used by setting the first part of the realm to "3GPP-bootstrapping" (for the ME-based key i.e. Ks\_ext\_NAF), or to "3GPP-bootstrapping-uicc" (for the UICC-based key i.e. Ks\_int\_NAF). + +Both the UE and the NAF shall verify upon receiving each of the HTTP responses and HTTP requests that the second part of the realm attribute is equal to the FQDN of the NAF. + +In the case of GBA\_U, if the HTTPS client application resides in the ME, then the application shall use only the ME-based key i.e. Ks\_ext\_NAF (the UICC-based key Ks\_int\_NAF is not available in the ME). If the NAF indicates to the ME-based HTTPS client application that only UICC-based key shall be used, the application must terminate the communication with the NAF. If the HTTP client application resides in the UICC, then the application shall use only the UICC-based key. If the NAF indicates to the UICC-based application that only ME-based key shall be used, the application must terminate the communication with the NAF. + +In the case of GBA\_U, the operator may indicate the type of the key to be used in the Ua reference point in the NAF specific USS as specified in 3GPP TS 29.109 [3]. If the NAF has requested an application specific USS, and the indication is present in the USS, the NAF shall use the indicated key type. If the type of the negotiated key is different from the type indicated in the USS, the NAF shall terminate the communication with the UE. + +An example flow of a successful HTTP Digest authentication procedure can be found in clause B.3. + +### 5.2.3 Authentication failures + +Authentication failures are handled as they are described in RFC 2617 [9]. + +### 5.2.4 Bootstrapping required indication + +NAF shall indicate to the UE that bootstrapped security association is required by sending an HTTP response with code 401 "Unauthorized" and include the WWW-Authenticate header into the response. In particular, the "realm" attribute shall contain a prefix "3GPP-bootstrapping@" or "3GPP-bootstrapping-uicc@" or "3GPP-bootstrapping-digest", and this shall trigger UE to run bootstrapping procedure over Ub interface. + +### 5.2.5 Bootstrapping renegotiation indication + +The NAF shall indicate to the UE that the existing bootstrapped security association used in the last HTTP request sent by the UE has expired and that a new bootstrapped security association is required by sending an HTTP response described in subclause 5.2.3. When the UE receives the 401 "Unauthorized" HTTP response to the HTTP request that was protected using the existing bootstrapped security association, this shall trigger the UE to run bootstrapping procedure over Ub interface. + +### 5.2.6 Integrity protection + +Integrity protection may be provided by using HTTP Digest integrity protection, i.e. quality of protection (qop) parameter is set to "auth-int". + +## 5.3 UE and NAF authentication using HTTPS + +### 5.3.1 General + +Prior to establishing HTTP, the UE and the NAF may perform authentication. Three different authentication mechanisms may be used for UE and NAF authentication: + +- Shared key-based UE authentication (HTTP Digest) with certificate-based NAF authentication (TLS); +- Shared key-based mutual authentication between UE and NAF (PSK TLS), and; +- Certificate based mutual authentication between UE and AS; + +The protocol stack of the Ua interface when TLS is used is presented in figure 5.3.1-1. and described in subclause 5.3.2. The HTTP Digest authentication is described in subclause 5.2. + +![Diagram showing the protocol stack of the Ua interface with TLS. It consists of two vertical stacks of protocol layers connected by a horizontal line labeled 'Ua'. The left stack (UE) has layers: Application logic in the UE, HTTP Digest/HTTP, TLS, TCP, and IP. The right stack (NAF) has the same layers: Application logic in the NAF, HTTP Digest/HTTP, TLS, TCP, and IP.](64fd8bd804acee34ea91bdde28997fe3_img.jpg) + +| | | | +|-----------------------------|----|------------------------------| +| Application logic in the UE | | Application logic in the NAF | +| HTTP Digest
HTTP | | HTTP Digest
HTTP | +| TLS | | TLS | +| TCP | | TCP | +| IP | Ua | IP | + +Diagram showing the protocol stack of the Ua interface with TLS. It consists of two vertical stacks of protocol layers connected by a horizontal line labeled 'Ua'. The left stack (UE) has layers: Application logic in the UE, HTTP Digest/HTTP, TLS, TCP, and IP. The right stack (NAF) has the same layers: Application logic in the NAF, HTTP Digest/HTTP, TLS, TCP, and IP. + +Figure 5.3.1-1: Protocol stack of Ua interface with TLS + +The protocol stack of the Ua interface when PSK TLS is used is presented in figure 5.3.1-2 and described in subclause 5.3.3. The HTTP Digest authentication is described in subclause 5.2. + +![Figure 5.3.1-2: Protocol stack of Ua interface with PSK TLS. The diagram shows two protocol stacks connected by a horizontal line labeled 'Ua'. The left stack (UE) has four layers: Application logic in the UE, TLS with support of PSK TLS, TCP, and IP. The right stack (NAF) has the same four layers: Application logic in the NAF, TLS with support of PSK TLS, TCP, and IP.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +| | | | +|-----------------------------|----|------------------------------| +| Application logic in the UE | | Application logic in the NAF | +| TLS with support of PSK TLS | | TLS with support of PSK TLS | +| TCP | Ua | TCP | +| IP | | IP | + +Figure 5.3.1-2: Protocol stack of Ua interface with PSK TLS. The diagram shows two protocol stacks connected by a horizontal line labeled 'Ua'. The left stack (UE) has four layers: Application logic in the UE, TLS with support of PSK TLS, TCP, and IP. The right stack (NAF) has the same four layers: Application logic in the NAF, TLS with support of PSK TLS, TCP, and IP. + +**Figure 5.3.1-2: Protocol stack of Ua interface with PSK TLS** + +### 5.3.2 Shared key-based UE authentication with certificate-based NAF authentication + +#### 5.3.2.1 Authentication procedure + +The authentication mechanism described in this section for ME-based application is mandatory to implement in the ME and optional to implement in the NAF. + +The authentication mechanism described in this section for UICC-based application is optional to implement in the UICC and the NAF. + +The UE and the NAF shall support the TLS version as specified in annex E of 3GPP TS 33.310 [25]. See chapter 5.3.1 in TS 33.222 [5] for the detailed profiling of TLS. + +- When the UE starts communication via Ua reference point with the NAF, it shall establish a TLS tunnel with the NAF. The NAF is authenticated to the UE by means of a public key certificate. The UE shall verify that the server certificate corresponds to the FQDN of the NAF it established the tunnel with. No client authentication is performed as part of TLS (no client certificate necessary). +- The UE sends an HTTP request to the NAF inside the TLS tunnel (HTTPS, i.e. HTTP over TLS) as described in chapter 5.2. +- The NAF shall authenticate the HTTP request using HTTP Digest as specified in subclause 5.2. + +#### 5.3.2.2 Authentication failures + +Server authentication failures are handled in TLS as they are described in the RFC for TLS which is defined in annex E of 3GPP TS 33.310 [25]. Client authentication failures are handled in HTTP Digest as they are described in RFC 2617 [9]. + +#### 5.3.2.3 Bootstrapping required indication + +Bootstrapping required indication is done on HTTP Digest and therefore described in subclause 5.2.4. + +#### 5.3.2.4 Bootstrapping renegotiation indication + +Bootstrapping renegotiation indication is done on HTTP Digest and therefore described in subclause 5.2.5. + +### 5.3.3 Shared key-based mutual authentication between UE and NAF + +#### 5.3.3.1 Authentication procedure + +The authentication mechanism described in this section for ME-based application is optional to implement in the ME and the NAF. + +The authentication mechanism described in this section for UICC-based application is optional to implement in the UICC and the NAF. + +The Pre-Shared Key Ciphersuites for TLS (PSK TLS) may be used with bootstrapped security association as the authentication, confidentiality, and integrity protection method. The profile for TLS and TLS Extensions to be used together with PSK TLS is defined in annex E of 3GPP TS 33.310 [25]. + +The PSK TLS handshake shall be used with bootstrapped security association as follows: + +- the ClientHello message shall contain one or more PSK-based ciphersuites; +- the ClientHello message shall contain the server\_name TLS extension and it shall contain the hostname of the NAF; +- the ServerHello message shall contain a PSK-based ciphersuite selected by the NAF; +- the ServerKeyExchange shall be sent by the server and it shall contain the psk\_identity\_hint field and it shall contain the static string "3GPP-bootstrapping" or "3GPP-bootstrapping-uicc" or "3GPP-bootstrapping-digest". If several authentication methods are supported then the ServerKeyExchange message shall include the PSK-identity hints for all allowed authentication methods, separated by semi-colon ";" (e.g., "3GPP-bootstrapping;3GPP-bootstrapping-uicc"). + +In the case of GBA\_U, the NAF shall indicate to the UE which NAF specific key can be used by setting the psk\_identity\_hint to "3GPP-bootstrapping" (for the ME-based key i.e. Ks\_ext\_NAF), or to "3GPP-bootstrapping-uicc" (for the UICC-based key i.e. Ks\_int\_NAF). If the NAF allows both types of keys to be used then the psk\_identity\_hint field shall contain both hints separated by semi-colon ";". + +In addition, the NAF may include an indication to use a BSF address different from the one specified in 3GPP TS 23.003 [7] in the psk\_identity\_hint field of the ServerKeyExchange message. The indication to use the different BSF address shall contain a prefix "3GPP bootstrapping-BSF-address", a separator character ":" and the FQDN of the BSF. The NAF may only include this indication for an application specified to support this functionality (e.g. Proximity-based Services, see 3GPP TS 33.303 [29]) and if it is included then the static strings "3GPP bootstrapping" shall be included. + +The psk\_identity\_hint field may contain a list of psk\_identity\_hints and are separated by a semi-colon character (";") (see NOTE 1); + +NOTE 1: Other psk identity name spaces than "3GPP-bootstrapping" or "3GPP-bootstrapping-uicc" can be supported, however, they are out of the scope of this specification. + +- the ClientKeyExchange shall contain the psk\_identity field and it shall contain a prefix "3GPP-bootstrapping" or "3GPP-bootstrapping-uicc" or "3GPP-bootstrapping-digest" indicating the selected psk identity name space, a separator character ";" and the B-TID. In the selection of the GBA mode by the UE, AKA-based modes shall take priority over GBA\_Digest.; +- if the PSK TLS client resides in the ME, the UE shall derive the TLS premaster secret from the NAF specific key material i.e. Ks\_NAF in the case of GBA\_ME. For GBA\_U the UE shall derive the TLS premaster secret from the ME-based key material i.e. Ks\_ext\_NAF; +- if the PSK TLS client resides in the UICC, the UE shall derive the TLS premaster secret from the NAF specific UICC-based key material i.e. Ks\_int\_NAF; +- if the indication to use a different BSF address was included in the psk\_identity\_hint field of the ServerKeyExchange message, the ME shall derive the TLS premaster secret from a Ks\_NAF resulting from a GBA\_ME bootstrapping with the indicated BSF and shall use the prefix "3GPP bootstrapping" in the psk\_identity field of the ClientKeyExchange message. + +NOTE 2: A GBA\_U capable NAF indicates to the UE the type of the authorized NAF specific key (i.e. Ks\_ext\_NAF or Ks\_int\_NAF or both). The details of the key decision mechanism in the NAF are specified in 3GPP TS 29.109 [3]. + +In the case of GBA\_U, if the HTTPS client application resides in the ME then the application shall use only the ME-based key i.e. Ks\_ext\_NAF (the UICC-based key Ks\_int\_NAF is not available in the ME). If a NAF indicates to a ME-based HTTPS client application that the UICC-based key shall be used then the application must terminate the communication with this NAF. If a HTTPS client application resides in the UICC, then the application shall only use the UICC-based key. If the NAF indicates to the UICC-based application that only the ME-based key can be used then the application must terminate the communication with the NAF. + +In the case of GBA\_U, the operator may indicate the type of the key to be used in the Ua reference point in the NAF specific USS as specified in 3GPP TS 29.109 [3]. If the NAF has requested an application specific USS, and the indication is present in the USS, the NAF shall use the indicated key type. If the type of the negotiated key is different from the type indicated in the USS, the NAF shall terminate the communication with the UE. + +An example flow of the PSK TLS procedure can be found in clause F.3. + +#### 5.3.3.2 Authentication failures + +Authentication failures are handled as they are described in the profile for TLS specified in annex E of 3GPP TS 33.310 [25]. + +#### 5.3.3.3 Bootstrapping required indication + +During TLS handshake, the NAF shall indicate to the UE that bootstrapped security association is required by sending a ServerHello message containing a PSK-based ciphersuite, and a ServerKeyExchange message containing the psk\_identity\_hint field, which contains a static string "3GPP-bootstrapping" or "3GPP-bootstrapping-uicc" or "3GPP-bootstrapping-digest". This shall trigger the UE to run the bootstrapping procedure over Ub interface. + +NOTE: The NAF shall select a PSK-based ciphersuite only if the UE has offered one or more PSK-based ciphersuites in the corresponding ClientHello message. + +#### 5.3.3.4 Bootstrapping renegotiation indication + +During usage of TLS session, the NAF shall indicate to the UE that bootstrapped security association has expired by sending close\_notify alert message to the UE. The UE may attempt resume the old TLS session by sending a ClientHello message containing the old session ID. The NAF shall refuse to use the old session ID by sending a ServerHello message with a new session ID. This will indicate to the UE that the bootstrapped security association it used has expired. + +During TLS handshake, the NAF shall indicate to the UE that the bootstrapped security association has expired by sending handshake\_failure message as a response to the Finished message sent by the UE. This will indicate to the UE that the bootstrapped security association it used has expired. + +### 5.3.4 Certificate based mutual authentication between UE and application server + +The authentication mechanism described in this clause is optional to implement in the UE and in the application server. + +The certificate based mutual authentication between an UE and an application server shall be based on TLS and TLS Extensions. The profile for TLS and TLS Extensions is defined in annex E of 3GPP TS 33.310 [25]. + +Annex B in TS 33.222 [5] provides guidance on certificate mutual authentication between UE and application server. + +### 5.3.5 Integrity protection + +Integrity protection is provided by using authenticated TLS tunnel as described in RFC 2818 [12]. + +# --- 6 PKI portal, Ua interface + +## 6.1 Introduction + +3GPP TS 33.221 [4] specifies the enrolment of subscriber certificates and the delivery of CA certificates to the UE. The TS specifies that the authentication of these procedures be based on bootstrapping procedure and more generally on the HTTP Digest authentication as described in subclause 5.2 of the present document. + +## 6.2 Subscriber certificate enrolment + +The subscriber certificate enrolment procedure contains the following requests: + +- an enrolment request in the form of PKCS#10 [16]; + +- an optional request for WIM specific authentication code for key generation [19]; and +- an optional request for WIM specific authentication code for proof of key origin [19]. + +Respectively, the subscriber certificate enrolment procedure contains the following responses: + +- a subscriber certificate; and +- a WIM specific authentication code [19]. + +NOTE: The on board key generation and the generation of the proof of key origin requires a WIM specific authentication code. Whether it is, is decided by the issuer of the WIM card. + +### 6.2.1 Enrolment procedure + +The UE shall generate a PKCS#10 certification request [16] according to 3GPP TS 33.221 [4]. The UE shall send the PKCS#10 certification request to the PKI portal in the HTTP payload in a HTTP POST request. The Request-URI shall indicate the desired response type. Upon successful enrolment, PKI portal shall return the enrolled subscriber certificate in the desired format. + +The UE populates the HTTP POST request as follows: + +- the HTTP version shall be 1.1 which is specified in RFC 2616 [14]; +- the base of the Request-URI is extracted from the full PKI portal URI (e.g. if the full PKI portal URI is "" then the Request-URI shall be "/enrol". + +NOTE 1: In case a proxy is used between the UE and the PKI portal, then the full Request-URI will be used in the HTTP Post request. + +- the Request-URI shall contain an URI parameter "response" that shall be set to "single", "pointer", or "chain" depending on the UE's desired response type (e.g. Request-URI may take the form of "/enrol?response=single" for certificate delivery); + +NOTE 2: The PKI portal might ignore the UE's desired response type, and the UE should be capable of receiving the issued subscriber certificate in any of the response types. + +- the UE may add additional URI parameters to the Request-URI; + +NOTE 3: The PKI portal might ignore the additional URI parameters. + +- the HTTP header Content-Type shall be "application/x-pkcs10"; +- the HTTP header Content-Length shall be the length of the Base64 encoded PKCS#10 certification request in Octets; and +- the HTTP payload shall contain the Base64 encoded PKCS#10 certification request and optionally surrounded by "----- BEGIN CERTIFICATE REQUEST -----" and "----- END CERTIFICATE REQUEST -----" tags; +- the UE may add additional HTTP headers to the HTTP POST request. + +The UE sends the HTTP POST request to the PKI portal. The PKI portal checks that the HTTP request is valid, and extracts the Base64 encoded PKCS#10 certification request for further processing. The PKI portal shall verify that the subscriber is authorized to receive the particular type of certificate by checking subscriber's user security settings received from the BSF as specified 3GPP TS 33.220 [1]. + +Upon successful subscriber certificate creation procedure, the PKI portal shall return the subscriber certificate to the UE in the UE's desired format or in the PKI portal's desired format. + +The response format type shall be one of the following: + +- the subscriber certificate itself (i.e. desired response type was "single"); +- a pointer to the subscriber certificate (i.e. desired response type was "pointer"); or +- a certificate chain that contains full certification chain from subscriber certificate to the root certificate (i.e. desired response type was "chain"). + +If response format type is "single", the PKI portal shall populate HTTP response as follows: + +- the HTTP status code shall be 200; +- the HTTP header Content-Type shall be "application/x-x509-user-cert"; +- the HTTP header Content-Length shall be the length of the HTTP payload in octets; +- the HTTP payload shall contain the Base64 encoded subscriber certificate and optionally surrounded by "----- BEGIN CERTIFICATE ----- " and "----- END CERTIFICATE ----- " tags; +- the PKI portal may add additional HTTP headers to the HTTP response. + +If response format type is "pointer", the PKI portal shall populate HTTP response as follows: + +- the HTTP status code shall be 200; +- the HTTP header Content-Type shall be "application/vnd.wap.cert-response"; +- the HTTP header Content-Length shall be the length of the HTTP payload in octets; +- the HTTP payload shall contain the Base64 encoded CertResponse structure and optionally surrounded by "----- BEGIN CERTIFICATE RESPONSE ----- " and "----- END CERTIFICATE RESPONSE ----- " tags; +- the PKI portal may add additional HTTP headers to the HTTP response. + +If response format type is "chain", the PKI portal shall populate HTTP response as follows: + +- the HTTP status code shall be 200; +- the HTTP header Content-Type shall be "application/pkix-pkipath"; +- the HTTP header Content-Length shall be the length of the HTTP payload in octets; +- the HTTP payload shall contain the Base64 encoded PkiPath structure; +- the PKI portal may add additional HTTP headers to the HTTP response. + +The PKI portal shall send the HTTP response to the UE. The UE shall check that the HTTP response is valid, and extract the Base64 encoded subscriber certificate, pointer to the subscriber certificate, or certificate chain for further processing. + +An example flow of a successful subscriber certificate enrolment procedure can be found in clause E.3. + +### 6.2.2 WIM specific authentication code for key generation + +The UE may be equipped with a WIM which may require an authentication code from WIM provider in order to generate a key onboard WIM as specified in OMA ECMAScript [19] and OMA WPKI [20] specifications. In this case, the UE shall request the authentication code from PKI portal using a HTTP GET request. If the PKI portal can acquire authentication code, it is returned to the UE in the corresponding HTTP response. + +The UE populates the HTTP GET request as follows: + +- the HTTP version shall be 1.1 which is specified in RFC 2616 [14]; +- the base of the Request-URI is extracted from the full PKI portal URI and appended with "/wim-auth-code" (e.g. if the full PKI portal URI is "http://pki-portal.operator.com/enrol" then the Request-URI shall be "/enrol/wim-auth-code"); +- the Request-URI shall contain an URI parameter "request" that shall be set to the return value received from the WIM; + +NOTE 1: If an authentication code is required, the WIM will return "error:AuthReq:cardSerialNumber:Challenge". The cardSerialNumber and the Challenge are in a hexadecimal format as specified in OMA ECMAScript specification [19]. + +- the UE may add additional URI parameters to the Request-URI; + +- the UE may add additional HTTP headers to the HTTP GET request. + +The UE sends the HTTP GET request to the PKI portal. The PKI portal acknowledges that this is an authentication code because the Request-URI contains the "/wim-auth-code" and the URI parameter "request". The PKI portal extracts the authentication code derivation parameters from the URI parameter "request", and derives the authentication code. + +NOTE 2: The actual derivation of the authentication code is outside the scope. + +Upon successful authentication code derivation, the PKI portal shall return the authentication code to the UE in a HTTP response: + +- the HTTP status code shall be 200; +- the HTTP header Content-Type shall be "text/plain"; +- the HTTP header Content-Length shall be the length of the HTTP payload in octets; +- the HTTP payload shall contain the authentication code in a hexadecimal format; +- the PKI portal may add additional HTTP headers to the HTTP response. + +Upon receiving the authentication code from the PKI portal, the UE shall use it to authenticate the procedure of generating the key onboard the WIM. + +### 6.2.3 WIM specific authentication code for proof of key origin + +The UE may be equipped with a WIM which may require an authentication code from WIM provider in order to generate a proof of key origin onboard WIM as specified in OMA ECMAScript [19] and OMA WPKI [20] specifications. In this case, the UE shall request the authentication code from PKI portal using a HTTP GET request. If the PKI portal can acquire authentication code, it is returned to the UE in the corresponding HTTP response. + +The procedure to obtain the authentication code for the generation of proof of key origin onboard WIM is the same as for the key generation, and is described in subclause D.2.1. + +Upon receiving the authentication code from the PKI portal, the UE shall use it to authenticate the procedure generating the proof of key origin onboard the WIM. + +### 6.2.4 Error situations + +Subscriber certificate enrolment may not be successful for multiple reasons. The error cases are indicated by using 4xx and 5xx HTTP Status Codes as defined in RFC 2616 [14]. The 4xx status code indicates that the UE seems to have erred, and the 5xx status code indicates that the PKI portal is aware that it has erred. Possible error situations during subscriber certificate enrolment and their mappings to HTTP Status Codes are described in table 6.2.4-1. + +NOTE: On the table 6.2.4-1, the "Description" column describes the error situation in PKI portal. The "PKI portal error" column describes the typical reason for the error. + +An example flow of a failure in subscriber certificate enrolment procedure can be found in clause E.4. + +**Table 6.2.4-1: HTTP Status Codes used for enrolment error** + +| HTTP Status Code | HTTP Error | UE should repeat the request | Description | PKI portal error | +|------------------|------------------|------------------------------|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 400 | Bad Request | No | Request could not be understood | PKCS#10 request was missing, or malformed | +| 401 | Unauthorized | Yes | Request requires authentication (cf. subclause 5.2) | Authentication pending, cf. subclause 5.2 | +| 402 | Payment Required | No | Reserved for future use | - | +| 403 | Forbidden | No | PKI portal understood the request, but is refusing to fulfil it | PKCS#10 request was valid, but subscriber is not allowed to enrol this particular type of certificates or PKCS#10 request contained unacceptable parameters | + +| HTTP Status Code | HTTP Error | UE should repeat the request | Description | PKI portal error | +|------------------|-------------------------------|------------------------------|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| 404 | Not Found | No | PKI portal has not found anything matching the Request-URI | The Request-URI was malformed and PKI portal cannot fulfil the enrolment request | +| 405 to 406 | * | No | Not used by PKI portal | - | +| 407 | Proxy Authentication Required | Yes | PKI portal uses Authentication Proxy and UE shall authenticate itself with the proxy | Authentication Proxy authentication pending, cf. subclause 5.2 | +| 408 to 417 | * | No | PKI portal should not use these status codes | - | +| 500 | Internal Server Error | No | PKI portal encountered an unexpected error | PKI portal is mis-configured | +| 501 | Not Implemented | No | PKI portal does not support the required functionality | The server does not contain PKI portal service | +| 502 | Bad Gateway | No | Gateway/Proxy received an invalid response from PKI portal | PKI portal is behind a gateway/proxy and sent an invalid response to the gateway/proxy | +| 503 | Service Unavailable | Yes | PKI portal service is currently unavailable | PKI portal is temporarily unavailable, UE may repeat the request after delay indicated by "Retry-After" header | +| 504 | Gateway Timeout | No | Gateway/Proxy did not receive a timely response from the upstream server | PKI portal is behind a gateway/proxy and did not send a response to the gateway/proxy in time, or was not reachable by the gateway/proxy | +| 505 | HTTP Version Not Supported | No | PKI portal does not support the HTTP protocol version that was used in the request line | UE should use HTTP/1.1 version with PKI portal | + +## 6.3 CA certificate delivery + +The root certificate delivery procedure contains the following request: + +- a CA certificate delivery request; + +and the corresponding response: + +- the CA certificate. + +### 6.3.1 CA certificate delivery procedure + +The UE shall populate the HTTP GET request as follows: + +- the HTTP version shall be 1.1 which is specified in RFC 2616 [14]; +- the base of the Request-URI is extracted from the full PKI portal URI (e.g. if the full PKI portal URI is "" then the Request-URI shall be "/getcertificate"). + +NOTE 1: In case a proxy is used between the UE and the PKI portal, then the full Request-URI will be used in the HTTP Post request. + +- the Request-URI shall contain an URI parameter "in" that shall be the Base64 encoding of the DER encoded Issuer field of the X.509 certificate; +- the Request-URI may contain an URI parameter "ki" that shall be the Base64 encoding of the DER encoded the Key Identifier of the X.509 certificate; + +NOTE 2: Key Identifier of the CA certificate can be obtained from the Authority Key Identifier extension of the subscriber certificate. + +- the UE may add additional URI parameters to the Request-URI; + +- the UE may add additional HTTP headers to the HTTP GET request. + +The UE sends the HTTP GET request to the PKI portal. The PKI portal checks that the HTTP request is valid, and extracts the "in" parameter and optionally "ki" parameter from the Request-URI. If the PKI portal can verify that the Issuer field parameter is valid, and that the UE may set the CA certificate as a root certificate (i.e. trusted CA certificate), it will then send the CA certificate back to the UE in the corresponding HTTP response. + +The PKI portal shall populate the HTTP response as follows: + +- the HTTP status code shall be 200; +- the HTTP header Content-Type shall be "application/x-x509-ca-cert"; +- the HTTP header Content-Length shall be the length of the HTTP payload in octets; +- the HTTP payload shall contain the Base64 encoded CA certificate structure and optionally surrounded by "----- BEGIN CERTIFICATE -----" and "----- END CERTIFICATE -----" tags; +- the PKI portal may add additional HTTP headers to the HTTP response. + +The PKI portal shall send the HTTP response to the UE. The UE shall check that the HTTP response is valid, and extract the Base64 encoded CA certificate for further processing. UE shall validate and match the received CA certificate against the parameters supplied in the corresponding request. + +An example flow of CA certificate procedure can be found in clause E.5. + +### 6.3.2 Error situations + +CA certificate delivery may not be successful for multiple reasons. The error cases are indicated by using 4xx and 5xx HTTP Status Codes as defined in RFC 2616 [14]. The 4xx status code indicates that the UE seems to have erred, and the 5xx status codes indicate that the PKI portal is aware that it has erred. Possible error situations during CA certificate delivery and their mappings to HTTP Status Codes are described in table 6.3.2-1. + +NOTE: On the table 6.3.2-1, the "Description" column describes the error situation in PKI portal. The "PKI portal error" column describes the typical reason for the error. + +An example flow of a failure in CA certificate delivery procedure can be found in clause E.6. + +**Table 6.3.2-1: HTTP Status Codes for CA certificate delivery error** + +| HTTP Status Code | HTTP Error | UE should repeat the request | Description | PKI portal error | +|-------------------------|-------------------------------|-------------------------------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| 400 | Bad Request | No | Request could not be understood | Request could not be understood | +| 401 | Unauthorized | Yes | Request requires authentication (cf. subclause 5.2) | Authentication pending, cf. subclause 5.2 | +| 402 | Payment Required | No | Reserved for future use | - | +| 403 | Forbidden | No | PKI portal understood the request, but is refusing to fulfil it | CA certificate delivery request was understood but PKI portal refuses to deliver the CA certificate | +| 404 | Not Found | No | PKI portal has not found anything matching the Request-URI | PKI portal does not have the requested CA certificate | +| 405 to 406 | * | No | Not used by PKI portal | - | +| 407 | Proxy Authentication Required | Yes | PKI portal uses Authentication Proxy and UE shall authenticate itself with the proxy | Authentication Proxy authentication pending, cf. subclause 5.2 | +| 408 to 417 | * | No | PKI portal should not use these status codes | - | +| 500 | Internal Server Error | No | PKI portal encountered an unexpected error | PKI portal is mis-configured | +| 501 | Not Implemented | No | PKI portal does not support the required functionality | The server does not contain PKI portal service | +| 502 | Bad Gateway | No | Gateway/Proxy received an invalid response from PKI portal | PKI portal is behind a gateway/proxy and sent an invalid response to the gateway/proxy | +| 503 | Service Unavailable | Yes | PKI portal service is currently unavailable | PKI portal is temporarily unavailable, UE may repeat the request after delay indicated by "Retry-After" header | +| 504 | Gateway Timeout | No | Gateway/Proxy did not receive a timely response from the upstream server | PKI portal is behind a gateway/proxy and did not send a response to the gateway/proxy in time, or was not reachable by the gateway/proxy | +| 505 | HTTP Version Not Supported | No | PKI portal does not support the HTTP protocol version that was used in the request line. | UE should use HTTP/1.1 version with PKI portal | + +# 7 Authentication Proxy + +## 7.1 Introduction + +The use of authentication proxy (AP) is specified in 3GPP TS 33.222 [5]. The AP in GAA is used to separate the GAA specific authentication procedure and the Application Server (AS) specific application logic to different logical entities. The AP is configured as a HTTP reverse proxy, i.e. the FQDN of the AS is configured to the AP such a way that the IP traffic intended to the AS is directed to the AP by the network. The AP performs the GAA authentication of the UE. After the GAA authentication procedure has been successfully completed, the AP assumes the typical role of a reverse proxy, i.e. the AP forwards HTTP requests originating from the UE to the correct AS, and returns the corresponding HTTP responses from the AS to the originating UE. + +## 7.2 Authentication + +The authentication of the UE shall be based on GAA as specified in clause 5. + +The AP shall remove the "Authorization" header from the HTTP requests that are forwarded from the UE to the AS. The AP shall add the "Authentication-Info" header to the HTTP responses that are forwarded to the UE from the AS. + +The UE may indicate the user identity intended to be used with the AS by adding a HTTP header to the outgoing HTTP requests. The HTTP header name shall be "X-3GPP-Intended-Identity" and it shall contain the user identity surrounded by quotation marks ("). If the HTTP header has been added, the AP may verify that the user identity belongs to the subscriber. In case the AP supports this check of the user identity then it shall be performed dependant on the subscriber's application specific or AP specific user security settings. + +## 7.3 Authorization + +The AP shall be able to decide whether particular subscriber, i.e. the UE, is authorized to access a particular AS. The granularity of the authorization procedures is specified in 3GPP TS 33.222 [5]. + +The AP may indicate an asserted identity or a list of identities to the AS by adding a HTTP header to the HTTP requests coming from the UE and forwarded to the AS. The HTTP header name shall be "X-3GPP-Asserted-Identity" and it shall contain a list of identities separated by comma (,) and each identity is surrounded by quotation marks ("). Whether the AP supports this handling of an asserted identity or a list of identities then it shall depend on local policy in the AP. In addition the subscriber's application specific or AP specific user security settings may be considered. + +The AP may indicate an authorization flag or a list of authorization flags from the application specific user security settings (USS) to the AS by adding a HTTP header to the HTTP requests coming from the UE and forwarded to the AS. The HTTP header name shall be "X-3GPP-Authorization-Flags" and it shall contain a list of authorization flags separated by comma (,) and each authorization flag is surrounded by quotation marks ("). In case the AP supports this handling of authorization flags from USS then it shall depend on local policy in the AP. + +# --- Annex A (informative): Signalling flows of bootstrapping procedure + +## A.1 Scope of signalling flows + +This annex gives examples of signalling flows for bootstrapping procedure. + +## --- A.2 Introduction + +### A.2.1 General + +Bootstrapping procedure is executed in order to establish bootstrapped security association, i.e. bootstrapping session between an UE and the BSF. + +The bootstrapping session is used between a UE and a NAF. An example usage of it is described in annex B. + +### A.2.2 Key required to interpret signalling flows + +3GPP TS 24.228 [13], subclause 4.1.1, specifies the key required to interpret the contents of the SIP methods. This key is used with HTTP based messages (cf. RFC 2616 [14]) as well since SIP and HTTP messages resemble each other in structure. The following key rules are used in addition to those specified in 3GPP TS 24.228 [13]: + +- a) The HTTP based messaging is always initiated by the client: + - HTTP request is generated by the client (i.e. UE); + - HTTP response is generated by the server as a response to the HTTP request; + - HTTP proxies may be between the client and the server. +- b) There is only one single HTTP response to the HTTP request. +- c) In order to differentiate between HTTP messages and other protocol messages, the HTTP messages are marked with simple arrow line, and all *non-HTTP* messages with block arrows. +- d) The flows show the signalling exchanges between the following functional entities in addition to those specified in 3GPP TS 24.228 [13]: + - Bootstrapping Server Function (BSF); + - Network Application Function (NAF); + - PKI portal (PKI portal). +- e) The "(B-TID)" sequence of characters is used to indicate that the bootstrapping transaction identifier (B-TID) needs to be filled in. + +## --- A.3 Signalling flows demonstrating a successful bootstrapping procedure + +The overall bootstrapping procedure in successful case is presented in figure A.3-1. The bootstrapping Zh interface performs the retrieval of an authentication vector by BSF from the HSS. The procedure corresponds to the step 2 in figure A.3-1. + +This clause specifies in detail the format of the bootstrapping procedure that is further utilized by various applications. It contains the AKA authentication procedure with BSF, and later the bootstrapping key material generation procedure. + +![Sequence diagram of bootstrapping signalling between UE, BSF, and HSS.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant UE + participant BSF + participant HSS + UE->>BSF: 1. initial GET + BSF->>HSS: 2. Zh interface + Note right of BSF: 3. Authentication vector selection + BSF->>UE: 4. 401 Unauthorized + Note left of UE: 5. Generation of response and session keys + UE->>BSF: 6. GET + Note right of BSF: 7. Authentication and generation of bootstrapping key material + BSF->>UE: 8. 200 OK + Note left of UE: 9. Generation of bootstrapping key material + +``` + +The diagram illustrates the bootstrapping signalling process between a User Equipment (UE), a Bootstrapping Server Function (BSF), and a Home Subscriber Server (HSS). The sequence of messages is as follows: + + +- The UE sends an 'initial GET' request to the BSF. +- The BSF communicates with the HSS via the 'Zh interface'. +- The BSF performs 'Authentication vector selection'. +- The BSF responds to the UE with a '401 Unauthorized' message. +- The UE performs 'Generation of response and session keys'. +- The UE sends a second 'GET' request to the BSF. +- The BSF performs 'Authentication and generation of bootstrapping key material'. +- The BSF responds to the UE with a '200 OK' message. +- The UE performs 'Generation of bootstrapping key material'. + +Sequence diagram of bootstrapping signalling between UE, BSF, and HSS. + +**Figure A.3-1: Bootstrapping signalling** + +### **1. Initial GET request (UE to BSF) - see example in table A.3-1** + +The purpose of this message is to initiate bootstrapping procedure between the UE and BSF. The UE sends an HTTP request containing the private user identity towards its home BSF. + +**Table A.3-1: Initial GET request (UE to BSF)** + +``` + +GET / HTTP/1.1 +Host: bsf.home1.net:80 +User-Agent: Bootstrapping Client Agent; Release-6; 3gpp-gba-tmpi +Date: Thu, 08 Jan 2004 10:13:17 GMT +Accept: */* +Authorization: Digest + username="user1_private@home1.net", + realm="bsf.home1.net", + nonce="", + uri="/", + response="" + +``` + +**Request-URI:** The Request-URI (the URI that follows the method name, "GET", in the first line) indicates the resource indication of this GET request. For bootstrapping server, this is by default "/". + +- Host:** Specifies the Internet host and port number of the BSF server, derived from the private user identity or IMSI according to 3GPP TS 23.003 [7], or obtained from the original URI given by referring resource. The port number to be used with Ub reference point is the default port of HTTP, i.e. 80. +- User-Agent:** Contains information about the user agent originating the request. +- Date:** Represents the date and time at which the message was originated. +- Accept:** Media types which are acceptable for the response. +- Authorization:** It carries authentication information. The private user identity (user1\_private@home1.net) is carried in the username field of the Digest AKA protocol. The "uri" parameter (directive) contains the same value as the Request-URI. The "realm" parameter (directive) contains the network name where the username is authenticated. The Host and the "realm" parameter (directive) value are obtained from the same field in the USIM and therefore, are identical. In this example, it is assumed that a new UICC card was just inserted into the terminal, and there is no other cached information to send. Therefore, "nonce" and "response" parameters (directives) are empty. + +### 2. Zh: Authentication procedure + +BSF retrieves the corresponding AVs from the HSS. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table A.3-2: BSF authentication information procedure (BSF to HSS)** + +| Message source and destination | Zh Information element name | Information Source in GET | Description | +|--------------------------------|-----------------------------|---------------------------|-----------------------------------------------------------------------------------------------------| +| BSF to HSS | Private User Identity | Authorization: | The Private User Identity is encoded in the username field according to the Authorization protocol. | + +### 3. Authentication vector selection + +The BSF selects an authentication vector for use in the authentication challenge. For detailed description of the authentication vector, see 3GPP TS 33.220 [1]. + +NOTE 1: The authentication vector can be of the form as in 3GPP TS 33.203 [21] (if IMS AKA is the selected authentication scheme): + +- $AV = RAND_n || AUTN_n || XRES_n || CK_n || IK_n$ where: + - RAND: random number used to generate the XRES, CK, IK, and part of the AUTN. It is also used to generate the RES at the UE. + - AUTN: Authentication token (including MAC and SQN); 128 bit value generated by the HSS. + - XRES: Expected (correct) result from the UE. + - CK: Cipher key (optional). + - IK: Integrity key. + +### 4. 401 Unauthorized response (BSF to UE) - see example in table A.3-3 + +BSF forwards the challenge to the UE in HTTP 401 Unauthorized response (without the CK, IK and XRES). This is to demand the UE to authenticate itself. The challenge contains RAND and AUTN that are populated in nonce field according to RFC 3310 [6]. + +**Table A.3-3: 401 Unauthorized response (BSF to UE)** + +``` + +HTTP/1.1 401 Unauthorized +Server: Bootstrapping Server; Release-6 +Date: Thu, 08 Jan 2004 10:13:17 GMT +WWW-Authenticate: Digest + realm="bsf.home1.net", + nonce= base64 (RAND + AUTN + server specific data), + algorithm=AKAv1-MD5, + qop="auth-int", + opaque="5ccc069c403ebaf9f0171e9517f30e41" + +``` + +**Server:** Contains information about the software used by the origin server (BSF). + +**Date:** Represents the date and time at which the message was originated. + +**WWW-Authenticate:** The BSF challenges the user. The nonce includes the quoted string, base64 encoded value of the concatenation of the AKA RAND, AKA AUTN and server specific data. + +NOTE 2: The actual nonce value in the WWW-Authenticate header field is encoded in base64, and it can look like: + nonce="A34Cm+Fva37UYWpGNB34JP". + +### 5. Generation of response and session keys at UE + +Upon receiving the Unauthorized response, the UE extracts the MAC and the SQN from the AUTN. The UE calculates the XMAC and checks that XMAC matches the received MAC and that the SQN is in the correct range. If both these checks are successful the UE calculates the authentication challenge response (using RES and other parameters as defined in RFC 3310 [6]), and also computes the session keys IK and CK. The authentication challenge response is put into the Authorization header and sent back to the BSF in the GET request. + +### 6. GET request (UE to BSF) - see example in table A.3-4 + +The UE sends an HTTP GET request again, with the RES, which is used for response calculation, to the BSF. + +**Table A.3-4: GET request (UE to BSF)** + +``` + +GET / HTTP/1.1 +Host: bsf.home1.net:80 +User-Agent: Bootstrapping Client Agent; Release-6; 3gpp-gba-tmpi +Date: Thu, 08 Jan 2004 10:13:18 GMT +Accept: */* +Authorization: Digest + username="user1_private@home1.net", + realm="bsf.home1.net", + nonce="base64 (RAND + AUTN + server specific data)", + uri="/", qop=auth-int, + nc=00000001, + cnonce="6629fae49393a05397450978507c4ef1", + response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", + algorithm=AKAv1-MD5 + +``` + +**Authorization:** This carries the response to the authentication challenge received in step 4 and contains the private user identity, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +### 7. Authentication and generation of key material at BSF + +Upon receiving an integrity protected GET request carrying the authentication challenge response, the BSF checks that the expected response (calculated by the BSF using XRES and other parameter as defined in RFC 3310 [6]) matches the received challenge response. If the check is successful then the user has been authenticated and the private user identity is registered in the BSF. + +The BSF generates the bootstrapping transaction identifier (B-TID) for the IMPI and stores the tuple . + +For detailed bootstrapping key material generation procedure see 3GPP TS 33.220 [1]. + +### 8. 200 OK response (BSF to UE) - see example in table A.3-5 + +The BSF sends 200 OK response to the UE to indicate the success of the authentication. + +**Table A.3-5: 200 OK response (BSF to UE)** + +``` +HTTP/1.1 200 OK +Server: Bootstrapping Server; Release-6; 3gpp-gba-tmpi +Authentication-Info: qop=auth-int, + rspauth="6629fae49394a05397450978507c4ef1", + cnonce="6629fae49393a05397450978507c4ef1", + nc=00000001, + nextnonce="base64(RAND + AUTN + server specific data)" +Date: +Expires: Thu, 08 Jan 2004 10:23:17 GMT +Content-Type: application/vnd.3gpp.bsf+xml +Content-Length: (...) + + + + user@bsf.operator.com + 2004-05-28T13:20:00Z + + 2004-05-27T13:20:00Z + + +``` + +**Content-Type:** Contains the media type of the entity body. + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the server authentication information. The header includes the "rspauth" parameter, which is calculated as specified in RFC 2617 [9] using RES for response calculation as specified in RFC 3310 [6]. + +**Expires:** Gives the date/time after which the response is considered stale. + +### 9. Generation of key material at UE + +The key material Ks is generated in UE by concatenating CK and IK. In the case of GBA\_ME, the ME stores the tuple , and in the case of GBA\_U, the UICC stores the tuple . + +NOTE 3: The NAF specific key material (Ks\_NAF in the case of GBA\_ME, or Ks\_ext\_NAF and Ks\_int\_NAF in the case of GBA\_U) is derived from Ks during the Ua interface procedures, and is used for securing the Ua interface. In the case of GBA\_ME, the ME stores the tuple and in the case of GBA\_U, the ME stores the tuple , and the UICC stores the tuple . + +For detailed bootstrapping key material generation procedure for NAF specific key (Ks\_NAF, Ks\_ext\_NAF or Ks\_int\_NAF) see 3GPP TS 33.220 [1]. + +## A.4 Signalling flows demonstrating a synchronization failure in the bootstrapping procedure + +If the UE considers the sequence number in the challenge to be not in the correct range, it sends a synchronization failure indication back to BSF. The parameter AUTS contains the concealed value of the counter value SQNMS in the UE. + +![Sequence diagram illustrating the bootstrapping procedure in a sequence number synchronization failure case. The diagram shows interactions between UE, BSF, and HSS. The UE sends an initial GET to the BSF. The BSF uses the Zh interface to query the HSS. The BSF performs authentication vector selection and responds with a 401 Unauthorized. The UE detects an invalid SQN and generates an AUTS parameter. The UE then sends a GET request to the BSF. The BSF again uses the Zh interface to query the HSS, performs authentication vector selection, and responds with another 401 Unauthorized. Finally, the UE decides to continue with bootstrapping.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` +sequenceDiagram + participant UE + participant BSF + participant HSS + Note right of BSF: 3. Authentication vector selection + Note left of UE: 5. SQN invalid, generate AUTS + Note right of BSF: 8. Authentication vector selection + Note left of UE: 10. Continue with bootstrapping + + UE->>BSF: 1. initial GET + BSF->>HSS: 2. Zh interface + BSF->>UE: 4. 401 Unauthorized + UE->>BSF: 6. GET + BSF->>HSS: 7. Zh interface + BSF->>UE: 9. 401 Unauthorized +``` + +Sequence diagram illustrating the bootstrapping procedure in a sequence number synchronization failure case. The diagram shows interactions between UE, BSF, and HSS. The UE sends an initial GET to the BSF. The BSF uses the Zh interface to query the HSS. The BSF performs authentication vector selection and responds with a 401 Unauthorized. The UE detects an invalid SQN and generates an AUTS parameter. The UE then sends a GET request to the BSF. The BSF again uses the Zh interface to query the HSS, performs authentication vector selection, and responds with another 401 Unauthorized. Finally, the UE decides to continue with bootstrapping. + +**Figure A.4-1: The bootstrapping procedure in sequence number synchronization failure case.** + +### 1-4. Initial bootstrapping steps + +Steps 1 through 4 are described in the corresponding steps in clause A.3. + +### 5. SQN invalid, generate AUTS at UE + +The UE identifies the sequence number is out of synchronization. The UE generates the AUTS parameter (112 bit value). The AUTS parameter is populated in Authorization header, as specified in RFC 3310 [6]. + +### 6. GET request (UE to BSF) - see example in table A.4-1 + +The UE sends HTTP GET request, with the AUTS parameter to the BSF. + +**Table A.4-1: GET request (UE to BSF)** + +``` +GET / HTTP/1.1 +Host: bsf.home1.net:80 +User-Agent: Bootstrapping Client Agent; Release-6 +Date: Thu, 08 Jan 2004 10:13:17 GMT +Accept: */* +Authorization: Digest + username="user1_private@home1.net", + realm="bsf.home1.net", + nonce="base64(RAND + AUTN + server specific data)", + uri="/", + qop=auth-int, + nc=00000001, + cnonce="6629fae49393a05397450978507c4ef1", + response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", + algorithm=AKAv1-MD5, + auts="base64(AUTS) " +``` + +**Authorization:** This carries the response to the authentication challenge received in step 4 and contains the AUTS parameter. + +### 7. Zh: Authentication procedure + +If BSF does not have the corresponding AV indicated by the AUTS, the BSF shall retrieve it from the HSS. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table A.4-2: BSF authentication information procedure (BSF to HSS)** + +| Message source and destination | Zh Information element name | Information Source in GET | Description | +|--------------------------------|-----------------------------|---------------------------|-----------------------------------------------------------------------------------------------------| +| BSF to HSS | Private User Identity | Authorization: | The Private User Identity is encoded in the username field according to the Authorization protocol. | + +### 8. Authentication vector selection + +The BSF selects the AV indicated by the AUTS for use in the authentication challenge. For detailed description of the authentication vector, see 3GPP TS 33.203 [21]. + +### 9. 401 Unauthorized response (BSF to UE) - see example in table A.4-3 + +The BSF sends another challenge based on new range of sequence number. + +**Table A.4-3: 401 Unauthorized response (BSF to UE)** + +``` +HTTP/1.1 401 Unauthorized +Server: Bootstrapping Server; Release-6 +Date: Thu, 08 Jan 2004 10:13:17 GMT +WWW-Authenticate: Digest + realm="bsf.home1.net", + nonce="base64(RAND + AUTN + server specific data)", + algorithm=AKAv1-MD5, + qop="auth-int", + opaque="5ccc069c403ebaf9f0171e9517f30e41" +``` + +**WWW-Authenticate:** The BSF challenges the user with new range of sequence number. The nonce includes the quoted string, base64 encoded value of the concatenation of the AKA RAND, AKA AUTN and server specific data. + +### 10. Continue with bootstrapping + +The bootstrapping procedure continues from step 5 of clause A.3. + +# --- Annex A1 (informative): Signalling flows of GBA Push procedure + +## A1.1 Scope of signalling flows + +This annex gives examples of signalling flows for the GBA Push procedure. + +## --- A1.2 Introduction + +### A1.2.1 General + +The GBA Push procedure is executed in order to establish a bootstrapped security association, i.e. bootstrapping session between a Push-NAF and a UE. + +### A1.2.2 Key required to interpret signalling flows + +The detailed message contents are not shown in the flows for this subclause as they are not necessarily transported using a text based mechanism. The details for the message contents can be found in 3GPP TS 33.223 [24]. + +The flows show the signalling exchanges between the following functional entities: + +- User Equipment (UE); +- Push-Network Application Function (P-NAF); +- Bootstrapping Server Function (BSF); +- Home Subscriber Server (HSS). + +## --- A1.3 Signalling flows demonstrating a successful GBA Push procedure + +The overall GBA Push procedure in the successful case is presented in figure A1.3-1. The bootstrapping interface Zh performs the retrieval of an authentication vector by BSF from the HSS, this corresponds to steps 4 and 5 in figure A1.3-1. The bootstrapping interface Zpn performs the retrieval of the GPI by the Push-NAF from the BSF, this corresponds to steps 2 and 7 in figure A1.3-1. The bootstrapping interface Upa is used to transfer the GPI from the Push-NAF to the UE, this corresponds to step 9 in figure A1.3-1. The Zpn interface is defined in 3GPP TS 29.109 [3]. + +![Sequence diagram for GBA Push signalling showing interactions between UE, P-NAF, BSF, and HSS.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-NAF + participant BSF + participant HSS + + Note right of P-NAF: 1. Generate GPI Request + P-NAF->>BSF: 2. GPI Request + Note right of BSF: 3. Init processing of GPI Request + BSF->>HSS: 4. AV Request + HSS-->>BSF: 5. AV Response + Note right of BSF: 6. NAF SA generation + BSF-->>P-NAF: 7. GPI Response + Note right of P-NAF: 8. NAF SA storage + P-NAF-->>UE: 9. GPI Push + Note right of UE: 10. NAF SA storage +``` + +The diagram illustrates the GBA Push signalling process between four entities: UE, P-NAF, BSF, and HSS. The sequence of events is as follows: 1. The P-NAF generates a GPI Request. 2. The P-NAF sends the GPI Request to the BSF. 3. The BSF initiates processing of the GPI Request. 4. The BSF sends an AV Request to the HSS. 5. The HSS responds with an AV Response. 6. The BSF generates a NAF SA. 7. The BSF sends a GPI Response to the P-NAF. 8. The P-NAF stores the NAF SA. 9. The P-NAF sends a GPI Push to the UE. 10. The UE stores the NAF SA. + +Sequence diagram for GBA Push signalling showing interactions between UE, P-NAF, BSF, and HSS. + +Figure A1.3-1: GBA Push signalling + +### **1. Generate GPI Request (Push-NAF)** + +A Push-NAF needs to establish a shared NAF SA with a UE which is registered for Push services. It knows the identity of the subscriber. The Push-NAF performs the processing described in 3GPP TS 33.223 [24] and generates the GPI Request. + +### **2. Send GPI Request (Push-NAF to BSF)** + +The Push-NAF sends the GPI Request to the BSF. + +### **3. Initial processing of GPI Request (BSF)** + +Upon receiving the request from the NAF, the BSF performs the processing steps described in 3GPP TS 33.223 [24]. + +### **4-5. Zh: Authentication procedure (BSF and HSS)** + +These steps correspond to Step 2 in figure A.3-1. + +### **6. NAF SA generation (BSF)** + +The BSF generates the NAF SA as defined in 3GPP TS 33.223 [24]. + +### **7. Send GPI Response (BSF to Push-NAF)** + +The GPI Response generated in the previous step is sent from the BSF to the Push-NAF. + +### 8. NAF SA storage (Push-NAF) + +The Push-NAF stores the information needed to maintain the NAF SA as described in 3GPP TS 33.223 [24]. + +### 9. GPI Push (Push-NAF to UE) + +The Push-NAF sends a GPI Push to the UE. This can be send over whatever transport method that the Push-NAF wishes to use (e.g. SMS, MMS, SIP Message, etc) The GPI Push message is described in 3GPP TS 33.223 [24]. + +### 10. NAF SA Storage (UE) + +The UE processes the GPI as described in 3GPP TS 33.223 [24] and stores the NAF SA. The UE does not need to contact the network to correctly generate the NAF SA. + +# --- Annex B (informative): Signalling flows for HTTP Digest Authentication with bootstrapped security association + +## B.1 Scope of signalling flows + +This annex gives examples of signalling flows for using HTTP Digest Authentication with bootstrapped security association. + +## --- B.2 Introduction + +### B.2.1 General + +A bootstrapping session established using a bootstrapping procedure (cf. clause 4 and annex A) is used between a UE and a NAF. The BSF provides to the NAF a NAF specific key material (Ks\_NAF or Ks\_ext\_NAF and optionally Ks\_int\_NAF) which is derived from the key material (Ks). The NAF uses this key to authenticate and optionally secure (i.e. integrity protect and encrypt) the communications between it and the UE. The BSF will also provide the NAF the expiration time of the bootstrapping session. When the bootstrapping session becomes invalid the NAF will stop using the session, and indicate to the UE that bootstrapping session has expired and that new session needs to be established. + +An example of the signalling flows of the authentication procedure using HTTP Digest authentication [9] is given in clause B.3. + +### B.2.2 Key required to interpret signalling flows + +The key to interpret signalling flows is specified in subclause A.2.2. + +## --- B.3 Signalling flows demonstrating a successful authentication procedure + +The signalling flow in figure B.3-1 describes the generic message exchange between UE and NAF using HTTP Digest Authentication. In this example, the HTTPS client application resides in the ME, i.e., either Ks\_NAF or Ks\_ext\_NAF is used as the key. The conversation can take place inside a server-authenticated TLS (as described in the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]) tunnel in which case TLS session has been established before step 1. + +![Sequence diagram illustrating HTTP Digest Authentication with bootstrapped security association. The diagram shows three lifelines: UE, NAF, and BSF. The sequence of messages is: 1. GET from UE to NAF; 2. 401 Unauthorized from NAF to UE; 3. Generation of NAF specific key material (internal UE step); 4. GET from UE to NAF; 5. Zn interface message from NAF to BSF; 6. Authentication from BSF to NAF; 7. 200 OK from NAF to UE; 8. Authentication (internal UE step).](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + UE->>NAF: 1. GET + NAF-->>UE: 2. 401 Unauthorized + Note left of UE: 3. Generation of NAF specific key material + UE->>NAF: 4. GET + NAF->>BSF: 5. Zn interface + Note right of NAF: 6. Authentication + BSF-->>NAF: + NAF-->>UE: 7. 200 OK + Note left of UE: 8. Authentication + +``` + +Sequence diagram illustrating HTTP Digest Authentication with bootstrapped security association. The diagram shows three lifelines: UE, NAF, and BSF. The sequence of messages is: 1. GET from UE to NAF; 2. 401 Unauthorized from NAF to UE; 3. Generation of NAF specific key material (internal UE step); 4. GET from UE to NAF; 5. Zn interface message from NAF to BSF; 6. Authentication from BSF to NAF; 7. 200 OK from NAF to UE; 8. Authentication (internal UE step). + +**Figure B.3-1: HTTP Digest Authentication with bootstrapped security association** + +### **1. GET request (UE to NAF) - see example in table B.3-1** + +The UE sends an HTTP request to a NAF to gain access to a service. + +**Table B.3-1: Initial GET request (UE to NAF)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 GET / HTTP/1.1 Host: naf1.home1.net:1234 User-Agent: NAF1 Application Agent; Release-6 3gpp-gba Date: Thu, 08 Jan 2004 10:50:35 GMT Accept: */* Referer: http://naf1.home1.net:1234/service X-3GPP-Intended-Identity: "user@asl.home1.net"
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Request-URI:** The Request-URI (the URI that follows the method name, "GET", in the first line) indicates the resource indication of this GET request. + +**Host:** Specifies the Internet host and port number of the NAF server, obtained from the original URI given by referring resource. + +**User-Agent:** Contains information about the user agent originating the request and it includes the static string "3gpp-gba" to indicate to the application server (i.e. NAF) that the UE supports 3GPP-bootstrapping based authentication. + +**Date:** Represents the date and time at which the message was originated. + +**Accept:** Media types which are acceptable for the response. + +**Referer:** Allows the user agent to specify the address (URI) of the resource from which the URI for the NAF was obtained. + +NOTE 1: This step can also be a POST request in which case the request would contain a client payload in the HTTP request and the corresponding Content-Type and Content-Length header values. + +### 2. 401 Unauthorized response (NAF to UE) - see example in table B.3-2 + +Upon receiving an HTTP request that contains static string "3gpp-gba" in the User-Agent header, NAF can choose to authenticate the UE using bootstrapped security association. If NAF chooses to authenticate the UE using bootstrapped security association, it responds with HTTP response code 401 "Unauthorized" which contains a WWW-Authenticate header. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +**Table B.3-2: 401 Unauthorized response (NAF to UE)** + +``` +HTTP/1.1 401 Unauthorized +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 10:50:35 GMT +WWW-Authenticate: Digest realm="3GPP-bootstrapping@naf.home1.net", + nonce="6629fae49393a05397450978507c4ef1", algorithm=MD5, qop="auth,auth-int", + opaque="5ccc069c403ebaf9f0171e9517f30e41" +``` + +**Server:** Contains information about the software used by the origin server (NAF). + +**Date:** Represents the date and time at which the message was originated. + +**WWW-Authenticate:** The NAF challenges the user. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +The options for the quality of protection (qop) attribute is by default "auth-int" meaning that the payload of the following HTTP requests and responses should integrity protected. If the conversation is taking place inside a server-authenticated TLS tunnel, the options for the qop attribute can also contain "auth" meaning that the payload of the following HTTP requests and responses are not protected by HTTP Digest. The integrity protection is handled on the TLS layer instead. + +The realm attribute contains two parts delimited by "@" sign. The first part is a constant string "3GPP-bootstrapping" instructing the UE to use a bootstrapped security association. The second part is the FQDN of the NAF. + +### 3. Generation of NAF specific keys at UE + +UE verifies that the second part of the realm attribute does correspond to the server it is talking to. In particular, if the conversation is taking place inside a server-authenticated TLS tunnel, the UE shall verify that the server name in the server's TLS certificate matches the server name in the realm attribute of the WWW-Authenticate header. + +UE derives the NAF specific key material *Ks\_(ext)\_NAF* as specified in 3GPP TS 33.220 [1]. + +NOTE 2: If UE does not have a bootstrapped security association available, it obtains one by running bootstrapping procedure over Ub interface + +### 4. GET request (UE to NAF) - see example in table B.3-3 + +UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material *Ks\_(ext)\_NAF* (base64 encoded) as the password, and sends the request to NAF. + +**Table B.3-3: GET request (UE to NAF)** + +``` +GET / HTTP/1.1 +Host: naf1.home1.net:1234 +User-Agent: NAF1 Application Agent; Release-6 3gpp-gba +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://naf1.home1.net:1234/service +X-3GPP-Intended-Identity: "user@as1.home1.net" +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@naf.home1.net", + nonce="a6332ffd2d234=", uri="/", qop=auth-int, nc=00000001, + cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 +``` + +**Authorization:** This carries the response to the authentication challenge received in step 2 along with the username, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +The qop attribute is set to "auth-int" by default. If the conversation is taking place inside a server-authenticated TLS tunnel, the qop attribute can be set to "auth" as well. + +NOTE 3: If step 1 was a POST request then this request would also be POST request and contain the same client payload in the HTTP request as was carried in step 1. + +### 5. Zn: NAF specific key procedure + +NAF retrieves the NAF specific key material (Ks\_NAF or Ks\_ext\_NAF) from the BSF. + +In the case that the HTTPS client resides in the UICC, then the NAF needs to retrieve Ks\_int\_NAF. + +If the NAF retrieved an application-specific USS and it contained a keyChoice indication, the NAF must enforce this indication. Hence, if the UICC-based key was indicated the NAF must terminate the communication with the UE in this phase. + +NOTE 4: If the local configuration in the NAF restricts the access to the service to UICC-based applications using only Ks\_int\_NAF, then the NAF will terminate the communication with the UE in this phase. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table B.3-4: Bootstrapping authentication information procedure (NAF to BSF)** + +| Message source and destination | Zn Information element name | Information Source in GET | Description | +|--------------------------------|-----------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| NAF to BSF | B-TID | Authorization | The bootstrapping transaction identifier (B-TID) is encoded in the username field according to the Authorization protocol. | + +### 6. Authentication at NAF + +NAF verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_(ext)\_NAF obtained from BSF. NAF calculates the corresponding digest values using Ks\_(ext)\_NAF, and compares the calculated values with the received values in the Authorization header. + +The NAF also verifies that the DNS name in the realm attribute matches its own. If the conversation is taking place inside a server-authenticated TLS tunnel, the NAF shall also verify that this DNS name is the same as that of the TLS server certificate. + +If the verification succeeds, the incoming client-payload request is taken in for further processing. + +### 7. 200 OK response (NAF to UE) - see example in table B.3-5 + +The NAF sends 200 OK response to the UE to indicate the success of the authentication. NAF generates a HTTP response containing the server-payload it wants to send back to the UE. The NAF can use key material Ks\_(ext)\_NAF to integrity protect and authenticate the response. + +**Table B.3-5: 200 OK response (NAF to UE)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27Content-Type: text/html +Content-Length: 1234 +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", +cnonce="6629fae49393a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + + +``` + +**Content-Type:** Contains the media type of the entity body. + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the protection + +**Expires:** Gives the date/time after which the response is considered stale. + +### 8. Authentication at UE + +UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can accept the server-payload for further processing. + +NOTE 4: Additional messages can be exchanged using steps 4 through 8 as many times as is necessary. The following HTTP requests and responses are constructed according to RFC 2617 [9]. + +# **Annex C (normative): XML Schema Definition** + +## **C.1 Introduction** + +This annex contains the XML schema definition for an XML document carrying the bootstrapping transaction identifier (B-TID), the key lifetime, and possibly other server specific data. + +The "lifetime" attribute shall indicate the expiry time of the key. The lifetime value shall be expressed in UTC form, indicated by a time zone designator "Z" immediately following the time portion of the value. + +If the XML document includes element, the element is included in the element of the root element. + +NOTE: When included, the element is validated by the particle of the element. + +The current time shall be expressed in UTC form, indicated by a time zone designator "Z" immediately following the time portion of the value. The UE may use information in the element to determine the duration for which the bootstrapping transaction identifier (B-TID) is valid. + +The receiving entity ignores any unknown XML element and any unknown XML attribute. + +``` + + + + + + + + + + + + + + + + + + + + + + + + > + + + + +``` + +NOTE: The element within the complex type tExtension allows for compatible standard extensions in future releases. + +# --- Annex D (informative): Signalling flows for Authentication Proxy + +## D.1 Scope of signalling flows + +This annex gives examples of signalling flows for using AP in GAA. + +## --- D.2 Introduction + +A bootstrapping session (established using a bootstrapping procedure, cf. clause 4 and annex A) is used between a UE and an authentication proxy (AP) that is functioning as a NAF. The BSF provides to the AP an AP specific key material (Ks\_NAF or Ks\_ext\_NAF and optionally Ks\_int\_NAF), which is derived from the key material (Ks). The AP uses this key to authenticate and optionally secure (i.e. integrity protect with HTTP Digest using "auth-int" qop option, or integrity protect and encrypt with PSK TLS) the communications between it and the UE. The BSF will also provide the AP the expiration time of the bootstrapping session. When the bootstrapping session becomes invalid the AP will stop using the session, and indicate to the UE that bootstrapping session has expired and that new session needs to be established. + +The AP functions as a reverse proxy. After the AP has authenticated and optionally secured the communication between it and the UE, the AP will forward the incoming HTTP requests from the UE to the correct application server (AS) behind the AP. There can be multiple application servers behind the AP. + +NOTE: As consequence of the fact that the UE assumes it is communicating with the AS, not the AP, the AP might need to use different NAF specific keys per UE because (i) the UE will use the hostname of the AS (i.e., NAF\_ID) when deriving the NAF specific key, (ii) the AP is doing virtual name based hosting, i.e., has reverse proxy functionality, and (iii) the UE can communicate through the AP with several ASes at the same time. + +An example of the signalling flows of the authentication procedure between a UE, an AP, and an AS is given in clause D.3. + +### D.2.1 Key required to interpret signalling flows + +The key to interpret signalling flows specified in subclause A.2.2. + +## --- D.3 Signalling flow demonstrating a successful authentication procedure + +The signalling flow in figure D.3-1 describes the generic message exchange between a UE, a AP, and an AS using HTTP. In this example, the HTTP client application resides in the ME, i.e., either Ks\_NAF or Ks\_ext\_NAF is used as the key. The conversation between the UE and the AP can take place inside a server-authenticated TLS (as described in the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]) tunnel in which case TLS session has been established before step 1. + +![Sequence diagram showing successful authentication with AP and AS. The diagram involves three lifelines: UE, AP, and AS. The sequence of messages is: 1. GET (UE to AP), 2. 401 Unauthorized (AP to UE), 3. Generation of NAF specific key material (internal UE process), 4. GET (authenticated) (UE to AP), 5. Validate authentication and authorize request (internal AP process), 6. GET (with UID) (AP to AS), 7. AS specific logic (internal AS process), 8. 200 OK (AS to AP), 9. Add Authentication-Info (internal AP process), 10. 200 OK (AP to UE), 11. Process response (internal UE process).](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AP + participant AS + Note left of UE: 3. Generation of NAF specific key material + UE->>AP: 1. GET + AP-->>UE: 2. 401 Unauthorized + Note left of UE: 3. Generation of NAF specific key material + UE->>AP: 4. GET (authenticated) + Note right of AP: 5. Validate authentication and authorize request + AP->>AS: 6. GET (with UID) + Note right of AS: 7. AS specific logic + AS-->>AP: 8. 200 OK + Note right of AP: 9. Add Authentication-Info + AP-->>UE: 10. 200 OK + Note left of UE: 11. Process response + +``` + +Sequence diagram showing successful authentication with AP and AS. The diagram involves three lifelines: UE, AP, and AS. The sequence of messages is: 1. GET (UE to AP), 2. 401 Unauthorized (AP to UE), 3. Generation of NAF specific key material (internal UE process), 4. GET (authenticated) (UE to AP), 5. Validate authentication and authorize request (internal AP process), 6. GET (with UID) (AP to AS), 7. AS specific logic (internal AS process), 8. 200 OK (AS to AP), 9. Add Authentication-Info (internal AP process), 10. 200 OK (AP to UE), 11. Process response (internal UE process). + +**Figure D.3-1: Successful authentication with AP and AS** + +### **1. GET request (UE to AP) - see example in table D.3-1** + +The UE sends an HTTP request to a AP to gain access to a service. + +**Table D.3-1: Initial GET request (UE toAP)** + +``` + +GET / HTTP/1.1 +Host: as1.home1.net:1234 +User-Agent: NAF1 Application Agent; Release-6 3gpp-gba +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://as1.home1.net:1234/service + +``` + +**Request-URI:** The Request-URI (the URI that follows the method name, "GET", in the first line) indicates the resource indication of this GET request. + +**Host:** Specifies the Internet host and port number of the AS, obtained from the original URI given by referring resource. + +**User-Agent:** Contains information about the user agent originating the request and it includes the static string "3gpp-gba" to indicate to the application server (i.e. NAF) that the UE supports 3GPP-bootstrapping based authentication. + +**Date:** Represents the date and time at which the message was originated. + +**Accept:** Media types which are acceptable for the response. + +**Referer:** Allows the user agent to specify the address (URI) of the resource from which the URI for the AS was obtained. + +NOTE 1: The UE assumes it is communicating directly with the AS, but is in fact communicating with the AP which functioning as a reverse proxy. + +### 2. 401 Unauthorized response (AP to UE) - see example in table D.3-2 + +Upon receiving an HTTP request that contains static string "3gpp-gba" in the User-Agent header, the AP might choose to authenticate the UE using bootstrapped security association. If AP chooses to authenticate the UE using bootstrapped security association, it responds with HTTP response code 401 "Unauthorized" which contains a WWW-Authenticate header. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +**Table D.3-2: 401 Unauthorized response (AP to UE)** + +``` +HTTP/1.1 401 Unauthorized +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 10:50:35 GMT +WWW-Authenticate: Digest realm="3GPP-bootstrapping@asl.home1.net", + nonce="6629fae49393a05397450978507c4ef1", algorithm=MD5, qop="auth,auth-int", + opaque="5ccc069c403ebaf9f0171e9517f30e41" +``` + +**Server:** Contains information about the software used by the origin server (AP). + +**Date:** Represents the date and time at which the message was originated. + +**WWW-Authenticate:** The AP challenges the user. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +The options for the quality of protection (qop) attribute for HTTP Digest integrity protection is by default "auth-int" meaning that the payload of the following HTTP requests and responses should integrity protected. If the conversation is taking place inside a server-authenticated TLS tunnel, the options for the qop attribute might also contain "auth" meaning that the payload of the following HTTP requests and responses are not protected by HTTP Digest. The integrity protection is handled on the TLS layer instead. + +The realm attribute contains two parts delimited by "@" sign. The first part is a constant string "3GPP-bootstrapping" instructing the UE to use a bootstrapped security association. The second part is the FQDN of the NAF. In this case, the FQDN of the NAF must be the server hostname that the UE used in the corresponding HTTP request, i.e., the hostname of the AS. + +### 3. Generation of NAF specific keys at UE + +The UE verifies that the second part of the realm attribute does correspond to the server it is talking to. In particular, if the conversation is taking place inside a server-authenticated TLS tunnel, the UE verifies that the server name in the server's TLS certificate matches the server name in the realm attribute of the WWW-Authenticate header. + +The UE derives the NAF specific key material $K_{s\_(\text{ext})\_NAF}$ as specified in 3GPP TS 33.220 [1]. + +NOTE 2: If the UE does not have a bootstrapped security association available, it will obtain one by running bootstrapping procedure over Ub interface + +### 4. GET request (UE to AP) - see example in table D.3-3 + +The UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material $K_{s\_(\text{ext})\_NAF}$ (base64 encoded) as the password, and sends the request to the AP. + +**Table D.3-3: GET request (UE to AP)** + +``` +GET / HTTP/1.1 +Host: as1.home1.net:1234 +User-Agent: NAF1 Application Agent; Release-6 3gpp-gba +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://as1.home1.net:1234/service +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@as1.home1.net", + nonce="a6332ffd2d234==", uri="/", qop=auth-int, nc=00000001, + cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 +``` + +**Authorization:** This carries the response to the authentication challenge received in step 2 along with the username, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +The qop attribute is set to "auth-int" when HTTP Digest integrity protection is used. If the conversation is taking place inside a server-authenticated TLS tunnel, the qop attribute can be set to "auth" as well. + +### 5. Validate authentication and authorize request + +If the AP does not have the NAF specific key material (Ks\_NAF or Ks\_ext\_NAF), then the AP retrieves that and one or more user security setting (USS) from the BSF. For detailed signalling flows see 3GPP TS 29.109 [3]. + +If the AP retrieved an application-specific USS and it contained a keyChoice indication, the AP must enforce this indication. Hence, if the UICC-based key was indicated the AP must terminate the communication with the UE in this phase. + +NOTE 3: If the local configuration in the AP restricts the access to this NAF service to UICC-based applications, then the AP will terminate the communication with the UE in this phase. + +The AP verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_(ext)\_NAF obtained from BSF. The AP calculates the corresponding digest values using Ks\_(ext)\_NAF, and compares the calculated values with the received values in the Authorization header. The AP will also verify that the DNS name in the realm attribute matches the AS hostname. If the conversation is taking place inside a server-authenticated TLS tunnel, the AP will also verify that this DNS name is the same as that of the TLS server. + +If the verification succeeds, the incoming client-payload request is taken in for further processing. + +Depending on the AP configuration, the AP will inspect the incoming HTTP request accordingly, see 3GPP TS 33.222 [5]. In this example it is assumed that the AP has been configured to add subscriber's identifiers (UIDs) to the forwarded HTTP request (see step 6). + +NOTE 4: If UE has included "X-3GPP-Intended-Identity" with subscriber's identity to the HTTP response, then the AP will validate the given identity before forwarding the request to the AS. + +### 6. GET request (AP to AS) - see example in table D.3-4 + +The AP forwards the HTTP request to the correct AS. The correct AS is determined by checking the "Host" header of the request and AP's internal configuration. + +The AP removes the "Authorization" header from the forwarded HTTP request. Depending on the AP configuration, the AP might add subscriber's UIDs to the HTTP request by using "X-3GPP-Asserted-Identity" header. + +In this example, subscriber's UIDs are added to the request. + +**Table D.3-4: GET request (AP to AS)** + +``` +GET / HTTP/1.1 +Host: as1.home1.net:1234 +User-Agent: NAF1 Application Agent; Release-6 3gpp-gba +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://as1.home1.net:1234/service +X-3GPP-Asserted-Identity: "user@as1.home1.net", "user2@as1.home.net" +``` + +- Content-Type:** Contains the media type of the entity body. +- Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. +- Authentication-Info:** This carries the protection +- Expires:** Gives the date/time after which the response is considered stale. +- X-3GPP-Asserted-Identity:** This header is added by the AP and carries the list of subscriber's identities to the AS. + +### 7. AS specific logic at AS + +The AS processes the incoming HTTP request and extracts the UIDs from the "X-3GPP-Asserted-Identity" header. + +### 8. 200 OK response (AS to AP) - see example in table D.3-5 + +The AS returns a HTTP response to the AP with service specific payload. + +**Table D.3-5: 200 OK response (AS to AP)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Content-Length: (...) +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + + +``` + +- Content-Type:** Contains the media type of the entity body. +- Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. +- Expires:** Gives the date/time after which the response is considered stale. + +### 9. Add Authentication-Info header at AP + +The AP calculates and adds the "Authentication-Info" header to the HTTP response that forwarded to the UE. + +### 10. 200 OK response (AP to UE) - see example in table D.3-6 + +The AP forwards the HTTP response to the UE. + +**Table D.3-6: 200 OK response (AP to UE)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Content-Length: 1234 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", + cnonce="6629fae49393a05397450978507c4ef1", nc=00000001 + + +``` + +**Authentication-Info:** This header is inserted by the AP to the request. The values in the header are calculated by the AP. + +### 11. Process response at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can accept the server-payload for further processing. + +NOTE 5: Additional messages can be exchanged using steps 4 through 11 as many times as is necessary. The HTTP Digest related headers in the following HTTP requests and responses must be constructed according to RFC 2617 [8]. + +# --- Annex E (informative): Signalling flows for PKI portal + +## E.1 Scope of signalling flows + +This annex gives examples of signalling flows for the subscriber certificate enrolment and the CA certificate delivery. + +## --- E.2 Introduction + +### E.2.1 General + +A bootstrapping session established using a bootstrapping procedure (cf., clause 4 and annex A) is used between a UE and a PKI portal. The BSF provides to the PKI portal a NAF specific key material (Ks\_NAF or Ks\_ext\_NAF) which is derived from the key material (Ks). The PKI portal uses this key to authenticate and optionally secure (i.e. integrity protect and encrypt) the communications between it and the UE. The BSF will also provide the PKI portal the expiration time of the bootstrapping session. + +### E.2.2 Key required to interpret signalling flows + +The key to interpret signalling flows is specified in subclause A.2.2. + +## --- E.3 Signalling flows demonstrating a successful subscriber certificate enrolment + +### E.3.1 Simple subscriber certificate enrolment + +The signalling flow in figure E.3.1-1 describes the message exchange between UE and PKI portal when UE wants to enrol a subscriber certificate. The messaging can take place inside a server-authenticated TLS (as described in the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]) tunnel in which case TLS session has been established before step 1. + +![Sequence diagram showing successful subscriber certificate enrolment between UE, PKI portal, and BSF.](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PKI_portal as PKI portal + participant BSF + Note left of UE: 3. Generation of NAF specific key material + UE->>PKI_portal: 1. Initial enrolment request + PKI_portal-->>UE: 2. 401 Unauthorized + Note right of PKI_portal: 6. Authentication and certificate generation + UE->>PKI_portal: 4. Authenticated enrolment request + PKI_portal->>BSF: 5. Zn interface + PKI_portal-->>UE: 7. Delivery of subscriber certificate + Note left of UE: 8. Authentication + +``` + +Sequence diagram showing successful subscriber certificate enrolment between UE, PKI portal, and BSF. + +**Figure E.3.1-1: Successful subscriber certificate enrolment.** + +#### **1. Initial enrolment request (UE to PKI portal) - see example in table E.3.1-1** + +The UE sends an HTTP request to the PKI portal containing a PKCS#10 certification request. + +**Table E.3.1-1: Initial enrolment request (UE to PKI portal)** + +``` + +POST /enrol?response=single HTTP/1.1 +Host: pkiportal.home1.net:1234 +Content-Type: application/x-pkcs10 +Content-Length: (...) +User-Agent: SCEnrolmentAgent; Release-6 3gpp-gba +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service + +----- BEGIN CERTIFICATE REQUEST ----- + +----- END CERTIFICATE REQUEST ----- + +``` + +- Request-URI:** The Request-URI (the URI that follows the method name, "POST", in the first line) indicates the resource of this POST request. The Request-URI contains the parameter "response" which is set to "single" to indicate to the PKI portal the desired response type, i.e. just the subscriber certificate is requested to be delivered. +- Host:** Specifies the Internet host and port number of the PKI portal server, obtained from the original URI given by referring resource. +- Content-Type:** Contains the media type "application/x-pkcs10", i.e. the PKCS#10. +- Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. +- User-Agent:** Contains information about the user agent originating the request and it will include the static string "3gpp-gba" to indicate to the application server (i.e., NAF) that the UE supports 3GPP-bootstrapping based authentication. + +- Date:** Represents the date and time at which the message was originated. +- Accept:** Media types which are acceptable for the response. +- Referer:** Allows the user agent to specify the address (URI) of the resource from which the URI for the PKI portal was obtained. + +NOTE 1: This step is used to trigger the GBA-based authentication between the UE and the PKI portal. + +#### 2. 401 Unauthorized response (PKI portal to UE) - see example in table E.3.1-2 + +Upon receiving an HTTP request that contains static string "3gpp-gba" in the User-Agent header the PKI portal responds with HTTP response code 401 "Unauthorized" which contains a WWW-Authenticate header. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +**Table E.3.1-2: 401 Unauthorized response (PKI portal to UE)** + +``` +HTTP/1.1 401 Unauthorized +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 10:50:35 GMT +WWW-Authenticate: Digest realm="3GPP-bootstrapping@pkiportal.home1.net", +nonce="6629fae49393a05397450978507c4ef1", algorithm=MD5, qop="auth,auth-int", +opaque="5ccc069c403ebaf9f0171e9517f30e41" +``` + +- Server:** Contains information about the software used by the origin server (PKI portal). +- Date:** Represents the date and time at which the message was originated. +- WWW-Authenticate:** The PKI portal challenges the user. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +The options for the quality of protection (qop) attribute is by default "auth-int" meaning that the payload of the following HTTP requests and responses should integrity protected. If the messaging is taking place inside a server-authenticated TLS tunnel, the options for the qop attribute can also contain "auth" meaning that the payload of the following HTTP requests and responses are not protected by HTTP Digest. The integrity protection is handled on the TLS layer instead. + +The realm attribute contains two parts delimited by "@" sign. The first part is a constant string "3GPP-bootstrapping" instructing the UE to use a bootstrapped security association. The second part is the hostname of the server (i.e. FQDN of the PKI portal). + +#### 3. Generation of NAF specific keys at UE + +The UE verifies that the second part of the realm attribute does correspond to the server it is talking to. In particular, if the messaging is taking place inside a server-authenticated TLS tunnel, the UE verifies that the server name (i.e. FQDN of the PKI portal) in the server's TLS certificate matches the hostname of the server in the realm attribute of the WWW-Authenticate header. + +UE derives the NAF specific key material Ks\_NAF as specified in 3GPP TS 33.220 [1]. + +NOTE 2: If UE does not have a bootstrapped security association available, it will obtain one by running bootstrapping procedure over Ub interface. + +#### 4. Authenticated enrolment request (UE to PKI portal) - see example in table E.3.1-3 + +UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material Ks\_NAF (base64 encoded) as the password, and sends the request to PKI portal. + +**Table E.3.1-3: Authenticated enrolment request (UE to PKI portal)** + +``` + +POST /enrol?response=single HTTP/1.1 +Host: pkiportal.home1.net:1234 +Content-Type: application/pkcs10 +Content-Length: (...) +User-Agent: SCEnrolmentAgent; Release-6 3gpp-gba +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@pkiportal.home1.net", + nonce="a6332ffd2d234==", uri="/enrol?response=single", qop=auth-int, nc=00000001, + cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 + +----- BEGIN CERTIFICATE REQUEST ----- + +----- END CERTIFICATE REQUEST ----- + +``` + +**Authorization:** This carries the response to the authentication challenge received in step 2 along with the username, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +The qop attribute is set to "auth-int" by default. If the messaging is taking place inside a server-authenticated TLS tunnel, the qop attribute can be set to "auth" as well. + +NOTE 3: If step 1 was a POST request then this request would also be POST request and contain the same client payload in the HTTP request as was carried in step 1. + +#### 5. Zn: NAF specific key procedure + +PKI portal retrieves the NAF specific key material (Ks\_NAF) and subscriber's user security setting from the BSF. + +NOTE 4: Subscriber's user security setting for PKI portal consists of flags that indicate whether certain type certificate is authorized to be issued to the subscriber. There are two certificate types: authentication certificate and non-repudiation certificate. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table E.3.1-4: Bootstrapping authentication information procedure (PKI portal to BSF)** + +| Message source and destination | Zn Information element name | Information Source in GET | Description | +|--------------------------------|-----------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| NAF to BSF | B-TID | Authorization | The bootstrapping transaction identifier (B-TID) is encoded in the username field according to the Authorization protocol. | + +#### 6. Authentication and certificate generation at PKI portal + +PKI portal verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_NAF obtained from BSF. PKI portal calculates the corresponding digest values using Ks\_NAF, and compares the calculated values with the received values in the Authorization header. + +The PKI portal also verifies that the hostname (i.e. its FQDN) in the realm attribute matches its own. If the messaging is taking place inside a server-authenticated TLS tunnel, the PKI portal also verifies that this hostname is the same as that of the TLS server. + +If the verification succeeds, the incoming client-payload request is taken in for further processing. The PKI portal continues processing of the PKCS#10 request according to its internal policies. The PKI portal verifies that the subscriber is allowed to receive the particular type of certificate indicate in the PKCS#10 request by checking subscriber's user security setting received from the BSF in step 5. + +NOTE 5: The procedures for generating the subscriber certificate are outside the scope. + +#### 7. Delivery of subscriber certificate (PKI portal to UE) - see example in table E.3.1-5 + +The PKI portal sends 200 OK response to the UE to indicate the success of the authentication and the subscriber certificate enrolment. The PKI portal generates a HTTP response containing the enrolled subscriber certificate. The PKI portal can use key material Ks\_NAF to integrity protect and authenticate the response. + +**Table E.3.1-5: Delivery of subscriber certificate (PKI portal to UE)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Content-Type: application/x-x509-user-cert +Content-Length: (...) +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", +cnonce="6629fae49394a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + +----- BEGIN CERTIFICATE ----- + +----- END CERTIFICATE ----- +``` + +**Content-Type:** Contains the media type "application/x-x509-user-cert", i.e. X.509 certificate. + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the protection + +**Expires:** Gives the date/time after which the response is considered stale. + +#### 8. Authentication at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can accept the subscriber certificate for further processing. + +### E.3.2 Subscriber certificate enrolment with WIM authentication codes + +The signalling flow in figure E.3.2-1 describes the message exchange between UE and PKI portal when UE wants to enrol a subscriber certificate, and the UE uses a WIM that requires authentication codes both for onboard key pair generation and proof-of-origin generation. The messaging can take place inside a server-authenticated TLS (as described in the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]) tunnel in which case TLS session has been established before step 1. + +![Sequence diagram showing successful subscriber certificate enrolment between UE, PKI portal, and BSF.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PKI portal + participant BSF + + Note over UE: 1. WIM authcode for +onboard key generation +required + UE->>PKI portal: 2. Initial WIM authcode request + PKI portal-->>UE: 3. 401 Unauthorized + Note over UE: 4. Generation of NAF +specific key material + UE->>PKI portal: 5. Authenticated WIM authcode request + PKI portal<->BSF: 6. Zn interface + Note over PKI portal: 7. Authentication and +generation of WIM authcode + PKI portal-->>UE: 8. Delivery of WIM authcode + Note over UE: 9. Authentication, onboard key +pair generation, WIM authcode +for proof-of-origin required + UE->>PKI portal: 10. Authenticated WIM authcode request + Note over PKI portal: 11. Authentication and +generation of WIM authcode + PKI portal-->>UE: 12. Delivery of WIM authcode + Note over UE: 13. Authentication, proof-of-origin +generation, certification request +generation + UE->>PKI portal: 14. Authenticated enrolment request + Note over PKI portal: 15. Authentication and +certificate generation + PKI portal-->>UE: 16. Delivery of subscriber certificate + Note over UE: 17. Authentication + +``` + +The sequence diagram illustrates the interaction for successful subscriber certificate enrolment. It begins with the UE (User Equipment) requiring a WIM authcode for onboard key generation. The UE sends an initial WIM authcode request to the PKI portal, which responds with a 401 Unauthorized status. The UE then generates NAF specific key material and sends an authenticated WIM authcode request. The PKI portal uses a Zn interface to the BSF (Bootstrapping Server Function) for authentication and generation of the WIM authcode, which is then delivered to the UE. The UE performs authentication, onboard key pair generation, and WIM authcode for proof-of-origin. It then sends an authenticated WIM authcode request to the PKI portal. The PKI portal authenticates and generates the WIM authcode, which is delivered to the UE. The UE performs authentication, proof-of-origin generation, and certification request generation. It then sends an authenticated enrolment request to the PKI portal. The PKI portal authenticates and generates the certificate, which is delivered to the UE. Finally, the UE performs authentication. + +Sequence diagram showing successful subscriber certificate enrolment between UE, PKI portal, and BSF. + +**Figure E.3.2-1: Successful subscriber certificate enrolment** + +#### 1. WIM authentication code for onboard key pair generation required at UE + +The UE has initiated enrolment procedure and the WIM in the UE requires an WIM authentication code for the onboard key pair generation. + +NOTE 1: It is not mandatory to generate a key pair for each enrolment procedure, and the WIM can not require WIM authentication code for generating the key pair. In these cases, the WIM authentication code is not needed. + +#### 2. Initial WIM authentication code request (UE to PKI portal) - see example in table E.3.2-1 + +The UE sends an HTTP request to the PKI portal containing a WIM authentication code request. + +**Table E.3.2-1: Initial WIM authentication code request (UE to PKI portal)** + +``` +GET /enrol/wim-auth-code?request=error:AuthReq:123456789ABCDEF:AABBCCDD EE HTTP/1.1 +Host: pkiportal.home1.net:1234 +User-Agent: SCEnrolmentAgent; Release-6 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service +``` + +**Request-URI:** The Request-URI (the URI that follows the method name, "GET", in the first line) indicates the resource of this GET request. The Request-URI contains the parameter "request" which contains the WIM authentication request parameter received from the WIM, i.e. a static string "error:AuthReq:" appended by the WIM serial number in hexadecimal format, colon ":", and the challenge data in hexadecimal format. + +**Host:** Specifies the Internet host and port number of the PKI portal server, obtained from the original URI given by referring resource. + +**User-Agent:** Contains information about the user agent originating the request. + +**Date:** Represents the date and time at which the message was originated. + +**Accept:** Media types which are acceptable for the response. + +**Referer:** Allows the user agent to specify the address (URI) of the resource from which the URI for the PKI portal was obtained. + +NOTE 2: This step is used to trigger the GBA-based authentication between the UE and the PKI portal. + +#### 3. 401 Unauthorized response (PKI portal to UE) - see example in table E.3.2-2 + +The PKI portal responds with HTTP response code 401 "Unauthorized" which contains a WWW-Authenticate header. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +**Table E.3.2-2: 401 Unauthorized response (PKI portal to UE)** + +``` +HTTP/1.1 401 Unauthorized +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 10:50:35 GMT +WWW-Authenticate: Digest realm="3GPP-bootstrapping@pkiportal.home1.net", + nonce="6629fae49393a05397450978507c4ef1", algorithm=MD5, qop="auth,auth-int", + opaque="5ccc069c403ebaf9f0171e9517f30e41" +``` + +**Server:** Contains information about the software used by the origin server (PKI portal). + +**Date:** Represents the date and time at which the message was originated. + +**WWW-Authenticate:** The PKI portal challenges the user. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +The options for the quality of protection (qop) attribute is by default "auth-int" meaning that the payload of the following HTTP requests and responses should integrity protected. If the messaging is taking place inside a server-authenticated TLS tunnel, the options for the qop attribute can also contain "auth" meaning that the payload of the following HTTP requests and responses are not protected by HTTP Digest. The integrity protection is handled on the TLS layer instead. + +The realm attribute contains two parts delimited by "@" sign. The first part is a constant string "3GPP-bootstrapping" instructing the UE to use a bootstrapped security association. The second part is the hostname of the server (i.e. FQDN of the PKI portal). + +#### 4. Generation of NAF specific keys at UE + +The UE verifies that the second part of the realm attribute does correspond to the server it is talking to. In particular, if the messaging is taking place inside a server-authenticated TLS tunnel, the UE verifies that the server name (i.e. FQDN of the PKI portal) in the server's TLS certificate matches the hostname of the server in the realm attribute of the WWW-Authenticate header. + +UE derives the NAF specific key material Ks\_NAF as specified in 3GPP TS 33.220 [1]. + +NOTE 3: If UE does not have a bootstrapped security association available, it will obtain one by running bootstrapping procedure over Ub interface. + +#### 5. Authenticated WIM authentication code request (UE to PKI portal) - see example in table E.3.2-3 + +UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material Ks\_NAF as the password, and sends the request to PKI portal. + +**Table E.3.2-3: Authenticated WIM authentication code request (UE to PKI portal)** + +``` +GET /enrol/wim-auth-code?request=error:AuthReq:123456789ABCDEF:AABBCCDDEE HTTP/1.1 +Host: pkiportal.home1.net:1234 +User-Agent: SCEEnrolmentAgent; Release-6 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@pkiportal.home1.net", +nonce="a6332ffd2d234==", uri="/enrol/wim-auth- +code?request=error:AuthReq:123456789ABCDEF:AABBCCDDEE ", qop=auth-int, nc=00000001, +cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", +opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 +``` + +**Authorization:** This carries the response to the authentication challenge received in step 2 along with the username, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +The qop attribute is set to "auth-int" by default. If the messaging is taking place inside a server-authenticated TLS tunnel, the qop attribute can be set to "auth" as well. + +#### 6. Zn: NAF specific key procedure + +PKI portal retrieves the NAF specific key material (Ks\_NAF) from the BSF. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table E.3.2-4: Bootstrapping authentication information procedure (PKI portal to BSF)** + +| Message source and destination | Zn Information element name | Information Source in GET | Description | +|--------------------------------|-----------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| NAF to BSF | B-TID | Authorization | The bootstrapping transaction identifier (B-TID) is encoded in the username field according to the Authorization protocol. | + +#### 7. Authentication and WIM authentication code generation at NAF + +PKI portal verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_NAF obtained from BSF. The PKI portal calculates the corresponding digest values using Ks\_NAF, and compares the calculated values with the received values in the Authorization header. + +The PKI portal also verifies that the hostname (i.e. its FQDN) in the realm attribute matches its own. If the messaging is taking place inside a server-authenticated TLS tunnel, the PKI portal also verifies that this hostname is the same as that of the TLS server. + +If the verification succeeds, the WIM authentication code is taken in for further processing. The PKI portal continues processing of the WIM authentication code request according to its internal policies. + +NOTE 4: The procedures for generating the WIM authentication code are outside the scope. + +#### 8. Delivery of WIM authentication code (PKI portal to UE) - see example in table E.3.2-5 + +The PKI portal sends 200 OK response to the UE to indicate the success of the authentication and the WIM authentication code generation. The PKI portal generates a HTTP response containing the WIM authentication code. The PKI portal can use key material Ks\_NAF to integrity protect and authenticate the response. + +**Table E.3.2-5: Delivery of WIM authentication code (PKI portal to UE)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/plain +Content-Length: (...) +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", + cnonce="6629fae49394a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + +13579BDF2468ACE +``` + +**Content-Type:** Contains the media type "text/plain". + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the protection + +**Expires:** Gives the date/time after which the response is considered stale. + +#### 9. Authentication, key pair generation, and WIM authentication code request for proof-of-origin generation at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can use the WIM authentication code in the onboard key pair generation with the WIM. + +The WIM in the UE also requires a WIM authentication code for the proof-of-origin generation. + +NOTE 5: It is not mandatory to include the proof-of-origin to certificate request of the enrolment procedure, and the WIM can not require WIM authentication code for generating the proof-of-origin. In these cases, the WIM authentication code is not needed. + +#### 10. Authenticated WIM authentication code request (UE to PKI portal) - see example in table E.3.2-6 + +The UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material Ks\_NAF as the password, and sends the request to PKI portal. + +**Table E.3.2-6: Authenticated WIM authentication code request (UE to PKI portal)** + +``` +GET /enrol/wim-auth-code?request=error:AuthReq:1122334455667788:1122334455 HTTP/1.1 +Host: pkiportal.home1.net:1234 +User-Agent: SCEnrolmentAgent; Release-6 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service +``` + +``` +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@pkiportal.home1.net", +nonce="a6332ffd2d234==", uri="/enrol/wim-auth- +code?request=error:AuthReq:123456789ABCDEF:AABBCCDDEE ", qop=auth-int, nc=00000001, +cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", +opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 +``` + +#### 11. Authentication and WIM authentication code generation at NAF + +PKI portal verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_NAF obtained from BSF. PKI portal calculates the corresponding digest values using Ks\_NAF, and compares the calculated values with the received values in the Authorization header. + +The PKI portal also verifies that the hostname (i.e. its FQDN) in the realm attribute matches its own. If the messaging is taking place inside a server-authenticated TLS tunnel, the PKI portal also verifies that this hostname is the same as that of the TLS server. + +If the verification succeeds, the WIM authentication code is taken in for further processing. The PKI portal continues processing of the WIM authentication code request according to its internal policies. + +NOTE 6: The procedures for generating the WIM authentication code are outside the scope. + +#### 12. Delivery of WIM authentication code (PKI portal to UE) - see example in table E.3.2-7 + +The PKI portal sends 200 OK response to the UE to indicate the success of the authentication and the WIM authentication code generation. The PKI portal generates a HTTP response containing the WIM authentication code. The PKI portal can use key material Ks\_NAF to integrity protect and authenticate the response. + +**Table E.3.2-7: Delivery of WIM authentication code (PKI portal to UE)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/plain +Content-Length: (...) +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", +cnonce="6629fae49393a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + +FFEDDDCCBBAA998877665544 +``` + +**Content-Type:** Contains the media type "text/plain". + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the protection + +**Expires:** Gives the date/time after which the response is considered stale. + +#### 13. Authentication, proof-key-origin key pair generation, and PKCS#10 generation at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can use the WIM authentication code in the proof-of-origin generation with the WIM. + +The WIM in the UE also requires a WIM authentication code for the proof-of-origin generation. + +NOTE 7: It is not mandatory to include the proof-of-origin to certificate request of the enrolment procedure, and the WIM can not require WIM authentication code for generating the proof-of-origin. In these cases, the WIM authentication code is not needed. + +#### 14. Authenticated enrolment request (UE to PKI portal) - see example in table E.3.2-8 + +UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material Ks\_NAF as the password, and sends the request to PKI portal. + +**Table E.3.2-8: Authenticated enrolment request (UE to PKI portal)** + +``` + +POST /enrol?response=single HTTP/1.1 +Host: pkiportal.home1.net:1234 +Content-Type: application/pkcs10 +Content-Length: (...) +User-Agent: SCEnrolmentAgent; Release-6 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@pkiportal.home1.net", + nonce="a6332ffd2d234==", uri="/enrol?response=single", qop=auth-int, nc=00000002, + cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 + +----- BEGIN CERTIFICATE REQUEST ----- + +----- END CERTIFICATE REQUEST ----- + +``` + +**Authorization:** This carries the response to the authentication challenge received in step 2 along with the username, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +The qop attribute is set to "auth-int" by default. If the messaging is taking place inside a server-authenticated TLS tunnel, the qop attribute can be set to "auth" as well. + +#### 15. Authentication and certificate generation at PKI portal + +PKI portal verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_NAF obtained from BSF. PKI portal calculates the corresponding digest values using Ks\_NAF, and compares the calculated values with the received values in the Authorization header. + +The PKI portal also verifies that the hostname (i.e. its FQDN) in the realm attribute matches its own. If the messaging is taking place inside a server-authenticated TLS tunnel, the PKI portal also verifies that this hostname is the same as that of the TLS server. + +If the verification succeeds, the incoming client-payload request is taken in for further processing. The PKI portal continues processing of the PKCS#10 request according to its internal policies. + +NOTE 8: The procedures for generating the subscriber certificate are outside the scope. + +#### 16. Delivery of subscriber certificate (PKI portal to UE) - see example in table E.3.2-9 + +The PKI portal sends 200 OK response to the UE to indicate the success of the authentication and the subscriber certificate enrolment. The PKI portal generates a HTTP response containing the enrolled subscriber certificate. The PKI portal can use key material Ks\_NAF to integrity protect and authenticate the response. + +**Table E.3.2-9: Delivery of subscriber certificate (PKI portal to UE)** + +``` + +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Content-Type: application/x-x509-user-cert +Content-Length: (...) +Authentication-Info: qop=auth-int, rspauth="6629fae49393a05397450978507c4ef1", + cnonce="6629fae49393a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + +----- BEGIN CERTIFICATE ----- + +----- END CERTIFICATE ----- + +``` + +**Content-Type:** Contains the media type "application/x-x509-user-cert", i.e. X.509 certificate. + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the protection + +**Expires:** Gives the date/time after which the response is considered stale. + +#### 17. Authentication at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can accept the subscriber certificate for further processing. + +## --- E.4 Signalling flows demonstrating a failure in subscriber certificate enrolment + +The signalling flow in figure E.3.1-1 describes the message exchange between UE and PKI portal using HTTP Digest Authentication. This clause describes a failure in the subscriber certificate enrolment, related to PKI procedures. Thus, it assumed that subscriber certificate enrolment procedure has proceeded to step 6 as described in subclause E.3.1. + +### 6. Authentication and certificate generation at PKI portal + +The verification procedures described in subclause E.3.1 step 6 are successfully completed. + +The PKI portal encounters an error during the internal enrolment procedure. For example, the PKI portal is not allowed to issue a certificate to the subscriber due operator's internal policies, i.e. the subscriber's profile in the HSS indicates that the enrolment is not allowed. + +### 7. Error notification (PKI portal to UE) - see example in table E.4-1 + +The PKI portal sends 403 Forbidden response to the UE to indicate that the subscriber certificate enrolment is not allowed. The PKI portal generates a HTTP response containing the error notification. The PKI portal can use key material Ks\_NAF to authenticate the response. + +**Table E.4-1: Error notification (PKI portal to UE)** + +``` +HTTP/1.1 403 Forbidden +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", +cnonce="6629fae49393a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT +``` + +**Authentication-Info:** This carries the protection + +**Expires:** Gives the date/time after which the response is considered stale. + +#### 8. Authentication at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE is notified of the failure of the subscriber certificate enrolment. + +## --- E.5 Signalling flows demonstrating a successful CA certificate delivery + +The signalling flow in figure E.5-1 describes the message exchange between UE and PKI portal when UE requests a CA certificate delivery. The messaging can take place inside a server-authenticated TLS (as described in the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]) tunnel in which case TLS session has been established before step 1. + +![Sequence diagram showing successful CA certificate delivery between UE, PKI portal, and BSF.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PKI as PKI portal + participant BSF + UE->>PKI: 1. Initial get request + PKI-->>UE: 2. 401 Unauthorized + Note left of UE: 3. Generation of NAF +specific key material + UE->>PKI: 4. Authenticated get request + PKI->>BSF: 5. Zn interface + BSF->>PKI: + Note right of PKI: 6. Authentication + PKI-->>UE: 7. Delivery of CA certificate + Note left of UE: 8. Authentication and +response verification + +``` + +The diagram illustrates the interaction for successful CA certificate delivery. It starts with the UE sending an 'Initial get request' to the PKI portal. The PKI portal responds with '401 Unauthorized'. Simultaneously, the UE generates 'NAF specific key material'. The PKI portal performs 'Authentication' and communicates with the BSF via a 'Zn interface'. Upon successful authentication, the PKI portal sends an 'Authenticated get request' to the UE, followed by the 'Delivery of CA certificate'. Finally, the UE performs 'Authentication and response verification'. + +Sequence diagram showing successful CA certificate delivery between UE, PKI portal, and BSF. + +**Figure E.5-1: Successful CA certificate delivery.** + +### **1. Initial get request (UE to PKI portal) - see example in table E.5-1** + +The UE sends an HTTP request to the PKI portal requesting the delivery of CA certificate. + +**Table E.5-1: Initial get request (UE to PKI portal)** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 GET /getcertificate?in=aabbccdd== HTTP/1.1 Host: pkiportal.home1.net:1234 User-Agent: SCEnrolmentAgent; Release-6 Date: Thu, 08 Jan 2004 10:50:35 GMT Accept: */* Referer: http://pkiportal.home1.net:1234/service
| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Request-URI:** The Request-URI (the URI that follows the method name, "GET", in the first line) indicates the resource indication of this GET request. The Request-URI contains the parameter "in" (i.e. issuer name) which is set to the Base64 encoding of the DER encoded Issuer field of the X.509 certificate. + +**Host:** Specifies the Internet host and port number of the PKI portal server, obtained from the original URI given by referring resource. + +**User-Agent:** Contains information about the user agent originating the request. + +**Date:** Represents the date and time at which the message was originated. + +**Accept:** Media types which are acceptable for the response. + +**Referer:** Allows the user agent to specify the address (URI) of the resource from which the URI for the PKI portal was obtained. + +NOTE 1: This step is used to trigger the GBA-based authentication between the UE and the PKI portal. + +### 2. 401 Unauthorized response (PKI portal to UE) - see example in table E.5-2 + +The PKI portal responds with HTTP response code 401 "Unauthorized" which contains a WWW-Authenticate header. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +**Table E.5-2: 401 Unauthorized response (PKI portal to UE)** + +``` +HTTP/1.1 401 Unauthorized +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 10:50:35 GMT +WWW-Authenticate: Digest realm="3GPP-bootstrapping@pkiportal.home1.net", + nonce="6629fae49393a05397450978507c4ef1", algorithm=MD5, qop="auth,auth-int", + opaque="5ccc069c403ebaf9f0171e9517f30e41" +``` + +**Server:** Contains information about the software used by the origin server (PKI portal). + +**Date:** Represents the date and time at which the message was originated. + +**WWW-Authenticate:** The PKI portal challenges the user. The header instructs the UE to use HTTP Digest Authentication with a bootstrapped security association. + +The options for the quality of protection (qop) attribute is by default "auth-int" meaning that the payload of the following HTTP requests and responses should integrity protected. If the messaging is taking place inside a server-authenticated TLS tunnel, the options for the qop attribute can also contain "auth" meaning that the payload of the following HTTP requests and responses are not protected by HTTP Digest. The integrity protection is handled on the TLS layer instead. + +The realm attribute contains two parts delimited by "@" sign. The first part is a constant string "3GPP-bootstrapping" instructing the UE to use a bootstrapped security association. The second part is the host of the server (i.e. the FQDN of the PKI portal). + +### 3. Generation of NAF specific keys at UE + +The UE verifies that the second part of the realm attribute does correspond to the server it is talking to. In particular, if the messaging is taking place inside a server-authenticated TLS tunnel, the UE verifies that the server name (i.e. FQDN of the PKI portal) in the server's TLS certificate matches the hostname of the server in the realm attribute of the WWW-Authenticate header. + +UE derives the NAF specific key material Ks\_NAF as specified in 3GPP TS 33.220 [1]. + +NOTE 2: If UE does not have a bootstrapped security association available, it will obtain one by running bootstrapping procedure over Ub interface. + +#### 4. Authenticated get request (UE to PKI portal) - see example in table E.5-3 + +UE generates the HTTP request by calculating the Authorization header values using the bootstrapping transaction identifier B-TID it received from the BSF as the username and the NAF specific key material Ks\_NAF (base64 encoded) as the password, and sends the request to PKI portal. + +**Table E.5-3: Authenticated get request (UE to PKI portal)** + +``` +GET /getcertificate?in=aabbccdd== HTTP/1.1 +Host: pkiportal.home1.net:1234 +User-Agent: SCEEnrolmentAgent; Release-6 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Accept: */* +Referer: http://pkiportal.home1.net:1234/service +Authorization: Digest username="(B-TID)", realm="3GPP-bootstrapping@pkiportal.home1.net", + nonce="a6332ffd2d234==", uri="/getcertificate?in=aabbccdd==", qop=auth-int, nc=00000001, + cnonce="6629fae49393a05397450978507c4ef1", response="6629fae49393a05397450978507c4ef1", + opaque="5ccc069c403ebaf9f0171e9517f30e41", algorithm=MD5 +``` + +**Authorization:** This carries the response to the authentication challenge received in step 2 along with the username, the realm, the nonce, the URI, the qop, the NC, the cnonce, the response, the opaque, and the algorithm. + +The qop attribute is set to "auth-int" by default. If the messaging is taking place inside a server-authenticated TLS tunnel, the qop attribute can be set to "auth" as well. + +NOTE 3: If step 1 was a GET request then this request would also be GET request and contain the same Request-URI in the HTTP request as was carried in step 1. + +#### 5. Zn: NAF specific key procedure + +PKI portal retrieves the NAF specific key material (Ks\_NAF) from the BSF. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table E.5-4: Bootstrapping authentication information procedure (PKI portal to BSF)** + +| Message source and destination | Zn Information element name | Information Source in GET | Description | +|--------------------------------|-----------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| NAF to BSF | B-TID | Authorization | The bootstrapping transaction identifier (B-TID) is encoded in the username field according to the Authorization protocol. | + +#### 6. Authentication at PKI portal + +PKI portal verifies the Authorization header by using the bootstrapping transaction identifier B-TID and the key material Ks\_NAF obtained from BSF. PKI portal calculates the corresponding digest values using Ks\_NAF, and compares the calculated values with the received values in the Authorization header. + +The PKI portal also verifies that the hostname (i.e. its FQDN) in the realm attribute matches its own. If the HTTP messaging is taking place inside a server-authenticated TLS tunnel, the PKI portal also verifies that this hostname is the same as that of the TLS server. + +If the verification succeeds, the incoming client-payload request is taken in for further processing, i.e. the PKI portal sends the requested CA certificate to the UE. + +#### 7. Delivery of CA certificate (PKI portal to UE) – see example in table E.5-5 + +The PKI portal sends 200 OK response to the UE to indicate the success of the authentication. The PKI portal generates a HTTP response containing the requested CA certificate. The PKI portal use the key material Ks\_NAF to integrity protect and authenticate the response. + +**Table E.5-5: Delivery of CA certificate (PKI portal to UE)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Content-Type: application/x-x509-ca-cert +Content-Length: (...) +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", +cnonce="6629fae49394a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +Expires: Fri, 09 Jan 2004 10:50:36 GMT + +----- BEGIN CERTIFICATE ----- + +----- END CERTIFICATE ----- +``` + +**Content-Type:** Contains the media type "application/x-x509-ca-cert", i.e. X.509 CA certificate. + +**Content-Length:** Indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient. + +**Authentication-Info:** This carries the protection. + +**Expires:** Gives the date/time after which the response is considered stale. + +#### 8. Authentication and response verification at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE can accept the CA certificate for further processing. + +## --- E.6 Signalling flows demonstrating a failure in CA certificate delivery + +The signalling flow in figure E.5-1 describes the message exchange between UE and PKI portal when UE requests a CA certificate delivery. This clause describes a failure in the CA certificate delivery. It assumed that CA certificate delivery procedure has proceeded to step 6 as described in clause E.5. + +### 6. Authentication at PKI portal + +The verification procedures described in clause E.5 step 6 are successfully completed. + +The PKI portal discovers that it does not have the requested CA certificate. + +### 7. Error notification (PKI portal to UE) - see example in table E.6-1 + +The PKI portal sends 404 Not Found response to the UE to indicate that the requested CA certificate is not found in the PKI portal. The PKI portal can use key material Ks\_NAF to authenticate the response. + +**Table E.6-1: Error notification (PKI portal to UE)** + +``` +HTTP/1.1 404 Not Found +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Content-Type: text/html +Authentication-Info: qop=auth-int, rspauth="6629fae49394a05397450978507c4ef1", +cnonce="6629fae49394a05397450978507c4ef1", nc=00000001 +Date: Thu, 08 Jan 2004 10:50:35 GMT +``` + +**Authentication-Info:** This carries the protection + +### 8. Authentication and response verification at UE + +The UE receives the response and verifies the Authentication-Info header. If the verification succeeds, the UE is notified of the failure of the CA certificate delivery. + +# --- Annex F (informative): Signalling flows for PSK TLS with bootstrapped security association + +## F.1 Scope of signalling flows + +This annex gives examples of signalling flows for using PSK TLS with bootstrapped security association. + +## --- F.2 Introduction + +### F.2.1 General + +A bootstrapping session established using a bootstrapping procedure (cf., clause 4 and annex A) is used between a UE and a NAF. The BSF provides to the NAF a NAF specific key material (Ks\_NAF or Ks\_ext\_NAF and optionally Ks\_int\_NAF) which is derived from the key material (Ks). The NAF uses this key to authenticate and optionally secure (i.e. integrity protect and encrypt) the communications between it and the UE. The BSF will also provide the NAF the expiration time of the bootstrapping session. When the bootstrapping session becomes invalid the NAF will stop using the session, and indicate to the UE that bootstrapping session has expired and that new session needs to be established. + +An example of the signalling flows of the authentication procedure using PSK TLS is given in clause F.3. + +### F.2.2 Key required to interpret signalling flows + +The following key (rules) have been applied to TLS handshake signalling flows to improve readability, reduce errors and increase maintainability: + +- a) The description of TLS messages and their fields are identified by three fields: "TLS.MESSAGE.FIELD": + - "TLS" identifies that the message is a TLS message; + - "MESSAGE" identifies the name of the TLS message (e.g. ClientHello); + - "FIELD" identifies the name of the TLS message field (e.g. client\_version). + +An example being "TLS.ClientHello.client\_version", which identifies TLS message "ClientHello" and its data field "client\_version". The possible TLS message and TLS message field names as well as their encoding to the TLS protocol are specified in IETF TLS related specifications as defined in annex E of 3GPP TS 33.310 [25]. + +- b) If multiple TLS messages are sent in sequence from one entity to another this is described as one step. + - the figures describe the sending of multiple TLS messages in one step by listing the TLS message names in separate lines; + - the description of the step contains the explanation of the messages and their parameters as described in bullet a). +- c) In order to differentiate between TLS messages and other protocol messages, the TLS messages are marked with simple arrow line, and all *non-TLS* messages with block arrows. +- d) The flows show the signalling exchanges between the following functional entities: + - User Equipment (UE); + - Bootstrapping Server Function (BSF); + - Network Application Function (NAF). + +## F.3 Signalling flow demonstrating a successful PSK TLS authentication procedure + +The signalling flow in figure F.3-1 describes the generic message exchange between UE and NAF using PSK TLS. In this example, the PSK TLS client application resides in the ME, i.e., either Ks\_NAF or Ks\_ext\_NAF is used as the key. + +![Sequence diagram of PSK TLS handshake with bootstrapped security association between UE, NAF, and BSF.](74d23510f27b21403a7be84820821863_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + + UE->>NAF: (1) ClientHello(PSK-based ciphersuites) + NAF-->>UE: (2) ServerHello(PSK-based ciphersuite) +ServerKeyExchange(PSK identity hint) +ServerHelloDone + Note over UE: (3) Bootstrapping and generation +of NAF specific key material + UE->>NAF: (4) ClientKeyExchange(PSK identity) +ChangeCipherSpec +Finished + NAF->>BSF: (5) Zn interface + BSF-->>NAF: + Note over NAF: (6) Authentication + NAF-->>UE: (7) ChangeCipherSpec +Finished + Note over UE: (8) Authentication + UE->>NAF: (9) Application Data + +``` + +The diagram illustrates the signalling flow for a PSK TLS handshake. It involves three main entities: UE (User Equipment), NAF (Network Application Function), and BSF (Bootstrap Server Function). The process starts with the UE sending a ClientHello message to the NAF (1). The NAF responds with ServerHello, ServerKeyExchange, and ServerHelloDone (2). A bootstrapping step occurs at the UE (3). The UE then sends ClientKeyExchange, ChangeCipherSpec, and Finished messages to the NAF (4). The NAF interacts with the BSF via a Zn interface (5) for authentication (6). The NAF then sends ChangeCipherSpec and Finished messages to the UE (7). The UE performs its own authentication (8). Finally, application data is exchanged between the UE and the NAF (9). + +Sequence diagram of PSK TLS handshake with bootstrapped security association between UE, NAF, and BSF. + +**Figure F.3-1: PSK TLS handshake with bootstrapped security association.** + +### 1. TLS handshake message: ClientHello (UE to NAF) + +The UE sends ClientHello message to the NAF. In order to indicate that the UE is capable of PSK-based authentication it includes the PSK-based ciphersuites to the list of acceptable ciphersuites list. The UE also includes to the ClientHello message the server\_name TLS extension containing the hostname of the NAF. + +**TLS.ClientHello.client\_version:** the version of the TLS protocol in the UE is 3.1. + +**TLS.ClientHello.random:** a UE generated random structure. + +**TLS.ClientHello.session\_id:** the ID of the TLS session is empty, i.e. no previous TLS session is used. + +**TLS.ClientHello.cipher\_suites:** the list of ciphersuites includes one or more PSK-based ciphersuites. + +**TLS.ClientHello.compression\_methods:** a list of the compression methods is null. + +**TLS.ClientHello.client\_hello\_extension\_list:** list of extensions includes server\_name extension that contains the hostname of the NAF. + +### 2. TLS handshake messages: ServerHello, ServerKeyExchange, ServerHelloDone (NAF to UE) + +If the NAF wants to use PSK-based authentication, it selects one of the acceptable PSK-based ciphersuites, places the selected ciphersuite in the ServerHello message, and includes an appropriate ServerKeyExchange message. The NAF can help the UE in selecting the correct PSK identity by providing a list of hints in ServerKeyExchange message. That list includes a static string "3GPP-bootstrapping ". + +**TLS.ServerHello.server\_version:** the version of the TLS protocol in the NAF is 3.1. + +**TLS.ServerHello.random:** a NAF generated random (must be different from ClientHello.random). + +**TLS.ServerHello.session\_id:** the identity of the TLS session generated by the NAF. + +**TLS.ServerHello.cipher\_suite:** the ciphersuite selected by the NAF is one of the PSK-based ciphersuites listed in ClientHello.cipher\_suites. + +**TLS.ServerHello.compression\_method:** the compression method selected by the NAF is null. + +**TLS.ServerHello.server\_hello\_extension\_list:** list of extensions is empty. + +**TLS.ServerKeyExchange.psk\_identity\_hint:** the PSK identity hint contains the constant string "3GPP-bootstrapping". + +**TLS.ServerHelloDone:** this message does not have data fields. + +### 3. Bootstrapping and generation of NAF specific key material at UE + +The UE performs the bootstrapping procedure to produce B-TID and Ks(ext)\_NAF as described in clause A.3. If bootstrapping procedure has been done recently, the UE can use the B-TID and Ks(ext)\_NAF produced from that procedure. + +### 4. TLS handshake messages: ClientKeyExchange, ChangeCipherSpec, Finished (UE to NAF) + +The UE sets concatenated "3GPP-bootstrapping" string, separator character ";" and the B-TID as the PSK identity, and Ks(ext)\_NAF as the pre-shared key. The UE then sends ClientKeyExchange containing the B-TID, ChangeCipherSpec, and Finished messages to the NAF. The TLS premaster secret is derived from Ks(ext)\_NAF. + +**TLS.ClientKeyExchange.psk\_identity:** the PSK identity contains concatenated "3GPP-bootstrapping" string, separator character ";" and the B-TID. + +**TLS.ChangeCipherSpec.type:** contains value 1 (change\_cipher\_spec). + +**TLS.Finished.verify\_data:** the verify data contains the hash of the handshake messages. For details, see the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]. + +### 5. Zn: NAF specific key procedure + +The NAF extracts the B-TID from the ClientKeyExchange message and requests the NAF specific key (Ks\_NAF or Ks\_ext\_NAF) from BSF. The BSF returns the NAF specific key that corresponds to the B-TID. + +If the NAF retrieved an application-specific USS and it contained a keyChoice indication, the NAF must enforce this indication. Hence, if the UICC-based key was indicated the NAF must terminate the communication with the UE in this phase. + +NOTE: If the local configuration in the NAF restricts the access to this NAF service to UICC-based applications, then the NAF will terminate the communication with the UE in this phase. + +For detailed signalling flows see 3GPP TS 29.109 [3]. + +**Table F.3-1: Bootstrapping authentication information procedure (NAF to BSF)** + +| Message source and destination | Zn Information element name | Information Source in TLS | Description | +|--------------------------------|-----------------------------|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| NAF to BSF | B-TID | ClientKeyExchange.psk_identity | The bootstrapping transaction identifier (B-TID) is encoded in the ClientKeyExchange.psk_identity field according to PSK TLS. | + +### 6. Authentication at NAF + +The NAF validates the Finished message sent by the UE. + +### 7. TLS handshake messages: ChangeCipherSpec, Finished (NAF to UE) + +The NAF sends ChangeCipherSpec, and Finished messages to the UE. + +**TLS.ChangeCipherSpec.type:** contains value 1 (change\_cipher\_spec). + +**TLS.Finished.verify\_data:** the verify data contains the hash of the handshake messages. For details, see the RFC for TLS defined in annex E of 3GPP TS 33.310 [25]. + +### 8. Authentication at UE + +The UE validates the Finished message sent by the NAF. + +### 9. Application data transfer + +The UE and the NAF initiate application data transfer in the TLS session. + +# Annex G (normative): 3GPP specific extension-headers for HTTP entity-header fields + +## G.1 General + +This annex defines the syntax of 3GPP specific extension-headers introduced in this document in augmented Backus-Naur form as defined in RFC 2234 [22]. + +## G.2 X-3GPP-Intended-Identity extension-header + +The "X-3GPP-Intended-Identity" header is used optionally by the UE to indicate the user identity intended to be used with the AS. It contains the user identity surrounded by quotation marks ("). + +**Table G.2: Syntax of X-3GPP-Intended-Identity extension-header** + +``` +X-3GPP-Intended-Identity = "X-3GPP-Intended-Identity" ":" DQUOTE identity DQUOTE +identity = *(%x20-21 / %x23-7E) +``` + +In the syntax definition the rule 'identity' refers to the user identity and it is defined as a string of printable characters and spaces but excluding quotation marks. The exact type definition for 'identity' is done in TS 29.109 [3] as part of the User Security Setting definition (as the uid tag in the XML scheme definition). + +## G.3 X-3GPP-Asserted-Identity extension-header + +Depending on the subscriber's GBA user security settings the "X-3GPP-Asserted-Identity" header is used by the AP to indicate an asserted identity or a list of identities to the AS. It contains a list of identities separated by comma (,) and each identity is surrounded by quotation marks ("). + +**Table G.3: Syntax of X-3GPP-Asserted-Identity extension-header** + +``` +X-3GPP-Asserted-Identity = "X-3GPP-Asserted-Identity" ":" identity-list +identity-list = DQUOTE identity DQUOTE *("," DQUOTE identity DQUOTE) +identity = *(%x20-21 / %x23-7E) +``` + +In the syntax definition the rule 'identity' refers to the user identity and it is defined as a string of printable characters and spaces but excluding quotation marks. The exact type definition for 'identity' is done in TS 29.109 [3] as part of the User Security Setting definition (as the uid tag in the XML scheme definition). + +## G.4 X-3GPP-Authorization-Flags extension-header + +The "X-3GPP-Authorization-Flags" header is used optionally by the AP to indicate an authorization flag or a list of authorization flags from the application specific user security setting (USS) to the AS. It contains a list of authorization flags separated by comma (,) and each authorization flag is surrounded by quotation marks ("). + +**Table G.4: Syntax of X-3GPP-Authorization-Flags extension-header** + +``` +X-3GPP-Authorization-Flags = "X-3GPP-Authorization-Flags" ":" auth-flag-list +auth-flag-list = DQUOTE auth-flag DQUOTE *("," DQUOTE auth-flag DQUOTE) +auth-flag = *(%x20-21 / %x23-7E) +``` + +In the syntax definition the rule 'auth-flag' refers to the authorization flag and it is defined as a string of printable characters and spaces but excluding quotation marks. The exact type definition for authorization flag is done in TS 29.109 [3] as part of the User Security Setting definition. + +# Annex H (normative): 2G GBA + +## H.1 Introduction + +This annex specifies the implementation option to allow the use of SIM cards or SIMs on UICC for GBA. The procedure specified in this annex is called 2G GBA. 2G GBA allows access to applications in a more secure way that would be possible with the use of password or with GSM without enhancements. Stage 2 level details for 2G GBA has been specified in 3GPP TS 33.220 [1], Annex I. + +## H.2 2G GBA bootstrapping procedure + +A UE and the BSF shall establish a bootstrapped security association between them by running the 2G GBA bootstrapping procedure. The bootstrapping security association consists of a bootstrapping transaction identifier (B-TID) and key material Ks. Bootstrapping session on the BSF also includes security related information about subscriber (e.g. user's private identity). Bootstrapping session is valid for a certain time period, and shall be deleted in the BSF when the session becomes invalid. + +It shall be possible that the BSF is configured to either allow or disallow the use of 2G GBA bootstrapping. If 2G GBA is disallowed, the BSF shall not start the TLS handshake with the UE as described below. + +The 2G GBA Bootstrapping procedure as specified in 3GPP TS 33.220 [1] is further detailed as described below. + +- Authorization, WWW-Authenticate, and Authentication-Info HTTP headers shall be used as described in RFC 3310 [6] with following exceptions: + - a) the "realm" parameter shall contain the FQDN of the BSF. The UE shall check that the "realm" attribute contains the same FQDN of the BSF that was present in the BSF certificate. + - b) the quality of protection ("qop") parameter shall be "auth-int". + - c) the "username" parameter shall contain user's private identity (IMPI) which has been derived from the IMSI of the SIM application as specified in 3GPP TS 23.003 [7]. + - d) the "nonce" field shall be populated as specified in 3GPP TS 33.220 [1], Annex H with + - the "RAND" which is the RAND of the 2G authentication vector, and + - the "AUTN" which is a 128-bit zero number, and + +- the "server specific" data is a 128-bit random number "Ks-input" generated by the BSF. +- the "RES" which is used as the password is derived as specified in 3GPP TS 33.220 [1], Annex H. + +In addition to RFC 3310 [6], the following apply: + +- a) In the initial request from the UE to the BSF, the UE shall include Authorization header with following parameters: + - the username directive, set to the value of the private user identity IMPI derived from the IMSI of the SIM according to 3GPP TS 23.003 [7]; + - the realm directive, set to the BSF address derived from the IMSI of the SIM according to 3GPP TS 23.003 [7]; + - the uri directive, set to either absoluteURL "https:///" or abs\_path "/", and which one is used is specified in RFC 2617 [9]; + - the nonce directive, set to an empty value; and + - the response directive, set to an empty value; +- b) In the challenge response from the BSF to the UE, the BSF shall include parameters to WWW-Authenticate header as specified in RFC 3310 [6] with following clarifications: + - the realm directive, set to the BSF address derived from the IMSI of the SIM according to 3GPP TS 23.003 [7]; +- c) In the message from the BSF to the UE, the BSF shall include bootstrapping transaction identifier (B-TID) and the key lifetime to an XML document in the HTTP response payload. The BSF may also include additional server specific data to the XML document. The XML schema definition of this XML document is given in Annex C. +- d) Authentication-Info header shall be included into the subsequent HTTP response after the BSF concluded that the UE has been authenticated. Authentication-Info header shall include the "rspauth" parameter. + +After successful bootstrapping procedure the UE and the BSF shall contain the key material (Ks) and the B-TID. The key material shall be derived from AKA parameters as specified for 2G GBA in 3GPP TS 33.220 [1]. In addition, BSF shall also contain a set of security specific attributes (GUSS) related to the UE. + +## H.3 User authentication failure + +If the response returned by the UE is different than expected, the BSF may challenge the UE again with a new AKA challenge using a new 2G authentication vector. After N consecutive incorrect responses from the UE, the BSF shall indicate a failure to the UE. The exact value of N is defined by local policy. + +## H.4 Network authentication failure + +In case the UE fails at authenticating the network, the UE shall abort the bootstrapping procedure. + +# Annex I (normative): GBA\_Digest + +## I.1 Introduction + +This annex specifies the implementation option to use SIP Digest credentials for GBA. The procedure specified in this annex is called GBA\_Digest. GBA\_Digest allows access to applications in a more secure way that would be possible with the use of password based HTTP Digest. Stage 2 level description for GBA\_Digest has been specified in 3GPP TS 33.220 [1], annex M. + +## I.2 GBA\_Digest bootstrapping procedure + +A UE and the BSF shall establish a bootstrapped security association between them by running the GBA\_Digest bootstrapping procedure. The bootstrapping security association consists of a bootstrapping transaction identifier (B-TID) and key material Ks. A Bootstrapping session on the BSF also includes security related information about the subscriber (in particular the user's private identity). A Bootstrapping session is valid for a certain time period, and shall be deleted in the BSF when the session becomes invalid. + +The UE shall establish a TLS connection with the BSF prior to sending any HTTP request to the BSF. + +A UE shall indicate to the BSF that it intends to run GBA\_Digest as defined in 3GPP TS 33.220 [1] by including a "product" token in the "User-Agent" header field (cf. RFC 2616 [14]) that is set to a static string "GBA\_Digest" in HTTP requests sent to the BSF. The BSF is configured to either allow or disallow the use of GBA\_Digest bootstrapping. If GBA\_Digest is disallowed, the BSF shall reject the HTTP request by the UE. + +The GBA\_Digest Bootstrapping procedure as specified in 3GPP TS 33.220 [1] is further detailed as described below. + +- Authorization, WWW-Authenticate, and Authentication-Info HTTP header fields shall be used as described in RFC 2617 [9] with following exceptions: + - a) the "realm" parameter shall be set to the domain name of the home network; + - b) the quality of protection ("qop") parameter shall be "auth-int"; + - c) the "username" parameter shall contain user's private identity; + - d) the "nonce" field shall be populated as specified in 3GPP TS 33.220 [1], annex M with a random number generated by the BSF according to RFC 2617 [9]; and +- a password, which is called "passwd" and is derived as specified in 3GPP TS 33.220 [1], annex M. + +In addition to RFC 2617 [9], the following apply: + +- a) in the initial request from the UE to the BSF, the UE shall include an Authorization header field with following parameters: + - the uri directive, set to either absoluteURL "https:///" or abs\_path "/", and which one is used is specified in RFC 2617 [9]; + - the nonce directive, set to an empty value; + - the response directive, set to an empty value; +- b) in the HTTP response containing the Digest challenge from the BSF to the UE, the BSF shall include parameters to WWW-Authenticate header field as specified in RFC 2617 [9]; +- c) in the HTTP request sent as an answer to the HTTP response in bullet b) the UE shall include an Authorization header field that contains a digest-response, "cnonce", and "nonce-count" header field parameters as specified in RFC 2617 [9], and + - the uri directive, set to either absoluteURL "https:///" or abs\_path "/", and which one is used is specified in RFC 2617 [9]; + +- the nonce directive, set to an empty value; and +- d) in the message from the BSF to the UE, which the BSF shall only send after the BSF concluded that the UE has been authenticated, the BSF shall include an Authentication-Info header with the "rspauth" parameter. Furthermore, the BSF shall include the bootstrapping transaction identifier (B-TID) and the key lifetime to an XML document in the HTTP response payload. The BSF may also include additional server specific data to the XML document. The XML schema definition of this XML document is given in Annex C. + +After a successful bootstrapping procedure the UE and the BSF shall contain the key material (Ks) and the B-TID. The key material shall be derived from SIP Digest parameters as specified for GBA\_Digest in 3GPP TS 33.220 [1]. In addition, the BSF may also contain a set of security specific attributes (GUSS) related to the UE, depending on the conditions in subclause 4.5.2 of 3GPP TS 33.220 [1]. + +## I.3 User authentication failure + +If the response returned by the UE is different than expected, the BSF may challenge the UE again with a new Digest challenge using the same SIP Digest authentication vector. After N consecutive incorrect responses from the UE, the BSF shall indicate a failure to the UE. The exact value of N is defined by local policy. + +## I.4 Network authentication failure + +In case the UE fails at authenticating the network, the UE shall abort the bootstrapping procedure. + +# --- Annex J (Normative): Realization of GBA Push delivery + +## J.1 Introduction + +The GBA Push procedure is executed in order to establish a bootstrapped security association, i.e. bootstrapping session between a Push-NAF and a UE. The GBA Push service is initiated by delivering GBA Push Information (GPI) to the UE as described in 3GPP TS 33.223 [24]. However, 3GPP TS 33.223 [24] only specifies the GBA Push architecture; this annex specifies how GPI is delivered to the UE using WAP Push without the OMA DM Notification structure. + +## --- J.2 GPI delivery using WAP Push + +### J.2.1 General + +When the GPI data object is delivered using SMS, the Push-NAF and the UE shall use the Push OTA protocol over WSP as defined in OMA's "Push Over the Air" specification [26] for connectionless non-secure push. + +### J.2.2 Push-NAF procedures + +In order to send the GPI via WSP, the Push-NAF shall construct a push message according to OMA's "Push Message Specification" [27] and shall populate the push message as follows: + +- the Content-Type header shall include the MIME media type 'application/vnd.3gpp.gba.gpi' or the corresponding short code as defined in subclause J.3.1.3. +- the X-WAP-Application-ID header shall include the application-id associated with the specific GBA User Agent or the corresponding short code, if available for the application in question. The short code for the identifier of a specific application is defined in the corresponding specification for the application. +- the Session Identifier shall be different between different GBA Push initiated sessions for the same recipient. All messages in the associated OMA DM session shall include the Session identifier as Session ID. +- the message body shall contain the GPI envelope as described in subclause J.3.1.2 with the version field set to 1, the session identifier set by the server, as specified in subclause J.3.1.2, and GPI field set to the GPI. + +NOTE 1: One SMS can carry 140 bytes of information and the GPI message fits into a single SMS when short codes are used for the Content-Type and X-WAP-Application-ID attributes, as described in subclause J.3. When short codes are not defined, or not used, the WAP Push message does not fit into a single SMS message and then concatenated SMS messages are used. + +The general format of the GPI push message within one SMS message is shown as an example in table J.2-1. + +**Table J.2-1: Example of a GPI Push message with header and content in one SMS** + +| Binary Value | Bytes | Meaning Description | +|--------------------------------------------------------------------------------------------------------------|----------------|-----------------------------------------------------------------------------| +| WDP headers starts | | | +| 06 | 1 | User-Data-Header (UDHL) Length = 6 bytes WDP layer | +| 05 | 1 | UDH IE identifier: Port numbers | +| 04 | 1 | UDH port number IE length | +| 0B | 1 | Destination port (high), Port number 2948 | +| 84 | 1 | Destination port (low), Port number 2948 | +| Orig.port | 1 | Originating port (high), Port number freely chosen by sender | +| Orig.port | 1 | Originating port (low), Port number freely chosen by sender | +| End of WDP headers, WSP header starts | | | +| Trans.id | 1 | Transaction ID / Push ID WSP layer | +| 06 | 1 | PDU type (push) | +| 03 | 1 | Headerlength (content type+headers) | +| Cont.Type | e.g. 1, Note 1 | Content type code MIME-Type AF X-WAP-Application-ID, see subclause J.3.1.3. | +| Appl.Id | e.g. 2, Note 2 | Application Id | +| End of WSP header, start of GBA specific information | | | +| 01 | 1 | Version, see subclause J.3.1.2. | +| Sess.Id | 2 | 16 bit integer for Session-ID, see subclause J.3.1.2 | +| | Varying | GPI | +| Note 1: The length depends on the allocated short code; 1-4 bytes. This is 1 byte for OMA DM Notifications. | | | +| Note 2: The length depends on the allocated short code; 2-4 bytes. This is 2 bytes for OMA DM Notifications. | | | + +NOTE 2: If the GPI Push message needs to be sent in more than one SMS, the segmentation information is added in 5 bytes to the WDP headers in each SMS (in total 7+5=12 bytes). The 5 added bytes are Type 0x00, len 0x03, Message Reference Number (byte) for concatenation, Current Segment Number (byte) and Total Segment Count (byte). + +### J.2.3 UE procedures + +#### J.2.3.1 Reception of GPI in push message + +Upon receiving a push message on the IANA registered WDP port 2948 according to OMA's "Push Message Specification" [27] where: + +- the Content-Type header indicates the application/vnd.3gpp.gba.gpi MIME type as defined in subclause J.3.1.4 or the the corresponding short code as defined in subclause J.3.1.3; and +- the X-WAP-Application-ID header indicates an application supported by the UE; + +the UE shall extract GPI from the GPI envelope according to subclause J.3.1, check the integrity of the GPI and use the Application-ID to locate the corresponding application in the UE. The UE uses the content of the push message to establish a connection with the indicated server. All messages in the associated OMA DM session shall include the Session identifier (Session ID) as received from Push-NAF. + +NOTE: As indicated in OMA DM Enabler Release v1.2 [28] it is also possible to send WAP Push messages using some other transport than SMS, if the UE for example does not support SMS. OMA's "Push Message Specification" [27] also specifies OTA-HTTP and OTA-SIP, which can be supported by the UE. + +## J.3 PDUs and parameters specific to the present document + +### J.3.1 GPI envelope + +#### J.3.1.1 General + +This subclause defines the GPI envelope carrying GPI as specified for the GAA bootstrap framework in 3GPP TS 33.223 [24]. + +#### J.3.1.2 Structure + +The GPI envelope is coded according to figure J.3.1.2-1 and table J.3.1.2-1. + +![](ddcdc1712375261ba1d89165fdf12aa6_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|--------------------|---|---|---|---|---|---|---|---------| +| Version | | | | | | | | octet 1 | +| Session identifier | | | | | | | | octet 2 | +| | | | | | | | | octet 3 | +| GPI | | | | | | | | octet 4 | +| | | | | | | | | octet n | + +Figure J.3.1.2-1: GPI envelope + +Table J.3.1.2-1: GPI envelope + +The version field is in the octet 1. Version field value equal to 1 indicates that the structure is according to this document. Sending entity does not set the version field to a value not defined by this document. Receiving entity ignores any GPI envelope with version field set to unknown value. + +The session identifier field is in the octet 2 and the octet 3. The Session identifier field defines the identifier of the corresponding OMA DM session to be established due to the GBA Push message. The format and content definitions of the Session identifier field shall be the same as for the Session ID component in the OMA DM SYNCML header as specified in OMA Device Management Enabler Release v1.2, see [28]. + +The GPI field is in octets starting from octet 4 til the end of the GPI envelope. + +#### J.3.1.3 GPI envelope short code values + +The GPI envelope defined in table J.3.2-1 indicates the Content-Type in the WSP header. + +Table J.3.2-1: GPI Envelope short code values + +| WSP header attribute | Value | Short code | Descriptions | +|----------------------|------------------------------|-------------|-----------------------------------------| +| Content-Type | application/vnd.3gpp.gba.gpi | To be added | The Content-Type indicates GPI envelope | + +Editor's note: The WSP short code for 'application/vnd.3gpp.gba.gpi' should be requested from Open Mobile Alliance. + +#### J.3.1.4 IANA registration template + +Editor's note: The MIME type "application/vnd.3gpp.gba.gpi" needs to be registered in the IANA registry. + +MIME media type name: + +application + +MIME subtype name: + +Vendor Tree – vnd.3gpp.gba.gpi + +Required parameters: + +None + +Optional parameters: + +None + +Encoding considerations: + +binary + +Security considerations: + +None + +Interoperability considerations: + +This content type provides a format for exchanging information in WAP push message. + +Published specification: + +3GPP TS 24.109 + +() + +Applications which use this media: + +GBA Push + +Intended usage: + +Delivery of GBA Push information + +# Annex K (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|--------------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2004-09 | CN-25 | NP-040423 | | | The draft was approved, and 3GPP TS 24.109 was then to be issued in Rel-6 under formal change control. | 2.1.2 | 6.0.0 | +| 2004-12 | CN-25 | NP-040511 | 001 | 1 | Corrections and clarifications to clause 4 and example flows | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 002 | 1 | Corrections and clarifications to clause 5 and example flows in annex F | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 003 | 1 | Update of Authentication Proxy Procedures | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 005 | | Clarification of Ua usage | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 006 | 1 | Correction of User Agent Header | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 007 | 1 | B-TID transfer | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 008 | 1 | AP signalling flow example | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040511 | 010 | 1 | Editorials | 6.0.0 | 6.1.0 | +| 2004-12 | CN-25 | NP-040512 | 009 | 1 | Authorization flag transfer between AP and AS | 6.0.0 | 6.1.0 | +| 2005-03 | CN-27 | NP-050082 | 011 | 1 | Editorial corrections | 6.1.0 | 6.2.0 | +| 2005-03 | CN-27 | NP-050130 | 012 | 2 | PSK TLS updates | 6.1.0 | 6.2.0 | +| 2005-06 | CP-28 | CP-050066 | 13 | 1 | Format of lifetime values | 6.2.0 | 6.3.0 | +| 2005-06 | CP-28 | CP-050066 | 15 | 1 | User identify reference | 6.2.0 | 6.3.0 | +| 2005-06 | CP-28 | CP-050066 | 16 | | Key material - Ks only | 6.2.0 | 6.3.0 | +| 2005-06 | CP-28 | CP-050066 | 17 | 1 | Usage of Ks_int_NAF | 6.2.0 | 6.3.0 | +| 2005-09 | CP-29 | | | | NAF specific key derivation | 6.3.0 | 6.4.0 | +| | | CP-050364 | 018 | 2 | | | | +| 2005-09 | CP-29 | | | | Missing separator character | 6.3.0 | 6.4.0 | +| | | CP-050364 | 019 | | | | | +| 2005-09 | CP-29 | | | | Ks_int_NAF usage | 6.4.0 | 7.0.0 | +| | | CP-050369 | 20 | 1 | | | | +| 2005-12 | CP-30 | | | | Reference correction | 7.0.0 | 7.1.0 | +| | | CP-050539 | 22 | | | | | +| 2005-12 | CP-30 | | | | 2GGBA | 7.0.0 | 7.1.0 | +| | | CP-050551 | 23 | 1 | | | | +| 2006-03 | CP-31 | | | | Extension of the XML schema | 7.1.0 | 7.2.0 | +| | | CP-060116 | 025 | | | | | +| 2006-03 | CP-31 | | | | Update of Reference PSK TLS | 7.1.0 | 7.2.0 | +| | | CP-060116 | 027 | | | | | +| 2006-06 | CP-32 | | | | Correction of message recipient in table caption | 7.2.0 | 7.3.0 | +| | | CP-060279 | 028 | | | | | +| 2006-09 | CP-33 | | | | Realm parameter on Ub interface | 7.3.0 | 7.4.0 | +| | | CP-060454 | 0032 | 1 | | | | +| 2006-09 | CP-33 | | | | Corrections of BSF examples | 7.3.0 | 7.4.0 | +| | | CP-060454 | 0030 | 1 | | | | +| 2006-11 | CP-34 | | | | Registration of content-type "application/vnd.3gpp.bsf+xml" | 7.4.0 | 7.5.0 | +| | | CP-060657 | 0034 | - | | | | +| 2007-12 | CP-38 | CP-070787 | 0036 | | Interoperability problems for request on Ub reference point | 7.5.0 | 7.6.0 | +| 2008-12 | CP-42 | | | | Upgrade to Rel-8 | 7.6.0 | 8.0.0 | +| 2009-03 | CP-43 | CP-090160 | 0037 | 2 | Introduction of GBA Push within TS 24.109 – Upa Interface | 8.0.0 | 8.1.0 | +| 2009-06 | CP-44 | CP-090425 | 0038 | | Correction of key material on Upa Interface | 8.1.0 | 8.2.0 | +| 2009-06 | CP-44 | CP-090424 | 0039 | | Invalid XML schema bug fix | 8.1.0 | 8.2.0 | +| 2009-12 | CP-46 | | | | Upgrade to Rel-9 | 8.2.0 | 9.0.0 | +| 2010-06 | CP-18 | CP-100351 | 0041 | | Privacy for Private User Identity on Ub | 9.0.0 | 9.1.0 | +| 2011-03 | CP-51 | | | | Upgrade to Rel-10 | 9.1.0 | 10.0.0 | +| 2011-09 | CP-53 | CP-110650 | 0046 | | Updating of references to 24.228 | 10.0.0 | 10.1.0 | + +| Change history | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|-------------------------------------------------------------------------------------------|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2012-06 | CP-56 | CP-120321 | 0047 | 1 | GBA_Digest procedures for 24.109 | 10.1.0 | 11.0.0 | +| 2012-06 | CP-56 | CP-120307 | 0048 | 1 | Correct TLS version | 10.1.0 | 11.0.0 | +| 2012-09 | CP-57 | CP-120598 | 0049 | | Qop for GBA_Digest | 11.0.0 | 11.1.0 | +| 2012-09 | CP-57 | CP-120598 | 0050 | 1 | GBA_Digest procedures for Ua interface | 11.0.0 | 11.1.0 | +| 2012-09 | CP-57 | CP-120583 | 0051 | 1 | Update references for TLS Extensions and PSK cyphersuites | 11.0.0 | 11.1.0 | +| 2012-12 | CP-58 | CP-120794 | 0052 | 2 | Realization of GBA Push delivery | 11.1.0 | 11.2.0 | +| 2013-03 | CP-59 | CP-130130 | 0053 | 1 | Correction of header field names in flows | 11.2.0 | 12.0.0 | +| 2013-06 | CP-60 | CP-130265 | 0054 | 1 | Shared key-based UE authentication with certificate-based NAF authentication - compliance | 12.0.0 | 12.1.0 | +| 2013-06 | CP-60 | CP-130265 | 0055 | | Consistent usage of terminology and correction of flows | 12.0.0 | 12.1.0 | +| 2013-06 | CP-60 | CP-130265 | 0056 | | Corrections of references | 12.0.0 | 12.1.0 | +| 2013-12 | CP-62 | CP-130725 | 0062 | 2 | GBA mode selection in NAF | 12.1.0 | 12.2.0 | +| 2014-03 | CP-63 | CP-140132 | 0064 | 1 | Base64 encoding of NAF specific key material | 12.2.0 | 12.3.0 | +| 2015-03 | CP-67 | CP-150082 | 0065 | 2 | Determination of UTC time | 12.3.0 | 13.0.0 | +| 2016-03 | CP-71 | CP-160084 | 0067 | | Adding ability to signal BSF address in psk_identity_hint field for ProSe | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------|--------------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-12 | CP-74 | CP-160752 | 0068 | | F | opaque parameter | 14.0.0 | +| 2018-06 | SA-80 | | | | | Automatic upgrade (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24139/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg b/marked/Rel-16/24_series/24139/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..549a1f9e68f5596ea80f3a8ff5ea9a942fce48d5 --- /dev/null +++ b/marked/Rel-16/24_series/24139/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d4655a0ea89eddfd60110b69d7cd612fe78179e76e41d11e333e65b7cfe1401 +size 20013 diff --git a/marked/Rel-16/24_series/24139/9b62a616c7a1097c5da57f001ab6dd64_img.jpg b/marked/Rel-16/24_series/24139/9b62a616c7a1097c5da57f001ab6dd64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88cc1a14d0466d438d66592a96cdeabdca323690 --- /dev/null +++ b/marked/Rel-16/24_series/24139/9b62a616c7a1097c5da57f001ab6dd64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c7ab56caa90a4c4c4eee5da8328cd923ef060ae75bdb076f3f79d8319ac5e41 +size 18671 diff --git a/marked/Rel-16/24_series/24139/raw.md b/marked/Rel-16/24_series/24139/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..be4c2fca1800890910136ba018c599159386622e --- /dev/null +++ b/marked/Rel-16/24_series/24139/raw.md @@ -0,0 +1,698 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 General..... | 7 | +| 4.1 Support of Fixed Broadband Access Network Interworking..... | 7 | +| 4.2 Network Discovery and Selection..... | 8 | +| 4.2.1 Access network discovery and selection procedures..... | 8 | +| 4.2.2 EPC network selection ..... | 8 | +| 4.2.3 Access network reselection ..... | 8 | +| 4.2.4 Data traffic routing of IP flows ..... | 8 | +| 4.3 UE – EPC Network Protocols ..... | 8 | +| 4.3.1 Trusted and Untrusted Accesses..... | 8 | +| 4.3.2 IP Mobility Mode Selection ..... | 8 | +| 4.3.3 Authentication and Authorization ..... | 8 | +| 5 Supporting QoS..... | 8 | +| 5.1 General ..... | 8 | +| 5.2 UE reflective QoS procedures..... | 9 | +| 5.2.1 General ..... | 9 | +| 5.2.2 DSCP marking rule..... | 9 | +| 5.2.3 Maintaining DSCP marking rules ..... | 9 | +| 5.2.4 Receiving an IP packet..... | 10 | +| 5.2.5 Sending an IP packet ..... | 10 | +| 5.3 Network procedures for supporting QoS ..... | 10 | +| 5.4 Enabling UE reflective QoS function..... | 10 | +| 5.4.1 General ..... | 10 | +| 5.4.2 UE procedure..... | 11 | +| 5.4.2.1 Sending Reflective QoS Indication (RQSI) to 3GPP AAA server ..... | 11 | +| 5.4.2.2 Receiving the RQSI from 3GPP AAA server..... | 11 | +| 5.4.3 Network procedure ..... | 12 | +| 5.4.3.1 RQSI from 3GPP AAA server to UE ..... | 12 | +| 6 Tunnel management procedure..... | 12 | +| 6.1 Tunnel management procedures over S2b ..... | 12 | +| 6.1.1 General ..... | 12 | +| 6.1.2 UE procedures ..... | 13 | +| 6.1.2.1 Tunnel establishment..... | 13 | +| 6.1.2.2 Tunnel modification..... | 13 | +| 6.1.2.3 Tunnel disconnection..... | 13 | +| 6.1.2.4 Support of reflective QoS ..... | 14 | +| 6.1.3 ePDG procedure ..... | 14 | +| 6.1.3.1 Tunnel establishment..... | 14 | +| 6.1.3.2 Tunnel modification..... | 14 | +| 6.1.3.3 Tunnel disconnection..... | 14 | +| 6.1.3.4 Support of QoS ..... | 14 | +| 6.2 Tunnel management procedure over S2c..... | 14 | +| 6.2.1 S2c procedure over trusted fixed broadband access network..... | 14 | +| 6.2.1.1 General..... | 14 | +| 6.2.1.2 UE procedure ..... | 15 | +| 6.2.1.2.1 Dual-Stack Mobile IPv6 initial attach..... | 15 | +| 6.2.1.2.2 Dual-Stack Mobile IPv6 handover..... | 15 | +| 6.2.1.2.3 Dual Stack Mobile IPv6 Re-Registration..... | 15 | +| 6.2.1.2.4 Dual-Stack Mobile IPv6 detach ..... | 15 | +| 6.2.1.2.5 Support of reflective QoS..... | 15 | + +6.2.1.3 HA procedure..... 16 + +6.2.1.3.1 Dual-Stack Mobile IPv6 initial attach..... 16 + +6.2.1.3.2 Dual-Stack Mobile IPv6 handover..... 16 + +6.2.1.3.3 Dual Stack Mobile IPv6 Re-Registration..... 16 + +6.2.1.3.4 Dual-Stack Mobile IPv6 detach ..... 16 + +6.2.1.3.5 Support of QoS..... 16 + +6.2.2 S2c procedure over un-trusted fixed broadband access network ..... 16 + +6.2.2.1 General..... 16 + +6.2.2.2 UE procedure ..... 16 + +6.2.2.3 ePDG Procedure ..... 17 + +6.2.2.4 HA Procedure ..... 17 + +7 Non-seamless WLAN Offload..... 17 + +7.1 General ..... 17 + +7.2 UE procedure..... 17 + +7.3 Network procedure..... 17 + +8 PDUs and parameters specific to the present document..... 18 + +8.1 IETF RFC coding information defined within present document..... 18 + +8.1.1 RQSI attributes ..... 18 + +8.1.1.1 AT\_RQSI\_IND attribute..... 18 + +8.1.1.2 AT\_RQSI\_RES attribute ..... 18 + +Annex A (informative): Change history..... 19 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the UE – EPC procedures for accessing 3GPP Evolved Packet Core (EPC) via a Fixed Broadband Access network. + +The specification covers the Support of QoS, Tunnel management procedures including the support of NAT traversal, and non-seamless offloading impacts. + +The present document is applicable to the UE and the network. In this technical specification the network is the 3GPP EPC. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.139: "3GPP System-Fixed Broadband Access Network Interworking". +- [3] 3GPP TS 24.302: "Access to the Evolved Packet Core (EPC) via non-3GPP access networks; Stage 3". +- [4] 3GPP TS 24.303: "Mobility management based on Dual-Stack Mobile IPv6; Stage 3". +- [5] IETF RFC 2474 (December 1998): "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [6] IETF RFC 4187 (January 2006): "Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)". +- [7] IETF RFC 5996 (September 2010): "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [8] IETF RFC 4555 (June 2006): "IKEv2 Mobility and Multihoming Protocol (MOBIKE)". +- [9] IETF RFC 3948 (January 2005): "UDP Encapsulation of IPsec ESP Packets". +- [10] IETF RFC 4301 (December 2005): "Security Architecture for the Internet Protocol". +- [11] Broadband Forum TR-058: "Multi-service Architecture and Framework Requirements", September 2003. +- [12] Broadband Forum TR-059: "Architecture Requirements for the Support of QoS-Enabled IP Service", September 2003. +- [13] Broadband Forum TR-101: "Migration to Ethernet-based DSL Aggregation", Issue 2, July 2011. +- [14] Broadband Forum TR-134: "Policy Control Framework", Issue 1, July 2012. +- [15] Broadband Forum TR-145: "Multi-service Broadband Network Functional Modules and Architecture", Issue 1, November 2012. +- [16] Broadband Forum TR-203: "Interworking between Next Generation Fixed and 3GPP Wireless Access", Issue 1, August 2012. + +- [17] Broadband Forum TR-146: "Subscriber Sessions", Issue 1, May 2013. +- [18] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [19] 3GPP TS 23.003: "Numbering, addressing and identification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Fixed Broadband Access network:** Fixed broadband access network is a type of high-speed Internet access for multi-service broadband packet networking. The fixed broadband access system is specified by the Broadband Forum in BBF TR-058 [11], BBF TR-059 [12], BBF TR-101 [13], BBF TR-134 [14], BBF TR-145 [15], BBF TR-146 [17], and BBF TR-203 [16]. + +**UE reflective QoS function:** A UE function that supports reflective QoS for uplink traffic over a fixed broadband access network as specified in 3GPP TS 23.139 [2]. + +**Non-seamless WLAN offload (NSWO):** NSWO is a capability of a UE supporting routing specific IP flows over the WLAN access without traversing the EPC as defined in 3GPP TS 23.139 [2]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.303 [4] subclause 3.1 apply: + +**Home Agent (HA)** + +## 3.2 Abbreviations + +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]. + +| | | +|------|------------------------------------| +| DSCP | Differentiated Services Code Point | +| NAT | Network Address Translation | +| P-GW | PDN Gateway | +| QoS | Quality of Service | +| RQSI | Reflective QoS Indication | +| EPC | Evolved Packet Core | + +# --- 4 General + +## 4.1 Support of Fixed Broadband Access Network Interworking + +The support of fixed broadband access network is based on the network configuration as specified in 3GPP TS 23.139 [2]. The fixed broadband access network interworking related functions are triggered by the network if the network knows the UE local access network is a fixed broadband access network. For instance, the network can be statically configured with a mapping between the UE local IP address and the local access network type. + +For access to 3GPP Evolved Packet Core (EPC) via a fixed broadband access network or non-seamless WLAN offload at a fixed broadband access network or both, the EPC network procedures and the UE procedures are specified in this document. In all other cases, the EPC network procedure and the UE procedures are specified in 3GPP TS 24.302 [3] and 3GPP TS 24.303 [4]. + +## 4.2 Network Discovery and Selection + +### 4.2.1 Access network discovery and selection procedures + +When interworking with fixed broadband access, the access network discovery and selection procedures specified in 3GPP TS 24.302 [3] is applied. + +### 4.2.2 EPC network selection + +When interworking with fixed broadband access, the EPC network selection procedures specified in 3GPP TS 24.302 [3] is applied. + +### 4.2.3 Access network reselection + +When interworking with fixed broadband access, the access network reselection procedures specified in 3GPP TS 24.302 [3] is applied. + +### 4.2.4 Data traffic routing of IP flows + +When interworking with fixed broadband access, the data routing of IP flows procedures specified in 3GPP TS 24.302 [3] is applied. + +## 4.3 UE – EPC Network Protocols + +### 4.3.1 Trusted and Untrusted Accesses + +When interworking with Fixed Access Broadband, the UE-EPC Network protocols related to trusted and untrusted access procedures specified in 3GPP TS 24.302 [3] is applied. + +### 4.3.2 IP Mobility Mode Selection + +When interworking with Fixed Access Broadband, the UE-EPC Network protocols related to IP Mobility Mode Selection procedures specified in 3GPP TS 24.302 [3] is applied. + +### 4.3.3 Authentication and Authorization + +When interworking with Fixed Access Broadband, the UE-EPC Network protocols related to Authentication and Authorization procedures specified in 3GPP TS 24.302 [3] is applied. + +# --- 5 Supporting QoS + +## 5.1 General + +When interworking with a fixed broadband access network, DSCP marking is used for setting QoS as specified in IETF RFC 2474 [5]. + +For downlink traffic, the 3GPP network sets the DSCP value on the outer header of each IP packet on a per-flow basis. When tunnelling the IP packet to the UE, the network copies the DSCP value from the inner IP header to the new outer IP header. + +For uplink traffic, the reflective QoS on uplink traffic is optionally supported by the UE when accessing a fixed broadband access network. The reflective QoS is achieved by creating a DSCP marking rule based on the received downlink traffic. + +The BBF network performs QoS treatment and QoS remapping based on DSCP value of the outer IP header. + +## 5.2 UE reflective QoS procedures + +### 5.2.1 General + +A UE may support the UE reflective QoS function for uplink traffic. + +For a UE supporting UE reflective QoS function, and if UE reflective QoS function is enabled by the network, the UE shall create uplink DSCP marking rules based on the received downlink traffic. Each uplink DSCP marking rule contains a n-tuple rule which is created based on the corresponding n-tuple of the received downlink traffic. The UE shall use the uplink DSCP marking rules to set the DSCP field of the outer IP header of the outgoing IP packets. + +The UE reflective QoS function is enabled by the network as specified in subclause 5.4. + +### 5.2.2 DSCP marking rule + +The DSCP marking rules contains following parameter values: + +- Source IP address; +- Destination IP address; +- Source port number; +- Destination port number; +- Protocol type; +- DSCP marking value; and +- Timestamp. + +The source IP address refers to the IP address used by the UE as source IP address when generating IP traffic. + +The destination IP address refers to the IP address of the data packets destined for the UE. + +The source port number refers to the port number used by the UE as source port number when generating IP traffic. + +The destination port number refers to the port number of the data packets destined for the UE. + +The protocol type is a value among the internet protocol numbers as defined in IANA. In case of IPv4, the protocol type value is the value of the outer IP header protocol type field. In case of IPv6, the protocol type value is the value of the last next header field. + +The timestamp is the time that the DSCP marking rule was created or the last time the DSCP marking rule was applied. + +### 5.2.3 Maintaining DSCP marking rules + +The DSCP marking table is created when the first DSCP marking rule is created based on the received downlink IP packet. + +Depending on the protocol type, the n-tuple is either a 5-tuple (including: source IP address, destination IP address, source port number, destination port number, and protocol type) or a 3-tuple (including source IP address, destination IP address, and protocol type). + +The lifetime of the DSCP marking table is same as the associated PDN connection. + +A UE may remove the expired entries from the table based on the timestamp. How long the entry shall be maintained in the table is an implementation specific value. + +### 5.2.4 Receiving an IP packet + +When receiving an IP packet, the UE shall perform a lookup in the DSCP marking table based on the n-tuple of the IP header. If tunnel is established between the UE and the network, the lookup is performed after the tunnel de-capsulation. + +If no matching entry is found, a new entry shall be created as follows: + +- The source IP address of the new entry is the destination IP address of the received packets; +- The source port number of the new entry is the destination port number of the received packets; +- The destination IP address of the new entry is the source IP address of the received packets; +- The destination port number of the new entry is the source port number of the received packets; +- The protocol type value is either the value of the last protocol type field in IPv4 case, or the value of the last next header field in case of IPv6; +- The DSCP field is set as same as the DSCP field of the received outer IP header; and +- The timestamp is set. + +If a matching entry is found, the timestamp shall be set. + +### 5.2.5 Sending an IP packet + +When sending an IP packet, the UE shall perform a lookup in the DSCP marking table based on the n-tuple of the IP header. If a tunnel is established between the UE and the network, the lookup is performed before the tunnel encapsulation. + +If a matching entry is found, the UE shall set the DSCP marking value of the IP header of the packet according to the matched DSCP marking rule and set the timestamp of the entry. If there is already a value of the DSCP field in the IP header of the packet set by the UE application, it shall be overwritten by the DSCP marking value from the DSCP marking rule. + +If no matching entry is found, the UE shall not modify the DSCP field of the IP header of the packet. + +If a tunnel is established between the UE and the network, the UE shall copy the DSCP value from the IP header of the original packet into the new outer header at the tunnel encapsulation before forwarding it to the network. + +## 5.3 Network procedures for supporting QoS + +The 3GPP network shall create DSCP marking rules per QoS flow based on policies as defined in 3GPP TS 23.139 [2]. + +When tunnelling the UE downlink traffic, the network shall copy the DSCP value from the received IP header into the new outer header before forwarding to the UE. + +Optionally, the network may perform DSCP marking remapping based on the operator's policy. + +## 5.4 Enabling UE reflective QoS function + +### 5.4.1 General + +The UE indicates its support of UE reflective QoS function to the network. When the UE explicit indication is received, the network provides the reflective QoS Indication to the UE which indicates that the UE reflective QoS function shall be enabled or disabled. + +For trusted fixed broadband access network, the indication is provided at 3GPP based access authentication before an IP address is allocated to the UE. For un-trusted fixed broadband access network, if the 3GPP based access authentication is performed the indication is provided at 3GPP based access authentication before an IP address is allocated to the UE, or it is provided during IKEv2 signalling for IPsec tunnel establishment with the ePDG. For DSMIPv6 based access procedure, the indication is provided during IKEv2 signalling for IPsec tunnel establishment with the PDN-GW/HA. + +### 5.4.2 UE procedure + +#### 5.4.2.1 Sending Reflective QoS Indication (RQSI) to 3GPP AAA server + +During EAP-AKA and EAP-AKA' based authentication, UE may provide an explicit indication to the 3GPP AAA server about the supporting of UE reflective QoS function. The explicit indication is sent using an attribute in the EAP- + +AKA and EAP-AKA' protocols, which extends these protocols as specified in subclause 8.2 of IETF RFC 4187 [6]. This attribute is provided in EAP-Response/AKA-Challenge and the corresponding EAP-AKA' message payload. + +If the UE reflective QoS function is supported, the UE shall provide the RQSI using AT\_RQSI\_IND attribute in EAP-AKA or EAP-AKA'. This indication is provided if the UE receives the AT\_RESULT\_IND attribute within the EAP-Request/AKA-Challenge message, or the EAP-Request/AKA-Challenge' message when EAP-AKA' is used. If the UE provides the AT\_RQSI\_IND attribute within the EAP-Response/AKA-Challenge message payload, or the EAP-Response/AKA-Challenge' message payload when EAP-AKA' is used, the UE shall also provide the AT\_RESULT\_IND attribute within the message. + +The detailed coding of this attribute is described in subclause 8.1.1. + +#### 5.4.2.2 Receiving the RQSI from 3GPP AAA server + +The UE shall only enable the UE reflective QoS function if enabled by the network. + +If the Reflective QoS Indication is received at 3GPP based access authentication which indicates the UE reflective QoS function is enabled, the UE may: + +- perform the UE reflective QoS function on all traffic for the attached fixed broadband access network that enabled the UE reflective QoS function; and +- disable the UE reflective QoS function, when: + - a) the UE/network initiated detachment from the attached fixed broadband access network; or + - b) the UE moves away from the attached fixed broadband access network coverage. + +If the Reflective QoS Indication is received at 3GPP based access authentication during the attachment of the fixed broadband access network: + +- the UE need not provide an explicit indication during IKEv2 signalling for IPsec tunnel establishment with ePDG or DSMIPv6 bootstrapping with PDN-GW/HA; and +- the UE shall ignore the Reflective QoS Indication if it is received during IKEv2 signalling for IPsec tunnel establishment with ePDG or DSMIPv6 bootstrapping with PDN-GW/HA . + +If the Reflective QoS Indication is received during IKEv2 signalling for IPsec tunnel establishment with ePDG which indicates that the UE reflective QoS function is enabled, the UE shall: + +- perform the UE reflective QoS function on all tunneled traffic for the attached ePDG that enabled the UE reflective QoS function; and +- disable the UE reflective QoS function, when: + - a) the PDN connection over the attached ePDG is released or handover to another access network occurs; + - b) the UE/network initiated detachment from the attached fixed broadband access network; or + - c) the UE moves away from the attached fixed broadband access network coverage; + +If the Reflective QoS Indication is received during IKEv2 signalling for IPsec tunnel establishment with ePDG and DSMIPv6 is used as selected mobility protocol (see subclause 6.3.3 of 3GPP TS 24.302 [3]): + +- the UE need not provide an explicit indication during DSMIPv6 bootstrapping with PDN-GW/HA; and +- the UE shall ignore the Reflective QoS Indication if it is received during DSMIPv6 bootstrapping with PDN-GW/HA. + +For DSMIPv6 over a fixed broadband access network, if the Reflective QoS Indication is received during DSMIPv6 bootstrapping with PDN-GW/HA which indicates that the UE reflective QoS function is enabled, the UE shall: + +- perform the UE reflective QoS function for all DSMIPv6 traffic for the attached PDN-GW/HA that enabled the UE reflective QoS function; and +- disable the UE reflective QoS function, when: + +- a) the PDN connection with the attached PDN-GW/HA is released or handover to another access; +- b) the UE/network initiated detachment from the attached fixed broadband access network; or +- c) the UE moves away from the attached fixed broadband access network coverage; + +The UE shall not enable the UE reflective QoS function, if: + +- the received Reflective QoS Indication indicates that the UE reflective QoS function is disabled; or +- the Reflective QoS Indication is not received from the 3GPP AAA. + +If the UE reflective QoS function is not enabled, the DSCP marking value of the outer IP header performed by the UE is implementation specific. + +### 5.4.3 Network procedure + +#### 5.4.3.1 RQSI from 3GPP AAA server to UE + +A 3GPP AAA server supporting RQSI, shall include the AT\_RESULT\_IND attribute within the EAP-Request/AKA-Challenge and corresponding EAP-AKA' message payload. + +If the UE provided an explicit indication as described in subclause 5.4.2.1, the 3GPP AAA server shall inform the UE of its decision of the UE reflective QoS function by invoking an EAP-Request/AKA-Notification dialogue when EAP-AKA is used or an EAP-Request/AKA-Notification' dialogue when EAP-AKA' is used. The UE reflective QoS function decision is sent to the UE by using the AT\_RQSI\_RES attribute. + +The UE reflective QoS function decision is made by the 3GPP AAA server based on the capabilities of the UE, the type of access, the access identity and local policies. + +The detailed coding of this attribute is described in subclause 8.1.1. + +# --- 6 Tunnel management procedure + +## 6.1 Tunnel management procedures over S2b + +### 6.1.1 General + +The purpose of tunnel management procedures is to establish or disconnect an end-to-end tunnel between the UE and the ePDG for S2b access to 3GPP Evolved Packet Core (EPC) via a fixed broadband access network. + +The tunnel management procedures and ePDG selection procedure specified in 3GPP TS 24.302 [3] clause 7 are applied. In addition, the procedures specified in this subclause shall be supported. + +NOTE: If required by national regulations, a DNS server can indicate that the current country mandates the selection of ePDG in this country (see 3GPP TS 23.402 [18] and 3GPP TS 23.003 [19]). + +### 6.1.2 UE procedures + +#### 6.1.2.1 Tunnel establishment + +Once the ePDG has been selected, the UE shall initiate the IPsec tunnel establishment procedure using the IKEv2 protocol as specified in 3GPP TS 24.302 [3] subclause 7.2.2 with the following additions: + +- a) if the UE supports Reflective QoS, the UE shall provide the RQSI using AT\_RQSI\_IND attribute as defined in subclause 8.1.1.1 within the IKE\_AUTH request message; +- b) if MOBIKE is supported, the UE shall include the MOBIKE\_SUPPORTED notification in the IKE\_AUTH request message; +- c) in an IPv4 fixed broadband access network, NAT may be deployed, e.g. a UE may locate behind a Residence Gateway in which a NAT function is enabled. The UE shall support the NAT detection function as specified in IETF RFC 5996 [7]; and + +- d) if NAT is detected between the UE and the ePDG, + - the UE shall invoke the IKEv2 NAT traversal procedure as specified in IETF RFC 5996 [7]; + - the UE shall use UDP encapsulated for ESP as specified in IETF RFC 5996 [7]; and + - the UE may send the NAT-keepalive packet to keep NAT mapping alive as defined in the IETF RFC 3948 [9]. + +#### 6.1.2.2 Tunnel modification + +The UE shall support the tunnel modification procedure specified in 3GPP TS 24.302 [3] subclause 7.2.3. + +The tunnel modification procedure may be triggered if the UE local IP address or the NAT UDP port number or both have been reassigned. For instance, the Residence Gateway NAT function may be restarted for some reasons. As the result of the NAT restart, the UE local IP address and the mapping of the NAT UDP port number may be reassigned. + +If the UE detects that the local IP address or the NAT UDP port number or both are reassigned, the UE shall: + +- disconnect the tunnel as specified in subclause 6.1.2.3 and re-initiate the tunnel establishment procedure as specified in subclause 6.1.2.1; or +- use MOBIKE for recovering the IKEv2 SA as specified in IETF RFC 4555 [8]. + +If MOBIKE is supported, the UE shall support the tunnel modification procedure specified in 3GPP TS 24.302 [3] subclause 7.2.3 with the following additions: + +- the UE shall perform the Dead Peer Detection (DPD) procedure to detect if NAT mapping have changed as specified in IETF RFC 4555 [8]; +- if NAT remapping is detected, the UE shall update the IKEv2 security association with the new allocated local IP address, and shall then send an INFORMATIONAL request containing the UPDATE\_SA\_ADDRESSES notification to the ePDG; and +- when the UE receives an INFORMATIONAL request with a COOKIE2 notification present, the UE shall copy the notification to the COOKIE2 notification of an INFORMATIONAL response and send it to the ePDG. + +#### 6.1.2.3 Tunnel disconnection + +The procedure of tunnel disconnection initiated by the UE is specified 3GPP TS 24.302 [3]. + +#### 6.1.2.4 Support of reflective QoS + +The UE may support reflective QoS for uplink traffic as specified in subclause 5.2. + +If reflective QoS is supported and IPsec anti-replay feature specified in IETF RFC 4301 [10] is implemented, the UE should create dedicated child SA for each IP flow which has the same DSCP marking value. If not, the UE may choose to increase the IPsec anti-replay window size or use any other implementation-specific method to avoid the sequence issue. + +### 6.1.3 ePDG procedure + +#### 6.1.3.1 Tunnel establishment + +Upon receipt of an IKE\_AUTH request message from the UE requesting the establishment of a tunnel, the ePDG shall perform the tunnel establishment procedure as specified in 3GPP TS 24.302 [3] with the following additions: + +- a) the ePDG shall support the NAT detection function as defined in section 2.23 of IETF RFC 5996 [7]; +- b) if MOBIKE\_SUPPORTED notification is received, the ePDG shall include the MOBIKE\_SUPPORTED notification in the IKE\_AUTH response message; +- c) if NAT is detected between the UE and the ePDG, the ePDG shall use UDP encapsulated for ESP as defined in IETF RFC 5996 [7]; and + +- d) the ePDG shall send the RQSI on whether Reflective QoS shall be applied within the IKE\_AUTH response message to the UE if received from the 3GPP AAA Server. + +#### 6.1.3.2 Tunnel modification + +If MOBIKE applies, the ePDG shall perform the tunnel modification procedure as defined in 3GPP TS 24.302 [3], subclause 7.4.2. + +If MOBIKE does not apply, the ePDG shall perform the procedure for UE initiated disconnection as defined in subclause 6.1.3.3, followed by the tunnel establishment procedure as defined in subclause 6.1.3.1. + +#### 6.1.3.3 Tunnel disconnection + +The procedure of tunnel disconnection initiated by the ePDG is as specified 3GPP TS 24.302 [3]. + +#### 6.1.3.4 Support of QoS + +When receiving a downlink data packet for a UE, the ePDG shall copy the DSCP marking value from the received IP header into the new IPSec header before forwarding to the UE, as specified in subclause 5.3. + +If the anti-replay feature specified in IETF RFC 4301 [10] is implemented, the ePDG should create a dedicated child SA for each IP flow which has the same DSCP marking value; or, the ePDG may choose to increase the IPSec anti-replay window size or use any other implementation-specific method to avoid the out of sequence issue. + +Optionally, the ePDG may perform DSCP marking remapping based on the operator's policy. + +## 6.2 Tunnel management procedure over S2c + +### 6.2.1 S2c procedure over trusted fixed broadband access network + +#### 6.2.1.1 General + +The purpose of tunnel management procedures is to establish or disconnect an end-to-end tunnel between the UE and the HA for S2c access to 3GPP Evolved Packet Core (EPC) via a trusted fixed broadband access network. + +The tunnel management procedures specified in 3GPP TS 24.303 [4] clause 5 are applied. In addition, the procedures specified in this subclause shall be supported. + +#### 6.2.1.2 UE procedure + +##### 6.2.1.2.1 Dual-Stack Mobile IPv6 initial attach + +Once the HA has been selected, the UE shall initiate the Dual-Stack Mobile IPv6 initial attach procedure specified in 3GPP TS 24.303 [4], subclause 5.1 with the following additions: + +- a) if the UE supports Reflective QoS, the UE may provide the RQSI using AT\_RQSI\_IND attribute as defined in subclause 8.1.1.1 within the IKE\_AUTH request message; +- b) If MOBIKE is supported, the UE shall include the MOBIKE\_SUPPORTED notification in the IKE\_AUTH request message; +- c) in an IPv4 fixed broadband access network, NAT may be deployed, e.g. a UE may locate behind a Residence Gateway in which a NAT function is enabled. The UE shall support the NAT detection function as specified in IETF RFC 5996 [7] and IETF RFC 4555 [8]; +- d) If NAT is detected between the UE and the HA, + - the UE shall invoke the IKEv2 NAT traversal procedure as specified in IETF RFC 5996 [7]; + - the UE shall use UDP-Encapsulated ESP as defined in IETF RFC 5996 [7] and IETF RFC 4555 [8]; and + - the UE may send the NAT-keepalive packet to keep NAT mapping alive as defined in IETF RFC 3948 [9] and IETF RFC 4555 [8]. + +##### 6.2.1.2.2 Dual-Stack Mobile IPv6 handover + +The Dual-Stack Mobile IPv6 handover procedure shall be triggered if the UE local IP address has been reassigned, or the UE moves from one link to another link. + +The UE procedure of Dual-Stack Mobile IPv6 handover is specified in 3GPP TS 24.303 [4], subclause 5.2. + +If the UE detects that the local IP address or the NAT UDP port number or both are reassigned, the UE shall update the mobility tunnel with the HA by initiating the Dual-Stack Mobile IPv6 handover. + +##### 6.2.1.2.3 Dual Stack Mobile IPv6 Re-Registration + +The UE procedure of Dual-Stack Mobile IPv6 Re-Registration is specified in 3GPP TS 24.303 [4], subclause 5.3. + +##### 6.2.1.2.4 Dual-Stack Mobile IPv6 detach + +The UE procedure of Dual-Stack Mobile IPv6 detach is specified in 3GPP TS 24.303 [4], subclause 5.4. + +##### 6.2.1.2.5 Support of reflective QoS + +The UE may support UE Reflective QoS function for uplink traffic as specified in subclause 5.2. + +If UE Reflective QoS function for uplink traffic is enabled, S2c data integrity protection is used and the IPsec anti-replay feature specified in IETF RFC 4301 [10] is implemented, the UE should create dedicated child SA for each IP flow which has the same DSCP marking value; or, the UE may choose to increase the IPsec anti-replay window size or use any other implementation-specific method to avoid the sequence issue. + +#### 6.2.1.3 HA procedure + +##### 6.2.1.3.1 Dual-Stack Mobile IPv6 initial attach + +Upon receipt of an IKE\_AUTH request message from the UE requesting the establishment of a tunnel, the HA shall perform the Dual-Stack Mobile IPv6 initial attach procedure as specified in 3GPP TS 24.303 [4], subclause 5.1 with the following additions: + +- a) the HA shall support the NAT detection function as defined in section 2.23 of IETF RFC 5996 [7] and in IETF RFC 4555 [8]; +- b) if MOBIKE\_SUPPORTED notification is received, the HA shall include the MOBIKE\_SUPPORTED notification in the IKE\_AUTH response message; and +- c) if NAT is detected between the UE and the HA, the HA shall use UDP encapsulated for ESP as defined in IETF RFC 5996 [7]. + +##### 6.2.1.3.2 Dual-Stack Mobile IPv6 handover + +The Dual-Stack Mobile IPv6 handover procedure shall be triggered if the UE local IP address has been reassigned, or the UE moves from one link to another link. + +The HA procedure of Dual-Stack Mobile IPv6 handover is specified in 3GPP TS 24.303 [4], subclause 5.2. + +##### 6.2.1.3.3 Dual Stack Mobile IPv6 Re-Registration + +The HA procedure of Dual-Stack Mobile IPv6 Re-Registration is specified in 3GPP TS 24.303 [4], subclause 5.3. + +##### 6.2.1.3.4 Dual-Stack Mobile IPv6 detach + +The HA procedure of Dual-Stack Mobile IPv6 detach is specified in 3GPP TS 24.303 [4], subclause 5.4. + +##### 6.2.1.3.5 Support of QoS + +The HA shall set per QoS flow DSCP marking on the IP outer header as specified in subclause 5.3. + +If S2c data integrity protection is used and the IPsec anti-replay feature specified in IETF RFC 4301 [10] is implemented, the HA should create a dedicated child SA for each IP flow which has the same DSCP marking value. Or, + +the UE may choose to increase the IPsec anti-replay window size or use any other implementation-specific method to avoid the out of sequence issue. + +### 6.2.2 S2c procedure over un-trusted fixed broadband access network + +#### 6.2.2.1 General + +The purpose of tunnel management procedures is to establish or disconnect an end-to-end tunnel between the UE and the HA for S2c access to 3GPP Evolved Packet Core (EPC) via an un-trusted fixed broadband access network. + +The tunnel management procedures specified in 3GPP TS 24.303 [4] clause 5 are applied. The additional procedures specified in this subclause shall also be supported. + +#### 6.2.2.2 UE procedure + +The UE tunnel management procedure of the IPsec tunnel with ePDG is specified in subclause 6.1.2. + +The UE tunnel management procedure of Dual-Stack Mobile IPv6 tunnel with the HA is specified in subclause 6.2.1.2. + +The UE may support the UE reflective QoS for uplink traffic on the IPsec header as specified in subclause 6.1.2.4. + +#### 6.2.2.3 ePDG Procedure + +The ePDG tunnel management procedure of the IPsec tunnel is specified in subclause 6.1.3. + +The ePDG procedure for the support of QoS is specified in subclause 6.1.3.4. + +#### 6.2.2.4 HA Procedure + +The HA tunnel management procedure of Dual-Stack Mobile IPv6 tunnel is specified in subclause 6.2.1.3. + +The HA procedure for the support of QoS is specified in subclause 6.2.1.3.5. + +# --- 7 Non-seamless WLAN Offload + +## 7.1 General + +A non-seamless offload capable UE selects a fixed broadband access network for non-seamless WLAN offload as specified in 3GPP TS 23.139 [2]. + +## 7.2 UE procedure + +The UE may use any local IP address(es) for non-seamless WLAN offload traffic regardless of the selected IP mobility protocol. The UE local IP address allocation procedure is specified in BBF TR-146 [17]. + +The UE may support the UE reflective QoS for non-seamless WLAN offload uplink traffic as specified in subclause 5.2. The UE reflective QoS function may be enabled by the network at EAP-AKA and EAP-AKA' based access authentication, during IKEv2 signalling for IPsec tunnel establishment with the ePDG, or during DSMIPv6 bootstrapping with PDN-GW/HA, as specified in subclause 5.4. + +## 7.3 Network procedure + +At EAP-AKA and EAP-AKA' based access authentication, during IKEv2 signalling for IPsec tunnel establishment with the ePDG, or during DSMIPv6 bootstrapping with PDN-GW/HA, the 3GPP AAA server may enable the UE reflective QoS function. The fixed broadband access network may provide QoS on the non-seamless WLAN offload traffic after successful 3GPP based access authentication. + +When forwarding a downlink data packet to a UE, the fixed broadband access network may set the DSCP value on the outer IP header of each IP packet at per-flow basis as specified in subclause 5.3. + +# 8 PDUs and parameters specific to the present document + +## 8.1 IETF RFC coding information defined within present document + +### 8.1.1 RQSI attributes + +#### 8.1.1.1 AT\_RQSI\_IND attribute + +![Diagram of AT_RQSI_IND attribute structure showing octets 1-4 and bit positions 0-7.](36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg) + +| | | | +|-------------------------------|--|--------------------| +| 7   6   5   4   3   2   1   0 | | | +| Attribute Type = AT_RQSI_IND | | octet 1 | +| Length = 1 | | octet 2 | +| Value | | octet 3
octet 4 | + +Diagram of AT\_RQSI\_IND attribute structure showing octets 1-4 and bit positions 0-7. + +Figure 8.1.1.1-1: AT\_RQSI\_IND attribute + +Table 8.1.1.1-1: AT\_RQSI\_IND attribute + +| | | | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|------------------------------------------| +| Octet 1 indicates the type of attribute as AT_RQSI_IND with a value of 142. | | | | | | | | | +| Octet 2 is the length of this attribute which shall be set to 1 as per IETF RFC 4187 [6] | | | | | | | | | +| Octet 3 and 4 is the value of this attribute. Octet 3 is reserved and shall be coded as zero. Octet 4 shall be set as follows. All other values are reserved. | | | | | | | | | +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Support of reflective QoS | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | reflective QoS function is supported | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | reflective QoS function is not supported | + +#### 8.1.1.2 AT\_RQSI\_RES attribute + +![Diagram of AT_RQSI_RES attribute structure showing octets 1-4 and bit positions 0-7.](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +| | | | +|-------------------------------|--|--------------------| +| 7   6   5   4   3   2   1   0 | | | +| Attribute Type = AT_RQSI_RES | | octet 1 | +| Length = 1 | | octet 2 | +| Value | | octet 3
octet 4 | + +Diagram of AT\_RQSI\_RES attribute structure showing octets 1-4 and bit positions 0-7. + +Figure 8.1.1.2-1: AT\_RQSI\_RES attribute. + +Table 8.1.1.2-1: AT\_RQSI\_RES attribute + +| | | | | | | | | | +|-----------------------------------------------------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|------------------------------------------| +| Octet 1 indicates the type of attribute as AT_RQSI_RES with a value of 143. | | | | | | | | | +| Octet 2 is the length of this attribute which shall be set to 1 as per IETF RFC 4187 [6] | | | | | | | | | +| Octet 3 and 4 is the value of this attribute. Octet 3 is reserved and shall be coded as zero. | | | | | | | | | +| Octet 4 shall be set as follows. All other values are reserved. | | | | | | | | | +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Reflective QoS decision | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | Enabling the UE reflective QoS function | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | Disabling the UE reflective QoS function | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|----------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2012-05 | | | | | Version 0.0.1: Preliminary proposal | | 0.0.1 | +| 2012-05 | CT1#78 | | | | Includes the following contribution agreed by CT1 at CT1#78:
C1-122424, C1-122484 | 0.0.1 | 0.1.0 | +| 2012-08 | CT1#79 | | | | Includes the following contribution agreed by CT1 at CT1#79:
C1-123080, C1-123082, C1-123083, C1-123084, C1-123085, C1-123366 | 0.1.0 | 0.2.0 | +| 2012-09 | CT-57 | CP-120607 | | | Version 1.0.0 created by MCC for presentation at CT-57 for information and approval | 0.2.0 | 1.0.0 | +| 2012-09 | CT-57 | | | | Version 11.0.0 created by MCC after approval at CT-57 | 1.0.0 | 11.0.0 | +| 2012-12 | CT-58 | CP-120805 | 0001 | 1 | BBF reference updates and editorial cleanup | 11.0.0 | 11.1.0 | +| 2012-12 | CT-58 | CP-120805 | 0002 | | Editor notes on attribute types for AT_RQSI_IND and AT_RQSI_RES | 11.0.0 | 11.1.0 | +| 2012-12 | CT-58 | CP-120805 | 0003 | 1 | Update the receiving RQSI procedure | 11.0.0 | 11.1.0 | +| 2013-03 | CT-59 | CP-130111 | 0004 | | Update the Non-seamless WLAN Offload procedure | 11.1.0 | 11.2.0 | +| 2013-03 | CT-59 | CP-130111 | 0005 | | Correction on Tunnel modification procedure | 11.1.0 | 11.2.0 | +| 2013-06 | CT-60 | CP-130245 | 0006 | 1 | Default QoS | 11.2.0 | 11.3.0 | +| 2013-06 | CT-60 | CP-130390 | 0007 | 3 | Reflective QoS function | 11.2.0 | 11.3.0 | +| 2014-09 | CT-65 | | | | Upgrade to Rel-12 | 11.3.0 | 12.0.0 | +| 2014-12 | CT-66 | CP-140837 | 0009 | 1 | BBF reference update | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140825 | 0011 | 1 | Correct the attribute type value of AT_RQSI_IND | 12.0.0 | 12.1.0 | +| 2015-12 | CT-70 | | | | Upgrade to Rel-13 | 12.1.0 | 13.0.0 | +| 2016-06 | CT-72 | CP-160316 | 0012 | 2 | Tunnel establishment requirements on fixed broadband access network in support of Lawful Interception | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA-80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24141/13fde41de77bf026013a0b81684d1fc9_img.jpg b/marked/Rel-16/24_series/24141/13fde41de77bf026013a0b81684d1fc9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28e3aa7fd0bcfe362997ec69238dffac9ae47dc3 --- /dev/null +++ b/marked/Rel-16/24_series/24141/13fde41de77bf026013a0b81684d1fc9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d4ae4c2e6917a49d808051854c25d03c23a4f7a80f55384104498ded32d37ad +size 91431 diff --git a/marked/Rel-16/24_series/24141/23aceb0e7d3c1a644294899d9047df05_img.jpg b/marked/Rel-16/24_series/24141/23aceb0e7d3c1a644294899d9047df05_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1a7c213d8beb71e1f124599d2c7fe446808867e5 --- /dev/null +++ b/marked/Rel-16/24_series/24141/23aceb0e7d3c1a644294899d9047df05_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad443e46f8d811f95906400ab544f833051f011b3d158c54a880c4e2e41f8b96 +size 81535 diff --git a/marked/Rel-16/24_series/24141/4a390493f601ce1ac6b9201db4e28b5a_img.jpg b/marked/Rel-16/24_series/24141/4a390493f601ce1ac6b9201db4e28b5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0843089e6ffc0f88c593b9a7cde14a7cd886991e --- /dev/null +++ b/marked/Rel-16/24_series/24141/4a390493f601ce1ac6b9201db4e28b5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c32abc1771f7ec37472eebce75f911b8fd50c761e4b6db7da7d912eae17ad134 +size 47912 diff --git a/marked/Rel-16/24_series/24141/4b2dd266b605b2f31a8759f802637301_img.jpg b/marked/Rel-16/24_series/24141/4b2dd266b605b2f31a8759f802637301_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..317103ee5ced5597361f21672823fb4e576b7ecf --- /dev/null +++ b/marked/Rel-16/24_series/24141/4b2dd266b605b2f31a8759f802637301_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:736dcd8beb821c1c195d89d91ef0d2d7947f298d5cca0e6fe5133bdf95c3f3e2 +size 45312 diff --git a/marked/Rel-16/24_series/24141/508bc574df81fa8d3027a374f6d155fc_img.jpg b/marked/Rel-16/24_series/24141/508bc574df81fa8d3027a374f6d155fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d6d08274743b9036d67bd3648b1f42d52afecfb --- /dev/null +++ b/marked/Rel-16/24_series/24141/508bc574df81fa8d3027a374f6d155fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fc2ffce301823cde229ed8ee66078fa8c2dbf163cca74a75841ff150fb8492e +size 78354 diff --git a/marked/Rel-16/24_series/24141/54159e6d8f5ecc73ad262758e3a60677_img.jpg b/marked/Rel-16/24_series/24141/54159e6d8f5ecc73ad262758e3a60677_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..25058ae6803098eac5359e3fda8408ae6869cced --- /dev/null +++ b/marked/Rel-16/24_series/24141/54159e6d8f5ecc73ad262758e3a60677_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7614677fb3f54db12ce04a4c0016174d55b7c401eaf0f4193970ba2cdd67b54e +size 45585 diff --git a/marked/Rel-16/24_series/24141/7d2d1d3870cd224c4430d19334557716_img.jpg b/marked/Rel-16/24_series/24141/7d2d1d3870cd224c4430d19334557716_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cbfed861ab37121e6afd83a0ba03dfe7bc6c3b76 --- /dev/null +++ b/marked/Rel-16/24_series/24141/7d2d1d3870cd224c4430d19334557716_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4179ba382dbd4466ada4dbd7fa080ce6c5c105e6e23046fe344b0e2830f5868f +size 76788 diff --git a/marked/Rel-16/24_series/24141/7dfe05137c554aca6bed20d67e52d739_img.jpg b/marked/Rel-16/24_series/24141/7dfe05137c554aca6bed20d67e52d739_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec5f29193eca8d49d866fd7563af337ec678c8fa --- /dev/null +++ b/marked/Rel-16/24_series/24141/7dfe05137c554aca6bed20d67e52d739_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fb12a6fca26c993be520611d29d491736542db19e0d7c8e1cee83fd52975670 +size 76805 diff --git a/marked/Rel-16/24_series/24141/7ede87328f6b696dcffa65ebc4570cc8_img.jpg b/marked/Rel-16/24_series/24141/7ede87328f6b696dcffa65ebc4570cc8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..99f7d73c0f95892c32dfcddf349f828939d83482 --- /dev/null +++ b/marked/Rel-16/24_series/24141/7ede87328f6b696dcffa65ebc4570cc8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:34a81b8eef3e17c0684f6ab9e5c757ac954d889ee7d295e42e265e5f61b08d41 +size 90624 diff --git a/marked/Rel-16/24_series/24141/91aa06b0972f24b4889588fa0e3a331a_img.jpg b/marked/Rel-16/24_series/24141/91aa06b0972f24b4889588fa0e3a331a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf9ab8565bf975cf66975b70bfe8f860c9bca833 --- /dev/null +++ b/marked/Rel-16/24_series/24141/91aa06b0972f24b4889588fa0e3a331a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c02ede85e41c84ee8eacf36b13e89721fab362b60b4b0fe4825785dd730fe9e +size 45922 diff --git a/marked/Rel-16/24_series/24141/9694add1e3183133a9ddb9f41c48d00e_img.jpg b/marked/Rel-16/24_series/24141/9694add1e3183133a9ddb9f41c48d00e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f8a4000524baefd7359069a689eea671b3cfdafc --- /dev/null +++ b/marked/Rel-16/24_series/24141/9694add1e3183133a9ddb9f41c48d00e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47c8e4b63ae93831ddce99c4760caaa19598de4e825a7eba692df7309d57d8c0 +size 43506 diff --git a/marked/Rel-16/24_series/24141/9b9262a549828579ab904148450734f6_img.jpg b/marked/Rel-16/24_series/24141/9b9262a549828579ab904148450734f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..223ae0434418e40ee051777538d096e721917d8c --- /dev/null +++ b/marked/Rel-16/24_series/24141/9b9262a549828579ab904148450734f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:138a24851b3263f7b8713ca90620667c76c0537586eecaf431dda9c1dff49f1f +size 90704 diff --git a/marked/Rel-16/24_series/24141/a7450c80e88ad3f6ca1427ad84020998_img.jpg b/marked/Rel-16/24_series/24141/a7450c80e88ad3f6ca1427ad84020998_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0581f953065a757e8b3d6a17799dc1c9c805d044 --- /dev/null +++ b/marked/Rel-16/24_series/24141/a7450c80e88ad3f6ca1427ad84020998_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:041f70a51918d810a184617aeae651a0741f7b0e372d044eaf7a05265f75cd4e +size 117260 diff --git a/marked/Rel-16/24_series/24141/cfc2672ccfdf7b47212ef2b8d72c0ff3_img.jpg b/marked/Rel-16/24_series/24141/cfc2672ccfdf7b47212ef2b8d72c0ff3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0cadbc15f223966c8a566ae74833eb96b81d790a --- /dev/null +++ b/marked/Rel-16/24_series/24141/cfc2672ccfdf7b47212ef2b8d72c0ff3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc1da11c62c7f069165620cc009c7fc84acfe445f0ddbc15b22fcf72e31512a5 +size 71087 diff --git a/marked/Rel-16/24_series/24141/d15e2d3e8dd9157eb7f0cc120097484a_img.jpg b/marked/Rel-16/24_series/24141/d15e2d3e8dd9157eb7f0cc120097484a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c6abf20b47962da3d8426e3f58b90a025a7a7df --- /dev/null +++ b/marked/Rel-16/24_series/24141/d15e2d3e8dd9157eb7f0cc120097484a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe107001e801b48b30ffa54c3f44a82f310166e3fc384ff69af4b53d0bc9e075 +size 41854 diff --git a/marked/Rel-16/24_series/24141/raw.md b/marked/Rel-16/24_series/24141/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3d6c24905e21ac65103c38aeee69411faf51c7d2 --- /dev/null +++ b/marked/Rel-16/24_series/24141/raw.md @@ -0,0 +1,7145 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|------------------------------------------------------------------------------------------------|----| +| Foreword..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations..... | 9 | +| 4 Presence service overview..... | 10 | +| 5 SIP related procedures..... | 10 | +| 5.1 Introduction..... | 10 | +| 5.2 Functional entities..... | 10 | +| 5.2.1 User Equipment (UE)..... | 10 | +| 5.2.2 Application Server (AS)..... | 10 | +| 5.3 Roles..... | 10 | +| 5.3.1 Presence User Agent (PUA)..... | 10 | +| 5.3.1.1 General..... | 10 | +| 5.3.1.2 Publication of presence information..... | 11 | +| 5.3.1.3 Mapping of presence attributes..... | 11 | +| 5.3.1.4 Storing presence attributes by multipart/related or content indirection..... | 12 | +| 5.3.1.5 Subscription for the watcher information event template package..... | 12 | +| 5.3.1.6 Subscription for notification of state changes in XML document..... | 13 | +| 5.3.2 Watcher..... | 13 | +| 5.3.2.1 General..... | 13 | +| 5.3.2.2 Subscription for presence information state changes and notification acceptance..... | 13 | +| 5.3.2.3 Subscription for presence information state changes of presentity collections..... | 13 | +| 5.3.2.4 Subscription for the watcher information event template package..... | 14 | +| 5.3.2.5 Subscription for notification of state changes in XML document..... | 14 | +| 5.3.3 Presence Server (PS)..... | 14 | +| 5.3.3.1 General..... | 14 | +| 5.3.3.2 Subscription acceptance to presence information and notification of state changes..... | 14 | +| 5.3.3.3 Publication acceptance of presence information..... | 14 | +| 5.3.3.4 Subscription acceptance to watcher information and notification of state changes..... | 15 | +| 5.3.3.5 Subscription acceptance and notification of state changes in XML document..... | 15 | +| 5.3.4 Resource List Server (RLS)..... | 15 | +| 5.3.4.1 General..... | 15 | +| 5.3.4.2 Subscription acceptance to resource lists and notification of state changes..... | 16 | +| 5.3.4.3 Subscription to presence information..... | 16 | +| 5.3.4.4 Subscription acceptance and notification of state changes in XML document..... | 16 | +| 5.3.5 Presence Network Agent (PNA)..... | 16 | +| 5.3.5.1 General..... | 16 | +| 5.3.5.2 Subscription to reg event package..... | 16 | +| 5.3.5.3 Publication of network presence information..... | 17 | +| 6 Protocol for data manipulation at the Ut reference point..... | 17 | +| 6.1 Introduction..... | 17 | +| 6.2 Functional entities..... | 17 | +| 6.2.1 User Equipment (UE)..... | 17 | +| 6.2.2 Application Server (AS)..... | 17 | +| 6.2.3 Authentication proxy..... | 18 | +| 6.3 Roles..... | 18 | +| 6.3.1 XCAP client..... | 18 | +| 6.3.1.1 Introduction..... | 18 | +| 6.3.1.2 Manipulating a resource list..... | 18 | +| 6.3.1.3 Manipulating the subscription authorization policy..... | 18 | +| 6.3.1.4 Publishing hard state presence information..... | 19 | +| 6.3.2 XCAP server..... | 19 | +| 6.3.2.1 Introduction..... | 19 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| 6.3.2.2 | Resource list manipulation acceptance..... | 19 | +| 6.3.2.3 | Subscription authorization policy manipulation acceptance..... | 19 | +| 6.3.2.4 | Publication acceptance of hard state presence information..... | 19 | +| 7 | Presence information model of the 3GPP subscriber..... | 20 | +| 7.1 | General..... | 20 | +| 7.2 | XML schema definitions..... | 20 | +| 7.3 | XML schema descriptions..... | 20 | +| Annex A (informative): | Example signalling flows of presence service operation..... | 21 | +| A.1 | Scope of signalling flows..... | 21 | +| A.2 | Introduction..... | 21 | +| A.2.1 | General..... | 21 | +| A.2.2 | Key required to interpret signalling flows..... | 21 | +| A.3 | Signalling flows demonstrating how watchers subscribe to presence event notification..... | 22 | +| A.3.1 | Introduction..... | 22 | +| A.3.2 | Watcher and presentity in different networks, UE in home network..... | 23 | +| A.3.2.1 | Successful subscription..... | 23 | +| A.3.3 | Watcher subscribing to resource list, UE in visited network..... | 32 | +| A.3.3.1 | Watcher subscribing to his own resource list, UE in visited network - Successful subscription..... | 32 | +| A.3.3.2 | Watcher subscribing to a resource list, UE in visited network - successful subscription..... | 43 | +| A.3.4 | RLS subscribing to presentities in different network..... | 56 | +| A.3.4.1 | Successful subscription..... | 56 | +| A.3.5 | Network based watcher subscribing on behalf of IMS watcher to IMS presentities..... | 64 | +| A.3.6 | Watcher subscribing to state changes in XML document, UE in visited network..... | 72 | +| A.3.6.1 | Watcher subscribing to changes made via XCAP in his resource list, UE in visited network - Successful subscription..... | 72 | +| A.4 | Signalling flows demonstrating how presentities update presence information..... | 81 | +| A.4.1 | Introduction..... | 81 | +| A.4.2 | Initial publication or modification of presence information by UE..... | 81 | +| A.4.2.1 | Successful publication..... | 81 | +| A.4.3 | Refreshing of presence information by UE..... | 86 | +| A.4.3.1 | Successful refresh..... | 86 | +| A.5 | PS notifying watcher of updates to presence information..... | 89 | +| A.5.1 | Introduction..... | 89 | +| A.5.2 | Watcher and presentity in the different networks, UE in the home network..... | 89 | +| A.5.2.1 | Successful notification..... | 89 | +| A.5.3 | Notification to resource list in a different network and notification to watcher in the visited network..... | 92 | +| A.5.3.1 | Successful notification..... | 92 | +| A.6 | PUA subscribing to his own watcher list and receiving notification of new watcher subscriptions..... | 98 | +| A.6.1 | Introduction..... | 98 | +| A.6.2 | PUA subscribing to watcher list and receiving a notification of an already pending watcher subscription followed by a notification of a subscription from a new watcher not already in the watcher list..... | 99 | +| A.7 | PNA subscription for the reg-event package..... | 113 | +| A.8 | Example signalling flows of HTTP based presence service operation..... | 117 | +| A.8.1 | Introduction..... | 117 | +| A.8.2 | Signalling flows demonstrating how XCAP clients manipulate resource lists..... | 118 | +| A.8.3 | Signalling flows demonstrating how XCAP clients manipulate presence authorization policy..... | 121 | +| A.8.4 | Storing external content (successful operation)..... | 124 | +| Annex B (informative): | Change history..... | 129 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the protocol details for the presence service within the IP Multimedia (IM) Core Network (CN) subsystem based on the Session Initiation Protocol (SIP) and SIP Events as defined in 3GPP TS 24.229 [9]. + +Where possible the present document specifies the requirements for this protocol by reference to specifications produced by the IETF within the scope of SIP and SIP Events, either directly, or as modified by 3GPP TS 24.229 [9]. + +Requirements for manipulation of presence data are defined by use of a protocol at the Ut reference point based on XML Configuration Access Protocol (XCAP) (RFC 4825 [33]). + +The present document is applicable to Application Servers (ASs) and User Equipment (UE) providing presence functionality. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.141: "Presence Service; Stage 1". +- [3] 3GPP TS 23.002: "Network architecture". +- [4] 3GPP TS 23.141: "Presence service; Architecture and functional description; Stage 2". +- [5] 3GPP TS 23.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". +- [6] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [7] 3GPP TS 24.109: "Bootstrapping interface (Ub) and Network application function interface (Ua); Protocol details". +- [8] 3GPP TS 24.228 Release 5: "Signalling flows for the IP multimedia call control based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [9] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [10] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and message contents". +- [11] 3GPP TS 33.222: "Generic Authentication Architecture (GAA); Access to network application functions using Hypertext Transfer Protocol over Transport Layer Security (HTTPS)". +- [12] IETF RFC 2664 (1999): "FYI on Questions and Answers - Answers to Commonly asked New Internet User Questions". +- [13] Void. +- [14] IETF RFC 2387 (August 1998): "The MIME Multipart/Related Content-type". +- [15] IETF RFC 2616 (June 1999): "Hypertext Transfer Protocol -- HTTP/1.1". + +- [15A] IETF RFC 2617 (June 1999): " HTTP Authentication: Basic and Digest Access Authentication". +- [16] IETF RFC 2778 (2000): "A Model for Presence and Instant Messaging". +- [17] IETF RFC 3261 (June 2002): "SIP: Session Initiation Protocol". +- [18] IETF RFC 3263 (June 2002): "Session Initiation Protocol (SIP): Locating SIP Servers". +- [19] IETF RFC 6665 (July 2012): "SIP-Specific Event Notification". +- [20] IETF RFC 3310 (2002): "Hypertext Transfer Protocol (HTTP) Digest Authentication Using Authentication and Key Agreement (AKA)". +- [21] IETF RFC 3863 (August 2004): "Presence Information Data Format (PIDF)". +- [22] IETF RFC 4662 (August 2006): "A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists". +- [23] IETF RFC 3903 (October 2004): "Session Initiation Protocol (SIP) for Event State Publication". +- [24] IETF RFC 5263 (September 2008): "Session Initiation Protocol (SIP) extension for Partial Notification of Presence Information". +- [25] IETF RFC 5196 (September 2008): "Session Initiation Protocol (SIP) User Agent Capability Extension to Presence Information Data Format (PIDF)". +- [26] IETF RFC 4480 (July 2006): "RPID: Rich Presence Extensions to the Presence Information Data Format (PIDF)". +- [27] IETF RFC 3856 (August 2004): "A Presence Event Package for the Session Initiation Protocol (SIP)". +- [28] IETF RFC 3857 (August 2004): "A Watcher Information Event Template-Package for the Session Initiation Protocol (SIP)". +- [29] IETF RFC 3858 (August 2004): "An Extensible Markup Language (XML) Based Format for Watcher Information". +- [30] IETF RFC 4661 (September 2006): "An Extensible Markup Language (XML) Based Format for Event Notification Filtering". +- [31] IETF RFC 4660 (September 2006): "Functional Description of Event Notification Filtering". +- [32] IETF RFC 4482 (July 2006): "CIPID: Contact Information for the Presence Information Data Format". +- [33] IETF RFC 4825 (May 2007): "The Extensible Markup Language (XML) Configuration Access Protocol (XCAP)". +- [34] IETF RFC 4827 (May 2007): "An Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Usage for Manipulating Presence Document Contents". +- [35] IETF RFC 5025 (December 2007): "Presence Authorization Rules". +- [35A] IETF RFC 4745 (February 2007): "Common Policy: A Document Format for Expressing Privacy Preferences". +- [36] IETF RFC 4826 (May 2007): "An Extensible Markup Language (XML) Formats for Representing Resource Lists". +- [37] IETF RFC 4119 (December 2005): "A Presence-based GEOPRIV Location Object Format". +- [38] IETF RFC 5262 (September 2008): "Presence Information Data Format (PIDF) Extension for Partial Presence". +- [39] IETF RFC 5874 (May 2010): "An Extensible Markup Language (XML) Document Format for Indicating a Change in XML Configuration Access Protocol (XCAP) Resources". + +- [40] IETF RFC 4483 (May 2006): "A Mechanism for Content Indirection in Session Initiation Protocol (SIP) Messages". +- [41] Void. +- [42] Void. +- [43] IETF RFC 5875 (May 2010): "An Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Diff Event Package". +- [44] IETF RFC 4479 (July 2006): "A Data Model for Presence". +- [45] IETF RFC 5264 (September 2008): "Publication of Partial Presence Information". +- [46] 3GPP2 X.S0027-004: "Network Presence". +- [47] Void +- [48] 3GPP2 S.S0109: "Generic bootstrapping architecture" +- [49] 3GPP2 S.S0114: "Security mechanisms using GBA" +- [50] Void +- [51] 3GPP TS 33.310: "Network Domain Security (NDS); Authentication Framework (AF)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply: + +**subscription authorization policy:** a policy that determines which watchers are allowed to subscribe to diffa presentity's presence information +The subscription authorization policy also determines to which presentity's presence information the watcher has access. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.141 [4] apply: + +**Presence list server** +**Presence Network Agent (PNA)** +**Presence Server (PS)** +**Presence User Agent (PUA)** + +For the purposes of the present document, the following terms and definitions from RFC 2778 [16] apply: + +**Presence tuple** +**Presentity** + +For the purposes of the present document, the following terms and definitions from RFC 3903 [23] apply: + +**Event Publication Agent (EPA)** +**Event State Compositor (ESC)** + +For the purposes of the present document, the following terms and definitions from RFC 4825 [33] apply: + +**XCAP client** +**XCAP server** + +For the purposes of the present document, the following terms and definitions from RFC 4662 [22] apply: + +**Resource List Server (RLS)** + +For the purposes of the present document, the following terms and definitions given in RFC 1594 [12]. + +### **Fully-Qualified Domain Name (FQDN)** + +For the purposes of the present document, the following terms and definitions given in RFC 3261 [17] apply: + +**Final response** +**Header** +**Header field** +**Method** +**Request** +**Response** +**(SIP) transaction** +**Status-code** (see RFC 3261 [17], subclause 7.2) +**Tag** (see RFC 3261 [17], subclause 19.3) + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.002 [3], subclauses 4.1.1.1 and 4a.7 apply: + +**Call Session Control Function (CSCF)** +**Home Subscriber Server (HSS)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.218 [5], subclause 3.1 apply: + +**Filter criteria** +**Initial filter criteria** +**Subsequent request** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.228 [6], subclauses 4.3.3.1 and 4.6 apply: + +**Interrogating-CSCF (I-CSCF)** +**Proxy-CSCF (P-CSCF)** +**Serving-CSCF (S-CSCF)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TR 21.905 [1] apply: + +**User Equipment (UE)** + +For the purposes of the present document, the following terms and definitions from 3GPP TS 33.222 [11] apply: + +**Authentication Proxy** + +## **3.2 Abbreviations** + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|---------------------------------------| +| AS | Application Server | +| AUID | Application Unique ID | +| CN | Core Network | +| CPIM | Common Profile for Instant Messaging | +| CSCF | Call Session Control Function | +| EPA | Event Publication Agent | +| ESC | Event State Compositor | +| HSS | Home Subscriber Server | +| HTTP | HyperText Transfer Protocol | +| I-CSCF | Interrogating - CSCF | +| IM | IP Multimedia | +| IOI | Inter Operator Identifier | +| IP | Internet Protocol | +| MIME | Multipurpose Internet Mail Extensions | +| P-CSCF | Proxy - CSCF | +| PIDF | Presence Information Data Format | +| PNA | Presence Network Agent | +| PS | Presence Server | + +| | | +|--------|-----------------------------------| +| PSI | Public Service Identity | +| PUA | Presence User Agent | +| RLMI | Resource List Meta-Information | +| RLS | Resource List Server | +| RPID | Rich Presence Information Data | +| S-CSCF | Serving - CSCF | +| SIP | Session Initiation Protocol | +| TLS | Transport Layer Security | +| UE | User Equipment | +| URI | Universal Resource Identifier | +| XCAP | XML Configuration Access Protocol | +| XML | Extensible Markup Language | + +# --- 4 Presence service overview + +The presence service provides the ability for the home network to manage presence information of a user's device, service or service media even whilst roaming. A user's presence information may be obtained through input from the user, information supplied by network entities or information supplied by elements external to the home network. Consumers of presence information, watchers, may be internal or external to the home network. The architecture for the 3GPP presence service is specified in 3GPP TS 23.141 [4]. + +SIP and XCAP provide means to manipulate the presence status of a user. For details on the differences between those means refer to RFC 3903 [23] and RFC 4827 [34]. For details on the relationship of XCAP server to other roles see subclause 6.2.2. + +# --- 5 SIP related procedures + +## 5.1 Introduction + +## 5.2 Functional entities + +### 5.2.1 User Equipment (UE) + +A UE shall implement the role of a PUA (see subclause 5.3.1), a watcher (see subclause 5.3.2) or both. + +### 5.2.2 Application Server (AS) + +An AS may implement one or more of the roles of a PUA (see subclause 5.3.1), watcher (see subclause 5.3.2), PS (see subclause 5.3.3), RLS (see subclause 5.3.4), or PNA (see subclause 5.3.5). + +## 5.3 Roles + +### 5.3.1 Presence User Agent (PUA) + +#### 5.3.1.1 General + +A PUA is an entity that provides presence information to a PS. + +In addition to the procedures specified in subclause 5.3.1, the PUA shall support the procedures specified in 3GPP TS 24.229 [9] appropriate to the functional entity in which the PUA is implemented. + +#### 5.3.1.2 Publication of presence information + +When the PUA intends to publish its own view of the presentity's presence information, it shall generate a PUBLISH request by acting as an Event Publication Agent (EPA) in accordance with RFC 3903 [23]. + +NOTE 1: The contents of the presence event package containing the event state of the EPA, and how such information is constructed, are outside the scope of this version of the specification. However implementations will need to take into account the reporting needs of the EPA, and also the needs of the EPA to override information published by another EPA relating to the same presentity. + +The PUA shall implement the "application/pidf+xml" content type as described in RFC 3863 [21], the Presence Information Data Format (PIDF) extensions defined in RFC 4480 [26]. + +The PUA may implement the PIDF extensions defined in RFC 4482 [32]. + +The PUA may implement location information according to the format defined in RFC 4119 [37]. + +NOTE 2: The categorization of presence attributes to generic information attributes and communication address specific attributes is done using the and elements as defined in RFC 4479 [44]. + +The PUA shall implement RFC 5196 [25] if it wants to make use of SIP user agent capabilities in the presence document. The extension may be used for describing the type of the service described by the presence tuple. + +The PUA may implement RFC 5264 [45] if it wants to use the partial publication mechanism. The first partial PUBLISH request shall contain the full state. The PUA uses the "application/pidf-diff+xml" content type as described in RFC 5262 [38]. + +The PUA shall update the presence information, either 600 s before the publication expiration time if the publication period indicated from the PS in the response to the PUBLISH request was for greater than 1 200 s, or when half of the time has expired if the publication period was for 1 200 s or less, unless the PUA has determined that an update to the presence information is not required. + +When the PUA intends to show different value of the same presence attribute to different watchers, the PUA shall publish a tuple or person element for every value it intends to show, all including a different value of the same presence attribute. The PUA shall label different information with different value of the element in every published tuple or person element as defined in RFC 4480 [26]. The PUA shall also authorize different tuples to different watchers or watcher groups by manipulating the subscription authorization policy as defined in subclause 6.3.1.2. + +If a local configuration information limiting the rate at which PUA is allowed to generate PUBLISH requests is available, then PUA shall take that information into account. Such local configuration information could be e.g. the shortest time period between consecutive PUBLISH requests. + +#### 5.3.1.3 Mapping of presence attributes + +The eXtensible Markup Language (XML) Schema Definition of the "application/pidf+xml" format covers the definition of the 3GPP subscriber's presence attributes and the PUA shall perform the following mapping: + +- the communication address (containing communication means, status and contact address) attribute and the priority attribute are represented by a element including a basic element and a elements containing a priority attribute as defined in RFC 3863 [21]. + +The PUA represents subscriber specific information by including a element defined in RFC 4479 [44]. The person element may contain e.g. and elements both defined in RFC 4480 [26]. Further PIDF extensions as defined in RFC 4482 [32] can also be used. + +NOTE 1: RFC 4479 [44] defines also a element which can be used to present device specific information. + +- the text attribute is represented by the element as defined in RFC 3863 [21] for elements and in RFC 4479 [44] for and elements; and +- the location attribute is represented by the elements defined in RFC 4119 [37] and the element defined in RFC 4480 [26]. + +NOTE 2: Only information elements either relevant for the application or recommended by the presence-data model RFC 4479 [44] are included in the PUBLISH request. Attributes not relevant or available (e.g. the text attribute or the location attribute) are omitted. + +Additional extensions can be used to express application specific attributes, but their usage is outside the scope of this version of the specification. + +#### 5.3.1.4 Storing presence attributes by multipart/related or content indirection + +The PUA shall implement the "multipart/related" content type as described in RFC 2387 [14] if it wants to aggregate other Multipurpose Internet Mail Extensions (MIME) objects with the "application/pidf+xml" content type. + +When a presence attribute has a value of a MIME object, the PUA shall either: + +- a) publish the presence document and the MIME object utilizing the "multipart/related" content-type in the PUBLISH request; or +- b) make use of content indirection. + +When the PUA decides to use the content indirection mechanism for publishing an initial or modified value of a presence attribute the PUA shall: + +- a) store the MIME object behind an HTTP URI on the PS or ensure that the MIME object and a HTTP URL pointing to that MIME object already exists on the PS; or +- b) use the "multipart/related" content type as described in RFC 2387 [14] with the content indirection mechanism as specified in RFC 4483 [40] for the publication of presence information format as follows: + - set a CID URI referencing to other MIME multipart body. The other multipart body contains the content indirection information which is represented as the value of an XML element; + - include the presence document of the format "application/pidf+xml" or "application/pidf-diff+xml" in the root of the body of the "multipart/related" content; and + - specify the part having information about the MIME object by using the "message/external-body" content type, defining the HTTP URI, versioning information and other information about the MIME object as described in RFC 4483 [40]. + +NOTE 1: The versioning information is used for determining whether or not the MIME object indirectly referenced by a URI has changed or not; + +When storing a MIME object on the PS the PUA shall: + +- a) construct as many HTTP URIs as the number of objects to be stored; and +- b) formulate every HTTP URI according to a predefined directory structure. + +NOTE 2: The PUA has the root directory for storing the MIME objects on the PS preconfigured. + +NOTE 3: The PUA needs to store the MIME objects on the PS behind the HTTP URI(s) created previously using standard HTTP procedures as defined in RFC 2616 [15]. + +#### 5.3.1.5 Subscription for the watcher information event template package + +Upon activation of the presence service, the PUA application may subscribe for the watcher information state changes in accordance with RFC 3857 [28] and RFC 3858 [29]. Subscription is according to RFC 6665 [19] as per 3GPP TS 24.229 [9]. + +The PUA application may include filters in the body of the SUBSCRIBE request in accordance with RFC 4661 [30], and RFC 4660 [31] as updated by RFC 6665 [19]. + +#### 5.3.1.6 Subscription for notification of state changes in XML document + +In order to get notifications of changes to XML documents manipulated via the Ut reference point the PUA may generate a SUBSCRIBE request in accordance with RFC 5875 [43] and RFC 6665 [19]. + +### 5.3.2 Watcher + +#### 5.3.2.1 General + +A watcher is an entity that subscribes to or requests presence information about a presentity from the PS. + +In addition to the procedures specified in subclause 5.3.2, the watcher shall support the procedures specified in 3GPP TS 24.229 [9] appropriate to the functional entity in which the watcher is implemented. + +#### 5.3.2.2 Subscription for presence information state changes and notification acceptance + +When the watcher intends to subscribe for presence information state changes of a presentity, it shall generate a SUBSCRIBE request in accordance with RFC 6665 [19] and RFC 3856 [27]. + +The watcher shall implement the "application/pidf+xml" content type as described in RFC 3863 [21], the PIDF extensions defined in RFC 4480 [26]. + +The watcher may implement the PIDF extensions defined in RFC 4482 [32]. + +The watcher may implement location information according to the format defined in RFC 4119 [37]. + +The watcher shall implement RFC 5196 [25] if it wants to make use of SIP user agent capabilities extensions included in the presence document. The extension may be used by the watcher for interpreting the type of the service described by the presence tuple. + +The watcher may include filters in the body of the SUBSCRIBE request in accordance with RFC 4661 [30], and RFC 4660 [31] as updated by RFC 6665 [19]. + +The watcher may indicate its support for partial notification using the Accept header field in accordance with RFC 5263 [24]. + +The watcher shall interpret the received presence information according to RFC 4479 [44] and the following: + +- a) a element as defined in RFC 4479 [44] means information about the presentity; +- b) a tuple including a element defined in RFC 4480 [26] means information about an alternate contact to the presentity; +- c) a tuple contains communication means specific information. The communication means described by the tuple is deduced from the URI scheme of the contact address information present in the element as defined in RFC 3863 [21]. If the URI scheme of the contact address information provides ambiguous information about the communication means, the watcher shall further examine other elements of the tuple to decide the communication mean. Such elements can be the element, any of the different media type specific elements as defined in RFC 5196 [25]. +- d) a element as defined in RFC 4479 [44] means information about a device. + +Additional extensions can be used to express application specific attributes, but their usage is outside the scope of this version of the specification. + +#### 5.3.2.3 Subscription for presence information state changes of presentity collections + +When the watcher intends to subscribe for presence information state changes of a presentity collection, it shall generate a SUBSCRIBE request in accordance with RFC 4662 [22], additionally to the procedures described in subclause 5.3.2.2. + +#### 5.3.2.4 Subscription for the watcher information event template package + +Upon activation of the presence service, the watcher may subscribe recursively for the watcher information state changes in accordance with RFC 3857 [28] and RFC 3858 [29]. Subscription is according to RFC 6665 [19] as per 3GPP TS 24.229 [9]. + +The watcher may include filters in the body of the SUBSCRIBE request in accordance with RFC 4661 [30], and RFC 4660 [31] as updated by RFC 6665 [19]. + +#### 5.3.2.5 Subscription for notification of state changes in XML document + +In order to get notifications of changes to XML documents manipulated via the Ut reference point the watcher may generate a SUBSCRIBE request in accordance with RFC 5875 [43] and RFC 6665 [19] as per 3GPP TS 24.229 [9]. + +### 5.3.3 Presence Server (PS) + +#### 5.3.3.1 General + +A PS is an entity that accepts, stores, and distributes presence information. + +In addition to the procedures specified in subclause 5.3.3, the PS shall support the procedures specified in 3GPP TS 24.229 [9] appropriate to the functional entity in which the PS is implemented. + +#### 5.3.3.2 Subscription acceptance to presence information and notification of state changes + +When the PS receives a SUBSCRIBE request for the presence information event package, the PS shall first attempt to verify the identity of the source of the SUBSCRIBE request as described in 3GPP TS 24.229 [9] subclause 5.7.1.4, then perform authorization according to 3GPP TS 24.229 [9] subclause 5.7.1.5. In case of successful subscription, the PS shall generate a response to the SUBSCRIBE request and notifications in accordance with RFC 6665 [19] and RFC 3586 [27]. + +Additionally, in the special case of a watcher subscription if the subscription authorization policy results in the action to confirm the watcher subscription from the PUA and the PUA has a valid watcher information subscription, see RFC 3857 [28], then, the PS shall inform the PUA about the watcher subscription attempt. + +If the watcher has indicated the need for partial notification using the Accept header field, then the PS shall generate partial notifications in accordance with RFC 5263 [24] and RFC 5262 [38]. + +If the body of the SUBSCRIBE request from the watcher contains filters, the PS shall apply the requested filtering function on notifications in accordance with RFC 4661 [30], and RFC 4660 [31] as updated by RFC 6665 [19]. + +If the watcher has indicated support for the "multipart/related" content type using the Accept header field, then the PS may generate notifications using "multipart/related" content type which aggregates "application/pidf+xml" formatted presence information with other MIME objects in accordance with RFC 2387 [14]. In this case, the PS shall modify the value of the presence attribute in the PIDF document to refer to the MIME object included in the corresponding MIME multipart body. If the watcher has not indicated support for the "multipart/related" or a MIME object cannot be accessed by the PS, the PS should exclude the presence attribute from the notification. + +NOTE: How the PS takes presence information from various presence sources, in order to generate a final presence document, is outside the scope of this version of the specification. Implementations need a flexible approach to composition policy and therefore to the collection, filtering and composition of presence documents. + +#### 5.3.3.3 Publication acceptance of presence information + +The PS shall act as an Event State Composer (ESC). + +When the PS receives a PUBLISH request, the PS shall first verify the identity of the source of the PUBLISH request as described in 3GPP TS 24.229 [9] subclause 5.7.1.4, then perform authorization according to 3GPP TS 24.229 [9] subclause 5.7.1.5. In case of successful authentication and authorization, the PS shall process the PUBLISH request in accordance with RFC 3903 [23]. + +If the PUBLISH request contains the "application/pidf-diff+xml" content-type as described in RFC 5262 [38], the PS shall process the PUBLISH request in accordance with RFC 3903 [23] and RFC 5264 [45]. + +If the PUBLISH request contains the "multipart/related" content type and the PS supports the content type, the PS shall process the content as follows: + +- if a MIME multipart contains a MIME object of a content type supported by the PS, either store the MIME object in case of initial publication or replace an existing content in case of modify operation; and +- if a multipart includes the "message/external-body" content type and the content indirection as described in RFC 4483 [40] is supported by the PS, ensure that it has access to the MIME object indicated by the URI and that the MIME object exists; and associate the value of the presence attribute that refers to the MIME object with the MIME object and additional information about it. + +If the PS does not support the content type used for publishing MIME objects then the PS shall send a 415 (Unsupported Media Type) response and indicate the supported content types in the Accept header. + +NOTE: If the PS receives a HTTP request for storing a MIME object on the PS ,meaning that the HTTP URI points to a predefined directory reserved for storing MIME objects and the request is an HTTP PUT request, the PS replaces any existing content referenced by the Request-URI with the content of the request. If the Request-URI points to an uncreated directory, the PS creates the directory, stores the content there and associates the content with the Request-URI. For all requests, i.e. HTTP PUT, HTTP GET and HTTP DELETE requests, the PS generates an appropriate response in accordance with RFC 2616 [15]. + +To receive 3GPP2 IP-CAN network presence information from the PNA, the PS shall support the XML extension defined in 3GPP2 X.S0027-004 [46]. + +#### 5.3.3.4 Subscription acceptance to watcher information and notification of state changes + +When the PS receives a SUBSCRIBE request for the watcher information event template package, the PS shall first verify the identity of the source of the SUBSCRIBE request as described in 3GPP TS 24.229 [9] subclause 5.7.1.4, then perform authorization according to 3GPP TS 24.229 [9] subclause 5.7.1.5. In case of successful subscription, the PS shall generate a response to the SUBSCRIBE request and notifications in accordance with RFC 6665 [19], RFC 3857 [28] and RFC 3858 [29]. + +If the body of the SUBSCRIBE request from the PUA contains filters, the PS shall apply the requested filtering function on notifications in accordance with RFC 4661 [30], and RFC 4660 [31] as updated by RFC 6665 [19]. + +#### 5.3.3.5 Subscription acceptance and notification of state changes in XML document + +When the PS receives a SUBSCRIBE request having the Event header value "xcap-diff", the PS shall first verify the identity of the source of the SUBSCRIBE request as described in 3GPP TS 24.229 [9] subclause 5.7.1.4, then it shall perform authorization as described in 3GPP TS 24.229 [9] subclause 5.7.1.5. Afterwards, the PS shall generate a response to the SUBSCRIBE request and notifications in accordance with RFC 5875 [43] and RFC 6665 [19]. + +### 5.3.4 Resource List Server (RLS) + +#### 5.3.4.1 General + +The Resource List Server (RLS) is an implementation of the presence list server. The RLS is an entity that accepts subscriptions to resource lists and sends notifications to update subscribers of the state of the resources in a resource list. + +In addition to the procedures specified in subclause 5.3.4, the RLS shall support the procedures specified in 3GPP TS 24.229 [9] appropriate for an AS in which the RLS is implemented. + +#### 5.3.4.2 Subscription acceptance to resource lists and notification of state changes + +When the RLS receives a SUBSCRIBE request for the presence information event package of a presentity collection, the RLS shall first verify the identity of the source of the SUBSCRIBE request as described in 3GPP TS 24.229 [9] subclause 5.7.1.4, then perform authorization according to 3GPP TS 24.229 [9] subclause 5.7.1.5. In case of successful subscription, the RLS shall generate a response to the SUBSCRIBE request and notifications in accordance with RFC 6665 [19] and RFC 4662 [22] by adding a Require header field with value "eventlist". + +If the body of the SUBSCRIBE request from the watcher contains filters, the RLS shall apply the requested filtering function on notifications in accordance with RFC 4661 [30], and RFC 4660 [31] as updated by RFC 6665 [19]. + +#### 5.3.4.3 Subscription to presence information + +When the RLS receives a SUBSCRIBE request for the presence information event package of a presentity collection and installs the corresponding subscription, the RLS shall resolve the list URI to individual URIs and generate SUBSCRIBE requests for each of the individual URIs as per the procedures in RFC 6665 [19], RFC 3856 [27] and RFC 4662 [22] if the state information for the resource represented by the individual URI is otherwise not available. + +For internal virtual subscriptions, the detection of loops potentially caused by lists of lists is possible in RLS. However for back-end subscriptions (see RFC 4662 [22]), the detection of such situations is not possible in RLS. To prevent + +loops in subscriptions to non-local resources the RLS shall not insert "eventlist" in the "Supported" header of back-end subscriptions. + +#### 5.3.4.4 Subscription acceptance and notification of state changes in XML document + +When the RLS receives a SUBSCRIBE request having the Event header value "xcap-diff", the RLS shall first verify the identity of the source of the SUBSCRIBE request as described in 3GPP TS 24.229 [9] subclause 5.7.1.4, then it shall perform authorization as described in 3GPP TS 24.229 [9] subclause 5.7.1.5. Afterwards, the RLS shall generate a response to the SUBSCRIBE request and notifications in accordance with RFC 5875 [43] and RFC 6665 [19]. + +### 5.3.5 Presence Network Agent (PNA) + +#### 5.3.5.1 General + +In addition to the procedures specified in subclause 5.3.5, the PNA shall support the procedures specified in 3GPP TS 24.229 [9] appropriate to the functional entity in which the PNA is implemented. + +The PNA can collect presence information about the presentity from a number of core network entities. The PNA can combine information from various core network entities to form more complete presence information. + +Among these core network entities, the S-CSCF uses SIP to deliver presence information to the PNA over the Pi reference point as specified in subclause 5.3.5.2. + +NOTE: As part of the configuration of AS to provide a presence system, appropriate settings are downloaded to the initial filter criteria in the S-CSCF to ensure this occurs. The PNA will receive third-party REGISTER requests as specified in 3GPP TS 24.229 [9] subclauses 5.4.1.7 and 5.7.1.1. + +#### 5.3.5.2 Subscription to reg event package + +On receiving a third-party REGISTER request which contains an Expires header with a non-zero value, the PNA shall, if no subscription already exists, subscribe to the reg event package for a particular user at the S-CSCF, as described in 3GPP TS 24.229 [9] subclause 5.7.1.1. As a result, the S-CSCF will then provide the presence-related information as reg event packages in NOTIFY requests to the PNA. + +On receiving a third-party REGISTER request, the PNA may, if a subscription already exists, resubscribe to the reg event package for a particular user at the S-CSCF, as described in 3GPP TS 24.229 [9] subclause 5.7.1.1. As a result, the S-CSCF will then provide the presence-related information as reg event packages in NOTIFY requests to the PNA. + +#### 5.3.5.3 Publication of network presence information + +To publish network presence information received from 3GPP2 IP-CAN, the PNA shall follow the procedures defined in 3GPP2 X.S0027-004 [46]. + +# --- 6 Protocol for data manipulation at the Ut reference point + +## 6.1 Introduction + +XML Configuration Access Protocol (XCAP) is used to store, alter and delete data related to the presence service. XCAP is designed according to the Hypertext Transfer Protocol (HTTP) framework, and uses the HTTP methods PUT, GET and DELETE for communication over the Ut reference point. The general information that can be manipulated is user groups, subscription authorization policy, resource lists, hard state presence publication, MIME objects referenced from the hard state presence information, etc. Soft state presence information manipulated with a PUBLISH request is not manipulated by the mechanism provided over the Ut reference point. + +## 6.2 Functional entities + +### 6.2.1 User Equipment (UE) + +The UE implements the XCAP client role as described in subclause 6.3.1. + +For accessing presence servers in 3GPP system: + +- 1) The UE shall implement HTTP digest AKA (see RFC 3310 [20]) and it shall initiate a bootstrapping procedure with the bootstrapping server function located in the home network, as described in 3GPP TS 24.109 [7]. +- 2) The UE shall acquire the subscriber's certificate from PKI portal by using a bootstrapping procedure, as described in 3GPP TS 24.109 [7]; +- 3) The UE shall implement HTTP digest authentication (see RFC 2617 [15A]); and +- 4) The UE shall implement Transport Layer Security (TLS) according to the TLS profile specified in 3GPP TS 33.310 [r33310] annex E. The UE shall be able to authenticate the network application function based on the received certificate during TLS handshaking phase. + +For accessing presence servers in 3GPP2 system, the subscriber shall be authenticated by the presence server. subscriber authentication may be performed by the operator using proprietary or non-3G standardized methods. GBA defined in 3GPP2 S.S0109 [48] may also be used. If GBA based subscriber authentication is used, then the following shall apply: + +- 1) The UE shall implement bootstrapping procedures as specified in 3GPP2 S.S0109 [48]; and +- 2) The UE shall implement TLS with pre-shared keys method specified in clause 5 of 3GPP2 S.S0114 [49]. + +### 6.2.2 Application Server (AS) + +If an AS implements the role of a PS (see subclause 5.3.3) or of a RLS (see subclause 5.3.4), then the AS shall also implement the role of a XCAP server (see subclause 6.3.2). + +If there is no authentication proxy in the network, then the AS in 3GPP system shall: + +- 1) implement the role of a network application function, as described in 3GPP TS 24.109 [7]; +- 2) implement TLS according to the TLS profile specified in 3GPP TS 33.310 [51] annex E; +- 3) implement HTTP digest authentication (see RFC 2617 [15A]); and +- 4) support certificate authentication. + +For 3GPP2 system, the authentication proxy does not apply. If GBA based authentication is used by an AS in 3GPP2 system, then the AS shall: + +- 1) implement the role of a network application function, as described in 3GPP2 S.S0114 [49]; and +- 2) implement TLS with pre-shared keys method specified in clause 5 of 3GPP2 S.S0114 [49]. + +### 6.2.3 Authentication proxy + +For 3GPP2 system, this subclause does not apply. + +The generic requirements for an authentication proxy are defined in 3GPP TS 24.109 [7]. + +In addition an authentication proxy acting within the scope of presence shall: + +- 1) verify the content of the "X-3GPP-Intended-Identity" header in case it is available in HTTP requests; and +- 2) indicate an asserted identity of the user in the "X-3GPP-Asserted-Identity" header in HTTP requests sent to the AS. + +## 6.3 Roles + +### 6.3.1 XCAP client + +#### 6.3.1.1 Introduction + +The XCAP client is a logical function as defined in RFC 4825 [33]. The XCAP client provides the means to manipulate the data such as user groups, subscription authorization policy, resource lists, hard state presence information, MIME objects referenced from the hard state presence information, etc. + +NOTE: In order to be able to manipulate data stored on the XCAP server, the XCAP client has the root directory on the XCAP server pre-configured or uses some means to discover it. Discovery mechanisms are outside the scope of the present document. + +#### 6.3.1.2 Manipulating a resource list + +When the XCAP client intends to manipulate a resource list, it shall generate an HTTP PUT, HTTP GET or HTTP DELETE request in accordance with RFC 2616 [15], RFC 4825 [33] and RFC 4826 [36]. + +#### 6.3.1.3 Manipulating the subscription authorization policy + +When the XCAP client intends to manipulate the subscription authorization policy, it shall generate an HTTP PUT, HTTP GET or HTTP DELETE request in accordance with RFC 2616 [15], RFC 4825 [33], RFC 4745 [35A], and RFC 5025 [35]. + +When the XCAP client intends to authorize particular watchers or watcher groups, the XCAP client shall authorize those watchers in and child elements of the element as specified in RFC 4745 [35A]. + +When the XCAP client intends to time-restrict presence attributes, the XCAP client shall define time periods in elements as specified in RFC 4745 [35A]. + +When the XCAP client intends to provide certain presence attributes to particular watchers or watcher groups and not others, the XCAP client shall permit those presence attributes in the element as specified in RFC 5025 [35]. + +When the XCAP client intends to authorize providing a particular presence attribute to different watchers or watcher groups depending on the value of that attribute, the XCAP client shall specify those attribute values in the element as specified in RFC 5025 [35]. + +#### 6.3.1.4 Publishing hard state presence information + +The XCAP client shall implement RFC 4827 [34] in order to be able to manipulate hard state presence information. Hard state presence information uses the same format as soft state information, namely "application/pidf+xml" content type as described in RFC 3863 [21] together with any of its extensions. + +When the hard state presence information contains one or more MIME objects to be aggregated with the "application/pidf+xml" content type and any of its extensions, the XCAP client shall: + +- a) construct as many HTTP URIs as the number of objects to be stored and formulate every HTTP URI according to a predefined directory structure; + +NOTE: In order to be able to manipulate data stored on the XCAP server, the XCAP client has the root directory on the XCAP server pre-configured or use some means to discover it. Discovery mechanisms are outside the scope of the present document. + +- b) store the objects on the XCAP server behind the HTTP URI(s) created in the previous step using standard HTTP procedures as defined in RFC 2616 [15]; +- c) include every HTTP URI as a value of the corresponding XML element in the published "application/pidf+xml" presence document referencing the stored object(s) in the previous step; and +- d) publish the hard state presence information according to RFC 4827 [34]. + +### 6.3.2 XCAP server + +#### 6.3.2.1 Introduction + +The XCAP server is a logical function as defined in RFC 4825 [33]. The XCAP server can store data such as user groups, subscription authorization policy, resource lists, hard state presence information, MIME objects referenced from the hard state presence information, etc. + +#### 6.3.2.2 Resource list manipulation acceptance + +When the XCAP server receives an HTTP PUT, HTTP GET or HTTP DELETE request for manipulating or fetching a resource list, the XCAP server shall first authenticate the request in accordance with 3GPP TS 24.109 [7] and then perform authorization. Afterwards the XCAP server shall perform the requested action and generate a response in accordance with RFC 2616 [15], RFC 4825 [33] and RFC 4826 [36]. + +#### 6.3.2.3 Subscription authorization policy manipulation acceptance + +When the XCAP server receives an HTTP PUT, HTTP GET or HTTP DELETE request for manipulating or fetching of the subscription authorization policy, the XCAP server shall first authenticate the request in accordance with 3GPP TS 24.109 [7] and then perform authorization. Afterwards the XCAP server shall perform the requested action and generate a response in accordance with RFC 2616 [15], RFC 4825 [33], RFC 4745 [35A], and RFC 5025 [35]. + +#### 6.3.2.4 Publication acceptance of hard state presence information + +When the XCAP server receives an HTTP PUT, HTTP GET or HTTP DELETE request for publishing, fetching or deleting of hard state presence information, the XCAP server shall first authenticate the request in accordance with 3GPP TS 24.109 [7] and then perform authorization. Afterwards the XCAP server shall: + +- a) if the HTTP URI points to a predefined directory reserved for storing MIME objects and the request is an HTTP PUT request, replace any existing content referenced by the Request-URI with the content of the request; +- b) if the Request-URI points to an uncreated directory and the request is HTTP PUT, create the directory, store the content there and associate the content with the Request-URI. For all requests, i.e. HTTP PUT, HTTP GET and HTTP DELETE requests, generate an appropriate response in accordance with RFC 2616 [15]; or +- c) if the HTTP URI points to an XCAP directory and the Application Unique ID (AUID) part of the HTTP URI is set to "pidf-manipulation", process the request and generate an appropriate response in accordance with RFC 4825 [33], RFC 4827 [34] and RFC 2616 [15]. + +# --- 7 Presence information model of the 3GPP subscriber + +## 7.1 General + +Void. + +## 7.2 XML schema definitions + +Void. + +## 7.3 XML schema descriptions + +Void. + +# --- Annex A (informative): Example signalling flows of presence service operation + +## A.1 Scope of signalling flows + +This annex gives examples of signalling flows for the presence service within the IP Multimedia (IM) Core Network (CN) subsystem based on the Session Initiation Protocol (SIP) and SIP Events. + +These signalling flows provide detailed signalling flows, which expand on the overview information flows provided in 3GPP TS 23.141 [4]. + +## --- A.2 Introduction + +### A.2.1 General + +The signalling flows provided in this annex follow the methodology developed in 3GPP TS 24.228 [8]. The following additional considerations apply: + +- a) 3GPP TS 24.228 [8] shows separate signalling flows with no configuration hiding between networks, and with configuration hiding between networks. There is no presence specific functionality associated with this hiding, and therefore such separate signalling flows are not shown in the present document; and +- b) 3GPP TS 24.228 [8] does not show the functionality between the S-CSCF and the AS. As the presence service depends on the functionality provided by various AS, the signalling flows between S-CSCF and AS are shown in the present document. + +### A.2.2 Key required to interpret signalling flows + +The key to interpret signalling flows specified in 3GPP TS 24.228 [8] subclauses 4.1 and 4.2 applies with the additions specified below. + +- rls.home1.net: an RLS in the home network of the watcher; +- rls.home2.net: an RLS in the home network of the service provider, but not the home network of the watcher; +- ps.home1.net: a PS in the home network of the publisher; +- ps.home2.net: a PS in the home network of the service provider, but not in that of the watcher; +- user1\_list1@home1.net: a resource list being subscribed to on a RLS in the home network; +- user2\_list1@home2.net: a resource list being subscribed to on a RLS in the home network of the service provider, but not the home network of the subscriber; +- user1\_public1@home1.net: presentity being watched, own watcher list; +- user3\_public1@home3.net: presentity being watched. + +As in 3GPP TS 24.228 [8], in order to differentiate between SIP methods and other protocol messages, the message name is preceded with the associated protocol for all non-SIP messages. Where the XCAP is used to map an HTTP URI to an XML document, the protocol name "XCAP" is used for both the HTTP request and HTTP response. + +Each signalling flow table contains descriptions for headers where the content of the header is new to that signalling flow, as is already performed in 3GPP TS 24.228 [8]. + +However, 3GPP TS 24.228 [8] includes extensive descriptions for the contents of various headers following each of the tables representing the contents of the signalling flows. Where the operation of the header is identical to that shown in 3GPP TS 24.228 [8], then such text is not reproduced in the present document. + +Additional text may also be found on the contents of headers within 3GPP TS 24.228 [8] in addition to the material shown in the present document. + +## A.3 Signalling flows demonstrating how watchers subscribe to presence event notification + +### A.3.1 Introduction + +The subclause covers the signalling flows that show how watchers can request presence information about a presentity. + +For the routing of the Public Service Identity (PSI) towards the AS, there are two scenarios: + +Subclause A.3.3.2 shows the case where the I-CSCF forwards the SUBSCRIBE request directly to the RLS when the RLS is located within the same network. There is another scenario where the I-CSCF forwards the SUBSCRIBE request towards the RLS, being involved with the S-CSCF located in the same network, but this scenario is not described in the present document. + +### A.3.2 Watcher and presentity in different networks, UE in home network + +#### A.3.2.1 Successful subscription + +![Sequence diagram showing the successful subscription process for presence information between a Watcher UE and an AS(PS) across two networks.](7ede87328f6b696dcffa65ebc4570cc8_img.jpg) + +``` + +sequenceDiagram + participant UE as UE (Watcher) + subgraph Home Network#1 + participant P-CSCF1 as P-CSCF#1 + participant S-CSCF1 as S-CSCF#1 + end + subgraph Home Network#2 + participant I-CSCF + participant HSS + participant S-CSCF2 as S-CSCF#2 + participant AS as AS(PS) + end + + Note right of S-CSCF1: 3. Evaluation of initial filter criteria + Note right of S-CSCF2: 7. Evaluation of initial filter criteria + Note right of AS: 9. Watcher authorisation + + UE->>P-CSCF1: 1. SUBSCRIBE + P-CSCF1->>S-CSCF1: 2. SUBSCRIBE + S-CSCF1->>I-CSCF: 4. SUBSCRIBE + I-CSCF->>HSS: 5. Cx: User location query + I-CSCF->>S-CSCF2: 6. SUBSCRIBE + S-CSCF2->>AS: 8. SUBSCRIBE + AS->>S-CSCF2: 10. 200 (OK) + S-CSCF2->>I-CSCF: 11. 200 (OK) + I-CSCF->>S-CSCF1: 12. 200 (OK) + S-CSCF1->>P-CSCF1: 13. 200 (OK) + P-CSCF1->>UE: 14. 200 (OK) + AS->>S-CSCF2: 15. NOTIFY + S-CSCF2->>S-CSCF1: 16. NOTIFY + S-CSCF1->>P-CSCF1: 17. NOTIFY + P-CSCF1->>UE: 18. 200 (OK) + S-CSCF1->>S-CSCF2: 19. 200 (OK) + S-CSCF2->>AS: 20. 200 (OK) + +``` + +The sequence diagram illustrates the successful subscription process for presence information. It begins with the UE (Watcher) sending a SUBSCRIBE request to P-CSCF#1. P-CSCF#1 forwards it to S-CSCF#1, which evaluates initial filter criteria and then sends a SUBSCRIBE to I-CSCF. I-CSCF performs a Cx: User location query with the HSS and then sends a SUBSCRIBE to S-CSCF#2. S-CSCF#2 evaluates initial filter criteria and sends a SUBSCRIBE to AS(PS). AS(PS) performs watcher authorisation and returns a 200 (OK) response. This response is passed back through S-CSCF#2, I-CSCF, S-CSCF#1, and P-CSCF#1 to the UE. Subsequently, the AS(PS) sends a NOTIFY message to S-CSCF#2, which is then passed back through S-CSCF#1 and P-CSCF#1 to the UE. Finally, 200 (OK) responses are returned from the UE to P-CSCF#1, P-CSCF#1 to S-CSCF#1, S-CSCF#1 to S-CSCF#2, and S-CSCF#2 to AS(PS). + +Sequence diagram showing the successful subscription process for presence information between a Watcher UE and an AS(PS) across two networks. + +Figure A.3.2.1-1: Watcher subscribing for presence information + +Figure A.3.2.1-1 shows a watcher subscribing to presence event notification about a presentity. The presentity is in a different IM CN subsystem. The details of the signalling flows are as follows: + +##### 1. **SUBSCRIBE request (UE (watcher) to P-CSCF) - see example in table A.3.2.1-1** + +A watcher agent in a UE wishes to watch a presentity, or certain presence information of the presentity. To initiate a subscription, the UE generates a SUBSCRIBE request containing the "presence" event that it wishes to be notified of, together with an indication of the length of time this periodic subscription should last and the support for partial notification. + +**Table A.3.2.1-1: SUBSCRIBE request (UE (watcher) to P-CSCF)** + +``` +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedrflj40a222 +CSeq: 61 SUBSCRIBE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port-c=8642; port-s=7531 +Event: presence +Expires: 7200 +Accept: application/pidf+xml;q=0.3, application/pidf-diff+xml;q=1 +Contact: +Content-Length: 0 +``` + +**Request-URI:** Public user identity whose events the subscriber subscribes to. + +**Event:** This field is populated with the value "presence" to specify the use of the presence package. + +**Accept:** This field is populated with the value 'application/pidf+xml' and 'application/pidf-diff+xml', latter one with higher preference. + +**To:** Same as the Request-URI. + +##### 2. **SUBSCRIBE request (P-CSCF to S-CSCF) - see example in table A.3.2.1-2** + +The P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The SUBSCRIBE request is forwarded to S-CSCF. A Route header is inserted into SUBSCRIBE request. The information for the Route header is taken from the service route determined during registration. + +**Table A.3.2.1-2: SUBSCRIBE request (P-CSCF to S-CSCF)** + +``` +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Access-Network-Info: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: +``` + +##### 3. Evaluation of initial filter criteria + +S-CSCF#1 validates the service profile of this subscriber and evaluates the initial filter criteria. In this example, no AS is assumed to be involved. + +##### 4. SUBSCRIBE request (S-CSCF to I-CSCF) - see example in table A.3.2.1-4 + +S-CSCF#1 performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, S-CSCF#1 forwards the SUBSCRIBE request directly to the I-CSCF in the destination network. + +**Table A.3.2.1-4: SUBSCRIBE (S-CSCF to I-CSCF)** + +``` +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;;branch=z9hG4bKnashds7 +Max-Forwards: 68 +P-Asserted-Identity: , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: +Record-Route: , +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: +``` + +##### 5. Cx: User Location Query procedure + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +For detailed message flows see 3GPP TS 29.228 [10]. + +Table A.3.2.1-5a provides the parameters in the SIP SUBSCRIBE request (flow 4), which are sent to the HSS. + +**Table A.3.2.1-5a: Cx: User location query procedure (I-CSCF to HSS)** + +| Message source and destination | Cx: Information element name | Information source in SIP SUBSCRIBE | Description | +|--------------------------------|------------------------------|-------------------------------------|-------------------------------------------------------------| +| I-CSCF to HSS | User Public Identity | Request-URI | This information element indicates the public user identity | + +Table A.3.2.1-5b provides the parameters sent from the HSS that need to be mapped to the SIP SUBSCRIBE request (flow 6) and sent to the S-CSCF. + +**Table A.3.2.1-5b: Cx: User location query procedure (HSS to I-CSCF)** + +| Message source and destination | Cx: Information element name | Mapping to SIP header in SIP SUBSCRIBE | Description | +|--------------------------------|------------------------------|----------------------------------------|-----------------------------------------------------------------| +| HSS to I-CSCF | S-CSCF name | Route header field | This information indicates the serving CSCF's name of that user | + +##### 6. SUBSCRIBE request (I-CSCF to S-CSCF) - see example in table A.3.2.1-6 + +The I-CSCF forwards the SUBSCRIBE request to the S-CSCF (S-CSCF#2) that will handle the termination. + +**Table A.3.2.1-6: SUBSCRIBE request (I-CSCF to S-CSCF)** + +``` +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: +``` + +NOTE: The I-CSCF does not add itself to the Record-Route header, as it has no need to remain in the signalling path for the subsequent requests. + +##### 7. Evaluation of initial filter criteria + +S-CSCF#2 validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:user2\_public1@home2.net S-CSCF#2 has termination initial filter criteria with Service Point Trigger of Method = SUBSCRIBE and Event = "presence" that informs the S-CSCF to route the SUBSCRIBE request to the AS ps.home2.net. The S-CSCF#2 has preconfigured information not to create a Record-Route entry for this request. + +##### 8. SUBSCRIBE request (S-CSCF to PS) – see example in table A.3.2.1-8 + +The S-CSCF forwards the SUBSCRIBE request to the PS. + +**Table A.3.2.1-8: SUBSCRIBE request (S-CSCF to PS)** + +``` +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +Route: , +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: +``` + +###### **P-Charging-Vector:** + +The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the originating + +Inter Operator Identifier (IOI) parameter of this header and removes the terminating IOI parameter. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the PS. + +##### 9. Authorization of watcher + +The PS performs the necessary authorization checks on the originator to ensure it is allowed to watch the presentity. In this example all privacy conditions are met, so the PS sends a 200 (OK) response to the S-CSCF. + +In the case where the privacy/authorization checks fails, then a necessary 2xx or 4xx response will be sent to the S-CSCF. The selection of the correct response code depends on the presentity's subscription authorization policy document. + +##### 10. 200 (OK) response (PS to S-CSCF) - see example in table A.3.2.1-10 + +The PS sends the response to S-CSCF#2. + +**Table A.3.2.1-10: 200 (OK) response (PS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP +pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; +term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +**P-Charging-Vector:** The PS stores the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS stores the P-Charging-Function-Addresses header field and passes this header to the S-CSCF. + +##### 11. 200 (OK) response (S-CSCF to I-CSCF) - see example in table A.3.2.1-11 + +S-CSCF#2 forwards the response to I-CSCF#2. + +**Table A.3.2.1-11: 200 (OK) response (S-CSCF to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP +pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: +P-Charging-Function-Addresses: +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the I-CSCF. + +##### 12. **200 (OK) response (I-CSCF to S-CSCF) - see example in table A.3.2.1-12** + +I-CSCF#2 forwards the response to S-CSCF#1. + +**Table A.3.2.1-12: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### 13. **200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.1-13** + +S-CSCF#1 forwards the response to P-CSCF#1. + +**Table A.3.2.1-13: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### 14. **200 (OK) response (P-CSCF to UE) - see example in table A.3.2.1-14** + +P-CSCF#1 forwards the response to the watcher agent in the UE. + +**Table A.3.2.1-14: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### 15. **NOTIFY request (PS to S-CSCF) - see example in table A.3.2.1-15** + +As soon as the PS sends a 200 (OK) response to accept the subscription, it sends a NOTIFY request with the current state of the presentity's presence information that the watcher has subscribed and been authorized to. + +The NOTIFY request is sent to S-CSCF#1. Based on the Accept header field of the SUBSCRIBE request, the PS decides to use partial notification to provide changes of presence information. + +**Table A.3.2.1-15: NOTIFY request (PS to S-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedlrfjflslj40a222 +CSeq: 42 NOTIFY +Subscription-State: active ;expires=7200 +Event: presence +Contact: +Content-Type: application/pidf-diff +xml +Content-Length: (...) + + + + + + + open + + sip + + http://example.com/~user2/icon.gif + + false + true + + sip:user2_public1@home2.net + Don't Disturb Please! + Ne derangez pas, s'il vous plait + 2003-08-27T11:49:29Z + + + + + open + + assistant + + tel:+1-212-555-2222 + She's my secretary + 2003-08-27T11:49:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + + +``` + +###### **P-Charging-Vector:** + +The PS populates the icid parameter with a globally unique identifier and adds the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +**Content-Type:** Set to the preferred value of the Accept header received in the SUBSCRIBE request. + +The message body in the NOTIFY request that carries the presence information of the presentity is formed as indicated in RFC 3863 [21], RFC 4480 [26], RFC 5196 [25], RFC 4482 [32], RFC 5263 [24] and RFC 4479 [44]. + +##### **16. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.2.1-16** + +The S-CSCF#1 forwards the NOTIFY request to P-CSCF#1. + +**Table A.3.2.1-16: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP +ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Charging-Function-Addresses: +Privacy: +Record-Route: +Route: sip: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter of this header and removes the parameter from this header. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +##### **17. NOTIFY request (P-CSCF to UE) - see example in table A.3.2.1-17** + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.2.1-17: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , +Privacy: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +##### **18. 200 (OK) response (UE to P-CSCF) - see example in table A.3.2.1-18** + +The UE generates a 200 (OK) response to the NOTIFY request. + +**Table A.3.2.1-18: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **19. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.3.2.1-19** + +The P-CSCF forwards the 200 (OK) response to S-CSCF#1. + +**Table A.3.2.1-19: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **20. 200 (OK) response (S-CSCF to P-S) - see example in table A.3.2.1-20** + +S-CSCF#2 forwards the 200 (OK) response to the PS. + +**Table A.3.2.1-20: 200 (OK) response (S-CSCF to PS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +### A.3.3 Watcher subscribing to resource list, UE in visited network + +#### A.3.3.1 Watcher subscribing to his own resource list, UE in visited network - Successful subscription + +![Sequence diagram showing the successful subscription process for a watcher in a visited network. The diagram is divided into two main sections: 'Visited Network' (containing UE, P-CSCF, and S-CSCF) and 'Home Network of UE' (containing AS(RLS)). The sequence of messages is as follows: 1. UE sends SUBSCRIBE to P-CSCF; 2. P-CSCF sends SUBSCRIBE to S-CSCF; 3. S-CSCF performs 'Evaluation of initial filter criteria'; 4. S-CSCF sends SUBSCRIBE to AS(RLS); 5. AS(RLS) performs 'Watcher Authorisation'; 6. AS(RLS) sends 200 (OK) to S-CSCF; 7. S-CSCF sends 200 (OK) to P-CSCF; 8. P-CSCF sends 200 (OK) to UE; 9. AS(RLS) sends NOTIFY to S-CSCF; 10. S-CSCF sends NOTIFY to P-CSCF; 11. P-CSCF sends NOTIFY to UE; 12. UE sends 200 (OK) to P-CSCF; 13. P-CSCF sends 200 (OK) to S-CSCF; 14. S-CSCF sends 200 (OK) to AS(RLS); 15. AS(RLS) performs 'Subscriptions and notifications on presence event package'; 16. AS(RLS) sends NOTIFY to S-CSCF; 17. S-CSCF sends NOTIFY to P-CSCF; 18. P-CSCF sends NOTIFY to UE; 19. UE sends 200 (OK) to P-CSCF; 20. P-CSCF sends 200 (OK) to S-CSCF; 21. S-CSCF sends 200 (OK) to AS(RLS).](7d2d1d3870cd224c4430d19334557716_img.jpg) + +Sequence diagram showing the successful subscription process for a watcher in a visited network. The diagram is divided into two main sections: 'Visited Network' (containing UE, P-CSCF, and S-CSCF) and 'Home Network of UE' (containing AS(RLS)). The sequence of messages is as follows: 1. UE sends SUBSCRIBE to P-CSCF; 2. P-CSCF sends SUBSCRIBE to S-CSCF; 3. S-CSCF performs 'Evaluation of initial filter criteria'; 4. S-CSCF sends SUBSCRIBE to AS(RLS); 5. AS(RLS) performs 'Watcher Authorisation'; 6. AS(RLS) sends 200 (OK) to S-CSCF; 7. S-CSCF sends 200 (OK) to P-CSCF; 8. P-CSCF sends 200 (OK) to UE; 9. AS(RLS) sends NOTIFY to S-CSCF; 10. S-CSCF sends NOTIFY to P-CSCF; 11. P-CSCF sends NOTIFY to UE; 12. UE sends 200 (OK) to P-CSCF; 13. P-CSCF sends 200 (OK) to S-CSCF; 14. S-CSCF sends 200 (OK) to AS(RLS); 15. AS(RLS) performs 'Subscriptions and notifications on presence event package'; 16. AS(RLS) sends NOTIFY to S-CSCF; 17. S-CSCF sends NOTIFY to P-CSCF; 18. P-CSCF sends NOTIFY to UE; 19. UE sends 200 (OK) to P-CSCF; 20. P-CSCF sends 200 (OK) to S-CSCF; 21. S-CSCF sends 200 (OK) to AS(RLS). + +**Figure A.3.3.1-1: Watcher subscribing to resource list** + +Figure A.3.3.1-1 shows a watcher subscribing to resource list event notification. The details of the signalling flows are as follows: + +##### **1. SUBSCRIBE request (UE to P-CSCF) – see example in table A.3.3.1-1** + +A watcher agent in a UE wishes to watch a number of presentities, or certain presence information of these presentities. The list of presentities are identified by a SIP URI. In order to initiate a subscription to the RLS, the UE generates a SUBSCRIBE request indicating support for "eventlist", together with an indication of the length of time this periodic subscription should last. + +**Table A.3.3.1-1: SUBSCRIBE request (UE to P-CSCF)** + +``` + +SUBSCRIBE sip:user1_list1@home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedrflj40a222 +CSeq: 123 SUBSCRIBE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port- +c=8642; port-s=7531 +Event: presence +Supported: eventlist +Expires: 7200 +Accept: application/pidf+xml, application/rlmi+xml, multipart/related +Contact: +Content-Length: 0 + +``` + +**Request-URI:** SIP URI of the resource list representing the collection of public user identities whose events the subscriber subscribes to. + +**Event:** This field is populated with the value "presence" to specify the use of the presence package. + +**Accept:** This field is populated with the value "application/pidf+xml", "application/rlmi+xml" and "multipart/related" indicating that the UE supports both body types for the eventlist extension additionally to PIDF. + +**Supported:** This field is populated with the value "eventlist" to specify the support for the eventlist extension. + +**To:** Same as the Request-URI. + +##### 2. SUBSCRIBE request (P-CSCF to S-CSCF) – see example in table A.3.3.1-2 + +The P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The SUBSCRIBE request is forwarded to S-CSCF#1. A Route header is inserted into SUBSCRIBE request. The information for the Route header is taken from the service route determined during registration. + +**Table A.3.3.1-2: SUBSCRIBE request (P-CSCF to S-CSCF)** + +``` + +SUBSCRIBE sip:user1_list1@home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Access-Network-Info: +Route: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +Privacy: +Record-Route: +Route: +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Length: + +``` + +##### 3. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. Assuming that sip:user1\_list1@home1.net is a statically created PSI, sip:user1\_list1@home1.net is included in the service profile as part of an originating initial Filter Criteria with Service Trigger Point of Method = SUBSCRIBE AND Supported = "eventlist" AND Request-URI = sip:user1\_list1@home1.net that informs the S-CSCF to route the SUBSCRIBE request to the AS sip:rls.home1.net. + +If there is no initial filter criteria for this PSI (sip:user1\_list1@home1.net), the assumption is that the PSI is a sub domain-based PSI. The procedure defined in RFC 3263 [18] with DNS NAPTR and SRV queries may then be used to get the IP address of the AS home1.net. + +##### 4. SUBSCRIBE request (S-CSCF to RLS) – see example in table A.3.3.1-4 + +The S-CSCF forwards the SUBSCRIBE request to the RLS. + +**Table A.3.3.1-4: SUBSCRIBE request (S-CSCF to RLS)** + +``` +SUBSCRIBE sip:user1_list1@home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 68 +P-Access-Network-Info: +P-Asserted-Identity: , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +Record-Route: , +Route: , +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the RLS. + +##### 5. Authorization of watcher + +The RLS performs the necessary authorization checks on the originator to ensure that he/she is authorized to use the resource list. In this example this condition has been met, so the PS sends a 200 (OK) response to the S-CSCF. If the previous condition failed, then a 403 (Forbidden) response would be sent to the S-CSCF. + +##### 6. 200 (OK) response (RLS to S-CSCF) - see example in table A.3.3.1-6 + +The RLS sends the response to the S-CSCF. + +**Table A.3.3.1-6: 200 (OK) response (RLS to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net; + term-ioi=home1.net +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Require: eventlist +Expires: +Contact: +Content-Length: 0 + +``` + +**P-Charging-Vector:** The RLS stores the terminating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +##### 7. **200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.3.1-7** + +The S-CSCF forwards the response to the P-CSCF. + +**Table A.3.3.1-7: 200 (OK) response (S-CSCF to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +Record-Route: +From: +To: +Call-ID: +CSeq: +Require: +Expires: +Contact: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter received. + +##### 8. **200 (OK) response (P-CSCF to UE) - see example in table A.3.3.1-8** + +The P-CSCF forwards the response to the watcher agent in the UE. + +**Table A.3.3.1-8: 200 (OK) response (P-CSCF to UE)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Record-Route: , +From: +To: +Call-ID: +CSeq: +Require: +Expires: +Contact: +Content-Length: + +``` + +##### 9. **NOTIFY request (RLS to S-CSCF) - see example in table A.3.3.1-9** + +The RLS generates a NOTIFY request including the RLMI document as a result of the SUBSCRIBE request. + +**Table A.3.3.1-9 NOTIFY request (RLS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj40a222 +CSeq: 89 NOTIFY +Subscription-State: active;expires=7200 +Require: eventlist +Event: presence +Contact: +Content-Type: application/rlmi+xml;charset="UTF-8" +Content-Length: + + + + + Kovacs Janos + + + + Szabo Bela + + + + +``` + +**P-Charging-Vector:** The RLS inserts this header and populates the icid parameters with a globally unique value and adds the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The RLS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +##### 10. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.3.1-10 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.3.3.1-10: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF stores originating Inter Operator Identifier (IOI) parameter received. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +##### **11. NOTIFY request (P-CSCF to UE) – see example in table A.3.3.1-11** + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.3.1-11: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Length: + +(...) +``` + +##### **12. 200 (OK) response (UE to P-CSCF) – see example in table A.3.3.1-12** + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.3.3.1-12: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **13. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.3.3.1-13** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.3.3.1-13: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **14. 200 (OK) response (S-CSCF to RLS) - see example in table A.3.3.1-14** + +The S-CSCF#2 forwards the response to the RLS in the home network of the UE. + +**Table A.3.3.1-14: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +##### 15. Subscriptions and notifications on presence event package + +After the RLS generated a NOTIFY request to inform the UE about the subscription state, the RLS generates the necessary SUBSCRIBE requests to the presentities present in the resource list as described in subclause A.3.4.1. As soon as it receives NOTIFY request(s) about a state change in one or more presentities, it generates a NOTIFY request. + +##### 16. NOTIFY request (RLS to S-CSCF) – see example in table A.3.3.1-16 + +The RLS copies the body of the incoming NOTIFY request(s) into the body of the outgoing NOTIFY request using MIME type multipart/related. Further notification sent by the RLS may contain either the full or the partial set of presence information (only the presence information that has changed since the last notification) as described in RFC 4662 [22]. + +In this example it is assumed that the RLS has received two NOTIFY requests from presentities sip:user2\_public1@home2.net and sip:user3\_public1@home3.net before generating the NOTIFY request in table A.3.3.1-16 to the UE. + +**Table A.3.3.1-16 NOTIFY request (RLS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrfljflsj40a222 +CSeq: 90 NOTIFY +Subscription-State: active;expires=5000 +Require: eventlist +Event: presence +Contact: +Content-Type: multipart/related;type="application/rlmi+xml"; + start="";boundary="50UBfW7LSCVLtggUPe5z" +Content-Length: (...) + +--50UBfW7LSCVLtggUPe5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/rlmi+xml;charset="UTF-8" + + + + + Kovacs Janos + + + + Szabo Bela + + + + +--50UBfW7LSCVLtggUPe5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/pidf+xml;charset="UTF-8" + + + + + + + open + + sip + + http://example.com/~user2/icon.gif + + false + true + + sip:user2_public1@home2.net + Don't Disturb Please! + + + +``` + +``` + +Ne derangez pas, s'il vous plait +2003-08-27T11:49:29Z + + + + + open + + assistant + + tel:+1-212-555-2222 + She's my secretary + 2003-08-27T11:49:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + + + +--50UBfW7LSCVLtgguPE5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/pidf+xml;charset="UTF-8" + + + + + + + closed + + sip + + + false + true + + sip:user3_public1@home3.net + Don't Disturb Please! + Senki se merjen zavarni! + 2003-08-27T11:48:59Z + + + + + open + + supervisor + + tel:+1-858-204-9141 + He's my supervisor + 2003-08-27T11:48:59Z + + + + http://example.com/~user3 + http://example.com/~user3/card.vcd + presentity + + + + + + +--50UBfW7LSCVLtgguPE5z-- + +``` + +**P-Charging-Vector:** The RLS inserts this header and populates the icid parameters with a globally unique value and adds the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The RLS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +**Content-Type:** Set to the value of the Accept: header received in the SUBSCRIBE request. + +The message body in the NOTIFY request that carries the presence information of the presentity is formed as indicated in RFC 4662 [22], RFC 4479 [44], RFC 4480 [26], RFC 4482 [32] and RFC 5196 [25]. + +##### 17. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.3.1-17 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.3.3.1-17: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=423551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content Type: +Content-Length: + +(...) +``` + +**P-Charging-Vector:** The RLS stores the originating Inter Operator Identifier (IOI) parameter received. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +##### 18. NOTIFY request (P-CSCF to UE) - see example in table A.3.3.1-18 + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.3.1-18: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Content-Type: +Content-Length: + +(...) +``` + +##### 19. 200 (OK) response (UE to P-CSCF) – see example in table A.3.3.1-19 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.3.3.1-19: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **20. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.3.3.1-20** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.3.3.1-20: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **21. 200 (OK) response (S-CSCF to RLS) - see example in table A.3.3.1-21** + +The S-CSCF#2 forwards the response to the RLS in the home network of the UE. + +**Table A.3.3.1-21: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +#### A.3.3.2 Watcher subscribing to a resource list, UE in visited network - successful subscription + +![Sequence diagram showing the interaction for a successful subscription. Lifelines: UE, P-CSCF, S-CSCF#1, I-CSCF, HSS, AS(RLS). The process involves SUBSCRIBE, 200 (OK), NOTIFY, and 200 (OK) messages between these components across three network domains: Visited Network, UE Home Network, and Home Network of AS.](13fde41de77bf026013a0b81684d1fc9_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF#1 + participant I-CSCF + participant HSS + participant AS(RLS) + + Note left of UE: Visited Network + Note left of S-CSCF#1: UE Home Network + Note left of AS(RLS): Home Network of AS + + UE->>P-CSCF: 1. SUBSCRIBE + P-CSCF->>S-CSCF#1: 2. SUBSCRIBE + S-CSCF#1->>S-CSCF#1: 3. Evaluation of initial filter criteria + S-CSCF#1->>I-CSCF: 4. SUBSCRIBE + I-CSCF->>HSS: 5. Cx: PSI location query + HSS->>AS(RLS): 6. SUBSCRIBE + AS(RLS)->>AS(RLS): 7. Watcher Authorisation + AS(RLS)->>I-CSCF: 8. 200 (OK) + I-CSCF->>S-CSCF#1: 9. 200 (OK) + S-CSCF#1->>P-CSCF: 10. 200 (OK) + P-CSCF->>UE: 11. 200 (OK) + AS(RLS)->>I-CSCF: 12. NOTIFY + I-CSCF->>S-CSCF#1: 13. NOTIFY + S-CSCF#1->>P-CSCF: 14. NOTIFY + P-CSCF->>UE: 15. NOTIFY + UE->>P-CSCF: 15. 200 (OK) + P-CSCF->>S-CSCF#1: 16. 200 (OK) + S-CSCF#1->>I-CSCF: 17. 200 (OK) + I-CSCF->>AS(RLS): 17. 200 (OK) + AS(RLS)->>AS(RLS): 18. Subscriptions and notifications on presence event package + AS(RLS)->>I-CSCF: 19. NOTIFY + I-CSCF->>S-CSCF#1: 20. NOTIFY + S-CSCF#1->>P-CSCF: 21. NOTIFY + P-CSCF->>UE: 21. NOTIFY + UE->>P-CSCF: 22. 200 (OK) + P-CSCF->>S-CSCF#1: 23. 200 (OK) + S-CSCF#1->>I-CSCF: 24. 200 (OK) + I-CSCF->>AS(RLS): 24. 200 (OK) +``` + +Sequence diagram showing the interaction for a successful subscription. Lifelines: UE, P-CSCF, S-CSCF#1, I-CSCF, HSS, AS(RLS). The process involves SUBSCRIBE, 200 (OK), NOTIFY, and 200 (OK) messages between these components across three network domains: Visited Network, UE Home Network, and Home Network of AS. + +Figure A.3.3.2-1 Watcher subscribing to resource list + +Figure A.3.3.2-1 shows a watcher subscribing to resource list event notification. The details of the signalling flows are as follows: + +##### 1. **SUBSCRIBE request (UE to P-CSCF) - see example in table A.3.3.2-1** + +A watcher agent in a UE wishes to watch a number of presentities, or certain presence information of these presentities. The list of presentities are identified by a SIP URI. In order to initiate a subscription to the RLS, the UE generates a SUBSCRIBE request indicating support for "eventlist", together with an indication of the length of time this periodic subscription should last. + +**Table A.3.3.2-1: SUBSCRIBE request (UE to P-CSCF)** + +``` + +SUBSCRIBE sip:user2_list1@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedrflj40a222 +CSeq: 123 SUBSCRIBE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port- +c=8642; port-s=7531 +Event: presence +Supported: eventlist +Expires: 7200 +Accept: application/pidf+xml, application/rlmi+xml, multipart/related +Contact: +Content-Length: 0 + +``` + +**Request-URI:** SIP URI of the resource list representing the collection of public user identities whose events the subscriber subscribes to. + +**Event:** This field is populated with the value "presence" to specify the use of the presence package. + +**Accept:** This field is populated with the value "application/pidf+xml", "application/rlmi+xml" and "multipart/related" indicating that the UE supports the eventlist extension additionally to PIDF. + +**Supported:** This field is populated with the value "eventlist" to specify the support for the eventlist extension. + +**To:** Same as the Request-URI. + +##### 2. SUBSCRIBE request (P-CSCF to S-CSCF) - see example in table A.3.3.2-2 + +The P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The SUBSCRIBE request is forwarded to S-CSCF#1. A Route header is inserted into SUBSCRIBE request. The information for the Route header is taken from the service route determined during registration. + +**Table A.3.3.2-2: SUBSCRIBE request (P-CSCF to S-CSCF)** + +``` +SUBSCRIBE sip:user2_list1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Access-Network-Info: +Route: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +Record-Route: +Route: +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Length: +``` + +##### 3. Evaluation of initial filter criteria + +S-CSCF#1 validates the service profile of this subscriber and evaluates the initial filter criteria. In this example, no AS is assumed to be involved. + +##### 4. SUBSCRIBE request (S-CSCF to I-CSCF) - see example in table A.3.3.2-4 + +S-CSCF#1 performs an analysis of the destination address. As the destination address points to a resource that is in a different network as the S-CSCF, the S-CSCF sends the request to the I-CSCF of home2.net. + +**Table A.3.3.2-4: SUBSCRIBE request (S-CSCF to I-CSCF)** + +``` +SUBSCRIBE sip:user2_list1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 68 +P-Asserted-Identity: , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +Record-Route: , +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Length: +``` + +##### 5. PSI location query + +The I-CSCF sends a query to the HSS to find the RLS where sip:user2\_list1@home2.net is hosted. The HSS responds with the address of the RLS. + +For detailed message flows see 3GPP TS 29.228 [10]. + +Table A.3.3.2-5a provides the parameters in the SIP SUBSCRIBE request (flow 4), which are sent to the HSS. + +**Table A.3.3.2-5a Cx: User location query procedure (I-CSCF to HSS)** + +| Message source & destination | Cx: Information element name | Information source in SIP SUBSCRIBE | Description | +|------------------------------|------------------------------|-------------------------------------|-------------------------------------------------------| +| I-CSCF to HSS | User Public Identity | Request-URI: | This information element indicates the PSI of the RLS | + +Table A.3.3.2-5b provides the parameters sent from the HSS that need to be mapped to SIP SUBSCRIBE (flow 6) and sent to S-CSCF. + +**Table A.3.3.2-5b Cx: User location query procedure (HSS to I-CSCF)** + +| Message source & destination | Cx: Information element name | Mapping to SIP header in SIP SUBSCRIBE | Description | +|------------------------------|------------------------------|----------------------------------------|---------------------------------------------------| +| HSS to I-CSCF | S-CSCF name | Route header field | This information indicates the address of the RLS | + +##### 6. SUBSCRIBE request (I-CSCF to RLS) - see example in table A.3.3.2-6 + +The I-CSCF forwards the SUBSCRIBE request to the RLS. + +**Table A.3.3.2-6: SUBSCRIBE request (I-CSCF to S-CSCF)** + +``` +SUBSCRIBE sip:user2_list1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 67 +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +Record-Route: +Route: +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Length: +``` + +##### 7. Authorization of watcher + +The RLS performs the necessary authorization checks on the originator to ensure that he/she is authorized to use the resource list. In this example this condition has been met, so the PS sends a 200 (OK) response to the S-CSCF. If the previous condition failed, then a 403 (Forbidden) response would be sent to the S-CSCF. + +##### 8. **200 (OK) response (RLS to I-CSCF) - see example in table A.3.3.2-8** + +The RLS sends the response to the S-CSCF. + +**Table A.3.3.2-8: 200 (OK) response (RLS to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Require: eventlist +Expires: +Contact: +Content-Length: 0 +``` + +###### **P-Charging-Vector:** + +The RLS stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +###### **P-Charging-Function-Addresses:** + +The RLS stores the P-Charging-Function-Addresses header field and passes this header to the I-CSCF. + +##### 9. **200 (OK) response (I-CSCF to S-CSCF) - see example in table A.3.3.2-9** + +The I-CSCF forwards the response to the S-CSCF. + +**Table A.3.3.2-9: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: +Record-Route: +From: +To: +Call-ID: +CSeq: +Require: +Expires: +Contact: +Content-Length: 0 +``` + +###### **P-Charging-Vector:** + +The RLS stores the header and passes this header to the S-CSCF. + +##### **10. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.3.2-10** + +The S-CSCF forwards the response to the P-CSCF. + +**Table A.3.3.2-10: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Record-Route: +From: +To: +Call-ID: +CSeq: +Require: +Expires: +Contact: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter. + +##### **11. 200 (OK) response (P-CSCF to UE) - see example in table A.3.3.2-11** + +The P-CSCF forwards the response to the watcher agent in the UE. + +**Table A.3.3.2-11: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Record-Route: , +From: +To: +Call-ID: +CSeq: +Require: +Expires: +Contact: +Content-Length: +``` + +##### 12. NOTIFY request (RLS to S-CSCF) – see example in table A.3.3.2-12 + +The RLS generates a NOTIFY request including the RLMI document as a result of the SUBSCRIBE request. + +**Table A.3.3.2-12: NOTIFY request (RLS to S-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj40a222 +CSeq: 89 NOTIFY +Subscription-State: active;expires=5000 +Require: eventlist +Event: presence +Contact: +Content-Type: application/rlmi+xml;charset="UTF-8" +Content-Length: (...) + + + + + Kovacs Janos + + + + Szabo Bela + + + +``` + +**P-Charging-Vector:** The RLS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +##### 13. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.3.2-13 + +The S-CSCF#1 forwards the NOTIFY request to the P-CSCF. + +**Table A.3.3.2-13: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home2.net;branch=z9hG4bK240f34.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Max-Forwards: 69 +Record-Route: +Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Type: +Content-Length: +(...) +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter. + +**P-Charging-Function-Addresses:** The RLS populates the P-Charging-Function-Addresses header field to be passed to the I-CSCF. + +##### **14. NOTIFY request (P-CSCF to UE) - see example in table A.3.3.2-14** + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.3.2-14: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: Contact: +Content-Type: +Content-Length: + +(...) +``` + +##### **15. 200 (OK) response (UE to P-CSCF) - see example in table A.3.3.2-15** + +The UE acknowledges the NOTIFY request with a 200 (OK) to the P-CSCF. + +**Table A.3.3.2-15: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home2.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **16. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.3.3.2-16** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF#1. + +**Table A.3.3.2-16: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home2.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **17. 200 (OK) response (S-CSCF to RLS) - see example in table A.3.3.2-17** + +The S-CSCF#1 forwards the response to the RLS in the home network of the UE. + +**Table A.3.3.2-17: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home2.net;branch=z9hG4bK240f34.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +##### **18. Subscriptions and notifications on presence event package** + +After the RLS generated a 200 (OK) response to the SUBSCRIBE request from the UE, it generates the necessary SUBSCRIBE requests to the presentities present in the resource list as described in subclause A.3.4.1. As soon as it receives NOTIFY request(s) about a state change in one or more presentities, it generates a NOTIFY request. + +##### 19. NOTIFY request (RLS to S-CSCF) – see example in table A.3.3.2-19 + +The RLS copies the body of the incoming NOTIFY request(s) into the body of the outgoing NOTIFY request using MIME type multipart/related. Further notification sent by the RLS contain may contain either the full or the partial set of presence information (only the presence information that has changed since the last notification) as described in RFC 4662 [22]. + +In this example it is assumed that the RLS receives two NOTIFY requests from presentities sip:user2\_public1@home2.net and sip:user3\_public1@home3.net before generating the NOTIFY request in subclause A.3.3.2-23 to the UE. + +**Table A.3.3.2-19: NOTIFY request (RLS to S-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj1slj40a222 +CSeq: 89 NOTIFY +Subscription-State: active;expires=5000 +Require: eventlist +Event: presence +Contact: +Content-Type: multipart/related;type="application/rlmi+xml"; +start="";boundary="50UBfW7LSCVLtggUPe5z" +Content-Length: (...) + +--50UBfW7LSCVLtggUPe5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/rlmi+xml;charset="UTF-8" + + + + + Kovacs Janos + + + + Szabo Bela + + + + +--50UBfW7LSCVLtggUPe5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/pidf+xml;charset="UTF-8" + + + + + + + open + + sip + + http://example.com/~user2/icon.gif + + false + true + + sip:user2_public1@home2.net + Don't Disturb Please! + Ne derangez pas, s'il vous plait + 2003-08-27T11:49:29Z + + +``` + +``` + + + + + + open + + assistant + + tel:+1-212-555-2222 + She's my secretary + 2003-08-27T11:49:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + + + +--50UBfW7LSCVLtgguPE5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/pidf+xml;charset="UTF-8" + + + + + + + closed + + sip + + + false + true + + sip:user3_public1@home3.net + Don't Disturb Please! + Senki se merjen zavarni! + 2003-08-27T11:48:59Z + + + + + open + + supervisor + + tel:+1-858-204-9141 + He's my supervisor + 2003-08-27T11:48:59Z + + + + http://example.com/~user3 + http://example.com/~user3/card.vcd + presentity + + + + + + +--50UBfW7LSCVLtgguPE5z-- + +``` + +**P-Charging-Vector:** The RLS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**Content-Type:** Set to the value of the Accept: header received in the SUBSCRIBE request. + +The message body in the NOTIFY request that carries the presence information of the presentity is formed as indicated in RFC 4662 [22], RFC 4479 [44], RFC 4480 [26], RFC 4482 [32] and RFC 5196 [25]. + +##### **20. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.3.2-20** + +The S-CSCF#1 forwards the NOTIFY request to the P-CSCF. + +**Table A.3.3.2-20: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter received. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the P-CSCF. + +##### **21. NOTIFY request (P-CSCF to UE) - see example in table A.3.3.2-21** + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.3.2-21: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1SIP/2.0/UDP rls.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +##### **22. 200 (OK) response (UE to P-CSCF) - see example in table A.3.3.2-22** + +The UE acknowledges the NOTIFY request with a 200 (OK) to the P-CSCF. + +**Table A.3.3.2-22: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1SIP/2.0/UDP rls.home2.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +##### **23. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.3.3.2-23** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF#1. + +**Table A.3.3.2-23: 200 (OK) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home2.net;branch=z9hG4bK240f34.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024", orig-ioi=hom1.net, + term-ioi=visited1.net +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +##### **24. 200 (OK) response (S-CSCF to RLS) – see example in table A.3.3.2-24** + +The S-CSCF#2 forwards the response to the RLS in the home network of the UE. + +**Table A.3.3.2-24: 200 (OK) response (S-CSCF to RLS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home2.net;branch=z9hG4bK240f34.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024", orig-ioi=hom1.net; + term-ioi=hom1.net +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +### A.3.4 RLS subscribing to presentities in different network + +#### A.3.4.1 Successful subscription + +![Sequence diagram showing the successful subscription process for RLS to presentities in different networks. The diagram is divided into two main groups: 'List server' (containing AS(RLS) and S-CSCF#1) and 'Presentity Home Network' (containing I-CSCF, HSS, S-CSCF#2, and AS(PS)). The sequence of messages is: 1. SUBSCRIBE from AS(RLS) to S-CSCF#1; 2. Evaluation of initial filter criteria at S-CSCF#1; 3. SUBSCRIBE from S-CSCF#1 to I-CSCF; 4. Cx: User location query between I-CSCF and HSS; 5. SUBSCRIBE from I-CSCF to S-CSCF#2; 6. Evaluation of initial filter criteria at S-CSCF#2; 7. SUBSCRIBE from S-CSCF#2 to AS(PS); 8. Watcher authorisation at AS(PS); 9. 200 (OK) from AS(PS) to S-CSCF#2; 10. 200 (OK) from S-CSCF#2 to I-CSCF; 11. 200 (OK) from I-CSCF to S-CSCF#1; 12. 200 (OK) from S-CSCF#1 to AS(RLS); 13. NOTIFY from HSS to S-CSCF#1; 14. NOTIFY from S-CSCF#1 to AS(RLS); 15. 200 (OK) from AS(RLS) to S-CSCF#1; 16. 200 (OK) from HSS to AS(PS).](508bc574df81fa8d3027a374f6d155fc_img.jpg) + +Sequence diagram showing the successful subscription process for RLS to presentities in different networks. The diagram is divided into two main groups: 'List server' (containing AS(RLS) and S-CSCF#1) and 'Presentity Home Network' (containing I-CSCF, HSS, S-CSCF#2, and AS(PS)). The sequence of messages is: 1. SUBSCRIBE from AS(RLS) to S-CSCF#1; 2. Evaluation of initial filter criteria at S-CSCF#1; 3. SUBSCRIBE from S-CSCF#1 to I-CSCF; 4. Cx: User location query between I-CSCF and HSS; 5. SUBSCRIBE from I-CSCF to S-CSCF#2; 6. Evaluation of initial filter criteria at S-CSCF#2; 7. SUBSCRIBE from S-CSCF#2 to AS(PS); 8. Watcher authorisation at AS(PS); 9. 200 (OK) from AS(PS) to S-CSCF#2; 10. 200 (OK) from S-CSCF#2 to I-CSCF; 11. 200 (OK) from I-CSCF to S-CSCF#1; 12. 200 (OK) from S-CSCF#1 to AS(RLS); 13. NOTIFY from HSS to S-CSCF#1; 14. NOTIFY from S-CSCF#1 to AS(RLS); 15. 200 (OK) from AS(RLS) to S-CSCF#1; 16. 200 (OK) from HSS to AS(PS). + +Figure A.3.4.1-1 RLS subscribing to presentities in different network + +Figure A.3.4.1-1 shows the RLS subscribing to presence event notification about a presentity. The presentity is in a different IM CN subsystem. The details of the signalling flows are as follows: + +##### 1. SUBSCRIBE request (RLS to S-CSCF) – see example in table A.3.4.1-1 + +The RLS resolves the watcher's resource address (the address is received according to subclause A.3.3) and subscribes to presence event notification at all the presentities that are represented by the resource list SIP URI. The home network of these presentities can be different or in the same network, as the RLS. In this example only a single subscription is shown where the home network of the presentity is another network. Subscriptions to other presentities follow a similar procedure. To initiate a subscription, the RLS generates a SUBSCRIBE request containing the "presence" event that it wishes to be notified of, together with an indication of the length of time this periodic subscription should last. The RLS sends the SUBSCRIBE request to the S-CSCF of "sip:user1\_public1@home1.net" (S-CSCF#1). The address of S-CSCF#1 is either remembered from previous transactions (when "sip:user1\_public1@home1.net" has subscribed for the resource list) or queried by the RLS using the Sh interface. + +**Table A.3.4.1-1 SUBSCRIBE request (RLS to S-CSCF)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bKehuefdam +Max-Forwards: 70 +Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2TrT5tAFrbHLso=323551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +From: ;tag=31415 +To: +Call-ID: q987a9a87g087abgf7qyg7ag +CSeq: 123 SUBSCRIBE +Event: presence +Expires: 7200 +Accept: application/pidf+xml +Contact: +Content-Length: 0 + +``` + +| | | +|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Request-URI: | Public user identity whose events the RLS subscribes to. | +| P-Charging-Vector: | The RLS populates the icid parameter with a new globally unique value and populates the originating Inter Operator Identifier (IOI) parameter with the identifier of its own network of RLS. | +| P-Charging-Function-Addresses: | The RLS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. | +| To: | Same as the Request-URI. | +| Event: | This field is populated with the value "presence" to specify the use of the presence package. | +| Accept: | This field is populated with the value "application/pidf+xml". | + +##### 2. Evaluation of initial filter criteria + +S-CSCF#1 validates the service profile of this subscriber and evaluates the initial filter criteria. In this example, no AS is assumed to be involved. + +##### 3. SUBSCRIBE request (S-CSCF to I-CSCF) – see example in table A.3.4.1-3 + +S-CSCF#1 performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. S-CSCF#1 forwards the request to the I-CSCF. + +**Table A.3.4.1-3 SUBSCRIBE request (S-CSCF to I-CSCF)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bKehuefdam +Max-Forwards: 69 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received. + +##### 4. Cx: User Location Query procedure + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the presentity. The HSS responds with the address of the current S-CSCF for the presentity. + +For detailed message flows see 3GPP TS 29.228 [10]. + +Table A.3.4.1-4a provides the parameters in the SIP SUBSCRIBE request (flow 3), which are sent to the HSS. + +**Table A.3.4.1-4a: Cx: User location query procedure (I-CSCF to HSS)** + +| Message source and destination | Cx: Information element name | Information source in SIP SUBSCRIBE | Description | +|--------------------------------|------------------------------|-------------------------------------|-------------------------------------------------------------| +| I-CSCF to HSS | User Public Identity | Request-URI | This information element indicates the public user identity | + +Table A.3.4.1-4b provides the parameters sent from the HSS that need to be mapped to SIP SUBSCRIBE request (flow 5) and sent to the S-CSCF. + +**Table A.3.4.1-4b: Cx: User location query procedure (HSS to I-CSCF)** + +| Message source and destination | Cx: Information element name | Mapping to SIP header in SIP SUBSCRIBE | Description | +|--------------------------------|------------------------------|----------------------------------------|-----------------------------------------------------------------| +| HSS to I-CSCF | S-CSCF name | Route header field | This information indicates the serving CSCF's name of that user | + +##### 5. SUBSCRIBE request (I-CSCF to S-CSCF) - see example in table A.3.4.1-5 + +The I-CSCF forwards the SUBSCRIBE request to the S-CSCF#2 that will handle the termination. + +**Table A.3.4.1-5: SUBSCRIBE request (I-CSCF to S-CSCF)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bKj5hgrt2o, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bKehuefdam +Max-Forwards: 68 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-icid=home1.net; +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +##### 6. Evaluation of initial filter criteria + +S-CSCF#2 validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:user2\_public1@home2.net the S-CSCF has Termination initial Filter Criteria with Service Point Trigger of Method = SUBSCRIBE AND Event = "presence" that informs the S-CSCF to route the SUBSCRIBE request to the AS ps.home2.net. The S-CSCF#2 has preconfigured information not to create a Record-Route entry for this request. + +##### 7. SUBSCRIBE request (S-CSCF to PS) - see example in table A.3.4.1-7 + +The S-CSCF#2 forwards the SUBSCRIBE request to the PS. + +**Table A.3.4.1-7 SUBSCRIBE request (S-CSCF to PS)** + +``` +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bKj5hgRT2o, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bKehuefdam +Max-Forwards: 67 +P-Asserted-Identity: +P-Charging-Vector: +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: +``` + +###### P-Charging-Vector: + +The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +###### P-Charging-Function-Addresses: + +The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the PS. + +##### 8. Authorization of watcher + +The PS performs the necessary authorization checks on the originator to ensure it is allowed to watch the presentity. In this example all privacy conditions are met, so the PS sends a 200 (OK) response to the S-CSCF. + +In the case where the privacy/authorization checks fails, then a necessary 2xx or 4xx response will be sent to the S-CSCF. The selection of the correct response code depends on the presentity's subscription authorization policy document. + +##### 9. 200 (OK) response (PS to S-CSCF) - see example in table A.3.4.1-9 + +The PS sends the response to S-CSCF#2. + +**Table A.3.4.1-9: 200 (OK) response (PS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bKj5hgRT2o, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig- + ioi=home2.net;term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: 0 +``` + +**P-Charging-Vector:** The PS stores the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS stores the P-Charging-Function-Addresses header field and passes this header to the S-CSCF. + +##### 10. **200 (OK) response (S-CSCF to I-CSCF) - see example in table A.3.4.1-10** + +S-CSCF#2 forwards the response to the I-CSCF. + +**Table A.3.4.1-10: 200 (OK) response (S-CSCF to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bKj5hgrt2o, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bKehuefdam +P-Charging-Vector: +P-Charging-Function-Addresses: +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the I-CSCF. + +##### 11. **200 (OK) response (I-CSCF to S-CSCF) - see example in table A.3.4.1-11** + +The I-CSCF forwards the response to S-CSCF#1. + +**Table A.3.4.1-11: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bKehuefdam +P-Charging-Vector: +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### 12. **200 (OK) response (S-CSCF to RLS) - see example in table A.3.4.1-12** + +S-CSCF#1 forwards the response to the RLS. + +**Table A.3.4.1-12: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bKehuefdam +P-Charging-Vector: +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +###### **P-Charging-Vector:** + +The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +###### **P-Charging-Function-Addresses:** + +The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the RLS. + +##### 13. NOTIFY request (PS to S-CSCF) - see example in table A.3.4.1-13 + +As soon as the PS sends a 200 (OK) response to accept the subscription, it sends a NOTIFY request with the current state of the presentity's presence information that the watcher has subscribed and been authorized to. The NOTIFY request is sent to S-CSCF#1. + +**Table A.3.4.1-13: NOTIFY request (PS to S-CSCF)** + +``` +NOTIFY sip:rls.home1.net SIP/2.0 +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +Route: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=423551024"; orig-ioi=home2.net +From: ;tag=151170 +To: ;tag=31415 +Call-ID: q987a9a87g087abgf7qyg7ag +CSeq: 42 NOTIFY +Subscription-State:active;expires=7200 +Event: presence +Contact: +Content-Type: application/pidf+xml +Content-Length: (...) + + + + + + + open + + sip + + http://example.com/~user2/icon.gif + + false + true + + im:user2_public1@home2.net + Don't Disturb Please! + Ne derangez pas, s'il vous plait + 2003-08-27T11:49:29Z + + + + + open + + assistant + + tel:+1-212-555-2222 + She's my secretary + 2003-08-27T11:49:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**Content-Type:** Set to the value of the Accept header received in the SUBSCRIBE request or "application/pidf+xml". + +The message body in the NOTIFY request that carries the presence's presence state is formed as indicated in RFC 3863 [21], RFC 4479 [44], RFC 4480 [26], RFC 4482 [32] and RFC 5196 [25]. + +##### **14. NOTIFY request (S-CSCF to RLS) - see example in table A.3.4.1-14** + +The S-CSCF#1 forwards the NOTIFY request to the RLS. + +**Table A.3.4.1-14: NOTIFY request (S-CSCF to RLS)** + +``` +NOTIFY sip:rls.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP + ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +P-Charging-Vector: +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the RLS. + +##### **15. 200 (OK) response (RLS to S-CSCF) – see example in table A.3.4.1-15** + +The RLS generates a 200 (OK) response to the NOTIFY request. + +**Table A.3.4.1-15: 200 (OK) response (RLS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024"; orig- + ioi=home1.net:term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**P-Charging-Vector:** The RLS stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +##### **16. 200 (OK) response (S-CSCF to PS) – see example in table A.3.4.1-16** + +The S-CSCF#1 forwards the 200 (OK) response to the PS. + +**Table A.3.4.1-16: 200 (OK) response (S-CSCF to PS)** + +``` + +SIP/2.0 200 OK +P-Charging-Vector: +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +### A.3.5 Network based watcher subscribing on behalf of IMS watcher to IMS presentities + +![Sequence diagram Figure A.3.5-1 showing the signaling flow for a network based watcher subscribing on behalf of an IMS watcher. The flow involves Home Network#1 (Network watcher, HSS, S-CSCF#1) and Home Network#2 (I-CSCF, HSS, S-CSCF#2, AS(PS)).](cfc2672ccfdf7b47212ef2b8d72c0ff3_img.jpg) + +``` + +sequenceDiagram + participant NW as Network watcher + participant HSS1 as HSS + participant SCSCF1 as S-CSCF#1 + participant ICSCF as I-CSCF + participant HSS2 as HSS + participant SCSCF2 as S-CSCF#2 + participant AS as AS(PS) + + Note over NW, SCSCF1: Home Network#1 + Note over ICSCF, AS: Home Network#2 + + NW->>HSS1: 1. Sh: User location query + HSS1->>SCSCF1: 2. SUBSCRIBE + Note right of SCSCF1: 3. Evaluation of initial filter criteria + SCSCF1->>ICSCF: 4. SUBSCRIBE + ICSCF->>HSS2: 5. Cx: User location query + HSS2->>SCSCF2: 6. SUBSCRIBE + Note right of SCSCF2: 7. Evaluation of initial filter criteria + SCSCF2->>AS: 8. SUBSCRIBE + Note right of AS: 9. Watcher authorisation + AS-->>SCSCF2: 10. 200 (OK) + SCSCF2-->>HSS2: 11. 200 (OK) + HSS2-->>ICSCF: 12. 200 (OK) + ICSCF-->>SCSCF1: 13. 200 (OK) + SCSCF1-->>HSS1: 14. NOTIFY + HSS1-->>NW: 15. NOTIFY + NW-->>HSS1: 16. 200 (OK) + HSS1-->>AS: 17. 200 (OK) + +``` + +Sequence diagram Figure A.3.5-1 showing the signaling flow for a network based watcher subscribing on behalf of an IMS watcher. The flow involves Home Network#1 (Network watcher, HSS, S-CSCF#1) and Home Network#2 (I-CSCF, HSS, S-CSCF#2, AS(PS)). + +**Figure A.3.5-1: Network based watcher subscribing on behalf of IMS watcher for presence information of IMS presentities** + +Figure A.3.5-1 shows a trusted network based watcher subscribing on behalf of an IMS watcher to presence event notification about an IMS based presentity. The presentity is in a different IM CN subsystem than the network based watcher and the signalling flow assumes that the IMS watcher on whose behalf the network based watcher subscribes is registered to the IMS network. The details of the signalling flows are as follows: + +1. Sh: User Location Query procedure + +The network based watcher sends a query to the HSS to find out the S-CSCF of the user on whose behalf the subscription is initiated. The HSS responds with the address of the current S-CSCF for the originating subscriber. + +##### **2. SUBSCRIBE request (Network based watcher to S-CSCF) - see example in table A.3.5-2** + +The SUBSCRIBE request is constructed and forwarded to S-CSCF. The S-CSCF is inserted into the Route header of the SUBSCRIBE request. + +**Table A.3.5-2: SUBSCRIBE request (network watcher to S-CSCF)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP watcher.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +Max-Forwards: 69 +P-Asserted-Identity: +Privacy: none +Route: +From: ;tag=31415 +To: +Call-ID: b89rjhnedrflj40a222 +CSeq: 61 SUBSCRIBE +Event: PRESENCE +Expires: 7200 +Accept: application/pidf+xml;q=0.3, application/pidf-diff+xml;q=1 +Contact: +Content-Length: 0 + +``` + +**Request-URI:** Public user identity of the user to whose events the subscriber subscribes to. + +**P-Asserted-Identity:** The network based watcher inserts the public user identity of the watcher on whose behalf the subscription is made into the P-Asserted-Identity header field. + +**Route:** The Route header is populated with the address of the S-CSCF obtained from the response to the user location query performed by the network based watcher on the Sh interface. + +**Event:** This field is populated with the value "presence" to specify the use of the presence package. + +**Contact:** The contact information of the network based watcher. + +##### **3. Evaluation of initial filter criteria** + +S-CSCF#1 validates the service profile of the subscriber identified in the P-Asserted-Identity header field and evaluates the initial filter criteria. In this example, no AS is assumed to be involved. + +##### **4. SUBSCRIBE request (S-CSCF to I-CSCF) - see example in table A.3.5-4** + +S-CSCF#1 performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, S-CSCF#1 forwards the SUBSCRIBE request directly to the I-CSCF in the destination network. + +**Table A.3.5-4: SUBSCRIBE (S-CSCF to I-CSCF)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP +network.home1.net;branch=z9hG4bK240f34.1, +Max-Forwards: 68 +P-Asserted-Identity: +Privacy: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +##### 5. Cx: User Location Query procedure + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +For detailed message flows see 3GPP TS 29.228 [10]. + +Table A.3.5-5a provides the parameters in the SIP SUBSCRIBE request (flow 4), which are sent to the HSS. + +**Table A.3.5-5a: Cx: User registration location procedure (I-CSCF to HSS)** + +| Message source and destination | Cx: Information element name | Information source in SIP SUBSCRIBE | Description | +|--------------------------------|------------------------------|-------------------------------------|-------------------------------------------------------------| +| I-CSCF to HSS | User Public Identity | Request-URI | This information element indicates the public user identity | + +Table A.3.5-5b provides the parameters sent from the HSS that need to be mapped to the SIP SUBSCRIBE request (flow 6) and sent to the S-CSCF. + +**Table A.3.5-5b: Cx: User location query procedure (HSS to I-CSCF)** + +| Message source and destination | Cx: Information element name | Mapping to SIP header in SIP SUBSCRIBE | Description | +|--------------------------------|------------------------------|----------------------------------------|-----------------------------------------------------------------| +| HSS to I-CSCF | S-CSCF name | Route header field | This information indicates the serving CSCF's name of that user | + +##### 6. SUBSCRIBE request (I-CSCF to S-CSCF) - see example in table A.3.5-6 + +The I-CSCF forwards the SUBSCRIBE request to the S-CSCF (S-CSCF#2) that will handle the termination. + +**Table A.3.5-6: SUBSCRIBE request (I-CSCF to S-CSCF)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + network.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 67 +P-Asserted-Identity: +Privacy: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +NOTE: The I-CSCF does not add itself to the Record-Route header, as it has no need to remain in the signalling path for the subsequent requests. + +##### 7. Evaluation of initial filter criteria + +S-CSCF#2 validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:user2\_public1@home2.net S-CSCF#2 has termination initial filter criteria with Service Point Trigger of Method = SUBSCRIBE and Event = "presence" that informs the S-CSCF to route the SUBSCRIBE request to the AS ps.home2.net. The S-CSCF#2 has preconfigured information not to create a Record-Route header for this request. + +##### 8. SUBSCRIBE request (S-CSCF to PS) - see example in table A.3.5-8 + +The S-CSCF forwards the SUBSCRIBE request to the PS. + +**Table A.3.5-8: SUBSCRIBE request (S-CSCF to PS)** + +``` + +SUBSCRIBE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + network.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 66 +P-Asserted-Identity: +Privacy: +Route: , +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +##### 9. Authorization of watcher + +The PS performs the necessary authorization checks on the watcher whose behalf the subscription is being made to ensure it is allowed to watch the presentity. In this example all privacy conditions are met, so the PS sends a 200 (OK) response to the S-CSCF. + +In the case where the privacy/authorization checks fails, then a necessary 2xx or 4xx response will be sent to the S-CSCF. The selection of the correct response code depends on the presentity's authorization policy document. + +##### 10. 200 (OK) response (PS to S-CSCF) - see example in table A.3.5-10 + +The PS sends the response to S-CSCF#2. + +**Table A.3.5-10: 200 (OK) response (PS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + network.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### **11. 200 (OK) response (S-CSCF to I-CSCF) - see example in table A.3.5-11** + +S-CSCF#2 forwards the response to I-CSCF#2. + +**Table A.3.5-11: 200 (OK) response (S-CSCF to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + network.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### **12. 200 (OK) response (I-CSCF to S-CSCF) - see example in table A.3.5-12** + +I-CSCF#2 forwards the response to S-CSCF#1. + +**Table A.3.5-12: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + network.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### **13. 200 (OK) response (S-CSCF to network watcher) - see example in table A.3.5-13** + +S-CSCF#1 forwards the response to request originator. + +**Table A.3.5-13: 200 (OK) response (S-CSCF to network watcher)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP network.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: +``` + +##### 14. NOTIFY request (PS to S-CSCF) - see example in table A.3.5-14 + +As soon as the PS sends a 200 (OK) response to accept the subscription, it sends a NOTIFY request with the current state of the presentity's presence information that the watcher has subscribed and been authorized to. The NOTIFY request is sent to S-CSCF#1. Based on the Accept header field of the SUBSCRIBE request, the PS decides to use partial notifications to provide further changes of presence information. The first notification always contains the full state. The 'application/pidf-diff+xml' content type is used. + +**Table A.3.5-14: NOTIFY request (PS to S-CSCF)** + +``` +NOTIFY sip: network.home1.net;branch=z9hG4bK240f34.1 SIP/2.0 +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +Route: +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj40a222 +CSeq: 42 NOTIFY +Subscription-State: active; expires=7200 +Event: presence +Contact: +Content-Type: application/pidf-diff+xml +Content-Length: (...) + + + + + + + open + + http://example.com/~user2/icon.gif + + sip + + false + true + + sip:user2_public1@home2.net + Don't Disturb Please! + Ne derangez pas, s'il vous plait + 2003-08-27T11:49:29Z + + + + + open + + assistant + + tel:+1-212-555-2222 + She's my secretary + 2003-08-27T11:49:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + + +``` + +**From:** The tag of this field matches that of the To field in the received 200 (OK) response for the SUBSCRIBE request. + +**Content-Type:** Set to the preferred value of the Accept header received in the SUBSCRIBE request. + +The message body in the NOTIFY request that carries the presence information of the presentity is formed as indicated in RFC 3863 [21], RFC 4480 [26], RFC 4482 [32], RFC 5196 [25], RFC 4479 [44] and RFC 5263 [24]. + +##### **15. NOTIFY request (S-CSCF to network watcher) - see example in table A.3.5-15** + +The S-CSCF#1 forwards the NOTIFY request to the network watcher + +**Table A.3.5-15: NOTIFY request (S-CSCF to network watcher)** + +``` +NOTIFY sip: network.home1.net;branch=z9hG4bK240f34.1SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +Privacy: +Record-Route: + +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +##### **16. 200 (OK) response (network watcher to S-CSCF) – see example in table A.3.5-16** + +The network watcher forwards the 200 (OK) response to S-CSCF#1. + +**Table A.3.5-16: 200 (OK) response (network watcher to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **17. 200 (OK) response (S-CSCF to PS) – see example in table A.3.5-17** + +S-CSCF#2 forwards the 200 (OK) response to the PS. + +**Table A.3.5-17: 200 (OK) response (S-CSCF to PS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +### A.3.6 Watcher subscribing to state changes in XML document, UE in visited network + +#### A.3.6.1 Watcher subscribing to changes made via XCAP in his resource list, UE in visited network - Successful subscription + +![Sequence diagram showing the interaction for a successful subscription to state changes in an XML document. The diagram is split into two parts: the initial subscription and the subsequent notification after a resource list modification.](9b9262a549828579ab904148450734f6_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant AS_RLS as AS(RLS) + + Note left of UE: Visited Network + Note right of AS_RLS: Home Network of UE + + Note over UE, P-CSCF, S-CSCF, AS_RLS: Initial Subscription + UE->>P-CSCF: 1. SUBSCRIBE + P-CSCF->>S-CSCF: 2. SUBSCRIBE + S-CSCF->>S-CSCF: 3. Evaluation of initial filter criteria + S-CSCF->>AS_RLS: 4. SUBSCRIBE + AS_RLS->>AS_RLS: 5. Authorisation + AS_RLS->>S-CSCF: 6. 200 (OK) + S-CSCF->>P-CSCF: 7. 200 (OK) + P-CSCF->>UE: 8. 200 (OK) + AS_RLS->>S-CSCF: 9. NOTIFY + S-CSCF->>P-CSCF: 10. NOTIFY + P-CSCF->>UE: 11. NOTIFY + UE->>P-CSCF: 12. 200 (OK) + P-CSCF->>S-CSCF: 13. 200 (OK) + S-CSCF->>AS_RLS: 14. 200 (OK) + + Note over UE, P-CSCF, S-CSCF, AS_RLS: User retrieves current resource list via XCAP GET + UE->>AS_RLS: 15. user retrieves current resource list via XCAP GET + AS_RLS->>AS_RLS: 16. resource list gets modified via XCAP + AS_RLS->>S-CSCF: 17. NOTIFY + S-CSCF->>P-CSCF: 18. NOTIFY + P-CSCF->>UE: 19. NOTIFY + UE->>P-CSCF: 20. 200 (OK) + P-CSCF->>S-CSCF: 21. 200 (OK) + S-CSCF->>AS_RLS: 22. 200 (OK) +``` + +The sequence diagram illustrates the interaction for a successful subscription to state changes in an XML document. It is divided into two main parts: the initial subscription and the subsequent notification after a resource list modification. The participants involved are the User Equipment (UE), Packet-CSCF (P-CSCF), Serving-CSCF (S-CSCF), and the Application Server (AS(RLS)). The UE sends a SUBSCRIBE message to the P-CSCF, which is then forwarded to the S-CSCF. The S-CSCF evaluates the initial filter criteria and sends a SUBSCRIBE message to the AS(RLS). The AS(RLS) performs an authorisation and returns a 200 (OK) response, which is then passed back through the S-CSCF and P-CSCF to the UE. Next, the AS(RLS) sends a NOTIFY message, which is also passed back through the S-CSCF and P-CSCF to the UE. The UE responds with a 200 (OK) message. After this, the user retrieves the current resource list via an XCAP GET request. The AS(RLS) then modifies the resource list via XCAP and sends a NOTIFY message, which is again passed back through the S-CSCF and P-CSCF to the UE. The UE responds with a 200 (OK) message, which is then passed back through the S-CSCF and P-CSCF to the AS(RLS). + +Sequence diagram showing the interaction for a successful subscription to state changes in an XML document. The diagram is split into two parts: the initial subscription and the subsequent notification after a resource list modification. + +**Figure A.3.6.1-1: Watcher subscribing to changes made via XCAP in his resource list** + +Figure A.3.6.1-1 shows a watcher subscribing to notifications of state changes made via XCAP in his resource list. The details of the flows as follows: + +##### 1. SUBSCRIBE request (UE to P-CSCF) – see example in table A.3.6.1-1 + +A watcher agent in a UE wishes to get notification when his resource list gets modified via XCAP. In order to initiate a subscription to XCAP document changes in RLS, the UE generates a SUBSCRIBE request indicating support for "xcap-diff", together with an indication of the length of time this periodic subscription should last. + +**Table A.3.6.1-1: SUBSCRIBE request (UE to P-CSCF)** + +``` +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedrflj40a222 +CSeq: 123 SUBSCRIBE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port- +c=8642; port-s=7531 +Event: xcap-diff;diff-processing=aggregate +Expires: 7200 +Accept: application/xcap-diff+xml +Contact: +Content-Type: application/resource-lists+xml +Content-Length: (...) + + + + + + + +``` + +**Request-URI:** The users own SIP URI to get notifications of changes on all lists owned by the user. + +**Event:** This field is populated with the value "xcap-diff" to specify the use of the xcap-diff package to get notified of changes to XCAP documents. + +**Accept:** This field is populated with the value "application/xcap-diff+xml" indicating that the UE supports the MIME type. + +**To:** Same as the Request-URI. + +##### 2. SUBSCRIBE request (P-CSCF to S-CSCF) - see example in table A.3.6.1-2 + +The P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The SUBSCRIBE request is forwarded to S-CSCF#1. A Route header is inserted into SUBSCRIBE request. The information for the Route header is taken from the service route determined during registration. + +**Table A.3.6.1-2: SUBSCRIBE request (P-CSCF to S-CSCF)** + +``` +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Access-Network-Info: +Route: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +Privacy: +Record-Route: +Route: +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +##### 3. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:user1\_public1@home1.net the S-CSCF has originating initial Filter Criteria with Service Point Trigger of Method = SUBSCRIBE AND Event = "xcap-diff" that informs the S-CSCF to route the SUBSCRIBE request to the AS sip:rls.home1.net. + +##### 4. SUBSCRIBE request (S-CSCF to RLS) - see example in table A.3.6.1-4 + +The S-CSCF forwards the SUBSCRIBE request to the RLS. + +**Table A.3.6.1-4 SUBSCRIBE request (S-CSCF to RLS)** + +``` + +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 68 +P-Access-Network-Info: +P-Asserted-Identity: , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +Record-Route: , +Route: , +From: +To: +Call-ID: +CSeq: +Event: +Supported: +Expires: +Accept: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the RLS. + +##### 5. Authorization + +The RLS performs the necessary authorization checks on the originator to ensure that he/she is authorized to subscribe to XML document changes. In this example this condition has been met, so the RLS sends a 200 (OK) response to the S-CSCF. + +##### 6. 200 (OK) response (RLS to S-CSCF) - see example in table A.3.6.1-6 + +The RLS sends the response to the S-CSCF. + +**Table A.3.6.1-6: 200 (OK) response (RLS to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net; + term-ioi=home1.net +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: 0 + +``` + +##### 7. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.6.1-7 + +The S-CSCF forwards the response to the P-CSCF. + +**Table A.3.6.1-7: 200 (OK) response (S-CSCF to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: + +``` + +##### 8. **200 (OK) response (P-CSCF to UE) - see example in table A.3.6.1-8** + +The P-CSCF forwards the response to the watcher agent in the UE. + +**Table A.3.6.1-8: 200 (OK) response (P-CSCF to UE)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Record-Route: , +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: + +``` + +##### 9. **NOTIFY request (RLS to S-CSCF) – see example in table A.3.6.1-9** + +The RLS generates a NOTIFY request including the xcap-diff document as a result of the SUBSCRIBE request. As this is the initial NOTIFY it contains only the new-etag, previous-etag and document-selector elements. + +**Table A.3.6.1-9 NOTIFY request (RLS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-loi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedlrfjflsj40a222 +CSeq: 89 NOTIFY +Subscription-State: active;expires=7200 +Event: xcap-diff +Contact: +Content-Type: application/xcap-diff+xml;charset="UTF-8" +Content-Length: + + + + + + + + + + + +``` + +The content of the document element contains a new-etag and a previous etag element with identical value and no list of instructions. This way it is indicated that this is the reference XML diff document. This document has only the information about the etags and the document URI's covered by that subscription. + +##### 10. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.6.1-10 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.3.6.1-10: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: + +(...) +``` + +##### 11. NOTIFY request (P-CSCF to UE) - see example in table A.3.6.1-11 + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.6.1-11: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: + +(...) +``` + +##### 12. 200 (OK) response (UE to P-CSCF) - see example in table A.3.6.1-12 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.3.6.1-12: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **13. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.3.6.1-13** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.3.6.1-13: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **14. 200 (OK) response (S-CSCF to RLS) - see example in table A.3.6.1-14** + +The S-CSCF#2 forwards the response to the RLS in the home network of the UE. + +**Table A.3.6.1-14: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **15. User retrieves current resource list via XCAP get** + +As user1 does not have a local copy of the resource list identified by the etag he retrieves the corresponding list via XCAP get. + +##### **16. Resource List gets modified via XCAP** + +The resource list of user1 gets modified via XCAP procedures. + +##### 17. NOTIFY request (RLS to S-CSCF) - see example in table A.3.6.1-17 + +In this example it is assumed that the RLS has received a XCAP request to delete user2\_public@home1.net from the resource list of user1. + +**Table A.3.6.1-17 NOTIFY request (RLS to S-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedlrfjflslj40a222 +CSeq: 90 NOTIFY +Subscription-State: active;expires=5000 +Event: xcap-diff +Contact: +Content-Type: application/xcap-diff+xml;charset="UTF-8" +Content-Length: (...) + + + + + + + + + ]]> + + + + +``` + +**Content-Type:** Set to application/xcap-diff+xml. + +The message body in the NOTIFY request contains information of the new-etag of the changed document, the change method and the element that was changed in accordance with RFC 5874 [39]. + +##### 18. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.3.6.1-18 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.3.6.1-18: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content Type: +Content-Length: + +(...) +``` + +##### **19. NOTIFY request (P-CSCF to UE) – see example in table A.3.6.1-19** + +The P-CSCF forwards the NOTIFY request to the watcher in the UE. + +**Table A.3.6.1-19: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Content-Type: +Content-Length: + +(...) +``` + +##### **20. 200 (OK) response (UE to P-CSCF) – see example in table A.3.6.1-20** + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.3.6.1-20: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **21. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.3.6.1-21** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.3.6.1-21: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### 22. 200 (OK) response (S-CSCF to RLS) – see example in table A.3.6.1-22 + +The S-CSCF#2 forwards the response to the RLS in the home network of the UE. + +**Table A.3.6.1-22: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024"; orig-ioi=home1.net; +term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## A.4 Signalling flows demonstrating how presentities update presence information + +### A.4.1 Introduction + +This subclause covers the signalling flows that show how presentities update presence information in the PS. + +### A.4.2 Initial publication or modification of presence information by UE + +#### A.4.2.1 Successful publication + +![Sequence diagram showing the successful publication of presence information by a UE. The diagram involves four lifelines: UE, P-CSCF#1, S-CSCF#1, and PS. The sequence of messages is: 1. PUBLISH from UE to P-CSCF#1; 2. PUBLISH from P-CSCF#1 to S-CSCF#1; 3. Evaluation of initial filter criteria (internal to S-CSCF#1); 4. PUBLISH from S-CSCF#1 to PS; 5. Publisher authorisation (internal to PS); 6. 200 (OK) from PS to S-CSCF#1; 7. 200 (OK) from S-CSCF#1 to P-CSCF#1; 8. 200 (OK) from P-CSCF#1 to UE.](9694add1e3183133a9ddb9f41c48d00e_img.jpg) + +Home Network#1 + +``` + +sequenceDiagram + participant UE + participant P-CSCF#1 + participant S-CSCF#1 + participant PS + Note right of S-CSCF#1: 3. Evaluation of initial filter criteria + Note right of PS: 5. Publisher authorisation + UE->>P-CSCF#1: 1. PUBLISH + P-CSCF#1->>S-CSCF#1: 2. PUBLISH + S-CSCF#1->>PS: 4. PUBLISH + PS-->>S-CSCF#1: 6. 200 (OK) + S-CSCF#1-->>P-CSCF#1: 7. 200 (OK) + P-CSCF#1-->>UE: 8. 200 (OK) + +``` + +Sequence diagram showing the successful publication of presence information by a UE. The diagram involves four lifelines: UE, P-CSCF#1, S-CSCF#1, and PS. The sequence of messages is: 1. PUBLISH from UE to P-CSCF#1; 2. PUBLISH from P-CSCF#1 to S-CSCF#1; 3. Evaluation of initial filter criteria (internal to S-CSCF#1); 4. PUBLISH from S-CSCF#1 to PS; 5. Publisher authorisation (internal to PS); 6. 200 (OK) from PS to S-CSCF#1; 7. 200 (OK) from S-CSCF#1 to P-CSCF#1; 8. 200 (OK) from P-CSCF#1 to UE. + +**Figure A.4.2.1-1: UE publishing presence information** + +The UE may publish the partial presence information or the full presence information about a presentity to the PS. + +In this example, it is assumed that the UE publishes the full presence information. + +Figure A.4.2.1-1 shows a UE publishing or modifying already existing presence information about a presentity. The details of the signalling flows as follows: + +##### 1. **PUBLISH request (UE to P-CSCF) - see example in table A.4.2.1-1** + +A PUA in a UE wishes to publish presence information. To initiate the publication, the UE generates a PUBLISH request according to RFC 3903 [23] containing the presence information that it wishes to publish. + +**Table A.4.2.1-1: PUBLISH request (UE to P-CSCF)** + +``` + +PUBLISH sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedlrfjflslj40a222 +CSeq: 61 PUBLISH +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port- +c=8642; port-s=7531 +Event: presence +Expires: 7200 +Content-Type: application/pidf+xml +Content-Length: (...) + + + + + + + open + + sip + + http://example.com/~user2/icon.gif + + false + true + + sip:user2_public1@home2.net + Don't Disturb Please! + Ne derangez pas, s'il vous plait + 2003-08-27T11:49:29Z + + + + + open + + assistant + + tel:+1-212-555-2222 + She's my secretary + 2003-08-27T11:49:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + +``` + +- Request-URI:** Public user identity whose presence information the PUA intends to publish. +- Event:** This field is populated with the value "presence" to specify the use of the presence package. +- To:** Same as the Request-URI. +- Content-Type:** Set to the value "application/pidf+xml". + +The message body in the PUBLISH request that carries the presence update state is formed as indicated in RFC 3863 [21], RFC 4480 [26], RFC 5196 [25], RFC 4482 [32], RFC 5263 [24] and RFC 4479 [44]. + +##### **2. PUBLISH request (P-CSCF to S-CSCF) - see example in table A.4.2.1-2** + +P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The PUBLISH request is forwarded to the S-CSCF. A Route header is inserted into PUBLISH request. The information for the Route header is taken from the service route determined during registration. + +**Table A.4.2.1-2: PUBLISH request (P-CSCF to S-CSCF)** + +``` +PUBLISH sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Access-Network-Info: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Content-Type: +Content-Length: + +(...) +``` + +##### **3. Evaluation of initial filter criteria** + +S-CSCF validates the service profile of the publisher and evaluates the initial filter criteria. For user1\_public1@home1.net S-CSCF#1 has originating initial Filter Criteria with Service Point Trigger of Method = PUBLISH AND Event = "presence" AND Request-URI = "sip:user1\_public1@home1.net" that informs the S-CSCF to route the PUBLISH request to the PS ps.home1.net. + +##### 4. PUBLISH (S-CSCF to PS) - see example in table A.4.2.1-4 + +The S-CSCF#1 forwards the PUBLISH request to the PS. + +**Table A.4.2.1-4: PUBLISH request (S-CSCF to PS)** + +``` +PUBLISH sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Access-Network-Info: +Max-Forwards: 68 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +Route: , +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Content-Type: +Content-Length: + +(...) +``` + +###### P-Charging-Vector: + +The S-CSCF populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +###### P-Charging-Function-Addresses: + +The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the PS. + +##### 5. Authorization of publisher + +The PS performs the necessary authorization checks on the originator to ensure it is allowed to publish the presentity's presence information. In this example all privacy conditions are met, so the PS sends a 200 (OK) response to the S-CSCF. + +##### 6. 200 (OK) response (PS to S-CSCF) - see example in table A.4.2.1-6 + +The PS sends the response to S-CSCF. + +**Table A.4.2.1-6: 200 (OK) response (PS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig- + ioi=home1.net;term-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: 7200 +SIP-ETag: 123xy +Content-Length: 0 +``` + +###### P-Charging-Vector: + +The PS stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +###### P-Charging-Function-Addresses: + +The PS stores the P-Charging-Function-Addresses header field and passes this header to the S-CSCF. + +**SIP-ETag:** This field is populated with a locally unique entity-tag to associate further publications of this event state. + +##### 7. **200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1-7** + +S-CSCF forwards the response to P-CSCF. + +**Table A.4.2.1-7: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +P-Charging-Function-Addresses: +From: +To: +Call-ID: +CSeq: +Expires: +SIP-ETag: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter and removes the orig-ioi and the term-ioi parameters. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +##### 8. **200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1-6** + +P-CSCF forwards the response to the PUA in the UE. + +**Table A.4.2.1-8: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Expires: +SIP-ETag: +Content-Length: +``` + +### A.4.3 Refreshing of presence information by UE + +#### A.4.3.1 Successful refresh + +![Sequence diagram showing the successful refresh of presence information by a UE. The diagram involves four entities: UE, P-CSCF#1, S-CSCF#1, and PS. The sequence of messages is: 1. PUBLISH from UE to P-CSCF#1; 2. PUBLISH from P-CSCF#1 to S-CSCF#1; 3. Evaluation of initial filter criteria (internal to S-CSCF#1); 4. PUBLISH from S-CSCF#1 to PS; 5. Publisher authorisation (internal to PS); 6. 200 (OK) from PS to S-CSCF#1; 7. 200 (OK) from S-CSCF#1 to P-CSCF#1; 8. 200 (OK) from P-CSCF#1 to UE.](4a390493f601ce1ac6b9201db4e28b5a_img.jpg) + +Home Network#1 + +``` + +sequenceDiagram + participant UE + participant P-CSCF#1 + participant S-CSCF#1 + participant PS + UE->>P-CSCF#1: 1. PUBLISH + P-CSCF#1->>S-CSCF#1: 2. PUBLISH + Note right of S-CSCF#1: 3. Evaluation of initial +filter criteria + S-CSCF#1->>PS: 4. PUBLISH + Note right of PS: 5. Publisher +authorisation + PS->>S-CSCF#1: 6. 200 (OK) + S-CSCF#1->>P-CSCF#1: 7. 200 (OK) + P-CSCF#1->>UE: 8. 200 (OK) + +``` + +Sequence diagram showing the successful refresh of presence information by a UE. The diagram involves four entities: UE, P-CSCF#1, S-CSCF#1, and PS. The sequence of messages is: 1. PUBLISH from UE to P-CSCF#1; 2. PUBLISH from P-CSCF#1 to S-CSCF#1; 3. Evaluation of initial filter criteria (internal to S-CSCF#1); 4. PUBLISH from S-CSCF#1 to PS; 5. Publisher authorisation (internal to PS); 6. 200 (OK) from PS to S-CSCF#1; 7. 200 (OK) from S-CSCF#1 to P-CSCF#1; 8. 200 (OK) from P-CSCF#1 to UE. + +Figure A.4.3.1-1: UE updating presence information + +Figure A.4.3.1-1 shows an UE refreshing the presence information about a presentity. The details of the signalling flows are as follows: + +##### - PUBLISH request (UE to P-CSCF) – see example in table A.4.3.1-1** + +A PUA in a UE wishes to refresh already existing presence information. To initiate the publication, the UE generates a PUBLISH request according to RFC 3903 [23]. + +Table A.4.3.1-1: PUBLISH request (UE to P-CSCF) + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 PUBLISH sip:user1_public1@home1.net SIP/2.0 Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 70 P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 Route: <sip:pcscf1.visited1.net:7531;lr;comp=sigcomp>, <sip:orig@scscf1.home1.net;lr> P-Preferred-Identity: <sip:user1_public1@home1.net> Privacy: none From: <sip:user1_public1@home1.net>;tag=31415 To: <sip:user1_public1@home1.net> Call-ID: b89rjhnedrflj40a111 CSeq: 61 PUBLISH Require: sec-agree Proxy-Require: sec-agree Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port-c=8642; port-s=7531 Event: presence SIP-If-Match: 123xy Expires: 7200 Content-Length: 0
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Request-URI:** Public user identity whose presence information the PUA intends to publish. + +**Event:** This field is populated with the value "presence" to specify the use of the presence package. + +**To:** Same as the Request-URI. + +**SIP-If-Match:** This field is populated with the entity-tag earlier provided by the PS in the SIP-ETag header field of the previous 200(OK) response and is used as a versioning precondition to the PUBLISH refresh. + +##### 2. **PUBLISH request (P-CSCF to S-CSCF) - see example in table A.4.3.1-2** + +P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The PUBLISH request is forwarded to the S-CSCF. A Route header is inserted into PUBLISH request. The information for the Route header is taken from the service route determined during registration. + +**Table A.4.3.1-2: PUBLISH request (P-CSCF to S-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
PUBLISH sip:user1_public1@home1.net SIP/2.0 Via: SIP/2.0/UDP pscsf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 P-Access-Network-Info: Max-Forwards: 69 P-Asserted-Identity: <sip:user1_public1@home1.net> P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" Privacy: Route: <sip:orig@scscf1.home1.net;lr> From: To: Call-ID: CSeq: Event: SIP-If-Match: Expires: Content-Length:
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**P-Charging-Vector:** The P-CSCF populates the icid parameter with a globally unique value. + +##### 3. **Evaluation of initial filter criteria** + +S-CSCF#1 validates the service profile of this publisher and evaluates the initial filter criteria. For user1\_public1@home1.net the S-CSCF has originating initial Filter Criteria with Service Point Trigger of Method = PUBLISH AND Event = "presence" AND Request-URI = "sip:user1\_public1@home1.net" that informs the S-CSCF to route the PUBLISH request to the PS ps.home1.net. + +##### 4. **PUBLISH (S-CSCF to PS) – see example in table A.4.3.1-4** + +The S-CSCF forwards the PUBLISH request to the PS. + +**Table A.4.3.1-4: PUBLISH (S-CSCF to PS)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
PUBLISH sip:user1_public1@home1.net SIP/2.0 Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP pscsf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 P-Access-Network-Info: Max-Forwards: 68 P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] Privacy: Route: <sip:ps.home1.net;lr>, <sip:scscf1.home1.net;lr> From: To: Call-ID: CSeq: Event: SIP-If-Match: Expires: Content-Length:
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**P-Charging-Vector:** + +The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the PS. + +##### **5. Authorization of publisher** + +The PS performs the necessary authorization checks on the originator to ensure it is allowed to publish the presentity's presence information. In this example all privacy conditions are met, so the PS sends a 200 (OK) response to the S-CSCF. + +##### **6. 200 (OK) response (PS to S-CSCF) - see example in table A.4.3.1-6** + +The PS sends the response to S-CSCF. + +**Table A.4.3.1-6: 200 (OK) response (PS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023555517"; orig- + ioi=home1.net;term-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: 7200 +SIP-ETag: 345abc +Content-Length: 0 +``` + +**P-Charging-Vector:** The PS stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS stores the P-Charging-Function-Addresses header field and passes this header to the S-CSCF. + +**SIP-ETag:** This field is populated with a new locally unique entity-tag. + +##### **7. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.3.1-7** + +S-CSCF#1 forwards the response to P-CSCF. + +**Table A.4.3.1-7: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023555517" +P-Charging-Function-Addresses: +From: +To: +Call-ID: +CSeq: +Expires: +SIP-ETag: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter and removes the orig-ioi and the term-ioi parameters. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +##### **8. 200 (OK) response (P-CSCF to UE) - see example in table A.4.3.1-6** + +P-CSCF#1 forwards the response to the PUA in the UE. + +Table A.4.3.1-8: 200 (OK) response (P-CSCF to UE) + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Expires: +SIP-ETag: +Content-Length: + +``` + +## A.5 PS notifying watcher of updates to presence information + +### A.5.1 Introduction + +This subclause covers the signalling flows that show how the PS notifies watchers of updates to presence information. + +### A.5.2 Watcher and presentity in the different networks, UE in the home network + +#### A.5.2.1 Successful notification + +![Sequence diagram showing the successful notification flow from AS(PS) to UE via various network elements.](d15e2d3e8dd9157eb7f0cc120097484a_img.jpg) + +The diagram illustrates the signalling flow for a successful notification. It is divided into two network domains: 'Presentity Home Network (Home2.net)' and 'Watcher Home Network (Home1.net)'. The entities involved are AS(PS), S-CSCF#2, I-CSCF, S-CSCF#1, HSS, P-CSCF, and UE. The sequence of messages is as follows: + +1. NOTIFY: AS(PS) to S-CSCF#1 +2. NOTIFY: S-CSCF#1 to P-CSCF +3. NOTIFY: P-CSCF to UE +4. 200 (OK): UE to P-CSCF +5. 200 (OK): P-CSCF to S-CSCF#1 +6. 200 (OK): S-CSCF#1 to AS(PS) + +Sequence diagram showing the successful notification flow from AS(PS) to UE via various network elements. + +Figure A.5.2.1-1: Notification to watcher in the visited network + +Figure A.5.2.1-1 shows how a watcher is notified of updates to a presentity's presence information. The signalling flow is applicable to the case where the watcher and presentity are in the same or in different IM CN subsystems. + +##### 1. NOTIFY request (PS to S-CSCF) – see example in table A.5.2.1-1 + +The PS determines which authorized watchers are entitled to receive the updates of the presence information for this presentity. For each appropriate watcher, the PS sends a NOTIFY request that contains the updated state of presence information. The NOTIFY request may either contain the complete set of presence information, or only the information that has changed since the last notification. In this example, the watcher indicated preference for partial notification in the SUBSCRIBE request, so the NOTIFY request is formulated according to RFC 5263 [24] and RFC 5262 [38] by including only the information that has changed since the last notification. (Note that the first NOTIFY request has contained the full state of the presence information.) + +**Table A.5.2.1-1: NOTIFY request (PS to S-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=523551024"; orig-ioi=home2.net +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrfljflslj40a222 +CSeq: 43 NOTIFY +Subscription-State: active;expires=5000 +Event: presence +Contact: +Content-Type: application/pidf-diff+xml +Content-Length: (...) + + + + + + + + open + + voice + http://example.com/~user2/iconABC.gif + tel:40302020@home2.net + This is a new tuple inserted as the 2nd tuple. + 2004-11-01T11:49:29Z + + ] ] > + + closed + + + + + + + + http://example.com/~user2/iconXYZ.gif + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +##### 2. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.5.2.1-2 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.5.2.1-2: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=523551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter. + +**P-Charging-Function-Addresses:** The S-CSCF populates the P-Charging-Function-Addresses header field to be passed to the P-CSCF. + +##### 3. NOTIFY request (P-CSCF to UE) - see example in table A.5.2.1-3 + +The P-CSCF forwards the NOTIFY request to the UE. + +**Table A.5.2.1-3: NOTIFY request (P-CSCF to UE)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.home1.net;branch=240f34.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +##### 4. 200 (OK) response (UE to P-CSCF) - see example in table A.5.2.1-4 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.5.2.1-4: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.home1.net;branch=240f34.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +##### 5. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.5.2.1-5 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.5.2.1-5: 200 (OK) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +ps.home2.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=523551024" +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +##### 6. **200 (OK) response (S-CSCF to PS)** - see example in table A.5.2.1-6 + +The S-CSCF forwards the 200 (OK) response to the PS. + +**Table A.5.2.1-6: 200 (OK) response (S-CSCF to PS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK240f34.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=523551024"; orig- +ioi=home1.net:term-ioi=home2.net +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +### A.5.3 Notification to resource list in a different network and notification to watcher in the visited network + +#### A.5.3.1 Successful notification + +![Sequence diagram showing the notification flow between AS(PS), S-CSCF#2, AS(RLS), S-CSCF#1, P-CSCF, and UE across three network domains: Presentity Home Network, Home Network of UE, and Visited Network.](91aa06b0972f24b4889588fa0e3a331a_img.jpg) + +``` + +sequenceDiagram + participant AS(PS) + participant S-CSCF#2 + participant AS(RLS) + participant S-CSCF#1 + participant P-CSCF + participant UE + + Note left of AS(PS): Presentity Home Network + Note left of AS(RLS): Home Network of UE + Note left of P-CSCF: Visited Network + + S-CSCF#2->>AS(RLS): 1. NOTIFY + AS(RLS)->>S-CSCF#1: 2. NOTIFY + S-CSCF#1->>AS(RLS): 3. 200 (OK) + S-CSCF#1->>AS(PS): 4. 200 (OK) + AS(RLS)->>S-CSCF#1: 5. NOTIFY + S-CSCF#1->>P-CSCF: 6. NOTIFY + P-CSCF->>UE: 7. NOTIFY + UE->>P-CSCF: 8. 200 (OK) + P-CSCF->>S-CSCF#1: 9. 200 (OK) + S-CSCF#1->>AS(RLS): 10. 200 (OK) + +``` + +Sequence diagram showing the notification flow between AS(PS), S-CSCF#2, AS(RLS), S-CSCF#1, P-CSCF, and UE across three network domains: Presentity Home Network, Home Network of UE, and Visited Network. + +**Figure A.5.3.1-1: Notification to resource list in a different network and notification to watcher in the visited network** + +Figure A.5.3.1-1 shows the PS providing presence event notification about a presentity to a RLS in a different network. This notification triggers the RLS to provide presence event notification to the watcher. The details of the signalling flows are as follows: + +##### 1. NOTIFY request (PS to S-CSCF) - see example in table A.5.3.1-1 + +The PS determines which authorized watchers are entitled to receive presence information. For each appropriate watcher, the PS sends a NOTIFY request that contains the updated state of presence information. In this example the notification is only sent to the RLS. + +The NOTIFY request may either contain the complete set of presence information, or only those presence information that have changed since the last notification. In this example, the complete set of presence information is sent. + +**Table A.5.3.1-1: NOTIFY request (PS to S-CSCF)** + +``` +NOTIFY sip:rls.home1.net SIP/2.0 +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=623551024"; orig-ioi=home12.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: +From: ;tag=151170 +To: ;tag=31415 +Call-ID: gahjt393yhakfh83hfas198a +CSeq: 43 NOTIFY +Subscription-State: active;expires=5000 +Event: presence +Contact: +Content-Type: application/pidf+xml +Content-Length: (...) + + + + + + + open + + + http://example.com/~user2/icon.gif + sip + + false + true + + sip:user2_public1@home2.net + Don't Disturb Please! + Ne derangez pas, s'il vous plait + 2003-08-27T17:35:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +The message body in the NOTIFY request that carries the presence information of the presentity is formed as indicated in RFC 3863 [21], RFC 4480 [26], RFC 5196 [25], RFC 4482 [32], RFC 5263 [24] and RFC 4479 [44]. + +##### 2. NOTIFY request (S-CSCF to RLS) - see example in table A.5.3.1-2 + +The S-CSCF#1 forwards the NOTIFY request to the RLS. + +**Table A.5.3.1-2: NOTIFY request (S-CSCF to RLS)** + +``` +NOTIFY sip:rls.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bKehuehjgt, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +P-Charging-Vector: +P-Charging-Function-Addresses: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the RLS. + +##### 3. 200 (OK) response (RLS to S-CSCF) - see example in table A.5.3.1-3 + +The RLS generates a 200 (OK) response to the NOTIFY request. + +**Table A.5.3.1-3: 200 (OK) response (RLS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=623551024"; orig- +ioi=home1.net;term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**P-Charging-Vector:** The RLS stores the terminating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +##### 4. 200 (OK) response (S-CSCF to PS) - see example in table A.5.3.1-4 + +The S-CSCF#1 forwards the 200 (OK) response to the PS. + +**Table A.5.3.1-4: 200 (OK) response (S-CSCF to PS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=623551024"; orig- + ioi=home1.net:term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +##### 5. NOTIFY request (RLS to S-CSCF#1) - see example in table A.5.3.1-5 + +The RLS may decide to wait for other notifications and combine them in a single notification towards the UE or it sends the notification to the UE without any waiting. In this example, the RLS does not wait for other notifications. + +**Table A.5.3.1-5: NOTIFY request (RLS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=723551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: gahjt393yhakfh83hfas198a +CSeq: 90 NOTIFY +Subscription-State: active;expires=4500 +Require: eventlist +Event: presence +Contact: +Content-Type: multipart/related;type="application/rlmi+xml"; + start="";boundary="70UBfW7L78hjgfgUPe5z" +Content-Length: (...) + +--70UBfW7L78hjgfgUPe5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/rlmi+xml;charset="UTF-8" + + + + Kovacs Janos + + + + +--70UBfW7L78hjgfgUPe5z +Content-Transfer-Encoding: binary +Content-ID: +Content-Type: application/pidf+xml;charset="UTF-8" + + + + + + + +``` + +``` + +open + +sip + +http://example.com/~user2/icon.gif + +false +true + +sip:user2_public1@home2.net +Don't Disturb Please! +Ne derangez pas, s'il vous plait +2003-08-27T17:35:29Z + + + + presentity + http://example.com/~user2 + http://example.com/~user2/card.vcd + + + + + + +--70UBfW7L78hjfgUPe5z + +``` + +###### **P-Charging-Vector:** + +The RLS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +###### **P-Charging-Function-Addresses:** + +The RLS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +The message body in the NOTIFY request that carries the presence information of the presentity is formed as indicated in RFC 3863 [21], RFC 4480 [26], RFC 5196 [25], RFC 4482 [32], RFC 5263 [24] and RFC 4479 [44]. + +##### 6. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.5.3. 1-6 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.5.3.1-6: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=723551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +###### **P-Charging-Vector:** + +The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter. + +###### **P-Charging-Function-Addresses:** + +The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +##### **7. NOTIFY request (P-CSCF to UE) - see example in table A.5.3.1-7** + +The P-CSCF forwards the NOTIFY request to the UE. + +**Table A.5.3.1-7: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Require: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +##### **8. 200 (OK) response (UE to P-CSCF) - see example in table A.5.3.1-8** + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.5.3.1-8: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **9. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.5.3.1-9** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.5.3.1-9: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=723551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### 10. 200 (OK) response (S-CSCF to RLS) – see example in table A.5.3.1-10 + +The S-CSCF forwards the response to the RLS in the home network of the presentity. + +**Table A.5.3.1-10: 200 (OK) response (S-CSCF to RLS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP rls.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=723551024"; orig- + ioi=home1.net:term-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the RLS. + +## A.6 PUA subscribing to his own watcher list and receiving notification of new watcher subscriptions + +### A.6.1 Introduction + +This subclause covers the signalling flows that show how a PUA can subscribe to his own watcher list. + +### A.6.2 PUA subscribing to watcher list and receiving a notification of an already pending watcher subscription followed by a notification of a subscription from a new watcher not already in the watcher list + +![Sequence diagram showing the signaling flow for PUA subscribing to a watcher list and receiving notifications. The diagram is divided into two network domains: Visited Network (UE (PUA), P-CSCF) and Home Network of UE (S-CSCF, AS(PS)).](7dfe05137c554aca6bed20d67e52d739_img.jpg) + +``` + +sequenceDiagram + participant UE (PUA) + participant P-CSCF + participant S-CSCF + participant AS(PS) + + Note right of S-CSCF: Evaluation of initial filter criteria + + UE (PUA)->>P-CSCF: 1. SUBSCRIBE + P-CSCF->>S-CSCF: 2. SUBSCRIBE + S-CSCF->>AS(PS): 4. SUBSCRIBE + AS(PS)->>S-CSCF: 6. 200 (OK) + S-CSCF->>P-CSCF: 7. 200 (OK) + P-CSCF->>UE (PUA): 8. 200 (OK) + AS(PS)->>S-CSCF: 9. NOTIFY + S-CSCF->>P-CSCF: 10. NOTIFY + P-CSCF->>UE (PUA): 11. NOTIFY + UE (PUA)->>P-CSCF: 12. 200 (OK) + P-CSCF->>S-CSCF: 13. 200 (OK) + S-CSCF->>AS(PS): 14. 200 (OK) + Note left of UE (PUA): 15. Watcher authorisation + AS(PS)->>S-CSCF: 16. NOTIFY + S-CSCF->>P-CSCF: 17. NOTIFY + P-CSCF->>UE (PUA): 18. NOTIFY + UE (PUA)->>P-CSCF: 19. 200 (OK) + P-CSCF->>S-CSCF: 20. 200 (OK) + S-CSCF->>AS(PS): 21. 200 (OK) + Note right of AS(PS): 22. Pending new watcher subscription + AS(PS)->>S-CSCF: 23. NOTIFY + S-CSCF->>P-CSCF: 24. NOTIFY + P-CSCF->>UE (PUA): 25. NOTIFY + UE (PUA)->>P-CSCF: 26. 200 (OK) + P-CSCF->>S-CSCF: 27. 200 (OK) + S-CSCF->>AS(PS): 28. 200 (OK) + Note left of UE (PUA): 29. Watcher authorisation + AS(PS)->>S-CSCF: 30. NOTIFY + S-CSCF->>P-CSCF: 31. NOTIFY + P-CSCF->>UE (PUA): 32. NOTIFY + UE (PUA)->>P-CSCF: 33. 200 (OK) + P-CSCF->>S-CSCF: 34. 200 (OK) + S-CSCF->>AS(PS): 35. 200 (OK) + +``` + +Sequence diagram showing the signaling flow for PUA subscribing to a watcher list and receiving notifications. The diagram is divided into two network domains: Visited Network (UE (PUA), P-CSCF) and Home Network of UE (S-CSCF, AS(PS)). + +**Figure A.6.2-1: PUA subscribing to watcher list and receiving a notification of an already pending watcher subscription followed by a notification of a subscription from a new watcher not already in the watcher list** + +Figure A.6.2-1 shows a PUA subscribing to the watcher list and receiving a notification of an already pending watcher subscription followed by a notification of a subscription from a new watcher not already in the watcher list. In this example the default watcherinfo subscription filtering policy is applied meaning that a partial state of a watcher-info document is transported in the notifications. The details of the signalling flows as follows: + +##### 1. SUBSCRIBE request (UE to P-CSCF) – see example in table A.6.2-1 + +The presentity wishes to watch his own watcher information, therefore he subscribes for the watcher information template-package of presence. The UE generates a SUBSCRIBE request containing the presence.winfo event, together with an indication of the length of time this periodic subscription should last. + +**Table A.6.2-1: SUBSCRIBE request (UE to P-CSCF)** + +``` + +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedlrfjflslj40a222 +CSeq: 123 SUBSCRIBE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi=87654321; port- +c=8642; port-s=7531 +Event: presence.winfo +Expires: 7200 +Accept: application/watcherinfo+xml +Contact: +Content-Length: 0 + +``` + +**Request URI:** Public user identity whose events the subscriber subscribes to. In this case the Public User Identity of the presentity in SIP URI format. + +**Event:** This field is populated with the value "presence.winfo" to specify the use of the watcher information template-package of presence. + +**Accept:** This field is populated with the value 'application/watcherinfo+xml' indicating that the UE supports this body type for notification. + +**To:** Same as the Request-URI. + +#### 2. SUBSCRIBE request (P-CSCF to S-CSCF) – see example in table A.6.2-2 + +The P-CSCF looks up the serving network information for the public user identity that was stored during the registration procedure. The SUBSCRIBE request is forwarded to the S-CSCF. A Route header is inserted into SUBSCRIBE request. + +**Table A.6.2-2: SUBSCRIBE request (P-CSCF to S-CSCF)** + +``` + +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK120f34.1 , SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Access-Network-Info: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +##### 3. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:user1\_public1@home1.net the S-CSCF has originating initial Filter Criteria with Service Point Trigger of Method = SUBSCRIBE AND Event = "presence.wininfo" that informs the S-CSCF to route the SUBSCRIBE request to the AS sip:ps.home1.net. + +##### 4. SUBSCRIBE request (S-CSCF to PS) – see example in table A.6.2-4 + +The S-CSCF forwards the SUBSCRIBE request to the PS. + +**Table A.6.2-4: SUBSCRIBE request (S-CSCF to PS)** + +``` + +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Access-Network-Info: +Max-Forwards: 68 +P-Asserted-Identity: , +P-Charging-Vector: icid-value="AyretyU0dm+6O2TrT5tAFrbHLso=023551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +Route: , +Record-Route: , +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Accept: +Contact: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the PS. + +##### 5. Authorization + +The PS performs the necessary authorization checks on the originator. In this example, the originator is the owner of the watcher information, so he/she is authorized to see the full watcher information. + +In other examples (when the originator is not the owner of the watcher information) subscribers are only allowed to monitor the state of their own subscription, which means that they will receive notifications only containing the state of their own subscription. This requires that a terminating initial Filter Criteria with Service Point Trigger of Method = SUBSCRIBE AND Event = "presence.wininfo" has been defined for the user sip:user1\_public1@home1.net. + +##### 6. 200 (OK) response (PS to S-CSCF) - see example in table A.6.2-6 + +The PS sends the response to the S-CSCF. + +**Table A.6.2-6: 200 (OK) response (PS to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig- + ioi=home1.net;term-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Record-Route: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: 0 + +``` + +**P-Charging-Vector:** The PS stores the originating Inter Operator Identifier (IOI) parameter and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS stores the P-Charging-Function-Addresses header field and passes this header to the S-CSCF. + +##### **7. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.6.2-7** + +The S-CSCF forwards the response to the P-CSCF. + +**Table A.6.2-7: 200 (OK) response (S-CSCF to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK120f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Record-Route: +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF stores the terminating Inter Operator Identifier (IOI) parameter. + +##### **8. 200 (OK) response (P-CSCF to UE) - see example in table A.6.2-8** + +The P-CSCF forwards the response to the PUA in the UE. + +**Table A.6.2-8: 200 (OK) response (P-CSCF to UE)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKehuefdam +Record-Route: , +From: +To: +Call-ID: +CSeq: +Expires: +Contact: +Content-Length: + +``` + +##### **9. NOTIFY request (PS to S-CSCF) - see example in table A.6.2-9** + +After the PS generated a 200 (OK) response to the SUBSCRIBE request from the UE, it generates a NOTIFY request containing the current state of the watcher information. The watcher information contains one pending subscription. + +**Table A.6.2-9 NOTIFY request (PS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrfljflslj40a222 +CSeq: 89 NOTIFY +Subscription-State: active;expires=7200 +Event: presence.wininfo +Contact: +Content-Type: application/watcherinfo+xml +Content-Length: (...) + + + + + sip:user2_public1@home2.net + + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +##### 10. NOTIFY request (S-CSCF to P-CSCF) – see example in table A.6.2-10 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.6.2-10: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +#### 11. NOTIFY request (P-CSCF to UE) - see example in table A.6.2-11 + +The P-CSCF forwards the NOTIFY request to the PUA in the UE. + +**Table A.6.2-11: NOTIFY request (P-CSCF to UE)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Record-Route: , +Max-Forwards: 68 +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**12. 200 (OK) response (UE to P-CSCF) – see example in table A.6.2-12** + +The PUA on the UE determines that this is a full state watcher-info document and replaces any current watcher-info with the new document. The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.6.2-12: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +**13. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.6.2-13** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.6.2-13: 200 (OK) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**14. 200 (OK) response (S-CSCF to PS) – see example in table A.6.2-14** + +The P-CSCF forwards the response to the PS in the home network of the UE. + +**Table A.6.2-14: 200 (OK) response (S-CSCF to PS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig- + ioi=home1.net:term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF inserts the terminating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +#### 15. Authorization of watcher + +The presentity determines to allow the watcher to access the presence information. The PUA modifies the subscription authorization policy by authorizing presence information for sip:user2\_public1@home1.net. + +#### 16. NOTIFY request (PS to S-CSCF) – see example in table A.6.2-16 + +The authorization event means changes in the watcher information, which triggers a new NOTIFY request. The watcher information included in the NOTIFY request contains only information on the watcher whose state has changed, which in this example is the accepted subscription of sip:user2\_public1@home1.net. + +**Table A.6.2-16: NOTIFY request (PS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj40a222 +CSeq: 90 NOTIFY +Subscription-State: active;expires=4900 +Event: presence.wininfo +Contact: +Content-Type: application/watcherinfo+xml +Content-Length: (...) + + + + + sip:user2_public1@home2.net + + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +#### 17. NOTIFY request (S-CSCF to P-CSCF) – see example in table A.6.2-17 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.6.2-17: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=223551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF passes this header received. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +#### 18. NOTIFY request (P-CSCF to UE) - see example in table A.6.2-18 + +The P-CSCF forwards the NOTIFY request to the PUA in the UE. + +**Table A.6.2-18: NOTIFY request (P-CSCF to UE)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Record-Route: , +Max-Forwards: 68 +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +#### 19. 200 (OK) response (UE to P-CSCF) - see example in table A.6.2-19 + +The PUA determines that this is a full state watcher-info document and replaces any current watcher-info with the new document. The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.6.2-19: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 20. 200 (OK) response (P-CSCF to S-CSCF) – see example in table A.6.2-20 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.6.2-20: 200 (OK) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +21. **200 (OK) response (S-CSCF to PS) – see example in table A.6.2-21** + +The P-CSCF forwards the response to the PS in the home network of the UE. + +**Table A.6.2-21: 200 (OK) response (S-CSCF to PS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net +term-ioi=visited1.net +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**P-Charging-Vector:** The PS inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +22. **Pending new watcher subscription** + +The PS receives a SUBSCRIBE request from a new watcher and performs the necessary authorization checks on the originator and determines that this is a new watcher that is not yet in the watcher list. + +23. **NOTIFY request (PS to S-CSCF) - see example in table A.6.2-23** + +The PS generates a NOTIFY request containing watcher information of the new watcher pending subscription. Thus, the watcher information contains the partial state. + +**Table A.6.2-23 NOTIFY request (PS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj40a222 +CSeq: 90 NOTIFY +Subscription-State: active;expires=5000 +Event: presence.winfo +Content-Type: application/watcherinfo+xml +Contact: +Content-Length: (...) + + + + + sip:user3_public1@home3.net + + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +#### 24. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.6.2-24 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.6.2-24: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Type: +Contact: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +#### 25. NOTIFY request (P-CSCF to UE) - see example in table A.6.2-25 + +The P-CSCF forwards the NOTIFY request to the PUA in the UE. + +**Table A.6.2-25: NOTIFY request (P-CSCF to UE)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Type: +Contact: +Content-Length: + +(...) + +``` + +**26. 200 (OK) response (UE to P-CSCF) - see example in table A.6.2-26** + +The PUA determines that this is a partial state notification of watcher-info and adds the new pending subscription to its existing watcher-info document. The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.6.2-26: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +**27. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.6.2-27** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.6.2-27: 200 (OK) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**28. 200 (OK) response (S-CSCF to PS) - see example in table A.6.2-28** + +The P-CSCF forwards the response to the PS in the home network of the UE. + +**Table A.6.2-28: 200 (OK) response (S-CSCF to PS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net; + term-ioi=visited1.net +From: +To: +Call-ID: +CSeq: +Content-Length: + +``` + +**P-Charging-Vector:** The S-CSCF inserts the originating Inter Operator Identifier (IOI) parameter received and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +## 29. Authorization of watcher + +The presentity determines to allow the watcher to access the presence information. The PUA modifies the authorization policy by authorizing presence information for sip:user3\_public1@home3.net. + +## 30. NOTIFY request (PS to S-CSCF) - see example in table A.6.2-30 + +The authorization event means changes in the watcher information, which triggers a new NOTIFY request. The watcher information included in the NOTIFY request contains the accepted subscription of sip:user3\_public1@home3.net. + +**Table A.6.2-30 NOTIFY request (PS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedlrfjflslj40a222 +CSeq: 90 NOTIFY +Subscription-State: active;expires=4900 +Event: presence.wininfo +Content-Type: application/watcherinfo+xml +Contact: +Content-Length: (...) + + + + + sip:user3_public1@home3.net + + + +``` + +**P-Charging-Vector:** The PS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The PS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +## 31. NOTIFY request (S-CSCF to P-CSCF) – see example in table A.6.2-31 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.6.2-31: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +ps.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=423551024" +P-Charging-Function-Addresses: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Type: +Contact: +Content-Length: + +(...) + +``` + +**P-Charging-Vector:** The S-CSCF stores the originating Inter Operator Identifier (IOI) parameter received. + +**P-Charging-Function-Addresses:** The S-CSCF stores the P-Charging-Function-Addresses header field and passes this header to the P-CSCF. + +### 32. NOTIFY request (P-CSCF to UE) - see example in table A.6.2-32 + +The P-CSCF forwards the NOTIFY request to the PUA in the UE. + +**Table A.6.2-32: NOTIFY request (P-CSCF to UE)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Type: +Contact: +Content-Length: + +(...) + +``` + +### 33. 200 (OK) response (UE to P-CSCF) - see example in table A.6.2-33 + +The PUA determines that this is a partial state notification of watcher-info and updates the active subscription to its existing watcher-info document. The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.6.2-33: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=240f34.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP ps.home2.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +### 34. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.6.2-34 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.6.2-34: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**35. 200 (OK) response (S-CSCF to PS) - see example in table A.6.2-35** + +The P-CSCF forwards the response to the PS in the home network of the UE. + +**Table A.6.2-35: 200 (OK) response (S-CSCF to PS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP ps.home1.net;branch=z9hG4bK240f34.1 +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +--- + +## A.7 PNA subscription for the reg-event package + +Figure A.7-1 shows the registration signalling flow for the scenario when the user is not registered. For the purpose of this registration signalling flow, the subscriber is considered to be roaming. This signalling flow also shows the authentication of the private user identity. + +This is followed by the subscription procedure for the reg-event package, whereby the PNA requests to be notified by the S-CSCF when a registration event has occurred. This is done using the 'reg-event' package as described in 3GPP TS 24.229 [9]. + +![Sequence diagram showing registration signalling for a user not registered. Lifelines: UE, RAN, GPRS/DHCP, P-CSCF, DNS, I-CSCF, S-CSCF, HSS, PNA. The diagram is split into Visited Network (visited1.net) and Home Network (home1.net).](a7450c80e88ad3f6ca1427ad84020998_img.jpg) + +``` + +sequenceDiagram + participant UE + participant RAN + participant GPRS/DHCP + participant P-CSCF + participant DNS + participant I-CSCF + participant S-CSCF + participant HSS + participant PNA + + Note left of UE: 1. GPRS Attach procedure +PDP Context Establishment +P-CSCF Discovery + UE->>P-CSCF: 2. REGISTER + P-CSCF->>DNS: 3. DNS: DNS-Q + DNS-->>P-CSCF: + P-CSCF->>I-CSCF: 4. REGISTER + I-CSCF->>HSS: 5. Cx: User registration status query + HSS-->>I-CSCF: + I-CSCF->>S-CSCF: 6. REGISTER + S-CSCF->>HSS: 7. Cx: Authentication + HSS-->>S-CSCF: 8. Authentication Vector Selection + S-CSCF->>I-CSCF: 9. 401 Unauthorized + I-CSCF->>P-CSCF: 10. 401 Unauthorized + P-CSCF->>UE: 11. 401 Unauthorized + Note right of UE: 12. oRsp session keys + UE->>P-CSCF: 13. REGISTER + P-CSCF->>DNS: 14. DNS: DNS-Q + DNS-->>P-CSCF: + P-CSCF->>I-CSCF: 15. REGISTER + I-CSCF->>HSS: 16. Cx: User registration status query + HSS-->>I-CSCF: + I-CSCF->>S-CSCF: 17. REGISTER + S-CSCF->>HSS: 18. Authentication + HSS-->>S-CSCF: 19. Cx: S-CSCF registration notification + S-CSCF->>I-CSCF: 20. 200 OK + I-CSCF->>P-CSCF: 21. 200 OK + P-CSCF->>UE: 22. 200 OK + Note right of S-CSCF: 23. Initial filter criteria + S-CSCF->>PNA: 24. REGISTER + PNA-->>S-CSCF: 25. 200 OK + S-CSCF->>PNA: 26. SUBSCRIBE + PNA-->>S-CSCF: 27. 200 OK + S-CSCF->>PNA: 28. NOTIFY + PNA-->>S-CSCF: 29. 200 OK + +``` + +Sequence diagram showing registration signalling for a user not registered. Lifelines: UE, RAN, GPRS/DHCP, P-CSCF, DNS, I-CSCF, S-CSCF, HSS, PNA. The diagram is split into Visited Network (visited1.net) and Home Network (home1.net). + +Figure A.7-1: Registration signalling: user not registered + +1-22. See 3GPP TS 24.228 [8], subclause 6.2 steps 1 through 22 + +**23. Initial filter criteria** + +The S-CSCF analyses the incoming request against the initial filter criteria and decides to send a third-party REGISTER request to the PNA. + +**24. REGISTER request (S-CSCF to PNA) - see example in table A.7-24** + +This signalling flow forwards the REGISTER request from the S-CSCF to the PNA. + +**Table A.7-24: REGISTER request (S-CSCF to PNA)** + +``` +REGISTER sip:ps.home1.net SIP/2.0 +Via: SIP/2.0/UDP sip:scscf1.home1.net +Max-Forwards: 70 +P-Access-Network-Info: +P-Visited-Network-ID: +P-Charging-Vector: +P-Charging-Function-Addresses: +From: sip:scscf1.home1.net +To: +Contact: +Expires: 600000 +Call-ID: apb03a0s09dkjdfglkj49112 +CSeq: 43 REGISTER +Content-Length: 0 +``` + +**25. 200 OK response (PNA to S-CSCF) - see example in table A.7-25** + +The PNA sends a 200 (OK) response to the S-CSCF indicating that Registration was successful. + +**Table A.7-25: 200 OK response (PNA to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP sip:scscf1.home1.net +From: +To: +Call-ID: +Contact: ;expires=600000 +CSeq: +Date: Wed, 11 July 2001 08:49:37 GMT +Content-Length: +``` + +**26. SUBSCRIBE request (PNA to S-CSCF) - see example in table A.7-26** + +The PNA sends the SUBSCRIBE request for the reg event package. + +**Table A.7-26: SUBSCRIBE request (PNA to S-CSCF)** + +``` +SUBSCRIBE sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP sip:ps.home1.net +Max-Forwards: 70 +P-Asserted-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: dre36d2v32gnlgiiomm72445 +CSeq: 61 SUBSCRIBE +Event: reg +Expires: 600000 +Accept: application/reginfo+xml +Contact: +Content-Length: 0 +``` + +**From:** This header is populated with the SIP URI that identifies the PNA. + +**Contact:** This is where the NOTIFY requests for this subscription will be sent. + +- Event:** This field is set to the value 'reg' to specify the use of the reg event package. +- Accept:** This field is set to the value "application/reginfo+xml". + +**27. 200 (OK) response (S-CSCF to PNA) - see example in table A.7-27** + +The S-CSCF sends a 200 (OK) response to the PNA indicating that registration was successful. + +**Table A.7-27: 200 (OK) response (S-CSCF to PNA)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP sip:ps.home1.net +P-Asserted-Identity: +Privacy: +From: +To: ;tag=151170 +Call-ID: +CSeq: +Contact: +Expires: +Content-Length: +``` + +- Expires:** If value of the Expires header in SUBSCRIBE request is different from the one received in REGISTER method, then the value of Expires header in the 200 (OK) response is set to match the value of Expires header in REGISTER method. + +**28. NOTIFY request (S-CSCF to PNA) - see example in table A.7-28** + +The S-CSCF sends a first NOTIFY request towards the PNA in order to inform the PNA about the registration status of monitored user. + +**Table A.7-28: NOTIFY request (S-CSCF to PNA)** + +``` +NOTIFY sip:pcscf1.visited1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1 +Max-Forwards: 70 +From: ;tag=151170 +To: ;tag=31415 +Call-ID: dre36d2v32gnlgliomm72445 +CSeq: 42 NOTIFY +Subscription-State: active;expires=600000 +Event: reg +Content-Type: application/reginfo+xml +Contact: +Content-Length: (...) + + + + + + sip:[5555::aaa:bbb:ccc:ddd] + + + + + sip:[5555::aaa:bbb:ccc:ddd] + + + + + sip:[5555::aaa:bbb:ccc:ddd] + + + +``` + +- From:** The tag of this field matches that of the To; field in the received 200 (OK) response for the SUBSCRIBE request. +- Content-Type:** Set to the value of the Accept header received in the SUBSCRIBE request or "application/reginfo+xml" if the Accept header was not present in the SUBSCRIBE request. + +The message body in the NOTIFY request that carries the subscriber's registration state is formed as indicated in 3GPP TS 24.229 [9]. + +29. **200 (OK) response (PNA to S-CSCF) - see example in table A.7-29** + +PNA sends the 200 (OK) response to the S-CSCF. + +**Table A.7-29: 200 (OK) response (PNA to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: 0 +``` + +## A.8 Example signalling flows of HTTP based presence service operation + +### A.8.1 Introduction + +This subclause shows signalling flows relating to the manipulation of presence service data over the Ut reference point using XCAP. The flows only shows the signalling between the XCAP server and the XCAP client, thus possible proxies located in between the entities are not shown in the example signalling flows. + +Each example signalling flow shows several sequences of manipulation of data for the presence service. + +NOTE: Error conditions are not considered in the examples e.g. if authorization checks fail in the XCAP server, XML Schema compliancy checks fail or the file specified by the URI does not exist then an appropriate 4xx response is sent to the client. + +Clarifications how XCAP is using HTTP are described in RFC 4825 [33]. + +NOTE: The authentication proxy resides between UE (XCAP client) and AS (XCAP server), and examples of signalling flows for the authentication proxy are provided in 3GPP TS 24.109 [7]. + +## A.8.2 Signalling flows demonstrating how XCAP clients manipulate resource lists + +![Sequence diagram showing XCAP client (UE) and XCAP server (AS) interaction. The sequence is: 1. XCAP PUT (UE to AS), 2. XCAP 201 (Created) (AS to UE), 3. XCAP PUT (UE to AS), 4. XCAP 200 (OK) (AS to UE), 5. XCAP DELETE (UE to AS), 6. XCAP 200 (OK) (AS to UE), 7. XCAP GET (UE to AS), 8. XCAP 200 (OK) (AS to UE). Vertical ellipses indicate intermediate steps between the shown messages.](54159e6d8f5ecc73ad262758e3a60677_img.jpg) + +``` + +sequenceDiagram + participant UE as UE (XCAP client) + participant AS as AS (XCAP server) + Note right of UE: ... + UE->>AS: 1. XCAP PUT + AS-->>UE: 2. XCAP 201 (Created) + Note right of UE: ... + UE->>AS: 3. XCAP PUT + AS-->>UE: 4. XCAP 200 (OK) + Note right of UE: ... + UE->>AS: 5. XCAP DELETE + AS-->>UE: 6. XCAP 200 (OK) + Note right of UE: ... + UE->>AS: 7. XCAP GET + AS-->>UE: 8. XCAP 200 (OK) + +``` + +Sequence diagram showing XCAP client (UE) and XCAP server (AS) interaction. The sequence is: 1. XCAP PUT (UE to AS), 2. XCAP 201 (Created) (AS to UE), 3. XCAP PUT (UE to AS), 4. XCAP 200 (OK) (AS to UE), 5. XCAP DELETE (UE to AS), 6. XCAP 200 (OK) (AS to UE), 7. XCAP GET (UE to AS), 8. XCAP 200 (OK) (AS to UE). Vertical ellipses indicate intermediate steps between the shown messages. + +**Figure A.8.2-1: XCAP client manipulating a resource list on XCAP server** + +Figure A.8.2-1 shows a how a XCAP client may manipulate a resource list on a XCAP server. The details of the signalling flows are as follows: + +**1. XCAP PUT request (XCAP client to XCAP server - see example in table A.8.2-1** + +The XCAP client generates an XCAP PUT request to create a new resource list on the XCAP server. The resource list has one entry. + +**Table A.8.2-1: XCAP PUT request (XCAP client to XCAP server)** + +``` + +PUT http://xcap.home1.net/services/resource-lists/users/user1/pf.xml HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:13:17 GMT +Content-Type: application/resource-lists+xml +Content-Length: (...) + + + + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="urn:ietf:params:xml:ns:resource-lists"> + + + User2 + + + + +``` + +2. **XCAP 201 (Created) response (XCAP server to XCAP client)** – see example in table A.8.2-2 + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to create a file, the XCAP server sends an XCAP 201 (Created) response to the XCAP client. + +**Table A.8.2-2: XCAP 201 (Created) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 201 Created +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "aaa" +Date: Thu, 08 Jan 2004 10:50:35 GMT +Content-Length: 0 +``` + +3. **XCAP PUT request (XCAP client to XCAP server)** – see example in table A.8.2-3 + +The XCAP client adds a new entry to the previously created resource list by generating a new XCAP PUT request. + +**Table A.8.2-3: XCAP PUT request (XCAP client to XCAP server)** + +``` +PUT http://xcap.home1.net/services/resource-lists/users/user1/pf.xml/~/resource-lists/ +list%5b@name=%22Presence_fellows%22%5d/entry HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:13:17 GMT +Content-Type: application/xcap-el +Content-Length: (...) + + + User3 + +``` + +4. **XCAP 200 (OK) response (XCAP server to XCAP client)** - see example in table A.8.2-4 + +After the XCAP server has performed the necessary authorization checks, XML document validations and XML schema compliancy checks the XCAP server sends an XCAP 200 (OK) response to the XCAP client. + +**Table A.8.2-4: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "aab" +Date: Thu, 08 Jan 2004 10:50:45 GMT +Content-Length: 0 +``` + +5. **XCAP DELETE request (XCAP client to XCAP server)** - see example in table A.8.2-5 + +The XCAP client decides to delete the entry "user2" from the resource list. The XCAP client generates an XCAP DELETE request. + +**Table A.8.2-5: XCAP DELETE request (XCAP client to XCAP server)** + +``` +DELETE http://xcap.home1.net/services/resource-lists/users/user1/pf.xml/~/resource-lists/ +list%5b@name=%22Presence_fellows%22%5d/entry%5b@name=user2"%5d HTTP/1.1 +Host: oper.example.com:9999 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:14:17 GMT +``` + +6. **XCAP 200 (OK) response (XCAP server to XCAP client) – see example in table A.8.2-6** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to delete an entry from the resource list, the XCAP server sends an XCAP 200 (OK) response. + +**Table A.8.2-6: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 11:00:47 GMT +Content-Length: 0 +``` + +7. **XCAP GET request (XCAP client to XCAP server) – see example in table A.8.2-7** + +The XCAP client wishes to check the result of the previous transaction by generating an XCAP GET request. + +**Table A.8.2-7: XCAP GET request (XCAP client to XCAP server)** + +``` +GET http://xcap.home1.net/services/resource-lists/users/user1/pf.xml HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 11:13:17 GMT +Content-Length: 0 +``` + +8. **XCAP 200 (OK) response (XCAP server to XCAP client) - see example in table A.8.2-8** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to fetch the resource list, the XCAP server sends an XCAP 200 (OK) response to the XCAP client including the resource list in the body of the response. + +**Table A.8.2-8: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "askdajdsaj" +Date: Thu, 08 Jan 2004 11:50:35 GMT +Content-Type: application/resource-lists+xml +Content-Length: (...) + + + + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="urn:ietf:params:xml:ns:resource-lists"> + + + User3 + + + +``` + +### A.8.3 Signalling flows demonstrating how XCAP clients manipulate presence authorization policy + +![Sequence diagram showing XCAP client (UE) and XCAP server (AS) interaction. The sequence is: 1. XCAP PUT (UE to AS), 2. XCAP 201 (Created) (AS to UE), 3. XCAP PUT (UE to AS), 4. XCAP 200 (OK) (AS to UE), 5. XCAP DELETE (UE to AS), 6. XCAP 200 (OK) (AS to UE), 7. XCAP GET (UE to AS), 8. XCAP 200 (OK) (AS to UE). Vertical ellipses indicate additional steps between the shown messages.](4b2dd266b605b2f31a8759f802637301_img.jpg) + +``` + +sequenceDiagram + participant UE as UE (XCAP client) + participant AS as AS (XCAP server) + UE->>AS: 1. XCAP PUT + AS-->>UE: 2. XCAP 201 (Created) + Note over UE,AS: : + Note over UE,AS: : + UE->>AS: 3. XCAP PUT + AS-->>UE: 4. XCAP 200 (OK) + Note over UE,AS: : + Note over UE,AS: : + UE->>AS: 5. XCAP DELETE + AS-->>UE: 6. XCAP 200 (OK) + Note over UE,AS: : + Note over UE,AS: : + UE->>AS: 7. XCAP GET + AS-->>UE: 8. XCAP 200 (OK) + +``` + +Sequence diagram showing XCAP client (UE) and XCAP server (AS) interaction. The sequence is: 1. XCAP PUT (UE to AS), 2. XCAP 201 (Created) (AS to UE), 3. XCAP PUT (UE to AS), 4. XCAP 200 (OK) (AS to UE), 5. XCAP DELETE (UE to AS), 6. XCAP 200 (OK) (AS to UE), 7. XCAP GET (UE to AS), 8. XCAP 200 (OK) (AS to UE). Vertical ellipses indicate additional steps between the shown messages. + +**Figure A.8.3-1: XCAP client manipulating presence authorization policy on XCAP server** + +Figure A.8.3-1 shows a XCAP client manipulating presence authorization policy on a XCAP server. The details of the signalling flows are as follows: + +- XCAP PUT request (XCAP client to XCAP server) – see example in table A.8.3-1** + +The XCAP client generates an XCAP PUT request to create a presence authorization policy on the XCAP server. The presence authorization policy has one rule allowing for sip:user2\_public1@home2.net to see all service information along with the service related servcaps elements defined in RFC 5196 [25]. + +**Table A.8.3-1: XCAP PUT request (XCAP client to XCAP server)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 PUT http://xcap.home1.net/services/pres-rules/users/user1/ps.xml HTTP/1.1 User-Agent: IMS subscriber Date: Thu, 08 Jan 2004 10:13:17 GMT Content-Type: application/auth-policy+xml Content-Length: (...)  <?xml version="1.0" encoding="UTF-8"?> <ruleset xmlns="urn:ietf:params:xml:ns:common-policy"   xmlns:sc="urn:ietf:params:xml:ns:pidf:caps"   xmlns:pr="urn:ietf:params:xml:ns:pres-rules"   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   xsi:schemaLocation="urn:ietf:params:xml:ns:pres-rules">   <rule id="dsafa43232">     <conditions>       <identity>         <id entity="user2_public1@home2.net"/>       </identity>     </conditions>     <actions>
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +``` + +allow + + + + + + + true + + + + + +``` + +## 2. XCAP 201 (Created) response (XCAP server to XCAP client) - see example in table A.8.3-2 + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to create a file, the XCAP server sends an XCAP 201 (Created) response to the XCAP client. + +**Table A.8.3-2: XCAP 201 (Created) response (XCAP server to XCAP client)** + +``` + +HTTP/1.1 201 Created +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "bbb" +Date: Thu, 08 Jan 2004 10:50:35 GMT +Content-Length: 0 + +``` + +## 3. XCAP PUT request (XCAP client to XCAP server) – see example in table A.8.3-3 + +The XCAP client adds a new rule to the previously created presence authorization policy by generating a new XCAP request. The new rule blocks the user named sip:user3\_public1@home3.net to see presence information. + +**Table A.8.3-3: XCAP PUT request (XCAP client to XCAP server)** + +``` + +PUT http://xcap.home1.net/services/pres-rules/users/user1/ps.xml/~~/permission-statements/ +ruleset/rule%5b2%5d HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:13:27 GMT +Content-Type: application/xcap-el +Content-Length: (...) + + + + + + + + + block + + + +``` + +## 4. XCAP 200 (OK) response (XCAP server to XCAP client) - see example in table A.8.3-4 + +After the XCAP server has performed the necessary authorization checks, XML document validations and XML schema compliance checks the XCAP server sends an XCAP 200 (OK) response to the XCAP client. + +**Table A.8.3-4: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` + +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "bbb2" +Date: Thu, 08 Jan 2004 10:50:45 GMT +Content-Length: 0 + +``` + +5. **XCAP DELETE request (XCAP client to XCAP server) - see example in table A.8.3-5** + +The XCAP client decides to delete the rule for sip:user2\_public1@home2.net from the authorization policy. The XCAP client generates an XCAP DELETE request. + +**Table A.8.3-5: XCAP DELETE request (XCAP client to XCAP server)** + +``` +DELETE http://xcap.home1.net/services/pres-rules/users/user1/ps.xml/~~/ruleset/rule/ +statement[@id="dsafa43232"] HTTP/1.1 +Host: oper.example.com:9999 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:14:17 GMT +``` + +6. **XCAP 200 (OK) response (XCAP server to XCAP client) – see example in table A.8.3-6** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to delete an entry from the resource list, the XCAP server sends an XCAP 200 (OK) response. + +**Table A.8.3-6: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 11:00:47 GMT +Content-Length: 0 +``` + +7. **XCAP GET request (XCAP client to XCAP server) – see example in table A.8.3-7** + +The XCAP client wishes to check the result of the previous transaction by generating an XCAP GET request. + +**Table A.8.3-7: XCAP GET request (XCAP client to XCAP server)** + +``` +GET http://xcap.home1.net/services/pres-rules/users/user1/ps.xml HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 11:13:17 GMT +Content-Length: 0 +``` + +8. **XCAP 200 (OK) response (XCAP server to XCAP client) – see example in table A.8.3-8** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to fetch the resource list, the XCAP server sends an XCAP 200 (OK) response to the XCAP client including the authorization rules in the body of the response. + +**Table A.8.3-8: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "eiuekkksks" +Date: Thu, 08 Jan 2004 11:50:35 GMT +Content-Type: application/auth-policy+xml +Content-Length: (...) + + + + + + + + + + + block + + + +``` + + + +### A.8.4 Storing external content (successful operation) + +![Sequence diagram showing interactions between UE (XCAP client), AS (XCAP server), and HTTP server. The sequence includes HTTP PUT, HTTP 201 (Created), XCAP PUT, XCAP 201 (Created), HTTP GET, HTTP 200 (OK), HTTP PUT, HTTP 200 (OK), XCAP PUT, XCAP 200 (OK), HTTP DELETE, and HTTP 200 (OK) messages with vertical ellipsis separators.](23aceb0e7d3c1a644294899d9047df05_img.jpg) + +``` +sequenceDiagram + participant UE as UE (XCAP client) + participant AS as AS (XCAP server) + participant HTTP as HTTP server + + Note right of AS: 1. HTTP PUT + AS->>HTTP: 1. HTTP PUT + Note right of HTTP: 2. HTTP 201 (Created) + HTTP-->>UE: 2. HTTP 201 (Created) + Note right of UE: ... + Note right of UE: 3. XCAP PUT + UE->>AS: 3. XCAP PUT + Note right of AS: 4. XCAP 201 (Created) + AS-->>UE: 4. XCAP 201 (Created) + Note right of UE: ... + Note right of UE: 5. HTTP GET + UE->>HTTP: 5. HTTP GET + Note right of HTTP: 6. HTTP 200 (OK) + HTTP-->>UE: 6. HTTP 200 (OK) + Note right of UE: ... + Note right of UE: 7. HTTP PUT + UE->>HTTP: 7. HTTP PUT + Note right of HTTP: 8. HTTP 200 (OK) + HTTP-->>UE: 8. HTTP 200 (OK) + Note right of UE: ... + Note right of UE: 9. XCAP PUT + UE->>AS: 9. XCAP PUT + Note right of AS: 10. XCAP 200 (OK) + AS-->>UE: 10. XCAP 200 (OK) + Note right of UE: ... + Note right of UE: 11. HTTP DELETE + UE->>HTTP: 11. HTTP DELETE + Note right of HTTP: 12. HTTP 200 (OK) + HTTP-->>UE: 12. HTTP 200 (OK) +``` + +Sequence diagram showing interactions between UE (XCAP client), AS (XCAP server), and HTTP server. The sequence includes HTTP PUT, HTTP 201 (Created), XCAP PUT, XCAP 201 (Created), HTTP GET, HTTP 200 (OK), HTTP PUT, HTTP 200 (OK), XCAP PUT, XCAP 200 (OK), HTTP DELETE, and HTTP 200 (OK) messages with vertical ellipsis separators. + +Figure A.8.4.-1: XCAP client manipulating hard-state presence document on XCAP server + +Figure A.8.4-1 shows a XCAP client manipulating hard-state presence document on a XCAP server when the presence document has an aggregated storing MIME object with the "application/pidf+xml" content type and any of its extensions. The details of the signalling flows are as follows: + +1. **HTTP PUT request (XCAP client to XCAP server) – see example in table A.8.2-1** + +In order to store the content, the XCAP client generates an HTTP PUT request containing the MIME object in the body of the request. The request-URI points to the directory where the content is stored and shows the name of the file to be created. + +**Table A.8.4-1: HTTP PUT request (XCAP client to XCAP server)** + +``` +PUT http://operator.example.com/services/users/bill/pictureX HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:13:17 GMT +Content-Type: image/jpeg +Content-Length: (...) + +{pictureX.jpg} +``` + +2. **HTTP 201 (Created) response (XCAP server to XCAP client) – see example in table A.8.4-2** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to create a file the HTTP server sends an HTTP 201 (Created) response to the client. + +**Table A.8.4-2: HTTP 201 (Created) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 201 Created +Server: Apache/1.3.22 (Unix) mod_perl/1.27Content-Type: text/html +Date: Thu, 08 Jan 2004 10:50:35 GMT +Content-Length: 0 +``` + +3. **XCAP PUT request (XCAP client to XCAP server) - see example in table A.8.2-3** + +The XCAP client generates an XCAP PUT request in order to store XML encoded presence document which includes a URI reference to the MIME object stored on the XCAP server. The AUID part of the request URI is 'pidf-manipulation' as defined in RFC 4827 [34]. + +**Table A.8.4-3: XCAP PUT request (XCAP client to XCAP server)** + +``` +PUT http://xcap.example.com/services/pidf-manipulation/users/bill/pidf.xml HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:13:27 GMT +Content-Type: application/pidf+xml +Content-Length: (...) + + + + + + + open + + sip:bill@example.com + + + + + + http://operator.example.com/services/users/bill/pictureX.jpg + + + +``` + +**4. XCAP 201 (Created) response (XCAP server to XCAP client) - see example in table A.8.4-4** + +After the XCAP server has performed the necessary authorization checks, XML document validations and XML schema compliancy checks the XCAP server sends an XCAP 201 (Created) response to the XCAP client. + +**Table A.8.4-4: XCAP 201 (Created) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 201 Created +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "cccl" +Date: Thu, 08 Jan 2004 10:50:45 GMT +Content-Length: 0 +``` + +**5. HTTP GET request (XCAP client to XCAP server) – see example in table A.8.4-5** + +The XCAP client wishes to fetch the MIME object from the XCAP server. The client generates an HTTP GET request. The request URI points to the directory where the object is stored and indicates the name of the file to be fetched. + +**Table A.8.4-5: HTTP GET request (XCAP client to XCAP server)** + +``` +GET http://operator.example.com/services/users/bill/pictureX HTTP/1.1 +Host: oper.example.com:9999 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 10:43:17 GMT +Accept: image/jpeg +Content-Length: 0 +``` + +**6. HTTP 200 (OK) response (XCAP server to XCAP client) – see example in table A.8.4-6** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to fetch the file the XCAP server sends an HTTP 200 (OK) response having the object in the body to the XCAP client. + +**Table A.8.4-6: HTTP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 11:00:47 GMT +Content-Type: image/jpeg +Content-Length: (...) + +{pictureX} +``` + +**7. HTTP PUT request (XCAP client to XCAP server) – see example in table A.8.4-7** + +The XCAP client wishes to modify the earlier stored MIME object by replacing the picture X with a new picture X with new content. To modify the object the XCAP client generates an HTTP PUT request using the same request URI as has been used for the modified (old) object. The new object is conveyed in the body of the request. + +**Table A.8.4-7: HTTP PUT request (XCAP client to XCAP server)** + +``` +PUT http://operator.example.com/services/users/bill/pictureX HTTP/1.1 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 11:13:17 GMT +Content-Type: image/jpeg +Content-Length: (...) + +{pictureX.jpg} +``` + +8. **HTTP 200 (OK) response (XCAP server to XCAP client)** – see example in table A.8.4-8 + +After the XCAP server has performed the necessary authorization checks on the originator to ensure the XCAP client is allowed to replace the existing MIME object with the new one the XCAP server sends an HTTP 200 (OK) response to the XCAP client. + +**Table A.8.4-8: HTTP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 11:50:35 GMT +Content-Length: 0 +``` + +9. **XCAP PUT request (XCAP client to XCAP server)** – see example in table A.8.4-9 + +The XCAP client wishes to remove the MIME object from his presence information. The XCAP client generates an XCAP PUT request to modify the XML encoded presence document to remove the reference to the MIME object from the presence document. The request URI contains a node selector to the requested tuple according to RFC 4825 [33]. + +**Table A.8.4-9: XCAP PUT request (XCAP client to XCAP server)** + +``` +PUT http://xcap.example.com/services/pidf-manipulation/users/bill/pidf.xml/~/presence/person +HTTP/1.1 +Date: Thu, 08 Jan 2004 11:13:37 GMT +If-Match: "cc1" +Content-Type: application/xcap-el +Content-Length: (...) + + + + + + +``` + +10. **XCAP 200 (OK) response (XCAP server to XCAP client)** - see example in table A.8.4-10 + +After the XCAP server has performed the necessary authorization checks, XML document validations and XML Schema compliancy checks the XCAP server sends an XCAP 200 (OK) response to the XCAP client. + +**Table A.8.4-10: XCAP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Etag: "ccc2" +Date: Thu, 08 Jan 2004 11:50:59 GMT +Content-Length: 0 +``` + +11. **HTTP DELETE request (XCAP client to XCAP server)** – see example in table A.8.4-11 + +The XCAP client removes the MIME object from the XCAP server by generating an HTTP DELETE request. + +**Table A.8.4-11: HTTP DELETE request (XCAP client to XCAP server)** + +``` +DELETE http://operator.example.com/services/users/bill/pictureX HTTP/1.1 +Host: oper.example.com:9999 +User-Agent: IMS subscriber +Date: Thu, 08 Jan 2004 11:52:00 GMT +``` + +**12. HTTP 200 (OK) response (XCAP server to XCAP client) – see example in table A.8.4-12** + +After the XCAP server has performed the necessary authorization checks on the originator to ensure that the XCAP client is allowed to delete the object, the XCAP server sends an HTTP 200 (OK) response to the XCAP client. + +**Table A.8.4-12: HTTP 200 (OK) response (XCAP server to XCAP client)** + +``` +HTTP/1.1 200 OK +Server: Apache/1.3.22 (Unix) mod_perl/1.27 +Date: Thu, 08 Jan 2004 11:52:35 GMT +Content-Length: 0 +``` + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2003-06 | | | | | Version 0.0.1: Preliminary discussion with editor | | | +| 2003-06 | | | | | Version 0.0.2: Results of preliminary discussion with interested parties | | | +| 2003-08 | CN1#31 | N1-031176 | | | Version 0.0.3: Revised as a result of conference call and email discussion with interested parties | | | +| 2003-08 | CN1#31 | N1-031324 | | | Version 0.0.4: Revised as a result of offline discussions at CN1#31 | | | +| 2003-09 | CN1#31 | N1-031365 | | | Version 0.1.0: Revised to included allocated TS number and title as amended by MCC. | | | +| 2003-11 | CN1#32 | N1-03aaaa | | | Version 0.2.0: Revised to include agreements made in N1-031366. | | | +| 2004-05 | CN1#34 | NP-04xxxx | | | Version 0.3.0. Revised to include agreements made in N1-040765, N1-040794, N1-040795, N1-040866, N1-040939, N1-040945, N1-040946, N1-040997, N1-040998, N1-040999, N1-041002, N1-041006, N1-041008, N1-041092, N1-041093. | | | +| 2004-05 | CN1#34 | NP-040200 | | | Version 2.0.0 identical to version 0.3.0 for presentation for approval to plenary. | | | +| 2004-06 | CN#24 | NP-040200 | | | Approved by the plenary. | 2.0.0 | 6.0.0 | +| 2004-09 | CN#25 | NP-040426 | 3 | 2 | Editorial issues | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 4 | 1 | Watcher cleanup and alignment with PUA | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 5 | 3 | PUA clause restructuring | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040427 | 6 | 2 | GAA impacts | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 7 | 1 | XCAP roles | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 8 | 1 | XCAP Change | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 9 | | Policy Capability References | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 11 | | Filter criteria update | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 14 | 1 | Enhanced partial publication description | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 15 | 1 | Publication Rate Limiting | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 17 | 1 | Correction to processing PUBLISH with the "multipart/related" content type | 6.0.0 | 6.1.0 | +| 2004-09 | CN#25 | NP-040380 | 18 | | XML document corrections of message flows | 6.0.0 | 6.1.0 | +| 2004-12 | CN#26 | NP-040503 | 19 | 1 | Clarifications to Ut | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 20 | | Alignment between PUA and watcher for draft-ietf-geopriv-pidf-lo-01 | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040599 | 21 | 2 | Introduction of XCAP client and XCAP server | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 22 | 1 | Correction XCAP change flow | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 23 | | Delete Authentication Proxy Requirements | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 24 | 1 | Aligning Presence data model with IETF | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 25 | 1 | IETF reference update (SIP specific parts) | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 26 | 1 | IETF reference update (XCAP) | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 27 | 1 | Updates to Partial publication | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 28 | 1 | Correction to Watcher Information message flow | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 30 | 1 | Preventing loop in RLS subscriptions | 6.1.0 | 6.2.0 | +| 2004-12 | CN#26 | NP-040503 | 32 | | Filter criteria update | 6.1.0 | 6.2.0 | +| 2005-03 | CN#27 | NP-050073 | 34 | 1 | Resolution of references to 24.228 | 6.2.0 | 6.3.0 | + +| | | | | | | | | +|---------|-------|-----------|-----|---|-----------------------------------------------------------------------------------------------------------|-------|-------| +| | | | | | | | | +| 2005-03 | CN#27 | NP-050078 | 35 | | Authentication proxy for presence | 6.2.0 | | +| | | | | | | | 6.3.0 | +| 2005-03 | CN#27 | NP-050078 | 37 | | XCAP-change clarification | 6.2.0 | | +| | | | | | | | 6.3.0 | +| 2005-03 | CN#27 | NP-050078 | 38 | | XCAP-change correction | 6.2.0 | | +| | | | | | | | 6.3.0 | +| 2005-03 | CN#27 | NP-050078 | 39 | | IFC corrections | 6.2.0 | | +| | | | | | | | 6.3.0 | +| 2005-06 | CP#28 | CP-050063 | 41 | | SPI to SPT | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 43 | | Reference update: event-list | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 44 | | Reference update: filter | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 45 | | Reference update: xcap | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 46 | | Reference update: xcap-list-usage | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 47 | | Reference update: policy | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 48 | | Reference update: config-framework | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 40 | 1 | Editorial corrections | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-06 | CP#28 | CP-050063 | 42 | 1 | xcap-change substitution | 6.3.0 | | +| | | | | | | | 6.4.0 | +| 2005-09 | CP#29 | CP-050441 | 050 | 3 | Data model changes | 6.4.0 | | +| | | | | | | | 6.5.0 | +| 2005-09 | CP#29 | CP-050441 | 051 | 2 | XCAP changes | 6.4.0 | | +| | | | | | | | 6.5.0 | +| 2005-07 | CP-30 | | | | Version 7.0.0 created by MCC due to TISPAN references | 6.5.0 | | +| | | | | | | | 7.0.0 | +| 2006-03 | | | 053 | 2 | Clarifications to text on presence information | 7.0.0 | | +| | CP-31 | CP-060163 | | | | | 7.1.0 | +| 2006-03 | | | 054 | 1 | Miscellaneous Text Changes | 7.0.0 | | +| | CP-31 | CP-060109 | | | | | 7.1.0 | +| 2006-03 | | | 055 | 1 | Reference Change | 7.0.0 | | +| | CP-31 | CP-060109 | | | | | 7.1.0 | +| 2006-03 | | | 056 | 1 | Replace UA-Profile instead of SIP-profile | 7.0.0 | | +| | CP-31 | CP-060109 | | | | | 7.1.0 | +| 2006-09 | | | 063 | 1 | Removal of Editor's notes in 24.141 | 7.1.0 | | +| | CP-33 | CP-060456 | | | | | 7.2.0 | +| 2006-11 | | | 065 | - | draft-ietf-simple-event-list reference update | 7.2.0 | | +| | CP-34 | CP-060656 | | | | | 7.3.0 | +| 2006-11 | | | 067 | - | draft-ietf-sip-content-indirect-mech reference update | 7.2.0 | | +| | CP-34 | CP-060656 | | | | | 7.3.0 | +| 2006-11 | | | 069 | - | draft-ietf-geopriv-pidf-lo reference update | 7.2.0 | | +| | CP-34 | CP-060656 | | | | | 7.3.0 | +| 2006-11 | | | 071 | - | draft-ietf-simple-filter-funct and draft-ietf-simple-filter-format reference update | 7.2.0 | | +| | CP-34 | CP-060656 | | | | | 7.3.0 | +| 2006-11 | | | 073 | - | draft-ietf-simple-presence-data-model, draft-ietf-simple-rpid and draft-ietf-simple-cpid reference update | 7.2.0 | | +| | CP-34 | CP-060656 | | | | | 7.3.0 | +| 2006-11 | | | 075 | 1 | Resolution of editor's notes relating to draft-rosenberg-simple-presence-processing-model | 7.2.0 | | +| | CP-34 | CP-060656 | | | | | 7.3.0 | +| 2006-11 | | | 078 | 1 | User location query when UE watcher subscribes to presentity | 7.2.0 | | +| | CP-34 | CP-060670 | | | | | 7.3.0 | +| 2006-11 | | | 079 | 1 | User location query when watcher subscribes to resource list | 7.2.0 | | +| | CP-34 | CP-060670 | | | | | 7.3.0 | +| 2006-11 | | | 080 | 1 | User location query when resource list subscribes to presentity | 7.2.0 | | +| | CP-34 | CP-060670 | | | | | 7.3.0 | +| 2006-11 | | | 081 | 1 | User location query when network watcher subscribes to presentity | 7.2.0 | | +| | CP-34 | CP-060670 | | | | | 7.3.0 | +| 2007-09 | | | 086 | 1 | IETF reference updates | 7.3.0 | | +| | CP-37 | CP-070581 | | | | | 7.4.0 | +| 2008-03 | | | 088 | 3 | Network presence | 7.4.0 | | +| | CP-39 | CP-080140 | | | | | 8.0.0 | +| 2008-06 | | | 091 | | Revision of references to documents from IETF | 8.0.0 | | +| | CP-40 | CP-080348 | | | | | 8.1.0 | +| 2008-06 | CP-40 | | 087 | 7 | Security mechanisms for presence | 8.0.0 | 8.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------------------------------------|--------|--------| +| | | | | | | | | +| 2008-09 | CP-41 | CP-080539 | 094 | 1 | Removal of redundant references | 8.1.0 | | +| 2008-12 | CP-42 | CP-080861 | 099 | | IETF SIMPLE reference updates | 8.2.0 | 8.2.0 | +| 2009-12 | CP-46 | CP-090891 | 0102 | 1 | Change of ua-profile package to xcap-diff package | 8.3.0 | 8.3.0 | +| 2009-12 | CP-46 | | | | Upgrade to Rel-9 | 8.4.0 | 8.4.0 | +| 2010-06 | CP-48 | CP-100336 | 0106 | 4 | Remove reference to policy capability internet drafts | 9.0.0 | 9.0.0 | +| 2010-12 | CP-50 | CP-100722 | 0114 | | IETF reference updates | 9.1.0 | 9.1.0 | +| 2011-03 | CP-51 | | | | Upgrade to Rel-10 | 9.2.0 | 9.2.0 | +| 2012-09 | CP-57 | | | | Upgrade to Rel-11 | 10.0.0 | 10.0.0 | +| 2013-09 | CP-61 | CP-130513 | 0115 | 1 | Updating Presence to RFC 6665 | 11.0.0 | 11.0.0 | +| 2013-12 | CP-62 | CP-130770 | 0116 | 1 | Correction of some editorial errors | 12.0.0 | 12.0.0 | +| 2013-12 | CP-62 | CP-130770 | 0117 | 1 | Correcting RFC 6665 title | 12.0.0 | 12.1.0 | +| 2015-06 | CP-68 | CP-150328 | 0118 | | Aligning TLS profiles used by CT1 specifications with SA3 agreed TLS profile | 12.1.0 | 12.1.0 | +| | | | | | | | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA80 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24147/0f666d2ebbad7fab84c7c4fb531ea932_img.jpg b/marked/Rel-16/24_series/24147/0f666d2ebbad7fab84c7c4fb531ea932_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0126abbfd6f122348d8101b31af6695e50d448d8 --- /dev/null +++ b/marked/Rel-16/24_series/24147/0f666d2ebbad7fab84c7c4fb531ea932_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50aed8ac0b8aeae1d2312fba82794d551c397e11551c0683a20a298fcd32b0fd +size 58513 diff --git a/marked/Rel-16/24_series/24147/1cd38e4f2ffcae2871964fa6313a9a27_img.jpg b/marked/Rel-16/24_series/24147/1cd38e4f2ffcae2871964fa6313a9a27_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..62da1a8330f666285b4a86fbfbc3c2bb0f8fb6bd --- /dev/null +++ b/marked/Rel-16/24_series/24147/1cd38e4f2ffcae2871964fa6313a9a27_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26fcc2bfe9d86b38096d91a4c8655cb46fccdb533feb0e5d8ca3218aecd34bc0 +size 145607 diff --git a/marked/Rel-16/24_series/24147/1ec8205c17ab05d4670ab9d41b572ec7_img.jpg b/marked/Rel-16/24_series/24147/1ec8205c17ab05d4670ab9d41b572ec7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76a558c15bc4da03a7d857238b3ef402a4bdd683 --- /dev/null +++ b/marked/Rel-16/24_series/24147/1ec8205c17ab05d4670ab9d41b572ec7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44e72f2a4e20bd87332e03475fe31f437cfbacf9d2e328efbe196abeb44bc0bb +size 61788 diff --git a/marked/Rel-16/24_series/24147/36f5fcb5a6d05ddc81fc4bab4b3288ef_img.jpg b/marked/Rel-16/24_series/24147/36f5fcb5a6d05ddc81fc4bab4b3288ef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..430dd79dfc2f147289a14d93ce5338e57fdb6cfa --- /dev/null +++ b/marked/Rel-16/24_series/24147/36f5fcb5a6d05ddc81fc4bab4b3288ef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4773bff5a8cfe957e6dca878c531b6d29420a1156bbeffdef187e1096a933f36 +size 70067 diff --git a/marked/Rel-16/24_series/24147/4af57aad638888edf2062306f8a54a6c_img.jpg b/marked/Rel-16/24_series/24147/4af57aad638888edf2062306f8a54a6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d47ccfcdccefc69f63220a45cfff295dda4e2238 --- /dev/null +++ b/marked/Rel-16/24_series/24147/4af57aad638888edf2062306f8a54a6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c2b8f38dc6694c6138180dd50d797b39e5219913e710877cbe5477dcc85d3c0 +size 112855 diff --git a/marked/Rel-16/24_series/24147/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg b/marked/Rel-16/24_series/24147/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e7bcb9f96c76cac99f162bc16855db3af89cb67 --- /dev/null +++ b/marked/Rel-16/24_series/24147/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec7601cebfd401364cca3bf1493010f2e7a50dd3d021e067523f6edf3fa5cdf1 +size 103775 diff --git a/marked/Rel-16/24_series/24147/573293af67ee571aef04bf725fcefbe5_img.jpg b/marked/Rel-16/24_series/24147/573293af67ee571aef04bf725fcefbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcdcbb4bf9c032e54e0ffdd3c1c63c0980922164 --- /dev/null +++ b/marked/Rel-16/24_series/24147/573293af67ee571aef04bf725fcefbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e221dbc8d46d47b9d143da78b3cb25b17c2f9f78110b416fad31f8128311012a +size 47251 diff --git a/marked/Rel-16/24_series/24147/5801c19431e76330430e92a598cc7a16_img.jpg b/marked/Rel-16/24_series/24147/5801c19431e76330430e92a598cc7a16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e52b85fd106ad571e19156b515b5c0b21bfd05a1 --- /dev/null +++ b/marked/Rel-16/24_series/24147/5801c19431e76330430e92a598cc7a16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:818810284818c2fb80e9b675075e60bab8a00a82d844fb89947adb43fe8b9bd3 +size 114895 diff --git a/marked/Rel-16/24_series/24147/737abf1e655afd3324b6b3987945d913_img.jpg b/marked/Rel-16/24_series/24147/737abf1e655afd3324b6b3987945d913_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ef95257fb4779c05cc12dca48c7b9fd9ff240125 --- /dev/null +++ b/marked/Rel-16/24_series/24147/737abf1e655afd3324b6b3987945d913_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:88e7ace1b3dd6c7721f0677b372f2315c242846a80f94a9d07651c406c9fa28a +size 95036 diff --git a/marked/Rel-16/24_series/24147/8e14350b4b669119a3bdfca7869110ca_img.jpg b/marked/Rel-16/24_series/24147/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..226a1c263447c31ea7609d194bd87ce91f0456f7 --- /dev/null +++ b/marked/Rel-16/24_series/24147/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e4e01289494417fe3c1bc860f54c6b7cb1b2aa0006dd2f0caac6548fa6984fc +size 73132 diff --git a/marked/Rel-16/24_series/24147/901755bf86813427f3a32efa0363a27c_img.jpg b/marked/Rel-16/24_series/24147/901755bf86813427f3a32efa0363a27c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f10e92d6081a3031453375e40aabbb73e434295 --- /dev/null +++ b/marked/Rel-16/24_series/24147/901755bf86813427f3a32efa0363a27c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a57be47a83a5dfb1dfb4eff6870fb06274963bb8cee8801829ca356aba7daf7b +size 90373 diff --git a/marked/Rel-16/24_series/24147/b13465efdac63129aef9b6f1787d0d00_img.jpg b/marked/Rel-16/24_series/24147/b13465efdac63129aef9b6f1787d0d00_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ceed3cc92844d412cf1446a763bd923ac6f45a4 --- /dev/null +++ b/marked/Rel-16/24_series/24147/b13465efdac63129aef9b6f1787d0d00_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e10e52f2ac3c1db99390efac4302ee23532af3fdfc30aa99deeed98d08751f7 +size 45549 diff --git a/marked/Rel-16/24_series/24147/b96be3d7d73fc1d7af1879bb57de1cc4_img.jpg b/marked/Rel-16/24_series/24147/b96be3d7d73fc1d7af1879bb57de1cc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d08f03e2717020e13aea2e819d3f1c915b191cc --- /dev/null +++ b/marked/Rel-16/24_series/24147/b96be3d7d73fc1d7af1879bb57de1cc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b89c305082da4e6e04eeb5d8383cf5be381fc9f6b1954ea2d6a3082e9ea4e526 +size 58648 diff --git a/marked/Rel-16/24_series/24147/c0438093a10a593c42106b1e5dbb4331_img.jpg b/marked/Rel-16/24_series/24147/c0438093a10a593c42106b1e5dbb4331_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b3f0ff2738c0b6904e5619ffc4328503354cb614 --- /dev/null +++ b/marked/Rel-16/24_series/24147/c0438093a10a593c42106b1e5dbb4331_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:788cadb214e79f790014d2b9e2744706d8e23300fc9d6c31b8055812d9e00026 +size 59880 diff --git a/marked/Rel-16/24_series/24147/df72bd7468eb8bd59e911d0b5cb7a810_img.jpg b/marked/Rel-16/24_series/24147/df72bd7468eb8bd59e911d0b5cb7a810_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6a7ef583ec8388a8ff23ede407d8d49270921fa8 --- /dev/null +++ b/marked/Rel-16/24_series/24147/df72bd7468eb8bd59e911d0b5cb7a810_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ff1d629a68132b8041816f5a72fd0d00bcfcf20f9f1f7adda11b60b579de1b7 +size 127594 diff --git a/marked/Rel-16/24_series/24147/raw.md b/marked/Rel-16/24_series/24147/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e4ce64d145b6cdd21cad5b7d4f42a7d356de6f2b --- /dev/null +++ b/marked/Rel-16/24_series/24147/raw.md @@ -0,0 +1,10407 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations..... | 10 | +| 4 Conferencing overview..... | 10 | +| 5 Protocol using SIP and SIP events for conferencing..... | 12 | +| 5.1 Introduction..... | 12 | +| 5.2 Functional entities..... | 12 | +| 5.2.1 User Equipment (UE)..... | 12 | +| 5.2.2 Media Resource Function Controller (MRFC)..... | 12 | +| 5.2.3 Conferencing Application Server (AS)..... | 12 | +| 5.2.4 Media Gateway Control Function (MGCF)..... | 12 | +| 5.3 Role..... | 12 | +| 5.3.1 Conference Participant..... | 12 | +| 5.3.1.1 General..... | 12 | +| 5.3.1.2 Subscription for conference event package..... | 12 | +| 5.3.1.3 Conference creation..... | 13 | +| 5.3.1.3.1 General..... | 13 | +| 5.3.1.3.2 Conference creation with a conference factory URI..... | 13 | +| 5.3.1.3.3 Three-way session creation..... | 13 | +| 5.3.1.4 Joining a conference..... | 14 | +| 5.3.1.4.1 User joining a conference by using a conference URI..... | 14 | +| 5.3.1.4.2 User joining a conference after receipt of a REFER request..... | 14 | +| 5.3.1.5 Inviting other users to a conference..... | 14 | +| 5.3.1.5.1 General..... | 14 | +| 5.3.1.5.2 User invites other user to a conference by sending a REFER request to the other user..... | 15 | +| 5.3.1.5.3 User invites other user to a conference by sending a REFER request to the conference focus..... | 15 | +| 5.3.1.5.4 User invites other users to a conference by including URI list in initial INVITE request to the conference focus..... | 15 | +| 5.3.1.6 Leaving a conference..... | 16 | +| 5.3.1.6.1 Conference participant leaving a conference..... | 16 | +| 5.3.1.6.2 Conference focus removes conference participant from a conference..... | 16 | +| 5.3.1.6.3 Removing a conference participant from a conference..... | 16 | +| 5.3.1.7 Consent to list server distribution..... | 17 | +| 5.3.2 Conference Focus..... | 17 | +| 5.3.2.1 General..... | 17 | +| 5.3.2.2 Generic procedures for all conference related methods at the conference focus..... | 17 | +| 5.3.2.2.1 Conference focus originating case..... | 17 | +| 5.3.2.2.2 Conference focus terminating case..... | 17 | +| 5.3.2.3 Conference creation..... | 18 | +| 5.3.2.3.1 Conference creation with a conference factory URI..... | 18 | +| 5.3.2.3.2 Conference creation with a conference URI..... | 18 | +| 5.3.2.4 User joining a conference..... | 19 | +| 5.3.2.4.1 User joining a conference by using a conference URI..... | 19 | +| 5.3.2.5 Invitation of users to a conference..... | 19 | +| 5.3.2.5.1 General..... | 19 | +| 5.3.2.5.2 Request from a user to invite another user to a conference using a REFER request..... | 19 | +| 5.3.2.5.3 Request from a user to invite another user to a conference using an INVITE request for conference creation..... | 20 | +| 5.3.2.5.4 Inviting a user to a conference by sending an INVITE request..... | 20 | +| 5.3.2.5.5 Inviting a user to a conference by sending a REFER request..... | 21 | +| 5.3.2.6 Leaving a conference..... | 21 | +| 5.3.2.6.1 Conference participant leaving a conference..... | 21 | + +| | | | +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------| +| 5.3.2.6.2 | Removing a conference participant from a conference..... | 21 | +| 5.3.2.6.2.1 | General..... | 21 | +| 5.3.2.6.2.2 | Request from a conference participant to remove another conference participant from a conference..... | 22 | +| 5.3.2.6.2.3 | Conference focus removes conference participant from a conference..... | 22 | +| 5.3.2.7 | Conference termination..... | 22 | +| 5.3.3 | Conference Notification Service..... | 23 | +| 5.3.3.1 | General..... | 23 | +| 5.3.3.2 | Subscription to conference event package..... | 23 | +| 5.3.3.3 | Leaving a conference..... | 23 | +| 5.3.3.4 | Conference termination..... | 23 | +| 6 | Protocol using SDP for conferencing..... | 23 | +| 6.1 | Introduction..... | 23 | +| 6.2 | Functional entities..... | 24 | +| 6.2.1 | User Equipment (UE)..... | 24 | +| 6.2.2 | Media Resource Function Controller (MRFC)..... | 24 | +| 6.2.3 | Conferencing Application Server (Conferencing AS)..... | 24 | +| 6.2.4 | Media Gateway Control Function (MGCF)..... | 24 | +| 6.3 | Role..... | 24 | +| 6.3.1 | Conference Participant..... | 24 | +| 6.3.2 | Conference Focus..... | 24 | +| 7 | Void..... | 25 | +| 8 | Protocol for floor control for conferencing..... | 25 | +| 8.1 | Introduction..... | 25 | +| 8.2 | Functional entities..... | 25 | +| 8.2.1 | User Equipment (UE)..... | 25 | +| 8.2.2 | Media Resource Function Processor (MRFP)..... | 25 | +| 8.3 | Role..... | 25 | +| 8.3.1 | Floor participant..... | 25 | +| 8.3.2 | Floor chair..... | 26 | +| 8.3.3 | Floor control server..... | 26 | +| Annex A (informative): Example signalling flows of conferencing operation..... | | 27 | +| A.1 | Scope of signalling flows..... | 27 | +| A.2 | Introduction..... | 27 | +| A.2.1 | General..... | 27 | +| A.2.2 | Key required to interpret signalling flows..... | 27 | +| A.2.3 | Overview of signalling flows related to PSI routeing..... | 27 | +| A.3 | Flows demonstrating the creation of a conference..... | 29 | +| A.3.1 | Introduction..... | 29 | +| A.3.2 | User automatically creating a conference with a conference factory URI..... | 29 | +| A.3.2.1 | MRFC/AS is located in user's home network..... | 29 | +| A.3.2.2 | MRFC/AS is not located in user's home network..... | 47 | +| A.3.3 | User automatically creating a conference with a conference URI..... | 67 | +| A.3.4 | User creating a conference by manually dialling..... | 68 | +| A.3.5 | User creating a conference from two existing connections (Three-way session), users in different networks..... | 68 | +| A.3.6 | User automatically creating a conference with a conference factory URI and inviting some users to the newly-created conference..... | 68 | +| A.4 | Flows demonstrating a user joining a conference..... | 85 | +| A.4.1 | Introduction..... | 85 | +| A.4.2 | User calling into a conference..... | 86 | +| A.4.2.1 | MRFC/AS is not located in user's home network..... | 86 | +| A.4.2.1.1 | Conference URI resolved by the terminating home network..... | 86 | +| A.4.2.1.2 | Conference URI can be resolved by the originating home network..... | 111 | +| A.4.3 | User getting invited to a conference..... | 128 | +| A.4.3.1 | MRFC/AS is not located in user's home network..... | 128 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------------|------------| +| A.4.3.1.1 | Conference Participant referring another user to a conference..... | 128 | +| A.4.3.1.2 | User getting referred to a conference by a conference participant..... | 138 | +| A.4.3.1.3 | MRFC/AS invites a user to a conference..... | 147 | +| A.4.3.1.4 | MRFC/AS refers a user to a conference..... | 167 | +| A.4.4 | User requesting IMS to join another user..... | 178 | +| A.4.4.1 | MRFC/AS is located in user's home network..... | 178 | +| A.4.5 | User joins a private conversation to a conference..... | 186 | +| A.4.5.1 | User in a different network..... | 186 | +| A.5 | Flows demonstrating a user subscribing to the conference event package..... | 186 | +| A.5.1 | Introduction..... | 186 | +| A.5.2 | User subscribing to the conference event package..... | 187 | +| A.5.2.1 | MRFC/AS is not located in user's home network..... | 187 | +| A.6 | Flows demonstrating a user leaving a conference..... | 193 | +| A.6.1 | Introduction..... | 193 | +| A.6.2 | User leaving the conference..... | 193 | +| A.6.2.1 | MRFC/AS is located in user's home network..... | 193 | +| A.6.3 | User requesting to remove another user from conference..... | 199 | +| A.6.4 | MRFC/AS drops a user from a conference..... | 199 | +| A.6.4.1 | MRFC/AS is located in user's home network..... | 199 | +| A.7 | Flows demonstrating conference termination..... | 202 | +| A.7.1 | General..... | 202 | +| A.8 | Flows demonstrating usage of hold and resume during conferences..... | 202 | +| A.9 | Flows demonstrating the use of the Replaces header..... | 203 | +| A.9.1 | POTS subscriber invited to a conference..... | 203 | +| Annex B (normative): | SDP a=content attribute "g.3gpp.conf" value..... | 208 | +| B.1 | Introduction..... | 208 | +| B.2 | New value..... | 208 | +| Annex C (informative): | Change history..... | 209 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document provides the protocol details for conferencing within the IP Multimedia Core Network subsystem (IMS) based on the Session Initiation Protocol (SIP), SIP Events, the Session Description Protocol (SDP) and the Binary Floor Control Protocol (BFCP). + +The functionalities for conference policy control (with respective standardised protocols) are felt to be essential for a complete IMS conferencing service but are not specified in this version of IMS conferencing and are for further study. + +The present document does not cover the signalling between a MRFC and a MRFP. + +Where possible, the present document specifies the requirements for this protocol by reference to specifications produced by the IETF within the scope of SIP, SIP Events, SDP and BFCP, either directly, or as modified by 3GPP TS 24.229. Where this is not possible, extensions to SIP are defined within the present document. The document has therefore been structured in order to allow both forms of specification. + +The present document is applicable to Application Servers (ASs), Multimedia Resource Function Controllers (MRFCs), Multimedia Resource Function Processors (MRFP), Media Gateway Control Functions (MGCFs) and to User Equipment (UE) providing conferencing capabilities. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.228: "Service requirements for the Internet Protocol (IP) multimedia core network subsystem; Stage 1". +- [3] 3GPP TS 23.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". +- [4] 3GPP TS 24.228 Release 5: "Signalling flows for the IP multimedia call control based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [5] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [7] IETF RFC 3261 (June 2002): "SIP: Session Initiation Protocol". +- [8] IETF RFC 4353 (February 2006): "A Framework for Conferencing with the Session Initiation Protocol (SIP)". +- [9] IETF RFC 4579 ( August 2006): "Session Initiation Protocol Call Control - Conferencing for User Agents". +- [10] IETF RFC 6665 (July 2012): "SIP-Specific Event Notification". +- [11] IETF RFC 4575 (August 2006): "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [12] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and message contents". + +- [13] Void. +- [14] Void. +- [15] 3GPP TS 29.208: "End to end Quality of Service (QoS) signalling flows". +- [16] IETF RFC 2833 (May 2000): "RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals". +- [17] IETF RFC 3515 (April 2003): "The Session Initiation Protocol (SIP) Refer Method". +- [18] Void. +- [19] IETF RFC 3840 (August 2004): "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [20] IETF RFC 3892 (September 2004): "The Session Initiation Protocol (SIP) Referred-By Mechanism". +- [21] Void. +- [22] Void. +- [23] Void. +- [24] Void. +- [25] Void. +- [26] Void. +- [27] Void. +- [28] IETF RFC 4582 (November 2006): "The Binary Floor Control Protocol (BFCP)". +- [29] Void. +- [30] Void. +- [31] Void. +- [32] Void. +- [33] IETF RFC 3891 (September 2004): "The Session Initiation Protocol (SIP) "Replaces" Header". +- [34] IETF RFC 5366 (October 2008): "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". +- [35] IETF RFC 4583 (November 2006): "Session Description Protocol (SDP) Format for Binary Floor Control Protocol (BFCP) Streams". +- [36] IETF RFC 5360 (October 2008): "A Framework for Consent-Based Communications in the Session Initiation Protocol (SIP)". +- [37] IETF RFC 7989 (October 2016): "End-to-End Session Identification in IP-Based Multimedia Communication Networks". +- [38] 3GPP TS 24.166: "3GPP IMS Conferencing Management Object (MO)". +- [39] IETF RFC 7647 (September 2015): "Clarifications for the use of REFER with RFC6665". +- [40] IETF RFC 4796 (February 2007): "The Session Description Protocol (SDP) Content Attribute". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 21.905 [1], and the following apply: + +**Conferencing AS:** an Application Server that supports functionality specific to a SIP conference focus + +**Ad-hoc conference:** An unscheduled conference that is created on-the-fly by a conference participant. + +The following terms and definitions given in 3GPP TS 23.228 [2] apply (unless otherwise specified): + +**Public Service Identity** + +**Three-way session** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.228 [6] subclauses 4.3.3.1 and 4.6 apply: + +**IP-Connectivity Access Network (IP-CAN)** + +The following terms and definitions given in RFC 4353 [8] apply (unless otherwise specified): + +**Conference** + +**Conference-Aware Participant** + +**Conference notification service** + +**Conference Policy** + +**Conference-Unaware Participant** + +**Conference URI** + +**Focus** + +**Mixer** + +**Participant** + +**Tightly Coupled Conference** + +The following terms and definitions given in RFC 4579 [9] apply (unless otherwise specified): + +**Conference Factory URI** + +For the purposes of the present document, the following terms and definitions given in RFC 3840 [19] apply: + +**Feature parameter** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.002 [2] subclauses 4.1.1.1 and 4a.7 apply: + +**Call Session Control Function (CSCF)** + +**Home Subscriber Server (HSS)** + +**Media Gateway Control Function (MGCF)** + +**Multimedia Resource Function Controller (MRFC)** + +**Multimedia Resource Function Processor (MRFP)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.218 [5] subclause 3.1 apply: + +**Filter criteria** + +**Initial filter criteria** + +**Initial request** + +**Subsequent request** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.228 [7] subclauses 4.3.3.1 and 4.6 apply: + +**Interrogating-CSCF (I-CSCF)** + +**Proxy-CSCF (P-CSCF)** + +### **Public user identity** **Serving-CSCF (S-CSCF)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TR 21.905 [1] apply: + +### **User Equipment (UE)** + +For the purposes of the present document, the following terms and definitions given in RFC 4582 [28] apply: + +### **Floor** **Floor chair** **Floor control server** **Floor participant** + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|-----------------------------------------| +| AMR | Adaptive Multi-Rate | +| AS | Application Server | +| BFCP | Binary Floor Control Protocol | +| CN | Core Network | +| CSCF | Call Session Control Function | +| FQDN | Fully Qualified Domain Name | +| HSS | Home Subscriber Server | +| I-CSCF | Interrogating CSCF | +| IM | IP Multimedia | +| IMS | IP Multimedia CN subsystem | +| IP | Internet Protocol | +| IP-CAN | IP-Connectivity Access Network | +| MGCF | Media Gateway Control Function | +| MRFC | Multimedia Resource Function Controller | +| MRFP | Multimedia Resource Function Processor | +| P-CSCF | Proxy CSCF | +| PSI | Public Service Identity | +| S-CSCF | Serving CSCF | +| SDP | Session Description Protocol | +| SIP | Session Initiation Protocol | +| TLS | Transport Layer Security | +| UE | User Equipment | +| VBC | Volume Based Charging | + +# --- 4 Conferencing overview + +The basic services for the IP Multimedia core network Subsystem (IMS), as defined in 3GPP TS 24.229 [5], allow a user to initiate, modify and terminate media sessions based on the Session Initiation Protocol, as defined in RFC 3261 [7]. Although these basic mechanisms already allow multi party calls, more sophisticated services for communication between multiple parties can be made available by the network. + +The conferencing service provides the means for a user to create, manage, terminate, join and leave conferences. It also provides the network with the ability to give information about these conferences to the involved parties. + +The network operator or the user may apply membership and media policies to a conference. The functionality for conference policy control (with a respective standardised protocol) is felt to be essential for a complete IMS conferencing service but is not specified in this version of IMS conferencing and is for further study. + +Conferencing applies to any kind of media stream by which users may want to communicate, this includes e.g. audio and video media streams as well as instant message based conferences or gaming. Floor control, as part of the conferencing service offers control of shared conference resources at the MRFP using BFCP. + +The framework for SIP conferences is specified in RFC 4353 [8]. + +The architecture for the 3GPP conference service is specified in 3GPP TS 23.228 [6] and 3GPP TS 23.218 [3]. + +The present document specifies the usage of SIP, SDP and BFCP to realize 3GPP conference service based on the protocols specified by the IETF defined conference service as per RFCs listed in clause 2. However, since the IETF conference service has various scenarios and features as described in RFC 4353 [8], 3GPP conference service is a subset of the above IETF defined conference service. + +Loosely coupled conferencing is outside the scope of this release of the IMS conferencing service. + +The following figure depicts the functional split for SIP based conferences between the AS, the MRFC and the MRFP. + +![Figure 4.1: Functional split between the AS, MRFC and MRFP. The diagram shows three main functional blocks: AS (Application Server), MRFC (Media Resource Function Controller), and MRFP (Media Resource Function Processor). The AS contains Media Conference Policy Server, Conference Policy Server, Conference Notification Server, Conference Policy, and Top-level Conference Focus. The MRFC contains Media Conference Policy and Low-level Conference Focus. The MRFP contains Mixer and Floor Control Server. Interfaces are labeled Cr, Mp, ISC, Mr, RTP/RTCP, and BFCP. An S-CSCF is shown interacting with the AS and MRFC via ISC and Mr interfaces.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` + +graph TD + subgraph AS [AS] + direction TB + MCPPS[Media Conference Policy Server] -.-> CPS[Conference Policy Server] + CPS --> CP[Conference Policy] + CP --> TCF[Top-level Conference Focus] + CNS[Conference Notification Server] + end + subgraph MRFC [MRFC] + direction TB + MCP[Media Conference Policy] --> LCF[Low-level Conference Focus] + end + subgraph MRFP [MRFP] + direction TB + Mixer[Mixer] + FCS[Floor Control Server] + end + S-CSCF[S-CSCF] + AS -- Cr --> MRFC + MRFC -- Mp --> MRFP + AS -- ISC --> S-CSCF + S-CSCF -- Mr --> AS + S-CSCF -- Mr --> MRFC + MRFC -.-> CNS + Mixer -- RTP/RTCP --> RTP[ ] + FCS -- BFCP --> BFCP[ ] + style RTP fill:none,stroke:none + style BFCP fill:none,stroke:none + +``` + +Figure 4.1: Functional split between the AS, MRFC and MRFP. The diagram shows three main functional blocks: AS (Application Server), MRFC (Media Resource Function Controller), and MRFP (Media Resource Function Processor). The AS contains Media Conference Policy Server, Conference Policy Server, Conference Notification Server, Conference Policy, and Top-level Conference Focus. The MRFC contains Media Conference Policy and Low-level Conference Focus. The MRFP contains Mixer and Floor Control Server. Interfaces are labeled Cr, Mp, ISC, Mr, RTP/RTCP, and BFCP. An S-CSCF is shown interacting with the AS and MRFC via ISC and Mr interfaces. + +**Figure 4.1: Functional split between the AS, MRFC and MRFP** + +The conference policy, conference notification server and top-level focus as specified in RFC 4353 [8] subclause 6 are located in the AS. + +The MRFC has a conference policy and focus as specified in RFC 4353 [8] subclause 6.3. + +The mixer and floor control server are located in the MRFP. + +# 5 Protocol using SIP and SIP events for conferencing + +## 5.1 Introduction + +Void + +## 5.2 Functional entities + +### 5.2.1 User Equipment (UE) + +For the purpose of SIP based conferences, the UE shall implement the role of a Conference participant as described in subclause 5.3.1. + +### 5.2.2 Media Resource Function Controller (MRFC) + +For the purpose of SIP based conferences, the MRFC shall support the procedures for ad-hoc conferencing as described in subclause 5.8 of 3GPP TS 24.229 [5] and the procedures for media control of ad-hoc conferencing described in subclause 10.3 of 3GPP TS 24.229 [5] + +For the purpose of SIP based conferences, the MRFC shall regard the MRFP as a mixer, as described in RFC 4353 [8]. + +### 5.2.3 Conferencing Application Server (AS) + +For the purpose of SIP based conferences, the conferencing AS shall implement the role of a conference focus, as described in subclause 5.3.2 and as a conference notification service, as described in subclause 5.3.3. The conferencing AS may implement the role of a conference participant as described in subclause 5.3.1. + +The conferencing AS shall use the procedures for 3rd party call control as described in subclause 5.7.5 of 3GPP TS 24.229 [5] and the procedures for media control in subclause 10.2 of 3GPP TS 24.229 [5] to implement SIP based conferences. + +### 5.2.4 Media Gateway Control Function (MGCF) + +For the purpose of SIP based conferences, the MGCF shall implement the role of Conference participant as described in subclauses 5.3.1.3.2, 5.3.1.4.1, 5.3.1.5.4, 5.3.1.6.1 and 5.3.1.6.2. In addition, MGCF shall implement the functions except the "REFER" function in subclause 5.3.1.3.3. + +## 5.3 Role + +### 5.3.1 Conference Participant + +#### 5.3.1.1 General + +In addition to the procedures specified in subclause 5.3.1, the conference participant shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the conference participant is implemented. + +#### 5.3.1.2 Subscription for conference event package + +The conference participant may subscribe to the conference event package, as described in RFC 4575 [11]. If the SUBSCRIBE request outside the existing INVITE dialog is rejected by a 403 (Forbidden) response, the conference participant should send a SUBSCRIBE request in the existing INVITE dialog. + +If SUBSCRIBE request in the existing INVITE dialog fails, the UE should continue the conference call without conference event subscription. + +NOTE: Pre-release 12 networks can support in-dialog SUBSCRIBE requests only. Sending a SUBSCRIBE in the existing dialog enables the UE to subscribe to the conference event package in this situation. + +#### 5.3.1.3 Conference creation + +##### 5.3.1.3.1 General + +A conference can be created by means of SIP, as described in subclause 5.3.1.3.2 or subclause 5.3.1.3.3. + +NOTE: Additionally, creation of a conference can be provided by other means. + +The conference participant shall make use of the procedures for session establishment as described in subclauses 5.1.2A and 5.1.3 of 3GPP TS 24.229 [5] when creating conferences by means of SIP. + +##### 5.3.1.3.2 Conference creation with a conference factory URI + +Upon a request to create a conference with a conference factory URI, the conference participant shall: + +- 1) generate an initial INVITE request in accordance with subclause 5.1.3.1 of 3GPP TS 24.229 [5]; and +- 2) set the request URI of the INVITE request to the conference factory URI. + +On receiving a 200 (OK) response to the INVITE request with the "isfocus" feature parameter indicated in Contact header, the conference participant shall store the content of the received Contact header as the conference URI. In addition to this, the conference participant may subscribe to the conference event package as described in RFC 4575 [11] by using the stored conference URI. + +NOTE 1: A conference participant can decide not to subscribe to the conference event package for conferences with a large number of attendees, due to, e.g. the signalling traffic caused by the notifications about users joining or leaving the conference. + +NOTE 2: A conference can also be created with a conference URI. The procedures for this case at the conference participant are identical to those for joining a conference, as described in subclause 5.3.1.4.1. It is not assumed that the conference participant is aware that the conference gets created in this case. + +NOTE 3: The UE can discover the conference factory URI from the Management Object as defined in 3GPP TS 24.166 [38]. Further discovery mechanisms for the conference factory URI are outside the scope of the present document. + +##### 5.3.1.3.3 Three-way session creation + +When a user is participating in two or more SIP sessions and wants to join together two of these active sessions to a so-called three-way session, the user shall perform the following steps. + +- 1) create a conference at the conference focus by sending an INVITE request with the conference factory URI for the three-way session towards the conference focus, as described in subclause 5.3.1.3.2; +- 2) decide and perform for each of the active sessions that are requested to be joined to the three-way session, how the remote user shall be invited to the three-way session, which can either be: + - a) by performing the procedures for inviting a user to a conference by sending a REFER request to the user, as described in subclause 5.3.1.5.2; or + - b) by performing the procedures for inviting a user to a conference by sending a REFER request to the conference focus, as described in subclause 5.3.1.5.3; +- 3) release the active session with the user, by applying the procedures for session release in accordance with RFC 3261 [7], provided that a BYE request has not already been received, after a NOTIFY request has been received, indicating that the user has successfully joined the three-way session, i.e. including: + - a) a body of content-type "message/sipfrag" that indicates a "200 OK" response; and, + - b) a Subscription-State header set to the value "terminated"; and, +- 4) treat the created three-way session as a normal conference, i.e. the conference participant shall apply the applicable procedures of subclause 5.3.1 for it. + +#### 5.3.1.4 Joining a conference + +##### 5.3.1.4.1 User joining a conference by using a conference URI + +Upon generating an initial INVITE request to join a conference for which the conference URI is known to the conference participant, the conference participant shall: + +- 1) set the request URI of the INVITE request to the conference URI; and +- 2) send the INVITE request towards the conferencing AS that is hosting the conference. + +NOTE 1: The initial INVITE request is generated in accordance with 3GPP TS 24.229 [5]. + +NOTE 2: The conference participants can get the conference URI as described in subclause 5.3.1.4.2. Other mechanisms can also be used by the conference participant to become aware of the conference URI, but they are out of scope of this specification.. + +In addition, the conference participant may subscribe to the conference event package as described in RFC 4575 [11] by using the known conference URI. + +NOTE 3: A conference participant can decide not to subscribe to the conference event package for conferences with a large number of attendees, due to the signalling traffic caused by the notifications about e.g. users joining or leaving the conference. + +Upon receipt of an INVITE request that includes a Replaces header, the conference participant shall apply the procedures described in RFC 3891 [33] to the INVITE request. + +##### 5.3.1.4.2 User joining a conference after receipt of a REFER request + +Upon receipt of a REFER request that either includes a Refer-To header which includes the "method" uri parameter set to INVITE or does not include the "method" URI parameter, the conference participant shall: + +- 1) handle the REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10]; +- 2) perform the actions as described in subclause 5.3.1.4.1 for a user joining a conference; and +- 3) if the received REFER request included a Referred-By header, include the Referred-By header in accordance with RFC 3892 [20] in the INVITE request that is sent for joining the conference. + +#### 5.3.1.5 Inviting other users to a conference + +##### 5.3.1.5.1 General + +Upon inviting other users to a conference, the conference participant has to decide which of the following procedures has to be applied: + +- 1) inviting an user to a conference by sending a REFER request to the user directly, as described in subclause 5.3.1.5.2; or +- 2) inviting a user to a conference by sending a REFER request to the conference focus, as described in subclause 5.3.1.5.3; or +- 3) inviting one or more users to a conference by adding these users' SIP URIs to the INVITE request that is sent to the Conference focus to create the conference (see subclause 5.3.1.3.2) as described in subclause 5.3.1.5.4. + +NOTE: Additionally, users can be invited to a conference by other means. + +It is out of the scope of the present document, how the UE decides which of the above procedures shall be applied. + +##### 5.3.1.5.2 User invites other user to a conference by sending a REFER request to the other user + +Upon generating a REFER request in accordance with the procedures specified in 3GPP TS 24.229 [5], IETF RFC 3515 [17] as updated by IETF RFC 6665 [10] and IETF RFC 7647 [39] that is destined to a user in order to invite that user to a specific conference, the conference participant shall: + +- 1) set the request URI of the REFER request to the address of the user who is invited to the conference; +- 2) set the Refer-To header of the REFER request to the conference URI of the conference that the other user shall be invited to, including the "method" URI parameter set to "INVITE" or omit the "method" parameter; and + +NOTE: Other headers of the REFER request will be set in accordance with 3GPP TS 24.229 [5]. + +- 3) send the REFER request towards the user who is invited to the conference. + +The UE may additionally include the Referred-By header to the REFER request and set it to the URI of the conference participant that is sending the REFER request. + +Afterwards the UE shall treat incoming NOTIFY requests that are related to the previously sent REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10] and may indicate the received information to the user. + +##### 5.3.1.5.3 User invites other user to a conference by sending a REFER request to the conference focus + +Upon generating a REFER request in accordance with the procedures specified in 3GPP TS 24.229 [5], IETF RFC 3515 [17] as updated by IETF RFC 6665 [10] and IETF RFC 7647 [39] that is destined to the conference focus in order to invite another user to a specific conference, the conference participant shall: + +- 1) set the request URI of the REFER request to the conference URI to which the user is invited to; +- 2) set the Refer-To header of the REFER request to the SIP URI or tel URL of the user who is invited to the conference; +- 3) either include the "method" URI parameter with the value "INVITE" or omit the "method" URI parameter in the Refer-To header; and + +NOTE: Other headers of the REFER request will be set in accordance with 3GPP TS 24.229 [5]. + +- 4) send the REFER request towards the conference focus that is hosting the conference. + +The UE may additionally include the Referred-By header to the REFER request and set it to the URI of the conference participant that is sending the REFER request. + +In case of an active session the UE may additionally include the Replaces header in the header portion of the SIP URI of the Refer-to header field of the REFER request. If the user involved in the active session is identified by a tel URI, the UE shall convert the tel URI to an SIP URI as described in RFC 3261 [7] before including the Replaces header field. The included Replaces header field shall refer to the active dialog that is replaced by the ad-hoc conference. The Replaces header field shall comply with RFC 3891 [33]. + +Afterwards the UE shall treat incoming NOTIFY requests that are related to the previously sent REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10] and may indicate the received information to the user. + +##### 5.3.1.5.4 User invites other users to a conference by including URI list in initial INVITE request to the conference focus + +Upon generating an INVITE request that is destined to the conference focus in order to create a conference using a conference factory URI (see subclause 5.3.1.3.2) the UE may attach a message body to the request that includes a URI list as described in RFC 5366 [34]. In order to do this the UE shall follow the procedures in subclause 5.3.1.3.2 for creation of the INVITE request and, in addition, the conference initiator shall build a list of URIs in accordance with RFC 5366 [34] including the SIP URIs of all the users that are to be invited to the conference. + +In case of an ad-hoc conference where the conference creator is already involved in a dialog with a user who shall be invited to the conference, the UE may add information of this dialog ID (Call-ID header field, From header field, To header field, and if available a Session-ID header field as described in RFC 7989 [37]) to the URIs in the URI list, according to the procedures for adding header fields ("?" mechanism) described in subclause 19.1.1 of RFC 3261 [7]. + +Once the INVITE request has been sent, the conference participant shall behave as described in subclause 5.3.1.3.2 once the 200 (OK) response to the INVITE is received. + +#### 5.3.1.6 Leaving a conference + +##### 5.3.1.6.1 Conference participant leaving a conference + +When leaving a conference, the conference participant shall: + +- 1) generate a BYE request on the dialog that was established when joining or creating the conference, in accordance to the procedures described in 3GPP TS 24.229 [5] and RFC 3261 [7]; +- 2) if the conference participant is subscribed to the conference state event information of that conference, the conference participant shall not renew this subscription and let the related subscription timer expire. When a related NOTIFY request is received which does not include a Subscription-State header set to the value "terminated", the conference participant shall: + +- a) wait for an implementation dependant time, if a related NOTIFY request with the Subscription-State header set to the value "terminated" is received; and +- b) afterwards, if no such NOTIFY request is received, unsubscribe from the conference state event information by performing the procedures as described in RFC 6665 [10] and RFC 4575 [11]. + +NOTE 1: A conference participant leaving a conference will cause the conference notification service to send a NOTIFY request with updated conference state information to all conference participants, including the participant who just left. Therefore the time between sending the BYE request and receiving the next NOTIFY request is very short. The conference participant does not immediately unsubscribe from the conference event package in order not to cause unnecessary traffic on the air interface. + +NOTE 2: After the conference participant leaves the conference, it can receive NOTIFY requests that cross the BYE request sent by the conference participant. In this case, the NOTIFY request will not include a Subscription-State header with the value "terminated", as it was issued before the conference focus / conference notification service got aware of the conference participant leaving the conference. Due to this another NOTIFY request may be received within a short period of time (see NOTE 1), that carries the Subscription-State header set to "terminated". + +##### 5.3.1.6.2 Conference focus removes conference participant from a conference + +Upon receipt of a BYE request on the dialog that was established when joining or creating a conference, the conference participant shall: + +- 1) respond to the BYE request as described in 3GPP TS 24.229 [5] and RFC 3261 [7]; and +- 2) if the conference participant is subscribed to the conference state event information of that conference, perform the actions for not renewing the subscription to the conference state event information as described for the conference participant leaving a conference in subclause 5.3.1.6.1. + +##### 5.3.1.6.3 Removing a conference participant from a conference + +Upon generating a REFER request in accordance with the procedures specified in 3GPP TS 24.229 [5], IETF RFC 3515 [17] as updated by IETF RFC 6665 [10] and IETF RFC 7647 [39] to remove a conference participant from a conference, the removing conference participant shall: + +- 1) set the request URI of the REFER request to the conference URI of the conference from which the conference participant shall be removed +- 2) set the Refer-To header of the REFER request: + - a) to the address of the conference participant who should be removed from the conference, including the "method" parameter set to "BYE", if a single conference participant should be removed from the conference. If the address of conference participant is a global tel URI, it shall be converted to SIP URI as described in RFC 3261 [7]; or + - b) to the conference URI and the "method" parameter to "BYE", if all conference participants shall be removed from the conference. + +NOTE 1: Other headers of the REFER request will be set in accordance with 3GPP TS 24.229 [5]. + +NOTE 2: The removal of all conference participants from the conference will terminate the conference if the conference policy is set accordingly. + +- 3) send the REFER request towards the conference focus that is hosting the conference. + +Afterwards the removing conference participant shall treat incoming NOTIFY requests that are related to the previously sent REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10] and may indicate the received information to the user. + +NOTE: Additionally, a conference participant can be removed from a conference by other means. + +#### 5.3.1.7 Consent to list server distribution + +A participant capable of receiving a request to join a conference should support the requirements of a recipient defined in RFC 5360 [36]. + +### 5.3.2 Conference Focus + +#### 5.3.2.1 General + +In addition to the procedures specified in subclause 5.3.2, the conference focus shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the conference focus is implemented. When performing 3rd party call control the conference focus shall follow the procedures of subclause 5.7.5 of 3GPP TS 24.229 [5]. + +#### 5.3.2.2 Generic procedures for all conference related methods at the conference focus + +##### 5.3.2.2.1 Conference focus originating case + +The conference focus shall follow the procedures of 3GPP TS 24.229 [5] subclause 5.7.3 when acting as an originating UA. + +##### 5.3.2.2.2 Conference focus terminating case + +Upon receipt of a conference related initial request, the conference focus shall follow the procedures of 3GPP TS 24.229 [5] subclause 5.7.1.2 in relation to the contents of the P-Charging-Function-Addresses header and the P-Charging-Vector header. + +When creating the first response for this initial request, the conference focus shall: + +- 1) include the P-Charging-Vector header including: + - a) the value of the icid parameter as received in the initial request; + - b) the value of the orig-ioi parameter as received in the initial request; and + - c) the term-ioi parameter, indicating the network of the conference focus; and +- 2) include the P-Charging-Function-Addresses header as received in the initial request or, if the P-Charging-Function-Addresses header was not received in the initial request, indicate the values applicable for the conference in the P-Charging-Function-Addresses header. + +When creating responses for an initial INVITE request, the conference focus shall additionally send the 200 (OK) response to the initial INVITE request only after the resource reservation has been completed. + +#### 5.3.2.3 Conference creation + +##### 5.3.2.3.1 Conference creation with a conference factory URI + +Upon receipt of an INVITE request that includes a conference factory URI in the request URI, the conference focus shall: + +- 1) check if the conference factory URI is allocated and reject the request in accordance with RFC 3261 [7] if it is not allocated. The following actions in this subclause shall only be performed if the conference factory URI is allocated; + +NOTE: The mechanism by which the conference focus gets aware whether a URI is a conference factory URI is out of the scope of the present document. One possibility would be that an operator uses a specific user part (e.g. conference-factory@home1.net) or host part (e.g. conference-factory.home1.net) for identification of conference factory URIs. + +- 2) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; + +- 3) allocate a conference URI and if needed a temporary conference URI; and +- 4) if "preconditions" were indicated as required in the INVITE request are not satisfied, generate a first provisional response to the INVITE request, indicating the temporary conference URI in the Contact header if allocated, else the conference URI. + +At the same time, resources will also be requested from the mixer. + +If the conference focus generates any 1xx or 2xx response to the INVITE request, the conference focus shall include the "isfocus" feature parameter in accordance with the procedures of RFC 3840 [19]. + +Upon receipt of an indication from the mixer that conference resources have been through-connected, the conference focus shall generate a 200 (OK) response to the INVITE request, indicating the "isfocus" feature parameter as a parameter to the conference URI in the Contact header. + +##### 5.3.2.3.2 Conference creation with a conference URI + +Upon receipt of an INVITE request that includes a conference URI in the request URI and the conference has not been created yet, the conference focus shall: + +- 1) check if the conference URI is allocated reject the request in accordance with RFC 3261 [7] if it is not allocated. The following actions in this subclause shall only be performed if the conference URI is allocated; +- 2) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; and +- 3) if a contact header is included in the response, set the contact header to the conference URI. At the same time, resources will also be requested from the mixer. + +If the conference focus generates any 1xx or 2xx response to the INVITE request, the conference focus shall include the "isfocus" feature parameter in accordance with the procedures of RFC 3840 [19]. + +Upon receipt of an indication from the conference mixer that conference resources have been through-connected, the conference focus shall generate a 200 (OK) response to the INVITE request, indicating the conference URI in the Contact header. + +#### 5.3.2.4 User joining a conference + +##### 5.3.2.4.1 User joining a conference by using a conference URI + +Upon receipt of an INVITE request that includes a conference URI in the request URI, the conference focus shall: + +- 1) check if the conference URI is allocated. If the conference URI is not allocated, the conference focus shall reject the request in accordance with RFC 3261 [7]. The following actions in this subclause shall only be performed if the conference URI is allocated; +- 2) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; and +- 3) if a contact header is included in the response, set the contact header to the conference URI. + +At the same time, resources will also be requested from the mixer. + +If the conference focus generates any 1xx or 2xx response to the INVITE request, the conference focus shall include the "isfocus" feature parameter in accordance with the procedures of RFC 3840 [19]. + +Upon receipt of an indication from the mixer that conference resources have been through-connected, the conference focus shall generate a 200 (OK) response to the INVITE request, indicating the conference URI in the Contact header. + +#### 5.3.2.5 Invitation of users to a conference + +##### 5.3.2.5.1 General + +The conference focus can invite users to a conference by sending an INVITE request to the user, as described in subclause 5.3.2.5.4. This procedure will be triggered at the conference focus either by a REFER request received from authorized users, that request the conference focus to invite other users to the conference, as described in subclause 5.3.2.5.2, or by the initial INVITE request that creates the conference when it includes a "recipient-list" message body as described in subclause 5.3.2.5.3. + +NOTE: Additionally, invitation of users to a conference can be triggered by other means. + +Additionally, the conference focus can invite users to a conference by sending a REFER request to the user, as described in subclause 5.3.2.5.5. How these procedures are triggered is outside the scope of this specification. + +##### 5.3.2.5.2 Request from a user to invite another user to a conference using a REFER request + +Upon receipt of an REFER request that includes: + +- a) a conference URI in the request URI; and +- b) a Refer-To header including: + - a valid SIP URI or tel URL; and, + - the "method" parameter either set to "INVITE" or omitted; + +NOTE: If the "method" URI parameter is omitted, the conference focus assumes that the method is INVITE. + +the conference focus shall: + +- 1) check if the conference URI is allocated. If the conference URI is not allocated, the conference focus shall reject the request in accordance with RFC 3261 [7]. The following actions in this subclause shall only be performed if the conference URI is allocated; +- 2) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; +- 3) generate a final response to the REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10]; +- 4) invite the user indicated in the Refer-To header by performing the procedures as described in subclause 5.3.2.5.4; +- 5) if the received REFER request included a Referred-By header, include the Referred-By header in accordance with RFC 3892 [20] in the INVITE request that is sent for inviting the user to join the conference; +- 5a) if the received REFER request included a Replaces header, include the Replaces header in accordance with RFC 3891 [33] and 3GPP TS 24.229 [5] in the INVITE request that is sent for joining the conference; and +- 6) based on the progress of this invitation, send NOTIFY messages in accordance with the procedures of RFC 3515 [17] as updated by RFC 6665 [10] towards the user who sent the REFER request. + +##### 5.3.2.5.3 Request from a user to invite another user to a conference using an INVITE request for conference creation + +Upon receipt of an INVITE request for conference creation (see subclause 5.3.2.3) after receiving a valid "recipient-list" as defined in RFC 5366 [34], the conference focus shall, in addition to the procedures described in subclause 5.3.2.3, perform following actions: + +- 1) support the procedures of RFC 5360 [36] associated with such a URI list. The conference focus shall act as the relay and may act as a store and forward server as defined in RFC 5360 [36]; and +- 2) send an INVITE request to each of the SIP URIs contained in the URI list that is embedded in the message body of the INVITE request for conference creation, by following the procedures in subclause 5.3.2.5.4. + +The invitation of the users whose SIP URIs are included in the URI list should be initiated by the conference focus in parallel, since the objective of using the URI-list method of inviting users to a conference is usually a fast conference set-up. However, in case the conference focus is not able to keep track of multiple parallel invitations associated to a single conference the conference focus may issue the invitations serially. + +Sending of the multiple invitations should be initiated by the MRFC/AS as soon as a conference URI for the conference has been created, and should run in parallel to the procedure described in subclause 5.3.2.3 in order to speed up conference establishment. If establishment of a session to any of the invitees fails, the further actions depends on local policy whether the conference will continue with the accepted participants or release the whole conference. + +If the conference focus is included in the signalling path between the conference creator and the invited user as a B2B UA, and + +- if the URIs in the URI list contain a Session-ID header field, the focus shall verify if the Session ID information matches to a partial dialog between the focus and the conference creator; else +- if the URIs in the URI list contain Call-ID header field, From header field and To header field, the focus shall verify if this dialog ID information matches to a partial dialog between the focus and the conference creator. + +In the case of a match the focus may use this information to send re-INVITE request in the partial dialogs between the focus and the invited users in order to connect the media of the invited users to the MRFP. + +In the case of no match the focus shall discard Call-ID header field, From header field, To header field and Session-ID header field form the URIs in the URI list, if those header fields are included. + +##### 5.3.2.5.4 Inviting a user to a conference by sending an INVITE request + +When generating an INVITE request in order to invite a user to a specific conference, the conference focus shall: + +- 1) set the request URI of the INVITE request to the address of the user who is invited to the conference; +- 2) set the P-Asserted-Identity header of the INVITE request to the conference URI of the conference that the user shall be invited to; +- 3) set the Contact header of the INVITE request to the conference URI of the conference that the user shall be invited to, including the "isfocus" feature parameter; +- 4) if the INVITE request is generated due to a received REFER request from another conference participant and that received REFER request included a Referred-By header, include the Referred-By header in accordance with RFC 3892 [20] in the INVITE request; +- 4a) if the INVITE request is generated due to a received REFER request from another conference participant and the received REFER request included a Replaces header, include the Replaces header in accordance with RFC 3891 [33] and 3GPP TS 24.229 [5] in the INVITE request; +- 5) send the INVITE request towards the user who is invited to the conference. + +NOTE 1: The conference focus will request the resources required for the new user from the conference mixer. + +NOTE 2: Requests are generated in accordance with 3GPP TS 24.229 [5]. + +Afterwards the conference focus shall proceed the session establishment as described in 3GPP TS 24.229 [5]. + +##### 5.3.2.5.5 Inviting a user to a conference by sending a REFER request + +When generating a REFER request in accordance with the procedures specified in 3GPP TS 24.229 [5], IETF RFC 3515 [17] as updated by IETF RFC 6665 [10] and IETF RFC 7647 [39] in order to invite a user to a specific conference, the conference focus shall: + +- 1) set the request URI of the REFER request to the address of the user who is invited to the conference; +- 2) set the P-Asserted-Identity header of the REFER request to the conference URI of the conference that the user shall be invited to; + +- 3) set the Refer-To header of the REFER request to the conference URI of the conference that the other user shall be invited to, and either including the "method" URI parameter set to "INVITE" or omitting the "method" URI parameter; and + +NOTE 1: Other headers of the REFER request will be set in accordance with 3GPP TS 24.229 [5]. + +- 4) send the REFER request towards the user who is invited to the conference. + +NOTE 2: Requests are generated in accordance with 3GPP TS 24.229 [5]. + +Afterwards the conference focus shall treat incoming NOTIFY requests that are related to the previously sent REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10]. + +#### 5.3.2.6 Leaving a conference + +##### 5.3.2.6.1 Conference participant leaving a conference + +Upon receipt of a BYE message from a conference participant, the conference focus shall: + +- 1) respond to the BYE request as described in 3GPP TS 24.229 [5] and RFC 3261 [7]; and +- 2) release the resources, related to the conference participant from the conference mixer. + +##### 5.3.2.6.2 Removing a conference participant from a conference + +###### 5.3.2.6.2.1 General + +The conference focus can remove a conference participant from a conference by terminating the dialog with the conference participant. This is done by sending a BYE request to the participant, as described in subclause 5.3.2.6.2.3. The removal of a conference participant by the conference focus will be triggered: + +- 1) by a REFER request received from authorized users, that request the conference focus to remove the conference participant from the conference, as described in subclause 5.3.2.6.2.2; or +- 2) by local administration procedures. + +NOTE: Additionally, a conference participant may be removed from a conference by other means. + +###### 5.3.2.6.2.2 Request from a conference participant to remove another conference participant from a conference + +Upon receipt of a REFER request that includes: + +- a) a conference URI in the request URI; and, +- b) a Refer-To header including: + - 1) a valid SIP URI; and + - 2) the "method" parameter set to "BYE". + +The conference focus shall: + +- 1) check if the conference URI is allocated. If the conference URI is not allocated, the conference focus shall reject the request in accordance with RFC 3261 [7]. The following actions in this subclause shall only be performed if the conference URI is allocated; + - 1A) if the SIP URI contains a user parameter that equals "phone" and if the SIP URI of the Refer-To header can be converted to a global tel URI as described in RFC 3261 [7], convert the SIP URI to the equivalent global tel URI. Verify that the tel URI belongs to user who is currently a participant of the referenced conference. If this verification fails, then reject the request in accordance with RFC 3261 [7] and RFC 3515 [17] as updated by RFC 6665 [10]; +- 2) check if the SIP URI of the Refer-To header is identical to the conference URI or belongs to a user who is currently a participant of the referenced conference. If this verification fails, then reject the request in accordance with RFC 3261 [7] and RFC 3515 [17] as updated by RFC 6665 [10]; + +- 3) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; +- 4) generate a final response to the REFER request in accordance with RFC 3515 [17] as updated by RFC 6665 [10]; +- 5) if a single conference participant is indicated in the Refer-To header, remove this conference participant from the conference according to subclause 5.3.2.6.2.3. If the Refer-To header includes the conference URI, remove all conference participants from the conference by performing the procedures described in subclause 5.3.2.6.2.3 for each conference participant individually; and +- 6) based on the progress of this removal, send NOTIFY messages in accordance with the procedures of RFC 3515 [17] as updated by RFC 6665 [10] towards the conference participant who sent the REFER request. + +###### 5.3.2.6.2.3 Conference focus removes conference participant from a conference + +When removing a conference participant from a conference, the conference focus shall: + +- 1) generate a BYE request on the dialog that was established when the conference participant joined or created the conference, in accordance to the procedures described in 3GPP TS 24.229 [5] and RFC 3261 [7]; +- 2) release the resources, related to the conference participant from the conference mixer. + +#### 5.3.2.7 Conference termination + +A conference shall be terminated by the conference focus: + +- 1) when the conference has been created by means of the procedure described in subclause 5.3.2.5.3 and session establishment to one or more of the invitees has failed; or +- 2) when the conference policy dictates it; or +- 3) when no dedicated rules for conference termination exist in the conference policy; and: + - either the conference was created with a conference factory URI and the conference creator has left the conference; or + - the last conference participant has left or has been removed from the conference. + +NOTE: How the conference policy can be created or changed is out of the scope of this specification. + +To terminate an existing conference, the conference focus shall: + +- 1) remove all present conference participants from the conference by performing the procedures as described in subclause 5.3.2.6.2.3 for each participant individually; and +- 2) deallocate the conference URI. + +### 5.3.3 Conference Notification Service + +#### 5.3.3.1 General + +In addition to the procedures specified in subclause 5.3.3, the conference notification service shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the conference notification service is implemented. + +#### 5.3.3.2 Subscription to conference event package + +Upon receipt of a SUBSCRIBE request that includes a conference URI in the request URI and the "conference" tag in the Event header, the conference notification service shall: + +- 1) check if the conference URI is allocated and reject the request in accordance with RFC 3261 [7] if it is not allocated. The following actions in this subclause shall only be performed if the conference URI is allocated; + +- 2) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions shall only be performed if the request can be authorized; and +- 3) establish the subscription to the conference state event information as described in RFC 6665 [10] and RFC 4575 [11]. + +#### 5.3.3.3 Leaving a conference + +When generating a NOTIFY request with conference state event information that is destined to a subscriber that has either left the conference or was removed from it, the conference notification service shall, include in the NOTIFY request a Subscription-State header with the value "terminated" in accordance with RFC 6665 [10]. + +#### 5.3.3.4 Conference termination + +The conference notification service shall terminate all subscriptions to the conference event package in accordance with RFC 4575 [11] when the conference is terminated, as described in subclause 5.3.2.7. + +# --- 6 Protocol using SDP for conferencing + +## 6.1 Introduction + +Void + +## 6.2 Functional entities + +### 6.2.1 User Equipment (UE) + +For the purpose of SIP based conferences, the UE shall implement the role of a conference participant as described in subclause 6.3.1. + +### 6.2.2 Media Resource Function Controller (MRFC) + +For the purpose of SIP based conferences, the MRFC shall support the procedures for media control of ad-hoc conferencing described in subclause 10.3 of 3GPP TS 24.229 [5]. + +### 6.2.3 Conferencing Application Server (Conferencing AS) + +For the purpose of SIP-based conferences, the conferencing AS shall act as a conference focus, as described in subclause 6.3.2. The conferencing AS may implement the role of a conference participant as described in subclause 6.3.1. + +The conferencing AS shall use the procedures for media control in subclause 10.2 of 3GPP TS 24.229 [5] to implement SIP based conferences. + +### 6.2.4 Media Gateway Control Function (MGCF) + +The MGCF implements the role of Conference participant (see subclause 6.3.1). + +## 6.3 Role + +### 6.3.1 Conference Participant + +The conference participant shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the conference participant is implemented. + +If the conference participant uses BFCP as specified in clause 8, then the conference participant shall support the procedures specified in RFC 4583 [35]. + +### 6.3.2 Conference Focus + +In addition to the procedures specified in subclause 6.3.2, the conference focus shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the conference focus is implemented. + +If the conference focus uses BFCP as specified in clause 8, then the conference focus shall support the procedures specified in RFC 4583 [35]. + +NOTE: RFC 4582 [28] recommends the use of Transport Layer Security (TLS) for the secure exchange of BFCP. Whether this is followed, and the mechanism for the exchange of the certificates in association with SDP are outside the scope of this version of this document. + +When the conference focus receives any SIP request or response containing SDP, the conference focus shall examine the media parameters in the received SDP. + +Provided that the INVITE request received by the conference focus contains an SDP offer including one or more "m=" media descriptions, the SDP answer shall: + +- reflect the media capabilities and policies as available for the conference; and +- contain a request confirmation for the result of the resource reservation at the originating end point for every "m=" media line if preconditions were required by the originator. + +During session establishment procedure for a conference, SIP messages shall only contain SDP payload if that is intended to modify the session description. + +For "video" and "audio" media types that utilize the RTP/RTCP, the conference focus shall specify the proposed bandwidth for each media stream utilizing the "b=" media descriptor in the SDP. For other media streams the "b=" media descriptor may be included. The value or absence of the "b=" parameter will affect the assigned QoS which is defined in 3GPP TS 29.208 [15]. + +If the conference focus supports the Volume Based Charging (VBC) functionality, then for each media stream used for the conference, the conference focus shall include the "a=content" media level attribute with value "g.3gpp.conf" as defined in annex B in the SDP. + +The conference focus shall include the DTMF media format at the end of the "m=" media descriptor in the SDP for audio media flows that support both audio codec and DTMF payloads in RTP packets as described in RFC 2833 [16]. + +Upon receipt of a SDP answer or sending a SDP answer that changes the resource requirements for the conference, the conference focus shall provide the corresponding changes of conference resources. + +Upon receipt of a SDP offer during conference creation, that confirms that the conference participant has reserved the required resources, the conference focus shall through-connect the conference resources. + +# --- 7 Void. + +# --- 8 Protocol for floor control for conferencing + +## 8.1 Introduction + +Support of floor control is optional for participants and MRFP. + +## 8.2 Functional entities + +### 8.2.1 User Equipment (UE) + +A UE may support the floor participant (see subclause 8.3.1) or floor chair role (see subclause 8.3.2). A floor chair may, but need not, be a floor participant. + +### 8.2.2 Media Resource Function Processor (MRFP) + +An MRFP may support the floor control server role (see subclause 8.3.3), the floor chair role (see subclause 8.3.2), or the floor participant role (see subclause 8.3.1). + +## 8.3 Role + +### 8.3.1 Floor participant + +The floor participant shall support general client operations and floor participant operations as described in RFC 4582 [28]. + +BFCP messages shall be sent on any IP-CAN transport used for media in accordance with subclause 9.2.2 of 3GPP TS.24.229 [5]. + +### 8.3.2 Floor chair + +The floor chair shall support client operations and floor chair operations as described in RFC 4582 [28]. + +BFCP messages shall be sent on any IP-CAN transport used for media in accordance with subclause 9.2.2 of 3GPP TS.24.229 [5]. + +### 8.3.3 Floor control server + +The floor control server shall support floor control server operations as described in RFC 4582 [28]. + +NOTE: It is out of scope of this version of the document how the floor control server discovers the floor control policy of the conference, and how the floor control server manipulates the media policy of the conference due to changes in the status of any floor. + +# --- Annex A (informative): Example signalling flows of conferencing operation + +## A.1 Scope of signalling flows + +This annex gives examples of signalling flows for conferencing within the IP Multimedia CN Subsystem (IMS) based on the Session Initiation Protocol (SIP), SIP Events and the Session Description Protocol (SDP). + +These signalling flows provide detailed signalling flows, which expand on the overview information flows provided in 3GPP TS 23.228 [6]. + +These signalling flows are simplified in that they do not show the AS to MRFC interactions nor the AS and MRFC functional split. + +## --- A.2 Introduction + +### A.2.1 General + +This annex breaks down the signalling flows for establishing sessions into a number of individual procedures, following the same principles as 3GPP TS 23.228 [3] subclause 5.4.9. + +For the purposes of the present document, a further breakdown has been necessary, and therefore a number of signalling flows have been given an (a) or (b) suffix, so that the signalling flows for establishing sessions where configuration independence is applied may be distinguished from those where it is not, e.g.: + +- (MO#1a) Mobile origination, roaming, without I-CSCF providing configuration independence. +- (MO#1b) Mobile origination, roaming, with I-CSCF in home network providing configuration independence. + +### A.2.2 Key required to interpret signalling flows + +The key to interpret signalling flows specified in 3GPP TS 24.228 [4] subclause 4.1 applies with the additions specified below: + +- #### represents the contents in the headers are not shown and does not impact the implementation of the flows. + +As in 3GPP TS 24.228 [4], in order to differentiate between SIP methods and other protocol messages, the message name is preceded with the associated protocol for all non-SIP messages. + +Each flow table contains descriptions for headers where the content of the header is new to that flow, as is already performed in 3GPP TS 24.228 [4]. + +However, 3GPP TS 24.228 [4] includes extensive descriptions for the contents of various headers following each of the tables representing the contents of the flows. Where the operation of the header is identical to that shown in 3GPP TS 24.228 [4], then such text is not reproduced in the present document. + +Additional text may also be found on the contents of headers within 3GPP TS 24.228 [4] in addition to the material shown in the present document. + +### A.2.3 Overview of signalling flows related to PSI routing + +The flows in this annex reflect examples for some of the PSI specific routing scenarios. This subclause gives a list of the PSI scenarios and indicates which flows specifically cover them: + +- 1) User originating a dialog towards a PSI. + - a) PSI is hosted by the originating users home network. + - i) S-CSCF of originating user can directly route towards the AS hosting the PSI. + +This case is shown in subclauses A.3.2.1 and A.4.4.1. + +- ii) PSI is statically pre-configured, i.e. S-CSCF of the originating user routes towards the S-CSCF assigned to the PSI, which afterwards routes towards the AS hosting the PSI. + +This case is not covered by the present document. + +- b) PSI is hosted by a network different from the originating users home network. + +- i) PSI can be resolved directly by the S-CSCF located in the originating users home network. + +This case is shown in subclauses A.4.2.1.2 and A.5.2.1. + +- ii) S-CSCF in originating users home network can only resolve an I-CSCF of the network that is hosting the PSI. + +- I-CSCF can directly route towards the AS hosting the PSI. + +- a) This case is shown in subclauses A.3.2.2 and A.4.2.1.1. + +- PSI is statically pre-configured, i.e. I-CSCF routes first to S-CSCF in the network that hosts the PSI, the S-CSCF afterwards routes towards the AS hosting the PSI. + +- b) This case is not covered by the present document. + +- 2) Dialog originates from a PSI. + +- a) AS routes directly to the I-CSCF of the terminating users home network. + +This case is shown in subclause A.4.3.1.3. + +- b) AS routes first to a S-CSCF in the network hosting the PSI, which then routes to the I-CSCF of the terminating users home network. + +This case is shown in subclause A.4.3.1.4. + +- 3) Dialog originating from a PSI and terminating at a different PSI. + +This case is not covered by the present document. + +## A.3 Flows demonstrating the creation of a conference + +### A.3.1 Introduction + +Clause A.3 covers the flows that show how a user can create conferences at a MRFC/AS. + +### A.3.2 User automatically creating a conference with a conference factory URI + +#### A.3.2.1 MRFC/AS is located in user's home network + +![Sequence diagram showing the flow for creating a conference when the MRFC/AS is in the user's home network.](4af57aad638888edf2062306f8a54a6c_img.jpg) + +The sequence diagram illustrates the interaction between a User Equipment (UE#1) in a Visited Network and various network elements in the Home Network to create a conference. The participants are UE#1, P-CSCF, S-CSCF, MRFC/AS, and MRFP. + +- UE#1 sends an INVITE to P-CSCF. +- P-CSCF responds with 100 Trying. +- P-CSCF forwards the INVITE to S-CSCF. +- S-CSCF responds with 100 Trying. +- S-CSCF performs an Evaluation of initial Filter Criteria. +- S-CSCF sends an INVITE to MRFC/AS. +- MRFC/AS responds with 100 Trying. +- MRFC/AS sends a message to MRFP to Allocate Conference URI. +- MRFC/AS performs an H.248 interaction with MRFP to create conference connection resources for UE#1. +- MRFC/AS sends a 183 Session Progress to S-CSCF. +- S-CSCF forwards the 183 Session Progress to P-CSCF. +- P-CSCF performs an Authorize QoS resources. +- P-CSCF forwards the 183 Session Progress to UE#1. +- UE#1 performs a Resource Reservation. +- UE#1 sends a PRACK to P-CSCF. +- P-CSCF forwards the PRACK to S-CSCF. +- S-CSCF forwards the PRACK to MRFC/AS. +- MRFC/AS sends a 200 OK to S-CSCF. +- S-CSCF forwards the 200 OK to P-CSCF. +- P-CSCF forwards the 200 OK to UE#1. +- MRFC/AS performs an H.248 interaction with MRFP to modify conference connection resources for UE#1. +- UE#1 sends an UPDATE to P-CSCF. +- P-CSCF forwards the UPDATE to S-CSCF. +- S-CSCF forwards the UPDATE to MRFC/AS. +- MRFC/AS sends a 200 OK to S-CSCF. +- S-CSCF forwards the 200 OK to P-CSCF. +- P-CSCF forwards the 200 OK to UE#1. +- MRFC/AS performs an H.248 interaction with MRFP to connect through conference connection resources for UE#1. +- MRFC/AS sends a 200 OK to S-CSCF. +- S-CSCF forwards the 200 OK to P-CSCF. +- P-CSCF forwards the 200 OK to UE#1. +- P-CSCF performs an Approval of QoS Commit. +- P-CSCF sends a 200 OK to UE#1. +- UE#1 sends an ACK to P-CSCF. +- P-CSCF forwards the ACK to S-CSCF. +- S-CSCF forwards the ACK to MRFC/AS. + +Sequence diagram showing the flow for creating a conference when the MRFC/AS is in the user's home network. + +Figure A.3.2.1-1: User automatically creating a conference with a conference factory URI - MRFC/AS is located in user's home network + +Figure A.3.2.1-1 shows an user creating a conference by using a conference-factory URI. The conference is created at a MRFC/AS of the users home network. + +The details of the flows are as follows: + +##### 1. INVITE request (UE to P-CSCF) - see example in table A.3.2.1-1 + +A UE wants to create a conference. For this purpose the UE is aware of a conference-factory URI that was obtained by means outside the present document (e.g. due to pre-configuration or via other protocols, such as http). + +The UE determines the complete set of codecs that it is capable of supporting for this conference. It builds a SDP Offer containing bandwidth requirements and characteristics of each, and assigns local port numbers for each possible media flow. Multiple media flows may be offered, and for each media flow (m= line in SDP), there may be multiple codec choices offered. + +For this example, it is assumed that UE#1 is willing to establish a multimedia session comprising a video stream and an audio stream. The video stream supports two codecs, either H.263 or MPEG-4 Visual. The audio stream supports the AMR codec. The UE sends the INVITE request to the P-CSCF. + +The UE indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +The UE does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between UE and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +**Table A.3.2.1-1: INVITE request (UE to P-CSCF)** + +``` + +INVITE sip:conference-factory1@mrfcl.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu, 199 +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99:MPVMP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** contains the conference factory URI. + +##### 2. 100 (Trying) response (P-CSCF to UE) - see example in table A.3.2.1-2 + +The P-CSCF responds to the INVITE request (1) with a 100 (Trying) provisional response. + +**Table A.3.2.1-2: 100 (Trying) response (P-CSCF to UE)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +##### 3. INVITE request (P-CSCF to S-CSCF) - see example in table A.3.2.1-3 + +The P-CSCF forwards the INVITE request to the S-CSCF. + +**Table A.3.2.1-3: INVITE request (P-CSCF to S-CSCF)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE sip:conference-factory1@mrfc1.home1.net SIP/2.0 Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 69 Route: <sip:orig@scscf1.home1.net;lr> Record-Route: <sip:pcscf1.visited1.net;lr> P-Asserted-Identity: "John Doe" <sip:user1_public1@home1.net> P-Access-Network-Info: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" Privacy: From: To: Call-ID: Cseq: Supported: Contact: Allow: Accept: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 4. 100 (Trying) response (S-CSCF to P-CSCF) - see example in table A.3.2.1-4 + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) provisional response. + +**Table A.3.2.1-4: 100 (Trying) response (S-CSCF to P-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 100 Trying Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 5. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +##### 6. INVITE request (S-CSCF to MRFC/AS) - see example in table A.3.2.1-6 + +The S-CSCF forwards the INVITE request to the MRFC/AS that is indicated in the host part of the Request URI. The S-CSCF does not re-write the Request URI. + +**Table A.3.2.1-6: INVITE request (S-CSCF to MRFC/AS)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE sip:conference-factory1@mrfc1.home1.net SIP/2.0 Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 68 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> P-Asserted-Identity: "John Doe" <sip:user1_public1@home1.net>, <tel:+358-50-4821437> P-Access-Network-Info: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22];     ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] Privacy: From: To: Call-ID: Cseq: Supported: Contact: Allow: Accept: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### **7. 100 (Trying) response (MRFC/AS to S-CSCF) - see example in table A.3.2.1-7 (related to table A.3.2.1-6)** + +The MRFC/AS responds to the INVITE request (6) with a 100 (Trying) provisional response. + +**Table A.3.2.1-7: 100 (Trying) response (MRFC/AS to S-CSCF)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 100 Trying Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 8. Allocate conference URI + +The MRFC/AS allocates a conference URI, based on local information and information gained from the conference-factory URI, as well as information gained from other elements of the SIP signalling. + +##### 9. H.248 interaction to create connection + +The MRFC initiates a H.248 interaction to create an IMS connection point for UE#1 in MRFP and to determine media capabilities of the MRFP. + +##### 10. 183 (Session Progress) response (MRFC/AS to S-CSCF) - see example in table A.3.2.1-13 (related to table A.3.2.1-6) + +The MRFC determines the complete set of codecs that it is capable of supporting for this conference. It determines the intersection with those appearing in the SDP in the INVITE request. + +The media stream capabilities of the destination are returned along the signalling path, in a 183 (Session Progress) provisional response (to 6). + +**Table A.3.2.1-10: 183 (Session Progress) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: "Conference Server" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Require: precondition, 100rel +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +RSeq: 9021 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933623 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 10001 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MP4V-ES +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +###### Contact: + +Contains the IP address or FQDN of the MRFC/AS and a temporary identifier of the conference being created in the user part. The URI for the allocated + +conference is not indicated yet. The "isfocus" feature parameter is included, as this temporary contact is still a conference URI. + +**P-Charging-Vector:** The MRFC/AS inserts this header and populates the icid parameters with a unique value and populates the term-ioi parameter with the identifier of its own network. + +**P-Charging-Function-Address:** The MRFC/AS stores the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +##### 11. 183 (Session Progress) response (S-CSCF to P-CSCF) - see example in table A.3.2.1-11 + +The S-CSCF forwards the 183 (Session Progress) response to the P-CSCF. + +**Table A.3.2.1-11: 183 (Session Progress) response (S-CSCF to P-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22];     ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 12. Authorize QoS Resources + +The P-CSCF authorizes the resources necessary for this session. The approval of QoS commitment either happens at this stage or after the 200 (OK) response of INVITE request (39) based on operator local policy. + +##### 13 183 (Session Progress) response (P-CSCF to UE) - see example in table A.3.2.1-13 + +The P-CSCF forwards the 183 (Session Progress) response to the originating endpoint. + +**Table A.3.2.1-13: 183 (Session Progress) response (P-CSCF to UE)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Contact: +Allow: +RSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +##### 14. Resource reservation + +The originating UE sets up the bearer in accordance with the media description received SDP. + +##### 15. PRACK request (UE to P-CSCF) - see example in table A.3.2.1-15 + +The PRACK request does not carry SDP as the final codec decision is already made as part of the initial offer/answer exchange. + +**Table A.3.2.1-15: PRACK request (UE to P-CSCF)** + +``` + +PRACK sip:lmaa234269@mrfcl.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +Require: precondition, sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; + port-c=8642; port-s=7531 +Rack: 9021 127 INVITE +Content-Length: 0 + +``` + +##### 16. PRACK request (P-CSCF to S-CSCF) - see example in table A.3.2.1-16 + +The P-CSCF forwards the PRACK request to the S-CSCF. + +**Table A.3.2.1-16: PRACK request (P-CSCF to S-CSCF)** + +``` +PRACK sip:lmaa234269@mrfl.home1.net SIP/2.0 +Via: SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +Route: +From: +To: +Call-ID: +Cseq: +Require: precondition +RAck: +Content-Length: +``` + +##### 17. PRACK request (S-CSCF to MRFC/AS) - see example in table A.3.2.1-17 + +The S-CSCF forwards the PRACK request to the MRFC/AS. + +**Table A.3.2.1-17: PRACK request (S-CSCF to MRFC/AS)** + +``` +PRACK sip:lmaa234269@mrfl.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +P-Access-Network-Info: +From: +To: +Call-ID: +Cseq: +Require: +RAck: +Content-Length: +``` + +##### 18. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.2.1-18 (related to table A.3.2.1-17) + +The MRFC/AS acknowledges the PRACK request (17) with a 200 (OK) response. + +**Table A.3.2.1-18: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Content-Length: 0 +``` + +##### 19. H.248 interaction to modify connection + +MRFC initiates a H.248 interaction to modify the connection established in step #9 and instructs MRFP to reserve the multimedia processing resources for UE#1 according to the preceding resource negotiation between the UE#1 and the MRFC. + +##### **20. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.1-20** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +###### **Table A.3.2.1-20: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **21. 200 (OK) response (P-CSCF to UE) - see example in table A.3.2.1-21** + +The P-CSCF forwards the 200 (OK) response to the UE. + +###### **Table A.3.2.1-21: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### 22. UPDATE request (UE to P-CSCF) - see example in table A.3.2.1-22 + +When the resource reservation is completed, the UE sends the UPDATE request to the MRFC/AS, via the signalling path established by the INVITE request. + +**Table A.3.2.1-22: UPDATE request (UE to P-CSCF)** + +``` + +UPDATE sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +##### 23. UPDATE request (P-CSCF to S-CSCF) - see example in table A.3.2.1-23 + +The P-CSCF forwards the UPDATE request to the S-CSCF. + +Table A.3.2.1-23: UPDATE request (P-CSCF to S-CSCF) + +``` + +UPDATE sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; + ggsn=[5555::4b4:3c3:2d2:1e1]; pdp-sig=no; gcid=723084371; auth-token=43876559; flow-id=3 +Route: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +##### 24. UPDATE request (S-CSCF to MRFC/AS) - see example in table A.3.2.1-24 + +The S-CSCF forwards the UPDATE request to the MRFC/AS. + +**Table A.3.2.1-24: UPDATE request (S-CSCF to MRFC/AS)** + +``` +UPDATE sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +P-Access-Network-Info: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +``` + +##### **25. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.2.1-25 (related to table A.3.2.1-24)** + +The MRFC/AS acknowledges the UPDATE request (24) with a 200 (OK) response. + +**Table A.3.2.1-25: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933625 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +The SDP indicates that the resource reservation was successful both in the local and the remote segment. + +##### **26. H.248 interaction to modify connection** + +MRFC initiates a H.248 interaction to connect through the multimedia processing resources for UE#1 in MRFP. + +##### **27. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.1-27** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.3.2.1-27: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +``` + +##### 28. 200 (OK) response (P-CSCF to UE) - see example in table A.3.2.1-28 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.3.2.1-28: 200 (OK) response (P-CSCF to UE)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 200 OK Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### **29. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.2.1-29 (related to table A.3.2.1-6)** + +After the success modification of the session (26), the MRFC/AS sends a 200 (OK) response final response to the INVITE request (6) to the S-CSCF. + +**Table A.3.2.1-29: 200 (OK) response (MRFC/AS to S-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 200 OK Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP   pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP   [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> From: To: Call-ID: CSeq: 127 INVITE Contact: <sip:conference1@mrfc1.home1.net>;isfocus Allow-Events: conference, pending-additions Content-Length:0
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Contact:** Contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**Allow-Events:** The MRFC/AS indicates support for the "conference" and "pending-additions" event packages. + +##### 30. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.1-30 + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to the P-CSCF. + +**Table A.3.2.1-30: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +##### 31. Approval of QoS commit + +The P-CSCF approves the commitment of the QoS resources if it was not approved already in step (12). + +##### 32. 200 (OK) response (P-CSCF to UE) - see example in table A.3.2.1-32 + +The P-CSCF forwards the 200 (OK) response final response to the session originator. The UE can start the media flow(s) for this session. + +**Table A.3.2.1-32: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +##### 33. ACK request (UE to P-CSCF) - see example in table A.3.2.1-33 + +The UE starts the media flow for this session, and responds to the 200( OK) response (32) with an ACK request sent to the P-CSCF. + +**Table A.3.2.1-33: ACK request (UE to P-CSCF)** + +``` +ACK sip:conference1@mrfc1.home1.net:2342 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +##### **34. ACK request (P-CSCF to S-CSCF) - see example in table A.3.2.1-34** + +The P-CSCF forwards the ACK request to the S-CSCF. + +**Table A.3.2.1-34: ACK request (P-CSCF to S-CSCF)** + +``` +ACK sip:conference1@mrfc1.home1.net:2342 SIP/2.0 +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +##### **35. ACK request (S-CSCF to MRFC/AS) - see example in table A.3.2.1-35** + +The S-CSCF forwards the ACK request to the MRFC/AS. + +**Table A.3.2.1-35: ACK request (S-CSCF to MRFC/AS)** + +``` +ACK sip:conference1@mrfc1.home1.net:2342 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### A.3.2.2 MRFC/AS is not located in user's home network + +Figure A.3.2.2-1 shows an user creating a conference by using a conference-factory URI. The conference is created at a MRFC/AS located in a different network than user's S-CSCF. + +![Sequence diagram showing the interaction between UE#1, P-CSCF, S-CSCF, I-CSCF, MRFC/AS, and MRFP across three network domains: Visited Network, Home Network, and Conference AS home network. The diagram illustrates the process of a user automatically creating a conference with a conference factory URI, where the MRFC/AS is not located in the user's home network.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant P-CSCF + participant S-CSCF + participant I-CSCF + participant MRFC/AS + participant MRFP + + Note left of S-CSCF: Evaluation of initial Filter Criteria + Note right of MRFC/AS: Allocate Conference URI + Note right of MRFC/AS: H.248 interaction to create conference connection resources for UE#1 + Note right of MRFC/AS: H.248 interaction to modify conference connection resources for UE#1 + Note right of MRFC/AS: H.248 interaction to connect through conference connection resources for UE#1 + Note left of P-CSCF: Authorize QoS resources + Note left of P-CSCF: Resource Reservation + Note left of P-CSCF: Approval of QoS Commit + + UE#1->>P-CSCF: 1. INVITE + P-CSCF-->>UE#1: 2. 100 Trying + P-CSCF->>S-CSCF: 3. INVITE + S-CSCF-->>P-CSCF: 4. 100 Trying + S-CSCF->>I-CSCF: 6. INVITE + I-CSCF-->>S-CSCF: 7. 100 Trying + I-CSCF->>MRFC/AS: 9. INVITE + MRFC/AS-->>I-CSCF: 10. 100 Trying + MRFC/AS->>MRFP: 11. Allocate Conference URI + MRFC/AS->>MRFP: 12. H.248 interaction to create conference connection resources for UE#1 + MRFC/AS->>I-CSCF: 13. 183 Session Progress + I-CSCF->>S-CSCF: 14. 183 Session Progress + S-CSCF->>P-CSCF: 15. 183 Session Progress + P-CSCF->>UE#1: 17. 183 Session Progress + P-CSCF->>MRFC/AS: 16. Authorize QoS resources + P-CSCF->>MRFP: 18. Resource Reservation + UE#1->>P-CSCF: 19. PRACK + P-CSCF->>S-CSCF: 20. PRACK + S-CSCF->>MRFC/AS: 21. PRACK + MRFC/AS-->>S-CSCF: 22. 200 OK + MRFC/AS->>MRFP: 23. H.248 interaction to modify conference connection resources for UE#1 + MRFC/AS->>I-CSCF: 28. UPDATE + I-CSCF->>S-CSCF: 29. 200 OK + MRFC/AS->>MRFP: 30. H.248 interaction to connect through conference connection resources for UE#1 + MRFC/AS-->>I-CSCF: 33. 200 OK + I-CSCF->>S-CSCF: 34. 200 OK + S-CSCF->>P-CSCF: 35. 200 OK + P-CSCF->>UE#1: 25. 200 OK + P-CSCF->>MRFC/AS: 36. Approval of QoS Commit + P-CSCF->>UE#1: 37. 200 OK + UE#1->>P-CSCF: 38. ACK + P-CSCF->>S-CSCF: 39. ACK + S-CSCF->>MRFC/AS: 40. ACK + +``` + +Sequence diagram showing the interaction between UE#1, P-CSCF, S-CSCF, I-CSCF, MRFC/AS, and MRFP across three network domains: Visited Network, Home Network, and Conference AS home network. The diagram illustrates the process of a user automatically creating a conference with a conference factory URI, where the MRFC/AS is not located in the user's home network. + +**Figure A.3.2.2-1: User automatically creating a conference with a conference factory URI - MRFC/AS is not located in user's home network** + +The details of the flows are as follows: + +##### **1. INVITE request (UE to P-CSCF) - see example in table A.3.2.2-1** + +A UE wants to create a conference to a MRFC/AS in other network. For this purpose the UE is aware of a conference-factory URI that was obtained by means outside the present document (e.g. due to pre-configuration or via other protocols, such as http) + +The UE determines the complete set of codecs that it is capable of supporting for this conference. It builds a SDP Offer containing bandwidth requirements and characteristics of each, and assigns local port numbers for each possible media flow. Multiple media flows may be offered, and for each media flow (m= line in SDP), there may be multiple codec choices offered. + +For this example, it is assumed that the UE is willing to establish a multimedia session comprising a video stream and an audio stream. The video stream supports two codecs, either H.263 or MPEG-4 Visual. The audio stream supports the AMR codec. The UE sends the INVITE request to the P-CSCF. + +The UE indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +The UE does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between UE and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +**Table A.3.2.2-1: INVITE request (UE to P-CSCF)** + +``` + +INVITE sip:conference-factory@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu, 199 +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99:MPVMP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** contains the conference factory URI. + +##### 2. 100 (Trying) response (P-CSCF to UE) - see example in table A.3.2.2-2 + +The P-CSCF responds to the INVITE request (1) with a 100 (Trying) response provisional response. + +**Table A.3.2.2-2: 100 (Trying) response (P-CSCF to UE)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 100 (Trying) response Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 3. INVITE request (P-CSCF to S-CSCF) - see example in table A.3.2.2-3 + +The P-CSCF forwards the INVITE request to the S-CSCF. + +**Table A.3.2.2-3: INVITE request (P-CSCF to S-CSCF)** + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
INVITE sip:conference-factory@home2.net SIP/2.0 Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 69 Route: <sip:orig@scscf1.home1.net;lr> Record-Route: <sip:pcscf1.visited1.net;lr> P-Asserted-Identity: "John Doe" <sip:user1_public1@home1.net> P-Access-Network-Info: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" Privacy: From: To: Call-ID: Cseq: Supported: Contact: Allow: Accept: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 4. 100 (Trying) response (S-CSCF to P-CSCF) - see example in table A.3.2.2-4 + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) response provisional response. + +**Table A.3.2.2-4: 100 (Trying) response (S-CSCF to P-CSCF)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 100 (Trying) response Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 5. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +##### 6. INVITE request (S-CSCF to I-CSCF) - see example in table A.3.2.2-6 + +S-CSCF determines the network where the INVITE request should be forwarded. The S-CSCF resolves the I-CSCF as the next hop for this request. + +**Table A.3.2.2-6: INVITE request (S-CSCF to I-CSCF)** + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
INVITE sip:conference-factory@home2.net SIP/2.0 Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 68 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> P-Asserted-Identity: "John Doe" <sip:user1_public1@home1.net>, <tel:+358-50-4821437> P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net Privacy: From: To: Call-ID: CSeq: Supported: Contact: Allow: Accept: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 7. 100 (Trying) response (I-CSCF to S-CSCF) - see example in table A.3.2.2-7 + +The I-CSCF responds to the INVITE request (6) with a 100 (Trying) response provisional response. + +**Table A.3.2.2-7: 100 (Trying) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### 8. Public service identity (PSI) location query + +The I-CSCF resolves the conference-factory URI. In this example the I-CSCF queries HSS to resolve the MRFC/AS PSI to be contacted. The HSS responds with the address of the MRFC/AS. + +For detailed message flows see 3GPP TS 29.228 [12] . + +Table A.3.2.2-8a provides the parameters in the SIP INVITE request, which are sent to the HSS. + +**Table A.3.2.2-8a Cx: User location query procedure (I-CSCF to HSS)** + +| Message source and destination | Cx: Information element name | Information source in SIP INVITE | Description | +|--------------------------------|-------------------------------|----------------------------------|-------------------------------------------------------------| +| I-CSCF to HSS | Public Service Identity (PSI) | Request-URI: | This information element indicates the public user identity | + +Table A.3.2.2-8b provides the parameters sent from the HSS that need to be mapped to SIP INVITE and sent to MRFC/AS. + +**Table A.3.2.2-8b Cx: User location query procedure (HSS to I-CSCF)** + +| Message source and destination | Cx: Information element name | Mapping to SIP header in SIP INVITE | Description | +|--------------------------------|------------------------------|-------------------------------------|------------------------------------------------------------------------------| +| HSS to I-CSCF | MRFC/AS address | IP packet destination address | This information element indicates the MRFC/AS address which serves the PSI. | + +##### 9. INVITE request (I-CSCF to MRFC/AS) - see example in table A.3.2.2-9 + +I-CSCF forwards the INVITE request to the MRFC/AS. The I-CSCF does not add itself to the Record-Route header since it does not need to stay on the signalling path for subsequent requests. + +**Table A.3.2.2-9: INVITE request (I-CSCF to MRFC/AS)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
INVITE sip:conference-factory@home2.net SIP/2.0 Via: SIP/2.0/UDP icscf1.home2.net;branch=z9hG4bK32f432.1, SIP/2.0/UDP     scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 67 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net Privacy: From: To: Call-ID: Cseq: Supported: Contact: Allow: Accept: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### **10. 100 (Trying) response (MRFC/AS to I-CSCF) - see example in table A.3.2.2-10 (related to table A.3.2.2-9)** + +The MRFC/AS responds to the INVITE request (6) with a 100 (Trying) response provisional response. + +**Table A.3.2.2-10: 100 (Trying) response (MRFC/AS to I-CSCF)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 100 (Trying) response Via: SIP/2.0/UDP icscf1.home2.net;branch=z9hG4bK32f432.1, SIP/2.0/UDP     scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 11. Allocate conference URI + +MRFC/AS allocates a conference URI, based on local information and information gained from the conference-factory URI, as well as information gained from other elements of the SIP signalling. + +##### 12. H.248 interaction to create connection + +MRFC initiates a H.248 interaction to create an connection point for UE#1 in MRFP and to determine media capabilities of MRFP. + +##### 13. 183 (Session Progress) response (MRFC/AS to I-CSCF) - see example in table A.3.2.2-13 (related to table A.3.2.2-9) + +The MRFC determines the complete set of codecs that it is capable of supporting for this conference. It determines the intersection with those appearing in the SDP in the INVITE request. + +The media stream capabilities of the destination are returned along the signalling path, in a 183 (Session Progress) provisional response (to 8). + +**Table A.3.2.2-13: 183 (Session Progress) response (MRFC/AS to I-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP icscf1.home2.net;branch=z9hG4bK32f432.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: "Conference Server" +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Require: precondition, 100rel +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +RSeq: 9021 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933623 2987933623 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 10001 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MP4V-ES +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +- Contact:** Contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. +- P-Charging-Vector:** The MRFC/AS inserts the originating IOI parameter received and populates the terminating IOI parameter with its own network. +- P-Charging-Function-Addresses:** The MRFC/AS inserts the P-Charging-Function-Addresses header field to be passed to the I-CSCF. + +##### 14. 183 (Session Progress) response (I-CSCF to S-CSCF) - see example in table A.3.2.2-14 + +The I-CSCF forwards the 183 (Session Progress) response to the P-CSCF. + +**Table A.3.2.2-14: 183 (Session Progress) response (I-CSCF to S-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Contact: +Allow: +RSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +##### 15. 183 (Session Progress) response (S-CSCF to P-CSCF) - see example in table A.3.2.2-15 + +The S-CSCF forwards the 183 (Session Progress) response to the P-CSCF. + +**Table A.3.2.2-15: 183 (Session Progress) response (S-CSCF to P-CSCF)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 16. Authorize QoS Resources + +The P-CSCF authorizes the resources necessary for this session. The approval of QoS commitment either happens at this stage or after 200 (OK) response of INVITE request (34) based on operator local policy. + +##### 17. 183 (Session Progress) response (P-CSCF to UE) - see example in table A.3.2.2-17 + +The P-CSCF forwards the 183 (Session Progress) response to the originating endpoint. + +**Table A.3.2.2-17: 183 (Session Progress) response (P-CSCF to UE)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net:7531;lr;comp=sigcomp> P-Asserted-Identity: Privacy: From: To: Call-ID: CSeq: Require: Contact: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 18. Resource reservation + +The originating UE sets up the bearer in accordance with the media description received SDP. + +##### 19. PRACK request (UE to P-CSCF) - see example in table A.3.2.2-19 + +The PRACK request does not carry SDP as the final codec decision is already made as part of the initial offer/answer exchange. + +**Table A.3.2.2-19: PRACK request (UE to P-CSCF)** + +``` + +PRACK sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +Require: precondition, sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +RAck: 9021 127 INVITE +Content-Length: 0 + +``` + +##### **20. PRACK request (P-CSCF to S-CSCF) - see example in table A.3.2.2-20** + +The P-CSCF forwards the PRACK request to the S-CSCF. + +**Table A.3.2.2-20: PRACK request (P-CSCF to S-CSCF)** + +``` + +PRACK sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +Route: +From: +To: +Call-ID: +Cseq: +Require: precondition +RAck: +Content-Length: + +``` + +##### **21. PRACK request (S-CSCF to MRFC/AS) - see example in table A.3.2.2-21** + +The S-CSCF resolves the Request-URI and forwards the PRACK request directly to the MRFC/AS. + +**Table A.3.2.2-21: PRACK request (S-CSCF to MRFC/AS)** + +``` + +PRACK sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Require: +RAck: +Content-Length: + +``` + +##### **22. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.2.2-22 (related to table A.3.2.2-21)** + +The MRFC/AS acknowledges the PRACK request (20) with a 200 (OK) response. + +**Table A.3.2.2-22: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **23. H.248 interaction to modify connection** + +MRFC initiates a H.248 interaction to modify the connection established in step #11 and instructs MRFP to reserve the multimedia processing resources for UE#1 according to the preceding resource negotiation between the UE#1 and the MRFC. + +##### **24. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.2-24** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.3.2.2-24: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### **25. 200 (OK) response (P-CSCF to UE) - see example in table A.3.2.2-25** + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.3.2.2-25: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### 26. UPDATE request (UE to P-CSCF) - see example in table A.3.2.2-26 + +When the resource reservation is completed, the UE sends the UPDATE request to the MRFC/AS, via the signalling path established by the INVITE request. + +**Table A.3.2.2-26: UPDATE request (UE to P-CSCF)** + +``` + +UPDATE sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +##### 27. UPDATE request (P-CSCF to S-CSCF) - see example in table A.3.2.2-27 + +The P-CSCF forwards the UPDATE request to the S-CSCF. + +Table A.3.2.2-27: UPDATE request (P-CSCF to S-CSCF) + +``` + +UPDATE sip:conferece1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; + ggsn=[5555::4b4:3c3:2d2:1e1]; pdp-sig=no; gcid=723084371; auth-token=43876559; flow-id=3 +Route: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +##### 28. UPDATE request (S-CSCF to MRFC/AS) - see example in table A.3.2.2-28 + +The S-CSCF forwards the UPDATE request to the MRFC/AS. + +Table A.3.2.2-28: UPDATE request (S-CSCF to MRFC/AS) + +``` + +UPDATE sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +##### 29. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.2.2-29 (related to table A.3.2.2-28) + +The MRFC/AS acknowledges the UPDATE request (27) with a 200 (OK) response. + +**Table A.3.2.2-29: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933625 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +The SDP indicates that the resource reservation was successful both in the local and the remote segment. + +##### 30. H.248 interaction to modify connection + +MRFC initiates a H.248 interaction to connect through the multimedia processing resources for UE#1 in MRFP. + +##### **31. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.2-31** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.3.2.2-31: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 (OK) +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +##### 32. 200 (OK) response (P-CSCF to UE) - see example in table A.3.2.2-32 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.3.2.2-32: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +``` + +##### 33. 200 (OK) response (MRFC/AS to I-CSCF) - see example in table A.3.2.2-33 (related to table A.3.2.2-9) + +After the success modification of the session (29), the MRFC/AS sends a 200 (OK) response final response to the INVITE request (8) to the I-CSCF. + +**Table A.3.2.2-33: 200 (OK) response (MRFC/AS to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf1.home2.net;branch=z9hG4bK32f432.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: 127 INVITE +Contact: ;isfocus +Allow-Events: conference, pending-additions +Content-Length:0 +``` + +**Contact:** Contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**Allow-Events:** The MRFC/AS indicates support for the "conference" and "pending-additions" event packages. + +##### **34. 200 (OK) response (I-CSCF to S-CSCF) - see example in table A.3.2.2-34** + +The I-CSCF forwards the 200(OK) response to the S-CSCF + +**Table A.3.2.2-34: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length:0 +``` + +##### **35. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.2.2-35** + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to the P-CSCF. + +**Table A.3.2.2-35: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +##### **36. Approval of QoS commit** + +The P-CSCF approves the commitment of the QoS resources if it was not approved already in step (12). + +##### **37. 200 (OK) response (P-CSCF to UE) - see example in table A.3.2.2-37** + +The P-CSCF forwards the 200 (OK) response final response to the session originator. The UE can start the media flow(s) for this session. + +**Table A.3.2.2-37: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +##### 38. ACK request (UE to P-CSCF) - see example in table A.3.2.2-38 + +The UE starts the media flow for this session, and responds to the 200 (OK) response (32) with an ACK request sent to the P-CSCF. + +**Table A.3.2.2-38: ACK request (UE to P-CSCF)** + +``` +ACK sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +##### 39. ACK request (P-CSCF to S-CSCF) - see example in table A.3.2.2-39 + +The P-CSCF forwards the ACK request to the S-CSCF. + +**Table A.3.2.2-39: ACK request (P-CSCF to S-CSCF)** + +``` +ACK sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +##### 40. ACK request (S-CSCF to MRFC/AS) - see example in table A.3.2.2-40 + +The S-CSCF forwards the ACK request to the MRFC/AS. + +**Table A.3.2.2-40: ACK request (S-CSCF to MRFC/AS)** + +``` +ACK sip:conference1@mrfc1.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +### A.3.3 User automatically creating a conference with a conference URI + +The call flows for a user automatically creating a conference with a conference URI look identical to the call flows for conference creation with a conference-factory URI (see subclause A.3.2), besides the URIs carried in the Request URI and Contact header fields. + +### A.3.4 User creating a conference by manually dialling + +The call flows for a user creating a conference by manually dialling into the IMS look identical to the call flows for conference creation with a conference-factory URI (see subclause A.3.2), besides the URIs carried in the Request URI and Contact header fields. + +### A.3.5 User creating a conference from two existing connections (Three-way session), users in different networks + +Subclause 5.3.1.3.3 of the present document shows that the creation of a Three-way session is a local issue at the UE which results in a combination of other procedures (conference creation, conference participant invitation to conference, session release). + +### A.3.6 User automatically creating a conference with a conference factory URI and inviting some users to the newly-created conference + +This flow shows how a user can create a conference using a conference factory URI and simultaneously invite some users to the newly created conference, all using a single INVITE request. + +![Sequence diagram showing the interaction between a User Equipment (UE#1) and various network elements (P-CSCF, S-CSCF, MRFC/AS, MRFP) for conference creation. The diagram is split into Visited Network and Home Network. The process involves INVITE, 100 Trying, 183 Session Progress, PRACK, 200 OK, UPDATE, and ACK messages, with internal steps for filter criteria evaluation, resource allocation, and H.248 interactions.](5801c19431e76330430e92a598cc7a16_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant P-CSCF + participant S-CSCF + participant MRFC/AS + participant MRFP + + Note left of S-CSCF: Evaluation of initial Filter Criteria + + Note right of MRFC/AS: Allocate Conference URI + Note right of MRFC/AS: H.248 interaction to create conference connection resources for UE#1 + Note right of MRFC/AS: Invite users to conference + + Note right of MRFC/AS: H.248 interaction to modify conference connection resources for UE#1 + Note right of MRFC/AS: H.248 interaction to connect through conference connection resources for UE#1 + + Note left of P-CSCF: Authorize QoS resources + Note left of P-CSCF: Resource Reservation + Note left of P-CSCF: Approval of QoS Commit + + UE#1->>P-CSCF: 1. INVITE + P-CSCF-->>UE#1: 2. 100 Trying + P-CSCF->>S-CSCF: 3. INVITE + S-CSCF-->>P-CSCF: 4. 100 Trying + S-CSCF->>MRFC/AS: 6. INVITE + MRFC/AS-->>S-CSCF: 7. 100 Trying + MRFC/AS->>S-CSCF: 11. 183 Session Progress + S-CSCF-->>P-CSCF: 12. 183 Session Progress + P-CSCF->>UE#1: 14. 183 Session Progress + UE#1->>P-CSCF: 16. PRACK + P-CSCF->>S-CSCF: 17. PRACK + S-CSCF->>MRFC/AS: 18. PRACK + MRFC/AS-->>S-CSCF: 19. 200 OK + S-CSCF-->>P-CSCF: 21. 200 OK + P-CSCF-->>UE#1: 22. 200 OK + UE#1->>P-CSCF: 23. UPDATE + P-CSCF->>S-CSCF: 24. UPDATE + S-CSCF->>MRFC/AS: 25. UPDATE + MRFC/AS-->>S-CSCF: 26. 200 OK + S-CSCF-->>P-CSCF: 28. 200 OK + P-CSCF-->>UE#1: 29. 200 OK + S-CSCF-->>P-CSCF: 31. 200 OK + P-CSCF->>UE#1: 33. 200 OK + UE#1->>P-CSCF: 34. ACK + P-CSCF->>S-CSCF: 35. ACK + S-CSCF->>MRFC/AS: 36. ACK + +``` + +Sequence diagram showing the interaction between a User Equipment (UE#1) and various network elements (P-CSCF, S-CSCF, MRFC/AS, MRFP) for conference creation. The diagram is split into Visited Network and Home Network. The process involves INVITE, 100 Trying, 183 Session Progress, PRACK, 200 OK, UPDATE, and ACK messages, with internal steps for filter criteria evaluation, resource allocation, and H.248 interactions. + +**Figure A.3.6-1: User automatically creating a conference with a conference factory URI - MRFC/AS is located in user's home network** + +Figure A.3.6-1 shows an user creating a conference by using a conference-factory URI and simultaneouslt inviting some users to that conference. The conference is created at a MRFC/AS of the users home network. + +The details of the flows are as follows: + +#### **1. INVITE request (UE to P-CSCF) - see example in table A.3.6-1** + +A UE wants to create a conference. For this purpose the UE is aware of a conference-factory URI that was obtained by means outside the present document (e.g. due to pre-configuration or via other protocols, such as http). + +The UE wants also to invite some users to this conference in an expedite manner, avoiding the cumbersome manual invitation to each of these users. Thus it builds a URI list including the SIP URIs of the users that are to be invited and includes it in the message body of the INVITE request for conference creation. + +That the invited users have previously given consent to the inviting user to invite them. + +The UE determines the complete set of codecs that it is capable of supporting for this conference. It builds a SDP Offer containing bandwidth requirements and characteristics of each, and assigns local port numbers for each possible media flow. Multiple media flows can be offered, and for each media flow (m= line in SDP), there can be multiple codec choices offered. + +For this example, it is assumed that the UE is willing to establish a multimedia session comprising an audio stream only. The audio stream supports the AMR codec. The UE sends the INVITE request to the P-CSCF. + +The UE indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +The UE does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between UE and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +**Table A.3.6-1: INVITE request (UE to P-CSCF)** + +``` + +INVITE sip:conference-factory1@mrfcl.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree, recipient-list-invite +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu, 199 +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: multipart/mixed;boundary="boundary1" +Content-Length: (...) + +--boundary1 +Content-Type: application/sdp + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +--boundary1 +Content-Type: application/resource-lists+xml +Content-Disposition: recipient-list + + + + + + + + + +--boundary1-- + +``` + +**Request-URI:** contains the conference factory URI. + +**Content-Type:** contains the specification of the MIME content with the string used as part separator + +#### 2. 100 (Trying) response (P-CSCF to UE) - see example in table A.3.6-2 + +The P-CSCF responds to the INVITE request (1) with a 100 (Trying) provisional response. + +**Table A.3.6-2: 100 (Trying) response (P-CSCF to UE)** + +``` +SIP/2.0 100 Trying +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### 3. INVITE request (P-CSCF to S-CSCF) - see example in table A.3.6-3 + +The P-CSCF forwards the INVITE request to the S-CSCF. + +**Table A.3.6-3: INVITE request (P-CSCF to S-CSCF)** + +``` +INVITE sip:conference-factory1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +From: +To: +Call-ID: +Cseq: +Require: recipient-list-invite +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +--boundary1 +Content-Type: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= + +--boundary1 +Content-Type: +Content-Disposition: + + + +... + +--boundary1 +``` + +##### **4. 100 (Trying) response (S-CSCF to P-CSCF) - see example in table A.3.6-4** + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) provisional response. + +**Table A.3.6-4: 100 (Trying) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 100 Trying +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +##### **5. Evaluation of initial filter criteria** + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +##### 6. INVITE request (S-CSCF to MRFC/AS) - see example in table A.3.6-6 + +The S-CSCF forwards the INVITE request to the MRFC/AS that is indicated in the host part of the Request URI. The S-CSCF does not re-write the Request URI. + +**Table A.3.6-6: INVITE request (S-CSCF to MRFC/AS)** + +``` + +INVITE sip:conference-factory1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig- + ioi=typ3home1.net;orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +From: +To: +Call-ID: +Cseq: +Require: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +--boundary1 +Content-Type: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= + +--boundary1 +Content-Type: +Content-Disposition: + + + +... + +--boundary1 + +``` + +##### 7. 100 (Trying) response (MRFC/AS to S-CSCF) - see example in table A.3.6-7 (related to table A.3.6-6) + +The MRFC/AS responds to the INVITE request (6) with a 100 (Trying) provisional response. + +**Table A.3.6-7: 100 (Trying) response (MRFC/AS to S-CSCF)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 8. Allocate conference URI + +The MRFC/AS allocates a conference URI, based on local information and information gained from the conference-factory URI, as well as information gained from other elements of the SIP signalling. + +##### 9. H.248 interaction to create connection + +The MRFC initiates a H.248 interaction to create an IMS connection point for UE#1 in MRFP and to determine media capabilities of the MRFP. + +##### 10. Invite users to conference + +Once the conference URI is allocated the MRFC/AS checks that the users identified by the SIP URIs in the body of the INVITE request from UE#1 have consented to be invited by UE#1. Provided they have previously consented, the users identified by the SIP URIs in the body of the INVITE request from UE#1 are invited to join the conference. To do this the MRFC/AS follows the procedure shown in A.4.3.1.3 setting the Request-URI to the users: sip:user2\_public1@home1.net, sip:user3\_public1@home1.net and sip:user1\_public1@foreign.net. + +Notice that the three invitations would be sent simultaneously if the MRFC/AS does support it (see section 5.3.2.5.3). Notice also that it is not necessary that the MRFC/AS waits for the completion of the invitation procedures before continuing with step 11, i.e. the three invitations and the procedure being described in the present flow can run in parallel. + +##### 11. 183 (Session Progress) response (MRFC/AS to S-CSCF) - see example in table A.3.6-13 (related to table A.3.6-6) + +The MRFC determines the complete set of codecs that it is capable of supporting for this conference. It determines the intersection with those appearing in the SDP in the INVITE request. + +The media stream capabilities of the destination are returned along the signalling path, in a 183 (Session Progress) provisional response (to 6). + +**Table A.3.6-10: 183 (Session Progress) response (MRFC/AS to S-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: "Conference Server" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + orig-ioi=type3home1.net; term-ioi=home1.net; term-ioi=type3as1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Require: precondition, 100rel +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +RSeq: 9021 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933623 2987933623 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +- Contact:** Contains the IP address or FQDN of the MRFC/AS and a temporary identifier of the conference being created in the user part. The URI for the allocated conference is not indicated yet. The "isfocus" feature parameter is included, as this temporary contact is still a conference URI. +- P-Charging-Vector:** The MRFC/AS inserts this header and populates the icid parameters with a unique value and populates the term-ioi parameter with the identifier of its own network. +- P-Charging-Function-Address:** The MRFC/AS stores the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +##### 11. 183 (Session Progress) response (S-CSCF to P-CSCF) - see example in table A.3.6-11 + +The S-CSCF forwards the 183 (Session Progress) response to the P-CSCF. + +**Table A.3.6-11: 183 (Session Progress) response (S-CSCF to P-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2TrT5tAFrbHLso=023551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Contact: +Allow: +RSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +##### **12. Authorize QoS Resources** + +The P-CSCF authorizes the resources necessary for this session. The approval of QoS commitment either happens at this stage or after the 200 (OK) response of INVITE request (39) based on operator local policy. + +##### **13 183 (Session Progress) response (P-CSCF to UE) - see example in table A.3.6-13** + +The P-CSCF forwards the 183 (Session Progress) response to the originating endpoint. + +**Table A.3.6-13: 183 (Session Progress) response (P-CSCF to UE)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Contact: +Allow: +RSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +b= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +##### **14. Resource reservation** + +The originating UE sets up the bearer in accordance with the media description received SDP. + +##### **15. PRACK request (UE to P-CSCF) - see example in table A.3.6-15** + +The PRACK request does not carry SDP as the final codec decision is already made as part of the initial offer/answer exchange. + +**Table A.3.6-15: PRACK request (UE to P-CSCF)** + +``` + +PRACK sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , From: + ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +Require: precondition, sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; + port-c=8642; port-s=7531 +RAck: 9021 127 INVITE +Content-Length: 0 + +``` + +##### 16. PRACK request (P-CSCF to S-CSCF) - see example in table A.3.6-16 + +The P-CSCF forwards the PRACK request to the S-CSCF. + +**Table A.3.6-16: PRACK request (P-CSCF to S-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
PRACK sip:lmaa234269@mrfcl.home1.net SIP/2.0 Via: SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 69 P-Access-Network-Info: Route: <sip:scscf1.home1.net;lr> From: To: Call-ID: Cseq: Require: precondition RAck: Content-Length:
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 17. PRACK request (S-CSCF to MRFC/AS) - see example in table A.3.6-17 + +The S-CSCF forwards the PRACK request to the MRFC/AS. + +**Table A.3.6-17: PRACK request (S-CSCF to MRFC/AS)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
PRACK sip:lmaa234269@mrfcl.home1.net SIP/2.0 Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 68 P-Access-Network-Info: From: To: Call-ID: Cseq: Require: RAck: Content-Length:
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 18. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.6-18 (related to table A.3.6-17) + +The MRFC/AS acknowledges the PRACK request (17) with a 200 (OK) response. + +**Table A.3.6-18: 200 (OK) response (MRFC/AS to S-CSCF)** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 200 OK Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: Cseq: Content-Length: 0
| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 19. H.248 interaction to modify connection + +MRFC initiates a H.248 interaction to modify the connection established in step #9 and instructs MRFP to reserve the multimedia processing resources for UE#1 according to the preceding resource negotiation between the UE#1 and the MRFC. + +##### 20. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.6-20 + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.3.6-20: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### 21. 200 (OK) response (P-CSCF to UE) - see example in table A.3.6-21 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.3.6-21: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +##### 22. UPDATE request (UE to P-CSCF) - see example in table A.3.6-22 + +When the resource reservation is completed, the UE sends the UPDATE request to the MRFC/AS, via the signalling path established by the INVITE request. + +**Table A.3.6-22: UPDATE request (UE to P-CSCF)** + +``` +UPDATE sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +##### 23. UPDATE request (P-CSCF to S-CSCF) - see example in table A.3.6-23 + +The P-CSCF forwards the UPDATE request to the S-CSCF. + +**Table A.3.6-23: UPDATE request (P-CSCF to S-CSCF)** + +``` +UPDATE sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; +ggsn=[5555::4b4:3c3:2d2:1e1]; pdp-sig=no; gcid=723084371; auth-token=43876559; flow-id=3 +Route: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +### 24. UPDATE request (S-CSCF to MRFC/AS) - see example in table A.3.6-24 + +The S-CSCF forwards the UPDATE request to the MRFC/AS. + +**Table A.3.6-24: UPDATE request (S-CSCF to MRFC/AS)** + +``` +UPDATE sip:lmaa234269@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +P-Access-Network-Info: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +## 25. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.6-25 (related to table A.3.6-24) + +The MRFC/AS acknowledges the UPDATE request (24) with a 200 (OK) response. + +**Table A.3.6-25: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933625 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +The SDP indicates that the resource reservation was successful both in the local and the remote segment. + +## 26. H.248 interaction to modify connection + +MRFC initiates a H.248 interaction to connect through the multimedia processing resources for UE#1 in MRFP. + +## 27. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.6-27 + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.3.6-27: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +## 28. 200 (OK) response (P-CSCF to UE) - see example in table A.3.6-28 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.3.6-28: 200 (OK) response (P-CSCF to UE)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 200 OK Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 29. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.3.6-29 (related to table A.3.6-6) + +After the success modification of the session (26), the MRFC/AS sends a 200 (OK) response final response to the INVITE request (6) to the S-CSCF. + +**Table A.3.6-29: 200 (OK) response (MRFC/AS to S-CSCF)** + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 200 OK Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> From: To: Call-ID: CSeq: 127 INVITE Contact: <sip:conference1@mrfc1.home1.net>;isfocus Allow-Events: conference, pending-additions Content-Length:0
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Contact:** Contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**Allow-Events:** The MRFC/AS indicates support for the "conference" and "pending-additions" event packages + +### 30. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.3.6-30 + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to the P-CSCF. + +**Table A.3.6-30: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +### 31. Approval of QoS commit + +The P-CSCF approves the commitment of the QoS resources if it was not approved already in step (12). + +### 32. 200 (OK) response (P-CSCF to UE) - see example in table A.3.6-32 + +The P-CSCF forwards the 200 (OK) response final response to the session originator. The UE can start the media flow(s) for this session. + +**Table A.3.6-32: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +### 33. ACK request (UE to P-CSCF) - see example in table A.3.6-33 + +The UE starts the media flow for this session, and responds to the 200( OK) response (32) with an ACK request sent to the P-CSCF. + +**Table A.3.6-33: ACK request (UE to P-CSCF)** + +``` +ACK sip:conference1@mrfcl.home1.net:2342 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , From: + ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +**34. ACK request (P-CSCF to S-CSCF) - see example in table A.3.6-34** + +The P-CSCF forwards the ACK request to the S-CSCF. + +**Table A.3.6-34: ACK request (P-CSCF to S-CSCF)** + +``` +ACK sip:conference1@mrfc1.home1.net:2342 SIP/2.0 +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +**35. ACK request (S-CSCF to MRFC/AS) - see example in table A.3.6-35** + +The S-CSCF forwards the ACK request to the MRFC/AS. + +**Table A.3.6-35: ACK request (S-CSCF to MRFC/AS)** + +``` +ACK sip:conference1@mrfc1.home1.net:2342 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +--- + +## A.4 Flows demonstrating a user joining a conference + +### A.4.1 Introduction + +Void + +## A.4.2 User calling into a conference + +### A.4.2.1 MRFC/AS is not located in user's home network + +#### A.4.2.1.1 Conference URI resolved by the terminating home network + +![Sequence diagram showing the interaction between a User Equipment (UE#1) in a Visited Network and various network elements (P-CSCF, S-CSCF, I-CSCF, HSS, MRFC/AS, MRFP) in the UE#1 Home Network and MRFC/AS Home Network. The process involves INVITE, 100 Trying, Session Progress, PRACK, UPDATE, and ACK messages, with H.248 interactions for resource creation and modification.](901755bf86813427f3a32efa0363a27c_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant P-CSCF + participant S-CSCF + participant I-CSCF + participant HSS + participant MRFC/AS + participant MRFP + + Note left of UE#1: Visited Network + Note right of MRFP: MRFC/AS Home Network + Note right of S-CSCF: UE#1 Home Network + + UE#1->>P-CSCF: 1. INVITE + P-CSCF-->>UE#1: 2. 100 Trying + P-CSCF->>S-CSCF: 3. INVITE + S-CSCF-->>P-CSCF: 4. 100 Trying + S-CSCF->>S-CSCF: 5. Evaluation of initial Filter Criteria + S-CSCF->>I-CSCF: 6. INVITE + I-CSCF-->>S-CSCF: 7. 100 Trying + I-CSCF->>HSS: 8. PSI location query + I-CSCF->>MRFC/AS: 9. INVITE + MRFC/AS-->>I-CSCF: 10. 100 Trying + MRFC/AS->>MRFP: 11. H.248 interaction to create conference connection resources for UE#1 + MRFC/AS->>I-CSCF: 12. 183 Session Progress + I-CSCF->>S-CSCF: 13. 183 Session Progress + S-CSCF->>P-CSCF: 14. 183 Session Progress + P-CSCF->>P-CSCF: 15. Authorize QoS resources + P-CSCF->>UE#1: 16. 183 Session Progress + UE#1->>UE#1: 17. Resource Reservation + UE#1->>P-CSCF: 18. PRACK + P-CSCF->>S-CSCF: 19. PRACK + S-CSCF->>I-CSCF: 20. PRACK + I-CSCF->>MRFC/AS: 21. PRACK + MRFC/AS-->>I-CSCF: 22. 200 OK + MRFC/AS->>MRFP: 23. H.248 interaction to modify conference connection resources for UE#1 + MRFC/AS->>I-CSCF: 30. UPDATE + I-CSCF->>S-CSCF: 29. UPDATE + S-CSCF->>P-CSCF: 28. UPDATE + P-CSCF->>UE#1: 27. UPDATE + MRFC/AS-->>I-CSCF: 31. 200 OK + MRFC/AS->>MRFP: 32. H.248 interaction to connect through conference connection resources for UE#1 + MRFC/AS->>I-CSCF: 36. 200 OK + I-CSCF->>S-CSCF: 37. 200 OK + S-CSCF->>P-CSCF: 38. 200 OK + P-CSCF->>UE#1: 35. 200 OK + P-CSCF->>P-CSCF: 39. Approval of QoS Commit + P-CSCF->>UE#1: 40. 200 OK + UE#1->>P-CSCF: 41. ACK + P-CSCF->>S-CSCF: 42. ACK + S-CSCF->>I-CSCF: 43. ACK + I-CSCF->>MRFC/AS: 44. ACK + +``` + +Sequence diagram showing the interaction between a User Equipment (UE#1) in a Visited Network and various network elements (P-CSCF, S-CSCF, I-CSCF, HSS, MRFC/AS, MRFP) in the UE#1 Home Network and MRFC/AS Home Network. The process involves INVITE, 100 Trying, Session Progress, PRACK, UPDATE, and ACK messages, with H.248 interactions for resource creation and modification. + +**Figure A.4.2.1.1-1: User calling into a conference - network MRFC/AS is not located in user's home network - conference URI resolved by the terminating home network** + +Figure A.4.2.1.1-1 shows an user calling into a conference by using a conference URI. The focus of that conference is at a MRFC/AS which are located in another network. The conference URI in this example cannot be resolved by the originating home network. + +The details of the flows are as follows: + +#### 1. INVITE request (UE to P-CSCF) - see example in table A.4.2.1.1-1 + +A UE wants to join a conference. For this purpose the UE is aware of the related conference URI that was obtained by means outside the present document (e.g. via other protocols, such as http). + +The UE determines the complete set of codecs that it is capable of supporting for this conference. It builds a SDP Offer containing bandwidth requirements and characteristics of each, and assigns local port numbers for each possible media flow. Multiple media flows may be offered, and for each media flow (m= line in SDP), there may be multiple codec choices offered. + +For this example, it is assumed that UE#1 is willing to establish a multimedia session comprising a video stream and an audio stream. The video stream supports two codecs, either H.263 or MPEG-4 Visual. The audio stream supports the AMR codec. capable of sending two simultaneous video streams, either H261 or The UE sends the INVITE request to the P-CSCF. + +The UE indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +The UE does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between UE and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +**Table A.4.2.1.1-1: INVITE request (UE to P-CSCF)** + +``` + +INVITE sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99:MPVMP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** contains the conference URI. + +## 2. 100 (Trying) response (P-CSCF to UE) - see example in table A.4.2.1.1-2 + +The P-CSCF responds to the INVITE request (1) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.1-2: 100 (Trying) response (P-CSCF to UE)** + +``` +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +### 3. INVITE request (P-CSCF to S-CSCF) - see example in table A.4.2.1.1-3 + +The P-CSCF forwards the INVITE request to the S-CSCF. + +**Table A.4.2.1.1-3: INVITE request (P-CSCF to S-CSCF)** + +``` +INVITE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +``` + +**4. 100 (Trying) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.1-4** + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.1-4: 100 (Trying) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**5. Evaluation of initial filter criteria** + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +**6. INVITE request (S-CSCF to I-CSCF) - see example in table A.4.2.1.1-6** + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the INVITE request directly to the I-CSCF in the destination network. + +As the S-CSCF does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.4.2.1.1-6: INVITE request (S-CSCF to I-CSCF)** + +``` + +INVITE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +**7. 100 (Trying) response (I-CSCF to S-CSCF) - see example in table A.4.2.1.1-7 (related to table A.4.2.1.1-6)** + +The I-CSCF responds to the INVITE request (6) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.1-7: 100 (Trying) response (MRFC/AS to S-CSCF)** + +``` + +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +## 8. Public service identity (PSI) location query + +The I-CSCF sends a query to the HSS to find out the MRFC/AS at which the conference has been created. The HSS responds with the address of the MRFC/AS at which the conference is hosted. The HSS responds with the address of the MRFC/AS. + +For detailed message flows see 3GPP TS 29.228 [12]. + +Table A.4.2.1.1-8a provides the parameters in the SIP INVITE request, which are sent to the HSS. + +**Table A.4.2.1.1-8a Cx: User location query procedure (I-CSCF to HSS)** + +| Message source and destination | Cx: Information element name | Information source in SIP INVITE | Description | +|--------------------------------|-------------------------------|----------------------------------|-------------------------------------------------------------| +| I-CSCF to HSS | Public Service Identity (PSI) | Request-URI: | This information element indicates the public user identity | + +Table A.4.2.1.1-8b provides the parameters sent from the HSS that need to be mapped to SIP INVITE and sent to MRFC/AS. + +**Table A.4.2.1.1-8b Cx: User location query procedure (HSS to I-CSCF)** + +| Message source and destination | Cx: Information element name | Mapping to SIP header in SIP INVITE | Description | +|--------------------------------|------------------------------|-------------------------------------|------------------------------------------------------------------------------| +| HSS to I-CSCF | MRFC/AS address | IP packet destination address | This information element indicates the MRFC/AS address which serves the PSI. | + +## 9. INVITE request (I-CSCF to MRFC/AS) - see example in table A.4.2.1.1-9 + +I-CSCF forwards the INVITE request to the MRFC/AS that was resolved during the PSI location query (8). The I-CSCF does not re-write the Request URI. + +**Table A.4.2.1.1-9: INVITE request (I-CSCF to MRFC/AS)** + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
INVITE sip:conference1@home2.net SIP/2.0 Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP     scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 67 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net Privacy: From: To: Call-ID: CSeq: Supported: Contact: Allow: Accept: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**10. 100 (Trying) response (MRFC/AS to I-CSCF) - see example in table A.4.2.1.1-10 (related to table A.4.2.1.1-9)** + +The MRFC/AS responds to the INVITE request (9) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.1-10: 100 (Trying) response (MRFC/AS to I-CSCF)** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 100 (Trying) response Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP     scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 11. H.248 interaction to create conference connection resources for UE#1 + +MRFC initiates a H.248 interaction to create an connection point for UE#1 in MRFP. + +## 12. 183 (Session Progress) response (MRFC/AS to I-CSCF) - see example in table A.4.2.1.1-12 (related to table A.4.2.1.1-9) + +The media stream capabilities of the conference are returned along the signalling path, in a 183 (Session Progress) provisional response (to 9). + +**Table A.4.2.1.1-12: 183 (Session Progress) response (MRFC/AS to I-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: "Conference Server" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Require: precondition, 100rel +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +RSeq: 9021 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933623 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 10001 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MP4V-ES +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Contact:** Contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**P-Charging-Vector:** The MRFC/AS inserts this header and populates the icid parameters with an unique value and the terminating Inter Operator Identifier (IOI) for the home network of the MRFC/AS and puts back the originating IOI. + +**P-Charging-Function-Addresses:** The MRFC/AS populates the P-Charging-Function-Addresses header field to be passed to the I-CSCF. + +### 13. 183 (Session Progress) response (I-CSCF to S-CSCF) - see example in table A.4.2.1.1-13 + +The I-CSCF forwards the 183 (Session Progress) response to the S-CSCF. + +**Table A.4.2.1.1-13: 183 (Session Progress) response (I-CSCF to S-CSCF)** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net;     term-ioi=home2.net Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**14. 183 (Session Progress) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.1-14** + +The S-CSCF forwards the 183 (Session Progress) response to the P-CSCF. + +**Table A.4.2.1.1-14: 183 (Session Progress) response (S-CSCF to P-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22];     ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 15. Authorize QoS Resources + +The P-CSCF authorizes the resources necessary for this session. The approval of QoS commitment either happens at this stage or after 200 (OK) response of INVITE request (38) based on operator local policy. + +#### 16. 183 (Session Progress) response (P-CSCF to UE) - see example in table A.4.2.1.1-16 + +The P-CSCF forwards the 183 (Session Progress) response to the originating endpoint. + +**Table A.4.2.1.1-16: 183 (Session Progress) response (P-CSCF to UE)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net:7531;lr;comp=sigcomp> P-Asserted-Identity: Privacy: From: To: Call-ID: CSeq: Require: Contact: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 17. Resource reservation + +The originating UE sets up the bearer in accordance with the media description received SDP. + +#### 18. PRACK request (UE to P-CSCF) - see example in table A.4.2.1.1-18 + +The PRACK request does not carry SDP as the final codec decision is already made as part of the initial offer/answer exchange. + +**Table A.4.2.1.1-18: PRACK request (UE to P-CSCF)** + +``` + +PRACK sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +Require: precondition, sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +RAck: 9021 127 INVITE +Content-Length: 0 + +``` + +**Request-URI:** takes the value of the Contact header of the received 183 (Session Progress) response. + +#### 19. PRACK request (P-CSCF to S-CSCF) - see example in table A.4.2.1.1-19 + +The P-CSCF forwards the PRACK request to the S-CSCF. + +**Table A.4.2.1.1-19: PRACK request (P-CSCF to S-CSCF)** + +``` + +PRACK sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +Route: +From: +To: +Call-ID: +Cseq: +Require: precondition +RAck: +Content-Length: + +``` + +#### 20. PRACK request (S-CSCF to I-CSCF) - see example in table A.4.2.1.1-20 + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the PRACK request directly to the I-CSCF in the destination network. + +As the S-CSCF does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.4.2.1.1-20: PRACK request (S-CSCF to I-CSCF)** + +``` + +PRACK sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Require: +RAck: +Content-Length: + +``` + +## 21. PRACK request (I-CSCF to MRFC/AS) - see example in table A.4.2.1.1-21 + +I-CSCF forwards the PRACK request to the MRFC/AS that was resolved during the PSI location query (8). + +**Table A.4.2.1.1-21: PRACK request (I-CSCF to MRFC/AS)** + +``` +PRACK sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +From: +To: +Call-ID: +Cseq: +Require: +RAck: +Content-Length: +``` + +## 22. 200 (OK) response (MRFC/AS to I-CSCF) - see example in table A.4.2.1.1-22 (related to table A.4.2.1.1-21) + +The MRFC/AS acknowledges the PRACK request (21) with a 200 (OK) response. + +**Table A.4.2.1.1-22: 200 (OK) response (MRFC/AS to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## 23. H.248 interaction to modify connection for UE#1 + +MRFC initiates a H.248 interaction to modify the connection established in step #11 and instructs MRFP to reserve the multimedia processing resources for UE#1 according to the preceding resource negotiation between the UE#1 and the MRFC. + +## 24. 200 (OK) response (I-CSCF to S-CSCF) - see example in table A.4.2.1.1-24 + +The I-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.2.1.1-24: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**25. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.1-25** + +S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.2.1.1-25: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**26. 200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1.1-26** + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.4.2.1.1-26: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## 27. UPDATE request (UE to P-CSCF) - see example in table A.4.2.1.1-27 + +When the resource reservation is completed, the UE sends the UPDATE request to the MRFC/AS, via the signalling path established by the INVITE request. + +**Table A.4.2.1.1-27: UPDATE request (UE to P-CSCF)** + +``` + +UPDATE sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 0 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** takes the value of the Contact header of the received 183 (Session Progress) response. + +28. UPDATE request (P-CSCF to S-CSCF) - see example in table A.4.2.1.1-28 + +The P-CSCF forwards the UPDATE request to the S-CSCF. + +Table A.4.2.1.1-28: UPDATE request (P-CSCF to S-CSCF) + +``` + +UPDATE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; +ggsn=[5555::4b4:3c3:2d2:1e1]; pdp-sig=no; gcid=723084371; auth-token=43876559; flow-id=3 +Route: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +**29. UPDATE request (S-CSCF to I-CSCF) - see example in table A.4.2.1.1-29** + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the UPDATE request directly to the I-CSCF in the destination network. + +As the S-CSCF does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.4.2.1.1-29: UPDATE request (S-CSCF to I-CSCF)** + +``` +UPDATE sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +``` + +30. UPDATE request (I-CSCF to MRFC/AS) - see example in table A.4.2.1.1-30 + +I-CSCF forwards the UPDATE request to the MRFC/AS that was resolved during the PSI location query (8). The I-CSCF does not re-write the Request URI. + +Table A.4.2.1.1-30: UPDATE request (I-CSCF to MRFC/AS) + +``` + +UPDATE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= + +``` + +**31. 200 (OK) response (MRFC/AS to I-CSCF) - see example in table A.4.2.1.1-31 (related to table A.4.2.1.1-30)** + +The MRFC/AS acknowledges the UPDATE request (30) with a 200 (OK) response. + +**Table A.4.2.1.1-31: 200 (OK) response (MRFC/AS to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933623 2987933625 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +The SDP indicates that the resource reservation was successful both in the local and the remote segment. + +**32. H.248 interaction to modify connection** + +MRFC initiates a H.248 interaction to connect through the multimedia processing resources for UE#1 in MRFP. + +33. 200 (OK) response (I-CSCF to S-CSCF) - see example in table A.4.2.1.1-31 + +The I-CSCF forwards the 200 (OK) response to the S-CSCF. + +Table A.4.2.1.1-31: 200 (OK) response (I-CSCF to S-CSCF) + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +**34. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.1-34** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.2.1.1-34: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +### 35. 200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1.1-35 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.4.2.1.1-35: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +``` + +### 36. 200 (OK) response (MRFC/AS to I-CSCF) - see example in table A.4.2.1.1-36 (related to table A.4.2.1.1-9) + +After the success modification of the session (32), the MRFC/AS sends a 200 (OK) response final response to the INVITE request (9) to the I-CSCF. + +**Table A.4.2.1.1-36: 200 (OK) response (MRFC/AS to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: 127 INVITE +Contact: ;isfocus +Allow-Events: conference, pending-additions +Content-Length:0 +``` + +**Contact:** contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**Allow-Events:** The MRFC/AS indicates support for the "conference" and "pending-additions" event packages + +**37. 200 (OK) response (I-CSCF to S-CSCF) - see example in table A.4.2.1.1-37** + +The I-CSCF sends a 200 (OK) response final response along the signalling path back to the S-CSCF. + +**Table A.4.2.1.1-37: 200 (OK) response (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +**38. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.1-38** + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to the P-CSCF. + +**Table A.4.2.1.1-38: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +**39. Approval of QoS commit** + +The P-CSCF approves the commitment of the QoS resources if it was not approved already in step (15). + +**40. 200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1.1-40** + +The P-CSCF forwards the 200 (OK) response final response to the session originator. The UE can start the media flow(s) for this session. + +**Table A.4.2.1.1-40: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +**41. ACK request (UE to P-CSCF) - see example in table A.4.2.1.1-41** + +The UE starts the media flow for this session, and responds to the 200( OK) response (40) with an ACK request sent to the P-CSCF. + +**Table A.4.2.1.1-41: ACK request (UE to P-CSCF)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +**42. ACK request (P-CSCF to S-CSCF) - see example in table A.4.2.1.1-42** + +The P-CSCF forwards the ACK request to the S-CSCF. + +**Table A.4.2.1.1-42: ACK request (P-CSCF to S-CSCF)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +**43. ACK request (S-CSCF to I-CSCF) - see example in table A.4.2.1.1-43** + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the ACK request directly to the I-CSCF in the destination network. + +As the S-CSCF does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.4.2.1.1-43: ACK request (S-CSCF to I-CSCF)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +**44. ACK request (I-CSCF to MRFC/AS) - see example in table A.4.2.1.1-44** + +I-CSCF forwards the ACK request to the MRFC/AS that was resolved during the PSI location query (8). The I-CSCF does not re-write the Request URI. + +**Table A.4.2.1.1-44: ACK request (I-CSCF to MRFC/AS)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### A.4.2.1.2 Conference URI can be resolved by the originating home network + +![Sequence diagram showing the interaction between UE#1, P-CSCF, S-CSCF, MRFC/AS, and MRFP across three networks: Visited Network, UE#1 Home Network, and MRFC/AS Home Network. The process involves INVITE, 100 Trying, Session Progress, PRACK, 200 OK, UPDATE, and ACK messages, with internal steps for filter criteria evaluation, H.248 resource creation/modification, and QoS authorization.](737abf1e655afd3324b6b3987945d913_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant P-CSCF + participant S-CSCF + participant MRFC/AS + participant MRFP + + Note left of UE#1: Visited Network + Note left of S-CSCF: UE#1 Home Network + Note left of MRFC/AS: MRFC/AS Home Network + + UE#1->>P-CSCF: 1. INVITE + P-CSCF-->>UE#1: 2. 100 Trying + P-CSCF->>S-CSCF: 3. INVITE + S-CSCF-->>P-CSCF: 4. 100 Trying + S-CSCF->>S-CSCF: 5. Evaluation of initial Filter Criteria + S-CSCF->>MRFC/AS: 6. INVITE + MRFC/AS-->>S-CSCF: 7. 100 Trying + MRFC/AS->>MRFP: 8. H.248 interaction to create conference connection resources for UE#1 + MRFC/AS->>S-CSCF: 9. 183 Session Progress + S-CSCF->>P-CSCF: 10. 183 Session Progress + P-CSCF->>P-CSCF: 11. Authorize QoS resources + P-CSCF->>UE#1: 12. 183 Session Progress + UE#1->>UE#1: 13. Resource Reservation + UE#1->>P-CSCF: 14. PRACK + P-CSCF->>S-CSCF: 15. PRACK + S-CSCF->>MRFC/AS: 16. PRACK + MRFC/AS-->>S-CSCF: 17. 200 OK + MRFC/AS->>MRFP: 18. H.248 interaction to modify conference connection resources for UE#1 + S-CSCF-->>P-CSCF: 19. 200 OK + UE#1-->>P-CSCF: 20. 200 OK + UE#1->>P-CSCF: 21. UPDATE + P-CSCF->>S-CSCF: 22. UPDATE + S-CSCF->>MRFC/AS: 23. UPDATE + MRFC/AS-->>S-CSCF: 24. 200 OK + MRFC/AS->>MRFP: 25. H.248 interaction to connect through conference connection resources for UE#1 + MRFC/AS-->>S-CSCF: 28. 200 OK + S-CSCF-->>P-CSCF: 29. 200 OK + P-CSCF->>P-CSCF: 30. Approval of QoS Commit + UE#1-->>P-CSCF: 31. 200 OK + UE#1->>P-CSCF: 32. ACK + P-CSCF->>S-CSCF: 33. ACK + S-CSCF->>MRFC/AS: 34. ACK + +``` + +Sequence diagram showing the interaction between UE#1, P-CSCF, S-CSCF, MRFC/AS, and MRFP across three networks: Visited Network, UE#1 Home Network, and MRFC/AS Home Network. The process involves INVITE, 100 Trying, Session Progress, PRACK, 200 OK, UPDATE, and ACK messages, with internal steps for filter criteria evaluation, H.248 resource creation/modification, and QoS authorization. + +**Figure A.4.2.1.2-1: User calling into a conference - MRFC/AS is not located in user's home network - conference URI can be resolved by the originating home network** + +Figure A.4.2.1.2-1 shows an user calling into a conference by using a conference URI. The focus of that conference is at a MRFC/AS which are located in another network. The conference URI in this example can be resolved by the originating home network. + +The details of the flows are as follows: + +##### 1. INVITE request (UE to P-CSCF) - see example in table A.4.2.1.2-1 + +A UE wants to join a conference. For this purpose the UE is aware of the related conference URI that was obtained by means outside the present document. + +The UE determines the complete set of codecs that it is capable of supporting for this conference. It builds a SDP Offer containing bandwidth requirements and characteristics of each, and assigns local port numbers for + +each possible media flow. Multiple media flows may be offered, and for each media flow (m= line in SDP), there may be multiple codec choices offered. + +For this example, it is assumed that UE#1 is willing to establish a multimedia session comprising a video stream and an audio stream. The video stream supports two codecs, either H.263 or MPEG-4 Visual. The audio stream supports the AMR codec. + +The UE indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +The UE does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between UE and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +**Table A.4.2.1.2-1: INVITE request (UE to P-CSCF)** + +``` + +INVITE sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu, 199 +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99:MP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** contains the conference URI. + +## 2. 100 (Trying) response (P-CSCF to UE) - see example in table A.4.2.1.2-2 + +The P-CSCF responds to the INVITE request (1) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.2-2: 100 (Trying) response (P-CSCF to UE)** + +``` +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +### 3. INVITE request (P-CSCF to S-CSCF) - see example in table A.4.2.1.2-3 + +The INVITE request is forwarded to the S-CSCF. + +**Table A.4.2.1.2-3: INVITE request (P-CSCF to S-CSCF)** + +``` +INVITE sip:conference1@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +``` + +**4. 100 (Trying) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.2-4** + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.2-4: 100 (Trying) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**5. Evaluation of initial filter criteria** + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +**6. INVITE request (S-CSCF to MRFC/AS) - see example in table A.4.2.1.2-6** + +S-CSCF forwards the INVITE request to the MRFC/AS based on the Request URI of the INVITE request. The S-CSCF does not re-write the Request URI. + +**Table A.4.2.1.2-6: INVITE request (S-CSCF to MRFC/AS)** + +``` + +INVITE sip:conference1@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +7. 100 (Trying) response (MRFC/AS to S-CSCF) - see example in table A.4.2.1.2-7 (related to table A.4.2.1.2-6) + +The MRFC/AS responds to the INVITE request (6) with a 100 (Trying) response provisional response. + +**Table A.4.2.1.2-7: 100 (Trying) response (MRFC/AS to S-CSCF)** + +``` + +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +- ## 8. H.248 interaction to create conference connection resources for UE#1 + +MRFC initiates a H.248 interaction to create an connection point for UE#1 in MRFP. + +9. 183 (Session Progress) response (MRFC/AS to S-CSCF) - see example in table A.4.2.1.2-9 (related to table A.4.2.1.2-6) + +The media stream capabilities of the conference are returned along the signalling path, in a 183 (Session Progress) provisional response (to 6). + +**Table A.4.2.1.2-9: 183 (Session Progress) response (MRFC/AS to S-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: "Conference Server" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Require: precondition, 100rel +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +RSeq: 9021 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933623 2987933623 IN IP6 5555::1111:2222:3333:4444 +s=- +c=IN IP6 5555::1111:2222:3333:4444 +t=0 0 +m=video 10001 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MP4V-ES +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +- Contact:** Contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. +- P-Charging-Vector:** The MRFC/AS inserts this header and populates the icid parameters with an unique value and the terminating Inter Operator Identifier (IOI) for the home network of the MRFC/AS and puts back the originating IOI. +- P-Charging-Function-Addresses:** The MRFC/AS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +### 10. 183 (Session Progress) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.2-10 + +The S-CSCF forwards the 183 (Session Progress) response to the P-CSCF. + +**Table A.4.2.1.2-10: 183 (Session Progress) response (S-CSCF to P-CSCF)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP     [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: P-Asserted-Identity: P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22];     ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 11. Authorize QoS Resources + +The P-CSCF authorizes the resources necessary for this session. The approval of QoS commitment either happens at this stage or after 200( OK) response to the INVITE request (30) based on operator local policy. + +12. 183 (Session Progress) response (P-CSCF to UE) - see example in table A.4.2.1.2-12 + +The P-CSCF forwards the 183 (Session Progress) response to the originating endpoint. + +**Table A.4.2.1.2-12: 183 (Session Progress) response (P-CSCF to UE)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Contact: +RSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= + +``` + +### 13. Resource reservation + +The originating UE sets up the bearer in accordance with the media description received SDP. + +#### 14. PRACK request (UE to P-CSCF) - see example in table A.4.2.1.2-14 + +The PRACK request does not carry SDP as the final codec decision is already made as part of the initial offer/answer exchange. + +**Table A.4.2.1.2-14: PRACK request (UE to P-CSCF)** + +``` + +PRACK sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +Require: precondition, sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +RAck: 9021 127 INVITE +Content-Length: 0 + +``` + +**Request-URI:** takes the value of the Contact header of the received 183 (Session Progress) response. + +### 15. PRACK request (P-CSCF to S-CSCF) - see example in table A.4.2.1.2-15 + +The P-CSCF forwards the PRACK request to the S-CSCF. + +**Table A.4.2.1.2-15: PRACK request (P-CSCF to S-CSCF)** + +``` + +PRACK sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +Route: +From: +To: +Call-ID: +Cseq: +Require: precondition +RAck: +Content-Length: + +``` + +### 16. PRACK request (S-CSCF to MRFC/AS) - see example in table A.4.2.1.2-16 + +S-CSCF forwards the PRACK request to the MRFC/AS based on the Request URI of the PRACK request. The S-CSCF does not re-write the Request URI. + +**Table A.4.2.1.2-16: PRACK request (S-CSCF to MRFC/AS)** + +``` + +PRACK sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Require: +RAck: +Content-Length: + +``` + +**17. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.4.2.1.2-17 (related to table A.4.2.1.2-16)** + +The MRFC/AS acknowledges the PRACK request (16) with a 200 (OK) response. + +**Table A.4.2.1.2-17: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**18. H.248 interaction to modify connection for UE#1** + +MRFC initiates a H.248 interaction to modify the connection established in step #11 and instructs MRFP to reserve the multimedia processing resources for UE#1 according to the preceding resource negotiation between the UE#1 and the MRFC. + +**19. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.2-19** + +S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.2.1.2-19: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**20. 200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1.2-20** + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.4.2.1.2-20: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## 21. UPDATE request (UE to P-CSCF) - see example in table A.4.2.1.2-21 + +When the resource reservation is completed, the UE sends the UPDATE request to the MRFC/AS, via the signalling path established by the INVITE request. + +**Table A.4.2.1.2-21: UPDATE request (UE to P-CSCF)** + +``` + +UPDATE sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** takes the value of the Contact header of the received 183 (Session Progress) response. + +22. UPDATE request (P-CSCF to S-CSCF) - see example in table A.4.2.1.2-22 + +The P-CSCF forwards the UPDATE request to the S-CSCF. + +Table A.4.2.1.2-22: UPDATE request (P-CSCF to S-CSCF) + +``` + +UPDATE sip:conference1@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; + ggsn=[5555::4b4:3c3:2d2:1e1]; pdp-sig=no; gcid=723084371; auth-token=43876559; flow-id=3 +Route: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +23. UPDATE request (S-CSCF to MRFC/AS) - see example in table A.4.2.1.2-23 + +S-CSCF forwards the UPDATE request to the MRFC/AS based on the Request URI of the UPDATE request. The S-CSCF does not re-write the Request URI. + +Table A.4.2.1.2-23: UPDATE request (S-CSCF to MRFC/AS) + +``` + +UPDATE sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= + +``` + +**24. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.4.2.1.2-24 (related to table A.4.2.1.2-23)** + +The MRFC/AS acknowledges the UPDATE request (23) with a 200 (OK) response. + +**Table A.4.2.1.2-24: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933623 2987933625 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +The SDP indicates that the resource reservation was successful both in the local and the remote segment. + +**25. H.248 interaction to modify connection** + +MRFC initiates a H.248 interaction to connect through the multimedia processing resources for UE#1 in MRFP. + +**26. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.2-26** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.2.1.2-26: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +27. 200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1.2-27 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.4.2.1.2-27: 200 (OK) response (P-CSCF to UE)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 200 OK Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a=
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +28. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.4.2.1.2-28 (related to table A.4.2.1.2-7) + +After the success modification of the session (25), the MRFC/AS sends a 200 (OK) response final response to the INVITE request (6) to the I-CSCF. + +**Table A.4.2.1.2-28: 200 (OK) response (MRFC/AS to S-CSCF)** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 200 OK Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP   pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP   [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Record-Route: <sip:scscf1.home1.net;lr>, <sip:pcscf1.visited1.net;lr> From: To: Call-ID: CSeq: 127 INVITE Contact: <sip:conference1@mrfc2.home2.net>;isfocus Allow-Events: conference, pending-additions Content-Length:0
| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Contact:** contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**Allow-Events:** The MRFC/AS indicates support for the "conference" and "pending-additions" event packages + +## 29. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.2.1.2-29 + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to the P-CSCF. + +**Table A.4.2.1.2-29: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +## 30. Approval of QoS commit + +The P-CSCF approves the commitment of the QoS resources if it was not approved already in step (14). + +## 31. 200 (OK) response (P-CSCF to UE) - see example in table A.4.2.1.2-31 + +The P-CSCF forwards the 200 (OK) response final response to the session originator. The UE can start the media flow(s) for this session. + +**Table A.4.2.1.2-31: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Content-Length: +``` + +## 32. ACK request (UE to P-CSCF) - see example in table A.4.2.1.2-32 + +The UE starts the media flow for this session, and responds to the 200 (OK) response (31) with an ACK request sent to the P-CSCF. + +**Table A.4.2.1.2-32: ACK request (UE to P-CSCF)** + +``` +ACK sip:conference1@mrfc2.home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +**Cseq:** is required to be the same value as Cseq contained in original INVITE request (3). + +### 33. ACK request (P-CSCF to S-CSCF) - see example in table A.4.2.1.2-33 + +The P-CSCF forwards the ACK request to the S-CSCF. + +**Table A.4.2.1.2-33: ACK request (P-CSCF to S-CSCF)** + +``` +ACK sip:conference1@mrfc2.home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +### 34. ACK request (S-CSCF to MRFC/AS) - see example in table A.4.2.1.2-34 + +S-CSCF forwards the ACK request to the MRFC/AS based on the Request URI of the ACK request. The S-CSCF does not re-write the Request URI. + +**Table A.4.2.1.2-34: ACK request (S-CSCF to MRFC/AS)** + +``` +ACK sip:conference1@mrfc2.home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +## A.4.3 User getting invited to a conference + +### A.4.3.1 MRFC/AS is not located in user's home network + +#### A.4.3.1.1 Conference Participant referring another user to a conference + +Figure A.4.3.1.1-1 shows how UE#1 refers UE#2 to a conference. UE#1 has created a conference by using the mechanisms described in subclause 6.2, and UE#1 has learned the conference URI that identifies this conference. + +![Sequence diagram showing a REFER request flow between two lifelines. The first lifeline sends a REFER request to the second lifeline. The second lifeline responds with a message, and the first lifeline replies. A return message is also shown from the second lifeline to the first.](b13465efdac63129aef9b6f1787d0d00_img.jpg) + +``` +sequenceDiagram + participant UE1 + participant UE2 + Note right of UE1: [ ] + UE1->>UE2: REFER request + Note right of UE2: [ ] + UE2-->>UE1: Response + Note right of UE1: [ ] + UE1-->>UE2: Reply + Note right of UE2: [ ] + UE2-->>UE1: Return +``` + +Sequence diagram showing a REFER request flow between two lifelines. The first lifeline sends a REFER request to the second lifeline. The second lifeline responds with a message, and the first lifeline replies. A return message is also shown from the second lifeline to the first. + +**Figure A.4.3.1.1-1: User inviting another user to a conference by sending a REFER request to the other user** + +The details of the flows are as follows: + +**1. UE#1 creates a conference** + +UE#1 creates a conference as described in subclause 6.3.2. Once the conference creation is accomplished, UE#1 has learned the conference URI allocated for this conference. + +## 2. REFER request (UE to P-CSCF) - see example in table A.4.3.1.1-2 + +A UE has created a conference and learned the conference URI. Now the UE wants to invite another UE to that conference. + +**Table A.4.3.1.1-2: REFER request (UE to P-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 REFER +Require: sec-agree +Refer-To: +Referred-By: +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Content-Length: 0 +``` + +**Request-URI:** contains the public user identity of UE#2. + +**Via:** contains the IP address or FQDN of the originating UE. + +**Refer-To:** contains the conference URI as learned during the conference establishment. Additionally the "method" uri parameter indicates that the other user is requested to send an INVITE request to this conference URI. + +**Referred-By:** contains the public user identity of the referring user, as in this example the referring user has decided to indicate its own identity to the referred user. + +## 3. REFER request (P-CSCF to S-CSCF) - see example in table A.4.3.1.1-3 + +The P-CSCF forwards the REFER request to the S-CSCF. + +**Table A.4.3.1.1-3: REFER request (P-CSCF to S-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Access-Network-Info: +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Supported: +Contact: +Content-Length: +``` + +## 4. Evaluation of initial Filter Criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +## 5. REFER request (S-CSCF to I-CSCF in UE#2 home network) - see example in table A.4.3.1.1-5 + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the REFER request directly to the destination network. + +**Table A.4.3.1.1-5: REFER request (S-CSCF to I-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Supported: +Contact: +Content-Length: +``` + +**6. REFER request (I-CSCF towards S-CSCF of UE#2) - see example in table A.4.3.1.1-6** + +The I-CSCF performs a Cx location query to the HSS (not shown in this flow) to find out the S-CSCF of UE#2. + +The I-CSCF then forwards the REFER request to that S-CSCF that will handle the session termination. + +**Table A.4.3.1.1-6: REFER request (I-CSCF towards S-CSCF of UE#2)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +Route: +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Supported: +Contact: +Content-Length: +``` + +## 7. 200 (OK) response to REFER (S-CSCF of UE#2 to I-CSCF) - see example in table A.4.3.1.1-7 + +UE#2 home network indicates that it has received the REFER request by sending a 200 (OK) response. This means that UE#2 home network has begun to process the request. This does not mean, however, that the referred-to resource would have been contacted. + +**Table A.4.3.1.1-7: 200 (OK) response to REFER (S-CSCF of UE#2 to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Asserted-Identity: "John Smith" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; icid-generated- + at=[5555::f5f:e4e:d3d:c2c]; orig-ioi=home1.net; term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy:none +From: ;tag=171828 +To: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 127 REFER +Contact:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- + ad76cc7fc74;comp=sigcomp> +Content-Length:0 +``` + +## 8. 200 (OK) response to REFER (I-CSCF to S-CSCF) - see example in table A.4.3.1.1-8 + +The I-CSCF forwards the response to the S-CSCF. + +**Table A.4.3.1.1-8: 200 (OK) response to REFER (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024";; orig-ioi=home1.net; + term-ioi=home2.net +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +## 9. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.3.1.1-9 + +The S-CSCF forwards the response to the P-CSCF. + +**Table A.4.3.1.1-9: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +## 10. 200 (OK) response to REFER (P-CSCF to UE#1) - see example in table A.4.3.1.1-10 + +The P-CSCF forwards the response to the UE. + +**Table 6.3.3.1-10: 200 (OK) response to REFER (P-CSCF to UE#1)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length:0 +``` + +## 11. NOTIFY request (from S-CSCF of UE#2 to S-CSCF) - see example in table A.4.3.1.1-11 + +S-CSCF receives a NOTIFY request corresponding the REFER request. The NOTIFY request contains information about the progress of the REFER request processing. The body of the NOTIFY request contains a fragment of the response as received by the notifying UE for the request that was initiated due to the REFER request. The NOTIFY request is forwarded to the P-CSCF. + +**Table A.4.3.1.1-11: NOTIFY request (from S-CSCF of UE#2 to S-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch= z9hG4bK764z87.1, SIP/2.0/UDP + scscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home2.net +Max-Forwards: 68 +Route: , +Record-Route: , +To: ;tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 42 NOTIFY +Subscription-State: active;expires:7200 +Event: refer +Contact: +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 100 (Trying) response +``` + +## 12. NOTIFY request (from S-CSCF to P-CSCF) - see example in table A.4.3.1.1-12 + +The S-CSCF forwards the message to the P-CSCF. + +**Table: A.4.3.1.1-12: NOTIFY request (from S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Max-Forwards: 67 +Route: +Record-Route: , , + +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 13. NOTIFY request (from P-CSCF to UE#1) - see example in table A.4.3.1.1-13 + +The P-CSCF forwards the message to UE#1. + +**Table A.4.3.1.1-13: NOTIFY request (from P-CSCF to UE#1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 66 +Record-Route: , , + , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +#### 14. 200 (OK) response (UE to P-CSCF) - see example in table A.4.3.1.1-14 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.4.3.1.1-14: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: , , + , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 15. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.1-15 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.1-15: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 16. 200 (OK) response (S-CSCF to S-CSCF of UE#2) - see example in table A.4.3.1.1-16 + +The S-CSCF forwards the 200 (OK) response to the S-CSCF of UE#2 according to the information in the Via field. + +**Table A.4.3.1.1-16: 200 (OK) response (S-CSCF to S-CSCF of UE#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 17. UE#2 joins the conference. + +UE#2 joins the conference. The message flows are depicted in subclause 6.3.2. + +## 18. NOTIFY request (from S-CSCF of UE#2 to S-CSCF) - see example in table A.4.3.1.1-18 + +S-CSCF receives a NOTIFY request corresponding the REFER request. + +**Table A.4.3.1.1-18: NOTIFY request (from S-CSCF of UE#2 to S-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home2.net +Max-Forwards: 68 +Route: , +Record-Route: , +To: ; tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 43 NOTIFY +Subscription-State: terminated +Event: refer +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 200 OK +``` + +**Subscription-State:** indicates that the implicit subscription to the refer event has been terminated. + +## 19. NOTIFY request (from S-CSCF to P-CSCF) - see example in table A.4.3.1.1-19 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.4.3.1.1-19: NOTIFY request (from S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Max-Forwards: 67 +Route: +Record-Route: , , + +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 20. NOTIFY request (from P-CSCF to UE#1) - see example in table A.4.3.1.1-20 + +The P-CSCF forwards the NOTIFY request to UE#1. + +**Table A.4.3.1.1-20: NOTIFY request (from P-CSCF to UE#1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pscsf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 66 +Record-Route: , , + , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 21. 200 (OK) response (UE to P-CSCF) - see example in table A.4.3.1.1-21 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.4.3.1.1-21: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: , , + , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## 22. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.1-22 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.1-22: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## 23. 200 (OK) response (S-CSCF to S-CSCF of UE#2) - see example in table A.4.3.1.1-23 + +The S-CSCF forwards the 200 (OK) response to the home network of UE#2 according to the information in the Via field. + +Table A.4.3.1.1-23: 200 (OK) response (S-CSCF to S-CSCF of UE#2) + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## A.4.3.1.2 User getting referred to a conference by a conference participant + +Figure A.4.3.1.2-1 shows how UE#2 gets referred to a conference by receiving a REFER request from a conference participant. The REFER request contains the conference URI where UE#2 should use when joining the conference. + +![Sequence diagram showing the interaction between a User Equipment (UE) and a Conference Participant to refer the UE to a conference via a REFER request.](1ec8205c17ab05d4670ab9d41b572ec7_img.jpg) + +The diagram illustrates a sequence of messages between two main entities: a Conference Participant (top) and a User Equipment (UE) (bottom). The interaction begins with the Conference Participant sending a REFER request to the UE. The UE responds with a 200 OK message. The Conference Participant then sends a subsequent message, likely a re-REFER or a notification, which the UE acknowledges. The diagram uses vertical lines to represent the lifelines of the participants and horizontal arrows to show the flow of messages. There are also some internal messages or processing steps indicated by self-arrows on the lifelines. + +Sequence diagram showing the interaction between a User Equipment (UE) and a Conference Participant to refer the UE to a conference via a REFER request. + +Figure A.4.3.1.2-1: User getting invited to a conference by receiving a REFER request. + +The details of the flows are as follows: + +**1. REFER request (S-CSCF of UE#1 to I-CSCF) - see example in table A.4.3.1.2-1** + +REFER request is sent by the S-CSCF of UE#1 to UE#2 home network. S-CSCF of UE#1 has resolved the address of I-CSCF as the entry point to UE#2 home network. See subclause 6.3.3.1.1 for originating side of the call flow. + +**Table A.4.3.1.2-1: REFER request (S-CSCF of UE#1 to I-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-loi=home1.net +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 REFER +Refer-To: +Referred-By: +Supported: gruu +Contact: +Content-Length: 0 +``` + +**Request-URI:** contains the public user identity of UE#2. + +**Refer-To:** contains the conference URI as learned during the conference establishment. Additionally the "method" uri parameter indicates that the other user is requested to send an INVITE request to this conference URI. + +**Referred-By:** contains the public user identity of the referring user, as in this example the referring user has decided to indicate its own identity to the referred user. + +**2. The I-CSCF performs HSS query** + +The I-CSCF performs HSS query to find out the S-CSCF serving UE#2. + +### 3. REFER request (I-CSCF to S-CSCF) - see example in table A.4.3.1.2-3 + +After finding out the S-CSCF assigned to UE#2, the I-CSCF forwards the REFER request to that S-CSCF. The I-CSCF does not add itself to the Record-route since it does not have to remain on the signalling path for subsequent requests within the same dialog. + +**Table A.4.3.1.2-3: REFER request (I-CSCF to S-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +Record-Route: +Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By +Supported: +Contact: +Content-Length: + +(...) +``` + +### 4. Evaluation of initial Filter Criteria + +The S-CSCF validates the service profile of this subscriber, and evaluates the initial Filter Criteria. + +### 5. REFER request (S-CSCF to P-CSCF) - see example in table A.4.3.1.2-5 + +The S-CSCF remembers (from registration procedures) the contact address of UE#2 and determines the P-CSCF assigned for UE#2 and routes the REFER request there. + +**Table A.4.3.1.2-5: REFER request (S-CSCF to P-CSCF)** + +``` +REFER sip:[5555::eeee:ffff:aaaa:bbbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +Record-Route: , , + +Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Charging Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Supported: +Contact: +P-Called-Party-ID: +Content-Length: + +(...) +``` + +## 6. REFER request (P-CSCF to UE#2) - see example in table A.4.3.1.2-6 + +The P-CSCF forwards the request to UE#2. + +**Table A.4.3.1.2-6: REFER request (P-CSCF to UE#2)** + +``` +REFER sip:[5555::eeee:ffff:aaaa:bbbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK249354.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 65 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Supported: +Contact: +P-Called-Party-ID: +Content-Length: + +(...) +``` + +## 7. 200 (OK) response to REFER (UE#2 to P-CSCF) - see example in table A.4.3.1.2-7 + +UE#2 accepts the REFER request by sending a 200 (OK) response. + +**Table A.4.3.1.2-7: 200 (OK) response to REFER (UE#2 to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK249354.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy=none +From: +To: ;tag=151170 +Call-ID: +CSeq: +Contact: +Content-Length:0 +``` + +## 8. 200 (OK) response to REFER (P-CSCF to S-CSCF) - see example in table A.4.3.1.2-8 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.2-8: 200 (OK) response to REFER (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Asserted-Identity: "John Smith" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home2.net + term-ioi=visited2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length:0 +``` + +## 10. 200 (OK) response to REFER (I-CSCF to UE#1 home network) - see example in table A.4.3.1.2-10 + +The I-CSCF forwards the 200 (OK) response to S-CSCF of UE#1. + +**Table A.4.3.1.2-10: 200 (OK) response to REFER (I-CSCF to S-CSCF of UE#1)** + +``` +SIP/2.0 200 OK +Via: scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home2.net + term-ioi=visited2.net +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length:0 +``` + +## 11. NOTIFY request (from UE#2 to P-CSCF) - see example in table A.4.3.1.2-11 + +UE#2 creates a subscription and sends a notification of the status of the refer event. + +**Table A.4.3.1.2-11: NOTIFY request (from UE#2 to P-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 70 +Route: , , , + +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +To: ;tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 42 NOTIFY +Subscription-State: active;expires:7200 +Event: refer +Contact: +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 100 (Trying) response +``` + +## 12. NOTIFY request (from P-CSCF to S-CSCF) - see example in table A.4.3.1.2-12 + +The P-CSCF forwards the NOTIFY request to the S-CSCF. + +**Table: A.4.3.1.2-12: NOTIFY request (from P-CSCF to S-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +Route: , , +Record-Route: +P-Access-Network-Info: +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 13. NOTIFY request (from S-CSCF to UE#1 home network) - see example in table A.4.3.1.2-13 + +The S-CSCF forwards the NOTIFY request to UE#1 home network (S-CSCF#1). + +**Table A.4.3.1.2-13: NOTIFY request (from S-CSCF to UE#1 home network)** + +``` + +NOTIFY sip: user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765- +00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP +[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home2.net +Max-Forwards: 68 +Route: , +Record-Route: , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: +(...) + +``` + +**14. 200 (OK) response (S-CSCF of UE#1 to S-CSCF) - see example in table A.4.3.1.2-14** + +The S-CSCF receives a 200 (OK) response to the NOTIFY request from UE#1's home network. + +**Table A.4.3.1.2-14: 200 (OK) response (S-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP +[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: , , +, +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home2.net +term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +**15. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.3.1.2-15** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.3.1.2-15: 200 (OK) response (S-CSCF to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP +[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +## 16. 200 (OK) response (P-CSCF to UE#2) - see example in table A.4.3.1.2-16 + +The P-CSCF forwards the 200 (OK) response to UE#2. + +**Table A.4.3.1.2-16: 200 (OK) response (P-CSCF to UE#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## 17. UE#2 joins the conference. + +UE#2 joins the conference. The message flows are depicted in subclause 6.3.2. + +## 18. NOTIFY request (from UE#2 to P-CSCF) - see example in table A.4.3.1.2-18 + +P-CSCF receives a NOTIFY request from UE#2 indicating the status of the refer event. + +**Table A.4.3.1.2-18: NOTIFY request (from UE#2 to P-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 70 +Route: , , + , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +To: ; tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 43 NOTIFY +Subscription-State: terminated +Event: refer +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 200 OK +``` + +## 19. NOTIFY request (from P-CSCF to S-CSCF) - see example in table A.4.3.1.2-19 + +The P-CSCF forwards the NOTIFY request to the S-CSCF. + +**Table A.4.3.1.2-19: NOTIFY request (from P-CSCF to S-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +Max-Forwards: 69 +Route: , , +Record-Route: P-Access-Network-Info: +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 20. NOTIFY request (from S-CSCF to S-CSCF of UE#1) - see example in table A.4.3.1.2-20 + +The S-CSCF forwards the NOTIFY request to UE#1's home network. + +**Table A.4.3.1.2-20: NOTIFY request (from S-CSCF to S-CSCF of UE#1)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK23d223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home2.net +Max-Forwards: 68 +Route: , +Record-Route: , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +**21. 200 (OK) response (S-CSCF of UE#1 to S-CSCF) - see example in table A.4.3.1.2-21** + +The S-CSCF receives a 200 (OK) response to the NOTIFY request from UE#1 home network. + +**Table A.4.3.1.2-21: 200 (OK) response (S-CSCF of UE#1 to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK23d244.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK23d223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: , , + , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024"; orig-ioi=home1.net + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**22. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.2-22** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.3.1.2-22: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK23d223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=323551024" +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**23. 200 (OK) response (P-CSCF to UE#2) - see example in table A.4.3.1.2-23** + +The P-CSCF forwards the 200 (OK) response to UE#2. + +**Table A.4.3.1.2-23: 200 (OK) response (P-CSCF UE#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**A.4.3.1.3 MRFC/AS invites a user to a conference** + +Figure A.4.3.1.3-1 shows an MRFC/AS inviting a user to a conference. The invitation is sent as a result of user1@home1.net sending a REFER request to the MRFC/AS. The MRFC/AS is located in a different network than user's S-CSCF. + +![Sequence diagram showing the interaction between MRFC/AS, I-CSCF, S-CSCF, P-CSCF, and UE#2 for inviting a user to a conference. The diagram is divided into three network domains: UE#1 Home Network, UE#2 Home Network, and UE#2 Visited Network. The sequence starts with an INVITE from MRFC/AS to I-CSCF, followed by a 100 Trying response. I-CSCF then sends an HSS query and an INVITE to S-CSCF. S-CSCF responds with 100 Trying and performs an evaluation of initial filter criteria. It then sends an INVITE to P-CSCF, which responds with 100 Trying and 183 Session Progress. P-CSCF sends an INVITE to UE#2, which responds with 100 Trying and 183 Session Progress. P-CSCF then authorizes QoS resources and sends a 183 Session Progress to S-CSCF. S-CSCF sends a 183 Session Progress to I-CSCF, which in turn sends it to MRFC/AS. MRFC/AS sends a PRACK to S-CSCF. S-CSCF sends a PRACK to P-CSCF, which sends it to UE#2. P-CSCF responds with 200 OK to S-CSCF, which responds with 200 OK to MRFC/AS. MRFC/AS sends an UPDATE to S-CSCF, which sends it to P-CSCF, which sends it to UE#2. UE#2 responds with 200 OK to P-CSCF, which responds with 200 OK to S-CSCF, which responds with 200 OK to MRFC/AS. MRFC/AS then performs an H.248 interaction to connect through the conference resources for UE#2. P-CSCF sends a 200 OK to S-CSCF, which sends it to MRFC/AS. MRFC/AS sends an ACK to S-CSCF, which sends it to P-CSCF, which sends it to UE#2.](1cd38e4f2ffcae2871964fa6313a9a27_img.jpg) + +``` + +sequenceDiagram + participant MRFC/AS + participant I-CSCF + participant S-CSCF + participant P-CSCF + participant UE#2 + + Note left of MRFC/AS: UE#1 Home Network + Note left of I-CSCF: UE#2 Home Network + Note left of P-CSCF: UE#2 Visited Network + + MRFC/AS->>I-CSCF: 1. INVITE + I-CSCF-->>MRFC/AS: 2. 100 Trying + I-CSCF->>S-CSCF: 3.HSS query + I-CSCF->>S-CSCF: 4. INVITE + S-CSCF-->>I-CSCF: 5. 100 Trying + S-CSCF->>S-CSCF: 6. Evaluation of initial Filter Criteria + S-CSCF->>P-CSCF: 7. INVITE + P-CSCF-->>S-CSCF: 8. 100 Trying + P-CSCF->>UE#2: 9. INVITE + UE#2-->>P-CSCF: 10. 100 Trying + UE#2-->>P-CSCF: 11. 183 Session Progress + P-CSCF->>P-CSCF: 12. Authorize QoS resources + P-CSCF->>S-CSCF: 13. 183 Session Progress + S-CSCF->>I-CSCF: 14. 183 Session Progress + I-CSCF->>MRFC/AS: 15. 183 Session Progress + MRFC/AS->>S-CSCF: 16. PRACK + MRFC/AS->>MRFC/AS: 17. H.248 interaction to create conference connection resources for UE#2 + S-CSCF->>P-CSCF: 18. PRACK + P-CSCF->>UE#2: 19. PRACK + UE#2-->>P-CSCF: 20. 200 OK + P-CSCF-->>S-CSCF: 21. 200 OK + S-CSCF-->>MRFC/AS: 22. 200 OK + MRFC/AS->>S-CSCF: 23. UPDATE + S-CSCF->>P-CSCF: 24. UPDATE + P-CSCF->>UE#2: 25. UPDATE + UE#2-->>P-CSCF: 26. 200 OK + P-CSCF-->>S-CSCF: 27. 200 OK + S-CSCF-->>MRFC/AS: 28. 200 OK + MRFC/AS->>MRFC/AS: 29. H.248 interaction to connect through the conference resources for UE#2 + P-CSCF-->>S-CSCF: 30. 200 OK + S-CSCF->>S-CSCF: 31. Approval of QoS commit + S-CSCF-->>P-CSCF: 32. 200 OK + P-CSCF-->>I-CSCF: 33. 200 OK + I-CSCF-->>MRFC/AS: 34. 200 OK + MRFC/AS->>S-CSCF: 35. ACK + S-CSCF->>P-CSCF: 36. ACK + P-CSCF->>UE#2: 37. ACK + +``` + +Sequence diagram showing the interaction between MRFC/AS, I-CSCF, S-CSCF, P-CSCF, and UE#2 for inviting a user to a conference. The diagram is divided into three network domains: UE#1 Home Network, UE#2 Home Network, and UE#2 Visited Network. The sequence starts with an INVITE from MRFC/AS to I-CSCF, followed by a 100 Trying response. I-CSCF then sends an HSS query and an INVITE to S-CSCF. S-CSCF responds with 100 Trying and performs an evaluation of initial filter criteria. It then sends an INVITE to P-CSCF, which responds with 100 Trying and 183 Session Progress. P-CSCF sends an INVITE to UE#2, which responds with 100 Trying and 183 Session Progress. P-CSCF then authorizes QoS resources and sends a 183 Session Progress to S-CSCF. S-CSCF sends a 183 Session Progress to I-CSCF, which in turn sends it to MRFC/AS. MRFC/AS sends a PRACK to S-CSCF. S-CSCF sends a PRACK to P-CSCF, which sends it to UE#2. P-CSCF responds with 200 OK to S-CSCF, which responds with 200 OK to MRFC/AS. MRFC/AS sends an UPDATE to S-CSCF, which sends it to P-CSCF, which sends it to UE#2. UE#2 responds with 200 OK to P-CSCF, which responds with 200 OK to S-CSCF, which responds with 200 OK to MRFC/AS. MRFC/AS then performs an H.248 interaction to connect through the conference resources for UE#2. P-CSCF sends a 200 OK to S-CSCF, which sends it to MRFC/AS. MRFC/AS sends an ACK to S-CSCF, which sends it to P-CSCF, which sends it to UE#2. + +Figure A.4.3.1.3-1: MRFC/AS inviting a user to a conference - MRFC/AS routes directly to I-CSCF + +The details of the flows are as follows: + +**1. INVITE request (MRFC/AS to I-CSCF) - see example in table A.4.3.1.3-1** + +In this example, the MRFC/AS is capable of resolving the terminating users I-CSCF address for this request. As a result of a DNS query, it has received the address of the I-CSCF as the next hop. + +The MRFC/AS invites a user to a conference as it received a REFER request from another user. + +The MRFC/AS determines the codecs that are applicable for this conference. It builds a SDP Offer containing bandwidth requirements and characteristics of each, and assigns local port numbers for each possible media flow. Multiple media flows may be offered, and for each media flow (m= line in SDP). In this example, there is only one codec per media offered. + +For this example, it is assumed that MRFC/AS is willing to establish a multimedia session comprising a video stream and an audio stream. The video stream supports H.263. The audio stream supports the AMR codec. + +The MRFC/AS indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +The UE does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between UE and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +**Table A.4.3.1.3-1: INVITE request (MRFC/AS to I-CSCF)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: precondition, 100rel +Referred-By: +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +Allow-Events: conference, pending-additions +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::abc:def:abc:abc +s= +c=IN IP6 5555::abc:def:abc:def +t=0 0 +m=video 10001 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Request-URI:** contains the public user identity of UE#2. + +**P-Asserted-Identity:** contains the asserted identity as configured in the MRFC/AS. + +**Contact:** contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +**Allow-Events:** The MRFC/AS indicates support for the "conference" and "pending-additions" event packages + +**Referred-By:** contains the same value as received in the Referred-By in the REFER request that was received from the user that requested the MRFC/AS send the INVITE request. + +## 2. 100 (Trying) response (I-CSCF to MRFC/AS) - see example in table A.4.3.1.3-2 + +The I-CSCF responds to the INVITE request with a 100 (Trying) provisional response. + +**Table A.4.3.1.3-2: 100 (Trying) response (I-CSCF to MRFC/AS)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP conferencel@mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +### 3. Cx: User Location Query procedure + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +For detailed message flows see 3GPP TS 29.228 [12]. + +#### 4. INVITE request (I-CSCF to S-CSCF) - see example in table A.4.3.1.3-4 + +The INVITE request is forwarded to the S-CSCF. + +**Table A.4.3.1.3-4: INVITE request (I-CSCF to S-CSCF)** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
INVITE sip:user2_public1@home2.net SIP/2.0 Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP      mrfc1.home1.net;branch=z9hG4bK23273846 Max-Forwards: 69 P-Asserted-Identity: P-Charging-Vector: Privacy: From: To: Call-ID: CSeq: Supported: Referred-By: Contact: Allow: Allow-Events: Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5. 100 (Trying) response (S-CSCF to I-CSCF) - see example in table 6.2.2.2-5 + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) provisional response. + +**Table 6.2.2.2-5: 100 (Trying) response (S-CSCF to I-CSCF)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 100 Trying Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP      mrfc1.home1.net;branch=z9hG4bK23273846 From: To: Call-ID: CSeq: Content-Length: 0
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 6. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +## 7. INVITE request (S-CSCF to P-CSCF) - see example in table A.4.3.1.3-7 + +S-CSCF remembers (from registration procedures) the contact address of UE#2 and determines the P-CSCF assigned for UE#2 and routes message there. + +**Table A.4.3.1.3-7: INVITE request (S-CSCF to P-CSCF)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP     mrfcl.home1.net;branch=z9hG4bK23273846 Max-Forwards: 68 Record-Route: <sip:scscf1.home1.net;lr> P-Asserted-Identity: P-Charging-Vector: #### Privacy: From: To: Call-ID: Cseq: Supported: Referred-By: Contact: Allow: Allow-Events: P-Called-Party-ID: <sip:user2_public1@home2.net> Content-Type: Content-Length: (...)  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 8. 100 (Trying) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.3-8 + +The P-CSCF responds to the INVITE request (6) with a 100 (Trying) provisional response. + +**Table A.4.3.1.3-8: 100 (Trying) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## 9. INVITE request (P-CSCF to UE#2) - see example in table A.4.3.1.3-9 + +P-CSCF forwards the request to UE#2. + +**Table A.4.3.1.3-9: INVITE request (P-CSCF to UE#2)** + +``` +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1 SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 67 +Record-Route: , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Referred-By: +Contact: +Allow: +Allow-Events: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +``` + +### 10. 100 (Trying) response (UE#2 to P-CSCF) - see example in table A.4.3.1.3-10 + +UE#2 responds to the INVITE request (9) with a 100 (Trying) provisional response. + +**Table A.4.3.1.3-10: 100 (Trying) response (UE#2 to P-CSCF)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1 SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +**11. 183 (Session Progress) response (UE#2 to P-CSCF) - see example in table A.4.3.1.3-11** + +UE#2 determines the complete set of codecs that it is capable of supporting for this session. It determines the intersection with those appearing in the SDP in the INVITE request. + +The UE responds with a 183 (Session Progress) response containing SDP back to the originator. This response is sent to the P-CSCF. + +**Table A.4.3.1.3-11: 183 (Session Progress) response (UE#2 to P-CSCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Require: precondition, 100rel +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +RSeq: 9021 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933623 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=inactive +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +## 12. Authorize QoS resources + +The P-CSCF authorizes the resources necessary for this session. The approval of QoS commitment either happens at this stage or after 200 (OK) response of INVITE request (31) based on operator local policy. + +### 13. 183 (Session Progress) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.3-13 + +The P-CSCF forwards the 183 (Session Progress) response to the S-CSCF. + +**Table A.4.3.1.3-13: 183 (Session Progress) response (P-CSCF to S-CSCF)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP     mrfc1.home1.net;branch=z9hG4bK23273846 Record-Route: <sip:pcscf2.visited2.net;lr>, <sip:scscf2.home2.net;lr> P-Asserted-Identity: "John Smith" <sip:user2_public1@home2.net> P-Access-Network-Info: P-Charging-Vector: #### Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 14. 183 (Session Progress) response (S-CSCF to I-CSCF) - see example in table A.4.3.1.3-14 + +The S-CSCF forwards the 183 (Session Progress) response to I-CSCF. + +**Table A.4.3.1.3-14: 183 (Session Progress) response (S-CSCF to I-CSCF)** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP      mrfcl.homel.net;branch=z9hG4bK23273846 Record-Route: P-Asserted-Identity: "John Smith" <sip:user2_public1@home2.net>, <tel:+1-212-555-2222> P-Charging-Vector: #### P-Charging-Function-Addresses: #### Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 15. 183 (Session Progress) response (I-CSCF to MRFC/AS) - see example in table A.4.3.1.3-15 + +The I-CSCF forwards the 183 (Session Progress) response to the MRFC/AS. + +**Table A.4.3.1.3-15: 183 (Session Progress) response (I-CSCF to MRFC/AS)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 183 Session Progress Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 Record-Route: P-Asserted-Identity: Privacy: From: To: Call-ID: CSeq: Require: Contact: Allow: RSeq: Content-Type: Content-Length:  v= o= s= c= t= m= b= a= a= a= a= a= a= a= a= m= b= a= a= a= a= a= a= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 16. PRACK request (MRFC/AS to S-CSCF) - see example in table A.4.3.1.3-16 + +The MRFC/AS determines which media flows should be used for this session, and which codecs should be used for each of those media flows. + +Since there is no change in the media characteristics, the MRFC/AS does not include any new SDP offer in the PRACK request sent to UE#2. + +The MRFC/AS sends the PRACK request to the S-CSCF of UE#2 according to the Record-Route header received in 183 Session progress (15). + +**Table A.4.3.1.3-16: PRACK request (MRFC/AS to S-CSCF)** + +``` + +PRACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- +ad76cc7fc74 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +RAck: 9021 127 INVITE +Content-Length: 0 + +``` + +**Request-URI:** takes the value of the Contact header of the received 183 (Session Progress) response. + +## 17. Resource reservation + +After determining the media streams, the MRFC/AS initiates the reservation procedures for the resources needed for this session. + +## 18. PRACK request (S-CSCF to P-CSCF) - see example in table A.4.3.1.3-18 + +The P-CSCF forwards the PRACK request to the P-CSCF. + +**Table A.4.3.1.3-18: PRACK request (S-CSCF to P-CSCF)** + +``` + +PRACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +RAck: +Content-Length: + +``` + +## 19. PRACK request (P-CSCF to UE#2) - see example in table A.4.3.1.3-19 + +The P-CSCF forwards the PRACK request to UE#2. + +**Table A.4.3.1.3-19: PRACK request (P-CSCF to UE#2)** + +``` + +PRACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +RAck: +Content-Length: + +``` + +## 20. 200 (OK) response (UE#2 to P-CSCF) - see example in table A.4.3.1.3-20 (related to table A.4.3.1.3-19) + +UE#2 acknowledges the PRACK request (19) with a 200 (OK) response. + +**Table A.4.3.1.3-20: 200 (OK) response (UE#2 to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**21. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.3-21** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.3-21: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: +``` + +**22. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.4.3.1.3-22** + +The S-CSCF forwards the 200 (OK) response to the MRFC/AS. + +**Table A.4.3.1.3-22: 200 (OK) response (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: +``` + +### 23. UPDATE request (MRFC/AS to S-CSCF) - see example in table A.4.3.1.3-23 + +When the resource reservation in step (17) is completed, the MRFC/AS sends the UPDATE request to UE#2. + +**Table A.4.3.1.3-23: UPDATE request (MRFC/AS to S-CSCF)** + +``` +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- +ad76cc7fc74 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555::abc:def:abc:abc +s=- +c=IN IP6 5555::abc:def:abc:def +t=0 0 +m=video 0 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +**Request-URI:** takes the value of the Contact header of the received 183 (Session Progress) response. + +24. UPDATE request (S-CSCF to P-CSCF) - see example in table A.4.3.1.3-24 + +The S-CSCF forwards the UPDATE request to the P-CSCF. + +Table A.4.3.1.3-24: UPDATE request (S-CSCF to P-CSCF) + +``` + +UPDATE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +25. UPDATE request (P-CSCF to UE#2) - see example in table A.4.3.1.3-25 + +The P-CSCF forwards the UPDATE request to UE#2. + +Table A.4.3.1.3-25: UPDATE request (P-CSCF to UE#2) + +``` + +UPDATE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +m= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +**26. 200 (OK) response (UE#2 to P-CSCF) - see example in table A.4.3.1.3-26 (related to table A.4.3.1.3-25)** + +UE#2 acknowledges the UPDATE request (25) with a 200 (OK) response. + +**Table A.4.3.1.3-26: 200 (OK) response (UE#2 to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933623 2987933625 IN IP6 5555:: aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 0 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +**27. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.3-27** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.3-27: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +a= +``` + +## 28. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.4.3.1.3-28 + +The S-CSCF forwards the 200 (OK) response to the MRFC/AS. + +**Table A.4.3.1.3-28: 200 (OK) response (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +m= +b= +a= +a= +a= +a= +a= +a= +``` + +## 29. H.248 interaction to modify connection + +MRFC initiates a H.248 interaction to connect through the multimedia processing resources for UE#2 in MRFP. + +## 30. 200 (OK) response (UE#2 to P-CSCF) - see example in table A.4.3.1.3-30 (related to table A.4.3.1.3-9) + +UE#2 sends a 200 (OK) response final response to the INVITE request (9) to the P-CSCF. + +**Table 6.2.2.2-30: 200 (OK) response (UE#2 to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1 SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: 127 INVITE +Contact: +Content-Length:0 +``` + +## 31. Approval of QoS commit + +The P-CSCF approves the commitment of the QoS resources if it was not approved already in step (12). + +### 32. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.3.1.3-32 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.3-32: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: , +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length:0 +``` + +### 33. 200 (OK) response (S-CSCF to I-CSCF) - see example in table A.4.3.1.3-33 + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to I-CSCF. + +**Table A.4.3.1.3-33: 200 (OK) response (S-CSCF to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +### 34. 200 (OK) response (I-CSCF to MRFC/AS) - see example in table A.4.3.1.3-34 + +The I-CSCF forwards the 200 (OK) response final response to the session originator. + +**Table 6.2.2.2-34: 200 (OK) response (I-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +### 35. ACK request (MRFC/AS to S-CSCF) - see example in table A.4.3.1.3-35 + +The MRFC/AS responds to the 200 (OK) response (35) with an ACK request sent to the S-CSCF. + +**Table A.4.3.1.3-35: ACK request (MRFC/AS to S-CSCF)** + +``` +ACK sip: user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- + ad76cc7fc74 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +**36. ACK request (S-CSCF to P-CSCF) - see example in table A.4.3.1.3-36** + +The S-CSCF forwards the ACK request to the P-CSCF. + +**Table A.4.3.1.3-36: ACK request (S-CSCF to P-CSCF)** + +``` +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +**37. ACK request (P-CSCF to UE#2) - see example in table A.4.3.1.3-37** + +The P-CSCF forwards the ACK request to the UE#2. + +**Table A.4.3.1.3-37: ACK request (P-CSCF to UE#2)** + +``` +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +**A.4.3.1.4 MRFC/AS refers a user to a conference** + +Figure A.4.3.1.4-1 shows how MRFC/AS refers UE#2 to a conference by sending a REFER request to UE#2. The MRFC/AS has created a conference and allocated a conference URI. + +In this example, the MRFC/AS is not capable of resolving the Request-URI and therefore routes the request first to the S-CSCF in its own network. + +![Sequence diagram showing MRFC/AS inviting another user to a conference by sending a REFER request to UE#2.](c0438093a10a593c42106b1e5dbb4331_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE#1 + participant MRFC as MRFC/AS + participant UE2 as UE#2 + participant UE3 as UE#3 + + Note over UE1, UE3: (Top labels obscured by black bar) + UE1->>MRFC: 1. REFER + MRFC->>UE1: 2. 202 Accepted + MRFC->>UE2: 3. INVITE + Note right of MRFC: (Internal Processing) + UE2->>MRFC: 4. 180 Ringing + MRFC->>UE1: 5. NOTIFY (180 Ringing) + UE1->>MRFC: 6. 200 OK + UE2->>MRFC: 7. 200 OK + MRFC->>UE2: 8. ACK + MRFC->>UE1: 9. NOTIFY (200 OK) + UE1->>MRFC: 10. 200 OK + MRFC->>UE3: 11. INVITE + UE3->>MRFC: 12. 200 OK + MRFC->>UE3: 13. ACK + +``` + +Sequence diagram showing MRFC/AS inviting another user to a conference by sending a REFER request to UE#2. + +Figure A.4.3.1.4-1: MRFC/AS inviting another user to a conference by sending a REFER request to UE#2 + +The details of the flows are as follows: + +1. **REFER request (MRFC/AS to S-CSCF) - see example in table A.4.3.1.4-1** + +The MRFC/AS wants to invite another user to a conference by sending a REFER request to that user. + +**Table A.4.3.1.4-1: REFER request (MRFC/AS to S-CSCF)** + +``` +REFER sip: user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 REFER +Refer-To: +Referred-By: +Contact: ;isfocus +Content-Length: 0 +``` + +- Request-URI:** contains the public user identity of UE#2. +- P-Asserted-Identity:** contains the asserted identity as configured in the MRFC/AS. +- P-Charging-Vector:** the MRFC/AS inserts this header and populates the icid parameters with a globally unique value and includes the originating network identifier. +- Refer-To:** contains the conference URI. Additionally the method uri parameter indicates that the UE#2 shall send an INVITE request to this URI. +- Referred-By:** contains the public user identity of the user, on which behalf the MRFC/AS sends the REFER message. +- Contact:** contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +2. **REFER request (S-CSCF to I-CSCF) - see example in table A.4.3.1.4-2** + +The REFER request is forwarded to the I-CSCF. + +**Table A.4.3.1.4-2: REFER request (S-CSCF to I-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Contact: +Content-Length: +``` + +### 3. Cx: User Location Query procedure + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +For detailed message flows see 3GPP TS 29.228 [12] + +### 4. REFER request (I-CSCF to S-CSCF) - see example in table A.4.3.1.4-4 + +The I-CSCF forwards the REFER request to the address obtained during HSS query. The I-CSCF adds itself to the Via, but not to the Record-Route header as it will not need to stay on the signalling path for subsequent requests. + +**Table A.4.3.1.4-4: REFER request (I-CSCF to S-CSCF)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK231234.5, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Contact: +Content-Length: +``` + +### 5. Evaluation of Initial Filter criteria + +S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +### 6. REFER request (S-CSCF to P-CSCF) - see example in table A.4.3.1.4-6 + +The S-CSCF remembers (from registration procedures) the contact address of UE#2 and determines the P-CSCF assigned for UE#2 and routes the message there. The S-CSCF adds itself to the Via and Record-Route headers. + +**Table A.4.3.1.4-6: REFER request (S-CSCF to P-CSCF)** + +``` +REFER sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK231234.5, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 67 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Contact: +P-Called-Party-ID: +Content-Length: +``` + +## 7. REFER request (P-CSCF to UE#2) - see example in table A.4.3.1.4-7 + +The P-CSCF forwards the request to UE#2. + +**Table A.4.3.1.4-7: REFER request (P-CSCF to UE#2)** + +``` +REFER sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK249354.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK231234.5, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 66 +Record-Route: , , + +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Referred-By: +Contact: +P-Called-Party-ID: +Content-Length: +``` + +## 8. 200 (OK) response to REFER (UE#2 to P-CSCF) - see example in table A.4.3.1.4-8 + +UE# accepts the REFER request by sending a 200 (OK) response. + +**Table A.4.3.1.4-8: 200 (OK) response to REFER (UE#2 to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK249354.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK231234.5, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: , , + +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy:none +From: ; tag=171828 +To: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 127 REFER +Contact: +Content-Length:0 +``` + +**9. 200 (OK) response to REFER (P-CSCF to S-CSCF) - see example in table A.4.3.1.4-9** + +The P-CSCF forwards the response to the S-CSCF. + +**Table A.4.3.1.4-9: 200 (OK) response to REFER (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK234974.3, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK231234.5, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: , , + +P-Access-Network-Info: +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +**10. 200 (OK) response to REFER (S-CSCF to I-CSCF) - see example in table A.4.3.1.4-10** + +The S-CSCF forwards the response to the I-CSCF. + +**Table A.4.3.1.4-10: 200 (OK) response to REFER (S-CSCF to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK231234.5, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: +P-Asserted-Identity: "John Smith" +P-Charging-Vector: ### +P-Charging-Function-Addresses: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +**11. 200 (OK) response to REFER (I-CSCF to S-CSCF) - see example in table A.4.3.1.4-11** + +The I-CSCF forwards the response to the S-CSCF. + +**Table A.4.3.1.4-11: 200 (OK) response to REFER (I-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +## 12. 200 (OK) response to REFER (S-CSCF to MRFC/AS) - see example in table A.4.3.1.4-12 + +The S-CSCF forwards the response to the MRFC/AS. + +**Table A.4.3.1.4-12: 200 (OK) response to REFER (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +## 13. NOTIFY request (UE#2 to P-CSCF) - see example in table A.4.3.1.4-13 + +According to RFC 3515 [17], UE#2 creates a subscription and sends a notification of the status of the refer. + +**Table A.4.3.1.4-13: NOTIFY request (from UE#2 to P-CSCF)** + +``` +NOTIFY sip:conferencel@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 70 +Route: , , + +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +To: ;tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 42 NOTIFY +Subscription-State: active;expires:7200 +Event: refer +Contact: +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 100 Trying +``` + +## 14. NOTIFY request (from P-CSCF to S-CSCF) - see example in table A.4.3.1.4-14 + +The P-CSCF forwards the message to the S-CSCF. + +**Table: A.4.3.1.4-14: NOTIFY request (from P-CSCF to S-CSCF)** + +``` +NOTIFY sip:conferencel@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 69 +Route: , +Record-Route: +P-Access-Network-Info: +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 15. NOTIFY request (from S-CSCF to S-CSCF - see example in table A.4.3.1.4-15) + +The S-CSCF forwards the message to the S-CSCF. + +**Table A.4.3.1.4-15: NOTIFY request (from S-CSCF to S-CSCF)** + +``` +NOTIFY sip:conferencel@mrfl.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 68 +Route: +Record-Route: , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 16. NOTIFY request (from S-CSCF to MRFC/AS- see example in table A.4.3.1.4-16) + +The S-CSCF forwards the message to the MRFC/AS. + +**Table A.4.3.1.4-16: NOTIFY request (from S-CSCF to MRFC/AS)** + +``` +NOTIFY sip:conferencel@mrfl.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 67 +Record-Route: , , + +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 17. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.4.3.1.4-17 + +The MRFC/AS acknowledges the NOTIFY request with a 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.4-17: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: , , + +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**18. 200 (OK) response (S-CSCF to S-CSCF) - see example in table A.4.3.1.4-18** + +The S-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.4-18: 200 (OK) response (S-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**19. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.3.1.4-19** + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.3.1.4-19: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**20. 200 (OK) response (P-CSCF to UE#2) - see example in table A.4.3.1.4-20** + +The P-CSCF forwards the 200 (OK) response to UE#2. + +**Table A.4.3.1.4-20: 200 (OK) response (P-CSCF to UE#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**21. UE#2 joins the conference.** + +UE#2 joins the conference as described in subclause 5.3.1.4. + +## 22. NOTIFY request (UE#2 to P-CSCF) - see example in table A.4.3.1.4-22 + +The P-CSCF receives a NOTIFY request from UE#2 indicating the status of the refer. + +**Table A.4.3.1.4-22: NOTIFY request (from UE#2 to P-CSCF)** + +``` +NOTIFY sip:conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 70 +Route: , , + +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +To: ;tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 42 NOTIFY +Subscription-State: terminated +Event: refer +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 200 OK +``` + +## 23. NOTIFY request (from P-CSCF to S-CSCF) - see example in table A.4.3.1.4-23 + +The P-CSCF forwards the message to the S-CSCF. + +**Table: A.4.3.1.4-23: NOTIFY request (from P-CSCF to S-CSCF)** + +``` +NOTIFY sip:conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 69 +P-Access-Network-Info: +Route: , +Record-Route: +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 24. NOTIFY request (from S-CSCF to S-CSCF) - see example in table A.4.3.1.4-24 + +The S-CSCF forwards the message to the S-CSCF. + +**Table A.4.3.1.4-24: NOTIFY request (from S-CSCF to S-CSCF)** + +``` +NOTIFY sip:conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pcscf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 68 +Route: +Record-Route: , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 25. NOTIFY request (from S-CSCF to MRFC/AS- see example in table A.4.3.1.4-25) + +The S-CSCF forwards the message to the MRFC/AS. + +**Table A.4.3.1.4-25: NOTIFY request (from S-CSCF to MRFC/AS)** + +``` +NOTIFY sip:conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Max-Forwards: 67 +Record-Route: , , + +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 26. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.4.3.1.4-26 + +The MRFC/AS acknowledges the NOTIFY request with a 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.4-26: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: , , + +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +## 27. 200 (OK) response (S-CSCF to S-CSCF) - see example in table A.4.3.1.4-27 + +The S-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.3.1.4-27: 200 (OK) response (S-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## 28. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.4.3.1.4-28 + +The S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.4.3.1.4-28: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net;branch=z9hG4bK234223.1, SIP/2.0/UDP +[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**29. 200 (OK) response (P-CSCF to UE#2) - see example in table A.4.3.1.4-29** + +The P-CSCF forwards the 200 (OK) response to UE#2. + +**Table A.4.3.1.4-29: 200 (OK) response (P-CSCF to UE#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=z9hG4bK23dh42.1 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## A.4.4 User requesting IMS to join another user + +### A.4.4.1 MRFC/AS is located in user's home network + +Figure A.4.4.1-1 shows how UE#1 invites UE#2 to a conference by sending a REFER request to MRFC/AS. UE#1 has created a conference by using the mechanisms described in subclause 5.3.1.3, and UE#1 has learned the conference URI that identifies this conference. + +![A sequence diagram showing interactions between four entities. The diagram includes vertical lifelines, horizontal message arrows (both solid and dashed), and rectangular activation bars. No text labels are present on the lifelines or messages.](0f666d2ebbad7fab84c7c4fb531ea932_img.jpg) + +A sequence diagram illustrating the flow of messages between four entities. The diagram consists of four vertical lifelines. At the top, there are four rectangular boxes representing the entities, grouped under two larger horizontal bars. A wide horizontal bar spans across all four lifelines near the top. Below this, various messages are exchanged: + +- A message from the first lifeline to the second. +- A message from the second lifeline to the third. +- A rectangular processing block on the third lifeline. +- A message from the third lifeline to the fourth. +- A return message from the fourth lifeline to the third. +- A rectangular processing block on the fourth lifeline. +- A return message from the third lifeline to the second. +- A return message from the second lifeline to the first. +- A message from the first lifeline to the second. +- A message from the second lifeline to the third. +- A message from the third lifeline to the fourth. +- A rectangular processing block on the fourth lifeline. +- A return message from the fourth lifeline to the third. +- A return message from the third lifeline to the second. +- A return message from the second lifeline to the first. +- A final message from the third lifeline to the fourth. + +A sequence diagram showing interactions between four entities. The diagram includes vertical lifelines, horizontal message arrows (both solid and dashed), and rectangular activation bars. No text labels are present on the lifelines or messages. + +**Figure A.4.4.1-1: User inviting another user to a conference by sending a REFER request to MRFC/AS** + +The details of the flows are as follows: + +### 1. UE#1 creates a conference + +UE#1 creates a conference as described in subclause 5.3.1.3. Once the conference creation is accomplished, UE#1 has learned the conference URI allocated for this conference. + +## 2. REFER request (UE to P-CSCF) - see example in table A.4.4.1-2 + +A UE has created a conference and learned the conference URI. Now the UE wants to join another UE to that conference. + +**Table A.4.4.1-2: REFER request (UE to P-CSCF)** + +``` +REFER sip: conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 REFER +Require: sec-agree +Refer-To: +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Content-Length: 0 +``` + +**Request-URI:** contains the conference URI as learned during the conference establishment. + +## 3. REFER request (P-CSCF to S-CSCF) - see example in table A.4.4.1-3 + +The REFER request is forwarded to the S-CSCF. + +**Table A.4.4.1-3: REFER request (P-CSCF to S-CSCF)** + +``` +REFER sip: conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Charging-Vector: ### +P-Access-Network-Info: +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Supported: +Contact: +Content-Length: +``` + +## 4. Evaluation of initial Filter Criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +## 5. REFER request (S-CSCF to MRFC/AS) - see example in table A.4.4.1-5 + +The S-CSCF forwards the REFER request to the address obtained by a DNS query. The S-CSCF adds itself to the Record-Route header. + +**Table A.4.4.1-5: REFER request (S-CSCF to MRFC/AS)** + +``` +REFER sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Refer-To: +Supported: +Contact: +Content-Length: +``` + +## 6. 200 (OK) response to REFER (MRFC/AS to S-CSCF) - see example in table A.4.4.1-6 + +The MRFC/AS indicates that it has received the REFER request by sending a 200 (OK) response. This means that MRFC/AS has accepted the REFER request and has begun to process the request. This does not mean, however, that the referred-to resource would have been contacted. + +**Table A.4.4.1-6: 200 (OK) response to REFER (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy:none +From: ;tag=171828 +To: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 127 REFER +Contact: ;isfocus +Content-Length:0 +``` + +**Contact:** contains the conference URI for the conference allocated at the MRFC/AS and the "isfocus" feature parameter. + +## 7. INVITE request user to conference + +The MRFC/AS invites the user, who is indicated in the Refer-To header of the received REFER request. It does apply the procedures as shown in subclause A.4.3.1.3. + +8. 200 (OK) response to REFER (S-CSCF to P-CSCF) - see example in table A.4.4.1-8 + +The S-CSCF forwards the response to the P-CSCF. + +**Table A.4.4.1-8: 200 (OK) response to REFER (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +9. 200 (OK) response to REFER (P-CSCF to UE#1) - see example in table A.4.4.1-9 + +The P-CSCF forwards the response to UE#1. + +**Table A.4.4.1-9: 200 (OK) response to REFER (P-CSCF to UE#1)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Content-Length: +``` + +10. NOTIFY request (MRFC/AS to S-CSCF) - see example in table A.4.4.1-10 + +The MRFC/AS sends a NOTIFY request to inform the S-CSCF about the progress of the REFER request processing. The body of the NOTIFY request contains a fragment of the response as received by the notifying UE for the request that was initiated due to the REFER request. + +**Table A.4.4.1-10: NOTIFY request (from MRFC/AS to S-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765- +00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: , +To: ;tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 42 NOTIFY +Subscription-State: active;expires:7200 +Event: refer +Contact: ;isfocus +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 100 Trying +``` + +## 11. NOTIFY request (from S-CSCF to P-CSCF) - see example in table A.4.4.1-11 + +The S-CSCF forwards the message to the P-CSCF. + +**Table A.4.4.1-11: NOTIFY request (from S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + mrfc.home1.net;branch= z9hG4bK23273846 +Max-Forwards: 69 +Route: +Record-Route: +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 12. NOTIFY request (from P-CSCF to UE#1) - see example in table A.4.4.1-12 + +The P-CSCF forwards the message to UE#1. + +**Table A.4.4.1-12: NOTIFY request (from P-CSCF to UE#1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + mrfc.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +Record-Route: , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 13. 200 (OK) response (UE to P-CSCF) - see example in table A.4.4.1-13 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.4.4.1-13: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP mrfc.home1.net;branch=z9hG4bK23273846 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 14. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.4.1-14 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.4.1-14: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + mrfc.home1.net;branch=z9hG4bK23273846 +Record-Route: +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 15. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.4.4.1-15 + +The S-CSCF forwards the 200 (OK) response to MRFC/AS. + +**Table A.4.4.1-15: 200 (OK) response (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc.home1.net;branch=z9hG4bK23273846 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 16. Referred user joins the conference. + +The referred user joins the conference as described in subclause 5.3.1.4. + +#### 17. NOTIFY request (from MRFC/AS to S-CSCF) - see example in table A.4.4.1-17 + +The MRFC/AS sends a NOTIFY request that indicates that the referred party has joined the conference. + +**Table A.4.4.1-17: NOTIFY request (from MRFC/AS to S-CSCF)** + +``` +NOTIFY sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765- + 00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: , +To: ; tag=171828 +From: ;tag=151170 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 43 NOTIFY +Subscription-State: terminated +Event: refer +Content-Length: (...) +Content-Type: message/sipfrag + +SIP/2.0 200 OK +``` + +**Subscription-State:** indicates that the implicit subscription to the refer event has been terminated. + +## 18. NOTIFY request (from S-CSCF to P-CSCF) - see example in table A.4.4.1-18 + +The S-CSCF forwards the message to the P-CSCF. + +**Table 6.3.3.1.1-18: NOTIFY request (from S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + mrfc.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +Route: +Record-Route: +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 19. NOTIFY request (from P-CSCF to UE#1) - see example in table A.4.4.1-19 + +The P-CSCF forwards the message to UE#1. + +**Table A.4.4.1-19: NOTIFY request (from P-CSCF to UE#1)** + +``` +NOTIFY sip: [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + mrfc.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +Record-Route: , +To: +From: +Call-ID: +CSeq: +Subscription-State: +Event: +Content-Length: (...) +Content-Type: + +(...) +``` + +## 20. 200 (OK) response (UE to P-CSCF) - see example in table A.4.4.1-20 + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.4.4.1-20: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK23433.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP mrfc.home1.net;branch=z9hG4bK23273846 +Record-Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**21. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.4.4.1-21** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.4.4.1-21: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK23436s.1, SIP/2.0/UDP + mrfc.home1.net;branch=z9hG4bK23273846 +Record-Route: P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**22. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.4.4.1-22** + +The S-CSCF forwards the 200 (OK) response to the MRFC/AS. + +**Table A.4.4.1-22: 200 (OK) response (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc.home1.net;branch=z9hG4bK23273846 +Record-Route: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## A.4.5 User joins a private conversation to a conference + +### A.4.5.1 User in a different network + +Void + +--- + +## A.5 Flows demonstrating a user subscribing to the conference event package + +### A.5.1 Introduction + +Void + +## A.5.2 User subscribing to the conference event package + +### A.5.2.1 MRFC/AS is not located in user's home network + +![Sequence diagram showing the interaction for subscribing to a conference event package when the MRFC/AS is not in the user's home network.](36f5fcb5a6d05ddc81fc4bab4b3288ef_img.jpg) + +``` +sequenceDiagram + participant UE#1 + participant P-CSCF + participant S-CSCF + participant MRFC/AS + + Note left of P-CSCF: Visited Network + Note left of S-CSCF: UE#1 Home Network + Note left of MRFC/AS: MRFC/AS Home Network + + UE#1->>P-CSCF: 1. SUBSCRIBE + P-CSCF->>S-CSCF: 2. SUBSCRIBE + S-CSCF->>S-CSCF: 3. Evaluation of initial Filter Criteria + S-CSCF->>MRFC/AS: 4. SUBSCRIBE + MRFC/AS-->>S-CSCF: 5. 200 OK + S-CSCF-->>P-CSCF: 6. 200 OK + P-CSCF-->>UE#1: 7. 200 OK + MRFC/AS-->>S-CSCF: 8. NOTIFY + S-CSCF-->>P-CSCF: 9. NOTIFY + P-CSCF-->>UE#1: 10. NOTIFY + UE#1->>P-CSCF: 11. 200 OK + P-CSCF->>S-CSCF: 12. 200 OK + S-CSCF->>MRFC/AS: 13. 200 OK +``` + +The diagram illustrates a sequence of messages between a User Equipment (UE#1), a Proxy-CSCF (P-CSCF), a Serving-CSCF (S-CSCF), and a Media Resource Function/AS (MRFC/AS). The interaction is as follows: 1. UE#1 sends a SUBSCRIBE request to P-CSCF. 2. P-CSCF forwards the SUBSCRIBE request to S-CSCF. 3. S-CSCF performs an 'Evaluation of initial Filter Criteria'. 4. S-CSCF sends a SUBSCRIBE request to MRFC/AS. 5. MRFC/AS returns a 200 OK response to S-CSCF. 6. S-CSCF returns a 200 OK response to P-CSCF. 7. P-CSCF returns a 200 OK response to UE#1. 8. MRFC/AS sends a NOTIFY message to S-CSCF. 9. S-CSCF forwards the NOTIFY message to P-CSCF. 10. P-CSCF forwards the NOTIFY message to UE#1. 11. UE#1 sends a 200 OK response to P-CSCF. 12. P-CSCF sends a 200 OK response to S-CSCF. 13. S-CSCF sends a 200 OK response to MRFC/AS. + +Sequence diagram showing the interaction for subscribing to a conference event package when the MRFC/AS is not in the user's home network. + +**Figure A.5.2.1-1: User subscribing to conference event package - MRFC/AS is not located in user's home network** + +Figure A.5.2.1-1 shows an user subscribing to the conference state event for a specific conference that is provided at a MRFC/AS located in another network. The conference URI, which is used for subscription to the conference event package, does include a FQDN in the host part in this example. + +The details of the flows are as follows: + +#### 1. SUBSCRIBE request (UE to P-CSCF) - see example in table A.5.2.1-1 + +A UE wants to get informed about the state of a certain conference, the involved users and their related media states. The conference is identified by a conference URI. In order to initiate a subscription to the MRFC/AS, the UE generates a SUBSCRIBE request containing the 'conference' event, together with the length of time this periodic subscription should last. + +**Table A.5.2.1-1: SUBSCRIBE request (UE to P-CSCF)** + +``` + +SUBSCRIBE sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , +P-Preferred-Identity: +Privacy: none +From: ;tag=31415 +To: +Call-ID: b89rjhnedrflslj40a222 +CSeq: 61 SUBSCRIBE +Require: sec-agree +Proxy-Require: sec-agreeSecurity-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; +spi-s=87654321; port-c=8642; port-s=7531 +Event: conference +Expires: 7200 +Accept: application/conference-info+xml +Contact: +Content-Length: 0 + +``` + +**Request-URI:** contains the conference URI. + +## 2. SUBSCRIBE request (P-CSCF to S-CSCF) - see example in table A.5.2.1-2 + +The SUBSCRIBE request is forwarded to the S-CSCF. + +**Table A.5.2.1-2: SUBSCRIBE request (P-CSCF to S-CSCF)** + +``` + +SUBSCRIBE sip:conferencel@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Access-Network-Info: +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024" +Privacy: +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: Accept: +Contact: +Content-Length: + +``` + +## 3. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +#### 4. SUBSCRIBE request (S-CSCF to MRFC/AS) - see example in table A.5.2.1-4 + +S-CSCF forwards the SUBSCRIBE request to the MRFC/AS based on the Request URI of the SUBSCRIBE request. The S-CSCF does not re-write the Request URI. + +**Table A.5.2.1-4: SUBSCRIBE request (S-CSCF to MRFC/AS)** + +``` +SUBSCRIBE sip:conference1@mrfc2.home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: +Record-Route: , +From: +To: +Call-ID: +CSeq: +Event: +Expires: Accept: +Contact: +Content-Length: +``` + +#### 5. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.5.2.1-5 (related to table A.5.2.1-4) + +The MRFC/AS performs the necessary authorization checks on the originator to ensure that he/she is allowed to subscribe to this specific conference. In this example the conditions have been met, so the MRFC/AS acknowledges the SUBSCRIBE request (6) with a 200 (OK) response. + +**Table A.5.2.1-5: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK351g45.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +From: +To: ;tag=151170 +Call-ID: +CSeq: +Event: +Expires: +Contact: +Content-Length: +``` + +#### 6. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.5.2.1-6 + +S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.5.2.1-6: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Contact: +Content-Length: +``` + +#### 7. 200 (OK) response (P-CSCF to UE) - see example in table A.5.2.1-7 + +The P-CSCF forwards the 200 (OK) response to the UE. + +**Table A.5.2.1-7: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: +Call-ID: +CSeq: +Event: +Expires: +Contact: +Content-Length: +``` + +#### 8. NOTIFY request (MRFC/AS to S-CSCF) - see example in table A.5.2.1-8 + +The MRFC/AS generates a NOTIFY request that includes information about all participants that the subscribing user is allowed to see. The information about one participant includes: + +- the SIP URI identifying the user; +- the dialog state associated for that users attachment to the conference; and +- the users status in terms of media in the conference. + +**Table A.5.2.1-8: NOTIFY request (MRFC/AS to S-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrfljlsj40a222 +CSeq: 42 NOTIFY +Subscription-State: active ;expires=7200 +Event: conference;recurse +Contact: +Content-Type: application/conference-info+xml +Content-Length: (...) + + + + entity="conference1@mrfc2.home1.net" + state="full" + version="0" + + John Doe + + connected + dialed-in + + audio + + 534232 + sendrecv + + + + Simon Moon + + on-hold + dialed-in + + audio + + 534232 + sendrecv + + + + + +``` + +**P-Charging-Vector:** The MRFC/AS populates the icid parameter with a globally unique value and populates the identifier of its own network to the terminating Inter Operator Identifier (IOI) parameter of this header. + +The message body in the NOTIFY request that carries the conference state information of the conference participants is formed as indicated in RFC 4575 [11]. + +## 9. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.5.2.1-9 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.5.2.1-9: NOTIFY request (S-CSCF to P-CSCF)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**10. NOTIFY request (P-CSCF to UE) - see example in table A.5.2.1-10** + +The P-CSCF forwards the NOTIFY request to the UE. + +**Table A.5.2.1-10: NOTIFY request (P-CSCF to UE)** + +``` + +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP mrfc2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) + +``` + +**11. 200 (OK) response (UE to P-CSCF) - see example in table A.5.2.1-11 (related to table A.5.2.1-10)** + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.5.2.1-11: 200 (OK) response (UE to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP mrfc2.home2.net;branch=z9hG4bK348923.1 +Record-Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +**12. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.5.2.1-12** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.5.2.1-12: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc2.home2.net;branch=z9hG4bK348923.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024" +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**13. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.5.2.1-13** + +The S-CSCF forwards the 200 (OK) response to the MRFC/AS. + +**Table A.5.2.1-13: 200 (OK) response (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc2.home2.net;branch=z9hG4bK348923.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=123551024"; orig-ioi=home1.net; + term-ioi=home1.net +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +--- + +## A.6 Flows demonstrating a user leaving a conference + +### A.6.1 Introduction + +Void + +### A.6.2 User leaving the conference + +#### A.6.2.1 MRFC/AS is located in user's home network + +Figure A.6.2.1-1 shows an user leaving a conference. The example shows the flow for the user, who created the conference with a conference-factory URI. For this example it is assume that the user is subscribed to the conference state event package at the MRFC/AS. + +![Sequence diagram showing the process of a user leaving a conference. The diagram is split into two network domains: Visited network (UE#1, P-CSCF) and UE#1 Home network (S-CSCF, MRFC/AS, MRFP). The sequence of messages is: 1. BYE (UE#1 to P-CSCF), 2. Remove resource reservation (P-CSCF internal), 3. BYE (P-CSCF to S-CSCF), 4. BYE (S-CSCF to MRFC/AS), 5. H.248 interaction to release connection resources for UE#1 (MRFC/AS to MRFP), 6. 200 OK (MRFP to MRFC/AS), 7. 200 OK (MRFC/AS to S-CSCF), 8. 200 OK (S-CSCF to P-CSCF), 9. NOTIFY (MRFC/AS to S-CSCF), 10. NOTIFY to other conference participants (MRFC/AS internal), 11. NOTIFY (S-CSCF to P-CSCF), 12. NOTIFY (P-CSCF to UE#1), 13. 200 OK (UE#1 to P-CSCF), 14. 200 OK (P-CSCF to S-CSCF), 15. 200 OK (S-CSCF to MRFC/AS).](b96be3d7d73fc1d7af1879bb57de1cc4_img.jpg) + +Sequence diagram showing the process of a user leaving a conference. The diagram is split into two network domains: Visited network (UE#1, P-CSCF) and UE#1 Home network (S-CSCF, MRFC/AS, MRFP). The sequence of messages is: 1. BYE (UE#1 to P-CSCF), 2. Remove resource reservation (P-CSCF internal), 3. BYE (P-CSCF to S-CSCF), 4. BYE (S-CSCF to MRFC/AS), 5. H.248 interaction to release connection resources for UE#1 (MRFC/AS to MRFP), 6. 200 OK (MRFP to MRFC/AS), 7. 200 OK (MRFC/AS to S-CSCF), 8. 200 OK (S-CSCF to P-CSCF), 9. NOTIFY (MRFC/AS to S-CSCF), 10. NOTIFY to other conference participants (MRFC/AS internal), 11. NOTIFY (S-CSCF to P-CSCF), 12. NOTIFY (P-CSCF to UE#1), 13. 200 OK (UE#1 to P-CSCF), 14. 200 OK (P-CSCF to S-CSCF), 15. 200 OK (S-CSCF to MRFC/AS). + +**Figure A.6.2.1-1: User leaving a conference** + +The details of the flows are as follows. + +**1. BYE (UE to P-CSCF) - see example in table A.6.2.1-1** + +A UE wants to leave a conference. For this purpose the UE sends a BYE message to the P-CSCF with the Conference-URI as the Request-URI. + +**Table A.6.2.1-1: BYE (UE to P-CSCF)** + +``` + +BYE sip:conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ; tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Cseq: 153 BYE +Content-Length: 0 + +``` + +**Request-URI:** contains the value of the Conference-URI as learned during conference creation. + +**2. Remove resource reservation** + +The P-CSCF removes the authorization for resources that had previously been issued for this endpoint for this session. This step will also result in a release indication to the GPRS subsystem to confirm that the IP bearers associated with the session have been deleted. + +### 3. BYE (P-CSCF to S-CSCF) - see example in table A.6.2.1-3 + +The P-CSCF removes the Security-Verify header, and the "sec-agree" option tag from the Require and Proxy-Require headers. As the Require and Proxy-Require headers are empty, it removes these headers completely. + +**Table A.6.2.1-3: BYE (P-CSCF to S-CSCF)** + +``` +BYE sip:conferencel@mrfcl.home1.net SIP/2.0 +Via: SIP/2.0/UDP pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +P-Access-Network-Info: +From: +To: +Call-ID: +Cseq: +Content-Length: 0 +``` + +### 4. BYE (S-CSCF to MRFC/AS) - see example in table A.6.2.1-4 + +The S-CSCF forwards the BYE to the MRFC/AS. + +**Table A.6.2.1-4: BYE (S-CSCF to MRFC/AS)** + +``` +BYE sip:conferencel@mrfcl.home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Access-Network-Info: +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +### 5. H.248 interaction to release resources + +The MRFC/AS interacts with the MRFP to release the resources reserved for UE#1 in this conference. + +### 6. 200 (OK) response (MRFC/AS to S-CSCF) - see example in table A.6.2.1-6 + +After successfully releasing the resources from the MRFP, the MRFC/AS sends a 200 (OK) response request to the S-CSCF. + +**Table A.6.2.1-6: 200 (OK) response (MRFC/AS to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +### 7. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.6.2.1-7 + +S-CSCF forwards the 200 (OK) response to the P-CSCF. + +**Table A.6.2.1-7: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +**8. 200 (OK) response (P-CSCF to UE) - see example in table A.6.2.1-8** + +P-CSCF forwards the message to the UE. + +**Table A.6.2.1-8: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +## 9. NOTIFY request (MRFC/AS to S-CSCF) - see example in table A.6.2.1-9 + +The MRFC/AS generates a NOTIFY request to indicate that UE#1 has left the conference and automatically unsubscribe UE#1 from its subscription to the conference event package. + +**Table A.6.2.1-9: NOTIFY request (MRFC/AS to S-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net +Route: , +From: ;tag=151170 +To: ;tag=31415 +Call-ID: b89rjhnedrflj40a222 +CSeq: 42 NOTIFY +Subscription-State: terminated +Event: conference +Contact: +Content-Type: application/conference-info+xml +Content-Length: (...) + + + + + John Doe + + disconnected + departed + + + + Simon Moon + + connected + dialed-in + + audio + + 534282 + inactive + + + + +``` + +**P-Charging-Vector:** The MRFC/AS populates the icid parameter with a globally unique value and populates the identifier of its own network to the originating Inter Operator Identifier (IOI) parameter of this header. + +**P-Charging-Function-Addresses:** The MRFC/AS populates the P-Charging-Function-Addresses header field to be passed to the S-CSCF. + +**Subscription-State:** Value of "terminated" indicates that the UE has been unsubscribed from the conference event package. + +The message body in the NOTIFY request that carries the conference state information of the conference participants is formed as indicated in RFC 4575 [11]. + +## 10. Other conference participants are notified + +MRFC/AS similarly notifies other conference participants that have subscribed to the conference event package that UE#1 has left the conference. + +## 11. NOTIFY request (S-CSCF to P-CSCF) - see example in table A.6.2.1-11 + +The S-CSCF forwards the NOTIFY request to the P-CSCF. + +**Table A.6.2.1-11: NOTIFY request (S-CSCF to P-CSCF)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK348923.1 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +Max-Forwards: 69 +Route: +Record-Route: +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +## 12. NOTIFY request (P-CSCF to UE) - see example in table A.6.2.1-12 + +The P-CSCF forwards the NOTIFY request to the UE. + +**Table A.6.2.1-12: NOTIFY request (P-CSCF to UE)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , +From: +To: +Call-ID: +CSeq: +Subscription-State: +Event: +Contact: +Content-Type: +Content-Length: + +(...) +``` + +## 13. 200 (OK) response (UE to P-CSCF) - see example in table A.6.2.1-13 (related to table A.6.2.1-12) + +The UE acknowledges the NOTIFY request with a 200 (OK) response to the P-CSCF. + +**Table A.6.2.1-13: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net:7531;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK348923.1 +Record-Route: , +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +**14. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.6.2.1-14** + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.6.2.1-14: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK348923.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024" +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +**15. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.6.2.1-15** + +The S-CSCF forwards the 200 (OK) response to the MRFC/AS. + +**Table A.6.2.1-15: 200 (OK) response (S-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK348923.1 +Record-Route: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=223551024"; orig-ioi=home1.net; + term-ioi=home1.net +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Content-Length: +``` + +## A.6.3 User requesting to remove another user from conference + +The call flows for a user requesting the removal of another user from a conference are basically identical to the call flows for a user requesting IMS to join another user (see subclause A.4.4). The call flows only differ in the Refer-To header of the REFER request, namely in the "method" parameter which is set to "BYE" instead of "INVITE" and the tasks performed by the MRFC/AS before sending the NOTIFY requests. + +## A.6.4 MRFC/AS drops a user from a conference + +### A.6.4.1 MRFC/AS is located in user's home network + +Figure A.6.4.1-1 shows an MRFC/AS dropping a user from a conference. + +![Sequence diagram showing the interaction between UE#1, P-CSCF, S-CSCF, MRFC/AS, and MRFP for dropping a user from a conference. The diagram is split into Visited network (UE#1, P-CSCF) and UE#1 Home network (S-CSCF, MRFC/AS, MRFP). The sequence of messages is: 1. BYE (MRFC/AS to S-CSCF), 2. BYE (S-CSCF to P-CSCF), 3. Remove resource reservation (P-CSCF), 4. BYE (P-CSCF to UE#1), 5. 200 OK (UE#1 to P-CSCF), 6. 200 OK (P-CSCF to S-CSCF), 7. 200 OK (S-CSCF to MRFC/AS), 8. H.248 interaction to release connection resources for UE#1 (MRFC/AS to MRFP), 9. Event notification messages (MRFC/AS to S-CSCF).](573293af67ee571aef04bf725fcefbe5_img.jpg) + +Sequence diagram showing the interaction between UE#1, P-CSCF, S-CSCF, MRFC/AS, and MRFP for dropping a user from a conference. The diagram is split into Visited network (UE#1, P-CSCF) and UE#1 Home network (S-CSCF, MRFC/AS, MRFP). The sequence of messages is: 1. BYE (MRFC/AS to S-CSCF), 2. BYE (S-CSCF to P-CSCF), 3. Remove resource reservation (P-CSCF), 4. BYE (P-CSCF to UE#1), 5. 200 OK (UE#1 to P-CSCF), 6. 200 OK (P-CSCF to S-CSCF), 7. 200 OK (S-CSCF to MRFC/AS), 8. H.248 interaction to release connection resources for UE#1 (MRFC/AS to MRFP), 9. Event notification messages (MRFC/AS to S-CSCF). + +**Figure A.6.4.1-1: MRFC/AS dropping a user from a conference** + +The details of the flows are as follows. + +**1. BYE (MRFC/AS to S-CSCF) - see example in table A.6.4.1-1** + +MRFC/AS decides to drop a user from a conference. The decision may be based on a change in the conference policy, because the conference lifetime is exceeded, or some other reason. + +The MRFC/AS issues a BYE request to the S-CSCF. + +**Table A.6.4.1-1: BYE (MRFC/AS to S-CSCF)** + +``` +BYE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +Route: , +From: ; tag=314159 +To: ; tag=171828 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 73 BYE +Content-Length: 0 +``` + +**Request-URI:** contains the Contact address of the dropped user. + +**2. BYE (S-CSCF to P-CSCF) - see example in table A.6.4.1-2** + +The S-CSCF forwards the BYE request to the P-CSCF. + +**Table A.6.4.1-2: BYE (S-CSCF to P-CSCF)** + +``` +BYE sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +### 3. Remove resource reservation + +The P-CSCF removes the authorization for resources that had previously been issued for this endpoint for this session. This step will also result in a release indication to the GPRS subsystem to confirm that the IP bearers associated with the session have been deleted. + +### 4. BYE (P-CSCF to UE) - see example in table A.6.4.1-4 + +The P-CSCF forwards the BYE to the UE. + +**Table A.6.4.1-4: BYE (P-CSCF to UE)** + +``` +BYE sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +### 5. 200 (OK) response (UE to P-CSCF) - see example in table A.6.4.1-5 + +After successfully releasing the resources from the MRFP, the MRFC/AS sends a 200 (OK) response to the S-CSCF. + +**Table A.6.4.1-5: 200 (OK) response (UE to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: +To: +Call-ID: +Cseq: +Content-Length: 0 +``` + +### 6. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.6.4.1-6 + +P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.6.4.1-6: 200 (OK) response (P-CSCF to S-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK348923.1 +P-Access-Network-Info: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +## 7. 200 (OK) response (S-CSCF to MRFC/AS) - see example in table A.6.4.1-7 + +S-CSCF forwards the 200 (OK) response to the MRFC/AS. + +**Table A.6.4.1-7: 200 (OK) response (S-CSCF to MRFC/AS)** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SIP/2.0 200 OK Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK348923.1 P-Access-Network-Info: From: To: Call-ID: Cseq: Content-Length:
| +|---------------------------------------------------------------------------------------------------------------------------------------------------| + +## 8. H.248 interaction to release resources + +MRFC/AS interacts with the MRFP to release the resources reserved for UE#1 in this conference. + +## 9. Conference event package messages + +The MRFC/AS also terminates the user's subscription to the conference state event package. The message flow is identical to messages 6.5.2.1-9 to 6.5.2.1-15 in subclause 6.5.2.1. for an user leaving a conference. + +--- + +# A.7 Flows demonstrating conference termination + +## A.7.1 General + +The SIP based flows for conference termination look identical to the call flows for a user leaving a conference (see subclause A.6.2) / a user being removed from a conference (see subclause A.6.4). The termination of the conference itself, after the last user has left / has been removed from the conference does not result in any exchange of SIP messages. + +--- + +# A.8 Flows demonstrating usage of hold and resume during conferences + +The hold- and resume-service is already described in 3GPP TS 24.228 [4] and the related call flows can be readily applied for the IMS conferencing service. The handling of a conference put on hold by one user is a local matter at the MRFC. + +--- + +# A.9 Flows demonstrating the use of the Replaces header + +## A.9.1 POTS subscriber invited to a conference + +![Sequence diagram showing CONF interworking signalling flow in case of an active session between NGN and PSTN. The diagram involves UE-A, P-CSCF, S-CSCF, AS/MRFC (with MRFP), MGCF (with MGW), and PSTN/ISDN. It details 47 steps of SIP and H.248 signaling, including INVITE, IAM, ANM, 200 OK, ACK, REFER, NOTIFY, and BYE messages, as well as RTP and Information Channel establishment.](df72bd7468eb8bd59e911d0b5cb7a810_img.jpg) + +``` + +sequenceDiagram + participant UEA as UE-A + participant PCSCF as P-CSCF + participant SCSCF as S-CSCF + participant ASMRFC as AS/MRFC + participant MGCF as MGCF + participant PSTNISDN as PSTN/ISDN + + Note over ASMRFC: MRFP + Note over MGCF: MGW + + UEA->>PCSCF: 1. INVITE + PCSCF->>SCSCF: 2. INVITE + SCSCF->>ASMRFC: 3. INVITE + MGCF->>MGCF: 4. H.248 interaction + MGCF->>PSTNISDN: 5. IAM + PSTNISDN->>MGCF: 6. Resource reservation + MGCF->>PSTNISDN: 7. ANM + MGCF->>MGCF: 8. H.248 interaction + MGCF->>ASMRFC: 9. 200 OK + ASMRFC->>SCSCF: 10. 200 OK + SCSCF->>PCSCF: 11. 200 OK + PCSCF->>UEA: 12. ACK + UEA->>PCSCF: 13. ACK + PCSCF->>SCSCF: 14. ACK + SCSCF->>ASMRFC: RTP + ASMRFC->>MGCF: Information Channel + MGCF->>PSTNISDN: Information Channel + + UEA->>PCSCF: 15. INVITE + PCSCF->>SCSCF: 16. INVITE + SCSCF->>ASMRFC: 17. INVITE + ASMRFC->>ASMRFC: 18. H.248 interaction + ASMRFC->>SCSCF: 19. 200 OK + SCSCF->>PCSCF: 20. 200 OK + PCSCF->>UEA: 21. 200 OK + UEA->>PCSCF: 22. ACK + PCSCF->>SCSCF: 23. ACK + SCSCF->>ASMRFC: 24. ACK + UEA->>ASMRFC: RTP + + UEA->>PCSCF: 25. REFER + PCSCF->>SCSCF: 26. REFER + SCSCF->>ASMRFC: 27. REFER + ASMRFC->>SCSCF: 28. NOTIFY + SCSCF->>PCSCF: 29. NOTIFY + PCSCF->>UEA: 30. NOTIFY + ASMRFC->>SCSCF: 31. INVITE + SCSCF->>MGCF: 32. INVITE + MGCF->>MGCF: 33. H.248 interaction + MGCF->>SCSCF: 34. 200 OK + SCSCF->>ASMRFC: 35. 200 OK + ASMRFC->>SCSCF: 36. ACK + SCSCF->>MGCF: 37. ACK + MGCF->>ASMRFC: RTP + ASMRFC->>SCSCF: 38. NOTIFY + SCSCF->>PCSCF: 39. NOTIFY + PCSCF->>UEA: 40. NOTIFY + Note over MGCF: 41. switching existing information channel to new RTP session + MGCF->>SCSCF: 42. BYE + SCSCF->>PCSCF: 43. BYE + PCSCF->>UEA: 44. BYE + UEA->>PCSCF: 45. 200 OK + PCSCF->>SCSCF: 46. 200 OK + SCSCF->>MGCF: 47. 200 OK + UEA->>MGCF: no RTP sent + +``` + +Sequence diagram showing CONF interworking signalling flow in case of an active session between NGN and PSTN. The diagram involves UE-A, P-CSCF, S-CSCF, AS/MRFC (with MRFP), MGCF (with MGW), and PSTN/ISDN. It details 47 steps of SIP and H.248 signaling, including INVITE, IAM, ANM, 200 OK, ACK, REFER, NOTIFY, and BYE messages, as well as RTP and Information Channel establishment. + +**Figure A.9-1: CONF interworking signalling flow in case of an active session between NGN and PSTN** + +UE-A is in an active voice session with a PSTN/ISDN TE (SIP dialog with Call-ID, to-tag and from-tag between UE-A and MGCF). It then creates a conference and invites the PSTN/ISDN TE to the conference by sending a REFER to the conference focus, which invites the PSTN/ISDN TE to the conference by sending an INVITE which includes the Replaces header to the MGCF. The MGCF confirms the session, switches the existing information channel to the new RTP session, and terminates the session which is replaced. + +NOTE: The example given in the figure above assumes that the INVITE request sent from the UE and the INVITE request sent from the AS/MRFC are routed to the same MGCF. + +1. – 3. UE-A initiates a voice session with a PSTN/ISDN TE by sending an INVITE to the MGCF. + +**Table A.9-1: 1.INVITE (UE-A to P-CSCF)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu, 199 +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port- +c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +NOTE: Intermediate steps (183 (Session Progress), PRACK, UPDATE and related responses are not shown) + +4. H.248 interaction + +5. SS7: IAM + +6. resource reservation + +7. SS7: ANM + +8. H.248 interaction + +9. – 11. The MGCF sends a final response back to the session originator. + +**Table A.9-2: 9. 200 OK (MGCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP bgpcf1.home1.net;branch=z9hG4bK6546q2.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.home1.net;branch=z9hG4bK431h23.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 + +``` + +``` + +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: +Privacy: none +From: +To: ;tag=314159 +Call-ID: +CSeq: +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE +RSeq: 9021 +Content-Length: 0 + +``` + +12. – 14. The Calling party acknowledges the final response with an ACK request. + +15. – 24. UE-A creates a conference by sending an INVITE to the Conference URI and connects to the conference. + +**Table A.9-3: 15. INVITE request (UE-A to P-CSCF)** + +``` + +INVITE sip:conference-factory1@mrfcl.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171829 +To: +Call-ID: cb03a0s09a2sdfglkj490444 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: precondition, 100rel, gruu, 199 +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept: application/sdp, .application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MPVMP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +NOTE: Intermediate steps (183 (Session Progress), PRACK, UPDATE and related responses are not shown) + +25. – 27. UE-A invites the PSTN/ISDN TE to the conference by sending a REFER request to the conference focus, the ‘method’ parameter set to ‘INVITE’. The Refer-To header of the REFER request includes the Replaces parameter with Call-ID, to-tag and from-tag from the existing SIP dialog. + +**Table A.9-4: 25. REFER request (UE-A to P-CSCF)** + +``` +REFER sip: conference1@mrfc1.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171829 +To: + +Call-ID: cb03a0s09a2sdfglkj490555 +Cseq: 127 REFER +Require: sec-agree +Refer-To: +Referred-By: +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; + port-c=8642; port-s=7531 +Contact: +Content-Length: 0 +``` + +28. – 30. The conference focus sends a NOTIFY request containing information about the progress of the REFER request processing. The Subscription-State is set to ‘active’. + +31. – 32.. The conference focus invites the PSTN/ISDN TE by sending a INVITE request to the MGCF. The INVITE request includes the Replaces header with Call-ID, to-tag and from-tag from the existing SIP dialog. + +**Table A.9-5: INVITE request (MRFC/AS to S-CSCF)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: none +From: ;tag=171123 +To: + +Call-ID: bc03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: replaces +Replaces: cb03a0s09a2sdfglkj490333,to-tag=314159;from-tag=171828 +Supported: precondition, 100rel, gruu +Referred-By: +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +Allow-Events: conference, pending-additions +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::abc:def:abc:abc +s=- +c=IN IP6 5555::abc:def:abc:def +t=0 0 +m=video 10001 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +NOTE: Intermediate steps (183 (Session Progress), PRACK, UPDATE and related responses are not shown) + +33. H.248 interaction. + +34. – 35. The MGCF sends a final response back to the session originator. + +36. – 37. The Calling party acknowledges the final response with an ACK request. + +38. – 40. The conference focus sends a NOTIFY request containing information about the progress of the REFER request processing. The Subscription-State is set to 'terminated'. + +41. The MGCF replaces the existing RTP stream to UE-A with the new RTP stream to the conference mixer. + +42. – 44. The MGCF releases the session with UE-A by sending a BYE request to UE-A. + +45. – 47. UE-A responds with a 200 OK response. + +--- + +## Annex B (normative): SDP a=content attribute "g.3gpp.conf" value + +### B.1 Introduction + +This annex provides the IANA registration information for a new value, g.3gpp.conf, for the SDP a=content media-level attribute defined in RFC 4796 [40]. The attribute value is used indicate that an SDP media description is associated with the conference service + +**Editor's note: [PC\_VBC, CR0133] The following parameter should be registered immediately on approval of this specification, and the registration in error removed from "att-field (media level only)" table.** + +### B.2 New value + +IANA registration table: "content SDP Parameters" table of "Session Description Protocol (SDP) Parameters" registry + +SDN name: g.3gpp.conf + +Description: Stream associated with the 3GPP conference service. + +Reference: 3GPP TS 24.147 + +## Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------|--| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | | +| 2003-06 | | | | | Version 0.0.1: Initial version for discussion on conference call with interested parties | | | | +| 2003-06 | | | | | Version 0.0.2: Revised version after phone conference;
- introducing new structure for clauses 5 to 8
- Annex A made informative
- editorial issues
- alignment between Conferencing and Presence TS | | | | +| 2003-06 | | | | | Version 0.0.3:
- introduced editorial changes as indicated on CN1 Mailing list
- introduced references to RFC 3261 and SIP conf framework draft
- clarified the relation of roles and functional entities in clause 5 and 6 | | | | +| 2003-06 | | | | | Version 0.0.4: added TS-number | | | | +| 2003-07 | | | | | Version 0.0.5: small editorials
Added some abbreviations | | | | +| 2003-08 | | | | | Version 0.0.6: updates due to comments received during CN1#31 - deleted former clause A.8 (Flow demonstrating SIMPLE based instant message conferences) | N1-031122 | N1-031280 | | +| 2003-09 | | | | | Version 0.1.0: Title updated | | | | +| 2004-05 | | | | | Version 1.0.0 created as the outcome of CN#34 (Zagreb, Croatia). Material was shifted from version 3GPP TR 29.847 version 2.0.0 based on the agreed CR in N1-040875. | | | | +| 2004-05 | | | | | Version 1.0.1 created due to editorials indicated by e-mail after CN1#34 meeting. Furthermore re-introduced last paragraph of scope clause as well as two editor's notes, as they could not be agreed to be deleted (they were deleted during the shifting process). | | | | +| 2004-06 | | | | | Version 1.1.0 created as the outcome of CN#34bis (Helsinki, Finland). Changes applied based on the following agreed tdocs:
- N1-041127 - Messaging Conferences Editors Note Deletion
- N1-041128 - Shifting Leftovers
- N1-041130 - Discovery Deletion
- N1-041131 - Air Interface Load
- N1-041163 - SDP for UE
- N1-041165 - CN5 Work Editors Note Deletion
- N1-041213 - Clause 5, editorial issues
- N1-041256 - Abnormal Cases Cleanup
- N1-041258 - Auto Unsubscribe
- N1-041259 - AS originated requests
- N1-041261 - Authentication Procedure
- N1-041264 - Reference to Referred-By
- N1-041291 - Cx PSI Query
- N1-041292 - CPCP clarifications
- N1-041293 - Conference Termination by Means of CPCP
- N1-041311 - Simplification of CPCP clause
Smaller editorial changes, especially in the area of protected spaces and references to draft-numbers, were performed by the editor without asking for further permission. | | | | +| 2004-08 | | | | | Version 1.2.0 created as the outcome of CN#35 (Sophia Antipolis, France). Changes applied based on the following agreed tdocs:
- N1-041363 - request handling in focus
- N1-041459 - scope corrections
- N1-041574 - removal of all conference participants
- N1-041575 - rework of CPCP clause
- N1-041576 - security procedure in CPCP flows
- N1-041577 - adding of floor control protocol
Smaller editorial changes were performed by the editor. | | | | +| 2004-09 | | | | | Version 2.0.0 created to be sent for approval, editorial changes introduced by ETSI/MCC | 1.2.0 | 2.0.0 | | +| 2004-09 | NP-25 | NP-040367 | | | The draft was approved and the specification TS 24.147 is brought under the change control. Additional editorial clean-up by ETSI/MCC. | 2.0.0 | 6.0.0 | | +| 2004-12 | NP-26 | NP-040505 | 001 | | Removing editor's note on other protocols | 6.0.0 | 6.1.0 | | +| 2004-12 | NP-26 | NP-040505 | 007 | | Alternative procedure for removing all conference participants | 6.0.0 | 6.1.0 | | +| 2004-12 | NP-26 | NP-040505 | 008 | 1 | Update of SIP Chapter to new CPCP terminology | 6.0.0 | 6.1.0 | | +| 2004-12 | NP-26 | NP-040505 | 009 | | Update of CPCP Chapter | 6.0.0 | 6.1.0 | | +| 2004-12 | NP-26 | NP-040505 | 010 | 1 | Removal of "Conference Notification Service" Role | 6.0.0 | 6.1.0 | | + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|----------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2004-12 | NP-26 | NP-040505 | 011 | 1 | Update of signaling flows | 6.0.0 | 6.1.0 | +| 2004-12 | NP-26 | NP-040505 | 012 | 1 | Introduction of XCAP Change | 6.0.0 | 6.1.0 | +| 2004-12 | NP-26 | NP-040505 | 013 | 1 | Correction of BFCP clause | 6.0.0 | 6.1.0 | +| 2004-12 | NP-26 | NP-040505 | 016 | 1 | Correction Flow Adding a user to the conference with CPCP | 6.0.0 | 6.1.0 | +| 2004-12 | NP-26 | NP-040505 | 017 | 1 | Correction - Flow "conference creation with CPCP" | 6.0.0 | 6.1.0 | +| 2004-12 | NP-26 | NP-040505 | 018 | 1 | Correction expelling/terminating flow using CPCP | 6.0.0 | 6.1.0 | +| 2004-12 | NP-26 | NP-040505 | 019 | | p-asserted id in response from conf AS/MRFC | 6.0.0 | 6.1.0 | +| 2005-03 | NP-27 | NP-050072 | 022 | 2 | Deleting CPCP and BFCP from Rel-6 IMS Conferencing | 6.1.0 | 6.2.0 | +| 2005-03 | NP-27 | NP-050073 | 020 | 1 | Resolution of references to 24.228 | 6.1.0 | 6.2.0 | +| 2005-06 | CP-28 | | | | Removal of references related to bootstrapping for the conference service in Release 6 | | | +| | | CP-050060 | 024 | | | 6.2.0 | 6.3.0 | +| 2005-12 | CP-30 | CP-050552 | 026 | | Support of floor control | 6.3.0 | 7.0.0 | +| 2006-03 | CP-31 | CP-060118 | 0027 | 1 | Shift conference material from 24.819 to 24.147 | 7.0.0 | 7.1.0 | +| 2006-03 | CP-31 | CP-060163 | 0028 | 2 | Removal of the PDF | 7.0.0 | 7.1.0 | +| 2006-03 | CP-31 | CP-060126 | 0029 | - | Inviting to a Conference | 7.0.0 | 7.1.0 | +| 2006-03 | CP-31 | CP-060126 | 0030 | 1 | Joining a Conference | 7.0.0 | 7.1.0 | +| 2006-03 | CP-31 | CP-060111 | 0031 | 1 | Correcting requirement of conference mixer | 7.0.0 | 7.1.0 | +| 2006-03 | CP-31 | CP-060111 | 0034 | 1 | IETF reference updates | 7.0.0 | 7.1.0 | +| 2006-09 | CP-33 | CP-060467 | 0037 | 2 | Ad-hoc conferencing with multiple users | 7.1.0 | 7.2.0 | +| 2006-09 | CP-33 | CP-060504 | 0039 | 1 | Removal of Editor's notes in 24.147 | 7.1.0 | 7.2.0 | +| 2006-11 | CP-34 | CP-060655 | 0041 | - | RFC reference update | 7.2.0 | 7.3.0 | +| 2007-03 | CP-35 | CP-070149 | 0048 | | BFCP reference update | 7.3.0 | 7.4.0 | +| 2007-03 | CP-35 | CP-070149 | 0049 | | SDP usage in association with BFCP | 7.3.0 | 7.4.0 | +| 2007-06 | CP-36 | CP-070370 | 0050 | 4 | Modification of the conference ability of MGCF | 7.4.0 | 7.5.0 | +| 2007-06 | CP-36 | CP-070387 | 0055 | 1 | Some corrections to IMS conference | 7.4.0 | 7.5.0 | +| 2007-09 | CP-37 | CP-070595 | 0056 | 1 | Correction of invitation of users to a conference | 7.5.0 | 7.6.0 | +| 2007-09 | CP-37 | CP-070596 | 0058 | 1 | Proposal for CONF | 7.5.0 | 7.6.0 | +| 2007-12 | CP-38 | CP-070802 | 0060 | 2 | Correction of CONF creation by including URI list | 7.6.9 | 7.7.0 | +| 2007-12 | CP-38 | CP-070810 | 0054 | 4 | Incorporation of roles relating draft-ietf-consent-framework | 7.7.0 | 8.0.0 | +| 2008-03 | CP-39 | CP-080118 | 0064 | 2 | Support for BYE method | 8.0.0 | 8.1.0 | +| 2008-12 | CP-42 | CP-080854 | 0067 | | Media control for conferencing | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | CP-080854 | 0068 | | Note on conference examples | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | CP-080843 | 0070 | | Reference updates (release 7 ietf dependencies) | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | CP-080848 | 0071 | | Reference updates (release 8 ietf dependencies) | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | CP-080846 | 0074 | 2 | Correction of reference and flows in 24.147 | 8.1.0 | 8.2.0 | +| 2009-09 | CP-45 | CP-090682 | 0075 | 2 | Correction of URI list conference activation | 8.2.0 | 9.0.0 | +| 2009-12 | CP-46 | CP-090923 | 0076 | | Using conferencing MO | 9.0.0 | 9.1.0 | +| 2009-12 | CP-46 | CP-090940 | 0077 | | Obsolete drafts referenced | 9.0.0 | 9.1.0 | +| 2009-12 | CP-46 | CP-090920 | 0081 | 1 | 3-way session creation correction | 9.0.0 | 9.1.0 | +| 2009-12 | CP-46 | | | | Editorial cleanup by MCC | 9.0.0 | 9.1.0 | +| 2010-12 | CP-50 | CP-100864 | 0084 | 2 | Adding Mr' Interface in the Architecture when providing conference | 9.1.0 | 10.0.0 | +| 2011-06 | CP-52 | CP-110465 | 0085 | 2 | Clarification of start 3 party call procedure | 10.0.0 | 10.1.0 | +| 2011-12 | CP-54 | CP-110864 | 0089 | 3 | Deletion of call flow related Editor's Notes in 24.147 (Rel-8) | 10.1.0 | 10.2.0 | +| 2011-12 | CP-54 | CP-110881 | 0090 | | RFC Correction 24.147 | 10.2.0 | 11.0.0 | +| 2012-03 | CP-55 | CP-120124 | 0091 | | Correcting references | 11.0.0 | 11.1.0 | +| 2013-09 | CP-61 | CP-130511 | 0099 | 1 | User joining a conference by using a conference URI | 11.1.0 | 12.0.0 | +| 2013-12 | CP-62 | CP-130728 | 0103 | | Reference update: draft-kaplan-insipid-session-id | 12.0.0 | 12.1.0 | +| 2013-12 | CP-62 | CP-130770 | 0104 | 2 | Updating TS 24.147 to RFC 6665 | 12.0.0 | 12.1.0 | +| 2013-12 | CP-62 | CP-130763 | 0105 | 1 | Editorial corrections to align with style conventions | 12.0.0 | 12.1.0 | +| 2013-12 | CP-62 | CP-130770 | 0108 | 1 | Updating TS 24.147 to RFC 6665 for Record-Route header | 12.0.0 | 12.1.0 | +| 2014-06 | CP-64 | CP-140330 | 0109 | | Editorial corrections | 12.1.0 | 12.2.0 | +| 2014-06 | CP-64 | CP-140333 | 0110 | 2 | Conference event subscription fallback. | 12.1.0 | 12.2.0 | +| 2014-09 | CP-65 | CP-140635 | 0115 | 1 | Confrencing – references correction | 12.2.0 | 12.3.0 | +| 2014-12 | | | | | Replacing draft-kaplan-insipid-session-id with draft-ietf-insipid-session-id | | | +| | CP-66 | CP-140837 | 0122 | 3 | | 12.3.0 | 12.4.0 | +| 2015-03 | CP-67 | CP-150067 | 0123 | 3 | Update REFER to reflect RFC 6665 | 12.4.0 | 12.5.0 | +| 2015-03 | CP-67 | CP-150063 | 0124 | 1 | Reference update: draft-ietf-insipid-session-id | 12.4.0 | 12.5.0 | +| 2015-12 | CP-70 | | | | Upgrade to Rel-13 | 12.5.0 | 13.0.0 | +| 2016-03 | | | | | Update draft-ietf-sipcore-refer-clarifications reference to reflect RFC 7647 | | | +| | CP-71 | CP-160068 | 0126 | 1 | | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT-75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-06 | CT-76 | CP-171060 | 0129 | 2 | A | Reference update of draft-ietf-insipid-session-id-13 to RFC 7989 | 14.1.0 | +| 2018-06 | CT-80 | CP-181073 | 0133 | 1 | B | g.3gpp.conf value | 15.0.0 | +| 2019-12 | CT-86 | CP-193116 | 0134 | 1 | F | Enhancements related to how UE should handle conference subscription failure. | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24171/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/24_series/24171/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55376a7ea4c9fb111f177a6ae9246a78693b0d0e --- /dev/null +++ b/marked/Rel-16/24_series/24171/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c50b6139203300070a636a61289a25a71fae62568c7fbeea085f51481ca94d1f +size 109137 diff --git a/marked/Rel-16/24_series/24171/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/24_series/24171/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9656b076fab75cab95b21151f68af13f7245d45a --- /dev/null +++ b/marked/Rel-16/24_series/24171/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cee1f304c25995e957f153b8cd40ff92857afe459f476efa2ee1c66d4c52c1e4 +size 146323 diff --git a/marked/Rel-16/24_series/24171/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/24_series/24171/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7ad647b2827b9f8b83bc5bc86f18045fbebfc34 --- /dev/null +++ b/marked/Rel-16/24_series/24171/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:768193bb267a2d4c85c0c6790c9fdf7aa5cef626734835d0d9bfce31bf15ce2f +size 76041 diff --git a/marked/Rel-16/24_series/24171/bffdddb47fced140f8d17fdc2a29f592_img.jpg b/marked/Rel-16/24_series/24171/bffdddb47fced140f8d17fdc2a29f592_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac419ed3aec6e84bda1a3e118229f537048b1064 --- /dev/null +++ b/marked/Rel-16/24_series/24171/bffdddb47fced140f8d17fdc2a29f592_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e431bbc3509246d94b01487eecf64d2568796488843fa16703ec9f8a9285fa47 +size 165026 diff --git a/marked/Rel-16/24_series/24171/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/24_series/24171/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e362140421a4f55fbc8c3e90bf9b26f5800ad655 --- /dev/null +++ b/marked/Rel-16/24_series/24171/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0e1e9a061f3a3fda978891d3554b9c85036e0a83036b6ea487b49590f8df4fc3 +size 108234 diff --git a/marked/Rel-16/24_series/24171/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/24_series/24171/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2197e9e4cbef726cdd2ddedb575de70c59d334d --- /dev/null +++ b/marked/Rel-16/24_series/24171/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1dc97b31c2b2623930af31f87b6a0ef1848c16ad218b4073ef112b61ac05d929 +size 154387 diff --git a/marked/Rel-16/24_series/24171/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/24_series/24171/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b96f05ba9f70f0ce8754a48ddda7f1932cf736f --- /dev/null +++ b/marked/Rel-16/24_series/24171/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f15861615d0da92d749b68192ef16f3af6ef6de156172b6191698c21dfc99da +size 80072 diff --git a/marked/Rel-16/24_series/24171/raw.md b/marked/Rel-16/24_series/24171/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8d586e27281d4154d5f3d3e647fc9e6f598d271e --- /dev/null +++ b/marked/Rel-16/24_series/24171/raw.md @@ -0,0 +1,443 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 General..... | 6 | +| 4.1 Overview ..... | 6 | +| 4.1.1 NAS aspect ..... | 6 | +| 4.1.2 LCS aspect..... | 6 | +| 4.2 LCS Support capabilities..... | 6 | +| 4.2.1 UE support of LCS ..... | 6 | +| 4.2.2 MME support of LCS..... | 7 | +| 5 Support of LCS signaling..... | 7 | +| 5.1 General ..... | 7 | +| 5.2 LCS operations..... | 7 | +| 5.2.0 General ..... | 7 | +| 5.2.1 Network initiated location services operations..... | 7 | +| 5.2.1.1 Location Notification..... | 7 | +| 5.2.1.1.0 General ..... | 7 | +| 5.2.1.1.1 Normal operation..... | 8 | +| 5.2.1.2 Network initiated Positioning Information Transport ..... | 9 | +| 5.2.2 Mobile initiated location services operations ..... | 10 | +| 5.2.2.1 Mobile Originated Location Request (MO-LR) ..... | 10 | +| 5.2.2.1.0 General ..... | 10 | +| 5.2.2.1.1 Normal operation..... | 11 | +| 5.2.2.2 Mobile initiated Positioning Information Transport..... | 15 | +| 5.3 LCS messages and coding..... | 16 | +| 5.3.1 Messages for common LCS operations..... | 16 | +| 5.3.2 Messages for E-UTRAN LCS operations only ..... | 16 | +| 5.3.2.1 LPP Messages..... | 16 | +| 5.3.2.1.1 Downlink Positioning Information Transport using LPP messages ..... | 16 | +| 5.3.2.1.2 Uplink Positioning Information Transport using LPP messages ..... | 16 | +| Annex A (informative): Change history..... | 17 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the operations and information coding for the Non-access Stratum (NAS) layer protocol for supporting the Location Services (LCS) in the Evolved Universal Terrestrial Radio Access Network (E-UTRAN). + +The present document is applicable to the User Equipment (UE) and to the Mobility Management Entity (MME) in the Evolved Packet System (EPS). + +The present document is developed in accordance to the general principles stated in 3GPP TS 23.271 [1]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.271: "Functional stage 2 description of LCS". +- [3] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS)". +- [4] 3GPP TS 36.355: "LTE Positioning Protocol". +- [5] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [6] 3GPP TS 24.030: "LCS Supplementary service operations; Stage 3". +- [7] 3GPP TS 29.171: "Definition of SLs interface for Control Plane LCS". +- [8] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +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]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.272 [8] apply: + +**CS fallback** + +## 3.2 Abbreviations + +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]. + +| | | +|---------|----------------------------------------------------| +| EPS | Evolved Packet System | +| IE | Information Element | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | + +| | | +|-------|------------------------------------| +| LCS | Location Services | +| LPP | LTE Positioning Protocol | +| LTE | Long Term Evolution | +| MME | Mobility Management Entity | +| MO-LR | Mobile Originated Location Request | +| MT-LR | Mobile Terminated Location Request | +| NAS | Non-access Stratum | +| UE | User Equipment | + +# --- 4 General + +## 4.1 Overview + +### 4.1.1 NAS aspect + +To enable transfer of application protocol messages between the MME and the UE, a generic "container" message is defined on the downlink (Downlink Generic NAS Transport message) and the uplink (Uplink Generic NAS Transport message). The message protocol and procedures are described in 3GPP TS 24.301 [3]. + +### 4.1.2 LCS aspect + +Location Services (LCS) uses the generic containers provided by the NAS Generic Transport mechanism to transfer LCS signalling messages between the UE and the network. + +Currently, container in the generic transport messages can carry the following LCS information: + +- LTE Positioning Protocol (LPP) messages (Refer to 3GPP TS 36.355 [4]) + - Both downlink and uplink LPP messages are supported + - A Routing Identifier is transported as the Additional Information IE in Uplink/Downlink Generic NAS Transport message for LPP messages (Refer to 3GPP TS 24.301 [3]) +- Location services messages + - Messages for MO-LR operations (Refer to 3GPP TS 24.080 [5]) + - Messages for MT-LR LCS location notification (Refer to 3GPP TS 24.080 [5]) + +## 4.2 LCS Support capabilities + +### 4.2.1 UE support of LCS + +The UE announces to the network its ability to support LCS notification mechanism and/or LPP messages using the UE Network Capability IE defined in 3GPP TS 24.301 [3]. + +### 4.2.2 MME support of LCS + +The network announces to the UE its ability to support LCS MO-LR mechanism in E-UTRAN and GERAN/UTRAN using the EPS network feature support IE defined in 3GPP TS 24.301[3]. These information are taken into account by the UE, in addition to UE's LCS and CSFB capabilities for UE to determine whether to initiate EPC-MO-LR procedure or CS fallback procedure for CS-MO-LR in GERAN/UTRAN as specified in 3GPP TS 23.272 [8], subclause 8.3.1. + +# --- 5 Support of LCS signaling + +## 5.1 General + +This clause defines the E-UTRAN LCS operations (subclause 5.2) and the format and coding of the messages (subclause 5.3). + +The messages defined in this subclause can be transported in the Downlink Generic NAS Transport message and the Uplink Generic NAS Transport message defined in 3GPP TS 24.301 [3]. + +## 5.2 LCS operations + +### 5.2.0 General + +The operations defined in this subclause are for E-UTRAN LCS support only. + +The MO-LR operation and the Location Notification operation for E-UTRAN LCS are similar to that for GERAN and UTRAN LCS. The operations for GERAN and UTRAN location signalling support are defined in 24.030 [6]. + +### 5.2.1 Network initiated location services operations + +#### 5.2.1.1 Location Notification + +##### 5.2.1.1.0 General + +The Location Notification operation enables the MME to trigger the end-user notification verification process on the UE using NAS signaling. The NAS signaling (see 5.2.1.1.1) are transported using the Downlink Generic NAS Transport message and the Uplink Generic NAS Transport message defined in 3GPP TS 24.301 [3]. Figure 5.2.1.1.0-1 illustrates an example of the NAS signaling transport for an EPC-MT-LR session. + +![Sequence diagram showing NAS signaling transport for Location Notification between UE and MME. The diagram includes two callout boxes explaining the message structure and the UE's response process.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MME + Note right of MME: When an EPC-MT-LR location session is initiated at MME, if the LCS notification/verification is required and is supported by the UE, the MME sets the Generic Message Container Type to "Location services message container", and includes LCS Notification Verification Invoke in the Generic Message Container in the Downlink Generic NAS Transport message. + MME->>UE: Downlink Generic NAS Transport (LCSMsgContainer, REGISTER(Facility(LCS-LocationNotification Invoke))) + Note left of UE: After user notification and verification, the UE sets the Generic Message Container Type to "Location services message container", and includes LCS Notification Verification Return Result in the Generic Message Container in the Uplink Generic NAS Transport message. + UE->>MME: Uplink Generic NAS Transport (LCSMsgContainer, RELEASE COMPLETE(Facility(LCS-LocationNotification Return Result))) + +``` + +Sequence diagram showing NAS signaling transport for Location Notification between UE and MME. The diagram includes two callout boxes explaining the message structure and the UE's response process. + +**Figure 5.2.1.1.0-1: NAS signaling transport for Location Notification** + +NOTE: The optional Additional Information IE of the Downlink/Uplink Generic NAS Transport message is not used when the LCS Location Notification signaling are transported in the Generic Message Container. + +##### **5.2.1.1.1 Normal operation** + +The network invokes a location notification procedure by sending a REGISTER message containing a LCS-LocationNotification invoke component to the UE. This may be sent either to request verification for MT-LR or to notify about already authorized MT-LR. + +In case of privacy verification the UE shall respond to the request by sending a RELEASE COMPLETE message containing the mobile subscriber's response in a return result component (see figure 5.2.1.1.1-1). + +If the timer T(LCSN) expires in the network before any response from the UE (e.g. due to no response from the user), the network shall interpret this by applying the default treatment defined in TS 3GPP 23.271 [2] (i.e. disallow location if barred by subscription and allow location if allowed by subscription). + +In the case of location notification no response is required from the UE, the UE shall terminate the dialogue by sending a RELEASE COMPLETE message containing a LocationNotification return result. + +If the UE is unable to process the request received from the network, it shall return an error indication by sending a RELEASE COMPLETE message containing a return error component. Error values are specified in 3GPP TS 24.080 [5]. + +![Sequence diagram showing UE to Network communication for Location Notification. The diagram includes messages: REGISTER, Facility (Invoke = LCS-LocationNotification), RELEASE COMPLETE, Facility (Return result = LCS-LocationNotification), RELEASE COMPLETE, Facility (Return error (Error)), RELEASE COMPLETE, Facility (Reject (Invoke_problem)), and RELEASE COMPLETE.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant UE + participant Network + Note over UE, Network: REGISTER + UE->>Network: Facility (Invoke = LCS-LocationNotification (notificationType, locationType, lcsClientExternalID, lcsClientName, lcsRequestorID, lcsCodeword, lcsServiceTypeId)) + Note over UE, Network: RELEASE COMPLETE + Network-->>UE: Facility (Return result = LCS-LocationNotification (verificationResponse)) + Note over UE, Network: RELEASE COMPLETE + Network-->>UE: Facility (Return error (Error)) + Note over UE, Network: RELEASE COMPLETE + Network-->>UE: Facility (Reject (Invoke_problem)) + Note over UE, Network: RELEASE COMPLETE + +``` + +Sequence diagram showing UE to Network communication for Location Notification. The diagram includes messages: REGISTER, Facility (Invoke = LCS-LocationNotification), RELEASE COMPLETE, Facility (Return result = LCS-LocationNotification), RELEASE COMPLETE, Facility (Return error (Error)), RELEASE COMPLETE, Facility (Reject (Invoke\_problem)), and RELEASE COMPLETE. + +Figure 5.2.1.1.1-1: Location Notification + +#### 5.2.1.2 Network initiated Positioning Information Transport + +The MME sends LPP message and the associated Routing Identifier in the Downlink Generic NAS Transport message (Refer to 3GPP TS 24.301 [3]). Figure 5.2.1.2-1: illustrates an example of the NAS signaling transport for downlink LPP messages. + +![Sequence diagram showing NAS signaling transport for downlink LPP messages between UE, MME, and E-SMLC.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` +sequenceDiagram + participant UE + participant MME + participant E-SMLC + Note left of MME: NAS signaling for EPC-MO-LR, EPC-MT-LR, or EPC-NI-LR session initiation might have occurred. + Note right of MME: MME decides to request positioning support from E-SMLC. The MME allocates a Correlation Identifier and includes it in the LCS-AP Location Request message sent to the E-SMLC. + Note right of E-SMLC: The E-SMLC decides to exchange information with the UE using LPP messages encapsulated in the LCS-AP Connection Oriented Information Transfer message. The E-SMLC includes the Correlation Identifier received in the LCS-AP Location Request message in the LCS-AP Connection Oriented Information Transfer message. + Note left of UE: The MME sets the Generic Message Container Type to "LPP message container" and forwards the LPP message in the Generic Message Container in the Downlink Generic NAS Transport message. The MME includes a Routing Identifier in the Additional Information IE of the Downlink Generic NAS Transport message associated with the positioning session between the MME and E-SMLC (e.g. the Correlation Identifier).. + MME->>UE: Downlink Generic NAS Transport (LPPMsgContainer, LPPmsg, RoutingIdentifier) +``` + +The diagram illustrates the sequence of messages for downlink LPP transport. It starts with a note indicating potential NAS signaling initiation. The MME then sends a request to the E-SMLC with a Correlation Identifier. The E-SMLC responds with LPP messages in an LCS-AP Connection Oriented Information Transfer message, including the Correlation Identifier. The MME then encapsulates these in a Downlink Generic NAS Transport message with a specific container type and a Routing Identifier before sending it to the UE. + +Sequence diagram showing NAS signaling transport for downlink LPP messages between UE, MME, and E-SMLC. + +Figure 5.2.1.2-1: NAS signaling transport for downlink LPP messages + +### 5.2.2 Mobile initiated location services operations + +#### 5.2.2.1 Mobile Originated Location Request (MO-LR) + +##### 5.2.2.1.0 General + +The MO-LR operation enables the UE to launch MO positioning session using NAS signaling. The NAS signaling (see 5.2.2.1.1 and 5.2.2.1.2) are transported using the Downlink Generic NAS Transport message and the Uplink Generic NAS Transport message defined in 3GPP TS 24.301 [3]. Figure 5.2.2.1.0-1 illustrates an example of the NAS signaling transport for an EPC-MO-LR session. + +![Sequence diagram showing NAS signaling transport for MO-LR between UE and MME. The UE sends an Uplink Generic NAS Transport message (LCSMsgContainer, REGISTER(Facility(LCS-MOLR Invoke))) to the MME. The MME then initiates a positioning session with the E-SMLC. Upon receipt of the response, the MME sends a Downlink Generic NAS Transport message (LCSMsgContainer, REGISTER(Facility(LCS-MOLR Return Result))) back to the UE.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MME + Note left of UE: When an EPC-MO-LR location session is initiated at UE, the UE sets the Generic Message Container Type to "Location services message container" and includes a LCS MO-LR Invoke in the Generic Message Container in the Uplink Generic NAS Transport message. + UE->>MME: Uplink Generic NAS Transport (LCSMsgContainer, REGISTER(Facility(LCS-MOLR Invoke))) + Note right of MME: If MME decides to request positioning from E-SMLC, the MME initiates a positioning session with the E-SMLC using LCS-AP messaging. + Note right of MME: Upon receipt of the positioning response from the E-SMLC, the MME sets the Generic Message Container Type to "Location services message container", and includes LCS-MOLR Return Result in the Generic Message Container in the Downlink Generic NAS Transport message. + MME->>UE: Downlink Generic NAS Transport (LCSMsgContainer, REGISTER(Facility(LCS-MOLR Return Result))) + +``` + +Sequence diagram showing NAS signaling transport for MO-LR between UE and MME. The UE sends an Uplink Generic NAS Transport message (LCSMsgContainer, REGISTER(Facility(LCS-MOLR Invoke))) to the MME. The MME then initiates a positioning session with the E-SMLC. Upon receipt of the response, the MME sends a Downlink Generic NAS Transport message (LCSMsgContainer, REGISTER(Facility(LCS-MOLR Return Result))) back to the UE. + +**Figure 5.2.2.1.0-1: NAS signaling transport for MO-LR** + +NOTE: The optional Additional Information of the Downlink/Uplink Generic NAS Transport message is not used when the MO-LR signaling are transported in the Generic Message Container. + +##### 5.2.2.1.1 Normal operation + +The UE invokes a MO-LR by sending a REGISTER message to the network containing a LCS-MOLR invoke component. SS Version Indicator value 1 or above shall be used. + +The receiving network entity shall initiate the handling of location request in the network. The network shall pass the result of the location procedure to the UE by sending a FACILITY message to the UE containing a LCS-MOLR return result component. When location estimate is kept in the network entity and this information satisfies the requested accuracy and the requested maximum age of location, then the network may reuse this information and the positioning measurement procedure may be skipped. + +The network shall pass the result of the location procedure to the UE only if the location estimate is given in a format that the UE supports, as indicated by either the presence (and content) or the absence of the parameter supportedGADShapes, which may be sent by the UE in the LCS-MOLR operation. + +The UE may terminate the dialogue by sending a RELEASE COMPLETE message in the case of single location request (see figure 5.2.2.1.1-1). The UE may also initiate another location request operation by sending a FACILITY message to the network containing a LCS-MOLR invoke component (see figure 5.2.2.1.1-2). After the last location request operation the UE shall terminate the dialogue by sending a RELEASE COMPLETE message. + +If the network is unable to successfully fulfil the request received from the UE (e.g. to provide a location estimate or location assistance information), it shall clear the transaction by sending a RELEASE COMPLETE message containing a return error component. Error values are specified in 3GPP TS 24.080 [5]. If the network is unable to provide a location estimate due to lack of support in the UE for the type of shape of the location estimate, then it shall use the error Facility Not Supported. + +If the network has returned a result to the UE in a FACILITY message but, after some PLMN administered time period has elapsed, has not received either a new location request operation in a FACILITY message or a RELEASE + +COMPLETE message from the UE, the network may clear the transaction by sending a RELEASE COMPLETE message. + +During the MO-LR operation the UE shall run a timer T(LCSL). This timer is started when the operation is sent, and stopped when a response is received from the network. If this timer expires the UE shall assume that the operation has failed, and may terminate the dialogue by sending a RELEASE COMPLETE message, and shall inform the user of the failure. + +![Sequence diagram showing a single mobile originated location request between a UE and a Network. The sequence includes REGISTER, FACILITY (Invoke = LCS-MOLR), FACILITY (Return result = LCS-MOLR), RELEASE COMPLETE, FACILITY (Return error (Error)), RELEASE COMPLETE, FACILITY (Reject (Invoke_problem)), and RELEASE COMPLETE messages.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` +sequenceDiagram + participant UE + participant Network + Note over UE, Network: REGISTER + UE->>Network: Facility (Invoke = LCS-MOLR (molr-Type, lcs-QoS, lcsClientExternalID, mlc-Number, supportedGADShapes, lcsServiceTypeID, ageOfLocationInfo, locationType, pseudonymIndicator, multiplePositioningProtocolPDUs)) + Note over UE, Network: FACILITY + Network-->>UE: Facility (Return result = LCS-MOLR (velocityEstimate, add-LocationEstimate)) + Note over UE, Network: RELEASE COMPLETE + Network-->>UE: Facility (Return error (Error)) + Note over UE, Network: RELEASE COMPLETE + Network-->>UE: Facility (Reject (Invoke_problem)) + Note over UE, Network: RELEASE COMPLETE + Network-->>UE: +``` + +Sequence diagram showing a single mobile originated location request between a UE and a Network. The sequence includes REGISTER, FACILITY (Invoke = LCS-MOLR), FACILITY (Return result = LCS-MOLR), RELEASE COMPLETE, FACILITY (Return error (Error)), RELEASE COMPLETE, FACILITY (Reject (Invoke\_problem)), and RELEASE COMPLETE messages. + +Figure 5.2.2.1.1-1: Single mobile originated location request + +UE + +Network + +![Sequence diagram showing multiple mobile originated location requests between UE and Network. The diagram includes messages for REGISTER, FACILITY (Invoke = LCS-MOLR), FACILITY (Return result), RELEASE COMPLETE, and Facility (Return error/Reject).](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +sequenceDiagram + participant UE + participant Network + Note right of Network: REGISTER + UE->>Network: Facility (Invoke = LCS-MOLR (molr-Type, lcs-QoS, lcsClientExternalID, mlc-Number, supportedGADShapes, lcsServiceTypeID, ageOfLocationInfo, locationType, pseudonymIndicator, multiplePositioningProtocolPDUs)) + Note right of Network: FACILITY + Network-->>UE: (Return result = LCS-MOLR (velocityEstimate, add-LocationEstimate)) + Note right of Network: RELEASE COMPLETE + Network-->>UE: Facility (Return error (Error)) + Note right of Network: RELEASE COMPLETE + Network-->>UE: Facility (Reject (Invoke_problem)) + Note right of Network: FACILITY + UE->>Network: Facility (Invoke = LCS-MOLR (molr-Type, lcs-QoS, lcsClientExternalID, mlc-Number, supportedGADShapes, lcsServiceTypeID, ageOfLocationInfo, locationType, pseudonymIndicator, multiplePositioningProtocolPDUs)) + Note right of Network: FACILITY + Network-->>UE: (Return result = LCS-MOLR (velocityEstimate, add-LocationEstimate)) + Note right of Network: RELEASE COMPLETE + Network-->>UE: Facility (Return error (Error)) + Note right of Network: RELEASE COMPLETE + Network-->>UE: Facility (Reject (Invoke_problem)) + Note right of Network: RELEASE COMPLETE + Network-->>UE: + +``` + +Sequence diagram showing multiple mobile originated location requests between UE and Network. The diagram includes messages for REGISTER, FACILITY (Invoke = LCS-MOLR), FACILITY (Return result), RELEASE COMPLETE, and Facility (Return error/Reject). + +**Figure 5.2.2.1.1-2: Multiple mobile originated location requests** + +NOTE: Only the following IEs defined in MO-LR Invoke in 3GPP TS 24.080 [5] are used for E-UTRAN LCS: + +- molr-Type +- lcs-QoS +- lcsServiceTypeID +- ageOfLocationInformation +- locationType +- mlc-Number +- lcsClientExternalID +- pseudonymIndicator +- supportedGADShapes + +- multiplePositioningProtocolPDUs + +NOTE: multiplePositioningProtocolPDUs IE is added to the LCS-MOLR Invoke to allow for passing multiple UE positioning information LPP messages (e.g. UE location measurements or UE capabilities) to the E-SMLC for E-UTRAN LCS. Its ASN.1 description is given in 3GPP TS 24.080 [5]. + +#### 5.2.2.2 Mobile initiated Positioning Information Transport + +The UE sends LPP message and the associated Routing Identifier in the Uplink Generic NAS Transport message (Refer to 3GPP TS 24.301 [3]). Figure 5.2.2.2-1 illustrates an example of the NAS signaling transport for uplink LPP messages. + +![Sequence diagram illustrating NAS signaling transport for uplink LPP messages between UE, MME, and E-SMLC.](bffdddb47fced140f8d17fdc2a29f592_img.jpg) + +``` +sequenceDiagram + participant UE + participant MME + participant E-SMLC + + Note left of UE: NAS signaling for EPC-MO-LR, EPC-MT-LR, or EPC-NI-LR session initiation may have occurred. + Note right of E-SMLC: UE received LPP messages encapsulated in the Downlink Generic NAS Transport message. + Note left of UE: UE decides to respond to the Downlink Generic NAS Transport message that carries the LPP messages from the E-SMLC. The UE sets the Generic Message Container Type to "LPP message container" and includes the LPP messages in the Generic Message Container in the Uplink Generic NAS Transport message. The UE includes the Routing Identifier (received in the Additional Information IE of the Downlink Generic NAS Transport message) in the Additional Information IE of the Uplink Generic NAS Transport message. + UE->>MME: Uplink Generic NAS Transport (LPPMsgContainer, LPPmsg, RoutingIdentifier) + Note right of MME: The MME determines the E-SMLC and the appropriate positioning session from the Routing Identifier received in the Additional Information IE of the Uplink Generic NAS Transport message, and forwards the LPP messages in the LCS-AP Connection Oriented Information Transfer message to the E-SMLC. The MME includes the Correlation Identifier associated with the session in the LCS-AP Connection Oriented Information Transfer message. +``` + +The diagram illustrates the sequence of messages for mobile initiated positioning information transport. It involves three main entities: UE (User Equipment), MME (Mobility Management Entity), and E-SMLC (Evolved SMLC). The process starts with a note indicating that NAS signaling for EPC-MO-LR, EPC-MT-LR, or EPC-NI-LR session initiation may have occurred. The UE receives LPP messages encapsulated in the Downlink Generic NAS Transport message from the E-SMLC. The UE then decides to respond, setting the Generic Message Container Type to "LPP message container" and including the LPP messages in the Generic Message Container in the Uplink Generic NAS Transport message. The UE also includes the Routing Identifier (received in the Additional Information IE of the Downlink Generic NAS Transport message) in the Additional Information IE of the Uplink Generic NAS Transport message. The UE sends the Uplink Generic NAS Transport message (containing LPPMsgContainer, LPPmsg, and RoutingIdentifier) to the MME. The MME determines the E-SMLC and the appropriate positioning session from the Routing Identifier received in the Additional Information IE of the Uplink Generic NAS Transport message, and forwards the LPP messages in the LCS-AP Connection Oriented Information Transfer message to the E-SMLC. The MME also includes the Correlation Identifier associated with the session in the LCS-AP Connection Oriented Information Transfer message. + +Sequence diagram illustrating NAS signaling transport for uplink LPP messages between UE, MME, and E-SMLC. + +Figure 5.2.2.2-1: NAS signaling transport for uplink LPP messages + +## 5.3 LCS messages and coding + +### 5.3.1 Messages for common LCS operations + +The LCS message format and information elements coding for the MO-LR and the Location Notification operations (subclause 5.2) are defined in 24.080 [5] for the following messages: + +- Register message +- Facility message +- Release Complete message + +### 5.3.2 Messages for E-UTRAN LCS operations only + +#### 5.3.2.1 LPP Messages + +##### 5.3.2.1.1 Downlink Positioning Information Transport using LPP messages + +The MME shall set the Generic Message Container Type to "LPP message container" in the Downlink Generic NAS Transport message. + +The MME includes a Routing Identifier in the Additional Information IE of the Downlink Generic NAS Transport message associated with the positioning session between the MME and E-SMLC. + +The Routing identifier is the Correlation ID, which is defined in 3GPP TS 29.171 [7], so that the MME can map the Routing identifier to the Correlation identifier when the MME receives an S1-AP Transport Message. + +##### 5.3.2.1.2 Uplink Positioning Information Transport using LPP messages + +The UE shall set the Generic Message Container Type to "LPP message container" in the Uplink Generic NAS Transport message. + +The UE includes a Routing Identifier received in the Additional Information IE of the Downlink Generic NAS Transport message in the the Additional Information IE of the Uplink Generic NAS Transport message. (See editor's note below on Routing Identifier). This association of the Routing Identifier is provided at the LPP level: the UpLink Generic NAS Transport message carries an LPP message that is a response to or instigated by the LPP message in the Downlink Generic NAS Transport message. The Routing identifier is the Correlation ID, which is defined in 3GPP TS 29.171 [7], so that the MME can map the Routing identifier to the Correlation identifier when the MME receives an S1-AP Transport Message. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|----|-----|-----------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2010-03 | CP#47 | CP-100053 | | | 3GPP TS presented for approval in CT#47 | 2.0.0 | 9.0.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | 11.0.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | 12.0.0 | +| 2015-12 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | 13.0.0 | +| 2017-03 | - | - | - | - | Update to Rel-14 version (MCC) | 13.0.0 | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24182/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg b/marked/Rel-16/24_series/24182/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..669e38abb137cf75d6c357aff93abf46354ddf1a --- /dev/null +++ b/marked/Rel-16/24_series/24182/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c0c336526f64e6d1aa14836f0cbf818033927447aa0d5fbae04c3147c4247af +size 105238 diff --git a/marked/Rel-16/24_series/24182/1f1614411edea7edfc86c839a608e1fc_img.jpg b/marked/Rel-16/24_series/24182/1f1614411edea7edfc86c839a608e1fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..488d33c12155626f19e0cc1fdbc66f1cb2d93604 --- /dev/null +++ b/marked/Rel-16/24_series/24182/1f1614411edea7edfc86c839a608e1fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51c8567dbec61db40746f3ed3894993979bd0bf120fb1e40f622a409d94701fe +size 108309 diff --git a/marked/Rel-16/24_series/24182/223792b3652794024244c277cc46394b_img.jpg b/marked/Rel-16/24_series/24182/223792b3652794024244c277cc46394b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7eccf1ebc2740f684c817f764bd23ad628d07a2 --- /dev/null +++ b/marked/Rel-16/24_series/24182/223792b3652794024244c277cc46394b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55be61b5c9fc9bb295797ee90c4ab7b7d3ef8f12b666ba86bfb0e1445e2d3de7 +size 73562 diff --git a/marked/Rel-16/24_series/24182/2a476a0b3dbc3429436246db4784ff9f_img.jpg b/marked/Rel-16/24_series/24182/2a476a0b3dbc3429436246db4784ff9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a95d54b4e4839fe3f341203c6c6e2fb8a303592f --- /dev/null +++ b/marked/Rel-16/24_series/24182/2a476a0b3dbc3429436246db4784ff9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d154f631c51a8f0b2b88b05e5794599999bafaa51d69594d533083d89608402a +size 133949 diff --git a/marked/Rel-16/24_series/24182/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/24_series/24182/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..009756714183102d5a23a76b0cbf5c767dc5d312 --- /dev/null +++ b/marked/Rel-16/24_series/24182/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:582c68eb0de274d9277acc45bcbceae9944bb4865eebe895a92ce4bdcfeaa612 +size 84586 diff --git a/marked/Rel-16/24_series/24182/331afcb1534110b4c4f6ddf553a0f7e0_img.jpg b/marked/Rel-16/24_series/24182/331afcb1534110b4c4f6ddf553a0f7e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..98194871906a5dc8760dc7dea7fa3939b549c534 --- /dev/null +++ b/marked/Rel-16/24_series/24182/331afcb1534110b4c4f6ddf553a0f7e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d45822745db50912a953faf25488c793652783cdcc7bcc967ed659d2ecb0c80 +size 132378 diff --git a/marked/Rel-16/24_series/24182/3337af75dfee8af7687b4f49914d6c93_img.jpg b/marked/Rel-16/24_series/24182/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b18fe67874444551b5414a314d5a4c0cc4ceb1b3 --- /dev/null +++ b/marked/Rel-16/24_series/24182/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23b8e97c18bd0ed8947c5b207cb026b4e6dfa44daa686b213d607b816b1aa945 +size 106256 diff --git a/marked/Rel-16/24_series/24182/4806f9f95fff13a30d6523bd6ffeac63_img.jpg b/marked/Rel-16/24_series/24182/4806f9f95fff13a30d6523bd6ffeac63_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7e302eb1ac91dc548e2f84cb186c02c5e1db77c0 --- /dev/null +++ b/marked/Rel-16/24_series/24182/4806f9f95fff13a30d6523bd6ffeac63_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30c3638af081a2ebb199c57ef1472e522aeea7f09d5ed7d0fbad9be241143409 +size 136336 diff --git a/marked/Rel-16/24_series/24182/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg b/marked/Rel-16/24_series/24182/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..441625384e65bb79544876522aa429e378e8429a --- /dev/null +++ b/marked/Rel-16/24_series/24182/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8b6460ef5cd9c43576b56b51c57a9c363fb3eaa7485387024a295b5b066295d +size 107833 diff --git a/marked/Rel-16/24_series/24182/72d448a65347c51989171748789c7d4b_img.jpg b/marked/Rel-16/24_series/24182/72d448a65347c51989171748789c7d4b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44a5c00bc166c70aea53d40374704634bedb811a --- /dev/null +++ b/marked/Rel-16/24_series/24182/72d448a65347c51989171748789c7d4b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b2fcef55b65ee533cd98c5af13ebf0b71aa0ccd7728fe318b4c745c6c4f75c66 +size 100905 diff --git a/marked/Rel-16/24_series/24182/8269648391c59363ea61243864a2adf7_img.jpg b/marked/Rel-16/24_series/24182/8269648391c59363ea61243864a2adf7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc260a595a0f6c872f04329b4396e9e097db5f73 --- /dev/null +++ b/marked/Rel-16/24_series/24182/8269648391c59363ea61243864a2adf7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:46792d379c3538efb5d84f9ba3aba55557d4e44edd1c6eb489a899f7da7c1013 +size 84596 diff --git a/marked/Rel-16/24_series/24182/9ba75f891de20483c291538e38701d96_img.jpg b/marked/Rel-16/24_series/24182/9ba75f891de20483c291538e38701d96_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..97e6036af7482c358f8eb59e4b46fb32028992bc --- /dev/null +++ b/marked/Rel-16/24_series/24182/9ba75f891de20483c291538e38701d96_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26bfdfc876b89565d8c39503dcfac5d6c171ab7ad898e00095bd4ae8d57b2263 +size 44409 diff --git a/marked/Rel-16/24_series/24182/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg b/marked/Rel-16/24_series/24182/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20760e79cd62bf8f7321c8878ad9ed91f25a9286 --- /dev/null +++ b/marked/Rel-16/24_series/24182/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e8180fe54873da8b00793cee1829d4d0d9fe225c02cfeaf6aa73f1f927bc5bb +size 126613 diff --git a/marked/Rel-16/24_series/24182/a963ca41bde1669b18a4b783616f228b_img.jpg b/marked/Rel-16/24_series/24182/a963ca41bde1669b18a4b783616f228b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8964670e76ccef514144bf2c4fbffdd17e302947 --- /dev/null +++ b/marked/Rel-16/24_series/24182/a963ca41bde1669b18a4b783616f228b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3aa32228b2c46e60fa41e9c25397baba676490d1f04e81fe59d49bbec872157f +size 139338 diff --git a/marked/Rel-16/24_series/24182/cc7baa8e5118f4b42c01166637c738ea_img.jpg b/marked/Rel-16/24_series/24182/cc7baa8e5118f4b42c01166637c738ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ebc8e41c210b38fcdd68423881692f5b6b0254f --- /dev/null +++ b/marked/Rel-16/24_series/24182/cc7baa8e5118f4b42c01166637c738ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b4200c02aa4f8ec4156faed0f48d373377f67a9999deace456b4bad429b243bf +size 143215 diff --git a/marked/Rel-16/24_series/24182/ceb6fe29e2d57711907569c31182b3c2_img.jpg b/marked/Rel-16/24_series/24182/ceb6fe29e2d57711907569c31182b3c2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..89b7831e3e342d215fa6f0261cd9d7d93f087769 --- /dev/null +++ b/marked/Rel-16/24_series/24182/ceb6fe29e2d57711907569c31182b3c2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c8374bdcfd9a6c3e3e261bf81bae1e87119626fbd311043d105ee9c63f37018 +size 75207 diff --git a/marked/Rel-16/24_series/24182/d04c50badc78d5ba47bf4e352af4a754_img.jpg b/marked/Rel-16/24_series/24182/d04c50badc78d5ba47bf4e352af4a754_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..02a24105ab864efabb4defc2000c00c19582817b --- /dev/null +++ b/marked/Rel-16/24_series/24182/d04c50badc78d5ba47bf4e352af4a754_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9b9536b0867c96c1940a6fac7be009eec8150b32e62a95ab91a9b098b48953f +size 147690 diff --git a/marked/Rel-16/24_series/24182/db7a693cf26f527ac6c0d4d41da20858_img.jpg b/marked/Rel-16/24_series/24182/db7a693cf26f527ac6c0d4d41da20858_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..27ad2cb909386466b2e0249d5308c79dd5149e03 --- /dev/null +++ b/marked/Rel-16/24_series/24182/db7a693cf26f527ac6c0d4d41da20858_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:70976a7a3c467414a816214f50d1c99a136285223a64147ae46e04e020d9905c +size 107156 diff --git a/marked/Rel-16/24_series/24182/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/24_series/24182/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e3c3519bf64701f6cddd59a826730350d0edfb5a --- /dev/null +++ b/marked/Rel-16/24_series/24182/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e97c4c40b14f561dd9c9e49ea0f767652d7a2e167e8429227635e35a0a64ff90 +size 116507 diff --git a/marked/Rel-16/24_series/24182/e18841eb4a995df8354a793459e12fd0_img.jpg b/marked/Rel-16/24_series/24182/e18841eb4a995df8354a793459e12fd0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db43d3d80f28ee11864bde85c2b188c0f333b5b6 --- /dev/null +++ b/marked/Rel-16/24_series/24182/e18841eb4a995df8354a793459e12fd0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81b48a203cad6cd8de731c2dbd4316fe40f4238facf45ebf5ce27b899eca7331 +size 129567 diff --git a/marked/Rel-16/24_series/24182/raw.md b/marked/Rel-16/24_series/24182/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1dd504cfc65098405898d74d156d0c4005bb1bb0 --- /dev/null +++ b/marked/Rel-16/24_series/24182/raw.md @@ -0,0 +1,9049 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations..... | 7 | +| 4 Customized Alerting Tones (CAT)..... | 7 | +| 4.1 Introduction..... | 7 | +| 4.2 Description..... | 7 | +| 4.2.1 General description..... | 7 | +| 4.3 Operational requirements..... | 8 | +| 4.3.1 Provision/withdrawal..... | 8 | +| 4.3.1.1 CAT provision/withdrawal..... | 8 | +| 4.3.1.2 Requirements on the originating network side..... | 8 | +| 4.3.1.3 Requirements on the terminating network side..... | 8 | +| 4.4 Syntax requirements..... | 8 | +| 4.5 Signalling procedures..... | 8 | +| 4.5.1 General..... | 8 | +| 4.5.2 Activation/deactivation..... | 8 | +| 4.5.3 Registration/erasure..... | 9 | +| 4.5.4 Interrogation..... | 9 | +| 4.5.5 Invocation and operation..... | 9 | +| 4.5.5.1 Actions at the originating UE..... | 9 | +| 4.5.5.1.1 General..... | 9 | +| 4.5.5.1.2 UE Actions for CAT copy..... | 9 | +| 4.5.5.1.3 UE Actions for CAT stop..... | 9 | +| 4.5.5.1.4 UE support of DTMF..... | 9 | +| 4.5.5.2 Actions at the AS serving the originating UE..... | 10 | +| 4.5.5.2.1 General..... | 10 | +| 4.5.5.2.2 AS Actions for forking model..... | 10 | +| 4.5.5.2.3 AS Actions for early session model..... | 12 | +| 4.5.5.2.3A AS Actions for CAT Reject..... | 13 | +| 4.5.5.2.4 AS Actions for CAT stop..... | 13 | +| 4.5.5.2.5 AS support of DTMF..... | 14 | +| 4.5.5.2.6 AS Actions for Gateway model..... | 14 | +| 4.5.5.3 Actions at the AS serving the terminating UE..... | 17 | +| 4.5.5.3.1 General..... | 17 | +| 4.5.5.3.2 AS actions for forking model..... | 17 | +| 4.5.5.3.3 AS Actions for early session model..... | 19 | +| 4.5.5.3.4 AS Actions for CAT copy..... | 20 | +| 4.5.5.3.5 AS Actions for CAT stop..... | 20 | +| 4.5.5.3.6 AS support of DTMF..... | 20 | +| 4.5.5.3.7 AS Actions for Gateway model..... | 20 | +| 4.6 Interaction with other services..... | 23 | +| 4.6.1 Communication session Hold (HOLD)..... | 23 | +| 4.6.2 Termination Identification Presentation (TIP)..... | 23 | +| 4.6.3 Termination Identification Restriction (TIR)..... | 23 | +| 4.6.4 Originating Identification Presentation (OIP)..... | 24 | +| 4.6.5 Originating Identification Restriction (OIR)..... | 24 | +| 4.6.6 Conference (CONF)..... | 24 | +| 4.6.7 Communication DIVersion services (CDIV)..... | 24 | +| 4.6.7.1 General..... | 24 | +| 4.6.7.2 CFNR..... | 25 | +| 4.6.8 Message Waiting Indication (MWI)..... | 25 | +| 4.6.9 Communication Barring (CB)..... | 25 | +| 4.6.10 Explicit Call Transfer (ECT)..... | 25 | + +| | | | +|--------|------------------------------------------------------|----| +| 4.6.11 | Communication Wait..... | 25 | +| 4.6.12 | Completion of Communications to Busy Subscriber..... | 26 | +| 4.6.13 | Customized Ringing Signal (CRS)..... | 26 | +| 4.6.14 | Multi-Device (MuD)..... | 26 | +| 4.6.15 | Multi-Identity (MiD)..... | 26 | +| 4.7 | Parameter values (timers)..... | 26 | +| 4.8 | Service configuration..... | 26 | + +# **Annex A (informative): Signalling flows.....27** + +| | | | +|---------|-----------------------------------------------------------------------------------------------------------------------------|-----| +| A.1 | Scope of signalling flows..... | 27 | +| A.2 | Void..... | 27 | +| A.3 | CAT forking model signalling flows..... | 27 | +| A.3.1 | Introduction..... | 27 | +| A.3.2 | CAT when UE#1 and UE#2 have resources available..... | 27 | +| A.3.3 | CAT when UE#1 does not have required resources available while UE#2 has resources available..... | 32 | +| A.3.4 | CAT when UE#1 has resources available while UE#2 does not have required resources available..... | 38 | +| A.4 | CAT early session model signalling flows..... | 43 | +| A.4.1 | Introduction..... | 43 | +| A.4.2 | CAT when UE#1 and UE#2 have resources available..... | 43 | +| A.4.3 | CAT when UE#1 does not have required resources available while UE#2 has resources available..... | 48 | +| A.4.4 | CAT when UE#1 has resources available while UE#2 does not have required resources available..... | 58 | +| A.5 | CAT Gateway model signalling flows..... | 64 | +| A.5.1 | Introduction..... | 64 | +| A.5.2 | CAT when UE#1 and UE#2 have resources available..... | 65 | +| A.5.2A | CAT using reINVITE request when UE#1 and UE#2 have resources available..... | 71 | +| A.5.3 | CAT when UE#1 does not have required resources available while UE#2 has resources available..... | 76 | +| A.5.3A | CAT using reINVITE request when UE#1 does not have required resources available while UE#2 has resources available..... | 85 | +| A.5.4 | CAT when UE#1 has resources available while UE#2 does not have required resources available..... | 95 | +| A.5.4A | CAT using reINVITE request when UE#1 has resources available while UE#2 does not have required resources available..... | 100 | +| A.5.5 | CAT diverting for CFNR using reINVITE request when UE#1, UE#2 and UE#3 have resources available..... | 106 | +| A.5.6 | CAT diverting for CFU..... | 117 | +| A.5.6.1 | General..... | 117 | +| A.5.6.2 | Gateway model CAT diverting for CFU when UE#1, UE#2 and UE#3 have resources available..... | 118 | +| A.5.7 | CAT when both UE#1 and UE#2 do not have required resources available..... | 125 | +| A.5.8 | CAT with different media types during one SIP session when both UE#1 and UE#2 do not have required resources available..... | 134 | +| A.6 | Interworking with CS domain..... | 143 | +| A.6.1 | Introduction..... | 143 | +| A.6.2 | CAT provided by the terminating CS domain..... | 143 | +| A.6.3 | CAT provided to the originating CS domain with the CAT forking model..... | 146 | +| A.6.4 | CAT provided to the originating CS domain with the CAT early session model..... | 150 | + +# **Annex B (normative): SDP a=content attribute "g.3gpp.cat" value.....156** + +| | | | +|-----|-------------------|-----| +| B.1 | Introduction..... | 156 | +| B.2 | New value..... | 156 | + +# **Annex C (informative): Change history.....157** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the protocol details for the Customized Alerting Tones (CAT) service in the IP Multimedia (IM) Core Network (CN) subsystem based on the requirements from 3GPP TS 22.182 [2]. + +The CAT service is an operator specific service by which an operator enables the subscriber to customize the media which is played to the calling party during alerting of the called party. + +The present document is applicable to User Equipment (UE) and Application Servers (AS) which are intended to support the CAT service. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.182: "Customized Alerting Tones (CAT) Requirements; Stage 1". +- [3] 3GPP TS 24.238: "Session Initiation Protocol (SIP) based user configuration; Stage 3". +- [4] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [5] RFC 3262: "Reliability of Provisional Responses in the Session Initiation Protocol (SIP)". +- [6] 3GPP TS 24.623: "Extensible Markup Language (XML) Configuration Access Protocol (XCAP) over the Ut interface for Manipulating Supplementary Services". +- [7] RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [8] RFC 3960: "Early Media and Ringing Tone Generation in the Session Initiation Protocol (SIP)". +- [9] RFC 5009 (September 2007): "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [10] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [11] RFC 6086 (January 2011): "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [12] RFC 4796 (February 2007): "The Session Description Protocol (SDP) Content Attribute". +- [13] RFC 3311: "The Session Initiation Protocol (SIP) UPDATE Method". +- [14] 3GPP TS 24.628: "Common Basic Communication procedures; Protocol specification". +- [15] RFC 4566: "SDP: Session Description Protocol". +- [16] 3GPP TS 24.174: "Support of Multi-Device and Multi-Identity in IMS; Stage 3". +- [17] RFC 3312: "Integration of Resource Management and Session Initiation Protocol (SIP)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|-------|---------------------------| +| B2BUA | Back-to-Back User Agent | +| CAT | Customized Alerting Tones | +| DTMF | Dual Tone Multi Frequency | +| MRF | Media Resource Function | + +# --- 4 Customized Alerting Tones (CAT) + +## 4.1 Introduction + +The CAT service is an operator specific service by which an operator enables the subscriber to customize the media which is played to the calling party during alerting of the called party. The media can consist of favourable songs, multi-media clips or other customized alerting tones. CAT service should not negatively affect the conversation between calling and called parties. + +## 4.2 Description + +### 4.2.1 General description + +The service user is able to subscribe to the CAT service, activate (or de-activate) the service, and update the settings, e.g., to change by configuration the active CAT media. The media can consist of favourable songs, multimedia clips or other customized alerting tones. The CAT subscriber is able to refine the CAT media selection behaviour with configured rules, e.g. time, calling party's location, called party's location, the identity of the calling and called party. The CAT service is able to select the appropriate CAT media according to the rules. + +CAT is a terminating network service, but can also have an originating network functional component. That is, CAT media can be selected on behalf of the called subscriber for playback to the calling party, but the calling (IMS) subscriber can also subscribe to and activate the CAT service. In such a case, the CAT media selected by the calling party takes precedence for playback purposes over that selected by the called party. Whether or not the calling party's CAT media has precedence over the called party's selected CAT media is a matter of configuration in the calling party's (originating) network. + +The start of playback of the selected CAT media toward the calling party occurs some time following the initiation of a session, but prior to session answer. When the called party answers, playback of the CAT media either stops or continues to play during the conversation, depending on operator or user preferences. When the CAT media is playing, the calling party is able to stop (e.g. mute) it. + +## 4.3 Operational requirements + +### 4.3.1 Provision/withdrawal + +#### 4.3.1.1 CAT provision/withdrawal + +The CAT service may be provided after prior arrangement with the service provider. + +The CAT service may be withdrawn at the subscriber's request or for administrative reasons. + +#### 4.3.1.2 Requirements on the originating network side + +The originating network side may support the "early-session" extension as described in RFC 3959 [7]. + +NOTE 1: the CAT service implementing the early-session model needs the early-session extension to be supported by intermediate entities and the originating UE, else CAT media can not be provided to the caller. + +The CAT service implementing the forking model and gateway model add no additional requirements on the originating network side. + +For the early session model, if the CAT service is provided by the originating network, the CAT AS shall control an MRF as described in 3GPP TS 24.229 [4] that is acting on behalf of a calling subscriber who has activated CAT. + +NOTE 2: The interworking between different models for CAT service is out of scope of this specification. + +#### 4.3.1.3 Requirements on the terminating network side + +For the early session model, if the CAT service is provided by the terminating network, the CAT AS shall control an MRF as described in 3GPP TS 24.229 [4] that is acting on behalf of a called subscriber who has activated CAT. + +NOTE: The interworking between different models for CAT service is out of scope of this specification. + +## 4.4 Syntax requirements + +There are no special SIP syntax requirements for the CAT service. + +## 4.5 Signalling procedures + +### 4.5.1 General + +Configuration of supplementary services by the user should: + +- take place over the Ut interface using XCAP as enabling protocol as described in 3GPP TS 24.623 [6]; or +- use SIP based user configuration as described in 3GPP TS 24.238 [3]; + +NOTE: Other possibilities for user configuration, such as web-based provisioning or pre-provisioning by the operator are outside the scope of the present document, but are not precluded. + +The details of the Ut interface based user configuration of CAT service are not specified in this version of the document. + +### 4.5.2 Activation/deactivation + +The CAT service is activated at provisioning and deactivated at withdrawal. + +When a CAT service is activated a subscriber can specify which CAT a calling user should experience, or use the operator's default setting. + +After a subscriber has activated their CAT service a calling user experiences the CAT that was chosen by the subscriber. + +### 4.5.3 Registration/erasure + +The CAT service requires no registration. Erasure is not applicable. + +### 4.5.4 Interrogation + +For CAT, interrogation is not applicable. + +### 4.5.5 Invocation and operation + +#### 4.5.5.1 Actions at the originating UE + +##### 4.5.5.1.1 General + +The UE shall follow the procedures specified in 3GPP TS 24.229 [4] for session initiation and termination. + +If the originating UE supports the early session mechanism then the UE shall make use of the procedures as specified in RFC 3959 [7]. + +The originating UE shall follow the actions at the originating UE in 3GPP TS 24.628 [14] with addition that the UE may play CAT media if an early media session is already established between the UE and the CAT AS, independently of receiving 180 (Ringing) response. + +##### 4.5.5.1.2 UE Actions for CAT copy + +In order for the calling party to copy the media for the CAT service, the UE shall send a specific DTMF digit for CAT copy to the AS. + +NOTE: The definition of which DTMFs are used is outside the scope of this specification and is dependant on the implementation of operator. + +##### 4.5.5.1.3 UE Actions for CAT stop + +In order for the calling party to stop the media for the CAT service, the UE shall send a specific DTMF digit for CAT stop to the AS. + +In order for the calling party to restart the media for the CAT service, the UE shall send a specific DTMF digit for CAT restart to the AS. + +NOTE: The definition of which DTMFs are used is outside the scope of this specification and is dependant on the implementation of operator. + +##### 4.5.5.1.4 UE support of DTMF + +In addition to indicating support of the telephone-event media subtype in the SDP offer, as defined in 3GPP TS 24.229 [4], the UE shall indicate support the SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [4], by including a Recv-Info header field with a "infoDtmf" value, as defined in IETF RFC 6086 [11]. + +NOTE: For telephone-event based DTMF transport, the DTMF digits are sent to the AS via an MRF. + +The AS will indicate to the UE which DTMF transport mechanism to use for CAT control. + +#### 4.5.5.2 Actions at the AS serving the originating UE + +##### 4.5.5.2.1 General + +The procedures specified in 3GPP TS 24.229 [4] for an AS acting as a routing B2BUA apply with additions described in the subclauses below. + +If the initial INVITE originated from the served user includes a Supported header field with "early-session" option-tag and the AS supports the "early-session" extension as described in RFC 3959 [7], the AS shall based on operator policy follow the procedures in subclause 4.5.5.2.3 to provide CAT service. The procedures in subclause 4.5.5.2.3 shall not be used if there are intermediaries in the network that do not understand the procedures. + +The interactions between the AS and the MRF are described in 3GPP TS 24.229 [4]. + +##### 4.5.5.2.2 AS Actions for forking model + +The AS performing the forking model shall follow the procedure as specified in annex D in 3GPP TS 24.628 [14] with the additional procedures described in this subclause. + +If the terminating network provides early media (e.g. CAT service) towards the originating UE, the AS decides which CAT service should have priority based on the operator policy and the calling CAT service subscriber's preferences. + +The procedures in this subclause are applicable if the CAT service provided by the AS serving the originating UE has priority. If the CAT service provided by the AS serving the originating UE has no priority, the AS does not perform any CAT specific procedures. The AS can determine whether the terminating network provides early media if the AS receives a P-Early-Media header field with a "sendrecv" value or a "sendonly" value. + +Upon receiving an initial SIP INVITE request destined to the terminating UE, the AS shall: + +- a) based on local policy remove the P-Early-Media header field, if present; +- b) forward the initial SIP INVITE request to the terminating UE; +- c) contact the MRF to request CAT resources; and +- d) send a reliable SIP 183 (Session Progress) response to the originating UE. The AS shall include in the SIP 183 (Session Progress) provisional response: + - a P-Asserted-Identity header field containing the public user identity of the terminating UE unless privacy policy or restriction services prevent providing any public user identity of the terminating party; + - a To header field with a To tag locally generated by the AS; + - a P-Early-Media header field with a "sendrecv" value or a "sendonly" value; + - an SDP answer, based on information received from the MRF. The AS shall include an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value in the SDP answer; and + - if a Supported header field with an option tag "precondition" was received in the initial INVITE request and the AS decides to use the precondition mechanism, an indication in the SDP answer that the local preconditions are fulfilled. + +If preconditions are used, the AS shall not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled. The point when the AS instructs the MRF to start applicable media for the CAT service is based on local policy. If the AS can provide CAT media for media lines not included in the original SDP offer and the UE in the Contact header field included media feature tags indicating support for the additional media, the AS shall send an UPDATE request towards the UE in the dialog with a negotiated SDP. The AS shall include in this UPDATE request: + +- a) an SDP offer based on an offer from the MRF with any new media lines placed after the existing media-lines. The AS shall include an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value in all the media lines; +- b) a P-Early-Media header field with a "sendrecv" value or a "sendonly" value; and +- c) if preconditions are used, an indication in the SDP offer that local preconditions are fulfilled. + +NOTE 1: The AS can, based on local policy, wait to send the SIP 183 (Session Progress) response to the originating UE until the AS has received a SIP 180 (Ringing) provisional response from the terminating UE. + +NOTE 2: The AS can, based on local policy, wait to instruct the MRF to start CAT media until the AS has received a SIP 180 (Ringing) provisional response from the terminating UE. + +NOTE 3: The interaction between the AS and MRF is not specified for the CAT service but can use the Cr reference point as described in 3GPP TS 24.229 [4]. + +NOTE 4: If the AS acts as a Proxy and does not want to remain in the signalling path between the originating UE and the terminating UE, the AS does not need to add its own SIP-URI to the SIP Record-Route header field. If the AS acts as a B2BUA, the AS will always remain in the signalling path. + +NOTE 5: The AS can, if it supports the P-Early-Media header field, based on local policy choose to not provide the CAT service to the originating UE if the initial INVITE request does not contain a P-Early-Media header field with a "supported" value. + +Upon receiving a reliable provisional response from a terminating UE containing an SDP answer to the original SIP INVITE request, the AS: + +- a) may forward the provisional response to the originating UE reliably; + +- b) may, unless the provisional response contained a 199 response code, change the response code to SIP 183 (Session Progress) response; +- c) shall insert a P-Early-Media header field, or modify an existing header field, with an "inactive" value before forwarding the provisional response; +- d) shall, if the reliable provisional response is not forwarded to the originating UE, acknowledge the received provisional response by sending a SIP PRACK request as defined in RFC 3262 [5] to the terminating UE; and +- e) shall, if the reliable provisional response contained an SDP answer and the provisional response is not forwarded to the originating UE, save the SDP answer contained in the reliable provisional response for that particular early dialog. If forking has occurred toward the terminating UE, the AS may save SDP answers from several different UEs; + +If precondition procedures are used between the originating UE and the terminating UE, the AS shall forward reliable provisional responses which contain SDP to the originating UE, in order to allow the UEs to exchange additional SDP offers and answers associated with the precondition procedures. + +Upon receiving an unreliable provisional response from the terminating UE to the original SIP INVITE request, the AS may forward the provisional response to the originating UE reliably. Unless the provisional response contained a 199 response code, the AS may change the response code to SIP 183 (Session Progress) response. + +If the AS supports the P-Early-Media header field, the AS shall insert a P-Early-Media header field with an "inactive" value before forwarding the provisional response. + +Upon receiving a SIP 200 (OK) response to the initial SIP INVITE request from the terminating UE indicating that the terminating UE has answered the call, the AS shall: + +- a) instruct the MRF to stop the media for the CAT service; +- b) forward the SIP 200 (OK) response to the originating UE; and +- c) if the AS has saved the SDP answer associated with the dialog confirmed by the SIP 200 (OK) response and if the AS has not forwarded the SDP answer to the originating UE, the AS shall include the saved SDP answer in the SIP 200 (OK) response. + +Upon receiving a SIP 4xx, 5xx or 6xx response from a terminating UE the AS shall: + +- a) instruct the MRF to stop the media for the CAT service; and +- b) forward the final response to the originating UE. + +Upon receiving a SIP PRACK request including the P-Early-Media header field with an "inactive" value, the AS shall: + +- a) instruct the MRF to release the media resource reserved for the CAT service; and +- b) forward the SIP PRACK request to the terminating UE. + +##### 4.5.5.2.3 AS Actions for early session model + +The procedures in subclause 4.5.5.3.3 shall apply with following additions: + +- Upon receiving the first SIP 18x response containing an early-session SDP offer containing an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value to the initial INVITE request, the AS: + - decides which CAT service should have priority based on the operator policy and the calling CAT service subscriber's preferences; + +NOTE 1: Based on the operator policy, the AS can decide which CAT service should have priority when receiving the first SIP INVITE request or receiving the first SIP 18x response. + +- if the CAT service provided by the AS serving the originating UE has no priority, then forward the SIP 18x response and do not provide CAT service; +- if the CAT service provided by the AS serving the originating UE has priority, then: + +- send a reliable SIP 18x response to the originating UE. The SIP 18x response shall: + - include a P-Asserted-Identity header containing the public user identity of the served user unless privacy policy or restriction services prevent providing any public user identity of the terminating party; + - include a Require header with option tag "early-session"; + - include the SDP content, with an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value, for CAT service provided by the AS serving the originating UE instead of the CAT service provided by the AS serving the terminating UE as early-session SDP offer and if preconditions are used, and CAT resource has been requested, indicate the local preconditions are fulfilled; + - if a SIP PRACK request from originating UE containing an SDP answer related to an early session is received, the AS shall forward the SIP PRACK request with a new SDP answer related to the early-session and set all port numbers of the media types to "0". +- Upon receiving the first SIP 18x response including the P-Early-Media header and an SDP answer containing an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value, the AS: + - decides which CAT service should have priority based on the operator policy and the calling CAT service subscriber's preferences; + - if the CAT service provided by the AS serving the originating UE has no priority, then forward the SIP 18x response and do not provide CAT service; + - if the CAT service provided by the AS serving the originating UE has priority, then: + - send a reliable SIP 18x response to the originating UE. The SIP 18x response shall: + - include a P-Asserted-Identity header containing the public user identity of the served user unless privacy policy or restriction services prevent providing any public user identity of the terminating party; + - include a Require header with option tag "early-session"; + - include the SDP content, with an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value, for CAT as early-session SDP offer and if preconditions are used, and CAT resource has been requested, indicate the local preconditions are fulfilled; + - if a SIP PRACK request from originating UE containing an SDP answer related to an early session is received, the AS shall forward the SIP PRACK after removing the SDP answer related to the early session and including the P-Early-Media header field with an "inactive" value. + +###### 4.5.5.2.3.A AS Actions for CAT Reject + +This subclause describes the procedures when the CAT AS has decided to reject CAT offered by the AS serving the terminating UE. + +Upon receiving the first reliable SIP 18x response containing an early-session SDP offer, containing an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value, to the initial INVITE request, the AS shall decide whether CAT service provided by the AS serving the terminating UE needs to be rejected or not based on the operator policy and the calling CAT service subscribers preferences. + +NOTE 1: Based on the operator policy, the AS can decide whether to reject the terminating CAT service when receiving the first SIP INVITE request or receiving the first SIP 18x response. + +If the CAT service provided by the AS serving the terminating UE needs to be rejected, when the AS receives a reliable SIP 18x response, the AS shall: + +- include a P-Asserted-Identity header field containing the public user identity of the terminating user unless privacy policy or restriction services prevent providing any public user identity of the terminating party; +- if present, remove the early-session SDP offer from the response; + +- forward the SIP 18x response to the originating UE; and +- when a SIP PRACK request from originating UE is received, if the SIP 18x response contained an early-session SDP offer, the AS shall insert an early-session SDP answer with all media port numbers set to "0" before forwarding the SIP PRACK request. + +Upon receiving the first SIP 18x response including the P-Early-Media header field and an SDP answer containing an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value, the AS shall decide whether CAT service provided by the AS serving the terminating UE needs to be rejected or not based on the operator policy and the calling CAT service subscriber's preferences; + +NOTE 2: Based on the operator policy, the AS can decide whether to reject the terminating CAT service when receiving the first SIP INVITE request or receiving the first SIP 18x response. + +If the CAT service provided by the AS serving the terminating UE needs to be rejected, when the AS receives a SIP 18x response, the AS shall: + +- include a P-Asserted-Identity header field containing the public user identity of the terminating user unless privacy policy or restriction services prevent providing any public user identity of the terminating party; +- if the AS supports the P-Early-Media header field, the AS shall insert a P-Early-Media header field, or modify an existing header field, with an "inactive" value before forwarding the provisional response; +- remove the SDP a=content media-level attribute "g.3gpp.cat" value; +- forward the SIP 18x response to the originating UE; and +- when a SIP PRACK request from originating UE is received, the AS shall forward the SIP PRACK including the P-Early-Media header field with an "inactive" value. + +##### 4.5.5.2.4 AS Actions for CAT stop + +Upon receipt of specific DTMF digit for CAT stop, the AS instructs the MRF to stop the media for the CAT service. + +Upon receipt of specific DTMF digit for CAT restart, the AS instructs the MRF to restart the media for the CAT service. + +##### 4.5.5.2.5 AS support of DTMF + +If the UE has indicated support of both the "telephone-event" media subtype and the SIP INFO mechanism for DTMF transport, the AS shall based on operator policy choose which DTMF transport mechanism to use for CAT control between the UE and the AS. + +If the AS wants to use the SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [4], the AS shall indicate support of the mechanism in a response sent to the UE by including a Recv-Info header field with a "infoDtmf" value, as defined in IETF RFC 6086 [11]. + +If the AS wants to use the "telephone-event" media subtype for DTMF transport, the AS shall include the "telephone-event" in the SDP for CAT media, sent to the UE. + +NOTE: The usage of the "telephone-event" media subtype for CAT control requires that intermediates allow the telephone-event packages to traverse from the UE to the AS during the early dialog. + +For the remainder of this subclause, when the term "receipt of DTMF digit" is used, it means either the detection of a DTMF digit by the MRF, which is then passed to the AS over the Cr interface, or the receipt of an INFO request containing the appropriate INFO package, as negotiated above. + +##### 4.5.5.2.6 AS Actions for Gateway model + +The AS performing the Gateway model shall follow the procedure as specified in RFC 3960 [8] and annex G in 3GPP TS 24.628 [14] with the additional procedures described in this subclause. + +Upon receiving an initial INVITE request, before forwarding the initial INVITE request towards the terminating UE, the AS shall: + +- a) store the SDP offer sent from the originating side if the AS is going to update media with both originating side and terminating side when the 200 (OK) response to the initial INVITE request is received; +- b) if required by local policy, remove the P-Early-Media header field, if present; and +- c) contact the MRF to request CAT resource. + +When the video media feature tag is not included in the Contact header field of the initial INVITE request towards the terminating UE and there is no video description in the SDP offer included in the initial INVITE request, the AS shall not request video CAT resource from MRF, and shall not apply video CAT media to the originating UE. + +**Editor's note: [TEI15, CR0096] the mechanism and procedure to support the selection of the media type of early media by end users is FFS.** + +**NOTE:** If playing customized media before alerting is allowed based on operator's policy, upon forwarding the initial INVITE request to the terminating UE, the AS can play customized media before alerting by following the procedure as specified in annex G in 3GPP TS 24.628 [14]. When to stop the customized media depends on operator's policy. + +Upon receiving an SIP 180 (Ringing) response or SIP 183 (Session Progress) response to the initial SIP INVITE request sent to the terminating UE, before forwarding the response towards the originating UE, the AS shall: + +- a) if the SIP 180 (Ringing) response or the SIP 183 (Session Progress) response to the initial SIP INVITE request includes an SDP answer, store the SDP answer received from the terminating UE; +- b) if the AS has not sent an SDP answer: + - 1) generate an SDP answer, either: + - i) based on the SDP answer as received from the terminating UE, if: + - the originating UE indicated support for the precondition mechanism by including the "precondition" option tag in the Supported header field in the initial INVITE request and the terminating UE applied the precondition mechanism to the session by including "precondition" option tag in the Require header field in the 18x response sent to the originating UE as described in RFC 3312 [17], and the resources required between the originating UE and the terminating UE are more than the resources required between originating UE and MRF associated with the AS for CAT; or + - the media types required between originating UE and MRF associated with the AS for CAT are different from the media types required between the originating UE and the terminating UE; or + - ii) based on the information received from the MRF associated with AS for CAT, for all other cases; + - 2) include an SDP content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value in the generated SDP answer; and + - 3) remove the received P-Early-Media header field if present, and include a P-Early-Media header field with a "sendrecv" value or a "sendonly" value; and +- c) if the AS has sent an SDP answer, the AS shall not generate an SDP answer. + +**NOTE:** The procedures for handling multiple early dialogs, due to forking, is not specified in the current release of this specification. + +If the originating UE indicated support for the precondition mechanism and the precondition mechanism was applied to the session, the AS shall not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled. The point when the AS instruct the MRF to start applicable media for the CAT service is based on local policy. + +If the originating UE indicated support for the precondition mechanism and local resources were indicated not available in the initial INVITE request, and if the precondition mechanism was applied to the session, after forwarding an UPDATE request from the originating UE to the terminating UE which indicates that resources at the originating UE are available, upon receiving an SIP 200 (OK) response for the UPDATE request from the terminating UE, the AS shall: + +- a) store the SDP of the terminating UE; and +- b) forward the SDP of the terminating UE to the originating UE. + +Upon receiving the first 18x response without applying the precondition mechanism or a 180 (Ringing) response to the initial INVITE request from the terminating UE used to indicate that resources are available on the terminating UE and user is being alerted, + +- a) if the originating UE indicated support for the precondition mechanism and + - 1) if the precondition mechanism was applied to the session, the AS shall + - i) send an UPDATE request with an SDP offer based on the SDP of CAT to the originating UE, the media types required in the SDP offer can include additional media types compared to the SDP offer initiated by the originating UE in the previous INVITE request, and + - ii) use the precondition mechanism in the UPDATE request as specified in RFC 3312 [17], and not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled in the 200 (OK) response to the UPDATE request or subsequent UPDATE request; or + - 2) if the precondition mechanism was not applied to the session, when the media types required in the SDP of the CAT and the previous SDP offer in INVITE request are different, + - i) the AS shall send an UPDATE request with an SDP offer based on the SDP of the CAT to the originating UE; and + - ii) the AS may based on local policy use the precondition mechanism in the UPDATE request as specified in RFC 3312 [17], if the precondition mechanism is used in the UPDATE request, the AS shall not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled in the 200 (OK) response to the UPDATE request or subsequent UPDATE request; or +- b) if the originating UE did not indicate support for the precondition mechanism, and if the media types required in the SDP of the CAT and the previous SDP offer in the initial INVITE request are different, the AS shall send an UPDATE request to the originating UE with an SDP offer based on the SDP of the CAT. + +If UPDATE request containing an SDP offer from terminating side is received when a 180 (Ringing) response has been sent and a 200 (OK) response to the initial INVITE has not been sent yet, the AS shall: + +- a) not forward the UPDATE request to the originating side; +- b) store the SDP offer contained in the UPDATE request, and if SDP answer or SDP offer from terminating side has been stored previously, the AS shall replace it with the new received SDP offer; and +- c) respond to the UPDATE request with a 200 (OK) response and generate an SDP answer based on the SDP offer previously sent from the originating side. + +Upon receiving an SIP 200 (OK) (INVITE) from terminating UE, if it is not allowed to continue playing video CAT by operator or user settings, or if video CAT media has not been played during the called party alerting, the AS shall instruct the MRF to stop the media for the CAT service and either: + +- a) if the AS is going to update media only with the originating side, generate an UPDATE request as specified in RFC 3311 [13] to update the media with the originating UE using either: + - 1) if the AS has previously stored the SDP answer or SDP offer sent from the terminating side, the SDP answer of the terminating UE as previously stored; or + - 2) if the AS has not previously stored SDP answer or SDP offer sent from the terminating side, the SDP answer received in the immediate 200 (OK) response to the SIP INVITE request; or +- b) if the AS is going to update media with both originating side and terminating side: + - 1) send an offerless re-INVITE request to the terminating side; + +- 2) upon receiving a SIP response to the re-INVITE request containing an SDP offer from the terminating side, generate an UPDATE request as specified in RFC 3311 [13] to send an SDP offer to the originating UE. The SDP offer shall only contain the media components which appeared both in the SDP offer contained in the SIP response to the re-INVITE request and the previously stored SDP offer in the initial INVITE, and set the port number of the corresponding m-line to zero if it has been set to zero during previous SDP negotiation; and +- 3) upon receiving a 200 (OK) response to the UPDATE request from the originating side, generate an SDP answer to the terminating side, included in the ACK request associated with the re-INVITE request. The SDP answer shall be based on the SDP answer contained in the 200 (OK) response to the UPDATE request, and for the media components which not appear in the SDP answer in the 200 (OK) response, set the port number of the corresponding m-line to zero. + +If video CAT has been played during the called party alerting, and if it is allowed to continue playing video CAT by operator and user settings during conversation, upon receiving an SIP 200 (OK) (INVITE) from terminating UE, the AS shall perform either above bullet a) or bullet b) in the paragraph above related to the reception of 200 (OK) on INVITE with additions described below: + +- a) before using the SDP answer received from terminating UE to update media with originating UE by UPDATE request, the AS shall: + - 1) if the SDP answer only includes audio components, which means the conversation is going to be audio conversation, insert video components into this SDP answer based on the CAT information previously received from MRF, the video components shall include: + - i) a media-level attribute "c=", as specified in RFC 4566 [15], with a value of the corresponding IP address for CAT media; + - ii) a media-level attribute with a "g.3gpp.cat" value; and + - iii) an "a=sendonly" attribute. + - 2) if the SDP answer includes video components but with zero port number or with an "a=inactive" attribute, which also means the conversation is going to be audio conversation, replace the existed video components with new video components based on the CAT information previously received from MRF, the new video media components shall include: + - i) a media-level attribute "c=", as specified in RFC 4566 [15], with a value of the corresponding IP address for CAT media; + - ii) a media-level attribute with a "g.3gpp.cat" value; and + - iii) an "a=sendonly" attribute. + - 3) if the SDP answer includes video descriptions with port number greater than zero and without an "a=inactive" attribute, instruct the MRF to stop to play CAT media. +- b) upon receiving a 200 (OK) response associated with the UPDATE request mentioned in the first sentence of bullet a) from the originating side: + - 1) if the AS is going to forward the SDP answer contained in this 200 (OK) response to terminating UE, before forwarding the SDP answer to the terminating UE, the AS shall exclude CAT related media descriptions from the SDP answer; and + - 2) if the SDP answer in this 200 (OK) response includes the video components of video CAT, after the media update in bullet a) in the paragraph above related to continue playing video CAT is finished, the AS shall instruct the MRF to stop the audio stream of video CAT. + +#### 4.5.5.3 Actions at the AS serving the terminating UE + +##### 4.5.5.3.1 General + +The procedures specified in 3GPP TS 24.229 [4] for an AS acting as a routing B2BUA apply with additions described in the subclauses below. + +If the initial INVITE destined to served user includes a Supported header field with "early-session" option-tag and the AS supports the "early-session" extension as described in RFC 3959 [7], the AS shall based on operator policy follow the procedures in subclause 4.5.5.3.3 to provide CAT service. The procedures in subclause 4.5.5.3.3 shall not be used if there are intermediaries in the network that do not understand the procedures. + +Depending on the operator policy, it shall also be possible for the AS to perform the actions specified as Gateway model in RFC 3960 [8]. + +The AS shall follow procedures specified in subclause 4.6 for any services where interaction shall be considered. + +##### 4.5.5.3.2 AS actions for forking model + +The AS performing the forking model shall follow the procedure as specified in annex D in 3GPP TS 24.628 [14] with the additional procedures described in this subclause. + +Upon receiving an initial SIP INVITE request destined to the served user, the AS shall: + +- a) based on local policy remove the P-Early-Media header field, if present; +- b) forward the initial SIP INVITE request to the served user; +- c) contact the MRF to request CAT resources; and +- d) send a reliable SIP 183 (Session Progress) response to the originating UE. The SIP 183 (Session Progress) provisional response shall: + - include a P-Asserted-Identity header field containing the public user identity of the served user unless privacy policy or restriction services prevent providing any public user identity of the terminating party; + - include a To header field with a To tag locally generated by the AS; + - include a P-Early-Media header field with a "sendrecv" value or a "sendonly" value; + - include an SDP answer, based on information received from the MRF. The AS shall include an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value in the SDP answer; and + - if a Supported header field with an option tag "precondition" was received in the initial INVITE request and the AS decides to use the precondition mechanism, indicate in the SDP answer that the local preconditions are fulfilled. + +If preconditions are used, the AS shall not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled. The point when the AS instructs the MRF to start applicable media for the CAT service is based on local policy. If the AS can provide CAT media for media lines not included in the original SDP offer and the UE in the Contact header field included media feature tags indicating support for the additional media, the AS shall send an UPDATE request towards the UE in the dialog with a negotiated SDP. The AS shall include in this UPDATE request: + +- a) an SDP offer based on an offer from the MRF with any new media lines placed after the existing media-lines. The AS shall include an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value in all the media lines; +- b) a P-Early-Media header field with a "sendrecv" value or a "sendonly" value; and +- c) if preconditions are used, an indication in the SDP offer that local preconditions are fulfilled. + +NOTE 1: The AS can, based on local policy, wait to send the SIP 183 (Session Progress) response to the originating UE until the AS has received a SIP 180 (Ringing) provisional response from the served UE. + +NOTE 2: The AS can, based on local policy, wait to instruct the MRF to start CAT media until the AS has received a SIP 180 (Ringing) provisional response from the served UE. + +NOTE 3: The interaction between the AS and MRF is not specified for the CAT service but can use the Cr reference point as described in 3GPP TS 24.229 [4]. + +NOTE 4: If the AS acts as a Proxy and does not want to remain in the signalling path between the originating UE and the terminating UE, the AS does not need to add its own SIP-URI to the SIP Record-Route header field. If the AS acts as a B2BUA, the AS will always remain in the signalling path. + +NOTE 5: The AS can, if it supports the P-Early-Media header field, based on local policy choose to not provide the CAT service to the originating UE if the initial INVITE request does not contain a P-Early-Media header field with a "supported" value. + +Upon receiving a reliable provisional response from a served UE containing an SDP answer to the original SIP INVITE request, the AS: + +- may forward the provisional response to the originating UE reliably and, unless the provisional response contained a 199 response code, after changing the Status-Line to SIP 183 (Session Progress) response; +- shall insert a P-Early-Media header field, or modify an existing header field, with an "inactive" value before forwarding the provisional response; +- shall, if the reliable provisional response is not forwarded to the originating UE, acknowledge the received provisional response by sending a SIP PRACK request as defined in RFC 3262 [5] to the served UE; and +- shall, if the reliable provisional response contained an SDP answer and the provisional response is not forwarded to the originating UE, save the SDP answer contained in the reliable provisional response for that particular early dialog. If forking has occurred toward the served user, the AS may save SDP answers from several different UEs; + +If precondition procedures are used between the originating UE and the served UE, the AS shall forward reliable provisional responses which contain SDP to the originating UE, in order to allow the UEs to exchange additional SDP offers and answers associated with the precondition procedures. + +Upon receiving an unreliable provisional response from a served UE to the original SIP INVITE request, the AS may forward the provisional response to the originating UE and, unless the provisional response contained a 199 response code, after changing the Status-Line to SIP 183 (Session Progress) response. + +If the AS supports the P-Early-Media header field, the AS shall insert a P-Early-Media header field with an "inactive" value before forwarding the provisional response. + +Upon receiving a SIP 200 (OK) response to the initial SIP INVITE request from a served UE indicating that the served user has answered the call, the AS shall: + +- instruct the MRF to stop the media for the CAT service; +- forward the SIP 200 (OK) response to the originating UE; and +- if the AS has saved the SDP answer associated with the dialog confirmed by the SIP 200 (OK) response and if the AS has not forwarded the SDP answer to the originating UE, the AS shall include the saved SDP answer in the SIP 200 (OK) response. + +Upon receiving a SIP 4xx, 5xx or 6xx response from a served UE the AS shall: + +- instruct the MRF to stop the media for the CAT service; and +- forward the final response to the originating UE. + +Upon receiving a SIP PRACK request including the P-Early-Media header field with an "inactive" value, the AS shall: + +- instruct the MRF to release the media resource reserved for the CAT service; and +- forward the SIP PRACK request to the served UE. + +##### 4.5.5.3.3 AS Actions for early session model + +Upon receiving an initial INVITE request destined to the served user including a Supported header with "early-session" tag, as described in RFC 3959 [7], the AS: + +- may contact the MRF to request CAT resource if session SDP preconditions are not used, or local preconditions are fulfilled; + +- if required by local policy, remove the P-Early-Media header field, if present; and +- shall forward the initial INVITE request to the served user. + +Upon receiving the first SIP 18x response to the initial INVITE request, the AS shall: + +- if session SDP preconditions are not used in the initial INVITE request, or local preconditions in the initial INVITE request are fulfilled, then contact the MRF to request CAT resource if it has not been requested; +- send a reliable SIP 18x response to the originating UE. The SIP 18x response shall: + - include a P-Asserted-Identity header containing the public user identity of the served user unless privacy policy or restriction services prevent providing any public user identity of the terminating party; + - include a Require header with option tag "early-session"; + - include the SDP content, with an SDP a=content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value, for CAT as early-session SDP offer and if preconditions are used, and CAT resource has been requested, indicate the local preconditions are fulfilled; + +Upon receiving additional SIP 18x response to the initial INVITE request, the AS shall forward it to the originating UE. + +Upon receiving a SIP request containing an early-session SDP offer that indicates the local preconditions are fulfilled, the AS shall: + +- contact the MRF to request CAT resource; +- generate an early-session SDP answer based on the information from the MRF and, if preconditions are used, indicate that the local preconditions are fulfilled; and +- after receiving a SIP 200 (OK) response to the request, include the early-session SDP answer in the SIP 200 (OK) response, and forwards it to the originator. + +If preconditions are used, the AS should not instruct the MRF to start applicable media for the CAT service before the originating UE indicates that early-session SDP local preconditions are fulfilled. Whether to start applicable media for the CAT service before or after receiving the SIP 180 (Ringing) response from the served UE is based on local policy. + +If a SIP message from served UE containing an SDP offer related to an early session is received, the AS shall send an SDP answer to the SDP offer related to the early-session sent by the served UE and set all port numbers of the media types to "0". + +Upon receiving a SIP 200 (OK) response from the served UE to the initial INVITE request, the AS shall instruct the MRF to stop media for the CAT service and forward the SIP 200 (OK) response to the originating UE. + +NOTE 1: The interaction between the AS and MRF is not specified for the CAT service but can use the Cr reference point as described in 3GPP TS 24.229 [4]. + +Upon receiving a SIP 4xx, 5xx or 6xx response from a served UE the AS shall: + +- instruct the MRF to stop the media for the CAT service; and +- forward the final response to the originating UE. + +##### 4.5.5.3.4 AS Actions for CAT copy + +Upon receipt of the specific DTMF digit, the AS copies the media for the called party's CAT service. + +NOTE: How the AS copies the called party's CAT is out of the scope of this document. + +##### 4.5.5.3.5 AS Actions for CAT stop + +Upon receipt of the specific DTMF digit for CAT stop, the AS instructs the MRF to stop the media for the CAT service. + +Upon receipt of the specific DTMF digit for CAT restart, the AS instructs the MRF to restart the media for the CAT service. + +##### 4.5.5.3.6 AS support of DTMF + +If the UE has indicated support of both the "telephone-event" media subtype and the SIP INFO mechanism for DTMF transport, the AS shall based on operator policy choose which DTMF transport mechanism to use for CAT control between the UE and the AS. + +If the AS wants to use the SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [4], the AS shall indicate support of the mechanism in a response sent to the UE by including a Recv-Info header field with a "infoDtmf" value, as defined in IETF RFC 6086 [11]. + +If the AS wants to use the "telephone-event" media subtype for DTMF transport, the AS shall include the "telephone-event" in the SDP for CAT media, sent to the UE. + +NOTE: The usage of the "telephone-event" media subtype for CAT control requires that intermediates allow the telephone-event packages to traverse from the UE to the AS during the early dialog. + +For the remainder of this subclause, when the term "receipt of DTMF digit" is used, it means either the detection of a DTMF digit by the MRF, which is then passed to the AS over the Cr interface, or the receipt of an INFO request containing a DTMF Info Package, as negotiated above. + +##### 4.5.5.3.7 AS Actions for Gateway model + +The AS performing the Gateway model shall follow the procedure as specified in RFC 3960 [8] and annex G in 3GPP TS 24.628 [14] with the additional procedures described in this subclause. + +Upon receiving an initial INVITE request, before forwarding the initial INVITE request towards the terminating UE, the AS shall: + +- a) store the SDP offer sent from the originating side if the AS is going to update media with both originating side and terminating side when the 200 (OK) response to the initial INVITE request is received; +- b) if required by local policy, remove the P-Early-Media header field, if present; and +- c) contact the MRF to request CAT resource. + +When the video media feature tag is not included in the Contact header field of the initial INVITE request towards the terminating UE and there is no video description in the SDP offer included in the initial INVITE request, the AS shall not request video CAT resource from MRF, and shall not apply video CAT media to the originating UE. + +**Editor's note:** [TEI15, CR0096] the mechanism and procedure to support the selection of the media type of early media by end users is FFS. + +NOTE: If playing customized media before alerting is allowed based on operator's policy, upon forwarding the initial INVITE request to the terminating UE, the AS can play customized media before alerting by following the procedure as specified in annex G in 3GPP TS 24.628 [14]. When to stop the customized media depends on operator's policy. + +Upon receiving an SIP 180 (Ringing) response or SIP 183 (Session Progress) response to the initial SIP INVITE request sent to the terminating UE, before forwarding the response towards the originating UE, the AS shall: + +- a) if the SIP 180 (Ringing) response or the SIP 183 (Session Progress) response to the initial SIP INVITE request includes an SDP answer, store the SDP answer received from the terminating UE; +- b) if the AS has not sent an SDP answer: + - 1) generate an SDP answer, either: + - i) based on the SDP answer as received from the terminating UE, if: + - the originating UE indicated support for the precondition mechanism by including the "precondition" option tag in the Supported header field in the initial INVITE request and the terminating UE applied the precondition mechanism to the session by including "precondition" option tag in the Require header field in the 18x response sent to the originating UE as described in RFC 3312 [17], and the resources required between the originating UE and the terminating UE are more than the resources required between originating UE and MRF associated with the AS for CAT; or + +- the media types required between originating UE and MRF associated with the AS for CAT are different from the media types required between the originating UE and the terminating UE; or + - ii) based on the information received from the MRF associated with AS for CAT, for all other cases; +- 2) include an SDP content media-level attribute, as specified in RFC 4796 [12], with a "g.3gpp.cat" value in the generated SDP answer; and + - 3) remove the received P-Early-Media header field if present, and include a P-Early-Media header field with a "sendrecv" value or a "sendonly" value; and +- c) if the AS has sent an SDP answer, the AS shall not generate an SDP answer. + +NOTE: The procedures for handling multiple early dialogs, due to forking, is not specified in the current release of this specification. + +If the originating UE indicated support for the precondition mechanism and the precondition mechanism was applied to the session, the AS shall not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled. The point when the AS instruct the MRF to start applicable media for the CAT service is based on local policy. + +If the originating UE indicated support for the precondition mechanism and local resources were indicated not available in the initial INVITE request, and if the precondition mechanism was applied to the session after forwarding an UPDATE request from the originating UE to the terminating UE which indicates that resources at the originating UE are available, upon receiving an SIP 200 (OK) response for the UPDATE request from the terminating UE, the AS shall: + +- a) store the SDP of the terminating UE; and +- b) forward the SDP of the terminating UE to the originating UE. + +Upon receiving the first 18x response without applying the precondition mechanism or a 180 (Ringing) response to the initial INVITE request from the terminating UE used to indicate that resources are available on the terminating UE and user is being alerted, + +- a) if the originating UE indicated support for the precondition mechanism and + - 1) if the precondition mechanism was applied to the session, the AS shall + - i) send an UPDATE request with an SDP offer based on the SDP of CAT to the originating UE, the media types required in the SDP offer can include additional media types compared to the SDP offer initiated by the originating UE in the previous INVITE request, and + - ii) use the precondition mechanism in the UPDATE request as specified in RFC 3312 [17], and not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled in the 200 (OK) response to the UPDATE request or subsequent UPDATE request; or + - 2) if the precondition mechanism was not applied to the session, when the media types required in the SDP of the CAT and the previous SDP offer in INVITE request are different, + - i) the AS shall send an UPDATE request with an SDP offer based on the SDP of the CAT to the originating UE; and + - ii) the AS may based on local policy use the precondition mechanism in the UPDATE request as specified in RFC 3312 [17], if the precondition mechanism is used in the UPDATE request, the AS shall not instruct the MRF to start applicable media for the CAT service before the originating UE has indicated that preconditions are fulfilled in the 200 (OK) response to the UPDATE request or subsequent UPDATE request; or +- b) if the originating UE did not indicate support for the precondition mechanism, and if the media types required in the SDP of the CAT and the previous SDP offer in the initial INVITE request are different, the AS shall send an UPDATE request to the originating UE with an SDP offer based on the SDP of the CAT. + +If UPDATE request containing an SDP offer from terminating side is received when a 180 (Ringing) response has been sent and a 200 (OK) response to the initial INVITE has not been sent yet, the AS shall: + +- a) not forward the UPDATE request to the originating side; and +- b) store the SDP offer contained in the UPDATE request, and if SDP answer or SDP offer from terminating side has been stored previously, the AS shall replace it with the new received SDP offer; and +- c) respond to the UPDATE request with a 200 (OK) response and generate an SDP answer based on the SDP offer previously sent from the originating side. + +Upon receiving an SIP 200 (OK) (INVITE) from terminating UE, if it is not allowed to continue playing video CAT by operator or user settings, or if video CAT media has not been played during the called party alerting, the AS shall instruct the MRF to stop the media for the CAT service and either: + +- a) if the AS is going to update media only with the originating side, generate an UPDATE request as specified in RFC 3311 [13] to update the media with the originating UE using either: + - 1) if the AS has previously stored the SDP answer or SDP offer sent from the terminating side, the SDP answer of the terminating UE as previously stored; or + - 2) if the AS has not previously stored SDP answer or SDP offer sent from the terminating side, the SDP answer received in the immediate 200 (OK) response to the SIP INVITE request.or +- b) if the AS is going to update media with both originating side and terminating side: + - 1) send an offerless re-INVITE request to the terminating side; + - 2) upon receiving a SIP response to the re-INVITE request containing an SDP offer from the terminating side, generate an UPDATE request as specified in RFC 3311 [13] to send an SDP offer to the originating UE. The SDP offer shall only contain the media components which appeared both in the SDP offer contained in the SIP response to the re-INVITE request and the previously stored SDP offer in the initial INVITE, and set the port number of the corresponding m-line to zero if it has been set to zero during previous SDP negotiation; and + - 3) upon receiving a 200 (OK) response to the UPDATE request from the originating side, generate an SDP answer to the terminating side, included in the ACK request associated with the re-INVITE request. The SDP answer shall be based on the SDP answer contained in the 200 (OK) response to the UPDATE request, and for the media components which not appear in the SDP answer in the 200 (OK) response, set the port number of the corresponding m-line to zero. + +If video CAT has been played during the called party alerting, and if it is allowed to continue playing video CAT by operator and user settings during conversation, upon receiving an SIP 200 (OK) (INVITE) from terminating UE, the AS shall perform either above bullet a) or bullet b) in the paragraph above related to the reception of 200 (OK) on INVITE with additions described below: + +- a) before using the SDP answer received from terminating UE to update media with originating UE by UPDATE request, the AS shall: + - 1) if the SDP answer only includes audio components, which means the conversation is going to be audio conversation, insert video components into this SDP answer based on the CAT information previously received from MRF, the video components shall include: + - i) a media-level attribute "c=", as specified in RFC 4566 [15], with a value of the corresponding IP address for CAT media; + - ii) a media-level attribute with a "g.3gpp.cat" value; and + - iii) an "a=sendonly" attribute. + - 2) if the SDP answer includes video components but with zero port number or with an "a=inactive" attribute, which also means the conversation is going to be audio conversation, replace the existed video components with new video components based on the CAT information previously received from MRF, the new video media components shall include: + - i) a media-level attribute "c=", as specified in RFC 4566 [15], with a value of the corresponding IP address of CAT media; + - ii) a media-level attribute with a "g.3gpp.cat" value; and + +- iii) an "a=sendonly" attribute. +- 3) if the SDP answer includes video descriptions with port number greater than zero and without an "a=inactive" attribute, which means the conversation is going to be video conversation, instruct the MRF to stop to play CAT media. +- b) upon receiving a 200 (OK) response associated with the UPDATE request mentioned in the first sentence of bullet a) from the originating side: + - 1) if the AS is going to forward the SDP answer contained in this 200 (OK) response to terminating UE, before forwarding the SDP answer to the terminating UE, the AS shall exclude CAT related media descriptions from the SDP answer; and + - 2) if the SDP answer in this 200 (OK) response includes the video components of video CAT, after the media update in bullet a) in the paragraph above related to continue playing video CAT is finished, the AS shall instruct the MRF to stop the audio stream of video CAT. + +## 4.6 Interaction with other services + +### 4.6.1 Communication session Hold (HOLD) + +No impact, i.e. neither service shall affect the operation of the other service. + +### 4.6.2 Termination Identification Presentation (TIP) + +No impact, i.e. neither service shall affect the operation of the other service. + +### 4.6.3 Termination Identification Restriction (TIR) + +The TIR service takes precedence over the CAT service subscribed by the called party. If the TIR service prevents CAT media from being played to the calling party, then the AS providing CAT service shall not apply the CAT service to the session. + +### 4.6.4 Originating Identification Presentation (OIP) + +The order of the services in the filter criteria list should be configured so that CAT service appears before OIP service, in order for the CAT service to provide CAT media associated with the calling party's identity (i.e., the called party may play one type of CAT media to a particular caller and other types of CAT media to other callers depending on the called party's subscription). + +**NOTE:** If the called party does not subscribe to OIP service, the AS providing OIP service will remove P-Asserted-Identity according to 3GPP TS 24.607 [10], and it will not be possible to provide CAT service based on calling party's identity if the OIP service was applied prior to CAT service in this given case. Unless the network operator can assure that such scenario do not occur based on their service configuration, as CAT service cannot be aware of whether OIP service is subscribed by the user, and OIP service cannot be aware of how CAT service is to be performed, CAT service will always need to be performed prior to OIP service. + +### 4.6.5 Originating Identification Restriction (OIR) + +The OIR service takes precedence over the CAT service subscribed by the called party. The behaviour of the CAT service is dependent on whether if the called party has a CAT service associated with the calling party's identity (i.e., the called party may play one type of CAT media to a particular caller and other types of CAT media to other callers depending on the called party's subscription) and whether OIR service is requested. + +The AS providing CAT service shall: + +- 1) if the called party has CAT service associated with that specific calling party's identity, the AS shall: + - inspect the priv-value set in the Privacy header field in the request; and + - if the Privacy header field is set to either "id", "header", or "user", i.e. OIR service is requested, then the AS shall not apply CAT service to the session. + +- 2) in all other cases (i.e. except for the case if the called party has CAT service associated with that specific calling party's identity, and OIR service is requested), the AS shall process CAT service based on the called party's subscription. + +NOTE: OIR service itself is independent from CAT service, as the identities that need to be restricted towards the terminating user will be handled, i.e. restricted, appropriately by other functional entities as specified in 3GPP TS 24.229 [4], e.g. at the boundary of trust domain which may be the terminating P-CSCF. + +### 4.6.6 Conference (CONF) + +No impact, i.e. neither service shall affect the operation of the other service. + +### 4.6.7 Communication Diversion services (CDIV) + +#### 4.6.7.1 General + +If the diverting party has both CAT service and CDIV active, and the diverted-to party has CAT service active, based on operator policy, either: + +- 1) the CAT service of the diverted-to party shall be applied to the session by the AS providing the CAT service of diverted-to party, except in the case of CFNR. The interaction of CAT service with CFNR is described in subclause 4.6.7.2; or +- 2) the CAT service of the diverting party shall be applied to the session by the AS providing CAT service for the diverting party, without the CAT service for the diverted-to party applied to the session. + +NOTE 1: the above network operator option can be deployed in cases where diversion of the call is hidden from the calling party. + +If the diverting party has both CAT service and CDIV active, and the diverted-to party does not have an active service, based on operator policy, either: + +- 1) no CAT service shall be applied to the session when CDIV is invoked; or +- 2) the CAT service of the diverting party shall be applied to the session by the AS providing CAT service for the diverting party, without the CAT service for the diverted-to party applied to the session. + +NOTE 2: the above network operator option can be deployed in cases where diversion of the call is hidden from the calling party. + +#### 4.6.7.2 CFNR + +If the diverting party has both CAT service and CFNR active, and the diverted-to party has CAT service active, based on operator policy, either: + +- 1) the CAT service of the diverting party shall be applied to the session by the AS providing CAT service for the diverting party until the CFNR timer expires. Upon the CFNR timer expiring, the AS providing CAT service for the diverting party shall stop applying the CAT for the diverting user and the AS providing CAT service for the diverted-to party shall apply the CAT service of the diverted-to party; or +- 2) the CAT service of the diverting party shall be applied to the session by the AS providing CAT service for the diverting party, without the CAT service for the diverted-to party applied to the session. + +NOTE 1: the above network operator option can be deployed in cases where diversion of the call is hidden from the calling party. + +If the diverting party has CAT service and CFNR active, and the diverted-to party does not have an active service, based on operator policy, either: + +- 1) the CAT service of the diverting party shall be applied to the session by the AS providing CAT service for the diverting party until the CFNR timer expires; or +- 2) the CAT service of the diverting party shall be applied to the session by the AS providing CAT service for the diverting party, without the CAT service for the diverted-to party applied to the session, until reception of a final SIP response to the INVITE. + +NOTE 2: the above network operator option can be deployed in cases where diversion of the call is hidden from the calling party. + +### 4.6.8 Message Waiting Indication (MWI) + +No impact, i.e. neither service shall affect the operation of the other service. + +### 4.6.9 Communication Barring (CB) + +No impact, i.e. neither service shall affect the operation of the other service. + +### 4.6.10 Explicit Call Transfer (ECT) + +If the transfer target has CAT service active, the AS providing CAT service shall apply the transfer target's CAT in the case of blind transfer. The AS providing CAT service shall not apply the transfer target's CAT in the case of consultative transfer while the call is transferring to the transfer target. + +The CAT service of the transferor shall not be applied when ECT is invoked. + +### 4.6.11 Communication Wait + +In the case that the called party has Communication Waiting and CAT services active, the AS providing the CAT service for the called party shall apply the called party's CAT to the session if the called party is considered 'approaching network determined user busy' as a network operator option. Alternatively, the AS providing the call party's CAT shall not apply the CAT service and the Communication Waiting alert shall be applied. + +### 4.6.12 Completion of Communications to Busy Subscriber + +No impact, i.e. neither service shall affect the operation of the other service. + +### 4.6.13 Customized Ringing Signal (CRS) + +In following scenarios, + +- both CAT and CRS is provided using early session model, calling party has CRS service and called party has CAT service; +- both CAT and CRS is provided using early session model, calling party has CAT and CRS service, and CRS has high iFC priority than CAT; or +- both CAT and CRS is provided using early session model, called party has CAT and CRS service, and CRS has high iFC priority than CAT, + +if receiving a SIP PRACK request include two early session SDP, i.e. the early session SDP answer from originating UE for early session model CAT and the early session SDP offer from CRS AS for early session model CRS, CAT AS shall: + +- recognize the SDP which includes an SDP a=content attribute with a "g.3gpp.cat" value for each media description is the SDP answer from originating UE for CAT service; and +- remove the selected SDP before forwarding the SIP PRACK request. + +In other scenarios, neither service shall affect the operation of the other service. + +### 4.6.14 Multi-Device (MuD) + +No impact. + +### 4.6.15 Multi-Identity (MiD) + +In the terminating network, if identity D, as defined in 3GPP TS 24.174 [16], has CAT service active, and user B, as defined in 3GPP TS 24.174 [16], has CAT service active, based on operator policy, either: + +- 1) the CAT service of user B shall be applied to the session by the AS providing the CAT service of user B; or + +- 2) the CAT service of identity D shall be applied to the session by the AS providing CAT service for identity D, without the CAT service of user B applied to the session. + +If identity D has CAT service active, and user B does not have CAT service active, based on operator policy, either: + +- 1) no CAT service shall be applied to the session; or +- 2) the CAT service of identity D shall be applied to the session by the AS providing CAT service for identity D, without the CAT service of user B applied to the session. + +In the originating network, no impact. + +## 4.7 Parameter values (timers) + +No timers for CAT service are defined + +## 4.8 Service configuration + +User configuration of CAT service is not specified in this version of the document. + +# --- Annex A (informative): Signalling flows + +## A.1 Scope of signalling flows + +This annex gives examples of signalling flows for the CAT service within the IP Multimedia (IM) Core Network (CN) subsystem based on the Session Initiation Protocol (SIP). + +## --- A.2 Void + +## A.3 CAT forking model signalling flows + +### A.3.1 Introduction + +The following flows show establishment of a session between UE#1 and UE#2, using the forking model described in subclause 4.5.5.3.2 to provide CAT to UE#1. The following flows are included: + +- subclause A.3.2 shows CAT, using the forking, model, when UE#1 and UE#2 have resources available; +- subclause A.3.3 shows CAT, using the forking, model, when UE#1 does not have resources available; +- subclause A.3.4 shows CAT, using the forking, model, when UE#2 does not have resources available; + +### A.3.2 CAT when UE#1 and UE#2 have resources available + +![Sequence diagram for CAT, no resource reservation. Lifelines: UE #1, S-CSCF, C-AAS, UE #2. The diagram shows a SIP call setup where UE #1 sends an INVITE to S-CSCF, which is then forwarded to C-AAS and then to UE #2. UE #2 responds with 180 (Ringing) and 200 (OK) messages. C-AAS performs resource reservation and media start/stop actions. The sequence ends with ACK messages.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant SCSCF as S-CSCF + participant CAAS as C-AAS + participant UE2 as UE #2 + + Note over UE1: Resources available + UE1->>SCSCF: 1. INVITE (SDP_O) + SCSCF->>CAAS: 2. INVITE (SDP_O) + Note over CAAS: Reserve CA resources + Note over UE2: Resources available + CAAS->>SCSCF: 3. INVITE (SDP_O) + SCSCF->>UE2: 4. INVITE (SDP_O) + UE2->>CAAS: 5. 180 (Ringing) (D2) + CAAS->>SCSCF: 6. 180 (Ringing) (D2) + SCSCF->>UE1: 8. 183 (Session Progress) (SDP_A, D1) + UE1->>SCSCF: 9. PRACK (D1) + SCSCF->>CAAS: 10. PRACK (D1) + Note over CAAS: Start CA media + CAAS->>SCSCF: 11. 200 (OK) (PRACK, D1) + SCSCF->>UE1: 12. 200 (OK) (PRACK, D1) + UE2->>SCSCF: 13. 200 (OK) (SDP_A, D2) + SCSCF->>CAAS: 14. 200 (OK) (SDP_A, D2) + Note over CAAS: Stop CA media + CAAS->>SCSCF: 15. 200 (OK) (SDP_A, D2) + SCSCF->>UE1: 16. 200 (OK) (SDP_A, D2) + UE1->>SCSCF: 17. ACK (D2) + SCSCF->>UE2: 18. ACK (D2) + +``` + +Sequence diagram for CAT, no resource reservation. Lifelines: UE #1, S-CSCF, C-AAS, UE #2. The diagram shows a SIP call setup where UE #1 sends an INVITE to S-CSCF, which is then forwarded to C-AAS and then to UE #2. UE #2 responds with 180 (Ringing) and 200 (OK) messages. C-AAS performs resource reservation and media start/stop actions. The sequence ends with ACK messages. + +**Figure A.3.2-1: CAT, no resource reservation** + +**1 INVITE request (UE#1 to S-CSCF) see example in table A.3.2-1** + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.3.2-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: IEEE-802.11a +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact:; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Accept:application/sdp, application/3gpp-ims+xml +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::aaa:bbb:ccc:ddd +s=- +c=IN IP6 6666::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, gruu and the 199 provisional response + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +#### 5-6 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +#### 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.3.2-2 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. + +An early dialog (D1) is established between UE#1 and the CAT-AS. + +NOTE: As an alternative, the CAT-AS can send the SIP 183 (Session Progress) provisional response when the initial SIP INVITE request is received from UE#1. + +**Table A.3.2-2: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1pcscf1.visited1.net;branch=z9hG4bK240f34.1, + SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Recv-Info: infoDtmf +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 6666::eee:fff:bbb:aaa +s=- +c=IN IP6 6666::eee:fff:bbb:aaa +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**Recv-Info:** The CAT-AS indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### 9-10 PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +##### 11-12 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.3.2-3 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.3.2-3: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +From: +To: ;tag=6322 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +``` + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +##### 15-16 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS forwards the SIP 200 (OK) response to UE#1. + +A dialog (D2) is established between UE#1 and UE#2. + +The early dialog (D1) between UE#1 and the CAT-AS is terminated. + +#### **17-78 ACK request (UE#1 to UE#2)** + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +### A.3.3 CAT when UE#1 does not have required resources available while UE#2 has resources available + +![Sequence diagram showing a SIP call flow between UE #1, S-CSCF, CAT-AS, and UE #2. The diagram illustrates a scenario where UE #1 does not have required resources available, leading to a series of SIP messages including INVITE, PRACK, 183, 200, and ACK. Key events include 'Resources available for D1', 'Reserve CAT resources', 'Start CAT media', and 'Stop CAT media'.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAT-AS as CAT-AS + participant UE2 as UE #2 + + Note right of UE2: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of CAT-AS: Reserve CAT resources + CAT-AS->>S-CSCF: 5. 183 (Session Progress) (SDP_A, D1) + S-CSCF->>UE1: 6. 183 (Session Progress) (SDP_A, D1) + Note left of UE1: Resources available for D1 + UE1->>S-CSCF: 7. PRACK (SDP_O, D1) + S-CSCF->>CAT-AS: 8. PRACK (SDP_O, D1) + CAT-AS->>S-CSCF: 9. 200 (OK) (SDP_A, D1) + S-CSCF->>UE1: 10. 200 (OK) (SDP_A, D1) + CAT-AS->>S-CSCF: 11. 180 (Ringing) (SDP_A, D2) + S-CSCF->>CAT-AS: 12. 180 (Ringing) (SDP_A, D2) + Note right of CAT-AS: Start CAT media + CAT-AS->>S-CSCF: 13. 183 (Session Progress) (SDP_A, D2) + S-CSCF->>UE1: 14. 183 (Session Progress) (SDP_A, D2) + Note left of UE1: Resources available for D2 + UE1->>S-CSCF: 15. PRACK (SDP_O, D2) + S-CSCF->>UE2: 16. PRACK (SDP_O, D2) + CAT-AS->>S-CSCF: 17. 200 (OK) (SDP_A, D2) + S-CSCF->>UE1: 18. 200 (OK) (SDP_A, D2) + CAT-AS->>UE2: 19. 200 (OK) (D2) + S-CSCF->>CAT-AS: 20. 200 (OK) (D2) + Note right of CAT-AS: Stop CAT media + CAT-AS->>S-CSCF: 21. 200 (OK) (D2) + S-CSCF->>UE1: 22. 200 (OK) (D2) + UE1->>S-CSCF: 23. ACK (D2) + S-CSCF->>UE2: 24. ACK (D2) + +``` + +Sequence diagram showing a SIP call flow between UE #1, S-CSCF, CAT-AS, and UE #2. The diagram illustrates a scenario where UE #1 does not have required resources available, leading to a series of SIP messages including INVITE, PRACK, 183, 200, and ACK. Key events include 'Resources available for D1', 'Reserve CAT resources', 'Start CAT media', and 'Stop CAT media'. + +**Figure A.3.3-1: CAT, UE#1 does not have required resources available** + +**1 INVITE request (UE#1 to CAT-AS)** see example in table A.3.3-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.3.3-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Accept: application/sdp, application/3gpp-ims+xml +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 6666::aaa:bbb:ccc:ddd +s=- +c=IN IP6 6666::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, gruu and the 199 provisional response. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the user at UE#1 for this session. The local preconditions are indicated as not fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the SIP INVITE request to UE#2. + +#### 5-6 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.3.3-2 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#2. + +An early dialog (D1) is established between UE#1 and the CAT-AS. + +NOTE: As an alternative, the CAT-AS can send the SIP 183 (Session Progress) provisional response when a SIP 180 (Ringing) provisional response is received from UE#2. + +**Table A.3.3-2: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1pcscf1.visited1.net;branch=z9hG4bK240f34.1, + SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Recv-Info: infoDtmf +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::eee:fff:bbb:aaa +s=- +c=IN IP6 6666::eee:fff:bbb:aaa +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**Recv-Info:** The CAT-AS indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### 7-8 PRACK request (UE#1 to CAT-AS) see example in table A.1.3-4 + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +**Table A.3.3-3: PRACK request (UE#1 to CAT-AS)** + +``` + +PRACK sip:cat-as.home1.net +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: +To: tag=2236 +Call-ID: +Cseq: 129 PRACK +Rack: 9022 +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933669 IN IP6 6666::aaa:bbb:ccc:ddd +s=- +c=IN IP6 6666::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**SDP:** The local preconditions are indicated as fulfilled, and media are set to "sendrecv". + +##### 9-10 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 11-12 180 (Ringing) provisional response (UE#2 to CAT-AS) see example in table A.3.3-4 + +The called party is alerted. UE#2 sends an unreliable SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to start CAT media. + +**Table A.3.3-4: 180 (Ringing) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +From: +To: ;tag=6322 +Call-ID: +Cseq: +Require: 100rel, precondition +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9021 +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote none +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs to be used for the session. The local preconditions are indicated as fulfilled. + +##### 13-14 183 (Session Progress) provisional response (CAT-AS to UE#1) + +The CAT-AS changes the response code to SIP 183 (Session Progress) response and forwards the SIP provisional response to UE#1. + +An early dialog (D2) is established between UE#1 and UE#2. + +##### 15-16 PRACK request (UE#1 to UE#2) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to UE#2. + +**SDP:** The local preconditions are indicated as fulfilled, and media are set to "sendrecv". + +##### 17-18 200 (OK) response to PRACK request (UE#2 to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 19-20 200 (OK) response to INVITE request (UE#2 to CAT-AS) + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +##### **21-22 200 (OK) response to INVITE request (CAT-AS to UE#1)** + +The CAT-AS forwards the SIP 200 (OK) response to UE#1. + +The CAT-AS instructs the MRF to stop CAT media. + +The early dialog (D1) between UE#1 and the CAT-AS is terminated. + +#### **23-24 ACK request (UE#1 to UE#2)** + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +### A.3.4 CAT when UE#1 has resources available while UE#2 does not have required resources available + +![Sequence diagram showing a SIP call flow between UE #1, S-CSCF, CAT-AS, and UE #2. The diagram illustrates an error scenario where UE #2 does not have required resources available. The sequence starts with UE #1 sending an INVITE (SDP_O) to S-CSCF, which is then forwarded to CAT-AS. CAT-AS attempts to reserve resources and then forwards the INVITE to UE #2. UE #2 responds with a 180 (Ringing) (SDP_A, D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 183 (Session Progress) (SDP_A, D2) to UE #1. UE #1 responds with a PRACK (D2), which is forwarded to CAT-AS and then to UE #2. UE #2 responds with a 200 (OK) (D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 183 (Session Progress) (SDP_A, D1) to UE #1. UE #1 responds with a PRACK (D1), which is forwarded to CAT-AS and then to UE #2. UE #2 responds with a 200 (OK) (D1), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 200 (OK) (D2) to CAT-AS. CAT-AS then sends a 'Start CA media' message to UE #2. UE #2 responds with a 200 (OK) (D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 'Stop CA media' message to UE #2. UE #2 responds with a 200 (OK) (D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends an ACK (D2) to UE #1. UE #1 responds with an ACK (D2), which is forwarded to CAT-AS and then to UE #2.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAT-AS as CAT-AS + participant UE2 as UE #2 + + Note left of UE1: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CA resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of UE2: Resources available + UE2->>CAT-AS: 5. 180 (Ringing) (SDP_A, D2) + CAT-AS->>S-CSCF: 6. 180 (Ringing) (SDP_A, D2) + S-CSCF->>UE1: 7. 183 (Session Progress) (SDP_A, D2) + UE1->>S-CSCF: 8. 183 (Session Progress) (SDP_A, D2) + S-CSCF->>UE1: 9. PRACK (D2) + S-CSCF->>CAT-AS: 10. PRACK (D2) + CAT-AS->>UE2: 11. 200 (OK) (D2) + UE2->>CAT-AS: 12. 200 (OK) (D2) + CAT-AS->>S-CSCF: 13. 183 (Session Progress) (SDP_A, D1) + S-CSCF->>UE1: 14. 183 (Session Progress) (SDP_A, D1) + UE1->>S-CSCF: 15. PRACK (D1) + S-CSCF->>CAT-AS: 16. PRACK (D1) + Note right of CAT-AS: Start CA media + CAT-AS->>UE2: 17. 200 (OK) (D1) + UE2->>CAT-AS: 18. 200 (OK) (D1) + CAT-AS->>S-CSCF: 19. 200 (OK) (D2) + S-CSCF->>CAT-AS: 20. 200 (OK) (D2) + Note right of CAT-AS: Stop CA media + CAT-AS->>UE2: 21. 200 (OK) (D2) + UE2->>CAT-AS: 22. 200 (OK) (D2) + CAT-AS->>S-CSCF: 23. ACK (D2) + S-CSCF->>UE1: 24. ACK (D2) + +``` + +Sequence diagram showing a SIP call flow between UE #1, S-CSCF, CAT-AS, and UE #2. The diagram illustrates an error scenario where UE #2 does not have required resources available. The sequence starts with UE #1 sending an INVITE (SDP\_O) to S-CSCF, which is then forwarded to CAT-AS. CAT-AS attempts to reserve resources and then forwards the INVITE to UE #2. UE #2 responds with a 180 (Ringing) (SDP\_A, D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 183 (Session Progress) (SDP\_A, D2) to UE #1. UE #1 responds with a PRACK (D2), which is forwarded to CAT-AS and then to UE #2. UE #2 responds with a 200 (OK) (D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 183 (Session Progress) (SDP\_A, D1) to UE #1. UE #1 responds with a PRACK (D1), which is forwarded to CAT-AS and then to UE #2. UE #2 responds with a 200 (OK) (D1), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 200 (OK) (D2) to CAT-AS. CAT-AS then sends a 'Start CA media' message to UE #2. UE #2 responds with a 200 (OK) (D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends a 'Stop CA media' message to UE #2. UE #2 responds with a 200 (OK) (D2), which is forwarded back to CAT-AS and then to S-CSCF. S-CSCF then sends an ACK (D2) to UE #1. UE #1 responds with an ACK (D2), which is forwarded to CAT-AS and then to UE #2. + +Figure A.3.4-1: CAT, UE#2 does not have required resources available + +1 INVITE request (UE#1 to CAT-AS) see example in table A.3.4-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.3.4-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: IEEE-802.11a +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact:; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Accept:application/sdp, application/3gpp-ims+xml +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::aaa:bbb:ccc:ddd +s=- +c=IN IP6 6666::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, gruu and the 199 provisional response. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the user at UE#1 for this session. The SDP contains an indication that the local preconditions are fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the SIP INVITE request to UE#2. + +#### 5-6 180 (Ringing) provisional response (UE#2 to CAT-AS) see example in table A.3.4-2 + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +**Table A.3.4-2: 180 (Ringing) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKKnashds7 +Record-Route: , , + , +From: +To: ;tag=6322 +Call-ID: +Cseq: +Require: 100rel, precondition +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9021 +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote none +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=content:g.3gpp.cat +``` + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs to be used for the session and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The local preconditions are indicated as fulfilled. + +##### 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) + +The CAT-AS changes the response code to 183 (Session Progress) response, and forwards the SIP provisional response to UE#1. + +An early dialog (D2) is established between UE#1 and UE#2. + +#### 9-10 PRACK request (UE#1 to UE#2) + +UE#1 sends a SIP PRACK request, which acknowledges the 183 (Session Progress) provisional response, to UE#2. + +##### 11-12 200 (OK) response to PRACK (UE#2 to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.3.3-3 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#2. + +An early dialog (D1) is established between UE#1 and the CAT-AS. + +NOTE: As an alternative, the CAT-AS can send the SIP 183 (Session Progress) provisional response when the initial SIP INVITE request is received from UE#1. + +**Table A.3.3-4: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.lpcscf1.visited1.net;branch=z9hG4bK240f34.1, + SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Recv-Info: infoDtmf +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::eee:fff:bbb:aaa +s= +c=IN IP6 6666::eee:fff:bbb:aaa +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**Recv-Info:** The CAT-AS indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs supported to be used for CAT. The SDP content is based on information received from the MRF. The SDP contains an indication that the local preconditions are fulfilled. + +##### 15-16 PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to start CAT media. + +##### 17-18 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### **19-20 200 (OK) response to INVITE request (UE#2 to CAT-AS)** + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +#### **21-22 200 (OK) response to INVITE request (CAT-AS to UE#1)** + +The CAT-AS forwards the SIP 200 (OK) response to UE#1. + +The early dialog (D1) between UE#1 and the CAT-AS is terminated. + +#### **23-24 ACK request (UE#1 to UE#2)** + +UE#1 sends a SIP ACK request, which acknowledges the 200 (OK) final response, to UE#2. + +## --- A.4 CAT early session model signalling flows + +### A.4.1 Introduction + +The following flows show establishment of a session between UE#1 and UE#2, using the early session model described in subclause 4.5.5.3.3 to provide CAT to UE#1. The following flows are included: + +- subclause A.4.2 shows CAT, using the early session model, when UE#1 and UE#2 have resources available; +- subclause A.4.3 shows CAT, using the early session model, when UE#1 does not have resources available; +- subclause A.4.4 shows CAT, using the early session model, when UE#2 does not have resources available; + +### A.4.2 CAT when UE#1 and UE#2 have resources available + +![Sequence diagram for CAT, no resource reservation. Lifelines: UE #1, S-CSCF, C-A-S, UE #2. The sequence shows an INVITE request from UE #1 to S-CSCF, which is then forwarded to C-A-S and then to UE #2. Responses include 180 (Ringing), 183 (Session Progress), 200 (OK) for PRACK and INVITE, and finally ACK messages. Internal actions include 'Resources available', 'Reserve CA resources', and 'Start/Stop CA media'.](8269648391c59363ea61243864a2adf7_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAS as C-A-S + participant UE2 as UE #2 + + Note left of UE1: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAS: 2. INVITE (SDP_O) + Note right of CAS: Reserve CA resources + Note right of UE2: Resources available + CAS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + UE2->>CAS: 5. 180 (Ringing) + CAS->>S-CSCF: 6. 180 (Ringing) + S-CSCF->>CAS: 7. 183 (Session Progress) (early SDP_O) + CAS->>UE1: 8. 183 (Session Progress) (early SDP_O) + UE1->>S-CSCF: 9. PRACK (early SDP_A) + S-CSCF->>CAS: 10. PRACK (early SDP_A) + Note right of CAS: Start CA media + CAS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE1: 12. 200 (OK) (PRACK) + CAS->>UE2: 13. 200 (OK) (SDP_A) + S-CSCF->>CAS: 14. 200 (OK) (SDP_A) + Note right of CAS: Stop CA media + CAS->>S-CSCF: 15. 200 (OK) (SDP_A) + S-CSCF->>UE1: 16. 200 (OK) (SDP_A) + UE1->>S-CSCF: 17. ACK + S-CSCF->>UE2: 18. ACK + +``` + +Sequence diagram for CAT, no resource reservation. Lifelines: UE #1, S-CSCF, C-A-S, UE #2. The sequence shows an INVITE request from UE #1 to S-CSCF, which is then forwarded to C-A-S and then to UE #2. Responses include 180 (Ringing), 183 (Session Progress), 200 (OK) for PRACK and INVITE, and finally ACK messages. Internal actions include 'Resources available', 'Reserve CA resources', and 'Start/Stop CA media'. + +Figure A.4.2-1: CAT, no resource reservation + +1 INVITE request (UE#1 to S-CSCF) see example in table A.4.2-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.4.2-1: INVITE request (UE#1 to S-CSCF)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Recv-Info: infoDtmf +Supported: precondition, 100rel, early-session +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, and early-session SDP. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. If preconditions are used, the local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +#### 5-6 Reliable 180 (Ringing) provisional response (UE#2 to CAT-AS) see example in table A.4.2-5 + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +**Table A.4.2-5: 180 (Ringing) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP pscsf2.visited2.net;branch=z9hG4bK472a32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.2, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: ;tag=2236 +Call-ID: +Cseq: +RSeq: 9022 +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Length: 0 + +``` + +##### **7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.4.2-7** + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. + +An early-session SDP is sent to the UE#1 via the 183 (Session Progress) provisional response. + +**Table A.4.2-7: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Require: precondition, 100rel, early-session +Recv-Info: dtmfInfo +RSeq: 9022 +Contact:;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Disposition: early-session +Content-Length: (...) + +v=0 +o=- 2987933616 2987933616 IN IP6 5555::eee:fff:aaa:bbb +s=- +c=IN IP6 5555::ccc:aaa:bbb:acc +t=0 0 +m=audio 3456 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=content:g.3gpp.cat + +``` + +**early SDP** The early-session SDP offer (early SDP\_O) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The early-session SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +**Recv-Info:** The CAT-AS indicates willingness to receive DTMF Info Packages in INFO requests. + +##### **9-10 PRACK request (UE#1 to CAT-AS) see example in table A.4.2-9** + +UE#1 sends a SIP PRACK request with a early-session SDP answer, which acknowledges the SIP 183 (Session Progress) provisional response, towards UE#2. + +The CAT-AS instructs the MRF to play CAT media. + +**Table A.4.2-9: PRACK request (UE#1 to CAT-AS)** + +``` + +PRACK sip:cat-as.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: +To: +Call-ID: +Cseq: 128 PRACK +Contact: +Content-Type: application/sdp +Content-Disposition: early-session +Content-Length: (...) + +v=0 +o= 2987933616 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3466 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**early SDP** The early-session SDP answer (early SDP\_A) contains a set of codecs supported by UE#1 to be used for CAT. The local preconditions are indicated as fulfilled. + +##### 11-12 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.4.2-13 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request towards UE#1. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.4.2-13: 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP answer (SDP\_A) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +#### 15-16 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS forwards the SIP 200 (OK) response to UE#1. + +A regular session is established between UE#1 and UE#2. + +The early session between UE#1 and the CAT-AS is terminated. + +#### 17 18 ACK request (UE#1 to UE#2) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +### A.4.3 CAT when UE#1 does not have required resources available while UE#2 has resources available + +![Sequence diagram for CAT, UE#1 does not have resources available. Lifelines: UE #1, S-CSCF, CA-AS, UE #2. The diagram shows a SIP session establishment process where UE #1 sends an INVITE to S-CSCF, which is then forwarded to CA-AS and UE #2. UE #2 responds with 'Resources available'. The process continues with 183 Session Progress, PRACK, 200 OK, UPDATE, and finally ACK messages. Internal actions like 'Reserve CA resources', 'Start CA media', and 'Stop CA media' are shown within the CA-AS lifeline.](a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CA-AS as CA-AS + participant UE2 as UE #2 + + Note right of UE2: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O1) + S-CSCF->>CA-AS: 2. INVITE (SDP_O1) + CA-AS-->>S-CSCF: 3. INVITE (SDP_O1) + S-CSCF->>UE2: 4. INVITE (SDP_O1) + UE2-->>S-CSCF: 5. 183 (Session Progress) (SDP_A1) + S-CSCF->>CA-AS: 6. 183 (Session Progress) (SDP_A1) + CA-AS-->>S-CSCF: 7. 183 (Session Progress) (SDP_A1, early SDP_O1) + S-CSCF-->>UE1: 8. 183 (Session Progress) (SDP_A1, early SDP_O1) + UE1->>S-CSCF: 9. PRACK (early SDP_A1) + S-CSCF->>CA-AS: 10. PRACK (early SDP_A1) + CA-AS-->>S-CSCF: 11. PRACK + S-CSCF->>UE2: 12. PRACK + Note left of UE1: Resources available + UE2-->>S-CSCF: 13. 200 (OK) + S-CSCF->>CA-AS: 14. 200 (OK) + CA-AS-->>S-CSCF: 15. 200 (OK) + S-CSCF-->>UE1: 16. 200 (OK) + UE1->>S-CSCF: 17. UPDATE (SDP_O2, early SDP_O2) + S-CSCF->>CA-AS: 18. UPDATE (SDP_O2, early SDP_O2) + Note right of CA-AS: Reserve CA resources + CA-AS-->>S-CSCF: 19. UPDATE (SDP_O2) + S-CSCF->>UE2: 20. UPDATE (SDP_O2) + UE2-->>S-CSCF: 21. 200 (OK) (SDP_A2) + S-CSCF->>CA-AS: 22. 200 (OK) (SDP_A2) + CA-AS-->>S-CSCF: 23. 200 (OK) (SDP_A2, early SDP_A2) + S-CSCF-->>UE1: 24. 200 (OK) (SDP_A2, early SDP_A2) + UE2-->>S-CSCF: 25. 180 (Ringing) + S-CSCF->>CA-AS: 26. 180 (Ringing) + Note right of CA-AS: Start CA media + UE2-->>S-CSCF: 27. 200 (OK) + S-CSCF->>CA-AS: 28. 200 (OK) + Note right of CA-AS: Stop CA media + CA-AS-->>S-CSCF: 29. 200 (OK) + S-CSCF-->>UE1: 30. 200 (OK) + UE1->>S-CSCF: 31. ACK + S-CSCF->>UE2: 32. ACK + +``` + +Sequence diagram for CAT, UE#1 does not have resources available. Lifelines: UE #1, S-CSCF, CA-AS, UE #2. The diagram shows a SIP session establishment process where UE #1 sends an INVITE to S-CSCF, which is then forwarded to CA-AS and UE #2. UE #2 responds with 'Resources available'. The process continues with 183 Session Progress, PRACK, 200 OK, UPDATE, and finally ACK messages. Internal actions like 'Reserve CA resources', 'Start CA media', and 'Stop CA media' are shown within the CA-AS lifeline. + +Figure A.4.3-1: CAT, UE#1 does not have resources available + +#### 1-2 INVITE request (UE#1 to CAT-AS) see example in table A.4.3-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.4.3-1: INVITE request (UE#1 to S-CSCF)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Recv-Info: infoDtmf +Supported: precondition, 100rel, early-session +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, and early-session SDP. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O1) contains a set of codecs supported by UE#1 and desired by the user at UE#1 for this session. The SDP contains an indication that the local preconditions are not fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the SIP INVITE request to UE#2. + +#### 5-6 183 (Session Progress) provisional response (UE#2 to CAT-AS) see example in table A.4.3-5 + +UE#2 sends a SIP 183 (Session Progress) provisional response for the INVITE request to the CAT-AS. + +**Table A.4.3-5: 183 (Session Progress) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: ;tag=6322 +Call-ID: +Cseq: +Require: 100rel, precondition +RSeq: 9021 +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat + +``` + +**SDP** The SDP answer (SDP\_A1) contains a set of codecs to be used for the session and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The local preconditions are indicated as fulfilled. + +#### 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.4.3-7 + +The CAT-AS forwards the SIP 183 (Session Progress) provisional response with early-session SDP for CAT to UE#1. + +**Table A.4.3-7: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Require: 100rel, precondition, early-session +RSeq: 9021 +Contact: +Content-Type: multipart/mixed; boundary="boundary1" +Content-Length: (...) + +--boundary1 +Content-Type: application/sdp +Content-Disposition: session + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +--boundary1 +Content-Type: application/sdp +Content-Disposition: early-session + +v=0 +o= 2987933616 2987933616 IN IP6 5555::ccc:aaa:bbb:acc +s= +c=IN IP6 5555::ccc:aaa:bbb:acc +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 + +--boundary1 + +``` + +**early SDP** The early-session SDP offer (early SDP\_O1) contains a set of codecs to be used for CAT. The preconditions are indicated as not fulfilled. + +**9-10 PRACK request (UE#1 to CAT-AS)** see example in table A.4.3-9 + +UE#1 sends a SIP PRACK request with early-session SDP answer, which acknowledges the 183 (Session Progress) provisional response, towards UE#2. + +**Table A.4.3-9: PRACK request (UE#1 to CAT-AS)** + +``` +PRACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: +To: +Call-ID: +Cseq: 128 PRACK +Contact: +Content-Type: application/sdp +Content-Disposition: early-session +Content-Length: (...) + +v=0 +o= 2987933616 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3500 RTP/AVP 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +m=audio 3556 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +``` + +**early SDP** The early-session SDP answer (early SDP\_A1) contains a set of codecs supported by UE#1 to be used for CAT. The preconditions are indicated as not fulfilled. + +#### 11-12 PRACK request (CAT-AS to UE#2) see example in table A.4.3-11 + +CAT-AS forwards the SIP PRACK request without early-session SDP answer to UE#2. + +**Table A.4.3-11: PRACK request (CAT-AS to UE#2)** + +``` +PRACK sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP catas.home2.net;branch=z9hG4bK614Q63.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK464z73.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK351b51.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK582f12.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +Max-Forwards: 66 +Privacy: +From: +To: +Call-ID: +Cseq: 128 PRACK +Contact: +Content-Length: 0 +``` + +#### 13-16 200 (OK) response to PRACK request (UE#2 to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +#### 17-18 UPDATE request (UE#1 to CAT-AS) see example in table A.4.3-17 + +UE#1 reserved resources for regular session and early session, it sends an SIP UPDATE request with session SDP offer and early-session SDP offer towards UE#2. + +**Table A.4.3-17: UPDATE request (UE#1 to CAT-AS)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: +To: +Call-ID: +Cseq: 129 UPDATE +Contact: +Content-Type: multipart/mixed; boundary="boundary1" +Content-Length: (...) + +--boundary1 +Content-Type: application/sdp +Content-Disposition: session + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +--boundary1 +Content-Type: application/sdp +Content-Disposition: early-session + +v=0 +o= 2987933616 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3500 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3556 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +--boundary1 + +``` + +- SDP** The offer (SDP\_O2) contains a set of codecs supported by UE#1 and desired by the user at UE#1 for this session. The SDP contains an indication that the preconditions are fulfilled. +- early SDP** The early-session SDP offer (early SDP\_O2) contains a set of codecs supported by UE#1 to be used for CAT. The local preconditions are indicated as fulfilled. + +##### **19-20 UPDATE request (CAT-AS to UE#2) see example in table A.4.3-19** + +CAT-AS forwards the SIP UPDATE request towards UE#2 without early-session SDP. + +The CAT-AS instructs the MRF to reserve CAT resources. + +**Table A.4.3-19: UPDATE request (CAT-AS to UE#2)** + +``` +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP catas.home2.net;branch=z9hG4bK164Q63.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK442z73.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK514b51.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK812f12.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +Max-Forwards: 66 +Privacy: +From: +To: +Call-ID: +Cseq: 129 UPDATE +Contact: +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +#### **21-22 200 (OK) response to UPDATE request (UE#2 to CAT-AS) see example in table A.4.3-21** + +UE#2 sends a SIP 200 (OK) for the SIP UPDATE request to the CAT-AS. + +**Table A.4.3-21: 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK611k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764KS12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK164Q63.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK442z73.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK514b51.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK812f12.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +From: +To: +Call-ID: +Cseq: +Contact: +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP answer (SDP\_A2) contains a set of codecs to be used for the session. The preconditions are indicated as fulfilled. + +##### **23-24 200 (OK) response to UPDATE request (CAT-AS to UE#1) see example in table A.4.3-23** + +CAT-AS forwards the SIP 200 (OK) for the SIP UPDATE request to UE#1. + +**Table A.4.3-23: 200 (OK) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP catas.home2.net;branch=z9hG4bK164Q63.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK442z73.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK514b51.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK812f12.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +From: +To: +Call-ID: +Cseq: +Contact: +Content-Type: multipart/mixed; boundary="boundary1" +Content-Length: (...) + +--boundary1 +Content-Type: application/sdp +Content-Disposition: session + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +--boundary1 +Content-Type: application/sdp +Content-Disposition: early-session + +v=0 +o= 2987933616 2987933616 IN IP6 5555::ccc:aaa:bbb:acc +s= +c=IN IP6 5555::ccc:aaa:bbb:acc +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +--boundary1 + +``` + +##### **early SDP** + +The early-session SDP answer (early SDP\_A2) contains a set of codecs supported by UE#1 to be used for CAT. The early-session SDP content is based on information received from the MRF. The preconditions are indicated as fulfilled. + +##### **25-26 180 (Ringing) response to INVITE request (UE#2 to CAT-AS)** + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request towards UE#1. + +The CAT-AS terminates the provisional response. + +The CAT-AS instructs the MRF to play CAT media. + +#### **27-28 200 (OK) response to INVITE request (UE#2 to CAT-AS)** + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request towards UE#1. + +The CAT-AS instructs the MRF to stop CAT media. + +#### **29-30 200 (OK) response to INVITE request (CAT-AS to UE#1)** + +The CAT-AS forwards the SIP 200 (OK) response to UE#1. + +A regular session is established between UE#1 and UE#2. + +The early session between UE#1 and the CAT-AS is terminated. + +#### **31-32 ACK request (UE#1 to UE#2)** + +UE#1 sends a SIP ACK request, which acknowledges the 200 (OK) final response, to UE#2. + +### A.4.4 CAT when UE#1 has resources available while UE#2 does not have required resources available + +![Sequence diagram showing a SIP call flow between UE #1, S-CSCF, C-A-S, and UE #2. The diagram illustrates an error scenario where UE #2 does not have resources available. The flow starts with an INVITE from UE #1 to S-CSCF, which is then forwarded to C-A-S and then to UE #2. UE #2 responds with a 183 Session Progress. C-A-S then sends a 183 to S-CSCF, which in turn sends it to UE #1. The diagram continues with PRACK and 200 OK messages, and finally a STOP C-A media message from C-A-S to S-CSCF.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAS as C-A-S + participant UE2 as UE #2 + + Note left of UE1: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O1) + S-CSCF->>CAS: 2. INVITE (SDP_O1) + CAS->>S-CSCF: 3. INVITE (SDP_O1) + S-CSCF->>UE2: 4. INVITE (SDP_O1) + Note right of UE2: Resources available + UE2->>CAS: 5. 183 (Session Progress) (SDP_A1) + CAS->>S-CSCF: 6. 183 (Session Progress) (SDP_A1) + Note right of CAS: Reserve C-A resources + CAS->>S-CSCF: 7. 183 (Session Progress) (SDP_A1, early SDP_O1) + S-CSCF->>UE1: 8. 183 (Session Progress) (SDP_A1, early SDP_O1) + UE1->>S-CSCF: 9. PRACK (early SDP_A1) + S-CSCF->>CAS: 10. PRACK (early SDP_A1) + CAS->>S-CSCF: 11. PRACK + S-CSCF->>UE2: 12. PRACK + CAS->>S-CSCF: 13. 200 (OK) + S-CSCF->>CAS: 14. 200 (OK) + S-CSCF->>UE1: 16. 200 (OK) + CAS->>S-CSCF: 17. 180 (Ringing) + S-CSCF->>CAS: 18. 180 (Ringing) + Note right of CAS: Start C-A media + CAS->>S-CSCF: 19. 200 (OK) + S-CSCF->>CAS: 20. 200 (OK) + Note right of CAS: Stop C-A media + CAS->>S-CSCF: 21. 200 (OK) + S-CSCF->>UE1: 22. 200 (OK) + UE1->>S-CSCF: 23. ACK + S-CSCF->>UE2: 24. ACK + +``` + +Sequence diagram showing a SIP call flow between UE #1, S-CSCF, C-A-S, and UE #2. The diagram illustrates an error scenario where UE #2 does not have resources available. The flow starts with an INVITE from UE #1 to S-CSCF, which is then forwarded to C-A-S and then to UE #2. UE #2 responds with a 183 Session Progress. C-A-S then sends a 183 to S-CSCF, which in turn sends it to UE #1. The diagram continues with PRACK and 200 OK messages, and finally a STOP C-A media message from C-A-S to S-CSCF. + +Figure A.4.4-1: CAT, UE#2 does not have resources available + +#### 1-2 INVITE request (UE#1 to CAT-AS) see example in table A.4.4-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.4.4-1: INVITE request (UE#1 to S-CSCF)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Recv-Info: infoDtmf +Supported: precondition, 100rel, early-session +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: >; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, and early-session SDP. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O1) contains a set of codecs supported by UE#1 and desired by the user at UE#1 for this session. The SDP contains an indication that the local preconditions are fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the SIP INVITE request to UE#2. + +#### 5-6 183 (Session Progress) provisional response (UE#2 to CAT-AS) see example in table A.4.4-5 + +UE#2 sends a SIP 183 (Session Progress) provisional response for the INVITE request to the CAT-AS. + +**Table A.4.4-5: 183 (Session Progress) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pcscf2.visited2.net;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: ;tag=6322 +Call-ID: +Cseq: +Require: 100rel, precondition +RSeq: 9021 +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Disposition: session +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat + +``` + +**SDP** The SDP answer (SDP\_A1) contains a set of codecs to be used for the session and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The preconditions are indicated as fulfilled. + +#### 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.4.4-7 + +The CAT-AS forwards the SIP 183 (Session Progress) provisional response with early-session SDP for CAT to UE#1. + +**Table A.4.4-7: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Require: 100rel, precondition, early-session +RSeq: 9021 +Contact: +Content-Type: multipart/mixed; boundary="boundary1" +Content-Length: (...) + +--boundary1 +Content-Type: application/sdp +Content-Disposition: session + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +--boundary1 +Content-Type: application/sdp +Content-Disposition: early-session + +v=0 +o= 2987933616 2987933616 IN IP6 5555::ccc:aaa:bbb:acc +s= +c=IN IP6 5555::ccc:aaa:bbb:acc +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 + +--boundary1 + +``` + +**early SDP** The early-session SDP offer (early SDP\_O1) contains a set of codecs to be used for CAT. The local preconditions are indicated as fulfilled. + +**9-10 PRACK request (UE#1 to CAT-AS) see example in table A.4.4-9** + +UE#1 sends a SIP PRACK request with early-session SDP answer, which acknowledges the 183 (Session Progress) provisional response, towards UE#2. + +**Table A.4.4-9: PRACK request (UE#1 to CAT-AS)** + +``` + +PRACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: +To: +Call-ID: +Cseq: 128 PRACK +Contact: +Content-Type: application/sdp +Content-Disposition: early-session +Content-Length: (...) + +v=0 +o=- 2987933616 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3500 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +m=audio 3556 RTP/AVP 97 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**early SDP**       The early-session SDP answer (early SDP\_A1) contains a set of codecs supported by UE#1 to be used for CAT. The preconditions are indicated as fulfilled. + +#### 11-12 PRACK request (CAT-AS to UE#2) see example in table A.4.4-11 + +CAT-AS forwards the SIP PRACK request without early-session SDP answer to UE#2. + +**Table A.4.4-11: PRACK request (CAT-AS to UE#2)** + +``` + +PRACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP catas.home2.net;branch=z9hG4bK614Q63.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK464z73.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK351b51.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK582f12.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKna234s7 +Max-Forwards: 66 +Privacy: +From: +To: +Call-ID: +Cseq: 128 PRACK +Contact: +Content-Length: 0 + +``` + +#### 13-16 200 (OK) response to PRACK request (UE#2 to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +#### 17-18 180 (Ringing) response to INVITE request (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request towards UE#1. + +The CAT-AS terminates the provisional response. + +The CAT-AS instructs the MRF to play CAT media. + +#### **19-20 200 (OK) response to INVITE request (UE#2 to CAT-AS)** + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request towards UE#1. + +The CAT-AS instructs the MRF to stop CAT media. + +#### **21-22 200 (OK) response to INVITE request (CAT-AS to UE#1)** + +The CAT-AS forwards the SIP 200 (OK) response to UE#1. + +A regular session is established between UE#1 and UE#2. + +The early session between UE#1 and the CAT-AS is terminated. + +#### **23-24 ACK request (UE#1 to UE#2)** + +UE#1 sends a SIP ACK request, which acknowledges the 200 (OK) final response, to UE#2. + +## --- **A.5 CAT Gateway model signalling flows** + +### **A.5.1 Introduction** + +The following flows show establishment of a session between UE#1 and UE#2, using the gateway model as defined in RFC 3960 [8] to provide CAT to UE#1. The following flows are included: + +- subclause A.5.2 shows CAT, using the gateway model, when UE#1 and UE#2 have resources available; +- subclause A.5.2A shows gateway model CAT using reINVITE request, when UE#1 and UE#2 have resources available; +- subclause A.5.3 shows CAT, using the gateway model, when UE#1 does not have resources available; +- subclause A.5.3A shows gateway model CAT using reINVITE request, when UE#1 does not have resources available; +- subclause A.5.4 shows CAT, using the gateway model, when UE#2 does not have resources available; +- subclause A.5.4A shows gateway model CAT using reINVITE request, when UE#2 does not have resources available; +- subclause A.5.7 shows CAT, using the gateway model, when both UE#1 and UE#2 do not have resources available +- subclause A.5.8 shows CAT with different media types during one session, using gateway model, when both UE#1 and UE#2 do not have resources available + +NOTE: Flows in subclauses A.5.2A, A.5.3A and A.5.4A shall apply when the originating UE will release or change the ports used from the original SDP offer during a session. + +The following flows show establishment of a session between UE#1, UE#2 and UE#3, among which the UE#3 is the diverted UE for UE#2, using the gateway model as defined in RFC 3960 [8] to provide CAT to UE#1. The following flows are included: + +- subclause A.5.5 shows CAT signalling flow for a successful communication forwarding on no reply using the gateway model with reINVITE request, when UE#1 , UE#2 and UE#3 have resources available; + +### A.5.2 CAT when UE#1 and UE#2 have resources available + +![Sequence diagram for CAT (Call Admission Control) when UE#1 and UE#2 have resources available. The diagram shows the interaction between UE#1, S-CSCF, CAT-AS, and UE#2. The process involves INVITE, 180 (Ringing), PRACK, 200 (OK), UPDATE, and ACK messages, with internal steps for resource reservation and media start/stop.](1f1614411edea7edfc86c839a608e1fc_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAT-AS as CAT-AS + participant UE2 as UE #2 + + Note left of UE1: Resources available + Note right of UE2: Resources available + + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CA resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of UE2: Alert called party + CAT-AS->>S-CSCF: 5. 180 (Ringing) + S-CSCF->>CAT-AS: 6. 180 (Ringing) + CAT-AS->>S-CSCF: 7. 180 (Ringing) (SDP_A_cat) + S-CSCF->>UE1: 8. 180 (Ringing) (SDP_A_cat) + UE1->>S-CSCF: 9. PRACK + S-CSCF->>CAT-AS: 10. PRACK + Note right of CAT-AS: Start CA media + CAT-AS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE1: 12. 200 (OK) (PRACK) + Note right of UE2: Called party answers the call + CAT-AS->>S-CSCF: 13. 200 (OK) (SDP_A_regular) + S-CSCF->>CAT-AS: 14. 200 (OK) (SDP_A_regular) + Note right of CAT-AS: Stop CA media + CAT-AS->>S-CSCF: 15. UPDATE (SDP_A_regular) + S-CSCF->>UE1: 16. UPDATE (SDP_A_regular) + UE1->>S-CSCF: 17. 200 (OK) (UPDATE) (SDP_O2) + S-CSCF->>CAT-AS: 18. 200 (OK) (UPDATE) (SDP_O2) + CAT-AS->>S-CSCF: 19. 200 (OK) (INVITE) + S-CSCF->>UE1: 20. 200 (OK) (INVITE) + UE1->>S-CSCF: 21. ACK + S-CSCF->>CAT-AS: 22. ACK + CAT-AS->>S-CSCF: 23. ACK + S-CSCF->>UE2: 24. ACK + +``` + +Sequence diagram for CAT (Call Admission Control) when UE#1 and UE#2 have resources available. The diagram shows the interaction between UE#1, S-CSCF, CAT-AS, and UE#2. The process involves INVITE, 180 (Ringing), PRACK, 200 (OK), UPDATE, and ACK messages, with internal steps for resource reservation and media start/stop. + +Figure A.5.1-1: CAT, no resource reservation + +- 1 INVITE request (UE#1 to CAT-AS) see example in table A.5.2-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.5.2-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. **SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +#### 5-6 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +#### 7-8 180 (Ringing) provisional response (CAT-AS to UE#1) see example in table A.5.2-2 + +The CAT-AS sends a reliable SIP 180 (Ringing) provisional response to UE#1. + +**Table A.5.2-2: 180 (Ringing) response (CAT-AS to UE#1)** + +``` +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 340051372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### 9-10 PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +##### 11-12 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.5.2-3 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.5.2-3: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +#### 15-16 UPDATE request (CAT-AS to UE#1) see example in table A.5.2-4 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) response from UE#2. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +**Table A.5.2-4: UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336278 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. The local preconditions are indicated as fulfilled. + +##### 17-18 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. UE#1 includes a SDP answer (SDP\_O2) in the 200 (OK) response to the corresponding SIP UPDATE request. + +##### 19-20 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +#### 21-22 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +#### 23-24 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +NOTE 2: The ACK request from CAT-AS towards UE#2 may be sent after receiving 200 (OK) response from UE#2 in step 14. + +### A.5.2A CAT using reINVITE request when UE#1 and UE#2 have resources available + +![Sequence diagram for A.5.2A CAT using reINVITE request. Lifelines: UE#1, S-CSCF, C-A-S, UE#2. The diagram shows the interaction for establishing a call with resource reservation and subsequent media start/stop.](331afcb1534110b4c4f6ddf553a0f7e0_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE#1 + participant S-CSCF as S-CSCF + participant CAS as C-A-S + participant UE2 as UE#2 + + Note left of UE1: Resources available + Note right of UE2: Resources available + + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAS: 2. INVITE (SDP_O) + Note right of CAS: Reserve CA resources + CAS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of UE2: Alert called party + CAS->>S-CSCF: 5. 180 (Ringing) + S-CSCF->>CAS: 6. 180 (Ringing) + CAS->>S-CSCF: 7. 180 (Ringing) (SDP_A_cat) + S-CSCF->>UE1: 8. 180 (Ringing) (SDP_A_cat) + UE1->>S-CSCF: 9. PRACK + S-CSCF->>CAS: 10. PRACK + Note right of CAS: Start CA media + CAS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE1: 12. 200 (OK) (PRACK) + Note right of UE2: Called party answers the call + CAS->>S-CSCF: 13. 200 (OK) (SDP_A_regular) + S-CSCF->>CAS: 14. 200 (OK) (SDP_A_regular) + Note right of CAS: Stop CA media + CAS->>S-CSCF: 15. ACK + S-CSCF->>UE2: 16. ACK + CAS->>S-CSCF: 17. reINVITE + S-CSCF->>UE2: 18. reINVITE + CAS->>S-CSCF: 19. 200 (OK) (reINVITE) (SDP_O_UE2_regular) + S-CSCF->>CAS: 20. 200 (OK) (reINVITE) (SDP_O_UE2_regular) + CAS->>S-CSCF: 21. UPDATE (SDP_O_UE2_regular) + S-CSCF->>UE1: 22. UPDATE (SDP_O_UE2_regular) + UE1->>S-CSCF: 23. 200 (OK) (UPDATE) (SDP_A_UE1_regular) + S-CSCF->>CAS: 24. 200 (OK) (UPDATE) (SDP_A_UE1_regular) + CAS->>S-CSCF: 25. 200 (OK) (INVITE) + S-CSCF->>UE1: 26. 200 (OK) (INVITE) + UE1->>S-CSCF: 27. ACK + S-CSCF->>CAS: 28. ACK + CAS->>S-CSCF: 29. ACK (SDP_A_UE1_regular) + S-CSCF->>UE2: 30. ACK (SDP_A_UE1_regular) + +``` + +Sequence diagram for A.5.2A CAT using reINVITE request. Lifelines: UE#1, S-CSCF, C-A-S, UE#2. The diagram shows the interaction for establishing a call with resource reservation and subsequent media start/stop. + +Figure A.5.2A-1: CAT, no resource reservation + +#### 1 INVITE request (UE#1 to CAT-AS) see example in table A.5.2A-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +Table A.5.2A-1: INVITE request (UE#1 to CAT-AS) + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +#### 5-6 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +##### 7-8 180 (Ringing) provisional response (CAT-AS to UE#1) see example in table A.5.2A-2 + +The CAT-AS sends a reliable SIP 180 (Ringing) provisional response to UE#1. + +**Table A.5.2A-2: 180 (Ringing) response (CAT-AS to UE#1)** + +``` +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 340051372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media + +description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### 9-10 PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +##### 11-12 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.5.2A-3 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.5.2A-3: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +##### SDP + +The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +##### 15-16 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +#### 17-18 re INVITE request (CAT-AS to UE#2) + +The CAT-AS sends a SIP reINVITE request without SDP to UE#2. + +##### 19-20 200 (OK) response to reINVITE request (UE#2 to CAT-AS) see example in table A.5.2A-4 + +UE#2 sends a SIP 200 (OK) response for the SIP reINVITE request (step 18) with SDP\_O\_UE2\_regular to the CAT-AS. + +**Table A.5.2A-4: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: ;comp=sigcomp>, , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74>; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP offer (SDP\_O\_UE2\_regular) contains a set of codecs supported by UE#2 and desired by the called user for this session. The local preconditions are indicated as fulfilled. + +##### 21-22 UPDATE request (CAT-AS to UE#1) see example in table A.5.2A-5 + +The CAT-AS sends an UPDATE request containing values received in the 200 OK from UE#2 (step 20). + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +**Table A.5.2A-5: UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336278 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_UE2\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response (step 20). The local preconditions are indicated as fulfilled. + +##### 23-24 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. UE#1 includes a SDP answer (SDP\_A\_UE1\_regular) in the 200 (OK) response to the corresponding SIP UPDATE request. + +##### 25-26 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +#### 27-28 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +#### 29-30 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response (step 19), with SDP answer (SDP\_A\_UE1\_regular) to UE#2. + +### A.5.3 CAT when UE#1 does not have required resources available while UE#2 has resources available + +Figure A.5.3-1 shows an example call flow for CAT when UE#1 does not have required resources available and UE#2 have resources available. + +![Sequence diagram showing a SIP call flow between UE #1, S-CSCF, CAT-AS, and UE #2. The diagram illustrates a scenario where UE #1 does not have required resources available, leading to a series of SIP messages including INVITE, 183 Session Progress, PRACK, UPDATE, 200 OK, 180 Ringing, and ACK. Key events include 'Resources available' at UE #1 and UE #2, 'Reserve CA resources' at CAT-AS, 'Start CA media' at CAT-AS, and 'Called party answers the call' at UE #2.](2a476a0b3dbc3429436246db4784ff9f_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAT-AS as CAT-AS + participant UE2 as UE #2 + + Note right of UE2: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CA resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + S-CSCF->>CAT-AS: 5. 183 (Session Progress) (SDP_A_regular) + CAT-AS->>S-CSCF: 6. 183 (Session Progress) (SDP_A_regular) + S-CSCF->>UE1: 8. 183 (Session Progress) (SDP_A_cat) + UE1->>S-CSCF: 9. PRACK + S-CSCF->>CAT-AS: 10. PRACK + CAT-AS->>S-CSCF: 11. PRACK + S-CSCF->>UE2: 12. PRACK + UE2->>S-CSCF: 13. 200 (OK) (PRACK) + S-CSCF->>CAT-AS: 14. 200 (OK) (PRACK) + CAT-AS->>S-CSCF: 15. 200 (OK) (PRACK) + S-CSCF->>UE1: 16. 200 (OK) (PRACK) + Note left of UE1: Resources available + UE1->>S-CSCF: 17. UPDATE (SDP_O_cat) + S-CSCF->>CAT-AS: 18. UPDATE (SDP_O_cat) + CAT-AS->>S-CSCF: 19. UPDATE (SDP_O_regular) + S-CSCF->>UE2: 20. UPDATE (SDP_O_regular) + Note right of UE2: Alert called party + UE2->>S-CSCF: 21. 200 (OK) (UPDATE) (SDP_A_regular) + S-CSCF->>CAT-AS: 22. 200 (OK) (UPDATE) (SDP_A_regular) + CAT-AS->>S-CSCF: 23. 200 (OK) (UPDATE) (SDP_A_cat) + S-CSCF->>UE1: 24. 200 (OK) (UPDATE) (SDP_A_cat) + S-CSCF->>UE2: 25. 180 (Ringing) + Note right of CAT-AS: Start CA media + CAT-AS->>S-CSCF: 27. 180 (Ringing) + S-CSCF->>UE1: 28. 180 (Ringing) + Note right of UE2: Called party answers the call + UE2->>S-CSCF: 29. 200 (OK) + S-CSCF->>CAT-AS: 30. 200 (OK) + Note right of CAT-AS: Stop CA media + CAT-AS->>S-CSCF: 31. UPDATE (SDP_A_regular) + S-CSCF->>UE1: 32. UPDATE (SDP_A_regular) + UE1->>S-CSCF: 33. 200 (OK) (UPDATE) (SDP_O2) + S-CSCF->>CAT-AS: 34. 200 (OK) (UPDATE) (SDP_O2) + CAT-AS->>S-CSCF: 35. 200 (OK) (INVITE) + S-CSCF->>UE1: 36. 200 (OK) (INVITE) + UE1->>S-CSCF: 37. ACK + S-CSCF->>CAT-AS: 38. ACK + CAT-AS->>S-CSCF: 39. ACK + S-CSCF->>UE2: 40. ACK + +``` + +Sequence diagram showing a SIP call flow between UE #1, S-CSCF, CAT-AS, and UE #2. The diagram illustrates a scenario where UE #1 does not have required resources available, leading to a series of SIP messages including INVITE, 183 Session Progress, PRACK, UPDATE, 200 OK, 180 Ringing, and ACK. Key events include 'Resources available' at UE #1 and UE #2, 'Reserve CA resources' at CAT-AS, 'Start CA media' at CAT-AS, and 'Called party answers the call' at UE #2. + +Figure A.5.3-1: CAT, UE#1 does not have required resources available + +#### 1 INVITE request (UE#1 to CAT-AS) see example in table A.5.3-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.5.3-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as not fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +##### 5-6 183 (Session Progress) provisional response (UE#2 to CAT-AS) see example in table A.5.3-2 + +UE#2 sends a reliable SIP 183 (Session Progress) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +**Table A.5.3-2: 183 (Session Progress) provisional response (UE#2 to CAT-AS)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +RSeq: 9022 +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The local preconditions are indicated as not fulfilled. + +##### 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.5.3-3 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. The CAT-AS shall take into account, when creating the SDP message, the media indicated by UE#2 in the previously received 183 (Session Progress) provisional response and the one used by MRF for the media for CAT. + +**Table A.5.3-3: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +``` + +``` + +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF and information in the previously received 183 (Session Progress) provisional response from UE#2. The local preconditions are indicated as not fulfilled. + +##### 9-12 PRACK request (UE#1 to CAT-AS, and to UE#2) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS, which is further sent to UE#2. + +##### 13-16 200 (OK) response to PRACK request (UE#2 to CAT-AS, and to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to CAT-AS, which is further sent to UE#1. + +##### 17-18 UPDATE request (UE#1 to CAT-AS) - see example in table A.5.3-4 + +UE#1 indicates that it can send and receive media as the necessary resources are available. + +**Table A.5.3-4: UPDATE request (UE#1 to CAT-AS)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , , +From: ;tag=171828 +To: ;tag=2236 + +``` + +``` + +Call-ID: +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +##### **SDP** + +The SDP offer (SDP\_O\_cat) contains a set of codecs supported to be used for CAT. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### **19-20 UPDATE request (CAT-AS to UE#2) - see example in table A.5.3-5** + +CAT-AS indicates to UE#2 that UE#1 can send and receive media as the necessary resources are available. + +**Table A.5.3-5: UPDATE request (CAT-AS to UE#2)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- +ad76cc7fc74;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +Route: +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 56101 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933616 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv + +``` + +``` + +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP**                 The SDP offer (SDP\_O\_regular) contains a set of codecs supported to be used for regular conversation. The local preconditions are indicated as fulfilled. + +##### 21-22 200 (OK) response (UE#2 to CAT-AS) - see example in table A.5.3-6 + +UE#2 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. The SDP shall contain information relevant to the media that will be used after the session is established. + +CAT-AS shall store the relevant information in SDP for later use in step 31. + +**Table A.5.3-6: 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74>; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP**                 The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The local preconditions are indicated as fulfilled. + +##### 23-24 200 (OK) response (CAT-AS to UE#1) - see example in table A.5.3-7 + +CAT-AS sends a SIP 200 (OK) response for the SIP UPDATE request to UE#1. The SDP shall contain information relevant to the media for CAT used by the MRF. + +**Table A.5.3-7: 200 (OK) response (CAT-AS to UE#1)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336157 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs to be used for CAT. The local preconditions are indicated as fulfilled. + +##### 25-26 180 (Ringing) provisional response (UE#2 to CAT-AS) + +UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media upon receipt of 180. + +##### 27-28 180 (Ringing) provisional response (CAT-AS to UE#1) + +CAT-AS sends a SIP 180 (Ringing) provisional response for the INVITE request to the UE#1. + +##### 29-30 200 (OK) response to INVITE request (UE#2 to CAT-AS) + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +##### 31-32 UPDATE request (CAT-AS to UE#1) see example in table A.5.3-8 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) for UPDATE request from UE#2 in step 22. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +NOTE 1: The AS will remain in the signalling path, i.e. work as a B2BUA, in order to align and maintain information in SDP for further exchanged messages between UE#1 and UE#2. + +**Table A.5.3-8: UPDATE request (CAT-AS to UE#1)** + +``` +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336156 29879336158 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP offer (SDP\_A\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. + +##### 33-34 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to sending the response. UE#1 includes a SDP answer (SDP\_O2) in the 200 (OK) response to the corresponding SIP UPDATE request. + +##### 35-36 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +##### 37-38 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +#### 39-40 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +NOTE 3: The ACK request from CAT-AS towards UE#2 may be sent after receiving 200 (OK) from UE#2 in step 18. + +### A.5.3A CAT using reINVITE request when UE#1 does not have required resources available while UE#2 has resources available + +Figure A.5.3A-1 shows an example call flow for CAT when UE#1 does not have required resources available and UE#2 have resources available. + +![Sequence diagram showing a call setup between UE #1, S-CSCF, CA-AS, and UE #2. The diagram illustrates a scenario where UE #1 does not have required resources available, leading to a series of SIP messages including INVITE, PRACK, UPDATE, and ACK. Key events include 'Resources available' at UE #1 and UE #2, 'Reserve CA resources' at CA-AS, 'Alert called party' at UE #2, and 'Called party answers the call' at UE #2. The sequence ends with ACK messages from UE #1 and UE #2.](4806f9f95fff13a30d6523bd6ffeac63_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CA-AS as CA-AS + participant UE2 as UE #2 + + Note right of UE2: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CA-AS: 2. INVITE (SDP_O) + Note right of CA-AS: Reserve CA resources + CA-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + S-CSCF->>UE1: 5. 183 (Session Progress) (SDP_A_regular) + CA-AS->>S-CSCF: 6. 183 (Session Progress) (SDP_A_regular) + S-CSCF->>UE1: 7. 183 (Session Progress) (SDP_A_cat) + UE1->>S-CSCF: 8. 183 (Session Progress) (SDP_A_cat) + UE1->>S-CSCF: 9. PRACK + S-CSCF->>CA-AS: 10. PRACK + CA-AS->>S-CSCF: 11. PRACK + S-CSCF->>UE2: 12. PRACK + S-CSCF->>UE1: 13. 200 (OK) (PRACK) + CA-AS->>S-CSCF: 14. 200 (OK) (PRACK) + S-CSCF->>UE1: 15. 200 (OK) (PRACK) + UE1->>S-CSCF: 16. 200 (OK) (PRACK) + Note left of UE1: Resources available + UE1->>S-CSCF: 17. UPDATE (SDP_O_cat) + S-CSCF->>CA-AS: 18. UPDATE (SDP_O_cat) + CA-AS->>S-CSCF: 19. UPDATE (SDP_O_regular) + S-CSCF->>UE2: 20. UPDATE (SDP_O_regular) + Note right of UE2: Alert called party + S-CSCF->>UE1: 21. 200 (OK) (UPDATE) (SDP_A_regular) + CA-AS->>S-CSCF: 22. 200 (OK) (UPDATE) (SDP_A_regular) + S-CSCF->>UE1: 23. 200 (OK) (UPDATE) (SDP_A_cat) + UE1->>S-CSCF: 24. 200 (OK) (UPDATE) (SDP_A_cat) + S-CSCF->>UE2: 25. 180 (Ringing) + CA-AS->>S-CSCF: 26. 180 (Ringing) + Note right of CA-AS: Start CA media + S-CSCF->>UE1: 27. 180 (Ringing) + UE1->>S-CSCF: 28. 180 (Ringing) + Note right of UE2: Called party answers the call + S-CSCF->>UE2: 29. 200 (OK) + CA-AS->>S-CSCF: 30. 200 (OK) + Note right of CA-AS: Stop CA media + S-CSCF->>UE1: 31. ACK + S-CSCF->>UE2: 32. ACK + S-CSCF->>CA-AS: 33. reINVITE + S-CSCF->>UE2: 34. reINVITE + S-CSCF->>UE1: 35. 200 (OK) (reINVITE) (SDP_O_UE2_regular) + CA-AS->>S-CSCF: 36. 200 (OK) (reINVITE) (SDP_O_UE2_regular) + S-CSCF->>UE1: 37. UPDATE (SDP_O_UE2_regular) + UE1->>S-CSCF: 38. UPDATE (SDP_O_UE2_regular) + UE1->>S-CSCF: 39. 200 (OK) (UPDATE) (SDP_A_UE1_regular) + CA-AS->>S-CSCF: 40. 200 (OK) (UPDATE) (SDP_A_UE1_regular) + UE1->>S-CSCF: 41. 200 (OK) (INVITE) + S-CSCF->>UE1: 42. 200 (OK) (INVITE) + UE1->>S-CSCF: 43. ACK + S-CSCF->>CA-AS: 44. ACK + CA-AS->>S-CSCF: 45. ACK (SDP_A_UE1_regular) + S-CSCF->>UE2: 46. ACK (SDP_A_UE1_regular) + +``` + +Sequence diagram showing a call setup between UE #1, S-CSCF, CA-AS, and UE #2. The diagram illustrates a scenario where UE #1 does not have required resources available, leading to a series of SIP messages including INVITE, PRACK, UPDATE, and ACK. Key events include 'Resources available' at UE #1 and UE #2, 'Reserve CA resources' at CA-AS, 'Alert called party' at UE #2, and 'Called party answers the call' at UE #2. The sequence ends with ACK messages from UE #1 and UE #2. + +Figure A.5.3A-1: CAT, UE#1 does not have required resources available + +#### 1 INVITE request (UE#1 to CAT-AS) see example in table A.5.3A-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.5.3A-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; + port-c=8642; port-s=7531 +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as not fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +##### 5-6 183 (Session Progress) provisional response (UE#2 to CAT-AS) see example in table A.5.3A-2 + +UE#2 sends a reliable SIP 183 (Session Progress) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +**Table A.5.3A-2: 183 (Session Progress) provisional response (UE#2 to CAT-AS)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP +catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , +, , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +RSeq: 9022 +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The local preconditions are indicated as not fulfilled. + +##### 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.5.3A-3 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. The CAT-AS shall take into account, when creating the SDP message, the media indicated by UE#2 in the previously received 183 provisional response and the one used by MRF for the media for CAT. + +**Table A.5.3A-3: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF and information in the previously received 183 (Session Progress) provisional response from UE#2. The local preconditions are indicated as not fulfilled. + +##### 9-12 PRACK request (UE#1 to CAT-AS, and to UE#2) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS, which is further sent to UE#2. + +##### 13-16 200 (OK) response to PRACK request (UE#2 to CAT-AS, and to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to CAT-AS, which is further sent to UE#1. + +##### 17-18 UPDATE request (UE#1 to CAT-AS) - see example in table A.5.3A-4 + +UE#1 indicates that it can send and receive media as the necessary resources are available. + +**Table A.5.3A-4: UPDATE request (UE#1 to CAT-AS)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , , +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; +tg.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_cat) contains a set of codecs supported to be used for CAT. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### **19-20 UPDATE request (CAT-AS to UE#2) - see example in table A.5.3A-5** + +CAT-AS indicates to UE#2 that UE#1 can send and receive media as the necessary resources are available. + +**Table A.5.3A-5: UPDATE request (CAT-AS to UE#2)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- +ad76cc7fc74;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +Route: +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 56101 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_regular) contains a set of codecs supported to be used for regular conversation. The local preconditions are indicated as fulfilled. + +##### 21-22 200 (OK) response (UE#2 to CAT-AS) - see example in table A.5.3A-6 + +UE#2 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. The SDP shall contain information relevant to the media that will be used after the session is established. + +CAT-AS shall store the relevant information in SDP for later use in step 31. + +###### Table A.5.3A-6: 200 (OK) response (UE#2 to CAT-AS) + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The local preconditions are indicated as fulfilled. + +##### 23-24 200 (OK) response (CAT-AS to UE#1) - see example in table A.5.3A-7 + +CAT-AS sends a SIP 200 (OK) response for the SIP UPDATE request to UE#1. The SDP shall contain information relevant to the media for CAT used by the MRF. + +**Table A.5.3A-7: 200 (OK) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336157 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs to be used for CAT. The local preconditions are indicated as fulfilled. + +##### 25-26 180 (Ringing) provisional response (UE#2 to CAT-AS) + +UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media upon receipt of 180 (Ringing) response. + +##### 27-28 180 (Ringing) provisional response (CAT-AS to UE#1) + +CAT-AS sends a SIP 180 (Ringing) provisional response for the INVITE request to the UE#1. + +##### 29-30 200 (OK) response to INVITE request (UE#2 to CAT-AS) + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +#### 31-32 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +##### 33-34 reINVITE request (CAT-AS to UE#2) + +The CAT-AS sends a SIP reINVITE request without SDP to UE#2. + +##### 35-36 200 (OK) response to reINVITE request (UE#2 to CAT-AS) see example in table A.5.3A-8 + +UE#2 sends a SIP 200 (OK) response for the SIP reINVITE request (step 34) with SDP\_O\_UE2\_regular to the CAT-AS. + +**Table A.5.3A-8: 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: ;comp=sigcomp, , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_UE2\_regular) contains a set of codecs supported by UE#2 and desired by the called user for this session. The local preconditions are indicated as fulfilled. + +##### 37-38 UPDATE request (CAT-AS to UE#1) see example in table A.5.3A-9 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) for UPDATE request from UE#2 in step 36. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +NOTE 1: The AS will remain in the signalling path, i.e. work as a B2BUA, in order to align and maintain information in SDP for further exchanged messages between UE#1 and UE#2. + +**Table A.5.3A-9: UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336158 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_UE2\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. + +##### 39-40 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to sending the response. UE#1 includes a SDP answer (SDP\_A\_UE1\_regular) in the 200 (OK) response to the corresponding SIP UPDATE request. + +##### 41-42 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +##### 43-44 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +#### 45-46 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response in step 36, with SDP\_A\_UE1\_regular to UE#2. + +### A.5.4 CAT when UE#1 has resources available while UE#2 does not have required resources available + +Figure A.5.4-1 shows an example call flow for CAT when UE#1 has resources available while UE#2 does not have required resources available. + +![Sequence diagram showing a SIP call flow between UE#1, S-CSCF, CAT-AS, and UE#2. The diagram illustrates an error scenario where UE#2 does not have required resources available. The sequence starts with UE#1 sending an INVITE (SDP_O) to S-CSCF, which is then forwarded to CAT-AS. CAT-AS attempts to reserve resources and then sends an INVITE (SDP_O) to UE#2. UE#2 responds with 'Resources available' and 'Alert called party'. The call proceeds with 180 (Ringing) and 200 (OK) responses. However, after the call is established, CAT-AS sends a 'Stop CA media' message, and the subsequent UPDATE and ACK messages result in an error state for UE#2.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAT-AS as CAT-AS + participant UE2 as UE #2 + + Note left of UE1: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CA resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of UE2: Resources available + Note right of UE2: Alert called party + UE2->>CAT-AS: 5. 180 (Ringing) + CAT-AS->>S-CSCF: 6. 180 (Ringing) + S-CSCF->>UE1: 8. 180 (Ringing) (SDP_A_cat) + UE1->>S-CSCF: 9. PRACK + S-CSCF->>CAT-AS: 10. PRACK + Note right of CAT-AS: Start CA media + CAT-AS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE1: 12. 200 (OK) (PRACK) + Note right of UE2: Called party answers the call + UE2->>CAT-AS: 13. 200 (OK) (SDP_A_regular) + CAT-AS->>S-CSCF: 14. 200 (OK) (SDP_A_regular) + Note right of CAT-AS: Stop CA media + CAT-AS->>S-CSCF: 15. UPDATE (SDP_A_regular) + S-CSCF->>UE1: 16. UPDATE (SDP_A_regular) + UE1->>S-CSCF: 17. 200 (OK) (UPDATE) (SDP_O2) + S-CSCF->>CAT-AS: 18. 200 (OK) (UPDATE) (SDP_O2) + CAT-AS->>S-CSCF: 19. 200 (OK) (INVITE) + S-CSCF->>UE1: 20. 200 (OK) (INVITE) + UE1->>S-CSCF: 21. ACK + S-CSCF->>CAT-AS: 22. ACK + CAT-AS->>S-CSCF: 23. ACK + S-CSCF->>UE2: 24. ACK + +``` + +Sequence diagram showing a SIP call flow between UE#1, S-CSCF, CAT-AS, and UE#2. The diagram illustrates an error scenario where UE#2 does not have required resources available. The sequence starts with UE#1 sending an INVITE (SDP\_O) to S-CSCF, which is then forwarded to CAT-AS. CAT-AS attempts to reserve resources and then sends an INVITE (SDP\_O) to UE#2. UE#2 responds with 'Resources available' and 'Alert called party'. The call proceeds with 180 (Ringing) and 200 (OK) responses. However, after the call is established, CAT-AS sends a 'Stop CA media' message, and the subsequent UPDATE and ACK messages result in an error state for UE#2. + +Figure A.5.4-1: CAT, UE#2 does not have required resources available + +#### 1 INVITE request (UE#1 to CAT-AS) see example in table A.5.4-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +Table A.5.4-1: INVITE request (UE#1 to CAT-AS) + +| | +|------------------------------------| +| INVITE tel:+1-212-555-2222 SIP/2.0 | +|------------------------------------| + +``` + +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +##### 5-6 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +##### 7-8 180 (Ringing) provisional response (CAT-AS to UE#1) see example in table A.5.4-2 + +The CAT-AS sends a reliable SIP 180 (Ringing) provisional response to UE#1. + +**Table A.5.4-2: 180 (Ringing) response (CAT-AS to UE#1)** + +``` +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### 9-10 PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +##### 11-12 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.5.4-3 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.5.4-3: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +##### 15-16 UPDATE request (CAT-AS to UE#1) see example in table A.5.4-4 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) response from UE#2. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +**Table A.5.4-4: UPDATE request (CAT-AS to UE#1)** + +``` +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +``` + +``` + +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336278 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. + +##### 17-18 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to sending the response. UE#1 includes a SDP answer (SDP\_O2) in the 200 (OK) response to the corresponding SIP UPDATE request. + +##### 19-20 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +##### 21-22 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +##### 23-24 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +NOTE 2: The ACK request from CAT-AS towards UE#2 may be sent after receiving 200 OK from UE#2 in step 14. + +### A.5.4A CAT using reINVITE request when UE#1 has resources available while UE#2 does not have required resources available + +Figure A.5.4A-1 shows an example call flow for CAT when UE#1 has resources available while UE#2 does not have required resources available. + +![Sequence diagram for CAT call setup between UE#1, S-CSCF, CAT-AS, and UE#2. The diagram shows a series of messages including INVITE, 180 Ringing, PRACK, 200 OK, reINVITE, UPDATE, and ACK. UE#2 does not have required resources available, leading to a failure in the call setup process.](a963ca41bde1669b18a4b783616f228b_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE #1 + participant S-CSCF as S-CSCF + participant CAT-AS as CAT-AS + participant UE2 as UE #2 + + Note left of UE1: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CA resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of UE2: Resources available + Note right of UE2: Alert called party + UE2->>CAT-AS: 5. 180 (Ringing) + CAT-AS->>S-CSCF: 6. 180 (Ringing) + S-CSCF->>CAT-AS: 7. 180 (Ringing) (SDP_A_cat) + CAT-AS->>UE1: 8. 180 (Ringing) (SDP_A_cat) + UE1->>S-CSCF: 9. PRACK + S-CSCF->>CAT-AS: 10. PRACK + Note right of CAT-AS: Start CA media + Note right of UE2: Called party answers the call + CAT-AS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE1: 12. 200 (OK) (PRACK) + S-CSCF->>CAT-AS: 13. 200 (OK) (SDP_A_regular) + CAT-AS->>S-CSCF: 14. 200 (OK) (SDP_A_regular) + Note right of CAT-AS: Stop CA media + S-CSCF->>CAT-AS: 15. ACK + CAT-AS->>UE2: 16. ACK + S-CSCF->>CAT-AS: 17. reINVITE + CAT-AS->>UE2: 18. reINVITE + UE2->>CAT-AS: 19. 200 (OK) (reINVITE) (SDP_O_UE2_regular) + CAT-AS->>S-CSCF: 20. 200 (OK) (reINVITE) (SDP_O_UE2_regular) + S-CSCF->>CAT-AS: 21. UPDATE (SDP_O_UE2_regular) + CAT-AS->>UE1: 22. UPDATE (SDP_O_UE2_regular) + UE1->>S-CSCF: 23. 200 (OK) (UPDATE) (SDP_A_UE1_regular) + S-CSCF->>CAT-AS: 24. 200 (OK) (UPDATE) (SDP_A_UE1_regular) + CAT-AS->>S-CSCF: 25. 200 (OK) (INVITE) + S-CSCF->>UE1: 26. 200 (OK) (INVITE) + UE1->>S-CSCF: 27. ACK + S-CSCF->>CAT-AS: 28. ACK + CAT-AS->>S-CSCF: 29. ACK (SDP_A_UE1_regular) + S-CSCF->>UE2: 30. ACK (SDP_A_UE1_regular) + +``` + +Sequence diagram for CAT call setup between UE#1, S-CSCF, CAT-AS, and UE#2. The diagram shows a series of messages including INVITE, 180 Ringing, PRACK, 200 OK, reINVITE, UPDATE, and ACK. UE#2 does not have required resources available, leading to a failure in the call setup process. + +Figure A.5.4A-1: CAT, UE#2 does not have required resources available + +1 INVITE request (UE#1 to CAT-AS) see example in table A.5.4A-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.5.4A-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +#### 5-6 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +##### 7-8 180 (Ringing) provisional response (CAT-AS to UE#1) see example in table A.5.4A-2 + +The CAT-AS sends a reliable SIP 180 (Ringing) provisional response to UE#1. + +**Table A.5.4A-2: 180 (Ringing) response (CAT-AS to UE#1)** + +``` +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +##### SDP + +The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +##### 9-10 PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +##### 11-12 200 (OK) response to PRACK request (CAT-AS to UE#1) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +##### 13-14 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.5.4A-3 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.5.4A-3: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +##### 15-16 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +##### 17-18 reINVITE request (CAT-AS to UE#2) + +The CAT-AS sends a SIP reINVITE request without SDP to UE#2. + +##### **19-20 200 (OK) response to reINVITE request (UE#2 to CAT-AS) see example in table A.5.4A-4** + +UE#2 sends a SIP 200 (OK) response for the SIP reINVITE request (step 18) with SDP\_O\_UE2\_regular to the CAT-AS. + +**Table A.5.4A-4: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP offer (SDP\_O\_UE2\_regular) contains a set of codecs supported by UE#2 and desired by the called user for this session. The local preconditions are indicated as fulfilled. + +##### **21-22 UPDATE request (CAT-AS to UE#1) see example in table A.5.4A-5** + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) response from UE#2 (step 20). + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +**Table A.5.4A-5: UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336278 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_UE2\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response (step 20). + +##### 23-24 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to sending the response. UE#1 includes a SDP answer (SDP\_A\_UE1\_regular) in the 200 (OK) response to the corresponding SIP UPDATE request. + +##### 25-26 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +##### 27-28 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +#### 29-30 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response (step 19), with SDP answer (SDP\_A\_UE1\_regular) to UE#2. + +### A.5.5 CAT diverting for CFNR using reINVITE request when UE#1, UE#2 and UE#3 have resources available + +Figures A.5.5-1a and A.5.5-1b show an example CAT signalling flow for a successful communication forwarding on no reply based on a CDIV AS providing the forwarding. + +![Sequence diagram for CAT with CFNR, no resource reservation. Lifelines: UE#1, S-CSCF, CDIV S, CA-AS, UE#2, UE#3.](d04c50badc78d5ba47bf4e352af4a754_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant S-CSCF + participant CDIV S + participant CA_AS as CA - AS + participant UE#2 + participant UE#3 + + Note over UE#1: Resources available + Note over UE#2: Resources available + Note over UE#3: Resources available + + UE#1->>S-CSCF: 1. INVITE (SDP_O) (URI=SIPURI-UE#2) + S-CSCF->>CDIV S: 2. INVITE (SDP_O) + CDIV S->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>CA_AS: 4. INVITE (SDP_O) + Note over CA_AS: Reserve CA resources + CA_AS->>CDIV S: 5. INVITE (SDP_O) + CDIV S->>S-CSCF: 6. INVITE (SDP_O) + S-CSCF->>UE#2: 7. 180 (Ringing) + Note over UE#2: Alert called party + UE#2->>CA_AS: 8. 180 (Ringing) + CA_AS->>CDIV S: 9. 180 (Ringing) (SDP_A_cat) + CDIV S->>S-CSCF: 10. 180 (Ringing) (SDP_A_cat) + Note over CDIV S: 11. Start timer + S-CSCF->>UE#1: 12. 180 (Ringing) (SDP_A_cat) + UE#1->>S-CSCF: 13. PRACK + S-CSCF->>CA_AS: 14. PRACK + Note over CA_AS: Start CA media + CA_AS->>S-CSCF: 14. 200 (OK) (PRACK) + S-CSCF->>UE#1: 14. 200 (OK) (PRACK) + Note over CDIV S: 15. Timer expired + CDIV S->>S-CSCF: 16. CANCEL + S-CSCF->>CA_AS: 17. CANCEL + Note over CA_AS: Stop CA media + CA_AS->>S-CSCF: 18. 200 (OK) (CANCEL) + S-CSCF->>CDIV S: 19. 200 (OK) (CANCEL) + CDIV S->>S-CSCF: 20. CANCEL + S-CSCF->>CA_AS: 21. CANCEL + CA_AS->>S-CSCF: 22. 200 (OK) (CANCEL) + S-CSCF->>CDIV S: 23. 200 (OK) (CANCEL) + S-CSCF->>UE#1: 24. 181 (Call Is Being Forwarded) + S-CSCF->>CDIV S: 25. 487 (Request terminated) + CDIV S->>S-CSCF: 26. 487 (Request terminated) + S-CSCF->>CDIV S: 27. ACK + S-CSCF->>CA_AS: 28. ACK + S-CSCF->>UE#2: 29. 487 (Request terminated) + UE#2->>S-CSCF: 30. 487 (Request terminated) + S-CSCF->>UE#2: 31. ACK + S-CSCF->>CA_AS: 32. ACK + S-CSCF->>CDIV S: 33. INVITE (SDP_O) (URI=SIPURI-UE#3) + CDIV S->>S-CSCF: 34. INVITE (SDP_O) + Note over CA_AS: Reserve CA resources + +``` + +Sequence diagram for CAT with CFNR, no resource reservation. Lifelines: UE#1, S-CSCF, CDIV S, CA-AS, UE#2, UE#3. + +**Figure A.5.5-1a: CAT with CFNR, no resource reservation** + +Error: + +106 + +Error: Reference source not + +![Sequence diagram showing a call flow between UE#1, S-CSCF, CDIV S, CA-AS, UE#2, and UE#3. The diagram includes messages such as INVITE, 180 (Ringing), 183 (Session Progress), UPDATE, PRACK, 200 (OK), ACK, and reINVITE. It also includes call state notifications like 'Alert called party', 'Start CA media', 'Stop CA media', and 'Called party answers the call'.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE#1 + participant SCSCF as S-CSCF + participant CDIVS as CDIV S + participant CAS as CA-AS + participant UE2 as UE#2 + participant UE3 as UE#3 + + Note right of UE3: Alert called party + UE1->>SCSCF: 35. INVITE (SDP_O) + SCSCF->>CDIVS: 36. INVITE (SDP_O) + CDIVS->>UE3: + Note right of UE3: Alert called party + CDIVS->>SCSCF: 37. 180 (Ringing) + SCSCF->>CAS: 38. 180 (Ringing) + SCSCF->>CDIVS: 39. 183 (Session Progress) (SDP_A_cat_#3) + CDIVS->>SCSCF: 40. 183 (Session Progress) (SDP_A_cat_#3) + SCSCF->>UE1: 41. UPDATE (SDP_A_cat_#3) + UE1->>SCSCF: 42. 200 (OK) (UPDATE) (SDP_O_cat_#3) + SCSCF->>CDIVS: 43. PRACK (SDP_O_cat_#3) + CDIVS->>CAS: 44. PRACK (SDP_O_cat_#3) + Note right of CAS: Start CA media + SCSCF->>CDIVS: 45. 200 (OK) (PRACK)(SDP_A2_CA_#3) + CDIVS->>SCSCF: 46. 200 (OK) (PRACK)(SDP_A2_CA_#3) + Note right of UE3: Called party answers the call + SCSCF->>CAS: 47. 200 (OK) (SDP_A_regular_#3) + CAS->>CDIVS: 48. 200 (OK) (SDP_A_regular_#3) + Note right of CAS: Stop CA media + SCSCF->>CDIVS: 49. ACK + CDIVS->>UE3: 50. ACK + SCSCF->>CDIVS: 51. reINVITE + CDIVS->>UE3: 52. reINVITE + SCSCF->>CDIVS: 53. 200 (OK) (reINVITE) (SDP_O2_regular_#3) + CDIVS->>CAS: 54. 200 (OK) (reINVITE) (SDP_O2_regular_#3) + SCSCF->>UE1: 55. UPDATE (SDP_O2_regular_#3) + UE1->>SCSCF: 56. 200 (OK) (UPDATE) (SDP_A2_regular_#3) + SCSCF->>CDIVS: 57. 200 (OK) (INVITE) + CDIVS->>SCSCF: 58. ACK + SCSCF->>CDIVS: 59. ACK (SDP_A2_regular_#3) + CDIVS->>UE3: 60. ACK (SDP_A2_regular_#3) + +``` + +Sequence diagram showing a call flow between UE#1, S-CSCF, CDIV S, CA-AS, UE#2, and UE#3. The diagram includes messages such as INVITE, 180 (Ringing), 183 (Session Progress), UPDATE, PRACK, 200 (OK), ACK, and reINVITE. It also includes call state notifications like 'Alert called party', 'Start CA media', 'Stop CA media', and 'Called party answers the call'. + +Figure A.5.5-1b: CAT with CFNR, no resource reservation + +1 INVITE request (UE#1 to S-CSCF) see example in table A.5.5-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem with UE#2 as the desired called UE. The URI-UE#2 is subscribed to the CFNR service. + +**Table A.5.5-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; + port-c=8642; port-s=7531 +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +#### 2 INVITE request (S-CSCF to CDIV AS) + +The S-CSCF forwards the SIP INVITE request to the CDIV AS. + +#### 3-5 INVITE request (CDIV AS to CAT-AS) + +Via the S-CSCF, the CDIV AS forwards the request to the CAT-AS serving UE#2. + +The CAT-AS instructs the MRF to reserve CAT resources. + +#### 5-6 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +##### 7-8 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +##### 9-12 180 (Ringing) provisional response (CAT-AS to UE#1) see example in table A.5.5-2 + +The CAT-AS sends a reliable SIP 180 (Ringing) provisional response to UE#1. The CDIV AS starts the no reply timer. + +**Table A.5.5-2: 180 (Ringing) response (CAT-AS to UE#1)** + +``` +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 340051372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media + +description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +#### **13 PRACK request (UE#1 to CAT-AS)** + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +#### **14 200 (OK) response to PRACK (CAT-AS to UE#1)** + +A SIP 200 (OK) response sent by the CAT-AS for the SIP PRACK request traverses through CDIV AS and S-CSCF to UE#1. + +###### **15 No reply timer expires** + +The no reply timer expires. + +##### **16-19 CANCEL request (CDIV AS to CAT-AS) and 200 (OK) response to CANCEL request (CAT-AS to CDIV AS)** + +The CDIV AS sends CANCEL request to the CAT-AS. The CAT AS instructs the MRF to stop CAT media. The CAT-AS sends 200 (OK) response for the CANCEL request to the CDIV AS. + +##### **20-23 CANCEL request (CAT-AS to UE#2) and 200 (OK) response to CANCEL request (UE#2 to CAT-AS)** + +The CAT-AS sends CANCEL request to UE#2. The UE#2 sends 200 (OK) response for the CANCEL request to the CAT-AS. + +#### **24 181 (Call Is Being Forwarded) response (CDIV AS to UE#1)** + +Depending on the value of CDIV subscription option “Originating user receives notification that his communication has been diverted (forwarded or deflected)”, a 181 (Call Is Being Forwarded) response is sent towards UE#1 indicating that the communication is diverted. + +##### **25-28 487 (Request Terminated) response (CAT-AS to CDIV) and ACK request** + +A 487 (Request Terminated) response with a ACK request finalize the termination of the dialog between CDIV AS and CAT-AS. + +##### **29-32 487 (Request Terminated) response (UE#2 to CAT-AS) and ACK request** + +A 487 (Request Terminated) response with a ACK request finalize the termination of the dialog between CAT-AS and UE#2. + +#### **33 INVITE request (CDIV AS to S-CSCF) see example in table A.5.5-3** + +An INVITE request including URI-UE#3 as destination is sent towards the S-CSCF. Additional the History-Info header is included. + +**Table A.5.5-3: INVITE request (CDIV AS to UE#3)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +#### 34 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the INVITE request to the CAT-AS serving UE#3. + +The CAT-AS instructs the MRF to reserve CAT resources. + +##### 35-36 INVITE request (CAT-AS to UE#3) + +The CAT-AS forwards the request to UE#3. + +##### 37-38 180 (Ringing) provisional response (UE#3 to CAT-AS) + +The called party is alerted. UE#3 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +##### 39-40 183 (Session Progress) provisional response (CAT-AS to CDIV AS) see example in table A.5.5-4 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to CDIV AS. + +**Table A.5.5-4: 183 (Session Progress) response (CAT-AS to CDIV AS)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP** The SDP answer (SDP\_A\_cat#3) contains a set of codecs supported to be used for CAT. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +#### 41 UPDATE request (CDIV AS to UE#1) see example in table A5.5-5 + +The CDIV AS sends UPDATE request to UE#1. + +**Table A.5.5-5: UPDATE request (CDIV AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336278 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_A\_cat\_#3) contains a set of codecs supported to be used for CAT. The SDP content is based on information received in previous 183 response. + +#### 42 200 (OK) response (UE#1 to CDIV AS) see example in table A5.5-6 + +The UE#1 sends 200 (OK) response for the UPDATE request to CDIV AS. UE#1 includes a SDP answer (SDP\_O\_cat\_#3) in the 200 (OK) response to the corresponding SIP UPDATE request. + +#### 43-44 PRACK request (CDIV AS to CAT-AS) + +The CDIV AS sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. A SDP offer (SDP\_O\_cat\_#3) is included. + +#### 45-46 200 (OK) response (CAT-AS to CDIV AS) + +The CAT-AS sends a SIP 200 (OK) response for the PRACK request to CDIV AS. A SDP answer (SDP\_A2\_CAT\_#3) is included in the 200(OK) response. The set of codecs supported to be used for CAT is based on information from MRF. The CAT-AS instructs the MRF to play the CAT media. + +#### 47-48 200 (OK) response to INVITE (UE#3 to CAT-AS) see example in table A.5.2-6 + +The called party answers the call. UE#3 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.5.2-6: 200 (OK) response (UE#3 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular\_#3) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +#### 49-50 ACK request (CAT-AS to UE#3) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#3. + +#### 51-52 reINVITE request (CAT-AS to UE#3) + +The CAT-AS sends a SIP reINVITE request without SDP to UE#3. + +#### 53-54 200 (OK) response to reINVITE request (UE#3 to CAT-AS) see example in table A.5.2-7 + +UE#3 sends a SIP 200 (OK) response for the SIP reINVITE request with SDP\_O2\_regular\_#3 to the CAT-AS. + +**Table A.5.2-7: 200 (OK) response (UE#3 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O2\_regular\_#3) contains a set of codecs supported by UE#3 and desired by the called user for this session. The local preconditions are indicated as fulfilled. + +## 55 UPDATE request (CAT-AS to UE#1) see example in table A.5.2-8 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) response from UE#3. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#3. + +**Table A.5.2-8: UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336389 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O2\_regular\_#3) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response (step 52). The local preconditions are indicated as fulfilled. + +#### 56 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. UE#1 includes a SDP answer (SDP\_A2\_regular\_#3) in the 200 (OK) response to the corresponding SIP UPDATE request. + +#### 57 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +#### 58 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +#### 59-60 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response (step 54), with SDP answer (SDP\_A2\_regular\_#3) to UE#2. + +## A.5.6 CAT diverting for CFU + +### A.5.6.1 General + +Subclause A.5.6.2 shows an example CAT signalling flow for an successful communication forwarding unconditional based on an CDIV AS providing the forwarding. + +A.5.6.2 Gateway model CAT diverting for CFU when UE#1, UE#2 and UE#3 have resources available + +![Sequence diagram showing a SIP call flow between UE#1, S-CSCF, CDIV S, CA-AS, UE#3, and UE#2. The diagram includes messages like INVITE, 181, 183, PRACK, 200 OK, ACK, reINVITE, and UPDATE. Internal actions include 'CFU Logic is executed', 'Reserve CA resources', 'Start CA media', and 'Stop CA media'. External actions include 'Resources available' and 'Alert called party'.](cc7baa8e5118f4b42c01166637c738ea_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE#1 + participant S-CSCF as S-CSCF + participant CDIV_S as CDIV S + participant CA_AS as CA-AS + participant UE3 as UE#3 + participant UE2 as UE#2 + + Note left of UE1: Resources available + Note right of UE3: Resources available + Note right of UE2: Resources available + + UE1->>S-CSCF: 1. INVITE (SDP_O) (URI=SIPURI-UE#2) + S-CSCF->>CDIV_S: 2. INVITE (SDP_O) + Note right of CDIV_S: 3. CFU Logic is executed + CDIV_S->>S-CSCF: 4. 181 (Call Is Being Forwarded) + S-CSCF->>UE1: 5. 181 (Call Is Being Forwarded) + S-CSCF->>CDIV_S: 6. INVITE (SDP_O) (URI=SIPURI-UE#3) + CDIV_S->>CA_AS: 7. INVITE (SDP_O) + Note right of CA_AS: Reserve CA resources + CA_AS->>S-CSCF: 8. INVITE (SDP_O) + S-CSCF->>UE3: 9. INVITE (SDP_O) + Note right of UE3: Alert called party + UE3->>S-CSCF: 10. 180 (Ringing) + S-CSCF->>CDIV_S: 11. 180 (Ringing) + CDIV_S->>S-CSCF: 12. 183 (Session Progress) (SDP_A_cat) + S-CSCF->>CDIV_S: 13. 183 (Session Progress) (SDP_A_cat) + CDIV_S->>S-CSCF: 14. 183 (Session Progress) (SDP_A_cat) + S-CSCF->>UE1: 15. 183 (Session Progress) (SDP_A_cat) + UE1->>S-CSCF: 16. PRACK + S-CSCF->>CDIV_S: 17. PRACK + CDIV_S->>CA_AS: 18. PRACK + Note right of CA_AS: Start CA media + CA_AS->>CDIV_S: 19. 200 (OK) (PRACK) + CDIV_S->>S-CSCF: 20. 200 (OK) (PRACK) + S-CSCF->>UE1: 21. 200 (OK) (PRACK) + Note right of UE3: Called party answers the call + UE3->>S-CSCF: 22. 200 (OK) (SDP_A_regular) + S-CSCF->>CDIV_S: 23. 200 (OK) (SDP_A_regular) + Note right of CA_AS: Stop CA media + CA_AS->>S-CSCF: 24. ACK + S-CSCF->>UE3: 25. ACK + S-CSCF->>CDIV_S: 26. reINVITE + CDIV_S->>UE3: 27. reINVITE + UE3->>S-CSCF: 28. 200 (OK) (reINVITE) (SDP_O_regular) + S-CSCF->>CDIV_S: 29. 200 (OK) (reINVITE) (SDP_O_regular) + CDIV_S->>S-CSCF: 30. UPDATE (SDP_O_regular) + S-CSCF->>UE1: 31. UPDATE (SDP_O_regular) + UE1->>S-CSCF: 32. 200 (OK) (UPDATE) (SDP_A2_regular) + S-CSCF->>CDIV_S: 33. 200 (OK) (UPDATE) (SDP_A2_regular) + CDIV_S->>S-CSCF: 34. 200 (OK) (INVITE) + S-CSCF->>UE1: 35. 200 (OK) (INVITE) + UE1->>S-CSCF: 36. ACK + S-CSCF->>CDIV_S: 37. ACK + CDIV_S->>S-CSCF: 38. ACK (SDP_A2_regular) + S-CSCF->>UE3: 39. ACK (SDP_A2_regular) + +``` + +Sequence diagram showing a SIP call flow between UE#1, S-CSCF, CDIV S, CA-AS, UE#3, and UE#2. The diagram includes messages like INVITE, 181, 183, PRACK, 200 OK, ACK, reINVITE, and UPDATE. Internal actions include 'CFU Logic is executed', 'Reserve CA resources', 'Start CA media', and 'Stop CA media'. External actions include 'Resources available' and 'Alert called party'. + +Figure A.5.6.2-1: CAT with CFU, no resource reservation + +## 1 SIP INVITE request (UE#1 to CAT-AS)-see example in table A.5.6.2-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +Table A.5.6.2-1: SIP INVITE request (UE#1 to CAT-AS) + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for GRUU, 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. **SDP** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +## 2 SIP INVITE request (S-CSCF to CDIV AS) + +The S-CSCF forwards the SIP INVITE request to the CDIV AS. + +## 3 Procedures for CFU are executed. + +### 4-5 SIP 181 (Call Is Being Forwarded) response (CDIV AS to UE#1) + +Depending on the value of subscription option "Originating user receives notification that his communication has been diverted (forwarded or deflected)", a 181 (Call Is Being Forwarded) response is sent towards the UE#1 indicating that the communication is diverted. + +### 6-7 SIP INVITE request (CDIV AS to S-CSCF)-see example in table A.5.6.2-6 + +A SIP INVITE request including SIP URI of UE#3 as destination is sent towards the S-CSCF. Additionally, the History-Info header is included. + +**Table A.5.6.2-6: INVITE request (CDIV AS to UE#3)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: comp=sigcomp>, , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +### 8-9 SIP INVITE request (CAT-AS to UE#3) + +The CAT-AS forwards the SIP INVITE request to UE#3. + +### 10-11 SIP 180 (Ringing) provisional response (UE#3 to CAT-AS) + +The called party is alerted. UE#3 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +#### 12-15 SIP 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.5.6.2-12 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. + +**Table A.5.6.2-12: SIP 183 (Session Progress) response (CAT-AS to UE#1)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ,+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 340051372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +#### SDP + +The SDP answer (SDP\_A\_cat) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +#### 16-18 SIP PRACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +#### 19-21 SIP 200 (OK) response to PRACK request (CAT-AS to UE#1) + +A SIP 200 (OK) response sent by the CAT-AS for the SIP PRACK request traverses through CDIV AS and S-CSCF to UE#1. + +#### 22-23 SIP 200 (OK) response to INVITE request (UE#3 to CAT-AS) see example in table A.5.6.2-22 + +The called party answers the call. UE#3 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.5.6.2-22: 200 (OK) response (UE#3 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +#### 24-25 SIP ACK request (CAT-AS to UE#3) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#3. + +#### 26-27 SIP reINVITE request (CAT-AS to UE#3) + +The CAT-AS sends a SIP reINVITE request without SDP to UE#3. + +#### 28-29 SIP 200 (OK) response to reINVITE request (UE#3 to CAT-AS) see example in table A.5.6.2-28 + +UE#2 sends a SIP 200 (OK) response for the SIP reINVITE request (step 18) with SDP\_O\_UE2\_regular to the CAT-AS. + +**Table A.5.6.2-28: 200 (OK) response (UE#3 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_regular) contains a set of codecs supported by UE#3 and desired by the called user for this session. The local preconditions are indicated as fulfilled. + +### 30-31 SIP UPDATE request (CAT-AS to UE#1) see example in table A.5.6.2-30 + +The CAT-AS sends a SIP UPDATE request containing values received in the 200 (OK) response from UE#3. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#3. + +**Table A.5.6.2-30: SIP UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336278 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP** The SDP offer (SDP\_O\_regular) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. + +### 32-33 SIP 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to sending the response. UE#1 includes a SDP answer (SDP\_A2\_regular) in the 200 (OK) response to the corresponding SIP UPDATE request. + +### 34-35 SIP 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +### 36-37 SIP ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +### 38-39 SIP ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, with SDP answer (SDP\_A2\_regular) to UE#2. + +## A.5.7 CAT when both UE#1 and UE#2 do not have required resources available + +Figure A.5.7-1 shows an example call flow for CAT when UE#1 and UE#2 does not have required resources available, and the session bandwidth between UE#1 and UE#2 is rather than the session bandwidth between UE#1 and CAT-AS. + +![Sequence diagram showing CAT call flow between UE#1, S-CSCF, CAT-AS, and UE#2.](72d448a65347c51989171748789c7d4b_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE#1 + participant SCSCF as S-CSCF + participant CATAS as CAT-AS + participant UE2 as UE#2 + + UE1->>SCSCF: 1. INVITE (SDP 1) + SCSCF->>CATAS: 2. INVITE (SDP 1) + CATAS->>SCSCF: 3. INVITE (SDP 1) + SCSCF->>UE2: 4. INVITE (SDP 1) + UE2-->>SCSCF: 5. 183 (Session Progress) (SDP 2, A-Require) + SCSCF-->>CATAS: 6. 183 (Session Progress) (SDP 2, A-Require) + CATAS-->>SCSCF: 7. 183 (Session Progress) (SDP 2, A-Require) + SCSCF-->>UE1: 8. 183 (Session Progress) (SDP 2, A-Require) + UE1->>SCSCF: 9. PRACK + SCSCF->>CATAS: 10. PRACK + CATAS->>SCSCF: 11. PRACK + SCSCF->>UE2: 12. PRACK + UE2-->>SCSCF: 13. 200 (OK) (PRACK) + SCSCF-->>CATAS: 14. 200 (OK) (PRACK) + CATAS-->>SCSCF: 15. 200 (OK) (PRACK) + SCSCF-->>UE1: 16. 200 (OK) (PRACK) + Note over UE1: Resources available + UE1->>SCSCF: 17. UPDATE (SDP 1) + SCSCF->>CATAS: 18. UPDATE (SDP 1) + CATAS->>SCSCF: 19. UPDATE (SDP 1) + SCSCF->>UE2: 20. UPDATE (SDP 1) + Note over UE2: Resources available + Note over UE2: Alert called party + UE2-->>SCSCF: 21. 200 (OK) (UPDATE) (SDP 2, A-Require) + SCSCF-->>CATAS: 22. 200 (OK) (UPDATE) (SDP 2, A-Require) + CATAS-->>SCSCF: 23. 200 (OK) (UPDATE) (SDP 2, A-Require) + SCSCF-->>UE1: 24. 200 (OK) (UPDATE) (SDP 2, A-Require) + UE2-->>SCSCF: 25. 180 (Ringing) + SCSCF-->>CATAS: 26. 180 (Ringing) + Note over CATAS: Reserve CAT resources + CATAS->>SCSCF: 27. UPDATE (SDP CAT) + SCSCF->>UE1: 28. UPDATE (SDP CAT) + UE1-->>SCSCF: 29. 200 (OK) (UPDATE) (SDP 1) + SCSCF-->>CATAS: 30. 200 (OK) (UPDATE) (SDP 1) + Note over CATAS: Start CAT media + CATAS-->>SCSCF: 31. 180 (Ringing) + SCSCF-->>UE1: 32. 180 (Ringing) + Note over UE2: Called party answers the call + UE2-->>SCSCF: 33. 200 (OK) (INVITE) + SCSCF-->>CATAS: 34. 200 (OK) (INVITE) + Note over CATAS: Stop CAT media + CATAS->>SCSCF: 35. UPDATE (SDP 2, A-Require) + SCSCF->>UE1: 36. UPDATE (SDP 2, A-Require) + UE1-->>SCSCF: 37. 200 (OK) (UPDATE) (SDP 1) + SCSCF-->>CATAS: 38. 200 (OK) (UPDATE) (SDP 1) + CATAS-->>SCSCF: 39. 200 (OK) (INVITE) + SCSCF-->>UE1: 40. 200 (OK) (INVITE) + UE1->>SCSCF: 41. ACK + SCSCF->>CATAS: 42. ACK + CATAS->>SCSCF: 43. ACK + SCSCF->>UE2: 44. ACK + +``` + +Sequence diagram showing CAT call flow between UE#1, S-CSCF, CAT-AS, and UE#2. + +Figure A.5.7-1: CAT, UE#1 and UE#2 does not have required resources available + +- INVITE request (UE#1 to CAT-AS) see example in table A.5.7-1** + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.5.7-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as not fulfilled. + +## 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +## 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +## 5-6 183 (Session Progress) provisional response (UE#2 to CAT-AS) see example in table A.5.7-2 + +UE#2 sends a reliable SIP 183 (Session Progress) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +**Table A.5.7-2: 183 (Session Progress) provisional response (UE#2 to CAT-AS)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: comp=sigcomp>, , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +RSeq: 9022 +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74>; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP:** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The local preconditions are indicated as not fulfilled. + +## 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.5.7-3 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. The CAT-AS shall take into account, when creating the SDP message, the media indicated by UE#2 in the previously received 183 (Session Progress) provisional response. + +**Table A.5.7-3: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +``` + +``` + +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: ;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 51372 RTP/AVPF 98 +a=acfg:1 t=1 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP:** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The local preconditions are indicated as not fulfilled. + +#### 9-12 PRACK request (UE#1 to CAT-AS, and to UE#2) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS, which is further sent to UE#2. + +#### 13-16 200 (OK) response to PRACK request (UE#2 to CAT-AS, and to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to CAT-AS, which is further sent to UE#1. + +#### 17-18 UPDATE request (UE#1 to CAT-AS) - see example in table A.5.7-4 + +UE#1 indicates that it can send and receive media as the necessary resources are available. + +**Table A.5.7-4: UPDATE request (UE#1 to CAT-AS)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , , +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree + +``` + +``` + +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP:** The SDP answer (SDP\_O2) contains a set of codecs supported to be used for the session. The SDP content is based on information received from the UE#2. The local preconditions are indicated as fulfilled. + +#### 19-20 UPDATE request (CAT-AS to UE#2) - see example in table A.5.7-5 + +CAT-AS indicates to UE#2 that UE#1 can send and receive media as the necessary resources are available. + +**Table A.5.7-5: UPDATE request (CAT-AS to UE#2)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99- +ad76cc7fc74;comp=sigcomp SIP/2.0 +Via: [5555::ccc:aaa:abc:abc]:1357;comp=sigcomp;branch=z9hG4bKnashds8 +Max-Forwards: 66 +Route: +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 56101 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933616 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none + +``` + +``` + +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP:** The SDP offer (SDP\_O2) contains a set of codecs supported to be used for the session. The SDP content is based on information received from the UE#1. The local preconditions are indicated as fulfilled. + +#### 21-24 200 (OK) response (UE#2 to CAT-AS, and to UE#1) - see example in table A.5.7-6 + +UE#2 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. The SDP shall contain information relevant to the media that will be used after the session is established. + +CAT-AS shall store the relevant information in SDP for later use in step 35. + +**Table A.5.7-6: 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local none +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**SDP:** The SDP answer (SDP\_A\_regular2) contains a set of codecs to be used for the session. The local preconditions are indicated as fulfilled. + +#### 25-26 180 (Ringing) provisional response (UE#2 to CAT-AS) + +UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources upon receipt of 180. + +## 27-28 UPDATE request (CAT-AS to UE#1) see example in table A.5.7-7 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) for UPDATE request from UE#2 in step 22. + +Session between UE#1 and UE#2 is replaced with session between UE#1 and CAT-AS. + +NOTE 1: The AS will remain in the signalling path, i.e. work as a B2BUA, in order to align and maintain information in SDP for further exchanged messages between UE#1 and UE#2. + +**Table A.5.7-7: UPDATE request (CAT-AS to UE#1)** + +``` +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336156 29879336158 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP** The SDP offer (SDP\_O\_cat) contains a set of codecs to be used for CAT. The SDP content is based on information received from previous 200 (OK) response. + +## 29-30 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. UE#1 includes a SDP answer (SDP\_A\_cat) in the 200 (OK) response to the corresponding SIP UPDATE request. The CAT-AS instructs MRF to start playing the CAT media. + +## 31-32 180 (Ringing) provisional response (CAT-AS to UE#1) + +CAT-AS sends a SIP 180 (Ringing) provisional response for the INVITE request to the UE#1. + +## 33-34 200 (OK) response to INVITE request (UE#2 to CAT-AS) + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +## 35-36 UPDATE request (CAT-AS to UE#1) see example in table A.5.7-8 + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) for UPDATE request from UE#2 in step 22. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +NOTE 1: The AS will remain in the signalling path, i.e. work as a B2BUA, in order to align and maintain information in SDP for further exchanged messages between UE#1 and UE#2. + +**Table A.5.7-8: UPDATE request (CAT-AS to UE#1)** + +``` +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336158 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP:** The SDP offer (SDP\_O\_regular2) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. + +### 37-38 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to sending the response. UE#1 includes a SDP answer (SDP\_A3) in the 200 (OK) response to the corresponding SIP UPDATE request. + +### 39-40 200 (OK) response to INVITE request (CAT-AS to UE#1) + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +### 41-42 ACK request (UE#1 to CAT-AS) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +### 43-44 ACK request (CAT-AS to UE#2) + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +NOTE 3: The ACK request from CAT-AS towards UE#2 may be sent after receiving 200 (OK) from UE#2 in step 18. + +## A.5.8 CAT with different media types during one SIP session when both UE#1 and UE#2 do not have required resources available + +Figure A.5.8-1 shows an example call flow for CAT when UE#1 and UE#2 does not have required resources available, and the media type required by CAT service which is video in this example, and the media type required by the call which is audio, are different during one session. + +**Error:** + +133 + +**Error: Reference source not** + +![UML Sequence diagram showing a call flow between UE#1, S-CSCF, CAT AS, and UE#2. The flow involves session initiation (INVITE), resource reservation, alerting, and media control for Customized Alerting Tones (CAT).](db7a693cf26f527ac6c0d4d41da20858_img.jpg) + +``` + +sequenceDiagram + participant UE1 as UE#1 + participant SCSCF as S-CSCF + participant CATAS as CAT AS + participant UE2 as UE#2 + + UE1->>SCSCF: 1. INVITE (SDP 0) + SCSCF->>CATAS: 2. INVITE (SDP 0) + CATAS->>SCSCF: 3. INVITE (SDP 0) + SCSCF->>UE2: 4. INVITE (SDP 0) + UE2-->>SCSCF: 5. 183 (Session Progress) (SDP A, Regular) + SCSCF-->>CATAS: 6. 183 (Session Progress) (SDP A, Regular) + CATAS-->>SCSCF: 7. 183 (Session Progress) (SDP A, Regular) + SCSCF-->>UE1: 8. 183 (Session Progress) (SDP A, Regular) + UE1->>SCSCF: 9. PRACK + SCSCF->>CATAS: 10. PRACK + CATAS->>SCSCF: 11. PRACK + SCSCF->>UE2: 12. PRACK + UE2-->>SCSCF: 13. 200 (OK) (PRACK) + SCSCF-->>CATAS: 14. 200 (OK) (PRACK) + CATAS-->>SCSCF: 15. 200 (OK) (PRACK) + SCSCF-->>UE1: 16. 200 (OK) (PRACK) + Note left of UE1: Resources +available + UE1->>SCSCF: 17. UPDATE (SDP 0 2) + SCSCF->>CATAS: 18. UPDATE (SDP 0 2) + CATAS->>SCSCF: 19. UPDATE (SDP 0 2) + SCSCF->>UE2: 20. UPDATE (SDP 0 2) + Note right of UE2: Resources +available + Note right of UE2: Alert called party + UE2-->>SCSCF: 21. 200 (OK) (UPDATE) (SDP A, Regular 2) + SCSCF-->>CATAS: 22. 200 (OK) (UPDATE) (SDP A, Regular 2) + CATAS-->>SCSCF: 23. 200 (OK) (UPDATE) (SDP A, Regular 2) + SCSCF-->>UE1: 24. 200 (OK) (UPDATE) (SDP A, Regular 2) + UE2-->>SCSCF: 25. 180 (Ringing) + SCSCF-->>CATAS: 26. 180 (Ringing) + Note right of CATAS: Reserve CAT +resources + CATAS->>SCSCF: 27. UPDATE (SDP 0 CAT) + SCSCF->>UE1: 28. UPDATE (SDP 0 CAT) + UE1-->>SCSCF: 29. 200 (OK) (UPDATE) (SDP A, CAT) + SCSCF-->>CATAS: 30. 200 (OK) (UPDATE) (SDP A, CAT) + Note left of UE1: CAT resources +available + CATAS->>SCSCF: 31. UPDATE (SDP 0 2) + SCSCF->>UE2: 32. UPDATE (SDP 0 2) + UE2-->>SCSCF: 33. 200 (OK) (UPDATE) (SDP A, 2) + SCSCF-->>CATAS: 34. 200 (OK) (UPDATE) (SDP A, 2) + Note right of CATAS: Start CAT media + CATAS-->>SCSCF: 35. 180 (Ringing) + SCSCF-->>UE1: 36. 180 (Ringing) + UE2-->>SCSCF: 37. 200 (OK) (INVITE) + Note right of UE2: Called party +answers the call + SCSCF-->>CATAS: 38. 200 (OK) (INVITE) + Note right of CATAS: Stop CAT media + CATAS->>SCSCF: 39. UPDATE (SDP 0 Regular 2) + SCSCF->>UE1: 40. UPDATE (SDP 0 Regular 2) + UE1-->>SCSCF: 41. 200 (OK) (UPDATE) (SDP A, 2) + SCSCF-->>CATAS: 42. 200 (OK) (UPDATE) (SDP A, 2) + CATAS-->>SCSCF: 43. 200 (OK) (INVITE) + SCSCF-->>UE1: 44. 200 (OK) (INVITE) + UE1->>SCSCF: 45. ACK + SCSCF->>CATAS: 46. ACK + CATAS->>SCSCF: 47. ACK + SCSCF->>UE2: 48. ACK + +``` + +UML Sequence diagram showing a call flow between UE#1, S-CSCF, CAT AS, and UE#2. The flow involves session initiation (INVITE), resource reservation, alerting, and media control for Customized Alerting Tones (CAT). + +**Figure A.5.8-1: CAT with different media types during one session, UE#1 and UE#2 does not have required resources available** + +## 1 INVITE request (UE#1 to CAT-AS) see example in table A.5.8-1 + +UE#1 sends a SIP INVITE request to the intermediate IM CN subsystem. + +**Table A.5.8-1: INVITE request (UE#1 to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +P-Early-Media: supported +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ;video;+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for 199 responses, reliable provisional responses and preconditions. + +**P-Early-Media:** The UE indicates support for the P-Early-Media header. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**Contact:** The UE indicates support for video handling. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as not fulfilled. In this example, only audio media description has been included in SDP\_O in case of audio call. + +## 2 INVITE request (S-CSCF to CAT-AS) + +The S-CSCF forwards the SIP INVITE request to the CAT-AS. + +## 3-4 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the request to UE#2. + +## 5-6 183 (Session Progress) provisional response (UE#2 to CAT-AS) see example in table A.5.8-2 + +UE#2 sends a reliable SIP 183 (Session Progress) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS terminates the provisional response. + +**Table A.5.8-2: 183 (Session Progress) provisional response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: ;comp=sigcomp, , + , , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +RSeq: 9022 +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74>; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=audio 8386 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP:** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session. The local preconditions are indicated as not fulfilled. + +## 7-8 183 (Session Progress) provisional response (CAT-AS to UE#1) see example in table A.5.8-3 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to UE#1. The CAT-AS shall take into account, when creating the SDP message, the media indicated by UE#2 in the previously received 183 (Session Progress) provisional response. + +**Table A.5.8-3: 183 (Session Progress) response (CAT-AS to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 + +``` + +``` + +P-Early-Media: sendrecv +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336156 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=audio 49170 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +a=content:g.3gpp.cat + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**SDP:** The SDP answer (SDP\_A\_regular) contains a set of codecs to be used for the session and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The local preconditions are indicated as not fulfilled. + +#### 9-12 PRACK request (UE#1 to CAT-AS, and to UE#2) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS, which is further sent to UE#2. + +#### 13-16 200 (OK) response to PRACK request (UE#2 to CAT-AS, and to UE#1) + +UE#2 sends a SIP 200 (OK) response for the SIP PRACK request to CAT-AS, which is further sent to UE#1. + +#### 17-18 UPDATE request (UE#1 to CAT-AS) - see example in table A.5.8-4 + +UE#1 indicates that it can send and receive media as the necessary resources are available. + +**Table A.5.8-4: UPDATE request (UE#1 to CAT-AS)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , , +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi-s=87654321; port-c=8642; port-s=7531 +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 + +``` + +``` +a=rtpmap:96 telephone-event +``` + +**SDP:** The SDP offer (SDP\_O2) contains a set of codecs supported to be used for the session. The SDP content is based on information received from the UE#2. The local preconditions are indicated as fulfilled. + +#### 19-20 UPDATE request (CAT-AS to UE#2) - see example in table A.5.8-5 + +CAT-AS indicates to UE#2 that UE#1 can send and receive media as the necessary resources are available. + +**Table A.5.8-5: UPDATE request (CAT-AS to UE#2)** + +``` +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74;comp=sigcomp SIP/2.0 +Via: [5555::ccc:aaa:abc:abc]:1357;comp=sigcomp;branch=z9hG4bKnashds8 +Max-Forwards: 66 +Route: +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 56101 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi-s=87654321; port-c=8642; port-s=7531 +Contact: ; +tg.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::ccc:aaa:abc:abc +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event +``` + +**SDP:** The SDP offer (SDP\_O2) contains a set of codecs supported to be used for the session. The SDP content is based on information received from the UE#1. The local preconditions are indicated as fulfilled. + +#### 21-24 200 (OK) response (UE#2 to CAT-AS, and to UE#1) - see example in table A.5.8-6 + +UE#2 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. The SDP shall contain information relevant to the media that will be used after the session is established. + +CAT-AS shall store the relevant information in SDP for later use in step 35. + +**Table A.5.8-6: 200 (OK) response (UE#2 to CAT-AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP +catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: ;comp=sigcomp, , +, , , + +From: +``` + +``` + +To: ;tag=2236 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74>; + +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336157 29879336157 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +**SDP:** The SDP answer (SDP\_A\_regular2) contains a set of codecs to be used for the session. The local preconditions are indicated as fulfilled. + +### 25-26 180 (Ringing) provisional response (UE#2 to CAT-AS) + +UE#2 sends a SIP 180 (Ringing) provisional response for the INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources upon receipt of 180. + +### 27-28 UPDATE request (CAT-AS to UE#1) see example in table A.5.8-8 + +The CAT-AS sends an UPDATE request containing the SDP offer based on the CAT media information received from MRF. + +Session between UE#1 and UE#2 is replaced with session between UE#1 and CAT-AS. + +**NOTE 1:** The AS will remain in the signalling path, i.e. work as a B2BUA, in order to align and maintain information in SDP for further exchanged messages between UE#1 and UE#2. + +**Table A.5.8-7: UPDATE request (CAT-AS to UE#1)** + +``` + +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: ;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74>+g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336158 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 5555::ccc:aaa:abc:abc +t=0 0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event + +``` + +``` + +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendonly +a=curr:qos remote none +a=des:qos mandatory local sendonly +a=des:qos mandatory remote recvonly +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 + +``` + +**SDP** The SDP offer (SDP\_O\_cat) contains a set of codecs to be used for CAT. The SDP content is based on information received from MRF, in this example, includes an additional video media description and related attributes. The local preconditions are indicated as fulfilled, and the remote preconditions are indicated as not fulfilled because UE#1 is expected to reserve additional resources for video media required by CAT-AS. + +### 29-30 200 (OK) response (UE#1 to CAT-AS) + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. UE#1 includes a SDP answer (SDP\_A\_cat) in the 200 (OK) response to the corresponding SIP UPDATE request. UE#1 starts to reserve CAT resources. The CAT-AS should not instruct MRF to start playing the CAT media unless the remote preconditions are indicated as fulfilled in SDP answer included in this 200 (OK) response or in SDP offer included in consequent UPDATE request. + +### 31-32 UPDATE request (UE#1 to CAT-AS) see example in table A.5.8-8 + +UE#1 indicates that it can receive CAT media as the necessary resources are available. + +The CAT-AS instructs MRF to start playing the CAT media. + +**Table A.5.8-8: UPDATE request (UE#1 to CAT-AS)** + +``` + +UPDATE sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , , +From: ;tag=171828 +To: ;tag=2236 +Call-ID: +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; ealg=aes-cbc; spi-c=98765432; spi- +s=87654321; port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +m=video 7398 RTP/AVPF 98 +b=AS:75 +a=curr:qos local sendonly +a=curr:qos remote recvonly +a=des:qos mandatory local sendonly +a=des:qos mandatory remote recvonly +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 + +``` + +**SDP:** The SDP offer (SDP\_O3) contains a set of codecs supported to be used for the session. The SDP content is based on information received from the CAT-AS in Step 27. The remote preconditions are indicated as fulfilled. + +**33-34 200 (OK) response to UPDATE request (CAT-AS to UE#1)** + +CAT-AS sends a SIP 200 (OK) UPDATE response for the SIP UPDATE request to UE#1. + +**35-36 180 (Ringing) provisional response (CAT-AS to UE#1)** + +CAT-AS sends a SIP 180 (Ringing) provisional response for the INVITE request to the UE#1. + +**37-38 200 (OK) response to INVITE request (UE#2 to CAT-AS)** + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**39-40 UPDATE request (CAT-AS to UE#1) see example in table A.5.8-9** + +The CAT-AS sends an UPDATE request containing values received in the 200 (OK) for UPDATE request from UE#2 in step 22. + +Session between UE#1 and CAT-AS is replaced with session between UE#1 and UE#2. + +NOTE 1: The AS will remain in the signalling path, i.e. work as a B2BUA, in order to align and maintain information in SDP for further exchanged messages between UE#1 and UE#2. + +**Table A.5.8-9: UPDATE request (CAT-AS to UE#1)** + +``` +UPDATE sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 SIP/2.0 +Via: SIP/2.0/UDP [5555::ccc:aaa:abc:abc]:8805;branch=z9hG4bK182D87.1 +Max-Forwards: 70 +Route: , +From: ;tag=2236 +To: ;tag=171828 +Call-ID: +Cseq: 12814111 UPDATE +Require: +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 29879336156 29879336158 IN IP6 5555::ccc:aaa:abc:abc +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=audio 8386 RTP/AVPF 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=rtpmap:96 telephone-event +``` + +**SDP:** The SDP offer (SDP\_O\_regular2) contains a set of codecs to be used for the session. The SDP content is based on information received from previous 200 (OK) response. + +**41-42 200 (OK) response (UE#1 to CAT-AS)** + +UE#1 sends a SIP 200 (OK) response for the SIP UPDATE request to CAT-AS. If the resources indicated for the media cannot be reused by the one reserved for the CAT media, UE#1 shall reserve necessary resources prior to + +sending the response. UE#1 includes a SDP answer (SDP\_A3) in the 200 (OK) response to the corresponding SIP UPDATE request. + +**43-44 200 (OK) response to INVITE request (CAT-AS to UE#1)** + +The CAT-AS sends the SIP 200 (OK) response for the (initial) SIP INVITE request to UE#1. + +**45-46 ACK request (UE#1 to CAT-AS)** + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to CAT-AS. + +**47-48 ACK request (CAT-AS to UE#2)** + +CAT-AS sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +NOTE 3: The ACK request from CAT-AS towards UE#2 may be sent after receiving 200 (OK) from UE#2 in step 18. + +--- + +## A.6 Interworking with CS domain + +### A.6.1 Introduction + +The following signalling flows show interworking with the CS domain, when CAT is provided by the terminating CS domain to the IMS, and when CAT is provided to the originating CS domain from the IMS. The following flows are included: + +- subclause A.6.2 shows CAT when CAT is provided by the terminating CS domain; +- subclause A.6.3 shows CAT, using the forking model, when CAT is provided to the originating CS domain; +- subclause A.6.4 shows CAT, using the early session, model, when CAT is provided to the originating CS domain; + +The signalling flow in subclause A.6.2 is not dependent on which CAT model is used. + +### A.6.2 CAT provided by the terminating CS domain + +![Sequence diagram showing the interaction between UE#1, MGCF, and CS. The sequence includes: 1. INVITE (SDP_O) from UE#1 to MGCF; 2. IAM from MGCF to CS; 3. 183 (Session Progress) (SDP_A) from MGCF to UE#1; 4. PRACK from UE#1 to MGCF; 5. 200 (OK) from MGCF to UE#1; 6. ACM from CS to MGCF; 7. ANM from CS to MGCF; 8. 200 (OK) from MGCF to UE#1; 9. ACK from UE#1 to MGCF. Internal CS messages include 'Resources available', 'Start CA media', and 'Stop CA media'.](9ba75f891de20483c291538e38701d96_img.jpg) + +``` +sequenceDiagram + participant UE#1 + participant MGCF + participant CS + + Note left of UE#1: Resources available + UE#1->>MGCF: 1. INVITE (SDP_O) + MGCF->>CS: 2. IAM + MGCF-->>UE#1: 3. 183 (Session Progress) (SDP_A) + UE#1->>MGCF: 4. PRACK + MGCF-->>UE#1: 5. 200 (OK) + CS->>MGCF: 6. ACM + Note right of CS: Start CA media + Note right of CS: Stop CA media + CS->>MGCF: 7. ANM + MGCF-->>UE#1: 8. 200 (OK) + UE#1->>MGCF: 9. ACK +``` + +Sequence diagram showing the interaction between UE#1, MGCF, and CS. The sequence includes: 1. INVITE (SDP\_O) from UE#1 to MGCF; 2. IAM from MGCF to CS; 3. 183 (Session Progress) (SDP\_A) from MGCF to UE#1; 4. PRACK from UE#1 to MGCF; 5. 200 (OK) from MGCF to UE#1; 6. ACM from CS to MGCF; 7. ANM from CS to MGCF; 8. 200 (OK) from MGCF to UE#1; 9. ACK from UE#1 to MGCF. Internal CS messages include 'Resources available', 'Start CA media', and 'Stop CA media'. + +Figure A.6.2-1: CAT provided by terminating CS system + +**1-2 INVITE request (UE#1 to MGCF) see example in table A.6.2-1** + +UE#1 sends a SIP INVITE request to the MGCF. + +The MGCF sends an ISUP IAM message to CS. + +**Table A.6.2-1: INVITE request (UE#1 to MGCF)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: IEEE-802.11a +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ; ++g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::aaa:bbb:ccc:ddd +s= +c=IN IP6 6666::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, gruu and the 199 provisional response. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by UE#1 and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +### 3 183 (Session Progress) provisional response (MGCF to UE#1) see example in table A.6.2-2 + +The MGCF sends a reliable SIP 183 (Session Progress) provisional response to UE#1. + +An early dialog is established between UE#1 and the MGCF. + +CAT media is received from CS. + +**Table A.6.2-2: 183 (Session Progress) response (MGCF to UE#1)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1pcscf1.visited1.net;branch=z9hG4bK240f34.1, + SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Recv-Info: infoDtmf +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendonly +Contact: ,+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp- + service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 6666::eee:fff:aaa:bbb +s=- +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=video 0 RTP/AVP 98 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**P-Early-Media:** The MGCF requests authorization for early media. + +**Recv-Info:** The MGCF indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs to be used for the session. The video stream is rejected. The local preconditions are indicated as fulfilled. + +#### 4 PRACK request (UE#1 to MGCF) + +UE#1 sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the MGCF. + +#### 5 200 (OK) response to PRACK request (MGCF to UE#1) + +The MGCF sends a SIP 200 (OK) response for the SIP PRACK request to UE#1. + +#### 6 ACM message (CS to MGCF) + +The MGCF receives an ISUP ACM message from CS. + +#### 7-8 200 (OK) response to INVITE request (MGCF to UE#1) + +The MGCF receives an ISUP ANM message from CS. + +The MGCF sends a SIP 200 (OK) response for the SIP INVITE request to UE#1. + +#### 9 ACK request (UE#1 to MGCF) + +UE#1 sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to the MGCF. + +## A.6.3 CAT provided to the originating CS domain with the CAT forking model + +![Sequence diagram showing the CAT provided to the originating CS domain with the CAT forking model. The diagram involves four lifelines: CS, MGCF, CAT-AS, and UE #2. The sequence of messages is as follows: 1. IAM from CS to MGCF; 2. INVITE (SDP_O) from MGCF to CAT-AS; 3. Reserve CAT resources (internal to CAT-AS); 4. INVITE (SDP_O) from CAT-AS to MGCF; 5. INVITE (SDP_O) from MGCF to UE #2; 6. 180 (Ringing) (D2) from UE #2 to MGCF; 7. 180 (Ringing) (D2) from MGCF to CAT-AS; 8. 183 (Session Progress) (SDP_A, D1) from CAT-AS to MGCF; 9. ACK (D1) from MGCF to CAT-AS; 10. Start CAT media (internal to CAT-AS); 11. 200 (OK) (PRACK, D1) from CAT-AS to MGCF; 12. 200 (OK) (SDP_A, D2) from MGCF to UE #2; 13. 200 (OK) (SDP_A, D2) from UE #2 to MGCF; 14. Stop CAT media (internal to CAT-AS); 15. 200 (OK) (SDP_A, D2) from MGCF to CAT-AS; 16. ACK (D2) from CAT-AS to UE #2; 17. ACM from MGCF to CS; 18. ANM from MGCF to CS.](ceb6fe29e2d57711907569c31182b3c2_img.jpg) + +``` + +sequenceDiagram + participant CS + participant MGCF + participant CAT-AS + participant UE#2 as UE #2 + + Note right of CAT-AS: Reserve CAT resources + Note right of CAT-AS: Start CAT media + Note right of CAT-AS: Stop CAT media + + CS->>MGCF: 1. IAM + MGCF->>CAT-AS: 2. INVITE (SDP_O) + CAT-AS->>CAT-AS: 3. Reserve CAT resources + CAT-AS->>MGCF: 4. INVITE (SDP_O) + MGCF->>UE#2: 5. INVITE (SDP_O) + UE#2->>MGCF: 6. 180 (Ringing) (D2) + MGCF->>CAT-AS: 7. 180 (Ringing) (D2) + CAT-AS->>MGCF: 8. 183 (Session Progress) (SDP_A, D1) + MGCF->>CAT-AS: 9. ACK (D1) + CAT-AS->>CAT-AS: 10. Start CAT media + CAT-AS->>MGCF: 11. 200 (OK) (PRACK, D1) + MGCF->>UE#2: 12. 200 (OK) (SDP_A, D2) + UE#2->>MGCF: 13. 200 (OK) (SDP_A, D2) + CAT-AS->>CAT-AS: 14. Stop CAT media + MGCF->>CAT-AS: 15. 200 (OK) (SDP_A, D2) + CAT-AS->>UE#2: 16. ACK (D2) + MGCF->>CS: 17. ACM + MGCF->>CS: 18. ANM + +``` + +Sequence diagram showing the CAT provided to the originating CS domain with the CAT forking model. The diagram involves four lifelines: CS, MGCF, CAT-AS, and UE #2. The sequence of messages is as follows: 1. IAM from CS to MGCF; 2. INVITE (SDP\_O) from MGCF to CAT-AS; 3. Reserve CAT resources (internal to CAT-AS); 4. INVITE (SDP\_O) from CAT-AS to MGCF; 5. INVITE (SDP\_O) from MGCF to UE #2; 6. 180 (Ringing) (D2) from UE #2 to MGCF; 7. 180 (Ringing) (D2) from MGCF to CAT-AS; 8. 183 (Session Progress) (SDP\_A, D1) from CAT-AS to MGCF; 9. ACK (D1) from MGCF to CAT-AS; 10. Start CAT media (internal to CAT-AS); 11. 200 (OK) (PRACK, D1) from CAT-AS to MGCF; 12. 200 (OK) (SDP\_A, D2) from MGCF to UE #2; 13. 200 (OK) (SDP\_A, D2) from UE #2 to MGCF; 14. Stop CAT media (internal to CAT-AS); 15. 200 (OK) (SDP\_A, D2) from MGCF to CAT-AS; 16. ACK (D2) from CAT-AS to UE #2; 17. ACM from MGCF to CS; 18. ANM from MGCF to CS. + +Figure A.6.3-1: CAT provided to originating CS system + +### 1-2 INVITE request (MGCF to CAT-AS) see example in table A.6.3-1 + +The MGCF receives an ISUP IAM message from CS. + +The MGCF sends a SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +**Table A.6.3-1: INVITE request (MGCF to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Privacy: none +P-Early-Media: supported +P-Asserted-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, 199 +Contact: ;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp- +service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::aaa:bbb:ccc:ddd +s=- +c=IN IP6 6666::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes=2 +a=rtpmap:96 telephone-event + +``` + +**Supported:** The MGCF indicates support for preconditions, reliable provisional responses, gruu and the 199 provisional response. + +**P-Early-Media:** The MGCF indicates support for the P-Early-Media header. + +**Recv-Info:** The MGCF indicates willingness to receive DTMF Info Packages in INFO requests. + +**Supported:** The MGCF indicates support for reliable provisional responses. + +**SDP:** The SDP offer (SDP\_O) contains a set of codecs supported by the MGCF and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +### 3-4INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the SIP INVITE request to UE#2. + +### 5-6180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the SIP INVITE request to the CAT-AS. + +The CAT-AS terminates the SIP 180 (Ringing) provisional response. + +### 7-8 183 (Session Progress) provisional response (CAT-AS to MGCF) see example in table A.6.3-2 + +The CAT-AS sends a reliable SIP 183 (Session Progress) provisional response to the MGCF. + +An early dialog (D1) is established between the MGCF and the CAT-AS. + +The MGCF sends an ISUP ACM message to CS. + +**Table A.6.3-2: 183 (Session Progress) response (CAT-AS to MGCF)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Recv-Info: infoDtmf +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +P-Early-Media: sendrecv +Contact: +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::eee:fff:bbb:aaa +s= +c=IN IP6 5555::eee:fff:bbb:aaa +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes +a=content:g.3gpp.cat + +``` + +**P-Early-Media:** The CAT-AS requests authorization for early media. + +**Recv-Info:** The CAT-AS indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +## 9 PRACK request (MGCF to CAT-AS) + +The MGCF sends a SIP PRACK request, which acknowledges the SIP 183 (Session Progress) provisional response, to the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +## 10 200 (OK) response to PRACK request (CAT-AS to MGCF) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to the MGCF. + +## 11-12 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.6.3-3 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.6.3-3: 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +From: +To: ;tag=6322 +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 6666::eee:fff:aaa:bbb +s= +c=IN IP6 6666::eee:fff:aaa:bbb +t=0 0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; maxframes + +``` + +**SDP:** The SDP answer (SDP\_A) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +### 13-14 200 (OK) response to INVITE request (CAT-AS to MGCF) + +The CAT-AS forwards the SIP 200 (OK) response to the MGCF. + +A dialog (D2) is established between the MGCF and UE#2. + +The early dialog (D1) between the MGCF and the CAT-AS is terminated. + +The MGCF sends an ISUP ANM message to CS. + +### 15 ACK request (MGCF to UE#2) + +The MGCF sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +## A.6.4 CAT provided to the originating CS domain with the CAT early session model + +![Sequence diagram showing CAT provided to originating CS domain with the CAT early-session model. Lifelines: CS, MGCF, CAT-AS, UE #2. The sequence includes messages like 1. IAM, 2. INVITE (SDP_O), Reserve CAT resources, 3. INVITE (SDP_O), 4. 180 (Ringing), 5. 180 (Ringing) (early-session SDP_O), 6. ACM / CPG, 7. PRACK (early-session SDP_A), Start CAT media, 8. 200 (OK), 9. 200 (OK) (SDP_A), Stop CAT media, 10. 200 (OK) (SDP_A), 11. ANM, and 12. ACK.](223792b3652794024244c277cc46394b_img.jpg) + +``` +sequenceDiagram + participant CS + participant MGCF + participant CAT-AS + participant UE#2 as UE #2 + + Note right of CAT-AS: Error: Reference source not + + CS->>MGCF: 1. IAM + MGCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CAT resources + CAT-AS->>UE#2: 3. INVITE (SDP_O) + UE#2-->>CAT-AS: 4. 180 (Ringing) + CAT-AS-->>MGCF: 5. 180 (Ringing) (early-session SDP_O) + MGCF-->>CS: 6. ACM / CPG + MGCF->>CAT-AS: 7. PRACK (early-session SDP_A) + Note right of CAT-AS: Start CAT media + CAT-AS-->>MGCF: 8. 200 (OK) + UE#2-->>CAT-AS: 9. 200 (OK) (SDP_A) + Note right of CAT-AS: Stop CAT media + CAT-AS-->>MGCF: 10. 200 (OK) (SDP_A) + MGCF-->>CS: 11. ANM + MGCF->>UE#2: 12. ACK +``` + +Sequence diagram showing CAT provided to originating CS domain with the CAT early-session model. Lifelines: CS, MGCF, CAT-AS, UE #2. The sequence includes messages like 1. IAM, 2. INVITE (SDP\_O), Reserve CAT resources, 3. INVITE (SDP\_O), 4. 180 (Ringing), 5. 180 (Ringing) (early-session SDP\_O), 6. ACM / CPG, 7. PRACK (early-session SDP\_A), Start CAT media, 8. 200 (OK), 9. 200 (OK) (SDP\_A), Stop CAT media, 10. 200 (OK) (SDP\_A), 11. ANM, and 12. ACK. + +Figure A.6.4-1: CAT provided to originating CS domain with the CAT early-session model + +1-2. INVITE request (MGCF to CAT-AS) see example in table A.6.4-2 + +The MGCF receives an ISUP IAM message from CS domain. + +The MGCF sends a SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to reserve CAT resources. + +**Table A.6.4-2: INVITE request (MGCF to CAT-AS)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Privacy: none +P-Asserted-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Accept-Contact: *;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Recv-Info: infoDtmf +Supported: precondition, 100rel, gruu, early-session +Contact: ;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp- +service.ims.icsi.mmtel" +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3400 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +a=rtpmap:99 MP4V-ES +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +**Supported:** The UE indicates support for preconditions, reliable provisional responses, gruu and early-session disposition type. + +**Recv-Info:** The UE indicates willingness to receive DTMF Info Packages in INFO requests. + +**SDP** The SDP offer (SDP\_O) contains a set of codecs supported by the MGCF and desired by the calling user for this session. The local preconditions are indicated as fulfilled. + +### 3 INVITE request (CAT-AS to UE#2) + +The CAT-AS forwards the SIP INVITE request to UE#2. + +### 4 180 (Ringing) provisional response (UE#2 to CAT-AS) + +The called party is alerted. UE#2 sends a SIP 180 (Ringing) provisional response for the SIP INVITE request to the CAT-AS. + +### 5 180 (Ringing) provisional response (CAT-AS to MGCF) see example in table A.6.4-5 + +The CAT-AS sends a reliable SIP 180 (Ringing) provisional response to the MGCF. + +**Table A.6.4-5: SIP 180 (Ringing) responses (CAT-AS to MGCF)** + +``` + +SIP/2.0 180 Ringing +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +From: +To: ;tag=2236 +Call-ID: +Cseq: +Require: 100rel +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +RSeq: 9022 +Contact: ;+g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Disposition: early-session +Content-Length: (...) + +v=0 +o= 2987933616 2987933616 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 10001 RTP/AVP 98 99 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=conf:qos remote sendrecv +a=rtpmap:98 H263 +a=rtpmap:99 MP4V-ES +a=fmtp:98 profile-level-id=0 +a=content:g.3gpp.cat +m=audio 6544 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=conf:qos remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=content:g.3gpp.cat + +``` + +**Early Session SDP** The early session SDP offer (early-session SDP\_O) contains a set of codecs supported to be used for CAT and, in this example, includes a SDP "a=content" attribute with a "g.3gpp.cat" value for each media description. The SDP content is based on information received from the MRF. The local preconditions are indicated as fulfilled. + +## 6 ACM/CPG message (MGCF to CS domain) + +The MGCF sends an ACM or CPG message to CS domain. + +If the IMS CAT is multimedia, the MGCF shall take an indication in ACM or CPG message which instructs originating MSC to initiate H.245 negotiation between CS user and MGCF. + +NOTE: How to take the indication in ACM or CPG message is out of scope of this specification. + +## 7 PRACK request (MGCF to CAT AS) see example in table A.6.4-7 + +The MGCF sends a SIP PRACK request, which acknowledges the SIP 180 (Ringing) provisional response, to the CAT-AS. + +An early dialog using early-session SDP is established between the MGCF and the CAT-AS. + +The CAT-AS instructs the MRF to play CAT media. + +**Table A.6.4-7: SIP PRACK Request (MGCF to CAT AS)** + +``` + +PRACK sip:cat-as.home1.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: +From: ;tag=171828 +To: ;tag=2236 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 128 PRACK +Require: precondition +RAck: 9022 127 INVITE +Content-Type: application/sdp +Content-Disposition: early-session +Content-Length: (...) + +v=0 +o= 2987933616 2987933616 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 3402 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3458 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +**Early Session SDP** The early session SDP answer (early-session SDP\_A) contains a set of codecs to be used for the CAT. If preconditions are used, they are indicated as fulfilled. + +#### 8 200 (OK) response to PRACK request (CAT-AS to MGCF) + +The CAT-AS sends a SIP 200 (OK) response for the SIP PRACK request to the MGCF. + +#### 9 200 (OK) response to INVITE request (UE#2 to CAT-AS) see example in table A.6.4-9 + +The called party answers the call. UE#2 sends a SIP 200 (OK) final response for the SIP INVITE request to the CAT-AS. + +The CAT-AS instructs the MRF to stop CAT media. + +**Table A.6.4-9: SIP 200 (OK) response (UE#2 to CAT-AS)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pcscf2.home2.net;branch=z9hG4bK764XC12.1, SIP/2.0/UDP + catas.home2.net;branch=z9hG4bK764Q32.1, SIP/2.0/UDP + pcscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Contact: ; + +g.3gpp.icsi_ref="urn%3Aurn-7%3gpp-service.ims.icsi.mmtel" +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::ggg:hhh:iii:jjj +s= +c=IN IP6 5555::ggg:hhh:iii:jjj +t=0 0 +m=video 3400 RTP/AVP 98 +b=AS:75 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:98 H263 +a=fmtp:98 profile-level-id=0 +m=audio 3456 RTP/AVP 97 96 +b=AS:25.4 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +**SDP** The SDP answer (SDP\_A) contains a set of codecs to be used for the session. If preconditions are used, they are indicated as fulfilled. + +#### 10-11 200 (OK) responses to INVITE request (CAT-AS to MGCF) + +The CAT-AS forwards the SIP 200 (OK) response to the MGCF. + +The dialog for session is established between the MGCF and UE#2. + +The early dialog using early-session SDP between the MGCF and the CAT-AS is terminated. + +The MGCF sends an ISUP ANM message to CS domain. + +#### 12 ACK request (MGCF to UE#2) + +The MGCF sends a SIP ACK request, which acknowledges the SIP 200 (OK) final response, to UE#2. + +--- + +## Annex B (normative): SDP a=content attribute "g.3gpp.cat" value + +### B.1 Introduction + +This annex provides the IANA registration information for a new value, g.3gpp.cat, for the SDP a=content media-level attribute defined in RFC 4796 [12]. The attribute value is used indicate that an SDP media descriptions is associated with the CAT service. + +### B.2 New value + +IANA registration table: "content SDP Parameters" table of "Session Description Protocol (SDP) Parameters" registry + +SDN name: g.3gpp.cat + +Description: Stream associated with the 3GPP Customized Alerting Ringtone (CAT) service. + +Reference: 3GPP TS 24.182 + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|------------|-----------|------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2008-06 | | | | | TS skeleton from Rapporteur | | 0.0.0 | +| 2008-07 | CT1#54 | | | | Implemented C1-0082446, C1-082663, C1-082664, C1-082771 from CT1#54 | | 0.1.0 | +| 2008-08 | CT1#55 | | | | Implemented C1-082960, C1-083205, C1-083375 from CT1#55 | | 0.2.0 | +| 2008-09 | | | | | Version 1.0.0 created for presentation to TSG CT#41 for information | 0.2.0 | 1.0.0 | +| 2008-10 | CT1#55 bis | | | | Implemented the following from CT1#55bis: C1-083641, C1-083649, C1-083650, C1-083651, C1-083652, C1-083653, C1-083895, C1-083913, C1-083914, C1-084250, C1-084251, C1-084252, C1-084254, C1-084255, C1-084257, C1-084258, C1-084259, C1-084426, C1-084427 | | 1.1.0 | +| 2008-11 | CT1#56 | | | | Implemented the following from CT1#56: C1-084681, C1-085103, C1-085104, C1-085279, C1-085281, C1-085282, C1-085283, C1-085284, C1-085285, C1-085286, C1-085287, C1-085458 | | 1.2.0 | +| 2008-11 | | | | | Version 2.0.0 created for presentation to TSG CT#42 for approval | 1.2.0 | 2.0.0 | +| 2008-12 | CT#42 | | | | Version 8.0.0 created after approval in CT#42 | 2.0.0 | 8.0.0 | +| 2009-03 | CT#43 | CP-090155 | 0007 | | Interaction with ECT | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090155 | 0008 | 1 | Correction on UE response for UPDATE in Gateway model | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090155 | 0009 | 2 | No user configuration specified for IMS CAT | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090155 | 0011 | 2 | Flow Updates | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090155 | 0012 | 2 | Intercation between CAT and CDIV | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090162 | 0002 | 1 | Actions at the AS serving the originating UE | 8.1.0 | 9.0.0 | +| 2009-03 | CT#43 | CP-090162 | 0003 | 2 | CAT copy | 8.1.0 | 9.0.0 | +| 2009-03 | CT#43 | CP-090162 | 0014 | 1 | CAT Stop | 8.1.0 | 9.0.0 | +| 2009-06 | CT#44 | CP-090429 | 0015 | | Clarification of the CAT AS when acting as a Proxy or B2BUA | 9.0.0 | 9.1.0 | +| 2009-06 | CT#44 | CP-090429 | 0018 | 1 | CAT Priority | 9.0.0 | 9.1.0 | +| 2009-06 | CT#44 | CP-090429 | 0019 | 1 | Signalling flows for gateway model with CFNR | 9.0.0 | 9.1.0 | +| 2009-06 | CT#44 | CP-090429 | 0021 | 1 | Introduce Re-INVITE into gateway model | 9.0.0 | 9.1.0 | +| 2009-06 | CT#44 | CP-090406 | 0022 | | Correction of callflow for CAT | 9.0.0 | 9.1.0 | +| 2009-09 | CT#45 | CP-090661 | 0024 | 2 | Correction: CAT and OIR interaction | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090661 | 0026 | 1 | Correction: CAT and OIP interaction | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090681 | 0027 | 2 | Add CAT Stop function to the AS serving the originating UE | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090681 | 0028 | 3 | Add DTMF support for O-CAT AS | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090681 | 0029 | 3 | Add DTMF support for T-CAT AS | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090681 | 0030 | 2 | Add DTMF support for originating UE to support CAT controll | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090681 | 0033 | 1 | Modify priority handling for AS serving originator for early-session model | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-090681 | 0034 | 1 | CAT Reject | 9.1.0 | 9.2.0 | + +| | | | | | | | | +|---------|-------|---------------|------|---|-----------------------------------------------------------------------------------|--------|--------| +| 2009-09 | CT#45 | CP-09068
2 | 0036 | 1 | Clarification for the CAT flow | 9.1.0 | 9.2.0 | +| 2009-09 | CT#45 | CP-09068
1 | 0038 | 2 | Signalling flows for gateway model with CFU | 9.1.0 | 9.2.0 | +| 2009-12 | CT#46 | CP-09092
1 | 0040 | 1 | Clarification of the requirements on the network side | 9.2.0 | 9.3.0 | +| 2009-12 | CT#46 | CP-09092
1 | 0041 | 2 | correction of CAT Copy and CAT stop procedures | 9.2.0 | 9.3.0 | +| 2009-12 | CT#46 | CP-09092
1 | 0042 | 1 | Clean up the CAT | 9.2.0 | 9.3.0 | +| 2009-12 | CT#46 | CP-09092
1 | 0044 | 1 | CAT Gateway model callflow correction | 9.2.0 | 9.3.0 | +| 2009-12 | CT#46 | CP-09090
4 | 0047 | | Removal of editor's note in 24.182 | 9.2.0 | 9.3.0 | +| 2010-03 | CT#47 | CP-10013
3 | 0051 | 3 | CAT: Actions at the AS serving the originating UE for the forking model | 9.3.0 | 9.4.0 | +| 2010-03 | CT#47 | CP-10013
3 | 0052 | 1 | CAT: Usage of P-Early-Media for the forking model | 9.3.0 | 9.4.0 | +| 2010-03 | CT#47 | CP-10013
3 | 0053 | | CAT: Addition of DTMF Info Package | 9.3.0 | 9.4.0 | +| 2010-03 | CT#47 | CP-10011
3 | 0055 | | CAT: Correction regarding converting received provisional response codes to 183 | 9.3.0 | 9.4.0 | +| 2010-06 | CT#48 | CP-10035
2 | 0056 | 1 | Removal of editor's notes in 24.182 | 9.4.0 | 9.5.0 | +| 2010-06 | CT#48 | CP-10035
2 | 0060 | | Interaction with CRS | 9.4.0 | 9.5.0 | +| 2010-06 | CT#48 | CP-10029
9 | 0061 | | Modification of the AS procedure in forking model | 9.4.0 | 9.5.0 | +| 2010-06 | CT#48 | CP-10037
1 | 0058 | 1 | Correction of the P-Early-Media header value | 9.5.0 | 10.0.0 | +| 2010-12 | CT#50 | CP-10072
9 | 0064 | 1 | CAT GW Model for originating and terminating UEs with pre-conditions | 10.0.0 | 10.1.0 | +| 2011-03 | CT#51 | CP-11017
3 | 0066 | | Reference update: RFC 6086 | 10.1.0 | 10.2.0 | +| 2011-06 | CT#52 | CP-11044
3 | 0072 | 2 | Correction on AS actions for forking model and early session model | 10.2.0 | 10.3.0 | +| 2012-09 | CT#57 | | | | Upgrade to Rel-11 | 10.3.0 | 11.0.0 | +| 2013-09 | CT#61 | CP-13048
7 | 0075 | 1 | Correction of IANA registration of g.3gpp.cat | 11.0.0 | 11.1.0 | +| 2014-06 | CT#64 | CP-14033
0 | 0078 | 3 | Correction on CAT flow of gateway model | 11.1.0 | 12.0.0 | +| 2015-03 | CT#67 | CP-15005
1 | 0084 | | RFC number correction on CAT | 12.0.0 | 12.1.0 | +| 2015-03 | CT#67 | CP-15008
2 | 0079 | 3 | CAT AS store media type | 12.1.0 | 13.0.0 | +| 2015-03 | CT#67 | CP-15008
2 | 0080 | 1 | CAT handling of UPDATE sent between 180 and 200 OK | 12.1.0 | 13.0.0 | +| 2015-06 | CT#68 | CP-15032
8 | 0085 | 2 | Addition of missing AS actions for CAT gateway model on receiving initial INVITE | 13.0.0 | 13.1.0 | +| 2015-06 | CT#68 | CP-15032
8 | 0086 | | Addition of missing AS actions for CAT gateway model on receiving 18x response | 13.0.0 | 13.1.0 | +| 2015-06 | CT#68 | CP-15032
8 | 0087 | 1 | Addition of missing AS actions for CAT gateway model to start CAT media | 13.0.0 | 13.1.0 | +| 2015-06 | CT#68 | CP-15032
8 | 0088 | | Addition of missing AS actions for CAT gateway model on receiving 200 OK response | 13.0.0 | 13.1.0 | +| 2015-06 | CT#68 | CP-15032
8 | 0089 | 1 | Correction of call flow example for CAT | 13.0.0 | 13.1.0 | +| 2016-06 | CT#72 | CP-16033
2 | 0092 | 3 | Clarification on CAT AS procedure for handling of P-Early-Media header | 13.1.0 | 14.0.0 | +| 2016-06 | CT#72 | CP-16033
2 | 0093 | 2 | Condition of setting SDP in SIP 18x response for CAT Gateway model | 13.1.0 | 14.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-12 | CT-78 | CP-173068 | 0094 | 4 | F | Correction of the procedure for stopping/restarting the provision of CAT media | 14.1.0 | +| 2018-03 | CT-79 | CP-180057 | 0102 | 1 | A | Removing Editor's Notes after IANA registration | 14.2.0 | +| 2018-03 | CT-79 | CP-180090 | 0096 | 3 | F | Support for video CAT service within audio call in TS 24.182 | 15.0.0 | +| 2018-03 | CT-79 | CP-180090 | 0104 | | F | Correction of message examples for the CAT gateway model | 15.0.0 | +| 2018-03 | CT-79 | CP-180090 | 0105 | | B | Video CAT for forking model | 15.0.0 | +| 2019-06 | CT-84 | CP-191147 | 0106 | 3 | B | Support for playing customized media before alerting in TS 24.182 | 16.0.0 | +| 2019-06 | CT-84 | CP-191147 | 0108 | 3 | B | Support to continue to play video CAT without voice during audio conversation | 16.0.0 | +| 2019-06 | CT-84 | CP-191147 | 0109 | 3 | F | UE actions clarification of CAT for gateway model | 16.0.0 | +| 2019-09 | CT-85 | CP-192071 | 0111 | 3 | B | Corrections on AS actions for playing CAT media continually during conversationy | 16.1.0 | +| 2019-09 | CT-85 | CP-192071 | 0112 | 2 | F | Corrections of the NOTE for playing customized media before alerting | 16.1.0 | +| 2020-03 | CT-87e | CP-200123 | 0118 | 1 | B | CAT interactions with MuD and MiD services | 16.2.0 | +| 2020-06 | CT-88e | CP-201111 | 0119 | 2 | B | Use preconditions for CAT when originating UE supports precondition | 16.3.0 | +| 2020-06 | CT-88e | CP-201111 | 0120 | 1 | F | Preconditions correction for forking model | 16.3.0 | +| 2020-07 | CT-88e | | | | | Editorial corrections | 16.3.1 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24196/raw.md b/marked/Rel-16/24_series/24196/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b51733b54493c633c28a04e42bb80b3104cac2e1 --- /dev/null +++ b/marked/Rel-16/24_series/24196/raw.md @@ -0,0 +1,434 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Enhanced Calling Name (eCNAM)..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 Service Description ..... | 7 | +| 4.2.1 General Description..... | 7 | +| 4.3 Operational Requirements..... | 7 | +| 4.3.1 Provision/withdrawal..... | 7 | +| 4.3.2 Requirements on the Originating Network..... | 7 | +| 4.3.3 Requirements on the Terminating Network ..... | 8 | +| 4.3.3.1 Data Sources ..... | 8 | +| 4.5 Signalling Procedures..... | 8 | +| 4.5.1 General ..... | 8 | +| 4.5.2 Activation/Deactivation..... | 8 | +| 4.5.3 Invocation and Operation ..... | 9 | +| 4.5.3.1 Actions at the Originating UE ..... | 9 | +| 4.5.3.2 Actions at the AS serving the Originating UE..... | 9 | +| 4.5.3.3 Actions at the AS serving the Terminating UE ..... | 9 | +| 4.5.3.3.1 Identity not available..... | 9 | +| 4.5.3.3.2 Identity available, presentation not allowed..... | 9 | +| 4.5.3.3.3 Identity available, originating user identity verified and passed, presentation allowed ..... | 9 | +| 4.5.3.3.4 Identity available, verification failed ..... | 10 | +| 4.5.3.4 Actions at the Terminating UE ..... | 10 | +| 4.6 Interaction with other Services..... | 11 | +| 4.6.1 Originating Identification Presentation (OIP) ..... | 11 | +| 4.6.2 Originating Identification Restriction (OIR) ..... | 11 | +| 4.6.3 Terminating Identification Presentation / Terminating Identification Restriction (TIP/TIR) ..... | 11 | +| 4.6.4 Advice of Charge..... | 11 | +| 4.6.5 Communication Waiting (CW) ..... | 11 | +| 4.6.6 Communication Hold ..... | 11 | +| 4.6.7 Explicit Communication Transfer (ECT)..... | 11 | +| 4.6.8 Closed User Group (CUG) ..... | 11 | +| 4.6.9 Completion of Communications to Busy Subscriber (CCBS) ..... | 11 | +| 4.6.10 Communication Diversion (CDIV)..... | 12 | +| 4.6.11 Malicious Communication Identification (MCID)..... | 12 | +| 4.6.12 Anonymous Communication Rejection (ACR) and Incoming Communications Barring (ICB)..... | 12 | +| 4.6.13 Message Waiting Indication (MWI)..... | 12 | +| 4.6.14 Flexible Alerting (FA) ..... | 12 | +| 4.6.15 Personal Network Management (PNM) ..... | 12 | +| 4.6.16 Multi-Device (MuD) ..... | 12 | +| 4.6.17 Multi-Identity (MiD) ..... | 12 | +| 4.7 Parameter values (timers)..... | 12 | +| Annex A (informative): Change history..... | 13 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the stage three (protocol description) of the Enhanced Calling Name (eCNAM) supplementary service based on stage one description in 3GPP TS 22.173 [1]. It provides the protocol details in the IP Multimedia (IM) Core Network (CN) subsystem (see 3GPP TS 24.229 [2]) based on the Session Initiation Protocol (SIP) (see RFC 3261 [3]) where the eCNAM data is retrieved by the terminating network from trusted data sources. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 22.173: "IP Multimedia Core Network Subsystem (IMS) Multimedia Telephony Service and supplementary services". +- [2] 3GPP TS 24.229: "IP Multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [3] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [4] 3GPP TS 23.003: "Numbering, addressing and identification". +- [5] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Network Asserted Identity within Trusted Networks". +- [6] IETF RFC 3323: "A Privacy Mechanism for the Session Initiation Protocol (SIP)". +- [7] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [8] 3GPP TS 24.604: "Communication Diversion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem". +- [9] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". +- [10] ITU-T Recommendation E.164 (11/2010): "The international public telecommunication numbering plan". +- [11] ITU-T Recommendation I.210 (03/1993): "Principles of telecommunication services supported by an ISDN and the means to describe them". + +# --- 3 Definitions and abbreviations + +For the purposes of the present document, the following definitions and abbreviations apply. + +## 3.1 Definitions + +For the purposes of the present document, the following definitions and abbreviations apply: + +**Identity information:** all the information identifying a user, including trusted (network generated) and/or untrusted (user generated) addresses. + +NOTE: Identity information takes the form of either a SIP URI (see RFC 3261 [3]) or a tel URI (see RFC 3966 [7]). + +**Originating UE:** sender of a SIP request intended to initiate either a dialog (e.g. INVITE, SUBSCRIBE), or a standalone transaction. + +**Private information:** information that according to RFC 3323 [6] and RFC 3325 [5] is not permitted to be delivered to the remote end. + +**Searchkey:** a user identity employed to retrieve the eCNAM data associated with that identity from the appropriate data sources. + +**terminating UE:** recipient of a SIP request intended either to initiate a dialog or to initiate either a dialog or a standalone transaction + +**trusted identity information:** network generated user public identity information + +For the purposes of the present document, the following definitions given in RFC 3261 [3] apply. + +**header** + +**header field** + +**request** + +**response** + +**session** + +**(SIP) transaction** + +For the purposes of the present document, the following definitions given in ITU-T Recommendation I.210 [11] apply: + +**supplementary service** + +**E.164 telephone number:** telephone number formatted according to ITU-T. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply. + +| | | +|-------|------------------------------------------------| +| 3GPP | 3 rd Generation Partnership Project | +| ACR | Anonymous Communication Rejection | +| AS | Application Server | +| CCBS | Completion of Communication to Busy Subscriber | +| CDIV | Communication DIVersion | +| CN | Core Network | +| CUG | Closed User Group | +| CW | Communication Waiting | +| eCNAM | Enhanced Calling Name | +| ECT | Explicit Communication Transfer | +| FA | Flexible Alerting | +| HOLD | Communication Hold | +| ICB | Incoming Communications Barring | +| IETF | Internet Engineering Task Force | +| IM | IP Multimedia | +| IMS | IP Multimedia Subsystem | +| IP | Internet Protocol | +| MCID | Malicious Communication Identification | +| MiD | Multi-iDentity | +| MuD | Multi-Device | +| MWI | Message Waiting Indication | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| PNM | Personal Network Management | +| SDP | Session Description Protocol | +| SIP | Session Initiation Protocol | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | +| TN | Telephone Number | +| UE | User Equipment | + +# 4 Enhanced Calling Name (eCNAM) + +## 4.1 Introduction + +The eCNAM service provides the terminating user with the name associated with the originating user and optionally delivers metadata about that originating user. While eCNAM is a terminating service, the eCNAM operations rely on information received from the originating network, such as the originating user's E.164 telephone number (TN) to retrieve eCNAM data from trusted data sources (via methods outside the scope of this specification). + +## 4.2 Service Description + +### 4.2.1 General Description + +The eCNAM service provides the terminating user with a name that identifies the originating user, and metadata about that originating user (e.g., address, language). + +**NOTE:** The terminating service provider retrieves the name and metadata from pre-selected data sources. The terminating service provider can also partner with analytics providers that offer risk indicators about the incoming call (e.g., known perpetrators of scams) as part of the metadata eCNAM delivers. + +To retrieve eCNAM data, the service provider formulates queries using a searchkey to retrieve the name and metadata. The searchkey is a user identity obtained from the incoming SIP INVITE. Most commonly, the service provider uses an E.164 TN as that searchkey. Other identities could be used to retrieve the eCNAM data. + +If the terminating network determines that the telephone number's (or other identity's) presentation is restricted (i.e., not to be presented to the end user), the eCNAM data will also be restricted. + +If the terminating network determines that the telephone number (or other identity's) presentation is not restricted (i.e., to be presented to the end user), the eCNAM data will also be presented to the end user with no restriction. + +## 4.3 Operational Requirements + +### 4.3.1 Provision/withdrawal + +The eCNAM service can be provided after prior arrangement with the service provider. + +The eCNAM service can be withdrawn at the subscriber's request or for administrative reasons. + +### 4.3.2 Requirements on the Originating Network + +eCNAM is a terminating service, however, the eCNAM operations rely on information received from the originating network. + +If the originating user identity, such as the originating user's E.164 TN, is not delivered by the originating network to the terminating network, the terminating service provider will not be able to retrieve eCNAM data from the relevant data sources. + +**NOTE:** The searchkey element necessary for retrieving eCNAM data from the relevant data source is, in most cases, restricted to the originating user's E.164 TN for most databases. However, other user identities can be used as searchkey elements. + +The originating network can support a verification capability, such as the number verification capability described in 3GPP TS 24.229 [2]. Without a verification capability at the originating network, the integrity of the eCNAM data retrieved could be impacted. + +### 4.3.3 Requirements on the Terminating Network + +#### 4.3.3.1 Data Sources + +The eCNAM service involves the retrieval of the name data and the additional caller information from data sources that the terminating service provider has access to, based on service provider policy. + +The special arrangements and interfaces between the terminating service provider and the data sources are outside the scope of this document and are subject to operator procedures. + +NOTE 1: The accuracy of the name information and the metadata about the caller varies among sources; therefore, the terminating service provider exercises a choice of which source to use. The interfaces and protocols used to retrieve the data are typically negotiated between the terminating service provider and the data source. + +NOTE 2: The terminating service provider pre-determines the elements of metadata that will be delivered on each call to eCNAM subscribers. The set of metadata varies from one service provider to another. + +## 4.4 Syntax Requirements + +The syntax for the header fields are normatively described in 3GPP TS 24.229 [2]. The relevant headers are: + +- The P-Asserted-Identity header field which shall conform to the specifications in RFC 3325 [5] and RFC 3966 [7]. +- The Identity header field which shall conform to the specifications in RFC 8224 [9]. +- The Call-Info header field which shall conform to the specifications in RFC 3261 [3]. +- The Privacy header field which shall conform to the specifications in RFC 3323 [6] and RFC 3325 [5]. + +NOTE: The privacy level "session" and "critical" are not used in this specification. + +- The From header field which shall conform to the specifications in RFC 3261 [3] and RFC 3966 [7]. + +## 4.5 Signalling Procedures + +### 4.5.1 General + +Configuration of the eCNAM is performed by the service provider. + +### 4.5.2 Activation/Deactivation + +The service provider activates the eCNAM service at provisioning, upon the user's request. + +The service provider deactivates the service at withdrawal upon the user's request. + +No user configuration is defined in this release. + +### 4.5.3 Invocation and Operation + +#### 4.5.3.1 Actions at the Originating UE + +No actions at the originating UE. + +#### 4.5.3.2 Actions at the AS serving the Originating UE + +No actions at the AS serving the originating UE. + +#### 4.5.3.3 Actions at the AS serving the Terminating UE + +##### 4.5.3.3.1 Identity not available + +eCNAM is a terminating service; however, the eCNAM operations rely on information received from the originating network. + +If the incoming INVITE does not include the user's E.164 TN in the "tel" URI or the 'user element' of the SIP URI, the terminating AS will not be able to retrieve eCNAM data from the relevant data sources. Based on service provider policy, the AS uses the E.164 TN in either the incoming From header field or the incoming P-Asserted-Identity header field to request eCNAM data from the trusted data sources. + +If this information is not received in the incoming INVITE or is not available from the data sources (missing data or query timeouts) then the terminating AS shall consider the eCNAM data unavailable. + +As a result, the terminating AS shall, according to local policy, populate the text string "Unavailable" in the "display-name" parameter of the outgoing From header field and/or P-Asserted-Identity header field in the SIP INVITE request that the terminating AS sends to the terminating UE. + +If some elements of the eCNAM metadata are unavailable (e.g., requested data elements could not be found in the data source), the terminating AS shall deliver the available data to the terminating UE in Call-Info header fields, and shall not deliver the string "unavailable" for the missing elements. + +##### 4.5.3.3.2 Identity available, presentation not allowed + +If the terminating AS receives a Privacy header field set to any of the priv-values "id", "user" or "header" (i.e., presentation is not allowed), then the terminating AS shall populate the text string "Anonymous" in the "display-name" parameter of the From header field in the SIP INVITE request that the AS sends to the terminating UE. The full SIP URI for Anonymous User Identity is described in 3GPP TS 23.003 [4]. + +The metadata may be sent to the terminating UE, based on service provider policy. + +NOTE: The service provider may allow delivery of only the metadata (such as analytics), if allowed by local and national policies to caution users against fraudsters disguised with anonymous identities. + +##### 4.5.3.3.3 Identity available, originating user identity verified and passed, presentation allowed + +The terminating AS shall consider that the user identity presentation is allowed when there is no Privacy header field in the received INVITE or a Privacy header field set to priv-value "none". + +If the identity presentation is allowed and the result of the originating user identity verification performed (such as the verification resulting in the "verstat" tel URI parameter described in 3GPP TS 24.229 [2]) shows the verification passed, the AS shall proceed to retrieve eCNAM data from the trusted sources. + +The AS shall extract the originating identity from the incoming INVITE in order to formulate the query to the trusted data sources. It is based on service provider policy to decide whether the identity retrieved from the P-Asserted-Identity header field, the From header field or both with a priority order. + +If the chosen identity is the E.164 TN, the following procedures shall apply: + +- 1 The terminating AS shall extract the TN from the username portion of the incoming SIP URI request of the incoming From header field or P-Asserted-Identity header field, if user=phone parameter is present. +- 2 If user=phone is not present in the SIP URI, the terminating AS shall extract the TN from the tel URI of the incoming From header field or P-Asserted-Identity header field. +- 3 If both a SIP URI with user=phone present, and a tel URI are available, the terminating AS shall extract the TN from the tel URI of the incoming From header field or P-Asserted-Identity header field. +- 4 The terminating AS will query the appropriate data source(s) using the extracted TN. + +NOTE 1: The labels/titles of the data elements are known to the terminating service provider based on their arrangements with the data sources. + +NOTE 2: Semantic translation is outside the scope of the present document. + +NOTE 3: In addition to plain text, the Call-Info header field supports the delivery of icons, which may be needed if analytics results include symbols to be displayed on the UE. + +The terminating AS shall populate the received name (retrieved from data sources) in the "display-name" parameter of the From header field or the P-Asserted-Identity header field in the INVITE request being sent to the UE. + +The terminating AS shall populate the received metadata elements in one or more Call-Info header fields. + +NOTE 4: The eCNAM metadata elements can include information about the caller's language, address, email, or type of business and more. The metadata can also include the results of analytics that the service provider makes available to the user directly or through third party affiliations. The analytics can contain text and icons about the originating user. + +If other name information is received in the INVITE request, the terminating service provider local policy shall apply. The AS may discard the received name data. + +##### 4.5.3.3.4 Identity available, verification failed + +If the originating user identity verification performed (such as the verification resulting in the "verstat" tel URI parameter described in 3GPP TS 24.229 [2]) shows that verification failed, the terminating AS may deliver partial or no eCNAM information to the subscriber's UE. + +As a result, and based on terminating service provider policy, the terminating AS may perform one or more of the following actions: + +- The AS may remove the display-name of the From header field or the P-Asserted-Identity header field in the INVITE request being sent to the UE; +- The AS may populate a text string of the terminating service provider's choice in the display-name of the From header field or the P-Asserted-Identity header field in the INVITE request being sent to the UE. Examples of such strings include "Suspected Spam" or "Fake Number"; +- The AS may populate graphical symbols of the service provider's choice in one or more Call-Info header field(s) to the terminating UE. Examples include warning symbols and text. + +#### 4.5.3.4 Actions at the Terminating UE + +The terminating UE shall support the receipt of one or more P-Asserted Identity header fields. + +The terminating UE shall retrieve the originating user's name from the "display-name" parameter of the P-Asserted Identity header field or the "display-name" parameter of the From header field depending on the header used for determining the originating party identity. + +NOTE 1: The data sources queried for metadata are typically local to the service provider, and therefore are populated with data represented in the same language as the subscriber's. Therefore, semantic translation is not likely to be needed. UEs can offer semantic translation of the display as an individual, manufacturer-based capability. Semantic translation is outside the scope of the present document. + +The UE shall support receipt of one or more Call-Info header fields. + +The terminating UE shall retrieve the metadata of the originating user from the Call-Info header fields. + +NOTE 2: UEs can support capabilities such as text-to-speech for the blind, as well as ensuring that messages delivered in colours intended for warnings be relayed in a different method to accommodate colour-blind users. + +## 4.6 Interaction with other Services + +### 4.6.1 Originating Identification Presentation (OIP) + +For users that subscribe to both OIP and eCNAM, and subject to service provider policy, the name information retrieved through eCNAM may override any name information available via OIP. + +Subject to service provider policy, eCNAM metadata and other OIP data may both be presented to the end user with or without individual marking to distinguish the eCNAM service data from other call information. + +### 4.6.2 Originating Identification Restriction (OIR) + +The OIR service shall take precedence over the eCNAM service. + +### 4.6.3 Terminating Identification Presentation / Terminating Identification Restriction (TIP/TIR) + +No impact. Neither service shall affect the operation of the other service. + +### 4.6.4 Advice of Charge + +No impact. Neither service shall affect the operation of the other service. + +### 4.6.5 Communication Waiting (CW) + +If a terminating party has the eCNAM service active and is notified that an incoming communication is waiting, then this terminating user shall receive the eCNAM data on the incoming session, if presentation is not restricted on that incoming session. + +### 4.6.6 Communication Hold + +No impact. Neither service shall affect the operation of the other service. + +### 4.6.7 Explicit Communication Transfer (ECT) + +No impact; i.e. neither service shall affect the operation of the other service. + +### 4.6.8 Closed User Group (CUG) + +In general, CUG members do not communicate with users outside the group. However, if members were allowed to activate eCNAM and to receive calls from outside the group, then eCNAM data will be delivered based on the caller's OIR status. + +### 4.6.9 Completion of Communications to Busy Subscriber (CCBS) + +The originating party's eCNAM data shall be transmitted to the CCBS customer's UE when the terminating party becomes free, and a CCBS communication is generated to the terminating party. + +### 4.6.10 Communication Diversion (CDIV) + +Subject to service provider policy, the terminating AS serving the diverted to user may optionally deliver the eCNAM data of a diverting user. The identity of the diverting user is obtained from the History-Info header field, as described in 3GPP TS 24.604 [8]. + +### 4.6.11 Malicious Communication Identification (MCID) + +No impact. Neither service shall affect the operation of the other service. + +### 4.6.12 Anonymous Communication Rejection (ACR) and Incoming Communications Barring (ICB) + +Within the network execution of ICB and ACR services, either service shall take precedence over the eCNAM service. + +### 4.6.13 Message Waiting Indication (MWI) + +No impact. Neither service shall affect the operation of the other service. + +### 4.6.14 Flexible Alerting (FA) + +If the FA Pilot has eCNAM activated, incoming calls to the FA Pilot shall apply eCNAM to the members of the FA group. + +Metadata that is obtained from analytics shall be based on the FA Pilot and not the individual members' identity. + +NOTE: Analytics can sometimes be based on the called party's identity. Therefore, it should be noted that in an FA group, the only identity available for use shall be that of the Pilot. + +### 4.6.15 Personal Network Management (PNM) + +For a user that subscribes to both PNM and eCNAM, both originating user identity and eCNAM identity data shall be delivered to the Personal Network UE that is configured to act as a Personal Network controller. + +### 4.6.16 Multi-Device (MuD) + +If the terminating user of the eCNAM service has activated the MuD service, eCNAM data shall be transmitted to all UEs of the terminating user. + +### 4.6.17 Multi-Identity (MiD) + +No impact. Neither service shall affect the operation of the other service. + +## 4.7 Parameter values (timers) + +Not applicable. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-08 | C1-105 | | | | | Version after implementation of pCRs agreed in C1-105 | 0.1.0 | +| 2017-11 | C1-106 | | | | | Version after implementation of pCRs agreed in C1-106 | 0.2.0 | +| 2017-12 | C1-107 | | | | | Version after implementation of pCRs agreed in C1-107 | 0.3.0 | +| 2017-12 | CT-78 | CP-173044 | | | | Presentation for information at TSG CT | 1.0.0 | +| 2018-01 | C1-108 | | | | | Version after implementation of pCRs agreed in C1-108 | 1.1.0 | +| 2018-02 | C1-109 | | | | | Version after implementation of pCRs agreed in C1-109 | 1.2.0 | +| 2018-03 | CT-79 | CP-180102 | | | | Presentation for approval at TSG CT | 2.0.0 | +| 2018-03 | CT-79 | | | | | Version 15.0.0 created after approval | 15.0.0 | +| 2019-09 | CT-85 | CP-192047 | 0001 | | F | Reference to RFC 8224 | 15.1.0 | +| 2019-12 | CT-86 | CP-193111 | 0002 | | B | Adding interactions with "Multi-Device" and "Multi-Identity" services | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24247/18e519d1f91133e080347562f681dfb5_img.jpg b/marked/Rel-16/24_series/24247/18e519d1f91133e080347562f681dfb5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e8410740507b10858bccddb47f7cf176a2878b25 --- /dev/null +++ b/marked/Rel-16/24_series/24247/18e519d1f91133e080347562f681dfb5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dcc1acb96c212dcb46faa08e5575597008c8be0b7e14e40d70dab54592da9f13 +size 109720 diff --git a/marked/Rel-16/24_series/24247/61a7f401eb46fe99a71f27bc37493f04_img.jpg b/marked/Rel-16/24_series/24247/61a7f401eb46fe99a71f27bc37493f04_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dafd3e2a35cefde48e1e4d798040661c8a7ff4de --- /dev/null +++ b/marked/Rel-16/24_series/24247/61a7f401eb46fe99a71f27bc37493f04_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f173156245a9b8eac331fd4100b32f5db118c114cbf3199fd1d691b3d31ee628 +size 132760 diff --git a/marked/Rel-16/24_series/24247/7ec4ba01d21d0840c67e18d51aeb1415_img.jpg b/marked/Rel-16/24_series/24247/7ec4ba01d21d0840c67e18d51aeb1415_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b389e22fd34e8b15ff223562e436d049e35dc92a --- /dev/null +++ b/marked/Rel-16/24_series/24247/7ec4ba01d21d0840c67e18d51aeb1415_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:086609164257d6c3edf4c5feb839665096eb1438a079554b87620d4ed495d489 +size 18456 diff --git a/marked/Rel-16/24_series/24247/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/24_series/24247/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ebed06a4b0ea9eaed23051a51c979157d860cd7c --- /dev/null +++ b/marked/Rel-16/24_series/24247/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aeff2bf184b0ed2bac37e96064fc4921f074066c62fdb76357dbfebf5bb44be0 +size 138456 diff --git a/marked/Rel-16/24_series/24247/b5335262987c819d7f71ce40f99cb71b_img.jpg b/marked/Rel-16/24_series/24247/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..14bd1f7411d1825104dd6064577d5b8192cbb05e --- /dev/null +++ b/marked/Rel-16/24_series/24247/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ffe38b8e4cd1658a407fdcc053b83029b337eaa4ada52ed563d9de2d8f21abf6 +size 109938 diff --git a/marked/Rel-16/24_series/24247/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/24_series/24247/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..89b9328c65420b8eb7b32a402bde17be5960ff93 --- /dev/null +++ b/marked/Rel-16/24_series/24247/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49e1987054a5f89d98950f2c71a94ea15d0b9992f8daa66d67e8261d407b17ea +size 122975 diff --git a/marked/Rel-16/24_series/24247/raw.md b/marked/Rel-16/24_series/24247/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..63a1078de077db7bbd6144db601425c4070c3e81 --- /dev/null +++ b/marked/Rel-16/24_series/24247/raw.md @@ -0,0 +1,4106 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Messaging overview ..... | 8 | +| 5 Protocol using SIP for page-mode messaging ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.1.1 Sending immediate message to multiple recipients..... | 8 | +| 5.2 Functional entities ..... | 9 | +| 5.2.1 User Equipment (UE) ..... | 9 | +| 5.2.2 Application Server (AS) ..... | 9 | +| 5.2.3 Media Resource Function Controller (MRFC)..... | 9 | +| 5.3 Role ..... | 9 | +| 5.3.1 Participant..... | 9 | +| 5.3.1.1 General..... | 9 | +| 5.3.1.2 Sending of an immediate message..... | 9 | +| 5.3.1.3 Receiving an immediate message..... | 9 | +| 5.3.1.4 Consent to list server distribution ..... | 10 | +| 5.3.2 Application Server (AS) ..... | 10 | +| 5.3.2.1 Receiving an immediate message for unregistered Public User Identity ..... | 10 | +| 5.3.3 List Server ..... | 10 | +| 5.3.3.1 List server originating case ..... | 10 | +| 5.3.3.2 List server terminating case ..... | 10 | +| 5.3.3.3 List Server processing the MESSAGE URI-list ..... | 11 | +| 5.3.3.4 List server support of MESSAGE URI-lists ..... | 11 | +| 6 Protocol using SIP for session-mode messaging ..... | 11 | +| 6.1 Introduction ..... | 11 | +| 6.2 Functional entities ..... | 11 | +| 6.2.1 User Equipment (UE) ..... | 11 | +| 6.3 Role ..... | 12 | +| 6.3.1 Participant..... | 12 | +| 6.3.1.1 General..... | 12 | +| 6.3.1.2 Session initiation - mobile originating case..... | 12 | +| 6.3.1.3 Session initiation - mobile terminating case ..... | 12 | +| 6.3.2 Intermediate Node ..... | 12 | +| 6.3.2.1 General..... | 12 | +| 6.3.2.2 Generic procedures for all methods at the intermediate node ..... | 12 | +| 6.3.2.2.1 Intermediate node – originating case ..... | 12 | +| 6.3.2.2.2 Intermediate node – terminating case..... | 12 | +| 6.3.2.3 Session Initiation..... | 13 | +| 6.3.2.3.1 Session initiation – originating case..... | 13 | +| 6.3.2.3.2 Session initiation – terminating case..... | 13 | +| 7 Protocol using SIP for session-mode messaging conferences ..... | 13 | +| 7.1 Introduction ..... | 13 | +| 7.2 Functional entities ..... | 13 | +| 7.2.1 User Equipment (UE) ..... | 13 | +| 7.2.2 Media Resource Function Controller (MRFC)..... | 13 | +| 7.2.3 Conferencing Application Server (AS) ..... | 13 | +| 8 Protocol using SDP for session-mode messaging and session-mode messaging conferences ..... | 14 | +| 8.1 Introduction ..... | 14 | +| 8.2 Functional entities ..... | 14 | +| 8.2.1 User Equipment (UE) ..... | 14 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------|-----------| +| 8.2.2 | Media Resource Function Controller (MRFC)..... | 14 | +| 8.2.3 | Application Server (AS) ..... | 14 | +| 8.3 | Role ..... | 14 | +| 8.3.1 | SDP offerer ..... | 14 | +| 8.3.2 | SDP answerer ..... | 15 | +| 8.3.3 | Void ..... | 16 | +| 9 | Protocol using MSRP for session-mode messaging and session-mode messaging conferences..... | 16 | +| 9.1 | Introduction ..... | 16 | +| 9.2 | Functional entities ..... | 16 | +| 9.2.1 | User Equipment (UE) ..... | 16 | +| 9.2.1.1 | General ..... | 16 | +| 9.2.2 | Application Server (AS) ..... | 16 | +| 9.2.3 | Media Resource Function Processor (MRFP)..... | 16 | +| 9.3 | Role ..... | 16 | +| 9.3.1 | MSRP sender..... | 16 | +| 9.3.1.1 | MSRP sender sends a message ..... | 16 | +| 9.3.2 | MSRP receiver..... | 17 | +| 9.3.3 | Intermediate node ..... | 17 | +| 9.3.3.1 | Intermediate node terminating case ..... | 17 | +| 9.3.3.2 | Intermediate node originating case ..... | 17 | +| 10 | Void..... | 18 | +| Annex A (informative): | Example signalling flows of messaging service operation ..... | 18 | +| A.1 | Scope of signalling flows..... | 18 | +| A.2 | Introduction ..... | 18 | +| A.2.1 | General ..... | 18 | +| A.2.2 | Key required to interpret signalling flows..... | 18 | +| A.3 | Signalling flows demonstrating immediate messaging..... | 19 | +| A.4 | Signalling flows demonstrating session-based messaging..... | 19 | +| A.4.1 | Introduction ..... | 19 | +| A.4.2 | Establishing a session for session-based messaging without preconditions ..... | 19 | +| A.4.3 | Establishing a session for session-based messaging with Intermediate Nodes..... | 33 | +| A.4.4 | Establishing a session for session-based messaging with preconditions ..... | 56 | +| A.5 | Flows demonstrating session-based messaging conferences ..... | 57 | +| A.5.1 | User connecting into a messaging conference ..... | 57 | +| A.5.2 | MRFC/AS invites a user to a messaging conference ..... | 66 | +| Annex B (informative): | Change history..... | 76 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the protocol details for the messaging service within the IP Multimedia CN Subsystem (IMS) based on the Session Initiation Protocol (SIP), the Session Description Protocol (SDP) and, the Message Session Relay Protocol (MSRP) . The document covers immediate messaging, session based messaging and session-based messaging conferences, as described in 3GPP TS 22.340 [11]. + +Where possible the present document specifies the requirements for this protocol by reference to specifications produced by the IETF within the scope of SIP, SDP and, MSRP, either directly, or as modified by 3GPP TS 24.229 [5]. + +The present document is applicable to Application Servers (ASs) , Media Resource Function Controllers (MRFCs), Media Resource Function Processors (MRFPs) and to User Equipment (UE) providing messaging capabilities. + +This document does not cover the signalling between a MRFC and a MRFP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.228: "Service requirements for the Internet Protocol (IP) multimedia core network subsystem; Stage 1". +- [3] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IP Multimedia (IM) call model; Stage 2". +- [4] 3GPP TS 24.228 Release 5: "Signalling flows for the IP multimedia call control based on SIP and SDP; Stage 3". +- [5] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [7] IETF RFC 3261 (March 2002): "SIP: Session Initiation Protocol". +- [8] IETF RFC 3428 (December 2002): "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [9] IETF RFC 4975 (September 2007): "The Message Session Relay Protocol (MSRP)". +- [10] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem; Stage 3". +- [11] 3GPP TS 22.340: "IP Multimedia System (IMS) messaging; Stage 1". +- [12] IETF RFC 5365 (October 2008): "Multiple-Recipient MESSAGE Requests in the Session Initiation Protocol (SIP)". +- [13] IETF RFC 3994 (January 2005): "Indication of Message Composition for Instant Messaging". +- [14] 3GPP TS 26.141 "IP Multimedia System (IMS) Messaging and Presence; Media formats and codecs". + +- [15] IETF RFC 5547 (May 2009): "A Session Description Protocol (SDP) Offer/Answer Mechanism to Enable File Transfer". +- [16] IETF RFC 5360 (October 2008): "A Framework for Consent-Based Communications in the Session Initiation Protocol (SIP)". +- [17] 3GPP2 C.S0050-B: "3GPP2 File Formats for Multimedia Services". +- [18] IETF RFC 6135 (February 2011): "An Alternative Connection Model for the Message Session Relay Protocol (MSRP)". +- [19] IETF RFC 6714 (August 2012): " Connection Establishment for Media Anchoring (CEMA) for the Message Session Relay Protocol (MSRP)". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +**IsComposing information** This is a term used to indicate that an indication is sent to the communicating user when a user in entering a new message. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 22.340 [11] apply: + +**Immediate messaging** + +**Session based messaging** + +**Session based messaging conferences** + +For the purposes of the present document, the following terms and definitions given in RFC 4975 [9] apply: + +**Host** + +**Page-mode messaging** + +**Session inactivity timer** + +**Session-mode messaging** + +**Session-mode messaging conferences** + +**Visitor** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.147 [10] apply: + +**Conferencing Application Server** + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|-------------------------------------| +| AS | Application Server | +| CN | Core Network | +| DM | Data manipulator | +| DMS | Data manipulation server | +| IM | IP Multimedia | +| IMS | IP Multimedia CN subsystem | +| IP | Internet Protocol | +| MRFC | Media Resource Function Controllers | +| MRFP | Media Resource Function Processors | +| MSRP | Message Session Relay Protocol | +| SBLP | Service Based Local Policy | +| SDP | Session Description Protocol | +| SIP | Session Initiation Protocol | + +| | | +|-----|--------------------------| +| UE | User Equipment | +| URL | Uniform Resource Locator | + +# --- 4 Messaging overview + +The basic services for the IP Multimedia core network Subsystem (IMS), as defined in 3GPP TS 24.229 [5], allow a user to initiate, modify and terminate media sessions using the Session Initiation Protocol, as defined in RFC 3261 [7]. Although these basic mechanisms already allow the exchange of instant messaging information using SIP, this functionality can be extended to provide a richer service within the IMS. + +The messaging service within the IM CN subsystem provides the means for a user to send or receive single messages immediately to / from another user and to create and participate in a messaging conference with one or more other users. Participants to such message based communication may be internal or external to the home network. + +When to use an immediate message and when to use a session-based messaging session will depend on the application. + +**NOTE:** Some participants may always use session-based messaging, while others may use immediate messaging or a combination of session-based messaging and immediate messaging dependant of the characteristics of the messaging session. The criteria are implementation and application specific. + +For immediate messaging the procedures for page-mode messaging, as defined in RFC 3428 [8] or for session-mode messaging, as defined in RFC 4975 [9], RFC 6714 [19] and RFC 6135 [18] are utilized. When to use a page-mode messaging and when to use session-mode messaging session for the purpose of immediate messaging will depend on the application. + +For session-based messaging and session-based messaging conferences, the Message Session Relay Protocol (MSRP) is utilized to transport messages. + +The architecture for the 3GPP messaging is specified in 3GPP TS 23.228 [6] and 3GPP TS 23.218 [3]. The 3GPP recommended media formats and codecs are specified in 3GPP TS 26.141 [14]. The 3GPP2 recommended media formats and codecs are specified in 3GPP2 C.S0050-B [17]. + +The functional split for session-mode messaging between an AS, MRFC and MRFP is that same as that described in clause 4 in 3GPP TS 24.147 [10] for SIP based conferences. The functional split between the AS, MRFC and MRFP for page-mode messaging is out of scope of the present document. + +# --- 5 Protocol using SIP for page-mode messaging + +## 5.1 Introduction + +### 5.1.1 Sending immediate message to multiple recipients + +The UE may be able to send a single immediate message to multiple recipients by including in the MESSAGE request the list of URIs (i.e., URI-list) that identify the intended recipients. + +The UE shall create a MESSAGE request in accordance with 3GPP TS 24.229 [5], and it shall also include a multipart body in the MESSAGE request. The Request-URI shall be set to the SIP URI of the Application Server that implements the role of the List Server. The multipart body shall contain the body carrying the URI-list (in the XML format) whose Content-Disposition type is 'recipient-list', and the body that contains the immediate message payload as specified in the RFC 5365 [12]. + +The handling of the received response shall be in accordance with 3GPP TS 24.229 [5]. + +## 5.2 Functional entities + +### 5.2.1 User Equipment (UE) + +For the purpose of page-mode messaging, the UE shall implement the role of a Participant as described in subclause 5.3.1. + +### 5.2.2 Application Server (AS) + +As the functional split for the purposes of page mode messaging between the AS and the MRFC is out of scope of the present document, the procedures are described for a combined AS and MRFC. The AS and MRFC may either be collocated, or interoperate using a proprietary protocol and a proprietary functional split. + +For the purpose of page-mode messaging, an Application Server may implement the role of a List Server as described in subclause 5.3.3. An Application Server may implement the role of a Participant as described in subclause 5.3.1 + +### 5.2.3 Media Resource Function Controller (MRFC) + +As the function split for the purposes of page mode messaging between the MRFC and the AS is out of scope of the present document, the procedures for the MRFC are described together with those for the AS in subclause 5.2.2. + +## 5.3 Role + +### 5.3.1 Participant + +#### 5.3.1.1 General + +For the purpose of page-mode messaging a participant will send a page-mode message using a SIP MESSAGE request as defined in RFC 3428 [8] to another participant. + +#### 5.3.1.2 Sending of an immediate message + +When sending a page-mode message to another participant or to a list server, the participant shall construct and send a MESSAGE request in accordance with RFC 3428 [8] and subclause 5.1.2A.1 of 3GPP TS 24.229 [5]. + +The participant may include in a MESSAGE request an isComposing status message as defined in RFC 3994 [13]. + +The participant shall stop transmitting isComposing status messages if the participant receives a 415 (Unsupported Media Type) status code in a response to a MESSAGE request containing the status indication. + +The Request URI shall either be: + +- the URI of the other participant; or +- a PSI identifying a group. + +#### 5.3.1.3 Receiving an immediate message + +Upon receipt of a MESSAGE request, the participant shall perform the procedures as described in RFC 3428 [8] and subclause 5.1.2A.2 of 3GPP TS 24.229 [5]. + +NOTE: A MESSAGE request can be used for applications other than immediate messaging (e.g. 3GPP TS 23.228 [6] subclause 5.4.9), and the handling of received MESSAGE requests for such applications is outside the scope of this specification. + +#### 5.3.1.4 Consent to list server distribution + +A participant capable of receiving message requests should support the requirements of a recipient defined in RFC 5360 [16]. + +### 5.3.2 Application Server (AS) + +#### 5.3.2.1 Receiving an immediate message for unregistered Public User Identity + +When an immediate message destined for an unregistered Public User Identity arrives at the user's home network, the I-CSCF and S-CSCF perform the actions as specified in 3GPP TS 24.229 [5]. + +If the Public User Identity has services related to unregistered state activated (i.e., hold the MESSAGE request temporarily in the network.), the MESSAGE request will be routed to an AS, which processes the request further on. The AS may then hold the MESSAGE request and deliver the MESSAGE request when either the UE becomes reachable or the validity of the message expires as specified in RFC 3428 [8]. + +### 5.3.3 List Server + +#### 5.3.3.1 List server originating case + +In addition to the procedure specified in subclause 5.3.3.2 the list server shall follow the procedures of 3GPP TS 24.229 [5] subclause 5.7.3 when acting as an originating UA. + +The PSI is used to address a predefined list of URIs. + +The list server shall send a MESSAGE request to each of the entries in the predefined URI list. For each of MESSAGE requests the list server shall populate the header fields as follows: + +- a) the Request URI header fields set to the URI of one of the entries of the predefined URI list; +- b) the From header field set to the same value as the From header field (excluding the "tag" parameter) that was received in the incoming MESSAGE request; +- c) the To header fields set to the same value as the To header field that was received in the incoming MESSAGE request; +- d) the P-Charging-Vector header that includes: + - 1) the value of the icid parameter if available; and + - 2) the value of the orig-ioi parameter if available; +- e) the P-Charging-Function-Addresses header containing the values received in the incoming MESSAGE request or, if the P-Charging-Function-Addresses header was not received in the incoming MESSAGE request, indicate the values applicable for the list server in the P-Charging-Function-Addresses header; and +- f) the P-Asserted Identity header and Privacy header containing the values received in the MESSAGE request; + +The handling of the 200 (OK) response shall be in accordance with 3GPP TS 24.229 [5]. + +#### 5.3.3.2 List server terminating case + +Upon receipt of a MESSAGE request that includes a PSI in the request URI the list server shall: + +- 1) check if the PSI is allocated to a predefined URI list and rejects the request in accordance with RFC 3261 [7] if it is not allocated. The following actions in this subclause shall only be performed if the distribution list URI is allocated; +- 2) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; +- 3) create a 202 (Accepted) response. The response shall be in accordance with the procedures of 3GPP TS 24.229 [5] subclause 5.7.1.2 in relation to the contents of the P-Charging-Function-Addresses header and the P-Charging-Vector header; and : + - a) include the P-Charging-Vector header including: + - i) the value of the icid parameter as received in the MESSAGE request; + - ii) the value of the orig-ioi parameter as received in the MESSAGE request; and + - iii) the term-ioi parameter, indicating the network of the list server; and + - b) include the P-Charging-Function-Addresses header as received in the MESSAGE request or, if the P-Charging-Function-Addresses header was not received in the MESSAGE request, indicate the values applicable for the list server in the P-Charging-Function-Addresses header; and +- 4) send the 202 (Accepted) response. + +#### 5.3.3.3 List Server processing the MESSAGE URI-list + +Upon receiving the MESSAGE request with the URI-list included in the multipart body, the List Server shall inform the UE that it has received the MESSAGE request by returning the 202 (Accepted) response. Subsequently, the List Server shall create a MESSAGE request for each intended recipient listed in the URI-list, and it shall insert the immediate message payload into the body of each outgoing MESSAGES request. + +When creating the outgoing MESSAGE requests destined for each recipient, the List Server shall follow the procedures described in the 3GPP TS 24.229 [5]. The List Server shall populate the header fields of each outgoing MESSAGE request as follows: + +- the Request-URI set to the SIP URI of the intended recipient; +- the From header field set to the same value as the From header field that was received in the incoming MESSAGE request; +- the To header set to the SIP URI of the intended recipient; and +- the remaining headers set to the values as specified in 3GPP TS 24.229 [5] subclause 5.7.3. + +The List Server shall also compose the multipart body of the outgoing MESSAGE request as specified in the RFC 5365 [12], and included it in the outgoing MESSAGE request. + +When sending the MESSAGE request to each recipient, and processing the respective responses, the List Server shall behave as specified in the 3GPP TS 24.229 [5] subclause 5.7. + +#### 5.3.3.4 List server support of MESSAGE URI-lists + +A list server shall support the relay requirements of RFC 5360 [16]. The list server may also support the store and forward server requirements of RFC 5360 [16]. + +# --- 6 Protocol using SIP for session-mode messaging + +## 6.1 Introduction + +## 6.2 Functional entities + +### 6.2.1 User Equipment (UE) + +For the purpose of session-mode messaging, the UE shall implement the role of a Participant as described in subclause 6.3.1. + +## 6.3 Role + +### 6.3.1 Participant + +#### 6.3.1.1 General + +The participant shall perform SIP related session procedures in accordance with 3GPP TS 24.229 [5] to set up the dialog used for session-based messaging. + +#### 6.3.1.2 Session initiation - mobile originating case + +When the originating participant wishes to engage the terminating participant in a session-mode message session, it shall use the call initiation procedure specified in 3GPP TS 24.229 [5]. The Request URI header shall include the URI of the terminating participant. + +#### 6.3.1.3 Session initiation - mobile terminating case + +When the terminating participant receives an initial INVITE request from the originating endpoint proposing a message session, the terminating participant shall apply the procedures as specified in 3GPP TS 24.229 [5]. + +### 6.3.2 Intermediate Node + +#### 6.3.2.1 General + +The intermediate node shall act as a Routeing B2BUA as specified in subclause 5.7 in 3GPP TS 24.229 [5]. + +#### 6.3.2.2 Generic procedures for all methods at the intermediate node + +##### 6.3.2.2.1 Intermediate node – originating case + +The intermediate node shall follow the procedures of 3GPP TS 24.229 [5] subclause 5.7.3 when acting as an originating UA. + +##### 6.3.2.2.2 Intermediate node – terminating case + +Upon receipt of an initial request the intermediate node shall follow the procedures of 3GPP TS 24.229 [5] subclause 5.7.1.2 in relation to the contents of the P-Charging-Function-Addresses header and the P-Charging-Vector header. + +When creating the first response for this initial request, the intermediate node shall: + +- 1) include the P-Charging-Vector header including: + - a) the value of the icid parameter as received in the initial request; + - b) the value of the orig-ioi parameter as received in the initial request; and + - c) the term-ioi parameter, indicating the network of the intermediate node; and +- 2) include the P-Charging-Function-Addresses header as received in the initial request or, if the P-Charging-Function-Addresses header was not received in the initial request indicate the values applicable for the conference in the P-Charging-Function-Addresses header. + +When creating responses for an initial INVITE request, the intermediate node shall additionally send the 200 (OK) response to the initial INVITE request only after the resource reservation has been completed. + +#### 6.3.2.3 Session Initiation + +##### 6.3.2.3.1 Session initiation – originating case + +The intermediate node shall follow the procedures of 3GPP TS 24.229 [5] at call initiation. + +The intermediate node shall populate the INVITE as specified for a Routeing B2BUA with the following clarification: + +- a) the Request URI to the URI as in the received Request URI; +- b) the To header to the same display name and URI as in the received To header; +- c) the From header sent includes the same display name and URI as in the From header in the received INVITE; and +- d) the P-Asserted-Identity header and privacy includes the same information as in the received P-Asserted-Identity header and Privacy header; and + +If the intermediate node is not able to establish a TCP connection for the MSRP session the intermediate node shall send BYE towards the participant and release the associated recourses. + +##### 6.3.2.3.2 Session initiation – terminating case + +Upon receipt of an INVITE request that includes the terminating participant URI in the request URI, the intermediate node shall: + +- 1) verify the identity of the user as described in subclause 5.7.1.4 of 3GPP TS 24.229 [5] and authorize the request as described in subclause 5.7.1.5 of 3GPP TS 24.229 [5]. The following actions in this subclause shall only be performed if the request can be authorized; + +- 2) establish the session in accordance with 3GPP TS 24.229 [5]; and +- 3) create a 200 (OK) response. + +# --- 7 Protocol using SIP for session-mode messaging conferences + +## 7.1 Introduction + +Void. + +## 7.2 Functional entities + +### 7.2.1 User Equipment (UE) + +For the purpose of session-mode messaging conferences, the UE shall implement the role of a Participant as described in subclause 6.3.1 and the the procedures described in subclause 5.2.1 in 3GPP TS 24.147 [10]. + +### 7.2.2 Media Resource Function Controller (MRFC) + +For the purpose of session-based messaging conferences, the MRFC shall follow the procedures described in subclause 5.2.2 in 3GPP TS 24.147 [10]. + +### 7.2.3 Conferencing Application Server (AS) + +For the purpose of session-based messaging conferences, the AS shall follow the procedures described in subclause 5.2.3 in 3GPP TS 24.147 [10]. + +# --- 8 Protocol using SDP for session-mode messaging and session-mode messaging conferences + +## 8.1 Introduction + +## 8.2 Functional entities + +### 8.2.1 User Equipment (UE) + +For the purpose of session-mode messaging and session-mode messaging conferences, the UE shall implement the role of: + +- an SDP offerer as described in subclause 8.3.1; and +- an SDP answerer as described in subclause 8.3.2. + +### 8.2.2 Media Resource Function Controller (MRFC) + +The MRFC shall implement the role of an intermediate node as described in subclause 8.3.3. + +### 8.2.3 Application Server (AS) + +The AS shall implement the role of an SDP offerer, as described in subclause 8.3.1, and an SDP answerer, as described in subclause 8.3.2 when engaged in a session mode session between a SDP offerer and SDP answerer. + +NOTE: An AS, that is on the signalling path for the related SIP signalling, is not mandated to terminate the related MSRP. + +## 8.3 Role + +### 8.3.1 SDP offerer + +When an SDP offerer wants to create a session mode messaging session, the SDP offerer shall populate the SDP as specified in subclause 6.1 in 3GPP TS 24.229 [5]. In addition the SDP offerer shall also include an SDP media description for an MSRP session. The SDP media description shall include: + +- a) an SDP msrp-cema attribute, in accordance with RFC 6714 [19]; +- b) the supported MIME types in the SDP accept-types or accept-wrapped-types attributes, in accordance with RFC 4975 [9]; +- c) an SDP path attribute, with a value for the authority component that does not resolve to a valid IP address, and with a valid session-id component, in the MSRP URI component of the attribute ; and +- d) an SDP setup attribute, in accordance with RFC 6135 [18]. + +The SDP may also include an SDP max-size attribute, in accordance with RFC 4975 [9]. + +The SDP offerer may want to indicate to the other user(s), that the SDP offerer is prepared to receive isComposing information, then it shall add the MIME type "application/ im-iscomposing+xml" to the SDP accept-type or access-wrapped-types attributes. + +**NOTE:** When the SDP offerer receives an SDP answer, if the SDP media description for the MSRP session does not contain an SDP msrp-cema attribute, the SDP offerer might fall back to the RFC 4975 [9] procedures, in accordance with RFC 6714 [19]. In such case, the SDP offerer will send a new SDP offer that does not include an SDP msrp-cema attribute, and in which the authority component in the MSRP URI component of the SDP path attribute is set in accordance with RFC 4975 [9]. + +Otherwise, if the SDP answer contains an SDP setup attribute with a "passive" value, the SDP offerer shall set up a TCP connection (if not already available) when an IP-CAN bearer with sufficient QoS is available. + +In accordance with RFC 6135 [18], the SDP offerer shall not include an SDP connection attribute in the initial SDP offer. For file transfer, the SDP shall also include SDP media level attributes in accordance with RFC 5547 [15], with the exception that it shall include the SDP file-selector attribute with at least a size parameter. + +For file transfer, once the MSRP 200 (OK) response for the last MSRP SEND request is received, the SDP offerer shall terminate the MSRP session associated with the file transfer by sending an SDP offer where the port value of the SDP media description for the MSRP session is zero. In case there are no other SDP media descriptions associated with the SIP session, the SDP offerer shall send a SIP BYE request in order to terminate the SIP session. + +### 8.3.2 SDP answerer + +SDP answerer shall populate the SDP answer as specified in subclause 6.1 in 3GPP TS 24.229 [5]. In addition the SDP answerer shall include an SDP media description for an MSRP session. The SDP media description shall include: + +- a) an SDP msrp-cema attribute, if the precondition described in RFC 6714 [19] for including the attribute is fulfilled. Otherwise the SDP answerer will fall back to the RFC 4975 [9] procedures; +- b) the supported MIME types in the SDP accept-types or accept-wrapped-types attributes, in accordance with RFC 4975 [9]; +- c) if the precondition described in RFC 6714 [19] for including the SDP msrp-cema attribute is fulfilled, an SDP path attribute, with a value for the authority component that does not resolve to a valid IP address, and with a valid session-id component, in the MSRP URI component of the attribute; +- d) if the precondition described in RFC 6714 [19] for including the SDP msrp-cema attribute is not fulfilled, an SDP path attribute in accordance with RFC 4975 [9]; and +- e) an SDP setup attribute, in accordance with RFC 6135 [18]. + +The SDP answerer may also include an SDP max-size attribute, in accordance with RFC 4975 [9]. + +If the SDP answerer receives the MIME type "application/im-iscomposing+xml" in the SDP accept-types or accept-wrapped-types attribute and the SDP answerer accepts the exchange of isComposing information the SDP answerer shall add the MIME type "application/im-iscomposing+xml" to the SDP accept-types or access-wrapped types attributes. + +If the SDP answer contains an SDP setup attribute with an "active" value, the SDP answerer shall set up a TCP connection (if not already available) when an IP-CAN bearer with sufficient QoS is available. + +For file transfer, the SDP answerer shall behave in accordance with RFC 5547 [15]. + +### 8.3.3 Void --- + +# 9 Protocol using MSRP for session-mode messaging and session-mode messaging conferences + +## 9.1 Introduction + +## 9.2 Functional entities + +### 9.2.1 User Equipment (UE) + +#### 9.2.1.1 General + +The UE shall: + +- implement the role of an MSRP sender as described in subclause 9.3.1; and +- implement the role of an MSRP receiver as described in subclause 9.3.2. + +### 9.2.2 Application Server (AS) + +The AS shall implement the role of a MSRP sender, as described in subclause 9.3.1, and a MSRP receiver, as described in subclause 9.3.2 when engaged in a session mode session between a MSRP sender and MSRP receiver. + +NOTE: An AS, that is on the signalling path for the related SIP signalling, is not mandated to terminate the related MSRP. + +### 9.2.3 Media Resource Function Processor (MRFP) + +The MRFP shall implement the role of an intermediate node as described in subclause 9.3.3. + +The MRFP may implement the role of an MSRP sender as described in subclause 9.3.1. + +The MRFP may implement the role of an MSRP receiver as described in subclause 9.3.2. + +## 9.3 Role + +### 9.3.1 MSRP sender + +#### 9.3.1.1 MSRP sender sends a message + +When a MSRP sender wishes to send a message, the MSRP sender shall ensure that the message length does not exceed the SDP max-size attribute value associated with the MSRP session. Depending on the message length the message may be included in one SEND request or chunked into multiple SEND requests, in accordance with RFC 4975 [9]. + +The SEND request shall include a Byte-Range header. The MSRP sender shall populate the Byte-Range header fields as follows: + +- the range end set to \* (interruptible), to make the chunks interruptible, if the SEND request is longer than 2048 octets; and + +- the total field set to the total size of the message. + +The MSRP sender shall create a SEND request in accordance with RFC 4975 [9] and RFC 6135 [18], where the value of To-Path is the MSRP URI shall be set to value of path attribute received in a SDP offer or a SDP answer. + +If it is possible to exchange isComposing information, the MSRP sender may include in a SEND request an isComposing status message as defined in RFC 3994 [13]. + +### 9.3.2 MSRP receiver + +When a MSRP receiver receives a SEND request, the MSRP receiver shall parse the SEND request. The MSRP receiver shall either send a response including: + +- a 200 (OK) status-code , as specified in RFC 4975 [9], for the concerned SEND message if the parsing was successful; or +- an appropriate status-code, as specified in RFC 4975 [9], for the concerned SEND message if the parsing was unsuccessful. + +The MSRP receiver shall send a REPORT request if this is explicit or implicit requested in the SEND request(s) belonging to the message. It shall either be: + +- a successful REPORT request including status-code 200 (OK) if a complete message is received and the Report-Success header in the SEND request was set to "yes"; or +- an unsuccessful REPORT request including status-code other than 200 (OK) as defined in RFC 4975 [9] if the MSRP receiver can conclude that a complete message is not received and the Report-Failure header is set to "yes" or not included. The criteria to conclude that a complete message is not received are specified in RFC 4975 [9]. + +### 9.3.3 Intermediate node + +#### 9.3.3.1 Intermediate node terminating case + +When an intermediate node receives a SEND request, the intermediate node shall: + +- parse the SEND request and either send a response including: + - a 200 (OK) status-code, as specified in RFC 4975 [9], for the concerned SEND message, if the parsing was successful; or + - an appropriate status-code, as specified in RFC 4975 [9], for the concerned SEND message if the parsing was unsuccessful.; and +- determine that a complete message has been received. The following actions in this subclause shall only be performed if a complete message is received. + +The MSRP receiver shall send a REPORT request if this is explicit or implicit requested in the SEND request(s) associated to the same message. It shall either be: + +- a successful REPORT request including status-code 200 (OK) if the intermediate node concludes that all available users on the distribution list has received the complete message or a concerned user has received the complete message and the Report-Success header in the SEND request was set to "yes"; or +- an unsuccessful REPORT request including status-code other than 200 (OK) as defined in RFC 4975 [9] if the intermediate node conclude that a complete message has not been received or that a complete message has not been able to be delivered to all available users on the distribution list or to a particular member of the distribution list. + +#### 9.3.3.2 Intermediate node originating case + +When an intermediate node wishes to send a message, the intermediate shall ensure that the message length does not exceed the SDP max-size attribute value associated with the MSRP session. Depending on the message length the message may be included in one SEND request or chunked into multiple SEND requests, in accordance with RFC 4975 [9]. + +The SEND request shall include a Byte-Range header. The MSRP sender shall populate the Byte-Range header fields as follows: + +- the range-end field set to \* (interruptible), to make the chunks interruptible, if the SEND request is longer than 2048 octets; and +- the total field set to the total size of the message. + +The intermediate shall create a SEND request in accordance with RFC 4975 [9] and RFC 6135 [18] with the following clarifications: + +- 1) set the Report-Success header as received in the SEND request; +- 2) set the Report-Failure header as received in the SEND request; and +- 3) depending on the received MSRP URI + - a) either send the SEND request to all available user of the conference; or + - b) send the SEND request to one MSRP receiver. + +# 10 Void + +# Annex A (informative): Example signalling flows of messaging service operation + +## A.1 Scope of signalling flows + +This annex gives examples of signalling flows for conferencing within the IP Multimedia CN Subsystem (IMS) based on the Session Initiation Protocol (SIP), SIP Events, the Session Description Protocol (SDP) and other protocols. + +These signalling flows provide detailed signalling flows, which expand on the overview information flows provided in 3GPP TS 23.228 [6]. + +## A.2 Introduction + +### A.2.1 General + +### A.2.2 Key required to interpret signalling flows + +The key to interpret signalling flows specified in 3GPP TS 24.228 [4] subclause 4.1 applies with the additions specified below : + +- #### represents the contents in the headers are not shown and does not impact the implementation of the flows. + +In order to differentiate between messages for SIP and MSRP, the following notation is used: + +![Diagram illustrating signalling flow notation. It shows three horizontal lines representing different message types: 1. INVITE: A solid line with an arrow pointing right, labeled 'SIP message'. 2. TCP setup: A dashed line with arrows pointing both left and right, labeled 'Reliable transport protocol messages (in bold style)'. 3. SEND: A solid line with an arrow pointing right, labeled 'MRSP message (in bold style)'.](7ec4ba01d21d0840c67e18d51aeb1415_img.jpg) + +Diagram illustrating signalling flow notation. It shows three horizontal lines representing different message types: 1. INVITE: A solid line with an arrow pointing right, labeled 'SIP message'. 2. TCP setup: A dashed line with arrows pointing both left and right, labeled 'Reliable transport protocol messages (in bold style)'. 3. SEND: A solid line with an arrow pointing right, labeled 'MRSP message (in bold style)'. + +Figure A.2.2-1: Signalling flow notation + +## --- A.3 Signalling flows demonstrating immediate messaging + +The signalling flow for immediate messaging is shown in subclause 10.6 of 3GPP TS 24.228 [4]. + +## --- A.4 Signalling flows demonstrating session-based messaging + +### A.4.1 Introduction + +This subclause provides signalling flows for session-based messaging, established both with and without preconditions. + +How the signalling flow for session-based messaging looks like depends on the following: + +- a) at what point in time the IP-CAN for the media component (MSRP) is set up; or +- b) whether preconditions and reliable provisional responses are used or not. + +### A.4.2 Establishing a session for session-based messaging without preconditions + +Figure A.4.2-1 shows the establishment of an MSRP session between two users without the usage of preconditions and reliable provisional responses as well as the first message being sent over the established connection. + +It is assumed that both the originating UE and terminating UE are using an IP-CAN with a separate bearer for SIP signalling which means that each UE needs to reserve a new IP-CAN bearer for the message session media component prior to sending the first MSRP message. + +![Sequence diagram showing the establishment of an MSRP session between UE#1 and UE#2 across multiple network elements.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +The sequence diagram illustrates the establishment of an MSRP session between UE#1 and UE#2. The participants are grouped into three network domains: UE#1 Home Network (UE#1, P-CSCF#1, S-CSCF#1), UE#2 Home Network (I-CSCF#2, S-CSCF#2), and UE#2 Visited Network (P-CSCF#2, UE#2). + +``` + +sequenceDiagram + participant UE#1 + participant P-CSCF#1 + participant S-CSCF#1 + participant I-CSCF#2 + participant S-CSCF#2 + participant P-CSCF#2 + participant UE#2 + + Note left of S-CSCF#1: 5. Evaluation of Initial Filter Criteria + Note right of S-CSCF#2: 11. Evaluation of Initial Filter Criteria + Note right of UE#2: 16. Reserve IP-CAN bearer for media + Note left of UE#1: 28. Reserve IP-CAN bearer for media + + UE#1->>P-CSCF#1: 1. INVITE + P-CSCF#1-->>UE#1: 2. 100 Trying + P-CSCF#1->>S-CSCF#1: 3. INVITE + S-CSCF#1-->>P-CSCF#1: 4. 100 Trying + Note left of S-CSCF#1: 5. Evaluation of Initial Filter Criteria + S-CSCF#1->>I-CSCF#2: 6. INVITE + I-CSCF#2-->>S-CSCF#1: 7. 100 Trying + Note right of I-CSCF#2: 8. HSS query + I-CSCF#2->>S-CSCF#2: 9. INVITE + S-CSCF#2-->>I-CSCF#2: 10. 100 Trying + Note right of S-CSCF#2: 11. Evaluation of Initial Filter Criteria + S-CSCF#2->>P-CSCF#2: 12. INVITE + P-CSCF#2-->>S-CSCF#2: 13. 100 Trying + P-CSCF#2->>UE#2: 14. INVITE + UE#2-->>P-CSCF#2: 15. 100 Trying + Note right of UE#2: 16. Reserve IP-CAN bearer for media + UE#2->>P-CSCF#2: 17. 200 OK + P-CSCF#2-->>S-CSCF#2: 18. 200 OK + S-CSCF#2-->>I-CSCF#2: 19. 200 OK + I-CSCF#2-->>S-CSCF#1: 20. 200 OK + S-CSCF#1-->>P-CSCF#1: 21. 200 OK + P-CSCF#1-->>UE#1: 22. 200 OK + UE#1->>P-CSCF#1: 23. ACK + P-CSCF#1->>S-CSCF#1: 24. ACK + S-CSCF#1->>I-CSCF#2: 25. ACK + I-CSCF#2->>S-CSCF#2: 26. ACK + S-CSCF#2->>P-CSCF#2: 27. ACK + Note left of UE#1: 28. Reserve IP-CAN bearer for media + UE#1->>UE#2: 29. TCP setup + UE#1->>UE#2: 30. SEND + UE#2-->>UE#1: 31. 200 OK + +``` + +Sequence diagram showing the establishment of an MSRP session between UE#1 and UE#2 across multiple network elements. + +**Figure A.4.2-1: Establishment of MSRP session** + +The details of the signalling flows are as follows: + +#### 1. INVITE request (UE#1 to P-CSCF#1) - see example in table A.4.2-1 + +The originating UE wants to initiate a session-based message session with the terminating UE. The originating UE creates a local MSRP URL, which can be used for the communication between the two user agents. It builds a SDP Offer containing the generated MSRP URL and assigns a local port number for the MSRP communication. + +**Table A.4.2-1: INVITE request (UE#1 to P-CSCF#1)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE sip:user2_public1@home2.net SIP/2.0 Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 70 Route: <sip:pcscf1.visited1.net:7531;lr;comp=sigcomp>, <sip:orig@scscf1.home1.net;lr> P-Preferred-Identity: "John Doe" <sip:user1_public1@home1.net> P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 Privacy: none From: <sip:user1_public1@home1.net>; tag=171828 To: <sip:user2_public1@home2.net> Call-ID: cb03a0s09a2sdfglkj490333 Cseq: 127 INVITE Require: sec-agree Proxy-Require: sec-agree Supported: gruu Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; port-c=8642; port-s=7531 Contact: <sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ;comp=sigcomp> Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE Accept: application/sdp, application/3gpp-ims+xml Content-Type: application/sdp Content-Length: (...)  v=0 o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd s=- c=IN IP6 5555::aaa:bbb:ccc:ddd t=0 0 m=message 2855 TCP/MSRP* a=accept-types:message/cpim text/plain text/html a=path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271/tcp a=max-size:131072 a=msrp-cema a=setup:active
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### SDP + +The SDP contains a set of content types supported by UE#1 and desired by the user at UE#1 for this session in the accept-types attribute and indicates the maximum size message that can be received by UE#1 in the max-size attribute. + +#### 2. 100 (Trying) response (P-CSCF#1 to UE#1) - see example in table A.4.2-2 + +The P-CSCF responds to the INVITE request with a 100 (Trying) response provisional response. + +**Table A.4.2-2: 100 (Trying) response (P-CSCF#1 to UE#1)** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 100 Trying Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 From: To: Call-ID: CSeq: Content-Length: 0
| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 3. INVITE request (P-CSCF#1 to S-CSCF#1) - see example in table A.4.2-3 + +The INVITE request is forwarded to the S-CSCF. + +**Table A.4.2-3: INVITE request (P-CSCF#1 to S-CSCF#1)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### 4. **100 (Trying) response (S-CSCF#1 to P-CSCF#1) - see example in table A.4.2-4** + +The S-CSCF responds to the INVITE request with a 100 (Trying) response provisional response. + +**Table A.4.2-4: 100 (Trying) response (S-CSCF#1 to P-CSCF#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 5. **Evaluation of initial filter criteria** + +S-CSCF#1 validates the service profile of this subscriber and evaluates the initial filter criteria. + +#### 6. **INVITE request (S-CSCF#1 to I-CSCF#2) - see example in table A.41-6** + +S-CSCF#1 forwards the INVITE request to the I-CSCF#2. + +**Table A.4.2-6: INVITE request (S-CSCF#1 to I-CSCF#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **7. 100 (Trying) response (I-CSCF#2 to S-CSCF#1) - see example in table A.4.2-7** + +I-CSCF#2 sends a 100 (Trying) response provisional response to S-CSCF#1. + +**Table A.4.2-7: 100 (Trying) response (I-CSCF#2 to S-CSCF#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **8. Cx: User Location Query procedure** + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +#### **9. INVITE request (I-CSCF#2 to S-CSCF#2) – see example in table A.4.2-9** + +I-CSCF#2 forwards the INVITE request to the S-CSCF#2 that will handle the session termination. + +**Table A.4.2-9: INVITE request (I-CSCF#2 to S-CSCF#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +Route: +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **10. 100 (Trying) response (S-CSCF#2 to I-CSCF#2) – see example in table A.4.2-10** + +S-CSCF#2 responds to the INVITE request with a 100 (Trying) response provisional response. + +**Table A.4.2-10: 100 (Trying) response (S-CSCF#2 to I-CSCF#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **11. Evaluation of initial filter criteria** + +S-CSCF#2 validates the service profile of this subscriber and evaluates the initial filter criteria. + +#### **12. INVITE request (S-CSCF#2 to P-CSCF#2) – see example in table A.4.2-12** + +S-CSCF#2 forwards the INVITE request, as determined by the termination procedure. S-CSCF#2 remembers (from the registration procedure) the UE Contact address and the next hop CSCF for this UE. + +**Table A.4.2-12: INVITE request (S-CSCF#2 to P-CSCF#2)** + +``` + +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +Route: +Record-Route: , , + +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **13. 100 (Trying) response (P-CSCF#2 to S-CSCF#2) – see example in table A.4.2-13** + +S-CSCF#2 receives a 100 (Trying) response provisional response to the INVITE request. + +**Table A.4.2-13: 100 (Trying) response (P-CSCF#2 to S-CSCF#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **14. INVITE request (P-CSCF#2 to UE#2) – see example in table A.4.2-14** + +P-CSCF#2 forwards the INVITE request to the terminating UE. + +**Table A.4.2-14: INVITE request (P-CSCF#2 to UE#2)** + +``` + +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 65 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **15. 100 (Trying) response (UE#2 to P-CSCF#2) – see example in table A.4.2-15** + +The terminating UE sends a 100 (Trying) response provisional response to P-CSCF#2. + +**Table A.4.2-15: 100 (Trying) response (UE#2 to P-CSCF#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + pscsf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + pscsf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **16. Reserve IP-CAN bearer for media** + +The terminating UE accepts the message session. The terminating UE reserves an IP-CAN bearer for the message session media component. + +#### **17. 200 (OK) response (UE#2 to P-CSCF#2) – see example in table A.4.2-17** + +After reserving an IP-CAN bearer for the message session media component the terminating UE sends a 200 (OK) response for the INVITE request containing SDP that indicates that the terminating UE has accepted the message session and listens on the MSRP TCP port returned in the path attribute in the answer for a TCP SETUP from the originating UE. + +**Table A.4.2-17: 200 (OK) response (UE#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: gruu +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim +a=path:msrp://[5555::eee:fff:aaa:bbb]:2855/s234167/tcp +a=max-size:65536 +a=msrp-cema +a=setup:passive + +``` + +##### **SDP** + +The SDP contains the set of offered content types supported by UE#2 and desired by the user at UE#2 for this session in the accept-types attribute and indicates the maximum size message that can be received by UE#2 in the max-size attribute. + +#### **18. 200 (OK) response (P-CSCF#2 to S-CSCF#2) – see example in table A.4.2-18** + +P-CSCF#2 forwards the 200 (OK) response to S-CSCF#2. + +**Table A.4.2-18: 200 (OK) response (P-CSCF#2 to S-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: John Smith" +Privacy: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **19. 200 (OK) response (S-CSCF#2 to I-CSCF#2) – see example in table A.4.2-19** + +S-CSCF#2 forwards the 200 (OK) response to I-CSCF#2. + +**Table A.4.2-19: 200 (OK) response (S-CSCF#2 to I-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: "John Smith" , +Privacy: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net; + term-ioi=home2.net +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; + ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd] +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **20. 200 (OK) response (I-CSCF#2 to S-CSCF#1) – see example in table A.4.2-20** + +I-CSCF#2 forwards the 200 (OK) response to S-CSCF#1. + +**Table A.4.2-20: 200 (OK) response (I-CSCF#2 to S-CSCF#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +Privacy: none +P-Charging-Vector: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **21. 200 (OK) response (S-CSCF#1 to P-CSCF#1) – see example in table A.4.2-21** + +S-CSCF#1 forwards the 200 (OK) response to P-CSCF#1. + +**Table A.4.2-21: 200 (OK) response (S-CSCF#1 to P-CSCF#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +Privacy: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +From: +To: +Call-ID: +CSeq: +Require: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **22. 200 (OK) response (P-CSCF#1 to UE#1) – see example in table A.4.2-22** + +P-CSCF#1 forwards the 200 (OK) response to the originating UE. + +**Table A.4.2-22: 200 (OK) response (P-CSCF#1 to UE#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **23. ACK request (UE#1 to P-CSCF#1) – see example in table A.4.2-23** + +The UE responds to the 200 (OK) response with an ACK request sent to the P-CSCF#1. + +**Table A.4.2-23: ACK request (UE#1 to P-CSCF#1)** + +``` + +ACK sip: user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 +;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , , + , +From: ;tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 + +``` + +#### **24. ACK request (P-CSCF#1 to S-CSCF#1) – see example in table A.4.2-24** + +The P-CSCF#1 forwards the ACK request to S-CSCF#1. + +**Table A.4.2-24: ACK request (P-CSCF#1 to S-CSCF#1)** + +``` + +ACK sip: user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 +;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +Route: , , +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **25. ACK request (S-CSCF#1 to S-CSCF#2) - see example in table A.4.2-25** + +The S-CSCF#1 forwards the ACK request to the S-CSCF#2. + +**Table A.4.2-25: ACK request (S-CSCF#1 to S-CSCF#2)** + +``` + +ACK sip: user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 +;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Route: , +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **26. ACK request (S-CSCF#2 to P-CSCF#2) – see example in table A.4.2-26** + +S-CSCF#1 forwards the ACK request to P-CSCF#2. + +**Table A.4.2-26: ACK request (S-CSCF#2 to P-CSCF#2)** + +``` + +ACK sip: [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **27. ACK request (P-CSCF#2 to UE#2) – see example in table A.4.2-27** + +P-CSCF#2 forwards the ACK request to the terminating UE. + +**Table A.4.2-27: ACK request (P-CSCF#2 to UE#2)** + +``` + +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **28. Reserve IP-CAN bearer for media** + +The originating UE reserves an IP-CAN bearer for the message session media component. + +#### **29. TCP setup** + +The originating UE establishes a TCP connection using the IP-CAN bearers established in step 16 and step 28 to the host address and the port as specified in the MSRP URL received in the SDP Answer from the terminating UE. + +#### **30. MSRP SEND request (UE#1 to UE#2) – see example in table A.4.2-30** + +The originating UE sends the first message over the MSRP session with an MSRP SEND request using the established TCP connection. + +**Table A.4.2-30: MSRP SEND request (UE#1 to UE#2)** + +``` + +MSRP d93kswow SEND +To-path:msrp://[5555::eee:fff:aaa:bbb]: 3333/s234167;tcp +From-path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271;tcp +Message-ID: 8822 +Byte-Range: 1-77/77 +Content-Type: "text/plain" + +those are my principles. If you don't like them I have others - Groucho Marx. +-----d93kswow$ + +``` + +- To-path:** The sender's remote path +- From-path:** The sender's local URL +- Message-ID:** A unique message ID for MSRP message. +- Byte-Range:** The Byte Range for this message. +- Content-Type:** The format of the body of the request. + +#### 31. MSRP 200 (OK) response (UE#2 to UE#1) – see example in table A.4.2-31 + +The terminating UE acknowledges the reception of the MSRP SEND request with an MSRP 200 (OK) response using the established TCP connection. + +**Table A.4.2-31: MSRP 200 (OK) response (UE#2 to UE#1)** + +``` + +MSRP d93kswow 200 OK +To-path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271;tcp +From-path:msrp://[5555::eee:fff:aaa:bbb]: 3333/s234167;tcp + +-----d93kswow$ + +``` + +### A.4.3 Establishing a session for session-based messaging with Intermediate Nodes + +Figure A.4.3-1 shows the establishment of a MSRP session between two users with intermediate nodes being added to the signalling path as well as the first message being sent over the established connection. + +It is assumed that both the originating UE and terminating UE are using an IP-CAN with a separate bearer for SIP signalling which means that each UE needs to reserve a new IP-CAN bearer for the message session media component. + +This example is simplified, the MRFC and MRFP functions are shown as combined with AS#1 and AS#2 in this example. + +![Sequence diagram showing SIP INVITE and 100 Trying messages between UE#1, P-CSCF#1, S-CSCF#1, AS#1, I-CSCF#2, S-CSCF#2, AS#2, P-CSCF#2, and UE#2 across four network domains: UE#1 Visited Network, UE#1 Home Network, UE#2 Home Network, and UE#2 Visited Network. The diagram includes internal processing steps like 'Evaluation of Initial Filter Criteria', 'HSS query', and 'Reserve IP-CAN bearer for media'.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` +sequenceDiagram + participant UE#1 + participant P-CSCF#1 + participant S-CSCF#1 + participant AS#1 + participant I-CSCF#2 + participant S-CSCF#2 + participant AS#2 + participant P-CSCF#2 + participant UE#2 + + Note left of UE#1: UE#1 Visited Network + Note left of S-CSCF#1: UE#1 Home Network + Note left of AS#2: UE#2 Home Network + Note left of UE#2: UE#2 Visited Network + + UE#1->>P-CSCF#1: 1. INVITE + P-CSCF#1-->>UE#1: 2. 100 Trying + P-CSCF#1->>S-CSCF#1: 3. INVITE + S-CSCF#1-->>P-CSCF#1: 4. 100 Trying + Note right of S-CSCF#1: 5. Evaluation of Initial Filter Criteria + S-CSCF#1->>AS#1: 6. INVITE + AS#1-->>S-CSCF#1: 7. 100 Trying + S-CSCF#1->>AS#1: 8. INVITE + AS#1-->>S-CSCF#1: 9. 100 Trying + S-CSCF#1->>I-CSCF#2: 10. INVITE + I-CSCF#2-->>S-CSCF#1: 11. 100 Trying + Note right of I-CSCF#2: 12. HSS query + I-CSCF#2->>S-CSCF#2: 13. INVITE + S-CSCF#2-->>I-CSCF#2: 14. 100 Trying + Note right of S-CSCF#2: 15. Evaluation of Initial Filter Criteria + S-CSCF#2->>AS#2: 16. INVITE + AS#2-->>S-CSCF#2: 17. 100 Trying + S-CSCF#2->>AS#2: 18. INVITE + AS#2-->>S-CSCF#2: 19. 100 Trying + S-CSCF#2->>P-CSCF#2: 20. INVITE + P-CSCF#2-->>S-CSCF#2: 21. 100 Trying + P-CSCF#2->>UE#2: 22. INVITE + UE#2-->>P-CSCF#2: 23. 100 Trying + Note right of UE#2: 24. Reserve IP-CAN bearer for media +``` + +Sequence diagram showing SIP INVITE and 100 Trying messages between UE#1, P-CSCF#1, S-CSCF#1, AS#1, I-CSCF#2, S-CSCF#2, AS#2, P-CSCF#2, and UE#2 across four network domains: UE#1 Visited Network, UE#1 Home Network, UE#2 Home Network, and UE#2 Visited Network. The diagram includes internal processing steps like 'Evaluation of Initial Filter Criteria', 'HSS query', and 'Reserve IP-CAN bearer for media'. + +![Sequence diagram showing the establishment of an MSRP session with intermediate nodes across four network domains: HE#1 Visited Network, HE#1 Home Network, HE#2 Home Network, and HE#2 Visited Network. The diagram illustrates the signaling flow between UE#1, P-CSCF#1, S-CSCF#1, AS#1, I-CSCF#2, S-CSCF#2, AS#2, P-CSCF#2, and UE#2. Key messages include 200 OK, ACK, TCP setup, and SEND messages. A callout box indicates step 46 as 'Reserve IP-CAN bearer for media'.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +The sequence diagram illustrates the establishment of an MSRP session across four network domains. The participants are: + + +- HE#1 Visited Network:** UE#1, P-CSCF#1 +- HE#1 Home Network:** S-CSCF#1, AS#1 +- HE#2 Home Network:** I-CSCF#2, S-CSCF#2, AS#2 +- HE#2 Visited Network:** P-CSCF#2, UE#2 + + The signaling flow is as follows: + + +- UE#1 sends a 200 OK (25) to P-CSCF#1. +- P-CSCF#1 sends a 200 OK (26) to S-CSCF#1. +- S-CSCF#1 sends a 200 OK (27) to AS#1. +- AS#1 sends an ACK (28) to S-CSCF#1. +- S-CSCF#1 sends an ACK (29) to P-CSCF#1. +- P-CSCF#1 sends an ACK (30) to UE#1. +- UE#1 and P-CSCF#1 perform a TCP setup (31). +- P-CSCF#1 sends a 200 OK (32) to S-CSCF#1. +- S-CSCF#1 sends a 200 OK (33) to AS#1. +- AS#1 sends an ACK (34) to S-CSCF#1. +- S-CSCF#1 sends an ACK (35) to P-CSCF#1. +- P-CSCF#1 sends an ACK (36) to UE#1. +- UE#1 and P-CSCF#1 perform another TCP setup (37). +- P-CSCF#1 sends a 200 OK (38) to S-CSCF#1. +- S-CSCF#1 sends a 200 OK (39) to AS#1. +- AS#1 sends an ACK (40) to S-CSCF#1. +- S-CSCF#1 sends an ACK (41) to P-CSCF#1. +- P-CSCF#1 sends an ACK (42) to UE#1. +- UE#1 sends a RESERVE IP-CAN bearer for media (46). +- P-CSCF#1 sends an ACK (44) to S-CSCF#1. +- S-CSCF#1 sends an ACK (45) to AS#1. +- AS#1 performs a TCP setup (47) with UE#1. +- UE#1 sends a SEND (48) to AS#1. +- AS#1 sends a SEND (49) to S-CSCF#2. +- S-CSCF#2 sends a SEND (50) to P-CSCF#2. +- P-CSCF#2 sends a 200 OK (51) to S-CSCF#2. +- S-CSCF#2 sends a 200 OK (52) to AS#2. +- AS#2 sends a 200 OK (53) to P-CSCF#1. + +Sequence diagram showing the establishment of an MSRP session with intermediate nodes across four network domains: HE#1 Visited Network, HE#1 Home Network, HE#2 Home Network, and HE#2 Visited Network. The diagram illustrates the signaling flow between UE#1, P-CSCF#1, S-CSCF#1, AS#1, I-CSCF#2, S-CSCF#2, AS#2, P-CSCF#2, and UE#2. Key messages include 200 OK, ACK, TCP setup, and SEND messages. A callout box indicates step 46 as 'Reserve IP-CAN bearer for media'. + +**Figure A.4.3-1: Establishment of MSRP session with Intermediate Nodes** + +The details of the signalling flows are as follows: + +#### **1. INVITE request (UE#1 to P-CSCF#1) - see example in table A.4.3-1** + +The originating UE#1 wants to initiate a session-based message session with the terminating UE#2. UE#1 creates a local MSRP URL, which can be used for the communication between the two user agents. It builds a SDP Offer containing the generated MSRP URL and assigns a local port number for the MSRP communication. + +**Table A.4.3-1: INVITE request (UE#1 to P-CSCF#1)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi=87654321; port1=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271/tcp +a=max-size:131072 +a=msrp-cema +a=setup:active + +``` + +**SDP** The SDP contains the set of content types supported by UE#1 and desired by the user at UE#1 for this session in the accept-types attribute and indicates the maximum size message that can be received by UE#1 in the max-size attribute. + +#### 2. 100 (Trying) response (P-CSCF#1 to UE#1) - see example in table A.4.3-2 + +The P-CSCF responds to the INVITE request with a 100 (Trying) response provisional response. + +**Table A.4.3-2: 100 (Trying) response (P-CSCF#1 to UE#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 3. INVITE request (P-CSCF#1 to S-CSCF#1) - see example in table A.4.3-3 + +The INVITE request is forwarded to the S-CSCF. + +**Table A.4.3-3: INVITE request (P-CSCF#1 to S-CSCF#1)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Access-Network-Info: +P-Charging-Vector: #### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### 4. **100 (Trying) response (S-CSCF#1 to P-CSCF#1) - see example in table A.4.3-4** + +The S-CSCF responds to the INVITE request with a 100 (Trying) response provisional response. + +**Table A.4.3-4: 100 (Trying) response (S-CSCF#1 to P-CSCF#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 5. **Evaluation of initial filter criteria** + +S-CSCF#1 validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:user1\_public1@home1.net S-CSCF#1 has origination initial filter criteria with service points of interest of Method = INVITE request and SDP m= 'message' and 'msrp' protocol that informs the S-CSCF to route the INVITE request to the AS sip:as1.home1.net. + +#### 6. **INVITE request (S-CSCF#1 to AS#1) - see example in table A.4.3-6** + +S-CSCF#1 forwards the INVITE request to the AS#1. + +**Table A.4.3-6: INVITE request (S-CSCF#1 to AS#1)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Route: , +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Access-Network-Info: +P-Charging-Vector: #####P-Charging-Function-Addresses: ##### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **7. 100 (Trying) response (AS#1 to S-CSCF#1) - see example in table A.4.3-7** + +AS#1 sends a 100 (Trying) response provisional response to S-CSCF#1. + +**Table A.4.3-7: 100 (Trying) response (AS#1 to S-CSCF#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +AS#1 establishes a TCP connection using the IP-CAN bearers established in step 1 to the host address and port as specified in the MSRP URL received in the SDP Offer from the originating UE#1. + +#### **8. INVITE request (AS#1 to S-CSCF#1) - see example in table A.4.3-8** + +AS#1 sends a new INVITE request to the S-CSCF#1 with the session attribute containing a unique URL for the AS#1 to receive media on. + +**Table A.4.3-8: INVITE request (AS#1 to S-CSCF#1)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP as1.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +Record-Route: +Route: +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: ### +Privacy: none +From: ; tag=234567 +To: +Call-ID: s09a233cbsdfglkj490303a0 +Cseq: 278 INVITE +Supported: +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933620 2987933620 IN IP6 7777::eee:ddd:ccc:aaa +s=- +c=IN IP6 7777::eee:ddd:ccc:aaa +t=0 0 +m=message 3927 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[7777::eee:ddd:ccc:aaa]:3927/s222371;tcp +a=max-size:65536 +a=msrp-cema +a=setup:active + +``` + +**Record-Route** The AS#1 includes a Record-Route header containing its SIP URI. + +**SDP** The SDP contains the set of offered content types allowed by the policy of network home1 in the accept-types attribute and indicates the maximum size message that can be received by UE#1 and allowed by the policy of network home1 in the max-size attribute. + +#### 9. 100 (Trying) response (S-CSCF#1 to AS#1) - see example in table A.4.3-9 + +S-CSCF#1 sends a 100 (Trying) response provisional response to AS#1. + +**Table A.4.3-9: 100 (Trying) response (S-CSCF#1 to AS#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP as1.home1.net;branch=z9hG4bK240f34.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 10. INVITE request (S-CSCF#1 to I-CSCF#2) – see example in table A.4.3-10 + +S-CSCF#1 forwards the INVITE request to the I-CSCF#2. As the S-CSCF#1 does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.4.3-10: INVITE request (S-CSCF#1 to I-CSCF#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 69 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= + +``` + +#### **11. 100 (Trying) response (I-CSCF#2 to S-CSCF#1) - see example in table A.4.3-11** + +I-CSCF#2 sends a 100 (Trying) response provisional response to S-CSCF#1. + +**Table A.4.3-11: 100 (Trying) response (I-CSCF#1 to S-CSCF#1)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **12. Cx: User Location Query procedure** + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +#### **13. INVITE request (I-CSCF#2 to S-CSCF#2) – see example in table A.4.3-13** + +I-CSCF#2 forwards the INVITE request to the S-CSCF#2 that will handle the session termination. + +**Table A.4.3-13: INVITE request (I-CSCF#2 to S-CSCF#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Route: , +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +NOTE: The I-CSCF does not add itself to the Record-Route header, as it has no need to remain in the signalling path once the session is established. + +#### 14. 100 (Trying) response (S-CSCF#2 to I-CSCF#2) – see example in table A.4.3-14 + +S-CSCF#2 responds to the INVITE request with a 100 (Trying) response provisional response. + +**Table A.4.3-14: 100 (Trying) response (S-CSCF#2 to I-CSCF#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 15. Evaluation of initial filter criteria + +S-CSCF#2 validates the service profile of this subscriber and evaluates the initial filter criteria. For sip:[user2\\_public1@home2.net](#) S-CSCF#2 has termination initial filter criteria with service points of interest of Method = INVITE request and SDP m = 'message' and 'msrp' protocol that informs the S-CSCF to route the INVITE request to the AS sip:as2.home2.net. + +#### 16. INVITE request (S-CSCF#2 to AS#2) – see example in table A.4.3-16 + +S-CSCF#2 forwards the INVITE request to AS#2 + +**Table A.4.3-16: INVITE request (S-CSCF#2 to AS#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 67 +Route: , +Record-Route: , , +P-Asserted-Identity: +P-Charging-Vector: +P-Charging-Function-Addresses: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **17. 100 (Trying) response (AS#2 to S-CSCF#2) – see example in table A.4.3-17** + +S-CSCF#2 receives a 100 (Trying) response provisional response to the INVITE request. + +**Table A.4.3-17: 100 (Trying) response (AS#2 to S-CSCF#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **18. INVITE request (AS#2 to S-CSCF#2) – see example in table A.4.3-18** + +AS#2 sends a new INVITE request to the S-CSCF#2 with the session attribute containing a unique URL for the AS#2 to receive media on. + +**Table A.4.3-18: INVITE request (AS#2 to S-CSCF#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP as2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +Route: +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: none +From: ; tag=7871654 +To: +Call-ID: 0s09glkj4903a2sdf33cb03a +Cseq: 210 INVITE +Supported: +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Accept: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933630 2987933630 IN IP6 9999::ccc:aaa:bbb:ddd +s=- +c=IN IP6 9999::ccc:aaa:bbb:ddd +t=0 0 +m=message 3333 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[9999::ccc:aaa:bbb:ddd]:3333/s317121;tcp +a=max-size:32768 +a=msrp-cema +a=setup:active + +``` + +**Record-Route** The AS#1 includes a Record-Route header containing its SIP URI. + +**SDP** The SDP contains the set of offered content types allowed by the policy of network home2 in the accept-types attribute and indicates the maximum size message that can be received by UE#1 and allowed by the policy of network home2 in the max-size attribute. + +#### 19. 100 (Trying) response (S-CSCF#2 to AS#2) – see example in table A.4.3-19 + +S-CSCF#2 receives a 100 (Trying) response provisional response to the INVITE request. + +**Table A.4.3-19: 100 (Trying) response (S-CSCF#2 to AS#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP as2.home2.net;branch=z9hG4bK348923.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 20. INVITE request (S-CSCF#2 to P-CSCF#2) – see example in table A.4.3-20 + +S-CSCF#2 forwards the INVITE request, as determined by the termination procedure. S-CSCF#2 remembers (from the registration procedure) the UE Contact address and the next hop CSCF for this UE. + +**Table A.4.3-20: INVITE request (S-CSCF#2 to P-CSCF#2)** + +``` +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +as2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +Route: +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **21. 100 (Trying) response (P-CSCF#2 to S-CSCF#2) – see example in table A.4.3-21** + +S-CSCF#2 receives a 100 (Trying) response provisional response to the INVITE request. + +**Table A.4.3-21: 100 (Trying) response (P-CSCF#2 to S-CSCF#2)** + +``` +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +as2.home2.net;branch=z9hG4bK348923.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### **22. INVITE request (P-CSCF#2 to UE#2) – see example in table A.4.3-22** + +P-CSCF#2 forwards the INVITE request to the terminating UE. + +**Table A.4.3-22: INVITE request (P-CSCF#2 to UE#2)** + +``` + +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + as2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +Record-Route: , , + +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **23. 100 (Trying) response (UE#2 to P-CSCF#2) – see example in table A.4.3-23** + +UE#2 sends a 100 (Trying) response provisional response to P-CSCF#2. + +**Table A.4.3-23: 100 (Trying) response (UE#2 to P-CSCF#2)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + as2.home2.net;branch=z9hG4bK348923.1 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **24. Reserve IP-CAN bearer for media** + +The terminating UE#2 accepts the message session and. UE#2 reserves an IP-CAN bearer for the message session media component. + +#### **25. 200 (OK) response (UE#2 to P-CSCF#2) – see example in table A.4.3-25** + +After reserving an IP-CAN bearer for the message session media component, the terminating UE#2 sends a 200 (OK) response for the INVITE request containing SDP that indicates that UE#2 has accepted the message session and listens on the MSRP TCP port returned in the path attribute in the answer for a TCP SETUP from AS#2. + +**Table A.4.3-25: 200 (OK) response (UE#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + as2.home2.net;branch=z9hG4bK348923.1 +Record-Route: , , , + +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: tag=7871654 +To: ;tag=999456 +Call-ID: 0s09glkj4903a2sdf33cb03a +Cseq: 210 INVITE +Supported: gruu +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 29879336302987933630IN IP6 5555::eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim +a=path:msrp://[5555::eee:fff:aaa:bbb]:2855/s417121/tcp +a=max-size:65536 +a=msrp-cema +a=setup:passive + +``` + +**SDP** The SDP contains the set of offered content types supported by UE#2 and desired by the user at UE#2 for this session in the accept-types attribute and indicates the maximum size message that can be received by UE#2 in the max-size attribute. + +#### 26. 200 (OK) response (P-CSCF#2 to S-CSCF#2) – see example in table A.4.3-26 + +P-CSCF#2 forwards the 200 (OK) response to S-CSCF#2. + +**Table A.4.3-26: 200 (OK) response (P-CSCF#2 to S-CSCF#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +as2.home2.net;branch=z9hG4bK348923.1 +Record-Route: +P-Asserted-Identity: "John Smith" +Privacy: +P-Charging-Vector: ### +P-Access-Network-Info: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **27. 200 (OK) response (S-CSCF#2 to AS#2) – see example in table A.4.3-27** + +S-CSCF#2 forwards the 200 (OK) response to AS#2. + +**Table A.4.3-27: 200 (OK) response (S-CSCF#2 to AS#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP as2.home2.net;branch=z9hG4bK348923.1 +Record-Route: +P-Asserted-Identity: "John Smith" , +Privacy: +P-Charging-Vector: ### +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **28. ACK request (AS#2 to S-CSCF#2) – see example in table A.4.3-28** + +AS#2 generates a new ACK request and sends it to S-CSCF#2. + +**Table A.4.3-28: ACK request (AS#2 to S-CSCF#2)** + +``` + +ACK sip: user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 +;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP as2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 70 +Route: , +From: ;tag=7871654 +To: ;tag=2217770 +Call-ID: 0s09glkj4903a2sdf33cb03a +Cseq: 210 ACK +Content-Length: 0 + +``` + +#### **29. ACK request (S-CSCF#2 to P-CSCF#2) – see example in table A.4.3-29** + +S-CSCF#1 forwards the ACK request to P-CSCF#2. + +**Table A.4.3-29: ACK request (S-CSCF#2 to P-CSCF#2)** + +``` + +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +as2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **30. ACK request (P-CSCF#2 to UE#2) – see example in table A.4.3-30** + +P-CSCF#2 forwards the ACK request to UE#2. + +**Table A.4.3-30: ACK request (P-CSCF#2 to UE#2)** + +``` + +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +as2.home2.net;branch=z9hG4bK348923.1 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **31. TCP setup** + +AS#2 establishes a TCP connection using the IP-CAN bearers established in step 24 to the host address and port as specified in the MSRP URL received in the SDP Answer from UE#2. + +#### **32. 200 (OK) response (AS#2 to S-CSCF#2) – see example in table A.4.3-32** + +AS#2 generates a 200 (OK) response to S-CSCF#2. + +**Table A.4.3-32: 200 (OK) response (AS#2 to S-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Record-Route: , , +P-Asserted-Identity: "John Smith" , +Privacy: +P-Charging-Vector: ### +From: tag=234567 +To: ;tag=98989823 +Call-ID: s09a233cbsdfglkj490303a0 +CSeq: 278 INVITE +Supported: gruu +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933640 2987933640 IN IP6 9999::ccc:aaa:bbb:ddd +s=- +c=IN IP6 9999::ccc:aaa:bbb:dddt=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[9999::ccc:aaa:bbb:ddd]:2855/s317122/tcp +a=max-size:32768 +a=msrp-cema +a=setup:passive + +``` + +##### **SDP** + +The SDP contains the set of answered content types supported by UE#2 in the accept-types attribute and indicates the maximum size message that can be received by UE#2 and allowed by the policy of network home2 in the max-size attribute. + +#### **33. 200 (OK) response (S-CSCF#2 to I-CSCF#2) – see example in table A.4.3-33** + +S-CSCF#2 forwards the 200 (OK) response to I-CSCF#2. + +**Table A.4.3-33: 200 (OK) response (S-CSCF#2 to I-CSCF#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +P-Asserted-Identity: "John Smith" , +Privacy: +P-Charging-Vector: ### +P-Charging-Function-Addresses: ### +From: +To: +Call-ID: +CSeq: +Supported +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **34. 200 (OK) response (I-CSCF#2 to S-CSCF#1) – see example in table A.4.3-34** + +I-CSCF#2 forwards the 200 (OK) response to S-CSCF#1. + +**Table A.4.3-34: 200 (OK) response (I-CSCF#2 to S-CSCF#1)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +P-Asserted-Identity: +Privacy: none +P-Charging-Vector: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **35. 200 (OK) response (S-CSCF#1 to AS#1) – see example in table A.4.3-35** + +S-CSCF#1 forwards the 200 (OK) response to AS#1. + +**Table A.4.3-35: 200 (OK) response (S-CSCF#1 to AS#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP as1.home1.net;branch=z9hG4bK240f34.1 +Record-Route: +P-Asserted-Identity: +Privacy: +P-Charging-Vector: +P-Charging-Function-Addresses: ### +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **36. ACK request (AS#1 to S-CSCF#1) - see example in table A.4.3-36** + +AS#1 generates an ACK request and sends it to S-CSCF#1. + +**Table A.4.3-36: ACK request (AS#1 to S-CSCF#1)** + +``` + +ACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP as1.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 70 +Route: , , +From: ; tag=234567 +To: ;tag=98989823 +Call-ID: s09a233cbsdfglkj490303a0 +Cseq: 278 ACK +Content-Length: 0 + +``` + +#### **37. ACK request (S-CSCF#1 to S-CSCF#2) - see example in table A.4.3-37** + +The S-CSCF#1 forwards the ACK request to S-CSCF#2. + +**Table A.4.3-37: ACK request (S-CSCF#1 to S-CSCF#2)** + +``` + +ACK sip: user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP as1.home1.net;branch= +z9hG4bK240f34.1 +Max-Forwards: 69 +Route: , +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **38. ACK request (S-CSCF#2 to AS#2) - see example in table A.4.3-38** + +The S-CSCF#2 forwards the ACK request to the AS#2. + +**Table A.4.3-38: ACK request (S-CSCF#2 to AS#2)** + +``` + +ACK sip: user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + as1.home1.net;branch=z9hG4bK240f34.1 +Max-Forwards: 68 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **39. TCP setup** + +AS#1 establishes a TCP connection to the host address and port as specified in the MSRP URL received in the SDP Answer from the AS#2. + +#### **40. 200 (OK) response (AS#1 to S-CSCF#1) – see example in table A.4.3-40** + +AS#1 generates a 200 (OK) response and sends it to S-CSCF#1. + +**Table A.4.3-40: 200 (OK) response (AS#1 to S-CSCF#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +P-Asserted-Identity: +Privacy: +P-Charging-Vector: ### +From: ;tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +CSeq: 127 INVITE +Supported +Contact: +Allow: +Content-Type: +Content-Length: + +v=0 +o=- 2987933642 2987933642 IN IP6 7777::eee:ddd:ccc:aaa +s=- +c=IN IP6 7777::eee:ddd:ccc:aaa +t=0 0 +m=message 3927 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[7777::eee:ddd:ccc:aaa]:3927/s222372;tcp +a=max-size:32768 +a=msrp-cema +a=setup:passive + +``` + +##### **SDP** + +The SDP contains the set of answered content types supported by UE#2 in the accept-types attribute and indicates the maximum size message that can be received by UE#2 and allowed by the policy of network home1 in the max-size attribute. + +#### **41. 200 (OK) response (S-CSCF#1 to P-CSCF#1) – see example in table A.4.3-41** + +S-CSCF#1 forwards the 200 (OK) response to P-CSCF#1. + +**Table A.4.3-41: 200 (OK) response (S-CSCF#1 to P-CSCF#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +Privacy: +P-Charging-Vector: ### +From: +To: +Call-ID: +CSeq: +Require: +Supported +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **42. 200 (OK) response (P-CSCF#1 to UE#1) – see example in table A.4.3-42** + +P-CSCF#1 forwards the 200 (OK) response to UE#1 + +**Table A.4.3-42: 200 (OK) response (P-CSCF#1 to UE#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Supported +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **43. ACK request (UE#1 to P-CSCF#1) – see example in table A.4.3-43** + +The UE responds to the 200 (OK) response with an ACK request sent to the P-CSCF#1. + +**Table A.4.3-43: ACK request (UE#1 to P-CSCF#1)** + +``` + +ACK sip: user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , , + +From: ;tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 + +``` + +#### **44. ACK request (P-CSCF#1 to S-CSCF#1) – see example in table A.4.3-44** + +The P-CSCF#1 forwards the ACK request to the S-CSCF#1. + +**Table A.4.3-44: ACK request (P-CSCF#1 to S-CSCF#1)** + +``` + +ACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +P-Access-Network-Info: +Route: , +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **45. ACK request (S-CSCF#1 to AS#1) - see example in table A.4.3-45** + +The S-CSCF#1 forwards the ACK request to AS#1. + +**Table A.4.3-45: ACK request (S-CSCF#1 to AS#1)** + +``` + +ACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK344a65.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **46. Reserve IP-CAN bearer for media** + +UE#1 reserves an IP-CAN bearer for the message session media component. + +#### **47. TCP setup** + +Originating UE#1 establishes a TCP connection using the IP-CAN bearers established in step 46 to the host address and port as specified in the MSRP URL received in the SDP Answer from AS#1. + +#### **48. MSRP SEND (UE#1 to AS#1) – see example in table A.4.3-48** + +The originating UE sends the first message over the MSRP session with a MSRP SEND request using the established TCP connection. + +**Table A.4.3-48: MSRP SEND (UE#1 to AS#1)** + +``` + +MSRP 34kjf94 SEND +To-path:msrp://[7777::eee:ddd:ccc:aaa]:3927/s222372/tcp +From-path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271/tcp +Message-ID: 8822 +Byte-Range: 1-89/89 +Content-Type: "text/plain" + +I will never be a member of a club that accepts people like me as members - Groucho Marx. +-----34kjf94$ + +``` + +- To-path:** The sender's remote path. +- From-path:** The sender's local URL. +- Message-ID:** A unique message ID for MSRP message. +- Byte-Range:** The Byte Range for this message. +- Content-Type:** The format of the body of the request. + +#### **49. MSRP SEND (AS#1 to AS#2) – see example in table A.4.3-49** + +AS#1 forwards the first MSRP SEND request to AS#2 over the MSRP session using the established TCP connection. + +**Table A.4.3-49: MSRP SEND (AS#1 to AS#2)** + +``` + +MSRP shfsoi3 SEND +To-path:msrp://[9999::ccc:aaa:bbb:ddd]:3333/s317122/tcp +From-path:msrp://[7777::eee:ddd:ccc:aaa]:3927/s222371/tcp +Message-ID: 2832 +Byte-Range: 1-89/89 +Content-Type: "text/plain" + +I will never be a member of a club that accepts people like me as members - Groucho Marx. +-----shfsoi3$ + +``` + +- To-path:** The sender's remote path. +- From-path:** The sender's local URL. +- Message-ID:** A unique message ID for MSRP message. +- Byte-Range:** The Byte Range for this message. +- Content-Type:** The format of the body of the request. + +#### **50. MSRP SEND (AS#2 to UE#2) – see example in table A.4.3-50** + +AS#2 forwards the first MSRP SEND request to UE#2 over the MSRP session using the established TCP connection. + +**Table A.4.3-50: MSRP SEND (AS#2 to UE#2)** + +``` + +MSRP 2oid4sf SEND +To-path:msrp://[5555::eee:fff:aaa:bbb]:3335/s417121/tcp +From-path:msrp://[9999::ccc:aaa:bbb:ddd]:3333/s317121/tcp +Message-ID: 3311 +Byte-Range: 1-89/89 +Content-Type: "text/plain" + +I will never be a member of a club that accepts people like me as members - Groucho Marx. +-----2oid4sf$ + +``` + +- To-path:** The sender's remote path. +- From-path:** The sender's local URL. +- Message-ID:** A unique message ID for MSRP message. +- Byte-Range:** The Byte Range for this message. +- Content-Type:** The format of the body of the request. + +#### **51. MSRP 200 (OK) response (UE#2 to AS#2) – see example in table A.4.3-51** + +The receiving UE#2 acknowledges the reception of the MSRP SEND request with a MSRP 200 (OK) response sent using the established TCP connection. + +**Table A.4.3-51: MSRP 200 (OK) response (UE#2 to AS#2)** + +``` +MSRP 2oid4sf 200 OK +To-path:msrp://[9999::ccc:aaa:bbb:ddd]:3333/s317121/tcp +From-path:msrp://[5555::eee:fff:aaa:bbb]:3335/s417121/tcp + +-----2oid4sf2j32ri3$ +``` + +#### **52. MSRP 200 (OK) response (AS#2 to AS#1) – see example in table A.4.3-52** + +AS#2 acknowledges the reception of the MSRP SEND request with a MSRP 200 (OK) response to AS#1 using the established TCP connection. + +**Table A.4.3-52: MSRP 200 (OK) response (AS#2 to AS#1)** + +``` +MSRP shfsoi3 200 OK +To-path:msrp://[7777::eee:ddd:ccc:aaa]:3927/s222371/tcp +From-path:msrp://[9999::ccc:aaa:bbb:ddd]:3333/s317122/tcp + +-----hfsoi3$ +``` + +#### **53. MSRP 200 (OK) response (AS#1 to UE#1) – see example in table A.4.3-53** + +AS#1 acknowledges the reception of the MSRP SEND request with a MSRP 200 (OK) response to UE#1 sent using the established TCP connection. + +**Table A.4.3-53: MSRP 200 (OK) response (AS#1 to UE#1)** + +``` +MSRP 34kjf94 200 OK +To-path:msrp://[555::aaa:bbb:ccc:ddd]:2855/s111271/tcp +From-path:msrp://[7777::eee:ddd:ccc:aaa]:3927/s222372/tcp +-----34kjf94$ +``` + +### A.4.4 Establishing a session for session-based messaging with preconditions + +This signalling flow is not provided as it is the same as the session establishment flows with preconditions in 3GPP TS 24.228 [4] except that the SDP contents are for setting up MSRP sessions over TCP rather than RTP sessions over UDP. + +## A.5 Flows demonstrating session-based messaging conferences + +### A.5.1 User connecting into a messaging conference + +![Sequence diagram showing the flow of a messaging conference connection from UE#1 through various network elements (P-CSCF, S-CSCF, I-CSCF, HSS, MRFC/AS, MRFP) across different network domains (Visited Network, UE#1 Home Network, MRFC/AS Home Network).](18e519d1f91133e080347562f681dfb5_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant P-CSCF + participant S-CSCF + participant I-CSCF + participant HSS + participant MRFC/AS + participant MRFP + + Note left of UE#1: Visited Network + Note left of S-CSCF: UE#1 Home Network + Note left of MRFC/AS: MRFC/AS Home Network + + UE#1->>P-CSCF: 1. INVITE + P-CSCF-->>UE#1: 2. 100 Trying + P-CSCF->>S-CSCF: 3. INVITE + S-CSCF-->>P-CSCF: 4. 100 Trying + Note right of S-CSCF: 5. Evaluation of initial Filter Criteria + S-CSCF->>I-CSCF: 6. INVITE + I-CSCF-->>S-CSCF: 7. 100 Trying + Note right of I-CSCF: 8. PSI location query + I-CSCF->>MRFC/AS: 9. INVITE + MRFC/AS-->>I-CSCF: 10. 100 Trying + Note right of MRFC/AS: 11. H.248 interaction to create conference connection resources for UE#1 + MRFC/AS->>I-CSCF: 12. 200 OK + I-CSCF->>S-CSCF: 13. 200 OK + S-CSCF->>P-CSCF: 14. 200 OK + Note right of P-CSCF: 15. Authorize QoS resources + P-CSCF-->>UE#1: 16. 200 OK + UE#1->>P-CSCF: 17. ACK + P-CSCF->>S-CSCF: 18. ACK + S-CSCF->>I-CSCF: 19. ACK + I-CSCF->>MRFC/AS: 20. ACK + Note left of UE#1: 21. Resource Reservation + Note right of MRFP: 22. TCP setup + UE#1->>MRFP: 23. SEND + MRFP-->>UE#1: 24. 200 OK + +``` + +Sequence diagram showing the flow of a messaging conference connection from UE#1 through various network elements (P-CSCF, S-CSCF, I-CSCF, HSS, MRFC/AS, MRFP) across different network domains (Visited Network, UE#1 Home Network, MRFC/AS Home Network). + +**Figure A.5.1-1: User connecting into a messaging conference - network MRFC/AS is not located in user's home network - conference URI resolved by the terminating home network** + +Figure A.5.1-1 shows an user calling into a messaging conference by using a conference URI. The focus of that conference is at a MRFC/AS which are located in another network. The conference URI in this example cannot be resolved by the originating home network + +The details of the flows are as follows: + +#### 1. INVITE request (UE to P-CSCF) - see example in table A.5.1-1 + +A UE wants to join a messaging conference. For this purpose the UE is aware of the related conference URI that was obtained by means outside the present document (e.g. via other protocols, such as http). + +The originating UE creates a local MSRP URL, which can be used for communication for the messaging conference. It builds a SDP Offer containing the generated MSRP URL and assigns a local port number for the MSRP communication. + +The UE sends the INVITE request to the P-CSCF. + +**Table A.5.1-1: INVITE request (UE to P-CSCF)** + +``` + +INVITE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: "John Doe" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s11271;tcp +a=max-size:131072 +a=msrp-cema +a=setup:active + +``` + +**SDP** The SDP contains a set of content types supported by UE#1 and desired by the user at UE#1 for this session in the accept-types attribute and indicates the maximum size message that can be received by UE#1 in the max-size attribute. + +#### 2. 100 (Trying) response (P-CSCF to UE) - see example in table A.5.1-2 + +The P-CSCF responds to the INVITE request (1) with a 100 (Trying) response provisional response. + +**Table A.5.1-2: 100 (Trying) response (P-CSCF to UE)** + +``` + +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 3. INVITE request (P-CSCF to S-CSCF) - see example in table A.5.1-3 + +The P-CSCF forwards the INVITE request to the S-CSCF. + +**Table A.5.1-3: INVITE request (P-CSCF to S-CSCF)** + +``` +INVITE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +Record-Route: +P-Asserted-Identity: "John Doe" +P-Access-Network-Info: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +``` + +#### 4. 100 (Trying) response (S-CSCF to P-CSCF) - see example in table A.5.1-4 + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) response provisional response. + +**Table A.5.1-4: 100 (Trying) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 5. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +#### 6. INVITE request (S-CSCF to I-CSCF) - see example in table A.5.1-6 + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the INVITE request directly to the I-CSCF in the destination network. + +As the S-CSCF does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.5.1-6: INVITE request (S-CSCF to I-CSCF)** + +``` + +INVITE sip:conferencel@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: "John Doe" , +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= + +``` + +#### **7. 100 (Trying) response (I-CSCF to S-CSCF) - see example in table A.5.1-7 (related to table A.5.1-6)** + +The I-CSCF responds to the INVITE request (6) with a 100 (Trying) response provisional response. + +**Table A.5.1-7: 100 (Trying) response (I-CSCF to S-CSCF)** + +``` + +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **8. Public service identity (PSI) location query** + +The I-CSCF sends a query to the HSS to find out the MRFC/AS at which the conference has been created. The HSS responds with the address of the MRFC/AS at which the conference is hosted. The HSS responds with the address of the MRFC/AS. + +For detailed message flows see [5]. + +#### 9. INVITE request (I-CSCF to MRFC/AS) - see example in table A.5.1-9 + +I-CSCF forwards the INVITE request to the MRFC/AS that was resolved during the PSI location query (8). The I-CSCF does not re-write the Request URI. + +**Table A.5.1-9: INVITE request (I-CSCF to MRFC/AS)** + +``` + +INVITE sip:conference1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Allow: +Accept: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= + +``` + +#### 10. 100 (Trying) response (MRFC/AS to I-CSCF) - see example in table A.5.1-10 (related to table A.5.1-9) + +The MRFC/AS responds to the INVITE request (9) with a 100 (Trying) response provisional response. + +**Table A.5.1-10: 100 (Trying) response (MRFC/AS to I-CSCF)** + +``` + +SIP/2.0 100 (Trying) response +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### 11. H.248 interaction to create conference connection resources for UE#1 + +MRFC initiates a H.248 interaction to create an connection point for UE#1 in MRFP. + +#### 12. 200 (OK) response (MRFC/AS to I-CSCF) - see example in table A.5.1-12 (related to table A.5.1-9) + +The MRFC/AS sends a 200 (OK) response for the INVITE request containing SDP that indicates that the MRFC/AS has accepted the message session and listens on the MSRP TCP port returned in the path attribute in the answer for a TCP SETUP from the originating UE. The MRFC/AS sends a 200 (OK) response final response to the INVITE request (9) to the I-CSCF. + +**Table A.5.1-12: 200 (OK) response (MRFC/AS to I-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: "Conference Server" +P-Charging-Vector: ### +P-Charging-Function-Addresses: ### +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: +Contact: ;isfocus +Allow-Events: conference, pending-additions +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933623 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[9999:: aaa:bbb:ccc:ddd]:2855/s317122/tcp +a=max-size:32768 +a=msrp-cema +a=setup:passive + +``` + +**SDP** The SDP contains a set of offered content types supported by the MRFC/AS for this session in the accept-types attribute and indicates the maximum size message that can be received by the MRFC/AS in the max-size attribute. + +#### 13. 200 (OK) response (I-CSCF to S-CSCF) - see example in table A.5.1-13 + +The I-CSCF sends a 200 (OK) response final response along the signalling path back to the S-CSCF. + +**Table A.5.1-13: 200 (OK) response (I-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= + +``` + +#### **14. 200 (OK) response (S-CSCF to P-CSCF) - see example in table A.5.1-14** + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to the P-CSCF. + +**Table A.5.1-14: 200 (OK) response (S-CSCF to P-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: ### +P-Charging-Function-Addresses: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +``` + +#### **15. Authorize QoS Resources** + +The P-CSCF authorizes the resources necessary for this session. + +#### **16. 200 (OK) response (P-CSCF to UE) - see example in table A.5.1-16** + +The P-CSCF forwards the 200 (OK) response final response including the media authorisation token to the session originator. + +**Table A.5.1-16: 200 (OK) response (P-CSCF to UE)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Contact: +Allow-Events: +Allow: +Content-Type: +Content-Length: +``` + +#### 17. ACK request (UE to P-CSCF) - see example in table A.5.1-17 + +The UE starts the media flow for this session, and responds to the 200( OK) response (16) with an ACK request sent to the P-CSCF. + +**Table A.5.1-17: ACK request (UE to P-CSCF)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +#### 18. ACK request (P-CSCF to S-CSCF) - see example in table A.5.1-18 + +The P-CSCF forwards the ACK request to the S-CSCF. + +**Table A.5.1-18: ACK request (P-CSCF to S-CSCF)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### 19. ACK request (S-CSCF to I-CSCF) - see example in table A.5.1-19 + +The S-CSCF performs an analysis of the destination address, and determines the network operator to whom the destination subscriber belongs. Since the originating operator does not desire to keep their internal configuration hidden, the S-CSCF forwards the ACK request directly to the I-CSCF in the destination network. + +As the S-CSCF does not know whether the I-CSCF at home2.net is a loose router or not, it does not introduce a Route header. + +**Table A.5.1-19: ACK request (S-CSCF to I-CSCF)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### 20. ACK request (I-CSCF to MRFC/AS) - see example in table A.5.1-20 + +I-CSCF forwards the ACK request to the MRFC/AS that was resolved during the PSI location query (8). The I-CSCF does not re-write the Request URI. + +**Table A.5.1-20: ACK request (I-CSCF to MRFC/AS)** + +``` +ACK sip:conference1@home2.net:2342 SIP/2.0 +Via: SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 67 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### 21. Reserve IP-CAN bearer for media + +The UE reserves an IP-CAN bearer for the message session media component. + +#### 22. TCP setup + +Originating UE establishes a TCP connection using the IP-CAN bearers established in step 21 to the host address and port as specified in the MSRP URL received in the SDP Answer from MRFC/AS. + +#### 23. MSRP SEND request (UE to MRFP) – see example in table A.5.1-23 + +The originating UE sends the first message over the MSRP session with an MSRP SEND request using the established TCP connection. + +**Table A.5.1-23: MSRP SEND request (UE to MRFP)** + +``` +MSRP a97ghjut SEND +To-path:msrp://[9999::ccc:aaa:bbb:ddd]:2855/s317122/tcp +From-path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271/tcp +Message-ID: 9972 +Byte-Range: 1-77/77 +Content-Type: "text/plain" +those are my principles. If you don't like them I have others - Groucho Marx. +-----a97ghjut$ +``` + +**To-path:** The sender's remote path + +**From-path:** The sender's local URL + +**Message-ID:** A unique message ID for MSRP message. + +**Byte-Range:** The Byte Range for this message. + +**Content-Type:** The format of the body of the request. + +#### 24. MSRP 200 (OK) response (MRFP to UE) – see example in table A.5.1-24 + +The MRFP acknowledges the reception of the MSRP SEND request with an MSRP 200 (OK) response using the established TCP connection. + +**Table A.5.1-24: MSRP 200 (OK) response (MRFP to UE)** + +``` +MSRP a97ghjut 200 OK +To-path:msrp://[9999::ccc:aaa:bbb:ddd]:2855/s317122/tcp +From-path:msrp://[5555::aaa:bbb:ccc:ddd]:2855/s111271/tcp +-----a97ghjut$ +``` + +### A.5.2 MRFC/AS invites a user to a messaging conference + +Figure A.5.2-1 shows an MRFC/AS inviting a user to a messaging conference. The invitation is sent as a result of user1@home1.net sending a REFER request to the MRFC/AS. The MRFC/AS is located in a different network than user's S-CSCF. The flows for inviting a user to a conference using REFER are shown in TS 24.147 [10]. + +![Sequence diagram showing the interaction between UE#1 Home Network, UE#2 Home Network, and UE#2 Visited Network for a conference call setup.](61a7f401eb46fe99a71f27bc37493f04_img.jpg) + +The sequence diagram illustrates the interaction between the following entities: + +- UE#1 Home Network:** MRFP, MRFC/AS +- UE#2 Home Network:** I-CSCF, S-CSCF +- UE#2 Visited Network:** P-CSCF, UE#2 + +The sequence of messages is as follows: + +- MRFC/AS → I-CSCF: 1. INVITE +- I-CSCF → MRFC/AS: 2. 100 Trying +- I-CSCF → S-CSCF: 3. HSS query +- I-CSCF → S-CSCF: 4. INVITE +- S-CSCF → I-CSCF: 5. 100 Trying +- S-CSCF → P-CSCF: 6. Evaluation of initial Filter Criteria +- S-CSCF → P-CSCF: 7. INVITE +- P-CSCF → S-CSCF: 8. 100 Trying +- P-CSCF → UE#2: 9. Authorize QoS resources +- P-CSCF → UE#2: 10. INVITE +- UE#2 → P-CSCF: 11. 100 Trying +- UE#2 → P-CSCF: 12. Resource Reservation +- P-CSCF → UE#2: 13. 200 OK +- P-CSCF → S-CSCF: 14. 200 OK +- S-CSCF → I-CSCF: 15. 200 OK +- I-CSCF → MRFC/AS: 16. 200 OK +- MRFC/AS → S-CSCF: 17. ACK +- S-CSCF → P-CSCF: 18. ACK +- P-CSCF → UE#2: 19. ACK +- MRFP ↔ MRFC/AS: 20. H.248 interaction to create conference connection resources for UE#2 +- MRFP ↔ UE#2: 21. TCP setup +- MRFP → UE#2: 22. SEND +- MRFP → UE#2: 23. 200 OK + +Sequence diagram showing the interaction between UE#1 Home Network, UE#2 Home Network, and UE#2 Visited Network for a conference call setup. + +**Figure A.5.2-1: MRFC/AS inviting a user to a messaging conference - MRFC/AS routes directly to I-CSCF** + +The details of the flows are as follows: + +#### **1. INVITE request (MRFC/AS to I-CSCF) - see example in table A.5.2-1** + +In this example, the MRFC/AS is capable of resolving the terminating users I-CSCF address for this request. As a result of a DNS query, it has received the address of the I-CSCF as the next hop. + +The MRFC/AS invites a user to a messaging conference as it received a REFER request from another user. + +The MRFC/AS creates a local MSRP URL, which can be used for communication for the messaging conference. It builds a SDP Offer containing the generated MSRP URL and assigns a local port number for the MSRP communication. + +**Table A.5.2-1: INVITE request (MRFC/AS to I-CSCF)** + +``` +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: none +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Referred-By: +Contact: ;isfocus +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY, PUBLISH +Allow-Events: conference, pending-additions +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::abc:def:abc:def +s=- +c=IN IP6 5555::abc:def:abc:def +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html +a=path:msrp://[5555::abc:def:abc:def]:2855/s111271;tcp +a=max-size:32768 +a=msrp-cema +a=setup:active +``` + +**SDP** The SDP contains a set of content types supported by the MRFC/AS for this session in the accept-types attribute and indicates the maximum size message that can be received by the MRFC/AS in the max-size attribute. + +#### **2. 100 (Trying) response (I-CSCF to MRFC/AS) - see example in table A.5.2-2** + +The I-CSCF responds to the INVITE request with a 100 (Trying) provisional response. + +**Table A.5.2-2: 100 (Trying) response (I-CSCF to MRFC/AS)** + +``` +SIP/2.0 100 Trying +Via: SIP/2.0/UDP conferencel@mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### **3. Cx: User Location Query procedure** + +The I-CSCF sends a query to the HSS to find out the S-CSCF of the called user. The HSS responds with the address of the current S-CSCF for the terminating subscriber. + +For detailed message flows see 3GPP TS 29.228[11]. + +#### 4. INVITE request (I-CSCF to S-CSCF) - see example in table A.5.2-4 + +The INVITE request is forwarded to the S-CSCF. + +**Table A.5.2-4: INVITE request (I-CSCF to S-CSCF)** + +``` +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +P-Asserted-Identity: +P-Charging-Vector: +Privacy: +From: +To: +Call-ID: +Cseq: +Referred-By: +Contact: +Allow: +Allow-Events: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### 5. 100 (Trying) response (S-CSCF to I-CSCF) - see example in table A.5.2-5 + +The S-CSCF responds to the INVITE request (3) with a 100 (Trying) provisional response. + +**Table A.5.2-5: 100 (Trying) response (S-CSCF to I-CSCF)** + +``` +SIP/2.0 100 Trying +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 +``` + +#### 6. Evaluation of initial filter criteria + +The S-CSCF validates the service profile of this subscriber and evaluates the initial filter criteria. + +#### 7. INVITE request (S-CSCF to P-CSCF) - see example in table A.5.2-7 + +S-CSCF remembers (from registration procedures) the contact address of UE#2 and determines the P-CSCF assigned for UE#2 and routes message there. + +**Table A.5.2-7: INVITE request (S-CSCF to P-CSCF)** + +``` + +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +Record-Route: +P-Asserted-Identity: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +Cseq: +Referred-By: +Contact: +Allow: +Allow-Events: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **8. 100 (Trying) response (P-CSCF to S-CSCF) - see example in table A.5.2-8** + +The P-CSCF responds to the INVITE request (6) with a 100 (Trying) provisional response. + +**Table A.5.2-8: 100 (Trying) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 100 Trying +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +From: +To: +Call-ID: +CSeq: +Content-Length: 0 + +``` + +#### **9. Authorize QoS resources** + +The P-CSCF authorizes the resources necessary for this session. + +#### 10. INVITE request (P-CSCF to UE#2) - see example in table A.5.2-10 + +P-CSCF forwards the request to UE#2 including the Media Authorisation token. + +**Table A.5.2-10: INVITE request (P-CSCF to UE#2)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1 SIP/2.0/UDP     scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP     mrfc1.home1.net;branch=z9hG4bK23273846 Max-Forwards: 67 Record-Route: <sip:pcscf2.visited2.net:5088;lr;comp=sigcomp>, <sip:scscf2.home2.net;lr> P-Asserted-Identity: Privacy: From: To: Call-ID: Cseq: Referred-By: Contact: Allow: Allow-Events: P-Called-Party-ID: Content-Type: Content-Length: (...)  v= o= s= c= t= m= a= a= a=
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 11. 100 (Trying) response (UE#2 to P-CSCF) - see example in table A.5.2-11 + +UE#2 responds to the INVITE request (10) with a 100 (Trying) provisional response. + +**Table A.5.2-11: 100 (Trying) response (UE#2 to P-CSCF)** + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 SIP/2.0 100 Trying Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1 SIP/2.0/UDP     scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP     icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP     mrfc1.home1.net;branch=z9hG4bK23273846 From: To: Call-ID: CSeq: Content-Length: 0
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 12. Resource reservation + +After determining the media streams, UE#2 initiates the reservation procedures for the resources needed for this session. + +#### 13. 200 (OK) response (UE#2 to P-CSCF) - see example in table A.5.2-13 (related to table A.5.2-10) + +After reserving an IP-CAN bearer for the message session media component the receipt of the MSRP 200 (OK) response to the MSRP VISIT request, the terminating UE#2 sends a 200 (OK) response for the INVITE request containing SDP that indicates that UE#2 has successfully visited AS#2, accepted the message session and listens on the MSRP TCP port returned in the path attribute in the answer for a TCP SETUP from the MRFC/AS. + +**Table A.5.2-13: 200 (OK) response (UE#2 to P-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: ;comp=sigcomp, +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: +To: ; tag=314159 +Call-ID: +CSeq: 127 INVITE +Supported: gruu +Contact: +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, SUBSCRIBE, NOTIFY +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933623 2987933623 IN IP6 5555::eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=message 2855 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim +a=path:msrp://[5555::eee:fff:aaa:bbb]:2855/s417121/tcp +a=max-size:65536 +a=msrp-cema +a=setup:passive + +``` + +**SDP** The SDP contains a set of offered content types supported by UE#2 and desired by the user at UE#2 for this session in the accept-types attribute and indicates the maximum size message that can be received by UE#2 in the max-size attribute. + +#### 14. 200 (OK) response (P-CSCF to S-CSCF) - see example in table A.5.2-14 + +The P-CSCF forwards the 200 (OK) response to the S-CSCF. + +**Table A.5.2-14: 200 (OK) response (P-CSCF to S-CSCF)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfcl.home1.net;branch=z9hG4bK23273846 +Record-Route: , +P-Asserted-Identity: "John Smith" +P-Access-Network-Info: +P-Charging-Vector: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **15. 200 (OK) response (S-CSCF to I-CSCF) - see example in table A.5.2-15** + +The S-CSCF sends a 200 (OK) response final response along the signalling path back to I-CSCF. + +**Table A.5.2-15: 200 (OK) response (S-CSCF to I-CSCF)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP icscf2.home2.net;branch=z9hG4bK241d17.2, SIP/2.0/UDP + mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: +P-Asserted-Identity: "John Smith" , +P-Charging-Vector: ### +P-Charging-Function-Addresses: ### +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **16. 200 (OK) response (I-CSCF to MRFC/AS) - see example in table A.5.2-16** + +The I-CSCF forwards the 200 (OK) response final response to the session originator. + +**Table A.5.2-16: 200 (OK) response (I-CSCF to MRFC/AS)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Record-Route: +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### 17. ACK request (MRFC/AS to S-CSCF) - see example in table A.5.2-17 + +The MRFC/AS responds to the 200 (OK) response (16) with an ACK request sent to the S-CSCF. + +**Table A.5.2-17: ACK request (MRFC/AS to S-CSCF)** + +``` +ACK sip:user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 +;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 +``` + +#### 18. ACK request (S-CSCF to P-CSCF) - see example in table A.5.2-18 + +The S-CSCF forwards the ACK request to the P-CSCF. + +**Table A.5.2-18: ACK request (S-CSCF to P-CSCF)** + +``` +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 69 +Route: +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### 19. ACK request (P-CSCF to UE#2) - see example in table A.5.2-19 + +The P-CSCF forwards the ACK request to the UE#2. + +**Table A.5.2-19: ACK request (P-CSCF to UE#2)** + +``` +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK240f34.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +mrfc1.home1.net;branch=z9hG4bK23273846 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Length: +``` + +#### 20. H.248 interaction to create conference connection resources for UE#2 + +MRFC initiates a H.248 interaction to create an connection point for UE#2 in MRFP. + +#### 21. TCP setup + +MRFP establishes a TCP connection using the IP-CAN bearers established in step 12 to the host address and port as specified in the MSRP URL received in the SDP Answer UE#2. + +#### 22. MSRP SEND request (MRFP to UE#2) – see example in table A.5.2-22 + +The MRFP sends the first message over the MSRP session with an MSRP SEND request using the established TCP connection. + +**Table A.5.2-22: MSRP SEND request (MRFP to UE#2)** + +``` +MSRP y56hkseg SEND +To-path:msrp://[5555::eee:fff:aaa:bbb]:2855/s417121/tcp +From-path:msrp://[5555::abc:def:abc:def]:2855/s111271/tcp +Message-ID: 10568 +Byte-Range: 1-89/89 +Content-Type: "text/plain" +I will never be a member of a club that accepts people like me as members - Groucho Marx. +-----y56hkseg$ +``` + +- To-path:** The sender's remote path +- From-path:** The sender's local URL +- Message-ID:** A unique message ID for MSRP message. +- Byte-Range:** The Byte Range for this message. +- Content-Type:** The format of the body of the request. + +#### **23. MSRP 200 (OK) response (UE#2 to MRFP) – see example in table A.5.2-23** + +The terminating UE acknowledges the reception of the MSRP SEND request with an MSRP 200 (OK) response using the established TCP connection. + +**Table A.5.2-23: MSRP 200 (OK) response (UE#2 to MRFP)** + +``` +MSRP y56hkseg 200 OK +To-path:msrp://[5555::eee:fff:aaa:bbb]:2855/s417121/tcp +From-path:msrp://[5555::abc:def:abc:def]:2855/s111271/tcp +-----y56hkseg$ +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|----------|----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2003-06 | | | | | Version 0.0.1: Initial version for discussion | | 0.0.1 | +| 2003-06 | CN#31 | | | | Version 0.0.2: Title and text changed in order to reflect that Messaging is a service. | N1-031123 | N1-031281 | +| 2003-09 | | | | | Version 0.1.0: Title changed | 0.0.2 | 0.1.0 | +| 2003-12 | | | | | Version 0.2.0: Incorporated the following CRs as approved at CN#32 meeting:
N1-031676: Message Sessions in IMS – Call Flow
N1-031677: Immediate Messaging – Call Flow reference to 24.228
N1-031722: Message Sessions in IMS – Text (created Annex B)
N1-031723: Immediate Messaging – Text

Additionally the editor took the freedom to change the heading formats in subclause B.5. Also the title of subclause B.5 was replaced with the title of clause 5 in the main part of the text and subclauses B.5.1 and B.5.2 were added (both ). | 0.1.0 | 0.2.0 | +| 2003-12 | | | | | Version 0.2.1: Including minor issues that were left out by mistake when creating version 0.2.0 | 0.2.0 | 0.2.1 | +| 2004-01 | | | | | Version 0.3.0: Incorporated the following CRs as approved at CN#32bis meeting:
N1-040151 – Message Session in IMS
N1-040189 – Deletion of imported and unused Definitions
N1-040197 – UE to UE message session flow
N1-040198 – Message Session Initiation – mobile originating case
N1-040199 – Message Session Initiation – mobile terminating case
N1-040200 – Use of MESSAGE versus MSRP | 0.2.1 | 0.3.0 | +| 2004-01 | | | | | Version 0.3.1: Including N1-040200, that was left out (although listed) by mistake when creating version 0.3.0 | 0.3.0 | 0.3.1 | +| 2004-02 | | | | | Version 0.4.0: Incorporated the following CRs as approved at CN1#33 meeting:
- N1-040261 – Update of Scope
- N1-040262 – Correction of Flows
- N1-040280 – Editorial Changes
- N1-040306 – Corrections to Annex A.4.3
- N1-040307 – Corrections to Annex B
- N1-040426 – SDP for session-based messaging
- N1-040429 – Corrections to Annex A.1 – A.4.2
- N1-040486 – Definition of MSRP Role for AS and MRFP
- N1-040488 – Session-based Messaging with Intermediate Node Flow A.4.3 | 0.3.1 | 0.4.0 | +| 2004-02 | | | | | Version 0.4.1: Added subclause 9.2.2, which was missing from last update. Minor editorials | 0.4.0 | 0.4.1 | +| 2004-04 | | | | | Version 0.5.0: Incorporated the following CRs as approved as CN1#33bis meeting:
- N1-040561 – MSRP in AS
- N1-040648 – Editorial changes to Annex A
- N1-040738 – MSRP terminating UE hosting flow as well as minor editorial changes | 0.4.1 | 0.5.0 | +| 2004-05 | | | | | Version 1.0.0: Incorporated the following CRs as approved during CN1#34 meeting:
- N1-041038 – Shifting Material from Annex B to main body
- N1-041036 – Corrections to Message Sessions Flows
- N1-041040 – Ut for Messaging
- N1-040850 – Correction of signalling flow example
- N1-041037 – Establishing a session with active intermediate nodes, with originating UE hosting, and without SBLP
- N1-041039 – Addition of Note to 5.3.1.1
- several smaller editorial changes

Note: the material was first shifted from Annex B to the main body (approved CR in N1-041038), all CRs that were written against material in Annex B were afterwards applied against the material in the main body. | 0.5.0 | 1.0.0 | +| 2004-05 | | | | | Version 1.0.1 produced to correct smaller editorial mistakes. | 1.0.0 | 1.0.1 | +| 2004-06 | | | | | Version 1.1.0 produced as outcome of CN#34bis meeting in Helsinki, Finland. Todc N1-041172 (Changes in MSRP) and smaller editorial changes incorporated. | 1.0.1 | 1.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| 2004-08 | | | | | Version 1.2.0 produced as outcome CN#35 meeting in Sophia Antipolis, France. Tdoc N1-041585 (AS section) and smaller editorial changes incorporated. | 1.1.0 | 1.2.0 | +| 2004-11 | | | | | Version 6.0.0 produces as outcome of CN#36 meeting in Seoul, South Korea. The following documents were incorporated:
N1-041714 – deletion of intro clause
N1-041716 – Terminology alignment
N1-041989 – Data Manipulation for IMS Messaging in Rel-6
N1-041995 – Session establishment for session-mode messaging
N1-041996 – Session-based messaging conferences
N1-041997 – subclause 8 rework
N1-041998 – general subclause in participant section
N1-041999 – subclause 9 rework
N1-042001 – Participant in immediate messaging
N1-042114 – subclause 10 rework
N1-042115 – subclause 6 rework | 1.2.0 | 2.0.0 | +| 2004-12 | CN-26 | NP-040611 | | | Version 2.0.0 is approved and the TS is brought under the change control. As an erroneous v6.0.0 is presented in CN-26, the first officially published version is 6.0.1. | 2.0.0 | 6.0.1 | +| 2005-03 | CN-27 | NP-050073 | 011 | 1 | Corrections to Message Session Flows to align with draft-ietf-simple-message-sessions-09 | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050073 | 008 | 1 | Alignment between TS 23.228/ TS 22.340 and TS 24.247 for immediate messaging | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050073 | 001 | 1 | Resolution of references to 24.228 | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050073 | 003 | | MESSAGE to unregistered user | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050073 | 010 | 2 | Removing CPCP from 24.247 | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050075 | 009 | 2 | Clarifications to TS 24.247 subclause 9.3 | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050075 | 002 | 3 | MESSAGE to multiple recipients | 6.0.1 | 6.1.0 | +| 2005-03 | CN-27 | NP-050075 | 007 | 2 | Alignment between TS 22.340 and on TS 24.247 for "is composing" | 6.0.1 | 6.1.0 | +| 2005-06 | CP-28 | CP-050060 | 13 | 1 | List server - sending requests | 6.1.0 | 6.2.0 | +| 2005-06 | CP-28 | CP-050060 | 15 | 1 | Adding of reference TS 26.241 to TS 24.247 | 6.1.0 | 6.2.0 | +| 2005-06 | CP-28 | CP-050060 | 16 | 1 | Corrections to Message Session Flows to Align with draft-IETF-simple-message-sessions-10 | 6.1.0 | 6.2.0 | +| 2005-09 | CP-29 | CP-050359 | 17 | | Corrections to TS 24.247 to align with draft-ietf-simple-message-sessions-11 | 6.2.0 | 6.3.0 | +| 2005-12 | CP-30 | CP-050544 | 18 | 1 | Call flow corrections | 6.3.0 | 6.4.0 | +| 2005-12 | CP-30 | CP-050544 | 19 | | Corrections to TS 24.247 to align with Draft-ietf-simple-message-sessions12 | 6.3.0 | 6.4.0 | +| 2006-03 | CP-31 | CP-060110 | 20 | | Corrections to references in TS 24.247 to align with draft-ietf-simple-message-sessions-13 and draft-ietf-sipping-uri-list-message-06 | 6.4.0 | 6.5.0 | +| 2006-09 | CP-33 | CP-060504 | 22 | | Removal of Editor's notes in 24.247 | 6.5.0 | 6.6.0 | +| 2006-11 | CP-34 | CP-060655 | 23 | 1 | Correction of the i-d name for Multiple-Recipient MESSAGE Requests in the Session Initiation Protocol (SIP | 6.6.0 | 6.7.0 | +| 2006-11 | CP-34 | CP-060661 | 24 | 2 | Addition of MSRP file transfer | 6.7.0 | 7.0.0 | +| 2007-03 | CP-35 | CP-070130 | 26 | | IETF reference corrections | 7.0.0 | 7.1.0 | +| 2007-06 | CP-36 | CP-070430 | 27 | | File transfer | 7.1.0 | 7.2.0 | +| 2007-12 | CP-38 | CP-070788 | 32 | | IETF reference updates | 7.2.0 | 7.3.0 | +| 2007-12 | CP-38 | CP-070810 | 29 | | Incorporation of roles relating draft-ietf-consent-framework | 7.3.0 | 8.0.0 | +| 2008-03 | CP-39 | CP-080140 | 0033 | 1 | Messaging references | 8.0.0 | 8.1.0 | +| 2008-12 | CP-42 | CP-080854 | 0035 | | Addition of media control for session-based messaging | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | CP-080841 | 0038 | | Reference updates (release 6 ietf dependencies) | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | CP-080846 | 0042 | 1 | Corrections of reference and flows in 24.247 | 8.1.0 | 8.2.0 | +| 2008-12 | CP-42 | | | | Editorial cleanup by MCC | 8.1.0 | 8.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---------------------------------------------------------------------------------|--------|--------| +| 2009-06 | CP-44 | CP-090424 | 0044 | 1 | Alternative connection model for MSRP | 8.2.0 | 8.3.0 | +| 2009-12 | CP-46 | | | | Upgrade to Rel-9 | 8.3.0 | 9.0.0 | +| 2010-06 | CP-48 | CP-100351 | 0046 | 1 | MSRP alignment | 9.0.0 | 9.1.0 | +| 2010-12 | CP-50 | CP-100726 | 0050 | 1 | Inclusion of file transfer attributes | 9.1.0 | 9.2.0 | +| 2010-12 | CP-50 | CP-100874 | 0052 | 2 | Reference update: draft-ietf-simple-msrp-sessmatch & draft-ietf-simple-msrp-acm | 9.1.0 | 9.2.0 | +| 2011-03 | CP-51 | CP-110172 | 0054 | | Reference update: draft-ietf-simple-msrp-sessmatch & draft-ietf-simple-msrp-acm | 9.2.0 | 9.3.0 | +| 2011-03 | CP-51 | | | | Upgrade to Rel-10 | 9.3.0 | 10.0.0 | +| 2011-06 | CP-52 | CP-110454 | 0057 | | Reference update: RFC 6135 | 10.0.0 | 10.1.0 | +| 2011-09 | CP-53 | CP-110662 | 0060 | 1 | Reference update: draft-ietf-simple-msrp-sessmatch | 10.1.0 | 10.2.0 | +| 2011-12 | CP-54 | CP-110864 | 0066 | 1 | Reference update: draft-ietf-simple-msrp-cema | 10.2.0 | 10.3.0 | +| 2011-12 | CP-54 | CP-110881 | 0063 | 1 | Correction of charging headers | 10.3.0 | 11.0.0 | +| 2012-06 | CP-57 | CP-120573 | 0070 | 1 | Reference update: draft-ietf-simple-msrp-cema | 11.0.0 | 11.1.0 | +| 2012-12 | CP-58 | CP-120793 | 0071 | 1 | Corrections to references and editorial errors | 11.1.0 | 11.2.0 | +| 2012-12 | CP-58 | CP-120781 | 0075 | | Reference update: RFC 6714 | 11.1.0 | 11.2.0 | +| 2012-12 | CP-58 | CP-120781 | 0079 | 1 | Procedure update: RFC 6714 | 11.1.0 | 11.2.0 | +| 2013-12 | CP-62 | CP-130763 | 0080 | 1 | MSRP-CEMA and privacy | 11.2.0 | 12.0.0 | +| 2015-12 | CP-70 | | | | Upgrade to Rel-13 | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA-80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24279/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/24_series/24279/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..51db3437b555819bb07628e45fee2bf22907ce39 --- /dev/null +++ b/marked/Rel-16/24_series/24279/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a68dfdf34aff3276be88ab712eab17ecfdceb1c6d2966920d8ec9a12db840333 +size 17914 diff --git a/marked/Rel-16/24_series/24279/30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg b/marked/Rel-16/24_series/24279/30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..03aa3ceb22947d3ca709b3bbad810465ee97726b --- /dev/null +++ b/marked/Rel-16/24_series/24279/30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:68d54f7441933b96663f6e570856e7083a2737f0782ffdc6690427a68becd184 +size 81102 diff --git a/marked/Rel-16/24_series/24279/3337af75dfee8af7687b4f49914d6c93_img.jpg b/marked/Rel-16/24_series/24279/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..89bedfd460eab3cf4c1542be96070f6a4a48665d --- /dev/null +++ b/marked/Rel-16/24_series/24279/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2f6da32cd8413b1ba23f51bb9c1e1eed12504902ae37e67f3379436af66b350 +size 131401 diff --git a/marked/Rel-16/24_series/24279/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg b/marked/Rel-16/24_series/24279/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6132557960274c3e83974e15d9b8f78b477b5585 --- /dev/null +++ b/marked/Rel-16/24_series/24279/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42c27e09cb9121aa15b3853b4cea4b145c62ed94da4817fba77be448f641f6e4 +size 127084 diff --git a/marked/Rel-16/24_series/24279/61a7f401eb46fe99a71f27bc37493f04_img.jpg b/marked/Rel-16/24_series/24279/61a7f401eb46fe99a71f27bc37493f04_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6672930e366362873374c12f53ff49c8fcc30cf5 --- /dev/null +++ b/marked/Rel-16/24_series/24279/61a7f401eb46fe99a71f27bc37493f04_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:46ed8a3f2d556ac1658621dc7487ba57bcdbcf69ed1843148d5b74b31bc1c706 +size 155609 diff --git a/marked/Rel-16/24_series/24279/65e8c0628536d6d4245e9ab46ba070c3_img.jpg b/marked/Rel-16/24_series/24279/65e8c0628536d6d4245e9ab46ba070c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..247a1612a787ab2b06919308ef9fc5880955eacb --- /dev/null +++ b/marked/Rel-16/24_series/24279/65e8c0628536d6d4245e9ab46ba070c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e32b1818ad323025a2397ee651aa0db132b1547786550278890ef92ab7861fb +size 116631 diff --git a/marked/Rel-16/24_series/24279/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/marked/Rel-16/24_series/24279/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e662704a79f96cc31f48c6e12a4d59704bf57321 --- /dev/null +++ b/marked/Rel-16/24_series/24279/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:36e9a53dfc5219758ca6f07800e64888f5f99915b2ad4c17218dce8f66cd5eb7 +size 82011 diff --git a/marked/Rel-16/24_series/24279/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/24_series/24279/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..92a95d7e209391d30aa4a1afc925ee1eea1abad5 --- /dev/null +++ b/marked/Rel-16/24_series/24279/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d254189994eff2a4a34583ab52dc0d41098ce8c2e816258872b34f22aed12a92 +size 165892 diff --git a/marked/Rel-16/24_series/24279/fcc757566216206ceddbd6c775e8db02_img.jpg b/marked/Rel-16/24_series/24279/fcc757566216206ceddbd6c775e8db02_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a830765c98b694b7da862230b5c9e8788be1e81 --- /dev/null +++ b/marked/Rel-16/24_series/24279/fcc757566216206ceddbd6c775e8db02_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43d541945b149ffdbe4970bc9c3c10e4f97ee9b663aae771d826570e1840c6e1 +size 159470 diff --git a/marked/Rel-16/24_series/24279/raw.md b/marked/Rel-16/24_series/24279/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..70ebb4f780a91b330eabc0f224dc78211df7d975 --- /dev/null +++ b/marked/Rel-16/24_series/24279/raw.md @@ -0,0 +1,3530 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Common capability information and identifiers for CS-first and IMS-first scenarios ..... | 8 | +| 4.1 UE capability exchange - overview ..... | 8 | +| 4.2 Personal ME identifier ..... | 9 | +| 4.3 UE capability version..... | 9 | +| 4.4 Radio environment information ..... | 9 | +| 4.5 IM Status ..... | 9 | +| 5 Common procedures for CS-first and IMS-first scenarios ..... | 10 | +| 5.1 Registration of UE capabilities ..... | 10 | +| 5.2 Criteria for initiating capability exchange..... | 10 | +| 5.3 Criteria for responding to a capability exchange request..... | 10 | +| 5.4 Exchange of radio environment information and IM Status ..... | 11 | +| 5.5 Storage of capabilities in the UE..... | 11 | +| 6 Combining a CS call with an existing IM session ..... | 11 | +| 6.1 Introduction ..... | 11 | +| 6.2 Functional entities ..... | 11 | +| 6.2.1 User equipment..... | 11 | +| 6.2.2 Application server (AS)..... | 11 | +| 6.3 Roles..... | 11 | +| 6.3.1 CSI user agent (CUA) ..... | 11 | +| 6.3.1.1 General..... | 11 | +| 6.3.1.2 Exchange of UE capability information – IM session first scenario ..... | 11 | +| 6.3.1.3 Session set-up – originating case..... | 12 | +| 6.3.1.4 Session set-up – terminating case ..... | 13 | +| 6.3.1.5 CS call set-up – originating case..... | 13 | +| 6.3.1.6 CS call set-up – terminating case..... | 13 | +| 6.3.1.7 SDP exchange – UE capability information exchange..... | 14 | +| 6.3.1.8 SDP offer answer – originating case..... | 14 | +| 6.3.1.9 SDP offer answer – terminating case..... | 14 | +| 7 Combining an IM session with an existing CS call ..... | 14 | +| 7.1 Introduction ..... | 14 | +| 7.2 Functional entities ..... | 14 | +| 7.2.1 User equipment..... | 14 | +| 7.2.2 Application server (AS)..... | 14 | +| 7.3 Roles..... | 15 | +| 7.3.1 CSI user agent (CUA) ..... | 15 | +| 7.3.1.1 General..... | 15 | +| 7.3.1.2 Exchange of UE capability information – CS first scenario..... | 15 | +| 7.3.1.3 Session set-up – originating case..... | 15 | +| 7.3.1.4 Session set-up – terminating case ..... | 16 | +| 7.3.1.5 CS call set-up – originating case..... | 16 | +| 7.3.1.6 CS call set-up – terminating case..... | 17 | +| 7.3.1.7 SDP exchange – UE capability information exchange..... | 17 | +| 7.3.1.8 SDP offer-answer – originating case ..... | 17 | +| 7.3.1.9 SDP offer-answer – terminating case ..... | 17 | +| 8 Interaction with supplementary services..... | 18 | +| 8.1 Roles..... | 18 | +| 8.1.1 CSI user agent (CUA) ..... | 18 | +| 8.1.2 CSI application server (CSI AS) ..... | 18 | + +| | | | +|-------------------------------|---------------------------------------------------------------------------------------------|-----------| +| 8.1.2.1 | Introduction..... | 18 | +| 8.1.2.2 | Call Forwarding and Call Barring ..... | 18 | +| 8.2.1.3 | Call Completion..... | 18 | +| 9 | IMS origination and CSI termination..... | 18 | +| 9.1 | Introduction ..... | 18 | +| 9.2 | Functional entities ..... | 18 | +| 9.2.1 | User equipment..... | 18 | +| 9.2.2 | Application server (AS)..... | 19 | +| 9.2.3 | MGCF ..... | 19 | +| 9.3 | Roles..... | 19 | +| 9.3.1 | Void ..... | 19 | +| 9.3.2 | CSI UA (CUA) ..... | 19 | +| 9.3.3 | CSI AS..... | 19 | +| 9.3.3.1 | General..... | 19 | +| 9.3.3.2 | Retrieval of public user identity information..... | 19 | +| 9.3.3.3 | Session Splitting towards terminating CUA..... | 20 | +| 9.3.3.3.1 | General ..... | 20 | +| 9.3.3.3.2 | Call Initiation towards the CS domain ..... | 20 | +| 9.3.3.3.3 | Session Initiation towards the IM CN subsystem ..... | 20 | +| 9.3.3.3.4 | Subsequent requests ..... | 21 | +| 9.3.3.4 | Session Modification ..... | 21 | +| 9.3.3.4.1 | Adding an IM Session to an existing CS call..... | 21 | +| 9.3.3.4.2 | Adding a CS call to an existing IMS Session..... | 22 | +| 9.3.3.4.3 | Modifying an existing CS call and an existing IMS Session ..... | 22 | +| 9.3.3.5 | Session Combining ..... | 23 | +| 9.3.3.6 | Session Release..... | 25 | +| 9.3.3.7 | Unregistered Service..... | 25 | +| 9.3.3.8 | Capability exchange with the CSI UE ..... | 25 | +| Annex A (normative): | Media feature tags defined within the current document ..... | 26 | +| A.1 | General..... | 26 | +| A.2 | Definition of media feature tag g.3gpp.cs-voice..... | 26 | +| A.3 | Definition of media feature tag g.3gpp.cs-video..... | 26 | +| Annex B (informative): | Example signalling flows for the combining of CS calls with IM sessions..... | 27 | +| B.1 | Scope of signalling flows..... | 27 | +| B.2 | Introduction..... | 27 | +| B.2.1 | General ..... | 27 | +| B.2.2 | Key required to interpret signalling flows..... | 27 | +| B.3 | Signalling flows demonstrating CSI session setup when no CS call has yet been set up..... | 28 | +| B.3.1 | Introduction ..... | 28 | +| B.3.2 | Establishing a CSI session when no CS call has yet been set up ..... | 28 | +| B.4 | Signalling flows demonstrating CSI session setup when a CS call is already established..... | 37 | +| B.4.1 | Introduction ..... | 37 | +| B.4.2 | Establishing a CSI session when CS call has been setup..... | 37 | +| B.5 | Signalling flows demonstrating capability information exchange in a CS call (only) ..... | 47 | +| B.5.1 | Introduction ..... | 47 | +| B.5.2 | Establishing a CS call from a CSI capable UE ..... | 47 | +| B.6 | Signalling flows demonstrating UE capability exchange with no UE capability version ..... | 50 | +| B.6.1 | Introduction ..... | 50 | +| B.6.2 | UE capability exchange outside a CS call..... | 50 | +| B.6.3 | UE capability exchange when a CS call is already in progress ..... | 58 | +| B.7 | Signalling flows demonstrating UE capability exchange with UE capability version ..... | 61 | +| B.7.1 | Introduction ..... | 61 | + +B.7.2 UE capability exchange with UE capability version.....61 + +B.8 Signalling flows demonstrating an IMS multimedia session setup with IMS origination and CSI termination. ....65 + +B.8.1 Introduction .....65 + +B.8.2 CSI interworking function establishing a combinational CS call and an IMS session to a terminating UE .....65 + +Annex C (informative): Change history.....77 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the technical realisation for the combination of Circuit Switched calls and IM sessions when using them simultaneously between the same two users. + +The present document describes the use of CS and IM services in combination, using the existing procedures that have been defined for CS and IMS. It includes the necessary function as adding an IM session to an ongoing CS call, adding a CS call to an ongoing IM session, supplementary services as they relate to CSICS and supporting capability exchange. + +The present document is applicable to UE and Application Servers providing for the combination of Circuit Switched calls and IM sessions. + +# --- 2 References + +The following documents contain provisions that, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "3G Vocabulary". +- [2] 3GPP TS 22.279: "Combined CS Calls and IMS Sessions". +- [3] 3GPP TS 23.279: "Combining CS and IMS services". +- [4] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [5] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] RFC 3840: "Indicating User Agent Capabilities in the Session Initiation Protocol". +- [7] 3GPP TS 22.081: "Line Identification; Service description - Stage 1". +- [8] 3GPP TS 22.087: "User-to-User Signalling (UUS); Service description - Stage 1". +- [9] 3GPP TS 24.087: "User-to-User Signalling (UUS) Supplementary Service - Stage 3". +- [10] 3GPP TS 24.247: "Messaging service using the IP Multimedia (IM) Core Network; Stage 3". +- [11] 3GPP TS 24.228 Release 5: "Signalling flows for the IP multimedia call control based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [12] 3GPP TS 33.203: "3G security; Access security for IP-based services". +- [13] 3GPP TS 26.141 "IP Multimedia System (IMS) Messaging and Presence; Media formats and codecs". +- [14] RFC 3264: "An Offer/Answer Model with Session Description Protocol (SDP)". +- [15] 3GPP TS 29.162: "Interworking between the IM CN subsystem and IP networks". +- [16] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface". +- [17] RFC 3261: "SIP: Session Initiation Protocol". +- [18] RFC 7433: "A Mechanism for Transporting User-to-User Call Control Information in SIP". + +[19] + +RFC 7434: "Interworking ISDN Call Control User Information with SIP". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions are given in 3GPP TS 22.279 [2]. + +**Combinational Service** +**Combinational call** +**Combinational Session** +**CSICS capable UE** + +For the purposes of the present document, the following terms and definitions are given in 3GPP TS 23.279 [3]. + +**CSI session** +**Multimedia IMS session** +**CSI origination** +**CSI termination** +**IMS origination** +**IMS termination** + +For the purposes of the present document, the following terms and definitions given in 3GPP TR 21.905 [1] apply: + +**Universal Subscriber Identity Module (USIM)** +**User Equipment (UE)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 33.203 [12] apply: + +**IM Subscriber Identity Module (ISIM)** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations defined in 3GPP TR 21.905 [1] and the following abbreviations apply: + +CSICS                      Circuit Switched IMS Combinational Service + +# --- 4 Common capability information and identifiers for CS-first and IMS-first scenarios + +## 4.1 UE capability exchange - overview + +The terminal capabilities that can be exchanged are: + +- a) Media types which can be supported as IMS media streams (i.e. media component definitions of IM sessions); +- b) Media format parameters for supported IMS media types (codecs, media file formats etc.); +- c) MSISDN and preferred SIP URI or tel URI for the UE sending the UE capability information; +- d) Whether the terminal is capable combining an IM session with either CS-Video telephony, CS-Voice, or both; +- e) MMS version that is supported; +- f) Support for other IMS based capabilities and/or services e.g. PoC; and +- g) Personal ME Identifier to identify which of the user's MEs the UE capability information is related to. +- h) UE capability version, which may be used to identify the current capabilities of a terminal to indicate capability update. +- i) The IM Status, which indicates the IMS capability and registration status of the sending UE. + +3GPP TS 26.141 [13] specifies the 3GPP recommended media formats and codecs which can be reflected in the SDP used by the CUA. + +## 4.2 Personal ME identifier + +A specific ME of the user shall be identified by a personal ME identifier, which has the syntax PMI-XXXX. The part "XXXX" shall be a random value, as defined in 3GPP TS 24.008 [4] subclause 2.1.1, in the range from hexadecimal 0000 to hexadecimal FFFF generated by the CUA. The personal ME identifier shall be stored by the UE and can be changed to ensure that two or more of the user's MEs do not have the same personal ME identifier. + +At CS call setup, the MSISDN distinguishes a user and the personal ME identifier distinguishes one ME among those belonging to that user. In the IMS, a public user identity distinguishes a user and the personal ME identifier distinguishes one ME among those belonging to that user. + +The personal ME identifier may be exchanged during: + +- UE capability information exchange; +- IM session set up; and +- CS call set up. + +## 4.3 UE capability version + +The UE capability version is used to identify the current UE's version of capabilities and has the syntax UCV-XX. The part "XX" shall be a value in the range from hexadecimal 00 to hexadecimal FF generated by the CUA, and based on the set of capabilities. The UE capability version shall be changed to another value whenever the CUA changes its capabilities. + +The UE capability version may be exchanged during: + +- UE capability information exchange; +- IM session set up, and +- CS call set up. + +## 4.4 Radio environment information + +The radio environment information is used to indicate whether the terminal is in a radio environment at CS call setup that supports simultaneous use of CS and PS services. + +The radio environment information may be exchanged during CS call setup only. + +## 4.5 IM Status + +The IM Status is exchanged at CS call setup only. The IM Status is only valid for the duration of the CS call. + +The IM Status is an indication of the IMS capability and registration status of the UE that provides this indication. The IM Status, if provided, shall indicate the UE as either:- + +- not capable of IM subsystem registration +- IM subsystem registered +- IM subsystem capable and willing to register to IM subsystem +- IM subsystem capable but will not register to IM subsystem + +The IM Status of the UE that provides the IM Status can be used by the receiving CUA in its decision to perform an IMS registration if allowed by user's preference (and if the receiving UE is not already IMS registered). + +The provision of the IM Status is optional. + +# --- 5 Common procedures for CS-first and IMS-first scenarios + +## 5.1 Registration of UE capabilities + +The CUA may include a media feature tag in the Contact header of a REGISTER request, in accordance with RFC 3840 [6]. The media feature-tags applicable for CSI are g.3gpp.cs-voice, g.3gpp.cs-video, or both values. These media feature tags are further described in annex A. + +## 5.2 Criteria for initiating capability exchange + +An OPTIONS request should be sent from the UE to the remote UE in the following cases: + +- a) when the UE is in a CS call with the remote UE; and + - the received radio environment information indicates that the remote UE and remote radio environment is capable of handling PS and CS domain simultaneously; + - the received MSISDN plus personal ME identifier plus UE capability version does not match any combination in use by the UE to cache capabilities; and + - the received IMS status is "MS is IM subsystem registered" or "MS is IM subsystem capable and willing to register to IM subsystem". +- b) when the UE is in an IM session with the remote UE and the received INVITE request includes UE capability version plus public user identity plus personal ME identifier that does not match any combination in use by the UE to cache capabilities. + +NOTE 1: For a CSI call where the CS call is established first, the OPTIONS request can only be sent when the PS domain is available. The PS domain can either be available already when the CS call is set-up or at a later instant due to changed radio condition. + +- c) when the UE capabilities have been significantly upgraded; or + +NOTE 2: A significant upgrade of UE capabilities is when an UE has been upgraded with e.g. video capability or supports a new service. + +- d) when a UE receives an OPTIONS request from a remote UE and there is no ongoing (or recently finished) capability exchange initiated by the UE. + +NOTE 3: The OPTIONS request can be sent as a standalone transaction or as a part of a session. + +Information specific to capability exchange with a CS-call already established is covered in subclause 7.3.1.2. + +Information specific to capability exchange with an IM session already established is covered in subclause 6.3.1.2. + +## 5.3 Criteria for responding to a capability exchange request + +The end-user or application shall give its approval for the UE capabilities to be included in response to a capability exchange request. + +## 5.4 Exchange of radio environment information and IM Status + +A UE may send information about its current radio environment and its IM Status during CS Call set-up. If the UE finds that the remote UE's IM Status indicates the remote UE is either IM subsystem registered or IM subsystem capable and willing to register to IM subsystem and its current radio environment supports simultaneous CS and PS services, then if allowed by the user's preference the UE should attempt an IMS registration (if the UE is not already IMS registered). + +The information exchanged during the call establishment is valid for the duration of the CS call. + +## 5.5 Storage of capabilities in the UE + +The terminal capabilities of other UEs are stored by the requesting UE. This stored information shall be valid until ISIM/USIM is removed or until an update of the terminal capabilities occurs according to subclause 5.2. Stored information shall not be deleted when the UE is switched off. + +# --- 6 Combining a CS call with an existing IM session + +## 6.1 Introduction + +(void) + +## 6.2 Functional entities + +### 6.2.1 User equipment + +A UE shall implement the role of a CUA as specified in subclause 6.3.1. + +### 6.2.2 Application server (AS) + +An application server may be included for a CSI call. However, no specific CSI role is assigned to it. + +## 6.3 Roles + +### 6.3.1 CSI user agent (CUA) + +#### 6.3.1.1 General + +In addition to the procedures specified in subclause 6.3.1, the CUA shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the CUA is implemented. + +#### 6.3.1.2 Exchange of UE capability information – IM session first scenario + +When a CUA wants to exchange capabilities with the remote party, the CUA originating the OPTIONS request shall apply the procedure as specified in 3GPP TS 24.229 [5] with the following additions: + +- a) The CUA shall in the Request URI: + - include the URI received in the P-Asserted-Identity header from the remote CUA; or if that is not available: + - include a tel URI corresponding to the MSISDN intended for the CS call set up; or + - include a SIP URI associated with the remote user available in the CUA. + +NOTE 1: The MSISDN can only be included as a tel URI if it is in international format. + +NOTE 2: If no SIP URI or tel URI in accordance with above is available the CUA cannot initiate the OPTIONS request. + +NOTE 3: The OPTIONS request can also be sent as a part of a session. The request URI needs to be set in accordance with TS 24.229 [5] in this case. + +- b) The CUA shall in the P-Preferred-Identity header either include: + - preferably the MSISDN of an assumed registered tel URI of the CUA; or + - an assumed registered SIP URI associated with the CUA. +- c) The CUA shall in the Accept-Contact header include media feature tag(s) with the value(s) "+g.3gpp.cs-voice" or "+g.3gpp.cs-video" or both, marked as explicit. + +- d) The CUA may in the User-Agent header include the personal ME identifier and the UE capability version. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +The CUA answering with a 200 (OK) response to the OPTIONS request shall apply the procedure as specified in 3GPP TS 24.229 [5] with the following additions: + +- a) The CUA shall in the Contact header include media feature tag(s) with the value(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both. The CUA shall include in the Contact header the SIP-URI and, if available the tel URI that can be used to establish a CSI call. + +NOTE 4: The indicated tel URI corresponds to the MSISDN intended for the CS call setup. + +- b) The CUA may in the Server header include the personal ME identifier and UE capability version. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +Upon the receipt of the 200 (OK) response the CUA acts in accordance with 3GPP TS 24.229 [5]. In addition, the CUA may locally update the UE capability information, the URIs associated with the remote CUA and the personal ME identifier of the remote CUA. + +#### 6.3.1.3 Session set-up – originating case + +When the originating CUA wants to establish an IM session in combination with a CS call, the CUA shall apply the session initiation procedure specified in 3GPP TS 24.229 [5] with the following additions: + +- a) The CUA shall in the Request-URI in the initial request either include: + +- 1) a tel URI that is the MSISDN intended for CS call set up; or +- 2) a SIP-URI associated with the remote user available in the CUA. + +NOTE: The MSISDN can only be included as a tel URI if it is in the international format. + +- b) The CUA shall in the P-Preferred-Identity header in the initial request include an assumed registered tel URI corresponding to the MSISDN of the CUA. +- c) The CUA shall in the Accept-Contact header in the initial request include media feature tag(s) with the values "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both, marked as explicit. +- d) The Contact header shall include media feature tag(s) with the value(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both. +- e) The CUA may in the User-Agent header include the personal ME identifier and UE capability version. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +If the response includes a personal ME identifier and a UE capability version and the combination of public user identity plus personal ME identifier plus UE capability version of the terminating UE is known to the CUA, the CUA may indicate capability information of the terminating UE to the user via the MMI. + +#### 6.3.1.4 Session set-up – terminating case + +When the terminating CUA receives an initial request, the terminating CUA shall apply the procedures as specified in 3GPP TS 24.229 [5]. The Contact header shall include media feature tag(s) with the value(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both in the response(s), in accordance with RFC 3840 [6]. The UE may include the personal ME identifier and UE capability version in the Server header in the responses. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +If the request includes a personal ME identifier and a UE capability version and the combination of public user identity plus personal ME identifier of the originating UE is known to the CUA, the CUA may indicate capability information of the originating UE to the user via the MMI. + +#### 6.3.1.5 CS call set-up – originating case + +When the originating CUA wants to add the CS part of a CSICS call, it shall set up the call in accordance with 3GPP TS 24.008 [4] with the following additions: + +- a) The CUA may include the radio environment information and the IM Status, the personal ME identifier and UE capability version in the user-user information (as defined in 3GPP TS 24.008 [4] Annex O) in the SETUP Message. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. The handling of the user-user information element shall be in accordance with 3GPP TS 24.087 [9]. + +NOTE 1: If the CUA does not support the user-to-user 1 supplementary service, in accordance with 3GPP TS 22.087 [8] the radio environment information, the IM Status, the personal ME identity, and the UE capability version: + +- will not be sent to the remote CUA, +- will be ignored if provided by the remote CUA. + +- b) The CUA shall include in the called party BCD number either: + +- an E.164 number as included in the P-Asserted-Identity header that was received during IM session establishment; or +- if this is not possible, the MSISDN of the remote user stored in UE. + +NOTE 2: It is assumed that the originating CUA uses the COLP supplementary service, in accordance with 3GPP TS 22.081 [7] and UUS service 1, in accordance with 3GPP TS 22.087 [8]. The CLIR supplementary service in accordance with 3GPP TS 22.081 [7] is not in use in the originating CUA. + +If the connected number received in the CONNECT message differs from the MSISDN number used in the SETUP message, the actions to be taken by the CUA are implementation dependent. + +#### 6.3.1.6 CS call set-up – terminating case + +When the terminating CUA receives a CS call, the CUA shall check if there any ongoing IM sessions, which were initiated with a request that included an Accept-Contact header with media feature tag(s) with the value(s)"g.3gpp.cs-voice", "+g.3gpp.cs-video" or both. + +- If there are ongoing IM sessions, which were initiated with a request that included an Accept-Contact header with media feature tag(s) with the values(s)"g.3gpp.cs-voice", "+g.3gpp.cs-video" or both and if the received Calling Party BCD number corresponds to an entry in the P-Asserted-Identity header in an ongoing IM session, the CUA shall set up the call in accordance with 3GPP TS 24.008 [4]. The CUA may include the user-user information element with the radio environment information, the IM Status, personal ME identifier (as defined in 3GPP TS 24.008 [4] Annex O) and UE capability version in the CONNECT message, in accordance with 3GPP TS 24.087 [9]. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. +- Otherwise, the CUA shall set up the call in accordance with subclause 7.3.1.6. + +NOTE 1: If the CUA does not support the user-to-user 1 supplementary service, in accordance with 3GPP TS 22.087 [8] the radio environment information, the IM Status, the personal ME identifier and the UE capability version: + +- will not be sent to the remote CUA, +- will be ignored if provided by the remote CUA. + +NOTE 2 It is assumed that the terminating CUA uses the CLIP supplementary service, in accordance with 3GPP TS 22.081 [7] and UUS service 1, in accordance with 3GPP TS 22.087 [8] The COLR supplementary service in accordance with 3GPP TS 22.081 [7] is not in use in the terminating CUA. + +NOTE 3: If the CUA does not support the user-to-user 1 supplementary service, in accordance with 3GPP TS 22.087 [8] the radio environment information, the IM Status, the personal ME identifier and UE capability version will not be sent to the remote CUA. + +#### 6.3.1.7 SDP exchange – UE capability information exchange + +The CUA shall act in accordance with 3GPP TS 24.229 [5] when the CUA exchanges its capabilities with the remote CUA. + +The following information may be included: + +- a) Media types which can be supported as IMS media streams (i.e. media component definitions of IM sessions). +- b) Media format parameters for supported IMS media types (codecs, media file formats etc.). + +NOTE: The media and codecs used for the CS call are not included in the SDP. + +#### 6.3.1.8 SDP offer answer – originating case + +When a CUA wants to create a CSI communication, the CUA shall populate the SDP as specified in subclause 6.1 in 3GPP TS 24.229 [5]. + +#### 6.3.1.9 SDP offer answer – terminating case + +When a CUA wants to participate in a CSI communication, the CUA shall populate the SDP as specified in subclause 6.1 in 3GPP TS 24.229 [5]. + +# --- 7 Combining an IM session with an existing CS call + +## 7.1 Introduction + +(void) + +## 7.2 Functional entities + +### 7.2.1 User equipment + +A UE shall implement the role of a CUA as specified in subclause 7.3.1. + +### 7.2.2 Application server (AS) + +An application server may be included for a CSI call. However, no specific CSI role is assigned to it. + +## 7.3 Roles + +### 7.3.1 CSI user agent (CUA) + +#### 7.3.1.1 General + +In addition to the procedures specified in subclause 7.3.1 of this document, the CUA shall support the procedures specified in 3GPP TS 24.229 [5] appropriate to the functional entity in which the CUA is implemented. + +#### 7.3.1.2 Exchange of UE capability information – CS first scenario + +When the CUA wants to exchange capabilities with the remote party, the CUA originating the OPTIONS request shall apply the procedure as specified in 3GPP TS 24.229 [5] with the following additions: + +- a) The CUA shall in the Request URI include one of the following: + - a URI, as received in P-Asserted-Identity header from the remote CUA during the terminal capability information exchange procedure; or, if this is not available; + - a tel URI consisting of the Connected Number information element or the Calling Party BCD number received during establishment of the existing CS call, or the MSISDN used for the CS call set-up ( the Called Party BCD Number); or + - a SIP URI associated with the remote user stored in the CUA. + +NOTE 1: The MSISDN can only be included as a tel URI if it is in the international format. + +NOTE 2: If no SIP URI or tel URI in accordance with above is available the CUA cannot initiate the OPTIONS request. + +- b) The CUA shall in the P-Preferred-Identity header either include: + - the MSISDN of the CUA as an assumed registered tel URI; or + - an assumed registered SIP URI associated with the CUA. +- c) The CUA shall in the Accept-Contact header include media feature tag(s) with the values(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both marked as explicit. +- d) The CUA may in the User-Agent header include the personal ME identifier and the UE capability version. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +The CUA answering with a 200 (OK) response to the OPTIONS request shall apply the procedure as specified in 3GPP TS 24.229 [5] with the following additions: + +- a) The CUA shall in the Contact header include media feature tag(s) with the values(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both. The CUA shall include in the Contact header the SIP-URI and, if available the tel URI that can be used to establish a CS call. + +NOTE 3: The indicated tel URI corresponds to the MSISDN intended for the CS call setup. + +- b) The CUA may in the Server header include the personal ME identifier and the UE capability version. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +Upon the receipt of the 200 (OK) response, the CUA acts in accordance with 3GPP TS 24.229 [5]. In addition, the CUA may locally update the UE capability information for the remote user, the URIs associated with the remote CUA and the personal ME identifier of the remote CUA. + +#### 7.3.1.3 Session set-up – originating case + +When the originating CUA wants to add an IM session to a CS call, it shall apply the call initiation procedure specified in 3GPP TS 24.229 [5] with the following additions: + +- a) The CUA shall in the Request URI in the initial request either include: + - 1) the URI, as received in P-Asserted Identity header from the terminating CUA during the terminal capability information exchange procedure; or if this is not available + - 2) a tel URI that either is: + - the connected number information element, received during establishment of the existing CS call, and if this is not available the MSISDN used for the CS call set-up (the used Called Party BCD Number); or + - the Calling Party BCD number information element, received during establishment of the existing CS call. +- b) The CUA shall in the P-Preferred Identity header in the initial request include an assumed registered tel URI corresponding to the MSISDN of the CUA. +- c) The CUA shall in the Accept-Contact header in the initial request include media feature tag(s) with the value(s) "+g.3gpp.cs-voice", a "+g.3gpp.cs-video" or both, marked as explicit. +- d) The Contact header shall include media feature tag(s) with the value(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both. +- e) The CUA may in the User-Agent header include the personal ME identifier and the UE capability version. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +NOTE 1: If privacy is indicated it is not possible to correlate the CS call and the IM session. + +#### 7.3.1.4 Session set-up – terminating case + +When the terminating CUA receives an initial request for an IM session, the terminating CUA shall apply the procedures as specified in 3GPP TS 24.229 [5] with the following additions: + +- a) If the Accept-Contact header in the INVITE request includes a media feature tag(s) with the value(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both, the CUA shall check if one of the identities in the P-Asserted-Identity header matches the received Calling Party BCD number information element or Connected number information element received for an ongoing CS call. If there is a match, a CSICS call is established. + +Otherwise, the CUA shall not consider this a CSI call/session. + +- b) The Contact header shall include media feature tag(s) with the value(s) "+g.3gpp.cs-voice", "+g.3gpp.cs-video" or both in the response(s), in accordance with RFC 3840 [6]. +- c) The UE may include the personal ME identifier and the UE capability version in the Server header in the responses. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. + +#### 7.3.1.5 CS call set-up – originating case + +When the originating CUA wants to set up a CS call in combination with an IM Session, the CUA shall set up the call in accordance with 3GPP TS 24.008 [4] with the following additions: + +- a) The SETUP message may include the user-user information element, which can include the radio environment information, the IM Status, the personal ME identifier and the UE capability version as specified in 3GPP TS 24.008 [4] Annex O. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. The handling of the user-user information element shall be in accordance with 3GPP TS 24.087 [9]. + +If the CONNECT message includes a personal ME identifier and UE capability version and the combination of MSISDN plus personal ME identifier plus UE capability version of the terminating UE is known to the CUA, the CUA may indicate already available capability information of the terminating UE to the user via the MMI. If originating UE finds that terminating UE and its current radio environment supports simultaneous CS and PS services and terminating UE's IM Status indicates the remote UE is either IM subsystem registered or IM subsystem capable and willing to register to IM subsystem, then if allowed by the user's preference originating UE should attempt an IMS registration (if the UE is not already IMS registered). + +NOTE 1: If the CUA does not support the user-to-user 1 supplementary service, in accordance with 3GPP TS 22.087 [8] the radio environment information, the IM Status, the personal ME identifier and the UE capability version: + +- will not be sent to the remote CUA, +- will be ignored if provided by the remote CUA. + +NOTE 2: It is assumed that the originating CUA uses COLP supplementary service, in accordance with 3GPP TS 22.081 [7] and UUS service 1, in accordance with 3GPP TS 22.087 [8] The CLIR supplementary service in accordance with 3GPP TS 22.081 [7] is not in use in the originating CUA. + +#### 7.3.1.6 CS call set-up – terminating case + +When the terminating CUA receives a CS call: + +- a) the CUA shall set up the call in accordance with 3GPP TS 24.008 [4] and may include the user to user information element in the CONNECT message with the radio environment information, the IM Status, the personal ME identifier and the UE capability version as defined in 3GPP TS 24.008 [4] Annex O. Both, the personal ME identifier and the UE capability version, shall be present or neither of them. The handling of the user-user information element shall be in accordance with 3GPP TS 22.087 [8]. + +If the SETUP message includes a personal ME identifier and UE capability version and the combination of MSISDN plus personal ME identifier plus UE capability version of the originating UE is known to the CUA, the CUA may indicate already available capability information of the originating UE to the user via the MMI. If terminating UE finds that originating UE and its current radio environment supports simultaneous CS and PS services and originating UE's IM Status indicates the remote UE is either IM subsystem registered or IM subsystem capable and willing to register to IM subsystem, then if allowed by the user's preference terminating UE should attempt an IMS registration (if the UE is not already IMS registered). + +NOTE 1: If the CUA does not support the user-to-user 1 supplementary service, in accordance with 3GPP TS 24.087 [9] the radio environment information, the IM Status, the personal ME identifier and the UE capability version: + +- will not be sent to the remote CUA +- will be ignored if provided by the remote CUA. + +NOTE 2: It is assumed that the terminating CUA uses the CLIP supplementary service, in accordance with 3GPP TS 22.081 [7] and UUS service 1, in accordance with 3GPP TS 22.087 [8]. The COLR supplementary service in accordance with 3GPP TS 22.081 [7] is not in use in the terminating CUA. + +#### 7.3.1.7 SDP exchange – UE capability information exchange + +The CUA shall act in accordance with subclause 6.3.1.7. + +#### 7.3.1.8 SDP offer-answer – originating case + +The CUA shall act in accordance with subclause 6.3.1.8. + +#### 7.3.1.9 SDP offer-answer – terminating case + +The CUA shall act in accordance with subclause 6.3.1.9. + +# --- 8 Interaction with supplementary services + +## 8.1 Roles + +### 8.1.1 CSI user agent (CUA) + +No protocol interactions for supplementary services are identified. + +NOTE: Service interactions are specified in 3GPP TS 23.279 [3]. + +### 8.1.2 CSI application server (CSI AS) + +#### 8.1.2.1 Introduction + +Other than the interactions to supplementary services described below, no further interactions to other supplementary services have been identified. + +#### 8.1.2.2 Call Forwarding and Call Barring + +The determination that Call Forwarding is being applied to terminating CUA or that Call Barring has been applied to the terminating CUA and the subsequent behaviour of the CSI AS is given in subclause 9.3.3.5. + +#### 8.2.1.3 Call Completion + +If the CSI AS receives indications that the terminating CUA has applied call hold or call retrieval, the CSI AS shall perform corresponding session modification toward the originating UE. + +# --- 9 IMS origination and CSI termination + +## 9.1 Introduction + +This subclause describes the detailed procedures for establishing sessions from UEs that use IMS origination to UEs that use CSI termination. + +NOTE: The IMS origination and CSI termination are specific session establishment scenarios defined in TS 23.279 [3]. When a UE is considered to use IMS origination and when a UE is considered to use CSI termination is defined in subclause 9.2.1 of TS 23.279 [3]. + +## 9.2 Functional entities + +### 9.2.1 User equipment + +For establishing sessions with IMS origination and CSI termination, two different UEs are involved. + +- 1) The UE that uses CSI termination, which terminates sessions by receiving real time media over the CS domain. This UE implements the role of CUA as specified in subclause 6.3.1 and subclause 7.3.1. +- 2) The UE that uses IMS origination, which originates sessions by transmitting real time and non-real time media over an IP-CAN. + +### 9.2.2 Application server (AS) + +For supporting the control functionality required to handle sessions with IMS origination and CSI termination an application server shall implement the role of CSI AS as defined in subclause 9.3.3. + +### 9.2.3 MGCF + +No specific role in support of provision of CSI terminating session has been identified for the MGCF. In this version of this document, any CSI capability related information if provided to the MGCF will not be interworked by the MGCF. + +## 9.3 Roles + +### 9.3.1 Void + +### 9.3.2 CSI UA (CUA) + +The UE that uses CSI termination implements the role of CUA as specified in subclause 6.3.1 and subclause 7.3.1 with no additional requirements. + +NOTE: For proper handling and delivery of CSI terminating sessions, a CUA needs to include the media feature tags applicable for CSI in the Contact header when performing the registration procedure. + +### 9.3.3 CSI AS + +#### 9.3.3.1 General + +The CSI AS shall support the procedure for the multimedia session splitting, modifying, combining and releasing. + +To support a CSI session between a UE in IMS only mode and a CSI capable UE (CUA), the CSI AS shall support capability exchange with the CUA in the terminating CS domain on behalf of the CUA in the originating IM CN subsystem, when the CSI AS has determined that the network supports the required CSI functionality. + +The CSI AS can use the media feature tags (e.g. g.3gpp.cs-voice and g.3gpp.cs-video) obtained from the terminating CUA to perform termination logic. + +If the media feature tags indicate that the CUA has both voice and video capabilities and that CSI AS knows that video interworking to the CS domain is supported, then the CSI AS can use the CS domain to terminate any realtime voice and video sessions to the CUA. However the IM CN subsystem can also be used for the video component of the real time conversation. + +NOTE 1: The knowledge that the IM CN subsystem supports video interworking to the CS domain is configured in the CSI AS. + +The procedure of multimedia session splitting is specified in the subclause 9.3.3.3. + +NOTE 2: The CSI AS obtains the media feature tags of the terminating CUA from the reg-event package. + +#### 9.3.3.2 Retrieval of public user identity information + +The CSI AS can obtain information about the public user identities of the CUA by using the reg event package as specified in 3GPP TS 24.229 [5], or via the Sh interface as specified in 3GPP TS 29.328 [16]. + +The information about the public user identities can also be provisioned in the CSI AS. + +NOTE: A third party REGISTER request received by the CSI AS can be triggered by a CUA including in the Contact header of the REGISTER request the media feature tag value(s) of "+g.3gpp.cs-voice" and "+g.3gpp.cs-video" or both. + +#### 9.3.3.3 Session Splitting towards terminating CUA + +##### 9.3.3.3.1 General + +When the CSI AS receives a SIP INVITE request including the SDP media descriptions for both voice media and non-voice media (e.g. MSRP) from the originating UE, the CSI AS shall check if the received dialog identifier in the request matches a dialog identifier for an ongoing session in the CSI AS: + +- 1) if there is no match, the CSI AS performs the session splitting procedure as follows: + - a) for the non-voice media, the CSI AS shall initiate the new SIP INVITE request requesting the same non-voice media as received in the incoming INVITE request towards the CUA via IM CN subsystem as per subclause 9.3.3.3.3; and + - b) for the voice media, the CSI AS shall initiate the new SIP INVITE request requesting the same voice media as received in the incoming INVITE request towards the CUA via CS domain through the MGCF as per subclause 9.3.3.3.2. +- 2) if there is a match, the CSI AS shall act as per subclause 9.3.3.4.3. + +When the CSI AS receives the SIP INVITE request including the SDP media description from the originating UE for voice media only, the CSI AS shall check if the dialog identifier in the request matches a dialog identifier for an ongoing session in the CSI AS; + +- 1) if there is no match, the CSI AS shall follow the procedure in subclause 9.3.3.3.2; or +- 2) otherwise the CSI AS shall follow the procedures as specified in subclause 9.3.3.4.2. + +When the CSI AS receives the SIP INVITE request including the SDP media description from the originating UE for non-voice media only, the CSI AS shall check if the dialog identifier in the request matches a dialog identifier for an ongoing session in the CSI AS: + +- 1) if there is no match, the CSI AS shall follow the subclause 9.3.3.3.3; or +- 2) otherwise the CSI AS shall follow the subclause 9.3.3.4.1. + +For the standalone SIP request and the SIP request initiating a new dialog other than the SIP INVITE request, the CSI AS shall follow subclause 5.7.5 of 3GPP TS 24.229[5] without splitting. + +##### 9.3.3.3.2 Call Initiation towards the CS domain + +When the CSI AS receives an initial SIP INVITE request that requests an IMS session with voice media, the CSI AS shall perform the third party call control, as specified 5.7.5 of 3GPP TS 24.229[5] including the following: + +- 1) The CSI AS creates the SIP INVITE request setting the Request-URI and To header to a Tel-URI which is an alias of the SIP-URI which is included in the received SIP INVITE request; +- NOTE: The CSI AS maps between SIP-URI and Tel-URI from information provided by the HSS about alias URIs of the registered identity, as specified in 3GPP TS 29.328[16]. +- 2) The CSI AS adds the address of BGCF in the Route header to be located behind of the address of S-CSCF; + - 3) The CSI AS populates the SDP with the voice media parameters which were included in the SIP INVITE request from the originating UE; and + - 4) The CSI AS sends the SIP INVITE request towards the S-CSCF for further routing. + +If the CSI AS does not take any action for the received SIP INVITE request, it shall apply the procedure described in subclause 5.7.4 of 3GPP TS 24.229 [5]. + +##### 9.3.3.3.3 Session Initiation towards the IM CN subsystem + +When the CSI AS initiates a session towards the CUA for a non-voice media the CSI AS shall; + +- 1) operate as an application server performing 3rd party call control acting as a routing B2BUA, as specified in subclause 5.7.5 of 3GPP TS 24.229 [5] for this request and all future requests and in the same dialog; +- 2) set the Request-URI and the To header field to the SIP-URI for the CUA in the outgoing SIP INVITE request; +- 3) populate the SDP with the non-voice media parameters which were included in the SIP INVITE request or a SIP UPDATE request from the originating UE into the outgoing SIP INVITE request; +- 4) include in the Accept-Contact header field the feature tag(s) with the value(s) "+g.3gpp.cs-voice" or "+g.3gpp.cs-video" or both, marked as explicit; and +- 5) send the SIP INVITE request towards the S-CSCF for further routing. + +When the CSI AS receives a SIP response from the CUA, the CSI AS shall act in accordance with subclause 9.3.3.5. + +When the CSI AS initiates a session towards the originating UE the CSI AS shall: + +- 1) operate as an application server performing 3rd party call control acting as an initiating B2BUA, specified in subclause 5.7.5 of 3GPP TS 24.229 [5] for this request and all future requests in the same dialog; +- 2) set the Request-URI and the To header field in the outgoing SIP INVITE request to the SIP URI as indicated in the P-Asserted-Identity header field received from the originating UE; +- 3) populate the SDP with the media components which were included in the SDP of a SIP re-INVITE request or a UPDATE request and not possible to use on the existing session to the originating UE in the outgoing SIP INVITE request; and +- 4) send the SIP INVITE request towards the S-CSCF for further routing. + +When the CSI AS receives a SIP response from the originating UE the CSI AS shall handle the response by following the rules of the 3GPP TS 24.229 [5]. + +##### 9.3.3.3.4 Subsequent requests + +When the CSI AS receives a subsequent SIP request from the originating UE before it has provided the final SIP response to the originating UE (i.e. in early dialog), the CSI AS shall act as follows: + +- 1) The SIP request which is triggered by the subsequent SIP request from the originating UE shall include exactly the same media components as the SIP requests triggered by the initial SIP INVITE request; and +- 2) the CSI AS shall not send a SIP request to the already established call leg if the CSI AS has received the final SIP response for that call leg. Instead the CSI AS shall include the media description indicating the media on the established call leg is ready when responding back to the originating UE. + +Upon receipt of the SIP re-INVITE request or the SIP UPDATE request from the originating UE after the session is established, the CSI AS shall follow subclause 9.3.3.4. Handling of other subsequent SIP requests is out of scope of this version of the document. + +#### 9.3.3.4 Session Modification + +##### 9.3.3.4.1 Adding an IM Session to an existing CS call + +When the CSI AS receives a SIP re-INVITE request or a SIP UPDATE request from the originating UE and the received SDP includes other "m=" lines than "m=audio" line that have non-zero port numbers and there do not exist any non voice media session to the CUA, the CSI AS shall initiate a SIP INVITE request requesting the same non-voice media as received in the incoming re-INVITE request or UPDATE request towards the CUA via the IM CN subsystem as specified in the subclause 9.3.3.3.3. If there exist a session the CSI AS shall send an SIP re-INVITE or SIP UPDATE request to the CUA in accordance with subclause 9.3.3.4.3. + +When the CSI AS receives the SIP response message from the CUA, it shall be processed according to subclause 9.3.3.5. + +When the CSI AS receives a SIP re-INVITE request or a SIP UPDATE request from the CUA and the CSI AS is required to setup a new session the set up is performed in accordance with subclause 9.3.3.3.3. Otherwise the CSI-AS shall send a SIP re-INVITE request or a SIP UPDATE request to the originating UE including: + +- the Request-URI set to the URI received from the originating UE in the Contact header; and +- a new SDP offer, including the media characteristics as received in the incoming SIP re-INVITE or UPDATE request, by following the rules of the 3GPP TS 24.229 [5]. + +NOTE: Whether the CSI AS uses the existing dialog to the originating UE or uses a new dialog can depend on local policy and received signalling information in the SDP from the originating UE. + +When the CSI AS receives a SIP response message from the originating UE, the responses shall be processed according to the rules specified in 3GPP TS 24.229 [5]. + +##### 9.3.3.4.2 Adding a CS call to an existing IMS Session + +When the CSI AS receives a SIP re-INVITE request or a SIP UPDATE request and the received SDP includes an additional "m=audio" line which has non-zero port; + +- the CSI AS shall check if there is an ongoing voice call between the CUA and the CSI AS which is associated with the same session in which the SIP re-INVITE request or a SIP UPDATE request is received; + - a) If a voice call between the CUA and the CSI AS via CS domain does not exist, the CSI AS shall initiate a SIP INVITE requesting the same voice media towards the CUA as specified in the subclause 9.3.3.3.2 ; + - b) Otherwise, the CSI AS shall reply with 4xx response. + +NOTE: The multicall setup is not supported within this specification. + +When the CSI AS receives the SIP response from the MGCF, it shall be processed according to the subcaluse 9.3.3.5. + +When the CSI AS receives a SIP re-INVITE request or a SIP UPDATE request and the received SDP includes an additional entry in the existing "m=audio" line which has non-zero port; + +- the CSI AS shall check if there is an ongoing voice call between the CUA and the CSI AS which is associated with the same session in which the SIP re-INVITE or a SIP UPDATE request is received; + - a) If a voice call between the CUA and the CSI AS via CS domain does not exist, the CSI AS shall initiate a SIP INVITE requesting the same voice media towards the CUA as specified in the subclause 9.3.3.3.2; + - b) Otherwise the CSI AS shall send an SIP re-INVITE or a SIP UPDATE request to the CUA including: + - the Request-URI set to the URI received from the MGCF in the Contact header; and + - a new SDP offer, including the media characteristics as received in the SIP re-INVITE or a SIP UPDATE request , by following the rules of the 3GPP TS24.229 [5]. + +##### 9.3.3.4.3 Modifying an existing CS call and an existing IMS Session + +When the CSI AS receives a SIP re-INVITE request or a SIP UPDATE request where the dialog identifier included in the request matches with a dialog identifier of an ongoing session then; + +- 1) if the SDP media description for voice in the received SIP re-INVITE request or a SIP UPDATE request is updated; + - a) the CSI AS shall send a SIP re-INVITE request or a SIP UPDATE request to the MGCF including; + - the Request-URI and the To header field set to the URI received from the MGCF in the Contact header field; and + - a new SDP offer, including the media characteristics as received in the SIP re-INVITE or A SIP UPDATE request , by following the rules of 3GPP TS 24.229 [5]. + - b) When the CSI AS receives the SIP response from the MGCF, the SIP response shall be processed according to subclause 9.3.3.5. + +- 2) if the SDP media description for non-voice in the received SIP re-INVITE request or SIP UPDATE request is updated; + - a) the CSI AS shall send a SIP re-INVITE request or SIP UPDATE request to the CUA including; + - the Request-URI and the To header field set to the URI received from the CUA in the Contact header field; and + - a new SDP offer, including the media characteristics as received in the SIP INVITE request or a SIP UPDATE request, by following the rules of the 3GPP TS 24.229 [5]. + - b) When the CSI AS receives the SIP response from the CUA, the SIP response shall be processed according to subclause 9.3.3.5. +- 3) if the SDP media description in the received SIP re-INVITE request includes one or more 'm=' lines with the port number set to zero, the CSI AS shall act as specified in the subclause 9.3.3.6. + +#### 9.3.3.5 Session Combining + +The CSI AS having established one call leg to the CUA and another call leg to the MGCF shall combine the SIP responses from the CUA and the MGCF as follows: + +The CSI AS shall act as a B2BUA as per subclause 5.7.5 of 3GPP TS 24.229 [5] with the following additions. + +If the CSI AS receives a SDP answer from both of the two call legs, the CSI AS shall include a SDP answer in a SIP response which includes the SDP from both legs in accordance with 3GPP TS 24.229 [5], i.e. the CSI AS shall respond to the SIP INVITE request from the originating UE when all SDP media descriptions from both of the two split call legs are known to the CSI AS. The SIP response code that is sent to the originating UE by the CSI AS depends on the SIP response received from the two call legs and is specified in table 9.3.3.5A. + +If the CSI AS receives only SDP answer from one of the legs, the CSI AS shall include the SDP answer in a SIP response in accordance with 3GPP TS 24.229[5]. The SIP response code that is sent to the originating UE by the CSI AS depends on the SIP response received from the two call legs and is specified in table 9.3.3.5A. + +If the CSI AS receives SIP responses without any SDP, the SIP response code that is sent to the originating UE by the CSI AS depends on the SIP response received from the two call legs and is specified in table 9.3.3.5A. + +In addition to table 9.3.3.5A, when the CSI AS receives only one SDP answer from one leg while having a SIP 3xx – 6xx error response(s) from the other leg, the CSI AS shall: + +- 1) if the SIP error response is received from the MGCF, provide the SIP response to the originating UE as shown in table 9.3.3.5A but with the port of the voice media set to 0 in the SDP answer provided to the originating UE; or +- 2) if the SIP error response is received from the CUA, provide the SIP response to the originating UE as shown in table 9.3.3.5A but with the port of the non-voice media set to 0 in the SDP answer provided to the originating UE. + +When the CSI AS receives the SIP responses for the SIP INVITE requests that were sent to the CUA and the MGCF, the CSI AS shall: + +- 1) provide the SIP response to the originating UE as per subclause 5.7.5 of 3GPP TS 24.229 [5]. In this SIP response except the final SIP response, the CSI AS shall provide all SDP media description that is received from the CUA and the MGCF in the SDP answer; +- 2) provide the combined final SIP response to the originating UE only if the final SIP responses arriving from each of the two call legs, have the same SIP status code; or +- 3) provide the SIP response as shown in the table 9.3.3.5A below to the originating UE if the SIP responses arrived from the two call legs have different status codes; +- 4) provide a combined SIP 180 (Ringing) response to the originating UE only if the SIP 180 (Ringing) responses arrive from each early dialog of the two call legs. When the precondition mechanism is used, the CSI AS shall not provide a combined SIP 180 (Ringing) response until the required resource reservations are met for each of the two call legs; + +- 5) provide - when precondition mechanism is used - a combined SIP 200 (OK) response to the SIP UPDATE request to the originating UE only if both SIP 200 (OK) responses to the SIP UPDATE requests which had been sent in each of the two call legs arrive; +- 6) provide a SIP response to the originating UE including "100rel" in the Require header field if at least one of SIP responses from either call legs include "100rel" in the Required header; and +- 7) if due to forking more than one SIP response is received for the non-voice media, choose one which comes from the CUA and initiate SIP CANCEL request(s) to cancel the other forked dialog(s). + +NOTE: The CSI AS recognizes the SIP response from the CUA by regarding the media feature tag or by comparing contact address in the Contact header with the terminal information stored in the CSI AS. + +If one of two call legs is established earlier than the other, the CSI AS upon receiving a SIP response from the early dialog of the other call leg shall include the media description showing the media on the established call leg is ready when responding back to the originating UE. + +If the CSI AS does not receive any response from one of call legs towards the CUA within an implementation dependent time, the CSI AS shall reject the media of that corresponding leg that has timeout, by indicating such rejection within the SDP body media descriptions when the CSI AS response to the originating UE. For the call leg that has not responded by timeout, the CSI AS may initiate the SIP CANCEL request to cancel the pending session of the corresponding call leg. Any responses received after this timeout are ignored by the CSI AS. + +**Table 9.3.3.5A: SIP response (CSI AS to the originating UE)** + +| Response from MGCF | Response from CUA | Response provided by CSI AS to the originating UE | +|--------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 180 | 200 | 180(When preconditions between the UE and CSI AS are met) | +| 200 | 180 | | +| 183 | 200 | 183 | +| 200 | 183 | | +| 4xx/5xx/6xx | 180 | 180(When preconditions between the UE and CSI AS are met) | +| 180 | 4xx/5xx/6xx | | +| 4xx/5xx/6xx | 183/200 | 183/200 | +| 183/200 | 4xx/5xx/6xx | | +| 181 | Any response | Response will be based on local policy, i.e. keep the successfully established CS call or/and IMS session with the calling party. | +| Any response | 181 | | +| 4xx/5xx/6xx | 4xx/5xx/6xx | 4xx/5xx/6xx (according to the best response procedures as specified in IETF RFC 3261[17]) | +| 603 | Any response | Either when responding back to the originating UE provide an SDP answer rejecting the media component which is subject to Call Barring and thereby allow the originating UE to renegotiate, or respond to the calling UE with the response indicating that call is barred and initiate a SIP CANCEL request to cancel the other call leg being established toward the CUA. | +| Any response | 603 | Either when responding back to the originating UE provide an SDP answer rejecting the media component which is subject to Call Barring and thereby allow the originating UE to renegotiate, or respond to the calling UE with the response indicating that call is barred and initiate a SIP CANCEL request to cancel the other call leg being established toward the CUA. | + +#### 9.3.3.6 Session Release + +If the CSI AS receives the SIP re-INVITE request or a SIP UPDATE request which includes "m=" lines where the port number has been changed to zero from that provided in the previous SDP offer from the originating UE, then: + +- 1) if the received SDP media description includes the port number set to zero for all "m=audio" lines, the CSI AS shall initiate a SIP BYE request to release the session toward the MGCF which is associated with the session where the SIP re-INVITE or SIP UPDATE request is received; +- 2) if the received SDP media description includes the port number set to zero for a "m=audio" line, the CSI AS shall initiate a SIP re-INVITE or a SIP UPDATE request including a SDP with the received "m=audio" lines in accordance with 3GPP TS 24.229 [5]; +- 3) if the received SDP media description includes the port number set to zero for non-"m=audio" lines, the CSI AS initiates a SIP re-INVITE request including SDP media description for non-voice toward the CUA; or +- 4) if the received SDP media description includes the port numbers set to zero for all the "m=" lines other than "m=audio" the CSI AS initiates a SIP BYE request towards the CUA in the IM CN subsystem. + +If the CSI AS receives the SIP BYE request from the originating UE, then; + +- 1) the CSI AS shall initiate the SIP BYE request to release the session towards the CUA which is associated to the session where the SIP BYE request is received and, +- 2) the CSI AS shall initiate the SIP BYE request to release the session towards the MGCF which is associated to the session where the SIP BYE request is received. + +If the CSI AS receives the SIP BYE request from the CUA or the MGCF, then; + +- 1) if there is no remaining session other than the session the SIP BYE request belongs to, the CSI AS initiates a SIP BYE request toward the originating UE or, +- 2) otherwise, the CSI AS initiates a SIP re-INVITE request to remove corresponding media towards the originating UE. + +#### 9.3.3.7 Unregistered Service + +To allow for the provision of unregistered service, the CSI AS may keep the UE capability information after the user has been deregistered from the IM CN subsystem. The duration of validity of UE capability information after a UE has deregistered from the IM CN subsystem is an operator policy. + +When the CSI AS receives a SIP INVITE request destined for a user who is unregistered to the IM CN subsystem, the CSI AS shall follow 9.3.3.3 with the following addition. + +- The CSI AS shall not initiate a session toward the IM CN subsystem and shall in the SDP answer provided to the originating UE, set the port to 0 for all media except the voice media. + +NOTE 1: In the case that the CSI terminating service is part of a series of unregistered services for the user, care is taken that the triggering of the CSI AS does not negatively affect the provisioning of other unregistered services for that user in the terminating network, ie. the terminating user's service profile iFC is so set up to ensure orderly triggering of the CSI AS and the other unregistered services for that terminating user. + +NOTE 2: Forwarding an incoming call to the CUA via CS domain by using Call Forwarding Supplementary Service is not in the scope of this document. + +#### 9.3.3.8 Capability exchange with the CSI UE + +When the CSI AS has determined that the network supports the functionality required for CSI sessions between UEs in IMS only mode and a CSI capable UE (CUA) and has received an initial INVITE request, then the CSI AS shall perform CSI capability exchange with the terminating CSI UE on behalf of the originating IMS UE. The SIP INVITE request generated by the CSI AS shall include the User-to-User header field as defined in RFC 7433 [18]. This User-to-User header field shall contain the following CSI capability information in the User-user information element as defined in 3GPP TS 24.008 [4] Annex O: + +- 1) The IM Status is configured as IM subsystem registered; + +2) The radio environment is configured as capable of simultaneous services. + +NOTE: 3GPP TS 24.008 [4] specifies that the user-user information element is used to convey information between the mobile station and the remote ISDN user. A package for interworking user-to-user information with the ISDN is defined by RFC 7434 [19]. + +# --- Annex A (normative): Media feature tags defined within the current document + +## A.1 General + +This subclause describes the media feature tag definitions that are applicable for the 3GPP IM CN Subsystem for the realisation of CS. + +## --- A.2 Definition of media feature tag g.3gpp.cs-voice + +Media feature-tag name: g.3gpp.cs-voice + +ASN.1 Identifier: 1.3.6.1.8.2.1 + +Summary of the media feature indicated by this tag: This feature-tag indicates that the device supports circuit switched voice when combining circuit switched calls and IM sessions. + +Values appropriate for use with this feature-tag: Boolean. + +The feature-tag is intended primarily for use in the following applications, protocols, services, or negotiation mechanisms: This feature-tag is most useful in a communications application, for describing the capabilities of a device, such as a phone or PDA. + +Examples of typical use: Indicating that a mobile phone can support voice in a circuit switched environment within the context of combining a circuit switched voice call with an IM session. + +Related standards or documents: 3GPP TS 24.279: "Combining Circuit Switched (CS) and IP Multimedia Subsystem (IMS) services, stage 3" + +Security Considerations: Security considerations for this media feature-tag are discussed in subclause 11.1 of RFC 3840 [6]. + +## --- A.3 Definition of media feature tag g.3gpp.cs-video + +Media feature-tag name: g.3gpp.cs-video + +ASN.1 Identifier: 1.3.6.1.8.2.2 + +Summary of the media feature indicated by this tag: This feature-tag indicates that the device supports circuit switched video when combining circuit switched video calls and IM sessions. + +Values appropriate for use with this feature-tag: Boolean. + +The feature-tag is intended primarily for use in the following applications, protocols, services, or negotiation mechanisms: This feature-tag is most useful in a communications application, for describing the capabilities of a device, such as a phone or PDA. + +Examples of typical use: Indicating that a mobile phone can support video in a circuit switched environment within the context of combining a circuit switched video call with an IM session. + +Related standards or documents: 3GPP TS 24.279: "Combining Circuit Switched (CS) and IP Multimedia Subsystem (IMS) services, stage 3" + +Security Considerations: Security considerations for this media feature-tag are discussed in subclause 11.1 of RFC 3840 [6]. + +--- + +# Annex B (informative): Example signalling flows for the combining of CS calls with IM sessions + +## B.1 Scope of signalling flows + +This annex gives examples of signalling flows for the combination of CS calls with IM sessions within the IP Multimedia (IM) Core Network (CN) subsystem based on the Session Initiation Protocol (SIP). + +These detailed signalling flows expand on the overview information flows provided in 3GPP TS 23.279 [3]. + +--- + +## B.2 Introduction + +### B.2.1 General + +The signalling flows provided in this annex follow the methodology developed in 3GPP TS 24.228 [11]. The following additional considerations apply: + +- a) 3GPP TS 24.228 [11] shows separate signalling flows with no configuration hiding between networks, and with configuration hiding between networks. There is no combining of CS calls with IM sessions functionality associated with this hiding, and therefore such separate signalling flows are not show in the present document; +- b) 3GPP TS 24.228 [11] breaks down the functionality of the various CSCFs. Such intervening activity in the CSCFs is in general not relevant to showing the functionality combining of CS calls with IM sessions, and therefore the CSCFs are collapsed into a single entity labelled "Intermediate IM CN subsystem entities". + +### B.2.2 Key required to interpret signalling flows + +The key to interpret signalling flows specified in 3GPP TS 24.228 [11] subclause 4.1 applies with the additions specified below: + +- tel:+12125551111 is the tel URI, PMI-0007 is the personal ME identifier and UCV-04 is the UE capability version relating to CUA#1; +- tel:+12125552222 is the tel URI, PMI-0EA2 is the personal ME identifier and UCV-0D is the UE capability version relating to CUA#2; +- tel:+12125553333 is the tel URI of the UE#1 and +- sip:user3\_public1@home1.net is the SIP URI of the UE#1. + +Each signalling flow table contains descriptions for headers where the content of the header is new to that signalling flow, as is already performed in 3GPP TS 24.228 [11]. + +However, 3GPP TS 24.228 [11] includes extensive descriptions for the contents of various headers following each of the tables representing the contents of the signalling flows. Where the operation of the header is identical to that shown in 3GPP TS 24.228 [11], then such text is not reproduced in the present document. + +Additional text can also be found on the contents of headers within 3GPP TS 24.228 [11] in addition to the material shown in the present document. + +In order to differentiate between messages for SIP and media, the following notation is used: + +![Diagram illustrating signalling flow notation. It shows four horizontal lines representing different types of communication: 1. A solid line with an arrow pointing right, labeled 'INVITE' above and 'SIP message' to the right. 2. A dashed line with an arrow pointing right, labeled 'SETUP' above and 'CS message' to the right. 3. A solid double-headed arrow, labeled 'Media over a PS connection' to the right. 4. A dashed double-headed arrow, labeled 'Media over a CS connection' to the right.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +Diagram illustrating signalling flow notation. It shows four horizontal lines representing different types of communication: 1. A solid line with an arrow pointing right, labeled 'INVITE' above and 'SIP message' to the right. 2. A dashed line with an arrow pointing right, labeled 'SETUP' above and 'CS message' to the right. 3. A solid double-headed arrow, labeled 'Media over a PS connection' to the right. 4. A dashed double-headed arrow, labeled 'Media over a CS connection' to the right. + +Figure B.2.2-1: Signalling flow notation + +## B.3 Signalling flows demonstrating CSI session setup when no CS call has yet been set up + +### B.3.1 Introduction + +This subclause provides signalling flows for CSI session setup, using session-based messaging as an example, established before any CS call has been established. + +The signalling flows are based on the session establishment flows in subclause A.3 of 3GPP TS 24.247 [10], with some additions related to CSI. The UAC includes the media feature tags g.3gpp.cs-voice and g.3gpp.cs-video in the Accept-Contact header. + +### B.3.2 Establishing a CSI session when no CS call has yet been set up + +Figure B.3.2-1 shows the establishment of an MSRP session between two users as well. A CS call is then established after MSRP messages are communicated over the established PS connection. + +![Sequence diagram showing the establishment of a session before a CS call is established between CUA#1 and CUA#2 via Intermediate IM CN subsystem entities and Intermediate CS entities.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant CUA#1 + participant IMCN as Intermediate IM CN subsystem entities + participant CS as Intermediate CS entities + participant CUA#2 + + Note left of CUA#1: 1. OPTIONS request and response + CUA#1->>CUA#2: 1. OPTIONS request and response + Note right of CUA#1: 2. INVITE + CUA#1->>IMCN: 2. INVITE + Note left of IMCN: 3. 100 Trying + IMCN-->>CUA#1: 3. 100 Trying + Note right of IMCN: 4a. User-Agent P-CSCF#1 -> P-CSCF#2 +4b. INVITE request S-CSCF -> I-CSCF + IMCN->>CUA#2: 5. INVITE + Note left of IMCN: 6. 100. Trying + IMCN-->>CUA#2: 6. 100. Trying + Note right of CUA#2: 7. Reserve IP-CAN bearer for media + CUA#2->>CUA#1: 8. Reliable exchange of SDP + Note right of IMCN: 9. 200 OK + IMCN-->>CUA#2: 9. 200 OK + Note left of CUA#1: 10. 200 OK + CUA#1-->>IMCN: 10. 200 OK + Note right of CUA#1: 11. ACK + CUA#1->>IMCN: 11. ACK + Note right of IMCN: 13. ACK + IMCN-->>CUA#2: 13. ACK + Note left of CUA#1: 12. Reserve IP-CAN bearer for media + CUA#1->>CUA#2: 14. Establishment of the MSRP session + Note right of CUA#1: 15. Media exchange in PS domain + CUA#1->>CUA#2: 15. Media exchange in PS domain + Note right of IMCN: 16. SETUP + IMCN->>CS: 16. SETUP + Note left of CUA#1: 17. CALL PROCEEDING + CS-->>CUA#1: 17. CALL PROCEEDING + Note right of CS: 18. SETUP + CS->>CUA#2: 18. SETUP + Note left of CS: 19. CALL CONFIRM + CS-->>CUA#2: 19. CALL CONFIRM + Note right of CS: 20. Early Assignment of User Plane Resources + CS-->>CUA#2: 21. ALERTING + Note right of IMCN: 22. Early Assignment of User Plane Resources + IMCN-->>CUA#1: 23. ALERTING + Note right of CS: 24. CONNECT + CS->>CUA#2: 24. CONNECT + Note right of CS: 25. CONNECT ACKNOWLEDGE + CS-->>CUA#2: 25. CONNECT ACKNOWLEDGE + Note left of CUA#1: 26. CONNECT + CUA#1-->>IMCN: 26. CONNECT + Note right of CS: 27. CONNECT ACKNOWLEDGE + CS-->>CUA#1: 27. CONNECT ACKNOWLEDGE + Note right of CUA#1: 28. Active Call in CS domain + CUA#1->>CUA#2: 28. Active Call in CS domain + +``` + +Sequence diagram showing the establishment of a session before a CS call is established between CUA#1 and CUA#2 via Intermediate IM CN subsystem entities and Intermediate CS entities. + +**Figure B.3.2-1: Establishment of a session before a CS call is established** + +The details of the signalling flows are as follows: + +#### **1. UE capabilities exchange** + +Both UEs have performed a capability exchange. In the here shown example both UEs transfer their UE capability version and personal ME identifier as a part of the capability exchange. An example for capability exchange without the usage of UE capability version and personal ME identifier can be found in subclause B.6. + +#### 2. INVITE request (CUA#1 to P-CSCF#1) - see example in table B.3.2-2 + +The originating CUA wants to initiate a session with the terminating CUA. In this example, the originating CUA creates a local MSRP URL, which can be used for the communication between the two user agents. It builds a SDP Offer containing the generated MSRP URL and assigns a local port number for the MSRP communication. + +The originating CUA declares its capabilities for CS-voice and CS-video, and requests to reach a UE with cs-voice or cs-video capabilities. The originating CUA includes its personal ME identifier and UE capability version in the User-Agent header. + +**Table B.3.2-2: INVITE request (CUA#1 to P-CSCF#1)** + +``` + +INVITE tel:+12125552222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ,+g.3gpp.cs-voice;+g.3gpp.cs-video +Accept-Contact: *,+g.3gpp.cs-voice, +g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +User-Agent: PMI-0007, UCV-04 +Accept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 3402 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html image/jpeg image/gif video/3gpp +a=path:msrp://[5555::aaa:bbb:ccc:ddd]:3402/s111271;tcp +a=max-size:131072 + +``` + +**SDP** The SDP contains a set of content types supported by CUA#1 and desired by the user at CUA#1 for this session in the accept-types attribute and indicates the maximum size message that can be received by CUA#1 in the max-size attribute. + +#### 3. 100 (Trying) response (P-CSCF#1 to CUA#1) + +The P-CSCF responds to the INVITE request with a 100 (Trying) provisional response as described in subclause A.3 of 3GPP TS 24.247 [10]. + +#### 4a. User-Agent (P-CSCF#1 to P-CSCF#2) + +The User-Agent header field is transparently passed from P-CSCF#1 to P-CSCF#2. + +#### 4b. INVITE request (S-CSCF#1 to I-CSCF#2) - see example in table B.3.2-4b + +S-CSCF#1 forwards the INVITE request to the I-CSCF#2, after mapping the tel URI to a SIP-URI. + +**Table B.3.2-4b: INVITE request (S-CSCF#1 to I-CSCF#2)** + +``` +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Accept-Contact: +Allow: +Accept: +User Agent: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= +``` + +#### **5. INVITE request (P-CSCF#2 to CUA#2) – see example in table B.3.2-5** + +P-CSCF#2 forwards the INVITE request to the terminating CUA. + +**Table B.3.2-5: INVITE request (P-CSCF#2 to CUA#2)** + +``` + +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 65 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported +Contact: +Accept-Contact: +Allow: +Accept: +User-Agent: +P-Called-Party-ID: +Content-Type: +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +#### **6. 100 (Trying) response (CUA#2 to P-CSCF#2)** + +The terminating CUA sends a 100 (Trying) provisional response to P-CSCF#2 as described in subclause A.3 of 3GPP TS 24.247 [10]. + +#### **7. Reserve IP-CAN bearer for media** + +The terminating CUA accepts the message session. The terminating CUA reserves an IP-CAN bearer for the message session media component. + +#### **8. Reliable exchange of SDP** + +SDP is conveyed between CUA#1 and CUA#2. The mechanism for this is not relevant for the example and is not described. + +#### **9. 200 (OK) response (CUA#2 to P-CSCF#2) – see example in table B.3.2-9** + +After reserving an IP-CAN bearer for the message session media component the terminating CUA sends a 200 (OK) response for the INVITE request containing SDP that indicates that the terminating CUA has accepted the message session and listens on the MSRP TCP port returned in the path attribute in the answer for a TCP SETUP from the originating CUA. + +CUA#2 declares support only for CS-voice, not CS-video in its Contact header. The terminating CUA includes its personal ME identifier and UE capability version in the Server header. + +**Table B.3.2-9: 200 (OK) response (CUA#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: gruu +Contact: ,+g.3gpp.cs-voice +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Server: PMI-0EA2, UCV-0D +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=message 3402 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim +a=path:msrp://[5555::eee:fff:aaa:bbb]:3402/s234167/tcp +a=max-size:65536 + +``` + +**SDP** The SDP contains the set of offered content types supported by CUA#2 and desired by the user at CUA#2 for this session in the accept-types attribute and indicates the maximum size message that can be received by CUA#2 in the max-size attribute. + +#### 10. 200 (OK) response (P-CSCF#1 to CUA#1) – see example in table B.3.2-10 + +P-CSCF#1 forwards the 200 (OK) response to the originating CUA. + +**Table B.3.2-10: 200 (OK) response (P-CSCF#1 to CUA#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Server: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +a= + +``` + +**P-Asserted-Identity:** This header field is added by the intermediate IM CN subsystem entities in accordance with 3GPP TS 24.229 [5]. + +#### 11. ACK request (CUA#1 to P-CSCF#1) – see example in table B.3.2-11 + +The CUA responds to the 200 (OK) response with an ACK request sent to the P-CSCF#1. + +**Table B.3.2-11: ACK request (CUA#1 to P-CSCF#1)** + +``` + +ACK sip: user2_public1@home2.net;gr=urn:uuid:2ad8950e-48a5-4a74-8d99-ad76cc7fc74 +;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , , + , +From: ;tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 + +``` + +#### 12. Reserve IP-CAN bearer for media + +The originating CUA reserves an IP-CAN bearer for the message session media component. + +#### 13. ACK request (P-CSCF#2 to CUA#2) – see example in table B.3.2-13. + +P-CSCF#2 forwards the ACK request to the terminating CUA. + +**Table B.3.2-13: ACK request (P-CSCF#2 to CUA#2)** + +``` + +ACK sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +#### **14. Establishment of the MSRP session** + +The CUAs will establish the MSRP session as described in subclause A.3 of 3GPP TS 24.247 [10]. + +#### **15. Media exchange in PS domain** + +The CUAs will transfer media over the PS domain. + +#### **16. Initiation of CS call establishment with SETUP from originating side (from CUA#1 to MSC#1)** + +CUA#1 starts the CS call towards CUA#2 sending out the SETUP. + +Specifically for CSI, the SETUP message includes:- + +- Called Party Number = [(Numbering plan identifier = ISDN/telephony numbering plan), +(type of number = international number), (Number digits = 121255522222)] +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), +(IM Status = IM subsystem registered), (Personal ME Identifier = 0007), (UE capability version = 04)]. + +CUA#1 ensures that the Personal ME Identifier within the User-User IE of the SETUP correlates to the Personal ME Identifier used by CUA#1 in the preceding IM session. + +#### **17. CALL PROCEEDING (MSC#1 to CUA#1)** + +MSC#1 after call processing checks replies to CUA#1 with Call Proceeding. + +MSC#1 progresses the CS Call by contacting MSC#2. Intermediate CS entities could be involved. + +The User-User information provided by CUA#1 is forwarded by MSC#1 towards MSC#2. + +There is no specific CSI information in CALL\_PROCEEDING. + +#### **18. Initiation of CS terminating call with SETUP towards called party (from MSC#2 to CUA#2)** + +MSC#2 starts the terminating call by initiating SETUP to CUA#2. + +Specifically for CSI, the SETUP message includes :- + +- Called Party Number = [(type of number = international number ), +(Numbering plan identifier = ISDN/telephony numbering plan), (Number digits = 121255522222)] +- Calling Party Number = [(presentation indicator = Presentation allowed), +(screening indicator = Network provided), (type of number = international number ), +(Numbering plan identifier = ISDN/telephony numbering plan), (Number digits = 121255511111)] +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), +(IM Status = IM subsystem registered), (Personal ME Identifier = 0007), (UE capability version = 04)]. + +The Personal ME Identifier provided by CUA#1 is used by CUA#2 to relate to the appropriate remote terminal having the parallel IM session. The UE capability version provided by CUA#1 is used by CUA#2 to check whether the terminal capabilities of CUA#1 are already known by CUA#2. + +#### **19. CALL CONFIRM indicating terminating CS Call is being processed (from CUA#2 to MSC#2)** + +CUA#2 on accepting the terminating call for further processing respond to MSC#2 with CALL\_CONFIRM. There is no specific CSI information in CALL\_CONFIRM. + +#### 20. Allocation of user plane resources + +MSC#2 initiate provision of user plane resources. In this example call flow, this allocation takes place at this instance in time, but the network can opt to allocate resources after message 24 but certainly completes the allocation before message 25. + +There are no CSI specifics. + +#### 21. ALERTING indicating end user is alerted, (from CUA#2 to MSC#2) + +When alerting towards the end user is started (ie. end user ringing) CUA#2 indicates that the call has been delivered by sending ALERTING to MSC#2. + +There are no CSI specifics in this message; in particular, User-User Information Element is not provided. + +#### 22. Originating NW allocates user plane resources + +When MSC#2 receives ALERTING (see previous message 21), MSC#2 conveys this through Intermediate CS entities to MSC#1. Knowing that the call has delivered to far end user, MSC#1 initiates allocation of user plane resources to originating CUA#1. + +MSC#1 could have opt to allocate user plane resources to CUA#1 much earlier in the messaging sequence (eg. after CALL\_PROCEEDING) or MSC#1 could allocate user plane resource much later eg. just before sending of message 26. + +This example flow chooses to indicate user plane resources being allocated at this point in time. + +#### 23. ALERTING indicating far end alerting has started (from MSC#1 to CUA#1) + +MSC#1 sends to CUA#1 ALERTING indicating that the far end user is being alerted. This indication together with available user plane resource allow for ring tone to be provided to the originating user by the network. If the network had opted not to allocate user plane resources, then this ALERTING will allow the CUA#1 to generate local indications to the user that the call has been delivered to the far end user. + +#### 24. CONNECT - far end user answers the call (from CUA#2 to MSC#2) + +When the user answers the call, CUA#2 sends CONNECT to MSC#2. + +Specifically for CSI, the CONNECT message includes:- + +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), (IM Status = IM subsystem registered), (Personal ME Identifier = 0EA2), (UE capability version = 0D)]. + +CUA#2 provides its Personal ME Identifier and UE capability version within the User-User IE. This Personal ME Identifier and UE capability version is the same as that provided by CUA#2 in 200 OK (message step 9) of the IM session. + +CUA#2 sending CONNECT starts connecting to the user plane resources. + +#### 25. CONNECT ACKNOWLEDGE (from MSC#2 to CUA#2) + +Upon getting CONNECT, MSC#2 starts through connecting the call from the far end through the intermediate CS entities to MSC#1. MSC#2 indicates this by sending CONNECT\_ACKNOWLEDGE to CUA#2 and thus allowing CUA#2 to progress to active call state. + +MSC#2 conveys call acceptance to MSC#1 forwarding any User-User information to MSC#1 that is included in the CONNECT from CUA#2. + +#### 26. CONNECT – far end has answered the call (from MSC#1 to CUA#1) + +MSC#1 indicates far end has answered the terminating call by sending CONNECT to CUA#1. MSC#1 having through connected the call on the network side now awaits CUA#1 to connect to the allocated user plane resources. + +Specifically for CSI, the CONNECT message includes: + +- Connected Number = [(presentation indicator = Presentation allowed), (screening indicator = Network provided), (type of number = international number), (Numbering plan identifier = ISDN/telephony numbering plan), (Number digits = 12125552222)] + +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), (IM Status = IM subsystem registered), (Personal ME Identifier = 0EA2), (UE capability version = 0D)]. + +The Personal ME Identifier provided by CUA#2 is used by CUA#1 to relate to the appropriate remote terminal having the parallel IM session. The UE capability version provided by CUA#2 is used by CUA#1 to check whether the terminal capabilities of CUA#2 are already known by CUA#1. + +#### 27. CONNECT ACKNOWLEDGE (from CUA#1 to MSC#1) + +CUA#1 receiving CONNECT and with available user plane through connects the call and return CONNECT\_ACKNOWLEDGE to MSC#1. The CONNECT ACKNOWLEDGE allows the network to progress to active call state. There are no CSI specifics in CONNECT ACKNOWLEDGE + +#### 28. CS Call takes place + +The CS call takes place. + +## --- B.4 Signalling flows demonstrating CSI session setup when a CS call is already established + +### B.4.1 Introduction + +This subclause provides signalling flows for CSI session setup, using video session as an example of the IM session, established after any CS call has been established. + +The flows show some additions related to CSI. The CUA includes the media feature tags g.3gpp.cs-voice and g.3gpp.cs-video in the Accept-Contact header and in the Contact header. The User Agent and Server Header carries the personal ME identifier. + +### B.4.2 Establishing a CSI session when CS call has been setup + +Figure B.4.2-1 shows the establishment of video session between two users. A CS call is established before the video session is established. + +It is assumed that both the originating CUA and terminating CUA are using an IP-CAN with a separate bearer for SIP signalling which means that each CUA needs to provide resource reservation before starting the video session. + +![Diagram showing a box labeled CUA#1 with a vertical line extending downwards and four horizontal lines branching off to the right, resembling a tree structure. The entire diagram is enclosed in a dashed rectangular border.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +The diagram consists of a rectangular box at the top containing the text "CUA#1". A solid vertical line descends from the bottom center of this box. From this vertical line, four horizontal lines branch out to the right. Each horizontal line is preceded by a chevron shape (a 'V' pointing to the right) that is attached to the vertical line, suggesting a sequence of four items or steps originating from the "CUA#1" box. The entire structure is enclosed within a dashed rectangular border. + +Diagram showing a box labeled CUA#1 with a vertical line extending downwards and four horizontal lines branching off to the right, resembling a tree structure. The entire diagram is enclosed in a dashed rectangular border. + +Figure B.4.2-1: Establishment of a video session after a CS call is established + +The details of the signalling flows are as follows: + +#### 1. CS call + +A CS call setup is performed according to subclause B.5. + +#### 2. UE capabilities exchange + +Both UEs have performed a capability exchange. In the here shown example both UEs transfer their UE capability version and personal ME identifier as a part of the capability exchange. An example for capability exchange without the usage of UE capability version and personal ME identifier can be found in subclause B.6. + +#### 3. INVITE request (CUA#1 to P-CSCF#1) - see example in table B.4.2-2 + +CUA#1 wants to initiate a session with the terminating CUA. In this example, the CUA#1 creates a video session as the IM session. CUA#1 includes the "precondition" and "100rel" options tag in the supported header. + +CUA#1 indicates, using the SDP Capability Negotiation mechanism, that it supports and is willing to use AVPF transport for the video stream and the audio stream. + +CUA#1 indicates that it supports precondition and it indicates that it supports reliable provisional responses. However, it does not use the "Require" header for these capabilities. + +CUA#1 does not have available the resources that are necessary to transport the media. + +For this example it is assumed, that signalling encryption was negotiated between CUA#1 and P-CSCF in the security mode set-up procedure during the last successful authentication. This option will only be shown in this example. + +CUA#1 declares its capabilities for CS-voice and CS-video, and requests to reach a UE with CS-voice or CS-video capabilities by including these media feature tags in the Accept-contact header and includes its personal ME identifier and UE capability version in User-Agent header. + +**Table B.4.2-2: INVITE request (CUA#1 to P-CSCF#1)** + +``` + +INVITE tel:+12125552222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Supported: precondition, 100rel, gruu +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: ,+g.3gpp.cs-voice;+g.3gpp.cs-video +Accept-Contact: *,+g.3gpp.cs-voice, +g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Accept:application/sdp, application/3gpp-ims+xml +User-Agent: PMI-0007, UCV-04 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 49232 RTP/AVP 107 +a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 + +``` + +``` + +b=AS:64.0 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:107 H263/90000 +a=fmtp 107 profile=0 level=45 + +``` + +**SDP**               The SDP contains the video codec supported by CUA#1 and desired by the user at CUA#1 for this session. The precondition attributes are also included. + +#### **4. 100 (Trying) response (P-CSCF#1 to CUA#1)** + +The P-CSCF responds to the INVITE request with a 100 (Trying) provisional response as described in subclause A.3 of 3GPP TS 24.247 [10]. + +#### **5. Reserve IP CAN bearer for media** + +CUA#1 starts resource reservation based on the SDP. + +#### **6a. User-Agent (P-CSCF#1 to P-CSCF#2)** + +The User-Agent header field is transparently passed from P-CSCF#1 to P-CSCF#2. + +#### **6b. INVITE request (S-CSCF#1 to I-CSCF#2) - see example in table B.4.2-3** + +S-CSCF#1 forwards the INVITE request to the I-CSCF#2, after replacing the tel URI with a SIP-URI in the Request URI. + +**Table B.4.2-3: INVITE request (S-CSCF#1 to I-CSCF#2)** + +``` + +INVITE sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Route: , +Record-Route: , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Accept-Contact: +Allow: +Accept: +User-Agent: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +b= +a= +a= +a= +a= +a= +a= +a= + +``` + +#### **7. INVITE request (P-CSCF#2 to CUA#2) – see example in table B.4.2-4** + +P-CSCF#2 forwards the INVITE request to the terminating CUA. + +**Table B.4.2-4: INVITE request (P-CSCF#2 to CUA#2)** + +``` + +INVITE sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp>,+g.3gpp.cs-voice +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 65 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Contact: +Accept-Contact: +Allow: +Accept: +User-Agent: +P-Called-Party-ID: +Content-Type: +Content-Length:(...) + +v= +o= +s= +c= +t= +m= +a= +a= +b= +a= +a= +a= +a= +a= +a= +a= + +``` + +#### **8. 100 (Trying) response (CUA#2 to P-CSCF#2)** + +The terminating CUA sends a 100 (Trying) provisional response to P-CSCF#2 as described in subclause A.3 of 3GPP TS 24.247 [10]. + +#### **9. Reserve IP-CAN bearer for media** + +The terminating CUA sets up the bearer in accordance with the received SDP.. + +#### **10. 183 (session progress) response (CUA#2 to P-CSCF#2) – see example in table B.4.2-5** + +CUA#2 declares support for "CS-voice" and "CS-video" in its Contact header. The CUA includes the personal ME identifier and the UE capability version in the Server header. CUA#2 requires resource reservation and supports the precondition mechanism. + +**Table B.4.2-5: 183 (session progress) response (CUA#2 to P-CSCF#2)** + +``` + +SIP/2.0 183 Session progress +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , +, +Privacy: none +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Contact: ,+g.3gpp.cs-voice,+g.3gpp.cs-video +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Require: 100rel, precondition +Supported: gruu +Server: PMI-0EA2, UCV-0D +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 49234 RTP/AVPF 107 +a=acfg:1 t=1 +b=AS:64.0 +a=curr:qos remote none +a=curr:qos local none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=conf:qos remote sendrecv +a=inactive +a=rtpmap:107 H263/90000 +a=fmtp 107 profile=0 level=45 + +``` + +11. 183 (session progress) response (P-CSCF#1 to CUA#1 ) – see example in table B.4.2-6 + +**Table B.4.2-6: 183 (session progress) response (P-CSCF#1 to CUA#1 )** + +``` +SIP/2.0 183 Session progress +Via: [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +Privacy: +From: +To: +Call-ID: +Cseq: +RSeq: +P-Asserted-Identity:< user2_public1@home2.net>, < tel:+12125552222> +Contact: +Allow: +Require: +Supported: +Server: +Content-Type: +Content-Length: + +v=0 +o=- +s=- +c= +t= +m= +a= +b= +a= +a= +a= +a= +a= +a= +a= +a= +``` + +#### 12. PRACK-200 Exchange + +#### 13. IP-CAN bearer available for media + +The IP-CAN bearer at CUA#1 is established. + +#### 14. IP-CAN bearer available for media. + +The IP-CAN bearer at CUA#2 is established. + +#### 15. UPDATE request (CUA#1 to P-CSCF#1 ) – see example in table B.4.2-7 + +CUA#1 indicates that it can send and receive media. + +**Table B.4.2-7: UPDATE request (CUA#1 to P-CSCF#1 )** + +``` + +UPDATE +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +From: ; tag=171828 +To: tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi=87654321; port1=7531 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=video 49232 RTP/AVPF 107 +b=AS:64.0 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=sendrecv +a=rtpmap:107 H263/90000 +a=fmtp 107 profile=0 level=45 + +``` + +#### **16. UPDATE request (P-CSCF#2 to CUA#2 ) – see example in table B.4.2-8** + +The CUA#2 can start alerting. + +**Table B.4.2-8: UPDATE request (P-CSCF#2 to CUA#2)** + +``` + +UPDATE +Via: : SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, +SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= + +``` + +#### **17. 200 (OK) response (CUA#2 to P-CSCF#2) – see example in table B.4.2-9** + +CUA 2 indicates that media can be received and sent. + +**Table B.4.2-9: 200(OK) response (CUA#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 129 UPDATE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=video 49234 RTP/AVPF 107 +b=AS:64.0 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos mandatory remote sendrecv +a=sendrecv +a=rtpmap:107 H263/90000 +a=fmtp 107 profile=0 level=45 + +``` + +#### **18. 200 (OK) response (P-CSCF#1 to CUA#1) – see example in table B.4.2-10** + +**Table B.4.2-10: 200(OK) response (P-CSCF#1 to CUA#1)** + +``` + +SIP/2.0 200 OK +Via: [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +From: +To: +Call-ID: +Cseq: +Content-Type: +Content-Length: + +v=0 +o=- +s=- +c= +t= +m= +b= +a= +a= +a= +a= +a= +a= +a= + +``` + +#### **19. 200 (OK) response (CUA#2 to P-CSCF#2) – see example in table B.4.2-11** + +CUA#2 accepts the session. + +**Table B.4.2-11: 200 (OK) response (CUA#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871y12.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Privacy: none +From: ; tag=171828 +To: ;tag=314159;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Contact: ,+g.3gpp.cs-voice, +g.3gpp.cs-video +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Server: PMI-0EA2, UCV-0D +Content-Length: 0 + +``` + +#### **20. 200 (OK) response (P-CSCF#1 to CUA#1) – see example in table B.4.2-12** + +P-CSCF#1 forwards the 200 (OK) response to the originating CUA. + +**Table B.4.2-12: 200 (OK) response (P-CSCF#1 to CUA#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +P-Asserted-Identity: < user2_public1@home2.net>, < tel:+12125552222> +Privacy: +From: +To: +Call-ID: +CSeq: +Require: +Contact: +Allow: +Server: +Content-Length: + +``` + +#### **21. ACK request (CUA#1 to P-CSCF#1) – see example in table B.4.2-13** + +The CUA responds to the 200 (OK) response with an ACK request sent to the P-CSCF#1. + +**Table B.4.2-13: ACK request (CUA#1 to P-CSCF#1)** + +``` + +ACK sip: ; +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Route: , , + , +From: ;tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 ACK +Content-Length: 0 + +``` + +#### **22. ACK request (P-CSCF#2 to CUA#2) – see example in table B.3.2-14.** + +P-CSCF#2 forwards the ACK request to the terminating CUA. + +**Table B.3.2-14: ACK request (P-CSCF#2 to CUA#2)** + +``` + +ACK sip: +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +scscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +From: +To: +Call-ID: +Cseq: +Content-Length: + +``` + +## B.5 Signalling flows demonstrating capability information exchange in a CS call (only) + +### B.5.1 Introduction + +This subclause provides signalling flows for exchange of information relevant for CSI in a CS call only. + +### B.5.2 Establishing a CS call from a CSI capable UE + +Figure B.5.2-1 shows the exchange of Radio Environment information, the IM Status, UE capability version and Personal ME Identifier by the CUAs of a CSI capable UE during a normal CS call establishment. + +![Sequence diagram of CS call establishment showing late assignment of user plane resources.](30a91d1c3ead5af4823f4f3330e4ac1e_img.jpg) + +``` + +sequenceDiagram + participant CUA#1 + participant IMCN as Intermediate IM CN subsystem entities + participant CS as Intermediate CS entities + participant CUA#2 + + Note right of CS: 8. Late Assignment of User Plane Resources + Note left of IMCN: 10. Late Assignment of User Plane Resources + + CUA#1->>CS: 1. SETUP + CS-->>CUA#1: 2. CALL PROCEEDING + CS->>CUA#2: 3. SETUP + CUA#2-->>CS: 4. CALL CONFIRM + CS-->>CUA#1: 6. ALERTING + CS-->>CUA#2: 5. ALERTING + CS-->>CUA#2: 7. CONNECT + Note right of CS: 8. Late Assignment of User Plane Resources + CS-->>CUA#2: 9. CONNECT ACKNOWLEDGE + Note left of IMCN: 10. Late Assignment of User Plane Resources + CUA#1-->>CS: 11. CONNECT + CS-->>CUA#1: 12. CONNECT ACKNOWLEDGE + Note right of CS: 13. Active Call in CS domain + CUA#1-->>CUA#2: 13. Active Call in CS domain + +``` + +The diagram illustrates the signalling flow for establishing a CS call with late assignment of user plane resources. It involves four main entities: CUA#1, Intermediate IM CN subsystem entities, Intermediate CS entities, and CUA#2. The sequence of messages is as follows: 1. SETUP from CUA#1 to Intermediate CS entities; 2. CALL PROCEEDING from Intermediate CS entities to CUA#1; 3. SETUP from Intermediate CS entities to CUA#2; 4. CALL CONFIRM from CUA#2 to Intermediate CS entities; 6. ALERTING from Intermediate CS entities to CUA#1; 5. ALERTING from Intermediate CS entities to CUA#2; 7. CONNECT from Intermediate CS entities to CUA#2; 8. Late Assignment of User Plane Resources (indicated by a note on the CS entity side); 9. CONNECT ACKNOWLEDGE from Intermediate CS entities to CUA#2; 10. Late Assignment of User Plane Resources (indicated by a note on the IM CN entity side); 11. CONNECT from CUA#1 to Intermediate CS entities; 12. CONNECT ACKNOWLEDGE from Intermediate CS entities to CUA#1; and finally, 13. Active Call in CS domain, represented by a dashed line between CUA#1 and CUA#2. + +Sequence diagram of CS call establishment showing late assignment of user plane resources. + +**Figure B.5.2-1: CS call establishment (example of late assignment of user plane resources)** + +The details of the signalling flows are as follows:- + +#### **1. Initiation of CS call establishment with SETUP from originating side (from CUA#1 to MSC#1)** + +CUA#1 starts the CS call towards CUA#2 sending out the SETUP. + +Specifically for CSI, the SETUP message includes:- + +- Called Party Number = [(Numbering plan identifier = ISDN/telephony numbering plan), +(type of number = international number ), (Number digits = 12125552222)] +- User-User IE = [(Protocol ID =3GPP capability exchange protocol), (Radio Environment = 1), +(IM Status = IM subsystem capable and willing to register to IM subsystem), +(Personal ME Identifier = 0007), (UE capability version = 04)]. + +#### **2. CALL PROCEEDING (MSC#1 to CUA#1)** + +MSC#1 after call processing checks replies to CUA#1 with CALL\_PROCEEDING. + +MSC#1 progress with the CS Call by contacting MSC#2. Intermediate CS entities could be involved. + +The User-User information provided by CUA#1 is forwarded by MSC#1 towards MSC#2. + +There is no specific CSI information in CALL\_PROCEEDING. + +#### **3. Initiation of CS terminating call with SETUP towards called party (from MSC#2 to CUA#2)** + +MSC#2 starts the terminating call by initiating SETUP to CUA#2. + +Specifically for CSI, the SETUP message includes:- + +- Called Party Number = [(type of number = international number ), +(Numbering plan identifier = ISDN/telephony numbering plan), (Number digits = 12125552222)] +- Calling Party Number = [(presentation indicator = Presentation allowed), +(screening indicator = Network provided), (type of number = international number ), +(Numbering plan identifier = ISDN/telephony numbering plan), (Number digits = 12125551111)] +- User-User IE = [(Protocol ID =3GPP capability exchange protocol), (Radio Environment = 1), +(IM Status = IM subsystem capable and willing to register to IM subsystem), +(Personal ME Identifier = 0007), (UE capability version = 04)]. + +The Personal ME Identifier provided by CUA#1 is later used by CUA#2 to relate to a particular terminal of CUA#1 that initiated this CS call is later progressed to a CSI call. + +#### **4. CALL CONFIRM indicating terminating CS Call is being processed (from CUA#2 to MSC#2)** + +CUA#2 on accepting the terminating call for further processing respond to MSC#2 with CALL\_CONFIRM. + +There is no specific CSI information in CALL\_CONFIRM. + +#### **5. ALERTING indicating end user is alerted, (from CUA#2 to MSC#2)** + +CUA#2 indicates locally to the user that a call has arrived by starting local alerting. With the call delivered, + +CUA#2 sends ALERTING to MSC#2. + +There are no CSI specifics in this message; in particular, there is no inclusion of User-User Information Element. + +NOTE: This example flow has taken to illustrate local alerting by CUA#2. This is the case if in the SETUP MSC#2 allows this to be done, as MSC intends to do a late assignment of user plane resources. + +#### **6. ALERTING indicating far end alerting has started (from MSC#1 to CUA#1)** + +Through Intermediate CS entities, MSC#2 informs MSC#1 that the call has been delivered. + +MSC#1 sends to CUA#1 ALERTING indicating that call has been delivered and far end user is being alerted. + +Only local indication of call delivery can be provided by CUA#1 to the user (ie. ringing tone) as user plane resources have yet to be assigned by MSC#1. + +There are no CSI specifics in this message. + +#### **7. CONNECT - far end user answers the call (from CUA#2 to MSC#2)** + +When the user answers the call, CUA#2 sends CONNECT to MSC#2. + +Specifically for CSI, the CONNECT message includes:- + +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), +(IM Status = IM subsystem capable and willing to register to IM subsystem), +(Personal ME Identifier = 0EA2), (UE capability version = 0D)]. + +After sending the CONNECT, CUA#2 is ready to connect to user plane resources and does the instance user plane resources is allocated. + +MSC#2 conveys call answer to MSC#1 and forwards any User-User information to MSC#1 that is included in the CONNECT from CUA#2. + +The provision of the Personal ME Identifier is to allow CUA#2 and CUA#1 to bind this CS Call answered by a particular terminal of CUA#2 to any eventual associated IM session to progress this CS call to a CSI call. + +#### 8. Allocation of user plane resources + +MSC#2 has to allocate user plane resources to CUA#2 to allow speech to take place. In this example, this is the very latest point in time that MSC#2 can allocate such resources. This is referred to as Late Assignment. With the completion of the user plane resources, CUA#2 connects up and speech begins. + +#### 9. CONNECT ACKNOWLEDGE (from MSC#2 to CUA#2) + +Upon completing Late Assignment, MSC#2 starts through connecting the call all the way from CUA#2 to the far end through the Intermediate CS Entities to MSC#1. + +MSC#2 indicates this by sending CONNECT\_ACKNOWLEDGE to CUA#2 and thus allowing CUA#2 to progress to active call state. + +#### 10. Originating NW allocates user plane resources + +Knowing that the call has been answered, MSC#1 initiates allocation of user plane resources to originating CUA#1. + +In this example, this is the latest point in time that MSC#1 can assign the user plane resources for speech to take place. + +#### 11. CONNECT (from MSC#1 to CUA#1) + +MSC#1 indicates far end has answered the terminating call by sending CONNECT to CUA#1. MSC#1 through connects the call on the network side and awaits CUA#1 to connect to the allocated user plane resources. + +Specifically for CSI, the CONNECT message includes: + +- Connected Number = [(presentation indicator = Presentation allowed), +(screening indicator = Network provided), (type of number = international number), +(Numbering plan identifier = ISDN/telephony numbering plan), (Number digits = 12125552222)] +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), +(IM Status = IM subsystem capable and willing to register to IM subsystem), +(Personal ME Identifier = 0EA2), (UE capability version = 0D)]. + +#### 12. CONNECT ACKNOWLEDGE (from CUA#1 to MSC#1) + +CUA#1 receiving CONNECT and with available user plane through connects the call and return CONNECT\_ACKNOWLEDGE to MSC#1. The CONNECT ACKNOWLEDGE is to allow the network to progress to active call state. The CONNECT ACKNOWLEDGE does not have any CSI specifics. + +#### 13. CS Call takes place + +The CS call takes place. + +## --- B.6 Signalling flows demonstrating UE capability exchange with no UE capability version + +### B.6.1 Introduction + +This subclause provides signalling flows for UE capability exchange with no UE capability version and no personal ME identifier outside a CS call or when a CS call is already in progress. + +### B.6.2 UE capability exchange outside a CS call + +Figure B.6.2-1 shows the UE capability exchange using the OPTIONS method. + +![Sequence diagram showing UE capability exchange before any CS call is established. Lifelines: CUA#1, Intermediate IM CN subsystem entities, Intermediate CS entities, CUA#2. The process involves OPTIONS and 200 OK messages between CUA#1 and CUA#2 via the intermediate entities, with caching of address information at each CUA.](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +``` +sequenceDiagram + participant CUA#1 + participant IMCN as Intermediate IM CN subsystem entities + participant CS as Intermediate CS entities + participant CUA#2 + + Note right of IMCN: 2. OPTIONS request S-CSCF -> I-CSCF + Note right of IMCN: 3. Routing decisions within S-CSCF#2 + Note right of CUA#2: 5. Cache address information + Note right of CUA#1: 8. Cache address information + Note right of IMCN: 10. OPTIONS request S-CSCF -> I-CSCF + Note right of IMCN: 11. Routing decisions within S-CSCF#1 + Note right of CUA#1: 13. Cache address information + Note right of CUA#2: 16. Cache address information + + CUA#1->>IMCN: 1. OPTIONS + IMCN->>CS: 2. OPTIONS request S-CSCF -> I-CSCF + CS->>CUA#2: 4. OPTIONS + CUA#2->>CS: 6. 200 OK + CS->>CUA#1: 7. 200 OK + CUA#1->>CUA#2: 9. OPTIONS + IMCN->>CS: 10. OPTIONS request S-CSCF -> I-CSCF + CS->>CUA#1: 12. OPTIONS + CUA#1->>IMCN: 14. 200 OK + IMCN->>CUA#2: 15. 200 OK + CUA#1->>CUA#2: 17. CS Call Setup +``` + +Sequence diagram showing UE capability exchange before any CS call is established. Lifelines: CUA#1, Intermediate IM CN subsystem entities, Intermediate CS entities, CUA#2. The process involves OPTIONS and 200 OK messages between CUA#1 and CUA#2 via the intermediate entities, with caching of address information at each CUA. + +**Figure B.6.2-1: UE capability exchange before any CS call is established** + +The details of the signalling flows are as follows: + +#### 1. OPTIONS request (CUA#1 to P-CSCF#1) - see example in table B.6.2-1 + +The originating CUA wants to know the capabilities of the terminating UE, preferably a UE that supports CS-voice and CS-video, or one or the other. + +**Table B.6.2-1: OPTIONS request (CUA#1 to P-CSCF#1)** + +``` +OPTIONS tel:+12125552222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 OPTIONS +Require: sec-agree +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Accept-Contact: *,+g.3gpp.cs-voice,+g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Accept: application/sdp +Content-Length: 0 +``` + +#### 2. OPTIONS request (S-CSCF#1 to I-CSCF#2) - see example in table B.6.2-2 + +S-CSCF#1 forwards the OPTIONS request to the I-CSCF#2, after mapping the tel URI to a SIP-URI. + +**Table B.6.2-2: OPTIONS request (S-CSCF#1 to I-CSCF#2)** + +``` +OPTIONS sip:user2_public1@home2.net SIP/2.0 +Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; orig-ioi=home1.net +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Accept-Contact: +Allow: +Accept: +Content-Length: 0 +``` + +#### 3. Routing decision based on caller preferences and callee capabilities + +The S-CSCF for CUA#2 uses caller preferences (information from the Accept-Contact header) and callee capabilities (information stored in the Registrar from the REGISTER Contact header) information to decide how to route the OPTIONS request. + +#### 4. OPTIONS request (P-CSCF#2 to CUA#2) – see example in table B.6.2-4 + +P-CSCF#2 forwards the OPTIONS request to the terminating CUA. + +**Table B.6.2-4: OPTIONS request (P-CSCF#2 to CUA#2)** + +``` + +OPTIONS sip:[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 65 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Accept-Contact: +Allow: +Accept: +Content-Length: 0 +P-Called-Party-ID: + +``` + +#### 5. Save CUA#1's address, prepare 200 OK response + +The terminating CUA caches any address related information it learns about CUA#1 from the OPTIONS request, such as its SIP URI. The terminating CUA adds feature parameters to the Contact header field in the OPTIONS response indicating its capabilities. The feature parameters that were included in the registration generated by the terminating CUA are used in the OPTIONS response. + +#### 6. 200 (OK) response (CUA#2 to P-CSCF#2) – see example in table B.6.2-6 + +The terminating CUA sends a 200 (OK) response for the OPTIONS request containing the terminating CUA's capabilities. This information is declared both in the media feature tags listed in the Contact header and in the SDP. In this example, CUA#2 declares capability for cs-voice, but not cs-video, and it declares support for MSRP, RTP video (H.263) and RTP audio (AMR). + +**Table B.6.2-6: 200 (OK) response (CUA#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP + icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP + scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP + pscsf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=123451D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 OPTIONS +Supported: gruu, preconditions, 100rel +Contact: ,+g.3gpp.cs-voice, +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s=- +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=message 0 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim image/jpeg image/gif video/3gpp +a=max-size:65536 +m=video 0 RTP/AVP 96 +a=rtpmap:96 H263-2000/90000 +m=audio 0 RTP/AVP 97 +a=rtpmap:97 AMR/8000 +m=video 0 RTP/AVPF 96 +a=rtpmap:96 H263-2000/90000 +m=audio 0 RTP/AVPF 97 +a=rtpmap:97 AMR/8000 + +``` + +**SDP**                      The SDP contains: + +- The set of offered content types supported by UE#2 and desired by the user at UE#2 for an MSRP session in the accept-types attribute and indicates the maximum size message that can be received by UE#2 in the max-size attribute (no dynamically allocated attributes are included, for example, the a=path line is not there); +- The supported video codec and relevant parameters (but no dynamically allocated parameters); +- The supported audio codec and relevant parameters (but no dynamically allocated parameters). + +No ports are declared since UE capabilities are just being listed. + +#### 7. 200 (OK) response (P-CSCF#1 to CUA#1) – see example in table B.6.2-7 + +P-CSCF#1 forwards the 200 (OK) response to the originating CUA. + +**Table B.6.2-7: 200 (OK) response (P-CSCF#1 to CUA#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +m= +a= +m= +a= +m= +a= +m= +a= + +``` + +#### **8. Cache information on CUA#2's capabilities** + +Since no CS call is ongoing, cache the information obtained on CUA#2's capabilities for later use within a CS call. + +#### **9. OPTIONS request (CUA#2 to P-CSCF#2) - see example in table B.6.2-9** + +The originating CUA wants to know the capabilities of the terminating UE, preferably a UE that supports cs-voice and cs-video, or one or the other. + +**Table B.6.2-9: OPTIONS request (CUA#2 to P-CSCF#2)** + +``` + +OPTIONS tel:+12125551111 SIP/2.0 +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=af45K329jstd43 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=123451D0FCE11 +Privacy: none +From: ; tag=1912031 +To: +Call-ID: ast324c2ho9512go9238ks4b +Cseq: 127 OPTIONS +Require: sec-agree +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=23456789; spi-s=12345678; + port-c=8318; port-s=7743 +Accept-Contact: *,+g.3gpp.cs-voice,+g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Accept: application/sdp +Content-Length: 0 + +``` + +#### **10. OPTIONS request (S-CSCF#2 to I-CSCF#1) - see example in table B.6.2-10** + +S-CSCF#2 forwards the OPTIONS request to the I-CSCF#1, after mapping the tel URI to a SIP-URI. + +**Table B.6.2-10: OPTIONS request (S-CSCF#2 to I-CSCF#1)** + +``` + +OPTIONS sip:user1_public1@home1.net SIP/2.0 +Via: SIP/2.0/UDP scscf2.home2.net;branch= af45K329jsg213, SIP/2.0/UDP + pcscf2.visited2.net;branch= af45K329jsbbb2, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch= af45K329jstd43 +Max-Forwards: 68 +Record-Route: , +P-Asserted-Identity: +P-Charging-Vector: icid-value="H7a2rvdguTd6eYt7br=ac?+g5468HdrrdRf54b"; orig-iei=home2.net +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Accept-Contact: +Allow: +Accept: +Content-Length: 0 + +``` + +#### **11. Routing decision based on caller preferences and callee capabilities** + +The S-CSCF for CUA#1 uses caller preferences (information from the Accept-Contact header) and callee capabilities (information stored in the Registrar from the REGISTER Contact header) information to decide how to route the OPTIONS request. + +#### **12. OPTIONS request (P-CSCF#1 to CUA#1) – see example in table B.6.2-12** + +P-CSCF#1 forwards the OPTIONS request to the terminating CUA. + +**Table B.6.2-12: OPTIONS request (P-CSCF#1 to CUA#1)** + +``` + +OPTIONS sip:[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp SIP/2.0 +Via: SIP/2.0/UDP pcscf1.visited1.net:6809;comp=sigcomp;branch= af45K329jsgfff, SIP/2.0/UDP + scscf1.home1.net;branch= af45K329js1234, SIP/2.0/UDP icscf1_s.home1.net;branch= + af45K329jsskit, SIP/2.0/UDP scscf2.home2.net;branch= af45K329jsg213, SIP/2.0/UDP + pcscf2.visited2.net;branch= af45K329jsbbb2, SIP/2.0/UDP + [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch= af45K329jstd43 +Max-Forwards: 65 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +Cseq: +Supported: +Accept-Contact: +Allow: +Accept: +Content-Length: 0 +P-Called-Party-ID: + +``` + +#### **13. Save CUA#1's address, prepare 200 OK response** + +The terminating CUA caches any address related information it learns about CUA#2 from the OPTIONS request, such as its SIP URI. The terminating CUA adds feature parameters to the Contact header field in the OPTIONS response indicating its capabilities. The feature parameters that were included in the registration generated by the terminating CUA are used in the OPTIONS response. + +#### **14. 200 (OK) response (CUA#1 to P-CSCF#1) – see example in table B.6.2-14** + +The originating CUA sends a 200 (OK) response for the OPTIONS request containing the originating CUA's capabilities. This information is declared both in the media feature tags listed in the Contact header and in the SDP. In this example, CUA#1 declares capability for cs-voice and cs-video, and it declares support for MSRP, RTP video (H.263) and RTP audio (AMR). + +**Table B.6.2-14: 200 (OK) response (CUA#1 to P-CSCF#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf1.visited1.net:6809;comp=sigcomp;branch= af45K329jsgfff, SIP/2.0/UDP +scscf1.home1.net;branch= af45K329js1234, SIP/2.0/UDP icscf1_s.home1.net;branch= +af45K329jsskit, SIP/2.0/UDP scscf2.home2.net;branch= af45K329jsg213, SIP/2.0/UDP +pcscf2.visited2.net;branch= af45K329jsbbb2, SIP/2.0/UDP +[5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch= af45K329jstd43 +Record-Route: , , +, +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: ast324c2ho9512go9238ks4b +Cseq: 127 OPTIONS +Supported: gruu, preconditions, 100rel +Contact: ; +g.3gpp.cs-voice; +g.3gpp.cs-video, +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933617 IN IP6 5555:: aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 0 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim image/jpeg image/gif video/3gpp +a=max-size:65536 +m=video 0 RTP/AVP 96 +a=rtpmap:96 H263-2000/90000 +m=audio 0 RTP/AVP 97 +a=rtpmap:97 AMR/8000 +m=video 0 RTP/AVPF 96 +a=rtpmap:96 H263-2000/90000 +m=audio 0 RTP/AVPF 97 +a=rtpmap:97 AMR/8000 + +``` + +#### **SDP** + +The SDP contains: + +- The set of offered content types supported by UE#1 and desired by the user at UE#1 for an MSRP session in the accept-types attribute and indicates the maximum size message that can be received by UE#1 in the max-size attribute (no dynamically allocated attributes are included, for example, the a=path line is not there); +- The supported video codec and relevant parameters (but no dynamically allocated parameters); +- The supported audio codec and relevant parameters (but no dynamically allocated parameters). + +No ports are declared since UE capabilities are just being listed. + +#### **15. 200 (OK) response (P-CSCF#2 to CUA#2) – see example in table B.6.2-15** + +P-CSCF#2 forwards the 200 (OK) response to the originating CUA. + +**Table B.6.2-15: 200 (OK) response (P-CSCF#2 to CUA#2)** + +``` +SIP/2.0 200 OK +Via: SIP/2.0/UDP [5555::eee:fff:aaa:bbb]:8805;comp=sigcomp;branch=af45K329jstd43 +Record-Route: , , + , +P-Asserted-Identity: +Privacy: +From: +To: +Call-ID: +CSeq: +Supported: +Contact: +Allow: +Content-Type: +Content-Length: + +v= +o= +s= +c= +t= +m= +a= +a= +m= +a= +m= +a= +``` + +#### 16. Cache information on CUA#1's capabilities + +Since no CS call is ongoing, cache the information obtained on CUA#1's capabilities for later use within a CS call. + +#### 17. CS call establishment + +Either UE initiates the setup of a CS call between CUA#1 and CUA#2, as described in subclause B.5. However, in subclause B.5 UE capability version and personal ME identifier are used. + +### B.6.3 UE capability exchange when a CS call is already in progress + +Figure B.6.3-1 shows the UE capability exchange using OPTIONS when a CS call is already in progress between CUA#1 and CUA#2. + +![Sequence diagram showing UE capability exchange using OPTIONS after a CS call is established between CUA#1 and CUA#2 via Intermediate IM CN subsystem entities and Intermediate CS entities.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +``` +sequenceDiagram + participant CUA#1 + participant IMCN as Intermediate IM CN subsystem entities + participant CS as Intermediate CS entities + participant CUA#2 + + Note left of CUA#1: 1. CS Call Setup + CUA#1->>CUA#2: 1. CS Call Setup + Note right of CUA#2: 2. OPTIONS + CUA#1->>IMCN: 2. OPTIONS + Note left of IMCN: 3. OPTIONS request S-CSCF -> I-CSCF + IMCN->>IMCN: 4. Routing decisions within S-CSCF#2 + IMCN->>CUA#2: 5. OPTIONS + Note right of CUA#2: 6. Cache address information + CUA#2->>IMCN: 7. 200 OK + IMCN->>CUA#1: 8. 200 OK + Note left of CUA#1: 9. Cache address information + CUA#2->>IMCN: 10. OPTIONS + Note left of IMCN: 11. OPTIONS request S-CSCF -> I-CSCF + IMCN->>IMCN: 12. Routing decisions within S-CSCF#1 + IMCN->>CUA#1: 13. OPTIONS + Note left of CUA#1: 14. Cache address information + CUA#1->>IMCN: 15. 200 OK + IMCN->>CUA#2: 16. 200 OK + Note right of CUA#2: 17. Cache address information +``` + +The sequence diagram illustrates the interaction for UE capability exchange. It begins with a 'CS Call Setup' (1) between CUA#1 and CUA#2. CUA#1 then sends an 'OPTIONS' (2) request to the Intermediate IM CN subsystem entities. These entities send an 'OPTIONS request S-CSCF -> I-CSCF' (3) and perform 'Routing decisions within S-CSCF#2' (4). An 'OPTIONS' (5) message is sent to CUA#2, which caches the address information (6) and returns a '200 OK' (7). The IM CN subsystem entities then send a '200 OK' (8) to CUA#1, which caches the information (9). CUA#2 sends another 'OPTIONS' (10) request. The IM CN subsystem entities send another 'OPTIONS request S-CSCF -> I-CSCF' (11) and perform 'Routing decisions within S-CSCF#1' (12). An 'OPTIONS' (13) message is sent to CUA#1, which caches the information (14) and returns a '200 OK' (15). Finally, the IM CN subsystem entities send a '200 OK' (16) to CUA#2, which caches the information (17). + +Sequence diagram showing UE capability exchange using OPTIONS after a CS call is established between CUA#1 and CUA#2 via Intermediate IM CN subsystem entities and Intermediate CS entities. + +Figure B.6.3-1: UE capability exchange using OPTIONS after a CS call is established + +Only the details of the signalling flows are described that are different from the flows where UE capability exchange happens before a CS call is established (see subclause B.6.2). + +#### 1. CS call establishment + +Either UE initiates the setup of a CS call between CUA#1 and CUA#2, as described in subclause B.5. In this example the UE capability version and personal ME identifier are not transferred as part of the CS call signalling. Therefore, CUA#1 is not aware of the capabilities of CUA#2 and starts a capability exchange. + +#### 2. OPTIONS request (CUA#1 to P-CSCF#1) + +As the CS call is already established, the OPTIONS request is built using the tel URI that is the same as the connected number received in the Connect Message from the already established CS call. This assumes that CUA#1 originated the CS call. + +##### 2. to 5. OPTIONS request (CUA#1 to CUA#2) + +Same as steps for OPTIONS when no CS call is established, see subclause B.6.2 steps 1 to 4. + +#### 6. Cache information of CUA#1's capabilities and display capabilities available during this CS call + +Since a CS call is ongoing, use the information in the OPTIONS request to indicate to the user which capabilities are available during this CS call. Also, cache the information about CUA#1's capabilities for later use. + +##### 7. to 8. 200 (OK) response to OPTIONS request (CUA#2 to CUA#1) + +Same as steps for OPTIONS when no CS call is established, see subclause B.6.2 steps 6 to 7. + +#### 9. Cache information of UE#2's capabilities and display capabilities available during this CS call + +Since a CS call is ongoing, use the information in the 200 (OK) response to the OPTIONS request to indicate to the user which capabilities are available during this CS call. Also, cache the information about UE#2's capabilities for later use. + +#### 10. OPTIONS request (CUA#2 to P-CSCF#2) + +When the CS call is already established, then the OPTIONS request is built using the tel URI that is the same as the calling number received in the SETUP Message from the already established CS call. + +##### 10. to 13. OPTIONS request (CUA#2 to CUA#1) + +Same as steps for OPTIONS when no CS call is established, see subclause B.6.2 steps 9 to 12. + +#### 14. Cache information of CUA#2's capabilities and display capabilities available during this CS call + +Since a CS call is ongoing, use the information in the OPTIONS request and if available previously stored capabilities of CUA#2 to indicate to the user which capabilities are available during this CS call. Also, cache the information about CUA#2's capabilities for later use. + +##### 15. to 16. 200 (OK) response to OPTIONS request (CUA#1 to CUA#2) + +Same as steps for OPTIONS when no CS call is established, see subclause B.6.2 steps 14. to 15. + +#### 17. Cache information on UE#1's capabilities and display capabilities available during this CS call + +Since a CS call is ongoing, use the information in the 200 (OK) response to the OPTIONS request to indicate to the user which capabilities are available during this CS call. Also, cache the information obtained on UE#1's capabilities for later use. + +## --- B.7 Signalling flows demonstrating UE capability exchange with UE capability version + +### B.7.1 Introduction + +This subclause provides signalling flows for UE capability exchange with UE capability version and personal ME identifier outside a CS call or when a CS call is already in progress. + +### B.7.2 UE capability exchange with UE capability version + +Figure B.7.2-1 shows the UE capability exchange using OPTIONS when an IM session or a CS call is already in progress between CUA#1 and CUA#2. In this figure, CUA#2 received UE capability version and personal ME identifier, which means for instance that CUA#1's capabilities have been significantly updated. + +The difference between with no UE capability version (Figure B.6.2-1, B.6.3-1) and with UE capability version (Figure B.7.2-1) of UE capability exchange is that the frequency of OPTIONS transaction is reduced through exchange of UE capability version (Figure B.7.2-1). + +![Sequence diagram showing UE capability exchange using OPTIONS messages. The diagram involves four lifelines: CUA#1, Intermediate IM CN subsystem entities, Intermediate CS entities, and CUA#2. The sequence starts with CUA#1 sending an INVITE request and 200 OK response to CUA#2. CUA#2 then compares the received capability version with its stored version. If different, it decides to update. CUA#2 sends an OPTIONS request to the Intermediate CS entities. The CS entities forward it to the IM subsystem (4a, 4b). The IM subsystem makes routing decisions (5) and sends an OPTIONS response (6) to CUA#1. CUA#1 stores the address information (7) and sends a 200 OK response (8) to the CS entities. The CS entities then forward it to the IM subsystem (9), which sends a 200 OK response (10) to CUA#2. CUA#2 stores the address information (11).](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` + +sequenceDiagram + participant CUA1 as CUA#1 + participant IMCN as Intermediate IM CN subsystem entities + participant CS as Intermediate CS entities + participant CUA2 as CUA#2 + + Note right of CUA2: 2. CUA#2 compare between stored CUA#1's capability version and received CUA#1's capability version. If stored and received CUA#1's capability version is different, CUA#2 decide to update stored capability of CUA#1. + + CUA1->>CUA2: 1. INVITE request and 200 OK response + CUA1->>CUA2: 1'. SETUP request and CONNECT response + CUA2->>CS: 3. OPTIONS + CS->>IMCN: 4a. User-Agent P-CSCF#2 - P-CSCF#1 +4b. OPTIONS request S-CSCF -> I-CSCF + IMCN->>IMCN: 5. Routing decisions within S-CSCF#1 + IMCN->>CUA1: 6. OPTIONS + Note left of CUA1: 7. Store address information + CUA1->>CS: 8. 200 OK + CS->>IMCN: 9. Server P-CSCF#2 -> P-CSCF#1 + IMCN->>CUA2: 10. 200 OK + Note right of CUA2: 11. Store address information + +``` + +Sequence diagram showing UE capability exchange using OPTIONS messages. The diagram involves four lifelines: CUA#1, Intermediate IM CN subsystem entities, Intermediate CS entities, and CUA#2. The sequence starts with CUA#1 sending an INVITE request and 200 OK response to CUA#2. CUA#2 then compares the received capability version with its stored version. If different, it decides to update. CUA#2 sends an OPTIONS request to the Intermediate CS entities. The CS entities forward it to the IM subsystem (4a, 4b). The IM subsystem makes routing decisions (5) and sends an OPTIONS response (6) to CUA#1. CUA#1 stores the address information (7) and sends a 200 OK response (8) to the CS entities. The CS entities then forward it to the IM subsystem (9), which sends a 200 OK response (10) to CUA#2. CUA#2 stores the address information (11). + +**Figure B.7.2-1: UE capability exchange using OPTIONS after receiving UE capability version during an IM session setup or a CS call setup** + +If UE capability exchange performs after receiving UE capability version and personal ME identifier during an IM session setup, initial IM session setup messages are used as follows; + +#### 1. INVITE request and 200 OK response + +##### 1a. INVITE request (CUA#1 to CUA#2) – see example in table B.7.2-1a + +CUA#1 sends INVITE request with UE#1's capability version to CUA#2. The UE#1's capability version is set to a different value from the previously stored UE#1's capability version, because the CUA#1 has updated its capability. + +**Table B.7.2-1a: INVITE request (CUA#1 to CUA#2)** + +``` + +INVITE tel:+12125552222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: , +P-Preferred-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: sec-agree +Proxy-Require: sec-agree +Supported: gruu +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi-c=98765432; spi-s=87654321; +port-c=8642; port-s=7531 +Contact: +Accept-Contact: *,+g.3gpp.cs-voice,+g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Accept: application/sdp, application/3gpp-ims+xmlUser-Agent: PMI-0007, UCV-04 +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s=- +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 3402 TCP/MSRP * +a=accept-types:message/cpim text/plain text/html image/jpeg image/gif video/3gpp +a=path:msrp://[5555::aaa:bbb:ccc:ddd]:3402/s111271/tcp +a=max-size:131072 + +``` + +##### 1b. 200 OK response (CUA#2 to CUA#1) – see example in table B.7.2-1b + +CUA#2 accepts the session + +**Table B.7.2-1b: 200 OK response (CUA#2 to CUA#1)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pcscf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP +scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +icscf2_s.home2.net;branch=z9hG4bK871yl2.1, SIP/2.0/UDP +scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP +pcscf1.visited1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP +[5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Privacy: none +From: ; tag=171828 +To: ;tag=314159;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: gruu +Contact: ,+g.3gpp.cs-voice, +g.3gpp.cs-video +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Server: PMI-0EA2, UCV-0D +Content-Length: (...) + +v= +o= +s= +c= +t= +m= +a= +a= +a= +a= + +``` + +If UE capability exchange performs after receiving UE capability version during a CS call setup, initial CS call setup messages are used as follows; + +#### 1'. SETUP request and CONNECT response + +##### 1'a. SETUP request (CUA#1 to CUA#2) + +CUA#1 send CS call SETUP message to CUA#2. The UE#1's capability version is set to a different value from the previously stored UE#1's capability version, because the CUA#1 has updated its capability. Specifically for CSI with UE capability version, the SETUP message includes; + +- Called Party Number = [(Numbering plan identifier = ISDN/telephony numbering plan), (type of number = international number), (Number digits = 12125552222)] +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), (Personal ME Identifier = 0007), (UE Capability Version = 04)]. + +CUA#1 ensures that the Personal ME Identifier and UE capability version within the User-User IE of the SETUP correlates to the Personal ME Identifier and UE capability version used by CUA#1 in the preceding IM session. + +##### 1'b. CONNECT response (CUA#2 to CUA#1) + +CUA#2 send CS call CONNECT message to CUA#1 to establish CS bearer. Specifically for CSI with UE capability version, the CONNECT message includes; + +- User-User IE = [(Protocol ID = 3GPP capability exchange protocol), (Radio Environment = 1), (Personal ME Identifier = 0EA2), (UE Capability Version = 0D)]. + +CUA#2 uses the Personal ME Identifier and UE capability version provided by CUA#1 in SETUP to bind the IM session to this CS Call. CUA#2 returns the Personal ME Identifier and UE capability version provided by CUA#2 within the User-User IE. + +#### 2. CUA#2 decide whether to send OPTIONS request according to UE#1's capability version + +CUA#2 decides whether to send SIP OPTIONS request to CUA#1 according to UE capability version received during the IM session setup. If the received UE capability version is set differently from previously stored UE capability version, it means that CUA#1 has updated its capabilities. In this case, CUA#2 sends SIP OPTIONS request to CUA#1 to get CUA#1's updated capability information. + +##### 3 to 6. OPTIONS request (CUA#2 to CUA#1) + +Same as steps for OPTIONS when IM session is established, see subclause B.6.2 steps 9. to 12. + +#### 7. Store CUA#2's address information and display capabilities, which have been updated available during this IM session + +Since an IM session is ongoing, use the information in the SIP OPTIONS request to indicate to the user which capabilities are available during this IM session. Also, store the address information and capabilities from CUA#2 for later use. + +##### 8. to 10. 200 (OK) response to OPTIONS request (CUA#1 to CUA#2) + +Same as steps for OPTIONS when IM session with no UE capability version is established, see subclause B.6.2 steps 14. to 15. + +#### 11. Store information on CUA#1's capabilities + +Since an IM session is ongoing, use the information in the 200 (OK) response to the OPTIONS request to indicate to the user which capabilities are available during this IM session. Also, store the capability information from CUA#1 for later use. + +## --- B.8 Signalling flows demonstrating an IMS multimedia session setup with IMS origination and CSI termination. + +### B.8.1 Introduction + +This subclause provides signalling flows for establishing an IM multimedia session with IMS origination and CSI termination. + +The flows shows some additions related to CSI. The B2B CUA of the CSI AS includes the media feature tags g.3gpp.cs-voice and g.3gpp.cs-video in the Accept-Contact header and in the Contact header. + +UE#1 illustrated in the figures is a UE that originates multimedia sessions without involving the CS domain for media transport. + +### B.8.2 CSI interworking function establishing a combinational CS call and an IMS session to a terminating UE + +Figure B.8.2-1 illustrates an example signalling flow for an IMS originated multimedia session (with real time voice component and a non-real time messaging component) a CSI UE interworked by the CSI interworking function in the IM CN subsystem. + +In this example the messaging component is transported by MSRP. + +In this example, UE#1 needs to reserve local resources. + +In this example, the "100 Trying" in response to an initial INVITE and other SIP message exchanges, eg. the 183 Session Progress from CUA#2 and PRACK going to CUA#2, are not shown for simplicity. + +In this example, the originating NW and the terminating NW are shown as two separate NWs. This does not imply that the originating and terminating cannot be just one NW. What this example is meant to illustrate is which part of the NW (originating or terminating) that the CSI AS for terminating session handling is invoked. + +In this example the CSI AS in its 183 Session Progress to UE#1 provides an SDP answer wherein the audio component indicates a "c=" line destination pointing to the MGW and for the MSRP component the "c=" line at session level indicates the destination as the terminating CUA itself. + +![Sequence diagram showing the interworking of an originating multimedia IMS session to a CSI UE. The diagram is divided into 'In originating NW' and 'In terminating NW'. Lifelines include UE#1, Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS, MGCF, MGW, VMSC, and CUA#2. The sequence involves INVITE, iFC evaluation, Termination logic, H.248 interaction, 183 Session Progress, PRACK, and 200 OK messages, with parallel bearers reserved for media.](61a7f401eb46fe99a71f27bc37493f04_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant IMCN1 as Intermediate IM CN subsystem #1 entities + participant IMCN2 as Intermediate IM CN subsystem #2 entities + participant CSI AS + participant MGCF + participant MGW + participant VMSC + participant CUA#2 + + Note left of IMCN1: In originating NW + Note right of CUA#2: In terminating NW + + UE#1->>IMCN1: 1. INVITE + IMCN1->>IMCN2: 2. INVITE + Note right of IMCN2: 2a. iFC evaluation + IMCN2->>CSI AS: 3. INVITE + Note right of CSI AS: 4. Termination logic is applied + CSI AS->>IMCN2: 5. INVITE (SIP URI) + IMCN2->>CUA#2: 5a. INVITE (SIP URI) + CSI AS->>IMCN2: 7. INVITE (Tel URI) + IMCN2->>IMCN2: 7a. INVITE (Tel URI) + IMCN2->>MGCF: 8. IAM + Note right of MGCF: 9. H.248 interaction with the MGW + MGCF->>CSI AS: 10. 200 OK (SIP URI) + CSI AS->>IMCN2: 10a. 200 OK (SIP URI) + IMCN2->>CSI AS: 11. ACK + CSI AS->>IMCN2: 11a. ACK + CSI AS->>IMCN2: 12. 183 Session Progress + IMCN2->>IMCN2: 12. 183 Session Progress + IMCN2->>IMCN1: 12a. 183 Session Progress + IMCN1->>UE#1: 12a. 183 Session Progress + UE#1->>IMCN1: 13. PRACK + IMCN1->>IMCN2: 13a. PRACK + IMCN2->>CSI AS: 13a. PRACK + CSI AS->>IMCN2: 15. PRACK + IMCN2->>CSI AS: 15a. PRACK + CSI AS->>MGCF: 16. 200 OK + MGCF->>CSI AS: 16a. 200 OK + CSI AS->>IMCN2: 17. 200 OK + IMCN2->>IMCN1: 17a. 200 OK + IMCN1->>UE#1: 17a. 200 OK + + Note right of CUA#2: 6. Reserve IP-CAN bearer for media + Note left of IMCN1: 14. Reserve IP-CAN bearer for media + +``` + +Sequence diagram showing the interworking of an originating multimedia IMS session to a CSI UE. The diagram is divided into 'In originating NW' and 'In terminating NW'. Lifelines include UE#1, Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS, MGCF, MGW, VMSC, and CUA#2. The sequence involves INVITE, iFC evaluation, Termination logic, H.248 interaction, 183 Session Progress, PRACK, and 200 OK messages, with parallel bearers reserved for media. + +Figure B/8.2-1: Interworking an originating multimedia IMS session to a CSI UE + +![Sequence diagram showing the interworking of an originating multimedia IMS session to a CSI UE. The diagram is divided into 'In originating NW' and 'In terminating NW'. Lifelines include UE#1, Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS, MGCF, MGW, VMSC, and CUA#2. The sequence of messages includes UPDATE, COT, SETUP, CALL_CONFIRM, ALERTING, ISUP ACM/CPG and SIP 180 (Ringing)/PRACK exchange, Resource allocation, CONNECT, CONNECT_ACK, ANM, 200 OK (Tel URI), and ACK. At the bottom, a 'Voice component' and 'MSRP component' are shown as continuous lines across the network segments.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +The diagram illustrates the signaling flow for interworking an originating multimedia IMS session to a CSI UE. It is divided into two main network domains: 'In originating NW' and 'In terminating NW'. + +**Entities:** + +- In originating NW:** UE#1, Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS. +- In terminating NW:** MGCF, MGW, VMSC, CUA#2. + +**Sequence of Messages:** + +- UE#1 sends 18. UPDATE to Intermediate IM CN subsystem #1 entities. +- Intermediate IM CN subsystem #1 entities send 18a. UPDATE to Intermediate IM CN subsystem #2 entities. +- Intermediate IM CN subsystem #2 entities send 18a. UPDATE to CSI AS. +- Intermediate IM CN subsystem #2 entities send 19. UPDATE to CSI AS. +- Intermediate IM CN subsystem #2 entities send 19a. UPDATE to MGCF. +- MGCF sends 20. COT to VMSC. +- VMSC sends 21. SETUP to CUA#2. +- CUA#2 sends 22. CALL\_CONFIRM to VMSC. +- VMSC sends 23. ALERTING to CUA#2. +- A dashed double-headed arrow labeled 24. ISUP ACM/CPG and SIP 180 (Ringing)/PRACK exchange occurs between UE#1 and VMSC. +- MGW sends 25. Resource allocation to VMSC. +- VMSC sends 25a. Resource allocation to CUA#2. +- VMSC sends 26. CONNECT to CUA#2. +- CUA#2 sends 27. CONNECT\_ACK to VMSC. +- VMSC sends 28. ANM to MGCF. +- MGCF sends 29. 200 OK (Tel URI) to Intermediate IM CN subsystem #2 entities. +- Intermediate IM CN subsystem #2 entities send 29a. 200 OK (Tel URI) to CSI AS. +- CSI AS sends 30. 200 OK to Intermediate IM CN subsystem #2 entities. +- Intermediate IM CN subsystem #2 entities send 30a. 200 OK to Intermediate IM CN subsystem #1 entities. +- Intermediate IM CN subsystem #1 entities send 30a. 200 OK to UE#1. +- UE#1 sends 31. ACK to Intermediate IM CN subsystem #1 entities. +- Intermediate IM CN subsystem #1 entities send 31a. ACK to Intermediate IM CN subsystem #2 entities. +- Intermediate IM CN subsystem #2 entities send 31a. ACK to CSI AS. +- Intermediate IM CN subsystem #2 entities send 32. ACK to CSI AS. +- Intermediate IM CN subsystem #2 entities send 32a. ACK to MGCF. + +**Media Components:** + +- Voice component:** A solid line spanning from UE#1 through Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS, MGCF, MGW, VMSC, and CUA#2. +- MSRP component:** A solid line spanning from UE#1 through Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS, MGCF, MGW, VMSC, and CUA#2. + +Sequence diagram showing the interworking of an originating multimedia IMS session to a CSI UE. The diagram is divided into 'In originating NW' and 'In terminating NW'. Lifelines include UE#1, Intermediate IM CN subsystem #1 entities, Intermediate IM CN subsystem #2 entities, CSI AS, MGCF, MGW, VMSC, and CUA#2. The sequence of messages includes UPDATE, COT, SETUP, CALL\_CONFIRM, ALERTING, ISUP ACM/CPG and SIP 180 (Ringing)/PRACK exchange, Resource allocation, CONNECT, CONNECT\_ACK, ANM, 200 OK (Tel URI), and ACK. At the bottom, a 'Voice component' and 'MSRP component' are shown as continuous lines across the network segments. + +Figure B/8.2-1 (continued): Interworking an originating multimedia IMS session to a CSI UE + +#### 1. SIP INVITE request (from originating UE#1) + +UE#1 wants to initiate a multimedia session with the terminating CUA#2 and sends out an INVITE request. See example in Table B.8.2-1. + +**Table B.8.2-1: INVITE request (UE#1 to P-CSCF#1)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 70 +Route: sip:pcscf1.home1.net:7531;lr;comp=sigcomp>, +P-Preferred-Identity: "Joe Bloke" +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: 100rel; precondition, gruu +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi=87654321; port1=7531 +Contact: < sip: user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6;comp=sigcomp > +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATEAccept:application/sdp, application/3gpp-ims+xml +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96a=tcap:1 RTP/AVPF +a=pconfig:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +m=message 3402 TCP/MSRP +a=accept-types:message/cpim text/plain text/html image/jpeg image/gif video/3gpp +a=path:msrp://[5555::aaa:bbb:ccc:ddd]:3402/s111271;tcp +a=max-size:131072 + +``` + +#### 2. SIP INVITE request (from originating intermediate IM CN subsystem #1 to the terminating IM CN subsystem #2) + +The originating IM CN #1 maps the Tel URI to a SIP URI and forwards the INVITE request towards the terminating IM CN #2. See example in Table B.8.2-2 + +**Table B.8.2-2: INVITE request (S-CSCF#1 to S-CSCF#2)** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE <sip:user2_public2@home2.net> SIP/2.0 Via: SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, SIP/2.0/UDP      pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP      [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 Max-Forwards: 67 Route: <sip:as.home1.net;lr>,<sip:cb03a0s09a2sdfglkj490333@scscf1.home1.net;lr> Record-Route: <sip:scscf1.home1.net>, <sip:pcscf1.home1.net> P-Asserted-Identity: "Joe Bloke" <sip:user3_public1@home1.net>, <tel: +1-212-555-333> P-Access-Network-Info: Privacy: none P-Charging-Vector: P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] From: To: Call-ID: Cseq: 127 Supported: Contact: Allow: Content-Type: Content-Length: (...)  v=0 o= s= c= t= m= a= a= b= a= a= a= a= a= a= a= a= a= m= a= a= a=
| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 2a. Evaluation of initial filter criteria (at S-CSCF#2) + +The S-CSCF#2 performs iFC evaluation in order to decide what services to invoke and how to route the INVITE request. In this example, the S-CSCF#2 determines that the INVITE request must be routed to the CSI AS. + +#### 3. SIP INVITE request (to the target CSI application server) + +S-CSCF#2 routes the INVITE to the indicated CSI application server. See example in Table B.8.2-3. + +**Table B.8.2-3 INVITE request (S-CSCF#2 to CSI application server)** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 INVITE <sip:user2_public2@home2.net> SIP/2.0 Via: SIP/2.0/UDP scscf2.home2.net;branch=y2y2y2y2y2y2y2.2,      SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1,
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +``` + + SIP/2.0/UDP pcscf1.home1.net;branch=z9hG4bK240f34.1, SIP/2.0/UDP + [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Max-Forwards: 66 +Route: , +Record-Route: , + , + +P-Asserted-Identity: "Joe Bloke" +P-Access-Network-Info: +Privacy: none +P-Charging-Vector: +P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; +ecf=[5555::1ff:2ee:3dd:4ee]; ecf=[5555::6aa:7bb:8cc:9dd] +From: +To: +Call-ID: +Cseq: 127 +Supported: +Contact: +Allow: +Content-Type: +Content-Length: (...) + +v=0 +o= +s= +c= +t= +m= +a= +a= +b= +a= +a= +a= +a= +a= +a= +a= +a= +a= +m= +a= +a= +a= + +``` + +#### 4. Termination logic processing by the CSI AS + +The CSI application server invokes its termination logic and based on the requested media components it decides to do a session split, i.e. to terminate the voice component via the CS domain and the session containing MSRP stream via an IP-CAN. + +NOTE 1: For splitting the session into two parts, the CSI AS will later initiate two INVITE requests: one in step 5 for the MSRP component and another in step 7 for the voice component. The sequence of these INVITE requests is implementation specific (although this example shows first the INVITE for the voice component). + +NOTE 2: The two sessions (for the voice and session containing MSRP stream) are presented to the user as a single composite session. + +#### 5. SIP INVITE request (from CSI AS to terminating user CUA#2 in the IM CN subsystem ) + +The CSI AS (acting as a B2B UA) initiates an INVITE request for the session containing the MRSP stream to the terminating CUA#2 with the Request URI set to the SIP URI received in the initial INVITE request received at step 3. See example in Table B.8.2-4 + +**Table B.8.2-4: INVITE request (CSI AS as B2BUA to S-CSCF#2 for IMS session)** + +``` + +INVITE sip:user2_public2@home2.net SIP/2.0 +Via: SIP/2.0/UDP as.home2.net +Max-Forwards: 70 +Route: +Record-Route: +P-Asserted-Identity: +P-Access-Network-Info: +P-Charging-Vector: +Privacy: none +Supported: gruu +From: ;tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Contact: +Accept-Contact: *,+g.3gpp.cs-voice, +g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=message 3402 TCP/MSRP +a=accept-types:message/cpim text/plain text/html image/jpeg image/gif video/3gpp +a=path:msrp://[5555::aaa:bbb:ccc:ddd]:3402/s111271/tcp +a=max-size:131072 + +``` + +#### **6. Reserve IP-CAN bearer for Media at terminating side** + +The terminating CUA initiates media reservation. + +#### **7. SIP INVITE request (from CSI AS to the terminating user CUA#2 in CS domain)** + +Acting again as a B2B UA the CSI AS substitutes the SIP URI in the Request URI (received in step 3) with a Tel URI and initiates a new INVITE request. See example in Table B.8.2-5. + +**Table B.8.2-5: INVITE request (CSI AS as B2BUA to S-CSCF#2 for CS call)** + +``` + +INVITE tel:+1-212-555-2222 SIP/2.0 +Via: SIP/2.0 as.home.net; branch=z9hG4bKnashdt8t8 +Max-Forwards: 65 +Route: , +Record-Route: +P-Asserted-Identity: +P-Access-Network-Info: +Privacy: none +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: 100rel, precondition, gruu +Require: sec-agree +Proxy-Require: sec-agree +Security-Verify: ipsec-3gpp; q=0.1; alg=hmac-sha-1-96; spi=87654321; port1=7531 +Contact: < sip:user1_public1@home1.net;gr=urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6;comp=sigcomp > +Accept-Contact: *,+g.3gpp.cs-voice, +g.3gpp.cs-video;explicit +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP6 5555::aaa:bbb:ccc:ddd +s= +c=IN IP6 5555::aaa:bbb:ccc:ddd +t=0 0 +m=audio 3456 RTP/AVP 97 96a=tcap:1 RTP/AVPF +a=pcfg:1 t=1 +b=AS:25.4a=curr:qos local sendrecva=curr:qos remote none + +``` + +``` + +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### 8. ISUP IAM (from the MGCF to the VMSC of the terminating CUA#2) + +The MGCF performs the IMS/CS interworking functions and initiates an ISUP IAM towards the VMSC. Because the media for the originating side is not yet available, the MGCF indicates "Continuity check performed on previous circuit" in the IAM. + +#### 9. H248 interactions (between MGCF and MGW) + +MGCF interacts with MGW for necessary resource allocation. + +#### 10. SIP 200 (OK) response (from CUA#2 back to CSI AS through intermediate IM CN subsystem #2) + +After reserving an IP-CAN bearer for the message session media component the terminating CUA sends a 200 (OK) response for the INVITE request containing SDP that indicates that the terminating CUA has accepted the message session and listens on the MSRP TCP port returned in the path attribute in the answer for a TCP SETUP from the originating CUA. + +CUA#2 declares support only for CS-voice, not CS-video in its Contact header. The terminating CUA includes its personal ME identifier and UE capability version in the service header. + +See example in Table B.8.2-6. + +**Table B.8.2-6: 200 (OK) response (CUA#2 to P-CSCF#2)** + +``` + +SIP/2.0 200 OK +Via: SIP/2.0/UDP pscsf2.visited2.net:5088;comp=sigcomp;branch=z9hG4bK361k21.1, SIP/2.0/UDP + scscf2.home2.net;branch=z9hG4bK764z87.1, SIP/2.0/UDP +Record-Route: , , +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: ;tag=314159 +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Supported: gruu +Contact: ,+g.3gpp.cs-voice +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Server: PMI-0EA2, UCV-08 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s= +c=IN IP6 5555::eee:fff:aaa:bbb +t=0 0 +m=message 3402 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim +a=path:msrp://[5555::eee:fff:aaa:bbb]:3402/s234167/tcp +a=max-size:65536 + +``` + +NOTE: The SDP contains the set of offered content types supported by CUA#2 and desired by the user at CUA#2 for this session in the accept-types attribute and indicates the maximum size message that can be received by CUA#2 in the max-size attribute. + +#### 11. SIP ACK request (CSI AS back to CUA#2) + +The CSI AS provides SIP ACK request to CUA#2. + +#### 12. SIP 183 (Session Progress) response (from MGCF to CSI AS through intermediate IM CN subsystem #2) + +The MGCF provides a 183 Session Progress request back to the CSI AS through S-CSCF#2. + +##### **12a. SIP 183 (Session Progress) response (from CSI AS to UE#1)** + +The CSI AS provides a 183 Session Progress response back to the UE#1. + +#### **12a. SIP 183 (Session Progress) response (from CSI AS to UE#1 through intermediate IM CN subsystems)** + +CSI AS in turn provides 183 (Session Progress) response back to UE#1 through the intermediate IM CN subsystems. This 183 (Session progress) response from the CSI AS will include a SDP answer to UE#1's SDP offer in the initial INVITE. See example in Table B.8.2-7. + +**Table B.8.2-7: 183 (Session Progress) response (CSI AS to S-CSCF#2)** + +``` + +SIP/2.0 183 Session Progress +Via: SIP/2.0/UDP scscf2.home2.net;branch=z9hG4bK764z87.1, + SIP/2.0/UDP icscf2_s.home2.net;branch=z9hG4bK871y12.1, + SIP/2.0/UDP scscf1.home1.net;branch=z9hG4bK332b23.1, + SIP/2.0/UDP pcscf1.visited1.net;branch=z9hG4bK240f34.1, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd]:1357;comp=sigcomp;branch=z9hG4bKnashds7 +Record-Route: , , +Privacy: none +P-Access-Network-Info: 3GPP-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ; tag=171828 +To: +Call-ID: cb03a0s09a2sdfglkj490333 +Cseq: 127 INVITE +Require: precondition, 100rel +Contact: ,+g.3gpp.cs-voice +Allow: INVITE, ACK, CANCEL, BYE, PRACK, UPDATE, REFER, MESSAGE, OPTIONS +Server: PMI-0EA2, UCV-08 +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933617 IN IP6 5555:: eee:fff:aaa:bbb +s= +c=IN IP6 5555:: eee:fff:aaa:bbb +t=0 0 +m=audio 3456 RTP/AVPF 97 96 +a=acfg:1 t=1 +b=AS:25.4 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=inactive +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +c=IN IP6 5555::eee:fff:www:yyy +t=0 0 +m=message 3402 TCP/MSRP * +a=accept-types:text/plain text/html message/cpim +a=path:msrp://[5555::eee:fff:aaa:bbb]:3402/s234167/tcp +a=max-size:65536 + +``` + +#### **13, 13a. SIP PRACK request (from UE#1)** + +UE#1 upon receipt of 183 (Session Progress) response replies back with PRACK request. With that UE#1 initiates resource allocation for the session it originated. + +#### **14 Reserve IP-CAN bearer for Media at originating side** + +The originating UE starts resource reservation for media bearers. + +#### **15, 15a. SIP PRACK request (from CSI AS to MGCF)** + +The PRACK from UE#1 lead the CSI AS to provide PRACK to the MGCF + +#### **16, 16a SIP 200 (OK) response (MGCF to CSI AS )** + +MGCF acknowledges the PRACK (from CSI AS) with 200 (OK) (back to CSI AS) + +#### **17, 17a. SIP 200 (OK) response (from CSI AS to UE#1 through intermediate IM CN subsystems)** + +CSI AS correspondingly provides the 200 (OK) back to UE#1 through the intermediate IM CN subsystems. + +#### **18, 18a SIP UPDATE request (from UE#1 to CSI AS through intermediate IM CN subsystems)** + +UE#1 indicates it has available the necessary resources. + +#### **19, 19a SIP UPDATE request (from CSI AS to MGCF through intermediate IM CN subsystem#2)** + +CSI AS provides the indication of available resources at originating side to the MGCF. + +#### **20. ISUP COT (from MGCF to VMSC)** + +With the UPDATE indicating that originating side has the necessary media resources and as such conditions are met, the MGCF sends COT to the VMSC indicating "continuity check successful". + +#### **21. SETUP (from VMSC to CUA#2)** + +The VMSC now sends the SETUP towards the terminating CUA#2. + +#### **22. CALL CONFIRM (from CUA#2 to VMSC)** + +The terminating UE acknowledges and confirms acceptance of the incoming call by sending CONFIRM back to the VMSC. + +NOTE: There is no suggestion, by this example or otherwise, that CUA#2 only response with CALL CONFIRM after the INVITE for the IM CN subsystem is received. + +#### **23. ALERTING (from CUA#2 to VMSC)** + +For this example, the VMSC allows early local alerting. With the generation of local alerting, ALERTING is sent back from the UE to the VMSC. + +#### **24. ACM, CPG, SIP 180 (Ringing) response and SIP Prack request (VMSC to MGCF through IM CN Subsystem to originating end)** + +On receipt of the ALERTING from the terminating UE, the VMSC, MGCF, IM CN subsystem and the originating UE exchange ISUP and SIP signalling to indicate that the called party confirmed the call and did start ringing the end user. + +#### **25, 25a . Resource allocation (VMSC to terminating UE, MGW and VMCS)** + +The VMSC starts resource allocation towards the terminating UE. + +Between VMSC and the MGW resource allocation is also started. + +#### **26. CONNECT (from CUA#2 to VMSC)** + +When the user answers the call, the terminating UE sends CONNECT to the VMSC. After sending the CONNECT, the terminating UE is ready to connect to user plane resources. + +#### **27. CONNECT ACK (from VMCS to CUA#2)** + +VMSC connects up the user plane and return CONNECT\_ACKNOWLEDGE to the terminating UE.. + +Through connect all the way back to originating UE is not initiated. + +#### **28. ANM (from VMSC to MGCF)** + +The VMSC having through connected the user plane sends an indication of answer to the MGCF. This is the ISUP ANM message. + +#### **29. SIP 200 (OK) response (from MGCF to the CSI AS via the intermediate IM CN subsystem #2)** + +Upon the receipt of the ANM from the VMSC, and after the connection of the media flow, the MGCF sends the SIP 200 (OK) final response to the received SIP INVITE request (in step 5) back to the CSI AS via the intermediate IM CN subsystem #2. + +##### **30, 30a . SIP 200 (OK) response (from CSI AS to intermediate IM CN subsystem #2)** + +The SIP 200 (OK) final response is provided by the CSI AS back to the originating UE#1 through the terminating intermediate IM CN subsystem #2. + +NOTE: In this example, the CSI AS provides the 200 (OK) response back to the originating UE#1 after both the voice session and the session containing the MRSP have been successfully established. + +##### **31, 31a. SIP ACK (from UE#1 to CSI AS through intermediate IM CN subsystems)** + +UE#1 responds to the 200 (OK) with ACK + +##### **32, 32a. SIP ACK (CSI AS to MGCF)** + +The CSI AS correspondingly provides the ACK to the MGCF. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-------------|-----------------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | R
e
v | Subject/Comment | Old | New | +| 2006-02 | | | | | Version 1.0.0 created by shifting text from TR 24.879 v1.2.0, as per C1-060527, after CT1 41. | - | 1.0.0 | +| 2006-02 | | | | | Version 2.0.0 created by MCC, editorial changes | 1.0.0 | 2.0.0 | +| 2006-03 | CT-31 | CP-060099 | | | Version 2.0.0 was approved and version 7.0.0 created by MCC | 2.0.0 | 7.0.0 | +| 2006-06 | CT-32 | CP-060275 | 0001 | 2 | Correction of notation for the signalling flows | 7.0.0 | 7.1.0 | +| 2006-06 | CT-32 | CP-060275 | 0009 | | Use of the Contact header in OPTIONS requests for capability exchange | 7.0.0 | 7.1.0 | +| 2006-06 | CT-32 | CP-060275 | 0011 | 1 | Referencing TS 26.141 | 7.0.0 | 7.1.0 | +| 2006-09 | CT-33 | CP-060461 | 0012 | | Correction of chapter 4 | 7.1.0 | 7.2.0 | +| 2006-09 | CT-33 | CP-060461 | 0013 | 3 | Correction of criteria for initiating capability exchange | 7.1.0 | 7.2.0 | +| 2006-09 | CT-33 | CP-060461 | 0015 | 1 | OPTIONS request inside a session | 7.1.0 | 7.2.0 | +| 2006-09 | CT-33 | CP-060461 | 0016 | | Usage of UCV and PMI | 7.1.0 | 7.2.0 | +| 2006-09 | CT-33 | CP-060461 | 0017 | | tel URI usage during session setup | 7.1.0 | 7.2.0 | +| 2006-09 | CT-33 | CP-060461 | 0020 | 1 | Merging of the Call procedures for both IMS-first and CS-first with UE capability version | 7.1.0 | 7.2.0 | +| 2006-09 | CT-33 | CP-060472 | 0019 | 2 | Provision and exchange of IMS status | 7.1.0 | 7.2.0 | +| 2006-11 | CT-34 | CP-060669 | 0021 | 2 | Signalling flows involving the CSI application server | 7.2.0 | 7.3.0 | +| 2006-11 | CT-34 | CP-060669 | 0022 | 1 | CSI Termination session handling | 7.2.0 | 7.3.0 | +| 2006-11 | CT-34 | CP-060666 | 0023 | 1 | Correction of signalling flows | 7.2.0 | 7.3.0 | +| 2007-03 | CT-35 | CP-070137 | 0028 | 2 | The CSI AS uses the capabilities of the CUA to perform termination logic | 7.3.0 | 7.4.0 | +| 2007-03 | CT-35 | CP-070137 | 0032 | 3 | Signalling flow for different "c=" in SDP Offer/Answer | 7.3.0 | 7.4.0 | +| 2007-03 | CT-35 | CP-070137 | 0035 | 1 | SIP URI-Tel URI mapping information in CSI AS | 7.3.0 | 7.4.0 | +| 2007-03 | CT-35 | CP-070137 | 0036 | 2 | Corrections to CSI termination | 7.3.0 | 7.4.0 | +| 2007-03 | CT-35 | CP-070243 | 0034 | 3 | Procedures of CSI AS | 7.3.0 | 7.4.0 | +| 2007-06 | CT-36 | CP-070390 | 0049 | 1 | Correction of references to wrong subclauses | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0038 | 2 | Video interworking alternatives | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0039 | 3 | Retrival of Public user identity information | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0040 | 3 | Session handling | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0044 | 3 | Inclusion of new call cases for IMS session setup | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0045 | 1 | Additions of a call case adding a cs call to an IMS session | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0048 | 2 | Enhacement of session release procedures | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0050 | - | Removal of references to MGCF interworking and information for interworking | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0052 | 2 | Further details of combining procedure in CSI AS | 7.4.0 | 7.5.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------|--------|--------| +| 2007-06 | CT-36 | CP-070390 | 0053 | 3 | CSI AS handling of error response | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0054 | 1 | CSI AS interactions with supplementary services | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0055 | 3 | Unregistered CUA service handling for CSI termination | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0057 | 4 | Detailed procedures about session combining | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070390 | 0046 | 4 | Clarification on modifying IMS and CS session | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070391 | 0059 | - | g.3gpp.cs-voice and g.3gpp.cs-video registered by IANA | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070481 | 0051 | 4 | Further details on splitting procedure | 7.4.0 | 7.5.0 | +| 2007-06 | CT-36 | CP-070482 | 0043 | 6 | Additions to the session initiating cases to the IMS session setup | 7.4.0 | 7.5.0 | +| 2007-09 | CT-37 | CP-070594 | 0061 | | Removal of Editor's note in subclause 9.3.3.3.1 | 7.5.0 | 7.6.0 | +| 2007-09 | CT-37 | CP-070594 | 0060 | 1 | Corrections of wrong specifications and requirements of the CSI AS | 7.5.0 | 7.6.0 | +| 2007-12 | CT-38 | CP-070790 | 0063 | | ASN.1 not included for feature tags CS-voice and CS-video | 7.6.0 | 7.7.0 | +| 2007-12 | CT-38 | CP-070790 | 0064 | | Correction to B.6.2 and B.7.2 signalling flows | 7.6.0 | 7.7.0 | +| 2007-12 | CT-38 | CP-07814 | 0066 | 3 | Capability Exchange for CSI termination | 7.7.0 | 8.0.0 | +| 2008-12 | CT-42 | CP-080848 | 0067 | | Corrections of flows in 24.279 | 8.0.0 | 8.1.0 | +| 2009-12 | CT-46 | CP-091041 | 0068 | 2 | Remove the Editor's Notes in TS 24.279 | 8.1.0 | 8.2.0 | +| 2009-12 | CT-46 | | | | Upgrade to Rel-9 | 8.2.0 | 9.0.0 | +| 2011-03 | CT-51 | | | | Upgrade to Rel-10 | 9.0.0 | 10.0.0 | +| 2012-09 | CT-57 | | | | Upgrade to Rel-11 | 10.0.0 | 11.0.0 | +| 2014-03 | CT-63 | CP-140118 | 0072 | | Updating of UUS references | 11.0.0 | 11.1.0 | +| 2014-09 | CT-65 | | | | Upgrade to Rel-12 | 11.1.0 | 12.0.0 | +| 2015-12 | CT-70 | | | | Upgrade to Rel-13 | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-06 | CT76 | CP-171052 | 0079 | 1 | A | Update CSI UUI references to RFC 7433 and RFC 7434 | 14.1.0 | +| 2018-06 | SA-80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24282/04da196e79f7ac195f928904a244f0f9_img.jpg b/marked/Rel-16/24_series/24282/04da196e79f7ac195f928904a244f0f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f5136dd2a5e875e290f7d8f8a807925674d4dbc --- /dev/null +++ b/marked/Rel-16/24_series/24282/04da196e79f7ac195f928904a244f0f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba02e031580d35feaf6cce8beb79ff6cf0f88ed58db845026e849d5687bb4861 +size 11321 diff --git a/marked/Rel-16/24_series/24282/095cb128d8f8cc689f28744e6d5d798d_img.jpg b/marked/Rel-16/24_series/24282/095cb128d8f8cc689f28744e6d5d798d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..35c3b7536924c53f151c8f5ed5271a7143918034 --- /dev/null +++ b/marked/Rel-16/24_series/24282/095cb128d8f8cc689f28744e6d5d798d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eacd51e73d88980c9ad5f0cf5e85a2d87e7fdb06aae8aba92debe3461c75a9e7 +size 17894 diff --git a/marked/Rel-16/24_series/24282/0f22a2de3c4dfdf861c3948191e92ee3_img.jpg b/marked/Rel-16/24_series/24282/0f22a2de3c4dfdf861c3948191e92ee3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f5ca41c864a6490927161039acd4de1bf3a0b66 --- /dev/null +++ b/marked/Rel-16/24_series/24282/0f22a2de3c4dfdf861c3948191e92ee3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa86c9318e1d64e24569fdcf37fd421b404007242542f6cba1f90e1b26653b1f +size 12479 diff --git a/marked/Rel-16/24_series/24282/0f41d1d7623b574c7af88bb7c983c853_img.jpg b/marked/Rel-16/24_series/24282/0f41d1d7623b574c7af88bb7c983c853_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..14e65ae9e5e96eb59573965da561acba1d2b2d00 --- /dev/null +++ b/marked/Rel-16/24_series/24282/0f41d1d7623b574c7af88bb7c983c853_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd9b453f1a22ae9311816101ee24b12d643ad7d098fc8d22cec8051de641cde6 +size 23386 diff --git a/marked/Rel-16/24_series/24282/14af2781d0bd19b98b10672b74daaca2_img.jpg b/marked/Rel-16/24_series/24282/14af2781d0bd19b98b10672b74daaca2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..582512dbab1f9bf16a10bc1e894afbca695d2868 --- /dev/null +++ b/marked/Rel-16/24_series/24282/14af2781d0bd19b98b10672b74daaca2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a61f00b79dcc07abfcf156942af602dfaab810ff1b932c34fd6af2be40f476c6 +size 15425 diff --git a/marked/Rel-16/24_series/24282/197763d033c6f44ae28e0d5ec5ad4579_img.jpg b/marked/Rel-16/24_series/24282/197763d033c6f44ae28e0d5ec5ad4579_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24c5486d71c29d159f2a7ceb6dd5f6936265785e --- /dev/null +++ b/marked/Rel-16/24_series/24282/197763d033c6f44ae28e0d5ec5ad4579_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72a257987918d4dc94379e8306cb5acee50cf09465b24101f2008f5dded78050 +size 20464 diff --git a/marked/Rel-16/24_series/24282/317e0525ef1b2458976c246876f4a948_img.jpg b/marked/Rel-16/24_series/24282/317e0525ef1b2458976c246876f4a948_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1dd20a7a9f44c0a870a981e27afb622c051bf033 --- /dev/null +++ b/marked/Rel-16/24_series/24282/317e0525ef1b2458976c246876f4a948_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:800ca9c76d5e7652d2ef782f1c4781105a5614f0cd4a0b6244bb5bd117c86afd +size 3702 diff --git a/marked/Rel-16/24_series/24282/31f5b6310f831ca3ea4f18453980c070_img.jpg b/marked/Rel-16/24_series/24282/31f5b6310f831ca3ea4f18453980c070_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1388670ad4592c44759a9d24779bc46f91a84df4 --- /dev/null +++ b/marked/Rel-16/24_series/24282/31f5b6310f831ca3ea4f18453980c070_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff15e2288fb81081f89da842fe564f6f06d7b14a52b8c6ac2952e0d2d0a7942b +size 10105 diff --git a/marked/Rel-16/24_series/24282/3e6d714c4066432dc49451f6f86f9766_img.jpg b/marked/Rel-16/24_series/24282/3e6d714c4066432dc49451f6f86f9766_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c8e5a50f09e9e3b7f737ad1fd09dfbe9b1531602 --- /dev/null +++ b/marked/Rel-16/24_series/24282/3e6d714c4066432dc49451f6f86f9766_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0ae28738853088e909c9fd88bf462e4db168f03ed2ea4f95f0ec671e4208ea0 +size 11578 diff --git a/marked/Rel-16/24_series/24282/40933a545dbad72be6f3656384eed721_img.jpg b/marked/Rel-16/24_series/24282/40933a545dbad72be6f3656384eed721_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..215c9776117955bd572fb506f6fa159b3ec1b3be --- /dev/null +++ b/marked/Rel-16/24_series/24282/40933a545dbad72be6f3656384eed721_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5fae444f1e5ed8e12c3ecf5d9f6ffb8d46d56cbc564883f817788f7cf6b76f62 +size 11757 diff --git a/marked/Rel-16/24_series/24282/587ce8b2f9b66fa0db33410888d35966_img.jpg b/marked/Rel-16/24_series/24282/587ce8b2f9b66fa0db33410888d35966_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb534dfc4e0e235bc5426828a317c68af041d639 --- /dev/null +++ b/marked/Rel-16/24_series/24282/587ce8b2f9b66fa0db33410888d35966_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc41438b1db42b1a05b6ed0f78fded10413af0de63da8c733c506f40ade597fc +size 16766 diff --git a/marked/Rel-16/24_series/24282/65e8c0628536d6d4245e9ab46ba070c3_img.jpg b/marked/Rel-16/24_series/24282/65e8c0628536d6d4245e9ab46ba070c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16c88a3056742cfdbfbf577af443e1064e687bf8 --- /dev/null +++ b/marked/Rel-16/24_series/24282/65e8c0628536d6d4245e9ab46ba070c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc8915f1c37dc30a5cc46ff4d9009ed0eeb55fccabc9d144a52dd53242a175ab +size 39316 diff --git a/marked/Rel-16/24_series/24282/73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg b/marked/Rel-16/24_series/24282/73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b86df9a31ab99fe05aa5f83289902fde4dde1f8c --- /dev/null +++ b/marked/Rel-16/24_series/24282/73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:67d5ec3e50ab8d8af7f0c8810f02add0e5d1533e78e088390115299cfd04279c +size 8346 diff --git a/marked/Rel-16/24_series/24282/783bdce904660c3e31ca0ae26aa89011_img.jpg b/marked/Rel-16/24_series/24282/783bdce904660c3e31ca0ae26aa89011_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..74720dda0f15a75f82e0086a091ecfdf155a11d4 --- /dev/null +++ b/marked/Rel-16/24_series/24282/783bdce904660c3e31ca0ae26aa89011_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c5619874bf973004257e7c0e120be0ccae473cfd7662516f43f591909310c8d +size 22969 diff --git a/marked/Rel-16/24_series/24282/7d675e1c380dccba3f69e2de4e72562c_img.jpg b/marked/Rel-16/24_series/24282/7d675e1c380dccba3f69e2de4e72562c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..700d249777945eda845b7048ecb75ee0115fb16b --- /dev/null +++ b/marked/Rel-16/24_series/24282/7d675e1c380dccba3f69e2de4e72562c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec9f0ad106388058398686621257db55d6ecf07a13e5a00595dcc0fcd44e51de +size 13199 diff --git a/marked/Rel-16/24_series/24282/8c05782074bb11421b43f2d5d6799b62_img.jpg b/marked/Rel-16/24_series/24282/8c05782074bb11421b43f2d5d6799b62_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9615bb666e6ff13ca6ec4b3d48405cc823ed3fbe --- /dev/null +++ b/marked/Rel-16/24_series/24282/8c05782074bb11421b43f2d5d6799b62_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:571ff608eeb3c464f6a7f9d0330be4b84aa067b4524188399376bfed1bf4ec00 +size 14523 diff --git a/marked/Rel-16/24_series/24282/b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg b/marked/Rel-16/24_series/24282/b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9817bf75acc7208f49f3b14c2eda522ee4a5af33 --- /dev/null +++ b/marked/Rel-16/24_series/24282/b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5571039774b87bc621140f03f8472bf90108c93ea173b2cf91550b9411405877 +size 10146 diff --git a/marked/Rel-16/24_series/24282/b3bcc66c2024c092432a61ce8d80ee9a_img.jpg b/marked/Rel-16/24_series/24282/b3bcc66c2024c092432a61ce8d80ee9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..259f15a7e41384915fcda1cfa67c9738ddb1fb62 --- /dev/null +++ b/marked/Rel-16/24_series/24282/b3bcc66c2024c092432a61ce8d80ee9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f5b01877dc0fbbb2b501196a274466a48154ed47900c7dbbae57368cb687a40 +size 13043 diff --git a/marked/Rel-16/24_series/24282/b45f9bbca93687a01a42a6eae5c25b50_img.jpg b/marked/Rel-16/24_series/24282/b45f9bbca93687a01a42a6eae5c25b50_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e71c0c3a4a95fb7b901b687ae162147057fc2c30 --- /dev/null +++ b/marked/Rel-16/24_series/24282/b45f9bbca93687a01a42a6eae5c25b50_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a86b6458fffcb92b78dcea475f662bb2e9945916a9c2d365d889b8d69c195ced +size 21093 diff --git a/marked/Rel-16/24_series/24282/b54a22abcb1bcfbcf96ae7085a3902c4_img.jpg b/marked/Rel-16/24_series/24282/b54a22abcb1bcfbcf96ae7085a3902c4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93a8ee3e7272ff292eb2cc4831c11013ad19ed89 --- /dev/null +++ b/marked/Rel-16/24_series/24282/b54a22abcb1bcfbcf96ae7085a3902c4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f334f48e27ffd29ce747b930b7f960656c86d67ab8b6c0c3e1af7dc9947853f2 +size 11346 diff --git a/marked/Rel-16/24_series/24282/bf1635af3b59ca260bc86e762d0f2466_img.jpg b/marked/Rel-16/24_series/24282/bf1635af3b59ca260bc86e762d0f2466_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5824897e915bcd4cee4306ea825efa609a361223 --- /dev/null +++ b/marked/Rel-16/24_series/24282/bf1635af3b59ca260bc86e762d0f2466_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:539bc09a9b84aa088eed93d8a0a99432740587e44c9d55e2b9b72ca4dd4bcce3 +size 21491 diff --git a/marked/Rel-16/24_series/24282/db388803c917f32f84f9ce6375dfa6b9_img.jpg b/marked/Rel-16/24_series/24282/db388803c917f32f84f9ce6375dfa6b9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..165459393ee6318274142d7875157a10bad2cc74 --- /dev/null +++ b/marked/Rel-16/24_series/24282/db388803c917f32f84f9ce6375dfa6b9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db35ee99c4e1f194b10cc4a28911728f475c9e2b231d11abccad1c9510561f8e +size 21298 diff --git a/marked/Rel-16/24_series/24282/e645ed71024459749170f5d01e301b37_img.jpg b/marked/Rel-16/24_series/24282/e645ed71024459749170f5d01e301b37_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0699790c5badb9ad36821c3d15bc721a1776f87a --- /dev/null +++ b/marked/Rel-16/24_series/24282/e645ed71024459749170f5d01e301b37_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b24acc8caeb0e53d6b9fb32aa76acb15b654f885faf4e204c958d0784e400055 +size 14145 diff --git a/marked/Rel-16/24_series/24282/ecffb3397edcd774dfe391fbd05e0e75_img.jpg b/marked/Rel-16/24_series/24282/ecffb3397edcd774dfe391fbd05e0e75_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4230bafbddb288a93a4d1161d57ed152fcee2fe1 --- /dev/null +++ b/marked/Rel-16/24_series/24282/ecffb3397edcd774dfe391fbd05e0e75_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e259ed07947fdb3ca1727cca12e15ba68d70e628bd443539684d6c95d5c37472 +size 12254 diff --git a/marked/Rel-16/24_series/24282/f365adb7fff59db39a46ffb7025589ff_img.jpg b/marked/Rel-16/24_series/24282/f365adb7fff59db39a46ffb7025589ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49f66df5fd64e040363a6d8061b5d9eea96393e5 --- /dev/null +++ b/marked/Rel-16/24_series/24282/f365adb7fff59db39a46ffb7025589ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf76865882960316bb667d753adc37b8dc08a75cd4c4a943589520ced61a6b0c +size 8392 diff --git a/marked/Rel-16/24_series/24282/raw.md b/marked/Rel-16/24_series/24282/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d49b075d2dc67a60f72ae4bc9042d28a23387be1 --- /dev/null +++ b/marked/Rel-16/24_series/24282/raw.md @@ -0,0 +1,13739 @@ + + + + +![Horizontal line separator](317e0525ef1b2458976c246876f4a948_img.jpg) + +A solid black horizontal line spanning most of the page width, acting as a section separator. + +Horizontal line separator + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------|----| +| Foreword..... | 18 | +| 1 Scope..... | 19 | +| 2 References..... | 19 | +| 3 Definitions, symbols and abbreviations..... | 22 | +| 3.1 Definitions..... | 22 | +| 3.2 Abbreviations..... | 23 | +| 4 General..... | 24 | +| 4.1 MCData overview..... | 24 | +| 4.2 Identity, URI and address assignments..... | 25 | +| 4.2.1 Public Service identities..... | 25 | +| 4.2.2 MCData session identity..... | 25 | +| 4.2.3 MCData client ID..... | 26 | +| 4.3 Pre-established sessions..... | 26 | +| 4.4 Emergency Alerts..... | 26 | +| 4.5 MCData Protocol..... | 26 | +| 4.6 Protection of sensitive XML application data..... | 26 | +| 4.7 Protection of TLV signalling and media content..... | 29 | +| 4.7A Signalling security when using MBMS..... | 30 | +| 4.8 MCData client ID..... | 31 | +| 4.9 Warning Header Field..... | 31 | +| 4.9.1 General..... | 31 | +| 4.9.2 Warning texts..... | 31 | +| 4.10 MCData emergency groups and emergency group communications..... | 33 | +| 5 Functional entities..... | 34 | +| 5.1 Introduction..... | 34 | +| 5.2 MCData client..... | 34 | +| 5.3 MCData server..... | 35 | +| 5.3.0 General..... | 35 | +| 5.3.1 SIP failure case..... | 36 | +| 5.3.2 Management of MBMS bearers..... | 36 | +| 6 Common procedures..... | 37 | +| 6.1 Introduction..... | 37 | +| 6.2 MCData client procedures..... | 37 | +| 6.2.1 Distinction of requests at the MCData client..... | 37 | +| 6.2.1.1 SIP MESSAGE request..... | 37 | +| 6.2.1.2 SIP INVITE request..... | 38 | +| 6.2.2 MCData conversation items..... | 38 | +| 6.2.2.1 Generating an SDS Message..... | 38 | +| 6.2.2.2 Generating an FD Message for FD using HTTP..... | 40 | +| 6.2.2.3 Generating an FD Message for FD using media plane..... | 40 | +| 6.2.2.4 Client generating message to terminate FD over HTTP..... | 41 | +| 6.2.3 Disposition Notifications..... | 42 | +| 6.2.3.1 Generating an SDS Notification..... | 42 | +| 6.2.3.2 Generating an FD Notification..... | 42 | +| 6.2.4 Sending SIP requests and receiving SIP responses..... | 43 | +| 6.2.4.1 Generating a SIP MESSAGE request towards the originating participating MCData function..... | 43 | +| 6.2.5 Location information..... | 44 | +| 6.2.5.1 Location information for location reporting..... | 44 | +| 6.3 MCData server procedures..... | 44 | +| 6.3.1 Distinction of requests at the MCData server..... | 44 | +| 6.3.1.1 SIP MESSAGE request..... | 44 | +| 6.3.1.2 SIP INVITE request..... | 46 | +| 6.3.2 Sending SIP requests and receiving SIP responses..... | 48 | +| 6.3.2.1 Generating a SIP MESSAGE request towards the terminating MCData client..... | 48 | + +| | | | +|-----------|----------------------------------------------------------------------------------------------------------------------|----| +| 6.3.3 | Retrieving a group document..... | 48 | +| 6.3.4 | Determining targeted group members for MCData communications..... | 48 | +| 6.3.5 | Affiliation check..... | 49 | +| 6.3.6 | MCData conversation items..... | 49 | +| 6.3.6.1 | Server generating a FD HTTP TERMINATION message for FD over HTTP..... | 49 | +| 6.3.7 | Procedures referenceable from other procedures..... | 49 | +| 6.3.7.1 | Emergency alert and emergency communications procedures..... | 49 | +| 6.3.7.1.1 | Sending a SIP re-INVITE request for MCData emergency alert or emergency group communication..... | 49 | +| 6.3.7.1.2 | Generating a SIP MESSAGE request for notification of in-progress emergency status change..... | 50 | +| 6.3.7.1.3 | Populate mcdata-info and location-info MIME bodies for emergency alert..... | 51 | +| 6.3.7.1.4 | Retrieving Resource-Priority header field values for emergency communications..... | 51 | +| 6.3.7.1.5 | Generating a SIP MESSAGE request to indicate successful receipt of an emergency alert or emergency cancellation..... | 52 | +| 6.3.7.2 | Authorisations..... | 52 | +| 6.3.7.2.1 | Determining authorisation for initiating an MCData emergency alert..... | 52 | +| 6.3.7.2.2 | Determining authorisation for cancelling an MCData emergency alert..... | 53 | +| 6.3.7.2.3 | Determining authorisation for cancelling an MCData emergency communication..... | 53 | +| 6.4 | Handling of MIME bodies in a SIP message..... | 54 | +| 6.5 | Confidentiality and Integrity Protection of sensitive XML content..... | 55 | +| 6.5.1 | General..... | 55 | +| 6.5.1.1 | Applicability and exclusions..... | 55 | +| 6.5.1.2 | Performing XML content encryption..... | 55 | +| 6.5.1.3 | Performing integrity protection on an XML body..... | 55 | +| 6.5.1.4 | Verifying integrity of an XML body and decrypting XML elements..... | 55 | +| 6.5.2 | Confidentiality Protection..... | 56 | +| 6.5.2.1 | General..... | 56 | +| 6.5.2.2 | Keys used in confidentiality protection procedures..... | 56 | +| 6.5.2.3 | Procedures for sending confidentiality protected content..... | 56 | +| 6.5.2.3.1 | MCData client..... | 56 | +| 6.5.2.3.2 | MCData server..... | 56 | +| 6.5.2.3.3 | Content Encryption in XML elements..... | 57 | +| 6.5.2.3.4 | Attribute URI Encryption..... | 57 | +| 6.5.2.4 | Procedures for receiving confidentiality protected content..... | 57 | +| 6.5.2.4.1 | Determination of confidentiality protected content..... | 57 | +| 6.5.2.4.2 | Decrypting confidentiality protected content in XML elements..... | 58 | +| 6.5.2.4.3 | Decrypting confidentiality protected URIs in XML attributes..... | 58 | +| 6.5.2.5 | MCData server copying received XML content..... | 58 | +| 6.5.3 | Integrity Protection of XML documents..... | 59 | +| 6.5.3.1 | General..... | 59 | +| 6.5.3.2 | Keys used in integrity protection procedures..... | 60 | +| 6.5.3.3 | Sending integrity protected content..... | 61 | +| 6.5.3.3.1 | MCData client..... | 61 | +| 6.5.3.3.2 | MCData server..... | 61 | +| 6.5.3.3.3 | Integrity protection procedure..... | 61 | +| 6.5.3.4 | Receiving integrity protected content..... | 62 | +| 6.5.3.4.1 | Determination of integrity protected content..... | 62 | +| 6.5.3.4.2 | Verification of integrity protected content..... | 62 | +| 6.6 | Confidentiality and Integrity Protection of TLV messages..... | 62 | +| 6.6.1 | General..... | 62 | +| 6.6.2 | Derivation of master keys for media and media control..... | 63 | +| 6.6.3 | Protection of MCData Data signalling and MCData Data messages..... | 64 | +| 6.6.3.1 | General..... | 64 | +| 6.6.3.2 | The MCData client..... | 64 | +| 6.6.3.3 | The participating MCData function..... | 64 | +| 6.6.3.4 | The controlling MCData function..... | 64 | +| 7 | Registration and service authorisation..... | 65 | +| 7.1 | General..... | 65 | +| 7.2 | MCData client procedures..... | 65 | +| 7.2.1 | SIP REGISTER request for service authorisation..... | 65 | +| 7.2.1AA | SIP REGISTER request without service authorisation..... | 67 | + +| | | | +|----------|----------------------------------------------------------------------------------------------------------------|-----| +| 7.2.1A | Common SIP PUBLISH procedure..... | 67 | +| 7.2.2 | SIP PUBLISH request for service authorisation and MCData service settings..... | 67 | +| 7.2.3 | Sending SIP PUBLISH for MCData service settings only..... | 68 | +| 7.2.4 | Determination of MCData service settings..... | 69 | +| 7.2.5 | Receiving a CSK key download message..... | 70 | +| 7.3 | MCData server procedures..... | 71 | +| 7.3.1 | General..... | 71 | +| 7.3.1A | Confidentiality and Integrity Protection..... | 71 | +| 7.3.2 | SIP REGISTER request for service authorisation..... | 73 | +| 7.3.3 | SIP PUBLISH request for service authorisation and service settings..... | 73 | +| 7.3.4 | Receiving SIP PUBLISH request for MCData service settings only..... | 75 | +| 7.3.5 | Receiving SIP PUBLISH request with "Expires=0"..... | 76 | +| 7.3.6 | Subscription to and notification of MCData service settings..... | 76 | +| 7.3.6.1 | Receiving subscription to MCData service settings..... | 76 | +| 7.3.6.2 | Sending notification of change of MCData service settings..... | 76 | +| 7.3.7 | Sending a CSK key download message..... | 77 | +| 8 | Affiliation..... | 77 | +| 8.1 | General..... | 77 | +| 8.2 | MCData client procedures..... | 78 | +| 8.2.1 | General..... | 78 | +| 8.2.2 | Affiliation status change procedure..... | 78 | +| 8.2.3 | Affiliation status determination procedure..... | 79 | +| 8.2.4 | Procedure for sending affiliation status change request in negotiated mode to target MCData user..... | 80 | +| 8.2.5 | Procedure for receiving affiliation status change request in negotiated mode from authorized MCData user..... | 80 | +| 8.2.6 | Rules based affiliation status change procedure..... | 81 | +| 8.3 | MCData server procedures..... | 81 | +| 8.3.1 | General..... | 81 | +| 8.3.2 | Procedures of MCData server serving the MCData user..... | 81 | +| 8.3.2.1 | General..... | 81 | +| 8.3.2.2 | Stored information..... | 82 | +| 8.3.2.3 | Receiving affiliation status change from MCData client procedure..... | 82 | +| 8.3.2.4 | Receiving subscription to affiliation status procedure..... | 85 | +| 8.3.2.5 | Sending notification of change of affiliation status procedure..... | 86 | +| 8.3.2.6 | Sending affiliation status change towards MCData server owning MCData group procedure..... | 87 | +| 8.3.2.7 | Affiliation status determination from MCData server owning MCData group procedure..... | 88 | +| 8.3.2.8 | Procedure for authorizing affiliation status change request in negotiated mode sent to served MCData user..... | 90 | +| 8.3.2.9 | Forwarding affiliation status change towards another MCData user procedure..... | 91 | +| 8.3.2.10 | Forwarding subscription to affiliation status towards another MCData user procedure..... | 92 | +| 8.3.2.11 | Affiliation status determination..... | 92 | +| 8.3.2.12 | Affiliation status change by implicit affiliation..... | 93 | +| 8.3.2.13 | Implicit affiliation status change completion..... | 94 | +| 8.3.2.14 | Implicit affiliation status change cancellation..... | 94 | +| 8.3.2.15 | Implicit affiliation to configured groups procedure..... | 95 | +| 8.3.3 | Procedures of MCData server owning the MCData group..... | 96 | +| 8.3.3.1 | General..... | 96 | +| 8.3.3.2 | Stored information..... | 97 | +| 8.3.3.3 | Receiving group affiliation status change procedure..... | 97 | +| 8.3.3.4 | Receiving subscription to affiliation status procedure..... | 99 | +| 8.3.3.5 | Sending notification of change of affiliation status procedure..... | 99 | +| 8.3.3.6 | Implicit affiliation eligibility check procedure..... | 100 | +| 8.3.3.7 | Affiliation status change by implicit affiliation procedure..... | 100 | +| 8.4 | Coding..... | 101 | +| 8.4.1 | Extension of application/pidf+xml MIME type..... | 101 | +| 8.4.1.1 | Introduction..... | 101 | +| 8.4.1.2 | Syntax..... | 101 | +| 8.4.2 | Extension of application/simple-filter+xml MIME type..... | 103 | +| 8.4.2.1 | Introduction..... | 103 | +| 8.4.2.2 | Syntax..... | 103 | + +| | | | +|-----------|----------------------------------------------------------------------------------------------------|-----| +| 9 | Short Data Service (SDS)..... | 104 | +| 9.1 | General..... | 104 | +| 9.2 | On-network SDS..... | 105 | +| 9.2.1 | General..... | 105 | +| 9.2.1.1 | Sending an SDS message..... | 105 | +| 9.2.1.2 | Handling of received SDS messages with or without disposition requests..... | 105 | +| 9.2.1.3 | Handling of disposition requests..... | 107 | +| 9.2.2 | Standalone SDS using signalling control plane..... | 107 | +| 9.2.2.1 | General..... | 107 | +| 9.2.2.2 | MCData client procedures..... | 107 | +| 9.2.2.2.1 | MCData client originating procedures..... | 107 | +| 9.2.2.2.2 | MCData client terminating procedures..... | 108 | +| 9.2.2.3 | Participating MCData function procedures..... | 109 | +| 9.2.2.3.1 | Originating participating MCData function procedures..... | 109 | +| 9.2.2.3.2 | Terminating participating MCData function procedures..... | 111 | +| 9.2.2.4 | Controlling MCData function procedures..... | 112 | +| 9.2.2.4.1 | Originating controlling MCData function procedures..... | 112 | +| 9.2.2.4.2 | Terminating controlling MCData function procedures..... | 112 | +| 9.2.3 | Standalone SDS using media plane..... | 114 | +| 9.2.3.1 | General..... | 114 | +| 9.2.3.2 | MCData client procedures..... | 115 | +| 9.2.3.2.1 | SDP offer generation..... | 115 | +| 9.2.3.2.2 | SDP answer generation..... | 115 | +| 9.2.3.2.3 | MCData client originating procedures..... | 115 | +| 9.2.3.2.4 | MCData client terminating procedures..... | 118 | +| 9.2.3.3 | Participating MCData function procedures..... | 119 | +| 9.2.3.3.1 | SDP offer generation..... | 119 | +| 9.2.3.3.2 | SDP answer generation..... | 119 | +| 9.2.3.3.3 | Originating participating MCData function procedures..... | 119 | +| 9.2.3.3.4 | Terminating participating MCData function procedures..... | 121 | +| 9.2.3.4 | Controlling MCData function procedures..... | 123 | +| 9.2.3.4.1 | SDP offer generation..... | 123 | +| 9.2.3.4.2 | SDP answer generation..... | 124 | +| 9.2.3.4.3 | Originating controlling MCData function procedures..... | 124 | +| 9.2.3.4.4 | Terminating controlling MCData function procedures..... | 125 | +| 9.2.4 | SDS session..... | 127 | +| 9.2.4.1 | General..... | 127 | +| 9.2.4.2 | MCData client procedures..... | 127 | +| 9.2.4.2.1 | SDP offer generation..... | 127 | +| 9.2.4.2.2 | SDP answer generation..... | 128 | +| 9.2.4.2.3 | MCData client originating procedures..... | 128 | +| 9.2.4.2.4 | MCData client terminating procedures..... | 130 | +| 9.2.4.3 | Participating MCData function procedures..... | 131 | +| 9.2.4.3.1 | SDP offer generation..... | 131 | +| 9.2.4.3.2 | SDP answer generation..... | 132 | +| 9.2.4.3.3 | Originating participating MCData function procedures..... | 132 | +| 9.2.4.3.4 | Terminating participating MCData function procedures..... | 134 | +| 9.2.4.4 | Controlling MCData function procedures..... | 136 | +| 9.2.4.4.1 | SDP offer generation..... | 136 | +| 9.2.4.4.2 | SDP answer generation..... | 136 | +| 9.2.4.4.3 | Originating controlling MCData function procedures..... | 136 | +| 9.2.4.4.4 | Terminating controlling MCData function procedures..... | 137 | +| 9.2.5 | SDS communication using pre-established session..... | 140 | +| 9.2.5.1 | Common procedure..... | 140 | +| 9.2.5.1.1 | Generating an INVITE request on receipt of a REFER request..... | 140 | +| 9.2.5.1.2 | Generating Re-INVITE request towards originating MCData client within pre-established session..... | 140 | +| 9.2.5.1.3 | Generating Re-INVITE request towards terminating MCData client within pre-established session..... | 141 | +| 9.2.5.2 | Initiating one-to-one SDS communication..... | 141 | +| 9.2.5.2.1 | MCData client procedures..... | 141 | + +| | | | +|-------------|------------------------------------------------------------------|-----| +| 9.2.5.2.1.1 | Client originating procedures..... | 141 | +| 9.2.5.2.1.2 | Client terminating procedures..... | 143 | +| 9.2.5.2.2 | Participating MCData function procedures..... | 143 | +| 9.2.5.2.2.1 | Originating procedures..... | 143 | +| 9.2.5.2.2.2 | Terminating procedures..... | 144 | +| 9.2.5.3 | Initiating group SDS communication..... | 145 | +| 9.2.5.3.1 | MCData client procedures..... | 145 | +| 9.2.5.3.1.1 | Client originating procedures..... | 145 | +| 9.2.5.3.1.2 | Client terminating procedures..... | 146 | +| 9.2.5.3.2 | Participating MCData function procedures..... | 147 | +| 9.2.5.3.2.1 | Originating procedures..... | 147 | +| 9.2.5.3.2.2 | Terminating procedures..... | 148 | +| 9.2.5.4 | Leaving SDS communication..... | 149 | +| 9.2.5.4.1 | MCData client procedures..... | 149 | +| 9.2.5.4.1.1 | Client originating procedures..... | 149 | +| 9.2.5.4.1.2 | Client terminating procedures..... | 150 | +| 9.2.5.4.2 | Participating MCData function procedures..... | 150 | +| 9.2.5.4.2.1 | Originating procedures..... | 150 | +| 9.2.5.4.2.2 | Terminating procedures..... | 151 | +| 9.2.6 | SDS session using MBMS delivery in the media plane..... | 151 | +| 9.3 | Off-network SDS..... | 151 | +| 9.3.1 | General..... | 151 | +| 9.3.1.1 | Message transport to a MCData Client..... | 151 | +| 9.3.1.2 | Message transport to a MCData Group..... | 151 | +| 9.3.2 | Standalone SDS using signalling control plane..... | 152 | +| 9.3.2.1 | General..... | 152 | +| 9.3.2.2 | Sending SDS message..... | 152 | +| 9.3.2.3 | Retransmitting SDS message..... | 153 | +| 9.3.2.4 | Receiving SDS message..... | 154 | +| 9.3.2.5 | SDS Read while TFS3 (delivery and read) is running..... | 155 | +| 9.3.2.6 | Timer TFS3 (delivery and read) expires..... | 155 | +| 10 | File Distribution (FD)..... | 155 | +| 10.1 | General..... | 155 | +| 10.2 | On-network FD..... | 155 | +| 10.2.1 | General..... | 155 | +| 10.2.1.1 | Sending an FD message..... | 155 | +| 10.2.1.2 | Handling of received FD messages..... | 156 | +| 10.2.1.2.1 | Initial processing of the received FD message..... | 156 | +| 10.2.1.2.2 | Mandatory Download..... | 156 | +| 10.2.1.2.3 | Non-Mandatory download..... | 157 | +| 10.2.1.3 | Discovery of the Absolute URI of the media storage function..... | 159 | +| 10.2.1.3.1 | General..... | 159 | +| 10.2.1.3.2 | Void..... | 159 | +| 10.2.1.3.3 | Participating MCData function procedures..... | 159 | +| 10.2.1.3.4 | Controlling MCData function procedures..... | 160 | +| 10.2.2 | File upload using HTTP..... | 162 | +| 10.2.2.1 | Media storage client procedures..... | 162 | +| 10.2.2.2 | Media storage function procedures..... | 163 | +| 10.2.3 | File download using HTTP..... | 163 | +| 10.2.3.1 | Media storage client procedures..... | 163 | +| 10.2.3.2 | Media storage function procedures..... | 164 | +| 10.2.4 | FD using HTTP..... | 164 | +| 10.2.4.1 | General..... | 164 | +| 10.2.4.2 | MCData client procedures..... | 165 | +| 10.2.4.2.1 | MCData client originating procedures..... | 165 | +| 10.2.4.2.2 | MCData client terminating procedures..... | 165 | +| 10.2.4.3 | Participating MCData function procedures..... | 166 | +| 10.2.4.3.1 | Originating participating MCData function procedures..... | 166 | +| 10.2.4.3.2 | Terminating participating MCData function procedures..... | 167 | +| 10.2.4.4 | Controlling MCData function procedures..... | 169 | +| 10.2.4.4.1 | Originating controlling MCData function procedures..... | 169 | + +| | | | +|------------|---------------------------------------------------------------------------------------------------------|-----| +| 10.2.4.4.2 | Terminating controlling MCData function procedures..... | 169 | +| 10.2.5 | FD using media plane..... | 173 | +| 10.2.5.1 | General..... | 173 | +| 10.2.5.2 | MCData client procedures..... | 173 | +| 10.2.5.2.1 | SDP offer generation..... | 173 | +| 10.2.5.2.2 | SDP answer generation..... | 174 | +| 10.2.5.2.3 | MCData client originating procedures..... | 174 | +| 10.2.5.2.4 | MCData client terminating procedures..... | 176 | +| 10.2.5.3 | Participating MCData function procedures..... | 178 | +| 10.2.5.3.1 | SDP offer generation..... | 178 | +| 10.2.5.3.2 | SDP answer generation..... | 178 | +| 10.2.5.3.3 | Originating participating MCData function procedures..... | 178 | +| 10.2.5.3.4 | Terminating participating MCData function procedures..... | 180 | +| 10.2.5.4 | Controlling MCData function procedures..... | 182 | +| 10.2.5.4.1 | SDP offer generation..... | 182 | +| 10.2.5.4.2 | SDP answer generation..... | 183 | +| 10.2.5.4.3 | Originating controlling MCData function procedures..... | 183 | +| 10.2.5.4.4 | Terminating controlling MCData function procedures..... | 184 | +| 11 | Transmission and Reception Control..... | 187 | +| 11.1 | General..... | 187 | +| 11.2 | Auto-receive for File Distribution..... | 189 | +| 11.3 | Accessing list of deferred data group communications..... | 189 | +| 11.3.1 | General..... | 189 | +| 11.3.2 | MCData client procedures..... | 189 | +| 11.3.2.1 | Sending a request to access a list of deferred group communications..... | 189 | +| 11.3.2.2 | Receiving a list of deferred group communications..... | 189 | +| 11.3.3 | Participating MCData function procedures..... | 190 | +| 11.3.3.1 | Receiving a request to access a list of deferred group communications..... | 190 | +| 11.3.3.2 | Sending a list of deferred group communications..... | 190 | +| 12 | Dispositions and Notifications..... | 190 | +| 12.1 | General..... | 190 | +| 12.2 | On-network disposition notifications..... | 191 | +| 12.2.1 | MCData client procedures..... | 191 | +| 12.2.1.1 | MCData client sends a disposition notification message..... | 191 | +| 12.2.1.2 | MCData client receives a disposition notification message..... | 191 | +| 12.2.2 | Participating MCData function procedures..... | 192 | +| 12.2.2.1 | Participating MCData function receives disposition notification from a MCData user..... | 192 | +| 12.2.2.2 | Participating MCData function receives disposition notification from a Controlling MCData function..... | 193 | +| 12.2.3 | Controlling MCData function procedures..... | 194 | +| 12.3 | Off-network dispositions..... | 196 | +| 12.3.1 | General..... | 196 | +| 12.3.2 | Sending off-network SDS delivery notification..... | 196 | +| 12.3.3 | Sending off-network SDS read notification..... | 197 | +| 12.3.4 | Sending off-network SDS delivered and read notification..... | 197 | +| 12.3.5 | Off-network SDS notification retransmission..... | 198 | +| 12.4 | Network-triggered notifications for FD..... | 198 | +| 12.4.1 | General..... | 198 | +| 12.4.1.1 | File availability expiry..... | 198 | +| 12.4.2 | Controlling MCData function procedures..... | 199 | +| 12.4.2.1 | Generation of a SIP MESSAGE request for notification..... | 199 | +| 12.4.2.2 | Expiry of timer TDC2 (file availability timer)..... | 199 | +| 12.4.3 | Participating MCData function procedures..... | 200 | +| 12.4.4 | MCData client terminating procedures..... | 200 | +| 13 | Communication Release..... | 200 | +| 13.1 | General..... | 200 | +| 13.2 | On-network..... | 200 | +| 13.2.1 | General..... | 200 | + +| | | | +|----------------|-------------------------------------------------------------------------------------------------------------|-----| +| 13.2.1.1 | Server generating message for release of communication over HTTP towards participating MCData function..... | 200 | +| 13.2.1.2 | Authorised user generating FD HTTP TERMINATION MESSAGE towards participating MCData function..... | 201 | +| 13.2.2 | MCData originating user initiated communication release..... | 202 | +| 13.2.2.1 | General..... | 202 | +| 13.2.2.2 | Release of MCData communication over media plane..... | 202 | +| 13.2.2.2.1 | General..... | 202 | +| 13.2.2.2.2 | MCData client procedures..... | 202 | +| 13.2.2.2.2.1 | MCData client originating procedures..... | 202 | +| 13.2.2.2.2.2 | MCData client terminating procedures..... | 202 | +| 13.2.2.2.3 | Participating MCData function procedures..... | 202 | +| 13.2.2.2.3.1 | Originating participating MCData function procedures..... | 202 | +| 13.2.2.2.3.2 | Terminating participating MCData function procedures..... | 203 | +| 13.2.2.2.4 | Controlling MCData function procedures..... | 203 | +| 13.2.2.2.4.1 | Communication release policy for group MCData communication..... | 203 | +| 13.2.2.2.4.2 | Communication release policy for one-to-one MCData communication..... | 203 | +| 13.2.2.2.4.3 | Receiving a SIP BYE request..... | 203 | +| 13.2.2.2.4.4 | Sending a SIP BYE request..... | 204 | +| 13.2.2.3 | Release of MCData communication over HTTP..... | 204 | +| 13.2.2.3.1 | General..... | 204 | +| 13.2.2.3.2 | MCData client procedures..... | 204 | +| 13.2.2.3.2.1 | MCData client originating procedures..... | 204 | +| 13.2.2.3.2.1.1 | Initiating Release..... | 204 | +| 13.2.2.3.2.1.2 | Receiving Release Response Type from server..... | 205 | +| 13.2.2.3.2.2 | MCData client terminating procedures..... | 205 | +| 13.2.2.3.3 | Participating MCData function procedures..... | 205 | +| 13.2.2.3.3.1 | Originating participating MCData function procedures..... | 205 | +| 13.2.2.3.3.2 | Terminating participating MCData function procedures..... | 205 | +| 13.2.2.3.4 | Controlling MCData function procedures..... | 205 | +| 13.2.3 | MCData server initiated communication release without prior indication..... | 206 | +| 13.2.3.1 | General..... | 206 | +| 13.2.3.2 | Release of MCData communication over media plane..... | 206 | +| 13.2.3.2.1 | General..... | 206 | +| 13.2.3.2.2 | MCData client procedures..... | 206 | +| 13.2.3.2.3 | Participating MCData function procedures..... | 206 | +| 13.2.3.2.4 | Controlling MCData function procedures..... | 206 | +| 13.2.3.3 | Release of MCData communication over HTTP..... | 206 | +| 13.2.3.3.1 | General..... | 206 | +| 13.2.3.3.2 | MCData client procedures..... | 206 | +| 13.2.3.3.2.1 | MCData client originating procedure..... | 206 | +| 13.2.3.3.2.2 | MCData client terminating procedure..... | 207 | +| 13.2.3.3.3 | Participating MCData function procedures..... | 207 | +| 13.2.3.3.4 | Controlling MCData function procedures..... | 207 | +| 13.2.4 | MCData server initiated communication release with prior indication..... | 207 | +| 13.2.4.1 | General..... | 207 | +| 13.2.4.2 | MCData client procedures for communication over media plane..... | 207 | +| 13.2.4.2.1 | Receiving intent to release the communication..... | 207 | +| 13.2.4.2.2 | Request for extension of communication..... | 208 | +| 13.2.4.2.3 | Receiving response to communication extension request..... | 208 | +| 13.2.4.3 | Participating MCData function procedures for communication over media plane..... | 209 | +| 13.2.4.3.1 | Receiving SIP INFO request from the controlling MCData function..... | 209 | +| 13.2.4.3.2 | Receiving SIP INFO request from the MCData client..... | 209 | +| 13.2.4.4 | Controlling MCData function procedures for communication over media plane..... | 210 | +| 13.2.4.4.1 | Sending intent to release a communication..... | 210 | +| 13.2.4.4.2 | Receiving more information..... | 210 | +| 13.2.4.4.3 | Receiving request for extension of communication..... | 210 | +| 13.2.4.4.4 | Sending response to communication extension request..... | 211 | +| 13.2.4.5 | Release of MCData communication over HTTP..... | 211 | +| 13.2.4.5.1 | General..... | 211 | +| 13.2.4.5.2 | MCData client procedures..... | 211 | + +| | | | +|--------------|--------------------------------------------------------------------------------------|-----| +| 13.2.4.5.2.1 | Receiving intent to release the communication..... | 211 | +| 13.2.4.5.2.2 | Request for extension of communication..... | 212 | +| 13.2.4.5.2.3 | Receiving response to communication extension request..... | 212 | +| 13.2.4.5.3 | Participating MCData function procedures..... | 212 | +| 13.2.4.5.3.1 | Originating participating MCData function procedures..... | 212 | +| 13.2.4.5.3.2 | Terminating participating MCData function procedures..... | 213 | +| 13.2.4.5.4 | Controlling MCData function procedures..... | 213 | +| 13.2.4.5.4.1 | Sending intent to release a communication..... | 213 | +| 13.2.4.5.4.2 | Receiving request for extension of communication..... | 213 | +| 13.2.4.5.4.3 | Sending response to communication extension request..... | 213 | +| 13.2.5 | Authorized MCData user initiated communication release without prior indication..... | 214 | +| 13.2.5.1 | General..... | 214 | +| 13.2.5.2 | Release of MCData communication over media plane..... | 214 | +| 13.2.5.2.1 | General..... | 214 | +| 13.2.5.2.2 | Authorized MCData client procedures..... | 214 | +| 13.2.5.2.2.1 | Sending communication release request..... | 214 | +| 13.2.5.2.3 | Participating MCData function procedures..... | 215 | +| 13.2.5.2.3.1 | Receiving SIP INFO request from the authorized MCData client..... | 215 | +| 13.2.5.2.4 | Controlling MCData function procedures..... | 215 | +| 13.2.5.2.4.1 | Receiving request to release the communication from authorized MCData user..... | 215 | +| 13.2.5.3 | Release of MCData communication over HTTP..... | 215 | +| 13.2.5.3.1 | General..... | 215 | +| 13.2.5.3.2 | Authorized MCData client procedures..... | 216 | +| 13.2.5.3.2.1 | Sending communication release request..... | 216 | +| 13.2.5.3.2.2 | Receiving Release Response Type from server..... | 216 | +| 13.2.5.3.3 | Participating MCData function procedures..... | 216 | +| 13.2.5.3.3.1 | Originating participating MCData function procedures..... | 216 | +| 13.2.5.3.3.2 | Terminating participating MCData function procedures..... | 216 | +| 13.2.5.3.4 | Controlling MCData function procedures..... | 216 | +| 13.2.5.3.4.1 | Receiving request to release the communication from authorized MCData user..... | 216 | +| 13.2.6 | Authorized MCData user initiated communication release with prior indication..... | 217 | +| 13.2.6.1 | General..... | 217 | +| 13.2.6.2 | Release of MCData communication over media plane..... | 217 | +| 13.2.6.2.1 | General..... | 217 | +| 13.2.6.2.2 | Authorized MCData client procedures..... | 217 | +| 13.2.6.2.2.1 | Sending intent to release a communication..... | 217 | +| 13.2.6.2.2.2 | Receiving more information..... | 218 | +| 13.2.6.2.2.3 | Receiving request for extension of communication..... | 218 | +| 13.2.6.2.2.4 | Sending response to communication extension request..... | 219 | +| 13.2.6.2.3 | Participating MCData function procedures..... | 219 | +| 13.2.6.2.3.1 | Receiving SIP INFO request from the authorized MCData client..... | 219 | +| 13.2.6.2.3.2 | Receiving SIP INFO request from the controlling MCData function..... | 219 | +| 13.2.6.2.4 | Controlling MCData function procedures..... | 220 | +| 13.2.6.2.4.1 | Receiving request to release the communication from authorized MCData user..... | 220 | +| 13.2.6.2.4.2 | Receiving more information..... | 220 | +| 13.2.6.2.4.3 | Receiving request for extension of communication..... | 221 | +| 13.2.6.2.4.4 | Receiving response to communication extension request..... | 221 | +| 13.2.6.3 | Release of MCData communication over HTTP..... | 222 | +| 13.2.6.3.1 | General..... | 222 | +| 13.2.6.3.2 | Authorized MCData client procedures..... | 222 | +| 13.2.6.3.2.1 | Sending intent to release a communication..... | 222 | +| 13.2.6.3.2.2 | Receiving request for extension of communication..... | 222 | +| 13.2.6.3.2.3 | Sending response to communication extension request..... | 223 | +| 13.2.6.3.2.4 | Receiving Release Response from server..... | 223 | +| 13.2.6.3.3 | Participating MCData function procedures..... | 223 | +| 13.2.6.3.3.1 | Originating participating MCData function procedures..... | 223 | +| 13.2.6.3.3.2 | Terminating participating MCData function procedures..... | 223 | +| 13.2.6.3.4 | Controlling MCData function procedures..... | 223 | +| 13.2.6.3.4.1 | Receiving request to release the communication from authorized MCData user..... | 223 | +| 13.2.6.3.4.2 | Receiving request for extension of communication..... | 224 | +| 13.2.6.3.4.3 | Receiving response to communication extension request..... | 224 | + +| | | | +|-----------|-------------------------------------------------------------|-----| +| 14. | Enhanced Status (ES)..... | 225 | +| 14.1 | General..... | 225 | +| 14.2 | On-network ES..... | 225 | +| 14.2.1 | MCData client procedures..... | 225 | +| 14.2.1.1 | MCData client originating procedures..... | 225 | +| 14.2.1.2 | MCData client terminating procedures..... | 225 | +| 14.2.2 | Participating MCData function procedures..... | 226 | +| 14.2.2.1 | Originating participating MCData function procedures..... | 226 | +| 14.2.2.2 | Terminating participating MCData function procedures..... | 226 | +| 14.2.3 | Controlling MCData function procedures..... | 226 | +| 14.2.3.1 | Originating controlling MCData function procedures..... | 226 | +| 14.2.3.2 | Terminating controlling MCData function procedures..... | 226 | +| 14.3 | Off-network ES..... | 226 | +| 14.3.1 | Sending enhanced status message..... | 226 | +| 14.3.2 | Receiving enhanced status message..... | 226 | +| 15 | Message Formats..... | 227 | +| 15.1 | MCData message functional definitions and contents..... | 227 | +| 15.1.1 | General..... | 227 | +| 15.1.2 | SDS SIGNALLING PAYLOAD message..... | 227 | +| 15.1.2.1 | Message definition..... | 227 | +| 15.1.3 | FD SIGNALLING PAYLOAD message..... | 227 | +| 15.1.3.1 | Message definition..... | 227 | +| 15.1.4 | DATA PAYLOAD message..... | 228 | +| 15.1.4.1 | Message definition..... | 228 | +| 15.1.5 | SDS NOTIFICATION message..... | 229 | +| 15.1.5.1 | Message definition..... | 229 | +| 15.1.6 | FD NOTIFICATION message..... | 229 | +| 15.1.6.1 | Message definition..... | 229 | +| 15.1.7 | SDS OFF-NETWORK MESSAGE message..... | 230 | +| 15.1.7.1 | Message definition..... | 230 | +| 15.1.8 | SDS OFF-NETWORK NOTIFICATION message..... | 231 | +| 15.1.8.1 | Message definition..... | 231 | +| 15.1.9 | FD NETWORK NOTIFICATION message..... | 232 | +| 15.1.9.1 | Message definition..... | 232 | +| 15.1.10 | COMMUNICATION RELEASE message..... | 232 | +| 15.1.10.1 | Message definition..... | 232 | +| 15.1.11 | DEFERRED DATA REQUEST message..... | 233 | +| 15.1.11.1 | Message definition..... | 233 | +| 15.1.12 | DEFERRED DATA RESPONSE message..... | 233 | +| 15.1.12.1 | Message definition..... | 233 | +| 15.1.13 | FD HTTP TERMINATION..... | 234 | +| 15.1.13.1 | Message definition..... | 234 | +| 15.1.14 | GROUP EMERGENCY ALERT message..... | 234 | +| 15.1.14.1 | Message definition..... | 234 | +| 15.1.15 | GROUP EMERGENCY ALERT ACK message..... | 235 | +| 15.1.15.1 | Message definition..... | 235 | +| 15.1.16 | GROUP EMERGENCY ALERT CANCEL message..... | 235 | +| 15.1.16.1 | Message definition..... | 235 | +| 15.1.17 | GROUP EMERGENCY ALERT CANCEL ACK message..... | 235 | +| 15.1.17.1 | Message definition..... | 235 | +| 15.2 | General message format and information elements coding..... | 236 | +| 15.2.1 | General..... | 236 | +| 15.2.2 | Message type..... | 236 | +| 15.2.3 | SDS disposition request type..... | 237 | +| 15.2.4 | FD disposition request type..... | 238 | +| 15.2.5 | SDS disposition notification type..... | 238 | +| 15.2.6 | FD disposition notification type..... | 238 | +| 15.2.7 | Application ID..... | 239 | +| 15.2.8 | Date and time..... | 239 | +| 15.2.9 | Conversation ID..... | 239 | + +| | | | +|------------|------------------------------------------------------------------------------------------------|-----| +| 15.2.10 | Message ID..... | 240 | +| 15.2.11 | InReplyTo message ID..... | 240 | +| 15.2.12 | Number of payloads..... | 240 | +| 15.2.13 | Payload..... | 241 | +| 15.2.14 | MCData group ID..... | 242 | +| 15.2.15 | MCData user ID..... | 242 | +| 15.2.16 | Mandatory download..... | 243 | +| 15.2.17 | Metadata..... | 243 | +| 15.2.18 | Notification type..... | 244 | +| 15.2.19 | Data query type..... | 244 | +| 15.2.20 | Comm release Information type..... | 245 | +| 15.2.21 | Extension response type..... | 245 | +| 15.2.22 | Termination Information type..... | 246 | +| 15.2.23 | Release Response Type..... | 246 | +| 15.2.24 | Extended application ID..... | 247 | +| 15.2.25 | User location..... | 247 | +| 15.2.26 | Organization name..... | 248 | +| 16 | Emergency Alert..... | 248 | +| 16.1 | General..... | 248 | +| 16.2 | On-network emergency alert..... | 249 | +| 16.2.1 | Client procedures..... | 249 | +| 16.2.1.1 | Emergency alert origination..... | 249 | +| 16.2.1.2 | Emergency alert cancellation..... | 250 | +| 16.2.1.3 | MCData client receives an MCData emergency alert or communication notification..... | 251 | +| 16.2.2 | Participating MCData function procedures..... | 253 | +| 16.2.2.1 | Receipt of a SIP MESSAGE request for emergency notification from the served MCData client..... | 253 | +| 16.2.2.2 | Receipt of a SIP MESSAGE request for emergency notification for terminating MCData client..... | 254 | +| 16.2.2.3 | Receipt of a SIP MESSAGE request indicating successful delivery of emergency notification..... | 255 | +| 16.2.3 | Controlling MCData function procedures..... | 256 | +| 16.2.3.1 | Handling of a SIP MESSAGE request for emergency notification..... | 256 | +| 16.2.3.2 | Handling of a SIP MESSAGE request for emergency alert cancellation..... | 257 | +| 16.3 | Off-network emergency alert..... | 260 | +| 16.3.1 | General..... | 260 | +| 16.3.2 | Basic state machine..... | 260 | +| 16.3.2.1 | General..... | 260 | +| 16.3.2.2 | Emergency alert state machine..... | 260 | +| 16.3.2.3 | Emergency alert states..... | 261 | +| 16.3.2.3.1 | E1: Not in emergency state..... | 261 | +| 16.3.2.3.2 | E2: Emergency state..... | 261 | +| 16.3.3 | Procedures..... | 261 | +| 16.3.3.1 | Originating user sending emergency alert..... | 261 | +| 16.3.3.2 | Emergency alert retransmission..... | 261 | +| 16.3.3.3 | Terminating user receiving emergency alert..... | 262 | +| 16.3.3.4 | Terminating user receiving retransmitted emergency alert..... | 262 | +| 16.3.3.5 | Originating user cancels emergency alert..... | 262 | +| 16.3.3.6 | Terminating user receives GROUP EMERGENCY ALERT CANCEL message..... | 263 | +| 16.3.3.7 | Implicit emergency alert cancel..... | 263 | +| 17 | Location procedures..... | 263 | +| 17.1 | General..... | 263 | +| 17.2 | Participating MCData function location procedures..... | 263 | +| 17.2.1 | General..... | 263 | +| 17.2.2 | Location reporting configuration..... | 264 | +| 17.2.3 | Location information request..... | 264 | +| 17.2.4 | Location information report..... | 264 | +| 17.2.5 | Abnormal cases..... | 265 | +| 17.3 | MCData client location procedures..... | 265 | +| 17.3.1 | General..... | 265 | +| 17.3.2 | Location reporting configuration..... | 265 | +| 17.3.3 | Location information request..... | 266 | +| 17.3.4 | Location information report..... | 266 | + +| | | | +|------------|-----------------------------------------------------------------------------------|-----| +| 17.3.4.1 | Report triggering..... | 266 | +| 17.3.4.2 | Sending location information report..... | 266 | +| 18 | Pre-established session..... | 267 | +| 18.1 | General..... | 267 | +| 18.2 | Participating MCData function use of resource sharing..... | 267 | +| 18.3 | Pre-established session for MCData SDS communication..... | 268 | +| 18.3.1 | General..... | 268 | +| 18.3.1.1 | SDP offer generation..... | 268 | +| 18.3.1.2 | SDP answer generation..... | 268 | +| 18.3.2 | Session establishment..... | 268 | +| 18.3.2.1 | MCData client procedures..... | 268 | +| 18.3.2.2 | Participating MCData function procedures..... | 269 | +| 18.3.3 | Session release..... | 270 | +| 18.3.3.1 | MCData client procedures..... | 270 | +| 18.3.3.1.1 | MCData client initiated release..... | 270 | +| 18.3.3.1.2 | Participating MCData function initiated release..... | 270 | +| 18.3.3.2 | Participating MCData function procedures..... | 271 | +| 18.3.3.2.1 | MCData client initiated release..... | 271 | +| 18.3.3.2.2 | Participating MCData function initiated release..... | 271 | +| 18.3.4 | Session modification..... | 272 | +| 18.3.4.1 | MCData client procedures..... | 272 | +| 18.3.4.1.1 | MCData client initiated..... | 272 | +| 18.3.4.1.2 | MCData client receives SIP UPDATE or SIP re-INVITE request..... | 272 | +| 18.3.4.2 | Participating MCData function procedures..... | 272 | +| 18.3.4.2.1 | Reception of a SIP UPDATE or SIP re-INVITE request from served MCData client..... | 272 | +| 18.3.4.2.2 | Participating MCData function initiated..... | 273 | +| 19 | MBMS transmission usage procedure..... | 273 | +| 19.1 | General..... | 273 | +| 19.2 | Participating MCData function MBMS usage procedures..... | 273 | +| 19.2.1 | General..... | 273 | +| 19.2.2 | Sending MBMS bearer announcement procedures..... | 274 | +| 19.2.2.1 | General..... | 274 | +| 19.2.2.2 | Sending an initial MBMS bearer announcement procedure..... | 274 | +| 19.2.2.3 | Updating an announcement..... | 276 | +| 19.2.2.4 | Cancelling an MBMS bearer announcement..... | 277 | +| 19.2.2.5 | Sending a MuSiK download message..... | 277 | +| 19.2.3 | Receiving an MBMS bearer listening status from an MCData client..... | 278 | +| 19.2.4 | Abnormal cases..... | 279 | +| 19.3 | MCData client MBMS usage procedures..... | 279 | +| 19.3.1 | General..... | 279 | +| 19.3.2 | Receiving an MBMS bearer announcement..... | 279 | +| 19.3.3 | The MBMS bearer listening status and suspension report procedures..... | 281 | +| 19.3.3.1 | Conditions for sending an MBMS listening status report..... | 281 | +| 19.3.3.2 | Sending the MBMS bearer listening or suspension status report..... | 282 | +| 19.3.4 | Receiving a MuSiK download message..... | 284 | +| 20 | IP Connectivity..... | 285 | +| 20.1 | General..... | 285 | +| 20.1.1 | MC Data client SDP offer/answer generation..... | 285 | +| 20.1.2 | MC Data participating server SDP offer/answer generation..... | 285 | +| 20.1.3 | MC Data controlling server SDP offer/answer generation..... | 286 | +| 20.2 | MCData Client Procedures..... | 286 | +| 20.2.1 | MCData client originating procedures..... | 286 | +| 20.2.2 | MCData client terminating procedures..... | 287 | +| 20.3 | Participating MCData function procedures..... | 288 | +| 20.3.1 | Originating participating MCData function procedures..... | 288 | +| 20.3.2 | Terminating participating MCData function procedures..... | 290 | +| 20.4 | Controlling MCData function procedures..... | 291 | +| 20.4.1 | Originating procedures..... | 291 | +| 20.4.2 | Terminating procedures..... | 292 | + +| | | | +|------------|-----------------------------------------------------------|-----| +| 21 | MCData Message Store..... | 294 | +| 21.1 | General..... | 294 | +| 21.2 | MCData message store functions and client procedures..... | 294 | +| 21.2.1 | Object retrieval procedure..... | 294 | +| 21.2.1.1 | Message store client procedures..... | 294 | +| 21.2.1.2 | Message store function procedures..... | 295 | +| 21.2.2 | Object search procedure..... | 295 | +| 21.2.2.1 | Message store client procedures..... | 295 | +| 21.2.2.2 | Message store function procedures..... | 295 | +| 21.2.3 | Update object(s) procedure..... | 295 | +| 21.2.3.1 | Message store client procedures..... | 295 | +| 21.2.3.2 | Message store function procedures..... | 296 | +| 21.2.4 | Delete stored object(s) procedure..... | 296 | +| 21.2.4.1 | Message store client procedures..... | 296 | +| 21.2.4.2 | Message store function procedures..... | 296 | +| 21.2.5 | Void..... | 297 | +| 21.2.5A | Deposit an object..... | 297 | +| 21.2.5A.1 | MCData server procedures..... | 297 | +| 21.2.5A.2 | Message store function procedures..... | 297 | +| 21.2.6 | Object and folder copy procedure..... | 298 | +| 21.2.6.1 | Message store client procedures..... | 298 | +| 21.2.6.2 | Message store function procedures..... | 298 | +| 21.2.7 | Deleting a folder procedure..... | 298 | +| 21.2.7.1 | Message store client procedures..... | 298 | +| 21.2.7.2 | Message store function procedures..... | 298 | +| 21.2.8 | Create a folder procedure..... | 299 | +| 21.2.8.1 | Message store client procedures..... | 299 | +| 21.2.8.2 | Message store function procedures..... | 299 | +| 21.2.9 | void..... | 299 | +| 21.2.10 | Moving object(s) and folder(s) procedure..... | 299 | +| 21.2.10.1 | Message store client procedures..... | 299 | +| 21.2.10.2 | Message store function procedures..... | 300 | +| 21.2.11 | Folder search procedure..... | 300 | +| 21.2.11.1 | Message store client procedures..... | 300 | +| 21.2.11.2 | Message store function procedures..... | 300 | +| 21.2.12 | Void..... | 301 | +| 21.2.12A | Create a subscription to notifications..... | 301 | +| 21.2.12A.1 | Message store client procedures..... | 301 | +| 21.2.12A.2 | Message store function procedures..... | 301 | +| 21.2.13 | Void..... | 301 | +| 21.2.13A | Delete a subscription to notifications..... | 301 | +| 21.2.13A.1 | Message store client procedures..... | 301 | +| 21.2.13A.2 | Message store function procedures..... | 302 | +| 21.2.14 | Void..... | 302 | +| 21.2.14A | Update a subscription to notifications..... | 302 | +| 21.2.14A.1 | Message store client procedures..... | 302 | +| 21.2.14A.2 | Message store function procedures..... | 302 | +| 21.2.15 | Object(s) upload procedure..... | 303 | +| 21.2.15.1 | Message store client procedures..... | 303 | +| 21.2.15.2 | Message store function procedures..... | 303 | +| 21.2.16 | Synchronization notifications..... | 303 | +| 21.2.16.1 | Message store function procedures..... | 303 | +| 21.2.16.2 | Message store client procedures..... | 304 | +| 21.2.17 | Search-based synchronization..... | 304 | +| 21.2.17.1 | Message store client procedures..... | 304 | +| 21.2.17.2 | Message store function procedures..... | 304 | +| 21.2.18 | List subfolders of a given folder..... | 304 | +| 21.2.18.1 | Message store client procedures..... | 304 | +| 21.2.18.2 | Message store function procedures..... | 305 | + +| | | | +|----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|------------| +| 22 | Functional alias..... | 305 | +| 22.1 | General..... | 305 | +| 22.2 | Procedures..... | 305 | +| 22.2.1 | MCData client procedures..... | 305 | +| 22.2.1.1 | General..... | 305 | +| 22.2.1.2 | Functional alias status change procedure..... | 305 | +| 22.2.1.3 | Functional alias status determination procedure..... | 307 | +| 22.2.1.4 | Location based functional alias status change procedure..... | 308 | +| 22.2.2 | MCData server procedures..... | 308 | +| 22.2.2.1 | General..... | 308 | +| 22.2.2.2 | Procedures of MCData server serving the MCData user..... | 308 | +| 22.2.2.2.1 | General..... | 308 | +| 22.2.2.2.2 | Stored information..... | 308 | +| 22.2.2.2.3 | Receiving functional alias status change from MCData client procedure..... | 309 | +| 22.2.2.2.4 | Receiving subscription to functional alias status procedure..... | 311 | +| 22.2.2.2.5 | Sending notification of change of functional alias status procedure..... | 312 | +| 22.2.2.2.6 | Sending functional alias status change towards MCData server owning the functional alias procedure..... | 312 | +| 22.2.2.2.7 | Functional alias status determination from MCData server owning functional alias procedure..... | 314 | +| 22.2.2.3 | Procedures of MCData server owning the functional alias..... | 316 | +| 22.2.2.3.1 | General..... | 316 | +| 22.2.2.3.2 | Stored information..... | 316 | +| 22.2.2.3.3 | Receiving functional alias status change procedure..... | 316 | +| 22.2.2.3.4 | Receiving subscription to functional alias status procedure..... | 318 | +| 22.2.2.3.5 | Sending notification of change of functional alias status procedure..... | 319 | +| 22.2.2.3.6 | Functional alias status automatic deactivation procedure..... | 319 | +| 22.3 | Coding..... | 320 | +| 22.3.1 | Extension of application/pidf+xml MIME type..... | 320 | +| 22.3.1.1 | Introduction..... | 320 | +| 22.3.1.2 | Syntax..... | 320 | +| 22.3.2 | Extension of application/simple-filter+xml MIME type..... | 322 | +| 22.3.2.1 | Introduction..... | 322 | +| 22.3.2.2 | Syntax..... | 322 | +| Annex A (informative): Signalling flows..... | | 323 | +| Annex B (normative): Media feature tags within the current document..... | | 324 | +| B.2 | Definition of media feature tag for Mission Critical Data (MCData) communications Short Data Service (SDS)..... | 324 | +| B.3 | Definition of media feature tag for Mission Critical Data (MCData) communications File Distribution (FD)..... | 324 | +| Annex C (normative): ICSI values defined within the current document..... | | 326 | +| C.2 | Definition of ICSI value for the Mission Critical Data (MCData) service..... | 326 | +| C.2.1 | URN..... | 326 | +| C.2.2 | Description..... | 326 | +| C.2.3 | Reference..... | 326 | +| C.2.4 | Contact..... | 326 | +| C.2.5 | Registration of subtype..... | 326 | +| C.2.6 | Remarks..... | 326 | +| C.3 | Definition of ICSI value for the Mission Critical Data (MCData) communications Short Data Service (SDS)..... | 327 | +| C.3.1 | URN..... | 327 | +| C.3.2 | Description..... | 327 | +| C.3.3 | Reference..... | 327 | +| C.3.4 | Contact..... | 327 | +| C.3.5 | Registration of subtype..... | 327 | +| C.3.6 | Remarks..... | 327 | + +| | | | +|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------|------------| +| C.4 | Definition of ICSI value for Mission Critical Data (MCData) communications File Distribution (FD)..... | 327 | +| C.4.1 | URN..... | 327 | +| C.4.2 | Description..... | 327 | +| C.4.3 | Reference..... | 328 | +| C.4.4 | Contact..... | 328 | +| C.4.5 | Registration of subtype..... | 328 | +| C.4.6 | Remarks..... | 328 | +| Annex D (normative): XML schemas..... | | 329 | +| D.1 | XML schema for transporting MCData identities and general services information..... | 329 | +| D.1.1 | General..... | 329 | +| D.1.2 | XML schema..... | 329 | +| D.1.3 | Semantic..... | 330 | +| D.1.4 | IANA registration template..... | 332 | +| D.2 | Void..... | 334 | +| D.3 | XML schema for MCData (de)-affiliation requests..... | 334 | +| D.3.1 | General..... | 334 | +| D.3.2 | XML schema..... | 334 | +| D.3.3 | Semantic..... | 335 | +| D.3.4 | IANA registration template..... | 335 | +| D.4 | XML schema for MCData location information..... | 337 | +| D.4.1 | General..... | 337 | +| D.4.2 | XML schema..... | 337 | +| D.4.3 | Semantic..... | 342 | +| D.4.4 | IANA registration template..... | 347 | +| D.5 | XML schema for MBMS usage information..... | 349 | +| D.5.1 | General..... | 349 | +| D.5.2 | XML schema..... | 349 | +| D.5.3 | Semantic..... | 350 | +| D.5.4 | IANA registration template..... | 353 | +| Annex E (normative): IANA registration forms..... | | 355 | +| E.1 | MIME type for transporting MCData signalling content..... | 355 | +| E.2 | MIME type for transporting MCData payload content..... | 356 | +| Annex F (normative): Timers..... | | 359 | +| F.1 | General..... | 359 | +| F.2 | On-network timers..... | 359 | +| F.2.1 | Timers in the participating MCData function..... | 359 | +| F.2.2 | Timers in the controlling MCData function..... | 360 | +| F.2.3 | Timers in the MCData UE..... | 361 | +| F.3 | Off-network timers..... | 361 | +| F.3.1 | Timers in off-network SDS..... | 361 | +| F.3.2 | Timers in off-network emergency alert..... | 362 | +| Annex G (normative): Counters and states..... | | 364 | +| G.1 | General..... | 364 | +| G.2 | On-network counters..... | 364 | +| G.3 | Off-network counters..... | 364 | +| G.3.1 | Counters in off-network SDS..... | 364 | +| G.4 | On-network emergency related states..... | 364 | +| G.4.1 | MCData emergency alert state..... | 364 | + +| | | | +|-------|-------------------------------------------------|-----| +| G.4.2 | MCData emergency state..... | 365 | +| G.4.3 | In-progress emergency group state..... | 365 | +| G.4.4 | MCData emergency group state..... | 366 | +| G.4.5 | MCData emergency group communication state..... | 367 | + +**Annex H (informative): INFO packages defined in the present document.....369** + +| | | | +|----------|-----------------------------------------------------------|-----| +| H.1 | Info package for indication of communication release..... | 369 | +| H.1.1 | Scope..... | 369 | +| H.1.2 | g.3gpp.mcdata-com-release info package..... | 369 | +| H.1.2.1 | Overall description..... | 369 | +| H.1.2.2 | Applicability..... | 369 | +| H.1.2.3 | Appropriateness of INFO Package Usage..... | 369 | +| H.1.2.4 | Info package name..... | 369 | +| H.1.2.5 | Info package parameters..... | 370 | +| H.1.2.6 | SIP options tags..... | 370 | +| H.1.2.7 | INFO message body parts..... | 370 | +| H.1.2.8 | Info package usage restrictions..... | 370 | +| H.1.2.9 | Rate of INFO Requests..... | 370 | +| H.1.2.10 | Info package security considerations..... | 370 | +| H.1.2.11 | Implementation details and examples..... | 370 | + +| | | +|--------------------------------------------|-----| +| Annex I (informative): Change history..... | 371 | +|--------------------------------------------|-----| + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document specifies the signalling control protocols needed to support Mission Critical Data (MCData) communications as specified by 3GPP TS 23.282 [2]. The present document specifies both on-network and off-network protocols. + +The present document utilises the common functional architecture to support mission critical services as specified in 3GPP TS 23.280 [3], in support of MCData communications. + +The MCData service can be used for public safety applications and also for general commercial applications e.g. utility companies and railways. + +The present document is applicable to User Equipment (UE) supporting the MCData client functionality, and to application servers supporting the MCData server functionality. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.282: "Functional architecture and information flows to support Mission Critical Data (MCData); Stage 2"; +- [3] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2"; +- [4] IETF RFC 3261 (June 2002): "SIP: Session Initiation Protocol". +- [5] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] IETF RFC 3428 (December 2002): "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [7] IETF RFC 6080 (November 2010): "A Session Initiation Protocol (SIP) Extension for the Identification of Services". +- [8] IETF RFC 3841 (August 2004): "Caller Preferences for the Session Initiation Protocol (SIP)". +- [9] IETF RFC 4826 (May 2007): "Extensible Markup Language (XML) Formats for Representing Resource Lists". +- [10] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control Protocol specification". +- [11] 3GPP TS 24.481: "Mission Critical Services (MCS) group management Protocol specification". +- [12] 3GPP TS 24.484: "Mission Critical Services (MCS) configuration management Protocol specification". +- [13] IETF RFC 4483 (May 2006): "A Mechanism for Content Indirection in Session Initiation Protocol (SIP) Messages". +- [14] IETF RFC 4122 (July 2005): "A Universally Unique Identifier (UUID) URN Namespace". + +- [15] 3GPP TS 24.582: "Mission Critical Data (MCData) media plane control Protocol specification"; +- [16] IETF RFC 3840 (August 2004): "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [17] IETF RFC 4975 (September 2007): "The Message Session Relay Protocol (MSRP)". +- [18] IETF RFC 5366 (October 2008): "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". +- [19] IETF RFC 6135 (February 2011): "An Alternative Connection Model for the Message Session Relay Protocol (MSRP) ". +- [20] IETF RFC 6714 (August 2012): "Connection Establishment for Media Anchoring (CEMA) for the Message Session Relay Protocol (MSRP)". +- [21] IETF RFC 6086 (January 2011): "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [22] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [23] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [24] 3GPP TS 24.482: "Mission Critical Services (MCS) identity management Protocol specification. +- [25] 3GPP TS 24.334: "Proximity-services (ProSe) User Equipment (UE) to Proximity-services (ProSe) Function Protocol aspects; Stage 3". +- [26] 3GPP TS 33.180: "Security of the Mission Critical Service". +- [27] void +- [28] W3C: "XML Encryption Syntax and Processing Version 1.1", . +- [29] W3C: "XML Signature Syntax and Processing (Second Edition)", . +- [30] IETF RFC 4648 (October 2006): "The Base16, Base32, and Base64 Data Encodings". +- [31] 3GPP TS 23.003: "Numbering, addressing and identification". +- [32] IETF RFC 2045 (November 1996): "Multipart Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [33] IETF RFC 2392 (August 1998): "Content-ID and Message-ID Uniform Resource Locators". +- [34] IETF RFC 3903 (October 2004): "Session Initiation Protocol (SIP) Extension for Event State Publication". +- [35] IETF RFC 4354 (January 2006): "A Session Initiation Protocol (SIP) Event Package and Data Format for Various Settings in Support for the Push-to-Talk over Cellular (PoC) Service". +- [36] IETF RFC 6665 (July 2012): "SIP-Specific Event Notification". +- [37] 3GPP TS 29.283: "Diameter Data Management Applications". +- [38] IETF RFC 4028 (April 2005): "Session Timers in the Session Initiation Protocol (SIP)". +- [39] IETF RFC 3856 (August 2004): "A Presence Event Package for the Session Initiation Protocol (SIP)". +- [40] IETF RFC 3863 (August 2004): "Presence Information Data Format (PIDF)". +- [41] IETF RFC 4661 (September 2006): "An Extensible Markup Language (XML)-Based Format for Event Notification Filtering". + +- [42] 3GPP TS 24.483: "Mission Critical Services (MCS) Management Object (MO)". +- [43] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [44] IETF RFC 5627 (October 2009): "Obtaining and Using Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol (SIP)". +- [45] IETF RFC 4567 (July 2006): "Key Management Extensions for Session Description Protocol (SDP) and Real Time Streaming Protocol (RTSP)". +- [46] IETF RFC 3986 (January 2005): "Uniform Resource Identifier (URI): Generic Syntax". +- [47] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [48] 3GPP TS 29.582: "Mission Critical Data (MCData) signalling control interworking with LMR systems; Protocol specification". +- [49] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [50] IETF RFC 5245 (April 2010): "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer Answer Protocols". +- [51] IETF RFC 3515 (April 2003): "The Session Initiation Protocol (SIP) Refer Method". +- [52] IETF RFC 7647 (September 2015): "Clarifications for the use of REFER with RFC6665". +- [53] IETF RFC 4488 (May 2006): "Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription". +- [54] IETF RFC 4538 (June 2006): "Request Authorization through Dialog Identification in the Session Initiation Protocol (SIP)". +- [55] IETF RFC 6509 (February 2012): "MIKEY-SAKKE: Sakai-Kasahara Key Encryption in Multimedia Internet KEYing (MIKEY)". +- [56] 3GPP TS 23.468: "Group Communication System Enablers for LTE (GCSE\_LTE); Stage 2". +- [57] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE); MB2 reference point; Stage 3". +- [58] Void. +- [59] IETF RFC 5761 (April 2010): "Multiplexing RTP Data and Control Packets on a Single Port". +- [60] IETF RFC 5795 (March 2010): "The ROBust Header Compression (ROHC) Framework". +- [61] IETF RFC 3095 (July 2001): "ROBust Header Compression (ROHC): Framework and four profiles: RTP, UDP, ESP, and uncompressed". +- [62] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [63] 3GPP TS 23.203: "Policy and charging control architecture". +- [64] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [65] 3GPP TS 29.199-09: "Open Service Access (OSA); Parlay X web services; Part 9: Terminal location". +- [66] OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C: "RESTful Network API for Network Message Storage". +- [67] IETF RFC 8101 (March 2017): "IANA Registration of New Session Initiation Protocol (SIP) Resource-Priority Namespace for Mission Critical Push To Talk Service". +- [68] 3GPP TS 22.280: "Mission Critical Services Common Requirements (MCCoRe); Stage 1". + +- [69] IETF RFC 5547: "A Session Description Protocol (SDP) Offer/Answer Mechanism to Enable File Transfer". +- [70] IETF RFC 1738: "Uniform Resource Locators (URL)". +- [71] IETF RFC 4566 (July 2006): "SDP: Session Description Protocol". +- [72] IETF RFC 5888 (June 2010): "The Session Description Protocol (SDP) Grouping Framework". + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +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]. + +**An MCData user is affiliated to an MCData group:** The MCData user has expressed interest in an MCData group it is a member of, and both the MCData server serving the MCData user and the MCData server owning the MCData group have authorized the MCData user's interest in the MCData group communication. + +**An MCData user is affiliated to an MCData group at an MCData client:** The MCData user is affiliated to the MCData group, the MCData client has a registered IP address for an IMPU related to the MCData ID, and the MCData server serving the MCData user has authorised the MCData user's interest in the MCData group at the MCData client. + +**Affiliation status:** Applies for an MCData user to an MCData group and has one of the following states: + +- a) the "not-affiliated" state indicating that the MCData user is not interested in the MCData group and the MCData user is not affiliated to the MCData group; +- b) the "affiliating" state indicating that the MCData user is interested in the MCData group but the MCData user is not affiliated to the MCData group yet; +- c) the "affiliated" state indicating that the MCData user is affiliated to the MCData group and there was no indication that MCData user is no longer interested in the MCData group; and +- d) the "deaffiliating" state indicating that the MCData user is no longer interested in the MCData group but the MCData user is still affiliated to the MCData group. + +**Group identity:** An MCData group identity or a temporary MCData group identity. + +**MCData client ID:** is a globally unique identification of a specific MCData client instance. MCData client ID is a UUID URN as specified in IETF RFC 4122 [14]. + +**MCData emergency alert:** A notification from the MCData client to the MCData service that the MCData user has an emergency condition. + +**MCData emergency alert state:** MCData client internal perspective of the state of an MCData emergency alert. + +**MCData emergency group state:** MCData client internal perspective of the in-progress emergency state of an MCData group maintained by the controlling MCData function. + +**MCData emergency group communication:** An urgent MCData group communication that highlights a situation of potential death or serious injury. + +**MCData emergency group communication state:** MCData client internal perspective of the state of an MCData emergency group communication. + +**Functional alias status:** Applies for the status of a functional alias for an MCData user and has one of the following states: + +- a) the "not-activated" state indicating that the MCData user has not activated the functional alias; + +- b) the "activating" state indicating that the MCData user is interested in using the functional alias but the functional alias is not yet activated for the MCData user; +- c) the "activated" state indicating that the MCData user has activated the functional alias; and +- d) the "deactivating" state indicating that the MCData user is no longer interested in using the functional alias but the functional alias is still activated for the MCData user. + +For the purpose of the present document, the following terms and definitions given in 3GPP TS 33.180 [26] apply: + +**Client Server Key (CSK)** +**Multicast Signalling Key (MuSiK)** +**Multicast Signalling Key Identifier (MuSiK-ID)** +**MBMS subchannel control key (MSCCK)** +**MBMS subchannel control key identifier (MSCCK-ID)** +**Private Call Key (PCK)** +**Signalling Protection Key (SPK)** +**XML Protection Key (XPK)** + +For the purpose of the present document, the following terms and definitions given in 3GPP TS 22.280 [68] apply: + +**Functional alias** + +## 3.2 Abbreviations + +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]. + +| | | +|-----------------|--------------------------------------------| +| CSK | Client-Server Key | +| IMPU | P Multimedia Public User identity | +| MBMS | Multimedia Broadcast and Multicast Service | +| MC | Mission Critical | +| MCS | Mission Critical Service | +| MCData | Mission Critical Data | +| MCData group ID | MCData group Identity | +| MDEA | MCData Emergency Alert | +| MDEG | MCData Emergency Group | +| MDEGC | MCData Emergency Group Communication | +| MDES | MCData Emergency State | +| MIME | Multipurpose Internet Mail Extensions | +| MONP | MCPTT Off-Network Protocol | +| QCI | QoS Class Identifier | +| RTP | Real-time Transport Protocol | +| SAI | Service Area Identifier | +| SDP | Session Description Protocol | +| SIP | Session Initiation Protocol | +| SPK | Signalling Protection Key | +| URI | Uniform Resource Identifier | +| URN | Uniform Resource Name | +| UUID | Universally Unique Identifier | +| XPK | XML Protection Key | + +--- + +## 4 General + +### 4.1 MCData overview + +The MCData service supports communication between a pair of users (i.e. one-to-one communication) and several users (i.e. group communication), where each user has the ability to: + +- share data using Short Data Service (SDS); +- share files using File Distribution (FD) service; and +- exchange Data using IP Connectivity service. + +SDS is provided in both, on-network and off-network while FD and IP Connectivity is provided only in on-network in this release of the present document. + +The present document provides the signalling control protocol enhancements to support the MCData architectural procedures specified in 3GPP TS 23.282 [2]. + +For on-network communications, the present document makes use of the existing IMS procedures specified in 3GPP TS 24.229 [5]. + +The on-network procedures in this document allow an MCData user to: + +- send a standalone SDS using signalling control plane; +- send a standalone SDS using media plane; +- initiate a SDS session; +- send a file using HTTP; +- send a file using media plane; +- establish an IP Connectivity session to exchange Data; +- access the MCData message store; and +- use a functional alias to identify the MCData user. + +For off-network, the present document utilises the procedures for ProSe direct discovery for Public Safety and the procedures for one-to-one ProSe direct communication for Public Safety and one-to-many ProSe direct communication for Public Safety, as specified in 3GPP TS 24.334 [25], and allows an MCData user to: + +- send a standalone SDS using signalling control plane. + +The MCData procedures provided by the present document refer to: + +- the media plane procedures defined in 3GPP TS 24.582 [15]; +- the group management procedures defined in 3GPP TS 24.481 [11]; +- the identity management procedures defined in 3GPP TS 24.482 [24]; and +- the security procedures defined in 3GPP TS 33.180 [26]. + +The MCData procedures provided by the present document access the configuration parameters provided by 3GPP TS 24.483 [42] and 3GPP TS 24.484 [12]. + +The following procedures are provided within this document: + +- common procedures are specified in clause 6; +- procedures for registration in the IM CN subsystem and service authorisation are specified in clause 7; +- procedures for affiliation are specified in clause 8; +- procedures for on-network and off-network SDS are specified in clause 9; +- procedures for on-network FD are specified in clause 10; +- procedures for transmission and reception control are specified in clause 11; +- procedures for dispositions and notifications are specified in clause 12; + +- procedures for communication release are specified in clause 13; +- procedures for location reporting are specified in clause 17; +- procedure for using MBMS transmission are specified in clause 19; +- procedures for establishing an IP Connectivity session are specified in clause 20; +- procedures for the MCData message store are specified in clause 21; and +- procedures for the use of functional alias are specified in clause 22. + +The MCData UE primarily obtains access to the MCData service via E-UTRAN, using the procedures defined in 3GPP TS 24.301 [43]. + +## 4.2 Identity, URI and address assignments + +### 4.2.1 Public Service identities + +In order to support MCData, the following URI and address assignments are assumed: + +- 1) the participating MCData function is configured to be reachable using: + - a) the public service identity of the participating MCData function serving the MCData user. + +### 4.2.2 MCData session identity + +The MCData session identity is a SIP URI, which identifies the MCData session between: + +- the MCData client and the participating MCData function; and +- the participating MCData function and the controlling MCData function. + +The MCData session identity shall be a GRUU as defined in IETF RFC 5627 [44] assigned by the MCData server as per 3GPP TS 24.229 [5]. + +The MCData session identity identifies the MCData session in such a way that e.g.: + +- the IM CN subsystem is able to route an initial SIP request to the controlling MCData function. + +The controlling MCData function allocates a unique MCData session identity hosted at the controlling MCData function for the MCData session at the time of session establishment. + +When protection of sensitive application data is required by the MCData operator, the MCData session identity cannot contain identity information that is classified as sensitive such as the MCData ID or the MCData Group ID, as specified in subclause 4.6. + +The controlling MCData function sends the MCData session identity towards the MCData client during MCData session establishment by including it in the Contact header field of the final SIP response to a session initiation request. + +The participating MCData function allocates a unique MCData session identity hosted at the participating MCData function for the MCData session when it receives a MCData session identity in the Contact header field of a SIP request or a SIP response from the controlling MCData function and includes it in the Contact header field of the SIP request or SIP response sent towards the MCData client. The participating MCData function maintains a mapping of the MCData session identities it sends to the MCData client to the corresponding MCData session identities received from the controlling MCData function. + +The MCData client can cache the MCData session identity until a time when it is no longer needed. + +### 4.2.3 MCData client ID + +MCData client ID is described in subclause 4.8 of the present document. + +## 4.3 Pre-established sessions + +When establishing a pre-established session, the MCData client negotiates the media parameters, including establishing IP addresses and ports using interactive connectivity establishment (ICE) as specified in IETF RFC 5245 [50] with the participating MCData function, prior to using the pre-established session for establishing MCData communication with other MCData users. The procedures for establishing, modifying and releasing a pre-established session are defined in clause 18. + +The pre-established session can later be used in MCData communication. This avoids the need to negotiate media parameters (including evaluating ICE candidates) and reserving bearer resources during the MCData communication establishment that results in delayed MCData communication establishment. + +## 4.4 Emergency Alerts + +MCData emergency alerts can be initiated or cancelled as described in the procedures of clause 16 which include: + +- MCData emergency alert initiation, on-network; +- MCData emergency alert cancellation, on-network; +- MCData emergency alert initiation, off-network; and +- MCData emergency alert cancellation, off-network. + +MCData emergency alerts are initiated to a target MCData group, and, if successful and not already affiliated to that group, will result in the initiator being implicitly affiliated to that MCData group. + +Key aspects of MCData emergency alerts include: + +- **MCData emergency alert (MDEA) state:** the MCData client maintains the internal MCData emergency alert state (MDEA, see subclause G.4.1). The initial setting is "MDEA 1: no-alert". +- **Authorisations for emergency alerts:** MCData users need to be authorised to initiate MCData emergency alerts and additionally need to be authorised to cancel MCData emergency alerts initiated by them or by others. The parameters related to these authorisations are specified in 3GPP TS 24.483 [42] and 3GPP TS 24.484 [12]. + +## 4.5 MCData Protocol + +Subclauses 15 describes the TLV based message formats used in MCData communications. Each message consist of a series of information elements. Annex I of 3GPP TS 24.379 [10] describes the standard format of the messages and the encoding rules for each type of information element. + +## 4.6 Protection of sensitive XML application data + +In certain deployments, for example, in the case that the MCData operator uses the underlying SIP core infrastructure from the carrier operator, the MCData operator can prevent certain sensitive application data from being visible in the clear to the SIP layer. The following data are classed as sensitive application data: + +- MCData ID; +- MCData group ID; +- user location information; +- alert indicator; +- access token (containing the MCData ID); +- MCData client ID; and +- functional alias. + +The above data is transported as XML content in SIP messages, in XML elements or XML attributes. + +Data is transported in attributes in the following circumstances in the procedures in the present document: + +- an MCData ID, an MCData Group ID, and an MCData client ID in an XML document published in SIP PUBLISH request for affiliation according to IETF RFC 3856 [39]; +- an MCData ID or an MCData Group ID in XML document notified in a SIP NOTIFY request for affiliation according to IETF RFC 3856 [39]; +- an MCData ID in application/resource-lists+xml document included in a SIP MESSAGE or SIP INVITE request for one-to-one SDS or one-to-one FD, according to IETF RFC 5366 [18]; +- an MCData ID and functional alias in an XML document published in SIP PUBLISH request for functional alias management according to IETF RFC 3856 [39]; and +- an MCData ID and functional alias in an XML document notified in a SIP NOTIFY request for functional alias management according to IETF RFC 3856 [39]. + +3GPP TS 33.180 [26] describes a method to provide confidentiality protection of sensitive application data in elements by using XML encryption (i.e. xmlenc) and in attributes by using an attribute confidentiality protection scheme described in subclause 6.6.2.3 of the present document. Integrity protection can also be provided by using XML signatures (i.e. xmlsig). + +Protection of the data relies on a shared XML protection key (XPK) used to encrypt and sign data: + +- between the MCData client and the MCData server, the XPK is a client-server key (CSK); and +- between MCData servers, the XPK is a signalling protection key (SPK). + +The CSK (XPK) and a key-id CSK-ID (XPK-ID) are generated from keying material provided by the key management server. Identity based public key encryption based on MIKEY-SAKKE is used to transport the CSK between SIP end-points. The encrypted CSK is transported from the MCData client to the MCData server when the MCData client performs service authorisation as described in clause 7 and is also used during service authorisation to protect the access token. + +The SPK (XPK) and a key-id SPK-ID (XPK-ID) are directly provisioned in the MCData servers. + +Configuration in the MCData client and MCData server is used to determine whether one or both of confidentiality protection and integrity protection are required. + +The following four examples give a brief overview of the how confidentiality and integrity protection is applied to application data in this specification. + +**EXAMPLE 1:** Pseudo code showing how confidentiality protection is represented in the procedures in the document for sensitive data sent by the originating client. + +``` +IF configuration is set for confidentiality protection of sensitive data +THEN + Encrypt data element using the CSK (XPK); + Include in an element of the XML MIME body: + (1) the encryption method; + (2) the key-id (XPK-ID); + (3) the cipher data; + Encrypt URIs in attribute using the CSK (XPK) by following subclause 6.6.2.3; +ELSE + include application data into XML MIME body in clear text; +ENDIF; +``` + +**EXAMPLE 2:** Pseudo code showing how integrity protection is represented in the procedures in the present document for data sent by the originating client. + +``` +IF configuration is set for integrity protection of application data +THEN + Use a method to hash the content; + Generate a signature for the hashed content using the CSK (XPK); + Include within a XML element of the XML MIME body: + (1) a canonicalisation method to be applied to the signed information; + (2) the signature method used for generating the signature; + (3) a reference to the content to be signed; +``` + +``` + + (4) the hashing method used; + (5) the hashed content; + (6) the key-id (XPK-ID); + (7) the signature value; + ENDFIF; + +``` + +EXAMPLE 3: Pseudo code showing how confidentiality protection is represented in the procedures in the present document at the server side when receiving encrypted content. + +``` + +IF configuration is set for confidentiality protection of sensitive data +THEN + Check that the XML content contains the element; + Check that the XML document contains a URI with the domain name for MC Services +confidentiality protection; + Return an error if the element or domain name for MC Services confidentiality +protection are not found; + Otherwise: + (1) obtain the CSK (XPK) using the CSK-ID (XPK-ID) in the received XML body; + (2) for encrypted data in elements, decrypt the data elements using the CSK; + (3) for encrypted URIs in attributes, decrypt the URIs using the CSK; +ENDIF; + +``` + +EXAMPLE 4: Pseudo code showing how integrity protection is represented in the procedures in the present document at the server side when receiving signed content. + +``` + +IF configuration is set for integrity protection of application data +THEN + Check that the XML content contains the element; + Return an error if the element is not found; + Otherwise: + (1) obtain the CSK (XPK) using the CSK-ID (XPK-ID) in the received XML body; + (2) verify the signature of the content using the CSK; + Return an error if the validation of the signature fails; + IF validation of the signature passes + THEN + decrypt any data found in elements; + decrypt any encrypted URIs found in attributes; + ENDFIF; +ENDIF; + +``` + +The content can be re-encrypted and signed again using the SPK between MCData servers. + +The following examples show the difference between normal and encrypted data content. In this example consider the MCData client initiating a group standalone SDS message using the signalling control plane. + +EXAMPLE 5: MIME body represented with data elements in the clear: + +``` + +Content-Type: application/vnd.3gpp.mcdata-info+xml + + + + group-sds + + sip:group123@mcdataoperator1.com + + + + +``` + +EXAMPLE 6: MIME body represented with the encrypted: + +``` + +Content-Type: application/vnd.3gpp.mcdata-info+xml + + + + group-sds + + + + + base64XpkId + + + +``` + +``` + + A23B45C5657689090 + + + + + + +``` + +EXAMPLE 7: pidf+xml MIME body represented with clear URIs in attributes: + +``` + +Content-Type: application/pidf+xml + + + + + + + + + +``` + +EXAMPLE 8: pidf+xml MIME body represented with encrypted URIs in attributes: + +``` + +Content-Type: application/pidf+xml + + + + + + + + + +``` + +## 4.7 Protection of TLV signalling and media content + +The protection of TLV signalling and media content is based on 3GPP MCData security solution as defined in 3GPP TS 33.180 [26]. + +For different security requirements of different information elements of a MCData message, the information elements of MCData messages are bifurcated in the following components: + +- **MCData Data signalling payload:** information elements necessary for identification and management of the MCData messages e.g. conversation identifiers, session identifiers, transaction identifiers, disposition requests, etc. This payload is confidentiality and integrity protected between the MCData Client and the MCData server. +- **MCData Data payload:** the actual user payload for MCData user or application consumption. This payload is end-to-end confidentiality and integrity protected. + +An SDS message can be sent over both, signalling plane and media plane. When an SDS message is sent using signalling plane, the body included in the SIP MESSAGE request, which carries MCData Data signalling payload, is protected between each entity separately if protection is applied. On the other hand the body included in the SIP MESSAGE request which carries the MCData Data payload is end-to-end protected. The procedures for the protection of the SDS messages over the signalling plane are specified in this document. Protection of SDS message over media control plane is specified in 3GPP TS 24.582 [15]. + +For FD using HTTP and FD using media plane, the MCData Data signalling payload sent over the signalling plane is protected between each entity separately if protection is applied. The procedure for the protection of the file is specified in 3GPP TS 24.582 [15]. + +The ciphering algorithm indicated in the Key Download procedure by the MCData server shall be used to protect the MCData signalling fields (i.e. MCData signaling parameters, Data signaling payload and end-to-end security parameters). + +## 4.7A Signalling security when using MBMS + +Signalling security is established between the participating MCData function and the MCData client. + +The protection of MBMS subchannel control messages on the general purpose MBMS subchannels can be done with MSCCKs (each identified by a corresponding MSCCK-ID), distributed during MBMS bearer announcement (see + +subclause 19.2.2). Each general purpose MBMS subchannel is associated with an MSCCK and a corresponding MSCCK-ID. There can be multiple general purpose MBMS subchannels deployed, each associated with its own MSCCK and corresponding MSCCK-ID. The (MSCCK-ID, MSCCK) pair is provided for each general purpose MBMS subchannel separately. + +According to 3GPP TS 33.180 [26] subclause 8.2, the MCData Payload Protection Key (DPPK) referenced in subclause 6.6 is a Multicast Signalling Keys (MuSiK), (identified by a corresponding (MuSiK-ID)), distributed via MuSiK download messages. The MSCCK and MuSiKs can be distributed independently of each other and in any order and can also be used independently. Signalling supports initial keying, as well as repeated re-keying and un-keying for both MSCCK and MuSiKs. + +The MuSiK download message contains an embedded MIME payload which is the MIKEY payload containing the MuSiK and MuSiK-ID, as well as an embedded XML payload potentially containing an explicit list of MCData group ids to which the key applies. Both payloads are protected as described in 3GPP TS 33.180 [26], as they are transferred between the participating MCData function and the MCData client. Within the XML payload, the list of MCData group ids is protected as application sensitive data (see subclause 4.8). Within the MIKEY payload, the MuSiK is encrypted using the MCData ID of the served MCData client. The payload is signed using a key associated to the identity of the participating MCData function. + +To distribute MuSiK, the participating MCData function uses the I\_MESSAGE format from subclause 5.2.4 of 3GPP TS 33.180 [26], which includes associated parameters. The participating function sets the Status associated parameter to values defined in subclause E.6.9 of 3GPP TS 33.180 [26], namely "Not-revoked" when keying or rekeying and "Revoked" when unkeying, respectively. Upon receipt, the MCData client validates the signature and, if valid, the MCData client first examines the Status attribute and either marks the associated security functions as "not in use" or stores the MuSiK and the MuSiK-ID, and then replies with a success code; otherwise, the MCData client can reply with a failure code. If a success code is not received from the MCData client in response to the MuSiK download message, the participating MCData function starts using only unicast towards the respective MCData client for the listed groups. + +The security context is initiated when the MBMS bearer is announced to the MCData clients. The procedure involves the participating MCData function creating an MBMS subchannel control key (MSCCK) and a corresponding key identifier (MSCCK-ID) associated with the MBMS bearer when the MBMS bearer is activated, and then transferring the MSCCK and the MSCCK-ID associated with the MBMS bearer to served MCData clients using SIP signalling. The MSCCK is encrypted using the MCData ID of the served MCData client and domain-specific material provided from the KMS. + +The MSCCK and the MSCCK-ID associated with the MBMS bearer are distributed within a MIKEY payload within the SDP describing the general purpose MBMS subchannel of the MBMS bearer. This payload is called a MIKEY-SAKKE I\_MESSAGE, as defined in IETF RFC 6509 [55], which ensures the confidentiality, integrity and authenticity of the payload. The encoding of the MIKEY payload in the SDP is described in IETF RFC 4567 [45] using an "a=key-mgmt" attribute. The payload is signed using a key associated to the identity of the participating MCData function. To distribute MSCCK, the participating MCData function uses the I\_MESSAGE format from subclause 5.2.4 of 3GPP TS 33.180 [26], which includes associated parameters. + +The participating function sets the Status associated parameter to values defined in subclause E.6.9 of 3GPP TS 33.180 [26], namely "Not-revoked" when keying or rekeying and "Revoked" when unkeying, respectively. Upon receipt, the MCData client validates the signature and, if the signature is found valid and the I\_MESSAGE contains a Status attribute, the MCData client first examines the Status attribute and either marks the associated security functions as "not in use" or extracts and stores the encapsulated MSCCK and the corresponding MSCCK-ID. The decrypted key is used as described in 3GPP TS 33.180 [26]. With the MSCCK successfully shared between the participating MCData function and the served UEs, the participating MCData function is able to securely send MBMS subchannel control messages to the MCData clients. + +## 4.8 MCData client ID + +The MCData client assigns the MCData client ID when the MCData client is used for the first time. The MCData client generates the MCData client ID as specified in subclause 4.2 of IETF RFC 4122 [25]. + +The MCData client preserves the MCData client ID: + +- while the MCData client is SIP registered as specified in 3GPP TS 24.229 [5]; + +- while the MCData client is not SIP registered as specified in 3GPP TS 24.229 [5] and the UE serving the MCData client is switched on; +- while the UE serving the MCData client is switched off; and +- while the UE serving the MCData client is power-cycled. + +NOTE: MCData client ID is not preserved when the UE is reset to factory settings. + +## 4.9 Warning Header Field + +### 4.9.1 General + +The MCData server can include a free text string in a SIP response to a SIP request. When the MCData server includes a text string in a response to a SIP MESSAGE or SIP INVITE request the text string is included in a Warning header field as specified in IETF RFC 3261 [24]. The MCData server includes the Warning code set to 399 (miscellaneous warning) and includes the host name set to the host name of the MCData server. + +EXAMPLE: Warning: 399 "200 user not authorised to transmit data " + +### 4.9.2 Warning texts + +The text string included in a Warning header field consists of an explanatory text preceded by a 3-digit text code, according to the following format in Table 4.4.2-1. + +**Table 4.9.2-1 ABNF for the Warning text** + +``` +warn-text =/ DQUOTE mcdata-warn-code SP mcdata-warn-text DQUOTE +mcdata-warn-code = DIGIT DIGIT DIGIT +mcdata-warn-text = *( qdtext | quoted-pair ) +``` + +Table 4.4.2-2 defines the warning texts that are defined for the Warning header field when a Warning header field is included in a response to a SIP INVITE request as specified in subclause 4.4.1. + +**Table 4.9.2-2: Warning texts defined for the Warning header field** + +| Code | Explanatory text | Description | +|------|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| 101 | service authorisation failed | The service authorisation of the MCData ID against the IMPU failed at the MCData server. | +| 102 | too many simultaneous affiliations | The MCData user already has N2 maximum number of simultaneous affiliations. | +| 104 | isfocus not assigned | A controlling MCData function has not been assigned to the MCData session. | +| 113 | group document does not exist | The group document requested from the group management server does not exist. | +| 114 | unable to retrieve group document | The group document exists on the group management server but the MCData server was unable to retrieve it. | +| 115 | group is disabled | The group has the element set to "true" in the group management server. | +| 116 | user is not part of the MCData group | The group exists on the group management server but the requesting user is not part of this group. | +| 120 | user is not affiliated to this group | The MCData user is not affiliated to the group. | +| 136 | authentication of the MIKEY-SAKKE I_MESSAGE failed | Security context establishment failed. | +| 139 | integrity protection check failed | The integrity protection of an XML MIME body failed. | +| 140 | unable to decrypt XML content | The XML content cannot be decrypted. | +| 141 | user unknown to the participating function | The participating function is unable to associate the public user identity with an MCData ID. | +| 142 | unable to determine the controlling function | The participating function is unable to determine the controlling function for the group call or private call. | +| 145 | unable to determine called party | The participating function was unable to determine the called party from the information received in the SIP request. | +| 198 | no users are affiliated to this group | No users in the group are affiliated. | +| 199 | expected MIME bodies not in the request" | The expected MIME bodies were not received in the SIP request. | +| 200 | user not authorised to transmit data | The MCData user is not authorised to transmit data. | +| 201 | user not authorised to transmit data on this group identity | The MCData user is not authorised to transmit data on the group identity included in the request. | +| 202 | user not authorised for one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request | The MCData user is not authorised for one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request | +| 203 | message too large to send over signalling control plane | The MCData client sent data that is greater than the size that can be handled by the signalling control plane. | +| 204 | unable to determine targeted user for one-to-one SDS | The MCData server is unable to determine the targeted user for one-to-one SDS. | +| 205 | unable to determine targeted user for one-to-one FD | The MCData server is unable to determine the targeted user for one-to-one FD. | +| 206 | short data service not allowed for this group | SDS is not allowed on the group indicated in the SDS request. | +| 207 | SDS services not supported for this group | SDS services not supported for this group | +| 208 | user not authorised for MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request | The MCData user is not authorised for group MCData communications due to exceeding the maximum amount of data that can be sent in a single request. | +| 209 | one FD SIGNALLING PAYLOAD or FD HTTP TERMINATION message only must be present in FD request | Only one FD SIGNALLING PAYLOAD or FD HTTP TERMINATION message must be present in FD request | +| 210 | Only one File URL must be present in the FD request | Only one File URL must be present in the FD request. | +| 211 | payload for an FD request is not FILEURL | The payload in the FD request did not contain a FILEURL | + +| | | | +|-----|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| 212 | file referenced by file URL does not exist | The MCData server was unable to locate the file referenced by the file URL. | +| 213 | file distribution not allowed for this group | FD is not allowed on the group indicated in the FD request. | +| 214 | FD services not supported for this group | FD services not supported for this group | +| 215 | request to transmit is queued by the server | The MCData request was queued by the server for later transmission. | +| 216 | unable to correlate the disposition notification | The MCData server was unable to correlate the disposition notification to a MCData message. | +| 217 | user not authorised for SDS communications on this group identity due to message size | The size of the message exceeded the maximum data allowed for SDS communications on this group identity | +| 218 | user not authorised for one-to-one SDS communications due to message size | The size of the message exceeded the maximum data allowed for one-to-one SDS communications. | +| 219 | user not authorised for FD communications on this group identity due to file size | The size of the file exceeded the maximum data allowed for FD communications on this group identity | +| 220 | user not authorised for FD communications due to file size | The size of the file exceeded the maximum data allowed for one-to-one FD communications. | +| 221 | user not authorised to initiate one-to-one SDS session | The MCData user is not authorised to initiate a one-to-one SDS session. | +| 222 | user not authorised to initiate group SDS session on this group identity | The MCData user is not authorised to initiate a SDS session on the group identity included in the request. | +| 223 | No Conversation ID or Message ID present | Conversation ID and Message ID required to identify transmission | +| 224 | No Transmission available | No transmission identified with given Conversation ID, Message Id and file URL | +| 225 | User not authorized to initiate pre-established session | The MCData user is not authorised to initiate a pre-established MCData session. | +| 226 | function not allowed due to pre-established session not supported | Pre-established session is not supported by MCData participating function | +| 227 | unable to determine targeted user for one-to-one IP Connectivity | The MCData server is unable to determine the targeted user for one-to-one IP Connectivity. | +| 228 | maximum number of service authorizations reached | The number of maximum simultaneous service authorizations for the MCData user has been reached. | +| 229 | one-to-one MCData communication not authorised to the targeted user" | The user is not authorised to initiate one-to-one MCData communication to this targeted user". | +| 230 | one-to-one MCData communication not authorised from this originating user" | The user is not authorised to receive one-to-one MCData communication from this originating user". | + +## 4.10 MCData emergency groups and emergency group communications + +**Editor's note:** In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +MCData emergency groups and emergency group communications as defined by 3GPP TS 23.282 [2] are supported by the procedures in this specification. There are a number of state variables used to manage MCData emergencies, including: + +- **MCData emergency state:** in accordance with 3GPP TS 23.282 [2], indicates (see subclause G.4.2) that the MCData user is in a life-threatening situation. This MCData client state variable is changed via action by the MCData user of the device or by an authorised MCData user. While the MCData emergency state is set on the client, all communications originated by the client will be MCData emergency communications, assuming the MCData user is authorised for MCData emergency communications. + +- **in-progress emergency group state:** in accordance with 3GPP TS 23.282 [2], this state variable (see subclause G.4.3) indicates whether or not there is an MCData emergency group communication ongoing on the specified group. This state is managed by the controlling MCData function. All group communications originated on this MCData group when in an in-progress emergency state are MCData emergency group communications until this state is cancelled, regardless of the originator being (or not) in an MCData emergency state. +- **MCData emergency group (MDEG) state:** this is an internal state (see subclause G.4.4) managed by the MCData client which tracks the in-progress emergency state of the group (see 3GPP TS 23.282 [2]) managed by the controlling MCData function. Ideally, the MCData client would not need to track the in-progress emergency group state, but doing so enables the MCData client to request MCData emergency-level priority earlier than otherwise possible. For example, if the MCData user wishes to join an MCData emergency group communication and is not in MCData emergency state itself, the MCData client should have emergency level priority. If it has knowledge of the in-progress emergency state of the group, it can request priority by including a Resource-Priority header field set to the MCPTT namespace specified in IETF RFC 8101 [67], and appropriate priority level in the SIP INVITE request (or SIP re-INVITE request). +- **MCData emergency group communication (MDEGC) state:** this is an internal state (see subclause G.4.5) corresponding to an ongoing group communication. The state is managed by the MCData client, which in conjunction with the MCData emergency alert state (see subclause 4.4), aids in managing the MCData emergency state and related actions. + +--- + +## 5 Functional entities + +### 5.1 Introduction + +This clause associates the functional entities with the MCData roles described in the stage 2 architecture document (see 3GPP TS 23.282 [2]). + +### 5.2 MCData client + +To be compliant with the procedures in the present document, an MCData client shall: + +- act as the user agent for all MCData application transactions (e.g. initiation of a group standalone SDS message); and +- support handling of the MCData client ID as described in subclause 4.8. + +To be compliant with the on-network procedures in the present document, an MCData client shall: + +- support the MCData client on-network procedures defined in 3GPP TS 23.282 [2]; +- support the GCS UE procedures defined in 3GPP TS 23.468 [56] for unicast delivery, MBMS delivery and service continuity; +- support the on-network MCData message formats specified in clause 15 for the short data service (SDS) and the file distribution service (FD); +- act as a SIP UA as defined in 3GPP TS 24.229 [5]; +- generate SDP offer and SDP answer in accordance with 3GPP TS 24.229 [5] and: + - a) subclause 9.2.3 and subclause 9.2.4 for short data service; and + - b) subclause 10.2.5 for file distribution. +- for registration and service authorisation, implement the procedures specified in subclause 7.2; +- for affiliation, implement the procedures specified in subclause 9.2; +- for short data service (SDS) functionality implement the MCData client procedures specified in: + - a) subclause 9.2; and + +- b) clause 6 of 3GPP TS 24.582 [15]; +- for file distribution (FD) functionality implement the MCData client procedures specified in: + - a) subclause 10.2; and + - b) clause 7 of 3GPP TS 24.582 [15]; +- for transmission and reception control functionality implement the MCData client procedures specified in clause 11; +- for disposition notification functionality implement the MCData client procedures specified in subclause 12.2; +- for communication release functionality implement the MCData client procedures specified in subclause 13.2; and +- for functional alias management, implement the procedures specified in subclause 22.2.1. + +To be compliant with the off-network procedures in the present document, an MCData client shall: + +- support the off-network procedures defined in 3GPP TS 23.282 [2]; +- support the off-network MONP MCData message formats specified in clause 15; +- implement the procedures for ProSe direct discovery for public safety use as specified in 3GPP TS 24.334 [25]; +- implement the procedures for one-to-one ProSe direct communication for Public Safety use as specified in 3GPP TS 24.334 [25]; and +- for short data service (SDS) functionality implement the MCData client procedures specified in subclause 9.3. + +To be compliant with the on-network and off-network procedures in the present document requiring end-to-end security key distribution, an MCData client shall support the procedures specified in 3GPP TS 33.180 [26]. + +To be compliant with the procedures for confidentiality protection of XML elements in the present document, the MCData client shall implement the procedures specified in subclause 6.5.2. + +To be compliant with the procedures for integrity protection of XML MIME bodies in the present document, the MCData client shall implement the procedures specified in subclause 6.5.3. + +## 5.3 MCData server + +### 5.3.0 General + +An MCData server can perform the controlling role for short data service and file distribution as defined in 3GPP TS 23.282 [2]. + +An MCData server can perform the participating role for short data service and file distribution as defined in 3GPP TS 23.282 [2]. + +An MCData server performing the participating role can serve an originating MCData user. + +An MCData server performing the participating role can serve a terminating MCData user. + +The same MCData server can perform the participating role and controlling role for the same group short data service transaction or group file distribution transaction. + +When referring to the procedures in the present document for the MCData server acting in a participating role for the served user, the term, "participating MCData function" is used. + +When referring to the procedures in the present document for the MCData server acting in a controlling role for the served user, the term "controlling MCData function" is used. + +To be compliant with the procedures in the present document, an MCData server shall: + +- support the MCData server procedures defined in 3GPP TS 23.282 [2]; + +- support the GCS AS procedures defined in 3GPP TS 23.468 [56] for unicast delivery, MBMS delivery and service continuity; +- implement the role of an AS performing 3rd party call control acting as a routing B2BUA as defined in 3GPP TS 24.229 [5]; +- generate SDP offer and SDP answer in accordance with 3GPP TS 24.229 [5] and: + - a) subclause 9.2.3 and subclause 9.2.4 for short data service; and + - b) subclause 10.2.5 for file distribution. +- for registration and service authorisation, implement the procedures specified in subclause 7.3; +- for affiliation, implement the procedures specified in subclause 9.2.2; +- for short data service (SDS) functionality implement the MCData server procedures specified in: + - a) subclause 9.2; and + - b) clause 6 of 3GPP TS 24.582 [15]; +- for file distribution (FD) functionality implement the MCData server procedures specified in: + - a) subclause 10.2; and + - b) clause 7 of 3GPP TS 24.582 [15]; +- for transmission and reception control functionality implement the MCData server procedures specified in clause 11; +- for disposition notification functionality implement the MCData server procedures specified in clause 12.2; +- for communication release functionality implement the MCData server procedures specified in clause 13.2; and +- for functional alias management, implement the procedures specified in subclause 22.2.2. + +To be compliant with the procedures in the present document requiring the distribution of keying material between MCData clients as specified in 3GPP TS 33.180 [26], an MCData server shall ensure that the keying material is copied from the incoming MCData messages into the outgoing MCData messages. + +To be compliant with the procedures for confidentiality protection of XML elements in the present document, the MCData server shall implement the procedures specified in subclause 6.5.2. + +To be compliant with the procedures for integrity protection of XML MIME bodies in the present document, the MCData server shall implement the procedures specified in subclause 6.5.3. + +### 5.3.1 SIP failure case + +When initiating a SIP failure response to any received SIP request, depending on operator policy, the MCData server may insert a SIP Response-Source header field in accordance with the procedures in subclause 5.7.1.0 of 3GPP TS 24.229 [5], where the "role" header field parameter is set to "pf-mcdata-server" or "cf-mcdata-server" depending on the current role endorsed by the MCData server. + +### 5.3.2 Management of MBMS bearers + +When providing services over MBMS, an MCData server acting in the participating MCData function role shall: + +- allocate TMGIs and activate MBMS bearers in MBMS service areas to be used for MCData media plane transmissions via multicast, per 3GPP TS 23.468 [56] and 3GPP TS 29.468 [57]; +- deactivate MBMS bearers and deallocate TMGIs when no longer necessary, per 3GPP TS 23.468 [56] and 3GPP TS 29.468 [57]; +- handle MBMS bearers related notifications per 3GPP TS 23.468 [56] and 3GPP TS 29.468 [57]; and + +- adjust the priority / pre-emption characteristics of MBMS bearers, as appropriate, in response to relevant events, using procedures specified in per 3GPP TS 23.468 [56] and 3GPP TS 29.468 [57]. + +## 6 Common procedures + +### 6.1 Introduction + +This clause describes the common procedures for each functional entity. + +### 6.2 MCData client procedures + +#### 6.2.1 Distinction of requests at the MCData client + +##### 6.2.1.1 SIP MESSAGE request + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +The MCData client needs to distinguish between the following SIP MESSAGE request for originations and terminations: + +- SIP MESSAGE request routed to the MCData client containing a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml" and includes an XML body containing a Location root element containing a Configuration element. Such requests are known as "SIP MESSAGE request for location report configuration"; +- SIP MESSAGE request routed to the MCData client containing a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml" and includes an XML body containing a Location root element containing a Request element. Such requests are known as "SIP MESSAGE request for location report request"; +- SIP MESSAGE request routed to the MCData client containing a Content-Type header field set to "application/vnd.3gpp.mcdata-info+xml" and including an element set to a value of "true" or "false" and/or an element set to a value of "true" or "false". Such requests are known as "SIP MESSAGE request for emergency notification"; +- SIP MESSAGE request routed to the MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for standalone SDS for terminating MCData client"; +- SIP MESSAGE request routed to the MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for FD using HTTP for terminating MCData client"; +- SIP MESSAGE request routed to the MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an SDS NOTIFICATION message. Such requests are known as "SIP MESSAGE request for SDS disposition notification for terminating MCData client"; and +- SIP MESSAGE request routed to the MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an FD NOTIFICATION message. Such requests are known as "SIP MESSAGE request for FD disposition notification for terminating MCData client"; + +- SIP MESSAGE request routed to the MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-info+xml MIME body containing a element in of the SIP MESSAGE request contains the value "msf-disc-res". Such requests are known as "SIP MESSAGE request for absolute URI discovery response"; and +- SIP MESSAGE request routed to the MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an DEFERRED DATA RESPONSE message. Such requests are known as "SIP MESSAGE response for the list of deferred group communications request". + +## 6.2.1.2 SIP INVITE request + +The MCData client needs to distinguish between the following SIP INVITE requests for terminations: + +- SIP INVITE request routed to the terminating MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds" or "group-sds" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "initial SIP INVITE request for standalone SDS over media plane for terminating MCData client"; +- SIP INVITE request routed to the terminating MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds-session" or "group-sds-session" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "initial SIP INVITE request for SDS session for terminating MCData client"; +- SIP INVITE request routed to the terminating MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field and a element set to "one-to-one-fd" or "group-fd" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "initial SIP INVITE request for file distribution for terminating MCData client"; and +- SIP INVITE request routed to the terminating MCData client with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" in a P-Asserted-Service header field and a element set to "one-to-one-ipconn" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "initial SIP INVITE request for IP Connectivity session for terminating MCData client". + +## 6.2.2 MCData conversation items + +### 6.2.2.1 Generating an SDS Message + +In order to generate an SDS message, the MCData client: + +- 1) shall generate an SDS SIGNALLING PAYLOAD message as specified in subclause 15.1.2; +- 2) shall generate a DATA PAYLOAD message as specified in subclause 15.1.4; +- 3) shall include in the SIP request, the SDS SIGNALLING PAYLOAD message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and +- 4) shall include in the SIP request, the DATA PAYLOAD message in an application/vnd.3gpp.mcdata-payload MIME body as specified in subclause E.2. + +When generating an SDS SIGNALLING PAYLOAD message as specified in subclause 15.1.2, the MCData client: + +- 1) shall set the Date and time IE to the current time as specified in subclause 15.2.8; + +- 2) if the SDS message starts a new conversation, shall set the Conversation ID IE to a newly generated Conversation ID value as specified in subclause 15.2.9; +- 3) if the SDS message continues an existing unfinished conversation, shall set the Conversation ID IE to the Conversation ID value of the existing conversation as specified in subclause 15.2.9; +- 4) shall set the Message ID IE to a newly generated Message ID value as specified in subclause 15.2.10; +- 5) if the SDS message is in reply to a previously received SDS message, shall include the InReplyTo message ID IE with the Message ID value in the previously received SDS message; +- 6) if the SDS message is for user consumption, shall not include an Application ID IE as specified in subclause 15.2.7 and shall not include an Extended application ID IE as specified in subclause 15.2.24; +- 7) if the SDS message is intended for an application on the terminating MCData client, shall include: + - a) an Application ID IE with a Application ID value representing the intended application as specified in subclause 15.2.7; or + - b) an Extended application ID IE with an Extended application ID value representing the intended application as specified in subclause 15.2.24; + +NOTE: The value chosen for the Application ID value is decided by the mission critical organisation. + +- 8) if only a delivery disposition notification is required shall include a SDS disposition request type IE set to "DELIVERY" as specified in subclause 15.2.3; +- 9) if only a read disposition notification is required shall include a SDS disposition request type IE set to "READ" as specified in subclause 15.2.3; +- 10) if both a delivery and read disposition notification is required shall include a SDS disposition request type IE set to "DELIVERY AND READ" as specified in subclause 15.2.3; and +- 11) may set the User location IE to the current location of the UE as specified in subclause 15.2.25. + +When generating an DATA PAYLOAD message for SDS as specified in subclause 15.1.4, the MCData client: + +- 1) shall set the Number of payloads IE to the number of Payload IEs that needs to be encoded, as specified in subclause 15.2.12; +- 2) if end-to-end security is required for a one-to-one communication, shall include the Security parameters and Payload IE with security parameters as described in 3GPP TS 33.180 [26]. Otherwise, if end-to-end security is not required for a one-to-one communication, shall include the Payload IE as specified in subclause 15.1.4; and +- 3) for each Payload IE included: + - a) if the payload is text, shall set the Payload content type as "TEXT" as specified in subclause 15.2.13; + - b) if the payload is binary data, shall set the Payload content type as "BINARY" as specified in subclause 15.2.13; + - c) if the payload is hyperlinks, shall set the Payload content type as "HYPERLINKS" as specified in subclause 15.2.13; + - d) if the payload is location, shall set the Payload content type as "LOCATION" as specified in subclause 15.2.13; + - e) if payload is enhanced status for a group, shall set the Payload content type as "ENHANCED STATUS" as specified in subclause 15.2.13; and + - f) shall include the data to be sent in the Payload data. + +## 6.2.2.2 Generating an FD Message for FD using HTTP + +In order to generate an FD message, the MCData client: + +- 1) shall generate an FD SIGNALLING PAYLOAD message as specified in subclause 15.1.3; and +- 2) shall include in the SIP request, the FD SIGNALLING PAYLOAD message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1. + +When generating an FD SIGNALLING PAYLOAD message as specified in subclause 15.1.3, the MCData client: + +- 1) shall set the Date and time IE to the current time as specified in subclause 15.2.8; +- 2) if the FD message starts a new conversation, shall set the Conversation ID IE to a newly generated Conversation ID value as specified in subclause 15.2.9; +- 3) if the FD message continues an existing unfinished conversation, shall set the Conversation ID IE to the Conversation ID value of the existing conversation as specified in subclause 15.2.9; +- 4) shall set the Message ID IE to a newly generated Message ID value as specified in subclause 15.2.10; +- 5) if the FD message is in reply to a previously received MCData message, shall include the InReplyTo message ID IE with the Message ID value in the previously received MCData message; +- 6) if the FD message is for user consumption, shall not include an Application ID IE as specified in subclause 15.2.7 and shall not include an Extended application ID IE as specified in subclause 15.2.24; +- 7) if the FD message is intended for an application on the terminating MCData client, shall include: + - a) an Application ID IE with a Application ID value representing the intended application as specified in subclause 15.2.7; or + - b) an Extended application ID IE with an Extended application ID value representing the intended application as specified in subclause 15.2.24; + +NOTE: The value and field chosen for coding the identity of the application are coordinated by the mission critical organisation. + +- 8) may include an FD disposition request type IE set to "FILE DOWNLOAD COMPLETE UPDATE" as specified in subclause 15.2.4; +- 9) if requiring mandatory download at the recipient side, shall include a Mandatory download IE as specified in subclause 15.2.16 set to the value of "MANDATORY DOWNLOAD"; +- 10) shall include a Payload IE with: + - a) the Payload content type set to "FILEURL" as specified in subclause 15.2.13; and + - b) the URL of the file in the Payload data as as specified in subclause 15.2.13; and +- 11) may include a Metadata IE with the required file description information and file availability information, as specified in subclause 15.2.17. + +### 6.2.2.3 Generating an FD Message for FD using media plane + +In order to generate an FD message, the MCData client: + +- 1) shall generate an FD SIGNALLING PAYLOAD message as specified in subclause 15.1.3; and +- 2) shall include in the SIP request, the FD SIGNALLING PAYLOAD message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1. + +When generating an FD SIGNALLING PAYLOAD message as specified in subclause 15.1.3, the MCData client: + +- 1) shall set the Date and time IE to the current time as specified in subclause 15.2.8; +- 2) if the file starts a new conversation, shall set the Conversation ID IE to a newly generated Conversation ID value as specified in subclause 15.2.9; +- 3) if the file continues an existing conversation, shall set the Conversation ID IE to the Conversation ID value of the existing conversation as specified in subclause 15.2.9; + +- 4) shall set the Message ID IE to a newly generated Message ID value as specified in subclause 15.2.10; +- 5) if the file is in reply to a previously received SDS message or file, shall include the InReplyTo message ID IE with the Message ID value in the previously received SDS message or file; +- 6) if the file is for user consumption, shall not include an Application ID IE as specified in subclause 15.2.7 and shall not include an Extended application ID IE as specified in subclause 15.2.24; +- 7) if the file is intended for an application on the terminating MCData client, shall include: + - a) an Application ID IE with a Application ID value representing the intended application as specified in subclause 15.2.7; or + - b) an Extended application ID IE with an Extended application ID value representing the intended application as specified in subclause 15.2.24; + +NOTE: The value and field chosen for coding the identity of the application are coordinated by the mission critical organisation. + +- 8) if a file download complete notification is required shall include a FD disposition request type IE set to "FILE DOWNLOAD COMPLETED UPDATE" as specified in subclause 15.2.4; and +- 9) shall include and set the Mandatory download IE to "MANDATORY DOWNLOAD" as described in subclause 15.2.16. + +#### 6.2.2.4 Client generating message to terminate FD over HTTP + +In order to generate an message to terminate FD using HTTP, the MCData client: + +- 1) shall generate an FD HTTP TERMINATION message as specified in subclause 15.1.13; and +- 2) shall include in the SIP request, the FD HTTP TERMINATION message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1. + +When generating an FD HTTP TERMINATION message as specified in subclause 15.1.13, the MCData client: + +- 1) shall set the Conversation ID IE to a value identifying the conversation, as specified in subclause 15.2.9; +- 2) shall set the Message ID IE to a value identifying the message as specified in subclause 15.2.10; +- 3) may set: + - a) the Application ID IE to the stored value if applicable; or + - b) the Extended Application ID IE to the stored value if applicable; +- 4) shall include a Payload IE with: + - a) shall set the Payload content type set to "FILEURL" as specified in subclause 15.2.13; and + - b) shall set the URL of the file same as of FD transmission; and +- 5) Shall set the Termination information type IE set to "TERMINATION REQUEST" as specified in subclause 15.2.22. + +### 6.2.3 Disposition Notifications + +#### 6.2.3.1 Generating an SDS Notification + +In order to generate an SDS notification, the MCData client: + +- 1) shall generate an SDS NOTIFICATION message as specified in subclause 15.1.5; and +- 2) shall include in the SIP request, the SDS NOTIFICATION message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1. + +When generating an SDS NOTIFICATION message as specified in subclause 15.1.5, the MCData client: + +- 1) if sending a delivered notification, shall set the SDS disposition notification type IE as "DELIVERED" as specified in subclause 15.2.5; +- 2) if sending a read notification, shall set the SDS disposition notification type IE as "READ" as specified in subclause 15.2.5; +- 3) if sending a delivered and read notification, shall set the SDS disposition notification type IE as "DELIVERED AND READ" as specified in subclause 15.2.5; +- 4) if the SDS message could not be delivered to the user or application (e.g. due to lack of storage), shall set the SDS disposition notification type IE as "UNDELIVERED" as specified in subclause 15.2.5; +- 5) shall set the Date and time IE to the current time to as specified in subclause 15.2.8; +- 6) shall set the Conversation ID to the value of the Conversation ID that was received in the SDS message as specified in subclause 15.2.9; +- 7) shall set the Message ID to the value of the Message ID that was received in the SDS message as specified in subclause 15.2.10; +- 8) if the SDS message was destined for the user, shall not include an Application ID IE (as specified in subclause 15.2.7) and shall not include an Extended application ID IE (as specified in subclause 15.2.24); and +- 9) if the SDS message was destined for an application, shall include: + - a) an Application ID IE set to the value of the Application ID that was included in the SDS message as specified in subclause 15.2.3; or + - b) an Extended application ID IE set to the value of the Extended application ID that was included in the SDS message as specified in subclause 15.2.24. + +### 6.2.3.2 Generating an FD Notification + +In order to generate an FD notification, the MCData client: + +- 1) shall generate an FD NOTIFICATION message as specified in subclause 15.1.6; and +- 2) shall include in the SIP request, the FD NOTIFICATION message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1. + +When generating an FD NOTIFICATION message as specified in subclause 15.1.6, the MCData client: + +- 1) if sending a file download accept notification, shall set the FD disposition notification type IE as "FILE DOWNLOAD REQUEST ACCEPTED" as specified in subclause 15.2.6; +- 2) if sending a file download reject notification, shall set the FD disposition notification type IE as "FILE DOWNLOAD REQUEST REJECTED" as specified in subclause 15.2.6; +- 3) if sending a file download deferred notification, shall set the FD disposition notification type IE as "FILE DOWNLOAD REQUEST DEFERRED" as specified in subclause 15.2.6; +- 4) shall set the Conversation ID to the value of the Conversation ID that was received in the FD message as specified in subclause 15.2.9; +- 5) shall set the Date and time IE to the current time as specified in subclause 15.2.8; and +- 6) if sending a file download completed notification: + - a) shall set the FD disposition notification type IE as "FILE DOWNLOAD COMPLETED" as specified in subclause 15.2.6; + - b) shall set the Message ID to the value of the Message ID that was received in the FD message as specified in subclause 15.2.10; + - c) if the FD message was destined for the user, shall not include an Application ID IE as specified in subclause 15.2.7 and shall not include a Extended application ID IE as specified in subclause 15.2.24; and + +- d) if the FD message was destined for an application, shall include: + - i) an Application ID IE set to the value of the Application ID that was included in the FD message as specified in subclause 15.2.3; or + - ii) an Extended application ID IE set to the value of the Extended application ID that was included in the FD message as specified in subclause 15.2.24. + +## 6.2.4 Sending SIP requests and receiving SIP responses + +### 6.2.4.1 Generating a SIP MESSAGE request towards the originating participating MCData function + +This subclause is referenced from other procedures. + +In a SIP MESSAGE request, the MCData client: + +- 1) when sending SDS messages or SDS disposition notifications: + - a) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + - b) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; and + - c) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP MESSAGE request; +- 2) when sending FD messages, FD disposition notifications or FD media storage function discovery messages: + - a) shall include an Accept-Contact header field containing the g.3gpp.mcdata.fd media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + - b) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; and + - c) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP MESSAGE request; +- 3) may include a P-Preferred-Identity header field in the SIP MESSAGE request containing a public user identity as specified in 3GPP TS 24.229 [5]; and +- 4) shall set the Request-URI to the public service identity identifying the participating MCData function serving the MCData user. + +## 6.2.5 Location information + +### 6.2.5.1 Location information for location reporting + +This procedure is initiated by the MCData client when it is including location report information as part of a SIP request for a specified location trigger. + +The MCData client: + +- 1) shall include an application/vnd.3gpp.location-info+xml MIME body as specified in Annex D.4 with a element included in the root element; and +- 2) shall include in the element the specific location information configured for the specified location trigger. + +## 6.3 MCData server procedures + +### 6.3.1 Distinction of requests at the MCData server + +#### 6.3.1.1 SIP MESSAGE request + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +The MCData server needs to distinguish between the following SIP MESSAGE request for originations and terminations: + +- SIP MESSAGE requests routed to the participating MCData function as a result of processing initial filter criteria at the S-CSCF in accordance with the origination procedures as specified in 3GPP TS 24.229 [5] with the Request-URI set to the MBMS public service identity of the participating MCData function. Such requests are known as "SIP MESSAGE request for an MBMS listening status update"; +- SIP MESSAGE request routed to the participating MCData function containing a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml" and includes an XML body containing a Location root element containing a Report element. Such requests are known as "SIP MESSAGE request for location reporting"; +- SIP MESSAGE request routed to the MCData client containing a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml" and includes an XML body containing a Location root element containing a Configuration element. Such requests are known as "SIP MESSAGE request for location report configuration"; +- SIP MESSAGE request routed to the MCData client containing a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml" and includes an XML body containing a Location root element containing a Request element. Such requests are known as "SIP MESSAGE request for location report request"; +- SIP MESSAGE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for standalone SDS for originating participating MCData function"; +- SIP MESSAGE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-info+xml MIME body containing a element containing the value "msf-disc-req". Such requests are known as "SIP MESSAGE request for absolute URI discovery request for participating MCData function"; +- SIP MESSAGE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-info+xml MIME body containing a element containing the value "msf-disc-res". Such requests are known as "SIP MESSAGE request for absolute URI discovery response for participating MCData function"; +- SIP MESSAGE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-info+xml MIME body containing a element containing the value "msf-disc-req". Such requests are known as "SIP MESSAGE request for absolute URI discovery request for controlling MCData function"; +- SIP MESSAGE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted- + +Service header field. Such requests are known as "SIP MESSAGE request for FD using HTTP for originating participating MCData function"; + +- SIP MESSAGE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an FD NETWORK NOTIFICATION message. Such requests are known as "SIP MESSAGE network notification for FD using HTTP for terminating participating MCData function"; +- SIP MESSAGE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for standalone SDS for terminating participating MCData function"; +- SIP MESSAGE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for FD using HTTP for terminating participating MCData function"; +- SIP MESSAGE request routed to an MCData server with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an SDS NOTIFICATION message. Such requests are known as "SIP MESSAGE request for SDS disposition notification for MCData server"; +- SIP MESSAGE request routed to an MCData server with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an FD NOTIFICATION message. Such requests are known as "SIP MESSAGE request for FD disposition notification for MCData server"; +- SIP MESSAGE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for standalone SDS for controlling MCData function"; +- SIP MESSAGE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field. Such requests are known as "SIP MESSAGE request for FD using HTTP for controlling MCData function"; +- SIP MESSAGE requests routed to the controlling MCData function with the Request-URI set to the public service identity of the controlling MCData function and containing a Content-Type header field set to "application/vnd.3gpp.mcdata-info+xml" and including an XML body containing a root element containing a element containing an element or an <>alert-ind> element. Such requests are known as "SIP MESSAGE requests for emergency notification for controlling MCData function"; +- SIP MESSAGE requests routed to the originating participating MCData function with the Request-URI set to the public service identity of the participating MCData function and containing a Content-Type header field set to "application/vnd.3gpp.mcdata-info+xml" and including an XML body containing a root element containing a element containing an element or an <>alert-ind> element. Such requests are known as "SIP MESSAGE requests for emergency notification for originating participating MCData function"; +- SIP MESSAGE requests routed to the terminating participating MCData function with the Request-URI set to the public service identity of the terminating participating MCData function and containing a Content-Type header field set to "application/vnd.3gpp.mcdata-info+xml" and including an XML body containing a root element containing a element containing an element or an <>alert-ind> element. Such requests are known as "SIP MESSAGE requests for emergency notification for terminating participating MCData function"; + +- SIP MESSAGE requests routed to the terminating participating MCData function with the Request-URI set to the public service identity of the terminating participating MCData function and containing an "application/vnd.3gpp.mcdata-info+xml" MIME body with an element present. Such requests are known as "SIP MESSAGE requests indicating delivery of emergency notification"; and +- SIP MESSAGE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field, and with an application/vnd.3gpp.mcdata-signalling MIME body containing an DEFERRED DATA REQUEST message. Such requests are known as "SIP MESSAGE request for list of deferred group communications". + +If a SIP MESSAGE request is received at an MCData server that is not in accordance with the SIP MESSAGE requests listed above, then the MCData server shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response. + +### 6.3.1.2 SIP INVITE request + +The MCData server needs to distinguish between the following SIP INVITE requests for originations and terminations: + +- SIP INVITE requests routed to the participating MCData function with the Request-URI set to a public service identity of the participating MCData function and contain in an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element and an element set to a value of "true". Such requests are known as "SIP INVITE request for establishing a pre-established session" in the procedures in the present document; +- SIP INVITE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds" or "group-sds" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for standalone SDS over media plane for originating participating MCData function"; +- SIP INVITE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds" or "group-sds" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for standalone SDS over media plane for terminating participating MCData function"; +- SIP INVITE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds" or "group-sds" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for controlling MCData function for standalone SDS over media plane"; +- SIP INVITE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds-session" or "group-sds-session" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for SDS session for originating participating MCData function"; +- SIP INVITE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds-session" or "group-sds-session" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for SDS session for terminating participating MCData function"; +- SIP INVITE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in a P-Asserted-Service header field and a element set to "one-to-one-sds-session" or "group-sds-session" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for controlling MCData function for SDS session"; + +- SIP INVITE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field and a element set to "one-to-one-fd" or "group-fd" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for file distribution for originating participating MCData function"; +- SIP INVITE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field and a element set to "one-to-one-fd" or "group-fd" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for file distribution for terminating participating MCData function"; and +- SIP INVITE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in a P-Asserted-Service header field and a element set to "one-to-one-fd" or "group-fd" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for controlling MCData function for file distribution"; +- SIP INVITE request routed to the originating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" in a P-Asserted-Service header field and a element set to "one-to-one-ipconn" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for IP Connectivity session for originating participating MCData function"; +- SIP INVITE request routed to the terminating participating MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" in a P-Asserted-Service header field and a element set to "one-to-one-ipconn" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for IP Connectivity session for terminating participating MCData function"; and +- SIP INVITE request routed to the controlling MCData function with an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn", and an ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" in a P-Asserted-Service header field and a element set to "one-to-one-ipconn" contained in an application/vnd.3gpp.mcdata-info+xml MIME body. Such requests are known as "SIP INVITE request for controlling MCData function for IP Connectivity session". + +## 6.3.2 Sending SIP requests and receiving SIP responses + +### 6.3.2.1 Generating a SIP MESSAGE request towards the terminating MCData client + +This subclause is referenced from other procedures. + +The participating MCData function shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] and: + +- 1) shall include in the SIP MESSAGE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [8] that were received (if any) in the incoming SIP MESSAGE request; +- 2) shall set the Request-URI of the outgoing SIP MESSAGE request to the public user identity associated to the MCData ID of the terminating MCData user; +- 3) shall populate the outgoing SIP MESSAGE request MIME bodies as specified in subclause 6.4 and + +- 4) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP MESSAGE request to the P-Asserted-Identity header field of the outgoing SIP MESSAGE request. + +### 6.3.3 Retrieving a group document + +This subclause describes how an MCData server accesses a group document from a group management server. + +Upon receipt of a SIP request: + +- 1) if the MCData server is not yet subscribed to the group document for the group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP request, the MCData server shall subscribe to the "xcap-diff" event-package for the group document of this group identity as specified in 3GPP TS 24.481 [11]; +- NOTE: As a group document can potentially have a large content, the MCData server can subscribe to the group document indicating support of content-indirection as defined in IETF RFC 4483 [13], by following the procedures in 3GPP TS 24.481 [11]. +- 2) upon receipt of a SIP 404 (Not Found) response as a result of attempting to subscribe to the "xcap-diff" event-package for the group document of the group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP request as specified in 3GPP TS 24.481 [11], the MCData server shall send the SIP 404 (Not Found) response with the warning text set to "113 group document does not exist" in a Warning header field as specified in subclause 4.9. Otherwise, continue with the rest of the steps; and + - 3) upon receipt of any other SIP 4xx, SIP 5xx or SIP 6xx response as a result of attempting to subscribe to the "xcap-diff" event-package for the group document of the group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request as specified in 3GPP TS 24.481 [11], the MCData server shall send the SIP final response with the warning text set to "114 unable to retrieve group document" in a Warning header field as specified in subclause 4.4 and shall not continue with the rest of the steps; + +### 6.3.4 Determining targeted group members for MCData communications + +The MCData server shall only send MCData messages to affiliated group members. + +The MCData server determines whether a user is affiliated to a group by following the procedures in subclause 6.3.5. + +The MCData server performs the affiliation check in subclause 6.3.5 on each entry contained in the element of the group document. + +### 6.3.5 Affiliation check + +The MCData server shall determine that the MCData user, with MCData User ID, is affiliated to the MCData group, with MCData Group ID, at the MCData client, with MCData client ID, if the elements, as described in subclause 8.3.3.2, exist with their expected values, as below: + +1. an MCData group information entry with MCData group ID same as the MCData group ID under consideration; +2. in the MCData group information entry found in 1, an MCData user information entry with the MCData ID same as the MCData ID under consideration; +3. in the MCData user information entry found in 2, an MCData client information entry with MCData Client ID same as the MCData client ID under consideration; and +4. in the MCData user information entry found in 2, an expiration time, which has not expired. + +### 6.3.6 MCData conversation items + +#### 6.3.6.1 Server generating a FD HTTP TERMINATION message for FD over HTTP + +In order to generate an terminating response message for FD over HTTP, the MCData server: + +- 1) shall generate an FD HTTP TERMINATION message as specified in subclause 15.1.13; and + +- 2) shall include in the SIP request, the FD HTTP TERMINATION message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1. + +When generating an FD HTTP TERMINATION message as specified in subclause 15.1.13, the MCData server: + +- 1) shall set the Conversation ID IE to a value identifying the conversation, as specified in subclause 15.2.9; +- 2) shall set the Message ID IE to a value identifying the message as specified in subclause 15.2.10; +- 3) may set the Application ID IE ID to the stored value if applicable; +- 4) shall include a Payload IE with: + - a) Shall set the Payload content type set to "FILEURL" as specified in subclause 15.2.13; and + - b) Shall set the URL of the file same as payload of FD transmission; and +- 5) Shall set the Termination information type IE set to "TERMINATION RESPONSE" as specified in subclause 15.2.22. + +## 6.3.7 Procedures referenceable from other procedures + +### 6.3.7.1 Emergency alert and emergency communications procedures + +#### 6.3.7.1.1 Sending a SIP re-INVITE request for MCData emergency alert or emergency group communication + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +This clause is referenced from other procedures. + +The controlling MCData function shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [5]. + +The controlling MCData function: + +- 1) shall include an SDP offer with the media parameters as currently established with the terminating MCData client according to 3GPP TS 24.229 [5]; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to the MCData ID of the initiating MCData user; +- 3) if the in-progress emergency group state of the group is set to a value of "true" the controlling MCData function: + - a) shall include a Resource-Priority header field with the namespace populated with the values for an MCData emergency group communication as specified in subclause 6.3.7.1.4; + - b) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body the element set to a value of "true"; and + - c) if the element is set to "true" in the received SIP re-INVITE request and MCData emergency alerts are authorised for this group and MCData user as determined by the procedures of subclause 6.3.7.2.1, shall populate the application/vnd.3gpp.mcdata-info+xml MIME body and application/vnd.3gpp.mcdata-location-info+xml MIME body as specified in subclause 6.3.7.1.3. Otherwise, shall set the element to a value of "false" in the application/vnd.3gpp.mcdata-info+xml MIME body; +- 4) if the in-progress emergency group state of the group is set to a value of "false": + - a) shall include a Resource-Priority header field populated with the values for a normal MCData group communication as specified in subclause 6.3.7.1.4; and + - b) if the received SIP re-INVITE request contained an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false" and this is an authorised request to cancel an MCData emergency group communication as determined by the procedures of subclause 6.3.7.2.3: + +- i) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false"; and +- ii) if the received SIP re-INVITE request contained an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false" and this is an authorised request to cancel an MCData emergency alert as determined by the procedures of subclause 6.3.7.2.2, shall: + - A) include in the application/vnd.3gpp.mcdata-info+xml MIME body an element set to a value of "false"; and + - B) if the received SIP request contains an element in the application/vnd.3gpp.mcdata-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP re-INVITE request. + +#### 6.3.7.1.2 Generating a SIP MESSAGE request for notification of in-progress emergency status change + +**Editor's note:** In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +This clause is referenced from other procedures. + +This clause describes the procedures for generating a SIP MESSAGE request to notify affiliated but not participating members of an MCData group of the change of status of the in-progress emergency state or emergency alert status of an MCData group. The procedure is initiated by the controlling MCData function when there has been a change of in-progress emergency or the emergency alert status of an MCData group. + +The controlling MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 3) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 4) shall set the Request-URI to the address of the terminating participating function associated with the MCData ID of the targeted MCData user; +- 5) shall include a P-Asserted-Identity header field set to the public service identity of controlling MCData function; +- 6) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; +- 7) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to the value of the MCData ID of the targeted MCData user; and +- 8) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body an element set to the MCData group ID of the MCData group on which the MCData emergency communication or the emergency alert state has changed. + +#### 6.3.7.1.3 Populate mcdata-info and location-info MIME bodies for emergency alert + +This clause is referenced from other procedures. + +This clause describes the procedures for populating the application/vnd.3gpp.mcdata-info+xml and application/vnd.3gpp.mcdata-location-info+xml MIME bodies for an MCData emergency alert. The procedure is initiated by the controlling MCData function when it has received a SIP request initiating an MCData emergency alert and generates a message containing the MCData emergency alert information required by 3GPP TS 23.282 [2]. + +The controlling MCData function: + +- 1) shall include, if not already present, an application/vnd.3gpp.mcdata-info+xml MIME body as specified in Annex D.1, and set the element to a value of "true"; +- 2) shall determine the value of the MCData user's Mission Critical Organization from the element, of the MCData user profile document identified by the MCData ID and profile index associated with MCData user (see the MCData user profile document in 3GPP TS 24.484 [12]); +- 3) shall include in the element containing the element an element set to the value of the MCData user's Mission Critical Organization; and +- 4) shall copy the contents of the application/vnd.3gpp.mcdata-location-info+xml MIME body in the received SIP request into an application/vnd.3gpp.mcdata-location-info+xml MIME body included in the outgoing SIP request. + +#### 6.3.7.1.4 Retrieving Resource-Priority header field values for emergency communications + +**Editor's note:** In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +This clause is referenced from other procedures. + +When determining the Resource-Priority header field namespace and priority values as specified in IETF RFC 8101 [67] for an MCData emergency communication, the controlling MCData function: + +- 1) shall retrieve the value of the element contained in the element contained in the element of the MCData service configuration document (see the service configuration document in 3GPP TS 24.484 [12]); and +- 2) shall retrieve the value of the element contained in the element contained in the element of the MCData service configuration document (see the service configuration document in 3GPP TS 24.484 [12]). + +When determining the Resource-Priority header field namespace and priority values as specified in IETF RFC 8101 [67] for a normal MCData communication, the controlling MCData function: + +- 1) shall retrieve the value of the element contained in the element contained in the element of the MCData service configuration document (see the service configuration document in 3GPP TS 24.484 [12]); and +- 2) shall retrieve the value of the element contained in the element contained in the element of the MCData service configuration document (see the service configuration document in 3GPP TS 24.484 [12]). + +**NOTE:** The "normal" Resource-Priority header field value is needed to return to a normal priority value from a priority value adjusted for an MCData emergency communication. The "normal" priority received from the EPS by use of the "normal" Resource-Priority header field value is expected to be the same as the "normal" priority received from the EPS when initiating a communication with no Resource-Priority header field included. + +#### 6.3.7.1.5 Generating a SIP MESSAGE request to indicate successful receipt of an emergency alert or emergency cancellation + +**Editor's note:** In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +This clause is referenced from other procedures. + +This clause describes the procedures for generating a SIP MESSAGE request to notify the originator of an emergency alert or emergency cancellation that the request was successfully received. + +The controlling MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; + +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 3) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 4) shall set the Request-URI to the address of the terminating participating function associated with the MCData ID of the targeted MCData user; +- 5) shall include a P-Asserted-Identity header field set to the public service identity of controlling MCData function; and +- 6) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to the value of the MCData ID of the targeted MCData user. + +### 6.3.7.2 Authorisations + +#### 6.3.7.2.1 Determining authorisation for initiating an MCData emergency alert + +If the controlling MCData function has received a SIP request targeted to an MCData group with the element of the application/vnd.3gpp.mcdata-info+xml MIME body set to a value of "true", the controlling MCData function shall check the following conditions: + +- 1) if the element of the element of a element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "true": + - a) if the "entry-info" attribute of the element of the element contained within the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "DedicatedGroup" and: + - i) if the MCData group identity targeted for the emergency alert is contained in the element of the element of the element contained within the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]); and + - ii) if the element of the element of a element of the element of the element of the group document identified by the MCData group identity is set to a value of "true" as specified in 3GPP TS 24.481 [11]; or + - b) if the "entry-info" attribute of the element of the element contained within the element of the MCData user profile (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "UseCurrentlySelectedGroup" and the element of the element of a element of the element of the element of the group document identified by the MCData group identity targeted for the emergency alert is set to a value of "true" as specified in 3GPP TS 24.481 [11]; + +then the MCData emergency alert request shall be considered to be an authorised request for an MCData emergency alert targeted to a MCData group. In all other cases, the MCData emergency alert request shall be considered to be an unauthorised request for an MCData emergency alert targeted to an MCData group. + +If the controlling MCData function has received a SIP request targeted to an MCData user with the element of the application/vnd.3gpp.mcdata-info+xml MIME body set to a value of "true", the controlling MCData function shall check the following conditions: + +- 1) if the element of the element of the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "true"; and + - a) if the "entry-info" attribute of the element of the element contained within the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "UsePreConfigured" and the MCData ID of the MCData user + +targeted for the communication is contained in the element of the element of the element contained within the element (see the MCData user profile document in 3GPP TS 24.484 [12]); or + +- b) if the "entry-info" attribute of the element of the element contained within the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "LocallyDetermined"; + +then the MCData emergency alert request shall be considered to be an authorised request for an MCData emergency alert targeted to an MCData user. In all other cases, it shall be considered to be an unauthorised request for an MCData emergency alert targeted to an MCData user. + +#### 6.3.7.2.2 Determining authorisation for cancelling an MCData emergency alert + +If the controlling MCData function has received a SIP request with the element of the application/vnd.3gpp.mcdata-info+xml MIME body set to a value of "false" and: + +- 1) if the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "true", then the MCData emergency alert cancellation request shall be considered to be an authorised request for an MCData emergency alert cancellation; and +- 2) if the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "false", then the MCData emergency alert cancellation request shall be considered to be an unauthorised request for an MCData emergency alert cancellation. + +#### 6.3.7.2.3 Determining authorisation for cancelling an MCData emergency communication + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +If the controlling MCData function has received a SIP request for an MCData group communication with the element of the application/vnd.3gpp.mcdata-info+xml MIME body set to a value of "false" and: + +- 1) if the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "true", then the MCData emergency communication cancellation request shall be considered to be an authorised request for an MCData emergency group communication cancellation; and +- 2) If the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "false", then the MCData emergency group communication cancellation request shall be considered to be an unauthorised request for an MCData emergency group communication cancellation. + +If the controlling MCData function has received a SIP request for an MCData private communication with the element of the application/vnd.3gpp.mcdata-info+xml MIME body set to a value of "false" and: + +- 1) if the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "true", then the MCData emergency private communication cancellation request shall be considered to be an authorised request for an MCData emergency private communication cancellation; and +- 2) if the element of the element of the MCData user profile document identified by the MCData ID and profile index of the calling user (see the MCData user profile document in 3GPP TS 24.484 [12]) is set to a value of "false" or not present, then the MCData emergency private communication cancellation request shall be considered to be an unauthorised request for an MCData emergency private communication cancellation. + +## 6.4 Handling of MIME bodies in a SIP message + +The MCData client and the MCData server shall support several MIME bodies in SIP requests and SIP responses. + +When the MCData client or the MCData server sends a SIP message and the SIP message contains more than one MIME body, the MCData client or the MCData server: + +- 1) shall, as specified in IETF RFC 2046 [21], include one Content-Type header field with the value set to multipart/mixed and with a boundary delimiter parameter set to any chosen value; +- 2) for each MIME body: + - a) shall insert the boundary delimiter; + - b) shall insert the Content-Type header field with the MIME type of the MIME body; and + - c) shall insert the content of the MIME body; +- 3) shall insert a final boundary delimiter; and +- 4) if an SDP offer or an SDP answer is one of the MIME bodies, shall insert the application/sdp MIME body as the first MIME body. + +NOTE: The reason for inserting the application/sdp MIME body as the first body is that if a functional entity in the underlying SIP core does not understand multiple MIME bodies, the functional entity will ignore all MIME bodies with the exception of the first MIME body. The order of multiple MCData application MIME bodies in a SIP message is irrelevant. + +When the MCData client or the MCData server sends a SIP message and the SIP message contains only one MIME body, the MCData client or the MCData server: + +- 1) shall include a Content-Type header field set to the MIME type of the MIME body; and +- 2) shall insert the content of the MIME body. + +## 6.5 Confidentiality and Integrity Protection of sensitive XML content + +### 6.5.1 General + +#### 6.5.1.1 Applicability and exclusions + +The procedures in subclauses 6.5 apply in general to all procedures described in clause 9, clause 10, clause 12 and clause 13 with the exception that the confidentiality and integrity protection procedures for the registration and service authorisation procedures are described in clause 7. + +#### 6.5.1.2 Performing XML content encryption + +Whenever the MCData UE includes XML elements or attributes pertaining to the data specified in subclause 4.6 in SIP requests or SIP responses, the MCData UE shall perform the procedures in subclause 6.5.2.3.1. + +Whenever the MCData server includes XML elements or attributes pertaining to the data specified in subclause 4.6 in SIP requests or SIP responses, the MCData server shall perform the procedures in subclause 6.5.2.3.2, with the exception that when the MCData server receives a SIP request with XML elements or attributes in an MIME body that need to be copied from the incoming SIP request to an outgoing SIP request without modification, the MCData server shall perform the procedures specified in subclause 6.5.2.5. + +NOTE: The procedures in subclause 6.5.2.3.1 and subclause 6.5.2.3.2 first determine (by referring to configuration) if confidentiality protection is enabled and then call the necessary procedures to encrypt the contents of the XML elements if confidentiality protection is enabled. + +#### 6.5.1.3 Performing integrity protection on an XML body + +The functional entity shall perform the procedures in this subclause just prior to sending a SIP request or SIP response. + +- 1) The MCData UE shall perform the procedures in subclause 6.5.3.3.1; and +- 2) The MCData server shall perform the procedures in subclause 6.5.3.3.2. + +NOTE: The procedures in subclause 6.5.3.3.1 and subclause 6.5.3.3.2 first determine if integrity protection of XML MIME bodies is required and then calls the necessary procedures to integrity protect each XML MIME body if integrity protection is required. Each XML MIME body has its own signature. + +#### 6.5.1.4 Verifying integrity of an XML body and decrypting XML elements + +Whenever the functional entity (i.e. MCData UE or MCData server) receives a SIP request or a SIP response, the functional entity shall perform the following procedures before performing any other procedures. + +- 1) The functional entity shall determine if integrity protection has been applied to an XML MIME body by following the procedures in subclause 6.5.3.4.1 and if integrity protection has been applied: + - a) shall use the keying information described in subclause 6.5.3.2 and the procedures described in subclause 6.5.3.4.2 to verify the integrity of the XML MIME body; and + - b) if the integrity protection checks fail shall not perform any further procedures in this clause; +- 2) The functional entity shall determine whether confidentiality protection has been applied to XML elements in XML MIME bodies in a SIP request or SIP response, pertaining to the data specified in subclause 4.6, by following the procedures in subclause 6.5.2.4.1, and if confidentiality protection has been applied: + - a) shall use the keying information described in subclause 6.5.2.2 along with the procedures described in subclause 6.5.2.4.2 to decrypt the received values; and + - b) if any decryption procedures fail, shall not perform any further procedures in this clause. + +### 6.5.2 Confidentiality Protection + +#### 6.5.2.1 General + +In general, confidentiality protection is applied to specific XML elements and attributes in XML MIME bodies in SIP requests and responses as specified in subclause 4.6. + +Configuration for applying confidentiality protection is not selective to a specific XML element or attribute of the data described in subclause 4.6. If configuration for confidentiality protection is turned on, then all XML elements and attributes described in subclause 4.6 are confidentiality protected. If configuration for confidentiality protection is turned off, then no XML content in SIP requests and SIP responses are confidentiality protected. + +#### 6.5.2.2 Keys used in confidentiality protection procedures + +Confidentiality protection uses an XPK to encrypt the data which (depending on who is the sender and who is the receiver of the encrypted information) can be a CSK or an SPK as specified in subclause 4.6. An XPK-ID (CSK-ID/SPK-ID) is used to key the XPK (CSK/SPK). It is assumed that before the procedures in this subclause are called, the CSK/CSK-ID and/or SPK/SPK-ID are available on the sender and recipient of the encrypted content as described in subclause 4.6. + +The procedures in subclause 6.5.2.3 and subclause 6.5.2.4 are used with a XPK equal to the CSK and a XPK-ID equal to the CSK-ID in the following circumstances as described in 3GPP TS 33.180 [26]: + +- 1) MCData client sends confidentiality protected content to an MCData server; and +- 2) MCData server sends confidentiality protected content to an MCData client. + +The procedure in subclause 6.5.2.3 and subclause 6.5.2.4 are used with a XPK equal to the SPK and a XPK-ID equal to the SPK-ID when the MCData server sends confidentiality protected content to an MCData server. + +## 6.5.2.3 Procedures for sending confidentiality protected content + +### 6.5.2.3.1 MCData client + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "true" or no element is present in the MCData Service Configuration document, then sending confidentiality protected content from the MCData client to the MCData server is enabled, and the MCData client: + +- 1) shall use the appropriate keying information specified in subclause 6.5.2.2; +- 2) shall perform the procedures in subclause 6.5.2.3.3 to confidentiality protect XML elements containing the content described in subclause 4.6; and +- 3) shall perform the procedures in subclause 6.5.2.3.4 to confidentiality protect URIs in XML attributes for URIs described in subclause 4.6. + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "false", then sending confidentiality protected content from the MCData client to the MCData server is disabled, and content is included in XML elements and attributes without encryption. + +### 6.5.2.3.2 MCData server + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "true" or no element is present in the MCData Service Configuration document, then sending confidentiality protected content from the MCData server to the MCData client is enabled. If the element of the element is set to "true" in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] or no element is present in the MCData Service Configuration document, then sending confidentiality protected content between MCData servers is enabled. + +When sending confidentiality protected content, the MCData server: + +- 1) shall use the appropriate keying information specified in subclause 6.5.2.2; +- 2) shall perform the procedures in subclause 6.5.2.3.3 to confidentiality protect XML elements containing the content described in subclause 4.6, and +- 3) shall perform the procedures in subclause 6.5.2.3.4 to confidentiality protect URIs in XML attributes for URIs described in subclause 4.6. + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "false", then sending confidentiality protected content from the MCData server to the MCData client is disabled, and then content is included in XML elements and attributes without encryption. + +If the element of the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "false", then sending confidentiality protected content between MCData servers is disabled, and content is included in XML elements and attributes without encryption. + +### 6.5.2.3.3 Content Encryption in XML elements + +The following procedures shall be performed by an MCData client or an MCData server: + +- 1) perform encryption as specified in W3C: "XML Encryption Syntax and Processing Version 1.1", [28] subclause 4.3, using the "AES-128-GCM algorithm HMAC" as the encryption algorithm and the XPK as the key; and +- 2) follow the semantic for the element of the MIME body as described in Annex F of the present document, to include the encrypted content in the MIME body ensuring that the necessary XML elements required for confidentiality protection are included as specified in 3GPP TS 33.180 [26]. + +### 6.5.2.3.4 Attribute URI Encryption + +The following procedures shall be performed by an MCData client or an MCData server: + +- 1) perform encryption as specified in [aes-gcm], using the "AES-128-GCM algorithm HMAC" as the encryption algorithm and the XPK as the key, with a 96 bit randomly selected IV; and +- 2) replace the URI to be protected in the attribute by a URI constructed as follows: + - a) the URI schema is "[sip:](#)"; + - b) the first part of the userinfo part is the base64 encoded result of the encryption of the original attribute value; + - c) the string ";iv=" is appended to the result of step b); + - d) the base64 encoding of the IV (section 5 of IETF RFC 4648 [30]) is appended to the result of step c); + - e) the string ";key-id=" is appended to the result of step d); + - f) the base64 encoding of the XPK-ID according to 3GPP 33.180 [26] is appended to the result of step e); + - g) the string ";alg=128-aes-gcm" is appended to the result of step f); and + - h) the string "@", followed by the domain name for MC Services confidentiality protection as specified in 3GPP TS 23.003 [31] is appended to the result of step g). + +#### 6.5.2.4 Procedures for receiving confidentiality protected content + +##### 6.5.2.4.1 Determination of confidentiality protected content + +The following procedure is used by the MCData client or MCData server to determine if an XML element is confidentiality protected. + +- 1) if an XML element contains the XML element, then the content of the XML element is confidentiality protected; and +- 2) if an XML element does not contain the XML element, then the content of the XML element is not confidentiality protected. + +The following procedure is used by the MCData client or MCData server to determine if a URI in the XML attribute is confidentiality protected. + +- 1) if an XML attribute is a URI with the domain name for MC Services confidentiality protection as specified in the 3GPP TS 23.003 [31], then the URI is confidentiality protected; and +- 2) if an XML attribute is a URI without the domain name for MC Services confidentiality protection as specified in the 3GPP TS 23.003 [31], then the URI is not confidentiality protected. + +##### 6.5.2.4.2 Decrypting confidentiality protected content in XML elements + +The following procedure shall be performed by an MCData client or an MCData server to decrypt an individual XML element that has a type of "encrypted" within an XML MIME body: + +- 1) if the XML element or any of its sub-elements as described in 3GPP TS 33.180 [26] are not present in the MIME body then send a SIP 403 (Forbidden) response with the warning text set to "140 unable to decrypt XML content" in a Warning header field as specified in subclause 4.4, and exit this procedure. Otherwise continue with the rest of the steps; +- 2) perform decryption on the element as specified in W3C: "XML Encryption Syntax and Processing Version 1.1", [28] subclause 4.4 to decrypt the contents of the element contained within the element; +- 3) if the decryption procedure fails, then send a SIP 403 (Forbidden) response with the warning text set to "140 unable to decrypt XML content" in a Warning header field as specified in subclause 4.4. Otherwise continue with the rest of the steps; and +- 4) return success of this procedure together with the decrypted XML element. + +#### 6.5.2.4.3 Decrypting confidentiality protected URIs in XML attributes + +The following procedure shall be performed by an MCData client or an MCData server to decrypt a URI in an attribute in a XML document: + +- 1) the value between ";iv=" and the next ";" provides the base64 encoded value of the 96 bit IV and the value between ";key-id" and the next ";" defines the key which has been used for encryption, i.e. "CSK" or "SPK"; and +- 2) the original URI is obtained by decrypting the base64 encoded string between the "[sip:](#)" URI prefix and the next ";" using the "AES-128-GCM algorithm HMAC" as the decryption algorithm with IV and key as determined in step 1). This value replaces the encrypted URI as the value of the XML attribute. + +#### 6.5.2.5 MCData server copying received XML content + +The following procedure is executed when an MCData server receives a SIP request containing XML MIME bodies, where the content needs to be copied from the incoming SIP request to the outgoing SIP request. + +The MCData server: + +- 1) shall copy the XML elements from the XML MIME body of the incoming SIP request that do not contain a XML element, to the same XML body in the outgoing SIP request; +- 2) for each encrypted XML element in the XML MIME body of the incoming SIP request as determined by subclause 6.5.2.4.1: + - a) shall use the keying information described in subclause 6.5.2.2 to decrypt the content within the XML element by following the procedures specified in subclause 6.5.2.4.2, and shall continue with the steps below if the encrypted XML element was successfully decrypted; + - b) if confidentiality protection is enabled as specified in subclause 6.5.2.3.2, then for each decrypted XML element: + - i) shall re-encrypt the content within the XML element using the keying information described in subclause 6.5.2.2 and by following the procedures specified in subclause 6.5.2.3.3; and + - ii) shall include the re-encrypted content into the same XML MIME body of the outgoing SIP request; and + - c) if confidentiality protection is disabled as specified in subclause 6.5.2.3.2, shall include the decrypted content in the same XML MIME body of the outgoing SIP request. +- 3) for each encrypted XML URI attribute in the XML MIME body of the incoming SIP request as determined by subclause 6.5.2.4.1: + - a) shall use the keying information described in subclause 6.5.2.2 to decrypt the URI value of the XML attribute by following the procedures specified in subclause 6.5.2.4.3, and shall continue with the steps below if the encrypted XML attribute value was successfully decrypted; + - b) if confidentiality protection is enabled as specified in subclause 6.5.2.3.2, then for each decrypted XML element: + - i) shall re-encrypt the URI value of the XML attribute using the keying information described in subclause 6.5.2.2 and by following the procedures specified in subclause 6.5.2.3.4; and + - ii) shall include the re-encrypted attribute value into the same XML MIME body of the outgoing SIP request; and + - c) if confidentiality protection is disabled as specified in subclause 6.5.2.3.2, shall include the decrypted value in the same XML MIME body of the outgoing SIP request. + +## 6.5.3 Integrity Protection of XML documents + +### 6.5.3.1 General + +Integrity protection can be applied to a whole XML MIME body. When integrity protection is enabled, all XML MIME bodies transported in SIP requests and responses are integrity protected. The following XML MIME bodies used in the present specification in SIP signalling can be integrity protected: + +- application/vnd.3gpp.mcdata-info+xml; +- application/vnd.3gpp.mcdata-mbms-usage-info+xml; +- application/vnd.3gpp.mcdata-location-info+xml; +- application/poc-settings+xml; +- application/resources-list+xml; and +- application/vnd.3gpp.mcdata-affiliation-command+xml. + +If integrity protection is enabled, and one or more of the XML MIME bodies complying to the types listed above are included in a SIP request or SIP response, then a MIME body of type application/vnd.3gpp.mcptt-signed+xml specified in 3GPP TS 24.379 [10] is included in the SIP request or SIP response containing one or more signatures pointing to those XML MIME bodies as illustrated in Figure 6.5.3.1-1. + +In order to integrity protect the XML MIME bodies listed above in this subclause in SIP requests and SIP responses, the MCData client and MCData server shall, for each MIME body, include the Content-ID header field as specified in IETF RFC 2045 [32] containing a Content-ID ("cid") Uniform Resource Locator (URL) as specified in IETF RFC 2392 [33]. + +![Diagram illustrating the integrity protection of XML MIME bodies in SIP requests and responses. A yellow rectangular container holds two nested boxes: a green box at the top and a blue box at the bottom. The green box contains two lines of text: 'XML MIME body' and 'signature'. The blue box contains one line of text: 'XML MIME body'. A white arrow points from the right side of the yellow container to the green box.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +Diagram illustrating the integrity protection of XML MIME bodies in SIP requests and responses. A yellow rectangular container holds two nested boxes: a green box at the top and a blue box at the bottom. The green box contains two lines of text: 'XML MIME body' and 'signature'. The blue box contains one line of text: 'XML MIME body'. A white arrow points from the right side of the yellow container to the green box. + +**Figure 6.5.3.1-1: Integrity Protection of XML MIME bodies in SIP requests and SIP responses** + +Each MIME body that is integrity protected is assigned a unique signature. + +Configuration for applying integrity protection is not selective to a specific MIME body. If configuration for integrity protection is turned on, then all XML MIME bodies in SIP requests and responses are integrity protected. If configuration for integrity protection is turned off, then no XML MIME bodies in SIP requests and SIP responses are integrity protected. + +### 6.5.3.2 Keys used in integrity protection procedures + +Integrity protection uses an XPK to sign the data which (depending on who is the sender and who is the receiver of the signed information) can be a CSK or an SPK as specified in subclause 4.6. An XPK-ID (CSK-ID/SPK-ID) is used to key the XPK (CSK/SPK). It is assumed that before the procedures in subclause 6.5.3.3 and subclause 6.5.3.4 are called, the CSK/CSK-ID and/or SPK/SPK-ID are available on the sender and recipient of the integrity protected content, as described in subclause 4.6. + +The procedures in subclause 6.5.3.3 and subclause 6.5.3.4 shall be used with a XPK equal to the CSK and a XPK-ID equal to the CSK-ID in the following circumstances as described in 3GPP TS 33.180 [26]: + +- 1) MCData client sends integrity protected content to an MCData server; and + +- 2) MCData server sends integrity protected content to an MCData client. + +The procedure in subclause 6.5.3.3 and subclause 6.5.3.4 shall be used with a XPK equal to the SPK and a XPK-ID equal to the SPK-ID when the MCData server sends integrity protected content to an MCData client. + +### 6.5.3.3 Sending integrity protected content + +#### 6.5.3.3.1 MCData client + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "true" or no element is present in the MCData Service Configuration document, then sending integrity protected content from the MCData client to the MCData server is enabled, and the MCData client shall use the appropriate keying information specified in subclause 6.5.3.2 and shall perform the procedures in subclause 6.5.3.3.3 to integrity protect XML MIME bodies. + +NOTE: Each XML MIME body is integrity protected separately. + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "false", then sending integrity protected content from the MCData client to the MCData server is disabled, and all XML MIME bodies are sent without integrity protection. + +#### 6.5.3.3.2 MCData server + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "true", or no element is present in the MCData Service Configuration document, then sending integrity protected content from the MCData server to the MCData client is enabled. If the element of the element is set to "true" in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] or no element is present in the MCData Service Configuration document, then sending integrity protected content between MCData servers is enabled. + +When sending integrity protected content, the MCData server shall use the appropriate keying information specified in subclause 6.5.3.2 and shall perform the procedures in subclause 6.5.3.3.3 to integrity protect XML MIME bodies. + +NOTE: Each XML MIME body is integrity protected separately. + +If the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "false", then sending integrity protected content from the MCData server to the MCData client is disabled, and all XML MIME bodies are sent without integrity protection. + +If the element of the element in the MCData Service Configuration document as specified in 3GPP TS 24.484 [12] is set to "false", then sending integrity protected content between MCData servers is disabled, and content is included in XML elements without encryption. + +#### 6.5.3.3.3 Integrity protection procedure + +The following procedure shall be performed by the MCData client and MCData server to integrity protect the XML bodies defined by the MIME types listed in subclause 6.5.3.1: + +- 1) include a Content-Type header field set to "application/vnd.3gpp.mcptt-signed+xml" defined in 3GPP TS 24.379 [10]; +- 2) for each of the MIME types defined in subclause 6.5.3.1 where the content defined by these MIME types is to be integrity protected: + - a) perform reference generation as specified in W3C: "XML Signature Syntax and Processing (Second Edition)", [29] subclause 3.1.1 using the SHA256 algorithm to produce a hash of the MIME body and continue with the procedures below if reference generation is successful; + - b) perform signature generation as specified in W3C: "XML Signature Syntax and Processing (Second Edition)", [29] subclause 3.1.2 using the HMAC-SHA256 signature method and the XPK as the key and continue with the procedures below if signature generation is successful; and + +- 3) follow the schema defined in Annex F.6.2 and the semantic described in Annex F.6.3 to create the application/vnd.3gpp.mcptt-signed+xml MIME body, defined in 3GPP TS 24.379 [10], containing signatures referring to the XML MIME bodies included in the SIP request or SIP response. + +### 6.5.3.4 Receiving integrity protected content + +#### 6.5.3.4.1 Determination of integrity protected content + +The following procedure is used by the MCData client or MCData server to determine if an XML MIME body is integrity protected. + +- 1) if the XML element is not present in the XML MIME body, then the content is not integrity protected; and +- 2) if the XML element is present in the XML MIME body, then the content is integrity protected. + +#### 6.5.3.4.2 Verification of integrity protected content + +The following procedure is used by the MCData client or MCData server to verify the integrity of an XML MIME body: + +- 1) if the required sub-elements of the as described in 3GPP TS 33.180 [26] are not present in the MIME body and if not present, are not known to the sender and recipient by other means, then the integrity protection procedure fails and exit this procedure. Otherwise continue with the rest of the steps; +- 2) perform reference validation on the element as specified in W3C: "XML Signature Syntax and Processing (Second Edition)", [29] subclause 3.2.1; +- 3) if reference validation fails, then send a SIP 403 (Forbidden) response towards the functional entity with the warning text set to: "139 integrity protection check failed" in a Warning header field as specified in subclause 4.4, and do not continue with the rest of the steps in this subclause; +- 4) obtain the XPK using the XPK-ID in the received XML body and use it to perform signature validation of the value of the element as specified in W3C: "XML Signature Syntax and Processing (Second Edition)", [29] subclause 3.2.2; +- 5) if signature validation fails, then send a SIP 403 (Forbidden) response towards the functional entity with the warning text set to: "139 integrity protection check failed" in a Warning header field as specified in subclause 4.4, and do not continue with the rest of the steps in this subclause; and +- 6) return success of the integrity protection of the XML document passes the integrity protection procedure. + +## 6.6 Confidentiality and Integrity Protection of TLV messages + +### 6.6.1 General + +Signalling plane provides confidentiality and integrity protection for the MCData Data signalling and MCData Data messages sent over the signalling plane. Signalling plane security also provides the authentication of MCData Data messages. + +The signalling plane security is based on 3GPP MCData security solution including key management and end-to-end protection as defined in 3GPP TS 33.180 [26]. + +Various keys and associated key identifiers protect the MCData Data signalling and MCData Data messages carried on the signalling plane. + +The MCData Data signalling messages may be: + +1. SDS SIGNALLING PAYLOAD; +2. FD SIGNALLING PAYLOAD; +3. SDS NOTIFICATION; +4. FD NOTIFICATION; + +5. FD NETWORK NOTIFICATION; +6. COMMUNICATION RELEASE; +7. SDS OFF-NETWORK MESSAGE; or +8. SDS OFF-NETWORK NOTIFICATION. + +The MCData Data messages may be: + +1. DATA PAYLOAD. + +In an on-network MCData communication for an MCData group, if protection of MCData Data messages is negotiated, the GMK and the GMK-ID of the MCData group protect the MCData Data messages sent and received by MCData clients; + +In an on-network one-to-one MCData communications, if protection of MCData Data messages is negotiated, the PCK and the PCK-ID protect the MCData Data messages sent and received by MCData clients; + +If protection of MCData Data signalling messages sent using unicast between the MCData client and the participating MCData function serving the the MCData client is negotiated, the CSK and the CSK-ID protect the MCData Data signalling messages sent and received using unicast by the MCData client and by a participating MCData function; + +If protection of MCData Data signalling messages between the participating MCData function and the controlling MCData function is configured, the SPK and the SPK-ID protect the MCData Data signalling messages sent and received between the participating MCData function and the controlling MCData function; and + +If protection of MCData is configured for an on-network MBMS MCData communication, a MuSiK and the corresponding MuSiK-ID may be used to protect transmissions on an MBMS bearer to and from MCData clients. + +The GMK and the GMK-ID are distributed to the MCData clients using the group document subscription and notification procedure specified in 3GPP TS 24.481 [11]. + +The PCK and the PCK-ID are generated by the MCData client initiating the standalone SDS using signalling control plane or standalone one-to-one SDS using media plane or one-to-one SDS session or one-to-one FD using media plane and provided to the MCData client receiving the SIP signalling. + +The CSK and the CSK-ID are generated by the MCData client and provided to the participating MCData function serving the MCData client using SIP signalling. + +The SPK and the SPK-ID are configured in the participating MCData function and the controlling MCData function. + +The MuSiK and the MuSiK-ID are distributed to the MCData clients as described in clause 19. + +The key material for creating and verifying the authentication signature (SSK, PVT and KPAK) is provisioned to the MCData clients by the KMS as specified in 3GPP TS 33.180 [26]. + +## 6.6.2 Derivation of master keys for media and media control + +Each MCData Payload Protection Key (DPPK) (i.e. GMK, PCK, CSK, SPK) and its associated key identifier DPPK-ID (i.e. GMK-ID, PCK-ID, CSK-ID, SPK -ID) described in subclause 6.6.1 are used to derive a MCData Payload Cipher Key (DPCK) and its associated DPCK-ID as specified in 3GPP TS 33.180 [26]. + +DPCK and DPCK-ID are used in the protection of MCData Data signalling and MCData Data messages as specified in 3GPP TS 33.180 [26]. + +## 6.6.3 Protection of MCData Data signalling and MCData Data messages + +### 6.6.3.1 General + +The MCData Data messages may be encrypted and integrity protected. When encryption is applied the media shall be encrypted as specified in subclause 8.5.4 in 3GPP TS 33.180 [26]. + +The MCData Data signalling messages may be protected by encryption. When encryption is applied the MCData Data signalling shall be encrypted as specified in subclause 8.5.4 in 3GPP TS 33.180 [26]. + +The MCData Data messages and the protected MCData Data messages may also be end-to-end authenticated as specified in subclause 8.5.5 in 3GPP TS 33.180 [15]. + +### 6.6.3.2 The MCData client + +A MCData client transmitting MCData Data messages shall protect the MCData Data messages using the related DPPK and DPPK-ID according to the negotiated protection method. For one-to-one communications PCK and PCK-ID shall be used as DPPK and DPPK-ID. For group communications GMK and GMK-ID shall be used as DPPK and DPPK-ID. + +A MCData client transmitting MCData Data messages shall use the key material provisioned by the KMS when generating the authentication signature. + +A MCData client which receives protected MCData Data messages shall decrypt and authenticate the protected MCData Data messages using the related DPPK and DPPK-ID according to the negotiated protection method. + +A MCData client which receives signed MCData Data messages shall verify the signature using the signature, the identity of the originating MCData client and the KPAK provisioned by the KMS. + +A MCData client transmitting MCData Data signalling messages shall encrypt the MCData Data signalling messages using CPK and CPK-ID if MCData Data signalling messages protection is negotiated. + +A MCData client which receives encrypted MCData Data signalling messages shall decrypt the media control using CPK and CPK-ID. + +### 6.6.3.3 The participating MCData function + +A participating MCData function which receives protected MCData Data messages shall forward it to the next entity without any additional action related to the security framework. + +A participating MCData function, when receiving an encrypted MCData Data signalling messages from a MCData client shall decrypt the encrypted MCData Data signalling messages using the CSK and CSK-ID negotiated with the MCData client which has sent the MCData Data signalling message. Then, the participating MCData function shall forward the MCData Data signalling messages to the controlling MCData function by encrypting the MCData Data signalling messages using SPK and SPK-ID, if protection is configured between the participating MCData function and the controlling MCData function. + +A participating MCData function, when receiving an encrypted MCData Data signalling messages from the controlling MCData function shall decrypt the encrypted MCData Data signalling messages using the SPK and SPK-ID configured between the participating MCData function and the controlling MCData function. Then, the participating MCData function shall forward the MCData Data signalling messages to the destination MCData client using the CSK and CSK-ID if protection is negotiated between the participating MCData function and the MCData client. + +### 6.6.3.4 The controlling MCData function + +A controlling MCData function which receives protected MCData Data messages shall forward it to the next entity without any additional action related to the security framework. + +A controlling MCData function, when receiving an encrypted MCData Data signalling messages from a participating MCData function shall decrypt the encrypted MCData Data signalling messages using the SPK and SPK-ID configured between the participating MCData function and the controlling MCData function. Then, the controlling MCData function shall forward the MCData Data signalling messages to the participating MCData function serving the destination MCData client by encrypting the MCData Data signalling messages using SPK and SPK-ID, if protection is configured between the participating MCData function and the controlling MCData function. + +--- + +## 7 Registration and service authorisation + +### 7.1 General + +This clause describes the procedures for SIP registration and MCData service authorization for the MCData client and the MCData service. The MCData UE can use SIP REGISTER or SIP PUBLISH for MCData service settings to perform service authorization for MCData. The decision which method to use is based on implementation and on + +availability of an access-token received as outcome of the user authentication procedure as described in 3GPP TS 24.482 [24]. + +If another MC service client (e.g. MCPTT, MCVideo) is operating at the same time on the same MC UE as the MCData client, then the MCData client shares the same SIP registration as the other MC service clients. The SIP REGISTER procedures in this clause are combined with the SIP REGISTER procedures for the other operating MC service clients to create a single SIP REGISTER request. If other MC service clients are already operating when the MCData client registers then a re-registration is performed containing the parameters for the other operating MC services. + +Although the access-token can be the same for the MCData service as for other MC services when performing service authorization for MCData along with other MC services using SIP REGISTER multipart MIME bodies for each MC service are included in the SIP REGISTER request. The MCData server can therefore receive multipart MIME bodies in the SIP REGISTER request. Multiple contact addresses (one per MC service client) can be included in a SIP REGISTER request provided they all contain the same IP address and port number (see 3GPP TS 24.229 [5] for further details of including multiple contact addresses in a single SIP REGISTER request). + +If the MCData client logs off from the MCData service but other MC service clients are to remain registered the MC UE performs a re-registration as specified in 3GPP TS 24.229 [5] without the supported g.3gpp.mcdata media feature tags and the g.3gpp.icsi-ref media feature tags containing the values of the supported MCData service ICSIs in the Contact header field of the SIP REGISTER request but with the parameters for the remaining operating MC service clients. + +## 7.2 MCData client procedures + +### 7.2.1 SIP REGISTER request for service authorisation + +When the MCData client performs SIP registration for service authorisation the MCData client shall perform the registration procedures as specified in 3GPP TS 24.229 [5]. + +The MCData client shall include the following media feature tags in the Contact header field of the SIP REGISTER request: + +- 1) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 2) if SDS is supported then: + - a) the g.3gpp.mcdata.sds media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and +- 3) if FD service is supported then: + - a) the g.3gpp.mcdata.fd media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd". + +NOTE 1: If the MCData client logs off from the MCData service but the MCData UE remains registered the MCData UE performs a re-registration as specified in 3GPP TS 24.229 [5] without the supported g.3gpp.mcdata media feature tags and the g.3gpp.icsi-ref media feature tag containing the supported MCData service ICSIs in the Contact header field of the SIP REGISTER request. + +If the MCData client, upon performing SIP registration: + +- 1) has successfully finished the user authentication procedure as described in 3GPP TS 24.482 [24]; +- 2) has available an access-token; +- 3) based on implementation decides to use SIP REGISTER for service authorization; +- 4) confidentiality protection is disabled as specified in subclause 6.5.2.3.1; and +- 5) integrity protection is disabled as specified in subclause 6.5.3.3.1; + +then the MCData client shall include in the SIP REGISTER request an application/vnd.3gpp.mcdata-info+xml MIME body as defined in Annex D.1 with: + +- 1) the element set to the value of the access token received during the user authentication procedures; and +- 2) the element set to the value of the MCData client ID of the originating MCData client. + +NOTE 2: the access-token contains the MCData ID of the user. + +If the MCData client, upon performing SIP registration: + +- 1) has successfully finished the user authentication procedure as described in 3GPP TS 24.482 [24]; +- 2) has an available access-token; +- 3) based on implementation decides to use SIP REGISTER for service authorization; and +- 4) either confidentiality protection is enabled as specified in subclause 6.5.2.3.1 or integrity protection is enabled as specified in subclause 6.5.3.3.1; + +then the MCData client: + +- 1) shall include an application/mikey MIME body with the CSK as MIKEY-SAKKE I\_MESSAGE as specified in 3GPP TS 33.180 [26] in the body of the SIP REGISTER request; +- 2) if confidentiality protection is enabled as specified in subclause 6.5.2.3.1, shall include in the body of the SIP REGISTER request an application/vnd.3gpp.mcdata-info+xml MIME body with the following clarifications: + - a) shall encrypt the received access-token using the CSK and include the element set to the encrypted access-token, as specified in subclause 6.5.2.3.1; and + - b) shall encrypt the MCData client ID of the originating MCData client using the CSK and include the element set to the encrypted MCData client ID; +- 3) if confidentiality protection is disabled as specified in subclause 6.5.2.3.1, shall include an application/vnd.3gpp.mcdata-info+xml MIME body as defined in Annex D.1 with: + - a) the element set to the value of the access token received during the user authentication procedures; and + - b) the element set to the value of the MCData client ID of the originating MCData client; and +- 4) if integrity protection is enabled as specified in subclause 6.5.3.3.1, shall use the CSK to integrity protect the application/vnd.3gpp.mcdata-info+xml MIME body by following the procedures in subclause 6.6.3.3.3. + +## 7.2.1AA SIP REGISTER request without service authorisation + +When the MCData client performs SIP registration without service authorisation the MCData client shall perform the registration procedures as specified in 3GPP TS 24.229 [4]. + +The MCData client shall include the following media feature tags in the Contact header field of the SIP REGISTER request: + +- 1) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 2) if SDS is supported then: + - a) the g.3gpp.mcdata.sds media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and +- 3) if FD service is supported then: + +- a) the g.3gpp.mcdata.fd media feature tag; and +- b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd". + +NOTE: If the MCData client logs off from the MCData service but the MCData UE remains registered the MCData UE performs a re-registration as specified in 3GPP TS 24.229 [5] without the supported g.3gpp.mcdata media feature tags and the g.3gpp.icsi-ref media feature tag containing the supported MCData service ICSIs in the Contact header field of the SIP REGISTER request. + +## 7.2.1A Common SIP PUBLISH procedure + +This procedure is only referenced from other procedures. + +When populating the SIP PUBLISH request, the MCData client shall: + +- 1) shall set the Request-URI to the public service identity identifying the participating MCData function serving the MCData user; +- 2) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 3) shall set the Event header field to the "poc-settings" value; and +- 4) shall set the Expires header field according to IETF RFC 3903 [34], to 4294967295, if the MCData user is not removing the MCData service settings, otherwise to remove the MCData service settings the MCData client shall set the Expires header field to zero. + +NOTE 1: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +NOTE 2: The expiration timer of the MCData client service settings is only applicable for the MCData client service settings from the MCData client that matches the Instance Identifier URN. The expiration timer of MCData user service settings is also updated in the MCData server if expiration timer of MCData client service settings is updated in the MCData server. + +NOTE 3: Removing the MCData service settings by setting the Expires header field to zero, logs off the MCData client from the MCData service. + +## 7.2.2 SIP PUBLISH request for service authorisation and MCData service settings + +If based on implementation the MCData client decides to use SIP PUBLISH for MCData server settings to also perform service authorization and + +- 1) has successfully finished the user authentication procedure as described in 3GPP TS 24.482 [24]; and +- 2) has available an access-token; + +then the MCData client: + +- 1) shall perform the procedures in subclause 7.2.1A; +- 2) if confidentiality protection is disabled as specified in subclause 6.5.2.3.1 and integrity protection is disabled, shall include in the body of the SIP PUBLISH request, an application/vnd.3gpp.mcdata-info+xml MIME body as specified in Annex D.1 with the element set to the value of the access token received during the user authentication procedures; +- 3) if either confidentiality protection is enabled as specified in subclause 6.5.2.3.1 or integrity protection is enabled as specified in subclause 6.5.3.3.1 shall include an application/mikey MIME body with the CSK as MIKEY-SAKKE\_I\_MESSAGE as specified in 3GPP TS 33.180 [26] in the body of the SIP PUBLISH request; +- 4) if confidentiality protection is enabled as specified in subclause 6.5.2.3.1, shall include in the body of the SIP PUBLISH request an application/vnd.3gpp.mcdata-info+xml MIME body with: + +- a) the element set to the received access-token encrypted using the CSK, as specified in subclause 6.5.2.3.3; and + - b) the element set to the encrypted MCData client ID of the originating MCData client, as specified in subclause 6.5.2.3.3; +- 5) if confidentiality protection is disabled as specified in subclause 6.5.2.3.1, shall include in the body of the SIP PUBLISH request, an application/vnd.3gpp.mcdat-info+xml MIME body as specified in Annex D.1 with: + - a) the element set to the value of the access token received during the user authentication procedures in the body of the SIP PUBLISH request; and + - b) the element set to the value of the MCData client ID of the originating MCData client; + - 6) shall include an application/poc-settings+xml MIME body as defined in 3GPP TS 24.379 [10] containing: + - a) the element set to the value contained in the "user-profile-index" attribute of the selected MCData user profile as defined in 3GPP TS 24.484 [12]; and + - 7) if integrity protection is enabled as specified in subclause 6.5.3.3.1, shall use the CSK to integrity protect the application/vnd.3gpp.mcdat-info+xml MIME body and application/poc-settings+xml MIME body by following the procedures in subclause 6.5.3.3.3. + +The MCData client shall send the SIP PUBLISH request according to 3GPP TS 24.229 [5]. + +### 7.2.3 Sending SIP PUBLISH for MCData service settings only + +To set, update, remove or refresh the MCData service settings, the MCData client shall generate a SIP PUBLISH request according 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 4354 [35]. In the SIP PUBLISH request, the MCData client: + +- 1) shall perform the procedures in subclause 7.2.1A; +- 2) if confidentiality protection is enabled as specified in subclause 6.5.2.3.1, shall include in the body of the SIP PUBLISH request, an application/vnd.3gpp.mcdat-info+xml MIME body with: + - a) the element set to the targeted MCData ID encrypted using the CSK, as specified in subclause 6.5.2.3.3; and + - b) the element set to the encrypted MCData client ID of the originating MCData client, as specified in subclause 6.5.2.3.3; +- 3) if confidentiality protection is disabled as specified in subclause 6.5.2.3.1, shall include an application/vnd.3gpp.mcdat-info+xml MIME body as specified in Annex D.1 with: + - a) the set to the cleartext targeted MCData ID; and + - b) the element set to the value of the MCData client ID of the originating MCData client; +- 4) shall include an application/poc-settings+xml MIME body as defined in 3GPP TS 24.379 [10] containing: + - a) the element set to the value contained in the "user-profile-index" attribute of the selected MCData user profile as defined in 3GPP TS 24.484 [12]; and +- 5) if integrity protection is enabled as specified in subclause 6.5.3.3.1, shall use the CSK to integrity protect the application/vnd.3gpp.mcdat-info+xml MIME body and application/poc-settings+xml MIME body by following the procedures in subclause 6.5.3.3.3. + +The MCData client shall send the SIP PUBLISH request according to 3GPP TS 24.229 [5]. + +On receiving the SIP 200 (OK) response to the SIP PUBLISH request the MCData client may indicate to the MCData User the successful communication of the MCData service settings to the MCData server. + +## 7.2.4 Determination of MCData service settings + +In order to discover MCData service settings of another MCData client of the same MCData user or to verify the currently active MCData service settings of this MCData client, the MCData client shall generate an initial SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36], and IETF RFC 4354 [35]. + +In the SIP SUBSCRIBE request, the MCData client: + +- 1) shall set the Request-URI to the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall include the element set to the MCData ID of the MCData user; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 4) shall set the Event header field to the 'poc-settings' value; +- 5) shall include an Accept header field containing the "application/poc-settings+xml" MIME type; +- 6) if the MCData client wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; and + +NOTE 1: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 7) if the MCData client wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [36], to zero. + +In order to re-subscribe or de-subscribe, the MCData client shall generate an in-dialog SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36], IETF RFC 4354 [35]. In the SIP SUBSCRIBE request, the MCData client: + +- 1) shall set the Event header field to the 'poc-settings' value; +- 2) shall include an Accept header field containing the "application/poc-settings+xml" MIME type; +- 3) if the MCData client wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; and + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 4) if the MCData client wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [36], to zero. + +Upon receiving a SIP NOTIFY request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36] and IETF RFC 4354 [35], that contains an application/poc-settings+xml MIME body the MCData client shall cache: + +- 1) the element of the poc-settings+xml MIME body for each MCData client identified by the "id" attribute according to IETF RFC 4354 [35] as the current Answer-mode indication of that MPCTT client; and +- 2) the element of the poc-settings+xml MIME body for each MCData client identified by the "id" attribute according to IETF RFC 4354 [35] as the active MCData user profile of that MCData client. + +## 7.2.5 Receiving a CSK key download message + +When the MCData client receives a SIP MESSAGE request containing: + +- 1) a P-Asserted-Service header field containing the "urn:urn-7:3gpp-service.ims.icsi.mcdata"; and +- 2) an application/mikey MIME body; + +Then, if the key identifier within the CSB-ID of the MIKEY payload is a CSK-ID (4 most-significant bits have the value '2'), the MCData client: + +- 1) shall follow the security procedures in subclause 9.2.1 of 3GPP TS 33.180 [26] to extract the CSK. The client: + - a) if the initiator field (IDRi) has type 'URI' (identity hiding is not used), the client: + - i) shall extract the initiator URI from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]. If the initiator URI deviates from the public service identity of the participating MCData function serving the MCData user, shall reject the SIP MESSAGE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9.2 and shall not continue with the rest of the steps; and + - ii) shall convert the initiator URI to a UID as described in 3GPP TS 33.180 [26]; + - b) if the initiator field (IDRi) has type 'UID' (identity hiding in use), the client: + - i) shall convert the public service identity of participating MCData function serving the MCData user to a UID as described in 3GPP TS 33.180 [26]; and + - ii) shall compare the generated UID with the UID in the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]. If the two initiator UIDs deviate from each other, shall reject the SIP MESSAGE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9.2 and shall not continue with the rest of the steps; + - c) shall use the UID to validate the signature of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - d) if authentication verification of the I\_MESSAGE fails, shall reject the SIP MESSAGE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.4 and shall not continue with the rest of the steps; + - e) shall extract and decrypt the encapsulated CSK using the participating MCData function's (KMS provisioned) UID key as described in 3GPP TS 33.180 [26]; + - f) shall extract and store the algorithm to be used to protect the MCData signalling fields; and + - g) shall extract the CSK-ID, from the payload as specified in 3GPP TS 33.180 [26]; and +- 2) Upon successful extraction, the client shall replace the existing CSK and CSK-ID associated with the participating MCData function, with the extracted CSK and CSK-ID in the 'key download' message. + +## 7.3 MCData server procedures + +### 7.3.1 General + +The MCData server obtains information that it needs to implement service authorization specific requirements from: + +- a) any received third-party SIP REGISTER request (e.g. including information contained in the body of the third-party SIP REGISTER request) as specified in 3GPP TS 24.229 [5]. The body will carry the SIP REGISTER request as sent by the MCData client and may contain information needed for service authorization; or +- b) any received SIP PUBLISH request for MCData server settings containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters. The body of the SIP PUBLISH request will contain information needed for service authorization. + +### 7.3.1A Confidentiality and Integrity Protection + +When the MCData server receives a SIP REGISTER request sent from the MCData client contained within a message/sip MIME body of a received third-party SIP REGISTER request or a SIP PUBLISH request, it first determines whether XML MIME bodies included in the request are integrity protected. If XML MIME bodies are integrity protected the MCData server validates the signature of each of the XML MIME bodies. If the integrity + +protection check(s) pass or the XML MIME bodies are not integrity protected, the MCData server then determines whether the content in specific XML elements is confidentiality protected. If XML content is confidentiality protected, the MCData server decrypts the protected content. + +Upon receiving: + +- a SIP REGISTER request containing an application/vnd.3gpp.mcdata-info+xml MIME body within a message/sip MIME body of the SIP REGISTER request sent from the MCData client; or +- a SIP PUBLISH request containing an application/vnd.3gpp.mcdata-info+xml MIME body and an application/poc-settings+xml MIME body; + +the MCData server: + +- 1) shall determine if integrity protection has been applied to XML MIME bodies in the SIP request by following the procedures in subclause 6.5.3.4.1 for each XML MIME body; +- 2) if integrity protection has been applied, shall use the keying data described in subclause 6.5.3.2 and the procedures described in subclause 6.5.3.4.2 to verify the integrity of each of the XML MIME bodies; and +- 3) if all integrity protection checks succeed, shall continue with the remaining steps of this subclause. + +Upon receiving: + +- a SIP REGISTER request containing an application/vnd.3gpp.mcdata-info+xml MIME body with an element and an element within a message/sip MIME body of the SIP REGISTER request sent from the MCData client; or +- a SIP PUBLISH request containing an application/vnd.3gpp.mcdata-info+xml MIME body with an element and an element, and an application/poc-settings+xml MIME body; + +the MCData server: + +- 1) shall determine if confidentiality protection has been applied to the element and the element in the application/vnd.3gpp.mcdata-info+xml MIME body, by following the procedures in subclause 6.5.2.4.1; +- 2) if confidentiality protection has been applied to the element and element: + - a) shall use the keying information received in the MIKEY-SAKKE I\_MESSAGE as specified in 3GPP TS 33.180 [26], along with the procedures described in subclause 6.5.2.4.2 to: + - i) decrypt the received access token in the element in the application/vnd.3gpp.mcdata-info+xml MIME body; and + - ii) decrypt the received MCData client ID in the element in the application/vnd.3gpp.mcdata-info+xml MIME body; + - b) if the decryption procedure succeeds, shall identify the MCData ID and the MCData client ID from the decrypted values; and + - c) if the decryption procedure fails, shall determine that confidentiality protection has not been successful; +- 3) if confidentiality protection has been applied to only one of the element or the element: + - a) shall determine that confidentiality protection has not been successful; +- 4) if confidentiality protection has not been applied: + - a) shall identify the MCData ID from element received in the application/vnd.3gpp.mcdata-info+xml MIME body; and + - b) shall identify the MCData client ID from the element received in the application/vnd.3gpp.mcdata-info+xml MIME body. + +Upon receiving a SIP PUBLISH request containing an application/vnd.3gpp.mcdata-info+xml MIME body with an element, an element, and an application/poc-settings+xml MIME body, the MCData server: + +- 1) shall determine if confidentiality protection has been applied to the element and the element in the application/vnd.3gpp.mcdata-info+xml MIME body by following the procedures in subclause 6.5.2.4.1; +- 2) if confidentiality protection has been applied to the element and the element: + - a) shall use the keying information described in subclause 6.5.2.2 along with the procedures described in subclause 6.5.2.4.2 to: + - i) decrypt the received encrypted MCData ID in the element in the application/vnd.3gpp.mcdata-info+xml MIME body; and + - ii) decrypt the received encrypted MCData client ID in the element in the application/vnd.3gpp.mcdata-info+xml MIME body; + - b) if all decryption procedures succeed, shall identify the MCData ID and MCData client ID from the decrypted values; and + - c) if the decryption procedure fails, shall determine that confidentiality protection has not been successful; +- 3) if confidentiality protection has been applied to only one of the element or element: + - a) shall determine that confidentiality protection has not been successful; +- 4) if confidentiality protection has not been applied: + - a) shall identify the MCData ID from the contents of the element in the application/vnd.3gpp.mcdata-info+xml MIME body; and + - b) shall identify the MCData client ID from the element received in the application/vnd.3gpp.mcdata-info+xml MIME body. + +### 7.3.2 SIP REGISTER request for service authorisation + +The MCData server shall support obtaining service authorization specific information from the SIP REGISTER request sent from the MCData client and included in the body of a third-party SIP REGISTER request. + +NOTE 1: 3GPP TS 24.229 [5] defines how based on initial filter criteria the SIP REGISTER request sent from the UE is included in the body of the third-party SIP REGISTER request. + +Upon receiving a third party SIP REGISTER request with a message/sip MIME body containing the SIP REGISTER request sent from the MCData client containing an application/vnd.3gpp.mcdata-info+xml MIME body with an element and an element within a message/sip MIME body of the SIP REGISTER request sent from the MCData client, the MCData server: + +- 1) shall identify the IMS public user identity from the third-party SIP REGISTER request; +- 2) shall identify the MCData ID from the SIP REGISTER request sent from the MCData client and included in the message/sip MIME body of the third-party SIP REGISTER request by following the procedures in subclause 7.3.1A; +- 2A) shall check if the number of maximum simultaneous authorizations supported for the MCData user as specified in the element of the element contained in the element of the MCData service configuration document (see the service configuration document in 3GPP TS 24.484 [12]) has been reached. If reached, the MCData server shall not continue with the rest of the steps in this clause; +- 3) shall perform service authorization for the identified MCData ID as described in 3GPP TS 33.180 [26]; + +- 4) if service authorization was successful, shall bind the MCData ID and the MCData client ID to the IMS public user identity; +- 4A) if service authorization was successful and if the service authorization request was from an MCData user who is previously MCData service authorized on another MCData client (as determined by a comparison of the received MCData client ID with the MCData client ID of existing bindings), keep the current bindings and create a new binding between the MCData ID, the MCData client ID and the IMS public user identity; + +NOTE 2: The MCData server will store the binding MCData ID, MCData client ID, IMS public user identity and an identifier addressing the MCData server in an external database. + +- 5) if a Resource-Share header field with the value "supported" is contained in the "message/sip" MIME body of the third-party REGISTER request, shall bind the MCData ID and the MCData client ID to the identity of the MCData UE identified by the "+g.3gpp.registration-token" header field parameter in the Contact header field of the incoming third-party REGISTER request; and +- 6) if more than one binding exists for the MCData ID, shall include in the SIP 200 (OK) response an application/vnd.3gpp.mcdata-info+xml MIME body as specified in annex D.1 with a element set to the value "true". + +### 7.3.3 SIP PUBLISH request for service authorisation and service settings + +The MCData server shall support obtaining service authorization specific information from a SIP PUBLISH request for MCData server settings. + +Upon receiving a SIP PUBLISH request containing: + +- 1) an Event header field set to the "poc-settings" value; +- 2) an application/poc-settings+xml MIME body; and +- 3) an application/vnd.3gpp.mcdata-info+xml MIME body containing an element and an element; + +the MCData server: + +- 1) shall identify the IMS public user identity from the P-Asserted-Identity header field; +- 2) shall perform the procedures in subclause 7.3.1A; +- 3) if the procedures in subclause 7.3.1A were not successful shall send a SIP 403 (Forbidden) response towards the MCData client with the warning text set to: "140 unable to decrypt XML content" in a Warning header field as specified in subclause 4.9, and not continue with the rest of the steps in this subclause; +- 3A) shall check if the number of maximum simultaneous authorizations supported for the MCData user as specified in the element of the element contained in the element of the MCData service configuration document (see the service configuration document in 3GPP TS 24.484 [12]) has been reached. If reached, the MCData server shall send a SIP 486 (Busy Here) response towards the MCData client with the warning text set to: "228 maximum number of service authorizations reached" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps in this clause; +- 4) shall perform service authorization for the identified MCData ID as described in 3GPP TS 33.180 [26]; +- 5) if service authorization was successful: + - a) shall bind the MCData ID and MCData client ID to the IMS public user identity; + - b) if the service authorization request was from an MCData user who is previously MCData service authorized on another MCData client (as determined by a comparison of the received MCData client ID with the MCData client ID of existing bindings), keep the current bindings and create a new binding between the MCData ID, MCData client ID and the IMS public user identity; and + - c) if a Resource-Share header field with the value "supported" was included in the "message/sip" MIME body of the third-party REGISTER request, shall bind the MCData ID and MCData client ID to the identity of the + +MCDData UE identified by the "+g.3gpp.registration-token" header field parameter in the Contact header field of the third-party REGISTER request that contained this IMS public user identity; + +NOTE 1: The MCData server will store the binding MCData ID, MCData client ID, IMS public user identity and an identifier addressing the MCData server in an external database. + +- 6) if service authorization was not successful, shall send a SIP 403 (Forbidden) response towards the MCData client with the warning text set to: "101 service authorisation failed" in a Warning header field as specified in subclause 4.9, and not continue with the rest of the steps in this subclause; +- 7) shall process the SIP PUBLISH request according to rules and procedures of IETF RFC 3903 [34] and if processing of the SIP request was not successful, do not continue with the rest of the steps; +- 8) shall cache the received MCData service settings until the MCData service settings expiration timer expires; +- 9) shall send a SIP 200 (OK) response according 3GPP TS 24.229 [5] with: + - a) if more than one binding exists for the MCData ID, an application/vnd.3gpp.mcdata-info+xml MIME body as specified in annex D.1 with a element set to the value "true"; +- 10) shall download the MCData user profile from the MCData user database as defined in 3GPP TS 29.283 [37] if not already stored at the MCData server and use the element of the poc-settings event package if included to identify the active MCData user profile for the MCData client; + +NOTE 2: If the element of the poc-settings event package is included then only that MCData user profile is needed to be downloaded from the MCData user database. + +- 11) if there is no element included in the poc-settings event package then if multiple MCData user profiles are stored at the MCData server or downloaded for the MCData user from the MCData user database, shall determine the pre-selected MCData user profile to be used as the active MCData user profile by identifying the MCData user profile (see the MCData user profile document in 3GPP TS 24.484 [12]) in the collection of MCData user profiles that contains a element; and + +NOTE 3: If only one MCData user profile is stored at the MCData server or only one MCData user profile is downloaded from the MCData user database, then by default this MCData user profile is the pre-selected MCData user profile. + +- 12) if an element is contained in the element of the MCData user profile document with one or more elements containing an MCData group ID (see the MCData user profile document in 3GPP TS 24.484 [12]) for the served MCData ID, shall perform implicit affiliation as specified in subclause 8.3.2.15. + +### 7.3.4 Receiving SIP PUBLISH request for MCData service settings only + +Upon receiving a SIP PUBLISH request containing: + +- 1) an Event header field set to the "poc-settings" value; +- 2) an application/poc-settings+xml MIME body; and +- 3) an application/vnd.3gpp.mcdata-info+xml MIME body containing an element and an element; + +The MCData server: + +- 1) shall identify the IMS public user identity from the P-Asserted-Identity header field; +- 2) shall perform the procedures in subclause 7.3.1A; +- 3) if the procedures in subclause 7.3.1A were not successful, shall send a SIP 403 (Forbidden) response towards the MCData client with the warning text set to: "140 unable to decrypt XML content" in a Warning header field as specified in subclause 4.9, and not continue with the rest of the steps in this subclause; +- 4) shall verify that a binding between the IMS public user identity in the Request-URI and the MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml exists at the MCData server; + +- 5) if a binding exists between the IMS public user identity and the MCData ID in the request and the validity period of the binding has not expired shall download the MCData user profile from the MCData user database as defined in 3GPP TS 29.283 [37] if not already stored at the MCData server; +- 6) if a binding does not exist between the IMS public user identity and the MCData ID in the request or the binding exists, but the validity period of the binding has expired, shall reject the SIP PUBLISH request with a SIP 404 (Not Found) response and not continue with any of the remaining steps; +- 7) shall process the SIP PUBLISH request according to rules and procedures of IETF RFC 3903 [34] and if processing of the SIP request was not successful, do not continue with the rest of the steps; +- 8) shall cache the received MCData service settings until the MCData service settings expiration timer expires; +- 9) shall send a SIP 200 (OK) response according 3GPP TS 24.229 [5]; +- 10) shall download the MCData user profile from the MCData user database as defined in 3GPP TS 29.283 [37] if not already stored at the MCData server and use the element of the poc-settings event package if included to identify the active MCData user profile for the MCData client; + +NOTE 1: If the element of the poc-settings event package is included then only that MCData user profile is needed to be downloaded from the MCData user database. + +- 11) if there is no element included in the poc-settings event package then if multiple MCData user profiles are stored at the MCData server or downloaded for the MCData user from the MCData user database, shall determine the pre-selected MCData user profile to be used as the active MCData user profile by identifying the MCData user profile (see the MCData user profile document in 3GPP TS 24.484 [12]) in the collection of MCData user profiles that contains a element; and + +NOTE 2: If only one MCData user profile is stored at the MCData server or only one MCData user profile is downloaded from the MCData user database, then by default this MCData user profile is the pre-selected MCData user profile. + +- 12) if an element is contained in the element of the MCData user profile document with one or more elements containing an MCData group ID (see the MCData user profile document in 3GPP TS 24.484 [12]) for the served MCData ID, shall perform implicit affiliation as specified in subclause 8.3.2.15. + +### 7.3.5 Receiving SIP PUBLISH request with "Expires=0" + +Upon receiving a SIP PUBLISH request containing: + +- 1) an Event header field set to the "poc-settings" value; and +- 2) an Expires header field set to 0; + +the MCData server: + +- 1) shall identify the IMS public user identity from the P-Asserted-Identity header field; +- 2) shall process the SIP PUBLISH request according to rules and procedures of IETF RFC 3903 [34] and if processing of the SIP request was successful, continue with the rest of the steps; +- 3) shall remove the MCData service settings; +- 4) shall remove the binding between the MCData ID and public user identity; and +- 5) shall send a SIP 200 (OK) response according to 3GPP TS 24.229 [5]. + +### 7.3.6 Subscription to and notification of MCData service settings + +#### 7.3.6.1 Receiving subscription to MCData service settings + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the participating MCData function of the served MCData user; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element which identifies an MCData ID served by the MCData server; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata,sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 3) the Event header field of the SIP SUBSCRIBE request contains the 'poc-settings' event type. + +the MCData server: + +- 1) shall identify the served MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the participating MCData function serving the MCData user, shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP SUBSCRIBE request; +- 3) if the originating MCData ID is different than the served MCData ID, shall send a 403 (Forbidden) response and shall not continue with the rest of the steps; and +- 4) shall generate a 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36] and IETF RFC 4354 [35]. + +For the duration of the subscription, the MCData server shall notify subscriber about changes of the MCData service settings of the subscribed MCData user, as described in subclause 7.3.6.2. + +### 7.3.6.2 Sending notification of change of MCData service settings + +In order to notify the subscriber about changes of the MCData service settings of the subscribed MCData client of the subscribed MCData user, the MCData server: + +- 1) shall generate an application/poc-settings+xml MIME body as defined in 3GPP TS 24.379 [10] containing: + - a) the element identifying the active MCData user profile; and +- 2) send a SIP NOTIFY request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36] and IETF RFC 4354 [35] with the constructed application/poc-settings+xml MIME body. + +### 7.3.7 Sending a CSK key download message + +If confidentiality protection is enabled as specified in subclause 6.5.2.3.1, and if the participating MCData function received a Client Server Key (CSK) within a SIP REGISTER request for service authorisation or SIP PUBLISH request for service authorisation, the participating MCData function may decide to update the CSK. In this case, the participating MCData function shall perform a key download procedure for the CSK. The participating MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall set the Request-URI to the URI received in the To header field in the third-party SIP REGISTER request; +- 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media-feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 4) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 5) shall include an application/mikey MIME body containing the algorithm to be used to protect the MCData signalling fields, the CSK-ID and the CSK encrypted within a MIKEY message to the MC client as specified in subclause 9.2.1 of 3GPP TS 33.180 [26] in the body of the SIP MESSAGE request; and +- 6) shall send the SIP MESSAGE request towards the MCData client according to 3GPP TS 24.229 [5]. + +## 8 Affiliation + +### 8.1 General + +Subclause 8.2 contains the procedures for explicit affiliation at the MCData client. + +Subclause 8.3 contains the procedures for explicit affiliation at the MCData server serving the MCData user and the MCData server owning the MCData group. + +Subclause 8.3 contains the procedures for implicit affiliation at the MCData server serving the MCData user and the MCData server owning the MCData group. + +Subclause 8.4 describes the coding used for explicit affiliation. + +The procedures for implicit affiliation in this clause are triggered at the MCData server serving the MCData user in the following circumstances: + +- on receipt of a SIP MESSAGE request from an MCData client when initiating an MCData emergency alert targeted to an MCData group and the MCData client is not already affiliated to the MCData group; and +- on receipt of a SIP REGISTER request for service authorisation (as described in subclause 7.3.2) or SIP PUBLISH request for service authorisation and service settings (as described in subclause 7.3.3), as determined by configuration in the MCData user profile document as specified in 3GPP TS 24.484 [12]. + +The procedures for implicit affiliation in this clause are triggered at the MCData server owning the MCData group in the following circumstances: + +- on receipt of a SIP MESSAGE request from the MCData server serving the MCData user when the MCData user initiates an MCData emergency alert targeted to an MCData group and the MCData client is not already affiliated to the MCData group. + +### 8.2 MCData client procedures + +#### 8.2.1 General + +The MCData client procedures consist of: + +- an affiliation status change procedure; +- an affiliation status determination procedure; +- a procedure for sending affiliation status change request in negotiated mode to target MCData user; +- a procedure for receiving affiliation status change request in negotiated mode from authorized MCData user; and +- a rules based affiliation status change procedure. + +In order to obtain information about success or rejection of changes triggered by the affiliation status change procedure for an MCData user, the MCData client needs to initiate the affiliation status determination procedure for the MCData user before starting the affiliation status change procedure for the MCData user. + +#### 8.2.2 Affiliation status change procedure + +In order: + +- to indicate that an MCData user is interested in one or more MCData group(s) at an MCData client; +- to indicate that the MCData user is no longer interested in one or more MCData group(s) at the MCData client; +- to refresh indication of an MCData user interest in one or more MCData group(s) at an MCData client due to near expiration of the expiration time of an MCData group with the affiliation status set to the "affiliated" state received in a SIP NOTIFY request in subclause 8.2.3; + +- to send an affiliation status change request in mandatory mode to another MCData user; +- to indicate that an MCData user is interested in one or more MCData group(s) at an MCData client triggered by a location or functional alias activation criteria; +- to indicate that the MCData user is no longer interested in one or more MCData group(s) at the MCData client triggered by location or functional alias deactivation criteria; or +- any combination of the above; + +the MCData client shall generate a SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34], and IETF RFC 3856 [39]. + +When the MCData user indicates that he is no longer interested in one or more MCData group(s) at the MCData client, the MCData client shall first check value of the element if present within the MCData user profile document (see the MCData user profile document specified in 3GPP TS 24.484 [50]). If the affiliation to the group has been activated due to a rule being fulfilled and the element is present and is set to a value of "true", the MCData client shall suppress the MCData user's request. + +NOTE 0: If the request is suppressed, a notification message can be displayed to the user. + +In the SIP PUBLISH request, the MCData client: + +- 1) shall set the Request-URI to the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall include the element set to the MCData ID of the MCData user; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 4) if the targeted MCData user is interested in at least one MCData group at the targeted MCData client, shall set the Expires header field according to IETF RFC 3903 [34], to 4294967295; + +NOTE 1: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if the targeted MCData user is no longer interested in any MCData group at the targeted MCData client, shall set the Expires header field according to IETF RFC 3903 [34], to zero; and +- 6) shall include an application/pidf+xml MIME body indicating per-user affiliation information according to subclause 8.4.1. In the MIME body, the MCData client: + - a) shall include all MCData groups where the targeted MCData user indicates its interest at the targeted MCData client; + - b) shall include the MCData client ID of the targeted MCData client; + - c) shall not include the "status" attribute and the "expires" attribute in the element; and + - d) shall set the child element of the root element to a globally unique value. + +The MCData client shall send the SIP PUBLISH request according to 3GPP TS 24.229 [5]. + +### 8.2.3 Affiliation status determination procedure + +NOTE 1: The MCData UE also uses this procedure to determine which MCData groups the MCData user successfully affiliated to. + +In order to discover MCData groups: + +- 1) which the MCData user at an MCData client is affiliated to; or + +- 2) which another MCData user is affiliated to; + +the MCData client shall generate an initial SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. + +In the SIP SUBSCRIBE request, the MCData client: + +- 1) shall set the Request-URI to the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall include the element set to the MCData ID of the targeted MCData user; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 4) if the MCData client wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if the MCData client wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [36], to zero; and +- 6) shall include an Accept header field containing the application/pidf+xml MIME type; and +- 7) if requesting MCData groups where the MCData user is affiliated to at the MCData client, shall include an application/simple-filter+xml MIME body indicating per-client restrictions of presence event package notification information according to subclause 8.4.2, indicating the MCData client ID of the MCData client. + +In order to re-subscribe or de-subscribe, the MCData client shall generate an in-dialog SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. In the SIP SUBSCRIBE request, the MCData client: + +- 1) if the MCData client wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 3: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 2) if the MCData client wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [36], to zero; and +- 3) shall include an Accept header field containing the application/pidf+xml MIME type. + +Upon receiving a SIP NOTIFY request according to 3GPP TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36], if SIP NOTIFY request contains an application/pidf+xml MIME body indicating per-user affiliation information constructed according to subclause 8.4.1, then the MCData client shall determine affiliation status of the MCData user for each MCData group at the MCData client(s) in the MIME body. If the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request is included, the element value indicates the SIP PUBLISH request which triggered sending of the SIP NOTIFY request. + +## 8.2.4 Procedure for sending affiliation status change request in negotiated mode to target MCData user + +NOTE: Procedure for sending affiliation status change request in negotiated mode to several target MCData users is not supported in this version of the specification. + +Upon receiving a request from the MCData user to send an affiliation status change request in negotiated mode to a target MCData user, the MCData client shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. In the SIP MESSAGE request, the MCData client: + +- 1) shall set the Request-URI to the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall include the element set to the MCData ID of the target MCData user; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP MESSAGE request; +- 4) shall include an application/vnd.3gpp.mcdata-affiliation-command+xml MIME body as specified in Annex D.3; and +- 5) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]. + +On receiving a SIP 2xx response to the SIP MESSAGE request, the MCData client shall indicate to the user that the request has been delivered to an MCData client of the target MCData user. + +## 8.2.5 Procedure for receiving affiliation status change request in negotiated mode from authorized MCData user + +Upon receiving a SIP MESSAGE request containing: + +- 1) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 2) an application/vnd.3gpp.mcdata-affiliation-command+xml MIME body with a list of MCData groups for affiliation under the element and a list of MCData groups for de-affiliation under the element; + +then the MCData client: + +- 1) shall send a 200 (OK) response to the SIP MESSAGE request; +- 2) shall seek confirmation of the list of MCData groups for affiliation and the list of MCData groups for de-affiliation, resulting in an accepted list of MCData groups for affiliation and an accepted list of MCData groups for de-affiliation; and +- 3) if the user accepts the request: + - a) shall perform affiliation for each entry in the accepted list of MCData groups for affiliation for which the MCData client is not affiliated, as specified in subclause 8.2.2; and + - b) shall perform de-affiliation for each entry in the accepted list of MCData groups for de-affiliation for which the MCData client is affiliated, as specified in subclause 8.2.2. + +## 8.2.6 Rules based affiliation status change procedure + +Rules based affiliation is controlled by the elements or of the MCData user profile document identified by the MCData ID of the MCData user (see the MCData user profile document specified in 3GPP TS 24.484 [50]). The rules can be composed of location criteria (including heading and speed) or functional alias based criteria. A rule is fulfilled if any of the location criteria and any of the functional alias based criteria are met. These rules are evaluated whenever a change of location occurs and whenever a functional alias is activated or deactivated. If any defined rule is fulfilled, the MCData client shall initiate the affiliation status change procedure as specified in subclause 8.2.2. + +NOTE: Hysteresis can be applied to location changes to avoid too frequent affiliation changes. In addition, the definition of area entry and exit criteria can be specified to provide a buffer space to minimize ping-ponging into and out of an area. + +## 8.3 MCData server procedures + +### 8.3.1 General + +The MCData server procedures consist of: + +- procedures of MCData server serving the MCData user; and +- procedures of MCData server owning the MCData group. + +### 8.3.2 Procedures of MCData server serving the MCData user + +#### 8.3.2.1 General + +The procedures of MCData server serving the MCData user consist of: + +- a receiving affiliation status change from MCData client procedure; +- a receiving subscription to affiliation status procedure; +- a sending notification of change of affiliation status procedure; +- a sending affiliation status change towards MCData server owning MCData group procedure; +- an affiliation status determination from MCData server owning MCData group procedure; +- a procedure for authorizing affiliation status change request in negotiated mode sent to served MCData user; +- a forwarding affiliation status change towards another MCData user procedure; +- a forwarding subscription to affiliation status towards another MCData user procedure +- an affiliation status determination procedure; +- an affiliation status change by implicit affiliation procedure; +- an implicit affiliation status change completion procedure; +- an implicit affiliation status change cancellation procedure; and +- an implicit affiliation to configured groups procedure. + +#### 8.3.2.2 Stored information + +The MCData server shall maintain a list of MCData user information entries. The list of the MCData user information entries contains one MCData user information entry for each served MCData ID. + +In each MCData user information entry, the MCData server shall maintain: + +- 1) an MCData ID. This field uniquely identifies the MCData user information entry in the list of the MCData user information entries; and +- 2) a list of MCData client information entries. + +In each MCData client information entry, the MCData server shall maintain: + +- 1) an MCData client ID. This field uniquely identifies the MCData client information entry in the list of the MCData client information entries; and +- 2) a list of MCData group information entries. + +In each MCData group information, the MCData server shall maintain: + +- 1) an MCData group ID. This field uniquely identifies the MCData group information entry in the list of the MCData group information entries; + +- 2) an affiliation status; +- 3) an expiration time; +- 4) an affiliating p-id; and +- 5) a next publishing time. + +### 8.3.2.3 Receiving affiliation status change from MCData client procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains either the public service identity identifying the originating participating MCData function serving the MCData user, or the public service identity identifying the terminating participating MCData function serving the MCData user; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element which identifies an MCData ID served by the MCData server; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and +- 5) SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-user affiliation information according to subclause 8.4.1; + +then the MCData server: + +- 1) shall identify the served MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 2) if the Request-URI of the SIP PUBLISH request contains the public service identity identifying the originating participating MCData function serving the MCData user, shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP PUBLISH request; +- 3) if the Request-URI of the SIP PUBLISH request contains the public service identity identifying the terminating participating MCData function serving the MCData user, shall identify the originating MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 4) if the originating MCData ID is different than the served MCData ID and the originating MCData ID is not authorized to modify affiliation status of the served MCData ID, shall send a 403 (Forbidden) response and shall not continue with the rest of the steps; +- 5) if the Expires header field of the SIP PUBLISH request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP PUBLISH request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 6) if the Expires header field of the SIP PUBLISH request has nonzero value, shall determine the candidate expiration interval to according to IETF RFC 3903 [34]; +- 7) if the Expires header field of the SIP PUBLISH request has zero value, shall set the candidate expiration interval to zero; +- 8) shall respond with SIP 200 (OK) response to the SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34]. In the SIP 200 (OK) response, the MCData server: + - a) shall set the Expires header field according to IETF RFC 3903 [34], to the candidate expiration time; +- 9) if the "entity" attribute of the element of the application/pidf+xml MIME body of the SIP PUBLISH request is different than the served MCData ID, shall not continue with the rest of the steps; +- 10) shall identify the served MCData client ID in the "id" attribute of the element of the element of the application/pidf+xml MIME body of the SIP PUBLISH request; + +11) shall consider an MCData user information entry such that: + +- a) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID; +- as the served MCData user information entry; + +12) shall consider an MCData client information entry such that: + +- a) the MCData client information entry is in the list of MCData client information entries of the served MCData user information entry; and + - b) the MCData client ID of the MCData client information entry is equal to the served MCData client ID; +- as the served MCData client information entry; + +13) shall consider a copy of the list of the MCData group information entries of the served MCData client information entry as the served list of the MCData group information entries; + +14) if the candidate expiration interval is nonzero: + +- a) shall construct the candidate list of the MCData group information entries as follows: + +- i) for each MCData group ID which has an MCData group information entry in the served list of the MCData group information entries, such that the expiration time of the MCData group information entry has not expired yet, and which is indicated in a "group" attribute of an element of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request: + +- A) shall copy the MCData group information entry into a new MCData group information entry of the candidate list of the MCData group information entries; + +- B) if the affiliation status of the MCData group information entry is "deaffiliating" or "deaffiliated", shall set the affiliation status of the new MCData group information entry to the "affiliating" state and shall reset the affiliating p-id of the new MCData group information entry; and + +- C) shall set the expiration time of the new MCData group information entry to the current time increased with the candidate expiration interval; + +- ii) for each MCData group ID which has an MCData group information entry in the served list of the MCData group information entries, such that the expiration time of the MCData group information entry has not expired yet, and which is not indicated in any "group" attribute of the element of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request: + +- A) shall copy the MCData group information entry into a new MCData group information entry of the candidate list of the MCData group information entries; and + +- B) if the affiliation status of the MCData group information entry is "affiliated" or "affiliating": + +- shall set the affiliation status of the new MCData group information entry to the "de-affiliating" state; and + - shall set the expiration time of the new MCData group information entry to the current time increased with twice the value of timer F; and + +- iii) for each MCData group ID: + +- A) which does not have an MCData group information entry in the served list of the MCData group information entries; or + +- B) which has an MCData group information entry in the served list of the MCData group information entries, such that the expiration time of the MCData group information entry has already expired; + +and which is indicated in a "group" element of the element of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request: + +- A) shall add a new MCData group information entry in the candidate list of the MCData group information list for the MCData group ID; + - B) shall set the affiliation status of the new MCData group information entry to the "affiliating" state; + - C) shall set the expiration time of the new MCData group information entry to the current time increased with the candidate expiration interval; and + - D) shall reset the affiliating p-id of the new MCData group information entry; +- b) determine the candidate number of MCData group IDs as number of different MCData group IDs which have an MCData group information entry: + - i) in the candidate list of the MCData group information entries; or + - ii) in the list of the MCData group information entries of an MCData client information entry such that: + - A) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry; and + - B) the MCData client ID of the MCData client information entry is not equal to the served MCData client ID; +- with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and + +- c) if the candidate number of MCData group IDs is bigger than N2 value of the served MCData ID, shall based on MCData service provider policy reduce the candidate MCData group IDs to that equal to N2; + +NOTE: The MCData service provider policy can determine to remove an MCData group ID based on the order it appeared in the PUBLISH request or based on the importance or priority of the MCData group or some other policy to determine which MCData groups are preferred. + +15) if the candidate expiration interval is zero, constructs the candidate list of the MCData group information entries as follows: + +- a) for each MCData group ID which has an entry in the served list of the MCData group information entries: + - i) shall copy the MCData group entry of the served list of the MCData group information into a new MCData group information entry of the candidate list of the MCData group information entries; + - ii) shall set the affiliation status of the new MCData group information entry to the "de-affiliating" state; and + - iii) shall set the expiration time of the new MCData group information entry to the current time increased with twice the value of timer F; + +16) shall replace the list of the MCData group information entries stored in the served MCData client information entry with the candidate list of the MCData group information entries; + +17) shall perform the procedures specified in subclause 8.3.2.6 for the served MCData ID and each MCData group ID: + +- a) which does not have an MCData group information entry in the served list of the MCData group information entries and which has an MCData group information entry in the candidate list of the MCData group information entries with the affiliation status set to the "affiliating" state; +- b) which has an MCData group information entry in the served list of the MCData group information entries with the expiration time already expired, and which has an MCData group information entry in the candidate list of the MCData group information entries with the affiliation status set to the "affiliating" state; +- c) which has an MCData group information entry in the served list of the MCData group information entries with the affiliation status set to the "deaffiliating" state or the "deaffiliated" state and with the expiration time + +not expired yet, and which has an MCData group information entry in the candidate list of the MCData group information entries with the affiliation status set to the "affiliating" state; or + +- d) which has an MCData group information entry in the served list of the MCData group information entries with the affiliation status set to the "affiliated" state and with the expiration time not expired yet, and which has an MCData group information entry in the candidate list of the MCData group information entries with the affiliation status set to the "de-affiliating" state; + +18) shall identify the handled p-id in the child element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and + +19) shall perform the procedures specified in subclause 8.3.2.5 for the served MCData ID. + +### 8.3.2.4 Receiving subscription to affiliation status procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains either the public service identity identifying the originating participating MCData function serving the MCData user, or the public service identity identifying the terminating participating MCData function serving the MCData user; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element which identifies an MCData ID served by the MCData server; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; + +the MCData server: + +- 1) shall identify the served MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the originating participating MCData function serving the MCData user, shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP SUBSCRIBE request; +- 3) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the terminating participating MCData function serving the MCData user, shall identify the originating MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 4) if the originating MCData ID is different than the served MCData ID and the originating MCData ID is not authorized to modify affiliation status of the served MCData ID, shall send a 403 (Forbidden) response and shall not continue with the rest of the steps; and +- 5) shall generate a 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36]. + +For the duration of the subscription, the MCData server shall notify the subscriber about changes of the information of the served MCData ID, as described in subclause 8.3.2.5. + +### 8.3.2.5 Sending notification of change of affiliation status procedure + +In order to notify the subscriber about changes of the served MCData ID, the MCData server: + +- 1) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID; + as the served MCData user information entry; + +- 2) shall consider the list of the MCData client information entries of the served MCData user information entry as the served list of the MCData client information entries; +- 3) shall generate an application/pidf+xml MIME body indicating per-user affiliation information according to subclause 8.4.1 and the served list of the MCData client information entries with the following clarifications: + - a) the MCData server shall not include information from an MCData group information entry with the expiration time already expired; + - b) the MCData server shall not include information from an MCData group information entry with the affiliation status set to the "deaffiliated" state; + - c) if the SIP SUBSCRIBE request creating the subscription of this notification contains an application/simple-filter+xml MIME body indicating per-client restrictions of presence event package notification information according to subclause 8.4.2, the MCData server shall restrict the application/pidf+xml MIME body according to the application/simple-filter+xml MIME body; and + - d) if this procedure is invoked by procedure in subclause 8.3.2.3 where the handled p-id value was identified, the MCData server shall set the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request to the handled p-id value; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [5], and IETF RFC 6665 [36] for the subscription created in subclause 8.3.2.4. In the SIP NOTIFY request, the MCData server shall include the generated application/pidf+xml MIME body indicating per-user affiliation information. + +### 8.3.2.6 Sending affiliation status change towards MCData server owning MCData group procedure + +NOTE 1: Usage of one SIP PUBLISH request to carry information about change of affiliation state of several MCData users served by the same MCData server is not supported in this version of the specification. + +In order: + +- to send an affiliation request of a served MCData ID to a handled MCData group ID; +- to send an de-affiliation request of a served MCData ID from a handled MCData group ID; or +- to send an affiliation request of a served MCData ID to a handled MCData group ID due to near expiration of the previously published information; + +the MCData server shall generate a SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39]. In the SIP PUBLISH request, the MCData server: + +- 1) shall set the Request-URI to the public service identity of the controlling MCData function associated with the handled MCData group ID; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData server: + - a) shall include the element set to the handled MCData group ID; and + - b) shall include the element set to the served MCData ID; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if sending an affiliation request, shall set the Expires header field according to IETF RFC 3903 [34], to 4294967295; + +NOTE 1: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if sending an de-affiliation request, shall set the Expires header field according to IETF RFC 3903 [34], to zero; +- 6) shall include an P-Asserted-Identity header field set to the public service identity of the MCData server according to 3GPP TS 24.229 [5]; + +- 7) shall set the current p-id to a globally unique value; +- 8) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID;as the served MCData user information entry; +- 9) for each MCData group information entry such that: + - a) the MCData group information entry has the "affiliating" affiliation status, the MCData group ID set to the handled MCData group ID, the expiration time has not expired yet and the affiliating p-id is not set; + - b) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry; and + - c) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry;shall set the affiliating p-id of the MCData group information entry to the current p-id; and +- 10) shall include an application/pidf+xml MIME body indicating per-group affiliation information constructed according to subclause 8.4.1. The MCData server shall indicate all served MCData client IDs, such that: + - a) the affiliation status is set to "affiliating" or "affiliated", and the expiration time has not expired yet in an MCData group information entry with the MCData group ID set to the handled MCData group; + - b) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry; + - c) the MCData client information entry has the MCData client ID set to the served MCData client ID; and + - d) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry. + +The MCData server shall set the child element of the root element to the current p-id. + +The MCData server shall not include the "expires" attribute in the element. + +The MCData server shall send the SIP PUBLISH request according to 3GPP TS 24.229 [5]. + +If timer F expires for the SIP PUBLISH request sent for a (de)affiliation request of served MCData ID to the MCData group ID or upon receiving a SIP 3xx, 4xx, 5xx or 6xx response to the SIP PUBLISH request, the MCData server: + +- 1) shall remove each MCData group ID entry such that: + - a) the MCData group information entry has the MCData group ID set to the handled MCData group ID; + - b) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry; and + - c) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry. + +### 8.3.2.7 Affiliation status determination from MCData server owning MCData group procedure + +NOTE 1: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of affiliation state of several MCData users served by the same MCData server is not supported in this version of the specification. + +In order to discover whether a served MCData user was successfully affiliated to a handled MCData group in the MCData server owning the handled MCData group, the MCData server shall generate an initial SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. + +In the SIP SUBSCRIBE request, the MCData server: + +- 1) shall set the Request-URI to the public service identity of the controlling MCData function associated with the handled MCData group ID; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData server: + - a) shall include the element set to the handled MCData group ID; and + - b) shall include the element set to the served MCData ID; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if the MCData server wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if the MCData server wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [36], to zero; +- 6) shall include an Accept header field containing the application/pidf+xml MIME type; and +- 7) shall include an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to subclause 8.4.2, indicating the served MCData ID. + +In order to re-subscribe or de-subscribe, the MCData server shall generate an in-dialog SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. In the SIP SUBSCRIBE request, the MCData server: + +- 1) if the MCData server wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 3: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 2) if the MCData server wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [36], to zero; and +- 3) shall include an Accept header field containing the application/pidf+xml MIME type. + +Upon receiving a SIP NOTIFY request according to 3GPP TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36], if SIP NOTIFY request contains an application/pidf+xml MIME body indicating per-group affiliation information constructed according to subclause 8.4.1, then the MCData server: + +- 1) for each served MCData ID and served MCData client ID such that the application/pidf+xml MIME body of SIP NOTIFY request contains: + - a) a element of the root element; + - b) the "id" attribute of the element indicating the served MCData ID; + - c) an child element of the element of the element; + - d) the "client" attribute of the element indicating the served MCData client ID; and + - d) the "expires" attribute of the element indicating expiration of affiliation;perform the following: + +- a) if an MCData group information entry exists such that: + - i) the MCData group information entry has the "affiliating" affiliation status, the MCData group ID set to the handled MCData group ID, and the expiration time has not expired yet; + - ii) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry with the MCData client ID set to the served MCData client ID; + - iii) the MCData client information entry is in the list of the MCData client information entries of a served MCData user information entry with the MCData ID set to the served MCData ID; and + - iv) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + +shall set the affiliation status of the MCData group information entry to "affiliated"; and + +shall set the next publishing time of the MCData group information entry to the current time and half of the time between the current time and the expiration of affiliation; and + +- 2) for each MCData group information entry such that: + +- a) the MCData group information entry has the "affiliated" affiliation status or the "deaffiliating" affiliation status, the MCData group ID set to the handled MCData group ID, and the expiration time has not expired yet; +- b) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry with the MCData client ID set to a served MCData client ID; +- c) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry with the MCData ID set to a served MCData ID; and +- d) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain: + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the served MCData ID; +- c) an child element of the child element of the element; and +- d) the "client" attribute of the element indicating the served MCData client ID. + +perform the following: + +- a) shall set the affiliation status of the MCData group information entry to "deaffiliated"; and + - b) shall set the expiration time of the MCData group information entry to the current time; and +- 3) if a element is included in the root element of the application/pidf+xml MIME body of the SIP NOTIFY request, then for each MCData group information entry such that: + - a) the MCData group information entry has the "affiliating" affiliation status, the MCData group ID set to the handled MCData group ID, the expiration time has not expired yet and with the affiliating p-id set to the value of the element; + - b) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry with the MCData client ID set to a served MCData client ID; + - c) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry with the MCData ID set to a served MCData ID; and + - d) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain: + +- a) a element of the root element; + - b) the "id" attribute of the element indicating the served MCData ID; + - c) an child element of the child element of the element; and + - d) the "client" attribute of the element indicating the served MCData client ID; +- perform the following: +- a) shall set the affiliation status of the MCData group information entry to "deaffiliated"; and + - b) shall set the expiration time of the MCData group information entry to the current time. + +### 8.3.2.8 Procedure for authorizing affiliation status change request in negotiated mode sent to served MCData user + +Upon receiving a SIP MESSAGE request such that: + +- 1) Request-URI of the SIP MESSAGE request contains the public service identity identifying the terminating participating MCData function serving the MCData user; +- 2) the SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 4) the SIP MESSAGE request contains an application/vnd.3gpp.mcdata-affiliation-command+xml MIME body; + +then the MCData server: + +- 1) shall identify the served MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request; +- 2) shall identify the originating MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request; +- 3) if the originating MCData ID is not authorized to send an affiliation status change request in negotiated mode to the served MCData ID, shall send a 403 (Forbidden) response and shall not continue with the rest of the steps; +- 4) shall set the Request-URI of the SIP MESSAGE request to the public user identity bound to the served MCData ID in the MCData server; and +- 5) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + +before forwarding the SIP MESSAGE request further. + +### 8.3.2.9 Forwarding affiliation status change towards another MCData user procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcdata-info MIME body containing the element which identifies an MCData ID not served by the MCData server; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and + +- 5) SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-user affiliation information according to subclause 8.4.1; + +then the MCData server: + +- 1) shall identify the target MCData ID in the element of the application/vnd.3gpp.mcdata-info MIME body of the SIP PUBLISH request; +- 2) shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP PUBLISH request; +- 3) shall generate a SIP PUBLISH request from the received SIP PUBLISH request. In the generated SIP PUBLISH request, the MCData server: + - a) shall set the Request-URI to the public service identity identifying the terminating participating MCData function serving the target MCData ID; + - b) shall include a P-Asserted-Identity header field containing the public service identity identifying the originating participating MCData function serving the MCData user; + - c) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData server: + - A) shall include the element set to the target MCData ID; and + - B) shall include the element set to the originating MCData ID; and + - d) shall include other signalling elements from the received SIP PUBLISH request; and +- 4) shall send the generated SIP PUBLISH request according to 3GPP TS 24.229 [5]. + +The MCData server shall forward received SIP responses to the SIP PUBLISH request. + +### 8.3.2.10 Forwarding subscription to affiliation status towards another MCData user procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcdata-info MIME body containing the element which identifies an MCData ID not served by MCData server; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; + +then the MCData server: + +- 1) shall identify the target MCData ID in the element of the application/vnd.3gpp.mcdata-info MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP SUBSCRIBE request; +- 3) shall generate a SIP SUBSCRIBE request from the received SIP SUBSCRIBE request. In the generated SIP SUBSCRIBE request, the MCData server: + - a) shall set the Request-URI to the public service identity identifying the terminating participating MCData function serving the target MCData ID; + - b) shall include a P-Asserted-Identity header field containing the public service identity identifying the originating participating MCData function serving the MCData user; + +- c) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData server: + - A) shall include the element set to the target MCData ID; and + - B) shall include the element set to the originating MCData ID; and +- d) shall include other signalling elements from the received SIP SUBSCRIBE request; and +- 4) shall send the generated SIP SUBSCRIBE request according to 3GPP TS 24.229 [5]. + +The MCData server shall forward any received SIP responses to the SIP SUBSCRIBE request, any received SIP NOTIFY request and any received SIP responses to the SIP NOTIFY request. + +### 8.3.2.11 Affiliation status determination + +This subclause is referenced from other procedures. + +If the participating MCData function needs to determine the affiliation status of an MCData user to an MCData group, the participating function: + +- 1) shall find the user information entry in the list of MCData user information entries described in subclause 8.3.2.2 such that the MCData ID of the MCData user information entry is equal to the MCData ID of the originator of the received SIP request; + - a) if the applicable MCData group information entry cannot be found, then the participating MCData function shall determine that the MCData user is not affiliated to the MCData group at the MCData client and the skip the rest of the steps; +- 2) shall find the MCData client information entry in the list of MCData client information entries of MCData user information entry found in step 1) in which the MCData client id matches the value of the element contained in the application/vnd.3gpp.mcdata-info+xml MIME body in the received SIP request; + - a) if the applicable MCData client information entry cannot be found, then the participating MCData function shall determine that the MCData user is not affiliated to the MCData group at the MCData client and the skip the rest of the steps; +- 3) shall find the MCData group information entry in the list of MCData group information entries of MCData client information entry found in step 2 such that the MCData group identity matches the value of the identity of the targeted MCData group; + - a) if the applicable MCData group information entry was found in step 3) and the affiliation status of the MCData group information entry is "affiliating" or "affiliated", shall determine that the MCData user at the MCData client to be affiliated to the targeted MCData group and skip the rest of the steps; + - b) if the applicable MCData group information entry was found in step 3) and the affiliation status of the MCData group information entry is "deaffiliating" or "deaffiliated", shall determine that the MCData user at the MCData client to not be affiliated to the targeted MCData group and skip the rest of the steps; or + - c) if the applicable MCData group information entry was not found in step 3), shall determine that the MCData user at the MCData client is not affiliated to the targeted MCData group. + +### 8.3.2.12 Affiliation status change by implicit affiliation + +This subclause is referenced from other procedures. + +Upon receiving a SIP request that requires implicit affiliation of the sending MCData client to an MCData group, the participating MCData function: + +- 1) shall determine the served MCData client ID from the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the received SIP request; +- 2) shall determine the MCData group ID from the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the received SIP request; + +- 3) shall determine the served MCData ID by using the public user identity in the P-Asserted-Identity header field of the SIP request; + +NOTE 1: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 4) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID;as the served MCData user information entry; +- 5) shall consider an MCData client information entry such that: + - a) the MCData client information entry is in the list of MCData client information entries of the served MCData user information entry; and + - b) the MCData client ID of the MCData client information entry is equal to the served MCData client ID;as the served MCData client information entry; +- 6) shall consider a copy of the list of the MCData group information entries of the served MCData client information entry as the served list of the MCData group information entries; +- 7) shall construct the candidate list of the MCData group information entries as follows: + - a) for each MCData group ID which has an MCData group information entry in the served list of the MCData group information entries shall copy the MCData group information entry into a new MCData group information entry of the candidate list of the MCData group information entries; and + - b) if the determined MCData group ID does not have an MCData group information entry in the served list of the MCData group information entries or has an MCData group information entry in the served list of the MCData group information entries, such that the expiration time of the MCData group information entry has already expired: + - i) shall add a new MCData group information entry in the candidate list of the MCData group information list for the determined MCData group ID; + - ii) shall set the affiliation status of the new MCData group information entry to the "affiliating" state; and + - iii) shall set the expiration time of the new MCData group information entry to the current time increased with the candidate expiration interval; +- 8) determine the candidate number of MCData group IDs as the number of different MCData group IDs which have an MCData group information entry: + - a) in the candidate list of the MCData group information entries; or + - b) in the list of the MCData group information entries of an MCData client information entry such that: + - i) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry; and + - ii) the MCData client ID of the MCData client information entry is not equal to the served MCData client ID;with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and +- 9) if the candidate number of MCData group IDs is bigger than the N2 value of the served MCData ID, shall based on MCData service provider policy reduce the candidate MCData group IDs to that equal to N2; + +- 10) if the determined MCData group ID cannot be added to the the candidate list of the MCData group information entries due to exceeding the MCData user's N2 limit, shall discard the candidate list of the MCData group information entries and skip the remaining steps of the current procedure; and +- 11) shall replace the list of the MCData group information entries stored in the served MCData client information entry with the candidate list of the MCData group information entries. + +### 8.3.2.13 Implicit affiliation status change completion + +This subclause is referenced from other procedures. + +If the participating MCData function has received a SIP 2xx response from the controlling MCData function to a SIP request that had triggered performing the procedures of subclause 8.3.2.12, the participating MCData function: + +- 1) shall set the affiliation status of the MCData group information entry added to the candidate list of the MCData group information entries by the procedures of subclause 8.3.2.12 to "affiliated"; and +- 2) shall perform the procedures specified in subclause 8.3.2.5 for the served MCData ID. + +### 8.3.2.14 Implicit affiliation status change cancellation + +This subclause is referenced from other procedures. + +If the participating MCData function determines that a received SIP request that had triggered performing the procedures of subclause 8.3.2.12 needs to be rejected or if the participating MCData function receives a SIP 4xx, 5xx or 6xx response from the controlling MCData function for the received SIP request, the participating MCData function: + +- 1) shall remove the MCData group ID entry added by the procedures of subclause 8.3.2.12 such that: + - a) the MCData group information entry has the MCData group ID set to the MCData group ID of the MCData group targeted by the received SIP request; + - b) the MCData group information entry is in the list of the MCData group information entries of an MCData client information entry containing the MCData client ID included in the received SIP request; and + - c) the MCData client information entry is in the list of the MCData client information entries of the MCData user information entry containing the MCData ID of the sender of the received SIP request. + +### 8.3.2.15 Implicit affiliation to configured groups procedure + +This subclause is referenced from other procedures. + +If the participating MCData function has successfully performed service authorization for the MCData ID identified in the service authorisation procedure as described in 3GPP TS 33.179 [56], the participating MCData function: + +- 1) shall identify the MCData ID included in the SIP request received for service authorisation procedure as the served MCData ID; +- 2) shall identify the MCData client ID from the element contained in the application/vnd.3gpp.mcdata-info+xml MIME body included in the SIP request received for service authorisation as the served MCData client ID; +- 3) shall download the MCData user profile from the MCData user database as defined in 3GPP TS 29.283 [37] if not already stored at the participating MCData function; +- 4) if no element is contained in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]) for the served MCData ID or the element contains no elements containing an MCData group ID, shall skip the remaining steps; +- 5) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of MCData user information entries described in subclause 8.3.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID; + +as the served MCData user information entry; + +- 6) shall consider an MCData client information entry such that: + - a) the MCData client information entry is in the list of MCData client information entries of the served MCData user information entry; and + - b) the MCData client ID of the MCData client information entry is equal to the served MCData client ID; + +as the served MCData client information entry; +- 7) shall consider a copy of the list of the MCData group information entries of the served MCData client information entry as the served list of the MCData group information entries; +- 8) shall construct the candidate list of the MCData group information entries as follows: + - a) for each MCData group ID which has an MCData group information entry in the served list of the MCData group information entries shall copy the MCData group information entry into a new MCData group information entry of the candidate list of the MCData group information entries; + - b) for each MCData group ID contained in an element of the element in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]) for the served MCData ID that does not have an MCData group information entry in the served list of the MCData group information entries or has an MCData group information entry in the served list of the MCData group information entries such that the expiration time of the MCData group information entry has already expired: + - i) shall add a new MCData group information entry in the candidate list of the MCData group information list for the MCData group ID; + - ii) shall set the affiliation status of the new MCData group information entry to the "affiliating" state; and + - iii) shall set the expiration time of the new MCData group information entry to the current time increased with the candidate expiration interval; + - c) if in step b) above, no new MCData group information entries were added to the candidate list of the MCData group information list for the MCData group ID: + - i) shall discard the candidate list; and + - ii) shall skip the remaining steps; +- 9) determine the candidate number of MCData group IDs as the number of different MCData group IDs which have an MCData group information entry: + - a) in the candidate list of the MCData group information entries; or + - b) in the list of the MCData group information entries of an MCData client information entry such that: + - i) the MCData client information entry is in the list of the MCData client information entries of the served MCData user information entry; and + - ii) the MCData client ID of the MCData client information entry is not equal to the served MCData client ID; + +with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and + - c) if the candidate number of MCData group IDs is bigger than the N2 value of the served MCData ID, shall based on MCData service provider policy reduce the candidate MCData group IDs to that equal to N2; +- 10) shall replace the list of the MCData group information entries stored in the served MCData client information entry with the candidate list of the MCData group information entries; and +- 11) for each MCData group ID contained in an element of the element in the element of the MCData user profile document (see the MCData user profile document in + +3GPP TS 24.484 [12]) for the served MCData ID and which has an MCData group information entry in the candidate list of the MCData group information entries with an affiliation status of "affiliating", shall perform the procedures specified in subclause 8.3.2.6 for the served MCData ID and each MCData group ID. + +NOTE 2: To learn of the MCData groups successfully affiliated to, the MCData client can subscribe to that information by the procedures specified in subclause 8.2.3. + +### 8.3.3 Procedures of MCData server owning the MCData group + +#### 8.3.3.1 General + +The procedures of MCData server owning the MCData group consist of: + +- receiving group affiliation status change procedure; +- receiving subscription to affiliation status procedure; +- sending notification of change of affiliation status procedure; +- implicit affiliation eligibility check procedure; and +- affiliation status change by implicit affiliation procedure. + +NOTE: Usage of CSC-3 part of MCData group affiliation procedure and of CSC-3 part of MCData group de-affiliation procedure is not specified in this version of the specification. + +#### 8.3.3.2 Stored information + +The MCData server shall maintain a list of MCData group information entries. + +In each MCData group information entry, the MCData server shall maintain: + +- 1) an MCData group ID. This field uniquely identifies the MCData group information entry in the list of the MCData group information entries; and +- 2) a list of MCData user information entries. + +In each MCData user information entry, the MCData server shall maintain: + +- 1) an MCData ID. This field uniquely identifies the MCData user information entry in the list of the MCData user information entries; +- 2) a list of MCData client information entries; and +- 3) an expiration time. + +In each MCData client information entry, the MCData server shall maintain: + +- 1) an MCData client ID. This field uniquely identifies the MCData client information entry in the list of the MCData client information entries. + +#### 8.3.3.3 Receiving group affiliation status change procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains the public service identity of the controlling MCData function associated with the served MCData group; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and + +- 5) SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-group affiliation information constructed according to subclause 8.4.1; + +then the MCData server: + +- 1) shall identify the served MCData group ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 2) shall identify the handled MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 3) if the Expires header field of the SIP PUBLISH request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP PUBLISH request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if an MCData group for the served MCData group ID does not exist in the group management server according to 3GPP TS 24.481 [11], shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 5) if the handled MCData ID is not a member of the MCData group identified by the served MCData group ID, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 6) shall respond with SIP 200 (OK) response to the SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34]. In the SIP 200 (OK) response, the MCData server: + - a) shall set the Expires header field according to IETF RFC 3903 [34], to the selected expiration time; +- 7) if the "entity" attribute of the element of the application/pidf+xml MIME body of the SIP PUBLISH request is different than the served MCData group ID, shall not continue with the rest of the steps; +- 8) if the handled MCData ID is different from the MCData ID in the "id" attribute of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request, shall not continue with the rest of the steps; +- 9) shall consider an MCData group information entry such that: + - a) the MCData group information entry is in the list of MCData group information entries described in subclause 8.3.3.2; and + - b) the MCData group ID of the MCData group information entry is equal to the served MCData group ID;as the served MCData group information entry; +- 10) if the selected expiration time is zero: + - a) shall remove the MCData user information entry such that: + - i) the MCData user information entry is in the list of the MCData user information entries of the served MCData group information entry; and + - ii) the MCData user information entry has the MCData ID set to the served MCData ID; +- 11) if the selected expiration time is not zero: + - a) shall consider an MCData user information entry such that: + - i) the MCData user information entry is in the list of the MCData user information entries of the served MCData group information entry; and + - ii) the MCData ID of the MCData user information entry is equal to the handled MCData ID;as the served MCData user information entry; + +- b) if the MCData user information entry does not exist: + - i) shall insert an MCData user information entry with the MCData ID set to the handled MCData ID into the list of the MCData user information entries of the served MCData group information entry; and + - ii) shall consider the inserted MCData user information entry as the served MCData user information entry; and + - c) shall set the following information in the served MCData user information entry: + - i) set the MCData client ID list according to the "client" attributes of the elements of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and + - ii) set the expiration time according to the selected expiration time; +- 12) shall identify the handled p-id in the child element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and +- 13) shall perform the procedures specified in subclause 8.3.3.5 for the served MCData group ID. + +#### 8.3.3.4 Receiving subscription to affiliation status procedure + +NOTE: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of affiliation state of several MCData users served by the same MCData server is not supported in this version of the specification. + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity of the controlling MCData function associated with the served MCData group; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; and +- 5) the SIP SUBSCRIBE request contains an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to subclause 8.4.2 indicating the same MCData ID as in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; + +then the MCData server: + +- 1) shall identify the served MCData group ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the handled MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Expires header field of the SIP SUBSCRIBE request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP SUBSCRIBE request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if an MCData group for the served MCData group ID does not exist in the group management server according to 3GPP TS 24.481 [11], shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 5) if the handled MCData ID is not a member of the MCData group identified by the served MCData group ID, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request + +according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; and + +- 6) shall generate a SIP 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [5], IETF RFC 6665 [36]. + +For the duration of the subscription, the MCData server shall notify subscriber about changes of the information of the served MCData ID, as described in subclause 8.3.3.5. + +### 8.3.3.5 Sending notification of change of affiliation status procedure + +In order to notify the subscriber identified by the handled MCData ID about changes of the affiliation status of the served MCData group ID, the MCData server: + +- 1) shall consider an MCData group information entry such that: + - a) the MCData group information entry is in the list of MCData group information entries described in subclause 8.3.3.2; and + - b) the MCData group ID of the MCData group information entry is equal to the served MCData group ID; +- 2) shall consider an MCData user information entry such: + - a) the MCData user information entry is in the list of the MCData user information entries of the served MCData group information entry; and + - b) the MCData ID of the MCData user information entry is equal to the handled MCData ID;as the served MCData user information entry; +- 3) shall generate an application/pidf+xml MIME body indicating per-group affiliation information according to subclause 8.4.1 and the served list of the served MCData user information entry of the MCData group information entry with following clarifications: + - a) the MCData server shall include the "expires" attribute in the element; and + - b) if this procedure is invoked by procedure in subclause 8.3.3.3 where the handled p-id was identified, the MCData server shall set the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request to the handled p-id value; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [5], and IETF RFC 6665 [36] for the subscription created in subclause 8.3.3.4. In the SIP NOTIFY request, the MCData server shall include the generated application/pidf+xml MIME body indicating per-group affiliation information. + +### 8.3.3.6 Implicit affiliation eligibility check procedure + +This subclause is referenced from other procedures. + +Upon receiving a SIP request for an MCData group that the MCData user is not currently affiliated to and that requires the controlling MCData function to check on the eligibility of the MCData user to be implicitly affiliated to the MCData group, the controlling MCData function: + +- 1) shall identify the served MCData group ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP request; +- 2) shall identify the handled MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP request; +- 3) if an MCData group for the served MCData group ID does not exist in the group management server according to 3GPP TS 24.481 [11], shall consider the MCData user to be ineligible for implicit affiliation and skip the rest of the steps; +- 4) if the handled MCData ID is not a member of the MCData group identified by the served MCData group ID, shall consider the MCData user to be ineligible for implicit affiliation and skip the rest of the steps; + +- 5) if there is no MCData group information entry in the list of MCData group information entries described in subclause 8.3.3.2 with an MCData group identity matching the served MCData group ID, then shall consider the MCData user to be ineligible for implicit affiliation and skip the rest of the steps; or +- 6) shall consider the MCData user to be eligible for implicit affiliation. + +### 8.3.3.7 Affiliation status change by implicit affiliation procedure + +This subclause is referenced from other procedures. + +Upon receiving a SIP request for an MCData group that the MCData user is not currently affiliated to and that requires the controlling MCData function to perform an implicit affiliation to, the controlling MCData function: + +- 1) shall identify the served MCData group ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP request; + - 2) shall identify the handled MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP request; + - 3) shall consider an MCData group information entry such that: + - a) the MCData group information entry is in the list of MCData group information entries described in subclause 8.3.3.2; and + - b) the MCData group ID of the MCData group information entry is equal to the served MCData group ID;as the served MCData group information entry; + - 4) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of the MCData user information entries of the served MCData group information entry; and + - b) the MCData ID of the MCData user information entry is equal to the handled MCData ID;as the served MCData user information entry; + - c) if the MCData user information entry does not exist: + - i) shall insert an MCData user information entry with the MCData ID set to the handled MCData ID into the list of the MCData user information entries of the served MCData group information entry; and + - ii) shall consider the inserted MCData user information entry as the served MCData user information entry; and + - d) shall make the following modifications in the served MCData user information entry: + - i) add the MCData client ID derived from the received SIP request to the MCData client ID list if not already present; and + - ii) set the expiration time as determined by local policy; +- 5) shall perform the procedures specified in subclause 8.3.3.5 for the served MCData group ID. + +## 8.4 Coding + +### 8.4.1 Extension of application/pidf+xml MIME type + +#### 8.4.1.1 Introduction + +The subclauses of the parent subclause describe an extension of the application/pidf+xml MIME body specified in IETF RFC 3863 [40]. The extension is used to indicate: + +- per-user affiliation information; and +- per-group affiliation information. + +### 8.4.1.2 Syntax + +The application/pidf+xml MIME body indicating per-user affiliation information is constructed according to IETF RFC 3863 [40] and: + +- 1) contains a root element according to IETF RFC 3863 [40]; +- 2) contains an "entity" attribute of the element set to the MCData ID of the MCData user; +- 3) contains one child element according to IETF RFC 3863 [40] per each MCData client of the element; +- 4) can contain a child element defined in the XML schema defined in table 8.4.1.2-1, of the element set to an identifier of a SIP PUBLISH request; +- 5) contains an "id" attribute of the element set to the MCData client ID; +- 6) contains one child element of each element; +- 7) contains one child element defined in the XML schema defined in table 8.4.1.2-1, of the element, for each MCData group in which the MCData user is interested at the MCData client; +- 8) contains a "group" attribute of each element set to the MCData group ID of the MCData group in which the MCData user is interested at the MCData client; +- 9) can contain a "status" attribute of each element indicating the affiliation status of the MCData user to MCData group at the MCData client; and +- 10) can contain an "expires" attribute of each element indicating expiration of affiliation of the MCData user to MCData group at the MCData client. + +The application/pidf+xml MIME body indicating per-group affiliation information is constructed according to IETF RFC 3856 [39] and: + +- 1) contains the root element according to IETF RFC 3863 [40]; +- 2) contains an "entity" attribute of the element set to the MCData group ID of the MCData group; +- 3) contains one child element according to IETF RFC 3863 [40] of the element; +- 4) can contain a child element defined in the XML schema defined in table 8.4.1.2-1, of the element set to an identifier of a SIP PUBLISH request; +- 5) contains an "id" attribute of the element set to the MCData ID of the MCData user; +- 6) contains one child element of each element; +- 7) contains one child element defined in the XML schema defined in table 8.4.1.2-1, of the element, for each MCData client at which the MCData user is interested in the MCData group; +- 8) contains one "client" attribute defined in the XML schema defined in table 8.4.1.2-2, of the element set to the MCData client ID; and +- 9) can contain an "expires" attribute defined in the XML schema defined in table 8.4.1.2-2, of the element indicating expiration of affiliation of the MCData user to MCData group at the MCData client. + +**Table 8.4.1.2-1: XML schema with elements and attributes extending the application/pidf+xml MIME body** + +``` + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + +``` + +The application/pidf+xml MIME body refers to namespaces using prefixes specified in table 8.4.1.2-2. + +**Table 8.4.1.2-2: Assignment of prefixes to namespace names in the application/pidf+xml MIME body** + +| Prefix | Namespace | +|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| mcdataPI10 | urn:3gpp:ns:mcdataPresInfo:1.0 | +| NOTE: The "urn:ietf:params:xml:ns:pidf" namespace is the default namespace so no prefix is used for it in the application/pidf+xml MIME body. | | + +## 8.4.2 Extension of application/simple-filter+xml MIME type + +### 8.4.2.1 Introduction + +The subclauses of the parent subclause describe an extension of the application/simple-filter+xml MIME body specified in IETF RFC 4661 [41]. + +The extension is used to indicate per-client restrictions of presence event package notification information and per-user restrictions of presence event package notification information. + +### 8.4.2.2 Syntax + +The application/simple-filter+xml MIME body indicating per-client restrictions of presence event package notification information is constructed according to IETF RFC 4661 [41] and: + +- 1) contains a root element according to IETF RFC 4661 [41]; +- 2) contains a child element according to IETF RFC 4661 [41], of the element; +- 3) contains a child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains a "prefix" attribute according to IETF RFC 4661 [41] set to "pidf"; and + - B) contains a "urn" attribute set to the "urn:ietf:params:xml:ns:pidf" value; +- 4) contains a child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains a "prefix" attribute according to IETF RFC 4661 [41], set to "mcdataPI10"; and + - B) contains an "urn" attribute according to IETF RFC 4661 [41], set to the "urn:3gpp:ns:mcdataPresInfo:1.0" value; +- 5) contains a child element according to IETF RFC 4661 [41], of the element where the element; + +- A) contains an "id" attribute set to a value constructed according to IETF RFC 4661 [41]; + - B) does not contain an "uri" attribute of the child element according to IETF RFC 4661 [41]; and + - C) does not contain an "domain" attribute according to IETF RFC 4661 [41]; +- 6) contains a child element according to IETF RFC 4661 [41], of the element; and + - 7) contains an child element according to IETF RFC 4661 [41], of the element where the element; + - A) does not contain a "type" attribute according to IETF RFC 4661 [41]; and + - B) contains the value, according to IETF RFC 4661 [41], set to concatenation of the + `"/pidf:presence/pidf:tuple[@id=""` string, the MCData client ID, and the `"]"` string. + +The application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information is constructed according to IETF RFC 4661 [41] and: + +- 1) contains a root element according to IETF RFC 4661 [41]; +- 2) contains a child element according to IETF RFC 4661 [41], of the element; +- 3) contains a child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains a "prefix" attribute according to IETF RFC 4661 [41] set to "pidf"; and + - B) contains a "urn" attribute set to the "urn:ietf:params:xml:ns:pidf" value; +- 4) contains a child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains a "prefix" attribute according to IETF RFC 4661 [41], set to "mcdataPI10"; and + - B) contains an "urn" attribute according to IETF RFC 4661 [41], set to the "urn:3gpp:ns:mcdataPresInfo:1.0" value; +- 5) contains a child element according to IETF RFC 4661 [41], of the element where the element; + - A) contains an "id" attribute set to a value constructed according to IETF RFC 4661 [41]; + - B) does not contain an "uri" attribute of the child element according to IETF RFC 4661 [41]; and + - C) does not contain an "domain" attribute according to IETF RFC 4661 [41]; +- 6) contains a child element according to IETF RFC 4661 [41], of the element; and +- 7) contains an child element according to IETF RFC 4661 [41], of the element where the element; + - A) does not contain a "type" attribute according to IETF RFC 4661 [41]; and + - B) contains the value, according to IETF RFC 4661 [41], set to concatenation of the + `"/pidf:presence/pidf:tuple[@id=""` string, the MCData ID, and the `"]"` string. + +## 9 Short Data Service (SDS) + +### 9.1 General + +The group administrator can disable the SDS service on a MCData group by setting the element under the element, in the group document, to "false". + +If the element under the element, in the group document, is set to "false" for a MCData group: + +- an MCData client should not use the procedures in the subclauses of the parent subclause to send SDS to the said MCData group. +- a terminating MCData controlling function should reject the request to send SDS to the said MCData group. + +## 9.2 On-network SDS + +### 9.2.1 General + +#### 9.2.1.1 Sending an SDS message + +When the MCData user wishes to send: + +- a one-to-one standalone Short Data Service (SDS) message to another MCData user; or +- a group standalone Short Data Service (SDS) message to a pre-arranged group ; + +the MCData client: + +- 1) shall follow the procedures in subclause 11.1 for transmission control; and +- 2) if the procedures in subclause 11.1 are successful and the size of the payload the MCData user wishes to send: + - a) is less than or equal to the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12], shall follow the procedures specified in subclause 9.2.2.2.1; + - b) is greater than the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12], shall follow the procedures specified in subclause 9.2.3.2.3. + +When the MCData user wishes to: + +- initiate a Short Data Service (SDS) session with another MCData user; or +- initiate a group Short Data Service (SDS) session to a pre-configured group or to particular members of the pre-configured group; + +the MCData client: + +- 1) shall follow the procedures in subclause 11.1 for transmission control; and +- 2) if the procedures in subclause 11.1 are successful, shall follow the procedures specified in subclause 9.2.4.2.3. + +#### 9.2.1.2 Handling of received SDS messages with or without disposition requests + +When a MCData client has received a SIP request containing: + +- an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and +- an application/vnd.3gpp.mcdata-payload MIME body as specified in subclause E.2; + +the MCData Client: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) shall decode the contents of the application/vnd.3gpp.mcdata-payload MIME body; +- 3) if the SDS SIGNALLING PAYLOAD message contains a new Conversation ID, shall instantiate a new conversation with the Message ID in the SDS SIGNALLING PAYLOAD identifying the first message in the conversation thread; +- 4) if the SDS SIGNALLING PAYLOAD message contains an existing Conversation ID and: + +- a) if the SDS SIGNALLING PAYLOAD message does not contain an InReplyTo message ID, shall use the Message ID in the SDS SIGNALLING PAYLOAD to identify a new message in the existing conversation thread; and + - b) if the SDS SIGNALLING PAYLOAD message contains an InReplyTo message ID, shall associate the message to an existing message in the conversation thread as identified by the InReplyTo message ID in the SDS SIGNALLING PAYLOAD, and use the Message ID in the SDS SIGNALLING PAYLOAD to identify the new message; +- 5) shall identify the number of Payload IEs in the DATA PAYLOAD message from the Number of payloads IE in the DATA PAYLOAD message; +- 6) if the SDS SIGNALLING PAYLOAD message does not contain an Application ID IE and does not contain an Extended application ID IE: + - a) shall determine that the payload contained in the DATA PAYLOAD message is for user consumption + - b) may notify the MCData user; + - c) may display to the MCData user the functional alias of the originating MCData user, if provided; and + - d) shall render the contents of the Payload IE(s) to the MCData user. +- 7) if the SDS SIGNALLING PAYLOAD message contains an Application ID IE: + - a) shall determine that the payload contained in the DATA PAYLOAD message is not for user consumption, + - b) shall not notify the MCData user; + - c) if the Application ID value is unknown, shall discard the SDS message; and + - d) if the Application ID value is known, shall deliver the contents of the Payload IE(s) to the identified application; + +NOTE 1: If required, the MCData client decrypts the Payload IEs before rendering the SDS message to the user or delivering the SDS message to the application. + +NOTE 2: The actions taken when the payload contains application data not meant for user consumption or command instructions are based upon the contents of the payload. If the payload content is addressed to a non-MCData application that is not running, the MCData client starts the local non-MCData application and delivers the payload to that application. + +NOTE 3: User consent is not required before accepting the data. + +- 8) if the SDS SIGNALLING PAYLOAD message contains an Extended application ID IE: + - a) shall determine that the payload contained in the DATA PAYLOAD message is not for user consumption; + - b) shall not notify the MCData user; + - c) if the Extended application ID value is unknown, shall discard the SDS message; and + - d) if the Extended application ID value is known, shall deliver the contents of the Payload IE(s) to the identified application; + +NOTE 4: If required, the MCData client decrypts the Payload IEs before rendering the SDS message to the user or delivering the SDS message to the application. + +NOTE 5: The actions taken when the payload contains application data not meant for user consumption or command instructions are based upon the contents of the payload. If the payload content is addressed to a non-MCData application that is not running, the MCData client starts the local non-MCData application and delivers the payload to that application. + +NOTE 6: User consent is not required before accepting the data. + +- 9) may store the message payload in local storage along with the Conversation ID, Message ID, InReplyTo message ID and Date and time; and +- 10) if the received SDS SIGNALLING PAYLOAD message contains an SDS disposition request type IE shall follow the procedures in subclause 9.2.1.3. + +### 9.2.1.3 Handling of disposition requests + +To handle the disposition requests, the MCData client: + +- 1) If the SDS disposition request type IE is set to: + - a) "DELIVERY" then, shall send a delivered notification as described in subclause 12.2.1.1; + - b) "READ", shall send a read notification as described in subclause 12.2.1.1, when a display indication is received; or + - c) "DELIVERY AND READ" then, shall start timer TDU1 (delivery and read). + +Upon receiving a display indication before timer TDU1 (delivery and read) expires, the MCData client: + +- 1) shall stop timer TDU1 (delivery and read); and +- 2) shall send a delivered and read notification as described in subclause 12.2.1.1. + +Upon expiry of timer TDU1 (delivery and read), the MCData client: + +- 1) shall send a delivered notification as described in subclause 12.2.1.1; and +- 2) upon receiving a display indication, send a read notification as described in subclause 12.2.1.1. + +## 9.2.2 Standalone SDS using signalling control plane + +### 9.2.2.1 General + +The procedures in the subclauses of the parent subclause are used by a MCData functional entity to send or receive: + +- a one-to-one standalone SDS message using the signalling control plane; or +- a group standalone SDS message using the signalling control plane. + +### 9.2.2.2 MCData client procedures + +#### 9.2.2.2.1 MCData client originating procedures + +The MCData client shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] with the clarifications given below. + +The MCData client: + +- 1) shall build the SIP MESSAGE request as specified in subclause 6.2.4.1; +- 2) if a one-to-one standalone SDS message is to be sent, shall insert in the SIP MESSAGE request: + - a) an application/resource-lists+xml MIME body with the MCData ID of the target MCData user, according to rules and procedures of IETF RFC 4826 [9]; + - b) an application/vnd.3gpp.mcdata-info+xml MIME body with: + - i) a element set to a value of "one-to-one-sds"; and + - ii) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP MESSAGE request, the element set to the URI of the used functional alias; and + +- c) if end-to-end security is required and the security context does not exist or if the existing security context has expired, an application/mikey MIME body with the MIKEY-SAKKE I\_MESSAGE as specified in 3GPP TS 33.180 [26]. The MCData client: + - i) if necessary, shall instruct the key management client to request keying material from the key management server as described in 3GPP TS 33.180 [26]; + - ii) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [26]; + - iii) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0001" to indicate that the purpose of the PCK is to protect one-to-one communications and with the remaining twenty eight bits being randomly generated as described in 3GPP TS 33.180 [26]; + - iv) shall encrypt the PCK to a UID associated to the MCData client using the MCData ID of the invited user and a time related parameter as described in 3GPP TS 33.180 [26]; + - v) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [26]; and + - vi) shall add the MCData ID of the originating MCData to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - vii) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating MCData user's signing key provided in the keying material together with a time related parameter; and + - viii) shall include the MIKEY-SAKKE I\_MESSAGE in an application/mikey MIME body as specified in 3GPP TS 33.180 [26]; +- 3) if a group standalone SDS message is to be sent: + - a) if the "///Common/MCData/AllowedSDS" leaf node present in the group document of the requested MCData group, configured on the group management client as specified in 3GPP TS 24.483 [42] is set to "false", shall reject the request to send SDS and not continue with the rest of the steps in this subclause; and + - b) shall insert in the SIP MESSAGE request an application/vnd.3gpp.mcdata-info+xml MIME body with: + - i) the element set to a value of "group-sds"; + - ii) the element set to the MCData group identity; + - iii) the element set to the MCData client ID of the originating MCData client; and + - iv) if the MCData client is aware of active functional aliases, and an active functional alias is to be included in the SIP MESSAGE request, the set to the URI of the used functional alias; +- 4) shall generate a standalone SDS message as specified in subclause 6.2.2.1; and +- 5) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]. + +#### 9.2.2.2.2 MCData client terminating procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for terminating MCData client", the MCData client: + +- 1) may reject the SIP MESSAGE request if there are not enough resources to handle the SIP MESSAGE request; +- 2) if the SIP MESSAGE request is rejected in step 1), shall respond toward participating MCData function with a SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this subclause; +- 3) if the SIP MESSAGE request contains an application/mikey MIME body containing a MIKEY-SAKKE I\_MESSAGE: + - a) shall extract the MCData ID of the originating MCData user from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - b) shall convert the MCData ID to a UID as described in 3GPP TS 33.180 [26]; + +- c) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [26]; +- d) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP MESSAGE request with a SIP 606 (Not Acceptable) response, and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9 and not continue with rest of the steps in this subclause; and +- e) if the signature of the MIKEY-SAKKE I\_MESSAGE was successfully validated: + - i) shall extract and decrypt the encapsulated PCK using the terminating user's (KMS provisioned) UID key as described in 3GPP TS 33.180 [26]; and + - ii) shall extract the PCK-ID, from the payload as specified in 3GPP TS 33.180 [26]; + +NOTE: With the PCK successfully shared between the originating MCData client and the terminating MCData client, both clients are able to exchange end-to-end secure message. + +- 4) shall generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; +- 5) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]; and +- 6) shall handle the received message as specified in subclause 9.2.1.2. + +## 9.2.2.3 Participating MCData function procedures + +### 9.2.2.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine the MCData ID of the originating user from the public user identity in the P-Asserted-Identity header field of the SIP MESSAGE request, and shall authorise the calling user; + +NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is: + - a) set to a value of "group-sds", shall determine the public service identity of the controlling MCData function associated with the MCData group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request; or + - b) set to a value of "one-to-one-sds", shall determine the public service identity of the controlling MCData function hosting the one-to-one standalone SDS service for the calling user; +- 5) if unable to identify the controlling MCData function for standalone SDS, it shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; + +- 6) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; +- 7) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID: + - a) is not allowed to send MCData communications as determined by step 1) of subclause 11.1, shall reject the "SIP MESSAGE request for standalone SDS for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - b) is not allowed to initiate one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request as determined by step 7) of subclause 11.1, shall reject the "SIP MESSAGE request for standalone SDS for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "202 user not authorised for one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - c) is not allowed to initiate one-to-one MCData communications to the targeted user as determined by step 1a) of subclause 11.1, shall reject the "SIP MESSAGE request for standalone SDS for originating participating MCData function" with a SIP 403 (Forbidden) response including warning text set to "229 one-to-one MCData communication not authorised to the targeted user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 8) if the payload size of the message is larger than the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12], shall reject the "SIP MESSAGE request for standalone SDS for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "203 message too large to send over signalling control plane" in a Warning header field as specified in subclause 4.9; + +NOTE: The term "payload size" refers to the "Length of Payload contents" of the payload IE of the DATA PAYLOAD message transported in the SIP MESSAGE request, minus 1 (to account for the added "Payload content type" field). + +- 9) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 10) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the controlling MCData function as determined by step 4) in this subclause; +- 11) shall copy all MIME bodies included in the incoming SIP MESSAGE request to the outgoing SIP MESSAGE request; +- 12) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP MESSAGE request; +- 12A) if the incoming SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; +- 13) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; +- 14) shall set the P-Asserted-Identity in the outgoing SIP MESSAGE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP MESSAGE request; and +- 15) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 202 (Accepted) response in response to the SIP MESSAGE request in step 15): + +- 1) shall generate a SIP 202 (Accepted) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 202 (Accepted) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP MESSAGE request in step 15): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the SIP MESSAGE request in step 15) the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +### 9.2.2.3.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request to retrieve the binding between the MCData ID and public user identity of the terminating MCData user; +- 3) if the binding between the MCData ID and public user identity of the terminating MCData user does not exist, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response, and shall not continue with the rest of the steps; +- 3a) if the element exists in the MCData user profile document with one or more elements (see the MCData user profile document in 3GPP TS 24.484 [12]) and: + - i) if the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request does not match with the element of any of the elements in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]); and + - ii) if configuration is not set in the MCData user profile document that allows the MCData user to receive one-to-one MCData communication from any user (see element in MCData user profile document in 3GPP TS 24.484 [12]);then: + - i) shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response including warning text set to "230 one-to-one MCData communication not authorised from this originating user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 4) shall generate an outgoing SIP MESSAGE request as specified in subclause 6.3.2.1; +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; and +- 6) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +#### 9.2.2.4 Controlling MCData function procedures + +##### 9.2.2.4.1 Originating controlling MCData function procedures + +This subclause describes the procedures for sending a SIP MESSAGE from the controlling MCData function and is initiated by the controlling MCData function as a result of an action in subclause 9.2.2.4.2. + +The controlling MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 3) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 4) shall copy the following MIME bodies in the received SIP MESSAGE request into the outgoing SIP MESSAGE request by following the guidelines in subclause 6.4: + - a) application/vnd.3gpp.mcdata-info+xml MIME body; + - b) application/vnd.3gpp.mcdata-signalling MIME body; and + - c) application/vnd.3gpp.mcdata-payload MIME body +- 5) in the application/vnd.3gpp.mcdata-info+xml MIME body: + - a) shall set the element set to the MCData ID of the terminating user; and + - b) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request was set to a value of "group-sds", shall set the element to the group identity; +- 6) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; +- 7) shall copy the public user identity of the calling MCData user from the P-Asserted-Identity header field of the incoming SIP MESSAGE request into the P-Asserted-Identity header field of the outgoing SIP MESSAGE request; +- 8) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and +- 9) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [5]. + +##### 9.2.2.4.2 Terminating controlling MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for controlling MCData function", the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4]. Otherwise, continue with the rest of the steps; + +2) if the SIP MESSAGE does not contain: + +- a) an application/vnd.3gpp.mcdata-info+xml MIME body; +- b) an application/vnd.3gpp.mcdata-signalling MIME body; and +- c) an application/vnd.3gpp.mcdata-payload MIME body; + +shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "199 expected MIME bodies not in the request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + +3) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body contained in the SIP MESSAGE; + +4) if the application/vnd.3gpp.mcdata-signalling MIME body contains a SDS SIGNALLING PAYLOAD message with a SDS disposition request type IE, shall store the value of the Conversation ID IE and the value of the Message ID IE in the SDS SIGNALLING PAYLOAD message; + +NOTE: The controlling MCData function uses the Conversation ID and Message ID for correlation with disposition notifications. + +5) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is set to a value of "one-to-one-sds" and: + +a) the conditions in subclause 11.1 indicate that the MCData user is not allowed to SDS communications due to message size as determined by step 3) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "218 user not authorised for one-to-one SDS communications due to message size" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + +b) the SIP MESSAGE request: + +i) does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall return a SIP 403 (Forbidden) response with the warning text set to "204 unable to determine targeted user for one-to-one SDS" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + +ii) contains an application/resource-lists MIME body with exactly one element, shall send a SIP MESSAGE request to the MCData user identified in the element of the MIME body, as specified in subclause 9.2.2.4.1; + +6) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is set to a value of "group-sds": + +a) shall retrieve the group document associated with the group identity in the SIP MESSAGE request by following the procedures in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + +b) if the element is present in the group document, shall send a SIP 403 (Forbidden) response with the warning text set to "115 group is disabled" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + +c) if the element of the element of the element in the group document does not contain an element with a "uri" attribute matching the MCData ID of the originating user contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, shall send a SIP 403 (Forbidden) response with the warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + +d) if the element contains a element in the group document set to a value of "false", shall send a SIP 403 (Forbidden) response with the warning text set to "206 short data service not allowed for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + +- e) if the element is not present in the group document or is present and contains a element containing an "enabler" attribute which is not set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", shall send a SIP 488 (Not Acceptable) response with the warning text set to "207 SDS services not supported for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - f) if the MCData server group SDS procedures in subclause 11.1 indicate that the user identified by the MCData ID: + - i) is not allowed to send group MCData communications on this group identity as determined by step 2) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "201 user not authorised to transmit data on this group identity" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - ii) is not allowed to send group MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request as determined by step 8) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "208 user not authorised for MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - iii) is not allowed to send SDS communications on this group identity due to message size as determined by step 5) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "217 user not authorised for SDS communications on this group identity due to message size" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - g) the originating user identified by the MCData ID is not affiliated to the group identity contained in the SIP MESSAGE request, as specified in subclause 6.3.5, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; + - h) shall determine targeted group members for MCData communications by following the procedures in subclause 6.3.4; + - j) if the procedures in subclause 6.3.4 result in no affiliated members found in the selected MCData group, shall return a SIP 403 (Forbidden) response with the warning text set to "198 no users are affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + - k) shall send SIP MESSAGE requests to the targeted group members identified in step h) above by following the procedure in subclause 9.2.2.4.1; +- 7) shall generate a SIP 202 (Accepted) response in response to the "SIP MESSAGE request for standalone SDS for controlling MCData function"; and +- 8) shall send the SIP 202 (Accepted) response towards the originating participating MCData function according to 3GPP TS 24.229 [5]. + +## 9.2.3 Standalone SDS using media plane + +### 9.2.3.1 General + +The procedures in the subclauses of the parent subclause are used by a MCData functional entity to send or receive: + +- a one-to-one standalone SDS message using the media control plane; or +- a group standalone SDS message using the media control plane. + +The procedures in the subclauses of the parent subclause are applicable to establish an on-demand standalone SDS using media plane. + +### 9.2.3.2 MCData client procedures + +#### 9.2.3.2.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 4975 [17], IETF RFC 6135 [19] and IETF RFC 6714 [20] the MCData client: + +- 1) shall include an "m=message" media-level section for the MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP", or "TCP/TLS/MSRP" for TLS; + - c) a format list field set to '\*'; + - d) an "a=sendonly" attribute; + - e) an "a=path" attribute containing its own MSRP URI; + - f) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload"; and + - g) set the a=setup attribute as "actpass"; and +- 2) if end-to-end security is required for a one-to-one communication and the security context does not exist or if the existing security context has expired, shall include the MIKEY-SAKKE I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [45]. + +#### 9.2.3.2.2 SDP answer generation + +When the MCData client receives an initial SDP offer for an MCData standalone SDS, the MCData client shall process the SDP offer and shall compose an SDP answer according to 3GPP TS 24.229 [5] and IETF RFC 4975 [17]. + +When composing an SDP answer, the MCData client: + +- 1) shall include an "m=message" media-level section for the accepted MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP", or "TCP/TLS/MSRP" for TLS according to the received SDP offer; + - c) a format list field set to '\*'; + - d) an "a=recvonly" attribute; + - e) an "a=path" attribute containing its own MSRP URI; + - f) set the content type as a=accept-types: application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload; and + - g) set the a=setup attribute according to IETF RFC 6135 [19]. + +#### 9.2.3.2.3 MCData client originating procedures + +The MCData client shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5] with the clarifications given below. + +The MCData client: + +- 1) shall include the g.3gpp.mcdata.sds media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [16]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + +- 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 5) should include the "timer" option tag in the Supported header field; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) if a one-to-one standalone SDS message is to be sent: + - a) shall insert in the SIP INVITE request a MIME resource-lists body with the MCData ID of the invited MCData user, according to rules and procedures of IETF RFC 5366 [18]; + - b) shall contain an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - i) the element set to a value of "one-to-one-sds"; and + - ii) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP INVITE request, the element set to the URI of the used functional alias; and + +NOTE 0: The MCData client learns the functional aliases that are activated for an MCData ID from procedures specified in subclause 22.2.1.3. + +- c) if an end-to-end security context needs to be established and the security context does not exist or if the existing security context has expired, then: + - i) if necessary, shall instruct the key management client to request keying material from the key management server as described in 3GPP TS 33.180 [26]; + - ii) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [26]; + - iii) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0001" to indicate that the purpose of the PCK is to protect one-to-one communications and with the remaining twenty eight bits being randomly generated as described in 3GPP TS 33.180 [26]; + - iv) shall encrypt the PCK to a UID associated to the MCData client using the MCData ID of the invited user and a time related parameter as described in 3GPP TS 33.180 [26]; + - v) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [26]; + - vi) shall add the MCData ID of the originating MCData to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; and + - vii) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating MCData user's signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [26]; +- 8) if a group standalone SDS message is to be sent: + - a) if the "///Common/MCData/AllowedSDS" leaf node present in the group document of the requested MCData group, configured on the group management client as specified in 3GPP TS 24.483 [42] is set to "false", shall reject the request to send SDS and not continue with the rest of the steps in this subclause; and + - b) shall contain in an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - i) the element set to a value of "group-sds"; + +- ii) the element set to the MCData group identity; +- iii) the element set to the MCData client ID of the originating MCData client; and + +NOTE 1: The MCData client does not include the MCData ID of the originating MCData user in the body, as this will be inserted into the body of the SIP INVITE request that is sent from the originating participating MCData function. + +- iv) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP INVITE request, may include the element set to the URI of the used functional alias; +- 9) shall set the Request-URI of the SIP INVITE request to the public service identity identifying the participating MCData function serving the MCData user; +- NOTE 2: The MCData client is configured with public service identity identifying the participating MCData function serving the MCData user. +- 10) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; +- 11) shall include an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 9.2.3.2.1; and +- 12) shall send the SIP INVITE request towards the MCData server according to 3GPP TS 24.229 [5]. + +On receipt of a SIP 2xx response to the SIP INVITE request, the MCData client: + +- 1) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]; +- 2) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; and +- 3) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.1.1.2. + +On receipt of a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request: + +- 1) shall indicate to the MCData user that the SDS message could not be sent; and +- 2) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]. + +On receipt of an indication from the media plane indicating that the standalone SDS message was not sent successfully, the MCData client shall: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5] with: + - a) Reason code set to "SIP"; + - b) cause set to "480"; and + - c) text set to "transmission failed"; +- 2) shall set the Request-URI to the MCData session identity to release; and +- 3) shall send a SIP BYE request towards MCData server according to 3GPP TS 24.229 [5]. + +On receipt of an indication from the media plane indicating that the standalone SDS message has been successfully transferred, the MCData client shall: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5] with: + - a) Reason code set to "SIP"; + - b) cause set to "200"; and + - c) text set to "transmission succeeded"; +- 2) shall set the Request-URI to the MCData session identity to release; and + +- 3) shall send a SIP BYE request towards MCData server according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request, the MCData client shall interact with the media plane and indicate to terminate the session, as specified in 3GPP TS 24.582 [15]. + +#### 9.2.3.2.4 MCData client terminating procedures + +Upon receipt of an "initial SIP INVITE request for standalone SDS over media plane for terminating MCData client" request, the MCData client shall follow the procedures for termination of multimedia sessions in the IM CN subsystem as specified in 3GPP TS 24.229 [5] with the clarifications below. + +The MCData client: + +- 1) may reject the SIP INVITE request if either of the following conditions are met: + - a) MCData client does not have enough resources to handle the call; or + - b) any other reason outside the scope of this specification;and skip the rest of the steps after step 2; +- 2) if the SIP INVITE request is rejected in step 1), shall respond toward participating MCData function either with appropriate reject code as specified in 3GPP TS 24.229 [5] and warning texts as specified in subclause 4.9 or with SIP 480 (Temporarily unavailable) response not including warning texts if the user is authorised to restrict the reason for failure and skip the rest of the steps of this subclause; +- 3) if the SDP offer of the SIP INVITE request contains an "a=key-mgmt" attribute field with a "mikey" attribute value containing a MIKEY-SAKKE I\_MESSAGE: + - a) shall extract the MCData ID of the originating MCData user from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - b) shall convert the MCData ID to a UID as described in 3GPP TS 33.180 [26]; + - c) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - d) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP INVITE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9 and not continue with rest of the steps in this subclause; and + - e) if the signature of the MIKEY-SAKKE I\_MESSAGE was successfully validated: + - i) shall extract and decrypt the encapsulated PCK using the terminating user's (KMS provisioned) UID key as described in 3GPP TS 33.180 [26]; and + - ii) shall extract the PCK-ID, from the payload as specified in 3GPP TS 33.180 [26]; + +NOTE: With the PCK successfully shared between the originating MCData client and the terminating MCData client, both clients are able to create an end-to-end secure session. + +- 3) may display to the MCData user the MCData ID of the inviting MCData user and the type of SDS request; +- 4) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; +- 5) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 6) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [38]. The "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 7) shall include the g.3gpp.mcdata.sds media feature tag in the Contact header field of the SIP 200 (OK) response; + +- 8) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in the Contact header field of the SIP 200 (OK) response; +- 9) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [5] with the clarifications given in subclause 9.2.3.2.2; and +- 10) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of an SIP ACK message to the sent SIP 200 (OK) message, the MCData client shall: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.1.1.3. + +### 9.2.3.3 Participating MCData function procedures + +#### 9.2.3.3.1 SDP offer generation + +The SDP offer is generated based on the received SDP offer. The SDP offer generated by the participating MCData function: + +- 1) shall contain only one SDP media-level section for SDS message as contained in the received SDP offer; and +- 2) shall contain an "a=key-mgmt" attribute field with a "mikey" attribute value, if present in the received SDP offer. + +When composing the SDP offer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number for the offered media stream in the received SDP offer with the IP address and port number of the participating MCData function, if required; and + +NOTE 1: Requirements can exist for the participating MCData function to be always included in the path of the offered media stream, for example: for the support of features such as MBMS, lawful interception and recording. Other examples can exist. + +NOTE 2: If the participating MCData function and the controlling MCData function are in the same MCData server, and the participating MCData function does not have a dedicated IP address or a dedicated port number for media stream, the replacement of the IP address or the port number is omitted. + +- 2) if the IP address is replaced, shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP offer. + +#### 9.2.3.3.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number in the received SDP answer with the IP address and port number of the participating MCData function, for the accepted media stream in the received SDP offer, if required; and + +NOTE 1: Requirements can exist for the participating MCData function to be always included in the path of the offered media stream, for example: for the support of features such as MBMS, lawful interception and recording. Other examples can exist. + +NOTE 2: If the participating MCData function and the controlling MCData function are in the same MCData server, and the participating MCData function does not have a dedicated IP address or a dedicated port number for media stream, the replacement of the IP address or the port number is omitted. + +- 2) if the IP address is replaced shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP answer. + +#### 9.2.3.3.3 Originating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for standalone SDS over media plane for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; + +- 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP INVITE request, and shall authorise the calling user; + +NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is: + - a) set to a value of "group-sds", shall determine the public service identity of the controlling MCData function associated with the MCData group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP INVITE request; or + - b) set to a value of "one-to-one-sds", shall determine the public service identity of the controlling MCData function hosting the one-to-one standalone SDS over media plane service for the calling user; +- 5) if unable to identify the controlling MCData function for standalone SDS over media plane, it shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 6) shall determine whether the MCData user identified by the MCData ID + - a) is authorised for MCData communications by following the procedures in subclause 11.1; and + - b) is not allowed to initiate one-to-one MCData communications to the targeted user as determined by step 1a) of subclause 11.1, shall reject the "SIP INVITE request for standalone SDS over media plane for originating participating MCData function" with a SIP 403 (Forbidden) response including warning text set to "229 one-to-one MCData communication not authorised to the targeted user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 7) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to initiate MCData communications, shall reject the "SIP INVITE request for standalone SDS over media plane for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; +- 8) shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5]; +- 9) shall include the option tag "timer" in the Supported header field; +- 10) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 11) shall set the Request-URI of the outgoing SIP INVITE request to the public service identity of the controlling MCData function as determined by step 4) in this subclause; +- 12) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; +- 12A) if the incoming SIP INVITE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; +- 13) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; + +- 14) shall set the P-Asserted-Identity in the outgoing SIP INVITE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP INVITE request; +- 15) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the MCData client as specified in subclause 9.2.3.3.1; and +- 16) shall send the SIP INVITE request as specified to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP INVITE request in step 16): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include in the SIP 200 (OK) response an SDP answer as specified in the subclause 9.2.3.3.2; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If the "refresher" parameter is not included in the received request, the "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and + - c) the isfocus media feature tag; +- 6) shall include Warning header field(s) that were received in the incoming SIP 200 (OK) response; +- 7) shall include an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP 200 (OK) response; +- 8) if the incoming SIP 200 (OK) response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 9) shall include the public service identity received in the P-Asserted-Identity header field of the incoming SIP 200 (OK) response into the P-Asserted-Identity header field of the outgoing SIP 200 (OK) response; and +- 10) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.2.1.4 +- 11) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]; and +- 12) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the SIP INVITE request in step 16) the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +#### 9.2.3.3.4 Terminating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for standalone SDS over media plane for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the participating MCData function shall reject the request with a SIP 403 (Forbidden) response with + +the warning text set to "104 isfocus not assigned" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; + +- 3) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCData ID and public user identity of the terminating MCData user; +- 4) if the binding between the MCData ID and public user identity of the terminating MCData user does not exist, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response, and shall not continue with the rest of the steps; +- 4A) if the element exists in the MCData user profile document with one or more elements (see the MCData user profile document in 3GPP TS 24.484 [12]) and: + +- i) if the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request does not match with the element of any of the elements in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]); and +- ii) if configuration is not set in the MCData user profile document that allows the MCData user to receive one-to-one MCData communication from any user (see element in MCData user profile document in 3GPP TS 24.484 [12]); + +then: + +- i) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response including warning text set to "230 one-to-one MCData communication not authorised from this originating user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 5) shall generate a SIP INVITE request accordance with 3GPP TS 24.229 [5]; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) shall include the option tag "timer" in the Supported header field; +- 8) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; + - c) the isfocus media feature tag; + - d) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the incoming SIP INVITE request; and + - e) any other uri-parameter provided in the Contact header field of the incoming SIP INVITE request; +- 9) shall include in the SIP INVITE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [8] that were received (if any) in the incoming SIP INVITE request; +- 10) shall set the Request-URI of the outgoing SIP INVITE request to the public user identity associated to the MCData ID of the terminating MCData user; +- 11) shall populate the outgoing SIP INVITE request with the MIME bodies that were present in the incoming SIP INVITE request; +- 12) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP INVITE request to the P-Asserted-Identity header field of the outgoing SIP INVITE request; + +- 13) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received "SIP INVITE request for standalone SDS over media plane for terminating participating MCData function" as specified in subclause 9.2.3.3.1; and +- 14) shall send the SIP INVITE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include in the SIP 200 (OK) response an SDP answer based on the SDP answer in the received SIP 200 (OK) response as specified in subclause 9.2.3.3.2; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If no "refresher" parameter was included in the SIP INVITE request, the "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and + - c) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP INVITE request from the controlling MCData function; +- 6) if the incoming SIP response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 7) shall copy the P-Asserted-Identity header field from the incoming SIP 200 (OK) response to the outgoing SIP 200 (OK) response; +- 8) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.2.1.5; and +- 10) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +### 9.2.3.4 Controlling MCData function procedures + +#### 9.2.3.4.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 4975 [17], IETF RFC 6135 [19] and IETF RFC 6714 [20] the controlling MCData function: + +- 1) shall include an "m=message" media-level section for the MCData media stream received from the originating MCData client consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS; + - c) a format list field set to "\*"; + - d) an "a=sendonly" attribute; + +- e) an "a=path" attribute containing its own MSRP URI; +- f) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload"; and +- g) set the a=setup attribute as "actpass". + +#### 9.2.3.4.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the controlling MCData function: + +- 1) shall include an "m=message" media-level section for the accepted MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS according to the received SDP offer; + - c) a format list field set to '\*'; + - d) an "a=recvonly" attribute; + - e) an "a=path" attribute containing its own MSRP URI; + - f) set the content type as a=accept-types: application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload; and + - g) set the a=setup attribute set to "passive" according to IETF RFC 6135 [19]. + +#### 9.2.3.4.3 Originating controlling MCData function procedures + +This subclause describes the procedures for inviting an MCData user to an MCData session. The procedure is initiated by the controlling MCData function as the result of an action in subclause 9.2.3.4.4. + +The controlling MCData function: + +- 1) shall generate a SIP INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include the Supported header field set to "timer"; +- 3) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38]. The refresher parameter shall be omitted; +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 5) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 6) shall include a Referred-By header field with the public user identity of the inviting MCData client; +- 7) shall include in the Contact header field an MCData session identity for the MCData session with the g.3gpp.mcdata.sds media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" according to IETF RFC 3840 [16]; +- 8) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the MCData ID of the terminating user; and + - b) the element set to the group identity; +- 9) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; + +NOTE 1: How the controlling MCData function finds the address of the terminating participating MCData function is out of the scope of the current release. + +- 10) shall set the P-Asserted-Identity header field to the public service identity of the controlling MCData function; +- 11) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 12) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating client according to the procedures specified in subclause 9.2.3.4.1; and +- 13) shall send the SIP INVITE request towards the terminating client in accordance with 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the controlling MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.1. + +NOTE 2: The procedures executed by the controlling MCData function prior to sending a response to the inviting MCData client are specified in subclause 9.2.3.4.4. + +#### 9.2.3.4.4 Terminating controlling MCData function procedures + +In the procedures in this subclause: + +- 1) MCData ID in an incoming SIP INVITE request refers to the MCData ID of the originating user from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; and +- 3) MCData ID in an outgoing SIP INVITE request refers to the MCData ID of the called user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; + +Upon receipt of a "SIP INVITE request for controlling MCData function for standalone SDS over media plane", the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine if the media parameters are acceptable and the MSRP URI is offered in the SDP offer and if not reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 3) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcdata.sds media feature tag; or + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; +- 4) shall cache SIP feature tags, if received in the Contact header field and if the specific feature tags are supported; +- 5) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; +- 6) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "one-to-one-sds" and the SIP INVITE request: + - a) does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall return a SIP 403 (Forbidden) response with the warning text set to "204 unable to determine targeted user for one-to-one SDS" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + - b) contains an application/resource-lists MIME body with exactly one element, shall invite the MCData user identified by the element of the MIME body, as specified in subclause 9.2.3.4.3; and + +- c) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.1; +- 7) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "group-sds": +- a) shall retrieve the necessary group document(s) from the group management server for the group identity contained in the SIP INVITE request and carry out initial processing as specified in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + - b) if the element is present in the group document, shall send a SIP 403 (Forbidden) response with the warning text set to "115 group is disabled" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - c) if the element of the element of the element in the group document does not contain an element with a "uri" attribute matching the MCData ID of the originating user contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP INVITE request, shall send a SIP 403 (Forbidden) response with the warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - d) if the element contains a element in the group document set to a value of "false", shall send a SIP 403 (Forbidden) response with the warning text set to "206 short data service not allowed for this group" in a Warning header field as specified in subclause 4.x and shall not continue with the rest of the steps; + - e) if the element is not present in the group document or is present and contains a element containing an "enabler" attribute which is not set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", shall send a SIP 488 (Not Acceptable) response with the warning text set to "207 SDS services not supported for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - f) if the MCData server group SDS procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to send group MCData communications on this group identity as determined by step 2) of subclause 11.1, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response, with warning text set to "201 user not authorised to transmit data on this group identity" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - g) the originating user identified by the MCData ID is not affiliated to the group identity contained in the SIP INVITE request, as specified in subclause 6.3.5, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; + - h) shall determine targeted group members for MCData communications by following the procedures in subclause 6.3.4; + - i) if the procedures in subclause 6.3.4 result in no affiliated members found in the selected MCData group, shall return a SIP 403 (Forbidden) response with the warning text set to "198 no users are affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + - j) shall invite each group member determined in step h) above, to the group session, as specified in subclause 9.2.3.4.3; and + - k) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.1. + +Upon receiving a SIP 200 (OK) response for a SIP INVITE request as specified in subclause 9.2.3.4.3 and if the MCData ID in the SIP 200 (OK) response matches to the MCData ID in the corresponding SIP INVITE request, the controlling MCData function: + +- 1) shall generate SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include the option tag "timer" in a Require header field; +- 3) shall include the Session-Expires header field and start supervising the SIP session according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". The "refresher" parameter in the Session-Expires header field shall be set to "uac"; + +- 4) shall include a P-Asserted-Identity header field with the public service identity of the controlling MCData function; +- 5) shall include a SIP URI for the MCData session identity in the Contact header field identifying the MCData session at the controlling MCData function; +- 6) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and + - c) the isfocus media feature tag; +- 7) shall include Warning header field(s) received in incoming responses to the SIP INVITE request; +- 8) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the subclause 9.2.3.4.2; +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.1; and +- 10) shall send a SIP 200 (OK) response to the inviting MCData client according to 3GPP TS 24.229 [5]. + +## 9.2.4 SDS session + +### 9.2.4.1 General + +The procedures in the subclauses of the parent subclause are used by a MCData functional entity to establish: + +- a one-to-one SDS session; or +- a group SDS session. + +The procedures in the subclauses of the parent subclause are applicable to establish an on-demand SDS session. + +### 9.2.4.2 MCData client procedures + +#### 9.2.4.2.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 4975 [17], IETF RFC 6135 [19] and IETF RFC 6714 [20] the MCData client: + +- 1) shall include an "m=message" media-level section for the MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS; + - c) an "a=sendrecv" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload"; and + - f) set the a=setup attribute as "actpass"; and +- 2) if end-to-end security is required for a one-to-one communication and the security context does not exist or if the existing security context has expired, shall include the MIKEY-SAKKE I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [45]. + +#### 9.2.4.2.2 SDP answer generation + +When the MCData client receives an initial SDP offer for an MCData SDS session, the MCData client shall process the SDP offer and shall compose an SDP answer according to 3GPP TS 24.229 [5] and IETF RFC 4975 [17]. + +When composing an SDP answer, the MCData client: + +- 1) shall include an "m=message" media-level section for the accepted MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS according to the received SDP offer; + - c) an "a=sendrecv" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as a=accept-types: application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload; and + - f) set the a=setup attribute according to IETF RFC 6135 [19]. + +#### 9.2.4.2.3 MCData client originating procedures + +The MCData client shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5] with the clarifications given below. + +The MCData client: + +- 1) shall include the g.3gpp.mcdata.sds media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [16]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 5) should include the "timer" option tag in the Supported header field; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) if a one-to-one SDS session is requested: + - a) shall insert in the SIP INVITE request a MIME resource-lists body with the MCData ID of the invited MCData user, according to rules and procedures of IETF RFC 5366 [18]; + - b) shall contain an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - i) the element set to a value of "one-to-one-sds-session"; and + - ii) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP INVITE request, the element set to the URI of the used functional alias; and + +NOTE 0: The MCData client learns the functional aliases that are activated for an MCData ID from procedures specified in subclause 22.2.1.3. + +- c) if an end-to-end security context needs to be established and the security context does not exist or if the existing security context has expired, then: + +- i) if necessary, shall instruct the key management client to request keying material from the key management server as described in 3GPP TS 33.180 [26]; + - ii) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [26]; + - iii) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0001" to indicate that the purpose of the PCK is to protect one-to-one communications and with the remaining twenty eight bits being randomly generated as described in 3GPP TS 33.180 [26]; + - iv) shall encrypt the PCK to a UID associated to the MCData client using the MCData ID of the invited user and a time related parameter as described in 3GPP TS 33.180 [26]; + - v) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [26]; + - vi) shall add the MCData ID of the originating MCData to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; and + - vii) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating MCData user's signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [26]; +- 8) if a group SDS session is requested: +- a) if the "/Common/MCData/AllowedSDS" leaf node present in the group document of the requested MCData group, configured on the group management client as specified in 3GPP TS 24.483 [42] is set to "false", shall reject the request to send SDS and not continue with the rest of the steps in this subclause; and + - b) shall contain in an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - i) the element set to a value of "group-sds-session"; + - ii) the element set to the MCData group identity; and + - iii) the element set to the MCData client ID of the originating MCData client; +- NOTE 1: The MCData client does not include the MCData ID of the originating MCData user in the body, as this will be inserted into the body of the SIP INVITE request that is sent from the originating participating MCData function. +- iv) if the MCData client is aware of active functional aliases, and an active functional alias is to be included in the SIP INVITE request, the set to the URI of the used functional alias; +- 9) shall set the Request-URI of the SIP INVITE request to the public service identity identifying the participating MCData function serving the MCData user; +- NOTE 2: The MCData client is configured with public service identity identifying the participating MCData function serving the MCData user. +- 10) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; +- 11) shall include an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 9.2.4.2.1; and +- 12) shall send the SIP INVITE request towards the MCData server according to 3GPP TS 24.229 [5]. + +On receipt of a SIP 2xx response to the SIP INVITE request, the MCData client: + +- 1) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]; +- 2) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; and +- 3) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.1.2.2. + +On receipt of a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the MCData client: + +- 1) shall indicate to the MCData user that the SDS message could not be sent; and +- 2) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]. + +On receipt of an indication from the media plane indicating that the SDS message was not sent successfully, the MCData client: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5] with: + - a) Reason code set to "SIP"; + - b) cause set to "480"; and + - c) text set to "transmission failed"; +- 2) shall set the Request-URI to the MCData session identity to release; and +- 3) shall send a SIP BYE request towards MCData server according to 3GPP TS 24.229 [5]. + +#### 9.2.4.2.4 MCData client terminating procedures + +Upon receipt of an "initial SIP INVITE request for SDS session for terminating MCData client" request, the MCData client shall follow the procedures for termination of multimedia sessions in the IM CN subsystem as specified in 3GPP TS 24.229 [5] with the clarifications below. + +The MCData client: + +- 1) may reject the SIP INVITE request if either of the following conditions are met: + - a) MCData client does not have enough resources to handle the call; or + - b) any other reason outside the scope of this specification;and skip the rest of the steps after step 2; +- 2) if the SIP INVITE request is rejected in step 1), shall respond toward participating MCData function either with appropriate reject code as specified in 3GPP TS 24.229 [5] and warning texts as specified in subclause 4.9 or with SIP 480 (Temporarily unavailable) response not including warning texts if the user is authorised to restrict the reason for failure and skip the rest of the steps of this subclause; +- 3) if the SDP offer of the SIP INVITE request contains an "a=key-mgmt" attribute field with a "mikey" attribute value containing a MIKEY-SAKKE I\_MESSAGE: + - a) shall extract the MCData ID of the originating MCData user from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - b) shall convert the MCData ID to a UID as described in 3GPP TS 33.180 [26]; + - c) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - d) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP INVITE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9 and not continue with rest of the steps in this subclause; and + - e) if the signature of the MIKEY-SAKKE I\_MESSAGE was successfully validated: + - i) shall extract and decrypt the encapsulated PCK using the terminating user's (KMS provisioned) UID key as described in 3GPP TS 33.180 [26]; and + - ii) shall extract the PCK-ID, from the payload as specified in 3GPP TS 33.180 [26]; + +NOTE: With the PCK successfully shared between the originating MCData client and the terminating MCData client, both clients are able to create an end-to-end secure session. + +- 4) may display to the MCData user the MCData ID of the inviting MCData user and the type of SDS request; +- 5) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; +- 6) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 7) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [38]. The "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 8) shall include the g.3gpp.mcdata.sds media feature tag in the Contact header field of the SIP 200 (OK) response; +- 9) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" in the Contact header field of the SIP 200 (OK) response; +- 10) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [5] with the clarifications given in subclause 9.2.4.2.2; and +- 11) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of an SIP ACK message to the sent SIP 200 (OK) message, the MCData client shall: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.1.2.3. + +To send a disposition notification after the media plane is released, the MCData client: + +- 1) shall follow the procedures described in subclause 12.2.1.1. + +### 9.2.4.3 Participating MCData function procedures + +#### 9.2.4.3.1 SDP offer generation + +The SDP offer is generated based on the received SDP offer. The SDP offer generated by the participating MCData function: + +- 1) shall contain only one SDP media-level section for SDS message as contained in the received SDP offer; and +- 2) shall contain an "a=key-mgmt" attribute field with a "mikey" attribute value, if present in the received SDP offer. + +When composing the SDP offer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number for the offered media stream in the received SDP offer with the IP address and port number of the participating MCData function, if required; and + +NOTE 1: Requirements can exist for the participating MCData function to be always included in the path of the offered media stream, for example: for the support of features such as MBMS, lawful interception and recording. Other examples can exist. + +NOTE 2: If the participating MCData function and the controlling MCData function are in the same MCData server, and the participating MCData function does not have a dedicated IP address or a dedicated port number for media stream, the replacement of the IP address or the port number is omitted. + +- 2) if the IP address is replaced, shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP offer. + +#### 9.2.4.3.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number in the received SDP answer with the IP address and port number of the participating MCData function, for the accepted media stream in the received SDP offer, if required; and + +NOTE 1: Requirements can exist for the participating MCData function to be always included in the path of the offered media stream, for example: for the support of features such as MBMS, lawful interception and recording. Other examples can exist. + +NOTE 2: If the participating MCData function and the controlling MCData function are in the same MCData server, and the participating MCData function does not have a dedicated IP address or a dedicated port number for media stream, the replacement of the IP address or the port number is omitted. + +- 2) if the IP address is replaced shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP answer. + +#### 9.2.4.3.3 Originating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for SDS session for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP INVITE request, and shall authorise the calling user; + +NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is: + - a) set to a value of "group-sds-session", shall determine the public service identity of the controlling MCData function associated with the MCData group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP INVITE request; or + - b) set to a value of "one-to-one-sds-session", shall determine the public service identity of the controlling MCData function hosting the one-to-one SDS session service for the calling user; +- 5) if unable to identify the controlling MCData function for SDS session, it shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 6) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; +- 7) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID + - a) is not allowed to send MCData communications as determined by step 1) of subclause 11.1, shall reject the "SIP INVITE request for SDS session for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "221 user not authorised to initiate one-to-one SDS session" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - b) is not allowed to initiate one-to-one MCData communications to the targeted user as determined by step 1a) of subclause 11.1, shall reject the "SIP INVITE request for SDS session for originating participating MCData function" with a SIP 403 (Forbidden) response including warning text set to "229 one-to-one MCData communication not authorised to the targeted user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 8) shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5]; + +- 9) shall include the option tag "timer" in the Supported header field; +- 10) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 11) shall set the Request-URI of the outgoing SIP INVITE request to the public service identity of the controlling MCData function as determined by step 4) in this subclause; +- 12) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; +- 12A) if the incoming SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; +- 13) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; +- 14) shall set the P-Asserted-Identity in the outgoing SIP INVITE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP INVITE request; +- 15) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the MCData client as specified in subclause 9.2.4.3.1; and +- 16) shall send the SIP INVITE request as specified to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP INVITE request in step 16): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include in the SIP 200 (OK) response an SDP answer as specified in the subclause 9.2.4.3.2; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If the "refresher" parameter is not included in the received request, the "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and + - c) the isfocus media feature tag; +- 6) shall include Warning header field(s) that were received in the incoming SIP 200 (OK) response; +- 7) shall include an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP 200 (OK) response; +- 8) if the incoming SIP 200 (OK) response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 9) shall include the public service identity received in the P-Asserted-Identity header field of the incoming SIP 200 (OK) response into the P-Asserted-Identity header field of the outgoing SIP 200 (OK) response; and +- 10) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.2.2.4; +- 11) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]; and +- 12) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the SIP INVITE request in step 16) the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +#### 9.2.4.3.4 Terminating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for SDS session for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the participating MCData function shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; +- 3) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCData ID and public user identity of the terminating MCData user; +- 4) if the binding between the MCData ID and public user identity of the terminating MCData user does not exist, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response, and shall not continue with the rest of the steps; +- 4A) if the element exists in the MCData user profile document with one or more elements (see the MCData user profile document in 3GPP TS 24.484 [12]) and: + - i) if the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request does not match with the element of any of the elements in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]); and + - ii) if configuration is not set in the MCData user profile document that allows the MCData user to receive one-to-one MCData communication from any user (see element in MCData user profile document in 3GPP TS 24.484 [12]); + +then: + +- i) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response including warning text set to "230 one-to-one MCData communication not authorised from this originating user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 5) shall generate a SIP INVITE request accordance with 3GPP TS 24.229 [5]; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) shall include the option tag "timer" in the Supported header field; +- 8) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; + - c) the isfocus media feature tag; + +- d) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the incoming SIP INVITE request; and + - e) any other uri-parameter provided in the Contact header field of the incoming SIP INVITE request; +- 9) shall include in the SIP INVITE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [8] that were received (if any) in the incoming SIP INVITE request; + - 10) shall set the Request-URI of the outgoing SIP INVITE request to the public user identity associated to the MCData ID of the terminating MCData user; + - 11) shall populate the outgoing SIP INVITE request with the MIME bodies that were present in the incoming SIP INVITE request; + - 12) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP INVITE request to the P-Asserted-Identity header field of the outgoing SIP INVITE request; + - 13) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received "SIP INVITE request for SDS session for terminating participating MCData function" as specified in subclause 9.2.4.3.1; and + - 14) shall send the SIP INVITE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include in the SIP 200 (OK) response an SDP answer based on the SDP answer in the received SIP 200 (OK) response as specified in subclause 9.2.4.3.2; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If no "refresher" parameter was included in the SIP INVITE request, the "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and + - c) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP INVITE request from the controlling MCData function; +- 6) if the incoming SIP response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 7) shall copy the P-Asserted-Identity header field from the incoming SIP 200 (OK) response to the outgoing SIP 200 (OK) response; +- 8) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]. +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.2.2.5; and +- 10) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +#### 9.2.4.4 Controlling MCData function procedures + +##### 9.2.4.4.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 4975 [17], IETF RFC 6135 [19] and IETF RFC 6714 [20] the controlling MCData function: + +- 1) shall include an "m=message" media-level section for the MCData media stream received from the originating MCData client consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS; + - c) an "a=sendrecv" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload"; and + - f) set the a=setup attribute as "actpass". + +##### 9.2.4.4.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the controlling MCData function: + +- 1) shall include an "m=message" media-level section for the accepted MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS according to the received SDP offer; + - c) an "a=sendrecv" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as a=accept-types: application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload; and + - f) set the a=setup attribute set to "passive" according to IETF RFC 6135 [19]. + +##### 9.2.4.4.3 Originating controlling MCData function procedures + +This subclause describes the procedures for inviting an MCData user to an MCData session. The procedure is initiated by the controlling MCData function as the result of: + +- an action in subclause 9.2.4.4.4; or +- for group SDS session, when an MCData client successfully affiliates the MCData group after the SDS session has been established. + +The controlling MCData function: + +- 1) shall generate a SIP INVITE according to 3GPP TS 24.229 [5]; +- 2) shall include the Supported header field set to "timer"; +- 3) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38]. The refresher parameter shall be omitted; +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 5) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; + +- 6) shall include a Referred-By header field with the public user identity of the inviting MCData client; + - 7) shall include in the Contact header field an MCData session identity for the MCData session with the g.3gpp.mcdata.sds media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" according to IETF RFC 3840 [16]; + - 8) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the MCData ID of the terminating user; and + - b) the element set to the group identity if the request is for group sds; + - 9) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; +- NOTE 1: How the controlling MCData function finds the address of the terminating participating MCData function is out of the scope of the current release. +- 10) shall set the P-Asserted-Identity header field to the public service identity of the controlling MCData function; + - 11) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; + - 12) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating client according to the procedures specified in subclause 9.2.4.4.1; and + - 13) shall send the SIP INVITE request towards the terminating client in accordance with 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the controlling MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.2. + +NOTE 2: The procedures executed by the controlling MCData function prior to sending a response to the inviting MCData client are specified in subclause 9.2.4.4.4. + +#### 9.2.4.4.4 Terminating controlling MCData function procedures + +In the procedures in this subclause: + +- 1) MCData ID in an incoming SIP INVITE request refers to the MCData ID of the originating user from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; and +- 3) MCData ID in an outgoing SIP INVITE request refers to the MCData ID of the called user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; + +Upon receipt of a "SIP INVITE request for controlling MCData function for SDS session", the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine if the media parameters are acceptable and the MSRP URI is offered in the SDP offer and if not reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 3) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcdata.sds media feature tag; or + +- b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; +- 4) shall cache SIP feature tags, if received in the Contact header field and if the specific feature tags are supported; + - 6) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; + - 7) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "one-to-one-sds-session" and the SIP INVITE request: + - a) does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall return a SIP 403 (Forbidden) response with the warning text set to "204 unable to determine targeted user for one-to-one SDS" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; + - b) contains an application/resource-lists MIME body with exactly one element, shall invite the MCData user identified by the element of the MIME body, as specified in subclause 9.2.4.4.3; and + - c) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.2; + - 8) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "group-sds-session": + - a) shall retrieve the necessary group document(s) from the group management server for the group identity contained in the SIP INVITE request and carry out initial processing as specified in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + - b) if the element is present in the group document, shall send a SIP 403 (Forbidden) response with the warning text set to "115 group is disabled" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - c) if the element of the element of the element in the group document does not contain an element with a "uri" attribute matching the MCData ID of the originating user contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP INVITE request, shall send a SIP 403 (Forbidden) response with the warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - d) if the element contains a element in the group document set to a value of "false", shall send a SIP 403 (Forbidden) response with the warning text set to "206 short data service not allowed for this group" in a Warning header field as specified in subclause 4.x and shall not continue with the rest of the steps; + - e) if the element is not present in the group document or is present and contains a element containing an "enabler" attribute which is not set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds", shall send a SIP 488 (Not Acceptable) response with the warning text set to "207 SDS services not supported for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - f) if the MCData server group SDS procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to send group MCData communications on this group identity as determined by step 2) of subclause 11.1, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response, with warning text set to "222 user not authorised to initiate group SDS session on this group identity" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - g) if the originating user identified by the MCData ID is not affiliated to the group identity contained in the SIP INVITE request, as specified in subclause 6.3.5, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; + - h) shall determine targeted group members for MCData communications by following the procedures in subclause 6.3.4; + +- i) if the procedures in subclause 6.3.4 result in no affiliated members found in the selected MCData group, shall return a SIP 403 (Forbidden) response with the warning text set to "198 no users are affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and +- j) shall invite each group member determined in step g) above, to the group session, as specified in subclause 9.2.4.4.3; and +- k) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.2. + +Upon receiving a SIP 200 (OK) response for a SIP INVITE request as specified in subclause 9.2.4.4.3 and if the MCData ID in the SIP 200 (OK) response matches to the MCData ID in the corresponding SIP INVITE request the controlling MCData function: + +- 1) shall generate SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include the option tag "timer" in a Require header field; +- 3) shall include the Session-Expires header field and start supervising the SIP session according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". The "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 4) shall include a P-Asserted-Identity header field with the public service identity of the controlling MCData function; +- 5) shall include a SIP URI for the MCData session identity in the Contact header field identifying the MCData session at the controlling MCData function; +- 6) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; and + - c) the isfocus media feature tag; +- 7) shall include Warning header field(s) received in incoming responses to the SIP INVITE request; +- 8) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the subclause 9.2.4.4.2; +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 6.3.2; and +- 10) shall send a SIP 200 (OK) response to the inviting MCData client according to 3GPP TS 24.229 [5]. + +## 9.2.5 SDS communication using pre-established session + +### 9.2.5.1 Common procedure + +#### 9.2.5.1.1 Generating an INVITE request on receipt of a REFER request + +This subclause is referenced from other procedures. + +When generating an initial SIP INVITE request according to 3GPP TS 24.229 [5], on receipt of an incoming SIP REFER request, the participating MCData function: + +- 1) shall include in the SIP INVITE request all header fields included in the headers portion of the SIP URI contained in the element of the application/resource-lists MIME body, referenced by the "cid" URL in the Refer-To header field in the incoming SIP REFER request; +- 2) should include the Session-Expires header field according to IETF RFC 4028 [38]. +- 3) shall include the option tag "timer" in the Supported header field; +- 4) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP REFER request to the P-Asserted-Identity header field of the outgoing SIP INVITE request; + +- 5) shall include the g.3gpp.mcdata.sds media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" into the Contact header field of the outgoing SIP INVITE request; +- 6) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; and +- 7) shall include in the SIP INVITE request the option tag "tdialog" in a Supported header field according to the rules and procedures of IETF RFC 4538 [54]; +- 8) shall include in the SIP INVITE request an SDP offer as specified in subclause 9.2.3.3.1 based upon: + - a) the SDP negotiated during the pre-established session establishment and any subsequent pre-established session modification; and + - b) the SDP offer (if any) included in the "body" URI parameter of the SIP URI contained in the element of the application/resource-lists MIME body, referenced by the "cid" URL in the Refer-To header field in the incoming SIP REFER request for a pre-established session; +- 9) shall copy the application/vnd.3gpp.mcdata-info+xml MIME body from the "body" URI parameter of the SIP URI in the application/resource-lists MIME body, referenced by the "cid" URL in the Refer-To header field of the SIP REFER request, to the outgoing SIP INVITE request; +- 9A) if the incoming SIP REFER request contained a element in an application/vnd.3gpp.mcdata-info+xml MIME body in the hname "body" parameter in the headers portion of the SIP URI in the Refer-To header field, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; and +- 10) if the incoming SIP REFER request contained an application/resource-lists MIME body in the "body" URI parameter of the SIP URI contained in the element of an application/resource-lists MIME body, referenced by the "cid" URL in the Refer-To header field, shall copy the application/resources-lists MIME body in the "body" URI parameter to the SIP INVITE request. + +#### 9.2.5.1.2 Generating Re-INVITE request towards originating MCData client within pre-established session + +This subclause is referenced from other procedures. + +The participating MCData function: + +- 1) shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [5] to be sent within the SIP dialog of the pre-established session; +- 2) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing Re-INVITE request: + - a) the element with a value set to "establish-success", if a SIP 2xx response is received to a SIP INVITE request sent to the controlling MCData function; or + - b) the element with a value set to "establish-fail", if an error response is received to a SIP INVITE request sent to the controlling MCData function; + +#### 9.2.5.1.3 Generating Re-INVITE request towards terminating MCData client within pre-established session + +This subclause is referenced from other procedures. + +The participating MCData function: + +- 1) shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [5] to be sent within the SIP dialog of the pre-established session; +- 2) should include the Session-Expires header field according to IETF RFC 4028 [38]. +- 3) shall include the option tag "timer" in the Supported header field; + +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 5) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 6) shall include in the Contact header field an MCData session identity for the MCData session with the g.3gpp.mcdata.sds media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" according to IETF RFC 3840 [16]; + +### 9.2.5.2 Initiating one-to-one SDS communication + +The procedures in this subclause are used to initiate one-to-one standalone SDS using media plane or one-to-one SDS session within the pre-established session. + +#### 9.2.5.2.1 MCData client procedures + +##### 9.2.5.2.1.1 Client originating procedures + +Upon receiving a request from an MCData user to initiate one-to-one standalone SDS using media plane or one-to-one SDS session within the pre-established session, the MCData client shall generate a SIP REFER request outside a dialog as specified in IETF RFC 3515 [51] as updated by IETF RFC 6665 [36] and IETF RFC 7647 [52], and in accordance with the UE procedures specified in 3GPP TS 24.229 [5], with the clarifications given below. + +The MCData client: + +- 1) shall set the Request URI of the SIP REFER request to the session identity of the pre-established session; +- 2) shall set the Refer-To header field of the SIP REFER request as specified in IETF RFC 3515 [51] with a Content-ID ("cid") Uniform Resource Locator (URL) as specified in IETF RFC 2392 [33] that points to an application/resource-lists MIME body as specified in IETF RFC 5366 [18], and with the Content-ID header field set to this "cid" URL; +- 3) if an end-to-end security context needs to be established and the security context does not exist or if the existing security context has expired, then: + - i) if necessary, shall instruct the key management client to request keying material from the key management server as described in 3GPP TS 33.180 [26]; + - ii) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [26]; + - iii) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0001" to indicate that the purpose of the PCK is to protect one-to-one communications and with the remaining twenty eight bits being randomly generated as described in 3GPP TS 33.180 [26]; + - iv) shall encrypt the PCK to a UID associated to the MCData client using the MCData ID of the invited user and a time related parameter as described in 3GPP TS 33.180 [26]; + - v) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [26]; + - vi) shall add the MCData ID of the originating MCData to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; and + - vii) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating MCData user's signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [26]; +- 4) shall include in the application/resource-lists MIME body a single element containing a "uri" attribute set to MCData ID of the called user, extended with the following parameters in the headers portion of the SIP URI: + +NOTE: Characters that are not formatted as ASCII characters are escaped in the following parameters in the headers portion of the SIP URI. + +- a) an hname "body" parameter populated with: + - i) an application/sdp MIME body containing an SDP offer with media attributes specified in subclause 9.2.3.2.1, if if a one-to-one standalone SDS message is requested; + - ii) an application/vnd.3gpp.mcdata-info MIME body with: + - A) if a one-to-one standalone SDS message is requested, the element set to a value of "one-to-one-sds". If a one-to-one SDS session is requested, the element set to a value of "one-to-one-sds-session"; + - B) the element set to the MCData client ID of the originating MCData client; and + - C) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP REFER request, the element set to the URI of the used functional alias; +- 5) shall include a P-Preferred-Service header field set to the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), according to IETF RFC 6050 [7]; +- 6) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; +- 7) shall include the following according to IETF RFC 4488 [53]: + - a) the option tag "norefersub" in the Supported header field; and + - b) the value "false" in the Refer-Sub header field; +- 8) shall include a Target-Dialog header field as specified in IETF RFC 4538 [54] identifying the pre-established session; +- 9) shall include the g.3gpp.mcdata.sds media feature tag in the Contact header field of the SIP REFER request according to IETF RFC 3840 [16]; and +- 10) shall send the SIP REFER request according to 3GPP TS 24.229 [5]. + +On receiving a final SIP 2xx response to the SIP REFER request, the MCData client: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +On receiving a SIP re-INVITE request within the pre-established session targeted by the sent SIP REFER request, the MCData client: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "establish-success": + - i) shall notify MCData user about successful the MCData communication establishment; +- 2) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "establish-fail": + - i) shall notify MCData user about the MCData communication establishment failure; and +- 3) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +#### 9.2.5.2.1.2 Client terminating procedures + +Upon receiving a SIP re-INVITE request within a pre-established Session without an associated MCData session, the MCData client: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "establish-request": + - i) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "one-to-one-sds", shall follow the procedures in subclause 9.2.3.2.4; and + +- ii) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "one-to-one-sds-session", shall follow the procedures in subclause 9.2.4.2.4. + +## 9.2.5.2.2 Participating MCData function procedures + +### 9.2.5.2.2.1 Originating procedures + +Upon receiving a SIP REFER request, with: + +- 1) the Request-URI set to a public service identity identifying the pre-established session on the participating MCData function; +- 2) the Refer-To header field containing a Content-ID ("cid") URL as specified in IETF RFC 2392 [33] that points to an application/resource-lists MIME body as specified in IETF RFC 5366 [18] containing one or more element(s) with a "uri" attribute containing a SIP URI set to the MCData ID of the called user(s); +- 3) an hname "body" parameter in the headers portion of the SIP URI specified above containing an application/vnd.3gpp.mcdata-info MIME body with the element set to "one-to-one-sds" or "one-to-one-sds-session"; and +- 4) a Content-ID header field set to the "cid" URL; + +the participating function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [24] and skip the rest of the steps; +- 2) shall determine the MCData ID of the calling user from public user identity in the P-Asserted-Identity header field of the SIP REFER request; +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP REFER request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; +- 4) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; + - i) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to initiate MCData communications, shall reject the SIP REFER request with a SIP 403 (Forbidden) response with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; +- 5) if the received SIP REFER request does not contain an application/resource-lists MIME body referenced by a "cid" URL in the Refer-To header field, shall reject the SIP REFER request with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; +- 6) if the received SIP REFER request contains an application/resource-lists MIME body referenced by a "cid" URL in the Refer-To header field with more than one element each with an application/vnd.3gpp.mcdata-info MIME body with the element set to "one-to-one-sds" or "one-to-one-sds-session", determine that the communication type is one-to-one standalone SDS or one-to-one SDS session; +- 7) shall determine the public service identity of the controlling MCData function associated with the originating user's MCData ID; + - i) if the participating MCData function is unable to identify the controlling MCData function, it shall reject the REFER request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; +- 8) if the SIP REFER request contained a Refer-Sub header field containing "false" value and a Supported header field containing "norefersub" value, shall handle the SIP REFER request as specified in 3GPP TS 24.229 [5], + +IETF RFC 3515 [51] as updated by IETF RFC 6665 [36], and IETF RFC 4488 [53] without establishing an implicit subscription; + +- 9) shall generate a final SIP 200 (OK) response to the SIP REFER request according to 3GPP TS 24.229 [5]; + +NOTE: In accordance with IETF RFC 4488 [53], the participating MCData function inserts the Refer-Sub header field containing the value "false" in the SIP 200 (OK) response to the SIP REFER request to indicate that it has not created an implicit subscription. + +- 10) shall send the response to the SIP REFER request towards the MCData client according to 3GPP TS 24.229 [5]; + +- 11) shall generate SIP INVITE request as described in subclause 9.2.5.1.1; + +- 12) shall set the Request-URI of the SIP INVITE request to the public service identity of the controlling MCData function serving the calling MCData user as determined above in step 7); and + +- 13) shall forward the SIP INVITE request according to 3GPP TS 24.229 [4]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the participating MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; +- 2) shall generate a SIP re-INVITE request as specified in subclause 9.2.5.1.2 with following clarifications: + - i) shall set the Request-URI to a public service identity identifying the pre-established session; +- 3) shall send the SIP re-INVITE request towards the originating MCData client according to 3GPP TS 24.229 [5]; and +- 4) upon receipt of a SIP 2xx response to the SIP re-INVITE, shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +#### 9.2.5.2.2.2 Terminating procedures + +Upon receipt of a "SIP INVITE request for standalone SDS over media plane for terminating participating MCData function" or "SIP INVITE request for SDS session for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the "SIP INVITE request for terminating participating MCData function" with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4], and skip the rest of the steps; +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCData ID and public user identity; + - i) if the binding between the MCData ID and public user identity does not exist, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response, and skip the rest of the steps; +- 3) shall generate a SIP re-INVITE request as specified in subclause 9.2.5.1.3 with following clarifications: + - i) shall set the Request-URI to a public service identity identifying the pre-established session; + - ii) if the incoming SIP INVITE request contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP INVITE request with following clarification: + - a) shall include element with a value set to "establish-request"; and + - iii) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; + +- c) the isfocus media feature tag; + - d) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the incoming SIP INVITE request; and + - e) any other uri-parameter provided in the Contact header field of the incoming SIP INVITE request; +- 4) shall send the SIP re-INVITE request towards the terminating MCData client according to 3GPP TS 24.229 [5]; and + - 5) upon receipt of a SIP 2xx response to the SIP re-INVITE, shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +### 9.2.5.3 Initiating group SDS communication + +The procedures in this subclause are used to initiate group standalone SDS using media plane or group SDS session within the pre-established session. + +#### 9.2.5.3.1 MCData client procedures + +##### 9.2.5.3.1.1 Client originating procedures + +Upon receiving a request from an MCData user to initiate group SDS session within the pre-established session, the MCData client shall generate a SIP REFER request outside a dialog as specified in IETF RFC 3515 [51] as updated by IETF RFC 6665 [36] and IETF RFC 7647 [52], and in accordance with the UE procedures specified in 3GPP TS 24.229 [5], with the clarifications given below. + +The MCData client: + +- 1) shall set the Request URI of the SIP REFER request to the session identity of the pre-established session; +- 2) shall set the Refer-To header field of the SIP REFER request as specified in IETF RFC 3515 [51] with a Content-ID ("cid") Uniform Resource Locator (URL) as specified in IETF RFC 2392 [33] that points to an application/resource-lists MIME body as specified in IETF RFC 5366 [18], and with the Content-ID header field set to this "cid" URL; +- 3) shall include in the application/resource-lists MIME body a single element containing a "uri" attribute set to the MCData group identity, extended with the following parameters in the headers portion of the SIP URI: + +NOTE: Characters that are not formatted as ASCII characters are escaped in the following parameters in the headers portion of the SIP URI. + +- a) an hname "body" parameter populated with: + - i) an application/sdp MIME body containing an SDP offer with media attributes specified in subclause 9.2.3.2.1, if a group standalone SDS message is requested; + - ii) an application/vnd.3gpp.mcdata-info MIME body with: + - A) if a group standalone SDS message is requested, the element set to a value of "group-sds". If a group SDS session is requested, the element set to a value of "group-sds-session"; + - B) the element set to the MCData group identity; + - C) the element set to the MCData client ID of the originating MCData client; and + - D) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP REFER request, the element set to the URI of the used functional alias; +- 4) shall include a P-Preferred-Service header field set to the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), according to IETF RFC 6050 [7]; +- 5) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; + +- 6) shall include the following according to IETF RFC 4488 [53]: + - a) the option tag "norefersub" in the Supported header field; and + - b) the value "false" in the Refer-Sub header field; +- 7) shall include a Target-Dialog header field as specified in IETF RFC 4538 [54] identifying the pre-established session; +- 8) shall include the g.3gpp.mcdata.sds media feature tag in the Contact header field of the SIP REFER request according to IETF RFC 3840 [16]; and +- 9) shall send the SIP REFER request according to 3GPP TS 24.229 [5]. + +On receiving a final SIP 2xx response to the SIP REFER request, the MCData client: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +On receiving a SIP re-INVITE request within the pre-established session targeted by the sent SIP REFER request, the MCData client: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "establish-success": + - i) shall notify MCData user about successful the MCData communication establishment; +- 2) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "establish-fail": + - i) shall notify MCData user about the MCData communication establishment failure; and +- 3) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +#### 9.2.5.3.1.2 Client terminating procedures + +Upon receiving a SIP re-INVITE request within a pre-established Session without an associated MCData session the MCData client: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "establish-request": + - i) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "group-sds", shall follow the procedures in subclause 9.2.3.2.4; + - ii) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "group-sds-session", shall follow the procedures in subclause 9.2.4.2.4; + +#### 9.2.5.3.2 Participating MCData function procedures + +##### 9.2.5.3.2.1 Originating procedures + +Upon receiving a SIP REFER request, with: + +- 1) the Request-URI set to a public service identity identifying the pre-established session on the participating MCData function; +- 2) the Refer-To header field containing a Content-ID ("cid") Uniform Resource Locator (URL) as specified in IETF RFC 2392 [33] that points to an application/resource-lists MIME body as specified in IETF RFC 5366 [18] containing one or more element(s) with a "uri" attribute containing a SIP URI set to the MCData group identity; +- 3) an hname "body" parameter in the headers portion of the SIP URI specified above containing an application/vnd.3gpp.mcdata-info MIME body with the element set to "group-sds" or "group-sds-session"; and +- 4) a Content-ID header field set to the "cid" URL; + +the participating function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [24] and skip the rest of the steps; + - 2) shall determine the MCData ID of the calling user from public user identity in the P-Asserted-Identity header field of the SIP REFER request; + - 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP REFER request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; + - 4) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; + - i) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to initiate MCData communications, shall reject the SIP REFER request with a SIP 403 (Forbidden) response with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - 5) if the received SIP REFER request does not contain an application/resource-lists MIME body referenced by a "cid" URL in the Refer-To header field, shall reject the SIP REFER request with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; + - 6) if the received SIP REFER request contains an application/resource-lists MIME body referenced by a "cid" URL in the Refer-To header field with more than one element each with an application/vnd.3gpp.mcdata-info MIME body with the element set to "group-sds", determine that the communication type is group SDS session; + - 7) shall determine the public service identity of the controlling MCData function associated with the originating user's MCData ID; + - i) if the participating MCData function is unable to identify the controlling MCData function, it shall reject the REFER request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; + - 8) if the SIP REFER request contained a Refer-Sub header field containing "false" value and a Supported header field containing "norefersub" value, shall handle the SIP REFER request as specified in 3GPP TS 24.229 [5], IETF RFC 3515 [51] as updated by IETF RFC 6665 [36], and IETF RFC 4488 [53] without establishing an implicit subscription; + - 9) shall generate a final SIP 200 (OK) response to the SIP REFER request according to 3GPP TS 24.229 [5]; +- NOTE: In accordance with IETF RFC 4488 [53], the participating MCData function inserts the Refer-Sub header field containing the value "false" in the SIP 200 (OK) response to the SIP REFER request to indicate that it has not created an implicit subscription. +- 10) shall send the response to the SIP REFER request towards the MCData client according to 3GPP TS 24.229 [5]; + - 11) shall generate SIP INVITE request as described in subclause 9.2.5.1.1; + - 12) shall set the Request-URI of the SIP INVITE request to the public service identity of the controlling MCData function servicing for the calling MCData user as determined above in step 7); and + - 13) shall forward the SIP INVITE request according to 3GPP TS 24.229 [4]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the participating MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; +- 2) shall generate a SIP re-INVITE request as specified in subclause 9.2.5.1.2 with following clarifications: + +- i) shall set the Request-URI to a public service identity identifying the pre-established session; +- 3) shall send the SIP re-INVITE request towards the originating MCData client according to 3GPP TS 24.229 [5]; and +- 4) upon receipt of a SIP 2xx response to the SIP re-INVITE, shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +#### 9.2.5.3.2.2 Terminating procedures + +Upon receipt of a "SIP INVITE request for standalone SDS over media plane for terminating participating MCData function" or "SIP INVITE request for SDS session for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the "SIP INVITE request for terminating participating MCData function" with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4], and skip the rest of the steps; +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCData ID and public user identity; + - i) if the binding between the MCData ID and public user identity does not exist, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response, and skip the rest of the steps; +- 3) shall generate a SIP re-INVITE request as specified in subclause 9.2.5.1.3 with following clarifications: + - i) shall set the Request-URI to a public service identity identifying the pre-established session; + - ii) if the incoming SIP INVITE request contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP INVITE request with following clarification: + - a) shall include element with a value set to "establish-request"; and + - iii) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.sds media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; + - c) the isfocus media feature tag; + - d) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the incoming SIP INVITE request; and + - e) any other uri-parameter provided in the Contact header field of the incoming SIP INVITE request; +- 4) shall send the SIP re-INVITE request towards the terminating MCData client according to 3GPP TS 24.229 [5]; and +- 5) upon receipt of a SIP 2xx response to the SIP re-INVITE, shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +#### 9.2.5.4 Leaving SDS communication + +##### 9.2.5.4.1 MCData client procedures + +###### 9.2.5.4.1.1 Client originating procedures + +Upon receiving a request from an MCData user to leave an MCData session within a pre-established session, the MCData client: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; + +- 2) shall generate an initial SIP REFER request outside a dialog in accordance with the procedures specified in 3GPP TS 24.229 [5], IETF RFC 4488 [53] and IETF RFC 3515 [51] as updated by IETF RFC 6665 [36] and IETF RFC 7647 [r7647]; +- 3) shall set the Request-URI of the SIP REFER request to the public service identity identifying the pre-established session on the MCData server serving the MCData user; +- 4) shall include the Refer-Sub header field with value "false" according to rules and procedures of IETF RFC 4488 [53]; +- 5) shall include the Supported header field with value "norefersub" according to rules and procedures of IETF RFC 4488 [53]; +- 6) shall set the Refer-To header field of the SIP REFER request to the MCData session identity to leave; +- 7) shall include the "method" SIP URI parameter with the value "BYE" in the URI in the Refer-To header field; +- 8) shall include a Target-Dialog header field as specified in IETF RFC 4538 [54] identifying the pre-established session; and +- 9) shall send the SIP REFER request according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 2xx response to the SIP REFER request, the MCData client shall interact with media plane as specified in 3GPP TS 24.582 [15]. + +On receiving a SIP re-INVITE request within the pre-established session targeted by the sent SIP REFER request, the MCData client: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "terminated": + - i) shall notify MCData user about successful the MCData communication termination. + +#### 9.2.5.4.1.2 Client terminating procedures + +Upon receiving a SIP re-INVITE request within a pre-established Session without an associated MCData session, the MCData client: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "terminate-request": + - i) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and + - ii) shall release all media plane resources corresponding to the MCData communication being released. + +#### 9.2.5.4.2 Participating MCData function procedures + +##### 9.2.5.4.2.1 Originating procedures + +Upon receiving a SIP REFER request with the "method" SIP URI parameter set to value "BYE" in the URI in the Refer-To header field from the MCData client, the participating MCData function: + +- 1) shall determine the MCData ID of the calling user from public user identity in the P-Asserted-Identity header field of the SIP REFER request; +- 2) if the participating MCData function cannot find a binding between the public user identity, then the participating MCData function shall reject the SIP REFER request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps; +- 3) if the SIP REFER request contained a Refer-Sub header field containing "false" value and a Supported header field containing "norefersub" value, shall handle the SIP REFER request as specified in 3GPP TS 24.229 [5], IETF RFC 3515 [53] as updated by IETF RFC 6665 [36], and IETF RFC 4488 [53] without establishing an implicit subscription; +- 4) shall generate a SIP 200 (OK) response to the SIP REFER request, and in the SIP 200 (OK) response: + +- a) shall include the Supported header field with value "norefersub" according to rules and procedures of IETF RFC 4488 [53]; and + - b) shall check the presence of the Refer-Sub header field of the SIP REFER request and if it is present and set to the value "false" shall include the Refer-Sub header field with value "false" according to rules and procedures of IETF RFC 4488 [53]; +- 5) shall send the SIP 200 (OK) response to the SIP REFER request towards MCData client according to 3GPP TS 24.229 [5]; + - 6) shall generate a SIP BYE request, and in the SIP BYE request: + - a) shall set the Request-URI to the MCData session identity which was included at the Refer-To header field of the received REFER request; and + - b) shall copy the contents of the P-Asserted-Identity header field of the received REFER request to the P-Asserted-Identity header field of the outgoing SIP BYE request; and + - 7) shall send the SIP BYE request toward the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the participating MCData function shall interact with the media plane as specified in 3GPP TS 24.582 [15] for releasing media plane resources associated with the SIP session with the controlling MCData function. The participating MCData function shall generate a SIP re-INVITE request as specified in subclause 9.2.5.1.2 with following clarifications and send the request towards the originating MCData client according to 3GPP TS 24.229 [5]: + +- 1) shall set the Request-URI to a public service identity identifying the pre-established session; and +- 2) shall set the element with a value of "terminated". + +#### 9.2.5.4.2.2 Terminating procedures + +Upon receiving a SIP BYE request from the controlling MCData function, the participating MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; +- 2) shall send a SIP 200 (OK) response to the controlling MCData function; +- 3) shall generate a SIP re-INVITE request as specified in subclause 9.2.5.1.2 with following clarifications: + - i) shall set the Request-URI to a public service identity identifying the pre-established session; and + - ii) shall set the element with a value of "terminate-request"; +- 4) shall send the SIP re-INVITE request towards the originating MCData client according to 3GPP TS 24.229 [5]; and +- 5) upon receipt of a SIP 2xx response to the SIP re-INVITE, shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +### 9.2.6 SDS session using MBMS delivery in the media plane + +The procedures for group SDS delivery using MBMS can be seen as extensions of group SDS delivery using unicast session via the media plane. + +Group SDS delivery using MBMS enables dynamic toggling between unicast and MBMS delivery at any time during a session, assuming the proper bearers are available. Only the terminating MCData clients and the respective associated MCData terminating participating functions become aware of and involved in the potential MBMS delivery. + +The terminating participating function can signal the start/stop/resume MBMS transmissions to the MCData client by using the media control plane Map Group To Bearer and Unmap Group To Bearer messages, described in 3GPP TS 24.582 [15]. The media control plane signaling associates the TMGI of an announced MBMS bearer with the MCData group ID of the communication and with the MBMS transmission parameters (IP address and UDP port). + +Guaranteed delivery for SDS when using MBMS can be achieved by the SDS originator through use of dispositions (i.e. "DELIVERED") and SDS NOTIFICATION mechanisms. It is up to the terminating participating function to + +decide whether or not to use MBMS for a session, and it is possible that the terminating participating function will not use MBMS delivery for SDS messages without the "DELIVERED" disposition. + +## 9.3 Off-network SDS + +### 9.3.1 General + +#### 9.3.1.1 Message transport to a MCData Client + +In order to transmit an off-network SDS message or SDS notification to an MCData user, the MCData client: + +- 1) shall send the MONP MCData message transported in a MONP MCDATA MESSAGE CARRIER message, specified in 3GPP TS 24.379 [10], as a UDP message to the local IP address of the MCData user, on UDP port 8809 (as specified in TS 24.379 [10]), with an IP time-to-live set to 255; and +- 2) shall treat UDP messages received on the port 8809 as received MONP MCDATA MESSAGE CARRIER messages. + +NOTE: An MCData client that supports IPv6 shall listen to the IPv6 addresses. + +#### 9.3.1.2 Message transport to a MCData Group + +In order to transmit an off-network SDS message, an SDS notification or any one of the emergency alert messages mentioned in subclause 16.3 to an MCData group, the MCData client: + +- 1) shall send the MONP MCData message transported in a MONP MCDATA MESSAGE CARRIER message, specified in 3GPP TS 24.379 [10], as a UDP message to the multicast IP address of the MCData group, on UDP port 8809, with an IP time-to-live set to 255; and +- 2) shall treat UDP messages received on the multicast IP address of the MCData group and on port 8809 as received MONP MCDATA MESSAGE CARRIER messages, with the IP address treated as mentioned in "/OffNetwork/MCPTTGroupParameter//IPMulticastAddress" leaf node within the group configuration specified in 3GPP TS 24.483 [42]. + +The MONP MCDATA MESSAGE CARRIER message is the entire payload of the UDP message. + +### 9.3.2 Standalone SDS using signalling control plane + +#### 9.3.2.1 General + +#### 9.3.2.2 Sending SDS message + +Upon receiving an indication to send an SDS message, the MCData client: + +- 1) if the request to send the SDS message is for a MCData group, shall check if the value of "/Common/MCData/AllowedSDS" leaf node, present in the group configuration as specified in 3GPP TS 24.483 [42], is set to "false". If the value is set to "false", shall reject the request to send the SDS message and not continue with the remaining procedures in this subclause; +- 2) if: + - a) a one-to-one SDS message is to be sent then, shall store the MCData user ID of the intended recipient as the target MCData user ID; or + - b) a group SDS message is to be sent then, shall store the MCData group ID as the target MCData group ID; +- 3) may set the stored SDS disposition request type as: + - a) "DELIVERY", if only delivery disposition is requested; + - b) "READ", if only read disposition is requested; or + - c) "DELIVERY AND READ", if both delivery and read dispositions are requested; + +- 4) if an existing conversation is indicated then, shall store the conversation identifier of the indicated conversation as SDS conversation ID. Otherwise, shall generate an UUID as described in IETF RFC 4122 [14] and store SDS conversation ID; +- 5) shall generate an UUID as described in IETF RFC 4122 [14] and store as the SDS message ID; +- 6) if indicated that the SDS message is in reply to another SDS message then, shall store the message identifier of the indicated message as SDS reply ID; +- 7) if indicated that the target recipient of the SDS message is an application then, shall store the application ID of the indicated application as the SDS application ID or as the SDS extended application ID; +- 8) shall store the received payload as the SDS payload; +- 9) shall store the received payload type as the SDS payload type; +- 10) shall store the current UTC time as the SDS transmission time; +- 11) shall generate a SDS OFF-NETWORK MESSAGE message as specified in subclause 15.1.7. In the SDS OFF-NETWORK MESSAGE message, the MCData client: + - a) shall set the Sender MCData user ID IE to its own MCData user ID; + - b) if: + - i) a one-to-one SDS message is to be sent then shall set the Recipient MCData user ID IE to the stored target MCData user ID as specified in subclause 15.2.15; or + - ii) a group SDS message is to be sent then, shall set the MCData group ID IE to the stored target MCData group ID as specified in subclause 15.2.14; + - c) may set the SDS disposition request type IE to the stored the SDS disposition request type as specified in subclause 15.2.3; + - d) shall set the Conversation ID IE to the stored conversation ID as specified in subclause 15.2.9; + - e) shall set the Message ID IE to the stored SDS message ID as specified in subclause 15.2.10; + - f) shall set the Date and time IE to the stored SDS transmission time as specified in subclause 15.2.8; + - g) may include the InReplyTo message ID IE set to the stored SDS reply ID as specified in subclause 15.2.11; + - h) may include: + - i) the Application ID IE set to the stored SDS application ID as specified in subclause 15.2.7; or + - ii) the Extended application ID IE set to the stored SDS extended application ID as specified in subclause 15.2.24; + - i) if end-to-end security is required for a one-to-one communication and the security context does not exist or if the existing security context has expired, shall include the Security parameters and Payload IE with security parameters as described in 3GPP TS 33.180 [26]; + - j) if + - i) end-to-end security is not required for a one-to-one communication, or + - ii) sending the SDS OFF-NETWORK MESSAGE message to a MCData group;may include the Payload IE as specified in subclause 15.2.13 with: + - i) the Payload content type to the stored SDS payload type; and + - ii) the Payload data set to the stored SDS payload; +- 12) if: + +- a) a one-to-one SDS message is to be sent then, shall send the SDS OFF-NETWORK MESSAGE message as specified in subclause 9.3.1.1; or + - b) a group SDS message is to be sent then, shall send the SDS OFF-NETWORK MESSAGE message as specified in subclause 9.3.1.2; +- 13) shall initialise the counter CFS1 (SDS retransmission) with the value set to 1; and +- 14) shall start timer TFS1 (SDS retransmission). + +### 9.3.2.3 Retransmitting SDS message + +Upon expiry of timer TFS1 (SDS retransmission), the MCData client: + +- 1) shall generate a SDS OFF-NETWORK MESSAGE message as specified in subclause 15.1.7. In the SDS OFF-NETWORK MESSAGE message, the MCData client: + - a) shall set the Sender MCData user ID IE to its own MCData user ID; + - b) if: + - i) a one-to-one SDS message is to be sent then, shall set the Recipient MCData user ID IE to the stored target MCData user ID; or + - ii) a group SDS message is to be sent then, shall set the MCData group ID IE to the stored target MCData group ID; + - c) may set the SDS disposition request type IE to the stored the SDS disposition request type as specified in subclause 15.2.3; + - d) shall set the Conversation ID IE to the stored conversation ID as specified in subclause 15.2.9; + - e) shall set the Message ID IE to the stored SDS message ID as specified in subclause 15.2.10; + - f) shall set the Date and time IE to the stored the SDS transmission time as specified in subclause 15.2.8; + - g) may include the InReplyTo message ID IE set to the stored SDS reply ID as specified in subclause 15.2.11; + - h) may include: + - i) the Application ID IE set to the stored SDS application ID as specified in subclause 15.2.7; or + - ii) the Extended application ID IE set to the stored SDS extended application ID as specified in subclause 15.2.24; + - i) if end-to-end security is required for a one-to-one communication and the security context does not exist or if the existing security context has expired, shall include the Security parameters IE with security parameters as described in 3GPP TS 33.180 [26]; and + - j) if: + - i) end-to-end security is not required for a one-to-one communication, or + - ii) sending the SDS OFF-NETWORK MESSAGE message to a MCData group;may include the Payload IE as specified in subclause 15.2.13 with: + - i) the Payload content type to the stored SDS payload type; and + - ii) the Payload data set to the stored SDS payload; +- 2) if: + - a) a one-to-one SDS message was sent then, shall send the SDS OFF-NETWORK MESSAGE message as specified in subclause 9.3.1.1; or + +- b) a group SDS message was sent then, shall send the SDS OFF-NETWORK MESSAGE message as specified in subclause 9.3.1.2; +- 3) shall increment the counter CFS1(SDS retransmission) by 1; and +- 4) shall start timer TFS1 (SDS retransmission) if the associated counter CFS1 (SDS retransmission) has not reached its upper limit. + +### 9.3.2.4 Receiving SDS message + +Upon receiving an SDS OFF-NETWORK MESSAGE message with a SDS disposition request type IE, the MCData client: + +- 1) shall store the value of Sender MCData user ID IE as the stored notification target MCData user ID; +- 2) shall store the value of Conversation ID IE as the stored conversation ID; +- 3) shall store the value of Message ID IE as the stored SDS message ID; +- 4) shall store the current UTC time as the stored SDS notification time; +- 5) if present, shall store the value of Application ID IE as the stored SDS application ID; +- 6) if present, shall store the value of the Extended application ID IE as the stored SDS extended application ID; +- 7) if present, shall store the value of MCData group ID IE to the stored target MCData group ID; and +- 8) if the SDS disposition request type IE is set to: + - a) "DELIVERY" then, shall send a SDS OFF-NETWORK NOTIFICATION message as described in subclause 12.3.2; + - b) "READ" then, shall send a SDS OFF-NETWORK NOTIFICATION message as described in subclause 12.3.3; or + - c) "DELIVERY AND READ" then, shall start timer TFS3 (delivery and read). + +NOTE: Duplicate messages (re-transmissions) that are received by the MCData client should not be processed again. + +### 9.3.2.5 SDS Read while TFS3 (delivery and read) is running + +Upon receiving a display indication before timer TFS3 (delivery and read) expires, the MCData client: + +- 1) shall generate and send a SDS OFF-NETWORK NOTIFICATION message as described in subclause 12.3.4. + +### 9.3.2.6 Timer TFS3 (delivery and read) expires + +Upon expiry of timer TFS3 (delivery and read), the MCData client: + +- 1) shall generate and send a SDS OFF-NETWORK NOTIFICATION message as described in subclause 12.3.2; and +- 2) upon receiving a display indication, shall generate and send a SDS OFF-NETWORK NOTIFICATION message as described in subclause 12.3.3. + +--- + +## 10 File Distribution (FD) + +### 10.1 General + +The group administrator can disable the FD service on a MCData group by setting the element under the element, in the group document, to "false". + +If the element under the element, in the group document, is set to "false" for a MCData group: + +- an MCData client should not use the procedures in the subclauses of the parent subclause for FD to the said MCData group. +- a terminating MCData controlling function should reject the request for FD to the said MCData group. + +## 10.2 On-network FD + +### 10.2.1 General + +#### 10.2.1.1 Sending an FD message + +When the MCData user wishes to send: + +- a one-to-one standalone File Distribution (FD) message to another MCData user; or +- a group standalone File Distribution (FD) message to a pre-configured group; + +the MCData client: + +- 1) shall follow the procedures in subclause 11.1 for transmission control; and +- 2) if the procedures in subclause 11.1 are successful: + - a) if requiring to send data without mandatory download, shall follow the procedures in subclause 10.2.4; and + - b) if requiring to send data with mandatory download, shall follow the the procedures in subclause 10.2.5. + +#### 10.2.1.2 Handling of received FD messages + +##### 10.2.1.2.1 Initial processing of the received FD message + +When a MCData client has received a SIP request containing an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1, the MCData Client: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body does not contain an FD SIGNALLING PAYLOAD message as specified in subclause 15.1.3, shall exit this subclause; +- 3) if more than one Payload IE is included in the FD SIGNALLING PAYLOAD message, shall exit this subclause; +- 4) if the Payload content type in the Payload IE in the FD SIGNALLING PAYLOAD message is not set to "FILEURL", shall exit this subclause; +- 5) if the FD SIGNALLING PAYLOAD message contains a Mandatory download IE set to the value of "MANDATORY DOWNLOAD" shall follow the procedures in subclause 10.2.1.2.2; and +- 6) if the FD SIGNALLING PAYLOAD message does not contain a Mandatory download IE, shall follow the procedures in subclause 10.2.1.2.3. + +##### 10.2.1.2.2 Mandatory Download + +The MCData client: + +- 1) if the FD SIGNALLING PAYLOAD message contains a new Conversation ID, shall instantiate a new conversation with the Message ID in the FD SIGNALLING PAYLOAD identifying the first message in the conversation thread; +- 2) if the FD SIGNALLING PAYLOAD message contains an existing Conversation ID and: + - a) if the FD SIGNALLING PAYLOAD message does not contain an InReplyTo message ID, shall use the Message ID in the FD SIGNALLING PAYLOAD to identify a new message in the existing conversation thread; and + +- b) if the FD SIGNALLING PAYLOAD message contains an InReplyTo message ID, shall associate the message to an existing message in the conversation thread as identified by the InReplyTo message ID in the FD SIGNALLING PAYLOAD, and use the Message ID in the FD SIGNALLING PAYLOAD to identify the new message; +- 3) may store the Conversation ID, Message ID, InReplyTo message ID and Date and time in local storage; + - 4) if the FD SIGNALLING PAYLOAD message does not contain an Application ID IE and does not contain an Extended application ID IE: + - a) shall determine that the payload contained in the Payload IE in the FD SIGNALLING PAYLOAD message is for user consumption; + - b) shall notify the user or application that the file identified by file URL in the Payload data in the Payload IE will be downloaded automatically; and + - c) if the FD SIGNALLING PAYLOAD message contains a Metadata IE, shall deliver the contents of the Metadata IE to the user or application; + - 5) if the FD SIGNALLING PAYLOAD message contains an Application ID IE: + - a) shall determine that the payload contained in the Payload IE in the FD SIGNALLING PAYLOAD message is not for user consumption; + - b) if the Application ID value is unknown, shall discard the FD message and exit this subclause; + - c) if the Application ID value is known, shall notify the application that the file identified by file URL in the Payload data in the Payload IE will be downloaded automatically; and +- NOTE 1: If the FD request is addressed to a non-MCData application that is not running, the MCData client starts the local non-MCData application. Subsequent automatic download of the file is then started and the file is delivered to that application. +- d) if the FD SIGNALLING PAYLOAD message contains a Metadata IE, shall deliver the contents of the Metadata IE to the application; +- 6) if the FD SIGNALLING PAYLOAD message contains an Extended application ID IE: + - a) shall determine that the payload contained in the Payload IE in the FD SIGNALLING PAYLOAD message is not for user consumption; + - b) if the Extended application ID value is unknown, shall discard the FD message and exit this clause; + - c) if the Extended application ID value is known, shall notify the application that the file identified by file URL in the Payload data in the Payload IE will be downloaded automatically; and +- NOTE 2: If the FD request is addressed to a non-MCData application that is not running, the MCData client starts the local non-MCData application. Subsequent automatic download of the file is then started and the file is delivered to that application. +- d) if the FD SIGNALLING PAYLOAD message contains a Metadata IE, shall deliver the contents of the Metadata IE to the application; +- 7) shall generate an FD NOTIFICATION indicating acceptance of the FD request as specified in subclause 12.2.1.1; + - 8) shall attempt to download the file as identified by the file URL in the Payload IE in the FD SIGNALLING PAYLOAD message, as specified in subclause 10.2.3.1; and + - 9) if the received FD SIGNALLING PAYLOAD message contains an FD disposition request type IE requesting a file download completed update indication, then after the file has been successfully downloaded, shall generate an FD NOTIFICATION indicating file download completed, by following the procedures in subclause 12.2.1.1. + +#### 10.2.1.2.3 Non-Mandatory download + +The MCData client: + +1) if the FD SIGNALLING PAYLOAD message does not contain an Application ID IE and does not contain an Extended application ID IE: + +- a) shall determine that the payload contained in the Payload IE in the FD SIGNALLING PAYLOAD message is for user consumption; +- b) shall notify the user about the incoming FD request; and +- c) if the FD SIGNALLING PAYLOAD message contains a Metadata IE, shall deliver the contents of the Metadata IE to the user; + +2) if the FD SIGNALLING PAYLOAD message contains an Application ID IE: + +- a) shall determine that the payload contained in the Payload IE in the FD SIGNALLING PAYLOAD message is not for user consumption; +- b) if the Application ID value is unknown, shall discard the FD message and exit this subclause; +- c) if the Application ID value is known, shall notify the application of the incoming FD request; and + +NOTE 1: If FD request is addressed to a non-MCData application that is not running, the MCData client starts the local non-MCData application. + +- d) if the FD SIGNALLING PAYLOAD message contains a Metadata IE, shall deliver the contents of the Metadata IE to the application; + +2A) if the FD SIGNALLING PAYLOAD message contains an Extended application ID IE: + +- a) shall determine that the payload contained in the Payload IE in the FD SIGNALLING PAYLOAD message is not for user consumption; +- b) if the Extended application ID value is unknown, shall discard the FD message and exit this clause; +- c) if the Extended application ID value is known, shall notify the application of the incoming FD request; and + +NOTE 2: If the FD request is addressed to a non-MCData application that is not running, the MCData client starts the local non-MCData application. + +- d) if the FD SIGNALLING PAYLOAD message contains a Metadata IE, shall deliver the contents of the Metadata IE to the application; + +3) shall start a timer TDU2 (FD non-mandatory download timer) with the timer value as specified in subclause F.2.3; + +4) shall wait for the user or application to request to download the file indicated by file URL in the Payload data in the Payload IE in the FD SIGNALLING PAYLOAD message; + +5) if the user or application accepts or rejects or decides to defer the FD request, shall stop timer TDU2 (FD non-mandatory download timer); + +6) if the user deferred the FD request while the timer TDU2 (FD non-mandatory download timer) was running, shall generate an FD NOTIFICATION indicating deferral of the FD request as specified in subclause 12.2.1.1; + +NOTE 3: Once the timer TDU2 (FD non-mandatory download timer) has expired the FD request can only be accepted or rejected with an appropriate action by the MCData client. + +NOTE 4: Once the timer TDU2 (FD non-mandatory download timer) has expired, no action is taken by the MCData client if the FD request is deferred. + +7) if the user or application rejects the FD request, shall generate an FD NOTIFICATION indicating rejection of the FD request as specified in subclause 12.2.1.1 and shall exit this subclause; and + +8) if the user accepts the FD request: + +- a) shall generate an FD NOTIFICATION indicating acceptance of the FD request as specified in subclause 12.2.1.1; + +- b) if the FD SIGNALLING PAYLOAD message contains a new Conversation ID, shall instantiate a new conversation with the Message ID in the FD SIGNALLING PAYLOAD identifying the first message in the conversation thread; +- c) if the FD SIGNALLING PAYLOAD message contains an existing Conversation ID and: + - i) if the FD SIGNALLING PAYLOAD message does not contain an InReplyTo message ID, shall use the Message ID in the FD SIGNALLING PAYLOAD to identify a new message in the existing conversation thread; and + - ii) if the FD SIGNALLING PAYLOAD message contains an InReplyTo message ID, shall associate the message to an existing message in the conversation thread as identified by the InReplyTo message ID in the FD SIGNALLING PAYLOAD, and use the Message ID in the FD SIGNALLING PAYLOAD to identify the new message; +- d) may store the Conversation ID, Message ID, InReplyTo message ID and Date and time in local storage; +- e) shall attempt to download the file as identified by the file URL in the Payload IE in the FD SIGNALLING PAYLOAD message, as specified in subclause 10.2.3.1; and +- f) if the received FD SIGNALLING PAYLOAD message contains an FD disposition request type IE requesting a file download completed update, then after the file download has been successfully downloaded, shall generate an FD NOTIFICATION by following the procedures in subclause 12.2.1.1. + +### 10.2.1.3 Discovery of the Absolute URI of the media storage function + +#### 10.2.1.3.1 General + +In order to upload a file to the media storage function on the controlling MCData function, the MCData UE if not aware of the absolute URI of the media storage function, discovers the absolute URI of the media storage function. + +#### 10.2.1.3.2 Void + +#### 10.2.1.3.3 Participating MCData function procedures + +On receipt of a "SIP MESSAGE request for absolute URI discovery request for participating MCData function", the originating participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP MESSAGE request; + +NOTE 1: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is "msf-disc-req": + - a) if the application/vnd.3gpp.mcdata-info+xml MIME body does not contain a MCData group ID, shall determine the public service identity of the controlling MCData function hosting the one-to-one FD using HTTP service for the calling user; and + - b) if the application/vnd.3gpp.mcdata-info+xml MIME body contains a MCData group ID, shall determine the public service identity of the controlling MCData function hosting the group standalone FD using HTTP + +service, associated with the MCData group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request; + +- 5) if unable to identify the controlling MCData function, it shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 6) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; +- 7) if the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request does not contain a element or the procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to send MCData communications as determined by step 1) of subclause 11.1, shall reject the "SIP MESSAGE request for and absolute URI discovery request for participating MCData function" with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; +- 8) shall generate a SIP MESSAGE request accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 9) shall copy all MIME bodies included in the incoming SIP MESSAGE request to the outgoing SIP MESSAGE request; +- 10) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP MESSAGE request; +- 11) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; +- 12) shall set the Request-URI of the outgoing SIP MESSAGE request to the public user identity of the controlling MCData function as determined by step 4) in this subclause; +- 13) shall set the P-Asserted-Identity header field of the outgoing SIP MESSAGE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP MESSAGE request; and +- 14) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP MESSAGE request in step 14): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the originating MCData client according to 3GPP TS 24.229 [5]. + +On receipt of a "SIP MESSAGE request for absolute URI discovery response for the participating function", the participating MCData function shall: forward the SIP MESSAGE request to the originating MCData client. + +Upon receipt of a SIP 200 (OK) response in response to the forwarded SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +#### 10.2.1.3.4 Controlling MCData function procedures + +Upon receiving a "SIP MESSAGE request for absolute URI discovery request" message, the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4]. Otherwise, continue with the rest of the steps; +- 2) if the SIP MESSAGE does not contain an application/vnd.3gpp.mcdata-info+xml MIME body, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "199 expected MIME + +bodies not in the request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + +- 3) shall decode the contents of the application/vnd.3gpp.mcdata-info+xml MIME body contained in the SIP MESSAGE; +- 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is present: + - a) shall retrieve the group document associated with the group identity in the SIP MESSAGE request by following the procedures in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + - b) if the element is present in the group document, shall send a SIP 403 (Forbidden) response with the warning text set to "115 group is disabled" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - c) if the element of the element in the group document does not contain an element with a "uri" attribute matching the MCData ID of the originating user contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, shall send a SIP 403 (Forbidden) response with the warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - d) if the element contains a element in the group document set to a value of "false", shall send a SIP 403 (Forbidden) response with the warning text set to "213 file distribution not allowed for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - e) if the element is not present in the group document or is present and contains a element containing an "enabler" attribute which is not set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", shall send a SIP 488 (Not Acceptable) response with the warning text set to "214 FD services not supported for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - f) if the MCData server group FD procedures in subclause 11.1 indicate that the user identified by the MCData ID: + - i) is not allowed to send group MCData communications on this group identity as determined by step 1) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "201 user not authorised to transmit data on this group identity" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - ii) the originating user identified by the MCData ID is not affiliated to the group identity contained in the SIP MESSAGE request, as specified in subclause 6.x.x, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; +- 5) shall generate a SIP 200 (OK) response in response to the "SIP MESSAGE request for absolute URI discovery request for controlling MCData function"; +- 6) shall send the SIP 200 (OK) response towards the originating participating MCData function according to 3GPP TS 24.229 [5]; and +- 7) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. In the generation of the SIP MESSAGE request, the controlling MCData function: + - a) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; + - b) shall identify the absolute URI of the media storage function associated with the controlling function; + - c) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; + +- d) shall include an application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, following the rules specified in subclause 6.4 for the handling of MIME bodies in a SIP message, with: + - i) a element containing the value "msf-disc-res"; and + - ii) an element set to the absolute URI of the media storage function if in step b) above; + - e) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the participating MCData function associated to the MCData ID of the originating user mentioned in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP MESSAGE request; and + - f) shall copy the public user identity of the calling MCData user from the P-Asserted-Identity header field of the incoming SIP MESSAGE request into the P-Asserted-Identity header field of the outgoing SIP MESSAGE request; and +- 8) shall send the SIP MESSAGE request towards the participating MCData function as specified in 3GPP TS 24.229 [5]. + +## 10.2.2 File upload using HTTP + +### 10.2.2.1 Media storage client procedures + +The media storage client shall determine the value of the absolute URI associated with the media storage function of the MCData content server from the element of the MCPTT user profile document (see the MCPTT user profile document in 3GPP TS 24.484 [50]). + +The media storage client shall send HTTP requests over a TLS connection as specified for the HTTP client in the UE in annex A of 3GPP TS 24.482 [24]. + +NOTE 1: The HTTP client encodes the MCData ID in the bearer access token of the Authorization header field of an HTTP request as specified in 3GPP TS 24.482 [24]. + +NOTE 2: The HTTP client always sends the HTTP requests to an HTTP proxy. Annex A of 3GPP TS 24.482 [24] indicates how the HTTP proxy forwards the HTTP request to the HTTP server. + +To upload a file to media storage function on the MCData content server, the media storage client: + +- 1) shall generate an HTTP POST request as specified in IETF RFC 7230 [22] and IETF RFC 7231 [23]; +- 2) shall set the Request-URI to the absolute URI identifying the resource on a media storage function; +- 3) shall set the Host header field to a hostname identifying the media storage function; +- 4) shall set the Content-Type header field to multipart/mixed and with a boundary delimiter parameter set to any chosen value; +- 5) if the file upload is for one-to-one file distribution, shall insert an application/vnd.3gpp.mcdata-info+xml MIME body with: + - a) the element set to a value of "one-to-one-fd"; and + - b) the element set to the originating MCData ID; +- 6) if the file upload is for group file distribution, shall insert an application/vnd.3gpp.mcdata-info+xml MIME body with: + - a) the element set to a value of "group-fd"; + - b) the element set to the MCData group identity; and + - c) the element set to the originating MCData ID; + +- 7) if end-to-end security is required for a one-to-one communication, the MCData client protects the binary data representing the file and prefixes the protected binary data with security parameters as described in 3GPP TS 33.180 [26]; +- 8) if + - i) end-to-end security is not required for a one-to-one communication, or + - ii) the file upload is for group file distribution;shall include the binary data representing the file with Content-Type field set to application/octet-stream and Content-Length field set to the file size; and +- 9) shall send the HTTP POST request towards the media storage function. + +On receipt of a HTTP 201 Created containing a Location header field with a URL identifying the location of the resource where the file has been stored on the media storage function, then the media storage client shall store this information. + +### 10.2.2.2 Media storage function procedures + +The media storage function on the MCData content server shall act as an HTTP server as defined in annex A of 3GPP TS 24.482 [24]. + +NOTE: The HTTP server validates the MCData ID in the bearer access token of the Authorization header field of an HTTP request as specified in 3GPP TS 24.482 [24]. + +On receipt of an HTTP POST request with a Request-URI identifying a resource on the media storage function, the media storage function: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-info+xml MIME body: + - a) if the user indicated by element is not allowed to upload files due to transmission control policy, shall return a HTTP 403 Forbidden response and not continue with the remaining steps in this subclause; + - b) If the element is set to: + - a) "one-to-one-fd" and the Content-Length header under application/octet-stream MIME is greater than element present in the service configuration document as specified in 3GPP TS 24.484 [12], shall generate and send a HTTP 413 Payload Too Large response and not continue with the remaining steps in this subclause; + - b) "group-fd": + - i) shall retrieve the group document associated with the group identity indicated in the element by following the procedures in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + - ii) if the Content-Length header under application/octet-stream MIME is greater than element present in the group document retrieved in step i), shall generate and send a HTTP 413 Payload Too Large response and not continue with the remaining steps in this subclause; + +**Editor's Note: [CR 0133, WI eMCData2] it is FFS to determine how the MCData content server will apply transmission control policy by accessing the configuration documents (e.g service configuration and group configuration) from the MCData server.** + +- 2) shall process the HTTP POST request by following the procedures in IETF RFC 7230 [22] and IETF RFC 7231 [23] with the following clarifications: + - a) shall store the file in the resource location as identified by the Request-URI; and + - b) shall generate and send a HTTP 201 Created response containing a Location header field with a URL identifying the location of the stored file. + +## 10.2.3 File download using HTTP + +### 10.2.3.1 Media storage client procedures + +The media storage client shall send HTTP requests over a TLS connection as specified for the HTTP client in the UE, in annex A of 3GPP TS 24.482 [24]. + +NOTE 1: The HTTP client encodes the MCData ID in the bearer access token of the Authorization header field of an HTTP request as specified in 3GPP TS 24.482 [24]. + +NOTE 2: The HTTP client always sends the HTTP requests to an HTTP proxy. Annex A of 3GPP TS 24.482 [24] indicates how the HTTP proxy forwards the HTTP request to the HTTP server. + +To download a file from the media storage function on the MCData content server, the media storage client: + +- 1) shall generate an HTTP GET request as specified in IETF RFC 7230 [22] and IETF RFC 7231 [23] with a Request-URI set to an absolute URI identifying the URL of the file being requested from the media storage function on the MCData content server; and +- 2) shall send the HTTP GET request towards the media storage function on the MCData content server. + +On receipt of a HTTP 200 OK response containing the requested file, the MCData client shall notify the user or application that the file has been successfully downloaded. + +### 10.2.3.2 Media storage function procedures + +The media storage function on the MCData content server shall act as an HTTP server as defined in annex A of 3GPP TS 24.482 [24]. + +NOTE 1: The HTTP server validates the MCData ID in the bearer access token of the Authorization header field of an HTTP request as specified in 3GPP TS 24.482 [24]. + +On receipt of an HTTP GET request with a Request-URI identifying a file, the media storage function on the MCData content server: + +- 1) if the MCData user is not allowed to download files due to reception control policy, shall return an HTTP 403 Forbidden response; +- 2) shall process the HTTP GET request by following the procedures in IETF RFC 7230 [22] and IETF RFC 7231 [23], and shall return a HTTP 200 OK response containing the requested file. + +**Editor's Note:** [CR 0133, WI eMCData2] it is FFS to determine how the MCData content server will apply reception control policy by accessing the configuration documents (e.g service configuration and group configuration) from the MCData server. + +## 10.2.4 FD using HTTP + +### 10.2.4.1 General + +The procedures in the subclauses of the parent subclause describe the SIP signalling procedures for: + +- one-to-one file distribution using HTTP; and +- group standalone file distribution using HTTP. + +When the MCData user wishes to perform file distribution via HTTP, the MCData client: + +- 1) shall check that the file size is less than or equal to the: + - a) element present in the group document retrieved by the group management client as specified in 3GPP TS 24.481 [11], if the file upload is for a group file distribution; or + - b) element present in the service configuration document as specified in 3GPP TS 24.484 [12], if the file upload is for a one-to-one file distribution; + +- 2) if the size of the file: + - a) is acceptable for upload as determined by step 1), shall determine the value of the absolute URI associated with the media storage function of the MCData content server from the element of the MCPTT user profile document (see the MCPTT user profile document in 3GPP TS 24.484 [50]); + - b) is not acceptable for upload, shall not continue with the remaining steps in this subclause; +- 3) shall request the media storage client to upload the file to the media storage function by following the procedures in subclause 10.2.2.1; and +- 4) shall initiate an FD request containing a file URL as specified in subclause 10.2.4.2.1. + +#### 10.2.4.2 MCData client procedures + +##### 10.2.4.2.1 MCData client originating procedures + +The MCData client shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] with the clarifications given below. + +The MCData client: + +- 1) shall build the SIP MESSAGE request as specified in subclause 6.2.4.1; +- 2) if a one-to-one standalone FD message is to be sent shall insert in the SIP MESSAGE request: + - a) an application/resource-lists+xml MIME body with the MCData ID of the target MCData user, according to rules and procedures of IETF RFC 4826 [9]; and + - b) an application/vnd.3gpp.mcdata-info+xml MIME body with: + - i) a element set to a value of "one-to-one-fd"; and + - ii) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP MESSAGE request, the element set to the URI of the used functional alias; +- 3) if a group standalone FD message is to be sent: + - a) if the "/Common/MCData/AllowedFD" leaf node present in the group document of the requested MCData group, configured on the group management client as specified in 3GPP TS 24.483 [42] is set to "false", shall reject the request for FD and not continue with the rest of the steps in this subclause; and + - b) shall insert in the SIP MESSAGE request an application/vnd.3gpp.mcdata-info+xml MIME body with: + - i) the element set to a value of "group-fd"; + - ii) the element set to the MCData group identity; + - iii) the element set to the MCData client ID of the originating MCData client; and + - iv) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP MESSAGE request, the element set to the URI of the used functional alias; +- 4) shall generate a standalone FD message as specified in subclause 6.2.2.2; and +- 5) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]. + +##### 10.2.4.2.2 MCData client terminating procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for terminating MCData client", the MCData client: + +- 1) may reject the SIP MESSAGE request if there are not enough resources to handle the SIP MESSAGE request; + +- 2) if the SIP MESSAGE request is rejected in step 1), shall respond towards the participating MCData function with a SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this subclause; +- 3) shall generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; +- 4) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]; and +- 5) shall handle the received message as specified in subclause 10.2.1.2. + +### 10.2.4.3 Participating MCData function procedures + +#### 10.2.4.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; + - 2) shall determine the MCData ID of the originating user from the public user identity in the P-Asserted-Identity header field of the SIP MESSAGE request, and shall authorise the calling user; +- NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; + - 4) if element is present in the application/vnd.3gpp.mcdata-info+xml, shall use its value as public service identity of the controlling MCData function. Otherwise, if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is: + - a) set to a value of "group-fd", shall determine the public service identity of the controlling MCData function hosting the group standalone FD using HTTP service, associated with the MCData group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request; or + - b) set to a value of "one-to-one-fd", shall determine the public service identity of the controlling MCData function hosting the one-to-one FD using HTTP service for the calling user; + - 5) if unable to identify the controlling MCData function, it shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; + - 6) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; + - 7) if is not present in the application/vnd.3gpp.mcdata-info+xml and if the procedures in subclause 11.1 indicate that the user identified by the MCData ID: + - a) is not allowed to initiate MCData communications as determined by step 1) of subclause 11.1, shall reject the "SIP MESSAGE request for FD using HTTP for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - b) is not allowed to initiate one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request as determined by step 7) of subclause 11.1, shall reject the "SIP MESSAGE request for FD using HTTP for originating participating MCData function" with a SIP 403 + +(Forbidden) response to the SIP MESSAGE request, with warning text set to "202 user not authorised for one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + +- c) is not allowed to initiate one-to-one MCData communications to the targeted user as determined by step 1a) of subclause 11.1, shall reject the "SIP MESSAGE request for FD using HTTP for originating participating MCData function" with a SIP 403 (Forbidden) response including warning text set to "229 one-to-one MCData communication not authorised to the targeted user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 8) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; + - 9) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the controlling MCData function as determined by step 4) in this subclause; + - 10) shall copy all MIME bodies included in the incoming SIP MESSAGE request to the outgoing SIP MESSAGE request; + - 10A) if the incoming SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; + - 11) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP MESSAGE request; + - 12) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; + - 13) shall set the P-Asserted-Identity in the outgoing SIP MESSAGE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP MESSAGE request; and + - 14) shall send the SIP MESSAGE request as specified to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 202 (Accepted) response in response to the SIP MESSAGE request in step 14): + +- 1) shall generate a SIP 202 (Accepted) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 202 (Accepted) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP MESSAGE request in step 14): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the SIP MESSAGE request in step 14) the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +#### 10.2.4.3.2 Terminating participating MCData function procedures + +Upon receipt of a: + +- "SIP MESSAGE request for FD using HTTP for terminating participating MCData function"; or +- "SIP MESSAGE network notification for FD using HTTP for terminating participating MCData function"; + +the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request to retrieve the binding between the MCData ID and public user identity of the terminating MCData user; +- 3) if the binding between the MCData ID and public user identity of the terminating MCData user does not exist, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response, and shall not continue with the rest of the steps; +- 4) if the SIP MESSAGE is a "SIP MESSAGE request for FD using HTTP for terminating participating MCData function", and if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message with a FD disposition request type IE, shall store the value of the Conversation ID IE, the value of the Message ID IE and the payload IE in the FD SIGNALLING PAYLOAD message; +- 5) if the SIP MESSAGE is a "SIP MESSAGE network notification for FD using HTTP for terminating participating MCData function", and if FD NETWORK NOTIFICATION message within the application/vnd.3gpp.mcdata-signalling MIME body contains an FD notification type IE with value set as "FILE EXPIRED UNAVAILABLE TO DOWNLOAD" as specified in subclause 15.2.6, the file identified using Conversation ID IE shall be removed from the stored file list; +- 5) shall generate an outgoing SIP MESSAGE request as specified in subclause 6.3.2.1; +- 5A) if the element exists in the MCData user profile document with one or more elements (see the MCData user profile document in 3GPP TS 24.484 [12]) and: + - i) if the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP message does not match with the element of any of the elements in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]); and + - ii) if configuration is not set in the MCData user profile document that allows the MCData user to receive one-to-one MCData communication from any user (see element in MCData user profile document in 3GPP TS 24.484 [12]);then: + - i) shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response including warning text set to "230 one-to-one MCData communication not authorised from this originating user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 6) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; and +- 7) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +#### 10.2.4.4 Controlling MCData function procedures + +##### 10.2.4.4.1 Originating controlling MCData function procedures + +This subclause describes the procedures for sending a SIP MESSAGE from the controlling MCData function and is initiated by the controlling MCData function as a result of an action in subclause 10.2.4.4.2. + +The controlling MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.fd media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 3) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 4) shall copy the following MIME bodies in the received SIP MESSAGE request into the outgoing SIP MESSAGE request by following the guidelines in subclause 6.4: + - a) application/vnd.3gpp.mcdata-info+xml MIME body; and + - b) application/vnd.3gpp.mcdata-signalling MIME body; +- 5) if the application/vnd.3gpp.mcdata-signalling MIME body in the received SIP MESSAGE request contained a FD SIGNALLING PAYLOAD message without the Mandatory download IE included, then: + - a) shall execute the procedures in subclause 11.2; + - b) if the procedures in subclause 11.2 indicate that the mandatory download indication needs to be included, shall include the Mandatory download IE set to a value of "MANDATORY DOWNLOAD" in the FD SIGNALLING PAYLOAD message of the outgoing SIP MESSAGE request; +- 6) in the application/vnd.3gpp.mcdata-info+xml MIME body: + - a) shall set the element set to the MCData ID of the terminating user; and + - b) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request was set to a value of "group-fd", shall set the element to the group identity; +- 7) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; +- 8) shall copy the public user identity of the calling MCData user from the P-Asserted-Identity header field of the incoming SIP MESSAGE request into the P-Asserted-Identity header field of the outgoing SIP MESSAGE request; +- 9) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; and +- 10) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [5]. + +##### 10.2.4.4.2 Terminating controlling MCData function procedures + +The procedures in this subclause are executed upon: + +- receipt of a "SIP MESSAGE request for FD using HTTP for controlling MCData function", the controlling MCData function; or +- a decision to now process a previously received "SIP MESSAGE request for FD using HTTP for controlling MCData function" that had been queued for later transmission; + +NOTE 1: The controlling MCData function may postpone the continuation of an FD using HTTP procedure by queuing the received "SIP MESSAGE request for FD using HTTP for controlling MCData function". The management of the queue is specified in Annex B of 3GPP TS 23.282 [2]. + +the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response or queue the received SIP MESSAGE. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4]; + - 2) if the received SIP MESSAGE request has been queued for later transmission, shall include warning text set to "215 request to transmit is queued by the server" in a Warning header field as specified in subclause 4.9;, in the SIP 202 (Accepted) response and not continue with the remaining steps in this subclause. Otherwise, continue with the rest of the steps; + - 3) if the SIP MESSAGE does not contain: + - a) an application/vnd.3gpp.mcdata-info+xml MIME body; and + - b) an application/vnd.3gpp.mcdata-signalling MIME body; + shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "199 expected MIME bodies not in the request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - 4) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body contained in the SIP MESSAGE; + - 5) if the application/vnd.3gpp.mcdata-signalling MIME body does not contain only one FD SIGNALLING PAYLOAD message or FD HTTP TERMINATION message, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "209 one FD SIGNALLING PAYLOAD message or FD HTTP TERMINATION message only must be present in FD request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - 6) if the FD SIGNALLING PAYLOAD message or FD HTTP TERMINATION message does not contain only one Payload IE, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "210 Only one File URL must be present in the FD request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - 7) if the Payload IE has Payload contents: + - a) with a Payload content type set to a value other than "FILEURL" shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "211 payload for an FD request is not FILEURL" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - b) with Payload data containing a file URL identifying a file that does not exist on the media storage function, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "212 file referenced by file URL does not exist" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - 8) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message with a FD disposition request type IE, shall store the value of the Conversation ID IE and the value of the Message ID IE in the FD SIGNALLING PAYLOAD message; +- NOTE 2: The controlling MCData function uses the Conversation ID and Message ID for correlation with disposition notifications. +- 9) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message: + - a) with a Metadata IE, shall derive a timer value for the file availability timer as the minimum of the file availability information in the metadata and the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12]; and + +- b) without a Metadata IE, shall derive a timer value for the file availability timer as the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12]; +- 10) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is set to a value of "one-to-one-fd" and the SIP MESSAGE request: +- a) does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall return a SIP 403 (Forbidden) response with the warning text set to "205 unable to determine targeted user for one-to-one FD" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + - b) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message contains an application/resource-lists MIME body with exactly one element, shall send a SIP MESSAGE request to the MCData user identified in the element of the MIME body, as specified in subclause 10.2.4.4.1; +- 11) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD HTTP TERMINATION message: +- a) if the FD HTTP TERMINATION message doesn't contain Conversation Id or Message Id, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "223 No Conversation ID or Message ID present" and shall not continue with rest of the steps; and + - b) if not identified any transmission with given Conversation ID, Message ID shall send 404 with reason with warning text set to "224 No transmission available" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps; +- 12) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message and if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request is set to a value of "group-fd": +- a) shall retrieve the group document associated with the group identity in the SIP MESSAGE request by following the procedures in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + - b) if the element is present in the group document, shall send a SIP 403 (Forbidden) response with the warning text set to "115 group is disabled" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - c) if the element of the element of the element in the group document does not contain an element with a "uri" attribute matching the MCData ID of the originating user contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, shall send a SIP 403 (Forbidden) response with the warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - d) if the element contains a element in the group document set to a value of "false", shall send a SIP 403 (Forbidden) response with the warning text set to "213 file distribution not allowed for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - e) if the element is not present in the group document or is present and contains a element containing an "enabler" attribute which is not set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", shall send a SIP 488 (Not Acceptable) response with the warning text set to "214 FD services not supported for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - f) if the MCData server group FD procedures in subclause 11.1 indicate that the user identified by the MCData ID: + - i) is not allowed to initiate group MCData communications on this group identity as determined by step 2) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response, with warning text set to "201 user not authorised to transmit data on this group identity" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + +- ii) is not allowed to initiate group MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request as determined by step 8) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "208 user not authorised for MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - iii) is not allowed to initiate group MCData communications on this group identity due to exceeding the maximum allowed file size as determined by step 6) of subclause 11.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request, with warning text set to "208 user not authorised for MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - g) if the originating user identified by the MCData ID is not affiliated to the group identity contained in the SIP MESSAGE request, as specified in subclause 6.3.5, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; + - j) shall determine targeted group members for MCData communications by following the procedures in subclause 6.3.4; + - k) if the procedures in subclause 6.3.4 result in no affiliated members found in the selected MCData group, shall return a SIP 403 (Forbidden) response with the warning text set to "198 no users are affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + - l) shall send SIP MESSAGE requests to the targeted group members identified in step j) above by following the procedure in subclause 10.2.4.4.1; +- 13) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message, shall start TDC2 (file availability timer) with the value derived in step 9 of this subclause; +- 14) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD SIGNALLING PAYLOAD message, shall associate the running timer TDC2 (file availability timer) to the Conversation ID, Message ID, Application ID (if included), and Extended application ID (if included) contained in the FD SIGNALLING PAYLOAD message; +- NOTE 3: Multiple file availability timers can be running for a file. Each file availability timer is uniquely associated to a Conversation ID and Message ID. +- 15) shall generate a SIP 202 (Accepted) response in response to the "SIP MESSAGE request for FD using HTTP for controlling MCData function"; and +- 16) shall send the SIP 202 (Accepted) response towards the originating participating MCData function according to 3GPP TS 24.229 [5]. +- 17) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD HTTP TERMINATION message and Termination information type IE set to "TERMINATION REQUEST" then: +- a) shall identify the FILE transmission with Conversation ID and Message ID and "FILE URL". If any ongoing transmission exist then execute procedure described in subclause 12.4.2.1 with following clarifications: + - i) shall set FD notification type IE as "FILE DELETED UNAVAILABLE TO DOWNLOAD" as specified in subclause 15.2.18; + - b) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. In the generation of the SIP MESSAGE request, the controlling MCData function: + - i) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; + - ii) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; + +- iii) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the participating MCData function associated to the MCData ID of the originating user mentioned in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request; + - iv) shall copy the public user identity of the calling MCData user from the P-Asserted-Identity header field of the incoming SIP MESSAGE request into the P-Asserted-Identity header field of the outgoing SIP MESSAGE request; + - v) shall include an application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, following the rules specified in subclause 6.4 for the handling of MIME bodies in a SIP message: + - A) fill element from element of the application/vnd.3gpp.mcdata-info+xml in received SIP MESSAGE; + - vi) shall generate FD HTTP TERMINATION message as described in subclause 6.3.6.1; + - vii) shall set the Termination information type IE set to "TERMINATION RESPONSE" as specified in subclause 15.2.22. + - viii) if clause is successful shall set Release response type IE of FD HTTP TERMINATION MESSAGE to "RELEASE SUCCESS" else set to "RELEASE FAILED" as described in subclause 15.2.23; and + - ix) shall include in the SIP request, the FD HTTP TERMINATION message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; +- c) shall send the SIP MESSAGE request towards the originating participating MCData function as specified in 3GPP TS 24.229 [5]; and +- 18) if the application/vnd.3gpp.mcdata-signalling MIME body contains an FD HTTP TERMINATION message and Termination information type IE set to other than "TERMINATION REQUEST" then follow procedures described on subclause 13.2.5 and subclause 13.2.6. + +## 10.2.5 FD using media plane + +### 10.2.5.1 General + +The procedures in the subclauses of the parent subclause describe the SIP signalling procedures for: + +- one-to-one file distribution using media plane; and +- group standalone file distribution using media plane. + +### 10.2.5.2 MCData client procedures + +#### 10.2.5.2.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 5547 [69] IETF RFC 6135 [19] and IETF RFC 6714 [20] the MCData client: + +- 1) shall include an "m=message" media-level section for the MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS; + - c) an "a=sendonly" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling"; + - f) set the a=setup attribute as "actpass"; + - g) a file-selector attribute containing: + +- i) a 'name' selector; + - ii) a 'type' selector; + - iii) a 'size' selector; and + - iv) a 'hash' selector; +- h) a file-date attribute; and +- 2) if end-to-end security is required for a one-to-one communication and the security context does not exist or if the existing security context has expired, shall include the MIKEY-SAKKE I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [45]. + +#### 10.2.5.2.2 SDP answer generation + +When the MCData client receives an initial SDP offer for file distribution, the MCData client shall process the SDP offer and shall compose an SDP answer according to 3GPP TS 24.229 [5] and IETF RFC 5547 [69]. + +When composing an SDP answer, the MCData client: + +- 1) shall include an "m=message" media-level section for the accepted MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS according to the received SDP offer; + - c) an "a=recvonly" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as a=accept-types:application/vnd.3gpp.mcdata-signalling; + - f) set the a=setup attribute according to IETF RFC 6135 [19]; and + - g) a file-selector attribute containing: + - i) a 'name' selector; + - ii) a 'type' selector; + - iii) a 'size' selector; and + - iv) a 'hash' selector. + +#### 10.2.5.2.3 MCData client originating procedures + +The MCData client shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5] with the clarifications given below. + +The MCData client: + +- 1) shall include the g.3gpp.mcdata.fd media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [16]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.fd media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; + +- 5) should include the "timer" option tag in the Supported header field; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) shall generate and contain an application/vnd.3gpp.mcdata-signalling MIME body with the FD SIGNALLING PAYLOAD as described in subclause 6.2.2.3; +- 8) if a one-to-one file distribution is requested: + - a) shall insert in the SIP INVITE request a MIME resource-lists body with the MCData ID of the invited MCData user, according to rules and procedures of IETF RFC 5366 [18]; and + - b) shall contain an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - i) the element set to a value of "one-to-one-fd"; and + - ii) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP INVITE request, the element set to the URI of the used functional alias; + - c) if an end-to-end security context needs to be established and the security context does not exist or if the existing security context has expired, then: + - i) if necessary, shall instruct the key management client to request keying material from the key management server as described in 3GPP TS 33.180 [26]; + - ii) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [26]; + - iii) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0001" to indicate that the purpose of the PCK is to protect one-to-one communications and with the remaining twenty eight bits being randomly generated as described in 3GPP TS 33.180 [26]; + - iv) shall encrypt the PCK to a UID associated to the MCData client using the MCData ID of the invited user and a time related parameter as described in 3GPP TS 33.180 [26]; + - v) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [26]; and + - vi) shall add the MCData ID of the originating MCData to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; and + - vii) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating MCData user's signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [26]; +- 9) if a group file distribution is requested: + - a) if the "//Common/MCData/AllowedFD" leaf node present in the group document of the requested MCData group, configured on the group management client as specified in 3GPP TS 24.483 [42] is set to "false", shall reject the request for FD and not continue with the rest of the steps in this subclause; and + - b) shall contain in an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - i) the element set to a value of "group-fd"; + - ii) the element set to the MCData group identity; + - iii) the element set to the MCData client ID of the originating MCData client; and + +NOTE 1: The MCData client does not include the MCData ID of the originating MCData user in the body, as this will be inserted into the body of the SIP INVITE request that is sent from the originating participating MCData function. + +- iv) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP INVITE request, the element set to the URI of the used functional alias; + - 10) shall set the Request-URI of the SIP INVITE request to the public service identity identifying the participating MCData function serving the MCData user; +- NOTE 2: The MCData client is configured with public service identity identifying the participating MCData function serving the MCData user. +- 11) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; + - 12) shall include an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 10.2.5.2.1; and + - 13) shall send the SIP INVITE request towards the MCData server according to 3GPP TS 24.229 [5]. + +On receipt of a SIP 2xx response to the SIP INVITE request, the MCData client: + +- 1) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]; +- 2) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; and +- 3) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 10.2.5.1.1.. + +On receipt of a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request: + +- 1) shall indicate to the MCData user that the file could not be sent; and +- 2) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]. + +On receipt of an indication from the media plane indicating that the file was not sent successfully, the MCData client shall: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5] with: + - a) Reason code set to "SIP"; + - b) cause set to "480"; and + - c) text set to "transmission failed"; +- 2) shall set the Request-URI to the MCData session identity to release; and +- 3) shall send a SIP BYE request towards MCData server according to 3GPP TS 24.229 [5]. + +#### 10.2.5.2.4 MCData client terminating procedures + +Upon receipt of an "initial SIP INVITE request for file distribution for terminating MCData client" request, the MCData client shall follow the procedures for termination of multimedia sessions in the IM CN subsystem as specified in 3GPP TS 24.229 [5] with the clarifications below. + +The MCData client: + +- 1) may reject the SIP INVITE request if either of the following conditions are met: + - a) MCData client does not have enough resources to handle the call; or + - b) any other reason outside the scope of this specification;and skip the rest of the steps after step 2; +- 2) if the SIP INVITE request is rejected in step 1), shall respond toward participating MCData function either with appropriate reject code as specified in 3GPP TS 24.229 [5] and warning texts as specified in subclause 4.9 or with SIP 480 (Temporarily unavailable) response not including warning texts if the user is authorised to restrict the reason for failure and skip the rest of the steps of this subclause; + +- 3) if the SDP offer of the SIP INVITE request contains an "a=key-mgmt" attribute field with a "mikey" attribute value containing a MIKEY-SAKKE I\_MESSAGE: + - a) shall extract the MCData ID of the originating MCData user from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - b) shall convert the MCData ID to a UID as described in 3GPP TS 33.180 [26]; + - c) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - d) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP INVITE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9 and not continue with rest of the steps in this subclause; and + - e) if the signature of the MIKEY-SAKKE I\_MESSAGE was successfully validated: + - i) shall extract and decrypt the encapsulated PCK using the terminating user's (KMS provisioned) UID key as described in 3GPP TS 33.180 [26]; and + - ii) shall extract the PCK-ID, from the payload as specified in 3GPP TS 33.180 [26]; +- NOTE: With the PCK successfully shared between the originating MCData client and the terminating MCData client, both clients are able to create an end-to-end secure session. +- 4) may display to the MCData user the MCData ID of the inviting MCData user; + - 4A) may display to the MCData user the functional alias of the inviting MCData user, if provided; + - 5) may display to the MCData user the file meta-data of the incoming file as described by the SDP included in the received SIP INVITE request; + - 6) if the Mandatory indication IE of the FD SIGNALLING PAYLOAD contained in the application/vnd.3gpp.mcdata-signalling MIME body received in the SIP INVITE request is set to "MANDATORY", then: + - i) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; + - ii) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; + - iii) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [38]. The "refresher" parameter in the Session-Expires header field shall be set to "uas"; + - iv) shall include the g.3gpp.mcdata.fd media feature tag in the Contact header field of the SIP 200 (OK) response; + - v) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" in the Contact header field of the SIP 200 (OK) response; + - vi) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [5] with the clarifications given in subclause 10.2.5.2.2; and + - vii) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of an SIP ACK message to the sent SIP 200 (OK) message, the MCData client shall: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 10.2.5.1.2. + +On receipt of an indication from the media plane of the successful download of the file and if the received FD SIGNALLING PAYLOAD message contained an FD disposition request type IE requesting a file download completed update indication, then, the MCData client: + +- 1) shall follow the procedures described in subclause 12.2.1.1. + +### 10.2.5.3 Participating MCData function procedures + +#### 10.2.5.3.1 SDP offer generation + +The SDP offer is generated based on the received SDP offer. The SDP offer generated by the participating MCData function: + +- 1) shall contain only one SDP media-level section for file distribution as contained in the received SDP offer; and +- 2) shall contain an "a=key-mgmt" attribute field with a "mikey" attribute value, if present in the received SDP offer. + +When composing the SDP offer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number for the offered media stream in the received SDP offer with the IP address and port number of the participating MCData function, if required; and + +NOTE 1: Requirements can exist for the participating MCData function to be always included in the path of the offered media stream, for example: for the support of features such as MBMS, lawful interception and recording. Other examples can exist. + +NOTE 2: If the participating MCData function and the controlling MCData function are in the same MCData server, and the participating MCData function does not have a dedicated IP address or a dedicated port number for media stream, the replacement of the IP address or the port number is omitted. + +- 2) if the IP address is replaced shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP answer. + +#### 10.2.5.3.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number in the received SDP answer with the IP address and port number of the participating MCData function, for the accepted media stream in the received SDP offer, if required; and + +NOTE 1: Requirements can exist for the participating MCData function to be always included in the path of the offered media stream, for example: for the support of features such as MBMS, lawful interception and recording. Other examples can exist. + +NOTE 2: If the participating MCData function and the controlling MCData function are in the same MCData server, and the participating MCData function does not have a dedicated IP address or a dedicated port number for media stream, the replacement of the IP address or the port number is omitted. + +- 2) if the IP address is replaced shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP answer. + +#### 10.2.5.3.3 Originating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for file distribution for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP INVITE request, and shall authorise the calling user; + +NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to + +the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; + +- 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is: + - a) set to a value of "group-fd", shall determine the public service identity of the controlling MCData function associated with the MCData group identity in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP INVITE request; or + - b) set to a value of "one-to-one-fd", shall determine the public service identity of the controlling MCData function hosting the file distribution service for the calling user; +- 5) if unable to identify the controlling MCData function for file distribution, it shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 6) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; +- 7) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID: + - a) is not allowed to initiate MCData communications as determined by step 1) of subclause 11.1, shall reject the "SIP INVITE request for file distribution for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - b) is not allowed to initiate one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request as determined by step 7) of subclause 11.1, shall reject the "SIP INVITE request for file distribution for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "202 user not authorised for one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - c) is not allowed to initiate one-to-one MCData communications to the targeted user as determined by step 1a) of clause 11.1, shall reject the "SIP INVITE request for file distribution for originating participating MCData function" with a SIP 403 (Forbidden) response including warning text set to "229 one-to-one MCData communication not authorised to the targeted user" in a Warning header field as specified in clause 4.9 and shall not continue with the rest of the steps; +- 8) shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5]; +- 9) shall include the option tag "timer" in the Supported header field; +- 10) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 11) shall set the Request-URI of the outgoing SIP INVITE request to the public service identity of the controlling MCData function as determined by step 4) in this subclause; +- 12) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; +- 12A) if the incoming SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; +- 13) shall include in the outgoing SIP INVITE request, the application/vnd.3gpp.mcdata-signalling MIME body that was present in the incoming SIP INVITE request; + +- 14) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; +- 15) shall set the P-Asserted-Identity in the outgoing SIP INVITE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP INVITE request; +- 16) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the MCData client as specified in subclause 10.2.5.3.1; and +- 17) shall send the SIP INVITE request as specified to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP INVITE request in step 16): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include in the SIP 200 (OK) response an SDP answer as specified in the subclause 10.2.5.3.2; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If the "refresher" parameter is not included in the received request, the "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.fd media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; and + - c) the isfocus media feature tag; +- 6) shall include Warning header field(s) that were received in the incoming SIP 200 (OK) response; +- 7) shall include an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP 200 (OK) response; +- 8) if the incoming SIP 200 (OK) response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 9) shall include the public service identity received in the P-Asserted-Identity header field of the incoming SIP 200 (OK) response into the P-Asserted-Identity header field of the outgoing SIP 200 (OK) response; and +- 10) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 7.2.1; +- 11) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]; and +- 12) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the SIP INVITE request in step 16) the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +#### 10.2.5.3.4 Terminating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for file distribution for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; + +- 2) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the participating MCData function shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; +- 3) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCData ID and public user identity of the terminating MCData user; +- 4) if the binding between the MCData ID and public user identity of the terminating MCData user does not exist, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response, and shall not continue with the rest of the steps; +- 4A) if the element exists in the MCData user profile document with one or more elements (see the MCData user profile document in 3GPP TS 24.484 [12]) and: + - i) if the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request does not match with the element of any of the elements in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]); and + - ii) if configuration is not set in the MCData user profile document that allows the MCData user to receive one-to-one MCData communication from any user (see element in MCData user profile document in 3GPP TS 24.484 [12]);then: + - i) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response including warning text set to "230 one-to-one MCData communication not authorised from this originating user" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- 5) shall generate a SIP INVITE request accordance with 3GPP TS 24.229 [5]; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) shall include the option tag "timer" in the Supported header field; +- 8) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.fd media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; + - c) the isfocus media feature tag; + - d) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the incoming SIP INVITE request; and + - e) any other uri-parameter provided in the Contact header field of the incoming SIP INVITE request; +- 9) shall include in the SIP INVITE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [8] that were received (if any) in the incoming SIP INVITE request; +- 10) shall set the Request-URI of the outgoing SIP INVITE request to the public user identity associated to the MCData ID of the terminating MCData user; +- 11) shall populate the outgoing SIP INVITE request with the MIME bodies that were present in the incoming SIP INVITE request; +- 12) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP INVITE request to the P-Asserted-Identity header field of the outgoing SIP INVITE request; + +- 13) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received "SIP INVITE request for file distribution for terminating participating MCData function" as specified in subclause 10.2.5.3.1; and +- 14) shall send the SIP INVITE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include in the SIP 200 (OK) response an SDP answer based on the SDP answer in the received SIP 200 (OK) response as specified in subclause 10.2.5.3.2; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If no "refresher" parameter was included in the SIP INVITE request, the "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.fd media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; and + - c) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP INVITE request from the controlling MCData function; +- 6) if the incoming SIP response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 7) shall copy the P-Asserted-Identity header field from the incoming SIP 200 (OK) response to the outgoing SIP 200 (OK) response; +- 8) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 7.2.2; and +- 10) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +## 10.2.5.4 Controlling MCData function procedures + +### 10.2.5.4.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 5547 [69] IETF RFC 6135 [19] and IETF RFC 6714 [20] the MCData client: + +- 1) shall include an "m=message" media-level section for the MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS; + - c) an "a=sendonly" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling"; + +- f) set the a=setup attribute as "actpass"; +- g) a file-selector attribute containing: + - i) a 'name' selector; + - ii) a 'type' selector; + - iii) a 'size' selector; and + - iv) a 'hash' selector; and +- h) a file-date attribute; + +#### 10.2.5.4.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the controlling MCData function: + +- 1) shall include an "m=message" media-level section for the accepted MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS according to the received SDP offer; + - c) a format list field set to "\*"; + - d) an "a=recvonly" attribute; + - e) an "a=path" attribute containing its own MSRP URI; + - f) set the content type as a=accept-types:application/vnd.3gpp.mcdata-signalling; and + - g) set the a=setup attribute set to "passive", according to IETF RFC 6135 [19]; and + - h) a file-selector attribute containing: + - i) a 'name' selector; + - ii) a 'type' selector; + - iii) a 'size' selector; and + - iv) a 'hash' selector. + +#### 10.2.5.4.3 Originating controlling MCData function procedures + +This subclause describes the procedures for inviting an MCData user to an MCData session. The procedure is initiated by the controlling MCData function as the result of an action in subclause 10.2.5.4.4. + +The controlling MCData function: + +- 1) shall generate a SIP INVITE according to 3GPP TS 24.229 [5]; +- 2) shall include the Supported header field set to "timer"; +- 3) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38]. The refresher parameter shall be omitted; +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcdata.fd media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 5) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 6) shall include a Referred-By header field with the public user identity of the inviting MCData client; + +- 7) shall include in the Contact header field an MCData session identity for the MCData session with the g.3gpp.mcdata.fd media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" according to IETF RFC 3840 [16]; + - 8) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the MCData ID of the terminating user; and + - b) the element set to the group identity if the request is for group file distribution ; + - 9) shall include in the outgoing SIP INVITE request, the application/vnd.3gpp.mcdata-signalling MIME body that was present in the incoming SIP INVITE request; + - 10) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; +- NOTE 1: How the controlling MCData function finds the address of the terminating participating MCData function is out of the scope of the current release. +- 11) shall set the P-Asserted-Identity header field to the public service identity of the controlling MCData function; + - 12) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; + - 13) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating client according to the procedures specified in subclause 10.2.5.4.1; and + - 14) shall send the SIP INVITE request towards the terminating client in accordance with 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the controlling MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 7.3. + +NOTE 2: The procedures executed by the controlling MCData function prior to sending a response to the inviting MCData client are specified in subclause 10.2.5.4.4. + +#### 10.2.5.4.4 Terminating controlling MCData function procedures + +In the procedures in this subclause: + +- 1) MCData ID in an incoming SIP INVITE request refers to the MCData ID of the originating user from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; and +- 3) MCData ID in an outgoing SIP INVITE request refers to the MCData ID of the called user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; + +The procedures in this subclause are executed upon: + +- receipt of a "SIP INVITE request for controlling MCData function for file distribution"; or +- a decision to now process a previously received "SIP INVITE request for controlling MCData function for file distribution" that had been queued for later transmission; + +NOTE 1: The controlling MCData function may postpone the continuation of an FD using media plane procedure by queuing the received "SIP INVITE request for controlling MCData function for file distribution". The management of the queue is specified in Annex B of 3GPP TS 23.282 [2]. + +the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response or queue the received SIP INVITE. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4]; +- 2) if the received SIP INVITE request has been queued for later transmission, shall include warning text set to "215 request to transmit is queued by the server" in a Warning header field as specified in subclause 4.9, in the SIP 100 (Trying) response, and shall send the SIP 100 (TRYING) response towards the originating participating MCData function according to 3GPP TS 24.229 [5] and not continue with the remaining steps in this subclause. Otherwise, continue with the rest of the steps; +- 3) shall determine if the media parameters are acceptable and the MSRP URI is offered in the SDP offer and if not reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 4) if the incoming SIP INVITE request does not contain an application/vnd.3gpp.mcdata-signalling MIME body with the FD SIGNALLING PAYLOAD as described in subclause 6.2.2.3, shall reject the SIP INVITE request with appropriate reject code; +- 5) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcdata.fd media feature tag; or + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; +- 6) shall cache SIP feature tags, if received in the Contact header field and if the specific feature tags are supported; +- 7) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; +- 8) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "one-to-one-fd" and: + - a) the conditions in subclause 11.1 indicate that the MCData user is not allowed to initiate FD communications due to file size exceeding allowed limits as determined by step 4) of subclause 11.1, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "220 user not authorised for FD communications due to file size" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + +NOTE 2: The size of the file intended for transfer over the media plane is obtained from the 'size' selector of the file-selector attribute in the received SDP offer. + +- b) the SIP INVITE request: + - i) does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall return a SIP 403 (Forbidden) response with the warning text set to "205 unable to determine targeted user for one-to-one FD " in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; + - ii) contains an application/resource-lists MIME body with exactly one element, shall invite the MCData user identified by the element of the MIME body, as specified in subclause 10.2.5.4.3; andshall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 7.3; +- 9) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "group-fd": + - a) shall retrieve the necessary group document(s) from the group management server for the group identity contained in the SIP INVITE request and carry out initial processing as specified in subclause 6.3.3, and shall continue with the remaining steps if the procedures in subclause 6.3.3 were successful; + - b) if the element is present in the group document, shall send a SIP 403 (Forbidden) response with the warning text set to "115 group is disabled" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + +- c) if the element of the element of the element in the group document does not contain an element with a "uri" attribute matching the MCData ID of the originating user contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP INVITE request, shall send a SIP 403 (Forbidden) response with the warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- d) if the element contains a element in the group document set to a value of "false", shall send a SIP 403 (Forbidden) response with the warning text set to "213 file distribution not allowed for this group" in a Warning header field as specified in subclause 4.x and shall not continue with the rest of the steps; +- e) if the element is not present in the group document or is present and contains a element containing an "enabler" attribute which is not set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd", shall send a SIP 488 (Not Acceptable) response with the warning text set to "214 FD services not supported for this group" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; +- f) if the user identified by the MCData ID: + - i) is not allowed to initiate group MCData communications on this group identity as determined by step 2) of subclause 11.1, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response, with warning text set to "201 user not authorised to transmit data on this group identity" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - ii) is not allowed to initiate group MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request as determined by step 8) of subclause 11.1, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "208 user not authorised for MCData communications on this group identity due exceeding the maximum amount of data that can be sent in a single request" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; and + - iii) is not allowed to initiate FD communications on this group identity due to file size exceeding the allowed limits as determined by step 6) of subclause 11.1, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "219 user not authorised for FD communications on this group identity due to file size" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause. + +NOTE 3: The size of the file intended for transfer over the media plane is obtained from the 'size' selector of the file-selector attribute in the received SDP offer. + +- g) if the originating user identified by the MCData ID is not affiliated to the group identity contained in the SIP INVITE request, as specified in subclause 6.3.5, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; +- h) shall determine targeted group members for MCData communications by following the procedures in subclause 6.3.4; +- j) if the procedures in subclause 6.3.4 result in no affiliated members found in the selected MCData group, shall return a SIP 403 (Forbidden) response with the warning text set to "198 no users are affiliated to this group" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and +- k) shall invite each group member determined in step h) above, to the group session, as specified in subclause 10.2.5.4.3; and +- l) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 7.3. + +Upon receiving a SIP 200 (OK) response for a SIP INVITE request as specified in subclause 10.2.5.4.3 and if the MCData ID in the SIP 200 (OK) response matches to the MCData ID in the corresponding SIP INVITE request the controlling MCData function: + +- 1) shall generate SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [5]; + +- 2) shall include the option tag "timer" in a Require header field; +- 3) shall include the Session-Expires header field and start supervising the SIP session according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". The "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 4) shall include a P-Asserted-Identity header field with the public service identity of the controlling MCData function; +- 5) shall include a SIP URI for the MCData session identity in the Contact header field identifying the MCData session at the controlling MCData function; +- 6) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.fd media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; and + - c) the isfocus media feature tag; +- 7) shall include Warning header field(s) received in incoming responses to the SIP INVITE request; +- 8) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the subclause 10.2.5.4.2; +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15] subclause 7.3; and +- 10) shall send a SIP 200 (OK) response to the inviting MCData client according to 3GPP TS 24.229 [5]. + +--- + +## 11 Transmission and Reception Control + +### 11.1 General + +The MCData functional entities (as specified in subclause 5.2 and subclause 5.3) check if the MCData user is allowed to initiate MCData communications by following the procedures specified below: + +- 1) if the MCData user wishes to send one-to-one MCData communications and the element of an element is not present in the MCData user profile document or is present with the value "false" (see the MCData user profile document in 3GPP TS 24.484 [12]), the MCData client and participating MCData function shall determine that the MCData user is not allowed to send MCData communications and shall not continue with the rest of the steps; +- 1A) if the MCData user wishes to initiate one-to-one MCData communications, the element exists in the MCData user profile document with one more elements, and the "uri" attribute of the element of the application/resource-lists MIME body does not match with one of the elements of the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]), the MCData client and participating MCData function shall determine that the MCData user is not allowed to initiate MCData communication to the targeted user and shall not continue with the rest of the steps; +- 2) if the MCData user wishes to send group MCData communications on an MCData group identity and the element of an element is not present in the MCData group document or is present with the value "false" as specified in 3GPP TS 24.481 [11], the MCData client and controlling MCData function shall determine that the MCData user is not allowed to send group MCData communications on this group identity, and shall not continue with the rest of the steps; +- 3) if the MCData user wishes to send one-to-one SDS communications and the size of the payload is greater than the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12], the MCData client and controlling MCData function shall determine that the MCData user is not allowed to send SDS communications due to message size and shall not continue with the rest of the steps; + +- 4) if the MCData user wishes to send one-to-one FD communications and the size of the data that the MCData user wishes to send is greater than the value contained in the element in the MCData service configuration document as specified in 3GPP TS 24.484 [12], the MCData client and controlling MCData function shall determine that the MCData user is not allowed to send FD communications due to file size and shall not continue with the rest of the steps; +- 5) if the MCData user wishes to send group SDS communications on an MCData group identity and the size of the data that the MCData user wishes to send is greater than the value contained in the element in the MCData group document for the MCData group ID as specified in 3GPP TS 24.481 [11], then the MCData client and the controlling MCData function shall determine that the MCData user is not allowed to send SDS communications on this group identity due to message size and shall not continue with the rest of the steps; +- 6) if the MCData user wishes to send group FD communications on an MCData group identity and the size of the data that the MCData user wishes to send is greater than the value contained in the element in the MCData group document for the MCData group ID as specified in 3GPP TS 24.481 [11], then the MCData client and the controlling MCData function shall determine that the MCData user is not allowed to send FD communications on this group identity due to file size and shall not continue with the rest of the steps; +- 7) if the MCData user wishes to send one-to-one MCData communications to another MCData user and the size of the payload is greater than the maximum amount of data that the MCData user can transmit in a single request during one-to-one communications contained in the element of the MCData user profile document (see the MCData user profile document in 3GPP TS 24.484 [12]), the MCData client and participating MCData function shall determine that the MCData user is not allowed to send one-to-one MCData communications due to exceeding the maximum amount of data that can be sent in a single request and shall not continue with the rest of the steps; +- 8) if the MCData user wishes to send group MCData communications on an MCData group identity and the size of the payload is greater than the maximum amount of data that the MCData user can transmit in a single request during group communications in the group identified by the MCData group identity in the request contained in the element of the element of the MCData group document as specified in 3GPP TS 24.481 [11], the MCData client and the controlling MCData function shall determine that the MCData user is not allowed to send group MCData communications on this group identity due to exceeding the maximum amount of data that can be sent in a single request and shall not continue with the rest of the steps; +- 9) if the MCData user wishes to initiate a SDS session for later use with one-to-one MCData communications there are no further checks for the MCData client which shall continue at step 11). If, for either the originating user or the terminating user, the element of an element is not present in the MCData user profile document or is present with the value "false" (see the MCData user profile document in 3GPP TS 24.484 [12]), the participating MCData function shall determine that the MCData user is not allowed to initiate a SDS session and shall not continue with the rest of the steps; +- 10) if the MCData user wishes to initiate a SDS session on an MCData group identity and the element of a element is not present in the MCData group document or is present with the value "false" as specified in 3GPP TS 24.481 [11], the MCData client and controlling MCData function shall determine that the MCData user is not allowed to initiate a SDS session on this group identity and shall not continue with the rest of the steps; +- 11) if the MCData user wishes to initiate an IP Connectivity session with one-to-one MCData communications and the element of an element is not present in the MCData user profile document or is present with the value "false" as specified in 3GPP TS 24.484 [12], the MCData client and controlling MCData function shall determine that the MCData user is not allowed to initiate an IP Connectivity session and shall not continue with the rest of the steps; and +- 12) the MCData functional entity shall determine that the MCData user is allowed to initiate MCData communications. + +## 11.2 Auto-receive for File Distribution + +If the controlling MCData function receives a one-to-one file distribution using HTTP or a group standalone file distribution using HTTP without the mandatory download indication the controlling MCData function: + +- 1) if the file distribution request contained metadata, shall retrieve the filesize contained in the fileselector of the Metadata IE in the FD request; +- 2) if the file distribution request did not contain metadata, shall determine the size of the file referenced by the file URL contained in FD request; +- 3) for one-to-one file distribution using HTTP, shall determine if the filesize is less than or equal to the value contained in the element of the MCData service configuration document as specified in 3GPP TS 24.484 [12]; +- 4) for group standalone file distribution using HTTP, shall determine if the filesize is less than or equal to the value contained the element of the MCData group document associated with the MCData group identity in the request, as specified in 3GPP TS 24.481 [11] +- 5) if condition 3) or 4) is true, shall determine that the mandatory download indication needs to be included in the file distribution request sent to the terminating MCData client; + +## 11.3 Accessing list of deferred data group communications + +### 11.3.1 General + +Accessing list of deferred data group communication allows a MCData user to request for the list of files that have been deferred for future download. The procedures are applicable for FD using HTTP. + +### 11.3.2 MCData client procedures + +#### 11.3.2.1 Sending a request to access a list of deferred group communications + +Upon receiving a request from the MCData user to access the list of deferred data group communications, the MCData client: + +- 1) shall build the SIP MESSAGE request as specified in subclause 6.2.4.1; +- 2) shall generate DEFERRED DATA REQUEST message as specified in subclause 15.1.11.1; +- 3) shall include in the SIP request, the DEFERRED DATA GROUP COMM message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and +- 4) shall send the SIP MESSAGE request towards the participating MCData function according to rules and procedures of 3GPP TS 24.229 [5]. + +#### 11.3.2.2 Receiving a list of deferred group communications + +Upon receipt of a "SIP MESSAGE response for the list of deferred group communications request", the MCData client: + +- 1) shall generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; +- 2) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]; +- 3) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body: + - a) if the application/vnd.3gpp.mcdata-signalling MIME body contains DEFERRED DATA RESPONSE message as specified in subclause 15.1.12: + - i) for each payload, if payload type is set to "FILEURL", shall store the payload data; and +- 4) shall present to MCData user, the list of file URLs which were deferred. + +### 11.3.3 Participating MCData function procedures + +#### 11.3.3.1 Receiving a request to access a list of deferred group communications + +Upon receipt of a "SIP MESSAGE request for the list of deferred group communications", the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; +- 2) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and +- 3) shall follow the procedure described in subclause 11.3.3.2 to send response. + +#### 11.3.3.2 Sending a list of deferred group communications + +To send the list of deferred group communications, the participating MCData function: + +- 1) shall build the SIP MESSAGE request as specified in subclause 6.3.2.1; +- 2) shall generate DEFERRED DATA RESPONSE message as specified in subclause 15.1.12.1; +- 3) shall include in the SIP request, the DEFERRED DATA RESPONSE message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and +- 4) shall send the SIP MESSAGE request towards the participating MCData function according to rules and procedures of 3GPP TS 24.229 [5]. + +When generating a DEFERRED DATA RESPONSE message as specified in subclause 15.1.12, the MCData client: + +- 1) shall set the number of payloads IE to the number of FD using HTTP communication which are deferred as per the stored file list: + - a) for each deferred file from the list, shall copy the payload IE value from the stored list to the payload IE value of the outgoing message being generated; + +--- + +## 12 Dispositions and Notifications + +### 12.1 General + +The procedures in clause 12 describe: + +- the on-network procedures for generating out-of-band dispositions for on-network SDS and on-network FD; +- the on-network procedures for generating network notifications for file distribution; and +- the off-network procedures for generating SDS dispositions. + +The MCData client can send a disposition notification as a direct result of receiving an MCData message (e.g. delivery notification) or can send a disposition notification at a later time (e.g. read notification). In certain circumstances the delivery and read notification can be delivered in one notification message. + +In-band dispositions are sent in the media plane as specified in 3GPP TS 24.582 [15]. + +### 12.2 On-network disposition notifications + +#### 12.2.1 MCData client procedures + +##### 12.2.1.1 MCData client sends a disposition notification message + +The MCData client shall follow the procedures in this subclause to: + +- indicate to an MCData client that an SDS message was delivered, read or delivered and read when the originating client requested a delivery, read or delivery and read report; + +- indicate to the participating MCData function serving the MCData user that an SDS message was undelivered. The participating MCData function can store the message for later re-delivery; +- indicate to an MCData client that a request for FD was accepted, deferred or rejected; or +- indicate to an MCData client that a file download has been completed; + +Before sending a disposition notification the MCData client needs to determine: + +- the group identity related to an SDS or FD message request received as part of a group communication. The MCData client determines the group identity from the contents of the element contained in the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SDS or FD message request; and +- the MCData user targeted for the disposition notification. The MCData client determines the targeted MCData user from the contents of the element contained in the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SDS or FD message request. + +The MCData client shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] with the clarifications given below. + +The MCData client: + +- 1) shall build the SIP MESSAGE request as specified in subclause 6.2.4.1; +- 2) shall follow the rules specified in subclause 6.4 for the handling of MIME bodies in a SIP message when processing the remaining steps in this subclause; +- 3) shall insert in the SIP MESSAGE request an application/resource-lists+xml MIME body containing the MCData ID of the targeted MCData user, according to rules and procedures of IETF RFC 5366 [18]; +- 4) void; +- 5) if sending a disposition notification in response to an MCData group data request, shall include an element set to the MCData group identity in the application/vnd.3gpp.mcdata-info+xml MIME body; +- 6) if requiring to send an SDS notification, shall generate an SDS NOTIFICATION message and include it in the SIP MESSAGE request as specified in subclause 6.2.3.1; +- 7) if requiring to send an FD notification, shall generate an FD NOTIFICATION message and include it in the SIP MESSAGE request as specified in subclause 6.2.3.2; and +- 8) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]. + +### 12.2.1.2 MCData client receives a disposition notification message + +Upon receipt of a: + +- "SIP MESSAGE request for SDS disposition notification for terminating MCData client"; or +- "SIP MESSAGE request for FD disposition notification for terminating MCData client"; + +the MCData client: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) shall deliver the notification to the user or application. + +## 12.2.2 Participating MCData function procedures + +### 12.2.2.1 Participating MCData function receives disposition notification from a MCData user + +Upon receipt of a: + +- "SIP MESSAGE request for SDS disposition notification for MCData server"; or +- "SIP MESSAGE request for FD disposition notification for MCData server"; + +the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP MESSAGE request; + +NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. + +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; +- 4) void; +- 5) if the SIP MESSAGE is a "SIP MESSAGE request for SDS disposition notification for MCData server" containing an SDS disposition notification type set to a value of "UNDELIVERED", shall temporarily store the message for re-delivery, shall start timer TD1 (SDS re-delivery timer) with the timer value as specified in subclause F.2.1, and shall not continue with the remaining steps; + +NOTE: The participating MCData function attempts re-delivery of the SDS message after timer TD1 (SDS re-delivery timer) expiry. + +- 6) if the SIP MESSAGE is a "SIP MESSAGE request for SDS disposition notification for MCData server " containing an SDS disposition notification type set to a value of "DELIVERED", "READ" or "DELIVERED AND READ" and the message was temporarily stored for re-delivery, shall delete the message from temporary store and shall stop TD1 (SDS re-delivery timer); +- 7) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 8) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the controlling MCData function; + +NOTE: How the participating MCData function determines the controlling MCData function to forward notification message is out of scope of the present document. + +- 9) shall copy all MIME bodies included in the incoming SIP MESSAGE request to the outgoing SIP MESSAGE request; +- 10) if not already included as part of step 8) above, shall include an application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request, containing an element set to the MCData ID of the originating user; +- 11) if the SIP MESSAGE is a "SIP MESSAGE request for SDS disposition notification for MCData server ", shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; +- 12) if the SIP MESSAGE is a "SIP MESSAGE request for FD disposition notification for MCData server ", shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; +- 13) if the SIP MESSAGE is a "SIP MESSAGE request for FD disposition notification for MCData server", and the FD disposition notification type IE is set as "FILE DOWNLOAD REQUEST ACCEPTED" or "FILE DOWNLOAD REQUEST REJECTED" as specified in subclause 15.2.6, shall remove the file from the stored file list; + +- 14) shall set the P-Asserted-Identity in the outgoing SIP MESSAGE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP MESSAGE request; and +- 15) shall send the SIP MESSAGE request as specified to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 202 (Accepted) response in response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP 202 (Accepted) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 202 (Accepted) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; and +- 2) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP MESSAGE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +#### 12.2.2.2 Participating MCData function receives disposition notification from a Controlling MCData function + +Upon receipt of a: + +- "SIP MESSAGE request for SDS disposition notification for terminating MCData client"; or +- "SIP MESSAGE request for FD disposition notification for terminating MCData client"; + +the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or if a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response, optionally containing a Retry-After header field as specified in IETF RFC 3261 [4]. In this case, the participating MCData function shall skip the rest of the steps; +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request to retrieve the binding between the MCData ID and the public user identity; +- 3) if the binding between the MCData ID and the public user identity does not exist, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response and shall skip the rest of the steps; +- 4) shall generate an outgoing SIP MESSAGE request as specified in subclause 6.3.2.1; +- 5) if sending an SDS disposition notification, shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; +- 5) if sending an FD disposition notification, shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP MESSAGE request; +- 6) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 2xx, 4xx, 5xx or 6xx response to the outgoing SIP MESSAGE request, the participating MCData function shall forward the SIP response to the controlling MCData function. + +### 12.2.3 Controlling MCData function procedures + +Upon receipt of a: + +- "SIP MESSAGE request for SDS disposition notification for MCData server"; or +- "SIP MESSAGE request for FD disposition notification for MCData server"; + +the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4]. Otherwise, continue with the rest of the steps; +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" or "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; +- 3) if the incoming SIP MESSAGE request does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; +- 4) shall attempt to correlate the disposition notification to the original SDS or FD request using the values contained in the Conversation ID and Message ID of the SDS NOTIFICATION message or FD NOTIFICATION message contained in the application/vnd.3gpp.mcdata-signalling MIME body of the SIP MESSAGE; +- 5) if unable to correlate the disposition notification as determined by step 4), shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response including warning text set to "216 unable to correlate the disposition notification" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; +- 6) if: + - a) a "SIP MESSAGE request for FD disposition notification for MCData server" has been received; + - b) the FD disposition notification type IE in the FD NOTIFICATION message is set to "FILE DOWNLOAD REQUEST REJECTED"; and + - c) the SIP MESSAGE does not contain an application/vnd.3gpp.mcdata-info+xml MIME body with an element, or the SIP MESSAGE contains an application/vnd.3gpp.mcdata-info+xml MIME body with an element and all other FD disposition notifications have been received from the invited group members and were all set to "FILE DOWNLOAD REQUEST REJECTED"; + +then: + +- a) shall delete the file stored in the media storage function that is associated with the Conversation ID and Message ID that was included in the FD NOTIFICATION message if no other file availability timers are running for a file;and + - b) shall stop the running timer TDC2 (file availability timer), which is associated to the Conversation ID, Message ID, Application ID (if associated), and Extended application ID (if associated) that is included in the FD NOTIFICATION message; +- 7) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; + - 8) if sending an SDS disposition notification: + - a) shall include an Accept-Contact header field containing the g.3gpp.mcdata.sds media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; + +- b) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] ] in the outgoing SIP MESSAGE request; + - 9) if sending an FD disposition notification: + - a) shall include an Accept-Contact header field containing the g.3gpp.mcdata.fd media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + - b) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; + - 10) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; +- NOTE 1: How the controlling MCData function finds the address of the terminating MCData participating function is out of the scope of the current release. +- 11) if sending an SDS disposition notification, shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds"; + - 12) if sending an FD disposition notification, shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; + - 13) shall copy the public user identity of the calling MCData user from the P-Asserted-Identity header field of the incoming SIP MESSAGE request into the P-Asserted-Identity header field of the outgoing SIP MESSAGE request; + - 14) shall copy the MCData ID of the MCData user listed in the MIME resources body of the incoming SIP MESSAGE request, into the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP MESSAGE request; + - 15) if the incoming SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with an element: + - a) shall retrieve the group document for the MCData group id contained in the element from the group management server, if not already cached, and identify the group members; + - b) shall verify that the MCData ID contained in the element matches to a group member. If there is no match, the controlling MCData function shall reject the SIP request with a SIP 403 (Forbidden) response including warning text set to "116 user is not part of the MCData group" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; + - c) if MCData disposition notifications need to be aggregated and an aggregated disposition notification has not yet been sent: + - i) if timer TDC1 (disposition aggregation timer) is not running, shall start timer TDC1 (disposition aggregation timer) with the timer value as specified in subclause F.2.2; + - ii) shall copy the application/vnd.3gpp.mcdata-signalling MIME body in the received SIP MESSAGE request to the outgoing SIP MESSAGE request; +- NOTE 2: If the aggregated MCData disposition notifications do not fit into one SIP MESSAGE request, then the controlling MCData function needs to generate a new SIP MESSAGE request for the remaining disposition notifications. +- iii) on expiry of timer TDC1 (disposition aggregation timer) shall continue with step 16; and + - iv) if all MCData disposition notifications have been received from all group members shall continue with step 16; and + - d) if MCData disposition notifications do not need to be aggregated, shall copy the application/vnd.3gpp.mcdata-signalling MIME body in the received SIP MESSAGE request to the outgoing SIP MESSAGE request and shall continue with step 16; + +- 16) if the incoming SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body without an element shall copy the application/vnd.3gpp.mcdata-signalling MIME body in the received SIP MESSAGE request to the outgoing SIP MESSAGE request; +- 17) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [5]; +- 18) shall generate a SIP 202 (Accepted) response in response to the + - "SIP MESSAGE request for SDS disposition notification for MCData server"; or + - "SIP MESSAGE request for FD disposition notification for MCData server"; and +- 19) shall send the SIP 202 (Accepted) response towards the originating participating MCData function according to 3GPP TS 24.229 [5]. + +## 12.3 Off-network dispositions + +### 12.3.1 General + +### 12.3.2 Sending off-network SDS delivery notification + +To send an off-network SDS delivery notification, the MCData client: + +- 1) shall store "DELIVERED" as the disposition type; +- 2) shall generate a SDS OFF-NETWORK NOTIFICATION message as specified in subclause 15.1.8. In the SDS OFF-NETWORK NOTIFICATION message, the MCData client: + - a) shall set the Sender MCData user ID IE to its own MCData user ID as specified in subclause 15.2.15; + - b) shall set the Conversation ID IE as the stored conversation ID as specified in subclause 15.2.9; + - c) shall set the Message ID IE as the stored SDS message ID as specified in subclause 15.2.10; + - d) shall set the Date and time IE as the stored SDS notification time as specified in subclause 15.2.8; + - e) shall set the SDS disposition notification type IE to the stored disposition type as specified in subclause 15.2.5; and + - f) may set: + - i) the Application ID IE to the stored SDS application ID as specified in subclause 15.2.7; or + - ii) the Extended application ID IE to the stored extended SDS application ID as specified in subclause 15.2.24; +- 3) shall send the SDS OFF-NETWORK NOTIFICATION message to the stored notification target MCData user ID as specified in subclause 9.3.1.1; +- 4) shall initialise the counter CFS2 (SDS notification retransmission) with the value set to 1; and +- 5) shall start timer TFS2 (SDS notification retransmission). + +### 12.3.3 Sending off-network SDS read notification + +Upon receiving a display indication for the payload to the user or processing of the payload by the target application, the MCData client: + +- 1) shall store "READ" as the disposition type; +- 2) shall store the current UTC time as the stored SDS notification time; +- 3) shall generate SDS OFF-NETWORK NOTIFICATION message as specified in subclause 15.1.8. In the SDS OFF-NETWORK NOTIFICATION message, the MCData client: + - a) shall set the Sender MCData user ID IE to its own MCData user ID as specified in subclause 15.2.15; + +- b) shall set the Conversation ID IE as the stored conversation ID as specified in subclause 15.2.9; + - c) shall set the Message ID IE as the stored SDS message ID as specified in subclause 15.2.10; + - d) shall set the Data and time IE as the SDS notification time as specified in subclause 15.2.8; + - e) shall set the SDS disposition notification type IE to the stored disposition type as specified in subclause 15.2.5; and + - f) may set: + - i) the Application ID IE set to the stored SDS application ID as specified in subclause 15.2.7; or + - ii) the Extended application ID IE to the stored extended SDS application ID as specified in subclause 15.2.24; +- 4) shall send the SDS OFF-NETWORK NOTIFICATION message to the stored sender MCData user ID as specified in subclause 9.3.1.1; + - 5) shall initialise the counter CFS2 (SDS notification retransmission) with the value set to 1; and + - 6) shall start timer TFS2 (SDS notification retransmission). + +### 12.3.4 Sending off-network SDS delivered and read notification + +Upon receiving a display indication for the payload to the user or processing of the payload by the target application, the MCData client: + +- 1) shall store "DELIVERED AND READ" as the disposition type and stop the timer TFS3 (display and read); +- 2) shall store the current UTC time as the stored SDS notification time; +- 3) shall generate SDS OFF-NETWORK NOTIFICATION message. In the SDS OFF-NETWORK NOTIFICATION message, the MCData client: + - a) shall set the Sender MCData user ID IE to its own MCData user ID as specified in subclause 15.2.15; + - b) shall set the Conversation ID IE as the stored conversation ID as specified in subclause 15.2.9; + - c) shall set the Message ID IE as the stored SDS message ID as specified in subclause 15.2.10; + - d) shall set the Date and time IE as the SDS notification time as specified in subclause 15.2.8; + - e) shall set the SDS disposition notification type IE to the stored disposition type as specified in subclause 15.2.5; and + - f) may set: + - i) the Application ID IE to the stored SDS application ID as specified in subclause 15.2.7; or + - ii) the Extended application ID IE to the stored extended SDS application ID as specified in subclause 15.2.24; +- 4) shall send the SDS OFF-NETWORK NOTIFICATION message to the stored sender MCData user ID as specified in subclause 9.3.1.1; +- 5) shall initialise the counter CFS2 (SDS notification retransmission) with the value set to 1; and +- 6) shall start timer TFS2 (SDS notification retransmission). + +### 12.3.5 Off-network SDS notification retransmission + +Upon expiry of timer TFS2 (SDS notification retransmission), the MCData client: + +- 1) shall generate a SDS OFF-NETWORK NOTIFICATION message as specified in subclause 15.1.8. In the SDS OFF-NETWORK NOTIFICATION message, the MCData client: + +- a) shall set the Sender MCData user ID IE to its own MCData user ID as specified in subclause 15.2.15; + - b) shall set the Conversation ID IE as the stored conversation ID as specified in subclause 15.2.9; + - c) shall set the Message ID IE as the stored SDS message ID as specified in subclause 15.2.10; + - d) shall set the Date and time IE as the stored SDS notification time as specified in subclause 15.2.8; + - e) shall set the SDS disposition type IE to the stored disposition type as specified in subclause 15.2.5; and + - f) may set: + - i) the Application ID IE to the stored SDS application ID as specified in subclause 15.2.7; or + - ii) the Extended application ID IE to the stored extended SDS application ID as specified in subclause 15.2.24; +- 2) shall send the SDS OFF-NETWORK NOTIFICATION message to the stored sender MCData user ID as specified in subclause 9.3.1.1; +- 3) shall increment the counter CFS2 (SDS notification retransmission) by 1; and +- 4) shall start timer TFS2 (SDS notification retransmission) if the associated counter CFS2 (SDS notification retransmission) has not reached its upper limit. + +## 12.4 Network-triggered notifications for FD + +### 12.4.1 General + +#### 12.4.1.1 File availability expiry + +When the controlling MCData function receives a "SIP MESSAGE request for FD using HTTP for controlling MCData function" (referred to as FD request), it starts a timer TDC2 (file availability timer). The timer value is derived from the "file availability" information contained in metadata in the FD request (if included) or by local policy. The timer running for the file is uniquely associated to the Conversation ID and Message ID in the FD request. + +The controlling MCData function tracks which MCData client(s) have downloaded the file referenced by the file URL received in an FD request which is associated to a Conversation ID and Message ID. On expiry of timer TDC2 (file availability timer), the controlling MCData function sends a FD NETWORK NOTIFICATION message with a notification type set to "FILE EXPIRED UNAVAILABLE TO DOWNLOAD". The MCData client is notified that the file associated with the Conversation ID and Message ID is no longer available to download. + +### 12.4.2 Controlling MCData function procedures + +#### 12.4.2.1 Generation of a SIP MESSAGE request for notification + +This subclause is referenced from other procedures and is not run standalone. + +The controlling MCData function + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.fd media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 3) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 4) shall follow the rules specified in subclause 6.4 for the handling of MIME bodies in a SIP message when processing the remaining steps in this subclause; +- 5) shall include in an application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP MESSAGE request: + +- the element set to the MCData ID of the MCData user; and + - the element set to a value of "notify"; +- 6) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; + - 7) shall include the public service identity of the controlling MCData function in the P-Asserted-Identity header field; and + - 8) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd". + +#### 12.4.2.2 Expiry of timer TDC2 (file availability timer) + +When timer TDC2 (file availability timer) associated to a specific Conversation ID and Message ID expires, the controlling MCData function shall identify a target set of MCData client(s) as being: + +- the MCData client that received a one-to-one file distribution using HTTP for the associated Conversation ID and Message ID, but has not yet downloaded the file; or +- each MCData client that received a group standalone file distribution using HTTP for the associated Conversation ID and Message ID, but have not yet downloaded the file; + +On expiry of timer TDC2 (file availability timer), for each identified MCData client, the controlling MCData function: + +NOTE: The file availability timer is associated to the Conversation ID and Message ID that was present in the initial FD request. + +- 1) shall generate a SIP MESSAGE request as specified in subclause 12.4.2.1; +- 2) shall include an FD NETWORK NOTIFICATION message in an application/vnd.3gpp.mcdata-signalling MIME body of the SIP MESSAGE request with: + - a) the FD notification type IE as "FILE EXPIRED UNAVAILABLE TO DOWNLOAD" as specified in subclause 15.2.6; + - b) shall set the Date and time IE to the current time as specified in subclause 15.2.8; + - c) the Conversation ID IE set to a value identifying the conversation, as specified in subclause 15.2.9; + - d) the Message ID IE set to a value identifying the message as specified in subclause 15.2.10; + - e) if an Application ID was stored against the expired timer TDC2 (file availability timer), shall set the Application ID to the stored value as specified in subclause 15.2.7; + - f) if an Extended application ID was stored against the expired timer TDC2 (file availability timer), shall set the Extended application ID to the stored value as specified in subclause 15.2.7; and +- 3) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [5]. + +#### 12.4.3 Participating MCData function procedures + +The participating MCData function shall follow the procedures in subclause 10.2.4.3.2. + +#### 12.4.4 MCData client terminating procedures + +On receipt of a SIP MESSAGE request containing an application/vnd.3gpp.mcdata-signalling MIME body with a FD NETWORK NOTIFICATION message, the MCData client: + +- 1) may reject the SIP MESSAGE request if there are not enough resources to handle the SIP MESSAGE request; +- 2) if the SIP MESSAGE request is rejected in step 1), shall respond towards the participating MCData function with a SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this subclause; +- 3) shall generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; + +- 4) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]; +- 5) shall decode the contents of the FD NETWORK NOTIFICATION message contained in the application/vnd.3gpp.mcdata-signalling MIME body; +- 6) if the FD NETWORK NOTIFICATION message contains an Application ID or contains an Extended application ID, shall deliver the FD NETWORK NOTIFICATION message to the application; and +- 7) if the FD NETWORK NOTIFICATION message does not contain an Application ID and does not contain an Extended application ID, shall deliver the FD NETWORK NOTIFICATION message to the user. + +--- + +## 13 Communication Release + +### 13.1 General + +Communication Release allows MCData user or MCData server to release MCData communications on-demand or based on policies. These procedures are applicable for SDS and FD and can be initiated by communication originator or MCData server. + +### 13.2 On-network + +#### 13.2.1 General + +##### 13.2.1.1 Server generating message for release of communication over HTTP towards participating MCData function + +This procedure is only referenced from other procedures. In order to generate a SIP MESSAGE towards the participating MCData function, the MCData server: + +- 1) shall generate SIP MESSAGE accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 3) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; +- 4) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the participating MCData function associated to the originating MCData ID user; and +- 5) shall include an application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, following the rules specified in subclause 6.4 for the handling of MIME bodies in a SIP message: + - a) fill element with the MCData ID of the target user. +- 6) shall include FD HTTP TERMINATION in application/vnd.3gpp.mcdata-signalling. + +While generating an FD HTTP TERMINATION message as specified in subclause 15.1.3.1, the MCData server: + +- 1) shall set the Conversation ID\_IE to a value identifying the conversation, as specified in subclause 15.2.9; +- 2) shall set the Message ID\_IE to a value identifying the message as specified in subclause 15.2.10; +- 3) may set: + - i) the Application ID\_IE to the stored value if applicable; or + - ii) the Extended application ID\_IE to the stored value if applicable; and +- 4) shall include a Payload IE with: + - a) the Payload content type set to "FILEURL" as specified in subclause 15.2.13; and + +- b) Shall set the URL of the file same as of FD transmission. + +### 13.2.1.2 Authorised user generating FD HTTP TERMINATION MESSAGE towards participating MCData function + +This clause is referred from other clause only. In order to generate a SIP MESSAGE towards participating MCData function: + +- 1) Shall generate SIP MESSAGE accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" along with parameters "require" and "explicit" according to IETF RFC 3841 [8] in the outgoing SIP MESSAGE request; +- 3) shall include a P-preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; +- 4) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the participating MCData function associated to the MCData ID user; and +- 5) shall include an application/vnd.3gpp.mcdata-info+xml MIME body in the SIP MESSAGE request, following the rules specified in subclause 6.4 for the handling of MIME bodies in a SIP message: + - a) set element to the MCData ID of the target user; and + - b) shall include FD HTTP TERMINATION application/vnd.3gpp.mcdata-signalling. While including FD HTTP TERMINATION message according to subclause E.1. + +When generating an FD HTTP TERMINATION message as specified in subclause 15.1.11, the MCData client: + +- 1) shall set the Conversation ID IE to a value identifying the conversation, as specified in subclause 15.2.9; +- 2) shall set the Message ID IE to a value identifying the message as specified in subclause 15.2.10; +- 3) may set: + - i) the Application ID IE ID to the stored value if applicable; or + - ii) the Extended Application ID IE to the stored value if applicable; and +- 4) shall include a Payload IE with: + - a) the Payload content type set to "FILEURL" as specified in subclause 15.2.13; and + - b) the URL of the file same as of FD transmission. + +## 13.2.2 MCData originating user initiated communication release + +### 13.2.2.1 General + +The MCData client can release the communication to indicate MCData service that the user no longer wants to transmit. + +### 13.2.2.2 Release of MCData communication over media plane + +#### 13.2.2.2.1 General + +The procedures described in this subclause are applicable to MCData SDS and MCData FD using media plane where originating MCData user initiates the communication release. + +#### 13.2.2.2.2 MCData client procedures + +##### 13.2.2.2.2.1 MCData client originating procedures + +When the MCData client wants to release a MCData communication established over the media plane, the MCData client: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5]; + +- 2) shall set the Request-URI to the MCData session identity to be released; and +- 3) shall send the SIP BYE request towards MCData server according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request, the MCData client shall release all media plane resources corresponding to the MCData communication being released. + +#### 13.2.2.2.2.2 MCData client terminating procedures + +Upon receiving a SIP BYE request, the MCData client: + +- 1) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and +- 2) shall release all media plane resources corresponding to the MCData communication being released. + +NOTE: Partially received data can be stored and processed. + +#### 13.2.2.2.3 Participating MCData function procedures + +##### 13.2.2.2.3.1 Originating participating MCData function procedures + +Upon receiving a SIP BYE request from the MCData client, the originating participating MCData function: + +- 1) shall generate a SIP BYE request as specified in 3GPP TS 24.229 [5]; +- 2) shall set the Request-URI to the MCData session identity mentioned in the received SIP BYE request; +- 3) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP BYE request to the P-Asserted-Identity header field of the outgoing SIP BYE request; and +- 4) shall send the SIP BYE request toward the controlling MCData function, according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the participating MCData function; + +- 1) shall forward the SIP 200 (OK) response to the originating MCData client and release all media plane resources corresponding to the MCData communication with the originating MCData client; and +- 2) shall release all media plane resources corresponding to the MCData communication with the controlling MCData function. + +##### 13.2.2.2.3.2 Terminating participating MCData function procedures + +Upon receiving a SIP BYE request from the controlling MCData function, the participating MCData function: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5]; +- 2) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP BYE request to the P-Asserted-Identity header field of the outgoing SIP BYE request; and +- 3) shall send the SIP BYE request to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the participating MCData function: + +- 1) shall send the SIP 200 (OK) response to the SIP BYE request received from the controlling MCData function according to 3GPP TS 24.229 [5] and release all media plane resources corresponding to the MCData communication with the controlling MCData function; and +- 2) shall release all media plane resources corresponding to the MCData communication with the terminating MCData client. + +#### 13.2.2.2.4 Controlling MCData function procedures + +##### 13.2.2.2.4.1 Communication release policy for group MCData communication + +The controlling MCData function shall release the group MCData communication, if: + +- 1) the controlling MCData function receives an indication from the media plane that the transmission time limit has reached; +- 2) the controlling MCData function receives an indication from the media plane that the transmission data limit per request has reached; +- 3) there are only one or no participants in the MCData communication; +- 4) according to a local policy, the initiator of the group call leaves the MCData communication; or +- 5) the minimum number of affiliated MCData group members is not present; + +#### 13.2.2.2.4.2 Communication release policy for one-to-one MCData communication + +The controlling MCData function shall release the one-to-one MCData communication if: + +- 1) the controlling MCData function receives an indication from the media plane that the transmission time limit has reached; +- 2) the controlling MCData function receives an indication from the media plane that the transmission data limit per request has reached; or +- 3) there are only one or no participants in the MCData communication. + +#### 13.2.2.2.4.3 Receiving a SIP BYE request + +Upon receiving a SIP BYE request the controlling MCData function: + +- 1) shall release all media plane resources corresponding to the MCData communication with the originating participating MCData function; +- 2) shall generate a SIP 200 (OK) response and send the SIP response towards the originating MCData client according to 3GPP TS 24.229 [5]; +- 3) shall check the communication release policy as specified in subclause 13.2.2.2.4.1 and subclause 13.2.2.2.4.2 whether the MCData communication needs to be released for each participant of the MCData communication; and +- 4) if release of the MCData communication is required, perform the procedures as specified in the subclause 13.2.2.2.4.4. + +#### 13.2.2.2.4.4 Sending a SIP BYE request + +When a participant needs to be removed from the MCData communication, the controlling MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] for the MCData communication release; +- 2) shall generate a SIP BYE request according to 3GPP TS 24.229 [5]; and +- 3) shall send the SIP BYE request to the MCData client according to 3GPP TS 24.229 [5]. + +If group MCData communication needs to be released, the controlling MCData function shall send SIP BYE requests as described in this subclause to all the participants of the communication. + +Upon receiving a SIP 200 (OK) response to a SIP BYE request, the controlling MCData function shall release all media plane resources corresponding to the MCData communication with the terminating participating MCData function. + +### 13.2.2.3 Release of MCData communication over HTTP + +#### 13.2.2.3.1 General + +The procedures described in this subclause are applicable to MCData FD using HTTP where originating MCData user initiates the communication release. This procedure applicable after file upload happened successfully and originating client sends SDS message towards server. + +### 13.2.2.3.2 MCData client procedures + +#### 13.2.2.3.2.1 MCData client originating procedures + +##### 13.2.2.3.2.1.1 Initiating Release + +When MCData client wants to release MCData communication either one-to-one FD or group-FD established over HTTP, the MCData client shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] with the clarifications given below. + +The MCData client: + +- 1) shall build the SIP MESSAGE request as specified in subclause 6.2.4.1; +- 2) if terminating one-to-one FD transmission, shall insert in the SIP MESSAGE request: + - a) an application/resource-lists+xml MIME body with the MCData ID of the recipient of FD transmission, according to rules and procedures of IETF RFC 4826 [9]; and + - b) an application/vnd.3gpp.mcdata-info+xml MIME body with a element set to a value of "one-to-one-fd"; +- 3) if terminating group FD transmission: + - a) shall insert in the SIP MESSAGE request an application/vnd.3gpp.mcdata-info+xml MIME body with: + - i) the element set to a value of "group-fd"; + - ii) the element set to the MCData group identity for which FD transmission happening; and + - iii) the element set to the MCData client ID of the originating MCData client; +- 4) shall generate a standalone FD message as specified in subclause 6.2.2.4; and +- 5) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5] towards originating participating function. + +##### 13.2.2.3.2.1.2 Receiving Release Response Type from server + +Upon receiving SIP MESSAGE from server containing application/vnd.3gpp.mcdata-signalling MIME body with HTTP TERMINATION MESSAGE and FD signalling payload message identity value set as FD HTTP TERMINATION as described in subclause 15.2.2 then + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; +- 2) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]; +- 3) if FD HTTP TERMINATION message contains an Application ID or contains an Extended Application ID, shall deliver the FD HTTP TERMINATION message to the application; and +- 4) if Termination information type IE in HTTP TERMINATION MESSAGE is set to "TERMINATION RESPONSE" as specified in subclause 15.2.22 and If Release Response Type IE present then: + - a) set to "RELEASE SUCCESS" as described in subclause 15.2.23 the notify user that termination request is successful; or + - b) set to "RELEASE FAILED" as described in subclause 15.2.23 then notify user that termination request failed. + +#### 13.2.2.3.2.2 MCData client terminating procedures + +On receipt of a SIP MESSAGE request containing an application/vnd.3gpp.mcdata-signalling MIME body with a FD NETWORK NOTIFICATION message, the MCData client shall follow the procedure as described in subclause 12.4.4. + +### 13.2.2.3.3 Participating MCData function procedures + +#### 13.2.2.3.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for originating participating MCData function", the participating MCData function should follow the procedure as describe in subclause 10.2.4.3.1. + +#### 13.2.2.3.3.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for terminating participating MCData function", the participating MCData function should follow the procedure as describe in subclause 10.2.4.3.2. + +#### 13.2.2.3.4 Controlling MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for controlling MCData function", the controlling MCData function should follow the procedure as describe in subclause 10.2.4.4.2. + +## 13.2.3 MCData server initiated communication release without prior indication + +### 13.2.3.1 General + +Based on local policies and conditions explained in subclause 13.2.2.2.4.1 and subclause 13.2.2.2.4.2, MCData server can release an ongoing MCData communication. Based on the configuration, MCData server can decide to release the communication without prior notification to MCData client. + +### 13.2.3.2 Release of MCData communication over media plane + +#### 13.2.3.2.1 General + +The procedures described in this subclause are applicable to MCData SDS and MCData FD using media plane where MCData server initiates communication release. + +#### 13.2.3.2.2 MCData client procedures + +Upon receiving a SIP BYE request from the MCData server, the MCData client should follow the procedure described in subclause 13.2.2.2.2.2 with following clarification: + +- 1) shall notify the MCData user with reason for release of communication if SIP BYE request contains reason header. + +#### 13.2.3.2.3 Participating MCData function procedures + +Upon receiving SIP BYE request from controlling MCData function, the participating MCData function should follow the procedure described in subclause 13.2.2.2.3.2 with following clarification: + +- 1) if reason header is present in the incoming SIP BYE request, shall copy the contents of the reason header field of the incoming SIP BYE request to the reason header field of the outgoing SIP BYE request. + +#### 13.2.3.2.4 Controlling MCData function procedures + +Based on communication release policies and configuration, when controlling MCData function wants to release communication, the controlling MCData function should follow the procedure as described in subclause 13.2.2.2.4.4 with following clarification: + +- 1) shall add reason header with reason-text value as appropriate (e.g. data volume limit, time limit expiry). + +### 13.2.3.3 Release of MCData communication over HTTP + +#### 13.2.3.3.1 General + +This procedure described in this subclause are applicable to MCData FD using HTTP where MCData server initiates communication release. + +### 13.2.3.3.2 MCData client procedures + +#### 13.2.3.3.2.1 MCData client originating procedure + +Upon receiving SIP MESSAGE from MCData server containing an application/vnd.3gpp.mcdata-signalling MIME body, the MCData client: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if application/vnd.3gpp.mcdata-signalling MIME body contains a FD HTTP TERMINATION message as specified in subclause 15.1.11 and if the Termination Information Type IE is set to "TRANSMISSION STOPPED", then: + - a) shall generate a SIP 200 OK response according to 3GPP TS 24.229 [5]; and + - b) shall send the SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and +- 3) shall notify MCData user about file transmission being stopped by identifying the corresponding file transmission local database based on conversation id, message id and FILE URL received in FD HTTP TERMINATION message, along with reason. + +#### 13.2.3.3.2.2 MCData client terminating procedure + +On receipt of a SIP MESSAGE request containing an application/vnd.3gpp.mcdata-signalling MIME body with a FD NETWORK NOTIFICATION message, the MCData client shall follow the procedures as described in subclause 12.4.4. + +### 13.2.3.3.3 Participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for terminating participating MCData function", the participating MCData function shall follow the procedure as described in subclause 10.2.4.3.2. + +### 13.2.3.3.4 Controlling MCData function procedures + +Base on communication release policies and configuration, when controlling MCData function wants to release communication, the controlling MCData function: + +- 1) shall execute procedure as described in subclause 12.4.2.1 to delete the file and notify to participants with following clarification: + - a) shall set FD notification type IE as "FILE DELETED UNAVAILABLE TO DOWNLOAD" as specified in subclause 15.2.18; and +- 2) shall generate SIP MESSAGE as described in subclause 13.2.1.1 and + - a) shall add reason header with reason-text value as appropriate (e.g. data volume limit, time limit expiry); + - b) shall set Termination information type IE of FD HTTP TERMINATION MESSAGE to "TRANSMISSION STOPPED" as described in subclause 15.2.22; and + - c) shall send the SIP MESSAGE to MCData user who initiated the communication according to according to rules and procedures of 3GPP TS 24.229 [5]. + +## 13.2.4 MCData server initiated communication release with prior indication + +### 13.2.4.1 General + +Based on local policies and conditions as mentioned in subclause 13.2.2.2.4.1 and subclause 13.2.2.2.4.2, the MCData server can release an ongoing MCData communication. + +If configured to, the MCData server can notify the originating MCData user about the intent to release communication and may request for more data about the communication it intends to release. The procedures described in this subclause are applicable to MCData SDS and MCData FD using media plane where the MCData server initiates the communication release. + +### 13.2.4.2 MCData client procedures for communication over media plane + +#### 13.2.4.2.1 Receiving intent to release the communication + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the MCData client: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a COMMUNICATION RELEASE message as specified in subclause 15.1.10, with the Comm release information type IE set to "INTENT TO RELEASE", then: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and + - c) if an Data query type IE is present and set to "REMAINING AMOUNT OF DATA", then: + - i) shall generate a DATA PAYLOAD message as described in subclause 15.1.4; + - ii) shall generate a SIP INFO request according to 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; + - iii) shall include in the SIP INFO request, the DATA PAYLOAD message in an application/vnd.3gpp.mcdata-payload MIME body as specified in subclause E.2; and + - A) shall set a Content-Disposition header field to "Info-Package" value; and + - iv) shall send the SIP INFO request within the SIP dialog of the MCData communication, towards the participating MCData function according to 3GPP TS 24.229 [5]; and +- 3) shall notify MCData user and present the reason, if the reason header is present in incoming SIP INFO message. + +When generating an DATA PAYLOAD message as specified in subclause 15.1.4, the MCData client: + +- 1) shall set the Number of payloads IE to 1: + - a) shall set the Payload content type as "TEXT" as specified in subclause 15.2.13; and + - b) shall include the remaining amount of data in bytes to be sent in the Payload data. + +Once the MCData user is notified about the MCData server's intent to release the communication, the MCData user may request for extension of communication as described in subclause 13.2.4.2.2. + +#### 13.2.4.2.2 Request for extension of communication + +Upon receiving a request from MCData user for extension of the communication as a result of MCData server's intent to release the communication, the MCData client: + +- 1) shall generate a SIP INFO request according to 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include a Info-Package with header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message as specified in subclause 15.1.10, in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and + - a) shall set a Content-Disposition header field to "Info-Package" value; and +- 4) shall send the SIP INFO request within the SIP dialog of the MCData communication, towards the participating MCData function according to 3GPP TS 24.229 [5]. + +When generating an COMMUNICATION RELEASE message as specified in subclause 15.1.10, the MCData client: + +- 1) shall set the Comm release information type to "EXTENSION REQUEST". + +### 13.2.4.2.3 Receiving response to communication extension request + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the MCData client: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a COMMUNICATION RELEASE message as specified in subclause 15.1.10, with the Comm release information type IE set to "EXTENSION RESPONSE", then: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and + - c) shall notify user about extension response based on Extension Response Type IE. + +### 13.2.4.3 Participating MCData function procedures for communication over media plane + +#### 13.2.4.3.1 Receiving SIP INFO request from the controlling MCData function + +Upon receiving a SIP INFO request with the Info-Package header field set to g.3gpp.mcdata-com-release package, from controlling MCData function within the SIP dialog of the MCData communication, the participating MCData function: + +- 1) shall generate a SIP INFO request according to 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall copy the contents of the Info-Package header field of the incoming SIP INFO request to the Info-Package header field of the outgoing SIP INFO request; +- 3) shall copy the MIME bodies present in the incoming SIP INFO request to the outgoing SIP INFO request; and +- 4) shall send the SIP INFO request to the MCData client within the SIP dialog of the MCData communication according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response from MCData client to the SIP INFO request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and +- 2) shall send a SIP 200 (OK) response to the SIP INFO request received from the controlling MCData function according to 3GPP TS 24.229 [5]. + +#### 13.2.4.3.2 Receiving SIP INFO request from the MCData client + +Upon receiving a SIP INFO request with the Info-Package header field set to g.3gpp.mcdata-com-release package, from MCData client within the SIP dialog of the MCData communication, the participating MCData function: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall copy the contents of the Info-Package header field of the incoming SIP INFO request to the Info-Package header field of the outgoing SIP INFO request; +- 3) shall copy the MIME bodies present in the incoming SIP INFO request to the outgoing SIP INFO request; and +- 4) shall send the SIP INFO request to the controlling MCData function, within the SIP dialog of the MCData communication, according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response from controlling MCData function to the SIP INFO request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + +- 2) shall send a SIP 200 (OK) response to the SIP INFO request received from the MCData client according to 3GPP TS 24.229 [5]. + +#### 13.2.4.4 Controlling MCData function procedures for communication over media plane + +##### 13.2.4.4.1 Sending intent to release a communication + +To send an intent to release a MCData communication, the controlling MCData function: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include the Info-Package header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1: + - a) shall set a Content-Disposition header field to "Info-Package" value; +- 4) may add reason header with reason-text value as appropriate (e.g. data volume limit, time limit expiry); and +- 5) shall send a SIP request towards participating MCData function within the SIP dialog of the MCData communication, according to 3GPP TS 24.229 [5]. + +When generating a COMMUNICATION RELEASE message, the controlling MCData function: + +- 1) shall generate a COMMUNICATION RELEASE message as defined in subclause 15.1.10. In the COMMUNICATION RELEASE message, the controlling MCData function: + - a) shall set Comm Release Information type IE to "INTENT TO RELEASE"; and + - b) if requesting for more information, shall include and set Data query type IE to the "REMAINING AMOUNT OF DATA". + +Upon receiving SIP 200 OK, the controlling MCData function: + +- 1) shall start Timer TDC3 (request for extension). + +If timer TDC3 (request for extension) expires before controlling MCData function receives a request for extension of communication from the MCData client, the controlling MCData function shall release MCData communication as described in subclause 13.2.2.2.4.4. + +##### 13.2.4.4.2 Receiving more information + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-payload MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-payload MIME body; and +- 2) shall identify the number of Payload IEs in the DATA PAYLOAD message from the Number of payloads IE in the DATA PAYLOAD message: + - a) For each Payload IE: + - i) shall store the contents of the Payload IE as remaining data information associated with ongoing MCData communication; + +##### 13.2.4.4.3 Receiving request for extension of communication + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and + +- 2) if application/vnd.3gpp.mcdata-signalling MIME body contains COMMUNICATION RELEASE message with the comm release information type IE set to "EXTENSION REQUEST", the controlling MCData function: + - a) shall stop the timer TDC3 (request for extension); + - b) shall generate SIP 200 (OK) response and send it towards participating MCData function according to 3GPP TS 24.229 [5]; and + - c) shall send response to communication extension request as described in subclause 13.2.4.4.4. + +#### 13.2.4.4.4 Sending response to communication extension request + +To send a response to communication extension request from MCData client, the controlling MCData function: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include the Info-Package header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and + - a) Shall set a Content-Disposition header field to "Info-Package" value; and +- 4) shall send a SIP request towards participating MCData function within the SIP dialog of the MCData communication, according to 3GPP TS 24.229 [5]. + +When generating a COMMUNICATION RELEASE message, the controlling MCData function: + +- 1) Shall generate a COMMUNICATION RELEASE message as defined in subclause 15.1.10. In the COMMUNICATION RELEASE message, the controlling MCData function: + - a) Shall set Comm Release Information type IE to "EXTENSION RESPONSE"; and + - b) shall assert the local policy along with already stored remaining data information associated with the MCData communication: + - i) If controlling MCData function decides to accept the request for extension, shall set extension request type information element to "ACCEPTED"; or + - ii) If controlling MCData function, decides to reject the request for extension, shall set extension request type information element to "REJECTED"; + +Upon receiving a SIP 200 (OK) response, + +- 1) shall release the MCData communication as described in subclause 13.2.2.2.4.4, if controlling MCData function, decides to reject the request for extension. + +#### 13.2.4.5 Release of MCData communication over HTTP + +##### 13.2.4.5.1 General + +Based on communication release policies and configuration, the MCData server can release an ongoing MCData communication. + +If configured, the MCData server can notify the originating MCData user about the intent to release communication and may request for more data about the communication it intends to release. The procedures described in this subclause are applicable to MCData FD using HTTP where the MCData server initiates the communication release. + +##### 13.2.4.5.2 MCData client procedures + +###### 13.2.4.5.2.1 Receiving intent to release the communication + +Upon receiving a SIP MESSAGE request containing an application/vnd.3gpp.mcdata-signalling MIME body; the MCData client: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a FD HTTP TERMINATION message as specified in subclause 15.1.11, with the Termination information type IE set to "INTENT TO RELEASE COMM OVER HTTP" then: + - a) shall identify file transmission request with Conversation ID, Message ID, and FILE URL in FD HTTP TERMINATION message, if identified any transmission: + - i) shall generate SIP 200 (OK) according to 3GPP TS 24.229 [5]; + - ii) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; + - iii) shall store the public service identity of the controlling MCData function from element of application/vnd.3gpp.mcdata-signalling MIME body; and + - iv) shall notify MCData user and present the reason; if the reason header is present in SIP MESSAGE. + +Once the MCData user is notified about the MCData server's intent to release the communication, the MCData user may request for extension of communication as described in subclause 13.2.4.5.2.2 + +#### 13.2.4.5.2.2 Request for extension of communication + +Upon receiving a request from MCData user for extension of the communication as a result of MCData server's intent to release the communication, the MCData client: + +- 1) shall generate SIP MESSAGE request according to 3GPP TS 24.229 [5]; +- 2) shall generated a standalone FD message as specified in subclause 6.2.2.4 with following clarifications: + - a) shall set Termination information type IE to "EXTENSION REQUEST FOR COMM OVER HTTP"; +- 3) shall include an application/vnd.3gpp.mcdata-info+xml MIME body: + - a) shall set element to the store public service identity of controlling MCData function; and +- 4) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5] towards originating participating function. + +#### 13.2.4.5.2.3 Receiving response to communication extension request + +Upon receiving a SIP MESSAGE request from MCData server containing application/vnd.3gpp.mcdata-signalling MIME body, the MCData client: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a FD HTTP TERMINATION message as specified in subclause 15.1.11, with the Termination information type IE set to "EXTENSION RESPONSE FOR COMM OVER HTTP", then: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and +- 3) shall notify user about extension response based on Extension response type IE. + +#### 13.2.4.5.3 Participating MCData function procedures + +##### 13.2.4.5.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for originating participating MCData function", the participating MCData function shall follow the procedure described in subclause 10.2.4.3.1. + +#### 13.2.4.5.3.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE network notification for FD using HTTP for terminating participating MCData function", the participating MCData function shall follow the procedure described in subclause 10.2.4.3.2 + +#### 13.2.4.5.4 Controlling MCData function procedures + +##### 13.2.4.5.4.1 Sending intent to release a communication + +To send an intent to release a MCData communication, the controlling MCData function: + +- 1) shall generate a SIP MESSAGE as described in subclause 13.2.1.1; +- 2) shall include element in application/vnd.3gpp.mcdata-info+xml MIME body with public service identity of controlling function; +- 3) shall set Termination information type IE in FD HTTP TERMINATION of application/vnd.3gpp.mcdata-signalling MIME body to "INTENT TO RELEASE COMM OVER HTTP"; +- 4) may add reason header with reason-text value as appropriate (e.g. data volume limit, time limit expiry); and +- 5) shall send a SIP request towards participating MCData function according to 3GPP TS 24.229 [5]. + +Upon receiving SIP 200 OK, the controlling MCData function: + +- 1) shall start Timer TDC3 (request for extension). + +If timer TDC3 (request for extension) expires before controlling MCData function receives a request for extension of communication from the MCData client, the controlling MCData function shall release MCData communication as described in subclause 13.2.3.3.4. + +##### 13.2.4.5.4.2 Receiving request for extension of communication + +Upon receiving a SIP MESSAGE request, the controlling MCData function: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) if application/vnd.3gpp.mcdata-signalling MIME body contains FD HTTP TERMINATION message with the Termination information type IE set to "EXTENSION REQUEST FOR COMM OVER HTTP", the controlling MCData function: + - a) shall stop the timer TDC3 (request for extension) for file transmission identified by Conversation ID and Message ID and FILE URL; + - b) shall generate SIP 200 (OK) response and send it towards participating MCData function according to 3GPP TS 24.229 [5]; and +- 3) shall send response to communication extension request as described in subclause 13.2.4.5.4.3. + +##### 13.2.4.5.4.3 Sending response to communication extension request + +To send a response to communication extension request from MCData client, the controlling MCData function: + +- 1) shall generate a SIP MESSAGE as described in subclause 13.2.1.1; +- 2) shall set Termination information type IE in FD HTTP TERMINATION of application/vnd.3gpp.mcdata-signalling MIME body to "EXTENSION RESPONSE FOR COMM OVER HTTP"; +- 3) shall assert the local policy associated with the MCData communication: + - a) If controlling MCData function decides to accept the request for extension, shall set Extension response type IE to "ACCEPTED"; or + - b) If controlling MCData function, decides to reject the request for extension, shall set Extension response type IE to "REJECTED"; and +- 4) shall send SIP MESSAGE towards participating MCData function according 3GPP TS 24.229 [5]; + +Upon receiving 200 OK response: + +- 1) shall release the MCData communication as described in subclause 13.2.3.3.4; if controlling MCData function decides to reject the request for extension. + +## 13.2.5 Authorized MCData user initiated communication release without prior indication + +### 13.2.5.1 General + +An authorized MCData user at any point of time during an ongoing MCData communication decides to release communication. An authorized MCData user should be part of the ongoing MCData communication. The procedure in this subclause describes the case where an authorized MCData user decides to release the communication without providing prior indication to originator MCData user. + +### 13.2.5.2 Release of MCData communication over media plane + +#### 13.2.5.2.1 General + +The procedures described in this subclause are applicable to MCData SDS and MCData FD established using media plane. + +#### 13.2.5.2.2 Authorized MCData client procedures + +##### 13.2.5.2.2.1 Sending communication release request + +Upon receiving request from an authorized MCData user to release the communication without prior indication to originating MCData user, the MCData client: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include the Info-Package header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1: + - a) shall set a Content-Disposition header field to "Info-Package" value; +- 4) shall insert in the SIP INFO request an application/vnd.3gpp.mcdata-info+xml MIME body with + - a) the element set to the MCData client ID of the authorized MCData client; +- 5) may add reason header with reason-text value as appropriate; and +- 6) shall send a SIP request towards participating MCData function within the SIP dialog of the MCData communication, according to 3GPP TS 24.229 [5]. + +When generating a COMMUNICATION RELEASE message, the MCData client: + +- 1) shall generate a COMMUNICATION RELEASE message as defined in subclause 15.1.10. In the COMMUNICATION RELEASE message, the MCData client: + - a) shall set Comm Release Information type IE to "AUTH USER RELEASE REQ". + +Upon receiving a SIP 200 (OK) response from participating MCData function to the SIP INFO request, the MCData client should inform the authorized MCData user about acceptance of communication release request by MCData server. + +Upon receiving a SIP 403 (Forbidden) response from participating MCData function to the SIP INFO request, the MCData client should inform the authorized MCData user about rejection of communication release request by MCData server. + +### 13.2.5.2.3 Participating MCData function procedures + +#### 13.2.5.2.3.1 Receiving SIP INFO request from the authorized MCData client + +Upon receiving a SIP INFO request with the Info-Package header field set to g.3gpp.mcdata-com-release package, from MCData client within the SIP dialog of the MCData communication, the participating MCData function should follow the procedure described in subclause 13.2.4.3.2. + +Upon receiving a SIP 403 (Forbidden) response from controlling MCData function to the SIP INFO request, the participating MCData function: + +- 1) shall generate a SIP 403 (Forbidden) response according to 3GPP TS 24.229 [5]; and +- 2) shall send a SIP 403 (Forbidden) response to the SIP INFO request received from the MCData client according to 3GPP TS 24.229 [5]. + +### 13.2.5.2.4 Controlling MCData function procedures + +#### 13.2.5.2.4.1 Receiving request to release the communication from authorized MCData user + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a COMMUNICATION RELEASE message as specified in subclause 15.1.10, with the Comm release information type IE set to "AUTH USER RELEASE REQ", then: + - a) shall validate whether MCData user from which communication release request is received is authorized or not based on configuration; +- 3) if MCData user validation is not successful, + - a) shall generate a SIP 403 (Forbidden) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 403 (Forbidden) response towards participating MCData function according to 3GPP TS 24.229 [5]; + - c) shall skip further steps; +- 4) if MCData user validation is successful, + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; +- 5) shall follow the procedure as described in subclause 13.2.3.2.4 to terminate the ongoing communication; + +### 13.2.5.3 Release of MCData communication over HTTP + +#### 13.2.5.3.1 General + +The procedures described in this subclause are applicable to MCData FD over HTTP. + +#### 13.2.5.3.2 Authorized MCData client procedures + +##### 13.2.5.3.2.1 Sending communication release request + +Upon receiving request from an authorized MCData user to release the communication without prior indication to originating MCData user, the MCData client + +- 1) shall generate a SIP MESSAGE as specified in subclause 13.2.1.2, then: + - a) shall set the Termination information type IE if FD HTTP TERMINATION message to "AUTH USER TERMINATION REQUEST FOR COMM OVER HTTP" as specified in subclause 15.2.22; + +- 2) shall add application/vnd.3gpp.mcdata-info+xml MIME body in SIP MESSAGE with: + - a) shall set element to the value received in incoming SIP MESSAGE; and + - b) shall add element set to the MCData client ID of the authorized MCData client; +- 3) may add reason header with reason-text value as appropriate; and +- 4) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5] towards originating participating function. + +Upon receiving a SIP 200 (OK) response from participating MCData function to the SIP MESSAGE request, the MCData client should inform the authorized MCData user about acceptance of communication release request by MCData server. + +Upon receiving a SIP 403 (Forbidden) or SIP 404 (Not found) response from participating MCData function to the SIP MESSAGE request, the MCData client should inform the authorized MCData user about rejection of communication release request by MCData server. + +#### 13.2.5.3.2.2 Receiving Release Response Type from server + +Upon receiving SIP MESSAGE from server containing application/vnd.3gpp.mcdata-signalling MIME body with HTTP TERMINATION MESSAGE and FD signalling payload message identity value set as FD HTTP TERMINATION as described in subclause 15.2.2, the authorized MCData client shall follow the procedure as described in subclause 13.2.2.3.2.1.2. + +#### 13.2.5.3.3 Participating MCData function procedures + +##### 13.2.5.3.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for originating participating MCData function", the participating MCData function shall follow the procedure as described in subclause 10.2.4.3.1. + +##### 13.2.5.3.3.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE network notification for FD using HTTP for terminating participating MCData function", the participating MCData function shall follow the procedure as described in subclause 10.2.4.3.2. + +#### 13.2.5.3.4 Controlling MCData function procedures + +##### 13.2.5.3.4.1 Receiving request to release the communication from authorized MCData user + +Upon receiving a SIP MESSAGE request and containing an application/vnd.3gpp.mcdata-signalling MIME body, the controlling MCData function: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains FD HTTP TERMINATION message as specified in subclause 15.1.11 then: + - a) if Termination information type IE set to "AUTH USER TERMINATION REQUEST FOR COMM OVER HTTP", then: + - i) shall validate whether MCData user identified in element of application/vnd.3gpp.mcdata-info+xml, is authorized or not based on configuration; + - b) if MCData user validation is not successful: + - i) shall generate a SIP 403 (Forbidden) response according to 3GPP TS 24.229 [5]; + - ii) shall send SIP 403 (Forbidden) response towards participating MCData function according to 3GPP TS 24.229 [5]; and + - iii) shall skip further steps; + - c) if MCData user validation is successful: + +- i) if not able to identify file transmission using the Conversation ID, Message ID and file URL, shall send SIP 404 (Not Found) with reason with waring text set to "224 No transmission available" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps; + - ii) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + - ii) shall send SIP 200 (OK) response towards MCData server according to 3GPP TS 24.229 [5]; and +- d) shall follow the procedure as described in subclause 13.2.3.3.4 to terminate the ongoing communication. + +The controlling MCData function should follow procedure as described in subclause 6.3.6.1 to generate response to the authorized user initiated request for release of MCData communication with following clarifications: + +- 1) shall set Release response type IE to: + - a) "RELEASE SUCCESS" if communication release request is successful; or + - b) "RELEASE FAILED" if communication release request is not successful; and +- 2) shall send the SIP MESSAGE request towards the authorized MCData client as specified in 3GPP TS 24.229 [5]. + +## 13.2.6 Authorized MCData user initiated communication release with prior indication + +### 13.2.6.1 General + +An authorized MCData user at any point of time during an ongoing MCData communication decides to release communication. An authorized MCData user should be part of the ongoing MCData communication. The procedure in this subclause describes the case where an authorized MCData user decides to release the communication with providing prior indication to originator MCData user. + +### 13.2.6.2 Release of MCData communication over media plane + +#### 13.2.6.2.1 General + +The procedures described in this subclause are applicable to MCData SDS and MCData FD established using media plane. + +#### 13.2.6.2.2 Authorized MCData client procedures + +##### 13.2.6.2.2.1 Sending intent to release a communication + +Upon receiving request from an authorized MCData user to release the communication without prior indication to originating MCData user, the MCData client: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include the Info-Package header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1: + - a) shall set a Content-Disposition header field to "Info-Package" value; +- 4) shall insert in the SIP INFO request an application/vnd.3gpp.mcdata-info+xml MIME body with: + - a) the element set to the MCData client ID of the authorized MCData client; +- 5) may add reason header with reason-text value as appropriate; and +- 6) shall send a SIP request towards participating MCData function within the SIP dialog of the MCData communication, according to 3GPP TS 24.229 [5]. + +When generating a COMMUNICATION RELEASE message, the MCData client: + +- 1) shall generate a COMMUNICATION RELEASE message as defined in subclause 15.1.10. In the COMMUNICATION RELEASE message, the MCData client: + - a) shall set Comm Release Information type IE to "INTENT TO RELEASE"; and + - b) if requesting for more information, shall include and set Data query type IE to the "REMAINING AMOUNT OF DATA". + +Upon receiving a SIP 200 (OK) response from participating MCData function to the SIP INFO request, the MCData client should inform the authorized MCData user about acceptance of communication release request by MCData server. + +Upon receiving a SIP 403 (Forbidden) response from participating MCData function to the SIP INFO request, the MCData client should inform the authorized MCData user about rejection of communication release request by MCData server. + +#### 13.2.6.2.2.2 Receiving more information + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-payload MIME body associated with the Info-Package, the authorized MCData client: + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; +- 2) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]; +- 3) shall decode the contents of the application/vnd.3gpp.mcdata-payload MIME body; and +- 4) shall identify the number of Payload IEs in the DATA PAYLOAD message: + - a) for each Payload IE: + - i) shall store the contents of the Payload IE as remaining data information associated with ongoing MCData communication. + +#### 13.2.6.2.2.3 Receiving request for extension of communication + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the authorized MCData client: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) if application/vnd.3gpp.mcdata-signalling MIME body contains COMMUNICATION RELEASE message with the comm release information type IE set to "EXTENSION REQUEST", the MCData client: + - a) shall generate SIP 200 (OK) response and send it towards participating MCData function according to 3GPP TS 24.229 [5]; and + - b) shall notify authorized MCData user about extension request and also present more information received previously to authorized MCData user; and +- 3) based on authorized MCData user's response, shall send response to communication extension request as described in subclause 13.2.6.2.4. + +#### 13.2.6.2.2.4 Sending response to communication extension request + +To send a response to communication extension request from originator MCData client, the authorized MCData client: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include the Info-Package header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; + +- a) Shall set a Content-Disposition header field to "Info-Package" value; and +- 4) shall send a SIP request towards participating MCData function within the SIP dialog of the MCData communication, according to 3GPP TS 24.229 [5]. + +When generating a COMMUNICATION RELEASE message, the MCData client: + +- 1) shall generate a COMMUNICATION RELEASE message as defined in subclause 15.1.10. In the COMMUNICATION RELEASE message, the MCData client: + - a) shall set Comm Release Information type IE to "EXTENSION RESPONSE"; and + - b) shall set extension request type information element as follows: + - i) if authorized MCData user decides to accept the request for extension, shall set extension request type information element to "ACCEPTED"; or + - ii) if authorized MCData user decides to reject the request for extension, shall set extension request type information element to "REJECTED". + +### 13.2.6.2.3 Participating MCData function procedures + +#### 13.2.6.2.3.1 Receiving SIP INFO request from the authorized MCData client + +Upon receiving a SIP INFO request with the Info-Package header field set to g.3gpp.mcdata-com-release package, from MCData client within the SIP dialog of the MCData communication, the participating MCData function should follow the procedure described in subclause 13.2.4.3.2. + +Upon receiving a SIP 403 (Forbidden) response from controlling MCData function to the SIP INFO request, the participating MCData function: + +- 1) shall generate a SIP 403 (Forbidden) response according to 3GPP TS 24.229 [5]; and +- 2) shall send a SIP 403 (Forbidden) response to the SIP INFO request received from the MCData client according to 3GPP TS 24.229 [5]. + +#### 13.2.6.2.3.2 Receiving SIP INFO request from the controlling MCData function + +Upon receiving a SIP INFO request with the Info-Package header field set to g.3gpp.mcdata-com-release package, from controlling MCData function within the SIP dialog of the MCData communication, the participating MCData function shall follow the procedure described in subclause 13.2.4.3.1. + +### 13.2.6.2.4 Controlling MCData function procedures + +#### 13.2.6.2.4.1 Receiving request to release the communication from authorized MCData user + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a COMMUNICATION RELEASE message as specified in subclause 15.1.10, with the Comm release information type IE set to AUTH USER RELEASE REQ, then: + - a) shall validate whether MCData user, from which communication release request is received, is authorized or not based on configuration; +- 3) if MCData user is not authorized to release the MCData communication, + - a) shall generate a SIP 403 (Forbidden) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 403 (Forbidden) response towards participating MCData function according to 3GPP TS 24.229 [5]; and + +- c) shall skip further steps; +- 4) if MCData user is authorized to release the MCData communication, + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + - b) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]; and + - 5) shall follow the procedure as described in subclause 13.2.4.4.1 with following clarifications; + - a) shall copy reason header from SIP INFO message received from participant MCData function. + +The controlling MCData function should store the information related to initiator of MCData communication release process. + +#### 13.2.6.2.4.2 Receiving more information + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-payload MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; +- 2) shall send SIP 200 (OK) response towards participating MCData server according to 3GPP TS 24.229 [5]. + +If controlling MCData function is not the initiator of the MCData communication release process, the controlling MCData function should send more information received in SIP INFO message to authorized MCData user who is the initiator of the MCData communication release process. The controlling MCData function: + +- 1) shall generate a SIP INFO request according to 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall generate a DATA PAYLOAD message as described in subclause 15.1.4; +- 3) shall include in the SIP INFO request, the DATA PAYLOAD message in an application/vnd.3gpp.mcdata-payload MIME body as specified in subclause E.2; + - a) shall set a Content-Disposition header field to "Info-Package" value; +- 4) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the MCData ID of the authorized MCData user; and +- 5) shall send the SIP INFO request within the SIP dialog of the MCData communication, towards the participating MCData function according to 3GPP TS 24.229 [5]. + +When generating an DATA PAYLOAD message as specified in subclause 15.1.4, the MCData client: + +- 1) shall set the Number of payloads IE to the same number which it received in SIP INFO message from participating function: + - a) shall copy every payload IE from SIP INFO message received from participating function. + +#### 13.2.6.2.4.3 Receiving request for extension of communication + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and +- 2) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]. + +If controlling MCData function is not the initiator of the MCData communication release process, the controlling MCData function should send request for extension of communication received in SIP INFO message to authorized MCData user who is the initiator of the MCData communication release process. The controlling MCData function: + +- 1) shall generate a SIP INFO request according to 3GPP TS 24.229 [5] and IETF RFC 6086 [21]; +- 2) shall include a Info-Package with header field set to g.3gpp.mcdata-com-release; +- 3) shall include in the SIP INFO request, a COMMUNICATION RELEASE message as specified in subclause 15.1.10, in an application/vnd.3gpp.mcdata-signalling MIME body as specified in subclause E.1; and + - a) shall set a Content-Disposition header field to "Info-Package" value; +- 4) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the MCData ID of the authorized MCData user; +- 5) shall send the SIP INFO request within the SIP dialog of the MCData communication, towards the participating MCData function according to 3GPP TS 24.229 [5]. + +When generating a COMMUNICATION RELEASE message as specified in subclause 15.1.10, the MCData client: + +- 1) shall set the Comm release information type to "EXTENSION REQUEST". + +#### 13.2.6.2.4.4 Receiving response to communication extension request + +Upon receiving a SIP INFO request within the SIP dialog of a MCData communication, with the Info-Package header field set to g.3gpp.mcdata-com-release package and containing an application/vnd.3gpp.mcdata-signalling MIME body associated with the Info-Package, the controlling MCData function: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a COMMUNICATION RELEASE message as specified in subclause 15.1.10, with the Comm release information type IE set to "EXTENSION RESPONSE", then: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + - b) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]. + +If controlling MCData function is not the initiator of the MCData communication release process, the controlling MCData function should send response to request for extension of communication received in SIP INFO message to originator MCData user. The controlling MCData function should follow procedure described in subclause 13.2.4.4.4 with following clarification: + +- 1) while generating a COMMUNICATION RELEASE message: + - a) shall copy the extension request type information element from SIP INFO message received from authorized MCData client. + +After sending response to originator MCData user, the controlling MCData function: + +- 1) shall release the MCData communication as described in subclause 13.2.2.2.4.4, if authorized MCData user has rejected the request for extension. + +#### 13.2.6.3 Release of MCData communication over HTTP + +##### 13.2.6.3.1 General + +The procedures described in this subclause are applicable to MCData FD over HTTP. + +##### 13.2.6.3.2 Authorized MCData client procedures + +###### 13.2.6.3.2.1 Sending intent to release a communication + +Upon receiving request from an authorized MCData user to release the communication without prior indication to originating MCData user, the MCData client: + +- 1) shall generate a SIP MESSAGE as specified in subclause 13.2.1.2, then: + +- a) shall set the Termination information type IE of FD HTTP TERMINATION message to "INTENT TO RELEASE COMM OVER HTTP"; +- 2) shall add application/vnd.3gpp.mcdata-info+xml MIME body in SIP MESSAGE with: + - a) shall set element to the value received in incoming SIP MESSAGE; and + - b) shall add element set to the MCData client ID of the authorized MCData client; +- 3) may add reason header with reason-text value as appropriate; and +- 4) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5] towards originating participating function. + +Upon receiving a SIP 200 (OK) response from participating MCData function to the SIP MESSAGE request, the MCData client should inform the authorized MCData user about acceptance of communication release request by MCData server. + +Upon receiving a SIP 403 (Forbidden) or SIP 404 (Not found) response from participating MCData function to the SIP MESSAGE request, the MCData client should inform the authorized MCData user about rejection of communication release request by MCData server. + +#### 13.2.6.3.2.2 Receiving request for extension of communication + +Upon receiving a SIP MESSAGE containing application/vnd.3gpp.mcdata-signalling MIME body then MCData client: + +- 1) shall decode contents of application/vnd.3gpp.mcdata-signalling; +- 2) if application/vnd.3gpp.mcdata-signalling MIME body contains FD HTTP TERMINATION message with the Termination information type IE set to "EXTENSION REQUEST FOR COMM OVER HTTP", the authorized MCData client: + - a) shall generate SIP 200 (OK) response and send it towards participating MCData function according to 3GPP TS 24.229 [5]; and + - b) shall notify authorized MCData user about extension request to authorized MCData user; and +- 3) based on authorized MCData user's response, shall send response to communication extension request as described in subclause 13.2.6.3.2.3. + +#### 13.2.6.3.2.3 Sending response to communication extension request + +To send a response to communication extension request from originator MCData client, the authorized MCData client: + +- 1) shall generate a SIP MESSAGE as specified in subclause 13.2.1.2, then: + - a) shall set the Termination information type IE if FD HTTP TERMINATION message to "EXTENSION RESPONSE FOR COMM OVER HTTP"; + - b) shall set Extension response type IE as follows: + - i) if authorized MCData user decides to accept the request for extension, shall set to "ACCEPTED"; or + - ii) if authorized MCData user decides to reject the request for extension, shall set to "REJECTED"; +- 2) shall add application/vnd.3gpp.mcdata-info+xml MIME body in SIP MESSAGE with: + - a) shall set element to the value received in incoming SIP MESSAGE of FD transmission message; and + - b) shall add element set to the MCData client ID of the authorized MCData client; +- 3) may add reason header with reason-text value as appropriate; and +- 4) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5] towards originating participating function. + +#### 13.2.6.3.2.4 Receiving Release Response from server + +Upon receiving SIP MESSAGE from server containing application/vnd.3gpp.mcdata-signalling MIME body with HTTP TERMINATION MESSAGE and FD signalling payload message identity value set as FD HTTP TERMINATION as described in subclause 15.2.2, the authorized MCData client shall follow the procedure as described in subclause 13.2.2.3.2.1.2. + +#### 13.2.6.3.3 Participating MCData function procedures + +##### 13.2.6.3.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for FD using HTTP for originating participating MCData function", the originating participating MCData function shall follow the procedure as described in subclause 10.2.4.3.1. + +##### 13.2.6.3.3.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE network notification for FD using HTTP for terminating participating MCData function", the terminating participating MCData function shall follow the procedure as described in subclause 10.2.4.3.2. + +#### 13.2.6.3.4 Controlling MCData function procedures + +##### 13.2.6.3.4.1 Receiving request to release the communication from authorized MCData user + +Upon receiving SIP MESSAGE from authorized MCData client containing an application/vnd.3gpp.mcdata-signalling MIME body; the controlling MCData function: + +- 1) shall decode the contents of the application/vnd.3gpp.mcdata-signalling MIME body; +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a FD HTTP TERMINATION message as specified in subclause 15.1.11, with the Termination information type IE set to "INTENT TO RELEASE FOR COMM OVER HTTP", then: + - a) shall get authorized MCData user identity from element of application/vnd.3gpp.mcdata-info+xml MIME body and validate whether authorized MCData user, from which communication release request is received, is authorized or not based on configuration; +- 3) if MCData user is not authorized to release the MCData communication, + - a) shall generate a SIP 403 (Forbidden) response according to 3GPP TS 24.229 [5]; + - b) shall send SIP 403 (Forbidden) response towards participating MCData function according to 3GPP TS 24.229 [5]; and + - c) shall skip further steps; +- 4) if MCData user is authorized to release the MCData communication: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + - b) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]; and +- 5) shall follow the procedure as described in subclause 13.2.4.5.3.1 with following clarifications; + - a) shall copy reason header from SIP MESSAGE received from participant MCData function. + +The controlling MCData function should store the information related to initiator of MCData communication release process. + +##### 13.2.6.3.4.2 Receiving request for extension of communication + +Upon receiving SIP MESSAGE containing an application/vnd.3gpp.mcdata-signalling MIME body, the Controlling MCData function: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and + +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a COMMUNICATION RELEASE message as specified in subclause 15.1.10, with the Comm release information type IE set to "EXTENSION REQUEST FOR COMM OVER HTTP", then: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + - b) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]. + +If controlling MCData function is not the initiator of the MCData communication release process, the controlling MCData function should send request for extension of communication received in SIP MESSAGE to authorized MCData user who is the initiator of the MCData communication release process. The controlling MCData function: + +- 1) shall generate SIP MESSAGE as described in subclause 13.2.1.1; +- 2) shall include application/vnd.3gpp.mcdata-info+xml MIME body, then: + - a) shall set element to authorized user MCData id; +- 3) shall set Termination information type IE of FD HTTP TERMINATION message to "EXTENSION REQUEST FOR COMM OVER HTTP" as specified in subclause 15.2.22; and +- 4) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5] towards participating function. + +#### 13.2.6.3.4.3 Receiving response to communication extension request + +Upon receiving a SIP MESSAGE containing an application/vnd.3gpp.mcdata-signalling MIME body, the controlling MCData function: + +- 1) shall decode the contents of application/vnd.3gpp.mcdata-signalling MIME body; and +- 2) if the application/vnd.3gpp.mcdata-signalling MIME body contains a FD HTTP TERMINATION message as specified in subclause 15.1.11, with the Termination information type IE set to "EXTENSION RESPONSE FOR COMM OVER HTTP", then: + - a) shall generate a SIP 200 (OK) response according to 3GPP TS 24.229 [5]; and + - b) shall send SIP 200 (OK) response towards participating MCData function according to 3GPP TS 24.229 [5]. + +If controlling MCData function is not the initiator of the MCData communication release process, the controlling MCData function should send response to request for extension of communication received in SIP MESSAGE to originator MCData user. The controlling MCData function should follow procedure described in subclause 13.2.4.2.3.2 with following clarification: + +- 1) while generating a FD HTTP TERMINATION message; + - a) shall copy the Extension response type information element from SIP MESSAGE received from authorized MCData client. + +After sending response to originator MCData user, the controlling MCData function: + +- 1) shall release the MCData communication as described in subclause 13.2.3.3.4, if authorized MCData user has rejected the request for extension. + +The controlling MCData function should follow procedure as described in subclause 6.3.6.1 to generate response to the authorized user initiated request for release of MCData communication with following clarifications: + +- 1) shall set Release response type IE to: + - a) "RELEASE SUCCESS" if communication release request is successful; or + - b) "RELEASE FAILED" if communication release request is not successful. +- 2) shall send the SIP MESSAGE request towards the authorized MCData client as specified in 3GPP TS 24.229 [5]. + +## 14. Enhanced Status (ES) + +### 14.1 General + +### 14.2 On-network ES + +#### 14.2.1 MCData client procedures + +##### 14.2.1.1 MCData client originating procedures + +Upon receiving a request from the MCData user to send an enhanced status to an MCData group and the element under the element as defined in 3GPP TS 24.481 [11] is set to "true", the MCData client: + +- 1) shall use the "id" attribute of the MCData user selected operation value from element under element as defined in 3GPP TS 24.481 [11], to generate a group standalone SDS message by following the procedure described in subclause 9.2.2.2.1. + +##### 14.2.1.2 MCData client terminating procedures + +Upon receiving a "SIP MESSAGE request for standalone SDS for terminating MCData client", the MCData client: + +- 1) shall follow the procedure defined in subclause 9.2.2.2.2; +- 2) shall match the received value with an "id" attribute of the operational values from the element of the MCData group document as defined in 3GPP TS 24.481 [11]; and +- 3) if a match is found, shall render the operational value as enhanced status to the MCData user. Otherwise shall discard the received message. + +#### 14.2.2 Participating MCData function procedures + +##### 14.2.2.1 Originating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for originating participating MCData function", the participating MCData function should follow the procedure described in subclause 9.2.2.3.1. + +##### 14.2.2.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for terminating participating MCData function", the participating MCData function should follow the procedure described in subclause 9.2.2.3.2. + +#### 14.2.3 Controlling MCData function procedures + +##### 14.2.3.1 Originating controlling MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for controlling MCData function", the controlling MCData function should follow the procedure described in subclause 9.2.2.4.1. + +##### 14.2.3.2 Terminating controlling MCData function procedures + +Upon receipt of a "SIP MESSAGE request for standalone SDS for controlling MCData function", the controlling MCData function should follow the procedure described in subclause 9.2.2.4.2. + +### 14.3 Off-network ES + +#### 14.3.1 Sending enhanced status message + +Upon receiving request from MCData user to share enhanced for selected group: + +- 1) if the value of "//Common/MCData/AllowedEnhSvc" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true" for the MCData group, the MCData client: + - a) shall use "//Common/MCData/EnhSvcOpValues//EnhSvcOpID" leaf node associated with user selected enhanced status operation value present in the group configuration as specified in 3GPP TS 24.483 [4] to generate a group standalone SDS message by following the procedure described in subclause 9.3.2.2. + +## 14.3.2 Receiving enhanced status message + +Upon receipt of a SDS OFF-NETWORK MESSAGE message, the MCData client: + +- 1) shall follow the procedure defined in subclause 9.3.2.4; +- 2) shall attempt to match the received value with a "//Common/MCData/EnhSvcOpValues//EnhSvcOpID" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4]; and +- 3) if a match is found, shall render the associated operational value from "//Common/MCData/EnhSvcOpValues//EnhSvcOpValue" leaf node as enhanced status to the MCData user. + +--- + +# 15 Message Formats + +## 15.1 MCData message functional definitions and contents + +### 15.1.1 General + +The following subclauses describe the MCData message functional definitions and contents. Each message consist of a series of information elements. The standard format of an MCData message and the encoding rules for each type of information element follow that defined for the MCPTT Off-Network Protocol (MONP) as documented in Annex I of 3GPP TS 24.379 [10]. The associated MIME types and related considerations are documented in Annex E of the present document. + +For off-network transport, the MONP MCData messages are transported in a MONP MCDATA CARRIER message defined in TS 24.379 [10]. + +### 15.1.2 SDS SIGNALLING PAYLOAD message + +#### 15.1.2.1 Message definition + +This message is sent by the UE to other UEs when sending an SDS data payload. This message provides the signalling content related to the SDS data payload. For the contents of the message see Table 15.1.2.1-1. + +Message type: SDS SIGNALLING PAYLOAD + +Direction: UE to other UEs (can be via network) + +**Table 15.1.2.1-1: SDS SIGNALLING PAYLOAD message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------|----------------------------------------|----------|--------|--------| +| | SDS signalling payload message identity | Message type
15.2.2 | M | V | 1 | +| | Date and time | Date and time
15.2.8 | M | V | 5 | +| | Conversation ID | Conversation ID
15.2.9 | M | V | 16 | +| | Message ID | Message ID
15.2.10 | M | V | 16 | +| 21 | InReplyTo message ID | InReplyTo message ID
15.2.11 | O | TV | 17 | +| 22 | Application ID | Application ID
15.2.7 | O | TV | 2 | +| 8- | SDS disposition request type | SDS disposition request type
15.2.3 | O | TV | 1 | +| 7D | Extended application ID | Extended application ID
15.2.24 | O | TLV-E | 3-x | +| 7E | User location | User location
15.2.25 | O | TLV-E | 4-x | +| 51 | Sender MCData user ID | MCData user ID
15.2.15 | O | TLV-E | 4-x | + +## 15.1.3 FD SIGNALLING PAYLOAD message + +### 15.1.3.1 Message definition + +This message is sent by the UE to other UEs when sending an FD data payload. This message provides the signalling content related to the FD data payload. For the contents of the message see Table 15.1.3.1-1. + +Message type: FD SIGNALLING PAYLOAD + +Direction: UE to other UEs (via the network) + +**Table 15.1.3.1-1: FD SIGNALLING PAYLOAD message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------------|---------------------------------------|----------|--------|--------| +| | FD signalling payload message identity | Message type
15.2.2 | M | V | 1 | +| | Date and time | Date and time
15.2.8 | M | V | 5 | +| | Conversation ID | Conversation ID
15.2.9 | M | V | 16 | +| | Message ID | Message ID
15.2.10 | M | V | 16 | +| 21 | InReplyTo message ID | InReplyTo message ID
15.2.11 | O | TV | 17 | +| 22 | Application ID | Application ID
15.2.7 | O | TV | 2 | +| 9- | FD disposition request type | FD disposition request type
15.2.4 | O | TV | 1 | +| A- | Mandatory download | Mandatory download
15.2.16 | O | TV | 1 | +| 78 | Payload | Payload
15.2.13 | O | TLV-E | 3-x | +| 79 | Metadata | Metadata
15.2.17 | O | TLV-E | 3-x | +| 7D | Extended application ID | Extended application ID
15.2.24 | O | TLV-E | 3-x | +| 51 | Sender MCData user ID | MCData user ID
15.2.15 | O | TLV-E | 4-x | + +## 15.1.4 DATA PAYLOAD message + +### 15.1.4.1 Message definition + +This message is sent by the UE to other UEs when sending an SDS data payload or an FD data payload. This message provides the data to be delivered to the user or application. For the contents of the message see Table 15.1.4.1-1. + +Message type: DATA PAYLOAD + +Direction: UE to other UEs (can be via the network for SDS and always via the network for FD) + +**Table 15.1.4.1-1: DATA PAYLOAD message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------|---------------------------------------------------------|----------|--------|--------| +| | Data payload message identity | Message type
15.2.2 | M | V | 1 | +| | Number of payloads | Number of payloads
15.2.12 | M | V | 1 | +| 7A | Security parameters and Payload | MCData Protected Payload message
3GPP TS 33.180 [26] | O | TLV-E | 32-x | +| 78 | Payload | Payload
15.2.13 | O | TLV-E | 3-x | + +NOTE 1: The Number of payloads IE dictates the number of Payload IEs that are included in the message by the sender. Multiple Payload IEs can be part of Security parameters and Payload IE if end-to-end security is required. + +NOTE 2: If end-to-end security is required for a one-to-one communication, Security parameters and Payload IE is included. Otherwise, if end-to-end security is not required for a one-to-one communication, Payload IE is included. For group communication, Payload IE is included. + +NOTE 3: Formatting of payloads as part of the Security parameters and Payload IE is specified in subclause 15.2.13. + +## 15.1.5 SDS NOTIFICATION message + +### 15.1.5.1 Message definition + +This message is sent by the UE to another other UE to share SDS disposition information. For the contents of the message see Table 15.1.5.1-1. + +Message type: SDS NOTIFICATION + +Direction: UE to other UEs (can be via network) + +**Table 15.1.5.1-1: SDS NOTIFICATION message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------|---------------------------------------------|----------|--------|--------| +| | SDS notification message identity | Message type
15.2.2 | M | V | 1 | +| | SDS disposition notification type | SDS disposition notification type
15.2.5 | M | V | 1 | +| | Date and time | Date and time
15.2.8 | M | V | 5 | +| | Conversation ID | Conversation ID
15.2.9 | M | V | 16 | +| | Message ID | Message ID
15.2.10 | M | V | 16 | +| 22 | Application ID | Application ID
15.2.7 | O | TV | 2 | +| 7D | Extended application ID | Extended application ID
15.2.24 | O | TLV-E | 3-x | +| 51 | Sender MCData user ID | MCData user ID
15.2.15 | O | TLV-E | 4-x | + +## 15.1.6 FD NOTIFICATION message + +### 15.1.6.1 Message definition + +This message is sent by the UE to another other UE to share FD disposition information. For the contents of the message see Table 15.1.6.1-1. + +Message type: FD NOTIFICATION + +Direction: UE to other UEs (via the network) + +**Table 15.1.6.1-1: FD NOTIFICATION message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------|--------------------------------------------|----------|--------|--------| +| | FD notification message identity | Message type
15.2.2 | M | V | 1 | +| | FD disposition notification type | FD disposition notification type
15.2.6 | M | V | 1 | +| | Date and time | Date and time
15.2.8 | M | V | 5 | +| | Conversation ID | Conversation ID
15.2.9 | M | V | 16 | +| | Message ID | Message ID
15.2.10 | M | V | 16 | +| 22 | Application ID | Application ID
15.2.7 | O | TV | 2 | +| 7D | Extended application ID | Extended application ID
15.2.24 | O | TLV-E | 3-x | +| 51 | Sender MCData user ID | MCData user ID
15.2.15 | O | TLV-E | 4-x | + +## 15.1.7 SDS OFF-NETWORK MESSAGE message + +### 15.1.7.1 Message definition + +This message is sent by the UE to other UEs to share application or user payload in a SDS message. For contents of the message see Table 15.1.7.1-1. + +Message type: SDS OFF-NETWORK MESSAGE + +Direction: UE to other UEs + +**Table 15.1.7.1-1: SDS OFF-NETWORK MESSAGE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------|------------------------------------------------------|----------|--------|--------| +| | SDS off-network message identity | Message Type 15.2.2 | M | V | 1 | +| | Date and time | Date and time 15.2.8 | M | V | 5 | +| | Number of payloads | Number of payloads 15.2.12 | M | V | 1 | +| | Conversation ID | Conversation ID 15.2.9 | M | V | 16 | +| | Message ID | Message ID 15.2.10 | M | V | 16 | +| | Sender MCData user ID | MCData user ID 15.2.15 | M | LV-E | 3-x | +| 21 | InReplyTo message ID | InReplyTo message ID 15.2.11 | O | TV | 17 | +| 22 | Application ID | Application ID 15.2.7 | O | TV | 2 | +| 8- | SDS disposition request type | SDS disposition request type 15.2.3 | O | TV | 1 | +| 23 | Security parameters | MCData Protected Payload message 3GPP TS 33.180 [26] | O | TV | 32 | +| 7B | MCData group ID | MCData group ID 15.2.14 | O | TLV-E | 4-x | +| 7C | Recipient MCData user ID | MCData user ID 15.2.15 | O | TLV-E | 4-x | +| 78 | Payload | Payload 15.2.13 | O | TLV-E | 4-x | +| 7D | Extended application ID | Extended application ID 15.2.24 | O | TLV-E | 3-x | +| 7E | User location | User location 15.2.25 | O | TLV-E | 4-x | + +## 15.1.8 SDS OFF-NETWORK NOTIFICATION message + +### 15.1.8.1 Message definition + +This message is sent by the UE to other UEs to share disposition status of a SDS message. For contents of the message see Table 15.1.8.1-1. + +Message type: SDS OFF-NETWORK NOTIFICATION + +Direction: UE to other UEs + +**Table 15.1.8.1-1: SDS OFF-NETWORK NOTIFICATION message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------------|------------------------------------------|----------|--------|--------| +| | SDS off-network notification message identity | Message type 15.2.2 | M | V | 1 | +| | SDS disposition notification type | SDS disposition notification type 15.2.5 | M | V | 1 | +| | Date and time | Date and time 15.2.8 | M | V | 5 | +| | Conversation ID | Conversation ID 15.2.9 | M | V | 16 | +| | Message ID | Message ID 15.2.10 | M | V | 16 | +| | Sender MCData user ID | MCData user ID 15.2.15 | M | LV-E | 3-x | +| 22 | Application ID | Application ID 15.2.7 | O | TV | 2 | +| 7D | Extended application ID | Extended application ID 15.2.24 | O | TLV-E | 3-x | + +## 15.1.9 FD NETWORK NOTIFICATION message + +### 15.1.9.1 Message definition + +This message is sent from the network to the UE to provide the UE a file availability indication. For the contents of the message see Table 15.1.9.1-1. + +Message type: FD NETWORK NOTIFICATION + +Direction: network to UE + +**Table 15.1.9.1-1: FD NETWORK NOTIFICATION message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|------------------------------------------|---------------------------------|----------|--------|--------| +| | FD network notification message identity | Message type 15.2.2 | M | V | 1 | +| | FD notification type | Notification type 15.2.18 | M | V | 1 | +| | Date and time | Date and time 15.2.8 | M | V | 5 | +| | Conversation ID | Conversation ID 15.2.9 | M | V | 16 | +| | Message ID | Message ID 15.2.10 | M | V | 16 | +| 22 | Application ID | Application ID 15.2.7 | O | TV | 2 | +| 7D | Extended application ID | Extended application ID 15.2.24 | O | TLV-E | 3-x | + +## 15.1.10 COMMUNICATION RELEASE message + +### 15.1.10.1 Message definition + +This message is sent by the MCData server to MCData UE to indicate about intension to release the MCData communication. This message is also sent by the MCData UE to MCData server to request extension for the MCData communication. The MCData server response back about the request using this message. For the contents of the message see Table 15.10.1-1. + +Message type: COMMUNICATION RELEASE + +Direction: Server to UE, UE to server + +**Table 15.1.10.1-1: COMMUNICATION RELEASE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-------------------------------|---------------------------------------|----------|--------|--------| +| | Comm Release message identity | Message type 15.2.2 | M | V | 1 | +| | Comm Release Information type | Comm Release Information type 15.2.20 | M | V | 1 | +| B- | Data query type | Data query type 15.2.19 | O | TV | 1 | +| C- | Extension response type | Extension response type 15.2.21 | O | TV | 1 | + +## 15.1.11 DEFERRED DATA REQUEST message + +### 15.1.11.1 Message definition + +This message is sent by the MCData UE to MCData server to request the list of group communications which was deferred by the MCData user. + +Message type: DEFERRED DATA REQUEST + +Direction: UE to server + +**Table 15.1.11.1-1: DEFERRED DATA REQUEST message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------------|---------------------|----------|--------|--------| +| | Deferred data request message identity | Message type 15.2.2 | M | V | 1 | + +## 15.1.12 DEFERRED DATA RESPONSE message + +### 15.1.12.1 Message definition + +This message is sent by the MCData server to the MCData UE as response to the list of deferred group communications request from the MCData UE. + +Message type: DEFERRED DATA RESPONSE + +Direction: Server to UE + +**Table 15.1.12.1-1: DEFERRED DATA RESPONSE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------|------------------------------------------------------|----------|--------|--------| +| | Deferred data response message identity | Message type 15.2.2 | M | V | 1 | +| | Number of payloads | Number of payloads 15.2.12 | M | V | 1 | +| 7A | Security parameters and Payload | MCData Protected Payload message 3GPP TS 33.180 [26] | O | TLV-E | 32-x | +| 78 | Payload | Payload 15.2.13 | O | TLV-E | 3-x | + +## 15.1.13 FD HTTP TERMINATION + +### 15.1.13.1 Message definition + +This message is sent by the UE to server or server to UE when trying to release FD communication over HTTP. This message provides the signalling content to identify the MESSAGE where FILE URL is shared. For the contents of the message see table 15.1.13.1-1. + +Message type: FD HTTP TERMINATION + +Direction: UE to server or server to UE + +**Table 15.1.13.1-1: FD HTTP TERMINATION content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------------|--------------------------------------|----------|--------|--------| +| | FD signalling payload message identity | Message type 15.2.2 | M | V | 1 | +| | Conversation ID | Conversation ID 15.2.9 | M | V | 16 | +| | Message ID | Message ID 15.2.10 | M | V | 16 | +| | Termination Information Type | Termination information type 15.2.22 | M | V | 1 | +| 22 | Application ID | Application ID 15.2.7 | O | TV | 2 | +| C- | Extension Response Type | Extension response type 15.2.21 | O | TV | 1 | +| D- | Release Response Type | Release response type 15.2.23 | O | TV | 1 | +| 78 | Payload | Payload 15.2.13 | O | TLV-E | 3-x | + +| | | | | | | +|----|-------------------------|------------------------------------|---|-------|-----| +| 7D | Extended application ID | Extended application ID
15.2.24 | O | TLV-E | 3-x | +|----|-------------------------|------------------------------------|---|-------|-----| + +## 15.1.14 GROUP EMERGENCY ALERT message + +### 15.1.14.1 Message definition + +This message is sent by the UE to other UEs to indicate an emergency situation. For contents of the message see table 15.1.14.1-1. + +Message type: GROUP EMERGENCY ALERT + +Direction: UE to other UEs + +**Table 15.1.14.1-1: GROUP EMERGENCY ALERT message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------------|------------------------------|----------|--------|--------| +| | Group emergency alert message identity | Message type
15.2.2 | M | V | 1 | +| | MCData group ID | MCData group ID
15.2.14 | M | LV-E | 3-x | +| | Originating MCData user ID | MCData user ID
15.2.15 | M | LV-E | 3-x | +| 7F | Organization name | Organization name
15.2.26 | O | TLV-E | 4-x | +| 7E | User location | User location
15.2.25 | O | TLV-E | 4-x | + +## 15.1.15 GROUP EMERGENCY ALERT ACK message + +### 15.1.15.1 Message definition + +This message is sent by the UE to other UEs to indicate receipt of emergency alert. For contents of the message see table 15.1.15.1-1. + +Message type: GROUP EMERGENCY ALERT ACK + +Direction: UE to other UEs + +**Table 15.1.15.1-1: GROUP EMERGENCY ALERT ACK message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|--------------------------------------------|----------------------------|----------|--------|--------| +| | Group emergency alert ack message identity | Message type
15.2.2 | M | V | 1 | +| | MCData group ID | MCData group ID
15.2.14 | M | LV-E | 3-x | +| | Originating MCData user ID | MCData user ID
15.2.15 | M | LV-E | 3-x | +| | Sending MCData user ID | MCData user ID
15.2.15 | M | LV-E | 3-x | + +## 15.1.16 GROUP EMERGENCY ALERT CANCEL message + +### 15.1.16.1 Message definition + +This message is sent by the UE to other UEs to indicate end of emergency situation. For contents of the message see table 15.1.16.1-1. + +Message type: GROUP EMERGENCY ALERT CANCEL + +Direction: UE to other UEs + +**Table 15.1.16.1-1: GROUP EMERGENCY ALERT CANCEL message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------------|----------------------------|----------|--------|--------| +| | Group emergency alert cancel message identity | Message type
15.2.2 | M | V | 1 | +| | MCData group ID | MCData group ID
15.2.14 | M | LV-E | 3-x | +| | Originating MCData user ID | MCData User ID
15.2.15 | M | LV-E | 3-x | + +## 15.1.17 GROUP EMERGENCY ALERT CANCEL ACK message + +### 15.1.17.1 Message definition + +This message is sent by the UE to other UEs to indicate receipt of emergency alert cancel. For contents of the message see table 15.1.17.1-1. + +Message type: GROUP EMERGENCY ALERT CANCEL ACK + +Direction: UE to other UEs + +**Table 15.1.17.1-1: GROUP EMERGENCY ALERT CANCEL ACK message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------------------------|----------------------------|----------|--------|--------| +| | Group emergency alert cancel ack message identity | Message type
15.2.2 | M | V | 1 | +| | MCData group ID | MCData group ID
15.2.14 | M | LV-E | 3-x | +| | Originating MCData user ID | MCData User ID
15.2.15 | M | LV-E | 3-x | +| | Sending MCData user ID | MCData user ID
15.2.15 | M | LV-E | 3-x | + +## 15.2 General message format and information elements coding + +### 15.2.1 General + +The least significant bit of a field is represented by the lowest numbered bit of the highest numbered octet of the field. When the field extends over more than one octet, the order of bit values progressively decreases as the octet number increases. + +Figure 15.2.1-1 shows an example of a field where the most significant bit of the field is marked MSB and the least significant bit of the field is marked LSB. + +![](0f22a2de3c4dfdf861c3948191e92ee3_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-----|---|---|---|---|---|---|-----|---------| +| MSB | x | x | x | x | x | x | x | octet 1 | +| x | x | x | x | x | x | x | x | | +| x | x | x | x | x | x | x | LSB | octet N | + +**Figure 15.2.1-1: Example of bit ordering of a field** + +Within the protocols defined in the present document, the message consists of the following parts: + +- message type information element; and +- other information elements, as required. + +The organization of a message is illustrated in the example shown in Figure 15.2.1-2. + +![Figure 15.2.1-2: General message organization example. A diagram showing a message structure. The first octet is divided into 8 bits, labeled 8 to 1 from left to right. Bits 8 and 7 are labeled 'Message type'. The remaining bits (6-1) and subsequent octets (octet 2 to octet n) are labeled 'Other information elements as required'.](8c05782074bb11421b43f2d5d6799b62_img.jpg) + +Figure 15.2.1-2: General message organization example. A diagram showing a message structure. The first octet is divided into 8 bits, labeled 8 to 1 from left to right. Bits 8 and 7 are labeled 'Message type'. The remaining bits (6-1) and subsequent octets (octet 2 to octet n) are labeled 'Other information elements as required'. + +**Figure 15.2.1-2: General message organization example** + +Unless specified otherwise in the message descriptions of subclause 15.1, a particular information element shall not be present more than once in a given message. + +The sending entity shall set value of a spare bit to zero. The receiving entity shall ignore value of a spare bit + +The sending entity shall not set a value of an information element to a reserved value. The receiving entity shall discard message containing an information element set to a reserved value. + +## 15.2.2 Message type + +The purpose of the Message type information element is to identify the type of the message. + +The value part of the Message type information element is coded as shown in Table 15.2.2-1. + +The Message type information element is a type 3 information element with a length of 1 octet. + +**Table 15.2.2-1: Message types** + +| Bits | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|----------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| x | x | 0 | 0 | 0 | 0 | 0 | 1 | SDS SIGNALLING PAYLOAD | +| x | x | 0 | 0 | 0 | 0 | 1 | 0 | FD SIGNALLING PAYLOAD | +| x | x | 0 | 0 | 0 | 0 | 1 | 1 | DATA PAYLOAD | +| x | x | 0 | 0 | 0 | 1 | 0 | 1 | SDS NOTIFICATION | +| x | x | 0 | 0 | 0 | 1 | 1 | 0 | FD NOTIFICATION | +| x | x | 0 | 0 | 0 | 1 | 1 | 1 | SDS OFF-NETWORK MESSAGE | +| x | x | 0 | 0 | 1 | 0 | 0 | 0 | SDS OFF-NETWORK NOTIFICATION | +| x | x | 0 | 0 | 1 | 0 | 0 | 1 | FD NETWORK NOTIFICATION | +| x | x | 0 | 0 | 1 | 0 | 1 | 0 | COMMUNICATION RELEASE | +| x | x | 0 | 0 | 1 | 0 | 1 | 1 | DEFERRED LIST ACCESS REQUEST | +| x | x | 0 | 0 | 1 | 1 | 0 | 0 | DEFERRED LIST ACCESS RESPONSE | +| x | x | 0 | 0 | 1 | 1 | 0 | 1 | FD HTTP TERMINATION | +| x | x | 0 | 1 | 0 | 0 | 0 | 1 | GROUP EMERGENCY ALERT | +| x | x | 0 | 1 | 0 | 0 | 1 | 0 | GROUP EMERGENCY ALERT ACK | +| x | x | 0 | 1 | 0 | 0 | 1 | 1 | GROUP EMERGENCY ALERT CANCEL | +| x | x | 0 | 1 | 0 | 1 | 0 | 0 | GROUP EMERGENCY ALERT CANCEL ACK | +| All other values are reserved. | | | | | | | | | + +Bit 7 of the above defined messages is set as follows: + +- '0' – if the message is not protected as defined in 3GPP TS 33.180 [26]; or +- '1' – if the message is protected as defined in 3GPP TS 33.180 [26]. + +Bit 8 of the above defined messages is set as follows: + +- '0' – if the message is not authenticated as defined in 3GPP TS 33.180 [26]; or +- '1' – if the message is authenticated as defined in 3GPP TS 33.180 [26]. + +## 15.2.3 SDS disposition request type + +The purpose of the SDS disposition request type information element is to identify the type of SDS disposition notification that the sender requires from the receiver. + +The value part of the SDS disposition request type information element is coded as shown in Table 15.2.3-1. + +The SDS disposition request type information element is a type 1 information element. + +![](7d675e1c380dccba3f69e2de4e72562c_img.jpg) + +| | | | | | | | | | +|----------------------------------|---|---|---|------------------------------------|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| SDS disposition request type IEI | | | | SDS disposition request type value | | | | octet 1 | + +**Figure 15.2.3-1: SDS disposition request type** + +**Table 15.2.3-1: SDS disposition request type** + +| | | | | | +|----------------------------------------------|---|---|---|-------------------| +| SDS disposition request type value (octet 1) | | | | | +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | DELIVERY | +| 0 | 0 | 1 | 0 | READ | +| 0 | 0 | 1 | 1 | DELIVERY AND READ | +| All other values are reserved. | | | | | + +## 15.2.4 FD disposition request type + +The purpose of the FD disposition request type information element is to identify the type of FD disposition notification that the sender requires from the receiver. + +The value part of the FD disposition request type information element is coded as shown in Table 15.2.4-1. + +The FD disposition request type information element is a type 1 information element. + +![](b54a22abcb1bcfbcf96ae7085a3902c4_img.jpg) + +| | | | | | | | | | +|---------------------------------|---|---|---|-----------------------------------|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| FD disposition request type IEI | | | | FD disposition request type value | | | | octet 1 | + +**Figure 15.2.4-1: FD disposition request type** + +**Table 15.2.4-1: FD disposition request type** + +| | | | | | +|---------------------------------------------|---|---|---|--------------------------------| +| FD disposition request type value (octet 1) | | | | | +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | FILE DOWNLOAD COMPLETED UPDATE | +| All other values are reserved. | | | | | + +## 15.2.5 SDS disposition notification type + +The purpose of the SDS disposition notification type information element is to identify the type of SDS disposition notification sent from receiver to the sender. + +The value part of the SDS disposition notification type information element is coded as shown in Table 15.2.5-1. + +The SDS disposition notification type information element is a type 3 information element with a length of 1 octet. + +**Table 15.2.5-1: SDS disposition notification type** + +| Bits | | | | | | | | | +|------|---|---|---|---|---|---|---|-------------------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | UNDELIVERED | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | DELIVERED | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | READ | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | DELIVERED AND READ | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | DISPOSITION PREVENTED BY SYSTEM
(NOTE) | + +All other values are reserved. +NOTE: Usage of this value is described in 3GPP TS 29.582 [48]. + +## 15.2.6 FD disposition notification type + +The purpose of the FD disposition notification type information element is to identify the type of FD disposition notification sent from receiver to the sender. + +The value part of the FD disposition notification type information element is coded as shown in Table 15.2.6-1. + +The FD disposition notification type information element is a type 3 information element with a length of 1 octet. + +**Table 15.2.6.1: FD disposition notification type** + +| Bits | | | | | | | | | +|------|---|---|---|---|---|---|---|--------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | FILE DOWNLOAD REQUEST ACCEPTED | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | FILE DOWNLOAD REQUEST REJECTED | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | FILE DOWNLOAD COMPLETED | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | FILE DOWNLOAD DEFERRED | + +All other values are reserved. + +## 15.2.7 Application ID + +The purpose of the Application ID information element is to uniquely identify the application for which the payload is intended. + +The Application ID information element is coded as shown in figure 15.2.7-1 and table 15.2.7-1 + +The Application ID information element is a type 3 information element with a length of 2 octets. + +![](ecffb3397edcd774dfe391fbd05e0e75_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------------------|---|---|---|---|---|---|---|---------| +| Application ID IEI | | | | | | | | octet 1 | +| Application ID value | | | | | | | | octet 2 | + +**Figure 15.2.7-1: Application ID value****Table 15.2.7-1: Application ID value** + +| | +|--------------------------------------------------------------------------------------------| +| Application ID value (octet 1) | +| The Application ID contains a number that uniquely identifies the destination application. | + +## 15.2.8 Date and time + +The Date and time information element is used to indicate the UTC time when a message or file was sent. + +The Date and time information element is coded as shown in Figure 15.2.8-1 and Table 15.2.8-1. + +The Date and time information element is a type 3 information element with a length of 5 octets. + +![Figure 15.2.8-1: Date and time value diagram showing a bit layout from bit 8 to 1 and octet 1 to 5.](31f5b6310f831ca3ea4f18453980c070_img.jpg) + +The diagram shows a rectangular box representing the data structure. Above the box, bits are numbered from 8 down to 1. Inside the box is the text 'Date and time value'. To the right of the box, it indicates 'octet 1' at the top and 'octet 5' at the bottom. + +Figure 15.2.8-1: Date and time value diagram showing a bit layout from bit 8 to 1 and octet 1 to 5. + +**Figure 15.2.8-1: Date and time value** + +**Table 15.2.8-1: Date and time value** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Date and time value (octet 1 to 5) | +| The Date and time value is an unsigned integer containing UTC time of the time when a message was sent, in seconds since midnight UTC of January 1, 1970 (not counting leap seconds). | + +## 15.2.9 Conversation ID + +The Conversation ID information element uniquely identifies the conversation. + +The Conversation ID information element is coded as shown in Figure 15.2.9-1 and Table 15.2.9-1. + +The Conversation ID information element is a type 3 information element with a length of 16 octets. + +![Figure 15.2.9-1: Conversation ID value diagram showing a bit layout from bit 8 to 1 and octet 1 to 16.](b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg) + +The diagram shows a rectangular box. Above the box, bits are numbered from 8 down to 1. Inside the box is the text 'Conversation ID value'. To the right of the box, it indicates 'octet 1' at the top and 'octet 16' at the bottom. + +Figure 15.2.9-1: Conversation ID value diagram showing a bit layout from bit 8 to 1 and octet 1 to 16. + +**Figure 15.2.9-1: Conversation ID value** + +**Table 15.2.9-1: Conversation ID value** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Conversation identifier value (octet 1 to 16) | +| The Conversation ID contains a number uniquely identifying the conversation. The value is a universally unique identifier as specified in IETF RFC 4122 [14]. | + +## 15.2.10 Message ID + +The Message ID information element uniquely identifies a message within a conversation. + +The Message ID information element is coded as shown in Figure 15.2.10-1 and Table 15.2.10-1. + +The Message ID information element is a type 3 information element with a length of 16 octets. + +![Figure 15.2.10-1: Message ID value diagram showing a bit layout from bit 8 to 1 and octet 1 to 16.](73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg) + +The diagram shows a rectangular box. Above the box, bits are numbered from 8 down to 1. Inside the box is the text 'Message ID value'. To the right of the box, it indicates 'octet 1' at the top and 'octet 16' at the bottom. + +Figure 15.2.10-1: Message ID value diagram showing a bit layout from bit 8 to 1 and octet 1 to 16. + +**Figure 15.2.10-1: Message ID value** + +**Table 15.2.10-1: Message ID value** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Message ID value (octet 1 to 16) | +| The Message ID contains a number uniquely identifying a message. The value is a universally unique identifier as specified in IETF RFC 4122 [14]. | + +## 15.2.11 InReplyTo message ID + +The InReplyTo message ID information element is used to associate a message within a conversation that is a reply to an existing message in a conversation. + +The InReplyTo message ID information element is coded as shown in Figure 15.2.11-1 and Table 15.2.11-1. + +The InReplyTo message ID information element is a type 3 information element with a length of 17 octets. + +![](14af2781d0bd19b98b10672b74daaca2_img.jpg) + +| | | | | | | | | | +|----------------------------|---|---|---|---|---|---|---|---------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| InReplyTo message ID IEI | | | | | | | | octet 1 | +| InReplyTo message ID value | | | | | | | | octet 2
octet 17 | + +**Figure 15.2.11-1: InReplyTo message ID value** + +**Table 15.2.11-1: InReplyTo Message ID value** + +InReplyTo message ID value (octet 2 to 17) + +The InReplyTo message ID contains a number uniquely identifying a message. The value is a universally unique identifier as specified in IETF RFC 4122 [14]. + +## 15.2.12 Number of payloads + +The Number of payloads information element identifies the number of payloads contained in the message. + +The Number of payloads information element is coded as shown in Figure 15.2.12-1, Table 15.2.12-1 + +The Number of payloads information element is a type 3 information element with a length of 1 octet + +![](f365adb7fff59db39a46ffb7025589ff_img.jpg) + +| | | | | | | | | | +|--------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Number of payloads | | | | | | | | octet 1 | + +**Figure 15.2.12-1: Number of payloads information element** + +**Table 15.2.12-2: Number of payloads information element** + +Number of payloads value (octet 1) + +The Number of payloads contains a value from 1 to 255. + +## 15.2.13 Payload + +The Payload information element contains the payload intended for the recipient user or application; + +The Payload information element is coded as shown in Figure 15.2.13-1, Table 15.2.13-1, Table 15.2.13-2 and Table 15.2.13-3. + +The Payload information element is a type 6 information element. + +![](b45f9bbca93687a01a42a6eae5c25b50_img.jpg) + +| | | | | | | | | | +|----------------------------|---|---|---|---|---|---|---|--------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Payload IEI | | | | | | | | octet 1 | +| Length of Payload contents | | | | | | | | octet 2
octet 3 | +| Payload contents | | | | | | | | octet 4
octet n | + +**Figure 15.2.13-1: Payload information element** + +**Table 15.2.13-1: Payload contents** + +![](b3bcc66c2024c092432a61ce8d80ee9a_img.jpg) + +| | | | | | | | | | +|----------------------|---|---|---|---|---|---|---|--------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Payload content type | | | | | | | | octet 4 | +| Payload data | | | | | | | | octet 5
octet n | + +**Table 15.2.13-2: Payload content type** + +| Bits | | | | | | | | | | +|----------------------------------------------------------------|---|---|---|---|---|---|---|--|------------------------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | | TEXT | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | | BINARY | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | | HYPERLINKS | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | | FILEURL | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | | LOCATION | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | | ENHANCED STATUS | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | | Value allocated for use in interworking (NOTE) | +| All other values are reserved. | | | | | | | | | | +| NOTE: Usage of this value is described in 3GPP TS 29.582 [48]. | | | | | | | | | | + +**Table 15.2.13-3: Payload data** + +Payload data is included in octet 5 to octet n; Max value of 65535 octets. + +Payload data contains the payload destined for the user or application. + +A file URL is encoded as specified in IETF RFC 1738 [70]. + +The length of location information payload content is 6 bytes. First 3 bytes contain the latitude information and next 3 bytes contain the longitude information. + +## 15.2.14 MCData group ID + +The MCData group ID information element is used to indicate the destination MCData group identifier; + +The MCData group ID information element is coded as shown in Figure 15.2.14-1 and Table 15.2.14-1. + +The MCData group ID information element is a type 6 information element. + +![](783bdce904660c3e31ca0ae26aa89011_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------------------------------|---|---|---|---|---|---|---|---------------------------| +| MCData group ID IEI | | | | | | | | octet 1 | +| Length of MCData group ID contents | | | | | | | | octet 2
octet 3 | +| MCData group ID contents | | | | | | | | octet 4
...
octet n | + +**Figure 15.2.14-1: MCData group ID information element****Table 15.2.14-1: MCData group ID information element** + +MCData group ID is contained in octet 4 to octet n; Max value of 65535 octets. + +## 15.2.15 MCData user ID + +The MCData user ID information element is used to indicate an MCData user ID. + +The MCData user ID information element is coded as shown in Figure 15.2.15-1 and Table 15.2.15-1. + +The MCData user ID information element is a type 6 information element. + +![](bf1635af3b59ca260bc86e762d0f2466_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-----------------------------------|---|---|---|---|---|---|---|---------| +| MCData user ID IEI | | | | | | | | octet 1 | +| Length of MCData user ID contents | | | | | | | | octet 2 | +| | | | | | | | | octet 3 | +| MCData user ID contents | | | | | | | | octet 4 | +| | | | | | | | | octet n | + +**Figure 15.2.15-1: MCData user ID information element** + +**Table 15.2.15-1: MCData user ID information element** + +MCData user ID is contained in octet 4 to octet n if the IE is used as an optional IE. + If used as a mandatory IE, MCData user ID IEI is omitted and MCData user ID is contained in octet 3 to octet n; + Max value of 65535 octets. + +## 15.2.16 Mandatory download + +The purpose of the Mandatory download information element is for the originating client to inform the terminating client that a file must be downloaded immediately. + +The value part of the Mandatory download information element is coded as shown in Figure 15.2.16-1 and Table 15.2.16-1. + +The Mandatory download information element is a type 1 information element. + +![](04da196e79f7ac195f928904a244f0f9_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------------------|---|---|---|--------------------------|---|---|---|---------| +| Mandatory download IEI | | | | Mandatory download value | | | | octet 1 | + +**Figure 15.2.16-1: Mandatory download** + +**Table 15.2.16-1: Mandatory download** + +Mandatory download value (octet 1) + +| Bits | | | | | +|------|---|---|---|--------------------| +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | MANDATORY DOWNLOAD | + +All other values are reserved. + +## 15.2.17 Metadata + +The Metadata information element is data that is used to describe a file. + +The Metadata information element is coded as shown in Figure 15.2.17-1 and Table 15.2.17-1. + +The Metadata information element is a type 6 information element. + +![](197763d033c6f44ae28e0d5ec5ad4579_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-----------------------------|---|---|---|---|---|---|---|---------| +| Metadata IEI | | | | | | | | octet 1 | +| Length of Metadata contents | | | | | | | | octet 2 | +| | | | | | | | | octet 3 | +| Metadata contents | | | | | | | | octet 4 | +| | | | | | | | | octet n | + +**Figure 15.2.17-1: Metadata information element****Table 15.2.17-1: Metadata information element** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

Metadata is contained in octet 4 to octet n; Max value of n is 65535 octets.

Metadata contains a concatenation of the following data:

  • - fileselector (which is a concatenation of filename, filesize, filetype and hash)
  • - file-date (which is set to "creation", "modification" or "read" with a date/time, to indicate date/time file was created, last modified or last read)
  • - file-availability (set to a date and time that the file is available until)
  • - file-description (which is set to text specifying description of file)

The file-selector is encoded as shown in the "file-selector-attr" ABNF specified in IETF RFC 5547 [69].

The file-date is encoded as shown in the "file-date-attr" ABNF specified in IETF RFC 5547 [69].

The file-availability is encoded as

file-availability = "file-availability:" date-time
    ;date-time is defined in IETF RFC 5322 [34]

The file-description is encoded as

file-description = "file-description:" <text to describe file>

| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 15.2.18 Notification type + +The purpose of the Notification type information element is to identify the type of notification sent from receiver to the sender. + +The value part of the Notification type information element is coded as shown in Table 15.2.18-1. + +The notification type information element is a type 3 information element with a length of 1 octet. + +**Table 15.2.18.1: Notification type** + +| Bits | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|--------------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | FILE EXPIRED UNAVAILABLE TO DOWNLOAD | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | FILE DELETED UNAVAILABLE TO DOWNLOAD | +| All other values are reserved. | | | | | | | | | + +## 15.2.19 Data query type + +The purpose of the data query type information element is to identify the type of data information that the sender requires from the receiver. + +The value part of the data query request type information element is coded as shown in Figure 15.2.19-1 and Table 15.2.19-1. + +The data query request type information element is a type 1 information element with a length of 1 octet + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------|---|---|---|-----------------------|---|---|---|---------| +| Data query type IEI | | | | Data query type value | | | | octet 1 | + +**Figure 15.2.19-1: Data query type** + +**Table 15.2.19-1: Data query type** + +| | | | | | +|---------------------------------|---|---|---|--------------------------| +| Data query type value (octet 1) | | | | | +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | REMAINING AMOUNT OF DATA | +| All other values are reserved. | | | | | + +## 15.2.20 Comm release Information type + +The purpose of the comm release information type information element is to identify the type of communication release information that the sender wants to inform to the receiver. + +The value part of the comm release information type information element is coded as shown in Table 15.2.20-1. + +The comm release information type information element is a type 3 information element with a length of 1 octet + +**Table 15.2.20-1: Comm release Information type** + +| | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|-----------------------| +| Bits | | | | | | | | | +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | INTENT TO RELEASE | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | EXTENSION REQUEST | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | EXTENSION RESPONSE | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | AUTH USER RELEASE REQ | +| All other values are reserved. | | | | | | | | | + +## 15.2.21 Extension response type + +The purpose of the extension request type information element is to inform MCData server's response towards MCData client's request for extension of the MCData communication. This information element is used only when comm release information type IE takes "EXTENSION RESPONSE" value. The receiver can ignore Extension response type information element value if comm release information type IE takes any other value. + +The value part of the Extension response type information element is coded as shown in Figure 15.2.21.1 and Table 15.2.21-1. + +The Extension response type information element is a type 1 information element. + +![](3e6d714c4066432dc49451f6f86f9766_img.jpg) + +| | | | | | | | | | +|-----------------------------|---|---|---|-------------------------------|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Extension response type IEI | | | | Extension response type value | | | | octet 1 | + +**Figure 15.2.21-1: Extension response type****Table 15.2.21-1: Extension response type** + +| | | | | | +|-----------------------------------------|---|---|---|----------| +| Extension response type value (octet 1) | | | | | +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | ACCEPTED | +| 0 | 0 | 1 | 0 | REJECTED | +| All other values are reserved. | | | | | + +## 15.2.22 Termination Information type + +The purpose of the Termination information type is to identify the type of termination request that the sender wants to inform to the receiver. + +The value part of the Termination information type element is coded as shown in table 15.2.22-1. + +The Termination information type is a type 3 information element with a length of 1 octet. + +**Table 15.2.22-1: Termination Information type** + +| Bits | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|--------------------------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | TERMINATION REQUEST | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | TERMINATION RESPONSE | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | TRANSMISSION STOPPED | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | INTENT TO RELEASE COMM OVER HTTP | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | EXTENSION REQUEST FOR COMM OVER HTTP | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | EXTENSION RESPONSE FOR COMM OVER HTTP | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | AUTH USER TERMINATION REQUEST FOR COMM OVER HTTP | +| All other values are reserved. | | | | | | | | | + +## 15.2.23 Release Response Type + +The purpose of the Release Response Type information element is to inform MCData server's response towards MCData client's request for termination of the MCData communication. This information element is used only when Termination information type IE takes "TERMINATION RESPONSE" value. The receiver can ignore Release response type information element value if Termination information type IE takes any other value + +The value part of the Release response type information element is coded as shown in figure 15.2.23.1 and table 15.2.23-1. + +The Release Response Type information element is a type 1 information element. + +![](40933a545dbad72be6f3656384eed721_img.jpg) + +| | | | | | | | | | +|---------------------------|---|---|---|-----------------------------|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Release Response Type IEI | | | | Release Response Type value | | | | octet 1 | + +**Figure 15.2.23-1: Release Response Type** + +**Table 15.2.23-1: Release Response Type** + +| Release Response Type value (octet 1) | | | | | +|---------------------------------------|---|---|---|-----------------| +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | RELEASE SUCCESS | +| 0 | 0 | 1 | 0 | RELEASE FAILED | +| All other values are reserved. | | | | | + +## 15.2.24 Extended application ID + +The purpose of the Extended application ID information element is to uniquely identify the application for which the payload is intended when the format of the identifier used is not the format available in the Application ID. + +The Extended application ID information element is coded as shown in figure 15.2.24-1, table 15.2.24-1, table 15.2.24-2 and table 15.2.24-3. + +The Extended application ID information element is a type 6 information element. + +![](0f41d1d7623b574c7af88bb7c983c853_img.jpg) + +| | | | | | | | | | +|--------------------------------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Extended application ID IEI | | | | | | | | octet 1 | +| Length of Extended application ID contents | | | | | | | | octet 2 | +| | | | | | | | | octet 3 | +| Extended application ID contents | | | | | | | | octet 4 | +| | | | | | | | | octet n | + +**Figure 15.2.24-1: Extended application ID value****Table 15.2.24-1: Extended application ID contents**![](587ce8b2f9b66fa0db33410888d35966_img.jpg) + +| | | | +|--------------------------------------|--|---------| +| 8   7   6   5   4   3   2   1 | | | +| Extended application ID content type | | octet 4 | +| Extended application ID data | | octet 5 | +| | | octet n | + +**Table 15.2.24-2: Extended application ID content type** + +| Bits | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | TEXT | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | URI | +| All other values are reserved. | | | | | | | | | + +**Table 15.2.24-3: Extended application ID data** + +Extended application ID data is included in octet 5 to octet n; Max length 65534 octets. + +Extended application ID data contains a value that uniquely identifies the destination application, encoded in the format specified by Extended application ID content type. + +A URI is encoded as specified in IETF RFC 3986 [46]. + +## 15.2.25 User location + +The User location information element is used to indicate the current location of the MCData client; + +The User location information element is coded as shown in figure 15.2.25-1 and table 15.2.25-1. + +The User location information element is a type 6 information element. + +![](db388803c917f32f84f9ce6375dfa6b9_img.jpg) + +| | | | +|----------------------------------|--|---------| +| 8   7   6   5   4   3   2   1 | | | +| User location IEI | | octet 1 | +| Length of User location contents | | octet 2 | +| | | octet 3 | +| User location contents | | octet 4 | +| | | octet n | + +**Figure 15.2.25-1: User location information element****Table 15.2.25-1: User location information element** + +User location is contained in octet 4 to octet n; Max value of 65535 octets. + +The User location information element contains the LocationInfo structure defined in subclause 7.4 of 3GPP TS 29.199-09 [65]. + +## 15.2.26 Organization name + +The Organization name information element is used to indicate the name of the organization to which the user belongs. + +The Organization name information element is coded as shown in figure 15.2.26-1 and table 15.2.26-1. + +The Organization name information element is a type 6 information element. + +![](095cb128d8f8cc689f28744e6d5d798d_img.jpg) + +| | | | +|----------------------------------------------------|--|-------------------------------| +| 8      7      6      5      4      3      2      1 | | | +| Length of Organization name contents | | octet 1
octet 2
octet 3 | +| Organization name contents | | octet n | + +**Figure 15.2.26-1: Organization name information element** + +**Table 15.2.26-1: Organization name information element** + +| | +|----------------------------------------------------------------------------------| +| Organization name is contained in octet 3 to octet n; Max value of 65535 octets. | +|----------------------------------------------------------------------------------| + +## 16 Emergency Alert + +### 16.1 General + +This clause describes the emergency alert procedures for on-network. + +For on-network emergency alert, the procedures for originating and terminating MCData clients, participating MCData function and controlling MCData function are specified in subclause 16.2. + +For off-network emergency alert, the procedures for each functional entity is specified in subclause 16.3. + +### 16.2 On-network emergency alert + +#### 16.2.1 Client procedures + +##### 16.2.1.1 Emergency alert origination + +Upon receiving a request from the MCData user to send an MCData emergency alert, the MCData client shall determine whether or not it is authorised to originate an emergency alert, as follows: + +- 1) if the element of the element of a element of the element of the MCData user profile document identified by the MCData ID and profile index associated with MCData user (see 3GPP TS 24.484 [12]) is present and is set to a value of "true", then the MCData emergency alert request shall be considered to be an authorised request for an MCData emergency alert. In all other cases, the MCData client shall indicate to the MCData user that the request for sending an MCData emergency alert is unauthorised and shall terminate this procedure. + +If the request was authorised, but the MCData user has not indicated the identity of the MCData group to receive the emergency alert, the MCData client shall use, in descending order of preference, one of the following: the value of the element of the element of the element in the MCData user profile, if present; if not, the identity of the MCData group to which the most recent communication or affiliation request was made by the MCData client since last acquiring the MCData service. If an MCData group identity cannot be determined, the MCData client shall indicate the fact to the MCData user and shall terminate this procedure. + +The MCData client shall generate a SIP MESSAGE as an out-of-dialog request, in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6], and: + +- 1) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP MESSAGE request; +- 2) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + +- 3) may include a P-Preferred-Identity header field in the SIP MESSAGE request containing a public user identity as specified in 3GPP TS 24.229 [5]; +- 4) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element (see clause D.1) with: + - a) the element set to the MCData group identity; + - b) the <>alert-ind> element set to a value of "true"; + - c) the element set to the MCData client ID of the originating MCData client; and + - d) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP MESSAGE request, the element set to the URI of the used functional alias; +- 5) shall include an application/vnd.3gpp.mcdata-location-info+xml MIME body with a element included in the root element (see clause D.x); +- 6) shall include in the element the specific location information configured for the MCData emergency alert location trigger; +- 7) shall set the MCData emergency state if not already set; +- 8) shall set the MCData emergency alert state to "MDEA 2: emergency-alert-confirm-pending"; +- 9) shall set the Request-URI to the public service identity identifying the participating MCData function serving the group identity; and +- 10) shall send the SIP MESSAGE request according to rules and procedures of 3GPP 24.229 [5]; + +On receiving a SIP 2xx response to the SIP MESSAGE request, the MCData client shall set the MCData emergency alert state to "MDEA 3: emergency-alert-initiated" and shall give the MCData user an indication of success. + +On receiving a SIP 4xx response a SIP 5xx response or a SIP 6xx response to the SIP MESSAGE request, the MCData client shall set the MCData emergency alert state to "MDEA 1: no-alert" and shall indicate the failure to the MCData user. + +NOTE: If no response is received after an implementation dependent amount of time or if there is an indication of communication failure, the MCData client can inform the user, and can clear the MCData emergency alert state or can retry sending the emergency alert to the MCData participating server. The MCData emergency state is left unchanged, as the MCData user presumably is in the best position to determine whether or not there still is an emergency situation and can use manual clearing, as necessary. + +### 16.2.1.2 Emergency alert cancellation + +Upon receiving a request from the MCData user to send an MCData emergency alert cancellation, the MCData client shall determine whether or not it is authorised to cancel an emergency alert, as follows: + +- 1) if the MCData emergency cancellation request is for an MCData emergency alert originated by this MCData user, then the request shall be considered authorised if element of the element of a element of the element of the MCData user profile document identified by the MCData ID and profile index associated with MCData user (see 3GPP TS 24.484 [12]) is present and is set to a value of "true"; and +- 2) if the MCData emergency cancellation request is for an MCData emergency alert originated by a different MCData user, then the request shall be considered authorised if element of the element of a element of the element of the MCData user profile document identified by the MCData ID and profile index associated with MCData user (see 3GPP TS 24.484 [12]) is present and is set to a value of "true". + +If the MCData emergency cancellation request is not considered authorised, the MCData client shall indicate this fact to the requesting MCData user and shall terminate this procedure. + +If the authorised MCData emergency cancellation request is for an MCData emergency alert originated by this MCData user and if there are more than one outstanding emergency alerts from this MCData user and the MCData user has not + +indicated which one to cancel, the MCData client shall terminate this procedure after giving an indication of the condition to the MCData user. + +The MCData client shall generate a SIP MESSAGE out-of dialog request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] and: + +- 1) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 2) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 3) may include a P-Preferred-Identity header field containing a public user identity as specified in 3GPP TS 24.229 [5]; +- 4) if the MCData emergency alert was originated by this MCData user, shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element (see clause D.1) with: + - a) the element set to the MCData group identity; + - b) the element set to a value of "false"; + - c) the element set to the MCData client ID of this MCData client; and + - d) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP MESSAGE request, the element set to the URI of the used functional alias; +- 5) if the MCData emergency alert was originated by a different MCData user, shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element (see clause D.1) with: + - a) the element set to the MCData group identity; + - b) the element set to a value of "false"; + - c) the element set to the MCData ID of the MCData user who originated the MCData emergency alert; and + - d) if the MCData client is aware of active functional aliases, and an active functional alias is to be included in the SIP MESSAGE request, the set to the URI of the used functional alias; +- 6) shall set the Request-URI to the public service identity identifying the participating MCData function serving the group identity; +- 7) if the generated SIP MESSAGE request does not contain an element in the application/vnd.3gpp.MCData-info+xml MIME body, shall set the MCData emergency alert state to "MDEA 4: emergency-alert-cancel-pending"; and +- 8) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of a SIP MESSAGE request containing an application/vnd.3gpp.mcdata-info+xml MIME body with an element set to "true" and an matching the MCData client ID included in the sent SIP MESSAGE request and if the sent SIP MESSAGE request did not contain an element in its application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall: + +- 1) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the received SIP MESSAGE request is set to a value of "false": + - a) set the MCData emergency alert state to "MDEA 1: no-alert"; and + - b) clear the MCData emergency state if not already cleared; and + +- 2) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the received SIP MESSAGE request is set to a value of "true" and if the MCData emergency alert state is set to "MDEA 4: emergency-alert-cancel-pending": + - a) set the MCData emergency alert state to "MDEA 1: no-alert". + +NOTE: It would appear to be an unusual situation for the initiator of an MCData emergency alert to not be able to clear their own alert. Nevertheless, an MCData user can be configured to be authorised to initiate MCData emergency alerts but not have the authority to clear them. Hence, the case is covered here. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the sent SIP MESSAGE emergency alert cancellation request, if the sent SIP MESSAGE request did not contain an element in the application/vnd.3gpp.mcdata-info+xml MIME body and the MCData emergency alert state is set to "MDEA 4: emergency-alert-cancel-pending": + +- 1) if the received SIP 4xx response, SIP 5xx response or SIP 6xx response does not contain an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element containing the element OR if it contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to a value of "true" (see clause D.1), the MCData client shall set the MCData emergency alert state to "MDEA 3: emergency-alert-initiated". + +### 16.2.1.3 MCData client receives an MCData emergency alert or communication notification + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +Upon receipt of a "SIP MESSAGE request for emergency notification", the MCData client: + +- 1) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "true", should display to the MCData user an indication of the MCData emergency alert and associated information, including: + - a) the MCData group identity contained in element of the application/vnd.3gpp.mcdata-info+xml MIME body; + - b) the originator of the MCData emergency alert contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body; and + - c) the mission critical organization of the MCData emergency alert originator contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body; + +NOTE 1: This is the case of the MCData client receiving the notification of another MCData user's emergency alert. + +- 2) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false": + - a) should display to the MCData user an indication of the MCData emergency alert cancellation and associated information, including: + - i) the MCData group identity contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body; and + - ii) the originator of the MCData emergency alert contained in: + - A) if present, the element of the application/vnd.3gpp.mcdata-info+xml MIME body; or + - B) the element of the application/vnd.3gpp.mcdata-info+xml MIME body; + - b) if the MCData ID contained in the element is the MCData ID of the receiving MCData user, shall set the MCData emergency alert state to "MDEA 1: no-alert"; and + +- c) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element is set to a value of "false": + - i) shall set the MCData emergency group state to "MDEG 1: no-emergency"; and + - ii) shall set the MCData emergency group communication state to "MDEGC 1: emergency-gc-capable"; + +NOTE 2: This is the case of the MCData client receiving the notification of the cancellation by a third party of an MCData emergency alert. This can be the MCData emergency alert of another MCData user or the MCData emergency alert of the recipient, as determined by the contents of the element. Optionally, notification of the cancellation of the in-progress emergency state of the MCData group can be included. + +- 3) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "true": + +- a) should display to the MCData user an indication of the additional emergency MCData user participating in the MCData emergency group communication including the following, if not already displayed as part of step 1): + +- i) the MCData group identity contained in the element application/vnd.3gpp.mcdata-info+xml MIME body; and +- ii) the element of the application/vnd.3gpp.mcdata-info+xml MIME body; and + +- b) shall set the MCData emergency group state to "MDEG 2: in-progress" if not already set to that value; + +NOTE 3: This is the case of the MCData client receiving notification of an additional MCData user in an MCData emergency state (i.e., not the MCData user that originally triggered the in-progress emergency state of the group) joining the in-progress emergency group communication. An emergency alert indication, if included, is handled in step 1). + +- 4) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false": + +- a) should display to the MCData user an indication of the cancellation of the in-progress emergency state of the MCData group communication including the following if not already displayed as part of step 2): + +- i) the MCData group identity contained in the element of the application/vnd.3gpp.mcdata-info+xml MIME body; and +- ii) the element of the application/vnd.3gpp.mcdata-info+xml MIME body; + +- b) shall set the MCData emergency group state to "MDEG 1: no-emergency"; and + +- c) shall set the MCData emergency group communication state to "MDEGC 1: emergency-gc-capable"; + +NOTE 4: This is the case of the MCData client receiving the notification of the cancellation of the in-progress emergency state of the MCData group. In this case, the receiving MCData client is affiliated with the MCData group but not participating in the session. An emergency alert cancellation, if included, is handled in step 2). + +- 5) shall generate a SIP 200 (OK) response according to rules and procedures of TS 24.229 [5]; and + +- 6) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of TS 24.229 [5]. + +## 16.2.2 Participating MCData function procedures + +### 16.2.2.1 Receipt of a SIP MESSAGE request for emergency notification from the served MCData client + +**Editor's note:** In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +Upon receipt of a "SIP MESSAGE request for emergency notification for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field in the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; + +NOTE 1: if the SIP MESSAGE request contains an emergency indication set to a value of "true" or an alert indication set to a value of "true", the participating MCData function can, according to local policy, choose to accept the request. + +- 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP MESSAGE request, and shall authorise the calling user; + +NOTE 2: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in clause 7.3. + +- 3) if the MCData user is not affiliated with the MCData group as determined by clause 8.3.2.11, shall perform the actions specified in clause 8.3.2.12 for implicit affiliation; +- 4) if the actions for implicit affiliation specified in step 3) above were performed but not successful in affiliating the MCData user due to the MCData user already having N2 simultaneous affiliations, shall reject the "SIP MESSAGE request for emergency notification for originating participating MCData function" with a SIP 486 (Busy Here) response with the warning text set to "102 too many simultaneous affiliations" in a Warning header field as specified in clause 4.9 and skip the rest of the steps; + +NOTE 3: N2 is the total number of MCData groups that an MCData user can be affiliated to simultaneously as specified in 3GPP TS 23.282 [2]. + +NOTE 4: As this is a request for MCData emergency services, the participating MCData function can choose to accept the request. + +- 5) shall determine the public service identity of the controlling MCData function associated with the group identity in the received SIP MESSAGE request; +- 6) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 7) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the controlling MCData function associated with the group identified by the element contained in the element containing the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the incoming SIP MESSAGE request; +- 8) shall copy the contents of the application/vnd.3gpp.mcdata-info+xml MIME body in the received SIP MESSAGE request into an application/vnd.3gpp.mcdata-info+xml MIME body as specified in clause D.1 included in the outgoing SIP MESSAGE request; +- 9) shall set the element of the element containing the element to the MCData ID determined in step 2) above; +- 10) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-location-info+xml MIME body as specified in clause D.4, shall copy the contents of the application/vnd.3gpp.mcdata-location-info+xml MIME body in the received SIP MESSAGE request into an application/vnd.3gpp.mcdata-location-info+xml MIME body included in the outgoing SIP MESSAGE request; +- 11) shall set the P-Asserted-Identity in the outgoing SIP MESSAGE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP MESSAGE request; +- 12) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request to the received value, otherwise shall not include a element; and +- 13) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 2xx response in response to the SIP MESSAGE request sent in step 12): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5] with the follow clarifications: + - a) shall include the public user identity received in the P-Asserted-Identity header field of the incoming SIP 2xx response into the P-Asserted-Identity header field of the outgoing SIP 200 (OK) response; +- 2) if the procedures of clause 8.3.2.12 for implicit affiliation were performed in the present subclause, shall complete the implicit affiliation by performing the procedures of clause 8.3.2.13; and +- 3) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the sent SIP MESSAGE request and if the implicit affiliation procedures of clause 8.3.2.12 were invoked in the present subclause, the participating MCData function shall perform the procedures of subclause 8.3.2.14. + +### 16.2.2.2 Receipt of a SIP MESSAGE request for emergency notification for terminating MCData client + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +In the procedures in this subclause: + +- 1) emergency indication in an incoming SIP MESSAGE request refers to the element of the application/vnd.3gpp.mcdata-info+xml MIME body; and +- 2) alert indication in an incoming SIP MESSAGE request refers to the element of the application/vnd.3gpp.mcdata-info+xml MIME body. + +Upon receipt of a "SIP MESSAGE requests for emergency notification for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field in the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; + +NOTE 1: if the SIP MESSAGE request contains an emergency indication set to a value of "true" or an alert indication set to a value of "true", the participating MCData function can, by means beyond the scope of this specification, choose to accept the request. + +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request to retrieve the binding between the MCData ID and public user identity; +- 3) if the binding between the MCData ID and public user identity does not exist, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response and skip the rest of the steps. Otherwise, continue with the rest of the steps; +- 4) shall generate an outgoing SIP MESSAGE request as specified in subclause 6.3.2.1; and +- 5) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the participating MCData function shall follow the procedures specified in TS 24.229 [5]. + +### 16.2.2.3 Receipt of a SIP MESSAGE request indicating successful delivery of emergency notification + +Upon receipt of a SIP MESSAGE request routed to the terminating participating MCData function with the Request-URI set to the public service identity of the terminating participating MCData function and the SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with an element present, the participating MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field in the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP MESSAGE request to retrieve the binding between the MCData ID and public user identity; +- 3) if the binding between the MCData ID and public user identity does not exist, then the participating MCData function shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response and skip the rest of the steps. Otherwise, continue with the rest of the steps; +- 4) shall generate an outgoing SIP MESSAGE request in accordance with TS 24.229 [5] and IETF RFC 3428 [6] and: + - a) shall include in the SIP MESSAGE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [8] that were received (if any) in the incoming SIP MESSAGE request; + - b) shall set the Request-URI of the outgoing SIP MESSAGE request to the public user identity associated to the MCData ID of the MCData user that was in the Request-URI of the incoming SIP MESSAGE request; + - c) shall copy the contents of the application/vnd.3gpp.mcdata-info+xml MIME body received in the incoming SIP MESSAGE request into an application/vnd.3gpp.mcdata-info+xml MIME body included in the outgoing SIP MESSAGE request; and + - d) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP MESSAGE request to the P-Asserted-Identity header field of the outgoing SIP MESSAGE request; and +- 5) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the participating MCData function shall follow the procedures specified in 3GPP TS 24.229 [5]. + +### 16.2.3 Controlling MCData function procedures + +#### 16.2.3.1 Handling of a SIP MESSAGE request for emergency notification + +Upon receipt of a "SIP MESSAGE request for emergency notification for controlling MCData function", the controlling MCData function: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field in the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps. Otherwise, continue with the rest of the steps; + +NOTE: If the SIP MESSAGE request contains an alert indication set to a value of "true", the controlling MCData function can, according to local policy, choose to accept the request. + +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata", "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" or "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd"; +- 3) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false", shall perform the procedures specified in clause 16.2.3.2 and skip the rest of the steps; +- 4) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "true": + - a) if the received SIP MESSAGE request is an unauthorised request for an MCData emergency alert as specified in subclause 6.3.7.2.1, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request as specified in 3GPP TS 24.229 [5] with the following clarifications: + +- i) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcdata-info+xml MIME body as specified in clause D.1 with the element containing the element with the element set to a value of "false"; and + - ii) shall send the SIP 403 (Forbidden) response as specified in TS 24.229 [5] and skip the rest of the steps; and +- b) if the received SIP MESSAGE request is an authorised request for an MCData emergency alert as specified in subclause 6.3.7.2.1: + - i) if the sending MCData user identified by the element included in the application/vnd.3gpp.mcdata-info+xml MIME body is not affiliated with the MCData group identified by the element of the MIME body as determined by the procedures of subclause 6.3.5: + - I) shall check if the MCData user is eligible to be implicitly affiliated with the MCData group as determined by subclause 8.3.3.6; + - II) if the MCData user is determined not to be eligible to be implicitly affiliated to the MCData group shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in subclause 4.9 and skip the rest of the steps below; or + - III) if the procedures of clause 8.3.3.6 determined the MCData user to be eligible to be implicitly affiliated to the MCData group, shall perform the implicit affiliation as specified in clause 8.3.3.7; + - ii) for each of the other affiliated members of the group: + - A) generate an outgoing SIP MESSAGE request notification of the MCData user's emergency alert indication as specified in subclause 6.3.7.1.2 with the clarifications of subclause 6.3.7.1.3; + - B) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - C) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request to the received value, otherwise shall not include a element; and + - D) send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]; + - iii) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [5] with the following clarifications: + - A) shall cache the information that the MCData user has initiated an MCData emergency alert; + - iv) shall send the SIP 200 (OK) response to the received SIP MESSAGE according to rules and procedures of 3GPP TS 24.229 [5]. + - v) shall generate a SIP MESSAGE request as described in subclause 6.3.7.1.5 to indicate successful receipt of an emergency alert, and shall include in the application/vnd.3gpp.mcdata-info+xml MIME body: + - A) the element set to a value of "true"; + - B) the element set to a value of "true"; and + - C) the element with the MCData client ID that was included in the incoming SIP MESSAGE request; and + - vi) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the controlling MCData function shall follow the procedures specified in 3GPP TS 24.229 [5]. + +### 16.2.3.2 Handling of a SIP MESSAGE request for emergency alert cancellation + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +Upon receipt of a "SIP MESSAGE request for emergency notification for controlling MCData function" containing an application/vnd.3gpp.mcdata-info+xml MIME body with the element set to a value of "false", the controlling MCData function: + +- 1) if the received SIP MESSAGE request is an unauthorised request for an MCData emergency alert cancellation as specified in clause 6.3.7.2.1: + - a) and if the received SIP MESSAGE request does not contain an element or is an unauthorised request for an MCData emergency communication cancellation as specified in clause 6.3.7.2.3, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request as specified in 3GPP TS 24.229 [5] with the following clarifications: + - i) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcdata-info+xml MIME body as specified in clause D.1 with the element containing the element with the element set to a value of "true"; + - ii) if the received SIP MESSAGE request contains an element of the element set to a value of "false" and if the in-progress emergency state of the group is set to a value of "true" and this is an unauthorised request for an MCData emergency communication cancellation as determined in step i) above, shall include an element set to a value of "true" in the application/vnd.3gpp.mcdata-info+xml MIME body in the SIP 403 (Forbidden) response; and + - iii) shall send the SIP 403 (Forbidden) response according to rules and procedures of 3GPP TS 24.229 [5] and skip the rest of the steps; and + - b) and if the received SIP MESSAGE request contains an element and is an authorised request for an MCData emergency communication cancellation as specified in clause 6.3.7.2.3 and the in-progress emergency state of the MCData group is set to a value of "true": + - i) shall set the in-progress emergency state of the group to a value of "false"; + - ii) shall clear the cache of the MCData ID of the MCData user that triggered the setting of the in-progress emergency state of the MCData group; + - iii) shall generate SIP re-INVITE requests to the other affiliated and joined members of the MCData group as specified in clause 6.3.7.1.1, and + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCData client as specified in 3GPP TS 24.229 [5]; + - iv) for each of the affiliated but not joined members of the group, shall: + - A) generate a SIP MESSAGE request notification of the cancellation of the MCData user's emergency communication as specified in clause 6.3.7.1.2; + - B) include in the application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; and + - C) include an element set to a value of "false" in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; + - D) send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]; + - v) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in TS 24.229 [5]; + - vi) shall send the SIP 200 (OK) response to the received SIP MESSAGE as specified in 3GPP TS 24.229 [5]; + +- vii) shall generate a SIP MESSAGE request as described in clause 6.3.7.1.5 to indicate successful emergency communication cancellation; + - viii) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP MESSAGE request: + - A) the element set to a value of "true"; + - B) the element set to a value of "true"; + - C) the element set to a value of "false"; and + - D) the element with the MCData client ID that was included in the incoming SIP MESSAGE request; and + - ix) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]; and +- 2) if the received SIP MESSAGE request is an authorised request for an MCData emergency alert cancellation as specified in clause 6.3.7.2.2: +- a) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcdata-info+xml MIME body, shall clear the cache of the MCData ID of the MCData user identified by the element as having an outstanding MCData emergency alert; + - b) if the received SIP MESSAGE request does not contain an element in the application/vnd.3gpp.mcdata-info+xml MIME body, clear the cache of the MCData ID of the sender of the SIP MESSAGE request as having an outstanding MCData emergency alert; + - c) if the received SIP MESSAGE request does not contain an element or is an unauthorised request for an MCData emergency communication cancellation as specified in clause 6.3.7.2.3, for each of the affiliated but not joined members of the group shall: + - i) generate a "SIP MESSAGE request for emergency notification for terminating participating MCData function" to cancel the MCData user's emergency alert as specified in clause 6.3.7.1.2; + - ii) include in the application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - iii) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcdata-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; + - iv) include an element set to a value of "false" in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; and + - v) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]; + - d) if the received SIP MESSAGE request contains an element and is an authorised request for an MCData emergency communication cancellation as specified in clause 6.3.7.2.3 and the in-progress emergency state of the MCData group is set to a value of "true": + - i) shall set the in-progress emergency state of the group to a value of "false"; + - ii) shall cache the information that the MCData user has cancelled the outstanding in-progress emergency state of the group; + - iii) shall generate SIP re-INVITE requests to the other affiliated and joined members of the MCData group as specified in clause 6.3.7.1.1, and + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCData client as specified in 3GPP TS 24.229 [5]; + - iv) for each of the affiliated but not joined members of the group, shall: + +- A) generate a SIP MESSAGE request notification of the cancellation of the MCData user's emergency communication as specified in clause 6.3.7.1.2; + - B) include in the application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - C) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcdata-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; + - D) include in the application/vnd.3gpp.mcdata-info+xml MIME body an element set to a value of "false"; + - E) include an element set to a value of "false" in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; and + - F) send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [5]; +- e) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [5]; + - f) shall send the SIP 200 (OK) response to the received SIP MESSAGE as specified in 3GPP TS 24.229 [5]. + - g) shall generate a SIP MESSAGE request as described in clause 6.3.7.1.5 to indicate successful receipt of the request for emergency alert cancellation; + - h) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body, the element set to a value of "false" and the set to "true"; + - i) shall populate the element with the MCData client ID that was included in the incoming SIP MESSAGE request; + - j) if the received SIP MESSAGE request contains an element of the element set to a value of "false": + - i) if this is an authorised request for an MCData emergency communication cancellation as specified in clause 6.3.7.2.3, shall include an element set to a value of "false" in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; and + - ii) otherwise, if this is an unauthorised request for an MCData emergency communication cancellation as specified in clause 6.3.7.2.3, and the in-progress emergency state of the group is set to a value of "true", shall include an element set to a value of "true" in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP MESSAGE request; + - k) shall send the SIP MESSAGE request according to according to the rules and procedures of TS 24.229 [5]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the controlling MCData function shall follow the procedures specified in 3GPP TS 24.229 [5]. + +## 16.3 Off-network emergency alert + +### 16.3.1 General + +### 16.3.2 Basic state machine + +#### 16.3.2.1 General + +#### 16.3.2.2 Emergency alert state machine + +The figure 16.3.2.2-1 gives an overview of the main states and transitions on the UE for emergency alert. + +Each emergency alert state machine is per MCData group. + +![Figure 16.3.2.2-1: Emergency alert state machine diagram. It shows two states: 'E1: Not in emergency state' (left) and 'E2: Emergency state' (right). A curved arrow points from E1 to E2. A return arrow points from E2 to E1, passing through a rectangular box labeled 'TFE2'.](e645ed71024459749170f5d01e301b37_img.jpg) + +``` + +stateDiagram-v2 + [*] --> E1 + E1 --> E2 + E2 --> E1 : TFE2 + +``` + +Figure 16.3.2.2-1: Emergency alert state machine diagram. It shows two states: 'E1: Not in emergency state' (left) and 'E2: Emergency state' (right). A curved arrow points from E1 to E2. A return arrow points from E2 to E1, passing through a rectangular box labeled 'TFE2'. + +**Figure 16.3.2.2-1: Emergency alert state machine** + +The following piece of information is associated with the emergency alert state machine: + +- a) the stored emergency state of the MCData group. + +NOTE: The emergency alert state machine is referred by the MCData off-network group call and MCData off-network private call procedures. + +### 16.3.2.3 Emergency alert states + +#### 16.3.2.3.1 E1: Not in emergency state + +This state is the start state of this state machine. + +The UE stays in this state while not in emergency state. + +#### 16.3.2.3.2 E2: Emergency state + +This state exists for UE, when the UE has sent a GROUP EMERGENCY ALERT message. + +### 16.3.3 Procedures + +#### 16.3.3.1 Originating user sending emergency alert + +When in state "E1: Not in emergency state", upon receiving an indication from the MCData user to transmit an emergency alert for an MCData group ID and the value of "/Common/AllowedActivateAlert" leaf node present in the user profile as specified in 3GPP TS 24.483 [42] is set to "true", the MCData client: + +- 1) shall set the stored emergency state as "true"; +- 2) shall set the stored MCData group ID to the indicated MCData group ID; +- 3) shall generate a GROUP EMERGENCY ALERT message as specified in subclause 15.1.14. In the GROUP EMERGENCY ALERT message, the MCData client: + - a) shall set the MCData group ID IE to the stored MCData group ID; + - b) shall set the Originating MCData user ID IE to own MCData user ID; + - c) may set the Organization name IE to own organization name; and + - d) may set the User location IE with client's current location, if requested; +- 4) shall send the GROUP EMERGENCY ALERT message as specified in subclause 9.3.1.2; +- 5) shall start timer TFE2 (emergency alert retransmission); and + +- 6) shall enter "E2: Emergency state" state. + +### 16.3.3.2 Emergency alert retransmission + +When in state "E2: Emergency state", upon expiry of timer TFE2 (emergency alert retransmission), the MCData client: + +- 1) shall generate a GROUP EMERGENCY ALERT message as specified in subclause 15.1.14. In the GROUP EMERGENCY ALERT message, the MCData client: + - a) shall set the MCData group ID IE to the stored MCData group ID; + - b) shall set the originating MCData user ID IE to own MCData user ID; + - c) may set the Organization name IE to own organization name; and + - d) may set the Location IE with client's current location, if requested; +- 2) shall send the GROUP EMERGENCY ALERT message as specified in subclause 9.3.1.2; +- 3) shall start the timer TFE2 (emergency alert retransmission); and +- 4) shall remain in the current state. + +### 16.3.3.3 Terminating user receiving emergency alert + +When in state "E1: Not in emergency state" or in "E2: Emergency state", upon receiving a GROUP EMERGENCY ALERT message with the Originating MCData user ID IE not stored in the list of users in emergency, the MCData client: + +- 1) shall store the Originating MCData user ID IE and location IE in the list of users in emergency; +- 2) shall generate a GROUP EMERGENCY ALERT ACK message as specified in subclause 15.1.15. In the GROUP EMERGENCY ALERT ACK message, the MCData client: + - a) shall set the MCData group ID IE to the MCData group ID IE of the received GROUP EMERGENCY ALERT message; + - b) shall set the Sending MCData user ID IE to own MCData user ID; + - c) shall set the Originating MCData user ID IE to the Originating MCData user ID IE of the received GROUP EMERGENCY ALERT message; and +- 3) shall send the GROUP EMERGENCY ALERT ACK message as specified in subclause 9.3.1.2; +- 4) shall start timer TFE1 (Emergency Alert); and +- 5) shall remain in the current state. + +NOTE: Each instance of timer TFE1 is per MCData user ID. + +**Editor's Note: [CR 0095, WI eMCData2] Use of timer TFE1 in case of several emergency alerts from multiple users is FFS.** + +### 16.3.3.4 Terminating user receiving retransmitted emergency alert + +When in state "E1: Not in emergency state" or in "E2: Emergency state", upon receiving a GROUP EMERGENCY ALERT message with the Originating MCData user ID IE stored in the list of users in emergency and Location IE different than the stored location of the user, the MCData client: + +- 1) may update the stored location of the user with the received Location IE; +- 2) shall restart the associated timer TFE1 (Emergency Alert); and +- 3) shall remain in the current state. + +### 16.3.3.5 Originating user cancels emergency alert + +When in "E2: Emergency state", upon receiving an indication from the MCData user to cancel an emergency alert and the value of "/Common/AllowedCancelAlert" leaf node present in the user profile as specified in 3GPP TS 24.483 [42] is set to "true", the MCData client: + +- 1) shall set the stored emergency state as "false"; +- 2) shall generate a GROUP EMERGENCY ALERT CANCEL message as specified in subclause 15.1.16. In the GROUP EMERGENCY ALERT CANCEL message, the MCData client: + - a) shall set the MCData group ID IE to the stored MCData group ID; and + - b) shall set the Originating MCData user ID IE to own MCData user ID; +- 3) shall send the GROUP EMERGENCY ALERT CANCEL message as specified in subclause 9.3.1.2; +- 4) shall stop timer TFE2 (emergency alert retransmission); and +- 5) shall enter "E1: Not in emergency state" state. + +### 16.3.3.6 Terminating user receives GROUP EMERGENCY ALERT CANCEL message + +When in state "E1: Not in emergency state" or in "E2: Emergency state", upon receiving a GROUP EMERGENCY ALERT CANCEL message with the Originating MCData user ID IE stored in the list of users in emergency, the MCData client: + +- 1) shall remove the MCData user ID and associated location information from the stored list of users in emergency; +- 2) shall generate a GROUP EMERGENCY ALERT CANCEL ACK message as specified in subclause 15.1.17. In the GROUP EMERGENCY ALERT CANCEL ACK message, the MCData client: + - a) shall set the MCData group ID IE to the MCData group ID IE of the received GROUP EMERGENCY ALERT CANCEL message; + - b) shall set the Sending MCData user ID IE to own MCData user ID; and + - c) shall set the Originating MCData user ID IE to the Originating MCData user ID IE of the received GROUP EMERGENCY ALERT message; +- 3) shall send the GROUP EMERGENCY ALERT CANCEL ACK message as specified in subclause 9.3.1.2; +- 4) shall stop the associated timer TFE1 (Emergency Alert); and +- 5) shall remain in the current state. + +### 16.3.3.7 Implicit emergency alert cancel + +When in state "E1: Not in emergency state" or in "E2: Emergency state", upon expiry of timer TFE1 (Emergency Alert) associated with a stored MCData user ID, the MCData client: + +- 1) shall remove the MCData user ID and associated location information from the stored list of users in emergency; and +- 2) shall remain in the current state. + +--- + +## 17 Location procedures + +### 17.1 General + +If the participating MCData function needs to obtain location information, the participating MCData function configures the MCData client upon successful MCData service authorization. The configuration contains information + +the MCData client uses to set up filter criteria for when the MCData client shall send location reports to the participating MCData function. + +The participating MCData function can also explicitly request the MCData client to send a location report. + +The MCData client will, based on the received configuration or when explicitly requested, send location reports. + +The location information can be used by the participating MCData function to determine whether to use MBMS bearers or not. + +## 17.2 Participating MCData function location procedures + +### 17.2.1 General + +The participating MCData function has procedures to: + +- configure the location reporting at the UE; +- request the UE to report the location of the UE; and +- receive a location information report from the UE. + +### 17.2.2 Location reporting configuration + +The participating MCData function may configure the location reporting in the MCData client by generating a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. The participating MCData function: + +- 1) shall include a Request-URI set to the URI from MCData service authorization corresponding to the MCData ID of the MCData user; +- 2) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" in accordance with IETF RFC 3841 [8]; +- 3) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with an element containing the MCData ID of the MCData user to receive the configuration; +- 4) shall include an application/vnd.3gpp.mcdata-location-info+xml MIME body with the element contained in the root element set to the desired configuration; +- 5) shall include the TriggerId attribute where defined for the sub-elements defining the trigger criterion; +- 6) shall include the public service identity of the participating MCData function in the P-Asserted-Identity header field; +- 7) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; and +- 8) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +### 17.2.3 Location information request + +If the participating MCData function needs to request the MCData client to report its location, the participating MCData functions shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. The participating MCData function: + +- 1) shall include a Request-URI set to the URI from MCData service authorization corresponding to the MCData ID of the MCData user; +- 2) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" in accordance with IETF RFC 3841 [8]; +- 3) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with an element containing the MCData ID of the MCData user; + +- 4) shall include an application/vnd.3gpp.mcdata-location-info+xml MIME body with a element contained in the root element; +- 5) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; and +- 6) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +## 17.2.4 Location information report + +If the participating MCData function receives a SIP request containing: + +- 1) a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml"; and +- 2) an application/vnd.3gpp.mcdata-location-info+xml MIME body with a element included in the root element; + +then the participating MCData function shall authorise the location report based on the MCData ID received. If the MCData user is authorised to send a location report the participating MCData function: + +- 1) shall use the location information as needed. + +NOTE: The element contains the event triggering identity in the location information report from the UE, and can contain location information. + +## 17.2.5 Abnormal cases + +Upon receipt of a SIP request: + +- 1) where the P-Asserted-Identity identifies a public user identity not associated with an MCData user served by the participating MCData function; or +- 2) with a MIME body with Content-Type header field set to "application/vnd.3gpp.mcdata-info+xml" and with a element containing an MCData ID that identifies an MCData user served by the participating MCData function; + +then, when the SIP request contains: + +- 1) an Accept-Contact header field with the g.3gpp.mcdata media feature tag; +- 2) an Accept-Contact header field with the g.3gpp.icsi-ref media-feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata"; and +- 3) an application/vnd.3gpp.mcdata-location-info+xml MIME body containing a element or a element; + +the participating MCData function shall remove the application/vnd.3gpp.mcdata-location-info+xml MIME body when sending a SIP request. + +# 17.3 MCData client location procedures + +## 17.3.1 General + +The MCData client sends a location report when one of the trigger criteria is fulfilled or when it receives a request from the participating MCData function to send a location report. To send the location report the MCData client can use an appropriate SIP message that it needs to send for other reasons, or it can include the location report in a SIP MESSAGE request. + +To send a location report, the MCData client includes in the SIP MESSAGE request an application/vnd.3gpp.mcdata-location-info+xml MIME body as specified in clause D.4. The MCData client populates the elements in accordance with its reporting configuration. Further location information may also be included in the P-Access-Network-Info header field. + +## 17.3.2 Location reporting configuration + +Upon receiving a SIP MESSAGE request containing: + +- 1) an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 2) a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml"; and +- 3) an application/vnd.3gpp.mcdata-location-info+xml MIME body with a root element included in the root element; + +the MCData client: + +- 1) shall store the contents of the elements; +- 2) shall set the location reporting triggers accordingly; and +- 3) shall start the minimumReportInterval timer. + +## 17.3.3 Location information request + +Upon receiving a SIP MESSAGE request containing: + +- 1) an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 2) a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml"; and +- 3) an application/vnd.3gpp.mcdata-location-info+xml MIME body with a element included in the root element; + +the MCData client: + +- 1) shall send a location report as specified in subclause 17.3.4; and +- 2) shall reset the minimumReportInterval timer. + +## 17.3.4 Location information report + +### 17.3.4.1 Report triggering + +If a location reporting trigger fires, the MCData client checks if the minimumReportInterval timer is running. If the timer is running the MCData client waits until the timer expires. When the minimumReportInterval timer expires, the MCData client: + +- 1) shall, if any of the reporting triggers are still true, send a location information report as specified in subclause 17.3.4.2. + +If the MCData client receives a location information request as specified in subclause 17.3.3, the MCData client shall send a location report as specified in subclause 17.3.4.2. + +### 17.3.4.2 Sending location information report + +If the MCData client needs to send a SIP request anyway (i.e. for reasons other than explicit location reporting request or the firing of a configured location trigger), the MCData client: + +- 1) shall include an application/vnd.3gpp.mcdata-location-info+xml MIME body and in the root element the MCData client shall include: + - a) a element and, if the Report was triggered by a location request, include the attribute set to the value of the attribute in the received Request; + - b) child elements, if triggers have fired, where each element is set to the value of the attribute associated with the triggers that have fired; and + +- c) the location reporting elements corresponding to the triggers that have fired, if at least one trigger has fired; +- 2) shall set the minimumReportInterval timer to the minimumReportInterval time and start the timer; and +- 3) shall reset all triggers. + +If the MCData client does not need to send a SIP request for reasons other than explicit location reporting request or the firing of a configured location trigger, the MCData client shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. The MCData client; + +- 1) shall include in the Request-URI, the SIP URI received in the P-Asserted-Identity header field in the received SIP MESSAGE request for location report configuration; +- 2) shall include a Content-Type header field set to "application/vnd.3gpp.mcdata-location-info+xml"; +- 3) shall include an application/vnd.3gpp.mcdata-location-info+xml MIME body and in the root element include: + - a) a element and if the Report was triggered by a location request include the attribute set to the value of the attribute in the received Request; + - b) child elements, if triggers have fired, where each element is set to the value of the attribute associated with the triggers that have fired; and + - c) the location reporting elements corresponding to the triggers that have fired, if at least one trigger has fired; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.mcdata along with parameters "require" and "explicit" in accordance with IETF RFC 3841 [8]; +- 5) shall set the minimumReportInterval timer to the minimumReportInterval time and start the timer; +- 6) shall reset all triggers; and +- 7) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [5]. + +--- + +## 18 Pre-established session + +### 18.1 General + +The MCData client may establish one or more pre-established sessions to the participating MCData function at any time after SIP registration and setting the service settings as defined in subclause 7.2.2 or subclause 7.2.3. + +The MCData client may use the pre-established session for originating standalone SDS using media plane or SDS session after pre-established session establishment. + +The participating MCData function may use the pre-established session for terminating standalone SDS using media plane or SDS session after pre-established session establishment. + +The use of a pre-established session requires the use of resource sharing as specified in 3GPP TS 29.214 [49] and 3GPP TS 24.229 [5] by the participating MCData function. The participating MCData function use of resource sharing is defined in subclause 18.2. + +### 18.2 Participating MCData function use of resource sharing + +The participating MCData function utilizes resource sharing either: + +- 1) via the SIP core as specified in 3GPP TS 24.229 [5]; or +- 2) by directly interfacing to PCC to control resource sharing via the Rx reference point as specified in 3GPP TS 29.214 [49]. + +If resource sharing is supported then the participating MCData function may allow the use of pre-established sessions by the MCData client. + +The participating MCData function can determine that the SIP core supports resource sharing from the received third-party SIP REGISTER request if the Resource-Share header field with the value "supported" is contained in the "message/sip" MIME body of the third-party SIP REGISTER request as specified in 3GPP TS 24.229 [5]. + +When using resource sharing the participating MCData function uses the "+g.3gpp.registration-token" header field parameter in the Contact header field of the third-party REGISTER request to identify the MCData UE that is registering and to identify whether resource sharing and pre-established sessions can be used with a specific MCData UE. + +## 18.3 Pre-established session for MCData SDS communication + +### 18.3.1 General + +This subclause describes the procedures to establish pre-established MCData session which may be used for originating standalone SDS using media plane or SDS session. The MCData client or the participating MCData function may initiate the release of a pre-established session as defined in subclause 18.3.3. + +#### 18.3.1.1 SDP offer generation + +When composing an SDP offer according to 3GPP TS 24.229 [5], IETF RFC 4975 [17], IETF RFC 6135 [19] and IETF RFC 6714 [20] the MCData client: + +- 1) shall include an "m=message" media-level section for the MCData media stream consisting of: + - a) the port number; + - b) a protocol field value of "TCP/MSRP" or "TCP/TLS/MSRP" for TLS; + - c) an "a=sendrecv" attribute; + - d) an "a=path" attribute containing its own MSRP URI; + - e) set the content type as "a=accept-types:application/vnd.3gpp.mcdata-signalling application/vnd.3gpp.mcdata-payload"; and + - f) set the a=setup attribute as "actpass". + +#### 18.3.1.2 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [5], the participating MCData function: + +- 1) shall replace the IP address and port number in the received SDP answer with the IP address and port number of the participating MCData function, for the accepted media stream in the received SDP offer, if required; and +- 2) if the IP address is replaced shall insert its MSRP URI before the MSRP URI in the "a=path" attribute in the SDP answer. + +### 18.3.2 Session establishment + +#### 18.3.2.1 MCData client procedures + +When the MCData client initiates a pre-established session the MCData client shall: + +- 1) gather ICE candidates according to IETF RFC 5245 [50]; and + +NOTE: ICE candidates are only gathered on interfaces that the MCData UE uses to obtain MCData service. + +- 2) generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [5], with the clarifications given below. + +The MCData client: + +- 1) shall set the Request-URI of the SIP INVITE request to the public service identity of the participating MCData function serving the MCData user; + +- 2) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; +- 3) shall include the g.3gpp.mcdata.sds media feature tag in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [16]; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.mcdata.sds along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 6) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref set to the value "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 7) shall include the "timer" option tag in the Supported header field; +- 8) should include the Session-Expires header field according to IETF RFC 4028 [38] and should not include the "refresher" header field. The "refresher" header field parameter shall be set to "uac" if included; +- 9) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with the element an element set to a value of "true"; +- 10) shall include an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 18.3.1.1, and include ICE candidates in the SDP offer as per IETF RFC 5245 [50]; and +- 11) shall send the SIP INVITE request according to 3GPP TS 24.229 [5]. + +Upon receiving a SIP 2xx response to the SIP INVITE request the MCData client: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +### 18.3.2.2 Participating MCData function procedures + +Upon receipt of a "SIP INVITE request for establishing a pre-established session" the participating MCData function: + +- 1) shall check whether the public service identity is allocated and if it is not allocated, shall return a SIP 404 (Not Found) response and skip the rest of the steps; +- 2) shall determine the MCData ID of the MCData user establishing the pre-established session and perform actions to verify the MCData ID of the MCData client and authorise the request according to local policy, and if not authorised, the participating MCData function shall return a SIP 403 (Forbidden) response with the warning text set to "225 User not authorized to initiate pre-established session" as specified in subclause 4.9 and skip the rest of the steps; +- 3) shall determine whether resource sharing is supported (see subclause 18.2); +- 4) if resource sharing is supported by the SIP core, determine that there is a binding between the MCData ID of the MCData user establishing the pre-established session and the MCData UE identified by the "+g.3gpp.registration-token" header field parameter in the Contact header field of the third-party REGISTER request (see subclause 18.2) and that this UE identity matches the identity in the "+g.3gpp.registration-token" header field parameter in the Feature-Caps header field in the "SIP INVITE request for establishing a pre-established session"; +- 5) if resource sharing is not supported or if there is no binding between the MCData ID of the MCData user and the identity of the MCData UE identified by the "+g.3gpp.registration-token" header field parameter in the Feature-Caps header field or the participating MCData function does not support the pre-established session, then the participating MCData function shall return a SIP 403 (Forbidden) response with the warning text set to "226 function not allowed due to pre-established session not supported" as specified in subclause 4.9 and skip the rest of the steps; + +- 6) shall determine if the media parameters are acceptable and the MSRP URI is offered in the SDP offer and if not reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 7) shall verify that the media resources are available to support the media parameters and if not shall reject the request with a SIP 500 (Server Internal Error) response, and skip the rest of the steps; +- 8) shall allocate a URI to be used to identify the pre-established session; +- 9) shall generate a SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [5]; and + - a) shall include a Contact header field containing the URI that identifies the pre-established session; + - b) shall include the public service identity in the P-Asserted-Identity header field; + - c) shall include a Supported header field containing the "norefersub" option tag; + - d) shall if the SIP core supports resource sharing, include a Resource-Share header field answer as specified in 3GPP TS 24.229 [5] with: + - A) the value "media-sharing"; + - B) an "origin" header field parameter set to "session-initiator"; + - C) a "timestamp" header field parameter; and + - D) a "rules" header field parameter with one resource sharing rule per media stream in the same order the corresponding m-line appears in the SDP. Each resource sharing rule is constructed as follows: + - a "new-sharing-key" part; and + - a "directionality" part indicating the direction of the pre-established media stream; and + - e) shall include an SDP answer as specified in 3GPP TS 24.229 [5] with the clarifications in subclause 18.3.1.2 and include ICE candidates in the SDP answer as per IETF RFC 5245 [50]; +- 10) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; +- 11) shall send the SIP 200 (OK) response towards the MCData client according to the rules and procedures of the 3GPP TS 24.229 [5]; and +- 12) shall evaluate the ICE candidates according to IETF RFC 5245 [50]. + +NOTE: If ICE candidate evaluation results in candidate pairs other than the default candidate pair being selected a further offer answer exchange using the procedures in subclause 18.3.4 will be needed. + +### 18.3.3 Session release + +#### 18.3.3.1 MCData client procedures + +##### 18.3.3.1.1 MCData client initiated release + +NOTE: The MCData client needs to be prepared to release the pre-established session when receiving a SIP BYE request generated by the SIP core (e.g. due to network release of media plane resources). + +When a MCData client needs to release a pre-established session as created in subclause 18.3.2, the MCData client shall perform the procedure as described in subclause 13.2.2.2.1. + +##### 18.3.3.1.2 Participating MCData function initiated release + +Upon receiving a SIP BYE request from the participating MCData function within a pre-established session the MCData client shall check whether there are any MCData sessions using the pre-established session, and: + +- 1) if there is an established MCData session then the MCData client shall remove the MCData client from the MCData session by performing the procedures for session release for each MCData session as specified in 3GPP TS 24.582 [15]; and + +- 2) if there is no MCData session using the pre-established session, then the MCData client shall follow the procedure described in subclause 13.2.3.2.2. + +### 18.3.3.2 Participating MCData function procedures + +#### 18.3.3.2.1 MCData client initiated release + +Upon receiving a SIP BYE request from the MCData client within a pre-established session the participating MCData function: + +- 1) shall check whether there is a MCData session using the pre-established session, and: + - a) if there is an established MCData session then the participating MCData function shall remove the MCData client from the MCData session by performing the procedures as specified in subclause 13.2.2.2.3.1; + - b) if there is a MCData session in the process of being established, then the participating MCData function: + - i) shall send a SIP CANCEL request to cancel the MCData session in the process of being established as specified in 3GPP TS 24.229 [5]; and + - ii) shall release the MCData session as specified in the subclause 13.2.2.2.3.1, if a SIP 200 (OK) response for the SIP INVITE request is received from the remote side; and + - c) if there is no MCData session using the pre-established session, then the participating MCData function shall: + - i) interact with the media plane as specified in 3GPP TS 24.582 [15] for disconnecting the media plane resources towards the MCData client; and + - ii) shall generate and send a SIP 200 (OK) response to the SIP BYE request according to rules and procedures of 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request from the remote side, the participating MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15] for releasing media plane resources towards the remote side; +- 2) shall interact with the media plane as specified in 3GPP TS 24.582 [15] for releasing media plane resources towards the MCData client; and +- 3) shall send a SIP 200 (OK) response to the SIP BYE request to the MCData client. + +#### 18.3.3.2.2 Participating MCData function initiated release + +When a participating MCData function needs to release a pre-established session as created in subclause 8.2.2, the participating MCData function: + +- 1) shall first release any participants of all MCData calls that are using the pre-established session. The participating MCData function shall remove the MCData client from the MCData session by performing the procedures as specified in subclause 13.2.2.2.3.1; +- 2) shall generate a SIP BYE request according to rules and procedures of 3GPP TS 24.229 [5]; +- 3) shall set the Request-URI of the SIP BYE request to the URI that identifies the pre-established session; +- 4) shall send the SIP BYE request towards the MCData client within the SIP dialog of the pre-established session according to rules and procedures of the 3GPP TS 24.229 [5]; and +- 5) shall, upon receiving a SIP 200 (OK) response to the SIP BYE request interact with the media plane as specified in 3GPP TS 24.582 [15]. + +## 18.3.4 Session modification + +### 18.3.4.1 MCData client procedures + +#### 18.3.4.1.1 MCData client initiated + +When the MCData client needs to modify the pre-established session outside of an MCData session, the MCData client: + +- 1) shall generate a SIP UPDATE request or a SIP re-INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 18.3.1.1, and include ICE candidates in the SDP offer as per IETF RFC 5245 [50], if required; and +- 3) shall send the SIP request towards the MCData server according to the rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of the SIP 200 (OK) response the MCData client: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15], if there is a change in media parameters in the received SDP answer, compared to those in the previously agreed SDP; and +- 2) shall interact with the media plane as specified in 3GPP TS 24.582 [15], if there is a media stream, that is currently used in the pre-established session and is removed in the received SDP answer. + +NOTE: The MCData client keeps resources for previously agreed media stream and media parameters until it receives a SIP 200 (OK) response. + +#### 18.3.4.1.2 MCData client receives SIP UPDATE or SIP re-INVITE request + +Upon receiving a SIP UPDATE request or a SIP re-INVITE request to modify an existing pre-established session without associated MCData session, the MCData client: + +- 1) shall validate that the received SDP offer includes at least one media stream for which the media parameters and the MSRP URI is acceptable by the MCData client and if not reject the request with a SIP 488 (Not Acceptable Here) response. Otherwise, continue with the rest of the steps; +- 2) shall generate a SIP 200 (OK) response as follows: + - a) shall include an SDP answer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 18.3.1.2, and include ICE candidates in the SDP answer as per IETF RFC 5245 [50], if required; and +- 3) shall send the SIP 200 (OK) response towards the MCPTT server according to the rules and procedures of 3GPP TS 24.229 [5]. + +### 18.3.4.2 Participating MCData function procedures + +#### 18.3.4.2.1 Reception of a SIP UPDATE or SIP re-INVITE request from served MCData client + +Upon receiving a SIP UPDATE request or a SIP re-INVITE request to modify an existing pre-established session without associated MCData session, the participating MCData function: + +- 1) shall validate that the received SDP offer includes at least one media stream for which the media parameters and the MSRP URI is acceptable by the participating MCData function and if not reject the request with a SIP 488 (Not Acceptable Here) response. Otherwise, continue with the rest of the steps; and +- 2) shall generate a SIP 200 (OK) response as follows: + - a) include an SDP answer according to 3GPP TS 24.229 [5] based on the received SDP offer with the clarifications given in the subclause 18.3.1.2, and include ICE candidates in the SDP answer as per IETF RFC 5245 [50], if required; and + - b) include a Contact header field containing the URI that identifies the pre-established session and send a SIP 200 (OK) response according to the rules and procedures of 3GPP TS 24.229 [5]. + +### 18.3.4.2.2 Participating MCData function initiated + +When the participating MCData function needs to modify the pre-established session outside of an MCData session, the participating MCData function: + +- 1) shall generate a SIP UPDATE request or a SIP re-INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include an SDP offer according to 3GPP TS 24.229 [5], and include ICE candidates in the SDP offer as per IETF RFC 5245 [50], if required; and +- 3) shall send the SIP request towards the MCData client according to the rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of the SIP 200 (OK) response, the participating MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15], if there is change in media parameters or the MSRP URI in the received SDP answer, compared to those in the previously agreed SDP; +- 2) shall interact with the media plane as specified in 3GPP TS 24.582 [15], if there is a media stream, that is currently used in the pre-established session, is removed in the received SDP answer; and +- 3) shall interact with the media plane as specified in 3GPP TS 24.582 [15], if there is a media stream accepted in the received SDP answer, that is not currently used by the participant in the pre-established session. + +NOTE: The participating MCData function keeps resources for previously agreed media stream, media parameters and the MSRP URI until it receives a SIP 200 (OK) response. + +--- + +## 19 MBMS transmission usage procedure + +### 19.1 General + +This clause describes the participating MCData function and the MCData client procedure for: + +- 1) MBMS bearer announcements; +- 2) MBMS bearer listening status; and +- 3) MBMS bearer suspension status. + +This clause contains references to the MBMS Subchannel control messages Map Group To Bearer and Unmap Group To Bearer defined in 3GPP TS 24.582 [15]. + +### 19.2 Participating MCData function MBMS usage procedures + +#### 19.2.1 General + +This subclause describes the procedures in the participating MCData function for: + +- 1) sending an MBMS bearer announcements to the MCData client; +- 2) receiving an MBMS bearer listening status from the MCData client; and +- 3) receiving an MBMS bearer suspension status from the MCData client. + +#### 19.2.2 Sending MBMS bearer announcement procedures + +##### 19.2.2.1 General + +The availability of a MBMS bearer is announced to MCData clients by means of an MBMS bearer announcement message. One or more MBMS bearer announcement elements are included in an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body. + +An MBMS bearer announcement message can contain new MBMS bearer announcements, updated MBMS bearer announcements or cancelled MBMS bearer announcements or a mix of all of them at the same time in an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body. Each initial MBMS bearer announcement message announces one MBMS bearer intended to carry a general purpose MBMS subchannel used for application level multicast signalling in a specified MBMS service area and additionally, the message could also announce zero or more extra MBMS bearers intended to carry additional media plane traffic. + +NOTE: A new MBMS bearer announcement does not implicitly remove previously sent MBMS bearer announcements if the previously sent MBMS bearer announcement is not included in an MBMS bearer announcement message. However, the application/sdp MIME body, if included in the new MBMS bearer announcement message, fully replaces the existing application/sdp MIME body (which includes the MSCCK security key used to protect the general purpose MBMS subchannel). + +When and to whom the participating MCData function sends the MBMS bearer announcement is based on local policy in the participating MCData function. + +The following subclauses describe how the participating MCData function: + +1. sends an initial MBMS bearer announcement message; +2. updates a previously sent announcement of MBMS bearer(s); +3. cancels a previously sent announcement of MBMS bearer(s); and +4. keys, re-keys or un-keys MCData groups using Multicast Signalling Key (MuSiK) via a key download procedure. + +Prior to the participating MCData function transmitting on an MBMS bearer, the participating MCData function: + +1. if necessary, shall instruct the local key management client to request keying material from the key management server as described in 3GPP TS 33.180 [26]; +2. shall generate MSCCK(s) with the corresponding MSCCK-ID(s) and MuSiK(s) with the corresponding MuSiK-ID(s) as necessary; and +3. shall distribute MSCCKs, MSCCK-IDs, MuSiKs and MuSiK-IDs to the MCData clients, as needed, using the keying material received from the key management server for security protection, as described in 3GPP TS 33.180 [26]. + +### 19.2.2.2 Sending an initial MBMS bearer announcement procedure + +For each MCData client that the participating MCData function is sending an MBMS bearer announcement to, the participating MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall set the Request-URI to the URI received in the To header field in a third-party SIP REGISTER request; +- 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media-feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 4) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 5) shall include one application/sdp MIME body conforming to 3GPP TS 24.229 [5] where the application/sdp MIME body: + - a) shall include the Content-Disposition header field with the value "render"; + - b) should include one or more "m=message" media lines and media line attributes conforming to IETF RFC 4566 [71] and IETF RFC 5888 [72], to be used as the MBMS subchannel for media only. Additionally, the participating MCData function: + +NOTE 0: Unciphered packets (i.e. using RTP/UDP/IP encapsulation) and ciphered packets (i.e. using SRTP/UDP/IP encapsulation) need separate media lines, with different transport protocols. + +- i) shall set the c-line to the unspecified address (0.0.0.0), if IPv4, or to a domain name within the ".invalid" DNS top-level domain, if IPv6; and + - ii) shall set the port number of the media line to 9; and + - iii) shall set the sub-field of the media line to RTP/AVP for unciphered traffic or to RTP/SAVP for ciphered traffic, to be used for the MBMS subchannel associated to the media line; and + - c) shall include one "m=application" media line to be used for the general purpose MBMS subchannel. The media line shall include a valid multicast IP address and a valid port number. If the protection of MBMS subchannel control messages sent over this MBMS subchannel of the MBMS bearer is required, the participating MCData function also includes an "a=key-mgmt" media-level attribute. The participating MCData function: + - i) shall encrypt the MSCCK to a UID associated to the targeted MCData ID and a time related parameter as described in 3GPP TS 33.180 [26]; + - ii) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated MSCCK and MSCCK-ID as specified in 3GPP TS 33.180 [26]; + - iii) shall add the public service identity of the participating MCData function to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - iv) shall sign the MIKEY-SAKKE I\_MESSAGE using the public service identity of the participating MCData function signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [26]; and + - v) shall include the "mikey" key management and protocol identifier and the signed MIKEY-SAKKE I\_MESSAGE in the value of the a=key-mgmt" media-level attribute according to IETF RFC 4567 [45]; and +- 6) shall include an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body defined in clause D.5 with the element set to "1" and one or more elements associated with the pre-activated MBMS bearers. Each set of an element: +- a) shall include a TMGI value in the element; +- NOTE 2: The same TMGI value can only appear in one element. The TMGI value is also used to identify the when updating or cancelling the element. +- NOTE 3: The security key active for the general purpose MBMS subchannel on which the mapping (i.e. the Map Group To Bearer message) of media to this MBMS bearer was indicated, is used for MBMS subchannels on this MBMS bearer, unless a different key or an indication of not using encryption is in place. +- b) shall include the QCI value in the element; + - c) if multiple carriers are supported, shall include the frequency to be used in the element; +- NOTE 4: In the current release, if the element is included, the frequency in the element is the same as the frequency used for unicast. +- d) shall include one or more MBMS service area IDs in elements in the element; +- NOTE 5: Initial mappings of groups to MBMS subchannels on an MBMS bearer for the purpose of carrying media can occur only where the MBMS service area for this bearer and the MBMS service area for the bearer carrying the general purpose MBMS subchannel on which the Map Group To Bearer message is sent intersect. However, once the mapping to this bearer was successful, the reception by the MCData client can continue (until Unmap Group To Bearer is received or until timeout) throughout the entire MBMS service area of this bearer. +- e) may include the element and set it to "true" value or the "false" value; + +NOTE 6: The participating function can choose to direct some clients not to send an MBMS bearer suspension report when notified by RAN, by including the element set to "false". The purpose is to prevent an avalanche of identical reports sent by clients roughly at the same time, to report the suspension of the same MBMS bearer. The way the participation function determines which clients are to send or not to send the report is outside the scope of the present document. + +- f) if the MBMS bearer is carrying the general purpose MBMS subchannel, shall include one element, giving the number of the "m=application" media line in the application/sdp MIME body generated in step 5 above to be used for the general purpose MBMS subchannel; and + - g) if the packet headers are compressed with ROHC specified in RFC 5795 [60] in this MBMS bearer, the element in the element in the element shall include the element defined in subclause D.5.3. +- 7) shall include the MBMS public service identity of the participating MCData function in the P-Asserted-Identity header field; + - 8) shall include in a MIME body with Content-Type header field set to "application/vnd.3gpp.mcdata-info+xml", the element set to the MCData ID of the user; and + - 9) shall send the SIP MESSAGE request towards the MCData client according to 3GPP TS 24.229 [5]. + +### 19.2.2.3 Updating an announcement + +When the participating MCData function wants to update a previously sent announcement, the participating MCData function sends an MBMS bearer announcement in an SIP MESSAGE request as specified in subclause 19.2.2.2 where the participating MCData function in the element to be updated: + +- 1) shall include the same TMGI value as in the MBMS bearer announcement to be updated in the element; + +NOTE 1: TMGI value is used to identify the when updating or cancelling the element and can't be changed. + +- 2) shall include the same or an updated value of the QCI in the element; +- 3) if a frequency was included in the previously sent announcement, shall include the same value in the element; + +NOTE 2: In the current release if the element is included, the frequency in the element is the same as the frequency used for unicast. + +- 4) shall include the same list of MBMS service area IDs or an updated list of MBMS service area IDs in elements in the element; +- 5) may include the same or an updated value in the element; +- 6) shall include the element with the same value as in the initial element; and +- 7) shall include the same application/sdp MIME body as included in the initial MBMS announcement. + +### 19.2.2.4 Cancelling an MBMS bearer announcement + +When the participating MCData function wants to cancel an MBMS bearer announcement associated with an element, the participating MCData function sends an MBMS bearer announcement as specified in subclause 19.2.2.2 where the participating MCData function in the element to be cancelled: + +- 1) shall include the same TMGI value as in the element to be cancelled in the element; +- 2) shall not include an element; +- 3) if the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body only contains elements that are to be cancelled, shall not include an element; and +- 4) if the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body only contains elements that are to be cancelled, shall not include an application/sdp MIME body. + +### 19.2.2.5 Sending a MuSiK download message + +For each MCData client that the participating MCData function is intending to use a Multicast Signalling Key (MuSiK), the participating MCData function shall perform a key download procedure for a MuSiK and its corresponding MuSiK-ID. Two kinds of MuSiK download are possible: default MuSiK download and explicit MuSiK download. The default MuSiK download is used to set, reset or unset a MuSiK and its corresponding MuSiK-ID and is applicable to all groups supported by the MCData client, except for certain identified groups for which MuSiKs and MuSiK-IDs are assigned, reassigned or unassigned separately via explicit MuSiK download. The default MuSiK and MuSiK-ID can apply to all the MCData clients supported by the participating MCData function and can be overridden by the explicit MuSiK download which is selectively applied only to the MCData clients using the explicitly identified groups. A group subject to explicit MuSiK download, can be switched to the default MuSiK protection via a default MuSiK download identifying that group. The participating MCData function: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]; +- 2) shall set the Request-URI to the URI received in the To header field in a third-party SIP REGISTER request; +- 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media-feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 4) shall include a P-Asserted-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- 5) shall include an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body defined in subclause D.5 with the element set to "1", and either + - a) containing an element with at least one element associated with the MuSiK being downloaded; or + - b) containing an element with zero or more elements associated with the MuSiK being downloaded; +- 6) if protection for the group(s) in the specified list is to be provided using the MuSiK, shall include an application/mikey MIME body with the MIKEY message containing the encrypted MuSiK and the corresponding MuSiK-ID, constructed as described in subclauses 5.8.1 and 5.2.2 of 3GPP TS 33.180 [26]; + +NOTE: Subclause 9.2.1.3 of 3GPP TS 33.180 [26] shows an example on how to include an application/mikey MIME body in a SIP message. + +- 7) shall send the SIP MESSAGE request towards the MCData client according to 3GPP TS 24.229 [5]. + +The participating MCData function shall consider the key download successful on receipt of a 200 OK message in response to the SIP MESSAGE request sent in step 7). + +A participating MCData function that does not receive a 200 OK message from a specific MCData client shall use unicast with that MCData client, for the groups for which the MuSiK was intended. + +### 19.2.3 Receiving an MBMS bearer listening status from an MCData client + +Upon receiving a "SIP MESSAGE request for an MBMS listening status update", the participating MCData function shall handle the request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6]. + +If the SIP MESSAGE request contains: + +- 1) an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body with an element; and +- 2) an application/vnd.3gpp.mcdata-info+xml MIME body containing an MCData ID in the served by the participating MCData function; + +then the participating MCData function: + +- 1) shall verify that the public user identity in the P-Asserted-Identity header field is bound to the MCData ID in the element in the application/vnd.3gpp.mcdata-info+xml MIME body, and if that is the case: + +- a) if the element is set to "listening": + - i) if a element is included, shall indicate to the media plane that the MCData client in the session identified by the element is now listening to the MBMS subchannel; and + - ii) if element is included with the value "true", shall indicate to the media plane that the MCData client is now listening to the general purpose MBMS subchannel; and +- b) if the element is set to "not-listening": + - i) if a element is included, shall indicate to the media plane that the MCData client in the sessions identified by the elements is not listening to the MBMS subchannel; + - ii) if element is included with the value "false", shall indicate to the media plane that the MCData client is no longer listening to the general purpose MBMS bearer; and + - iii) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +NOTE 1: If the MCData client reports that the MCData client is no longer listening to the general purpose MBMS subchannel it is implicitly understood that the MCData client no longer listens to any MBMS subchannel in ongoing conversations that the MCData client previously reported status "listening". + +If the SIP MESSAGE request contains: + +- 1) an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body with an element; and +- 2) an application/vnd.3gpp.mcdata-info+xml MIME body containing an MCData ID in the served by the participating MCData function; + +then the participating MCData function: + +- 1) shall verify that the public user identity in the P-Asserted-Identity header field is bound to the MCData ID in the element in the application/vnd.3gpp.mcdata-info+xml MIME body, and if that is the case: + +- a) if the element is set to "suspending": + - i) shall consider that the bearer identified by the element is about to be suspended and that the reduction or elimination of traffic on that bearer and/or on some of the bearers indicated in the elements can potentially avoid the suspension; and + +NOTE 2: An MBMS bearer is about to be suspended when RAN has notified the clients of the decision to suspend the bearer, but the actual suspension, which would occur at the end of the MCCH modification period, has not taken place yet because the MCCH modification period has not yet expired. + +- ii) may take implementation/configuration specific immediate action for the MCData client that reports the suspension as well as other MCData clients that listen to the same bearer (e.g. moving traffic to unicast bearer(s)), reducing transmission rate, eliminating traffic, modifying pre-emption priority); or +- b) if the element is set to "not-suspending": + +- i) shall consider that the bearer identified by the element is no longer about to be suspended; and + +NOTE 3: An MBMS bearer is no longer about to be suspended when RAN has notified the clients of the decision to no longer suspend the bearer after having previously notified the clients that the bearer would be suspended at the end of the MCCH modification period. The RAN notifications to first suspend and subsequently not to suspend the same MBMS bearer would have to come within the same MCCH modification period. + +- ii) may take implementation/configuration specific immediate action for the MCData client that reports the suspension as well as other MCData clients that listen to the same bearer (e.g. restoring traffic previously reduced or eliminated from MBMS bearers upon reception of suspension information). + +NOTE 4: If the MCData client reports that the MCData client is no longer listening to MBMS subchannels associated with the MBMS bearer indicated in the suspension information, it is implicitly understood that the suspension of that MBMS bearer has actually occurred. + +## 19.2.4 Abnormal cases + +Upon receipt of a SIP MESSAGE request with an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body: + +- 1) where the P-Asserted-Identity identifies a public user identity not associated with MCData user served by the participating MCData function; or +- 2) with an application/vnd.3gpp.mcdata-info+xml MIME body and with a element containing an MCData ID that identifies an MCData user served by the participating MCData function and an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body containing one or more elements; + +then the participating MCData function shall send a SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [5]. + +# 19.3 MCData client MBMS usage procedures + +## 19.3.1 General + +This subclause describes the procedures in the MCData client for: + +- 1) receiving an MBMS bearer announcement from the participating MCData function; +- 2) sending an MBMS bearer listening status report to the participating MCData function; and +- 3) sending an MBMS bearer suspension status report to the participating MCData function. + +## 19.3.2 Receiving an MBMS bearer announcement + +The MCData client associates each received application/sdp MIME body and each received security key with a general purpose MBMS subchannel announced in the same MBMS Bearer Announcement message. When receiving a Map Group To Bearer message, the MCData client interprets its content (e.g. the m= line number) in the context of the application/sdp MIME body associated with the general purpose MBMS subchannel on which the Map Group To Bearer message was received. + +When the MCData client receives a SIP MESSAGE request containing: + +- 1) a P-Asserted-Service header field containing the "urn:urn-7:3gpp-service.ims.icsi.mcdata"; and +- 2) an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body containing one or more an element(s); + +then the MCData client for each element in the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body: + +- 1) if the element is present: + - a) if an element with the same value of the element is already stored: + - i) shall replace the old element with the element received in the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body; + - b) if there is no element with the same value of the element stored: + - i) shall store the received element; + - c) shall associate the received announcement with the received application/sdp MIME body; + - d) shall associate the received announcement with the received element; + +- e) shall store the MBMS public service identity of the participating MCData function received in the P-Asserted-Identity header field and associate the MBMS public service identity with the new element; +- f) if a "a=key-mgmt" media-level attribute with the "mikey" key management and protocol identifier and a MIKEY-SAKKE I\_MESSAGE is included for the general purpose MBMS subchannel defined in the "m=application" media line in the application/sdp MIME body in the received SIP MESSAGE request, + - i) shall extract the initiator URI from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]. If the initiator URI deviates from the public service identity of the participating MCData function serving the MCData user, shall reject the SIP MESSAGE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; + - ii) shall convert the initiator URI to a UID as described in 3GPP TS 33.180 [26]; + - iii) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - iv) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP MESSAGE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and include warning text set to "136 authentication of the MIKEY-SAKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.4 and shall not continue with the rest of the steps; + - v) shall extract and decrypt the encapsulated MSCCK using the participating MCData function's (KMS provisioned) UID key as described in 3GPP TS 33.180 [26]; and + - vi) shall extract the MSCCK-ID, from the payload as specified in 3GPP TS 33.180 [26]; + +NOTE: With the MSCCK successfully shared between the participating MCData function and the served UEs, the participating MCData function is able to securely send MBMS subchannel control messages to the MCData clients. + +- g) shall listen to the general purpose MBMS subchannel defined in the "m=application" media line in the application/sdp MIME body in the received SIP MESSAGE request when entering an MBMS service area where the announced MBMS bearer is available; and + - h) shall check the condition for sending a listening status report as specified in the subclause 19.3.3; and +- 2) if no element is present: +- a) shall discard a previously stored element identified by the value of the ; + - b) shall remove the association with the stored application/sdp MIME body and stop listening to the general purpose MBMS subchannel; + - c) if no more elements associated with the stored application/sdp MIME body are stored in the MCData client, shall remove the stored application/sdp MIME body; and + - d) check the condition for sending a listening status report as specified in the subclause 19.3.3. + +### 19.3.3 The MBMS bearer listening status and suspension report procedures + +#### 19.3.3.1 Conditions for sending an MBMS listening status report + +If one of the following conditions is fulfilled: + +- 1) if the MCData client: + - a) receives a Map Group To Bearer message over the general purpose MBMS channel; + - b) participates in a group session identified by the Map Group To Bearer message; and + - c) the status "listening" is not already reported; or + +- 2) if the MCData client: + - a) receives an announcement as described in subclause 19.3.2; + - b) enters an MBMS service area where a general purpose MBMS is available; and + - c) experiences good MBMS bearer radio condition; + +then the MCData client shall report that the MCData client is listening to the MBMS bearer as specified in subclause 19.3.3.2. + +If one of the following conditions is fulfilled: + +- 1) if the MCData client: + - a) receives an MBMS bearer announcement as described in the subclause 19.3.2; + - b) the MBMS bearer announcement contains a cancellation of an element identified by the same TGMI value as received in a Map Group To Bearer message in an ongoing conversation; and + - c) the status "not-listening" is not already reported; +- 2) if the MCData client: + - a) receives an MBMS bearer announcement as described in the subclause 19.3.2; + - b) the MBMS bearer announcement contains a cancellation of an element; + - c) does not participate in an ongoing conversation; + - d) the MCData client has reported the "listening" status due to the availability of the general purpose MBMS subchannel in the element; and + - e) the status "not-listening" is not already reported; or +3. if the MCData client: + - a) suffers from bad MBMS bearer radio condition, + +then the MCData client shall report that the MCData client is not listening to the MBMS subchannels as specified in subclause 19.3.3.2. + +If all the following conditions are fulfilled: + +- 1) the MCData client has reported "listening" as the most recent listening status relative to an MBMS bearer; +- 2) the MCData client is notified that the MBMS bearer is about to be suspended by the RAN; and +- 3) the MCData client has not received a MBMS bearer announcement containing a element set to "false", + +then the MCData client shall report that the MBMS bearer is about to be suspended, as specified in subclause 19.3.3.2. + +If all the following conditions are fulfilled: + +- 1) the MCData client has reported "listening" as the most recent listening status relative to an MBMS bearer; +- 2) the MCData client has reported that the MBMS bearer is about to be suspended, but the suspension of the bearer has not been detected yet by the MCData client; +- 3) the MCData client is notified that the MBMS bearer is no longer to be suspended by the RAN; and +- 4) the MCData client has not received a MBMS bearer announcement containing a element set to "false", + +then the MCData client shall report that the MBMS bearer is no longer to be suspended, as specified in subclause 19.3.3.2. + +### 19.3.3.2 Sending the MBMS bearer listening or suspension status report + +When the MCData client wants to report the MBMS bearer listening status, the MCData client: + +NOTE 1: The application/vnd.3gpp.mcdata-mbms-usage-info+xml can contain both the listening status "listening" and "not listening" at the same time. + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] and + - a) shall include in the Request-URI the MBMS public service identity of the participating MCData function received in the P-Asserted-Identity header field of the announcement message; + - b) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media-feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; + - c) should include a public user identity in the P-Preferred-Identity header field as specified in 3GPP TS 24.229 [5]; + - d) shall include a P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; + - e) shall include an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body with the element set to "1"; + - f) if the MCData client is listening to the MBMS bearer, the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body: + - i) shall include an element set to "listening"; + - ii) if the intention is to report that the MCData client is listening to the MBMS subchannel for an ongoing conversation in a session (e.g. as the response to the Map Group To Bearer message), shall include the MCData session identity of the ongoing conversation in a element; + - iii) shall include one or more elements for which the listening status applies; and + - iv) if the intention is to report that the MCData client is listening to the general purpose MBMS subchannel, shall include the element set to "true"; + - g) if the MCData client is not listening, the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body: + - i) shall include an element set to "not-listening"; + - ii) shall include one or more elements for which the listening status applies; + - iii) if the intention is to report that the MCData client is no longer listening to the MBMS subchannel in an ongoing session (e.g. as the response to Unmap Group to Bearer message), shall include the MCData session identity in a element; and + - iv) if the intention is to report that the MCData client is no longer listening to general purpose MBMS subchannel, shall include the element set to "false"; and +- NOTE 2: If the MCData client reports that the MCData client is no longer listening to the general purpose MBMS subchannel, it is implicitly understood that the MCData client no longer listens to any MBMS subchannel in ongoing conversations that the MCData client previously reported status "listening". +- h) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the set to the MCData ID; and +- 2) shall send the SIP MESSAGE request according to 3GPP TS 24.229 [5]. + +When the MCData client meets all the conditions specified in subclause 19.3.3.1 for reporting a change in an MBMS bearer suspension status, the MCData client: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [5] and IETF RFC 3428 [6] and + +- a) shall include in the Request-URI the MBMS public service identity of the participating MCData function received in the P-Asserted-Identity header field of the announcement message; +- b) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media-feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- c) should include a public user identity in the P-Preferred-Identity header field as specified in 3GPP TS 24.229 [5]; +- d) shall include a P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcdata"; +- e) shall include an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body with the element set to "1"; +- f) if at least one MBMS bearer is about to be suspended, the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body: + - i) shall include an element set to "suspending"; + - ii) shall set the element to the total number of the included elements and elements; + - iii) shall include element(s) set to the TMGI value for each of the MTCHs on the same MCH corresponding to the MBMS bearers about to be suspended; and + - iv) may include elements, if available, corresponding to the TMGI values for other MTCHs on the same MCH as the MBMS bearers to be suspended + +NOTE 3: To report the suspension of MTCHs on different MCHs, the MCData client sends a separate message for each of the involved MCHs. + +- g) if the MBMS bearer is no longer about to be suspended, the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body: + - i) shall include an element set to "not-suspending"; + - ii) shall set the element to the number of included elements; and + - iii) shall include a element set to the corresponding TMGI value for each of the MTCHs of the MBMS bearers that are no longer about to be suspended; and +- h) shall include an application/vnd.3gpp.mcdata-info+xml MIME body with the set to the MCData ID; and + +2) shall send the SIP MESSAGE request according to 3GPP TS 24.229 [5]. + +NOTE 4: The MCData client reports in separate messages the MBMS bearers that are about to be suspended and the MBMS bearers that are no longer about to be suspended. + +### 19.3.4 Receiving a MuSiK download message + +When the MCData client receives a SIP MESSAGE request containing: + +- 1) a P-Asserted-Service header field containing the "urn:urn-7:3gpp-service.ims.icsi.mcdata"; and +- 2) with one of the following: + - a) an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body containing an element with at least one subelement; or + - b) an application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body containing an element with zero or more subelements; + +the MCData client shall: + +- 1) if the received message contains an element, set the impacted groups to be those groups identified by the subelements; +- 2) if the received message contains an element without subelements, set the impacted groups to be all groups not associated with currently valid explicit MuSiK downloads; and +- 3) if the received message contains an element with subelements, first dissociate those groups identified by the subelements from currently valid associations with explicit MuSiK downloads and then set the impacted groups to be all groups not associated with currently valid explicit MuSiK downloads. + +If the key identifier within the CSB-ID of the MIKEY payload is a MuSiK-ID (4 most-significant bits have the value '6'), the MCData client: + +- 1) shall process the MIKEY payload according to 3GPP TS 33.180 [26], as follows: + - a) if the initiator field (IDRi) has type 'URI' (identity hiding is not used), the client: + - i) shall extract the initiator URI from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]. If the initiator URI deviates from the public service identity of the participating MCData function serving the MCData client, shall reject the SIP MESSAGE request by sending a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and including warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.9 and shall not continue with the rest of the steps; and + - ii) shall convert the initiator URI to a UID as described in 3GPP TS 33.180 [26]; + - b) otherwise, if the initiator field (IDRi) has type 'UID' (identity hiding in use), the client: + - i) shall convert the public service identity of participating MCData function serving the MCData user to a UID as described in 3GPP TS 33.180 [26]; and + - ii) shall compare the generated UID with the UID in the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [26]. If the two initiator UIDs deviate from each other, shall reject the SIP MESSAGE request by sending a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and including warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.4 and shall not continue with the rest of the steps; + - c) otherwise, shall reject the SIP MESSAGE request by sending a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and including warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.4 and shall not continue with the rest of the steps; + - d) shall use the UID to validate the signature of the I\_MESSAGE as described in 3GPP TS 33.180 [26]; + - e) if authentication verification of the I\_MESSAGE fails or the I\_MESSAGE does not contain a Status attribute, shall reject the SIP MESSAGE request by sending SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [45], and including warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in subclause 4.4 and shall not continue with the rest of the steps; and + - f) shall examine the Status attribute and shall either mark the associated security functions as "not in use" or shall extract and store the encapsulated MuSiK and the corresponding MuSiK-ID from the payload as specified in 3GPP TS 33.180 [26]; and +- 2) for each of the impacted groups, shall either associate the status 'security not in use' or shall add/replace in the storage associated with the group the MuSiK-ID and the MuSiK, for use (decrypted) as security key. + +NOTE: It is expected that the MCData client is capable of storing a different MuSiK for each MCData group of interest. + +The MCData client shall respond with SIP 200 OK only if it finds the message syntactically correct and recognizes it as a valid and error-free MuSiK download (default or explicit) message. + +## 20 IP Connectivity + +### 20.1 General + +This subclause describes the IP Connectivity procedures between two MCData clients for on-network. Included are the procedures for MCData client procedures, participating MCData function procedures and controlling MCData function procedures. + +#### 20.1.1 MC Data client SDP offer/answer generation + +When a MCData client decides to establish an IP Connectivity session, or is answering an IP Connectivity request the MCData client shall include an SDP offer/answer according to subclause 6.1.2 of 3GPP TS 24.229 [5] with the following clarifications: + +- 1) shall set the IP address of the MC Data client to the IP address to be used in the IP Connectivity session; and + +NOTE: The MC service operator policy determines if the MC Data client should use an already assigned IP address or should request a new IP address following the procedures defined in 3GPP TS 24.301 [43]. + +- 2) depending on the service operator policy, the client shall add a zero port number value to the media descriptions of the SDP offer, in order to inform network entities that media resources are not requested for the session, or add a specific port number value to reserve the necessary media resources to be used in the data exchange. + +#### 20.1.2 MC Data participating server SDP offer/answer generation + +The SDP offer/answer is generated based on the received SDP offer/answer. The SDP offer/answer generated by the MC Data participating function: + +- 1) shall replace the IP address for the offered media stream in the received SDP offer with the IP address of the participating MC Data function, if required; and + +NOTE: Requirements can exist for the MC Data server to be in the path of the data exchange between authorized MC Data users in order to limit the exchange in terms of volume or time limits. + +- 2) depending on the service operator policy, shall ensure the port number is zero or replace the port number with a locally assigned port number + +#### 20.1.3 MC Data controlling server SDP offer/answer generation + +The SDP offer/answer is generated based on the received SDP offer/answer. The SDP offer/answer generated by the MC Data controlling function: + +- 1) shall replace the IP address for the offered media stream in the received SDP offer with the IP address of the controlling MC Data function, if required; and + +NOTE: Requirements can exist for the MC Data controlling server to be in the path of the data exchange between authorized MC Data users in order to limit the exchange in terms of volume or time limits. + +- 2) depending on the service operator policy, shall ensure the port number is zero or replace the port number with a locally assigned port number. + +## 20.2 MCData Client Procedures + +### 20.2.1 MCData client originating procedures + +When a MCData client receives the request by a user or user application to establish a IP Connectivity session with another MCData client the MCData client shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5] with the clarifications given below. The MCData ID of the target MCData client may be explicitly included in the request from the user or user application. If the target MCData ID is not included in the request, the MCData client may implicitly determine the target MCData ID by using the target IP Information included in the request to find a match in the One-to-One communication list of the MCData user profile document as specified in 3GPP TS 24.484 [12]. If the MCData ID of the target MCData client is determined implicitly by the target IP Information included in the request, + +the client searches in leaves below ///Common/OnetoOne/UserList//Entry/IPInformation/Entry/ for a match in the IP Information. The MCData ID is given by matching the user entry. + +The MCData client: + +- 1) shall include the g.3gpp.mcdata.ipconn media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [16]; + - 2) shall include an Accept-Contact header field containing the g.3gpp.mcdata.ipconn media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + - 3) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; + - 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" (coded as specified in 3GPP TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; + - 5) should include the "timer" option tag in the Supported header field; + - 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; + - 7) shall insert in the SIP INVITE request a MIME resource-lists body with the MCData ID of the invited MCData user, according to rules and procedures of IETF RFC 5366 [18]; + - 8) shall contain an application/vnd.3gpp.mcdata-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "one-to-one-ipconn"; and + - b) if the MCData client is aware of active functional aliases and if an active functional alias is to be included in the SIP INVITE request, the element set to the URI of the used functional alias; + - 9) shall set the Request-URI of the SIP INVITE request to the public service identity identifying the participating MCData function serving the MCData user; +- NOTE 1: The MCData client is configured with public service identity identifying the participating MCData function serving the MCData user. +- 10) may include a P-Preferred-Identity header field in the SIP INVITE request containing a public user identity as specified in 3GPP TS 24.229 [5]; + - 11) shall include an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 20.1.1; and + - 12) shall send the SIP INVITE request towards the MCData server according to 3GPP TS 24.229 [5]. + +On receipt of a SIP 2xx response to the SIP INVITE request, the MCData client: + +- 1) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]; +- 2) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; and +- 3) shall interact with MC Data user or user application. + +On receipt of a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the MCData client: + +- 1) shall indicate to the MCData user or user application that the IP Connectivity session could not be established; and +- 2) shall send a SIP ACK request as specified in 3GPP TS 24.229 [5]. + +On receipt of an indication from the media plane indicating that the IP Connectivity session could not be established, the MCData client: + +- 1) shall generate a SIP BYE request according to 3GPP TS 24.229 [5] with: + - a) Reason code set to "FAILURE\_CAUSE"; + - b) cause set to "1"; and + - c) text set to "Media bearer or QoS lost"; +- 2) shall set the Request-URI to the MCData session identity to release; and +- 3) shall send a SIP BYE request towards MCData server according to 3GPP TS 24.229 [5]. + +## 20.2.2 MCData client terminating procedures + +Upon receipt of an "initial SIP INVITE request for IP Connectivity session for terminating MCData client" request, the MCData client shall follow the procedures for termination of multimedia sessions in the IM CN subsystem as specified in 3GPP TS 24.229 [5] with the clarifications below. + +The MCData client: + +- 1) may reject the SIP INVITE request if either of the following conditions are met: + - a) MCData client does not have enough resources to handle the IP Connectivity session; or + - b) any other reason outside the scope of this specification;and skip the rest of the steps after step 2; +- 2) if the SIP INVITE request is rejected in step 1), shall respond toward participating MCData function either with appropriate reject code as specified in 3GPP TS 24.229 [5] and warning texts as specified in subclause 4.9 or with SIP 480 (Temporarily unavailable) response not including warning texts if the user is authorised to restrict the reason for failure and skip the rest of the steps of this subclause; +- 3) shall interact with the MCData user or user application providing the MCData ID of the inviting MCData user; +- 3A) may display to the MCData user the functional alias of the inviting MCData user, if provided; +- 4) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [5]; +- 5) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 6) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [38]. The "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 7) shall include the g.3gpp.mcdata.ipconn media feature tag in the Contact header field of the SIP 200 (OK) response; +- 8) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" in the Contact header field of the SIP 200 (OK) response; +- 9) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [5] with the clarifications given in subclause 20.1.1; and +- 10) shall send the SIP 200 (OK) response towards the MCData server according to rules and procedures of 3GPP TS 24.229 [5]. + +On receipt of an SIP ACK message to the sent SIP 200 (OK) message, the MCData client shall: + +- 1) shall interact with MC Data user or user application. + +## 20.3 Participating MCData function procedures + +### 20.3.1 Originating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for IP Connectivity session for originating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; + - 2) shall determine the MCData ID of the calling user from the public user identity in the P-Asserted-Identity header field of the SIP INVITE request, and shall authorise the calling user; +- NOTE: The MCData ID of the calling user is bound to the public user identity at the time of service authorisation, as documented in subclause 7.3. +- 3) if the participating MCData function cannot find a binding between the public user identity and an MCData ID or if the validity period of an existing binding has expired, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text set to "141 user unknown to the participating function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; + - 4) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is: + - a) set to a value of "one-to-one-ipconn", shall determine the public service identity of the controlling MCData function hosting the one-to-one IP Connectivity service for the calling user. + - 5) if unable to identify the controlling MCData function for IP Connectivity session, shall reject the SIP INVITE request with a SIP 404 (Not Found) response with the warning text "142 unable to determine the controlling function" in a Warning header field as specified in subclause 4.9, and shall not continue with any of the remaining steps; + - 6) shall determine whether the MCData user identified by the MCData ID is authorised for MCData communications by following the procedures in subclause 11.1; + - 7) if the procedures in subclause 11.1 indicate that the user identified by the MCData ID is not allowed to initiate MCData communications, shall reject the "SIP INVITE request for IP Connectivity session for originating participating MCData function" with a SIP 403 (Forbidden) response to the SIP INVITE request, with warning text set to "200 user not authorised to transmit data" in a Warning header field as specified in subclause 4.9, and shall not continue with the rest of the steps in this subclause; + - 8) shall generate a SIP INVITE request in accordance with 3GPP TS 24.229 [5]; + - 9) shall include the option tag "timer" in the Supported header field; + - 10) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; + - 11) shall set the Request-URI of the outgoing SIP INVITE request to the public service identity of the controlling MCData function as determined by step 4) in this subclause; + - 12) shall include the MCData ID of the originating user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; + - 13) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" (coded as specified in 3GPP TS 24.229 [5]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; + - 14) shall set the P-Asserted-Identity in the outgoing SIP INVITE request to the public user identity in the P-Asserted-Identity header field contained in the received SIP INVITE request; + - 15) shall include an SDP offer according to 3GPP TS 24.229 [5] based on the clause 20.1.2; + +- 16) if the received SIP INVITE request contains an application/vnd.3gpp.mcdata-info+xml MIME body that contains a element, shall check if the status of the functional alias is activated for the MCData ID. If the functional alias status is activated, then the participating MCData function shall set the element of the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request to the received value, otherwise shall not include a element; and +- 17) shall send the SIP INVITE request as specified to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the SIP INVITE request in step 16): + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include the option tag "timer" in a Require header field; +- 3) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If the "refresher" parameter is not included in the received request, the "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 4) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.ipconn media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn"; and + - c) the isfocus media feature tag; +- 5) shall include Warning header field(s) that were received in the incoming SIP 200 (OK) response; +- 6) shall include an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP 200 (OK) response; +- 7) if the incoming SIP 200 (OK) response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 8) shall include the public service identity received in the P-Asserted-Identity header field of the incoming SIP 200 (OK) response into the P-Asserted-Identity header field of the outgoing SIP 200 (OK) response; and +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; +- 10) shall send the SIP 200 (OK) response to the MCData client according to 3GPP TS 24.229 [5]; and +- 11) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the SIP INVITE request in step 15) the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the MCData client according to 3GPP TS 24.229 [5]. + +## 20.3.2 Terminating participating MCData function procedures + +Upon receipt of a "SIP INVITE request for IP Connectivity session for terminating participating MCData function", the participating MCData function: + +- 1) if unable to process the request, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The participating MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the participating MCData function shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in subclause 4.4, and shall not continue with the rest of the steps; + +- 3) shall use the MCData ID present in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCData ID and public user identity of the terminating MCData user; +- 4) if the binding between the MCData ID and public user identity of the terminating MCData user does not exist, then the participating MCData function shall reject the SIP INVITE request with a SIP 404 (Not Found) response, and shall not continue with the rest of the steps; +- 5) shall generate a SIP INVITE request accordance with 3GPP TS 24.229 [5]; +- 6) should include the Session-Expires header field according to IETF RFC 4028 [38]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 7) shall include the option tag "timer" in the Supported header field; +- 8) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.ipconn media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service:ims.icsi.mcdata.ipconn"; + - c) the isfocus media feature tag; + - d) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the incoming SIP INVITE request; and + - e) any other uri-parameter provided in the Contact header field of the incoming SIP INVITE request; +- 9) shall include in the SIP INVITE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [8] that were received (if any) in the incoming SIP INVITE request; +- 10) shall set the Request-URI of the outgoing SIP INVITE request to the public user identity associated to the MCData ID of the terminating MCData user; +- 11) shall populate the outgoing SIP INVITE request with the MIME bodies that were present in the incoming SIP INVITE request; +- 12) shall copy the contents of the P-Asserted-Identity header field of the incoming SIP INVITE request to the P-Asserted-Identity header field of the outgoing SIP INVITE request; +- 13) shall include in the SIP INVITE request an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 20.1.2; and +- 14) shall send the SIP INVITE request as specified in 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 200 (OK) response in response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.229 [5]; +- 2) shall include the option tag "timer" in a Require header field; +- 3) shall include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". If no "refresher" parameter was included in the SIP INVITE request, the "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 4) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.ipconn media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service:ims.icsi.mcdata.ipconn"; and + +- c) an MCData session identity mapped to the MCData session identity provided in the Contact header field of the received SIP INVITE request from the controlling MCData function; +- 5) if the incoming SIP response contained an application/vnd.3gpp.mcdata-info+xml MIME body, shall copy the application/vnd.3gpp.mcdata-info+xml MIME body to the outgoing SIP 200 (OK) response. +- 6) shall copy the P-Asserted-Identity header field from the incoming SIP 200 (OK) response to the outgoing SIP 200 (OK) response; +- 7) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; +- 8) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; and +- 9) shall send the SIP 200 (OK) response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request, the participating MCData function: + +- 1) shall generate a SIP response according to 3GPP TS 24.229 [5]; +- 2) shall include Warning header field(s) that were received in the incoming SIP response; and +- 3) shall forward the SIP response to the controlling MCData function according to 3GPP TS 24.229 [5]. + +## 20.4 Controlling MCData function procedures + +### 20.4.1 Originating procedures + +This subclause describes the procedures for inviting an MCData client to an MCData session. The procedure is initiated by the controlling MCData function as the result of an action in subclause 20.4.2. + +The controlling MCData function: + +- 1) shall generate a SIP INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include the Supported header field set to "timer"; +- 3) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [38]. The refresher parameter shall be omitted; +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcdata.ipconn media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [8]; +- 5) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" along with parameters "require" and "explicit" according to IETF RFC 3841 [8]; +- 6) shall include a Referred-By header field with the public user identity of the inviting MCData client; +- 7) shall include in the Contact header field an MCData session identity for the MCData session with the g.3gpp.mcdata.ipconn media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" according to IETF RFC 3840 [16]; +- 8) shall include in the application/vnd.3gpp.mcdata-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the MCData ID of the terminating user; and +- 9) shall set the Request-URI to the public service identity of the terminating participating MCData function associated to the MCData user to be invited; + +NOTE 1: How the controlling MCData function finds the address of the terminating participating MCData function is out of the scope of the current release. + +- 10) shall set the P-Asserted-Identity header field to the public service identity of the controlling MCData function; + +- 11) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 12) shall include in the SIP INVITE request an SDP offer according to 3GPP TS 24.229 [5] with the clarifications given in subclause 20.1.2; and +- 13) shall send the SIP INVITE request towards the terminating client in accordance with 3GPP TS 24.229 [5]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the controlling MCData function: + +- 1) shall interact with the media plane as specified in 3GPP TS 24.582 [15]. + +NOTE 2: The procedures executed by the controlling MCData function prior to sending a response to the inviting MCData client are specified in subclause 20.4.2. + +## 20.4.2 Terminating procedures + +In the procedures in this subclause: + +- 1) MCData ID in an incoming SIP INVITE request refers to the MCData ID of the originating user from the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the incoming SIP INVITE request; +- 2) MCData ID in an outgoing SIP INVITE request refers to the MCData ID of the called user in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the outgoing SIP INVITE request; + +Upon receipt of a "SIP INVITE request for controlling MCData function for IP Connectivity session", the controlling MCData function: + +- 1) if unable to process the request may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The controlling MCData function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [4] and skip the rest of the steps; +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcdata.ipconn media feature tag; or + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn"; +- 3) shall cache SIP feature tags, if received in the Contact header field and if the specific feature tags are supported; +- 4) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [38]; +- 5) if the element in the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP INVITE request is set to a value of "one-to-one-ipconn" and the SIP INVITE request: + - a) does not contain an application/resource-lists MIME body or contains an application/resource-lists MIME body with more than one element, shall return a SIP 403 (Forbidden) response with the warning text set to "227 unable to determine targeted user for one-to-one IP Connectivity" in a Warning header field as specified in subclause 4.9, and skip the rest of the steps below; and + - b) contains an application/resource-lists MIME body with exactly one element, shall invite the MCData user identified by the element of the MIME body, as specified in subclause 20.4.1; and + - c) can interact with the media plane, in case routing or transmission control is necessary. + +Upon receiving a SIP 200 (OK) response for a SIP INVITE request as specified in subclause 20.4.1 and if the MCData ID in the SIP 200 (OK) response matches to the MCData ID in the corresponding SIP INVITE request, the controlling MCData function: + +- 1) shall generate SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [5]; +- 2) shall include the option tag "timer" in a Require header field; + +- 3) shall include the Session-Expires header field and start supervising the SIP session according to rules and procedures of IETF RFC 4028 [38], "UAS Behavior". The "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 4) shall include a P-Asserted-Identity header field with the public service identity of the controlling MCData function; +- 5) shall include a SIP URI for the MCData session identity in the Contact header field identifying the MCData session at the controlling MCData function; +- 6) shall include the following in the Contact header field: + - a) the g.3gpp.mcdata.ipconn media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn"; and + - c) the isfocus media feature tag; +- 7) shall include Warning header field(s) received in incoming responses to the SIP INVITE request; +- 8) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the subclause 20.1.2; +- 9) shall interact with the media plane as specified in 3GPP TS 24.582 [15]; and +- 10) shall send a SIP 200 (OK) response to the inviting MCData client according to 3GPP TS 24.229 [5]. + +--- + +## 21 MCData Message Store + +### 21.1 General + +This clause defines procedures for communication between MCData message store client and MCData message store function as well as MCData server and MCData message store function as specified in subclause 7.13.3 of 3GPP TS 23.282[2]. The communication between the MCData message store client and MCData message store function shall use HTTP over TLS as specified in annex A of 3GPP TS 24.482 [24]. + +The MCData message store function shall act as an HTTP server as defined in annex A of 3GPP TS 24.482 [24]. + +The MCData message store client in the role of an HTTP client shall include the MCData access token (with the "Bearer" authentication scheme) in the Authorization header field of an HTTP request as specified in 3GPP TS 24.482 [24]. + +**Editor's note:** [eMCData2, CR 0168, C1-204022] The security mechanism for communication from the MCData server acting as an HTTP client and the Message store function acting as an HTTP server is FFS. + +The HTTP server (i.e. MCData message store) shall validate the MCData access token as specified in 3GPP TS 24.482 [24]. + +NOTE 1: In procedures for communication between MCData message store client and MCData message store function, the MCData ID which is the identity of the MCData user is part of MCData access token as specified in 3GPP TS 24.482 [24]. + +NOTE 1A: In procedures for communication between MCData server and MCData message store function, the MCData ID which is the identity of the MCData user is used as the value of the resource URL variable, "boxId" as specified in subclause 5.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +The interface between MCData message store client and MCData message store function (i.e. MCData-7) as well as the interface between MCData server and MCData message store function (i.e. MCData-8) shall be based on the RESTful API as specified in OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +NOTE 2: Procedures defined for communication between the MCData message store client and MCData message store function as well as MCData server and MCData message store function in the following sections reference subclause 6 "Detailed specification of the resources" of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. Additional information related to RESTful resources, data types and sequence diagrams are found in subclause 5 and JSON examples in appendix D of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2 MCData message store functions and client procedures + +### 21.2.1 Object retrieval procedure + +#### 21.2.1.1 Message store client procedures + +To retrieve the object from message store function, the message store client, acting as an HTTP client shall follow the procedure described in subclause 6.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP GET request as specified in subclause 6.2.3 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send the HTTP GET request towards the message store function. + +Upon receipt of a HTTP response, the message store client shall follow the procedure as described in subclause 6.2.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +#### 21.2.1.2 Message store function procedures + +Upon receipt of the HTTP GET request from the client, as per subclause 21.2.1.1, with the Request-URI identifying a resource in the message store, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP GET request by following the procedures described in subclause 6.2.3 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send a HTTP response towards the message store client indicating the result of the operation (e.g. if the object identified by the Request URI was successfully found, it is returned in the HTTP response). + +### 21.2.2 Object search procedure + +#### 21.2.2.1 Message store client procedures + +To search for information about a selected set of objects in the message store, the message store client, acting as an HTTP client shall follow the procedure described in subclause 6.8 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.8.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send the HTTP POST request, which may include a SelectionCriteria, towards the message store function. + +Upon receipt of a HTTP response, the message store client shall follow the procedure as describe in subclause 6.8.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +### 21.2.2.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per subclause 21.2.2.1, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP POST request by following the procedures described in subclause 6.8.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send an HTTP response, containing the objects matching the SelectionCriteria, towards the message store client. + +### 21.2.3 Update object(s) procedure + +#### 21.2.3.1 Message store client procedures + +To update object(s) in the message store, the message store client, acting as an HTTP client, shall either follow the procedure described in subclause 6.3 or 6.4, for individual object update, or 6.11 for bulk update of objects, of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall either generate an HTTP PUT request as specified in subclause 6.3.4, 6.4.4, for individual object update, or an HTTP POST request, as specified in subclause 6.11.5, for bulk update of objects, of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66], with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send HTTP PUT request, for individual object update, or HTTP POST request, for bulk update of objects, towards the message store function. + +Upon receipt of a HTTP response, the message store client shall either follow the procedure as described in subclause 6.3.2, 6.4.2 for individual object update response, or subclause 6.11.2 for bulk update of objects response, of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +#### 21.2.3.2 Message store function procedures + +Upon receipt of the HTTP PUT or HTTP POST request from the client, as per subclause 21.2.3.1, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) if the received request is an HTTP PUT, shall process the HTTP PUT request for individual object update by following the procedure described in subclauses 6.3.2 or 6.4.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; +- 3) if the received request is an HTTP POST, shall process the HTTP POST request by following the procedure described in subclause 6.11.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] for bulk update of objects; and +- 4) shall generate and send an HTTP response towards the message store client indicating the result of the update operation. + +### 21.2.4 Delete stored object(s) procedure + +#### 21.2.4.1 Message store client procedures + +To delete object(s) in the message store, the message store client, acting as an HTTP client, shall either follow the procedure described in subclause 6.2, for individual object delete, or subclause 6.12 for bulk delete of objects, of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall either generate an HTTP DELETE request as specified in subclause 6.2.6, for individual object delete, or an HTTP POST request as specified in subclause 6.12.6, for bulk delete of objects, of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66], with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send HTTP DELETE request, for individual object delete, or HTTP POST request, for bulk delete of objects, towards the message store function. + +Upon receipt of a HTTP response, the message store client shall either follow the procedure as described in subclause 6.2.2, for individual object delete response, or subclause 6.12.2, for bulk delete of objects response, of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +#### 21.2.4.2 Message store function procedures + +Upon receipt of the HTTP DELETE or HTTP POST request from the client, as per subclause 21.2.4.1, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) if the received request is an HTTP DELETE, shall process the HTTP DELETE request for individual object delete by following the procedure described in subclause 6.2.6 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; +- 3) if the received request is an HTTP POST, shall process the HTTP POST request by following the procedure specified in subclause 6.12.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] for bulk delete of objects; and +- 4) shall generate and send an HTTP response towards the message store client indicating the result of the delete procedure. + +#### 21.2.5 Void + +#### 21.2.5A Deposit an object + +##### 21.2.5A.1 MCData server procedures + +To deposit an object of an MCData user in the message store, the MCData server acting as an HTTP client shall follow the procedure described in clause 6.1 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarification: + +- 1) shall generate an HTTP POST request as specified in clause 6.1.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall set the boxId of the resource URL as specified in clause 6.1.1 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] to MCData ID which is the identity of the MCData user; + - c) shall include a valid MCData access token in the HTTP Authorization header; and +- 2) shall send the HTTP POST request towards the message store function. + +Upon receipt of an HTTP response, the MCData server shall follow the procedure described in subclause 6.1.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +##### 21.2.5A.2 Message store function procedures + +Upon receipt of an HTTP POST request from MCData server, as per subclause 21.2.5A.1, with a Request-URI identifying a resource on the message store, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24]; and +- 2) if validation is successful then + - a) shall process the HTTP POST request by following the procedures described in clause 6.1.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send the HTTP response towards the MCData server indicating the result of the deposit an object operation as per subclause 6.1.2 of the OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.6 Object and folder copy procedure + +### 21.2.6.1 Message store client procedures + +To copy object(s) and/or folder(s) to a destination folder in message store, the message store client, acting as an HTTP client, shall follow the procedure described in subclause 6.18 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.18.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send HTTP POST request identifying the target folder and the source object(s) and/or folder(s) for copying operation towards the message store function. + +Upon receipt of an HTTP response, the message store client should follow the procedure as described in subclause 6.18.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +### 21.2.6.2 Message store function procedures + +Upon receipt of the HTTP POST from the client, as per subclause 21.2.6.1, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP POST request by following the procedures described in subclause 6.18.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] and copy to the target folder the requested source object(s) and/or folders(s); and +- 3) shall generate and send a HTTP response towards the message store client indicating the result of the operation. + +## 21.2.7 Deleting a folder procedure + +### 21.2.7.1 Message store client procedures + +To delete a folder in message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in subclause 6.14 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP DELETE request as specified in subclause 6.14.6 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send the HTTP DELETE request identifying the folder to be deleted towards the message store function. + +Upon receipt of a HTTP response, the message store client should follow the procedure as described in subclause 6.14.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.7.2 Message store function procedures + +Upon receipt of the HTTP DELETE request from the client, as per subclause 21.2.7.1, with the Request-URI identifying the folder in the message store to be deleted, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP DELETE request by following the procedures described in subclause 6.14.6 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send a HTTP response towards the message store client indicating the result of the operation. + +## 21.2.8 Create a folder procedure + +### 21.2.8.1 Message store client procedures + +To create a folder in message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in subclause 6.13 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.13.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send towards the message store function the HTTP POST request identifying the target folder where the new folder is to be created. + +Upon receipt of a HTTP response, the message store client should follow the procedure as described in subclause 6.13.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +### 21.2.8.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per subclause 21.2.8.1, identifying the new folder to be created, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP POST request by following the procedures described in subclause 6.13.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] and create the requested folder; and +- 3) shall generate and send a HTTP response towards the message store client indicating the result of the operation. + +## 21.2.9 void + +## 21.2.10 Moving object(s) and folder(s) procedure + +### 21.2.10.1 Message store client procedures + +To move object(s) and/or folder(s) to a destination folder in the message store, the message store client, acting as an HTTP client shall follow the procedure described in subclause 6.19 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.19.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + +- a) shall set the Host header field to a hostname identifying the message store function; +- b) shall include a valid MCData access token in the HTTP Authorization header; and +- c) shall send the HTTP POST request, identifying source objects and/or folder(s) to be moved to the designated destination folder, towards the message store function. + +Upon receipt of a HTTP response, the message store client shall follow the procedure as described in subclause 6.19.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.10.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per subclause 21.2.10.1, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP POST request by following the procedures described in subclause 6.19.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] and perform the move operation; and +- 3) shall generate and send a HTTP response towards the message store client indicating the result of the operation. + +## 21.2.11 Folder search procedure + +### 21.2.11.1 Message store client procedures + +To search for information about a selected set of folder(s) in the message store, the message store client, acting as an HTTP client shall follow the procedure described in subclause 6.16 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.16.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send the HTTP POST request, which may include a SelectionCriteria, towards the message store function. + +Upon receipt of a HTTP response, the message store client should follow the procedure as described in subclause 6.16.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +### 21.2.11.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per subclause 21.2.11.1, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP POST request by following the procedures described in subclause 6.16.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send a HTTP response, containing the folders matching the SelectionCriteria, towards the message store client. + +## 21.2.12 Void + +### 21.2.12A Create a subscription to notifications + +#### 21.2.12A.1 Message store client procedures + +In order for the message store client to keep its local store in sync with the MCData message store, it needs to receive notifications about changes in the message store. For this purpose, the message store client would need to subscribe to notification from the message store. Synchronization using subscriptions and notifications is described in clause 5.1.5.1 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +To create a subscription to notifications about changes in the message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in clause 6.20 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.20.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; and + - b) shall include a valid MCData access token in the HTTP Authorization header; and +- 2) shall send the HTTP POST request towards the message store function. + +Upon receipt of an HTTP response, the message store client should follow the procedure as described in clause 6.20.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +#### 21.2.12A.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per subclause 21.2.12.1, with a Request-URI identifying a resource on the message store, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24]; and +- 2) if validation is successful then + - a) shall process the HTTP POST request by following the procedures described in clause 6.20.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] and create the requested subscription; and +- 3) shall generate and send an HTTP response towards the message store client indicating the result of the operation as per subclause 6.20.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.13 Void + +### 21.2.13A Delete a subscription to notifications + +#### 21.2.13A.1 Message store client procedures + +To delete / cancel a subscription and stop corresponding notifications about changes in the message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in clause 6.21 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarification: + +- 1) shall generate an HTTP DELETE request as specified in subclause 6.21.6 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and +- 2) shall send the HTTP DELETE request identifying the subscription to be deleted towards the message store function. + +Upon receipt of an HTTP response, the message store client should follow the procedure as described in clause 6.21.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.13A.2 Message store function procedures + +Upon receipt of the HTTP DELETE request from the client, as per clause 21.2.13.1, with a Request-URI identifying the subscription resource on the message store, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in TS 24.482 [24]; and +- 2) if validation is successful then + - a) shall process the HTTP DELETE request by following the procedures described in clause 6.21.6 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] and delete the requested subscription; and +- 3) shall generate and send an HTTP response towards the message store client indicating the result of the operation as per clause 6.21.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.14 Void + +### 21.2.14A Update a subscription to notifications + +#### 21.2.14A.1 Message store client procedures + +A client may update its subscription to notification in order to: + +- 1) extend the life of the subscription; +- 2) restart the notification stream from where it left off. + +Synchronization using subscriptions and notifications is described in clause 5.1.5.1 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] + +To update a subscription to notifications about changes in the message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in clause 6.21 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] the with following clarification: + +- 1) shall generate an HTTP POST request as specified in clause 6.21.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and +- 2) shall send the HTTP POST request towards the message store function. + +Upon receipt of an HTTP response, the message store client should follow the procedure described in clause 6.21.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +#### 21.2.14A.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per bclause 21.2.14A.1, with a Request-URI identifying a subscription resource on the message store, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in TS 24.482 [24]; and +- 2) if validation is successful then + - a) shall process the HTTP POST request by following the procedures described in clause 6.21.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] and update the requested subscription; and +- 3) shall generate and send an HTTP response towards the message store client indicating the result of the operation as per clause 6.21.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.15 Object(s) upload procedure + +### 21.2.15.1 Message store client procedures + +To upload the object(s) to the message store, the message store client acting as an HTTP client, shall follow the procedure described in subclause 6.1 for single upload and subclause 6.10 for bulk upload as specified in the OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarification: + +- 1) shall generate an HTTP POST request as specified in subclause 6.1.5 and 6.10.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; and + - c) shall send the HTTP POST request towards the message store function. + +Upon receipt of an HTTP response, the message store client shall follow the procedure as described in subclause 6.1.2 for single upload and 6.10.2 for bulk upload as specified in the OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +### 21.2.15.2 Message store function procedures + +Upon receipt of an HTTP POST request from the client, as per subclause 21.2.15.1, with a Request-URI identifying a resource on the message store, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24] and if validation is successful then +- 2) shall process the HTTP POST request by following the procedures described in subclause 6.1.5 and 6.10.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send the HTTP response towards the message store client indicating the result of the upload operation. + +## 21.2.16 Synchronization notifications + +### 21.2.16.1 Message store function procedures + +To send notifications about changes in the message store using the message store function, the MCData message store, acting as an HTTP client shall follow the procedure described in clause 6.22 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarification: + +- 1) shall generate an HTTP POST request as specified in clause 6.22.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarifications: + - a) shall set the Host header field to the callback URL which was previously provided by the client in its corresponding subscription creation request as specified in clause 21.2.12; and + - b) shall send the HTTP POST request towards the callback URL provided by the client. + +Upon receipt of an HTTP response, the message store function should follow the procedure as described in clause 6.22.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +### 21.2.16.2 Message store client procedures + +Upon receipt of the HTTP POST request from the MCData message store, as per clause 21.2.16.1, the message store client acting as an HTTP server: + +- 1) shall process the HTTP POST request by following the procedures described in clause 6.22.5 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- a) either use the notification content and the reported "restartToken" and "index" as specified in clause 5.1.5.1 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] to have the client's local message store updated accordingly; or + +- b) use the notification as a trigger to subsequently search the MCData message store for the list of changes as specified in clause 21.2.11.1; and +- 2) shall generate and send an HTTP response towards the message store function indicating the result of the operation as per clause 6.22.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +NOTE: The notifications about changes in the MCData message store can be used by the message store client to synchronize its local message store with the MCData message store in two distinguished ways which are listed in sub-bullets "a" and "b" above. + +## 21.2.17 Search-based synchronization + +### 21.2.17.1 Message store client procedures + +To search for changes (e.g. newly created objects, recently deleted objects, etc) in the MCData message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in clause 21.2.2.1 with following clarification: + +- 1) shall use the search criterion of "CreatedObjects", "VanishedObjects" or "Flag" in the HTTP POST request as specified in clause 5.1.5.2 and 5.4.2.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] in order to retrieve from the message store the list of the newly created object, recently deleted object and/or changes to flags respectively. + +### 21.2.17.2 Message store function procedures + +Upon receipt of the HTTP POST request from the client, as per clause 21.2.17.1, the message store function acting as an HTTP server shall follow the procedure described in clause 21.2.2.2 with the following clarification: + +- 1) if search criterion in the HTTP POST request is set to "CreatedObjects", then the HTTP POST, the response shall include a "creationCursor" as specified in clause 5.3.2.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.18 List subfolders of a given folder + +### 21.2.18.1 Message store client procedures + +To list subfolders of a given folder identified by its folder ID in the message store using the message store function, the message store client, acting as an HTTP client shall follow the procedure described in clause 6.14 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarification: + +- 1) shall generate an HTTP GET request as specified in clause 6.14.3 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] with the following clarifications: + - a) shall set the Host header field to a hostname identifying the message store function; + - b) shall include a valid MCData access token in the HTTP Authorization header; + - c) shall set the query string "listFilter" to: + - i) "Subfolders" if only a list of subfolders is to be returned; + - ii) "Objects" if only a list of objects is to be returned; or + - iii) "All" if a list all contents of the specified folder is to be returned; and +- 2) shall send the HTTP GET request towards the message store function. + +NOTE: in order for the message store client to list the subfolders of the root folder, it first needs to discover its folder ID as described in clause 5.1.6 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66] using Folder search procedure specified in clause 21.2.11 of the present document. + +Upon receipt of an HTTP response, the message store client should follow the procedure as described in clause 6.14.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +## 21.2.18.2 Message store function procedures + +Upon receipt of the HTTP GET request from the client, as per clause 21.2.18.1, with a Request-URI containing the query string listFilter = Subfolders, the message store function acting as an HTTP server: + +- 1) shall validate the MCData access token (with "Bearer" authentication scheme) received in the Authorization header of the request as specified in 3GPP TS 24.482 [24]; and +- 2) if validation is successful then + - a) shall process the HTTP GET request by following the procedures described in clause 6.14.3 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]; and +- 3) shall generate and send a HTTP response containing the subfolders towards the message store client indicating the result of the operation as per clause 6.14.2 of OMA-TS-REST\_NetAPI\_NMS-V1\_0-20190528-C [66]. + +--- + +# 22 Functional alias + +## 22.1 General + +Clause 22.2 contains the procedures for management of functional alias at the MCData client, the MCData server serving the MCData user and the MCData server owning the functional alias. + +Clause 22.3 describes the coding used for management of functional aliases. + +## 22.2 Procedures + +### 22.2.1 MCData client procedures + +#### 22.2.1.1 General + +The MCData client procedures consist of: + +- a functional alias status change procedure; +- a functional alias status determination procedure; and +- a location based functional alias status change procedure. + +In order to obtain information about success or rejection of changes triggered by the functional alias status change procedure for an MCData user, the MCData client needs to initiate the functional alias status determination procedure for the MCData user before starting the functional alias status change procedure for the MCData user. + +#### 22.2.1.2 Functional alias status change procedure + +In order: + +- to indicate that an MCData user requests to activate one or more functional aliases; +- to indicate that the MCData user requests to deactivate one or more functional aliases; +- to refresh indication of an MCData user interest in one or more functional aliases due to near expiration of the expiration time of a functional alias with the status set to the "activated" state received in a SIP NOTIFY request in subclause 22.2.1.3; +- to indicate that the MCData client entering into or exiting from a location area triggers one or more functional aliases to be activated; +- to indicate that the MCData client entering into or exiting from a location area triggers one or more functional aliases to be deactivated; or +- any combination of the above; + +the MCData client shall generate a SIP PUBLISH request according to TS 24.229 [5], IETF RFC 3903 [34], and IETF RFC 3856 [39]. + +When the MCData user requests to deactivate a functional alias, the MCData client shall first check the element within the element of the element corresponding to the functional alias within the list element of the element of the element of the MCData user profile document (see the MCData user profile document in TS 24.484 [12]). If the functional alias has been activated due to a location area trigger and the element is set to a value of "true", the MCData client shall suppress the MCData user's request. + +NOTE 1: If the request is suppressed, a notification message can be displayed to the user. + +In the SIP PUBLISH request, the MCData client: + +- 1) shall set the Request-URI to the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall include the element set to the MCData ID of the MCData user; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 4) if the MCData client requests to activate one or more functional aliases, shall set the Expires header field according to IETF RFC 3903 [34], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if the MCData client requests to deactivate one or more functional aliases, shall set the Expires header field according to IETF RFC 3903 [34], to zero; and + +NOTE 3: Activation and deactivation of functional alias cannot be performed with the same PUBLISH request. + +- 6) shall include an application/pidf+xml MIME body indicating per-user functional alias information according to subclause 22.3.1. In the MIME body, the MCData client: + - a) shall include all functional aliases where the MCData user requests activation for the MCData ID; + - b) shall include the MCData client ID of the targeted MCData client; + - c) shall not include the "status" attribute and the "expires" attribute in the element; + - d) if the MCData client has received an indication that take over of a functional alias is possible and intends to take over a functional alias, shall include a child element set to "true"; and + - e) shall set the child element of the root element to a globally unique value. + +The MCData client shall send the SIP PUBLISH request according to TS 24.229 [5]. + +### 22.2.1.3 Functional alias status determination procedure + +NOTE 1: The MCData UE also uses this procedure to determine which functional alias have been successfully activated for the MCData ID. + +In order to discover functional aliases: + +- 1) which which are activated for the MCData user; or +- 2) which another MCData user has activated; + +the MCData client shall generate an initial SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. + +In the SIP SUBSCRIBE request, the MCData client: + +- 1) shall set the Request-URI to the public service identity identifying the originating participating MCData function serving the MCData user; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData client shall include: + - a) the element set to the MCData ID of the targeted MCData user; and + - b) the element in the element of the element set to the value "functional-alias-status-determination"; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 4) if the MCData client wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if the MCData client wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [36], to zero; +- 6) shall include an Events header field set to "presence"; and +- 7) shall include an Accept header field containing the application/pidf+xml MIME type. + +In order to re-subscribe or de-subscribe, the MCData client shall generate an in-dialog SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. In the SIP SUBSCRIBE request, the MCData client: + +- 1) if the MCData client wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 3: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 2) if the MCData client wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [36], to zero; +- 3) shall include an Events header field set to "presence"; and +- 4) shall include an Accept header field containing the application/pidf+xml MIME type. + +Upon receiving a SIP NOTIFY request according to TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36], if SIP NOTIFY request contains an application/pidf+xml MIME body indicating per-user functional alias information constructed according to subclause 22.3.1, then the MCData client shall determine the status of the MCData user for each functional alias in the MIME body. If the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request is included, the element value indicates the SIP PUBLISH request which triggered sending of the SIP NOTIFY request. + +If the MCData client detected a functional alias activation or deactivation, it shall perform the procedure specified in subclause 8.2.6. + +#### 22.2.1.4 Location based functional alias status change procedure + +If a location criterion for functional alias activation or de-activation is met, the MCData client shall initiate the functional alias status change procedure as specified in subclause 22.2.1.2. + +## 22.2.2 MCData server procedures + +### 22.2.2.1 General + +The MCData server procedures consist of: + +- procedures of MCData server serving the MCData user; and +- procedures of MCData server owning the functional alias. + +### 22.2.2.2 Procedures of MCData server serving the MCData user + +#### 22.2.2.2.1 General + +The procedures of MCData server serving the MCData user consist of: + +- a receiving functional alias status change from MCData client procedure; +- a receiving subscription to functional alias status procedure; +- a sending notification of change of functional alias status procedure; +- a sending functional alias status change towards MCData server owning the functional procedure; and +- a functional alias status determination from MCData server owning the functional alias procedure. + +#### 22.2.2.2.2 Stored information + +The MCData server shall maintain a list of MCData user information entries. The list of the MCData user information entries contains one MCData user information entry for each served MCData ID. + +In each MCData user information entry, the MCData server shall maintain: + +- 1) an MCData ID. This field uniquely identifies the MCData user information entry in the list of the MCData user information entries; and +- 2) a list of functional alias information entries. + +In each functional alias information, the MCData server shall maintain: + +- 1) a functional alias ID. This field uniquely identifies the functional alias information entry in the list of the functional alias information entries; +- 2) a functional alias status; +- 3) an expiration time; +- 4) a functional alias p-id-fa; and +- 5) a next publishing time. + +#### 22.2.2.2.3 Receiving functional alias status change from MCData client procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains either the public service identity identifying the originating participating MCData function serving the MCData user, or the public service identity identifying the terminating participating MCData function serving the MCData user; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element which identifies an MCData ID served by the MCData server; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in 3GPP TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and + +- 5) SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-user functional alias information according to subclause 22.3.1; + +then the MCData server: + +- 1) shall identify the served MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 2) if the Request-URI of the SIP PUBLISH request contains the public service identity identifying the originating participating MCData function serving the MCData user, shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP PUBLISH request; +- 3) if the Request-URI of the SIP PUBLISH request contains the public service identity identifying the terminating participating MCData function serving the MCData user, shall identify the originating MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 4) if the originating MCData ID is different than the served MCData ID or the originating MCData ID is not authorized to modify functional alias status of the served MCData ID, shall send a SIP 403 (Forbidden) response and shall not continue with the rest of the steps; +- 5) if the Expires header field of the SIP PUBLISH request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP PUBLISH request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 6) if the Expires header field of the SIP PUBLISH request has nonzero value, shall determine the candidate expiration interval to according to IETF RFC 3903 [34]; +- 7) if the Expires header field of the SIP PUBLISH request has zero value, shall set the candidate expiration interval to zero; +- 8) shall respond with SIP 200 (OK) response to the SIP PUBLISH request according to TS 24.229 [5], IETF RFC 3903 [34]. In the SIP 200 (OK) response, the MCData server: + - a) shall set the Expires header field according to IETF RFC 3903 [34], to the candidate expiration time; +- 9) if the "entity" attribute of the element of the application/pidf+xml MIME body of the SIP PUBLISH request is different than the served MCData ID, shall not continue with the rest of the steps; +- 10) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of MCData user information entries described in subclause 22.2.2.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID;as the served MCData user information entry; +- 11) shall consider a copy of the list of the MCData functional alias entries of the served MCData user information entry as the served list of the MCData functional alias information entries; +- 12) if the candidate expiration interval is nonzero, shall construct the candidate list of the MCData functional alias entries as follows: + - a) for each functional alias ID which has a functional alias information entry in the served list of the functional alias information entries, such that the expiration time of the functional alias information entry has not expired yet, and which is indicated in a "functionalAliasID" attribute of a element of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request: + - i) shall copy the functional alias information entry into a new functional alias information entry of the candidate list of the functional alias information entries; + +- ii) if the functional alias status of the functional alias information entry is "deactivating" or "deactivated", shall set the functional alias status of the new functional alias information entry to the "activated" state and shall reset the activating p-id-fa of the new functional alias information entry; and + - iii) shall set the expiration time of the new functional alias information entry to the current time increased with the candidate expiration interval; + - b) for each functional alias ID which has a functional alias information entry in the served list of the functional alias information entries, such that the expiration time of the functional alias information entry has not expired yet, and which is not indicated in any "functionalAliasID" attribute of the element of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request: + - i) shall copy the functional alias information entry into a new functional alias information entry of the candidate list of the functional alias information entries; and + - ii) if the functional alias status of the functional alias information entry is "activated" or "activating": + - shall set the functional alias status of the new functional alias entry to the "deactivating" state; and + - shall set the expiration time of the new functional alias information entry to the current time increased with twice the value of timer F; and + - c) for each functional alias ID: + - i) which does not have a functional alias information entry in the served list of the functional alias entries; or + - ii) which has a functional alias information entry in the served list of the functional alias information entries, such that the expiration time of the functional alias information entry has already expired;and which is indicated in a "functionalAliasID" element of the element of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request: + - i) shall add a new functional alias information entry in the candidate list of the functional alias information list for the functional alias ID; + - ii) shall set the functional alias status of the new functional alias information entry to the "activating" state; + - iii) shall set the expiration time of the new functional alias information entry to the current time increased with the candidate expiration interval; and + - iv) shall reset the activating p-id-fa of the new functional alias information entry; +- 13) if the candidate expiration interval is zero, constructs the candidate list of the functional alias information entries as follows: +- a) for each functional alias ID which has an entry in the served list of the functional alias information entries: + - i) shall copy the functional alias entry of the served list of the functional alias information into a new functional alias information entry of the candidate list of the functional alias information entries; + - ii) shall set the functional alias status of the new functional alias information entry to the "de-activating" state; and + - iii) shall set the expiration time of the new functional alias information entry to the current time increased with twice the value of timer F; +- 14) shall replace the list of the functional alias information entries stored in the served MCData user information entry with the candidate list of the functional alias information entries; +- 15) shall perform the procedures specified in subclause 22.2.2.2.6 for the served MCData ID and each functional alias: + +- a) which does not have a functional alias information entry in the served list of the functional alias information entries and which has a functional alias information entry in the candidate list of the functional alias information entries with the functional alias status set to the "activating" state; + - b) which has a functional alias information entry in the served list of the functional alias information entries with the expiration time already expired, and which has a functional alias information entry in the candidate list of the functional alias information entries with the functional alias status set to the "activating" state; + - c) which has a functional alias information entry in the served list of the functional alias information entries with the functional alias status set to the "deactivating" state or the "deactivated" state and with the expiration time not expired yet, and which has an functional alias information entry in the candidate list of the functional alias information entries with the functional alias status set to the "activating" state; or + - d) which has a functional alias information entry in the served list of the functional alias information entries with the functional alias status set to the "activated" state and with the expiration time not expired yet, and which has an functional alias information entry in the candidate list of the functional alias information entries with the functional alias status set to the "deactivating" state; +- 16) shall identify the handled p-id-fa in the child element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and +- 17) shall perform the procedures specified in subclause 22.2.2.2.5 for the served MCData ID. + +#### 22.2.2.2.4 Receiving subscription to functional alias status procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains either the public service identity identifying the originating participating MCData function serving the MCData user, or the public service identity identifying the terminating participating MCData function serving the MCData user; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing: + - a) the element which identifies an MCData ID served by the MCData server; and + - b) the element with the element with the element set to a value of "functional-alias-status-determination"; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; + +the MCData server: + +- 1) shall identify the served MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the originating participating MCData function serving the MCData user, shall identify the originating MCData ID from public user identity in the P-Asserted-Identity header field of the SIP SUBSCRIBE request; +- 3) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the terminating participating MCData function serving the MCData user, shall identify the originating MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 4) if the originating MCData ID is different than the served MCData ID and the originating MCData ID is not authorized to modify functional alias status of the served MCData ID, shall send a SIP 403 (Forbidden) response and shall not continue with the rest of the steps; and +- 5) shall generate a SIP 200 (OK) response to the SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 6665 [36]. + +For the duration of the subscription, the MCData server shall notify the subscriber about changes of the information of the served MCData ID, as described in subclause 22.2.2.2.5. + +#### 22.2.2.2.5 Sending notification of change of functional alias status procedure + +In order to notify the subscriber about changes of functional aliases of the served MCData ID, the MCData server: + +- 1) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of MCData user information entries described in subclause 22.2.2.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID;as the served MCData user information entry; +- 2) shall generate an application/pidf+xml MIME body indicating per-user functional alias information according to clause 22.3.1 and the served list of the MCData user information entries with the following clarifications: + - a) the MCData server shall not include information from functional alias information entry with the expiration time already expired; + - b) the MCData server shall not include information from a functional alias information entry with the functional alias status set to the "deactivated" state; + - c) if this procedure is invoked by procedure in clause 22.2.2.2.3 where the handled p-id-fa value was identified, the MCData server shall set the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request to the handled p-id-fa value; and +- 3) send a SIP NOTIFY request according to 3GPP TS 24.229 [5], and IETF RFC 6665 [36] for the subscription created in clause 22.2.2.2.4. In the SIP NOTIFY request, the MCData server shall include the generated application/pidf+xml MIME body indicating per-user functional alias information. + +#### 22.2.2.2.6 Sending functional alias status change towards MCData server owning the functional alias procedure + +NOTE 1: Usage of one SIP PUBLISH request to carry information about change of functional alias state of several MCData users served by the same MCData server is not supported in this version of the specification. + +In order: + +- to send an activation request of a served MCData ID for a handled functional alias ID; +- to send a deactivation request of a served MCData ID for a handled functional alias ID; +- to send a take over request of a served MCData ID for a handled functional alias ID due to take over; or +- to send an activation request of a served MCData ID for a handled functional alias ID due to near expiration of the previously published information; + +the MCData server shall generate a SIP PUBLISH request according to TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39]. In the SIP PUBLISH request, the MCData server: + +- 1) shall set the Request-URI to the public service identity of the controlling MCData function associated with the handled functional alias ID; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData server: + - a) shall include the element set to the handled functional alias ID; and + - b) shall include the element set to the served MCData ID; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6080 [7]; + +- 4) if sending an activation request, shall set the Expires header field according to IETF RFC 3903 [34], to 4294967295; + +NOTE 1: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if sending an deactivation request, shall set the Expires header field according to IETF RFC 3903 [34], to zero; +- 6) shall include an P-Asserted-Identity header field set to the public service identity of the MCData server according to 3GPP TS 24.229 [5]; +- 7) shall set the current p-id-fa to a globally unique value; +- 8) shall consider an MCData user information entry such that: + +- a) the MCData user information entry is in the list of MCData user information entries described in clause 22.2.2.2.2; and + - b) the MCData ID of the MCData user information entry is equal to the served MCData ID; +- as the served MCData user information entry; + +- 9) for each functional alias information entry such that: + +- a) the functional alias information entry has the "activating" functional alias status, the functional alias ID set to the handled functional alias ID, the expiration time has not expired yet and the activating p-id-fa is not set; and +- b) the functional alias information entry is in the list of the functional alias information entries of the served MCData user information entry; + +shall set the activating p-id-fa of the functional alias information entry to the current p-id-fa; and + +- 10) shall include an application/pidf+xml MIME body indicating per-functional alias status information constructed according to clause 22.3.1.2. The MCData server shall indicate all served MCData user IDs, such that: + +- a) the functional alias status is set to "activating" with or without "take-over" element or "activated", and the expiration time has not expired yet in a functional alias information entry with the functional alias ID set to the handled functional alias; +- b) the functional alias information entry is in the list of the functional alias information entries of an MCData user information entry; and +- c) the MCData user information entry is a served MCData user information entry. + +The MCData server shall set the child element of the root element to the current p-id-fa. + +The MCData server shall not include the "expires" attribute in the element. + +The MCData server shall send the SIP PUBLISH request according to 3GPP TS 24.229 [5]. + +If timer F expires for the SIP PUBLISH request sent for a (de)activation request of served MCData ID for the functional alias ID or upon receiving a SIP 3xx, 4xx, 5xx or 6xx response to the SIP PUBLISH request, the MCData server: + +- 1) shall remove each functional alias ID entry such that: + - a) the functional alias information entry has the functional alias ID set to the handled functional alias ID; and + - b) the functional alias information entry is in the list of the functional alias information entries of the served MCData user information entry. + +#### 22.2.2.2.7 Functional alias status determination from MCData server owning functional alias procedure + +NOTE 1: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of functional alias state of several MCData users served by the same MCData server is not supported in this version of the specification. + +In order to discover whether a served MCData user successfully activated a handled functional alias in the MCData server owning the functional alias, the MCData server shall generate an initial SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. + +In the SIP SUBSCRIBE request, the MCData server: + +- 1) shall set the Request-URI to the public service identity of the controlling MCData function associated with the handled functional alias; +- 2) shall include an application/vnd.3gpp.mcdata-info+xml MIME body. In the application/vnd.3gpp.mcdata-info+xml MIME body, the MCData server: + - a) shall include the element set to the handled functional alias ID; and + - b) shall include the element set to the served MCData ID; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if the MCData server wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 5) if the MCData server wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [36], to zero; +- 6) shall include an Accept header field containing the application/pidf+xml MIME type; +- 7) shall include an Events header field set to "presence"; and +- 8) shall include an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to subclause 22.3.2, indicating the served MCData ID. + +In order to re-subscribe or de-subscribe, the MCData server shall generate an in-dialog SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36]. In the SIP SUBSCRIBE request, the MCData server: + +- 1) if the MCData server wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [36], to 4294967295; + +NOTE 3: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [4]. + +- 2) if the MCData server wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [36], to zero; +- 3) shall include an Events header field set to "presence"; and +- 4) shall include an Accept header field containing the application/pidf+xml MIME type. + +Upon receiving a SIP NOTIFY request according to TS 24.229 [5], IETF RFC 3856 [39], and IETF RFC 6665 [36], if SIP NOTIFY request contains an application/pidf+xml MIME body indicating per-functional alias information constructed according to subclause 22.3.1, then the MCData server: + +- 1) for each served MCData ID such that the application/pidf+xml MIME body of SIP NOTIFY request contains: + - a) a element of the root element; + +- b) the "id" attribute of the element indicating the served MCData ID; + - c) an child element of the element of the element; and + - d) the "expires" attribute of the element indicating expiration of activation of functional alias; +- perform the following: + +- a) if a functional alias information entry exists such that: + - i) the functional alias information entry has the "activating" functional alias status, the functional alias ID set to the handled functional alias ID, and the expiration time has not expired yet; + - ii) the functional alias information entry is in the list of the functional alias information entries of an MCData user information entry with the MCData ID set to the served MCData ID; and + - iii) the MCData user information entry is in the list of MCData user information entries described in clause 22.2.2.2.2; + +shall set the functional alias status of the functional alias information entry to "activated"; and + +shall set the next publishing time of the functional alias information entry to the current time and half of the time between the current time and the expiration of the functional alias; and + +2) for each functional alias information entry such that: + +- a) the functional alias information entry has the "activated" functional alias status or the "deactivating" functional alias status, the functional alias ID set to the handled functional alias ID, and the expiration time has not expired yet; +- b) the functional alias information entry is in the list of the functional alias information entries of an MCData user information entry with the MCData ID set to a served MCData ID; and +- c) the MCData user information entry is in the list of MCData user information entries described in clause 22.2.2.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain: + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the served MCData ID; and +- c) an child element of the child element of the element. + +perform the following: + +- a) shall set the functional alias status of the functional alias information entry to "deactivated"; and +- b) shall set the expiration time of the functional alias information entry to the current time; and + +3) if a element is included in the root element of the application/pidf+xml MIME body of the SIP NOTIFY request, then for each functional alias information entry such that: + +- a) the functional alias information entry has the "activating" functional alias status, the functional alias ID set to the handled functional alias ID, the expiration time has not expired yet and with the activating p-id-fa set to the value of the element; +- b) the functional alias information entry is in the list of the functional alias information entries of an MCData user information entry with the MCData ID set to a served MCData ID; and +- d) the MCData user information entry is in the list of MCData user information entries described in clause 22.2.2.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain: + +- a) a element of the root element; + +- b) the "id" attribute of the element indicating the served MCData ID; and + - c) an child element of the child element of the element; +- perform the following: +- a) shall set the functional alias status of the functional alias information entry to "deactivated"; and + - b) shall set the expiration time of the functional alias information entry to the current time. + +### 22.2.2.3 Procedures of MCData server owning the functional alias + +#### 22.2.2.3.1 General + +The procedures of MCData server owning the functional alias consist of: + +- receiving functional alias status change procedure; +- receiving subscription to functional alias status procedure; +- sending notification of change of functional alias status procedure; and +- modification of functional alias eligibility check procedure. + +#### 22.2.2.3.2 Stored information + +The MCData server shall maintain a list of functional alias information entries. + +In each functional alias information entry, the MCData server shall maintain: + +- 1) a functional alias ID. This field uniquely identifies the functional alias information entry in the list of the functional alias information entries; and +- 2) a list of MCData user information entries. + +In each MCData user information entry, the MCData server shall maintain: + +- 1) an MCData ID. This field uniquely identifies the MCData user information entry in the list of the MCData user information entries; +- 2) a take-over possible indication; and +- 3) an expiration time. + +#### 22.2.2.3.3 Receiving functional alias status change procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains the public service identity of the controlling MCData function associated with the served functional alias; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and +- 5) SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-functional alias information constructed according to clause 22.2.3.2; + +then the MCData server: + +- 1) shall identify the served functional alias in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; + +- 2) shall identify the handled MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP PUBLISH request; +- 3) if the Expires header field of the SIP PUBLISH request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP PUBLISH request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if the functional alias does not exist in the MCData server, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 4a) if SIP PUBLISH request is for activation of a functional alias then: + - a) if handled MCPTT ID does not match with any of the entries in the which contains the MCPTT IDs of MCPTT users which are allowed to activate the functional alias; or + - b) if no local policy exists that authorizes the request by the handled MCPTT ID;shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response according to 3GPP TS 24.229 [11], IETF RFC 3903 [12] and IETF RFC 3856 [13] and skip the rest of the steps; +- 5) if SIP PUBLISH request is for activation of a functional alias and the number of activations for the handled functional alias is equal , shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 6) if SIP PUBLISH request is for take over of a functional alias, the MCData server shall use the element to determine if take over is possible. If take over is not possible, the MCData server shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 7) shall respond with SIP 200 (OK) response to the SIP PUBLISH request according to TS 24.229 [5], IETF RFC 3903 [34]. In the SIP 200 (OK) response, the MCData server: + - a) shall set the Expires header field according to IETF RFC 3903 [34], to the selected expiration time; +- 8) if the "entity" attribute of the element of the application/pidf+xml MIME body of the SIP PUBLISH request is different than the served functional alias ID, shall not continue with the rest of the steps; +- 9) if the handled MCData ID is different from the MCData ID in the "id" attribute of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request, shall not continue with the rest of the steps; +- 10) shall consider a functional alias information entry such that: + - a) the functional alias information entry is in the list of functional alias information entries described in clause 22.2.2.3.2; and + - b) the functional alias ID of the functional alias information entry is equal to the served functional alias ID;as the served functional alias information entry; +- 11) if the selected expiration time is zero: + - a) shall remove the MCData user information entry such that: + - i) the MCData user information entry is in the list of the MCData user information entries of the served functional alias information entry; and + - ii) the MCData user information entry has the MCData ID set to the served MCData ID; +- 12) if the selected expiration time is not zero: + - a) shall consider an MCData user information entry such that: + +- i) the MCData user information entry is in the list of the MCData user information entries of the served functional alias information entry; and + - ii) the MCData ID of the MCData user information entry is equal to the handled MCData ID;as the served MCData user information entry; + - b) if the MCData user information entry does not exist: + - i) shall insert an MCData user information entry with the MCData ID set to the handled MCData ID into the list of the MCData user information entries of the served functional alias information entry; and + - ii) shall consider the inserted MCData user information entry as the served MCData user information entry; and + - c) shall set the expiration time in the served MCData user information entry according to the selected expiration time; +- 13) shall identify the handled p-id-fa in the child element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and +- 14) shall perform the procedures specified in clause 22.2.2.3.5 for the served functional alias ID. + +#### 22.2.2.3.4 Receiving subscription to functional alias status procedure + +NOTE: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of functional alias state of several MCData users served by the same MCData server is not supported in this version of the specification. + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity of the controlling MCData function associated with the served functional alias; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcdata-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcdata" (coded as specified in TS 24.229 [5]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; and +- 5) the SIP SUBSCRIBE request contains an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to clause 22.3.2 indicating the same MCData ID as in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; + +then the MCData server: + +- 1) shall identify the served functional alias ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the handled MCData ID in the element of the application/vnd.3gpp.mcdata-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Expires header field of the SIP SUBSCRIBE request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP SUBSCRIBE request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if a functional alias does not exist in the MCData server, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; +- 5) if the handled MCData ID based on local policy is not authorized for notifications of the functional alias identified by the served functional alias ID, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) + +response to the SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 3903 [34] and IETF RFC 3856 [39] and skip the rest of the steps; and + +- 6) shall generate a SIP 200 (OK) response to the SIP SUBSCRIBE request according to TS 24.229 [5], IETF RFC 6665 [36]. + +For the duration of the subscription, the MCData server shall notify subscriber about changes of the information of the served MCData ID, as described in clause 22.2.2.3.5. + +#### 22.2.2.3.5 Sending notification of change of functional alias status procedure + +In order to notify the subscriber identified by the handled MCData ID about changes of the functional alias status of the served functional alias ID, the MCData server: + +- 1) shall consider a functional alias information entry such that: + - a) the functional alias information entry is in the list of functional alias information entries described in clause 22.2.2.3.2; and + - b) the functional alias ID of the functional alias information entry is equal to the served functional alias ID; +- 2) shall consider an MCData user information entry such that: + - a) the MCData user information entry is in the list of the MCData user information entries of the served functional alias information entry; and + - b) the MCData ID of the MCData user information entry is equal to the handled MCData ID;as the served MCData user information entry; +- 3) shall generate an application/pidf+xml MIME body indicating per-functional alias information according to clause 22.3.1 and the served list of the served MCData user information entry of the functional alias information entry with following clarifications: + - a) the MCData server shall include the "expires" attribute in the element; and + - b) if this procedure is invoked by procedure in subclause 22.2.2.3.3 where the handled p-id-fa was identified, the MCData server shall set the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request to the handled p-id-fa value; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [5], and IETF RFC 6665 [36] for the subscription created in clause 22.2.2.3.4. In the SIP NOTIFY request, the MCData server shall include the generated application/pidf+xml MIME body indicating per-functional alias information. + +#### 22.2.2.3.6 Functional alias status automatic deactivation procedure + +In order to deactivate a functional alias associated with a target MCData ID: + +- 1) externally triggered by an MCData administrator by a mechanism outside of the scope of the standard; or +- 2) directly by the MCData function owning the functional alias as a result of an internal trigger like the expiration of the functional alias association; + +the MCData server + +- 1) shall consider a functional alias information entry such that: + - a) the functional alias information entry is in the list of functional alias information entries described in clause 22.2.2.3.2; and + - b) the functional alias ID of the functional alias information entry is equal to the served functional alias ID;as the served functional alias information entry; +- 2) shall remove the MCData user information entry such that: + +- a) the MCData user information entry is in the list of the MCData user information entries of the served functional alias information entry; and + - b) the MCData user information entry has the MCData ID set to the target MCData ID; and +- 3) shall perform the procedures specified in subclause 22.2.2.3.5 for the served functional alias ID. + +## 22.3 Coding + +### 22.3.1 Extension of application/pidf+xml MIME type + +#### 22.3.1.1 Introduction + +The clauses of the parent clause describe an extension of the application/pidf+xml MIME body specified in IETF RFC 3863 [40]. The extension is used to indicate: + +- per-user functional alias information; and +- per-functional alias status information. + +#### 22.3.1.2 Syntax + +The application/pidf+xml MIME body indicating per-user functional alias information is constructed according to IETF RFC 3863 [40] and: + +- 1) contains a root element according to IETF RFC 3863 [40]; +- 2) contains an "entity" attribute of the element set to the MCData ID of the MCData user; +- 3) contains one child element according to IETF RFC 3863 [40] per element; +- 4) can contain a child element defined in the XML schema defined in table 22.3.1.2-1, of the element set to an identifier of a SIP PUBLISH request; +- 5) contains an "id" attribute of the element set to the MCData client ID; +- 6) contains one child element of each element; +- 7) contains one child element defined in the XML schema defined in table 22.3.1.2-1, of the element, for each functional alias in which the MCData user is interested; +- 8) contains a "functionalAliasID" attribute of each element set to the functional alias ID of the functional alias in which the MCData user is interested;; +- 9) can contain a "status" attribute of each element indicating the activation status of functional alias for the MCData user; and +- 10) can contain an "expires" attribute of each element indicating expiration of activation of the functional alias for the MCData user. + +The application/pidf+xml MIME body indicating per-functional alias status information is constructed according to IETF RFC 3856 [39] and: + +- 1) contains the root element according to IETF RFC 3863 [40]; +- 2) contains an "entity" attribute of the element set to the functional alias ID of the functional alias; +- 3) contains one child element according to IETF RFC 3863 [40] of the element; +- 4) can contain a child element defined in the XML schema defined in table 22.3.1.2-1, of the element set to an identifier of a SIP PUBLISH request; +- 5) contains an "id" attribute of the element set to the MCData ID; +- 6) contains one child element of each element; + +- 7) contains one child element defined in the XML schema defined in table 22.3.1.2-1, of the element, for each MCData ID for which functional alias information is provided; +- 8) contains one "user" attribute defined in the XML schema defined in table 22.3.1.2-2, of the element set to the MCData client ID; and +- 9) can contain an "expires" attribute defined in the XML schema defined in table 22.3.1.2-2, of the element indicating expiration of activation of the functional alias for the MCData user. + +**Table 22.3.1.2-1: XML schema with elements and attributes extending the application/pidf+xml MIME body** + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +The application/pidf+xml MIME body refers to namespaces using prefixes specified in table 22.3.1.2-2. + +**Table 22.3.1.2-2: Assignment of prefixes to namespace names in the application/pidf+xml MIME body** + +| Prefix | Namespace | +|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| mcdataPIFA10 | urn:3gpp:ns:mcdataPresInfoFA:1.0 | +| NOTE: The "urn:ietf:params:xml:ns:pidf" namespace is the default namespace so no prefix is used for it in the application/pidf+xml MIME body. | | + +## 22.3.2 Extension of application/simple-filter+xml MIME type + +### 22.3.2.1 Introduction + +The subclauses of the parent clause describe an extension of the application/simple-filter+xml MIME body specified in IETF RFC 4661 [41]. + +The extension is used to indicate per-user restrictions of presence event package notification information for functional alias information. + +### 22.3.2.2 Syntax + +The application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information is constructed according to IETF RFC 4661 [41] and: + +- 1) contains a root element according to IETF RFC 4661 [41]; +- 2) contains an child element according to IETF RFC 4661 [41], of the element; +- 3) contains an child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains a "prefix" attribute according to IETF RFC 4661 [41] set to "pidf"; and + - B) contains a "urn" attribute set to the "urn:ietf:params:xml:ns:pidf" value; +- 4) contains a child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains a "prefix" attribute according to IETF RFC 4661 [41], set to "mcdataPIFA10"; and + - B) contains an "urn" attribute according to IETF RFC 4661 [41], set to the "urn:3gpp:ns:mcdataPresInfoFA:1.0" value; +- 5) contains a child element according to IETF RFC 4661 [41], of the element where the element: + - A) contains an "id" attribute set to a value constructed according to IETF RFC 4661 [41]; + - B) does not contain a "uri" attribute of the child element according to IETF RFC 4661 [41]; and + - C) does not contain a "domain" attribute according to IETF RFC 4661 [41]; +- 6) contains a child element according to IETF RFC 4661 [41], of the element; and +- 7) contains an child element according to IETF RFC 4661 [41], of the element where the element: + - A) does not contain a "type" attribute according to IETF RFC 4661 [41]; and + - B) contains the value, according to IETF RFC 4661 [41], set to concatenation of the '//pidf:presence/pidf:tuple[@id="" string, the MCData ID, and the '"]' string. + +--- + +## Annex A (informative): Signalling flows + +--- + +## Annex B (normative): Media feature tags within the current document + +### B.1 General + +This subclause describes the media feature tag definitions that are applicable for the 3GPP IM CN Subsystem for the realisation of the Mission Critical Data (MCData) service. + +--- + +### B.2 Definition of media feature tag for Mission Critical Data (MCData) communications Short Data Service (SDS) + +Media feature tag name: g.3gpp.mcdata.sds + +ASN.1 Identifier: 1.3.6.1.8.2.29 + +Summary of the media feature indicated by this media feature tag: This media feature tag when used in a SIP request or a SIP response indicates that the function sending the SIP message supports Mission Critical Data (MCData) communications Short Data Service (SDS). + +Values appropriate for use with this media feature tag: Boolean + +The media feature tag is intended primarily for use in the following applications, protocols, services, or negotiation mechanisms: This media feature tag is most useful in a communications application, for describing the capabilities of a device, such as a phone or PDA. + +Examples of typical use: Indicating that a mobile phone supports the Mission Critical Data (MCData) communications Short Data Service (SDS). + +Related standards or documents: 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification" + +Security Considerations: Security considerations for this media feature tag are discussed in subclause 11.1 of IETF RFC 3840 [16]. + +--- + +### B.3 Definition of media feature tag for Mission Critical Data (MCData) communications File Distribution (FD) + +Media feature tag name: g.3gpp.mcdata.fd + +ASN.1 Identifier: 1.3.6.1.8.2.30 + +Summary of the media feature indicated by this media feature tag: This media feature tag when used in a SIP request or a SIP response indicates that the function sending the SIP message supports Mission Critical Data (MCData) communications File Distribution (FD). + +Values appropriate for use with this media feature tag: Boolean + +The media feature tag is intended primarily for use in the following applications, protocols, services, or negotiation mechanisms: This media feature tag is most useful in a communications application, for describing the capabilities of a device, such as a phone or PDA. + +Examples of typical use: Indicating that a mobile phone supports the Mission Critical Data (MCData) communications File Distribution (FD). + +Related standards or documents: 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification" + +Security Considerations: Security considerations for this media feature tag are discussed in subclause 11.1 of IETF RFC 3840 [16]. + +--- + +## B.4 Definition of media feature tag for Mission Critical Data (MCData) communications IP Connectivity (IPCONN) + +Media feature tag name: g.3gpp.mcdata.ipconn + +**Editor's Note:** [MONASTERY2, CR 0294R1, C1-221903] It is necessary to obtain and register an ASN.1 Identifier for this media feature tag, + +ASN.1 Identifier: + +Summary of the media feature indicated by this media feature tag: This media feature tag when used in a SIP request or a SIP response indicates that the function sending the SIP message supports Mission Critical Data (MCData) communications IP Connectivity (IPCONN). + +Values appropriate for use with this media feature tag: Boolean + +The media feature tag is intended primarily for use in the following applications, protocols, services, or negotiation mechanisms: This media feature tag is most useful in a communications application, for describing the capabilities of a device, such as a phone or PDA. + +Examples of typical use: Indicating that a mobile phone supports the Mission Critical Data (MCData) communications IP Connectivity (IPCONN). + +Related standards or documents: 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification" + +Security Considerations: Security considerations for this media feature tag are discussed in clause 11.1 of IETF RFC 3840 [16]. + +--- + +## Annex C (normative): ICSI values defined within the current document + +### C.1 General + +This subclause describes the IMS Communications Service Identifier (ICSI) definitions that are applicable for the 3GPP IM CN Subsystem for the realisation of the Mission Critical Data (MCData) service. + +NOTE: The template has been created using the headers of the table in + +--- + +### C.2 Definition of ICSI value for the Mission Critical Data (MCData) service + +#### C.2.1 URN + +urn:urn-7:3gpp-service.ims.icsi.mcdata + +#### C.2.2 Description + +This URN indicates that the device has the capabilities to support the Mission Critical Data (MCData) service. This URN is also used by the device to associate a SIP request with the Mission Critical Data (MCData) service. + +#### C.2.3 Reference + +3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification". + +#### C.2.4 Contact + +Name: Ricky Kaura + +Email: [ricky.kaura@samsung.com](mailto:ricky.kaura@samsung.com) + +#### C.2.5 Registration of subtype + +Yes + +#### C.2.6 Remarks + +This URN is included in the "g.3gpp.icsi-ref" media feature tag in the Contact header field of SIP requests (not SIP MESSAGE) and responses, and the Accept-Contact header fields of non-register SIP requests. + +This URN can be included by the device in the P-Preferred-Service header field of SIP requests, and is asserted by the network into the P-Asserted-Service header field of SIP Requests. + +--- + +### C.3 Definition of ICSI value for the Mission Critical Data (MCData) communications Short Data Service (SDS) + +#### C.3.1 URN + +urn:urn-7:3gpp-service.ims.icsi.mcdata.sds + +## C.3.2 Description + +This URN indicates that the device has the capabilities to support the Mission Critical Data (MCData) Short Data Service (SDS) IMS communication service. This URN is also used by the device to associate a SIP request with the Mission Critical Data (MCData) Short Data Service (SDS) IMS communication service. + +## C.3.3 Reference + +3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification". + +## C.3.4 Contact + +Name: Ricky Kaura + +Email: ricky.kaura@samsung.com + +## C.3.5 Registration of subtype + +Yes + +## C.3.6 Remarks + +This URN is included in the "g.3gpp.icsi-ref" media feature tag in the Contact header field of SIP requests (not SIP MESSAGE) and responses, and the Accept-Contact header fields of non-register SIP requests. + +This URN can be included by the device in the P-Preferred-Service header field of SIP requests, and is asserted by the network into the P-Asserted-Service header field of SIP Requests. + +--- + +# C.4 Definition of ICSI value for Mission Critical Data (MCData) communications File Distribution (FD) + +## C.4.1 URN + +urn:urn-7:3gpp-service.ims.icsi.mcdata.fd + +## C.4.2 Description + +This URN indicates that the device has the capabilities to support the Mission Critical Data (MCData) File Distribution (FD) IMS communication service. This URN is also used by the device to associate a SIP request with the Mission Critical Data (MCData) File Distribution (FD) IMS communication service. + +## C.4.3 Reference + +3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification". + +## C.4.4 Contact + +Name: Ricky Kaura + +Email: ricky.kaura@samsung.com + +## C.4.5 Registration of subtype + +Yes + +## C.4.6 Remarks + +This URN is included in the "g.3gpp.icsi-ref" media feature tag in the Contact header field of SIP requests (not SIP MESSAGE) and responses, and the Accept-Contact header fields of non-register SIP requests. + +This URN can be included by the device in the P-Preferred-Service header field of SIP requests, and is asserted by the network into the P-Asserted-Service header field of SIP Requests. + +--- + +## C.5 Definition of ICSI value for Mission Critical Data (MCData) communications IP Connectivity (IPCONN) + +### C.5.1 URN + +urn:urn-7:3gpp-service.ims.icsi.mcdata.ipconn + +### C.5.2 Description + +This URN indicates that the device has the capabilities to support the Mission Critical Data (MCData) IP Connectivity (IPCONN) IMS communication service. This URN is also used by the device to associate a SIP request with the Mission Critical Data (MCData) IP Connectivity (IPCONN) IMS communication service. + +### C.5.3 Reference + +3GPP TS 24.282: "Mission Critical Data (MCData) signalling control Protocol specification". + +### C.5.4 Contact + +Name: Kiran Kapale + +Email: kiran.kapale@samsung.com + +### C.5.5 Registration of subtype + +Yes + +### C.5.6 Remarks + +This URN is included in the "g.3gpp.icsi-ref" media feature tag in the Contact header field of SIP requests (not SIP MESSAGE) and responses, and the Accept-Contact header fields of non-register SIP requests. + +This URN can be included by the device in the P-Preferred-Service header field of SIP requests, and is asserted by the network into the P-Asserted-Service header field of SIP Requests. + +## Annex D (normative): XML schemas + +### D.1 XML schema for transporting MCData identities and general services information + +#### D.1.1 General + +This subclause defines XML schema and MIME type for transporting MCData identities and general services information. + +#### D.1.2 XML schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## D.1.3 Semantic + +**Editor's note:** In the current release, support for emergency groups and emergency group communications (in particular the use of the element) may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +The element is the root element of the XML document. The element can contain subelements. + +NOTE 1: The subelements of the are validated by the particle of the element + +If the contains the element then: + +- 1) the , , , , , , , , , and elements can be included with encrypted content; +- 2) for each element in 1) that is included with content that is not encrypted: + - a) the element has the "type" attribute set to "Normal"; + - b) if the element is the , , , , or then the element is included; + - c) if the element is the or , then the element is included; and + - d) if the element is or then the element is included; +- 3) for each element in 1) that is included with content that is encrypted: + - a) the element has the "type" attribute set to "Encrypted"; + - b) the element from the "" namespace is included and: + +- i) can have a "Type" attribute can be included with a value of ""; +- ii) can include an element with the "Algorithm" attribute set to value of ""; +- iii) can include a element with a element containing the base 64 encoded XPK-ID; and +- iv) includes a element with a element containing the encrypted data. + +NOTE 2: When the optional attributes and elements are not included within the element, the information they contain is known to sender and the receiver by other means. + +If the contains the element then: + +- 1) the can be included with the access token received during authentication procedure as described in 3GPP TS 24.382 [49]; +- 2) the can be included with: + - a) a value of "one-to-one-sds" to indicate that the MCData client wants to initiate a one-to-one SDS request; + - b) a value of "group-sds" to indicate the MCData client wants to initiate a group SDS request; + - c) a value of "one-to-one-fd" to indicate that the MCData client wants to initiate a one-to-one FD request; + - d) a value of "group-fd" to indicate that the MCData client wants to initiate a group FD request; + - e) a value of "msf-disc-req" to indicate that the MCData client wishes to discover the absoluteURI of the media storage function for HTTP requests; + - f) a value of "msf-disc-res" when the participating MCData function sends the absolute URI to the MCData client; + - g) a value of "notify" when the controlling MCData function needs to send a notification to the MCData client; + - h) a value of "one-to-one-sds-session" to indicate that the MCData client wants to initiate a one-to-one SDS session; + - i) a value of "group-sds-session" to indicate the MCData client wants to initiate a group SDS session; or + - j) a value of "functional-alias-status-determination" when a client initiates a subscription request to FA status; +- 3) the can be included with an MCData group ID; +- 4) the can be included, set to MCData ID of the originating user; +- 5) the can be included, set to the MCData ID of the terminating user; +- 6) the can be included to indicate the MCData group identity to the terminating user; +- 7) the <>alert-ind> can be: + - a) set to "true" to indicate that an alert to be sent; or + - b) set to "false" to indicate that an alert to is be cancelled; +- 8) the can be included, set to the MCData ID of the originating user of an MCData emergency alert when being cancelled by another authorised MCDATA user; +- 9) the can be included, set to the MCData client ID of the MCData client that originated a SIP INVITE request, SIP REFER request, SIP REGISTER request, SIP PUBLISH request or SIP MESSAGE request; and +- 10) the can be included, set to the PSI of the controlling MCData function that handled the one-to-one or group MCData data request; and + +11) the can be included with the following elements: + +- a) a element: + - i) set to the value "true" by the MCData client in a pre-established session setup request to indicate to the MCData participating function about initiation of a pre-established session. +- b) an element can be included to indicate state of MCData communication within pre-established session. The can be set to: + - i) the value "establish-request" by the MCData participating function to indicate to the MCData client about an MCData communication establishment request within pre-established session; + - ii) the value "establish-success" by the MCData participating function or MCData client to indicate that the MCData communication is established successfully; + - iii) the value "establish-fail" by the MCData participating function or the MCData client to indicate that the MCData communication establishment is failed or rejected; + - iv) the value "terminate-request" by the MCData participating function to indicate to the MCData client about an MCData communication termination request within a pre-established session; and + - v) the value "terminated" by the MCData participating function or the MCData client to indicate that the MCData communication is terminated. +- c) an element can be included and set to: + - i) "true" to indicate that the communication that the MCData client is initiating is an emergency MCData communication; or + - ii) "false" to indicate that the MCData client is cancelling an emergency MCData communication (i.e. converting it back to a non-emergency communication); +- d) an <>alert-ind-rcvd> element: + - i) may be set to "true" and included in a SIP MESSAGE to indicate that the emergency alert or cancellation was received successfully; +- e) an element may be: + - i) set to the MCData user's Mission Critical Organization and included in an emergency alert sent by the MCData server to terminating MCData clients; +- f) a element set to the value of the functional alias that is used together with the "mcdata-calling-user-id"; and +- g) a element can be included and set to: + - i) "true" to indicate to the client that multiple clients are registered for the MCData user; or + - ii) "false" to indicate to the client that no other clients are registered for the MCData user. + +The recipient of the XML ignores any unknown element and any unknown attribute. + +## D.1.4 IANA registration template + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.mcdatinfo+xml + +Required parameters: + +None + +Optional parameters: + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303. + +Encoding considerations: + +binary. + +Security considerations: + +Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. In addition, this media type provides a format for exchanging information in SIP, so the security considerations from IETF RFC 3261 apply. + +The information transported in this media type does not include active or executable content. + +Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +Same as general interoperability considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. Any unknown XML elements and any unknown XML attributes are to be ignored by recipient of the MIME body. + +Published specification: + +3GPP TS 24.282 "Mission Critical Data (MCData) signalling control;Protocol specification", available via . + +Applications Usage: + +Applications supporting the mission critical data communications procedures as described in the published specification. + +Fragment identifier considerations: + +The handling in section 5 of IETF RFC 7303 applies. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## D.2 Void + +## D.3 XML schema for MCData (de)-affiliation requests + +### D.3.1 General + +This subclause defines XML schema and MIME type for MCData (de)-affiliation requests. + +### D.3.2 XML schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + +``` + +### D.3.3 Semantic + +The element is the root element of the XML document. The element may contain , or subelements or both. + +If the contains the element then: + +- 1) the element contains a list of subelements having at least one subelement. The recipient shall perform an affiliation for all the MCData groups contained in the list for the clients for which the applies. + +If the contains the element then: + +- 1) the element contains a list of subelements having at least one subelement. The recipient shall perform a de-affiliation for all the MCData groups contained in the list for the clients for which the applies. + +The recipient of the XML ignores any unknown element and any unknown attribute. + +### D.3.4 IANA registration template + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.mcdata-affiliation-command+xml + +Required parameters: + +None + +Optional parameters: + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303. + +Encoding considerations: + +binary. + +Security considerations: + +Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. In addition, this media type provides a format for exchanging information in SIP, so the security considerations from IETF RFC 3261 apply. + +The information transported in this media type does not include active or executable content. + +Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +Same as general interoperability considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. Any unknown XML elements and any unknown XML attributes are to be ignored by recipient of the MIME body. + +Published specification: + +3GPP TS 24.282 "Mission Critical Data (MCData) signalling control" version 14.0.0, available via . + +Applications which use this media type: + +Applications supporting the mission critical data functions as described in the published specification. + +Fragment identifier considerations: + +The handling in section 5 of IETF RFC 7303 applies. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## D.4 XML schema for MCData location information + +### D.4.1 General + +This subclause defines the XML schema and the MIME type for location information. + +### D.4.2 XML schema + +``` + + + + + + + + Root element, contains all information related to location configuration, + location request and location reporting for the MCData service + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + +``` + +## D.4.3 Semantic + +The element is the root element of the XML document. The element contains the , and subelements, of which only one can be present. + + element has a attribute that can assume the values "Full" and "Update". The value "Full" means that the Configuration element contains the full location configuration which replaces any previous location configuration. The value "Update" means that the location configuration is in addition to any previous location configuration. To remove configuration elements a "Full" configuration is needed. The element contains the following child elements: + +- 1) , an optional element that specifies the location information requested in non-emergency situations. The has the subelements: + - a) , an optional element specifying that the serving E-UTRAN Cell Global Identity (ECGI) needs to be reported; + - b) , an optional element that can occur multiple times, specifying that neighbouring ECGIs need to be reported; + - c) , an optional element specifying that the serving MBMS Service Area Id needs to be reported; + - d) , an optional element specifying that the MBSFN area Id needs to be reported; + - e) , an optional element specifying that the geographical coordinate specified in subclause 6.1 in 3GPP TS 23.032 [47] needs to be reported; and + - f) , a mandatory element specifying the minimum time the MCData client needs to wait between sending location reports. The value is given in seconds; +- 2) , an optional element that specifies the location information requested in emergency situations. The has the subelements: + - a) , an optional element specifying that the serving ECGI needs to be reported; + - b) , an optional element that can occur multiple times, specifying that neighbouring ECGIs need to be reported; + - c) , an optional element specifying that the serving MBMS Service Area Id needs to be reported; + - d) , an optional element specifying that the MBSFN area Id needs to be reported; + - e) , an optional element specifying that the geographical coordinate specified in subclause 6.1 in 3GPP TS 23.032 [47] needs to be reported; and + - f) , a mandatory element specifying the minimum time the MCData client needs to wait between sending location reports. The value is given in seconds; and +- 3) , a mandatory element specifying the triggers for the MCData client to perform reporting in non emergency status. The element contains the following sub-elements: + - a) , an optional element specifying what cell changes trigger location reporting. Consists of the following sub-elements: + - I) , an optional element. The presence of this element specifies that any cell change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + +- II) , an optional element specifying an ECGI which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - III) , an optional element specifying an ECGI which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; +- b) , an optional element specifying what tracking area changes trigger location reporting. Consists of the following sub-elements: + - I) , an optional element. The presence of this element specifies that any tracking area change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying a Tracking Area Id which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - III) , an optional element specifying a Tracking Area Id which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - c) , an optional element specifying what PLMN changes trigger location reporting. Consists of the following sub-elements: + - I) , an optional element. The presence of this element specifies that any PLMN change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying a PLMN Id which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - III) , an optional element specifying a PLMN Id which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - d) , an optional element specifying what MBMS changes trigger location reporting. Consists of the following sub-elements: + - I) , an optional element. The presence of this element specifies that any MBMS SA change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying an MBMS Service Area Id which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - III) , an optional element specifying an MBMS Service Area Id which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - e) , an optional element specifying what MBSFN changes trigger location reporting. Consists of the following sub-elements: + - I) , an optional element. The presence of this element specifies that any MBSFN area change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying an MBSFN area which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - III) , an optional element specifying an MBSFN area which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - f) , an optional element specifying that periodic location reports shall be sent. The value in seconds specifies the reporting interval. Contains a mandatory attribute that shall be set to a unique string; + - g) , an optional element specifying that the travelled distance shall trigger a report. The value in metres specified the travelled distance. Contains a mandatory attribute that shall be set to a unique string; + +- h) , an optional element specifying what signalling events triggers a location report. The element has the following sub-elements: + - I) , an optional element specifying that an initial log on triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying that a non-emergency group call triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - III) , an optional element specifying that a non-emergency private call triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - IV) , an optional element specifying that a received location configuration triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and +- i) , an optional element specifying what geographical area changes trigger location reporting. Consists of the following sub-elements: + - I) , an optional element. The presence of this element specifies that any geographical area change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying a geographical area which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string. The element has the following sub-elements: + - A) , an optional element containing a attribute and the following two subelements: + - x1) , an optional element specifying the area as a polygon specified in subclause 5.2 in 3GPP TS 23.032 [47]; and + - x2) , an optional element specifying the area as an Ellipsoid Arc specified in subclause 5.7 in 3GPP TS 23.032 [47]; and + - III) , an optional element specifying a geographical area which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string. +- 4) the shall be included with the following element not declared in the XML schema: + - a) , a mandatory element specifying the triggers for the MCData client to perform reporting in emergency status. The element contains the following sub-elements: + - I) , an optional element specifying what cell changes trigger location reporting. Consists of the following sub-elements: + - A) , an optional element. The presence of this element specifies that any cell change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying an ECGI which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - C) , an optional element specifying an ECGI which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - II) , an optional element specifying what tracking area changes trigger location reporting. Consists of the following sub-elements: + - A) , an optional element. The presence of this element specifies that any tracking area change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying a Tracking Area Id which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + +- C) , an optional element specifying a Tracking Area Id which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; +- III) , an optional element specifying what PLMN changes trigger location reporting. Consists of the following sub-elements: + - A) , an optional element. The presence of this element specifies that any PLMN change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying a PLMN Id which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - C) , an optional element specifying a PLMN Id which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - IV) , an optional element specifying what MBMS changes trigger location reporting. Consists of the following sub-elements: + - A) , an optional element. The presence of this element specifies that any MBMS SA change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying an MBMS Service Area Id which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - C) , an optional element specifying an MBMS Service Area Id which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - V) , an optional element specifying what MBSFN changes trigger location reporting. Consists of the following sub-elements: + - A) , an optional element. The presence of this element specifies that any MBSFN area change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying an MBSFN area which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + - C) , an optional element specifying an MBSFN area which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - VI) , an optional element specifying that periodic location reports shall be sent. The value in seconds specifies the reporting interval. Contains a mandatory attribute that shall be set to a unique string; + - VII) , an optional element specifying that the travelled distance shall trigger a report. The value in metres specified the travelled distance. Contains a mandatory attribute that shall be set to a unique string; + - VIII) , an optional element specifying what signalling events triggers a location report. The element has the following sub-elements: + - A) , an optional element specifying that an initial log on triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying that a non-emergency group call triggers a location report. Contains a mandatory attribute that shall be set to a unique string; + - C) , an optional element specifying that a non-emergency private call triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and + +- D) , an optional element specifying that a received location configuration triggers a location report. Contains a mandatory attribute that shall be set to a unique string; and +- IX) , an optional element specifying what geographical area changes trigger location reporting. Consists of the following sub-elements: +- A) , an optional element. The presence of this element specifies that any geographical area change is a trigger. Contains a mandatory attribute that shall be set to a unique string; + - B) , an optional element specifying a geographical area which when entered triggers a location report. Contains a mandatory attribute that shall be set to a unique string. The element has the following sub-elements: + - x1) , an optional element containing a attribute and the following two subelements: + - i1) , an optional element specifying the area as a polygon specified in subclause 5.2 in 3GPP TS 23.032 [47]; and + - i2) , an optional element specifying the area as an Ellipsoid Arc specified in subclause 5.7 in 3GPP TS 23.032 [47]; and + - C) , an optional element specifying a geographical area which when exited triggers a location report. Contains a mandatory attribute that shall be set to a unique string. + + is an element with a attribute. The element is used to request a location report. The value of the attribute is returned in the corresponding attribute in order to correlate the request and the report. + + is an element used to include the location report. It contains a attribute and a attribute. The attribute is used to return the value in the attribute in the element. The attribute has two values "Emergency" and "NonEmergency" used to inform whether the client is sending the report in an emergency situation or not. The element contains the following sub-elements: + +- 1) , an optional element which can occur multiple times that contain the value of the attribute associated with a trigger that has fired; and +- 2) , a mandatory element that contains the location information. The element contains the following sub-elements: + - a) , an optional element containing the ECGI of the serving cell; + - b) , an optional element that can occur multiple times. It contains the ECGI of any neighbouring cell the MCData client can detect; + - c) , an optional element containing the MBMS Service Area Id the MCData client is using; + - d) , an optional element containing the MBSFN area the MCData is located in; and + - e) , an optional element containing the longitude and latitude coded as in subclause 6.1 in 3GPP TS 23.032 [47]. + +The contents of the subelements in the subelement of the element can be encrypted. The following rules are applied when any of these elements are included: + +- 1) if confidentiality protection is not required, then: + - a) the "type" attributes associated with the , , , and elements of the element have the value "Normal" and + - ii) the subelement of the element contains the unencrypted value of the ECGI of the serving cell; + +- iii) the subelement of the element contains the unencrypted value of the ECGI of any neighbouring cell; + - iv) the subelement of the element contains the unencrypted value of the MBMS Service Area Id the MCData client is using; and + - v) the subelement of the , element contains the unencrypted value of the MBSFN area the MCData is located in; +- b) the "type" attributes associated with the and subelements of the element have the value "Normal" and the subelements of and subelements contain the unencrypted value of longitude and latitude. +- 2) if confidentiality protection is required, then: + - a) the "type" attributes associated with the , , , and elements have the value "Encrypted"; + - b) the "type" attributes associated with the and subelements of the element have the value "Encrypted"; + - c) for each of the elements described in 2a) and subelements described in 2b) above, the element from the "" namespace is included and: + - i) can have a "Type" attribute can be included with a value of ""; + - ii) can include an element with the "Algorithm" attribute set to value of ""; + - iii) can include a element with a element containing the base 64 encoded XPK-ID; and + - iv) includes a element with a element containing the encrypted data. + +NOTE: When the optional attributes and elements are not included within the element, the information they contain is known to sender and the receiver by other means. + +The recipient of the XML ignores any unknown element and any unknown attribute. + +## D.4.4 IANA registration template + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.mcdata-location-info+xml + +Required parameters: + +None + +Optional parameters: + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303. + +Encoding considerations: + +binary. + +Security considerations: + +Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. In addition, this media type provides a format for exchanging information in SIP, so the security considerations from IETF RFC 3261 apply. + +The information transported in this media type does not include active or executable content. + +Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +Same as general interoperability considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. Any unknown XML elements and any unknown XML attributes are to be ignored by recipient of the MIME body. + +Published specification: + +3GPP TS 24.282 "Mission Critical Data (MCData) signalling control; Protocol specification", available via . + +Applications which use this media type: + +Applications supporting the mission critical data as described in the published specification. + +Fragment identifier considerations: + +The handling in section 5 of IETF RFC 7303 applies. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## D.5 XML schema for MBMS usage information + +### D.5.1 General + +This subclause defines XML schema and MIME type for application/vnd.3gpp.mcdata-mbms-usage-info+xml. + +### D.5.2 XML schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## D.5.3 Semantic + +The `` element is the root element of the XML document. The `` element contains the subelements: + +1) `` containing the following elements: + +a) `` element contains a string used to indicate the MCData listening status: + +- The value "listening" indicates that the MCData client now is receiving RTP media packets and/or RTCP control packets over the MBMS subchannel in the session identified by the `` element or if the `` element is set to "true", that the MCData client is now listening to the general purpose MBMS subchannel. + +- The value "not-listening" indicates that the MCData client has stopped listening to the MBMS subchannel in the session identified by the element or, if the element is set to "false", that the MCData client no longer listens to the general purpose MBMS subchannel. + +Table D.5.3-1 shows the ABNF of the element. + +**Table D.5.3-1: ABNF syntax of values of the element** + +``` + +mbms-listening-status = listening-value / not-listening-value +listening-value = %x6c.69.73.74.65.6e.69.6e.67 ; "listening" +not-listening-value = %x6e.6f.74.2d.6c.69.73.74.65.6e.69.6e.67 ; "not-listening" + +``` + +- b) element contains the value of the URI received in the Contact header field received from the controlling MCData function when an on-demand session was established, or from the participating MCData function in the Connect message when the session was established over a pre-established session. This element is mandatory if the element is not present in the application/vnd.3gpp.mcdata-mbms-usage-info+xml MIME body. + +- c) element is a boolean with the following meaning: + +- True indicates that the MCData client is listening to the general purpose MBMS subchannel associated to the TMGI(s) in the element(s) but have not yet received a Map Group To bearer message for any session that the MCData client is involved in. +- False indicates that the MCData client is not listening to the general purpose MBMS subchannel any longer. + +Absence of the element requires that the element is present in the application/vnd.3gpp.mcdata-mbms-usage-info+xml; and + +- d) : element contains the TMGI. The element is coded as described in 3GPP TS 24.008 [62] subclause 10.5.6.13 excluding the Temporary Mobile Group Identity IEI and Length of Temporary Mobile Group Identity contents (octet 1 and octet 2 in 3GPP TS 24.008 [62] subclause 10.5.6.13). + +- 2) : contains the following subelements: + +- a) : element is a string used to indicate the MBMS bearers intended suspension status: + +- The value "suspending" indicates that the RAN has decided to suspend the referenced MBMS bearer(s) at the beginning of the next MCCH modification period. +- The value "not-suspending" indicates that the RAN has decided to revoke its decision to suspend the referenced MBMS bearer(s) before the beginning of the next MCCH modification period. + +Table D.5.3-2 shows the ABNF of the element. + +**Table D.5.3-2: ABNF syntax of values of the element** + +``` + +mbms-suspension-status = suspending-value / not-suspending-value +suspending-value = %x73.75.73.70.65.6e.64.69.6e.67 ; "suspending" +not-suspending-value = %x6e.6f.74.2d.73.75.73.70.65.6e.64.69.6e.67 ; "not-suspending" + +``` + +- b) : a hex binary number denoting the total number of occurrences of the and elements reported as part of the MBMS bearer suspension status; +- c) : contains a TMGI that is being reported as about to be suspended or as no longer about to be suspended; and +- d) : contains a TMGI that is not being reported as about to be suspended or as no longer about to be suspended, but which shares the same MCH with MBMS bearers reported in the elements; + +- 3) element containing the following elements: + +- a) : contains the TMGI. The element is coded as described in 3GPP TS 24.008 [62] subclause 10.5.6.13 excluding the Temporary Mobile Group Identity IEI and Length of Temporary Mobile Group Identity contents (octet 1 and octet 2 in 3GPP TS 24.008 [62] subclause 10.5.6.13); +- b) : element contains QCI information used by the ProSe UE-Network Relay to determine the ProSe Per-Packet Priority value to be applied for the multicast packets relayed to Remote UE over PC5. QCI values are defined in 3GPP TS 23.203 [63]; +- c) : element containing identification of frequency in case of multi carrier support. The element is coded as specified in 3GPP TS 29.468 [57]; + +NOTE 1: In the current release the frequency in the element is the same as the frequency used for unicast. + +- d) : element is a list of MBMS service area IDs for the applicable MBMS broadcast area as specified in 3GPP TS 23.003 [31] for Service Area Identifier (SAI), and with the encoding as specified in 3GPP TS 29.061 [64] for the MBMS-Service-Area AVP; + - e) : element is a positive integer that gives the number of the media line containing the general purpose MBMS subchannel in the application/sdp MIME body attached to the SIP MESSAGE request containing the MBMS announcements; + - f) : element is a boolean with the following meaning: + - True indicates that the MCData client is instructed to notify the MCData server when it becomes aware of an intended change in the suspension status of a listened MBMS bearer. + - False indicates that the MCData client is instructed not to notify the MCData server if it becomes aware of an intended change in the suspension status of a listened MBMS bearer ; and + - g) element can contain the following elements not shown in the XML schema: + - i) element: presence of the element indicates that the flows delivered by the announced MBMS bearer are header compressed with ROHC as specified in RFC 5795 [60] and RFC 3095 [61]; and + - ii) element: of type integer restricted to the range 1 to 16383 indicating the maximum CID value that can be used by the header compressor, see subclause 5.1.2 in RFC 5795 [60]. If max-cid > 15 then the header compressor uses the large CID representation. Else, the header compressor uses the small CID representation; +- 4) is an element of type "xs:integer" indicating the version of the application/vnd.3gpp.mbms-usage-info MIME body. In this version the indicates "1"; and +- 5) element can contain the following elements: +- a) that can contain: + - i) a element containing the identity, in the form of a URI, of a group for which the MuSiK download is performed; and + - b) that can contain: + - i) a element containing the identity, in the form of a URI, of a group for which the MuSiK download is performed. + +The recipient of the XML ignores any unknown element and any unknown attribute. + +## D.5.4 IANA registration template + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.mcdat-mbms-usage-info+xml + +Required parameters: + +None + +Optional parameters: + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303. + +Encoding considerations: + +binary. + +Security considerations: + +Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. In addition, this media type provides a format for exchanging information in SIP, so the security considerations from IETF RFC 3261 apply. + +The information transported in this media type does not include active or executable content. + +Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +Same as general interoperability considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. Any unknown XML elements and any unknown XML attributes are to be ignored by recipient of the MIME body. + +Published specification: + +3GPP TS 24.379 "Mission Critical Push To Talk (MCData) call control" version 13.0.0, available via . + +Applications which use this media type: + +Applications supporting the mission critical push to talk as described in the published specification. + +Fragment identifier considerations: + +The handling in section 5 of IETF RFC 7303 applies. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +## Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +## Intended usage: + +Common + +## Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## Annex E (normative): IANA registration forms + +### E.1 MIME type for transporting MCData signalling content + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.mcdata-signalling + +Required parameters: + +None + +Optional parameters: + +None + +Encoding considerations: + +binary. + +Security considerations: + +General mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +Security mechanisms specific to this MIME type are dependent upon the business and trust relationship between the mission critical data communications (MCData) operator and the SIP carrier operator. MCData operators may wish to encrypt and integrity protect the content transported by this MIME type independently of mechanisms provided by the transport layer. Such mechanisms are being specified in Rel-14 by 3GPP SA3. Security mechanisms applied to MCData signalling content is point-to-point (UE to server, server to server, server to UE). + +The information transported in this media type does not include active or executable content. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +The content transported within this MIME type needs to be interpreted by a server as specific decisions are made based on the signalling content (e.g. store disposition history). The final destination point of the content is the terminating UE. Each UE and server that handles the content transported using this MIME type shall understand the definition of the messages and protocol elements as defined in 3GPP TS 24.282. Any messages and protocol elements not defined by 3GPP TS 24.282 shall be ignored by the recipient UE or server. + +Published specification: + +3GPP TS 24.282 "Mission Critical Data (MCData) signalling control; Protocol specification", available via . + +Application Usage: + +Applications supporting the mission critical data communications procedures as described in the published specification. This MIME type shall contain signalling content that is related to the payload that is delivered to a terminating user or an application of the terminating user. + +Fragment identifier considerations: + +None. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +--- + +## E.2 MIME type for transporting MCData payload content + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.mcdatapayload + +Required parameters: + +None + +Optional parameters: + +None + +Encoding considerations: + +binary. + +Security considerations: + +General mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +Security mechanisms specific to this MIME type are dependent upon the business and trust relationship between the mission critical data communications (MCData) operator and the SIP carrier operator. MCData operators may wish to encrypt and integrity protect the content transported by this MIME type independently of mechanisms provided by the transport layer. Such mechanisms are being specified in Rel-14 by 3GPP SA3. Security mechanisms applied to MCData payload are end-to-end (UE to UE). + +The information transported in this media type does not include active or executable content. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +The content transported within MIME type does not need to be interpreted by a server. It represents the payload that is delivered to the end-user or an application of the end-user. Each UE and server that handles the content transported using this MIME type shall understand the definition of the messages and protocol elements as defined in 3GPP TS 24.282. Any messages and protocol elements not defined by 3GPP TS 24.282 shall be ignored by the recipient UE or server. + +Published specification: + +3GPP TS 24.282 "Mission Critical Data (MCData) signalling control; Protocol specification" available via . + +Application Usage: + +Applications supporting the mission critical data communications procedures as described in the published specification. This MIME type shall contain data that is delivered to a terminating user or an application of the terminating user. + +Fragment identifier considerations: + +None. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## Annex F (normative): Timers + +### F.1 General + +The following tables give a brief description of the timers used in the present document. + +For the on-network timers described in the present document, the following timer families are used: + +- TDPx: Timer Data Participating function x; and +- TDCy: Timer Data Controlling function y. + +For the off-network timers described in the present document, the following timer families are used: + +- TFSz: Timer oFf-network SDS z; + +where x, y and z represent numbers. + +### F.2 On-network timers + +#### F.2.1 Timers in the participating MCData function + +**Table F.2.1-1: Participating MCData function timers** + +| Timer | Timer value | Cause of start | Normal stop | On expiry | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| TDP1 (SDS re-delivery timer) (NOTE) | Default value:
60 seconds

Configurable. | On reception of a "SIP MESSAGE request for SDS disposition notification for MCData server" containing an SDS disposition notification type set to a value of "UNDELIVERED", | On reception of a "SIP MESSAGE request for SDS disposition notification for MCData server" containing an SDS disposition notification type set to a value of "DELIVERED", "READ" or "DELIVERED AND READ" | Re-deliver the SDS message to the MCData user. | +| NOTE: More than one instance of this timer can be running in the participating MCData function, each instance associated with a specific SDS message. | | | | | + +## F.2.2 Timers in the controlling MCData function + +**Table F.2.2-1: Controlling MCData function timers** + +| Timer | Timer value | Cause of start | Normal stop | On expiry | +|------------------------------------------------------|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| TDC1
(disposition notification timer)
(NOTE 1) | Default value: 5 seconds

Configurable. | On reception of a "SIP MESSAGE request for SDS disposition notification for MCData server" from a group member and aggregation of dispositions is required. | On reception of a "SIP MESSAGE request for SDS disposition notification for MCData server" from a group member where aggregation of disposition notifications is required and all other disposition notifications have been received from all other group members | Send the aggregated disposition notifications to the MCData user. | +| TDC2 (file availability timer)
(NOTE 2) | (NOTE 3) | On reception of an FD request using HTTP or using media plane. | On reception of a "SIP MESSAGE request for FD disposition notification for MCData server" from all the invited member(s) and the FD disposition notification type IE is set to "FILE DOWNLOAD REQUEST REJECTED" | Recipients are informed that the file is not available to download any longer as specified in subclause 12.4.2.1 | +| TDC3
(request for extension) | Default value: 15 seconds

Configurable. | Upon receiving SIP 200 (OK) from MCData client for the SIP INFO / SIP MESSAGE message sent as intent to release communication | Upon receiving request for extension of MCData communication from MCData client. | Release the MCData communication immediately. | + +NOTE 1: More than one instance of this timer can be running in the controlling MCData function, each instance associated with a specific group SDS message. + +NOTE 2: More than one instance of this timer can be running in the controlling MCData function associated with each file. Each timer for the file is associated uniquely to a Conversation ID and Message ID. + +NOTE 3: An FD request can contain metadata with "file availability" information. If the FD request contains "file availability", then the controlling MCData function uses this information to derive the timer value. If the FD request does not contain "file availability" information, then the controlling MCData function sets a value for the timer based upon local policy. + +## F.2.3 Timers in the MCData UE + +**Table F.2.3-1: MCData UE timers** + +| Timer | Timer value | Cause of start | Normal stop | On expiry | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TDU1 (delivery and read) (NOTE) | Default value:
120 milliseconds

Configurable. | When the client receives a SDS message with Disposition request type IE set to "DELIVERY AND READ". | When a SDS message display indication is received. | Send a SDS notification with Disposition type IE set to "DELIVERED" and when the MCData client has displayed the message to the MCData user, send a SDS notification with Disposition type IE set to "READ" | +| TDU2 (FD non-mandatory download timer) (NOTE) | Default value:
60 seconds

Configurable. | On reception of an FD request not indicating mandatory download as specified in subclause 10.2.1.2.3 | When the MCData user performs the action to accept, reject or defer the FD request as specified in subclause 10.2.1.2.3 | No specific action by the MCData UE. | +| NOTE: Value of timer TDU1 (delivery and read) should be configured such that, when a consolidated "DELIVERED AND READ" notification is not feasible, the MCData client is able to send the "DELIVERED" disposition notification without delay. | | | | | + +## F.3 Off-network timers + +### F.3.1 Timers in off-network SDS + +The table F.3.1-1 lists the timers used in off-network SDS, their start values, their limits, describes the cause of the start, and the action to take on normal stop and on expiry. + +**Table F.3.1-1: Timers in off-network SDS** + +| Timer | Timer value | Cause of start | Normal stop | On expiry | +|----------------------------------------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TFS1 (SDS message retransmission) | Default value: 40 millisecond
Configurable. | When the client sends a SDS OFF-NETWORK MESSAGE message. | Associated counter CFS1 (SDS message retransmission) reaches upper limit | Send a SDS OFF-NETWORK MESSAGE message. | +| TFS2 (SDS notification retransmission) | Default value: 40 millisecond
Configurable. | When the client sends a SDS OFF-NETWORK NOTIFICATION message. | Associated counter CFS2 (SDS notification retransmission) reaches upper limit | Send a SDS OFF-NETWORK NOTIFICATION message. | +| TFS3 (delivery and read) | Default value: 120 millisecond
Configurable. | When the client receives a SDS OFF-NETWORK MESSAGE with Disposition request type IE set to "DELIVERY AND READ". | When a SDS message display indication is received. | Send a SDS OFF-NETWORK NOTIFICATION message with Disposition type IE set to "DELIVERED" and when the MCData client has displayed the message to the MCData user, send a SDS OFF-NETWORK NOTIFICATION message with Disposition type IE set to "READ" | + +NOTE: Value of timer TFS3 (delivery and read) should be configured such that, when a consolidated "DELIVERED AND READ" notification is not feasible, the MCData client is able to send the "DELIVERED" disposition notification without delay. + +## F.3.2 Timers in off-network emergency alert + +The table F.3.2-1 lists the timers used in off-network emergency alert, their start values, their limits, describes the cause of start, and the action to take on normal stop and on expiry. + +**Table F.3.2-1: Timers in off-network emergency alert** + +| Timer | Timer value | Cause of start | Normal stop | On expiry | +|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|--------------------------------------------------------|-------------------------------------------------------------------------------| +| TFE1
(Emergency Alert) | Default value: 30 seconds
Maximum value: 60 seconds

Configurable.

Set to the value of
"//OffNetwork/Timers/TFE1"
leaf node present in the UE
initial configuration as specified
in 3GPP TS 24.483 [4]. | Receipt of GROUP
EMERGENCY ALERT. | Receipt of GROUP
EMERGENCY
ALERT CANCEL. | Assume end of
emergency state,
remove associated
user from the list. | +| TFE2
(emergency
alert
retransmission) | Default value: 5 seconds
Maximum value: 10 seconds

Configurable.

Set to the value of
"//OffNetwork/Timers/TFE2"
leaf node present in the UE
initial configuration as specified
in 3GPP TS 24.483 [4]. | Transmission of
GROUP
EMERGENCY ALERT. | Transmission of
GROUP
EMERGENCY
ALERT CANCEL. | Transmit GROUP
EMERGENCY
ALERT. | + +## Annex G (normative): Counters and states + +### G.1 General + +The following tables give a brief description of counters and states used in the present document. + +### G.2 On-network counters + +None defined. + +### G.3 Off-network counters + +#### G.3.1 Counters in off-network SDS + +The table G.3.1-1 lists the counters used in off-network SDS, their default upper limits and the action to take upon reaching the upper limit. The counters start at 1. + +**Table G.3.1-1: Counters in off-network SDS** + +| Counter | Upper Limit | Associated timer | Upon reaching the upper limit | +|-----------------------------------------|-----------------------------------|------------------|-------------------------------| +| CFS1 (SDS message retransmission ) | Default value: 5
Configurable. | TFS1 | Stop timer TFS1. | +| CFS2 (SDS notification retransmission ) | Default value: 5
Configurable. | TFS2 | Stop timer TFS2. | + +### G.4 On-network emergency related states + +#### G.4.1 MCData emergency alert state + +Table G.4.1-1 provides the semantics of the MCData emergency alert (MDEA) state values. This is an internal state of the MCData client and is managed by the MCData client. These state values aid in the managing of the information elements of MCData emergency alerts and their cancellations. + +**Table G.4.1-1: MCData emergency alert state** + +| MCData emergency alert state values | State-entering events | Comments | +|-----------------------------------------|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| MDEA 1: no-alert | initial state
emergency alert cancelled
emergency alert request denied | emergency alerts can be cancelled via requests with set to "false" (by initiator or by authorised user) | +| MDEA 2: emergency-alert-confirm-pending | emergency alert request sent | emergency alerts can be requested using set to "true" | +| MDEA 3: emergency-alert-initiated | emergency alert response (success) received | | +| MDEA 4: emergency-alert-cancel-pending | emergency alert cancellation request sent by alert originator | | + +Editor's Note: [CR 0066, WI eMCData2] The text above needs to be revisited/revised if Stage 2 changes to include MCData emergency communications group or MCData emergency state. + +## G.4.2 MCData emergency state + +The MCData emergency state is managed by the MCData client and MCData user. High-level characteristics of this state are captured in table G.4.2-1. + +**Table G.4.2-1: MCData emergency state** + +| MCData emergency state | State-setting events | State-clearing events | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Values:

"set": MCData user is in a life-threatening situation

"clear": MCData user is not in a life-threatening situation

Managed by:
MCData client and MCData user | MCData emergency alert initiated

MCData emergency communication initiated | MCData emergency alert cancelled (by initiator)

MCData emergency alert cancelled (by authorised-user)

MCData emergency communication cancelled by initiator (if there is no outstanding MCData emergency alert)

MCData user manually clears the state | While the MCData client is in the MCData emergency state, all group communications it makes will be MCData emergency group communications, providing the group is authorised for MCData emergency group communications. While in an emergency group communication while in the MCData emergency state, the MCData user is an emergency participant and will have pre-emptive priority over non-emergency participants in the emergency group communication. | + +## G.4.3 In-progress emergency group state + +Editor's note: In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +This state conforms with TS 23.282 [2]. It is managed by the controlling MCData function. High-level characteristics of this state are captured in table G.4.3-1. + +**Table G.4.3-1: in-progress emergency group state** + +| In-progress emergency group state values | State-entering events | Comments | +|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| "true" | acceptance by the controlling MCData function of an MCData emergency group communication request. | | +| "false" | initial state prior to any communication activity

acceptance by the controlling MCData function of an MCData emergency group cancel request. | | + +## G.4.4 MCData emergency group state + +Editor's note: In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +The MCData emergency group state is the MCData client's perspective of the in-progress emergency group state which is managed by the controlling MCData function. The MCData emergency group (MDEG) state is managed by the MCData client to enable the requesting of MCData emergency-level priority as early as possible in the origination of an MCData emergency group communication. High-level characteristics of this state are captured in table G.4.4-1. + +**Table G.4.4-1: MCData emergency group state** + +| MCData emergency group state values | State-entering events | Comments | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MDEG 1: no-emergency | initial state prior to any communication activity

Emergency group communication cancel request received on behalf of another user from the MCData server

Emergency group communication cancel response (success) in response to initiator's request | | +| MDEG 2: in-progress | Emergency group communication response received (confirm) to initiator's emergency group communication request

Emergency group communication request received (on behalf of another user) | In this state, all participants in communications on this group will receive emergency level priority whether or not they are in the MCData emergency state themselves. | +| MDEG 3: cancel-pending | Emergency group communication cancel request sent by initiator | The controlling MCData server may not grant the cancel request for various reasons, e.g., other users in an MCData emergency state remain in the communication. | +| MDEG 4: confirm-pending | Emergency group communication request sent by initiator | The controlling MCData server may not grant the request for various reasons, e.g., the MCData group is not configured as being emergency-capable so it can't be assumed that the group will enter the in-progress state. | + +## G.4.5 MCData emergency group communication state + +**Editor's note:** In the current release, support for emergency groups and emergency group communications may be absent, partial or limited, namely only provided to the extent of facilitating emergency alert functionality. + +Table G.4.5-1 provides the semantics of the MCData emergency group communication (MDEGC) state values. This is an internal state of the MCData client and is managed by the MCData client. This state variable aids in the managing of the information elements of MCData emergency group communications and MCData emergency alerts and their cancellations. + +**Table G.4.5-1: MCData emergency group communication state** + +| MCData emergency group communication state values | Semantics | Comments | +|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MDEGC 1: emergency-gc-capable | MCData emergency-capable client is not currently in an MCData emergency group communication that it has originated, nor is it in the process of initiating one. | MCData emergency state: may or may not be set in this state, depending upon the MCData client's MDEA state | +| MDEGC 2: emergency-communication-requested | MCData client has initiated an MCData emergency group communication request. | MCData emergency state: is set | +| MDEGC 3: emergency-communication-granted | MCData client has received an MCData emergency group communication grant. | If the MCData user initiates a communication while the MCData emergency state is still set, that communication will be an MCData emergency group communication, assuming that the group is authorised for the client to initiate emergency group communications on.
MCData emergency state: is set | + +--- + +## Annex H (informative): INFO packages defined in the present document + +### H.1 Info package for indication of communication release + +#### H.1.1 Scope + +This subclause contains the information required for the IANA registration of info package g.3gpp.mcdata-com-release in accordance with IETF RFC 6086. + +#### H.1.2 g.3gpp.mcdata-com-release info package + +##### H.1.2.1 Overall description + +When one of the communication release conditions are met e.g. lack of bearer capacity, limit for the maximum amount of data or time that a participant transmits from a single request to transmit exceeded, the MCData server may decide to release communication. Based on local policy and configuration, MCData server can release the communication without prior notification to MCData user; or it may send a notification to MCData user and allow the user to request for extension if the MCData user wants to. With this notification, MCData server may also request for more information related to ongoing communication like amount of data remaining to be transmitted. If MCData user requests for extension of the MCData communication, MCData server can accept or reject based on local policy. + +##### H.1.2.2 Applicability + +This package is used to: + +- send MCData server's intent to release the communication to the MCData client +- send more data from MCData client to MCData server when requested +- request extension of the MCData communication to MCData server. +- send response for extension request from MCData server to MCData client. + +##### H.1.2.3 Appropriateness of INFO Package Usage + +A number of solutions were discussed for sending MCData server's intent to release the communication along with request for more data to MCData user. The solutions were: + +- 1) Use of the session related methods (e.g. SIP RE-INVITE 200 (OK) response. +- 2) Use of the SIP INFO method as described in IETF RFC 6086, by defining a new info package. + +The result of the evaluation of the above solutions were: + +- 1) An SIP INVITE request will have three-way handshake, which may not be optimal to transfer the required data. +- 2) The use of SIP INFO request was found as the most appropriate solution since the SIP INFO request could be sent in the existing SIP session and can carry QUERY response in 200 OK. + +##### H.1.2.4 Info package name + +g.3gpp.mcdata-com-release + +##### H.1.2.5 Info package parameters + +None defined + +### H.1.2.6 SIP options tags + +None defined + +### H.1.2.7 INFO message body parts + +The MIME type of the message body carrying application/vnd.3gpp.mcdata-signalling and application/vnd.3gpp.mcdata-payload. Both application/vnd.3gpp.mcdata-signalling and application/vnd.3gpp.mcdata-payload MIME type is defined in this specification. + +### H.1.2.8 Info package usage restrictions + +None defined. + +### H.1.2.9 Rate of INFO Requests + +Single INFO request generated after MCData server decides to release communication with prior notification to MCData client and not requesting for more data. + +Two INFO requests generated after MCData server decides to release communication with prior notification to MCData client and requesting more data. + +Two INFO requests generated after MCData client requests for extension of communication. + +### H.1.2.10 Info package security considerations + +The security is based on the generic security mechanism provided for the underlying SIP signalling. No additional security mechanism is defined. + +### H.1.2.11 Implementation details and examples + +UAC generation of INFO requests: See 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". + +UAS processing of INFO requests: See 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". + +--- + +## Annex I (informative): Change history + +| Change history | | | | | | | +|----------------|-------|-----------|------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +| 2017-01 | | | | | Initial version. | 0.0.0 | +| 2017-01 | | | | | Implementing the following P-CRs after CT1#101-bis: C1-170189, C1-170438, C1-170439, C1-170440, C1-170442, C1-170480. | 0.1.0 | +| 2017-02 | | | | | Implementing editorials spotted in v0.1.0 and implementing the following P-CRs after CT1#102: C1-171057, C1-171058, C1-171119. | 0.2.0 | +| 2017-04 | | | | | Implementing the following P-CRs after CT1#103: C1-171420, C1-171423, C1-171428, C1-171728, C1-171732, C1-171737; C1-171739; C1-171740; C1-171741; C1-171742; C1-171744; C1-171745; C1-171778; C1-171806; C1-171814; C1-171815; C1-171816; C1-171817; C1-171819. | 0.3.0 | +| 2017-05 | | | | | Implementing the following P-CRs after CT1#104: C1-172166; C1-172167; C1-172168; C1-172218; C1-172224; C1-172225; C1-172247; C1-172283; C1-172371; C1-172372; C1-172373; C1-172374; C1-172375; C1-172377; C1-172537; C1-172538; C1-172541; C1-172542; C1-172544; C1-172545; C1-172546; C1-172548; C1-172736; C1-172737; C1-172739; C1-172742; C1-172752. | 0.4.0 | +| 2017-06 | CT-76 | CP-171110 | | | Version 1.0.0 created for presentation at CT for information | 1.0.0 | +| 2017-06 | CT-76 | | | | Version 14.0.0 created after approval at CT | 14.0.0 | +| 2017-06 | CT-76 | | | | Addition of missing XSD files | 14.0.1 | +| 2017-09 | CT-77 | CP-172102 | 0001 | 1 | Completing affiliation check for MCData | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0002 | 1 | Fixing auto-send and auto-receive | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0003 | 1 | Adding warnings for MCData | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0004 | 1 | SDS Session Late entry | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0005 | | mcdata-mcdata-id | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0006 | 1 | Services configuration | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0007 | | Location information | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0008 | 1 | Security clause 4.7 | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0009 | 2 | Confidentiality and Integrity Protection of TLV messages | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0010 | | Timers and counters | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0012 | 1 | Off-network SDS | 14.1.0 | +| 2017-09 | CT-77 | CP-172102 | 0013 | | Redundant editor's notes | 14.1.0 | +| 2017-12 | CT-78 | CP-173064 | 0015 | 1 | MCData Overview | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0016 | 3 | Authentication and key distribution | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0017 | | Corrections to deferred download | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0018 | | Redundant Editor's Notes | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0019 | | Enhanced Status | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0020 | | File availability parameters | 14.2.0 | + +| | | | | | | | +|---------|-------|-----------|------|---|----------------------------------------------------------------------------------------------|--------| +| 2017-12 | CT-78 | CP-173064 | 0021 | | EN on security | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0022 | 2 | Corrections on FD Disposition Notification | 14.2.0 | +| 2017-12 | CT-78 | CP-173064 | 0023 | 2 | Remove mcdata-signed+xml | 14.2.0 | +| 2017-12 | CT-78 | CP-173075 | 0014 | 3 | Response-Source header field handling completion | 15.0.0 | +| 2018-03 | CT-79 | CP-180073 | 0025 | 1 | Correction to mcdatainfo schema | 15.1.0 | +| 2018-03 | CT-79 | CP-180082 | 0026 | 3 | Accessing list of deferred data group communications | 15.1.0 | +| 2018-03 | CT-79 | CP-180082 | 0027 | 1 | Authorized MCData user initiated communication release with prior indication | 15.1.0 | +| 2018-03 | CT-79 | CP-180082 | 0028 | 1 | Authorized MCData user initiated communication release without prior indication | 15.1.0 | +| 2018-03 | CT-79 | CP-180082 | 0029 | 1 | On-network Enhanced Status | 15.1.0 | +| 2018-06 | CT-80 | CP-181054 | 0034 | 2 | MCData Cplane SDS procedure selection criterion | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0035 | 1 | Modification in usage of mcdata-enhanced-status-operational-values element for on-network ES | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0036 | 2 | Off network enhanced status | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0037 | 1 | MCData originating user initiated release of MCData communication over HTTP | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0038 | 1 | MCData server initiated release of MCData communication over HTTP | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0039 | 1 | MCData server initiated release of MCData communication over HTTP with prior indication | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0040 | 1 | Auth user initiated release of MCData communication over HTTP | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0041 | 1 | Auth user initiated release of MCData communication over HTTP with prior indication | 15.2.0 | +| 2018-06 | CT-80 | CP-181054 | 0043 | 2 | Protected payload message types | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0045 | 1 | Extended application Id for MCData SDS messages | 15.2.0 | +| 2018-06 | CT-80 | CP-181064 | 0046 | 1 | Essential corrections in communication release procedures | 15.2.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-09 | CT#81 | CP-182125 | 0048 | 1 | A | Completed IANA registrations for MCData | 15.3.0 | +| 2018-09 | CT#81 | CP-182125 | 0050 | 1 | A | Fix issues with encoding of IEs in MONP messages for MCData | 15.3.0 | +| 2018-09 | CT#81 | CP-182147 | 0051 | | F | Change Extended Application ID from TLV to TLV-E | 15.3.0 | +| 2018-09 | CT#81 | CP-182125 | 0053 | | A | Addition of Registration without Auth Token | 15.3.0 | +| 2018-12 | CT#82 | CP-183045 | 0056 | | F | Removal of editor's notes | 15.4.0 | +| 2018-12 | CT#82 | CP-183059 | 0058 | | A | Correct root element in presence event package | 15.4.0 | +| 2018-12 | CT#82 | CP-183059 | 0060 | | A | Correction of the "prefix" attribute handling | 15.4.0 | +| 2018-12 | CT#82 | CP-183059 | 0062 | | A | Rel-14 completed IANA registrations for MCData | 15.4.0 | +| 2019-03 | CT#83 | CP-190094 | 0063 | 2 | F | Clarification of encoding of MCData signalling content and MCData payload content | 15.5.0 | +| 2019-06 | CT#84 | CP-191118 | 0065 | | A | Removing IP Address from media-level section in SDP body for MCData Standalone SDS using media plan, SDS Session and FD using media plane | 15.6.0 | +| 2019-06 | CT#84 | CP-191118 | 0070 | 1 | A | Corrections in MCData SDS Session | 15.6.0 | +| 2019-06 | CT#84 | CP-191140 | 0066 | 3 | B | Emergency Alerts for MCData – General sections | 16.0.0 | +| 2019-06 | CT#84 | CP-191140 | 0067 | 3 | B | Emergency Alerts for MCData – sending origination request, on-network | 16.0.0 | +| 2019-06 | CT#84 | CP-191140 | 0068 | 2 | B | Emergency Alerts for MCData – cancelation, on-network | 16.0.0 | +| 2019-09 | CT#85 | CP-192061 | 0071 | 1 | C | Extended Application ID for MCData FD Messages | 16.1.0 | +| 2019-09 | CT#85 | CP-192061 | 0072 | 1 | B | Add Location procedures for MCData | 16.1.0 | +| 2019-09 | CT#85 | CP-192042 | 0076 | 1 | A | Fix for plugtest reported issue on mcdata notification | 16.1.0 | +| 2019-12 | CT#86 | CP-193108 | 0077 | 1 | C | Introduction of LMR Message as a value for MCData Payload content type | 16.2.0 | +| 2019-12 | CT#86 | CP-193109 | 0078 | 1 | C | Adding file description in MCData FD communication | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0079 | 2 | B | Pre-established session – References, General details and warning updates | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0080 | 2 | B | Common procedures for initiating SDS communication using pre-established session | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0081 | 2 | B | Pre-established session – General and PF use of resource sharing | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0082 | 2 | B | Client side procedure - Pre-established session establishment | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0083 | 2 | B | Pre-established session release | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0084 | 2 | B | Client side procedures – Initiating one-to-one SDS communication using pre-established session | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0085 | 2 | B | PF side procedures – Initiating MCData communication using pre-established session | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0086 | 2 | B | Initiating group SDS communication using pre-established session | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0087 | 2 | B | Leaving SDS communication using pre-established session | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0088 | 2 | B | PF side procedure - Pre-established session establishment | 16.2.0 | +| 2019-12 | CT#86 | CP-193109 | 0091 | 1 | F | Correct target of error response | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0092 | 2 | B | Add signalling plane capability to support transmission / reception via MBMS in MCData | 16.2.0 | +| 2019-12 | CT#86 | CP-193109 | 0094 | 1 | F | Correction of internal clause reference for implicit affiliation | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0095 | 3 | B | Add off-network emergency alert to MCData | 16.2.0 | +| 2019-12 | CT#86 | CP-193109 | 0096 | 1 | F | Correct MCData location schema | 16.2.0 | +| 2019-12 | CT#86 | CP-193102 | 0097 | 3 | B | Addition of Location information to SDS | 16.2.0 | +| 2020-03 | CT#87e | CP-200121 | 0099 | | F | Correcting SIP related terminology | 16.3.0 | +| 2020-03 | CT#87e | CP-200121 | 0100 | 1 | F | Correct reference in 8.3.2.6 | 16.3.0 | +| 2020-03 | CT#87e | CP-200122 | 0101 | 1 | B | IP Connectivity | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0102 | 1 | B | MCData key download procedure | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0103 | 2 | B | Retrieval of stored object | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0104 | 2 | B | Search for Objects in MCData message store | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0105 | 3 | B | Update Object(s) in MCData message store | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0106 | 1 | B | Delete Stored Object(s) in MCData message store. | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0107 | 1 | B | Add Message Store Client subclause | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0108 | 1 | B | Copy stored object(s) and/or folder(s) | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0109 | 1 | B | Creating new folder | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0110 | 1 | B | Delete folder | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0111 | 1 | B | Move object(s) and folder(s) | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0112 | 1 | B | Search for Folders in MCData message store | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0113 | 1 | B | Move the stored object to destination folder | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0114 | 1 | B | Upload the objects to the MCData message store | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0115 | 1 | C | Accessing the absolute URI associated with the media storage function | 16.3.0 | +| 2020-03 | CT#87e | CP-200121 | 0116 | 1 | F | Corrections to TDC2 and TDC3 timer handling | 16.3.0 | +| 2020-03 | CT#87e | CP-200115 | 0117 | 1 | B | The pre-established session modification for MCData | 16.3.0 | +| 2020-06 | CT#88-e | CP-201112 | 0118 | 1 | B | Deposit an object | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0119 | 1 | B | Create a subscription to notifications | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0120 | 1 | B | Delete a subscription to notifications | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0121 | 1 | B | Update a subscription to notifications | 16.4.0 | + +| | | | | | | | | +|--|--|--|--|--|--|-------------------------------------------------------------------------------------------|--| +| | | | | | | MCC note: In the first sentence of §21.2.14A.1, the word "may" was substituted for "can". | | +|--|--|--|--|--|--|-------------------------------------------------------------------------------------------|--| + +| | | | | | | | | +|---------|---------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88-e | CP-201112 | 0122 | 1 | B | Synchronization notification
MCC note: Resolved reference to clause "21.2.n" in § 21.2.16.2 1) b) as 21.2.11.1. | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0123 | 1 | B | Search-based Synchronization | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0124 | 1 | B | List folder | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0125 | 3 | C | Editor's note for hostname of MCData message store is addressed
MCC note: CR not written to correct version of the Spec, but was implementable. | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0126 | 2 | B | Support for MCData emergency alert and communications
MCC note: This CR introduces the abbreviation IMPU; MCC has added this in the list of abbreviations, choosing the most appropriate of the five variations appearing in other 3GPP Specs.
Similarly, MCC has provided the expansions of abbreviations UUID and URN introduced, but not defined by, this CR.
The newly introduced term "Group identity" has a circular definition.
In §D.1.3., "can" has been changed to "may" in newly introduced bullet points 11 c), 11 c) i), and 11 e). | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0127 | 2 | B | Emergency Alerts for MCData – client procedures | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0128 | 2 | B | Handling of MCData Emergency Alerts at the MCData participating servers | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0129 | 2 | B | Handling of MCData Emergency Alerts at the MCData controlling server | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0130 | 2 | B | Auxiliary procedures in support of Emergency Alerts for MCData | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0131 | 1 | F | Issue fixes in MCData pre-established session | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0132 | 1 | B | IPConnectivity extension to include IP Information | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0133 | 3 | F | Corrections to file upload-download procedure as per stage 2 architecture changes | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0134 | | B | Add functional alias status definitions | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0135 | | B | Add functional alias to clause 4.6 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201121 | 0136 | | F | Correct | 16.4.0 | +| 2020-06 | CT#88-e | CP-201121 | 0137 | | D | Editorial correction – 6.3.6.1
MCC note: removal of extraneous underlining | 16.4.0 | +| 2020-06 | CT#88-e | CP-201121 | 0138 | | D | Editorial correction – 10.2.5.4.4
MCC note: adds "if" at start of point 9) g) | 16.4.0 | +| 2020-06 | CT#88-e | CP-201121 | 0139 | 1 | D | Error correction – 13.2.1.1
MCC note: change of "client" to "server" is not editorial! | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0140 | | B | Functional alias – 5.2 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0141 | | B | Functional alias – 5.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0142 | | B | Functional alias – 9.2.1.2 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0143 | 1 | B | Functional alias – 9.2.2.2.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0144 | | B | Functional alias – 9.2.2.3.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0145 | 1 | B | Functional alias – 9.2.3.2.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0146 | 1 | B | Functional alias – 9.2.3.3.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0147 | 1 | B | Functional alias – 9.2.4.2.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0148 | | B | Functional alias – 9.2.4.3.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0149 | 1 | B | Functional alias – 9.2.5.1.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0150 | 1 | B | Functional alias – 9.2.5.2.1.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0151 | 1 | B | Functional alias – 9.2.5.3.1.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0152 | 1 | B | Functional alias – 10.2.4.2.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0153 | 1 | B | Functional alias – 10.2.4.3.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0154 | 1 | B | Functional alias – 10.2.5.2.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0155 | | B | Functional alias – 10.2.5.2.4 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0156 | 1 | B | Functional alias – 10.2.5.3.3 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0157 | 1 | B | Functional alias – 16.2.1.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0158 | 1 | B | Functional alias – 16.2.1.2 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0159 | 1 | B | Functional alias – 20.2.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201123 | 0160 | | B | Functional alias – 20.2.2 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0161 | 1 | B | Functional alias – affiliation procedures in 8.2 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0163 | 1 | B | Functional alias – MCData Client procedures | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0164 | 1 | B | Functional Alias – MCData Server procedures | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0162 | 1 | B | Functional alias – Coding | 16.4.0 | +| 2020-06 | CT#88-e | CP-201121 | 0165 | | F | Remove duplicate RFC 3856 reference | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0166 | | B | Update MCData Overview clause 4.1 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201121 | 0167 | 1 | D | Implement missing reference number | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0168 | 1 | B | Resolving EN for identifying user between MCData Server and MCData message store | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0169 | | F | Corrections in IP Connectivity SDP offer/answer generation | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0170 | 1 | B | Signalling plane support in MCData for user plane SDS using MBMS | 16.4.0 | +| 2020-06 | CT#88-e | CP-201088 | 0173 | | A | Off-network MCData support | 16.4.0 | +| 2020-06 | CT#88-e | CP-201088 | 0174 | 1 | A | Adding mcdata id in signalling payload for sender of the data in MCData media plane (Session) communication | 16.4.0 | +| 2020-06 | CT#88-e | CP-201124 | 0177 | | B | Update service authorization procedures to support limiting the | 16.4.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|--------------------------------------------------------------------------------|--------| +| | | | | | | number of authorized clients per MCData user | | +| 2020-06 | CT#88-e | CP-201124 | 0178 | 1 | B | Restricting incoming/outgoing MCData communications-control | 16.4.0 | +| 2020-06 | CT#88-e | CP-201112 | 0179 | 1 | F | Client SIP INVITE request descriptions | 16.4.0 | +| 2020-07 | | | | | | Editorial corrections | 16.4.1 | +| 2020-09 | CT#89-e | CP-202165 | 0180 | | F | Editors Notes in IP Connectivity | 16.5.0 | +| 2020-09 | CT#89-e | CP-202165 | 0181 | 1 | F | Increment service authorisations | 16.5.0 | +| 2020-09 | CT#89-e | CP-202154 | 0184 | 1 | F | Miscellaneous fixes | 16.5.0 | +| 2020-09 | CT#89-e | CP-202165 | 0185 | | F | Corrections on MCData related MONASTERY2 CRs implementation | 16.5.0 | +| 2020-12 | CT#90-e | CP-203202 | 0196 | | F | Fix on authorizations limit client notification | 16.6.0 | +| 2020-12 | CT#90-e | CP-203202 | 0198 | 1 | F | Reject the unauthorized user request for functional alias activation | 16.6.0 | +| 2021-06 | CT#92-e | CP-211125 | 0230 | 1 | A | Missing MONP message transport port number and other corrections | 16.7.0 | +| 2021-06 | CT#92-e | CP-211132 | 0222 | 2 | F | Add the element to D.1.3 | 16.7.0 | +| 2021-06 | CT#92-e | CP-211132 | 0232 | 1 | F | FA indication in subscription request MCData_16 | 16.7.0 | +| 2021-09 | CT#93-e | CP-212123 | 0235 | - | F | Correct spelling of deaffiliation boolean | 16.8.0 | +| 2021-09 | CT#93-e | CP-212122 | 0238 | 1 | F | MCData service binding - R16 | 16.8.0 | +| 2021-09 | CT#93-e | CP-212123 | 0250 | 2 | F | MCData correction on Functional Alias activation procedures | 16.8.0 | +| 2021-09 | CT#93-e | CP-212122 | 0241 | 1 | F | MCData - Define undeclared XML elements of location & mbms usage in XML schema | 16.8.0 | +| 2022-03 | CT#95-e | CP-220230 | 0298 | 1 | F | Addition of new SDS Disposition Notification type for LMR Interworking | 16.9.0 | +| 2022-03 | CT#95-e | CP-220231 | 0294 | 1 | F | Media feature tags and namespace definitions for IP Connectivity subservice | 16.9.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24285/47e8c2042061e08a14e012472e9fdbaa_img.jpg b/marked/Rel-16/24_series/24285/47e8c2042061e08a14e012472e9fdbaa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e952274e62459063314d759718e0d0146f495ef5 --- /dev/null +++ b/marked/Rel-16/24_series/24285/47e8c2042061e08a14e012472e9fdbaa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d74b706dbb7f0b2074024ffe9306fdef2d0e174b4ba78adf13d261b0cad53777 +size 43760 diff --git a/marked/Rel-16/24_series/24285/raw.md b/marked/Rel-16/24_series/24285/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..64cf2603fb2db8a74f4d1bc8793afc21c02d5da6 --- /dev/null +++ b/marked/Rel-16/24_series/24285/raw.md @@ -0,0 +1,654 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Allowed CSG List Management Object ..... | 6 | +| 5 Management Object parameters..... | 6 | +| 5.1 General ..... | 6 | +| 5.2 Node: ..... | 6 | +| 5.3 //AllowedCSGEntries ..... | 7 | +| 5.4 //AllowedCSGEntries/ ..... | 7 | +| 5.5 //AllowedCSGEntries//PLMN_ID ..... | 7 | +| 5.6 //AllowedCSGEntries//CSG-entries..... | 7 | +| 5.7 //AllowedCSGEntries//CSG-entries/ ..... | 7 | +| 5.8 //AllowedCSGEntries//CSG-entries//CSG_ID ..... | 8 | +| 5.9 //AllowedCSGEntries//CSG-entries//HNB_Name..... | 8 | +| 5.10 //AllowedCSGEntries//CSG-entries//CSG_Type ..... | 8 | +| 5.11 //OperatorCSGEntries ..... | 8 | +| 5.12 //OperatorCSGEntries/ ..... | 9 | +| 5.13 //OperatorCSGEntries//PLMN_ID ..... | 9 | +| 5.14 //OperatorCSGEntries//CSG-entries ..... | 9 | +| 5.15 //OperatorCSGEntries//CSG-entries/..... | 9 | +| 5.16 //OperatorCSGEntries//CSG-entries//CSG_ID ..... | 9 | +| 5.17 //OperatorCSGEntries//CSG-entries//HNB_Name ..... | 10 | +| 5.18 // OperatorCSGEntries //CSG-entries//CSG_Type..... | 10 | +| 5.19 //Ext/ ..... | 10 | +| 5.20 //OperatorCSGEntries//OperatorCSGEntries_Only_thisPLMN ..... | 10 | +| 5.21 //OperatorCSGEntries/OperatorCSGEntries_Only ..... | 11 | +| Annex A (informative): Management Object DDF..... | 12 | +| Annex B (informative): Change history..... | 16 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies an Allowed Closed Subscriber Group (CSG) List Management Object (MO). + +The Allowed CSG List MO is compatible with the OMA Device Management (DM) protocol specifications, version 1.2 and upwards, and is defined using the OMA DM Device Description Framework (DDF) as described in the Enabler Release Definition OMA-ERELD-DM-V1\_2 [5]. + +The Allowed CSG List MO consists of relevant parameters for that can be used by the UE to select the appropriate CSG cell based on its subscription. + +The Allowed CSG List MO defines the relevant parameters related to the Allowed CSG List and to the Operator CSG List. + +The usage of the Allowed CSG List for in the idle mode process and the mobility management procedure is defined in 3GPP TS 23.122 [2], 3GPP TS 24.008 [3] and 3GPP TS 24.301 [4]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [1A] 3GPP TS 23.003: "Numbering, addressing and identification". +- [2] 3GPP TS 23.122: "Non-Access-Stratum functions related to Mobile Station (MS) in idle mode". +- [3] 3GPP TS 24.008: "Mobile Radio Interface Layer 3 specification; Core Network Protocols; Stage 3" +- [4] 3GPP TS 24.301: " Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3" +- [5] OMA-ERELD-DM-V1\_2: "Enabler Release Definition for OMA Device Management". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] apply. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|----------------------------| +| CSG | Closed Subscriber Group | +| DM | Device Management | +| HNB | Home NodeB/eNodeB | +| MO | Management Object | +| OMA | Open Mobile Alliance | +| PLMN | Public Land Mobile Network | + +# 4 Allowed CSG List Management Object + +The Allowed CSG List Management Object (MO) is used to manage the list of allowed CSG IDs, the Operator CSG IDs and the related restricted access information at UE. + +The Management Object Identifier is: urn:oma:mo:ext-3gpp-csg:1.0. + +The OMA DM Access Control List (ACL) property mechanism (see OMA-ERELD-DM-V1\_2 [5]) may be used to grant or deny access rights to OMA DM servers in order to modify nodes and leaf objects of the Allowed CSG list MO. + +The following nodes and leaf objects are possible under the Allowed CSG List node as described in figure 4-1: + +![A hierarchical tree diagram showing the structure of the Allowed CSG List Management Object. The root node is , which branches into AllowedCSGEntries, OperatorCSGEntries, and Ext ?. AllowedCSGEntries branches into +, which further branches into PLMN_ID and CSG entries. CSG entries branches into +, which branches into CSG_ID, HNB_Name ?, and CSG_Type ?. OperatorCSGEntries branches into +, which branches into PLMN_ID, OperatorCSGEntries_Only_thisPLMN?, and OperatorCSGEntries_Only?. OperatorCSGEntries_Only? branches into CSG-entries, which branches into +, which branches into CSG_ID, HNB_Name ?, and CSG_Type ?.](47e8c2042061e08a14e012472e9fdbaa_img.jpg) + +``` + +graph TD + X[""] --> ACE["AllowedCSGEntries"] + X --> OCE["OperatorCSGEntries"] + X --> Ext["Ext ?"] + ACE --> X_plus_1[" +"] + X_plus_1 --> PLMN_ID_1["PLMN_ID"] + X_plus_1 --> CSG_entries_1["CSG entries"] + CSG_entries_1 --> X_plus_2[" +"] + X_plus_2 --> CSG_ID_1["CSG_ID"] + X_plus_2 --> HNB_Name_1["HNB_Name ?"] + X_plus_2 --> CSG_Type_1["CSG_Type ?"] + OCE --> X_plus_3[" +"] + X_plus_3 --> PLMN_ID_2["PLMN_ID"] + X_plus_3 --> OCE_O只_1["OperatorCSGEntries_Only_thisPLMN?"] + X_plus_3 --> OCE_O只_2["OperatorCSGEntries_Only?"] + OCE_O只_2 --> CSG_entries_2["CSG-entries"] + CSG_entries_2 --> X_plus_4[" +"] + X_plus_4 --> CSG_ID_2["CSG_ID"] + X_plus_4 --> HNB_Name_2["HNB_Name ?"] + X_plus_4 --> CSG_Type_2["CSG_Type ?"] + +``` + +A hierarchical tree diagram showing the structure of the Allowed CSG List Management Object. The root node is , which branches into AllowedCSGEntries, OperatorCSGEntries, and Ext ?. AllowedCSGEntries branches into +, which further branches into PLMN\_ID and CSG entries. CSG entries branches into +, which branches into CSG\_ID, HNB\_Name ?, and CSG\_Type ?. OperatorCSGEntries branches into +, which branches into PLMN\_ID, OperatorCSGEntries\_Only\_thisPLMN?, and OperatorCSGEntries\_Only?. OperatorCSGEntries\_Only? branches into CSG-entries, which branches into +, which branches into CSG\_ID, HNB\_Name ?, and CSG\_Type ?. + +Figure 4-1: The Allowed CSG List Management Object + +When a UE receives an Allowed CSG List Management Object (MO) containing the Allowed CSG List, it shall update its Allowed CSG list stored in a USIM or in a non-volatile memory in the ME. + +When a UE receives an Allowed CSG List Management Object (MO) containing the Operator CSG List, it shall update the Operator CSG List stored in a non-volatile memory in the ME. + +# 5 Management Object parameters + +## 5.1 General + +This clause describes the parameters for the Allowed CSG List Management Object (MO). + +## 5.2 Node: + +This interior node acts as a placeholder for zero or one accounts for a fixed node. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +## 5.3 //AllowedCSGEntries + +The AllowedCSGEntries interior node is used to allow a reference to a list of allowed CSG entries. + +- Occurrence: One +- Format: node +- Access Types: Get +- Values: N/A + +## 5.4 //AllowedCSGEntries/ + +This run-time node acts as a placeholder for one or more allowed CSG entries. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get +- Values: N/A + +## 5.5 //AllowedCSGEntries//PLMN\_ID + +The PLMN\_ID leaf represents a PLMN Identifier + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The value of the PLMN Identifier shall be a PLMN-Id as specified in 3GPP TS 23.003 [1A]. + +## 5.6 //AllowedCSGEntries//CSG-entries + +The CSG-entries interior node is used to allow a reference to a list of allowed CSG entries in a PLMN. + +- Occurrence: One +- Format: node +- Access Types: Get +- Values: N/A + +## 5.7 //AllowedCSGEntries//CSG-entries/ + +This run-time node acts as a placeholder for one or more CSG entries (the CSG Identity, its related HNB Name and CSG Type) in a PLMN. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get +- Values: N/A + +## 5.8 //AllowedCSGEntries//CSG-entries//CSG\_ID + +The CSG\_ID leaf represents a CSG Identifier. + +- Occurrence: One +- Format: bin + +- Access Types: Get, Replace +- Values: + +The value of the CSG Identifier shall be coded as a CSG-ID as specified in 3GPP TS 23.003 [1A]. + +## 5.9 //AllowedCSGEntries//CSG-entries//HNB\_Name + +The HNB\_name leaf represents a HNB Name. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: + +The value of the HNB Name shall be coded as specified in 3GPP TS 23.003 [1A]. + +## 5.10 //AllowedCSGEntries//CSG-entries//CSG\_Type + +The CSG Type leaf represents a CSG type. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: + +The value of the CSG Type shall be coded as specified in 3GPP TS 23.003 [1A]. + +## 5.11 //OperatorCSGEntries + +The OperatorCSGEntries interior node is used to allow a reference to a list of operator CSG entries. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +## 5.12 //OperatorCSGEntries/ + +This run-time node acts as a placeholder for one or more operator CSG entries. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get +- Values: N/A + +## 5.13 //OperatorCSGEntries//PLMN\_ID + +The PLMN\_ID leaf represents a PLMN Identifier. + +- Occurrence: One +- Format: chr + +- Access Types: Get, Replace +- Values: + +The value of the PLMN Identifier shall be a PLMN-Id as specified in 3GPP TS 23.003 [1A]. + +## 5.14 //OperatorCSGEntries//CSG-entries + +The CSG-entries interior node is used to allow a reference to a list of operator CSG entries in a PLMN. + +- Occurrence: One +- Format: node +- Access Types: Get +- Values: N/A + +## 5.15 //OperatorCSGEntries//CSG-entries/ + +This run-time node acts as a placeholder for one or more CSG entries (the CSG Identity, its related HNB Name and CSG Type) in a PLMN. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get +- Values: N/A + +## 5.16 //OperatorCSGEntries//CSG-entries//CSG\_ID + +The CSG\_ID leaf represents a CSG Identifier. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The value of the CSG Identifier shall be coded as a CSG-ID as specified in 3GPP TS 23.003 [1A]. + +## 5.17 //OperatorCSGEntries//CSG-entries//HNB\_Name + +The HNB\_name leaf represents a HNB Name. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: + +The value of the HNB Name shall be coded as specified in 3GPP TS 23.003 [1A]. + +## 5.18 // OperatorCSGEntries //CSG-entries//CSG\_Type + +The CSG Type leaf represents a CSG type. + +- Occurrence: ZeroOrOne +- Format: chr + +- Access Types: Get, Replace +- Values: + +The value of the CSG Type shall be coded as specified in 3GPP TS 23.003 [1A]. + +## 5.19 //Ext/ + +The Ext is an interior node for where the vendor specific information about the Allowed CSG List MO is being placed (vendor meaning application vendor, device vendor etc.). Usually the vendor extension is identified by vendor specific name under the ext node. The tree structure under the vendor identified is not defined and can therefore include one or more un-standardized sub-trees. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.20 + +### //OperatorCSGEntries//OperatorCSGEntries\_Only\_thisPLMN + +The OperatorCSGEntries\_Only\_thisPLMN leaf is used to indicate which CSGs the UE is configured to present to the user for a certain PLMN ID during manual CSG selection. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: "false", "true" + - "false" – Indicates that HPLMN has configured the UE to present to the user CSGs for the PLMN indicated in PLMN\_ID leaf without any restriction. + - "true" – Indicates that HPLMN has configured the UE to present to the user only the CSGs in the Operator CSG List for the PLMN indicated in PLMN\_ID leaf. + +NOTE: For the value "true", if the HPLMN has not included any CSG entry for the PLMN indicated in PLMN\_ID leaf, the UE is implicitly configured to not display any CSG for this PLMN during manual CSG selection. + +If the OperatorCSGEntries\_Only\_thisPLMN leaf is not included, then its value is equal to the value of OperatorCSGEntries\_Only leaf. + +## 5.21 //OperatorCSGEntries/OperatorCSGEntries\_Only + +The OperatorCSGEntries\_Only leaf is used to indicate which CSGs the UE is configured to present to the user during manual CSG selection for every PLMN not included in the OperatorCSGEntries leaf and for every PLMN for which an OperatorCSGEntries\_Only\_thisPLMN leaf was not included. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: "false", "true" + +"false" – Indicates that the HPLMN has configured the UE, for every PLMN not included in any PLMN\_ID leaf in the OperatorCSGEntries leaf or for which an OperatorCSGEntries\_Only\_thisPLMN leaf was not included, to present to the user CSGs without any restriction. + +"true" – Indicates that the HPLMN has configured the UE, for every PLMN not included in any PLMN\_ID leaf in the OperatorCSGEntries leaf or any PLMN for which an OperatorCSGEntries\_Only\_thisPLMN leaf was not included, to present to the user only the CSGs in the Operator CSG List. + +NOTE: For the value "true", if the HPLMN has not included any CSG entry in the OperatorCSGList for a certain PLMN, the UE is implicitly configured to not display any CSG for that PLMN during manual CSG selection. + +If the OperatorCSGEntries\_Only leaf is not included, the default OperatorCSGEntries\_Only value is "false". + +# Annex A (informative): Management Object DDF + +This DDF is the standardized minimal set. A vendor can define its own DDF for the complete device. This DDF can include more features than this minimal standardized version. + +``` + + + + + 1.2 + + + + + + + Root Node of the UE Allowed CSG List + + urn:oma:ext-3gpp-csg:1.0 + + + + AllowedCSGEntries + + + + + This node specifies the parent node for allowed CSG entries + text/plain + + + + + + + + This node specifies the parent node for PLMN entries + text/plain + + + PLMN_ID + + + + + This leaf specifies the PLMN ID + text/plain + + + + CSG-entries + + + + + This node specifies the parent node for CSG entries + text/plain + + + + + + + + This node specifies CSG entries for specific PLMN + text/plain + + + CSG_ID + + + + + + + + +``` + +``` + + This leaf specifies the CSG identifier + text/plain + + + + HNB_Name + + + + + This leaf node specifies the HNB Name + text/plain + + + + CSG Type + + + + + This leaf node specifies the CSG Type + text/plain + + + + + + + + + OperatorCSGEntries + + + + + This node specifies the parent node for operator CSG entries + text/plain + + + OperatorCSGEntries_Only + + + + + This leaf specifies which CSGs to display to the user + text/plain + + + + + + + + + This node specifies the parent node for PLMN entries + text/plain + + + PLMN_ID + + + + + This leaf specifies the PLMN ID + text/plain + + + + OperatorCSGEntries_Only_thisPLMN + + + + + This leaf specifies which CSGs to display to the user + text/plain + + + + +``` + +``` + + + CSG-entries + + + + + This node specifies the parent node for CSG entries + text/plain + + + + + + + + This node specifies CSG entries for specific PLMN + text/plain + + + CSG_ID + + + + + This leaf specifies the CSG identifier + text/plain + + + + HNB_Name + + + + + This leaf node specifies the HNB Name + text/plain + + + + CSG Type + + + + + This leaf node specifies the CSG Type + text/plain + + + + + + Ext + + + + + + + + + + + + + + A collection of all extension objects + + + + + + + + + +``` + + + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|--------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2008-09 | | | | | Version 0.0.1: Preliminary proposal | | 0.0.1 | +| 2008-10 | | | | | Version 0.0.2: TS number is added | 0.0.1 | 0.0.2 | +| 2008-11 | | | | | C1-085374 | 0.0.2 | 0.1.0 | +| 2008-11 | | | | | Editorial corrections | 0.1.0 | 0.1.1 | +| 2008-11 | | | | | Version 1.0.0 created for presentation to CT#42 for information | 0.1.1 | 1.0.0 | +| 2009-02 | | | | | C1-090705 | 1.0.0 | 1.1.0 | +| 2009-02 | CT-43 | | | | Version 2.0.0 created for presentation to CT#43 for approval | 1.1.0 | 2.0.0 | +| 2009-03 | CT-43 | | | | Version 8.0.0 created after approval at CT#43 | 2.0.0 | 8.0.0 | +| 2009-06 | CT-44 | CP-090423 | 0001 | | urn for the CSG MO registered by OMNA and minor corrections and cleanups | 8.0.0 | 8.1.0 | +| 2009-06 | CT-44 | CP-090423 | 0002 | 1 | Updating the allowed CSG list on receiving OMA DM message | 8.0.0 | 8.1.0 | +| 2009-06 | CT-44 | | | | Cover sheet template fixed by MCC | 8.0.0 | 8.1.0 | +| 2009-06 | | | | | Correct version shown on cover | 8.1.0 | 8.1.1 | +| 2009-09 | CT-45 | CP-090677 | 0003 | 1 | Support of CSG Type in Allowed CSG MO | 8.1.1 | 8.2.0 | +| 2009-09 | CT-45 | CP-090633 | 0004 | 2 | Introduction of Operator CSG List in the MO | 8.2.0 | 9.0.0 | +| 2009-12 | CT-46 | CP-090918 | 0006 | | Correction of the OMA DM object for the Allowed CSG list | 9.0.0 | 9.1.0 | +| 2009-12 | CT-46 | CP-090935 | 0007 | | Support of CSG Type for Operator CSG List | 9.0.0 | 9.1.0 | +| 2010-06 | CT-48 | CP-100350 | 0011 | | Occurrence of HNB_Name and CSG_Type | 9.1.0 | 9.2.0 | +| 2010-06 | CT-48 | CP-100370 | 0010 | 1 | Updating Operator CSG List | 9.2.0 | 10.0.0 | +| 2010-09 | CT-49 | CP-100606 | 0021 | | Correcting DDF of allowed CSG list MO | 10.0.0 | 10.1.0 | +| 2010-12 | CT-50 | CP-100748 | 0023 | 3 | Support for displaying only CSGs in the Operator CSG List | 10.1.0 | 10.2.0 | +| 2012-09 | CT-57 | | | | Upgrade to Rel-11 | 10.2.0 | 11.0.0 | +| 2014-09 | CT-65 | | | | Upgrade to Rel-12 | 11.0.0 | 12.0.0 | +| 2015-12 | CT-70 | | | | Upgrade to Rel-13 | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT-75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA-80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24302/1514ba1efbec1dbb3fbda5d02701af36_img.jpg b/marked/Rel-16/24_series/24302/1514ba1efbec1dbb3fbda5d02701af36_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9fb56593a26e055b67465a5467ff0796a7b0eef5 --- /dev/null +++ b/marked/Rel-16/24_series/24302/1514ba1efbec1dbb3fbda5d02701af36_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f5392d6f7125e76955d89e94273a55d9912b11c43d429fea7bd59fedc07256b +size 12953 diff --git a/marked/Rel-16/24_series/24302/2914642fbfe4ae35924bdf4beb189c1f_img.jpg b/marked/Rel-16/24_series/24302/2914642fbfe4ae35924bdf4beb189c1f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa030472118e03f050a2438eb625810e07a19cb3 --- /dev/null +++ b/marked/Rel-16/24_series/24302/2914642fbfe4ae35924bdf4beb189c1f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ecb52edbcf8c6bcf555449bfab7b6adaf41251c43f950ff72973e314c4805db +size 28956 diff --git a/marked/Rel-16/24_series/24302/3295c6ffe9f6d00c3811c37d327ac844_img.jpg b/marked/Rel-16/24_series/24302/3295c6ffe9f6d00c3811c37d327ac844_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5a3121de01905db79642033d6e49744012ef2e71 --- /dev/null +++ b/marked/Rel-16/24_series/24302/3295c6ffe9f6d00c3811c37d327ac844_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82d7574fabc0b4e1bdb0b0a777f1564544e6b7f84607fb9565aed3c47a1077ef +size 21357 diff --git a/marked/Rel-16/24_series/24302/3e88de626facff0ce44cb3cb12c40d29_img.jpg b/marked/Rel-16/24_series/24302/3e88de626facff0ce44cb3cb12c40d29_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2bd5efa6a8e1da4eb5dca342eb66f13448a728e3 --- /dev/null +++ b/marked/Rel-16/24_series/24302/3e88de626facff0ce44cb3cb12c40d29_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5869cc02d4d6c4229e83850ca2be5bbdf1e8bb330ab21c0415202e03c74ca95b +size 20479 diff --git a/marked/Rel-16/24_series/24302/4bb56f4af58f9d5daab52d98c984d8d5_img.jpg b/marked/Rel-16/24_series/24302/4bb56f4af58f9d5daab52d98c984d8d5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..98561fcfcb0b0cb0e402665d7e438eb864dc911d --- /dev/null +++ b/marked/Rel-16/24_series/24302/4bb56f4af58f9d5daab52d98c984d8d5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f24f4646cbdfd78240a7e5d804857b2fa9581b356335f75a89ebd91b598347f +size 17336 diff --git a/marked/Rel-16/24_series/24302/679c2ccc5b7f68983ae16ad7ba7308c3_img.jpg b/marked/Rel-16/24_series/24302/679c2ccc5b7f68983ae16ad7ba7308c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..43cd7f600492574eb1a0601deb22bfda46ed3bb5 --- /dev/null +++ b/marked/Rel-16/24_series/24302/679c2ccc5b7f68983ae16ad7ba7308c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ba39ce0b912cb72e13fbd9f954da11fe7035bfdd903ee9937140aa27f86a6b9 +size 20102 diff --git a/marked/Rel-16/24_series/24302/7497bf7f235b0bf4852cfd9ab9d01a43_img.jpg b/marked/Rel-16/24_series/24302/7497bf7f235b0bf4852cfd9ab9d01a43_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1534da281c3186e90458416c5920ce288df72003 --- /dev/null +++ b/marked/Rel-16/24_series/24302/7497bf7f235b0bf4852cfd9ab9d01a43_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07fd674609e9a9bbdd90e4e5eb2f721f4168e71b51778e7034e94a17539c2394 +size 11412 diff --git a/marked/Rel-16/24_series/24302/76808556fd942668469e05483dc61e5b_img.jpg b/marked/Rel-16/24_series/24302/76808556fd942668469e05483dc61e5b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..891c4b7954db875de8ddf07aaa95b4d21345332b --- /dev/null +++ b/marked/Rel-16/24_series/24302/76808556fd942668469e05483dc61e5b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41a54a25f1d2407760a609254759e7a4f8a5f3dee3c7accf411f97a507d7d8bd +size 38022 diff --git a/marked/Rel-16/24_series/24302/85a44a4e566144c47c2289799051c0b1_img.jpg b/marked/Rel-16/24_series/24302/85a44a4e566144c47c2289799051c0b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a7a797a266acff901ecd8b2b101e26ad2cf6503 --- /dev/null +++ b/marked/Rel-16/24_series/24302/85a44a4e566144c47c2289799051c0b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c6e4660d9e5fecef79309d2783c0cb539f28eb30eaa075a26b0145dc0fa7477 +size 12965 diff --git a/marked/Rel-16/24_series/24302/884c44b6cb9fbe15347e0562a6085df2_img.jpg b/marked/Rel-16/24_series/24302/884c44b6cb9fbe15347e0562a6085df2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb1c3346cc5d3114a8003e70348ffbaf45c5dde7 --- /dev/null +++ b/marked/Rel-16/24_series/24302/884c44b6cb9fbe15347e0562a6085df2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e63dfcafdfb493cee0a94641d5650f0e0f060965a0021df37e3a647749aead9 +size 96751 diff --git a/marked/Rel-16/24_series/24302/8d6b56ea28d70ce527efde127103e045_img.jpg b/marked/Rel-16/24_series/24302/8d6b56ea28d70ce527efde127103e045_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cdf506d0fbfc8bf755ad7673c843a39024e4a472 --- /dev/null +++ b/marked/Rel-16/24_series/24302/8d6b56ea28d70ce527efde127103e045_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c82e44c5c43f22cc1c43301b0d98c034ea4422a7b90a5defab88d9642b4dbd4 +size 16965 diff --git a/marked/Rel-16/24_series/24302/9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg b/marked/Rel-16/24_series/24302/9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f908cebf98239185bd7f259491d3898739b21db --- /dev/null +++ b/marked/Rel-16/24_series/24302/9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fdd6434fe9f1f3d5b30c468cea92b2d3403a7cfc41628b63570df2f4a2d00f6 +size 29843 diff --git a/marked/Rel-16/24_series/24302/a4e9abbc6ca82471f1a223d0a68cd45e_img.jpg b/marked/Rel-16/24_series/24302/a4e9abbc6ca82471f1a223d0a68cd45e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dca795e73695059c4eaf99ed8c036b9ab54cff5b --- /dev/null +++ b/marked/Rel-16/24_series/24302/a4e9abbc6ca82471f1a223d0a68cd45e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ca8d789f7b69e186cfa56b82da34e79438fb90c319770ad44b692b089ef2d7f +size 27619 diff --git a/marked/Rel-16/24_series/24302/ab34425e5238083d55091d3abe8452c2_img.jpg b/marked/Rel-16/24_series/24302/ab34425e5238083d55091d3abe8452c2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cc35d9af093ee50efd0a539fe1c5cb3c2ce8dfcb --- /dev/null +++ b/marked/Rel-16/24_series/24302/ab34425e5238083d55091d3abe8452c2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:02b7284665a516d83a765f081bbd85ac678485e1f9c9c391bbc1814a0b84710c +size 16745 diff --git a/marked/Rel-16/24_series/24302/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg b/marked/Rel-16/24_series/24302/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c20321901099cac11635a1f37daee18268d96c6b --- /dev/null +++ b/marked/Rel-16/24_series/24302/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe6de0ca36ccc7ce0a133a2396ab45cfe16e81b6c8e6a6a32974b589318e8d6a +size 34123 diff --git a/marked/Rel-16/24_series/24302/b822771c1a5790feaeecfc439e08bcdd_img.jpg b/marked/Rel-16/24_series/24302/b822771c1a5790feaeecfc439e08bcdd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3f10c9f1dfbeaca0cd8327a31b53afbc2c5dfc23 --- /dev/null +++ b/marked/Rel-16/24_series/24302/b822771c1a5790feaeecfc439e08bcdd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8eeb4553d3c3dffdbaf9a586caa425c05fa74e0f3797ac5dc58fc9335c31f9d8 +size 31034 diff --git a/marked/Rel-16/24_series/24302/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg b/marked/Rel-16/24_series/24302/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c5ec9cb9be66ef31eda9882a1597c416c68e0ccd --- /dev/null +++ b/marked/Rel-16/24_series/24302/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b8727dd724f1c5dde966585c85ff9dba827fbe1ba82aea30ce07bd2bb519cd9 +size 59310 diff --git a/marked/Rel-16/24_series/24302/d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg b/marked/Rel-16/24_series/24302/d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..108c3aeb860b9309a7eedbbfd1a3dc080abca7e7 --- /dev/null +++ b/marked/Rel-16/24_series/24302/d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:076efc49e40c7e35fc5ec376ebee40e49f8628a562d38532799522db32a5cb50 +size 17274 diff --git a/marked/Rel-16/24_series/24302/d74d2943c702ef88a5f9dec974fc92a5_img.jpg b/marked/Rel-16/24_series/24302/d74d2943c702ef88a5f9dec974fc92a5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d93417411ae4bb1927924ff490f5758bcf0beec4 --- /dev/null +++ b/marked/Rel-16/24_series/24302/d74d2943c702ef88a5f9dec974fc92a5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:995d69b466caaf4f5f06e44b5824174bcff868ae2d3773b12a6fc1d723089e48 +size 64055 diff --git a/marked/Rel-16/24_series/24302/d7eba809a7e0433a21291666f36a78e9_img.jpg b/marked/Rel-16/24_series/24302/d7eba809a7e0433a21291666f36a78e9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1fc7aa733be941b3845a1782b22781d1b662e790 --- /dev/null +++ b/marked/Rel-16/24_series/24302/d7eba809a7e0433a21291666f36a78e9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47653e41180c889d344a0beff2f8c3d858f0f456d96a865ae6c62266e55a1df2 +size 18685 diff --git a/marked/Rel-16/24_series/24302/db6adf216c948c2b545e513aba13a16a_img.jpg b/marked/Rel-16/24_series/24302/db6adf216c948c2b545e513aba13a16a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63f9d59aedd19ba6ff1ccc1ea28ec5585da3f5a9 --- /dev/null +++ b/marked/Rel-16/24_series/24302/db6adf216c948c2b545e513aba13a16a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e65102b22a039ef4e062c72df7ca02593977e2c9a04a0f3e8deb6149467f5d0b +size 18449 diff --git a/marked/Rel-16/24_series/24302/e6b7c04e3244ab7b6161e0ec2edafd86_img.jpg b/marked/Rel-16/24_series/24302/e6b7c04e3244ab7b6161e0ec2edafd86_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75d217fd5cdaf0a7655eee70c8ad0908393a894a --- /dev/null +++ b/marked/Rel-16/24_series/24302/e6b7c04e3244ab7b6161e0ec2edafd86_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6881222ebd71ac70ee32d4ef81edee165bb1cf2c297af08ab5d4c0e953113448 +size 12867 diff --git a/marked/Rel-16/24_series/24302/eabcb2f8b9acedb194571d5bc734b463_img.jpg b/marked/Rel-16/24_series/24302/eabcb2f8b9acedb194571d5bc734b463_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..add9caa0d7b68ec777a46383f7c8e492769b4022 --- /dev/null +++ b/marked/Rel-16/24_series/24302/eabcb2f8b9acedb194571d5bc734b463_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8566aa9d818d7bd4f100280b6b25616f91c7b8231e7f7a67c22bd5818af64326 +size 14003 diff --git a/marked/Rel-16/24_series/24302/f9873201604e723ae0bafb7e389ef619_img.jpg b/marked/Rel-16/24_series/24302/f9873201604e723ae0bafb7e389ef619_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63826517baea9f3ec156e83e6501778c6fa80a6f --- /dev/null +++ b/marked/Rel-16/24_series/24302/f9873201604e723ae0bafb7e389ef619_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21b1f324eb93ce12db56cbfaacda0b6fc7140c90e1e76c6b1065649194057834 +size 15856 diff --git a/marked/Rel-16/24_series/24302/f99313b06c15e9882079b773ce50a7b2_img.jpg b/marked/Rel-16/24_series/24302/f99313b06c15e9882079b773ce50a7b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2839932fef0178ccb7f323eca9ac4e330e856c71 --- /dev/null +++ b/marked/Rel-16/24_series/24302/f99313b06c15e9882079b773ce50a7b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26315a63b574eda83e58c4dce481e3b8d983fbe5df65230f7e77fb1682796b8c +size 35597 diff --git a/marked/Rel-16/24_series/24302/fe4f9338148fd891afbd3e301f9bad33_img.jpg b/marked/Rel-16/24_series/24302/fe4f9338148fd891afbd3e301f9bad33_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..136d8979095a064ef8a21b8ef42ca92c735a36fb --- /dev/null +++ b/marked/Rel-16/24_series/24302/fe4f9338148fd891afbd3e301f9bad33_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5f435f30aeb37b80ec427408123261370c2c70c467f283d8310530b03c2780f +size 19297 diff --git a/marked/Rel-16/24_series/24302/raw.md b/marked/Rel-16/24_series/24302/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bdd08e89604e0ab63a60ffa02bcceb7621a2203b --- /dev/null +++ b/marked/Rel-16/24_series/24302/raw.md @@ -0,0 +1,6440 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------------------------|----| +| Foreword..... | 11 | +| 1 Scope..... | 12 | +| 2 References..... | 12 | +| 3 Definitions, symbols and abbreviations..... | 15 | +| 3.1 Definitions..... | 15 | +| 3.2 Abbreviations..... | 18 | +| 4 General..... | 19 | +| 4.1 Trusted and untrusted accesses..... | 19 | +| 4.2 cdma2000® HRPD Access System..... | 20 | +| 4.3 WiMAX Access System..... | 20 | +| 4.3A WLAN..... | 20 | +| 4.4 Identities..... | 20 | +| 4.4.1 User identities..... | 20 | +| 4.4.2 Identification of IP Services/PDN connections..... | 21 | +| 4.4.3 FQDN for ePDG Selection..... | 21 | +| 4.4.4 Access Network Identity..... | 21 | +| 4.4.5 ANDSF Server Name..... | 21 | +| 4.4.6 Home Agent address(es)..... | 21 | +| 4.4.7 Security Parameters Index..... | 22 | +| 4.5 Fixed Broadband Access System..... | 22 | +| 4.6 Restrictive non-3GPP access networks..... | 22 | +| 4.7 Provision and handling of local emergency numbers..... | 22 | +| 4.8 Quality of service support..... | 23 | +| 4.8.1 General..... | 23 | +| 4.8.2 QoS differentiation in trusted WLAN..... | 23 | +| 4.8.2.1 General..... | 23 | +| 4.8.2.2 QoS signalling..... | 23 | +| 4.8.2.3 QoS differentiation in user plane..... | 24 | +| 4.8.3 QoS differentiation in untrusted non-3GPP access..... | 24 | +| 5 Network Discovery and Selection..... | 24 | +| 5.0 General..... | 24 | +| 5.1 Access network discovery and selection procedures..... | 24 | +| 5.1.1 General..... | 24 | +| 5.1.2 Access network discovery procedure..... | 25 | +| 5.1.2.1 Triggering the discovery of operator preferred access networks with the ANDSF..... | 25 | +| 5.1.2.2 Discovering availability of access networks..... | 25 | +| 5.1.3 Access network selection procedure..... | 25 | +| 5.1.3.1 General..... | 25 | +| 5.1.3.2 Specific intra-technology access network selection..... | 25 | +| 5.1.3.2.1 cdma2000® HRPD access network selection..... | 25 | +| 5.1.3.2.2 WiMAX NAP selection..... | 26 | +| 5.1.3.2.3 WLAN selection..... | 26 | +| 5.2 EPC network selection over non-3GPP access..... | 27 | +| 5.2.1 General..... | 27 | +| 5.2.2 Generic EPC network selection procedure over non-3GPP access..... | 28 | +| 5.2.2.1 Identification of the EPC..... | 28 | +| 5.2.2.2 EPC network selection..... | 28 | +| 5.2.2.2.1 UE selection modes..... | 28 | +| 5.2.2.2.2 Manual EPC network selection..... | 28 | +| 5.2.2.2.3 Automatic EPC network selection..... | 28 | +| 5.2.3 Access technology specific EPC network selection procedures..... | 28 | +| 5.2.3.1 EPC network selection procedures for WiMAX..... | 28 | +| 5.2.3.1.1 Identification of the EPC by the WiMAX access network..... | 28 | +| 5.2.3.1.2 EPC network selection..... | 29 | +| 5.2.3.2 EPC network selection procedures for WLAN..... | 29 | + +| | | | +|------------|-----------------------------------------------------------------------------------------------|----| +| 5.2.3.2.1 | UE selection modes..... | 29 | +| 5.2.3.2.1A | Service provider solicitation..... | 29 | +| 5.2.3.2.2 | Manual Service Provider selection mode procedure..... | 30 | +| 5.2.3.2.3 | Automatic mode service provider selection procedure..... | 30 | +| 5.3 | Access Network reselection..... | 31 | +| 5.3.1 | General..... | 31 | +| 5.3.2 | UE procedures..... | 31 | +| 5.3.3 | EPC procedures..... | 32 | +| 5.3.4 | Periodic EPC network reselection attempts..... | 32 | +| 5.4 | Data traffic routing of IP flows..... | 32 | +| 5.4.1 | General..... | 32 | +| 5.4.2 | Access technology or access network selection..... | 33 | +| 5.4.2.1 | ANDSF rules control the WLAN access selection and traffic routing..... | 33 | +| 5.4.2.2 | RAN rules control the WLAN access selection and traffic routing..... | 33 | +| 6 | UE – EPC Network protocols..... | 33 | +| 6.1 | General..... | 33 | +| 6.2 | Trusted and Untrusted Accesses..... | 33 | +| 6.2.1 | General..... | 33 | +| 6.2.2 | Pre-configured policies in the UE..... | 34 | +| 6.2.3 | Dynamic Indication..... | 34 | +| 6.2.4 | No trust relationship information..... | 34 | +| 6.3 | IP Mobility Mode Selection..... | 34 | +| 6.3.1 | General..... | 34 | +| 6.3.2 | Static configuration of inter-access mobility mechanism..... | 34 | +| 6.3.3 | Dynamic configuration of inter-access mobility mechanism..... | 35 | +| 6.3.3.0 | General..... | 35 | +| 6.3.3.1 | IPMS indication..... | 35 | +| 6.3.3.1.1 | IPMS indication from UE to 3GPP AAA server..... | 35 | +| 6.3.3.1.2 | IPMS indication from 3GPP AAA server to UE..... | 36 | +| 6.4 | Authentication and authorization for accessing EPC via a trusted non-3GPP access network..... | 36 | +| 6.4.1 | General..... | 36 | +| 6.4.1A | TWAN connection modes..... | 37 | +| 6.4.2 | UE procedures..... | 37 | +| 6.4.2.1 | Identity Management..... | 37 | +| 6.4.2.1A | Identity Management - emergency session..... | 37 | +| 6.4.2.2 | EAP-AKA and EAP-AKA' based Authentication..... | 37 | +| 6.4.2.3 | Full Authentication and Fast Re-authentication..... | 38 | +| 6.4.2.4 | Handling of the Access Network Identity..... | 38 | +| 6.4.2.4.1 | General..... | 38 | +| 6.4.2.4.2 | ANID indication from 3GPP AAA server to UE..... | 39 | +| 6.4.2.4.3 | UE check of ANID for HRPD CDMA 2000® access networks..... | 39 | +| 6.4.2.4.4 | UE check of ANID for WiMAX access networks..... | 39 | +| 6.4.2.4.5 | UE check of ANID for WLAN access networks..... | 39 | +| 6.4.2.4.6 | UE check of ANID for ETHERNET access networks..... | 39 | +| 6.4.2.5 | Full name for network and short name for network..... | 39 | +| 6.4.2.6 | TWAN connection modes..... | 40 | +| 6.4.2.6.1 | General..... | 40 | +| 6.4.2.6.2 | Usage of single-connection mode (SCM)..... | 40 | +| 6.4.2.6.2A | Usage of single-connection mode (SCM) - emergency..... | 43 | +| 6.4.2.6.3 | Usage of multi-connection mode (MCM)..... | 44 | +| 6.4.2.6.3A | Usage of multi-connection mode (MCM) - emergency..... | 45 | +| 6.4.2.6.3B | Usage of transparent single-connection mode (TSCM) - emergency..... | 46 | +| 6.4.2.6.4 | Network support not available..... | 46 | +| 6.4.2.7 | Mobile Equipment Identity Signalling..... | 47 | +| 6.4.3 | 3GPP AAA server procedures..... | 48 | +| 6.4.3.1 | Identity Management..... | 48 | +| 6.4.3.1A | Identity Management - emergency session..... | 48 | +| 6.4.3.2 | EAP-AKA and EAP-AKA' based Authentication..... | 48 | +| 6.4.3.3 | Full authentication and Fast Re-authentication..... | 48 | +| 6.4.3.4 | Full name for network and short name for network..... | 48 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------|----| +| 6.4.3.5 | TWAN connection modes..... | 49 | +| 6.4.3.5.1 | General..... | 49 | +| 6.4.3.5.1A | Emergency session connection mode negotiation for unauthenticated UEs..... | 49 | +| 6.4.3.5.2 | Usage of single-connection mode (SCM)..... | 49 | +| 6.4.3.5.2A | Usage of single-connection mode (SCM) - emergency..... | 51 | +| 6.4.3.5.3 | Usage of multi-connection mode (MCM)..... | 52 | +| 6.4.3.5.3A | Usage of multi-connection mode (MCM) - emergency..... | 53 | +| 6.4.3.5.3B | Usage of transparent single-connection mode (TSCM) - emergency..... | 54 | +| 6.4.3.5.4 | Network support not available..... | 55 | +| 6.4.3.6 | Mobile Equipment Identity Signalling..... | 55 | +| 6.4.4 | Multiple PDN support for trusted non-3GPP access..... | 55 | +| 6.5 | Authentication and authorization for accessing EPC via an untrusted non-3GPP access network..... | 56 | +| 6.5.1 | General..... | 56 | +| 6.5.2 | Full authentication and authorization..... | 56 | +| 6.5.2.1 | General..... | 56 | +| 6.5.2.2 | UE procedures..... | 57 | +| 6.5.2.2.1 | General..... | 57 | +| 6.5.2.2.2 | EAP AKA..... | 57 | +| 6.5.2.3 | 3GPP AAA server procedures..... | 58 | +| 6.5.2.3.1 | General..... | 58 | +| 6.5.2.3.2 | EAP-AKA..... | 58 | +| 6.5.2.4 | ePDG procedures..... | 58 | +| 6.5.3 | Multiple PDN support for untrusted non-3GPP access network..... | 59 | +| 6.6 | UE - 3GPP EPC (cdma2000® HRPD Access)..... | 60 | +| 6.6.1 | General..... | 60 | +| 6.6.2 | Non-emergency case..... | 60 | +| 6.6.2.1 | General..... | 60 | +| 6.6.2.2 | UE identities..... | 60 | +| 6.6.2.3 | cdma2000® HRPD access network identity..... | 60 | +| 6.6.2.4 | PLMN system selection..... | 60 | +| 6.6.2.5 | Trusted and untrusted accesses..... | 60 | +| 6.6.2.6 | IP mobility mode selection..... | 61 | +| 6.6.2.7 | Authentication and authorization for accessing EPC..... | 61 | +| 6.6.3 | Emergency case..... | 61 | +| 6.6.3.1 | General..... | 61 | +| 6.6.3.2 | UE identities..... | 61 | +| 6.6.3.3 | Authentication and authorization for accessing EPC..... | 61 | +| 6.7 | UE - 3GPP EPC (WiMAX Access)..... | 61 | +| 6.7.1 | General..... | 61 | +| 6.7.2 | Non-emergency case..... | 62 | +| 6.7.2.1 | General..... | 62 | +| 6.7.2.2 | UE identities..... | 62 | +| 6.7.2.3 | WiMAX access network identity..... | 62 | +| 6.7.2.4 | Selection of the Network Service Provider..... | 62 | +| 6.7.2.5 | Trusted and untrusted accesses..... | 62 | +| 6.7.2.6 | IP mobility mode selection..... | 62 | +| 6.7.2.7 | Authentication and authorization for accessing EPC..... | 62 | +| 6.7.3 | Emergency case..... | 62 | +| 6.8 | Communication over the S14..... | 62 | +| 6.8.1 | General..... | 62 | +| 6.8.2 | Interaction with the Access Network Discovery and Selection Function..... | 63 | +| 6.8.2.1 | General..... | 63 | +| 6.8.2.2 | UE procedures..... | 64 | +| 6.8.2.2.1 | UE discovering the ANDSF..... | 64 | +| 6.8.2.2.1A | ANDSF communication security..... | 64 | +| 6.8.2.2.2 | Role of UE for Push model..... | 64 | +| 6.8.2.2.3 | Role of UE for Pull model..... | 65 | +| 6.8.2.2.4 | UE using information provided by ANDSF..... | 65 | +| 6.8.2.3 | ANDSF procedures..... | 70 | +| 6.8.2.3.1 | General..... | 70 | +| 6.8.2.3.2 | Role of ANDSF for Push model..... | 70 | + +| | | | +|-----------|--------------------------------------------------------------------------------------------------------|----| +| 6.8.2.3.3 | Role of ANDSF for Pull model..... | 71 | +| 6.9 | Handling of Protocol Configuration Options information..... | 71 | +| 6.10 | Integration with access stratum layer of 3GPP access..... | 71 | +| 6.10.1 | General..... | 71 | +| 6.10.2 | Selection of control of WLAN access selection and traffic routing..... | 71 | +| 6.10.3 | Additional procedures when WLAN access selection and traffic routing is controlled by ANDSF rules..... | 72 | +| 6.10.4 | Additional procedures when WLAN access selection and traffic routing is controlled by RAN rules..... | 73 | +| 7 | Tunnel management procedures..... | 75 | +| 7.1 | General..... | 75 | +| 7.2 | UE procedures..... | 75 | +| 7.2.1 | Selection of the ePDG..... | 75 | +| 7.2.1.1 | General..... | 75 | +| 7.2.1.2 | Determination of the country the UE is located in..... | 75 | +| 7.2.1.3 | Handling of ePDG selection based on the country the UE is located in..... | 76 | +| 7.2.1.4 | Determine if the visited country mandates the selection of ePDG in this country..... | 78 | +| 7.2.1A | Selection of the ePDG for emergency bearer services..... | 78 | +| 7.2.2 | Tunnel establishment..... | 78 | +| 7.2.2.1 | Tunnel establishment accepted by the network..... | 78 | +| 7.2.2.2 | Tunnel establishment not accepted by the network..... | 81 | +| 7.2.2A | Liveness check procedure..... | 83 | +| 7.2.2B | Handling of NBIFOM..... | 83 | +| 7.2.2C | Rekeying procedure..... | 83 | +| 7.2.2D | NAT keep alive procedure..... | 83 | +| 7.2.3 | Tunnel modification..... | 84 | +| 7.2.3.1 | UE-initiated modification..... | 84 | +| 7.2.3.2 | UE behaviour towards ePDG initiated modification..... | 84 | +| 7.2.4 | Tunnel disconnection..... | 84 | +| 7.2.4.1 | UE initiated disconnection..... | 84 | +| 7.2.4.2 | UE behaviour towards ePDG initiated disconnection..... | 85 | +| 7.2.4.3 | Local tunnel disconnection initiated from 3GPP access..... | 85 | +| 7.2.5 | Emergency session establishment..... | 85 | +| 7.2.6 | Mobile identity signaling..... | 87 | +| 7.2.7 | IKEv2 multiple bearer PDN connectivity..... | 87 | +| 7.2.7.1 | General..... | 87 | +| 7.2.7.2 | Maintained information..... | 88 | +| 7.2.7.3 | Control plane procedures..... | 88 | +| 7.2.7.3.1 | General..... | 88 | +| 7.2.7.3.2 | Establishment of IKEv2 SA and initial IPsec ESP tunnel..... | 88 | +| 7.2.7.3.3 | Establishment of an additional IPsec ESP tunnel..... | 88 | +| 7.2.7.3.4 | Release of an additional IPsec ESP tunnel..... | 89 | +| 7.2.7.3.5 | Modification of an IPsec ESP tunnel due to change of EPS QoS and TFT..... | 89 | +| 7.2.7.3.6 | ePDG initiated IPsec ESP tunnel rekeying..... | 91 | +| 7.2.7.3.7 | UE initiated IPsec ESP tunnel rekeying..... | 92 | +| 7.2.7.4 | User plane procedures..... | 92 | +| 7.2.7.4.1 | General..... | 92 | +| 7.2.7.4.2 | Uplink IP packet handling..... | 92 | +| 7.3 | 3GPP AAA server procedures..... | 92 | +| 7.4 | ePDG procedures..... | 92 | +| 7.4.1 | Tunnel establishment..... | 92 | +| 7.4.1.1 | Tunnel establishment accepted by the network..... | 92 | +| 7.4.1.2 | Tunnel establishment not accepted by the network..... | 94 | +| 7.4.1A | Liveness check..... | 95 | +| 7.4.1B | Handling of NBIFOM..... | 95 | +| 7.4.1C | Handling of N1 mode support..... | 96 | +| 7.4.2 | Tunnel modification..... | 96 | +| 7.4.2.1 | ePDG-initiated modification..... | 96 | +| 7.4.2.2 | ePDG behaviour towards UE-initiated modification..... | 96 | +| 7.4.3 | Tunnel disconnection..... | 97 | +| 7.4.3.1 | ePDG initiated disconnection..... | 97 | +| 7.4.3.2 | ePDG behaviour towards UE initiated disconnection..... | 97 | + +| | | | +|------------|---------------------------------------------------------------------------|-----| +| 7.4.3.3 | Local tunnel disconnection initiated by PGW..... | 97 | +| 7.4.4 | Emergency session establishment..... | 98 | +| 7.4.5 | Mobile identity signaling..... | 99 | +| 7.4.6 | IKEv2 multiple bearer PDN connectivity..... | 99 | +| 7.4.6.1 | General..... | 99 | +| 7.4.6.2 | Maintained information..... | 99 | +| 7.4.6.3 | Control plane procedures..... | 99 | +| 7.4.6.3.1 | General..... | 99 | +| 7.4.6.3.2 | Establishment of IKEv2 SA and initial IPSec ESP tunnel..... | 99 | +| 7.4.6.3.3 | Establishment of an additional IPSec ESP tunnel..... | 100 | +| 7.4.6.3.4 | Release of an additional IPSec ESP tunnel..... | 100 | +| 7.4.6.3.5 | Modification of an IPSec ESP tunnel due to change of EPS QoS and TFT..... | 100 | +| 7.4.6.3.6 | ePDG initiated IPSec ESP tunnel rekeying..... | 101 | +| 7.4.6.3.7 | UE initiated IPSec ESP tunnel rekeying..... | 101 | +| 7.4.6.4 | User plane procedures..... | 101 | +| 7.4.6.4.1 | General..... | 101 | +| 7.4.6.4.2 | Downlink IP packet handling..... | 101 | +| 7.4.6.4.3 | Uplink IP packet handling..... | 101 | +| 8 | PDUs and parameters specific to the present document..... | 102 | +| 8.0 | General..... | 102 | +| 8.1 | 3GPP specific coding information defined within present document..... | 102 | +| 8.1.1 | Access Network Identity format and coding..... | 102 | +| 8.1.1.1 | Generic format of the Access Network Identity..... | 102 | +| 8.1.1.2 | Definition of Access Network Identities for Specific Access Networks..... | 102 | +| 8.1.2 | IKEv2 Notify Message Type value..... | 104 | +| 8.1.2.1 | Generic..... | 104 | +| 8.1.2.2 | Private Notify Message - Error Types..... | 104 | +| 8.1.2.3 | Private Notify Message - Status Types..... | 106 | +| 8.1.3 | ANDSF Push Information..... | 108 | +| 8.1.3.1 | General..... | 108 | +| 8.1.3.2 | ANDSF Push Information values..... | 108 | +| 8.1.4 | PDUs for TWAN connection modes..... | 108 | +| 8.1.4.0 | General..... | 108 | +| 8.1.4.1 | Message..... | 108 | +| 8.1.4.2 | Item..... | 109 | +| 8.1.4.3 | CONNECTIVITY_TYPE item..... | 110 | +| 8.1.4.4 | ATTACHMENT_TYPE item..... | 110 | +| 8.1.4.5 | APN item..... | 111 | +| 8.1.4.6 | PDN_TYPE item..... | 111 | +| 8.1.4.7 | AUTHORIZATIONS item..... | 111 | +| 8.1.4.8 | CONNECTION_MODE_CAPABILITY item..... | 111 | +| 8.1.4.9 | PROTOCOL_CONFIGURATION_OPTIONS item..... | 112 | +| 8.1.4.10 | CAUSE item..... | 112 | +| 8.1.4.10.1 | General..... | 112 | +| 8.1.4.10.2 | Causes..... | 113 | +| 8.1.4.11 | IPV4_ADDRESS item..... | 114 | +| 8.1.4.12 | IPV6_INTERFACE_IDENTIFIER item..... | 114 | +| 8.1.4.13 | TWAG_CP_ADDRESS item..... | 114 | +| 8.1.4.14 | TWAG_UP_MAC_ADDRESS item..... | 115 | +| 8.1.4.15 | SUPPORTED_WLCP_TRANSPORTS item..... | 115 | +| 8.1.4.16 | Tw1 item..... | 116 | +| 8.1.4.17 | ACCESS_CAUSE item..... | 116 | +| 8.1.4.17.1 | General..... | 116 | +| 8.1.4.17.2 | Access causes..... | 116 | +| 8.2 | IETF RFC coding information defined within present document..... | 117 | +| 8.2.1 | IPMS attributes..... | 117 | +| 8.2.1.1 | AT_IPMS_IND attribute..... | 117 | +| 8.2.1.2 | AT_IPMS_RES attribute..... | 117 | +| 8.2.2 | Access Network Identity indication attribute..... | 118 | +| 8.2.2.1 | Access Network Identity in the AT_KDF_INPUT attribute..... | 118 | +| 8.2.3 | Trust relationship indication attribute..... | 118 | + +| | | | +|------------|------------------------------------------------------------|-----| +| 8.2.3.1 | AT_TRUST_IND attribute..... | 118 | +| 8.2.4 | IKEv2 Configuration Payloads attributes..... | 119 | +| 8.2.4.1 | HOME_AGENT_ADDRESS attribute..... | 119 | +| 8.2.4.2 | TIMEOUT_PERIOD_FOR_LIVENESS_CHECK attribute..... | 119 | +| 8.2.5 | Full name for network and short name for network..... | 120 | +| 8.2.5.1 | AT_FULL_NAME_FOR_NETWORK attribute..... | 120 | +| 8.2.5.2 | AT_SHORT_NAME_FOR_NETWORK attribute..... | 120 | +| 8.2.6 | Handling of the unknown protocol data..... | 121 | +| 8.2.7 | Attributes for TWAN connection modes..... | 121 | +| 8.2.7.1 | AT_TWAN_CONN_MODE attribute..... | 121 | +| 8.2.8 | Device Identity..... | 122 | +| 8.2.8.1 | AT_DEVICE_IDENTITY attribute..... | 122 | +| 8.2.9 | IKEv2 Notify payloads..... | 123 | +| 8.2.9.1 | BACKOFF_TIMER Notify payload..... | 123 | +| 8.2.9.2 | DEVICE_IDENTITY Notify payload..... | 124 | +| 8.2.9.3 | NBIFOM_GENERIC_CONTAINER Notify payload..... | 125 | +| 8.2.9.4 | P-CSCF_RESELECTION_SUPPORT Notify payload..... | 126 | +| 8.2.9.5 | PTI Notify payload..... | 126 | +| 8.2.9.6 | REACTIVATION_REQUESTED_CAUSE Notify payload..... | 127 | +| 8.2.9.7 | EMERGENCY_SUPPORT Notify payload..... | 127 | +| 8.2.9.8 | EMERGENCY_CALL_NUMBERS Notify payload..... | 128 | +| 8.2.9.9 | IKEV2_MULTIPLE_BEARER_PDN_CONNECTIVITY Notify payload..... | 129 | +| 8.2.9.10 | EPS_QOS Notify payload..... | 130 | +| 8.2.9.10A | EXTENDED_EPS_QOS Notify payload..... | 130 | +| 8.2.9.11 | TFT Notify payload..... | 131 | +| 8.2.9.12 | MODIFIED_BEARER Notify payload..... | 132 | +| 8.2.9.13 | APN_AMBR Notify payload..... | 132 | +| 8.2.9.14 | EXTENDED_APN_AMBR Notify payload..... | 133 | +| 8.2.9.15 | N1_MODE_CAPABILITY Notify payload..... | 134 | +| 8.2.9.16 | N1_MODE_INFORMATION Notify payload..... | 134 | +| 8.2.9.17 | N1_MODE_S_NSSAI_PLMN_ID Notify payload..... | 135 | +| 8.2.10 | EAP-3GPP-LimitedService method..... | 136 | +| 8.2.10.1 | General..... | 136 | +| 8.2.10.2 | Message format..... | 136 | +| 8.2.10.2.1 | EAP-Request/3GPP-LimitedService-Init-Info message..... | 136 | +| 8.2.10.2.2 | EAP-Response/3GPP-LimitedService-Init-Info message..... | 137 | +| 8.2.10.2.3 | EAP-Request/3GPP-LimitedService-Notif message..... | 138 | +| 8.2.10.2.4 | EAP-Response/3GPP-LimitedService-Notif message..... | 139 | + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex A (informative): Example signalling flows for inter-system change between 3GPP and non-3GPP systems using ANDSF..... | 141 | +| A.1 Scope of signalling flows..... | 141 | +| A.2 Signalling flow for inter-system change between 3GPP access network and non-3GPP access network..... | 141 | +| Annex B (informative): Assignment of Access Network Identities in 3GPP..... | 144 | +| B.1 Access Network Identities..... | 144 | +| Annex C (informative): Example usage of ANDSF..... | 145 | +| C.1 Scope of ANDSF Example..... | 145 | +| C.2 Organization of ANDSF Coverage Map for WiMAX Network discovery..... | 145 | +| C.3 Parameters in Pull mode..... | 145 | +| Annex D (informative): Mismatch of static configuration of mobility mechanism in the UE and in the network..... | 146 | +| Annex E (informative): UE procedures based on preconfigured and received information..... | 148 | +| Annex F (Normative): Access to EPC via restrictive non-3GPP access network..... | 151 | +| F.1 General..... | 151 | +| F.2 UE – EPC network protocols..... | 151 | +| F.2.1 General..... | 151 | +| F.2.2 FTT protocol..... | 151 | +| F.2.2.1 General..... | 151 | +| F.2.2.2 UE requested FTT establishment procedure..... | 151 | +| F.2.2.2.1 General..... | 151 | +| F.2.2.2.2 UE requested FTT establishment procedure initiation..... | 152 | +| F.2.2.2.3 UE requested FTT establishment procedure initiation via restrictive non-3GPP access network type I..... | 152 | +| F.2.2.2.4 UE requested FTT establishment procedure initiation via restrictive non-3GPP access network type II..... | 152 | +| F.2.2.2.5 UE requested FTT establishment procedure accepted by the network..... | 152 | +| F.2.2.3 IKEv2 message transport procedure..... | 152 | +| F.2.2.3.1 General..... | 152 | +| F.2.2.3.2 IKEv2 message transport procedure initiation..... | 152 | +| F.2.2.3.3 IKEv2 message transport procedure accepted..... | 153 | +| F.2.2.4 Encapsulating security payload transport procedure..... | 153 | +| F.2.2.4.1 General..... | 153 | +| F.2.2.4.2 Encapsulating security payload transport initiation..... | 153 | +| F.2.2.4.3 Encapsulating security payload transport accepted..... | 153 | +| F.2.2.5 UE requested keep-alive procedure..... | 153 | +| F.2.2.5.1 General..... | 153 | +| F.2.2.5.2 UE requested keep-alive procedure initiation..... | 153 | +| F.2.2.5.3 UE requested keep-alive procedure accepted by the network..... | 154 | +| F.2.2.6 UE requested FTT release procedure..... | 154 | +| F.2.2.6.1 General..... | 154 | +| F.2.2.6.2 UE requested FTT release procedure initiation..... | 154 | +| F.2.2.6.3 UE requested FTT release procedure accepted by the network..... | 154 | +| F.2.2.7 Network requested FTT release procedure..... | 154 | +| F.2.2.7.1 General..... | 154 | +| F.2.2.7.2 Network requested FTT release procedure initiation..... | 154 | +| F.2.2.7.3 Network requested FTT release procedure accepted by the UE..... | 154 | +| F.2.3 Additional IKEv2 procedures when FTT is used..... | 154 | +| F.2.3.1 FTT KAT negotiation during tunnel establishment..... | 154 | + +| | | | +|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|------------| +| F.3 | PDUs and parameters specific to the present annex..... | 155 | +| F.3.1 | Void..... | 155 | +| F.3.2 | Message types of FTT messages..... | 155 | +| F.3.2.1 | Generic FTT envelope..... | 155 | +| F.3.2.2 | IKEv2 envelope..... | 155 | +| F.3.2.3 | ESP envelope..... | 155 | +| F.3.2.4 | Keep-alive envelope..... | 156 | +| F.3.3 | IKEv2 configuration attributes..... | 156 | +| F.3.3.1 | FTT_KAT configuration attribute..... | 156 | +| Annex G (Informative): IANA registrations..... | | 158 | +| G.1 | General..... | 158 | +| G.2 | EAP-AKA attributes..... | 158 | +| G.2.1 | General..... | 158 | +| G.2.2 | AT_TWAN_CONN_MODE EAP-AKA attribute..... | 158 | +| G.2.3 | AT_DEVICE_IDENTITY EAP-AKA attribute..... | 159 | +| G.3 | IKEv2 configuration attributes..... | 159 | +| G.3.1 | General..... | 159 | +| G.3.2 | TIMEOUT_PERIOD_FOR_LIVENESS_CHECK attribute..... | 159 | +| Annex H (normative): Definition of generic container for ANQP payload..... | | 161 | +| H.1 | General..... | 161 | +| H.2 | General structure..... | 161 | +| H.2.1 | Structure..... | 161 | +| H.2.2 | Generic container User Data (GUD)..... | 161 | +| H.2.3 | User Data Header Length (UDHL)..... | 162 | +| H.2.4 | Information Elements..... | 162 | +| H.2.4.1 | Information Element Identity (IEI)..... | 162 | +| H.2.4.2 | PLMN List IE..... | 162 | +| H.2.4.3 | PLMN List with S2a Connectivity IE..... | 163 | +| H.2.4.4 | PLMN List with trusted 5G Connectivity IE..... | 163 | +| H.2.4.5 | PLMN List with trusted 5G Connectivity-without-NAS IE..... | 163 | +| Annex I (normative): Definition of the Emergency Call Number field's contents..... | | 164 | +| I.1 | General..... | 164 | +| I.2 | Formatting..... | 164 | +| I.2.1 | General..... | 164 | +| I.2.2 | ABNF for the urn:3gpp:sos-anqp namespace and its parameters..... | 164 | +| I.2.3 | Semantics..... | 164 | +| I.2.4 | Mapping Emergency Call Number field's contents to the Local WLAN Emergency Numbers List..... | 165 | +| Annex J (normative): Emergency Call Numbers from DNS procedure..... | | 166 | +| J.1 | General..... | 166 | +| J.2 | Retrieval of emergency call numbers..... | 166 | +| J.3 | Void..... | 166 | +| Annex K (normative): Local Emergency Call Numbers from IKEv2 procedure..... | | 167 | +| K.1 | General..... | 167 | +| K.2 | Retrieval of local emergency call numbers..... | 167 | +| K.2.1 | UE procedures..... | 167 | +| K.2.2 | ePDG procedures..... | 167 | +| Annex L (informative): Change history..... | | 169 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the discovery and network selection procedures for access to 3GPP Evolved Packet Core (EPC) via non-3GPP access networks and includes Authentication and Access Authorization using Authentication, Authorization and Accounting (AAA) procedures used for the interworking of the 3GPP EPC and the non-3GPP access networks. + +The present document also specifies the Tunnel management procedures used for establishing an end-to-end tunnel from the UE to the ePDG to the point of obtaining IP connectivity and includes the selection of the IP mobility mode. + +The non-3GPP access networks considered in this present document are cdma2000® HRPD and Worldwide Interoperability for Microwave Access (WiMAX), and any access technologies covered in 3GPP TS 23.402 [6]. The present document also specifies UE access to PLMN IP-based services via restrictive non-3GPP access networks covered in 3GPP TS 33.402 [15]. These non-3GPP access networks can be trusted or untrusted access networks. + +The present document is applicable to the UE and the network. In this technical specification the network is the 3GPP EPC. + +NOTE: cdma2000® is a registered trademark of the Telecommunications Industry Association (TIA-USA). + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] Void. +- [2A] 3GPP TS 23.002: "Network architecture". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] 3GPP TS 23.122: "Non-Access-Stratum (NAS) functions related to Mobile Station (MS) in idle mode". +- [5] Void. +- [5A] 3GPP TS 23.203: "Policy and Charging Control Architecture". +- [6] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [7] Void. +- [8] Void. +- [9] 3GPP TS 24.234 v12.2.0: "3GPP System to Wireless Local Area Network (WLAN) interworking; WLAN User Equipment (WLAN UE) to network protocols". +- [10] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS)". +- [11] 3GPP TS 24.303: "Mobility management based on Dual-Stack Mobile IPv6". +- [12] 3GPP TS 24.304: "Mobility management based on Mobile IPv4; User Equipment (UE) - Foreign Agent interface". + +- [13] 3GPP TS 24.312: "Access Network Discovery and Selection Function (ANDSF) Management Object (MO)". +- [14] 3GPP TS 25.304: "User Equipment (UE) procedures in idle mode and procedures for cell reselection in connected mode". +- [14A] 3GPP TS 25.331: "Radio Resource Control (RRC); Protocol Specification". +- [15] 3GPP TS 33.402: "3GPP System Architecture Evolution: Security aspects of non-3GPP accesses". +- [16] 3GPP TS 36.304: "Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) procedures in idle mode". +- [16A] 3GPP TS 45.008: "Radio Access Network; Radio subsystem link control". +- [16B] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA) Radio Resource Control (RRC); Protocol specification". +- [17] 3GPP TS 29.273: "Evolved Packet System; 3GPP EPS AAA Interfaces". +- [18] 3GPP TS 29.275: "Proxy Mobile IPv6 (PMIPv6) based Mobility and Tunnelling protocols". +- [19] 3GPP TS 29.276: "Optimized Handover Procedures and Protocols between EUTRAN Access and cdma2000 HRPD Access". +- [20] 3GPP2 X.S0057-B v2.0: "E-UTRAN - HRPD Connectivity and Interworking: Core Network Aspects". +- [21] 3GPP2 C.S0087-A v4.0: "E-UTRAN – HRPD and CDMA2000 1x Connectivity and Interworking: Air Interface Aspects". +- [22] Void. +- [23] 3GPP2 C.S0024-B v3.0: "cdma2000® High Rate Packet Data Air Interface Specification". +- [23A] 3GPP2 C.S0016-D v1.0: "Over-the-Air Service Provisioning of Mobile Stations in Spread Spectrum Standards". +- [24] WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 2: "Architecture Tenets, Reference Model and Reference Points", November 2007. +- [25] WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3: "Detailed Protocols and Procedures", November 2007. +- [26] WiMAX Forum Mobile System Profile Release 1.0 Approved Specification Revision 1.4.0, April 2007. +- [27] IEEE Std 802.16e-2005 and IEEE Std 802.16-2004/Cor1-2005: "IEEE Standard for Local and Metropolitan Area Networks, Part 16: Air Interface for Fixed and Mobile Broadband Wireless Access Systems Amendments 2 and Corrigendum 1", February 2006. +- [28] IETF RFC 7296 (October 2014): "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [29] IETF RFC 3748 (June 2004): "Extensible Authentication Protocol (EAP)". +- [30] IETF RFC 4301 (December 2005): "Security Architecture for the Internet Protocol". +- [31] IETF RFC 4555 (June 2006): "IKEv2 Mobility and Multihoming Protocol (MOBIKE)". +- [32] IETF RFC 4303 (December 2005): "IP Encapsulating Security Payload (ESP)". +- [33] IETF RFC 4187 (January 2006): "Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)". +- [34] IETF RFC 3629 (November 2003): "UTF-8, a transformation format of ISO 10646". + +- [35] IETF RFC 1035 (November 1987): "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION". +- [36] Void. +- [37] IETF RFC 6153 (February 2011): "DHCPv4 and DHCPv6 Options for Access Network Discovery and Selection Function (ANDSF) Discovery". +- [38] IETF RFC 5448 (May 2009): "Improved Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)". +- [39] OMA-ERELD-DM-V1\_2: "Enabler Release Definition for OMA Device Management". +- [40] Void +- [41] "Unicode 5.1.0, Unicode Standard Annex #15; Unicode Normalization Forms", March 2008. +. +- [42] 3GPP TS 33.220: "Generic Authentication Architecture (GAA); Generic bootstrapping architecture". +- [43] 3GPP TS 29.109: "Generic Authentication Architecture (GAA); Zh and Zn Interfaces based on the Diameter protocol". +- [44] 3GPP TS 33.222: "Generic Authentication Architecture (GAA); Access to network application functions using Hypertext Transfer Protocol over Transport Layer Security (HTTPS)". +- [45] 3GPP TS 31.102: "Characteristics of the Universal Subscriber Identity Module (USIM) application". +- [46] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [47] 3GPP TS 33.223: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push function". +- [48] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [49] IETF RFC 4739: "Multiple Authentication Exchanges in the Internet Key Exchange (IKEv2) Protocol". +- [50] 3GPP TS 29.274: "Tunnelling Protocol for Control plane (GTPv2-C)". +- [51] 3GPP TS 24.139: "3GPP System-Fixed Broadband Access Network Interworking; Stage 3". +- [52] 3GPP TS 24.109: "Bootstrapping interface (Ub) and network application function interface (Ua); Protocol details". +- [53] IETF RFC 2817 (May 2000): "Upgrading to TLS Within HTTP/1.1". +- [54] Void. +- [55] Void. +- [56] 3GPP TS 24.244: "Wireless LAN control plane protocol for trusted WLAN access to EPC". +- [57] IEEE Std 802.11-2016: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Specific requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [58] IEEE Std 802-2014: "IEEE Standard for Local and Metropolitan Area Networks: Overview and Architecture", 30th June 2014. +- [59] Void. +- [60] IETF RFC 4284 (January 2006): "Identity Selection Hints for the Extensible Authentication Protocol (EAP)". + +- [61] IEEE Std 802.1X™-2010: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Port-based Network Access Control". +- [62] IETF RFC 4282: "The Network Access Identifier". +- [63] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". +- [64] IETF RFC 7651 (September 2015): "3GPP IP Multimedia Subsystems (IMS) Option for the Internet Key Exchange Protocol Version 2 (IKEv2)". +- [65] 3GPP TS 33.310: "Network Domain Security (NDS); Authentication Framework (AF)". +- [66] 3GPP TS 23.380: "IMS Restoration Procedures". +- [67] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [68] 3GPP TS 23.161: "Network-Based IP Flow Mobility (NBIFOM); Stage 2". +- [69] 3GPP TS 24.161: "Network-Based IP Flow Mobility (NBIFOM); Stage 3". +- [70] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [70A] IETF RFC 4309 (December 2005): "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [70B] IETF RFC 7296 (October 2014): "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [71] IETF RFC 6696 (July 2012): "EAP Extensions for the EAP Re-authentication Protocol (ERP)". +- [72] IETF RFC 3948 (January 2005): "UDP Encapsulation of IPsec ESP Packets". +- [73] IETF RFC 2234 (November 1997): "Augmented BNF for Syntax Specification: ABNF". +- [74] IETF RFC 5279 (July 2008): "A Uniform Resource Name (URN) Namespace for the 3rd Generation Partnership Project (3GPP)". +- [75] IETF RFC 2474 (December 1998): "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [76] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [77] 3GPP TR 24.502: "Access to the 3GPP 5G Core Network (5GCN) via non-3GPP access networks". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +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]. + +**Access Network Discovery and Selection Function:** In this specification, Access Network Discovery and Selection Function (ANDSF) is a network element specified in 3GPP TS 23.402 [6]. Unless otherwise specified, the term ANDSF is used to refer to both Home and Visited ANDSF. + +**ANDSF rules:** In this specification, ANDSF rules refers to the set of ANDSF policies defined in 3GPP TS 24.312 [13] for WLAN access selection and traffic routing between E-UTRAN or UTRAN and WLAN. ANDSF rules can contain RAN validity conditions for RAN-assisted WLAN interworking. + +**Emergency session:** In this specification, an emergency session refers to an emergency PDN connection established in E-UTRAN and handed over to a S2a based cdma2000® HRPD access network, or an emergency PDN connection established over trusted or untrusted WLAN access, or an emergency PDN connection established in 3GPP access and handed over to trusted or untrusted WLAN access. + +**Equivalent home service provider:** In this specification, equivalent home service provider is a service provider that is equivalent to HPLMN in regard to service provider selection over WLAN. + +**Equivalent visited service provider:** In this specification, equivalent visited service provider is a service provider that is equivalent to the V-PLMN in regard to service provider selection over WLAN. + +**Home ANDSF:** In this specification, the Home ANDSF (H-ANDSF) is an ANDSF element located in the home PLMN of a UE. + +**Offload Preference Indicator (OPI):** In this specification, Offload Preference Indicator (OPI) is a bitmap (i.e. a one-dimensional bit array) that can be used by UEs in an E-UTRA or UTRA cell to determine when to move certain traffic (e.g. certain IP flows) to WLAN access or to 3GPP access. The meaning of each bit in this bitmap is operator specific and is not defined in 3GPP specifications. + +**Offloadable PDN connection:** In this specification, an offloadable PDN connection is a PDN connection, established in (or previously handed over to) 3GPP access, such that: + +- the WLAN offload indication information element (see 3GPP TS 24.301 [10] and 3GPP TS 24.008 [46]) last received for the PDN connection has the "offloading the traffic of the PDN connection via a WLAN when in S1 mode is acceptable" value and the UE is in S1 mode; or +- the WLAN offload indication information element (see 3GPP TS 24.301 [10] and 3GPP TS 24.008 [46]) last received for the PDN connection has the "offloading the traffic of the PDN connection via a WLAN when in UTRAN Iu mode is acceptable" value and the UE is in UTRAN Iu mode. + +**Preferred Service Providers List (PSPL):** In this specification, the Preferred Service Providers List refers to a prioritized list of service provider realms other than equivalent home service providers preferred by the UE's 3GPP home operator for WLAN. + +**Set of Access network discovery information:** In this specification, a set of Access network discovery information is the access network discovery information from a single ANDSF. + +**Set of Inter-system mobility policy:** In this specification, a set of Inter-system mobility policy is the inter-system policy information received from a single ANDSF. + +**Visited ANDSF:** In this specification, the Visited ANDSF (V-ANDSF) is an ANDSF element located in the visited PLMN of a UE. + +**RAN Assistance Information:** In this specification, RAN Assistance Information refers to the set of thresholds and parameters that can be provided by E-UTRAN or UTRAN to the UE for assisting WLAN access selection and traffic routing. The RAN assistance information can include 3GPP access thresholds, WLAN access thresholds, an Offload Preference Indicator (OPI) value and WLAN identifiers as defined in 3GPP TS 25.331 [14A] and 3GPP TS 36.331 [16B]. + +**RAN rules:** In this specification, RAN rules refers to the set of RAN assistance parameter and RAN steering command handling, access network selection and traffic steering procedures defined in 3GPP TS 36.304 [16], 3GPP TS 25.304 [14] and 3GPP TS 36.331 [16B] for the steering of traffic between E-UTRAN or UTRAN and WLAN associated with RAN-controlled LTE-WLAN interworking or RAN-assisted WLAN interworking. + +**Restrictive non-3GPP access network type I:** a non-3GPP access network forwarding IP packets of TCP connections initiated by a served UE, with destination port 443, and with destination address outside of the non-3GPP access network, and discarding IP packets of some or all other TCP connections initiated by the served UE, with destination address outside of the non-3GPP access network. + +**Restrictive non-3GPP access network type II:** a non-3GPP access network discarding IP packets of TCP connections initiated by a served UE, with destination address outside of the non-3GPP access network, where the non-3GPP access network contains HTTP proxy supporting HTTP CONNECT method for URIs with port 443 and with host outside of the non-3GPP access network. + +**Restrictive non-3GPP access network:** restrictive non-3GPP access network type I or restrictive non-3GPP access network type II. + +**Firewall traversal tunnel (FTT):** a TCP connection with TLS connection enabling passing of messages between UE in restrictive non-3GPP access network and ePDG. + +**Firewall traversal tunnel keep-alive time (FTT KAT):** a maximum time between two subsequent messages sent by UE in the firewall traversal tunnel. + +**Unauthenticated IMSI:** In this specification, the term "unauthenticated IMSI" or the term "IMSI is unauthenticated" is only pertinent to the network. The knowledge that a UE's IMSI is unauthenticated or that the UE has an unauthenticated IMSI, is not available to the UE. + +**WLAN Selection Policy (WLANS P):** In this specification, the WLAN Selection Policy is a set of operator-defined rules that determine how the UE selects/reselects a WLAN access network. + +**WLAN selection information:** In this specification, WLAN selection information refers to the information received from ANDSF including WLAN Selection Policy (WLANS P), rule selection information, Home Network Preference information and Visited Network Preference information as specified in 3GPP TS 24.312 [13]. + +**Visited PLMNs with preferred rules:** In this specification, visited PLMNs with preferred rules included in the rule selection information refers to a list of identifiers of visited PLMNs provided by HPLMN, so that the UE roaming in such visited PLMN prefers ISMP, ISRP or WLANS P rules provided by the visited PLMN over ISMP, ISRP or WLANS P rules provided the HPLMN. In ANDSF MO, the visited PLMNs with preferred rules correspond to the ANDSF/RuleSelectionInformation/VPLMNSwithPreferredRules interior node. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.122 [4] apply: + +- Acceptable cell** +- EHPLMN** +- Home PLMN** +- Limited service state** +- RPLMN** +- Visited PLMN** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.402 [6] apply: + +- IFOM capable UE** +- Inter-APN routing capable UE** +- Local Operating Environment Information** +- MAPCON capable UE** +- S2a** +- S2b** +- S2c** +- Non-seamless WLAN offload capable UE** +- Single-connection mode (SCM)** +- Transparent single-connection mode (TSCM)** +- Multi-connection mode (MCM)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 29.273 [17] apply: + +- STa** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.301 [10] apply: + +- Evolved packet core network** +- Evolved packet system** + +For the purposes of the present document, the following terms and definitions given in WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25] apply: + +- Network Access Provider** +- Network Service Provider** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 33.402 [15] apply: + +**External AAA server** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.312 [13] apply: + +**Active rule****Valid rule** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.003 [3] that relate to access to 3GPP evolved packet core via non-3GPP access networks, apply: + +**NAI****Alternative NAI****Decorated NAI****Emergency NAI****Fast-Reauthentication NAI****Pseudonym Identity****Root NAI** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.002 [2A] apply: + +**3GPP AAA Proxy****3GPP AAA Server** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.161 [68] apply: + +**NBIFOM****Routing Rule****UE-initiated NBIFOM****Network-initiated NBIFOM****Multi-access PDN connection** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.501 [76] apply: + +**N1 mode****PDU session ID** + +## 3.2 Abbreviations + +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]. + +| | | +|----------|-------------------------------------------------------------| +| AAA | Authentication, Authorization and Accounting | +| ACL | Access Control List | +| AKA | Authentication and Key Agreement | +| ANDSF | Access Network Discovery and Selection Function | +| ANDSF-SN | Access Network Discovery and Selection Function Server Name | +| ANID | Access Network Identity | +| ANQP | Access Network Query Protocol | +| APN | Access Point Name | +| DHCP | Dynamic Host Configuration Protocol | +| DM | Device Management | +| DNS | Domain Name System | +| DSCP | Differentiated Services Code Point | +| DSMIPv6 | Dual-Stack MIPv6 | +| eAN/PCF | Evolved Access Network Packet Control Function | +| EAP | Extensible Authentication Protocol | +| EPC | Evolved Packet Core | +| ePDG | Evolved Packet Data Gateway | +| EPS | Evolved Packet System | +| ERP | EAP Re-authentication Protocol | +| ESP | Encapsulating Security Payload | +| FQDN | Fully Qualified Domain Name | + +| | | +|---------|---------------------------------------------------| +| GAA | Generic Authentication Architecture | +| GBA | Generic Bootstrapping Architecture | +| HA | Home Agent | +| H-ANDSF | Home-ANDSF | +| HRPD | High Rate Packet Data | +| HSGW | HRPD Serving Gateway | +| IEEE | Institute of Electrical and Electronics Engineers | +| IFOM | IP Flow Mobility | +| IKEv2 | Internet Key Exchange version 2 | +| IARP | Inter-APN Routing Policy | +| IPMS | IP Mobility Mode Selection | +| ISMP | Inter-system Mobility Policy | +| ISRP | Inter-system Routing Policy | +| IANA | Internet Assigned Numbers Authority | +| I-WLAN | Interworking – WLAN | +| MAPCON | Multi Access PDN Connectivity | +| MCM | Multi-connection mode | +| MO | Management Object | +| NAI | Network Access Identifier | +| NAP | Network Access Provider | +| NBIFOM | Network-Based IP Flow Mobility | +| NBM | Network based mobility management | +| NSP | Network Service Provider | +| NSSAI | Network Slice Selection Assistance Information | +| NSWO | Non-Seamless WLAN Offload | +| OMA | Open Mobile Alliance | +| OPI | Offload Preference Indicator | +| PCO | Protocol Configuration Options | +| P-GW | PDN Gateway | +| PDU | Protocol Data Unit | +| PSPL | Preferred Service Provider List | +| QoS | Quality of Service | +| SCM | Single-connection mode | +| S-GW | Serving Gateway | +| S-NSSAI | Single NSSAI | +| SPI | Security Parameters Index | +| TFT | Traffic Flow Template | +| TSCM | Transparent single-connection mode | +| UE | User Equipment | +| UICC | Universal Integrated Circuit Card | +| V-ANDSF | Visited-ANDSF | +| W-APN | WLAN APN | +| WiMAX | Worldwide Interoperability for Microwave Access | +| WLAN | Wireless Local Area Network | +| WLANS | WLAN Selection Policy | +| WLCP | WLAN Control Protocol | +| WMF | WiMAX Forum | + +--- + +## 4 General + +### 4.1 Trusted and untrusted accesses + +The HPLMN operator of the EPC selects whether a connected non-3GPP IP access network is a trusted or untrusted IP access network. + +For a trusted non-3GPP IP access network the communication between the UE and the EPC is secure. For an untrusted non-3GPP IP access network the communication between the UE and the EPC is not trusted to be secure. + +For a trusted non-3GPP IP access network, all communication between the access network and the EPC is transferred over pre-established secure links. For an untrusted non-3GPP IP access network, to secure communication between the UE and the EPC: + +- a single IPSec tunnel needs to be established to the ePDG for all PDN connections when the UE accesses EPC via S2c is used; or +- an IPSec tunnel needs to be established with the same ePDG for each PDN connection when the UE accesses EPC via S2b is used. + +## 4.2 cdma2000® HRPD Access System + +The cdma2000® HRPD system is a wireless mobile system developed under the auspices of 3GPP2. The cdma2000® HRPD system and its access network subsystem is compliant with 3GPP2 X.S0057 [20] and 3GPP2 C.S0087 [21], which define the core network and air interface aspects, respectively. + +## 4.3 WiMAX Access System + +The WiMAX system is a wireless mobile broadband system developed under the auspices of the WMF and the IEEE. The WiMAX system and its access network subsystem are compliant with WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 2 [24]. The protocol architecture and signalling of the WiMAX system is specified in WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25] which supports the air interface defined in WiMAX Forum Mobile System Profile Release 1.0 Approved Specification Revision 1.4.0 [26] specifying selected profiles of IEEE Std 802.16e-2005 and IEEE Std 802.16-2004/Cor1-2005 [27] that are to be supported. The WiMAX access system correspond to the WiMAX Access Service Network (ASN) and to relevant interfaces, as defined in WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25]. + +## 4.3A WLAN + +WLAN is an access network developed under the auspices of IEEE Computer Society. WLAN is compliant with IEEE Std 802.11 [57], which define air interface aspects. + +IEEE Std 802.11 [57] defines Access Network Query Protocol (ANQP). A UE can receive from an AP ANQP-elements in response to an ANQP query. The ANQP query response is received in a generic advertisement service response frame or a protected management frame. + +Where needed, the current specification further describes the structure and contents of payload of ANQP-elements specified in IEEE Std 802.11 [57] (see annex H and annex I). + +## 4.4 Identities + +### 4.4.1 User identities + +The user identification shall be either the root NAI, or the decorated NAI, when the UE accesses the EPC via non-3GPP access networks, and gets authentication, authorization and accounting services from the EPC. + +For emergency services over WLAN: + +- if IMSI is not available (i.e. a UE without USIM), the IMEI shall be used for the identification, as user part of the emergency NAI and the UE shall use a specific domain in the realm part of the NAI as specified in 3GPP TS 23.003 [3]; or +- if the UE has an IMSI, it shall use the IMSI for the identification, as user part of the emergency NAI. + +NOTE 1: If the IMSI is unauthenticated on the network side and the network supports emergency session for unauthenticated IMSI, the IMEI is used for the identification on the network side (see subclause 6.4.3.1A). + +For handover of an emergency session from E-UTRAN to a S2a based cdma2000® HRPD access network, if IMSI is not available (i.e. a UE without USIM) or IMSI is unauthenticated, the IMEI shall be used for the identification, as part of the emergency NAI as defined. + +The UE's Mobile Identity IMEI or IMEISV is conveyed to the network (see subclause 6.4 and subclause 7) and used to enable consistent services for the UE accessing the network via non-3GPP access or to support the emergency services over WLAN for the unauthenticated UEs. + +NOTE 2: IMEI and IMEISV are untrusted identities stored on the UE. + +User identification in non-3GPP accesses may require additional identities that are out of the scope of 3GPP. + +IETF RFC 4187 [33] and 3GPP TS 23.003 [3] provide definitions for UE and user identities although they use slightly different terms. Similar terms are also used in 3GPP TS 33.402 [15]. The following list provides term equivalencies and describes the relation between various user identities. + +- The Root NAI is to be used as the permanent identity as specified in 3GPP TS 33.402 [15]. +- The Fast-Reauthentication NAI is to be used as the Fast-Reauthentication Identity or the re-authentication ID as specified in 3GPP TS 33.402 [15]. +- The Pseudonym Identity is to be used as the Pseudonym as specified in 3GPP TS 33.402 [15]. + +#### 4.4.2 Identification of IP Services/PDN connections + +For access to EPC the Access Point Name (APN) is used for identifying IP services/PDN connections. The detailed definition of APN as used for access to EPC is specified in 3GPP TS 23.003 [3]. APN is conveyed in the IKEv2 signaling during tunnel establishment when S2b interface is used for UE to access EPC. When UE accesses EPC via S2a using trusted WLAN access network, APN is conveyed in EAP-AKA' signaling for single-connection mode (SCM) or in WLAN Control Protocol (WLCP) signaling (see 3GPP TS 24.244 [56]) for multi-connection mode (MCM) + +#### 4.4.3 FQDN for ePDG Selection + +An ePDG Fully Qualified Domain Name (ePDG FQDN) is either provisioned by the home operator or constructed by UE in either the Operator Identifier FQDN format or the Tracking/Location Area Identity FQDN format as described in subclause 4.5.4.2 of 3GPP TS 23.402 [6], and used as input to the DNS mechanism for ePDG selection. + +The detailed format of this ePDG FQDN is specified in 3GPP TS 23.003 [3]. + +#### 4.4.4 Access Network Identity + +For access to EPC via S2a using a trusted non-3GPP access network, the UE uses the Access Network Identity (ANID) in the key derivation (see 3GPP TS 33.402 [15]). The handling of the Access Network Identity is described in subclause 6.4.2.4 and the generic format and specific values for the Access Network Identity are defined in subclause 8.1.1. + +#### 4.4.5 ANDSF Server Name + +The ANDSF Server Name (ANDSF-SN) is used for ANDSF discovery. The detailed rules are defined in subclause 6.8.2.2.1 and the format of the ANDSF-SN is specified in 3GPP TS 23.003 [3]. + +#### 4.4.6 Home Agent address(es) + +If DSMIPv6 is used, the Home Agent IPv6 address (and optionally an IPv4 address) are needed. Within this specification, Home Agent address(es) signalling via IKEv2 between the UE and the ePDG is defined in subclause 7.4.1. + +#### 4.4.7 Security Parameters Index + +The Security Parameters Index (SPI, see IETF RFC 4301 [30]) identifies uniquely a security association between the UE and the ePDG. For the case of NBM using S2b a one to one mapping between SPI and PDN connection applies. + +### 4.5 Fixed Broadband Access System + +The fixed broadband access system is a type of high-speed Internet access for multi-service broadband packet networking. The fixed broadband access system is specified by the Broadband Forum, including addressing interoperability, architecture and management. + +For support of fixed broadband access interworking, the EPC network procedures are specified in 3GPP TS 24.139 [51]. + +The UE procedures for support of fixed broadband access are specified in 3GPP TS 24.139 [51] and can be used when the EPC network uses the fixed broadband access interworking or the fixed broadband access convergence. + +The architecture of the fixed broadband access convergence is specified in 3GPP TS 23.203 [5A]. + +## 4.6 Restrictive non-3GPP access networks + +An untrusted non-3GPP access network can be a restrictive non-3GPP access network. When the UE is served by a restrictive non-3GPP access network, the UE and the ePDG follow the additional procedures described in the annex F. + +## 4.7 Provision and handling of local emergency numbers + +It is a UE implementation option to support the procedures of this subclause. + +Once the UE has a secure connection to a PLMN through non-3GPP access, the UE supports obtaining local emergency numbers by one of the following ways: + +- i) when the UE is connected to a PLMN through trusted non-3GPP access, the local emergency numbers is provided through ANQP, within the ANQP payload. The signalling protocol and methods for use of ANQP is as specified in IEEE Std 802.11 [57]. See also annex I; +- ii) when the UE is connected to a PLMN through untrusted non-3GPP access, local emergency numbers can be provided through DNS query. See annex J; or +- iii) when the UE is connected to a PLMN through untrusted non-3GPP access, local emergency numbers can be provided through IKEv2. See annex K. + +Upon receiving the local emergency numbers through any of the methods indicated above, the UE shall store the local emergency numbers: + +- a) if the Non-3GPP emergency number indicator within the Non-3GPP NW provided policies IE through registration procedures over 3GPP access is set to "use of non-3GPP emergency numbers permitted", and: + - if the UE is connected to a PLMN through non-3GPP access and also registered to same PLMN or different PLMN through 3GPP access in the same country, then provide these local emergency numbers to upper layers for the detection of UE initiated emergency call; + - if the UE is connected to a PLMN through non-3GPP access but is also registered to different PLMN through 3GPP access that is not in the same country, then do not use the received local emergency numbers; +- b) if the Non-3GPP emergency number indicator within the Non-3GPP NW provided policies IE through registration procedures over 3GPP access is set to "use of non-3GPP emergency numbers not permitted", or if no Non-3GPP NW provided policies IE was provided through registration procedures over 3GPP access, then: + - do not use the received local emergency numbers for the detection of UE initiated emergency call over 3GPP access; and +- c) if the UE: + - is connected to a PLMN through non-3GPP access; + - is not registered to any PLMN through 3GPP access; + - is not in limited service state camped on an acceptable cell of any PLMN through 3GPP access; and + - can determine that the MCC information of the local emergency numbers received over non-3GPP access corresponds to the country in which the UE is located; + +then, as an implementation option, provide these local emergency numbers to upper layers for the detection of UE initiated emergency call. + +NOTE: The UE determination of the country in which the UE is located, is UE implementation specific. + +The local emergency numbers, received in any of the methods indicated above: + +- are only valid in the country where these local emergency numbers were provided; +- replace only the stored local emergency numbers received over non-3GPP access, if any; +- shall be deleted when UE moves to a country different from where the local emergency numbers were received; and at switch off or removal of the USIM. + +## 4.8 Quality of service support + +### 4.8.1 General + +QoS differentiation may be supported for both trusted WLAN and untrusted WLAN. + +### 4.8.2 QoS differentiation in trusted WLAN + +#### 4.8.2.1 General + +For trusted WLAN, QoS differentiation may be supported if Multi-Connection mode (MCM) based access to EPC is used. + +#### 4.8.2.2 QoS signalling + +As part of EAP-AKA' authentication via TWAN, the UE and the TWAN first negotiates TWAN connection mode usage as described in subclause 6.4. + +During PDN connection establishment, the UE indicates to the TWAG whether WLCP multiple bearer PDN connectivity capability is supported or not, as specified in 3GPP TS 24.244 [56]: + +- if the UE does not indicate that WLCP multiple bearer PDN connectivity is supported, or if the UE indicates that WLCP multiple bearer PDN connectivity is supported but the TWAG does not support WLCP multiple bearer PDN connectivity, then QoS differentiation is not supported. Single point-to-point PDN connection is used to carry all S2a bearers traffic between the UE and TWAG; or +- if WLCP multiple bearer PDN connectivity is supported by both the UE and TWAN, then QoS differentiation is supported and multiple bearer PDN connectivity shall be used between the UE and TWAG: + - During PDN connection establishment, the TWAG shall establish a default WLCP bearer for the PDN connection. The default WLCP bearer remains established throughout the lifetime of the PDN connection; and + - The TWAG shall establish a separate WLCP bearer for each additional S2a dedicated bearer of the PDN connection using WLCP signalling as specified in 3GPP TS 24.244 [56]. Each WLCP bearer is associated with TFT and bearer level QoS (i.e. QCI, GBR and MBR) for one-to-one mapping between WLCP bearer and S2a bearer. The TWAG shall maintain the WLCP bearer to the S2a bearer mapping table. + +#### 4.8.2.3 QoS differentiation in user plane + +If WLCP multiple bearer PDN connectivity is used: + +- For uplink packets, the UE shall select WLCP bearer based on the uplink packet filters in the TFTs. If no match is found, the UE shall select the WLCP bearer that does not have any uplink packet filter assigned. If all bearers have been assigned an uplink packet filter, the UE shall discard the uplink data packet. The UE shall then use the QCI in WLCP bearer level QoS information to derive the DSCP value for uplink packets. The UE shall provide the user plane connection id to the lower layers to be used as the MAC address of the TWAG associated with the WLCP bearer. The TWAG shall then route the uplink packets to the corresponding S2a bearers based on the the WLCP bearer and the S2a bearer mapping table. + +NOTE 1: The UE can map QCI to DSCP value, for example, by using the mapping between standardized QCI values and Release 99 3GPP QoS parameter values specified in 3GPP TS 23.401 [4] table E.3, and the mapping between Release 99 3GPP QoS parameter values and DSCP values specified in IEEE Std. 802.11-2012 [57] table V-1. + +- For downlink packets, the PDN GW routes the packets to S2a bearers based on the downlink packet filters in the TFTs assigned to each of the S2a bearers. The TWAG then selects the corresponding WLCP bearer for the downlink packets based on the the WLCP bearer and the S2a bearer mapping table. The TWAG shall also use the QCI in WLCP bearer level QoS information to derive the DSCP value for downlink packets. The TWAG shall provide the user plane connection id to the lower layers to be used as the MAC address of the TWAG associated with the WLCP bearer. + +NOTE 2: The TWAG can map QCI to DSCP value, for example, by using the mapping between standardized QCI values and Release 99 3GPP QoS parameter values specified in 3GPP TS 23.401 [4] table E.3, and the mapping between Release 99 3GPP QoS parameter values and DSCP values specified in IEEE Std 802.11 [57] table R-1. + +#### 4.8.3 QoS differentiation in untrusted non-3GPP access + +For untrusted non-3GPP access, QoS differentiation is provided if the UE and the ePDG supports the IKEv2 multiple bearer PDN connectivity and the IKEv2 multiple bearer PDN connectivity is used in the PDN connection as defined in subclause 7.2.7 and subclause 7.4.6. + +--- + +## 5 Network Discovery and Selection + +### 5.0 General + +The following aspects are included when selecting an EPC network and routing traffic via the EPC network: + +- access network discovery and selection procedures as defined in subclause 5.1; +- EPC network selection as defined in subclause 5.2; and +- data traffic routing of IP flows as defined in subclause 5.4. + +If the UE perform reselection of the access network as defined in subclause 5.3 and the UE reselects to a different access network, the UE performs the second item and third item of the above bulleted list. + +### 5.1 Access network discovery and selection procedures + +#### 5.1.1 General + +If PLMN selection specified in 3GPP TS 23.122 [4] is applicable (e.g., at switch-on, recovery from lack of 3GPP coverage, or user selection of applicable 3GPP access technology), the PLMN selection to select the highest priority PLMN according to these specifications is performed before any access network discovery. Procedures for EPC selection over non-3GPP access are specified in subclause 5.2. In particular, for WLAN access, service provider selection function is specified in the WLAN specific procedures in subclause 5.2.3.2 + +In the access network discovery procedure the UE may get from the ANDSF information on available access networks in its vicinity. The UE may obtain this information by querying the ANDSF, and may use this information when determining the presence of operator preferred access networks. Determination of the presence of access networks requires using radio access specific procedures, which are not further described here. + +The UE determines the presence of several access networks and then selects between them. If a higher priority access network is found connected to the selected service provider or a higher priority service provider, the UE will attempt to attach via that access network. + +#### 5.1.2 Access network discovery procedure + +##### 5.1.2.1 Triggering the discovery of operator preferred access networks with the ANDSF + +The UE may initiate communications with the ANDSF for operator preferred access network discovery: + +- when conditions set up within the policies available in the UE are met; or + +- when a user requests for manual selection. + +NOTE 1: The minimum allowed time interval between two consecutive UE initiated requests towards the ANDSF can be set by operator policies. + +NOTE 2: The UE changing of access networks can override the minimum allowed time interval setting. + +### 5.1.2.2 Discovering availability of access networks + +The UE may apply the techniques specific to the non-3GPP access technologies to discover available non-3GPP access networks. Such techniques will not be further described here. + +In addition, the UE may signal to the ANDSF to obtain information on operator preferred access networks. The discovery of the ANDSF by the UE, the connection to the ANDSF by the UE and the signalling between the UE and the ANDSF are given in subclause 6.8. + +## 5.1.3 Access network selection procedure + +### 5.1.3.1 General + +The access network selection may be classified as inter-technology or intra-technology. + +The UE can use information received from ANDSF for inter-technology access network selection. + +If the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, the UE uses the information described in subclause 6.10.4 for inter-technology access network selection. + +Other mechanisms for inter-technology access network selection are out of scope of this specification. + +### 5.1.3.2 Specific intra-technology access network selection + +In this release of the specification the use of the following specific intra-technology access network selection procedures is specified. + +#### 5.1.3.2.1 cdma2000® HRPD access network selection + +The access network selection process for cdma2000® HRPD access networks shall follow 3GPP2 X.S0057 [20]. + +#### 5.1.3.2.2 WiMAX NAP selection + +The access network selection process for WiMAX which encompasses the NAP discovery and access, shall follow the WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25]. + +#### 5.1.3.2.3 WLAN selection + +##### 5.1.3.2.3.1 General + +The purpose of this procedure is to create a prioritized list of selected WLAN(s). + +The user preferences are used to select between the automatic WLAN selection procedure or the manual WLAN selection procedure. + +The UE shall determine the prioritized list of selected WLAN(s): + +- 1) if user preferences are present, in accordance with the manual mode WLAN selection procedure (see subclause 5.1.3.2.3.2); and +- 2) if user preferences are not present, in accordance with the automatic mode WLAN selection procedure (see subclause 5.1.3.2.3.3). + +The UE shall use the prioritized list of selected WLAN(s) to select the service provider in the procedure in subclause 5.2.3.2. + +##### 5.1.3.2.3.2 Manual mode WLAN selection + +The UE creates a prioritized list of selected WLAN(s). The creation of the prioritized list is implementation specific. + +### 5.1.3.2.3.3 Automatic mode WLAN selection + +If the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, then the selected WLAN(s) are WLAN(s) that fulfil the selection criteria with the highest priority configured in the active ANDSF WLANSP rule. + +If the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, then the selected WLAN(s) are WLAN(s) matching WLAN identifiers in an entry of the list of the WLAN identifiers received along with the move-traffic-to-WLAN indication as described in subclause 6.10.4. + +The UE determines the selected WLAN(s) according to the following steps: + +- 1) the UE shall construct prioritized list of available WLANs as follows: + - a) if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, the UE shall use the procedures specified in IEEE Std 802.11 [57] to discover the available WLANs. The UE may perform ANQP procedures as specified in IEEE Std 802.11 [57] to discover the attributes and capabilities of available WLANs. The UE shall compare the attributes and capabilities of the available WLANs with the highest priority selection criterion that has not been used yet in the active WLANSP rule, and construct a prioritized list of available WLANs that fulfil the selection criteria. If there are multiple highest priority selection criteria, it is up to the UE implementation which one to use. In particular, if: + - the group of selection criteria include the HomeNetworkIndication and it is set to "1" (see 3GPP TS 24.312 [13]); and + - the HomeNetworkPreference: + - i) does not include 3GPP\_RPLMN\_Preferred; or + - ii) includes 3GPP\_RPLMN\_Preferred and it is set to "0" (see 3GPP TS 24.312 [13]); + then a WLAN is included, if: + - the other selection criteria in the active WLANSP rule are met; and + - the domain name list (see IEEE Std 802.11 [57]) includes: + - i) the home domain name derived from its IMSI; or + - ii) any realm in the EquivalentHomeSPs as specified in 3GPP TS 24.312 [13]. + +The priority of a WLAN in the list is set to the WLAN priority defined in the *preferredSSIDlist* of the matching selection criteria. There may be one or more selected WLANs in the list; and + +- b) if the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, the UE shall use the procedures specified in IEEE Std 802.11 [57] to discover available WLANs. The UE shall construct a prioritized list of available WLANs and populate it with each discovered WLAN which matches all WLAN identifiers included in an entry of the list of the WLAN identifiers received along with the move-traffic-to-WLAN indication as described in subclause 6.10.4. The priority of a discovered WLAN in the prioritized list of available WLANs is decided by the UE in an implementation specific way; +- 2) if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, and if the following conditions are fulfilled: + - the UE supports the PDN connection establishment over WLAN using the applicable S2a procedures specified in 3GPP TS 23.402 [6]; + - the "S2a connection preference" indicator exists and indicates that PDN connection establishment over WLAN using the applicable S2a procedures specified in 3GPP TS 23.402 [6] is preferred; and + - one or more WLANs in the list constructed in step 1) is a trusted non-3GPP IP access network; + +then the UE considers the WLANs that have the highest priority and indicate the HPLMN or RPLMN in the PLMN list with S2a connectivity IE (see annex H) as the selected WLAN(s). + +Otherwise, the UE considers the WLAN(s) that has or have the highest priority as the selected WLAN(s). And + +NOTE 1: WLAN advertises PLMN(s) towards which the S2a connectivity is supported using ANQP-element "3GPP Cellular Network" with the PLMN List with S2a Connectivity IE in the payload, according to annex H. + +NOTE 2: Advertising S2a connectivity over a WLAN using EAP signalling is not supported in this version of the specification. + +3) if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, if there are no WLAN(s) selected in step 2), the UE may repeat the procedure from step 1) taking into consideration selection criteria with lower priority from the active WLANSF rule. + +NOTE 3: UE implementation can optimize the steps described above, e.g. by combining the ANQP procedures. + +## 5.2 EPC network selection over non-3GPP access + +### 5.2.1 General + +The following EPC network selection procedures over non-3GPP access are defined: + +- 1) WiMAX specific; +- 2) EPC network selection via cdma2000® HRPD access is given in 3GPP TS 23.122 [4] with any exceptions detailed in subclause 5.3.4; +- 3) WLAN specific procedures in clause 5 apply: the procedures detail selecting one or more WLANs and (subsequently) selecting one service provider offering services via the WLAN (see subclause 5.2.3.2). When the operator of the WLAN requires authentication and the authentication succeeds (see subclause 6.4 and 6.5.1), the UE follows the procedures defined for connecting with the EPC. When the UE is connected to EPC through WLAN access, the tunnel is set-up with the ePDG (as described in clause 7 of this document) using a root NAI as defined in 3GPP TS 23.003 [3] or with the HA (as described in 3GPP TS 24.303 [11]); and +- 4) generic EPC network selection for other access technologies not listed above. + +The UE performs the appropriate EPC selection procedure over non-3GPP access when the non-3GPP radio becomes enabled. If the UE needs to establish emergency session over untrusted access, the UE shall select an ePDG that supports emergency services as described in subclause 7.2.1 and 3GPP TS 23.402 [6]. + +NOTE: The UE can perform the appropriate EPC selection procedure over non-3GPP access based on other implementation-specific triggers, e.g. regaining non-3GPP access network coverage or connectivity. + +The UE can utilize information received from ANDSF to which EPCs an access network is connected as described in 3GPP TS 24.312 [13]. Additionally, any technology specific means can be employed to acquire such information, but these are out of scope of this specification. + +### 5.2.2 Generic EPC network selection procedure over non-3GPP access + +#### 5.2.2.1 Identification of the EPC + +The identification of EPC shall be based on one of the following: + +- PLMN-Id (i.e. pair of MCC+MNC), as specified in 3GPP TS 23.003 [3]; or +- Home/Visited Network Realm/Domain, as specified in 3GPP TS 23.003 [3]. + +#### 5.2.2.2 EPC network selection + +##### 5.2.2.2.1 UE selection modes + +Two modes of EPC network selection are defined, manual and automatic. The UE shall select the EPC network according to the selected operating mode. + +#### 5.2.2.2.2 Manual EPC network selection + +The UE shall present the list of available EPC networks, to which connectivity is provided through the selected non-3GPP access network, to the user. If UE's HPLMN or PLMNs equivalent to it are in this list, they shall be shown in the highest ranking order. The ordering of the rest of entries in the list is implementation dependent. If available, the UE should display names and/or realms/domains. + +If multiple equivalent HPLMNs are available, then the display order among them is UE implementation specific. + +#### 5.2.2.2.3 Automatic EPC network selection + +The UE may use locally stored data for selecting between EPC networks available for connectivity via the currently selected non-3GPP access network. + +The UE shall select a PLMN according to the PLMN selection procedures of the selected non-3GPP access network. + +Additional criteria are out of scope of this specification and remain implementation specific. + +### 5.2.3 Access technology specific EPC network selection procedures + +#### 5.2.3.1 EPC network selection procedures for WiMAX + +##### 5.2.3.1.1 Identification of the EPC by the WiMAX access network + +With WiMAX as a non-3GPP access network, the WiMAX NSP is mapped onto the EPC network operator. The NSP indication can be provided to the UE in accordance to WiMAX Forum Network Architecture Release 1.0 version 1.2 [25]. The WiMAX access network should advertise the NSP identity of the EPC in the MCC, MNC format. + +##### 5.2.3.1.2 EPC network selection + +###### 5.2.3.1.2.1 UE selection modes + +There are two modes of network selection, namely, manual network selection and automatic network selection. The UE shall follow one of the following two procedures depending on its operating mode. + +###### 5.2.3.1.2.2 Manual EPC network selection + +The manual network selection for WiMAX access shall follow the WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25] with the following exceptions and additions: + +- When presenting the list of available networks for user selection, the UE shall provide the network name of the related MCC + MNC pair. If that is not possible, the UE shall provide the MCC + MNC pair; and +- If the UE is unable to register to the user selected NSP, further UE action is implementation dependent. + +###### 5.2.3.1.2.3 Automatic EPC network selection + +The automatic network selection for WiMAX access shall follow the WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25] without any exceptions or additions. + +#### 5.2.3.2 EPC network selection procedures for WLAN + +##### 5.2.3.2.1 UE selection modes + +There are two modes of service provider selection, namely, manual service provider selection and automatic service provider selection. + +The UE follows one of the following two procedures defined in subclause 5.2.3.2.2 and 5.2.3.2.3 depending on its implementation. + +The service provider selected in accordance with these procedures determines the WLAN that is selected. When the selected WLAN is a trusted WLAN IP access and the UE decides to access EPC via S2a using trusted WLAN IP access, the UE shall derive a NAI from the identity of the selected service provider and use the NAI as the identity for authentication and authorization with the service provider and usage of the WLAN (see subclause 6.4). + +#### 5.2.3.2.1A Service provider solicitation + +The UE shall determine which service providers are available from the available list of WLANs as constructed using the WLAN selection procedure described in subclause 5.1.3.2.3 using following procedures: + +- i) the UE selects a WLAN from the list of selected WLAN(s) constructed using the WLAN selection procedure described in subclause 5.1.3.2.3; +- ii) if the WLAN selected in step i): + - a) supports ANQP specified in IEEE Std 802.11 [57] and if the UE did not obtain a list of realms using ANQP in subclause 5.1.3.2.3.3 item 1, the UE sends an ANQP request for a list of realms (i.e. ANQP-elements "NAI Realm") and/or PLMN identities (i.e. ANQP-element "3GPP Cellular Network"); and + +NOTE 1: The UE uses procedures defined in IEEE Std 802.11 [57] to determine if the WLAN supports ANQP and to send the ANQP query request for ANQP-elements "NAI Realm" and/or "3GPP Cellular Network", as specified in IEEE Std 802.11 [57]. + +- b) does not support ANQP (see IEEE Std 802.11 [57]) or the UE does not receive a list of realms in item a), an EAP-Request/Identity is received and the EAP-request/Identity does not include one or more of realms and/or PLMN identities of service providers (encoded in accordance with IETF RFC 4284 [60]), the UE supports IEEE 802.1x authentication (see IEEE Std 802.1X™-2010 [61]), the UE shall request a list of realms and/or PLMN identities of service providers interworking with that WLAN by sending the EAP-Response/Identity message including as identity the alternative NAI; and + +- iii) the UE repeats this procedure for all WLANs from the available list of WLANs as constructed using the WLAN selection procedure described in subclause 5.1.3.2.3. + +NOTE 2: The list with realms and/or PLMN identities of service providers received in accordance with procedures in IETF RFC 4284 [60], is of limited size and might not contain all the realms and/or PLMN identities of service providers available via the WLAN. + +The UE shall convert any received PLMN identities into PLMN realms using the rules defined in 3GPP TS 23.003 [3]. + +#### 5.2.3.2.2 Manual Service Provider selection mode procedure + +The UE indicates to the user the service providers which are available for WLAN. The UE may obtain the service providers available for WLAN using procedures as described in subclause 5.2.3.2.1A. The UE will select the service provider based on the user preference. + +#### 5.2.3.2.3 Automatic mode service provider selection procedure + +The purpose of this procedure is to: + +- select a service provider over WLAN; and +- construct a NAI for use with authentication signalling with the selected service provider in order for the UE to be authorised to use the WLAN. + +If the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2: + +- if the RPLMN or an equivalent PLMN (see 3GPP TS 24.301 [10] or 3GPP TS 24.008 [46]) is available as described in subclause 5.2.3.2.1A via a WLAN from the selected WLAN(s) constructed using the WLAN selection procedure described in subclause 5.1.3.2.3, the highest priority service provider is the RPLMN or an equivalent PLMN (see 3GPP TS 24.301 [10] or 3GPP TS 24.008 [46]); +- if the RPLMN and an equivalent PLMN (see 3GPP TS 24.301 [10] or 3GPP TS 24.008 [46]) are not available as described in subclause 5.2.3.2.1A via a WLAN from the selected WLAN(s) constructed using the WLAN selection procedure described in subclause 5.1.3.2.3 and Home PLMN or an EHPLMN is available, the highest priority service provider is Home PLMN or an EHPLMN; and +- if the RPLMN, an equivalent PLMN (see 3GPP TS 24.301 [10] or 3GPP TS 24.008 [46]), Home PLMN and an EHPLMN are not available as described in subclause 5.2.3.2.1A via a WLAN from the selected WLAN(s) constructed using the WLAN selection procedure described in subclause 5.1.3.2.3, the highest priority service provider is a PLMN selected in an implementation-dependent way. + +If the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, a service provider is the highest priority service provider if the service provider is available via a WLAN from the selected WLAN(s) constructed using the WLAN selection procedure described in subclause 5.1.3.2.3 and if: + +- i) the service provider is selected in item 3; or +- ii) the conditions in item 3 are not met, and: + - the service provider is the HPLMN; + - the service provider is an equivalent home service provider (i.e. the service provider's realm matches a realm in the EquivalentHomeSPs as specified in 3GPP TS 24.312 [13]); or + - no WLAN of the selected WLAN(s) provides access to a higher priority service provider. + +Until the highest priority service provider is found, the UE shall verify if a service provider available over a WLAN of the selected WLAN(s) is the highest priority service provider: + +- 1) Void +- 2) Using the service providers which are available for WLAN as described in subclause 5.2.3.2.1A, the UE uses the PLMN realms as the service provider realms in the remaining steps of this subclause. +- 3) If the following conditions are fulfilled: + - the "3GPP RPLMN preferred" indicator is configured to prioritize 3GPP RPLMN; and + - the realm of the RPLMN or the realm of an equivalent visited service provider included in the EquivalentVisitedSPs as specified in 3GPP TS 24.312 [13] is included in the list of realms created in subclause 5.2.3.2.1A, step ii); + +then the UE shall select the RPLMN or the equivalent visited service provider. The RPLMN shall be selected with higher priority than the equivalent visited service provider. If the RPLMN is selected, the UE shall convert the RPLMN identity into selected PLMN realm using the rules defined in 3GPP TS 23.003 [3] and use it as the service provider realms in the remaining steps of this subclause. + +- 4) if the condition in step 3) is not satisfied, the UE shall select a service provider in the following order: + - i) HPLMN matching a realm in the list of realms received in step ii) as described in subclause 5.2.3.2.1A; + - ii) realm found both in the list of realms received in step ii) as described in subclause 5.2.3.2.1A and in the EquivalentHomeSPs as specified in 3GPP TS 24.312 [13]; and + - iii) realm found both in the list of realms received in step ii) as described in subclause 5.2.3.2.1A and in the PSPL as specified in 3GPP TS 24.312 [13] with the priority higher than any other service provider's priority indicated as available via the WLAN. + +If a UE used the procedures in IETF RFC 4284 [60] (see subclause 5.2.3.2.1A) to obtain a list of service providers, then the UE is only required to select the HPLMN (if available) or an available equivalent home service provider. + +NOTE 1: A UE using procedures in IETF RFC 4284 [60] to obtain a list of service providers is only required to select the HPLMN (if available) or an available equivalent home service provider. If the UE selects another service provider, the UE could be roaming even though the HPLMN or equivalent home service provider is available at the access point. + +The UE shall select the WLAN providing access to the highest priority service provider. + +If a highest priority service provider could not be determined, the UE proceeds in implementation-dependent way. + +The UE shall construct a NAI for authentication with the highest priority service provider as described in 3GPP TS 23.003 [3]. Specifically, the UE constructs the: + +- a) root NAI corresponding to the HPLMN, if the highest priority service provider is the HPLMN advertised using a PLMN identity; + +- b) decorated NAI with double decoration including the realm of the highest priority service provider and the realm of the RPLMN, if the highest priority service provider is an equivalent visited service provider; or +- c) decorated NAI including the realm of the highest priority service provider, otherwise. + +NOTE 2: UE implementation can optimize the steps described above, e.g. by combining the ANQP procedures described in subclause 5.2.3.2.1A with the ANQP procedures in subclause 5.1.3.2.3.3. + +## 5.3 Access Network reselection + +### 5.3.1 General + +The network reselection procedure shall be executed based on the user's request or the operator's policy. Such operator policy for supporting network reselection can be provided by the ANDSF or can be pre-provisioned in the UE. + +### 5.3.2 UE procedures + +The UE may retrieve information from ANDSF, which includes available access network and operator's policy as specified in subclause 6.8.2. + +The information which is retrieved from the ANDSF shall not impact the PLMN selection and reselection procedures specified in 3GPP TS 23.122 [4]. For WLAN access, the UE configured with a WLANSP rule specified in 3GPP TS 24.312 [13], shall use the access network selection procedure and a PLMN selection procedure defined in this document which are different from and shall not be used in conjunction with the procedures for I-WLAN access specified in 3GPP TS 24.234 [9]. + +The network reselection procedure can be in automatic mode or manual mode dependent on UE configuration settings. For WiMAX access, the manual mode reselection shall follow the behaviour described in subclause 5.2.3.1.2.2 and the automatic mode reselection shall follow the behaviour described in subclause 5.2.3.1.2.3. + +If the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, if the UE receives move-traffic-to-WLAN indication, along with the list of the WLAN identifiers as described in subclause 6.10.4, the UE shall perform the procedure in subclause 6.10.4. + +### 5.3.3 EPC procedures + +The ANDSF shall send available access network(s) and operator's policy to the UE in response to the UE's request or based on the network triggers as specified in subclause 6.8.2. + +### 5.3.4 Periodic EPC network reselection attempts + +In automatic mode, when UE is not in its HPLMN or one of its equivalent HPLMNs, the UE shall make a periodic attempt to return to its HPLMN or one of its equivalent HPLMNs. For this purpose the timer value given in the EFHPLMN as defined in 3GPP TS 31.102 [45] shall be used with the following exceptions:- + +- For UE accessing the EPC via cdma2000® HRPD access networks, the UE's search for a more preferred system shall abide by the parameters and procedures defined in 3GPP2 C.S0016 [23a]. +- For UE accessing the EPC via WiMAX access networks, the time period between periodic network searches is implementation specific. +- For UE accessing the EPC via any other non-3GPP access networks, unless the UE has availability to EFHPLMN, the time period between periodic network searches is implementation specific but shall not be less than 30 minutes. + +--- + +## 5.4 Data traffic routing of IP flows + +### 5.4.1 General + +In regards to the routing of IP flows, 3GPP TS 23.402 [6] defines the following UE capabilities: IFOM capability, inter-APN routing capability, NSWO capability and MAPCON capability. Any of these capabilities can be enabled and disabled via UE configuration means outside of the scope of this document. A capability that exists and has not been + +disabled is considered as supported. A capability that does not exist or the existing capability that has been disabled is considered as not supported. + +A UE can have several sets of information about access technologies or access networks or both to assist in determining the data traffic routing of IP flows. These sets of information are: + +- the Inter-APN Routing policies. The IARP can be statically provisioned in the UE. Additionally, the IARP can be provided by the H-ANDSF. The UE shall ignore the IARP received from the V-ANDSF; +- the Inter-System Routing policies. The ISRP can be statically provisioned in the UE or it can be provided by the H-ANDSF or the V-ANDSF or both; +- the Local Operating Environment Information. The Local Operating Environment Information can be optionally generated by the UE locally and the contents of Local Operating Environment Information is implementation dependant; +- user preference settings; +- the RAN assistance information (including OPI); +- the measurements corresponding to the thresholds in the RAN assistance information; and +- indications received from access stratum as described in subclause 6.10.4. + +This clause describes the relationship amongst these information sets and how they are used in order to route data traffic of IP flows. The Local Operating Environment Information does not apply to MAPCON rules in this version of the specification. + +## 5.4.2 Access technology or access network selection + +### 5.4.2.1 ANDSF rules control the WLAN access selection and traffic routing + +This subclause applies if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2. + +When selecting the access technologies or access networks or both to route the data traffic of IP flows: + +- 1) if a UE supporting IFOM or non-seamless WLAN offload is provided with user preferences and has IARP rule for NSWO, ISRP or Local Operating Environment Information or any combination of them, the user preference settings shall take precedence over IARP rule for NSWO (if present), ISRP (if present) and Local Operating Environment Information (if present). +- 2) if a UE supporting IFOM or non-seamless WLAN offload has IARP rule for NSWO, ISRP and Local Operating Environment Information and no user preference settings and if based on the content of Local Operating Environment the UE decides that an access technology or access network or both do not meet implementation specific criteria for routing data traffic of a specific IP flow, the UE may exclude that access technology or access network or both when deciding on the routing of the data traffic for those IP flows. +- 3) if a UE supporting IFOM or non-seamless WLAN offload having Local Operating Environment Information but no available ISRP, IARP rule for NSWO and no user preference settings, the UE may evaluate the available access technologies or access networks against the Local Operating Environment Information. + +When a UE supporting MAPCON selects the access technologies or access networks or both, to route the data traffic of a specific APN, the user preference settings shall take precedence over ISRP (if present) and IARP rule (if present). + +The user preference settings shall take precedence over IARP (if present). + +### 5.4.2.2 RAN rules control the WLAN access selection and traffic routing + +Access technology or access network selection procedures in subclause 6.10.4 apply if the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2. + +## 6 UE – EPC Network protocols + +### 6.1 General + +### 6.2 Trusted and Untrusted Accesses + +#### 6.2.1 General + +For a UE, the trust relationship of a non-3GPP IP access network is determined by the home PLMN operator. That trust relationship is indicated to the UE via the following methods: + +- Pre-configured policies in the UE by the home PLMN operator. +- Dynamic indication during 3GPP-based access authentication. + +For a trusted non-3GPP IP access network, the UE shall follow the access methods given in subclause 6.4. For an untrusted non-3GPP IP access network, the UE shall follow the access methods given in subclause 6.5. + +If the dynamic trust relationship indication is received during 3GPP-based access authentication, the UE shall rely on the dynamic trust relationship indication. Otherwise the UE shall follow the pre-configured policies for a specific non-3GPP access network. If no dynamic indicator is received, and no pre-configured policy matches a specific non-3GPP access network where the UE attempts to access, the UE shall follow the procedure defined in subclause 6.2.4. + +#### 6.2.2 Pre-configured policies in the UE + +The following types of policies can be pre-configured on the UE by the home PLMN operator: + +- Pre-configured trust relationship policies for specific non-3GPP access technologies and/or PLMNs. For example, the UE may be configured to use the procedures for trusted access networks as described in subclause 6.4 as follows: + - an access network of access technology X1 from PLMN Y1 is trusted; and/or + - any access network of access technology X2 is trusted; and/or + - any access network from PLMN Y2 is trusted; and/or + - any access network is trusted. + +The format of the pre-configured policies is not specified in this release of this specification. + +#### 6.2.3 Dynamic Indication + +If the UE performs 3GPP-based access authentication, the 3GPP AAA server may send a trust relationship indicator of the non-3GPP access network to the UE during the EAP-AKA, EAP-AKA' or EAP-3GPP-LimitedService based access authentication (i.e. EAP-AKA, EAP-AKA' or EAP-3GPP-LimitedService) as specified in 3GPP TS 33.402 [15]. If non-3GPP access network is trusted, the 3GPP AAA server shall send this trust relationship indicator as specified in 3GPP TS 29.273 [17]. The indicator is sent using a AT\_TRUST\_IND attribute, by extending the EAP-AKA (and EAP-AKA' and EAP-3GPP-LimitedService) protocol as specified in subclause 8.2 of IETF RFC 4187 [33]. This attribute is provided in EAP-Request/AKA-Challenge or EAP-Request/AKA'-Challenge or EAP-Request/3GPP-LimitedService-Init-Info message payload respectively. The detailed coding of this attribute is described in subclause 8.2.3.1. + +#### 6.2.4 No trust relationship information + +If no dynamic indicator is received, and no pre-configured policies matches a specific non-3GPP access network where the UE attempts to access, the UE shall consider it as untrusted network and operate based on subclause 6.5. + +## 6.3 IP Mobility Mode Selection + +### 6.3.1 General + +The IP mobility mechanisms supported between 3GPP and non-3GPP accesses within an operator and its roaming partner's network may be based on either: + +- a) Static Configuration; or +- b) Dynamic Configuration. + +The choice between a) and b) depends upon operators' preferences or roaming agreement or both. + +### 6.3.2 Static configuration of inter-access mobility mechanism + +For networks deploying a single IP mobility management mechanism, the statically configured mobility mechanism can be access type or roaming agreement specific or both. The information about the mechanism to be used in such scenario is expected to be provisioned into the terminal and the network. + +In static configuration, if there is a mismatch between the IP mobility mode mechanism parameters pre-configured in the network and in the UE, the UE may not be able to access the EPC. If the UE is able to access the EPC even if there is a mismatch between the IP mobility mode mechanisms, the network may not be able to provide session continuity for the UE. More details of the possible cases of mismatch between the IP mobility mode mechanism are described in the informative annex D. + +If the network is configured with a static mobility mechanism and the AAA server implements protocol extensions for a dynamic IP Mobility Mode Selection (IPMS) exchange, the AAA server shall send to the UE an AT\_RESULT\_IND attribute during the authentication procedure as it is described in subclause 6.3.3.1.2. + +### 6.3.3 Dynamic configuration of inter-access mobility mechanism + +#### 6.3.3.0 General + +Dynamic IP Mobility Mode Selection (IPMS) consists of: + +- IP mobility management protocol selection between Network Based Mobility (NBM), DSMIPv6 or MIPv4; and +- Decision on IP address preservation if NBM is selected + +Upon initial attachment to a non-3GPP access and upon handoff to non-3GPP accesses, the UE performs IPMS by providing an indication during network access authentication for EPC. For trusted access, the indication is provided before an IP address is allocated to the UE, while in untrusted access network, the indication is provided during IKEv2 signalling for IPSec tunnel establishment with the ePDG. + +When the UE provides an explicit indication for IPMS, then the network shall provide the indication to the UE identifying the selected mobility management mechanism. + +When the dynamic IP mobility mode selection is used if the UE does not receive any indication of a selected mobility protocol after the UE provided an explicit indication, it is considered as an abnormal case and the UE may not get connectivity to the EPC. + +NOTE: The scenarios for mobility mode selection are described in subclause 4.1.3 of 3GPP TS 23.402 [6]. + +#### 6.3.3.1 IPMS indication + +##### 6.3.3.1.1 IPMS indication from UE to 3GPP AAA server + +During network access authentication, UE may provide an explicit indication to the 3GPP AAA server about the supported mobility protocol by using an attribute in the EAP-AKA and EAP-AKA' protocols, to extend these protocols as specified in subclause 8.2 of IETF RFC 4187 [33]. This attribute is provided in EAP-Response/AKA-Challenge and corresponding EAP-AKA' message payload. + +The UE may provide the indication for IPMS using AT\_IPMS\_IND attribute in EAP-AKA or EAP-AKA' if the UE receives the AT\_RESULT\_IND attribute within the EAP-Request/AKA-Challenge message, or the + +EAP-Request/AKA'-Challenge message (when EAP-AKA' is used). If the UE provides the AT\_IPMS\_IND attribute within the EAP-Response/AKA-Challenge message payload or within the EAP-Response/AKA'-Challenge message payload (when EAP-AKA' is used), the UE shall also provide the AT\_RESULT\_IND attribute within the message. + +If the UE supports IPMS indication, it shall indicate support for one or more mobility protocols in AT\_IPMS\_IND attribute as follows: + +- the UE shall indicate support for DSMIPv6 if the UE supports DSMIPv6; and +- the UE shall indicate support for MIPv4 if the UE supports MIPv4; and +- during initial attach, the UE should indicate support for NBM if the UE supports address preservation based on NBM between the access it is attaching to and all other accesses that the UE supports.; or +- upon handover, the UE shall indicate support for NBM if the UE supports address preservation based on NBM while moving from source access network to target non-3GPP access network that the UE is attaching to. + +NOTE: The UE can be configured not to use IPMS indication, e.g. the UE is DSMIP capable only. + +If the UE does not support any mobility protocol then the UE shall not send the AT\_IPMS\_IND attribute to the 3GPP AAA server. + +The preference of protocol may be indicated based on the policies configured on the UE. The detailed coding of this attribute is described in subclause 8.2.1.1. + +#### 6.3.3.1.2 IPMS indication from 3GPP AAA server to UE + +A 3GPP AAA server supporting IPMS shall include the AT\_RESULT\_IND attribute within the EAP-Request/AKA-Challenge and corresponding EAP-AKA' message payload. + +If the UE provided an explicit indication as described in subclause 6.3.3, the 3GPP AAA server shall inform the UE of its decision on the mobility protocol and IP preservation mode by invoking an EAP-Request/AKA-Notification dialogue when EAP-AKA is used or an EAP-Request/AKA'-Notification dialogue when EAP-AKA' is used. + +On selecting the mobility protocol based on UE indication, access network capabilities and network policies, the 3GPP AAA server shall indicate the selected protocol to the UE by using the AT\_IPMS\_RES attribute. If the 3GPP AAA server does not receive any indication from the UE but knows the UE's policies allow the usage of NBM and knows the home and access network supports NBM, the network shall use NBM shall be used for providing connectivity to the UE. + +If the AT\_IPMS\_RES attribute indicates DSMIPv6 then the UE shall follow the procedures defined in 3GPP TS 24.303 [11]. + +If the AT\_IPMS\_RES attribute indicates MIPv4 support, then the UE shall follow the procedures defined in 3GPP TS 24.304 [12]. + +The detailed coding of this attribute is described in subclause 8.2.1.2. + +## 6.4 Authentication and authorization for accessing EPC via a trusted non-3GPP access network + +### 6.4.1 General + +For access to the EPC via a trusted non-3GPP access network, a connection shall be established between the UE and the trusted non-3GPP access network using signalling procedures specific to the trusted non-3GPP access network, which are out of scope of this present document. + +Access authentication signalling for access to the EPC shall be executed between the UE and 3GPP AAA server to ensure mutual authentication of the user and the EPC, with the exception of UEs without IMSI (see subclauses 4.4.1 and 6.6.3.2) or UEs initiating emergency session but whose IMSI authentication cannot proceed. Such authentication is based on IETF protocols as specified in 3GPP TS 33.402 [15]. + +EAP-AKA' is used for access authentication in the trusted access network, according to 3GPP TS 33.402 [15], subclause 6.2. According to 3GPP TS 33.402 [15], subclause 6.1, EAP-AKA' can be skipped if conditions listed in subclause 9.2.2.1 or conditions described in subclause 13.4 of 3GPP TS 33.402 [15] are met. + +If the access network does not support EAP-AKA or EAP-AKA' and the UE considers the access network as trusted, the UE shall access to the EPC only via S2c and any authentication method (EAP-based or otherwise) can be used for access authentication as long as the criteria set in 3GPP TS 33.402 [15], subclause 9.2.2.1 are met. + +When the UE decides to access EPC via S2c using non-3GPP IP access, EAP-AKA authentication is performed between the UE and the PDN-GW as specified in 3GPP TS 24.303 [11] and 3GPP TS 33.402 [15]. + +The UE may support ERP as described in IETF RFC 6696 [71] and 3GPP TS 33.402 [15]. In this release of this specification, only the ERP Implicit Bootstrapping mode defined in IETF RFC 6696 [71] is supported. + +After a UE successfully completes authentication and authorization for accessing EPC via the trusted non-3GPP access network, the UE may receive as part of an ANQP query to the access point, an ANQP-element in a protected frame with management frame protection enabled. If the ANQP-element is an Emergency Call Number ANQP-element encoded in accordance with Annex I, the UE considers the content of the Emergency Call Number field valid. + +## 6.4.1A TWAN connection modes + +As part of EAP-AKA' authentication via TWAN or EAP-3GPP-LimitedService authentication via TWAN, the UE and the network can negotiate usage of either the single-connection mode (SCM) or the multi-connection mode (MCM) as described in 3GPP TS 23.402 [6]. + +NOTE: UE requesting neither SCM nor MCM acts in transparent single-connection mode (TSCM). No UE extensions are needed for TSCM. + +The negotiation consists of the following steps: + +- a) The 3GPP AAA server indicates support of TSCM, SCM, MCM or any combination of them as described in subclause 6.4.3.5. +- b) The UE requests usage of SCM or MCM as described in subclause 6.4.2.6.2 and subclause 6.4.2.6.3, acts in TSCM or aborts the EAP authentication as described in subclause 6.4.2.6.4. +- c) The 3GPP AAA server either accepts or rejects the UE request as described in subclause 6.4.3.5. + +If EAP-AKA' authentication is skipped during emergency call via TWAN for unauthenticated UEs and the EAP-3GPP-LimitedService authentication via TWAN is performed, the UE and the network can negotiate usage of either the single-connection mode (SCM) or the multi-connection mode (MCM) as follows: + +- a) The 3GPP AAA server indicates support of SCM, MCM or any combination of them as described in subclause 6.4.3.5.1A. +- b) The UE requests usage of SCM or MCM as described in subclause 6.4.2.6.2A and subclause 6.4.2.6.3A, or aborts the EAP authentication as described in subclause 6.4.2.6.4. +- c) The 3GPP AAA server either accepts or rejects the UE request as described in subclause 6.4.3.5. + +## 6.4.2 UE procedures + +### 6.4.2.1 Identity Management + +The user identities to be used by the UE in the authentication and authorization for accessing EPC via a trusted non-3GPP access are the Root-NAI (permanent identity), decorated NAI, Fast-Reauthentication NAI (Fast-Reauthentication Identity) and Pseudonym Identity and these identities are described in subclause 4.4. + +If the UE supports ERP, the identity to be used by the UE during the re-authentication procedure using ERP is the "KeyName-NAI" as described in 3GPP TS 23.003 [3]. + +#### 6.4.2.1A Identity Management - emergency session + +When initiating emergency session via trusted non-3GPP access, if the UE has no valid subscriber data available (USIM not available, or USIM is considered invalid by the UE), the UE shall provide its IMEI in an EAP Response/Identity message based on emergency NAI format specified in 3GPP TS 23.003 [3]. + +If the UE receives EAP-Request/3GPP-LimitedService-Init-Info message from the network requesting IMEI, the UE provides IMEI as specified in subclause 6.4.2.7. + +#### 6.4.2.2 EAP-AKA and EAP-AKA' based Authentication + +The UE shall support EAP-AKA based authentication as specified in IETF RFC 4187 [33] and EAP-AKA' based authentication as specified in IETF RFC 5448 [38]. 3GPP TS 33.402 [15] specifies the conditions under which one or the other of these two methods is used. + +During network access authentication, the UE may provide an explicit indication for IPMS by adding an attribute in the EAP-AKA or EAP-AKA' payload as defined in subclause 6.3.3. + +During network access authentication, the 3GPP AAA server may provide the ANID to the UE, see subclause 6.4.2.4. + +For WLAN access, after the UE has been successfully authenticated from WLAN, if the UE receives EAP-Request/AKA'-Notification dialogue with AT\_NOTIFICATION attribute value 1031 "User has not subscribed to the requested service" as defined in IETF RFC 4187 [33], the UE shall not initiate the EPC access procedure to the same WLAN until switching off or the UICC containing the USIM is removed. + +NOTE: Switching off and USIM change conditions are implemented taking into consideration the user experience aspect. + +#### 6.4.2.3 Full Authentication and Fast Re-authentication + +The UE shall support both full authentication and fast re-authentication for EAP AKA as specified in IETF RFC 4187 [33] and for EAP-AKA' as specified in IETF RFC 5448 [38]. + +Full authentication is performed to generate new keys. The initial authentication shall be a full authentication as specified in 3GPP TS 33.402 [15]. For a full authentication either the Permanent Identity or the Pseudonym Identity is used. + +According to 3GPP TS 33.402 [15] the fast re-authentication procedure uses the Fast Re-authentication Identity and is used for renewing the session keys. + +The Permanent Identity is based on the IMSI of the UE. The Fast Re-authentication Identity is provided to the UE by the 3GPP AAA server during the previous authentication procedure. The UE shall use the Fast Re-authentication Identity only once. A Pseudonym Identity provided to the UE by the 3GPP AAA Server during a previous authentication procedure can be reused in later authentications until the UE receives a new Pseudonym identity from the 3GPP AAA Server. + +NOTE: The 3GPP AAA Server will assign a new Pseudonym Identity with a frequency dictated by operator's policy. The allocation of new pseudonyms is required to prevent that the user's movements are tracked by an unauthorized party. + +If during an authentication request, the UE receives an EAP-Request/AKA-Identity message containing AT\_PERMANENT\_ID\_REQ, the UE shall return the Permanent Identity in the AT\_IDENTITY attribute of the EAP-Response/AKA\_Identity. If the UE receives an EAP-Request/AKA'-Identity message containing AT\_PERMANENT\_ID\_REQ, the UE shall return the Permanent Identity in the AT\_IDENTITY attribute of the EAP-Response /AKA'-Identity message. + +If during an authentication request, the UE receives an EAP-Request/AKA-Identity message which contains AT\_FULLAUTH\_ID\_REQ, the UE shall return the Pseudonym Identity as the AT\_IDENTITY within EAP-Response/AKA\_Identity message if available. If the UE receives an EAP-Request/AKA'-Identity message containing AT\_FULLAUTH\_ID\_REQ, the UE shall return the Pseudonym Identity as the AT\_IDENTITY within the EAP-Response /AKA'-Identity message if available. Otherwise the UE shall return the Permanent Identity. + +If during an authentication request, the UE receives an EAP-Request/AKA-Identity message or EAP-Request/AKA'-Identity message respectively, which contains AT\_ANY\_ID\_REQ, the UE shall return the Fast Re-authentication Identity if available as the AT\_IDENTITY. Otherwise the UE shall return the Pseudonym Identity. + +#### 6.4.2.4 Handling of the Access Network Identity + +##### 6.4.2.4.1 General + +The 3GPP AAA server provides the UE with the ANID in EAP signalling. The UE can also obtain the ANID by access network specific means, which are out of scope of the present document. For some access networks the ANID can also be configured into the UE and the 3GPP AAA server. + +NOTE: According to 3GPP TS 33.402 [15], the ANID is used by HSS and UE to generate transformed authentication vectors and therefore the ANID needs to be identical in the HSS and in the UE. The trusted non-3GPP access network first sends the ANID to the 3GPP AAA server via the STa reference point and the 3GPP AAA server sends the ANID to HSS via the SWx reference point, see 3GPP TS 29.273 [17], and to the UE as specified in this specification. + +##### 6.4.2.4.2 ANID indication from 3GPP AAA server to UE + +When the 3GPP AAA server sends an EAP Request' or AKA-Challenge' message to the UE, the 3GPP AAA server shall include the ANID to be used when generating transformed authentication vectors, using the AT\_KDF\_INPUT attribute as described in subclause 8.2.2. The value and coding of this attribute is described in subclause 8.1.1. + +##### 6.4.2.4.3 UE check of ANID for HRPD CDMA 2000® access networks + +The UE shall apply the rules for comparison of the locally determined ANID and the one received over EAP-AKA' as specified in IETF RFC 5448 [38]. The UE, or the user, may use the ANID as a basis for an optional decision whether the access network is authorized to serve the UE. E.g. the UE may compare the ANID against a list of preferred or barred ANIDs. + +When the UE can locally determine based on physical layer or access network procedures that the UE is connected to a eHRPD network, the locally determined ANID is "HRPD". If the comparison check is successful and if either the optional access network authorization decision in the UE is positive or is not performed, the UE shall proceed; otherwise the UE shall abort the access procedure. + +##### 6.4.2.4.4 UE check of ANID for WiMAX access networks + +The UE shall apply the rules for comparison of the locally determined ANID and the one received over EAP-AKA' as specified in IETF RFC 5448 [38]. The UE, or the user, may use the ANID as a basis for an optional decision whether the access network is authorized to serve the UE. E.g. the UE may compare the ANID against a list of preferred or barred ANIDs. + +When the UE can locally determine based on physical layer or access network procedures that the UE is connected to a WiMAX access network, the locally determined ANID is "WIMAX". If the comparison check is successful and if either the optional access network authorization decision in the UE is positive or is not performed, the UE shall proceed; otherwise the UE shall abort the access procedure. + +##### 6.4.2.4.5 UE check of ANID for WLAN access networks + +The UE shall apply the rules for comparison of the locally determined ANID and the one received over EAP-AKA' as specified in IETF RFC 5448 [38]. The UE, or the user, may use the ANID as a basis for an optional decision whether the access network is authorized to serve the UE. E.g. the UE may compare the ANID against a list of preferred or barred ANIDs. + +When the UE can locally determine based on physical layer or access network procedures that the UE is connected to a WLAN network, the locally determined ANID is "WLAN". If the comparison check is successful and if either the optional access network authorization decision in the UE is positive or is not performed, the UE shall proceed; otherwise the UE shall abort the access procedure. + +##### 6.4.2.4.6 UE check of ANID for ETHERNET access networks + +The UE shall apply the rules for comparison of the locally determined ANID and the one received over EAP-AKA' as specified in IETF RFC 5448 [38]. The UE, or the user, may use the ANID as a basis for an optional decision whether + +the access network is authorized to serve the UE. E.g. the UE may compare the ANID against a list of preferred or barred ANIDs. + +When the UE can locally determine based on physical layer or access network procedures that the UE is connected to a Ethernet network, the locally determined ANID is "ETHERNET". If the comparison check is successful and if either the optional access network authorization decision in the UE is positive or is not performed, the UE shall proceed; otherwise the UE shall abort the access procedure. + +#### 6.4.2.5 Full name for network and short name for network + +When receiving the EAP-Request/AKA-Challenge message when the EAP-AKA is used or the EAP-Request/AKA'-Challenge message when the EAP-AKA' is used, and the AT\_FULL\_NAME\_FOR\_NETWORK attribute, the AT\_SHORT\_NAME\_FOR\_NETWORK attribute or both are included, then the UE may use the contents to update appropriate information stored within the UE. + +#### 6.4.2.6 TWAN connection modes + +##### 6.4.2.6.1 General + +The UE may support SCM. The UE may support MCM. + +NOTE 1: The UE is allowed to support both MCM and SCM. The UE is allowed to support neither MCM nor SCM. + +NOTE 2: No UE extensions are needed for TSCM. + +##### 6.4.2.6.2 Usage of single-connection mode (SCM) + +If: + +- a) the UE supports the SCM; +- b) the EAP-Request/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + - 1) contains the message type field indicating CONNECTION\_CAPABILITY; and + - 2) contains the item list field: + - A) including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 indicating support of SCM; and + - B) if the UE requests an emergency attach or an emergency handover, including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 indicating that emergency services are supported; and +- c) the UE requests usage of the SCM; + +then the UE: + +- a) shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Response/AKA'-Challenge message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the UE shall: + - 1) set the message type field to SCM\_REQUEST; and + - 2) in the item list field: + - A) include a CONNECTIVITY\_TYPE item according to subclause 8.1.4.3 indicating the requested connectivity type - PDN connection, or NSWO; and + - B) if a PDN connection is requested: + - i) include a ATTACHMENT\_TYPE item according to subclause 8.1.4.4 indicating whether an initial attach, a handover attach, an emergency attach, or an emergency handover is requested; + +- ii) if a PDN connection for an APN other than the default APN is requested and either an initial attach or a handover attach is requested, include an APN item according to subclause 8.1.4.5 indicating the requested APN; + - iii) if the initial attach or the emergency attach is requested, include a PDN\_TYPE item according to subclause 8.1.4.6 indicating the requested PDN type; + - iv) if the handover attach or the emergency handover is requested, include a PDN\_TYPE item according to subclause 8.1.4.6 indicating the PDN type supported in the PDN connection to be handed over; and + - v) if the UE wishes to transmit (protocol) data (e.g. configuration parameters, error codes or messages/events) to the network, include a PROTOCOL\_CONFIGURATION\_OPTIONS item according to subclause 8.1.4.9; and +- b) if a PDN connection is requested, shall include the AT\_RESULT\_IND attribute in the EAP-Response/AKA'-Challenge message. + +NOTE 1: If the UE does not include the AT\_RESULT\_IND attribute in the EAP-Response/AKA'-Challenge message, in case of successful authentication, then EAP-Request/AKA'-Notification message is not received and the UE is only informed about success using EAP-Success. + +Upon receiving the EAP-Request/AKA'-Notification message including the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + +- contains the message type field indicating SCM\_RESPONSE; and +- contains the item list field; + +the UE: + +- a) if the AT\_NOTIFICATION attribute indicates success, shall determine the authorized connectivity type in the CONNECTIVITY\_TYPE item as described in subclause 8.1.4.3 included in the item list field. If the authorized connectivity type is PDN connection, the UE: + - 1) if the initial attach, or the handover attach is requested, shall determine the selected APN in the APN item as described in subclause 8.1.4.5 included in the item list field; + - 2) shall determine the PDN type supported in the PDN connection in the PDN\_TYPE item as described in subclause 8.1.4.6 included in the item list field; + - 3) if a PROTOCOL\_CONFIGURATION\_OPTIONS item as described in subclause 8.1.4.9 is included in the item list field, shall determine the protocol configuration options in the PROTOCOL\_CONFIGURATION\_OPTIONS item; + - 4) if a IPV4\_ADDRESS item as described in subclause 8.1.4.11 is included in the item list field, shall determine the IPv4 address allocated to the UE for the PDN connection in the IPV4\_ADDRESS item; + - 5) if a IPV6\_INTERFACE\_IDENTIFIER item as described in subclause 8.1.4.12 is included in the item list field, shall determine the IPv6 interface identifier allocated to the UE for the PDN connection in the IPV6\_INTERFACE\_IDENTIFIER item and shall use it when building the IPv6 link local address; and + - 6) shall determine the TWAG user plane MAC address in the TWAG\_UP\_MAC\_ADDRESS item as described in subclause 8.1.4.14 included in the item list field, and shall use the TWAG user plane MAC address for encapsulating user plane packets according to 3GPP TS 23.402 [6]; and +- b) if the AT\_NOTIFICATION attribute indicates failure with value 0 "General failure after authentication" or value 16384 - "General failure" as defined in IETF RFC 4187 [33] and the ACCESS\_CAUSE item is included: + - 1) shall determine the cause of failure in the ACCESS\_CAUSE item as described in subclause 8.1.4.17 included in the item list field; + - 2) if the initial attach, or the handover attach is requested, and the cause of failure is #2 "Non-3GPP access to EPC not allowed" as defined in subclause 8.1.4.17, shall not retry the authentication procedure to any WLANs until switching off or the UICC containing the USIM is removed; + +- 3) if the cause of failure is #11 "PLMN\_NOT\_ALLOWED" as defined in subclause 8.1.4.17, shall not retry the authentication procedure from the same PLMN via WLANs according to the network selection procedures as defined in subclause 5.2.2; +- 4) if the initial attach, or the handover attach is requested, and the cause of failure is #3 "RAT type not allowed" as defined in subclause 8.1.4.17, the UE shall not retry the authentication procedure to any WLANs until switching off or the UICC containing the USIM is removed; +- 5) if the cause of failure is #6 "Illegal ME" as defined in subclause 8.1.4.17, shall not retry the authentication procedure from the same PLMN until switching off or the UICC containing the USIM is removed; and + +NOTE 2: Switching off and USIM change conditions are implemented taking into consideration the user experience aspect. + +- c) if the AT\_NOTIFICATION attribute indicates failure as defined in bullet b) and the CAUSE item is included: + - 1) shall determine the cause of failure in the CAUSE item as described in subclause 8.1.4.10 included the item list field; + - 2) if the initial attach, or the handover attach is requested, the cause of failure is #26 "Insufficient resources" and the Tw1 item is included in the item list field, shall take different actions depending on the timer value received in the Tw1 item as follows: + - A) if the timer value indicates neither zero nor deactivated, shall stop timer Tw1 associated with the corresponding APN, if it is running. The UE shall start timer Tw1 (see 3GPP TS 24.244 [56]) with the value provided in the Tw1 value IE and not send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN until timer Tw1 expires, the timer Tw1 is stopped, or the USIM is removed; + - B) if the timer value indicates that this timer is deactivated, shall not send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN until the UE is switched off or the USIM is removed; + - C) if the timer value indicates zero, may send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN; and + - D) if the WLAN radio is disabled when the timer Tw1 is running and if the USIM in the UE remains the same when the WLAN radio is enabled, shall behave as follows when the WLAN radio is enabled: + - let t1 be the time remaining for Tw1 timeout when the WLAN radio was disabled and let t be the time elapsed since the WLAN radio was disabled until the WLAN radio was enabled. If t1 is greater than t, then the timer shall be restarted with the value t1 – t. If t1 is equal to or less than t, then the timer need not be restarted. If the UE is not capable of determining t, then the UE shall restart the timer with the value t1; +- 3) if the cause of failure is #26 "Insufficient resources" and the Tw1 item is not included in the item list field, may send a SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN; +- 4) if the initial attach, or the handover attach is requested, and the cause of failure is #38 "Network failure" as defined in subclause 8.1.4.10.2: + - A) if the Tw1 item is included in the item list field, shall behave as follows: + - i) if the timer value received in the Tw1 item indicates neither zero nor deactivated, shall start the Tw2 timer with the timer value provided in the Tw1 item, and shall not try again until the backoff timer expires or the UE is switched off or the UICC containing the USIM is removed; + - ii) if the timer value received in the Tw1 item indicates that this timer is deactivated, shall not try again until the UE is switched off or the UICC containing the USIM is removed; and + - iii) if the timer value received in the Tw1 item indicates zero, may send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN; and + +- B) if the Tw1 item is not included in the item list field, shall start an implementation specific backoff timer and not try again until the backoff timer expires or the UE is switched off or the UICC containing the USIM is removed; and + +NOTE 3: Existing Tw1 item can be reused by the network to provide back off timer value to start Tw2 timer. + +- 5) if the initial attach, or the handover attach is requested, and the cause of failure is #27 "Unknown APN" as defined in subclause 8.1.4.10.2: + - a) if the Tw1 item is included in the item list field, shall behave as follows: + - i) if the timer value received in the Tw1 item indicates neither zero nor deactivated, shall start the Tw2 timer with the timer value provided in the Tw1 item, and shall not send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN to the same PLMN until the backoff timer expires or the UE is switched off or the UICC containing the USIM is removed; + - ii) if the timer value received in the Tw1 item indicates that this timer is deactivated, shall not send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN to the same PLMN until the UE is switched off or the UICC containing the USIM is removed; and + - iii) if the timer value received in the Tw1 item indicates zero, may send another SCM\_REQUEST message with the CONNECTIVITY\_TYPE item indicating PDN connection and with APN item indicating the same APN; and + - b) if the Tw1 item is not included in the item list field, shall not retry the authentication procedure with the same WLAN for the same APN to the same PLMN until the UE is switched off or the UICC containing the USIM is removed, unless the UE has an implementation specific backoff timer. In that case, the UE shall not retry until that implementation specific timer expires. + +#### 6.4.2.6.2A Usage of single-connection mode (SCM) - emergency + +If the UE needs to establish an IMS emergency session over trusted WLAN access, the UE shall: + +- 1) if the UE already has active PDN connection, the UE shall detach first (see 3GPP TS 23.402 [6]) and then follow item 2) below to start initial attach procedure for emergency service; and +- 2) if the UE does not have an active PDN connection and requests usage of the SCM, the UE shall start initial attach procedure for emergency service using the procedures specified in subclause 6.4.2.6.2. In addition, + - a) upon receiving EAP-Request/AKA'-Challenge message: + - if the CONNECTION\_MODE\_CAPABILITY item in the item list field indicates support of emergency services, the UE shall respond with the EAP-Response/AKA'-Challenge message with the ATTACHMENT\_TYPE item in the item list field set to "emergency attach" or "emergency handover"; or + - if the CONNECTION\_MODE\_CAPABILITY item in the item list field does not indicate support of emergency services, the UE shall respond with the EAP-Response/AKA'-Client-Error message as described in subclause 6.4.2.6.4. The UE shall re-initiate initial attach procedure for emergency service by selecting a different WLAN supporting emergency service; or + - b) upon receiving EAP-Request/3GPP-LimitedService-Init-Info message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating CONNECTION\_CAPABILITY and message field contains CONNECTION\_MODE\_CAPABILITY item in the item list field indicating support of SCM and emergency services, + - if the UE supports the SCM and requests the usage of the SCM, the UE shall respond with the EAP-Response/3GPP-LimitedService-Init-Info message and shall include the AT\_TWAN\_CONN\_MODE attribute with the message type field set to SCM\_REQUEST and in the item list field shall: + - i) include a ATTACHMENT\_TYPE item indicating whether an emergency attach or emergency handover is requested; + +- ii) if emergency attach is requested, include a PDN\_TYPE item according to subclause 8.1.4.6 indicating the requested PDN type; + - iii) if emergency handover attach is requested, include a PDN\_TYPE item according to subclause 8.1.4.6 indicating the PDN type supported in the PDN connection to be handed over; and + - iv) if the UE wishes to transmit (protocol) data (e.g. configuration parameters, error codes or messages/events) to the network, include a PROTOCOL\_CONFIGURATION\_OPTIONS item according to subclause 8.1.4.9; and +- c) upon receiving the EAP-Request/3GPP-LimitedService-Notif message including the AT\_TWAN\_CONN\_MODE attribute with the message type field of the message field indicating SCM\_RESPONSE and the item list field: + - the UE shall: + - i) determine the PDN type supported in the PDN connection in the PDN\_TYPE item as described in subclause 8.1.4.6 included in the item list field; + - ii) determine the protocol configuration options in the PROTOCOL\_CONFIGURATION\_OPTIONS item if a PROTOCOL\_CONFIGURATION\_OPTIONS item as described in subclause 8.1.4.9 is included in the item list field; + - iii) if a IPV4\_ADDRESS item as described in subclause 8.1.4.11 is included in the item list field, determine the IPv4 address allocated to the UE for the PDN connection in the IPV4\_ADDRESS item; + - iv) if a IPV6\_INTERFACE\_IDENTIFIER item as described in subclause 8.1.4.12 is included in the item list field, determine the IPv6 interface identifier allocated to the UE for the PDN connection in the IPV6\_INTERFACE\_IDENTIFIER item and use it when building the IPv6 link local address; and + - v) determine the TWAG user plane MAC address in the TWAG\_UP\_MAC\_ADDRESS item as described in subclause 8.1.4.14 included in the item list field, and use the TWAG user plane MAC address for encapsulating user plane packets according to 3GPP TS 23.402 [6]; and + - d) if the UE had requested emergency attach or emergency handover of an emergency session, upon receiving the EAP-Request/AKA'-Notification message, if the AT\_NOTIFICATION attribute indicates failure, the UE shall detach and then perform initial attach procedure for emergency service by selecting a different WLAN supporting emergency service. + +#### 6.4.2.6.3 Usage of multi-connection mode (MCM) + +If: + +- a) the UE supports the MCM; +- b) the EAP-Request/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + - 1) contains the message type field indicating CONNECTION\_CAPABILITY; and + - 2) contains the item list field: + - A) including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 indicating support of MCM; + - B) including the SUPPORTED\_WLCP\_TRANSPORTS item as described in subclause 8.1.4.15; and + - C) if the UE requests an emergency attach or an emergency handover, including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 indicating that emergency services are supported; + +- c) at least one WLCP transport indicated as supported in the SUPPORTED\_WLCP\_TRANSPORTS item is also supported by the UE; and +- d) the UE requests usage of the MCM; + +then the UE: + +- a) shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Response/AKA'-Challenge message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the UE: + - 1) shall set the message type field to MCM\_REQUEST; and + - 2) in the item list field: + - A) if the UE requests an emergency attach or an emergency handover, shall include an ATTACHMENT\_TYPE item according to subclause 8.1.4.4 indicating whether an emergency attach, or an emergency handover is requested; and +- b) shall include the AT\_RESULT\_IND attribute in the EAP-Response/AKA'-Challenge message. + +Upon receiving the EAP-Request/AKA'-Notification message including the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 where the message field as described in subclause 8.1.4.1: + +- contains the message type field indicating MCM\_RESPONSE; and +- contains the item list field; + +the UE: + +- a) if the AT\_NOTIFICATION attribute indicates success: + - 1) shall determine the NSWO authorization in the AUTHORIZATIONS item as described in subclause 8.1.4.7 included in the item list field; + - 2) shall determine the TWAG control plane address(es) in the TWAG\_CP\_ADDRESS item as described in subclause 8.1.4.13 included in the item list field; and + - 3) shall derive the WLCP key as described in Annex A.3 in 3GPP TS 33.402 [15]; and + +NOTE: After receiving EAP Success message terminating the EAP procedures after successful authentication and authorization for MCM access to EPC, the UE establishes a DTLS connection with the TWAG and initiates WLCP procedures according to 3GPP TS 24.244 [56]. + +- b) if the AT\_NOTIFICATION attribute indicates failure, shall determine the cause of failure in the ACCESS\_CAUSE or CAUSE item as described in subclause 8.1.4.17 and 8.1.4.10 included in the item list field. + +#### 6.4.2.6.3A Usage of multi-connection mode (MCM) - emergency + +If the UE needs to establish an IMS emergency session over trusted WLAN access, the UE shall: + +- 1) if the UE already has active PDN connection: + - if the TWAN does not support emergency service, the UE shall detach first and then follow item 2) below to start initial attach procedure for emergency service and selecting a WLAN supporting Emergency service; or + - if the connected TWAN supports emergency service, the UE shall initiate PDN connectivity establishment procedures as specified in 3GPP TS 24.244 [56]. +- 2) if the UE does not have an active PDN connection and requests usage of the MCM, the UE shall start initial attach procedure for emergency service using the procedures specified in subclause 6.4.2.6.3. In addition, + - a) upon receiving EAP-Request/AKA'-Challenge message: + - if the CONNECTION\_MODE\_CAPABILITY item in the item list field indicates support of emergency services, the UE shall respond with the EAP-Response/AKA'-Challenge message with the + +ATTACHMENT\_TYPE item in the item list field set to "emergency attach" or "emergency handover"; or + +- if the CONNECTION\_MODE\_CAPABILITY item in the item list field does not indicate support of emergency services, the UE shall respond with the EAP-Response/AKA'-Client-Error message as described in subclause 6.4.2.6.4. The UE shall re-initiate initial attach procedure for emergency service by selecting a different WLAN supporting emergency service; or +- b) upon receiving EAP-Request/3GPP-LimitedService-Init-Info message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating CONNECTION\_CAPABILITY and message field contains CONNECTION\_MODE\_CAPABILITY item in the item list field indicating support of MCM and emergency services, + - if the UE supports the MCM and requests the usage of the MCM and + - i) message field of the AT\_TWAN\_CONN\_MODE attribute contains SUPPORTED\_WLCP\_TRANSPORTS item as described in subclause 8.1.4.15; and + - ii) at least one WLCP transport indicated as supported in the SUPPORTED\_WLCP\_TRANSPORTS item is also supported by the UE, + +the UE shall respond with the EAP-Response/3GPP-LimitedService-Init-Info message and shall: + +- i) include the AT\_TWAN\_CONN\_MODE attribute with the message type field set to MCM\_REQUEST; +- c) upon receiving the EAP-Request/3GPP-LimitedService-Notif message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating MCM\_RESPONSE and the item list field: + - the UE shall: + - i) determine the TWAG control plane address(es) in the TWAG\_CP\_ADDRESS item as described in subclause 8.1.4.13 included in the item list field; + - ii) derive the WLCP key as described in Annex A.3 in 3GPP TS 33.402 [15]. + +NOTE: After receiving EAP Success message terminating the EAP procedures after successful authentication and authorization for MCM access to EPC, the UE establishes a DTLS connection with the TWAG and initiates WLCP procedures according to 3GPP TS 24.244 [56]. + +- d) if the UE had requested emergency attach or emergency handover of an emergency session, upon receiving the EAP-Request/AKA'-Notification message, if the AT\_NOTIFICATION attribute indicates failure, the UE shall detach and then perform initial attach procedure for emergency service by selecting a different WLAN supporting emergency service. + +#### 6.4.2.6.3B Usage of transparent single-connection mode (TSCM) - emergency + +The emergency session is not supported for the UE using TSCM mode. + +NOTE: If the UE in TSCM mode already has active PDN connection, the UE remains connected. + +#### 6.4.2.6.4 Network support not available + +If the EAP-Request/AKA'-Challenge message does not include the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1, then only TSCM is available. + +If the UE supports SCM, the UE does not support MCM, and the EAP-Request/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + +- 1) contains the message type field indicating CONNECTION\_CAPABILITY; and +- 2) contains the item list field including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 not indicating support of SCM; + +then only TSCM is available. + +If the UE does not support SCM, the UE supports MCM, and the EAP-Request/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + +- 1) contains the message type field indicating CONNECTION\_CAPABILITY; and +- 2) contains the item list field including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 not indicating support of MCM; + +then only TSCM is available. + +If the UE does not support SCM, the UE supports MCM, the EAP-Request/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + +- 1) contains the message type field indicating CONNECTION\_CAPABILITY; and +- 2) contains the item list field: + - A) including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 indicating support of MCM; and + - B) including the SUPPORTED\_WLCP\_TRANSPORTS item as described in subclause 8.1.4.15; + +and none of the WLCP transport indicated as supported in the SUPPORTED\_WLCP\_TRANSPORTS item is also supported by the UE, then only TSCM is available. + +If only TSCM is available: + +- a) if the UE does not request an emergency attach, the UE does not request an emergency handover and the UE is willing to use TSCM, the UE shall act as in TSCM; and +- b) if the UE requests an emergency attach or the UE requests an emergency handover or the UE is unwilling to use TSCM, the UE shall send EAP-Response/AKA'-Client-Error message. + +NOTE: In TSCM, successful EAP-AKA' authentication triggers creation of a PDN connection to the default APN. The UE can be unwilling to use the PDN connection to the default APN e.g. because the UE needs to perform handover of a PDN connection, because the UE needs to establish a PDN connection to an APN other than the default APN, because the UE needs to establish multiple PDN connections, or because the UE has no usage for the PDN connection to the default APN and wants to avoid any possible charges related to the PDN connection to the default APN. + +If the UE requests an emergency attach or an emergency handover, and the EAP-Request/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1: + +- 1) contains the message type field indicating CONNECTION\_CAPABILITY; and +- 2) contains the item list field including the CONNECTION\_MODE\_CAPABILITY item as described in subclause 8.1.4.8 not indicating support of emergency services; + +then the UE shall send EAP-Response/AKA'-Client-Error message. + +## 6.4.2.7 Mobile Equipment Identity Signalling + +If the UE receives: + +- an EAP-Request/AKA'-Challenge message; or +- an EAP-Request/3GPP-LimitedService-Init-Info message; + +containing the AT\_DEVICE\_IDENTITY attribute and the Identity Type field of the received AT\_DEVICE\_IDENTITY attribute is set to either 'IMEI' or 'IMEISV' and the Identity Value field is empty, then if the + +UE's Mobile Equipment Identity IMEI or IMEISV is available, the UE shall include IMEI or IMEISV in the AT\_DEVICE\_IDENTITY attribute in: + +- the EAP-Response/AKA'-Challenge message; or +- the EAP-Response/3GPP-LimitedService-Init-Info message; + +as follows: + +- if IMEISV are available, the UE shall include IMEISV in the AT\_DEVICE\_IDENTITY attribute. The Identity Type field of the AT\_DEVICE\_IDENTITY attribute shall be set to 'IMEISV'; and +- if IMEI is available and IMEISV is not available, the UE shall include IMEI in the AT\_DEVICE\_IDENTITY attribute. The Identity Type field of the AT\_DEVICE\_IDENTITY attribute shall be set to 'IMEI'. + +The AT\_DEVICE\_IDENTITY attribute shall be sent as an encrypted attribute and included in the value field of the AT\_ENCR\_DATA attribute as described in IETF RFC 4187 [33]. + +The detailed coding of the AT\_DEVICE\_IDENTITY attribute is described in subclause 8.2.8.1. + +## 6.4.3 3GPP AAA server procedures + +### 6.4.3.1 Identity Management + +The 3GPP AAA selects the pseudonym identity or the Fast Re-authentication Identity and returns the identity to the UE during the Authentication procedure as specified in 3GPP TS 33.402 [15]. The 3GPP AAA server shall maintain a mapping between the UE's permanent identity and the pseudonym identity and between the UE's permanent identity and the Fast Re-authentication Identity. + +#### 6.4.3.1A Identity Management - emergency session + +Upon receiving a request from the UE for emergency session establishment, if + +- IMSI is provided to the network but IMSI authentication cannot proceed or IMSI authentication has failed or the 3GPP AAA server cannot determine if authentication is successful; and +- the 3GPP AAA server is configured to accept unauthenticated emergency session over WLAN, + +the 3GPP AAA server requests IMEI from the UE as specified in subclause 6.4.3.6 using the EAP-Request/3GPP-LimitedService-Init-Info message. + +### 6.4.3.2 EAP-AKA and EAP-AKA' based Authentication + +The 3GPP AAA server shall support EAP AKA based authentication as specified in IETF RFC 4187 [33] and EAP-AKA' based authentication as specified in IETF RFC 5448 [38]. 3GPP TS 33.402 [15] specifies the conditions under which one or the other of these two methods is used. If the UE provides an explicit indication for the supported mobility protocols and the network supports multiple IP mobility mechanisms, the network shall select the protocol to be used and communicate the decision to the UE as defined in subclause 6.3.3.1.2. + +For WLAN access, after the UE has been successfully authenticated and the EPC access and Non-Seamless WLAN Offload are not authorized for the UE, the 3GPP AAA Server shall invoke an EAP-Request/AKA'-Notification dialogue and indicate this to the UE by using the AT\_NOTIFICATION attribute value 1031 – "User has not subscribed to the requested service" as defined in IETF RFC 4187 [33]. + +### 6.4.3.3 Full authentication and Fast Re-authentication + +The 3GPP AAA shall support full re-authentication and fast re-authentication as specified in IETF RFC 4187 [33]. + +The decision to use the fast re-authentication process is taken by the home network (i.e. the 3GPP AAA server) and is based on operator policies. If fast re-authentication is to be used, the home network shall indicate this to the UE by providing the Fast Re-authentication Identity to the UE during the authentication process. + +When initiating an authentication, the home network shall indicate the type of authentication required by including either AT\_PERMANENT\_ID\_REQ or AT\_FULLAUTH\_ID\_REQ for Full authentication and AT\_ANY\_ID\_REQ for + +Fast re-authentication in the EAP-Request/AKA\_Identity message or the EAP-Request/AKA'-Identity message respectively. + +The home network (i.e. the 3GPP AAA server) may upon receiving the Fast Re-authentication Identity in AT\_IDENTITY, decide to proceed with the fast re-authentication or choose instead to initiate a full authentication. This decision is based on operator policies. + +#### 6.4.3.4 Full name for network and short name for network + +The 3GPP AAA server may include the AT\_FULL\_NAME\_FOR\_NETWORK attribute, the AT\_SHORT\_NAME\_FOR\_NETWORK attribute or both in the EAP-Request/AKA-Challenge message when the EAP-AKA is used and in the EAP-Request/AKA'-Challenge message when the EAP-AKA' is used. + +The detailed coding of the AT\_FULL\_NAME\_FOR\_NETWORK attribute and the AT\_SHORT\_NAME\_FOR\_NETWORK is described in subclause 8.2.5. + +#### 6.4.3.5 TWAN connection modes + +##### 6.4.3.5.1 General + +The 3GPP AAA server may support the single-connection mode (SCM). + +The 3GPP AAA server may support the multi-connection mode (MCM). + +If the network supports SCM, MCM or both, the 3GPP AAA server shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 and the AT\_RESULT\_IND attribute in the EAP-Request/AKA'-Challenge message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + +- a) set the message type field to CONNECTION\_CAPABILITY; and +- b) in the item list field: + - 1) include a CONNECTION\_MODE\_CAPABILITY item according to subclause 8.1.4.8 indicating whether the network supports TSCM, SCM, MCM or any combination of them and indicating whether the network supports the emergency services; and + - 2) if the network supports MCM, include a SUPPORTED\_WLCP\_TRANSPORTS item according to subclause 8.1.4.15 indicating WLCP transport(s) supported by the TWAG. + +##### 6.4.3.5.1A Emergency session connection mode negotiation for unauthenticated UEs + +If the 3GPP AAA server is configured to accept unauthenticated emergency session over WLAN and IMEI was received or IMSI was received but IMSI authentication cannot proceed, the 3GPP AAA server shall initiate connection mode negotiation with the UE as follows: + +- if the 3GPP AAA server supports SCM, MCM or both, the 3GPP AAA server shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Request/3GPP-LimitedService-Init-Info message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - a) set the message type field to CONNECTION\_CAPABILITY; and + - b) in the item list field: + - 1) include a CONNECTION\_MODE\_CAPABILITY item according to subclause 8.1.4.8 indicating whether the network supports SCM, MCM or any combination of them, and indicating emergency service is supported; and + - 2) if the network supports MCM, include a SUPPORTED\_WLCP\_TRANSPORTS item according to subclause 8.1.4.15 indicating WLCP transport(s) supported by the TWAG. + +##### 6.4.3.5.2 Usage of single-connection mode (SCM) + +If + +- the 3GPP AAA server supports SCM; +- the EAP-Response/AKA'-Challenge message includes the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1 contains the message type field indicating SCM\_REQUEST; and +- the authentication was successful; + +then the 3GPP AAA server: + +- if the ATTACHMENT\_TYPE item according to subclause 8.1.4.4 indicating an emergency attach, or an emergency handover is included in the item list field of the message field, shall identify that the attach is for emergency services; and +- shall trigger the TWAN to establish the connectivity of the requested connectivity type according to 3GPP TS 23.402 [6]. + +If: + +- the 3GPP AAA server authorizes the requested connectivity; and +- the EAP-Response/AKA'-Challenge message includes the AT\_RESULT\_IND attribute; + +then the 3GPP AAA server shall invoke an EAP-Request/AKA'-Notification dialogue. The 3GPP AAA server shall construct the EAP-Request/AKA'-Notification message as follows: + +- a) indicate success in the AT\_NOTIFICATION attribute; and +- b) include the AT\_TWAN\_CONN\_MODE attribute described in subclause 8.2.7.1. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - 1) set the message type field to SCM\_RESPONSE; and + - 2) in the item list field: + - A) include a CONNECTIVITY\_TYPE item as described in subclause 8.1.4.3 indicating the authorized connectivity type. Only one connectivity type is indicated; and + - B) if a PDN connection was authorized: + - i) if the initial attach, or the handover attach is requested, include an APN item according to subclause 8.1.4.5 indicating the APN of the authorized PDN connection; + - ii) include a PDN\_TYPE item according to subclause 8.1.4.6 indicating the PDN type(s) selected in the authorized PDN connection; + - iii) if the 3GPP AAA server wishes to transmit (protocol) data (e.g. configuration parameters, error codes or messages/events) to the UE, include a PROTOCOL\_CONFIGURATION\_OPTIONS item according to subclause 8.1.4.9; + - iv) if an IPv4 address is allocated to the UE for the PDN connection, include a IPV4\_ADDRESS item according to subclause 8.1.4.11; + - v) if an IPv6 interface identifier is allocated to the UE for the PDN connection, include a IPV6\_INTERFACE\_IDENTIFIER item according to subclause 8.1.4.12; and + - vi) include a TWAG\_UP\_MAC\_ADDRESS item according to subclause 8.1.4.14. + +If the 3GPP AAA server does not authorize the requested connectivity and if: + +- the attach is not for emergency session; or +- the attach is for emergency session and if the 3GPP AAA server is not configured to accept unauthenticated emergency session over WLAN, + +NOTE: The case where the 3GPP AAA server does not authorize the request but is configured to accept unauthenticated emergency session over WLAN is specified in subclause 6.4.3.5.2A. + +then the 3GPP AAA server shall invoke an EAP-Request/AKA'-Notification dialogue. The 3GPP AAA server shall construct the EAP-Request/AKA'-Notification message as follows: + +- a) indicate failure in the AT\_NOTIFICATION attribute; and +- b) include the AT\_TWAN\_CONN\_MODE attribute described in subclause 8.2.7.1. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - 1) set the message type field to SCM\_RESPONSE; + - 2) in the item list field, include a ACCESS\_CAUSE or CAUSE item according to subclause 8.1.4.17 and 8.1.4.10 indicating the cause of failure; + - 3) if the initial attach, or the handover attach is requested, the cause of failure is #26 "Insufficient resources" and a value of backoff timer is to be provided to the UE for the PDN connection, include a Tw1 item according to subclause 8.1.4.16; + - 3A) if the initial attach, or the handover attach is requested, the cause of failure is #38 "Network failure" or #27 "unknown APN" and a value of backoff timer is to be provided to the UE for the PDN connection, include a Tw1 item according to subclause 8.1.4.16; + - 4) if the 3GPP AAA Server receives DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using "Non-3GPP access to EPC not allowed" value in the ACCESS\_CAUSE item; + - 5) if the 3GPP AAA Server receives DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using "PLMN not allowed" value in the ACCESS\_CAUSE item; + - 6) if the 3GPP AAA Server receives DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using #27 "Unknown APN" value in the CAUSE item; + - 7) if the 3GPP AAA Server receives DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using #3 "RAT type not allowed" value in the ACCESS\_CAUSE item; and + - 8) if the 3GPP AAA Server receives DIAMETER\_UNABLE\_TO\_COMPLY sent by HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using #38 "Network failure" in the CAUSE item. + +#### 6.4.3.5.2A Usage of single-connection mode (SCM) - emergency + +If the 3GPP AAA Server supports IMS Emergency sessions over WLAN, the 3GPP AAA server shall: + +- if IMSI was received and IMSI authentication can proceed, the 3GPP AAA server invokes an EAP-Request/AKA'-Notification dialogue to indicate success or failure to the UE as described in subclause 6.4.3.5.2; +- if IMSI was received but IMSI authentication cannot proceed, then + - A) if the 3GPP AAA server is configured to accept unauthenticated emergency session over WLAN: + - a) the 3GPP AAA server sends EAP Request/3GPP-LimitedService-Init-Info message as specified in subclause 6.4.3.5.1A; + - b) upon receiving the EAP-Response/3GPP-LimitedService-Init-Info message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating SCM\_REQUEST and the item list field, the 3GPP AAA server shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Request/3GPP-LimitedService-Notif message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - i) set the message type field to SCM\_RESPONSE; and + - ii) in the item list field: + +- a) 1) include the PDN type supported in the PDN connection in the PDN\_TYPE item as described in subclause 8.1.4.6 in the item list field; + - b) 2) include the protocol configuration options in the PROTOCOL\_CONFIGURATION\_OPTIONS item if a PROTOCOL\_CONFIGURATION\_OPTIONS item as described in subclause 8.1.4.9 is in the item list field; + - c) 3) if an IPv4 address is allocated to the UE for the PDN connection, include a IPV4\_ADDRESS item according to subclause 8.1.4.11; + - d) 4) if an IPv6 interface identifier is allocated to the UE for the PDN connection, include a IPV6\_INTERFACE\_IDENTIFIER item according to subclause 8.1.4.12; and + - e) 5) include a TWAG\_UP\_MAC\_ADDRESS item according to subclause 8.1.4.14; and +- c) upon receiving the EAP-Response/3GPP-LimitedService-Notif message, the 3GPP AAA server shall generate the MSK using IMEI as described in subclause 13.4 in 3GPP TS 33.402 [15] and send EAP Success message to the UE to allow the UE to proceed with emergency session establishment; or +- B) if the 3GPP AAA server is not configured to accept unauthenticated emergency session over WLAN, the 3GPP AAA server shall reject the emergency session request and return an EAP Failure message to the UE; or +- if IMEI was received, +- A) if the 3GPP AAA server is configured to accept unauthenticated emergency session over WLAN: +- a), the 3GPP AAA server sends EAP Request/3GPP-LimitedService-Init-Info message to as specified in subclause 6.4.3.5.1A; + - b) upon receiving the EAP-Response/3GPP-LimitedService-Init-Info message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating SCM\_REQUEST and the item list field, the 3GPP AAA server shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Request/3GPP-LimitedService-Notif message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - i) set the message type field to SCM\_RESPONSE; and + - ii) in the item list field: + - f) 1) include the PDN type supported in the PDN connection in the PDN\_TYPE item as described in subclause 8.1.4.6 in the item list field; + - g) 2) include the protocol configuration options in the PROTOCOL\_CONFIGURATION\_OPTIONS item if a PROTOCOL\_CONFIGURATION\_OPTIONS item as described in subclause 8.1.4.9 is in the item list field; + - h) 3) if an IPv4 address is allocated to the UE for the PDN connection, include a IPV4\_ADDRESS item according to subclause 8.1.4.11; + - i) 4) if an IPv6 interface identifier is allocated to the UE for the PDN connection, include a IPV6\_INTERFACE\_IDENTIFIER item according to subclause 8.1.4.12; and + - j) 5) include a TWAG\_UP\_MAC\_ADDRESS item according to subclause 8.1.4.14; and + - c) upon receiving the EAP-Response/3GPP-LimitedService-Notif message, the 3GPP AAA server shall generate the MSK using IMEI as described in subclause 13.4 in 3GPP TS 33.402 [15] and send EAP Success message to the UE to allow the UE to proceed with emergency session establishment; or +- B) if the 3GPP AAA server is not configured to accept unauthenticated emergency session over WLAN, the 3GPP AAA server shall reject the emergency session request and return an EAP Failure message to the UE. + +#### 6.4.3.5.3 Usage of multi-connection mode (MCM) + +If: + +- a) the 3GPP AAA server supports MCM; +- b) if the EAP-Response/AKA'-Challenge message includes: + - 1) the AT\_TWAN\_CONN\_MODE attribute as described in subclause 8.2.7.1 wherein the message field as described in subclause 8.1.4.1 contains the message type field indicating MCM\_REQUEST; and + - 2) the AT\_RESULT\_IND attribute; +- c) the 3GPP AAA server authorizes the request. If the ATTACHMENT\_TYPE item according to subclause 8.1.4.4 indicating an emergency attach, or an emergency handover is included in the item list field of the message field, the 3GPP AAA server shall identify that the attach is for emergency services; and +- d) the authentication was successful; + +then the 3GPP AAA server shall invoke an EAP-Request/AKA'-Notification dialogue. The 3GPP AAA server shall construct the EAP-Request/AKA'-Notification message as follows: + +- a) indicate success in the AT\_NOTIFICATION attribute; and +- b) include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - 1) set the message type field to MCM\_RESPONSE; and + - 2) in the item list field: + - A) include an AUTHORIZATIONS item according to subclause 8.1.4.7 indicating whether UE is authorized to use NSWO; and + - B) include a TWAG\_CP\_ADDRESS item according to subclause 8.1.4.13 indicating the TWAG control plane address. + +If the 3GPP AAA server does not authorize the request and if + +- the attach is not for emergency services; or +- the attach is for emergency services and if the 3GPP AAA server is not configured to accept unauthenticated emergency session over WLAN, + +NOTE: The case where the 3GPP AAA server does not authorize the request but is configured to accept unauthenticated emergency session over WLAN is specified in subclause 6.4.3.5.3A. + +then the 3GPP AAA server shall invoke an EAP-Request/AKA'-Notification dialogue. The 3GPP AAA server shall construct the EAP-Request/AKA'-Notification message as follows: + +- a) indicate failure in the AT\_NOTIFICATION attribute; and +- b) include the AT\_TWAN\_CONN\_MODE attribute described in subclause 8.2.7.1. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + - 1) set the message type field to MCM\_RESPONSE; + - 2) in the item list field, include a ACCESS\_CAUSE or CAUSE item according to subclause 8.1.4.17 and 8.1.4.10 indicating the cause of failure; + - 3) if the 3GPP AAA Server receives DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using "Non-3GPP access to EPC not allowed" value in the ACCESS\_CAUSE item; + - 4) if the 3GPP AAA Server receives DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using "PLMN not allowed" value in the ACCESS\_CAUSE item; + +- 5) if the 3GPP AAA Server receives DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using #27 "Unknown APN" value in the CAUSE item; +- 6) if the 3GPP AAA Server receives DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED sent by the HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using #3 "RAT type not allowed" value in the ACCESS\_CAUSE item; and +- 7) if the 3GPP AAA Server receives DIAMETER\_UNABLE\_TO\_COMPLY sent by HSS as specified in 3GPP TS 29.273 [17], indicate this to the UE by using #38 "Network failure" in the CAUSE item. + +#### 6.4.3.5.3A Usage of multi-connection mode (MCM) - emergency + +If the 3GPP AAA Server supports IMS Emergency sessions over WLAN, the 3GPP AAA server shall: + +- if IMSI was received and IMSI authentication can proceed, the 3GPP AAA server invokes an EAP-Request/AKA'-Notification dialogue to indicate success to the UE as described in subclause 6.4.3.5.3; +- if IMSI was received but IMSI authentication cannot proceed, then + +A) if the 3GPP AAA server is configured to accept unauthenticated emergency session over WLAN: + +- a), the 3GPP AAA server sends EAP Request/3GPP-LimitedService-Init-Info message as specified in subclause 6.4.3.5.1A; +- b) upon receiving the EAP-Response/3GPP-LimitedService-Init-Info message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating SCM\_REQUEST and the item list field, the 3GPP AAA server shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Request/3GPP-LimitedService-Notif message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + +- i) set the message type field to SCM\_RESPONSE; and +- ii) in the item list field: + +- k) 1) include the TWAG control plane address(es) in the TWAG\_CP\_ADDRESS item as described in subclause 8.1.4.13 in the item list field; and + +- c) upon receiving the EAP-Response/3GPP-LimitedService-Notif message, the 3GPP AAA server shall generate the MSK using IMEI as described in subclause 13.4 in 3GPP TS 33.402 [15] and send EAP Success message to the UE to allow the UE to proceed with emergency session establishment; or + +B) if the 3GPP AAA server is not configured to accept unauthenticated emergency session over WLAN, the 3GPP AAA server shall reject the emergency session request and return an EAP Failure message to the UE; or + +- if IMEI was received, + +A) if the 3GPP AAA server is configured to accept unauthenticated emergency session over WLAN: + +- a), the 3GPP AAA server sends EAP Request/3GPP-LimitedService-Init-Info message as specified in subclause 6.4.3.5.1A; +- b) upon receiving the EAP-Response/3GPP-LimitedService-Init-Info message including the AT\_TWAN\_CONN\_MODE attribute with the message type of message field indicating MCM\_REQUEST and the item list field, the 3GPP AAA server shall include the AT\_TWAN\_CONN\_MODE attribute according to subclause 8.2.7.1 in the EAP-Request/3GPP-LimitedService-Notif message. In the message field according to subclause 8.1.4.1 of the AT\_TWAN\_CONN\_MODE attribute, the 3GPP AAA server shall: + +- i) set the message type field to MCM\_RESPONSE; and +- ii) in the item list field: + +- 1) 1) include the TWAG control plane address(es) in the TWAG\_CP\_ADDRESS item as described in subclause 8.1.4.13 in the item list field; and + - c) upon receiving the EAP-Response/3GPP-LimitedService-Notif message, the 3GPP AAA server shall generate the MSK using IMEI as described in subclause 13.4 in 3GPP TS 33.402 [15] and send EAP Success message to the UE to allow the UE to proceed with emergency session establishment; or +- B) if the 3GPP AAA server is not configured to accept unauthenticated emergency session over WLAN, the 3GPP AAA server shall reject the emergency session request and return an EAP Failure message to the UE. + +#### 6.4.3.5.3B Usage of transparent single-connection mode (TSCM) - emergency + +The emergency session is not supported for the UE using TSCM mode. + +#### 6.4.3.5.4 Network support not available + +NOTE: If the network does not support a TWAN connection mode and the UE needs to request usage of the not supported TWAN connection mode, upon sending EAP-Request/AKA'-Challenge message, the network receives EAP-Response/AKA'-Client-Error message. Handling defined in IETF RFC 5448 [38] applies for the EAP-Response/AKA'-Client-Error message. + +#### 6.4.3.6 Mobile Equipment Identity Signalling + +If the network supports Mobile Equipment Identity signalling over trusted WLAN, the 3GPP AAA server shall include the AT\_DEVICE\_IDENTITY attribute in: + +- the EAP-Request/AKA'-Challenge message; or +- the EAP-Request/3GPP-LimitedService-Init-Info message; + +with the Identity Type field set to either 'IMEI' or 'IMEISV' and an empty Identity Value field to request the UE to provide the Mobile Equipment Identity indicated in the Identity Type. + +Upon receiving: + +- the EAP-Response/AKA'-Challenge message; or +- the EAP-Response/3GPP-LimitedService-Init-Info message; + +from the UE, if the AT\_DEVICE\_IDENTITY attribute is included and Identity Type field is set to either 'IMEI' or 'IMEISV', then the 3GPP AAA server shall forward the received Mobile Equipment Identity to the TWAN as specified in 3GPP TS 29.273 [17]. + +### 6.4.4 Multiple PDN support for trusted non-3GPP access + +Connectivity to multiple PDNs via trusted non-3GPP access is supported in the EPS when the network policies, the non-3GPP access and the user subscription allow it. + +NOTE 1: In 3GPP, there is a limitation to the maximum number of simultaneous PDN connections per UE caused by the number of EPS bearer identities (see subclause 11.2.3.1.5 of 3GPP TS 24.007 [48]). Not complying with this limitation when accessing non-3GPP access can lead to unexpected consequences, e.g. connectivity loss in case of handover to 3GPP access. The maximum number of PDN connection via trusted non-3GPP access is independent from the maximum number of active EPS bearer contexts for 3GPP access (see subclause 6.5.1A of 3GPP TS 24.301 [10]). + +If the UE supports dynamic mobility management selection the UE shall use the same mobility protocol when multiple connections are established, see 3GPP TS 23.402 [6]. + +When the UE accesses EPC via S2a using trusted non-3GPP IP access and establishes connections to additional PDNs, the UE shall send a trigger for additional PDN connectivity specific to the non-3GPP access. The UE shall include an APN in this trigger to connect to the desired PDN. The UE shall also indicate the Attach Type to the trusted non-3GPP access during additional PDN connectivity. The Attach Type shall distinguish between Initial Attach and Handover Attach. For the multi-connection mode used via trusted WLAN access network, the PDN connection establishment procedures are specified in 3GPP TS 24.244 [56]. + +NOTE 2: The indication about Attach Type is non-3GPP access network specific and its coding is out of scope of this specification. + +NOTE 3: The trigger for additional PDN connectivity is non-3GPP access network specific and its coding is out of scope of this specification. + +When the UE accesses EPC via S2c using non-3GPP IP access, the UE shall follow the procedures described in 3GPP TS 24.303 [11] to connect to multiple PDNs. + +If the UE accesses EPC via S2a using non-3GPP IP access and it is handing over from a source access network to a target non-3GPP IP access and the UE has more than one PDN connection to a given APN in the source access network, the UE shall transfer all the PDN connections for the given APN to the target trusted non-3GPP access network as specified in 3GPP TS 23.402 [6]. + +If multiple PDN connections to a single APN are not supported over the target trusted non-3GPP access network, only one PDN connection to the given APN shall be established in the target non-3GPP access as specified in 3GPP TS 23.402 [6]. If multiple PDN connection requests to the same APN are received but the target trusted non-3GPP access network does not support multiple PDN connections to the same APN, the network shall reject the additional PDN connection requests to the same APN received from the UE when one PDN connection to the same APN has already been established. The UE shall determine which PDN connection is re-established in the non-3GPP access based on the home address information (i.e. IPv4 address or IPv6 prefix or both) provided by the network. + +NOTE 4: The protocol details of the PDN connection reject procedure is non-3GPP access network specific and its coding is outside the scope of this specification. For the multi-connection mode used via trusted WLAN access network, the protocol details of the PDN connection reject procedure is specified in 3GPP TS 24.244 [56] + +NOTE 5: When UE supporting IP address preservation for NBM with multiple PDN connections to the same APN hands over to the non-3GPP access network, the UE can, as an implementation option, prioritise the re-establishment for a particular PDN connection before re-establishing the remaining PDN connections. The way a UE prioritizes a particular PDN connection is non-3GPP access network specific and its coding is out of scope of this specification. Another implementation option can be to send multiple re-establishment requests concurrently. + +NOTE 6: Any unsuccessful re-establishment of any of the multiple PDN connections to the same APN can be managed in an implementation specific manner avoiding UE making repeated re-establishment attempts to the network. + +If the UE did not handover all the PDN connections for a given APN to the target trusted non-3GPP access network, the network may disconnect the remaining PDN connections for that given APN after an implementation dependent time. + +## 6.5 Authentication and authorization for accessing EPC via an untrusted non-3GPP access network + +### 6.5.1 General + +In order to attach to the evolved packet core network (EPC) via untrusted non-3GPP IP access, the UE first needs to be configured with a local IP address from the untrusted non-3GPP access network. + +During the attach to the untrusted non-3GPP access, the operator of the non-3GPP access network may optionally require to perform a 3GPP based access authentication as specified in 3GPP TS 33.402 [15]. + +Once the UE is configured with a local IP address, the UE shall select the Evolved Packet Data Gateway (ePDG) as described in subclause 7.2.1 and shall initiate the IPsec tunnel establishment procedure as described in subclause 7.2.2. During these steps authentication and authorization for access to EPC shall be performed. + +## 6.5.2 Full authentication and authorization + +### 6.5.2.1 General + +During the establishment of the IPSec tunnel between the UE and the ePDG, 3GPP based authentication signalling for untrusted non-3GPP access to the EPC shall be exchanged between the UE and the 3GPP AAA server in the EPC to ensure mutual authentication of the user and the EPC. + +Authorization of EPC access shall be performed by the 3GPP AAA server upon successful user authentication. + +The access authentication signalling between the UE, ePDG and the 3GPP AAA server shall be based on EAP-AKA as specified in IETF RFC 4187 [33] and is further detailed in 3GPP TS 33.402 [15], 3GPP TS 29.273 [17] and procedural descriptions in subclauses 6.5.2.2, 6.5.2.4 and 6.5.2.3. + +### 6.5.2.2 UE procedures + +#### 6.5.2.2.1 General + +When accessing the EPC via the ePDG, the UE shall exchange EAP-AKA signalling with the 3GPP AAA server as specified in 3GPP TS 33.402 [15]. + +NOTE: the EAP payload exchanged between UE and 3GPP AAA server is transported within the IKEv2 messages exchanged with ePDG as described in subclause 7.2.2. + +After the UE has been successfully authenticated, if the UE receives EAP-Request/AKA-Notification dialogue with AT\_NOTIFICATION attribute value 1031 – "User has not subscribed to the requested service" as defined in IETF RFC 4187 [33], the UE shall not initiate the EPC access procedure to same ePDG until switching off or the UICC containing the USIM is removed. + +NOTE: Switching off and USIM change conditions are implemented taking into consideration the user experience aspect. + +#### 6.5.2.2.2 EAP AKA + +##### 6.5.2.2.2.1 Identity management + +The support of user identity privacy as defined in IETF RFC 4187 [33] and based on temporary identity is mandatory for the UE. + +As defined in 3GPP TS 33.402 [15], the UE sends the user identity (in the IDi payload) in the first message of the IKE\_AUTH phase. The user identity sent by the UE in the IDi payload depends on the presence of the temporary identity as defined in IETF RFC 4187 [33]: + +- If valid fast re-authentication identity is available, the UE shall use the fast re-authentication NAI; +- Otherwise if valid pseudonym is available, the UE shall use the pseudonym NAI; +- Otherwise the UE shall use the permanent IMSI-based or IMEI-based NAI. + +The temporary identities shall be in the form of a NAI, as specified in 3GPP TS 23.003 [3] clause 19. The permanent identity shall be in the form of a NAI in which username is derived from IMSI or IMEI as defined in 3GPP TS 23.003 [3]. IETF RFC 4187 [33] defines the leading digits to identify the authentication mechanism. The leading digit defined for EAP-AKA authentication shall be used in the NAI for both the temporary identities and the permanent identity. + +The UE after successful EAP authentication may store the new temporary identity(ies) received in AT\_ENCR\_DATA attribute together with the fast re-authentication parameters (new master key, transient EAP keys and counter value) in the non-volatile memory of the UE or in the USIM as specified in 3GPP TS 31.102 [45]. In this later case the pseudonym is stored in the "Pseudonym" data file and the fast re-authentication identity, new master key, transient EAP keys and counter value in the "Re-authentication identity" data file. + +If no new temporary identity was received in AT\_ENCR\_DATA attribute of a successful EAP authentication, the stored temporary identity becomes invalid and the UE shall not send this temporary identity at the next EAP authentication. In case the temporary identity is stored in the USIM, the UE shall set the username of the corresponding temporary + +identity field to the "deleted" value (hexadecimal value FF) to indicate that this temporary identity is invalid as specified in 3GPP TS 23.003 [3]. + +#### 6.5.2.2.2.2 Protected result indications + +The UE shall support protected result indications (i.e. MAC protected) as specified in IETF RFC 4187 [33]. + +### 6.5.2.3 3GPP AAA server procedures + +#### 6.5.2.3.1 General + +During the authentication of the UE for accessing the EPC via the ePDG, the 3GPP AAA server shall initiate EAP-AKA based authentication with the UE as specified in 3GPP TS 33.402 [15]. + +After the UE has been successfully authenticated and the EPC access is not authorized for the UE, the 3GPP AAA Server shall invoke an EAP-Request/AKA-Notification dialogue and indicate this to the UE by using the AT\_NOTIFICATION attribute value 1031 – "User has not subscribed to the requested service" as defined in IETF RFC 4187 [33]. + +#### 6.5.2.3.2 EAP-AKA + +##### 6.5.2.3.2.1 Identity management + +The support of user identity privacy is mandatory for the 3GPP AAA server. The usage of this feature depends on operator's policies. + +If user identity privacy is used, the 3GPP AAA server shall send new encrypted temporary identity (pseudonym and/ or fast re-authentication identity) to the UE in every EAP authentication procedure. The 3GPP AAA selects the pseudonym identity or the Fast Re-authentication Identity and returns the identity to the UE during the Authentication procedure as specified in 3GPP TS 33.402 [15]. The 3GPP AAA server shall maintain a mapping between the UE's permanent identity and the pseudonym identity and between the UE's permanent identity and the Fast Re-authentication Identity. + +##### 6.5.2.3.2.2 EAP AKA based authentication + +The 3GPP AAA server shall support EAP AKA based authentication as specified in IETF RFC 4187 [33]. + +##### 6.5.2.3.2.3 Fast re-authentication + +The 3GPP AAA server shall support fast re-authentication as specified in the IETF RFC 4187 [33]. Fast re-authentication should be enabled in the 3GPP AAA server. The decision of using fast re-authentication is taken in the 3GPP AAA server depending on operator's policies. The 3GPP AAA server indicates to the UE the decision of using fast re-authentication by means of sending the fast re-authentication identity in the EAP authentication procedure (i.e. in EAP-Request/AKA/Challenge or EAP-Request/AKA-re-authentication). When the 3GPP AAA server sends a fast re-authentication identity to the UE, the 3GPP AAA server shall also include a pseudonym when allowed by the IETF RFC 4187 [33]. In this way, the UE retains a pseudonym if the 3GPP AAA server defers to full authentication. + +##### 6.5.2.3.2.4 Protected result indications + +The 3GPP AAA server should support protected result indications (i.e. MAC protected) for EAP AKA as specified in IETF RFC 4187 [33]. The usage of this feature depends on operator's policies. + +### 6.5.2.4 ePDG procedures + +During the authentication of the UE for accessing the EPC via the ePDG, the ePDG shall initiate EAP-AKA based authentication between the UE and the 3GPP AAA server as specified in 3GPP TS 33.402 [15]. The ePDG shall extract the EAP messages received from the UE over IKEv2, and send them to the 3GPP AAA Server and shall send the EAP message received from the 3GPP AAA Server to the UE over IKEv2 messages as defined in 3GPP TS 33.402 [15]. + +At the reception of the first message of the IKE\_AUTH phase from the UE, indicating to the ePDG that the UE wants to use EAP over IKEv2 (i.e. AUTH parameter absent), the ePDG sends the Authentication and Authorization request to the 3GPP AAA server including the EAP\_resp/Identity in the EAP payload, with the User Identity retrieved from the IDi payload and the APN information retrieved from the IDr payload of the incoming message from the UE. + +### 6.5.3 Multiple PDN support for untrusted non-3GPP access network + +Connectivity to multiple PDNs via untrusted non-3GPP access is supported in the EPS when the network policies, the non-3GPP access and the user subscription allow it. + +NOTE 1: In 3GPP, there is a limitation to the maximum number of simultaneous PDN connections per UE caused by the number of EPS bearer identities (see subclause 11.2.3.1.5 of 3GPP TS 24.007 [48]) or by the number of PDU session IDs (see subclause 11.2.3.1b of 3GPP TS 24.007 [48]). Not complying with this limitation when accessing non-3GPP access can lead to unexpected consequences, e.g. connectivity loss in case of handover to 3GPP access. The maximum number of PDN connection via untrusted non-3GPP access is independent from the maximum number of active EPS bearer contexts for 3GPP access (see subclause 6.5.1A of 3GPP TS 24.301 [10]). + +If the UE supports dynamic mobility management selection the UE shall use the same mobility protocol when multiple connections are established, see 3GPP TS 23.402 [6]. + +When the UE accesses EPC via S2b using untrusted non-3GPP IP access, and the UE establishes additional PDN connections, the UE shall establish a new IPSec tunnel with the same ePDG for each PDN connection. For each tunnel establishment procedure, the UE shall indicate to the ePDG an APN to the desired PDN and an attach type indication as specified in subclause 7.2.2. When establishing an additional PDN connection, the UE shall not indicate the INITIAL\_CONTACT notification. + +NOTE 2: When using the S2b interface to establish an additional PDN connection, the new IPSec tunnel establishment includes a new IKEv2 authentication and security association establishment as specified in subclause 7.2.2. + +When the UE accesses EPC via S2c using untrusted non-3GPP IP access, the UE shall follow the procedures described in 3GPP TS 24.303 [11] when establishing multiple PDN connections. For multiple PDN connections, the UE shall establish only one IPSec tunnel to the ePDG. + +If the UE had more than one PDN connection to a given APN in the source access network and the UE is performing a handover to a target untrusted non-3GPP access network via an ePDG that supports accessing an EPC via S2b-interface, the UE shall transfer all the PDN connections for the given APN to the target untrusted non-3GPP access network as specified in 3GPP TS 23.402 [6]. + +If multiple PDN connections to a single APN are not supported over the target untrusted non-3GPP access network, only one PDN connection to that given APN shall be established in the target non-3GPP access network as specified in 3GPP TS 23.402 [6] if NBM is used. The UE, if supporting IP address preservation for NBM, shall include the home address information during the tunnel establishment procedure as specified in subclause 7.2.2. If multiple PDN connection requests to the same APN are received but the network does not support multiple PDN connections to the same APN, the ePDG shall reject the additional PDN connection requests to the same APN received from the UE as described in subclause 7.4.1, in the following circumstances: + +- when one PDN connection to the same APN has already been established; +- only after the network has successfully established one PDN connection in the case that the additional PDN connections requests were received prior to the successful establishment of a single PDN connection. + +In the above cases, the UE shall determine which PDN connection is re-established in the non-3GPP access based on the home address information provided by the network. + +The UE behaviour, when PDN connection re-establishment is rejected by the network during handover to the untrusted non-3GPP access network, is described in subclause 7.2.2. + +NOTE 3: When a UE supporting IP address preservation for NBM with multiple PDN connections to the same APN hands over to the non-3GPP access network, the UE can, as an implementation option, prioritise the re-establishment for a particular PDN connection before re-establishing the remaining PDN connections. The UE indicates the prioritised PDN connection by including both the APN in the IDr payload and the home address information in the Handover Attach indicator as specified in subclause 7.2.2. Another implementation option can be to send multiple re-establishment requests concurrently. + +If the UE did not handover all the PDN connections for a given APN to the target untrusted non-3GPP access network, the source network may disconnect the remaining PDN connections for that given APN after an implementation dependent time. + +## 6.6 UE - 3GPP EPC (cdma2000® HRPD Access) + +### 6.6.1 General + +3GPP2 X.S0057 [20] defines the interworking architecture for access to the EPC via cdma2000® HRPD access networks. In particular, 3GPP2 X.S0057 [20] describes support for a UE using the cdma2000® HRPD air interface to access the EPC architecture defined in 3GPP TS 23.402 [6] by: + +- specifying the use of the interface between the 3GPP2 HRPD Serving Gateway (HSGW) and the PDN Gateway (P-GW) in the EPC by referencing 3GPP TS 29.275 [18], when the HSGW supports UEs accessing EPC via S2a; +- specifying the use of the interface across the S101 reference point between the eAN/PCF in the 3GPP2 HRPD access network and the MME in the EPC by referencing 3GPP TS 29.276 [19]; +- specifying the use of the user plane interface across the S103 reference point between the EPC Serving Gateway (S-GW) and the HSGW by referencing 3GPP TS 29.276 [19]; and +- describing the internal functions and responsibilities of the HSGW. + +3GPP2 C.S0087 [21] defines the signalling requirements and procedures for UEs accessing the EPC via 3GPP2 HRPD access networks using the cdma2000® HRPD air interface. In particular, 3GPP2 C.S0087 [21]: + +- defines the signalling extensions to the cdma2000® HRPD air interface defined in 3GPP2 C.S0024 [23] necessary to support interworking with the EPC and E-UTRAN; and +- defines the UE and eAN/PCF procedures and signalling formats to support bidirectional handoff between E-UTRAN and cdma2000® HRPD. + +### 6.6.2 Non-emergency case + +#### 6.6.2.1 General + +Subclauses 6.6.2.2 through 6.6.2.7 describe the particular requirements for access to the EPC via a cdma2000® HRPD access network in support of non-emergency accesses and services. + +#### 6.6.2.2 UE identities + +The UE and network shall use the root NAI as specified in 3GPP TS 23.003 [3] for EPC access authentication when the UE obtains service via a cdma2000® HRPD access network connected to an EPC in the UE's HPLMN. + +Additionally, the UE and network shall use the Fast-Reauthentication NAI and the Pseudonym Identity as described in subclause 4.4. + +#### 6.6.2.3 cdma2000® HRPD access network identity + +The access network identity is described in 3GPP TS 23.003 [3] and in subclause 6.4.2.4 of this specification. For a cdma2000® HRPD network, the value and encoding of the access network identity is described in subclause 8.1.1. The 3GPP AAA server, HSS, and any visited network AAA proxy shall use the access network identity during EAP-AKA' authentication procedures (see 3GPP TS 33.402 [15]). + +#### 6.6.2.4 PLMN system selection + +The UE shall rely on information provisioned by the home operator to facilitate the PLMN system selection process described in 3GPP TS 23.122 [4]. + +#### 6.6.2.5 Trusted and untrusted accesses + +The UE shall determine the trust relationship for access to the EPC via a cdma2000® HRPD access network as described in subclause 4.1. + +#### 6.6.2.6 IP mobility mode selection + +The UE and network shall perform IP mobility mode selection as described in subclauses 6.3.3.1 and 6.4.3.2 + +### 6.6.2.7 Authentication and authorization for accessing EPC + +The UE and 3GPP AAA server shall perform authentication and authorization procedures for access to the EPC as defined in 3GPP TS 33.402 [15]. + +## 6.6.3 Emergency case + +### 6.6.3.1 General + +Subclauses 6.6.3.2 through 6.6.3.3 describe the particular requirements for access to the EPC via a cdma2000® HRPD access network in support of an emergency session in course of handover from E-UTRAN to HRPD. + +In this release of the specification no emergency session related handling other than the handover of an emergency session from E-UTRAN to a cdma2000® HRPD access network supporting access S-GW or PDN GW via S2a-interface is specified. + +### 6.6.3.2 UE identities + +When the UE obtains emergency services via a cdma2000® HRPD access network connected to an EPC in the UE's HPLMN, then the UE and the network shall use the NAI for EPC access authentication as follows: + +- if IMSI is available and authenticated , then the UE and the network shall use the root NAI; +- if IMSI is not available or unauthenticated, then the emergency NAI shall be used. + +Additionally, the UE and the network shall use the Fast-Reauthentication NAI and the Pseudonym Identity as described in subclause 4.4.1. + +### 6.6.3.3 Authentication and authorization for accessing EPC + +If IMSI is available, then the authentication and authorization procedures via STa are executed if the local regulation and network operator option requires authenticating the UE. + +If the authentication and authorization procedures fail, then it depends on local regulation and network operator option to allow or reject the emergency services for the UE. + +If IMSI is not available, the authentication and authorization procedures via STa are not executed. + +## 6.7 UE - 3GPP EPC (WiMAX Access) + +### 6.7.1 General + +The WiMAX system and its access network subsystem are described within WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 2 [24]. The protocol architecture and signalling of the WiMAX system is specified in WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25]. This protocol architecture and signalling supports the air interface defined in WiMAX Forum Mobile System Profile Release 1.0 Approved Specification Revision 1.4.0 [26] which specifies selected profiles of IEEE Std 802.16e-2005 and IEEE Std 802.16-2004/Cor1-2005 [27]. + +### 6.7.2 Non-emergency case + +#### 6.7.2.1 General + +Subclauses 6.7.2.2 through 6.7.2.7 describe the particular requirements for access to the EPC via a WiMAX access network in support of non-emergency accesses and services. + +#### 6.7.2.2 UE identities + +The UE and network shall use the root NAI as specified in 3GPP TS 23.003 [3] for EPC access authentication when the UE obtains service via a WiMAX access network connected to an EPC in the UE's HPLMN. + +Additionally, the UE and network shall use the Fast-Reauthentication NAI and the Pseudonym Identity as described in subclause 4.4. + +### 6.7.2.3 WiMAX access network identity + +The access network identity is described in 3GPP TS 23.003 [3] and in subclause 6.4.2.4 of this specification. For a WiMAX network, the value and encoding of the access network identity is described in subclause 8.1.1. The 3GPP AAA server, HSS, and any visited network AAA proxy shall use the access network identity during EAP-AKA authentication procedures (see 3GPP TS 33.402 [15]). + +### 6.7.2.4 Selection of the Network Service Provider + +The UE shall use WiMAX-specific procedures described in WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25] to discover and select the highest priority Network Service Provider (NSP) which is available and allowable. + +### 6.7.2.5 Trusted and untrusted accesses + +The UE shall determine the trust relationship for access to the EPC via a WiMAX access network as described in subclause 4.1. + +### 6.7.2.6 IP mobility mode selection + +The UE and network shall perform IP mobility mode selection as described in subclauses 6.3.3.1 and 6.4.3.2. + +### 6.7.2.7 Authentication and authorization for accessing EPC + +NOTE: In line with 3GPP TS 33.402 [15], in this present specification, no particular security provisions are specified for interworking between WiMAX and EPS. Any access specific security procedures for WiMAX as a non-3GPP access network to EPC will be in accordance with WiMAX Forum Network Architecture Release 1.0 version 1.2 – Stage 3 [25] and WiMAX Forum Mobile System Profile Release 1.0 Approved Specification Revision 1.4.0 [26]. + +## 6.7.3 Emergency case + +NOTE: Procedures for handling emergency accesses or services are not specified within this release of the specification + +## 6.8 Communication over the S14 + +### 6.8.1 General + +In order to assist the UE with performing access network discovery and selection, ANDSF provides a set of information to the UE. This information contains: + +- the access network discovery and selection information to assist the UE with selecting the access network; +- ISMP to control and assist the UE with performing the inter-system change; +- ISRP information to control and assist a UE with selecting the access network to be used for routing different IP flows over different access networks, establishing PDN connections and identifying IP flows applicable for non-seamless WLAN offload; +- IARP information to control and assist a UE with selecting a prioritised APN which is associated with an existing PDN connection for routing different IP flows. The IARP provided by ANDSF can also include information for identifying IP flows applicable for non-seamless WLAN offload. +- WLAN Selection Policy to assist the UE with selecting the WLAN access network; +- Home Network Preference information to assists the UE in selecting a WLAN and a service provider for 3GPP-based authentication over WLAN; +- Visited Network Preference information to assist the UE in selecting a WLAN and a service provider for 3GPP-based authentication over WLAN when the UE is roaming in a V-PLMN; or +- Rule selection information to assist the roaming UE with selecting the active ANDSF rules to be used. + +The ANDSF can provide ISRP rules to a UE independently of the UE's support for IFOM, MAPCON, NSWO, RAT differentiation in ISRP or RAN-assisted WLAN interworking. Handling of ISRP nodes unsupported by the UE is described in in 3GPP TS 24.312 [13]. + +The ANDSF can provide IARP rules to a UE independently of the UE's support for NSWO, Inter-APN routing or RAN-assisted WLAN interworking. Handling of IARP nodes unsupported by the UE is described in in 3GPP TS 24.312 [13]. + +This set of information can either be provisioned in the UE by the home operator, or provided to the UE by the ANDSF over the S14 reference point via pull or push mechanisms as defined in 3GPP TS 23.402 [6] by means of the access network discovery and selection procedures as described in subclause 6.8.2. While roaming, the UE can receive a set of information from H-ANDSF or V-ANDSF or both. The V-ANDSF shall not provide any IARP or rule selection information to a roaming UE. If the roaming UE receives any IARP or rule selection information delivered by a V-ANDSF then the roaming UE shall ignore it. + +The UE, located in the home PLMN, needs to discover the H-ANDSF by means of the discovery procedure as described in subclause 6.8.2.2.1. The UE, located in the visited PLMN, needs to discover the H-ANDSF or V-ANDSF or both by means of the discovery procedure as described in subclause 6.8.2.2.1. + +Through push mechanisms the ANDSF can provide assistance information to the UE e.g. if the UE has previously used pull based ANDSF procedure or if OMA-DM bootstrapping is used as described in subclause 6.8.2.2.1A. Through pull mechanisms the UE can send a request to the ANDSF in order to get assistance information for access network discovery and selection. + +ANDSF shall comply with local, national and regional requirements regarding the privacy and confidentiality of location information. + +NOTE: The regulation and legislations of the home operator of the ANDSF server determines whether the ANDSF server can store the user's location information. + +If the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, then the access stratum layer of the 3GPP access can provide RAN assistance parameters and corresponding (E-)UTRAN measurements which are used in accordance with the ANDSF MO defined in 3GPP TS 24.312 [13]. + +## 6.8.2 Interaction with the Access Network Discovery and Selection Function + +### 6.8.2.1 General + +The S14 interface enables IP level communication between the UE and ANDSF. The protocols supported by the S14 interface are realized above the IP level. Both pull and push mechanisms may be supported for communication between the UE and the ANDSF. A combination of pull and push mechanisms may also be supported. The communication security over the S14 interface is specified in 3GPP TS 33.402 [15]. + +The UE, located in a home PLMN, can communicate securely with the H-ANDSF. The UE, located in a visited PLMN, can communicate securely with H-ANDSF or V-ANDSF or both. + +The information is transferred between the UE and ANDSF using OMA DM as defined in OMA-ERELD-DM-V1\_2 [39] with the management object as specified in 3GPP TS 24.312 [13]. + +### 6.8.2.2 UE procedures + +#### 6.8.2.2.1 UE discovering the ANDSF + +The IP address of the H-ANDSF can be configured in the UE by the home operator. + +When the UE is in its HPLMN or equivalent HPLMN, the UE may use DNS lookup as specified in IETF RFC 1035 [35] or DHCP query as specified in IETF RFC 6153 [37] to discover the IP address of the H-ANDSF. If the UE implements DHCP query, the preference between DNS lookup and DHCP query is UE implementation dependent. . + +When the UE is in a visited PLMN, the UE shall use DNS lookup to discover the IP address of the ANDSF. + +When performing a DNS lookup resolution for ANDSF, the UE shall apply the following procedures: + +- For the H-ANDSF discovery, the UE shall build a Fully Qualified Domain Name (FQDN) that shall be set to the ANFSF-SN FQDN as defined in 3GPP TS 23.003 [3] for the DNS request and select the IP address of the H-ANDSF included in the DNS response message. +- For the V-ANDSF discovery, the V-ANDSF IP address by which the UE can contact the V-ANDSF is obtained by the UE through a DNS lookup by name as specified in IETF RFC 1035 [35]. The QNAME shall be set to the ANDSF-SN FQDN and included in the DNS Request as defined in 3GPP TS 23.003 [3], and select the IP address of the V-ANDSF included in the DNS response message. + +#### 6.8.2.2.1A ANDSF communication security + +According to 3GPP TS 33.402 [15], for the pull model, the UE and ANDSF shall use PSK TLS with GBA based shared key-based mutual authentication to establish a secure connection between UE and ANDSF as specified by subclause 5.4 of 3GPP TS 33.222 [44]. + +According to 3GPP TS 33.402 [15], for the push model, the UE and ANDSF shall use PSK TLS with GBA push based shared key-based mutual authentication to establish a secure connection between the UE and the ANDSF as specified by subclause 5.1 of 3GPP TS 33.223 [47]. + +In accordance with 3GPP TS 29.109 [43], the BSF shall provide either the UE's IMSI or IMPI to NAF, ie the ANDSF server. + +OMA-DM's application level authentication mechanism does not need to be used with ANDSF, since mutual security association is already established on transport level using PSK-TLS as specified in 3GPP TS 33.402 [15]. According to OMA-ERELD-DM-V1\_2 [39], however, each Managed Object (MO) shall have an access control list (ACL) that lists authorized OMA DM servers. In order to comply with OMA-ERELD-DM-V1\_2 [39], the ANDSF-SN FQDN shall be used as server name in the ACL list. + +If the UE does not support the ANDSF security mechanism as specified in 3GPP TS 33.402 [15], or if the operator does not implement the GAA bootstrap framework specified in 3GPP TS 33.220 [42], appropriate communication security can be established with the ANDSF using OMA-DM's bootstrap, secure http (https) mechanism and WAP Push according to OMA-ERELD-DM-V1\_2 [39]. + +#### 6.8.2.2.2 Role of UE for Push model + +The UE shall implement the push model of ANDSF in accordance with OMA-ERELD-DM-V1\_2 [39] using WAP Push, which is applicable for 3GPP access networks only. + +If the UE operates according to the GAA bootstrap framework specified in 3GPP TS 33.220 [42] and if the UE supports GBA Push as specified in 3GPP TS 33.223 [47], the UE shall accept the SMS as a valid ANDSF notification SMS if: + +- the notification SMS contains valid GBA Push Information (GPI) as specified in 3GPP TS 24.109 [52], +- the X-WAP-Application-ID field (Push Application ID) in the WSP header indicates ANDSF, +- the WSP payload contains only the header part defined in 3GPP TS 24.109 [52] and the GPI parameter without any additional identifiers and +- the NAF FQDN in GPI conforms to the ANDSF-SN specified in 3GPP TS 23.003 [3]. + +The short code for the X-WAP-Application-ID is specified in subclause 8.1.3. + +If the UE operates according to OMA DM bootstrap procedures as specified in OMA DM Enabler Release v.1.2, see OMA-ERELD-DM v1\_2 [39], the UE shall accept the SMS as a valid ANDSF notification SMS if it contains an OMA DM General Package #0 message according to OMA-ERELD-DM v1\_2 [39]. + +In the push model of communication, if the UE receives a valid ANDSF notification SMS from the ANDSF, the UE shall establish a secure data connection using the information received in the notification SMS. + +If the UE receives an invalid ANDSF notification SMS it shall be ignored by the UE. + +Upon establishing a secure connection between the UE and ANDSF, the UE may be provided with updated ISMP, ISRP, IARP, WLANSP and information about available access networks. The list of the information is described in subclause 6.8.1 and 6.8.2.3.3 and the correspondent ANDSF MO is defined in 3GPP TS 24.312 [13]. + +### 6.8.2.2.3 Role of UE for Pull model + +In the pull model of communication, the UE sends a query to ANDSF to retrieve or update inter-system mobility policy or information about available access networks in its vicinity or inter-APN routing policy or any combination of them. A UE supporting IFOM, MAPCON, NSWO or any combination of these may also request ISRP. A UE may request IARP. The UE will wait for an implementation dependent time for an answer from the ANDSF. If ANDSF does not respond within that time, further action by the UE is implementation dependent. The UE may provide to ANDSF the UE's location information including, if available, the location parameters (for example, cell identities or the MAC address of the WLAN AP) associated with the Radio Access Networks the UE has discovered in its current location at the time the UE sends a query to ANDSF; the format of the location information is described as UE\_Location in ANDSF MO defined in 3GPP TS 24.312 [13]. + +After communicating with ANDSF, the UE may be provided with updated ISMP, ISRP, IARP, WLANSP and information about available access networks. The list of the information is described in subclause 6.8.1 and 6.8.2.3.3 and the correspondent ANDSF MO is defined in 3GPP TS 24.312 [13]. + +The UE may start Pull model communication with ANDSF based upon the information previously received from the ANDSF (e.g. based on the value of UpdatePolicy leaf defined in 3GPP TS 24.312 [13]). The UE capable of IFOM, MAPCON, or non-seamless WLAN offload (or any combination of these capabilities) can have all these capabilities disabled and have no ISRP. If the UE enables one (or more) of these capabilities, the UE may start Pull model communication with ANDSF. The UE capable of IFOM, MAPCON, or non-seamless WLAN offload (or any combination of these capabilities) can have one (or more) of these capabilities enabled and have no ISMP. If the UE disables all these capabilities, the UE may start Pull model communication with ANDSF. If the UE has no IARP, the UE may start Pull model communication with ANDSF. + +NOTE: Mechanisms to limit the frequency of queries transmission from the UE to the ANDSF are implementation dependant. + +### 6.8.2.2.4 UE using information provided by ANDSF + +#### 6.8.2.2.4.1 General + +ANDSF may provide various types of information to the UE, including access network discovery information, WLAN selection information, ePDG configuration information, inter-system mobility policy, the inter-system routing policies and the inter-APN routing policies. The UE may retain and use this ANDSF information until new or updated information is received. + +Network detection and selection shall take into account the access network specific requirements and the UE's local policy, e.g. user preference settings, access history, etc, along with the information provided by the ANDSF when discovering and selecting an access network. The local policy and the information provided by the ANDSF shall be used by the UE in an implementation dependent way to limit the undesired alternating between access systems, e.g. ping-pong type of inter-system changes. However, the use of such information from the ANDSF shall not be in contradiction to functions specified in 3GPP TS 23.122 [4], 3GPP TS 25.304 [14] and 3GPP TS 36.304 [16]. + +If the UE is roaming in a VPLMN, the UE may receive Inter-system mobility policies or Access network discovery information or ISRP or combinations of these from H-ANDSF or V-ANDSF or both. The UE may also receive the IARP from H-ANDSF. If IARP is received from V-ANDSF, the UE shall ignore it. The UE may also receive WLAN selection information including WLAN Selection Policy (WLANSP) from H-ANDSF or V-ANDSF or both, rule selection information, and Home Network Preference information from H-ANDSF. The UE may receive Visited Network Preference information from V-ANDSF. The UE may also receive ePDG configuration information from H-ANDSF. The formats of the above information are defined in 3GPP TS 24.312 [13]. + +The maximum number of sets of Inter-system mobility policies or Access network discovery information or ISRP or IARP or combinations of these that the UE may keep is implementation dependent. However, the UE shall retain at least one set of Inter-system mobility policies and one set of Access network discovery information from the same ANDSF. In addition, a UE supporting IFOM, MAPCON, or non-seamless WLAN offload shall retain at least one ISRP rule from the same ANDSF. Additionally, a UE shall retain at least one set of IARP received from the H-ANDSF. + +If a UE supporting IFOM, MAPCON, or non-seamless WLAN offload (or any combination of these features) has ISMP and ISRP available, and if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, then ISRP shall be used for the routing of IP traffic. The relation between ISRP and user preferences is described in subclause 5.4.2. + +For a UE with IFOM, MAPCON or non-seamless WLAN offload (or any combination of these capabilities) enabled, if ISMP, ISRP and IARP are available, and if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, then IARP and ISRP shall be used. In this case, the UE shall first apply IARP followed by ISRP as follows: + +- If non-seamless WLAN offload is selected by IARP then the IP flow is routed to the non-seamless WLAN offload and ISRP shall not be used for the routing of IP traffic. +- If a certain APN is selected by IARP then the IP flow is routed to the PDN connections corresponding to this APN. If there is a ForFlowBased ISRP rule matching the IP flow after the APN is selected, then the UE shall use the ForFlowBased ISRP rule matching the IP flow to select the access for this IP flow. +- If neither certain APN nor non-seamless WLAN offload is selected by IARP or one or more APNs are restricted by the IARP for routing the IP flow, then ISRP shall be used for the routing of IP traffic. When one or more APNs are restricted by the IARP, if a rule for NSWO is matched in the active ISRP rule that restricts the use of the selected WLAN (or any WLAN) for routing the IP flow, then the UE selects a not restricted APN to route the IP flow. + +The relation between IARP and user preferences is described in subclause 5.4.2. + +For a UE not supporting any of IFOM, MAPCON or non-seamless offload capabilities or with all those capabilities disabled, if ISMP and ISRP are available, and if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, the ISMP shall be used. + +For a UE not supporting any of IFOM, MAPCON capabilities or with all those capabilities disabled, if ISMP, ISRP and IARP are available, and if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, the IARP and ISMP shall be used. In this case, the UE shall firstly apply ISMP followed by IARP as follows: + +- If the 3GPP access is selected by ISMP policy, then the UE shall use the active IARP rule to determine if the IP flow is routed to the PDN connection corresponding to a certain APN. The non-seamless WLAN offload policy, defined in the IARP, shall not be used for routing of IP traffic; and +- If the WLAN access is selected by ISMP policy, then the UE shall use the active IARP rule to determine if the IP flow is routed to the PDN connection corresponding to a certain APN or using the non-seamless WLAN offload. + +This information shall be deleted if there is a change of USIM. This information may be deleted when UE is switched off. + +If the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, irrespective of whether any rule in ANDSF policies is 'active' or not, the UE shall periodically re-evaluate ANDSF policies. The value of the periodic re-evaluation timer is implementation dependant. The additional trigger for (re-)evaluating rules is that the 'active' rule becomes invalid (conditions no longer fulfilled), or other manufacturer specific trigger. When the UE receives ANDSF information it shall re-evaluate the available rules along with the new information. + +#### 6.8.2.2.4.2 Use of Inter-system Mobility Policy + +This subclause applies if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2. + +If more than one set of Inter-system mobility policies is available in the UE, the UE shall only use one set of Inter-system mobility policies at any one time. + +When the UE is roaming and receives Inter-system Mobility Policies from both H-ANDSF and V-ANDSF, the set of Inter-system Mobility Policies used by the UE is selected as follows: + +- If there is rule selection information provisioned in the UE by the H-ANDSF, and if the RPLMN identity is equal to one of the VPLMNs included in the visited PLMNs with preferred rules, the set of Inter-system Mobility Policies from V-ANDSF is selected by the UE. + +If the preferred access technology according to the Inter-system Mobility Policy is WLAN access technology, and if there is no WLANs matching the WLANSP rule(s) from the V-ANDSF, the set of Inter-system Mobility Policies from H-ANDSF is selected by the UE. However, if at least one WLAN matching one or more groups of selection criteria in the VPLMN's WLANSP rule becomes available, the UE should re-use the WLANSP policies and Inter-system Mobility Policies from V-ANDSF. + +- If there is rule selection information provisioned in the UE by the H-ANDSF, and if the RPLMN identity is not equal to any of the VPLMNs included in the visited PLMNs with preferred rules, the set of Inter-system Policies from H-ANDSF is selected by the UE. + +If the preferred access technology according to the Inter-system Mobility Policy is WLAN access technology, and if there is no WLANs matching the WLANSP rule(s) from the H-ANDSF, the set of of Inter-system Mobility Policies from V-ANDSF is selected by the UE. However, if at least one WLAN matching one or more groups of selection criteria in the HPLMN's WLANSP rule becomes available, the UE should re-use the WLANSP policies and Inter-system Mobility Policies from H-ANDSF. + +NOTE: How frequently the UE performs the discovery and reselection procedure depends on the UE implementation. + +The Inter-system Mobility Policy with the highest priority among the set of Inter-system Mobility Policies selected above is selected as the active Inter-system Mobility Policy. A UE uses the ISMP to decide if the most preferred available WLAN based on the WLANSP rule has higher priority than the 3GPP RAT. If so, the UE shall connect to EPC via WLAN access. Otherwise, the UE shall connect to EPC via 3GPP access. The prioritized list of WLAN in the active ISMP rule shall not be used for WLAN selection. + +When applying the Inter-system mobility policy the following requirements apply:- + +- the requirements on periodic network reselection as described in subclause 5.3.4 of the present specification; +- the PLMN selection rules specified in 3GPP TS 23.122 [4] and in subclause 5.2.3.2; +- the selection rules specified in 3GPP2 C.P0016-D [23a]; and +- the 3GPP RAT selection, cell selection and reselection rules specified in 3GPP TS 25.304 [14], 3GPP TS 36.304 [16] and 3GPP TS 45.008 [16a]. + +#### 6.8.2.2.4.3 Use of Access Network Discovery Information + +The UE may use the received Access network discovery information of both the H-ANSDF and V-ANDSF for network discovery and detection. The Access network discovery information received from:- + +- a) the H-ANDSF provides guidance for the UE on access networks that have connectivity to the HPLMN or equivalent HPLMNs or both; and +- b) the V-ANDSF provides guidance for the UE on access networks that have connectivity to the corresponding VPLMN or equivalent PLMNs or both. + +#### 6.8.2.2.4.4 Use of Inter-System Routing Policies + +This subclause applies if the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2. + +A UE supporting IFOM, MAPCON, or non-seamless WLAN offload (or any combination of these features) shall use the ISRP if available. + +A UE supporting IFOM uses the ISRP to: + +- select an access technology or an access network or both for routing user plane traffic matching specific IP flows on a specific or any APN identified in the ISRP. 3GPP RATs can be prioritized with respect to WLAN access but this prioritization does not influence 3GPP RAT selection; WLAN access networks can be prioritized with respect to 3GPP RATs but those WLANs do not influence WLAN selection; and +- decide if an access technology or access network or both are restricted for a specific IP flows on a specific or any APN identified in the ISRP. + +A UE supporting MAPCON uses the ISRP to: + +- select an access technology or an access network or both for routing user plane traffic matching a specific APN or any APN identified in the ISRP. 3GPP RATs can be prioritized with respect to WLAN access but this prioritization does not influence 3GPP RAT selection; WLAN access networks can be prioritized with respect to 3GPP RATs but those WLANs do not influence WLAN selection; and + +- decide if an access technology or an access network or both are restricted for a specific APN or any APN identified in the ISRP. + +NOTE: After selecting WLAN access for routing user plane traffic by this prioritised list of access technologies, a UE can use an implementation dependent way to prevent the traffic from being routed back to the original RAT again in a short period of time to avoid ping-pong behaviour. + +A UE supporting non-seamless WLAN offload uses the ISRP to: + +- select a WLAN access network for routing, without traversing the EPC, user plane traffic matching specific IP flows for a specific APN or any APN identified in the ISRP; WLAN access networks defined in routing rule do not influence WLAN selection; and +- decide if the selected WLAN access network is restricted for routing, without traversing the EPC, a specific IP flows for a specific APN or any APN identified in the ISRP. If not, the selected WLAN can be used to perform NSWO. + +When the UE supporting IFOM identifies an access technology or an access network or both over which an IP flow can be routed based on the ISRP, the UE shall apply the IFOM procedures specified in 3GPP TS 24.303 [11] to move an on-going IP flow from the source access technology or access network to the identified access technology or access network, if required. + +If more than one set of ISRP is available in the UE, the UE shall only use one ISRP at any one time. + +When the UE is roaming and receives Inter-system Routing Policies from both H-ANDSF and V-ANDSF, the set of Inter-system Routing Policies used by the UE is selected as follows: + +- If there is rule selection information provisioned in the UE by the H-ANDSF, and if the RPLMN identity is equal to one of the VPLMNs included in the visited PLMNs with preferred rules, the set of Inter-system Routing Policies from V-ANDSF is selected by the UE. + +If there are no WLANs matching the WLANSP rule(s) from the V-ANDSF, the set of Inter-system Routing Policy from the H-ANDSF is re-selected. However, if at least one WLAN matching one or more groups of selection criteria in the WLANSP rule of the VPLMN becomes available, the UE should re-use the WLANSP policies and Inter-system Routing Policies from V-ANDSF. + +- If there is rule selection information provisioned in the UE by the H-ANDSF, and if the RPLMN identity is not equal to any of the VPLMNs included in the visited PLMNs with preferred rules, the set of Inter-system Routing Policies from H-ANDSF is selected by the UE, + +If there are no WLANs matching the WLANSP rule(s) from the H-ANDSF, the set of Inter-system Routing Policy from the V-ANDSF is re-selected. However, if at least one WLAN matching one or more groups of selection criteria in the WLANSP rule of the HPLMN becomes available, the UE should re-use the WLANSP policies and Inter-system Routing Policies from H-ANDSF. + +NOTE: How frequently the UE performs the discovery and reselection procedure depends on the UE implementation. + +The Inter-system Routing Policy with the highest priority among the set of Inter-system Routing Policies selected above is selected as the active Inter-system Routing Policy. + +The UE shall periodically re-evaluate the flow distribution rules of the 'active' ISRP rule. The value of the periodic re-evaluation timer is implementation dependant. + +#### 6.8.2.2.4.5 Use of Inter-APN Routing Policies + +The UE shall use the IARP for APN if available. + +The UE shall use the IARP for non-seamless WLAN offload if available, and the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2. + +A UE uses the IARP to: + +- select an APN or non-seamless WLAN offload for routing user plane traffic matching specific IP flows; and +- decide if an APN or non-seamless WLAN offload is restricted for routing a specific IP flows. + +An IARP for APN can be applied only when it steers IP traffic to an existing (i.e. already established) PDN connection. Also, the scenario where multiple PDN connections via the same access network are associated with the same APN is not specified in the present document. + +When applying IARP the same requirements defined for inter-system mobility policy in subclause 6.8.2.2.4.2 applies with the exception that the UE shall apply IARP provided by the H-ANDSF. + +If no valid IARP present, then Inter-APN routing policy configuration is UE implementation dependent. + +#### 6.8.2.2.4.6 Use of WLAN selection information + +The UE uses the WLAN selection information provided by ANDSF to determine the selected WLAN and the selected service provider. + +The UE first uses WLAN Selection Policy (WLANS) and the visited PLMNs with preferred rules to determine the active WLANS rule. When roaming, if the UE is configured to prefer WLAN selection rules provided by the HPLMN, WLANS provided by HPLMN is used. Otherwise, WLANS provided by VPLMN is used. The UE selects the highest priority and valid WLANS rule as the active WLANS rule. + +During power-up, while the UE has not registered to any PLMN, the UE shall use WLANS provided by the HPLMN as valid. + +The UE determines the selected WLAN(s) as specified in subclause 5.1.3.2. If there are no selected WLANs according to active WLANS rule of the VPLMN/HPLMN, then the UE uses the WLANS policies from the HPLMN/VPLMN as active WLANS rule. However, if at least one WLAN that matches one or more groups of selection criteria in the WLANS rule of the VPLMN or the HPLMN becomes available, the UE should re-use the WLANS policies from the VPLMN or the HPLMN as active WLANS rule. + +NOTE: How frequently the UE performs the discovery and reselection procedure depends on the UE implementation. + +Home Network Preference information and Visited Network Preference information can be configured in the ANDSF MO to assist the UE in selecting a service provider over the selected WLAN(s) and constructing an appropriate NAI when attempting authentication with the selected service provider. + +The UE uses the list of selected WLANs and the Home Network Preference information (or the Visited Network Preference information if available and if the UE is roaming) to select a WLAN service provider as specified in subclause 5.2.3.2. + +#### 6.8.2.2.4.7 Use of ePDG information + +If the UE accesses EPC via the ePDG, the UE shall use the ePDG configuration information during the tunnel establishment procedure to determine the home operator preference on ePDG connection as described in subclause 7.2.1. + +#### 6.8.2.2.4.8 Use of LWA co-existence Information + +The H-ANDSF can configure the LWA co-existence information about the preference between the WLANS, ISRP and IARP for NSWO rules, on the one hand, and the LWA/RCLWI/LWIP procedures defined in the RAN, on the other hand, according to TS 23.402 [6]. The LWA co-existence information is configured in the ANDSF/HomeNetworkPreference/RanMobilitySetUsed node. + +If the UE: + +- has not selected a WLAN according to the WLANS rules or user preferences, including when the UE has not selected any WLAN; or +- has selected a WLAN according to the WLANS rules and is connected to a PLMN/WLAN combination configured in the ANDSF/HomeNetworkPreference/RanMobilitySetUsed node, + +the UE shall use the WLAN mobility set (see 3GPP TS 36.300 [70]) and ignore the WLANS, ISRP and IARP for NSWO rules. In order to apply the WLAN mobility set, the UE may disconnect from the WLAN it is currently connected to and connect to a WLAN identified by the RAN-configured WLAN mobility set. + +If the UE: + +- has selected a WLAN according to the WLANSP rules and is not connected to a PLMN/WLAN combination configured in the ANDSF/HomeNetworkPreference/RanMobilitySetUsed node; or +- has selected a WLAN based on user preferences, + +the UE shall ignore the WLAN mobility set and apply the WLANSP, ISRP and IARP for NSWO rules. + +### 6.8.2.3 ANDSF procedures + +#### 6.8.2.3.1 General + +Both the H-ANDSF and the V-ANDSF can provide information about inter-system mobility policy or information about available access networks in the vicinity of the UE or ISRP for the UE or combinations of these. The H-ANDSF may also provide IARP for the UE. The V-ANDSF shall not provide any IARP to a roaming UE. The inter-system mobility policies may be organized in a hierarchy and a priority order among multiple policies may determine which policy has the highest priority. The policies may indicate preference of one access network over another or may restrict inter-system mobility to a particular access network under certain conditions. The ANDSF may also specify validity conditions which indicate when a policy is valid. Such conditions may be based on time duration, location, RAN validity condition. The ANDSF may limit the information provided to the UE. This can be based on UE's current location, UE capabilities other than the capability of routing IP traffic simultaneously over multiple radio access interfaces (e.g. IFOM capability or MAPCON capability or non-seamless WLAN offload capability), etc. How the ANDSF decides how much information to provide to the UE is dependent on network implementation. + +#### 6.8.2.3.2 Role of ANDSF for Push model + +If there is no existing valid PSK TLS connection between the UE and ANDSF, the ANDSF, not implementing GBA Push, may send a notification SMS to the UE, without establishing a data connection with the UE. + +If there is no existing valid PSK TLS connection between the UE and ANDSF, the ANDSF, implementing GBA Push, shall send a message via SMS to the UE to establish a secure connection between the UE and ANDSF. The contents of the message shall contain a GBA Push Information as specified in 3GPP TS 33.223 [47]. + +After a secure connection is established according to subclause 6.8.2.2.1A, or if there is a valid PSK TLS connection between the UE and ANDSF, the ANDSF shall use the connection to provision ANDSF information to the UE. + +#### 6.8.2.3.3 Role of ANDSF for Pull model + +When the UE connects to an ANDSF, the ANDSF may provide the UE with ISMP, ISRP, IARP, WLANSP or information related to available access networks in the vicinity of the UE, or combinations of these. In case of information about available access networks, the ANDSF provides the following information about each available access network in the form of a list containing: + +- 1) Type of Access network (e.g. WLAN, WiMAX); +- 2) Location of Access Network (e.g. 3GPP location, WLAN location); +- 3) Access Network specific information (e.g. WLAN information, WiMAX information); and +- 4) Operator differentiated text field (if supported, e.g. if WNDS MO defined in 3GPP TS 24.312 [13] is used). + +The detailed list of information is described in 3GPP TS 24.312 [13]. + +## 6.9 Handling of Protocol Configuration Options information + +The Protocol Configuration Options (PCO) information element is specified in 3GPP TS 24.008 [46]. + +The support of PCOs is optional for the UE and the non-3GPP access network. + +Except for the trusted WLAN access, the content syntax of PCOs for the non-3GPP access UE and non-3GPP access network is access network specific and not in the scope of 3GPP, but if PCO is supported, the UE and the PDN-GW shall handle the PCO contents in accordance with 3GPP TS 24.008 [46]. + +PCO information is exchanged between the UE and the PDN-GW, see 3GPP TS 23.402 [6], 3GPP TS 29.274 [50] and 3GPP TS 29.275 [18]. Except for the trusted WLAN access, the specification of PCO signalling in the non-3GPP access network is access network specific and not in the scope of 3GPP. + +When the UE access EPC via trusted WLAN access network, + +- if SCM is used, the PCO is supported as described in subclause 6.4.2.6, 3GPP TS 29.274 [50] and 3GPP TS 29.275 [18]; +- if MCM is used, the PCO is supported as described in 3GPP TS 24.244 [56], 3GPP TS 29.274 [50] and 3GPP TS 29.275 [18];and +- if TSCM is used, the PCO is not supported by the UE. + +## 6.10 Integration with access stratum layer of 3GPP access + +### 6.10.1 General + +The subclause describes the additional procedures for integration with access stratum layer of 3GPP access. + +If the RAN assistance information is supported by the UE and the E-UTRAN or UTRAN, the E-UTRAN or UTRAN can provide RAN assistance information to the UE as described in 3GPP TS 25.331 [14A] and 3GPP TS 36.331 [16B]. + +### 6.10.2 Selection of control of WLAN access selection and traffic routing + +The WLAN access selection and traffic routing can be controlled either by ANDSF rules or by RAN rules. + +The ANDSF rules control the WLAN access selection and traffic routing if: + +- a) the UE has ANDSF rules but no RAN rules; or +- b) the UE has both ANDSF rules and RAN rules; and: + - 1) the UE is not capable to simultaneously route IP traffic to both 3GPP access and WLAN; and: + - A) the UE is not roaming and the UE has at least one ISMP rule from HPLMN; + - B) the UE is roaming in a VPLMN contained in the visited PLMNs with preferred rules and the UE has at least one ISMP rule from VPLMN; or + - C) the UE is roaming in a VPLMN not contained in the visited PLMNs with preferred rules and the UE has at least one ISMP rule from HPLMN; or + - 2) the UE is capable to simultaneously route IP traffic to both 3GPP access and WLAN; and: + - A) the UE is not roaming and the UE has an valid ISRP rule from HPLMN; + - B) the UE is roaming in a VPLMN contained in the visited PLMNs with preferred rules and the UE has a valid ISRP rule from VPLMN; or + - C) the UE is roaming in a VPLMN not contained in the visited PLMNs with preferred rules and the UE has a valid ISRP rule from HPLMN. + +The RAN rules control the WLAN access selection and traffic routing if: + +- a) the UE has RAN rules but no ANDSF rules; or +- b) the UE has both ANDSF rules and RAN rules; and: + - 1) the UE is not capable to simultaneously route IP traffic to both 3GPP access and WLAN; and: + - A) the UE is not roaming and the UE has no ISMP rules from HPLMN; + - B) the UE is roaming in a VPLMN contained in the visited PLMNs with preferred rules and the UE has no ISMP rules from VPLMN; or + - C) the UE is roaming in a VPLMN not contained in the visited PLMNs with preferred rules and the UE has no ISMP rules from HPLMN; or + - 2) the UE is capable to simultaneously route IP traffic to both 3GPP access and WLAN, and: + +- A) the UE is not roaming and the UE has no valid ISRP rule from HPLMN; +- B) the UE is roaming in a VPLMN contained in the visited PLMNs with preferred rules and the UE has no valid ISRP rule from VPLMN; or +- C) the UE is roaming in a VPLMN not contained in the visited PLMNs with preferred rules and the UE has no valid ISRP rule from HPLMN. + +### 6.10.3 Additional procedures when WLAN access selection and traffic routing is controlled by ANDSF rules + +If the ANDSF rules control the WLAN access selection and traffic routing as described in subclause 6.10.2, the access stratum layer of the 3GPP access provides the received RAN assistance parameters to this layer and the UE shall store the RAN assistance parameters and then use the RAN assistance information together with ANDSF rules specified in 3GPP TS 24.312 [13] and measurements results to make traffic routing decisions to move traffic to WLAN or to E-UTRAN or UTRAN by: + +- comparing the received RAN assistance thresholds with corresponding measurement results; and +- comparing the received OPI value with the provisioned OPI value provided by the ANDSF. + +The following thresholds can be used for traffic routing from E-UTRAN or UTRAN to WLAN: + +- ThreshServingOffloadWLANLowP; +- ThreshServingOffloadWLANLowQ; +- ThreshChUtilWLANLow; +- ThreshBackhRateDLWLANHigh; +- ThreshBackhRateULWLANHigh; and +- ThreshBeaconRSSIWLANHigh. + +The following thresholds can be used for traffic routing from WLAN to E-UTRAN or UTRAN: + +- ThreshServingOffloadWLANHighP; +- ThreshServingOffloadWLANHighQ; +- ThreshChUtilWLANHigh; +- ThreshBackhRateDLWLANLow; +- ThreshBackhRateULWLANLow; and +- ThreshBeaconRSSIWLANLow. + +Offload Preference Indication (OPI) parameter can be used for traffic routing in both directions, from E-UTRAN or UTRAN to WLAN or from WLAN to E-UTRAN or UTRAN. + +### 6.10.4 Additional procedures when WLAN access selection and traffic routing is controlled by RAN rules + +This subclause applies if the RAN rules control the WLAN access selection and traffic routing as described in subclause 6.10.2. + +The access stratum layer of the 3GPP access can provide: + +- 1) move-traffic-to-WLAN indication, along with list of WLAN identifiers. An entry in the list of the WLAN identifiers consists of SSID, BSSID, HESSID, or any combination of them; and +- 2) move-traffic-from-WLAN indication. + +The user preferences take precedence over the indications provided by the access stratum layer of the 3GPP access. + +NOTE 1: Handling of the move-traffic-from-WLAN indication and the move-traffic-to-WLAN indication for a multi-access PDN connection where the network-initiated NBIFOM mode is the selected NBIFOM mode, is specified in 3GPP TS 24.161 [69]. + +Upon: + +- receiving move-traffic-to-WLAN indication, along with the list of the WLAN identifiers, if the user preferences are not present; or +- establishment of a new PDN connection in 3GPP access, if the PDN connection is an offloadable PDN connection, the access stratum indicated move-traffic-to-WLAN, the access stratum has not indicated the move-traffic-from-WLAN indication after indicating of the move-traffic-to-WLAN indication and the user preferences are not present; + +and: + +- the UE is capable to simultaneously route IP traffic to both 3GPP access and WLAN and has at least one PDN connection which is not a multi-access PDN connection or where the UE-initiated NBIFOM mode is the selected NBIFOM mode as specified in 3GPP TS 24.161 [69]; or +- the UE is not capable to simultaneously route IP traffic to both 3GPP access and WLAN, and all the PDN connections of the UE in 3GPP access are offloadable PDN connections; + +the UE: + +- a) shall perform the procedure in subclause 5.1.3.2.3 and in subclause 5.2.3.2 to select the selected WLAN and the NAI for authentication; +- b) if not authenticated yet with the selected WLAN using the NAI for authentication in subclause 6.4, shall authenticate with the selected WLAN using the NAI for authentication in subclause 6.4. During authentication, if the selected WLAN is a trusted WLAN, SCM is supported by both UE and network, MCM is not supported by UE, network or both, and if: + - the UE is capable to simultaneously route IP traffic to both 3GPP access and WLAN and has at least one PDN connection which is not a multi-access PDN connection or where the UE-initiated NBIFOM mode is the selected NBIFOM mode as specified in 3GPP TS 24.161 [69]; or + - the UE is not capable to simultaneously route IP traffic to both 3GPP access and WLAN, and the UE has only one PDN connection; + +shall handover one PDN connection: + +- which is an offloadable PDN connection; and +- which is not a multi-access PDN connection or where the UE-initiated NBIFOM mode is the selected NBIFOM mode as specified in 3GPP TS 24.161 [69]; + +from 3GPP access to the WLAN access using procedures in subclause 6.4.2.6.2; + +NOTE 2: When the UE already has one PDN connection established via WLAN in SCM, and if move-traffic-to-WLAN indication is received, it is up to the UE implementation to determine whether to offload a PDN connection from 3GPP access to WLAN. In that case, it is also up to the UE implementation to determine which one of the offloadable PDN connections will be offloaded. + +- c) if the selected WLAN is a trusted WLAN, and MCM is supported by both UE and network, shall handover all the PDN connections: + +- which are offloadable PDN connections; and +- which are not a multi-access PDN connection or where the UE-initiated NBIFOM mode is the selected NBIFOM mode as specified in 3GPP TS 24.161 [69]; + +from 3GPP access to the WLAN access using procedures of 3GPP TS 24.244 [56]; + +- d) if the selected WLAN is an untrusted WLAN, and if the UE supports access to EPC via untrusted WLAN, shall handover all the PDN connections: + +- which are offloadable PDN connections; and +- which are not a multi-access PDN connection or where the UE-initiated NBIFOM mode is the selected NBIFOM mode as specified in 3GPP TS 24.161 [69]; + +from 3GPP access to the WLAN access using procedures in subclause 7.2.1 and subclause 7.2.2; and + +- e) if the UE has a valid IARP rule for APN, shall use the IARP for APN using the procedures in subclause 6.8.2.2.4.5. + +Upon receiving move-traffic-from-WLAN indication, and if the user preferences are not present, the UE shall handover all the PDN connections: + +- established in (or previously handed over to) WLAN access; and +- which are not a multi-access PDN connection or where the UE-initiated NBIFOM mode is the selected NBIFOM mode as specified in 3GPP TS 24.161 [69]; + +from WLAN access to the 3GPP access using procedures in 3GPP TS 24.301 [10]. + +--- + +## 7 Tunnel management procedures + +### 7.1 General + +The purpose of tunnel management procedures is to define the procedures for establishment or disconnection of an end-to-end tunnel between the UE and the ePDG. The tunnel establishment procedure is always initiated by the UE, whereas the tunnel disconnection procedure can be initiated by the UE or the ePDG. + +The tunnel is an IPsec tunnel (see IETF RFC 4301 [30]) established via an IKEv2 protocol exchange IETF RFC 7296 [28] between the UE and the ePDG. The UE may indicate support for IETF RFC 4555 [31]. The security mechanisms for tunnel setup using IPsec and IKEv2 are specified in 3GPP TS 33.402 [15]. + +### 7.2 UE procedures + +#### 7.2.1 Selection of the ePDG + +##### 7.2.1.1 General + +If the UE does not support ePDG selection according to 3GPP TS 24.502 [77], the UE performs ePDG selection based on the ePDG configuration information configured by the home operator in the UE either via H-ANDSF or via USIM or via implementation specific means. Implementation specific means apply only if the configurations via H-ANDSF and USIM are not present. The ePDG configuration information may consist of home ePDG identifier or ePDG selection information or both: + +- when available in ANDSF MO, the ePDG configuration information is provisioned in ePDG node under Home Network Preference as specified in 3GPP TS 24.312 [13]; and +- when available in USIM, the ePDG configuration information is provisioned in EFePDGId and EFePDGSelection files as specified in 3GPP TS 31.102 [45]. + +The ePDG configuration information provided by ANDSF may also be pre-configured by the home operator on the ME or provisioned on the UICC. The UE shall use the information in the following order of precedence: + +- 1) ePDG configuration information provided by the ANDSF server to the ME; +- 2) ePDG configuration information configured on the UICC; +- 3) ePDG configuration information pre-configured on the ME. + +The UE shall support the implementation of standard DNS mechanisms in order to retrieve the IP address(es) of the ePDG. The input to the DNS query is an ePDG FQDN as specified in subclause 4.4.3 and in 3GPP TS 23.003 [3]. + +If the UE supports ePDG selection according to 3GPP TS 24.502 [77], then the UE selects the ePDG according to 3GPP TS 24.502 [77]. + +### 7.2.1.2 Determination of the country the UE is located in + +If the UE cannot determine whether it is located in the home country or in a visited country, as required by the ePDG selection procedure specified in 3GPP TS 23.402 [6], the UE shall stop the ePDG selection. + +NOTE: It is out of scope of the present specification to define how the UE determines whether it is located in the home country or in a visited country or in a location that does not belong to any country. When the UE is in coverage of a 3GPP RAT, it can, for example, use the information derived from the available PLMN(s). In this case, the UE can match the MCC of the PLMN to which a cell belongs, broadcast on the BCCH of the 3GPP access, against the UE's IMSI to determine if they belong to the same country, as defined in 3GPP TS 23.122 [4]. If the UE is not in coverage of a 3GPP RAT, the UE can use other techniques, including user-provided location. + +### 7.2.1.3 Handling of ePDG selection based on the country the UE is located in + +The UE shall proceed as follows: + +- 1) if the UE is located in its home country and + - a) if the ePDG selection information is provisioned in the ePDG configuration information and if an entry for the HPLMN is available in the ePDG selection information, the UE shall construct an ePDG FQDN based on configured FQDN format of HPLMN as described in 3GPP TS 23.402 [6] and encoding in 3GPP TS 23.003 [3]; + - b) if the ePDG selection information is not provisioned in the ePDG configuration information or if the ePDG selection information is provisioned and an entry for the HPLMN is not available in the ePDG selection information, the UE shall: + - i) if Home ePDG identifier is provisioned in the ePDG configuration information, use the configured IP address to select the ePDG, or if configured IP address is not available, construct an ePDG FQDN using the configured FQDN; and + - ii) if the Home ePDG identifier is not provisioned in the ePDG configuration information, construct an ePDG FQDN based on the Operator Identifier FQDN format using the PLMN ID of the HPLMN as described in 3GPP TS 23.003 [3]; + - c) if the ePDG configuration information is not configured on the UE, or the ePDG configuration information is configured but empty, the UE shall construct the ePDG FQDN based on the Operator Identifier FQDN format using the PLMN ID of the HPLMN stored on the USIM; and + - d) If the ePDG selection is for establishing emergency bearer services and the UE is not equipped with a UICC, the UE may construct the Operator Identifier FQDN format based on a PLMN ID obtained via implementation specific means, + +and for the cases a) through d), the UE shall use the DNS server function to resolve the constructed ePDG FQDN to the IP address(es) of the ePDG(s). The UE shall select an IP address of an ePDG with the same IP version as its local IP address; + +- 2) if the UE is not located in its home country and + - a) if the ePDG selection information is provisioned in the ePDG configuration information and if the UE is attached to a VPLMN via 3GPP access: + - i) if an entry for the VPLMN is available in the ePDG selection information, the UE shall construct an ePDG FQDN based on configured FQDN format of the VPLMN as described in 3GPP TS 23.402 [6] and encoding in 3GPP TS 23.003 [3]; + - ii) if an entry for the VPLMN is not available in the ePDG selection information, and an 'Any\_PLMN' entry is available in the ePDG selection information, the UE shall construct an ePDG FQDN based on the configured FQDN format of the 'Any\_PLMN' entry as described in 3GPP TS 23.402 [6] and encoding in 3GPP TS 23.003 [3], + +and for case i) and ii), the UE shall use the DNS server function to resolve the contracted ePDG FQDN to the IP address(es) of the ePDG(s). The UE shall select an IP address of an ePDG with the same IP version as its local IP address; and + +b) if one of the following is true: + +- the UE is not attached to a PLMN via 3GPP access and the UE uses WLAN; +- the ePDG configuration information is not configured; +- the ePDG selection information is not provisioned in the ePDG configuration information; or +- the UE is attached to a VPLMN via 3GPP access and an entry for the VPLMN is not available in the ePDG selection information and an 'Any\_PLMN' entry is not available in the ePDG selection information, + +the UE shall perform a DNS query (see 3GPP TS 23.003 [3]) as specified in subclause 7.2.1.4 to determine if the visited country mandates the selection of ePDG in this country: + +i) if selection of ePDG in visited country is mandatory: + +- if the UE is attached to a VPLMN via 3GPP access and the PLMN ID of VPLMN is included in one of the returned DNS records, the UE shall select an ePDG in this VPLMN by constructing an ePDG FQDN based on the Operator Identifier FQDN format using the PLMN ID of the VPLMN as described in 3GPP TS 23.003 [3]; and + - if the UE is not attached to a PLMN via 3GPP access or the UE is attached to a VPLMN via 3GPP access and the PLMN ID of VPLMN is not included in any of the DNS records: +- m) - if the ePDG selection information is provisioned, the UE shall select an ePDG from a PLMN included in the DNS response that has highest PLMN priority (see 3GPP TS 24.312 [13]) in the ePDG selection information and construct an ePDG FQDN based on the configured FQDN format of the PLMN entry as described in 3GPP TS 23.402 [6] and encoding in 3GPP TS 23.003 [3]; and +- n) - if the ePDG selection information is not provisioned or the ePDG selection information does not contain any of the PLMNs in the DNS response, selection of the PLMN is UE implementation specific. The UE shall select an ePDG from a PLMN included in the DNS response and construct an ePDG FQDN based on the Operator Identifier FQDN format using the PLMN ID of the PLMN as described in 3GPP TS 23.003 [3], + +and for the above cases, the UE shall use the DNS server function to resolve the contracted ePDG FQDN to the IP address(es) of the ePDG(s). The UE shall select an IP address of an ePDG with the same IP version as its local IP address; + +ii) if the DNS response contains no records, selection of ePDG in visited country is not mandatory: + +- if the ePDG selection information is provisioned and contains one or more PLMNs in the visited country, the UE shall select an ePDG from a PLMN that has highest PLMN priority (see 3GPP TS 24.312 [13]) in the ePDG selection information; + - if the ePDG selection information is not provisioned or if the ePDG selection information is provisioned and contains no PLMNs in the visited country, the UE shall select an ePDG in the HPLMN as follows: +- o) - if the Home ePDG identifier is provisioned in the ePDG configuration information (see 3GPP TS 24.312 [13]), the UE shall use the configured IP address to select the ePDG, or if configured IP address is not available, use the configured FQDN and run DNS query to obtain the IP address(es) of the ePDG(s); and +- p) - if the Home ePDG identifier is not provisioned in the ePDG configuration information, the UE shall construct an ePDG FQDN based on the Operator Identifier FQDN format using the PLMN ID of the HPLMN as described in 3GPP TS 23.003 [3], and + +- if the ePDG selection is for establishing emergency bearer services and the UE is not equipped with a UICC, the UE may construct the Operator Identifier FQDN format based on a PLMN ID obtained via implementation specific means. + +and for the above cases, the UE shall use the DNS server function to resolve the constructed ePDG FQDN to the IP address(es) of the ePDG(s). The UE shall select an IP address of an ePDG with the same IP version as its local IP address; and + +- iii) if no DNS response is received, the UE shall terminate the ePDG selection procedure. + +If selecting an ePDG in the HPLMN fails, and the selection of ePDG in the HPLMN is performed using Home ePDG identifier configuration and there are more pre-configured ePDGs in the HPLMN, the UE shall repeat the tunnel establishment attempt using the next FQDN or IP address(es) of the ePDG in the HPLMN. + +Upon reception of a DNS response containing one or more IP addresses of ePDGs, the UE shall select an IP address of ePDG with the same IP version as its local IP address. If the UE does not receive a response to an IKE\_SA\_INIT request message sent towards to any of the received IP addresses of the selected ePDG, then the UE shall repeat the ePDG selection as described in this subclause, excluding the ePDG for which the UE did not receive a response to the IKE\_SA\_INIT request message. + +NOTE 1: The time the UE waits before reattempting access to another ePDG or to an ePDG that it previously did not receive a response to an IKE\_SA\_INIT request message, is implementation specific. + +The UE shall select only one ePDG also in case of multiple PDN connections. + +NOTE 2: During handover between two untrusted non-3GPP access networks, the UE can initiate tunnel establishment to another ePDG while still being attached to the current ePDG. + +#### 7.2.1.4 Determine if the visited country mandates the selection of ePDG in this country + +In order to determine if the visited country mandates the selection of ePDG in this country (see 3GPP TS 23.402 [6]), the UE shall perform the DNS NAPTR query using Visited Country FQDN as specified in 3GPP TS 23.003 [3]. + +If the result of this query is: + +- a set of one or more records containing the service instance names of the form "epdg.epc.mnc.mcc.pub.3gppnetwork.org", the UE shall determine that the visited country mandates the selection of the ePDG in this country; and + +NOTE: The (, ) pair in each record represents PLMN Id (see 3GPP TS 23.003 [3]) in the visited country which can be used for ePDG selection in subclause 7.2.1.3. + +- no records containing the service instance names of the form "epdg.epc.mnc.mcc.pub.3gppnetwork.org", the UE shall determine that the visited country does not mandate the selection of the ePDG in this country. + +#### 7.2.1A Selection of the ePDG for emergency bearer services + +The UE performs ePDG selection for emergency bearer services based on the ePDG configuration information provided by the home operator in the UE via H-ANDSF or via USIM, or via implementation specific means. + +The ePDG configuration information used for selecting the ePDG for emergency bearer services includes: + +- when available in ANDSF MO, Emergency\_ePDG\_Identifier and ePDG selection information are provisioned in ePDG node under Home Network Preference as specified in 3GPP TS 24.312 [13]; and +- when available in the USIM, the Emergency ePDG Identifier and ePDG selection information are provisioned in EFePDGIdEm and EFePDGSelection files as specified in 3GPP TS 31.102 [45]. + +NOTE: Implementation specific means apply only if the configurations via H-ANDSF and USIM are not present. + +When performing ePDG selection for establishing emergency bearer services, the UE shall proceed by following the general ePDG selection procedure specified in subclause 7.2.1 except: + +- Emergency\_ePDG\_Identifier shall be used instead of Home ePDG identifier; +- All ePDG FQDNs and visited country FQDNs for DNS query shall be constructed based on the ePDG FQDN format defined for emergency services as defined in 3GPP TS 23.003 [3]; and +- If the ME is not equipped with a UICC, the UE shall consider the ePDG configuration information as not available. + +## 7.2.2 Tunnel establishment + +### 7.2.2.1 Tunnel establishment accepted by the network + +Once the ePDG has been selected, the UE shall initiate the IPsec tunnel establishment procedure using the IKEv2 protocol as defined in IETF RFC 7296 [28] and 3GPP TS 33.402 [15]. + +The UE shall send an IKE\_SA\_INIT request message to the selected ePDG in order to setup an IKEv2 security association. Upon receipt of an IKE\_SA\_INIT response, the UE shall send an IKE\_AUTH request message to the ePDG, including: + +- The type of IP address (IPv4 address or IPv6 prefix or both) that needs to be configured in an IKEv2 CFG\_REQUEST Configuration Payload. If the UE requests for both IPv4 address and IPv6 prefix, the UE shall send two configuration attributes in the CFG\_REQUEST Configuration Payload: one for the IPv4 address and the other for the IPv6 prefix; +- The "IDr" payload, containing the APN in the Identification Data, for non-emergency session establishment. For emergency session establishment, the UE shall format the "IDr" payload according to subclause 7.2.5. The UE shall set the ID Type field of the "IDr" payload to ID\_FQDN as defined in IETF RFC 7296 [28]. The UE indicates a request for the default APN by omitting the "IDr" payload, which is in accordance with IKEv2 protocol as defined in IETF RFC 7296 [28]; and +- The "IDi" payload containing the NAI. + +The IKE\_AUTH request message may also contain: + +- An indication in a notify payload that MOBIKE is supported by the UE; +- The INTERNAL\_IP6\_DNS or the INTERNAL\_IP4\_DNS attribute in the CFG\_REQUEST Configuration Payload. The UE can obtain zero or more DNS server addressed in the CFG\_REPLY payload within the IKE\_AUTH response message as specified in IETF RFC 7296 [28]; or +- The P\_CSCF\_IP6\_ADDRESS attribute, the P\_CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REQUEST Configuration Payload. The UE can obtain zero or more P-CSCF server addresses in the CFG\_REPLY Configuration Payload within the IKE\_AUTH response message as specified in IETF RFC 7651 [64]. + +The UE may support the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2. If the UE supports the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute, the UE shall include the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute indicating support of receiving timeout period for liveness check in the CFG\_REQUEST configuration payload within the IKE\_AUTH request message. If the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2 indicating the timeout period for the liveness check is included in the CFG\_REPLY configuration payload within the IKE\_AUTH response message or if the UE has a pre-configured timeout period, the UE shall perform the tunnel liveness checks as described in subclause 7.2.2A. + +NOTE 1: The timeout period for liveness check is pre-configured in the UE in implementation-specific way. + +If the UE supports N1 mode, the UE shall include the N1\_MODE\_CAPABILITY Notify payload as defined in subclause 8.2.9.15 in the IKE\_AUTH request message and shall: + +- if the UE is establishing a PDN connection not related to any existing PDU session or any existing PDN connection, allocate a PDU session ID which is not currently being used by another PDU session over either 3GPP access or non-3GPP access, set the PDU Session ID field of the N1\_MODE\_CAPABILITY Notify payload to the allocated PDU session ID, and associate the allocated PDU session ID with the PDN connection that is being established; + +- if the UE is transferring an existing PDU session from 5GS, set the PDU Session ID field of the N1\_MODE\_CAPABILITY Notify payload to the PDU session ID of the existing PDU session that is being transferred and associate the PDU session ID with the PDN connection that is being established; or +- if the UE is transferring an existing PDN connection from EPS and a PDU session ID is associated with the PDN connection that is being transferred, set the PDU Session ID field of the N1\_MODE\_CAPABILITY Notify payload to the PDU session ID associated with the existing PDN connection. + +During the IKEv2 authentication and security association establishment, if the UE supports explicit indication about the supported mobility protocols, it shall provide the indication as described in subclause 6.3. + +During the IKEv2 authentication and tunnel establishment for initial attach, the UE shall provide an indication about Attach Type, which indicates Initial Attach. To indicate attach due to initial attach, the UE shall include either the INTERNAL\_IP4\_ADDRESS or the INTERNAL\_IP6\_ADDRESS attribute or both in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message. The INTERNAL\_IP4\_ADDRESS shall contain no value and the length field shall be set to 0. The INTERNAL\_IP6\_ADDRESS shall contain no value and the length field shall be set to 0. + +During the IKEv2 authentication and tunnel establishment for handover, the UE not supporting IP address preservation for NBM shall indicate Initial Attach as described in the previous paragraph. + +NOTE 2: The UE cannot handover PDN connection with PDN type "Ethernet" or "non-IP" from E-UTRAN to an ePDG because PDN connections with PDN type "Ethernet" or PDN type "non-IP" are not supported over ePDG. + +During the IKEv2 authentication and security association establishment for handover, the UE supporting IP address preservation for NBM, shall provide an indication about Attach Type, which indicates Handover Attach. During the IKEv2 authentication and security association establishment for transfer of an existing PDU session from 5GS, the UE shall provide an indication about Attach Type, which indicates Handover Attach. To indicate attach due to handover, the UE shall include the previously allocated home address information during the IPSec tunnel establishment. Depending on the IP version, the UE shall include either the INTERNAL\_IP4\_ADDRESS or the INTERNAL\_IP6\_ADDRESS attribute or both in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message to indicate the home address information which is in accordance with IKEv2 protocol as defined in IETF RFC 7296 [28]. If the previously allocated home address information consists of both an IPv4 address and an IPv6 prefix, then the UE shall include the INTERNAL\_IP4\_ADDRESS attribute and the INTERNAL\_IP6\_ADDRESS attribute in the CFG\_REQUEST configuration payload within the IKE\_AUTH request message. If the previously allocated home address information consists of an IPv4 address only, then the UE shall include the INTERNAL\_IP4\_ADDRESS attribute and shall not include the INTERNAL\_IP6\_ADDRESS attribute in the CFG\_REQUEST configuration payload within the IKE\_AUTH request message. If the previously allocated home address information consists of an IPv6 prefix only, then the UE shall include the INTERNAL\_IP6\_ADDRESS attribute and shall not include the INTERNAL\_IP4\_ADDRESS attribute in the CFG\_REQUEST configuration payload within the IKE\_AUTH request message. The UE shall support IPSec ESP (see IETF RFC 4303 [32]) in order to provide secure tunnels between the UE and the ePDG as specified in 3GPP TS 33.402 [15]. + +The UE may support multiple authentication exchanges in the IKEv2 protocol as specified in IETF RFC 4739 [49] in order to support authentication and authorization with an external AAA server allowing the UE to support PAP authentication procedure, or CHAP authentication procedure, or both, as described in 3GPP TS 33.402 [15]. + +If NBM is used and the UE wishes to access an external PDN and therefore needs to perform authentication and authorization with an external AAA server, the UE shall: + +- If the IKE\_SA\_INIT response contains a "MULTIPLE\_AUTH\_SUPPORTED" Notify payload, then include a "MULTIPLE\_AUTH\_SUPPORTED" Notify payload in the IKE\_AUTH request as described in IETF RFC 4739 [49] and perform the additional authentication steps as specified in 3GPP TS 33.402 [15]; and +- If the IKE\_SA\_INIT response does not contain a "MULTIPLE\_AUTH\_SUPPORTED" Notify payload, then perform the UE initiated disconnection as defined in subclause 7.2.4.1. The subsequent UE action is implementation dependent (e.g. select a new ePDG). + +After the successful authentication with the 3GPP AAA server, the UE receives from the ePDG an IKE\_AUTH response message containing a single CFG\_REPLY Configuration Payload including the assigned remote IP address information (IPv4 address or IPv6 prefix) as described in subclause 7.4.1. Depending on the used IP mobility management mechanism the following cases can be differentiated: + +- If DSMIPv6 is used for IP mobility management, the UE configures a remote IP address based on the IP address information contained in the INTERNAL\_IP4\_ADDRESS or INTERNAL\_IP6\_SUBNET attribute of the CFG\_REPLY Configuration Payload. The UE uses the remote IP address as Care-of-Address to contact the HA. +- If NBM is used for IP mobility management and the UE performs an initial attach, the UE configures a home address based on the address information from the CFG\_REPLY Configuration Payload. Otherwise, if NBM is used and the UE performs a handover attach, the UE continues to use its IP address configured before the handover, if the address information provided in the CFG\_REPLY Configuration Payload does match with the UE's IP address configured before the handover. If the UE's IP address (IPv4 address or IPv6 prefix) does not match with the address information of the CFG\_REPLY Configuration Payload, the UE shall configure a new home address based on the IP address information contained in the INTERNAL\_IP4\_ADDRESS, INTERNAL\_IP6\_SUBNET or INTERNAL\_IP6\_ADDRESS attribute of the CFG\_REPLY Configuration Payload. In the latter case, the IP address preservation is not possible. + +NOTE 3: In case of IPv6 address, the UE performs the match only on the IPv6 prefix provided within the CFG\_REPLY Configuration Payload contained in the INTERNAL\_IP6\_SUBNET or INTERNAL\_IP6\_ADDRESS. + +If the UE receives a PDN\_TYPE\_IPv4\_ONLY\_ALLOWED Notify payload or a PDN\_TYPE\_IPv6\_ONLY\_ALLOWED Notify payload, then the UE shall not subsequently initiate another UE requested PDN connectivity procedure specific to the non-3GPP access to the same APN to obtain a PDN type different from the one allowed by the network until: + +- the UE is switched off; +- the UICC containing the USIM is removed; or +- the network initiated the deactivation of the PDN connectivity to the given APN. + +If the UE supports DSMIPv6, the UE may request the HA IP address(es), by including a corresponding CFG\_REQUEST Configuration Payload containing a HOME\_AGENT\_ADDRESS attribute within the IKE\_AUTH request message. The HOME\_AGENT\_ADDRESS attribute content is defined in subclause 8.2.4.1. The HA IP address(es) requested in this attribute are for the APN for which the IPsec tunnel with the ePDG is set-up. In the CFG\_REQUEST within the IKE\_AUTH request message, the UE sets respectively the IPv6 address field and the optional IPv4 address field of the HOME\_AGENT\_ADDRESS attribute to 0::0 and to 0.0.0.0. If the UE can not obtain the IP addresses of the HA via IKEv2 signalling, it uses the home agent address discovery as specified in 3GPP TS 24.303 [11]. + +In case the UE wants to establish multiple PDN connections and if the UE uses DSMIPv6 for mobility management, the UE shall use DNS as defined in 3GPP TS 24.303 [11] to discover the HA IP address(es) for the additional PDN connections after IKEv2 security association was established to the ePDG. + +During the IKEv2 authentication and security association establishment, following the UE's initial IKE\_AUTH request message to the ePDG, if the UE subsequently receives an IKE\_AUTH response message from the ePDG containing the EAP-Request/AKA-Challenge, after verifying the received authentication parameters and successfully authenticating the ePDG as specified in 3GPP TS 33.402 [15], the UE shall send a new IKE\_AUTH request message to the ePDG including the EAP-Response/AKA-Challenge. In addition, the UE shall provide the requested mobile device identity if available, as specified in subclause 7.2.6. + +If the UE supports P-CSCF restoration extension for untrusted WLAN as specified in 3GPP TS 23.380 [66], the UE shall send its capability indication of the support of P-CSCF restoration to the ePDG by including the P-CSCF\_RESELECTION\_SUPPORT Notify payload within an IKE\_AUTH request message. The content of the P-CSCF\_RESELECTION\_SUPPORT Notify payload is described in subclause 8.2.9.4. + +If the UE supports N1 mode and the UE receives the N1\_MODE\_INFORMATION Notify payload as defined in subclause 8.2.9.16 in the IKE\_AUTH response message, the UE shall associate the S-NSSAI in the S-NSSAI Value field of the N1\_MODE\_INFORMATION Notify payload with the PDU session associated with the IKEv2 security association that was established, and if the UE receives the N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload as defined in subclause 8.2.9.17 in the IKE\_AUTH response message, the UE shall associate the PLMN ID that the S-NSSAI relates to in the S-NSSAI PLMN ID field of the N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload with the PDU session associated with the IKEv2 security association that was established. + +### 7.2.2.2 Tunnel establishment not accepted by the network + +If the UE receives the IKE\_AUTH response message from an ePDG of the HPLMN including a Notify payload with a Private Notify Message Type NON\_3GPP\_ACCESS\_TO\_EPC\_NOT\_ALLOWED or USER\_UNKNOWN or PLMN\_NOT\_ALLOWED or AUTHORIZATION\_REJECTED or RAT\_TYPE\_NOT\_ALLOWED or ILLEGAL\_ME as defined in subclause 8.1.2, then after the UE authenticates the network by using ePDG certificate and AUTH parameters as specified in 3GPP TS 33.402 [15], the UE shall close the related IKEv2 security association states and shall not retry the authentication procedure to an ePDG from the same PLMN until switching off or the UICC containing the USIM is removed. + +If the above Private Notify Message Type is received from the VPLMN's ePDG and the UE authenticates the network by using ePDG certificate and AUTH parameters as specified in 3GPP TS 33.402 [15]: + +- If the received Notify Message Type is NON\_3GPP\_ACCESS\_TO\_EPC\_NOT\_ALLOWED or USER\_UNKNOWN or AUTHORIZATION\_REJECTED or RAT\_TYPE\_NOT\_ALLOWED or ILLEGAL\_ME, the UE may retry the authentication procedure with an ePDG deployed by the HPLMN if allowed according to the ePDG selection procedure in subclause 7.2.1 and subclause 7.2.1A; or +- If the received Private Notify Message Type is PLMN\_NOT\_ALLOWED, the UE should retry the authentication procedure with an ePDG deployed by the HPLMN if allowed according to the ePDG selection procedure in subclause 7.2.1 and subclause 7.2.1A. + +If the UE receives from the ePDG the IKE\_AUTH response message, including a Notify payload with a Private Notify Message Type "NETWORK\_FAILURE" as defined in subclause 8.1.2 then after the UE authenticates the network, the UE shall close the related IKEv2 security association states and: + +- a) if the received IKE\_AUTH response message from ePDG contains a Notify payload with the BACKOFF\_TIMER Notify payload as defined in subclause 8.2.9.1, the UE shall behave as follows: + - i) if the timer value indicates neither zero nor deactivated, start the Tw3 timer with the value provided and not retry the authentication procedure to the same ePDG until timer Tw3 expires or the UE is switched off or the UICC containing the USIM is removed; + - ii) if the timer value indicates that this timer is deactivated, not retry the authentication procedure to the same ePDG until the UE is switched off or the UICC containing the USIM is removed; and + - iii) if the timer value indicates zero, may retry the authentication procedure to an ePDG from the same PLMN; or +- b) if the BACKOFF\_TIMER Notify payload is not included in the received IKE\_AUTH response message from ePDG, the UE shall start an implementation specific backoff timer. The UE shall not re-try the authentication procedure with the same ePDG until the backoff timer expires or the UE is switched off or the UICC containing the USIM is removed. + +If the UE receives from the ePDG an IKE\_AUTH response message including a Notify Payload with a Private Notify Message Error Type "NO\_APN\_SUBSCRIPTION" as defined in subclause 8.1.2 then after the UE authenticates the network, the UE shall close the related IKEv2 security association states and: + +- a) if the received IKE\_AUTH response message from ePDG contains a Notify payload with the BACKOFF\_TIMER Notify payload as defined in subclause 8.2.9.1, the UE shall behave as follows: + - i) if the timer value indicates neither zero nor deactivated, start the Tw3 timer with the value provided and not retry the authentication procedure to the same PLMN for the same APN until timer Tw3 expires or the UE is switched off or the UICC containing the USIM is removed; + - ii) if the timer value indicates that this timer is deactivated, not retry the authentication procedure to the same PLMN for the same APN until the UE is switched off or the UICC containing the USIM is removed; and + - iii) if the timer value indicates zero, may retry the authentication procedure to an ePDG from the same PLMN for the same APN; or +- b) if the BACKOFF\_TIMER Notify payload is not included in the received IKE\_AUTH response message from ePDG, the UE shall not retry the authentication procedure with the same PLMN for the same APN the UE is switched off or the UICC containing the USIM is removed, unless the UE has an implementation specific backoff timer. In that case, the UE shall not retry until that implementation specific timer expires. + +NOTE 1: The UE can perform NSWO from the current untrusted WLAN access network even though the tunnel establishment procedure to the ePDG is not accepted by the network. + +NOTE 2: Switching off and USIM change conditions are implemented taking into consideration the user experience aspect. + +If NBM is used and if the UE receives from the ePDG an IKE\_AUTH response message containing a Notify payload with a Private Notify Message Type PDN\_CONNECTION\_REJECTION as specified in subclause 8.1.2 that includes an IP address information in the Notification Data field, the UE shall not attempt to re-establish this PDN connection with the same IP address while connected to the current ePDG and the UE shall close the related IKEv2 security association states. + +If NBM is used and if the UE receives from the ePDG an IKE\_AUTH response message containing a Notify payload with a Private Notify Message Type PDN\_CONNECTION\_REJECTION as specified in subclause 8.1.2 and no Notification Data field, then after the UE authenticates the network, the UE shall not attempt to establish additional PDN connections to this APN while connected to the current ePDG. The UE shall close the related IKEv2 security association states. Subsequently, the UE can attempt to establish additional PDN connections to the given APN if one or more existing PDN connections to the given APN are released. While connected to the current ePDG, if this PDN connection is the first PDN connection for the given APN, the UE shall not attempt to establish PDN connection to the given APN. + +If NBM is used and if the UE receives from the ePDG an IKE\_AUTH response message containing a Notify payload with a Private Notify Message Type MAX\_CONNECTION\_REACHED as specified in subclause 8.1.2, then after the UE authenticates the network, the UE shall not attempt to establish any additional PDN connections while connected to the current ePDG. The UE shall close the related IKEv2 security association states. Subsequently, the UE can attempt to establish additional PDN connections via the ePDG if one or more existing PDN connections via the ePDG are released. + +## 7.2.2A Liveness check procedure + +If the UE supports the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2 and the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2 was included in the CFG\_REPLY configuration payload within the IKE\_AUTH response message received in subclause 7.2.2 the UE shall set the timeout period for the liveness check to the value of the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute. + +If the UE does not support the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2 or the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2 was not included in the CFG\_REPLY configuration payload within the IKE\_AUTH response message received in subclause 7.2.2 then: + +- 1) if the LivenessCheckPeriod node as specified in 3GPP TS 24.312 [13] is configured, the UE shall use the timeout period for the liveness check indicated by the LivenessCheckPeriod node; and +- 2) if the LivenessCheckPeriod node as specified in 3GPP TS 24.312 [13] is not configured, the UE shall use the pre-configured value of the timeout period for liveness check. + +NOTE: The timeout period is pre-configured in the UE in implementation-specific way. + +If the UE has not received any cryptographically protected IKEv2 or IPSec message for the duration of the timeout period for liveness check, the UE shall send an INFORMATIONAL request with no payloads as per IETF RFC 7296 [28]. If an INFORMATIONAL response is not received, the UE shall deem the IKEv2 security association to have failed, and shall discard all states associated with the IKE SA and any child SAs that were negotiated using that IKE SA as specified in IETF RFC 7296 [28]. + +## 7.2.2B Handling of NBIFOM + +If the IKEv2 authentication and security association establishment is triggered by procedures in 3GPP TS 24.161 [69], the UE shall include the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) in the IKE\_AUTH request message. The UE shall set the NBIFOM container contents field of the NBIFOM\_GENERIC\_CONTAINER Notify payload as specified in 3GPP TS 24.161 [69]. + +## 7.2.2C Rekeying procedure + +The UE may support rekeying as defined in IETF RFC 7296 [28]. + +To trigger rekeying, the UE shall use the rekeying time parameter (see IETF RFC 7296 [28]) if it is configured by the RekeyingTime node as specified in 3GPP TS 24.312 [13]. If the rekeying time parameter is not configured, the UE shall use an implementation-specific rekeying time (e.g. 18 hours). + +## 7.2.2D NAT keep alive procedure + +The UE may support NAT keep alive handling as defined in IETF RFC 7296 [28] and IETF RFC 3948 [72]. + +To control the NAT-keepalive packet sending, the UE shall use the parameter M (see IETF RFC 3948 [72]) if it is configured by the NATKeepAliveTime node as specified in 3GPP TS 24.312 [13]. If the parameter M is not configured, the UE shall use an implementation-specific time. + +## 7.2.3 Tunnel modification + +### 7.2.3.1 UE-initiated modification + +This procedure is used if MOBIKE as defined in IETF RFC 4555 [31] is supported by the UE. + +When there is a change of local IP address for the UE, the UE shall update the IKE security association with the new address, and shall update the IPsec security association associated with this IKE security association with the new address. The UE shall then send an INFORMATIONAL request containing the UPDATE\_SA\_ADDRESSES notification to the ePDG. + +If, further to this update, the UE receives an INFORMATIONAL request with a COOKIE2 notification present, the UE shall copy the notification to the COOKIE2 notification of an INFORMATIONAL response and send it to the ePDG. + +This procedure is also used during the UE-initiated IP flow mobility procedure (see subclause 6.3.3.3 of 3GPP TS 23.161 [68]) or the NBIFOM IP flow mapping procedure (see subclause 6.4.3 of 3GPP TS 23.161 [68]). + +If the UE-initiated modification is triggered by procedures in 3GPP TS 24.161 [69], the UE shall include the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) in the INFORMATIONAL request to the ePDG. The UE shall set the NBIFOM container contents field of the NBIFOM\_GENERIC\_CONTAINER Notify payload as specified in 3GPP TS 24.161 [69]. + +### 7.2.3.2 UE behaviour towards ePDG initiated modification + +This procedure is used if P-CSCF restoration extension for untrusted WLAN is supported as specified in 3GPP TS 23.380 [66]. + +If the UE receives the P\_CSCF\_IP6\_ADDRESS attribute, the P\_CSCF\_IP4\_ADDRESS attribute or both as specified in IETF RFC 7651 [64] in the CFG\_REQUEST configuration payload within the INFORMATIONAL request from the ePDG and the UE supports P-CSCF restoration extension for untrusted WLAN as specified in 3GPP TS 23.380 [66], the UE shall reply with an INFORMATIONAL response and proceed as specified in subclause 5.6.5.2 of 3GPP TS 23.380 [66]. The INFORMATIONAL response shall include the received P\_CSCF\_IP6\_ADDRESS attribute or the P\_CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REPLY Configuration Payload. The P\_CSCF\_IP6\_ADDRESS attribute shall contain no value and the length field shall be set to 0. The P\_CSCF\_IP4\_ADDRESS shall contain no value and the length field shall be set to 0. + +Upon of receipt of the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) in an INFORMATIONAL request, the UE shall reply with an INFORMATIONAL response and if required by procedures in 3GPP TS 24.161 [69], the UE shall include the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) in the INFORMATIONAL response. The UE shall set the NBIFOM container contents field of the NBIFOM\_GENERIC\_CONTAINER Notify payload as specified in 3GPP TS 24.161 [69]. + +## 7.2.4 Tunnel disconnection + +### 7.2.4.1 UE initiated disconnection + +The UE shall use the procedures defined in the IKEv2 protocol (see IETF RFC 7296 [28]) to disconnect one or more IPsec tunnels to the ePDG. The UE shall close the incoming security associations associated with the tunnel and instruct the ePDG to do the same by sending the INFORMATIONAL request message including a "DELETE" payload. The DELETE payload shall contain either: + +- i) Protocol ID set to "1" and no subsequent Security Parameters Indexes (SPIs) in the payload. This indicates closing of IKE security association, and implies the deletion of all IPsec ESP security associations that were negotiated within the IKE security association; +- ii) if the IKEv2 multiple bearer PDN connectivity is not supported or not used in the PDN connection as determined in subclause 7.2.7, Protocol ID set to "3" for ESP. The Security Parameters Indexes included in the payload shall correspond to the particular incoming ESP security associations at the UE for the given tunnel in question; or +- iii) if the IKEv2 multiple bearer PDN connectivity is used in the PDN connection as determined in subclause 7.2.7, the Protocol ID field of the DELETE payload is set to "3" for ESP and the SPI field of the DELETE payload includes UE's ESP SPIs of all bearer contexts of the PDN connection. + +### 7.2.4.2 UE behaviour towards ePDG initiated disconnection + +On receipt of the INFORMATIONAL request message including "DELETE" payload, indicating that the ePDG is attempting tunnel disconnection, the UE shall: + +- i) Close all security associations identified within the DELETE payload (these security associations correspond to outgoing security associations from the UE perspective). If no security associations were present in the DELETE payload, and the protocol ID was set to "1", the UE shall close the IKE security association, and all IPsec ESP security associations that were negotiated within it towards the ePDG; and +- ii) The UE shall delete the incoming security associations corresponding to the outgoing security associations identified in the "DELETE" payload. + +The UE shall send an INFORMATIONAL response message. If the INFORMATIONAL request message contained a list of security associations, the INFORMATIONAL response message shall contain a list of security associations deleted in step (ii) above. + +If the UE is unable to comply with the INFORMATIONAL request message, the UE shall send INFORMATION response message with either: + +- i) A NOTIFY payload of type "INVALID\_SPI", for the case that it could not identify one or more of the Security Parameters Indexes in the message from the ePDG; or +- ii) A more general NOTIFY payload type. This payload type is implementation dependent. + +If the INFORMATIONAL request message including the DELETE payload contains the REACTIVATION\_REQUESTED\_CAUSE Notify payload, the UE shall re-establish the IPsec Tunnel for the corresponding PDN connection after its release. The coding of the P-CSCF\_RESELECTION\_SUPPORT Notify payload is described in subclause 8.2.9.6. + +NOTE: For an IMS PDN connection, the re-establishment of the IPsec tunnel is part of the "Re-establishment of the IP-CAN used for SIP signalling procedure" specified in 3GPP TS 24 229 [67] subclause R.2.2.1B. + +### 7.2.4.3 Local tunnel disconnection initiated from 3GPP access + +A PDN connection over untrusted WLAN over S2b can be released locally in the UE, i.e. without any peer-to-peer signalling between the ePDG and the UE, based on the trigger received from the 3GPP access, e.g. during the P-CSCF restoration procedure for NBIFOM PDN connections (see 3GPP TS 23.380 [66]). + +Upon receiving over the 3GPP access: + +- a DEACTIVATE EPS BEARER CONTEXT REQUEST message with the EPS bearer context of a default EPS bearer context and ESM cause #39 "reactivation requested" (see 3GPP TS 24.301 [10]); or + +- a DETACH REQUEST message with the detach type "re-attach required" (see 3GPP TS 24.301 [10]) + +to release the resources for a PDN connection over the 3GPP access, the UE shall: + +- a) close the related IKEv2 security association for the IPsec tunnel associated with this PDN connection; and +- b) consider that the ePDG is no longer responding (see RFC 7296 [28]) and not send any messages to the ePDG. + +## 7.2.5 Emergency session establishment + +If the UE needs to establish an IMS emergency session over untrusted non-3GPP access as specified in 3GPP TS 24.229 [67], the UE shall: + +- if the UE is not connected to an ePDG yet, select an ePDG that supports emergency services as described in subclause 7.2.1A; +- if the UE is already connected to an ePDG that has indicated its capability of support emergency services as specified in subclause 7.4.1.1 and the ePDG is located in the same country where the UE is currently located, reuse ePDG for emergency session; and +- if the UE is already connected to an ePDG but the ePDG does not support the emergency services or ePDG is not located in the same country where the UE is currently located, first follow procedure described in subclause 7.2.4.1 to disconnect existing IPsec tunnel. The UE shall then select an ePDG that supports emergency services as described in subclause 7.2.1A. + +Once the UE selects an ePDG that supports emergency services as specified in subclause 7.2.1A, or if the UE is already connected to an ePDG and the ePDG is reused for emergency session, the UE shall initiate an IKEv2 tunnel establishment procedure towards this ePDG as described in subclause 7.2.2. Upon receipt of an IKE\_SA\_INIT response, the UE shall send an IKE\_AUTH request message to the ePDG according to subclause 7.2.2.1 with the "IDr" payload containing the string "EMERGENCY", using capital letters only, in the Identification Data. The UE shall set the ID Type field of the "IDr" payload to ID\_FQDN. + +NOTE: In this procedure, the only scenario in which the UE is not in the same country as the ePDG it is connected to, is when the UE is not in the country of its HPLMN and the ePDG is in the country of the HPLMN. + +In order to establish a new emergency session over an untrusted WLAN, the UE shall include: + +- an INTERNAL\_IP4\_ADDRESS attribute with the length field set to zero; +an INTERNAL\_IP6\_ADDRESS attribute with the length field set to zero; or +- both of the above; + +in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message. + +In order to perform handover of an emergency session from a 3GPP access network to untrusted WLAN, the UE shall include: + +- the INTERNAL\_IP4\_ADDRESS attribute set to the IPv4 address of the previously allocated home address information; +the INTERNAL\_IP6\_ADDRESS attribute set to the IPv6 address of the previously allocated home address information; or +- both of the above; + +in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message. If the previously allocated home address information consists of both an IPv4 address and an IPv6 prefix, then the UE shall include the INTERNAL\_IP4\_ADDRESS attribute and the INTERNAL\_IP6\_ADDRESS attribute in the CFG\_REQUEST configuration payload within the IKE\_AUTH request message. + +If the UE does not receive a response to an IKE\_SA\_INIT request message sent towards the selected ePDG, then the UE shall repeat the ePDG search as described in 3GPP TS 23.402 [6], excluding the ePDG for which the UE did not + +receive a response to the IKE\_SA\_INIT request message. The UE shall stop the establishment of emergency session if it is unable to select an ePDG for emergency bearer services. + +If after sending an IKE\_AUTH request message to the ePDG to initiate emergency session, the UE receives IKE\_AUTH response message from the ePDG containing a Notify payload with a Private Notify Message Type "UNAUTHENTICATED\_EMERGENCY\_NOT\_SUPPORTED", the UE shall follow the steps above to select a new ePDG for emergency session establishment by excluding the ePDGs from which the emergency session request was previously not accepted or by implementation specific means. + +If the UE receives the Notify Message Type IMEI\_NOT\_ACCEPTED as defined in subclause 8.1.2.2, the UE shall not retry the authentication procedure from the same PLMN until switching off, the UICC containing the USIM is replaced, or a UICC containing the USIM is inserted. + +If the UE is already connected to an ePDG selected by the procedure in subclause 7.2.1A, the UE is considered as attached for emergency bearer services. In such a case, the UE shall not initiate any additional IKEv2 tunnel establishment procedure. + +If the UE is connected to an ePDG selected by the procedure in subclause 7.2.1, and the ePDG has indicated its capability of support emergency service to the UE as specified in subclause 7.4.1.1 and is located in the same country where the UE is currently located, the UE, when it requires emergency services, shall initiate an IKEv2 tunnel establishment procedure towards the same ePDG to request for emergency session as specified in subclause 7.2.2 provided that an emergency PDN connection is not already active. + +## 7.2.6 Mobile identity signaling + +During the IKEv2 authentication and security association establishment, if the UE: + +- receives IKE\_AUTH response message from ePDG containing a Notify payload with the DEVICE\_IDENTITY Notify Message Type and the Identity Type field of the DEVICE\_IDENTITY Notify payload is set to either 'IMEI' or 'IMEISV' and the Identity Value field is empty; +- successfully authenticates the network or requests emergency session; and +- has Mobile Equipment Identity IMEI or IMEISV available, + +the UE shall include the DEVICE\_IDENTITY Notify payload in the new IKE\_AUTH request message. + +At any time after successful tunnel establishment, if the UE: + +- receives INFORMATIONAL request message from ePDG containing a Notify payload with the DEVICE\_IDENTITY Notify Message Type and the Identity Type field of the DEVICE\_IDENTITY Notify payload is set to either 'IMEI' or 'IMEISV' and the Identity Value field is empty; and +- has the UE's Mobile Equipment Identity IMEI or IMEISV available, + +the UE shall send INFORMATIONAL response containing a DEVICE\_IDENTITY Notify payload. + +The UE shall set the DEVICE\_IDENTITY as follows: + +- if IMEISV is available, the UE shall include IMEISV in the DEVICE\_IDENTITY Notify payload. The Identity Type field of the DEVICE\_IDENTITY Notify payload shall be set to 'IMEISV'; and +- if IMEI is available and IMEISV is not available, the UE shall include IMEI in the DEVICE\_IDENTITY attribute. The Identity Type field of the DEVICE\_IDENTITY Notify payload shall be set to 'IMEI'. + +The detailed coding of the DEVICE\_IDENTITY Notify payload is described in subclause 8.2.9.2. + +## 7.2.7 IKEv2 multiple bearer PDN connectivity + +### 7.2.7.1 General + +The UE may support the IKEv2 multiple bearer PDN connectivity. + +If the UE supports the IKEv2 multiple bearer PDN connectivity, then the UE shall perform handling specified in the present subclause. Otherwise the UE does not perform handling specified in the present subclause and remaining subclauses of the parent subclause of the present subclause. + +The UE shall include an IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify payload as specified in subclause 8.2.9.9 within an IKE\_AUTH request message establishing an IKE SA of a PDN connection. If the IKE\_AUTH response message contains an EPS\_QOS Notify payload as specified in subclause 8.2.9.10, the UE shall consider that the IKEv2 multiple bearer PDN connectivity is used in the PDN connection. + +If the IKEv2 multiple bearer PDN connectivity is used in the PDN connection, then the UE shall perform the handling specified in remaining subclauses of the parent subclause of the present subclause. Otherwise the UE does not perform the handling specified in remaining subclauses of the parent subclause of the present subclause. + +## 7.2.7.2 Maintained information + +The UE shall maintain one or more bearer contexts for the PDN connection. Each bearer context consists of a UE's ESP SPI, an ePDG's ESP SPI, an EPS QoS, an extended EPS QoS, a TFT, an APN-AMBR, an extended APN-AMBR, and an indication whether the bearer context is the default bearer context. The TFT can be absent only in the default bearer context. The extended EPS QoS can be absent for any bearer context. The APN-AMBR and the extended APN-AMBR are absent for bearer contexts which are not the default bearer context. The APN-AMBR can be present or absent for the default bearer context. The extended APN-AMBR can be present for the default bearer context only if the APN-AMBR is present for the default bearer context. + +## 7.2.7.3 Control plane procedures + +### 7.2.7.3.1 General + +Parent subclause of the present subclause describe control plane procedures for the IKEv2 multiple bearer PDN connectivity. + +### 7.2.7.3.2 Establishment of IKEv2 SA and initial IPSec ESP tunnel + +NOTE: Inclusion of a IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify payload in an IKE\_AUTH request message is specified in subclause 7.2.7.1. + +Upon receiving the IKE\_AUTH response message establishing the IKE SA of the PDN connection, the UE shall add a new bearer context to the PDN connection. The new bearer context shall consist of the UE's ESP SPI created by the IKE\_AUTH request/response pair, the ePDG's ESP SPI created by the IKE\_AUTH request/response pair, the EPS QoS indicated in the EPS\_QOS Notify payload, the extended EPS QoS indicated in the EXTENDED\_EPS\_QOS Notify payload (if included in the IKE\_AUTH response message), the APN-AMBR indicated in the APN\_AMBR Notify payload (if included in the IKE\_AUTH response message), and the extended APN-AMBR indicated in the EXTENDED\_APN\_AMBR Notify payload (if included in the IKE\_AUTH response message) of the IKE\_AUTH response message, and the indication that the bearer context is the default bearer context. + +### 7.2.7.3.3 Establishment of an additional IPSec ESP tunnel + +Upon receiving a CREATE\_CHILD\_SA request message in the IKE SA of the PDN connection, with an EPS\_QOS Notify payload as specified in subclause 8.2.9.10, with a TFT Notify payload as specified in subclause 8.2.9.11, and without a REKEY\_SA Notify payload, if the UE sends a CREATE\_CHILD\_SA response message without an IKEv2 notify payload indicating an error, the UE shall add a new bearer context to the PDN connection. The new bearer context shall consist of the UE's ESP SPI created by the CREATE\_CHILD\_SA request/response pair, the ePDG's ESP SPI created by the CREATE\_CHILD\_SA request/response pair, the EPS QoS indicated in the EPS\_QOS Notify payload of the CREATE\_CHILD\_SA request message, the extended EPS QoS indicated in the EXTENDED\_EPS\_QOS Notify payload (if included in the CREATE\_CHILD\_SA request message), the TFT indicated in the TFT Notify payload of the CREATE\_CHILD\_SA request message, and the indication that the bearer context is not the default bearer context. + +Upon receiving a CREATE\_CHILD\_SA request message in the IKE SA of the PDN connection, with an EPS\_QOS Notify payload as specified in subclause 8.2.9.10, with a TFT Notify payload as specified in subclause 8.2.9.11, and without a REKEY\_SA Notify payload: + +- the UE checks for semantic errors in TFT operations as follows: + +- 1) if the *TFT operation* in the TFT Notify payload is an operation other than "Create a new TFT", the UE shall send a CREATE\_CHILD\_SA response message with the SEMANTIC\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; +- b) the UE checks for syntactical errors in TFT operations as follows: + - 1) if the *TFT operation* in the TFT Notify payload is "Create a new TFT" and the packet filter list in the TFT Notify payload is empty, the UE shall send a CREATE\_CHILD\_SA response message with the SYNTACTICAL\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; and + - 2) if there are other types of syntactical errors in the coding of the TFT Notify payload, such as a mismatch between the number of packet filters subfield, and the number of packet filters in the packet filter list, the UE shall send a CREATE\_CHILD\_SA response message with the SYNTACTICAL\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; +- c) the UE checks for semantic errors in packet filters as follows: + - 1) if a packet filter consists of conflicting packet filter components which would render the packet filter ineffective, i.e. no IP packet will ever fit this packet filter, the UE shall send a CREATE\_CHILD\_SA response message with the SEMANTIC\_ERRORS\_IN\_PACKET\_FILTERS Notify payload. How the UE determines a semantic error in a packet filter is outside the scope of the present document; and + - 2) if the resulting TFT does not contain any packet filter which applicable for the uplink direction, the UE shall send a CREATE\_CHILD\_SA response message with the SEMANTIC\_ERRORS\_IN\_PACKET\_FILTERS Notify payload; +- d) the UE checks syntactical errors in packet filters as follows: + - 1) if the *TFT operation* in the TFT Notify payload is "Create a new TFT" and two or more packet filters in the resultant TFT would have identical packet filter identifiers, the UE shall send a CREATE\_CHILD\_SA response message with the SYNTACTICAL\_ERRORS\_IN\_PACKET\_FILTERS Notify payload; + - 2) if the *TFT operation* in the TFT Notify payload is "Create a new TFT" and two or more packet filters in all TFTs associated with this PDN connection would have identical packet filter precedence values: + - i) if the old packet filters do not belong to the default bearer context, the UE shall send a CREATE\_CHILD\_SA response message with the SYNTACTICAL\_ERRORS\_IN\_PACKET\_FILTERS Notify payload; and + +NOTE: the UE is not expected to be able to release a particular bearer context. + +- ii) if one or more old packet filters belong to the default bearer context, the UE shall release the PDN connection as specified in subclause 7.2.4.1; and + +- 3) if there are other types of syntactical errors in the coding of packet filters, such as the use of a reserved value for a packet filter component identifier, the UE shall send a CREATE\_CHILD\_SA response message with the SYNTACTICAL\_ERRORS\_IN\_PACKET\_FILTERS Notify payload. + +#### 7.2.7.3.4 Release of an additional IPSec ESP tunnel + +Upon receiving an INFORMATIONAL request message in the IKE SA of the PDN connection, with a DELETE payload indicating an ePDG's ESP SPI of a bearer context of the PDN connection, the UE shall send an INFORMATIONAL response message without an IKEv2 notify payload indicating an error and the UE shall remove the bearer context from the PDN connection. + +#### 7.2.7.3.5 Modification of an IPSec ESP tunnel due to change of EPS QoS and TFT + +Upon receiving an INFORMATIONAL request message the IKE SA of the PDN connection, with a MODIFIED\_BEARER Notify payload as specified in subclause 8.2.9.12 indicating an ePDG's ESP SPI of a bearer context of the PDN connection, if the UE sends an INFORMATIONAL response message without an IKEv2 notify payload indicating an error: + +- a) if the EPS\_QOS Notify payload as specified in subclause 8.2.9.10 is included in the INFORMATIONAL request message: + +- 1) the UE shall update the bearer context with the EPS QoS indicated in the EPS\_QOS Notify payload; and + - 2) if the EXTENDED\_EPS\_QOS Notify payload as specified in subclause 8.2.9.10A is included in the INFORMATIONAL request message, the UE shall update the bearer context with the extended EPS QoS indicated in the EXTENDED\_EPS\_QOS Notify payload; +- b) if the TFT Notify payload as specified in subclause 8.2.9.11 is included in the INFORMATIONAL request message, the UE shall update the bearer context with the TFT indicated in the TFT Notify payload; and + - c) if the bearer context is the default bearer context and the APN\_AMBR Notify payload as specified in subclause 8.2.9.13 is included in the INFORMATIONAL request message: + - 1) the UE shall update the bearer context with the APN\_AMBR indicated in the APN\_AMBR Notify payload; and + - 2) if the EXTENDED\_APN\_AMBR Notify payload as specified in subclause 8.2.9.14 is included in the INFORMATIONAL request message, the UE shall update the bearer context with the extended APN\_AMBR indicated in the EXTENDED\_APN\_AMBR Notify payload. + +Upon receiving an INFORMATIONAL request message the IKE SA of the PDN connection, with a MODIFIED\_BEARER Notify payload as specified in subclause 8.2.9.12 indicating an ePDG's ESP SPI of a bearer context of the PDN connection, and with a TFT Notify payload as specified in subclause 8.2.9.11: + +- a) the UE checks for semantic errors in TFT operations as follows: + - 1) if the *TFT operation* in the TFT Notify payload is "Create a new TFT" and there is already an existing TFT for the bearer context, the UE shall further process the new activation request and, if it was processed successfully, delete the old TFT; + - 2) if the *TFT operation* in the TFT Notify payload is an operation other than "Create a new TFT" and there is no TFT for the bearer context, the UE shall not diagnose an error and perform the following actions to resolve the inconsistency: + - i) if the TFT operation is "Delete existing TFT" or "Delete packet filters from existing TFT", and if no error according to items b, c, and d was detected, consider the TFT as successfully deleted; and + - ii) if the TFT operation is "Add packet filters in existing TFT" or "Replace packet filters in existing TFT", the UE shall process the new request as an activation request; + - 3) if the *TFT operation* in the TFT Notify payload is "Delete packet filters from existing TFT" and it would render the TFT empty: + - i) if the packet filters belong to a bearer context which is not the default bearer context, the UE shall process the new deletion request and, if no error according to items b, c, and d was detected, the UE shall send an INFORMATIONAL response message with the SEMANTIC\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; and + - ii) if the packet filters belong to a bearer context which is the default bearer context, the UE shall process the new deletion request and if no error according to items b, c, and d was detected then delete the existing TFT; and + - 4) if the *TFT operation* in the TFT Notify payload is "Delete existing TFT" and the bearer context is not the default bearer context, the UE shall send an INFORMATIONAL response message with the SEMANTIC\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; +- b) the UE checks for syntactical errors in TFT operations as follows: + - 1) if the *TFT operation* in the TFT Notify payload is "Create a new TFT", "Add packet filters in existing TFT", "Replace packet filters in existing TFT" or "Delete packet filters from existing TFT" and the packet filter list in the TFT Notify payload is empty, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; + - 2) if *TFT operation* in the TFT Notify payload is "Delete existing TFT" or "No TFT operation" with a non-empty packet filter list in the TFT Notify payload, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; + +- 3) if *TFT operation* in the TFT Notify payload is "Replace packet filters in existing TFT" when the packet filter to be replaced does not exist in the original TFT, the UE shall not diagnose an error, further process the replace request and, if no error according to items c and d was detected, include the packet filters received to the existing TFT; + - 4) if *TFT operation* in the TFT Notify payload is "Delete packet filters from existing TFT" when the packet filter to be deleted does not exist in the original TFT, the UE shall not diagnose an error, further process the deletion request and, if no error according to items c and d was detected, consider the respective packet filter as successfully deleted; + - 5) if *TFT operation* in the TFT Notify payload is "Delete packet filters from existing TFT" with a packet filter list also including packet filters in addition to the packet filter identifiers, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; and + - 6) if there are other types of syntactical errors in the coding of the TFT Notify payload, such as a mismatch between the number of packet filters subfield, and the number of packet filters in the packet filter list, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERROR\_IN\_THE\_TFT\_OPERATION Notify payload; +- c) the UE checks for semantic errors in packet filters as follows: +- 1) if a packet filter consists of conflicting packet filter components which would render the packet filter ineffective, i.e. no IP packet will ever fit this packet filter, the UE shall send an INFORMATIONAL response message with the SEMANTIC\_ERRORS\_IN\_PACKET\_FILTERS Notify payload. How the UE determines a semantic error in a packet filter is outside the scope of the present document; and + - 2) if the resulting TFT, which is assigned to a bearer context which is not the default bearer context, does not contain any packet filter applicable for the uplink direction among the packet filters created on request from the network, the UE shall send an INFORMATIONAL response message with the SEMANTIC\_ERRORS\_IN\_PACKET\_FILTERS Notify payload; and +- d) the UE checks for syntactical errors in packet filters as follows: +- 1) if the *TFT operation* in the TFT Notify payload is "Create a new TFT", "Add packet filters to existing TFT", and two or more packet filters in the resultant TFT would have identical packet filter identifiers: + - i) if two or more packet filters with identical packet filter identifiers are contained in the new request, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERRORS\_IN\_PACKET\_FILTERS Notify payload; and + - ii) if two or more packet filters with identical packet filter identifiers are not contained in the new request, the UE shall not diagnose an error, further process the new request and, if it was processed successfully, delete the old packet filters which have the identical packet filter identifiers; + - 2) if the *TFT operation* in the TFT Notify payload is "Create a new TFT", "Add packet filters to existing TFT" or "Replace packet filters in existing TFT", and two or more packet filters among all TFTs associated with this PDN connection would have identical packet filter precedence values: + - i) if the old packet filters do not belong to the default bearer context, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERRORS\_IN\_PACKET\_FILTERS Notify payload; and +- NOTE: the UE is not expected to be able to release a particular bearer context. +- ii) if one or more old packet filters belong to the default bearer context, the UE shall release the PDN connection as specified in subclause 7.2.4.1; and +- 3) if there are other types of syntactical errors in the coding of packet filters, such as the use of a reserved value for a packet filter component identifier, the UE shall send an INFORMATIONAL response message with the SYNTACTICAL\_ERRORS\_IN\_PACKET\_FILTERS Notify payload. + +#### 7.2.7.3.6 ePDG initiated IPsec ESP tunnel rekeying + +Upon receiving a CREATE\_CHILD\_SA request message in the IKE SA of the PDN connection, with a REKEY\_SA Notify payload indicating an ePDG's ESP SPI of a bearer context of the PDN connection, if the UE sends a CREATE\_CHILD\_SA response message without an IKEv2 notify payload indicating an error, the UE shall set the UE's ESP SPI of the bearer context to the UE's ESP SPI created by the CREATE\_CHILD\_SA request/response pair and shall set the ePDG's ESP SPI of the bearer context to the ePDG's ESP SPI created by the CREATE\_CHILD\_SA request/response pair. + +#### 7.2.7.3.7 UE initiated IPsec ESP tunnel rekeying + +Upon receiving a CREATE\_CHILD\_SA response message without an IKEv2 notify payload indicating an error, for a CREATE\_CHILD\_SA request message sent in the IKE SA of the PDN connection, with a REKEY\_SA Notify payload indicating an UE's ESP SPI of a bearer context of the PDN connection, the UE shall set the UE's ESP SPI of the bearer context to the UE's ESP SPI created by the CREATE\_CHILD\_SA request/response pair and shall set the ePDG's ESP SPI of the bearer context to the ePDG's ESP SPI created by the CREATE\_CHILD\_SA request/response pair. + +### 7.2.7.4 User plane procedures + +#### 7.2.7.4.1 General + +Parent subclause of the present subclause describe user plane procedures for the IKEv2 multiple bearer PDN connectivity. + +#### 7.2.7.4.2 Uplink IP packet handling + +If an uplink IP packet to be sent via a PDN connection: + +- matches the packet filters applicable for the uplink direction of the TFT of a bearer context of the PDN connection, the UE shall forward the uplink IP packet using the ePDG's ESP SPI of the bearer context. The UE shall use the QCI in the EPS QoS of the bearer context to derive the DSCP value for uplink packets and set the DSCP field as specified in IETF RFC 2474 [75] of the outer IP header of the ESP packet. +- does not match the packet filters applicable for the uplink direction of the TFT of any bearer context of the PDN connection and a bearer context without the TFT exists in the PDN connection, the UE shall forward the uplink IP packet using the ePDG's ESP SPI of the bearer context without the TFT. The UE shall set the DSCP field as specified in IETF RFC 2474 [75] of the outer IP header of the ESP packet to the DSCP value in a QoS mapping with the QCI indicated in the EPS QoS of the bearer context without the TFT. +- does not match the packet filters applicable for the uplink direction of the TFT of any bearer context of the PDN connection and a bearer context without the TFT does not exist in the PDN connection, the UE shall discard the uplink IP packet. + +NOTE 1: The UE can map QCI to DSCP value, for example, by using the mapping between standardized QCI values and Release 99 3GPP QoS parameter values specified in 3GPP TS 23.401 [4] table E.3, and the mapping between Release 99 3GPP QoS parameter values and DSCP values specified in IEEE Std 802.11 [57] table R-1. + +NOTE 2: The TSi payload and the TSr payloads are not used for selection of ESP SPI for the uplink IP packet. + +## 7.3 3GPP AAA server procedures + +The UE – 3GPP AAA server procedures are as specified in 3GPP TS 29.273 [17] and 3GPP TS 33.402 [15]. + +## 7.4 ePDG procedures + +### 7.4.1 Tunnel establishment + +#### 7.4.1.1 Tunnel establishment accepted by the network + +Upon receipt of an IKE\_AUTH request message from the UE requesting the establishment of a tunnel, the ePDG shall proceed with authentication and authorization. The basic procedure described in 3GPP TS 33.402 [15], while further details are given below. + +During the UE's authentication and authorization procedure, the 3GPP AAA server provides to the ePDG an indication about the selected IP mobility mechanism as specified in 3GPP TS 29.273 [17]. + +The ePDG shall proceed with IPsec tunnel setup completion and shall relay in the IKEv2 Configuration Payload (CFG\_REPLY) of the final IKE\_AUTH response message: + +- The remote IP address information to the UE as follows: + - If NBM is used as IP mobility mechanism, the ePDG shall assign either an IPv4 address or an IPv6 Home Network Prefix or both to the UE via a single CFG\_REPLY Configuration Payload. If the UE requests for both IPv4 address and IPv6 prefix, but the ePDG only assigns an IPv4 address or an IPv6 Home Network Prefix due to subscription restriction or network preference, the ePDG shall include the assigned remote IP address information (IPv4 address or IPv6 prefix) via a single CFG\_REPLY Configuration Payload and should add the corresponding PDN\_TYPE\_IPv4\_ONLY\_ALLOWED Notify payload, or PDN\_TYPE\_IPv6\_ONLY\_ALLOWED Notify payload. If the ePDG assigns an IPv4 address, the CFG\_REPLY contains the INTERNAL\_IP4\_ADDRESS attribute. If the ePDG assigns an IPv6 Home Network Prefix, the CFG\_REPLY contains the INTERNAL\_IP6\_SUBNET or INTERNAL\_IP6\_ADDRESS configuration attributes. The ePDG obtains the IPv4 address and/or the IPv6 Home Network Prefix from the PDN GW; or + +NOTE: In case of IPv6 address, if CFG\_REPLY Configuration Payload contains the INTERNAL\_IP6\_SUBNET or INTERNAL\_IP6\_ADDRESS, the UE considers only IPv6 Home Network Prefix defined by the prefix length value. + +- If DSMIPv6 is used as IP mobility mechanism, depending on the information provided by the UE in the CFG\_REQUEST payload the ePDG shall assign to the UE either a local IPv4 address or local IPv6 address (or a local IPv6 prefix) via a single CFG\_REPLY Configuration Payload. If the ePDG assigns a local IPv4 address, the CFG\_REPLY contains the INTERNAL\_IP4\_ADDRESS attribute and should add the corresponding PDN TYPE\_IPv4\_ONLY\_ALLOWED Notify payload or PDN\_TYPE\_IPv6\_ONLY\_ALLOWED Notify payload. If the ePDG assigns a local IPv6 address or a local IPv6 prefix the CFG\_REPLY contains correspondingly the INTERNAL\_IP6\_ADDRESS or the INTERNAL\_IP6\_SUBNET attribute; and +- If the UE included the INTERNAL\_IP6\_DNS or the INTERNAL\_IP4\_DNS in the CFG\_REQUEST Configuration payload, the ePDG shall include the same attribute in the CFG\_REPLY Configuration payload including zero or more DNS server addresses as specified in IETF RFC 7296 [28]; +- If the UE included the P\_CSCF\_IP6\_ADDRESS attribute, the P\_CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REQUEST configuration payload, the ePDG may include one or more instances of the same attribute in the CFG\_REPLY configuration payload as specified in IETF RFC 7651 [64]; and +- The ePDG may include the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute as specified in subclause 8.2.4.2 indicating the timeout period for liveness check in the CFG\_REPLY configuration payload. Presence of the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute in the IKE\_AUTH request can be used as input for decision on whether to include the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute. + +If the UE does not provide an APN to the ePDG during the tunnel establishment of a non-emergency session, the ePDG shall include the default APN in the "IDr" payload of the IKE\_AUTH response message. If the UE provided an APN to the ePDG during the tunnel establishment, the ePDG shall not change the provided APN and shall include the APN in the IDr payload of the IKE\_AUTH response message. The ePDG shall set the ID Type field of the "IDr" payload to ID\_FQDN as defined in IETF RFC 7296 [28]. Handling of "IDr" payload in case of an emergency session is specified in subclause 7.4.4. An IPsec tunnel is now established between the UE and the ePDG. + +If the UE indicates Handover Attach by including the previously allocated home address information and the ePDG obtains one or more PDN GW identities from the 3GPP AAA server, the ePDG shall use these identified PDN GWs in the subsequent PDN GW selection process. If the UE indicates Initial Attach i.e. home address information not included: + +- if the PDN GW allocation type received from the 3GPP AAA server indicates the static allocation type, the received PDN GW identities shall be used to select PDN-GW; and +- if the PDN GW allocation type received from the 3GPP AAA server indicates the dynamic allocation type, the PDN GW is selected based on DNS query via the UE requested APN. + +The ePDG shall support IPSec ESP (see IETF RFC 4303 [32]) in order to provide secure tunnels between the UE and the ePDG as specified in 3GPP TS 33.402 [15]. + +During the IKEv2 authentication and tunnel establishment, if the UE requested the HA IP address(es) and if DSMIPv6 was chosen and if the HA IP address(es) are available, the ePDG shall provide the HA IP address(es) (IPv6 address and optionally IPv4 address) for the corresponding APN as specified by the "IDr" payload in the IKE\_AUTH request message by including in the CFG\_REPLY Configuration Payload a HOME\_AGENT\_ADDRESS attribute. In the CFG\_REPLY, the ePDG sets respectively the IPv6 Home Agent address field and optionally the IPv4 Home Agent address field of the HOME\_AGENT\_ADDRESS attribute to the IPv6 address of the HA and to the IPv4 address of the HA. If no IPv4 HA address is available at the ePDG or if it was not requested by the UE, the ePDG shall omit the IPv4 Home Agent Address field. If the ePDG is not able to provide an IPv6 HA address for the corresponding APN, then the ePDG shall not include a HOME\_AGENT\_ADDRESS attribute in the CFG\_REPLY. + +The ePDG may support multiple authentication exchanges in the IKEv2 protocol as specified in IETF RFC 4739 [49] in order to support additional authentication and authorization of the UE with an external AAA server. + +If the ePDG supports authentication and authorization of the UE with an external AAA server, on receipt of an IKE\_SA\_INIT message the ePDG shall include a Notify payload of type "MULTIPLE\_AUTH\_SUPPORTED" in the IKE\_SA\_INIT response message to the UE. + +On successful completion of authentication and authorization procedure of the UE accessing EPC and on receipt of an IKE\_AUTH request containing a Notify payload of type "ANOTHER\_AUTH\_FOLLOWS", the ePDG shall send an IKE\_AUTH response containing the "AUTH" payload. + +Upon receipt of a subsequent IKE\_AUTH request from the UE containing the user identity in the private network within the "IDi" payload, the ePDG shall: + +- if PAP authentication is required, then send an EAP-GTC request to the UE within an IKE\_AUTH response message. Upon receipt of an EAP-GTC response from the UE, the ePDG shall use the procedures defined in 3GPP TS 29.275 [18] and 3GPP TS 29.274 [50] to authenticate the user with the external AAA server; and +- if CHAP authentication is required, then send an EAP MD5-Challenge request to UE. Upon receipt of EAP MD5-Challenge response within an IKE\_AUTH request message from the UE, the ePDG shall use the procedures defined in 3GPP TS 29.275 [18] and 3GPP TS 29.274 [50] to authenticate the user with the external AAA server. If the ePDG receives Legacy-Nak response containing EAP-GTC type from the UE (see IETF RFC 3748 [29]) the ePDG may change the authentication and authorization procedure. If the ePDG does not change the authentication and authorization procedure or if the ePDG receives a Legacy-Nak response not containing EAP-GTC, the ePDG shall send an EAP-Failure to the UE. + +NOTE: The signalling flows for authentication and authorization with an external AAA server are described in 3GPP TS 33.402 [15]. + +If the IKE\_AUTH request message contains a P-CSCF\_RESELECTION\_SUPPORT Notify payload as described in subclause 8.2.9.4 and if the ePDG supports the P-CSCF restoration extension (see 3GPP TS 23.380 [66]), the ePDG shall send a P-CSCF\_RESELECTION\_SUPPORT indication to the PGW. + +If the ePDG supports emergency service, the ePDG shall send its capability indication of support emergency service to the UE by including the EMERGENCY\_SUPPORT Notify payload within an IKE\_AUTH response message. The content of the EMERGENCY\_SUPPORT Notify payload is described in subclause 8.2.9.7. + +#### 7.4.1.2 Tunnel establishment not accepted by the network + +During the tunnel establishment procedures, if the ePDG receives from the AAA Server the Authentication and Authorization Answer message with the Result code IE (as specified in 3GPP TS 29.273 [17]): + +- a) DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type NON\_3GPP\_ACCESS\_TO\_EPC\_NOT\_ALLOWED as defined in subclause 8.1.2; +- b) DIAMETER\_ERROR\_USER\_UNKNOWN, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type USER\_UNKNOWN as defined in subclause 8.1.2; + +- c) DIAMETER\_AUTHORIZATION\_REJECTED, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type AUTHORIZATION\_REJECTED as defined in subclause 8.1.2; +- d) DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type RAT\_TYPE\_NOT\_ALLOWED as defined in subclause 8.1.2; +- e) DIAMETER\_UNABLE\_TO\_COMPLY, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type NETWORK\_FAILURE as defined in subclause 8.1.2 and the ePDG may also include a BACKOFF\_TIMER Notify payload of the IKE\_AUTH response message; +- f) DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type PLMN\_NOT\_ALLOWED as defined in subclause 8.1.2; +- g) DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify Payload with a Private Notify Message Type NO\_APN\_SUBSCRIPTION as defined in subclause 8.1.2 and the ePDG may also include a BACKOFF\_TIMER Notify payload of the IKE\_AUTH response message; or +- h) DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT, the ePDG shall include, in the IKE\_AUTH response message to the UE, a Notify payload with a Private Notify Message Type ILLEGAL\_ME as defined in subclause 8.1.2. + +NOTE: In the cases a) through h), the ePDG still provides to the UE the information needed to authenticate the ePDG. + +During the tunnel establishment procedures, when the network has determined that the requested procedure cannot be completed successfully due to a network failure, e.g. due to ePDG congestion, the ePDG: + +- a) shall include in the IKE\_AUTH response message to the UE a Notify payload with a Private Notify Message Type NETWORK\_FAILURE as defined in subclause 8.1.2; and +- b) may also include a BACKOFF\_TIMER Notify payload of the IKE\_AUTH response message. + +If NBM is used and if the ePDG needs to reject a PDN connection due to conditions as specified in 3GPP TS 29.273 [17] or the network policies or the ePDG capabilities to indicate that no more PDN connection request of the given APN can be accepted for the UE, the ePDG shall include, in the IKE\_AUTH response message, a Notify payload with a Private Notify Message Type PDN\_CONNECTION\_REJECTION as specified in subclause 8.1.2. Additionally if the IKE\_AUTH request message from the UE indicated Handover Attach as specified in subclause 7.2.2, and the ePDG needs to reject a PDN connection for example due to the corresponding PDN GW identity not received for the APN, the ePDG shall include, in the IKE\_AUTH response message, a Notify payload with a Private Notify Message Type "PDN\_CONNECTION\_REJECTION" as specified in subclause 8.1.2 and the Notification Data field with the IP address information from the Handover Attach indication. If the UE indicated Initial Attach, the Notification Data field shall be omitted. + +If the ePDG needs to reject a PDN connection due to the network policies or capabilities to indicate that no more PDN connection request with any APN can be accepted for the UE, the ePDG shall include in the IKE\_AUTH response message containing the IDr payload a Notify payload with a Private Notify Message Type MAX\_CONNECTION\_REACHED as specified in subclause 8.1.2. + +#### 7.4.1A Liveness check + +If the ePDG has not received any cryptographically protected IKEv2 or IPSec message for the duration of the timeout period for liveness check selected according to the local policy, the ePDG shall send an INFORMATIONAL request with no payloads IETF RFC 7296 [28]. If an INFORMATIONAL response is not received, the ePDG shall deem the IKEv2 security association to have failed, shall discard all states associated with the IKE SA and any child SAs that were negotiated using that IKE SA as specified in IETF RFC 7296 [28] and shall inform the PGW and the 3GPP AAA Server that the connection has been released. + +#### 7.4.1B Handling of NBIFOM + +If the UE included the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) within the IKE\_AUTH request message, and if required by procedures in 3GPP TS 24.161 [69], the ePDG shall include the same + +Notify payload within the IKE\_AUTH response message as specified in 3GPP TS 24.161 [69]. The ePDG shall set the NBIFOM container contents field of the NBIFOM\_GENERIC\_CONTAINER Notify payload as specified in 3GPP TS 24.161 [69]. + +## 7.4.1C Handling of N1 mode support + +If the UE included the N1\_MODE\_CAPABILITY Notify payload (see subclause 8.1.2.3) within the IKE\_AUTH request message, the ePDG may include the N1\_MODE\_INFORMATION Notify payload and the N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload within the IKE\_AUTH response message. The ePDG shall set the S-NSSAI Value field of the N1\_MODE\_INFORMATION Notify payload to the S-NSSAI for the PDU session associated with the IKEv2 security association if the S-NSSAI information for the PDU session indicated in the PDU session ID field of the N1\_MODE\_CAPABILITY Notify payload is available. The ePDG shall set the S-NSSAI PLMN ID field of the N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload to the PLMN ID that the S-NSSAI relates to for the PDU session associated with the IKEv2 security association if the PLMN ID that the S-NSSAI relates to is available for the PDU session indicated in the PDU session ID field of the N1\_MODE\_CAPABILITY Notify payload. + +## 7.4.2 Tunnel modification + +### 7.4.2.1 ePDG-initiated modification + +The ePDG shall forward the list of available P-CSCF addresses received from the P-GW by including the P\_CSCF\_IP6\_ADDRESS attribute, the P\_CSCF\_IP4\_ADDRESS attribute or both as specified in IETF RFC 7651 [64] in the CFG\_REQUEST configuration payload within the INFORMATIONAL request to the UE as specified in 3GPP TS 23.380 [66]. + +If the ePDG-initiated modification procedure is triggered by NBIFOM procedures in 3GPP TS 24.161 [69], the ePDG shall include the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) in the INFORMATIONAL request. The ePDG shall set the NBIFOM container contents field of the NBIFOM\_GENERIC\_CONTAINER Notify payload as specified in 3GPP TS 24.161 [69]. + +If the ePDG-initiated modification is initiated by a UE-initiated modification, i.e. by a received INFORMATIONAL request message, then the ePDG shall include in the sent INFORMATIONAL request message a PTI Notify payload as specified in subclause 8.1.2.3 with the Related Message ID field set to the Message ID field of the received INFORMATIONAL request message. + +### 7.4.2.2 ePDG behaviour towards UE-initiated modification + +When receiving an INFORMATIONAL request containing the UPDATE\_SA\_ADDRESSES notification, the ePDG shall check the validity of the IP address and update the IP address in the IKE security association with the values from the IP header. The ePDG shall reply with an INFORMATIONAL response. + +The ePDG may initiate a return routability check for the new address provided by the UE, by including a COOKIE2 notification in an INFORMATIONAL request and send it to the UE. When the ePDG receives the INFORMATIONAL response from the UE, it shall check that the COOKIE2 notification payload is the same as the one it sent to the UE. If it is different, the ePDG shall close the IKE security association by sending an INFORMATIONAL request message including a "DELETE" payload. + +If no return routability check is initiated by the ePDG, or if a return routability check is initiated and is successfully completed, the ePDG shall update the IPsec security associations associated with the IKE security association with the new address. + +Upon receipt of the NBIFOM\_GENERIC\_CONTAINER Notify payload (see subclause 8.1.2.3) in an INFORMATIONAL request, the ePDG shall reply with an INFORMATIONAL response and if required by procedures in 3GPP TS 24.161 [69], the ePDG shall include the NBIFOM\_GENERIC\_CONTAINER Notify payload in the INFORMATIONAL response. The ePDG shall set the NBIFOM container contents field of the NBIFOM\_GENERIC\_CONTAINER Notify payload as specified in 3GPP TS 24.161 [69]. + +## 7.4.3 Tunnel disconnection + +### 7.4.3.1 ePDG initiated disconnection + +The ePDG shall use the procedures defined in the IKEv2 protocol (see IETF RFC 7296 [28]) to disconnect one or more IPsec tunnels to the UE. The ePDG shall close the incoming security associations associated with the tunnel and instruct the UE to do likewise by sending the INFORMATIONAL request message including a "DELETE" payload. The DELETE payload shall contain either: + +- i) Protocol ID set to "1" and no subsequent Security Parameter Indexes in the payload. This indicates that the IKE security association, and all IPsec ESP security associations that were negotiated within it between ePDG and UE shall be deleted; +- ii) if the IKEv2 multiple bearer PDN connectivity is not supported or not used in the PDN connection as determined in subclause 7.4.6, the Protocol ID set to "3" for ESP. The SECURITY PARAMETERS INDEXES included in the payload shall correspond to the particular incoming ESP SECURITY ASSOCIATION at the ePDG for the given tunnel in question; or +- iii) if the IKEv2 multiple bearer PDN connectivity is used in the PDN connection as determined in subclause 7.4.6, the Protocol ID field of the DELETE payload is set to "3" for ESP and the SPI field of the DELETE payload includes ePDG's ESP SPIs bound to each the S2b bearers of the PDN connection. + +The INFORMATIONAL request message, in addition of the DELETE payload, may include the REACTIVATION\_REQUESTED\_CAUSE Notify payload. + +If the ePDG receives the reactivation requested cause in a Delete Bearer Request over S2b, the ePDG shall include the REACTIVATION\_REQUESTED\_CAUSE Notify payload in the INFORMATIONAL request message containing a DELETE payload. + +### 7.4.3.2 ePDG behaviour towards UE initiated disconnection + +On receipt of the INFORMATIONAL request message including "DELETE" payload indicating that the UE is initiating tunnel disconnect procedure, the ePDG shall: + +- i) Close all security associations identified within the DELETE payload (these security associations correspond to outgoing security associations from the ePDG perspective). If no security associations were present in the DELETE payload, and the protocol ID was set to "1", the ePDG shall close the IKE security association, and all IPsec ESP security associations that were negotiated within it towards the UE; and +- ii) The ePDG shall delete the incoming security associations corresponding to the outgoing security associations identified in the "DELETE" payload. + +The ePDG shall send an INFORMATIONAL response message. This shall contain a list of security associations deleted in step (ii) above. + +If the ePDG is unable to comply with the INFORMATIONAL request message, the ePDG shall send INFORMATION response message with either: + +- i) a NOTIFY payload of type "INVALID\_SPI", for the case that it could not identify one or more of the SECURITY PARAMETERS INDEXES in the message from the UE; or +- ii) a more general NOTIFY payload type. This payload type is implementation dependent. + +### 7.4.3.3 Local tunnel disconnection initiated by PGW + +A PDN connection over untrusted WLAN over S2b can be released locally in the ePDG, i.e. without any peer-to-peer signalling between the ePDG and the UE, based on the trigger received from the PGW, e.g. during the P-CSCF restoration procedure for NBIFOM PDN connections (see 3GPP TS 23.380 [66]). + +Upon receiving a request from PGW to release the resources for a PDN connection with cause "local release" (see 3GPP TS 29.274 [50]) the ePDG shall: + +- a) close the related IKEv2 security association for the IPsec tunnel associated with this PDN connection; and +- b) consider that the UE is no longer responding (see RFC 7296 [28]) and not send any messages to the UE. + +## 7.4.4 Emergency session establishment + +If the "IDr" payload containing the string "EMERGENCY", using capital letters only, in the Identification Data is included in the IKE\_AUTH request message from the UE, the ePDG shall: + +a) if: + +- 1) an INTERNAL\_IP4\_ADDRESS attribute with the length field set to zero; +- 2) an INTERNAL\_IP6\_ADDRESS attribute with the length field set to zero; or +- 3) both of the above; + +are included in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message, handle the session establishment as an emergency session establishment; + +b) if: + +- 1) an INTERNAL\_IP4\_ADDRESS attribute with the length field set to non-zero; +- 2) an INTERNAL\_IP6\_ADDRESS attribute with the length field set to non-zero; or +- 3) both of the above; + +are included in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message, handle the session establishment as a handover of an emergency session; + +- c) in the IKE\_AUTH response message, the ePDG shall not include the APN in the "IDr" payload; and +- d) ignore the fact that the "EMERGENCY" string does not comply with the ID\_FQDN ID Type, as described in IETF RFC 7296 [28]. + +In addition, if the IKE tunnel establishment is initiated for emergency session: + +- 1) if IMSI is provided to the network but the ePDG receives from the AAA Server the Authentication and Authorization Answer message with the Result code IE indicating DIAMETER\_ERROR\_USER\_UNKNOWN (see 3GPP TS 29.273 [17]), and thus the network considers the IMSI is unauthenticated: + - if the ePDG is configured to support unauthenticated emergency session over WLAN and Mobile Equipment Identity signalling over untrusted WLAN, the ePDG shall request the IMEI from the UE using the Mobile Equipment Identity signalling procedure by including the DEVICE\_IDENTITY Notify payload in the IKE\_AUTH response message as specified in subclause 7.4.5; or + - if the ePDG is not configured to support unauthenticated emergency session over WLAN or the ePDG is not configured to support Mobile Equipment Identity signalling over untrusted WLAN, the ePDG shall reject the requested PDN connection for emergency session. The ePDG shall include, in the IKE\_AUTH response message, a Notify payload with a Private Notify Message Type "UNAUTHENTICATED\_EMERGENCY\_NOT\_SUPPORTED" as specified in subclause 8.1.2; or +- 2) if IMSI is not provided to the network and the UE's IMEI is used as the User Identity in the IDi payload of the IKE\_AUTH request message: + - if the ePDG is configured to support emergency services from unauthenticated UE and the local policies and regulations allow unauthenticated emergency sessions, the ePDG forwards the EAP payload received from the UE to the 3GPP AAA Server serving the specific domain indicated in the realm part of NAI in the IDr payload; or + - if the ePDG is not configured to support emergency services from unauthenticated UE or if the local policies and regulations do not allow unauthenticated emergency sessions, the ePDG shall reject the emergency services request from the UE with the Notify Message Type IMEI\_NOT\_ACCEPTED as specified in subclause 8.1.2.2. + +## 7.4.5 Mobile identity signaling + +If the network supports Mobile Equipment Identity signalling over untrusted WLAN, the ePDG may request the UE to provide the Mobile Equipment Identity by including the DEVICE\_IDENTITY Notify payload with the Identity Type field set to either 'IMEI' or 'IMEISV' and an empty Identity Value field in: + +- the IKE\_AUTH response message to the initial IKE\_AUTH request message received from the UE during the IKEv2 authentication and security association establishment; or +- the INFORMATIONAL request message at any time after successful IPSec tunnel establishment. + +If the ePDG receives the following response message from the UE: + +- the IKE\_AUTH request message with the DEVICE\_IDENTITY Notify payload; or +- the INFORMATIONAL response message with the DEVICE\_IDENTITY Notify payload, + +and the Identity Type field set to either 'IMEI' or 'IMEISV' and the Identity Value is not empty, the ePDG shall forward the received IMEI or IMEISV identity to the 3GPP AAA server as specified in 3GPP TS 29.273 [17] and to the PDN GW as specified in 3GPP TS 29.275 [18] and 3GPP TS 29.274 [50]. + +## 7.4.6 IKEv2 multiple bearer PDN connectivity + +### 7.4.6.1 General + +The ePDG may support the IKEv2 multiple bearer PDN connectivity. + +If the ePDG supports the IKEv2 multiple bearer PDN connectivity, then the ePDG shall perform handling specified in the present subclause. Otherwise the ePDG does not perform handling specified in the present subclause and remaining subclauses of the parent subclause of the present subclause. + +If the IKE\_AUTH request message contains an IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify payload as specified in subclause 8.2.9.9 and the ePDG decides to use the IKEv2 multiple bearer PDN connectivity in the PDN connection of the IKE SA being established by the IKE\_AUTH request message according to local policy, the ePDG shall consider that the IKEv2 multiple bearer PDN connectivity is used in the PDN connection. + +If the IKEv2 multiple bearer PDN connectivity is used in the PDN connection, then the ePDG shall perform the handling specified in remaining subclauses of the parent subclause of the present subclause. Otherwise the ePDG does not perform the handling specified in remaining subclauses of the parent subclause of the present subclause. + +### 7.4.6.2 Maintained information + +The ePDG shall maintain a binding of an ePDG's ESP SPI and a UE's ESP SPI to each S2b bearer of the PDN connection. + +### 7.4.6.3 Control plane procedures + +#### 7.4.6.3.1 General + +Parent subclause of the present subclause describe control plane procedures for the IKEv2 multiple bearer PDN connectivity. + +#### 7.4.6.3.2 Establishment of IKEv2 SA and initial IPSec ESP tunnel + +In the IKE\_AUTH response message establishing an IKE SA of the PDN connection: + +- a) the ePDG shall include an EPS\_QOS Notify payload as specified in subclause 8.2.9.10 indicating the EPS QoS of the default S2b bearer of the PDN connection; +- b) the ePDG may include an EXTENDED\_EPS\_QOS Notify payload as specified in subclause 8.2.9.10A indicating the extended EPS QoS of the default S2b bearer of the PDN connection; +- c) the ePDG may include an APN\_AMBR Notify payload as specified in subclause 8.2.9.13 indicating the APN-AMBR of the PDN connection; and + +- d) if the APN\_AMBR Notify payload is included, the ePDG may include an EXTENDED\_APN\_AMBR Notify payload as specified in subclause 8.2.9.14 indicating the extended APN-AMBR of the PDN connection + +Upon sending the IKE\_AUTH response message, the ePDG shall bind the ePDG's ESP SPI created by the IKE\_AUTH request/response pair and the UE's ESP SPI created by the IKE\_AUTH request/response pair to the default S2b bearer of the PDN connection. + +#### 7.4.6.3.3 Establishment of an additional IPSec ESP tunnel + +If a dedicated S2b bearer of the PDN connection is activated, the ePDG shall send a CREATE\_CHILD\_SA request message in the IKE SA of the PDN connection. In the CREATE\_CHILD\_SA request message: + +- a) the ePDG shall include an EPS\_QOS Notify payload as specified in subclause 8.2.9.10 indicating the EPS QoS of the dedicated S2b bearer of the PDN connection; +- b) the ePDG may include an EXTENDED\_EPS\_QOS Notify payload as specified in subclause 8.2.9.10A indicating the extended EPS QoS of the dedicated S2b bearer of the PDN connection; and +- c) the ePDG shall include an TFT Notify payload as specified in subclause 8.2.9.11 indicating the TFT of the dedicated S2b bearer of the PDN connection. + +Upon receiving a CREATE\_CHILD\_SA response message without an IKEv2 notify payload indicating an error, the ePDG shall accept the dedicated S2b bearer activation and shall bind the ePDG's ESP SPI created by the CREATE\_CHILD\_SA request/response pair and the UE's ESP SPI created by the CREATE\_CHILD\_SA request/response pair to the dedicated S2b bearer of the PDN connection. + +Upon receiving a CREATE\_CHILD\_SA response message with an IKEv2 notify payload indicating an error, the ePDG shall reject the dedicated S2b bearer activation. + +#### 7.4.6.3.4 Release of an additional IPSec ESP tunnel + +If a dedicated S2b bearer of the PDN connection is deactivated, the ePDG shall send a INFORMATIONAL request message in the IKE SA of the PDN connection. In the INFORMATIONAL request message, the ePDG shall include an DELETE payload indicating the ePDG's ESP SPI bound to the dedicated S2b bearer. + +Upon receiving of a INFORMATIONAL response message, the ePDG shall acknowledge deactivation of the dedicated S2b bearer. + +#### 7.4.6.3.5 Modification of an IPSec ESP tunnel due to change of EPS QoS and TFT + +If an S2b bearer of the PDN connection is modified, the ePDG shall send a INFORMATIONAL request message in the IKE SA of the PDN connection. In the INFORMATIONAL request message, the ePDG shall include an MODIFIED\_BEARER Notify payload as specified in subclause 8.2.9.12 indicating the ePDG's ESP SPI bound to the S2b bearer. In the INFORMATIONAL request message: + +- a) the ePDG may include an EPS\_QOS Notify payload as specified in subclause 8.2.9.10 indicating the EPS QoS of the S2b bearer of the PDN connection; +- b) if the EPS\_QOS Notify payload is included, the ePDG may include an EXTENDED\_EPS\_QOS Notify payload as specified in subclause 8.2.9.10A indicating the extended EPS QoS of the default S2b bearer of the PDN connection; +- c) the ePDG may include an TFT Notify payload as specified in subclause 8.2.9.11 indicating the TFT of the S2b bearer of the PDN connection; and +- d) if the S2b bearer is the default S2b bearer: + - 1) the ePDG may include an APN\_AMBR Notify payload as specified in subclause 8.2.9.13 indicating the APN-AMBR of the PDN connection; and + - 2) if the APN\_AMBR Notify payload is included, the ePDG may include an EXTENDED\_APN\_AMBR Notify payload as specified in subclause 8.2.9.14 indicating the extended APN-AMBR of the PDN connection. + +Upon receiving a INFORMATIONAL response message without an IKEv2 notify payload indicating an error, the ePDG shall accept the S2b bearer modification. + +Upon receiving a INFORMATIONAL response message with an IKEv2 notify payload indicating an error, the ePDG shall reject the S2b bearer modification. + +#### 7.4.6.3.6 ePDG initiated IPsec ESP tunnel rekeying + +Upon receiving a CREATE\_CHILD\_SA response message without an IKEv2 notify payload indicating an error, for a CREATE\_CHILD\_SA request message sent in the IKE SA of the PDN connection, with a REKEY\_SA Notify payload indicating an ePDG's ESP SPI bound to an S2b bearer of the PDN connection, the ePDG shall set the ePDG's ESP SPI bound to the S2b bearer to the ePDG's ESP SPI created by the CREATE\_CHILD\_SA request/response pair and shall set the UE's ESP SPI bound to the S2b bearer to the UE's ESP SPI created by the CREATE\_CHILD\_SA request/response pair. + +#### 7.4.6.3.7 UE initiated IPsec ESP tunnel rekeying + +Upon receiving a CREATE\_CHILD\_SA request message in the IKE SA of the PDN connection, with a REKEY\_SA Notify payload indicating an UE's ESP SPI bound to an S2b bearer of the PDN connection, if the ePDG sends a CREATE\_CHILD\_SA response message without an IKEv2 notify payload indicating an error, the ePDG shall set the ePDG's ESP SPI bound to the S2b bearer to the ePDG's ESP SPI created by the CREATE\_CHILD\_SA request/response pair, and shall set the UE's ESP SPI bound to the S2b bearer to the UE's ESP SPI created by the CREATE\_CHILD\_SA request/response pair. + +#### 7.4.6.4 User plane procedures + +##### 7.4.6.4.1 General + +Parent subclause of the present subclause describe user plane procedures for the IKEv2 multiple bearer PDN connectivity. + +##### 7.4.6.4.2 Downlink IP packet handling + +The ePDG shall forward a downlink IP packet received via an S2b bearer of the PDN connection using an UE's ESP SPI bound to the S2b bearer. The ePDG shall use the QCI of S2b bearer via which the downlink packet was received to derive the DSCP value for downlink packets and set the DSCP field as specified in IETF RFC 2474 [75] of the outer IP header of the ESP packet. + +NOTE: The ePDG can map QCI to DSCP value, for example, by using the mapping between standardized QCI values and Release 99 3GPP QoS parameter values specified in 3GPP TS 23.401 [4] table E.3, and the mapping between Release 99 3GPP QoS parameter values and DSCP values specified in IEEE Std 802.11 [57] table R-1. + +##### 7.4.6.4.3 Uplink IP packet handling + +The ePDG shall forward an uplink IP packet received via an ePDG's ESP SPI bound to an S2b bearer of the PDN connection using the S2b bearer. + +--- + +## 8 PDUs and parameters specific to the present document + +### 8.0 General + +The least significant bit of a field is represented by the lowest numbered bit of the highest numbered octet of the field. When the field extends over more than one octet, the order of bit values progressively decreases as the octet number increases. + +Figure 8.0-1 shows an example of a field where the most significant bit of the field is marked MSB and the least significant bit of the field is marked LSB. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|-----|---|---|---|---|---|---|-----|---------| +| MSB | x | x | x | x | x | x | x | octet 1 | +| x | x | x | x | x | x | x | x | | +| x | x | x | x | x | x | x | LSB | octet N | + +**Figure 8.0-1: Example of bit ordering of a field** + +NOTE: IETF RFCs adopted different numbering of bits, such that the least significant bit of a field is represented by the highest numbered bit of the field. + +## 8.1 3GPP specific coding information defined within present document + +### 8.1.1 Access Network Identity format and coding + +#### 8.1.1.1 Generic format of the Access Network Identity + +The Access Network Identity shall take the generic format of an octet string without terminating null characters. The length indicator for the ANID is 2 bytes long, see IETF RFC 5448 [38]. Representation as a character string is allowed, but this character string shall be converted into an octet string of maximum length 253 according to UTF-8 encoding rules as specified in IETF RFC 3629 [34] before the Access Network Identity is input to the Key Derivation Function, as specified in 3GPP TS 33.402 [15], or used in the Access Network Identity indication from 3GPP AAA server to UE, cf. subclause 8.2.2. The ANID is structured as an ANID Prefix and none, one or more ANID additional character strings separated by the colon character ":". In case additional ANID strings are not indicated the complete ANID consists of the ANID Prefix character string only. The ANID shall be represented by Unicode characters encoded as UTF-8 as specified in IETF RFC 3629 [34] and formatted using Normalization Form KC (NFKC) as specified in Unicode 5.1.0, Unicode Standard Annex #15; Unicode Normalization Forms [41]. + +#### 8.1.1.2 Definition of Access Network Identities for Specific Access Networks + +Table 8.1.1.2-1 specifies the list of Access Network Identities defined by 3GPP in the context of non-3GPP access to EPC. + +**Table 8.1.1.2-1: Access Network Identities in the context of non-3GPP access to EPC** + +| Access Network Identity | | Type of Access Network | +|---------------------------------------------------------|--------------------------------------------------|-------------------------------------| +| ANID Prefix | Additional ANID strings | | +| "HRPD" constant character string, see NOTE 1 and NOTE 2 | No additional ANID string, see NOTE 2 and NOTE 6 | cdma2000® HRPD access network | +| "WIMAX" constant character string, see NOTE 1 | No additional ANID string, see NOTE 3 and NOTE 6 | WiMAX access network | +| "WLAN" constant character string, see NOTE 1 | No additional ANID string, see NOTE 4 and NOTE 6 | WLAN access network | +| "ETHERNET" constant character string, see NOTE 1 | No additional ANID string, see NOTE 5 and NOTE 6 | Fixed access network | +| All other character strings | Not applicable | Not defined, see NOTE 6 and Annex B | + +NOTE 1: The quotes are not part of the definition of the character string. + +NOTE 2: The value of the ANID Prefix for cdma2000® HRPD access networks is defined in 3GPP2 X.S0057 [20]. 3GPP2 is responsible for specifying possible additional ANID strings applicable to the "HRPD" ANID Prefix. + +NOTE 3: WiMAX Forum is responsible for specifying possible additional ANID strings applicable to the "WIMAX" ANID Prefix. + +NOTE 4: IEEE 802 is responsible for specifying possible additional ANID strings applicable to the "WLAN" ANID Prefix. + +NOTE 5: IEEE 802 is responsible for specifying possible additional ANID strings applicable to the "ETHERNET" ANID Prefix. + +NOTE 6: Additional ANID Prefixes and ANID strings can be added to this table following the procedure described in the informative Annex B. + +Table 8.1.1.2-2 specifies the list of Access Network Identities defined by 3GPP in the context of access to 5GCN. + +**Table 8.1.1.2-2: Access Network Identities in the context of access to 5GCN** + +| Access Network Identity | | Type of Access Network | +|----------------------------------------------------------------------------------|------------------------------------|-------------------------------| +| ANID Prefix | Additional ANID strings | | +| SNN-service-code, which is "5G" constant character string, see NOTE 1 and NOTE 2 | SNN-network-identifier, see NOTE 2 | N/A, see NOTE 3 | + +NOTE 1: The quotes are not part of the definition of the character string. + +NOTE 2: Serving network name (SNN) specified in 3GPP TS 24.501 [76] is used as 5G Access Network Identity. + +NOTE 3: Type of Access Network is not applicable for 5G Access Network Identity. + +## 8.1.2 IKEv2 Notify Message Type value + +### 8.1.2.1 Generic + +The IKEv2 Notify Message Type is specified in IETF RFC 7296 [28]. + +The Notify Message Type with a value (in decimal) between 8192 and 16383 is reserved for private error usage. + +The Notify Message Type with a value (in decimal) between 40960 and 65535 is reserved for private status usage. + +Only the private IKEv2 Notify Message Types used for this specification are specified in this subclause. + +### 8.1.2.2 Private Notify Message - Error Types + +The Private Notify Message, Error Types defined in table 8.1.2.2-1 are error notifications which indicates an error while negotiating an IKEv2 SA for the PDN connection to the APN requested by the UE. Refer to table 8.1.2.2-1 for more details on what each error type means. + +**Table 8.1.2.2-1: Private Error Types** + +| Notify Message | Value (in decimal) | Descriptions | +|----------------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PDN_CONNECTION_REJECTION | 8192 |

With an IP address information in Notification Data field:
The PDN connection corresponding to the IP address information has been rejected.

Without Notification Data field:
The PDN connection corresponding to the requested APN has been rejected. No additional PDN connections to the given APN can be established. If the rejected PDN connection is the first PDN connection for the given APN, this APN is not allowed for the UE.

| +| MAX_CONNECTION_REACHED | 8193 |

The PDN connection has been rejected. No additional PDN connections can be established for the UE due to the network policies or capabilities.
The maximum number of PDN connections per UE allowed to be established simultaneously is limited by the number of EPS bearer identities (see subclause 11.2.3.1.5 of 3GPP TS 24.007 [48]) or by the number of PDU session IDs (see subclause 11.2.3.1b of 3GPP TS 24.007 [48]).

| +| SEMANTIC_ERROR_IN_THE_TFT_OPERATION | 8241 | This error type is used to indicate that the requested service was rejected due to a semantic error in the TFT operation included in the request. | +| SYNTACTICAL_ERROR_IN_THE_TFT_OPERATION | 8242 | This error type is used to indicate that the requested service was rejected due to a syntactical error in the TFT operation included in the request. | +| SEMANTIC_ERRORS_IN_PACKET_FILTERS | 8244 | This error type is used to indicate that the requested service was rejected due to a semantic error in the packet filter(s) included in the request. | +| SYNTACTICAL_ERRORS_IN_PACKET_FILTERS | 8245 | This error type is used to indicate that the requested service was rejected due to a syntactical error in the packet filter(s) included in the request. | +| NON_3GPP_ACCESS_TO_EPC_NOT_ALLOWED | 9000 |

Corresponds to:

  • - DIAMETER_ERROR_USER_NO_NON_3GPP_SUBSCRIPTION Result code IE as specified in 3GPP TS 29.273 [17]; or
  • - Other scenarios when the UE is not allowed to use non-3GPP access to EPC.
| +| USER_UNKNOWN | 9001 |

Corresponds to:

  • - DIAMETER_ERROR_USER_UNKNOWN Result code IE as specified in 3GPP TS 29.273 [17]; or
  • - Other scenarios when the user identified by the IMSI is unknown.
| +| NO_APN_SUBSCRIPTION | 9002 |

Corresponds to:

  • - DIAMETER_ERROR_USER_NO_APN_SUBSCRIPTION Result code IE as specified in 3GPP TS 29.273 [17]; or
  • - Other scenarios when the requested APN is not included in the user's profile, and therefore is not authorized for that user..
| +| AUTHORIZATION_REJECTED | 9003 |

Corresponds to:

  • - DIAMETER_AUTHORIZATION_REJECTED Result code IE as specified in 3GPP TS 29.273 [17]; or
  • - Other scenarios when the user is barred from using the non-3GPP access or the subscribed APN.
| +| ILLEGAL_ME | 9006 |

Corresponds to:

  • - DIAMETER_ERROR_ILLEGAL_EQUIPMENT Result code IE as specified in 3GPP TS 29.273 [17]; or
  • - Other scenarios when the ME used is not accepted by the network.
| +| NETWORK_FAILURE | 10500 |

Corresponds to:

  • - DIAMETER_ERROR_UNABLE_TO_COMPLY Result code IE as specified in 3GPP TS 29.273 [17]; or
  • - Other scenarios when the network has determined that
| + +| | | | +|-----------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | the requested procedure cannot be completed successfully due to network failure. | +| RAT_TYPE_NOT_ALLOWED | 11001 | Corresponds to:
- DIAMETER_RAT_TYPE_NOT_ALLOWED Result code IE as specified in 3GPP TS 29.273 [17]; or
- Other scenarios when the access type is restricted to the user. | +| IMEI_NOT_ACCEPTED | 11005 | The emergency PDN connection request has been rejected since the network does not accept an emergency service request using an IMEI. | +| PLMN_NOT_ALLOWED | 11011 | Corresponds to:
- DIAMETER_ERROR_ROAMING_NOT_ALLOWED Result code IE as specified in 3GPP TS 29.273 [17];
- The ePDG performs PLMN filtering (based on roaming agreements) and rejects the request from the UE; or
- Other scenarios when the UE requests service in a PLMN where the UE is not allowed to operate. | +| UNAUTHENTICATED_EMERGENCY_NOT_SUPPORTED | 11055 | The emergency PDN connection request has been rejected due to authentication has failed or authentication cannot proceed at AAA server, and the ePDG does not support an emergency service request using an unauthenticated IMSI. | + +The private notify message error type values: + +- between 9950 and 9999; +- between 10950 and 10999; +- between 11950 and 11999; +- between 12950 and 12999; +- between 13950 and 13999; +- between 14950 and 14999; and +- between 15500 and 15599; + +will not be allocated to a Notify payload defined in the present specification. + +The private notify message error type values between 15500 and 15599 shall be allocated in 3GPP TS 24.502 [77]. + +### 8.1.2.3 Private Notify Message - Status Types + +The Private Notify Message Status Types defined in table 8.1.2.3-1 are used to indicate status notifications or additional information in a Notify payload which may be added to an IKEv2 message or IKE\_AUTH request or IKE\_AUTH response message according to the procedures described in the present document. Refer to table 8.1.2.3-1 for more details on what each status type means. + +**Table 8.1.2.3-1: Private Status Types** + +| Notify Message | Value (in decimal) | Descriptions | +|----------------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| REACTIVATION_REQUESTED_CAUSE | 40961 | The IPsec tunnel associated to a PDN connection is released with a cause requesting the UE to reestablish the IPsec tunnel for the same PDN Connection after its release. | +| BACKOFF_TIMER | 41041 | The value of the backoff timer is included in the BACKOFF_TIMER Notify payload as specified in subclause 8.2.9.1. | +| PDN_TYPE_IPV4_ONLY_ALLOWED | 41050 | This value is used by the network to indicate that only PDN type IPv4 is allowed for the requested PDN connectivity. | +| PDN_TYPE_IPV6_ONLY_ALLOWED | 41051 | This value is used by the network to indicate that only PDN type IPv6 is allowed for the requested PDN connectivity. | +| DEVICE_IDENTITY | 41101 | The device identity type and/or identity value are included in the DEVICE_IDENTITY Notify payload as specified in subclause 8.2.9.2. | +| EMERGENCY_SUPPORT | 41112 | This status when present indicates that the ePDG supports emergency service. The EMERGENCY_SUPPORT Notify payload is coded according to subclause 8.2.9.7. | +| EMERGENCY_CALL_NUMBERS | 41134 | Additional local emergency call numbers that the UE may use for detecting UE initiated emergency calls. The EMERGENCY_CALL_NUMBERS Notify payload is coded according to subclause 8.2.9.8. | +| NBIFOM_GENERIC_CONTAINER | 41288 | The NBIFOM parameters are included in the NBIFOM_GENERIC_CONTAINER Notify payload as specified in subclause 8.2.9.3. | +| P-CSCF_RESELECTION_SUPPORT | 41304 | This status when present indicates that the UE supports the P-CSCF restoration extension for untrusted WLAN | +| PTI | 41501 | An INFORMATIONAL request message of an ePDG-initiated modification procedure is initiated by another INFORMATIONAL request message of an UE-initiated modification procedure. The PTI Notify payload is coded according to subclause 8.2.9.5. | +| IKEV2_MULTIPLE_BEARER_PDN_CONNECTIVITY | 42011 | This status when present indicates that the UE supports IKEv2 multiple bearer PDN connectivity. The IKEV2_MULTIPLE_BEARER_PDN_CONNECTIVITY Notify payload is coded according to subclause 8.2.9.9. | +| EPS_QOS | 42014 | This status when present indicates EPS QoS. The EPS_QOS Notify payload is coded according to subclause 8.2.9.10. | +| EXTENDED_EPS_QOS | 42015 | This status when present indicates extended EPS QoS. The EXTENDED_EPS_QOS Notify payload is coded according to subclause 8.2.9.10A. | +| TFT | 42017 | This status when present indicates TFT. The TFT Notify payload is coded according to subclause 8.2.9.11. | +| MODIFIED_BEARER | 42020 | This status when present indicates sender's ESP SPI. The MODIFIED_BEARER Notify payload is coded according to subclause 8.2.9.12. | +| APN_AMBR | 42094 | This status when present indicates APN-AMBR. The APN_AMBR Notify payload is coded according to subclause 8.2.9.13. | +| EXTENDED_APN_AMBR | 42095 | This status when present indicates extended APN-AMBR. The EXTENDED_APN_AMBR Notify payload is coded according to subclause 8.2.9.14. | +| N1_MODE_CAPABILITY | 51015 | This status when present indicates N1 mode capability. The N1_MODE_CAPABILITY Notify payload is coded according to subclause 8.2.9.15. | +| N1_MODE_INFORMATION | 51115 | This status when present indicates N1 mode | + +| | | | +|-------------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | information. The N1_MODE_INFORMATION Notify payload is coded according to subclause 8.2.9.16. | +| N1_MODE_S_NSSAI_PLMN_ID | 52216 | This status when present indicates the PLMN ID that the S-NSSAI relates to. The N1_MODE_S_NSSAI_PLMN_ID Notify payload is coded according to subclause 8.2.9.17. | + +The private notify message status type values: + +- between 49950 and 49999; +- between 50950 and 50999; +- between 51950 and 51999; +- between 52950 and 52999; +- between 53950 and 53999; +- between 54950 and 54999; and +- between 55500 and 55599; + +will not be allocated to a Notify payload defined in the present specification. + +The private notify message status type values between 55500 and 55599 shall be allocated in 3GPP TS 24.502 [77]. + +## 8.1.3 ANDSF Push Information + +### 8.1.3.1 General + +The values of the ANDSF Push Information sent to the UE using the GAA bootstrap framework for ANDSF Push as specified in subclause 6.8.2.2.2 are defined in this subclause. + +### 8.1.3.2 ANDSF Push Information values + +The ANDSF Push Information defined in table 8.1.3.2-1 indicates the X-WAP-Application-ID field (Push Application ID) for ANDSF in the WSP header. + +**Table 8.1.3.2-1: ANDSF Push Information values** + +| WSP header attribute | Value | Short code | Descriptions | +|----------------------|---------------------|------------|------------------------------------------| +| X-WAP-Application-ID | x-3gpp.gba.andsf.ua | 0x9071 | The application identity indicates ANDSF | + +## 8.1.4 PDUs for TWAN connection modes + +### 8.1.4.0 General + +The PDUs defined in this subclause are used when SCM, MCM or both are supported. + +The sending entity shall set value of spare bit to zero. The receiving entity shall ignore value of spare bit + +### 8.1.4.1 Message + +The message is coded according to figure 8.1.4.1-1 and table 8.1.4.1-1. + +![Diagram of the Message PDU structure. It shows a sequence of octets from 7 to 0. Octet 1 contains the 'Message type' field. Octet 2 contains the 'Item list' field. Octet Z is the final octet. The spare bit (bit 7) is set to zero.](1514ba1efbec1dbb3fbda5d02701af36_img.jpg) + +| | | | | | | | | | +|--------------|---|---|---|---|---|---|---|---------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Message type | | | | | | | | octet 1 | +| Item list | | | | | | | | octet 2 | +| | | | | | | | | octet Z | + +Diagram of the Message PDU structure. It shows a sequence of octets from 7 to 0. Octet 1 contains the 'Message type' field. Octet 2 contains the 'Item list' field. Octet Z is the final octet. The spare bit (bit 7) is set to zero. + +**Figure 8.1.4.1-1: Message** + +**Table 8.1.4.1-1: Message** + +Message type field is coded according to table 8.1.4.1-2. The message is ignored if Message type field containing a value other than those in table 8.1.4.1-2 is received. + +Optional Item list field contains sequence of items, each of which is coded according to subclause 8.1.4.2. The receiving entity does not assume that a certain order of items will be used in the Item list. When the receiving entity does not recognize an item in the Item list, that particular item is ignored, and the receiving entity continues to process the rest of the items in the Item list. The Item list field includes at maximum one item of each type described in subclause 8.1.4.2. + +**Table 8.1.4.1-2: Message type** + +Message type is coded as follows. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---|---|---|---|---|---|---|---|-----------------------| +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | CONNECTION_CAPABILITY | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | SCM_REQUEST | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | SCM_RESPONSE | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | MCM_REQUEST | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | MCM_RESPONSE | + +## 8.1.4.2 Item + +The Item is coded according to figure 8.1.4.2-1 and table 8.1.4.2-1: + +![](f9873201604e723ae0bafb7e389ef619_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|--------|---|---|---|---|---|---|---|--------------------| +| Type | | | | | | | | octet 1 | +| Length | | | | | | | | octet 2 | +| Value | | | | | | | | octet 3
octet Z | + +**Figure 8.1.4.2-1: Item****Table 8.1.4.2-1: Item** + +Type field is coded according to the table 8.1.4.2-2. When the Type field contains a type other than those specified in table 8.1.4.2-2, the entire Item is ignored. + +Length field indicates the number of octets in the Value field. + +Value field contains the parameter value of the type of item. + +**Table 8.1.4.2-2: Types of item** + +| The type field is coded as follows. | | | | | | | | | +|-------------------------------------|----------|----------|----------|----------|----------|----------|----------|--------------------------------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | CONNECTIVITY_TYPE | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | ATTACHMENT_TYPE | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | APN | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | PDN_TYPE | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | AUTHORIZATIONS | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | CONNECTION_MODE_CAPABILITY | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | PROTOCOL_CONFIGURATION_OPTIONS | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | CAUSE | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | IPv4_ADDRESS | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | IPv6_INTERFACE_IDENTIFIER | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | TWAG_CP_ADDRESS | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | TWAG_UP_MAC_ADDRESS | +| 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | SUPPORTED_WLCP_TRANSPORTS | +| 0 | 0 | 0 | 0 | 1 | 1 | 0 | 1 | Tw1 | +| 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | ACCESS CAUSE | + +### 8.1.4.3 CONNECTIVITY\_TYPE item + +When the Type field of this item, according to subclause 8.1.4.2, indicates the CONNECTIVITY\_TYPE, then the Length field of this item is set to 1 and the Value field of this item is coded according to table 8.1.4.3-1. + +**Table 8.1.4.3-1: CONNECTIVITY\_TYPE value** + +| The Connectivity type value is coded as follows. | | | | | | | | | +|--------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|----------------------------------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | PDN connection connectivity type | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | NSWO connectivity type | + +All other values are interpreted as "PDN connection connectivity type". + +When the Connectivity Type item is received by the 3GPP AAA server, it indicates that the indicated connectivity type is requested. +When the Connectivity Type item is received by the UE, it indicates that the indicated connectivity type is authorized. + +### 8.1.4.4 ATTACHMENT\_TYPE item + +When the Type field of this item according to subclause 8.1.4.2 indicates the ATTACHMENT\_TYPE, then the Length field of this item is set to 1 and the Value field of this item is coded according to table 8.1.4.4-1. + +**Table 8.1.4.4-1: ATTACHMENT\_TYPE value** + +| The ATTACHMENT TYPE value is coded as follows. | | | | | | | | | +|------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|--------------------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | Initial attach | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | Handover attach | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | Emergency attach | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | Emergency handover | + +All other values are interpreted as "Initial attach". + +#### 8.1.4.5 APN item + +When the Type field of this item according to subclause 8.1.4.2 indicates the APN, then the Value field of this item contains the APN as described in 3GPP TS 23.003 [3]. When received by the 3GPP AAA server, it indicates the requested APN. When received by the UE, it indicates the selected APN. + +#### 8.1.4.6 PDN\_TYPE item + +When the Type field of this item according to subclause 8.1.4.2 indicates the PDN\_TYPE, then the Length field of this item is set to 1 and the Value field of this item is coded according to table 8.1.4.6-1. + +**Table 8.1.4.6-1: PDN\_TYPE value** + +| The PDN type value is coded as follows. | | | | | | | | | | +|-----------------------------------------|---|---|---|---|---|---|---|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | | IPv4 - when received by the 3GPP AAA server, it indicates that IPv4 is requested. When received by the UE, it indicates that IPv4 is supported. | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | | IPv6 - when received by the 3GPP AAA server, it indicates that IPv6 is requested. When received by the UE, it indicates that IPv6 is supported. | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | | IPv4v6 - when received by the 3GPP AAA server, it indicates that IPv4, IPv6 or both are requested. When received by the UE, it indicates that both IPv4 and IPv6 are supported. | + +All other values are interpreted as "IPv6". + +#### 8.1.4.7 AUTHORIZATIONS item + +When the Type field of this item according to subclause 8.1.4.2 indicates the AUTHORIZATIONS, then the Length field of this item is set to 1 and the Value field of this item is coded according to figure 8.1.4.7-1 and table 8.1.4.7-1. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---------|---------|---------|---------|---------|---------|---------|-------|---------| +| 0 Spare | 0 Spare | 0 Spare | 0 Spare | 0 Spare | 0 Spare | 0 Spare | NSWOA | octet 1 | + +**Figure 8.1.4.7-1: AUTHORIZATIONS value** + +**Table 8.1.4.7-1: AUTHORIZATIONS value** + +| | | +|-------------------------------------------------------|----------------------------------| +| The authorization value is coded as follows: | | +| UE authorization to use NSWO (NSWOA) (octet 1, bit 0) | | +| 0 | UE is not authorized to use NSWO | +| 1 | UE is authorized to use NSWO | +| Bit 1 to bit 7 of octet 1 are spare. | | + +#### 8.1.4.8 CONNECTION\_MODE\_CAPABILITY item + +When the Type field of this item according to subclause 8.1.4.2 indicates the CONNECTION\_MODE\_CAPABILITY, then the Length field of this item is set to 1 and the Value field of this item is coded according to figure 8.1.4.8-1 and table 8.1.4.8-1. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---------|---------|---------|---------|----|-------|------|------|---------| +| 0 Spare | 0 Spare | 0 Spare | 0 Spare | ES | TSMCI | MCMI | SMCI | octet 1 | + +**Figure 8.1.4.8-1: CONNECTION\_MODE\_CAPABILITY value****Table 8.1.4.8-1: CONNECTION\_MODE\_CAPABILITY value** + +The Connection Mode Capability value is coded as follows: + +Support of SCM (SCMI) (octet 1, bit 0) + +0 SCM is not supported + +1 SCM is supported + +Support of MCM (MCMI) (octet 1, bit 1) + +0 MCM is not supported + +1 MCM is supported + +Support of TSCM (TSCMI) (octet 1, bit 2) + +0 TSCM is not supported + +1 TSCM is supported + +Support of emergency services (ES) (octet 1, bit 3) + +0 emergency services are not supported + +1 emergency services are supported + +Bit 4 to bit 7 of octet 1 are spare. + +#### 8.1.4.9 PROTOCOL\_CONFIGURATION\_OPTIONS item + +When the Type field of this item according to subclause 8.1.4.2 indicates the PROTOCOL\_CONFIGURATION\_OPTIONS, then the Value field of this item is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the protocol configuration options information element defined in 3GPP TS 24.008 [46] subclause 10.5.6.3. + +NOTE: The protocol configuration options IEI field and the length of protocol configuration options contents field of the protocol configuration options information element are not included in the Value field of the PROTOCOL\_CONFIGURATION\_OPTIONS item. + +#### 8.1.4.10 CAUSE item + +##### 8.1.4.10.1 General + +When the Type field of this item according to subclause 8.1.4.2 indicates the CAUSE, then the Length field of this item is set to 1 and the Value field of this item is coded according to table 8.1.4.10-1. If the CAUSE item is received by the 3GPP AAA server, the item is ignored. + +Semantics of the Cause values are defined in subclause 8.1.4.10.2. + +**Table 8.1.4.10-1: CAUSE value** + +| The Cause value is coded as follows. | | | | | | | | | +|--------------------------------------|----------|----------|----------|----------|----------|----------|----------|---------------------------------------------------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | Operator determined barring | +| 0 | 0 | 0 | 1 | 1 | 0 | 1 | 0 | Insufficient resources | +| 0 | 0 | 0 | 1 | 1 | 0 | 1 | 1 | Unknown APN | +| 0 | 0 | 0 | 1 | 1 | 1 | 0 | 0 | Unknown PDN type | +| 0 | 0 | 0 | 1 | 1 | 1 | 0 | 1 | User authentication failed | +| 0 | 0 | 0 | 1 | 1 | 1 | 1 | 0 | Request rejected by PDN GW | +| 0 | 0 | 0 | 1 | 1 | 1 | 1 | 1 | Request rejected, unspecified | +| 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | Service option not supported | +| 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | Requested service option not subscribed | +| 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | Service option temporarily out of order | +| 0 | 0 | 1 | 0 | 0 | 1 | 1 | 0 | Network failure | +| 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | PDN type IPv4 only allowed | +| 0 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | PDN type IPv6 only allowed | +| 0 | 0 | 1 | 1 | 0 | 1 | 1 | 0 | PDN connection does not exist | +| 0 | 1 | 1 | 0 | 1 | 1 | 1 | 1 | Protocol error, unspecified | +| 0 | 1 | 1 | 1 | 0 | 0 | 0 | 1 | Multiple accesses to a PDN connection not allowed | + +All other values received by the UE are treated as 01101111, "Protocol error, unspecified". + +## 8.1.4.10.2 Causes + +### Cause #8 - Operator determined barring + +This cause is used by the network to indicate that the requested service was rejected due to operator determined barring. + +### Cause #26 - Insufficient resources + +This cause is used by the network to indicate that the requested service cannot be provided due to insufficient resources. + +### Cause #27 - Unknown APN + +This cause is used by the network to indicate that the requested service was rejected because the access point name could not be resolved. + +### Cause #28 - Unknown PDN type + +This cause is used by the network to indicate that the requested service was rejected by the external packet data network because the PDN type could not be recognised. + +### Cause #29 - User authentication failed + +This cause is used by the network to indicate that the requested service was rejected by the external packet data network due to a failed user authentication. + +### Cause #30 - Request rejected by PDN GW + +This cause is used by the network to indicate that the requested service or operation was rejected by the PDN GW. + +### Cause #31 - Request rejected, unspecified + +This cause is used by the network to indicate that the requested service or operation was rejected due to unspecified reasons. + +**Cause #32 - Service option not supported** + +This cause is used by the network when the UE requests a service which is not supported by the PLMN. + +**Cause #33 - Requested service option not subscribed** + +This cause is sent when the UE requests a service option for which it has no subscription. + +**Cause #34 - Service option temporarily out of order** + +This cause is sent when the network cannot service the request because of temporary outage of one or more functions required for supporting the service. + +**Cause #38 - Network failure** + +This cause is used by the network to indicate that the requested service was rejected due to an error situation in the network. + +**Cause #50 - PDN type IPv4 only allowed** + +This value is used by the network to indicate that only PDN type IPv4 is allowed for the requested PDN connectivity. + +**Cause #51 - PDN type IPv6 only allowed** + +This value is used by the network to indicate that only PDN type IPv6 is allowed for the requested PDN connectivity. + +**Cause #54 – PDN connection does not exist** + +This value is used by the network at handover from a 3GPP access network to indicate that the network does not have any information about the requested PDN connection. + +**Cause #111 - Protocol error, unspecified** + +This value is used to report a protocol error event only when no other value applies. + +**Cause #113 - Multiple accesses to a PDN connection not allowed** + +This value is used by the network to indicate that an additional access to the PDN connection as specified in 3GPP TS 24.161 [69] is not allowed. + +This subclause shows the numbers in the decimal numeration system. + +#### **8.1.4.11 IPV4\_ADDRESS item** + +When the Type field of this item according to subclause 8.1.4.2 indicates the IPV4\_ADDRESS, then the Length field of this item is set to 4 and the Value field of this item contains an IPv4 address allocated to the UE for the PDN connection. + +#### **8.1.4.12 IPV6\_INTERFACE\_IDENTIFIER item** + +When the Type field of this item according to subclause 8.1.4.2 indicates the IPV6\_INTERFACE\_IDENTIFIER, then the Length field of this item is set to 8 and the Value field of this item contains an IPv6 interface identifier allocated to the UE for the PDN connection to be used to build the IPv6 link local address. + +#### **8.1.4.13 TWAG\_CP\_ADDRESS item** + +When the Type field of this item according to subclause 8.1.4.2 indicates the TWAG\_CP\_ADDRESS, then the Value field of this item contains one or two TWAG control plane addresses and is coded according to figure 8.1.4.13-1 and table 8.1.4.13-1. + +![](eabcb2f8b9acedb194571d5bc734b463_img.jpg) + +| | | | +|-------------------------------|--|--------------------| +| 7   6   5   4   3   2   1   0 | | | +| TWAG CP address type | | octet 1 | +| TWAG CP addresses | | octet 2
octet Z | + +Figure 8.1.4.13-1: TWAG\_CP\_ADDRESS item value + +Table 8.1.4.13-1: TWAG\_CP\_ADDRESS item value + +The TWAG CP address type field (octet 1) is coded as follows. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---|---|---|---|---|---|---|---|----------| +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | IPv4 | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | IPv6 | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | IPv4IPv6 | + +All other values of the TWAG CP address type field are interpreted as "IPv4". + +If the TWAG CP address type field indicates IPv4, then the TWAG CP addresses field contains one TWAG control plane address consisting of an IPv4 address in octet 2 to octet 5. + +If the TWAG CP address type field indicates IPv6, then the TWAG CP addresses field contains one TWAG control plane address consisting of an IPv6 address in octet 2 to octet 17. + +If the TWAG CP address type field indicates IPv4IPv6, then the TWAG CP addresses field contains two TWAG control plane addresses. The first TWAG control plane address consists of an IPv4 address in octet 2 to octet 5, the second TWAG control plane address consists of an IPv6 address in octet 6 to octet 21. + +#### 8.1.4.14 TWAG\_UP\_MAC\_ADDRESS item + +When the Type field of this item according to subclause 8.1.4.2 indicates the TWAG\_UP\_MAC\_ADDRESS, then the Length field of this item is set to 6 and the Value field of this item contains a TWAG user plane MAC address allocated to the PDN connection. The MAC address is defined in subclause 8 of IEEE Std 802 [58]. + +#### 8.1.4.15 SUPPORTED\_WLCP\_TRANSPORTS item + +When the Type field of this item according to subclause 8.1.4.2 indicates the SUPPORTED\_WLCP\_TRANSPORTS, then the Length field of this item is set to 1 and the Value field of this item is coded according to figure 8.1.4.15-1 and table 8.1.4.15-1. + +![](ab34425e5238083d55091d3abe8452c2_img.jpg) + +| | | | | | | | | | +|-------------------------------|------------|------------|------------|------------|------------|-----------------------|-----------------------|---------| +| 7   6   5   4   3   2   1   0 | | | | | | | | | +| 0
Spare | 0
Spare | 0
Spare | 0
Spare | 0
Spare | 0
Spare | WLCP
oUDPo
IPv6 | WLCP
oUDPo
IPv4 | octet 1 | + +Figure 8.1.4.15-1: SUPPORTED\_WLCP\_TRANSPORTS value + +**Table 8.1.4.15-1: SUPPORTED\_WLCP\_TRANSPORTS value** + +The Supported WLCP transport value is coded as follows: + +WLCP over UDP over IPv4 support (WLCPoUDPoIPv4) (octet 1, bit 0) + +0 WLCP over UDP over IPv4 is not supported. + +1 WLCP over UDP over IPv4 is supported. + +WLCP over UDP over IPv6 support (WLCPoUDPoIPv6) (octet 1, bit 1) + +0 WLCP over UDP over IPv6 is not supported. + +1 WLCP over UDP over IPv6 is supported. + +Bit 2 to bit 7 of octet 1 are spare. + +## 8.1.4.16 Tw1 item + +When the Type field of this item according to subclause 8.1.4.2 indicates the Tw1, then the Value field of this item is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the GPRS timer 3 information element defined in 3GPP TS 24.008 [46] subclause 10.5.7.4a. + +NOTE: The GPRS Timer 3 IEI field and the length of GPRS Timer 3 contents field of the GPRS timer 3 information element are not included in the Value field of the Tw1 item. + +## 8.1.4.17 ACCESS\_CAUSE item + +### 8.1.4.17.1 General + +When the Type field of this item according to subclause 8.1.4.2 indicates the ACCESS\_CAUSE, then the Length field of this item is set to 1 and the Value field of this item is coded according to table 8.1.4.17-1. + +**Table 8.1.4.17-1: ACCESS\_CAUSE value** + +The Access cause value is coded as follows. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---|---|---|---|---|---|---|---|------------------------------------| +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | Non-3GPP access to EPC not allowed | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | RAT type now allowed | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | Illegal ME | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | PLMN not allowed | + +### 8.1.4.17.2 Access causes + +Access cause #2- Non-3GPP access to EPC not allowed + +This cause is used by the network to indicate that the requested service was rejected due to the user subscription data does not support EPS services from non-3GPP access. + +Access cause #3- RAT type not allowed + +This cause is used by the network to indicate that the requested service was rejected due to the WLAN is not allowed. + +Access cause #6- Illegal ME + +This cause is sent to the UE if the ME used is not acceptable to the network, e.g. blacklisted. + +Access cause #11- PLMN not allowed + +This cause is used by the network to indicate that the requested service was rejected due to the PLMN where the UE is roaming into is not allowed. + +## 8.2 IETF RFC coding information defined within present document + +### 8.2.1 IPMS attributes + +#### 8.2.1.1 AT\_IPMS\_IND attribute + +![](d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg) + +| | | | +|-------------------------------|--|--------------------| +| 7   6   5   4   3   2   1   0 | | | +| Attribute Type = AT_IPMS_IND | | octet 1 | +| Length = 1 | | octet 2 | +| Value | | octet 3
octet 4 | + +**Figure 8.2.1.1: AT\_IPMS\_IND attribute** + +**Table 8.2.1.1: AT\_IPMS\_IND attribute** + +Octet 1 indicates the type of attribute as AT\_IPMS\_IND with a value of 137. + +Octet 2 is the length of this attribute which shall be set to 1 as per IETF RFC 4187 [33] + +Octet 3 and 4 is the value of this attribute. Octet 3 is reserved and shall be coded as zero. Octet 4 shall be set as follows. All other values are reserved. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---|---|---|---|---|---|---|---|-----------------------------------------------------| +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | Protocol Supported | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | DSMIPv6 only | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | NBM only | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | MIPv4 only | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | DSMIPv6 and NBM both supported | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | MIPv4 and NBM both supported | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | DSMIPv6 and NBM Supported;DSMIPv6 preferred | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | DSMIPv6 and NBM Supported; NBM preferred | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | MIPv4 and NBM supported; MIPv4 preferred | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | MIPv4 and NBM supported; NBM preferred | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | MIPv4 and DSMIPv6 supported; MIPv4 preferred | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | MIPv4 and DSMIPv6 supported; DSMIPv6 preferred | +| 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | MIPv4, DSMIPv6 and NBM supported; MIPv4 preferred | +| 0 | 0 | 0 | 0 | 1 | 1 | 0 | 1 | MIPv4, DSMIPv6 and NBM supported; DSMIPv6 preferred | +| 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | MIPv4, DSMIPv6 and NBM supported; NBM preferred | + +#### 8.2.1.2 AT\_IPMS\_RES attribute + +![](fe4f9338148fd891afbd3e301f9bad33_img.jpg) + +| | | | +|-------------------------------|--|--------------------| +| 7   6   5   4   3   2   1   0 | | | +| Attribute Type = AT_IPMS_RES | | octet 1 | +| Length = 1 | | octet 2 | +| Value | | octet 3
octet 4 | + +**Figure 8.2.1.2: AT\_IPMS\_RES attribute.** + +**Table 8.2.1.2: AT\_IPMS\_RES attribute** + +| | | | | | | | | | +|-----------------------------------------------------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|-------------------| +| Octet 1 indicates the type of attribute as AT_IPMS_RES with a value of 138. | | | | | | | | | +| Octet 2 is the length of this attribute which shall be set to 1 as per IETF RFC 4187 [33] | | | | | | | | | +| Octet 3 and 4 is the value of this attribute. Octet 3 is reserved and shall be coded as zero. | | | | | | | | | +| Octet 4 shall be set as follows. All other values are reserved. | | | | | | | | | +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Protocol Selected | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | DSMIPv6 | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | NBM | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | MIPv4 | + +## 8.2.2 Access Network Identity indication attribute + +### 8.2.2.1 Access Network Identity in the AT\_KDF\_INPUT attribute + +The Access Network Identity is indicated in the Network Name Field of the AT\_KDF\_INPUT attribute as specified in IETF RFC 5448 [38]. The Network Name Field shall contain the Access Network Identity as specified in subclause 8.1.1 of this specification. + +NOTE: IETF in IETF RFC 5448 [38] refers to this specification for the value of the Network Name field. + +## 8.2.3 Trust relationship indication attribute + +### 8.2.3.1 AT\_TRUST\_IND attribute + +![](db6adf216c948c2b545e513aba13a16a_img.jpg) + +| | | +|-------------------------------|--------------------| +| 7   6   5   4   3   2   1   0 | | +| Attribute Type = AT_TRUST_IND | octet 1 | +| Length = 1 | octet 2 | +| Value | octet 3
octet 4 | + +**Figure 8.2.3.1-1: AT\_TRUST\_IND attribute****Table 8.2.3.1-1: AT\_TRUST\_IND attribute** + +| | | | | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|------------------------------| +| Octet 1 indicates the type of attribute as AT_TRUST_IND with a value of 139. | | | | | | | | | +| Octet 2 is the length of this attribute which shall be set to 1 as per IETF RFC 4187 [33] | | | | | | | | | +| Octet 3 and 4 is the value of the attribute. Octet 3 is reserved and shall be coded as zero. Octet 4 shall be set as follows. All other values are reserved. | | | | | | | | | +| | | | | | | | | | +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Indicated Trust Relationship | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | Trusted | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | UnTrusted | + +## 8.2.4 IKEv2 Configuration Payloads attributes + +### 8.2.4.1 HOME\_AGENT\_ADDRESS attribute + +The HOME\_AGENT\_ADDRESS attribute is shown in figure 8.2.4.1-1. The length of the HOME\_AGENT\_ADDRESS attribute is 16 or 20 bytes. The IPv4 Home Agent Address field is optional. The HA's IPv6 and IPv4 addresses are laid + +out respectively in IPv6 Home Agent Address and IPv4 Home Agent Address fields in big endian order (aka most significant byte first, or network byte order), see IETF RFC 7296 [28]. + +![](a4e9abbc6ca82471f1a223d0a68cd45e_img.jpg) + +| Bits | | | | | | | | Octets | +|-------------------------|----------------|---|---|---|---|---|---|---------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| R | Attribute Type | | | | | | | 1 | +| Attribute Type | | | | | | | | 2 | +| Length | | | | | | | | 3, 4 | +| IPv6 Home Agent Address | | | | | | | | 5 - 20 | +| IPv4 Home Agent Address | | | | | | | | 21 - 24 | + +**Figure 8.2.4.1-1: HOME\_AGENT\_ADDRESS attribute** + +The R bit in the first octet is defined in IETF RFC 7296 [28]. + +The Attribute Type indicating HOME\_AGENT\_ADDRESS is of the value 19. + +## 8.2.4.2 TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute + +The TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute is coded according to figure 8.2.4.2-1 and table 8.2.4.2-1. + +![](3e88de626facff0ce44cb3cb12c40d29_img.jpg) + +| Bits | | | | | | | | Octets | +|----------------|----------------|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| R | Attribute Type | | | | | | | 1 | +| Attribute Type | | | | | | | | 2 | +| Length | | | | | | | | 3, 4 | +| Timeout Period | | | | | | | | 5 - 8 | + +**Figure 8.2.4.2-1: TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute** + +**Table 8.2.4.2-1: TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK value** + +Bit 7 of Octet 1 is the R bit defined in IETF RFC 7296 [28]. The R bit is the reserved bit set to zero. + +Bits 0 through 6 of Octet 1 and Octet 2 is the Attribute Type field. The Attribute Type field is set to value 24 to indicate the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK. + +Octet 3 and Octet 4 is the Length field. This field indicates the length in octets of the Timeout Period field. This field is set to 0 or 4. + +Octets 5, 6, 7 and 8 are the Timeout Period field. If the Timeout Period field is included, it indicates the timeout period for liveness check in seconds encoded in the binary format. If the Timeout Period field is not included in the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK configuration attribute by the UE, the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK indicates the UE's support of receiving the timeout period for liveness check. + +## 8.2.5 Full name for network and short name for network + +### 8.2.5.1 AT\_FULL\_NAME\_FOR\_NETWORK attribute + +The AT\_FULL\_NAME\_FOR\_NETWORK attribute is coded according to figure 8.2.5.1-1 and table 8.2.5.1-1. + +![](9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|-------------------------------------------|---|---|---|---|---|---|---|----------------------| +| Attribute Type = AT_FULL_NAME_FOR_NETWORK | | | | | | | | octet 1 | +| Length | | | | | | | | octet 2 | +| Full name length | | | | | | | | octet 3 | +| Full name value | | | | | | | | octet 4
octet n | +| Padding | | | | | | | | octet n+1
octet m | + +Figure 8.2.5.1-1: AT\_FULL\_NAME\_FOR\_NETWORK attribute + +Table 8.2.5.1-1: AT\_FULL\_NAME\_FOR\_NETWORK attribute + +Octet 1 indicates the type of this attribute as AT\_FULL\_NAME\_FOR\_NETWORK with a value of 141. + +Octet 2 is the length of this attribute in multiples of 4 octets as specified in RFC 4187 [33]. + +Octet 3 is the full name length field and contains the length of the full name value field in octets. + +The full name value field starts at octet 4 and its length is indicated by the full name length field. The full name value field indicates the "full length name of the network" that the network wishes the UE to associate with MCC and MNC in the realm of the NAI used during authentication. The structure of the full name value field is the same as the structure of the Network Name defined in 3GPP TS 24.008 [46] subclause 10.5.3.5a except for the Network Name IEI and the Length of Network Name contents which are not included. + +The optional padding field starts after the last octet of the full name value field. Each octet of this field is set to zero by sending entity and ignored by receiving entity. + +## 8.2.5.2 AT\_SHORT\_NAME\_FOR\_NETWORK attribute + +The AT\_SHORT\_NAME\_FOR\_NETWORK attribute is coded according to figure 8.2.5.2-1 and table 8.2.5.2-1. + +![](b822771c1a5790feaeecfc439e08bcdd_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|--------------------------------------------|---|---|---|---|---|---|---|----------------------| +| Attribute Type = AT_SHORT_NAME_FOR_NETWORK | | | | | | | | octet 1 | +| Length | | | | | | | | octet 2 | +| Short name length | | | | | | | | octet 3 | +| Short name value | | | | | | | | octet 4
octet n | +| Padding | | | | | | | | octet n+1
octet m | + +Figure 8.2.5.2-1: AT\_SHORT\_NAME\_FOR\_NETWORK attribute + +**Table 8.2.5.2-1: AT\_SHORT\_NAME\_FOR\_NETWORK attribute** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 indicates the type of this attribute as AT_SHORT_NAME_FOR_NETWORK with a value of 140. | +| Octet 2 is the length of this attribute in multiples of 4 octets as specified in RFC 4187 [33]. | +| Octet 3 is the short name length field and contains the length of the short name value field in octets. | +| The short name value field starts at octet 4 and its length is indicated by the short name length field. The short name value field indicates the "abbreviated name of the network" that the network wishes the UE to associate with MCC and MNC in the realm of the NAI used during authentication. The structure of the short name value field is the same as the structure of the Network Name defined in 3GPP TS 24.008 [46] subclause 10.5.3.5a except for the Network Name IEI and the Length of Network Name contents which are not included. | +| The optional padding field starts after the last octet of the short name value field. Each octet of this field is set to zero by sending entity and ignored by receiving entity. | + +## 8.2.6 Handling of the unknown protocol data + +If the receiving entity receives an unknown value in a recognized skippable attribute in an EAP-AKA or EAP-AKA' message, the receiving entity shall ignore the attribute and shall handle the rest of the message. The definition of skippable attribute see the RFC 4187 [33]. The receiving entity handling of the unrecognized skippable attribute is as specified in RFC 4187 [33]. + +## 8.2.7 Attributes for TWAN connection modes + +### 8.2.7.1 AT\_TWAN\_CONN\_MODE attribute + +The AT\_TWAN\_CONN\_MODE attribute is coded according to figure 8.2.7.1-1 and table 8.2.7.1-1. + +![](2914642fbfe4ae35924bdf4beb189c1f_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|------------------------------------|---|---|---|---|---|---|---|----------------------| +| Attribute type = AT_TWAN_CONN_MODE | | | | | | | | octet 1 | +| Length | | | | | | | | octet 2 | +| Padding length | | | | | | | | octet 3 | +| Message | | | | | | | | octet 4
octet Y | +| Padding | | | | | | | | octet Y+1
octet Z | + +**Figure 8.2.7.1-1: AT\_TWAN\_CONN\_MODE attribute****Table 8.2.7.1-1: AT\_TWAN\_CONN\_MODE attribute** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 indicates the type of attribute as AT_TWAN_CONN_MODE with a value of 144. This attribute is skippable. | +| Octet 2 is the length of this attribute in multiples of 4 octets as specified in RFC 4187 [33]. | +| Padding length field contains the length of the padding field. | +| Message field is coded according to subclause 8.1.4.1. The length of the message field is determined from the length field and the padding length field. | +| Each octet of the padding field is set to zero by sending entity and ignored by receiving entity. | + +## 8.2.8 Device Identity + +### 8.2.8.1 AT\_DEVICE\_IDENTITY attribute + +The AT\_DEVICE\_IDENTITY attribute is coded according to figure 8.2.8.1-1 and table 8.2.8.1-1. + +![](f99313b06c15e9882079b773ce50a7b2_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|-------------------------------------|---|---|---|---|---|---|---|----------------------| +| Attribute type = AT_DEVICE_IDENTITY | | | | | | | | octet 1 | +| Length | | | | | | | | octet 2 | +| Identity Type | | | | | | | | octet 3 | +| Identity Length | | | | | | | | octet 4 | +| Identity Value | | | | | | | | octet 5
octet n | +| Padding | | | | | | | | octet n+1
octet m | + +Figure 8.2.8.1-1: AT\_DEVICE\_IDENTITY attribute + +Table 8.2.8.1-1: AT\_DEVICE\_IDENTITY attribute + +Octet 1 indicates the type of attribute as AT\_DEVICE\_IDENTITY with a value of xxx. This attribute is skippable. + +Octet 2 is the length of this attribute in multiples of 4 octets as specified in RFC 4187 [33]. + +Octet 3 indicates the type of Device Identity. + +| Identity Type (octet 3) | | | | | | | | | +|-------------------------|---|---|---|---|---|---|---|----------| +| Bits | | | | | | | | | +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | Reserved | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | IMEI | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | IMEISV | + +All other values are reserved. + +Octet 4 is Identity length field and contains the length of the Identity value in octets. + +The Identity Value field starts at octet 5 and its length is indicated by the Identity length field. The Identity value field represents the device identity digits of the corresponding Identity type and is coded using BCD coding. The Identity Value field is optional. + +For Identity Type 'IMEI' and 'IMEISV', Identity value digits are coded based on the IMEI and IMEISV structure defined in 3GPP TS 23.003 [3]. IMEI is 15 BCD digits and IMEISV is 16 BCD digits. Both IMEI and IMEISV are TBCD encoded. Bits 5 to 8 of octet i+4 (where i represents the octet of the IMEI(SV) being encoded) encodes digit 2i, bits 1 to 4 of octet i+4 encodes digit 2i-1 (i.e the order of digits is swapped in each octet compared to the digit order defined in 3GPP TS 23.003 [2]). Digits are packed contiguously with no internal padding. For IMEI, bits 5 to 8 of the last octet shall be filled with an end mark coded as '1111'. + +The optional padding field starts after the last octet of the Identity value field. Each octet of this field is set to zero by sending entity and ignored by receiving entity. + +## 8.2.9 IKEv2 Notify payloads + +### 8.2.9.1 BACKOFF\_TIMER Notify payload + +The BACKOFF\_TIMER Notify payload is used to indicate the value of the backoff timer. The BACKOFF\_TIMER Notify payload type is 41041 (see subclause 8.1.2.3). The length of the BACKOFF\_TIMER Notify payload is 6 octets. + +The BACKOFF\_TIMER Notify payload is coded according to figure 8.2.9.1-1 and table 8.2.9.1-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | +| Length=1 | | | | | | | | 5 | +| Backoff Timer Value | | | | | | | | 6 | + +Figure 8.2.9.1-1: BACKOFF\_TIMER Notify payload format + +Table 8.2.9.1-1: BACKOFF\_TIMER Notify payload value + +Octet 1 is defined in IETF RFC 7296 [28] + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41041 to indicate the Backoff Timer. + +Octet 5 is the Length field. This field indicates the length in octets of the Backoff Timer Value field. This field is set to 1. + +Octet 6 is the Backoff Timer Value field. This field indicates the value of Backoff Timer. It is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the GPRS timer 3 information element defined in 3GPP TS 24.008 [46] subclause 10.5.7.4a (Note 1). + +NOTE 1: The GPRS Timer 3 IEI field and the length of GPRS Timer 3 contents field of the GPRS timer 3 information element are not included in the value of the Backoff Timer. + +## 8.2.9.2 DEVICE\_IDENTITY Notify payload + +The DEVICE\_IDENTITY Notify payload is used to indicate the device identity. The DEVICE\_IDENTITY Notify payload type is 41101 (see subclause 8.1.2.3). + +The DEVICE\_IDENTITY Notify payload is coded according to figure 8.2.2.9-1 and table 8.2.2.9-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | +| Length | | | | | | | | 5-6 | +| Identity Type | | | | | | | | 7 | +| Identity Value | | | | | | | | 8-n | + +Figure 8.2.9.2-1: DEVICE\_IDENTITY Notify payload format + +**Table 8.2.9.2-1: DEVICE\_IDENTITY Notify payload value** + +Octet 1 is defined in IETF RFC 7296 [28] + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41101 to indicate the DEVICE\_IDENTITY. + +Octet 5 and Octet 6 is the Length field. This field indicates the combined length in octets of the Identity Type and Identity Value fields. + +Octet 7 is the Identity Type field. This field indicates the type of the device identity. + +| Identity Type (octet 7) | | | | | | | | | +|-------------------------|---|---|---|---|---|---|---|----------| +| Bits | | | | | | | | | +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | Reserved | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | IMEI | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | IMEISV | + +All other values are reserved. + +Octet 8-n is the Identity Value field indicating the value of the device identity. The Identity value field represents the device identity digits of the corresponding Identity type and is coded using BCD coding. The Identity Value field is optional. + +For Identity Type 'IMEI' and 'IMEISV', Identity value digits are coded based on the IMEI and IMEISV structure defined in 3GPP TS 23.003 [3]. IMEI is 15 BCD digits and IMEISV is 16 BCD digits. Both IMEI and IMEISV are TBCD encoded. Bits 5 to 8 of octet $i+5$ (where $i$ represents the octet of the IMEI(SV) being encoded) encodes digit $2i$ , bits 1 to 4 of octet $i+5$ encodes digit $2i-1$ (i.e the order of digits is swapped in each octet compared to the digit order defined in 3GPP TS 23.003 [2]). Digits are packed contiguously with no internal padding. For IMEI, bits 5 to 8 of the last octet shall be filled with an end mark coded as '1111'. + +### 8.2.9.3 NBIFOM\_GENERIC\_CONTAINER Notify payload + +The NBIFOM\_GENERIC\_CONTAINER Notify payload is used to contain the NBIFOM parameters. + +The NBIFOM\_GENERIC\_CONTAINER Notify payload is coded according to figure 8.2.9.3-1 and table 8.2.9.3-1. + +| Bits | | | | | | | | Octets | +|---------------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 - 6 | +| NBIFOM container contents | | | | | | | | 7 - x | + +**Figure 8.2.9.3-1: NBIFOM\_GENERIC\_CONTAINER Notify payload** + +**Table 8.2.9.3-1: NBIFOM\_GENERIC\_CONTAINER Notify payload** + +Octet 1 is defined in IETF RFC 7296 [28]. + +Octet 2 is the SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41288 to indicate the NBIFOM\_GENERIC\_CONTAINER. + +Octet 5 and octet 6 is the Length field. The Length field indicates the length in octets of the NBIFOM container contents field. + +Octet 7 to octet x is the NBIFOM container contents field containing the NBIFOM parameter list as defined in 3GPP TS 24.161 [69], subclause 6.1. + +#### 8.2.9.4 P-CSCF\_RESELECTION\_SUPPORT Notify payload + +The P-CSCF\_RESELECTION\_SUPPORT Notify payload is used to indicate the support by the UE of the P-CSCF restoration extension for untrusted WLAN. + +The P-CSCF\_RESELECTION\_SUPPORT Notify payload is coded according to figure 8.2.9.4-1 and table 8.2.9.4-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | + +**Figure 8.2.9.4-1: P-CSCF\_RESELECTION\_SUPPORT Notify Payload format** + +**Table 8.2.9.4-1: P-CSCF\_RESELECTION\_SUPPORT Notify Payload field values** + +Octet 1 is defined in IETF RFC 7296 [28]. + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41304 to indicate the P-CSCF\_RESELECTION\_SUPPORT (see subclause 8.1.2.3). + +#### 8.2.9.5 PTI Notify payload + +The PTI Notify payload is used to indicate that an INFORMATIONAL request message of an ePDG-initiated modification procedure is initiated by another INFORMATIONAL request message of a UE-initiated modification procedure. + +The PTI Notify payload is coded according to figure 8.2.9.5-1 and table 8.2.9.5-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 - 6 | +| Related Message ID | | | | | | | | 7 - 10 | + +**Figure 8.2.9.5-1: PTI Notify payload** + +**Table 8.2.9.5-1: PTI Notify payload** + +Octet 1 is defined in IETF RFC 7296 [28]. + +Octet 2 is the SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41501 (see subclause 8.1.2.3) to indicate the PTI. + +Octet 5 and octet 6 is the Length field. The Length field is set to 4. + +Octet 7 to octet 10 is the Related Message ID field containing the Message ID field of the INFORMATIONAL request message of the UE-initiated modification procedure which initiated the ePDG-initiated modification procedure. + +### 8.2.9.6 REACTIVATION\_REQUESTED\_CAUSE Notify payload + +The REACTIVATION\_REQUESTED\_CAUSE Notify payload is used to indicate the UE to re-establish the IPSec tunnel for the corresponding PDN connection after its release. + +The REACTIVATION\_REQUESTED\_CAUSE Notify payload is coded according to figure 8.2.9.6-1 and table 8.2.9.6-1. + +![](4bb56f4af58f9d5daab52d98c984d8d5_img.jpg) + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | + +**Figure 8.2.9.6-1: REACTIVATION\_REQUESTED\_CAUSE Notify payload format****Table 8.2.9.6-1: REACTIVATION\_REQUESTED\_CAUSE Notify payload field values** + +Octet 1 is defined in IETF RFC 7296 [28]. + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 40961 to indicate the REACTIVATION\_REQUESTED\_CAUSE (see subclause 8.1.2.3). + +### 8.2.9.7 EMERGENCY\_SUPPORT Notify payload + +The EMERGENCY\_SUPPORT Notify payload is used to indicate the ePDG support of emergency service. + +The EMERGENCY\_SUPPORT Notify payload is coded according to figure 8.2.9.7-1 and table 8.2.9.7-1. + +![](8d6b56ea28d70ce527efde127103e045_img.jpg) + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | + +**Figure 8.2.9.7-1: EMERGENCY\_SUPPORT Notify Payload format** + +**Table 8.2.9.7-1: EMERGENCY\_SUPPORT Notify Payload field value** + +Octet 1 is defined in IETF RFC 7296 [28] + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41112 to indicate the EMERGENCY\_SUPPORT (see subclause 8.1.2.3). + +## 8.2.9.8 EMERGENCY\_CALL\_NUMBERS Notify payload + +The EMERGENCY\_CALL\_NUMBERS Notify payload is used: + +- a) by the ePDG to provide local emergency call numbers for use within the country indicated by the MCC information; and +- b) by the UE to indicate support of retrieval of local emergency call numbers via IKEv2 procedures. + +The EMERGENCY\_CALL\_NUMBERS Notify payload is coded according to figure 8.2.9.8-1 and table 8.2.9.8-1 with a minimum length of 4 octets and a maximum length of 55 octets. + +| Bits | | | | | | | | Octets | +|-------------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| MCC information | | | | | | | | 5 | +| | | | | | | | | 6 | +| Length | | | | | | | | 7 | +| Local emergency numbers | | | | | | | | 8 - x | + +**Figure 8.2.9.8-1: EMERGENCY\_CALL\_NUMBERS Notify payload****Table 8.2.9.8-1: EMERGENCY\_CALL\_NUMBERS Notify payload** + +Octet 1 is defined in IETF RFC 7296 [28]. + +Octet 2 is the SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 41134 to indicate the EMERGENCY\_CALL\_NUMBERS. + +Octet 5 to octet 6 contains the MCC information of the country for which the emergency numbers indicated in the local emergency numbers field are applicable. If the EMERGENCY\_CALL\_NUMBERS Notify payload is included in the IKE\_AUTH response message, then the MCC information field shall be populated. + +Octet 7 is the Length field. The Length field indicates the length in octets of the Local emergency numbers field. + +Octet 8 to octet x is the Local emergency numbers field containing the emergency call numbers is in the same format as the Emergency Number List defined in subclause 10.5.3.13 of 3GPP TS 24.008 [46], starting with octet 3. The MCC information field, length field and Local emergency numbers field are omitted when the UE sends the EMERGENCY\_CALL\_NUMBERS Notify payload to the network to indicate support of retrieval of local emergency call numbers. + +The format of the MCC information item is shown in figure 8.2.9.8-2. Table 8.2.9.8-2 shows the coding of the MCC in the MCC information item. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|-------------|---|---|---|-------------|---|---|---|---| +| MCC digit 2 | | | | MCC digit 1 | | | | 5 | +| reserved | | | | MCC digit 3 | | | | 6 | + +Figure 8.2.9.8-2: *MCC information item*Table 8.2.9.8-2: *MCC information item* + +**MCC**, Mobile country code (octet 5, octet 6 bits 1 to 4) + The MCC field is coded as in ITU-T Rec. E212 [63], Annex A. + Bits 5 to 8 of 6 shall be coded as "1111". Mobile equipment shall ignore bits 5 to 8 of octet 6. + +### 8.2.9.9 IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify payload + +The IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify payload is used to indicate UE's support of the IKEv2 multiple bearer PDN connectivity. + +The IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify payload is coded according to figure 8.2.9.9-1 and table 8.2.9.9-1. + +| Bits | | | | | | | | | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Octets | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | + +Figure 8.2.9.9-1: IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify Payload format + +Table 8.2.9.9-1: IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY Notify Payload field value + +Octet 1 is defined in IETF RFC 7296 [28] + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42011 to indicate the IKEV2\_MULTIPLE\_BEARER\_PDN\_CONNECTIVITY (see subclause 8.1.2.3). + +### 8.2.9.10 EPS\_QOS Notify payload + +The EPS\_QOS Notify payload is used to indicate EPS QoS. + +The EPS\_QOS Notify payload is coded according to figure 8.2.9.10-1 and table 8.2.9.10-1. + +| Bits | | | | | | | | | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Octets | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| EPS QoS Value | | | | | | | | 6 - x | + +Figure 8.2.9.10-1: EPS\_QOS Notify payload format + +**Table 8.2.9.10-1: EPS\_QOS Notify payload value** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28] | +| Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. | +| Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42014 to indicate the EPS_QOS (see subclause 8.1.2.3). | +| Octet 5 is the Length field. This field indicates the length in octets of the EPS QoS Value field. | +| Octets 6 and later are the EPS QoS Value field. This field indicates the EPS QoS. It is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the EPS quality of service information element defined in 3GPP TS 24.301 [10] subclause 9.9.4.3 (Note 1). | +| NOTE 1: The EPS quality of service IEI field and the Length of EPS quality of service contents field of the EPS quality of service information element are not included in the value of the EPS QoS Value field. | + +## 8.2.9.10A EXTENDED\_EPS\_QOS Notify payload + +The EXTENDED\_EPS\_QOS Notify payload is used to indicate the extended EPS QoS. + +The EXTENDED\_EPS\_QOS Notify payload is coded according to figure 8.2.9.10A-1 and table 8.2.9.10A-1. + +| Bits | | | | | | | | Octets | +|------------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| Extended EPS QoS Value | | | | | | | | 6 - x | + +**Figure 8.2.9.10A-1: EXTENDED\_EPS\_QOS Notify payload format****Table 8.2.9.10A-1: EXTENDED\_EPS\_QOS Notify payload value** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28] | +| Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. | +| Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42015 to indicate the EXTENDED_EPS_QOS (see subclause 8.1.2.3). | +| Octet 5 is the Length field. This field indicates the length in octets of the Extended EPS QoS Value field. | +| Octets 6 and later are the Extended EPS QoS Value field. This field indicates the extended EPS QoS. It is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the extended quality of service information element defined in 3GPP TS 24.301 [10] subclause 9.9.4.30 (Note 1). | +| NOTE 1: The Extended quality of service IEI field and the Length of extended quality of service contents field of the extended quality of service information element are not included in the value of the Extended EPS QoS Value field. | + +## 8.2.9.11 TFT Notify payload + +The TFT Notify payload is used to indicate TFT. + +The TFT Notify payload is coded according to figure 8.2.9.11-1 and table 8.2.9.11-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| TFT Value | | | | | | | | 6 - x | + +Figure 8.2.9.11-1: TFT Notify payload format + +Table 8.2.9.11-1: TFT Notify payload value + +Octet 1 is defined in IETF RFC 7296 [28] + +Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42017 to indicate the TFT (see subclause 8.1.2.3). + +Octet 5 is the Length field. This field indicates the length in octets of the TFT Value field. + +Octets 6 and later are the TFT Value field. This field indicates the TFT. It is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the traffic flow template information element defined in 3GPP TS 24.00 [46] subclause 10.5.6.12 (Note 1). + +NOTE 1: The Traffic flow template IEI field and the Length of traffic flow template IE field of the traffic flow template information element are not included in the value of the TFT Value field. + +## 8.2.9.12 MODIFIED\_BEARER Notify payload + +The MODIFIED\_BEARER Notify payload is used to indicate ePDG's ESP SPI of the modified child SA. + +The MODIFIED\_BEARER Notify payload is coded according to figure 8.2.9.12-1 and table 8.2.9.12-1. + +| Bits | | | | | | | | Octets | +|--------------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Security Parameter Index | | | | | | | | 5 - 8 | + +Figure 8.2.9.12-1: MODIFIED\_BEARER Notify payload format + +**Table 8.2.9.12-1: MODIFIED\_BEARER Notify payload value** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28] and is set to 3 to indicate ESP. | +| Octet 2 is SPI Size field. It is set to 4 and there is one Security Parameter Index field. | +| Octet 3 to Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42020 to indicate the MODIFIED_BEARER (see subclause 8.1.2.3). | +| Octet 5 to Octet 8 is the Security Parameter Index field. The Security Parameter Index field contains the ePDG's ESP SPI of the modified child SA. | + +### 8.2.9.13 APN\_AMBR Notify payload + +The APN\_AMBR Notify payload is used to indicate the APN-AMBR. + +The APN\_AMBR Notify payload is coded according to figure 8.2.9.13-1 and table 8.2.9.13-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| APN AMBR Value | | | | | | | | 6 - x | + +**Figure 8.2.9.13-1: APN\_AMBR Notify payload format****Table 8.2.9.13-1: APN\_AMBR Notify payload value** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28] | +| Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. | +| Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42094 to indicate the APN_AMBR (see subclause 8.1.2.3). | +| Octet 5 is the Length field. This field indicates the length in octets of the APN AMBR Value field. | +| Octets 6 and later are the APN AMBR Value field. This field indicates the APN-AMBR. It is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the APN aggregate maximum bit rate information element defined in 3GPP TS 24.301 [10] subclause 9.9.4.2 (Note 1). | +| NOTE 1: The APN aggregate maximum bit rate IEI field and the Length of APN aggregate maximum bit rate contents field of the APN aggregate maximum bit rate information element are not included in the value of the APN AMBR Value field. | + +### 8.2.9.14 EXTENDED\_APN\_AMBR Notify payload + +The EXTENDED\_APN\_AMBR Notify payload is used to indicate the extended APN-AMBR. + +The EXTENDED\_APN\_AMBR Notify payload is coded according to figure 8.2.9.14-1 and table 8.2.9.14-1. + +| Bits | | | | | | | | Octets | +|-------------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| Extended APN AMBR Value | | | | | | | | 6 - x | + +**Figure 8.2.9.14-1: EXTENDED\_APN\_AMBR Notify payload format** + +**Table 8.2.9.14-1: EXTENDED\_APN\_AMBR Notify payload value** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28] | +| Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. | +| Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 42095 to indicate the EXTENDED_APN_AMBR (see subclause 8.1.2.3). | +| Octet 5 is the Length field. This field indicates the length in octets of the Extended APN AMBR Value field. | +| Octets 6 and later are the Extended APN AMBR Value field. This field indicates the extended APN-AMBR. It is coded as the value part (as specified in 3GPP TS 24.007 [48] for type 4 IE) of the extended APN aggregate maximum bit rate information element defined in 3GPP TS 24.301 [10] subclause 9.9.4.29 (Note 1). | +| NOTE 1: The Extended APN aggregate maximum bit rate IEI field and the Length of extended APN aggregate maximum bit rate contents of the extended APN aggregate maximum bit rate are not included in the value of the Extended APN AMBR Value field. | + +## 8.2.9.15 N1\_MODE\_CAPABILITY Notify payload + +The N1\_MODE\_CAPABILITY Notify payload is used to indicate support of N1 mode and to indicate the PDU session ID allocated to the PDU session associated with the IKEv2 security association being established by the IKEv2 message carrying the N1\_MODE\_CAPABILITY Notify payload. + +The N1\_MODE\_CAPABILITY Notify payload is coded according to figure 8.2.9.15-1 and table 8.2.9.15-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| PDU Session ID | | | | | | | | 6 | + +**Figure 8.2.9.15-1: N1\_MODE\_CAPABILITY Notify payload format** + +**Table 8.2.9.15-1: N1\_MODE\_CAPABILITY Notify payload value** + +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28]. | +| Octet 2 is SPI Size field. It is set to 0 and there is no Security Parameter Index field. | +| Octet 3 and Octet 4 is the Notify Message Type field. The Notify Message Type field is set to value 51015 to indicate the N1_MODE_CAPABILITY (see subclause 8.1.2.3). | +| Octet 5 is the Length field. This field indicates the length in octets of the PDU Session ID field. | +| Octets 6 is the PDU Session ID field. This field indicates the PDU session ID. It is coded as the PDU session identity information element defined in 3GPP TS 24.007 [48] subclause 11.2.3.1b. | + +## 8.2.9.16 N1\_MODE\_INFORMATION Notify payload + +The N1\_MODE\_INFORMATION Notify payload is used to indicate the S-NSSAI for the PDU session associated with the IKEv2 security association established by the IKEv2 message carrying the N1\_MODE\_INFORMATION Notify payload. + +The N1\_MODE\_INFORMATION Notify payload is coded according to figure 8.2.9.16-1 and table 8.2.9.16-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| S-NSSAI Value | | | | | | | | 6 – x | + +**Figure 8.2.9.16-1: N1\_MODE\_INFORMATION Notify payload format****Table 8.2.9.16-1: N1\_MODE\_INFORMATION Notify payload value** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Octet 1 is defined in IETF RFC 7296 [28]. | +| Octet 2 is the SPI Size field. It is set to 0 and there is no Security Parameter Index field. | +| Octet 3 and Octet 4 are the Notify Message Type field. The Notify Message Type field is set to value 51115 to indicate the N1_MODE_INFORMATION (see subclause 8.1.2.3). | +| Octet 5 is the Length field. This field indicates the length in octets of the S-NSSAI Value field. | +| Octets 6 and later are the S-NSSAI Value field. This field indicates the S-NSSAI value. It is coded as the value part of the S-NSSAI information element defined in 3GPP TS 24.501 [76] subclause 9.11.2.8. | + +## 8.2.9.17 N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload + +The N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload is used to indicate the PLMN ID that the S-NSSAI relates to for the PDU session associated with the IKEv2 security association established by the IKEv2 message carrying the N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload. + +The N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload is coded according to figure 8.2.9.17-1 and table 8.2.9.17-1. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3 - 4 | +| Length | | | | | | | | 5 | +| S-NSSAI PLMN ID | | | | | | | | 6 - 8 | + +Figure 8.2.9.17-1: N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload format + +Table 8.2.9.17-1: N1\_MODE\_S\_NSSAI\_PLMN\_ID Notify payload value + +Octet 1 is defined in IETF RFC 7296 [28]. + +Octet 2 is the SPI Size field. It is set to 0 and there is no Security Parameter Index field. + +Octet 3 and Octet 4 are the Notify Message Type field. The Notify Message Type field is set to value 52216 to indicate the N1\_MODE\_S\_NSSAI\_PLMN\_ID (see subclause 8.1.2.3). + +Octet 5 is the Length field. This field indicates the length in octets of the S-NSSAI PLMN ID field. + +Octets 6, 7 and 8 are the S-NSSAI PLMN ID field. This field indicates the PLMN ID that the S-NSSAI relates to. It is coded as the value part of the PLMN identity of the CN operator information element defined in 3GPP TS 24.008 [46] subclause 10.5.5.36. + +## 8.2.10 EAP-3GPP-LimitedService method + +### 8.2.10.1 General + +The messages of EAP-3GPP-LimitedService method are EAP requests and EAP responses as specified in IETF RFC 3748 [29] subclause 4.1 and use coding of the expanded method type as described in IETF RFC 3748 [29] subclause 5.7. + +The sending entity shall set value of a spare bit to zero. The receiving entity shall ignore value of a spare bit. + +### 8.2.10.2 Message format + +#### 8.2.10.2.1 EAP-Request/3GPP-LimitedService-Init-Info message + +EAP-Request/3GPP-LimitedService-Init-Info message is coded as specified in figure 8.2.10.2.1-1 and table 8.2.10.2.1-1. + +| Bits | | | | | | | | Octets | +|---------------------------|---|---|---|---|---|---|---|---------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Code | | | | | | | | 1 | +| Identifier | | | | | | | | 2 | +| Length | | | | | | | | 3 - 4 | +| Type | | | | | | | | 5 | +| Vendor-Id | | | | | | | | 6 - 8 | +| Vendor-Type | | | | | | | | 9 - 12 | +| Message-Id | | | | | | | | 13 | +| Spare | | | | | | | | 14 | +| EAP-AKA attributes length | | | | | | | | 15 - 16 | +| EAP-AKA attributes | | | | | | | | 17 - n | +| Extensions | | | | | | | | n+1 - m | + +Figure 8.2.10.2.1-1: EAP-Request/3GPP-LimitedService-Init-Info message + +**Table 8.2.10.2.1-1: EAP-Request/3GPP-LimitedService-Init-Info message** + +Code field is set to 1 (decimal) as specified in IETF RFC 3748 [29] subclause 4.1 and indicates request. + +Identifier field is set as specified in IETF RFC 3748 [29] subclause 4.1. + +Length field is set as specified in IETF RFC 3748 [29] subclause 4.1 and indicates the length of the EAP-Request/3GPP-LimitedService-Init-Info message in octets. + +Type field is set to 254 (decimal) as specified in IETF RFC 3748 [29] subclause 5.7 and indicates the expanded type. + +Vendor-Id field is set to the 3GPP Vendor-Id of 10415 (decimal) registered with IANA under the SMI Private Enterprise Code registry. + +Vendor-Type field is set to EAP-3GPP-LimitedService method identifier of 2 (decimal) as specified in 3GPP TS 33.402 [15] annex C. + +Message-Id field is set to 3GPP-LimitedService-Init-Info-Id of 1 (decimal). + +Spare field consists of spare bits. + +EAP-AKA attributes length field indicates the length of EAP-AKA attributes field in octets. + +EAP-AKA attributes field contains attributes as specified in IETF RFC 4187 [33]. + +Extensions field is an optional field and consists of spare bits. + +## 8.2.10.2.2 EAP-Response/3GPP-LimitedService-Init-Info message + +EAP-Response/3GPP-LimitedService-Init-Info message is coded as specified in figure 8.2.10.2.2-1 and table 8.2.10.2.2-1. + +| Bits | | | | | | | | Octets | +|---------------------------|---|---|---|---|---|---|---|---------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Code | | | | | | | | 1 | +| Identifier | | | | | | | | 2 | +| Length | | | | | | | | 3 - 4 | +| Type | | | | | | | | 5 | +| Vendor-Id | | | | | | | | 6 - 8 | +| Vendor-Type | | | | | | | | 9 - 12 | +| Message-Id | | | | | | | | 13 | +| Spare | | | | | | | | 14 | +| EAP-AKA attributes length | | | | | | | | 15 - 16 | +| EAP-AKA attributes | | | | | | | | 17 - n | +| Extensions | | | | | | | | n+1 - m | + +**Figure 8.2.10.2.2-1: EAP-Response/3GPP-LimitedService-Init-Info message** + +**Table 8.2.10.2.2-1: EAP-Response/3GPP-LimitedService-Init-Info message** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Code field is set to 2 (decimal) as specified in IETF RFC 3748 [29] subclause 4.1 and indicates response. | +| Identifier field is set as specified in IETF RFC 3748 [29] subclause 4.1. | +| Length field is set as specified in IETF RFC 3748 [29] subclause 4.1 and indicates the length of the EAP-Response/3GPP-LimitedService-Init-Info message in octets. | +| Type field is set to 254 (decimal) as specified in IETF RFC 3748 [29] subclause 5.7 and indicates the expanded type. | +| Vendor-Id field is set to the 3GPP Vendor-Id of 10415 (decimal) registered with IANA under the SMI Private Enterprise Code registry. | +| Vendor-Type field is set to EAP-3GPP-LimitedService method identifier of 2 (decimal) as specified in 3GPP TS 33.402 [15] annex C. | +| Message-Id field is set to 3GPP-LimitedService-Init-Info-Id of 1 (decimal). | +| Spare field consists of spare bits. | +| EAP-AKA attributes length field indicates the length of EAP-AKA attributes field in octets. | +| EAP-AKA attributes field contains attributes as specified in IETF RFC 4187 [33]. | +| Extensions field is an optional field and consists of spare bits. | + +### 8.2.10.2.3 EAP-Request/3GPP-LimitedService-Notif message + +EAP-Request/3GPP-LimitedService-Notif message is coded as specified in figure 8.2.10.2.3-1 and table 8.2.10.2.3-1. + +| Bits | | | | | | | | Octets | +|---------------------------|---|---|---|---|---|---|---|---------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Code | | | | | | | | 1 | +| Identifier | | | | | | | | 2 | +| Length | | | | | | | | 3 - 4 | +| Type | | | | | | | | 5 | +| Vendor-Id | | | | | | | | 6 - 8 | +| Vendor-Type | | | | | | | | 9 - 12 | +| Message-Id | | | | | | | | 13 | +| Spare | | | | | | | | 14 | +| EAP-AKA attributes length | | | | | | | | 15 - 16 | +| EAP-AKA attributes | | | | | | | | 17 - n | +| Extensions | | | | | | | | n+1 - m | + +**Figure 8.2.10.2.3-1: EAP-Request/3GPP-LimitedService-Notif message** + +**Table 8.2.10.2.3-1: EAP-Request/3GPP-LimitedService-Notif message** + +Code field is set to 1 (decimal) as specified in IETF RFC 3748 [29] subclause 4.1 and indicates request. + +Identifier field is set as specified in IETF RFC 3748 [29] subclause 4.1. + +Length field is set as specified in IETF RFC 3748 [29] subclause 4.1 and indicates the length of the EAP-Request/3GPP-LimitedService-Notif message in octets. + +Type field is set to 254 (decimal) as specified in IETF RFC 3748 [29] subclause 5.7 and indicates the expanded type. + +Vendor-Id field is set to the 3GPP Vendor-Id of 10415 (decimal) registered with IANA under the SMI Private Enterprise Code registry. + +Vendor-Type field is set to EAP-3GPP-LimitedService method identifier of 2 (decimal) as specified in 3GPP TS 33.402 [15] annex C. + +Message-Id field is set to 3GPP-LimitedService-Notif-Id of 2 (decimal). + +Spare field consists of spare bits. + +EAP-AKA attribute length field indicates the length of EAP-AKA attributes field in octets. + +EAP-AKA attributes field contains attributes as specified in IETF RFC 4187 [33]. + +Extensions field is an optional field and consists of spare bits. + +#### 8.2.10.2.4 EAP-Response/3GPP-LimitedService-Notif message + +EAP-Response/3GPP-LimitedService-Notif message is coded as specified in figure 8.2.10.2.4-1 and table 8.2.10.2.4-1. + +| Bits | | | | | | | | Octets | +|-------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Code | | | | | | | | 1 | +| Identifier | | | | | | | | 2 | +| Length | | | | | | | | 3 - 4 | +| Type | | | | | | | | 5 | +| Vendor-Id | | | | | | | | 6 - 8 | +| Vendor-Type | | | | | | | | 9 - 12 | +| Message-Id | | | | | | | | 13 | +| Extensions | | | | | | | | 14 -m | + +**Figure 8.2.10.2.4-1: EAP-Response/3GPP-LimitedService-Notif message** + +**Table 8.2.10.2.4-1: EAP-Response/3GPP-LimitedService-Notif message** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

Code field is set to 2 (decimal) as specified in IETF RFC 3748 [29] subclause 4.1 and indicates response.

Identifier field is set as specified in IETF RFC 3748 [29] subclause 4.1.

Length field is set as specified in IETF RFC 3748 [29] subclause 4.1 and indicates the length of the EAP-Response/3GPP-LimitedService-Notif message message in octets.

Type field is set to 254 (decimal) as specified in IETF RFC 3748 [29] subclause 5.7 and indicates the expanded type.

Vendor-Id field is set to the 3GPP Vendor-Id of 10415 (decimal) registered with IANA under the SMI Private Enterprise Code registry.

Vendor-Type field is set to EAP-3GPP-LimitedService method identifier of 2 (decimal) as specified in 3GPP TS 33.402 [15] annex C.

Message-Id field is set to 3GPP-LimitedService-Notif-Id of 2 (decimal).

Extensions field is an optional field and consists of spare bits.

| +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +--- + +## Annex A (informative): Example signalling flows for inter-system change between 3GPP and non-3GPP systems using ANDSF + +### A.1 Scope of signalling flows + +This annex gives examples of signalling flows for mobility between 3GPP and non-3GPP systems. These signalling flows provide as example detailed information on Network Discovery and Selection aspects involving the use of ANDSF. + +--- + +### A.2 Signalling flow for inter-system change between 3GPP access network and non-3GPP access network + +Figure A1 below shows an inter-system change procedure between 3GPP access network and non-3GPP access network using information obtained from ANDSF. + +In this example the UE uses DHCP query to obtain the IP address of the ANDSF. + +In this example flow, the communication between the UE and ANDSF does not imply use of any specific protocol. + +The steps involved in inter-system change between 3GPP access network and non-3GPP access network are as follows. + +![Sequence diagram for inter-system change between 3GPP and non-3GPP access using ANDSF. Lifelines: UE, 3GPP Access, Non-3GPP Access, ANDSF. A double-headed arrow is shown between UE and 3GPP Access.](d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg) + +``` + +sequenceDiagram + participant UE + participant 3GPP Access + participant Non-3GPP Access + participant ANDSF + UE<->3GPP Access: + +``` + +The diagram illustrates the initial connectivity phase of an inter-system change procedure. It features four lifelines: UE (User Equipment), 3GPP Access, Non-3GPP Access, and ANDSF (Access Network Discovery and Selection Function). A horizontal double-headed arrow is drawn between the UE and the 3GPP Access lifelines, indicating an established bidirectional connection. The other two lifelines, Non-3GPP Access and ANDSF, are present but have no messages or connections shown in this initial step. + +Sequence diagram for inter-system change between 3GPP and non-3GPP access using ANDSF. Lifelines: UE, 3GPP Access, Non-3GPP Access, ANDSF. A double-headed arrow is shown between UE and 3GPP Access. + +**Figure A1. Procedure for Inter-system change between 3GPP access and non-3GPP using ANDSF** + +**1. Initial connectivity** + +The UE is connected to 3GPP network. The current applications are supported over the 3GPP access network. + +NOTE: The procedure remains the same if the UE is initially connected to non-3GPP access network and wants to change to 3GPP access network. + +## 2. Pre-provisioned policies + +The inter-system mobility policy is pre-provisioned on the UE. Based on pre-provisioned operator policies the UE has preference for different non-3GPP networks such as WLAN, and WiMAX. The UE can select these access networks when they are available. + +## 3. ANDSF Discovery + +ANDSF discovery is performed as described in subclause 6.8.2.2.1. The UE can discover ANDSF using DHCP query options as specified in IETF RFC 6153 [37], where ANDSF may be identified with a specific sub-option code. Optionally, the home operator can use OMA-DM's bootstrap mechanism as specified in OMA-ERELD-DM-V1\_2 [39] to provide ANDSF information and security parameters for application layer authentication. Transport security is ensured by establishing an https tunnel between the UE and ANDSF, + +## 4. Policy Update based on Network Triggers + +Based on network triggers the ANDSF sends an updated inter-system mobility policy to the UE. The inter-system mobility policy includes validity conditions, i.e. conditions indicating when the policy is valid. Such conditions can include time duration, location area, etc. + +## 5. Evaluate which non-3GPP networks to discover + +The inter-system mobility policies specify the access networks that the UE can select; the UE has both WLAN and WiMAX radios. In this case, the inter-system mobility policy provided by the operator allows the UE to select either WLAN or WiMAX networks under all conditions. The UE, taking into account of the UE's local policy, e.g. user preference settings, access history, obtains information about availability of both WLAN and WiMAX access networks in its vicinity. + +## 6. Access Network Information Request + +The UE sends a request to ANDSF to get information about available access networks. The UE also includes its location information in the request. ANDSF can limit the information sent to UE based on internal settings. + +## 7. Access Network Information Response + +The ANDSF sends a response to the UE which includes the list of available access networks types (in order of operator preferences), access network identifier and PLMN identifier. In this case the ANDSF responds with availability of both WLAN and WiMAX network in the vicinity of the UE. + +## 8. Evaluate candidate non-3GPP networks + +Based on the received information and UE's local policy, the UE evaluates if it is within the coverage area of the available access networks in the order of preferences. In this case, based on the history and radio quality of WiMAX, the UE prefers WiMAX over WLAN access type. The UE powers on the WiMAX radio and checks for the presence of WiMAX network. The UE can listen to WiMAX broadcast messages (uplink/downlink channel data messages) and determines the presence of WiMAX network. Since the WiMAX network is the preferred network and since the UE has verified the presence of WiMAX network, the UE does not check for presence of WLAN network. + +## 9. Non-3GPP Network Selection + +The UE selects the most preferred available access network for inter-system mobility. In this case the UE selects the WiMAX access network. + +## 10. Inter-system change Procedure + +The UE initiates inter-system change procedure to the selected non-3GPP access network. The details of the inter-system change procedure are described elsewhere, see 3GPP TS 23.402 [6]. + +--- + +## Annex B (informative): Assignment of Access Network Identities in 3GPP + +This annex describes the recommended assignment procedure of Access Network Identities within 3GPP. + +--- + +### B.1 Access Network Identities + +According to 3GPP TS 23.003 [3] the encoding of the Access Network Identity is specified within 3GPP, but the Access Network Identity definition for each non-3GPP access network is under the responsibility of the corresponding standardisation organisation respectively. + +If a standardisation organisation for a non-3GPP access network determines they need to define a new Access Network Identity Prefix or additional ANID strings, they can contact the 3GPP TSG-CT WG 1 via a Liaison Statement and indicate the specific values of the Access Network Identity Prefixes or the specific values of, or construction principles for, the additional ANID strings to be specified by 3GPP and give reference to the corresponding specification(s) of the requesting organisation. 3GPP TSG CT WG 1 will then specify the values for the Access Network Identities by updating Table 8.1.1.2 in this specification and inform the requesting standardisation organisation. + +## Annex C (informative): Example usage of ANDSF + +### C.1 Scope of ANDSF Example + +This Annex gives an example of organization of ANDSF database and how it can be used to discover access network information. In this example the UE is in 3GPP network and is trying to discover available WiMAX networks. The ANDSF database is provided by the 3GPP operator with PLMN = PLMN\_3GPP. + +### C.2 Organization of ANDSF Coverage Map for WiMAX Network discovery + +Table C1 illustrates the organization of ANDSF database for discovering WiMAX and WiFi networks. The ANDSF database provides the coverage mapping information for WiMAX and WiFi networks based on 3GPP cell identifiers. In this example the UE\_Location can be specified either in terms of 3GPP parameters (PLMN + Cell Identifier) or in terms of geo spatial co-ordinates. + +**Table C1: ANDSF Database Organization for PLMN = PLMN\_3GPP** + +| UE_Location
- 3GPP (CellId)
- Other (Geopriv) | AccessType = WiMAX | AccessType = WiFi | +|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| Locn_1
Cell_Id = Cell_1 | NSP-ID= NSP_1:
-NAP_ID = NAP_1
-NAP_ID = NAP_2
NSP-ID = NSP_2
-NAP_ID = NAP_2
-NAP_ID = NAP_3 | SSID = WiFi1, BSSID = BS1
SSID = WiFi2, BSSID = BS2 | +| Locn_2
Cell_Id = Cell_2 | NSP-ID = NSP_2
- NAP_ID = NAP_3 | N/A | +| Locn_3
Cell_Id = Cell_3 | N/A | SSID = WiFi1, BSSID = BS3
SSID = WiFi4, BSSID = BS4 | +| ..... | ..... | ..... | +| Locn_n
Cell_Id = Cell_n | NSP-ID = NSP_1
NAP_ID = NAP_2 | SSID = WiFi6, BSSID = BS5 | + +For WiMAX network the database provides information about WiMAX NSP and NAP that provide coverage in respective 3GPP cells. Thus for example in 3GPP Cell\_1, WiMAX Service provider NSP\_1 provides service to WiMAX radio access providers NAP\_1 and NAP-2. Similarly WiMAX Service Provider NSP\_2 provides service to Network access providers NAP-2 and NAP\_3 as well. Similarly in 3GPP Cell\_2 WiMAX Network Service Provider NSP\_2 provides service to network Access Provider NAP\_3. Further it can be seen that no WiMAX coverage is available in 3GPP cell Cell\_3. + +### C.3 Parameters in Pull mode + +The UE is currently in 3GPP network. The UE sends a query to OMA ANDSF server as follows: + +ANDSF\_Query ( UE\_Location, AccessNetworkType=WiMAX ) + +The UE specifies the UE\_Location information in terms of current 3GPP Cell Id (e.g. Cell\_2) + +On receipt of the query message the ANDSF looks up the UE\_Location (Cell\_2) in the ANDSF database and searches for a prospective WiMAX entry. In this case the ANDSF retrieves WiMAX Service provider identifier (NSP-ID) NSP\_2 and WiMAX Network Access Provider Identifier (NAP-ID) NAP\_3. The ANDSF retrieves the network parameters for this combination. The ANDSF fills these parameters in the WNDS MO and sends the information back to the UE. + +ANDSF\_Response ( UE\_Location, AccessNetworkInformationRef MO=WIMAXNDS). + +--- + +## Annex D (informative): Mismatch of static configuration of mobility mechanism in the UE and in the network + +This annex describes the possible cases of mismatch between the statically configured mobility mechanisms in the UE and in the EPC as shown in table D.1. Additionally the table shows whether the UE would be able to access EPC services as a consequence of the mismatch. + +**Table D1: Mismatch of static configuration of mobility mechanism in the UE and in the network** + +| | NBM configured in the network | DSMIPv6 configured in the network | MIPv4 configured in the network | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NBM configured in the UE | No mismatch | Mismatch. The UE is not able to access EPC services because the UE configures a local IP address and there is no connectivity to the PGW in the EPC. Depending on operator's policy and roaming agreements, local IP access services (e.g. Internet access) can be provided in the non-3GPP network using the local IP address. However, such local IP access services, where the user traffic does not traverse the EPC, are not described in this specification. | Mismatch. The UE is not able to access EPC services because the UE does not support communication with the Foreign Agent in the trusted non-3GPP IP access network. | +| DSMIPv6 configured in the UE | Mismatch. The UE can be able to access EPC services. After attach to the non-3GPP network, the UE is on the home link and configures an IP address based on the HNP, however in some cases the UE cannot detect the home link. Since the UE is configured with DSMIPv6, the UE would initiate a DSMIPv6 bootstrapping:
- If the network offers a HA function to the UE and if the bootstrapping is successful, the UE detects that it is attached to the home link. Depending of the UE capabilities and the network configuration, the UE can access EPC via the S2a or S2b, but session continuity is not supported.
- If the network does not offer a HA function or if the bootstrapping to the HA is not successful, the UE is not able to receive its Home Network Prefix and hence the UE cannot detect that it is on the home link. If no APN bound to the configured IP address was received and the access network does not support APN delivery, the UE would not recognize the mismatch and cannot access EPC services. If the access network supports APN delivery and the configured IP address is bound to an APN, the UE can access EPC services. | No mismatch | Mismatch. The UE is not able to access EPC services because the UE does not support communication with the Foreign Agent in the trusted non-3GPP IP access network. | +| MIPv4 configured in the UE | Mismatch. The UE is not able to access EPC services because no Foreign Agent functionality is supported in the non-3GPP access network. | Mismatch. The UE is not able to access EPC services because no Foreign Agent functionality is supported in the non-3GPP access network. | No mismatch | + +--- + +## Annex E (informative): UE procedures based on preconfigured and received information + +The flow diagrams in figure E-1 and figure E-2 show examples of the procedures that the UE can follow in order to establish a PDN connection based on information available to the UE about the authentication method, received or pre-configured access network trust relationship information or received or preconfigured IP mobility mode selection information. + +The following symbols are used: + +| | | +|----------|----------------------------------------------------------------------------------------------------------------| +| AN_TRUST | trust relationship between the non-3GPP access network and the 3GPP EPC, considered to be applicable by the UE | +| IPMM | IP mobility mode, considered applicable by the UE | + +Initially, at the entry to flow chart the UE has established contact with the non-3GPP access network, but the UE does not know whether it is in a trusted or untrusted non-3GPP IP access access network. + +![Flowchart showing procedures for UE depending on received and preconfigured information - part 1. It starts with L2 attach and access authentication, then checks for EAP-AKA or KA execution, trust indicators, and preconfigured information for N_TRUST and IP mobility mode to determine the next steps for PDN connection setup.](884c44b6cb9fbe15347e0562a6085df2_img.jpg) + +``` +graph TD; Start["L2 attach (access specific), Access authentication (optional)"] --> WsExecuted{Ws EAP-AKA or KA executed?}; WsExecuted -- No --> NTRUSTPreconf{Preconfigured info for N_TRUST?}; WsExecuted -- Yes --> TrustIndReceived{Which _TRUST_IND received?}; TrustIndReceived -- "Not received at all" --> NTRUSTPreconf; TrustIndReceived -- Trusted --> ANTRUSTTrusted["AN_TRUST= TRUSTED"]; TrustIndReceived -- Untrusted --> NTRUSTPreconf; NTRUSTPreconf -- "No preconfiguration" --> NTRUSTPreconf; NTRUSTPreconf -- Trusted --> ANTRUSTTrusted; NTRUSTPreconf -- Untrusted --> ANTRUSTUntrusted["AN_TRUST= UNTRUSTED"]; ANTRUSTTrusted --> ANTRUSTTrustedBox["AN_TRUST= TRUSTED, Only DSMIPv6 can be used"]; ANTRUSTUntrusted --> ANTRUSTUntrustedBox["AN_TRUST= UNTRUSTED"]; ANTRUSTTrustedBox --> 2((2)); ANTRUSTUntrustedBox --> 1((1)); 1 --> DSIPv6Bootstrapping{DSMIPv6 bootstrapping performed?}; 2 --> DSIPv6Bootstrapping; DSIPv6Bootstrapping -- Yes --> CreateBinding["Create DSMIPv6 binding to HA (see S 24.303)"]; DSIPv6Bootstrapping -- No --> DSIPv6BootstrappingProc[DSMIPv6 bootstrapping]; DSIPv6BootstrappingProc --> CreateBinding; CreateBinding --> PDNCompleted([PDN connection setup completed]); ANTRUSTTrusted --> A_IPMS_RES{A_IPMS_RES Received?}; A_IPMS_RES -- No --> PreconfIPMobility{Preconfigured IP mobility mode available?}; A_IPMS_RES -- Yes --> IPMM{IPMM=?}; PreconfIPMobility -- No --> IPMM; PreconfIPMobility -- Yes --> IPMM; IPMM -- "DSMIPv6" --> CreateBinding; IPMM -- "MIPv4" --> MIPv4MM["MIPv4 MM registration (see S 24.304)"]; MIPv4MM --> PDNCompleted; IPMM -- "NBM" --> IPv6HNP["IPv6 HNP/ IPv4 HoA = as received via access specific signaling"]; IPv6HNP --> PDNCompleted; +``` + +Flowchart showing procedures for UE depending on received and preconfigured information - part 1. It starts with L2 attach and access authentication, then checks for EAP-AKA or KA execution, trust indicators, and preconfigured information for N\_TRUST and IP mobility mode to determine the next steps for PDN connection setup. + +Figure E-1. Procedures to be followed by the UE depending on received and preconfigured information - part 1 + +![Flowchart showing UE procedures for ePDG discovery and tunnel establishment. It starts with a connector '1', followed by 'ePDG discovery. Tunnel establishment to ePDG'. A decision 'AT_IPMS_RES Received?' follows. If 'Yes', it goes to connector '2'. If 'No', it checks 'Preconfigured IP mobility mode available?'. If 'Yes', it checks 'IPMM=DSMIPv6?'. If 'yes', it goes to connector '2'. If 'No', it proceeds to 'NBM used Pv6 HNP/ IPv4 HoA = IPv6/IPv4 address(es) in CFG_REPLY' and then to 'PDN connection set up completed'. If 'Preconfigured IP mobility mode available?' is 'No', it also proceeds to the NBM box.](b0384c8e0ff826a8116ab2ff67dadc43_img.jpg) + +``` +graph TD; 1((1)) --> A[ePDG discovery. +Tunnel establishment +to ePDG]; A --> B{AT_IPMS_RES +Received?}; B -- Yes --> 2((2)); B -- No --> C{Preconfigured +IP mobility mode +available?}; C -- Yes --> D{IPMM=DSMIPv6?}; C -- No --> E[NBM used +Pv6 HNP/ IPv4 HoA += IPv6/IPv4 +address(es) in +CFG_REPLY]; D -- yes --> 2; D -- No --> E; E --> F([PDN connection +set up completed]); +``` + +Flowchart showing UE procedures for ePDG discovery and tunnel establishment. It starts with a connector '1', followed by 'ePDG discovery. Tunnel establishment to ePDG'. A decision 'AT\_IPMS\_RES Received?' follows. If 'Yes', it goes to connector '2'. If 'No', it checks 'Preconfigured IP mobility mode available?'. If 'Yes', it checks 'IPMM=DSMIPv6?'. If 'yes', it goes to connector '2'. If 'No', it proceeds to 'NBM used Pv6 HNP/ IPv4 HoA = IPv6/IPv4 address(es) in CFG\_REPLY' and then to 'PDN connection set up completed'. If 'Preconfigured IP mobility mode available?' is 'No', it also proceeds to the NBM box. + +Figure E-2. Procedures to be followed by the UE depending on received and preconfigured information - part 2 + +--- + +## Annex F (Normative): Access to EPC via restrictive non-3GPP access network + +### F.1 General + +This annex specifies protocol for access to EPC via restrictive non-3GPP access network. + +The procedures are specified for UE and ePDG. The UE may support the procedures for access to EPC via restrictive non-3GPP access network. The ePDG may support the procedures for access to EPC via restrictive non-3GPP access network. + +--- + +### F.2 UE – EPC network protocols + +#### F.2.1 General + +In order to access to EPC via restrictive non-3GPP access network, the UE and the ePDG shall establish a firewall traversal tunnel (FTT) using the UE requested FTT establishment procedure according to subclause F.2.2. Once the FTT is established, the UE shall initiate establishment of an IPSec tunnel via an IKEv2 protocol exchange according to IETF RFC 7296 [28]. + +The UE and the ePDG shall construct the IKEv2 messages according to clause 7 and according to subclause F.2.3. + +The UE and the ePDG shall send the IKEv2 messages using the IKEv2 message transport procedure according to subclause F.2.2.3. + +The UE and the ePDG shall send the encapsulating security payloads using the encapsulating security payload transport procedure according to subclause F.2.2.4. + +If the UE has not sent a message over the FTT in the last FTT KAT seconds, the UE shall perform the UE requested keep-alive procedure according to subclause F.2.2.5. + +When all IKEv2 security associations are closed, the UE shall perform the UE requested FTT release procedure according to subclause F.2.2.6. + +When all IKEv2 security associations are closed, the network can perform the network requested FTT release procedure according to subclause F.2.2.7. + +#### F.2.2 FTT protocol + +##### F.2.2.1 General + +The FTT protocol consists of the UE requested FTT establishment procedure, the IKEv2 message transport procedure, the encapsulating security payload transport procedure, the UE requested keep-alive procedure, the UE requested FTT release procedure and the network requested FTT release procedure. + +##### F.2.2.2 UE requested FTT establishment procedure + +###### F.2.2.2.1 General + +The purpose of the UE requested FTT establishment procedure is to establish an FTT between the UE and the ePDG. + +###### F.2.2.2.2 UE requested FTT establishment procedure initiation + +If the UE is not configured with an HTTP proxy address, the UE shall follow the procedures in subclause F.2.2.2.3. + +If the UE is configured with an HTTP proxy address, the UE shall follow the procedures in subclause F.2.2.2.4. + +NOTE: UE configuration of an HTTP proxy address is out of scope of 3GPP. + +#### **F.2.2.2.3 UE requested FTT establishment procedure initiation via restrictive non-3GPP access network type I** + +In order to establish an FTT, the UE shall establish a TCP connection to the ePDG address and destination port 443. + +If the TCP connection establishment is successful, the UE shall establish a TLS connection over the TCP connection according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. If the ePDG address is a FQDN, the UE shall include a TLS extension of type "server\_name" in the TLS client hello message according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +The ePDG shall handle the TCP connection setup and shall handle the TLS connection establishment according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +#### **F.2.2.2.4 UE requested FTT establishment procedure initiation via restrictive non-3GPP access network type II** + +If the UE is configured with HTTP proxy address, in order to establish an FTT, the UE shall send HTTP CONNECT request to the HTTP proxy address according to IETF RFC 2817 [53]. The UE shall populate Request-URI of the HTTP CONNECT request with the ePDG address and port 443. + +Upon receiving HTTP 2xx response to HTTP CONNECT request, the UE shall establish TLS connection according to the TLS profile specified in 3GPP TS 33.310 [65] annex E over the TCP connection used for the HTTP CONNECT request transport. If the ePDG address is a FQDN, the UE shall include a TLS extension of type "server\_name" in the TLS client hello message according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +The ePDG shall handle the TCP connection setup and the TLS connection establishment according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +#### **F.2.2.2.5 UE requested FTT establishment procedure accepted by the network** + +When TLS Finished message is sent over the TCP connection according to the TLS profile specified in 3GPP TS 33.310 [65] annex E, the ePDG shall use the connection as the FTT. + +When valid TLS Finished message is received over the TCP connection, the UE shall use the connection as the FTT. + +### **F.2.2.3 IKEv2 message transport procedure** + +#### **F.2.2.3.1 General** + +The purpose of the IKEv2 message transport procedure is to transport an IKEv2 message over an FTT. + +#### **F.2.2.3.2 IKEv2 message transport procedure initiation** + +In order to send an IKEv2 message, the UE or the ePDG shall create an IKEv2 envelope as described in subclause F.3.2.2, shall populate the Non-ESP marker field with zero value and shall populate the IKEv2 message field of the IKEv2 envelope with the IKEv2 message. + +The UE shall send the IKEv2 envelope as TLS application data according to the TLS profile specified in 3GPP TS 33.310 [65] annex E: + +- if the IKEv2 message is an IKEv2 request, over an FTT of the UE; and +- if the IKEv2 message is an IKEv2 response of an IKEv2 request, over the FTT over which the IKEv2 request was received. + +The ePDG shall send the IKEv2 envelope as TLS application data according to the TLS profile specified in 3GPP TS 33.310 [65] annex E: + +- if the IKEv2 message is an IKEv2 request of an IKEv2 security association, over the FTT associated with the IKEv2 security association; and +- if the IKEv2 message is an IKEv2 response of an IKEv2 request, over the FTT over which the IKEv2 request was received. + +### F.2.2.3.3 IKEv2 message transport procedure accepted + +Upon receiving the IKEv2 envelope as TLS application data over the FTT, the ePDG or the UE shall extract the IKEv2 message from the IKEv2 envelope as described in subclause F.3.2.2 and shall handle it according to IETF RFC 7296 [28]. If the IKEv2 message is a validated IKEv2 packet, the ePDG shall associate the FTT with the IKEv2 security association of the validated packet (replacing any FTT previously associated with the IKEv2 security association). + +## F.2.2.4 Encapsulating security payload transport procedure + +### F.2.2.4.1 General + +The purpose of the encapsulating security payload transport procedure is to transport an encapsulating security payload over an FTT. + +### F.2.2.4.2 Encapsulating security payload transport initiation + +In order to send an encapsulating security payload, the UE or the ePDG shall create a ESP envelope as described in subclause F.3.2.3 and shall populate the ESP message field of the ESP envelope with the encapsulating security payload. + +The UE shall send the ESP envelope as TLS application data according to the TLS profile specified in 3GPP TS 33.310 [65] annex E over an FTT of the UE. + +The ePDG shall send the ESP envelope as TLS application data according to the TLS profile specified in 3GPP TS 33.310 [65] annex E over the FTT associated with the IKEv2 security association which established the child security association of the encapsulating security payload. + +### F.2.2.4.3 Encapsulating security payload transport accepted + +Upon receiving the ESP envelope over the FTT, the ePDG or the UE shall extract the encapsulating security payload from the ESP envelope as described in subclause F.3.2.3 and shall handle it according to IETF RFC 4303 [32]. + +## F.2.2.5 UE requested keep-alive procedure + +### F.2.2.5.1 General + +The purpose of the UE requested keep-alive procedure is to refresh binding in firewall (possibly including NAT) deployed between the restrictive non-3GPP access network and the EPC. + +### F.2.2.5.2 UE requested keep-alive procedure initiation + +In order to send a keep-alive, the UE shall create a keep-alive envelope as described in subclause F.3.2.4. + +The UE shall send the keep-alive envelope as TLS application data according to the TLS profile specified in 3GPP TS 33.310 [65] annex E over an FTT of the UE. + +### F.2.2.5.3 UE requested keep-alive procedure accepted by the network + +The ePDG shall discard any keep-alive envelope received over the FTT. + +## F.2.2.6 UE requested FTT release procedure + +### F.2.2.6.1 General + +The purpose of the UE requested FTT release procedure is to release an FTT when all IKEv2 security associations are closed. + +### F.2.2.6.2 UE requested FTT release procedure initiation + +In order to release the FTT, the UE shall send TLS close\_notify alert according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +### F.2.2.6.3 UE requested FTT release procedure accepted by the network + +The ePDG shall handle the TLS close\_notify alert according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +## F.2.2.7 Network requested FTT release procedure + +### F.2.2.7.1 General + +The purpose of the network requested FTT release procedure is to release an FTT when all IKEv2 security associations are closed. + +### F.2.2.7.2 Network requested FTT release procedure initiation + +In order to release the FTT, the ePDG shall send TLS close\_notify alert according to the TLS profile specified in 3GPP TS 33.310 [r33310] annex E. + +### F.2.2.7.3 Network requested FTT release procedure accepted by the UE + +The UE shall handle the TLS close\_notify alert according to the TLS profile specified in 3GPP TS 33.310 [65] annex E. + +## F.2.3 Additional IKEv2 procedures when FTT is used + +### F.2.3.1 FTT KAT negotiation during tunnel establishment + +The UE shall include the FTT\_KAT configuration attribute according to subclause F.3.3.1 in the IKEv2 CFG\_REQUEST configuration payload of the IKE\_AUTH request message sent via FTT. + +If the FTT\_KAT configuration attribute is included in the IKEv2 CFG\_REQUEST configuration payload, ePDG shall include the FTT\_KAT configuration attribute according to subclause F.3.3.1 in the IKEv2 CFG\_REPLY configuration payload. + +If the FTT\_KAT configuration attribute is not included in the IKEv2 CFG\_REPLY configuration payload, the UE shall determine the firewall traversal tunnel keep-alive time (FTT KAT) as a random number uniformly distributed between lower bound and higher bound. The default value for lower bound is 672 seconds and the default value for higher bound is 840 seconds. + +If the FTT\_KAT configuration attribute is included in the IKEv2 CFG\_REPLY configuration payload, the UE shall set the FTT KAT to the value of the Keep-alive time field of the FTT\_KAT configuration attribute. + +## F.3 PDUs and parameters specific to the present annex + +### F.3.1 Void + +### F.3.2 Message types of FTT messages + +#### F.3.2.1 Generic FTT envelope + +Generic FTT envelope is coded according to figure F.3.2.1-1 and table F.3.2.1-1. + +![](7497bf7f235b0bf4852cfd9ab9d01a43_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|---------|---|---|---|---|---|---|---|---------| +| Length | | | | | | | | octet 1 | +| | | | | | | | | octet 2 | +| Payload | | | | | | | | octet 3 | +| | | | | | | | | octet n | + +Figure F.3.2.1-1: Generic FTT envelope + +**Table F.3.2.1-1: Generic FTT envelope** + +Length field is in the octet 1 and the octet 2. The Length field indicates the length of the generic FTT envelope in octets. + +Payload field is in octets starting from octet 3 and its value depends on the message type. + +### F.3.2.2 IKEv2 envelope + +IKEv2 envelope is coded according to figure F.3.2.2-1 and table F.3.2.2-1. + +![](679c2ccc5b7f68983ae16ad7ba7308c3_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|----------------|---|---|---|---|---|---|---|--------------------| +| Length | | | | | | | | octet 1
octet 2 | +| Non-ESP marker | | | | | | | | octet 3
octet 6 | +| IKEv2 message | | | | | | | | octet 7
octet n | + +**Figure F.3.2.2-1: IKEv2 envelope****Table F.3.2.2-1: IKEv2 envelope** + +Length field is described in subclause F.3.2.1. The Length field value is bigger than 6. + +Non-ESP marker field is in the octet 3, the octet 4, the octet 5 and the octet 6. The Non-ESP marker field value is zero. + +IKEv2 message field is in octets starting from octet 7. The IKEv2 message contains the IKEv2 message as defined in IETF RFC 7296 [28], section 3.1 in format as for transmission from UDP port 500. + +### F.3.2.3 ESP envelope + +ESP envelope is coded according to figure F.3.2.3-1 and table F.3.2.3-1. + +![](e6b7c04e3244ab7b6161e0ec2edafd86_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|-------------|---|---|---|---|---|---|---|--------------------| +| Length | | | | | | | | octet 1
octet 2 | +| ESP message | | | | | | | | octet 3
octet n | + +**Figure F.3.2.3-1: ESP envelope****Table F.3.2.3-1: ESP envelope** + +Length field is described in subclause F.3.2.1. The Length field value is bigger than 6. + +ESP message field is in octets starting from octet 3. The ESP message contains the encapsulating security payload as defined in IETF RFC 4303 [32], section 2. The SPI field in the ESP header is not a zero value. + +### F.3.2.4 Keep-alive envelope + +Keep-alive envelope is coded according to figure F.3.2.4-1 and table F.3.2.4-1. + +![](85a44a4e566144c47c2289799051c0b1_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|--------------------|---|---|---|---|---|---|---|--------------------| +| Length | | | | | | | | octet 1
octet 2 | +| Keep-alive payload | | | | | | | | octet 3 | + +**Figure F.3.2.4-1: keep-alive envelope** + +**Table F.3.2.4-1: keep-alive envelope** + +Length field is described in subclause F.3.2.1. The Length field value is 3. + +Keep-alive payload field is in octet 3. The Keep-alive payload field value is 255. + +## F.3.3 IKEv2 configuration attributes + +### F.3.3.1 FTT\_KAT configuration attribute + +The FTT\_KAT configuration attribute is coded according to figure F.3.3.1-1 and table F.3.3.1-1. + +![](3295c6ffe9f6d00c3811c37d327ac844_img.jpg) + +| Bits | | | | | | | | Octets | +|-----------------|----------------|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| R | Attribute type | | | | | | | 1 | +| Attribute type | | | | | | | | 2 | +| Length | | | | | | | | 3 - 4 | +| Keep alive time | | | | | | | | 5 - 6 | + +**Figure F.3.3.1-1: FTT\_KAT configuration attribute****Table F.3.3.1-1: FTT\_KAT configuration attribute** + +R field is defined in IETF RFC 7296 [28]. + +Attribute type field has value 22. + +Length field is defined in IETF RFC 7296 [28]. + +When FTT\_KAT configuration attribute is included in the CFG\_REQUEST configuration payload of IKEv2 security association, packets of which are transported via FTT, the Keep-alive time field indicates preferred maximum time in seconds between two envelopes (any of those described in subclause F.3.2) sent via FTT. When FTT\_KAT configuration attribute is included in the CFG\_REPLY configuration payload of IKEv2 security association, packets of which are transported via FTT, the Keep-alive time field indicates actual maximum time in seconds between two envelopes (any of those described in subclause F.3.2) sent via FTT. + +--- + +## Annex G (Informative): IANA registrations + +### G.1 General + +This annex contains information needed for registrations with IANA. + +--- + +### G.2 EAP-AKA attributes + +#### G.2.1 General + +This subclause contains information needed for registrations of EAP-AKA attributes with IANA. + +#### G.2.2 AT\_TWAN\_CONN\_MODE EAP-AKA attribute + +In order to register the AT\_TWAN\_CONN\_MODE attribute, the following information will be inserted in form at : + +Contact name: + + + +Contact Email: + + + +What type of assignment/registration are you requesting? + +New item in the "Attribute Types (Skippable Attributes 128-255)" of the "EAP-AKA and EAP-SIM Parameters" as shown at and as specified in RFC 4187. + +Which registry are you requesting this assignment/registration be made in? + +The "Attribute Types (Skippable Attributes 128-255)" of the "EAP-AKA and EAP-SIM Parameters" as shown at and as specified in RFC 4187. + +If possible, please give a brief description of why you need this assignment/registration: + +Further information needs to be provided during authentication using EAP-AKA'. + +Additional Information. Please include a reference to the specification or RFC (if available) that defines this number or name space: + +RFC 4187 defines the registry for the "Attribute Types (Skippable Attributes 128-255)" of the "EAP-AKA and EAP-SIM Parameters". + +The following attribute is requested to be registered: + +- numbering space: EAP-AKA and EAP-SIM Parameters, Attribute Types (Skippable Attributes 128-255) +- attribute description: AT\_TWAN\_CONN\_MODE +- reference to specification where the attribute is described: +- attribute type: (number to be assigned by IANA) + +## G.2.3 AT\_DEVICE\_IDENTITY EAP-AKA attribute + +In order to register the AT\_DEVICE\_IDENTITY attribute, the following information will be inserted in form at : + +Contact name: + + + +Contact Email: + + + +What type of assignment/registration are you requesting? + +New item in the "Attribute Types (Skippable Attributes 128-255)" of the "EAP-AKA and EAP-SIM Parameters" as shown at and as specified in RFC 4187. + +Which registry are you requesting this assignment/registration be made in? + +The "Attribute Types (Skippable Attributes 128-255)" of the "EAP-AKA and EAP-SIM Parameters" as shown at and as specified in RFC 4187. + +If possible, please give a brief description of why you need this assignment/registration: + +Further information needs to be provided during authentication using EAP-AKA'. + +Additional Information. Please include a reference to the specification or RFC (if available) that defines this number or name space: + +RFC 4187 defines the registry for the "Attribute Types (Skippable Attributes 128-255)" of the "EAP-AKA and EAP-SIM Parameters". + +The following attribute is requested to be registered: + +- numbering space: EAP-AKA and EAP-SIM Parameters, Attribute Types (Skippable Attributes 128-255) +- attribute description: AT\_DEVICE\_IDENTITY +- reference to specification where the attribute is described: +- attribute type: (number to be assigned by IANA) + +--- + +## G.3 IKEv2 configuration attributes + +### G.3.1 General + +This subclause contains information needed for registrations of IKEv2 configuration attributes with IANA. + +### G.3.2 TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK attribute + +In order to register the TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK IKEv2 attribute, the following information will be inserted in form at : + +Contact name: + + + +Contact Email: + + + +What type of assignment/registration are you requesting? + +New item in the "IKEv2 Configuration Payload Attribute Types" of the "Internet Key Exchange Version 2 (IKEv2) Parameters" as shown at and as specified in IETF RFC 4306 [70A] and updated by IETF RFC 7296 [28] and IETF RFC 7296 [70B]. + +Which registry are you requesting this assignment/registration be made in? + +The "IKEv2 Configuration Payload Attribute Types" of the "Internet Key Exchange Version 2 (IKEv2) Parameters" as shown at and as specified in IETF RFC 4306 [70A] and updated by IETF RFC 7296 [28] and IETF RFC 7296 [70B]. + +If possible, please give a brief description of why you need this assignment/registration: + +This IKEv2 attribute is used to provide configuration for performing the liveness checks. + +Additional Information. Please include a reference to the specification or RFC (if available) that defines this number or name space: + +IETF RFC 4306 [70A] defines the registry for the "IKEv2 Configuration Payload Attribute Types". +IETF RFC 7296 [70B] and IETF RFC 7296 [28] refer to IETF RFC 4306 for the definition of the registry. + +The following attribute is requested to be registered: + +- value: (number to be assigned by IANA) +- attribute type: TIMEOUT\_PERIOD\_FOR\_LIVENESS\_CHECK +- multi-valued: no +- length: 4 octets +- reference: + +## Annex H (normative): Definition of generic container for ANQP payload + +### H.1 General + +This subclause describes the structure and contents of the generic container used as the payload in the 3GPP Cellular Network ANQP-element specified in IEEE Std 802.11 [57]. + +### H.2 General structure + +#### H.2.1 Structure + +The general structure of the generic container is shown in figure H.2.1-1. + +![](d74d2943c702ef88a5f9dec974fc92a5_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|----------------------------|---|---|---|---|---|---|---|------------| +| GUD | | | | | | | | octet 1 | +| UDHL | | | | | | | | octet 2 | +| IEI 1 | | | | | | | | octet 3 | +| Length of contents of IE 1 | | | | | | | | octet 4 | +| Contents of IE 1 | | | | | | | | | +| | | | | | | | | octet i | +| IEI 2 | | | | | | | | octet i+1* | +| Length of contents of IE 2 | | | | | | | | octet i+2 | +| Contents of IE 2 | | | | | | | | | +| | | | | | | | | octet l | +| | | | | | | | | octet l+1* | +| ..... | | | | | | | | | +| | | | | | | | | octet m | +| IEI q | | | | | | | | octet m+1* | +| Length of contents of IE q | | | | | | | | octet m+2 | +| Contents of IE q | | | | | | | | | +| | | | | | | | | octet n | + +Figure H.2.1-1 – Structure of IEEE Std 802.11 Generic Container + +#### H.2.2 Generic container User Data (GUD) + +Indicates the protocol version of the generic container + +00000000 Version 1 + +00000001 + +To + +11111111 Reserved + +## H.2.3 User Data Header Length (UDHL) + +Indicates the number of octets in the generic container after the UDHL. This indication is encoded in binary format. + +## H.2.4 Information Elements + +### H.2.4.1 Information Element Identity (IEI) + +Indicates the information element identity. The following values for IEI are defined in this version of the specification: + +00000000 PLMN List + +00000001 PLMN List with S2a connectivity + +00000010 PLMN List with trusted 5G connectivity + +00000011 PLMN List with trusted 5G connectivity-without-NAS + +000001002 + +To + +11111111 Reserved + +### H.2.4.2 PLMN List IE + +The PLMN List information element is used by the network to indicate the PLMNs that can be selected from the WLAN. The format of the PLMN List information element coded according to 3GPP TS 24.007 [48] subclause 11.2.2.1 is shown in figure H.2.4.2-1. + +![](76808556fd942668469e05483dc61e5b_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|------------------------------------|---|---|---|---|---|---|---|----------------------------------------| +| PLMN List IEI | | | | | | | | octet 1 | +| Length of PLMN List value contents | | | | | | | | octet 2 | +| Number of PLMNs | | | | | | | | octet 3 | +| PLMN information, PLMN 1 | | | | | | | | octet 4
octet 5
octet 6 | +| PLMN information, PLMN N | | | | | | | | octet 3N+1
octet 3N+2
octet 3N+3 | + +**Figure H.2.4.2-1: PLMN List information element** + +The "Number of PLMNs" (octet 3) contains the number of PLMN information items in the list. Bit 7 of octet 3 is the most significant bit and bit 0 of octet 3 the least significant bit. + +The format of the PLMN information item according to 3GPP TS 24.007 [48] subclause 11.2.2.1 is shown in figure H.2.4.2-2: + +![](d7eba809a7e0433a21291666f36a78e9_img.jpg) + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +|-------------|---|---|---|-------------|---|---|---|-----------| +| MCC digit 2 | | | | MCC digit 1 | | | | octet X | +| MNC digit 3 | | | | MCC digit 3 | | | | octet X+1 | +| MNC digit 2 | | | | MNC digit 1 | | | | octet X+2 | + +**Figure H.2.4.2-2: PLMN information item of the PLMN List IE** + +Table H.2.4.2-1 shows the coding of the MCC and MNC in the PLMN information item. + +**Table H.2.4.2-1: PLMN information item of PLMN List IE** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MCC , Mobile country code (octet X, octet X+1 bits 1 to 4)
The MCC field is coded as in ITU-T Rec. E212 [63], Annex A. | +| MNC , Mobile network code (octet X+2, octet X+1 bits 5 to 8).
The coding of this field is the responsibility of each administration but BCD coding shall be used. The MNC shall consist of 2 or 3 digits. For PCS 1900 for North America, Federal Regulation mandates that a 3-digit MNC shall be used. However a network operator may decide to use only two digits in the MNC over the radio interface. In this case, bits 5 to 8 of octet X+1 shall be coded as "1111". Mobile equipment shall accept MNC coded in such a way. | + +### H.2.4.3 PLMN List with S2a Connectivity IE + +The PLMN List with S2a connectivity information element is used by the WLAN to indicate the PLMNs to which the WLAN provides S2a connectivity. + +The format of the PLMN List with S2a Connectivity information element is identical to the format of the PLMN List information element defined in subclause H.2.4.2. + +### H.2.4.4 PLMN List with trusted 5G Connectivity IE + +The PLMN List with trusted 5G connectivity information element is used by the WLAN to indicate the PLMNs for which the WLAN provides connectivity to a 5GCN, using trusted non-3GPP access. + +The format of the PLMN List with trusted 5G connectivity information element is identical to the format of the PLMN List information element defined in subclause H.2.4.2. + +### H.2.4.5 PLMN List with trusted 5G Connectivity-without-NAS IE + +The PLMN List with trusted 5G connectivity-without-NAS information element is used by the WLAN to indicate the PLMNs for which the WLAN provides connectivity to a 5GCN, for devices without NAS capability, using trusted non-3GPP access. + +The format of the PLMN List with trusted 5G connectivity-without-NAS information element is identical to the format of the PLMN List information element defined in subclause H.2.4.2. + +## Annex I (normative): Definition of the Emergency Call Number field's contents + +### I.1 General + +The Emergency Call Number field is a variable-length UTF-8 (see RFC 3629 [34]) formatted field. The purpose of this field is to encode emergency call number(s) for use within the country where the field is received. + +This subclause describes the formatting of the Emergency Call Number Unit field used in the Emergency Call Number ANQP-element specified in IEEE Std 802.11 [57]. + +NOTE: According to IEEE Std 802.11 [57] an ANQP server is not necessarily collocated with an AP. Where the TWAN provides access to multiple PLMNs, where a PLMN has configured the TWAN to provide different emergency numbers compared to another PLMN, it is an implementation option to ensure the Emergency Call Number field includes the emergency numbers configured by the PLMN the UE successfully authenticated and authorized with. + +### I.2 Formatting + +#### I.2.1 General + +For the purposes of aiding in detection of emergency call number and assigning the emergency type, the Emergency Call Number Unit field can contain an emergency call number and one or more emergency call labels. + +The emergency call number and one or more emergency call labels shall be encoded as a namespace specific string for the namespace identifier equal to 3gpp (see RFC 5279 [74]). This specification further defines the namespace identifier equal to sos-anqp and parameters. + +For the purposes of aiding in determining of the country where these local emergency numbers were provided, the Emergency Call Number field contains the MCC. The MCC represents the country in which the AP is located. + +#### I.2.2 ABNF for the urn:3gpp:sos-anqp namespace and its parameters + +Table I.2.2-1 contains the ABNF (RFC 2234 [73]) for the urn:3gpp:sos-anqp namespace and its parameters. + +**Table I.2.2-1: Syntax of urn:3gpp:sos-anqp** + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 emergency-information = "urn:3gpp:sos-anqp:" mcc *(":" number 1*(":" label )) mcc                 = "mcc" DIGIT DIGIT (DIGIT)      ; exactly 2 or 3 digits label               = "sos" *("." sub-label) number            = DIGIT*DIGIT                      ; at least one DIGIT sub-label         = let-dig [ *let-dig-hyp let-dig ] let-dig-hyp     = let-dig / "-" let-dig         = ALPHA / DIGIT ALPHA           = %x41-5A / %x61-7A                  ; A-Z / a-z
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +NOTE: While the syntax of table I.2.2-1 allows for many different sub-labels following "sos", when originating an emergency IMS session (see TS 24.229 [67]) based on detecting a match with dialed digits, the SIP INVITE will only contain one of the following service URNs: "urn:service:sos", "urn:service:sos.police", "urn:service:sos.ambulance", "urn:service:sos.fire", "urn:service:sos.marine", "urn:service:sos.mountain". + +#### I.2.3 Semantics + +According to the ABNF in table I.2.2-1: + +- "urn:3gpp:sos-anqp:mcc310" is a valid expression: this expression indicates to the UE to overwrite any previously received list with Local WLAN emergency numbers with an empty list; + +- "urn:3gpp:sos-anqp:mcc222:112:sos.police:sos.ambulance" is a valid expression: this expression indicates to the UE to that in the country with MCC 222 the number 112 is an emergency number. The corresponding labels sos.police and sos.ambulance are mapped in accordance with annex I.2.4. + +## I.2.4 Mapping Emergency Call Number field's contents to the Local WLAN Emergency Numbers List + +When the Local WLAN Emergency Numbers List is to be encoded in the Local Emergency Numbers List format as defined in 3GPP TS 24.008 [46], subclause 10.5.3.13, the Emergency Call Number field's contents conforming to the ABNF for the urn:3gpp:sos-anqp namespace shall be mapped. The Local WLAN Emergency Numbers List for the PLMN with which the UE is connected via WLAN shall only be used when the contents are considered valid (see subclause 6.4.1). + +The contents of the Emergency Call Number Unit field map to 4 bit encoded number digits and 5 bit encoded Emergency Service Category Value as follows. In addition to the rules in 3GPP TS 24.008 [46], the following mapping shall apply for a URN with UTF-8 (see RFC 3629 [34]) digits in the mcc ABNF portion that match the MCC of the PLMN with which the UE is connected via WLAN : + +- 1) each UTF-8 digit in the emergency-number ABNF portion of the URN is converted into a corresponding 4-bit number digit of a set of octets part of an emergency number information; and +- 2) the label ABNF portion of the URN maps as follows: + - "sos": does not set bits of the 5 bit encoded Emergency Service Category Value of the emergency number information; + - "sos.police": sets bit 1 (police) of the 5 bit encoded Emergency Service Category Value of the emergency number information; + - "sos.ambulance": sets bit 2 (ambulance) of the 5 bit encoded Emergency Service Category Value of the emergency number information; + - "sos.fire": sets bit 3 (fire brigade) of the 5 bit encoded Emergency Service Category Value of the emergency number information; + - "sos.marine": sets bit 4 (marine guard) of the 5 bit encoded Emergency Service Category Value of the emergency number information; + - "sos.mountain": sets bit 5 (mountain rescue) of the 5 bit encoded Emergency Service Category Value of the emergency number information. + +--- + +## Annex J (normative): Emergency Call Numbers from DNS procedure + +### J.1 General + +This subclause describes the retrieval of the Emergency Call Numbers field using DNS procedures. + +The UE performs this procedure with a DNS server only, if the DNS server address is acquired from the ePDG using procedures in 3GPP TS 24.302 [156] subclause 7.2.2.1 and subclause 7.4.1, contained in the CFG\_REPLY Configuration payload, and after mutual authentication of the UE and the network. + +NOTE: The message carrying the emergency information is sent through the established IPsec tunnel to the 3GPP network. + +The related Country based Emergency Numbers FQDN is specified in 3GPP TS 23.003 [3]. + +--- + +### J.2 Retrieval of emergency call numbers + +When a UE is connected to WLAN access, the UE may support the DNS mechanisms specified in this Annex to retrieve emergency call numbers and service types for use within the country indicated by the MCC information. + +The UE shall construct an emergency number FQDN based on the Country based Emergency Numbers FQDN format as specified in 3GPP TS 23.003 [3] and then perform the DNS NAPTR query using the constructed emergency number FQDN as input. + +If the result of this query is: + +- a set of one or more records containing the replacement field of the form "..sos.en.epc.mcc.visited-country.pub.3gppnework.org", the UE shall consider the list of emergency-number(s) and type(s) as valid additional emergency call number(s) for the country indicated by the MCC information and store the emergency call number(s) and type(s) received; + +NOTE: Even though a label named "visited-country" is present in the replacement field, the UE can use the mechanism to obtain emergency numbers and associated type(s) even when the UE is in its home country. + +- no records containing the replacement field of the form "..sos.en.epc.mcc.visited-country.pub.3gppnework.org", the UE shall replace a Local Emergency Numbers List storing emergency call number(s) and type(s) received over WLAN with an empty Local Emergency Numbers List. + +--- + +### J.3 Void + +--- + +## Annex K (normative): Local Emergency Call Numbers from IKEv2 procedure + +### K.1 General + +This subclause describes the retrieval of the local emergency call numbers using IKEv2 procedures. + +The ePDG may support downloading local emergency call numbers using IKEv2 procedures. + +The UE may support retrieval of local emergency call numbers using IKEv2 procedures. + +--- + +### K.2 Retrieval of local emergency call numbers + +#### K.2.1 UE procedures + +During the tunnel establishment procedure (see subclause 7.2.2), if the UE supports retrieval of local emergency call numbers via IKEv2 procedures, it shall include the EMERGENCY\_CALL\_NUMBERS Notify payload without the MCC information field, Length field and Local emergency numbers field (i.e. the octet 5 to octet x in figure 8.2.9.8-1) in the IKE\_AUTH request message to indicate the support of retrieval of local emergency call numbers via IKEv2 procedures. + +After the successful authentication with the 3GPP AAA server, the UE receives from the ePDG an IKE\_AUTH response message, if: + +- the EMERGENCY\_CALL\_NUMBERS Notify payload is included in that IKE\_AUTH response message; and +- the UE supports retrieval of local emergency call numbers via IKEv2 procedures, + +the UE shall store the local WLAN emergency call numbers and corresponding emergency service categories contained in the EMERGENCY\_CALL\_NUMBERS Notify payload as additional emergency call numbers and categories. The additional emergency call numbers and categories can be used to detect a UE initiated emergency call if the MCC information in the EMERGENCY\_CALL\_NUMBERS Notify payload corresponds to the country in which the UE is located. The local WLAN emergency call numbers and corresponding emergency service categories stored in the user equipment shall be replaced on each receipt of an EMERGENCY\_CALL\_NUMBERS Notify payload with a MCC information field that has a non-zero value Length field. + +If: + +- no MCC information field; +- no Length field; or +- a Length field, set to a non-zero value, is present but no Local emergency numbers field; + +is present in a received EMERGENCY\_CALL\_NUMBERS Notify payload, then the local WLAN emergency call numbers and corresponding emergency service categories, if available in the user equipment, shall be kept. + +#### K.2.2 ePDG procedures + +The ePDG may be configured by the operator with the local emergency call numbers and associated emergency service types along with the corresponding country information. + +After the successful authentication between the UE and the 3GPP AAA server, if: + +- the ePDG is configured with the local emergency call numbers information; and +- the ePDG supports downloading of local emergency call numbers via IKEv2; + +the ePDG shall based on local policy: + +- if the UE has indicated support of retrieval of local emergency call numbers via IKEv2 procedures, + +- i) derive the current visited country from the IP address of the IKEv2 message, i.e. the IP address contained in the out most IP header field of the received IKEv2 message; and + - ii) include the configured local emergency call numbers and the associated emergency service categories of the derived country, if available, in the EMERGENCY\_CALL\_NUMBERS Notify payload in the final IKE\_AUTH response message; or +- b) always + - i) derive the current visited country from the IP address of the IKEv2 message, i.e. the IP address contained in the out most IP header field of the received IKEv2 message; and + - ii) include the configured local emergency call numbers and the associated emergency service categories of the derived country, if available, in the EMERGENCY\_CALL\_NUMBERS Notify payload in the final IKE\_AUTH response message. + +## Annex L (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------|--| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | | +| 2008-01 | | | | | Draft skeleton provided in C1-080125 by rapporteur to CT1#51. | | 0.0.0 | | +| 2008-02 | CT1#51 | | | | Includes the following contribution agreed by CT1 at CT1#51:
C1-080568 | 0.0.0 | 0.1.0 | | +| 2008-02 | CT1#51 bis | | | | Includes the following contributions agreed by CT1 at CT1#51 bis:
C1-080722, C1-080765, C1-080773, C1-080783, C1-080792, C1-080793 | 0.1.0 | 0.2.0 | | +| 2008-04 | CT1#52 | | | | Includes the following contributions agreed by CT1 at CT1#52:-
C1-080921, C1-081391, C1-081392, C1-081393, C1-081394 | 0.2.0 | 0.3.0 | | +| 2008-04 | email review | | | | Incomplete implementation C1-080921 | 0.3.0 | 0.3.1 | | +| 2008-05 | CT1#53 | | | | Includes the following contributions agreed by CT1 at CT1#53:-
C1-081575, C1-082019, C1-082066, C1-082067, C1-082074, C1-082077, C1-082078, C1-082086, C1-082091, C1-082092, C1-082093. | 0.3.1 | 0.4.0 | | +| 2008-06 | CT1#54 | | | | Includes the following contributions agreed by CT1 at CT1#54:-
C1-082470, C1-082563, C1-082567, C1-082569, C1-082688, C1-082803, C1-082804, C1-082809. | 0.4.0 | 0.5.0 | | +| 2008-08 | CT1#55 | | | | Includes the following contributions agreed by CT1 at CT1#55:-
C1-082923, C1-082982, C1-083084, C1-083171, C1-083179, C1-083262, C1-083466, C1-083480, C1-083481, C1-083512, C1-083513, C1-083514, C1-083526, C1-083603, C1-083617 | 0.5.0 | 0.6.0 | | +| 2008-09 | | | | | Version 1.0.0 created for presentation to TSG CT#41 for information | 0.6.0 | 1.0.0 | | +| 2008-10 | CT1#55bis | | | | Includes the following contributions agreed by CT1 at CT1#55bis:-
C1-083851; C1-083976; C1-084155; C1-084383; C1-084385; C1-084386; C1-084387; C1-084388; C1-084391; C1-084393; C1-084394; C1-084395; C1-084396; C1-084482 | 1.0.0 | 1.1.0 | | +| 2008-11 | CT1#56 | | | | Includes the following contributions agreed by CT1 at CT1#56:-
C1-084934; C1-085322; C1-085327; C1-085328; C1-085329; C1-085331; C1-085333; C1-085335; C1-085336; C1-085338; C1-085516; C1-085526; C1-085534
Editorial corrections by the rapporteur to align with drafting rules | 1.1.0 | 1.2.0 | | +| 2008-11 | | | | | Version 2.0.0 created for presentation to CT#42 for approval | 1.2.0 | 2.0.0 | | +| 2008-12 | CT#42 | | | | Version 8.0.0 created after approval in CT#42 | 2.0.0 | 8.0.0 | | +| 2009-03 | CT#43 | CP-090129 | 0001 | 2 | Rapporteur's cleanup of editorial and typo mistakes | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090131 | 0002 | | Trust Relationship Detection | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090130 | 0005 | 1 | Removing redundant and out-of-date editor's notes | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090129 | 0006 | 1 | Missing specification text on WIMAX ANID | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090125 | 0007 | 3 | ANDSF discovery and bootstrapping | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090127 | 0008 | 1 | Corrections for authentication in trusted and untrusted access | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090128 | 0009 | 2 | Incorrect protocol type and wrong reference | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090128 | 0011 | 4 | Delivering HA-APN information to the UE | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090126 | 0012 | 2 | Clarifications for IP mobility mode selection | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090130 | 0014 | | System selection | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090125 | 0017 | 2 | ANDSF procedure - align with 24.312 | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090129 | 0024 | 2 | Clarifying the number of ePDGs | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090130 | 0027 | 1 | Restructuring sub-clause 5.1 | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090129 | 0028 | 2 | Refining sub-clause 5.2 on EPC network selection | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090131 | 0029 | | Use of decorated NAI for cdma2000 access to EPC | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090126 | 0030 | | Clarification of AAA procedures for cdma2000 access | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090126 | 0034 | 1 | Clarification on Tunnel establishment for Multiple PDNs | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090126 | 0038 | 1 | Cleanup for Static Configuration of Inter-technology Mobility Mechanism | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090127 | 0042 | 1 | Cleanup for UE discovering the ANDSF | 8.0.0 | 8.1.0 | | +| 2009-03 | CT#43 | CP-090130 | 0044 | 2 | Selection of the ePDG – resolution of open issues | 8.0.0 | 8.1.0 | | +| 2009-06 | CT#44 | CP-090413 | 0043 | 3 | Mismatch in the static configuration of IP mobility mechanisms in the UE and the EPC | 8.1.0 | 8.2.0 | | +| 2009-06 | CT#44 | CP-090357 | 0048 | 2 | Refining UE procedures for IPSec tunnel management | 8.1.0 | 8.2.0 | | +| 2009-06 | CT#44 | CP-090413 | 0049 | 1 | Access authentication for untrusted non-3GPP access | 8.1.0 | 8.2.0 | | +| 2009-06 | CT#44 | CP-090413 | 0051 | 1 | Clarification about ANDSF usage | 8.1.0 | 8.2.0 | | +| 2009-06 | CT#44 | CP-090413 | 0055 | 1 | IPMS indication to the ePDG and IP address assignment | 8.1.0 | 8.2.0 | | +| 2009-06 | CT#44 | CP-090413 | 0057 | 1 | ANDSF DHCP Options | 8.1.0 | 8.2.0 | | +| 2009-06 | CT#44 | CP-090413 | 0058 | 1 | Network selection and I-WLAN | 8.1.0 | 8.2.0 | | +| 2009-09 | CT#45 | CP-090654 | 0037 | 5 | Clarifications on UE procedures | 8.2.0 | 8.3.0 | | +| 2009-09 | CT#45 | CP-090654 | 0056 | 5 | Handover of multiple PDN connections to one APN | 8.2.0 | 8.3.0 | | + +| | | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------------------------------------------|--------|--------| +| 2009-09 | CT#45 | CP-090654 | 0060 | 2 | Corrections and clarifications on identity usage | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0061 | 1 | Periodic network selection attempts for non-3GPP accesses | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0062 | 1 | Correcting ambiguity of EPC network selection for WLAN as a non-3GPP access | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0065 | 1 | Correction on how UE uses ANDSF information in Annex A | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0066 | | Alignment of text for ANDSF and PLMN selection interaction | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0068 | 1 | APN information in IKE message | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0069 | 1 | IP address allocation during IPsec tunnel establishment procedure | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0070 | | Editorial corrections to subclause 7.2.2 | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0071 | 2 | Corrections in IP Mobility Mode selection | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0072 | 4 | PCO handling on PMIP based interfaces | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0076 | 1 | Attach to untrusted network correction | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0077 | 2 | Corrections to sending of IPMS indication | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090654 | 0075 | 1 | Description on ANDSF in roaming case | 8.3.0 | 9.0.0 | +| 2009-12 | CT#46 | CP-090937 | 0079 | 1 | ANDSF Discovery in roaming scenarios | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090937 | 0082 | 2 | ANDSF discovery procedures performed by a UE | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090937 | 0083 | 3 | Secure connection between UE and ANDSF | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090934 | 0087 | 6 | Implementation of stage 2 requirements for MUPSPAP | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090901 | 0090 | 1 | Tunnel set up after WLAN PLMN selection | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090901 | 0091 | 2 | UE behavior when connecting to v-ANDSF | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090901 | 0095 | 2 | UE's IP configuration during IPsec tunnel establishment with ePDG | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090901 | 0097 | 2 | PDN connection reject during the IPsec tunnel establishment | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090901 | 0099 | 1 | Removal of outdated or redundant editor's notes ahead of CT#46 | 9.0.0 | 9.1.0 | +| 2009-12 | CT#46 | CP-090901 | 0102 | 1 | Addition of abbreviations | 9.0.0 | 9.1.0 | +| 2009-12 | | | | | Editorial correction | 9.1.0 | 9.1.1 | +| 2010-03 | CT#47 | CP-100107 | 0094 | 3 | Removing version identifier from ANDSF information request | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100144 | 0100 | 4 | Emergency session handling (for handovers to HRPD access) | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100107 | 0104 | 1 | Completion of Network selection procedures | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100107 | 0106 | 1 | Corrections to decodes of Value part of EAP attribute | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100150 | 0107 | 2 | DHCP discovery of ANDSF for UE while roaming | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100150 | 0108 | 2 | UE's use of V-ANDSF information vs H-ANDSF information | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100147 | 0109 | 1 | Allowing UE optional behaviour towards networks not supporting MUPSPAP | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100147 | 0110 | | Resolution of Editor's note on PDN connection rejection in section 6.4.4 | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100147 | 0113 | 2 | Handling of concurrent PDN connection requests at ePDG | 9.1.1 | 9.2.0 | +| 2010-03 | CT#47 | CP-100107 | 0115 | 1 | Correction on attachment with ePDG | 9.1.1 | 9.2.0 | +| 2010-06 | CT#48 | CP-100339 | 0118 | | Correction to the Full Authentication and Fast Re-authentication procedures | 9.2.0 | 9.3.0 | +| 2010-06 | CT#48 | CP-100339 | 0122 | | Reference Updates | 9.2.0 | 9.3.0 | +| 2010-06 | CT#48 | CP-100354 | 0123 | 1 | Corrections to PDN connection reject procedure for S2b interface | 9.2.0 | 9.3.0 | +| 2010-06 | CT#48 | CP-100339 | 0125 | | Removing Editor's notes on AT_IPMS_IND, AT_IPMS_RES and AT_TRUST_IND | 9.2.0 | 9.3.0 | +| 2010-06 | CT#48 | CP-100370 | 0119 | 2 | Description of additionally used identifiers in non-3GPP access | 9.3.0 | 10.0.0 | +| 2010-09 | CT#49 | CP-100485 | 0130 | | Removing editor's note on HOME AGENT ADDRESS | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100513 | 0131 | 3 | 24.302 procedures for Inter-System Routing Policies (ISRP) | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100509 | 0132 | 2 | Corrections to UE and ANDSF Pull mode procedures | 10.0.0 | 10.1.0 | +| 2010-12 | CT#50 | CP-100754 | 0134 | 4 | Local operating environment for IFOM | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100754 | 0135 | 1 | Introduction of Non-Seamless WLAN Offload | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100755 | 0136 | 2 | Remove PMIP qualifier for S2b interface | 10.1.0 | 10.2.0 | +| 2011-03 | CT#51 | CP-110163 | 0137 | 4 | ePDG selection for known VPLMN | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110185 | 0139 | 4 | Clarification of Multi-Access Capability Impact for Procedure between UE and ANDSF | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110200 | 0141 | 2 | Information of data traffic routing used by MAPCON capable UE | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110200 | 0142 | 3 | Abnormal case during the handover procedure | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110185 | 0146 | 1 | Correction on multiple PDN support for IFOM | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110185 | 0147 | | Request of ISRP from UE | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110185 | 0148 | 1 | Editor's notes in 24.302 | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110200 | 0149 | 1 | Clarification on use of ISRP for MAPCON capable UE | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | | | | Correction of an error in the implementation of CR0141 | 10.3.0 | 10.3.1 | +| 2011-06 | CT#52 | CP-110459 | 0151 | 1 | IP address allocation when using GTP on S2b | 10.3.1 | 10.4.0 | +| 2011-06 | CT#52 | CP-110471 | 0152 | 1 | Clarification on the relation of the user preferences with ISRP in a MAPCON UE | 10.3.1 | 10.4.0 | +| 2011-06 | CT#52 | CP-110466 | 0155 | | UE retains the information received from ANDSF | 10.3.1 | 10.4.0 | +| 2011-06 | CT#52 | CP-110453 | 0158 | 1 | Reference Update for draft-das-mipshop-andsf-dhcp-options | 10.3.1 | 10.4.0 | +| 2011-06 | CT#52 | CP-110478 | 0160 | 1 | Correction on IFOM and MAPCON UE capability | 10.3.1 | 10.4.0 | +| 2011-09 | CT#53 | CP-110660 | 0171 | 1 | Removal of duplicate reference and correction of references | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110690 | 0161 | 5 | Rejection of ePDG tunnel establishment request | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110690 | 0163 | 2 | Restriction of max PDN connections for non-3GPP access | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110690 | 0165 | 2 | Correction to Automatic EPC network selection | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110694 | 0168 | | Correction to references | 10.5.0 | 11.0.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| 2011-09 | CT#53 | CP-110690 | 0172 | | 3GPP2 reference corrections | 10.5.0 | 11.0.0 | +| 2011-12 | CT#54 | CP-110882 | 0173 | 4 | Clarify interaction between ISRP and ISMP. | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0175 | 3 | Handling the absence of APN leaf in ForServiceBased ISRP | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0180 | 2 | Incorrect representation of EAP-AKA' message | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0181 | 2 | Support for access to external private networks via S2b | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0182 | 1 | ISRP usage | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0184 | 3 | Clarification of the UE location | 11.0.0 | 11.1.0 | +| 2012-03 | CT#55 | CP-120113 | 0189 | 1 | HA IP address from DNS | 11.1.0 | 11.2.0 | +| 2012-06 | CT#56 | CP-120309 | 0190 | | NAI used for authentication | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120309 | 0192 | 1 | Remove PMIP qualifier for S2a interface | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120309 | 0194 | | Security mechanisms for tunnel setup using IPsec and IKEv2 | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120311 | 0195 | 2 | Name for network provided over non-3GPP access network connected to EPC | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120318 | 0198 | | Conditions for the UE to provide indication for IPMS | 11.2.0 | 11.3.0 | +| 2012-09 | CT#57 | CP-120584 | 0202 | 1 | Corrections for Name for network provided over non-3GPP access network connected to EPC | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120592 | 0203 | | Reference for BBAI | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120584 | 0205 | | Correction on bit number | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120584 | 0209 | 2 | Handling of unknown protocol data | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120584 | 0210 | 3 | Clarification of IPsec tunnel established between the UE and the ePDG | 11.3.0 | 11.4.0 | +| 2012-12 | CT#58 | CP-120794 | 0199 | 4 | Clarification on DSMIP indication | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120794 | 0211 | | Editor's notes on attribute types for AT_SHORT_NAME_FOR_NETWORK and AT_FULL_NAME_FOR_NETWORK | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120794 | 0213 | 3 | GBA Push realization not using General Package #0 format | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120794 | 0218 | 1 | Clarification of the usage of the APN in the IKEv2 signaling | 11.4.0 | 11.5.0 | +| 2013-03 | CT#59 | CP-130115 | 0222 | | Ignoring information element | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130125 | 0221 | 2 | Clean-up and consolidation of repeated requirements | 11.6.0 | 12.0.0 | +| 2013-06 | CT#60 | CP-130258 | 0228 | 2 | APN forbidden by the UE | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0229 | 2 | EPC access forbidden by the UE | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0230 | 2 | ISRP sent in PSK TLS connection | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130250 | 0233 | | Recommended application id for ANDSF GBA Push | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130418 | 0234 | 4 | Specification of Tunnelling of UE Services over Restrictive Access Networks | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0238 | 3 | Trust relationship notification from the 3GPP AAA server | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0241 | 1 | Reject a PDN connection | 12.0.0 | 12.1.0 | +| 2013-09 | CT#61 | CP-130512 | 0243 | 1 | Tunnelling of UE Services over Restrictive Access Networks - cleanup and editor's note resolution | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130509 | 0246 | 2 | IARP in roaming scenarios | 12.1.0 | 12.2.0 | +| 2013-12 | CT#62 | CP-130754 | 0247 | 2 | Bit order in fields of figures | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0249 | 1 | Incorrect message name | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130768 | 0250 | 4 | The usage of APN in non-3GPP access | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130761 | 0251 | 2 | Adding IARP in information provided by ANDSF | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130768 | 0254 | 1 | Multiple PDN support for trusted WLAN | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130768 | 0248 | 5 | EAP extensions for eSaMOG_St3 | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130761 | 0252 | 3 | Introduction of Inter-APN Routing Policies (IARP) for ANDSF | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130761 | 0257 | 1 | The usage of IARP in determining the data traffic routing of IP flows | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130765 | 0253 | 6 | Support of BBF convergence | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130803 | 0255 | 2 | Clarifications and cleanup related to UE capabilities for ANDSF | 12.2.0 | 12.3.0 | +| 2014-03 | CT#63 | CP-140139 | 0258 | 2 | UE unaware whether the network uses the fixed access broadband access interworking or the fixed broadband access convergence | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0259 | 5 | Editor's note on UE support of SCM and MCM | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0260 | | Editor's note on cause for 'None of the requested connectivity type(s) is authorized' | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0261 | | Editor's note on usage of SCM and MCM being subject to UE subscription | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0262 | 2 | Providing IPv4 address and IPv6 interface identifier | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0263 | 3 | Network capability not supporting UE request for MCM/SCM | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0264 | 2 | Causes defined for WLCP which are also applicable to SCM | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140141 | 0266 | | Correction to misleading requirement on provision of ISMP | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0267 | 1 | Providing TWAG control plane address | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140137 | 0270 | 1 | Access Network reselection procedures | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140137 | 0271 | 4 | Remove 24.234 from WLAN selection procedures | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140141 | 0274 | 1 | Deleting the repeated description about UE capability | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140151 | 0276 | 2 | Clarify handling of Protocol Configuration Options | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140141 | 0277 | 2 | Clarification for UE requirements about ANDSF rule evaluation | 12.3.0 | 12.4.0 | +| 2014-06 | CT#64 | CP-140336 | 0268 | 3 | Clarification on UE procedures according to 3GPP RAT differentiation in ISRP | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0273 | 7 | Introduction of WLAN selection mechanism based on WLANSP | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140319 | 0279 | 1 | Providing TWAG User Plane address for usage in single-connection mode | 12.4.0 | 12.5.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| 2014-06 | CT#64 | CP-140319 | 0280 | 1 | Providing TWAG control plane address for usage in multi-connection mode | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140319 | 0281 | | Corrections of minor errors | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140325 | 0283 | | Correction in applying IARP | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140325 | 0284 | 2 | Relation between IARP and ISMP | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140319 | 0286 | 1 | Requested connectivity type in SCM | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140325 | 0289 | 1 | Clarification and cleanup for IARP | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0293 | 2 | WLAN network selection terminologies | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0294 | 3 | UE usage of access network selection information | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0296 | 3 | Introduce service provider that is not a 3GPP service provider | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0302 | 1 | Manual PLMN selection function | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0303 | 3 | UE behaviour in access Network reselection procedures | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0304 | 4 | Modification on active rule selection mechanism | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140335 | 0307 | 3 | WLAN selection and service provider selection procedures | 12.4.0 | 12.5.0 | +| 2014-09 | CT#65 | CP-140650 | 0292 | 4 | Congestion control in SCM | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0299 | 4 | Preferred Service Provider List | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140661 | 0300 | 5 | Removal of I-WLAN references from ePDG selection procedure | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0306 | 3 | HomeNetwork indicator in WLAN selection | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0308 | 3 | Reuse 3GPP defined EAP-AKA procedures | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140574 | 0309 | 4 | Clarifying WLAN selection procedures in case of multiple candidate WLANs | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0310 | 3 | Completing service provider discovery procedures based on EAP | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0311 | 2 | Adding support for HPLMN identified with a non-PLMN realm | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0313 | | Repeated rule selection information | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0314 | 2 | Selection of WLANSP during power-up | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0315 | 1 | Selection of the active ISMP and ISRP | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0316 | 2 | Usage of ISMP/ISRP | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140659 | 0320 | 1 | User preference handling for data traffic routing | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0323 | 3 | Clarifications to WLAN selection procedures | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140672 | 0324 | | Removal of editor's note on active WLANSP rule | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140678 | 0325 | 5 | IEEE 802.11u generic container for ANQP payload | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140571 | 0326 | 4 | 3GPP access stratum layer controlling UE usage of WLAN | 12.5.0 | 12.6.0 | +| 2014-09 | CT#65 | CP-140650 | 0330 | | Initiating IANA registration for AT_TWAN_CONN_MODE EAP-AKA attribute | 12.5.0 | 12.6.0 | +| 2014-12 | CT#66 | CP-140854 | 0331 | 1 | Removal of priority of WLAN identifiers provided by the RAN | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140854 | 0332 | 2 | Correcting references to WLAN offload indication IE | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140854 | 0333 | 1 | 3GPP access stratum layer controlling UE usage of WLAN, in UEs NOT capable to simultaneously route IP traffic to both 3GPP access and WLAN access | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140840 | 0334 | | Corrections in procedures | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140840 | 0335 | 2 | Corrections in data structures | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140840 | 0336 | 1 | Correcting remaining cases of UE capabilities not matching network capabilities | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0337 | 1 | Fixing inconsistency in usage of VPLMNs with preferred rules | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0338 | 1 | HotSpot2.0 Rel-2 reference update | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140854 | 0340 | 3 | 3GPP access stratum layer controlling UE usage of WLAN using OPI | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0341 | 2 | Correcting error in IEEE 802.11u generic container | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140838 | 0342 | 2 | IANA registration of FTT_KAT parameter | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140854 | 0343 | 2 | Support of Beacon RSSI threshold as RAN assistance information | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140840 | 0347 | 1 | DTLS key derivation for multi-connection mode | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140854 | 0350 | 5 | RAN assistance information and traffic routing | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0353 | 1 | Clarification on how to select an ePDG | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0354 | 4 | Complete Manual Service Provider selection mode procedure | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0355 | 2 | Complete Manual mode WLAN selection | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140840 | 0362 | 3 | Removal of UDP info from TWAG_CP_ADDRESS | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140835 | 0363 | 1 | The usage of the IARP rule and the ISRP rule | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0364 | 3 | Automatic WLAN selection procedure cleanup | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0365 | 3 | Service Provider selection cleanup | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0366 | 3 | S2a WLAN selection must take PLMNs into account | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0367 | 2 | Equivalent service provider clarification | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0371 | 3 | Mode selection at switch-on | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0372 | 3 | WLANSP/ISMP/ISRP rule re-selection | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140854 | 0374 | | Correction for Offload Preference Indicator (OPI) | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0376 | 2 | Update to reference IEEE 802 | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140844 | 0368 | 1 | Correction on root NAI usage during automatic mode service provider selection using WLAN | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140857 | 0346 | 1 | Transport of P-CSCF addresses using signalling for access to EPC via WLAN connected using S2b | 12.7.0 | 13.0.0 | +| 2015-03 | CT#67 | CP-150068 | 0381 | 1 | Correcting references to 23.003 | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150065 | 0383 | 1 | IANA registration of AT_TWAN_CONN_MODE EAP-AKA attribute | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150075 | 0385 | | Correcting 3GPP access network terms | 13.0.0 | 13.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| 2015-03 | CT#67 | CP-150065 | 0387 | 2 | Correcting description of semantic of unrecognized values | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150075 | 0389 | 1 | Enforcement of RAN rules when new PDN connection is created in 3GPP access | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150068 | 0391 | 1 | Cross reference update | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150075 | 0394 | 2 | UE handling of ISRP and IARP rules for traffic routing | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150077 | 0396 | 1 | WLANSP information provided from ANDSF to the UE | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150061 | 0398 | 1 | Reference update to IEEE 802.11u standard | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150042 | 0400 | 4 | Usage of RAN rule in SCM | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150077 | 0401 | 1 | UE retaining IARP from the H-ANDSF | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150077 | 0402 | 2 | IKEv2 security associations when an additional PDN connection is setup via untrusted non-3GPP access network | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150075 | 0406 | 1 | PLMN selection when using RAN rule | 13.0.0 | 13.1.0 | +| 2015-03 | CT#67 | CP-150068 | 0413 | 1 | Introduction of Visited Network Preference information | 13.0.0 | 13.1.0 | +| 2015-06 | CT#68 | CP-150323 | 0414 | 1 | ID Type field of IDr payload carrying APN | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150321 | 0415 | | draft-gundavelli-ipsecme-3gpp-ims-options reference update | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0416 | 3 | Correction to ePDG selection | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0417 | 1 | INITIAL_CONTACT notification when additional PDN connection is established | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150314 | 0421 | 3 | Priority defined in preferredSSIDList | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0422 | 3 | Cause value for EPC forbidden | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150308 | 0428 | 1 | ANDSF information on visited PLMNs with preferred rules | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150305 | 0436 | 2 | Timer Tw1 | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150329 | 0438 | | Aligning TLS profiles used by CT1 specifications with SA3 agreed TLS profile | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0443 | 3 | Clarify when to use root NAI | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0445 | 3 | Adding a general subclause to clause 5 | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150314 | 0448 | 1 | Rule selection information | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0449 | 2 | IKEv2 liveness check | 13.1.0 | 13.2.0 | +| 2015-06 | CT#68 | CP-150323 | 0450 | 4 | Switch-on and switch-off for non-3GPP access | 13.1.0 | 13.2.0 | +| 2015-09 | CT#69 | CP-150519 | 0453 | | Incorrect reference [28] | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150522 | 0458 | 1 | IKEv2 extension for P-CSCF restoration over untrusted WLAN | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150533 | 0459 | 2 | Support of Emergency services over WLAN access to EPC | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150524 | 0460 | 3 | Support of IMEI signalling for trusted WLAN access | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150524 | 0461 | 1 | Support of IMEI signalling via IKEv2 for un-trusted access | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0463 | 3 | DIAMETER_AUTHORIZATION_REJECTED for untrusted WLAN | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0464 | 2 | DIAMETER_AUTHORIZATION_REJECTED for trusted WLAN | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0465 | 2 | DIAMETER_ERROR_USER_NO_NON_3GPP_SUBSCRIPTION | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0466 | 2 | DIAMETER_ERROR_USER_NO_NON_3GPP_SUBSCRIPTION | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0467 | 2 | DIAMETER_UNABLE_TO_COMPLY | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0468 | 2 | DIAMETER_UNABLE_TO_COMPLY | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0469 | 1 | Clarify the re-established PDN connection | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150526 | 0470 | 1 | Handling of NBIFOM during tunnel establishment procedure | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150526 | 0471 | 1 | Handling of NBIFOM during tunnel modification procedure | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150519 | 0478 | 1 | Correct bullets | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150527 | 0480 | 3 | DIAMETER_ERROR_USER_NO_APN_SUBSCRIPTION error code mapping to IKEv2 | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150515 | 0486 | 2 | EAP-AKA procedures for untrusted non-3GPP access network | 13.2.0 | 13.3.0 | +| 2015-09 | CT#69 | CP-150574 | 0487 | 3 | Selection of ePDG for emergency bearer services | 13.2.0 | 13.3.0 | +| 2015-12 | CT#70 | CP-150696 | 0456 | 7 | Liveness check corrections | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150707 | 0491 | 2 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED for trusted WLAN | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150714 | 0494 | 1 | APN handling in Emergency session establishment | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150696 | 0495 | | Correction of IP address handling during handover to untrusted non-3GPP access | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150695 | 0496 | | draft-gundavelli-ipsecme-3gpp-ims-options became RFC7651 | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150714 | 0497 | 3 | ePDG selection configuration in USIM for emergency services | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150696 | 0498 | 2 | UE handling of ANDSF information | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150707 | 0502 | 6 | DIAMETER_ERROR_USER_UNKNOWN, DIAMETER_ERROR_ROAMING_NOT_ALLOWED, DIAMETER_AUTHORIZATION_REJECTED and DIAMETER_ERROR_RAT_TYPE_NOT_ALLOWED result codes for untrusted WLAN | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150691 | 0505 | 1 | Correction for content of IDi payload | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150706 | 0506 | 1 | NBIFOM_GENERIC_CONTAINER definition | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150706 | 0507 | | Reducing NBIFOM specific statements for untrusted non-3GPP access | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150696 | 0508 | 1 | UE backoff Handling for trusted WLAN access to EPC using SCM | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150703 | 0509 | 1 | Mid-call IMEI signaling for untrusted access | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150696 | 0510 | 2 | Reference UE authentication of ePDG to 33.402 | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150710 | 0514 | 2 | Reactivation Requested cause over untrusted WLAN | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150706 | 0515 | | Multiple accesses to a PDN connection not allowed for SCM | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150707 | 0516 | 2 | Error cases for the trusted WLAN | 13.3.0 | 13.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|----|-----------------------------------------------------------------------------------|--------|--------| +| 2015-12 | CT#70 | CP-150707 | 0517 | 2 | HO procedures without PGW ID | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150707 | 0518 | 1 | Define AAA Server behaviour in procedure subclause | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150701 | 0519 | | Replace CFG SET/CFG_ACK with CFG_REQUEST/CFG_REPLY | 13.3.0 | 13.4.0 | +| 2015-12 | CT#70 | CP-150877 | 0426 | 20 | Selection of ePDG based on home operator preference | 13.3.0 | 13.4.0 | +| 2016-03 | CT#71 | CP-160070 | 0511 | 7 | Authentication Signalling Improvement with Backoff Timer for untrusted access | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160070 | 0512 | 10 | Authentication Signalling Improvement with Backoff Timer for SCM | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160082 | 0521 | 1 | Remove editor's note on ePDG selection | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160083 | 0523 | 4 | Selecting ePDG for emergency services in WLAN | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160070 | 0524 | 1 | Remove editor's notes | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160082 | 0526 | 1 | Add cause values for SCM | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160082 | 0527 | 2 | Confusing and misuse of the term and indication of "value" | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160070 | 0520 | 1 | ASI_WLAN cleanup | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160082 | 0528 | 3 | Replace undefined terms and reword untestable conditions | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160078 | 0530 | 1 | Correction on IKEv2 messages carrying CFG_REQUEST and CFG_REPLY | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160078 | 0531 | 1 | ePDG-initiated modification initiated by UE-initiated modification | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160077 | 0533 | 3 | DEVICE_IDENTITY signalling using IKEv2 Notify payload | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160078 | 0532 | 1 | Change NBIFOM_GENERIC_CONTAINER from Configuration payload to Notify payload | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160083 | 0537 | 3 | Handling of emergency indication for emergency sessions over untrusted WLAN | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160082 | 0539 | | Capitalisation of field names and miscellaneous corrections | 13.4.0 | 13.5.0 | +| 2016-03 | CT#71 | CP-160079 | 0540 | 3 | IKEv2 extension for P-CSCF reselection support | 13.4.0 | 13.5.0 | +| 2016-06 | CT#72 | CP-160316 | 0534 | 6 | ePDG selection in support of Lawful Interception | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160316 | 0541 | | Editor's notes on registration of TIMEOUT_PERIOD_FOR_LIVENESS_CHECK with IANA | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160313 | 0542 | | Usage and definition of REACTIVATION_REQUESTED_CAUSE | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160308 | 0543 | 1 | Correction of the name for the private Notify payloads | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160317 | 0544 | 2 | Emergency ePDG identifier configuration | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160316 | 0546 | 1 | ANDSF configuration for coexistence between WLANSP rules and LWPA, RCLWI and LWIP | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160316 | 0550 | 2 | ANDSF/UICC configuration precedence | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160316 | 0551 | 1 | Clarification on ePDG configuration information | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160325 | 0552 | 1 | Local release of NBIFOM PDN connection for untrusted WLAN | 13.5.0 | 13.6.0 | +| 2016-06 | CT#72 | CP-160344 | 0549 | 1 | Clarification on the use of the IKEv2 Error PLMN_NOT_ALLOWED | 13.6.0 | 14.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160516 | 0553 | 2 | F | Reservation of a private notify message error type value range and a private notify message status type value range for usage out of scope of 3GPP | 14.1.0 | +| 2016-09 | CT#73 | CP-160513 | 0554 | 1 | B | Add a cause value to indicate the rejection of an illegal UE for trusted WLAN access | 14.1.0 | +| 2016-09 | CT#73 | CP-160513 | 0555 | 2 | B | Add a cause value to indicate the rejection of an illegal UE for untrusted WLAN access | 14.1.0 | +| 2016-09 | CT#73 | CP-160507 | 0557 | 1 | A | Remove EN on backoff timer | 14.1.0 | +| 2016-09 | CT#73 | CP-160509 | 0559 | | A | Remove the editor's note on emergency service over WLAN | 14.1.0 | +| 2016-09 | CT#73 | CP-160517 | 0560 | 2 | B | ePDG selection for emergency services over WLAN | 14.1.0 | +| 2016-09 | CT#73 | CP-160517 | 0561 | 3 | B | Emergency session establishment for untrusted access | 14.1.0 | +| 2016-09 | CT#73 | CP-160507 | 0564 | 1 | A | Corrections to ePDG selection | 14.1.0 | +| 2016-09 | CT#73 | CP-160517 | 0566 | 3 | B | User Identification for emergency services over WLAN | 14.1.0 | +| 2016-09 | CT#73 | CP-160517 | 0567 | 2 | B | Support of Emergency session establishment for unauthenticated UEs | 14.1.0 | +| 2016-09 | CT#73 | CP-160510 | 0569 | 1 | F | Release-specific reference to 24.234 | 14.1.0 | +| 2016-09 | CT#73 | CP-160507 | 0571 | 1 | A | Remove editor's note for the case when LWA co-existence info is not provisioned | 14.1.0 | +| 2016-12 | CT#74 | CP-160798 | 0572 | 1 | B | ePDG emergency service support indication to the UE | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0573 | 4 | B | New emergency PDN connection in TWAN and handover of emergency PDN connection from 3GPP access to TWAN | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0574 | 2 | B | Handover of emergency PDN connection from 3GPP access to untrusted non-3GPP access | 14.2.0 | +| 2016-12 | CT#74 | CP-160735 | 0576 | 1 | A | NBIFOM and WLAN access selection and traffic routing controlled by RAN rules | 14.2.0 | +| 2016-12 | CT#74 | CP-160735 | 0579 | 1 | A | Alignment to RAN-controlled LTE-WLAN interworking and RAN-assisted WLAN interworking | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0580 | 2 | B | Determining same country location for UE and the connected ePDG | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0581 | 1 | F | Correction to "IMSI is unauthenticated" | 14.2.0 | +| 2016-12 | CT#74 | CP-160749 | 0583 | 2 | F | NO_APN_SUBSCRIPTION backoff handling for untrusted access | 14.2.0 | +| 2016-12 | CT#74 | CP-160749 | 0585 | 2 | F | NO_APN_SUBSCRIPTION backoff handling for SCM | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0587 | 1 | B | IMEI not accepted cause for rejection of ES request via untrusted WLAN | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0588 | 8 | B | IMSI as identification for emergency services over WLAN | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0589 | 1 | B | NAI as user identity in the IDi payload of IKE_AUTH message | 14.2.0 | +| 2016-12 | CT#74 | CP-160749 | 0591 | 2 | F | Clarification on ePDG selection procedure | 14.2.0 | +| 2016-12 | CT#74 | CP-160740 | 0592 | 1 | B | Add optional ERP support to UE | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0594 | 1 | B | Request IMEI from UE with unauthenticated IMSI via untrusted WLAN | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0595 | 3 | B | Emergency session for UICC-less and unauthenticated UEs over untrusted access | 14.2.0 | +| 2016-12 | CT#74 | CP-160798 | 0596 | 2 | B | Support of Emergency session establishment over trusted access | 14.2.0 | +| 2017-03 | CT#75 | CP-170134 | 0600 | | D | Correcting typo errors and "informal" text | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0602 | 3 | B | UE attached for emergency over untrusted WLAN | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0603 | 1 | F | Redundant description on handling of unauthenticated UE for emergency over untrusted WLAN | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0605 | 1 | F | Format of emergency NAI reference | 14.3.0 | +| 2017-03 | CT#75 | CP-170124 | 0607 | 2 | B | UE rekey procedure for WLAN | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0609 | 1 | B | Correction to the definition of emergency session | 14.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------|--------| +| 2017-03 | CT#75 | CP-170134 | 0610 | 1 | B | Authentication exception during emergency session over trusted WLAN | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0597 | 9 | B | Identity management for emergency session over trusted WLAN | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0601 | 4 | B | AAA Server support of Emergency session establishment over trusted access | 14.3.0 | +| 2017-03 | CT#75 | CP-170134 | 0611 | 3 | B | Connection mode negotiation for emergency session over trusted WLAN | 14.3.0 | +| 2017-06 | CT#76 | CP-171088 | 0599 | 5 | F | Introduction of WLAN and ANQP | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0608 | 8 | B | Managing local emergency number over the non-3GPP access | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0612 | 5 | B | Handling of emergency call numbers for emergency session over WLAN access | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0613 | | B | User identification for emergency session over WLAN access | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0614 | 1 | B | EAP-3GPP-LimitedService method coding | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0618 | 1 | B | Emergency call numbers via IKEv2 | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0619 | 1 | F | IKEv2 private error type to indicate unauthenticated emergency service | 14.4.0 | +| 2017-06 | CT#76 | CP-171089 | 0621 | 1 | B | ePDG handling of unauthenticated emergency session | 14.4.0 | +| 2017-06 | CT#76 | CP-171088 | 0623 | 1 | F | Correction on PDN-GW selection during initial attach | 14.4.0 | +| 2017-09 | CT#77 | CP-172111 | 0629 | 2 | F | Remove double negation | 14.5.0 | +| 2017-09 | CT#77 | CP-172099 | 0631 | 1 | F | Only ERP Implicit Bootstrapping mode is supported in Rel-14 | 14.5.0 | +| 2017-09 | CT#77 | CP-172111 | 0633 | 3 | F | Emergency call detection when the UE is connected only to non-3GPP access | 14.5.0 | +| 2017-09 | CT#77 | CP-172111 | 0635 | 3 | F | Minimum and maximum size for EMERGENCY_CALL_NUMBERS Notify payload | 14.5.0 | +| 2017-09 | CT#77 | CP-172123 | 0624 | 2 | B | IKEv2 multiple bearer PDN connectivity | 15.0.0 | +| 2017-09 | CT#77 | CP-172122 | 0625 | | F | Incorrect ESP SPI in Delete payload | 15.0.0 | +| 2017-09 | CT#77 | CP-172122 | 0630 | 1 | C | Alignment of IP address allocation mechanism between 3GPP and non-3GPP access | 15.0.0 | +| 2017-09 | CT#77 | CP-172123 | 0632 | 1 | B | Support of QoS differentiation for trusted non-3GPP access | 15.0.0 | +| 2017-09 | CT#77 | | | | | acceptation of revision marks | 15.0.1 | +| 2017-12 | CT#78 | CP-173077 | 0628 | | F | ePDG selection at a location that does not belong to any country | 15.1.0 | +| 2017-12 | CT#78 | CP-173078 | 0636 | 1 | F | Clarification on IPv6 addresses comparison during handover | 15.1.0 | +| 2017-12 | CT#78 | CP-173057 | 0638 | 3 | A | Handling of emergency numbers received over non-3GPP access | 15.1.0 | +| 2017-12 | CT#78 | CP-173057 | 0640 | 1 | A | Resolve EN "It is FFS if the UE can still use these numbers when connected only to non-3GPP access" | 15.1.0 | +| 2017-12 | CT#78 | CP-173082 | 0641 | | B | Resolving Editor's Note on QCI to DSCP mapping | 15.1.0 | +| 2017-12 | CT#78 | CP-173057 | 0643 | 4 | A | Correct MCC information usage and storage of Local Emergency Numbers List in Annex J | 15.1.0 | +| 2017-12 | CT#78 | CP-173082 | 0644 | 1 | B | Usage of TWAG MAC address for WLCP bearer | 15.1.0 | +| 2017-12 | CT#78 | CP-173077 | 0647 | 2 | D | Corrections to EAP-AKA procedure in the UE | 15.1.0 | +| 2017-12 | CT#78 | CP-173082 | 0648 | 1 | F | Incorrect values of Notify Message Type field | 15.1.0 | +| 2017-12 | CT#78 | CP-173082 | 0649 | 1 | B | Further QoS parameters in QoS differentiations | 15.1.0 | +| 2017-12 | CT#78 | CP-173049 | 0652 | | A | Missing 't' in "epdg.epc.mnc.mcc.pub.3gppnetwork.org" | 15.1.0 | +| 2017-12 | CT#78 | CP-173057 | 0654 | | A | Correct mapping Emergency Call Number Unit field contents to Emergency Service Category Value | 15.1.0 | +| 2017-12 | CT#78 | CP-173055 | 0656 | 1 | A | Emergency ePDG selection for UE without UICC | 15.1.0 | +| 2018-03 | CT#79 | CP-180106 | 0657 | 1 | F | Correction of incorrect references | 15.2.0 | +| 2018-03 | CT#79 | CP-180063 | 0659 | | A | Corrections of errors in emergency PDU session establishment by UE without valid UICC using SCM in TWAN | 15.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2018-06 | CT#80 | CP-181051 | 0661 | 2 | A | Emergency session establishment when the UE is connected to an ePDG | 15.3.0 | +| 2018-06 | CT#80 | CP-181059 | 0662 | 2 | B | Clarification on usage of ePDG selection procedures | 15.3.0 | +| 2018-06 | CT#80 | CP-181059 | 0663 | | B | 5G N3A - info for handover from EPC/ePDG to 5GS | 15.3.0 | +| 2018-06 | CT#80 | CP-181078 | 0665 | | F | Incorrect numbering of tables and figures | 15.3.0 | +| 2018-09 | CT#81 | CP-182129 | 0666 | 1 | B | S-NSSAI info for PDN connection established over ePDG/EPC | 15.4.0 | +| 2018-09 | CT#81 | CP-182129 | 0667 | 1 | F | Correction for no overlap in assignments of IKE Notify message types specified for access via untrusted non-3GPP to EPC and to 5GCN | 15.4.0 | +| 2018-09 | CT#81 | CP-182129 | 0668 | 1 | F | Correction for transfer of a PDU session to untrusted non-3GPP access connected to EPC | 15.4.0 | +| 2018-09 | CT#81 | CP-182151 | 0671 | 2 | F | Correcting maximum number of simultaneous PDN connections | 15.4.0 | +| 2018-09 | CT#81 | CP-182129 | 0672 | 2 | F | Using Serving network name as Access Network Identity for 5G | 15.4.0 | +| 2018-12 | CT#82 | CP-183031 | 0673 | 1 | F | Correction for selection of PDU session ID via untrusted non-3GPP access connected to EPC | 15.5.0 | +| 2018-12 | CT#82 | CP-183075 | 0675 | 1 | A | No UE configuration parameters for connectivity to ePDG by UICC | 15.5.0 | +| 2018-12 | CT#82 | CP-183072 | 0681 | | A | Resolving Editor's Notes: version of 3GPP2 X.S0057, 3GPP2 C.S0087 | 15.5.0 | +| 2018-12 | CT#82 | CP-183068 | 0687 | | A | Correct reference | 15.5.0 | +| 2018-12 | CT#82 | CP-183069 | 0690 | 1 | A | Clarify decorated NAI usage | 15.5.0 | +| 2018-12 | CT#82 | CP-183073 | 0695 | 1 | A | Resolving Editor's Note on application ID for ANDSF GBA Push | 15.5.0 | +| 2018-12 | CT#82 | CP-183069 | 0696 | 2 | A | Missing references to RFC 7296 and 4306 | 15.5.0 | +| 2019-03 | CT#83 | CP-190083 | 0699 | 1 | F | Correct determination of country the UE is located in | 15.6.0 | +| 2019-03 | CT#83 | CP-190100 | 0700 | | D | Fixing some heading styles and typos | 15.6.0 | +| 2019-03 | CT#83 | CP-190100 | 0702 | 3 | F | UE and ePDG behavior after no response to INFORMATIONAL message | 15.6.0 | +| 2019-03 | CT#83 | CP-190083 | 0704 | 1 | F | Correction on PDU session ID field setting for UE supporting N1 mode | 15.6.0 | +| 2019-03 | CT#83 | CP-190108 | 0703 | 1 | F | Correct typos Non-3GPP NW policies IE | 16.0.0 | +| 2019-06 | CT#84 | CP-191137 | 0705 | 2 | B | Adding 5G Connectivity capability to ANQP payload | 16.1.0 | +| 2019-06 | CT#84 | CP-191121 | 0707 | | A | Condition to include N1_MODE INFORMATION Notify payload | 16.1.0 | +| 2019-06 | CT#84 | CP-191145 | 0708 | 1 | F | Reference to IEEE Std 802.11 | 16.1.0 | +| 2019-09 | CT#85 | CP-192058 | 0711 | 1 | F | N1_MODE_SUPPORT Notify Payload | 16.2.0 | +| 2019-09 | CT#85 | CP-192058 | 0712 | | F | PLMN ID that S-NSSAI relates to | 16.2.0 | +| 2019-12 | CT#86 | CP-193114 | 0714 | 3 | F | Correcting description of MAX_CONNECTION_REACHED | 16.3.0 | +| 2019-12 | CT#86 | CP-193100 | 0716 | 1 | B | PLMN supporting 5G connectivity without 5G NAS signalling | 16.3.0 | +| 2020-06 | CT#88e | CP-201106 | 0718 | 1 | F | Clarification on NETWORK_FAILURE notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201128 | 0719 | 1 | F | Handover of ethernet PDN connection to ePDG not supported | 16.4.0 | +| 2020-06 | CT#88e | CP-201128 | 0720 | 1 | F | Correction of IKEV2 protocol RFC number from old 7296 to new 7296 | 16.4.0 | +| 2020-06 | CT#88e | CP-201128 | 0721 | 1 | F | Enhancement in UE handling when error MAX_CONNECTION_REACHED is received from network and clarify applicability of max PDN connection limit | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24303/raw.md b/marked/Rel-16/24_series/24303/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2cbe95a14c3c7219843627673d57ed5b602c2616 --- /dev/null +++ b/marked/Rel-16/24_series/24303/raw.md @@ -0,0 +1,1702 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 General..... | 9 | +| 4.1 Mobility management based on Dual-Stack Mobile IPv6 ..... | 9 | +| 4.2 Identities..... | 9 | +| 4.3 Multiple PDN connectivity ..... | 10 | +| 5 Dual-Stack Mobile IPv6 Procedures..... | 11 | +| 5.1 Dual-Stack Mobile IPv6 initial attach..... | 11 | +| 5.1.1 General ..... | 11 | +| 5.1.2 UE procedures ..... | 11 | +| 5.1.2.1 Discovery of the Home Agent address ..... | 11 | +| 5.1.2.1.1 General ..... | 11 | +| 5.1.2.1.2 Home agent address discovery based on DNS..... | 12 | +| 5.1.2.1.3 Home agent address discovery based on protocol configuration options ..... | 12 | +| 5.1.2.1.4 Home agent address discovery based on IKEv2 signalling ..... | 12 | +| 5.1.2.1.5 Home agent address discovery based on DHCPv6 ..... | 12 | +| 5.1.2.1a IFOM capability discovery ..... | 13 | +| 5.1.2.2 Security association establishment and IPv6 Home Network Prefix assignment ..... | 13 | +| 5.1.2.3 Home Link Detection..... | 14 | +| 5.1.2.4 Initial binding registration and IPv4 Home Address assignment ..... | 14 | +| 5.1.3 HA procedures..... | 16 | +| 5.1.3.1 Security association establishment and IPv6 Home Network Prefix assignment ..... | 16 | +| 5.1.3.2 Initial binding registration and IPv4 Home Address assignment ..... | 18 | +| 5.1.3.3 Binding Error message..... | 19 | +| 5.2 Dual-Stack Mobile IPv6 handover..... | 19 | +| 5.2.1 General ..... | 19 | +| 5.2.2 UE procedures ..... | 19 | +| 5.2.2.1 General..... | 19 | +| 5.2.2.2 Handover from home link to a foreign link ..... | 19 | +| 5.2.2.3 Handover from a foreign link to another foreign link ..... | 20 | +| 5.2.2.4 Handover from a foreign link to a home link ..... | 21 | +| 5.2.3 HA procedures..... | 21 | +| 5.2.3.1 Handover from home link to a foreign link ..... | 21 | +| 5.2.3.2 Handover from a foreign link to another foreign link ..... | 22 | +| 5.2.3.3 Handover from a foreign link to a home link ..... | 22 | +| 5.3 Dual Stack Mobile IPv6 Re-Registration..... | 23 | +| 5.3.1 General ..... | 23 | +| 5.3.2 UE procedures ..... | 23 | +| 5.3.3 HA procedures..... | 23 | +| 5.4 Dual-Stack Mobile IPv6 detach ..... | 24 | +| 5.4.1 General ..... | 24 | +| 5.4.2 UE procedures ..... | 24 | +| 5.4.2.1 Network-initiated detach..... | 24 | +| 5.4.2.2 UE-initiated detach ..... | 24 | +| 5.4.3 HA procedures..... | 24 | +| 5.4.3.1 Network-initiated detach..... | 24 | +| 5.4.3.2 UE-initiated detach ..... | 25 | +| 5.5 Void..... | 25 | +| 5.5A Protection of data traffic..... | 25 | +| 5.5A.1 General ..... | 25 | +| 5.5A.2 UE procedures ..... | 25 | +| 5.5A.3 HA procedures..... | 26 | + +| | | | +|-----------------------------|---------------------------------------------------------------------------|-----------| +| 5.6 | Attach to additional access network..... | 26 | +| 5.6.1 | General ..... | 26 | +| 5.6.2 | UE procedures ..... | 27 | +| 5.6.2.1 | General..... | 27 | +| 5.6.2.2 | Attach to additional access network acting as home link ..... | 27 | +| 5.6.2.3 | Attach to an additional access acting as foreign link..... | 27 | +| 5.6.3 | HA procedures..... | 28 | +| 5.6.3.1 | General..... | 28 | +| 5.6.3.2 | Attach to an additional access network acting as home link ..... | 28 | +| 5.6.3.3 | Attach to additional access acting as foreign link..... | 28 | +| 5.7 | Inter-access flow mobility ..... | 28 | +| 5.7.1 | General ..... | 28 | +| 5.7.2 | UE procedures ..... | 28 | +| 5.7.3 | HA procedures..... | 29 | +| 5.8 | UE-initiated removal of an access network from a PDN connection ..... | 30 | +| 5.8.1 | General ..... | 30 | +| 5.8.2 | UE procedures ..... | 30 | +| 5.8.2.1 | General..... | 30 | +| 5.8.2.2 | Removal of Home link access ..... | 30 | +| 5.8.2.3 | Removal of foreign link from a PDN connection..... | 30 | +| 5.8.3 | HA procedures..... | 31 | +| 5.8.3.1 | General..... | 31 | +| 5.8.3.2 | Removal of home link access from a PDN connection ..... | 31 | +| 5.8.3.3 | Removal of foreign link from a PDN connection..... | 31 | +| 5.9 | Network-initiated removal of an access network from a PDN connection..... | 31 | +| 5.9.1 | General ..... | 31 | +| 5.9.2 | UE procedures ..... | 31 | +| 5.9.2.1 | General..... | 31 | +| 5.9.2.2 | Removal of home link access from a PDN connection ..... | 32 | +| 5.9.2.3 | Removal of foreign link from a PDN connection..... | 32 | +| 5.9.3 | HA procedures..... | 32 | +| 5.9.3.1 | General..... | 32 | +| 5.9.3.2 | Removal of home link access from a PDN connection ..... | 32 | +| 5.9.3.3 | Removal of foreign link from a PDN connection..... | 32 | +| Annex A (normative): | Message Details..... | 33 | +| A.1 | General..... | 33 | +| A.2 | Initial Binding Registration..... | 33 | +| A.2.1 | Binding Update ..... | 33 | +| A.2.2 | Binding Acknowledgement..... | 34 | +| A.2.3 | Binding Error..... | 35 | +| A.3 | Re-Registration ..... | 35 | +| A.3.1 | Binding Update ..... | 35 | +| A.3.2 | Binding Acknowledgement..... | 36 | +| A.4 | Handover..... | 37 | +| A.4.1 | Binding Update ..... | 37 | +| A.4.2 | Binding Acknowledgement..... | 38 | +| A.5 | UE-initiated Detach..... | 39 | +| A.5.1 | Binding Update ..... | 39 | +| A.5.2 | Binding Acknowledgement..... | 40 | +| A.6 | Network-initiated detach..... | 41 | +| A.6.1 | Binding Revocation Indication Message..... | 41 | +| A.6.2 | Binding Revocation Acknowledgement..... | 41 | +| A.7 | Void..... | 41 | +| A.8 | Attach to an additional access network..... | 41 | +| A.8.1 | Binding Update ..... | 41 | +| A.8.2 | Binding Acknowledgement..... | 42 | + +| | | | +|-----------------------------|---------------------------------------------------------------------------|-----------| +| A.9 | Inter-access flow mobility..... | 43 | +| A.9.1 | Binding Update ..... | 43 | +| A.9.2 | Binding Acknowledgement..... | 45 | +| A.10 | UE-initiated removal of an access network from a PDN connection ..... | 45 | +| A.10.1 | Binding Update ..... | 45 | +| A.10.2 | Binding Acknowledgement..... | 46 | +| A.11 | Network-initiated removal of an access network from a PDN connection..... | 47 | +| A.11.1 | Binding Revocation Indication Message..... | 47 | +| A.11.2 | Binding Revocation Acknowledgement..... | 48 | +| Annex B (normative): | Extensions specific to the present document..... | 49 | +| B.1 | PDN Identifier notify payload..... | 49 | +| B.2 | IFOM Capability notify payload..... | 49 | +| Annex C (informative): | Change history..... | 50 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the signalling procedures for accessing the 3GPP Evolved Packet Core network and handling the mobility between 3GPP and non-3GPP accesses via the S2c reference point defined in 3GPP TS 23.402 [3]. + +The present document is applicable to the User Equipment (UE) and the network node implementing the Home Agent functionality. + +In addition the present document specifies the procedures used for the DSMIPv6 Home Agent discovery, for bootstrapping the DSMIPv6 security association between the UE and the Home Agent and for managing the DSMIPv6 tunnel. The specification of these procedures is compliant to IETF RFCs. + +DSMIPv6 procedures can be used independently of the underlying access technology. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 5555 (June 2009): "Mobile IPv6 support for Dual Stack Hosts and Routers". +- [3] 3GPP TS 23.402: "Architecture Enhancements for non-3GPP accesses". +- [4] IETF RFC 4877 (April 2007): "Mobile IPv6 Operation with IKEv2 and the Revised IPsec Architecture". +- [5] Void. +- [6] Void. +- [7] Void. +- [8] Void. +- [9] Void. +- [10] IETF RFC 5026 (October 2007): "Mobile IPv6 bootstrapping in split scenario". +- [11] IETF RFC 4303 (December 2005): "IP Encapsulating Security Payload (ESP)". +- [12] IETF RFC 6610 (May 2012): "DHCP Options for Home Information Discovery in Mobile IPv6 (MIPv6)". +- [13] IETF RFC 3736 (April 2004): "Stateless Dynamic Host Configuration Protocol (DHCP) Service for IPv6". +- [14] IETF RFC 5996 (September 2010): "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [15] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [16] Void. + +- [17] 3GPP TS 23.003: "Numbering, addressing and identification". +- [18] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [19] IETF RFC 5846 (June 2010): "Binding Revocation for IPv6 Mobility". +- [20] 3GPP TS 29.273: "3GPP EPS AAA interfaces". +- [21] 3GPP TS 24.302: "Access to the Evolved Packet Core (EPC) via non-3GPP access networks; Stage 3". +- [22] Void. +- [23] IETF RFC 4739 (November 2006): "Multiple Authentication Exchanges in the Internet Key Exchange (IKEv2) Protocol". +- [24] 3GPP TS 33.234: "Wireless Local Area Network (WLAN) interworking security". +- [25] Void. +- [26] IETF RFC 4039 (March 2005): "Rapid Commit Option for the Dynamic Host Configuration Protocol version 4 (DHCPv4)". +- [27] IETF RFC 6275 (July 2011): "Mobility Support in IPv6". +- [28] IETF RFC 4187 (January 2006): "Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP AKA)". +- [29] IETF RFC 3963 (January 2005): "Network Mobility (NEMO) Basic Support Protocol". +- [30] IETF RFC 5685 (November 2009): "Redirect Mechanism for the Internet Key Exchange Protocol Version 2 (IKEv2)". +- [31] IETF RFC 5648 (October 2009): "Multiple Care-of Addresses Registration". +- [32] IETF RFC 6089 (January 2011): "Flow Bindings in Mobile IPv6 and Network Mobility (NEMO) Basic Support". +- [33] IETF RFC 6088 (January 2011): "Traffic Selectors for Flow Bindings". +- [34] 3GPP TS 23.261: "IP flow mobility and seamless Wireless Local Area Network (WLAN) offload; Stage 2". +- [35] IETF RFC 6276 (July 2011): "DHCPv6 Prefix Delegation for Network Mobility (NEMO)". +- [36] 3GPP TS 24.312: "Access Network Discovery and Selection Function (ANDSF) Management Object (MO)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. The following terms used in this Technical Specification are defined in IETF RFC 6275 [27]: Home Address, Care-of Address, binding cache, binding cache entry. + +The following terms used in this Technical Specification are defined in IETF RFC 5648 [31], and IETF RFC 6089 [32]: Binding Identification Number, Flow, Flow Binding, Flow Identifier, and Traffic Selector. + +The following term used in this Technical Specification is defined in 3GPP TS 23.402 [3]: IFOM capable UE. + +The following terms used in this Technical Specification are defined in 3GPP TS 23.261 [34]: routing address, routing filter, routing rule. + +**Home network prefix:** An IPv6 prefix allocated by the Home Agent to the UE and used by the UE to configure the Home Address. The Home network prefix is uniquely allocated to a UE. + +**Home Agent:** The Home Agent functionality consists in the DSMIPv6 anchor point functionality described in IETF RFC 5555 [2] and IETF RFC 4877 [4]. Based on 3GPP TS 23.402 [3] the HA functionality is implemented in the PDN Gateway. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. + +| | | +|---------|-------------------------------| +| BID | Binding Identification Number | +| DSMIPv6 | Dual-Stack MIPv6 | +| EPC | Evolved Packet Core | +| ePDG | Evolved Packet Data Gateway | +| EPS | Evolved Packet System | +| FID | Flow Identifier | +| GW | Gateway | +| HA | Home Agent | +| MIPv6 | Mobile IP version 6 | +| TSi | Traffic Selector - Initiator | +| TSr | Traffic Selector - Responder | +| UE | User Equipment | + +# --- 4 General + +## 4.1 Mobility management based on Dual-Stack Mobile IPv6 + +DSMIPv6 is specified in IETF RFC 6275 [27] and IETF RFC 5555 [2]. The purpose of the DSMIPv6 procedures is to establish, manage and tear down a mobility tunnel between the UE and the HA function. The mobility tunnel establishment is always initiated by the UE, while the mobility tunnel tear down can be initiated either by the UE or the network. Communication between the UE and a correspondent node shall use the bidirectional mode of operation. Route optimization mode of operation is not supported by EPC in this release. + +In this specification, the IETF RFC 4877 [4] is used to secure DSMIPv6 signalling. For this purpose, the UE performs an IKEv2 exchange with the HA before establishing the mobility tunnel as described in subclause 5.1.2.2. The details of the security aspects are specified in 3GPP TS 33.402 [18]. + +The mobility tunnel procedures are performed by the UE for each PDN connection, meaning that if multiple PDNs are accessed by the UE, multiple instances of the procedures are needed. The multiple PDN connections behaviour is specified more in detail in subclause 4.3. + +In this specification, the IETF RFC 3963 [29] is used for prefix preservation. For this purpose, the UE uses the implicit mode as stated in IETF RFC 3963 [29] to tell the HA that the home network prefix would be preserved during mobility. The support of this operation is limited to the sending and receiving of IPv6 packets containing IPv6 addresses auto-configured from the home network prefix, in addition to the IPv6 Home Address. + +In this specification, the IETF RFC 5648 [31], IETF RFC 6089 [32] and IETF RFC 6088 [33] are used for IFOM. The general principles of IFOM are listed in 3GPP TS 23.261 [34]. For this purpose, the UE can decide if IFOM is to be applied to a PDN connection. The procedures used by the UE to determine which PDN connection IFOM is to be applied and how the IP flows are distributed are specified in 3GPP TS 24.302 [21]. + +## 4.2 Identities + +The UE shall use Network Access Identifier (NAI) as identification towards the HA in the IKEv2 exchange. During this process, the IPsec security association between the UE and the HA is tied to the user identity, set to the NAI, and to an SPI uniquely identifying this security association. The NAI is structured according to 3GPP TS 23.003 [17]. The NAI can be either a root NAI, a fast re-authentication NAI or pseudonym identity as specified in 3GPP TS 23.003 [17]. + +The UE shall use the HA-APN to identify the desired HA in the DNS-based and DHCPv6-based HA discovery procedures. The HA-APN is constructed according to 3GPP TS 23.003 [17]. + +NOTE: The operator is responsible to configure the DNS system so that the same PDN GW can be discovered via HA-APN and APN. A possible way of configuring the mapping between HA-APN and APN is to create the HA-APN from the respective APN by using the same Network Identifier and by adding the prefix "ha-apn" to the Operator Identifier. + +The Binding Update and Binding Acknowledgement shall not explicitly carry an NAI as the IPsec security association is tied to the user identity. + +## 4.3 Multiple PDN connectivity + +This specification supports multiple PDN connectivity. The UE can setup multiple PDN connections with a given APN or multiple APNs using multiple DSMIPv6 sessions. There is one DSMIPv6 session per each PDN connection. + +NOTE: When a UE is associated to multiple PDN connections, it is possible for the UE to create a tunnel loop amongst the HAs by binding home addresses to each other. This results in the possibility of HA being flooded with packets. Packet flooding is not specific to DSMIPv6 and there exist current implementations to deal with the packet flooding issue. As for the formation of tunnel loop, the solution to solve it in this current specification (Release 9) is implementation specific until a standardized solution emerges. + +The procedures described in clause 5 shall be interpreted as procedures which are executed for each PDN connection the UE established. This implies that: + +- For the initial attachment of a PDN connection, the UE shall perform a Home Agent address discovery (subclause 5.1.2.1), a security association establishment via IKEv2, including the EAP-AKA authentication and the IPv6 Home Network Prefix assignment (subclause 5.1.2.2), and the initial binding registration (subclause 5.1.2.4). +- The handover procedure shall be performed for each PDN connection separately as described in subclause 5.2.2. +- The re-registration procedure shall be performed for each PDN connection separately as described in subclause 5.3.2. +- The detach procedure shall be performed for each PDN connection separately as described in subclause 5.4.2 or in subclause 5.4.3. + +In addition to the above procedures, the following procedures described for an IFOM capable UE configured for IFOM shall be interpreted as procedures which are executed for each PDN connection that the UE has decided to apply the IFOM procedures. This implies that: + +- The attach to additional access network procedure, as described in subclause 5.6.2, shall be performed by the UE separately for each PDN connection to which the access is to be added. +- The inter-access flow mobility procedure, as described in subclause 5.7.2, shall be performed by the UE separately for each PDN connection when IP flows are to be moved amongst access networks. +- The removal of an access network procedure, as described in subclause 5.8.2, shall be performed by the UE separately for each PDN connection using the access network to be removed. + +# --- 5 Dual-Stack Mobile IPv6 Procedures + +## 5.1 Dual-Stack Mobile IPv6 initial attach + +### 5.1.1 General + +The DSMIPv6 initial attach is performed by the UE to establish a DSMIPv6 connection with the node acting as HA. This is also known as the bootstrapping procedure as the UE establishes the security association with the HA. The initial attach involves the following tasks: + +- **Discovery of the Home Agent address.** The UE needs to discover the IPv6 address as well as the IPv4 address of the HA. + +- **Security association establishment.** The UE needs to establish an IPsec security association with the HA in order to secure the DSMIPv6 signalling. IKEv2 (IETF RFC 4877 [4]) is used to establish this security association. +- **IPv6 Home Network Prefix assignment.** The UE needs to be assigned an IPv6 Network Prefix of its home network in order to configure the global unicast Home Address to be used in DSMIPv6. The HA is responsible of assigning the IPv6 Home Network Prefix to the UE. +- **IPv4 Home Address assignment.** Optionally, a dual-stack UE can also request to be assigned an IPv4 Home Address to be used for IPv4-only applications. The HA is responsible of assigning the IPv4 Home Address to the UE. +- **Home link detection.** The UE needs to perform Home Link Detection before initiate registration with the HA. The DSMIPv6 Home Link Detection Function is used by the UE to detect if it is attached to the home link from a DSMIPv6 perspective. +- **Initial binding registration.** Unless the home link detection procedure indicates the UE is at home, the UE sends a Binding Update message to perform its initial registration with the HA. + +If the UE is an IFOM capable UE the DSMIPv6 initial attach involves also the IFOM capability discovery. + +If the UE requires additional configuration parameters, e.g. Vendor-specific options, stateless DHCPv4 and DHCPv6 as defined in IETF RFC 4039 [26] and IETF RFC 3736 [13] can be run over the DSMIPv6 tunnel. + +### 5.1.2 UE procedures + +#### 5.1.2.1 Discovery of the Home Agent address + +##### 5.1.2.1.1 General + +The first procedure the UE needs to perform for DSMIPv6 initial attach is the discovery of the node acting as the HA. + +The UE can discover the IP addresses of the HA in one of the four following ways: + +- via DNS; +- via attach procedure for 3GPP access or trusted non-3GPP access (if supported) based on protocol configuration options; +- via IKEv2 during tunnel setup to ePDG for untrusted non-3GPP accesses; +- via DHCPv6. + +If the UE does not obtain the IP addresses of the HA via PCO during the 3GPP or trusted non-3GPP (if supported) attach or via IKEv2 signalling, it shall follow either the procedures described in subclause 5.1.2.1.5 or the procedures described in subclause 5.1.2.1.2. The UE may be configured to perform both procedures in parallel or one of the two procedures only in case the other failed. + +##### 5.1.2.1.2 Home agent address discovery based on DNS + +A UE performing Home Agent discovery based on DNS shall support the implementation of standard DNS mechanisms. + +The UE shall perform DNS Lookup by Home Agent Name as specified in IETF RFC 5026 [10]. The QNAME shall be set to the requested HA-APN. The HA-APN shall be constructed as specified in 3GPP TS 23.003 [17]. If a HA has both an IPv4 and an IPv6 address, the corresponding DNS record should be configured with both 'AAAA' and 'A' records. Accordingly the UE should perform one DNS lookup procedure to retrieve both 'AAAA' and 'A' records. The DNS server replies with one 'AAAA' and one 'A' record. + +##### 5.1.2.1.3 Home agent address discovery based on protocol configuration options + +The UE may request the IPv6 address and optionally the IPv4 address of the dual stack HA using the Protocol configuration options IE during the attach procedure for 3GPP or trusted non-3GPP access or the additional PDN connectivity procedure. The details of this procedure for the case of attach for 3GPP access are described in + +3GPP TS 24.301 [15]. The details of this procedure for the case of attach for trusted non-3GPP access are described in 3GPP TS 24.302 [21]. + +##### 5.1.2.1.4 Home agent address discovery based on IKEv2 signalling + +The UE may request the IPv6 and optionally the IPv4 address of the HA during the tunnel establishment procedure with the ePDG. The details of this procedure are described in 3GPP TS 24.302 [21]. + +##### 5.1.2.1.5 Home agent address discovery based on DHCPv6 + +The HA address discovery via DHCPv6 is possible in the following cases: + +- in 3GPP access, or +- in trusted non-3GPP access, when a DHCPv6 relay exists in the trusted non-3GPP access and the PDN GW is the DHCPv6 server, or +- in trusted non-3GPP access, when the DHCPv6 server is in the trusted non-3GPP access and it has the HA address information from static configuration, or received via STa reference point as specified in 3GPP TS 29.273 [20]. + +A UE performing HA discovery based on DHCPv6 shall support the implementation of stateless DHCPv6 as specified in IETF RFC 3736 [13] and the DHCPv6 options as specified in IETF RFC 6610 [12]. + +In order to discover the address of the HA the UE shall send an Information-Request message including the "MIP6 Home Network ID FQDN Option" as described in IETF RFC 6610 [12]. + +In order to connect to a HA for a specific target PDN, the UE shall include the desired HA-APN in the Home Network Identification FQDN field contained in the "MIP6 Home Network ID FQDN Option" as described in IETF RFC 6610 [12]. + +NOTE: The new options described in IETF RFC 6610 [12] are applicable to DSMIPv6. + +The HA information is provided to the UE as described in IETF RFC 6610 [12] in the sub-option contained in the "MIP6 Identified Home Network Information Option". The sub-option can be: + +- a "MIP6 Home Agent Address Network Information Option" (the IPv6 address and if available, the IPv4 address of the HA); or +- a "MIP6 Home Agent FQDN Network Information Option" (the HA FQDN) as described in IETF RFC 6610 [12]. + +In the latter case the UE shall perform a DNS Lookup by Home Agent Name as specified in IETF RFC 5026 [10]. The QNAME shall be set to the received HA FQDN. + +If a HA has both an IPv4 and an IPv6 address, the corresponding DNS record should be configured with both 'AAAA' and 'A' records. Accordingly the UE should perform one DNS lookup procedure to retrieve both 'AAAA' and 'A' records. The DNS server replies with one 'AAAA' and one 'A' record. + +##### 5.1.2.1a IFOM capability discovery + +An IFOM capable UE shall perform HA IFOM capability discovery, i.e. an IFOM capable UE shall discover whether the HA supports IFOM or not. The HA IFOM capability can be performed using the following methods: + +- as part of attach procedure for 3GPP access based on protocol configuration options; +- as part of a IKEv2 tunnel setup procedure with the HA; or +- using the information received from ANDSF. + +The IFOM capable UE shall support HA IFOM capability discovery performed through IKEv2 tunnel setup procedure. The HA IFOM capability discovery performed within IKEv2 tunnel setup procedure with the HA is described in subclause 5.1.2.2. + +If the IFOM capable UE supports IPv6 Home Network Prefix assignment via PCO, the IFOM capable UE shall support HA IFOM capability discovery via PCO. + +The IFOM capable UE may use inter system routing policies (see 3GPP TS 24.302 [21] and 3GPP TS 24.312 [36]) to perform the HA IFOM capability discovery for a specific APN. If the IFOM capable UE uses inter system routing policies to perform HA IFOM capability discovery, the UE may skip performing the HA IFOM capability discovery via PCO or the HA IFOM capability discovery via IKEv2. + +#### 5.1.2.2 Security association establishment and IPv6 Home Network Prefix assignment + +The UE shall support the IKEv2 protocol (see IETF RFC 5996 [14]) for negotiating the IPsec security association to secure DSMIPv6 signalling and shall support EAP over IKEv2 as described in IETF RFC 5996 [14] to perform authentication with an AAA server. In a case an additional authentication and authorization of the IPsec security association is needed with an external AAA server, then the additional authentication steps during the IKEv2 exchange shall be supported as specified in IETF RFC 4739 [23] and the UE shall follow the WLAN UE procedure described in 3GPP TS 33.234 [24]. + +The UE shall support IPsec ESP (see IETF RFC 4303 [11]) in order to provide authentication of Binding Update and Binding Acknowledgement messages as specified in IETF RFC 4877 [4]. The UE shall support multiple authentication exchanges in the IKEv2 protocol as specified in IETF RFC 4739 [23] in order to support authentication with an external AAA server. The UE shall support the redirect mechanism as defined in IETF RFC 5685 [30]. + +The UE shall initiate the security association establishment procedure by sending the IKE\_SA\_INIT request message defined in IETF RFC 5996 [14] to the HA. The UE shall indicate support for the HA reallocation by including a REDIRECT\_SUPPORTED payload in the IKE\_SA\_INIT request as specified in IETF RFC 5685[30]. On receipt of an IKE\_SA\_INIT response, the UE shall send an IKE\_AUTH request message including the MN-NAI in the IDi payload and the Access Point Name (APN) of the target PDN the UE wants to connect to in the IDr payload. The APN shall be formatted as defined in 3GPP TS 23.003 [17]. The username part of the MN-NAI included in "IDi" payload may be an IMSI, pseudonym or re-authentication ID. The UE shall include in the IDi payload the same MN-NAI it includes in the EAP-Response/Identity within the EAP-AKA exchange. + +In the very first EAP-Response/Identity within the IKEv2 exchange the UE shall include a NAI whose username is derived from IMSI. In subsequent exchanges the UE should use pseudonyms and re-authentication identities provided by the 3GPP AAA server as specified in IETF RFC 4187 [28]. + +NOTE: Fast re-authentication mechanism is optional, and therefore is an implementation option in the UE and operator configuration issue (i.e. it also depends on whether the AAA server sent a re-authentication ID during previous EAP authentication) whether to use it during security association establishment. + +EAP-AKA over IKEv2 shall be used to authenticate UE in the IKE\_AUTH exchange, while public key signature based authentication with certificates shall be used to authenticate the HA. + +During the IKEv2 exchange, the HA may trigger the UE to perform the HA reallocation procedure. If the UE receives as part of the IKE\_AUTH response message a REDIRECT payload containing the IP address of a target HA as specified in subclause 5.1.3.1, the UE shall initiate a new IKEv2 security association with the target HA. The UE shall terminate the IKEv2 security association with the initial HA by sending an IKEv2 Informational message with a DELETE payload as specified in IETF RFC 5996 [14]. + +During the IKEv2 exchange, the UE shall request the allocation of an IPv6 home prefix through the Configuration Payload in the IKE\_AUTH request message. Since in EPS a unique IPv6 prefix is assigned to the UE, the UE shall include a MIP6\_HOME\_PREFIX attribute in the CFG\_REQUEST payload of the IKE\_AUTH request message as described in IETF RFC 5026 [10]. In addition the UE may include the INTERNAL\_IP6\_DNS attribute in the CFG\_REQUEST as described in IETF RFC 5996 [14] to request the DNS server IPv6 address of the PLMN it is connecting to via DSMIPv6. In the same way the UE may include the INTERNAL\_IP4\_DNS attribute in the CFG\_REQUEST payload to request the IPv4 address of the DNS server. + +During the IKEv2 exchange, if the UE receives an IKE\_AUTH response message containing a Notify Payload with a Private Notify Message Type MAX\_CONNECTION\_REACHED as specified in 3GPP TS 24.302 [21], the UE shall close the related IKEv2 security association states. As long as none of existing IKEv2 security association is released, the UE shall not attempt to establish any additional IKEv2 security association. + +The UE shall then auto-configure a Home Address from the IPv6 prefix received from the HA and shall run a CREATE\_CHILD\_SA exchange to create the security association for the new Home Address. In the CREATE\_CHILD\_SA exchange the UE shall include the Home Address and the appropriate selectors in the TSi (Traffic Selector-initiator) payload to negotiate the IPsec security association for protecting the Binding Update and Binding Acknowledgement messages as specified in IETF RFC 4877 [4]. + +If the UE knows the IPv6 Home Network Prefix of a PDN connection for which the security association is to be setup, the UE shall insert a PDN Identifier notify payload, as defined in annex B, in the IKE\_AUTH request message. The PDN Identifier notify payload shall contain the IPv6 Home Network Prefix of the PDN connection for which the security association is being set up. If the UE does not know the IPv6 Home Network Prefix of the PDN connection for which the security association is to be set up, the UE shall not include the PDN Identifier notify payload in the IKE\_AUTH request message. + +If an IFOM capable UE performs HA IFOM capability discovery via IKEv2 procedure, the IFOM capable UE shall include the IFOM Capability notify payload (as specified in the Annex B.2) in the IKE\_SA\_INIT request message to perform HA IFOM capability discovery. If the IFOM capable UE receives in the IKE\_SA\_INIT response message the IFOM Capability notify payload, the IFOM capable UE shall behave as an IFOM capable UE configured for IFOM as the received payload indicates that the HA supports IFOM. If the IFOM capable UE does not receive in the IKE\_SA\_INIT response message the IFOM Capability notify payload, the IFOM capable UE shall behave as a UE which is not IFOM capable as the received payload indicates that the HA does not support IFOM. + +#### 5.1.2.3 Home Link Detection + +The DSMIPv6 Home Link Detection Function is used by the UE to detect if an access interface is on the home link for a PDN connection from a DSMIPv6 perspective. The Home Link Detection function shall be performed before sending DSMIPv6 Binding Update via the same access interface. + +To perform the Home Link Detection procedure, the UE shall compare the assigned Home Network Prefix for a PDN connection with the IPv6 prefix or prefixes included in the Prefix Information Option in the Router Advertisements received on the local link. The Home Network Prefix can be assigned in a 3GPP access via PCO, as specified in 3GPP TS 24.301 [15], or via IKEv2 as specified in subclause 5.1.2.2. If there is a match between the Home Network Prefix and one of the local prefixes, the UE is attached on the home link over the respective access interface and shall not send a Binding Update to the HA unless the UE currently has a valid DSMIPv6 Binding Update list entry. If the UE has a valid DSMIPv6 Binding Update list entry, the UE shall proceed to perform the action specified in subclause 5.2.2.4. If there is not any match, the UE shall proceed as specified in subclause 5.1.2.4. + +NOTE: The UE does not need to run IKEv2 for home link detection if the Home Network prefix is dynamically received in a PCO Information Element. + +If the IFOM capable UE performs the Home Network Prefix assignment via Protocol Configuration Option, the IFOM capable UE shall perform in the PDN CONNECTIVITY REQUEST message both Home Network Prefix assignment and the IFOM capability discovery. + +#### 5.1.2.4 Initial binding registration and IPv4 Home Address assignment + +After establishing the security association and obtaining the IPv6 Home Address, the UE shall send a Binding Update message as specified in IETF RFC 6275 [27] and IETF RFC 5555 [2] in order to register its Home Address and Care-of Address at the HA, if it detects it is in the foreign network. + +If both IPv4 and IPv6 Care-of Address are received at the foreign network, the UE shall first attempt to use the IPv6 Care-of Address for its binding registration. + +If IPv6 Care-of Address is used for initial binding registration, the UE shall send the Binding Update message to the IPv6 address of the HA. In this Binding Update message the H (home registration) and A (acknowledge) bits shall be set. If the UE needs an IPv4 Home Address, the UE shall include the 0.0.0.0 address in the IPv4 Home Address option to request a dynamic IPv4 Home Address. + +When IPv6 Care-of Address is used for initial binding registration, the Alternate Care-of Address option shall be used by the UE to carry the Care-of Address inside a Mobility Header which is protected by ESP. If this option is present, the address included in this option is the same address present in the source address of the IPv6 packet. The Alternate Care-of Address option shall not be included if a BID mobility option is added in the same Binding Update message. + +If IPv4 Care-of Address is used for initial binding registration, the UE shall send the Binding Update as follows (see IETF RFC 5555 [2]): + +- The IPv6 packet, with the IPv6 Home Address as the Source Address field of the IPv6 header, shall be encapsulated in UDP. +- The UE shall include the IPv4 Care-of Address as the Source Address field of the IPv4 header and the HA IPv4 address as the Destination Address field of the IPv4 header. + +- The UE shall include the IPv4 Care-of Address option containing the IPv4 Care-of Address. The IPv4 Care-of Address option shall not be included if a BID mobility option is added in the same Binding Update message. +- The UE shall set the H (home registration) and A (acknowledge) flags. +- The UE shall set the F (UDP encapsulation required) flag to 0. +- The UE shall set the R (Mobile Router Flag) flag to 1. +- If the UE needs an IPv4 Home Address, the UE shall include an IPv4 Home Address option with the 0.0.0.0 address in the Binding Update message, as defined in IETF RFC 5555 [2]. + +If the UE is an IFOM capable UE configured for IFOM, the UE extends the Binding Update with the following options: + +- a) The UE shall set the O (Overwrite) flag to "1"; +- b) The UE shall include a BID identifier mobility option in the Binding Update as specified in IETF RFC 5648 [31]; + - The UE shall set the BID-PRI field to assign the priority to the BID as indicated in IETF RFC 6089 [32]; and +- c) The UE may create one or more routing rules with the HA. For each routing rule that the UE wants to register with the HA, the UE shall include a FID mobility option containing one traffic selector as specified in IETF RFC 6089 [32]. + - The FID field shall be set to an arbitrary value; + - The FID-PRI field shall be set to the assigned priority of the FID as indicated in IETF RFC 6089 [32]; + - A Binding Reference suboption shall be included as defined in IETF RFC 6089 [32]. As indicated in IETF RFC 6089 [32] the value assigned to the BID is the same included in the BID mobility option included in the Binding Update; and + - Traffic selector suboption shall be set as specified in IETF RFC 6089 [32] and IETF RFC 6088 [33]. The parameters described in the traffic selector suboption represent the routing filter that corresponds to the routing rule that the UE wants to register with the HA. + +According to IETF RFC 6089 [32], traffic selector suboption contains parameters identifying downlink traffic, hence routing rules registered with the HA bind either a Care-of Address or a Home Address to the downlink traffic. The same bound IP address shall be used by the IFOM capable UE configured for IFOM to route the corresponding uplink traffic (i.e. asymmetrical routing is not allowed in this version of the specification). + +When the UE receives the Binding Acknowledgement from the HA, it shall validate it based on the rules described in IETF RFC 6275 [27] and IETF RFC 5555 [2]. If the Binding Acknowledgement contains the successful status code 0 ("Binding Update Accepted"), the UE shall create an entry for the registered Home Address in its Binding Update List and may start sending packets containing its IPv6 Home Address or other IPv6 addresses auto-configured from the assigned home network prefix. + +If the Binding Acknowledgement contains a value of 128, the UE may re-send the BU as specified in IETF RFC 6275 [27]. If the Binding Acknowledgement contains a value from 129 to 133 as specified in IETF RFC 6275 [27] or a value from 140 to 143 as specified in IETF RFC 3963 [29], the UE shall not send the BU to the HA and should discover another HA. + +If the Binding Acknowledgement contains an IPv4 Address Acknowledgement option with status code value from 0 to 127 (indicating success), the UE shall create two entries in its Binding Update List, one for the IPv6 Home Address and another for the IPv4 Home Address. If the Binding Acknowledgement contains an IPv4 Address Acknowledgement option with status code indicating error (i.e. 128 or higher), the UE shall create an entry only for the IPv6 HoA in its binding update list. Moreover, if the status code is 129 ("Administratively prohibited") or 132 ("Dynamic IPv4 home address assignment not available"), the UE shall not re-send the Binding Update and it shall use only the IPv6 HoA. If the Binding Acknowledgement contains an IPv4 Address Acknowledgement option with status 128 ("Failure, reason unspecified"), 130 ("Incorrect IPv4 home address"), 131 ("Invalid IPv4 address") or 133 ("Prefix allocation unauthorized") it shall re-send the Binding Update including the 0.0.0.0 address in the IPv4 Home Address option. If the Binding Acknowledgement does not contain an IPv4 Address Acknowledgement option, the UE shall create an entry only for the IPv6 HoA in its binding update list. + +NOTE 1: The value to be used to identify the IPv4 address acknowledgement option in the mobility header is 30; + +If the Binding Acknowledgment contains a BID mobility option, the UE shall process it as specified in IETF RFC 5648 [31]. If the Binding Acknowledgment contains one or more flow mobility options, the UE shall process it as specified in IETF RFC 6089 [32]. + +If the status field of the BID mobility option is set to zero, the IFOM capable UE configured for IFOM applies to every examined BID option the status code contained in the status field of the Binding Acknowledgement message as indicated in IETF RFC 5648 [31]. If the value of the status field assigned to a BID mobility option is equal to 4 ("MCOA NOTCOMPLETE"), 164 ("MCOA MALFORMED"), 165 ("MCOA NON-MCOA") or 167 ("MCOA UNKNOWN COA"), the IFOM capable UE configured for IFOM performs the operations described in IETF RFC 5648 [31]. + +NOTE 2: the above error cases, e.g. 165 ("MCOA NON-MCOA BINDING EXISTS"), that do not apply to the case of initial attach can apply to other use cases (e.g. attach to additional access). + +When processing a FID mobility option, if the value of the status field of the FID mobility option is 129 ("Flow binding rejected"), 130 ("Flow identification mobility option malformed"), 131 ("BID not found") or 132 ("FID not found"), the IFOM capable UE configured for IFOM performs the operations described in IETF RFC 6089 [32]. + +The UE may then send data traffic either with the IPv6 Home Address or with the IPv4 Home Address. If the UE is located on an IPv6-enabled link, it shall send IPv6 packets as described in IETF RFC 6275 [27]; IPv4 traffic shall be encapsulated in IPv6 packets as described in IETF RFC 5555 [2]. If the UE is located on an IPv4-only link and the Binding Acknowledgement contains the NAT detection option with the F flag set, the UE shall send IPv6 and IPv4 packets following the vanilla UDP encapsulation rules specified in IETF RFC 5555 [2]. Otherwise the UE shall send IPv6 and IPv4 packets encapsulated in IPv4 as specified in IETF RFC 5555 [2]. + +Once the DSMIPv6 tunnel is established, the UE may build a DHCPv4 or DHCPv6 message as described in IETF RFC 4039 [26] or IETF RFC 3736 [13] respectively and send it via the DSMIPv6 tunnel as described in IETF RFC 6275 [27] in order to retrieve additional parameters, e.g. Vendor-specific options. The UE may also request additional IPv6 prefix(es) with length of /64 or shorter by using DHCPv6 Prefix Delegation as defined in IETF RFC 6276 [35]. + +### 5.1.3 HA procedures + +#### 5.1.3.1 Security association establishment and IPv6 Home Network Prefix assignment + +The HA shall support the IKEv2 protocol (see IETF RFC 5996 [14]) for negotiating the IPsec security association to secure DSMIPv6 signalling and shall support EAP over IKEv2 as described in IETF RFC 5996 [14] to perform UE authentication with an AAA server. If an additional authentication and authorization of the IPsec security association were needed with an external AAA server, then the additional authentication steps during the IKEv2 exchange shall be supported as specified in IETF RFC 4739 [23] and the HA shall follow the PDG procedure defined in 3GPP TS 33.234 [24]. + +The HA shall support IPsec ESP (see IETF RFC 4303 [11]) in order to provide authentication of Binding Update and Binding Acknowledgement messages as specified in IETF RFC 4877 [4]. The HA shall support multiple authentication exchanges in the IKEv2 protocol as specified in IETF RFC 4739 [23] in order to support authentication with an external AAA server. + +The HA shall complete the IKE\_SA\_INIT exchange as specified in IETF RFC 5996 [14]. The HA shall include in the IDr the same value included by the UE in the IDr payload of the request. + +Upon successful authorization and authentication, the HA shall accept the security association establishment request by sending the IKE\_AUTH response message with the CFG\_REPLY payload including the IPv6 Home Network Prefix allocated to the UE in the MIP6\_HOME\_PREFIX attribute. This prefix information shall include the prefix length as specified in IETF RFC 5026 [10]. If the UE included the INTERNAL\_IP6\_DNS or the INTERNAL\_IP4\_DNS in the CFG\_REQUEST payload, the HA shall include the same attribute in the CFG\_REPLY payload including zero or more DNS server addresses as specified in IETF RFC 5996 [14]. + +If the HA needs to reject a IKEv2 security association establishment due to the network policies or capabilities to indicate that no more IKEv2 security association establishment request with any APN can be accepted for the UE, the HA shall include in the IKE\_AUTH response message containing the IDr payload a Notify Payload with a Private Notify Message Type MAX\_CONNECTION\_REACHED as specified in 3GPP TS 24.302 [21]. + +If the UE included a PDN Identifier notify payload within the IKE\_AUTH request message, the HA may apply the following procedure: + +- 1) Process the PDN Identifier notify payload according to IETF RFC 5996 [14]; and +- 2) Use the IPv6 prefix contained in the payload to identify the PDN connection for which the security association is being set up and + - if the HA is able to identify the PDN connection for which the security association is being set up, the HA shall insert the previously assigned IPv6 Home Network Prefix in the MIP6\_HOME\_PREFIX attribute in the CFG\_REPLY payload; or + - if the HA is not able to identify the PDN connection for which the security association is being set up, the HA shall ignore the content of the received PDN Identifier notify payload and allocate an IPv6 Home Network Prefix as described below. + +When allocating an IPv6 Home Network Prefix, the HA shall apply one of the following procedures: + +- If the IKEv2 message is received over an existing PDN connection, the assigned IPv6 network prefix of the PDN connection shall be sent to the UE as IPv6 Home Network Prefix in the MIP6\_HOME\_PREFIX attribute; or, +- If the IKEv2 message is not received over an existing PDN connection, and the UE has an existing PDN connection which has no IPSec security association established, the assigned IPv6 network prefix of the PDN connection shall be sent to the UE as IPv6 Home Network Prefix in the MIP6\_HOME\_PREFIX attribute; or, +- If the IKEv2 message is not received over an existing PDN connection, and the UE does not have an existing PDN connection which has no IPSec security association established, a new IPv6 network prefix shall be allocated and sent to the UE as IPv6 Home Network Prefix in the MIP6\_HOME\_PREFIX attribute. + +An IFOM capable Home Agent shall implement the IFOM Capability notify payload. If the UE included the IFOM Capability notify payload within the IKE\_SA\_INIT request message, the HA shall perform the following procedures: + +- process the IFOM Capability notify payload according to IETF RFC 5996 [14]; +- if the HA is IFOM capable, the HA includes the IFOM Capability notify payload in the IKE\_SA\_INIT response message; and +- if the HA is not IFOM capable, the HA ignores the IFOM Capability notify payload received from the UE and in the IKE\_SA\_INIT response message will not include the IFOM Capability notify payload. + +If the 3GPP AAA server triggers the HA to perform a HA reallocation procedure as specified in 3GPP TS 33.402 [18], the HA learns the IP address of the target HA as specified in 3GPP TS 29.273 [20]. The HA shall provide to the UE the target HA IP address in the REDIRECT payload during IKE\_AUTH exchange as specified in 3GPP TS 33.402 [18]. The encoding of the REDIRECT payload in the IKE\_AUTH response message is specified in IETF RFC 5685 [30]. The HA shall not assign an IPv6 prefix to the UE in the IKE\_AUTH exchange. The HA shall remove the states of the IKEv2 security association with the UE after receiving an IKEv2 Informational message with a DELETE payload from the UE. + +#### 5.1.3.2 Initial binding registration and IPv4 Home Address assignment + +When the HA receives a Binding Update message from the UE, it shall validate it as described in IETF RFC 6275 [27] and in IETF RFC 5555 [2]. If the Alternate Care-of Address option is present, the HA shall verify the correctness of the Alternate Care-of Address option. If the Care-of Address specified in the Alternate Care-of Address option and in the Source Address field of the IPv6 header of the Binding Update packet are different, the HA shall reject the request by returning a Binding Acknowledgement with status code 128. If the HA accepts the Binding Update message, it shall create a new entry in its binding cache for UE, marking it as a home registration. The lifetime of this binding cache entry is set based on operator's policies. The HA shall not perform a Duplicate Address Detection on the IPv6 Home Address of the UE because of the uniqueness of the IPv6 prefix assigned by the HA to the UE. Then the HA shall send a Binding Acknowledgement with R bit set to "1" as specified in IETF RFC 6275 [27] and IETF RFC 3963 [29]. The HA may include the Binding Refresh Advice mobility option following rules defined in IETF RFC 6275 [27] to indicate the remaining time until the UE should send a new home binding update. + +If the Binding Update contains an IPv4 Home Address option with the 0.0.0.0 IPv4 address, the HA shall assign an IPv4 Home Address to the UE, including an IPv4 Address Acknowledgement option in the Binding Acknowledgement message, as specified in IETF RFC 5555 [2]. If no IPv4 addresses are available at the HA, the HA shall send a Binding Acknowledgement with status code 132 in the IPv4 address acknowledgement option. + +If in the received Binding Update the IPv4 Care-of Address in the IPv4 Care-of Address option is not the same as the IPv4 address in the Source Address in the outer IPv4 header then a NAT was in the path. This information shall be included in the Binding Acknowledgement within a NAT Detection option with the F flag set and the Binding Acknowledgement shall be encapsulated based on the vanilla UDP encapsulation specified in IETF RFC 5555 [2]. + +If a NAT was not detected, the HA shall send the Binding Acknowledgement without any UDP encapsulation; the message shall be encapsulated in an IPv4 header if the Care-of Address is IPv4 or in an IPv6 header if the Care-of Address is IPv6 as specified in IETF RFC 5555 [2]. + +If the Binding Update contains a BID mobility option, the HA shall process it as specified in IETF RFC 5648 [31]. If one or more FID mobility options are included in the received Binding Update, the HA shall process it as specified in IETF RFC 6089 [32] and IETF RFC 6088 [33]. If binding update is accepted and IP flow mobility is supported, the HA shall insert the BID mobility option into the Binding Acknowledgement message as specified in IETF RFC 5648 [31]. In addition, if the received Binding Update contains FID mobility option, the HA shall create the flow bindings accordingly and insert the FID mobility option into the Binding Acknowledgement message as specified in IETF RFC 6089 [32]. + +If the binding update is accepted for both IPv4 and IPv6 home addresses, the HA creates two bindings, one for each home address as specified in IETF RFC 5555 [2]. The HA shall link the IPv4 home address binding to the IPv6 home address binding. + +NOTE: How the linkage between the two bindings (e.g. separate or single binding cache entry) is performed is implementation specific. + +When the binding cache entry is created for the UE, the HA shall tunnel all packets destined to the IPv6 Home Address, the home network prefix and all packets destined to the IPv4 Home Address (if present) to the UE's Care-of Address. If a NAT was detected, packets shall be encapsulated in UDP and IPv4 based on vanilla UDP encapsulation specified in IETF RFC 5555 [2]. If the Care-of Address is an IPv6 address, IPv4 and IPv6 packets shall be encapsulated in an IPv6 header as specified in IETF RFC 6275 [27] and in IETF RFC 5555 [2]; otherwise, if the Care-of Address is an IPv4 address, IPv4 and IPv6 packets shall be encapsulated in an IPv4 header as specified in IETF RFC 6275 [27] and in IETF RFC 5555 [2]. If the HA has multiple binding cache entries with flow bindings (see 3GPP TS 23.261 [34]), the HA shall route all packets destined to the IPv6 Home Address, the home network prefix, the IPv6 prefix(es) assigned through DHCP prefix delegation (if present) and all packets destined to the IPv4 Home Address (if present) as described in IETF RFC 6089 [32]. + +After the DSMIPv6 tunnel is established, if DHCPv6 Prefix Delegation request is received, the HA may assign additional IPv6 prefix(es) with length of /64 or shorter to the UE as defined in IETF RFC 6276 [35]. Once the DHCPv6 Prefix Delegation procedure has been completed, the HA shall add the assigned delegated prefix(es) into the binding cache entry as defined in IETF RFC 6276 [35]. When the delegated prefix(es) is included in the binding cache entry for UE, the HA shall tunnel all the packets destined to the delegated prefix(es) to the UE's Care-of Address. + +#### 5.1.3.3 Binding Error message + +When the HA receives a Binding Update and detects an unrecognized Mobility Header, the HA shall send a Binding Error message with status value 2 "Unrecognized MH Type value" as specified in IETF RFC 6275 [27]. The HA shall include the Home address that was contained in the Home Address destination option. + +If NAT was not detected, the HA shall send the Binding Error without any UDP encapsulation; the message shall be encapsulated in an IPv4 header if the Care-of Address is IPv4 or in an IPv6 header if the Care-of Address is IPv6 in the same manner as the Binding Acknowledgement encapsulation specified in IETF RFC 5555 [2]. + +If NAT was detected, the HA shall send the Binding Error encapsulated in UDP and IPv4 based on vanilla UDP encapsulation specified in IETF RFC 5555 [2]. + +## 5.2 Dual-Stack Mobile IPv6 handover + +### 5.2.1 General + +The DSMIPv6 handover procedure is performed by the UE to update its Care-of Address at the HA after a movement between two different accesses (e.g. a movement from a 3GPP to a non-3GPP access). The procedure is also used when the Care-of Address is changed for other reasons (e.g. re-allocation of a local IP address or equivalent). When this procedure takes place, the UE has already a valid registration at the HA, which implies that the HA has an entry in its + +binding cache for that UE and a security association to secure DSMIPv6 signalling is in place between the UE and the HA. + +The procedure involves performing the Home Link Detection, setup a security association with the HA if there is no security association existing, and the exchange of a Binding Update and a Binding Acknowledgement between the UE and the HA. For the handover procedure, at the previous access the UE shall already perform discovery of the HA address, and may set up a security association with it, as these steps are part of the initial attach procedure described in subclause 5.1.2. + +There are different handover scenarios: + +- handover from home link to a foreign link; +- handover from a foreign link to another foreign link; and +- handover from a foreign link to a home link. + +### 5.2.2 UE procedures + +#### 5.2.2.1 General + +Following a change of access, the UE configures an IP address on the target access system. The details of IP address configuration can be access specific. The handling of the received Binding Acknowledgement is the same as specified in subclause 5.1.2.4. + +#### 5.2.2.2 Handover from home link to a foreign link + +If the access network supports IPv6, as soon as the UE has received via a Router Advertisement at least an IPv6 prefix which is not present in its Prefix List, the UE shall perform the Home Link detection as specified in subclause 5.1.2.3. + +If the UE detects that it is moving from home link to foreign link, and if there is no security association existing with the HA, the UE shall perform the Security association establishment and Home Address assignment procedure with the HA as specified in subclause 5.1.2.2. + +Then the UE shall perform the initial binding registration and IPv4 Home Address assignment as specified in subclause 5.1.2.4. In order to maintain IP address preservation for the IPv4 address used in the home link, the UE shall include the IPv4 address used on the home link in an IPv4 Home Address option in the same Binding Update message. The IFOM capable UE configured for IFOM shall extend the Binding Update message as described in subclause 5.1.2.4. + +If the UE does not have an IPv4 Home Address but wants to configure one, the UE shall include the IPv4 Home Address option with the 0.0.0.0 address as specified in subclause 5.1.2.4. + +If the access network supports only IPv4, as soon as the UE has configured an IPv4 Care-of Address, the UE shall send a Binding Update tunnelled in UDP as specified in IETF RFC 5555 [2]. The UE shall set the F flag to "0". The UE shall set the R flag to "1". + +Independent of an IPv6 or IPv4 access network the UE shall set the Key Management Capability (K) bit in the Binding Update message. + +If the UE receives, as response to an outstanding binding registration, a binding acknowledgment having a status code equal to 135 ("Sequence number out of window") and a sequence number different from the one used in the outstanding binding registration, the UE shall accept the binding acknowledgment and process it as specified in IETF RFC 6275 [27]. + +#### 5.2.2.3 Handover from a foreign link to another foreign link + +If the access network supports IPv6, as soon as the UE has received via a Router Advertisement at least an IPv6 prefix which is not present in its Prefix List, the UE shall perform the Home Link detection as specified in subclause 5.1.2.3. + +If the UE detects it is not attached to the home link, the UE shall send a Binding Update to the HA including the newly configured IP address as the Care-of Address in the Source IP address of the packet and optionally in the Alternate Care-of Address Option IETF RFC 6275 [27]. The UE build the Binding Update message as specified in IETF RFC 6275 [27]. + +If the UE has been assigned also an IPv4 Home Address and wants to update also the binding for it, the UE shall include the IPv4 Home Address option including the assigned IPv4 Home Address in the same Binding Update message. + +If the UE has been assigned also an IPv4 Home Address and wants to release it, the UE shall not include any IPv4 Home Address option in the same Binding Update. + +If the UE does not have an IPv4 Home Address but wants to configure one, the UE shall include the IPv4 Home Address option with the 0.0.0.0 address as specified in subclause 5.1.2.4. + +If the access network supports only IPv4, as soon as the UE has configured an IPv4 Care-of Address which is different from the previous Care-of Address, the UE shall send a Binding Update tunnelled in UDP as specified in IETF RFC 5555 [2]. The UE shall set the F flag to "0". The UE shall set the R flag to "1". + +Independent of an IPv6 or IPv4 access network the UE shall set the Key Management Capability (K) bit in the Binding Update message. + +If the UE is an IFOM capable UE configured for IFOM, the UE extends the Binding Update with the following options: + +- a) the UE shall set the O (Overwrite) flag to "0"; +- b) the UE shall include a BID identifier mobility option in the Binding Update as specified in IETF RFC 5648 [31]; + - the UE shall set the BID field to the value registered with the Home Agent; + - the UE shall set the BID-PRI field to assign the priority to the BID as indicated in IETF RFC 6089 [32]; + - if the newly configured IP address used as Care-of Address is an IPv6 address, the UE shall not insert any Alternate Care-of Address option in the Binding Update message; + - if the newly configured IP address used as Care-of Address is an IPv4 address, the UE shall not insert any IPv4 Care-of Address option in the Binding Update message; and + - the UE shall insert the newly configured IP address used as Care-of Address in the Care-of Address field of the BID identifier mobility option inserted in the Binding Update message; +- c) the UE may create one or more routing rules. For each routing rule that the UE wants to register with the HA, the UE shall include a FID mobility option containing one traffic selector as specified in IETF RFC 6089 [32]. Traffic selectors are defined in IETF RFC 6088 [33]: + - the UE shall set the FID field to an arbitrary value; + - the UE shall set the FID-PRI field to assign the priority to the routing filter as indicated in IETF RFC 6089 [32]; + - the UE shall include a Binding Reference suboption as indicated in IETF RFC 6089 [32]. The value assigned to the BID identifies the routing address that the UE wants to use to exchange the packets matching the routing filters; and + - traffic selector suboption shall be set as specified in IETF RFC 6089 [32] and IETF RFC 6088 [33]. The parameters described in the traffic selector suboption represent the routing filter that corresponds to the routing rule that the UE wants to register with the HA; +- d) The UE may insert a flow summary mobility option (as described in IETF RFC 6089 [32]). + - If the UE wants to keep some routing rules previously registered unmodified, i.e. no flow handover, the UE lists the values of the FIDs identifying the routing rules that the UE wants to keep unmodified in the flow summary mobility option; and + - If the UE wants to remove one or more previously registered routing rules, the UE does not include in the flow summary mobility option the FIDs identifying the routing rules that the UE wants to remove; and +- e) the UE may modify one or more routing rules with the HA. For each routing rule that the UE wants to modify, the UE shall include a FID mobility option as specified in IETF RFC 6089 [32]. + - the UE shall set the FID field to the value identifying the routing filter the UE wants to handover; + +- the UE shall set the FID-PRI field to assign the priority to the BID as indicated in IETF RFC 6089 [32]; and +- the UE shall include a Binding Reference suboption as indicated in IETF RFC 6089 [32]. The value assigned to the BID identifies the routing address that the UE wants to use to exchange the packets matching the routing filters. + +The UE shall process the binding acknowledge message as described in subclause 5.1.2.4. + +#### 5.2.2.4 Handover from a foreign link to a home link + +If the access network supports IPv6, as soon as the UE has received via a Router Advertisement message at least an IPv6 prefix which is not present in its Prefix List, the UE shall perform the Home Link detection as specified in subclause 5.1.2.3 to detect if the UE is attaching to the home link. If the UE detects it is attached to the home link and there is a valid DSMIPv6 Binding Update list entry at the UE, the UE shall send a Binding Update with the Lifetime field set to "0" in order to remove the binding at the HA, as specified in IETF RFC 6275 [27]. If an IPv4 home address was assigned to the UE, as an optimization the UE may not include the IPv4 home address option as the binding for the IPv4 home address will be removed by the HA. Independent of an IPv6 or IPv4 access network the UE shall set the Key Management Capability (K) bit in the de-registration Binding Update message. The UE may preserve the IKEv2 session in order to avoid re-establishing the session when the next handover occurs. If there is not a safe assumption that the UE will remain in the home link (e.g. switching off the non-3GPP radio interface in case of a dual radio terminal), the UE should preserve the IKEv2 session. + +If the UE receives a Binding Revocation Indication message from the HA while there is an outstanding unacknowledged Binding Update with Lifetime field set to "0" message, the UE need not send a Binding Revocation Acknowledgement as specified in subclause 5.4.2.1. + +### 5.2.3 HA procedures + +#### 5.2.3.1 Handover from home link to a foreign link + +In case of UE handover from home link to foreign link, the HA shall support the initial registration procedure as specified in subclause 5.1.3. + +The error codes used in the Binding Acknowledgement are the same as specified in subclause 5.1.3.2. + +#### 5.2.3.2 Handover from a foreign link to another foreign link + +When the HA receives a Binding Update from the UE, the HA shall validate it as described in IETF RFC 6275 [27] and in IETF RFC 5555 [2]. If the validation is successful, the HA shall update the binding cache entry related to the Home Address included in the Binding Update. + +If the Binding Update is an IPv6 packet, with the Alternate Care-of Address option present, the HA shall verify the correctness of the Alternate Care-of Address option. If the Care-of Address specified in the Alternate Care-of Address option and in the Source Address field of the IPv6 header of the Binding Update packet are different, the HA shall reject the request by returning a Binding Acknowledgement with status code 128. If the option is valid, the HA shall update the binding cache entry with the Care-of Address in the Source Address of the IPv6 header. + +If the Binding Update outer header is an IPv4 header and the IPv4 Care-of Address in the IPv4 Care-of Address option is the same as the IPv4 address in the Source Address in the outer IPv4 header, the HA shall update the binding cache entry with the Care-of Address in the IPv4 Care-of Address option and shall send a Binding Acknowledgment encapsulated in IPv4 as specified in IETF RFC 5555 [2]. + +If in the received Binding Update the IPv4 Care-of Address in the IPv4 Care-of Address option is not the same as the IPv4 address in the Source Address in the outer IPv4 header then a NAT was in the path. This information shall be included in the Binding Acknowledgement within a NAT Detection option with the F bit set. The Binding Acknowledgment shall be encapsulated in UDP and the binding cache updated as specified in IETF RFC 5555 [2]. + +If the Binding Update contains an IPv4 Home Address option with an IPv4 Home Address previously assigned, the HA shall update also the binding cache entry related to the IPv4 Home Address to the UE. If the Binding Update contains no IPv4 Home Address option, the HA shall remove the binding cache entry related to the IPv4 Home Address of the UE if present. + +If the Binding Update contains an IPv4 Home Address option with the 0.0.0.0 IPv4 address, the HA shall assign an IPv4 Home Address to the UE, including an IPv4 Address Acknowledgement option in the Binding Acknowledgement message. + +The error codes used in the Binding Acknowledgement are the same as specified in subclause 5.1.3.2. + +If the Binding Update contains a BID mobility option and (optionally) a Flow summary mobility option, the HA shall process the received Binding Update message and send a Binding Acknowledgement message as described in subclause 5.1.3.2. + +If the Key Management Mobility Capability (K) bit is set in the Binding Update and the HA supports the feature, the HA updates its IKEv2 security associations to include the UE's Care-of Address as the peer address and the Binding Acknowledgement is returned with the K bit set. + +The HA shall set the R bit to "1" in the Binding Acknowledgement. + +#### 5.2.3.3 Handover from a foreign link to a home link + +When a UE hands over from a foreign link to its home link, a network based mobility protocol (PMIPv6 or GTP) in the home link creates a binding cache entry for the UE. The DSMIPv6 binding cache entry that was created by the UE on the foreign link shall not be overwritten. The downlink UE packets shall be processed by the HA based on the DSMIPv6 binding cache entry before the DSMIPv6 binding cache entry is removed. + +The DSMIPv6 binding cache entry shall be removed when a Binding Update with lifetime field set to "0" is received by the HA from the UE. The HA shall process the message as per IETF RFC 5555 [2] and IETF RFC 6275 [27], removing the associated binding cache entry and sending the Binding Acknowledge message with the Status field set to "0" (Binding Update accepted). If an IPv4 home address was assigned to the UE, the HA shall also remove the binding for the IPv4 home address tied to the IPv6 home address included in the Binding Update. + +If the HA decides to remove the DSMIPv6 binding cache entry of the UE, prior to receiving a binding update with lifetime set to "0" from the UE, the HA shall send a Binding Revocation Indication message as specified in subclause 5.4.3.1. + +NOTE: As described above, if the HA receives a Binding Update with Lifetime field set to "0", the HA removes the associated binding cache entry, but additionally the HA can store some data of the binding cache entry for a certain time in order to allow the HA to identify a delayed Binding Update registration message arriving at the HA after the Binding Update de-registration. + +## 5.3 Dual Stack Mobile IPv6 Re-Registration + +### 5.3.1 General + +The DSMIPv6 Re-Registration procedure can occur at any time when the UE is already registered at the HA. The procedure is initiated by the UE when it wishes to extend the lifetime of an existing registration, e.g. in case the lifetime is expiring. The procedure can also be initiated by the UE when it wishes to request an IPv4 home address or to release the IPv4 binding while maintaining the IPv6 binding. The procedure may also be initiated by the UE as a mechanism to refresh the NAT bindings in order to be reachable from the HA. + +NOTE: The usage of BU messages for keepalive purposes can have impacts to the battery life of the UE. The UE can be configured to rate limiting or avoid NAT keepalive as specified in IETF RFC 5555 [2]. + +### 5.3.2 UE procedures + +As specified in IETF RFC 6275 [27], if the UE wants to extend the validity of an existing binding at the HA, the UE shall send a new Binding Update to the HA before the expiration of the lifetime indicated in the received Binding Acknowledgement, even if it is not changing its primary Care-of Address. This Binding Update is usually referred as periodic Binding Update. + +The UE shall follow the rules described in IETF RFC 6275 [27], IETF RFC 5555 [2] and in subclause 5.1.2.4 to send a periodic Binding Update and handle the associated Binding Acknowledgement. As the UE has not performed any handover, the UE shall confirm the already registered Care of Address and shall indicate the desired lifetime value. In a periodic Binding Update the UE may request an IPv4 Home Address. + +If a NAT was detected and the UE is not exchanging data traffic, the UE may send a re-registration Binding Update in order to refresh the NAT binding. The Binding Update shall be sent with the interval contained in the Refresh Time field of the NAT detection option received when the NAT was detected. If the Refresh Time field was set to all 1s, the UE shall use the Binding Acknowledge lifetime as reference interval to send NAT keepalives Binding Updates. + +The UE may also send a re-registration Binding Update with the purpose of requesting an IPv4 Home Address. + +The UE may also send a re-registration Binding Update for the purpose of releasing the IPv4 Home Address previously assigned. For this purpose, the UE shall follow the rules described in IETF RFC 5555 [2] sending a re-registration Binding Update containing no IPv4 Home Address option. + +If the UE is an IFOM capable UE configured for IFOM, the UE extends the Binding Update with the following options: + +- a) the UE shall set the O (Overwrite) flag to "0"; +- b) the UE shall include a BID identifier mobility option in the Binding Update as specified in IETF RFC 5648 [31]; + - the UE shall set the BID field to the value identifying the Binding it wants to re-register; + - the UE shall set the BID-PRI field to assign the priority to the BID as indicated in IETF RFC 6089 [32]; and +- c) if the UE previously registered in the HA one or more routing filters, the UE shall include a flow summary mobility option as specified in IETF RFC 6089 [32] listing the values of the FIDs identifying the registered routing filter. + +### 5.3.3 HA procedures + +When the HA receives a periodic Binding Update message from the UE, it shall validate it as described in subclause 5.1.3.2, in IETF RFC 6275 [27], IETF RFC 5555 [2] and IETF RFC 5648[31]. + +In processing a periodic Binding Update the HA shall follow the rules described in subclause 5.1.3.2. In addition if the Binding Update does not include the IPv4 home address option the HA shall remove any associated IPv4 binding cache entry and continue to maintain the IPv6 binding. + +If the HA accepts the Binding Update message, it shall update the lifetime and sequence number of the existing entry in its binding cache for the Home Address. If the Binding Update contains a BID mobility option, the HA shall process it as specified in IETF RFC 5648 [31] and IETF RFC 6089 [32]. If binding update is accepted, the HA shall insert the BID mobility option into the Binding Acknowledgement message as specified in IETF RFC 5648 [31]. The Care-of Address is not updated as the periodic Binding Update is not used to update the Care-of Address. + +## 5.4 Dual-Stack Mobile IPv6 detach + +### 5.4.1 General + +The DSMIPv6 detach is performed by the UE to close the DSMIPv6 session and the respective IKEv2 session or by the network to inform the UE that it does not have access to a specific PDN through DSMIPv6 any longer. After the DSMIPv6 detach procedure, the UE still has IP connectivity provided by the access network. + +There are two explicit detach procedures: + +- UE-initiated detach procedure: in this case the UE performs a DSMIPv6 de-registration with the HA and closes the IKEv2 session. +- HA-initiated detach procedure: in this case the HA informs the UE that the DSMIPv6 binding is no more valid. The UE shall then perform the network-initiated detach procedure. + +### 5.4.2 UE procedures + +#### 5.4.2.1 Network-initiated detach + +Upon receiving a Binding Revocation Indication (BRI) message according to IETF RFC 5846 [19] from the HA, the UE first shall perform the required validity checks on the BRI according to IETF RFC 5846 [19]. + +The UE shall send a Binding Revocation Acknowledgement (BRA) as specified in IETF RFC 5846 [19]. In this message the UE shall set the status field to 'Success' to reflect that it has received the BRI message. The BRA message may be tunnelled in UDP or IPv4 as specified in subclause 5.1.2.4 for Binding Update messages. + +The UE then shall remove the entry identified in the BRI as deregistered from its binding update list and shall use the procedures defined in IETF RFC 5996 [14] to remove the IPsec security associations associated with the DSMIPv6 registration as described in subclause 5.4.2.2. + +#### 5.4.2.2 UE-initiated detach + +To detach from a specific PDN to which it is connected through a DSMIPv6 session, the UE shall send a Binding Update with the Lifetime field set to 0 as specified in IETF RFC 6275 [27]. + +The UE shall use the procedures defined in the IKEv2 protocol in IETF RFC 5996 [14] to remove the IPsec security associations associated with the DSMIPv6 registration. The UE shall close the security associations associated with the DSMIPv6 registration and instruct the HA to do the same by sending the INFORMATIONAL request message including a DELETE payload. The Protocol ID in the DELETE payload shall be set to "1" (IKE) to indicate that all IPsec ESP security associations that were negotiated within the IKEv2 exchange shall be deleted. + +### 5.4.3 HA procedures + +#### 5.4.3.1 Network-initiated detach + +As soon as it receives a trigger for network-initiated detach procedure (see 3GPP TS 29.273 [20]) the HA shall send a Binding Revocation Indication (BRI) message according to IETF RFC 5846 [19] to the UE. The message shall contain the Home Address, corresponding to the PDN connection which shall be removed. The HA shall set the P (Proxy Binding) bit to 0 (Not Proxy MIPv6 binding), G bit (Global) to 0 (only the PDN Connection specified by the HoA is removed) and V bit (IPv4 HoA Binding Only) to 0 (Not to terminate the IPv4 Home Address binding only). The revocation trigger value shall be set to 1 (Unspecified). The HA shall include the UE home address in the Type 2 routing header as per IETF RFC 5846 [19] and shall not include any mobility option. The HA shall not include a BID option in the BRI message. The BRI message may be tunnelled in UDP or IPv4 as specified in subclause 5.1.3.2 for Binding Acknowledgement messages. + +The HA shall follow procedures according to IETF RFC 5846 [19] to await the receipt of a Binding Revocation Acknowledgement (BRA) message from the UE. These procedures are based on the timer MINDelayBRIs defined in IETF RFC 5846 [19]. The HA shall not remove the entry from its binding cache before receiving the BRA. + +If the HA receives a Binding Update with Lifetime set to 0 after initiating the network-initiated detach procedure, the HA should treat the BU as acknowledgement to the BRI for the purposes of completing the revocation procedures that are defined in IETF RFC 5846 [19]; in this case, the HA shall remove the respective entry in its binding cache, deleting the timer MINDelayBRIs and respond with a Binding Acknowledgement according to IETF RFC 5555 [2] and IETF RFC 6275 [27]. + +#### 5.4.3.2 UE-initiated detach + +When the HA receives a Binding Update with the Lifetime field set to 0, it shall delete any existing entry for the Home Address included in the Binding Update. Then the HA shall send a Binding Acknowledgement as specified in IETF RFC 5555 [2] and IETF RFC 6275 [27]. + +On receipt of the INFORMATIONAL request message including a DELETE payload indicating that the UE is deleting the IPsec security associations associated with the DSMIPv6 registration, the HA shall close the IKE security association, and all IPsec ESP security associations that were negotiated within it towards the UE. + +## 5.5 Void + +## 5.5A Protection of data traffic + +### 5.5A.1 General + +UE and HA can use the IKEv2 CREATE\_CHILD\_SA exchange procedure to create a child security association to be used to provide integrity protection, confidentiality protection or both, to all data traffic exchanged within the DSMIPv6 tunnel. The procedure can be initiated by the HA or by the UE at any time after the security association between UE and HA has been set up. If both UE and HA independently decide to initiate the child security association establishment, the + +procedure described in IETF RFC 5996 [14] applies. The profiles for tunnel mode IPsec ESP are defined in 3GPP TS 33.402 [18]. + +### 5.5A.2 UE procedures + +After establishing the IPsec security association with the HA as described in subclause 5.1.2.2, the UE may initiate the creation of child security association pair to provide integrity protection, confidentiality protection or both. If the UE determines that the trust relationship of the non-3GPP access network is "untrusted" (see 3GPP TS 24.302 [21]), the UE shall not initiate the creation of child security association. If the UE initiates the creation of child security association pair, the UE shall send to the HA a CREATE\_CHILD\_SA request as described in IETF RFC 4877 [4] and IETF RFC 5996 [14] with the following additions: + +- a) the content of the Security Association payload is set accordingly for integrity protection, confidentiality protection or both as indicated in IETF RFC 5996 [14] using the IPsec profiles defined in 3GPP TS 33.402 [18]; and +- b) the TSi shall contain all the Home Network Prefix assigned to the UE. If prefix delegation is used, the TSi shall also contain all the prefix(es) provided to the UE. If the UE received an IPv4 Home Address, the TSi shall also contain the IPv4 Home Address. + +When the UE receives a CREATE\_CHILD\_SA request from the HA with selectors indicating the DSMIPv6 tunnel traffic, if the UE supports integrity protection, confidentiality protection or both, the UE shall reply with a CREATE\_CHILD\_SA response selecting the preferred transform proposed by the HA as specified in IETF RFC 5996 [14]. + +If the child SA is created successfully, the UE shall start encapsulating all the uplink packets in the DSMIPv6 tunnel in an IPsec ESP tunnel as negotiated with the HA during the CREATE\_CHILD\_SA procedure. + +The UE can stop using integrity protection, confidentiality protection or both, for the DSMIPv6 tunnel traffic. In order to do that, the UE shall delete the respective child security association by sending an INFORMATIONAL request message including the DELETE payload as specified in IETF RFC 5996 [14]. + +### 5.5A.3 HA procedures + +After establishing the IPsec security association with the UE as described in subclause 5.1.3.1, the HA may initiate the creation of child security association pair to provide integrity protection, confidentiality protection or both. If the HA receives the trust relationship indication as "untrusted" from the 3GPP AAA server during the authentication and authorization procedure or the authorization procedure (see 3GPP TS 29.273 [20]), the HA shall not initiate the creation of child security association procedure. If the trust relationship indication is not received, the initiation of the creation of the child security association is implementation dependent (e.g. based on configuration). If the HA initiates the creation of child security association pair, the HA shall send to the UE a CREATE\_CHILD\_SA request as described in IETF RFC 4877 [4] and IETF RFC 5996 [14] with the following additions: + +- a) the content of the Security Association payload is set accordingly for integrity protection, confidentiality protection or both as indicated in IETF RFC 5996 [14] using the IPsec profiles defined in 3GPP TS 33.402 [18]; and +- b) the TSi shall contain all the Home Network Prefix assigned to the UE. If prefix delegation is used, the TSi shall also contain all the prefix(es) provided to the UE. If the UE received an IPv4 Home Address, the TSi shall also contain the IPv4 Home Address. + +When the HA receives a CREATE\_CHILD\_SA request from the UE with selectors indicating the DSMIPv6 tunnel traffic, if the HA supports integrity protection, confidentiality protection or both, the HA shall check whether the child security association establishment can be accepted or not. If the HA receives the trust relationship indication set to "untrusted" indication from the 3GPP AAA server (see 3GPP TS 29.273 [20]), the HA shall reject the child security association establishment by using the NOTIFY payload of type "NO\_ADDITIONAL\_SAS" in the CREATE\_CHILD\_SA response. If HA does not receive the trust relationship indication, whether to accept or reject the child security association is implementation dependent. Otherwise, the HA shall reply with a CREATE\_CHILD\_SA response selecting the preferred transform proposed by the HA as specified in IETF RFC 5996 [14]. + +If the child SA is created successfully, the HA shall start encapsulating, all the uplink packets in the DSMIPv6 tunnel in an IPsec ESP tunnel as negotiated with the UE during the CREATE\_CHILD\_SA procedure. + +The HA can stop using integrity protection, confidentiality protection or both, for the DSMIPv6 tunnel traffic. In order to do that, the HA shall delete the respective child security association by sending an INFORMATIONAL request message including the DELETE payload as specified in IETF RFC 5996 [14]. + +## 5.6 Attach to additional access network + +### 5.6.1 General + +The operations defined within subclause 5.6 apply to an IFOM capable UE configured for IFOM and a HA supporting IFOM. + +The attach to additional access network procedure is performed by a UE supporting IFOM that has already established a PDN connection through an access network and decides to extend the PDN connection to another access network. + +There can be two possible scenarios: + +- the existing access network is a home link and the added access network is a foreign link; or +- the existing access network is a foreign link and the added access network is a home link. + +The attach to additional access network procedure involves performing the following: + +- access specific procedure to connect and configure an IP address for the added access network; +- discovery of a HA IP address if the UE has not obtained the IP address of the HA; +- home link detection; +- setting up a security association if there is no security existing association between the UE and HA; and +- exchange of Binding Update and Binding Acknowledgement with the BID mobility option and FID mobility option between the UE and HA. + +### 5.6.2 UE procedures + +#### 5.6.2.1 General + +For the attach to additional access network procedure, the UE is already attached to either a home link or foreign link and discovers a new link. The UE applies the DSMIPv6 Home Link Detection Function as specified in subclause 5.1.2.3 to determine if the new link will be a home link or a foreign link. If the new link is a home link, the UE follows the procedure as specified in subclause 5.6.2.2. If the new link is a foreign link, the UE follows the procedure as specified in subclause 5.6.2.3. + +#### 5.6.2.2 Attach to additional access network acting as home link + +The UE shall perform the DSMIPv6 Home Link Detection Function as specified in subclause 5.1.2.3. + +In addition, the UE shall perform the initial binding registration and IPv4 Home Address assignment as specified in subclause 5.1.2.4 with the following additional rules: + +- a) the UE shall send a Binding Update through the home link; +- b) the O (Overwrite) flag in the Binding Update shall be set to "0"; +- c) the UE shall insert a BID mobility option in this Binding Update with: + - the 'H' flag in the BID mobility option set to "1"; + - the Care-of Address field set to the IPv6 Home Address of the binding; and + - the BID-PRI field set to assign the priority to the BID as indicated in IETF RFC 6089 [32]; +- d) if routing filters were previously registered with the HA, the UE shall include a flow summary mobility option as specified in IETF RFC 6089 [32] listing the values of the FIDs identifying the routing filter that were previously registered; and + +- e) if the UE creates one or more routing rules as specified in subclause 5.1.2.4, for each FID mobility option, the value of the BID field in the Binding Reference suboption identifies the routing address that the UE wants to use to exchange packets matching the routing filter. + +When the UE receives the Binding Acknowledgment from the HA, the UE shall process the Binding Acknowledgment as specified in subclause 5.1.2.4. + +#### 5.6.2.3 Attach to an additional access acting as foreign link + +The UE shall perform the same procedures described in subclause 5.1.2.4. The UE shall send the Binding Update message through the added link. In addition, the UE shall register the binding for the home link by including a BID mobility option in the Binding Update message. The BID mobility option fields for the binding for the home link are those indicated in IETF RFC 5648 [31] for home binding with the following distinctions: + +- (a) the H flag shall be set to "1"; +- (b) the Care-of Address field shall be set to the IPv6 HoA of the binding; and +- (c) the BID-PRI field shall be set to the assigned priority of the BID as indicated in IETF RFC 6089 [32]. + +The UE shall process the received Binding Acknowledgement as specified in subclause 5.1.2.4. + +### 5.6.3 HA procedures + +#### 5.6.3.1 General + +The following subclauses describe the detailed HA procedures for the case when a UE is attaching to an additional access network. + +#### 5.6.3.2 Attach to an additional access network acting as home link + +When receiving a Binding Update from the UE, the HA performs the same procedure as specified in subclause 5.2.3.2. In addition, the HA shall validate the Binding Update as described in IETF RFC 5648 [31], IETF RFC 6089 [32] and IETF RFC 6088 [33]. + +#### 5.6.3.3 Attach to additional access acting as foreign link + +When receiving a Binding Update from the UE, the HA performs the same procedures described in subclause 5.2.3.2 and in addition the HA shall validate the Binding Update as described in IETF RFC 5648 [31], and IETF RFC 6089 [32] and IETF RFC 6088 [33]. As described in IETF RFC 5648 [31], the HA shall: + +- process the IPv6 address contained in the BID option with the H flag set to 0 as the Care-of Address; and +- process the IPv4 address contained in the BID option with the H flag set to 0 in the same way as the HA process the address contained in the IPv4 Care-of Address option in subclause 5.2.3.2. + +## 5.7 Inter-access flow mobility + +### 5.7.1 General + +The operations defined within this sub-clause apply to an IFOM capable UE configured for IFOM and to HA supporting IFOM. + +The inter-access flow mobility is performed by the UE supporting IFOM that already established a PDN connection and exchanges packets belonging to the PDN connection through multiple access networks. The UE has previously registered one or more routing rules with the HA. + +In this procedure, the UE updates the HA by performing any of the following operations: + +- assigning one or more routing filters to an access network different from the one those routing filters were previously assigned; +- adding one or more new routing rules to the HA; or +- removing one or more previously registered routing rules from the HA. + +The procedure involves the exchange of a Binding Update and a Binding Acknowledgement with BID and FID options between the UE and the HA. + +### 5.7.2 UE procedures + +The UE performs the same procedures described in subclause 5.3.2 with the following exceptions: + +- the UE shall set the O (Overwrite) flag to 0; +- the UE shall not include any Alternate Care-of Address option in the Binding Update message; and +- the UE shall not include any IPv4 Care-of Address option in the Binding Update message. + +In addition, the UE shall extend the Binding Update message with the following options (see IETF RFC 5648 [31], IETF RFC 6089 [32] and IETF RFC 6088 [33]): + +- a) The UE shall include a BID identifier mobility option: + - the BID field is set to the value identifying the routing address used as IP Source Address of the Binding Update message; + - if the Binding Update message is sent over a home link, the "H" flag is set to 1; + - if the Binding Update message is sent over a foreign link, the "H" flag is set to 0; + - the BID-PRI priority field is set to the priority assigned to the BID as indicated in IETF RFC 6089 [32]; and + - if the routing address is an IPv4 address, a NAT was detected and the UE is not exchanging data traffic, the UE may insert the routing address in the Care-of Address field of the BID mobility option; +- b) the UE may create one or more routing rules. For each routing rule that the UE wants to register with the HA, the UE shall include a FID mobility option containing one traffic selector as specified in IETF RFC 6089 [32]. Traffic selectors are defined in IETF RFC 6088 [33]: + - the UE shall set the FID field to an arbitrary value; + - the UE shall set the FID-PRI field to assign the priority to the routing filter as indicated in IETF RFC 6089 [32]; + - the UE shall include a Binding Reference suboption as indicated in IETF RFC 6089 [32]. The value assigned to the BID identifies the routing address that the UE wants to use to exchange the packets matching the routing filters; and + - traffic selector suboption shall be set as specified in IETF RFC 6089 [32] and IETF RFC 6088 [33]. The parameters described in the traffic selector suboption represent the routing filter that corresponds to the routing rule that the UE wants to register with the HA; +- c) The UE may insert a flow summary mobility option (as described in IETF RFC 6089 [32]). + - If the UE wants to keep some routing rules previously registered unmodified, i.e. no flow handover, the UE lists the values of the FIDs identifying the routing rules that the UE wants to keep unmodified in the flow summary mobility option; and + - If the UE wants to remove one or more previously registered routing rules, the UE does not include in the flow summary mobility option the FIDs identifying the routing rules that the UE wants to remove; and +- d) the UE may modify one or more routing rules with the HA. For each routing rule that the UE wants to modify, the UE shall include a FID mobility option as specified in IETF RFC 6089 [32]. + - the UE shall set the FID field to the value identifying the routing filter the UE wants to handover; + - the UE shall set the FID-PRI field to assign the priority to the BID as indicated in IETF RFC 6089 [32]; and + - the UE shall include a Binding Reference suboption as indicated in IETF RFC 6089 [32]. The value assigned to the BID identifies the routing address that the UE wants to use to exchange the packets matching the routing filters. + +The handling of the received Binding Acknowledgement message is the same as specified in subclause 5.1.2.4. In addition, the UE handles the FID and BID mobility options contained in the received Binding Acknowledgment message as specified in IETF RFC 5648 [31], IETF RFC 6089 [32] and IETF RFC 6088 [33]. + +### 5.7.3 HA procedures + +When receiving a Binding Update from the UE, the HA performs the same procedures described in subclause 5.3.3 and in addition the HA shall validate the Binding Update as described in IETF RFC 5648 [31], IETF RFC 6089 [32] and IETF RFC 6088 [33]. + +## 5.8 UE-initiated removal of an access network from a PDN connection + +### 5.8.1 General + +The operations defined within this sub-clause apply to an IFOM capable UE configured for IFOM and to HA supporting IFOM. + +The removal of an access network from a PDN connection procedure is initiated by a UE which has a PDN connection through multiple access networks. In this procedure, the UE stops using one of the access network for the PDN connection. + +The procedure involves the exchange of a Binding Update and a Binding Acknowledgement between the UE and the HA. + +There can be two possible scenarios: + +- home link access network is removed and foreign link access network is maintained; or +- foreign link access network is removed and home link access network is maintained. + +### 5.8.2 UE procedures + +#### 5.8.2.1 General + +The removal of an access network from a PDN connection is performed by a UE attached to multiple access networks. The UE sends a Binding Update message in order to update the HA binding cache removing the entry corresponding to the removed access network. If the removed access network is a home link, the UE follows the procedure as specified in subclause 5.8.2.2. If the removed access network is a foreign link, the UE follows the procedure as specified in subclause 5.8.2.3. + +#### 5.8.2.2 Removal of Home link access + +If the UE removes the home link from a specific PDN connection, the UE shall perform one of the following operations: + +- the UE sends a Binding Update with the Lifetime field set to 0 as specified in IETF RFC 5555 [2] and IETF RFC 6275 [27] and with a BID mobility option. The UE populates the BID mobility option as follows (see IETF RFC 5648 [31]): + - the BID identifier field is set to the BID corresponding to the access network the UE wants to remove; + - the H flag is set to 0; and + - the Care-of Address field in the BID mobility option is omitted;or: +- the UE sends a Binding Update message as indicated in subclause 5.1.2.4 with the following additions: + - the Binding Update message shall be exchanged through the maintained access network; + - the BID identifier field is set to the value identifying the maintained access network; and + +- the Care-of Address field in the BID mobility option is omitted. + +NOTE: The choice of the operation to follow is up to UE implementation. + +#### 5.8.2.3 Removal of foreign link from a PDN connection + +If the UE removes an access network acting as foreign link from a specific PDN connection and maintains the connection to the PDN through the home link, the UE shall send a Binding Update message with the Lifetime field set to 0 as specified in subclause 5.4.2.2. If the UE decides to close the security association set up with the HA, the UE shall send the INFORMATIONAL request message including a DELETE payload as specified in subclause 5.4.2.2. + +### 5.8.3 HA procedures + +#### 5.8.3.1 General + +The following subclauses describe the detailed HA procedures for the case when a UE is removing an access network from a PDN connection. + +#### 5.8.3.2 Removal of home link access from a PDN connection + +In case of removal of a home link from a PDN connection executed by the UE, the HA shall perform the following operations: + +- if the Lifetime field of the received Binding Update is set to 0, the HA processes the received Binding Update message as described in IETF RFC 5555 [2] and IETF RFC 6275 [27] and IETF RFC 5648 [31]; and +- if the Lifetime field of the received Binding Update is not set to 0, the HA shall perform the same procedures described in subclause 5.6.3.3. + +#### 5.8.3.3 Removal of foreign link from a PDN connection + +When the HA receives a Binding Update with the Lifetime field set to 0, the HA shall perform the same procedures described in subclause 5.4.3.2. + +## 5.9 Network-initiated removal of an access network from a PDN connection + +### 5.9.1 General + +The operations defined within this subclause apply to IFOM capable UE configured for IFOM and to HA supporting IFOM. + +The removal of an access network from a PDN connection procedure is initiated by the HA for a UE that has an established PDN connection through multiple access networks with the HA. In this procedure, the HA informs the UE that an entry in the binding cache is no more valid over one of the access network for the PDN connection. The UE then performs the network-initiated removal of an access network from a PDN connection procedure. + +The procedure involves the exchange of a Binding Revocation Indication (BRI) message and a Binding Revocation Acknowledgement (BRA) between the UE and the HA as specified in IETF RFC 5846 [19]. + +Once the procedure is completed, the UE uses the maintained access network for the PDN connection. + +There can be two possible scenarios: + +- home link access network is removed and foreign link access network is maintained; or +- foreign link access network is removed and home link access network is maintained. + +### 5.9.2 UE procedures + +#### 5.9.2.1 General + +The following subclauses describe the detailed UE procedures for the case when the HA removes an access network from a PDN connection. + +#### 5.9.2.2 Removal of home link access from a PDN connection + +Upon receiving a BRI message with a BID option, the UE shall perform the procedure as specified in subclause 5.4.2.1 with the following additions: + +- the UE shall process the BID mobility option as specified in IETF RFC 5846 [19]; +- the UE shall include the received BID mobility option in the BRA as specified in IETF RFC 5846 [19]; and +- the UE shall not close the security associations set up with the HA. + +#### 5.9.2.3 Removal of foreign link from a PDN connection + +Upon receiving a BRI message without a BID mobility option from the HA, the UE shall process the BRI message as specified in subclause 5.4.2.1. If the UE decides to close the security association set up with the HA, the UE shall send the INFORMATIONAL request message including a DELETE payload as specified in subclause 5.4.2.2. + +### 5.9.3 HA procedures + +#### 5.9.3.1 General + +The following subclauses describe the detailed HA procedures for the case when the HA removes an access network from a PDN connection. + +#### 5.9.3.2 Removal of home link access from a PDN connection + +In order to remove the home link access from a PDN connection, the HA shall perform the procedure as specified in subclause 5.4.3.1 with the following additions: + +- the HA shall include a BID mobility option of the home link access in the BRI message sent to the UE; and +- the HA shall only remove the home binding of the the PDN connection from the HA binding update cache, when a BRA message with the same BID mobility option is received. + +#### 5.9.3.3 Removal of foreign link from a PDN connection + +In order to remove the foreign link access network from a PDN connection, the HA shall perform the network initiated detach procedure by sending a BRI message without a BID mobility option as described in subclause 5.4.3.1. + +If an INFORMATIONAL request message including a DELETE payload is received, the HA shall perform the procedure as specified in subclause 5.4.3.2. + +# Annex A (normative): Message Details + +## A.1 General + +Only the message fields and the mobility options used in the DSMIPv6 procedures defined in this TS are present in this annex. Unspecified message fields and mobility options are not used by this specification. + +The IP header, the home address destination option, and type 2 routing header option of the DSMIPv6 signalling messages are not included in this annex. They shall be set in the message as defined in the IETF RFC 6275 [27], IETF RFC 5555 [2] and IETF RFC 5846 [19]. + +Only the message fields and mobility options used for normal cases in this TS are present in this annex. + +## A.2 Initial Binding Registration + +### A.2.1 Binding Update + +The fields of a BU message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.2.1-1. + +The Mobility Options in a BU message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.2.1-2. + +**Table A.2.1-1: Fields of a BU message for the DSMIPv6 Initial Binding Registration procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | Set to the requested number of time in units of 4 seconds the binding shall remain valid. | IETF RFC 6275 [27] | +| Home Registration (H) | Set to "1" to indicate receiving node should act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" to indicate home network prefix preservation for the UE. | IETF RFC 3963 [29] | +| Overwrite Flag (O) | Set to "1" to indicate replacing all binding cache entries at the HA with the entries listed in the Binding Update. | IETF RFC 5648 [31] | + +**Table A.2.1-2: Mobility Options in a BU message for the DSMIPv6 Initial Binding Registration procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Home Address option | O | Set to the value "0.0.0.0" to request allocation for the UE. The "P" flag is set to '0'.
The Prefix Length is set to the requested prefix length of '32'. | IETF RFC 5555 [2] | +| IPv4 Care-of Address | C | Set to the IPv4 Care-of address when in an IPv4 Access Network. | IETF RFC 5555 [2] | +| Alternate Care-of Address | C | Used (in addition to the Source address of the IPv6 packet) to carry the IPv6 care-of address when in an IPv6 access network. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | O | The BID and BID-PRI are set to an arbitrary value. For registration of a home link, the "H" flag is set to "1" and the value of the CoA field is the Home Address. For registration of a foreign link, the "H" flag is set to "0" and the value of the CoA field is the Care-of Address. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| Flow Identification mobility option | O | The FID and FID-PRI are set to an arbitrary value. The Action field is set to indicate the action taken by the receiver of the Binding Update. The sub-option field conveys the Traffic Selector sub-option. | IETF RFC 6089 [32],
IETF RFC 6088 [33] | +| Flow Summary mobility option | O | Contain one or more FIDs present in the binding update list to refresh the respective flow bindings. | IETF RFC 6089 [32] | + +### A.2.2 Binding Acknowledgement + +The fields of a BA message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.2.2-1. + +The Mobility Options in a BA message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.2.2-2. + +**Table A.2.2-1: Fields of a BA message for the DSMIPv6 Initial Binding Registration procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|--------------------------------------------------------------------------------------------------------|------------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27],
IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" | IETF RFC 3963 [29] | +| Sequence Number | Set to the value received in the corresponding Binding Update. | IETF RFC 6275 [27] | +| Lifetime | Set to the granted number of time units of 4 seconds the binding shall remain valid. | IETF RFC 6275 [27] | + +**Table A.2.2-2: Mobility Options in a BA message for the DSMIPv6 Initial Binding Registration procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| IPv4 Address Acknowledgment option | C | If IPv4 Home Address option is present in the corresponding BU, IPv4 Home Address is set to the IPv4 Home Address allocated for the UE. The supporting Status field is set accordingly. Pref-len field is set to "32". | IETF RFC 5555 [2] | +| NAT Detection Option | C | When present the option contains the F Flag which indicates to the UE that UDP encapsulation is required. Option contains an optionally Refresh Time for the UE to refresh the NAT binding. | IETF RFC 5555 [2] | +| Binding Refresh Advice | O | Contains a Refresh Interval in units of 4 seconds indicating the remaining time until the UE should send a new home registration to the HA. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE sent a Binding Identifier mobility option in the corresponding BU. The Status field is set accordingly. The BID, BID-PRI and "H" flag are set to the value indicated in the BID mobility option of the received Binding Update. | IETF RFC 5648 [31], IETF RFC 6089 [32] | +| Flow Identification mobility option | C | The option is present if the UE sent a Flow Identification mobility option in the corresponding BU. The Status field is set accordingly. The FID, FID-PRI, Action field and sub-option field are set to the value indicated in the FID mobility option of the received Binding Update. | IETF RFC 6089 [32], IETF RFC 6088 [33] | + +### A.2.3 Binding Error + +The fields of a BE message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.2.3-1. + +**Table A.2.3-1: Fields of a BE message for the DSMIPv6 Initial Binding Registration procedure** + +| Fields | Fields Description | Reference | +|---------------|----------------------------------------------------------------------------|--------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Home Address | The home address that was contained in the Home Address destination option | IETF RFC 6275 [27] | + +## A.3 Re-Registration + +### A.3.1 Binding Update + +The fields of a BU message for the DSMIPv6 Re-Registration procedure are depicted in Table A.3.1-1. + +The Mobility Options in a BU message for the DSMIPv6 Re-Registration procedure are depicted in Table A.3.1-2. + +**Table A.3.1-1: Fields of a BU message for the DSMIPv6 Re-Registration procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [27] | +| Home Registration (H) | Set to "1" to indicate receiving node should act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" to indicate home network prefix preservation for the UE. | IETF RFC 3963 [29] | +| Overwrite Flag (O) | Set to "0" to maintain all binding cache entries at the HA previously registered. | IETF RFC 5648 [31] | + +**Table A.3.1-2: Mobility Options in a BU message for the DSMIPv6 Re-Registration procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Home Address option | C |

If the UE has previously registered IPv4 home address and wants to keep it, it is included in the option. The "P" flag is not set. The Prefix Length is set to the requested prefix length of 32.

If the UE has previously registered IPv4 home address and wants to release it, it is not included in the BU.

If the UE has no IPv4 Home address it may set the value "0.0.0.0" to request allocation for the UE. In this case the "P" flag is set to "0".

The Prefix Length is set to the requested prefix length of 32.

| IETF RFC 5555 [2] | +| IPv4 Care-of Address | C | Set to the IPv4 Care-of address (same value as was set in the Initial BU) when in an IPv4 Access Network | IETF RFC 5555 [2] | +| Alternate Care-of Address | C | Used (in addition to the Source address of the IPv6 packet) to carry the IPv6 care-of address when in an IPv6 access network. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C |

The option is present if the UE included a Binding Identifier mobility option in the BU previously sent to the Home Agent.

The BID and BID-PRI are set to an arbitrary value.

For registration of a home link, the "H" flag is set to "1" and the value of the CoA field is the Home Address.

For registration of a foreign link, the "H" flag is set to "0" and the value of the CoA field is the Care-of Address.

| IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| Flow Summary mobility option | C |

The option is present if the UE included a Flow Summary mobility option or at least one Flow Identification mobility option in the BU previously sent to the Home Agent.

Contain one or more FIDs present in the binding update list to refresh the respective flow bindings.

| IETF RFC 6089 [32] | + +### A.3.2 Binding Acknowledgement + +The fields of a BA message for the DSMIPv6 Re-Registration procedure are depicted in Table A.3.2-1. + +The Mobility Options in a BA message for the DSMIPv6 Re-Registration procedure are depicted in Table A.3.2-2. + +**Table A.3.2-1: Fields of a BA message for the DSMIPv6 Re-Registration procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27],
IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" | IETF RFC 3963 [29] | +| Sequence Number | Set to the value received in the corresponding Binding Update or the last accepted sequence number in the case of Status 135 ("Sequence Number out of window"). | IETF RFC 6275 [27] | +| Lifetime | Set to the granted number of time units of 4 seconds the binding shall remain valid. | IETF RFC 6275 [27] | + +**Table A.3.2-2: Mobility Options in a BA message for the DSMIPv6 Re-Registration procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Address Acknowledgment option | C | If IPv4 Home Address option is present in the corresponding BU, IPv4 Home Address is set to the IPv4 Home Address previously allocated for the UE or to a dynamically allocated value if the UE had no previous IPv4 home address and requested one at with the BU. The supporting Status field is set accordingly. Pref-len field is set to "32". | IETF RFC 5555 [2] | +| NAT Detection Option | C | When present the option contains the F Flag which indicates to the UE that UDP encapsulation is required. Option contains an optionally Refresh Time for the UE to refresh the NAT binding. | IETF RFC 5555 [2] | +| Binding Refresh Advice | O | Contains a Refresh Interval in units of 4 seconds indicating the remaining time until the UE should send a new home registration to the HA. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE sent a Binding Identifier mobility option in the corresponding BU. The Status field is set accordingly. The BID, BID-PRI and "H" flag are set to the value indicated in the BID mobility option of the received Binding Update. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| Flow Identification mobility option | O | The Status field is set accordingly. The FID, FID-PRI, Action field and sub-option field are set to the value indicated in the Flow Summary mobility option of the received Binding Update. | IETF RFC 6089 [32],
IETF RFC 6088 [33] | + +## A.4 Handover + +### A.4.1 Binding Update + +The fields of a BU message for the DSMIPv6 Handover procedure are depicted in Table A.4.1-1. + +The Mobility Options in a BU message for the DSMIPv6 Handover procedure are depicted in Table A.4.1-2. + +**Table A.4.1-1: Fields of a BU message for the DSMIPv6 Handover procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [27] | +| Home Registration (H) | Set to "1" to indicate receiving node should act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility. | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" to indicate home network prefix preservation for the UE. | IETF RFC 3963 [29] | +| Overwrite Flag (O) | Set accordingly if the BID mobility option is present in the Binding Update. The purpose is to indicate replacing all binding cache entries at the HA with the entries listed in the Binding Update. | IETF RFC 5648 [31] | + +**Table A.4.1-2: Mobility Options in a BU message for the DSMIPv6 Handover procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Home Address option | C | For dynamic allocation, set to the value "0.0.0.0" to request allocation for the UE. In this case the "P" flag is set to "0".
The Prefix Length is set to the requested prefix length of "32".

If the UE already has an IPv4 Home Address and wants to keep on using it, the IPv4 home address is set to the previously allocated value. The "P" flag is not set. The Prefix Length is set to "32".

If the UE already has an IPv4 Home Address and wants to release it, the option is not inserted in the BU, | IETF RFC 5555 [2] | +| IPv4 Care-of Address | C | Set to the IPv4 Care-of address when in an IPv4 Access Network. | IETF RFC 5555 [2] | +| Alternate Care-of Address | C | Used (in addition to the Source address of the IPv6 packet) to carry the IPv6 care-of address when in an IPv6 access network. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE included a Binding Identifier mobility option in the BU previously sent to the Home Agent.
The BID and BID-PRI are set to an arbitrary value.
For registration of a home link, the "H" flag is set to "1" and the value of the CoA field is the Home Address.
For registration of a foreign link, the "H" flag is set to "0" and the value of the CoA field is the Care-of Address. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| Flow Summary mobility option | C | The option is present if the UE included a Flow Summary mobility option or at least one Flow Identification mobility option in the BU previously sent to the Home Agent.
Contain one or more FIDs present in the binding update list to refresh the respective flow bindings. | IETF RFC 6089 [32] | + +### A.4.2 Binding Acknowledgement + +The fields of a BA message for the DSMIPv6 Handover procedure are depicted in Table A.4.2-1. + +The Mobility Options in a BA message for the DSMIPv6 Handover procedure are depicted in Table A.4.2-2. + +**Table A.4.2-1: Fields of a BA message for the DSMIPv6 Handover procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27],
IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" | IETF RFC 3963 [29] | +| Sequence Number | Set to the value received in the corresponding Binding Update or the last accepted sequence number in the case of Status 135 (" Sequence Number out of window"). | IETF RFC 6275 [27] | +| Lifetime | Set to the granted number of time units of 4 seconds the binding shall remain valid. | IETF RFC 6275 [27] | + +**Table A.4.2-2: Mobility Options in a BA message for the DSMIPv6 Handover procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Address Acknowledgment option | C | If IPv4 Home Address option is present in the corresponding BU, IPv4 Home Address is set to the IPv4 Home Address either newly allocated for the UE or previously assigned prior to the Handover. The supporting Status field is set accordingly. The Pref-len is set to "32". | IETF RFC 5555 [2] | +| NAT Detection Option | C | When present the option contains the F Flag which indicates to the UE that UDP encapsulation is required. Option contains an optionally Refresh Time for the UE to refresh the NAT binding. | IETF RFC 5555 [2] | +| Binding Refresh Advice | O | Contains a Refresh Interval in units of four seconds indicating the remaining time until the UE should send a new home registration to the HA. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE sent a Binding Identifier mobility option in the corresponding BU. The Status field is set accordingly. The BID, BID-PRI and "H" flag are set to the value indicated in the BID mobility option of the received Binding Update. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| Flow Identification mobility option | O | The Status field is set accordingly. The FID, FID-PRI, Action field and sub-option field are set to the value indicated in the Flow Summary mobility option of the received Binding Update. | IETF RFC 6089 [32],
IETF RFC 6088 [33] | + +## A.5 UE-initiated Detach + +### A.5.1 Binding Update + +The fields of a BU message for the DSMIPv6 UE-Initiated Detach are depicted in Table A.5.1-1. + +The Mobility Options in a BU message for the DSMIPv6 UE-Initiated Detach are depicted in Table A.5.1-2. + +**Table A.5.1-1: Fields of a BU message for the DSMIPv6 UE-Initiated Detach procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | Set to a value of "0" indicating that the Binding Cache entry for the UE is to be deleted. | IETF RFC 6275 [27] | +| Home Registration (H) | Set to "1" to indicate receiving node should act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | + +**Table A.5.1-2: Mobility Options in a BU message for the DSMIPv6 UE-Initiated Detach procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|---------------------------|------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| IPv4 Home Address option | O | Set to the UE's previously registered value. The "P" flag is set to zero. The Prefix Length is set to 32. | IETF RFC 5555 [2] | +| IPv4 Care-of Address | C | Set to the IPv4 Care-of address when in an IPv4 Access Network. | IETF RFC 5555 [2] | +| Alternate Care-of Address | C | Used (in addition to the Source address of the IPv6 packet) to carry the IPv6 care-of address when in an IPv6 access network. | IETF RFC 6275 [27] | + +### A.5.2 Binding Acknowledgement + +The fields of a BA message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.5.2-1. + +The Mobility Options in a BA message for the DSMIPv6 Initial Binding Registration procedure are depicted in Table A.5.2-2. + +**Table A.5.2-1: Fields of a BA message for the DSMIPv6 UE-Initiated Detach procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27], IETF RFC 5555 [2] | +| Sequence Number | Set to the value received in the corresponding Binding Update or the last accepted sequence number in the case of Status 135 ("Sequence Number out of window"). | IETF RFC 6275 [27] | +| Lifetime | Set to "0". | IETF RFC 6275 [27] | + +**Table A.5.2-2: Mobility Options in a BA message for the DSMIPv6 UE-Initiated Detach procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| IPv4Address Acknowledgment option | C | If present in the BU the IPv4 Home Address is set to the IPv4 Home Address that is now de-registered. The pref-len is set to "32" and the supporting Status field is set accordingly. | IETF RFC 5555 [2] | + +## A.6 Network-initiated detach + +### A.6.1 Binding Revocation Indication Message + +The fields of a Binding Revocation Indication message for the Network-Initiated Detach are depicted in table A.6.1-1. + +**Table A.6.1-1: Fields of a BRI message for the Network-Initiated Detach procedure** + +| Fields | Fields Description | Reference | +|---------------------------|---------------------------------------------------------------------------------------------------------------|--------------------| +| B.R. Type | Set to "1" to indicate B.R.I. | IETF RFC 5846 [19] | +| Sequence Number | Set to a monotonically increasing value and is used to match with the returned Binding Revocation Acknowledge | IETF RFC 5846 [19] | +| Revocation Trigger | Set to "1" | IETF RFC 5846 [19] | +| Proxy Binding (P) | Set to "0" | IETF RFC 5846 [19] | +| Global (G) | Set to "0" | IETF RFC 5846 [19] | +| IPv4 HoA Binding Only (V) | Set to "0" | IETF RFC 5846 [19] | + +### A.6.2 Binding Revocation Acknowledgement + +The fields of a BRA message for the Network-Initiated Detach procedure are depicted in Table A.6.2-1. + +**Table A.6.2-1: Fields of a BRA message for the Network-Initiated Detach procedure** + +| Fields | Fields Description | Reference | +|-----------------------------|-----------------------------------------------------------------------------------------------------------|--------------------| +| B.R. Type | Set to "2" to indicate B.R.A. | IETF RFC 5846 [19] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [19] | +| Status | Indicates the result of the BRI. | IETF RFC 5846 [19] | +| Proxy Registration Flag (P) | Set to "0" to indicate that the Binding Revocation Acknowledgment is NOT for a proxy MIPv6 binding entry. | IETF RFC 5846 [19] | +| Global (G) | Set to "0"; the same value as for the BRI. | IETF RFC 5846 [19] | +| IPv4 HoA Binding Only (V) | Set to "0" | IETF RFC 5846 [19] | + +## A.7 Void + +## A.8 Attach to an additional access network + +### A.8.1 Binding Update + +The DSMIPv6 attach to additional access network procedure is described in subclause 5.5 and the fields of a BU message used for this procedure are depicted in table A.8.1-1. + +The DSMIPv6 attach to additional access network procedure is described in subclause 5.5 and the Mobility Options in a BU message used for this procedure are depicted in table A.8.1-2. + +**Table A.8.1-1: Fields of a BU message for the DSMIPv6 attach to an additional access network procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | Set to the requested number of time in units of 4 seconds to indicate how long the binding will remain valid. | IETF RFC 6275 [27] | +| Home Registration (H) | Set to "1" to indicate receiving node can act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" to indicate home network prefix preservation for the UE. | IETF RFC 3963 [29] | +| Overwrite Flag (O) | If the UE attaches to a foreign link, set to "1" to indicate first registration
If the UE attaches to the home link, set to "0" to maintain all binding cache entries at the HA previously registered. | IETF RFC 5648 [31] | + +**Table A.8.1-2: Mobility Options in a BU message for the DSMIPv6 attach to an additional access network procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Home Address option | O | Set to the value "0.0.0.0" to request allocation of an IPv4 Home Address for the UE. | IETF RFC 5555 [2] | +| | | The "P" flag is set to '0'. | | +| | | The Prefix Length is set to the requested prefix length of '32'. | | +| Binding Identifier mobility option | O | The BID and BID-PRI are set to an arbitrary value. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | For registration of a home link, the "H" flag is set to "1" and the value of the CoA field is the Home Address. | | +| | | For registration of a foreign link, the "H" flag is set to "0" and the value of the CoA field is the Care-of Address. | | +| Flow Identification mobility option | O | The FID and FID-PRI are set to an arbitrary value. | IETF RFC 6089 [32],
IETF RFC 6088 [33] | +| | | The sub-option field conveys the Traffic Selector sub-option. | | +| Flow Summary mobility option | O | Contain one or more FIDs present in the binding update list to refresh the respective flow bindings. | IETF RFC 6089 [32] | + +### A.8.2 Binding Acknowledgement + +The DSMIPv6 attach to additional access network procedure is described in subclause 5.5 and the fields of a BA message used for this procedure are depicted in table A.8.2-1. + +The DSMIPv6 attach to additional access network procedure is described in subclause 5.5 and the Mobility Options in a BA message used for this procedure are depicted in table A.8.2-2. + +**Table A.8.2-1: Fields of a BA message for the DSMIPv6 attach to an additional access network procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27],
IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" | IETF RFC 3963 [29] | +| Sequence Number | Set to the value received in the corresponding Binding Update. | IETF RFC 6275 [27] | +| Lifetime | Set to the granted number of time units of 4 seconds to indicate how long the binding will remain valid. | IETF RFC 6275 [27] | + +**Table A.8.2-2: Mobility Options in a BA message for the DSMIPv6 attach to an additional access network procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Address Acknowledgment option | C | If IPv4 Home Address option is present in the corresponding BU, IPv4 Home Address is set to the IPv4 Home Address allocated for the UE.
The supporting Status field is set accordingly. | IETF RFC 5555 [2] | +| | | Pref-len field is set to "32". | | +| | | | | +| NAT Detection Option | C | When present the option contains the F Flag which indicates to the UE that UDP encapsulation is required. Option contains an optionally Refresh Time for the UE to refresh the NAT binding. | IETF RFC 5555 [2] | +| Binding Refresh Advice | O | Contains a Refresh Interval in units of 4 seconds indicating the remaining time until the UE could send a new home registration to the HA. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE sent a Binding Identifier mobility option in the corresponding BU.
The Status field is set accordingly. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | The BID and BID-PRI are set to the value indicated in the BID mobility option of the received Binding Update. | | +| Flow Identification mobility option | C | The option is present if the UE sent a Flow Identification mobility option in the corresponding BU.
The Status field is set accordingly. | IETF RFC 6089 [32],
IETF RFC 6088 [33] | +| | | The FID, FID-PRI and sub-option field are set to the value indicated in the FID mobility option of the received Binding Update. | | + +## A.9 Inter-access flow mobility + +### A.9.1 Binding Update + +The DSMIPv6 inter-access flow mobility procedure is described in subclause 5.5 and the fields of a BU message used for this procedure are depicted in table A.9.1-1. + +The DSMIPv6 inter-access flow mobility procedure is described in subclause 5.5 and the Mobility Options in a BU message used for this procedure are depicted in table A.9.1-2. + +**Table A.9.1-1: Fields of a BU message for the DSMIPv6 inter-access flow mobility procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | Set to the requested number of time in units of 4 seconds to indicate how long the binding will remain valid. | IETF RFC 6275 [27] | +| Home Registration (H) | Set to "1" to indicate receiving node can act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" to indicate home network prefix preservation for the UE. | IETF RFC 3963 [29] | +| Overwrite Flag (O) | Set to "0" to indicate not replacing all binding cache entries at the HA with the entries listed in the Binding Update | IETF RFC 5648 [31] | + +**Table A.9.1-2: Mobility Options in a BU message for the DSMIPv6 inter-access flow mobility procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Home Address option | O | For dynamic allocation, set to the value "0.0.0.0" to request allocation for the UE. | IETF RFC 5555 [2] | +| | | If the UE already has an IPv4 Home Address and wants to keep on using it, the IPv4 home address is set to the previously allocated value. | | +| | | If the UE already has an IPv4 Home Address and wants to release it, the option is not inserted in the BU. | | +| | | If the UE request allocation of IPv4 Home Address, the "P" flag is set to '0'. | | +| | | If the UE already has an IPv4 Home Address and wants to keep on using it, the "P" flag is not set. | | +| | | The Prefix Length is set to the requested prefix length of '32'. | | +| Binding Identifier mobility option | O | The BID is set to the value identifying the routing address used as Source IP Address of the Binding Update. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | The BID-PRI is set to the value assigned to the BID. | | +| | | If the Binding Update message is sent on a home link, the "H" flag is set to "1". | | +| | | If the Binding Update message is sent on a foreign link, the "H" flag is set to "0". | | +| | | If the routing address used as IP Source Address of the Binding Update message is an IPv4 address, a NAT was detected and the UE is not exchanging data traffic, the Care-of Address field is set to the routing address. | | +| Flow Identification mobility option | O | For creating routing rules, the FID and FID-PRI are set to an arbitrary value. | IETF RFC 6089 [32],
IETF RFC 6088 [33] | +| | | For modifying routing rules, the FID and FID-PRI are set to the value identifying the routing filter the UE wants to modify. | | +| | | The sub-option field conveys the Traffic Selector sub-option. | | +| Flow Summary mobility option | O | Contain one or more FIDs present in the binding update list to refresh the respective flow bindings. | IETF RFC 6089 [32] | + +### A.9.2 Binding Acknowledgement + +The DSMIPv6 inter-access flow mobility procedure is described in subclause 5.5 and the fields of a BA message used for this procedure are depicted in table A.9.2-1. + +The DSMIPv6 inter-access flow mobility procedure is described in subclause 5.5 and the Mobility Options in a BA message used for this procedure are depicted in table A.9.2-2. + +**Table A.9.2-1: Fields of a BA message for the DSMIPv6 inter-access flow mobility procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27],
IETF RFC 5555 [2] | +| Mobile Router Flag (R) | Set to "1" | IETF RFC 3963 [29] | +| Sequence Number | Set to the value received in the corresponding Binding Update. | IETF RFC 6275 [27] | +| Lifetime | Set to the granted number of time units of 4 seconds to indicate how long the binding will remain valid. | IETF RFC 6275 [27] | + +**Table A.9.2-2: Mobility Options in a BA message for the DSMIPv6 inter-access flow mobility procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|-------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| IPv4 Address Acknowledgment option | C | If IPv4 Home Address option is present in the corresponding BU, IPv4 Home Address is set to the IPv4 Home Address either newly allocated for the UE or previously assigned prior to the Handover.
The supporting Status field is set accordingly. | IETF RFC 5555 [2] | +| | | Pref-len field is set to "32". | | +| | | | | +| NAT Detection Option | C | When present the option contains the F Flag which indicates to the UE that UDP encapsulation is required. Option contains an optionally Refresh Time for the UE to refresh the NAT binding. | IETF RFC 5555 [2] | +| Binding Refresh Advice | O | Contains a Refresh Interval in units of 4 seconds indicating the remaining time until the UE could send a new home registration to the HA. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE sent a Binding Identifier mobility option in the corresponding BU.
The Status field is set accordingly. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | The BID and BID-PRI are set to the value indicated in the BID mobility option of the received Binding Update. | | +| | | | | +| Flow Identification mobility option | C | The option is present if the UE sent a Flow Identification mobility option in the corresponding BU.
The Status field is set accordingly. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | The FID, FID-PRI and sub-option field are set to the value indicated in the FID mobility option of the received Binding Update. | | + +## A.10 UE-initiated removal of an access network from a PDN connection + +### A.10.1 Binding Update + +The UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.8 and the fields of a BU message used for this procedure are depicted in table A.10.1-1. + +The UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.8 and the Mobility Options in a BU message used for this procedure are depicted in table A.10.1-2. + +**Table A.10.1-1: Fields of a BU message for the UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Fields | Fields Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a monotonically increasing value. | IETF RFC 6275 [27] | +| Lifetime | If the Binding Update is to de-register binding of the access network, the Lifetime is set to a value of "0". | IETF RFC 6275 [27] | +| | If the Binding Update is to register the maintained access network, the Lifetime is set to the requested number of time in units of 4 seconds to indicate how long the binding will remain valid. | | +| Home Registration (H) | Set to "1" to indicate receiving node can act as this node's HA | IETF RFC 6275 [27] | +| Link-local Address Compatibility (L) | The Link-Local Address Compatibility (L) bit is set when the home address reported by the mobile node has the same interface identifier as the mobile node's link-local address. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set to "1" to indicate IKEv2 SA ability to survive mobility | IETF RFC 6275 [27] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [27] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate no forced UDP encapsulation | IETF RFC 5555 [2] | +| Mobile Router Flag (R) | If the Binding Update is to register the maintained access network, the Mobile Router Flag (R) is set to "1" to indicate home network prefix preservation for the UE. | IETF RFC 3963 [29] | +| Overwrite Flag (O) | Set to any value if the lifetime field of the Binding Update is set to 0 | IETF RFC 5648 [31] | +| | Set to "1" if the lifetime field of the Binding Update is set to any value different from 0 | | + +**Table A.10.1-2: Mobility Options in a BU message for the UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Binding Identifier mobility option | O | For a Binding Update with Lifetime set to "0", the BID and BID-PRI are set to the corresponding entry that the UE wants to remove. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | For a Binding Update with Lifetime not set to "0", the BID and BID-PRI are set to the corresponding entry that the UE wants to maintain. | | + +### A.10.2 Binding Acknowledgement + +The UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.8 and the fields of a BA message used for this procedure are depicted in table A.10.2-1. + +The UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.8 and the Mobility Options in a BA message used for this procedure are depicted in table A.10.2-2. + +**Table A.10.2-1: Fields of a BA message for the UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Fields | Fields Description | Reference | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [27] | +| Key Management Mobility Capability (K) | Set as per HA ability to support the feature of updating the IKE SA based on Binding Update processing | IETF RFC 6275 [27],
IETF RFC 5555 [2] | +| Mobile Router Flag (R) | If the Binding Update is to register the maintained access network, the Mobile Router Flag (R) is set to "1" | IETF RFC 3963 [29] | +| Sequence Number | Set to the value received in the corresponding Binding Update or the last accepted sequence number in the case of Status 135 ("Sequence Number out of window"). | IETF RFC 6275 [27] | +| Lifetime |

If the Binding Update is to de-register binding of the access network, the Lifetime is set to a value of "0".

If the Binding Update is to register the maintained access network, the Lifetime is set to the granted number of time in units of 4 seconds to indicate how long the binding will remain valid.

| IETF RFC 6275 [27] | + +**Table A.10.2-2: Mobility Options in a BA message for the UE-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| NAT Detection Option | C | When present the option contains the F Flag which indicates to the UE that UDP encapsulation is required. Option contains an optionally Refresh Time for the UE to refresh the NAT binding. | IETF RFC 5555 [2] | +| Binding Refresh Advice | O | Contains a Refresh Interval in units of 4 seconds indicating the remaining time until the UE could send a new home registration to the HA. | IETF RFC 6275 [27] | +| Binding Identifier mobility option | C | The option is present if the UE sent a Binding Identifier mobility option in the corresponding BU. The Status field is set accordingly. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | +| | | For a Binding Update with Lifetime not set to "0", the BID and BID-PRI are set to the value indicated in the BID mobility option of the received Binding Update. | | + +## A.11 Network-initiated removal of an access network from a PDN connection + +### A.11.1 Binding Revocation Indication Message + +The network-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.9 and the fields of a BRI message used for this procedure are depicted in table A.11.1-1. + +The network-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.9 and the Mobility Options in a BRI message used for this procedure are depicted in table A.11.1-2. + +**Table A.11.1-1: Fields of a BRI message for the network-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Fields | Fields Description | Reference | +|---------------------------|---------------------------------------------------------------------------------------------------------------|--------------------| +| B.R. Type | Set to "1" to indicate BRI. | IETF RFC 5846 [19] | +| Sequence Number | Set to a monotonically increasing value and is used to match with the returned Binding Revocation Acknowledge | IETF RFC 5846 [19] | +| Revocation Trigger | Set to "1" | IETF RFC 5846 [19] | +| Proxy Binding (P) | Set to "0" | IETF RFC 5846 [19] | +| Global (G) | Set to "0" | IETF RFC 5846 [19] | +| IPv4 HoA Binding Only (V) | Set to "0" | IETF RFC 5846 [19] | + +**Table A.11.1-2: Mobility Options in a BRI message for the network-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|------------------------------------|------|-------------------------------------------------------------------------------------|-------------------------------------------| +| Binding Identifier mobility option | O | The BID and BID-PRI are set to the corresponding entry that the UE wants to remove. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | + +### A.11.2 Binding Revocation Acknowledgement + +The network-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.9 and the fields of a BRA message used for this procedure are depicted in table A.11.2-1. + +The network-initiated DSMIPv6 removal of an access network from a PDN connection procedure is described in subclause 5.9 and the Mobility Options in a BRA message used for this procedure are depicted in table A.11.2-2. + +**Table A.11.2-1: Fields of a BRA message for the network-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Fields | Fields Description | Reference | +|-----------------------------|-----------------------------------------------------------------------------------------------------------|--------------------| +| B.R. Type | Set to "2" to indicate BRA. | IETF RFC 5846 [19] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [19] | +| Status | Indicates the result of the BRI. | IETF RFC 5846 [19] | +| Proxy Registration Flag (P) | Set to "0" to indicate that the Binding Revocation Acknowledgment is NOT for a proxy MIPv6 binding entry. | IETF RFC 5846 [19] | +| Global (G) | Set to "0"; the same value as for the BRI. | IETF RFC 5846 [19] | +| IPv4 HoA Binding Only (V) | Set to "0" | IETF RFC 5846 [19] | + +**Table A.11.2-2: Mobility Options in a BRA message for the network-initiated DSMIPv6 removal of an access network from a PDN connection procedure** + +| Mobility Option | Cat. | Mobility Option Description | Reference | +|------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Binding Identifier mobility option | C | This option may be included to indicate the specific BID that failed the revocation procedure.
The BID and BID-PRI are set to the value indicated in the BID mobility option of the received Binding Revocation Indication. | IETF RFC 5648 [31],
IETF RFC 6089 [32] | + +# Annex B (normative): Extensions specific to the present document + +## B.1 PDN Identifier notify payload + +The format of the PDN Identifier notify payload is shown in figure B.1-1. + +The PDN Identifier notify payload type is 40960. The length of the PDN Identifier notify payload is 21 octets. The IPv6 Home Network Prefix contains the IPv6 prefix of a PDN connection. The Prefix Length field indicates the length of the prefix contained in IPv6 Home Network Prefix field. + +The other fields are defined by IETF RFC 5996 [14]. + +| Bits | | | | | | | | Octets | +|--------------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | +| IPv6 Home Network Prefix | | | | | | | | 5 – 20 | +| Prefix Length | | | | | | | | 21 | + +**Figure B.1-1: PDN Identifier notify payload format** + +NOTE: As the notify payload notifies information relating an IKE\_SA, SPI Size field is set to 0 and there is no Security Parameter Index field. + +## B.2 IFOM Capability notify payload + +The format of the IFOM Capability notify payload is shown in figure B.2-1. + +The IFOM Capability notify payload type is 16428. The length of the IFOM Capability notify payload is 4 octets. The IFOM Capability notify payload is used to indicate the IFOM capability. + +The other fields are defined by IETF RFC 5996 [14]. + +| Bits | | | | | | | | Octets | +|---------------------|---|---|---|---|---|---|---|--------| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | +| Protocol ID | | | | | | | | 1 | +| SPI Size | | | | | | | | 2 | +| Notify Message Type | | | | | | | | 3-4 | + +**Figure B.2-1: IFOM Capability notify payload format** + +NOTE: As the notify payload notifies information relating to an IKE\_SA, SPI Size field is set to 0 and there is no Security Parameter Index field. + +# --- Annex C (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +|---------|---------------|-----------|------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| 01-2008 | | | | | Version 0.0.0 Editor's internal draft | | 0.0.0 | +| 02-2008 | CT1 #51 | | | | Includes the following contributions agreed in CT1 #51: C1-080436, C1-080437 | 0.0.0 | 0.1.0 | +| 02-2008 | CT1 #51bis | | | | Includes the following contributions agreed in CT1 #51bis: C1-080770, C1-080776, C1-080791. | 0.1.0 | 0.2.0 | +| 02-2008 | Email-review | | | | Editorial/style corrections in the clean version | 0.2.0 | 0.2.1 | +| 04-2008 | CT1 #52 | | | | Includes the following contributions agreed in CT1 #52: C1-080954, C1-080959, C1-080960, C1-081213, C1-081232, C1-081398, C1-081399, C1-081400, C1-081401, C1-081402, C1-081419 | 0.2.1 | 0.3.0 | +| 04-2008 | Email-review | | | | Editorial/style corrections in the clean version | 0.3.0 | 0.3.1 | +| 05-2008 | CT1 #53 | | | | Includes the following contributions agreed in CT1 #53: C1-081590, C1-081594, C1-081693, C1-082079, C1-082080, C1-082082, C1-082083, C1-082084, C1-082063 | 0.3.1 | 0.4.0 | +| 05-2008 | Email-review | | | | Editorial clean-up | 0.4.0 | 0.4.1 | +| 05-2008 | | | | | Version 1.0.0 to be presented to CT-40 created by MCC | 0.4.1 | 1.0.0 | +| 07-2008 | CT1 #54 | | | | Includes the following contributions agreed in CT1 #54: C1-082122, C1-082364, C1-082368, C1-082693, C1-082694, C1-082698, C1-082699, C1-082700 and C1-082808 | 1.0.0 | 1.1.0 | +| 08-2008 | CT1 #55 | | | | Includes the following contributions agreed in CT1 #55: C1-082827, C1-082828, C1-082989, C1-083003, C1-083004, C1-083486, C1-083488, C1-083524 and C1-083601 | 1.1.0 | 1.2.0 | +| 10-2008 | CT1 #55bis | | | | Includes the following contributions agreed in CT1 #55bis: C1-083858, C1-083861, C1-084384, C1-084454, C1-084455, C1-084457, C1-084458, C1-084460, C1-084461, C1-084553, C1-084563, C1-084564, C1-084565 | 1.2.0 | 1.3.0 | +| 11-2008 | CT1 #56 | | | | Includes the following contributions agreed in CT1 #56: C1-084692, C1-084693, C1-085379, C1-085517 | 1.3.0 | 1.4.0 | +| 11-2008 | E-mail review | | | | Editorial clean-up | 1.4.0 | 1.4.1 | +| 11-2008 | E-mail review | | | | Editorial clean-up | 1.4.1 | 1.4.2 | +| 11-2008 | E-mail review | | | | Editorial clean-up | 1.4.2 | 1.4.3 | +| 11-2008 | | | | | Version 2.0.0 created for presentation to CT#42 for approval | 1.4.3 | 2.0.0 | +| 12-2008 | | | | | Version 8.0.0 created after approval in CT#42 | 2.0.0 | 8.0.0 | +| 03-2009 | CT-43 | CP-090126 | 0001 | 1 | Binding Update Optimization | 8.0.0 | 8.1.0 | +| 03-2009 | CT-43 | CP-090126 | 0003 | | BRI error correction | 8.0.0 | 8.1.0 | +| 03-2009 | CT-43 | CP-090129 | 0005 | 1 | Missing HA Initiated Multiple PDN Detach | 8.0.0 | 8.1.0 | +| 03-2009 | CT-43 | CP-090129 | 0007 | | IPv4 HoA release | 8.0.0 | 8.1.0 | +| 03-2009 | CT-43 | CP-090125 | 0008 | 1 | Align with latest version of internet draft | 8.0.0 | 8.1.0 | +| 03-2009 | CT-43 | | | | Editorial cleanup by MCC | 8.0.0 | 8.1.0 | +| 06-2009 | CT-44 | CP-090413 | 0004 | 3 | Discovery of the Home Agent address | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090413 | 0011 | 1 | HA discovery via DHCPv6 | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090413 | 0012 | | Nemo Binding Acknowledgement Status value clarification | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090413 | 0013 | | Alternate Care-of Address correction | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090413 | 0014 | | TLV Header Format flag references | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090413 | 0016 | | Update to the Binding Revocation Indication Message | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090413 | 0017 | | Clarification of routing header usage | 8.1.0 | 8.2.0 | +| 06-2009 | CT-44 | CP-090324 | 0018 | 3 | HA reallocation procedure and Home Address request | 8.1.0 | 8.2.0 | +| 09-2009 | CT-45 | CP-090655 | 0019 | | DNS lookup at HA discovery based on DHCPv6 | 8.2.0 | 8.3.0 | +| 09-2009 | CT-45 | CP-090655 | 0021 | 1 | Clarification of IPv4 Home Address request | 8.2.0 | 8.3.0 | +| 09-2009 | CT-45 | CP-090655 | 0023 | 1 | Update of TS after DS-MIPv6 RFC availability | 8.2.0 | 8.3.0 | +| 09-2009 | CT-45 | CP-090655 | 0024 | 1 | Remove the static HNP configured in LTE capable UE | 8.2.0 | 8.3.0 | +| 09-2009 | CT-45 | CP-090655 | 0025 | | IPv4 address acknowledgement option type | 8.2.0 | 8.3.0 | +| 09-2009 | CT-45 | CP-090655 | 0027 | | Deletion of SA to the initial HA during HA reallocation procedure | 8.2.0 | 8.3.0 | +| 12-2009 | CT-46 | CP-090901 | 0028 | | RFC5555 missing reference | 8.3.0 | 8.4.0 | +| 12-2009 | CT-46 | CP-090901 | 0030 | | A bit in BRI message | 8.3.0 | 8.4.0 | +| 12-2009 | CT-46 | CP-090901 | 0031 | 1 | UE procedures at BRI reception | 8.3.0 | 8.4.0 | +| 12-2009 | CT-46 | CP-090901 | 0029 | 2 | Clarification of Binding Error message | 8.4.0 | 9.0.0 | +| 03-2010 | CT-47 | CP-100107 | 0035 | 1 | Multiple PDN connections | 9.0.0 | 9.1.0 | +| 03-2010 | CT-47 | CP-100107 | 0037 | 1 | PDN connections | 9.0.0 | 9.1.0 | + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +|---------|-------|-----------|------|-----|---------------------------------------------------------------------------------|--------|--------| +| 03-2010 | CT-47 | CP-100107 | 0039 | | Reference to redirect RFC | 9.0.0 | 9.1.0 | +| 06-2010 | CT-48 | CP-100339 | 0042 | | Reference Updates | 9.1.0 | 9.2.0 | +| 06-2010 | CT-48 | CP-100339 | 0044 | 2 | Usage of PDN prefix information with multiple PDNs to the same APN | 9.1.0 | 9.2.0 | +| 09-2010 | CT-49 | CP-100485 | 0048 | 3 | Usage of PDN Identifier notify payload | 9.2.0 | 9.3.0 | +| 09-2010 | CT-49 | CP-100513 | 0049 | 4 | IFOM Reference and Definitions | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0050 | 6 | UE behaviour with multiple PDN connection for IFOM | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0053 | 3 | Attach to additional access - general | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0054 | 5 | Dual Stack Mobile IPv6 inter-access flow mobility | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0055 | 2 | Attach to additional access acting as home link – UE behaviour | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0056 | 2 | Attach to additional access acting as visited link – UE behaviour | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0057 | 2 | Attach to additional access acting as home link – HA behaviour | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0058 | 1 | Attach to additional access acting as visited link - HA behavior | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0059 | 2 | Access removal - general | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0060 | | Home link access removal - UE behavior | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0061 | 2 | Visited link access removal - UE behavior | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0062 | | Removal of an access acting as home link – HA procedures | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0063 | 2 | Visited link access removal - HA behavior | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0064 | 1 | IFOM initial attachment | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100513 | 0065 | 1 | Message format for IP flow mobility | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100520 | 0066 | 2 | Support of IPv6 Prefix Delegation on S2c | 9.3.0 | 10.0.0 | +| 09-2010 | CT-49 | CP-100518 | 0067 | 1 | Usage of IP version for Care-of Address selection | 9.3.0 | 10.0.0 | +| 12-2010 | CT-50 | CP-100754 | 0069 | 2 | IFOM Attach to additional access procedure | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0070 | 2 | IFOM flow mobility procedure | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0071 | 1 | IFOM Remove a link - general | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0075 | 3 | Additional message format for IP flow mobility | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0077 | 1 | Clarification on Dual Stack Mobile IPv6 re-registration | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0078 | 3 | Network-initiated detach in multiple Care-of addresses use case | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100763 | 0079 | 1 | Delegated Prefix in HA | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100763 | 0080 | 1 | UE behaviour of DHCPv6 prefix delegation | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0082 | 2 | Clarification on IFOM capability | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0083 | 1 | Corrections and clarifications on IFOM procedures | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0084 | 5 | Access removal from PDN | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100763 | 0087 | | Assigned HNP in BA message | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0088 | 1 | IFOM Capability Discovery | 10.0.0 | 10.1.0 | +| 12-2010 | CT-50 | CP-100754 | 0089 | 2 | Error conditions for IFOM | 10.0.0 | 10.1.0 | +| 03-2011 | CT-51 | CP-110185 | 0093 | 1 | IFOM capability discovery through ISRP | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0094 | 3 | IFOM condition for binding acknowledge | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0095 | | IFOM error condition | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0096 | 1 | IFOM correction on attach to additional access procedure | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0098 | 1 | Network-initiated removal of an access | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0100 | 3 | Revision to Network-initiated Removal of Foreign Link from a PDN Connection | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0101 | | Modification of UE-initiated Removal of an Access Network from a PDN Connection | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0102 | 1 | Correction to pointer to TS 24.302 for IFOM procedure | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0103 | | IFOM extensions for handover | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0104 | | IFOM capability discovery – PCO usage correction | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0105 | | Correction on 'O' flag | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0106 | 1 | Protocol type definition for IFOM capability IKE-v2 payload | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0107 | 2 | Routing of packets for IFOM | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110185 | 0108 | | Removal of editor's note | 10.1.0 | 10.2.0 | +| 03-2011 | CT-51 | CP-110197 | 0109 | 2 | S2c data integrity protection | 10.1.0 | 10.2.0 | +| 06-2011 | CT-52 | CP-110478 | 0110 | 1 | References to RFC | 10.2.0 | 10.3.0 | +| 09-2011 | CT-53 | CP-110682 | 0111 | 1 | S2c data integrity protection over trusted non-3GPP access | 10.3.0 | 10.4.0 | +| 09-2011 | CT-53 | CP-110660 | 0115 | 2 | Correction of Home Agent discovery via DHCPv6 | 10.3.0 | 10.4.0 | +| 09-2011 | CT-53 | CP-110682 | 0117 | 1 | Correction to S2c data integrity protection – UE procedures | 10.3.0 | 10.4.0 | +| 09-2011 | CT-53 | CP-110690 | 0112 | 1 | Correction of security related reference | 10.4.0 | 11.0.0 | +| 09-2011 | CT-53 | CP-110690 | 0116 | 1 | Rejection of IKEv2 SA request | 10.4.0 | 11.0.0 | +| 09-2011 | CT-53 | CP-110690 | 0120 | 1 | Correction to references | 10.4.0 | 11.0.0 | +| 12-2011 | CT-54 | CP-110874 | 0121 | 2 | Correction to S2c data integrity protection – HA procedures | 11.0.0 | 11.1.0 | +| 06-2012 | CT-56 | CP-120300 | 0123 | | IETF reference update | 11.1.0 | 11.2.0 | + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +|---------|-------|-----------|------|-----|----------------------------------------------------------------------------------------------|--------|--------| +| 06-2012 | CT-56 | CP-120293 | 0125 | 4 | Correction to HA discovery based on DHCPv6 | 11.1.0 | 11.2.0 | +| 06-2012 | CT-56 | CP-120309 | 0126 | 1 | Generalize handover procedure to include also Care-of Address change independent of handover | 11.1.0 | 11.2.0 | +| 06-2012 | CT-56 | CP-120309 | 0127 | 1 | Corrections with references | 11.1.0 | 11.2.0 | +| 06-2013 | CT-60 | CP-130237 | 0129 | 1 | Specification of IFOM Capability notify payload type | 11.2.0 | 11.3.0 | +| 09-2014 | CT-65 | | | | Upgrade to Rel-12 | 11.3.0 | 12.0.0 | +| 12-2015 | CT-70 | | | | Upgrade to Rel-13 | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT-75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA-80 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24304/raw.md b/marked/Rel-16/24_series/24304/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6f8d804942170a07404f1aa1dd53406e2e63645e --- /dev/null +++ b/marked/Rel-16/24_series/24304/raw.md @@ -0,0 +1,313 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 General..... | 6 | +| 4.1 Mobility management based on FACoA..... | 6 | +| 4.2 Identities..... | 6 | +| 4.3 Multiple PDN connectivity ..... | 6 | +| 4.4 MIPv4 security aspects..... | 7 | +| 5 FACoA procedures for mobile IPv4 ..... | 7 | +| 5.1 FACoA initial attach and registration ..... | 7 | +| 5.1.1 General ..... | 7 | +| 5.1.2 UE procedures ..... | 7 | +| 5.1.2.1 Agent discovery ..... | 7 | +| 5.1.2.2 FACoA registration..... | 7 | +| 5.1.3 FA procedures ..... | 8 | +| 5.1.3.1 Agent advertisement ..... | 8 | +| 5.1.3.2 UE registration..... | 8 | +| 5.2 FACoA handover ..... | 8 | +| 5.2.1 General ..... | 8 | +| 5.2.2 UE procedures ..... | 8 | +| 5.2.3 FA procedures ..... | 9 | +| 5.3 FACoA deregistration ..... | 9 | +| 5.3.1 General ..... | 9 | +| 5.3.2 UE procedures ..... | 9 | +| 5.3.2.1 Network-initiated deregistration ..... | 9 | +| 5.3.2.2 UE-initiated deregistration..... | 10 | +| 5.3.3 FA procedures ..... | 10 | +| 5.3.3.1 Network-initiated deregistration ..... | 10 | +| 5.3.3.2 UE-initiated deregistration..... | 11 | +| Annex A (informative): Change history..... | 12 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the stage 3 aspects of mobility management for User Equipment (UE) using IETF Mobile IPv4 foreign agent mode to access the Evolved Packet Core Network (EPC) through trusted non-3GPP access networks and for mobility management of UE between the 3GPP access network and trusted non-3GPP access networks. + +In particular, the present document describes the UE – Mobile IPv4 Foreign Agent (FA) interface stage 3 aspects, where the FA functionality is located within the access network in the non-3GPP access domain. + +The present document is applicable to the User Equipment (UE) and the network node implementing the FA functionality. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 5944 (November 2010): "IP Mobility Support for IPv4, revised". +- [3] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [4] 3GPP TS 23.003: "Numbering, addressing and identification". +- [5] IETF RFC 5446 (February 2009): "Service Selection for Mobile IPv4". +- [6] 3GPP TS 33.402: "3GPP System Architecture Evolution; Security aspects for non-3GPP accesses". +- [7] IETF RFC 2794 (January 2000): "Mobile IP Network Access Identifier Extension for IPv4". +- [8] 3GPP TS 29.279: "Mobile IPv4 (MIPv4) based Mobility protocols; (Stage 3)". +- [9] IETF RFC 3543 (August 2003): "Registration Revocation in Mobile IPv4". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Foreign Agent (FA):** a router on a visited network which provides mobile IPv4 routing services to the UE while registered as described in IETF RFC 5944 [2]. + +**Foreign agent care-of address:** an address of a foreign agent with which the UE is registered as described in IETF RFC 5944 [2]. + +**Home Agent (HA):** a mobile IPv4 router on a UE's home network which tunnels datagrams for delivery to the UE while it is registered on a visited network as described in IETF RFC 5944 [2]. According to 3GPP TS 23.402 [3], the HA functionality is implemented in the PDN Gateway. + +## 3.2 Abbreviations + +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]. + +| | | +|-------|-------------------------------| +| EPC | Evolved Packet Core Network | +| FA | Foreign Agent | +| FACoA | Foreign Agent Care-of Address | +| HA | Home Agent | +| RRP | Registration Reply | +| RRQ | Registration Request | + +# --- 4 General + +## 4.1 Mobility management based on FACoA + +MIPv4 is specified in IETF RFC 5944 [2] which provides two alternative modes of enabling a mobile node (UE) to acquire a care-of address for routing of datagrams: + +- a "foreign agent care-of address" (FACoA) mode wherein a care-of address is provided by a FA through agent advertisement messages, or +- a "co-located care-of address" mode wherein a care-of address is acquired by the UE as a local IP address. + +For the purpose of IP mobility management while accessing the EPC through a trusted non-3GPP access network, the FACoA mode enables the UE to register the IP address of the FA (FACoA) located within the non-3GPP access network with the UE's HA for the routing of datagrams to the UE. + +## 4.2 Identities + +In order to support MIPv4 FA mode mobility management with the EPC, the network and mobile client shall use an NAI as described in 3GPP TS 23.003 [4] for user identification. The network and mobile client shall base the username part of the NAI on IMSI. + +The network and UE shall use the Root NAI when the UE attempts a MIPv4 registration while attached to the HPLMN. The Root NAI format is specified in 3GPP TS 23.003 [4]. + +The network and UE shall use the Decorated NAI when the UE attempts a MIPv4 registration while attached to a VPLMN. The Decorated NAI format is specified in 3GPP TS 23.003 [4]. + +## 4.3 Multiple PDN connectivity + +Following the establishment of a mobility binding to an initial PDN, the UE can request the establishment of a mobility binding with an additional PDN by including the APN of the desired PDN within a Service Selection extension defined in IETF RFC 5446 [5]. The Service Selection extension is included within the Registration Request (RRQ) message defined in IETF RFC 5944 [2]. The UE can repeat the process of sending an (RRQ) with a Service Selection extension to establish connectivity with additional PDNs. + +## 4.4 MIPv4 security aspects + +The procedures for bootstrapping of MIPv4 foreign agent care-of address (FACoA) security parameters are described in 3GPP TS 33.402 [6]. + +The MIPv4 security is based on the use of the authentication extensions defined in IETF RFC 5944 [2]. The MIPv4 signalling messages are protected between the UE and the HA using the Mobile-Home Authentication extension and optionally between the UE and the FA using the Mobile-Foreign Authentication extension. + +# 5 FACoA procedures for mobile IPv4 + +## 5.1 FACoA initial attach and registration + +### 5.1.1 General + +The MIPv4 initial attach is performed by the UE to establish a MIPv4 connection with the node acting as the HA. The initial attach involves the following procedures: + +- **Discovery of the HA address.** The UE needs to discover the IPv4 address of the node acting as the HA. +- **Discovery of FACoA.** The UE needs to discover the IPv4 care-of address provided by the FA. +- **IPv4 home address assignment.** The UE needs to be assigned an IPv4 address to be used as the home address in Mobile IPv4 FACoA mode. The HA is responsible of assigning the home address to the UE. +- **Security association establishment.** The UE needs to establish a security association with the node acting as the HA in order to secure the MIPv4 signalling. This procedure usually consists in a shared key verification and is performed via MIPv4 signalling. + +### 5.1.2 UE procedures + +#### 5.1.2.1 Agent discovery + +When the UE has attached to the non-3GPP access network, the UE may send a MIPv4 Agent Solicitation as specified in IETF RFC 5944 [2]. + +#### 5.1.2.2 FACoA registration + +Upon first receiving a MIPv4 Agent Advertisement message from a FA or detecting a reboot of the FA through inspection of the Agent Advertisement message sequence number, the UE shall select one care-of address included in the Mobility Agent Advertisement Extension and shall send an RRQ to the FA as specified in IETF RFC 5944 [2] with the care-of address included in the Care-of Address field of the RRQ message. The UE shall set the source address and Home Address field to the unspecified address (i.e. 0.0.0.0). The UE shall clear bits S (simultaneous binding) and D (decapsulation by mobile node), and set bit T (reverse tunnelling) to request reverse tunnelling. The UE shall also include the NAI extension as specified in IETF RFC 2794 [7]. + +As part of MIPv4 security, the UE shall include the Mobile-Home Authentication extension within the RRQ as specified in IETF RFC 5944 [2]. The UE shall set the authenticator and SPI fields of the of the Mobile-Home authentication extension to the MN-HA key and associated MN-HA-SPI generated as described in 3GPP TS 33.402 [6]. If the non-3GPP access specific procedures require a security association between the UE and FA, the UE shall also include the Mobile-Foreign Authentication extension within the RRQ as specified in IETF RFC 5944 [2]. The UE shall set the authenticator and SPI fields of the of the Mobile-Foreign authentication extension to the MN-FA key and associated MN-FA-SPI generated as described in 3GPP TS 33.402 [6]. + +If the UE already knows the IP address of the HA (e.g. when the HA address is pre-configured) the UE shall include that IP address in the Home Agent field. + +If the UE does not know the IP address of the HA, the UE shall include the unspecified address (i.e. 0.0.0.0) in the Home Agent field. + +If the UE has established a mobility binding with a given PDN and connection to an additional PDN is desired, the UE shall include the APN of the desired PDN within a Service Selection extension as defined in IETF RFC 5446 [5] within an RRQ as described in IETF RFC 5944 [2]. + +If the UE is registered on a trusted non-3GPP access network and maintenance of its registered mobility binding is desired, the UE shall re-register before the expiration of the lifetime of the registration as specified in IETF RFC 5944 [2]. If the UE has established connectivity to multiple PDNs, the UE shall re-register all mobility bindings. + +When the UE receives a Registration Reply (RRP) from the FA, the UE shall perform the validity checks and process the message as specified in IETF RFC 5944 [2] to include validation of the Mobile-Home Authentication extension and, + +if present, the Mobile-Foreign Authentication extension. After receiving a successful RRP, the UE shall store the HA address and the home address and may send data using the home address. + +### 5.1.3 FA procedures + +#### 5.1.3.1 Agent advertisement + +When the FA receives a MIPv4 Agent Solicitation, the FA shall send a MIPv4 Agent Advertisement to the UE as specified in IETF RFC 5944 [2]. The MIPv4 Agent Advertisement shall include only the Mobility Agent Advertisement Extension. + +The FA shall send an unsolicited MIPv4 Agent Advertisement when it receives a trigger that a new UE has attached to its link and it has not received a MIPv4 Agent Solicitation from the UE. In this case the FA shall set the destination address of the MIPv4 Agent Advertisement shall be the "limited broadcast" address (i.e. 255.255.255.255). + +For both solicited and unsolicited MIPv4 Agent Advertisements, the FA shall set the following bits in the Mobility Agent Advertisement Extension: R (registration required), F (foreign agent) and T (reverse tunnelling) (see IETF RFC 5944 [2]). The FA shall include at least one care-of address in the Mobility Agent Advertisement Extension. + +#### 5.1.3.2 UE registration + +When the FA receives an RRQ from the UE, the FA shall process it as specified in IETF RFC 5944 [2] and 3GPP TS 29.279 [8]. The FA shall validate the Mobile-Foreign Authentication extension if present. + +If the RRQ is accepted by the network, the FA shall send an RRP to the UE as specified in IETF RFC 5944 [2]. If the non-3GPP access specific procedures require a security association between the UE and FA, the FA shall also include the Mobile-Foreign Authentication extension within the RRP as specified in IETF RFC 5944 [2]. The FA shall set the authenticator and SPI fields of the Mobile-Foreign Authentication extension to the MN-FA key and associated MN-FA-SPI generated as described in 3GPP TS 33.402 [6]. + +## 5.2 FACoA handover + +### 5.2.1 General + +A MIPv4 handover occurs when the UE changes access between trusted non-3GPP accesses. A change in the local point of attachment will trigger a MIPv4 handover procedure. In this case, the UE has already an established binding at the HA, and the handover procedure will update the care-of address (FA IP address) of its binding. + +### 5.2.2 UE procedures + +The UE may detect a movement, based on the ICMP Lifetime field of the router advertisements: if the lifetime of an agent advertisement has expired, and the UE has not received another Agent Advertisement message from the same FA, then the UE can consider itself having moved. + +Another method for the UE to discover that it has moved is based on the advertised prefix: a change in the advertised prefix can aid the UE in determining that it has moved and to register with the newly advertised prefix. This method is only used when all mobility agents use the prefix length extension in their agent advertisements. + +NOTE: The UE can also detect the movement based on an indication from the layer 1 and layer 2. + +Upon detecting movement, the UE shall register with the new FA as specified in IETF RFC 5944 [2] by sending an RRQ with the care-of address of the new FA included in the Care-of Address field of the message. The UE shall set the source address to the unspecified address (i.e. 0.0.0.0). The UE shall clear bits S (simultaneous binding) and D (decapsulation by mobile node), and set bit T (reverse tunnelling) to request reverse tunnelling. The UE shall also include the NAI extension as specified in IETF RFC 2794 [7]. + +As part of MIPv4 security, the UE shall include the Mobile-Home Authentication extension within the RRQ as specified in IETF RFC 5944 [2]. The UE shall set the authenticator and SPI fields of the of the Mobile-Home authentication extension to the MN-HA key and associated MN-HA-SPI generated as described in 3GPP TS 33.402 [6]. If the non-3GPP access specific procedures require a security association between the UE and FA, the UE shall also include the Mobile-Foreign Authentication extension within the RRQ as specified in IETF RFC 5944 [2]. The UE shall set the authenticator and SPI fields of the of the Mobile-Foreign authentication extension to the MN-FA key and associated MN-FA-SPI generated as described in 3GPP TS 33.402 [6]. + +If the UE had maintained connectivity to multiple PDNs prior to the handover, the UE shall then update its mobility binding with each additional PDN using the procedure described in subclause 5.1.2.2. + +The UE shall include its known home address and the IP address of the HA within the RRQ. + +### 5.2.3 FA procedures + +The FA shall respond to agent solicitations sent by the UE, by addressing these agent solicitations to the unicast layer 2 and layer 3 addresses. + +When the FA receives a RRQ from the UE, the FA shall process it as specified in IETF RFC 5944 [2] and 3GPP TS 29.279 [8]. The FA shall validate the Mobile-Foreign Authentication extension if present. + +The FA relays the RRQ to the HA IP address found in the registration message. + +If the network accepts the RRQ, the FA shall send an RRP to the UE as specified in IETF RFC 5944 [2]. If the non-3GPP access specific procedures require a security association between the UE and FA, the FA shall also include the Mobile-Foreign Authentication extension within the RRQ as specified in IETF RFC 5944 [2]. The FA shall set the authenticator and SPI fields of the Mobile-Foreign Authentication extension to the MN-FA key and associated MN-FA-SPI generated as described in 3GPP TS 33.402 [6]. + +## 5.3 FACoA deregistration + +### 5.3.1 General + +MIPv4 deregistration is either due to a detach or a return home event. + +When the UE returns home, it will need to deregister from the HA. This can occur when the UE returns to the 3GPP network. In this scenario, the UE will de-register from the PDN-GW acting as an HA. + +### 5.3.2 UE procedures + +#### 5.3.2.1 Network-initiated deregistration + +Network-initiated deregistration can occur due to an administrative reason or detecting the UE's leaving the trusted non-3GPP access network. Network-initiated deregistration takes the form of registration revocation as defined in IETF RFC 3543 [9]. The FA or the HA can initiate registration revocation. + +The UE can be informed that its mobility binding no longer exists through inspection of the Agent Advertisement sequence number as described in IETF RFC 5944 [2]. + +Upon determining that its mobility binding no longer exists with the FA and HA, the UE shall locally clear its mobility binding. + +#### 5.3.2.2 UE-initiated deregistration + +The UE deregisters from its HA when it determines that it is back home or as part of a UE-initiated detach from the serving trusted non-3GPP access network. The UE can determine that it is back home through inspection of the H bit and advertised prefix within a received agent advertisement. + +In the case of UE deregistration upon returning home, the UE sends an RRQ with the destination address set to the HA's address, with a Lifetime field set to 0 to indicate deregistration, and with the care-of address set to the UE's home IP address. The RRQ will be formatted and handled as specified in IETF RFC 5944 [2]. The UE shall include the Mobile-Home Authentication extension within the RRQ as specified in IETF RFC 5944 [2] and shall set the authenticator and SPI fields of the of the authentication extension to the MN-HA key and associated MN-HA-SPI generated as described in 3GPP TS 33.402 [6]. + +In the case of UE deregistration as part of a UE-initiated detach from the serving trusted non-3GPP access network, the UE sends an RRQ with the Destination Address field set to the FA's address, with a Lifetime field set to 0 to indicate deregistration, and with the Care-of Address field set to the FA care-of address previously registered with the HA. The RRQ will be formatted and handled as specified in IETF RFC 5944 [2]. The UE shall include the Mobile-Home Authentication extension within the RRQ as specified in IETF RFC 5944 [2] and shall set the authenticator and SPI fields of the of the authentication extension to the MN-HA key and associated MN-HA-SPI generated as described in 3GPP TS 33.402 [6]. If the non-3GPP access specific procedures require a security association between the UE and FA, + +the UE shall also include the Mobile-Foreign Authentication extension within the RRQ as specified in IETF RFC 5944 [2] and shall set the authenticator and SPI fields of the Mobile-Foreign Authentication extension to the MN-FA key and associated MN-FA-SPI generated as described in 3GPP TS 33.402 [6]. + +If the UE has established connectivity to multiple PDNs, the UE shall perform this deregistration process for each PDN. The UE shall include a Service Selection extension as defined in IETF RFC 5446 [5] denoting the APN of the PDN to be deregistered in the RRQ. + +Once the deregistration request is accepted, the UE receives an RRP directly from the HA in the case of a "back home" deregistration or from the HA through the FA in the case of a deregistration as part of a UE initiated detach in the serving non-3GPP access network. The UE shall perform the validity checks on the Mobile-Home Authentication extension, and, if present, the Mobile-Foreign Authentication extension and processes the message as specified in IETF RFC 5944 [2]. + +### 5.3.3 FA procedures + +#### 5.3.3.1 Network-initiated deregistration + +Network-initiated deregistration can occur due to an administrative reason or detecting the UE's leaving the trusted non-3GPP access network. Network-initiated deregistration takes the form of registration revocation as defined in IETF RFC 3543 [9]. The FA or the HA can initiate registration revocation. + +The FA can initiate deregistration by sending a Registration Revocation message, as defined in IETF RFC 3543 [9], to the address of the HA. The Source Address field will be the care-of address of the FA registered by the UE, and the Home Address field will be the home IP address of the UE whose registration is being revoked. The HA will respond with a Registration Revocation Acknowledge message as specified in IETF RFC 3543 [9]. + +The HA can initiate deregistration by sending a Registration Revocation message to the FA providing the care-of address for the UE. The FA shall process the Registration Revocation message as described in IETF RFC 3543 [9] and respond to the HA with a Registration Revocation Acknowledge message. + +Following successful registration revocation, the FA may provide an indication to the UE that its mobility binding has been reset by appropriate setting of the Agent Advertisement sequence number as described in IETF RFC 5944 [2]. The FA may also initiate other actions to terminate the mobility session through other means that are beyond the scope of this document. + +#### 5.3.3.2 UE-initiated deregistration + +When the FA receives an RRQ with a Lifetime field set to 0 from the UE, the FA shall process it as specified in IETF RFC 5944 [2] and 3GPP TS 29.279 [8]. The FA shall validate the Mobile-Foreign Authentication extension if present. + +The FA shall relay the RRQ to the HA IP address found in the RRQ. + +If the HA accepts the RRQ, the FA shall send an RRP to the UE as specified in IETF RFC 5944 [2]. If the non-3GPP access specific procedures require a security association between the UE and FA, the FA shall also include the Mobile-Foreign Authentication extension within the RRQ as specified in IETF RFC 5944 [2]. The FA shall set the authenticator and SPI fields of the Mobile-Foreign Authentication extension to the MN-FA key and associated MN-FA-SPI generated as described in 3GPP TS 33.402 [6]. + +In case of a return home event, the deregistration procedure occurs between the UE and the HA; as such, the FA is not involved. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2008-01 | | | | | Draft scope provided by the rapporteur | | 0.0.0 | +| 2008-01 | CT1-51 | | | | Updated to include agreed scope C1-080569 | 0.0.0 | 0.1.0 | +| 2008-02 | CT1-51bis | | | | Includes the following contribution agreed by CT1: C1-080782 | 0.1.0 | 0.2.0 | +| 2008-04 | CT1-52 | | | | Includes the following contribution agreed by CT1: C1-081405 | 0.2.0 | 0.3.0 | +| 2008-04 | | | | | Minor editorial corrections | 0.3.0 | 0.3.1 | +| 2008-05 | CT1-53 | | | | Includes the following contributions agreed by CT1: C1-082087, C1-082088, C1-082089, C1-082090 | 0.3.1 | 0.4.0 | +| 2008-06 | CT1-54 | | | | Includes the following contributions agreed by CT1: C1-082686, C1-082687 | 0.4.0 | 0.5.0 | +| 2008-08 | CT1-55 | | | | Includes the following contributions agreed by CT1: C1-082986, C1-083307 | 0.5.0 | 0.6.0 | +| 2008-09 | | | | | Version 1.0.0 created for presentation to TSG CT#41 for information | 0.6.0 | 1.0.0 | +| 2008-10 | CT1-55bis | | | | Includes the following contributions agreed by CT1: C1-083981, C1-083982 | 1.0.0 | 1.1.0 | +| 2008-11 | CT1-56 | | | | Includes the following contributions agreed by CT1: C1-084779, C1-085380 | 1.1.0 | 1.2.0 | +| 2008-11 | | | | | Minor editorial corrections incorporated | 1.2.0 | 1.2.1 | +| 2008-11 | | | | | Version 2.0.0 created for presentation to TSG CT#42 for approval | 1.2.1 | 2.0.0 | +| 2008-12 | CT-42 | | | | Version 8.0.0 created after approval in CT#42 | 2.0.0 | 8.0.0 | +| 2009-12 | CT-46 | | | | Upgrade to Rel-9 | 8.0.0 | 9.0.0 | +| 2010-03 | CT-47 | CP-100107 | 0002 | | Update of reference for MIPv4 service selection | 9.0.0 | 9.1.0 | +| 2011-03 | CT-51 | CP-110163 | 0004 | | Reference update for MIPv4 | 9.1.0 | 9.2.0 | +| 2011-03 | CT-51 | | | | Upgrade to Rel-10 | 9.2.0 | 10.0.0 | +| 2012-09 | CT-57 | | | | Upgrade to Rel-11 | 10.0.0 | 11.0.0 | +| 2014-09 | CT-65 | | | | Upgrade to Rel-12 | 11.0.0 | 12.0.0 | +| 2015-12 | CT-70 | | | | Upgrade to Rel-13 | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT-75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA-80 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | SA-88e | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24305/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/24_series/24305/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..622ec1ffac67e9bb60a30cb0624fa44630ca4eda --- /dev/null +++ b/marked/Rel-16/24_series/24305/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04802e5af252b59aa24c2885a95f5eba0998c3da01f3bf557a864e9a716c974f +size 78483 diff --git a/marked/Rel-16/24_series/24305/raw.md b/marked/Rel-16/24_series/24305/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6eb8766278a87306dd9d479983026bb4c78919c6 --- /dev/null +++ b/marked/Rel-16/24_series/24305/raw.md @@ -0,0 +1,1312 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Selective Disabling of 3GPP UE Capabilities Management Object..... | 6 | +| 5 Management Object parameters..... | 7 | +| 5.1 General ..... | 7 | +| 5.2 Node: ..... | 7 | +| 5.3 //Name ..... | 7 | +| 5.4 //CS_Calls..... | 8 | +| 5.5 // CS_EmergencyCalls ..... | 8 | +| 5.5A //CS_EmergencyCalls/..... | 9 | +| 5.5B //CS_EmergencyCalls//Country..... | 9 | +| 5.5C //CS_EmergencyCalls//Country/Network..... | 9 | +| 5.6 //SupplementaryServices ..... | 9 | +| 5.7 //CS_SMS ..... | 10 | +| 5.8 //PS_SMS ..... | 10 | +| 5.9 //CS_LCS..... | 11 | +| 5.10 //PS_LCS..... | 11 | +| 5.11 //GPRS_SM_PDP..... | 11 | +| 5.12 //GPRS_SM_MBMS..... | 12 | +| 5.12A //EPS_SM_EPS ..... | 12 | +| 5.12B //APN..... | 13 | +| 5.12C //TrafficMappingInfo..... | 13 | +| 5.12D //NumberOfPacketFilters..... | 13 | +| 5.12E //PacketFilterList ..... | 14 | +| 5.12F //5GS_SM_PDU..... | 14 | +| 5.13 //IMS..... | 15 | +| 5.14 //Text ..... | 15 | +| 5.15 //CustomerCareNumbers/ ..... | 16 | +| 5.16 //CustomerCareNumbers/..... | 16 | +| 5.17 //CustomerCareNumbers//CustomerCareNumber ..... | 16 | +| 5.17A //AlertServerID..... | 16 | +| 5.18 // IMS_EmergencyCalls ..... | 17 | +| 5.19 //IMS_EmergencyCalls/..... | 17 | +| 5.20 //IMS_EmergencyCalls//Country..... | 17 | +| 5.21 //IMS_EmergencyCalls//Country/Network ..... | 18 | +| 5.22 //Ext ..... | 18 | +| Annex A (informative): Management Object DDF..... | 19 | +| Annex B (informative): Change history..... | 29 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies a mobile device Selective Disabling of 3GPP UE Capabilities (SDoUE) Management Object (MO) and the rules and corresponding behaviour of the UE with regard to the selective disabling of 3GPP UE capabilities, for example, when services or functions are disabled/enabled. + +The SDoUE MO is compatible with the OMA Device Management (DM) protocol specifications, version 1.2 and upwards, and is defined using the OMA DM Device Description Framework (DDF) as described in the Enabler Release Definition OMA-ERELD-DM-V1\_2 [8]. + +The SDoUE MO consists of the relevant parameters that can be managed for selective disabling of 3GPP UE capabilities. + +The SDoUE MO defines a repository of data into the ME. + +The service requirements for selective disabling of 3GPP UE capabilities are defined in 3GPP TS 22.011 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.011: "Service accessibility". +- [2A] 3GPP TS 23.003: "Numbering, addressing and identification". +- [3] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [4] 3GPP TS 24.010: "Mobile radio interface layer 3; Supplementary services specification; General aspects". +- [5] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [6] 3GPP TS 24.030: "Location Services (LCS); Supplementary service operations; Stage 3". +- [7] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3". +- [7A] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [7B] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [8] OMA-ERELD-DM-V1\_2: "Enabler Release Definition for OMA Device Management". +- [9] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [10] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] apply. + +## 3.2 Abbreviations + +| | | +|-------|---------------------------------------------| +| ACL | Access Control List | +| CS | Circuit Switched | +| DDF | Device Description Framework | +| DM | Device Management | +| EPS | Evolved Packet System | +| ESM | EPS Session Management | +| IMS | IP Multimedia core network Subsystem | +| MBMS | Multimedia Broadcast/Multicast Service | +| MCC | Mobile Country Code | +| MNC | Mobile Network Code | +| ME | Mobile Equipment | +| MO | Management Object | +| OMA | Open Mobile Alliance | +| PDP | Packet Data Protocol | +| PS | Packet Switched | +| SDoUE | Selective Disabling of 3GPP UE Capabilities | +| SM | Session Management | +| UE | User Equipment | + +# --- 4 Selective Disabling of 3GPP UE Capabilities Management Object + +The Selective Disabling of 3GPP UE Capabilities (SDoUE) Management Object (MO) is used to manage settings of the UE for remotely disabling selected UE capabilities. + +The Management Object Identifier is: urn:oma:mo:ext-3gpp-sdoue:1.0. + +The OMA DM Access Control List (ACL) property mechanism as standardized (see Enabler Release Definition OMA-ERELD-DM-V1\_2 [8]) may be used to grant or deny access rights to OMA DM servers in order to modify nodes and leaf objects of the SDoUE MO. + +The following nodes and leaf objects are possible under the SDoUE node: + +![Diagram of the SDoUE Management Object structure. The root node is . It has children: Name ?, CS_Calls ?, CS_EmergencyCalls ?, SupplementaryServices ?, CS_SMS ?, PS_SMS ?, CS_LCS ?, PS_LCS ?, GPRS_SM_PDP ?, GPRS_SM_MBMS ?, EPS_SM_EPS ?, 5GS_SM_PDU ?, Text ?, CustomerCareNumbers ?, AlertServerID ?, IMS_EmergencyCalls ?, and Ext ?. CS_EmergencyCalls ?, CustomerCareNumbers ?, and IMS_EmergencyCalls ? are followed by + nodes. CS_EmergencyCalls ?'s + node leads to Country, which leads to Network ?. CustomerCareNumbers ?'s + node leads to CustomerCareNumber. IMS_EmergencyCalls ?'s + node leads to Country, which leads to Network ?. GPRS_SM_PDP ?, GPRS_SM_MBMS ?, and EPS_SM_EPS ? are followed by TrafficMappingInfo ? nodes. TrafficMappingInfo ? nodes lead to PacketFilterList and NumberOfPacketFilters. EPS_SM_EPS ? also leads to APN ?.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` + +graph TD + X[""] --> Name["Name ?"] + X --> CS_Calls["CS_Calls ?"] + X --> CS_EmergencyCalls["CS_EmergencyCalls ?"] + X --> SupplementaryServices["SupplementaryServices ?"] + X --> CS_SMS["CS_SMS ?"] + X --> PS_SMS["PS_SMS ?"] + X --> CS_LCS["CS_LCS ?"] + X --> PS_LCS["PS_LCS ?"] + X --> GPRS_SM_PDP["GPRS_SM_PDP ?"] + X --> GPRS_SM_MBMS["GPRS_SM_MBMS ?"] + X --> EPS_SM_EPS["EPS_SM_EPS ?"] + X --> 5GS_SM_PDU["5GS_SM_PDU ?"] + X --> Text["Text ?"] + X --> CustomerCareNumbers["CustomerCareNumbers ?"] + X --> AlertServerID["AlertServerID ?"] + X --> IMS_EmergencyCalls["IMS_EmergencyCalls ?"] + X --> Ext["Ext ?"] + + CS_EmergencyCalls --> X_plus1[" +"] + X_plus1 --> Country1["Country"] + Country1 --> Network1["Network ?"] + + CustomerCareNumbers --> X_plus2[" +"] + X_plus2 --> CustomerCareNumber["CustomerCareNumber"] + + IMS_EmergencyCalls --> X_plus3[" +"] + X_plus3 --> Country2["Country"] + Country2 --> Network2["Network ?"] + + GPRS_SM_PDP --> TrafficMappingInfo["TrafficMappingInfo ?"] + GPRS_SM_MBMS --> TrafficMappingInfo + EPS_SM_EPS --> TrafficMappingInfo + TrafficMappingInfo --> PacketFilterList["PacketFilterList"] + TrafficMappingInfo --> NumberOfPacketFilters["NumberOfPacketFilters"] + + EPS_SM_EPS --> APN["APN ?"] + +``` + +Diagram of the SDoUE Management Object structure. The root node is . It has children: Name ?, CS\_Calls ?, CS\_EmergencyCalls ?, SupplementaryServices ?, CS\_SMS ?, PS\_SMS ?, CS\_LCS ?, PS\_LCS ?, GPRS\_SM\_PDP ?, GPRS\_SM\_MBMS ?, EPS\_SM\_EPS ?, 5GS\_SM\_PDU ?, Text ?, CustomerCareNumbers ?, AlertServerID ?, IMS\_EmergencyCalls ?, and Ext ?. CS\_EmergencyCalls ?, CustomerCareNumbers ?, and IMS\_EmergencyCalls ? are followed by + nodes. CS\_EmergencyCalls ?'s + node leads to Country, which leads to Network ?. CustomerCareNumbers ?'s + node leads to CustomerCareNumber. IMS\_EmergencyCalls ?'s + node leads to Country, which leads to Network ?. GPRS\_SM\_PDP ?, GPRS\_SM\_MBMS ?, and EPS\_SM\_EPS ? are followed by TrafficMappingInfo ? nodes. TrafficMappingInfo ? nodes lead to PacketFilterList and NumberOfPacketFilters. EPS\_SM\_EPS ? also leads to APN ?. + +Figure 1: The SDoUE Management Object + +# 5 Management Object parameters + +## 5.1 General + +This clause describes the parameters for the SDoUE Management Object (MO). + +## 5.2 Node: + +This interior node acts as a placeholder for zero or one accounts for a fixed node. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +## 5.3 //Name + +The Name leaf is a name for the SDoUE MO settings. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get + +- Values: + +## 5.4 //CS\_Calls + +The CS\_Calls leaf indicates an operator's preference to enable or disable mobile-originated Call Control (CC) procedures except for emergency calls. + +The CC procedures are specified in 3GPP TS 24.008 [3]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that mobile-originated CS calls are enabled. + - 1 – Indicates that mobile-originated CS calls are disabled. + +When the CS\_Calls leaf value is set to "1", the UE shall initiate the signalling procedure for release of all calls except for emergency calls (see 3GPP TS 24.008 [3]). Furthermore, the UE shall not use mobile-originated call control procedures except for emergency calls and customer care service number(s) until the CS\_Calls leaf value is set to "0". + +NOTE: Customer care service number(s) is(are) provided by the CustomerCareNumbers leaf (see sub-clauses 5.15, 5.16 and 5.17). + +## 5.5 // CS\_EmergencyCalls + +The CS\_EmergencyCalls interior node indicates an operator's preference to enable or disable emergency call control procedures. + +NOTE 1: Disabling of emergency call control procedures is subject to regional regulatory requirements. Therefore, emergency call control procedures cannot be disabled in regions where support of them is required (see 3GPP TS 22.011 [2]). + +The emergency call control procedures are specified in 3GPP TS 24.008 [3]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that CS emergency calls are enabled. + - 1 – Indicates that CS emergency calls are disabled. + +When the CS\_EmergencyCalls node value is set to "1" and the UE detects being under coverage of a PLMN (identified by Mobile Country Code (MCC) and Mobile Network Code (MNC)) as indicated by any of the stored Country and Network pairs of nodes (see sub-clauses 5.5A, 5.5B and 5.5C), then the UE shall initiate the signalling procedure for release of all emergency calls that use call control procedures. Furthermore, the UE shall not use call control procedures to establish emergency calls until the CS\_EmergencyCalls node value is set to "0" or the UE detects a change of Mobile Country Code (MCC) and Mobile Network Code (MNC) that does not match any of the stored Country and Network pairs of nodes. + +NOTE 2: As described by the definition and structure of the SDoUE MO the Country and Network nodes, if exist, constitute a pair of nodes. However, it is possible to indicate only a country/region by means of only setting the value of the Country node. + +### 5.5A //CS\_EmergencyCalls/ + +This run-time node acts as a placeholder for one or more Country nodes. Furthermore, this node provides a means for the operator to indicate where emergency call control procedures are disabled (i.e. The CS\_EmergencyCalls value is set to "1"). + +- Occurrence: ZeroOrMore +- Format: node +- Access Types: Get +- Values: N/A + +### 5.5B //CS\_EmergencyCalls//Country + +The Country interior node represents one Mobile Country Code (MCC). This node provides a means for including information that can be used to indicate in which MCC the emergency call control procedures are disabled (i.e. The CS\_EmergencyCalls value is set to "1"). + +The Country node value shall be a Mobile Country Code (MCC) as specified by ITU-T E.212 [10]. + +- Occurrence: One +- Format: chr +- Access Types: Get +- Values: + +The UE shall only use the information stored in the Country node when emergency call control procedures are disabled (i.e. The CS\_EmergencyCalls value is set to "1"). + +### 5.5C //CS\_EmergencyCalls//Country/Network + +The Network leaf represents one Mobile Network Code (MNC). This leaf provides a means, together with the Country leaf, for including information that can be used to indicate in which MCC and MNC the emergency calls procedures are disabled. + +The Network leaf value shall be a Mobile Network Code (MNC) as specified by ITU-T E.212 [10]. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get +- Values: + +The UE shall only use the information stored in the Network leaf when emergency call control procedures are disabled (i.e. The CS\_EmergencyCalls value is set to "1"). Furthermore, the UE shall interpret the information stored in the Network leaf, if exists, in conjunction with the corresponding Country node. + +## 5.6 //SupplementaryServices + +The SupplementaryServices leaf indicates an operator's preference to enable or disable mobile-originated Supplementary services operations. + +The Supplementary service operations are specified in 3GPP TS 24.010 [4]. + +NOTE: The functionality indicated by the SupplementaryServices leaf does not include the Location Service (LCS) supplementary service operations. + +- Occurrence: ZeroOrOne + +- Format: bool +- Access Types: Get +- Values: 0, 1 + +0 – Indicates that mobile-originated Supplementary service operations are enabled. + +1 – Indicates that mobile-originated Supplementary service operations are disabled. + +When the SupplementaryServices leaf value is set to "1", the UE shall initiate the signalling procedure for release of all ongoing supplementary service operations (transactions). Furthermore, the UE shall not invoke mobile-originated supplementary service operation procedures until the SupplementaryServices leaf value is set to "0". + +## 5.7 //CS\_SMS + +The CS\_SMS leaf indicates an operator's preference to enable or disable mobile-originated Short Message Service (SMS) via CS. + +The SMS procedures are specified in 3GPP TS 24.011 [5]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + +0 – Indicates that mobile-originated SMS via CS are enabled. + +1 – Indicates that mobile-originated SMS via CS are disabled. + +If the CS\_SMS leaf value is "1", the UE shall not use the CS domain for mobile-originated SMS transfer until the CS\_SMS leaf value is set to "0". The UE may use the PS domain instead of the CS domain for mobile-originated SMS transfer when the CS\_SMS leaf value is "1". + +## 5.8 //PS\_SMS + +The PS\_SMS leaf indicates an operator's preference to enable or disable mobile-originated Short Message Service (SMS) via PS. + +The SMS procedures are specified in 3GPP TS 24.011 [5]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + +0 – Indicates that mobile-originated SMS via PS are enabled. + +1 – Indicates that mobile-originated SMS via PS are disabled. + +If the PS\_SMS leaf value is "1", the UE shall not use the PS domain for mobile-originated SMS transfer until the PS\_SMS leaf value is set to "0". The UE may use the CS domain instead of the PS domain for mobile-originated SMS transfer when the PS\_SMS leaf value is "1". + +## 5.9 //CS\_LCS + +The CS\_LCS leaf indicates an operator's preference to enable or disable mobile-originated Location Service (LCS) operations via CS. + +The LCS Supplementary service operations are specified in 3GPP TS 24.030 [6]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that mobile-originated LCS via CS enabled. + - 1 – Indicates that mobile-originated LCS via CS disabled. + +If the CS\_LCS leaf value is "1", the UE shall not use the CS domain for mobile-originated LCS service operations until the CS\_LCS leaf value is set to "0". The UE may use the PS domain instead of the CS domain for mobile-originated LCS service operations when the CS\_LCS leaf value is "1". + +## 5.10 //PS\_LCS + +The PS\_LCS leaf indicates an operator's preference to enable or disable mobile-originated Location Service (LCS) operations via PS. + +The LCS Supplementary service operations are specified in 3GPP TS 24.030 [6]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that mobile-originated LCS via PS are enabled. + - 1 – Indicates that mobile-originated LCS via PS are disabled. + +If the PS\_LCS leaf value is "1", the UE shall not use the PS domain for mobile-originated LCS service operations until the PS\_LCS leaf value is set to "0". The UE may use the CS domain instead of the PS domain for mobile-originated LCS service operations when the PS\_LCS leaf value is "1". + +## 5.11 //GPRS\_SM\_PDP + +The GPRS\_SM\_PDP leaf indicates an operator's preference to enable or disable mobile-originated GPRS Session Management (SM) procedures for PDP contexts, e.g. PDP context activation, deactivation and modification. + +The GPRS SM procedures for PDP contexts are specified in 3GPP TS 24.008 [3]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that mobile-originated GPRS SM procedures for PDP contexts are enabled. + - 1 – Indicates that mobile-originated GPRS SM procedures for PDP contexts are disabled. + +When the GPRS\_SM\_PDP leaf value is set to "1", the UE shall initiate the signalling procedure for PDP context deactivation of all PDP contexts (see 3GPP TS 24.008 [3]). Additionally, the UE shall not use mobile-originated GPRS SM procedures for PDP contexts until the GPRS\_SM\_PDP leaf value is set to "0". The UE is however allowed to use mobile-originated GPRS SM procedure for PDP context activation in the following cases: + +- upon receipt of an OMA DM notification message indicating that the UE shall initiate an OMA DM session to the OMA DM server that either had set the disable value of the GPRS\_SM\_PDP leaf or is the one stored in the AlertServerID leaf; + +- when the mobile-originated PDP context activation procedure is necessary in order to either establish an emergency call over IMS (if the IMS\_EmergencyCalls value is set to "0") or send an OMA DM generic alert message according to the sub-clause 5.17A. + +## 5.12 //GPRS\_SM\_MBMS + +The GPRS\_SM\_MBMS leaf indicates an operator's preference to enable or disable GPRS Session Management (SM) procedures for MBMS contexts, i.e. MBMS context activation and deactivation. + +The GPRS SM procedures for MBMS contexts are specified in 3GPP TS 24.008 [3]. + +- Occurrence: ZeroOrOne + - Format: bool + - Access Types: Get + - Values: 0, 1 +- 0 – Indicates that GPRS SM procedures for MBMS contexts are enabled. +- 1 – Indicates that GPRS SM procedures for MBMS contexts are disabled. + +When the GPRS\_SM\_MBMS leaf value is set to "1", the UE shall locally release all resources allocated for MBMS contexts and it shall erase the MBMS context data. Furthermore, the UE shall not use GPRS SM procedures for MBMS contexts until the GPRS\_SM\_MBMS leaf value is set to "0". + +### 5.12A//EPS\_SM\_EPS + +The EPS\_SM\_EPS interior node indicates an operator's preference to enable or disable mobile-requested EPS Session Management (SM) procedures for EPS contexts, e.g. UE requested PDN connectivity, UE requested bearer resource modification, UE requested PDN disconnect, as well as provide restriction to EPS services. + +The EPS SM procedures for EPS contexts are specified in 3GPP TS 24.301 [7A]. + +- Occurrence: ZeroOrOne + - Format: bool + - Access Types: Get + - Values: 0, 1 +- 0 – Indicates that mobile-requested EPS SM procedures for EPS contexts are enabled and no restriction to EPS services applies. +- 1 – Indicates that mobile-requested EPS SM procedures for EPS contexts are disabled and restriction to EPS services applies. + +When the EPS\_SM\_EPS leaf value is set to "1", the UE shall proceed as follows: + +The UE shall initiate a UE requested PDN connectivity procedure (see 3GPP TS 24.301 [7A]). If the APN leaf exists, the UE shall use the value stored in the APN leaf as the APN in the PDN CONNECTIVITY REQUEST message. Otherwise, the UE shall not include any APN in the PDN CONNECTIVITY REQUEST message. + +After successful completion of the UE requested PDN connectivity procedure, if the TrafficMappingInfo interior node exists, the UE shall locally use the information provided by the TrafficMappingInfo (i.e. packet filters) in order to determine the traffic mapping to the EPS context established by the UE requested PDN connectivity procedure. Furthermore, this information shall be used by the UE until the EPS\_SM\_EPS leaf value is set to "0". The UE is however allowed to temporarily stop to use the traffic mapping information in the following cases: + +- upon receipt of an OMA DM notification message indicating that the UE shall initiate an OMA DM session to the OMA DM server that either had set the disable value of the EPS\_SM\_EPS leaf or is the one stored in the AlertServerID leaf; + +- when the UE wishes to either establish an emergency call over IMS (if the IMS\_EmergencyCalls value is set to "0") or send an OMA DM generic alert message according to the sub-clause 5.17A. + +Later, the UE shall initiate the signalling procedure for UE requested PDN disconnection (see 3GPP TS 24.301 [7A]) of all PDNs but the one which was established by the successful completion of the UE requested PDN connectivity procedure. + +Finally, the UE shall not use mobile-requested EPS SM procedures for EPS contexts until the EPS\_SM\_EPS leaf value is set to "0". + +## 5.12B//APN + +The APN leaf provides the information of an access point name. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get +- Values: + +The format of the APN is defined by 3GPP TS 23.003 [2A] in clause 9. + +EXAMPLE: mycompany.mnc012.mcc340.gprs + +## 5.12C //TrafficMappingInfo + +The TrafficMappingInfo interior node is used to allow configuring the minimum acceptable traffic flow template parameters (packet filters) for EPS context according operator's preference. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +NOTE: The information provided by means of the TrafficMappingInfo interior node is only used by the UE when the EPS\_SM\_EPS leaf value is set to "1". + +## 5.12D //NumberOfPacketFilters + +The APN leaf indicates the number of traffic filters contained in the PacketFilterList leaf. + +- Occurrence: One +- Format: int +- Access Types: Get +- Values: + +The NumberOfPacketFilters is an unsigned 8 bit integer and the value range is defined as the number of packet filters parameter in the traffic flow template information element (see subclause 10.5.6.12 in 3GPP TS 24.008 [3]). + +EXAMPLE: 3 (packet filters) + +### 5.12E//PacketFilterList + +The PacketFilterList leaf provides the information of a variable number of traffic filters. + +- Occurrence: One +- Format: int + +- Access Types: Get +- Values: + +The PacketFilterList is an unsigned 64 bit integer. The bit pattern shall be encoded as the packet filter list parameter in the traffic flow template information element (see subclause 10.5.6.12 in 3GPP TS 24.008 [3]) with the least significant bit in the rightmost position of the integer. Example: If the parameter is encoded into bit 6, 7 & 8 in 3GPP TS 24.008 [3], then it must be encoded into bit 1, 2 & 3 in this leaf. + +### 5.12F//5GS\_SM\_PDU + +The 5GS\_SM\_PDU interior node indicates an operator's preference to enable or disable mobile-requested 5GS Session Management (5GSM) procedures for PDU sessions, e.g. UE-requested PDU session establishment procedure, UE-requested PDU session modification procedure, UE-requested PDU session release procedure. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that mobile-originated 5GSM procedures for PDU sessions are enabled. + - 1 – Indicates that mobile-originated 5GSM procedures for PDU sessions are disabled. + +When the 5GS\_SM\_PDU leaf value is set to "1", the UE shall initiate the signalling procedure for UE-requested PDU session release procedure (see 3GPP TS 24.501 [7B]). Additionally, the UE shall not use UE-requested 5GSM procedures for PDU sessions until the 5GS\_SM\_PDU leaf value is set to "0". The UE is however allowed to use UE-requested 5GSM procedure for PDU session establishment in the following cases: + +- upon receipt of an OMA DM notification message indicating that the UE shall initiate an OMA DM session to the OMA DM server that either had set the disable value of the 5GS\_SM\_PDU leaf or is the one stored in the AlertServerID leaf; and +- when the UE-requested PDU session establishment procedure is necessary in order to either establish an emergency call over IMS (if the IMS\_EmergencyCalls value is set to "0") or send an OMA DM generic alert message according to the subclause 5.17A. + +## 5.13 //IMS + +The IMS leaf indicates an operator's preference to enable or disable IMS procedures for sending IMS registration request over an IP-CAN bearer established or to be established by GPRS, EPS, 5GS, via the cdma2000® HRPD to access EPC, via WLAN to access EPC or fixed broadband (see 3GPP TS 24.229 [7]). Enabling and disabling of IMS procedures for sending IMS registration request in other access technologies is out of scope of this document. + +The IMS procedures for sending IMS registration request are specified in 3GPP TS 24.229 [7]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that IMS procedures for sending IMS registration request are enabled. + - 1 – Indicates that IMS procedures for sending IMS registration request are disabled. + +If the IMS leaf value is set to "1", the following applies for an IP-CAN bearer of GPRS, EPS, 5GS, cdma2000® HRPD to access EPC, WLAN to access EPC or fixed broadband: + +- 1) if the UE has already registered a contact address with the IM CN subsystem, containing the IP address of the bearer, then the UE shall initiate the user-initiated deregistration procedure for the contact address; + +- 2) the UE shall not send IMS registration requests for a contact address containing the IP address of the bearer; and +- 3) the UE shall not attempt to establish the bearer to be used only for IMS with exception if: + - a) emergency call procedures over IMS are enabled (see subclause 5.18) and the bearer is to be used for IMS emergency registration or IMS emergency session establishment; or + - b) required to be established due to the EPS\_SM\_EPS leaf set to "1" (see subclause 5.12A). + +## 5.14 //Text + +The Text leaf provides a means for including information that will be displayed by the ME. The information contained in the text leaf should be in the ME selected language, via the OMA DM standard procedure. The information should contain information in order to assist in determining the cause of non-availability of specific services and what to do for example, a text string indicating the disabled service(s) and customer service number(s). An example of possible information to be displayed: "The GPRS service of the handset is currently disabled. For further information, please contact TelServices Help Centre by calling 111 from your handset or +44 7777 111 111 whilst abroad. Alternatively, you may wish to get in touch with us by email at help@telservices.net". + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get +- Values: + +When the OMA DM server updates the value of this leaf, the OMA DM server must be configured to ensure that the information provided in the CustomerCareNumbers, described in the sub-clauses 5.15, 5.16 and 5.17, is updated accordingly, i.e. the same customer care service number(s) is(are) provided by the CustomerCareNumbers. + +The ME should use and display all the information provided by the Text leaf to inform the end-user about the non-availability of services and/or customer care service number(s). The possible interactions with the end-user are implementation specific. + +## 5.15 //CustomerCareNumbers/ + +The CustomerCareNumbers interior node is used to allow a reference to a list of customer care service numbers. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +When the OMA DM server updates the values of the CustomerCareNumbers sub-nodes, the OMA DM server must be configured to ensure that the information provided in the Text leaf, described in the sub-clause 5.14, is updated accordingly, i.e. the same customer care service number(s) is(are) provided by the Text leaf. + +## 5.16 //CustomerCareNumbers/ + +This run-time node acts as a placeholder for one or more customer care service numbers. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get +- Values: N/A + +## 5.17 //CustomerCareNumbers//CustomerCareNumber + +The CustomerCareNumber leaf represents one customer care service number. This leaf provides a means for including information about customer care service number which can be used, by the end-user, in determining the cause of non-availability of specific services. + +The CustomerCareNumber leaf value shall be either a telephone number according to the E.164 scheme (see ITU-T Rec. E.164 [9]) or nationally-specific operator number, e.g. 191, 150. + +- Occurrence: One +- Format: chr +- Access Types: Get +- Values: + +## 5.17A//AlertServerID + +The AlertServerID leaf indicates the server identifier for an OMA DM server. This leaf provides a means for informing about the fact that the SDoUE MO has been modified. + +The AlertServerID leaf value is used by the UE to send an OMA DM generic alert message (see Enabler Release Definition OMA-ERELDM-DM-V1\_2 [8]) any time the SDoUE MO is modified by an OMA DM server different than the one indicated by the AlertServerID leaf value. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get +- Values: + +The UE shall send an OMA DM generic alert message immediately after the SDoUE MO has been modified by an OMA DM server different than the one identified by the AlertServerID leaf value. The Type element of the OMA DM generic alert message shall be set to "Reserved-Domain-Name: org.3gpp.SDoUE.changesperformedalert". + +## 5.18 // IMS\_EmergencyCalls + +The IMS\_EmergencyCalls interior node indicates an operator's preference to enable or disable emergency call procedures over IMS. + +NOTE 1: Disabling of emergency call control procedures over IMS is subject to regional regulatory requirements. Therefore, emergency call control procedures over IMS cannot be disabled in regions where support of them is required (see 3GPP TS 22.011 [2]). + +The emergency call procedures over IMS are specified in 3GPP TS 24.229 [7]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get +- Values: 0, 1 + - 0 – Indicates that emergency calls over IMS are enabled. + - 1 – Indicates that emergency calls over IMS are disabled. + +When the IMS\_EmergencyCalls node value is set to "1" and the UE detects being under coverage of a PLMN (identified by Mobile Country Code (MCC) and Mobile Network Code (MNC)) as indicated by any of the stored Country and Network pairs of nodes (see sub-clauses 5.19, 5.20 and 5.21), then the UE shall initiate the signalling procedure for release of all emergency calls over IMS. Furthermore, the UE shall not use IMS procedures to establish + +emergency calls until the IMS\_EmergencyCalls node value is set to "0" or the UE detects a change of Mobile Country Code (MCC) and Mobile Network Code (MNC) that does not match any of the stored Country and Network pairs of nodes. + +NOTE 2: As described by the definition and structure of the SDoUE MO the Country and Network nodes, if exist, constitute a pair of nodes. However, it is possible to indicate only a country/region by means of only setting the value of the Country node. + +## 5.19 //IMS\_EmergencyCalls/ + +This run-time node acts as a placeholder for one or more Country nodes. Furthermore, this node provides a means for the operator to indicate where emergency call procedures over IMS are disabled (i.e. The IMS\_EmergencyCalls value is set to "1"). + +- Occurrence: ZeroOrMore +- Format: node +- Access Types: Get +- Values: N/A + +## 5.20 //IMS\_EmergencyCalls//Country + +The Country interior node represents one Mobile Country Code (MCC). This node provides a means for including information that can be used to indicate in which MCC the emergency call procedures over IMS are disabled (i.e. The IMS\_EmergencyCalls value is set to "1"). + +The Country node value shall be a Mobile Country Code (MCC) as specified by ITU-T E.212 [10]. + +- Occurrence: One +- Format: chr +- Access Types: Get +- Values: + +The UE shall only use the information stored in the Country node when emergency call control procedures are disabled (i.e. The IMS\_EmergencyCalls value is set to "1"). + +## 5.21 //IMS\_EmergencyCalls//Country/Network + +The Network leaf represents one Mobile Network Code (MNC). This leaf provides a means, together with the Country leaf, for including information that can be used to indicate in which MCC and MNC the emergency call procedures over IMS are disabled. + +The Network leaf value shall be a Mobile Network Code (MNC) as specified by ITU-T E.212 [10]. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get +- Values: + +The UE shall only use the information stored in the Network leaf when emergency call procedures over IMS are disabled (i.e. The IMS\_EmergencyCalls value is set to "1"). Furthermore, the UE shall interpret the information stored in the Network leaf, if exists, in conjunction with the corresponding Country node. + +## 5.22 //Ext + +The Ext is an interior node for where the vendor specific information about the SDoUE MO is being placed (vendor meaning application vendor, device vendor etc.). Usually the vendor extension is identified by vendor specific name + +under the ext node. The tree structure under the vendor identified is not defined and can therefore include one or more un-standardized sub-trees. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +# --- Annex A (informative): Management Object DDF + +This DDF is the standardized minimal set. A vendor can define it's own DDF for the complete device. This DDF can include more features than this minimal standardized version. + +``` + + + + + 1.2 + --The device manufacturer-- + --The device model-- + + + x + + + + + SDOE settings + + + + + + + The SDOE Management Object. + + urn:oma:mo:ext-3gpp-sdoe:1.0 + + + + + + Name + + + + + + + + + + + User displayable name for the node. + + text/plain + + + + + + CS_Calls + + + + + + + + + + +``` + +``` + + + + +Indication of whether mobile-originated CS calls are enabled. + + text/plain + + + + + CS_EmergencyCalls + + + + + + + + + + + Indication of whether CS emergency call procedures are enabled. + + text/plain + + + + + + + + + + + + + + + + + + + + Country + + + + + + + + + + + A country or region identified by an Mobile Country Code (MCC). + + text/plain + + + +``` + +``` +Network + + + + + + + + + + + A network code identified by an Mobile Network Code (MNC). + + text/plain + + + + + + + + SupplementaryServices + + + + + + + + + + + Indication of whether mobile-originated Supplementary service operations are +enabled. + + text/plain + + + + + CS_SMS + + + + + + + + + + + Indication of whether mobile-originated SMS via CS is enable. + + text/plain + + + + + PS_SMS + +``` + +``` + + + + + + + + + +Indication of whether mobile-originated SMS via PS is enable. + + text/plain + + + + + + CS_LCS + + + + + + + + + + + Indication of whether mobile-originated LCS via CS is enable. + + text/plain + + + + + + PS_LCS + + + + + + + + + + + Indication of whether mobile-originated LCS via PS is enable. + + text/plain + + + + + + GPRS_SM_PDP + + + + + + + +``` + +``` + + + +Indication of whether mobile-originated GPRS SM procedures for PDP contexts are +enabled. + + text/plain + + + + + + GPRS_SM_MBMS + + + + + + + + + + + Indication of whether mobile-originated GPRS SM procedures for MBMS contexts are +enabled. + + text/plain + + + + + + EPS_SM_EPS + + + + + + + + + + + Indication of whether mobile-originated EPS SM procedures for EPS contexts are enabled and +restriction to EPS services applies. + + text/plain + + + + APN + + + + + + + + + + + An access point name. +``` + +``` + + + text/plain + + + + + TrafficMappingInfo + + + + + + + + + + + Traffic mapping information. + + text/plain + + + + NumberOfPacketFilters. + + + + + + + + + + + Number of packet filters. + + text/plain + + + + + PacketFilterList + + + + + + + + + + + Packet filter list. + + text/plain + + + + + + + + +``` + +``` +5GS_SM_PDU + + + + + + + + + + + Indication of whether UE-requested 5GSM procedures for PDU sessions are +enabled. + + text/plain + + + + + + IMS + + + + + + + + + + + Indication of whether IMS procedures for sending IMS registration request are +enabled. + + text/plain + + + + + + Text + + + + + + + + + + + Information to be displayed by the handset. + + text/plain + + + + + + CustomerCareNumbers + + + + + + +``` + +``` + + + + + + + +The customer care service numbers. + + text/plain + + + + + + + + + + + + + + + + + + + + CustomerServiceNumber + + + + + + + + + + + A customer care service number. + + text/plain + + + + + + + AlertServerID + + + + + + + + + + + An OMA DM server identifier for alerting. +``` + +``` + + text/plain + + + + + + IMS_EmergencyCalls + + + + + + + + + + + Indication of whether emergency call procedures over IMS are enabled. + + text/plain + + + + + + + + + + + + + + + + + + + + Country + + + + + + + + + + + A country or region identified by an Mobile Country Code (MCC). + + text/plain + + + + Network + + + + + + +``` + +``` + + + + + + +A network code identified by an Mobile Network Code (MNC). + + text/plain + + + + + + + + Ext + + + + + + + + + + + + A collection of all Extension objects. + + + + + + + +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2006-03 | | | | | Rapporteur input framework document agreed at CT1#41. | 0.0.0 | 0.1.0 | +| 2006-05 | | | | | Implementation of CRs agreed at CT1#42: C1-061070 | 0.1.0 | 0.2.0 | +| 2006-09 | | | | | Implementation of CRs agreed at CT1#43: C1-061593, C1-061594, C1-061595, C1-061699
Version 1.0.0 created for presentation for information to plenary (TSG CT #33). | 0.2.0 | 1.0.0 | +| 2006-11 | | | | | Implementation of CRs agreed at CT1#44: C1-062133, C1-062410, C1-062411, C1-062412, C1-062413, C1-062504, C1-062505, C1-062506
Editorial changes done.
Version 2.0.0 created for presentation for approval to plenary (TSG CT #34). | 1.0.0 | 2.0.0 | +| 2006-12 | | | | | Version 2.0.0 approved in CT#34 as CP-060652; Version 7.0.0 created by MCC | 2.0.0 | 7.0.0 | +| 2007-03 | CT-35 | CP-070150 | 0001 | 1 | Cleanups and corrections | 7.0.0 | 7.1.0 | +| 2007-03 | CT-35 | CP-070150 | 0002 | 1 | Behaviour of the UE when SupplementaryServices disable | 7.0.0 | 7.1.0 | +| 2007-03 | CT-35 | CP-070150 | 0003 | | Management Object (MO) identifier for SDoUE | 7.0.0 | 7.1.0 | +| 2007-03 | CT-35 | CP-070150 | 0004 | | Access to the SDoUE MO when in VPLMN | 7.0.0 | 7.1.0 | +| 2007-03 | CT-35 | CP-070150 | 0005 | 1 | Behaviour of the UE when EmergencyCalls disable | 7.0.0 | 7.1.0 | +| 2007-06 | CT-36 | CP-070379 | 0006 | 1 | Disabling of emergency calls procedures over IMS | 7.1.0 | 7.2.0 | +| 2008-03 | CT-39 | CP-080124 | 0007 | | Removal of editors note | 7.2.0 | 7.3.0 | +| 2008-03 | CT-39 | CP-080124 | 0008 | | Correction to the GPRS_SM_PDP leaf | 7.2.0 | 7.3.0 | +| 2008-12 | CT-42 | | | | Upgrade to Rel-8 | 7.3.0 | 8.0.0 | +| 2009-03 | CT-43 | CP-090120 | 0009 | | MO DDF XML bug fix | 8.0.0 | 8.1.0 | +| 2009-03 | CT-43 | CP-090131 | 0010 | | Update of SDoUE for EPS | 8.0.0 | 8.1.0 | +| 2009-06 | CT-44 | CP-090424 | 0012 | | XML error | 8.1.0 | 8.2.0 | +| 2009-12 | CT-46 | | | | Upgrade to Rel-9 | 8.2.0 | 9.0.0 | +| 2011-03 | CT-51 | | | | IMS parameter preventing establishment of IP-CAN bearer used only for IMS | 9.0.0 | 10.0.0 | +| 2011-12 | CT-54 | CP-110882 | 0015 | | Clarification to GPRS SM and EPS SM procedures | 10.0.0 | 11.0.0 | +| 2011-12 | CT-54 | | | | Correction to allow 3GPP network operators to stop useless signalling over IP-CAN used by 3GPP | 10.0.0 | 11.0.0 | +| 2014-09 | CT-65 | | | | Upgrade to Rel-12 | 11.0.0 | 12.0.0 | +| 2015-06 | CT-68 | CP-150310 | 0022 | 2 | IMS leaf and IP CAN bearer established by I-WLAN | 12.0.0 | 12.1.0 | +| 2015-09 | CT-69 | | | | IMS leaf and IP CAN bearer when using the EPC via WLAN to access IMS | 12.1.0 | 12.2.0 | +| 2015-12 | CT-70 | | | | Upgrade to Rel-13 | 12.2.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | CT-75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | CT-80 | CP-181058 | 0025 | 1 | B | Update of SDoUE for 5GS | 15.0.0 | +| 2018-09 | CT-81 | CP-182128 | 0026 | 1 | C | Update to the IMS leaf due to 5GS | 15.1.0 | +| 2018-12 | CT-82 | CP-183077 | 0027 | 1 | F | Addition of the object identifier in the DDF of the 3GPP Management Object | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24333/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/24_series/24333/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..971ba6808f3b8d5ef217305fcac59a1e3f420e04 --- /dev/null +++ b/marked/Rel-16/24_series/24333/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79e8e7079c4aa86b605f0bcf2887b5bbb909628ca4a599a9c1046396290124d2 +size 45996 diff --git a/marked/Rel-16/24_series/24333/5132b3a97ac70fe4765c1e07e66b72b3_img.jpg b/marked/Rel-16/24_series/24333/5132b3a97ac70fe4765c1e07e66b72b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c153cbb32cc42b36c92b367515b9e4d2e63546d --- /dev/null +++ b/marked/Rel-16/24_series/24333/5132b3a97ac70fe4765c1e07e66b72b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b4ed87a5a1f249d8548416587e70a80343d2a1ab97170ee8df3057a18d684ead +size 34951 diff --git a/marked/Rel-16/24_series/24333/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/24_series/24333/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..35f1487ad657fc30142158b268a457c0c6111c2f --- /dev/null +++ b/marked/Rel-16/24_series/24333/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:836e18ac2a1a089cbcd2eeba49736d336f060bccfad481962c583e869717db33 +size 92369 diff --git a/marked/Rel-16/24_series/24333/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg b/marked/Rel-16/24_series/24333/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8394e3d037f916a1bc7a456e2f495298453a71f4 --- /dev/null +++ b/marked/Rel-16/24_series/24333/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b636bf648a44b31731a080af5007691a2b38342a7774ed4dab73d36560727da7 +size 10526 diff --git a/marked/Rel-16/24_series/24333/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg b/marked/Rel-16/24_series/24333/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a52e362c4ee4371cc4e68fd21ff1ab3b9092ef3 --- /dev/null +++ b/marked/Rel-16/24_series/24333/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f487530d10e53b892fb29410c44d804fe6f8564f15d9275641c2d31c7533e70a +size 58441 diff --git a/marked/Rel-16/24_series/24333/86b4670fc1a5a694821ee92b99c1209a_img.jpg b/marked/Rel-16/24_series/24333/86b4670fc1a5a694821ee92b99c1209a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9d3be286df68b56075cd9410c485db87e08782a1 --- /dev/null +++ b/marked/Rel-16/24_series/24333/86b4670fc1a5a694821ee92b99c1209a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b075bd275d3d6dcf276a72ffd8516a26184f658eae9b8aad77b463097b86c89 +size 41079 diff --git a/marked/Rel-16/24_series/24333/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg b/marked/Rel-16/24_series/24333/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5eadf1db0c13cec762373eb7734d94911e6bd7eb --- /dev/null +++ b/marked/Rel-16/24_series/24333/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31a0334679cb3dd90d8a63d93c7ca589ef971231d4005cb1d5ad64d6ae1514d2 +size 22923 diff --git a/marked/Rel-16/24_series/24333/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/marked/Rel-16/24_series/24333/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be32652461f2b006b6b641690381138cfa514d0e --- /dev/null +++ b/marked/Rel-16/24_series/24333/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a32622836cd3decb833d1a804627fb9a575e5391e21ee404392555a25c8aab8e +size 61061 diff --git a/marked/Rel-16/24_series/24333/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/24_series/24333/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4055cfadb21cc9ac83a0e337fc758f70b58a4a6a --- /dev/null +++ b/marked/Rel-16/24_series/24333/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3bde2bfe0c0336343205512d3e0132fcee7914132f77f339a1a2ef7cffc4e71f +size 33147 diff --git a/marked/Rel-16/24_series/24333/b996d5a6408db9c4b3ac3aafd2ef44cf_img.jpg b/marked/Rel-16/24_series/24333/b996d5a6408db9c4b3ac3aafd2ef44cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8017933064675639fe4edb5e7b79b523523ff092 --- /dev/null +++ b/marked/Rel-16/24_series/24333/b996d5a6408db9c4b3ac3aafd2ef44cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcbfede815867353379ed6c149225a8cfbd102c18843e689681e4bf38278d129 +size 9522 diff --git a/marked/Rel-16/24_series/24333/d9c0a780cd22626253dab4aa41699e2f_img.jpg b/marked/Rel-16/24_series/24333/d9c0a780cd22626253dab4aa41699e2f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59556d5990b9f341fd6f10b9e11926d1d1590ea4 --- /dev/null +++ b/marked/Rel-16/24_series/24333/d9c0a780cd22626253dab4aa41699e2f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b9a7dfc3b4495756dc4322d3bdf447cd64dcaed2fb0743e5be21fa76ce8c7fc +size 37664 diff --git a/marked/Rel-16/24_series/24333/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/24_series/24333/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07e932d450760db8ea1bd594a5434481e12d5164 --- /dev/null +++ b/marked/Rel-16/24_series/24333/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5a2724359e2d63efd446bbeb53b14fa1349a489ab9815ec498abbaa4a1c794a +size 124447 diff --git a/marked/Rel-16/24_series/24333/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/24_series/24333/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..070ca4fb5e359a6917be845f40153c18970aad08 --- /dev/null +++ b/marked/Rel-16/24_series/24333/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9da66b2aff74589657861244dfd1f246ae1ecc150aa0d875f7ef9e3d7ed4ebef +size 18443 diff --git a/marked/Rel-16/24_series/24333/raw.md b/marked/Rel-16/24_series/24333/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4530e41248ad2fb7ca18614e60a552d3a5a090ea --- /dev/null +++ b/marked/Rel-16/24_series/24333/raw.md @@ -0,0 +1,7338 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions, symbols and abbreviations..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 10 | +| 4 ProSe Direct Services Provisioning MO..... | 10 | +| 4.1 Overview ..... | 10 | +| 4.2 ProSe Direct Services Provisioning MO parameters ..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 Node: ..... | 11 | +| 4.2.3 /MonitoringPolicy..... | 12 | +| 4.2.4 /MonitoringPolicy/..... | 12 | +| 4.2.5 /MonitoringPolicy//PLMN..... | 12 | +| 4.2.6 /MonitoringPolicy//ValidityTimerT4005 ..... | 12 | +| 4.2.7 /AnnouncingPolicy ..... | 12 | +| 4.2.8 /AnnouncingPolicy/ ..... | 13 | +| 4.2.9 /AnnouncingPolicy//PLMN..... | 13 | +| 4.2.10 /AnnouncingPolicy//ValidityTimerT4005..... | 13 | +| 4.2.11 /AnnouncingPolicy//Range..... | 13 | +| 4.2.12 /ToConRef ..... | 14 | +| 4.2.13 /ToConRef/..... | 14 | +| 4.2.14 /ToConRef//ConRef..... | 14 | +| 4.2.15 /RestrictedModelAMonitoringPolicy ..... | 14 | +| 4.2.16 /RestrictedModelAMonitoringPolicy/ ..... | 15 | +| 4.2.17 /RestrictedModelAMonitoringPolicy//PLMN ..... | 15 | +| 4.2.18 /RestrictedModelAMonitoringPolicy//ValidityTimerT4005..... | 15 | +| 4.2.19 /RestrictedModelAAnnouncingPolicy..... | 15 | +| 4.2.20 /RestrictedModelAAnnouncingPolicy/..... | 15 | +| 4.2.21 /RestrictedModelAAnnouncingPolicy//PLMN ..... | 16 | +| 4.2.22 /RestrictedModelAAnnouncingPolicy//ValidityTimerT4005 ..... | 16 | +| 4.2.23 /RestrictedModelAAnnouncingPolicy//Range ..... | 16 | +| 4.2.24 /RestrictedModelBDiscovererPolicy..... | 17 | +| 4.2.25 /RestrictedModelBDiscovererPolicy/ ..... | 17 | +| 4.2.26 /RestrictedModelBDiscovererPolicy//PLMN ..... | 17 | +| 4.2.27 /RestrictedModelBDiscovererPolicy//ValidityTimerT4005..... | 17 | +| 4.2.28 /RestrictedModelBDiscovererPolicy//Range..... | 17 | +| 4.2.29 /RestrictedModelBDiscovereePolicy..... | 18 | +| 4.2.30 /RestrictedModelBDiscovereePolicy/..... | 18 | +| 4.2.31 /RestrictedModelBDiscovereePolicy//PLMN ..... | 18 | +| 4.2.32 /RestrictedModelBDiscovereePolicy//ValidityTimerT4005 ..... | 19 | +| 4.2.33 /RestrictedModelBDiscovereePolicy//Range ..... | 19 | +| 4.2.34 /ProSeDiscoveryUEIDInfo ..... | 19 | +| 4.2.35 /ProSeDiscoveryUEIDInfo/ProSeDiscoveryUEID ..... | 19 | +| 4.2.36 / ProSeDiscoveryUEIDInfo/ValidityTimerT4015..... | 20 | +| 4.2.36A /WLANDirectDiscoveryPLMNList ..... | 20 | +| 4.2.36B /WLANDirectDiscoveryPLMNList/ ..... | 20 | +| 4.2.36C /WLANDirectDiscoveryPLMNList//PLMN ..... | 20 | +| 4.2.37 /Ext..... | 20 | +| 5 ProSe Public Safety Direct Services Provisioning MO ..... | 21 | +| 5.1 Overview ..... | 21 | +| 5.2 ProSe Public Safety Direct Services Provisioning MO parameters ..... | 26 | +| 5.2.1 General ..... | 26 | +| 5.2.2 Node: ..... | 26 | +| 5.2.3 /MonitoringPolicy..... | 26 | +| 5.2.4 /MonitoringPolicy/..... | 26 | + +| | | | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.2.5 | /MonitoringPolicy//PLMN..... | 26 | +| 5.2.6 | /MonitoringPolicy//ValidityTimerT4005 ..... | 27 | +| 5.2.7 | /AnnouncingPolicy ..... | 27 | +| 5.2.8 | /AnnouncingPolicy/ ..... | 27 | +| 5.2.9 | /AnnouncingPolicy//PLMN ..... | 27 | +| 5.2.10 | /AnnouncingPolicy//ValidityTimerT4005 ..... | 27 | +| 5.2.11 | /AnnouncingPolicy//Range ..... | 28 | +| 5.2.12 | Void ..... | 29 | +| 5.2.13 | Void ..... | 29 | +| 5.2.14 | Void ..... | 29 | +| 5.2.15 | Void ..... | 29 | +| 5.2.16 | Void ..... | 29 | +| 5.2.17 | Void ..... | 29 | +| 5.2.18 | Void ..... | 29 | +| 5.2.19 | Void ..... | 29 | +| 5.2.20 | Void ..... | 29 | +| 5.2.21 | Void ..... | 29 | +| 5.2.22 | Void ..... | 29 | +| 5.2.23 | Void ..... | 29 | +| 5.2.24 | Void ..... | 29 | +| 5.2.25 | Void ..... | 29 | +| 5.2.26 | Void ..... | 29 | +| 5.2.27 | Void ..... | 29 | +| 5.2.28 | Void ..... | 29 | +| 5.2.29 | Void ..... | 29 | +| 5.2.30 | Void ..... | 29 | +| 5.2.31 | Void ..... | 29 | +| 5.2.32 | Void ..... | 29 | +| 5.2.33 | Void ..... | 29 | +| 5.2.34 | Void ..... | 29 | +| 5.2.35 | /DirectCommunicationPolicy ..... | 30 | +| 5.2.36 | /DirectCommunicationPolicy/ ..... | 30 | +| 5.2.37 | /DirectCommunicationPolicy//PLMN ..... | 30 | +| 5.2.38 | /DirectCommunicationPolicy//ValidityTimerT4005 ..... | 30 | +| 5.2.39 | /DirectCommunicationPolicyNotInEUTRAN..... | 30 | +| 5.2.40 | /DirectCommunicationPolicyNotInEUTRAN/
DirectCommunicationAuthorisationNotInEUTRAN..... | 31 | +| 5.2.40A | /DirectCommunicationPolicyNotInEUTRAN/
OneToOneDirectCommunicationAuthorisationNotInEUTRAN ..... | 31 | +| 5.2.41 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters ..... | 31 | +| 5.2.42 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters/ ..... | 32 | +| 5.2.43 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
RadioParametersContents..... | 32 | +| 5.2.44 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea ..... | 32 | +| 5.2.45 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea/Polygon ..... | 32 | +| 5.2.46 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea/Polygon/ ..... | 33 | +| 5.2.47 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea/Polygon//Coordinates ..... | 33 | +| 5.2.48 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea/Polygon//Coordinates/ ..... | 33 | +| 5.2.49 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea/Polygon//Coordinates//Latitude..... | 33 | +| 5.2.50 | /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters//
GeographicalArea/Polygon//Coordinates//Longitude ..... | 34 | +| 5.2.51 | /GroupParameters ..... | 34 | +| 5.2.52 | /GroupParameters/ ..... | 34 | +| 5.2.53 | /GroupParameters// AddressType..... | 34 | +| 5.2.54 | /GroupParameters// IPMulticastAddress ..... | 35 | +| 5.2.55 | /GroupParameters//PKMFAddress ..... | 35 | + +| | | | +|---------|-------------------------------------------------------------------------------------------------------------------------------|----| +| 5.2.56 | /GroupParameters//SourceIPv4address ..... | 35 | +| 5.2.57 | /GroupParameters//Layer2GroupID ..... | 35 | +| 5.2.57A | /GroupParameters//ApplicationLayerGroupID ..... | 36 | +| 5.2.58 | /UsageInformationReportingConfiguration..... | 36 | +| 5.2.59 | /UsageInformationReportingConfiguration/ServerAddress ..... | 36 | +| 5.2.60 | /UsageInformationReportingConfiguration/CollectionPeriod ..... | 36 | +| 5.2.61 | /UsageInformationReportingConfiguration/ReportingWindow ..... | 36 | +| 5.2.62 | /UsageInformationReportingConfiguration/ ReportGroupParameters..... | 37 | +| 5.2.63 | /UsageInformationReportingConfiguration/
ReportTimeStampsFirstTransmissionAndReception ..... | 37 | +| 5.2.64 | /UsageInformationReportingConfiguration/ ReportDataTransmitted..... | 37 | +| 5.2.65 | /UsageInformationReportingConfiguration/ReportDataReceived ..... | 38 | +| 5.2.66 | /UsageInformationReportingConfiguration/ ReportTimeStampsOutOfCoverage..... | 38 | +| 5.2.66A | /UsageInformationReportingConfiguration/ ReportLocationInCoverage..... | 39 | +| 5.2.66B | /UsageInformationReportingConfiguration/ ReportRadioParameters ..... | 39 | +| 5.2.67 | /ToConRef ..... | 39 | +| 5.2.68 | /ToConRef/..... | 40 | +| 5.2.69 | /ToConRef//ConRef..... | 40 | +| 5.2.70 | /RestrictedDiscoveryPolicyForNonPS ..... | 40 | +| 5.2.71 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAMonitoringPolicy ..... | 40 | +| 5.2.72 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAMonitoringPolicy/ ..... | 40 | +| 5.2.73 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAMonitoringPolicy//PLMN ..... | 41 | +| 5.2.74 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAMonitoringPolicy/
/ValidityTimerT4005..... | 41 | +| 5.2.75 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAAnnouncingPolicy..... | 41 | +| 5.2.76 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAAnnouncingPolicy/..... | 41 | +| 5.2.77 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAAnnouncingPolicy//PLMN..... | 42 | +| 5.2.78 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAAnnouncingPolicy/
/ValidityTimerT4005..... | 42 | +| 5.2.79 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelAAnnouncingPolicy//Range ..... | 42 | +| 5.2.80 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy ..... | 43 | +| 5.2.81 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy/ ..... | 43 | +| 5.2.82 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy//PLMN ..... | 43 | +| 5.2.83 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy/
/ValidityTimerT4005..... | 43 | +| 5.2.84 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy//Range..... | 44 | +| 5.2.85 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy..... | 44 | +| 5.2.86 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy/..... | 44 | +| 5.2.87 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy//PLMN..... | 44 | +| 5.2.88 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy/
/ValidityTimerT4005..... | 45 | +| 5.2.89 | /RestrictedDiscoveryPolicyForNonPS /RestrictedModelBDiscovererPolicy//Range ..... | 45 | +| 5.2.90 | /RestrictedDiscoveryPolicyForNonPS /ProSeDiscoveryUEIDInfo ..... | 45 | +| 5.2.91 | /RestrictedDiscoveryPolicyForNonPS /ProSeDiscoveryUEIDInfo/ProSeDiscoveryUEID ..... | 46 | +| 5.2.92 | /RestrictedDiscoveryPolicyForNonPS /ProSeDiscoveryUEIDInfo/ValidityTimerT4015..... | 46 | +| 5.2.93 | /PublicSafetyDiscoveryPolicyNotInEUTRAN..... | 46 | +| 5.2.94 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ MonitoringAuthorisationNotInEUTRAN..... | 46 | +| 5.2.95 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ AnnouncingAuthorisationNotInEUTRAN ..... | 47 | +| 5.2.96 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscovererAuthorisationNotInEUTRAN ..... | 47 | +| 5.2.97 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscovererAuthorisationNotInEUTRAN ..... | 47 | +| 5.2.98 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters..... | 48 | +| 5.2.99 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters/ ..... | 48 | +| 5.2.100 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/
DiscoveryRadioParameters//RadioParametersContents..... | 48 | +| 5.2.101 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/
DiscoveryRadioParameters//GeographicalArea ..... | 48 | +| 5.2.102 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/
DiscoveryRadioParameters//GeographicalArea/Polygon..... | 49 | +| 5.2.103 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/
DiscoveryRadioParameters//GeographicalArea/Polygon/ ..... | 49 | +| 5.2.104 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters
//GeographicalArea/Polygon//Coordinates ..... | 49 | + +| | | | +|----------|--------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.2.105 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//GeographicalArea/Polygon//Coordinates/ ..... | 49 | +| 5.2.106 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//GeographicalArea/Polygon//Coordinates//Latitude ..... | 50 | +| 5.2.107 | /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//GeographicalArea/Polygon//Coordinates//Longitude ..... | 50 | +| 5.2.108 | /UETOnetworkRelayPolicy ..... | 50 | +| 5.2.109 | /UETOnetworkRelayPolicy/AuthorisationForRemoteUE ..... | 50 | +| 5.2.110 | Void ..... | 51 | +| 5.2.111 | Void ..... | 51 | +| 5.2.112 | Void ..... | 51 | +| 5.2.113 | /UETOnetworkRelayPolicy/AuthorisationForRelay ..... | 51 | +| 5.2.113A | /UETOnetworkRelayPolicy/AuthorisationForRelay/ AuthorisedPLMNs ..... | 51 | +| 5.2.114 | /UETOnetworkRelayPolicy/AuthorisationForRelay/ AuthorisedPLMNs/ ..... | 51 | +| 5.2.115 | /UETOnetworkRelayPolicy/AuthorisationForRelay/ AuthorisedPLMNs//PLMN ..... | 51 | +| 5.2.115A | /UETOnetworkRelayPolicy/AuthorisationForRelay/ AuthorisedPLMNs//RemoteUEIMEIReport ..... | 52 | +| 5.2.116 | /UETOnetworkRelayPolicy/AuthorisationForRelay/ AuthorisedPLMNs//ValidityTimerT4005 ..... | 52 | +| 5.2.116A | /UETOnetworkRelayPolicy/AuthorisationForRelay/ DLUnicastTrafficMappingRule ..... | 52 | +| 5.2.116B | /UETOnetworkRelayPolicy/AuthorisationForRelay/ DLUnicastTrafficMappingRule/ ..... | 52 | +| 5.2.116C | /UETOnetworkRelayPolicy/AuthorisationForRelay/ DLUnicastTrafficMappingRule//QCI .... | 53 | +| 5.2.116D | /UETOnetworkRelayPolicy/AuthorisationForRelay/ DLUnicastTrafficMappingRule//ProSePerPacketPriority ..... | 53 | +| 5.2.117 | /PublicSafetyDiscoveryParameters ..... | 53 | +| 5.2.118 | /PublicSafetyDiscoveryParameters /GroupMemberDiscoveryParameters ..... | 53 | +| 5.2.119 | /PublicSafetyDiscoveryParameters /GroupMemberDiscoveryParameters/UserInfoID ..... | 54 | +| 5.2.120 | /PublicSafetyDiscoveryParameters /GroupMemberDiscoveryParameters/ ..... | 54 | +| 5.2.121 | /PublicSafetyDiscoveryParameters /GroupMemberDiscoveryParameters//DiscoveryGroupID ..... | 54 | +| 5.2.121A | /PublicSafetyDiscoveryParameters /GroupMemberDiscoveryParameters//ApplicationLayerGroupID ..... | 54 | +| 5.2.121B | /PublicSafetyDiscoveryParameters /GroupMemberDiscoveryParameters//PKMFAAddress ..... | 54 | +| 5.2.122 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters ..... | 55 | +| 5.2.123 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /UserInfoID ..... | 55 | +| 5.2.124 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RemoteUEParameters ..... | 55 | +| 5.2.125 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RemoteUEParameters/ ..... | 55 | +| 5.2.126 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RemoteUEParameters//RelayServiceCode ..... | 56 | +| 5.2.127 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RemoteUEParameters//UserInfoIDOfRelay ..... | 56 | +| 5.2.128 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RemoteUEParameters//IPVversions ..... | 56 | +| 5.2.129 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RemoteUEParameters//PKMFAAddress ..... | 56 | +| 5.2.130 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters ..... | 57 | +| 5.2.131 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters/ ..... | 57 | +| 5.2.132 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters//RelayServiceCode ..... | 57 | +| 5.2.133 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters//PDNTtype ..... | 57 | +| 5.2.134 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters//APN ..... | 57 | +| 5.2.135 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters//ProSeRelayUEID ..... | 58 | +| 5.2.136 | /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters /RelayParameters//PKMFAAddress ..... | 58 | +| 5.2.137 | /OneToOneDirectCommunicationPolicy ..... | 58 | +| 5.2.138 | /OneToOneDirectCommunicationPolicy / ..... | 58 | +| 5.2.139 | /OneToOneDirectCommunicationPolicy //PLMN ..... | 59 | +| 5.2.140 | /OneToOneDirectCommunicationPolicy //ValidityTimerT4005 ..... | 59 | +| 5.2.141 | /OneToOneDirectCommunicationParameters ..... | 59 | +| 5.2.141A | /OneToOneDirectCommunicationParameters /ApplicationLayerGroup ..... | 59 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------------------------------|------------| +| 5.2.141B | /OneToOneDirectCommunicationParameters /ApplicationLayerGroup/ ..... | 60 | +| 5.2.142 | /OneToOneDirectCommunicationParameters
/ApplicationLayerGroup//Layer2IDForUnicastCommunication ..... | 60 | +| 5.2.142A | /OneToOneDirectCommunicationParameters /PC5SignallingPriority ..... | 60 | +| 5.2.143 | /OneToOneDirectCommunicationParameters /ApplicationLayerGroup//KMSAddress ..... | 60 | +| 5.2.143A | /OneToOneDirectCommunicationParameters
/ApplicationLayerGroup//ApplicationLayerGroupID ..... | 61 | +| 5.2.144 | /DiscoveryPolicyForPS..... | 61 | +| 5.2.145 | /DiscoveryPolicyForPS /ModelAMonitoringPolicy..... | 61 | +| 5.2.146 | /DiscoveryPolicyForPS /ModelAMonitoringPolicy/ ..... | 61 | +| 5.2.147 | /DiscoveryPolicyForPS /ModelAMonitoringPolicy//PLMN ..... | 61 | +| 5.2.148 | /DiscoveryPolicyForPS /ModelAMonitoringPolicy//ValidityTimerT4005 ..... | 62 | +| 5.2.149 | /DiscoveryPolicyForPS /ModelAAnnouncingPolicy ..... | 62 | +| 5.2.150 | /DiscoveryPolicyForPS /ModelAAnnouncingPolicy/ ..... | 62 | +| 5.2.151 | /DiscoveryPolicyForPS /ModelAAnnouncingPolicy//PLMN ..... | 62 | +| 5.2.152 | /DiscoveryPolicyForPS /ModelAAnnouncingPolicy//ValidityTimerT4005..... | 63 | +| 5.2.152A | /DiscoveryPolicyForPS /ModelAAnnouncingPolicy//Range..... | 63 | +| 5.2.153 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy..... | 63 | +| 5.2.154 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy/ ..... | 64 | +| 5.2.155 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy//PLMN ..... | 64 | +| 5.2.156 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy//ValidityTimerT4005 ..... | 64 | +| 5.2.156A | /DiscoveryPolicyForPS /ModelBDiscovererPolicy//Range ..... | 64 | +| 5.2.157 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy ..... | 65 | +| 5.2.158 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy/ ..... | 65 | +| 5.2.159 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy//PLMN ..... | 65 | +| 5.2.160 | /DiscoveryPolicyForPS /ModelBDiscovererPolicy//ValidityTimerT4005..... | 65 | +| 5.2.160A | /DiscoveryPolicyForPS /ModelBDiscovererPolicy//Range..... | 66 | +| 5.2.161 | /Ext..... | 66 | +| 6 | EPC-level ProSe discovery Provisioning MO ..... | 66 | +| 6.1 | Overview ..... | 66 | +| 6.2 | EPC-level ProSe discovery Provisioning MO parameters ..... | 67 | +| 6.2.1 | General ..... | 67 | +| 6.2.2 | /ToConRef ..... | 67 | +| 6.2.3 | /ToConRef/..... | 67 | +| 6.2.4 | /ToConRef//ConRef ..... | 67 | +| 6.2.5 | /Ext..... | 68 | +| Annex A (informative): | ProSe Direct Services Provisioning MO DDF ..... | 69 | +| Annex B (informative): | ProSe Public Safety Direct Services Provisioning MO DDF ..... | 80 | +| Annex C (informative): | EPC-level ProSe discovery Provisioning MO DDF..... | 121 | +| Annex D (informative): | Change history..... | 123 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document defines Management Objects (MO) that are used to configure the ProSe-enabled UE. + +The MOs are compatible with the OMA Device Management (DM) protocol specifications, version 1.2 and upwards, and are defined using the OMA DM Device Description Framework (DDF) as described in the Enabler Release Definition OMA-ERELD-DM-V1\_2 [3]. + +The MOs consist of relevant parameters for provisioning and authorisation of ProSe at the ProSe-enabled UE. + +The protocol aspects for ProSe are described in 3GPP TS 24.334 [4]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.303: "Proximity-based Services (ProSe); Stage 2". +- [3] OMA-ERELD-DM-V1\_2: "Enabler Release Definition for OMA Device Management". +- [4] 3GPP TS 24.334: "Proximity-services (ProSe) User Equipment (UE) to Proximity-services (ProSe) Function Protocol aspects; Stage 3". +- [5] OMA-TS-DM\_Protocol-V1\_2: "OMA Device Management Protocol". +- [6] 3GPP TS 23.003: "Numbering, addressing and identification". +- [7] 3GPP TS 33.303: "Proximity-based Services (ProSe); Security aspects". +- [8] IETF RFC 3927: "Dynamic Configuration of IPv4 Link-Local Addresses". +- [9] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [10] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC) protocol specification". +- [11] OMA-DDS-DM\_ConnMO-V1\_0-20081107-A: "Standardized Connectivity Management Objects". + +--- + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +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]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.303 [2] apply: + +**ProSe Direct Discovery** + +**ProSe Discovery UE ID** +**ProSe-enabled UE** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.334 [4] apply: + +**Not served by E-UTRAN** + +## 3.2 Abbreviations + +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]. + +| | | +|--------|---------------------------------------| +| DDF | Device Description Framework | +| DPF | Direct Services Provisioning Function | +| FQDN | Fully Qualified Domain Name | +| MO | Management Object | +| MSISDN | MS International PSTN/ISDN Number | +| ProSe | Proximity-based Services | + +--- + +## 4 ProSe Direct Services Provisioning MO + +### 4.1 Overview + +The ProSe Direct Services Provisioning MO is used to manage ProSe direct discovery authorisation and provisioning information for a ProSe-enabled non-public safety UE. + +The MO identifier is: `urn:oma:mo:ext-3gpp-prose-direct-provisioning:1.0`. + +The UE may initiate the provision of all available information from the DPF, using a client-initiated session Alert message of code "Generic Alert" (see OMA-TS-DM\_Protocol-V1\_2 [5]). When requesting all available information from the DPF, the "Type" element of the OMA DM generic alert message shall be set to "`urn:oma:mo:ext-3gpp-prose-direct-provisioning:1.0:provision`", the "LocURI" element (inside the "Source" element) shall be set to the address of the ProSe Direct Services Provisioning MO as specified by OMA-TS-DM\_Protocol-V1\_2 [5] and the "Data" element is not included. + +The OMA DM Access Control List (ACL) property mechanism (see OMA-ERELDM-DM-V1\_2 [3]) may be used to grant or deny access rights to OMA DM servers in order to modify nodes and leaf objects of the ProSe Direct Services Provisioning MO. + +The following nodes and leaf objects are possible in the ProSe Direct Services Provisioning MO as described in figure 4.1.1: + +![A hierarchical tree diagram representing the ProSe Direct Services Provisioning Management Object. The root node is . It branches into MonitoringPolicy?, AnnouncingPolicy?, ToConRef?, RestrictedModelA MonitoringPolicy?, RestrictedModelA AnnouncingPolicy?, RestrictedModelB DiscovererPolicy?, RestrictedModelB DiscovereePolicy?, ProSeDiscoveryUE IDInfo?, WLANDirectDiscoveryPLMNList?, and Ext?. MonitoringPolicy?, AnnouncingPolicy?, RestrictedModelA MonitoringPolicy?, RestrictedModelA AnnouncingPolicy?, RestrictedModelB DiscovererPolicy?, RestrictedModelB DiscovereePolicy?, and WLANDirectDiscoveryPLMNList? each lead to an + node, which then branches into PLMN, ValidityTimerT4005, and Range? (except for WLANDirectDiscoveryPLMNList? which only leads to PLMN). ToConRef? leads to an + node which branches into ConRef. ProSeDiscoveryUE IDInfo? leads to ProSeDiscoveryUEID and ValidityTimerT4015.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` +graph LR; X[""] --> MP["MonitoringPolicy?"]; X --> AP["AnnouncingPolicy?"]; X --> TR["ToConRef?"]; X --> RMP["RestrictedModelA MonitoringPolicy?"]; X --> RAP["RestrictedModelA AnnouncingPolicy?"]; X --> RDP["RestrictedModelB DiscovererPolicy?"]; X --> RDeP["RestrictedModelB DiscovereePolicy?"]; X --> PUDI["ProSeDiscoveryUE IDInfo?"]; X --> WPL["WLANDirectDiscoveryPLMNList?"]; X --> Ext["Ext?"]; MP --> Xplus1["+"]; Xplus1 --> PLMN1["PLMN"]; Xplus1 --> VT1["ValidityTimerT4005"]; AP --> Xplus2["+"]; Xplus2 --> PLMN2["PLMN"]; Xplus2 --> VT2["ValidityTimerT4005"]; Xplus2 --> R1["Range?"]; TR --> Xplus3["+"]; Xplus3 --> CR["ConRef"]; RMP --> Xplus4["+"]; Xplus4 --> PLMN3["PLMN"]; Xplus4 --> VT3["ValidityTimerT4005"]; RAP --> Xplus5["+"]; Xplus5 --> PLMN4["PLMN"]; Xplus5 --> VT4["ValidityTimerT4005"]; Xplus5 --> R2["Range?"]; RDP --> Xplus6["+"]; Xplus6 --> PLMN5["PLMN"]; Xplus6 --> VT5["ValidityTimerT4005"]; Xplus6 --> R3["Range?"]; RDeP --> Xplus7["+"]; Xplus7 --> PLMN6["PLMN"]; Xplus7 --> VT6["ValidityTimerT4005"]; Xplus7 --> R4["Range?"]; PUDI --> PUDIID["ProSeDiscoveryUEID"]; PUDI --> VT7["ValidityTimerT4015"]; WPL --> Xplus8["+"]; Xplus8 --> PLMN7["PLMN"]; +``` + +A hierarchical tree diagram representing the ProSe Direct Services Provisioning Management Object. The root node is . It branches into MonitoringPolicy?, AnnouncingPolicy?, ToConRef?, RestrictedModelA MonitoringPolicy?, RestrictedModelA AnnouncingPolicy?, RestrictedModelB DiscovererPolicy?, RestrictedModelB DiscovereePolicy?, ProSeDiscoveryUE IDInfo?, WLANDirectDiscoveryPLMNList?, and Ext?. MonitoringPolicy?, AnnouncingPolicy?, RestrictedModelA MonitoringPolicy?, RestrictedModelA AnnouncingPolicy?, RestrictedModelB DiscovererPolicy?, RestrictedModelB DiscovereePolicy?, and WLANDirectDiscoveryPLMNList? each lead to an + node, which then branches into PLMN, ValidityTimerT4005, and Range? (except for WLANDirectDiscoveryPLMNList? which only leads to PLMN). ToConRef? leads to an + node which branches into ConRef. ProSeDiscoveryUE IDInfo? leads to ProSeDiscoveryUEID and ValidityTimerT4015. + +Figure 4.1.1: The ProSe Direct Services Provisioning Management Object + +## 4.2 ProSe Direct Services Provisioning MO parameters + +### 4.2.1 General + +This subclause describes the parameters for the ProSe Direct Services Provisioning MO. + +### 4.2.2 Node: + +This interior node acts as a placeholder for zero or one account for a fixed node. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +### 4.2.3 /MonitoringPolicy + +The MonitoringPolicy node acts as a placeholder for open ProSe direct discovery monitoring authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 4.2.4 /MonitoringPolicy/ + +This interior node acts as a placeholder for one or more open ProSe direct discovery monitoring authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 4.2.5 /MonitoringPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use open ProSe direct discovery monitoring. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing open ProSe direct discovery monitoring in any PLMN for which no monitoring authorisation policy is available. + +### 4.2.6 /MonitoringPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this open ProSe direct discovery monitoring authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +### 4.2.7 /AnnouncingPolicy + +The AnnouncingPolicy node acts as a placeholder for open ProSe direct discovery announcing authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.8 /AnnouncingPolicy/ + +This interior node acts as a placeholder for one or more open ProSe direct discovery announcing authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.9 /AnnouncingPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use open ProSe direct discovery announcing. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing open ProSe direct discovery announcing in any PLMN for which no announcing authorisation policy is available. + +#### 4.2.10 /AnnouncingPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this open ProSe direct discovery announcing authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +#### 4.2.11 /AnnouncingPolicy//Range + +The Range leaf indicates the authorised announcing range for open ProSe direct discovery in the PLMN in which this announcing authorisation policy applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 4.2.11.1. + +**Table 4.2.11.1: Values of Range leaf** + +| Value | Description | +|-------|----------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised announcing range is set to: Short. | +| 2 | The authorised announcing range is set to: Medium. | +| 3 | The authorised announcing range is set to: Long. | +| 4-255 | Reserved | + +#### 4.2.12 /ToConRef + +The ToConRef interior node is used to allow application to refer to a collection of connectivity definitions. Several connectivity parameters can be listed for a given application under this interior node. + +This interior node contains configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.13 /ToConRef/ + +This run-time node acts as a placeholder for each reference to connectivity parameters. + +- Occurrence: OneOrMore +- Format: Node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.14 /ToConRef//ConRef + +The ConRef specifies a specific linkage to connectivity parameters. + +- Occurrence: One +- Format: Chr +- Access Types: Get, Replace +- Values: + +#### 4.2.15 /RestrictedModelAMonitoringPolicy + +The RestrictedModelAMonitoringPolicy node acts as a placeholder for restricted ProSe direct discovery model A monitoring authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.16 /RestrictedModelAMonitoringPolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model A monitoring authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.17 /RestrictedModelAMonitoringPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model A monitoring. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model A monitoring in any PLMN for which no monitoring authorisation policy is available. + +#### 4.2.18 /RestrictedModelAMonitoringPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model A monitoring authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +#### 4.2.19 /RestrictedModelAAnnouncingPolicy + +The RestrictedModelAAnnouncingPolicy node acts as a placeholder for restricted ProSe direct discovery model A announcing authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.20 /RestrictedModelAAnnouncingPolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model A announcing authorisation policies. + +- Occurrence: OneOrMore +- Format: node + +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.21 /RestrictedModelAAnnouncingPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model A announcing. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model A announcing in any PLMN for which no announcing authorisation policy is available. + +#### 4.2.22 /RestrictedModelAAnnouncingPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model A announcing authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +#### 4.2.23 /RestrictedModelAAnnouncingPolicy//Range + +The Range leaf indicates the authorised announcing range for restricted ProSe direct discovery model A in the PLMN in which this announcing authorisation policy applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 4.2.23.1. + +**Table 4.2.23.1: Values of Range leaf** + +| Value | Description | +|-------|----------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised announcing range is set to: Short. | +| 2 | The authorised announcing range is set to: Medium. | +| 3 | The authorised announcing range is set to: Long. | +| 4-255 | Reserved | + +#### 4.2.24 /RestrictedModelBDiscovererPolicy + +The RestrictedModelBDiscovererPolicy node acts as a placeholder for restricted ProSe direct discovery model B discoverer operation authorisation policy. + +- Occurrence: ZeroOrOne + +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.25 /RestrictedModelBDiscovererPolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model B discoverer operation authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.26 /RestrictedModelBDiscovererPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model B discoverer operation. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model B discoverer operation in any PLMN for which no discoverer operation authorisation policy is available. + +#### 4.2.27 /RestrictedModelBDiscovererPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model B discoverer operation authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +#### 4.2.28 /RestrictedModelBDiscovererPolicy//Range + +The Range leaf indicates the authorised discoverer operation range for restricted ProSe direct discovery model B in the PLMN in which this discoverer operation authorisation policy applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 4.2.28.1. + +**Table 4.2.28.1: Values of Range leaf** + +| Value | Description | +|--------------|--------------------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised discoverer operation range is set to: Short. | +| 2 | The authorised discoverer operation range is set to: Medium. | +| 3 | The authorised discoverer operation range is set to: Long. | +| 4-255 | Reserved | + +#### 4.2.29 /RestrictedModelBDiscovereePolicy + +The RestrictedModelBDiscovereePolicy node acts as a placeholder for restricted ProSe direct discovery model B discoveree operation authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.30 /RestrictedModelBDiscovereePolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model B discoveree operation authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.31 /RestrictedModelBDiscovereePolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model B discoveree operation. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model B discoveree operation in any PLMN for which no discoveree operation authorisation policy is available. + +#### 4.2.32 /RestrictedModelBDiscovereePolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model B discoveree operation authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +#### 4.2.33 /RestrictedModelBDiscovereePolicy//Range + +The Range leaf indicates the authorised discoveree operation range for restricted ProSe direct discovery model B in the PLMN in which this discoveree operation authorisation policy applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 4.2.33.1. + +**Table 4.2.33.1: Values of Range leaf** + +| Value | Description | +|-------|--------------------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised discoveree operation range is set to: Short. | +| 2 | The authorised discoveree operation range is set to: Medium. | +| 3 | The authorised discoveree operation range is set to: Long. | +| 4-255 | Reserved | + +#### 4.2.34 /ProSeDiscoveryUEIDInfo + +The ProSeDiscoveryUEIDInfo node acts as a placeholder for the ProSe Discovery UE ID and its associated validity timer T4015. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.35 /ProSeDiscoveryUEIDInfo/ProSeDiscoveryUEID + +The ProSeDiscoveryUEID leaf contains the ProSe Discovery UE ID assigned to the UE by the HPLMN ProSe Function for restricted ProSe direct discovery. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the ProSe Discovery UE ID is defined by 3GPP TS 23.003 [6]. + +#### 4.2.36 / ProSeDiscoveryUEIDInfo/ValidityTimerT4015 + +The ValidityTimerT4015 leaf indicates in unit of minutes for how long this ProSe Discovery UE ID is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +#### 4.2.36A /WLANDirectDiscoveryPLMNList + +The WLANDirectDiscoveryPLMNList node acts as a placeholder for a list of PLMNs whose ProSe Application IDs the UE is authorized to use for WLAN-based ProSe direct discovery. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.36B /WLANDirectDiscoveryPLMNList/ + +This interior node acts as a placeholder for one or more PLMNs whose ProSe Application IDs the UE is authorized to use for WLAN-based ProSe direct discovery. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +#### 4.2.36C /WLANDirectDiscoveryPLMNList//PLMN + +The PLMN leaf indicates the PLMN code of the operator whose ProSe Application IDs the UE is authorized to use to perform WLAN-based ProSe direct discovery operation. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing WLAN-based ProSe direct discovery using ProSe Application IDs from any PLMN not included in the list. + +#### 4.2.37 /Ext + +The Ext is an interior node for where the vendor specific information about the ProSe Direct Services Provisioning MO is being placed (vendor meaning application vendor, device vendor etc.). Usually the vendor extension is identified by vendor specific name under the ext node. The tree structure under the vendor identifier is not defined and can therefore include one or more un-standardized sub-trees. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +# 5 ProSe Public Safety Direct Services Provisioning MO + +## 5.1 Overview + +The ProSe Public Safety Direct Services Provisioning MO is used to manage ProSe direct discovery and ProSe direct communication authorisation and provisioning information for a ProSe-enabled public safety UE. + +The MO identifier is: urn:oma:mo:ext-3gpp-prose-public-safety-direct-provisioning:1.0. + +The UE may initiate the provision of all available information from the DPF, using a client-initiated session Alert message of code "Generic Alert" (see OMA-TS-DM\_Protocol-V1\_2 [5]). When requesting all available information from the DPF, the "Type" element of the OMA DM generic alert message shall be set to "urn:oma:mo:ext-3gpp-prose-public-safety-direct-provisioning:1.0:provision", the "LocURI" element (inside the "Source" element) shall be set to the address of the ProSe Public Safety Direct Services Provisioning MO as specified by OMA-TS-DM\_Protocol-V1\_2 [5] and the "Data" element is not included. + +The OMA DM Access Control List (ACL) property mechanism (see OMA-ERELD-DM-V1\_2 [3]) may be used to grant or deny access rights to OMA DM servers in order to modify nodes and leaf objects of the ProSe Public Safety Direct Services Provisioning MO. + +The following nodes and leaf objects are possible in the ProSe Public Safety Direct Services Provisioning MO as described in figure 5.1.1 and figure 5.1.2, figure 5.1.3, figure 5.1.4, figure 5.1.5, figure 5.1.6, figure 5.1.7, figure 5.1.8, figure 5.1.9, figure 5.1.10 and figure 5.1.11: + +![A hierarchical tree diagram representing the ProSe Public Safety Direct Services Provisioning Management Object. The root node is , which branches into MonitoringPolicy?, AnnouncingPolicy?, DirectCommunicationPolicy?, DirectCommunicationPolicyNotInEUTRAN?, GroupParameters?, UsageInformationReportingConfiguration?, ToConRef?, RestrictedDiscoveryPolicyForNonPS?, PublicSafetyDiscoveryPolicyNotInEUTRAN?, UEtoNetworkRelayPolicy?, PublicSafetyDiscoveryParameters?, OneToOneDirectCommunicationPolicy?, OneToOneDirectCommunicationParameters?, DiscoveryPolicyForPS?, and Ext?. Sub-nodes include + for MonitoringPolicy?, AnnouncingPolicy?, DirectCommunicationPolicy?, ToConRef?, and OneToOneDirectCommunicationPolicy?. References to other figures (5.1.8, 5.1.3, 5.1.4, 5.1.10, 5.1.5, 5.1.6, 5.1.7, 5.1.11, 5.1.9) are provided for several policy nodes. Attributes like PLMN, ValidityTimerT4005, Range?, and ConRef are also shown.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` +graph LR; X[""] --> MP["MonitoringPolicy?"]; X --> AP["AnnouncingPolicy?"]; X --> DCP["DirectCommunicationPolicy?"]; X --> DCPNI["DirectCommunicationPolicyNotInEUTRAN?"]; X --> GP["GroupParameters?"]; X --> URC["UsageInformationReportingConfiguration?"]; X --> TR["ToConRef?"]; X --> RDP["RestrictedDiscoveryPolicyForNonPS?"]; X --> PSDPNI["PublicSafetyDiscoveryPolicyNotInEUTRAN?"]; X --> UNRP["UEtoNetworkRelayPolicy?"]; X --> PDP["PublicSafetyDiscoveryParameters?"]; X --> ODCP["OneToOneDirectCommunicationPolicy?"]; X --> ODCPParam["OneToOneDirectCommunicationParameters?"]; X --> DPPS["DiscoveryPolicyForPS?"]; X --> Ext["Ext?"]; MP --> MP_X["+"]; MP_X --> MP_PLMN["PLMN"]; MP_X --> MP_VT["ValidityTimerT4005"]; AP --> AP_X["+"]; AP_X --> AP_PLMN["PLMN"]; AP_X --> AP_VT["ValidityTimerT4005"]; AP_X --> AP_R["Range?"]; DCP --> DCP_X["+"]; DCP_X --> DCP_PLMN["PLMN"]; DCP_X --> DCP_VT["ValidityTimerT4005"]; DCPNI --> DCPNI_Ref["See Figure 5.1.8"]; GP --> GP_Ref["See Figure 5.1.3"]; URC --> URC_Ref["See Figure 5.1.4"]; TR --> TR_X["+"]; TR_X --> TR_ConRef["ConRef"]; RDP --> RDP_Ref["See Figure 5.1.10"]; PSDPNI --> PSDPNI_Ref["See Figure 5.1.5"]; UNRP --> UNRP_Ref["See Figure 5.1.6"]; PDP --> PDP_Ref["See Figure 5.1.7"]; ODCP --> ODCP_X["+"]; ODCP_X --> ODCP_PLMN["PLMN"]; ODCP_X --> ODCP_VT["ValidityTimerT4005"]; ODCPParam --> ODCPParam_Ref["See Figure 5.1.11"]; DPPS --> DPPS_Ref["See Figure 5.1.9"]; +``` + +A hierarchical tree diagram representing the ProSe Public Safety Direct Services Provisioning Management Object. The root node is , which branches into MonitoringPolicy?, AnnouncingPolicy?, DirectCommunicationPolicy?, DirectCommunicationPolicyNotInEUTRAN?, GroupParameters?, UsageInformationReportingConfiguration?, ToConRef?, RestrictedDiscoveryPolicyForNonPS?, PublicSafetyDiscoveryPolicyNotInEUTRAN?, UEtoNetworkRelayPolicy?, PublicSafetyDiscoveryParameters?, OneToOneDirectCommunicationPolicy?, OneToOneDirectCommunicationParameters?, DiscoveryPolicyForPS?, and Ext?. Sub-nodes include + for MonitoringPolicy?, AnnouncingPolicy?, DirectCommunicationPolicy?, ToConRef?, and OneToOneDirectCommunicationPolicy?. References to other figures (5.1.8, 5.1.3, 5.1.4, 5.1.10, 5.1.5, 5.1.6, 5.1.7, 5.1.11, 5.1.9) are provided for several policy nodes. Attributes like PLMN, ValidityTimerT4005, Range?, and ConRef are also shown. + +Figure 5.1.1: The ProSe Public Safety Direct Services Provisioning Management Object (1 of 11) + +![A hierarchical tree diagram showing the Geographical Area object. The root node is Geographical Area, which branches into Polygon?. Polygon? branches into +, which branches into Coordinates. Coordinates branches into +, which branches into Latitude and Longitude.](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` +graph LR; GA["Geographical Area"] --> P["Polygon?"]; P --> P_X["+"]; P_X --> C["Coordinates"]; C --> C_X["+"]; C_X --> L["Latitude"]; C_X --> Lon["Longitude"]; +``` + +A hierarchical tree diagram showing the Geographical Area object. The root node is Geographical Area, which branches into Polygon?. Polygon? branches into +, which branches into Coordinates. Coordinates branches into +, which branches into Latitude and Longitude. + +Figure 5.1.2: The ProSe Public Safety Direct Services Provisioning Management Object (2 of 11) + +![Diagram of GroupParameters? object structure](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +This diagram shows the structure of the **GroupParameters?** object. It is a box with a single child element, **+**. The **+** element has six children: **AddressType**, **IPMulticastAddress**, **PKMFAddress?**, **SourceIPv4Address?**, **Layer2GroupID**, and **ApplicationLayerGroupID**. + +Diagram of GroupParameters? object structure + +Figure 5.1.3: The ProSe Public Safety Direct Services Provisioning Management Object (3 of 11) + +![Diagram of UsageInformation ReportingConfiguration? object structure](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +This diagram shows the structure of the **UsageInformation ReportingConfiguration?** object. It is a box with twelve children: **ServerAddress?**, **CollectionPeriod**, **ReportingWindow**, **ReportGroupParameters?**, **ReportTimeStampsFirstTransmission AndReception?**, **ReportDataTransmitted?**, **ReportDataReceived?**, **ReportTimeStampsOutOfCoverage?**, **ReportLocationInCoverage?**, and **ReportRadioParameters?**. + +Diagram of UsageInformation ReportingConfiguration? object structure + +Figure 5.1.4: The ProSe Public Safety Direct Services Provisioning Management Object (4 of 11) + +![Diagram of PublicSafetyDiscovery PolicyNotInEUTRAN? object structure](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +This diagram shows the structure of the **PublicSafetyDiscovery PolicyNotInEUTRAN?** object. It is a box with five children: **MonitoringAuthorisationNotInEUTRAN?**, **AnnouncingAuthorisationNotInEUTRAN?**, **DiscovereeAuthorisationNotInEUTRAN?**, **DiscovererAuthorisationNotInEUTRAN?**, and **DiscoveryRadio Parameters?**. The **DiscoveryRadio Parameters?** box has a child element **+**, which in turn has two children: **RadioParametersContents** and **Geographical Area**. The **Geographical Area** box has a child element **See Figure 5.1.2**. + +Diagram of PublicSafetyDiscovery PolicyNotInEUTRAN? object structure + +Figure 5.1.5: The ProSe Public Safety Direct Services Provisioning Management Object (5 of 11) + +![ASN.1 structure diagram for UETONetworkRelayPolicy?](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +UETONetworkRelayPolicy? ::= SEQUENCE { + AuthorisationForRemoteUE? + AuthorisationForRelay? + DLUnicastTrafficMappingRule? +} + +AuthorisationForRelay? ::= SEQUENCE { + AuthorisedPLMNs? +} + +AuthorisedPLMNs? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN + RemoteUEIMEIReport? + ValidityTimerT4005 +} + +DLUnicastTrafficMappingRule? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + QCI + ProSePerPacketPriority +} + +``` + +ASN.1 structure diagram for UETONetworkRelayPolicy? + +Figure 5.1.6: The ProSe Public Safety Direct Services Provisioning Management Object (6 of 11) + +![ASN.1 structure diagram for PublicSafetyDiscoveryParameters?](7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg) + +``` + +PublicSafetyDiscoveryParameters? ::= SEQUENCE { + GroupMemberDiscoveryParameters? + RelayDiscoveryParameters? +} + +GroupMemberDiscoveryParameters? ::= SEQUENCE { + UserID + + +} + ++ ::= SEQUENCE { + DiscoveryGroupID + ApplicationLayerGroupID + PKMFAddress? +} + +RelayDiscoveryParameters? ::= SEQUENCE { + UserID + RemoteUEParameters? + RelayParameters? +} + +RemoteUEParameters? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + RelayServiceCode + UserIDOfRelay? + IPVersions + PKMFAddress? +} + +RelayParameters? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + RelayServiceCode + PDNType? + APN? + ProSeRelayUEID + PKMFAddress? +} + +``` + +ASN.1 structure diagram for PublicSafetyDiscoveryParameters? + +Figure 5.1.7: The ProSe Public Safety Direct Services Provisioning Management Object (7 of 11) + +![ASN.1 structure diagram for DirectCommunicationPolicyNotInEUTRAN?](5132b3a97ac70fe4765c1e07e66b72b3_img.jpg) + +``` + +DirectCommunicationPolicyNotInEUTRAN? ::= SEQUENCE { + DirectCommunicationAuthorisationNotInEUTRAN? + OneToOneDirectCommunicationAuthorisationNotInEUTRAN? + DirectCommunicationRadioParameters? +} + +DirectCommunicationRadioParameters? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + RadioParametersContents + GeographicalArea +} + +GeographicalArea ::= SEQUENCE { + See Figure 5.1.2 +} + +``` + +ASN.1 structure diagram for DirectCommunicationPolicyNotInEUTRAN? + +Figure 5.1.8: The ProSe Public Safety Direct Services Provisioning Management Object (8 of 11) + +![ASN.1 structure diagram for DiscoveryPolicyForPS?](26d664119ad25250780f554633444e54_img.jpg) + +``` + +DiscoveryPolicyForPS? ::= SEQUENCE { + ModelAMonitoringPolicy? ModelAMonitoringPolicy?, + ModelAAnnouncingPolicy? ModelAAnnouncingPolicy?, + ModelBDiscovererPolicy? ModelBDiscovererPolicy?, + ModelBDiscovereePolicy? ModelBDiscovereePolicy? +} + +ModelAMonitoringPolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005 +} + +ModelAAnnouncingPolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005, + Range? +} + +ModelBDiscovererPolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005, + Range? +} + +ModelBDiscovereePolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005, + Range? +} + +``` + +ASN.1 structure diagram for DiscoveryPolicyForPS? + +Figure 5.1.9: The ProSe Public Safety Direct Services Provisioning Management Object (9 of 11) + +![ASN.1 structure diagram for RestrictedDiscoveryPolicyForNonPS?](a0739aaf13fa5a632d4faa830f6b2708_img.jpg) + +``` + +RestrictedDiscoveryPolicyForNonPS? ::= SEQUENCE { + RestrictedModelAMonitoringPolicy? RestrictedModelAMonitoringPolicy?, + RestrictedModelAAnnouncingPolicy? RestrictedModelAAnnouncingPolicy?, + RestrictedModelBDiscovererPolicy? RestrictedModelBDiscovererPolicy?, + RestrictedModelBDiscovereePolicy? RestrictedModelBDiscovereePolicy?, + ProSeDiscoveryUEIDInfo? ProSeDiscoveryUEIDInfo? +} + +RestrictedModelAMonitoringPolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005 +} + +RestrictedModelAAnnouncingPolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005, + Range? +} + +RestrictedModelBDiscovererPolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005, + Range? +} + +RestrictedModelBDiscovereePolicy? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + PLMN, + ValidityTimerT4005, + Range? +} + +ProSeDiscoveryUEIDInfo? ::= SEQUENCE { + ProSeDiscoveryUEID, + ValidityTimerT4015 +} + +``` + +ASN.1 structure diagram for RestrictedDiscoveryPolicyForNonPS? + +Figure 5.1.10: The ProSe Public Safety Direct Services Provisioning Management Object (10 of 11) + +![ASN.1 structure diagram for OneToOneDirectCommunicationParameters?](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +``` + +OneToOneDirectCommunicationParameters? ::= SEQUENCE { + PC5SignallingPriority, + ApplicationLayerGroup? +} + +ApplicationLayerGroup? ::= SEQUENCE { + + +} + ++ ::= SEQUENCE { + Layer2IDForUnicastCommunication, + KMSAddress?, + ApplicationLayerGroupID +} + +``` + +ASN.1 structure diagram for OneToOneDirectCommunicationParameters? + +Figure 5.1.11: The ProSe Public Safety Direct Services Provisioning Management Object (11 of 11) + +## 5.2 ProSe Public Safety Direct Services Provisioning MO parameters + +### 5.2.1 General + +This clause describes the parameters for the ProSe Public Safety Direct Services Provisioning MO. + +### 5.2.2 Node: + +This interior node acts as a placeholder for zero or one account for a fixed node. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +### 5.2.3 /MonitoringPolicy + +The MonitoringPolicy node acts as a placeholder for open ProSe direct discovery monitoring authorisation policy for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.4 /MonitoringPolicy/ + +This interior node acts as a placeholder for one or more open ProSe direct discovery monitoring authorisation policies for non-public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.5 /MonitoringPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use open ProSe direct discovery monitoring for non-public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing open ProSe direct discovery monitoring in any PLMN for which no monitoring authorisation policy is available. + +## 5.2.6 /MonitoringPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this open ProSe direct discovery monitoring authorisation policy for non-public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.7 /AnnouncingPolicy + +The AnnouncingPolicy node acts as a placeholder for open ProSe direct discovery announcing authorisation policy for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.8 /AnnouncingPolicy/ + +This interior node acts as a placeholder for one or more open ProSe direct discovery announcing authorisation policies for non-public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.9 /AnnouncingPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use open ProSe direct discovery announcing for non-public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing open ProSe direct discovery announcing in any PLMN for which no announcing authorisation policy is available. + +## 5.2.10 /AnnouncingPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this open ProSe direct discovery announcing authorisation policy for non-public safety use is valid. + +- Occurrence: One +- Format: int + +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.11 /AnnouncingPolicy//Range + +The Range leaf indicates the authorised announcing range for open ProSe direct discovery for non-public safety use in the PLMN in which this announcing authorisation policy applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.11.1. + +**Table 5.2.11.1: Values of Range leaf** + +| Value | Description | +|-------|----------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised announcing range is set to: Short. | +| 2 | The authorised announcing range is set to: Medium. | +| 3 | The authorised announcing range is set to: Long. | +| 4-255 | Reserved | + +5.2.12 Void + +5.2.13 Void + +5.2.14 Void + +5.2.15 Void + +5.2.16 Void + +5.2.17 Void + +5.2.18 Void + +5.2.19 Void + +5.2.20 Void + +5.2.21 Void + +5.2.22 Void + +5.2.23 Void + +5.2.24 Void + +5.2.25 Void + +5.2.26 Void + +5.2.27 Void + +5.2.28 Void + +5.2.29 Void + +5.2.30 Void + +5.2.31 Void + +5.2.32 Void + +5.2.33 Void + +5.2.34 Void + +### 5.2.35 /DirectCommunicationPolicy + +The DirectCommunicationPolicy node acts as a placeholder for one-to-many ProSe direct communication authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.36 /DirectCommunicationPolicy/ + +This interior node acts as a placeholder for one or more one-to-many ProSe direct communication authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.37 /DirectCommunicationPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use one-to-many ProSe direct communication. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing one-to-many ProSe direct communication in any PLMN for which no monitoring authorisation policy is available. + +### 5.2.38 /DirectCommunicationPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +### 5.2.39 /DirectCommunicationPolicyNotInEUTRAN + +The DirectCommunicationPolicyNotInEUTRAN node acts as a placeholder for the description of the direct communication authorisation when the UE is not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.40 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationAuthorisationNotInEUTRAN + +The DirectCommunicationAuthorisationNotInEUTRAN leaf indicates whether the UE is authorised to perform one-to-many ProSe direct communication when not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: bool + +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE is not authorised to perform one-to-many ProSe direct communication when not served by E-UTRAN. + - 1 Indicates that the UE is authorised to perform one-to-many ProSe direct communication when not served by E-UTRAN. + +## 5.2.40A /DirectCommunicationPolicyNotInEUTRAN/ OneToOneDirectCommunicationAuthorisationNotInEUTRAN + +The OneToOneDirectCommunicationAuthorisationNotInEUTRAN leaf indicates whether the UE is authorised to perform one-to-one ProSe direct communication when not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE is not authorised to perform one-to-one ProSe direct communication when not served by E-UTRAN. + - 1 Indicates that the UE is authorised to perform one-to-one ProSe direct communication when not served by E-UTRAN. + +## 5.2.41 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters + +The DirectCommunicationRadioParameters node acts as a placeholder for the radio parameter information needed for the UE to perform ProSe direct communication when the UE is not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.42 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters/ + +This interior node acts as a place holder for one or more set of radio parameters needed for the UE to perform ProSe direct communication when the UE is not served by E-UTRAN. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +### 5.2.43 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// RadioParametersContents + +The RadioParametersContents leaf contains the radio parameters to be used to perform ProSe direct communication when the UE is not served by E-UTRAN and the UE determines itself to be located in a geographical area associated with these radio parameters. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The RadioParametersContents is defined as *SL-Preconfiguration* in clause 9 of 3GPP TS 36.331 [10]. + +### 5.2.44 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea + +The GeographicalArea node acts as a placeholder for the geographical area associated with a set of radio parameters. The radio parameters are used by the UE for ProSe direct communication when the UE is not served by E-UTRAN and within an associated geographical area. + +- Occurrence: One +- Format: Node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.45 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea/Polygon + +The Polygon node acts as a placeholder for polygon geographical area descriptions. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.46 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea/Polygon/ + +This interior node acts as a placeholder for one or more polygon geographical area descriptions. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +### 5.2.47 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea/Polygon//Coordinates + +The Coordinates node acts as a placeholder for geographical coordinates outlining the borders of a polygon geographical area. + +- Occurrence: One +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.48 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea/Polygon//Coordinates/ + +This interior node acts as a placeholder for one or more geographical coordinates. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +NOTE: The upper limit of 15 specified in 3GPP TS 23.032 [9] for the number of points in a polygon shape does not apply to the number of coordinates in a geographical area described as a polygon for ProSe direct communication. + +### 5.2.49 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea/Polygon//Coordinates//Latitude + +The Latitude leaf contains the latitude of a geographical coordinate outlining the border of the polygon geographical area. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The Latitude is defined in subclause 6.1 of 3GPP TS 23.032 [9]. + +### 5.2.50 /DirectCommunicationPolicyNotInEUTRAN/ DirectCommunicationRadioParameters// GeographicalArea/Polygon//Coordinates//Longitude + +The Longitude leaf contains the longitude of a geographical coordinate outlining the border of the polygon geographical area. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace + +- Values: + +The Longitude is defined in subclause 6.1 of 3GPP TS 23.032 [9]. + +## 5.2.51 /GroupParameters + +The GroupParameters node acts as a placeholder for one-to-many ProSe direct communication group parameters. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.52 /GroupParameters/ + +This interior node acts as a placeholder for one or more set of group parameters for one-to-many ProSe direct communication. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.53 /GroupParameters//AddressType + +The AddressType leaf indicates the IP version of the addresses described by the IPMulticastAddress leaf. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: 'IPv4', 'IPv6' + +## 5.2.54 /GroupParameters//IPMulticastAddress + +The IPMulticastAddress leaf indicates the IP multicast address to be used for performing one-to-many ProSe direct communication. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The value of this leaf is an IPv4 address if the AddressType leaf value of the same rule is equal to "IPv4". The value of this leaf is an IPv6 address if the AddressType leaf value of the same rule is equal to "IPv6". + +## 5.2.55 /GroupParameters//PKMFAddress + +The PKMFAddress leaf contains the address of the ProSe Key Management Function that the UE uses to obtain the group security related contents (see 3GPP TS 33.303 [7]). + +- Occurrence: ZeroOrOne + +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The UE shall use the IP address of the HPLMN ProSe Function if this leaf is not provisioned. + +## 5.2.56 /GroupParameters//SourceIPv4address + +The SourceIPv4address leaf indicates the IP source address of the IP address to be used by the UE as a source address. If none is provisioned, then the UE shall use Dynamic Configuration of IPv4 Link-Local Addresses IETF RFC 3927 [8] to obtain a link local address for the Group. The source address refers to the IP address of the data packets destined for the UE. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: + +The value of this leaf is an IPv4 address. + +The absence of this leaf indicates that the UE shall use Dynamic Configuration of IPv4 Link-Local Addresses IETF RFC 3927 [8] to obtain a link local address for the group. + +## 5.2.57 /GroupParameters//Layer2GroupID + +The Layer2GroupID leaf indicates the group ID to be used at layer 2 for performing one-to-many ProSe direct communication. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.57A /GroupParameters//ApplicationLayerGroupID + +The ApplicationLayerGroupID leaf indicates the Application Layer Group ID identifying an application layer group that the UE belongs to. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: < Application Layer Group ID> + +## 5.2.58 /UsageInformationReportingConfiguration + +The UsageInformationReportingConfiguration node acts as a placeholder for the description of the configuration to be used by the UE for reporting of usage information. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.59 /UsageInformationReportingConfiguration/ServerAddress + +The ServerAddress leaf contains the address of the server to which the UE shall upload the usage information reports. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The UE shall upload the usage information reports to the IP address of the HPLMN ProSe Function if this leaf is not provisioned. + +## 5.2.60 /UsageInformationReportingConfiguration/CollectionPeriod + +The CollectionPeriod leaf contains the time interval, in unit of minutes, at which the UE shall generate the usage information reports. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 0-129600. + +Setting the CollectionPeriod leaf to a value of 0 disables generation of usage information reports at the UE. + +## 5.2.61 /UsageInformationReportingConfiguration/ReportingWindow + +The ReportingWindow contains the time window, in units of minutes, during which the UE shall upload the usage information report to the server. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 0-129600 + +Setting the ReportingWindow leaf to a value of 0 disables upload of the usage information reports by the UE. + +## 5.2.62 /UsageInformationReportingConfiguration/ReportGroupParameters + +The ReportGroupParameters leaf indicates whether or not the UE shall report the group parameters for one-to-many ProSe direct communication in the usage information. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE shall not report the group parameters for one-to-many ProSe direct communication in the usage information. + - 1 Indicates that the UE shall report the group parameters for one-to-many ProSe direct communication in the usage information. + +The default value 0 applies if this leaf is not provisioned. + +### 5.2.63 /UsageInformationReportingConfiguration/ReportTimeStampsFirstTransmissionAndReception + +The ReportTimeStampsFirstTransmissionAndReception leaf indicates whether or not the UE shall report the time stamps of the first transmission/reception during the collection period in the usage information. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE shall not report the time stamps of the first transmission/reception during the collection period in the usage information. + - 1 Indicates that the UE shall report the time stamps of the first transmission/reception during the collection period in the usage information. + +The default value 0 applies if this leaf is not provisioned. + +### 5.2.64 /UsageInformationReportingConfiguration/ReportDataTransmitted + +The ReportDataTransmitted leaf indicates whether or not the UE shall report the amount of data transmitted during the collection period in the usage information, and whether with location information. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the ReportDataTransmitted are specified in table 5.2.64.1. + +**Table 5.2.64.1: Values of ReportDataTransmitted leaf** + +| Value | Description | +|-------|----------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Reserved | +| 1 | The UE shall not report the amount of data transmitted during the collection period in the usage information. | +| 2 | The UE shall report the amount of data transmitted during the collection period in the usage information without location information. | +| 3 | The UE shall report the amount of data transmitted during the collection period in the usage information with location information. | +| 4-255 | Reserved | + +The default value 1 applies if this leaf is not provisioned. + +### 5.2.65 /UsageInformationReportingConfiguration/ReportDataReceived + +The ReportDataReceived leaf indicates whether or not the UE shall report the amount of data received during the collection period in the usage information, and whether with location information. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the ReportDataReceived are specified in table 5.2.65.1. + +**Table 5.2.65.1: Values of ReportDataReceived leaf** + +| Value | Description | +|-------|-------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Reserved | +| 1 | The UE shall not report the amount of data received during the collection period in the usage information. | +| 2 | The UE shall report the amount of data received during the collection period in the usage information without location information. | +| 3 | The UE shall report the amount of data received during the collection period in the usage information with location information. | +| 4-255 | Reserved | + +The default value 1 applies if this leaf is not provisioned. + +## 5.2.66 /UsageInformationReportingConfiguration/ReportTimeStampsOutOfCoverage + +The ReportTimeStampsOutOfCoverage leaf indicates whether or not the UE shall report the time stamps when it went in and out of E-UTRAN coverage during the collection period in the usage information. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE shall not report the time stamps when it went in and out of E-UTRAN coverage during the collection period in the usage information. + - 1 Indicates that the UE shall report the time stamps when it went in and out of E-UTRAN coverage during the collection period in the usage information. + +The default value 0 applies if this leaf is not provisioned. + +## 5.2.66A /UsageInformationReportingConfiguration/ReportLocationInCoverage + +The ReportLocationInCoverage leaf indicates whether or not the UE shall report the list of locations of the UE when in E-UTRAN coverage during the collection period in the usage information. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE shall not report the list of locations of the UE when in E-UTRAN coverage during the collection period in the usage information. + - 1 Indicates that the UE shall report the list of locations of the UE when in E-UTRAN coverage during the collection period in the usage information. + +The default value 0 applies if this leaf is not provisioned. + +## 5.2.66B /UsageInformationReportingConfiguration/ReportRadioParameters + +The ReportRadioParameters leaf indicates whether or not the UE shall report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE shall not report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information. + - 1 Indicates that the UE shall report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information. + +The default value 0 applies if this leaf is not provisioned. + +## 5.2.67 /ToConRef + +The ToConRef interior node is used to allow application to refer to a collection of connectivity definitions. Several connectivity parameters can be listed for a given application under this interior node. + +This interior node contains configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.68 /ToConRef/ + +This run-time node acts as a placeholder for each reference to connectivity parameters. + +- Occurrence: OneOrMore +- Format: Node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.69 /ToConRef//ConRef + +The ConRef specifies a specific linkage to connectivity parameters. + +- Occurrence: One +- Format: Chr +- Access Types: Get, Replace +- Values: + +## 5.2.70 /RestrictedDiscoveryPolicyForNonPS + +The RestrictedDiscoveryPolicyForNonPS node acts as a placeholder for restricted ProSe direct discovery authorisation policies for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.71 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAMonitoringPolicy + +The RestrictedModelAMonitoringPolicy node acts as a placeholder for restricted ProSe direct discovery model A monitoring authorisation policy for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.72 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAMonitoringPolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model A monitoring authorisation policies for non-public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.73 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAMonitoringPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model A monitoring for non-public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model A monitoring in any PLMN for which no monitoring authorisation policy is available. + +### 5.2.74 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAMonitoringPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model A monitoring authorisation policy is valid for non-public safety use. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +### 5.2.75 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAAnnouncingPolicy + +The RestrictedModelAAnnouncingPolicy node acts as a placeholder for restricted ProSe direct discovery model A announcing authorisation policy for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.76 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAAnnouncingPolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model A announcing authorisation policies for non-public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.77 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAAnnouncingPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model A announcing for non-public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model A announcing in any PLMN for which no announcing authorisation policy is available. + +## 5.2.78 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAAnnouncingPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model A announcing authorisation policy for non-public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.79 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelAAnnouncingPolicy//Range + +The Range leaf indicates the authorised announcing range for restricted ProSe direct discovery model A in the PLMN in which this announcing authorisation policy for non-public safety use applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.79.1. + +**Table 5.2.79.1: Values of Range leaf** + +| Value | Description | +|-------|----------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised announcing range is set to: Short. | +| 2 | The authorised announcing range is set to: Medium. | +| 3 | The authorised announcing range is set to: Long. | +| 4-255 | Reserved | + +## 5.2.80 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovererPolicy + +The RestrictedModelBDiscovererPolicy node acts as a placeholder for restricted ProSe direct discovery model B discoverer operation authorisation policy for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.81 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovererPolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model B discoverer operation authorisation policies for non-public safety use. + +- Occurrence: OneOrMore +- Format: node + +- Access Types: Get, Replace +- Values: N/A + +## 5.2.82 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovererPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model B discoverer operation for non-public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model B discoverer operation in any PLMN for which no discoverer operation authorisation policy is available. + +## 5.2.83 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovererPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model B discoverer operation authorisation policy for non-public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.84 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovererPolicy//Range + +The Range leaf indicates the authorised discoverer operation range for restricted ProSe direct discovery model B in the PLMN in which this discoverer operation authorisation policy for non-public safety use applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.84.1. + +**Table 5.2.84.1: Values of Range leaf** + +| Value | Description | +|-------|--------------------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised discoverer operation range is set to: Short. | +| 2 | The authorised discoverer operation range is set to: Medium. | +| 3 | The authorised discoverer operation range is set to: Long. | +| 4-255 | Reserved | + +## 5.2.85 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovereePolicy + +The RestrictedModelBDiscovereePolicy node acts as a placeholder for restricted ProSe direct discovery model B discoveree operation authorisation policy for non-public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.86 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovereePolicy/ + +This interior node acts as a placeholder for one or more restricted ProSe direct discovery model B discoveree operation authorisation policies for non-public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.87 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovereePolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use restricted ProSe direct discovery model B discoveree operation for non-public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing restricted ProSe direct discovery model B discoveree operation in any PLMN for which no discoveree operation authorisation policy is available. + +## 5.2.88 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovereePolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this restricted ProSe direct discovery model B discoveree operation authorisation policy for non-public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.89 /RestrictedDiscoveryPolicyForNonPS/RestrictedModelBDiscovereePolicy//Range + +The Range leaf indicates the authorised discoveree operation range for restricted ProSe direct discovery model B in the PLMN in which this discoveree operation authorisation policy for non-public safety use applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.89.1. + +**Table 5.2.89.1: Values of Range leaf** + +| Value | Description | +|-------|--------------------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised discoveree operation range is set to: Short. | +| 2 | The authorised discoveree operation range is set to: Medium. | +| 3 | The authorised discoveree operation range is set to: Long. | +| 4-255 | Reserved | + +## 5.2.90 /RestrictedDiscoveryPolicyForNonPS/ProSeDiscoveryUEIDInfo + +The ProSeDiscoveryUEIDInfo node acts as a placeholder for the ProSe Discovery UE ID and its associated validity timer T4015, which are used for restricted ProSe direct discovery for non-Public Safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.91 /RestrictedDiscoveryPolicyForNonPS/ProSeDiscoveryUEIDInfo/ProSeDiscoveryUEID + +The ProSeDiscoveryUEID leaf contains the ProSe Discovery UE ID assigned to the UE by the HPLMN ProSe Function for restricted ProSe direct discovery for non-Public Safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the ProSe Discovery UE ID is defined by 3GPP TS 23.003 [6]. + +## 5.2.92 /RestrictedDiscoveryPolicyForNonPS/ProSeDiscoveryUEIDInfo/ValidityTimerT4015 + +The ValidityTimerT4015 leaf indicates in unit of minutes for how long this ProSe Discovery UE ID is valid. + +- Occurrence: One +- Format: int + +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.93 /PublicSafetyDiscoveryPolicyNotInEUTRAN + +The PublicSafetyDiscoveryPolicyNotInEUTRAN node acts as a placeholder for the description of the direct discovery authorisation when the UE is not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.94 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ MonitoringAuthorisationNotInEUTRAN + +The MonitoringAuthorisationNotInEUTRAN leaf indicates whether the UE is authorised to perform ProSe direct discovery model A monitoring when not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE is not authorised to perform ProSe direct discovery model A monitoring when not served by E-UTRAN. + - 1 Indicates that the UE is authorised to perform ProSe direct discovery model A monitoring when not served by E-UTRAN. + +## 5.2.95 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ AnnouncingAuthorisationNotInEUTRAN + +The AnnouncingAuthorisationNotInEUTRAN leaf indicates whether the UE is authorised to perform ProSe direct discovery model A announcing when not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE is not authorised to perform ProSe direct discovery model A announcing when not served by E-UTRAN. + - 1 Indicates that the UE is authorised to perform ProSe direct discovery model A announcing when not served by E-UTRAN. + +## 5.2.96 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscovereeAuthorisationNotInEUTRAN + +The DiscovereeAuthorisationNotInEUTRAN leaf indicates whether the UE is authorised to perform ProSe direct discovery model B discoveree operation when not served by E-UTRAN. + +- Occurrence: ZeroOrOne + +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE is not authorised to perform ProSe direct discovery model B discoveree operation when not served by E-UTRAN. + - 1 Indicates that the UE is authorised to perform ProSe direct discovery model B discoveree operation when not served by E-UTRAN. + +## 5.2.97 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscovererAuthorisationNotInEUTRAN + +The DiscovererAuthorisationNotInEUTRAN leaf indicates whether the UE is authorised to perform ProSe direct discovery model B discoverer operation when not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE is not authorised to perform ProSe direct discovery model B discoverer operation when not served by E-UTRAN. + - 1 Indicates that the UE is authorised to perform ProSe direct discovery model B discoverer operation when not served by E-UTRAN. + +## 5.2.98 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters + +The DiscoveryRadioParameters node acts as a placeholder for the radio parameter information needed for the UE to perform ProSe direct discovery when the UE is not served by E-UTRAN. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.99 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters/ + +This interior node acts as a placeholder for one or more set of radio parameters needed for the UE to perform ProSe direct discovery when the UE is not served by E-UTRAN. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +## 5.2.100 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//RadioParametersContents + +The RadioParametersContents leaf contains the radio parameters to be used to perform ProSe direct discovery when the UE is not served by E-UTRAN and the UE determines itself to be located in a geographical area associated with these radio parameters. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The RadioParametersContents is defined as *SL-Preconfiguration* in clause 9 of 3GPP TS 36.331 [10]. + +## 5.2.101 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//GeographicalArea + +The GeographicalArea node acts as a placeholder for the geographical area associated with a set of radio parameters. The radio parameters are used by the UE for ProSe direct discovery when the UE is not served by E-UTRAN and within an associated geographical area. + +- Occurrence: One +- Format: Node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.102 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//GeographicalArea/Polygon + +The Polygon node acts as a placeholder for polygon geographical area descriptions. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.103 /PublicSafetyDiscoveryPolicyNotInEUTRAN/DiscoveryRadioParameters//GeographicalArea/Polygon/ + +This interior node acts as a placeholder for one or more polygon geographical area descriptions. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +### 5.2.104 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters //GeographicalArea/Polygon//Coordinates + +The Coordinates node acts as a placeholder for geographical coordinates outlining the borders of a polygon geographical area. + +- Occurrence: One +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.105 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters//GeographicalArea/Polygon//Coordinates / + +This interior node acts as a placeholder for one or more geographical coordinates. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +NOTE: The upper limit of 15 specified in 3GPP TS 23.032 [9] for the number of points in a polygon shape does not apply to the number of coordinates in a geographical area described as a polygon for ProSe direct communication. + +### 5.2.106 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters//GeographicalArea/Polygon// Coordinates//Latitude + +The Latitude leaf contains the latitude of a geographical coordinate outlining the border of the polygon geographical area. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The Latitude is defined in subclause 6.1 of 3GPP TS 23.032 [9]. + +### 5.2.107 /PublicSafetyDiscoveryPolicyNotInEUTRAN/ DiscoveryRadioParameters//GeographicalArea/Polygon//Coordinates //Longitude + +The Longitude leaf contains the longitude of a geographical coordinate outlining the border of the polygon geographical area. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace + +- Values: + +The Longitude is defined in subclause 6.1 of 3GPP TS 23.032 [9]. + +## 5.2.108 /UETONetworkRelayPolicy + +The UETONetworkRelayPolicy node acts as a placeholder for ProSe UE-to-network relay authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.109 /UETONetworkRelayPolicy/AuthorisationForRemoteUE + +The AuthorisationForRemoteUE leaf indicates whether the UE is authorised to act as a remote UE towards a ProSe UE-to-network relay UE. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0,1 + - 0 Indicates that the UE is not authorised to act as a remote UE towards a ProSe UE-to-network relay UE. + - 1 Indicates that the UE is authorised to act as a remote UE towards a ProSe UE-to-network relay UE. + +## 5.2.110 Void + +## 5.2.111 Void + +## 5.2.112 Void + +## 5.2.113 /UETONetworkRelayPolicy/AuthorisationForRelay + +The AuthorisationForRelay node acts as a placeholder for the authorisation policy to act as a ProSe UE-to-network relay. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.113A /UETONetworkRelayPolicy/AuthorisationForRelay/AuthorisedPLMNs + +The AuthorisedPLMNs node acts as a placeholder for the per-PLMN authorisation policies to act as a ProSe UE-to-network relay. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.114 /UETONetworkRelayPolicy/AuthorisationForRelay/AuthorisedPLMNs/ + +This interior node acts as a placeholder for one or more authorisation policies to act as a ProSe UE-to-network relay. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.115 /UETONetworkRelayPolicy/AuthorisationForRelay/AuthorisedPLMNs//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to act as a ProSe UE-to-network relay. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +## 5.2.115A /UETONetworkRelayPolicy/AuthorisationForRelay/AuthorisedPLMNs//RemoteUEIMEIReport + +The RemoteUEIMEIReport leaf indicates whether the ProSe UE-to-network relay is configured to report the IMEI or IMEISV of remote UE(s) using the relay service provided by this ProSe UE-to-network relay. + +- Occurrence: ZeroOrOne + - Format: int + - Access Types: Get, Replace + - Values: 0, 1, 2 +- 0 Indicates that the ProSe UE-to-network relay UE is not configured to report the IMEI or IMEISV of remote UE(s) using the relay service provided by this ProSe UE-to-network relay. + - 1 Indicates that the ProSe UE-to-network relay UE is configured to report the IMEI of the remote UE(s) using the relay service provided by this ProSe UE-to-network relay. + - 2 Indicates that the ProSe UE-to-network relay UE is configured to report the IMEISV of the remote UE(s) using the relay service provided by this ProSe UE-to-network relay. + +The default value of 0 applies if this leaf is omitted. + +## 5.2.116 /UETONetworkRelayPolicy/AuthorisationForRelay/AuthorisedPLMNs//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace + +- Values: 1-525600 + +## 5.2.116A /UETONetworkRelayPolicy/AuthorisationForRelay/DLUnicastTrafficMappingRule + +The DLUnicastTrafficMappingRule node acts as a placeholder for the mapping rules between the QCI of the EPS bearer and the ProSe Per-Packet Priority (PPPP) for downlink unicast traffic to be relayed over the PC5 interface. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.116B /UETONetworkRelayPolicy/AuthorisationForRelay/DLUnicastTrafficMappingRule/ + +This interior node acts as a placeholder for one or more mapping rules for downlink unicast traffic for a ProSe UE-to-network relay. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.116C /UETONetworkRelayPolicy/AuthorisationForRelay/DLUnicastTrafficMappingRule//QCI + +The QCI leaf indicates the QCI value of the EPS bearer configured by the mapping rule. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 0-255 + +## 5.2.116D /UETONetworkRelayPolicy/AuthorisationForRelay/DLUnicastTrafficMappingRule//ProSePerPacketPriority + +The ProSePerPacketPriority leaf indicates the ProSe Per-Packet Priority value to which the QCI value associated to the same mapping rule is mapped. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-8 + +## 5.2.117 /PublicSafetyDiscoveryParameters + +The PublicSafetyDiscoveryParameters node acts as a placeholder for ProSe direct discovery parameters for public safety use. + +- Occurrence: ZeroOrOne + +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.118 /PublicSafetyDiscoveryParameters/GroupMemberDiscoveryParameters + +The GroupMemberDiscoveryParameters node acts as a placeholder for ProSe direct discovery parameters when it is used for Group Member Discovery. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.119 /PublicSafetyDiscoveryParameters/GroupMemberDiscoveryParameters/UserInfoID + +The UserInfoID leaf indicates the user information which is sent by the announcing or discoverer or discoveree UE over the air during Group Member Discovery procedures. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.120 /PublicSafetyDiscoveryParameters/GroupMemberDiscoveryParameters/ + +This interior node acts as a placeholder for one or more sets of ProSe direct discovery parameters when it is used for group member discovery. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.121 /PublicSafetyDiscoveryParameters/GroupMemberDiscoveryParameters//DiscoveryGroupID + +The DiscoveryGroupID leaf indicates the group ID of the discovery group that the UE belongs to when group member discovery is performed. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.121A /PublicSafetyDiscoveryParameters/GroupMemberDiscoveryParameters//ApplicationLayerGroupID + +The ApplicationLayerGroupID leaf indicates the Application Layer Group ID identifying an application layer group that the UE belongs to. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: < Application Layer Group ID> + +## 5.2.121B /PublicSafetyDiscoveryParameters/GroupMemberDiscoveryParameters//PKMFAddress + +The PKMFAddress leaf contains the address of the ProSe Key Management Function that the UE uses to obtain the security related contents (see 3GPP TS 33.303 [7]). + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The UE shall use the IP address of the HPLMN ProSe Function if this leaf is not provisioned. + +## 5.2.122 /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters + +The RelayDiscoveryParameters node acts as a placeholder for ProSe direct discovery parameters when it is used for ProSe UE-to-network relay discovery. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.123 /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/UserInfoID + +The UserInfoID leaf indicates the user information which is sent by the announcing or discoverer or discoveree UE over the air during ProSe UE-to-network relay discovery procedures. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.124 /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RemoteUEParameters + +The RemoteUEParameters node acts as a placeholder for ProSe direct discovery parameters at the remote UE for ProSe UE-to-network relay discovery. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.125 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RemoteUEParameters/ + +This interior node acts as a placeholder for one or more sets of ProSe direct discovery parameters at the remote UE for ProSe UE-to-network relay discovery. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.126 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RemoteUEParameters//RelayServiceCode + +The RelayServiceCode leaf indicates the connectivity service that the ProSe UE-to-network relay provides to public safety applications. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.127 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RemoteUEParameters//UserInfoIDOfRelay + +The UserInfoIDOfRelay leaf indicates the user information of the ProSe UE-to-network relay that the remote UE seeks to discover during ProSe UE-to-network relay discovery procedures. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.128 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RemoteUEParameters//IPVersions + +The IPVersions leaf indicates the IP version(s) that the remote UE can use for the relay traffic associated with the Relay Service Code. + +- Occurrence: One + +- Format: chr +- Access Types: Get, Replace +- Values: 'IPv4', 'IPv6', 'IPv4v6' + +## 5.2.129 /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RemoteUEParameters//PKMFAddress + +The PKMFAddress leaf contains the address of the ProSe Key Management Function that the UE uses to obtain the security related contents (see 3GPP TS 33.303 [7]). + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The UE shall use the IP address of the HPLMN ProSe Function if this leaf is not provisioned. + +## 5.2.130 /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters + +The RelayParameters node acts as a placeholder for ProSe direct discovery parameters at the ProSe UE-to-network relay. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.131 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters/ + +This interior node acts as a placeholder for one or more sets of ProSe direct discovery parameters at the ProSe UE-to-network relay. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.132 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters//RelayServiceCode + +The RelayServiceCode leaf indicates the connectivity service that the ProSe UE-to-network relay provides to public safety applications. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace + +- Values: + +## 5.2.133 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters//PDNType + +The PDNType leaf indicates the IP version of the PDN connection to be used for the relayed traffic associated with a Relay Service Code. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: 'IPv4', 'IPv6' + +## 5.2.134 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters//APN + +The APN leaf indicates the PDN connection that the ProSe UE-to-network relay uses for the relayed traffic associated with a Relay Service Code. + +If this leaf is omitted, then the default APN is used for the PDN connectivity. + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: < A network access point object > + +## 5.2.135 + +### /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters//ProSeRelayUEID + +The ProSeRelayUEID leaf indicates the link layer identifier used for direct communication associated with a Relay Service Code. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: < ProSe UE ID> + +## 5.2.136 /PublicSafetyDiscoveryParameters/RelayDiscoveryParameters/RelayParameters//PKMFAddress + +The PKMFAddress leaf contains the address of the ProSe Key Management Function that the UE uses to obtain the group security related contents (see 3GPP TS 33.303 [7]). + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The UE shall use the IP address of the HPLMN ProSe Function if this leaf is not provisioned. + +### 5.2.137 /OneToOneDirectCommunicationPolicy + +The OneToOneDirectCommunicationPolicy node acts as a placeholder for one-to-one ProSe direct communication authorisation policy. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.138 /OneToOneDirectCommunicationPolicy / + +This interior node acts as a placeholder for one or more one-to-one ProSe direct communication authorisation policies. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.2.139 /OneToOneDirectCommunicationPolicy //PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use one-to-one ProSe direct communication. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing one-to-one ProSe direct communication in any PLMN for which no one-to-one ProSe direct communication authorisation policy is available. + +### 5.2.140 /OneToOneDirectCommunicationPolicy //ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this authorisation policy is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +### 5.2.141 /OneToOneDirectCommunicationParameters + +The OneToOneDirectCommunicationParameters node acts as a placeholder for one-to-one ProSe direct communication parameters. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.141A /OneToOneDirectCommunicationParameters /ApplicationLayerGroup + +The ApplicationLayerGroup node acts as a placeholder for application layer group parameters for one-to-one direct communication. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.141B /OneToOneDirectCommunicationParameters /ApplicationLayerGroup/ + +This interior node acts as a placeholder for one or more Application Layer Groups. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.142 /OneToOneDirectCommunicationParameters /ApplicationLayerGroup//Layer2IDForUnicastCommunication + +The Layer2IDForUnicastCommunication leaf indicates the link layer identifier used for one-to-one direct communication. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +## 5.2.142A /OneToOneDirectCommunicationParameters /PC5SignallingPriority + +The PC5SignallingPriority leaf indicates the provisioned ProSe Per-Packet Priority value used for any outgoing PC5 signalling message over a one-to-one direct communication link. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-8 + +## 5.2.143 /OneToOneDirectCommunicationParameters /ApplicationLayerGroup//KMSAddress + +The KMSAddress leaf contains the address of the Key Management Server that the UE uses to obtain the security related contents (see 3GPP TS 33.303 [7]). + +- Occurrence: ZeroOrOne +- Format: chr +- Access Types: Get, Replace +- Values: , . + +The UE shall use the IP address of the HPLMN ProSe Function if this leaf is not provisioned. + +## 5.2.143A /OneToOneDirectCommunicationParameters /ApplicationLayerGroup//ApplicationLayerGroupID + +The ApplicationLayerGroupID leaf indicates the Application Layer Group ID identifying an application layer group that the UE belongs to. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: < Application Layer Group ID> + +## 5.2.144 /DiscoveryPolicyForPS + +The DiscoveryPolicyForPS node acts as a placeholder for ProSe direct discovery authorisation policies for public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.145 /DiscoveryPolicyForPS /ModelAMonitoringPolicy + +The ModelAMonitoringPolicy node acts as a placeholder for ProSe direct discovery model A monitoring authorisation policy for public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.146 /DiscoveryPolicyForPS /ModelAMonitoringPolicy/ + +This interior node acts as a placeholder for one or more ProSe direct discovery model A monitoring authorisation policies for public safety use. + +- Occurrence: OneOrMore + +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.147 /DiscoveryPolicyForPS/ModelAMonitoringPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use ProSe direct discovery model A monitoring for public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing ProSe direct discovery model A monitoring for public safety use in any PLMN for which no monitoring authorisation policy is available. + +## 5.2.148 /DiscoveryPolicyForPS/ModelAMonitoringPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this ProSe direct discovery model A monitoring authorisation policy for public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.149 /DiscoveryPolicyForPS/ModelAAnnouncingPolicy + +The ModelAAnnouncingPolicy node acts as a placeholder for ProSe direct discovery model A announcing authorisation policy for public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.150 /DiscoveryPolicyForPS/ModelAAnnouncingPolicy/ + +This interior node acts as a placeholder for one or more ProSe direct discovery model A announcing authorisation policies for public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace + +- Values: N/A + +## 5.2.151 /DiscoveryPolicyForPS/ModelAAnnouncingPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use ProSe direct discovery model A announcing for public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing ProSe direct discovery model A announcing for public safety use in any PLMN for which no announcing authorisation policy is available. + +## 5.2.152 /DiscoveryPolicyForPS/ModelAAnnouncingPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this ProSe direct discovery model A announcing authorisation policy for public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.152A /DiscoveryPolicyForPS/ModelAAnnouncingPolicy//Range + +The Range leaf indicates the authorised announcing range for ProSe direct discovery model A in the PLMN in which this announcing authorisation policy for public safety use applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.152A.1. + +**Table 5.2.152A.1: Values of Range leaf** + +| Value | Description | +|-------|----------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised announcing range is set to: Short. | +| 2 | The authorised announcing range is set to: Medium. | +| 3 | The authorised announcing range is set to: Long. | +| 4-255 | Reserved | + +## 5.2.153 /DiscoveryPolicyForPS/ModelBDiscovererPolicy + +The ModelBDiscovererPolicy node acts as a placeholder for ProSe direct discovery model B discoverer operation authorisation policy for public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.154 /DiscoveryPolicyForPS/ModelBDiscovererPolicy/ + +This interior node acts as a placeholder for one or more ProSe direct discovery model B discoverer operation authorisation policies for public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.155 /DiscoveryPolicyForPS/ModelBDiscovererPolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use ProSe direct discovery model B discoverer operation for public safety use. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing ProSe direct discovery model B discoverer operation for public safety use in any PLMN for which no discoverer operation authorisation policy is available. + +## 5.2.156 /DiscoveryPolicyForPS/ModelBDiscovererPolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this ProSe direct discovery model B discoverer operation authorisation policy for public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.156A /DiscoveryPolicyForPS/ModelBDiscovererPolicy//Range + +The Range leaf indicates the authorised discoverer operation range for ProSe direct discovery model B in the PLMN in which this discoverer operation authorisation policy for public safety use applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.156A.1. + +**Table 5.2.156A.1: Values of Range leaf** + +| Value | Description | +|-------|--------------------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised discoverer operation range is set to: Short. | +| 2 | The authorised discoverer operation range is set to: Medium. | +| 3 | The authorised discoverer operation range is set to: Long. | +| 4-255 | Reserved | + +## 5.2.157 /DiscoveryPolicyForPS/ModelBDiscovereePolicy + +The ModelBDiscovereePolicy node acts as a placeholder for ProSe direct discovery model B discoveree operation authorisation policy for public safety use. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.158 /DiscoveryPolicyForPS/ModelBDiscovereePolicy/ + +This interior node acts as a placeholder for one or more ProSe direct discovery model B discoveree operation authorisation policies for public safety use. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.2.159 /DiscoveryPolicyForPS/ModelBDiscovereePolicy//PLMN + +The PLMN leaf indicates the PLMN code of the operator in which the UE is authorised to use ProSe direct discovery model B discoveree operation for public safety use. + +- Occurrence: One +- Format: chr + +- Access Types: Get, Replace +- Values: + +The format of the PLMN is defined by 3GPP TS 23.003 [6]. + +NOTE: The UE is prohibited from performing ProSe direct discovery model B discoveree operation in any PLMN for which no discoveree operation authorisation policy for public safety use is available. + +## 5.2.160 /DiscoveryPolicyForPS/ModelBDiscovereePolicy//ValidityTimerT4005 + +The ValidityTimerT4005 leaf indicates in unit of minutes for how long this ProSe direct discovery model B discoveree operation authorisation policy for public safety use is valid. + +- Occurrence: One +- Format: int +- Access Types: Get, Replace +- Values: 1-525600 + +## 5.2.160A /DiscoveryPolicyForPS/ModelBDiscovereePolicy//Range + +The Range leaf indicates the authorised discoveree operation range for ProSe direct discovery model B in the PLMN in which this discoveree operation authorisation policy for public safety use applies. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the Range are specified in table 5.2.160A.1. + +**Table 5.2.160A.1: Values of Range leaf** + +| Value | Description | +|-------|--------------------------------------------------------------| +| 0 | Reserved | +| 1 | The authorised discoveree operation range is set to: Short. | +| 2 | The authorised discoveree operation range is set to: Medium. | +| 3 | The authorised discoveree operation range is set to: Long. | +| 4-255 | Reserved | + +## 5.2.161 /Ext + +The Ext is an interior node for where the vendor specific information about the ProSe Public Safety Direct Services Provisioning MO is being placed (vendor meaning application vendor, device vendor etc.). Usually the vendor extension is identified by vendor specific name under the ext node. The tree structure under the vendor identifier is not defined and can therefore include one or more un-standardized sub-trees. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +## 6 EPC-level ProSe discovery Provisioning MO + +### 6.1 Overview + +The EPC-level ProSe discovery Provisioning MO is used to manage configuration parameters related to the EPC-level ProSe discovery. + +The MO identifier is: urn:oma:mo:ext-3gpp-EPC-level-prose-discovery-provisioning:1.0. + +The UE may initiate the provision of all available information from the DPF, using a client-initiated session Alert message of code "Generic Alert" (see OMA-TS-DM\_Protocol-V1\_2 [5]). When requesting all available information from the DPF, the "Type" element of the OMA DM generic alert message shall be set to "urn:oma:mo:ext-3gpp-EPC-level-prose-discovery-provisioning:1.0:provision", the "LocURI" element (inside the "Source" element) shall be set to the address of the EPC-level ProSe discovery Provisioning MO as specified by OMA-TS-DM\_Protocol-V1\_2 [5] and the "Data" element is not included. + +The OMA DM Access Control List (ACL) property mechanism (see OMA-ERELD-DM-V1\_2 [3]) may be used to grant or deny access rights to OMA DM servers in order to modify nodes and leaf objects of the EPC-level ProSe discovery Provisioning MO. + +The following nodes and leaf objects are possible in the EPC-level ProSe discovery Provisioning MO as described in figure 6.1.1: + +![Diagram of EPC-level ProSe discovery Provisioning MO structure](b996d5a6408db9c4b3ac3aafd2ef44cf_img.jpg) + +``` + +graph LR + X[""] --- ToConRef["ToConRef?"] + X --- Ext["Ext?"] + ToConRef --- Xplus["+"] + Xplus --- ConRef["ConRef"] + +``` + +The diagram shows a hierarchical structure. At the top level is a node labeled . From this node, two branches descend: one to a node labeled ToConRef? and another to a node labeled Ext?. The ToConRef? node is connected to a node labeled +. This + node is then connected to a leaf object labeled ConRef. + +Diagram of EPC-level ProSe discovery Provisioning MO structure + +Figure 6.1.1: EPC-level ProSe discovery Provisioning MO + +## 6.2 EPC-level ProSe discovery Provisioning MO parameters + +### 6.2.1 General + +This clause describes the parameters for the EPC-level ProSe discovery Provisioning MO. + +### 6.2.2 /ToConRef + +The ToConRef interior node is used to allow application to refer to a collection of connectivity definitions. Several connectivity parameters can be listed for a given application under this interior node. + +This interior node contains configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 6.2.3 /ToConRef/ + +This run-time node acts as a placeholder for each reference to connectivity parameters. + +- Occurrence: OneOrMore + +- Format: Node +- Access Types: Get, Replace +- Values: N/A + +## 6.2.4 /ToConRef//ConRef + +The ConRef specifies a specific linkage to connectivity parameters. + +- Occurrence: One +- Format: Chr +- Access Types: Get, Replace +- Values: + +## 6.2.5 /Ext + +The Ext is an interior node for where the vendor specific information about the EPC-level ProSe discovery Provisioning MO is being placed (vendor meaning application vendor, device vendor etc.). Usually the vendor extension is identified by vendor specific name under the ext node. The tree structure under the vendor identifier is not defined and can therefore include one or more un-standardized sub-trees. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +## Annex A (informative): ProSe Direct Services Provisioning MO DDF + +This DDF is the standardized minimal set. A vendor can define its own DDF for the complete device. This DDF can include more features than this minimal standardized version. + +``` + + + + + 1.2 + --The device manufacturer-- + --The device model-- + + + + + + + + ProSe Direct Services Provisioning + + + + + + + The ProSe Direct Services Provisioning Management Object. + + urn:oma:mo:ext-3gpp-prose-direct-provisioning:1.0 + + + + MonitoringPolicy + + + + + + + + + + + + + Monitoring authorisation policies for ProSe Direct Services. + + + + + + + + + + + + + + + + + + + + + + + PLMN + +``` + +``` + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for monitoring policy. + + + + + + + + + + + AnnouncingPolicy + + + + + + + + + + + + + Announcing authorisation policies for ProSe Direct Services. + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for announcing policy. + + + + + + + + Range + + + + + + + + + + + + Authorised range for announcing. + + + + + + + + + + + ToConRef + + + + + + + + + + + + collection of connectivity definitions + + +``` + +``` + + + + + + + + + + + + + + + + + + + The name node for one or more connectivity parameters + + + + + + ConRef + + + + + + + + + + + + Linkage to connectivity parameters + + text/plain + + + + + + + + RestrictedModelAMonitoringPolicy + + + + + + + + + + + + + Restricted model A monitoring authorisation policies for ProSe Direct +Services. + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model A monitoring +policy. + + + + + + + + + + + RestrictedModelAAnnouncingPolicy + + + + + + + + + + + + + Restricted model A announcing authorisation policies for ProSe Direct +Services. + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model A announcing +policy. + + + + + + + + Range + + + + + + + + + + + + Authorised range for restricted model A announcing. + + + + + + + + + + + RestrictedModelBDiscovererPolicy + + + +``` + +``` + + + + + + + + + + + + Restricted model B discoverer operation authorisation policies for ProSe +Direct Services. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model B discoverer operation +policy. + + + + + + + + Range + +``` + +``` + + + + + + + + + + + + + Authorised range for restricted model B discoverer +operation. + + + + + + + + + + + RestrictedModelBDiscovereePolicy + + + + + + + + + + + + + Restricted model B discoveree operation authorisation policies for ProSe +Direct Services. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + + +``` + +``` + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model B discoveree operation +policy. + + + + + + + + Range + + + + + + + + + + + + Authorised range for restricted model B discoveree +operation. + + + + + + + + + + + ProSeDiscoveryUEIDInfo + + + + + + + + + + + + + Value and validity timer for ProSe Discovery UE ID. + + + + + + + ProSeDiscoveryUEID + + + + + + + + + +``` + +``` + + + +ProSe Discovery UE ID. + + + + + + + + + ValidityTimerT4015 + + + + + + + + + + + + Validity Timer T4015 for ProSe Discovery UE ID. + + + + + + + + + + WLANDirectDiscoveryPLMNList + + + + + + + + + + + + + List of PLMNs for WLAN based ProSe Direct Discovery. + + /> + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + +``` + +----- + +----- + +``` + + PLMN code + + + + + + + + PLMN code. + + text/plain + + + + + + + + + Ext + + + + + + + + + + + A collection of all extension objects. + + + + + + + + +``` + +## Annex B (informative): ProSe Public Safety Direct Services Provisioning MO DDF + +This DDF is the standardized minimal set. A vendor can define its own DDF for the complete device. This DDF can include more features than this minimal standardized version. + +``` + + + + + 1.2 + --The device manufacturer-- + --The device model-- + + + + + + + + ProSe Public Safety Direct Services Provisioning + + + + + + + The ProSe Public Safety Direct Services Provisioning Management +Object. + + urn:oma:mo:ext-3gpp-prose-public-safety-direct-provisioning:1.0 + + + + + MonitoringPolicy + + + + + + + + + + + + + Monitoring authorisation policies for ProSe Public Safety Direct +Services. + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` +PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for monitoring policy. + + + + + + + + + + + AnnouncingPolicy + + + + + + + + + + + + + Announcing authorisation policies for ProSe Public Safety Direct +Services. + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for announcing policy. + + + + + + + + Range + + + + + + + + + + + + Authorised range for announcing. + + + + + + + + + + + DirectCommunicationPolicy + + + + + + + + + + + +``` + +``` + + + + + + Direct communication policies for ProSe Public Safety Direct +Services. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for direct communication policy. + + + + + + + + + + + DirectCommunicationPolicyNotInEUTRAN + + + + +``` + +``` + + + + + + + + + + + DirectCommunication policy when the UE is not in E-UTRAN policies direct +communication of ProSe Public Safety Direct Services. + + + + + + + DirectCommunicationAuthorisationNotInEUTRAN + + + + + + + + + + + + Authorisation for direct communication when not in E-UTRAN. + + + + + + + + OneToOneDirectCommunicationAuthorisationNotInEUTRAN + + + + + + + + + + + + Authorisation for one-to-one direct communication when not in E- +UTRAN. + + + + + + + + DirectCommunicationRadioParameters + + + + + + + + + + + + Radio parameters for direct communication when not in E- +UTRAN. + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + RadioParametersContents + + + + + + + + + + + + Radio parameters defined by RAN WG. + + text/plain + + + + + + GeographicalArea + + + + + + + + + + + + Geographical Area. + + text/plain + + + + + Polygon + + + + + + + + + + + + Polygon Area description. + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + Coordinates + + + + + + + + + + + + Descriptions for geographical coordinates + + text/plain + + + + + + + + + + + + + + + + + + + + + + + Latitude + + + + + + + + + + + + coordinate latitude + + text/plain + + + + + + Longitude + + + + + + +``` + +``` + + + + + + + + + + coordinate longitude + + text/plain + + + + + + + + + + + + + GroupParameters + + + + + + + + + + + + + Group parameters for ProSe Public Safety Direct Services. + + + + + + + + + + + + + + + + + + + + + + + + + AddressType + + + + + + + + + + + + IP version of the IP address. + + text/plain + + + +``` + +``` + + + + + IPMulticastAddress + + + + + + + + + + + + IP multicast address. + + + + + + + + PKMFAAddress + + + + + + + + + + + + Address of the ProSe Key Management Function. + + + + + + + + SourceIPv4Address + + + + + + + + + + + + Source IPv4 address. + + + + + + + + Layer2GroupID + + + + + + + + + + + + The Layer 2 group ID. +``` + +``` + + + + + + + + + ApplicationLayerGroupID + + + + + + + + + + + + application layer group ID. + + + + + + + + + + + UsageInformationReportingConfiguration + + + + + + + + + + + + + Usage information reporting configuration for ProSe Public Safety Direct +Services. + + + + + + + ServerAddress + + + + + + + + + + + + Server address for reporting charging data. + + + + + + + + CollectionPeriod + + + + + + + + +``` + +``` + + + + + + + + + Collection period. + + + + + + + + ReportingWindow + + + + + + + + + + + + Reporting window. + + + + + + + + ReportGroupParameters + + + + + + + + + + + + Whether to report group parameters. + + + + + + + + ReportTimeStampsFirstTransmissionAndReception + + + + + + + + + + + + Whether to report time stamps for first transmission and +reception. + + + + + + + + ReportDataTransmitted + + +``` + +``` + + + + + + + + + + +Whether to report data transmitted. + + + + + + + + ReportDataReceived + + + + + + + + + + + + Whether to report data received. + + + + + + + + ReportTimeStampsOutOfCoverage + + + + + + + + + + + + Whether to report time stamps when out of E-UTRAN coverage. + + + + + + + + ReportLocationInCoverage + + + + + + + + + + + + Whether to report list of locations when in E-UTRAN coverage. + + + + + + + +``` + +``` + +ReportRadioParameters + + + + + + + + + + + + Whether to report radio parameters used for ProSe direct +communication. + + + + + + + + + ToConRef + + + + + + + + + + + + collection of connectivity definitions + + + + + + + + + + + + + + + + + + The name node for one or more connectivity parameters + + + + + + ConRef + + + + + + + + + + + + Linkage to connectivity parameters + + text/plain + + + + + + +``` + +``` + + + RestrictedDiscoveryPolicyForNonPS + + + + + + + + + + + + + Authorisation policies for restricted direct discovery for non-public +safety use. + + + + + + + RestrictedModelAMonitoringPolicy + + + + + + + + + + + + + Restricted model A monitoring authorisation policies for ProSe Direct +Services. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + +``` + +``` + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model A monitoring +policy. + + + + + + + + + + + RestrictedModelAAnnouncingPolicy + + + + + + + + + + + + + Restricted model A announcing authorisation policies for ProSe Direct +Services. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + + + + + + +``` + +``` + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model A announcing +policy. + + + + + + + + Range + + + + + + + + + + + + Authorised range for restricted model A announcing. + + + + + + + + + + + RestrictedModelBDiscovererPolicy + + + + + + + + + + + + + Restricted model B discoverer operation authorisation policies for +ProSe Direct Services. + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model B discoverer +operation policy. + + + + + + + + Range + + + + + + + + + + + + Authorised range for restricted model B discoverer +operation. + + + + + + + + +``` + +``` + + RestrictedModelBDiscovereePolicy + + + + + + + + + + + + + Restricted model B discoveree operation authorisation policies for +ProSe Direct Services. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for restricted model B discoveree +operation policy. + + + + + + +``` + +``` + + + + Range + + + + + + + + + + + + Authorised range for restricted model B discoveree +operation. + + + + + + + + + + + ProSeDiscoveryUEIDInfo + + + + + + + + + + + + + Value and validity timer for ProSe Discovery UE ID. + + + + + + + ProSeDiscoveryUEID + + + + + + + + + + + + ProSe Discovery UE ID. + + + + + + + + ValidityTimerT4015 + + + + + + + + + +``` + +``` + + +Validity Timer T4015 for ProSe Discovery UE ID. + + + + + + + + + + + + PublicSafetyDiscoveryPolicyNotInEUTRAN + + + + + + + + + + + + + Direct Discovery policy when the UE is not in E-UTRAN. + + + + + + + MonitoringAuthorisationNotInEUTRAN + + + + + + + + + + + + Authorisation for monitoring when not in E-UTRAN. + + + + + + + + AnnouncingAuthorisationNotInEUTRAN + + + + + + + + + + + + Authorisation for announcing when not in E-UTRAN. + + + + + + + + DiscovereeAuthorisationNotInEUTRAN + +``` + +``` + + + + + + + + + + + + Authorisation for discoveree operation when not in E-UTRAN. + + + + + + + + DiscovererAuthorisationNotInEUTRAN + + + + + + + + + + + + Authorisation for discoverer operation when not in E-UTRAN. + + + + + + + + DiscoveryRadioParameters + + + + + + + + + + + + Radio parameters for direct discovery when not in E-UTRAN. + + + + + + + + + + + + + + + + + + + + + + + + + RadioParametersContents + + + +``` + +``` + + + + + + + + + +Radio parameters defined by RAN WG. + +text/plain + + + + + + GeographicalArea + + + + + + + + + + + + Geographical Area. + + text/plain + + + + + Polygon + + + + + + + + + + + + Polygon Area description. + + + + + + + + + + + + + + + + + + + + + + + + + Coordinates + + + + + + + + + + +``` + +``` + + + + + + + + + Descriptions for geographical coordinates + + text/plain + + + + + + + + + + + + + + + + + + + + + + + Latitude + + + + + + + + + + + + coordinate latitude + + text/plain + + + + + + Longitude + + + + + + + + + + + + coordinate longitude + + text/plain + + + + + + + + + + + +``` + +``` + + UETOtoNetworkRelayPolicy + + + + + + + + + + + + + UE-to-network relay policy. + + + + + + + AuthorisationForRemoteUE + + + + + + + + + + + + + UE-to-network relay authorisation policy for remote UE. + + + + + + + + + AuthorisationForRelay + + + + + + + + + + + + + UE-to-network relay authorisation policy for relay. + + + + + + AuthorisedPLMNs + + + + + + + + + + + + + + + + +``` + +``` +UE-to-network relay authorisation per PLMN policies. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + RemoteUEIMEIReport + + + + + + + + + + + + Whether to report the IMEI or IMEISV of the remote UE(s) +using the relay. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + + +``` + +``` +policy. + Validity Timer T4005 for relay authorisation + + + + + + + + + + DLUnicastTrafficMappingRule + + + + + + + + + + + + Mapping rule for downlink unicast traffic. + + + + + + + + + + + + + + + + + + + + + + + + + QCI + + + + + + + + + + + + QCI value used in the mapping rule + + + + + + + + ProSePerPacketPriority + + + + + + + + + +``` + +----- + +----- + +``` + + + + PPPP value used in the mapping rule + + + + + + + + + + + + + PublicSafetyDiscoveryParameters + + + + + + + + + + + + + Parameters for direct discovery for public safety use. + + + + + + + GroupMemberDiscoveryParameters + + + + + + + + + + + + + Group member discovery parameters. + + + + + + + UserInfoID + + + + + + + + + + + + User Info ID for group member discovery. + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + DiscoveryGroupID + + + + + + + + + + + + Discovery Group ID. + + + + + + + ApplicationLayerGroupID + + + + + + + + + + + + ApplicationLayer Group ID. + + + + + + + PKMFAddress + + + + + + + + + + + + Address of the ProSe Key Management Function. + + + + + + + + + + RelayDiscoveryParameters + + + + +``` + +``` + + + + + + + + + + + UE-to-network relay discovery parameters. + + + + + + + UserInfoID + + + + + + + + + + + + User Info ID for group member discovery. + + + + + + + + RemoteUEParameters + + + + + + + + + + + + Remote UE parameters. + + + + + + + + + + + + + + + + + + + + + + + + + RelayServiceCode + + + + + +``` + +``` + + + + + + + + Relay Service Code for the connectivity service sought by +the remote UE. + + + + + + + + UserInfoIDOfRelay + + + + + + + + + + + + User Info ID of relay sought by the remote UE. + + + + + + + + IPVersions + + + + + + + + + + + + IP version(s) for the connectivity service associated with +this Relay Service Code. + + + + + + + + PKMFAddress + + + + + + + + + + + + Address of the ProSe Key Management Function. + + + + + + + +``` + +``` + + + + RelayParameters + + + + + + + + + + + + Relay parameters. + + + + + + + + + + + + + + + + + + + + + + + + + RelayServiceCode + + + + + + + + + + + + Relay Service Code for the connectivity service provided by +the relay UE. + + + + + + + + PDNType + + + + + + + + + + + + PDN Type for connectivity service provided by relay +UE. + + + + + + +``` + +``` + + + + + + + APN + + + + + + + + + + + + APN to be used by relay UE for this connectivity +service. + + + + + + + + ProSeRelayUEID + + + + + + + + + + + + ProSe Relay UE ID for this connectivity service. + + + + + + + + PKMFAddress + + + + + + + + + + + + Address of the ProSe Key Management Function. + + + + + + + + + + + + + + + OneToOneDirectCommunicationPolicy + + + + +``` + +``` + + + + + + + + + + + One-to-one direct communication policies for public safety use. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for direct communication policy. + + + + + + + + + + + +``` + +``` +OneToOneDirectCommunicationParameters + + + + + + + + + + + + + Parameters for one-to-one direct communication. + + + + + + + PC5SignallingPriority + + + + + + + + + + + + ProSe Per-Packet Priority for PC5 signalling messages. + + + + + + + + ApplicationLayerGroup + + + + + + + + + + + + + ApplicationLayerGroup unicast communication configurations + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + Layer2IDForUnicastCommunication + + + + + + + + + + + + Layer 2 ID for unicast communication. + + + + + + + + KMSAddress + + + + + + + + + + + + Address of the Key Management Server. + + + + + + + + ApplicationLayerGroupID + + + + + + + + + + + + Application Layer Group ID for one-to-one direct +communication. + + + + + + + + + + + + + DiscoveryPolicyForPS + + + + + + + + + + +``` + +``` + + + +Authorisation policies for direct discovery for public safety +use. + + + + + + + ModelAMonitoringPolicy + + + + + + + + + + + + + Model A monitoring authorisation policies for ProSe direct discovery +for public safety use. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + +``` + +``` + + + + + + Validity Timer T4005 for model A monitoring policy for public +safety use. + + + + + + + + + + + ModelAAnnouncingPolicy + + + + + + + + + + + + + Model A announcing authorisation policies for ProSe direct discovery +for public safety use. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + +``` + +``` + + + + + + + + + +Validity Timer T4005 for model A announcing policy for public +safety use. + + + + + + + +Range + + + + + + + + + + + +Authorised range for model A announcing for public safety +use. + + + + + + + + + + +ModelBDiscovererPolicy + + + + + + + + + + + + + Model B discoverer operation authorisation policies for ProSe direct +discovery for public safety use. + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for model B discoverer operation policy +for public safety use. + + + + + + + + Range + + + + + + + + + + + + Authorised range for model B discoverer operation for public +safety use. + + + + + + + + + + + ModelBDiscovereePolicy + + + + + + + + + + + +``` + +``` + + + + Model B discoveree operation authorisation policies for ProSe direct +discovery for public safety use. + + + + + + + + + + + + + + + + + + + + + + + + + PLMN + + + + + + + + + + + + PLMN code. + + text/plain + + + + + + ValidityTimerT4005 + + + + + + + + + + + + Validity Timer T4005 for model B discoveree operation policy +for public safety use. + + + + + + + + Range + + + + + + + + + + +``` + +``` + + + + + + Authorised range for model B discoveree operation for public +safety use. + + + + + + + + + + + + + Ext + + + + + + + + + + + A collection of all extension objects. + + + + + + + + +``` + +## Annex C (informative): EPC-level ProSe discovery Provisioning MO DDF + +This DDF is the standardized minimal set. A vendor can define its own DDF for the complete device. This DDF can include more features than this minimal standardized version. + +``` + + + + + 1.2 + --The device manufacturer-- + --The device model-- + + + + + + + + EPC-level ProSe discovery Provisioning + + + + + + + EPC-level ProSe discovery Provisioning MO. + + urn:oma:mo:ext-3gpp-EPC-level-prose-discovery-provisioning:1.0 + + + + + ToConRef + + + + + + + + + + + + collection of connectivity definitions + + + + + + + + + + + + + + + + + + The name node for one or more connectivity parameters + + + + + + ConRef + + +``` + +``` + + + + + + + + + +Linkage to connectivity parameters + + text/plain + + + + + + + + Ext + + + + + + + + + + + A collection of all extension objects. + + + + + + + + +``` + +## Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|------------|-----------|------|-----|----------------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-03 | | | | | TS skeleton generated for submission at CT1#86bis | - | 0.0.0 | +| 2014-04 | CT1#86bis | | | | Implementation of C1-141571 and C1-141572. Editorial and formatting fixes. | 0.0.0 | 0.1.0 | +| 2014-05 | CT1#87 | | | | Implementation of C1-142200 | 0.1.0 | 0.2.0 | +| 2014-06 | CT-64 | CP-140278 | | | Version 1.0.0 submitted to CT-64 for information | 0.2.0 | 1.0.0 | +| 2014-07 | CT1#88 | | | | Implementation of C1-142855, C1-143024, C1-143244, C1-143252 and C1-143318. Fix for Annex B DDF compilation error. | 1.0.0 | 1.1.0 | +| 2014-09 | CT-65 | CP-140629 | | | Version 2.0.0 submitted to CT-65 for approval | 1.1.0 | 2.0.0 | +| 2014-09 | CT-65 | CP-140716 | | | Plenary tdoc revised to include missing cover sheet | 1.1.0 | 2.0.0 | +| 2014-09 | Post CT-65 | | | | Version 12.0.0 created after approval | 2.0.0 | 12.0.0 | +| 2014-12 | CT-66 | CP-140847 | 0001 | 1 | Announcing range parameter | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0002 | 3 | Update of provisioning parameters for charging reporting configuration in ProSe Public Safety Direct Services Provisioning MO | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0003 | 1 | Update of provisioning parameters for direct communication security in ProSe Public Safety Direct Services Provisioning MO | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0004 | | Update of range for validity timer T4005 in ProSe MOs | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0005 | | Prose Service authorisation for MO | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0007 | | Update of MOs related to radio parameters provisioned for ProSe | 12.0.0 | 12.1.0 | +| 2015-03 | CT-67 | CP-150071 | 0006 | 3 | Parameters of PDN connection to be used to reach HPLMN ProSe Function | 12.1.0 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0013 | 2 | Correction on conditions for activating ProSe direct discovery features | 12.1.0 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0014 | | Removal of Editor's notes on MO identifiers in TS 24.333 | 12.1.0 | 12.2.0 | +| 2015-03 | CT-67 | CP-150178 | 0015 | 2 | Update of RadioParameterContents leaves in ProSe MOs | 12.1.0 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0016 | 3 | Update of provisioning parameters for usage information reporting configuration in ProSe Public Safety Direct Services Provisioning MO | 12.1.0 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0017 | | Scope clarification for ProSe direct discovery in TS 24.333 – alternative 1 | 12.1.0 | 12.2.0 | +| 2015-06 | CT-68 | CP-150316 | 0019 | 1 | Correcting titles of configuration parameters carrying NAP object | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0020 | | GeographicalArea in DirectCommunicationRadioParameters | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0022 | 1 | Correction of ToConRef leaf in ProSe MO | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0024 | | Correction of 'Not served by E-UTRAN' | 12.2.0 | 12.3.0 | +| 2015-09 | CT-69 | CP-150528 | 0025 | 1 | Update of ProSe MOs for restricted ProSe direct discovery | 12.3.0 | 13.0.0 | +| 2015-12 | CT-70 | CP-150708 | 0026 | | Correction of ProSe Discovery UE ID provisioning and Wrong Reference | 13.0.0 | 13.1.0 | +| 2015-12 | CT-70 | CP-150708 | 0028 | 5 | Provisiong ProSe parameters for public safety use | 13.0.0 | 13.1.0 | +| 2015-12 | CT-70 | CP-150708 | 0029 | 1 | Scope Clarification of ProSe Direct discovery when not served by E-UTRAN | 13.0.0 | 13.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|----------------------------------------------------------------------------------|--------|--------| +| 2015-12 | CT-70 | CP-150692 | 0031 | | Provisioning MO for ProSe Public Safety Dierct Services | 13.0.0 | 13.1.0 | +| 2016-03 | CT-71 | CP-160157 | 0033 | 1 | ProSe MO update for provisioning ProSe Per-Packet Priority | 13.1.0 | 13.2.0 | +| 2016-03 | CT-71 | CP-160157 | 0034 | 1 | ProSe MO update for provisioning ProSe Per-Packet Priority and QCI mapping rules | 13.1.0 | 13.2.0 | +| 2016-03 | CT-71 | CP-160157 | 0035 | | Addition of provisioning parameter for security of relay discovery | 13.1.0 | 13.2.0 | +| 2016-03 | CT-71 | CP-160157 | 0036 | | Removal of Editor's notes on the format of the ProSe Discovery UE ID | 13.1.0 | 13.2.0 | +| 2016-03 | CT-71 | CP-160157 | 0032 | 5 | Application Layer Group ID and security parameters for MO | 13.1.0 | 13.2.0 | +| 2016-06 | CT-72 | CP-160311 | 0038 | 2 | Rename on the term 'Restricted Discovery Policy for PS' | 13.2.0 | 13.3.0 | +| 2016-06 | CT-72 | CP-160311 | 0040 | | Clean up of TS 24.333 | 13.2.0 | 13.3.0 | +| 2016-06 | CT-72 | CP-160311 | 0041 | | Removing Per-PLMN Service Authorization for Remote UEs | 13.2.0 | 13.3.0 | +| 2016-06 | CT-72 | CP-160311 | 0042 | | Adding IMEI reporting configuration for the relay policy in Public Safety MO | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160493 | 0043 | | F | Missing table for range values in public safety model B discoverer policy | 13.4.0 | +| 2017-03 | CT#75 | CP-170119 | 0045 | 1 | F | Correction of LocURI value | 13.5.0 | +| 2017-03 | CT#75 | CP-170108 | 0047 | | A | Removal of Editor's note on MO identifier | 13.5.0 | +| 2017-03 | CT#75 | CP-170119 | 0048 | | F | Correction of LocURI value for EPC-level ProSe discovery Provisioning MO | 13.5.0 | +| 2017-03 | SA#75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-12 | CT#78 | CP-173076 | 0049 | 2 | F | Update to DDF for ProSe Direct Services Provisioning MO for WLAN Direct Discovery | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0050 | 1 | F | Corrections to Annex B | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0051 | | F | Correction of Annex C | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0052 | | F | Correction of name for AuthorisedPLMNs | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0053 | 1 | F | Correction of DiscoveryRadioParameters and objects within | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0054 | | F | Clause 5, Figure 5.1.7 Object names, number of occurrences, and structure corrections | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0055 | 1 | F | Correction of DirectCommunicationPolicyNotInEUTRAN and objects within | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0056 | | F | Correction of values for SourceIPv4address | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0057 | 1 | F | Correction of structure for /OneToOneDirectCommunicationParameters | 15.0.0 | +| 2017-12 | CT#78 | CP-173079 | 0058 | | F | Correction of missing Values for node objects | 15.0.0 | +| 2017-12 | CT#78 | CP-173076 | 0060 | 2 | B | Update to ProSe Direct Services Provisioning MO for WLAN Direct Discovery | 15.0.0 | +| 2018-03 | CT#79 | CP-180065 | 0063 | | A | Clarification on the number of coordinates in a geographical area | 15.1.0 | +| 2018-09 | CT#81 | CP-182115 | 0066 | | A | Change of "RestrictedDiscoveryPolicyforPS" to DiscoveryPolicyforPS" | 15.2.0 | +| 2019-09 | CT#85 | CP-192071 | 0070 | 1 | F | Correcting undefined datatype: network access point object | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24334/09cef6267096187ea2ec3fa61909d695_img.jpg b/marked/Rel-16/24_series/24334/09cef6267096187ea2ec3fa61909d695_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..756d92aa7b655a5f42d8eb942d7a378b37cbe669 --- /dev/null +++ b/marked/Rel-16/24_series/24334/09cef6267096187ea2ec3fa61909d695_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:349e91776ac6a355a54c017ead319ef4a45823405939a57d08060d2b2dea44f1 +size 12524 diff --git a/marked/Rel-16/24_series/24334/0a73b03fba21af142d619a9a662e6490_img.jpg b/marked/Rel-16/24_series/24334/0a73b03fba21af142d619a9a662e6490_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d76f321264dafd0dc997224f297fd1aa1c01e5a --- /dev/null +++ b/marked/Rel-16/24_series/24334/0a73b03fba21af142d619a9a662e6490_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1f6ef8a2fdb2b9ad791f75691c98bdc0535d23a6c7d1ac9172f699750b81229 +size 16629 diff --git a/marked/Rel-16/24_series/24334/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg b/marked/Rel-16/24_series/24334/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c410490a5db283191e50deeea4c487e2df1ea2d --- /dev/null +++ b/marked/Rel-16/24_series/24334/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d4ba4e67d4d4392437dba1fba19d90e7060d2c669c724d916a69b7b69003e1db +size 8574 diff --git a/marked/Rel-16/24_series/24334/0f26e70157bd4c45f825795cdcd20fbd_img.jpg b/marked/Rel-16/24_series/24334/0f26e70157bd4c45f825795cdcd20fbd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d23bf4e2ce2469fb521051bf3d861fd20ae1e8cd --- /dev/null +++ b/marked/Rel-16/24_series/24334/0f26e70157bd4c45f825795cdcd20fbd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66e8d37ab9db6059e9a416caf0646c656f223411a6eaca10beaf95a76485bf5d +size 23097 diff --git a/marked/Rel-16/24_series/24334/1520ac6ca40d678c53dca4ef6550963f_img.jpg b/marked/Rel-16/24_series/24334/1520ac6ca40d678c53dca4ef6550963f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88ab798796d83b538347305fdc8e711ebe55378c --- /dev/null +++ b/marked/Rel-16/24_series/24334/1520ac6ca40d678c53dca4ef6550963f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e00ef09d5f6136c5d598e5019b677af811d0613cd4c8b0d36bc54610921aef31 +size 26429 diff --git a/marked/Rel-16/24_series/24334/16ddca00f500e7eef04e1f43a1e9497a_img.jpg b/marked/Rel-16/24_series/24334/16ddca00f500e7eef04e1f43a1e9497a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7222a9d15fb9865c40487168b304c6676c30808 --- /dev/null +++ b/marked/Rel-16/24_series/24334/16ddca00f500e7eef04e1f43a1e9497a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:edde750be6fa1a93deb9aaa3d075e750db488d6ad7023f9d67ffad47729653a9 +size 12217 diff --git a/marked/Rel-16/24_series/24334/1dd28a53f60be2a30f094e8f112e85d7_img.jpg b/marked/Rel-16/24_series/24334/1dd28a53f60be2a30f094e8f112e85d7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c0c89a51fcefb7d7bd0fa266120e193ce19adfa --- /dev/null +++ b/marked/Rel-16/24_series/24334/1dd28a53f60be2a30f094e8f112e85d7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:409bb35183645cb137f3a4286ef7d05427f8883d366e3930832968b0103af087 +size 8265 diff --git a/marked/Rel-16/24_series/24334/22a1092afae18f2567536ff8b0bbcdd5_img.jpg b/marked/Rel-16/24_series/24334/22a1092afae18f2567536ff8b0bbcdd5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61f618f1ab52ca8c28f7b14279e1aed02b6e0357 --- /dev/null +++ b/marked/Rel-16/24_series/24334/22a1092afae18f2567536ff8b0bbcdd5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa8a65ad3d6023e9dda6b8fd2b331f7a6f272f58128df1e06b87327604f351e2 +size 31458 diff --git a/marked/Rel-16/24_series/24334/25560b45ff748b9fc5d85aa004d18aa2_img.jpg b/marked/Rel-16/24_series/24334/25560b45ff748b9fc5d85aa004d18aa2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..21e3a9f44b0ae2786429da7bf72b5f9a339a4582 --- /dev/null +++ b/marked/Rel-16/24_series/24334/25560b45ff748b9fc5d85aa004d18aa2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30a440682848e9c4e9d55d5004649ae7b76c218de6995ac672593524ef0746e7 +size 23584 diff --git a/marked/Rel-16/24_series/24334/26d37a5ec149b21b1520a5bb18422208_img.jpg b/marked/Rel-16/24_series/24334/26d37a5ec149b21b1520a5bb18422208_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d3bd28ab48d2d04edb75f1279f251a8a0570c1aa --- /dev/null +++ b/marked/Rel-16/24_series/24334/26d37a5ec149b21b1520a5bb18422208_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3d2327b44708ec4e135698fa831249b590b56f88b222df49efe7d22d81a19eb +size 13152 diff --git a/marked/Rel-16/24_series/24334/2837ffdadcdb1e5bababa56b564e56ed_img.jpg b/marked/Rel-16/24_series/24334/2837ffdadcdb1e5bababa56b564e56ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dcb22cf53eac2837b06605338eeee7de54ab652a --- /dev/null +++ b/marked/Rel-16/24_series/24334/2837ffdadcdb1e5bababa56b564e56ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc236444701ac7a6e76bc1481dc519e8236847813b68fc00c1fc5472148c7ce4 +size 15198 diff --git a/marked/Rel-16/24_series/24334/2a476a0b3dbc3429436246db4784ff9f_img.jpg b/marked/Rel-16/24_series/24334/2a476a0b3dbc3429436246db4784ff9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..85713108556581c0f68d95d02dd9d3801abe4c5e --- /dev/null +++ b/marked/Rel-16/24_series/24334/2a476a0b3dbc3429436246db4784ff9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48c39d464b887b935606554cdff83eb14ace2e4137afb430fd29dbb872b5fd4e +size 22093 diff --git a/marked/Rel-16/24_series/24334/2e8dcf3d807269a64340a9c292ea7f5d_img.jpg b/marked/Rel-16/24_series/24334/2e8dcf3d807269a64340a9c292ea7f5d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..80503585dbbe029cf4eb115d756829885966e14a --- /dev/null +++ b/marked/Rel-16/24_series/24334/2e8dcf3d807269a64340a9c292ea7f5d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:536fb1c6bc7950f08c8249d8abbb53c892332602613255b3bf7569395f97c30d +size 8058 diff --git a/marked/Rel-16/24_series/24334/317e0525ef1b2458976c246876f4a948_img.jpg b/marked/Rel-16/24_series/24334/317e0525ef1b2458976c246876f4a948_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfcc03681fad11605a2ae239420aa3f4db021aef --- /dev/null +++ b/marked/Rel-16/24_series/24334/317e0525ef1b2458976c246876f4a948_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2668fc71ba97f6dd226b9e3a7240ea6e98a94e8c51f4d64057b3542822d81f14 +size 3819 diff --git a/marked/Rel-16/24_series/24334/31f5b6310f831ca3ea4f18453980c070_img.jpg b/marked/Rel-16/24_series/24334/31f5b6310f831ca3ea4f18453980c070_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4ff45d9a336be10c6d859c3da056b57ce35d6e8a --- /dev/null +++ b/marked/Rel-16/24_series/24334/31f5b6310f831ca3ea4f18453980c070_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bac2c087cf5117afbac86282f84dd254d754a1c93fb31d2502f138b04082485d +size 13175 diff --git a/marked/Rel-16/24_series/24334/36e029cd5d353a7e9c2f28c3aa199066_img.jpg b/marked/Rel-16/24_series/24334/36e029cd5d353a7e9c2f28c3aa199066_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..85377b6f2124817a766a967c970fdd5290e99fee --- /dev/null +++ b/marked/Rel-16/24_series/24334/36e029cd5d353a7e9c2f28c3aa199066_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b1673e1cf1d7d2384d4f5b52870d4569ae08ac0c9ad74455173e1572ffcfcc0 +size 14029 diff --git a/marked/Rel-16/24_series/24334/3e8e3bdb3d90f0856266d4eaf36abba1_img.jpg b/marked/Rel-16/24_series/24334/3e8e3bdb3d90f0856266d4eaf36abba1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ceba45043c19519ca7f8696f35aadfaeffb31ebc --- /dev/null +++ b/marked/Rel-16/24_series/24334/3e8e3bdb3d90f0856266d4eaf36abba1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c84c96b3ffb544bb324041eeb0b834febfcd3ae8235a61d594a8c64ca66bab0 +size 15259 diff --git a/marked/Rel-16/24_series/24334/47d4bb75bab808b473a9208ea8b0bf61_img.jpg b/marked/Rel-16/24_series/24334/47d4bb75bab808b473a9208ea8b0bf61_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fe3b7e9dcec40894806c035e88facf2151330846 --- /dev/null +++ b/marked/Rel-16/24_series/24334/47d4bb75bab808b473a9208ea8b0bf61_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a09895ed4dbca75a69f2acf305862dfe5f2e24311a1100b6898b54e0606651c4 +size 19370 diff --git a/marked/Rel-16/24_series/24334/4aeaa51a3999fab21171224e238cb571_img.jpg b/marked/Rel-16/24_series/24334/4aeaa51a3999fab21171224e238cb571_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..348c7c68c29cb5edaa0b9b4639ab9fad44960a62 --- /dev/null +++ b/marked/Rel-16/24_series/24334/4aeaa51a3999fab21171224e238cb571_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7a0891723ffe0967b285f2bbe401fcd4e756c16afda7f1b9951ec32ee7f903e +size 24253 diff --git a/marked/Rel-16/24_series/24334/4aeafa83d297a9b124c73904c5a49437_img.jpg b/marked/Rel-16/24_series/24334/4aeafa83d297a9b124c73904c5a49437_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b691b369b8d850ceb6d5cb1139786907cee6e557 --- /dev/null +++ b/marked/Rel-16/24_series/24334/4aeafa83d297a9b124c73904c5a49437_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:756730e337b20e142da0f8ff7899b1ac292bd476b3a50f95cf4fd5f3895ab586 +size 12295 diff --git a/marked/Rel-16/24_series/24334/5492fadb32a8df1ee9f2528a053c9862_img.jpg b/marked/Rel-16/24_series/24334/5492fadb32a8df1ee9f2528a053c9862_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc73a266de5b741682a92f8fc3fc674e29ec4030 --- /dev/null +++ b/marked/Rel-16/24_series/24334/5492fadb32a8df1ee9f2528a053c9862_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa676ff252ab59ac3d4ac4254e8218b1436810a8394fdb1308eef31997c591b1 +size 7601 diff --git a/marked/Rel-16/24_series/24334/5635bd67a8ba929382fd61dede8952c7_img.jpg b/marked/Rel-16/24_series/24334/5635bd67a8ba929382fd61dede8952c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1236bc8fc34367529eab8aa15703e94c03ae7457 --- /dev/null +++ b/marked/Rel-16/24_series/24334/5635bd67a8ba929382fd61dede8952c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98bbaa98b55837bfe3a75300152210cd822d1c435b09592cceb9a45d59c9b2fe +size 14676 diff --git a/marked/Rel-16/24_series/24334/5801c19431e76330430e92a598cc7a16_img.jpg b/marked/Rel-16/24_series/24334/5801c19431e76330430e92a598cc7a16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32d5c75295358929e0da144b5b3de05ed2171734 --- /dev/null +++ b/marked/Rel-16/24_series/24334/5801c19431e76330430e92a598cc7a16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11255326f2ed9af05e9c06a8b087ef22a5faa03589d0f1ae2931184677467130 +size 20928 diff --git a/marked/Rel-16/24_series/24334/58584484e1b78db31cf28c342cb7ac74_img.jpg b/marked/Rel-16/24_series/24334/58584484e1b78db31cf28c342cb7ac74_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61c3354af994e143dbbe6459b30120562621dac2 --- /dev/null +++ b/marked/Rel-16/24_series/24334/58584484e1b78db31cf28c342cb7ac74_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e96ef545ebb4887931fe6b0f2cf47a5743505fdb07c4c2a8973a2f453c662335 +size 6919 diff --git a/marked/Rel-16/24_series/24334/5b5df621a344a773d1ec32e11f3f610f_img.jpg b/marked/Rel-16/24_series/24334/5b5df621a344a773d1ec32e11f3f610f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..04292484311a54961e3497e776148dfb0972e91b --- /dev/null +++ b/marked/Rel-16/24_series/24334/5b5df621a344a773d1ec32e11f3f610f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7356206ea5c717a58a2d107e9677d03831acd34b6446c1f0dcfc532c74f60d94 +size 26949 diff --git a/marked/Rel-16/24_series/24334/5cdc04ba574b7b819a3cb6dbbd91306c_img.jpg b/marked/Rel-16/24_series/24334/5cdc04ba574b7b819a3cb6dbbd91306c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb60d4b9881076726e6e969e17b38361d9b4b0b4 --- /dev/null +++ b/marked/Rel-16/24_series/24334/5cdc04ba574b7b819a3cb6dbbd91306c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d61045697bf1b722c09341fc40c8289dd81808c0f80b5281f1fb736bcd1abaa +size 26967 diff --git a/marked/Rel-16/24_series/24334/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg b/marked/Rel-16/24_series/24334/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f5486d44f78ddc3f9e8a7f69072f83647a225f3 --- /dev/null +++ b/marked/Rel-16/24_series/24334/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8adca5232bdf94b3ad12fabf04433db1f32d1306a6ead25f6e33392781abfc06 +size 14697 diff --git a/marked/Rel-16/24_series/24334/61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg b/marked/Rel-16/24_series/24334/61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ad67dfc6fded4dd1a4407983b1654a2165d67a8 --- /dev/null +++ b/marked/Rel-16/24_series/24334/61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0be40b2d7332df4d0e735f53683870adbaf6cfde26129cd2ff34f846afe00e92 +size 8860 diff --git a/marked/Rel-16/24_series/24334/6234e6bbe2492677ef77d06cbaca2708_img.jpg b/marked/Rel-16/24_series/24334/6234e6bbe2492677ef77d06cbaca2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93c4779556d928863de6f94e819cfda687b8145d --- /dev/null +++ b/marked/Rel-16/24_series/24334/6234e6bbe2492677ef77d06cbaca2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:064ad0d62ad6768095ef5c45562672b552db8b6b5f57345b1479a4db5d0994de +size 8321 diff --git a/marked/Rel-16/24_series/24334/6322885569221ec51d70560d7dba1339_img.jpg b/marked/Rel-16/24_series/24334/6322885569221ec51d70560d7dba1339_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..347dead3f9f834710d6904c66c1675f03ba45fda --- /dev/null +++ b/marked/Rel-16/24_series/24334/6322885569221ec51d70560d7dba1339_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:359f99cb7e65bd1a44c31c9217465b7683cc0a9f21ff31f81a482b1447863deb +size 10752 diff --git a/marked/Rel-16/24_series/24334/688031e51a9a74ed869aa8405aab4e74_img.jpg b/marked/Rel-16/24_series/24334/688031e51a9a74ed869aa8405aab4e74_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ddb0ffb83e172ab5444d9a10e97641b0c4506cfc --- /dev/null +++ b/marked/Rel-16/24_series/24334/688031e51a9a74ed869aa8405aab4e74_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aef039db0d273795b7ff6c709d8df34ff50814fc8b8ddfe3725db2dc3c0a41a3 +size 8476 diff --git a/marked/Rel-16/24_series/24334/6bd66a9f24bf7442862b8f3ab580297e_img.jpg b/marked/Rel-16/24_series/24334/6bd66a9f24bf7442862b8f3ab580297e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08b127a51152bf11faeb90cf621bf22cfa9ce2a6 --- /dev/null +++ b/marked/Rel-16/24_series/24334/6bd66a9f24bf7442862b8f3ab580297e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e167632d5a603b10843303f62bd924756965b3e5cfacb04a9dc7de1a57805eab +size 11713 diff --git a/marked/Rel-16/24_series/24334/6c1f465976ff149b5f6d1e7bd88a14bf_img.jpg b/marked/Rel-16/24_series/24334/6c1f465976ff149b5f6d1e7bd88a14bf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9666f431c9473acf0814fc734ea9cdc741b90460 --- /dev/null +++ b/marked/Rel-16/24_series/24334/6c1f465976ff149b5f6d1e7bd88a14bf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40d708aef5e644138e57f8d3d239ecff1db29a26abd309a2c021d2b41b56c951 +size 19653 diff --git a/marked/Rel-16/24_series/24334/6cd03b2de72895b862b66ec8571baedf_img.jpg b/marked/Rel-16/24_series/24334/6cd03b2de72895b862b66ec8571baedf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b437d1f173b3bc9f08eccf0fd80d848d12ceb147 --- /dev/null +++ b/marked/Rel-16/24_series/24334/6cd03b2de72895b862b66ec8571baedf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a87990f9a1533e7a76846ca20b5ca20a66e30d0cafc71821f329af0b2bd38f41 +size 14549 diff --git a/marked/Rel-16/24_series/24334/710ff83dc4a77abbe489fbf1a462845a_img.jpg b/marked/Rel-16/24_series/24334/710ff83dc4a77abbe489fbf1a462845a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f542e64d5d7f3a342a3c62661afe346dd09e991 --- /dev/null +++ b/marked/Rel-16/24_series/24334/710ff83dc4a77abbe489fbf1a462845a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:776181445a5b9125790bad8c1348af7e0e7fb3ef36e50471fdeef384806b3315 +size 23158 diff --git a/marked/Rel-16/24_series/24334/73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg b/marked/Rel-16/24_series/24334/73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cbf5f53bf01abf49e6dcfe6438a84926bc8120a0 --- /dev/null +++ b/marked/Rel-16/24_series/24334/73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20fc4d55e0607b754837f0a5d6aa527e86004e1b624aef7ec6d6ad91cb345d8f +size 11029 diff --git a/marked/Rel-16/24_series/24334/750b1652a4f4791b84c02aa755a1dedd_img.jpg b/marked/Rel-16/24_series/24334/750b1652a4f4791b84c02aa755a1dedd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e3333a6b456558d036e972767818ecf4f360a469 --- /dev/null +++ b/marked/Rel-16/24_series/24334/750b1652a4f4791b84c02aa755a1dedd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0898f50591f3c082f66e89f4d5bdb01bbd263e6bf8d78042a4932d7b3c586d78 +size 14629 diff --git a/marked/Rel-16/24_series/24334/759c7d62402f0b4651ddce292be5bdef_img.jpg b/marked/Rel-16/24_series/24334/759c7d62402f0b4651ddce292be5bdef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..27c75cb219d11646b02416b75a012310491c1054 --- /dev/null +++ b/marked/Rel-16/24_series/24334/759c7d62402f0b4651ddce292be5bdef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:491d0490e318e0e8f453961f0505a7f0a93b143a1bb801d8855aca5a473357bf +size 23508 diff --git a/marked/Rel-16/24_series/24334/78862a2529213e65303b27d7fcf9a48c_img.jpg b/marked/Rel-16/24_series/24334/78862a2529213e65303b27d7fcf9a48c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4beb61855af02ff43bb4f61085b9eaae4aaf42fb --- /dev/null +++ b/marked/Rel-16/24_series/24334/78862a2529213e65303b27d7fcf9a48c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d3d71a603cb0c7a9dc64ed4614a70b88839b8523f01e96c48e01bcbbc569ff09 +size 12895 diff --git a/marked/Rel-16/24_series/24334/78a16fd827b60bf2582c349e28e0dfe6_img.jpg b/marked/Rel-16/24_series/24334/78a16fd827b60bf2582c349e28e0dfe6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7848c2e495de6958e035cbdcbe48fead34409924 --- /dev/null +++ b/marked/Rel-16/24_series/24334/78a16fd827b60bf2582c349e28e0dfe6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:515c390619b28f87238d970e2b69f26d7f594e774752cc5000f426efb73b5ba3 +size 7399 diff --git a/marked/Rel-16/24_series/24334/79aaab5889060cf8264226764a109cdb_img.jpg b/marked/Rel-16/24_series/24334/79aaab5889060cf8264226764a109cdb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7237fede53a7d48b218952b3ad3573a8430e1854 --- /dev/null +++ b/marked/Rel-16/24_series/24334/79aaab5889060cf8264226764a109cdb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:410efc05897f8082a1a879eec86f710a604fe7c0603439aeaca61626a70de191 +size 4981 diff --git a/marked/Rel-16/24_series/24334/7be79849b00ccd5e7220d808251b1258_img.jpg b/marked/Rel-16/24_series/24334/7be79849b00ccd5e7220d808251b1258_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..575fec39649d04ae68bb9ac7fdebb971bb12532a --- /dev/null +++ b/marked/Rel-16/24_series/24334/7be79849b00ccd5e7220d808251b1258_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:827f31db15723344c56dbfbbf00b0ab52fb4705a3f1dc7d0ce5db6038081faf0 +size 48114 diff --git a/marked/Rel-16/24_series/24334/80bb4ec4824504cee405fa52b634ca16_img.jpg b/marked/Rel-16/24_series/24334/80bb4ec4824504cee405fa52b634ca16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eed4c91853fe9b8e4e88e846915bf6b86d00cf7d --- /dev/null +++ b/marked/Rel-16/24_series/24334/80bb4ec4824504cee405fa52b634ca16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1363be01d4fd3bc1b61662f6c294061a85e52b34be51df9b34757d333f8db480 +size 12983 diff --git a/marked/Rel-16/24_series/24334/8269648391c59363ea61243864a2adf7_img.jpg b/marked/Rel-16/24_series/24334/8269648391c59363ea61243864a2adf7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..78c253f9a4ed620e85be3be8acbe85dbdd33e7f4 --- /dev/null +++ b/marked/Rel-16/24_series/24334/8269648391c59363ea61243864a2adf7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:19203e079b8d8b99e5bbecef506ace669960342705193411f9f0ad3530479637 +size 14374 diff --git a/marked/Rel-16/24_series/24334/84ff3b9de5bc4884d83fe064a8fff991_img.jpg b/marked/Rel-16/24_series/24334/84ff3b9de5bc4884d83fe064a8fff991_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07cdf77e82c7127aac21d548e50591ec42d31e25 --- /dev/null +++ b/marked/Rel-16/24_series/24334/84ff3b9de5bc4884d83fe064a8fff991_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c4c2109fcc666d0f99d2f3d118dea9a7ff6f687e54c80c6d35d1396bfb639d9 +size 12818 diff --git a/marked/Rel-16/24_series/24334/856d74cd46a3f383d2ffd19352028610_img.jpg b/marked/Rel-16/24_series/24334/856d74cd46a3f383d2ffd19352028610_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ad30d89201c1ba7eafb2fbec1270a91be5aeb3f --- /dev/null +++ b/marked/Rel-16/24_series/24334/856d74cd46a3f383d2ffd19352028610_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:543ae2ea5fe47c089fffd542c1b2cebbb7fce9188b8200ed8beb3cba0e78f5f9 +size 6871 diff --git a/marked/Rel-16/24_series/24334/92724c769da9d46b730fde1a6dccb023_img.jpg b/marked/Rel-16/24_series/24334/92724c769da9d46b730fde1a6dccb023_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0b3bf455a1dfda9e934fb42821b112eeff43e2fd --- /dev/null +++ b/marked/Rel-16/24_series/24334/92724c769da9d46b730fde1a6dccb023_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:998377ad67e65dca83a65d103b78aab748651ce477cc3c6f63d9585575923eb1 +size 15514 diff --git a/marked/Rel-16/24_series/24334/95b688d41d273fae1b28a240a2556803_img.jpg b/marked/Rel-16/24_series/24334/95b688d41d273fae1b28a240a2556803_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e23de3a5a0712a68aa03c096583d93e1bb5a5274 --- /dev/null +++ b/marked/Rel-16/24_series/24334/95b688d41d273fae1b28a240a2556803_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e1355927b5ec8154c119e4408c1bf2999ae69ba97a89681742eef0335c477a2 +size 14056 diff --git a/marked/Rel-16/24_series/24334/9a2e0224fed754d6b740485c9d4a6107_img.jpg b/marked/Rel-16/24_series/24334/9a2e0224fed754d6b740485c9d4a6107_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..03ef8e5a25eb84d44abaedd8fd1073dcc3db9057 --- /dev/null +++ b/marked/Rel-16/24_series/24334/9a2e0224fed754d6b740485c9d4a6107_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6bfc6a08b777854c87edc3d0467cf3442399b669a248f2424e0884f37178bc12 +size 6633 diff --git a/marked/Rel-16/24_series/24334/9ab99174161aa35a0b84ec0587ad0363_img.jpg b/marked/Rel-16/24_series/24334/9ab99174161aa35a0b84ec0587ad0363_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7b42bff86bf416a8f365aef86b46d4c4eae2d0d4 --- /dev/null +++ b/marked/Rel-16/24_series/24334/9ab99174161aa35a0b84ec0587ad0363_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a31c1d0d19ceab56d37725defb4af66dddf8d6cd14245a783250813f5a496ea4 +size 14272 diff --git a/marked/Rel-16/24_series/24334/9c7ef62eff36ab5e484b36559eccfeaf_img.jpg b/marked/Rel-16/24_series/24334/9c7ef62eff36ab5e484b36559eccfeaf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1c9b114b07f6b5de52a8aa89a54e359f7d42e69 --- /dev/null +++ b/marked/Rel-16/24_series/24334/9c7ef62eff36ab5e484b36559eccfeaf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f020997e51322191a3ea6b0c84f6c809fe2bb6e42aa47ce3de213dd591454433 +size 11719 diff --git a/marked/Rel-16/24_series/24334/9f5f9afcedaa0d9b7991976f5000865c_img.jpg b/marked/Rel-16/24_series/24334/9f5f9afcedaa0d9b7991976f5000865c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57c44aef71b2f8cc3d809d79ba2045da8a175a59 --- /dev/null +++ b/marked/Rel-16/24_series/24334/9f5f9afcedaa0d9b7991976f5000865c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81f437cd753c53476283207e7aa2c5f2b392cfa9389a4a012345219625bbd3ab +size 9788 diff --git a/marked/Rel-16/24_series/24334/a00c2ce2bca7f7c0d7a597c7e199db9a_img.jpg b/marked/Rel-16/24_series/24334/a00c2ce2bca7f7c0d7a597c7e199db9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bee3d1376bf79adfbbb7d50caab6cfa8e6642795 --- /dev/null +++ b/marked/Rel-16/24_series/24334/a00c2ce2bca7f7c0d7a597c7e199db9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33b981570a7f9f3b72044a6747fe839c5c839743a00727ebe22a200a5b9df37b +size 25165 diff --git a/marked/Rel-16/24_series/24334/a1e3575776f3a4da4c0b808d3b91bf8e_img.jpg b/marked/Rel-16/24_series/24334/a1e3575776f3a4da4c0b808d3b91bf8e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..77447abd1871b453c11bc9f89b3f66d5f6102516 --- /dev/null +++ b/marked/Rel-16/24_series/24334/a1e3575776f3a4da4c0b808d3b91bf8e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:391a372652db8c63c845047c27cfc49a89d15cb09d12412267be5eb1729a7795 +size 12802 diff --git a/marked/Rel-16/24_series/24334/a8bcad776c8f979f6ca27eebabac4af9_img.jpg b/marked/Rel-16/24_series/24334/a8bcad776c8f979f6ca27eebabac4af9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32c010465b75f273bcbbb919ebbd64ec52a78f51 --- /dev/null +++ b/marked/Rel-16/24_series/24334/a8bcad776c8f979f6ca27eebabac4af9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45030ae90e3e76a68447be46131f933f972065a707695da17b0c2c87ded4e821 +size 15941 diff --git a/marked/Rel-16/24_series/24334/abf91c0fe8bc45562f2bc9adc2d5d58a_img.jpg b/marked/Rel-16/24_series/24334/abf91c0fe8bc45562f2bc9adc2d5d58a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1136c0e28cf164334edfebd7a1d004f92c60b5fa --- /dev/null +++ b/marked/Rel-16/24_series/24334/abf91c0fe8bc45562f2bc9adc2d5d58a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eddea2287f7c274235ae7b2ef7dabddb2f5bba2ca9e65db6e02dec5b8bf1c25c +size 12400 diff --git a/marked/Rel-16/24_series/24334/ade808c7cde5b576488a326d288f29eb_img.jpg b/marked/Rel-16/24_series/24334/ade808c7cde5b576488a326d288f29eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..71c03e2f0c4ba711ce3e77583ac145cb696826cb --- /dev/null +++ b/marked/Rel-16/24_series/24334/ade808c7cde5b576488a326d288f29eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41fc368e0245169f0a96d3a3088dc8d5f57af1f673aae9eee681603e55827159 +size 17080 diff --git a/marked/Rel-16/24_series/24334/aed5b156b9b0fff9167baba88e5fdcfc_img.jpg b/marked/Rel-16/24_series/24334/aed5b156b9b0fff9167baba88e5fdcfc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..41ed8836711b6091a6b5b17fd40f91f41fce4f36 --- /dev/null +++ b/marked/Rel-16/24_series/24334/aed5b156b9b0fff9167baba88e5fdcfc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f733e96a894ebb38d098ef5fcb03d5248694864c6889a436fca7605f28a16482 +size 52152 diff --git a/marked/Rel-16/24_series/24334/b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg b/marked/Rel-16/24_series/24334/b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0930240aa046ecb740274983772177234256f83e --- /dev/null +++ b/marked/Rel-16/24_series/24334/b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1172e379b477dc71c37ebd2c4a3c6d2aecfea5af34d494e697721718543d43ab +size 13546 diff --git a/marked/Rel-16/24_series/24334/b50f38be091844d58b11e3d47bc71e73_img.jpg b/marked/Rel-16/24_series/24334/b50f38be091844d58b11e3d47bc71e73_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e280ee5e910131a08e70ee0a60fe68370f56d368 --- /dev/null +++ b/marked/Rel-16/24_series/24334/b50f38be091844d58b11e3d47bc71e73_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b52e5cdbb54e61d9e7f153fd2bdd3320f1a9ac87370fa067c11a449dad2d1fb +size 19393 diff --git a/marked/Rel-16/24_series/24334/c30bb9931a85960eb2e2008db772955c_img.jpg b/marked/Rel-16/24_series/24334/c30bb9931a85960eb2e2008db772955c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca377fa6ed94e6f4f8f132c6f5128ad7fe740573 --- /dev/null +++ b/marked/Rel-16/24_series/24334/c30bb9931a85960eb2e2008db772955c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dbebdf5eb12b68e6b35439564dc674c994f00e23d4ea7c9f34c140ab90bcbdc2 +size 7001 diff --git a/marked/Rel-16/24_series/24334/ce0b30eda000feb54457302d07202dc4_img.jpg b/marked/Rel-16/24_series/24334/ce0b30eda000feb54457302d07202dc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9970a0c299fb12bd9b4fc1fab03f99e266510bf --- /dev/null +++ b/marked/Rel-16/24_series/24334/ce0b30eda000feb54457302d07202dc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c18559d524a83210117e633cf4dc927e754fec9ccd93728a15c0bb6e92389652 +size 15695 diff --git a/marked/Rel-16/24_series/24334/cfd911568094b540490a86efe5c0ead6_img.jpg b/marked/Rel-16/24_series/24334/cfd911568094b540490a86efe5c0ead6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b085c7a078b8618826e8b8f6c85cff5c5fa61115 --- /dev/null +++ b/marked/Rel-16/24_series/24334/cfd911568094b540490a86efe5c0ead6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86fee5b091b871bad63ba0ca428e4e5487a3f58ba8304e6216faa69ae524ab4b +size 20995 diff --git a/marked/Rel-16/24_series/24334/cfe711931d1dd12a1e679873e79d9b1a_img.jpg b/marked/Rel-16/24_series/24334/cfe711931d1dd12a1e679873e79d9b1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7b350c509ecc6092954ffa4adef714ce97cb6bd5 --- /dev/null +++ b/marked/Rel-16/24_series/24334/cfe711931d1dd12a1e679873e79d9b1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e27fe6dc35df4570d0db76ab61eed5437c92fb13139529d3257de8abb25bb70 +size 23572 diff --git a/marked/Rel-16/24_series/24334/d6aa7052e7b36f8813f32684ac477305_img.jpg b/marked/Rel-16/24_series/24334/d6aa7052e7b36f8813f32684ac477305_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..23a63d866140f822cb446058cf02dda77a4e8d19 --- /dev/null +++ b/marked/Rel-16/24_series/24334/d6aa7052e7b36f8813f32684ac477305_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0623bc92275347f5f8208815dd907d62c85d6cba5239c6d7388ee2af84cf8f5 +size 3752 diff --git a/marked/Rel-16/24_series/24334/d6c377ae3e619ff992bd3647dbf43593_img.jpg b/marked/Rel-16/24_series/24334/d6c377ae3e619ff992bd3647dbf43593_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00c01fb7b6d1962b0560146e9ab556e295a8a10b --- /dev/null +++ b/marked/Rel-16/24_series/24334/d6c377ae3e619ff992bd3647dbf43593_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e416bc900ff58bdb99c29f63e4407b7f4d2b3581e50af9681e7796f16e12cadf +size 22318 diff --git a/marked/Rel-16/24_series/24334/da80cca94733ae79baed98eb586aa77b_img.jpg b/marked/Rel-16/24_series/24334/da80cca94733ae79baed98eb586aa77b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..984be6892c92376073ad862351a97df7010f6f6e --- /dev/null +++ b/marked/Rel-16/24_series/24334/da80cca94733ae79baed98eb586aa77b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a168bd963ae167464ee989b02bf0c9056db1058407bd8f231c585c18fc31a1bd +size 21428 diff --git a/marked/Rel-16/24_series/24334/dd1dd483573cc9c3bc666a371f59d5d7_img.jpg b/marked/Rel-16/24_series/24334/dd1dd483573cc9c3bc666a371f59d5d7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..30f7f39b8dab0d6c1447a74ffca1c9d1861a0458 --- /dev/null +++ b/marked/Rel-16/24_series/24334/dd1dd483573cc9c3bc666a371f59d5d7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b8064343c3a454c5f2c08d2c9f8fda067bd4d67521f79ce386b8691bb9a4c41 +size 14520 diff --git a/marked/Rel-16/24_series/24334/e603b56838e455402e8751d9b39ae9b0_img.jpg b/marked/Rel-16/24_series/24334/e603b56838e455402e8751d9b39ae9b0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a92d95ac2469123be99ce7a1086fd811c9dceb64 --- /dev/null +++ b/marked/Rel-16/24_series/24334/e603b56838e455402e8751d9b39ae9b0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca0c5c92af03240e9ee03c6fcbd21686a15644a0f35153ba43c55430cbb3fc40 +size 9600 diff --git a/marked/Rel-16/24_series/24334/e7010c66da16316c2935dfbbef5056b3_img.jpg b/marked/Rel-16/24_series/24334/e7010c66da16316c2935dfbbef5056b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a018dc0d3a09df7c190612c0babd570fcebb6fb8 --- /dev/null +++ b/marked/Rel-16/24_series/24334/e7010c66da16316c2935dfbbef5056b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:abae476fab75ef37963869365157a92a17fad7f56c4aaedb905fae7a1bd242a5 +size 24801 diff --git a/marked/Rel-16/24_series/24334/ed8597fae2e67db43518ae8bc46b6908_img.jpg b/marked/Rel-16/24_series/24334/ed8597fae2e67db43518ae8bc46b6908_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c69ba3d73d47857ffa13aa365b4b355395e50dc --- /dev/null +++ b/marked/Rel-16/24_series/24334/ed8597fae2e67db43518ae8bc46b6908_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c15b3b8cc0cf7330e0c4a133567c29848e448807272f375f754dec2e077ab29 +size 17678 diff --git a/marked/Rel-16/24_series/24334/eeb519f37cc42888fa15ab9ea20ba7cb_img.jpg b/marked/Rel-16/24_series/24334/eeb519f37cc42888fa15ab9ea20ba7cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..73f05a8682b94886f0bc83d1c1d6a162e34b46ac --- /dev/null +++ b/marked/Rel-16/24_series/24334/eeb519f37cc42888fa15ab9ea20ba7cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6baa0501cbab25adbc616b37e25d250d6fd2738060993a13f020fed6a410da83 +size 26857 diff --git a/marked/Rel-16/24_series/24334/f1de68a4cbb9b92a1c0ffd919bbd199c_img.jpg b/marked/Rel-16/24_series/24334/f1de68a4cbb9b92a1c0ffd919bbd199c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6754a54540658236d7dcc89f2cd61985158d7664 --- /dev/null +++ b/marked/Rel-16/24_series/24334/f1de68a4cbb9b92a1c0ffd919bbd199c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98258163e4a9f85dabb1ee81a960e3c3b32e102d2dda9f17534ead4bed5bd3bd +size 22388 diff --git a/marked/Rel-16/24_series/24334/f2124f9a242e6246af7f84f361ca8d22_img.jpg b/marked/Rel-16/24_series/24334/f2124f9a242e6246af7f84f361ca8d22_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..962a8b58cccaeeeb4f06b916d422874e53a5373f --- /dev/null +++ b/marked/Rel-16/24_series/24334/f2124f9a242e6246af7f84f361ca8d22_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa7010e7fa50bc6576f467216e4ac355b09701aa0e9cae22f194ac8e024ba613 +size 15921 diff --git a/marked/Rel-16/24_series/24334/f246294bf54daf21d334d732c4b76d88_img.jpg b/marked/Rel-16/24_series/24334/f246294bf54daf21d334d732c4b76d88_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..694d70d576d2ed29e8bd0b4b5d274e53282417f1 --- /dev/null +++ b/marked/Rel-16/24_series/24334/f246294bf54daf21d334d732c4b76d88_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:693b991ee40cbf3798ad078853b5520802319ed6acd8af7e766d3d9ff3c9e642 +size 4977 diff --git a/marked/Rel-16/24_series/24334/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg b/marked/Rel-16/24_series/24334/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53e2e1d9b2079344140c416fe0a4c541b515b0cf --- /dev/null +++ b/marked/Rel-16/24_series/24334/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:123772babdc5889eead211a492811a6eb411f4418dcfd896fc226856ba1359fb +size 14624 diff --git a/marked/Rel-16/24_series/24334/f7ee9cdc91f5f80cef936014cdf5c47e_img.jpg b/marked/Rel-16/24_series/24334/f7ee9cdc91f5f80cef936014cdf5c47e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7ff8ba195e4f8e8a754a8bdf9027d094fdbc1e5 --- /dev/null +++ b/marked/Rel-16/24_series/24334/f7ee9cdc91f5f80cef936014cdf5c47e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18d21a4dac766ba72bdf640df233950c6f29987b5d5db331fc58374aa55e187f +size 11941 diff --git a/marked/Rel-16/24_series/24334/ffe0fef452a0ae9a20253c319c54e13c_img.jpg b/marked/Rel-16/24_series/24334/ffe0fef452a0ae9a20253c319c54e13c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ace073a2328f68fb9beab5573d784daf8a6b730c --- /dev/null +++ b/marked/Rel-16/24_series/24334/ffe0fef452a0ae9a20253c319c54e13c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37dcfb33f79e3ed7e41813e94d39df2dee669fdd7b88844fafd674e187896fc6 +size 23835 diff --git a/marked/Rel-16/24_series/24334/raw.md b/marked/Rel-16/24_series/24334/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..84d9bba4c865dd5e9594fc3718ba0a0a5eb4917e --- /dev/null +++ b/marked/Rel-16/24_series/24334/raw.md @@ -0,0 +1,10476 @@ + + + + +![](317e0525ef1b2458976c246876f4a948_img.jpg) + +--- + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 13 | +| 1 Scope..... | 14 | +| 2 References..... | 14 | +| 3 Definitions, symbols and abbreviations..... | 16 | +| 3.1 Definitions..... | 16 | +| 3.2 Abbreviations..... | 17 | +| 4 General..... | 17 | +| 4.1 Overview..... | 17 | +| 5 ProSe service authorisation and authorisation update procedure..... | 18 | +| 5.1 Service authorisation and authorisation update for ProSe direct discovery and ProSe direct communication..... | 18 | +| 5.1.1 General..... | 18 | +| 5.1.2 ProSe Function discovery..... | 19 | +| 5.1.3 Service authorisation from ProSe Function..... | 20 | +| 6 ProSe direct discovery..... | 24 | +| 6.1 Overview..... | 24 | +| 6.1.1 Transport protocol for PC3 Control Protocol messages for ProSe direct discovery..... | 24 | +| 6.1.2 Handling of UE-initiated procedures..... | 24 | +| 6.1.3 Handling of ProSe Function-initiated procedures..... | 25 | +| 6.1.3.1 General..... | 25 | +| 6.1.3.2 HTTP long polling..... | 25 | +| 6.1.3.3 OMA Push..... | 25 | +| 6.2 Procedures..... | 26 | +| 6.2.1 Types of ProSe direct discovery procedures..... | 26 | +| 6.2.2 Announce request procedure for open ProSe direct discovery..... | 26 | +| 6.2.2.1 General..... | 26 | +| 6.2.2.2 Announce request procedure initiation..... | 26 | +| 6.2.2.3 Announce request procedure accepted by the ProSe Function..... | 28 | +| 6.2.2.4 Announce request procedure completion by the UE..... | 31 | +| 6.2.2.5 Announce request procedure not accepted by the ProSe Function..... | 32 | +| 6.2.2.6 Abnormal cases..... | 33 | +| 6.2.2.6.1 Abnormal cases in the UE..... | 33 | +| 6.2.2.6.2 Abnormal cases in the ProSe Function..... | 33 | +| 6.2.2A Announce request procedure for restricted ProSe direct discovery model A..... | 34 | +| 6.2.2A.1 General..... | 34 | +| 6.2.2A.2 Announce request procedure initiation..... | 34 | +| 6.2.2A.3 Announce request procedure accepted by the ProSe Function..... | 36 | +| 6.2.2A.4 Announce request procedure completion by the UE..... | 38 | +| 6.2.2A.5 Announce request procedure not accepted by the ProSe Function..... | 39 | +| 6.2.2A.6 Abnormal cases..... | 40 | +| 6.2.2A.6.1 Abnormal cases in the UE..... | 40 | +| 6.2.2A.6.2 Abnormal cases in the ProSe Function..... | 41 | +| 6.2.2B Discoveree request procedure for restricted ProSe direct discovery model B..... | 41 | +| 6.2.2B.1 General..... | 41 | +| 6.2.2B.2 Discoveree request procedure initiation..... | 41 | +| 6.2.2B.3 Discoveree request procedure accepted by the ProSe Function..... | 43 | +| 6.2.2B.4 Discoveree request procedure completion by the UE..... | 44 | +| 6.2.2B.5 Discoveree request procedure not accepted by the ProSe Function..... | 45 | +| 6.2.2B.6 Abnormal cases..... | 46 | +| 6.2.2B.6.1 Abnormal cases in the UE..... | 46 | +| 6.2.2B.6.2 Abnormal cases in the ProSe Function..... | 46 | +| 6.2.3 Monitor request procedure for open ProSe direct discovery..... | 47 | +| 6.2.3.1 General..... | 47 | +| 6.2.3.2 Monitor request procedure Initiation..... | 47 | +| 6.2.3.3 Monitor request procedure accepted by the ProSe Function..... | 48 | + +| | | | +|-------------|-----------------------------------------------------------------------------------------|----| +| 6.2.3.4 | Monitor request procedure completion by the UE..... | 50 | +| 6.2.3.5 | Monitor request procedure not accepted by the ProSe Function..... | 51 | +| 6.2.3.6 | Abnormal cases..... | 52 | +| 6.2.3.6.1 | Abnormal cases in the UE..... | 52 | +| 6.2.3.6.2 | Abnormal cases in the ProSe Function..... | 52 | +| 6.2.3A | Monitor request procedure for restricted ProSe direct discovery model A..... | 52 | +| 6.2.3A.1 | General..... | 52 | +| 6.2.3A.2 | Monitor request procedure Initiation..... | 53 | +| 6.2.3A.3 | Monitor request procedure accepted by the ProSe Function..... | 54 | +| 6.2.3A.4 | Monitor request procedure completion by the UE..... | 56 | +| 6.2.3A.5 | Monitor request procedure not accepted by the ProSe Function..... | 57 | +| 6.2.3A.6 | Abnormal cases..... | 58 | +| 6.2.3A.6.1 | Abnormal cases in the UE..... | 58 | +| 6.2.3A.6.2 | Abnormal cases in the ProSe Function..... | 58 | +| 6.2.3B | Discoverer request procedure for restricted ProSe direct discovery model B..... | 59 | +| 6.2.3B.1 | General..... | 59 | +| 6.2.3B.2 | Discoverer request procedure initiation..... | 59 | +| 6.2.3B.3 | Discoverer request procedure accepted by the ProSe Function..... | 60 | +| 6.2.3B.4 | Discoverer request procedure completion by the UE..... | 62 | +| 6.2.3B.5 | Discoverer request procedure not accepted by the ProSe Function..... | 64 | +| 6.2.3B.6 | Abnormal cases..... | 64 | +| 6.2.3B.6.1 | Abnormal cases in the UE..... | 64 | +| 6.2.3B.6.2 | Abnormal cases in the ProSe Function..... | 65 | +| 6.2.4 | Match report procedure for open ProSe direct discovery..... | 65 | +| 6.2.4.1 | General..... | 65 | +| 6.2.4.2 | Match report procedure initiation..... | 65 | +| 6.2.4.3 | Match report procedure accepted by the ProSe Function..... | 67 | +| 6.2.4.4 | Match report procedure completion by the UE..... | 68 | +| 6.2.4.5 | Match report procedure not accepted by the ProSe Function..... | 68 | +| 6.2.4.6 | Abnormal cases..... | 69 | +| 6.2.4.6.1 | Abnormal cases in the UE..... | 69 | +| 6.2.4A | Match report procedure for restricted ProSe direct discovery model A..... | 69 | +| 6.2.4A.1 | General..... | 69 | +| 6.2.4A.2 | Match report procedure initiation..... | 69 | +| 6.2.4A.3 | Match report procedure accepted by the ProSe Function..... | 71 | +| 6.2.4A.4 | Match report procedure completion by the UE..... | 72 | +| 6.2.4A.5 | Match report procedure not accepted by the ProSe Function..... | 72 | +| 6.2.4A.6 | Abnormal cases..... | 73 | +| 6.2.4A.6.1 | Abnormal cases in the UE..... | 73 | +| 6.2.4B | Match report procedure for restricted ProSe direct discovery model B..... | 73 | +| 6.2.4B.1 | General..... | 73 | +| 6.2.4B.2 | Match report procedure initiation..... | 73 | +| 6.2.4B.3 | Match report procedure accepted by the ProSe Function..... | 75 | +| 6.2.4B.4 | Match report procedure completion by the UE..... | 76 | +| 6.2.4B.5 | Match report procedure not accepted by the ProSe Function..... | 76 | +| 6.2.4B.6 | Abnormal cases..... | 76 | +| 6.2.4B.6.1 | Abnormal cases in the UE..... | 76 | +| 6.2.5 | Direct discovery time synchronisation by the Prose Function..... | 77 | +| 6.2.6 | Discovery Update..... | 77 | +| 6.2.6.1 | General..... | 77 | +| 6.2.6.2 | Revocation of Restricted Discovery Filters..... | 77 | +| 6.2.6.2.1 | Restricted Discovery filters revocation procedure initiation..... | 77 | +| 6.2.6.2.2 | Restricted Discovery filters revocation procedure accepted by the UE..... | 78 | +| 6.2.6.2.3 | Restricted Discovery filters revocation procedure completion by the ProSe Function..... | 78 | +| 6.2.6.2.4 | Restricted Discovery filters revocation procedure not accepted by the UE..... | 78 | +| 6.2.6.2.5 | Abnormal cases..... | 79 | +| 6.2.6.2.5.1 | Abnormal cases in the ProSe Function..... | 79 | +| 6.2.6.2.5.2 | Abnormal cases in the UE..... | 79 | +| 6.2.6.3 | Allocation of new ProSe Restricted Code..... | 79 | +| 6.2.6.3.1 | New ProSe Restricted Code allocation procedure initiation..... | 79 | +| 6.2.6.3.2 | ProSe Restricted Code allocation procedure accepted by the UE..... | 80 | + +| | | | +|-------------|-----------------------------------------------------------------------------------------|----| +| 6.2.6.3.3 | ProSe Restricted Code allocation procedure completion by the ProSe Function..... | 80 | +| 6.2.6.3.4 | ProSe Restricted Code allocation procedure not accepted by the UE..... | 80 | +| 6.2.6.3.5 | Abnormal cases..... | 80 | +| 6.2.6.3.5.1 | Abnormal cases in the ProSe Function..... | 80 | +| 6.2.6.3.5.2 | Abnormal cases in the UE..... | 81 | +| 6.2.7 | Direct discovery update procedure for open discovery..... | 81 | +| 6.2.7.1 | General..... | 81 | +| 6.2.7.2 | Direct discovery update procedure initiation..... | 81 | +| 6.2.7.3 | Direct discovery update procedure accepted by the UE..... | 82 | +| 6.2.7.4 | Direct discovery update procedure completed by the ProSe Function..... | 83 | +| 6.2.7.5 | Direct discovery update procedure not accepted by the UE..... | 83 | +| 6.2.7.6 | Abnormal cases..... | 83 | +| 6.2.7.6.1 | Abnormal cases in the ProSe Function..... | 83 | +| 6.2.7.6.2 | Abnormal cases in the UE..... | 84 | +| 6.2.8 | Announcing Alert procedure..... | 84 | +| 6.2.8.1 | General..... | 84 | +| 6.2.8.2 | Announcing Alert procedure initiation..... | 84 | +| 6.2.8.3 | Announcing Alert procedure accepted by the UE..... | 85 | +| 6.2.8.4 | Announcing Alert procedure completion by the ProSe Function..... | 86 | +| 6.2.8.4A | Announcing Alert procedure not accepted by the UE..... | 86 | +| 6.2.8.5 | Abnormal cases..... | 86 | +| 6.2.8.5.1 | Abnormal cases in the ProSe Function..... | 86 | +| 6.2.8.5.2 | Abnormal cases in the UE..... | 86 | +| 7 | EPC-level ProSe discovery..... | 87 | +| 7.1 | Overview..... | 87 | +| 7.1.1 | Transport protocol for PC3 Control Protocol messages for EPC-level ProSe discovery..... | 87 | +| 7.1.2 | Handling of UE-initiated procedures..... | 87 | +| 7.1.3 | Handling of network-initiated procedures..... | 87 | +| 7.1.3.1 | HTTP long polling..... | 87 | +| 7.1.3.2 | OMA Push..... | 88 | +| 7.2 | Procedures..... | 88 | +| 7.2.1 | Types of EPC-level ProSe discovery procedures..... | 88 | +| 7.2.2 | UE registration procedure..... | 89 | +| 7.2.2.1 | General..... | 89 | +| 7.2.2.2 | UE registration procedure initiation..... | 89 | +| 7.2.2.3 | UE registration procedure accepted by the ProSe Function..... | 89 | +| 7.2.2.4 | UE registration procedure completion by the UE..... | 90 | +| 7.2.2.5 | UE registration procedure not accepted by the ProSe Function..... | 90 | +| 7.2.3 | Application registration procedure..... | 90 | +| 7.2.3.1 | General..... | 90 | +| 7.2.3.2 | Application registration procedure initiation..... | 90 | +| 7.2.3.3 | Application registration procedure accepted by the ProSe Function..... | 91 | +| 7.2.3.4 | Application registration procedure completion by the UE..... | 91 | +| 7.2.3.5 | Application registration procedure not accepted by the ProSe Function..... | 91 | +| 7.2.4 | Proximity request procedure..... | 92 | +| 7.2.4.1 | General..... | 92 | +| 7.2.4.2 | Proximity request procedure initiation..... | 92 | +| 7.2.4.3 | Proximity request procedure accepted by the ProSe Function..... | 93 | +| 7.2.4.4 | Proximity request procedure completion by the UE..... | 93 | +| 7.2.4.5 | Proximity request procedure not accepted by the ProSe Function..... | 93 | +| 7.2.5 | Proximity alert procedure..... | 94 | +| 7.2.5.1 | General..... | 94 | +| 7.2.5.2 | Proximity alert procedure initiation by the network..... | 94 | +| 7.2.5.3 | Proximity alert procedure completion by the UE..... | 95 | +| 7.2.6 | UE deregistration procedure..... | 95 | +| 7.2.6.1 | General..... | 95 | +| 7.2.6.2 | UE-initiated UE deregistration procedure..... | 95 | +| 7.2.6.2.1 | UE-initiated UE deregistration procedure initiation..... | 95 | +| 7.2.6.2.2 | UE-initiated UE deregistration procedure accepted by the ProSe Function..... | 96 | +| 7.2.6.2.3 | UE-initiated UE deregistration procedure completion by the UE..... | 96 | +| 7.2.6.3 | Network-initiated UE deregistration procedure..... | 96 | + +| | | | +|------------|----------------------------------------------------------------------------------------------------------|-----| +| 7.2.6.3.1 | Network-initiated UE deregistration procedure initiation..... | 96 | +| 7.2.6.3.2 | Network-initiated UE deregistration procedure in the UE..... | 96 | +| 7.2.6.3.3 | Network-initiated UE deregistration procedure completion by the network..... | 96 | +| 7.2.7 | Proximity request cancellation procedure..... | 96 | +| 7.2.7.1 | General..... | 96 | +| 7.2.7.2 | UE initiated proximity request cancellation procedure..... | 97 | +| 7.2.7.2.1 | Initiation of UE initiated proximity request cancellation procedure..... | 97 | +| 7.2.7.2.2 | UE initiated proximity request cancellation procedure handling by the ProSe Function..... | 97 | +| 7.2.7.2.3 | UE initiated proximity request cancellation procedure completion by the UE..... | 97 | +| 7.2.7.3 | ProSe Function initiated proximity request cancellation procedure..... | 97 | +| 7.2.7.3.1 | Initiation of ProSe Function initiated proximity request cancellation procedure..... | 97 | +| 7.2.7.3.2 | ProSe initiated proximity request cancellation procedure handling by the UE..... | 98 | +| 7.2.7.3.3 | ProSe Function initiated proximity request cancellation procedure completion by the ProSe Function..... | 98 | +| 7.2.8 | Proximity request Validation procedure..... | 98 | +| 7.2.8.1 | General..... | 98 | +| 7.2.8.2 | Initiation of the proximity request validation procedure..... | 98 | +| 7.2.8.3 | Proximity request validation procedure in the UE..... | 99 | +| 7.2.8.4 | Proximity request validation procedure completion by the network..... | 99 | +| 7.2.9 | Abnormal cases..... | 99 | +| 7.2.9.1 | Abnormal cases in the UE..... | 99 | +| 7.2.9.2 | Abnormal cases in the ProSe Function..... | 100 | +| 8 | EPC support for WLAN direct discovery and communication..... | 100 | +| 9 | Handling of unknown, unforeseen, and erroneous protocol data..... | 100 | +| 9.1 | General..... | 100 | +| 9.2 | Handling of unknown, unforeseen, and erroneous protocol data in messages sent over the PC5 interface.... | 101 | +| 9.2.1 | Message too short..... | 101 | +| 9.2.2 | Unknown or unforeseen message type..... | 101 | +| 9.3 | Handling of unknown, unforeseen, and erroneous protocol data in messages sent over the PC3 interface.... | 101 | +| 9.3.1 | Invalid XML..... | 101 | +| 9.3.2 | Unforeseen message type..... | 101 | +| 10 | ProSe direct communication..... | 102 | +| 10.1 | General..... | 102 | +| 10.2 | One-to-many ProSe direct communication..... | 102 | +| 10.2.1 | General..... | 102 | +| 10.2.2 | ProSe direct communication facilitated by serving E-UTRAN..... | 103 | +| 10.2.3 | Procedure for UE to use provisioned radio resources..... | 103 | +| 10.2.4 | One-to-many ProSe direct communication transmission..... | 104 | +| 10.2.4.1 | General..... | 104 | +| 10.2.4.2 | eMBMS traffic relay..... | 104 | +| 10.3 | PC3ch Control Protocol for ProSe direct communication..... | 105 | +| 10.3.1 | Transport protocol for PC3ch Control Protocol for ProSe direct communication..... | 105 | +| 10.3.2 | Procedures for PC3ch Control Protocol for ProSe direct communication..... | 105 | +| 10.3.2.1 | Usage information report list sending procedure..... | 105 | +| 10.3.2.1.1 | General..... | 105 | +| 10.3.2.1.2 | Usage information report list sending procedure initiation..... | 106 | +| 10.3.2.1.3 | Usage information report list sending procedure accepted by the ProSe Function..... | 109 | +| 10.3.2.1.4 | Usage information report list sending procedure successful completion by the UE..... | 110 | +| 10.3.2.1.5 | Usage information report list sending procedure not accepted by the ProSe Function..... | 110 | +| 10.3.2.1.6 | Usage information report list sending procedure unsuccessful completion by the UE..... | 110 | +| 10.4 | One-to-one ProSe direct communication..... | 110 | +| 10.4.1 | Overview..... | 110 | +| 10.4.1A | Radio resource selection..... | 110 | +| 10.4.2 | Direct link setup procedure..... | 111 | +| 10.4.2.1 | General..... | 111 | +| 10.4.2.2 | Direct link setup procedure initiation by initiating UE..... | 111 | +| 10.4.2.3 | Direct link setup procedure accepted by the target UE..... | 113 | +| 10.4.2.4 | Direct link setup procedure completion by the initiating UE..... | 114 | +| 10.4.2.5 | Direct link setup procedure not accepted by the target UE..... | 114 | +| 10.4.2.6 | Abnormal cases..... | 115 | + +| | | | +|------------|---------------------------------------------------------------------------------------------|-----| +| 10.4.2.6.1 | Abnormal cases at the initiating UE..... | 115 | +| 10.4.2.6.2 | Abnormal cases at the target UE..... | 115 | +| 10.4.3 | Direct link keepalive procedure..... | 116 | +| 10.4.3.1 | General..... | 116 | +| 10.4.3.2 | Direct link keepalive procedure initiation by the requesting UE..... | 116 | +| 10.4.3.3 | Direct link keepalive procedure accepted by the peer UE..... | 116 | +| 10.4.3.4 | Direct link keepalive procedure completed by the requesting UE..... | 117 | +| 10.4.3.5 | Abnormal cases..... | 117 | +| 10.4.3.5.1 | Abnormal cases at the requesting UE..... | 117 | +| 10.4.3.5.2 | Abnormal cases at the peer UE..... | 117 | +| 10.4.4 | Direct link release procedure..... | 117 | +| 10.4.4.1 | General..... | 117 | +| 10.4.4.2 | Direct link release procedure initiation by the releasing UE..... | 117 | +| 10.4.4.3 | Direct link release procedure accepted by the peer UE..... | 118 | +| 10.4.4.4 | Direct link release procedure completion by the releasing UE..... | 118 | +| 10.4.4.5 | Abnormal cases..... | 118 | +| 10.4.4.5.1 | Abnormal cases at the releasing UE..... | 118 | +| 10.4.5 | Direct security mode control procedure..... | 118 | +| 10.4.5.1 | General..... | 118 | +| 10.4.5.2 | Direct security mode control procedure initiation by the commanding UE..... | 119 | +| 10.4.5.3 | Direct security mode control procedure accepted by the peer UE..... | 120 | +| 10.4.5.4 | Direct security mode control procedure completion by the commanding UE..... | 121 | +| 10.4.5.5 | Direct security mode control procedure not accepted by the peer UE..... | 121 | +| 10.4.5.6.1 | Abnormal cases at the commanding UE..... | 121 | +| 10.4.5.6.2 | Abnormal cases at the peer UE..... | 121 | +| 10.4.6 | IP Address configuration..... | 122 | +| 10.4.6.1 | General..... | 122 | +| 10.4.6.2 | Selection of IP version..... | 122 | +| 10.4.6.3 | IPv4 address configuration with DHCPv4..... | 122 | +| 10.4.6.4 | IPv6 address configuration with IPv6 stateless address auto-configuration..... | 123 | +| 10.4.7 | ProSe Per-Packet Priority for one-to-one ProSe direct communication..... | 123 | +| 10.4.7.1 | General..... | 123 | +| 10.4.7.2 | ProSe Per-Packet Priority for ProSe UE-to-network relay..... | 124 | +| 10.4.8 | Direct link rekeying procedure..... | 124 | +| 10.4.8.1 | General..... | 124 | +| 10.4.8.2 | Direct link rekeying procedure initiation..... | 124 | +| 10.4.8.3 | Direct link rekeying procedure accepted by the target UE..... | 125 | +| 10.4.8.5 | Direct link rekeying procedure not accepted by the target UE..... | 126 | +| 10.4.8.6.1 | Abnormal cases at the initiating UE..... | 126 | +| 10.4.8.6.2 | Abnormal cases at the target UE..... | 126 | +| 10.5 | TMGI monitoring request procedure..... | 126 | +| 10.5.1 | General..... | 126 | +| 10.5.2 | TMGI monitoring request procedure initiation by the remote UE..... | 127 | +| 10.5.3 | TMGI monitoring request procedure accepted by the ProSe UE-to-network relay UE..... | 127 | +| 10.5.4 | TMGI monitoring request procedure completion by the remote UE..... | 128 | +| 10.5.5 | Abnormal cases..... | 128 | +| 10.5.5.1 | Abnormal cases in the remote UE..... | 128 | +| 10.6 | Cell ID announcement request procedure..... | 129 | +| 10.6.1 | General..... | 129 | +| 10.6.2 | Cell ID announcement request procedure initiation by the remote UE..... | 129 | +| 10.6.3 | Cell ID announcement request procedure accepted by the ProSe UE-to-network relay UE..... | 130 | +| 10.6.4 | Cell ID announcement request procedure completion by the remote UE..... | 130 | +| 10.6.5 | Abnormal cases..... | 130 | +| 10.6.5.1 | Abnormal cases in the remote UE..... | 130 | +| 10.7 | Remote UE information request procedure..... | 130 | +| 10.7.1 | General..... | 130 | +| 10.7.2 | Remote UE information request procedure initiation by the ProSe UE-to-network relay UE..... | 131 | +| 10.7.3 | Remote UE information request accepted by the remote UE..... | 131 | +| 10.7.4 | Remote UE information request procedure completion by the ProSe UE-to-network relay UE..... | 131 | +| 10.7.5 | Abnormal cases..... | 131 | +| 10.7.5.1 | Abnormal cases in the ProSe UE-to-network relay UE..... | 131 | + +| | | | +|------------|---------------------------------------------------------------------------|-----| +| 10.8 | Non-IP data transport procedure..... | 131 | +| 10.8.1 | General..... | 131 | +| 10.8.2 | Non-IP data transmission over PC5..... | 132 | +| 10.8.3 | Non-IP data reception over PC5..... | 132 | +| 10A | ProSe direct discovery for public safety use..... | 132 | +| 10A.1 | Overview..... | 132 | +| 10A.2 | Procedures..... | 132 | +| 10A.2.1 | General..... | 132 | +| 10A.2.1A | Radio resource selection..... | 133 | +| 10A.2.2 | Announcing UE procedure for UE-to-network relay discovery..... | 133 | +| 10A.2.2.1 | General..... | 133 | +| 10A.2.2.2 | Announcing UE procedure for UE-to-network relay discovery initiation..... | 134 | +| 10A.2.2.3 | Announcing UE procedure for UE-to-network relay discovery completion..... | 135 | +| 10A.2.3 | Monitoring UE procedure for UE-to-network relay discovery..... | 135 | +| 10A.2.3.1 | General..... | 135 | +| 10A.2.3.2 | Monitoring UE procedure for UE-to-network relay discovery initiation..... | 135 | +| 10A.2.3.3 | Monitoring UE procedure for UE-to-network relay discovery completion..... | 137 | +| 10A.2.4 | Discoverer UE procedure for UE-to-network relay discovery..... | 137 | +| 10A.2.4.1 | General..... | 137 | +| 10A.2.4.2 | Discoverer UE procedure for UE-to-network relay discovery initiation..... | 137 | +| 10A.2.4.3 | Discoverer UE procedure for UE-to-network relay discovery completion..... | 140 | +| 10A.2.5 | Discoveree UE procedure for UE-to-network relay discovery..... | 140 | +| 10A.2.5.1 | General..... | 140 | +| 10A.2.5.2 | Discoveree UE procedure for UE-to-network relay discovery initiation..... | 141 | +| 10A.2.5.3 | Discoveree UE procedure for UE-to-network relay discovery completion..... | 142 | +| 10A.2.6 | Announcing UE procedure for group member discovery..... | 142 | +| 10A.2.6.1 | General..... | 142 | +| 10A.2.6.2 | Announcing UE procedure for group member discovery initiation..... | 142 | +| 10A.2.6.3 | Announcing UE procedure for group member discovery completion..... | 144 | +| 10A.2.7 | Monitoring UE procedure for group member discovery..... | 144 | +| 10A.2.7.1 | General..... | 144 | +| 10A.2.7.2 | Monitoring UE procedure for group member discovery initiation..... | 144 | +| 10A.2.7.3 | Monitoring UE procedure for group member discovery completion..... | 146 | +| 10A.2.8 | Discoverer UE procedure for group member discovery..... | 146 | +| 10A.2.8.1 | General..... | 146 | +| 10A.2.8.2 | Discoverer UE procedure for group member discovery initiation..... | 146 | +| 10A.2.8.3 | Discoverer UE procedure for group member discovery completion..... | 148 | +| 10A.2.9 | Discoveree UE procedure for group member discovery..... | 148 | +| 10A.2.9.1 | General..... | 148 | +| 10A.2.9.2 | Discoveree UE procedure for group member discovery initiation..... | 148 | +| 10A.2.9.3 | Discoveree UE procedure for group member discovery completion..... | 150 | +| 10A.2.10 | Announcing UE procedure for Relay Discovery Additional Information..... | 151 | +| 10A.2.10.1 | General..... | 151 | +| 10A.2.10.2 | Announcing procedure for Relay Discovery Additional Information..... | 151 | +| 10A.2.11 | Monitoring UE procedure for Relay Discovery Additional Information..... | 152 | +| 10A.2.11.1 | General..... | 152 | +| 10A.2.11.2 | Monitoring procedure for Relay Discovery Additional Information..... | 152 | +| 10A.2.12 | UE-to-network relay selection procedure..... | 154 | +| 10A.2.12.1 | General..... | 154 | +| 10A.2.12.2 | UE-to-network relay selection procedure initiation..... | 154 | +| 10A.2.12.3 | UE-to-network relay selection procedure completion..... | 154 | +| 10A.2.13 | UE-to-network relay reselection procedure..... | 155 | +| 10A.2.13.1 | General..... | 155 | +| 10A.2.13.2 | UE-to-network relay reselection procedure initiation..... | 155 | +| 11 | Message functional definitions and contents..... | 155 | +| 11.1 | Overview..... | 155 | +| 11.2 | ProSe discovery messages..... | 156 | +| 11.2.1 | General..... | 156 | +| 11.2.2 | application/3gpp-prose+xml..... | 156 | +| 11.2.3 | XML Schema..... | 156 | + +| | | | +|------------|------------------------------------------------------------|-----| +| 11.2.4 | Semantics..... | 169 | +| 11.2.4.1 | General..... | 169 | +| 11.2.4.2 | Semantics of ..... | 170 | +| 11.2.4.3 | Semantics of ..... | 171 | +| 11.2.4.4 | Semantics of ..... | 174 | +| 11.2.4.5 | Semantics of ..... | 175 | +| 11.2.4.6 | Semantics of ..... | 176 | +| 11.2.4.7 | Semantics of ..... | 176 | +| 11.2.4.8 | Semantics of ..... | 177 | +| 11.2.4.9 | Semantics of ..... | 177 | +| 11.2.4.10 | Semantics of ..... | 178 | +| 11.2.4.11 | Semantics of ..... | 178 | +| 11.2.4.12 | Semantics of ..... | 179 | +| 11.2.4.13 | Semantics of ..... | 179 | +| 11.2.4.14 | Semantics of ..... | 179 | +| 11.2.4.15 | Semantics of ..... | 180 | +| 11.2.4.16 | Semantics of ..... | 180 | +| 11.2.4.17 | Semantics of ..... | 180 | +| 11.2.4.18 | Semantics of ..... | 181 | +| 11.2.4.19 | Semantics of ..... | 181 | +| 11.2.4.20 | Semantics of ..... | 182 | +| 11.2.4.21 | Semantics of ..... | 182 | +| 11.2.4.22 | Semantics of ..... | 183 | +| 11.2.5 | PC5_DISCOVERY..... | 183 | +| 11.2.5.1 | Message definition..... | 183 | +| 11.3 | Messages transmitted over the PC3ch interface..... | 188 | +| 11.3.1 | General..... | 188 | +| 11.3.2 | application/3gpp-prose-pc3ch+xml..... | 188 | +| 11.3.3 | XML Schema..... | 188 | +| 11.3.4 | Semantics..... | 191 | +| 11.3.4.1 | General..... | 191 | +| 11.3.4.2 | Semantics of ..... | 191 | +| 11.3.4.3 | Semantics of ..... | 195 | +| 11.4 | PC5 Signalling messages..... | 195 | +| 11.4.1 | Overview..... | 195 | +| 11.4.2 | DIRECT_COMMUNICATION_REQUEST..... | 196 | +| 11.4.2.1 | Message definition..... | 196 | +| 11.4.3 | DIRECT_COMMUNICATION_ACCEPT..... | 197 | +| 11.4.3.1 | Message definition..... | 197 | +| 11.4.3.2 | Link Local IPv6 Address..... | 197 | +| 11.4.4 | DIRECT_COMMUNICATION_REJECT..... | 197 | +| 11.4.4.1 | Message definition..... | 197 | +| 11.4.5 | DIRECT_COMMUNICATION_KEEPALIVE..... | 198 | +| 11.4.5.1 | Message definition..... | 198 | +| 11.4.6 | DIRECT_COMMUNICATION_KEEPALIVE_ACK..... | 198 | +| 11.4.6.1 | Message definition..... | 198 | +| 11.4.7 | DIRECT_COMMUNICATION_RELEASE..... | 198 | +| 11.4.7.1 | Message definition..... | 198 | +| 11.4.8 | DIRECT_COMMUNICATION_RELEASE_ACCEPT..... | 199 | +| 11.4.8.1 | Message definition..... | 199 | +| 11.4.9 | TMGI_MONITORING_REQUEST..... | 199 | +| 11.4.9.1 | Message definition..... | 199 | +| 11.4.10 | TMGI_MONITORING_RESPONSE..... | 199 | +| 11.4.10.1 | Message definition..... | 199 | +| 11.4.11 | CELL_ID_ANNOUNCEMENT_REQUEST..... | 200 | +| 11.4.11.1 | Message definition..... | 200 | +| 11.4.12 | CELL_ID_ANNOUNCEMENT_RESPONSE..... | 200 | +| 11.4.12.1 | Message definition..... | 200 | +| 11.4.12A | DIRECT_SECURITY_MODE_COMMAND..... | 200 | +| 11.4.12A.1 | Message definition..... | 200 | +| 11.4.13 | DIRECT_SECURITY_MODE_COMPLETE..... | 201 | + +| | | | +|-----------|-------------------------------------------------------------|-----| +| 11.4.13.1 | Message definition..... | 201 | +| 11.4.14 | DIRECT_SECURITY_MODE_REJECT..... | 201 | +| 11.4.14.1 | Message definition..... | 201 | +| 11.4.15 | DIRECT_REKEYING_REQUEST..... | 202 | +| 11.4.15.1 | Message definition..... | 202 | +| 11.4.16 | DIRECT_REKEYING_RESPONSE..... | 202 | +| 11.4.16.1 | Message definition..... | 202 | +| 11.4.17 | DIRECT_REKEYING_TRIGGER..... | 203 | +| 11.4.17.1 | Message definition..... | 203 | +| 11.4.18 | REMOTE_UE_INFO_REQUEST..... | 203 | +| 11.4.18.1 | Message definition..... | 203 | +| 11.4.19 | REMOTE_UE_INFO_RESPONSE..... | 203 | +| 11.4.19.1 | Message definition..... | 203 | +| 11.5 | Non-IP data PDU format..... | 203 | +| 12 | General message format and information elements coding..... | 204 | +| 12.1 | Overview..... | 204 | +| 12.1A | General..... | 204 | +| 12.2 | ProSe direct discovery message formats..... | 204 | +| 12.2.1 | Data types format in XML schema..... | 204 | +| 12.2.2 | Parameters in ProSe direct discovery messages..... | 205 | +| 12.2.2.1 | Transaction ID..... | 205 | +| 12.2.2.2 | Command..... | 205 | +| 12.2.2.3 | UE Identity..... | 205 | +| 12.2.2.4 | Prose Application ID..... | 205 | +| 12.2.2.5 | Application Identity..... | 205 | +| 12.2.2.6 | ProSe Application Code..... | 205 | +| 12.2.2.7 | Validity Timer T4000..... | 206 | +| 12.2.2.8 | PC3 Control Protocol cause value..... | 206 | +| 12.2.2.9 | DiscoveryKey..... | 206 | +| 12.2.2.10 | Message Type..... | 206 | +| 12.2.2.11 | MIC..... | 207 | +| 12.2.2.12 | Discovery Filter..... | 207 | +| 12.2.2.13 | Void..... | 208 | +| 12.2.2.14 | Void..... | 208 | +| 12.2.2.15 | Void..... | 208 | +| 12.2.2.16 | Monitored PLMN ID..... | 208 | +| 12.2.2.17 | VPLMN ID..... | 208 | +| 12.2.2.18 | UTC-based counter..... | 208 | +| 12.2.2.19 | Validity Timer T4004..... | 208 | +| 12.2.2.20 | Metadata Flag..... | 208 | +| 12.2.2.21 | Metadata..... | 208 | +| 12.2.2.22 | UTC-based Counter LSB..... | 209 | +| 12.2.2.23 | Current Time..... | 209 | +| 12.2.2.24 | Max Offset..... | 209 | +| 12.2.2.25 | Discovery Type..... | 209 | +| 12.2.2.26 | Match Report Refresh Timer T4006..... | 210 | +| 12.2.2.27 | Requested Timer..... | 210 | +| 12.2.2.28 | ProSe Function Transaction ID..... | 210 | +| 12.2.2.29 | Update Info..... | 210 | +| 12.2.2.30 | RPAUID..... | 210 | +| 12.2.2.31 | Announcing Type..... | 211 | +| 12.2.2.32 | Application Level Container..... | 211 | +| 12.2.2.33 | Discovery Entry ID..... | 211 | +| 12.2.2.34 | ProSe Restricted Code..... | 211 | +| 12.2.2.35 | ProSe Restricted Code Suffix Range..... | 211 | +| 12.2.2.36 | On Demand Announcing Enabled Indicator..... | 212 | +| 12.2.2.37 | Restricted Discovery Filter..... | 212 | +| 12.2.2.38 | ACE Enabled Indicator..... | 212 | +| 12.2.2.39 | Validity Timer T4007..... | 213 | +| 12.2.2.40 | Restricted Code Security Material..... | 213 | +| 12.2.2.41 | Discovery Model..... | 213 | + +| | | | +|-----------|------------------------------------------------------------------|-----| +| 12.2.2.42 | ProSe Response Code..... | 213 | +| 12.2.2.43 | Discovery Query Filter..... | 213 | +| 12.2.2.44 | Validity Timer T4011..... | 213 | +| 12.2.2.45 | Subquery Result..... | 214 | +| 12.2.2.46 | ProSe Restricted Code Prefix..... | 214 | +| 12.2.2.47 | ProSe Restricted Code Suffix..... | 214 | +| 12.2.2.48 | ProSe UE ID..... | 214 | +| 12.2.2.49 | ProSe Relay UE ID..... | 214 | +| 12.2.2.50 | User Info ID..... | 214 | +| 12.2.2.51 | Relay Service Code..... | 214 | +| 12.2.2.52 | Target User Info..... | 215 | +| 12.2.2.53 | Target Group Info..... | 215 | +| 12.2.2.54 | Discovery Group ID..... | 215 | +| 12.2.2.55 | GMDS Composition..... | 215 | +| 12.2.2.56 | Spare..... | 215 | +| 12.2.2.57 | RDAI Composition..... | 215 | +| 12.2.2.58 | ECGI..... | 216 | +| 12.2.2.59 | MBMS related information..... | 216 | +| 12.2.2.60 | Validity Timer T4016..... | 217 | +| 12.2.2.61 | Match Report Refresh Timer T4017..... | 217 | +| 12.2.2.62 | Metadata Index Mask..... | 217 | +| 12.2.2.63 | Network-Initiated Transaction Method..... | 217 | +| 12.2.2.64 | Announcing PLMN ID..... | 217 | +| 12.2.2.65 | Metadata Indicator..... | 218 | +| 12.2.2.66 | URDS Composition..... | 218 | +| 12.2.2.67 | Status Indicator..... | 218 | +| 12.2.2.68 | ProSe Application Code Prefix..... | 219 | +| 12.2.2.69 | ProSe Application Code Suffix..... | 219 | +| 12.2.2.70 | ProSe Application Code ACE..... | 219 | +| 12.2.2.71 | PC5_tech..... | 219 | +| 12.3 | EPC-level ProSe discovery message formats..... | 220 | +| 12.3.1 | Data types format in XML schema..... | 220 | +| 12.3.2 | Information elements in EPC-level ProSe discovery messages..... | 220 | +| 12.3.2.1 | Transaction ID..... | 220 | +| 12.3.2.2 | UE Identity..... | 220 | +| 12.3.2.3 | Application Identity..... | 220 | +| 12.3.2.4 | Application Layer User ID..... | 220 | +| 12.3.2.5 | PC3 EPC Control Protocol cause value..... | 221 | +| 12.3.2.6 | WLAN Link Layer ID..... | 221 | +| 12.3.2.7 | EPC ProSe User ID..... | 221 | +| 12.3.2.8 | Range Class..... | 221 | +| 12.3.2.9 | Time Window..... | 222 | +| 12.3.2.10 | Void..... | 222 | +| 12.3.2.11 | UE Location..... | 222 | +| 12.3.2.12 | WLAN Indication..... | 222 | +| 12.3.2.13 | Assistance Information..... | 222 | +| 12.3.2.14 | Method for server-initiated transaction..... | 223 | +| 12.3.2.15 | Method for server-initiated transaction configuration..... | 223 | +| 12.4 | Formats for messages transmitted over the PC3ch interface..... | 223 | +| 12.4.1 | Data types format in XML schema..... | 223 | +| 12.4.2 | Parameters in messages transmitted over the PC3ch interface..... | 223 | +| 12.4.2.1 | Transaction ID..... | 223 | +| 12.4.2.2 | UE Identity..... | 223 | +| 12.4.2.3 | Sequence number..... | 224 | +| 12.4.2.4 | In coverage..... | 224 | +| 12.4.2.5 | ECGI..... | 224 | +| 12.4.2.6 | ProSe direct communication radio parameters..... | 224 | +| 12.4.2.7 | Cause value..... | 224 | +| 12.4.2.8 | Timestamp..... | 224 | +| 12.4.2.9 | ProSe Layer-2 Group ID..... | 224 | +| 12.4.2.10 | Prose Group IP multicast address..... | 224 | + +| | | | +|-------------------------------|------------------------------------------------------|------------| +| 12.4.2.11 | IP address of the UE..... | 224 | +| 12.4.2.12 | Prose UE ID..... | 225 | +| 12.4.2.13 | Transported data amount..... | 225 | +| 12.4.2.14 | Radio resources indicator..... | 225 | +| 12.4.2.15 | Radio frequency..... | 225 | +| 12.5 | PC5 Signalling message formats..... | 225 | +| 12.5.1 | Information elements in PC5 Signalling messages..... | 225 | +| 12.5.1.1 | PC5-SP Message Type..... | 225 | +| 12.5.1.2 | Sequence Number..... | 226 | +| 12.5.1.3 | User Info..... | 226 | +| 12.5.1.4 | IP Address Config..... | 227 | +| 12.5.1.5 | Link Local IPv6 Address..... | 228 | +| 12.5.1.6 | Keepalive Counter..... | 228 | +| 12.5.1.7 | PC5 Signalling Protocol Cause Value..... | 229 | +| 12.5.1.8 | Release Reason..... | 229 | +| 12.5.1.9 | Maximum Inactivity Period..... | 230 | +| 12.5.1.10 | TMGI..... | 230 | +| 12.5.1.11 | MBMS SAI list..... | 230 | +| 12.5.1.12 | ProSe Layer2 Group ID..... | 231 | +| 12.5.1.13 | TMGI Monitoring Refresh Timer T4104..... | 231 | +| 12.5.1.14 | SAI Indicator..... | 232 | +| 12.5.1.15 | ECGI announcement request refresh timer T4106..... | 232 | +| 12.5.1.16 | Requested ProSe Per-Packet Priority..... | 232 | +| 12.5.1.17 | Relay Service Code..... | 232 | +| 12.5.1.18 | GPI..... | 233 | +| 12.5.1.19 | PRUK ID..... | 233 | +| 12.5.1.20 | AUTS..... | 234 | +| 12.5.1.21 | RAND..... | 234 | +| 12.5.1.22 | UE Security Capabilities..... | 235 | +| 12.5.1.23 | Chosen Algorithms..... | 237 | +| 12.5.1.24 | LSB of K D-sess ID..... | 237 | +| 12.5.1.25 | MSB of K D-sess ID..... | 238 | +| 12.5.1.26 | LSB of K D ID..... | 238 | +| 12.5.1.27 | MSB of K D ID..... | 238 | +| 12.5.1.28 | K D ID..... | 239 | +| 12.5.1.29 | K D Freshness..... | 239 | +| 12.5.1.30 | Nonce_1..... | 240 | +| 12.5.1.31 | Nonce_2..... | 240 | +| 12.5.1.32 | Auth Flag..... | 240 | +| 12.5.1.33 | Signature..... | 241 | +| 12.5.1.34 | Encrypted Payload..... | 241 | +| 12.5.1.35 | Remote UE Information Type..... | 242 | +| 12.5.1.36 | IMEI..... | 242 | +| 13 | List of system parameters..... | 243 | +| 13.1 | General..... | 243 | +| 13.2 | Timers of ProSe direct services procedures..... | 244 | +| Annex A (informative): | IANA registrations..... | 253 | +| A.1 | IANA registrations for MIME types..... | 253 | +| A.1.1 | General..... | 253 | +| A.1.2 | application/3gpp-prose-pc3ch+xml..... | 253 | +| A.1.3 | application/3gpp-prose+xml..... | 254 | +| Annex B (informative): | Change history..... | 257 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the protocols for Proximity-based Services (ProSe) between: + +- the ProSe-enabled UE and the ProSe Function (over the PC3 interface); and +- two ProSe-enabled UEs (over the PC5 interface). + +The present document defines the associated procedures for ProSe service authorisation, ProSe direct discovery (using E-UTRA or WLAN technology), EPC-level ProSe discovery and ProSe direct communication. + +The present document also defines the message format, message contents, error handling and system parameters applied by the protocols for ProSe. + +The present document is applicable to: + +- the ProSe-enabled UE; and +- the ProSe Function. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.303: "Proximity-based services (ProSe); Stage 2". +- [3] 3GPP TS 29.344: "Proximity-services (Prose) Function to Home Subscriber Server (HSS) aspects; Stage 3". +- [4] 3GPP TS 23.003: "Numbering, addressing and identification". +- [5] 3GPP TS 29.345: "Inter-Proximity-services (Prose) Function signalling aspects; Stage 3". +- [6] 3GPP TS 33.303: "Proximity-based Services (ProSe); Security aspects". +- [7] W3C REC-xmlschema-2-20041028: "XML Schema Part 2: Datatypes". +- [8] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [9] 3GPP TS 24.333: "Proximity-services (ProSe) Management Objects (MO)". +- [10] IETF RFC 1035: "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION". +- [11] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [12] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". +- [13] Wi-Fi Alliance Technical Committee P2P Task Group, "Wi-Fi Peer-to-Peer (P2P) Technical Specification", Version 1.1. + +- [14] IEEE Std 802.11-2012: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Specific requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [15] IETF RFC 4862: "IPv6 Stateless Address Autoconfiguration". +- [16] IETF RFC 3927: "Dynamic Configuration of IPv4 Link-Local Addresses". +- [17] 3GPP TS 31.102: "Characteristics of the Universal Subscriber Identity Module (USIM) application". +- [18] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [19] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [20] [WAP-168-ServiceLoad-20010731-a](#): "Service Loading". +- [21] OMA-WAP-TS-PushOTA-V2\_1-20110405-A: "Push Over the Air". +- [22] [OMA-AD-Push-V2\\_2-20110809-A](#): "Push Architecture". +- [23] 3GPP TS 36.304: "Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) procedures in idle mode". +- [24] 3GPP TS 23.122: "Non-Access-Stratum (NAS) functions related to Mobile Station (MS) in idle mode". +- [25] IETF RFC 3023: "XML Media Types". +- [26] IETF RFC 4288: "Media Type Specifications and Registration Procedures". +- [27] 3GPP TS 32.277: "Proximity-based Services (ProSe) charging". +- [28] IETF RFC 1166: "Internet Numbers". +- [29] IETF RFC 5952: "A Recommendation for IPv6 Address Text Representation". +- [30] 3GPP TS 24.008: "Mobile Radio Interface Layer 3 specification; Core Network Protocols; Stage 3". +- [31] 3GPP TS 29.343: "Proximity-services (ProSe) function to ProSe application server aspects (PC2); Stage 3". +- [32] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". +- [33] IETF RFC 4861: "Neighbor Discovery for IP version 6 (IPv6)". +- [34] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [35] 3GPP TS 23.221: "Architectural requirements". +- [36] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [37] 3GPP TS 36.323: "Packet Data Convergence Protocol (PDCP) specification". +- [38] 3GPP TS 23.179: "Functional architecture and information flows to support mission critical communication services". +- [39] IETF RFC 6507: "Elliptic Curve-Based Certificateless Signatures for Identity-Based Encryption (ECCSI)". +- [40] IETF RFC 6508: "Sakai-Kasahara Key Encryption (SAKKE)". +- [41] 3GPP TS 33.102: "3G Security; Security architecture". + +- [42] 3GPP TS 33.233: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push function". +- [43] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +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]. + +**ProSe Function CTF (ADF):** Accounting Data Forwarding (ADF) function block of the Charging Trigger Function (CTF) in the ProSe Function. + +**Usage information report:** usage information related to one collection period. + +**Usage information report list:** one or more usage information report(s) and associated with a UE identity. + +**Not served by E-UTRAN:** the UE is either: + +- outside of E-UTRAN coverage; +- within E-UTRAN coverage but not camped on any cell; +- within E-UTRAN coverage but camped on a non-E-UTRAN cell; or +- camped on an E-UTRAN cell not operating on the carrier frequency provisioned for ProSe direct service. + +**Open ProSe direct discovery:** a type of ProSe direct discovery without explicit permission from the ProSe-enabled UE being discovered. + +**Restricted ProSe direct discovery:** a type of ProSe direct discovery that only takes place with explicit permission from the ProSe-enabled UE being discovered. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.303 [2] apply: + +**Local PLMN** +**ProSe-enabled UE** +**Geographical area** +**ProSe Query Code** +**ProSe Response Code** +**Discovery Query Filter** +**Discovery Response Filter** +**Restricted ProSe Application User ID** +**ProSe Discovery UE ID** +**Discovery Entry ID** +**ProSe Restricted Code** +**Relay Service Code** +**User Info ID** +**Discovery Group ID** +**ProSe Per-Packet Priority** +**ProSe Layer 2 Group ID** +**ProSe Per-Packet Reliability (PPPR)** +**ProSe UE-to-Network Relay** +**Remote UE** +**Application Layer Group ID** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.003 [4] apply: + +**ECGI** +**TMGI** + +## 3.2 Abbreviations + +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]. + +| | | +|--------|-------------------------------------------------------------------------------| +| ACE | Application-Controlled Extension | +| ADF | Accounting Data Forwarding function block | +| CTF | Charging Trigger Function | +| DUCK | Discovery User Confidentiality Key | +| DUIK | Discovery User Integrity Key | +| DUSK | Discovery User Scrambling Key | +| ECCSI | Elliptic Curve-based Certificateless Signatures for Identity-based Encryption | +| ECGI | E-UTRAN Cell Global Identification | +| FQDN | Fully Qualified Domain Name | +| GPI | GBA Push Information | +| MBMS | Multimedia Broadcast/Multicast Service | +| MIC | Message Integrity Check | +| MIME | Multi-Purpose Internet Mail Extensions | +| PDUID | ProSe Discovery UE ID | +| ProSe | Proximity-based Services | +| PRUK | ProSe Relay User Key | +| RPAUID | Restricted ProSe Application User ID | +| SAI | Service Area Identifier | +| SAKKE | Sakai-Kasahara Key Encryption | +| TMGI | Temporary Mobile Group Identity | +| TTL | Time To Live | +| UUID | Universally Unique Identifier | + +--- + +## 4 General + +### 4.1 Overview + +Proximity-based Services (ProSe) are services that can be provided by the 3GPP system based on UEs being in proximity to each other. In this release of the document, the 3GPP system enablers for ProSe include the following functions: + +- ProSe direct discovery (using E-UTRA or WLAN technology); +- ProSe direct communication; +- EPC-level ProSe discovery; and +- EPC support for WLAN direct discovery and communication. + +Among the above functions, ProSe direct discovery and EPC-level ProSe Discovery is applicable for both Public Safety UE and non-Public Safety UE. ProSe direct communication is applicable for Public Safety UE only. + +In this release of the document, the stand-alone procedure for EPC support for WLAN direct discovery and communication is not supported. + +The communication security over the PC3 interface is specified in 3GPP TS 33.303 [6]. The communication security over the PC3ch interface is the same as communication security over the PC3 interface specified in 3GPP TS 33.303 [6]. + +## 5 ProSe service authorisation and authorisation update procedure + +### 5.1 Service authorisation and authorisation update for ProSe direct discovery and ProSe direct communication + +#### 5.1.1 General + +The service authorisation for ProSe direct discovery and ProSe direct communication determines whether the UE is authorised to use ProSe direct discovery (based on E-UTRA or WLAN technology) and ProSe direct communication, in a particular PLMN or when not served by E-UTRAN. In this release of the specification, ProSe direct communication using E-UTRA technology is supported only for Public Safety ProSe-enabled UE. The service authorisation is either: + +- 1) pre-configured in the UE. The pre-configured service authorisation may be stored in the ME, or in the USIM as specified in 3GPP TS 31.102 [17], or in both the ME and the USIM. If both the ME and the USIM contain the same parameters, the values stored in the USIM shall take precedence. The UE shall not use the pre-configured service authorisation if the contents of the USIM indicate that the UE is not authorised to use them (see 3GPP TS 31.102 [17]); or +- 2) transferred between the UE and the ProSe Function over the PC3 interface with the ProSe Direct Services Provisioning Management Object or the ProSe Public Safety Direct Services Provisioning Management Object as specified in 3GPP TS 24.333 [9]. + +When using option 2) above, the UE shall request service authorisation to use ProSe direct discovery or ProSe direct communication or both from the ProSe Function of the HPLMN. As specified in 3GPP TS 29.345 [5], the ProSe Function of the HPLMN contacts the ProSe Function of each local PLMN or VPLMN to obtain the service authorisation, merges it with its own service authorisation and sends the merged service authorisation to the UE. + +NOTE 1: How the Prose Function in the HPLMN merges the authorisation policy is implementation dependent. + +The service authorisation provided by the ProSe Function of the HPLMN for E-UTRA-based ProSe direct discovery for non-public safety use contains a list of PLMNs in which the UE is authorised to use ProSe direct discovery. The service authorisation provided by the ProSe Function of the HPLMN for WLAN-based ProSe direct discovery for non-public safety use contains a list of PLMNs whose ProSe Application IDs the UE is authorised to use to perform WLAN-based ProSe direct discovery. + +The service authorisation provided by the ProSe Function of the HPLMN for ProSe direct discovery for public safety use indicates: + +- the list of PLMNs in which the UE is authorised to use ProSe direct discovery for public safety use when served by E-UTRAN; +- whether the UE is authorised to perform ProSe direct discovery for public safety use when not served by E-UTRAN, and if so, the required radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; +- the group member discovery related parameters; and +- the ProSe UE-to-network relay related parameters. + +NOTE 2: The provisioning and use of of radio parameters for ProSe direct discovery for public safety use as described in this clause does not apply to WLAN-based ProSe direct discovery. + +The service authorisation provided by the ProSe Function of the HPLMN for ProSe direct communication indicates: + +- whether the UE is authorised to perform ProSe direct communication when not served by E-UTRAN, and if so, the required radio parameters to be used for ProSe direct communication when not served by E-UTRAN; +- the ProSe direct communication policy parameters; +- the list of PLMNs in which the UE is authorised to use direct communication when served by E-UTRAN; and + +- the usage information reporting configuration. + +Alternatively, the ProSe direct communication policy parameters, the group member discovery related parameters and certain ProSe UE-to-network relay related parameters (i.e. items a, c and f in the parameters related to ProSe UE-to-network relaying in subclause 5.1.3) mentioned above can be provided by the third party public safety provider application server, using mechanisms that are out of scope of the present specification. If the UE receives the same parameters associated with the same Application Layer Group ID from the third party public safety provider application server as those which had been previously transferred between the UE and the ProSe Function over the PC3 interface with the ProSe Public Safety Direct Services Provisioning Management Object, the UE shall use the parameters provided by the third party public safety provider application server for ProSe direct communication. + +The UE discovers the IP address of the ProSe Functions of the HPLMN as specified in subclause 5.1.2. + +Optionally, the operator can configure the UE with configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. If the UE is configured with the configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function (see 3GPP TS 24.333 [9]): + +- a) if a PDN connection for reaching the HPLMN ProSe Function is not established yet, the UE shall establish the PDN connection for reaching the HPLMN ProSe Function according to the UE configuration and shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; and +- b) if a PDN connection for reaching the HPLMN ProSe Function is already established either due to other ProSe feature or due to other application, the UE shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function. + +After the UE is authorised to use ProSe direct discovery or ProSe direct communication or both, the ProSe Function of the HPLMN shall update the service authorisation: + +- a) when the ProSe Function of the HPLMN is informed the ProSe related subscription data is updated at the HSS; +- b) when the ProSe Function of the HPLMN decides to revoke the authorisation for ProSe direct service; +- c) when the ProSe Function of the HPLMN is informed the ProSe Function of the VPLMN or local PLMN decides to revoke the authorisation for ProSe direct service; or +- d) when the ProSe Function of the HPLMN decides to update the ProSe Discovery UE ID of the UE before the timer T4018 expires. + +The ProSe Function of the HPLMN sends the updated authorisation for ProSe direct service to the UE, e.g. by sending an OMA push message. If the update of service authorisation is triggered to revoke the authorisation for ProSe direct service, the updated authorization for ProSe direct service does not include: + +- a) the authorization for ProSe direct service (discovery or communication or both) which is to be revoked; and +- b) the PLMN ID of the PLMN in which the service authorisation is to be revoked. + +If the update of service authorisation is triggered to update the ProSe Discovery UE ID of the UE, the updated authorisation for ProSe direct service includes the new ProSe Discovery UE ID assigned to the UE and the associated validity timer T4015. The UE then sends the new ProSe Discovery UE ID to the ProSe Application Server, using mechanisms that are out of scope of the present specification. + +NOTE 3: The ProSe Function of the HPLMN can send the updated authorisation for ProSe direct service to the UE immediately or wait for the next time when the UE communicates with the ProSe Function of the HPLMN based on operator's policy; in the latter case, the UE is allowed to use ProSe direct services until the next time that it will communicate with the ProSe Function of the HPLMN. + +## 5.1.2 ProSe Function discovery + +The IP address of the ProSe function in the HPLMN may be pre-configured in the UE and in this case, the UE may use the pre-configured IP address. Alternatively, the FQDN of the ProSe Function in the HPLMN may be self-constructed by the UE, i.e. derived from the PLMN ID of the HPLMN. The UE may perform DNS lookup as specified in IETF RFC 1035 [10]. + +### 5.1.3 Service authorisation from ProSe Function + +The UE shall initiate the service authorisation procedure to the ProSe Function of the HPLMN: + +- a) when the UE receives a request from upper layer to perform open ProSe direct discovery announcing or monitoring, restricted ProSe direct discovery model A announcing or monitoring, restricted ProSe direct discovery model B discoverer operation or discoveree operation, or direct communication and has no valid service authorisation; +- b) when the UE is performing open ProSe direct discovery announcing or monitoring, restricted ProSe direct discovery model A announcing or monitoring, restricted ProSe direct discovery model B discoverer operation or discoveree operation, or direct communication and changes its registered PLMN to a PLMN which is not included in the list of PLMNs in which the UE is authorised to perform the corresponding service, and the request from upper layer to perform the corresponding service is still in place in the new registered PLMN; +- c) when timer T4005 associated with a valid service authorisation policy expires and the request from upper layer to perform open ProSe direct discovery announcing or monitoring, restricted ProSe direct discovery model A announcing or monitoring, restricted ProSe direct discovery model B discoverer operation or discoveree operation, or direct communication in the corresponding PLMN is still in place; or +- d) when timer T4015 associated with a ProSe Discovery UE ID expires and the request from upper layer to perform restricted ProSe direct discovery model A announcing or monitoring, restricted ProSe direct discovery model B discoverer operation or discoveree operation is still in place. + +NOTE 1: In order to ensure continuity of ProSe direct discovery service or ProSe direct communication service, the UE can request service authorisation from the ProSe Function of the HPLMN before the timer T4005 associated with a service authorisation policy in a PLMN expires or the timer 4015 associated with a ProSe Discovery UE ID expires. + +The UE shall obtain the service authorisation from the ProSe Function of the HPLMN over the PC3 interface by requesting the ProSe Direct Services Provisioning Management Object or the ProSe Public Safety Direct Services Provisioning MO as specified in 3GPP TS 24.333 [9]. The UE waits for an implementation dependent time for an answer from the ProSe Function. If the ProSe Function does not respond within that time, the UE may retry the service authorisation procedure. The number of retries performed by the UE is implementation dependent. Unless the UE receives a response from the ProSe function for service authorisation, the UE shall not consider that the request has been authorised. + +The ProSe direct discovery service authorisation from the ProSe Function of the HPLMN may include: + +- a) the PLMNs in which the UE is authorised to perform open ProSe direct discovery monitoring, and for each PLMN a timer T4005 indicating for how long the monitoring authorisation policy in that PLMN is valid; +- b) the PLMNs in which the UE is authorised to perform open ProSe direct discovery announcing , and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the announcing authorisation policy in that PLMN is valid; and + - 2) the authorised announcing range (short/medium/long). +- c) void; +- d) void; +- e) void; +- f) void; +- g) the PLMNs in which the UE is authorised to perform restricted ProSe direct discovery model A monitoring, and for each PLMN a timer T4005 indicating for how long the monitoring authorisation policy in that PLMN is valid; +- h) the PLMNs in which the UE is authorised to perform restricted ProSe direct discovery model A announcing, and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the announcing authorisation policy in that PLMN is valid; and + +- 2) the authorised announcing range (short/medium/long). +- i) the PLMNs in which the UE is authorised to perform restricted ProSe direct discovery model B discoverer operation, and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the discoverer operation authorisation policy in that PLMN is valid; and + - 2) the authorised discoverer operation range (short/medium/long). +- j) the PLMNs in which the UE is authorised to perform restricted ProSe direct discovery model B discoveree operation, and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the discoveree operation authorisation policy in that PLMN is valid; and + - 2) the authorised discoveree operation range (short/medium/long). +- k) the ProSe Discovery UE ID assigned to the UE for restricted ProSe direct discovery with an associated timer T4015 indicating for how long this ProSe Discovery UE ID is valid; and +- l) the PLMNs whose ProSe Application IDs the UE is authorised to use to perform WLAN-based ProSe direct discovery. + +The ProSe direct discovery for public safety use service authorisation from the ProSe Function of the HPLMN may include: + +- a) the PLMNs in which the UE is authorised to perform ProSe direct discovery for public safety use announcing, and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the authorisation policy for that operation is valid; and + - 2) the authorised announcing range (short/medium/long); +- b) whether the UE is authorised to perform ProSe direct discovery for public safety use announcing when the UE is not served by E-UTRAN; +- c) the PLMNs in which the UE is authorised to perform ProSe direct discovery for public safety use monitoring, and for each PLMN, a timer T4005 indicating for how long the authorisation policy for that operation is valid; +- d) whether the UE is authorised to perform ProSe direct discovery for public safety use monitoring when the UE is not served by E-UTRAN; +- e) the PLMNs in which the UE is authorised to perform ProSe direct discovery for public safety use discoverer operation, and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the authorisation policy for that operation is valid; and + - 2) the authorised discoveree operation range (short/medium/long); +- f) whether the UE is authorised to perform ProSe direct discovery for public safety use discoverer operation when the UE is not served by E-UTRAN; +- g) the PLMNs in which the UE is authorised to perform ProSe direct discovery for public safety use discoveree operation, and for each PLMN, it indicates: + - 1) a timer T4005 indicating for how long the authorisation policy for that operation is valid; and + - 2) the authorised discoverer operation range (short/medium/long); +- h) whether the UE is authorised to perform ProSe direct discovery for public safety use discoveree operation when the UE is not served by E-UTRAN; and +- i) the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN and the geographical area(s) in which the UE is allowed to use these radio parameters. + +NOTE 2: The provisioning and use of radio parameters for ProSe direct discovery for public safety use as described in this clause does not apply to WLAN-based ProSe direct discovery. + +NOTE 3: The authorised announcing range, authorised discoverer operation range and authorised discoveree operation range as indicated above and in this clause do not apply to WLAN-based ProSe direct discovery. When WLAN-based ProSe direct discovery is used the range is determined by the underlying WLAN technology. + +The ProSe direct discovery for public safety use service authorisation from the ProSe Function of the HPLMN may include the following parameters related to ProSe UE-to-network relaying: + +- a) the User Info ID for the UE-to-network relay discovery; +- b) the PLMNs in which the UE is authorised to act as a UE-to-network relay when the UE is served by E-UTRAN, and for each PLMN: + - 1) whether the relay needs to report the IMEI/IMEISV of the remote UE(s) connected to or disconnected from the relay; and + - 2) a timer T4005 indicating for how long the authorisation policy for that operation is valid; +- c) for each connectivity service provided by a UE-to-network relay: + - 1) the Relay Service Code identifying the connectivity service; + - 2) optionally the PDN type to be used for the relayed traffic of the connectivity service. If the PDN type is not provisioned, the IPv4v6 is used for the relayed traffic of the connectivity service; + - 3) optionally the APN to be used for the relayed traffic of the connectivity service. If the APN is not provisioned, the default APN is used for the relayed traffic of the connectivity service; + - 4) the ProSe Relay UE ID; and + - 5) the address of the ProSe Key Management Function that the UE shall use to obtain security contents; +- d) whether the UE is authorised to act as a remote UE towards a UE-to-network relay; +- e) void; +- f) for each connectivity service authorised to be accessed by the remote UE: + - 1) the Relay Service Code identifying the connectivity service; + - 2) the IP version(s) to be used for the traffic of the connectivity service; + - 3) optionally the User Info ID of the UE-to-network relay providing the connectivity service; and + - 4) the address of the ProSe Key Management Function that the UE shall use to obtain security contents; and +- g) mapping rules between the QCI of EPS bearer and the ProSe Per-Packet Priority for downlink unicast traffic relayed over the PC5 interface. + +The ProSe direct discovery for public safety use service authorisation from the ProSe Function of the HPLMN may include the following parameters related to group member discovery, for each application layer group: + +- a) the User Info ID for the group member discovery; +- b) the Discovery Group ID identifying the discovery group; +- c) the Application Layer Group ID identifying an application layer group that the UE belongs to; and +- d) the address of the ProSe Key Management Function that the UE shall use to obtain security contents. + +The one-to-many ProSe direct communication service authorisation from the ProSe Function of the HPLMN may include: + +- a) whether the UE is authorised to perform one-to-many ProSe direct communication when not served by E-UTRAN; +- b) the radio parameters to be used for one-to-many ProSe direct communication when not served by E-UTRAN as defined in 3GPP TS 36.331 [12] and the geographical area(s) in which the UE is allowed to use these radio parameters; +- c) the PLMNs in which the UE is authorised to perform one-to-many ProSe direct communication when served by E-UTRAN, and for each PLMN a timer T4005 indicating for how long the one-to-many direct communication authorisation policy in that PLMN is valid; and +- d) the one-to-many ProSe Direct communication policy parameters, consisting of, for each application layer group: + - 1) the ProSe Layer-2 Group ID; + - 2) the ProSe Group IP multicast address; + - 3) whether the UE should use IPv4 or IPv6 for that group; + - 4) an IPv4 address to be used by the UE as a source address in case IPv4 is used; + - 5) the address of the ProSe Key Management Function that the UE shall use to obtain group-related security contents; and + - 6) the Application Layer Group ID identifying an application layer group that the UE belongs to; and +- e) the usage information reporting configuration, including: + - 1) the address of the server to which the UE shall upload the usage information reports; + - 2) the collection period; + - 3) the reporting window; + - 4) whether or not the UE shall report the Group Parameters in the usage information; + - 5) whether or not the UE shall report the time stamps of the first transmission/reception during the collection period in the usage information; + - 6) whether or not the UE shall report the amount of data transmitted during the collection period in the usage information, and whether with location information; + - 7) whether or not the UE shall report the amount of data received during the collection period in the usage information, and whether with location information; + - 8) whether or not the UE shall report the time stamps when it went in and out of E-UTRAN coverage during the collection period in the usage information; + - 9) whether or not the UE shall report the list of locations of the UE when in E-UTRAN coverage during the reporting period in the usage information; and + - 10) whether or not the UE shall report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information. + +The one-to-one ProSe direct communication service authorisation from the ProSe Function of the HPLMN may include: + +- a) whether the UE is authorised to perform one-to-one ProSe direct communication when not served by E-UTRAN; +- b) the radio parameters to be used for one-to-one ProSe direct communication when not served by E-UTRAN as defined in 3GPP TS 36.331 [12] and the geographical area(s) in which the UE is allowed to use these radio parameters; +- c) the PLMNs in which the UE is authorised to perform one-to-one ProSe direct communication when served by E-UTRAN, and for each PLMN a timer T4005 indicating for how long the one-to-one direct communication authorisation policy in that PLMN is valid; and +- d) the one-to-one ProSe direct communication policy parameters, consisting of: + +- the ProSe Per-Packet Priority value for PC5 signalling messages; and +- for each application layer group, + - 1) the Layer 2 ID used for unicast communication; + - 2) void; + - 3) the address of the Key Management Server that the UE shall use to obtain security contents; and + - 4) the Application Layer Group ID identifying an application layer group that the UE belongs to. + +NOTE 4: ProSe communication operation is not applicable to local PLMNs. + +The ProSe Function of the HPLMN is allowed to take the serving PLMN of the UE into account when including the authorised PLMNs in the service authorisation to the UE. + +The UE shall start the timer(s) T4005 with the values included in this service authorisation. The UE shall consider that an authorisation policy is valid in the associated PLMN until the corresponding timer T4005 expires or is stopped. + +--- + +## 6 ProSe direct discovery + +### 6.1 Overview + +This clause describes the PC3 Control Protocol procedures between the UE and the ProSe Function for ProSe direct discovery announcing and monitoring. It also describes the ProSe Protocol procedures at the UE for ProSe direct discovery of other ProSe-enabled UEs over the PC5 interface. + +#### 6.1.1 Transport protocol for PC3 Control Protocol messages for ProSe direct discovery + +The UE and ProSe Function shall use HTTP 1.1 as specified in IETF RFC 7230 [18] and IETF RFC 7231 [19] as the transport protocol for ProSe messages over the PC3 interface. The ProSe messages described here shall be included in the body of either an HTTP request message or an HTTP response message. The following rules apply: + +#### 6.1.2 Handling of UE-initiated procedures + +The following rules apply for UE-initiated procedures: + +- The UE initiates ProSe transactions with an HTTP request message containing the PC3 request(s); +- The ProSe Function responds to the requests with an HTTP response message containing the PC3 response(s) for the PC3 request(s); and +- HTTP POST methods are used for PC3 direct discovery procedures. + +Optionally, the operator can configure the UE with configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. If the UE is configured with the configuration parameter for establishment of the PDN connection for reaching the HPLMN ProSe Function (see 3GPP TS 24.333 [9]): + +- a) if a PDN connection for reaching the HPLMN ProSe Function is not established yet, the UE shall establish the PDN connection for reaching the HPLMN ProSe Function according to the UE configuration and shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; and +- b) if a PDN connection for reaching the HPLMN ProSe Function is already established (e.g. either due to other ProSe feature or due to other application), the UE shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; + +## 6.1.3 Handling of ProSe Function-initiated procedures + +### 6.1.3.1 General + +The ProSe Function-initiated messages for ProSe direct discovery over the PC3 interface shall be contained in an HTTP response message. Either HTTP long polling, or OMA Push, can be used to trigger the HTTP request corresponding to this HTTP response message. The UE and the ProSe Function shall support OMA Push for network initiated procedures. Optionally the UE and ProSe Function should support long polling as well for network initiated procedures. + +If the UE supports the HTTP long polling, the UE shall include a Network-Initiated Transaction Method set to "HTTP long polling" in the DISCOVERY\_REQUEST message to the ProSe Function. + +Upon receiving a DISCOVERY\_REQUEST message containing a Network-Initiated Transaction Method set to "HTTP long polling", if the ProSe Function supports the HTTP long polling and wants to use the HTTP long polling for network initiated procedures, the ProSe Function shall include a Network-Initiated Transaction Method set to "HTTP long polling" in the DISCOVERY\_RESPONSE message. Otherwise the ProSe Function shall not include a Network-Initiated Transaction Method in the DISCOVERY\_RESPONSE message. + +If the UE receives a DISCOVERY\_RESPONSE message including a Network-Initiated Transaction Method set to "HTTP long polling", the UE shall use the HTTP long polling for network initiated procedures. Otherwise, the UE shall assume that the ProSe Function uses OMA Push for network initiated procedures. + +### 6.1.3.2 HTTP long polling + +The HTTP long polling method involves the following steps: + +- a) the UE sends an empty HTTP request message as a polling request when it expects network initiated message(s) over the PC3 interface; +- b) the ProSe Function defers its response to the UE's request until; + - i) one or more network-initiated PC3 message(s) for the UE are available. The ProSe Function encloses the message(s) in an HTTP response message and send it to the UE; or + - ii) a particular timeout for HTTP polling has occurred. The ProSe Function then sends an empty HTTP response message as the polling response to the UE. +- c) After receiving the response from the ProSe Function, the UE may keep polling after some waiting period if: + - i) the UE receives an empty polling response; or + - ii) the UE receives prose function-initiated message(s) from the ProSe Function but still expects additional network-initiated message(s). + +NOTE: The implementation of the HTTP polling process can be coordinated with the SUPL (Secure User Plane Location) procedures to synchronize the SUPL location report procedures and the HTTP polling procedure so as to reduce unnecessary wait time of polling. + +If the UE is triggered to send a PC3 message to the ProSe Function while it has a pending HTTP polling request, the UE shall open another HTTP connection to the ProSe Function to send this new request. Alternately the UE may always use a separate dedicated HTTP connection for polling. + +### 6.1.3.3 OMA Push + +The OMA Push method involves the following steps: + +- a) if one or more network-initiated PC3 message(s) for the UE are available, the ProSe Function sends a push message containing a particular URL to the UE via the OMA-Push Architecture as defined in [OMA-AD-Push-V2\\_2-20110809-A](#) [22]. The URL is linked to the PC3 message(s) to be sent to the UE. The ProSe Function (performing OMA Push Proxy Gateway functionality) generates a Push Message as specified in [OMA-WAP-TS-PushOTA-V2\\_1-20110405-A](#) [21] with the PDU set according to [WAP-168-ServiceLoad-20010731-a](#) [20]. The URL information shall be included in the PDU payload; +- b) After receiving the push message, the UE retrieves the URL from the payload of the message and sends an HTTP GET request to the ProSe Function with this URL; and + +- c) the ProSe Function sends an HTTP response message containing the PC3 message(s) to the UE. + +## 6.2 Procedures + +### 6.2.1 Types of ProSe direct discovery procedures + +The following PC3 Control Protocol procedures are defined: + +- announce request; +- monitor request; +- match report; and +- network initiated direct discovery update. + +In the following descriptions of PC3 Control Protocol procedures, the terms "request" and "response" refer to the corresponding PC3 Control Protocol messages, not to the HTTP request or response. The following procedure descriptions use a single PC3 Control Protocol message for illustration purposes. + +NOTE: A single HTTP request message can contain multiple PC3 Control Protocol requests and a single HTTP response message can contain multiple PC3 Control Protocol responses. + +### 6.2.2 Announce request procedure for open ProSe direct discovery + +#### 6.2.2.1 General + +The purpose of the announce request procedure for open ProSe direct discovery is for the UE: + +- to obtain one or more ProSe Application Code(s) to be announced over the PC5 interface, upon a request for announcing from upper layers as defined in 3GPP TS 23.303 [2]; +- to inform the ProSe Function that the UE wants to stop announcing a ProSe Application Code as defined in 3GPP TS 23.303 [2]; or +- to upload metadata associated with a ProSe Application ID to the ProSe Function as defined in 3GPP TS 23.303 [2]. + +The UE shall be authorised for open ProSe direct discovery announcing in the registered PLMN or the local PLMN based on the service authorisation procedure as specified in clause 5, before initiating the announce request procedure. + +NOTE: The notion of "local PLMN" does not apply for WLAN-based ProSe direct discovery. The UE can engage in WLAN-based ProSe direct discovery as announcing UE regardless of the serving PLMN or other PLMNs that provide E-UTRAN coverage in the UE location. + +The UE includes one of the ProSe Application Code(s) obtained as a result of a successful announce request procedure per PC5\_DISCOVERY message and passes the PC5\_DISCOVERY messages to the lower layers for transmission over the PC5 interface. + +#### 6.2.2.2 Announce request procedure initiation + +Before initiating the announce request procedure for open ProSe direct discovery, the UE is configured with the data structure of the ProSe Application IDs appropriate for its HPLMN. This step is performed using mechanisms out of scope of 3GPP. + +If the UE is authorised to perform E-UTRA-based open ProSe direct discovery announcing in the PLMN operating the radio resources signalled from the serving PLMN, or if the UE is authorised to perform WLAN-based open ProSe direct discovery, it shall initiate an announce request procedure: + +- a) when the UE is triggered by an upper layer application to announce a ProSe Application ID and the UE has no valid corresponding ProSe Application Code for that upper layer application; +- b) when the validity timer T4000 assigned by the ProSe Function to a ProSe Application Code has expired and the request from upper layers to announce the ProSe Application ID corresponding to that ProSe Application Code is still in place; + +- c) when the UE selects a new PLMN while announcing a ProSe Application Code and intends to announce in the new PLMN, and the UE is authorised for open ProSe direct discovery announcing in the new PLMN; +- d) when, while announcing a ProSe Application ID, the UE intends to switch the announcing PLMN to a different PLMN without performing PLMN selection, and the UE does not have a valid allocated ProSe Application Code for this new PLMN yet; or +- e) when the UE needs to inform the ProSe Function that the UE wants to stop announcing a ProSe Application Code; or +- f) when the UE needs to update metadata associated with a ProSe Application ID to the ProSe Function. + +When the UE selects a new PLMN while announcing a ProSe Application Code and the UE is not yet authorised for open ProSe direct discovery announcing in the new PLMN, the UE shall initiate an announce request procedure only after the UE is authorised for open ProSe direct discovery announcing in the new PLMN. + +NOTE 1: To ensure service continuity if the UE needs to keep announcing a ProSe Application Code corresponding to the same ProSe Application ID, the UE can initiate the announce request procedure before the TTL timer T4000 assigned by the ProSe Function for a Prose Application Code expires. + +The UE initiates the announce request procedure for open ProSe direct discovery by sending a DISCOVERY\_REQUEST message with: + +- a new transaction ID; +- the ProSe Application ID set to the ProSe Application ID received from upper layers; +- the command set to "metadata\_update" if the UE has a valid ProSe Application Code corresponding to the ProSe Application ID and intends to update metadata associated with the ProSe Application ID to the ProSe Function, otherwise set to "announce"; +- the UE identity set to the UE's IMSI; +- the Application Identity set to the Application Identity of the upper layer application that requested the announcing; +- the Discovery Entry ID set to 0 when this is a new request or set to the Discovery Entry ID received from the ProSe Function if the announce request is to update a previously sent announce request; +- the ACE Enabled Indicator set to "application-controlled extension enabled" if application-controlled extension is required by the upper layers or "normal" if application-controlled extension is not used; +- optionally the Requested Timer set to the length of validity timer associated with the ProSe Application Code that the UE expects to receive from the ProSe Function; +- optionally the Metadata set to the metadata received from upper layers associated with the ProSe Application ID; +- optionally in case of E-UTRA-based open ProSe direct discovery the Announcing PLMN ID set to the PLMN ID of the local PLMN operating the radio resources that the UE intends to use for announcing this ProSe Application ID; and +- optionally the PC5\_tech set to the PC5 radio technology that the UE wishes to use. PC5\_tech may include more than one PC5 radio technology. + +If open ProSe direct discovery with application-controlled extension is requested by upper layers, the DISCOVERY\_REQUEST message shall also include the Application Level Container, which contains application-level data transparent to the 3GPP network, to be used by the ProSe Application Server e.g. to assign ProSe Application Code Suffix(es). + +When the UE initiates the announce request procedure to inform the ProSe Function that the UE wants to stop announcing a ProSe Application Code before the associated valid timer expires, the UE shall set the Requested Timer to 0. + +NOTE 2: A UE can include one or multiple transactions in one DISCOVERY\_REQUEST message for different ProSe Application IDs, and receive corresponding element or element in a DISCOVERY\_RESPONSE message for each respective transaction. In the following description of the announce request procedure, only one transaction is included. + +Figure 6.2.2.2.1 illustrates the interaction of the UE and the ProSe Function in the announce request procedure. + +![Sequence diagram illustrating the announce request procedure between a UE and a ProSe Function. The diagram is split into two parts by a dashed line labeled 'OR'. The top part shows a successful procedure: the UE sends a DISCOVERY_REQUEST to the ProSe Function, and the ProSe Function responds with a DISCOVERY_RESPONSE (response-announce). The bottom part shows a rejected procedure: the UE sends a DISCOVERY_REQUEST to the ProSe Function, and the ProSe Function responds with a DISCOVERY_RESPONSE (response-reject).](759c7d62402f0b4651ddce292be5bdef_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSeFunction as ProSe Function + Note left of UE: Start 4000 + UE->>ProSeFunction: DISCOVERY_REQUEST + ProSeFunction-->>UE: DISCOVERY_RESPONSE (response-announce) + Note right of ProSeFunction: Start 4001 + Note over UE, ProSeFunction: OR + Note left of UE: Start 4000 + UE->>ProSeFunction: DISCOVERY_REQUEST + ProSeFunction-->>UE: DISCOVERY_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the announce request procedure between a UE and a ProSe Function. The diagram is split into two parts by a dashed line labeled 'OR'. The top part shows a successful procedure: the UE sends a DISCOVERY\_REQUEST to the ProSe Function, and the ProSe Function responds with a DISCOVERY\_RESPONSE (response-announce). The bottom part shows a rejected procedure: the UE sends a DISCOVERY\_REQUEST to the ProSe Function, and the ProSe Function responds with a DISCOVERY\_RESPONSE (response-reject). + +Figure 6.2.2.2.1: Announce request procedure + +### 6.2.2.3 Announce request procedure accepted by the ProSe Function + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "announce", if the Requested Timer is included in the DISCOVERY\_REQUEST message and the Requested Timer is set to 0, the ProSe Function shall check whether there is an existing UE context containing the discovery entry identified by the Discovery Entry ID included in the DISCOVERY\_REQUEST message. If the discovery entry exists in the UE context, the ProSe Function shall inform the ProSe Function in the announcing PLMN to remove the corresponding discovery entry as specified in 3GPP TS 29.345 [5] when the announcing PLMN is not the same as that of the PLMN to which the ProSe Function belongs and remove the discovery entry identified by the Discovery Entry ID from the UE's context. Then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message, and +- the Discovery Entry ID set to the identifier associated with the corresponding discovery entry. + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "announce", if the Requested Timer is not included in the DISCOVERY\_REQUEST message or the Requested Timer included in the DISCOVERY\_REQUEST message is not set to 0, the ProSe Function shall perform the following procedure. + +The ProSe Function shall check that the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is authorised for open ProSe direct discovery announcing. If the application is authorised for open ProSe direct discovery announcing, the ProSe Function may also check whether the ProSe Application ID contained in the DISCOVERY\_REQUEST message is known. If the ProSe Application ID is known or the ProSe Function skips the check of the ProSe Application ID, the ProSe Function shall check whether there is an existing context for the UE associated with the requested ProSe Application ID. + +If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for open ProSe direct discovery announcing as described in 3GPP TS 29.344 [3]. If the check indicates that the UE is authorised then: + +- the ProSe Function shall check whether the UE is authorised to announce the ProSe Application ID contained in the DISCOVERY\_REQUEST message; +- if the UE is authorised to announce the ProSe Application ID, the ACE Enabled Indicator is included and set to "application-controlled extension enabled", the Application Level Container is included in the DISCOVERY\_REQUEST message and the requested application uses application-controlled extension, the ProSe Function shall check whether the UE is authorised to use ACE. If the UE is authorised for ACE, the ProSe Function shall invoke the procedure described in 3GPP TS 29.343 [31] to check whether the UE is authorised to announce the requested ProSe Application ID with application-defined suffix(es), and obtain suffix-related information from the ProSe Application Server. The ProSe Function shall then allocate one ProSe Application Code Prefix and a value for validity timer T4000 to be used with the ProSe Application Code Suffix(es) obtained from the ProSe Application Server for the given ProSe Application ID as specified in 3GPP TS 29.343 [31]. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message; +- if the UE is authorised to announce the ProSe Application ID, the ACE Enabled Indicator is included and set to "normal" in the DISCOVERY\_REQUEST message and the requested application does not use application-controlled extension, the ProSe Function shall allocate the corresponding ProSe Application Code(s) and a value for validity timer T4000. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message; +- if the UE is authorised to announce the ProSe Application ID, the ACE Enabled Indicator is set included and to "normal" in the DISCOVERY\_REQUEST message, the Application Level Container is included in the DISCOVERY\_REQUEST and the requested application only uses application-controlled extension, the ProSe Function shall check whether the UE is authorised to use ACE. If the UE is authorised for ACE, the ProSe Function shall invoke the procedure described in 3GPP TS 29.343 [31] to check whether the UE is authorised to announce the requested ProSe Application ID with application-defined suffix(es), and obtain suffix-related information from the ProSe Application Server. The ProSe Function shall then allocate one ProSe Application Code Prefix and a value for validity timer T4000 to be used with the ProSe Application Code Suffix(es) obtained from the ProSe Application Server for the given ProSe Application ID as specified in 3GPP TS 29.343 [31]. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message; +- if the UE is authorised to announce the ProSe Application ID, the ACE Enabled Indicator is included and set to "application-controlled-extension enabled" and the Application Level Container is included in the DISCOVERY\_REQUEST message but the requested application does not use application-controlled extension, the ProSe Function shall allocate the corresponding ProSe Application Code(s) and a value for validity timer T4000. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message; and +- if the UE is authorised to announce the ProSe Application ID and the ACE Enabled Indicator is not included in the DISCOVERY\_REQUEST message, the ProSe Function shall allocate the corresponding ProSe Application Code(s) and a value for validity timer T4000. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message. + +NOTE 1: A UE implementing a previous release of the protocol will not include the ACE Enabled Indicator in the DISCOVERY\_REQUEST message. + +NOTE 2: The ProSe Function can allocate multiple ProSe Application Codes for a given ProSe Application ID for instance in the case when one or more labels in the ProSe Application ID Name are wild carded as described in subclause 24.2.2 of 3GPP TS 23.003 [4]. + +If the requested ProSe Application ID is country-specific or global as described in subclause 24.2 of 3GPP TS 23.003 [4], the ProSe Function shall allocate the corresponding ProSe Application Code(s) or ProSe Application Code Prefix according to subclause 24.3 of 3GPP TS 23.003 [4]. The temporary identity part of each ProSe Application Code or ProSe Application Code Prefix is taken from the data structure corresponding to the country-specific or global ProSe Application ID namespace according to subclause 24.3 of 3GPP TS 23.003 [4]. The ProSe Function shall use the MCC and MNC of the PLMN ID of this ProSe Function for the PLMN ID part of the ProSe Application Code or ProSe Application Code Prefix. + +After the ProSe Application Code(s) or ProSe Application Code Prefix allocation, the ProSe Function then associates the ProSe Application Code(s) or ProSe Application Code Prefix with a new discovery entry identified by a non-zero value Discovery Entry ID in the new context for the UE that contains the UE's subscription parameters obtained from the HSS, and starts timer T4001. The HSS also provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. For a given set of ProSe Application Codes or the allocated ProSe Application Code Prefix, timer T4001 shall be longer than timer T4000. By default, the value of timer T4001 is 4 minutes greater than the value of timer T4000. + +If there is an existing context for the UE that contains the UE's subscription parameters obtained from the HSS, but no discovery entry identified by the Discovery Entry ID contained in the DISCOVERY\_REQUEST message, the ProSe Function shall behave as if the Discovery Entry ID included in the DISCOVERY\_REQUEST message was set to 0, and the ProSe Function shall allocate a new non-zero Discovery Entry ID for this entry. + +If the Metadata is included in the DISCOVERY\_REQUEST message, the ProSe Function shall allocate the ProSe Application Code or ProSe Application Code Prefix including a Metadata Index to indicate the current version of the Metadata, and store the received metadata in the UE context. + +Moreover, if the command is set to "metadata\_update" in the DISCOVERY\_REQUEST message and there is an existing UE context stored in the ProSe Function, the ProSe Function shall update the metadata in the UE context by using the received Metadata in the DISCOVERY\_REQUEST message, and update the ProSe Application Code or ProSe Application Code Prefix in the UE context by changing the Metadata Index portion and keeping the rest unchanged. + +After the ProSe Application Code(s) allocation, the ProSe Function then associates the ProSe Application Code(s) with a new discovery entry identified by a non-zero value Discovery Entry ID in the UE context, and starts timer T4001. + +If there is an existing context for the UE and a discovery entry identified by the Discovery Entry ID contained in the DISCOVERY\_REQUEST message associated with the requested ProSe Application ID, the ProSe Function shall either update the discovery entry with a new validity timer T4000, or allocate new ProSe Application Code(s) or ProSe Application Code Prefix for the requested ProSe Application ID with a new validity timer T4000, and restart timer T4001. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message. + +If a new discovery entry was created or an existing discovery entry was updated and the UE is currently roaming or the Announcing PLMN ID is included in the DISCOVERY\_REQUEST message, the ProSe Function checks with the ProSe Function of the VPLMN or in case of E-UTRA-based open ProSe direct discovery the local PLMN identified by the Announcing PLMN ID whether the UE is authorised for open ProSe direct discovery announcing as described in 3GPP TS 29.345 [5]. + +If the check indicates that the UE is authorised then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message from the UE; +- either the ProSe Application Code(s) set to the ProSe Application Code(s) allocated by the ProSe Function, or the ProSe Application Code ACE parameter set to include the ProSe-Application Code- Prefix allocated by the ProSe Function, and one or more ProSe Application Code Suffix Ranges which contain the suffix(es) for the ProSe Application ID received in the DISCOVERY\_REQUEST message from the UE; +- Validity Timer T4000 set to the T4000 timer value assigned by the ProSe Function to the ProSe Application Code(s); +- if the ACE Enabled Indicator was included by the UE in the DISCOVERY\_REQUEST message, the ACE Enabled Indicator set to: + - "application-controlled extension enabled" if application-controlled extension is used; or + - "normal" if application-controlled extension is not used; +- the Discovery Entry ID set to the identifier associated with the corresponding discovery entry; +- the Discovery Key set to a value provided by the ProSe Function; and + +- optionally the PC5\_tech set to the one or more PC5 radio technologies that are authorized to be used for the assigned ProSe Application Code(s) or the assigned ProSe-Application Code- Prefix and the ProSe Application Code Suffix Ranges. + +If timer T4001 expires, the ProSe Function shall remove the discovery entry identified by the Discovery Entry ID from the UE's context. + +#### 6.2.2.4 Announce request procedure completion by the UE + +Upon receipt of the DISCOVERY\_RESPONSE message, if only the transaction ID and the Discovery Entry ID are contained in the element and the transaction ID and the Discovery Entry ID match the corresponding values sent by the UE in a DISCOVERY\_REQUEST message, the UE shall: + +- stop the validity timer T4000 corresponding to the ProSe Application Code(s) or ProSe Application Code Prefix in the discovery entry identified by the Discovery Entry ID; +- remove the discovery entry identified by the Discovery Entry ID included; and +- instruct the lower layers to stop announcing. + +Upon receipt of the DISCOVERY\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a DISCOVERY\_REQUEST message with the command set to "announce", the UE shall create a new discovery entry or update an existing discovery entry with the received ProSe Application Code(s) and the PLMN ID of the intended announcing PLMN. For this discovery entry, the UE shall stop the validity timer T4000 if running and start the validity timer T4000 with the received value. Otherwise the UE shall discard the DISCOVERY\_RESPONSE message and shall not perform the procedures below. + +For any one of the received ProSe Application Codes or ProSe Application Code Prefix in this discovery entry, the UE may perform open ProSe direct discovery announcing as described below. + +The UE requests the parameters from the lower layers for Prose direct discovery announcing (see 3GPP TS 36.331 [12]). In case of E-UTRA-based open ProSe direct discovery the UE shall perform direct discovery announcing only if the lower layers indicate that ProSe direct discovery is supported by the network. In case of E-UTRA-based open ProSe direct discovery if the UE in EMM-IDLE mode has to request resources for ProSe direct discovery announcing as specified in 3GPP TS 36.331 [12], the UE shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]. The UE shall obtain the UTC time for the next discovery transmission opportunity for ProSe direct discovery from the lower layers. + +If a valid UTC time is obtained, the UE shall generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18. If the resulting UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE, the UE shall use the UTC-based counter and the Discovery Key contained in the element of the DISCOVERY\_RESPONSE message to compute the MIC field for the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. + +The UE shall either use the ProSe Application Code received in the DISCOVERY\_RESPONSE message, or select one ProSe Application Code based on the ProSe Application Code Prefix and ProSe Application Code Suffix Range(s) received in the DISCOVERY\_RESPONSE message as announced ProSe Application Code, along with the MIC and the four least significant bits of the UTC-based counter, in order to construct a PC5\_DISCOVERY message, according to the format defined in subclause 11.2.5. + +- NOTE: The UE can use different codes formed based on different ProSe Application Code Suffixes to announce, without having to send a new DISCOVERY\_REQUEST message to the ProSe Function, as long as the validity timer T4000 of the ProSe Application Code Prefix has not expired. + +The UE then passes the PC5\_DISCOVERY message, along with the PLMN ID of the intended announcing PLMN, to the lower layers for transmission if: + +- the UE is currently authorised to perform open direct discovery announcing in the registered PLMN or in case of E-UTRA-based open ProSe direct discovery the local PLMN operating the radio resources that the UE intends to use; +- the validity timer T4000 for the corresponding discovery entry allocated ProSe Application Code or ProSe Application Code Prefix has not expired; and + +- a request from upper layers to announce the ProSe Application ID associated with both the ProSe Application Code or ProSe Application Code Prefix and the authorised Application Identity is still in place. + +The UE shall ensure that it keeps on passing PC5\_DISCOVERY messages to the lower layers for transmission until the validity timer T4000 of the ProSe Application Code or ProSe Application Code Prefix expires. How this is achieved is left up to UE implementation. + +During the announcing operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop announcing. When the UE stops announcing, in case of E-UTRA-based open ProSe direct discovery if the lower layers indicate that the UE is required to send a discovery indication to the eNodeB and the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +### 6.2.2.5 Announce request procedure not accepted by the ProSe Function + +If the DISCOVERY\_REQUEST message cannot be accepted by the ProSe Function, the ProSe Function sends a DISCOVERY\_RESPONSE message containing a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is not authorised for open ProSe direct discovery announcing, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid application". + +If the ProSe Application ID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #2 "Unknown ProSe Application ID". + +If the UE is not authorised for open ProSe direct discovery announcing, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the UE is not authorised to use the ProSe Application ID contained in the DISCOVERY\_REQUEST message, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the UE requests a country-specific ProSe Application ID for a country that does not correspond to the country of its HPLMN, and the ProSe Function has not authorized the UE to announce in that country, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #8 "Scope Violation in Prose Application ID". + +If the UE requests a country-specific ProSe Application ID for a country that does not correspond to the country of its HPLMN, and the ProSe Function has no agreement to access the country-wide ProSe Application ID database of that country, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #8 "Scope Violation in Prose Application ID". + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function and the Requested Timer is set to zero, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or invalid Discovery Entry ID". + +If the UE is not authorised to use ACE, but the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #12 "UE unauthorised for discovery with Application-Controlled Extension". + +If the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", but does not contain the Application Level Container parameter, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #14 "Missing Application Level Container". + +If the ProSe Application Server indicates to the ProSe Function that the Application Level Container in the DISCOVERY\_REQUEST message contains invalid information, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #15 "Invalid Data in Application Level Container". + +If the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", but does not contain the Application Level Container parameter, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #14 "Missing Application Level Container". + +If the DISCOVERY\_REQUEST message does not contain the ACE Enabled Indicator and the requested application only uses application-controlled extension, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid Application". + +## 6.2.2.6 Abnormal cases + +### 6.2.2.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_REQUEST message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the announce request procedure. + +- b) No response from the ProSe Function after the DISCOVERY\_REQUEST message has been successfully delivered (e.g. TCP ACK has been received for the DISCOVERY\_REQUEST message) + +The UE shall retransmit the DISCOVERY\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Indication from upper layers that the request to announce the ProSe Application ID is no longer in place after sending the DISCOVERY\_REQUEST message, but before the announce request procedure is completed + +The UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its contents and then abort the procedure. + +- d) Change of PLMN + +If a PLMN change occurs before the announce request procedure is completed, the procedure shall be aborted. If the UE is authorized to announce in the new PLMN, the procedure shall be restarted once the UE is registered on the new PLMN. + +- e) Absence of Discovery Entry ID parameter in a DISCOVERY\_RESPONSE message received in response to a DISCOVERY\_REQUEST message which contained a Discovery Entry ID parameter + +If the DISCOVERY\_REQUEST message: + +- included a Requested Timer which is set to 0; or +- included an Announcing PLMN ID; + +the UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its content and then abort the procedure. + +### 6.2.2.6.2 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_RESPONSE message + +After receiving an indication from lower layer that the DISCOVERY\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the ProSe Function shall abort the procedure, and stop any associated timer(s) T4001, if running. + +## 6.2.2A Announce request procedure for restricted ProSe direct discovery model A + +### 6.2.2A.1 General + +The purpose of the announce request procedure for restricted ProSe direct discovery model A is for the UE: + +- to obtain a ProSe Restricted Code corresponding to the Restricted ProSe Application User ID (RPAUID) to be announced over the PC5 interface, upon a request for announcing from upper layers (e.g., application client) as defined in 3GPP TS 23.303 [2]; or +- to inform the ProSe Function that the UE wants to stop announcing a ProSe Restricted Code as defined in 3GPP TS 23.303 [2]. + +Before initiating the announce request procedure, the UE shall be authorised for restricted ProSe direct discovery model A announcing in the registered PLMN or local PLMN based on the service authorisation procedure as specified in clause 5. + +NOTE: The notion of "local PLMN" does not apply for WLAN-based ProSe direct discovery. The UE can engage in WLAN-based ProSe direct discovery as announcing UE regardless of the serving PLMN or other PLMNs that provide E-UTRAN coverage in the UE location. + +The UE includes the ProSe Restricted Code obtained as a result of a successful announce request procedure in a PC5\_DISCOVERY message and passes the PC5\_DISCOVERY message to the lower layers for transmission over the PC5 interface. + +### 6.2.2A.2 Announce request procedure initiation + +Before initiating the announce request procedure, the user sets the permissions for the restricted discovery using application layer mechanisms. The application client in the UE retrieves the PDUID provisioned to the UE as part of the service authorisation procedure as specified in clause 5 and obtains an RPAUID associated with the UE's PDUID from the ProSe Application Server. The UE may provide metadata to be associated with the RPAUID, and the ProSe Application Server stores the metadata. This step is performed using mechanisms that are out of scope of the present specification. + +If the UE is authorised to perform E-UTRA-based restricted ProSe direct discovery model A announcing in the PLMN operating the radio resources signalled from the serving PLMN, or if the UE is authorised to perform WLAN-based restricted ProSe direct discovery model A, it shall initiate an announce request procedure: + +- when the UE is triggered by an upper layer application to announce an RPAUID and the UE has no valid corresponding ProSe Restricted Code for that RPAUID of the upper layer application; +- when the validity timer T4007 assigned by the ProSe Function to a ProSe Restricted Code has expired and the request from upper layers to announce the RPAUID corresponding to that ProSe Restricted Code is still in place; +- when the UE selects a new PLMN while announcing a ProSe Restricted Code and intends to announce in the new PLMN, and the UE is authorised for restricted ProSe direct discovery model A announcing in the new PLMN; +- when, while announcing a RPAUID, the UE intends to switch the announcing PLMN to a different PLMN without performing PLMN selection, and the UE does not have a valid allocated ProSe Restricted Code for this new PLMN yet; or +- when the UE needs to update a previously sent restricted ProSe direct discovery model A announcing request. + +When the UE selects a new PLMN while announcing a ProSe Restricted Code and the UE is not yet authorised for restricted ProSe direct discovery model A announcing in the new PLMN, the UE shall initiate an announce request procedure only after the UE is authorised for restricted ProSe direct discovery model A announcing in the new PLMN. + +NOTE 1: To ensure service continuity if the UE needs to keep announcing a ProSe Restricted Code corresponding to the same RPAUID, the UE can initiate the announce request procedure before the validity timer T4007 assigned by the ProSe Function for a ProSe Restricted Code expires. + +The UE initiates the announce request procedure by sending a DISCOVERY\_REQUEST message with: + +- a new transaction ID not used in any other direct discovery procedures in PC3 interface; +- the RPAUID set to the RPAUID received from upper layers; +- the command set to "announce"; +- the UE identity set to the UE's IMSI; +- the Application Identity set to the Application Identity of the upper layer application that requested the announcing; +- the Discovery Type set to "Restricted discovery"; +- the ACE Enabled Indicator set to "application-controlled extension enabled" if application-controlled extension is required by the upper layers or "normal" if application-controlled extension is not used; +- the announcing type set to "on demand" if on demand announcing is requested by upper layers and "normal" if on demand announcing is not requested by upper layers; +- optionally the Requested Timer set to the length of validity timer associated with the ProSe Restricted Code that the UE expects to receive from the ProSe Function; +- the Discovery Entry ID set to a 0 if the announcing request is a new request, and set to the Discovery Entry ID received from the ProSe Function if the announcing request is to update a previously sent announcing request; +- optionally in case of E-UTRA-based restricted ProSe direct discovery model A the Announcing PLMN ID set to the PLMN ID of the local PLMN operating the radio resources that the UE intends to use for announcing the RPAUID; and +- optionally the PC5\_tech set to the PC5 radio technology that the UE wishes to use. PC5\_tech may include more than one PC5 radio technology. + +If restricted ProSe direct discovery model A with application-controlled extension is requested by upper layers, the DISCOVERY\_REQUEST message shall also include the Application Level Container, which contains application-level data transparent to the 3GPP network, to be used by the ProSe Application Server e.g. to assign ProSe Restricted Code Suffix(es). + +When the UE initiates the announce request procedure to inform the ProSe Function that the UE wants to stop announcing a ProSe Restricted Code before the associated valid timer expires, the UE shall set the Requested Timer to 0. + +NOTE 2: A UE can include one or multiple transactions in one DISCOVERY\_REQUEST message for different RPAUIDs, and receive corresponding element or element in a DISCOVERY\_RESPONSE message for each respective transaction. In the following description of the announce request procedure, only one transaction is included. + +Figure 6.2.2A.2.1 illustrates the interaction of the UE and the ProSe Function in the announce request procedure. + +![Sequence diagram illustrating the Announce request procedure for restricted ProSe direct discovery model A. The diagram shows two possible outcomes for the DISCOVER_RESPONSE message from the ProSe Function to the UE. In the first case, the response is a 'restricted-announce-response' and the procedure starts at timer 4007. In the second case, the response is a 'response-reject' and the procedure starts at timer 4008. The UE sends a DISCOVER_REQUEST to the ProSe Function, which then responds with the appropriate DISCOVER_RESPONSE.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSeFunction as ProSe Function + Note right of ProSeFunction: Start 4007 + UE->>ProSeFunction: DISCOVER_REQUEST + ProSeFunction-->>UE: DISCOVER_RESPONSE (restricted-announce-response) + Note left of UE: Start 4008 + Note right of ProSeFunction: Start 4008 + Note between UE and ProSeFunction: OR + Note right of ProSeFunction: Start 4008 + UE->>ProSeFunction: DISCOVER_REQUEST + ProSeFunction-->>UE: DISCOVER_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the Announce request procedure for restricted ProSe direct discovery model A. The diagram shows two possible outcomes for the DISCOVER\_RESPONSE message from the ProSe Function to the UE. In the first case, the response is a 'restricted-announce-response' and the procedure starts at timer 4007. In the second case, the response is a 'response-reject' and the procedure starts at timer 4008. The UE sends a DISCOVER\_REQUEST to the ProSe Function, which then responds with the appropriate DISCOVER\_RESPONSE. + +**Figure 6.2.2A.2.1: Announce request procedure for restricted ProSe direct discovery model A** + +### 6.2.2A.3 Announce request procedure accepted by the ProSe Function + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "announce" and the Discovery Type set to "Restricted discovery", if the Requested Timer is included in the DISCOVERY\_REQUEST message and the Requested Timer is set to 0, the ProSe Function shall check whether there is an existing UE context containing the discovery entry identified by the Discovery Entry ID included in the DISCOVERY\_REQUEST message. If the discovery entry exists in the UE context, the ProSe Function shall inform the ProSe Function in the announcing PLMN to remove the corresponding discovery entry as specified in 3GPP TS 29.345 [5] when the announcing PLMN is not the same as that of the PLMN to which the ProSe Function belongs and remove the discovery entry identified by the Discovery Entry ID from the UE's context. Then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message, and +- the Discovery Entry ID set to the identifier associated with the corresponding discovery entry. + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "announce" and the Discovery Type set to "Restricted discovery", if the Requested Timer is not included in the DISCOVERY\_REQUEST message or the Requested Timer included in the DISCOVERY\_REQUEST message is not set to 0, the ProSe Function shall perform the following procedure. + +The ProSe Function shall check that the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is authorised for restricted ProSe direct discovery model A announcing. If the application is authorised for restricted ProSe direct discovery model A announcing, the ProSe Function shall check whether there is an existing context for the UE. + +If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for restricted ProSe direct discovery model A announcing as described in 3GPP TS 29.344 [3]. If the check indicates that the UE is authorised, the ProSe Function creates a UE context that contains the UE's subscription parameters obtained from the HSS. The HSS also provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. If the UE context exists, the ProSe Function shall then check whether the UE is authorised for restricted ProSe direct discovery model A announcing in the currently registered PLMN or in case of E-UTRA-based restricted ProSe direct discovery model A the local PLMN identified by the Announcing PLMN ID included in the DISCOVERY\_REQUEST message. + +If the UE is authorised and the Discovery Entry ID included in the DISCOVERY\_REQUEST message is set to 0 then: + +- the ProSe Function shall check whether the UE is authorised to announce the RPAUID contained in the DISCOVERY\_REQUEST message. Optionally this can include checking with the ProSe Application Server as described in 3GPP TS 29.343 [31] to obtain the binding between the RPAUID and PDUID, and then verifying that the PDUID belongs to the requesting UE; + +- if the UE is authorised to announce the RPAUID, the ACE Enabled Indicator is set to "application-controlled extension enabled", the Application Level Container is included in the DISCOVERY\_REQUEST message and the requested application uses application-controlled extension, the ProSe Function shall check whether the UE is authorized to use ACE. If the UE is authorized for ACE, the ProSe Function shall invoke the procedure described in 3GPP TS 29.343 [31] to check whether the UE is authorised to announce the requested RPAUID with application-defined suffix(es), and obtain suffix-related information from the ProSe Application Server. The ProSe Function shall then allocate a ProSe Restricted Code Prefix and a value for validity timer T4007 to be used with the ProSe Restricted Code Suffix(es) obtained from the ProSe Application Server for the given RPAUID as specified in 3GPP TS 29.343 [31]. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message when allocating validity timer T4007; +- if the UE is authorised to announce the RPAUID, the ACE Enabled Indicator is set to "normal" in the DISCOVERY\_REQUEST message and the requested application does not use application-controlled extension, the ProSe Function shall allocate the corresponding ProSe Restricted Code and a value for validity timer T4007. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message when allocating validity timer T4007; +- if the UE is authorised to announce the RPAUID, the ACE Enabled Indicator is set to "normal" in the DISCOVERY\_REQUEST message, the Application Level Container is included in the DISCOVERY\_REQUEST and the requested application only uses application-controlled extension, the ProSe Function shall check whether the UE is authorized to use ACE. If the UE is authorized for ACE, the ProSe Function shall invoke the procedure described in 3GPP TS 29.343 [31] to check whether the UE is authorised to announce the requested RPAUID with application-defined suffix(es), and obtain suffix-related information from the ProSe Application Server. The ProSe Function shall then allocate a ProSe Restricted Code Prefix and a value for validity timer T4007 to be used with the ProSe Restricted Code Suffix(es) obtained from the ProSe Application Server for the given RPAUID as specified in 3GPP TS 29.343 [31]. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message when allocating validity timer T4007. +- if the UE is authorised to announce the RPAUID, the ACE Enabled Indicator is set to "application-controlled-extension enabled" and the Application Level Container is included in the DISCOVERY\_REQUEST message but the requested application does not use application-controlled extension, the ProSe Function shall allocate the corresponding ProSe Restricted Code and a value for validity timer T4007. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message when allocating validity timer T4007; and +- the ProSe Function associates the allocated ProSe Restricted Code or ProSe Restricted Code Prefix with a new discovery entry in the UE's context, and starts timer T4008. The HSS also provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. For a given ProSe Restricted Code, timer T4008 shall be longer than timer T4007. By default, the value of timer T4008 is 4 minutes greater than the value of timer T4007. + +If the Discovery Entry ID included in the DISCOVERY\_REQUEST message is not set to 0 and if there is an existing discovery entry for this Discovery Entry ID value in the UE's context, the ProSe Function shall either update the discovery entry with a new validity timer T4007, or allocate a new ProSe Restricted Code or ProSe Restricted Code Prefix for the requested RPAUID with a new validity timer T4007, restart timer T4008, and clear any existing on demand announcing enabled indicator. The ProSe Function may take into account the Requested Timer if contained in the DISCOVERY\_REQUEST message when allocating validity timer T4007. + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is not found in the UE context or there is no UE context in the ProSe Function, the ProSe Function shall behave as if the Discovery Entry ID included in the DISCOVERY\_REQUEST message was set to 0, and the ProSe Function shall allocate a new non-zero Discovery Entry ID for this entry. + +If the announcing type is set to "on demand" in the DISCOVERY\_REQUEST message, the ProSe Function shall check if "on demand" announcing is authorised and enabled based on the Application Identity and the operator's policy. If "on demand" announcing is authorised and enabled, and there is no ongoing monitoring request for this RPAUID, then the ProSe Function shall set the on demand announcing enabled indicator to 1 for the corresponding discovery entry in the UE's context. + +If a new UE context was created or an existing UE context was updated, and the UE is currently roaming or the Announcing PLMN ID is included in the DISCOVERY\_REQUEST message, and the on demand announcing enabled indicator is not set to 1 for this discovery entry in the UE's context, the ProSe Function checks with the ProSe function + +of the VPLMN or in case of E-UTRA-based restricted ProSe direct discovery model A the local PLMN represented by the Announcing PLMN ID whether the UE is authorised for restricted ProSe direct discovery model A announcing as described in 3GPP TS 29.345 [5]. + +The ProSe Function shall then send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message from the UE; +- if the on demand announcing enabled indicator is not set to 1 in the UE's context for this discovery entry, either the ProSe Restricted Code set to the ProSe Restricted Code or the ProSe Restricted Code Prefix allocated by the ProSe Function, and optionally one or more ProSe Restricted Code Suffix Ranges which contain the suffix(es) for the RPAUID received in the DISCOVERY\_REQUEST message; +- a Validity Timer T4007 set to the T4007 timer value assigned by the ProSe Function to the ProSe Restricted Code; +- the ACE Enabled Indicator set to "application-controlled extension enabled" if application-controlled extension is used, or "normal" if application-controlled extension is not used; +- the Restricted Security set to a value containing the security-related information for restricted discovery provided by the ProSe Function; +- the On Demand Announcing Enabled Indicator indicating whether the on demand announcing is enabled or not for this discovery entry if the Announcing Type is set to "on demand" in the DISCOVERY\_REQUEST message; +- the Discovery Entry ID set to the ID of the discovery entry associated with this announce request in the UE's context; and +- optionally the PC5\_tech set to the one or more PC5 radio technologies that are authorized to be used for the assigned ProSe Restricted Code or the assigned ProSe Restricted Code Prefix and the associated ProSe Restricted Code Suffix Ranges. + +If timer T4008 expires, the ProSe Function shall remove the discovery entry associated with the corresponding RPAUID from the UE's context. + +#### 6.2.2A.4 Announce request procedure completion by the UE + +Upon receipt of the DISCOVERY\_RESPONSE message, if only the transaction ID and the Discovery Entry ID are contained in the element and the transaction ID and the Discovery Entry ID match the corresponding values sent by the UE in a DISCOVERY\_REQUEST message, the UE shall: + +- stop the validity timer T4007 for the discovery entry corresponding to the Discovery Entry ID received in the DISCOVERY\_RESPONSE message; +- remove the discovery entry identified by the Discovery Entry ID included; and +- instruct the lower layers to stop announcing. + +Upon receipt of the DISCOVERY\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a DISCOVERY\_REQUEST message with the command set to "announce", the UE shall create a new discovery entry or update an existing discovery entry with the received ProSe Restricted Code or ProSe Restricted Code Prefix and the PLMN ID of the intended announcing PLMN. For this discovery entry, the UE shall stop the validity timer T4007, if running, for the discovery entry corresponding to the Discovery Entry ID received in the DISCOVERY\_RESPONSE message, and start the validity timer T4007 for this discovery entry with the received value in the DISCOVERY\_RESPONSE message. Otherwise the UE shall discard the DISCOVERY\_RESPONSE message and shall not perform the procedures below. + +If the DISCOVERY\_RESPONSE message includes new ProSe Restricted Code or ProSe Restricted Code Prefix to replace the existing ProSe Restricted Code being announced, the UE shall notify lower layer to stop announcing the old ProSe Restricted Code in PC5 interface. + +If the DISCOVERY\_RESPONSE message contains an On Demand Announcing Enabled Indicator set to 1, the UE shall wait for an Announcing Alert Request message from the ProSe Function of the HPLMN before starting to perform + +restricted ProSe direct discovery model A announcing. Otherwise, the UE may perform restricted ProSe direct discovery model A announcing as described below. + +The UE requests the parameters from the lower layers for restricted Prose direct discovery model A announcing (see 3GPP TS 36.331 [12]). In case of E-UTRA-based restricted ProSe direct discovery the UE shall perform restricted ProSe direct discovery model A announcing only if the lower layers indicate that ProSe direct discovery is supported by the network. In case of E-UTRA-based restricted ProSe direct discovery if the UE in EMM-IDLE mode has to request resources for ProSe direct discovery announcing as specified in 3GPP TS 36.331 [12], the UE shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]. The UE shall obtain the UTC time for the next discovery transmission opportunity for ProSe direct discovery from the lower layers. + +If a valid UTC time is obtained, the UE shall generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18. If the resulting UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE, the UE shall either use the ProSe Restricted Code received in the DISCOVERY\_RESPONSE message, or select one ProSe Restricted Code based on the ProSe Restricted Code Prefix and ProSe Restricted Code Suffix Range(s) received in the DISCOVERY\_RESPONSE message as announced ProSe Restricted Code, along with the eight least significant bits of the UTC-based counter, in order to construct a PC5\_DISCOVERY message, according to the format defined in subclause 11.2.5. + +NOTE: The UE can use different codes formed based on different ProSe Restricted Code Suffixes to announce, without having to send a new DISCOVERY\_REQUEST message to the ProSe Function, as long as the validity timer T4007 of the ProSe Restricted Code Prefix has not expired. + +The UE shall then apply one or more of the DUIK, DUSK or DUCK with the associated Encrypted Bitmask, whichever received in the Restricted Code Security Material parameter of the DISCOVERY\_RESPONSE message, along with the UTC-based counter to the PC5\_DISCOVERY message, to e.g. generate a MIC value, scramble the message contents or provide confidentiality protection, as specified in 3GPP TS 33.303 [6]. + +The UE then passes the resulting PC5\_DISCOVERY message, along with the PLMN ID of the intended announcing PLMN, to the lower layers for transmission if: + +- the UE is currently authorised to perform restricted ProSe direct discovery model A announcing in the registered PLMN or in case of E-UTRA-based restricted ProSe direct discovery model A the local PLMN operating the radio resources that the UE intends to use; +- the validity timer T4007 for the corresponding discovery entry allocated ProSe Restricted Code or ProSe Restricted Code Prefix has not expired; and +- a request from upper layers to announce the RPAUID associated with both the ProSe Restricted Code or ProSe Restricted Code Prefix, and the authorised Application Identity, is still in place. + +The UE shall ensure that it keeps on passing PC5\_DISCOVERY messages to the lower layers for transmission until the validity timer T4007 of the ProSe Restricted Code or ProSe Restricted Code Prefix expires. How this is achieved is left up to UE implementation. + +During the announcing operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop announcing. When the UE stops announcing, In case of E-UTRA-based restricted ProSe direct discovery model A if the lower layers indicate that the UE is required to send a discovery indication to the eNodeB and the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +#### 6.2.2A.5 Announce request procedure not accepted by the ProSe Function + +If the DISCOVERY\_REQUEST message cannot be accepted by the ProSe Function, the ProSe Function sends a DISCOVERY\_RESPONSE message containing a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is not authorised for ProSe direct discovery announcing, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid application". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function or ProSe Application Server, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #9 "Unknown RPAUID". + +If the RPAUID contained in the DISCOVERY\_REQUEST message does not match the stored RPAUID for the requested Discovery Entry ID, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +If the UE is not authorised for restricted ProSe direct discovery model A announcing, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the UE is not authorised for restricted "on demand" restricted ProSe direct discovery model A announcing, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #13 "UE unauthorised for on-demand announcing". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is not associated with the PDUID belonging to the requesting UE, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation Failure". + +If the UE is not authorized to use ACE, but the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #12 "UE unauthorised for discovery with Application-Controlled Extension". + +If the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", but does not contain the Application Level Container parameter, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #14 "Missing Application Level Container". + +If the ProSe Application Server indicates to the ProSe Function that the Application Level Container in the DISCOVERY\_REQUEST message contains invalid information, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #15 "Invalid Data in Application Level Container". + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function and the Requested Timer is set to zero, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value # 10 "Unknown or invalid Discovery Entry ID". + +## 6.2.2A.6 Abnormal cases + +### 6.2.2A.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_REQUEST message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the announce request procedure. + +- b) No response from the ProSe Function after the DISCOVERY\_REQUEST message has been successfully delivered (e.g., TCP ACK has been received for the DISCOVERY\_REQUEST message) + +The UE shall retransmit the DISCOVERY\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Indication from upper layers that the request to announce the RPAUID is no longer in place after sending the DISCOVERY\_REQUEST message, but before the announce request procedure is completed + +The UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its contents and then abort the procedure. + +- d) Change of PLMN + +If a PLMN change occurs before the announce request procedure is completed, the procedure shall be aborted. If the UE is authorized to announce in the new PLMN, the procedure shall be restarted once the UE is registered on the new PLMN. + +#### 6.2.2A.6.2 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_RESPONSE message + +After receiving an indication from lower layer that the DISCOVERY\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the ProSe Function shall abort the procedure, and stop any associated timer(s) T4008, if running. + +### 6.2.2B Discoveree request procedure for restricted ProSe direct discovery model B + +#### 6.2.2B.1 General + +The purpose of the discoveree request procedure for restricted ProSe direct discovery model B is for the UE to obtain Discovery Query Filter(s) to be used for monitoring a model B query for a Restricted ProSe Application User ID (RPAUID) over the PC5 interface, and a ProSe Response Code to be announced over the PC5 interface as a response to a model B query, as defined in 3GPP TS 23.303 [2]. + +Before initiating the discoveree request procedure, the UE shall be authorised for restricted ProSe direct discovery model B discoveree operation in the registered PLMN or the local PLMN based on the service authorisation procedure as specified in clause 5. + +NOTE: The notion of "local PLMN" does not apply for WLAN-based ProSe direct discovery. The UE can engage in WLAN-based ProSe direct discovery as announcing UE regardless of the serving PLMN or other PLMNs that provide E-UTRAN coverage in the UE location. + +As the result of successful completion of this procedure, the UE obtains one or more Discovery Query Filters and applies them to the monitoring operation in PC5 interface. The UE shall also include the ProSe Response Code in a PC5\_DISCOVERY message and passes the message to the lower layers for transmission over the PC5 interface, when there is a match of the Discovery Query Filter(s). + +#### 6.2.2B.2 Discoveree request procedure initiation + +Before initiating the discoveree request procedure, the user sets the permissions for the restricted discovery using application layer mechanisms. The application client in the UE retrieves the PDUID provisioned to the UE as part of the service authorisation procedure as specified in clause 5 and obtains an RPAUID associated with the UE's PDUID from the ProSe Application Server. The UE may provide metadata to be associated with the RPAUID, and the ProSe Application Server stores the metadata. This step is performed using mechanisms that are out of scope of the present specification. + +If the UE is authorised to perform E-UTRA-based restricted ProSe direct discovery model B discoveree operation in the PLMN operating the radio resources signalled from the serving PLMN, or if the UE is authorised to perform WLAN-based restricted ProSe direct discovery model B discoveree operation, it shall initiate a discoveree request procedure: + +- a) when the UE is triggered by an upper layer application to announce an RPAUID in Model B and the UE has no valid corresponding ProSe Response Code and Discovery Query Filter(s) for that RPAUID of the upper layer application; +- b) when the validity timer T4011 assigned by the ProSe Function to a ProSe Response Code and the corresponding Discovery Query Filter(s) has expired and the request from upper layers to announce the RPAUID corresponding to that ProSe Response Code is still in place; +- c) when the UE selects a new PLMN while announcing or waiting for announcing a ProSe Response Code and intends to announce in the new PLMN, and the UE is authorised for restricted ProSe direct discovery model B discoveree operation in the new PLMN; + +- d) when, while announcing or waiting for announcing a ProSe Response Code, the UE intends to switch the announcing PLMN to a different PLMN without performing PLMN selection, and the UE does not have a valid allocated ProSe Response Code for this new PLMN yet; or +- e) when the UE needs to update a previously sent restricted ProSe direct discovery model B discoveree request. + +When the UE selects a new PLMN while announcing or waiting for announcing a ProSe Response Code and the UE is not yet authorised for restricted ProSe direct discovery model B discoveree operation in the new PLMN, the UE shall initiate a discoveree request procedure only after the UE is authorised for restricted ProSe direct discovery model B discoveree operation in the new PLMN. + +NOTE 1: To ensure service continuity if the UE needs to keep announcing in Model B a ProSe Response Code corresponding to the same RPAUID, the UE can initiate the discoveree request procedure before the validity timer T4011 assigned by the ProSe Function for a ProSe Response Code expires. + +The UE initiates the discoveree request procedure by sending a DISCOVERY\_REQUEST message with: + +- a new transaction ID not used in any other direct discovery procedures in PC3 interface; +- the RPAUID set to the RPAUID received from upper layers; +- the command set to "response"; +- the UE identity set to the UE's IMSI; +- the Application Identity set to the Application Identity of the upper layer application that requested the announcing; +- the Discovery Type set to "Restricted discovery"; +- the Discovery Model set to "Model B"; +- the Discovery Entry ID set to a 0 if the discoveree request is a new request, and set to the Discovery Entry ID received from the ProSe Function if the discoveree request is to update a previously sent discoveree request; +- optionally in case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation, the Announcing PLMN ID set to the PLMN ID of the local PLMN operating the radio resources that the UE intends to use for announcing the RPAUID; and +- optionally the PC5\_tech set to the PC5 radio technology that the UE wishes to use. PC5\_tech may include more than one PC5 radio technology. + +NOTE 2: A UE can include one or multiple transactions in one DISCOVERY\_REQUEST message for different RPAUIDs (e.g., for different applications), and receive corresponding element or element in a DISCOVERY\_RESPONSE message for each respective transaction. In the following description of the discoveree request procedure, only one transaction is included. + +Figure 6.2.2B.2.1 illustrates the interaction of the UE and the ProSe Function in the discoveree request procedure. + +![Sequence diagram illustrating the Discoveree request procedure for restricted ProSe direct discovery model B. The diagram shows two possible outcomes for the DISCOVER_RESPONSE message from the ProSe Function to the UE. In the first case, the response is a 'restricted-discoveree-response' and timer T4012 is started. In the second case, the response is a 'response-reject' and no timer is started. The UE sends a DISCOVER_REQUEST message to the ProSe Function in both cases.](8269648391c59363ea61243864a2adf7_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSeFunction as ProSe Function + Note left of UE: Start T4011 + UE->>ProSeFunction: DISCOVER_REQUEST + ProSeFunction-->>UE: DISCOVER_RESPONSE (restricted-discoveree-response) + Note right of ProSeFunction: Start T4012 + Note right of UE: OR + Note left of UE: Start T4011 + UE->>ProSeFunction: DISCOVER_REQUEST + ProSeFunction-->>UE: DISCOVER_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the Discoveree request procedure for restricted ProSe direct discovery model B. The diagram shows two possible outcomes for the DISCOVER\_RESPONSE message from the ProSe Function to the UE. In the first case, the response is a 'restricted-discoveree-response' and timer T4012 is started. In the second case, the response is a 'response-reject' and no timer is started. The UE sends a DISCOVER\_REQUEST message to the ProSe Function in both cases. + +**Figure 6.2.2B.2.1: Discoveree request procedure for restricted ProSe direct discovery model B** + +### 6.2.2B.3 Discoveree request procedure accepted by the ProSe Function + +Upon receiving a DISCOVERY\_REQUEST message, the ProSe Function shall check that the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is authorised for restricted ProSe direct discovery model B discoveree operation. If the application is authorised for restricted ProSe direct discovery model B discoveree operation, the ProSe Function shall check whether there is an existing context for the UE. + +If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for restricted ProSe direct discovery model B discoveree operation as described in 3GPP TS 29.344 [3]. If the check indicates that the UE is authorised, the ProSe Function creates a UE context that contains the UE's subscription parameters obtained from the HSS. The HSS also provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. + +If the UE context exists, the ProSe Function shall check whether the UE is authorized for restricted ProSe direct discovery model B discoveree operation in the currently registered PLMN or in case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation the local PLMN identified by the Announcing PLMN ID included in the DISCOVERY\_REQUEST message. + +If the UE is authorized and the Discovery Entry ID included in the DISCOVERY\_REQUEST message is set to 0 then: + +- the ProSe Function shall check whether the UE is authorised to announce the RPAUID contained in the DISCOVERY\_REQUEST message. Optionally this can include checking with the ProSe Application Server as described in 3GPP TS 29.343 [31] to obtain the binding between the RPAUID and PDUID, and then verifying that the PDUID belongs to the requesting UE; +- if the UE is authorised to announce the RPAUID, the ProSe Function shall allocate the corresponding ProSe Response Code and ProSe Query Code for the RPAUID. It shall also allocate Discovery Query Filter(s) based on the allocated ProSe Query Code. Then it shall assign a value for validity timer T4011, which is associated with the ProSe Response Code, ProSe Query Code and Discovery Query Filter(s). +- the ProSe Function associates the allocated ProSe Response Code, ProSe Query Code, and Discovery Query Filter with a new discovery entry ID in the UE context, and starts timer T4012. For a given ProSe Response Code, timer T4012 shall be longer than timer T4011. By default, the value of timer T4012 is 4 minutes greater than the value of timer T4011. + +If the Discovery Entry ID included in the DISCOVERY\_REQUEST message is not set to 0 and if there is an existing discovery entry for this Discovery Entry ID value in the UE context, the ProSe Function shall either update the discovery entry with a new validity timer T4011, or allocate a new ProSe Response Code, ProSe Query Code and the Discovery Query Filter(s) for the requested RPAUID with a new validity timer T4011, restart timer T4012. + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is not found in the UE context or there is no UE context in the ProSe Function, the ProSe Function shall behave as if the Discovery Entry ID included in the DISCOVERY\_REQUEST message was set to 0, and the ProSe Function shall allocate a new non-zero Discovery Entry ID for this entry. + +If a new UE context was created or an existing UE context was updated, and the UE is currently roaming or the Announcing PLMN ID is included in the DISCOVERY\_REQUEST message, the ProSe Function checks with the ProSe function of the VPLMN or in case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation the local PLMN identified by the Announcing PLMN ID whether the UE is authorised for restricted ProSe direct discovery model B discoveree operation as described in 3GPP TS 29.345 [5]. + +The ProSe Function shall then send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message from the UE; +- the ProSe Response Code set to the ProSe Response Code allocated for the RPAUID received in the DISCOVERY\_REQUEST message; +- one or more ProSe Query Filters set to the ProSe Query Filter(s) used to match a query for the RPAUID received in the DISCOVERY\_REQUEST message; +- a Validity Timer T4011 set to the T4011 timer value assigned by the ProSe Function to the ProSe Response Code and the Discovery Query Filter(s); +- the Restricted Security set to a value containing the security-related information for restricted discovery provided by the ProSe Function; +- the Discovery Entry ID set to the ID of the discovery entry associated with this discoveree request in the UE context. +- optionally the PC5\_tech set to the one or more PC5 radio technologies that are authorized to be used for the assigned ProSe Response Code. + +If timer T4012 expires, the ProSe Function shall remove the discovery entry associated with the corresponding RPAUID from the UE's context. + +#### 6.2.2B.4 Discoveree request procedure completion by the UE + +Upon receipt of the DISCOVERY\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a DISCOVERY\_REQUEST message with the command set to "response", the UE shall create a new discovery entry or update an existing discovery entry with the ProSe Response Code and Discovery Query Filter(s) received in the DISCOVERY\_RESPONSE message and the PLMN ID of the intended announcing PLMN. For this discovery entry, the UE shall stop the validity timer T4011 if running and start the validity timer T4011 with the received value. The UE shall also use the received ProSe Response Code and Discovery Query Filter(s) to replace the old counterparts if they are currently used. This may involve notifying the lower layers to stop announcing the old ProSe Response Code or to stop monitoring with the old Discovery Query Filter(s). Otherwise the UE shall discard the DISCOVERY\_RESPONSE message and shall not perform the procedures below. + +The UE may apply the received Discovery Query Filter(s) to its monitoring operation. Using the Discovery Query Filter(s) may result in a match event. There is match event when, for any of the masks in a Discovery Query Filter, the output of a bitwise AND operation between the ProSe Query Code contained in the received PC5\_DISCOVERY message and the mask, matches the output of a bitwise AND operation between the mask and the code contained in the Discovery Query Filter. + +When applying a Discovery Query Filter to a received PC5\_DISCOVERY message for the above-mentioned bitwise AND operation, the UE shall use the DUSK, if received as part of the filter in the DISCOVERY\_RESPONSE message, and the UTC-based counter generated during the monitoring operation described below, to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is included as part of the filter, the UE shall use the DUCK and the UTC-based counter to decrypt the message-specific confidentiality protected portion identified by the Encrypted Bitmask, as described in 3GPP TS 33.303 [6]; + +NOTE 1: The UE can look for a match on the unencrypted bits first before applying DUCK, to minimise the amount of processing performed before finding a match. + +If a DUIK is received as part of the filter, the UE shall use the DUIK and the UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message. + +NOTE 2: The UE needs to verify the MIC field because the match report procedure is not used for checking the MIC of a PC5\_DISCOVERY message containing a ProSe Query Code by the ProSe Function. + +The UE may instruct the lower layers to start monitoring with Discovery Query Filter(s) and prepare announcing the ProSe Response Code if all of the following conditions are met: + +- the UE is currently authorized to perform restricted ProSe direct discovery model B discoveree operation in the registered PLMN or in case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation, the local PLMN operating the radio resources that the UE intends to use; +- the UE has obtained the ProSe Response Code and Discovery Query Filter(s) and the respective validity timer T4011 for the corresponding discovery entry has not expired; and +- a request from upper layers to perform discoveree operation for the RPAUID associated with an authorised Application Identity is still in place. + +During the discoveree operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop the discoveree operation. When the UE stops discoveree operation, if the lower layers indicate that the UE is required to send a discovery indication to the eNodeB and in case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +Once the match of the Discovery Query Filter(s) occurs, the UE process this match event and requests the lower layers to announce the corresponding ProSe Response Code in the PC5 interface as a response, as specified in 3GPP TS 36.331 [12]. In case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation this shall be done only if the lower layers indicate that ProSe direct discovery is supported by the network. In case of E-UTRA-based restricted ProSe direct discovery model B discoveree operation if the UE in EMM-IDLE mode has to request resources for ProSe direct discovery announcing as specified in 3GPP TS 36.331 [12], the UE shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]. The UE shall obtain the UTC time for the next discovery transmission opportunity for ProSe direct discovery from the lower layers. + +If a valid UTC time is obtained, the UE shall generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18. If the resulting UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE, the UE shall use the ProSe Response Code received in the DISCOVERY\_RESPONSE message, along with the eight least significant bits of the UTC-based counter, in order to construct a PC5\_DISCOVERY message, according to the format defined in subclause 11.2.5. + +The UE shall then apply one or more of the DUIK, DUSK or DUCK with the associated Encrypted Bitmask, whichever received in the Restricted Code Security Material parameter of the DISCOVERY\_RESPONSE message, along with the UTC-based counter to the PC5\_DISCOVERY message, to e.g. generate a MIC value, scramble the message contents or provide confidentiality protection, as specified in 3GPP TS 33.303 [6]. + +The UE then passes the resulting PC5\_DISCOVERY message, along with the PLMN ID of the intended announcing PLMN, to the lower layers for transmission. + +For each match event with the Discovery Query Filter(s), the UE shall at least pass PC5\_DISCOVERY message once to the lower layers for transmission. The UE shall ensure that it keeps on passing PC5\_DISCOVERY messages to the lower layers for transmission as response(s) to the match event(s) of the corresponding Discovery Query Filter(s) until the validity timer T4011 expires. How this is achieved is left up to UE implementation. + +#### 6.2.2B.5 Discoveree request procedure not accepted by the ProSe Function + +If the DISCOVERY\_REQUEST message cannot be accepted by the ProSe Function, the ProSe Function sends a DISCOVERY\_RESPONSE message containing a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is not authorised for ProSe direct discovery Model B discoveree operation, the ProSe Function shall send the + +DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid application". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function or ProSe Application Server, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #9 "Unknown RPAUID". + +If the RPAUID contained in the DISCOVERY\_REQUEST message does not match the stored RPAUID for the requested Discovery Entry ID, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +If the UE is not authorised for restricted ProSe direct discovery model B discoveree operation, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is not associated with a PDUID belonging to the requesting UE, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation Failure". + +## 6.2.2B.6 Abnormal cases + +### 6.2.2B.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_REQUEST message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the discoveree request procedure. + +- b) No response from the ProSe Function after the DISCOVERY\_REQUEST message has been successfully delivered (e.g., TCP ACK has been received for the DISCOVERY\_REQUEST message) + +The UE shall retransmit the DISCOVERY\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Indication from upper layers that the request to announce the RPAUID in model B is no longer in place after sending the DISCOVERY\_REQUEST message, but before the discoveree request procedure is completed + +The UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its contents and then abort the procedure. + +- d) Change of PLMN + +If a PLMN change occurs before the discoveree request procedure is completed, the procedure shall be aborted. If the UE is authorized to perform restricted ProSe direct discovery model B discoveree operation in the new PLMN, the procedure shall be restarted once the UE is registered on the new PLMN. + +### 6.2.2B.6.2 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_RESPONSE message + +After receiving an indication from lower layer that the DISCOVERY\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the ProSe Function shall abort the procedure, and stop any associated timer(s) T4012, if running. + +## 6.2.3 Monitor request procedure for open ProSe direct discovery + +### 6.2.3.1 General + +The purpose of the monitor request procedure for open ProSe direct discovery is to allow a UE: + +- to receive and process PC5\_DISCOVERY messages upon a request for monitoring from upper layers as defined in 3GPP TS 23.303 [2]; or +- to inform the ProSe Function that the UE wants to stop using Discovery Filters for direct discovery monitoring as defined in 3GPP TS 23.303 [2]. + +The UE shall only initiate the monitor request procedure if it has been authorised for open ProSe direct discovery monitoring at least in one PLMN based on the service authorisation procedure. + +As a result of the monitor request procedure completing successfully, the UE obtains one or more Discovery Filters, along with a TTL (Time-To-Live) timer T4002 for each Discovery Filter indicating the time during which the filter is valid. + +### 6.2.3.2 Monitor request procedure Initiation + +Before initiating the monitor request procedure, the UE is configured with the data structure of the ProSe Application IDs it wants to monitor. This step is performed using mechanisms that are out of scope of 3GPP. + +If the UE is authorised to perform open ProSe direct discovery monitoring in at least one PLMN, it shall initiate a monitor request procedure: + +- a) when the UE is triggered by an upper layer application to perform open ProSe direct discovery monitoring corresponding to a ProSe Application ID and the UE has no valid Discovery Filters corresponding to the requested ProSe Application ID for that upper layer application; +- b) when the TTL timer T4002 assigned by the ProSe Function to a Discovery Filter has expired and the request from upper layers to monitor that ProSe Application ID is still in place; or +- c) when the UE needs to inform the ProSe Function that the UE wants to stop using Discovery Filters for direct discovery monitoring. + +NOTE 1: To ensure service continuity if the UE needs to keep monitoring the same Discovery Filter, the UE can initiate the monitor request procedure before the TTL timer T4002 assigned by the ProSe Function for a Discovery Filter expires. + +The UE initiates the monitor request procedure for open ProSe direct discovery by sending a DISCOVERY\_REQUEST message with: + +- a new transaction ID; +the ProSe Application ID set to the ProSe Application ID received from upper layers; +- the command set to "monitor" +- the UE identity set to the UE's IMSI; +- the Application Identity set to the Application Identity of the upper layer application that requested the monitoring; +- the ACE Enabled Indicator set to "application-controlled extension enabled" if application-controlled extension is required by the upper layers, or "normal" if application-controlled extension is not used; +- the Discovery Entry ID set to 0 if this is a new request or set to the Discovery Entry ID received from the ProSe Function if the monitor request is to update a previously sent monitor request; +- optionally, the Requested Timer set to 0 only when the UE wants to stop using Discovery Filters for direct discovery monitoring; and +- optionally the PC5\_tech set to the PC5 radio technology that the UE wishes to use for monitoring. PC5\_tech may include more than one PC5 radio technology. + +If open ProSe direct discovery with application-controlled extension is requested by upper layers, the DISCOVERY\_REQUEST message shall also include the Application Level Container, which contains information corresponding to the ProSe Application Code Suffix, e.g. group or user-specific information. + +NOTE 2: A UE can include one or multiple transactions in one DISCOVERY\_REQUEST message for one or more ProSe Application IDs, and receive corresponding element or element in the DISCOVERY\_RESPONSE message for each respective transaction. In the following description of the monitor request procedure, only one transaction is included. + +Figure 6.2.3.2.1 illustrates the interaction between the UE and the ProSe Function in the monitor request procedure. + +![Sequence diagram illustrating the Monitor request procedure between a UE and a ProSe Function. The diagram shows two possible outcomes: a successful response (response-monitor) or a rejection (response-reject).](0f26e70157bd4c45f825795cdcd20fbd_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSeFunction as ProSe Function + Note left of UE: START 4002 + UE->>ProSeFunction: DISCOVERY_REQUEST + Note right of ProSeFunction: START 4003 + ProSeFunction-->>UE: DISCOVERY_RESPONSE (response-monitor) + Note right of ProSeFunction: OR + Note left of UE: DISCOVERY_REQUEST + UE->>ProSeFunction: DISCOVERY_REQUEST + ProSeFunction-->>UE: DISCOVERY_RESPONSE (response-reject) + +``` + +The diagram illustrates the interaction between a User Equipment (UE) and a ProSe Function. The sequence starts with the UE sending a DISCOVERY\_REQUEST message to the ProSe Function. The ProSe Function then responds with a DISCOVERY\_RESPONSE message. There are two possible outcomes: a successful response (response-monitor) or a rejection (response-reject). The diagram includes state markers 'START 4002' for the UE and 'START 4003' for the ProSe Function. A dashed line labeled 'OR' separates the two possible response paths. + +Sequence diagram illustrating the Monitor request procedure between a UE and a ProSe Function. The diagram shows two possible outcomes: a successful response (response-monitor) or a rejection (response-reject). + +**Figure 6.2.3.2.1: Monitor request procedure** + +### 6.2.3.3 Monitor request procedure accepted by the ProSe Function + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "monitor", if the Requested Timer is included in the DISCOVERY\_REQUEST message and the Requested Timer is set to 0, the ProSe Function shall check whether there is an existing UE context containing the discovery entry identified by the Discovery Entry ID included in the DISCOVERY\_REQUEST message. If the discovery entry exists in the UE context, the ProSe Function shall remove the discovery entry identified by the Discovery Entry ID from the UE's context. When the associated ProSe Application ID is PLMN-specific and that PLMN ID indicated by the ProSe Application ID is not the same as that of the PLMN to which the ProSe Function belongs, the ProSe Function shall inform the ProSe Function in the PLMN indicated by the ProSe Application ID to remove the corresponding discovery entry as specified in 3GPP TS 29.345 [5]. Then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message; +- the Discovery Entry ID set to the value of the Discovery Entry ID received in the DISCOVERY\_REQUEST message; and +- optionally the PC5\_tech set to the value of the PC5\_tech if it was received in the DISCOVERY\_REQUEST message. + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "monitor", if the Requested Timer is not included in the DISCOVERY\_REQUEST message, the ProSe Function shall perform the following procedure. + +The ProSe Function shall check that the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is authorised for open ProSe direct discovery monitoring. If the application is authorised for open ProSe direct discovery monitoring, the ProSe Function checks whether there is an existing context for the UE associated with the requested ProSe Application ID. + +If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for open ProSe direct discovery monitoring as described in 3GPP TS 29.344 [3]. The HSS provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. If the subscription check indicates that the UE is authorised, the ProSe Function creates a new context for the UE and a new discovery entry identified by a non-zero value Discovery Entry ID which is associated with the requested ProSe Application ID. + +If the ACE Enabled Indicator in the DISCOVERY\_REQUEST message is included and set to "application-controlled extension enabled" and the requested application uses application-controlled extension, the ProSe Function shall check whether the UE is authorised to use ACE. If the UE is authorised for ACE, the ProSe Function shall also use the procedure described in 3GPP TS 29.343 [31] to obtain the mask(s) for monitoring the ProSe Application Code Suffix (es) corresponding to the requested ProSe Application ID. + +If the PLMN ID indicated in the ProSe Application ID is PLMN-Specific and that PLMN ID is not the same as that of the PLMN to which the ProSe Function belongs, then the ProSe Function executes the procedures defined in 3GPP TS 29.345 [5] to obtain the Discovery Filter(s) for the ProSe Application ID. Otherwise, the ProSe Function shall allocate one or more Discovery Filters for the requested ProSe Application ID if it is known to the ProSe Function and at least one corresponding valid ProSe Application Code or ProSe Application Code Prefix is available in the ProSe Function. Each Discovery Filter consists of a ProSe Application Code, one or more ProSe Application Masks, and a TTL timer T4002. If application-controlled extension is used, the allocated Discovery Filter shall be applicable to match both prefix and suffix portions of the ProSe Application Code. If the requested ProSe Application ID is country-specific or global or PLMN-specific as defined respectively in subclause 24.2 of 3GPP TS 23.003 [4], the ProSe Function shall allocate the Discovery Filter which contains ProSe Application Code and ProSe Application Mask(s) in the corresponding scope. If the ProSe Application ID is country-specific or global, the ProSe Application Mask(s) enclosed in the Discovery Filter hides the PLMN ID part correspondingly and the temporary identity part is taken from the data structure corresponding to the global or country-wide ProSe Application ID namespace, as specified in subclause 24.3 of 3GPP TS 23.003 [4]. If the requested ProSe Application ID is PLMN-specific, the ProSe Function shall allocate one or more PLMN-specific Discovery Filters. Each of these Discovery Filters shall contain a PLMN-specific Prose Application Code and the ProSe Application Mask(s) whose PLMN ID portion shall be set such that when the mask is applied to the ProSe Application Code, the outcome matches the full PLMN ID of that specific PLMN. After the Discovery Filter(s) are allocated, the ProSe Function then associates the Discovery Filters with the new discovery entry in the UE context and starts timer T4003 assigned for each Discovery Filter. For a given Discovery Filter timer T4003 shall be longer than timer T4002. By default, the value of timer T4003 is 4 minutes greater than the value of timer T4002. + +If there is an existing context for the UE that contains the UE's subscription parameters obtained from the HSS, but no discovery entry identified by the Discovery Entry ID contained in the DISCOVERY\_REQUEST message, the ProSe Function shall check whether the UE is authorised for ProSe direct discovery monitoring. If the UE is authorised, the ProSe Function shall allocate the Discovery Filter as specified above. + +After the Discovery Filter is allocated, the ProSe Function then associates the Discovery Filter with a new discovery entry identified by a non-zero value Discovery Entry ID in the UE context, and starts timer T4003 assigned for each Discovery Filter. + +Similarly, if there is an existing context and a discovery entry identified by the Discovery Entry ID contained in the DISCOVERY\_REQUEST message for the UE associated with the requested ProSe Application ID, the ProSe Function updates the content of Discovery Filter(s), associate the discovery entry with the updated Discovery Filter(s) and restart timer T4003 for each filter. The update of a Discovery Filter content includes setting new TTL timer(s) and if necessary, assigning new ProSe Application Code or ProSe Application Code Prefix and ProSe Application Mask(s). + +Then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message from the UE; +- the Discovery Entry ID set to the identifier associated with the discovery entry; and +- if the ACE Enabled Indicator was included by the UE in the DISCOVERY\_REQUEST message, the ACE Enabled Indicator set to: + +- "application-controlled extension enabled" if application-controlled extension is used; or +- "normal" if application-controlled extension is not used; +- one or more Discovery Filters allocated by the ProSe Function(s) for the ProSe Application ID received in the DISCOVERY\_REQUEST message from the UE; and +- optionally the PC5\_tech set to the one or more PC5 radio technologies that may be used for the Discovery Filters allocated by the ProSe Function(s). + +If timer T4003 expires, the ProSe Function shall remove the UE's association with the corresponding Discovery Filter. Furthermore, the ProSe Function shall remove the discovery entry from the UE's context if there is no Discovery Filter corresponding to the ProSe Application ID. + +### 6.2.3.4 Monitor request procedure completion by the UE + +Upon receipt of the DISCOVERY\_RESPONSE message, if only the transaction ID and the Discovery Entry ID are contained in the element and the transaction ID and the Discovery Entry ID match the corresponding values sent by the UE in a DISCOVERY\_REQUEST message, the UE shall: + +- stop TTL timer T4002 for each Discovery Filter in the discovery entry identified by the Discovery Entry ID; +- remove the discovery entry identified by the Discovery Entry ID; and +- instruct the lower layers to stop monitoring. + +Upon receipt of the DISCOVERY\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a DISCOVERY\_REQUEST message with the command set to "monitor", the UE shall, for each Discovery Filter assigned by the ProSe Function, stop TTL timer T4002 if running and start TTL timer T4002 with the received value. Otherwise the UE shall discard the DISCOVERY\_RESPONSE message and shall not perform the procedures below. + +The UE may perform open ProSe direct discovery monitoring for discovery messages received over the PC5 interface as described below. + +For a ProSe Application ID requested by the monitoring UE, the ProSe Function may have assigned one or more Discovery Filters. If application-controlled extension is used, the UE may further apply additional filtering on the part corresponding to the ProSe Application Code Suffix. The UE should apply all assigned Discovery Filters to its monitoring operation. Using these Discovery Filters may result in a match event. In case of a match event, the UE shall consider that the ProSe Application ID it seeks to monitor has been discovered. A match event for open ProSe direct discovery is defined as follows: + +There is a match event when, for any of the ProSe Application Masks in a Discovery Filter, the output of a bitwise AND operation between the ProSe Application Code contained in the received PC5\_DISCOVERY message and the ProSe Application Mask, matches the output of a bitwise AND operation between the ProSe Application Mask and the ProSe Application Code contained in the same Discovery Filter. + +NOTE: A ProSe Application Mask with all bits set to "1" is assigned by the ProSe Function for full matching. + +The UE may instruct the lower layers to start monitoring if all of the following conditions are met: + +- the UE is currently authorized to perform E-UTRA-based open ProSe direct discovery monitoring in at least one PLMN or the UE is currently authorized to perform WLAN-based open ProSe direct discovery monitoring; +- the UE has obtained at least one Discovery Filter and their respective TTL timer T4002(s) have not expired; and +- a request from upper layers to monitor for the ProSe Application ID associated with an authorised Application Identity is still in place. + +In case of E-UTRA-based open ProSe direct discovery monitoring, if the UE is in EMM-CONNECTED mode, the monitoring UE shall also trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +During the monitoring operation, the UE receives all PC5\_DISCOVERY messages and associated UTC times from the lower layers. The UE shall generate the UTC-based counter corresponding to the UTC time associated with a PC5\_DISCOVERY message and only process the PC5\_DISCOVERY message if the UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE. + +During the monitoring operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop monitoring. When the UE stops monitoring, in case of E-UTRA-based open ProSe direct discovery monitoring if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +### 6.2.3.5 Monitor request procedure not accepted by the ProSe Function + +If the DISCOVERY\_REQUEST message is not accepted by the ProSe Function, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is not authorised for open ProSe direct discovery monitoring, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid application". + +If the ProSe Application ID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #2 "Unknown ProSe Application ID". + +If the UE is not authorised for open ProSe direct discovery monitoring, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the UE requests a country-specific ProSe Application ID for a country that does not correspond to the country of its HPLMN, and the ProSe Function has not authorized the UE to monitor in that country, it shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #8 "Scope Violation in Prose Application ID". + +If the UE requests a country-specific ProSe Application ID for a country that does not correspond to the country of its HPLMN, and the ProSe Function has no agreement to access the country-specific ProSe Application ID database of that country, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #8 "Scope Violation in Prose Application ID". + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function and the Requested Timer is set to 0, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or invalid Discovery Entry ID". + +If the ProSe Function cannot retrieve a valid ProSe Application Code corresponding to the ProSe Application ID contained in the DISCOVERY\_REQUEST message, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #17 "No Valid ProSe Application Code". + +If the UE is not authorised to use ACE, but the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #12 "UE unauthorised for discovery with Application-Controlled Extension". + +If the DISCOVERY\_REQUEST message does not contain the ACE Enabled Indicator and the requested application only uses application-controlled extension, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid Application". + +### 6.2.3.6 Abnormal cases + +#### 6.2.3.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_REQUEST message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the monitor request procedure. + +- b) No response from the ProSe Function after the DISCOVERY\_REQUEST message has been successfully delivered (e.g. TCP ACK has been received for the DISCOVERY\_REQUEST message) + +The UE shall retransmit the DISCOVERY\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Indication from upper layers that the request to monitor the ProSe Application ID is no longer in place after sending the DISCOVERY\_REQUEST message, but before the monitor request procedure is completed + +The UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its contents and then abort the procedure. + +- d) Change of PLMN + +If a PLMN change occurs before the monitor request procedure is completed, the procedure shall be aborted. If the UE is authorized to monitor in the new PLMN, the procedures shall be restarted once the UE is registered on the new PLMN. + +### 6.2.3.6.2 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_RESPONSE message + +After receiving an indication from lower layer that the DISCOVERY\_RESPONSE message has not been successfully acknowledged, the ProSe Function shall abort the procedure, and stop any associated timer(s) T4003, if running. + +## 6.2.3A Monitor request procedure for restricted ProSe direct discovery model A + +### 6.2.3A.1 General + +The purpose of the monitor request procedure for restricted ProSe direct discovery model A is: + +- to allow a UE participating in restricted ProSe direct discovery model A to receive and process PC5\_DISCOVERY messages upon a request for monitoring from upper layers as defined in 3GPP TS 23.303 [2]; or +- to inform the ProSe Function that the UE wants to stop using Restricted Discovery Filter(s) for direct discovery monitoring as defined in 3GPP TS 23.303 [2]. + +The UE shall only initiate the restricted ProSe direct discovery model A monitor request procedure if it has been authorised for restricted ProSe direct discovery model A monitoring in at least in one PLMN based on the service authorisation procedure. + +As a result of the monitor request procedure completing successfully, the UE obtains one or more Restricted Discovery Filters, along with a TTL (Time-To-Live) timer T4009 for each Restricted Discovery Filter indicating the time during which the filter is valid. + +### 6.2.3A.2 Monitor request procedure Initiation + +Before initiating the monitor request procedure, the user sets the permissions for the restricted discovery using application layer mechanisms. The application client in the UE retrieves the PDUID provisioned to the UE as part of the service authorisation procedure as specified in clause 5, and obtains an RPAUID associated with the UE's PDUID and the target RPAUID(s) to be monitored from the ProSe Application Server. This step is performed using mechanisms that are out of scope of the present specification. + +If the UE is authorised to perform ProSe direct discovery model A monitoring in at least one PLMN, it shall initiate a monitor request procedure: + +- a) when the UE is triggered by an upper layer application to perform restricted ProSe direct discovery model A monitoring corresponding to at least one RPAUID, and the UE has no valid Restricted Discovery Filters corresponding to the requested RPAUID for that upper layer application; or + +- b) when the TTL timer T4009 assigned by the ProSe Function to a Restricted Discovery Filter has expired and the request from upper layers to monitor that RPAUID is still in place; or + +NOTE 1: To ensure service continuity if the UE needs to keep monitoring the same Restricted Discovery Filter, the UE can initiate the monitor request procedure before the TTL timer T4009 assigned by the ProSe Function for a Restricted Discovery Filter expires. + +- c) when the UE needs to update a previously sent restricted ProSe direct discovery model A monitoring request. + +The UE initiates the monitor request procedure by sending a DISCOVERY\_REQUEST message with: + +- a new transaction ID; +- the RPAUID set to the RPAUID received from upper layers; +- the command set to "monitor"; +- the Discovery Type set to "Restricted discovery" +- the UE identity set to the UE's IMSI; +- the Application Identity set to the Application Identity of the upper layer application that requested the monitoring; +- the ACE Enabled Indicator set to "application-controlled extension enabled" if application-controlled extension is required by the upper layers, or "normal" if application-controlled extension is not used; +- the Application Level Container set to the target RPAUIDs to monitor; +- the Discovery Entry ID set to 0 if the monitoring request is a new request, and set to the Discovery Entry ID received from the ProSe Function if the monitoring request is to update a previously sent monitoring request; +- optionally, the Requested Timer set to 0 only when the UE wants to stop using Restricted Discovery Filter(s) for direct discovery monitoring; and +- optionally the PC5\_tech set to the PC5 radio technology that the UE wishes to use for monitoring. PC5\_tech may include more than one PC5 radio technology. + +If restricted direct discovery model A with application-controlled extension is requested by upper layers, the Application Level Container included in the DISCOVERY\_REQUEST also contains information corresponding to the ProSe Restricted Code Suffix, e.g. group or user-specific information. + +NOTE 2: A UE can include one or multiple transactions in one DISCOVERY\_REQUEST message for one or more different monitoring targets, and receive corresponding element or element in the DISCOVERY\_RESPONSE message for each respective transaction. In the following description of the monitor request procedure, only one transaction is included. + +Figure 6.2.3A.2.1 illustrates the interaction between the UE and the ProSe Function in the monitor request procedure. + +![Sequence diagram illustrating the Monitor request procedure for restricted ProSe direct discovery model A. The diagram shows two possible paths for the response from the ProSe Function to the UE. In the first path, the ProSe Function sends a DISCOVER_RESPONSE with a element. In the second path, after an 'OR' condition, the ProSe Function sends a DISCOVER_RESPONSE with a element. The UE initiates the process with a DISCOVER_REQUEST.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note left of UE: Start 4009 + UE->>ProSe Function: DISCOVER_REQUEST + Note right of ProSe Function: Start 4010 + ProSe Function-->>UE: DISCOVER_RESPONSE (restricted-monitor-response) + Note right of ProSe Function: OR + ProSe Function-->>UE: DISCOVER_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the Monitor request procedure for restricted ProSe direct discovery model A. The diagram shows two possible paths for the response from the ProSe Function to the UE. In the first path, the ProSe Function sends a DISCOVER\_RESPONSE with a element. In the second path, after an 'OR' condition, the ProSe Function sends a DISCOVER\_RESPONSE with a element. The UE initiates the process with a DISCOVER\_REQUEST. + +**Figure 6.2.3A.2.1: Monitor request procedure for restricted ProSe direct discovery model A** + +### 6.2.3A.3 Monitor request procedure accepted by the ProSe Function + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "monitor" and the Discovery Type set to "Restricted discovery", if the Requested Timer is included in the DISCOVERY\_REQUEST message and the Requested Timer is set to 0, the ProSe Function shall check whether there is an existing UE context containing the discovery entry identified by the Discovery Entry ID included in the DISCOVERY\_REQUEST message. If the discovery entry exists in the UE context, the ProSe Function shall remove the discovery entry identified by the Discovery Entry ID from the UE's context. For each of the PDUIDs corresponding to the target RPAUIDs contained the Restricted Discovery Filters in the discovery entry, if the PDUID is PLMN-specific and that PLMN ID indicated by the PDUID is not the same as that of the PLMN to which the ProSe Function belongs, the ProSe Function shall inform the ProSe Function in the PLMN indicated by the PDUID to remove the corresponding discovery entry as specified in 3GPP TS 29.345 [5]. Then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message; +- the Discovery Entry ID set to the value of the Discovery Entry ID received in the DISCOVERY\_REQUEST message; and +- optionally the PC5\_tech set to the value of the PC5\_tech if it was received in the DISCOVERY\_REQUEST message. + +Upon receiving a DISCOVERY\_REQUEST message with the command set to "monitor" and the Discovery Type set to "Restricted discovery", if the Requested Timer is not included in the DISCOVERY\_REQUEST message, the ProSe Function shall perform the following procedure. + +The ProSe Function shall check that the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is authorised for ProSe direct discovery model A monitoring. If the application is authorised for restricted ProSe direct discovery model A monitoring, the ProSe Function shall check whether there is an existing UE context. + +If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for restricted ProSe direct discovery model A monitoring as described in 3GPP TS 29.344 [3]. The HSS provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. If the subscription check indicates that the UE is authorised, the ProSe Function creates a new UE context containing the UE's subscription parameters obtained from the HSS. + +If the Discovery Entry ID included in the DISCOVERY\_REQUEST is set to 0 then: + +- the ProSe Function shall use the procedure described in 3GPP TS 29.343 [31] to pass the Application Level Container included in the DISCOVERY\_REQUEST message to the ProSe Application Server and obtain a list of PDUID(s) , an Application Level Container and optionally Metadata Indicator(s) corresponding to the authorised target RPAUID(s) from the ProSe Application Server; +- if the ACE Enabled Indicator in the DISCOVERY\_REQUEST message is set to "application-controlled extension enabled" and the requested application uses application-controlled extension, the ProSe Function shall check whether the UE is authorized to use ACE. If the UE is authorized for ACE, the ProSe Function shall also use the procedure described in 3GPP TS 29.343 [31] to obtain the mask(s) for monitoring a ProSe Restricted Suffix Pool corresponding to each of the Target RPAUIDs. + +NOTE 1: The ProSe Application Server can reject the request for some of the target RPAUIDs included in the Application Level Container in the DISCOVERY\_REQUEST message because they are ineligible to be monitored by the requesting UE. Depending on the operator policy and application layer permissions, it is possible that only a subset of valid RPAUIDs are authorised by the ProSe Application Server. + +- for each of the PDUIDs corresponding to an authorised target RPAUID, if the PLMN ID of the PDUID is not the same as that of the PLMN to which the ProSe Function belongs, then the ProSe Function executes the procedures defined in 3GPP TS 29.345 [5] to obtain the ProSe Restricted Code or ProSe Restricted Code Prefix for the target RPAUID and creates Restricted Discovery Filter(s). Otherwise, for each target RPAUID, the ProSe Function shall allocate one or more Restricted Discovery Filter(s). If the ACE Enabled Indicator in the DISCOVERY\_REQUEST message does not match the ACE configuration in the ProSe Function or ProSe Application Server for this application, the ACE configuration in the ProSe Function or ProSe Application Server shall be used to create Restricted Discovery Filter(s). Each Restricted Discovery Filter consists of a ProSe Restricted Code, one or more masks, a TTL timer T4009, optionally the target RPAUID, optionally a metadata indicator and optionally metadata associated with this RPAUID; +- the ProSe Function associates the Restricted Discovery Filters with a new discovery entry in the UE's context; and +- the ProSe Function starts timer T4010 assigned for each Restricted Discovery Filter. For a given Restricted Discovery Filter, timer T4010 shall be longer than timer T4009. By default, the value of timer T4010 is 4 minutes greater than the value of timer T4009. + +NOTE 2: For each target RPAUID, the ProSe Function either allocates one Restricted Discovery Filter for full-matching the ProSe Restricted Code assigned to this RPAUID, or allocates one or more Restricted Discovery Filter(s) for matching the ProSe Restricted Code Prefix and Suffix Pool assigned to this RPAUID. + +If the Discovery Entry ID included in the DISCOVERY\_REQUEST message is not set to 0 and if there is an existing discovery entry for this Discovery Entry ID in the UE's context, the ProSe Function shall check whether the UE is authorised for restricted ProSe direct discovery model A monitoring. If the UE is authorised, the ProSe Function shall process the request as above-mentioned and update this discovery entry with the contents of the Restricted Discovery Filter(s) associated with this discovery entry and restart timer T4010(s) for each filter. The update of a Restricted Discovery Filter content includes setting new TTL timer(s) and if necessary, obtaining new ProSe Restricted Code and ProSe Restricted Mask(s) via the procedure defined in 3GPP TS 29.345 [5]. + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is not found in the UE context or there is no UE context in the ProSe Function, the ProSe Function shall behave as if the Discovery Entry ID included in the DISCOVERY\_REQUEST message was set to 0, and the ProSe Function shall allocate a new non-zero Discovery Entry ID for this entry. + +Then the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message from the UE; +- one or more Restricted Discovery Filter(s) allocated by the ProSe Function(s) for the authorised target RPAUID(s); +- the ACE Enabled Indicator set to "application-controlled extension enabled" if application-controlled extension is used, or "normal" if application-controlled extension is not used; + +- the Discovery Entry ID set to the ID of the discovery entry associated with this monitor request; +- the Application Level Container set to the application-level data received from the ProSe Application Server; and +- optionally the PC5\_tech set to the one or more PC5 radio technologies that may be used for the Restricted Discovery Filters allocated by the ProSe Function(s). + +If T4010 expires, the ProSe Function shall remove the corresponding Restricted Discovery Filter from the discovery entry in the UE's context. Furthermore, if there are no valid Restricted Discovery Filters associated with the discovery entry (e.g, all Restricted Discovery Filters have expired), the ProSe Function shall delete the discovery entry from the UE's context. + +#### 6.2.3A.4 Monitor request procedure completion by the UE + +Upon receipt of the DISCOVERY\_RESPONSE message, if only the transaction ID and the Discovery Entry ID are contained in element and the transaction ID and the Discovery Entry ID match the corresponding values sent by the UE in a DISCOVERY\_REQUEST message with the command set to "monitor", the UE shall: + +- stop TTL timer T4009 for each Restricted Discovery Filter in the discovery entry identified by the Discovery Entry ID; +- remove the discovery entry identified by the Discovery Entry ID; and +- instruct the lower layers to stop monitoring. + +Upon receipt of the DISCOVERY\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a DISCOVERY\_REQUEST message with the command set to "monitor" and, the UE shall process as follow: + +- If the DISCOVERY\_RESPONSE creates a new discovery entry, start the TTL timer T4009 with the received value for each Restricted Discovery Filter information element received in the DISCOVERY\_RESPONSE message. +- If the DISCOVERY\_RESPONSE updates an existing discovery entry, the UE shall + - stop the T4009 timer(s) of any Restricted Discovery Filter in this discovery entry which are no longer authorized by the ProSe Function, ask lower layers to stop using those filters in monitoring operation, and remove the corresponding Restricted Discovery Filter from the discovery entry; + - restart the T4009 timer(s) for those remain eligible; and + - start the T4009 timer(s) for any new Restricted Discovery Filter(s) included in the DISCOVERY\_RESPONSE message. + +Otherwise the UE shall discard the DISCOVERY\_RESPONSE message and shall not perform the procedures below. + +The UE may perform monitoring for discovery messages received over the PC5 interface as described below. + +The UE provides the Application Level Container, which contains the authorised Target RPAUID(s), to the upper layer applications. For each authorised target RPAUID, the ProSe Function may have assigned one or more Restricted Discovery Filters. If application-controlled extension is used, the UE may further apply additional filtering on the part corresponding to the ProSe Restricted Code Suffix. The UE should then apply all Restricted Discovery Filters to its monitoring operation. Using these Restricted Discovery Filters may result in a match event. In case of a match event, the UE shall consider that the target RPAUID it seeks to monitor has been discovered. A match event is defined as follows: + +There is match event when, for any of the masks in a Restricted Discovery Filter, the output of a bitwise AND operation between the ProSe Restricted Code contained in the received PC5\_DISCOVERY message and the mask, matches the output of a bitwise AND operation between the mask and the code contained in the same Restricted Discovery Filter. + +NOTE: In a Restricted Discovery Filter, a mask with all bits set to "1" is assigned by the ProSe Function for full matching of a ProSe Restricted Code. + +When applying a Restricted Discovery Filter to a received PC5\_DISCOVERY message for the above-mentioned bitwise AND operation, the UE shall use the DUSK, if received as part of the filter in the DISCOVERY\_RESPONSE message, and the UTC-based counter generated during the monitoring operation, to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is included as part of the filter, the UE shall use the DUCK and the UTC-based counter to decrypt the message-specific confidentiality protected portion identified by the Encrypted Bitmask, as described in 3GPP TS 33.303 [6]; + +NOTE: The UE can look for a match on the unencrypted bits first before applying DUCK, to minimise the amount of processing performed before finding a match. + +If a DUIK is received as part of the filter, the UE shall use the DUIK and the UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message. If a MIC Check Indicator parameter is included instead, the UE shall use the match report procedure described in subclause 6.2.4A to trigger checking of the MIC of the PC5\_DISCOVERY message containing the ProSe Restricted Code by the ProSe Function. + +The UE may instruct the lower layers to start monitoring if all of the following conditions are met: + +- the UE is currently authorized to perform E-UTRA-based restricted ProSe direct discovery model A monitoring in at least one PLMN or the UE is currently authorized to perform WLAN-based restricted ProSe direct discovery model A monitoring; +- the UE has obtained at least one Restricted Discovery Filter and their respective TTL timer T4009(s) have not expired; and +- a request from upper layers to monitor for the RPAUID(s) associated with an authorised Application Identity is still in place. + +In case of E-UTRA-based restricted ProSe direct discovery model A monitoring if the UE is in EMM-CONNECTED mode, the monitoring UE shall also trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +During the monitoring operation, the UE receives all PC5\_DISCOVERY messages and associated UTC times from the lower layers. The UE shall generate the UTC-based counter corresponding to the UTC time associated with a PC5\_DISCOVERY message and only process the PC5\_DISCOVERY message if the UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE. + +During the monitoring operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop monitoring. When the UE stops monitoring, in case of E-UTRA-based restricted ProSe direct discovery model A monitoring if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +### 6.2.3A.5 Monitor request procedure not accepted by the ProSe Function + +If the DISCOVERY\_REQUEST message is not accepted by the ProSe Function, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is not authorised for ProSe direct discovery monitoring, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid application". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Application Server, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #9 "Unknown RPAUID". + +If none of the RPAUID(s) contained in the Application Level Container in the DISCOVERY\_REQUEST message is eligible to be discovered by the requesting RPAUID, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #11 "Invalid Discovery Target". + +If the RPAUID contained in the DISCOVERY\_REQUEST message does not match the stored RPAUID for the requested Discovery Entry ID, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +If the UE is not authorised for restricted ProSe direct discovery monitoring, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is not associated with a PDUID belonging to the requesting UE, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation Failure". + +If the UE is not authorized to use ACE, but the DISCOVERY\_REQUEST message contains the ACE Enabled Indicator set to "application-controlled extension enabled", the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #12 "UE unauthorised for discovery with Application-Controlled Extension". + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function and the Requested Timer is set to 0, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or invalid Discovery Entry ID". + +## 6.2.3A.6 Abnormal cases + +### 6.2.3A.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_REQUEST message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the monitor request procedure. + +- b) No response from the ProSe Function after the DISCOVERY\_REQUEST message has been successfully delivered (e.g. TCP ACK has been received for the DISCOVERY\_REQUEST message) + +The UE shall retransmit the DISCOVERY\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Indication from upper layers that the request to monitor the targets contained in Application Level Container is no longer in place after sending the DISCOVERY\_REQUEST message, but before the monitor request procedure is completed + +The UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its contents and then abort the procedure. + +- d) Change of PLMN + +If a PLMN change occurs before the monitor request procedure is completed, the procedure shall be aborted. If the UE is authorized to monitor in the new PLMN, the procedures shall be restarted once the UE is registered on the new PLMN. + +### 6.2.3A.6.2 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_RESPONSE message + +After receiving an indication from lower layer that the DISCOVERY\_RESPONSE message has not been successfully acknowledged, the ProSe Function shall abort the procedure, and stop any associated timer(s) T4010, if running. + +## 6.2.3B Discoverer request procedure for restricted ProSe direct discovery model B + +### 6.2.3B.1 General + +The purpose of the discoverer request procedure for restricted ProSe direct discovery model B is for the UE to obtain ProSe Query Code(s) and Discovery Response Filter(s) to be used for sending query and monitoring responses over the PC5 interface based on the information provided by the upper layer application, as defined in 3GPP TS 23.303 [2]. + +Before initiating the discoverer request procedure, the UE shall be authorised for restricted ProSe direct discovery model B discoverer operation in the registered PLMN or the local PLMN based on the service authorisation procedure as specified in clause 5. + +NOTE: The notion of "local PLMN" does not apply for WLAN-based ProSe direct discovery. The UE can engage in WLAN-based ProSe direct discovery as announcing UE regardless of the serving PLMN or other PLMNs that provide E-UTRAN coverage in the UE location. + +As the result of successful completion of this procedure, the UE obtains one or more ProSe Query Code(s) which can be included in a PC5\_DISCOVERY message and passes the PC5\_DISCOVERY message to the lower layers for transmission over the PC5 interface. The UE also obtains Discovery Response Filter(s) and apply it to the monitoring operation in PC5 interface to match potential responses for the sent query request for the target RPAUID. + +### 6.2.3B.2 Discoverer request procedure initiation + +Before initiating the discoverer request procedure, the user sets the permissions for the restricted discovery using application layer mechanisms. The application client in the UE retrieves the PDUID provisioned to the UE as part of the service authorisation procedure as specified in clause 5 and obtains an RPAUID associated with the UE's PDUID from the ProSe Application Server. The UE may also obtain the target RPAUID(s) from the ProSe Application Server. This step is performed using mechanisms that are out of scope of the present specification. + +If the UE is authorised to perform E-UTRA-based restricted ProSe direct discovery model B discoverer operation in the PLMN operating the radio resources signalled from the serving PLMN, or if the UE is authorised to perform WLAN-based restricted ProSe direct discovery model B discoverer operation it shall initiate a discoverer request procedure: + +- a) when the UE is triggered by an upper layer application to perform the query for one or more target RPAUIDs in Model B and the UE has no valid corresponding ProSe Query Code and Discovery Response Filter for those target RPAUIDs of the upper layer application; +- b) when the validity timer T4013 assigned by the ProSe Function to a ProSe Query Codes and the corresponding Discovery Response Filter has expired and the request from upper layers to announce the RPAUID corresponding to that ProSe Response Code is still in place; +- c) when the UE selects a new PLMN while announcing a ProSe Query Code or waiting for a ProSe Response Code and intends to announce the ProSe Query Code in the new PLMN, and the UE is authorised for restricted ProSe direct discovery model B discoverer operation in the new PLMN; +- d) when, while querying for target RPAUID(s), the UE intends to switch the announcing PLMN to a different PLMN without performing PLMN selection, and the UE does not have a valid allocated ProSe Query Code for this new PLMN yet; or +- e) when the UE needs to update a previously sent restricted ProSe direct discovery model B discoverer request. + +When the UE selects a new PLMN while announcing a ProSe Query Code or waiting for a ProSe Response Code and the UE is not yet authorised for restricted ProSe direct discovery model B discoverer operation in the new PLMN, the UE shall initiate a discoverer request procedure only after the UE is authorised for restricted ProSe direct discovery model B discoverer operation in the new PLMN. + +NOTE 1: To ensure service continuity if the UE needs to keep announcing in Model B a ProSe Query Code corresponding to the same RPAUID, the UE can initiate the discoverer request procedure before the validity timer T4013 assigned by the ProSe Function for a ProSe Query Code expires. + +The UE initiates the discoverer request procedure by sending a DISCOVERY\_REQUEST message with: + +- a new transaction ID not used in any other direct discovery procedures in PC3 interface; + +- the RPAUID set to the RPAUID received from upper layers; +- the Application Level Container set to contain the application-layer information, e.g., target RPAUID(s) to discover; +- the command set to "query"; +- the UE identity set to the UE's IMSI; +- the Application Identity set to the Application Identity of the upper layer application that requested the announcing; +- the Discovery Type set to "Restricted discovery"; +- the Discovery Model set to "Model B"; +- the Discovery Entry ID set to a 0 if the discoverer request is a new request, and set to the Discovery Entry ID received from the ProSe Function if the discoverer request is to update a previously sent discoverer request; +- optionally in case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation the Announcing PLMN ID set to the PLMN ID of the local PLMN operating the radio resources that the UE intends to use for transmitting the query for the target RPAUID(s); and +- optionally the PC5\_tech set to the PC5 radio technology that the UE wishes to use. PC5\_tech may include more than one PC5 radio technology. + +NOTE 2: A UE can include one or multiple transactions in one DISCOVERY\_REQUEST message for different discovering requests (e.g., for different applications), and receive corresponding element or element in a DISCOVERY\_RESPONSE message for each respective transaction. In the following description of the discoverer request procedure, only one transaction is included. + +Figure 6.2.3B.2.1 illustrates the interaction of the UE and the ProSe Function in the discoverer request procedure. + +![Sequence diagram illustrating the discoverer request procedure for restricted ProSe direct discovery model B. The diagram shows two possible outcomes: a successful response or a response-reject.](3e8e3bdb3d90f0856266d4eaf36abba1_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note left of UE: Start 4013 + UE->>ProSe Function: DISCOVERY_REQUEST + Note right of ProSe Function: Start 4014 + ProSe Function-->>UE: DISCOVERY_RESPONSE (restricted-discoverer-response) + Note right of UE: OR + Note left of UE: Start 4013 + UE->>ProSe Function: DISCOVERY_REQUEST + Note right of ProSe Function: Start 4014 + ProSe Function-->>UE: DISCOVERY_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the discoverer request procedure for restricted ProSe direct discovery model B. The diagram shows two possible outcomes: a successful response or a response-reject. + +Figure 6.2.3B.2.1: Discoverer request procedure for restricted ProSe direct discovery model B + +### 6.2.3B.3 Discoverer request procedure accepted by the ProSe Function + +Upon receiving a DISCOVERY\_REQUEST message, the ProSe Function shall check that the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is authorised for restricted ProSe direct discovery model B discoverer operation. If the application is authorised for restricted ProSe direct discovery model B discoverer operation, the ProSe Function shall check whether there is an existing context for the UE. + +If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for restricted ProSe direct discovery model B discoverer operation as described in 3GPP TS 29.344 [3]. If the check indicates that the UE is authorised, the ProSe Function creates a UE context that contains the UE's subscription parameters obtained from the HSS. The HSS also provides to the ProSe Function the PLMN ID of the PLMN in which the UE is currently registered. + +If the UE context exists, the ProSe Function shall check whether the UE is authorized for restricted ProSe direct discovery model B discoverer operation in the currently registered PLMN or in case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation the local PLMN identified by the Announcing PLMN ID included in the DISCOVERY\_REQUEST message. + +If the UE is authorized and the Discovery Entry ID included in the DISCOVERY\_REQUEST message is set to 0 then: + +- the ProSe Function shall use the procedure described in 3GPP TS 29.343 [31] to pass the Application Level Container included in the DISCOVERY\_REQUEST message to the ProSe Application Server and obtain a list of PDUID(s) corresponding to the authorised target RPAUID(s) from the ProSe Application Server; +- for each of the PDUIDs corresponding to an authorised target RPAUID: + - if the PLMN ID of the PDUID is not the same as that of the PLMN to which the ProSe Function belongs, then the ProSe Function executes the procedures defined in 3GPP TS 29.345 [5] to obtain the ProSe Query Code, the ProSe Response Code, the associated validity timer T4012, and optionally metadata associated with this target RPAUID. Otherwise, the ProSe Function shall locate the discoverer UE context and retrieve the corresponding ProSe Query Code and ProSe Response Code and the validity timer T4012, and optionally metadata associated with this RPAUID. Then, the ProSe Function in the HPLMN builds one or more Discovery Response Filter(s) based on the respective ProSe Response Code, and associate the Discovery Response Filter(s) and ProSe Query Code with a new validity timer T4013 based on the remaining value of T4012. + +NOTE 1: If the ProSe Function cannot retrieve the corresponding discoverer UE context for a target RPAUID, e.g. the target RPAUID has not yet been requested to be discovered by Model B in a discoverer request procedure, or the discoverer UE context expires, the ProSe Function can skip the processing of this target RPAUID. + +NOTE 2: The ProSe Function can choose the value of T4013 to be longer than the remaining value of T4012, so that the discoverer UE sends a new discoverer request for renewing the query-related information no earlier than the discoverer UE renewing its own ProSe Response Code with the ProSe Function. + +- the ProSe Function associates the ProSe Query Code and corresponding Discovery Response Filter(s), target RPAUID, and optionally metadata associated with the target RPAUID with a new discovery entry in the discoverer UE's context; and +- the ProSe Function starts timer T4014 assigned for each ProSe Query Code and Discovery Response Filter(s) (of each target RPAUID) under this discovery entry of the discoverer UE context. For a given ProSe Query Code and the corresponding Discovery Response Filter(s), timer T4014 shall be longer than timer T4013. By default, the value of timer T4014 is 4 minutes greater than the value of timer T4013. + +If the Discovery Entry ID included in the DISCOVERY\_REQUEST message is not set to 0 and if there is an existing discovery entry for this Discovery Entry ID value in the UE's context, the ProSe Function shall still process the above steps, but update the discovery entry instead of creating a new discovery entry. + +If the Discovery Entry ID contained in the DISCOVERY\_REQUEST message is not found in the UE context or there is no UE context in the ProSe Function, the ProSe Function shall behave as if the Discovery Entry ID included in the DISCOVERY\_REQUEST message was set to 0, and the ProSe Function shall allocate a new non-zero Discovery Entry ID for this entry. + +If a new UE context was created or an existing UE context was updated, the UE is currently roaming or the Announcing PLMN ID is included in the DISCOVERY\_REQUEST message, the ProSe Function checks with the ProSe Function of the VPLMN or in case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation the local PLMN indicated by the Announcing PLMN ID whether the UE is authorised for restricted ProSe direct discovery model B discoverer operation as described in 3GPP TS 29.345 [5]. + +The ProSe Function shall then send a DISCOVERY\_RESPONSE message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the DISCOVERY\_REQUEST message from the UE; +- one or more Subquery Result information elements, each of which includes: + - a target RPAUID; + - the ProSe Query Code set to the ProSe Query Code for the target RPAUID; + - one or more the Discovery Response Filters IE which are set to include the Discovery Response Filter(s) used to match a potential ProSe Response Code responding to the ProSe Query Code.; + - a validity timer T4013 set to the T4013 timer value assigned by the ProSe Function to the ProSe Query Code and the Discovery Response Filter(s); and + - optionally, the metadata associated with the target RPAUID; + - the Restricted Security IE containing the security key(s) needed to be used with Discovery Response Filter(s) for restricted discovery monitoring; +- the Discovery Entry ID set to the ID of the discovery entry associated with this announce request in the UE context; and +- optionally the PC5\_tech set to the one or more PC5 radio technologies that are authorized to be used for the assigned ProSe Query Code. + +If T4014 expires, the ProSe Function shall remove the corresponding ProSe Query Code and ProSe Response Filter(s) from the discovery entry associated with the discoverer UE's context. + +#### 6.2.3B.4 Discoverer request procedure completion by the UE + +Upon receipt of the DISCOVERY\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a DISCOVERY\_REQUEST message with the command set to "query" and the Discovery Model set to "Model B", the UE shall, process as follow: + +- If the DISCOVERY\_RESPONSE creates a new discovery entry, start the validity timer T4013 with the received value for the ProSe Query Code and the corresponding Discovery Response Filter(s) included for each SubQuery-Result information element received in the DISCOVERY\_RESPONSE message and the PLMN ID of the intended announcing PLMN if included in the DISCOVERY\_REQUEST message; +- If the DISCOVERY\_RESPONSE updates an existing discovery entry, the UE shall + - stop the timer T4013 of any ProSe Query Code(s) and Discovery Response Filter(s) in this discovery entry which are no longer authorized by the ProSe Function, ask lower layers to stop announcing the ProSe Query Code(s) and monitoring ProSe Response Filter(s), and remove the ProSe Query Code(s) and Discovery Response Filter(s) from the existing discovery entry; + - restart the T4013 timer(s) for those remain eligible; + - start the T4013 timer(s) for any new ProSe Query Codes and their corresponding Discovery Response Filter(s); and + - update the PLMN ID of the intended announcing PLMN for this discovery entry if included in the DISCOVERY\_REQUEST message. + +Otherwise the UE shall discard the DISCOVERY\_RESPONSE message and shall not perform the procedures below. + +For each ProSe Query Code in this discovery entry, the UE requests the lower layers to announce the ProSe Query Code in the PC5 interface, as specified in 3GPP TS 36.331 [12]. In case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation this shall be done only if the lower layers indicate that ProSe direct discovery is supported by the network. In case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation if the UE in EMM-IDLE mode has to request resources for ProSe direct discovery announcing as specified in 3GPP TS 36.331 [12], the UE shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]. The UE shall obtain the UTC time for the next discovery transmission opportunity for ProSe direct discovery from the lower layers. + +If a valid UTC time is obtained, the UE shall generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18. If the resulting UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE, the UE shall for each ProSe Query Code in this discovery entry, use the ProSe Query Code to construct a PC5\_DISCOVERY message, according to the format defined in subclause 11.2.5. + +The UE shall then apply one or more of the DUIK, DUSK or DUCK with the associated Encrypted Bitmask, whichever received in the Restricted Code Security Material parameter of the DISCOVERY\_RESPONSE message, along with the UTC-based counter to the PC5\_DISCOVERY message, to e.g. generate a MIC value, scramble the message contents or provide confidentiality protection, as specified in 3GPP TS 33.303 [6]. + +The UE then passes the resulting PC5\_DISCOVERY message, along with the PLMN ID of the intended announcing PLMN stored for this discovery entry, to the lower layers for transmission and instruct the lower layers to start monitoring if: + +- the UE is currently authorised to perform restricted ProSe direct discovery model B discoverer operation in the registered PLMN or in case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation the local PLMN operating the radio resources that the UE intends to use; +- the validity timer T4013 for the ProSe Query Code and corresponding ProSe Response Filter(s) has not expired; and +- a request from upper layers to query the target RPAUID in restricted discovery Model B, associated with both the ProSe Query Code, and the authorised Application Identity, is still in place. + +During the discoverer operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop the discoverer operation. When the UE stops discoverer operation, in case of E-UTRA-based restricted ProSe direct discovery model B discoverer operation if the lower layers indicate that the UE is required to send a discovery indication to the eNodeB and the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +The UE shall ensure that it keeps on passing PC5\_DISCOVERY messages to the lower layers for transmission until the validity timer T4013 of the ProSe Query Code expires. How this is achieved is left up to UE implementation. + +The UE may apply the received Discovery Response Filter(s) to its monitoring operation. Using the Discovery Response Filter may result in a match event for the target RPAUID the UE is querying for. There is match event when, for any of the masks in a Discovery Response Filter, the output of a bitwise AND operation between the ProSe Response Code contained in the received PC5\_DISCOVERY message and the mask, matches the output of a bitwise AND operation between the mask and the code contained in the Discovery Response Filter. + +When applying a Discovery Response Filter to a received PC5\_DISCOVERY message for the bitwise AND operation, the UE shall use the DUSK, if received as part of the filter in the DISCOVERY\_RESPONSE message, and the UTC-based counter generated during the monitoring operation, to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is included as part of the filter, the UE shall use the DUCK and the UTC-based counter to decrypt the message-specific confidentiality protected portion identified by the Encrypted Bitmask, as described in 3GPP TS 33.303 [6]; + +NOTE: The UE can look for a match on the unencrypted bits first before applying DUCK, to minimise the amount of processing performed before finding a match. + +If a DUIK is received as part of the filter, the UE shall use the DUIK and the UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message. If a MIC Check Indicator parameter is included instead, the UE shall use the match report procedure described in subclause 6.2.4B to trigger checking of the MIC of the PC5\_DISCOVERY message containing the ProSe Response Code by the ProSe Function. + +The UE may notify the upper layer application about the match event of restricted ProSe direct discovery Model B with the corresponding target RPAUID and metadata, if the RPAUID and meta-data are included in the Subquery Result element in the DISCOVERY\_RESPONSE message. + +### 6.2.3B.5 Discoverer request procedure not accepted by the ProSe Function + +If the DISCOVERY\_REQUEST message cannot be accepted by the ProSe Function, the ProSe Function sends a DISCOVERY\_RESPONSE message containing a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the application corresponding to the Application Identity contained in the DISCOVERY\_REQUEST message is not authorised for restricted ProSe direct discovery Model B discoverer operation, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #1 "Invalid application". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is unknown to the ProSe Function or ProSe Application Server, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #9 "Unknown RPAUID". + +If the RPAUID contained in the DISCOVERY\_REQUEST message does not match the stored RPAUID for the requested Discovery Entry ID, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +If the UE is not authorised for restricted ProSe direct discovery model B discoverer operation, the ProSe Function shall send the DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +If the RPAUID contained in the DISCOVERY\_REQUEST message is not associated with a PDUID belonging to the requesting UE, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #3 "UE authorisation Failure". + +If the ProSe Function fails to retrieve any valid target PDUIDs from ProSe Application Server based on the Application Level Container contained in the DISCOVERY\_REQUEST message, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #11 "Invalid discovery target". + +If the ProSe Function fails to retrieve any valid discoveree UE contexts for the valid target RPAUIDs contained in the Application Level Container contained in the DISCOVERY\_REQUEST message, the ProSe Function shall send a DISCOVERY\_RESPONSE message containing a element with PC3 Control Protocol cause value #11 "Invalid discovery target". + +## 6.2.3B.6 Abnormal cases + +### 6.2.3B.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_REQUEST message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the discoverer request procedure. + +- b) No response from the ProSe Function after the DISCOVERY\_REQUEST message has been successfully delivered (e.g., TCP ACK has been received for the DISCOVERY\_REQUEST message) + +The UE shall retransmit the DISCOVERY\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Indication from upper layers that the request to discover the target RPAUID(s) is no longer in place after sending the DISCOVERY\_REQUEST message, but before the discoverer request procedure is completed + +The UE shall acknowledge the DISCOVERY\_RESPONSE message received from the ProSe Function but discard its contents and then abort the procedure. + +- d) Change of PLMN + +If a PLMN change occurs before the discoverer request procedure is completed, the procedure shall be aborted. If the UE is authorized to perform restricted ProSe direct discovery discoverer operation Model B in the new PLMN, the procedure shall be restarted once the UE is registered on the new PLMN. + +### 6.2.3B.6.2 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_RESPONSE message + +After receiving an indication from lower layer that the DISCOVERY\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the ProSe Function shall abort the procedure, and stop any associated timer(s) T4014, if running. + +## 6.2.4 Match report procedure for open ProSe direct discovery + +### 6.2.4.1 General + +The purpose of the Match report procedure for open ProSe direct discovery is to allow a UE to send a ProSe Application Code that was matched during the monitoring operation and receive the corresponding ProSe Application ID or the updated metadata, if there is no such a mapping stored locally or the Metadata Index in the ProSe Application Code indicates the metadata is updated. + +The UE shall only initiate the match report procedure if it has been authorised for open ProSe direct discovery monitoring in the monitored PLMN based on the service authorisation procedure. + +As a result of the match report procedure completing successfully, the UE obtains a ProSe Application ID and potentially other information, which the UE may store locally and pass to the upper layers. + +### 6.2.4.2 Match report procedure initiation + +The UE shall meet the following pre-conditions before initiating this procedure: + +- a request from upper layers to monitor for the ProSe Application ID, which resulted in the matched ProSe Application Code, is still in place; +- the lower layers have provided a "Monitored PLMN ID" value, and UTC time information, along with the discovery message containing a ProSe Application Code; and +- the TTL timer T4002 associated with the Discovery Filter, which resulted in a match event of the ProSe Application Code, has not expired. + +If the UE is authorised to perform open ProSe direct discovery monitoring in the monitored PLMN, it should initiate a match report procedure: + +- a) when there is a match event of one of the ProSe Application Codes received from the lower layers, and the UE does not have a corresponding ProSe Application ID already locally stored; +- b) when the UE has a locally stored mapping for the ProSe Application Code that resulted in a match event, but the validity timer T4004 of the ProSe Application Code has expired; +- c) when the UE has a locally stored mapping for the ProSe Application Code that resulted in a match event, but the match report refresh timer T4006 of the ProSe Application Code has expired; or +- d) when there is a match event of one of the ProSe Application Codes received from the lower layers, and the UE has a locally stored ProSe Application Code excluding the Metadata Index portion located by the locally stored Metadata Index Mask. + +The UE initiates the match report procedure for open ProSe direct discovery by sending a MATCH\_REPORT message with a new transaction ID and shall set the message contents as follows: + +- the UE shall set the ProSe Application Code to the ProSe Application Code for which there was a match event; +- the UE shall set the UE identity to the UE's IMSI; +- the UE shall set the UTC-based counter as follows: + - the UE shall generate two UTC-based counters with: + - 1) the first counter composed of: + +- the 27 most significant bits of the UTC-based counter set to the 27 most significant bits of the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event encoded as specified in subclause 12.2.2.18; + - the 28th most significant bit of the UTC-based counter set to '0'; and + - the 4 least significant bits of the UTC-based counter shall be set to the 4 least significant bits of the UTC-based counter contained in the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event, as specified in 3GPP TS 33.303 [6]; and +- 2) the second counter composed of: +- the 27 most significant bits of the UTC-based counter set to the 27 most significant bits of the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event encoded as specified in subclause 12.2.2.18; + - the 28th most significant bit of the UTC-based counter set to '1'; and + - the 4 least significant bits of the UTC-based counter set to the 4 least significant bits of the UTC-based counter contained in the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event, as specified in 3GPP TS 33.303 [6]; and +- then the UE shall select, among the two counters described above, the counter that is nearest to the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event encoded as specified in subclause 12.2.2.18, and set the UTC-based counter in the MATCH\_REPORT message to that counter; + - the UE shall set the MIC to the MIC of the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event; + - the UE shall set the Message Type to the value of Message Type field of the PC5\_DISCOVERY message that contained the ProSe Application Code for which there was a match event; + - the UE shall set the Monitored PLMN ID to the PLMN ID of the PLMN where the PC5\_DISCOVERY message was received, as provided by the lower layers; + - if the UE was roaming when the match event occurred, the UE shall set the VPLMN ID to the PLMN ID of the PLMN in which the UE was registered when the match event occurred; + - the UE shall set the Metadata Flag to indicate whether or not it wishes to receive metadata information associated with the ProSe Application ID in the MATCH\_REPORT\_ACK message from the ProSe Function; and + - optionally the PC5\_tech set to the PC5 radio technology for which there was a match event. PC5\_tech may include more than one PC5 radio technology. + +NOTE 1: A UE can include one or multiple transactions in one MATCH\_REPORT message for different ProSe Application Codes, and receive corresponding element or element in the MATCH\_REPORT\_ACK message for each respective transaction. In the following description of match report procedure, only one transaction is included. + +NOTE 2: The value of the Metadata Flag is determined through an indication from upper layers in the original request to monitor for a ProSe Application ID. + +Figure 6.2.4.2.1 illustrates the interaction between the UE and the ProSe Function in the match report procedure. + +![Sequence diagram illustrating the Match report procedure between a UE and a ProSe Function. The UE sends a MATCH_REPORT message to the ProSe Function. The ProSe Function responds with either a MATCH_REPORT_ACK (match-ack) with status 4004, or a MATCH_REPORT_ACK (match-reject) with status 4006. A dashed line separates the two possible outcomes.](5801c19431e76330430e92a598cc7a16_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: P r o S e +F u n c t i o n + UE->>ProSe Function: M A T C H _ R E P O R T + ProSe Function-->>UE: M A T C H _ R E P O R T _ A C K ( m a t c h - a c k ) + Note left of UE: S t a t u s 4 0 0 4 + Note left of UE: S t a t u s 4 0 0 6 + Note right of ProSe Function: ----- O R ----- + UE->>ProSe Function: M A T C H _ R E P O R T + ProSe Function-->>UE: M A T C H _ R E P O R T _ A C K ( m a t c h - r e j e c t ) + +``` + +Sequence diagram illustrating the Match report procedure between a UE and a ProSe Function. The UE sends a MATCH\_REPORT message to the ProSe Function. The ProSe Function responds with either a MATCH\_REPORT\_ACK (match-ack) with status 4004, or a MATCH\_REPORT\_ACK (match-reject) with status 4006. A dashed line separates the two possible outcomes. + +**Figure 6.2.4.2.1: Match report procedure** + +### 6.2.4.3 Match report procedure accepted by the ProSe Function + +Upon receiving a MATCH\_REPORT message, the ProSe Function shall check whether there is an existing context for the UE identified by its IMSI. If there is no associated UE context, the ProSe Function checks with the HSS whether the UE is authorised for open ProSe direct discovery monitoring as described in 3GPP TS 29.344 [3]. + +The ProSe Function shall also check the PLMN ID in the ProSe Application Code received from the UE. If the PLMN ID in the ProSe Application Code is not the same of that of the PLMN to which the ProSe Function belongs, the ProSe Function shall execute the procedures defined in 3GPP TS 29.345 [5]. Otherwise, the ProSe Function shall check whether the received ProSe Application Code is authorised to be transmitted on the monitored PLMN indicated in the Monitored PLMN ID in the received message. + +If the ProSe Application Code is PLMN-specific, the ProSe Function shall verify if the PLMN ID in the ProSe Application Code is the same as the PLMN of the ProSe Function. If so, the ProSe Function shall map the ProSe Application Code to the corresponding ProSe Application ID from the PLMN-specific database. If the ProSe Application Code is country-specific, as specified in subclause 24.3 of 3GPP TS 23.003 [4], the ProSe Function shall check whether the MCC of the PLMN ID part of the ProSe Application Code corresponds to the country of the ProSe Function. If so, the ProSe Function shall map the ProSe Application Code to the corresponding ProSe Application ID from the country-specific database. If the ProSe Application Code is global as specified in subclause 24.3 of 3GPP TS 23.003 [4], the ProSe Function shall map the ProSe Application Code to the corresponding ProSe Application ID from the global database. If the ProSe Application Code contains a ProSe Application Code Prefix, the ProSe Function maps the ProSe Application Code Prefix to the corresponding ProSe Application ID. + +The ProSe Function shall analyse the ProSe Application Code received from the UE and determine the validity of the ProSe Application Code. + +NOTE: This might require the ProSe Function to execute procedures defined in 3GPP TS 29.345 [5]. + +The ProSe Function shall check if the MIC value and its corresponding UTC-based counter are valid, as defined in 3GPP TS 33.303 [6]. + +If the VPLMN ID is included in the MATCH\_REPORT message, the ProSe Function uses it for charging purposes as specified in 3GPP TS 32.277 [27]. + +If the outcome of above processing is successful, the ProSe Function shall send a MATCH\_REPORT\_ACK message containing a element with: + +- the transaction ID set to the value of the transaction ID received in the MATCH\_REPORT message from the UE; +- the ProSe Application ID set to the ProSe Application ID provided by the ProSe Function and corresponding to the ProSe Application Code contained in the MATCH\_REPORT message; +- the Validity Timer T4004 set to indicate for how long this ProSe Application Code is valid; and +- the Match Report Refresh Timer T4006 set to indicate for how long the UE will wait before sending a new Match Report for this ProSe Application Code. + +If the UE has set the Metadata Flag to indicate that it wishes to receive metadata information associated with the ProSe Application ID, the ProSe Function shall set the Metadata to the metadata information associated with the ProSe Application Code received in the MATCH\_REPORT message and set the Metadata Index Mask to the Metadata Index Mask allocated by the ProSe Function for the ProSe Application Code received in the MATCH\_REPORT message. + +#### 6.2.4.4 Match report procedure completion by the UE + +Upon receipt of the MATCH\_REPORT\_ACK message, if the transaction ID contained in the element matches the value sent by the UE in a MATCH\_REPORT message, the UE shall store the mapping between the ProSe Application Code and ProSe Application ID locally, start timers T4004 and T4006, and may inform the upper layers of this match of the ProSe Application ID. If the Metadata Index Mask is contained in the MATCH\_REPORT\_ACK message, the UE shall also store the Metadata Index Mask with the ProSe Application Code and the ProSe Application ID locally. If there is a locally stored mapping between the ProSe Application ID and a ProSe Application Code, the UE shall delete the old mapping. Otherwise the UE shall discard the MATCH\_REPORT\_ACK message. + +Upon receipt of the MATCH\_REPORT\_ACK message, if the transaction ID contained in the element matches the value sent by the UE in a MATCH\_REPORT message and if the received PC3 Control Protocol cause value is #5 "Invalid MIC", as specified in subclause 6.2.4.5, the UE shall stop timer T4004 if it is running. + +NOTE 1: It is an implementation specific choice whether the UE informs the upper layers every time a ProSe Application ID triggers a match event, or only the first time this match occurs. + +NOTE 2: The UE can also inform the upper layers if a ProSe Application ID is no longer matched, because the validity timer T4004 of the corresponding ProSe Application Code expires. + +NOTE 3: The UE can also inform the upper layers if a ProSe Application ID is no longer matched, because the validity timer T4004 of the corresponding ProSe Application Code is stopped upon receiving MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #5 "Invalid MIC". + +#### 6.2.4.5 Match report procedure not accepted by the ProSe Function + +If the MATCH\_REPORT message is not accepted by the ProSe Function, the ProSe Function sends a MATCH\_REPORT\_ACK message with a element to the UE including an appropriate PC3 Control Protocol cause value. + +If the ProSe Application Code contained in the MATCH\_REPORT message is unknown by the ProSe Function, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #4 "Unknown ProSe Application Code". + +If the check of the MIC contained in the MATCH\_REPORT message fails, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #5 "Invalid MIC". + +If the check of the UTC-based counter contained in the MATCH\_REPORT message fails, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #6 "Invalid UTC-based counter". + +If the UE is not authorised for open ProSe direct discovery monitoring in the monitored PLMN contained in the MATCH\_REPORT message, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +## 6.2.4.6 Abnormal cases + +### 6.2.4.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of MATCH\_REPORT message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the match report procedure. + +- b) No response from the ProSe Function after the MATCH\_REPORT message has been successfully delivered (e.g. TCP ACK has been received for the MATCH\_REPORT message) + +If the TTL timer T4002 associated with the Discovery Filter which resulted in a match event has not expired, the UE shall retransmit the MATCH\_REPORT message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- c) Change of PLMN + +If a PLMN change occurs before the match report procedure is completed, the procedure shall be aborted. + +## 6.2.4A Match report procedure for restricted ProSe direct discovery model A + +### 6.2.4A.1 General + +The purpose of the match report procedure is to allow a UE to send a ProSe Restricted Code that was matched during the monitoring operation and receive the corresponding RPAUID, if there is no such a mapping stored locally. + +The UE shall only initiate the match report procedure if it has been authorised for restricted ProSe direct discovery monitoring model A in the monitored PLMN based on the service authorisation procedure. + +As a result of the match report procedure completing successfully, the UE obtains a RPAUID and potentially other information, which the UE may store locally and pass to the upper layers. + +### 6.2.4A.2 Match report procedure initiation + +The UE shall meet the following pre-conditions before initiating this procedure: + +- a request from upper layers to monitor for the target RPAUID, which resulted in the matched ProSe Restricted Code, is still in place; +- the lower layers have provided UTC time information, along with the discovery message containing the ProSe Restricted Code; and +- the TTL timer T4009 associated with the Restricted Discovery Filter, whose use resulted in a match event of the ProSe Restricted Code, has not expired. + +If the UE is authorised to perform restricted ProSe direct discovery monitoring model A in the monitored PLMN, it should initiate a match report procedure: + +- a) when there is a match event after applying one of the Restricted Discovery Filter(s) to a ProSe Restricted Code received from the lower layers, and the UE does not have a corresponding RPAUID already locally stored; +- b) when the UE has a locally stored mapping for the ProSe Restricted Code that resulted in a match event, but the validity timer T4016 of the ProSe Restricted Code has expired; +- c) when the UE has a locally stored mapping for the ProSe Restricted Code that resulted in a match event, but the match report refresh timer T4017 of the ProSe Restricted Code has expired; +- d) when the UE desires to obtain the metadata associated with the discovered ProSe Restricted Code; or + +- e) when the UE has a locally stored mapping for the ProSe Restricted Code that resulted in a match event, but the UE does not have a running match report refresh timer T4017 for this ProSe Restricted Code and the UE is directed by the ProSe Function to perform the required MIC check via the match report procedure. + +NOTE 1: The ProSe Function directs the UE to use the match report procedure to perform the MIC check by including the MIC Check Indicator parameter in the DISCOVERY\_RESPONSE message. + +The UE initiates the match report procedure by sending a MATCH\_REPORT message with a new transaction ID and shall set the message contents as follows: + +- the RPAUID set to the UE's RPAUID which has requested the corresponding monitoring operation that resulted this match event; +- the ProSe Restricted Code set to the ProSe Restricted Code for which there was a match event; +- the UE identity set to the UE's IMSI; +- the Discovery Type set to "Restricted discovery"; +- the Application Identity set to the Application Identity of the upper layer application that triggered the monitoring operation; +- optionally, the UTC-based counter set as follows if the MIC is checked via the match report procedure: + - the UE shall generate two UTC-based counters with: + - 1) the first counter composed of: + - the 23 most significant bits of the UTC-based counter set to the 23 most significant bits of the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event encoded as specified in subclause 12.2.2.18; + - the 24th most significant bit of the UTC-based counter set to '0'; and + - the 8 least significant bits of the UTC-based counter set to the 8 least significant bits of the UTC-based counter contained in the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event, as specified in 3GPP TS 33.303 [6]; and + - 2) the second counter composed of: + - the 23 most significant bits of the UTC-based counter set to the 23 most significant bits of the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event encoded as specified in subclause 12.2.2.18; + - the 24th most significant bit of the UTC-based counter set to '1'; and + - the 8 least significant bits of the UTC-based counter set to the 8 least significant bits of the UTC-based counter contained in the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event, as specified in 3GPP TS 33.303 [6]; and + - then the UE shall select, among the two counters described above, the counter that is nearest to the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event encoded as specified in subclause 12.2.2.18, and set the UTC-based counter in the MATCH\_REPORT message to that counter; +- optionally, the Message Type set to the value of Message Type field of the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event, if the MIC is checked via the match report procedure; +- optionally, the MIC set to the MIC of the PC5\_DISCOVERY message that contained the ProSe Restricted Code for which there was a match event if the MIC is checked via the match report procedure; +- the Metadata Flag set to indicate whether or not the UE wishes to receive the latest metadata information associated with the RPAUID in the MATCH\_REPORT\_ACK message from the ProSe Function; and + +- optionally the PC5\_tech set to the PC5 radio technology for which there was a match event. PC5\_tech may include more than one PC5 radio technology. + +NOTE 2: A UE can include one or multiple transactions in one MATCH\_REPORT message for different ProSe Restricted Codes, and receive a corresponding element or element in the MATCH\_REPORT\_ACK message for each respective transaction. In the following description of match report procedure, only one transaction is included. + +Figure 6.2.4A.2.1 illustrates the interaction between the UE and the ProSe Function in the match report procedure. + +![Sequence diagram illustrating the match report procedure for restricted discovery model A between a UE and a ProSe Function.](d6c377ae3e619ff992bd3647dbf43593_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note left of UE: Start T4016 + UE->>ProSe Function: MATCH_REPORT (restricted-match) + ProSe Function-->>UE: MATCH_REPORT_ACK (restricted-match-ack) + Note right of ProSe Function: OR + Note left of UE: Start T4016 + UE->>ProSe Function: MATCH_REPORT (restricted-match) + ProSe Function-->>UE: MATCH_REPORT_ACK (match-reject) + +``` + +The diagram shows two possible outcomes for the match report procedure. In the first path, the UE sends a MATCH\_REPORT (restricted-match) message to the ProSe Function, and the ProSe Function responds with a MATCH\_REPORT\_ACK (restricted-match-ack) message. In the second path, after a dashed line labeled 'OR', the UE sends another MATCH\_REPORT (restricted-match) message, and the ProSe Function responds with a MATCH\_REPORT\_ACK (match-reject) message. Both paths start with a 'Start T4016' timer activation at the UE. + +Sequence diagram illustrating the match report procedure for restricted discovery model A between a UE and a ProSe Function. + +Figure 6.2.4A.2.1: Match report procedure for restricted discovery model A + +### 6.2.4A.3 Match report procedure accepted by the ProSe Function + +Upon receiving a MATCH\_REPORT message, the ProSe Function shall check whether there is an existing context for the UE identified by its IMSI. + +The ProSe Function shall analyse the ProSe Restricted Code received from the UE in the MATCH\_REPORT message. If the MIC value and its corresponding UTC-based counter are included, the ProSe Function shall check whether the MIC value and the UTC-based counter are valid and within the acceptable range respectively as defined in 3GPP TS 33.303 [6]. The ProSe Function shall then check in the UE context if the ProSe Restricted Code matches any Restricted Discovery Filter(s) allocated for the particular application identified by the Application Identity received in the MATCH\_REPORT message. If such a discovery filter exists, the target RPAUID associated with the filter(s) shall be identified as the corresponding RPAUID for this code. Optionally, the ProSe Function may further invoke the procedure defined in 3GPP TS 29.343 [31] to verify if the target RPAUID is allowed to be discovered by the RPAUID of the requesting UE that has sent the MATCH\_REPORT message, or to retrieve metadata associated for the target RPAUID if Metadata Flag is set to "True" in the MATCH\_REPORT message and the ProSe Function does not have the latest metadata. + +If the outcome of the above processing is successful, the ProSe Function shall send a MATCH\_REPORT\_ACK message containing a element with the transaction ID set to the value of the transaction ID received in the MATCH\_REPORT message from the UE, the RPAUID set to the target RPAUID retrieved from the UE context at the ProSe Function which corresponds to the ProSe Restricted Code contained in the MATCH\_REPORT message, and the Validity Timer T4016 set to indicate for how long this ProSe Restricted Code is valid. The ProSe Function shall set the Match Report Refresh Timer T4017 to indicate for how long the UE will wait before sending a new Match Report for this ProSe Restricted Code if the MIC value and the UTC-based counter are included in the + +MATCH\_REPORT message. If there exists metadata information associated with this target RPAUID and the Metadata Flag is set to "True" in the MATCH\_REPORT message, the ProSe Function shall set the Metadata to the associated metadata information. + +If the corresponding PDUID of the target RPAUID does not belong to the HPLMN of the requesting UE, the ProSe Function may optionally invoke the procedure defined in 3GPP TS 29.345 [5] to inform the ProSe Function of the announcing UE about the match event. + +#### 6.2.4A.4 Match report procedure completion by the UE + +Upon receipt of the MATCH\_REPORT\_ACK message, if the transaction ID contained in the element matches the value sent by the UE in a MATCH\_REPORT message, the UE shall store the mapping between the ProSe Restricted Code and RPAUID locally, start timers T4016 and T4017, and may inform the upper layers of this match of the RPAUID. Otherwise the UE shall discard the MATCH\_REPORT\_ACK message. + +Upon receipt of the MATCH\_REPORT\_ACK message, if the transaction ID contained in the element matches the value sent by the UE in a MATCH\_REPORT message and if the received PC3 Control Protocol cause value is #5 "Invalid MIC", as specified in subclause 6.2.4A.5, the UE shall stop timer T4016 if it is running. + +NOTE 1: It is an implementation specific choice whether the UE informs the upper layers every time an RPAUID triggers a match event, or only the first time this match occurs. + +NOTE 2: The UE can also inform the upper layers if an RPAUID is no longer matched, because the validity timer T4016 of the corresponding ProSe Restricted Code expires. + +NOTE 3: The UE can also inform the upper layers if a ProSe Restricted Code is no longer matched, because the validity timer T4016 of the corresponding ProSe Restricted Code is stopped upon receiving MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #5 "Invalid MIC". + +#### 6.2.4A.5 Match report procedure not accepted by the ProSe Function + +If the MATCH\_REPORT message is not accepted by the ProSe Function, the ProSe Function sends a MATCH\_REPORT\_ACK message with a element to the UE including an appropriate PC3 Control Protocol cause value. + +If there is no associated UE context for the IMSI contained in the MATCH\_REPORT message, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #16 "Invalid Match Event". + +If the ProSe Restricted Code contained in the MATCH\_REPORT message does not match any Restricted Discovery Filter(s) allocated for the requesting UE for the corresponding application,, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #16 "Invalid Match Event". + +If the check of the MIC contained in the MATCH\_REPORT message fails, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #5 "Invalid MIC". + +If the check of the UTC-based counter contained in the MATCH\_REPORT message fails, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #6 "Invalid UTC-based counter". + +If the UE is not authorised for restricted ProSe direct discovery monitoring, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +#### 6.2.4A.6 Abnormal cases + +##### 6.2.4A.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of MATCH\_REPORT message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the match report procedure. + +- b) No response from the ProSe Function after the MATCH\_REPORT message has been successfully delivered (e.g. TCP ACK has been received for the MATCH\_REPORT message) + +If the TTL timer T4009 associated with the Restricted Discovery Filter which resulted in a match event has not expired, the UE shall retransmit the MATCH\_REPORT message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +## 6.2.4B Match report procedure for restricted ProSe direct discovery model B + +### 6.2.4B.1 General + +The purpose of the Match report procedure is to allow a UE to send a ProSe Response Code that was matched during the restricted ProSe direct discovery Model B discoverer operation and receive the corresponding RPAUID, if there is no such a mapping stored locally. + +The UE shall only initiate the match report procedure if it has been authorised for restricted ProSe direct discovery model B discoverer operation in the monitored PLMN based on the service authorisation procedure. + +As a result of the match report procedure completing successfully, the UE obtains a RPAUID and potentially other information, which the UE may store locally and pass to the upper layers. + +### 6.2.4B.2 Match report procedure initiation + +The UE shall meet the following pre-conditions before initiating this procedure: + +- a request from upper layers to discover the target RPAUID with restricted discovery model B, which resulted in the matched ProSe Response Code, is still in place; +- the lower layers have provided UTC time information, along with the discovery message containing the ProSe Response Code; and +- the TTL timer T4013 associated with the Discovery Response Filter, whose use resulted in a match event of the ProSe Response Code, has not expired. + +If the UE is authorised to perform restricted ProSe direct discovery model B discoverer operation in the monitored PLMN, it should initiate a match report procedure: + +- a) when there is a match event when applying one of the Discovery Response Filter(s) to one of the ProSe Response Codes received from the lower layers, and the UE does not have a corresponding RPAUID already locally stored; +- b) when the UE has a locally stored mapping for the ProSe Response Code that resulted in a match event, but the validity timer T4016 of the ProSe Response Code has expired; +- c) when the UE has a locally stored mapping for the ProSe Response Code that resulted in a match event, but the match report refresh timer T4017 of the ProSe Response Code has expired; +- d) when the UE desires to obtain the metadata associated with the discovered ProSe Response Code; or +- e) when the UE has a locally stored mapping for the ProSe Response Code that resulted in a match event, but the UE does not have a running match report refresh timer T4017 for this ProSe Response Code and the UE is directed by the ProSe Function to perform the required MIC check via the match report procedure. + +NOTE 1: The ProSe Function directs the UE to use the match report procedure to perform the MIC check by including the MIC Check Indicator parameter in the DISCOVERY\_RESPONSE message. + +The UE initiates the match report procedure by sending a MATCH\_REPORT message with a new transaction ID and shall set the message contents as follows: + +- the RPAUID set to the UE's RPAUID which has requested the corresponding restricted discovery model B discoverer operation that resulted this match event; +- the ProSe Response Code set to the ProSe Response Code for which there was a match event; +- the UE identity set to the UE's IMSI; +- the Discovery Type set to "Restricted discovery"; +- the Application Identity set to the Application Identity of the upper layer application that triggered the restricted direct discovery Model B discoverer operation; +- optionally, the UTC-based counter set as follows if the MIC is checked via the match report procedure: + - the UE shall generate two UTC-based counters with: + - 1) the first counter composed of: + - the 27 most significant bits of the UTC-based counter set to the 27 most significant bits of the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event encoded as specified in subclause 12.2.2.18; + - the 24th most significant bit of the UTC-based counter set to '0'; and + - the 8 least significant bits of the UTC-based counter shall be set to the 8 least significant bits of the UTC-based counter contained in the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event, as specified in 3GPP TS 33.303 [6]; and + - 2) the second counter composed of: + - the 23 most significant bits of the UTC-based counter set to the 23 most significant bits of the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event encoded as specified in subclause 12.2.2.18; + - the 24th most significant bit of the UTC-based counter set to '1'; and + - the 8 least significant bits of the UTC-based counter set to the 8 least significant bits of the UTC-based counter contained in the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event, as specified in 3GPP TS 33.303 [6]; and + - then the UE shall select, among the two counters described above, the counter that is nearest to the UTC time provided by the lower layers for the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event encoded as specified in subclause 12.2.2.18, and set the UTC-based counter in the MATCH\_REPORT message to that counter; +- optionally, the Message Type set to the value of Message Type field of the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event, if the MIC is checked via the match report procedure; +- optionally, the MIC to the MIC of the PC5\_DISCOVERY message that contained the ProSe Response Code for which there was a match event if the MIC is checked via the match report procedure; +- the Metadata Flag set to indicate whether or not the UE wishes to receive the latest metadata information associated with the RPAUID in the MATCH\_REPORT\_ACK message from the ProSe Function; and +- optionally the PC5\_tech set to the PC5 radio technology for which there was a match event. PC5\_tech may include more than one PC5 radio technology. + +NOTE 2: A UE can include one or multiple transactions in one MATCH\_REPORT message for different ProSe Response Codes, and receive corresponding element or element in the MATCH\_REPORT\_ACK message for each respective transaction. In the following description of match report procedure, only one transaction is included. + +Figure 6.2.4B.2.1 illustrates the interaction between the UE and the ProSe Function in the match report procedure. + +![Sequence diagram illustrating the match report procedure for restricted discovery model B. The diagram shows two possible outcomes for the ProSe Function's response to a MATCH_REPORT message from a UE. In the first path, the ProSe Function responds with a MATCH_REPORT_ACK (restricted-match-ack), which includes the T4016 timer. In the second path, separated by an 'OR' condition, the ProSe Function responds with a MATCH_REPORT_ACK (match-reject).](2a476a0b3dbc3429436246db4784ff9f_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note left of UE: Start T4016 + UE->>ProSe Function: MATCH_REPORT (restricted-match) + ProSe Function-->>UE: MATCH_REPORT_ACK (restricted-match-ack) + Note right of ProSe Function: OR + Note right of ProSe Function: ----- + Note right of ProSe Function: MATCH_REPORT (restricted-match) + ProSe Function-->>UE: MATCH_REPORT_ACK (match-reject) + +``` + +Sequence diagram illustrating the match report procedure for restricted discovery model B. The diagram shows two possible outcomes for the ProSe Function's response to a MATCH\_REPORT message from a UE. In the first path, the ProSe Function responds with a MATCH\_REPORT\_ACK (restricted-match-ack), which includes the T4016 timer. In the second path, separated by an 'OR' condition, the ProSe Function responds with a MATCH\_REPORT\_ACK (match-reject). + +**Figure 6.2.4A.2.1: Match report procedure for restricted discovery model B** + +### 6.2.4B.3 Match report procedure accepted by the ProSe Function + +Upon receiving a MATCH\_REPORT message, the ProSe Function shall check whether there is an existing discoverer UE context for the UE identified by its IMSI. + +The ProSe Function shall analyse the ProSe Response Code received from the UE in the MATCH\_REPORT message. If the MIC value and its corresponding UTC-based counter are included, the ProSe Function shall check whether the MIC value and the UTC-based counter are valid and within the acceptable range respectively, as defined in 3GPP TS 33.303 [6]. The ProSe Function shall then check in the UE context if the ProSe Response Code matches any Discovery Response Filter(s) allocated for the particular application identified by the Application Identity received in the MATCH\_REPORT message. If such a discovery filter exists, the target RPAUID associated with the filter(s) shall be identified as the corresponding RPAUID for this code. Optionally, the ProSe Function may further invoke the procedure defined in 3GPP TS 29.343 [31] to verify if the target RPAUID is allowed to be discovered by the RPAUID of the requesting UE that has sent the MATCH\_REPORT message, or to retrieve metadata associated for the target RPAUID if Metadata Flag is set to "True" in the MATCH\_REPORT message and the ProSe Function does not have the latest metadata. + +If the outcome of the above processing is successful, the ProSe Function shall send a MATCH\_REPORT\_ACK message containing a element with the transaction ID set to the value of the transaction ID received in the MATCH\_REPORT message from the UE, the RPAUID set to the target RPAUID retrieved from the UE context at the ProSe Function which corresponds to the ProSe Response Code contained in the MATCH\_REPORT message, the Validity Timer T4016 set to indicate for how long this ProSe Response Code is valid. The ProSe Function shall set the Match Report Refresh Timer T4017 to indicate for how long the UE will wait before sending a new Match Report for this ProSe Response Code if the MIC value and the UTC-based counter are included in the MATCH\_REPORT message. If there exists metadata information associated with this target RPAUID, the ProSe Function shall set the Metadata to the associated metadata information. + +If the corresponding PDUID of the target RPAUID does not belong to the HPLMN of the requesting UE, the ProSe Function may optionally invoke the procedure defined in 3GPP TS 29.345 [5] to inform the ProSe Function of the discoverer UE about the match event. + +#### 6.2.4B.4 Match report procedure completion by the UE + +Upon receipt of the MATCH\_REPORT\_ACK message, if the transaction ID contained in the element matches the value sent by the UE in a MATCH\_REPORT message, the UE shall store the mapping between the ProSe Response Code and the RPAUID locally, start timers T4016 and T4017, and may inform the upper layers of this match of the RPAUID. Otherwise the UE shall discard the MATCH\_REPORT\_ACK message. + +Upon receipt of the MATCH\_REPORT\_ACK message, if the transaction ID contained in the element matches the value sent by the UE in a MATCH\_REPORT message and if the received PC3 Control Protocol cause value is #5 "Invalid MIC", as specified in subclause 6.2.4A.5, the UE shall stop timer T4016 if it is running. + +NOTE 1: It is an implementation specific choice whether the UE informs the upper layers every time a RPAUID triggers a match event, or only the first time this match occurs. + +NOTE 2: The UE can also inform the upper layers if an RPAUID is no longer matched, because the validity timer T4016 of the corresponding ProSe Response Code expires. + +NOTE 3: The UE can also inform the upper layers if a ProSe Response Code is no longer matched, because the validity timer T4016 of the corresponding ProSe Response Code is stopped upon receiving MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #5 "Invalid MIC". + +#### 6.2.4B.5 Match report procedure not accepted by the ProSe Function + +If the MATCH\_REPORT message is not accepted by the ProSe Function, the ProSe Function sends a MATCH\_REPORT\_ACK message with a element to the UE including an appropriate PC3 Control Protocol cause value. + +If there is no associated UE context for the IMSI contained in the MATCH\_REPORT, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #16 "Invalid Match Event". + +If the ProSe Response Code contained in the MATCH\_REPORT message does not match any Discovery Response Filter(s) allocated for the requesting UE for the corresponding application,, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #16 "Invalid Match Event". + +If the check of the MIC contained in the MATCH\_REPORT message fails, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #5 "Invalid MIC". + +If the check of the UTC-based counter contained in the MATCH\_REPORT message fails, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #6 "Invalid UTC-based counter". + +If the UE is not authorised for restricted ProSe direct discovery model B discoverer operation, the ProSe Function shall send the MATCH\_REPORT\_ACK message with a element with PC3 Control Protocol cause value #3 "UE authorisation failure". + +#### 6.2.4B.6 Abnormal cases + +##### 6.2.4B.6.1 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of MATCH\_REPORT message (e.g. after TCP retransmission timeout) + +The UE shall close the existing secure connection to the ProSe Function, establish a new secure connection and then restart the match report procedure. + +- b) No response from the ProSe Function after the MATCH\_REPORT message has been successfully delivered (e.g. TCP ACK has been received for the MATCH\_REPORT message) + +If the TTL timer T4013 associated with the Discovery Response Filter which resulted in a match event has not expired, the UE shall retransmit the MATCH\_REPORT message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +## 6.2.5 Direct discovery time synchronisation by the Prose Function + +To ensure time synchronisation as specified in 3GPP TS 33.303 [6], the ProSe Function shall include timing-related information in parameters Current Time and Max Offset as defined in subclause 12.2.2.23 and subclause 12.2.2.24 in the DISCOVERY\_RESPONSE message. It shall also include Current Time in MATCH\_REPORT\_ACK message. + +After receiving the Current Time parameter in a DISCOVERY\_RESPONSE or MATCH\_REPORT\_ACK message, the UE shall set the clock used for ProSe to the value of Current Time. After receiving the Max Offset parameter in a DISCOVERY\_RESPONSE message, the UE shall store the Max Offset parameter and overwrite any previous value. + +## 6.2.6 Discovery Update + +### 6.2.6.1 General + +The discovery update procedure is used to update the discovery filters and/or allocate a new ProSe Restricted Code as defined in 3GPP TS 23.303 [2]. + +### 6.2.6.2 Revocation of Restricted Discovery Filters + +#### 6.2.6.2.1 Restricted Discovery filters revocation procedure initiation + +The ProSe Function in the HPLMN initiates the restricted discovery filters revocation procedure by sending the DISCOVERY\_UPDATE\_REQUEST to the UE with: + +- a new ProSe Function transaction ID not used in any other direct discovery procedures in PC3 interface; +- the UE identity set to the UE's IMSI; +- the Discovery Entry ID set to the Discovery Entry ID of the corresponding Discovery Entry that contains the Restricted Discovery Filter to be revoked; and +- Optionally Update Info containing the restricted discovery filters that replace the existing ones, if the ProSe Function decides to remove only certain filter(s) and not others. + +NOTE: The ProSe Function can include one or multiple transactions in one DISCOVERY\_UPDATE\_REQUEST message for different Restricted Discovery Filters, and receive corresponding element or element in a DISCOVERY\_UPDATE\_RESPONSE message for each respective transaction. In the following description of the network initiated direct discovery update request procedure, only one transaction is included. + +Figure 6.2.6.2.1.1 illustrates the interaction of the UE and the ProSe Function in the restricted discovery filters revocation procedure. + +![Sequence diagram illustrating the restricted discovery filters revocation procedure. The diagram shows two participants: UE (left) and ProSe Function (right). The ProSe Function sends a DISCOVERY_UPDATE_REQUEST message to the UE, and the UE responds with a DISCOVERY_UPDATE_RESPONSE message.](1dd28a53f60be2a30f094e8f112e85d7_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ProSe Function + ProSe Function->>UE: DISCOVERY_UPDATE_REQUEST + UE-->>ProSe Function: DISCOVERY_UPDATE_RESPONSE + +``` + +Sequence diagram illustrating the restricted discovery filters revocation procedure. The diagram shows two participants: UE (left) and ProSe Function (right). The ProSe Function sends a DISCOVERY\_UPDATE\_REQUEST message to the UE, and the UE responds with a DISCOVERY\_UPDATE\_RESPONSE message. + +Figure 6.2.6.2.1.1: Restricted Discovery filters revocation procedure + +#### 6.2.6.2.2 Restricted Discovery filters revocation procedure accepted by the UE + +Upon receiving a DISCOVERY\_UPDATE\_REQUEST message, the UE shall check if the UE identity contained in the DISCOVERY\_UPDATE\_REQUEST message is the IMSI of the UE. If the UE identity is the IMSI of the UE, the UE shall check if the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message is valid. If the Discovery Entry ID is valid, the UE shall proceed with the following direct discovery update procedure. + +The UE shall remove all the Restricted Discovery Filters corresponding to the Discovery Entry ID if the Update Info is not included in the DISCOVERY\_UPDATE\_REQUEST message or shall remove the old Restricted Discovery Filters and store the Restricted Discovery Filter included in the Update Info in the DISCOVERY\_UPDATE\_REQUEST message. Then the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message to the ProSe Function with: + +- the ProSe Function transaction ID set to the value of the ProSe Function transaction ID received in the DISCOVERY\_UPDATE\_REQUEST message; and +- Discovery Entry ID set to the value of the Discovery Entry ID received in the DISCOVERY\_UPDATE\_REQUEST message. + +#### 6.2.6.2.3 Restricted Discovery filters revocation procedure completion by the ProSe Function + +Upon receipt of the DISCOVERY\_UPDATE\_RESPONSE message by the ProSe Function, if the ProSe Function transaction ID contained in the element does not match the value sent by the ProSe Function in a DISCOVERY\_UPDATE\_REQUEST message, the ProSe Function shall discard the DISCOVERY\_UPDATE\_RESPONSE message. Upon receipt of the DISCOVERY\_UPDATE\_RESPONSE message by the ProSe Function, if the ProSe Function transaction ID contained in the element matches the value sent by the ProSe Function in a DISCOVERY\_UPDATE\_REQUEST message, the restricted discovery filters revocation procedure is complete. + +#### 6.2.6.2.4 Restricted Discovery filters revocation procedure not accepted by the UE + +If the DISCOVERY\_UPDATE\_REQUEST message cannot be accepted by the UE, the UE sends a DISCOVERY\_UPDATE\_RESPONSE message containing a element to the ProSe Function including an appropriate PC3 Control Protocol cause value. + +If the UE identity contained in the DISCOVERY\_UPDATE\_REQUEST message is not the IMSI of the UE, the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message containing a element with PC3 Control Protocol cause value #18 "Invalid UE Identity". + +If the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message is not found in the UE context, the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +#### 6.2.6.2.5 Abnormal cases + +##### 6.2.6.2.5.1 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_UPDATE\_REQUEST message (e.g. after TCP retransmission timeout) + +The ProSe Function shall close the existing secure connection to the UE. + +- b) No response from the UE after the DISCOVERY\_UPDATE\_REQUEST message has been successfully delivered (e.g., TCP ACK has been received for the DISCOVERY\_UPDATE\_REQUEST message) + +The ProSe Function shall retransmit the DISCOVERY\_UPDATE\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are ProSe Function implementation specific. + +##### 6.2.6.2.5.2 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_UPDATE\_RESPONSE message. + +After receiving an indication from lower layer that the DISCOVERY\_UPDATE\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the UE shall abort the procedure. + +### 6.2.6.3 Allocation of new ProSe Restricted Code + +#### 6.2.6.3.1 New ProSe Restricted Code allocation procedure initiation + +The ProSe Function in the HPLMN initiates the ProSe restricted code allocation procedure by sending the DISCOVERY\_UPDATE\_REQUEST to the UE with: + +- a new ProSe Function transaction ID not used in any other direct discovery procedures in PC3 interface; +- the UE identity set to the UE's IMSI; +- the Discovery Entry ID set to the Discovery Entry ID of the corresponding Discovery Entry that contains the ProSe Restricted Code to be replaced; +- Update Info containing the ProSe Restricted Code set to the ProSe Restricted Code to be replaced and a Validity Timer T4007 set to the T4007 timer value assigned by the ProSe Function to the ProSe Restricted Code. + +Figure 6.2.6.3.1.1 illustrates the interaction of the UE and the ProSe Function in the ProSe restricted code allocation procedure. + +NOTE: The ProSe function can include one or multiple transactions in one DISCOVERY\_UPDATE\_REQUEST message for different ProSe Restricted Codes, and receive corresponding element or element in a DISCOVERY\_UPDATE\_RESPONSE message for each respective transaction. In the following description of the network initiated direct discovery update request procedure, only one transaction is included. + +![Sequence diagram illustrating the New ProSe Restricted Code allocation procedure. The diagram shows two lifelines: UE (left) and ProSe Function (right). The ProSe Function sends a DISCOVERY_UPDATE_REQUEST message to the UE, and the UE responds with a DISCOVERY_UPDATE_RESPONSE message.](5492fadb32a8df1ee9f2528a053c9862_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ProSe Function + ProSe Function->>UE: DISCOVERY_UPDATE_REQUEST + UE-->>ProSe Function: DISCOVERY_UPDATE_RESPONSE + +``` + +Sequence diagram illustrating the New ProSe Restricted Code allocation procedure. The diagram shows two lifelines: UE (left) and ProSe Function (right). The ProSe Function sends a DISCOVERY\_UPDATE\_REQUEST message to the UE, and the UE responds with a DISCOVERY\_UPDATE\_RESPONSE message. + +**Figure 6.2.6.3.1.1: New ProSe Restricted Code allocation procedure** + +#### 6.2.6.3.2 ProSe Restricted Code allocation procedure accepted by the UE + +Upon receiving a DISCOVERY\_UPDATE\_REQUEST message, the UE shall check if the UE identity contained in the DISCOVERY\_UPDATE\_REQUEST message is the IMSI of the UE. If the UE identity is the IMSI of the UE, the UE shall check if the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message is valid. If the Discovery Entry ID is valid, the UE shall proceed with the following direct discovery update procedure. + +The UE shall replace the ProSe Restricted Code corresponding to the Discovery Entry ID included in the DISCOVERY\_UPDATE\_REQUEST message. The UE shall stop the validity timer T4007 if running and start the validity timer T4007 with the received value. Then the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message to the ProSe Function with: + +- the ProSe Function transaction ID set to the value of the ProSe Function transaction ID received in the DISCOVERY\_UPDATE\_REQUEST message; and +- Discovery Entry ID set to the value of the Discovery Entry ID received in the DISCOVERY\_UPDATE\_REQUEST message. + +### 6.2.6.3.3 ProSe Restricted Code allocation procedure completion by the ProSe Function + +Upon receipt of the DISCOVERY\_UPDATE\_RESPONSE message by the ProSe Function, if the ProSe Function transaction ID contained in the element does not match the value sent by the ProSe Function in a DISCOVERY\_UPDATE\_REQUEST message, the ProSe function shall discard the DISCOVERY\_UPDATE\_RESPONSE message. Upon receipt of the DISCOVERY\_UPDATE\_RESPONSE message by the ProSe Function, if the Prose Function transaction ID contained in the element matches the value sent by the ProSe Function in a DISCOVERY\_UPDATE\_REQUEST message, the ProSe Restricted Code allocation procedure is complete. + +### 6.2.6.3.4 ProSe Restricted Code allocation procedure not accepted by the UE + +If the DISCOVERY\_UPDATE\_REQUEST message cannot be accepted by the UE, the UE sends a DISCOVERY\_UPDATE\_RESPONSE message containing a element to the ProSe Function including an appropriate PC3 Control Protocol cause value. + +If the UE identity contained in the DISCOVERY\_UPDATE\_REQUEST message is not the IMSI of the UE, the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message containing a element with PC3 Control Protocol cause value #18 "Invalid UE identity". + +If the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message is not found in the UE context, the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +### 6.2.6.3.5 Abnormal cases + +#### 6.2.6.3.5.1 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_UPDATE\_REQUEST message (e.g. after TCP retransmission timeout) + +The ProSe Function shall close the existing secure connection to the UE. + +- b) No response from the UE after the DISCOVERY\_UPDATE\_REQUEST message has been successfully delivered (e.g., TCP ACK has been received for the DISCOVERY\_UPDATE\_REQUEST message) + +The ProSe Function shall retransmit the DISCOVERY\_UPDATE\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are ProSe Function implementation specific. + +#### 6.2.6.3.5.2 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_UPDATE\_RESPONSE message. + +After receiving an indication from lower layer that the DISCOVERY\_UPDATE\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the UE shall abort the procedure. + +## 6.2.7 Direct discovery update procedure for open discovery + +### 6.2.7.1 General + +The direct discovery update procedure is used to update or revoke a previously allocated ProSe Application Code, or Discovery Filter(s) as specified in 3GPP TS 23.303 [2]. + +### 6.2.7.2 Direct discovery update procedure initiation + +When triggered to revoke a previously allocated ProSe Application Code for an announcing UE or revoke Discovery Filter(s) for a monitoring UE, the ProSe Function in the HPLMN sends a DISCOVERY\_UPDATE\_REQUEST message to the UE with: + +- a new ProSe Function transaction ID not used in any other direct discovery procedures in PC3 interface; +- the UE identity set to the UE's IMSI; and +- the Discovery Entry ID set to the Discovery Entry ID of the corresponding Discovery Entry that contains the ProSe Application Code or the Discovery Filter(s) to be revoked. + +When triggered to update a previously allocated ProSe Application Code for an announcing UE, the ProSe function in the HPLMN shall allocate a new ProSe Application Code for the ProSe Application ID with a new validity timer T4000, associate the discovery entry with the new ProSe Application Code and restart timer T4001. Then the ProSe Function sends a DISCOVERY\_UPDATE\_REQUEST message to the UE with: + +- a new ProSe Function transaction ID not used in any other direct discovery procedures in PC3 interface; +- the UE identity set to the UE's IMSI; +- the Discovery Entry ID set to the Discovery Entry ID of the corresponding Discovery Entry that contains the ProSe Application Code to be updated; and +- the Update Info containing the ProSe Application Code set to the new ProSe Application Code allocated by the ProSe Function and a Validity Timer T4000 set to the T4000 timer value assigned by the ProSe Function to the new ProSe Application Code. + +When triggered to update Discovery Filter(s) for a monitoring UE, the ProSe Function in the HPLMN updates the content of Discovery Filter(s), associate the discovery entry with the updated Discovery Filter(s) and restart timer T4003 for each filter. The update of Discovery Filter content includes setting new TTL timer(s) and if necessary, assigning new ProSe Application Code and ProSe Application Mask(s). Then the ProSe Function sends a DISCOVERY\_UPDATE\_REQUEST message to the UE with: + +- a new ProSe Function transaction ID not used in any other direct discovery procedures in PC3 interface; +- the UE identity set to the UE's IMSI; +- the Discovery Entry ID set to the Discovery Entry ID of the corresponding Discovery Entry that contains the Discovery Filter(s) to be updated; and +- the Update Info containing the Discovery Filter(s) set to the new Discovery Filter(s) allocated by the ProSe Function. + +NOTE 1: The ProSe Function can include one or multiple transactions in one DISCOVERY\_UPDATE\_REQUEST message for ProSe App Codes or Discovery Filter(s) contained in different discovery entries, and receive corresponding element or element in a DISCOVERY\_UPDATE\_RESPONSE message for each respective transaction. In the following description of direct discovery update request procedure, only one transaction is included. + +Figure 6.2.7.2.1 illustrates the interaction of the UE and the ProSe Function in the direct discovery update procedure. + +![Sequence diagram illustrating the Direct discovery update procedure for open discovery. The diagram shows interactions between a ProSe Function and a UE, with a dashed line representing the R interface. The sequence starts with the ProSe Function sending a DISCOVERY_UPDATE_REQUEST to the UE. The UE responds with a DISCOVERY_UPDATE_RESPONSE containing a element. The ProSe Function then sends another DISCOVERY_UPDATE_REQUEST to the UE, which responds with a DISCOVERY_UPDATE_RESPONSE containing a element.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` + +sequenceDiagram + participant PF as ProSe Function + participant UE as UE + Note left of PF: Start 4001 or 4003 + PF->>UE: DISCOVERY_UPDATE_REQUEST + Note right of UE: Start 4000 or 4002 + UE-->>PF: DISCOVERY_UPDATE_RESPONSE (response-update) + Note right of PF: ----- R ----- + PF->>UE: DISCOVERY_UPDATE_REQUEST + UE-->>PF: DISCOVERY_UPDATE_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the Direct discovery update procedure for open discovery. The diagram shows interactions between a ProSe Function and a UE, with a dashed line representing the R interface. The sequence starts with the ProSe Function sending a DISCOVERY\_UPDATE\_REQUEST to the UE. The UE responds with a DISCOVERY\_UPDATE\_RESPONSE containing a element. The ProSe Function then sends another DISCOVERY\_UPDATE\_REQUEST to the UE, which responds with a DISCOVERY\_UPDATE\_RESPONSE containing a element. + +**Figure 6.2.7.2.1: Direct discovery update procedure for open discovery** + +NOTE 2: In the figure 6.2.7.2.1, the timers are started only when the procedure is triggered to update a previously allocated ProSe Application Code for an announcing UE or update Discovery Filter(s) for a monitoring UE. + +### 6.2.7.3 Direct discovery update procedure accepted by the UE + +Upon receiving a DISCOVERY\_UPDATE\_REQUEST message, the UE shall check if the UE identity contained in the DISCOVERY\_UPDATE\_REQUEST message is the IMSI of the UE. If the UE identity is the IMSI of the UE, the UE shall check if the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message is known. If the Discovery Entry ID is known, the UE shall proceed with the following direct discovery update procedure. + +If the Update Info is not included in the DISCOVERY\_UPDATE\_REQUEST message, the UE shall stop running timers corresponding to the discovery entry and delete the discovery entry corresponding to the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message. The UE informs the lower layers to stop announcing or monitoring corresponding to the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message. + +If the Update Info is included in the DISCOVERY\_UPDATE\_REQUEST message, the UE shall replace the existing ProSe Application Code or the Discovery Filter(s) with new ProSe Application Code or the Discovery Filter(s) contained in the Update Info correspondingly. The announcing UE shall stop the timer T4000, start the validity timer T4000 with the received value for the new ProSe Application Code and perform open ProSe direct discovery announcing with the new ProSe Application Code as described in subclause 6.2.2.4. The monitoring UE shall stop TTL timer T4002, start TTL timer T4002 with the received value for each new Discovery Filter(s) and perform open ProSe direct discovery monitoring with each new Discovery Filter(s) as described in subclause 6.2.3.4. + +Then the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message containing a element with: + +- the ProSe Function transaction ID set to the value of the ProSe Function transaction ID received in the DISCOVERY\_UPDATE\_REQUEST message; and +- the Discovery Entry ID set to the value of the Discovery Entry ID received in the DISCOVERY\_UPDATE\_REQUEST message. + +## 6.2.7.4 Direct discovery update procedure completed by the ProSe Function + +Upon receiving a DISCOVERY\_UPDATE\_RESPONSE message, if the ProSe Function transaction ID contained in the element does not match the value sent by the ProSe Function in a DISCOVERY\_UPDATE\_REQUEST message, the ProSe Function shall discard the DISCOVERY\_UPDATE\_RESPONSE message. Otherwise, the ProSe Function shall perform the following procedure. + +When the UE is an announcing UE and the radio resources that the UE intends to use are operated by a PLMN other than the HPLMN, the ProSe Function shall execute the procedures defined in 3GPP TS 29.345 [5] to inform the ProSe Function in VPLMN or local PLMN. + +When the UE is a monitoring UE and the ProSe Application ID monitored by the UE is PLMN-specific and that PLMN ID indicated by the ProSe Application ID is not the same as that of the PLMN to which the ProSe Function belongs, the ProSe Function executes the procedures defined in 3GPP TS 29.345 [5] to inform the ProSe Function in the PLMN indicated by the ProSe Application ID. + +For each Discovery Entry ID received in the DISCOVERY\_UPDATE\_RESPONSE message, if the procedure is to revoke a previously allocated ProSe Application Code or Discovery Filter(s), the ProSe Function shall delete the discovery entry indicated by the Discovery Entry ID from the UE's context and release the associated resources. + +## 6.2.7.5 Direct discovery update procedure not accepted by the UE + +If the DISCOVERY\_UPDATE\_REQUEST message cannot be accepted by the UE, the UE sends a DISCOVERY\_UPDATE\_RESPONSE message containing a element to the ProSe Function including an appropriate PC3 Control Protocol cause value. + +If the UE identity contained in the DISCOVERY\_UPDATE\_REQUEST message is not the IMSI of the UE, the UE shall send a DISCOVERY\_UPDATE\_RESPONSE message containing a element with PC3 Control Protocol cause value #18 "Invalid UE Identity". + +If the Discovery Entry ID contained in the DISCOVERY\_UPDATE\_REQUEST message is unknown, the UE shall send the DISCOVERY\_UPDATE\_RESPONSE message containing a element with PC3 Control Protocol cause value # 10 "Unknown or Invalid Discovery Entry ID". + +## 6.2.7.6 Abnormal cases + +### 6.2.7.6.1 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of DISCOVERY\_UPDATE\_REQUEST message (e.g. after TCP retransmission timeout) + +The ProSe Function shall close the existing secure connection to the UE. + +- b) No response from the UE after the DISCOVERY\_UPDATE\_REQUEST message has been successfully delivered (e.g., TCP ACK has been received for the DISCOVERY\_UPDATE\_REQUEST message) + +The ProSe Function shall retransmit the DISCOVERY\_UPDATE\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are ProSe Function implementation specific. + +### 6.2.7.6.2 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of DISCOVERY\_UPDATE\_RESPONSE message. + +After receiving an indication from lower layer that the DISCOVERY\_UPDATE\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the UE shall abort the procedure. + +## 6.2.8 Announcing Alert procedure + +### 6.2.8.1 General + +The purpose of the Announcing Alert procedure is for the ProSe Function in HPLMN to send to the announcing UE the ProSe Restricted Code generated in the announce request procedure for restricted ProSe direct discovery model A as specified in clause 6.2.2A. + +Before initiating the Announcing Alert procedure, the ProSe Function shall determine whether the announcing UE and the monitoring UE are close enough to trigger the Announcing Alert procedure. + +The announcing UE includes the ProSe Restricted Code in a PC5\_DISCOVERY message and passes the PC5\_DISCOVERY message to the lower layers for transmission over the PC5 interface in the registered PLMN or local PLMN as a result of a successful Announcing Alert procedure. + +### 6.2.8.2 Announcing Alert procedure initiation + +If the UE has initiated an announce request procedure for restricted ProSe direct discovery model A before as specified in clause 6.2.2A and the On Demand Announcing Enabled Indicator associated with the RPAUID in the announcing UE context is set to 1, the ProSe Function shall initiate an Announcing Alert procedure: + +- when the ProSe Function receives a pair of Target PDUID -Target RPAUID from the ProSe Application Server as described in 3GPP TS 29.343[31], the Target RPAUID is the same as the RPAUID stored in the announcing UE context, and ProSe Function determines the monitoring UE is in the vicinity of the announcing UE; or +- when the ProSe Function receives a pair of Target PDUID -Target RPAUID from other ProSe Functions as described in 3GPP TS 29.345[5], the Target RPAUID is the same as the RPAUID stored in the announcing UE context and the ProSe Function determines the monitoring UE is in the vicinity of the announcing UE. + +NOTE: How the ProSe Function in the HPLMN determines whether the announcing UE and the monitoring UE are close enough to trigger the Announcing Alert procedure is left to the implementation of ProSe Function. + +The ProSe Function initiates the Announce Alert procedure by sending an ANNOUNCING\_ALERT\_REQUEST message with: + +- a new ProSe Function transaction ID; +- the UE identity set to the UE's IMSI; +- the RPAUID set to the Target RPAUID received from ProSe Application Server as specified in 3GPP TS 29.343[31] or from other ProSe Functions as specified in 3GPP TS 29.345[5]; +- the ProSe Restricted Code set to the ProSe Restricted Code or the ProSe Restricted Code Prefix, and optionally one or more ProSe Restricted Code Suffix Ranges which contain the suffix(es) for the RPAUID retrieved from the announcing UE context; and +- the Discovery Entry ID set to the identifier associated with the corresponding discovery entry in the UE's context. + +Figure 6.2.8.2.1 illustrates the interaction of the ProSe Function and the UE in the Announce Alert procedure. + +![Sequence diagram illustrating the Announcing Alert procedure. The diagram shows two participants: UE (User Equipment) on the left and ProSe Function on the right. The interaction consists of two messages: 1. ANNOUNCING_ALERT_REQUEST: A message sent from the ProSe Function to the UE. 2. ANNOUNCING_ALERT_RESPONSE: A message sent from the UE to the ProSe Function.](c30bb9931a85960eb2e2008db772955c_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ANNOUNCING_ALERT_REQUEST + ProSe Function->>UE: ANNOUNCING_ALERT_REQUEST + Note left of UE: ANNOUNCING_ALERT_RESPONSE + UE->>ProSe Function: ANNOUNCING_ALERT_RESPONSE + +``` + +Sequence diagram illustrating the Announcing Alert procedure. The diagram shows two participants: UE (User Equipment) on the left and ProSe Function on the right. The interaction consists of two messages: 1. ANNOUNCING\_ALERT\_REQUEST: A message sent from the ProSe Function to the UE. 2. ANNOUNCING\_ALERT\_RESPONSE: A message sent from the UE to the ProSe Function. + +Figure 6.2.8.2.1: Announcing Alert procedure + +### 6.2.8.3 Announcing Alert procedure accepted by the UE + +Upon receipt of the ANNOUNCING\_ALERT\_REQUEST message, the UE shall check if the UE identity contained in the ANNOUNCING\_ALERT\_REQUEST message is the IMSI of the UE. If the UE identity is the IMSI of the UE, the UE shall check whether there is an existing discovery entry identified by the Discovery Entry ID included in the ANNOUNCING\_ALERT\_REQUEST message. If the discovery entry exists in the UE, the UE shall send an ANNOUNCE\_ALERT\_RESPONSE message to the ProSe Function with a ProSe Function transaction ID set to the value of the ProSe Function transaction ID received in the ANNOUNCING\_ALERT\_REQUEST message. + +Then, the UE may perform restricted ProSe direct discovery model A announcing as described below. + +The UE requests the parameters from the lower layers for restricted ProSe direct discovery model A announcing (see 3GPP TS 36.331 [12]). The UE shall perform restricted ProSe direct discovery model A announcing only if the lower layers indicate that ProSe direct discovery is supported by the network. If the UE in EMM-IDLE mode has to request resources for ProSe direct discovery announcing as specified in 3GPP TS 36.331 [12], the UE shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]. The UE shall obtain the UTC time for the next discovery transmission opportunity for ProSe direct discovery from the lower layers. + +If a valid UTC time is obtained, the UE shall generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18. If the resulting UTC-based counter is within Max Offset of the time shown by the clock used for ProSe by the UE, the UE shall use the UTC-based counter to compute the MIC field for the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. + +The UE shall either use the ProSe Restricted Code received in the ANNOUNCING\_ALERT\_REQUEST message, or select one ProSe Restricted Code based on the ProSe Restricted Code Prefix and ProSe Restricted Code Suffix Range(s) received in the ANNOUNCING\_ALERT\_REQUEST message as announced ProSe Restricted Code, along with the MIC and the eight least significant bits of the UTC-based counter, in order to construct a PC5\_DISCOVERY message, according to the format defined in subclause 11.2.5. + +NOTE: The UE can use different codes formed based on different ProSe Restricted Code Suffixes to announce, without having to send a new DISCOVERY\_REQUEST message to the ProSe Function, as long as the validity timer T4007 of the ProSe Restricted Code Prefix has not expired. + +The UE then passes the PC5\_DISCOVERY message to the lower layers for transmission if: + +- the UE is currently authorised to perform restricted ProSe direct discovery model A announcing in the registered PLMN or the local PLMN operating the radio resources that the UE intends to use; +- the validity timer T4007 for the corresponding discovery entry allocated ProSe Restricted Code or ProSe Restricted Code Prefix has not expired; and +- a request from upper layers to announce the RPAUID associated with both the ProSe Restricted Code or ProSe Restricted Code Prefix, and the authorised Application Identity, is still in place. + +The UE shall ensure that it keeps on passing PC5\_DISCOVERY messages to the lower layers for transmission until the validity timer T4007 of the ProSe Restricted Code or ProSe Restricted Code Prefix expires. How this is achieved is left up to UE implementation. + +During the announcing operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop announcing. When the UE stops announcing, if the lower layers indicate that the UE is required to send a discovery indication to the eNodeB and the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +### 6.2.8.4 Announcing Alert procedure completion by the ProSe Function + +Upon receipt of the ANNOUNCE\_ALERT\_RESPONSE message with a ProSe Function transaction ID set to the value of the ProSe Function Transaction ID included in the ANNOUNCING\_ALERT\_REQUEST message, the ProSe Function will set the associated On Demand Announcing Enabled Indicator to 0. Then the Announcing Alert procedure is successfully completed. + +#### 6.2.8.4A Announcing Alert procedure not accepted by the UE + +If the ANNOUNCING\_ALERT\_REQUEST message cannot be accepted by the UE, the UE sends a ANNOUNCING\_ALERT\_RESPONSE message containing a element to the ProSe Function including an appropriate PC3 Control Protocol cause value. + +If the UE identity contained in the ANNOUNCING\_ALERT\_REQUEST message is not the IMSI of the UE, the UE shall send a ANNOUNCING\_ALERT\_RESPONSE message containing a element with PC3 Control Protocol cause value #18 "Invalid UE Identity". + +If the Discovery Entry ID contained in the ANNOUNCING\_ALERT\_REQUEST message is unknown, the UE shall send the ANNOUNCING\_ALERT\_RESPONSE message containing a element with PC3 Control Protocol cause value #10 "Unknown or Invalid Discovery Entry ID". + +#### 6.2.8.5 Abnormal cases + +##### 6.2.8.5.1 Abnormal cases in the ProSe Function + +The following abnormal cases can be identified: + +- a) Indication from the transport layer of transmission failure of ANNOUNCING\_ALERT\_REQUEST message (e.g. after TCP retransmission timeout) + +The ProSe Function shall close the existing secure connection to the UE. + +- b) No response from the UE after the ANNOUNCING\_ALERT\_REQUEST message has been successfully delivered (e.g. TCP ACK has been received for the ANNOUNCING\_ALERT\_REQUEST message) + +The ProSe Function shall retransmit the ANNOUNCING\_ALERT\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are ProSe Function implementation specific. + +##### 6.2.8.5.2 Abnormal cases in the UE + +The following abnormal cases can be identified: + +- a) Indication from the lower layer of transmission failure of ANNOUNCE\_ALERT\_RESPONSE message. + +After receiving an indication from lower layer that the ANNOUNCE\_ALERT\_RESPONSE message has not been successfully acknowledged (e.g. TCP ACK is not received), the UE shall abort the procedure. + +--- + +## 7 EPC-level ProSe discovery + +### 7.1 Overview + +This clause describes the PC3 Control Protocol procedures between the UE and the ProSe Function for EPC-level ProSe discovery. + +#### 7.1.1 Transport protocol for PC3 Control Protocol messages for EPC-level ProSe discovery + +The UE and the ProSe Function shall use HTTP 1.1 as specified in IETF RFC 7230 [18] and IETF RFC 7231 [19] as the transport protocol for EPC-level ProSe discovery messages over the PC3 interface. The ProSe messages described here shall be included in the body of either an HTTP request message or an HTTP response message. + +#### 7.1.2 Handling of UE-initiated procedures + +The following rules apply for UE-initiated procedures: + +- The UE initiates ProSe transactions with an HTTP request message containing the PC3 request(s); and + +- The ProSe Function responds to the requests with an HTTP response message containing the PC3 response(s) for the PC3 request(s). + +Optionally, the operator can configure the UE with configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. If the UE is configured with the configuration parameter for establishment of the PDN connection for reaching the HPLMN ProSe Function (see 3GPP TS 24.333 [9]): + +- if a PDN connection for reaching the HPLMN ProSe Function is not established yet, the UE shall establish the PDN connection for reaching the HPLMN ProSe Function according to the UE configuration and shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; and +- if a PDN connection for reaching the HPLMN ProSe Function is already established (e.g. either due to other ProSe feature or due to other application), the UE shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; + +### 7.1.3 Handling of network-initiated procedures + +The network-initiated messages for EPC-level ProSe discovery over the PC3 interface shall be contained in an HTTP response message. Either HTTP long polling, or OMA Push, can be used to trigger the HTTP request corresponding to this HTTP response message. The UE and the ProSe Function shall support OMA Push for network initiated procedures. Optionally the UE and ProSe Function should support long polling as well for network initiated procedures. + +During the UE registration procedure, the UE and the ProSe Function decide which method to use. If the UE supports long polling method, the UE indicates that to the ProSe Function in the UE-registration request with a "Method for server-initiated transaction" IE. If the ProSe Function supports long polling method as well and if it prefers to use the long polling method for network initiated procedures, then it checks if UE can also support long polling method via the "Method for server-initiated transaction" IE included in the registration request message and indicates the use of long-polling in the registration response message. If the ProSe Function supports OMA Push only or if it chooses to use OMA Push then it ignores the "Method for server-initiated transaction" IE in UE registration request. + +#### 7.1.3.1 HTTP long polling + +The HTTP long polling method involves the following steps: + +- the UE sends an empty HTTP request message as a polling request when it expects network initiated message(s) over the PC3 interface; +- the ProSe Function defers its response to the UE's request until; + - one or more network-initiated PC3 message(s) for the UE are available. The ProSe Function will enclose the message(s) in an HTTP response message and send it to the UE; or + - a particular timeout for HTTP polling has occurred. The ProSe Function then sends an empty HTTP response message as the polling response to the UE. +- After receiving the response from the ProSe Function, the UE may keep polling after some waiting period if: + - the UE receives an empty polling response; or + - the UE receives network-initiated message(s) from the ProSe Function but still expects additional network-initiated message(s). + +NOTE: The implementation of the HTTP polling process can be coordinated with the SUPL (Secure User Plane Location) procedures to synchronize the SUPL location report procedures and the HTTP polling procedure so as to reduce unnecessary wait time of polling. + +If the UE is triggered to send a PC3 message to the ProSe Function while it has a pending HTTP polling request, the UE shall open another HTTP connection to the ProSe Function to send this new request. Alternately the UE may always use a separate dedicated HTTP connection for polling. + +#### 7.1.3.2 OMA Push + +The OMA Push method involves the following steps: + +- a) if one or more network-initiated PC3 message(s) for the UE are available, the ProSe Function sends a push message containing a particular URL to the UE via the OMA-Push Architecture as defined in [OMA-AD-Push-V2\\_2-20110809-A](#) [22]. The URL is linked to the PC3 message(s) to be sent to the UE. The ProSe Function (performing OMA Push Proxy Gateway functionality) generates a Push Message as specified in OMA-WAP-TS-PushOTA-V2\_1-20110405-A [21] with the PDU set according to [WAP-168-ServiceLoad-20010731-a](#) [20]. The URL information shall be included in the PDU payload; +- b) After receiving the push message, the UE retrieves the URL from the payload of the message and sends an HTTP GET request to the ProSe Function with this URL; and +- c) the ProSe Function sends an HTTP response message containing the PC3 message(s) to the UE. + +## 7.2 Procedures + +### 7.2.1 Types of EPC-level ProSe discovery procedures + +The following PC3 Control Protocol procedures are defined: + +- UE registration; +- application registration; +- proximity request; +- proximity request validation; +- proximity alert; +- UE deregistration; and +- proximity request cancellation. + +EPC support for WLAN direct discovery and communication may be requested as part of the EPC-level ProSe discovery procedure. + +### 7.2.2 UE registration procedure + +#### 7.2.2.1 General + +The purpose of the UE registration procedure is for the UE to register with the ProSe Function to obtain EPC-level ProSe discovery services as defined in 3GPP TS 23.303 [2]. The UE registers with the ProSe Function residing in the HPLMN. + +#### 7.2.2.2 UE registration procedure initiation + +Based on pre-configuration, if the UE is authorised to perform EPC-level ProSe discovery in the registered PLMN, it shall initiate the UE registration procedure when the UE is triggered by upper layers to obtain EPC-level ProSe discovery services and the UE has no corresponding EPC ProSe User ID. + +The UE initiates the UE registration procedure by sending a UE\_REGISTRATION\_REQUEST message with the UE identity set to the UE's IMSI. If the UE intends to use EPC support for WLAN direct discovery and communication and if the UE uses a permanent WLAN link layer identifier, then the UE also includes the WLAN link layer identifier in the UE\_REGISTRATION\_REQUEST message. If the UE supports long polling method for network initiated procedures then the UE also includes a "Method for server-initiated transaction" parameter indicating to the ProSe Function that it support long polling method. + +Figure 7.2.2.2.1 illustrates the interaction of the UE and the ProSe Function in the UE registration procedure. + +![Sequence diagram of UE registration procedure. The diagram shows two possible outcomes for the UE registration request. In the first case, the UE sends a UE_REGISTRATION_REQUEST to the ProSe Function, which responds with a UE_REGISTRATION_RESPONSE (response_register). In the second case, the UE sends a UE_REGISTRATION_REQUEST to the ProSe Function, which responds with a UE_REGISTRATION_RESPONSE (response_reject).](750b1652a4f4791b84c02aa755a1dedd_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ProSe Function + UE->>ProSe Function: UE_REGISTRATION_REQUEST + ProSe Function-->>UE: UE_REGISTRATION_RESPONSE (response_register) + Note right of ProSe Function: OR + UE->>ProSe Function: UE_REGISTRATION_REQUEST + ProSe Function-->>UE: UE_REGISTRATION_RESPONSE (response_reject) + +``` + +Sequence diagram of UE registration procedure. The diagram shows two possible outcomes for the UE registration request. In the first case, the UE sends a UE\_REGISTRATION\_REQUEST to the ProSe Function, which responds with a UE\_REGISTRATION\_RESPONSE (response\_register). In the second case, the UE sends a UE\_REGISTRATION\_REQUEST to the ProSe Function, which responds with a UE\_REGISTRATION\_RESPONSE (response\_reject). + +**Figure 7.2.2.2.1: UE registration procedure** + +### 7.2.2.3 UE registration procedure accepted by the ProSe Function + +Upon receiving a UE\_REGISTRATION\_REQUEST message, the ProSe Function interacts with the HSS as described in 3GPP TS 29.344 [3] in order to authenticate the user and check whether the user is authorised to use EPC-level ProSe discovery services corresponding to the IMSI contained in the UE\_REGISTRATION\_REQUEST message in the registered PLMN. + +If the ProSe Function contains all the settings related to authentication and authorisation for the user corresponding to the IMSI contained in the UE\_REGISTRATION\_REQUEST message then the ProSe function need not interact with the HSS and the ProSe Function checks locally if the user is authorised to use EPC-level ProSe discovery services. + +If the UE is authorised to use EPC-level ProSe discovery services, the ProSe Function generates an EPC ProSe User ID corresponding to the IMSI contained in the UE\_REGISTRATION\_REQUEST message and shall send a UE\_REGISTRATION\_RESPONSE message containing a element to the UE with the EPC ProSe User ID. The EPC ProSe User ID is a number generated by the ProSe Function that is unique within the ProSe Function on a per UE basis. The element shall also contain a server-initiated method configuration parameter indicating to the UE which method to use to handle server-initiated procedures. + +### 7.2.2.4 UE registration procedure completion by the UE + +Upon receipt of the UE\_REGISTRATION\_RESPONSE message containing a element the UE stores the EPC ProSe User ID and may start the application registration procedure. The UE shall use the method configured in UE\_REGISTRATION\_RESPONSE message to handle server-initiated procedures. + +### 7.2.2.5 UE registration procedure not accepted by the ProSe Function + +If the UE\_REGISTRATION\_REQUEST message is not accepted by the ProSe Function, the ProSe Function shall send a UE\_REGISTRATION\_RESPONSE message containing a element to the UE including an appropriate PC3 EPC Control Protocol cause value. + +If the UE is not authorised for EPC-level ProSe discovery, the ProSe Function shall send the UE\_REGISTRATION\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #2 "UE authorisation failure". + +## 7.2.3 Application registration procedure + +### 7.2.3.1 General + +The purpose of the application registration procedure is for the UE to activate EPC-level ProSe discovery for a specific application as defined in 3GPP TS 23.303 [2]. The UE registers the specific application with the ProSe Function residing in the HPLMN. + +### 7.2.3.2 Application registration procedure initiation + +When the user uses applications on the UE, an Application ID is used to identify the corresponding application server platform. When the user registers an application with the application server, the user is designated an Application Layer User ID. If the application requires EPC-level ProSe discovery, the UE is configured with the data structure of the Application IDs and the Application Layer User ID. This step is performed using mechanisms outside of the scope of 3GPP. The user may have multiple Application Layer User IDs for an application, but may choose to register only one of these to activate EPC-level ProSe discovery. The UE shall initiate the application registration procedure after successfully completing the UE registration procedure. + +If the UE is authorised to perform EPC-level ProSe discovery in the registered PLMN, it shall initiate the application registration procedure when the UE is triggered by upper layers to activate EPC-level Prose discovery for a specific application and the application is not registered. + +The UE initiates the application registration procedure by sending an APPLICATION\_REGISTRATION\_REQUEST message by including a new transaction ID, the UE's EPC ProSe User ID, the Application ID for the application that is to be registered and the user's Application Layer User ID for the application that is to be registered. + +**NOTE:** A UE can include one or multiple transactions in one APPLICATION\_REGISTRATION\_REQUEST message for different Application IDs, and receive corresponding element or element in the APPLICATION\_REGISTRATION\_RESPONSE message for each respective transaction. In the following description of the application registration procedure, only one transaction is included. + +Figure 7.2.3.2.1 illustrates the interaction of the UE and the ProSe Function in the application registration procedure. + +![Sequence diagram of the application registration procedure between a UE and a ProSe Function.](4aeaa51a3999fab21171224e238cb571_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: P r o S e F u n c t i o n + UE->>ProSe Function: A P P L I C A T I O N _ R E G I S T R A T I O N _ R E Q U E S T + ProSe Function-->>UE: A P P L I C A T I O N _ R E G I S T R A T I O N _ R E S P O N S E ( r e s p o n s e _ r e g i s t e r ) + Note right of ProSe Function: O R + UE->>ProSe Function: A P P L I C A T I O N _ R E G I S T R A T I O N _ R E Q U E S T + ProSe Function-->>UE: A P P L I C A T I O N _ R E G I S T R A T I O N _ R E S P O N S E ( r e s p o n s e _ r e j e c t ) + +``` + +The diagram illustrates the interaction between a User Equipment (UE) and a ProSe Function. The sequence of messages is as follows: + + +- The UE sends an **A P P L I C A T I O N \_ R E G I S T R A T I O N \_ R E Q U E S T** message to the ProSe Function. +- The ProSe Function responds with an **A P P L I C A T I O N \_ R E G I S T R A T I O N \_ R E S P O N S E ( r e s p o n s e \_ r e g i s t e r )** message. +- Alternatively (indicated by a dashed line and the word **O R**), the UE sends another **A P P L I C A T I O N \_ R E G I S T R A T I O N \_ R E Q U E S T** message. +- The ProSe Function responds with an **A P P L I C A T I O N \_ R E G I S T R A T I O N \_ R E S P O N S E ( r e s p o n s e \_ r e j e c t )** message. + +Sequence diagram of the application registration procedure between a UE and a ProSe Function. + +**Figure 7.2.3.2.1: Application registration procedure** + +### 7.2.3.3 Application registration procedure accepted by the ProSe Function + +Upon receiving an APPLICATION\_REGISTRATION\_REQUEST message, the ProSe Function retrieves the user profile based on the UE's EPC ProSe User ID included in the APPLICATION\_REGISTRATION\_REQUEST message. The ProSe Function then checks if the list of authorised applications in the user's profile includes the requested application based on the Application ID in the APPLICATION\_REGISTRATION\_REQUEST message. + +If the check is successful then the ProSe Function sends a request to the application server so that the user of this application identified by Application Layer User ID in the APPLICATION\_REGISTRATION\_REQUEST message can use EPC-level ProSe discovery for that application. + +If the user is authorised to use EPC-level ProSe discovery for the specified application, the ProSe Function generates one or more allowed range classes corresponding to the Application ID contained in the APPLICATION\_REGISTRATION\_REQUEST message. The ProSe Function shall send an APPLICATION\_REGISTRATION\_RESPONSE message containing a element to the UE with transaction ID set to the value of the transaction ID received in the APPLICATION\_REGISTRATION\_REQUEST message from the UE and the set of allowed range classes. The set of allowed range classes for each Application ID is stored in the ProSe Function. + +### 7.2.3.4 Application registration procedure completion by the UE + +Upon receipt of the UE\_REGISTRATION\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in an APPLICATION\_REGISTRATION\_REQUEST message the UE stores the set of allowed range classes for this Application ID and may start the proximity request procedure. + +### 7.2.3.5 Application registration procedure not accepted by the ProSe Function + +If the APPLICATION\_REGISTRATION\_REQUEST message is not accepted by the ProSe Function, the ProSe Function shall send an APPLICATION\_REGISTRATION\_RESPONSE message containing a element to the UE including an appropriate PC3 EPC Control Protocol cause value. + +If the application corresponding to the Application ID contained in the APPLICATION\_REGISTRATION\_REQUEST message is not authorised for EPC-level ProSe Discovery in the registered PLMN, the ProSe Function shall send the APPLICATION\_REGISTRATION\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #1 "Invalid Application". + +If the UE is not authorised for EPC-level ProSe Discovery, the ProSe Function shall send the APPLICATION\_REGISTRATION\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #2 "UE authorisation failure". + +If the Application Layer User ID contained in the APPLICATION\_REGISTRATION\_REQUEST message is unknown to the Application Server, the ProSe Function shall send the APPLICATION\_REGISTRATION\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #10 "Invalid Application Layer User ID". + +## 7.2.4 Proximity request procedure + +### 7.2.4.1 General + +The purpose of the proximity request procedure is to allow a UE (UE A) to request to be alerted when it enters in proximity with a targeted UE (UE B) as defined in 3GPP TS 23.303 [2]. UE A performs the proximity request procedure with the ProSe Function residing in the HPLMN. + +### 7.2.4.2 Proximity request procedure initiation + +Before initiating the proximity request procedure, UE A needs to register the user's Application Layer User ID A with ProSe Function A as described in subclause 7.2.3. UE A shall initiate the proximity request procedure when triggered by upper layers to activate EPC-level Prose discovery for a specific application and for a specific targeted user identified via its Application Layer User ID B. + +UE A initiates the proximity request procedure by sending a PROXIMITY\_REQUEST message to ProSe Function A by including a new transaction ID, UE A's EPC ProSe User ID, the Application ID for the application for which the request is made, UE A's Application Layer User ID (Application Layer User ID A), the Application Layer User ID of UE B (Application Layer User ID B), a requested range class value selected from the set of allowed range classes for this application, UE A's Current Location with the best known accuracy and a Time Window indicating the time interval during which the request is valid. + +NOTE: A UE can include one or multiple transactions in one PROXIMITY\_REQUEST message for different Application IDs, and receives corresponding element or element in the PROXIMITY\_REQUEST\_RESPONSE message for each respective transaction. In the following description of the Proximity Request procedure, only one transaction is included. + +If UE A, subsequent to successful proximity detection with UE B, wishes to engage in WLAN direct discovery and communication, UE A also includes a WLAN Indication in the PROXIMITY\_REQUEST message. + +Figure 7.2.4.2.1 illustrates the interaction of the UE and the ProSe Function in the proximity request procedure. + +![Sequence diagram of the proximity request procedure. The diagram shows two main interaction paths between a UE and a ProSe Function. The first path shows a successful acceptance: the UE sends a PROXIMITY_REQUEST to the ProSe Function, which responds with a PROXIMITY_REQUEST_RESPONSE (response-accept). The second path, separated by a dashed line labeled 'OR', shows a rejection: the UE sends a PROXIMITY_REQUEST to the ProSe Function, which responds with a PROXIMITY_REQUEST_RESPONSE (response-reject).](f1de68a4cbb9b92a1c0ffd919bbd199c_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSeFunction as ProSe Function + Note right of ProSeFunction: Path 1: Acceptance + UE->>ProSeFunction: PROXIMITY_REQUEST + ProSeFunction-->>UE: PROXIMITY_REQUEST_RESPONSE (response-accept) + Note right of ProSeFunction: Path 2: Rejection + Note left of UE: OR + UE->>ProSeFunction: PROXIMITY_REQUEST + ProSeFunction-->>UE: PROXIMITY_REQUEST_RESPONSE (response-reject) + +``` + +Sequence diagram of the proximity request procedure. The diagram shows two main interaction paths between a UE and a ProSe Function. The first path shows a successful acceptance: the UE sends a PROXIMITY\_REQUEST to the ProSe Function, which responds with a PROXIMITY\_REQUEST\_RESPONSE (response-accept). The second path, separated by a dashed line labeled 'OR', shows a rejection: the UE sends a PROXIMITY\_REQUEST to the ProSe Function, which responds with a PROXIMITY\_REQUEST\_RESPONSE (response-reject). + +**Figure 7.2.4.2.1: Proximity request procedure** + +### 7.2.4.3 Proximity request procedure accepted by the ProSe Function + +Upon receiving a PROXIMITY\_REQUEST message from UE A, ProSe Function A retrieves the user profile based on the UE's EPC ProSe User ID included in the PROXIMITY\_REQUEST message. ProSe Function A then checks that UE A has previously registered the application identified with the Application ID in the PROXIMITY\_REQUEST message and that the requested range class value belongs to the set of allowed range classes for this application. + +If the check is successful then ProSe Function A interacts with the Application Server to obtain the identifier of ProSe Function B that owns the user profile of the targeted user, as well as its EPC ProSe User ID (EPC ProSe User ID B). ProSe Function A then propagates the proximity request to ProSe Function B on the targeted UE side (the B-side). The Current Location of UE A included in the PROXIMITY\_REQUEST message may be used by ProSe Function B to determine whether the proximity request is accepted or not. + +NOTE: The mechanism used by ProSe Function B to determine acceptance or non-acceptance of PROXIMITY\_REQUEST messages is outside the scope of this specification. + +If the proximity request is accepted by the B-side, ProSe Function A stores Application Layer User ID A, Application Layer User ID B, EPC ProSe User ID B, requested range class and Time Window in the UE A's context identified with EPC ProSe User ID A. The WLAN Indication is also stored, if it was included in the PROXIMITY\_REQUEST message. Then ProSe Function A shall initiate location reporting for UE A and send a PROXIMITY\_REQUEST\_RESPONSE message containing a element to UE A with transaction ID set to the value of the transaction ID received in the PROXIMITY\_REQUEST message from UE A. + +### 7.2.4.4 Proximity request procedure completion by the UE + +Upon receipt of the PROXIMITY\_REQUEST\_RESPONSE message, if the transaction ID contained in the element matches the value sent by the UE in a PROXIMITY\_REQUEST message, the proximity request procedure is successfully completed. + +### 7.2.4.5 Proximity request procedure not accepted by the ProSe Function + +If the PROXIMITY\_REQUEST message is not accepted by the ProSe Function, the ProSe Function shall send a PROXIMITY\_REQUEST\_RESPONSE message containing a element to the UE including an appropriate PC3 EPC Control Protocol cause value. + +If the application corresponding to the Application ID contained in the PROXIMITY\_REQUEST message is not authorised for EPC-level ProSe discovery, the ProSe Function shall send the PROXIMITY\_REQUEST\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #1 "Invalid Application". + +If the application corresponding to the Application ID contained in the PROXIMITY\_REQUEST message has not been registered for EPC-level ProSe discovery, the ProSe Function shall send the PROXIMITY\_REQUEST\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #4 "Application not registered". + +If the requested Range Class value is not allowed for this application, the ProSe Function shall send the PROXIMITY\_REQUEST\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #5 "Range Class not allowed for this application". + +If based on the Current Location the B-side determines that UE A and targeted UE B are unlikely to enter proximity within the requested Time Window, the ProSe Function shall send the PROXIMITY\_REQUEST\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #6 "Proximity detection unlikely within requested time window". + +If the ProSe Function determines that the targeted UE has not registered the application identified with Application ID, the ProSe Function shall send the PROXIMITY\_REQUEST\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #7 "Targeted user not registered for this application". + +If the B-side rejects to validate the proximity request, the ProSe Function shall send the PROXIMITY\_REQUEST\_RESPONSE message containing a element with PC3 EPC Control Protocol cause value #8 "Proximity validation rejected by B side". + +## 7.2.5 Proximity alert procedure + +### 7.2.5.1 General + +The purpose of the proximity alert procedure is to inform the UE (UE A) that it has been determined to be in proximity with the targeted UE (UE B) as defined in 3GPP TS 23.303 [2]. If UE A has indicated in the proximity request procedure that it wishes to engage in WLAN direct discovery and communication with UE B, the proximity alert procedure is also used to provide Assistance Information that expedites the WLAN direct discovery and communication to both UE A and UE B. The proximity alert procedure is initiated by the ProSe Function residing in the HPLMN. + +### 7.2.5.2 Proximity alert procedure initiation by the network + +When ProSe Function A on the A-side determines that UE A and UE B are in proximity, it cancels the location reporting for UE A with the SUPL Location Platform and sends a PROXIMITY\_ALERT message to UE A including the Application ID, Application Layer User ID A and Application Layer User ID B. + +UE A may have registered multiple proximity requests for applications with different Application IDs. In this case the ProSe Function may combine the multiple alerts for each of the different Application IDs and send a combined PROXIMITY\_ALERT message to the UE. + +If UE A's context contains a WLAN Indication, the ProSe Function generates Assistance Information for WLAN direct discovery and communication according to the underlying WLAN technology, includes the Assistance Information in the PROXIMITY ALERT message and forwards the alert towards the B-side. + +If the context of UE A does not contain WLAN Indication then ProSe Function A sends a cancellation request towards ProSe Function B. + +After transmitting the PROXIMITY\_ALERT message to UE A and alerting (or sending a cancellation request to) the B-side, the ProSe Function deletes the information related to this specific Proximity Request in UE A's context. + +NOTE: IF UE A has signalled a permanent WLAN Link Layer ID during UE Registration procedure as described in subclause 7.2.2, the WLAN Link Layer ID for UE A is retrieved from UE A's context; otherwise a random WLAN Link Layer ID is generated for UE A by the ProSe Function. Similarly, if during the Proximity Request procedure the ProSe Function has received a permanent WLAN Link Layer ID for UE B, the WLAN Link Layer ID for UE B is retrieved from UE A's context; otherwise a random WLAN Link Layer ID is generated for UE B by the ProSe Function. + +When ProSe Function B is alerted that UE A and UE B are in proximity, it cancels the location reporting for UE B and shall send a PROXIMITY\_ALERT message to UE B including the Application ID, Application Layer User ID A and Application Layer User ID B. + +Figure 7.2.5.2.1 illustrates the interaction of the UE and the ProSe Function in the proximity alert procedure. + +![Sequence diagram for Figure 7.2.5.2.1: Proximity alert procedure. The diagram shows a UE on the left and a ProSe Function on the right. A message labeled 'PROXIMITY_ALERT' is sent from the ProSe Function to the UE, indicated by a long arrow pointing left with a small arrowhead at the UE side.](79aaab5889060cf8264226764a109cdb_img.jpg) + +Sequence diagram for Figure 7.2.5.2.1: Proximity alert procedure. The diagram shows a UE on the left and a ProSe Function on the right. A message labeled 'PROXIMITY\_ALERT' is sent from the ProSe Function to the UE, indicated by a long arrow pointing left with a small arrowhead at the UE side. + +**Figure 7.2.5.2.1: Proximity alert procedure** + +### 7.2.5.3 Proximity alert procedure completion by the UE + +Upon receipt of the PROXIMITY\_ALERT message the UE shall inform the application identified via the Application ID in the PROXIMITY\_ALERT message including Application Layer User ID A and Application Layer User ID B. If the Assistance Information for WLAN direct discovery and communication is included in the PROXIMITY\_ALERT message, the UE uses this information to engage in WLAN direct discovery and communication with the peer UE. + +## 7.2.6 UE deregistration procedure + +### 7.2.6.1 General + +The UE deregistration procedure is used to deregister the UE for EPC-level ProSe discovery services. It can be initiated at any time by the UE or by the ProSe Function residing in the HPLMN. + +### 7.2.6.2 UE-initiated UE deregistration procedure + +#### 7.2.6.2.1 UE-initiated UE deregistration procedure initiation + +When the UE decides to deregister for EPC-level ProSe discovery services, it shall send the UE\_DEREGISTRATION\_REQUEST message to the ProSe Function residing in the HPLMN. The message includes the EPC ProSe User ID. + +Figure 7.2.6.2.1.1 illustrates the interaction of the UE and the ProSe Function in the UE-initiated UE deregistration procedure. + +![Sequence diagram for Figure 7.2.6.2.1.1: UE-initiated UE deregistration procedure. The diagram shows a UE on the left and a ProSe Function on the right. A message labeled 'UE_DEREGISTRATION_REQUEST' is sent from the UE to the ProSe Function, indicated by a long arrow pointing right with an arrowhead at the ProSe Function side. Below this, a message labeled 'UE_DEREGISTRATION_RESPONSE' is sent from the ProSe Function to the UE, indicated by a long arrow pointing left with an arrowhead at the UE side.](688031e51a9a74ed869aa8405aab4e74_img.jpg) + +Sequence diagram for Figure 7.2.6.2.1.1: UE-initiated UE deregistration procedure. The diagram shows a UE on the left and a ProSe Function on the right. A message labeled 'UE\_DEREGISTRATION\_REQUEST' is sent from the UE to the ProSe Function, indicated by a long arrow pointing right with an arrowhead at the ProSe Function side. Below this, a message labeled 'UE\_DEREGISTRATION\_RESPONSE' is sent from the ProSe Function to the UE, indicated by a long arrow pointing left with an arrowhead at the UE side. + +**Figure 7.2.6.2.1.1: UE-initiated UE deregistration procedure** + +#### 7.2.6.2.2 UE-initiated UE deregistration procedure accepted by the ProSe Function + +Upon receiving the UE\_DEREGISTRATION\_REQUEST message, the ProSe Function retrieves the user profile based on the UE's EPC ProSe User ID included in the UE\_DEREGISTRATION\_REQUEST message, cancels any ongoing + +proximity alert procedures for this UE, clears the UE context and shall send a UE\_DEREGISTRATION\_RESPONSE message to the UE. + +### 7.2.6.2.3 UE-initiated UE deregistration procedure completion by the UE + +Upon receipt of the UE\_DEREGISTRATION\_RESPONSE message by the UE, the UE deregistration procedure is complete. + +## 7.2.6.3 Network-initiated UE deregistration procedure + +### 7.2.6.3.1 Network-initiated UE deregistration procedure initiation + +When the ProSe Function residing in the HPLMN decides to deregister the UE for EPC-level ProSe discovery services, it shall send the UE\_DEREGISTRATION\_REQUEST to the UE. + +Figure 7.2.6.3.1.1 illustrates the interaction of the UE and the ProSe Function in the network-initiated UE deregistration procedure. + +![Sequence diagram illustrating the network-initiated UE deregistration procedure. The diagram shows two participants: UE and ProSe Function. The ProSe Function sends a UE_DEREGISTRATION_REQUEST message to the UE. The UE responds with a UE_DEREGISTRATION_RESPONSE message to the ProSe Function.](2e8dcf3d807269a64340a9c292ea7f5d_img.jpg) + +``` +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ProSe Function + ProSe Function->>UE: UE_DEREGISTRATION_REQUEST + Note left of UE: UE + UE-->>ProSe Function: UE_DEREGISTRATION_RESPONSE +``` + +Sequence diagram illustrating the network-initiated UE deregistration procedure. The diagram shows two participants: UE and ProSe Function. The ProSe Function sends a UE\_DEREGISTRATION\_REQUEST message to the UE. The UE responds with a UE\_DEREGISTRATION\_RESPONSE message to the ProSe Function. + +**Figure 7.2.6.3.1.1: Network-initiated UE deregistration procedure** + +### 7.2.6.3.2 Network-initiated UE deregistration procedure in the UE + +Upon receiving a UE\_DEREGISTRATION\_REQUEST message, the UE deletes all context information related to EPC-level ProSe discovery and shall send a UE\_DEREGISTRATION\_RESPONSE message to the network. + +### 7.2.6.3.3 Network-initiated UE deregistration procedure completion by the network + +Upon receipt of the UE\_DEREGISTRATION\_RESPONSE message by the ProSe Function the UE deregistration procedure is complete. + +## 7.2.7 Proximity request cancellation procedure + +### 7.2.7.1 General + +The proximity request cancellation procedure is used by the UE or ProSe Function to cancel an ongoing proximity request that was sent earlier as defined in 3GPP TS 23.303 [2]. The UE initiates the proximity request cancellation procedure due to occurrence of certain event (e.g. termination of the corresponding application). The ProSe Function initiates the proximity request cancellation procedure (e.g. due to excess of time window). + +### 7.2.7.2 UE initiated proximity request cancellation procedure + +#### 7.2.7.2.1 Initiation of UE initiated proximity request cancellation procedure + +The UE initiates the proximity request cancellation procedure by sending a CANCEL\_PROXIMITY\_REQUEST message to the ProSe Function including a new transaction ID, the UE's EPC ProSe User ID, the Application ID for the application for which the cancellation is being made and the targeted user's Application Layer User ID B. + +**NOTE:** A UE can include one or multiple transactions in one CANCEL\_PROXIMITY\_REQUEST message for different Application IDs, and receive corresponding CANCEL\_PROXIMITY\_RESPONSE message for each respective transaction. In the following description of the proximity request cancellation procedure, only one transaction is included. + +Figure 7.2.7.2.1.1 illustrates the interaction of the UE and the ProSe Function in the UE initiated proximity request cancellation procedure. + +![Sequence diagram showing the UE initiated proximity request cancellation procedure. The UE sends a CANCEL_PROXIMITY_REQUEST message to the ProSe Function, and the ProSe Function responds with a CANCEL_PROXIMITY_RESPONSE message.](61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg) + +``` +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: P r o S e F u n c t i o n + UE->>ProSe Function: CANCEL_PROXIMITY_REQUEST + ProSe Function-->>UE: CANCEL_PROXIMITY_RESPONSE +``` + +Sequence diagram showing the UE initiated proximity request cancellation procedure. The UE sends a CANCEL\_PROXIMITY\_REQUEST message to the ProSe Function, and the ProSe Function responds with a CANCEL\_PROXIMITY\_RESPONSE message. + +**Figure 7.2.7.2.1.1: UE initiated proximity request cancellation procedure** + +#### 7.2.7.2.2 UE initiated proximity request cancellation procedure handling by the ProSe Function + +Upon receiving a CANCEL\_PROXIMITY\_REQUEST message from UE A, ProSe Function A retrieves the user profile of UE A based on UE A's EPC ProSe User ID included in the CANCEL\_PROXIMITY\_REQUEST message. ProSe Function A then uses the Application ID and Application Layer User ID B to identify the ProSe Function identifier of ProSe Function B which owns the context of the targeted user and forwards the cancellation request towards ProSe Function B as defined in 3GPP TS 29.345 [5]. + +The ProSe Function A shall send a CANCEL\_PROXIMITY\_RESPONSE message to UE A with transaction ID set to the value of the transaction ID received in the CANCEL\_PROXIMITY\_REQUEST message from UE A. If UE A has no other ongoing proximity requests then ProSe Function A cancels the location reporting for UE A. + +#### 7.2.7.2.3 UE initiated proximity request cancellation procedure completion by the UE + +Upon receipt of the CANCEL\_PROXIMITY\_RESPONSE message with transaction ID set to the value of the transaction ID received in the CANCEL\_PROXIMITY\_REQUEST message, the UE A shall abort the proximity request procedure and the UE initiated proximity request cancellation procedure is complete. + +### 7.2.7.3 ProSe Function initiated proximity request cancellation procedure + +#### 7.2.7.3.1 Initiation of ProSe Function initiated proximity request cancellation procedure + +The ProSe Function initiates the proximity request cancellation procedure by retrieving the user profile of UE A based on UE A's EPC ProSe User ID included in the PROXIMITY\_REQUEST message sent by UE A earlier. + +The ProSe Function A shall send a CANCEL\_PROXIMITY\_REQUEST message to UE A with transaction ID set to the value of the transaction ID received in the PROXIMITY\_REQUEST message from UE A, the UE A's EPC ProSe User ID, the Application ID for the application for which the cancellation is being made and the targeted user's Application Layer User ID B. If UE A has no other ongoing proximity requests then ProSe Function A cancels the location reporting for UE A. + +**NOTE:** A ProSe Function can include one or multiple transactions in one CANCEL\_PROXIMITY\_REQUEST message for each respective transaction. In the following description of the proximity request cancellation procedure, only one transaction is included. + +Figure 7.2.7.3.1.1 illustrates the ProSe Function initiated proximity request cancellation procedure. + +![Sequence diagram showing the ProSe Function initiated proximity request cancellation procedure. The diagram shows two messages between a UE and a ProSe Function. The first message is CANCEL_PROXIMITY_REQUEST from the ProSe Function to the UE. The second message is CANCEL_PROXIMITY_RESPONSE from the UE to the ProSe Function.](0dfdff10c725fe9c332b07ade9d23a5e_img.jpg) + +``` +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ProSe Function + ProSe Function->>UE: CANCEL_PROXIMITY_REQUEST + Note left of UE: UE + UE-->>ProSe Function: CANCEL_PROXIMITY_RESPONSE +``` + +Sequence diagram showing the ProSe Function initiated proximity request cancellation procedure. The diagram shows two messages between a UE and a ProSe Function. The first message is CANCEL\_PROXIMITY\_REQUEST from the ProSe Function to the UE. The second message is CANCEL\_PROXIMITY\_RESPONSE from the UE to the ProSe Function. + +**Figure 7.2.7.3.1.1: ProSe Function initiated proximity request cancellation procedure** + +#### 7.2.7.3.2 ProSe initiated proximity request cancellation procedure handling by the UE + +Upon receiving a CANCEL\_PROXIMITY\_REQUEST message from ProSe Function A, the UE A shall abort the proximity request procedure and send a CANCEL\_PROXIMITY\_RESPONSE message to ProSe Function A with transaction ID set to the value of the transaction ID received in the CANCEL\_PROXIMITY\_REQUEST message from ProSe Function A. + +#### 7.2.7.3.3 ProSe Function initiated proximity request cancellation procedure completion by the ProSe Function + +Upon receipt of the CANCEL\_PROXIMITY\_RESPONSE message by ProSe Function A, the ProSe Function initiated proximity request cancellation procedure is complete. + +### 7.2.8 Proximity request Validation procedure + +#### 7.2.8.1 General + +If the targeted UE's profile indicates that the proximity requests for the UE need to be explicitly validated then the network uses the proximity request validation procedure to request the targeted UE (UE B) to confirm permission for the proximity requests (e.g. user B may have temporarily disabled the ProSe functionality on UE B). It is initiated by the ProSe Function residing in the HPLMN as part of the overall proximity request procedure defined in 3GPP TS 23.303 [2]. + +#### 7.2.8.2 Initiation of the proximity request validation procedure + +Upon reception of a proximity request from UE A, the ProSe Function on the targeted UE side (B-side) retrieves the stored profile of UE B. If UE B's profile indicates that the proximity requests for UE B need to be explicitly validated, ProSe Function B shall send the PROXIMITY\_REQUEST\_VALIDATION message to UE B including the Application ID of the application for which the proximity request is being validated. + +Figure 7.2.8.2.1 illustrates the interaction of the targeted UE and the ProSe Function in the proximity request validation procedure. + +![Sequence diagram illustrating the Proximity request validation procedure. The diagram shows two instances of the procedure. In the first instance, UE B sends a PROXIMITY_REQUEST_VALIDATION message to the ProSe Function, which responds with PROXIMITY_REQUEST_VALIDATION_RESPONSE (response-accept). In the second instance, separated by a dashed line labeled 'OR', UE B sends the same message, but the ProSe Function responds with PROXIMITY_REQUEST_VALIDATION_RESPONSE (response-reject).](ffe0fef452a0ae9a20253c319c54e13c_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ProSe Function + Note right of ProSe Function: ProSe Function + UE->>ProSe Function: PROXIMITY_REQUEST_VALIDATION + ProSe Function-->>UE: PROXIMITY_REQUEST_VALIDATION_RESPONSE (response-accept) + Note right of ProSe Function: OR + UE->>ProSe Function: PROXIMITY_REQUEST_VALIDATION + ProSe Function-->>UE: PROXIMITY_REQUEST_VALIDATION_RESPONSE (response-reject) + +``` + +Sequence diagram illustrating the Proximity request validation procedure. The diagram shows two instances of the procedure. In the first instance, UE B sends a PROXIMITY\_REQUEST\_VALIDATION message to the ProSe Function, which responds with PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE (response-accept). In the second instance, separated by a dashed line labeled 'OR', UE B sends the same message, but the ProSe Function responds with PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE (response-reject). + +**Figure 7.2.8.2.1: Proximity request validation procedure** + +### 7.2.8.3 Proximity request validation procedure in the UE + +Upon receiving a PROXIMITY\_REQUEST\_VALIDATION message, UE B checks whether the application corresponding to the Application ID included in the message is ready for accepting a proximity request from other users. + +If the application corresponding to the Application ID contained in the PROXIMITY\_REQUEST\_VALIDATION message is ready for accepting proximity requests from other users, the targeted UE shall send the PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE message to the ProSe Function. + +If the application corresponding to the Application ID contained in the PROXIMITY\_REQUEST\_VALIDATION message is not ready for accepting proximity requests from other users, the targeted UE shall send the PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE message with PC3 EPC Control Protocol cause value #9 "Application disabled temporarily". + +### 7.2.8.4 Proximity request validation procedure completion by the network + +Upon receipt of the PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE message containing a element, ProSe Function B initiates location reporting for UE B and acknowledges the proximity request towards ProSe Function A. + +Upon receipt of the PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE message containing a element, ProSe Function B forwards an indication towards ProSe Function A that the proximity request is rejected. + +## 7.2.9 Abnormal cases + +### 7.2.9.1 Abnormal cases in the UE + +In case of the messages listed below: + +- UE\_REGISTRATION\_REQUEST; +- APPLICATION\_REGISTRATION\_REQUEST; +- PROXIMITY\_REQUEST; +- UE\_DEREGISTRATION\_REQUEST; + +- CANCEL\_PROXIMITY\_REQUEST; and +- PROXIMITY\_REQUEST\_VALIDATION. + +the following abnormal cases can be identified. + +- a) Indication from transport layer of transmission failure of a message (e.g. after TCP retransmission timeout) + +The UE shall close the existing connection to the ProSe Function, establish a new connection and then restart the appropriate procedure. + +- b) No response from the ProSe Function after a message has been successfully delivered (e.g. TCP ACK has not been received) + +The UE shall retransmit the message. + +### 7.2.9.2 Abnormal cases in the ProSe Function + +In case of the messages listed below: + +- UE\_REGISTRATION\_RESPONSE; +- APPLICATION\_REGISTRATION\_RESPONSE; +- PROXIMITY\_REQUEST\_RESPONSE; +- PROXIMITY\_ALERT; +- UE\_DEREGISTRATION\_RESPONSE; +- CANCEL\_PROXIMITY\_RESPONSE; and +- PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE. + +the following abnormal cases can be identified. + +- a) Indication from the lower layer of transmission failure of a message + +After receiving an indication from lower layer that a message has not been successfully acknowledged (e.g. TCP ACK is not received), the ProSe Function shall abort the procedure. + +--- + +## 8 EPC support for WLAN direct discovery and communication + +In this release of the document, the stand-alone procedure for EPC support for WLAN direct discovery and communication is not supported. + +--- + +## 9 Handling of unknown, unforeseen, and erroneous protocol data + +### 9.1 General + +The procedures specified in the present document apply to those PC3 or PC5 messages which pass the checks described in this subclause. + +This subclause also specifies procedures for the handling of unknown, unforeseen, and erroneous protocol data by the receiving entity. These procedures are called "error handling procedures", but in addition to providing recovery mechanisms for error situations they define a compatibility mechanism for future extensions of the protocols. + +Detailed error handling procedures in the network are implementation dependent and may vary from PLMN to PLMN. However, when extensions of this protocol are developed, networks will be assumed to have the error handling that is indicated in this subclause as mandatory ("shall") and that is indicated as strongly recommended ("should"). + +Also, the error handling of the network is only considered as mandatory or strongly recommended when certain thresholds for errors are not reached during a dedicated connection. + +## 9.2 Handling of unknown, unforeseen, and erroneous protocol data in messages sent over the PC5 interface + +### 9.2.1 Message too short + +When a message is received that is too short to contain a complete message type parameter, that message shall be ignored. + +### 9.2.2 Unknown or unforeseen message type + +If the UE receives a PC5\_DISCOVERY message with Message Type not defined as in subclause 12.2.2.10, it shall discard the whole PC5\_DISCOVERY message. + +If the UE receives a PC5\_DISCOVERY message with Message Type indicating a discovery model or discovery type that is not supported by the UE, it shall discard the whole PC5\_DISCOVERY message. + +## 9.3 Handling of unknown, unforeseen, and erroneous protocol data in messages sent over the PC3 interface + +### 9.3.1 Invalid XML + +The protocol data over PC3 interface are encapsulated as XML contents, which may contain one or more PC3 messages. The XML content shall be validated with the XML schema defined in subclause 11.2.3. + +When the UE receives an invalid XML content, it shall discard the whole XML content. When the ProSe Function receives an invalid XML content, it shall discard the whole XML document and send an HTTP response message containing a "400 Bad Request" error code to the UE. + +### 9.3.2 Unforeseen message type + +If the UE receives a PC3 message with a message type corresponding to a ProSe discovery mechanism that the UE is not authorised to use by the network, the UE shall discard the message. For example, if a UE not authorised for EPC-level ProSe discovery receives messages specified for EPC-level ProSe discovery procedures in subclause 7, the UE shall discard the message. + +If the ProSe Function receives a PC3 message whose message type indicates that this is a ProSe discovery mechanism the sending UE is not authorised to support, the ProSe Function shall discard the message. + +--- + +## 10 ProSe direct communication + +### 10.1 General + +This clause describes the procedures at the UE, and between UEs, for ProSe direct communication over the PC5 interface. + +When served by E-UTRAN, the UE shall be authorised for ProSe direct communication in the registered PLMN based on the service authorisation procedure as specified in clause 5, before initiating ProSe direct communication. + +When not served by E-UTRAN, the UE shall be authorised for ProSe direct communication for "not served by E-UTRAN" based on the service authorisation procedure as specified in subclause 5, before initiating ProSe direct communication. + +## 10.2 One-to-many ProSe direct communication + +### 10.2.1 General + +One-to-many ProSe direct communication is applicable only to ProSe-enabled Public Safety UEs. One-to-many ProSe direct communication can only apply when the UE is: + +- a) served by E-UTRAN and authorised for ProSe direct communication in the registered PLMN; +- b) not served by E-UTRAN, and authorised for ProSe direct communication for "not served by E-UTRAN"; or +- c) in EMM-IDLE mode and in limited service state as specified in 3GPP TS 23.122 [24] and authorised for ProSe direct communication when "not served by E-UTRAN", if the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]. + +Upon receiving a request from upper layers to send or receive data for ProSe direct communication in a given group, the UE shall initiate the procedure for ProSe direct communication. For case a, the UE shall perform ProSe direct communication procedures specified in subclause 10.2.2. For case b and c, the UE shall perform ProSe direct communication procedures specified in subclause 10.2.3. + +If the UE is camped on an E-UTRAN cell not operating on the carrier frequency provisioned for ProSe direct communication which indicates that ProSe direct communication is supported by the network, the UE can perform either ProSe direct communication procedures specified in subclause 10.2.2 or ProSe direct communication procedures specified in subclause 10.2.3. + +The UE shall obtain the ProSe direct communication policy parameters for that group as specified in subclause 5, except for the eMBMS content to be relayed by one-to-many ProSe direct communication as specified in subclause 10.2.4.2. + +If the ProSe direct communication policy parameters indicate that the UE is configured to use IPv6 for that group, the UE shall auto-configure a link local IPv6 Address following procedures defined in RFC 4862 [15]. This address can only be used as the source IP address for one-to-many ProSe direct communication. + +If the ProSe Direct communication policy parameters group indicate that the UE is configured to use IPv4 for that group, then the UE shall: + +- use the configured IPv4 address for that group as source address; or +- if there is no configured IPv4 address for that group, use Dynamic Configuration of IPv4 Link-Local Addresses as specified in IETF RFC 3927 [16]. + +### 10.2.2 ProSe direct communication facilitated by serving E-UTRAN + +When the UE is served by E-UTRAN and intends to use the ProSe radio resources (i.e. carrier frequency) provided by an E-UTRAN cell, the UE requests the parameters from the lower layers for transmitting or receiving ProSe direct communication (see 3GPP TS 36.331 [12]). When requesting the parameters from the lower layers for transmitting or receiving ProSe direct communication, the UE shall indicate to lower layers the ProSe Per-Packet Reliability (PPPR) value, if received from the upper layers. The UE shall perform direct communication only if the lower layers indicate that ProSe direct communication is supported by the network. If the UE in EMM-IDLE mode has to request resources for ProSe direct communication as specified in 3GPP TS 36.331 [12], the UE shall perform a service request procedure + +or tracking area update procedure as specified in 3GPP TS 24.301 [11]. Once the radio resources for transmitting or receiving ProSe direct communication are provided by eNodeB as specified in 3GPP TS 36.331 [12], the UE shall start ProSe direct communication. + +### 10.2.3 Procedure for UE to use provisioned radio resources + +When the UE is not served by E-UTRAN, the UE shall select the radio parameters to be used for ProSe direct communication as follows: + +- if the UE can determine itself located in a geographical area, and the UE is provisioned with radio parameters for the geographical area, the UE shall select the radio parameters associated with that geographical area; or +- in all other cases, the UE shall not initiate ProSe direct communication. + +NOTE 1: It is out of scope of the present specification to define how the UE can locate itself in a specific Geographical Area. When the UE is in coverage of a 3GPP RAT it can for example use information derived from the serving PLMN. When the UE is not in coverage of a 3GPP RAT it can use other techniques as determined by local regulations. + +Before initiating ProSe direct communication, the UE shall check with lower layers whether the selected radio parameters can be used in the current location without causing interference to other cells as specified in 3GPP TS 36.331 [12], and: + +- if the lower layers indicate that the usage would not cause any interference, the UE shall initiate ProSe direct communication; or + +NOTE 2: If the lower layers find that there exists a cell operating the provisioned radio resources (i.e., carrier frequency), and the cell belongs to the registered PLMN or a PLMN equivalent to the registered PLMN, and the UE is authorized for ProSe direct communication in this PLMN, the UE can use the radio parameters indicated by the cell as specified in 3GPP TS 36.331 [12]. + +- else if the lower layers report that one or more PLMNs operate in the provisioned radio resources (i.e. carrier frequency) then: + - a) if the following conditions are met: + - 1) none of the PLMNs reported by the lower layers is the registered PLMN or equivalent to the registered PLMN; and + - 2) at least one of the PLMNs reported by the lower layers is in the list of authorised PLMNs for ProSe direct communication and provides radio resources for ProSe direct communication as specified in 3GPP TS 36.331 [12]; + +then the UE shall: + +- 1) if in EMM-IDLE mode, perform PLMN selection triggered by ProSe direct communication as specified in 3GPP TS 23.122 [24]; or +- 2) else if in EMM-CONNECTED mode, either: + - i) perform a detach procedure as specified in 3GPP TS 24.301 [11] and then perform PLMN selection triggered by ProSe direct communication as specified in 3GPP TS 23.122 [24]; or + - ii) not initiate ProSe direct communication. + +Whether the UE performs i) or ii) above is left up to UE implementation; or + +- b) else the UE shall not initiate ProSe direct communication. + +If the registration to the selected PLMN is successful, the UE shall proceed with the procedure to initiate ProSe direct communication as specified in subclause 10.2.2. + +If the UE is performing ProSe direct communication using radio parameters associated with a geographical area and moves out of that geographical area, the UE shall stop performing ProSe direct communication and then: + +- if the UE is not served by E-UTRAN or the UE intends to use radio resources for ProSe other than those operated by the serving E-UTRAN cell, the UE shall select appropriate radio parameters for the new geographical area as specified above; or +- if the UE is served by E-UTRAN and intends to use radio resources for ProSe operated by the serving E-UTRAN cell, the UE shall proceed with the procedure to initiate ProSe direct communication when served by E-UTRAN. + +## 10.2.4 One-to-many ProSe direct communication transmission + +### 10.2.4.1 General + +When receiving user data from upper layers to be sent to a given group, the transmitting UE shall tag each outgoing protocol data unit with the following information before passing it to the lower layers for transmission: + +- a Layer-3 protocol data unit type (see 3GPP TS 36.323 [37]) set to: + - a) IP packet; or + - b) Address Resolution Protocol packet; +- the Source Layer-2 ID set to the ProSe UE ID assigned from the ProSe Key Management Function or self-assigned by the UE; +- the Destination Layer-2 ID set to the ProSe Layer-2 Group ID; +- the ProSe Per-Packet Priority associated with the protocol data unit; and +- the ProSe Per-Packet Reliability (PPPR), if received from the upper layers. + +The UE shall choose from a range of eight possible values to indicate the required ProSe Per-Packet Priority related to the lower layer handling of this packet data unit. The ProSe Per-Packet Priority is selected by the application layer based on criteria that are outside the scope of this specification, and is independent of the ProSe Layer-2 Group ID, which is used as the Layer 2 destination address for this packet data unit. + +### 10.2.4.2 eMBMS traffic relay + +A ProSe UE-to-network relay UE acting as an eMBMS traffic relay shall use one-to-many ProSe direct communication to broadcast the eMBMS traffic received from the network only if the following conditions are met: + +- the ProSe UE-to-network relay UE has detected the TMGI value which it has been requested to monitor during the TMGI monitoring request procedure as specified in subclause 10.5; and +- the ProSe UE-to-network relay UE has announced the PC5\_DISCOVERY message for Relay Discovery Additional Information, which includes the detected TMGI value and the corresponding ProSe Layer 2 Group ID to be used for the one-to-many communication packets carrying the relayed eMBMS traffic associated with this TMGI value. + +For eMBMS traffic relayed by the ProSe UE-to-network relay UE, the ProSe UE-to-network relay UE uses the ProSe Per-Packet Priority that is included in TMGI\_MONITORING\_REQUEST message to determine the ProSe Per-Packet Priority value to be applied for the one-to-many communication packets corresponding to that TMGI when they are relayed over PC5. + +NOTE: It is assumed that the remote UE receives the QCI associated with the TMGI at the application layer along with an associated priority value that the application layer in the remote UE maps into a ProSe Per-Packet Priority. + +For eMBMS traffic relayed by the ProSe UE-to-network relay UE, bearer-level security mechanisms specified in 3GPP TS 33.303 [6] shall not be applied. + +The ProSe UE-to-network relay UE acting as an eMBMS traffic relay shall stop the one-to-many ProSe direct communication, if any of the following conditions is met: + +- the TMGI value corresponding to the relayed eMBMS traffic can no longer be detected by the ProSe UE-to-network relay UE; or + +- There is no longer any remote UE requesting to monitor the TMGI value corresponding to the relayed eMBMS traffic, i.e., the T4105 timer for this TMGI (see subclause 10.5) expires. + +## 10.3 PC3ch Control Protocol for ProSe direct communication + +### 10.3.1 Transport protocol for PC3ch Control Protocol for ProSe direct communication + +The UE and ProSe Function CTF (ADF) shall use HTTP 1.1 as specified in IETF RFC 7230 [18] and IETF RFC 7231 [19] as the transport protocol for messages transmitted over the PC3ch interface. The ProSe messages described here shall be included in the body of either an HTTP request message or an HTTP response message. The following rules apply: + +- a) The UE initiates ProSe transactions with an HTTP request message containing the PC3ch request(s). +- b) The ProSe Function CTF (ADF) responds to the requests with an HTTP response message containing the PC3ch response(s) for the PC3ch request(s); and +- c) HTTP POST methods are used for PC3ch procedures. + +Optionally, the operator can configure the UE with configuration parameters for establishment of the PDN connection for reaching the HPLMN ProSe Function. If the UE is configured with the configuration parameter for establishment of the PDN connection for reaching the HPLMN ProSe Function (see 3GPP TS 24.333 [9]): + +- a) if a PDN connection for reaching the HPLMN ProSe Function is not established yet, the UE shall establish the PDN connection for reaching the HPLMN ProSe Function according to the UE configuration and shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; and +- b) if a PDN connection for reaching the HPLMN ProSe Function is already established (e.g. either due to other ProSe feature or due to other application), the UE shall send the HTTP request message via the PDN connection for reaching the HPLMN ProSe Function; + +### 10.3.2 Procedures for PC3ch Control Protocol for ProSe direct communication + +#### 10.3.2.1 Usage information report list sending procedure + +##### 10.3.2.1.1 General + +The purpose of the usage information report list sending procedure is to enable a ProSe-enabled Public Safety UE to provide information necessary for composing of charging events related to the ProSe direct communication as defined in 3GPP TS 32.277 [27]. + +The UE shall perform the usage information report list sending procedure with the Accounting Data Forwarding (ADF) function block of the Charging Trigger Function (CTF) in the ProSe Function (ProSe Function CTF (ADF)) residing in the HPLMN. + +The UE shall construct the usage information report based on the policy described in subclause 5.1.3. + +##### 10.3.2.1.2 Usage information report list sending procedure initiation + +The UE shall perform the usage information report list sending procedure if the UE is in E-UTRAN coverage and if: + +- a) the following is true: + - 1) if a usage information report list sending procedure was already performed after beginning of ProSe direct communication, the configured collection period has elapsed since the end of the previous usage information report list sending procedure; + - 2) if a usage information report list sending procedure was not performed yet after beginning of ProSe direct communication, the configured collection period has elapsed since beginning of ProSe direct communication; + - 3) the configured reporting window has not elapsed after the configured collection period elapsed; + +- 4) the UE is in the RRC CONNECTED mode; and + - 5) the UE has usage information for at least one collection period; or +- b) the following is true: +- 1) if a usage information report list sending procedure was already performed after beginning of ProSe direct communication, the configured collection period has elapsed since the end of the previous usage information report list sending procedure; + - 2) if a usage information report list sending procedure was not performed yet after beginning of ProSe direct communication, the configured collection period has elapsed since beginning of ProSe direct communication; + - 3) the configured reporting window has elapsed after the configured collection period elapsed; and + - 4) the UE has usage information for at least one collection period. + +The UE shall initiate the usage information report list sending procedure by sending a USAGE\_INFORMATION\_REPORT\_LIST message to the ProSe Function CTF (ADF). + +If the UE is configured with the IP address of the ProSe Function CTF (ADF), the UE shall send the USAGE\_INFORMATION\_REPORT\_LIST message to the configured IP address of the ProSe Function CTF (ADF). If the UE is not configured with the IP address of the ProSe Function CTF (ADF), the UE shall send the USAGE\_INFORMATION\_REPORT\_LIST message to the IP address of the ProSe Function discovered as described in subclause 5.1.2. + +In the USAGE\_INFORMATION\_REPORT\_LIST message, the UE: + +- a) shall include a new transaction ID; +- b) shall include the UE identity set to the UE's IMSI; +- c) for each collection period: + - 1) shall include a sequence number of the usage information report; + - 2) if the UE is configured to report the time stamps when it went in and out of E-UTRAN coverage during the collection period in the usage information, for each going in or out of E-UTRAN coverage: + - A) shall include information whether the UE was in or out of E-UTRAN coverage; + - B) shall include the time stamp of the move; and + - C) if the UE was in E-UTRAN coverage and the UE is configured to report the list of locations of the UE when in E-UTRAN coverage during the collection period in the usage information, for each camping on a cell or usage of a cell in the EMM-CONNECTED mode: + - i) shall include the E-UTRAN cell global identification of the cell; and + - ii) shall include the time stamp of beginning of the camping on the cell or of beginning of the usage of the cell in the EMM-CONNECTED mode; + - 3) if the UE is configured to report the group parameters in the usage information, for each group: + - A) shall include the ProSe Layer-2 Group ID; + - B) shall include the ProSe Group IP multicast address; + - C) if the UE transmitted data during the collection period and the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include the time stamp of the first transmission to the ProSe Group IP multicast address in the collection period; + - D) if the UE received data during the collection period and the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include the time stamp of the first reception from the ProSe Group IP multicast address in the collection period; + - E) shall include an IP address used by the UE as a source address; + +- F) shall include the ProSe UE ID; +- G) for each transmitter in one-to-many ProSe direct communication, shall include the Source L2 ID and IP address of the transmitter; +- H) if the UE is configured to report the amount of data transmitted during the collection period with location information in the usage information, per each in or out of E-UTRAN coverage period and per each E-UTRAN cell used when in E-UTRAN coverage: + - i) shall indicate whether the data are sent in or out of E-UTRAN coverage; + - ii) if the UE transmitted data in an E-UTRAN cell during an in E-UTRAN coverage period: + - shall include the E-UTRAN cell global identification of the E-UTRAN cell; + - shall include amount of the data transmitted in the E-UTRAN cell; + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first transmission in the E-UTRAN cell; and + - if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the indicator of which radio resources were used; + - iii) if the UE transmitted data during out of E-UTRAN coverage period: + - shall include amount of the data transmitted during the out of E-UTRAN coverage period; and + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first transmission during the out of E-UTRAN coverage period; and + - iv) if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the used radio frequency; and +- I) if the UE is configured to report the amount of data transmitted during the collection period without location information in the usage information, per each in or out of E-UTRAN coverage period: + - i) shall indicate whether the data are sent in or out of E-UTRAN coverage; + - ii) if the UE transmitted data during in E-UTRAN coverage period: + - shall include amount of the data transmitted during the in E-UTRAN coverage period; + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first transmission during the in E-UTRAN coverage period; and + - if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the indicator of which radio resources were used; + - iii) if the UE transmitted data during out of E-UTRAN coverage period: + - shall include amount of the data transmitted during the out of E-UTRAN coverage period; and + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first transmission during the out of E-UTRAN coverage period; and + - iv) if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the used radio frequency; and + +- J) if the UE is configured to report the amount of data received during the collection period with location information in the usage information, per each in or out of E-UTRAN coverage period and per each E-UTRAN cell used when in E-UTRAN coverage: + - i) shall indicate whether the data are sent in or out of E-UTRAN coverage; + - ii) if the UE received data in an E-UTRAN cell during an in E-UTRAN coverage period: + - shall include the E-UTRAN cell global identification of the E-UTRAN cell; + - shall include amount of the data received in the E-UTRAN cell; + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first reception in the E-UTRAN cell; and + - if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the indicator of which radio resources were used; + - iii) if the UE received data during out of E-UTRAN coverage period: + - shall include amount of the data received during the out of E-UTRAN coverage period; and + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first reception during the out of E-UTRAN coverage period; and + - iv) if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the used radio frequency; and + - K) if the UE is configured to report the amount of data received during the collection period without location information in the usage information, per each in or out of E-UTRAN coverage period: + - i) shall indicate whether the data are sent in or out of E-UTRAN coverage; + - ii) if the UE received data during in E-UTRAN coverage period: + - shall include amount of the data received during the in E-UTRAN coverage period; + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first reception during the in E-UTRAN coverage period; and + - if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the indicator of which radio resources were used; + - iii) if the UE received data during out of E-UTRAN coverage period: + - shall include amount of the data received during the out of E-UTRAN coverage period; and + - if the UE is configured to report the time stamps of the first transmission/reception during the collection period in the usage information, shall include time stamp of the first reception during the out of E-UTRAN coverage period; and + - iv) if the UE is configured to report the radio parameters used for ProSe direct communication (i.e. indicator of which radio resources used and radio frequency used) during the reporting period in the usage information, shall include the used radio frequency; and +- 4) if configured radio parameters for the ProSe direct communication applicable in the geographical area of the UE were used during the collection period, shall include the configured radio parameters for the ProSe direct communication applicable in the geographical area of the UE; and + +- d) for each application specific data received from upper layers during the collection period, shall include the received application specific data. + +Figure 10.3.2.1.2.1 illustrates the interaction of the UE and the ProSe Function CTF (ADF) in the usage information report list sending procedure. + +![Sequence diagram illustrating the usage information report list sending procedure between a UE and a ProSe Function CTF (ADF).](aed5b156b9b0fff9167baba88e5fdcfc_img.jpg) + +``` +sequenceDiagram + participant UE + participant ProSeFunctionCTF(ADF) as ProSe Function CTF (ADF) + Note right of ProSeFunctionCTF(ADF): ProSe Function CTF (ADF) + UE->>ProSeFunctionCTF(ADF): USAGE_INFORMATION_REPORT_LIST + ProSeFunctionCTF(ADF)-->>UE: USAGE_INFORMATION_REPORT_LIST_RESPONSE (response-accept) + Note left of UE: OR + Note right of ProSeFunctionCTF(ADF): ProSe Function CTF (ADF) + UE->>ProSeFunctionCTF(ADF): USAGE_INFORMATION_REPORT_LIST + ProSeFunctionCTF(ADF)-->>UE: USAGE_INFORMATION_REPORT_LIST_RESPONSE (response-reject) +``` + +The diagram shows two interaction paths between a UE and a ProSe Function CTF (ADF). In the first path, the UE sends a **USAGE\_INFORMATION\_REPORT\_LIST** message to the ProSe Function CTF (ADF), which responds with a **USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE** message containing a **response-accept** element. In the second path, separated by a dashed line labeled **OR**, the UE sends a **USAGE\_INFORMATION\_REPORT\_LIST** message to the ProSe Function CTF (ADF), which responds with a **USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE** message containing a **response-reject** element. + +Sequence diagram illustrating the usage information report list sending procedure between a UE and a ProSe Function CTF (ADF). + +**Figure 10.3.2.1.2.1: Usage information report list sending procedure** + +#### 10.3.2.1.3 Usage information report list sending procedure accepted by the ProSe Function + +Upon receiving a **USAGE\_INFORMATION\_REPORT\_LIST** message from UE, the ProSe Function CTF (ADF) triggers one or more charging data requests according to 3GPP TS 32.277 [27]. + +If the **USAGE\_INFORMATION\_REPORT\_LIST** message is accepted by the ProSe Function CTF (ADF), the ProSe Function CTF (ADF) shall send a **USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE** message to the UE, containing a **** element with transaction ID set to the value of the transaction ID included in the **USAGE\_INFORMATION\_REPORT\_LIST** message. + +#### 10.3.2.1.4 Usage information report list sending procedure successful completion by the UE + +Upon receipt of the **USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE** message containing a **** element with transaction ID set to the value of the transaction ID included in the **USAGE\_INFORMATION\_REPORT\_LIST** message, the usage information report list sending procedure is successfully completed. + +#### 10.3.2.1.5 Usage information report list sending procedure not accepted by the ProSe Function + +If the **USAGE\_INFORMATION\_REPORT\_LIST** message is not accepted by the ProSe Function CTF (ADF), the ProSe Function CTF (ADF) shall send a **USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE** message to the UE. In the **USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE** message, the ProSe Function CTF (ADF): + +- 1) shall include a **** element with transaction ID set to the value of the transaction ID included in the **USAGE\_INFORMATION\_REPORT\_LIST** message; and +- 2) shall include appropriate cause value. + +### 10.3.2.1.6 Usage information report list sending procedure unsuccessful completion by the UE + +Upon receipt of the USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE message containing a element with transaction ID set to the value of the transaction ID included in the USAGE\_INFORMATION\_REPORT\_LIST message, the usage information report list sending procedure is unsuccessfully completed. + +If the USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE message contains the cause value set to #3 "Invalid Message Format", the UE shall not perform the usage information report list sending procedure until the UE powers off and powers on again or the USIM is removed. + +## 10.4 One-to-one ProSe direct communication + +### 10.4.1 Overview + +This clause describes the PC5 Signalling Protocol procedures between two ProSe-enabled UEs for one-to-one ProSe direct communication. The following PC5 Signalling Protocol procedures are defined: + +- direct link setup; +- direct link keepalive; +- direct link release; and +- direct link authentication. + +### 10.4.1A Radio resource selection + +The UE shall be authorised for one-to-one ProSe direct communication and obtain the ProSe direct communication policy parameters based on the service authorisation procedure as specified in clause 5 before initiating or participating in any PC5 Signalling Protocol procedures for one-to-one ProSe direct communication. + +The UE shall select the radio resources for one-to-one ProSe direct communication as described for one-to-many ProSe direct communication in subclauses 10.2.1, 10.2.2 and 10.2.3. + +For one-to-one communication between a remote UE and a ProSe UE-to-network relay UE, if the remote UE receives a lower layers indication that using radio resources for relay communication is not allowed as specified in 3GPP TS 36.331 [12], the remote UE shall abort any ongoing procedures involving a relay (i.e., PC5 signalling Protocol procedures and data transmission/reception) and start an implementation specific timer with value T. While this timer is running, the remote UE shall not initiate any procedures involving a relay. If the remote UE receives lower layers indication that using radio resources for relay communication is allowed as specified in 3GPP TS 36.331 [12], the remote UE shall stop the implementation specific timer and can resume any procedures involving a relay. Otherwise, after the implementation specific timer expires, the remote UE shall release all direct links used for communication with relay(s) locally. + +NOTE: The length of T is UE implementation specific. + +### 10.4.2 Direct link setup procedure + +#### 10.4.2.1 General + +The direct link setup procedure is used to establish a secure direct link between two ProSe-enabled UEs. The UE sending the request message is called the "initiating UE" and the other UE is called the "target UE". + +If the direct link setup is for isolated one-to-one ProSe direct communication, i.e. when none of the two UEs is a ProSe UE-to-network relay, both UEs are required to have fetched in advance the public key of the KMS (Key Management Server), and a set of credentials associated with the UE's identity (as defined in IETF RFC 6507 [39] and IETF RFC 6508 [40]), as specified by 3GPP TS 33.303 [6]. + +#### 10.4.2.2 Direct link setup procedure initiation by initiating UE + +The initiating UE shall meet the following pre-conditions before initiating this procedure: + +- a request from upper layers to establish a direct link with the target UE is received and there is no existing link between the initiating UE and that target UE; +- the link layer identifier for the initiating UE (i.e., Layer 2 ID used for unicast communication) is available (e.g., pre-configured or self-assigned); +- the link layer identifier for the target UE (i.e., Layer 2 ID used for unicast communication) is available to the initiating UE (e.g., pre-configured or obtained via ProSe direct discovery); and +- the initiating UE is either authorised for ProSe direct communication in the serving PLMN, or has a valid authorization for ProSe direct communication when not served by E-UTRAN. + +The initiating UE initiates the direct link setup procedure by generating a DIRECT\_COMMUNICATION\_REQUEST message with: + +- the User Info set to: + - the initiating UE's User Info received from upper layers if the target UE is not a ProSe UE-to-network relay UE; + - the PRUK ID received from the PKMF if the target UE is a ProSe UE-to-network relay UE, the initiating UE has received a PRUK from the PKMF for this relay, and an attempt to connect to this relay has not been rejected due to the PRUK ID not being recognised; + - the initiating UE's IMSI if the target UE is a ProSe UE-to-network relay UE and the initiating UE has not received a PRUK from the PKMF for this relay; or + - the initiating UE's IMSI if the target UE is a ProSe UE-to-network relay UE and the initiating UE has received a PRUK from the PKMF for this relay but an attempt to connect to this relay has been rejected due to the PRUK ID not being recognised; +- an IP Address Config IE set to one of the following values: + - "DHCPv4 Server" if only IPv4 address allocation mechanism is supported by the initiating UE, i.e., acting as a DHCPv4 Server; + - "IPv6 Router" if only IPv6 address allocation mechanism is supported by the initiating UE, i.e., acting as an IPv6 Router; + - "DHCPv4 Server & IPv6 Router" if both IPv4 and IPv6 address allocation mechanisms are supported by the initiating UE; or + - "address allocation not supported" if neither IPv4 nor IPv6 address allocation mechanism is supported by the initiating UE; +- a Link Local IPv6 Address IE formed locally based on IETF RFC 4862 [15] if the IP Address Config IE is set to "address allocation not supported" and the link is setup for isolated one-to-one communication; + +NOTE 1: the UE can reuse a Link Local IPv6 IP address for multiple isolated one-to-one communication links. + +- a Maximum Inactivity Period IE to indicate the maximum inactivity period of the requesting UE over this direct link; + +NOTE 2: The value of Maximum Inactivity Period IE can be calculated based on UE's local settings, such as keepalive timer T4102 (see 10.4.3), retransmission timer T4101 (see 10.4.3), and maximum number of allowed retransmissions for DIRECT\_COMMUNICATION\_KEEPALIVE message. + +- a Nonce\_1 IE set to the 128-bit nonce value generated by the initiating UE for the purpose of session key establishment over this direct link; +- a UE Security Capabilities IE set to indicate the list of algorithms that the initiating UE supports for the security establishment of this direct link; +- an MSB of $K_{D-sess}$ ID IE set to the most significant 8 bits of the $K_{D-sess}$ ID; and + +- Optionally, a $K_D$ ID IE set to the known ID of $K_D$ which was previously established if the initiating UE has an existing $K_D$ with the target UE. + +If the direct link setup is for isolated one-to-one ProSe direct communication, the DIRECT\_COMMUNICATION\_REQUEST message shall also include the following parameters: + +- the Signature IE set to the ECCSI signature calculated with the following information elements, as specified in 3GPP TS 33.303 [6]: + - User Info; and + - Nonce\_1. + +Else if the link setup for remote UE to ProSe UE-to-network relay ProSe direct communication, the DIRECT\_COMMUNICATION\_REQUEST message shall also include the Relay Service Code IE set to the Relay Service Code of the target relay. + +After the DIRECT\_COMMUNICATION\_REQUEST message is generated, the initiating UE shall pass this message to the lower layers for transmission along with the initiating UE's Layer 2 ID (for unicast communication) and the target UE's Layer 2 ID (for unicast communication), and start timer T4100. The UE shall not send a new DIRECT\_COMMUNICATION\_REQUEST message to the same target UE while timer T4100 is running. + +![Sequence diagram showing the direct link setup procedure between an Initiating UE and a Target UE. It illustrates the exchange of DIRECT_COMMUNICATION_REQUEST, security procedures, and the final DIRECT_COMMUNICATION_ACCEPT or DIRECT_COMMUNICATION_REJECT messages.](6322885569221ec51d70560d7dba1339_img.jpg) + +``` + +sequenceDiagram + participant Initiating UE + participant Target UE + Initiating UE->>Target UE: DIRECT_COMMUNICATION_REQUEST + Note over Initiating UE, Target UE: Security procedure + Target UE-->>Initiating UE: DIRECT_COMMUNICATION_ACCEPT + Note over Initiating UE, Target UE: OR + Target UE-->>Initiating UE: DIRECT_COMMUNICATION_REJECT + +``` + +Sequence diagram showing the direct link setup procedure between an Initiating UE and a Target UE. It illustrates the exchange of DIRECT\_COMMUNICATION\_REQUEST, security procedures, and the final DIRECT\_COMMUNICATION\_ACCEPT or DIRECT\_COMMUNICATION\_REJECT messages. + +**Figure 10.4.2.2.1: Direct link setup procedure** + +### 10.4.2.3 Direct link setup procedure accepted by the target UE + +Upon receiving a DIRECT\_COMMUNICATION\_REQUEST message, the target UE shall store the pair of Layer 2 IDs (for unicast communication) used in the transport of this message provided by the lower layers and associate them with a direct link context. + +The target UE then checks the User Info IE included in the DIRECT\_COMMUNICATION\_REQUEST message and determines whether this request can be accepted or not. Then, the target UE examines the IP Address Config IE to see whether there is at least one common IP address configuration option supported by both the initiating UE and the target UE. If the above check is successful, the target UE shall invoke the direct security mode control procedure as specified in subclause 10.4.5 to establish a security association between the target UE and the initiating UE. Only after the completion of link authentication procedure and a successful establishment of the security association, the target UE shall send a DIRECT\_COMMUNICATION\_ACCEPT message to the initiating UE. + +The target UE shall include an IP Address Config IE set to one of the following values: + +- "DHCPv4 Server" if only IPv4 address allocation mechanism is supported by the target UE and the target UE is able to act as DHCP server; +- "IPv6 Router" if only IPv6 address allocation mechanism is supported by the target UE and the target UE is able to act as IPv6 Router; +- "DHCPv4 Server & IPv6 Router" if both IPv4 and IPv6 address allocation mechanisms are supported by the target UE; or +- "address allocation not supported" if neither IPv4 nor IPv6 address allocation is supported by the target UE. + +If the IP Address Config IE is set to "address allocation not supported" and the received DIRECT\_COMMUNICATION\_REQUEST message included a Link Local IPv6 Address IE, the target UE shall include a Link Local IPv6 Address IE set to the link-local IPv6 address formed locally. + +NOTE: the UE can reuse a Link Local IPv6 IP address for multiple isolated one-to-one communication links. + +A ProSe UE-to-network relay UE shall support at least one of the IP address allocation mechanisms. + +If the target UE acts as a ProSe UE-to-network relay UE and PDN connection for relaying associated with the ProSe relay UE ID is not established yet or additional PDN connection used for relaying is needed when the ProSe UE-to-network relay UE sends the DIRECT\_COMMUNICATION\_ACCEPT message to the remote UE, the ProSe UE-to-network relay UE shall initiate the UE requested PDN connectivity procedure by sending the PDN CONNECTIVITY REQUEST message including the APN which is associated with the ProSe Relay UE ID as specified in 3GPP TS 24.301 [11]. + +If the target UE is a ProSe-UE-to-network relay UE, the target UE shall create an inactivity timer T4108 with the value provided in the Maximum Inactivity Period IE included in the DIRECT\_COMMUNICATION\_REQUEST message, and start the timer T4108 when it has no more messages to send over the link to be established. Once the timer T4108 is started, if any communication activity occurs before the timer T4108 expires, the UE shall stop the timer T4108 and reset it with the initial value, unless a new value is provided in a Maximum Inactivity Period IE in a DIRECT\_COMMUNICATION\_KEEPALIVE message. + +If the target UE is a ProSe-UE-to-network relay UE, and it has been configured by the serving PLMN to report the IMEI or IMEISV of the remote UE(s) served by the relay based on the service authorisation procedure as specified in clause 5, the ProSe UE-to-network relay UE shall initiate a remote UE information request procedure (as specified in subclause 10.7.2) to request the IMEI or IMEISV of the remote UE upon successful direct link establishment. + +#### 10.4.2.4 Direct link setup procedure completion by the initiating UE + +Upon receipt of the DIRECT\_COMMUNICATION\_ACCEPT message, the initiating UE shall stop timer T4100. From this time onward the initiating UE shall use the established link for all one-to-one communication (including additional PC5 Signalling messages) to the target UE. + +#### 10.4.2.5 Direct link setup procedure not accepted by the target UE + +If the direct link setup request cannot be accepted, the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message. The DIRECT\_COMMUNICATION\_REJECT message contains a PC5 Signalling Protocol cause value set to one of the following cause values: + +- #1 Direct communication to target UE not allowed; +- #2 Authentication failure; +- #3 Conflict of Layer 2 ID for unicast communication is detected; +- #4 Lack of resources for proposed link; +- #5 IP version mismatch; or +- #6 Link setup failure due to other errors. + +If the target UE is not allowed to accept this request.e.g. based on operator policy or service authorisation provisioning, the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #1 "Direct communication to target UE not allowed". + +If verification of the signature parameter included in the DIRECT\_COMMUNICATION\_REQUEST message fails at the target UE (see subclause 10.4.5), the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #2 "Authentication failure". + +If the direct link setup fails due to the problems in direct link authentication procedure (see 10.4.5), the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #2 "Authentication failure". + +For a received DIRECT\_COMMUNICATION\_REQUEST message from a Layer 2 ID (for unicast communication), if the target UE already has an existing link established to the UE known to use this Layer 2 ID or is currently processing a DIRECT\_COMMUNICATION\_REQUEST message from the same Layer 2 ID, but with User Info different from the User Info IE included in this new incoming message, the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #3 "Conflict of Layer 2 ID for unicast communication is detected". + +If the direct link setup fails due to the congestion problems or other temporary lower layer problems causing resource constraints, the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #4 "Lack of resources for proposed link". + +In case of ProSe UE-to-network relay UE, if the remote UE intends to use the ProSe UE-to-network relay UE for mission critical communication (e.g. MCPTT), but the ProSe UE-to-network relay UE does not support IPv6 address allocation scheme as a router, the target UE (i.e. ProSe UE-to-network relay UE) shall reject the request with DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #5 "IP version mismatch". + +NOTE 1: To determine if remote UE intends to use the ProSe UE-to-network relay UE for mission critical communication (e.g. MCPTT), the target UE can examine the Layer 2 destination address of the transport of DIRECT\_COMMUNICATION\_REQUEST message to check whether it matches the ProSe Relay UE ID which has been associated to mission critical communication (e.g. MCPTT) or examine the User Info included in the DIRECT\_COMMUNICATION\_REQUEST message. + +For other reasons that causing the failure of link establishment, the target UE shall send a DIRECT\_COMMUNICATION\_REJECT message containing PC5 Signalling Protocol cause value #6 "Link setup failure due to other errors". + +Upon receipt of the DIRECT\_COMMUNICATION\_REJECT message, the initiating UE shall stop timer T4100 and abort the direct link setup procedure. If the cause value in the DIRECT\_COMMUNICATION\_REJECT message is #1 "Direct communication to target UE not allowed" or #4 "Lack of resources for proposed link", then the UE shall not attempt to start direct link setup with the same target UE at least for a time period T, and if the initiating UE is a remote UE requesting link setup to a ProSe UE-to-network relay UE, it shall initiate the relay reselection procedure as specified in subclause 10A.2.13. + +NOTE 2: The length of time period T is UE implementation specific and can be different for the case when the UE receives PC5 Signalling Protocol cause value #1 "Direct communication to target UE not allowed" or when the UE receives cause value #4 "Lack of resources for proposed link". + +## 10.4.2.6 Abnormal cases + +### 10.4.2.6.1 Abnormal cases at the initiating UE + +If timer T4100 expires, the initiating UE shall retransmit the DIRECT\_COMMUNICATION\_REQUEST message and restart timer T4100. After reaching the maximum number of allowed retransmissions, the initiating UE shall abort the direct link setup procedure, may notify the upper layer that the target UE is unreachable, and if the initiating UE is a remote UE requesting link setup to a ProSe UE-to-network relay UE, it shall initiate the relay reselection procedure as specified in subclause 10A.2.4. + +NOTE: The maximum number of allowed retransmissions is UE implementation specific. + +If the need to establish a link no longer exists before the procedure is completed, the initiating UE shall abort the procedure. + +### 10.4.2.6.2 Abnormal cases at the target UE + +For a received DIRECT\_COMMUNICATION\_REQUEST message from a Layer 2 ID (for unicast communication), if the target UE already has an existing link established to the UE known to use this Layer 2 ID and the new request contains an identical User Info as the known user, the UE shall process the new request. However, the target UE shall only delete the existing link context after the new link setup procedure succeeds, or the link keepalive procedure as described in subclause 10.4.3 fails. + +If the inactivity timer T4108 expires, if the target UE is a ProSe UE-to-network relay UE, it shall initiate the direct link release procedure specified in subclause 10.4.4 with the release reason #3 "Direct connection is not available any more". Otherwise, the target UE may: + +- A) initiate its own keepalive procedure to check the link; or +- B) initiate the direct link release procedure specified in subclause 10.4.4 with the release reason #3 "Direct connection is not available any more". + +Whether the UE chooses A or B is left to UE implementation. + +## 10.4.3 Direct link keepalive procedure + +### 10.4.3.1 General + +The direct link keepalive procedure is used to maintain the direct link between two ProSe-enabled UEs, i.e., check that the link between the two UEs is still viable. The procedure can be initiated by only one UE or both of the UEs in the established direct link. If the direct link is used for one-to-one communication between a remote UE and a ProSe UE-to-network relay UE, only the remote UE shall initiate the link keepalive procedure. + +In this procedure, the UE sending the DIRECT\_COMMUNICATION\_KEEPALIVE message is called the "requesting UE" and the other UE is called the "peer UE". + +### 10.4.3.2 Direct link keepalive procedure initiation by the requesting UE + +The requesting UE manages a keepalive timer T4102 and a keepalive counter for this procedure. The keepalive timer T4102 is used to trigger the periodic initiation of the procedure. It is started or restarted whenever the UE receives a PC5 Signalling message or PC5 user plane data from the peer UE over this link. The keepalive counter is set to an initial value of zero after link establishment. + +The requesting UE may initiate the procedure if: + +- a request from upper layers to check the viability of the direct link is received; or +- the keepalive timer T4102 for this link expires. + +The requesting UE initiates the procedure by stopping timer T4102 if it is still running and generating a DIRECT\_COMMUNICATION\_KEEPALIVE message with a Keepalive Counter IE that contains the value of the keepalive counter for this link. Optionally, the initiating UE may include a Maximum Inactivity Period IE to indicate the maximum inactivity period of the requesting UE over this direct link. When a remote UE sends DIRECT\_COMMUNICATION\_KEEPALIVE message to the ProSe UE-to-network relay UE, this IE shall be included. + +After the DIRECT\_COMMUNICATION\_KEEPALIVE message is generated, the requesting UE shall pass this message to the lower layers for transmission along with the requesting UE's Layer 2 ID (for unicast communication) and the peer UE's Layer 2 ID (for unicast communication), and start retransmission timer T4101. + +![A large black rectangular area, likely a placeholder for a diagram. Below it, a thin horizontal line with a small arrow pointing left is visible.](9a2e0224fed754d6b740485c9d4a6107_img.jpg) + +A large black rectangular area, likely a placeholder for a diagram. Below it, a thin horizontal line with a small arrow pointing left is visible. + +**Figure 10.4.3.2.1: Direct link keepalive procedure** + +### 10.4.3.3 Direct link keepalive procedure accepted by the peer UE + +Upon receiving a DIRECT\_COMMUNICATION\_KEEPALIVE message, the peer UE shall respond with a DIRECT\_COMMUNICATION\_KEEPALIVE\_ACK message including the Keepalive Counter IE set to the same value as that received in the DIRECT\_COMMUNICATION\_KEEPALIVE message. + +If a Maximum Inactivity Period IE is included in the DIRECT\_COMMUNICATION\_KEEPALIVE message, the peer UE shall stop the inactivity timer T4108 if it is running, and restart the timer T4108 with the value provided in the IE. If any communication activity occurs in this direct link before the timer T4108 expires, the UE shall stop the timer T4108 and reset it with the initial value. + +### 10.4.3.4 Direct link keepalive procedure completed by the requesting UE + +Upon receiving a DIRECT\_COMMUNICATION\_KEEPALIVE\_ACK message, the requesting UE shall stop retransmission timer T4101, start keepalive timer T4102 and increment the keepalive counter for this link. + +### 10.4.3.5 Abnormal cases + +#### 10.4.3.5.1 Abnormal cases at the requesting UE + +If retransmission timer T4101 expires, the requesting UE shall initiate the transmission of the DIRECT\_COMMUNICATION\_KEEPALIVE message again with the last used keepalive counter value and restart timer T4101. If no response is received from the peer UE after reaching the maximum number of allowed retransmissions, the requesting UE shall abort the link keepalive procedure and initiate the direct link release procedure (see subclause 10.4.4) instead, and if the requesting UE is a remote UE, it shall initiate the relay reselection procedure as specified in subclause 10A.2.13. + +NOTE: The maximum number of allowed retransmissions is UE implementation specific. + +If the need to use this direct link no longer exists before the direct link keepalive procedure is completed, the requesting UE shall abort the procedure and start a direct link release procedure (see subclause 10.4.4) instead. + +#### 10.4.3.5.2 Abnormal cases at the peer UE + +If the inactivity timer T4108 expires, if the peer UE is a ProSe UE-to-network relay UE, it shall initiate the direct link release procedure specified in 10.4.4 with the release reason #3 "Direct connection is not available any more". Otherwise, the peer UE may: + +- A) initiate its own keepalive procedure to check the link; or +- B) initiate the direct link release procedure specified in 10.4.4 with the release reason #3 "Direct connection is not available any more". + +Whether the UE chooses A or B is left to UE implementation. + +## 10.4.4 Direct link release procedure + +### 10.4.4.1 General + +The Direct link release procedure is used to release a secure direct link between two ProSe-enabled UEs. The link can be released from either end points. The UE sending the DIRECT\_COMMUNICATION\_RELEASE message is called the "releasing UE" and the other UE is called the "peer UE". + +When the direct link between a remote UE and a ProSe UE-to-network relay UE is released, the ProSe-UE-to-network relay UE shall perform the Remote UE report procedure as specified in 3GPP TS 24.301 [11]. + +#### 10.4.4.2 Direct link release procedure initiation by the releasing UE + +The releasing UE shall initiate the procedure if: + +- a request from upper layers to release a direct link with the peer UE which uses a known Layer 2 ID (for unicast communication) is received and there is an existing link between those two UEs; or +- the peer UE has been non-responsive, e.g., unable to complete the direct link keepalive procedure. + +The releasing UE initiates the direct link release procedure by generating a DIRECT\_COMMUNICATION\_RELEASE message with a Release Reason IE indicating one of the following cause values: + +- #1 Direct Communication to peer UE no longer needed; +- #2 Direct communication with the peer UE is no longer allowed; or +- #3 Direct connection is not available any more. + +After the DIRECT\_COMMUNICATION\_RELEASE message is generated, the releasing UE shall pass this message to the lower layers for transmission along with the releasing UE's Layer 2 ID (for unicast communication) and the peer UE's Layer 2 ID (for unicast communication). The releasing UE shall release the direct link locally if the release reason is #3 "Direct connection is not available any more". Otherwise, the releasing UE shall start timer T4103. + +![Diagram showing the direct link release procedure initiation. A long horizontal line with an arrow pointing right represents the release message from the releasing UE. Below it, a shorter horizontal line with an arrow pointing left represents the response from the peer UE.](f246294bf54daf21d334d732c4b76d88_img.jpg) + +The diagram illustrates the initiation of the direct link release procedure. It consists of two horizontal lines. The top line is longer and has an arrowhead pointing to the right, representing the DIRECT\_COMMUNICATION\_RELEASE message sent by the releasing UE. The bottom line is shorter and has an arrowhead pointing to the left, representing the response from the peer UE. + +Diagram showing the direct link release procedure initiation. A long horizontal line with an arrow pointing right represents the release message from the releasing UE. Below it, a shorter horizontal line with an arrow pointing left represents the response from the peer UE. + +**Figure 10.4.4.2.1: Direct link release procedure** + +#### 10.4.4.3 Direct link release procedure accepted by the peer UE + +Upon receiving a DIRECT\_COMMUNICATION\_RELEASE message, the peer UE shall stop timer T4101, timer T4102, timer T4103 or timer T4108 for this link, if any of those timers is running, and abort any other ongoing PC5 Signalling Protocol procedures on this link. The peer UE shall respond with a DIRECT\_COMMUNICATION\_RELEASE\_ACCEPT message. After the message is sent, the peer UE shall remove the context of this direct link and no longer send or receive any messages via this link. + +If the cause value in the DIRECT\_COMMUNICATION\_RELEASE message is "Direct communication with the peer UE is no longer allowed", then the UE shall not attempt to start direct link setup with the releasing UE at least for the time period T and if the peer UE is a remote UE requesting link setup to a ProSe UE-to-network relay UE, it shall initiate the relay reselection procedure as specified in subclause 10A.2.13. + +NOTE: The length of time period T is UE implementation specific. + +#### 10.4.4.4 Direct link release procedure completion by the releasing UE + +Upon receipt of the DIRECT\_COMMUNICATION\_RELEASE\_ACCEPT message, the releasing UE shall stop timer T4103. From this time onward the releasing UE shall no longer send or receive any messages via this link. + +## 10.4.4.5 Abnormal cases + +### 10.4.4.5.1 Abnormal cases at the releasing UE + +If retransmission timer T4103 expires, the releasing UE shall initiate the transmission of the DIRECT\_COMMUNICATION\_RELEASE message again and restart timer T4103. If no response is received from the peer UE after reaching the maximum number of allowed retransmissions, the releasing UE shall release the direct link locally. From this time onward the releasing UE shall no longer send or receive any messages via this link. + +NOTE: The maximum number of allowed retransmissions is UE implementation specific. + +## 10.4.5 Direct security mode control procedure + +### 10.4.5.1 General + +Security association for a direct link between two ProSe-Enabled UEs is established during the direct link setup procedure or direct link rekeying procedure with the exchange of message contents related to direct security mode establishment. After successful completion of the direct security mode control procedure, the selected security algorithms and keys are used to integrity protect and cipher all PC5 Signalling messages exchanged between the UEs; and are also used to cipher all data plane traffic exchanged between the UEs. + +In the rest of this subclause, the UE sending the DIRECT\_SECURITY\_MODE\_COMMAND message is called the "commanding UE" and the other UE is called the "peer UE". + +### 10.4.5.2 Direct security mode control procedure initiation by the commanding UE + +A commanding UE may initiate the direct security mode control procedure in response to receiving a DIRECT\_COMMUNICATION\_REQUEST or a DIRECT\_REKEYING\_REQUEST message. + +If the procedure takes place between a remote UE and a ProSe UE-to-network relay UE and is triggered by a DIRECT\_REKEYING\_REQUEST to only refresh $K_{D-sess}$ but not $K_D$ , then either the ProSe UE-to-network relay UE or the remote UE can act as the commanding UE. Otherwise, if both keys are to be refreshed, the ProSe UE-to-network relay UE shall act as the commanding UE. + +To initiate this procedure, the commanding UE shall either identify an existing $K_D$ based on the $K_D$ ID included in the DIRECT\_COMMUNICATION\_REQUEST or DIRECT\_REKEYING\_REQUEST message, or derive a new $K_D$ if it either does not share a known $K_D$ with the peer UE or wishes to derive a new $K_D$ , as specified in 3GPP TS 33.303 [6]. In the latter case, the commanding UE shall generate the MSB of $K_D$ ID to ensure that the resultant $K_D$ ID will be unique in the commanding UE. Then, it shall generate a LSB of $K_{D-sess}$ ID such that the $K_{D-sess}$ ID formed by combining with the MSB of $K_{D-sess}$ ID (received in the DIRECT\_COMMUNICATION\_REQUEST or DIRECT\_REKEYING\_REQUEST that triggered the direct security mode procedure) is unique within the commanding UE. + +Following this, the commanding UE shall generate a 128-bit Nonce\_2 value. With $K_D$ , Nonce\_2 and Nonce\_1 received in the DIRECT\_COMMUNICATION\_REQUEST or DIRECT\_REKEYING\_REQUEST message, the commanding UE shall derive $K_{D-sess}$ as specified in 3GPP TS 33.303 [6]. + +Then, the UE shall construct a DIRECT\_SECURITY\_MODE\_COMMAND message with the following: + +- Nonce\_2 IE set to Nonce\_2; +- the LSB of $K_{D-sess}$ ID IE set to indicate the least significant 8-bits of $K_{D-sess}$ ID; +- the UE Security Capabilities IE set to the UE Security Capabilities received in the DIRECT\_COMMUNICATION\_REQUEST message or DIRECT\_REKEYING\_REQUEST; and +- the Chosen Algorithms IE set to the algorithms to be used for ciphering and integrity protection. + +If the DIRECT\_SECURITY\_MODE\_COMMAND message is used between a remote UE and a ProSe UE-to-network relay UE and the ProSe UE-to-network relay UE received the $K_D$ Freshness parameter from the PKMF, then the ProSe UE-to-network relay UE shall include the following additional parameters in the DIRECT\_SECURITY\_MODE\_COMMAND message to create a new $K_D$ : + +- the GPI IE containing the GPI payload if it was received from the ProSe Key Management Function (PKMF); +- the $K_D$ Freshness IE set to the $K_D$ Freshness parameter received from the PKMF; and + +- the MSB of $K_D$ ID IE set to the MSB of $K_D$ ID of the new $K_D$ . + +If the DIRECT\_SECURITY\_MODE\_COMMAND message is used for isolated one-to-one ProSe direct communication, then the commanding UE shall include the following additional parameters in the DIRECT\_SECURITY\_MODE\_COMMAND message in order to create a new $K_D$ : + +- the User Info IE set to the User Info received from upper layers; +- the MSB of $K_D$ ID IE set to the MSB of $K_D$ ID of the new $K_D$ ; and +- the Signature IE set to the ECCSI signature value calculated with the following information elements, as specified in 3GPP TS 33.303 [6]: + - User Info; + - Nonce\_1; and + - the Encrypted Payload IE set to the SAKKE payload generated as specified in 3GPP TS 33.303 [6]. + +The commanding UE shall select the integrity protection and ciphering algorithms that will be used and include these choices in the Chosen algorithms IE in the DIRECT SECURITY MODE COMMAND message. The UE shall include the received UE security capabilities that was present in the DIRECT\_COMMUNICATION\_REQUEST or a DIRECT\_REKEYING\_REQUEST message that triggered the DIRECT SECURITY MODE COMMAND message. + +The commanding UE shall send the DIRECT SECURITY MODE COMMAND message unciphered, but shall integrity protect the message with the new security context. After sending the DIRECT\_SECURITY\_MODE\_COMMAND message, the commanding UE shall start timer T4111 (see figure 10.4.5.2.1). + +![Sequence diagram showing the Direct Security mode control procedure between a Commanding UE and a Peer UE. The diagram is split into two parts by an 'OR' line. Top part: Commanding UE starts timer T4111 and sends DIRECT_SECURITY_MODE_COMMAND to Peer UE; Peer UE responds with DIRECT_SECURITY_MODE_COMPLETE, and Commanding UE stops T4111. Bottom part: Commanding UE starts timer T4111 and sends DIRECT_SECURITY_MODE_COMMAND to Peer UE; Peer UE responds with DIRECT_SECURITY_MODE_REJECT, and Commanding UE stops T4111.](7be79849b00ccd5e7220d808251b1258_img.jpg) + +``` + +sequenceDiagram + participant CUE as Commanding UE + participant PUE as Peer UE + Note over CUE: Start T4111 + CUE->>PUE: DIRECT_SECURITY_MODE_COMMAND + PUE-->>CUE: DIRECT_SECURITY_MODE_COMPLETE + Note over CUE: Stop T4111 + Note over CUE,PUE: ------------------ OR ------------------ + Note over CUE: Start T4111 + CUE->>PUE: DIRECT_SECURITY_MODE_COMMAND + PUE-->>CUE: DIRECT_SECURITY_MODE_REJECT + Note over CUE: Stop T4111 + +``` + +Sequence diagram showing the Direct Security mode control procedure between a Commanding UE and a Peer UE. The diagram is split into two parts by an 'OR' line. Top part: Commanding UE starts timer T4111 and sends DIRECT\_SECURITY\_MODE\_COMMAND to Peer UE; Peer UE responds with DIRECT\_SECURITY\_MODE\_COMPLETE, and Commanding UE stops T4111. Bottom part: Commanding UE starts timer T4111 and sends DIRECT\_SECURITY\_MODE\_COMMAND to Peer UE; Peer UE responds with DIRECT\_SECURITY\_MODE\_REJECT, and Commanding UE stops T4111. + +**Figure 10.4.5.2.1: Direct Security mode control procedure** + +### 10.4.5.3 Direct security mode control procedure accepted by the peer UE + +Upon receipt of the DIRECT\_SECURITY\_MODE\_COMMAND message, the peer UE shall check whether the security mode command can be accepted or not. This is done by performing the integrity check of the message and by checking that the received UE security capabilities have not been altered compared to the latest values that the peer UE sent to the commanding UE in the DIRECT\_COMMUNICATION\_REQUEST or DIRECT\_REKEYING\_REQUEST message. + +In order to check the integrity, the peer UE needs to create the security context as described in 3GPP TS 33.303 [6]. If the MSB of $K_D$ ID were included in the DIRECT\_SECURITY\_MODE\_COMMAND message then the peer UE shall take one of the following two actions: + +- If performing isolated one-to-one ProSe direct communication, the peer UE shall first check the signature included in the SIGN IE of the DIRECT SECURITY MODE COMMAND and then obtain the new $K_D$ from the Encrypted Payload IE; or +- If the peer UE is a remote UE that has received the DIRECT\_SECURITY\_MODE\_COMMAND message from a ProSe UE-to-network relay UE, it shall first replace its PRUK ID and PRUK if a GPI IE was included in the DIRECT\_SECURITY\_MODE\_COMMAND. Finally, the UE shall derive a new $K_D$ , as described in 3GPP TS 33.303 [6]. + +If MSB of $K_D$ ID was not included in the DIRECT\_SECURITY\_MODE\_COMMAND, then the peer UE shall use either the existing $K_D$ indicated by the $K_D$ ID included in the DIRECT\_COMMUNICATION\_REQUEST or the currently used one. + +The peer UE shall then derive the $K_{D-sess}$ based on the $K_{D-sess}$ ID in the same way as the commanding UE. Finally the peer UE shall use the algorithms indicated in the Chosen Algorithms IE. + +If the DIRECT\_SECURITY\_MODE\_COMMAND message can be accepted, the peer UE shall send a DIRECT\_SECURITY\_MODE\_COMPLETE message ciphered and integrity protected with the new security context. The DIRECT\_SECURITY\_MODE\_COMPLETE message shall include the 16 least significant bits of the $K_D$ ID if the initiating UE included the MSB of $K_D$ ID in the DIRECT\_SECURITY\_MODE\_COMMAND message. + +From this time onward the peer UE shall protect all signalling messages and user data with the new security context. + +#### 10.4.5.4 Direct security mode control procedure completion by the commanding UE + +Upon receipt of the DIRECT\_SECURITY\_MODE\_COMPLETE message, the commanding UE shall stop timer T4111. If an LSB of $K_D$ ID IE was included in the message, the commanding UE uses this and the MSB of $K_D$ ID it previously sent to form the $K_D$ ID of the new $K_D$ . From this time onwards the commanding UE shall protect all signalling messages and user data with the new security context. + +#### 10.4.5.5 Direct security mode control procedure not accepted by the peer UE + +If the DIRECT\_SECURITY\_MODE\_COMMAND message cannot be accepted, the peer UE shall send a DIRECT\_SECURITY\_MODE\_REJECT message. The DIRECT\_SECURITY\_MODE\_REJECT message contains a PC5 Signaling Protocol Cause Value IE indicating one of the following cause values: + +- #7: UE security capabilities mismatch; +- #8: Unspecified error; or +- #9: Authentication synchronisation error. + +If the DIRECT\_SECURITY\_MODE\_COMMAND message cannot be accepted due to a synchronisation error when processing the authentication vector contained in the GPI payload sent by the ProSe UE-to-network relay UE to the remote UE, then the peer UE shall include the RAND and AUTS parameters in the DIRECT\_SECURITY\_MODE\_REJECT message. + +Upon receipt of the DIRECT\_SECURITY\_MODE\_REJECT message, the commanding UE shall stop timer T4111. If the PC5 Signaling Protocol Cause Value IE indicates a synchronisation error and the message contained a RAND and an AUTS, then a ProSe UE-to-network relay may fetch a fresh $K_D$ from the PKMF by sending a Key Request message including RAND and AUTS as specified in 3GPP TS 33.303 [6]. Otherwise the commanding UE shall abort the ongoing procedure that triggered the initiation of the direct security mode control procedure, as specified in subclauses 10.4.2 or 10.4.8. + +#### 10.4.5.6 Abnormal cases + +##### 10.4.5.6.1 Abnormal cases at the commanding UE + +If timer T4111 expires, then + +- if the direct security mode control procedure is triggered by a DIRECT\_COMMUNICATION\_REQUEST message, the commanding UE shall discard any derived keys with Nonce\_1 and initiate the transmission of the DIRECT\_COMMUNICATION\_REJECT message with the PC5 Signaling Protocol Cause Value IE set to #10 "non-responsive peer during the direct security mode procedure"; or + +- if the direct security mode control procedure is triggered by a DIRECT\_REKEYING\_REQUEST message, the commanding UE shall continue to use old keys until those keys are no longer valid. + +#### 10.4.5.6.2 Abnormal cases at the peer UE + +If the DIRECT\_SECURITY\_MODE\_COMMAND message is malformed, the peer UE shall discard the message. + +### 10.4.6 IP Address configuration + +#### 10.4.6.1 General + +The IP address configuration procedure is performed after the establishment of the direct link to enable IP connectivity between the UEs at each end of the direct link. + +When the IP address configuration procedure for a remote UE completes, the ProSe UE-to-network relay UE shall perform the Remote UE report procedure as specified in 3GPP TS 24.301 [11]. + +#### 10.4.6.2 Selection of IP version + +When neither of the two UEs on the direct link acts as a ProSe UE-to-network relay, the two UEs shall select the IP version (IPv4 or IPv6) to be used based on the following rules: + +- if the target UE in the direct link setup procedure (see subclause 10.4.2) has indicated "DHCPv4 Server" in the IP Address Config IE, then the initiating UE in the direct link setup procedure (see subclause 10.4.2) shall initiate the IPv4 address configuration with DHCPv4 procedure acting as a DHCP client; +- if the target UE in the direct link setup procedure has indicated "IPv6 Router" in the IP Address Config IE, then the initiating UE in the direct link setup procedure shall initiate the IPv6 address configuration with IPv6 stateless address auto-configuration acting as an IPv6 host; +- if the target UE in the direct link setup procedure has indicated "DHCPv4 Server & IPv6 Router" in the IP Address Config IE, then the initiating UE in the direct link setup procedure shall choose either IP version and initiate the address configuration procedure, acting as a client or host; +- if the target UE in the direct link setup procedure has indicated "address allocation not supported" in the IP Address Config IE and the initiating UE has indicated "DHCPv4 Server", "IPv6 Router" or "DHCPv4 Server & IPv6 Router" in the IP Address Config IE, then the target UE shall: + - a) initiate the IPv4 address configuration with DHCPv4 procedure acting as a DHCP client, if the initiating UE has indicated "DHCPv4 Server"; + - b) initiate the IPv6 address configuration with IPv6 stateless address auto-configuration acting as an IPv6 host if the initiating UE has indicated "IPv6 Router"; and + - c) choose either IP version and initiate the corresponding IP address configuration procedure as a client or host, if the other UE has indicated "DHCPv4 Server & IPv6 Router"; and +- if both of the UEs has indicated "address allocation not supported" in the IP Address Config IE, then the UEs shall use IPv6 link-local addresses formed locally as defined in RFC 4862 [15]. + +When one of the two UEs on the direct link acts as a ProSe UE-to-network relay, the two UEs shall select the IP version (IPv4 or IPv6) to be used based on the following rules + +- if the ProSe UE-to-network relay UE has indicated "DHCPv4 Server" in the IP Address Config IE, the remote UE shall initiate the IPv4 address configuration with DHCPv4 procedure acting as a DHCP client; +- if the ProSe UE-to-network relay UE has indicated "IPv6 Router" in the IP Address Config IE, the remote UE shall initiate the IPv6 address configuration with IPv6 stateless address auto-configuration acting as an IPv6 host; and +- if the ProSe UE-to-network relay UE has indicated "DHCPv4 Server & IPv6 Router" in the IP Address Config IE, the remote UE shall choose the IP version and initiate the corresponding IP address configuration procedure as a client or host. Especially, if the remote UE intends to use the ProSe UE-to-network relay UE for mission critical communication (e.g. MCPTT), the remote UE shall initiate the IPv6 stateless address auto-configuration acting as an IPv6 host. + +### 10.4.6.3 IPv4 address configuration with DHCPv4 + +The IPv4 address configuration with DHCPv4 shall be carried out as follow: + +1. The DHCP client sends a DHCPDISCOVER message; +2. The DHCP server sends the DHCPOFFER message with the assigned IPv4 address for the client. The IPv4 address provided shall correspond to a local IPv4 address range configured in the DHCP server; +3. When the DHCP client receives the lease offer, it sends a DHCPREQUEST message containing the received IPv4 address. +4. The DHCP server sends a DHCPACK message to the client UE. This message includes the lease duration and any other configuration information that the client might have requested. +5. On receiving the DHCPACK message, the IPv4 address configuration is completed. + +NOTE: The DHCPv4 client may skip the DHCPv4 Discovery phase, and send DHCPv4 Request message in broadcast as the first message in accordance with the DHCPv4 renewal process. + +If the direct link is setup for one-to-one communication between a remote UE and a UE-to-network relay UE, after the remote UE releases the IPv4 address using DHCPv4 or the IPv4 address lease time expires, the ProSe UE-to-network relay UE shall wait for a relay implementation specific time before allocating the same IPv4 address to another remote UE. + +### 10.4.6.4 IPv6 address configuration with IPv6 stateless address auto-configuration + +The IPv6 stateless address auto-configuration protocol procedure shall be carried out as follow: + +1. the UE acting as an IP Host shall send a Router Solicitation message in order to solicit a Router Advertisement message as specified in IETF RFC 4862 [15]. +2. Upon receiving the Router Solicitation message, the other UE shall send an IPv6 Router Advertisement message as specified in IETF RFC 4862 [15], acting as an advertising interface as specified in IETF RFC 4861 [33]. The Router Advertisement messages shall contain an IPv6 prefix, which is to be combined with the interface identifier to form the IPv6 address. +3. The UE which receives the Router advertisement message retrieves the router's address from the Source IP address field of the message, and formed its own IP address with the prefix and the interface identifier as specified in IETF RFC 4862 [15]. + +If the direct link is setup for one-to-one communication between a remote UE and a UE-to-network relay, the UE-to-network relay shall obtain the IPv6 prefix assigned to the remote UE via prefix delegation function from the network as defined in 3GPP TS 23.401 [34] before sending the IPv6 prefix to the remote UE. After the remote UE receives the Router Advertisement message, it constructs a full IPv6 address via IPv6 Stateless Address auto-configuration in accordance with IETF RFC 4862 [15]. However, the remote UE shall not use any identifiers defined in TS 23.003 [4] as the basis for generating the interface identifier. For privacy, the remote UE may change the interface identifier used to generate the full IPv6 address, as defined in 3GPP TS 23.221 [35] without involving the network. The remote UE shall use the auto-configured IPv6 address while sending packets in this implicitly created PDN connection. + +If the direct link is setup for one-to-one communication between a remote UE and a UE-to-network relay and support for mission critical applications and policy control for remote UEs is required, the remote UE shall be assigned a /64 IPv6 Prefix from a shorter IPv6 prefix by the UE-to-network relay. + +NOTE: In order to support policy control per remote UE, the assignment of a /64 IPv6 Prefix from a shorter IPv6 prefix by the UE-to-network relay is used. The support of the extended TFT filter format including the TFT packet filter attribute Local Address and Mask, as defined in 3GPP TS 24.008 [30], is needed in the UE-to-network relay and the network. + +## 10.4.7 ProSe Per-Packet Priority for one-to-one ProSe direct communication + +### 10.4.7.1 General + +When receiving the user data from upper layers to be sent over a direct link, the transmitting UE shall associate each outgoing protocol data unit with one of eight possible values to indicate the required ProSe Per-Packet Priority related + +to the lower layer handling of this packet data unit. The ProSe Per-Packet Priority is selected by the application layer based on criteria that are outside the scope of this specification, and is independent of the Layer 2 destination address used for this packet data unit. + +The UE shall associate any outgoing PC5 signalling message with the single ProSe Per-Packet Priority value provisioned for PC5 signalling messages. + +#### 10.4.7.2 ProSe Per-Packet Priority for ProSe UE-to-network relay + +For unicast uplink traffic, the ProSe UE-to-network relay uses the uplink TFTs to select the uplink EPS bearers for relayed uplink packets independently from the ProSe Per-Packet Priority applied over PC5 by remote UEs. + +For unicast downlink traffic the ProSe UE-to-network relay maps the QCI of the EPS bearer into a ProSe Per-Packet Priority value to be applied for the downlink relayed unicast packets over PC5. The mapping rules are provisioned in the ProSe UE-to-network relay. + +NOTE: downlink traffic on EPS bearers associated with the same QCI, but different ARP values, is assigned the same ProSe Per-Packet Priority over PC5. + +### 10.4.8 Direct link rekeying procedure + +#### 10.4.8.1 General + +This procedure is used to refresh the security context used between two UEs on an established direct link. + +The UE sending the DIRECT\_REKEYING\_REQUEST message is called the "initiating UE" and the other UE is called the "target UE". + +This procedure triggers initiation of a direct security mode control procedure by the target UE. If the ProSe UE-to-network relay UE wants to initiate this procedure to refresh $K_D$ , it shall use a DIRECT\_REKEYING\_TRIGGER message to trigger the remote UE to initiate this procedure from the other direction. + +#### 10.4.8.2 Direct link rekeying procedure initiation + +A UE shall initiate the direct link rekeying procedure in any of the following cases: + +- a) the session key $K_{D-sess}$ used to protect direct link communication is going to expire and needs to be refreshed and neither timer T4111 nor T4112 are running; or +- b) the UE wants to refresh $K_D$ and neither timer T4111 nor T4112 are running. + +The initiating UE shall generate a new 128-bit $Nonce\_1$ value and the most significant 8-bits of the $K_{D-sess}$ ID. The UE shall generate a DIRECT\_REKEYING\_REQUEST message with the following: + +- a $Nonce\_1$ IE set to the nonce value provided by the initiating UE for the purpose of session key establishment over this direct link; +- a UE Security Capabilities IE set to indicate the list of algorithms that the initiating UE supports for the security establishment of this direct link; +- an MSB of $K_{D-sess}$ ID IE set to the most significant 8-bits of the $K_{D-sess}$ ID; +- Optionally, an Auth Flag IE set to the value indicating the $K_D$ to be refreshed, if the UE wants to refresh $K_D$ ; and +- Optionally, a PRUK ID IE if the initiating UE is a remote UE towards a ProSe UE-to-network relay UE. + +A UE initiates the direct link rekeying procedure by sending a DIRECT\_REKEYING\_REQUEST message to the target UE and starting timer T4112 (see figure 10.4.8.2.1). + +![Sequence diagram for Figure 10.4.8.2.1: Direct link rekeying procedure between an Initiating UE and a Target UE.](b50f38be091844d58b11e3d47bc71e73_img.jpg) + +``` + +sequenceDiagram + participant Initiating UE + participant Target UE + Note left of Initiating UE: Start T4112 + Initiating UE->>Target UE: DIRECT_REKEYING_REQUEST + Target UE-->>Initiating UE: DIRECT_REKEYING_RESPONSE + Note left of Initiating UE: Stop T4112 + +``` + +Sequence diagram for Figure 10.4.8.2.1: Direct link rekeying procedure between an Initiating UE and a Target UE. + +**Figure 10.4.8.2.1: Direct link rekeying procedure** + +If the initiating UE is a ProSe UE-to-network relay UE, the ProSe UE-to-network relay UE wishes to refresh $K_D$ used on an established link between the ProSe UE-to-network relay UE and the remote UE, and there is no pending direct link rekeying procedure initiated by the remote UE, the ProSe UE-to-network relay UE shall send a DIRECT\_REKEYING\_TRIGGER message with the format specified in subclause 11.4.17 to trigger the remote UE to initiate its own direct link rekeying procedure and start timer T4113, as shown in figure 10.4.8.2.2. + +Upon receiving a DIRECT\_REKEYING\_TRIGGER message, the remote UE shall: + +- if timer T4112 is not running, initiate a direct link rekeying procedure to refresh $K_D$ as described above; and +- if timer T4112 is running, discard the DIRECT\_REKEYING\_TRIGGER message. + +NOTE: If timer T4112 is running at the remote UE, the ProSe UE-to-network relay UE will use the direct link rekeying procedure already initiated by the remote UE to refresh $K_D$ . + +Once the ProSe UE-to-network relay received the DIRECT\_REKEYING\_REQUEST message, the T4113 timer shall be stopped. + +![Sequence diagram for Figure 10.4.8.2.2: Direct link rekeying procedure triggered by a ProSe UE-to-network relay UE to refresh K_D between a Relay and a Remote UE.](5b5df621a344a773d1ec32e11f3f610f_img.jpg) + +``` + +sequenceDiagram + participant Relay + participant Remote UE + Note left of Relay: Start T4113 + Relay->>Remote UE: DIRECT_REKEYING_TRIGGER + Note right of Remote UE: Start T4112 + Remote UE-->>Relay: DIRECT_REKEYING_REQUEST + Note left of Relay: Stop T4113 + Relay-->>Remote UE: DIRECT_REKEYING_RESPONSE + Note right of Remote UE: Stop T4112 + +``` + +Sequence diagram for Figure 10.4.8.2.2: Direct link rekeying procedure triggered by a ProSe UE-to-network relay UE to refresh K\_D between a Relay and a Remote UE. + +**Figure 10.4.8.2.2: Direct link rekeying procedure triggered by a ProSe UE-to-network relay UE to refresh $K_D$** + +### 10.4.8.3 Direct link rekeying procedure accepted by the target UE + +If there is no active timer T4112 running, the target UE shall process the received DIRECT\_REKEYING\_REQUEST message and initiate a direct security mode control procedure acting as the commanding UE as described in subclause 10.4.5.2. + +If the timer T4112 is running in the target UE, then: + +- if the target UE is a ProSe UE-to-network relay UE, it shall stop timer T4112 and initiate a direct security mode control procedure acting as the commanding UE as described in subclause 10.4.5.2; and + +- if the target UE is neither a remote UE nor a ProSe UE-to-network relay UE, and the Nonce\_1 value received in the DIRECT\_REKEYING\_REQUEST message is larger than the Nonce\_1 value locally generated (and included in the last DIRECT\_REKEYING\_REQUEST message sent by the target UE), the target UE shall stop timer T4112 and initiate a direct security mode control procedure acting as the commanding UE as described in subclause 10.4.5.2. + +When the target UE is a ProSe UE-to-network relay UE, the ProSe UE-to-network relay UE shall trigger a Key Request procedure to the PKMF (see 3GPP TS 33.303 [6]), before initiating the direct security mode control procedure if one of the following conditions are met: + +- the Auth Flag IE is included in the DIRECT\_REKEYING\_REQUEST message; or +- the Auth Flag IE is not included in the DIRECT\_REKEYING\_REQUEST message but the ProSe UE-to-network relay UE wants to refresh $K_D$ . + +Upon completion of the direct security mode control procedure, i.e. upon receiving a DIRECT\_SECURITY\_MODE\_COMPLETE message, the target UE shall send a DIRECT\_REKEYING\_RESPONSE message with the format specified in subclause 11.4.16, to notify the initiating UE of the completion of this direct link rekeying procedure. + +#### 10.4.8.4 Direct link rekeying procedure completion by the initiating UE + +Upon the reception of a DIRECT\_REKEYING\_RESPONSE message, the initiating UE shall stop timer T4112. + +#### 10.4.8.5 Direct link rekeying procedure not accepted by the target UE + +A remote UE that receives a DIRECT\_REKEYING\_REQUEST message shall ignore the message if timer T4112 is running. Also, if there is no timer T4112 running but the remote UE wants to refresh $K_D$ , the UE shall ignore the received DIRECT\_REKEYING\_REQUEST message and act as the new initiating UE and initiate the direct link rekeying procedure to refresh the $K_D$ as described in subclause 10.4.8.2. + +Other UEs shall ignore a DIRECT\_REKEYING\_REQUEST message if timer T4112 is running and the Nonce\_1 value received in the DIRECT\_REKEYING\_REQUEST message is not larger than the Nonce\_1 value locally generated (and included in the last DIRECT\_REKEYING\_REQUEST message sent by the target UE). + +#### 10.4.8.6 Abnormal cases + +##### 10.4.8.6.1 Abnormal cases at the initiating UE + +If timer T4112 expires, the initiating UE shall initiate the transmission of the DIRECT\_REKEYING\_REQUEST message again and restart timer T4112. If no response is received from the target UE after reaching the maximum number of allowed retransmissions, the initiating UE shall abort the direct link rekeying procedure and initiate the direct link release procedure (see subclause 10.4.4). Additionally, if the initiating UE is a remote UE, it shall initiate the relay reselection procedure as specified in subclause 10A.2.13. + +NOTE: The maximum number of allowed retransmissions is UE implementation specific. + +##### 10.4.8.6.2 Abnormal cases at the target UE + +If the DIRECT\_REKEYING\_REQUEST message is malformed, the target UE shall discard the message. + +### 10.5 TMGI monitoring request procedure + +#### 10.5.1 General + +The purpose of the TMGI monitoring request procedure is for the remote UE to obtain a ProSe Layer 2 Group ID from the ProSe UE-to-network relay UE for receiving the MBMS content for the corresponding TMGI over PC5 interface or for the remote UE to inform the ProSe UE-to-network relay UE to forward the MBMS content for the corresponding TMGI. + +The remote UE in this procedure shall be a ProSe-enabled Public Safety UE and authorised to act as a remote UE towards a ProSe UE-to-network relay UE based on the service authorisation procedure as specified in clause 5. The ProSe UE-to-network relay UE in this procedure shall be a ProSe-enabled Public Safety UE and authorised to act as a ProSe UE-to-network relay UE based on the service authorisation procedure as specified in clause 5. + +## 10.5.2 TMGI monitoring request procedure initiation by the remote UE + +Before initiating the TMGI monitoring request procedure, the remote UE has successfully discovered the ProSe UE-to-network relay UE and obtained the Layer 2 ID of the ProSe UE-to-network relay UE as described in subclause 10A.2. The remote UE has also obtained TMGI and MBMS SAI from a group communication application to receive related MBMS content (e.g. as specified in 3GPP TS 23.179 [38]). + +The remote UE shall initiate a TMGI monitoring request procedure: + +- when the remote UE is triggered by an upper layer application to receive the MBMS content for a given TMGI and there is no corresponding TMGI monitoring refresh timer T4104 assigned by the ProSe UE-to-network relay UE; +- when the TMGI monitoring refresh timer T4104 assigned by the ProSe UE-to-network relay UE has expired and the request from the upper layer to receive the MBMS content for a given TMGI is still in place; +- when the remote UE receives a request from an upper layer application to change the requested ProSe Per-Packet Priority associated with the TMGI of an MBMS content that the remote UE is currently receiving; or +- when the remote UE receives a request from an upper layer application to change the requested MBMS SAI list associated with the TMGI of an MBMS content that the remote UE is currently receiving. + +The remote UE shall initiate the TMGI monitoring request procedure by sending a TMGI\_MONITORING\_REQUEST with: + +- the TMGI set to the TMGI received from the application layer; +- the MBMS SAI list included the TMGI corresponding MBMS SAIs received from the application layer; and +- the Requested ProSe Per-Packet Priority set to the ProSe Per-Packet Priority value mapped from the priority value associated with the TMGI from the application layer. + +![Sequence diagram of the TMGI monitoring request procedure initiation.](cfe711931d1dd12a1e679873e79d9b1a_img.jpg) + +The diagram illustrates the interaction between a remote UE and a ProSe UE-to-network relay UE. The remote UE sends a TMGI\_MONITORING\_REQUEST message to the relay UE. Upon sending this request, the remote UE starts timer T4104. The relay UE responds with a TMGI\_MONITORING\_RESPONSE message. Upon receiving this response, the relay UE starts timer T4105. + +``` +sequenceDiagram + participant Remote UE + participant ProSe UE-to-network relay UE + Note left of Remote UE: Start T4104 + Remote UE->>ProSe UE-to-network relay UE: TMGI_MONITORING_REQUEST + Note right of ProSe UE-to-network relay UE: Start T4105 + ProSe UE-to-network relay UE-->>Remote UE: TMGI_MONITORING_RESPONSE +``` + +Sequence diagram of the TMGI monitoring request procedure initiation. + +**Figure 10.5.2.1: TMGI monitoring request procedure** + +## 10.5.3 TMGI monitoring request procedure accepted by the ProSe UE-to-network relay UE + +Upon receiving a TMGI\_MONITORING\_REQUEST, the ProSe UE-to-network relay UE shall store the TMGI and the MBMS SAIs received in the TMGI\_MONITORING\_REQUEST and check whether at least one of the MBMS SAIs is included in the MBMS SAI list of the serving cell. If there is no MBMS SAI list of the serving cell, the ProSe UE-to-network relay UE retrieves the MBMS SAI list from the system information of the serving cell as specified in 3GPP TS 36.331 [12]. + +If the MBMS SAI check indicates at least one of the MBMS SAIs is included in the MBMS SAI list of the serving cell, the ProSe UE-to-network relay UE shall monitor the TMGI received in the TMGI\_MONITORING\_REQUEST in the MCCH channel of the serving cell as specified in 3GPP TS 36.331 [12]. + +If the MBMS SAI check indicates none of the MBMS SAIs is included in the MBMS SAI list of the serving cell, the ProSe UE-to-network relay UE shall not monitor the TMGI received in the TMGI\_MONITORING\_REQUEST in the MCCH channel of the serving cell as specified in 3GPP TS 36.331 [12]. + +For the receiving TMGI, the ProSe UE-to-network relay UE shall allocate a ProSe Layer 2 Group ID which is neither provisioned for one-to-many direct communication nor used for other TMGI(s). The ProSe UE-to-network relay UE shall also allocate a value for TMGI monitoring refresh timer T4104 to the remote UE, and start a timer T4105. For a given TMGI, the timer T4105 shall be longer than the TMGI monitoring refresh timer T4104. + +For the receiving Requested ProSe Per-Packet Priority, the ProSe UE-to-network relay UE shall associate the ProSe Per-Packet Priority value with the receiving TMGI. If there is only one ProSe Per-Packet Priority value associated with the receiving TMGI, the ProSe UE-to-network relay UE shall use the ProSe Per-Packet Priority value to transmit the relayed MBMS traffic corresponding to the TMGI over PC5. If there are several different ProSe Per-Packet Priority values associated with the receiving TMGI, which ProSe Per-Packet Priority value will be used to transmit the TMGI corresponding MBMS traffic over PC5 is based on ProSe UE-to-network relay UE implementation. + +Then the ProSe UE-to-network relay UE shall send a TMGI\_MONITORING\_RESPONSE with: + +- the ProSe Layer2 Group ID set to the allocated ProSe Layer 2 Group ID as the link layer identifier of the group for transmitting the MBMS content corresponding to the TMGI received in the TMGI\_MONITORING\_REQUEST; +- the TMGI monitoring refresh timer T4104 set to the T4104 timer value allocated by the ProSe UE-to-network relay UE for the TMGI received in the TMGI\_MONITORING\_REQUEST; and +- the SAI Indicator set to "true" if the MBMS SAI check indicates at least one of the MBMS SAIs is included in the MBMS SAI list of the serving cell, set to "false" if the MBMS SAI check indicates none of the MBMS SAIs is included in the MBMS SAI list of the serving cell. + +NOTE 1: If different ProSe UE-to-network relay UE allocates the same ProSe Layer 2 Group ID for MBMS content transmitting, the remote UE can use the Source Layer-2 ID (i.e. ProSe Relay UE ID) to distinguish whether the MBMS content is the requested MBMS content or not. If the Source Layer-2 ID is different from the ProSe Relay UE ID of the selected ProSe UE-to-network relay UE, the remote UE can just discard the MBMS content from this Source Layer-2 ID. + +NOTE 2: The applicable action when the remote UE receives a TMGI\_MONITORING\_RESPONSE with the SAI Indicator set to "false" is up to UE implementation (e.g. keep the currently selected ProSe UE-to-network relay UE or reselect another ProSe UE-to-network relay UE). + +If timer T4105 expires, the ProSe UE-to-network relay UE shall remove the TMGI and the MBMS SAIs received in the TMGI\_MONITORING\_REQUEST. + +## 10.5.4 TMGI monitoring request procedure completion by the remote UE + +Upon receiving a TMGI\_MONITORING\_RESPONSE, the UE shall, for the ProSe Layer2 Group ID received in the TMGI\_MONITORING\_RESPONSE, stop the TMGI monitoring refresh timer T4104 if running and start the TMGI monitoring refresh timer T4104 with the received value. + +## 10.5.5 Abnormal cases + +### 10.5.5.1 Abnormal cases in the remote UE + +The following abnormal cases can be identified: + +- a) No response from the ProSe UE-to-network relay UE after the TMGI\_MONITORING\_REQUEST has been successfully delivered + +The remote UE shall retransmit the TMGI\_MONITORING\_REQUEST. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +- b) Indication from upper layers that the request to receive the MBMS content for a given TMGI is no longer in place after sending the TMGI\_MONITORING\_REQUEST, but before the TMGI monitoring request procedure is completed + +The remote UE shall discard the TMGI\_MONITORING\_RESPONSE received from the ProSe UE-to-network relay UE and then abort the procedure. + +## 10.6 Cell ID announcement request procedure + +### 10.6.1 General + +The purpose of the cell ID announcement request procedure is for the remote UE to obtain ECGI of the cell serving the ProSe UE-to-network relay. + +The remote UE in this procedure shall be a ProSe-enabled Public Safety UE and is authorised to act as a remote UE towards a ProSe UE-to-network relay UE based on the service authorisation procedure as specified in clause 5. The ProSe UE-to-network relay UE in this procedure shall be a ProSe-enabled Public Safety UE and is authorised to act as a ProSe UE-to-network relay UE based on the service authorisation procedure as specified in clause 5. + +### 10.6.2 Cell ID announcement request procedure initiation by the remote UE + +Before initiating the cell ID announcement request procedure, a direct link has been successfully established between the remote UE and the ProSe UE-to-network relay UE. + +The remote UE shall initiate a cell ID announcement request procedure: + +- a) when the remote UE is triggered by an upper layer application to report ECGI of the serving cell to the application server, but cannot receive the PC5\_DISCOVERY message for Relay Discovery Additional Information from the ProSe UE-to-network relay UE, or the ECGI is not included in the PC5\_DISCOVERY message for Relay Discovery Additional Information from the ProSe UE-to-network relay UE; or +- b) when the ECGI announcement request refresh timer T4106 expires and the remote UE still needs to obtain ECGI of the cell serving the ProSe UE-to-network relay. + +The remote UE shall generate a CELL\_ID\_ANNOUNCEMENT\_REQUEST message and pass this message to the lower layers for transmission along with the remote UE's Layer 2 ID (for unicast communication) and the ProSe UE-to-network relay UE's Layer 2 ID (for unicast communication). + +![Sequence diagram of the Cell ID announcement request procedure between a remote UE and a ProSe UE-to-network relay UE.](1520ac6ca40d678c53dca4ef6550963f_img.jpg) + +The diagram illustrates the message exchange between a remote UE and a ProSe UE-to-network relay UE. The remote UE sends a CELL\_ID\_ANNOUNCEMENT\_REQUEST message to the ProSe UE-to-network relay UE. Upon receiving this message, the ProSe UE-to-network relay UE starts timer T4107 and responds with a CELL\_ID\_ANNOUNCEMENT\_RESPONSE message. The remote UE starts timer T4106 upon sending the request message. + +``` +sequenceDiagram + participant remote UE + participant ProSe UE-to-network relay UE + Note left of remote UE: Start T4106 + remote UE->>ProSe UE-to-network relay UE: CELL_ID_ANNOUNCEMENT_REQUEST + Note right of ProSe UE-to-network relay UE: Start T4107 + ProSe UE-to-network relay UE-->>remote UE: CELL_ID_ANNOUNCEMENT_RESPONSE +``` + +Sequence diagram of the Cell ID announcement request procedure between a remote UE and a ProSe UE-to-network relay UE. + +Figure 10.6.2.1: Cell ID announcement request procedure + +### 10.6.3 Cell ID announcement request procedure accepted by the ProSe UE-to-network relay UE + +Upon receiving a CELL\_ID\_ANNOUNCEMENT\_REQUEST message, the ProSe UE-to-network relay UE shall allocate an ECGI announcement request refresh timer T4106 to the remote UE, and start a timer T4107. The timer T4107 shall be longer than the ECGI announcement request refresh timer T4106. + +Then the ProSe UE-to-network relay UE shall respond a CELL\_ID\_ANNOUNCEMENT\_RESPONSE message with a ECGI announcement request refresh timer T4106 IE set to the T4106 timer value assigned by the ProSe UE-to-network relay UE. + +### 10.6.4 Cell ID announcement request procedure completion by the remote UE + +Upon receiving a CELL\_ID\_ANNOUNCEMENT\_RESPONSE message, the UE shall start the ECGI announcement request refresh timer T4106 with the received value. + +## 10.6.5 Abnormal cases + +### 10.6.5.1 Abnormal cases in the remote UE + +If there is no response from the ProSe UE-to-network relay UE after the CELL\_ID\_ANNOUNCEMENT\_REQUEST message has been successfully delivered, the remote UE shall retransmit the CELL\_ID\_ANNOUNCEMENT\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +## 10.7 Remote UE information request procedure + +### 10.7.1 General + +The purpose of the remote UE information request procedure is for the serving ProSe UE-to-network relay UE to obtain the information from the remote UE served by the relay. This procedure can only be initiated by the ProSe UE-to-network relay UE, over an established link between the remote UE and the ProSe UE-to-network relay UE. + +### 10.7.2 Remote UE information request procedure initiation by the ProSe UE-to-network relay UE + +Before initiating the remote UE information request procedure, a direct link has been successfully established between the remote UE and the ProSe UE-to-network relay UE. + +The ProSe UE-to-network relay UE shall generate a REMOTE\_UE\_INFO\_REQUEST message containing the Remote UE Information Type IE set to the requested type of information as specified in subclause 11.4.18, and pass this message to the lower layers for transmission along with the remote UE's Layer 2 ID for unicast communication (i.e., ProSe UE ID) and the ProSe UE-to-network relay UE's Layer 2 ID for unicast communication (i.e., ProSe Relay UE ID). + +![Diagram showing the Remote UE information request procedure. A long arrow points from left to right above a long arrow pointing from right to left.](d6aa7052e7b36f8813f32684ac477305_img.jpg) + +The diagram consists of two horizontal arrows. The top arrow is a long line with a small arrowhead pointing to the right. The bottom arrow is a long line with a small arrowhead pointing to the left. This visualizes a request-response exchange between two entities, with the request going from left to right and the response coming from right to left. + +Diagram showing the Remote UE information request procedure. A long arrow points from left to right above a long arrow pointing from right to left. + +Figure 10.7.2.1: Remote UE information request procedure + +### 10.7.3 Remote UE information request accepted by the remote UE + +Upon receiving a REMOTE\_UE\_INFO\_REQUEST message, the remote UE shall include the requested type of information in a REMOTE\_UE\_INFO\_RESPONSE message, as specified in subclause 11.4.19. + +### 10.7.4 Remote UE information request procedure completion by the ProSe UE-to-network relay UE + +Upon receiving a REMOTE\_UE\_INFO\_RESPONSE message, the ProSe UE-to-network relay UE shall store the information provided by the remote UE temporarily so that the remote UE identity can be reported to the MME, as specified in 3GPP TS 24.301 [11]. + +NOTE: After the ProSe UE-to-network relay UE reports the information of the remote UE to the MME, the stored remote UE information is deleted. + +### 10.7.5 Abnormal cases + +#### 10.7.5.1 Abnormal cases in the ProSe UE-to-network relay UE + +If there is no response from the remote UE after the REMOTE\_UE\_INFO\_REQUEST message has been successfully delivered, the ProSe UE-to-network relay UE shall retransmit the REMOTE\_UE\_INFO\_REQUEST message. + +NOTE: The timer to trigger retransmission and the maximum number of allowed retransmissions are UE implementation specific. + +## 10.8 Non-IP data transport procedure + +### 10.8.1 General + +The purpose of the non-IP data transport procedure is to transport, from the upper layers of a sending UE to the upper layers of the receiving UE, the following information over the PC5 interface: + +- non-IP data; and +- non-IP type. + +### 10.8.2 Non-IP data transmission over PC5 + +Upon a request from upper layers to send a non-IP data of a non-IP type, the UE shall create a non-IP data PDU, shall set the non-IP payload field of the non-IP data PDU to the non-IP data provided by upper layers, and shall set the non-IP type field of the non-IP data PDU to the non-IP type provided by upper layers, as specified in subclause 11.5. The UE shall then pass the non-IP data PDU to the lower layers for transmission. + +### 10.8.3 Non-IP data reception over PC5 + +Upon receiving a non-IP data PDU from the lower layers, the UE shall either: + +- check the non-IP type field in the non-IP data PDU and provide the non-IP data in the non-IP payload field of the non-IP data PDU to the corresponding upper layer entity; or +- provide the upper layers with the non-IP data in the non-IP payload field of the non-IP data PDU and with the non-IP type in the non-IP type field of the non-IP data PDU. + +--- + +## 10A ProSe direct discovery for public safety use + +### 10A.1 Overview + +This clause describes the procedures for ProSe direct discovery for public safety use at a ProSe-enabled public safety UE over the PC5 reference point. + +## 10A.2 Procedures + +### 10A.2.1 General + +The following procedures are defined for the ProSe direct discovery for public safety use: + +- announcing UE procedure for UE-to-network relay discovery; +- monitoring UE procedure for UE-to-network relay discovery; +- discoverer UE procedure for UE-to-network relay discovery; +- discoveree UE procedure for UE-to-network relay discovery; +- announcing UE procedure for group member discovery; +- monitoring UE procedure for group member discovery; +- discoverer UE procedure for group member discovery; +- discoveree UE procedure for group member discovery; +- announcing UE procedure for UE-to-network relay discovery additional information; and +- monitoring UE procedure for UE-to-network relay discovery additional information; + +Each ProSe-enabled Public Safety UE needs to obtain the security parameters from the ProSe Key Management Function before participating in ProSe direct discovery for public safety use, as specified in 3GPP TS 33.303 [6]. For each given Relay Service Code in UE-to-network relay discovery or Discovery Group ID in group member discovery, the ProSe Key Management Function (PKMF) will provide the following in the security parameters: + +- PSDK (Public Safety Discovery Key) and the associated Expiry Time for this PSDK; +- configurations to signal which combination of keys to be used for the discovery process; and +- optionally, if DUCK is to be used, an indication of which PC5\_DISCOVERY message fields shall be protected by the DUCK. + +After receiving the PSDK from the PKMF for the relay service or discovery group, the UE shall use it to derive specific DUIK, DUCK and DUSK needed to protect the ProSe direct discovery messages for the corresponding public safety use, as specified in 3GPP TS 33.303 [6]. + +### 10A.2.1A Radio resource selection + +The UE shall select the radio resource parameters to be used for ProSe direct discovery as follows: + +- when the UE is served by E-UTRAN and intends to use the ProSe radio resources (i.e. carrier frequency) obtained from the serving cell, + - 1) the UE shall use the radio resource parameters indicated by the serving cell (same or different from that of the serving cell) as specified in 3GPP TS 36.331 [12], if the corresponding PLMN is authorised for ProSe direct discovery; and + - 2) according to the radio resources (i.e. carrier frequency) along with PLMN ID which the serving cell indicates as allowed for ProSe direct discovery as defined in 3GPP TS 36.331 [12], if the UE intends to use one of the radio resources not operated by the serving cell for ProSe direct discovery and the corresponding PLMN is authorised for ProSe direct discovery, the UE shall search for a cell with the indicated PLMN operating the indicated radio resources as defined in 3GPP TS 36.331 [12] and 3GPP TS 36.304 [23], and obtain the radio resource parameters for ProSe direct discovery from that cell, without performing PLMN selection; and +- when the UE is not served by E-UTRAN or when the UE is served by E-UTRAN and intends to use the provisioned ProSe radio resources (i.e. carrier frequency): + +- 1) if the UE can determine itself located in a geographical area, and the UE is provisioned with radio parameters for the geographical area, then the UE shall search for a cell with any PLMN operating the selected provisioned radio resources (i.e. carrier frequency) associated with that geographical area, and: + +NOTE: It is out of scope of the present specification to define how the UE can locate itself in a specific geographical area. When the UE is in coverage of a 3GPP RAT it can for example use information derived from the serving PLMN. When the UE is not in coverage of a 3GPP RAT it can use other techniques as determined by local regulations. + +- i) if the UE finds such a cell belonging to a PLMN in which the UE is authorised for ProSe direct discovery and the cell provides radio resource parameters for ProSe direct discovery, then the UE shall use the indicated radio resource parameters for ProSe direct discovery; + - ii) if the UE finds such a cell but not in a PLMN authorised for ProSe direct discovery, then the UE shall not use the ProSe direct discovery in that carrier frequency; or + - iii) if the UE does not find any such cell in any PLMN, then the UE shall use the provisioned radio resource parameters; or +- 2) else the UE shall not initiate ProSe direct discovery. + +If the UE is performing ProSe direct discovery using radio resource parameters associated with a geographical area and moves out of that geographical area, the UE shall perform ProSe direct discovery using new radio resource parameters selected for ProSe direct discovery as described in this subclause. + +## 10A.2.2 Announcing UE procedure for UE-to-network relay discovery + +### 10A.2.2.1 General + +The purpose of the announcing UE procedure for UE-to-network relay discovery is: + +- to enable a ProSe-enabled public safety UE to announce availability of a connectivity service provided by a UE-to-network relay of the ProSe-enabled public safety UE to other ProSe-enabled public safety UEs, upon a request from upper layers as defined in 3GPP TS 23.303 [2]; or +- to enable a ProSe-enabled public safety UE to measure the PC5\_DISCOVERY message signal strength between the ProSe-enabled public safety UE and the ProSe UE-to-network relay UE(s) for relay selection/reselection. + +### 10A.2.2.2 Announcing UE procedure for UE-to-network relay discovery initiation + +The UE is authorised to perform the announcing UE procedure for UE-to-network relay discovery if: + +- a) the UE is authorised to act as a UE-to-network relay in the PLMN indicated by the serving cell as specified in clause 5, and + - the UE is served by E-UTRAN and the UE is authorised to perform ProSe direct discovery for public safety use announcing in the PLMN as specified in clause 5, and the lower layers indicate that discovery operation of a UE-to-network relay is supported; or + - the UE is authorised to perform ProSe direct discovery for public safety use announcing when not served by E-UTRAN as specified in clause 5 and intends to use the provisioned radio resources for UE-to-network relay discovery; and +- b) the UE is configured with the Relay Service Code parameter identifying the connectivity service to be announced and with the User Info ID for the UE-to-network relay discovery parameter, as specified in clause 5; + +otherwise the UE is not authorised to perform the announcing UE procedure for UE-to-network relay discovery. + +Figure 10A.2.2.2.1 illustrates the interaction of the UEs in the announcing UE procedure for UE-to-network relay discovery. + +![Diagram showing the UE sending a PC5_DISCOVERY message for UE-to-Network Relay Discovery Announcement to other UEs.](92724c769da9d46b730fde1a6dccb023_img.jpg) + +The diagram illustrates the initial step of the announcing UE procedure. It shows a 'UE' on the left and 'other UEs' on the right. A horizontal arrow points from the 'UE' to the 'other UEs', with the text 'PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement' centered above it. + +Diagram showing the UE sending a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement to other UEs. + +**Figure 10A.2.2.2.1: Announcing UE procedure for UE-to-network relay discovery** + +When the UE is triggered by an upper layer application to announce availability of a connectivity service provided by a UE-to-network relay, if the UE is authorised to perform the announcing UE procedure for UE-to-network relay discovery, then the UE: + +- a) if the UE is served by E-UTRAN, and the UE in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages for relay discovery for public safety as specified in 3GPP TS 36.331 [12], shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; +- b) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- c) shall generate a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement, the UE: + - 1) shall set the ProSe Relay UE ID to a ProSe Relay UE ID used for ProSe direct communication for the connectivity service to be announced; + - 2) shall set the Announcer Info parameter to the User Info ID for the UE-to-network relay discovery parameter, configured in clause 5; + - 3) shall set the Relay Service Code parameter to the Relay Service Code parameter identifying the connectivity service to be announced, configured in clause 5; + - 4) shall set the UTC-based counter LSB parameter to include the eight least significant bits of the UTC-based counter; and + - 5) shall set the Resource Status Indicator bit of the Status Indicator parameter to indicate whether or not the UE has resources available to provide a connectivity service for additional ProSe-enabled public safety UEs; +- d) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g. integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- e) shall pass the resulting PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement to the lower layers for transmission over the PC5 interface with an indication that the message is for relay discovery for public safety use. + +The UE shall ensure that it keeps on passing the same PC5\_DISCOVERY message and the indication that the message is for relay discovery for public safety use to the lower layers for transmission until the UE is triggered by an upper layer application to stop announcing availability of a connectivity service provided by a UE-to-network relay, or until the UE stops being authorised to perform the announcing UE procedure for UE-to-network relay discovery. How this is achieved is left up to UE implementation. + +### 10A.2.2.3 Announcing UE procedure for UE-to-network relay discovery completion + +When the UE is triggered by an upper layer application to stop announcing availability of a connectivity service provided by a UE-to-network relay, or when the UE stops being authorised to perform the announcing UE procedure for UE-to-network relay discovery, the UE shall instruct the lower layers to stop announcing. + +When the UE stops announcing, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.3 Monitoring UE procedure for UE-to-network relay discovery + +### 10A.2.3.1 General + +The purpose of the monitoring UE procedure for UE-to-network relay discovery is: + +- to enable a ProSe-enabled public safety UE to become aware of proximity of a connectivity service provided by a UE-to-network relay, upon a request from upper layers as defined in 3GPP TS 23.303 [2]; or +- to enable a ProSe-enabled public safety UE to perform measurements of signal strength of PC5\_DISCOVERY messages from ProSe UE-to-network relay UE(s) for relay selection/reselection. + +### 10A.2.3.2 Monitoring UE procedure for UE-to-network relay discovery initiation + +The UE is authorised to perform the monitoring UE procedure for UE-to-network relay discovery if: + +- a) the following is true: + - 1) the UE is not served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use monitoring when the UE is not served by E-UTRAN as specified in clause 5, is authorised to act as a remote UE towards a UE-to-network relay as specified in clause 5 and is configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; + - 2) the UE is served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use monitoring in at least one PLMN as specified in clause 5, is authorised to act as a remote UE towards a UE-to-network relay, and the lower layers indicate that discovery operation of a UE-to-network relay is supported; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]; and + - authorised to perform ProSe direct discovery for public safety use monitoring when the UE is not served by E-UTRAN as specified in clause 5, authorised to act as a remote UE towards a UE-to-network relay as specified in clause 5, and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + - ii) the lower layers indicate that discovery operation of a UE-to-network relay is supported; and: + +NOTE 1: When the lower layers indicate that discovery operation of a UE-to-network relay is supported, the serving cell broadcasts a common radio resources pool for public safety discovery reception and the UE can use this common radio resources pool while in limited service state. + +- b) the UE is configured with the Relay Service Code parameter identifying the connectivity service to be monitored and with the IP version(s) to be used for the traffic of the connectivity service to be monitored, as specified in clause 5; + +otherwise the UE is not authorised to perform the monitoring UE procedure for UE-to-network relay discovery. + +Figure 10A.2.3.2.1 illustrates the interaction of the UEs in the monitoring UE procedure for UE-to-network relay discovery. + +![Diagram illustrating the monitoring UE procedure for UE-to-network relay discovery. A UE on the left receives a PC5_DISCOVERY message for UE-to-Network Relay Discovery Announcement from other UEs on the right, indicated by a left-pointing arrow.](5635bd67a8ba929382fd61dede8952c7_img.jpg) + +UE other UEs + +PC5\_DISCOVERY message +for UE-to-Network Relay Discovery Announcement + +←────────────────────────────────────────────────────────── + +Diagram illustrating the monitoring UE procedure for UE-to-network relay discovery. A UE on the left receives a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement from other UEs on the right, indicated by a left-pointing arrow. + +**Figure 10A.2.3.2.1: Monitoring UE procedure for UE-to-network relay discovery** + +When the UE is triggered by an upper layer application to monitor proximity of a connectivity service provided by a UE-to-network relay; or when the UE has established a direct link with a ProSe UE-to-network relay UE as specified in subclause 10.4.2, and if the UE is authorised to perform the monitoring UE procedure for UE-to-network relay discovery, then the UE shall instruct the lower layers to start monitoring for PC5\_DISCOVERY messages with an indication that the message is for relay discovery for public safety use. + +Upon reception of a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement according to subclause 11.2.5.1, for the target Relay Service Code of the connectivity service which the UE is authorized to monitor, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the monitoring operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality-protected portion, as described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and the UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement. + +NOTE 2: The use of an erroneous UTC-based counter for processing the received PC5\_DISCOVERY messages at the ProSe-enabled Public Safety UE can cause MIC check failure after DUIK is used for integrity check, and malformed contents after DUSK is used for unscrambling or DUCK is used for deciphering. How a ProSe-enabled Public Safety UE ensures the accuracy of the UTC-based counter is left to UE implementation. + +Then if: + +- the Relay Service Code parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement is the same as the Relay Service Code parameter configured as specified in clause 5 for the connectivity service being monitored; and +- the User Info ID of the UE-to-network relay is not configured as specified in clause 5 for the connectivity service being monitored, or the Announcer Info parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement is the same as the User Info ID of the UE-to-network relay configured as specified in clause 5 for the connectivity service being monitored; + +then the UE shall consider that the connectivity service the UE seeks to monitor has been discovered. In addition, the UE can measure the signal strength of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement for relay selection or reselection. + +### 10A.2.3.3 Monitoring UE procedure for UE-to-network relay discovery completion + +When the UE is triggered by an upper layer application to stop monitoring proximity of a connectivity service provided by a UE-to-network relay, or when the UE stops being authorised to perform the monitoring UE procedure for UE-to-network relay discovery, the UE shall instruct the lower layers to stop monitoring. + +When the UE stops monitoring, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.4 Discoverer UE procedure for UE-to-network relay discovery + +### 10A.2.4.1 General + +The purpose of the discoverer UE procedure for UE-to-network relay discovery is: + +- to enable a ProSe-enabled public safety UE to solicit proximity of a connectivity service provided by a UE-to-network relay, upon a request from upper layers as defined in 3GPP TS 23.303 [2]; or +- to enable a ProSe-enabled public safety UE to measure the PC5\_DISCOVERY message signal strength between the ProSe-enabled public safety UE and the ProSe UE-to-network relay UE(s) for relay selection/reselection. + +### 10A.2.4.2 Discoverer UE procedure for UE-to-network relay discovery initiation + +The UE is authorised to perform the discoverer UE procedure for UE-to-network relay discovery if: + +- a) the following is true: + - 1) the UE is not served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use discoverer operation when the UE is not served by E-UTRAN as specified in clause 5, is authorised to act as a remote UE towards a UE-to-network relay as specified in clause 5 and is configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; + - 2) the UE is served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use discoverer operation in the PLMN indicated by the serving cell as specified in clause 5, is authorised to act as a remote UE towards a UE-to-network relay, and the lower layers indicate that discovery operation of a UE-to-network relay is supported; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]; and + - authorised to perform ProSe direct discovery for public safety use discoverer operation when the UE is not served by E-UTRAN as specified in clause 5, authorised to act as a remote UE towards a UE-to-network relay as specified in clause 5, and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + +- ii) the lower layers indicate that discovery operation of a UE-to-network relay is supported and that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12]; and + +NOTE 1: When the lower layers indicate that discovery operation of a UE-to-network relay is supported and that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], the serving cell broadcasts a common radio resources pool for public safety discovery transmission and the UE can use this common radio resources pool while in limited service state. + +- b) the UE is configured with the Relay Service Code parameter identifying the connectivity service to be solicited and with the User Info ID for the UE-to-network relay discovery parameter, as specified in clause 5; + +otherwise the UE is not authorised to perform the Discoverer UE procedure for UE-to-network relay discovery. + +Figure 10A.2.4.2.1 illustrates the interaction of the UEs in the Discoverer UE procedure for UE-to-network relay discovery. + +![Sequence diagram illustrating the Discoverer UE procedure for UE-to-network relay discovery. The diagram shows two horizontal timelines: 'UE' on the left and 'other UEs' on the right. 1. On the 'UE' timeline, a box labeled 'Start T4109' is shown. An arrow points from this box to the 'other UEs' timeline, labeled 'PC5_DISCOVERY message for UE-to-Network Relay Discovery Solicitation'. 2. On the 'other UEs' timeline, an arrow points from the 'other UEs' timeline back to the 'UE' timeline, labeled 'PC5_DISCOVERY message for UE-to-Network Relay Discovery Response'. 3. On the 'UE' timeline, a box labeled 'Stop T4109' and 'Start T4110' is shown, which receives the response arrow.](22a1092afae18f2567536ff8b0bbcdd5_img.jpg) + +Sequence diagram illustrating the Discoverer UE procedure for UE-to-network relay discovery. The diagram shows two horizontal timelines: 'UE' on the left and 'other UEs' on the right. 1. On the 'UE' timeline, a box labeled 'Start T4109' is shown. An arrow points from this box to the 'other UEs' timeline, labeled 'PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation'. 2. On the 'other UEs' timeline, an arrow points from the 'other UEs' timeline back to the 'UE' timeline, labeled 'PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response'. 3. On the 'UE' timeline, a box labeled 'Stop T4109' and 'Start T4110' is shown, which receives the response arrow. + +**Figure 10A.2.4.2.1: Discoverer UE procedure for UE-to-network relay discovery** + +For PC5\_DISCOVERY message signal strength measurement, the UE manages a periodic measurement timer T4110, which is used to trigger the periodic PC5\_DISCOVERY message signal strength measurement between the UE and the ProSe UE-to-network relay UE with which the UE has a link established. It is started whenever the UE has established a direct link with a ProSe UE-to-network relay UE as specified in subclause 10.4.2 and restarted whenever the UE receives the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response from the ProSe UE-to-network relay UE with which the UE has a link established. + +When the UE is triggered by an upper layer application to solicit proximity of a connectivity service provided by a UE-to-network relay, or when the periodic measurement timer T4110 expires, and if the UE is authorised to perform the discoverer UE procedure for UE-to-network relay discovery, then the UE: + +- a) if the UE is served by E-UTRAN, and the UE in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages for relay discovery for public safety as specified in 3GPP TS 36.331 [12], shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; +- b) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- c) shall generate a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation, the UE: + - 1) shall set the Discoverer Info parameter to the User Info ID for the UE-to-network relay discovery parameter, configured in clause 5; + - 2) shall set the Relay Service Code parameter to the Relay Service Code parameter identifying the connectivity service to be solicited, configured in clause 5; + +- 3) if the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation is used to trigger the signal strength measurement for the PC5\_DISCOVERY message from a specific ProSe UE-to-network relay UE with which the UE has a link established, shall set the ProSe Relay UE ID parameter to the ProSe Relay UE ID of that ProSe UE-to-network relay UE; and +- 4) shall set the UTC-based counter LSB parameter to include the four least significant bits of the UTC-based counter; +- d) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g. integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- e) shall pass the resulting PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation to the lower layers for transmission over the PC5 interface with an indication that the message is for relay discovery for public safety use. + +If the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation is used to solicit proximity of a connectivity service provided by a UE-to-network relay, the UE shall ensure that it keeps on passing the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation and the indication that the message is for relay discovery for public safety use to the lower layers for transmission until the UE is triggered by an upper layer application to stop soliciting proximity of a connectivity service provided by a UE-to-network relay, or until the UE stops being authorised to perform the discoverer UE procedure for UE-to-network relay discovery. How this is achieved is left up to UE implementation. + +If the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation is used to trigger the PC5\_DISCOVERY message signal strength measurement between the UE and the ProSe UE-to-network relay UE with which the UE has a link established, the UE shall start the retransmission timer T4109. If retransmission timer T4109 expires, the UE shall retransmit the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation and restart timer T4109. If no response is received from the ProSe UE-to-network relay UE with which the UE has a link established after reaching the maximum number of allowed retransmissions, the UE shall trigger relay reselection procedure. + +NOTE 2: The maximum number of allowed retransmissions is UE implementation specific. + +Upon reception of a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response according to subclause 11.2.5.1, for the target Relay Service Code of the connectivity service which the UE is authorized to discover, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the reception operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality-protected portion, as described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and the UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response. + +Then if: + +- the Relay Service Code parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response is the same as the Relay Service Code parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation; and +- the User Info ID of the UE-to-network relay is not configured as specified in clause 5 for the connectivity service being solicited, or the Discoverer Info parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response is the same as the User Info ID of the UE-to-network relay configured as specified in clause 5 for the connectivity service being solicited; + +then the UE shall consider that the connectivity service the UE seeks to discover has been discovered. In addition, the UE can measure the signal strength of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response for relay selection or reselection. If the UE has received the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response from the ProSe UE-to-network relay UE with which the UE has a link established, the UE shall stop the retransmission timer T4109, and start the periodic measurement timer T4110. + +### 10A.2.4.3 Discoverer UE procedure for UE-to-network relay discovery completion + +When the UE is triggered by an upper layer application to stop soliciting for proximity of a connectivity service provided by a UE-to-network relay, or when the UE stops being authorised to perform the Discoverer UE procedure for UE-to-network relay discovery, the UE shall instruct the lower layers to stop the discoverer operation. + +When the UE stops discoverer operation, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.5 Discoveree UE procedure for UE-to-network relay discovery + +### 10A.2.5.1 General + +The purpose of the discoveree UE procedure for UE-to-network relay discovery is to enable a ProSe-enabled public safety UE with a UE-to-network relay to respond to solicitation from other ProSe-enabled public safety UEs on proximity of a connectivity service provided by the UE-to-network relay, upon a request from upper layers as defined in 3GPP TS 23.303 [2]. + +### 10A.2.5.2 Discoveree UE procedure for UE-to-network relay discovery initiation + +The UE is authorised to perform the discoveree UE procedure for UE-to-network relay discovery if: + +- a) the UE is authorised to act as a UE-to-network relay in the PLMN indicated by the serving cell as specified in clause 5, and + - the UE is served by E-UTRAN and the UE is authorised to perform ProSe direct discovery for public safety use discoveree operation in the PLMN as specified in clause 5, and the lower layers indicate that discovery operation of a UE-to-network relay is supported; or- the UE is authorised to perform ProSe direct discovery for public safety use discoveree operation when not served by E-UTRAN as specified in clause 5 and intends to use the provisioned radio resources for UE-to-network relay discovery; and +- b) the UE is configured with the Relay Service Code parameter identifying the connectivity service to be responded to and with the User Info ID for the UE-to-network relay discovery parameter, as specified in clause 5; + +otherwise the UE is not authorised to perform the discoveree UE procedure for UE-to-network relay discovery. + +Figure 10A.2.5.2.1 illustrates the interaction of the UEs in the discoveree UE procedure for UE-to-network relay discovery. + +![Sequence diagram illustrating the Discoveree UE procedure for UE-to-network relay discovery. A UE sends a PC5_DISCOVERY message for UE-to-Network Relay Discovery Solicitation to other UEs. The other UEs respond with a PC5_DISCOVERY message for UE-to-Network Relay Discovery Response.](a00c2ce2bca7f7c0d7a597c7e199db9a_img.jpg) + +``` +sequenceDiagram + participant UE + participant other_UEs as other UEs + Note right of other_UEs: PC5_DISCOVERY message +for UE-to-Network Relay Discovery Solicitation + other_UEs->>UE: + Note left of UE: PC5_DISCOVERY message +for UE-to-Network Relay Discovery Response + UE->>other_UEs: +``` + +Sequence diagram illustrating the Discoveree UE procedure for UE-to-network relay discovery. A UE sends a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation to other UEs. The other UEs respond with a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response. + +**Figure 10A.2.5.2.1: Discoveree UE procedure for UE-to-network relay discovery** + +When the UE is triggered by an upper layer application to start responding to solicitation on proximity of a connectivity service provided by the UE-to-network relay, and if the UE is authorised to perform the discoveree UE procedure for UE-to-network relay discovery, then the UE: + +- a) if the UE is served by E-UTRAN, and the UE in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; and +- b) shall instruct the lower layers to start monitoring for PC5\_DISCOVERY messages with an indication that the message is for relay discovery for public safety use. + +Upon reception of a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation according to subclause 11.2.5.1, for the Relay Service Code of the connectivity service which the UE is authorized to respond, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the reception operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality-protected portion, as described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and the UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation. + +Then, if the Relay Service Code parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation is the same as the Relay Service Code parameter configured as specified in clause 5 for the connectivity service and either the ProSe Relay UE ID parameter is not included or the included ProSe Relay UE ID parameter is the same as the ProSe Relay UE ID associated with the Relay Service Code parameter configured as specified in clause 5, the UE: + +- a) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- b) shall generate a PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response, the UE: + - 1) shall set the ProSe Relay UE ID to a ProSe Relay UE ID used for ProSe direct communication for the connectivity service; + - 2) shall set the Discoveree Info parameter to the User Info ID for the UE-to-network relay discovery parameter, configured in clause 5; + - 3) shall set the Relay Service Code parameter to the Relay Service Code parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation; + - 4) shall set the UTC-based counter LSB parameter to include the eight least significant bits of the UTC-based counter; and + - 5) shall set the Resource Status Indicator bit of the Status Indicator parameter to indicate whether or not the UE has resources available to provide a connectivity service for additional ProSe-enabled public safety UEs; +- c) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g. integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- d) shall pass the resulting PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response with an indication that the message is for relay discovery for public safety use to the lower layers for transmission over the PC5 interface. + +### 10A.2.5.3 Discoveree UE procedure for UE-to-network relay discovery completion + +When the UE is triggered by an upper layer application to stop responding to solicitation on proximity of a connectivity service provided by a UE-to-network relay, or when the UE stops being authorised to perform the discoveree UE procedure for UE-to-network relay discovery, the UE shall instruct the lower layers to stop monitoring. + +When the UE stops monitoring, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.6 Announcing UE procedure for group member discovery + +### 10A.2.6.1 General + +The purpose of the announcing UE procedure for group member discovery is to enable a ProSe-enabled public safety UE to announce availability in a discovery group to other ProSe-enabled public safety UEs, upon a request from upper layers as defined in 3GPP TS 23.303 [2]. + +### 10A.2.6.2 Announcing UE procedure for group member discovery initiation + +The UE is authorised to perform the announcing UE procedure for group member discovery if: + +- a) the following is true: + - 1) the UE is not served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use announcing when the UE is not served by E-UTRAN as specified in clause 5, and is configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; + - 2) the UE is served by E-UTRAN, and is authorised to perform ProSe direct discovery for public safety use announcing in the PLMN indicated by the serving cell as specified in clause 5; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]; and + - authorised to perform ProSe direct discovery for public safety use announcing when the UE is not served by E-UTRAN as specified in clause 5 and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + - ii) the lower layers indicate that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12]; and +- b) the UE is configured with the Discovery Group ID parameter identifying the discovery group to be announced and with the User Info ID for the group member discovery parameter, as specified in clause 5; + +NOTE: When the lower layers indicate that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], the serving cell broadcasts a common radio resources pool for public safety discovery transmission and the UE can use this common radio resources pool while in limited service state. + +otherwise the UE is not authorised to perform the announcing UE procedure for group member discovery. + +Figure 10A.2.6.2.1 illustrates the interaction of the UEs in the announcing UE procedure for group member discovery. + +![Sequence diagram showing a PC5_DISCOVERY message for Group Member Discovery Announcement from a UE to other UEs.](f4e5a86da5c799372a7c1ea2397dedb7_img.jpg) + +``` + +sequenceDiagram + participant UE + participant other UEs + UE->>other UEs: PC5_DISCOVERY message +for Group Member Discovery Announcement + +``` + +Sequence diagram showing a PC5\_DISCOVERY message for Group Member Discovery Announcement from a UE to other UEs. + +**Figure 10A.2.6.2.1: Announcing UE procedure for group member discovery** + +When the UE is triggered by an upper layer application to announce availability in a discovery group, if the UE is authorised to perform the announcing UE procedure for group member discovery, then the UE: + +- a) if the UE is served by E-UTRAN, and the UE in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; +- b) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- c) shall generate a PC5\_DISCOVERY message for Group Member Discovery Announcement according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for Group Member Discovery Announcement, the UE: + - 1) shall set the ProSe UE ID to the Layer 2 ID used for unicast communication configured in clause 5; + - 2) shall set the Announcer Info parameter to the User Info ID for the group member discovery parameter, configured in clause 5; + - 3) shall set the Discovery Group ID parameter to the Discovery Group ID parameter identifying the discovery group to be announced, configured in clause 5; and + - 4) shall set the UTC-based counter LSB parameter to include the eight least significant bits of the UTC-based counter; +- d) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g., integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- e) shall pass the resulting PC5\_DISCOVERY message for Group Member Discovery Announcement to the lower layers for transmission over the PC5 interface with an indication that the message is for public safety use. + +The UE shall ensure that it keeps on passing the same PC5\_DISCOVERY message and the indication that the message is for public safety use to the lower layers for transmission until the UE is triggered by an upper layer application to stop announcing availability in a discovery group, or until the UE stops being authorised to perform the announcing UE procedure for group member discovery. How this is achieved is left up to UE implementation. + +### 10A.2.6.3 Announcing UE procedure for group member discovery completion + +When the UE is triggered by an upper layer application to stop announcing availability in a discovery group, or when the UE stops being authorised to perform the announcing UE procedure for group member discovery, the UE shall instruct the lower layers to stop announcing. + +When the UE stops announcing, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.7 Monitoring UE procedure for group member discovery + +### 10A.2.7.1 General + +The purpose of the monitoring UE procedure for group member discovery is to enable a ProSe-enabled public safety UE to become aware of proximity of other ProSe-enabled public safety UEs in a discovery group, upon a request from upper layers as defined in 3GPP TS 23.303 [2]. + +### 10A.2.7.2 Monitoring UE procedure for group member discovery initiation + +The UE is authorised to perform the monitoring UE procedure for group member discovery if: + +- a) the following is true: + - 1) the UE is not served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use monitoring when the UE is not served by E-UTRAN as specified in clause 5, and is configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; + - 2) the UE is served by E-UTRAN, and is authorised to perform ProSe direct discovery for public safety use monitoring in at least one PLMN as specified in clause 5; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]; and + - authorised to perform ProSe direct discovery for public safety use monitoring when the UE is not served by E-UTRAN as specified in clause 5, and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + - ii) the lower layers indicate that public safety discovery operation is supported; and: + +NOTE 1: When the lower layers indicate that public safety discovery operation is supported, the serving cell broadcasts a common radio resources pool for public safety discovery reception and the UE can use this common radio resources pool while in limited service state. + +- b) the UE is configured with the Discovery Group ID parameter identifying the discovery group to be monitored, as specified in clause 5; + +otherwise the UE is not authorised to perform the monitoring UE procedure for group member discovery. + +Figure 10A.2.7.2.1 illustrates the interaction of the UEs in the monitoring UE procedure for group member discovery. + +![Diagram showing a PC5_DISCOVERY message being sent from other UEs to a UE.](61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg) + +UE +other UEs +PC5\_DISCOVERY message +for Group Member Discovery Announcement + +``` + +sequenceDiagram + participant OtherUEs as other UEs + participant UE as UE + OtherUEs->>UE: PC5_DISCOVERY message (for Group Member Discovery Announcement) + +``` + +Diagram showing a PC5\_DISCOVERY message being sent from other UEs to a UE. + +**Figure 10A.2.7.2.1: Monitoring UE procedure for group member discovery;** + +When the UE is triggered by an upper layer application to monitor proximity of other UEs in a discovery group, and if the UE is authorised to perform the monitoring UE procedure for group member discovery, then the UE shall instruct the lower layers to start monitoring for PC5\_DISCOVERY messages with an indication that the message is for public safety use. + +Upon reception of a PC5\_DISCOVERY message for Group Member Discovery Announcement according to subclause 11.2.5.1, for the target Discovery Group ID of the discovery group to be monitored, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the monitoring operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality-protected portion, as described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for Group Member Discovery Announcement. + +NOTE 2: The use of an erroneous UTC-based counter for processing received PC5\_DISCOVERY messages at the ProSe-enabled Public Safety UE can cause MIC check failure after DUIK is used for integrity check, and malformed contents after DUSK is used for unscrambling or DUCK is used for deciphering. How a ProSe-enabled Public Safety UE ensures the accuracy of the UTC-based counter is left to UE implementation. + +Then if the Discovery Group ID parameter of the PC5\_DISCOVERY message for Group Member Discovery Announcement is the same as the configured Discovery Group ID parameter as specified in clause 5, the UE shall consider that other UE in the discovery group the UE seeks to monitor has been discovered. + +### 10A.2.7.3 Monitoring UE procedure for group member discovery completion + +When the UE is triggered by an upper layer application to stop monitoring proximity of other UEs in a discovery group, or when the UE stops being authorised to perform the monitoring UE procedure for group member discovery, the UE shall instruct the lower layers to stop monitoring. + +When the UE stops monitoring, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +### 10A.2.8 Discoverer UE procedure for group member discovery + +### 10A.2.8.1 General + +The purpose of the discoverer UE procedure for group member discovery is to enable a ProSe-enabled public safety UE to solicit proximity of other ProSe-enabled public safety UEs in a discovery group, upon a request from upper layers as defined in 3GPP TS 23.303 [2]. + +### 10A.2.8.2 Discoverer UE procedure for group member discovery initiation + +The UE is authorised to perform the discoverer UE procedure for group member discovery if: + +- a) the following is true: + - 1) the UE is not served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use discoverer operation when the UE is not served by E-UTRAN as specified in clause 5, and is configured with + +the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; + +- 2) the UE is served by E-UTRAN, and is authorised to perform ProSe direct discovery for public safety use discoverer operation in the PLMN indicated by the serving cell as specified in clause 5; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]; and + - authorised to perform ProSe direct discovery for public safety use discoverer operation when the UE is not served by E-UTRAN as specified in clause 5, and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + - ii) the lower layers indicate that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12]; and: +- NOTE: When the lower layers indicate that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], the serving cell broadcasts a common radio resources pool for public safety discovery transmission and the UE can use this common radio resources pool while in limited service state. +- b) the UE is configured with the Discovery Group ID parameter identifying the discovery group to be solicited and with the User Info ID for the group member discovery parameter, as specified in clause 5; + +otherwise the UE is not authorised to perform the discoverer UE procedure for group member discovery. + +Figure 10A.2.8.2.1 illustrates the interaction of the UEs in the discoverer UE procedure for group member discovery. + +![Sequence diagram showing the Discoverer UE procedure for group member discovery. A UE sends a PC5_DISCOVERY message for Group Member Discovery Solicitation to other UEs, and other UEs respond with a PC5_DISCOVERY message for Group Member Discovery Response.](710ff83dc4a77abbe489fbf1a462845a_img.jpg) + +``` +sequenceDiagram + participant UE + participant other_UEs as other UEs + Note right of UE: PC5_DISCOVERY message +for Group Member Discovery Solicitation + UE->>other_UEs: PC5_DISCOVERY message + Note left of other_UEs: PC5_DISCOVERY message +for Group Member Discovery Response + other_UEs-->>UE: PC5_DISCOVERY message +``` + +Sequence diagram showing the Discoverer UE procedure for group member discovery. A UE sends a PC5\_DISCOVERY message for Group Member Discovery Solicitation to other UEs, and other UEs respond with a PC5\_DISCOVERY message for Group Member Discovery Response. + +**Figure 10A.2.8.2.1: Discoverer UE procedure for group member discovery** + +When the UE is triggered by an upper layer application to solicit proximity of other UEs in a discovery group, and if the UE is authorised to perform the discoverer UE procedure for group member discovery, then the UE: + +- a) if the UE is served by E-UTRAN, and the UE in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; +- b) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- c) shall generate a PC5\_DISCOVERY message for Group Member Discovery Solicitation according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for Group Member Discovery Solicitation, the UE: + - 1) shall set the Discoverer Info parameter to the User Info ID for the group member discovery parameter, configured in clause 5; + - 2) shall set the Discovery Group ID parameter to the Discovery Group ID parameter identifying the discovery group to be solicited, configured in clause 5; + - 3) shall set either the Target User Info parameter or the Target Group Info parameter according to the target information provided by the upper layer application; and + - 4) shall set the UTC-based counter LSB parameter to include the eight least significant bits of the UTC-based counter; +- d) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g. integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- e) shall pass the resulting PC5\_DISCOVERY message for Group Member Discovery Solicitation to the lower layers for transmission over the PC5 interface with an indication that the message is for public safety use. + +The UE shall ensure that it keeps on passing the same PC5\_DISCOVERY message to the lower layers for transmission with an indication that the message is for public safety use until the UE is triggered by an upper layer application to stop soliciting proximity of other UEs in a discovery group, or until the UE stops being authorised to perform the discoverer UE procedure for group member discovery. How this is achieved is left up to UE implementation. + +Upon reception of a PC5\_DISCOVERY message for Group Member Discovery Response according to subclause 11.2.5.1, for the target Discovery Group ID of the discovery group to be discovered, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the monitoring operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality-protected portion, as + +described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for Group Member Discovery Response. + +Then if the Discovery Group ID parameter of the PC5\_DISCOVERY message for Group Member Discovery Response is the same as the Discovery Group ID parameter of the PC5\_DISCOVERY message for Group Member Discovery Solicitation, the UE shall consider that other UE in the discovery group the UE seeks to discover has been discovered. + +### 10A.2.8.3 Discoverer UE procedure for group member discovery completion + +When the UE is triggered by an upper layer application to stop soliciting proximity of other UEs in a discovery group, or when the UE stops being authorised to perform the discoverer UE procedure for group member discovery, the UE shall instruct the lower layers to stop discoverer operation. + +When the UE stops discoverer operation, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.9 Discoveree UE procedure for group member discovery + +### 10A.2.9.1 General + +The purpose of the discoveree UE procedure for group member discovery is to enable a ProSe-enabled public safety UE to respond to solicitation from other ProSe-enabled public safety UEs on proximity in a discovery group, upon a request from upper layers as defined in 3GPP TS 23.303 [2]. + +### 10A.2.9.2 Discoveree UE procedure for group member discovery initiation + +The UE is authorised to perform the discoveree UE procedure for group member discovery if: + +- a) the following is true: + - 1) the UE is not served by E-UTRAN, is authorised to perform ProSe direct discovery for public safety use discoveree operation when the UE is not served by E-UTRAN as specified in clause 5, and is configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; + - 2) the UE is served by E-UTRAN, and is authorised to perform ProSe direct discovery for public safety use discoveree operation in the PLMN(s) indicated by the serving cell as specified in clause 5; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]; and + - authorised to perform ProSe direct discovery for public safety use discoveree operation when the UE is not served by E-UTRAN as specified in clause 5, and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + +- ii) the lower layers indicate that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12]; and + +NOTE: When the lower layers indicate that the UE does not need to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], the serving cell broadcasts a common radio resources pool for public safety discovery transmission and the UE can use this common radio resources pool while in limited service state. + +- b) the UE is configured with the Discovery Group ID parameter identifying the discovery group to be responded to and with the User Info ID for the group member discovery parameter, as specified in clause 5; + +otherwise the UE is not authorised to perform the Discoveree UE procedure for group member discovery. + +Figure 10A.2.9.2.1 illustrates the interaction of the UEs in the Discoveree UE procedure for group member discovery. + +![Sequence diagram illustrating the Discoveree UE procedure for group member discovery. A UE sends a PC5_DISCOVERY message for Group Member Discovery Solicitation to other UEs. The other UEs respond with a PC5_DISCOVERY message for Group Member Discovery Response.](25560b45ff748b9fc5d85aa004d18aa2_img.jpg) + +``` +sequenceDiagram + participant UE + participant other_UEs as other UEs + Note right of UE: PC5_DISCOVERY message +for Group Member Discovery Solicitation + UE->>other_UEs: + Note left of other_UEs: PC5_DISCOVERY message +for Group Member Discovery Response + other_UEs->>UE: +``` + +Sequence diagram illustrating the Discoveree UE procedure for group member discovery. A UE sends a PC5\_DISCOVERY message for Group Member Discovery Solicitation to other UEs. The other UEs respond with a PC5\_DISCOVERY message for Group Member Discovery Response. + +**Figure 10A.2.9.2.1: Discoveree UE procedure for group member discovery** + +When the UE is triggered by an upper layer application to start responding to solicitation on proximity of a UE in a discovery group, and if the UE is authorised to perform the discoveree UE procedure for group member discovery, then the UE: + +- a) if the UE is served by E-UTRAN, and the UE in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages for public safety as specified in 3GPP TS 36.331 [12], shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; and +- b) shall instruct the lower layers to start monitoring for PC5\_DISCOVERY messages with an indication that the message is for public safety use. + +Upon reception of a PC5\_DISCOVERY message for Group Member Discovery Solicitation according to subclause 11.2.5.1, for the Discovery Group ID of the discovery group which the UE is configured to respond for, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the monitoring operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality protected portion, as described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for Group Member Discovery Solicitation. + +Then, if: + +- the Discovery Group ID parameter of the received PC5\_DISCOVERY message is the same as a Discovery Group ID parameter configured as specified in clause 5 for the discovery group; +- the Target User Info parameter is not included in the received PC5\_DISCOVERY message or the Target User Info parameter of the received PC5\_DISCOVERY message is the same as the User Info ID for the group member discovery parameter specified in clause 5; and + +- the Target Group Info parameter is not included in the received PC5\_DISCOVERY message or the Target Group Info parameter of the received PC5\_DISCOVERY message is the same as the identifier of the targeted group provided by the upper layer application (e.g. ProSe Layer-2 Group ID of the ProSe direct communication service authorisation specified in clause 5); + +the UE: + +- a) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- b) shall generate a PC5\_DISCOVERY message for Group Member Discovery Response according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for Group Member Discovery Response, the UE: + - 1) shall set the ProSe UE ID to the Layer 2 ID used for unicast communication, configured in clause 5; + - 2) shall set the Discoveree Info parameter to the User Info ID for the group member discovery parameter, configured in clause 5; + - 3) shall set the Discovery Group ID parameter to the Discovery Group ID parameter of the PC5\_DISCOVERY message for Group Member Discovery Solicitation; and + - 4) shall set the UTC-based counter LSB parameter to include the eight least significant bits of the UTC-based counter; +- c) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g. integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- d) shall pass the resulting PC5\_DISCOVERY message for Group Member Discovery Response with an indication that the message is for public safety use to the lower layers for transmission over the PC5 interface. + +### 10A.2.9.3 Discoveree UE procedure for group member discovery completion + +When the UE is triggered by an upper layer application to stop responding to solicitation on proximity of other UEs in a discovery group, or when the UE stops being authorised to perform the discoveree UE procedure for group member discovery, the UE shall instruct the lower layers to stop monitoring. + +When the UE stops monitoring, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.10 Announcing UE procedure for Relay Discovery Additional Information + +### 10A.2.10.1 General + +The purpose of the announcing UE procedure for Relay Discovery Additional Information is to announce to the remote UEs additional information about: + +- the MBMS traffic the ProSe UE-to-network relay is relaying; or +- the E-UTRAN Cell serving the ProSe UE-to-network relay + +as defined in 3GPP TS 23.303 [2]. + +### 10A.2.10.2 Announcing procedure for Relay Discovery Additional Information + +The ProSe UE-to-network relay announces the Relay Discovery Additional Information: + +- a) if the remote UE requests the ProSe UE-to-network relay to start monitoring a specific TMGI availability by the PC5-S TMGI Monitoring Request message, and as a response the ProSe UE-to-network relay acknowledges with the PC5-S TMGI Monitoring Response message and the TMGI is detected in the serving E-UTRAN cell, then the ProSe UE-to-network relay includes a pair of the TMGI and its corresponding ProSe Layer 2 Group ID in the PC5\_DISCOVERY message for Relay Discovery Additional Information until the timer T4105 expires (see the subclause 10.5); or + +- b) if the remote UE requests the ProSe UE-to-network relay to announce the E-UTRAN Cell Global ID (ECGI) of the cell serving the ProSe UE-to-network relay, and as a response the ProSe UE-to-network relay acknowledges with the PC5-S Cell ID Announcement Response message, then the ProSe UE-to-network relay includes the ECGI of the serving cell in the PC5\_DISCOVERY message for Relay Discovery Additional Information until the timer T4107 expires (see the subclause 10.6). + +NOTE 1: ProSe UE-to-network relay announces the Relay Discovery Additional Information only when it is in E-UTRAN coverage. + +Figure 10A.2.10.2.1 illustrates the interaction of the ProSe UE-to-network relay and the remote UE in the announcing UE procedure for Relay Discovery Additional Information. + +![Sequence diagram showing a PC5_DISCOVERY message for Relay Discovery Additional Information being sent from a ProSe UE-to-network relay UE to UEs.](a8bcad776c8f979f6ca27eebabac4af9_img.jpg) + +``` + +ProSe UE-to-network relay UE UEs + + PC5_DISCOVERY message + for Relay Discovery Additional Information + ------------------------------------------------------------> + +``` + +Sequence diagram showing a PC5\_DISCOVERY message for Relay Discovery Additional Information being sent from a ProSe UE-to-network relay UE to UEs. + +**Figure 10A.2.10.2.1: Announcing procedure for Relay Discovery Additional Information** + +The ProSe UE-to-network relay UE may start announcing Relay Discovery Additional Information if: + +- a) the ProSe UE-to-network relay UE is currently authorised to perform ProSe direct discovery Model A announcing in the serving PLMN if the UE is served by E-UTRAN; and + - 1) TMGI monitoring has been requested and responded to remote UEs, the ProSe UE-to-network relay UE detects the corresponding TMGI in the serving cell and the timer T4105 has not expired; or + - 2) ECGI announcement for the serving cell of the ProSe UE-to-network relay UE has been requested and responded to remote UEs, the timer T4107 has not expired. + +When the ProSe UE-to-network relay has some additional information to broadcast (i.e. either a pair of TMGI and its corresponding ProSe Layer 2 Group ID or ECGI), then the ProSe UE-to-network relay: + +- a) shall request the parameters from the lower layers for ProSe direct discovery announcing for public safety use (see 3GPP TS 36.331 [12]). The ProSe UE-to-network relay performs the announcing UE procedure for Relay Discovery Additional Information only if the lower layers indicate that ProSe direct discovery is supported by the network. If the ProSe UE-to-network relay in EMM-IDLE mode needs to request resources for sending PC5\_DISCOVERY messages as specified in 3GPP TS 36.331 [12], the ProSe UE-to-network relay shall perform a service request procedure or tracking area update procedure as specified in 3GPP TS 24.301 [11]; +- b) shall obtain a valid UTC time for the discovery transmission from the lower layers and generate the UTC-based counter corresponding to this UTC time as specified in subclause 12.2.2.18; +- c) shall generate PC5\_DISCOVERY message(s) for Relay Discovery Additional Information according to subclause 11.2.5.1. In the PC5\_DISCOVERY message for Relay Discovery Additional Information, the ProSe UE-to-network relay shall: + - 1) include the Relay Service Code and the ProSe Relay UE ID used for ProSe direct communication which the remote UE used to request for the Relay Discovery Additional Information; + - 2) set the Announcer Info parameter to the User Info ID parameter, configured in subclause 5; + - 3) set the Relay Discovery Additional Information contents by the additional information to broadcast; and + - 4) shall set the UTC-based counter LSB parameter to include the eight least significant bits of the UTC-based counter; + +- d) shall apply the DUIK, DUSK, or DUCK with the associated Encrypted Bitmask, along with the UTC-based counter to the PC5\_DISCOVERY message for whichever security mechanism(s) configured to be applied, e.g. integrity protection, message scrambling or confidentiality protection of one or more above parameters, as specified in 3GPP TS 33.303 [6]; and +- e) shall pass the resulting PC5\_DISCOVERY message for Relay Discovery Additional Information to the lower layers for transmission over the PC5 interface with an indication that the message is for public safety use. + +The ProSe UE-to-network relay shall ensure that it keeps on passing the PC5\_DISCOVERY messages to the lower layers for transmission until the corresponding timer (i.e. timer T4105 when the additional information is a pair of TMGI and its corresponding ProSe Layer 2 Group ID and timer T4107 when the additional information is ECGI) expires. + +During the announcing operation, if one of the above conditions is no longer met, the ProSe UE-to-network relay may instruct the lower layers to stop announcing. When the ProSe UE-to-network relay stops announcing, if the lower layers indicate that the ProSe UE-to-network relay is required to send a discovery indication to the eNodeB and the ProSe UE-to-network relay is in EMM-CONNECTED mode, the ProSe UE-to-network relay shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +## 10A.2.11 Monitoring UE procedure for Relay Discovery Additional Information + +### 10A.2.11.1 General + +The purpose of the monitoring UE procedure for Relay Discovery Additional Information is to enable a remote UE to become aware of MBMS traffics the ProSe UE-to-network relay is relaying or the E-UTRAN Cell serving the ProSe UE-to-network relay as defined in 3GPP TS 23.303 [2]. + +### 10A.2.11.2 Monitoring procedure for Relay Discovery Additional Information + +The remote UE monitors Relay Discovery Additional Information: + +- a) until the TMGI monitoring refresh timer T4104 expires if the remote UE has requested the ProSe UE-to-network relay to start monitoring a specific TMGI availability by the PC5-S TMGI Monitoring Request message and received the PC5-S TMGI Monitoring Response message from the ProSe UE-to-network relay; or +- b) until the ECGI announcement request refresh timer T4106 expires if the remote UE has requested the ProSe UE-to-network relay to announce the ECGI of the cell serving the ProSe UE-to-network relay and received the PC5-S Cell ID Announcement Response message from the ProSe UE-to-network relay. + +The UE may instruct the lower layers to start monitoring with an indication that the message is for relay discovery for public safety use if: + +- a) a request from upper layers to monitor for Relay Discovery Additional Information is still in place; and either: + - 1) the UE is currently authorised to perform ProSe direct discovery Model A monitoring in at least one PLMN if the UE is served by E-UTRAN; + - 2) the UE is currently authorised to perform ProSe direct discovery Model A monitoring if the UE is not served by E-UTRAN; or + - 3) the UE is: + - in EMM-IDLE mode, in limited service state as specified in 3GPP TS 23.122 [24], and the reason for the UE being in limited service state is one of the following: + - i) the UE is unable to find a suitable cell in the selected PLMN as specified in 3GPP TS 36.304 [23]; + - ii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #11 "PLMN not allowed" as specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #11 "PLMN not allowed" as specified in 3GPP TS 24.008 [30]; or + - iii) the UE received an ATTACH REJECT message or a TRACKING AREA UPDATE REJECT message or a SERVICE REJECT message with the EMM cause #7 "EPS services not allowed" as + +specified in 3GPP TS 24.301 [11] or a LOCATION UPDATING REJECT message or a GPRS ATTACH REJECT message or ROUTING AREA UPDATE REJECT message or SERVICE REJECT message with cause #7 "GPRS services not allowed" as specified in 3GPP TS 24.008 [30]. + +- authorised to perform ProSe direct discovery Model A monitoring when the UE is not served by E-UTRAN as specified in clause 5, and: + - i) configured with the radio parameters to be used for ProSe direct discovery for public safety use when not served by E-UTRAN; or + - ii) the lower layers indicate that public safety discovery operation is supported; and + +NOTE 1: When the lower layers indicate that public safety discovery operation is supported, the serving cell broadcasts a common radio resources pool for public safety discovery reception and the UE can use this common radio resources pool while in limited service state. + +If the UE is in EMM-CONNECTED mode, the monitoring UE shall also trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +During the monitoring operation, if one of the above conditions is no longer met, the UE may instruct the lower layers to stop monitoring. When the UE stops monitoring, if the UE is in EMM-CONNECTED mode, the UE shall trigger the corresponding procedure in lower layers as specified in 3GPP TS 36.331 [12]. + +Upon reception of a PC5\_DISCOVERY message for Relay Discovery Additional Information according to subclause 11.2.5.1, for the target Relay Service Code to be monitored, the UE shall use the associated DUSK, if configured, and the UTC-based counter obtained during the monitoring operation to unscramble the PC5\_DISCOVERY message as described in 3GPP TS 33.303 [6]. Then, if a DUCK is configured, the UE shall use the DUCK and the UTC-based counter to decrypt the configured message-specific confidentiality protected portion, as described in 3GPP TS 33.303 [6]. Finally, if a DUIK is configured, the UE shall use the DUIK and UTC-based counter to verify the MIC field in the unscrambled PC5\_DISCOVERY message for Relay Discovery Additional Information. + +NOTE 2: The use of an erroneous UTC-based counter for processing received PC5\_DISCOVERY messages at the ProSe-enabled Public Safety UE can cause MIC check failure after DUIK is used for integrity check, and malformed contents after DUSK is used for unscrambling or DUCK is used for deciphering. How a ProSe-enabled Public Safety UE ensures the accuracy of the UTC-based counter is left to UE implementation. + +Then, if: + +- the Relay Service Code parameter of the PC5\_DISCOVERY message for Relay Discovery Additional Information is the same as the Relay Service Code parameter configured as specified in clause 5 for the connectivity service being monitored; and +- the ProSe Relay UE ID parameter of the PC5\_DISCOVERY message for Relay Discovery Additional Information is the same as the ProSe Relay UE ID parameter identifying the relay the remote UE intends to communicate with; + +then the UE shall consider that the Relay Discovery Additional Information it intends to monitor has been discovered. In addition, the UE can measure the signal strength of the PC5\_DISCOVERY message for Relay Discovery Additional Information for relay selection or reselection. + +If the remote UE detects Relay Discovery Additional Information matched with the requested TMGI, then the remote UE starts to receive the MBMS traffic via the corresponding ProSe Layer-2 Group ID. When the ProSe-enabled public safety UE receives a PC5\_DISCOVERY message for Relay Discovery Additional Information containing its interested TMGI, the UE may start to receive the MBMS traffic via the corresponding ProSe Layer-2 Group ID even if it does not have a PC5 link established with the ProSe UE-to-network relay or is not authorized to use a ProSe UE-to-network relay. + +## 10A.2.12 UE-to-network relay selection procedure + +### 10A.2.12.1 General + +The purpose of the UE-to-network relay selection procedure is to enable a remote UE to select a suitable ProSe UE-to-network relay UE to obtain a connectivity service to EPC. + +## 10A.2.12.2 UE-to-network relay selection procedure initiation + +The remote UE shall trigger the UE-to-network relay selection procedure if the following conditions are met: + +- the UE is authorised to act as a remote UE towards a ProSe UE-to-network relay UE as specified in clause 5; +- the UE has obtained a list of ProSe UE-to-network relay UE candidate(s) fulfilling ProSe layer criteria with the monitoring procedure for UE-to-network relay discovery as specified in subclause 10A.2.3 or the discoverer procedure for UE-to-network relay discovery as specified in subclause 10A.2.4; and +- the UE has obtained a list of ProSe UE-to-network relay UE candidate(s) fulfilling lower layers criteria as specified in 3GPP TS 36.331 [12]. + +## 10A.2.12.3 UE-to-network relay selection procedure completion + +If there exists only one ProSe UE-to-network relay candidate satisfying the conditions in subclause 10A.2.12.2, then that ProSe UE-to-network relay UE is selected. If there exist more than one ProSe UE-to-network relay candidate satisfying the conditions in subclause 10A.2.12.2, any relay candidates not satisfying the non-radio related ProSe layer criteria shall be discarded, and out of the remaining relay candidates, the relay candidate with the highest ranking of the lower layer criteria shall be selected. The UE may take the value of the Resource Status Indicator bit of the Status Indicator parameter of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement or PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response into account when deciding which ProSe UE-to-network relay to select. It is up to the UE implementation whether the ProSe layer or the lower layers takes the final selection on which ProSe UE-to-network relay UE to select. + +## 10A.2.13 UE-to-network relay reselection procedure + +### 10A.2.13.1 General + +The purpose of the UE-to-network relay reselection procedure is to enable a remote UE to reselect a ProSe UE-to-network relay UE to obtain a connectivity service to EPC when the serving ProSe UE-to-network relay UE is no longer suitable. + +### 10A.2.13.2 UE-to-network relay reselection procedure initiation + +The remote UE shall trigger the UE-to-network relay reselection procedure if one of the following conditions is met: + +- a) the UE has received a lower layers indication that the serving ProSe UE-to-network relay UE no longer fulfills the lower layers criteria as specified in 3GPP TS 36.331 [12]; +- b) the parameters related to ProSe UE-to-network relay in the ProSe direct discovery for public safety use service authorisation (e.g., Relay Service Code, User Info ID, etc.) have been updated and the serving ProSe UE-to-network relay UE no longer fulfills the conditions specified in subclause 10A.2.3; +- c) the UE has received a DIRECT\_COMMUNICATION\_REJECT message from the ProSe UE-to-network relay UE with the cause value "Direct communication to target UE not allowed"; +- d) the UE has received a DIRECT\_COMMUNICATION\_RELEASE message from the ProSe UE-to-network relay UE with the cause value "Direct communication with the peer UE is no longer allowed"; +- e) the UE has received a DIRECT\_COMMUNICATION\_RELEASE message from the ProSe UE-to-network relay UE with the cause value "Direct connection is not available any more"; +- f) the UE has not received any response from the ProSe UE-to-network relay UE after M consecutive retransmissions of DIRECT COMMUNICATION SETUP or DIRECT COMMUNICATION KEEPALIVE messages; or +- g) the UE has not received any response from the ProSe UE-to-network relay UE after M consecutive retransmissions of PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation used to trigger the PC5\_DISCOVERY message signal strength measurement between the UE and the ProSe UE-to-network relay UE with which the UE has a link established. + +NOTE: The value of M is implementation specific and is less than or equal to the maximum number of retransmissions allowed for PC5 Signalling protocol. + +In cases c) and d), the remote UE shall exclude the ProSe UE-to-network relay UE which sent the message specified in cases c) or d) from the UE-to-network relay reselection process described below. + +To conduct UE-to-network relay reselection process, the UE shall first initiate one of the following procedures or both depending on UE's service authorisation for ProSe direct discovery for public safety use: + +- monitoring procedure for UE-to-network relay discovery as specified in subclause 10A.2.3; or +- discoverer procedure for UE-to-network relay discovery as specified in subclause 10A.2.4. + +After the execution of the above discovery procedure(s), the remote UE performs the UE-to-network relay selection procedure as specified in subclause 10A.2.3. + +--- + +## 11 Message functional definitions and contents + +### 11.1 Overview + +This clause contains the definition and contents of the messages used in the procedures described in the present document. + +### 11.2 ProSe discovery messages + +#### 11.2.1 General + +This subclause defines the XML schema and MIME type related to ProSe direct discovery messages and EPC-level ProSe discovery messages. + +This subclause also defines the format of the PC5\_DISCOVERY message transmitted over the PC5 interface. + +#### 11.2.2 application/3gpp-prose+xml + +The MIME type is used to carry information related to the ProSe discovery operation. It shall be coded as an XML document containing one of the following ProSe discovery messages: + +- DISCOVERY\_REQUEST; +- DISCOVERY\_RESPONSE; +- MATCH\_REPORT; +- MATCH\_REPORT\_ACK; +- DISCOVERY\_UPDATE\_REQUEST; +- DISCOVERY\_UPDATE\_RESPONSE; +- ANNOUNCING\_ALERT\_REQUEST; +- ANNOUNCING\_ALERT\_RESPONSE; +- UE\_REGISTRATION\_REQUEST; +- UE\_REGISTRATION\_RESPONSE; +- APPLICATION\_REGISTRATION\_REQUEST; +- APPLICATION\_REGISTRATION\_RESPONSE; +- PROXIMITY\_REQUEST; +- PROXIMITY\_REQUEST\_RESPONSE; +- PROXIMITY\_ALERT; + +- UE\_DEREGISTRATION\_REQUEST; +- UE\_DEREGISTRATION\_RESPONSE; +- CANCEL\_PROXIMITY\_REQUEST; +- CANCEL\_PROXIMITY\_RESPONSE; +- PROXIMITY\_REQUEST\_VALIDATION; or +- PROXIMITY\_REQUEST\_VALIDATION\_RESPONSE. + +Each of those messages is presented in the XML document as an XML element named after the corresponding message. + +### 11.2.3 XML Schema + +Implementations in compliance with the present document shall implement the XML schema defined below for messages used in ProSe direct discovery procedures over PC3 interface. + +``` + + + + + Info for ProSe Discovery Control Messages Syntax + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +An entity receiving the XML body ignores any unknown XML element and any unknown XML attribute. + +## 11.2.4 Semantics + +### 11.2.4.1 General + +The `` element is the root element of this XML document and it can be one of the following elements: + +- ``; + +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- ; +- +- ; +- ; +- element containing other discovery message defined in future releases; or +- an element from other namespaces defined in future releases. + +#### 11.2.4.2 Semantics of + +The element contains one or more of the following elements: + +- 1) zero, one or more element which contains transactions sent from the UE to the ProSe Function as announcing or monitoring requests for open ProSe direct discovery. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.2; + - c) a element containing the parameter defined in subclause 12.2.2.3; + - d) a element containing the parameter defined in subclause 12.2.2.4; + - e) an element containing the parameter defined in subclause 12.2.2.5; + - f) a element containing the parameter defined in subclause 12.2.2.33; + - g) an optional element containing the parameter defined in subclause 12.2.2.27; + - h) an optional element containing the parameter defined in subclause 12.2.2.21; + +- i) an optional element containing the parameter defined in subclause 12.2.2.64; + - j) zero or one element containing the parameter defined in subclause 12.2.2.38; + - k) zero or one element containing the parameter defined in subclause 12.2.2.71; + - l) zero or one element containing elements defined in future releases; + - m) zero, one or more elements from other namespaces defined in future releases; and + - n) zero, one or more attributes defined in future releases; +- 2) zero, one, or more element which contains transactions sent from the UE to the ProSe Function as announcing or monitoring requests for restricted ProSe directed discovery model A or transactions sent from the UE to the ProSe Function as discoverer or discoverer requests for restricted ProSe directed discovery model B. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.2; + - c) a element containing the parameter defined in subclause 12.2.2.3; + - d) a element containing the parameter defined in subclause 12.2.2.30; + - e) an element containing the parameter defined in subclause 12.2.2.5; + - f) a element containing the parameter defined in subclause 12.2.2.25; + - g) zero or one element containing the parameter defined in subclause 12.2.2.38; + - h) an element containing the parameter defined in subclause 12.2.2.31; + - i) an element containing the parameter defined in subclause 12.2.2.32; + - j) zero or one element containing the parameter defined in subclause 12.2.2.41; + - k) zero or one element containing the parameter defined in subclause 12.2.2.64; + - l) a element containing the parameter defined in subclause 12.2.2.33; + - m) an optional element containing the parameter defined in subclause 12.2.2.27; + - n) zero or one element containing the parameter defined in subclause 12.2.2.71; + - o) zero or one element containing elements defined in future releases; + - p) zero, one or more elements from other namespaces defined in future releases; and + - q) zero, one or more attributes defined in future releases; +- 3) zero or one element containing elements defined in future releases; +- 4) zero, one or more elements from other namespaces defined in future releases; +- 5) an optional "network-initiated transaction method" attribute containing the parameter defined in subclause 12.2.2.63; and +- 6) zero, one or more attributes defined in future releases. + +#### 11.2.4.3 Semantics of + +The element contains one or more of the following elements: + +- 1) a element containing the parameter defined in subclause 12.2.2.23; +- 2) a element containing the parameter defined in subclause 12.2.2.24; + +- 3) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to an announcing request if the ProSe Function accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.1; + - b) zero, one or more elements containing the parameter defined in subclause 12.2.2.6; + - c) zero or one element containing the parameter defined in subclause 12.2.2.70; + - d) zero, or one element containing the parameter defined in 12.2.2.7; + - e) zero, or, one element containing the parameter defined in subclause 12.2.2.9; + - f) a element containing the parameter defined in subclause 12.2.2.33; + - g) zero or one element containing the parameter defined in subclause 12.2.2.38; + - h) zero or one element containing the parameter defined in subclause 12.2.2.71; + - i) zero or one element containing elements defined in future releases; + - j) zero, one or more elements from other namespaces defined in future releases; and + - k) zero, one or more attributes defined in future releases; +- 4) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to a monitoring request if the ProSe Function accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.1; + - b) zero, one or more elements containing the parameter defined in subclause 12.2.2.12; + - c) a element containing the parameter defined in subclause 12.2.2.33; + - d) zero or one element containing the parameter defined in subclause 12.2.2.38; + - e) zero or one element containing elements defined in future releases; + - f) zero, one or more elements from other namespaces defined in future releases; and + - g) zero, one or more attributes defined in future releases; +- 5) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to an announcing request for restricted ProSe direct discovery model A if the ProSe Function accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.1; + - b) zero or one element containing the parameter defined in subclause 12.2.2.34; + - c) zero, one or more element containing the parameter defined in subclause 12.2.2.35; + - d) zero or one element containing the parameter defined in 12.2.2.39; + - e) zero or one element containing the parameter defined in subclause 12.2.2.38; + - f) zero or one element containing the parameter defined in subclause 12.2.2.40; + - g) an optional element containing the parameter defined in subclause 12.2.2.36; + - h) a element containing the parameter defined in subclause 12.2.2.33; + - i) zero or one element containing the parameter defined in subclause 12.2.2.71; + +- j) zero or one element containing elements defined in future releases; + - k) zero, one or more elements from other namespaces defined in future releases; and + - l) zero, one or more attributes defined in future releases; +- 6) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to a monitoring request for restricted ProSe direct discovery model A if the ProSe Function accepts the request. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) zero, one or more elements containing the parameter defined in subclause 12.2.2.37; + - c) zero or one element containing the parameter defined in subclause 12.2.2.38 + - d) a element containing the parameter defined in subclause 12.2.2.33; + - e) an element containing the parameter defined in subclause 12.2.2.32; + - f) zero or one element containing the parameter defined in subclause 12.2.2.71; + - g) zero or one element containing elements defined in future releases; + - h) zero, one or more elements from other namespaces defined in future releases; and + - i) zero, one or more attributes defined in future releases; +- 7) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to a discoveree UE's request for restricted ProSe direct discovery model B if the ProSe Function accepts the request. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the element defined in subclause 12.2.2.42; + - c) one or more elements containing the parameter defined in subclause 12.2.2.43; + - d) a element containing the parameter defined in subclause 12.2.2.44; + - e) zero or one element containing the parameter defined in subclause 12.2.2.40; + - f) a element containing the parameter defined in subclause 12.2.2.33; + - g) zero or one element containing the parameter defined in subclause 12.2.2.71; + - h) zero or one element containing elements defined in future releases; + - i) zero, one or more elements from other namespaces defined in future releases; and + - j) zero, one or more attributes defined in future releases; +- 8) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to a discoverer UE's request for restricted ProSe direct discovery model B if the ProSe Function accepts the request. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) one or more elements containing the parameter defined in subclause 12.2.2.45; + - c) a element containing the parameter defined in subclause 12.2.2.33; + - d) zero or one element containing the parameter defined in subclause 12.2.2.71; + - e) zero or one element containing elements defined in future releases; + +- f) zero, one or more elements from other namespaces defined in future releases; and + - g) zero, one or more attributes defined in future releases; +- 9) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to an announcing or monitoring requests if the ProSe Function cannot accept the request. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.8. + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 10) zero or one element containing elements defined in future releases; +- 11) zero, one or more elements from other namespaces defined in future releases; +- 12) an optional "network-initiated transaction method" attribute containing the parameter defined in subclause 12.2.2.63; and +- 13) zero, one or more attributes defined in future releases. + +#### 11.2.4.4 Semantics of + +The element contains one or more of the following element: + +- 1) zero, one or more element which contains transactions sent from the UE to the ProSe Function to report a matching of the direct discovery. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.6; + - c) a element containing the parameter defined in subclause 12.2.2.3; + - d) a element containing the parameter defined in subclause 12.2.2.16; + - e) an optional element containing the parameter defined in subclause 12.2.2.17; + - f) a element containing the parameter defined in subclause 12.2.2.11; + - g) a element containing the parameter defined in subclause 12.2.2.18; + - h) a element containing the parameter defined in subclause 12.2.2.20; + - i) a element containing the parameter defined in subclause 12.2.2.10; + - j) zero or one element containing the parameter defined in subclause 12.2.2.71; + - k) zero or one element containing elements defined in future releases; + - l) zero, one or more elements from other namespaces defined in future releases; and + - m) zero, one or more attributes defined in future releases; +- 2) zero, one or more element which contain transactions sent from the UE to the ProSe Function to report a matching of the restricted direct discovery model A or model B. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.3; + - c) a element containing the parameter defined in subclause 12.2.2.25 + - d) an element containing the parameter defined in subclause 12.2.2.5 + +- e) an element containing the parameter defined in subclause 12.2.2.30; + - f) a element containing the ProSe Restricted Code parameter defined in subclause 12.2.2.34 or ProSe Response Code parameter defined in subclause 12.2.2.42; + - g) an optional element containing the parameter defined in subclause 12.2.2.11; + - h) an optional element containing the parameter defined in subclause 12.2.2.10; + - i) an optional element containing the parameter defined in subclause 12.2.2.18; + - j) a element containing the parameter defined in subclause 12.2.2.20; + - k) zero or one element containing the parameter defined in subclause 12.2.2.71; + - l) zero or one element containing elements defined in future releases; + - m) zero, one or more elements from other namespaces defined in future releases; and + - n) zero, one or more attributes defined in future releases. +- 3) zero or one element containing elements defined in future releases; + - 4) zero, one or more elements from other namespaces defined in future releases; and + - 5) zero, one or more attributes defined in future releases. + +#### 11.2.4.5 Semantics of + +The element contains one or more of the following elements: + +- 1) a element containing the parameter defined in subclause 12.2.2.23; +- 2) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to a match report if the ProSe Function accepts the report. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.4; + - c) a element containing the parameter defined in subclause 12.2.2.19; + - d) an optional element containing the parameter defined in subclause 12.2.2.21; + - e) an optional element containing the parameter defined in subclause 12.2.2.62; + - f) zero or one element containing elements defined in future releases; + - g) zero, one or more elements from other namespaces defined in future releases; + - h) a mandatory "match-report-refresh-timer-T4006" attribute containing the parameter defined in subclause 12.2.2.26; and + - i) zero, one or more attributes defined in future releases; +- 3) zero, one or more element which contain transactions sent from the ProSe Function to the UE as a response to a match report if the ProSe Function accepts the report. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.1; + - b) an element containing the parameter defined in subclause 12.2.2.5; + - c) an element containing the parameter defined in subclause 12.2.2.30; + - d) a element containing the parameter defined in subclause 12.2.2.60; + - e) an optional element containing the parameter defined in subclause 12.2.2.21; + +- f) zero or one element containing elements defined in future releases; + - g) zero, one or more elements from other namespaces defined in future releases; + - h) an optional "match-report-refresh-timer-T4017" attribute containing the parameter defined in subclause 12.2.2.61; and + - i) zero, one or more attributes defined in future releases; +- 4) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to a match report if the ProSe Function cannot accept the match report. Each consists of: +- a) a element containing the parameter defined in subclause 12.2.2.1; + - b) a element containing the parameter defined in subclause 12.2.2.8; + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 5) zero or one element containing elements defined in future releases; +- 6) zero, one or more elements from other namespaces defined in future releases; and +- 7) zero, one or more attributes defined in future releases. + +#### 11.2.4.6 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the UE to the ProSe Function to register the UE. Each consists of: +- a) a element containing the parameter defined in subclause 12.3.2.1; + - b) a element containing the parameter defined in subclause 12.3.2.2; + - c) a element containing the parameter defined in subclause 12.3.2.6; + - d) a element containing the parameter defined in subclause 12.3.2.14; + - e) zero or one element containing elements defined in future releases; + - f) zero, one or more elements from other namespaces defined in future releases; and + - g) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.7 Semantics of + +The element contains one or more of the following elements: + +- 1) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to the UE\_REGISTRATION\_REQUEST message if the ProSe Function accepts the request. Each consists of: +- a) a element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.7; + - c) a element containing the parameter defined in subclause 12.3.2.15; + +- d) zero, one or more elements defined in future releases; and + - e) zero, one or more attributes defined in future releases; +- 2) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to the UE\_REGISTRATION\_REQUEST message if the ProSe Function cannot accept the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) a element containing the parameter defined in subclause 12.3.2.5; + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; + - 3) zero or one element containing elements defined in future releases; + - 4) zero, one or more elements from other namespaces defined in future releases; and + - 5) zero, one or more attributes defined in future releases. + +#### 11.2.4.8 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the UE to the ProSe Function to activate EPC-level ProSe discovery for a specific application. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.7. + - c) an element containing the parameter defined in subclause 12.3.2.3; + - d) an element containing the parameter defined in subclause 12.3.2.4; + - e) zero, one or more elements defined in future releases; and + - f) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.9 Semantics of + +The element contains one or more of the following elements: + +- 1) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to the APPLICATION\_REGISTRATION\_REQUEST message if the ProSe Function accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) one or more element containing the parameter defined in subclause 12.3.2.8; + - c) zero or one element containing elements defined in future releases; + - d) zero, one or more elements from other namespaces defined in future releases; and + - e) zero, one or more attributes defined in future releases; + +- 2) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to the APPLICATION\_REGISTRATION\_REQUEST message if the ProSe Function cannot accept the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) a element containing the parameter defined in subclause 12.3.2.5; + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 3) zero or one element containing elements defined in future releases; +- 4) zero, one or more elements from other namespaces defined in future releases; and +- 5) zero, one or more attributes defined in future releases. + +#### 11.2.4.10 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the UE to the ProSe Function to request to be alerted when it enters in proximity with a targeted UE. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.7; + - c) an element containing the parameter defined in subclause 12.3.2.3; + - d) an element containing the parameter defined in subclause 12.3.2.4; + - e) an element containing the parameter defined in subclause 12.3.2.4; + - f) a element containing the parameter defined in subclause 12.3.2.8; + - g) a element containing the parameter defined in subclause 12.3.2.11; + - h) a element containing the parameter defined in subclause 12.3.2.9; + - i) an optional element containing the parameter defined in subclause 12.3.2.12; + - j) zero or one element containing elements defined in future releases; + - k) zero, one or more elements from other namespaces defined in future releases; and + - l) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.11 Semantics of + +The element contains one or more of the following elements: + +- 1) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to the PROXIMITY\_REQUEST message if the ProSe Function accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) zero, one or more elements defined in future releases; and + - c) zero, one or more attributes defined in future releases; + +- 2) zero, one or more element which contains transactions sent from the ProSe Function to the UE as a response to the PROXIMITY\_REQUEST message if the ProSe Function cannot accept the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) a element containing the parameter defined in subclause 12.3.2.5; + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 3) zero or one element containing elements defined in future releases; +- 4) zero, one or more elements from other namespaces defined in future releases; and +- 5) zero, one or more attributes defined in future releases. + +#### 11.2.4.12 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the ProSe Function to the (UE A) and optionally to targeted (UE B) to alert them that they have entered in proximity. Each consists of: + - a) element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.3; + - c) an element containing the parameter defined in subclause 12.3.2.4; + - d) an element containing the parameter defined in subclause 12.3.2.4; + - e) an optional element containing the parameter defined in subclause 12.3.2.13; + - f) zero or one element containing elements defined in future releases; + - g) zero, one or more elements from other namespaces defined in future releases; and + - h) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.13 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent either from the UE to the ProSe Function or from the ProSe Function to the UE to deregister the UE. Each < UE-deregister-request > consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.7; + - c) a element containing the parameter defined in subclause 12.3.2.5; + - d) zero, one or more elements defined in future releases; and + - e) zero, one or more attributes defined in future releases +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and + +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.14 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent either from the UE to the ProSe Function or from the ProSe Function to the UE to complete the UE deregistration. Each < UE-deregister-response > consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) zero, one or more elements defined in future releases; and + - c) zero, one or more attributes defined in future releases +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.15 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the UE to the ProSe Function or from the ProSe Function to the UE to request cancellation of an ongoing proximity request. Each < cancel\_proximity-request > consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.7; + - c) an element containing the parameter defined in subclause 12.3.2.3; + - d) an element containing the parameter defined in subclause 12.3.2.4; + - e) zero, one or more elements defined in future releases; and + - f) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.16 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the ProSe Function to the UE or from the UE to the ProSe Function as a response to CANCEL\_PROXIMITY\_REQUEST message. Each < cancel\_proximity-response > consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) zero, one or more elements defined in future releases; and + - c) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.17 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent by the ProSe Function to the targeted UE (UE B) to request confirmation of permission for proximity request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) an element containing the parameter defined in subclause 12.3.2.3; + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; +- 3) zero, one or more elements from other namespaces defined in future releases; and +- 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.18 Semantics of + +The element contains one or more of the following elements: + +- 1) zero, one or more element which contains transactions sent from the UE to the ProSe Function as a response to the PROXIMITY\_REQUEST\_VALIDATION message if the application in the UE accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) zero, one or more elements defined in future releases; and + - c) zero, one or more attributes defined in future releases; +- 2) zero, one or more element which contains transactions sent from the UE to the ProSe Function as a response to the PROXIMITY\_REQUEST\_VALIDATION message if the application in the UE does not accept the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.3.2.1; + - b) a element containing the parameter defined in subclause 12.3.2.5. + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 3) zero or one element containing elements defined in future releases; +- 4) zero, one or more elements from other namespaces defined in future releases; and +- 5) zero, one or more attributes defined in future releases. + +#### 11.2.4.19 Semantics of < DISCOVERY\_UPDATE\_REQUEST> + +The < DISCOVERY\_UPDATE\_REQUEST> element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the ProSe Function to the UE as announcing or monitoring requests. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.28; + - b) a element containing the parameter defined in subclause 12.2.2.3; + - c) a element containing the parameter defined in subclause 12.2.2.33; + +- d) an optional element containing the parameter defined in subclause 12.2.2.29; + - e) zero or one element containing elements defined in future releases; + - f) zero, one or more elements defined in future releases; and + - g) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; + - 3) zero, one or more elements from other namespaces defined in future releases; and + - 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.20 Semantics of + +The element contains one or more of the following elements: + +- 1) one or more element which contains transactions sent from the UE to the ProSe Function as a response if the UE accepts the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.28; + - b) a element containing the parameter defined in subclause 12.2.2.33; + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 2) zero, one or more element which contains transactions sent from the UE to the ProSe Function as a response if the UE cannot accept the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.28; + - b) a element containing the parameter defined in subclause 12.2.2.8. + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 3) zero or one element containing elements defined in future releases; +- 4) zero, one or more elements from other namespaces defined in future releases; and +- 5) zero, one or more attributes defined in future releases. + +#### 11.2.4.21 Semantics of + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the UE to the ProSe Function as announcing or monitoring requests. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.28; + - b) a element containing the parameter defined in subclause 12.2.2.3; + - c) a element containing the parameter defined in subclause 12.2.2.30; + - d) a element containing the parameter defined in subclause 12.2.2.33; + - e) a element containing the parameter defined in subclause 12.2.2.34; + - f) zero, one or more element containing the parameter defined in subclause 12.2.2.35; + - g) zero or one element containing elements defined in future releases; + +- h) zero, one or more elements from other namespaces defined in future releases; and + - i) zero, one or more attributes defined in future releases; +- 2) zero or one element containing elements defined in future releases; + - 3) zero, one or more elements from other namespaces defined in future releases; and + - 4) zero, one or more attributes defined in future releases. + +#### 11.2.4.22 Semantics of < ANNOUNCING\_ALERT\_RESPONSE > + +The element contains one or more of the following elements: + +- 1) One or more element which contains transactions sent from the UE to the ProSe Function as announcing or monitoring requests. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.28; + - b) zero, one or more elements defined in future releases; and + - c) zero, one or more attributes defined in future releases; +- 2) zero, one or more element which contains transactions sent from the UE to the ProSe Function as a response if the UE cannot accept the request. Each consists of: + - a) a element containing the parameter defined in subclause 12.2.2.28; + - b) a element containing the parameter defined in subclause 12.2.2.8. + - c) zero, one or more elements defined in future releases; and + - d) zero, one or more attributes defined in future releases; +- 3) zero or one element containing elements defined in future releases; +- 4) zero, one or more elements from other namespaces defined in future releases; and +- 5) zero, one or more attributes defined in future releases. + +### 11.2.5 PC5\_DISCOVERY + +#### 11.2.5.1 Message definition + +This message is sent by the UE over the PC5 interface for open ProSe direct discovery and restricted ProSe direct discovery. See table 11.2.5.1.1, table 11.2.5.1.1A, table 11.2.5.1.2, table 11.2.5.1.3, table 11.2.5.1.4, table 11.2.5.1.5, table 11.2.5.1.6, table 11.2.5.1.7, table 11.2.5.1.8, table 11.2.5.1.9 and table 11.2.5.1.10. + +**Table 11.2.5.1.1: PC5\_DISCOVERY message content for open ProSe direct discovery** + +| Information Element | Type/Reference | Presence | Length (bits) | +|------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| ProSe Application Code | Binary
12.2.2.6 | M | 184 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Open discovery" and the Content Type is not set to "application-controlled extension enabled". | | | | + +**Table 11.2.5.1.1A: PC5\_DISCOVERY message content for open ProSe direct discovery with application-controlled extension** + +| Information Element | Type/Reference | Presence | Length (bits) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE 1) | Message Type
12.2.2.10 | M | 8 | +| ProSe Application Code Prefix (NOTE 2) | Binary
12.2.2.68 | M | 32-176 | +| ProSe Application Code Suffix (NOTE 2) | Binary
12.2.2.69 | M | 8-152 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE 1: The Discovery Type is set to "Open discovery" and the Content Type is set to "application-controlled extension enabled".
NOTE 2: The sum of the lengths of the ProSe Application Code Prefix and the ProSe Application Code Suffix is 184 bits. | | | | + +**Table 11.2.5.1.2: PC5\_DISCOVERY message content for restricted ProSe direct discovery** + +| Information Element | Type/Reference | Presence | Length (bits) | +|------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| ProSe Restricted Code | Binary
12.2.2.34 | M | 184 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Restricted discovery" and the Content Type is not set to "application-controlled extension enabled". | | | | + +**Table 11.2.5.1.3: PC5\_DISCOVERY message content for restricted ProSe direct discovery with application-controlled extension** + +| Information Element | Type/Reference | Presence | Length (bits) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| ProSe Restricted Code Prefix | Binary
12.2.2.46 | M | 64 | +| ProSe Restricted Code Suffix | Binary
12.2.2.47 | M | 120 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Restricted discovery", the Content Type is set to "application-controlled extension enabled" and the Discovery Model is set to "Model A". | | | | + +**Table 11.2.5.1.4: PC5\_DISCOVERY message for UE-to-Network Relay Discovery Announcement** + +| Information Element | Type/Reference | Presence | Length (bits) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| Relay Service Code | Binary
12.2.2.51 | M | 24 | +| Announcer Info | Binary
12.2.2.50 | M | 48 | +| ProSe Relay UE ID | Binary
12.2.2.49 | M | 24 | +| Status Indicator | Binary
12.2.2.67 | M | 8 | +| Spare | Binary
12.2.2.56 | M | 80 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Restricted discovery", the Content Type is set to "UE-to-Network Relay Discovery Announcement or UE-to-Network Relay Discovery Response" and the Discovery Model is set to "Model A". | | | | + +**Table 11.2.5.1.5: PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation** + +| Information Element | Type/Reference | Presence | Length (bits) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------|-----------------------| +| Message Type (NOTE 1) | Message Type
12.2.2.10 | M | 8 | +| Relay Service Code | Binary
12.2.2.51 | M | 24 | +| Discoverer Info | Binary
12.2.2.50 | M | 48 | +| URDS Composition | Binary
12.2.2.66 | M | 8 | +| ProSe Relay UE ID | Binary
12.2.2.49 | C
(NOTE 2) | 24 | +| Spare | Binary
12.2.2.56 | M | 80 or 104
(NOTE 3) | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE 1: The Discovery Type is set to "Restricted discovery", the Content Type is set to "UE-to-Network Relay Discovery Solicitation" and the Discovery Model is set to "Model B".
NOTE 2: Presence of the ProSe Relay UE ID is indicated by the URDS Composition.
NOTE 3: If the ProSe Relay UE ID is present, then the length of the Spare is 80 bits. If ProSe Relay UE ID is not included, then the length of the Spare is 104 bits. | | | | + +**Table 11.2.5.1.6: PC5\_DISCOVERY message for UE-to-Network Relay Discovery Response** + +| Information Element | Type/Reference | Presence | Length (bits) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| Relay Service Code | Binary
12.2.2.51 | M | 24 | +| Discoveree Info | Binary
12.2.2.50 | M | 48 | +| ProSe Relay UE ID | Binary
12.2.2.49 | M | 24 | +| Status Indicator | Binary
12.2.2.67 | M | 8 | +| Spare | Binary
12.2.2.56 | M | 80 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Restricted discovery", the Content Type is set to "UE-to-Network Relay Discovery Announcement or UE-to-Network Relay Discovery Response" and the Discovery Model is set to "Model B". | | | | + +**Table 11.2.5.1.7: PC5\_DISCOVERY message for Group Member Discovery Announcement** + +| Information Element | Type/Reference | Presence | Length (bits) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| Discovery Group ID | Binary
12.2.2.54 | M | 24 | +| Announcer Info | Binary
12.2.2.50 | M | 48 | +| ProSe UE ID | Binary
12.2.2.48 | M | 24 | +| Spare | Binary
12.2.2.56 | M | 88 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Restricted discovery", the Content Type is set to "Group Member Discovery Announcement or Group Member Discovery Response" and the Discovery Model is set to "Model A". | | | | + +**Table 11.2.5.1.8: PC5\_DISCOVERY message for Group Member Discovery Solicitation** + +| Information Element | Type/Reference | Presence | Length (bits) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------|----------------------| +| Message Type (NOTE 1) | Message Type
12.2.2.10 | M | 8 | +| Discovery Group ID | Binary
12.2.2.54 | M | 24 | +| Discoverer Info | Binary
12.2.2.50 | M | 48 | +| GMDS Composition | Binary
12.2.2.55 | M | 8 | +| Target User Info | Binary
12.2.2.52 | C
(NOTE 2) | 48 | +| Target Group Info | Binary
12.2.2.53 | C
(NOTE 2) | 24 | +| Spare | Binary
12.2.2.56 | M | 56 or 80
(NOTE 3) | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE 1: The Discovery Type is set to "Restricted discovery", the Content Type is set to "Group Member Discovery Solicitation" and the Discovery Model is set to "Model B". | | | | +| NOTE 2: Presence of the Target User Info and of Target Group Info is indicated by the GMDS Composition. | | | | +| NOTE 3: If the Target User Info is present, then the length of the Spare is 56 bits. If the Target Group Info is present, then the length of the Spare is 80 bits. | | | | + +**Table 11.2.5.1.9: PC5\_DISCOVERY message for Group Member Discovery Response** + +| Information Element | Type/Reference | Presence | Length (bits) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------|---------------| +| Message Type (NOTE) | Message Type
12.2.2.10 | M | 8 | +| Discovery Group ID | Binary
12.2.2.54 | M | 24 | +| Discoveree Info | Binary
12.2.2.50 | M | 48 | +| ProSe UE ID | Binary
12.2.2.48 | M | 24 | +| Spare | Binary
12.2.2.56 | M | 88 | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE: The Discovery Type is set to "Restricted discovery", the Content Type is set to "Group Member Discovery Announcement or Group Member Discovery Response" and the Discovery Model is set to "Model B". | | | | + +**Table 11.2.5.1.10: PC5\_DISCOVERY message for Relay Discovery Additional Information** + +| Information Element | Type/Reference | Presence | Length (bits) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------|---------------------| +| Message Type (NOTE 1) | Message Type
12.2.2.10 | M | 8 | +| Relay Service Code | Binary
12.2.2.51 | M | 24 | +| ProSe Relay UE ID | Binary
12.2.2.49 | M | 24 | +| Announcer Info | Binary
12.2.2.50 | M | 48 | +| RDAI Composition | Binary
12.2.2.57 | M | 8 | +| ECGI | Binary
12.2.2.58 | C
(NOTE 2) | 56 | +| MBMS related information | Binary
12.2.2.59 | C
(NOTE 2) | 72 | +| Spare | Binary
12.2.2.56 | M | 8 or 24
(NOTE 3) | +| MIC | Binary
12.2.2.11 | M | 32 | +| UTC-based Counter LSB | Binary
12.2.2.22 | M | 8 | +| NOTE 1: The Discovery Type is set to "Restricted discovery", the Content Type is set to "Relay discovery additional information" and the Discovery Model is set to "Model A". | | | | +| NOTE 2: Presence of the ECGI and MBMS related information is indicated by the RDAI Composition. | | | | +| NOTE 3: If the RDAI Composition indicates inclusion of the MBMS related information, it is 8 bits. If the RDAI Composition indicates inclusion of the ECGI, it is 24 bits. | | | | + +## 11.3 Messages transmitted over the PC3ch interface + +### 11.3.1 General + +This subclause defines XML schema and MIME type related to messages transmitted over the PC3ch interface. + +### 11.3.2 application/3gpp-prose-pc3ch+xml + +The MIME type is used to carry information related to message transmitted over the PC3ch interface. It shall be coded as an XML document compliant to the XML schema in subclause 11.3.3 containing one of the following messages: + +- USAGE\_INFORMATION\_REPORT\_LIST; or +- USAGE\_INFORMATION\_REPORT\_LIST\_RESPONSE. + +Each of those messages is presented in the XML document as an XML element named after the corresponding message. + +The XML document can contain elements and attributes defined in future releases of this document. Receiving entity ignores any element not defined by this version of the specification and any attribute not defined by this version of the specification. + +### 11.3.3 XML Schema + +``` + + + + + + Syntax of messages transmitted over the PC3ch interface + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## 11.3.4 Semantics + +### 11.3.4.1 General + +The element is the root element of this XML document. + +The element contains one of the following: + +- element; +- element; +- element containing elements defined in future releases; or +- one or more elements from other namespace defined in future releases. + +The element contains zero, one or more attributes defined in future releases. + +### 11.3.4.2 Semantics of + +The element contains: + +- a element containing the parameter defined in subclause 12.4.2.1; +- a element containing the parameter defined in subclause 12.4.2.2; +- one or more elements; +- zero, one or more element; + +- e) zero or one element containing elements defined in future releases; +- f) zero, one or more elements from other namespaces defined in future releases; and +- g) zero, one or more attributes defined in future releases. + +The element carries one usage information report. The element contains: + +- a) mandatory "sequence-number" attribute containing the parameter defined in subclause 12.4.2.3; +- b) zero, one or more elements; +- c) zero, one or more element; +- d) zero, one or more elements; +- e) zero or one element containing elements defined in future releases; +- f) zero, one or more elements from other namespaces defined in future releases; and +- g) zero, one or more attributes defined in future releases. + +The element carries information whether the UE was in E-UTRAN coverage or out of E-UTRAN coverage. The element contains: + +- a) mandatory "in-coverage" attribute containing the parameter defined in subclause 12.4.2.4; +- b) optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time when the information given in the element start being valid; +- c) if the UE was in E-UTRAN coverage, zero, one or more elements; +- d) zero or one element containing elements defined in future releases; +- e) zero, one or more elements from other namespaces defined in future releases; and +- f) zero, one or more attributes defined in future releases. + +The element carries information about an E-UTRAN cell where the UE was camping on or which the UE used in the EMM-CONNECTED mode. The element contains: + +- a) an optional "ECGI" attribute containing the parameter defined in subclause 12.4.2.5; +- b) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time when the information given in the element start being valid; +- c) zero or one element containing elements defined in future releases; +- d) zero, one or more elements from other namespaces defined in future releases; and +- e) zero, one or more attributes defined in future releases. + +The element carries information about the configured radio parameters for the ProSe direct communication applicable in the geographical area of the UE. The element contains: + +- a) a mandatory "params" attribute containing the parameter defined in subclause 12.4.2.6; +- b) a mandatory "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time when the information given in the element start being valid; +- c) zero or one element containing elements defined in future releases; +- d) zero, one or more elements from other namespaces defined in future releases; and +- e) zero, one or more attributes defined in future releases. + +The element carries information about a ProSe group. The element contains: + +- a) a mandatory "prose-layer2-group-ID" attribute containing the parameter defined in subclause 12.4.2.9; +- b) a mandatory "prose-group-IP-multicast-address" attribute containing the parameter defined in subclause 12.4.2.10; +- c) an optional "first-transmission-timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first transmission to the ProSe Group IP multicast address in the collection period; +- d) an optional "first-reception-timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first reception from the ProSe Group IP multicast address in the collection period; +- e) a element containing the parameter defined in subclause 12.4.2.11, of the UE; +- f) a element containing the parameter defined in subclause 12.4.2.12, of the UE; +- g) zero, one or more element; +- h) zero, one or more element; +- i) zero, one or more element; +- j) zero or one element containing elements defined in future releases; +- k) zero, one or more elements from other namespaces defined in future releases; and +- l) zero, one or more attributes defined in future releases. + +The element carries information about a transmitter in a ProSe group. The element contains: + +- a) a mandatory "source-IP-address" attribute containing the parameter defined in subclause 12.4.2.11, of the transmitter; +- b) a mandatory "prose-UE-id" attribute containing the parameter defined in subclause 12.4.2.12, of the transmitter; +- c) zero or one element containing elements defined in future releases; +- d) zero, one or more elements from other namespaces defined in future releases; and +- e) zero, one or more attributes defined in future releases. + +The element carries information about a transmission in a ProSe group. The element contains: + +- a) a mandatory "in-coverage" attribute containing the parameter defined in subclause 12.4.2.4; +- b) if the UE was in E-UTRAN coverage when transmitting the data, an optional "ECGI" attribute containing the parameter defined in subclause 12.4.2.5, indicating E-UTRAN Cell Global Identification of the E-UTRAN cell where the UE was camping on or which the UE used in the EMM-CONNECTED mode when transmitting the data; +- c) if the UE was in E-UTRAN coverage and the "ECGI" attribute is included: + - 1) a mandatory "amount" attribute containing the parameter defined in subclause 12.4.2.13 indicating the amount of octets transmitted to the ProSe group: + - when the UE was camping on a cell identified by the "ECGI" attribute when transmitting the data; or + - when the UE used in the EMM-CONNECTED mode a cell identified by the "ECGI" attribute when transmitting the data; and + - 2) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first transmission in the E-UTRAN cell; +- d) if the UE was in E-UTRAN coverage and the "ECGI" attribute is not included: + +- 1) a mandatory "amount" attribute containing the parameter defined in subclause 12.4.2.13 indicating the amount of octets transmitted to the ProSe group during the in E-UTRAN coverage period; and + - 2) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first transmission during the in E-UTRAN coverage period; +- e) if the UE was out of E-UTRAN coverage: + - 1) a mandatory "amount" attribute containing the parameter defined in subclause 12.4.2.13 indicating the amount of octets transmitted to the ProSe group during the out of E-UTRAN coverage period; and + - 2) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first transmission during the out of E-UTRAN coverage period; + - f) an optional "radio-resources-ind" attribute containing the parameter defined in subclause 12.4.2.14; + - g) an optional "radio-frequency" attribute containing the parameter defined in subclause 12.4.2.15; + - i) zero or one element containing elements defined in future releases; + - j) zero, one or more elements from other namespaces defined in future releases; and + - k) zero, one or more attributes defined in future releases. + +The element carries information about a reception in a ProSe group. The element contains: + +- a) a mandatory "in-coverage" attribute containing the parameter defined in subclause 12.4.2.4 indicating whether the UE was in E-UTRAN coverage when receiving the data; +- b) if the UE was in E-UTRAN coverage when receiving the data, an optional "ECGI" attribute containing the parameter defined in subclause 12.4.2.5 indicating E-UTRAN Cell Global Identification of the E-UTRAN cell where the UE was camping on or which the UE used in the EMM-CONNECTED mode when receiving the data; +- c) if the UE was in E-UTRAN coverage and the "ECGI" attribute is included: + - 1) a mandatory "amount" attribute containing the parameter defined in subclause 12.4.2.13 indicating the amount of octets received from the ProSe group: + - when the UE was camping on a cell identified by the "ECGI" attribute when receiving the data; or + - when the UE used in the EMM-CONNECTED mode a cell identified by the "ECGI" attribute when receiving the data; and + - 2) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first reception in the E-UTRAN cell; +- d) if the UE was in E-UTRAN coverage and the "ECGI" attribute is not included: + - 1) a mandatory "amount" attribute containing the parameter defined in subclause 12.4.2.13 indicating the amount of octets received from the ProSe group during the in E-UTRAN coverage period; and + - 2) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first reception during the in E-UTRAN coverage period; +- e) if the UE was out of E-UTRAN coverage: + - 1) a mandatory "amount" attribute containing the parameter defined in subclause 12.4.2.13 indicating the amount of octets received from the ProSe group during the out of E-UTRAN coverage period; and + - 2) an optional "timestamp" attribute containing the parameter defined in subclause 12.4.2.8 indicating date and time of the first reception during the out of E-UTRAN coverage period; +- f) an optional "radio-resources-ind" attribute containing the parameter defined in subclause 12.4.2.14; +- g) an optional "radio-frequency" attribute containing the parameter defined in subclause 12.4.2.15; +- h) zero or one element containing elements defined in future releases; + +- i) zero, one or more elements from other namespaces defined in future releases; and +- j) zero, one or more attributes defined in future releases. + +The element contains an application specific data received from upper layers during the collection period. + +### 11.3.4.3 Semantics of + +The element contains: + +- a) one of element and element; +- b) zero or one element containing elements defined in future releases; +- c) zero, one or more elements from other namespaces defined in future releases; and +- d) zero, one or more attributes defined in future releases. + +The element indicates that a related USAGE\_INFORMATION\_REPORT\_LIST message was accepted. The element contains: + +- a) element containing the parameter defined in subclause 12.4.2.1 indicating the value of the transaction ID of the related USAGE\_INFORMATION\_REPORT\_LIST message; +- b) zero or one element containing elements defined in future releases; +- c) zero, one or more elements from other namespaces defined in future releases; and +- d) zero, one or more attributes defined in future releases. + +The element indicates that a related USAGE\_INFORMATION\_REPORT\_LIST message was rejected. The element contains: + +- a) element containing the parameter defined in subclause 12.4.2.1 indicating the value of the transaction ID of the related USAGE\_INFORMATION\_REPORT\_LIST message; +- b) element containing the parameter defined in subclause 12.4.2.7; +- c) zero or one element containing elements defined in future releases; +- d) zero, one or more elements from other namespaces defined in future releases; and +- e) zero, one or more attributes defined in future releases. + +## 11.4 PC5 Signalling messages + +### 11.4.1 Overview + +This clause defines the structure of the PC5 Signalling messages exchanged between two ProSe-enabled UEs over the PC5 interface. These are standard L3 messages as defined in 3GPP TS 24.007 [43]. + +Each definition given in the present clause includes: + +- a) a table listing the Information Elements (IE) present in the message and the order of their appearance in the message. All IEs that may be repeated are explicitly indicated (The V, LV and LV-E formatted IEs, which contain the imperative part of the message, occur before the T, TV, TLV and TLV-E formatted IEs which contain the non-imperative part of the message, see 3GPP TS 24.007 [43]). In a (maximal) sequence of consecutive IEs with half octet length, the first IE with half octet length occupies bits 1 to 4 of octet N, the second IE bits 5 to 8 of octet N, the third IE bits 1 to 4 of octet N+1 etc. Such a sequence always has an even number of elements. + +For each information element the table indicates: + +1. The Information Element Identifier (IEI), in hexadecimal notation, if the IE has format T, TV, TLV or TLV-E. If the IEI has half octet length, it is specified by a notation representing the IEI as a hexadecimal digit followed by a "-" (example: B-). + +NOTE: The same IEI can be used for different information element types in different messages of the same protocol. + +2. The name of the information element (which is indicative of the semantics of the element). The name of the information element followed by "IE" or "information element" is used as reference to the information element within a message. + 3. The name of the type of the information element (which indicates the coding of the value part of the IE), and generally, the referenced subclause of clause 12 of the present document describing the value part of the information element. + 4. The presence requirement indication (M, C, or O) for the IE as defined in 3GPP TS 24.007 [43]. + 5. The format of the information element (T, V, TV, LV, TLV, LV-E or TLV-E) as defined in 3GPP TS 24.007 [43]. + 6. The length of the information element (or permissible range of lengths), in octets, in the message, where "?" means that the maximum length of the IE is only constrained by link layer protocol. This indication is non-normative. +- b) subclauses specifying, where appropriate, conditions for IEs with presence requirement C or O in the relevant message which together with other conditions specified in the present document define when the information elements shall be included or not, what non-presence of such IEs means, and – for IEs with presence requirement C – the static conditions for presence or non-presence of the IEs or for both cases (see 3GPP TS 24.007 [43]). + +## 11.4.2 DIRECT\_COMMUNICATION\_REQUEST + +### 11.4.2.1 Message definition + +This message is sent by a UE to another peer UE to establish a direct link. See table 11.4.2.1.1. + +Message type: DIRECT\_COMMUNICATION\_REQUEST + +**Table 11.4.2.1.1: DIRECT\_COMMUNICATION\_REQUEST message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------------|--------------------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_REQUEST message identity | PC5-SP Message Type
12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | User Info | User Info
12.5.1.3 | M | LV | 3-253 | +| | IP Address Config | IP Address Config
12.5.1.4 | M | V | 1 | +| | Maximum Inactivity Period | Maximum Inactivity Period
12.5.1.9 | M | V | 4 | +| | Nonce_1 | Nonce_1
12.5.1.30 | M | V | 16 | +| | UE Security Capabilities | UE Security Capabilities
12.5.1.22 | M | V | 2 | +| | MSB of K D-sess ID | MSB of K D-sess ID
12.5.1.25 | M | V | 1 | +| 17 | K D ID | K D ID
12.5.1.30 | O | TV | 5 | +| 25 | Relay Service Code | Relay Service Code
12.5.1.17 | O | TV | 4 | +| 22 | Signature | Signature
12.5.1.33 | O | TV | 130 | +| 3 | Link Local IPv6 Address | IPv6 Address
12.5.1.5 | O | TV | 17 | + +## 11.4.3 DIRECT\_COMMUNICATION\_ACCEPT + +### 11.4.3.1 Message definition + +This message is sent by the UE to another peer UE to indicate that the corresponding direct link setup request has been accepted. See table 11.4.3.1.1. + +.Message type: DIRECT\_COMMUNICATION\_ACCEPT + +**Table 11.4.3.1.1: DIRECT\_COMMUNICATION\_ACCEPT message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|--------------------------------------------------|-------------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_AC
CEPT message identity | PC5-SP Message Type
12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | IP Address Config | IP Address Config
12.5.1.4 | M | V | 1 | +| 3 | Link Local IPv6 Address | Link Local IPv6 Address
12.5.1.5 | O | TV | 17 | + +### 11.4.3.2 Link Local IPv6 Address + +The UE shall include this IE if the IP Address Config IE is set to "address allocation not supported". + +## 11.4.4 DIRECT\_COMMUNICATION\_REJECT + +### 11.4.4.1 Message definition + +This message is sent by the UE to another peer UE to indicate that the corresponding direct link setup request has been rejected. See table 11.4.4.1.1. + +.Message type: DIRECT\_COMMUNICATION\_REJECT + +**Table 11.4.4.1.1: DIRECT\_COMMUNICATION\_REJECT message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|--------------------------------------------------|----------------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_RE
JECT message identity | PC5-SP Message Type
12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | PC5 Signalling Cause Value | PC5 Signalling Cause Value
12.5.1.7 | M | V | 1 | + +## 11.4.5 DIRECT\_COMMUNICATION\_KEEPALIVE + +### 11.4.5.1 Message definition + +This message is sent by the UE to another peer UE to initiate a direct link keepalive procedure. See table 11.4.5.1.1. + +.Message type: DIRECT\_COMMUNICATION\_KEEPALIVE + +**Table 11.4.5.1.1: DIRECT\_COMMUNICATION\_KEEPALIVE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------------------|---------------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_KE
EPALIVE message identity | PC5-SP Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | Keepalive Counter | Keepalive Counter
12.5.1.6 | M | V | 4 | +| 7 | Maximum Inactivity Period | Maximum Inactivity Period
12.5.1.9 | O | TV | 5 | + +## 11.4.6 DIRECT\_COMMUNICATION\_KEEPALIVE\_ACK + +### 11.4.6.1 Message definition + +This message is sent by the UE to another peer UE to acknowledge and respond to the link keepalive request. See table 11.4.6.1.1. + +Message type: DIRECT\_COMMUNICATION\_KEEPALIVE\_ACK + +**Table 11.4.6.1.1: DIRECT\_COMMUNICATION\_KEEPALIVE\_ACK message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------------------------------|---------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_KE
EPALIVE_ACK message identity | PC5-SP Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | Keepalive Counter | Keepalive Counter
12.5.1.6 | M | V | 4 | + +## 11.4.7 DIRECT\_COMMUNICATION\_RELEASE + +### 11.4.7.1 Message definition + +This message is sent by the UE to another peer UE to initiate the direct link release procedure. See table 11.4.7.1.1. + +Message type: DIRECT\_COMMUNICATION\_RELEASE + +**Table 11.4.7.1.1: DIRECT\_COMMUNICATION\_RELEASE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------------------------|---------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_RE
LEASE message identity | PC5-SP Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | Release Reason | Release Reason
12.5.1.8 | M | V | 1 | + +## 11.4.8 DIRECT\_COMMUNICATION\_RELEASE\_ACCEPT + +### 11.4.8.1 Message definition + +This message is sent by the UE to another peer UE to indicate that the link release request is accepted. See table 11.4.8.1.1. + +Message type: DIRECT\_COMMUNICATION\_RELEASE\_ACCEPT + +**Table 11.4.8.1.1: DIRECT\_COMMUNICATION\_RELEASE\_ACCEPT message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-------------------------------------------------------------|---------------------------------|----------|--------|--------| +| | DIRECT_COMMUNICATION_RE
LEASE_ACCEPT message
identity | PC5-SP Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | + +## 11.4.9 TMGI\_MONITORING\_REQUEST + +### 11.4.9.1 Message definition + +This message is sent by the remote UE to ProSe UE-to-network relay UE for TMGI monitoring request. See table 11.4.9.1. + +**Table 11.4.9.1.1: TMGI\_MONITORING\_REQUEST content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-------------------------------------|-----------------------------|----------|--------|--------| +| | TMGI_MONITORING_REQUEST identity | Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | TMGI | Binary
12.5.1.10 | M | V | 6 | +| | MBMS SAI list | Binary
12.5.1.11 | M | LV-E | 6-516 | +| | Requested ProSe Per-Packet Priority | Binary
12.5.1.16 | M | V | 1 | + +## 11.4.10 TMGI\_MONITORING\_RESPONSE + +### 11.4.10.1 Message definition + +This message is sent by the ProSe UE-to-network relay UE to the remote UE for TMGI monitoring response. See table 11.4.10.1. + +**Table 11.4.10.1.1: TMGI\_MONITORING\_RESPONSE content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------------|-----------------------------|----------|--------|--------| +| | TMGI_MONITORING_RESPONSE identity | Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | ProSe Layer2 Group ID | Binary
12.5.1.12 | M | V | 3 | +| | TMGI monitoring refresh timer
T4104 | Binary
12.5.1.13 | M | V | 2 | +| | SAI indicator | Boolean
12.5.1.14 | M | V | 1 | + +## 11.4.11 CELL\_ID\_ANNOUNCEMENT\_REQUEST + +### 11.4.11.1 Message definition + +This message is sent by the remote UE to ProSe UE-to-network relay UE to initiate the cell ID announcement request procedure. See table 11.4.11.1. + +**Table 11.4.11.1.1: CELL\_ID\_ANNOUNCEMENT\_REQUEST content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------------|-----------------------------|----------|--------|--------| +| | CELL_ID_ANNOUNCEMENT_REQUEST identity | Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | + +## 11.4.12 CELL\_ID\_ANNOUNCEMENT\_RESPONSE + +### 11.4.12.1 Message definition + +This message is sent by the ProSe UE-to-network relay UE to the remote UE to acknowledge and respond to the cell ID announcement request. See table 11.4.12.1. + +**Table 11.4.12.1.1: CELL\_ID\_ANNOUNCEMENT\_RESPONSE content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|--------------------------------------------------|-----------------------------|----------|--------|--------| +| | CELL_ID_ANNOUNCEMENT_RESPONSE identity | Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | ECGI announcement request refresh timer
T4106 | Binary
12.5.1.15 | M | V | 2 | + +## 11.4.12A DIRECT\_SECURITY\_MODE\_COMMAND + +### 11.4.12A.1 Message definition + +This message is sent by a commanding UE to a peer UE to establish the security for a direct link. See table 11.4.12A.1.1. + +Message type: DIRECT\_SECURITY\_MODE\_COMMAND + +**Table 11.4.12A.1.1: DIRECT\_SECURITY\_MODE\_COMMAND message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------------|-----------------------------------------|----------|--------|----------| +| | DIRECT_SECURITY_MODE_COMMAND message identity | PC5-SP Message Type
12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | UE Security Capabilities | UE Security Capabilities
12.5.1.22 | M | V | 2 | +| | Nonce 2 | Nonce 2
12.5.1.31 | M | V | 16 | +| | Chosen Algorithms | Chosen Algorithms
12.5.1.23 | M | V | 1 | +| | LSB of K D-sess ID | LSB of K D-sess
12.5.1.24 | M | V | 1 | +| 16 | MSB of K D ID | MSB of K D ID
12.5.1.27 | O | TV | 3 | +| 18 | K D Freshness | K D Freshness
12.5.1.30 | O | TV | 17 | +| 24 | GPI | GPI
12.5.1.18 | O | TLV | Variable | +| 1 | User Info | User Info
12.5.1.3 | O | TLV | 3-253 | +| 22 | Signature | Signature
12.5.1.33 | O | TV | 130 | +| 23 | Encrypted Payload | Encrypted Payload
12.5.1.34 | O | TLV | Variable | + +## 11.4.13 DIRECT\_SECURITY\_MODE\_COMPLETE + +### 11.4.13.1 Message definition + +This message is sent by a peer UE to a commanding UE to confirm the establishment of the security for a direct link. See table 11.4.13.1. + +Message type: DIRECT\_SECURITY\_MODE\_COMPLETE + +**Table 11.4.13.1: DIRECT\_SECURITY\_MODE\_COMPLETE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|------------------------------------------------|---------------------------------------|----------|--------|--------| +| | DIRECT_SECURITY_MODE_COMPLETE message identity | PC5-SP Message Type
12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| 15 | LSB of K D ID | LSB of K D ID
12.5.1.26 | O | TV | 3 | + +## 11.4.14 DIRECT\_SECURITY\_MODE\_REJECT + +### 11.4.14.1 Message definition + +This message is sent by a peer UE to a commanding UE to indicate a failure to establish the security. See table 11.4.14.1. + +Message type: DIRECT\_SECURITY\_MODE\_REJECT + +**Table 11.4.2.14.1: DIRECT\_SECURITY\_MODE\_REJECT message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|----------------------------------------------|-------------------------------------------------|----------|--------|--------| +| | DIRECT_SECURITY_MODE_REJECT message identity | PC5-SP Message Type
12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | PC5 Signalling Protocol Cause Value | PC5 Signalling Protocol Cause Value
12.5.1.7 | M | V | 1 | +| 10 | RAND | RAND
12.5.1.21 | O | TV | 17 | +| 9 | AUTS | AUTS
12.5.1.20 | O | TV | 15 | + +## 11.4.15 DIRECT\_REKEYING\_REQUEST + +### 11.4.15.1 Message definition + +This message is sent by a UE to the peer UE to refresh the security of an established direct link. See table 11.4.15.1. + +Message type: DIRECT\_REKEYING\_REQUEST + +**Table 11.4.15.1: DIRECT\_REKEYING\_REQUEST message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|------------------------------------------|-----------------------------------------|----------|--------|--------| +| | DIRECT_REKEYING_REQUEST message identity | PC5-SP Message Type
12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number
12.5.1.2 | M | V | 2 | +| | UE Security Capabilities | UE Security Capabilities
12.5.1.22 | M | V | 2 | +| | Nonce_1 | Nonce_1
12.5.1.30 | M | V | 16 | +| | MSB of K D-sess ID | MSB of K D-sess
12.5.1.25 | M | V | 1 | +| 21 | Auth Flag | Auth Flag
12.5.1.32 | O | TV | 2 | +| 8 | PRUK ID | PRUK ID
12.5.1.19 | O | TV | 9 | + +## 11.4.16 DIRECT\_REKEYING\_RESPONSE + +### 11.4.16.1 Message definition + +This message is sent by a UE to the peer UE to complete refreshing the security of an established direct link. See table 11.4.16.1.1. + +Message type: DIRECT\_REKEYING\_RESPONSE + +**Table 11.4.16.1: DIRECT\_REKEYING\_RESPONSE message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-------------------------------------------|-------------------------------|----------|--------|--------| +| | DIRECT_REKEYING_RESPONSE message identity | PC5-SP Message Type 12.5.1.1. | M | V | 1 | +| | Sequence Number | Sequence Number 12.5.1.2 | M | V | 2 | + +## 11.4.17 DIRECT\_REKEYING\_TRIGGER + +### 11.4.17.1 Message definition + +This message is sent by a UE to the peer UE to trigger the peer UE to initiate a direct link rekeying procedure to refresh $K_D$ . See table 11.4.17.1.1. + +Message type: DIRECT\_REKEYING\_TRIGGER + +**Table 11.4.17.1: DIRECT\_REKEYING\_TRIGGER message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|------------------------------------------|------------------------------|----------|--------|--------| +| | DIRECT_REKEYING_TRIGGER message identity | PC5-SP Message Type 12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number 12.5.1.2 | M | V | 2 | + +## 11.4.18 REMOTE\_UE\_INFO\_REQUEST + +### 11.4.18.1 Message definition + +This message is sent by the ProSe UE-to-network relay UE to the remote UE to initiate the remote UE information request procedure. See table 11.4.18.1.1. + +**Table 11.4.18.1.1: REMOTE\_UE\_INFO\_REQUEST content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|-----------------------------------------|--------------------------------------|----------|--------|--------| +| | REMOTE_UE_INFO_REQUEST message identity | Message Type 12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number 12.5.1.2 | M | V | 2 | +| | Remote UE Information Type | Remote UE Information Type 12.5.1.35 | M | V | 1 | + +## 11.4.19 REMOTE\_UE\_INFO\_RESPONSE + +### 11.4.19.1 Message definition + +This message is sent by the remote UE to the ProSe UE-to-network relay UE to respond to the remote UE information request. See table 11.4.19.1.1. + +**Table 11.4.19.1.1: REMOTE\_UE\_INFO\_RESPONSE content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|------------------------------------------|--------------------------|----------|--------|--------| +| | REMOTE_UE_INFO_RESPONSE message identity | Message Type 12.5.1.1 | M | V | 1 | +| | Sequence Number | Sequence Number 12.5.1.2 | M | V | 2 | +| 27 | IMEI | IMEI 12.5.1.36 | O | TV | 10 | + +## 11.5 Non-IP data PDU format + +The non-IP data PDU is coded according to figure 11.5.1 and table 11.5.1. + +![Diagram of Non-IP data PDU format showing a header with 8 spare bits and a 1-bit Non-IP type field, followed by a payload of n octets.](36e029cd5d353a7e9c2f28c3aa199066_img.jpg) + +The diagram illustrates the structure of a Non-IP data PDU. It consists of a header and a payload. The header is 1 octet long and contains 8 bits. Bits 8 through 1 are shown. Bits 8, 7, 6, 5, 4, 3, and 2 are spare bits. Bit 1 is the 'Non-IP type' field. The payload follows the header and consists of octets 2 through n. The label 'Non-IP payload' is centered within the payload section. + +Diagram of Non-IP data PDU format showing a header with 8 spare bits and a 1-bit Non-IP type field, followed by a payload of n octets. + +**Figure 11.5.1: Non-IP data PDU format****Table 11.5.1: Non-IP data PDU values** + +Octet 1 contains the non-IP type field which indicates the type of non-IP data included in the non-IP payload. + +Octets 2 to n contain the non-IP payload field containing the non-IP data. + +# 12 General message format and information elements coding + +## 12.1 Overview + +This clause contains general message format and information elements coding for the messages used in the procedures described in the present document. + +### 12.1A General + +The sending entity shall set the value of a spare bit to zero. The receiving entity shall ignore the value of a spare bit. + +The sending entity shall not set the value of a field to a reserved value. The receiving entity shall discard a message carrying a field with the value set to a reserved value. + +## 12.2 ProSe direct discovery message formats + +### 12.2.1 Data types format in XML schema + +To exchange structured information over the transport protocol, XML text format/notation is introduced. + +The corresponding XML data types for the data types used in ProSe messages are provided in table 12.2.1.1. + +**Table 12.2.1.1: Primitive or derived types for ProSe Parameter Type** + +| ProSe Parameter Type | Type in XML Schema | +|----------------------|--------------------| +| Integer | xs:integer | +| String | xs:string | +| Boolean | xs:boolean | +| Binary | xs:hexBinary | +| Bit string | xs:hexBinary | +| Time | xs:dateTime | + +For complex data types described in subclause 12.2.2, an XML "complexType" can be used. + +Message construction shall be compliant with W3C REC-xmlschema-2-20041028: "XML Schema Part 2: Datatypes" [7] + +## 12.2.2 Parameters in ProSe direct discovery messages + +### 12.2.2.1 Transaction ID + +This parameter is used to uniquely identify a PC3 Control Protocol for ProSe direct discovery transaction when it is combined with other PC3 Control Protocol for ProSe direct discovery transactions in the same transport message. The UE shall set this parameter to a new number for each outgoing new discovery request. The transaction ID is an integer in the 0-255 range. + +### 12.2.2.2 Command + +This parameter is used to indicate the type of discovery request (announce, monitor, query, or response) contained in a DISCOVERY\_REQUEST message. It is an integer in the 0-255 range encoded as follows: + +- 0 Reserved +- 1 announce +- 2 monitor +- 3 query +- 4 response +- 5 metadata\_update +- 6-255 Unused + +### 12.2.2.3 UE Identity + +This parameter is used to indicate the requesting UE's identity and is set to the IMSI. The coding of IMSI is defined in 3GPP TS 23.003 [4]. + +### 12.2.2.4 Prose Application ID + +This parameter is used to carry an identity used for open ProSe direct discovery, identifying application related information for the ProSe-enabled UE. It is coded as specified in 3GPP TS 23.003 [4]. + +### 12.2.2.5 Application Identity + +This parameter is used to identify the particular application that triggers the DISCOVERY\_REQUEST message. The format of the Application Identity consists of two parts: + +- OS ID: operating system identifier. The format of the OS ID is a Universally Unique Identifier (UUID) as specified in IETF RFC 4122 [8]; and +- OS App ID: a string containing the OS specific application identifier. + +NOTE: Further definition of the format of OS App ID is beyond the scope of this specification. + +### 12.2.2.6 ProSe Application Code + +This parameter is used to contain a ProSe Application Code. The format of the ProSe Application Code is as follows: + +- a) if the ProSe Application Code is included in a PC5\_DISCOVERY message or in a MATCH\_REPORT message and application-controlled extension is used, the ProSe Application Code is encoded as a 184 bitstring composed of: + - the ProSe Application Code Prefix; and + - the ProSe Application Code Suffix; or +- b) in all other cases, the ProSe Application is encoded as a 184 bitstring as defined in 3GPP TS 23.003 [4]. + +### 12.2.2.7 Validity Timer T4000 + +This parameter is used to carry the value of validity timer T4000 associated with a ProSe Application Code. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +### 12.2.2.8 PC3 Control Protocol cause value + +This parameter is used to indicate the particular reason why a DISCOVERY\_REQUEST or MATCH\_REPORT message from the UE has been rejected by the ProSe Function. It is an integer in the 0-255 range encoded as follows: + +- 0 Reserved +- 1 Invalid Application +- 2 Unknown ProSe Application ID +- 3 UE authorisation failure +- 4 Unknown ProSe Application Code +- 5 Invalid MIC +- 6 Invalid UTC-based counter +- 7 Invalid Message Format +- 8 Scope violation in ProSe Application ID +- 9 Unknown RPAUID +- 10 Unknown or Invalid Discovery Entry ID +- 11 Invalid Discovery Target +- 12 UE unauthorised for discovery with Application-Controlled Extension +- 13 UE unauthorised for on-demand announcing +- 14 Missing Application Level Container +- 15 Invalid Data in Application Level Container +- 16 Invalid Match Event +- 17 No Valid ProSe Application Code +- 18 Invalid UE Identity +- 19-255 Unused + +## 12.2.2.9 DiscoveryKey + +This parameter is used to carry a Discovery Key allocated by the ProSe Function. This key is used by the UE to compute the MIC that is included in the PC5\_DISCOVERY message. The format of Discovery Key is defined in 3GPP TS 33.303 [6]. + +## 12.2.2.10 Message Type + +This parameter is used to indicate the type of ProSe direct discovery. + +This parameter is coded as shown in figure 12.2.2.10.1 and table 12.2.2.10.1. + +![Figure 12.2.2.10.1: Message Type parameter diagram showing bit positions 8 to 1 and their corresponding fields: Discovery type (bits 8-7), Content Type (bits 6-3), Discovery model (bits 2-1), and octet 1.](6bd66a9f24bf7442862b8f3ab580297e_img.jpg) + +| | | | | | | | | +|----------------|---|--------------|---|---|-----------------|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| Discovery type | | Content Type | | | Discovery model | | octet 1 | + +Figure 12.2.2.10.1: Message Type parameter diagram showing bit positions 8 to 1 and their corresponding fields: Discovery type (bits 8-7), Content Type (bits 6-3), Discovery model (bits 2-1), and octet 1. + +Figure 12.2.2.10.1: Message Type parameter + +Table 12.2.2.10.1: Message Type parameter + +| | | | | | +|---------------------------------|----------|----------|----------|--------------------------------------------------------------------------------------| +| Discovery type value (octet 1) | | | | | +| Bit | | | | | +| 8 | 7 | | | | +| 0 | 0 | | | Reserved | +| 0 | 1 | | | Open discovery | +| 1 | 0 | | | Restricted discovery | +| 1 | 1 | | | Reserved | +| Content type value (octet 1) | | | | | +| Bit | | | | | +| 6 | 5 | 4 | 3 | | +| 0 | 0 | 0 | 0 | announce/response | +| 0 | 0 | 0 | 1 | query | +| 0 | 0 | 1 | 0 | application-controlled extension enabled | +| 0 | 0 | 1 | 1 | Reserved | +| 0 | 1 | 0 | 0 | UE-to-Network Relay Discovery Announcement or UE-to-Network Relay Discovery Response | +| 0 | 1 | 0 | 1 | UE-to-Network Relay Discovery Solicitation | +| 0 | 1 | 1 | 0 | Group Member Discovery Announcement or Group Member Discovery Response | +| 0 | 1 | 1 | 1 | Group Member Discovery Solicitation | +| 1 | 0 | 0 | 0 | Relay discovery additional information | +| 1 | 0 | 0 | 1 | Reserved | +| 1 | 0 | 1 | 0 | Reserved | +| 1 | 0 | 1 | 1 | Reserved | +| 1 | 1 | 0 | 0 | Reserved | +| 1 | 1 | 0 | 1 | Reserved | +| 1 | 1 | 1 | 0 | Reserved | +| 1 | 1 | 1 | 1 | Reserved | +| Discovery model value (octet 1) | | | | | +| Bit | | | | | +| 2 | 1 | | | | +| 0 | 0 | | | Reserved | +| 0 | 1 | | | Model A | +| 1 | 0 | | | Model B | +| 1 | 1 | | | Reserved | + +NOTE 1: Content Type '0000' (announce/response) is used for model A announcing and for model B discoveree operation. + +NOTE 2: Content Type '0100' (UE-to-Network Relay Discovery Announcement or UE-to-Network Relay Discovery Response) is used for model A announcing and for model B discoveree operation. + +NOTE 3: Content Type '0110' (Group Member Discovery Announcement or Group Member Discovery Response) is used for model A announcing and for model B discoveree operation. + +#### 12.2.2.11 MIC + +This parameter is used to carry the MIC (Message Integrity Check) associated with the ProSe Application Code contained in a PC5\_DISCOVERY message. + +#### 12.2.2.12 Discovery Filter + +The elements in the Discovery Filter parameter are listed below. + +- ProSe Application Code: The ProSe Application Code is used by a monitoring UE for full or partial matching of PC5\_DISCOVERY messages received on the PC5 interface (see subclause 12.2.2.6). Only one code is allowed in a Discovery Filter; +- ProSe Application Mask: a bitmask provided by the ProSe Function in order to allow the monitoring UE to perform a full matching or partial matching of PC5\_DISCOVERY messages received on the PC5 interface. A ProSe Application Mask with all bits set to "1" is used for full matching. One or more ProSe Application Masks may be included in a Discovery Filter. The length of the ProSe Application Mask is as same as the length of ProSe Application Code; and +- TTLTimer T4002: Time-to-live duration for which the associated Discovery Filter is valid, after which it shall not be used. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +#### 12.2.2.13 Void + +#### 12.2.2.14 Void + +#### 12.2.2.15 Void + +#### 12.2.2.16 Monitored PLMN ID + +This parameter is used to indicate the PLMN ID of the PLMN in which the PC5\_DISCOVERY message containing a ProSe Application Code for which there was a match event was received. It is coded as specified in 3GPP TS 23.003 [4]. + +#### 12.2.2.17 VPLMN ID + +This parameter is used to indicate the PLMN ID of the PLMN in which the requesting UE is registered. It is coded as specified in 3GPP TS 23.003 [4]. + +#### 12.2.2.18 UTC-based counter + +This parameter is used to indicate the UTC time associated with the discovery transmission opportunity in which a PC5\_DISCOVERY message is sent. It is expressed in unit of seconds and coded in binary format as the 32 least significant bits of the Coordinated Universal Time as defined in 3GPP TS 36.331 [12]. + +#### 12.2.2.19 Validity Timer T4004 + +This parameter is used to carry the value of Validity Timer T4004 associated with a ProSe Application Code for which there was a match event. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +#### 12.2.2.20 Metadata Flag + +This parameter is used to indicate whether the UE wishes to receive the latest metadata information associated with the ProSe Application ID or RPAUID in the MATCH\_REPORT\_ACK from the ProSe Function. It is a Boolean value coded as follows: + +False the UE does not wish to receive the latest metadata information associated with the ProSe Application ID or RPAUID in the MATCH\_REPORT\_ACK from the ProSe Function + +True the UE wishes to receive the latest metadata information associated with the ProSe Application ID or RPAUID in the MATCH\_REPORT\_ACK message from the ProSe Function + +### 12.2.2.21 Metadata + +This parameter is used to carry the metadata that is associated with the ProSe Application ID contained in the MATCH\_REPORT\_ACK message. The purpose of the metadata is to carry additional application-layer information associated with a particular ProSe Application ID. Examples of such information are postal address, phone number, URL etc. The length and contents of the metadata are out of scope of 3GPP. The format of the metadata is a UTF8-encoded string. + +### 12.2.2.22 UTC-based Counter LSB + +This parameter is used to carry: + +- the four least significant bits of the UTC-based counter associated with the discovery transmission opportunity used by the UE performing open ProSe direct discovery announcing; or +- the eight least significant bits of the UTC-based counter associated with the discovery transmission opportunity used by the UE performing ProSe direct discovery announcing for restricted ProSe direct discovery or for ProSe direct discovery for public safety use. + +This parameter is coded as shown in figures 12.2.2.22.1 and 12.2.2.22.2, and table 12.2.2.22.1. + +![](9c7ef62eff36ab5e484b36559eccfeaf_img.jpg) + +| | | | | | | | | | +|-------|---|---|---|--------------------------------|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | Four LSBs of UTC-based counter | | | | octet 1 | +| Spare | | | | | | | | | + +**Figure 12.2.2.22.1: UTC-based Counter LSB parameter for open ProSe direct discovery** + +![](e603b56838e455402e8751d9b39ae9b0_img.jpg) + +| | | | | | | | | | +|---------------------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Eight LSBs of UTC-based counter | | | | | | | | octet 1 | + +**Figure 12.2.2.22. 2: UTC-based Counter LSB parameter for restricted ProSe direct discovery and for ProSe direct discovery for public safety use** + +**Table 12.2.2.22.1: UTC-based Counter LSB parameter** + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UTC-based Counter LSB value (octet 1) | +| For open ProSe direct discovery:
Bits 1 to 4 of octet 1 are set to the four least significant bits of the UTC-based counter encoded as specified in subclause 12.2.2.18.

Bits 5 to 8 of octet 1 are spare and shall be coded as zero. | +| For restricted ProSe direct discovery and for ProSe direct discovery for public safety use:
Bits 1 to 8 of octet 1 are set to the eight least significant bits of the UTC-based counter encoded as specified in subclause 12.2.2.18 | + +### 12.2.2.23 Current Time + +This parameter is used to carry the current UTC-based time at the ProSe Function. The format of this parameter follows the XML data type defined in table 12.2.1.1 for ProSe parameter type "Time". + +### 12.2.2.24 Max Offset + +This parameter is used to indicate the maximum time difference between the time on the UE's ProSe clock and the UTC-based counter associated with the discovery slot in seconds, as specified in 3GPP TS 33.303 [6]. The Max Offset is an integer in the 1-32 range. + +### 12.2.2.25 Discovery Type + +This parameter is used to indicate the type of ProSe direct discovery contained in the DISCOVERY\_REQUEST message or MATCH\_REPORT message. It is an integer in the 0-3 range encoded as follows: + +- 0 Reserved +- 1 Open discovery +- 2 Restricted discovery +- 3 Unused + +### 12.2.2.26 Match Report Refresh Timer T4006 + +This parameter is used to carry the value of Match Report Refresh Timer T4006 associated with a ProSe Application Code for which there was a match event. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +### 12.2.2.27 Requested Timer + +During the announce request procedure for open ProSe direct discovery or restricted ProSe direct discovery model A, the Requested Timer element is used to carry the length of validity timer associated with the ProSe Application Code or the ProSe Restricted Code that the UE expects to receive from the ProSe Function. When the procedure is to inform the ProSe Function that the UE wants to stop announcing a ProSe Application Code or a ProSe Restricted Code before the associated valid timer expires, the Requested Timer shall be set to 0. + +During the monitor request procedure for open ProSe direct discovery or restricted ProSe direct discovery model A, the Requested Timer element is only used to inform the ProSe Function that the UE wants to stop monitoring using Discovery Filter(s) or Restricted Discovery Filter(s). The Requested Timer shall be set to 0. + +It is an integer in the 0-525600 range representing the timer value in unit of minutes. + +### 12.2.2.28 ProSe Function Transaction ID + +This parameter is used to uniquely identify a PC3 Control Protocol for ProSe direct discovery transaction when it is combined with other PC3 Control Protocol for ProSe direct discovery transactions in the same transport message. The ProSe Function shall set this parameter to a new number for each outgoing new request. The ProSe Function transaction ID is an integer in the 0-255 range. + +### 12.2.2.29 Update Info + +This parameter is used to carry either: + +- 1) the updated information for an announcing UE in restricted discovery with a new ProSe Restricted Code to replace the old one in the discovery entry and the corresponding validity timer. In this case the parameter shall contain the following: + - ProSe Restricted Code: See subclause 12.2.2.34; and + - Validity Timer T4007: See subclause 12.2.2.39. +- 2) the updated information for a monitoring UE in restricted discovery with a new set of Restricted Discovery Filters to be used for a given discovery entry. In this case the parameter shall contain one or more Restricted Discovery Filters as defined in subclause 12.2.2.37; +- 3) the updated information for an announcing UE in open discovery with a new ProSe Application Code to replace the old one in the discovery entry and the corresponding validity timer. In this case the parameter shall contain: + - ProSe Application Code: See subclause 12.2.2.6; and + - Validity Timer T4000: See subclause 12.2.2.7. + +- 4) the updated information for a monitoring UE in open discovery with a new set of Discovery Filters to be used for a given discovery entry. In this case the parameter shall contain one or more Discovery Filters defined in subclause 12.2.2.12. + +#### 12.2.2.30 RPAUID + +This parameter is used to carry the RPAUID (Restricted ProSe Application User ID), which is an identity used for restricted ProSe direct discovery, identifying application related information for the ProSe-enabled UE. + +#### 12.2.2.31 Announcing Type + +This parameter is used to indicate whether the UE requests on demand announcing in a DISCOVERY\_REQUEST message. It is an integer in the 0-255 range encoded as follows: + +- 0 normal +- 1 on demand +- 2-255 Unused + +#### 12.2.2.32 Application Level Container + +This parameter is used to carry the Application Level Container, which contains application-level data transparent to the 3GPP network transferred between the application client in the UE and the ProSe Application Server. + +#### 12.2.2.33 Discovery Entry ID + +This parameter is used to carry the Discovery Entry ID, which is an identity allocated by the ProSe Function to refer to a discovery entry in the UE's context as a result of a discovery request, either announcing or monitoring. It is an integer in the 0-65535 range. + +#### 12.2.2.34 ProSe Restricted Code + +This parameter is used to contain a ProSe Restricted Code. The format of the ProSe Restricted Code is as follows: + +- a) if the ProSe Restricted Code is included in a PC5\_DISCOVERY message or in a MATCH\_REPORT message and application-controlled extension is not used, the ProSe Restricted Code is encoded as a 184 bitstring composed of: + - the ProSe Restricted Code in the 64 most significant bits; and + - the remaining 120 bits set to zero; +- b) if the ProSe Restricted Code is included in a PC5\_DISCOVERY message or in a MATCH\_REPORT message and application-controlled extension is used, the ProSe Restricted Code is encoded as a 184 bitstring composed of + - the ProSe Restricted Code Prefix in the 64 most significant bits; + - the ProSe Restricted Code Suffix; and + - any remaining unused least significant bits set to zero; or +- c) in all other cases, the ProSe Restricted Code is encoded as a 64 bitstring as defined in 3GPP TS 23.003 [4]. + +#### 12.2.2.35 ProSe Restricted Code Suffix Range + +This parameter is used to carry a range of consecutive ProSe Restricted Code Suffixes, each of which can be appended by the UE to a ProSe Restricted Code Prefix (see subclause 12.2.2.34) for restricted ProSe direct discovery with application-controlled extension. A ProSe Restricted Code Suffix Range includes a Beginning Suffix Code and optionally an Ending Suffix Code, as described below: + +- Beginning Suffix Code: The bit-length of this bit string reflects the length of the suffix portion of the ProSe Restricted Code allocated by the ProSe Application Server for an RPAUID based on application configuration. The binary value of this code is the lowest value of the ProSe Restricted Code Suffix range. + +- Ending Suffix Code: The binary value of this code is the highest value of the ProSe Restricted Code Suffix range. The length of the Ending Suffix Code shall be the same as that of the Beginning Suffix Code. + +If the ProSe Restricted Code Suffix Range contains only a single ProSe Restricted Code Suffix, then that suffix is represented by the Beginning Suffix Code, and the Ending Suffix Code is omitted. + +### 12.2.2.36 On Demand Announcing Enabled Indicator + +This parameter is used to carry the on demand announcing enabled indicator, which is a Boolean value indicating whether on demand announcing is enabled or not in the ProSe Function. + +### 12.2.2.37 Restricted Discovery Filter + +This parameter is used to carry the Discovery Filter(s) used to monitor an individual target RPAUID in restricted ProSe direct discovery model A. It contains one or more filter(s), TTL timer T4009, optionally an RPAUID parameter identifying the target RPAUID, security parameters such as Discovery User Scrambling Key, Discovery User Integrity Key and Discovery User Confidentiality Key, optionally a metadata indicator, and optionally the corresponding metadata. The elements in the Restricted Discovery Filter parameter are defined as below. + +- Filter: a matching filter used for restricted ProSe direct discovery model A monitoring. It contains one code and one or more masks. The code is used by a monitoring UE for full or partial matching of PC5\_DISCOVERY messages received on the PC5 interface with a ProSe Restricted Code (see subclause 12.2.2.34). Only one code is allowed in a filter. The mask is a bitmask provided by the ProSe Function in order to allow the monitoring UE to perform a full matching or partial matching of PC5\_DISCOVERY messages received on the PC5 interface. A mask with all bits set to "1" is used for full matching. One or more masks may be included in a filter. The length of the mask is the same as the length of the code; +- TTLTimer T4009: Time-to-live duration for which the associated Restricted Discovery Filter is valid, after which it shall not be used. It is an integer in the 1-525600 range representing the timer value in unit of minutes; +- RPAUID: identifier of the target RPAUID to be monitored; +- DUSK (Discovery User Scrambling Key): an optional key which is allocated by the ProSe Function and is used by the monitoring UE or discoverer UE for unscrambling the PC5\_DISCOVERY message containing the ProSe Restricted Code in restricted ProSe direct discovery. The format of the DUSK is defined in 3GPP TS 33.303 [6]; +- DUIK (Discovery User Integrity Key) or a MIC Check Indicator :DUIK is an optional key which is allocated by the ProSe Function and is used by the UE to compute the MIC that is included in the PC5\_DISCOVERY message containing the ProSe Restricted Code in restricted ProSe direct discovery. The format of the DUIK is defined in 3GPP TS 33.303 [6]. When the DUIK is absent, an optional MIC Check Indicator parameter may be included to inform a UE receiving PC5\_DISCOVERY messages that the MIC field needs to be checked by sending a MATCH\_REPORT message to the ProSe Function; +- DUCK material: an optional parameter containing a DUCK (Discovery User Confidentiality Key) and an Encrypted Bitmask. The DUCK is allocated by the ProSe Function and is used by the UE to decrypt a portion of the PC5\_DISCOVERY message in restricted ProSe direct discovery. The format of the DUCK is defined in 3GPP TS 33.303 [6]. The Encrypted Bitmask is a 184-bit bitmask which uses bit "1" to mark the positions of the bits for which the DUCK encryption is applied; +- Metadata indicator: It contains the information element defined in subclause 12.2.2.65; and +- Metadata: application-layer metadata associated with the monitoring target. + +### 12.2.2.38 ACE Enabled Indicator + +This parameter is used to indicate whether application-controlled extension for open ProSe direct discovery or restricted ProSe direct discovery is enabled. It is an integer value in the 0-255 range encoded as follows: + +- 0 Reserved +- 1 Normal +- 2 Application-controlled extension enabled +- 3-255 Unused + +#### 12.2.2.39 Validity Timer T4007 + +This parameter is used to carry the value of validity timer T4007 associated with a ProSe Restricted Code or ProSe Restricted Code Prefix. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +#### 12.2.2.40 Restricted Code Security Material + +This parameter is used as a container for the information necessary for security keys and algorithms protecting the sending or receiving of restricted ProSe direct discovery messages over the PC5 interface. The elements in the Restricted Code Security Material parameter are listed below: + +- DUSK (Discovery User Scrambling Key): an optional key which is allocated by the ProSe Function and is used by the UE for scrambling or unscrambling the PC5\_DISCOVERY message containing the ProSe Restricted Code in restricted ProSe direct discovery. The format of the DUSK is defined in 3GPP TS 33.303 [6]; +- DUIK (Discovery User Integrity Key): an optional key which is allocated by the ProSe Function and is used by the UE to compute the MIC that is included in the PC5\_DISCOVERY message containing the ProSe Restricted Code in restricted ProSe direct discovery. The format of the DUIK is defined in 3GPP TS 33.303 [6]; and +- DUCK (Discovery User Confidentiality Key) and associated Encrypted Bitmask): DUCK is an optional key which is allocated by the ProSe Function and is used by the UE to encrypt a portion of the PC5\_DISCOVERY message containing the ProSe Restricted Code in restricted ProSe direct discovery. The format of the DUCK is defined in 3GPP TS 33.303 [6]. The Encrypted Bitmask is a 184-bit bitmask which uses bit "1" to mark the positions of the bits for which the DUCK encryption is applied. + +#### 12.2.2.41 Discovery Model + +This parameter is used to indicate the model of ProSe direct discovery contained in the DISCOVERY\_REQUEST message. It is an integer in the 0-3 range encoded as follows: + +- 0 Reserved +- 1 Model A +- 2 Model B +- 3 Unused + +#### 12.2.2.42 ProSe Response Code + +This parameter is used to carry the ProSe Response Code. It is a bit string coded as specified in 3GPP TS 23.003 [4]. + +#### 12.2.2.43 Discovery Query Filter + +This parameter is used to carry the Discovery Query Filter that is allocated by the ProSe Function in the HPLMN to the Discoveree UE for restricted Model B discovery, for a particular RPAUID. The elements in the Discovery Query Filter parameter are defined as below. + +- Code: The code is used by a Discoveree UE for full or partial matching of PC5\_DISCOVERY messages received on the PC5 interface containing a ProSe Query Code. Only one code is allowed in a Discovery Query Filter; +- Mask: The mask is a bitmask provided by the ProSe Function in order to allow the Discoveree UE to perform a full matching or partial matching of PC5\_DISCOVERY messages received on the PC5 interface containing the ProSe Query Code. A mask with all bits set to "1" is used for full matching. One or more masks may be included in a filter. The length of the mask is the same as the length of the code. + +#### 12.2.2.44 Validity Timer T4011 + +This parameter is used to carry the value of validity timer T4011 associated with a ProSe Response Code and corresponding Discovery Query Filter(s). It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +### 12.2.2.45 Subquery Result + +This parameter is used to contain the information allocated by the ProSe Function related to one particular query target RPAUID which the discoverer UE intends to query with restricted ProSe direct discovery Model B. It contains one ProSe Query Code, one or more Discovery Response Filter(s), Validity Timer T4013, an RPAUID parameter identifying the target RPAUID, Restricted Security and optionally the corresponding metadata. The elements in the Subquery Result parameter are defined as below. + +- ProSe Query Code: It is a ProSe Restricted Code allocated by the ProSe Function to a discoverer UE to solicit the response from a discoveree UE for a particular target RPAUID. +- Discovery Response Filter: It contains one code and one or more masks to be used to matching ProSe Response Code, as described in subclause 6.2.3B.4. The code is used by a discoverer UE to represent a targeted ProSe Response Code (see subclause 12.2.2.42). The mask is a bitmask provided by the ProSe Function in order to allow the discoverer UE to perform a full matching or partial matching of PC5\_DISCOVERY messages received on the PC5 interface containing the ProSe Response Code. A mask with all bits set to "1" is used for full matching. The length of the mask is the same as the length of the code. +- Validity Timer T4013: It represents the validity time associated with a ProSe Query Code and corresponding Discovery Response Filter(s). It is an integer in the 1-525600 range representing the timer value in unit of minutes. +- Restricted Security: It contains the information element defined in subclause 12.2.2.40. +- RPAUID: identifier of the target RPAUID to be monitored. +- Metadata: application-layer metadata associated with the querying target. + +### 12.2.2.46 ProSe Restricted Code Prefix + +This parameter is used to contain a ProSe Restricted Code Prefix, whose format is defined in 3GPP TS 23.003 [4]. + +### 12.2.2.47 ProSe Restricted Code Suffix + +This parameter is used to contain a ProSe Restricted Code Suffix, whose format is defined in 3GPP TS 23.003 [4]. If the size of ProSe Restricted Code Suffix is less than 120 bits, the information element shall be padded with zeros in the least significant bits. + +### 12.2.2.48 ProSe UE ID + +The ProSe UE ID parameter is used to indicate a ProSe UE ID. The value of the ProSe UE ID parameter is a 24-bit long bit string. + +### 12.2.2.49 ProSe Relay UE ID + +The ProSe Relay UE ID parameter is used to indicate a ProSe Relay UE ID. The value of the ProSe Relay UE ID parameter is a 24-bit long bit string. + +### 12.2.2.50 User Info ID + +The User Info ID parameter carries a User Info ID as specified in 3GPP TS 23.303 [2]. The value of the User Info ID parameter is a 48-bit long bit string. The format of the User Info ID parameter is out of scope of this specification. + +NOTE: Depending on operation, User Info ID is indicated as the Announcer Info parameter, the Discoverer Info parameter or the Discoveree Info parameter. + +### 12.2.2.51 Relay Service Code + +The Relay Service Code parameter identifies a connectivity service the UE-to-Network relay provides. The value of the Relay Service Code parameter is a 24-bit long bit string. The format of the Relay Service Code parameter is out of scope of this specification. + +### 12.2.2.52 Target User Info + +The Target User Info parameter is used to provide the User Info ID of the targeted discoveree user. The value of the Target User Info parameter is a 48-bit long bit string. + +### 12.2.2.53 Target Group Info + +The Target Group Info parameter is used to provide the identifier of the targeted group (e.g. ProSe Layer 2 Group ID). The value of the Target Group Info parameter is 24-bit long bit string. + +### 12.2.2.54 Discovery Group ID + +The Discovery Group ID parameter carries an identifier of a discovery group that the UE belongs to. The value of the Discovery Group ID parameter is a 24-bit long bit string. The format of the Discovery Group ID parameter is out of scope of this specification. + +### 12.2.2.55 GMDS Composition + +This parameter is used to indicate the content of the PC5\_DISCOVERY message for Group Member Discovery Solicitation. + +This parameter is coded as shown in figure 12.2.2.55.1 and table 12.2.2.55.1. + +![](78a16fd827b60bf2582c349e28e0dfe6_img.jpg) + +| | | | | | | | | | +|------|------|-------|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| TUII | TGII | Spare | | | | | | octet 1 | + +**Figure 12.2.2.55.1: GMDS Composition parameter** + +**Table 12.2.2.55.1: GMDS Composition parameter** + +| | | +|-----------------------------------------------------------------------------------|------------------------------------------------| +| TUII (octet 1) | | +| Bit | | +| 8 | | +| 0 | Target User Info is not included (see NOTE 1) | +| 1 | Target User Info is included (see NOTE 1) | +| TGII (octet 1) | | +| Bit | | +| 7 | | +| 0 | Target Group Info is not included (see NOTE 1) | +| 1 | Target Group Info is included (see NOTE 1) | +| Bits 1 to 6 of octet 1 are spare and shall be coded as zero (see NOTE 2). | | +| NOTE 1: The TUII and TGII shall not be set to the same value. | | +| NOTE 2: Bits 1 to 6 of octet 1 were reserved in earlier versions of the protocol. | | + +### 12.2.2.56 Spare + +This parameter is a string of spare bits. The length of this parameter is variable and is indicated in a message where this parameter is included. + +### 12.2.2.57 RDAI Composition + +This parameter is used to indicate the content of the PC5\_DISCOVERY message for Relay Discovery Additional Information. + +This parameter is coded as shown in figure 12.2.2.57.1 and table 12.2.2.57.1. + +![](9f5f9afcedaa0d9b7991976f5000865c_img.jpg) + +| | | | | | | | | | +|--------|-------|-------|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| MBMSRI | ECGII | Spare | | | | | | octet 1 | + +**Figure 12.2.2.57.1: RDAI Composition IE parameter** + +**Table 12.2.2.57.1: RDAI Composition IE parameter** + +| | | +|------------------------------------------------------------------------------------------------------|------------------------------------------| +| MBMS related information (octet 1) | | +| Bit | | +| 8 | | +| 0 | MBMS related information is not included | +| 1 | MBMS related information is included | +| ECGI information (octet 1) | | +| Bit | | +| 7 | | +| 0 | ECGI information is not included | +| 1 | ECGI information is included | +| Bits 1 to 6 of octet 1 are spare and shall be coded as zero (see NOTE 2). | | +| NOTE 1: Either the ECGI information or the MBMS related information is to be included, but not both. | | +| NOTE 2: Bits 1 to 6 of octet 1 were reserved in earlier versions of the protocol. | | + +## 12.2.2.58 ECGI + +This parameter is used to indicate the ECGI of the serving cell where the ProSe UE-to-network relay UE is camping. + +The UE-to-network relay ECGI parameter is coded as shown in figure 12.2.2.58 and table 12.2.2.58. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|-------------|---|---|---|-------------|---|---|---------| +| | MCC digit 2 | | | | MCC digit 1 | | | octet 1 | +| | MNC digit 3 | | | | MCC digit 3 | | | octet 2 | +| | MNC digit 2 | | | | MNC digit 1 | | | octet 3 | +| | ECI digit 2 | | | | ECI digit 1 | | | octet 4 | +| | ECI digit 4 | | | | ECI digit 3 | | | octet 5 | +| | ECI digit 6 | | | | ECI digit 5 | | | octet 6 | +| | Spare | | | | ECI digit 7 | | | octet 7 | + +**Figure 12.2.2.58.1: UE-to-network relay ECGI parameter** + +**Table 12.2.2.58.1: UE-to-network relay ECGI parameter** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MCC, Mobile country code (octet 1, octet 2 bits 1 to 4)
The MCC field is coded as in ITU-T Rec. E.212 [32], Annex A. | +| MNC, Mobile network code (octet 2 bits 5 to 8, octet 3)
The coding of this field is the responsibility of each administration but BCD coding shall be used. If MNC consists of 2 digits, Bits 5 to 8 of octet 2 is coded as "1111". | +| ECI, E-UTRAN cell identity (octet 4, octet 5, octet 6, octet 7 bits 1 to 4)
The ECI field is coded as in 3GPP TS 23.003 [4]. | +| Spare(octet 7 bits 5 to 8)
The Spare field is coded as zeros. | + +## 12.2.2.59 MBMS related information + +This parameter is used to indicate a TMGI and its corresponding ProSe Layer-2 Group ID. + +The MBMS related information parameter is coded as shown in figure 12.2.2.59.1 and table 12.2.2.59.1. + +![Figure 12.2.2.59.1: TMGIs and ProSe Layer-2 Group IDs parameter diagram. The diagram shows a rectangular box divided into two horizontal sections. The top section is labeled 'TMGI' and the bottom section is labeled 'ProSe Layer-2 Group ID'. Above the box, bits 8 through 1 are indicated. To the right of the box, octets 1 through 9 are listed, with octets 1-6 corresponding to the TMGI section and octets 7-9 corresponding to the ProSe Layer-2 Group ID section.](cfd911568094b540490a86efe5c0ead6_img.jpg) + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 8      7      6      5      4      3      2      1
TMGI
ProSe Layer-2 Group ID
| octet 1
octet 2
octet 3
octet 4
octet 5
octet 6
octet 7
octet 8
octet 9 | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| + +Figure 12.2.2.59.1: TMGIs and ProSe Layer-2 Group IDs parameter diagram. The diagram shows a rectangular box divided into two horizontal sections. The top section is labeled 'TMGI' and the bottom section is labeled 'ProSe Layer-2 Group ID'. Above the box, bits 8 through 1 are indicated. To the right of the box, octets 1 through 9 are listed, with octets 1-6 corresponding to the TMGI section and octets 7-9 corresponding to the ProSe Layer-2 Group ID section. + +**Figure 12.2.2.59.1: TMGIs and ProSe Layer-2 Group IDs parameter** + +**Table 12.2.2.59.1: TMGIs and ProSe Layer-2 Group IDs parameter** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TMGI (octets 1 to 6) | +| The TMGI field is coded exactly same as octet 3 to octet 8 of TMGI element in the figure 10.5.154/3GPP TS 24.008 [30] and table 10.5.168/3GPP TS 24.008 [30]. | +| ProSe Layer-2 Group ID (octets 7 to 9) | +| The ProSe Layer-2 Group ID field contains a ProSe Layer-2 Group ID. | + +## 12.2.2.60 Validity Timer T4016 + +This parameter is used to carry the value of Validity Timer T4016 associated with a ProSe Restricted Code for which there was a match event. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +## 12.2.2.61 Match Report Refresh Timer T4017 + +This parameter is used to carry the value of Match Report Refresh Timer T4017 associated with a ProSe Restricted Code for which there was a match event. It is an integer in the 1-525600 range representing the timer value in unit of minutes. + +## 12.2.2.62 Metadata Index Mask + +This parameter is a bitmask provided by the ProSe Function in order to indicate the portion used for the Metadata Index in the ProSe Application Code for the monitoring UE. The length of the Metadata Index Mask is as same as the length of ProSe Application Code. + +## 12.2.2.63 Network-Initiated Transaction Method + +This parameter is used to indicate the method enabling transport of PC3 messages for ProSe Function-initiated ProSe direct discovery procedures. It is an integer in the 0-255 range encoded as follows: + +- 0 Unused +- 1 HTTP long polling +- 2-255 Unused + +## 12.2.2.64 Announcing PLMN ID + +This parameter is used to indicate the PLMN ID of the PLMN operating the radio resources which the UE intends to use for transmitting a PC5\_DISCOVERY message. It is coded as specified in 3GPP TS 23.003 [4]. + +## 12.2.2.65 Metadata Indicator + +This parameter is used to indicate whether there is a metadata associated with the target RPAUID. It is an integer value in the 0-255 range encoded as follows: + +- 0 No metadata associated + +- 1 Metadata associated +- 2-255 Unused + +## 12.2.2.66 URDS Composition + +This parameter is used to indicate the content of the PC5\_DISCOVERY message for UE-to-Network Relay Discovery Solicitation. + +This parameter is coded as shown in figure 12.2.2.66.1 and table 12.2.2.66.1. + +![Figure 12.2.2.66.1: URDS Composition parameter diagram. It shows a byte structure for octet 1. Bit 8 is labeled 'PRUII' and bits 7 through 1 are labeled 'Spare'.](58584484e1b78db31cf28c342cb7ac74_img.jpg) + +| | | | | | | | | | +|-------|-------|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| PRUII | Spare | | | | | | | octet 1 | + +Figure 12.2.2.66.1: URDS Composition parameter diagram. It shows a byte structure for octet 1. Bit 8 is labeled 'PRUII' and bits 7 through 1 are labeled 'Spare'. + +**Figure 12.2.2.66.1: URDS Composition parameter** + +**Table 12.2.2.66.1: URDS Composition parameter** + +| | | +|---------------------------------------------------------------------------------|-----------------------------------| +| PRUII (octet 1) | | +| Bit | | +| 8 | | +| 0 | ProSe Relay UE ID is not included | +| 1 | ProSe Relay UE ID is included | +| Bits 1 to 7 of octet 1 are spare and shall be coded as zero (see NOTE). | | +| NOTE: Bits 1 to 7 of octet 1 were reserved in earlier versions of the protocol. | | + +## 12.2.2.67 Status Indicator + +This parameter is used to indicate the status of ProSe UE-to-network relay. + +This parameter is coded as shown in figure 12.2.2.67.1 and table 12.2.2.67.1. + +Resource Status Indicator (RSI) is used to indicate whether or not the UE has resources available to provide a connectivity service for additional ProSe-enabled public safety UEs. + +![Figure 12.2.2.67.1: Status Indicator parameter diagram. It shows a byte structure for octet 1. Bit 8 is labeled 'RSI' and bits 7 through 1 are labeled 'Spare'.](856d74cd46a3f383d2ffd19352028610_img.jpg) + +| | | | | | | | | | +|-----|-------|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| RSI | Spare | | | | | | | octet 1 | + +Figure 12.2.2.67.1: Status Indicator parameter diagram. It shows a byte structure for octet 1. Bit 8 is labeled 'RSI' and bits 7 through 1 are labeled 'Spare'. + +**Figure 12.2.2.67.1: Status Indicator parameter** + +**Table 12.2.2.67.1: Status Indicator parameter** + +| | | +|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| RSI (octet 1) | | +| Bit | | +| 8 | | +| 0 | the UE does not have resources available to provide a connectivity service for additional ProSe-enabled public safety UEs | +| 1 | the UE has resources available to provide a connectivity service for additional ProSe-enabled public safety UEs | +| Bits 1 to 7 of octet 1 are spare and shall be coded as zero (see NOTE). | | +| NOTE: Bits 1 to 7 of octet 1 were reserved in earlier versions of the protocol. | | + +## 12.2.2.68 ProSe Application Code Prefix + +This parameter is used to contain a ProSe Application Code Prefix. Its length indicates the size in bits of the allocated prefix, which can take any value that is a multiple of 8 in the 32 to 176 range. + +NOTE: The size of the prefix for a given application is determined by the ProSe Application Server and made known to the ProSe Function by means that are out of scope of 3GPP. + +### 12.2.2.69 ProSe Application Code Suffix + +This parameter is used to contain a ProSe Application Code Suffix. The ProSe Application Code Suffix is used with a ProSe Application Code Prefix to form a 184-bit ProSe Application Code for open ProSe direct discovery with application-controlled extension. + +### 12.2.2.70 ProSe Application Code ACE + +This parameter is used to carry a set of ProSe Application Code(s) allocated for a corresponding ProSe Application ID when application-controlled extension is used. It contains one ProSe Application Code Prefix, and one or more ProSe Application Code Suffix Range(s). The elements in the ProSe Application Code ACE parameter are defined as below: + +- ProSe Application Code Prefix: as defined in subclause 12.2.2.68; +- ProSe Application Code Suffix Range: this parameter is used to carry a range of consecutive ProSe Application Code Suffixes (see subclause 12.2.2.69). A ProSe Application Code Suffix Range includes a Beginning Suffix Code and optionally an Ending Suffix Code, as described below: + - Beginning Suffix Code: The bit-length of this bit string reflects the length of the suffix portion of the ProSe Application Code allocated by the ProSe Application Server for a ProSe Application ID based on application configuration. The binary value of this code is the lowest value of the ProSe Application Code Suffix range. + - Ending Suffix Code: The binary value of this code is the highest value of the ProSe Application Code Suffix range. The length of the Ending Suffix Code shall be the same as that of the Beginning Suffix Code. + +If the ProSe Application Code Suffix Range contains only a single ProSe Application Code Suffix, then that suffix is represented by the Beginning Suffix Code, and the Ending Suffix Code is omitted. + +### 12.2.2.71 PC5\_tech + +This parameter is used to indicate the PC5 radio technology in order to enable co-ordination between the announcing and monitoring side. + +This parameter is coded as shown in figure 12.2.2.71.1 and table 12.2.2.71.1. + +![Diagram of the PC5_tech parameter structure. It shows a byte (octet 1) divided into 8 bits. Bits 8 through 3 are labeled 'Spare'. Bit 2 is labeled 'WLAN'. Bit 1 is labeled 'E-UTRA'.](6234e6bbe2492677ef77d06cbaca2708_img.jpg) + +| | | | | | | | | | +|-------|---|---|---|---|---|------|--------|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | octet 1 | +| Spare | | | | | | WLAN | E-UTRA | | + +Diagram of the PC5\_tech parameter structure. It shows a byte (octet 1) divided into 8 bits. Bits 8 through 3 are labeled 'Spare'. Bit 2 is labeled 'WLAN'. Bit 1 is labeled 'E-UTRA'. + +Figure 12.2.2.71.1: PC5\_tech parameter + +Table 12.2.2.71.1: PC5\_tech parameter + +| | | +|--------------------------------------------------------------|---------------------| +| PC5_tech (octet 1) | | +| Bit | | +| 1 | | +| 0 | E-UTRA not included | +| 1 | E-UTRA is included | +| Bit | | +| 2 | | +| 0 | WLAN not included | +| 1 | WLAN is included | +| Bits 3 to 8 of octet 1 are spare and shall be coded as zero. | | + +## 12.3 EPC-level ProSe discovery message formats + +### 12.3.1 Data types format in XML schema + +To exchange structured information over the transport protocol, XML text format/notation is introduced. XML data type definitions and requirements as specified in subclause 12.2.1 apply. + +### 12.3.2 Information elements in EPC-level ProSe discovery messages + +#### 12.3.2.1 Transaction ID + +This parameter is used to uniquely identify a PC3 Control Protocol for EPC-level ProSe discovery transaction when it is combined with other PC3 Control Protocol for EPC-level ProSe discovery transactions in the same transport message. The UE shall set this parameter to a new number for each outgoing new discovery request. The transaction ID is an integer in the 0-255 range. + +#### 12.3.2.2 UE Identity + +This parameter is used to indicate the requesting UE's identity and is set to the IMSI. The coding of IMSI is defined in 3GPP TS 23.003 [4]. + +#### 12.3.2.3 Application Identity + +This parameter is used to identify the particular application that triggers the APPLICATION\_REGISTRATION\_REQUEST message. The format of the Application Identity consists of two parts: + +- OS ID: operating system identifier. The format of the OS ID is a Universally Unique Identifier (UUID) as specified in IETF RFC 4122 [8]; and +- OS App ID: a string containing the OS specific application identifier. + +NOTE: Further definition of the format of OS App ID is beyond the scope of this specification. + +#### 12.3.2.4 Application Layer User ID + +This parameter is used to carry an Application Layer User ID that identifies the user in the context of specific application. It is encoded as a bit string. + +#### 12.3.2.5 PC3 EPC Control Protocol cause value + +This parameter is used to indicate the particular reason why either the UE or the ProSe function sends the UE\_DEREGISTRATION\_REQUEST message or why the following messages have been rejected by the ProSe Function: + +- UE\_REGISTRATION\_REQUEST; +- APPLICATION\_REGISTRATION\_REQUEST; +- PROXIMITY\_REQUEST; and +- PROXIMITY\_REQUEST\_VALIDATION. + +It is an integer in the 0-255 range encoded as follows: + +- 0 Reserved +- 1 Invalid Application +- 2 UE authorisation failure +- 3 Invalid Message Format +- 4 Application not registered +- 5 Range class not allowed for this application + +- 6 Proximity detection unlikely within requested time window +- 7 Targeted user not registered for this application +- 8 Proximity validation rejected by B-side +- 9 Application disabled temporarily +- 10 Invalid Application Layer User ID +- 11-255 Unused + +#### 12.3.2.6 WLAN Link Layer ID + +This parameter is used to carry WLAN link layer identifier. The value of WLAN Link Layer ID is coded as a bit string of length 48. + +#### 12.3.2.7 EPC ProSe User ID + +This parameter is used to carry an EPC ProSe User ID that identifies the UE registered for EPC-level ProSe Discovery in the context of the ProSe Function. It is specified in 3GPP TS 23.003 [4]. + +#### 12.3.2.8 Range Class + +This parameter is used to carry one range class used for APPLICATION\_REGISTRATION\_RESPONSE or PROXIMITY\_REQUEST messages. It is an integer in the 0-255 range encoded as follows: + +- 0 Reserved +- 1 0-50 m +- 2 0-100 m +- 3 0-200 m +- 4 0-500 m +- 5 0-1000 m +- 6-255 Unused + +#### 12.3.2.9 Time Window + +This parameter is used to specify a time interval in minutes during which a proximity request is valid. The Time Window is an integer in the range of 1 – 1440 minutes. + +#### 12.3.2.10 Void + +#### 12.3.2.11 UE Location + +The UE Location is set to the cell identity part of the Evolved Cell Global Identifier, as described in 3GPP TS 36.331 [12] and obtained from the lower layers of the UE. The value of UE Location is a bit string coded as specified in 3GPP TS 36.331 [12]. + +#### 12.3.2.12 WLAN Indication + +This parameter is used to carry an indication of whether the searching UE wishes to engage in WLAN direct discovery and communication subsequent to successful proximity detection. It is a Boolean value coded as follows: + +- False the searching UE does not wish to engage in WLAN direct discovery and communication subsequent to successful proximity detection +- True the searching UE wishes to engage in WLAN direct discovery and communication subsequent to successful proximity detection + +### 12.3.2.13 Assistance Information + +This parameter is used to carry information for expediting WLAN direct discovery and communication. The content of this parameter depends on the WLAN technology. + +Wi-Fi Peer-to-Peer (P2P) specification [13] defines an architecture and set of protocols that facilitate direct discovery and communication using the IEEE 802.11 technology [14]. To assist WLAN direct discovery and communication as required by the Wi-Fi P2P technology, the Assistance Information includes the following parameters. + +- SSID: The SSID to use for Wi-Fi P2P operation. To be compliant with the Wi-Fi P2P specification [13] the SSID should be in the form "DIRECT-ab" where a, b are two random characters; +- WLAN Secret Key: The pre-shared key to be used by UEs to secure their Wi-Fi P2P communication. This is used by UEs as the Pairwise Master Key (PMK); +- Group Owner indication: If set, the UE should implement the Group Owner (GO) functionality specified in the Wi-Fi P2P specification [13]. The UE implementing this functionality essentially becomes an AP that transmits Beacons with the P2P Information Element and accepts associations from other Wi-Fi P2P devices or from legacy Wi-Fi devices (those not implementing the Wi-Fi P2P functionality). If not set, the UE should behave as a Wi-Fi P2P client that attempts to discover and associate with a GO; +- P2P Device Address of self: This is the WLAN Link Layer ID to be used by UE to advertise itself. A UE implementing the Group Owner and indicates the WLAN Direct device from which the GO should accept WLAN association requests. Association requests from all other WLAN devices should be rejected by GO. +- P2P Device Address of peers: This is the WLAN Link Layer ID to be used by UE to discover peer UEs. A UE implementing the Group Owner should accept WLAN association requests only from devices that are in this list; +- Operation channel: The channel on which Wi-Fi P2P discovery and communication should take place; and +- Validity time: The time period during which the content provided in the assistance information is valid. + +### 12.3.2.14 Method for server-initiated transaction + +This parameter is used to indicate the capability of the UE to support methods other than OMA Push (e.g., HTTP long polling method) for server initiated procedures for EPC-level ProSe discovery. It is an integer in the 0-255 range encoded as follows: + +- 0 No extra methods available +- 1 HTTP long polling +- 2-255 Unused + +### 12.3.2.15 Method for server-initiated transaction configuration + +This parameter is used to indicate the preference of a server-initiated method type to be used by the UE and the ProSe Function for server-initiated procedures for EPC-level ProSe discovery other than OMA Push (e.g., HTTP long polling). It is an integer in the 0-255 range encoded as follows: + +- 0 The ProSe Function does not prefer other method +- 1 HTTP long polling +- 2-255 Unused + +## 12.4 Formats for messages transmitted over the PC3ch interface + +### 12.4.1 Data types format in XML schema + +To exchange structured information over the transport protocol, XML text format/notation is introduced. + +The corresponding XML data types for the data types used in ProSe PC3ch messages are provided in table 12.4.1. + +**Table 12.4.1: Primitive or derived types for ProSe PC3ch Parameter Type** + +| ProSe Parameter Type | Type in XML Schema | +|----------------------|--------------------| +| Integer | xs:integer | +| String | xs:string | +| Boolean | xs:boolean | +| Binary | xs:hexBinary | +| Bit string | xs:hexBinary | +| Time | xs:dateTime | + +For complex data types described in subclause 12.4.2, an XML "complexType" can be used. + +Message construction shall be compliant with W3C REC-xmlschema-2-20041028: "XML Schema Part 2: Datatypes" [7]. + +## 12.4.2 Parameters in messages transmitted over the PC3ch interface + +### 12.4.2.1 Transaction ID + +This parameter is used to uniquely identify a message transmitted over the PC3ch interface when it is combined with another message transmitted over the PC3ch interface in the same transport message. The UE shall set this parameter to a new number for each outgoing new message which includes this information element and is transmitted over the PC3ch interface. The transaction ID is an integer in the 0-255 range. + +### 12.4.2.2 UE Identity + +This parameter is used to indicate the requesting UE's identity and is set to the IMSI. The coding of IMSI is defined in 3GPP TS 23.003 [4]. + +### 12.4.2.3 Sequence number + +This parameter is used to indicate sequence number of the usage information report. The sequence number is an integer in the 0-4294967295 range. The sequence number is set to 0 on UE power up and is increased by 1 whenever a new usage information report is created. + +### 12.4.2.4 In coverage + +This parameter is used to indicate whether the UE was in E-UTRAN coverage. It is a Boolean value coded as follows: + +True the UE is in E-UTRAN coverage. + +False the UE is out of E-UTRAN coverage. + +### 12.4.2.5 ECGI + +This parameter is used to indicate E-UTRAN Cell Global Identification of the E-UTRAN cell where the UE was camping on or which the UE used in the EMM-CONNECTED mode. The coding of ECGI is defined in 3GPP TS 23.003 [4]. + +### 12.4.2.6 ProSe direct communication radio parameters + +This parameter is used to indicate the radio parameters used for ProSe direct communication. Format of the value is according to the SL-Preconfiguration-r12 ASN.1 data type described in 3GPP TS 36.331 [12]. + +### 12.4.2.7 Cause value + +This parameter is used to indicate the particular reason why the ProSe function CTF (ADF) rejects USAGE\_INFORMATION\_REPORT\_LIST message. It is an integer in the 0-255 range encoded as follows: + +- 0 Reserved +- 2 UE authorisation failure +- 3 Invalid Message Format + +10 Unable to process usage information report list + +1, 4-9, 11-255 Unused + +#### 12.4.2.8 Timestamp + +This parameter is used to indicate time and date. The format of this parameter follows the XML data type defined in table 12.4.1 for ProSe PC3ch message parameter type "Time". + +#### 12.4.2.9 ProSe Layer-2 Group ID + +This parameter is used to indicate a ProSe Layer-2 Group ID. The value of ProSe Layer 2 Group ID is a 24-bit bit-string. + +#### 12.4.2.10 Prose Group IP multicast address + +This parameter is used to indicate a ProSe Group IP multicast address. If the IP address is an IPv4 address, its value is coded as a string representing the dotted-decimal format of the IPv4 address as specified in IETF RFC 1166 [28]. If the IP address is an IPv6 address, its value is coded as a string representing the canonical text representation format of the IPv6 address as specified in IETF RFC 5952 [29]. + +#### 12.4.2.11 IP address of the UE + +This parameter is used to indicate an IP address used by the UE as a source address. If the IP address is an IPv4 address, its value is coded as a string representing the dotted-decimal format of the IPv4 address as specified in IETF RFC 1166 [28]. If the IP address is an IPv6 address, its value is coded as a string representing the canonical text representation format of the IPv6 address as specified in IETF RFC 5952 [29]. + +#### 12.4.2.12 Prose UE ID + +This parameter is used to indicate a ProSe UE ID. The value of ProSe UE ID is a 24-bit bit-string. + +#### 12.4.2.13 Transported data amount + +This parameter is used to indicate the amount of transported data in octets. The value of this parameter is coded as an integer. + +#### 12.4.2.14 Radio resources indicator + +This parameter is used to indicate whether the operator-provided radio resources or the configured radio resources were used for ProSe direct communication. + +It is an integer in the 0-255 range encoded as follows: + +- 0 Reserved +- 1 the operator-provided radio resources +- 2 the configured radio resources +- 3-255 Unused + +#### 12.4.2.15 Radio frequency + +This parameter is used to indicate the radio frequency used for ProSe direct communication. + +Format of the value is according to the ARFCN-ValueEUTRA-r9 ASN.1 data type described in 3GPP TS 36.331 [12]. + +## 12.5 PC5 Signalling message formats + +### 12.5.1 Information elements in PC5 Signalling messages + +#### 12.5.1.1 PC5-SP Message Type + +The PC5 SP Message Type IE is a type 3 information element, with the length of 1 octet. It is used to indicate the type of messages used in PC5 Signaling Protocol. + +Table 12.5.1.1.1 defines the value part of the PC5-SP Message Type IE used in the PC5 Signalling messages. + +**Table 12.5.1.1.1: PC5-SP message types for PC5 Signalling Protocol** + +| Bits | | | | | | | | | +|-------------------------------|---|---|---|---|---|---|---|-------------------------------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | DIRECT_COMMUNICATION_REQUEST | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | DIRECT_COMMUNICATION_ACCEPT | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | DIRECT_COMMUNICATION_REJECT | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | DIRECT_COMMUNICATION_KEEPALIVE | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | DIRECT_COMMUNICATION_KEEPALIVE_ACK | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | DIRECT_COMMUNICATION_RELEASE | +| 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | DIRECT_COMMUNICATION_RELEASE_ACCEPT | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | TMGI_MONITORING_REQUEST | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | TMGI_MONITORING_RESPONSE | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | CELL_ID_ANNOUNCEMENT_REQUEST | +| 0 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | CELL_ID_ANNOUNCEMENT_RESPONSE | +| 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | DIRECT_SECURITY_MODE_COMMAND | +| 0 | 0 | 0 | 0 | 1 | 1 | 0 | 1 | DIRECT_SECURITY_MODE_COMPLETE | +| 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | DIRECT_SECURITY_MODE_REJECT | +| 0 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | DIRECT_REKEYING_REQUEST | +| 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | DIRECT_REKEYING_RESPONSE | +| 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | DIRECT_REKEYING_TRIGGER | +| 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | REMOTE_UE_INFO_REQUEST | +| 0 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | REMOTE_UE_INFO_RESPONSE | +| All other values are reserved | | | | | | | | | + +#### 12.5.1.2 Sequence Number + +The purpose of the Sequence Number is to uniquely identify a PC5 Signalling message being sent or received. The sending UE will increment the sequence number for each outgoing new PC5 Signalling message. The Sequence Number information element is an integer in the 0-65535 range. + +#### 12.5.1.3 User Info + +The purpose of the User Info information element is to provide either the User Info received from upper layers identifying the user which is using this direct link, the PRUK ID received from the PKMF that the remote UE wants to use to connect to a relay using this direct link, or the IMSI of the remote UE using this direct link. + +The User Info IE content is a Type 4 information element, with a minimum length of 3 octets. The IEI of the User Info IE is 1. + +The User Info information element is coded as shown in figure 12.5.1.3.1, figure 12.5.1.3.2 and table 12.5.1.3.1. + +![](5cdc04ba574b7b819a3cb6dbbd91306c_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------------------------|---|---|---|---------|-------------------|---|---|----------| +| User Info IEI | | | | | | | | octet 1 | +| Length of User Info contents | | | | | | | | octet 2 | +| User Info | | | | 0 Spare | Type of User info | | | octet 3 | +| User Info | | | | | | | | octet 4* | + +**Figure 12.5.1.3.1: User Info information element** + +![](eeb519f37cc42888fa15ab9ea20ba7cb_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------------------------|---|---|---|-------------------|-------------------|---|---|----------| +| User Info IEI | | | | | | | | octet 1 | +| Length of User Info contents | | | | | | | | octet 2 | +| User Info digit 1 | | | | odd/even indic | Type of User info | | | octet 3 | +| User info digit p+1 | | | | User Info digit p | | | | octet 4* | + +**Figure 12.5.1.3.2: User Info information element for type of User Info "IMSI"** + +**Table 12.5.1.3.1: User Info information element** + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|--------------------------|--|--| +| Type of User Info (octet 3) | | | | | +| Bits | | | | | +| 3 | 2 | 1 | | | +| 0 | 0 | 1 Upper layers User Info | | | +| 0 | 1 | 0 PRUK ID | | | +| 0 | 1 | 1 IMSI | | | +| All other values are reserved. | | | | | +| Odd/even indication (octet 3) | | | | | +| Bit | | | | | +| 4 | | | | | +| 0 | even number of identity digits | | | | +| 1 | odd number of identity digits | | | | +| Identity digits (octet 3 etc) | | | | | +| For the IMSI, this field is coded using BCD coding. If the number of identity digits is even then bits 5 to 8 of the last octet shall be filled with an end mark coded as "1111". | | | | | +| For Type of identity "Upper layers User Info", the User Info bits are set to a bit string received from upper layers. Any unused bit in the last octet shall be coded as '0'. | | | | | +| For Type of identity "PRUK ID", the User Info bits are set to a bit string received from the PKMF. Any unused bit in the last octet shall be coded as '0'. | | | | | + +## 12.5.1.4 IP Address Config + +The purpose of the IP Address Config information element is to indicate the configuration options for IP address used by the UE over this direct link. + +The IP Address Config is a type 3 information element. The IEI of the IP Address Config IE is 2. + +The IP Address Config information element is coded as shown in figure 12.5.1.4.1 and table 12.5.1.4.1. + +![](84ff3b9de5bc4884d83fe064a8fff991_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------------|---|---|---|---|---|---|---|---------| +| IP Address Config IEI | | | | | | | | octet 1 | +| IP address Config Content | | | | | | | | octet 2 | + +**Figure 12.5.1.4.1: IP Address Config information element****Table 12.5.1.4.1: IP Address Config information element** + +| | | | | | +|-------------------------------------------------------------|----------|----------|----------|----------------------------------| +| IP Address Config value (octet 2) | | | | | +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | DHCPv4 Server | +| 0 | 0 | 0 | 1 | IPv6 Router | +| 0 | 0 | 1 | 0 | DHCPv4 Server & IPv6 Router | +| 0 | 0 | 1 | 1 | address allocation not supported | +| All other values are reserved. | | | | | +| Bit 5 to 8 of octet 2 are spare and shall be coded as zero. | | | | | + +### 12.5.1.5 Link Local IPv6 Address + +The Link Local IPv6 Address information element contains a link-local IPv6 address. + +The Link Local IPv6 Address is a type 3 information element. The IEI of the Link Local IPv6 Address IE is 3. + +The Link Local IPv6 Address element is coded as shown in figure 12.5.1.5.1 and table 12.5.1.5.1. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------------------|---|---|---|---|---|---|---|----------| +| Link Local IPv6 Address IEI | | | | | | | | octet 1 | +| Link Local IPv6 address Content | | | | | | | | octet 2 | +| | | | | | | | | octet 17 | + +**Figure 12.5.1.5.1: IP Address Config information element****Table 12.5.1.5.1: IPv6 Address information element** + +| | +|----------------------------------------------------------------------------------------------------------------------------| +| IP address value (octet 2 to 17) | +| This contains the 128-bit IPv6 address. This IPv6 address is encoded as a 128-bit address according to IETF RFC 4291 [36]. | + +### 12.5.1.6 Keepalive Counter + +The Keepalive Counter information element contains a 32-bit counter used for the direct link keepalive procedure. + +The Keepalive Counter is a type 3 information element with a length of 5 octets. The IEI of the KeepAlive Counter IE is 4. + +The Keepalive Counter information element is coded as shown in figure 12.5.1.6.1 and table 12.5.1.6.1. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------------|---|---|---|---|---|---|---|---------| +| Keepalive Counter IEI | | | | | | | | octet 1 | +| Keepalive Counter Content | | | | | | | | octet 2 | +| | | | | | | | | octet 5 | + +**Figure 12.5.1.6.1: Keepalive Counter information element** + +**Table 12.5.1.6.1: Keepalive Counter information element** + +| | +|---------------------------------------------| +| Keepalive Counter value (octet 2 to 5) | +| This contains the 32-bit keepalive counter. | + +## 12.5.1.7 PC5 Signalling Protocol Cause Value + +The purpose of the PC5 Signaling Protocol Cause Value information element is to indicate the error cause values used in the PC5 Signalling Protocol procedures. + +The PC5 Signalling Protocol Cause Value is a type 3 information element, with a length of 2 octets. The IEI of PC5 Signaling Protocol Cause Value IE is 5. + +The PC5 Signalling Protocol Cause Value information element is coded as shown in figure 12.5.1.7.1 and table 12.5.1.7.1. + +![](ed8597fae2e67db43518ae8bc46b6908_img.jpg) + +| | | | +|----------------------------------------------------|--|---------| +| 8      7      6      5      4      3      2      1 | | | +| PC5 Signalling Protocol Cause Value IEI | | octet 1 | +| PC5 Signalling Protocol Cause Value Content | | octet 2 | + +**Figure 12.5.1.7.1: PC5 Signaling Protocol Cause Value information element****Table 12.5.1.7.1: PC5 Signaling Protocol Cause Value information element** + +| PC5 Signaling Error Cause value (octet 2) | | | | | +|-------------------------------------------|---|---|---|--------------------------------------------------------------| +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | Direct communication to target UE not allowed | +| 0 | 0 | 1 | 0 | Authentication failure | +| 0 | 0 | 1 | 1 | Conflict of Layer 2 ID for unicast communication is detected | +| 0 | 1 | 0 | 0 | Lack of resources for proposed link | +| 0 | 1 | 0 | 1 | IP version mismatch | +| 0 | 1 | 1 | 0 | Link setup failure due to other errors | +| 0 | 1 | 1 | 1 | UE security capabilities mismatch | +| 1 | 0 | 0 | 0 | Unspecified error | +| 1 | 0 | 0 | 1 | Authentication synchronisation error | +| 1 | 0 | 1 | 0 | Non-responsive peer during security mode procedure | + +All other values are reserved. + +Bit 5 to 8 of octet 2 are spare and shall be coded as zero. + +## 12.5.1.8 Release Reason + +The purpose of the Release Reason information element is to indicate the reason why the direct link is to be released. + +The Release Reason IE is a type 3 information element, with a length of 2 octets. The IEI of Release Reason IE is 6. + +The Release Reason information element is coded as shown in figure 12.5.1.8.1 and table 12.5.1.8.1. + +![](f7ee9cdc91f5f80cef936014cdf5c47e_img.jpg) + +| | | | +|----------------------------------------------------|--|---------| +| 8      7      6      5      4      3      2      1 | | | +| Release Reason IEI | | octet 1 | +| Release Reason Content | | octet 2 | + +**Figure 12.5.1.8.1: Release Reason information element** + +**Table 12.5.1.8.1: Release Reason information element** + +| Release Reason value (octet 2) | | | | | +|-------------------------------------------------------------|---|---|---|------------------------------------------------------------| +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 1 | Direct communication to the peer UE no longer needed | +| 0 | 0 | 1 | 0 | Direct communication with the peer UE is no longer allowed | +| 0 | 0 | 1 | 1 | Direct connection is not available any more | +| All other values are reserved. | | | | | +| Bit 5 to 8 of octet 2 are spare and shall be coded as zero. | | | | | + +### 12.5.1.9 Maximum Inactivity Period + +The purpose of the Maximum Inactivity Period information element is to indicate the maximum inactivity period of the requesting UE over the direct link. + +The Maximum Inactivity Period IE is a type 3 information element, with a length of 5 octets. The IEI of Maximum Inactivity Period IE is 7. + +The Maximum Inactivity Period information element is coded as shown in figure 12.5.1.9.1 and table 12.5.1.9.1. + +![](f2124f9a242e6246af7f84f361ca8d22_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-----------------------------------|---|---|---|---|---|---|---|---------| +| Maximum Inactivity Period IEI | | | | | | | | octet 1 | +| Maximum Inactivity Period Content | | | | | | | | octet 2 | +| | | | | | | | | octet 5 | + +**Figure 12.5.1.9.1: Maximum Inactivity Period information element****Table 12.5.1.9.1: Maximum Inactivity Period information element** + +| | +|--------------------------------------------------------------| +| Maximum Inactivity Period value (octet 2 to 5) | +| This contains the 32-bit inactivity period value in seconds. | + +### 12.5.1.10 TMGI + +This parameter is used to identify the Multicast and Broadcast bearer services. The coding of TMGI is specified in 3GPP TS 24.008 [30]. + +### 12.5.1.11 MBMS SAI list + +This parameter is used to transfer a list of MBMS Service Area Identities to the ProSe UE-to-network relay UE. The MBMS SAI list is a type 6 information element, with a minimum length of 6 octets and a maximum length of 516 octets. The list can contain a maximum of 256 different MBMS Service Area Identities. The length of each MBMS SAI is 2 octets. The IEI of MBMS SAI list IE is 28. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-------------------------------------|---|---|---|---|---|---|---|------------| +| MBMS SAI list IEI | | | | | | | | octet 1 | +| Length of MBMS SAI list | | | | | | | | octet 2 | +| Length of MBMS SAI list (continued) | | | | | | | | octet 3 | +| Number of MBMS SAIs | | | | | | | | octet 4 | +| MBMS SAI 1 | | | | | | | | octet 5 | +| MBMS SAI 1 (continued) | | | | | | | | octet 6 | +| MBMS SAI 2 | | | | | | | | octet 7 | +| MBMS SAI 2 (continued) | | | | | | | | octet 8 | +| ... | | | | | | | | | +| MBMS SAI n | | | | | | | | octet 2n-1 | +| MBMS SAI n (continued) | | | | | | | | octet 2n | + +**Figure 12.5.1.11.1: MBMS SAI list information element** + +**Table 12.5.1.11.1: MBMS SAI list information element value part** + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------|----------|----------|----------|----------|----------|-------------| +|

The value part of the MBMS SAI list information element consists of the number of MBMS SAIs and one or more MBMS SAIs. The length of MBMS SAI list is set based on the 'Number of MBMS SAIs'. The ProSe UE-to-network relay UE shall store the complete list received.

| | | | | | | | | +|

Number of MBMS SAIs (octet 1)

| | | | | | | | | +|

Bits

| | | | | | | | | +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 element | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 2 element | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 3 element | +| ... | | | | | | | | | +| 1 | 1 | 1 | 1 | 1 | 1 | 0 | 1 | 254 element | +| 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 255 element | +| 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 256 element | +|

If the number of MBMS SAIs = n:

| | | | | | | | | +|

for i=1, n;
octet 2i and 2i+1 contain the MBMS SAI of the i-th MBMS SAI belonging to the MBMS SAI list

| | | | | | | | | +|

The coding of MBMS SAI is specified in 3GPP TS 23.003 [4].

| | | | | | | | | + +## 12.5.1.12 ProSe Layer2 Group ID + +This parameter is a link layer identifier of the group that transmits the MBMS traffic associated with a TMGI. The coding of ProSe Layer2 Group ID is specified in 3GPP TS 23.003 [4]. + +## 12.5.1.13 TMGI Monitoring Refresh Timer T4104 + +This parameter is used to carry the value of TMGI monitoring refresh timer T4104 associated with a TMGI. It is an integer in the 1-1440 range representing the timer value in unit of minutes. + +### 12.5.1.14 SAI Indicator + +This parameter is used to carry the SAI indicator, which is a Boolean value indicating whether the ProSe UE-to-network relay UE can forward the MBMS content associated with the received TMGI for the remote UE. + +### 12.5.1.15 ECGI announcement request refresh timer T4106 + +This parameter is used to carry the value of ECGI announcement request refresh timer. It is an integer in the 1-1440 range representing the timer value in unit of minutes. + +### 12.5.1.16 Requested ProSe Per-Packet Priority + +This parameter is used for representing a protocol data unit transmission priority for relaying eMBMS traffic over PC5. It is provided by the remote UE. It is an integer in the 1-8 range and the lower number means the higher priority. + +The Requested ProSe Per-Packet Priority is a type 3 information element, with a length of 2 octets. The Requested ProSe Per-Packet Priority information element is coded as shown in table 12.5.1.16.1. The IEI of the Requested ProSe Per-Packet Priority IE is 29. + +The Requested ProSe Per-Packet Priority information element is coded as shown in figure 12.5.1.16.1 and table 12.5.1.16.1. + +![](ce0b30eda000feb54457302d07202dc4_img.jpg) + +| | | | +|----------------------------------------------------|--|---------| +| 8      7      6      5      4      3      2      1 | | | +| Requested ProSe Per-Packet Priority IEI | | octet 1 | +| Requested ProSe Per-Packet Priority value | | octet 2 | + +**Figure 12.5.1.16.1: Requested ProSe Per-Packet Priority information element** + +**Table 12.5.1.16.1: Requested ProSe Per-Packet Priority information element** + +| ProSe Per-Packet Priority value (octet 2) | | | | | +|-------------------------------------------|---|---|---|----------| +| Bits | | | | | +| 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | Reserved | +| 0 | 0 | 0 | 1 | PPPP 1 | +| 0 | 0 | 1 | 0 | PPPP 2 | +| 0 | 0 | 1 | 1 | PPPP 3 | +| 0 | 1 | 0 | 0 | PPPP 4 | +| 0 | 1 | 0 | 1 | PPPP 5 | +| 0 | 1 | 1 | 0 | PPPP 6 | +| 0 | 1 | 1 | 1 | PPPP 7 | +| 1 | 0 | 0 | 0 | PPPP 8 | + +All other values are reserved. + +Bit 5 to 8 of octet 2 are spare and shall be coded as zero. + +### 12.5.1.17 Relay Service Code + +The purpose of the Relay Service Code information element is to indicate the parameter defined in subclause 12.2.2.51. + +The Relay Service Code information element is coded as shown in figure 12.5.1.17.1 and table 12.5.1.17.1. + +The Relay Service Code is a type 3 information element with a length of 4 octets. The IEI of the Relay Service Code IE is 25. + +![](95b688d41d273fae1b28a240a2556803_img.jpg) + +| | | | +|----------------------------------------------------|--|---------| +| 8      7      6      5      4      3      2      1 | | | +| Relay Service Code IEI | | octet 1 | +| Relay Service Code | | octet 2 | +| ⋮ | | ⋮ | +| Relay Service Code | | octet 4 | + +**Figure 12.5.1.17.1: Relay Service Code information element** + +**Table 12.5.1.17.1: Relay Service Code information element** + +| | +|----------------------------------------------| +| Relay Service Code value (octet 2 to 4) | +| This contains the 24-bit Relay Service Code. | + +## 12.5.1.18 GPI + +The purpose of the GPI information element is to include the GBA Push Information as defined in 3GPP TS 33.223 [42]. + +The GPI information element is coded as shown in figure 12.5.1.18.1 and table 12.5.1.18.1. + +The GPI is a type 4 information element with a variable length. The IEI of the GPI IE is 24. + +![](ade808c7cde5b576488a326d288f29eb_img.jpg) + +| | | | | | | | | | +|------------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| GPI IEI | | | | | | | | octet 1 | +| Length of GPI contents | | | | | | | | octet 2 | +| GPI | | | | | | | | octet 3 | +| ⋮ | | | | | | | | | +| | | | | | | | | octet n | + +**Figure 12.5.1.18.1: GPI information element****Table 12.5.1.18.1: GPI information element** + +| | +|------------------------------------------------------| +| GPI value (octet 3 to n) | +| GPI message layout as defined in 3GPP TS 33.223 [42] | + +## 12.5.1.19 PRUK ID + +The purpose of the PRUK ID information element is to provide the ProSe UE-to-network relay with the latest PRUK ID at the remote UE when the remote UE triggers rekeying. + +The PRUK ID information element is coded as shown in figure 12.5.1.19.1 and table 12.5.1.19.1. + +The PRUK ID is a type 3 information element with a length of 9 octets. The IEI of the PRUK ID IE is 8. + +![](78862a2529213e65303b27d7fcf9a48c_img.jpg) + +| | | | | | | | | | +|-------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| PRUK ID IEI | | | | | | | | octet 1 | +| PRUK ID | | | | | | | | octet 2 | +| ⋮ | | | | | | | | | +| | | | | | | | | octet 9 | + +**Figure 12.5.1.19.1: PRUK ID information element****Table 12.5.1.19.1: PRUK ID information element** + +| | +|------------------------------| +| PRUK ID value (octet 2 to 9) | +| This contains the PRUK ID | + +## 12.5.1.20 AUTS + +The purpose of the AUTS information element is to provide the network with the necessary information to begin a re-synchronisation as part of the AKA procedure (see 3GPP TS 33.102 [41]). + +The AUTS information element is coded as shown in figure 12.5.1.20.1 and table 12.5.1.20.1. + +The AUTS is a type 3 information element with a length of 15 octets. The IEI of the AUTS IE is 9. + +![](09cef6267096187ea2ec3fa61909d695_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------|---|---|---|---|---|---|---|----------| +| AUTS IEI | | | | | | | | octet 1 | +| AUTS | | | | | | | | octet 2 | +| ⋮ | | | | | | | | | +| | | | | | | | | octet 15 | + +**Figure 12.5.1.20.1: AUTS information element** + +**Table 12.5.1.20.1: AUTS information element** + +| | +|----------------------------------------------| +| AUTS value (octet 2 to 15) | +| This contains AUTS (see 3GPP TS 33.102 [41]) | + +## 12.5.1.21 RAND + +The purpose of the RAND information element is to provide the mobile station with a non-predictable challenge for the AKA procedure. + +The RAND information element is coded as shown in figure 12.5.1.21.1 and table 12.5.1.21.1. + +The RAND is a type 3 information element with a length of 17 octets. The IEI of the RAND IE is 10. + +![](6cd03b2de72895b862b66ec8571baedf_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------|---|---|---|---|---|---|---|----------| +| RAND IEI | | | | | | | | octet 1 | +| RAND value | | | | | | | | octet 2 | +| | | | | | | | | octet 17 | + +**Figure 12.5.1.21.1: RAND information element** + +**Table 12.5.1.21.1: RAND information element** + +| | +|--------------------------------------| +| RAND value (octet 2, 3,... and 17) | +| The RAND value consists of 128 bits. | + +## 12.5.1.22 UE Security Capabilities + +The UE Security Capabilities information element is used to indicate which security algorithms are supported by the UE. + +The UE Security Capabilities information element is coded as shown in figure 12.5.1.22.1 and table 12.5.1.22.1. + +The UE Security Capabilities is a type 3 information element with a length of 3 octets. The IEI of the UE Security Capabilities IE is 11. + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|------------------------------|----------|----------|----------|------|------|------|------|---------| +| UE security capabilities IEI | | | | | | | | octet 1 | +| EEA0 | 128-EEA1 | 128-EEA2 | 128-EEA3 | EEA4 | EEA5 | EEA6 | EEA7 | octet 2 | +| EIA0 | 128-EIA1 | 128-EIA2 | 128-EIA3 | EIA4 | EIA5 | EIA6 | EIA7 | octet 3 | + +**Figure 12.5.1.22.1: UE Security Capabilities information element** + +**Table 12.5.1.22.1: UE Security Capabilities information element** + +## EPS encryption algorithms supported (octet 2) + +EPS encryption algorithm EEA0 supported (octet 2, bit 8) + +0 EPS encryption algorithm EEA0 not supported +1 EPS encryption algorithm EEA0 supported + +EPS encryption algorithm 128-EEA1 supported (octet 2, bit 7) + +0 EPS encryption algorithm 128-EEA1 not supported +1 EPS encryption algorithm 128-EEA1 supported + +EPS encryption algorithm 128-EEA2 supported (octet 2, bit 6) + +0 EPS encryption algorithm 128-EEA2 not supported +1 EPS encryption algorithm 128-EEA2 supported + +EPS encryption algorithm 128-EEA3 supported (octet 2, bit 5) + +0 EPS encryption algorithm 128-EEA3 not supported +1 EPS encryption algorithm 128-EEA3 supported + +EPS encryption algorithm EEA4 supported (octet 2, bit 4) + +0 EPS encryption algorithm EEA4 not supported +1 EPS encryption algorithm EEA4 supported + +EPS encryption algorithm EEA5 supported (octet 2, bit 3) + +0 EPS encryption algorithm EEA5 not supported +1 EPS encryption algorithm EEA5 supported + +EPS encryption algorithm EEA6 supported (octet 2, bit 2) + +0 EPS encryption algorithm EEA6 not supported +1 EPS encryption algorithm EEA6 supported + +EPS encryption algorithm EEA7 supported (octet 1, bit 1) + +0 EPS encryption algorithm EEA7 not supported +1 EPS encryption algorithm EEA7 supported + +## EPS integrity algorithms supported (octet 3) + +EPS integrity algorithm EIA0 supported (octet 3, bit 8) + +0 EPS integrity algorithm EIA0 not supported +1 EPS integrity algorithm EIA0 supported + +EPS integrity algorithm 128-EIA1 supported (octet 3, bit 7) + +0 EPS integrity algorithm 128-EIA1 not supported +1 EPS integrity algorithm 128-EIA1 supported + +EPS integrity algorithm 128-EIA2 supported (octet 3, bit 6) + +0 EPS integrity algorithm 128-EIA2 not supported +1 EPS integrity algorithm 128-EIA2 supported + +EPS integrity algorithm 128-EIA3 supported (octet 3, bit 5) + +0 EPS integrity algorithm 128-EIA3 not supported +1 EPS integrity algorithm 128-EIA3 supported + +EPS integrity algorithm EIA4 supported (octet 3, bit 4) + +0 EPS integrity algorithm EIA4 not supported +1 EPS integrity algorithm EIA4 supported + +EPS integrity algorithm EIA5 supported (octet 3, bit 3) + +0 EPS integrity algorithm EIA5 not supported +1 EPS integrity algorithm EIA5 supported + +EPS integrity algorithm EIA6 supported (octet 3, bit 2) + +0 EPS integrity algorithm EIA6 not supported +1 EPS integrity algorithm EIA6 supported + +EPS integrity algorithm EIA7 supported (octet 3, bit 1) + +0 EPS integrity algorithm EIA7 not supported + +| | | +|---|----------------------------------------| +| 1 | EPS integrity algorithm EIA7 supported | +|---|----------------------------------------| + +### 12.5.1.23 Chosen Algorithms + +The purpose of the Chosen Algorithms information element is to indicate the algorithms to be used for ciphering and integrity protection. + +The Chosen Algorithms information element is coded as shown in figure 12.5.1.23.1 and table 12.5.1.23.1. + +The Chosen Algorithms is a type 3 information element with a length of 2 octets. The IEI of the Chosen Algorithms IE is 12. + +![](6c1f465976ff149b5f6d1e7bd88a14bf_img.jpg) + +| | | | | | | | | | +|-----------------------|-----------------------------|---|---|-------|----------------------------------------|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Chosen Algorithms IEI | | | | | | | | octet 1 | +| 0 | Type of ciphering algorithm | | | 0 | Type of integrity protection algorithm | | | octet 2 | +| spare | | | | spare | | | | | + +**Figure 12.5.1.23.1: Chosen Algorithms information element** + +**Table 12.5.1.23.1: Chosen Algorithms information element** + +| Type of integrity protection algorithm (octet 2, bit 1 to 3) | | | | +|--------------------------------------------------------------|---|---|--------------------------------------------------------------------| +| Bits | | | | +| 3 | 2 | 1 | | +| 0 | 0 | 0 | EPS integrity algorithm EIA0 (null integrity protection algorithm) | +| 0 | 0 | 1 | EPS integrity algorithm 128-EIA1 | +| 0 | 1 | 0 | EPS integrity algorithm 128-EIA2 | +| 0 | 1 | 1 | EPS integrity algorithm 128-EIA3 | +| 1 | 0 | 0 | EPS integrity algorithm EIA4 | +| 1 | 0 | 1 | EPS integrity algorithm EIA5 | +| 1 | 1 | 0 | EPS integrity algorithm EIA6 | +| 1 | 1 | 1 | EPS integrity algorithm EIA7 | + + + +| Type of ciphering algorithm (octet 2, bit 5 to 7) | | | | +|---------------------------------------------------|---|---|----------------------------------------------------------| +| Bits | | | | +| 7 | 6 | 5 | | +| 0 | 0 | 0 | EPS encryption algorithm EEA0 (null ciphering algorithm) | +| 0 | 0 | 1 | EPS encryption algorithm 128-EEA1 | +| 0 | 1 | 0 | EPS encryption algorithm 128-EEA2 | +| 0 | 1 | 1 | EPS encryption algorithm 128-EEA3 | +| 1 | 0 | 0 | EPS encryption algorithm EEA4 | +| 1 | 0 | 1 | EPS encryption algorithm EEA5 | +| 1 | 1 | 0 | EPS encryption algorithm EEA6 | +| 1 | 1 | 1 | EPS encryption algorithm EEA7 | + +Bit 4 and 8 of octet 2 are spare and shall be coded as zero. + +### 12.5.1.24 LSB of KD-sess ID + +The purpose of the LSB of KD-sess ID information element is to carry the 8 least significant bits of the KD-sess ID. + +The LSB of KD-sess ID IE is a type 3 information element, with a length of 2 octets. The IEI of the LSB of KD-sess ID IE is 13. + +The LSB of KD-sess ID information element is coded as shown in figure 12.5.1.24.1 and table 12.5.1.24.1. + +![](16ddca00f500e7eef04e1f43a1e9497a_img.jpg) + +| | | | | | | | | | +|---------------------------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| LSB of K D-sess ID IEI | | | | | | | | octet 1 | +| LSB of K D-sess ID Content | | | | | | | | octet 2 | + +**Figure 12.5.1.24.1: LSB of KD-sess ID information element** + +**Table 12.5.1.24.1: LSB of KD-sess ID information element** + +| | +|----------------------------------------------------------------------------------------------------------------------------| +| LSB of K D-sess ID value (octet 2)

This contains the 8 least significant bits of K D-sess ID. | +|----------------------------------------------------------------------------------------------------------------------------| + +**12.5.1.25 MSB of KD-sess ID** + +The purpose of the MSB of KD-sess ID information element is to carry the 8 most significant bits of the KD-sess ID. + +The MSB of KD-sess ID IE is a type 3 information element, with a length of 2 octets. The IEI of the MSB of KD-sess ID Request Nonce IE is 14. + +The MSB of KD-sess ID information element is coded as shown in figure 12.5.1.25.1 and table 12.5.1.25.1. + +![](4aeafa83d297a9b124c73904c5a49437_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------------------------|---|---|---|---|---|---|---|---------| +| MSB of K D-sess ID IEI | | | | | | | | octet 1 | +| MSB of K D-sess ID Content | | | | | | | | octet 2 | + +**Figure 12.5.1.25.1: MSB of KD-sess ID information element****Table 12.5.1.25.1: MSB of KD-sess ID information element** + +| | +|---------------------------------------------------------------------------------------------------------------------------| +| MSB of K D-sess ID value (octet 2)

This contains the 8 most significant bits of K D-sess ID. | +|---------------------------------------------------------------------------------------------------------------------------| + +**12.5.1.26 LSB of KD ID** + +The purpose of the LSD of KD ID information element is to carry the 16 least significant bits of the KD ID. + +The LSB of KD ID IE is a type 3 information element, with a length of 3 octets. The IEI of the LSB of KD ID is 15. + +The LSB of KD ID information element is coded as shown in figure 12.5.1.26.1 and table 12.5.1.26.1. + +![](a1e3575776f3a4da4c0b808d3b91bf8e_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------------------------------|---|---|---|---|---|---|---|---------| +| LSD of K D ID IEI | | | | | | | | octet 1 | +| LSB of K D ID Content | | | | | | | | octet 2 | +| | | | | | | | | octet 3 | + +**Figure 12.5.1.26.1: LSB of KD ID information element****Table 12.5.1.26.1: LSB of KD ID information element** + +| | +|------------------------------------------------------------------------------------------------------------------------| +| LSB of K D ID value (octet 2 to 3)

This contains the 16 least significant bits of K D ID. | +|------------------------------------------------------------------------------------------------------------------------| + +**12.5.1.27 MSB of KD ID** + +The purpose of the MSB of KD ID information element is to carry the 16 most significant bits of the KD ID. + +The MSB of KD ID IE is a type 3 information element, with a length of 3 octets. The IEI of the MSB of KD ID IE is 16. + +The MSB of KD ID information element is coded as shown in figure 12.5.1.27.1 and table 12.5.1.27.1. + +![](80bb4ec4824504cee405fa52b634ca16_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------------------------------|---|---|---|---|---|---|---|---------| +| MSD of K D ID IEI | | | | | | | | octet 1 | +| MSB of K D ID Content | | | | | | | | octet 2 | +| | | | | | | | | octet 3 | + +**Figure 12.5.1.27.1: MSB of KD ID information element** + +**Table 12.5.1.27.1: MSB of KD ID information element** + +| | +|------------------------------------------------------------------| +| MSB of K D ID value (octet 2 to 3) | +| This contains the 16 most significant bits of K D ID. | + +## 12.5.1.28 KD ID + +The purpose of the KD ID information element is to carry the identity of the KD held by a UE. + +The KD ID IE is a type 3 information element, with a length of 5 octets. The IEI of the KD ID IE is 17. + +The KD ID information element is coded as shown in figure 12.5.1.28.1 and table 12.5.1.28.1. + +![](abf91c0fe8bc45562f2bc9adc2d5d58a_img.jpg) + +| | | | | | | | | | +|---------------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| K D ID IEI | | | | | | | | octet 1 | +| K D ID Content | | | | | | | | octet 2 | +| | | | | | | | | octet 5 | + +**Figure 12.5.1.28.1: KD ID information element****Table 12.5.1.28.1: KD ID information element** + +| | +|-----------------------------------------------------------| +| K D ID value (octet 2 to 5) | +| This contains the 32-bit identifier of a K D . | + +## 12.5.1.29 KD Freshness + +The purpose of the KD Freshness information element is to indicate the nonce value generated by initiating PKMF to ensure that any calculated KD is fresh. + +The KD Freshness parameter IE is a type 3 information element, with a length of 17 octets. The IEI of the KD Freshness IE is 18. + +The KD Freshness parameter information element is coded as shown in figure 12.5.1.29.1 and table 12.5.1.29.1. + +![](9ab99174161aa35a0b84ec0587ad0363_img.jpg) + +| | | | | | | | | | +|----------------------------------|---|---|---|---|---|---|---|----------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| K D Freshness IEI | | | | | | | | octet 1 | +| K D Freshness Content | | | | | | | | octet 2 | +| | | | | | | | | octet 17 | + +**Figure 12.5.1.29.1: KD Freshness information element****Table 12.5.1.29.1: KD Freshness information element** + +| | +|------------------------------------------------| +| K D Freshness value (octet 2 to 17) | +| This contains the 128-bit nonce value. | + +## 12.5.1.30 Nonce\_1 + +The purpose of the Nonce\_1 information element is to indicate the nonce value generated by the UE which initiated the direct link setup procedure or direct link rekeying procedure. + +The Nonce\_1 IE is a type 3 information element, with a length of 17 octets. The IEI of the Nonce\_1 IE is 19. + +The Nonce\_1 information element is coded as shown in figure 12.5.1.30.1 and table 12.5.1.30.1. + +![](31f5b6310f831ca3ea4f18453980c070_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-----------------|---|---|---|---|---|---|---|----------| +| Nonce_1 IEI | | | | | | | | octet 1 | +| Nonce_1 Content | | | | | | | | octet 2 | +| | | | | | | | | octet 17 | + +**Figure 12.5.1.30.1: Nonce\_1 information element** + +**Table 12.5.1.30.1: Nonce\_1 information element** + +Nonce1 value (octet 2 to 17) + +This contains the 128-bit nonce value. + +### 12.5.1.31 Nonce\_2 + +The purpose of the Nonce\_2 information element is to indicate the nonce value generated by the UE which initiated the direct security mode control procedure. + +The Nonce\_2 IE is a type 3 information element, with a length of 17 octets. The IEI of the Nonce\_2 IE is 20. + +The Nonce\_2 information element is coded as shown in figure 12.5.1.31.1 and table 12.5.1.31.1. + +![](b0b96fc2fa2f3dab5ec2f28e4276255b_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-----------------|---|---|---|---|---|---|---|----------| +| Nonce_2 IEI | | | | | | | | octet 1 | +| Nonce_2 Content | | | | | | | | octet 2 | +| | | | | | | | | octet 17 | + +**Figure 12.5.1.31.1: Nonce\_2 information element** + +**Table 12.5.1.31.1: Nonce\_2 information element** + +Nonce\_2 value (octet 2 to 17) + +This contains the 128-bit nonce value. + +### 12.5.1.32 Auth Flag + +The purpose of the Auth Flag information element is to indicate that the $K_D$ is to be refreshed.. + +The Auth Flag IE is a type 3 information element, with a length of 2 octets. The IEI of the Auth Flag IE is 21. + +The Auth Flag information element is coded as shown in figure 12.5.1.32.1 and table 12.5.1.32.1. + +![](73c2b21b1b473ac72d3e750a4a7c2fa4_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-------------------|---|---|---|---|---|---|---|---------| +| Auth Flag IEI | | | | | | | | octet 1 | +| Auth Flag Content | | | | | | | | octet 2 | + +**Figure 12.5.1.32.1: Auth Flag information element** + +**Table 12.5.1.32.1: Auth Flag information element** + +Auth Flag value (octet 2) + +Bits + +**1** + +- 0 Reserved +- 1 $K_D$ is requested to be refreshed + +Bit 2 to 8 of octet 2 are spare and shall be coded as zero. + +### 12.5.1.33 Signature + +The purpose of the Signature information element is to indicate the ECCSI signature calculated based on information exchanged during the direct link setup. + +The Signature IE is a type 3 information element, with a length of 130 octets. The IEI of the Signature IE is 22. + +The Signature information element is coded as shown in figure 12.5.1.33.1 and table 12.5.1.33.1. + +![](26d37a5ec149b21b1520a5bb18422208_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-------------------|---|---|---|---|---|---|---|-----------| +| Signature IEI | | | | | | | | octet 1 | +| Signature Content | | | | | | | | octet 2 | +| | | | | | | | | octet 130 | + +**Figure 12.5.1.33.1: Signature information element** + +**Table 12.5.1.33.1: Signature information element** + +| | +|--------------------------------------------------------------------------------------------------------------------------| +| Signature value (octet 2 to 130) | +| This contains the signature with a length of 129 octets. The exact content structure is specified in 3GPP TS 33.303 [6]. | + +### 12.5.1.34 Encrypted Payload + +The purpose of the Encrypted Payload information element is to indicate the encrypted data encapsulating the shared secret key to be used for the established link. + +The Encrypted Payload IE is a type 4 information element, with a variable length. The IEI of the Encrypted Payload IE is 23. + +The Encrypted Payload information element is coded as shown in figure 12.5.1.34.1 and table 12.5.1.34.1. + +![](47d4bb75bab808b473a9208ea8b0bf61_img.jpg) + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---------------------------|---|---|---|---|---|---|---|---------| +| Encrypted Payload IEI | | | | | | | | octet 1 | +| Length Encrypted Payload | | | | | | | | octet 2 | +| Encrypted Payload Content | | | | | | | | octet 3 | +| | | | | | | | | octet n | + +**Figure 12.5.1.34.1: Encrypted Payload information element** + +**Table 12.5.1.34.1: Encrypted Payload information element** + +| | +|----------------------------------------------------------------------------------------------------------------------------------| +| Encrypted Payload value (octet 3 to n) | +| This contains the encrypted data content with a variable length. The exact content structure is specified in 3GPP TS 33.303 [6]. | + +### 12.5.1.35 Remote UE Information Type + +The purpose of the Remote UE Information Type element is to indicate the type of information requested regarding the remote UE. + +The Remote UE Information Type IE is a type 3 information element, with a length of 2 bytes. The IEI of the Remote UE Information Type IE is 26. + +The Remote UE Information Type information element is coded as shown in figure 12.5.1.35.1 and table 12.5.1.35.1. + +![](dd1dd483573cc9c3bc666a371f59d5d7_img.jpg) + +| | | | | | | | | | +|------------------------------------|---|---|---|---|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Remote UE Information Type IEI | | | | | | | | octet 1 | +| Remote UE Information Type Content | | | | | | | | octet 2 | + +**Figure 12.5.1.35.1: Remote UE Information Type information element** + +**Table 12.5.1.35.1: Remote UE Information Type information element** + +| Bits | | | | | | | | | +|------|---|---|---|---|---|---|---|--------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | IMEI | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | IMEISV | + +All other values are reserved + +## 12.5.1.36 IMEI + +The purpose of the IMEI information element is to indicate the IMEI or IMEISV of a UE. + +The IMEI IE is a type 3 information element, with a length of 10 bytes, depending on the IMEI type. The IEI of the IMEI IE is 27. + +The IMEI information element is coded as shown in figure 12.5.1.36.1 and table 12.5.1.36.1. + +![](da80cca94733ae79baed98eb586aa77b_img.jpg) + +| | | | | | | | | | +|-----------|---|---|---|--------------|-----------|---|---|----------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| IMEI IEI | | | | | | | | octet 1 | +| Digit 1 | | | | odd/
even | IMEI Type | | | octet 2 | +| Digit p+1 | | | | Digit p | | | | octet 3 | +| ... | | | | | | | | octet 10 | + +**Figure 12.5.1.36.1: IMEI information element** + +**Table 12.5.1.36.1: IMEI information element** + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| IMEI Content (octet 2- octet 10) | | +| Odd/even indication (octet 2) | | +| Bit | | +| 4 | | +| 0 | even number of IMEI identity digits | +| 1 | odd number of IMEI identity digits | +| IMEI Type (octet 2) | | +| Bits | | +| 3 2 1 | | +| 1 0 0 | IMEI | +| 1 0 1 | IMEISV | +| All other values are reserved. | | +| IMEI Identity digits (octet 2 etc) | | +| For the IMEI, this field is coded using BCD coding from octet 2 to octet 9. Octet 10 shall be filled with "11111111" and ignored on reception. The format of the IMEI is described in 3GPP TS 23.003 [4]. | | +| For the IMEISV, this field is coded using BCD coding from octet 2 to octet 10. Bits 5 to 8 of Octet 10 shall be filled with an end mark coded as "1111". The format of the IMEISV is described in 3GPP TS 23.003 [4]. | | + +--- + +# 13 List of system parameters + +## 13.1 General + +The description of timers in table 13.2.1 and table 13.2.2 should be considered a brief summary. The complete descriptions of the timers are in the procedures defined in subclause 5 and subclause 6. + +## 13.2 Timers of ProSe direct services procedures + +**Table 13.2.1: ProSe direct services timers – UE side** + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4000 | NOTE 1 |

Upon receiving a ProSe Application Code with an associated T4000 timer in a DISCOVERY_RESPONSE message whose transaction ID contained in the <response-announce> element matches the value sent by the UE in a DISCOVERY_REQUEST message with the command set to "announce", as described in subclause 6.2.2.4.

Upon receiving a ProSe Application Code with an associated T4000 timer in the Update Info in the <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.7.3.

|

Upon receiving a new T4000 timer value for the same ProSe Application Code or receiving a new Timer associated with a new ProSe Application Code for the same ProSe Application ID in a DISCOVERY_RESPONSE message.

When the UE selects a new PLMN.

Upon receiving a <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.7.3.

|

Stop announcing the associated ProSe Application Code over the PC5 interface and re-initiate the announce request procedure if the request from upper layers to announce the ProSe Application ID corresponding to the associated ProSe Application Code is still in place.

| +| T4002 | NOTE 2 |

Upon receiving a Discovery Filter with an associated T4002 timer in a DISCOVERY_RESPONSE message whose transaction ID contained in the <response-monitor> element matches the value sent by the UE in a DISCOVERY_REQUEST message with the command set to "monitor", as described in subclause 6.2.3.4.

Upon receiving a Discovery Filter in the Update Info in the <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.7.3.

|

Upon receiving a new T4002 timer value for the same Discovery Filter in a DISCOVERY_RESPONSE message.

Upon receiving a <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.7.3.

|

Stop using the associated Discovery Filter for ProSe direct discovery monitoring over the PC5 interface and re-initiate the monitor request procedure, if the request from upper layers to monitor the ProSe Application ID corresponding to the associated Discovery Filter is still in place.

| + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4004 | NOTE 3 | Upon receiving a T4004 timer in a MATCH_REPORT_ACK message whose transaction ID contained in the element matches the value sent by the UE in a MATCH_REPORT message, as described in subclause 6.2.4.4. | Upon receiving a new T4004 timer value for the same ProSe Application Code in a MATCH_REPORT_ACK message.

Upon receiving a MATCH_REPORT_ACK message with a element containing PC3 Control Protocol cause value is #5. | The UE may inform the upper layers that the corresponding ProSe Application ID is no longer matched. | +| T4005 | NOTE 4 | Upon receiving a monitoring, announcing, discoveree operation, discoverer operation or communication policy for a given PLMN with an associated T4005 value in the ProSe service authorisation as described in subclause 5.1.3. | When the service authorisation for the corresponding PLMN is revoked by the ProSe Function.

Upon receiving a new T4005 timer value for the same operation (monitoring, announcing, discoveree operation, discoverer operation or communication) in the same PLMN. | Stop the monitoring, announcing, discoveree, discoverer or communication operation in the corresponding PLMN and re-initiate the service authorisation procedure if the UE wants to continue performing announcing, monitoring, discoveree, discoverer or communication operation in that PLMN. | +| T4006 | NOTE 3 | Upon receiving a T4006 timer in a MATCH_REPORT_ACK message whose transaction ID contained in the element matches the value sent by the UE in a MATCH_REPORT message, as described in subclause 6.2.4.4. | Upon receiving a new T4006 timer value for the same ProSe Application Code in a MATCH_REPORT_ACK message.

When the corresponding T4004 timer for the ProSe Application Code is stopped or expires. | The UE needs to send a Match Report on next instance it detects the corresponding ProSe Application Code. | + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4007 | NOTE 5 |

Upon receiving a ProSe Restricted Code or ProSe Restricted Code Prefix with an associated T4007 timer in a DISCOVERY_RESPONSE message whose transaction ID contained in the <restricted-announce-response> element matches the value sent by the UE in a DISCOVERY_REQUEST message with the command set to "announce" and the Discovery Type set to "Restrict discovery", as described in subclause 6.2.2A.4.

Upon receiving a ProSe Restricted Code with an associated T4007 timer in the Update Info in the <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.6.3.

|

Upon receiving a new T4007 timer value for the same ProSe Restricted Code or ProSe Restricted Code Prefix, or upon receiving a new T4007 timer associated with a new ProSe Restricted Code or ProSe Restricted Code Prefix for the same RPAUID in a DISCOVERY_RESPONSE message.

When the UE selects a new PLMN.

Upon receiving a ProSe Restricted Code with an associated T4007 timer in the Update Info in the <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.6.3.

|

Stop announcing the associated ProSe Restricted Code over the PC5 interface if the ProSe Restricted Code is already allocated; and re-initiate the announce request procedure if the request from upper layers to announce the RPAUID corresponding to the associated ProSe Restricted Code is still in place.

| +| T4009 | NOTE 6 |

Upon receiving a Restricted Discovery Filter with an associated T4009 timer in a DISCOVERY_RESPONSE message whose transaction ID contained in the <restricted-monitor-response> element matches the value sent by the UE in a DISCOVERY_REQUEST message with the command set to "monitor" and the Discovery Type set to "Restrict discovery", as described in subclause 6.2.3A.4.

Upon receiving a Restricted Discovery Filter in the Update Info in the <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.6.2.

|

Upon receiving one or more new T4009 timer values for the same discovery entry in a DISCOVERY_RESPONSE message.

Upon receiving a Restricted Discovery Filter in the Update Info in the <discovery-update-request> element in a DISCOVERY_UPDATE_REQUEST message and the Discovery Entry ID in the <discovery-update-request> element is known, as described in subclause 6.2.6.2.

|

Stop using the associated Restricted Discovery Filter for restricted ProSe direct discovery monitoring over the PC5 interface and re-initiate the monitor request procedure, if the request from upper layers to monitor the corresponding discovery target is still in place.

| + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|-------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4011 | NOTE 7 | Upon receiving a ProSe Response Code and Discovery Query Filters with an associated T4011 timer in a DISCOVERY_RESPONSE message whose transaction ID contained in the < restricted-discoveree-response > element matches the value sent by the UE in a DISCOVERY_REQUEST message with the command set to "response" and the Discovery Type set to "Restrict discovery", as described in subclause 6.2.2B.4. | Upon receiving a new T4011 timer value for the same discovery entry in a DISCOVERY_RESPONSE message.

When the UE selects a new PLMN. | Stop announcing the associated ProSe Response Code or monitoring with the associated Discovery Query Filter(s) over the PC5 interface and re-initiate the discoveree request procedure if the request from upper layers to announce the RPAUID in Model B is still in place. | +| T4013 | NOTE 8 | Upon receiving a ProSe Query Code and Discovery Response Filters with an associated T4013 timer in a DISCOVERY_RESPONSE message whose transaction ID contained in the < restricted-discoverer-response > element matches the value sent by the UE in a DISCOVERY_REQUEST message with the command set to "query" and the Discovery Type set to "Restrict discovery", as described in subclause 6.2.3B.4. | Upon receiving a new T4013 timer value for the same discovery entry in a DISCOVERY_RESPONSE message. | Stop announcing the associated ProSe Query Code or monitoring with the associated Discovery Response Filter(s) over the PC5 interface and re-initiate the discoverer request procedure if the request from upper layers to query for the same targets in Model B is still in place. | +| T4015 | NOTE 4 | Upon receiving a ProSe Discovery UE ID with an associated T4015 value in the ProSe service authorisation as described in subclause 5.1.3. | Upon receiving a new ProSe Discovery UE ID. | Stop performing ProSe restricted discovery and re-initiate the service authorisation procedure if the UE wants to continue performing ProSe restricted discovery. | +| T4016 | NOTE 13 | Upon receiving a T4016 timer in a MATCH_REPORT_ACK message whose transaction ID contained in the < restricted-match-ack > element matches the value sent by the UE in a MATCH_REPORT message, as described in subclause 6.2.4A.4 or 6.2.4B.4. | Upon receiving a new T4016 timer value for the same ProSe Restricted Code or ProSe Response Code in a MATCH_REPORT_ACK message.

Upon receiving a MATCH_REPORT_ACK message with a < match-reject > element containing PC3 Control Protocol cause value #5. | The UE may inform the upper layers that the corresponding RPAUID is no longer matched. | + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4017 | NOTE 13 | Upon receiving a T4017 timer in a MATCH_REPORT_ACK message whose transaction ID contained in the element matches the value sent by the UE in a MATCH_REPORT message, as described in subclause 6.2.4A.4. | Upon receiving a new T4017 timer value for the same ProSe Restricted Code or ProSe Response Code in a MATCH_REPORT_ACK message.

When the corresponding T4016 timer for the ProSe Restricted Code or ProSe Response Code is stopped or expires. | The UE needs to send a Match Report on next instance it detects the corresponding ProSe Restricted Code or ProSe Response Code. | +| T4100 | | Upon sending a DIRECT_COMMUNICATION_REQUEST message | Upon receiving a DIRECT_COMMUNICATION_ACCEPT or DIRECT_COMMUNICATION_REJECT message from the target UE | Retransmission of DIRECT_COMMUNICATION_SETUP message | +| T4101 | | DIRECT_COMMUNICATION_KEEPALIVE message sent | Upon Receiving a DIRECT_COMMUNICATION_KEEPALIVE_ACK message or other PC5 Signaling message or user data from the peer UE | Retransmission of DIRECT_COMMUNICATION_KEEPALIVE message | +| T4102 | | Upon Receiving a DIRECT_COMMUNICATION_KEEPALIVE_ACK message, or other PC5 Signaling message, or any user data from the peer UE | Upon receiving an upper layer request to check whether the direct link is alive and sending out a DIRECT_COMMUNICATION_KEEPALIVE message | Send a DIRECT_COMMUNICATION_KEEPALIVE message | +| T4103 | | Upon sending a DIRECT_COMMUNICATION_RELEASE message | Upon receiving a DIRECT_COMMUNICATION_RELEASE_ACCEPT message from the peer UE. | Stop using the corresponding direct link for one-to-one communication | +| T4104 | NOTE 9 | Upon receiving a ProSe Layer2 Group ID with an associated T4104 timer in a TMGI_MONITORING_RESPONSE message, as described in subclause 10.5. | Upon receiving one or more new T4104 timer values for the same ProSe Layer2 Group ID in a TMGI_MONITORING_RESPONSE message. | Re-initiate the TMGI monitoring request procedure, if the request from upper layers to receive the MBMS content for the given TMGI is still in place. | +| T4105 | NOTE 10 | Upon assigning a ProSe Layer2 Group ID with an associated T4104 value to the remote UE, as described in subclause 10.5. | Upon sending a new TMGI_MONITORING_RESPONSE for the same TMGI. | Delete the associated TMGI and MBMS SAI list. | + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|-------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4106 | NOTE 11 | Upon receiving a T4106 value in a CELL_ID_ANNOUNCEMENT_RESPONSE message as described in subclause 10.6. | Upon receiving one or more new T4106 timer values in a CELL_ID_ANNOUNCEMENT_RESPONSE message. | Re-initiate the cell ID announcement request procedure, if the upper layer application still needs to obtain ECGI of the cell serving the ProSe UE-to-network relay. | +| T4107 | NOTE 12 | Upon sending a CELL_ID_ANNOUNCEMENT_RESPONSE message as described in subclause 10.6. | Upon sending a new CELL_ID_ANNOUNCEMENT_RESPONSE message. | Stop the cell ID announcement in the PC5_DISCOVERY message for Relay Discovery Additional Information. | +| T4108 | | Upon receiving a Maximum Inactivity Period IE in DIRECT_COMMUNICATION_KEEPALIVE message; or when the UE has no more message or user data to send over the direct link. | Upon sending or receiving a PC5 Signaling message or user data over the direct link | Either initiate the direct link keepalive procedure or direct link release procedure. | +| T4109 | | Upon sending the PC5_DISCOVERY message for UE-to-Network Relay Discovery Solicitation used to trigger the PC5_DISCOVERY message signal strength measurement between the UE and the ProSe UE-to-network relay UE with which the UE has a link established. | Upon Receiving the PC5_DISCOVERY message for UE-to-Network Relay Discovery Response from the ProSe UE-to-network relay UE with which the UE has a link established, | Retransmission the PC5_DISCOVERY message for UE-to-Network Relay Discovery Solicitation, | +| T4110 | | Upon Receiving the PC5_DISCOVERY message for UE-to-Network Relay Discovery Response from the ProSe UE-to-network relay UE with which the UE has a link established, | Upon releasing the direct link with a ProSe UE-to-network relay UE. | Send the PC5_DISCOVERY message for UE-to-Network Relay Discovery Solicitation used to trigger the PC5_DISCOVERY message signal strength measurement between the UE and the ProSe UE-to-network relay UE with which the UE has a link established, | +| T4111 | | Upon sending a DIRECT_SECURITY_MODE_COMMAND message. | Upon receiving the DIRECT_SECURITY_MODE_COMPLETE or DIRECT_SECURITY_MODE_REJECT message. | Sending a DIRECT_COMMUNICATION_REJECT if the security mode control procedure is triggered by the DIRECT_COMMUNICATION_REQUEST message from the peer UE. | +| T4112 | | Upon sending a DIRECT_REKEYING_REQUEST message. | Upon receiving the DIRECT_REKEYING_RESPONSE message or receiving a DIRECT_REKEYING_REQUEST message from the peer UE and satisfying the conditions specified in subclause 10.4.8. | Retransmission of DIRECT_REKEYING_REQUEST message. | + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|-------------------------------------------------|------------------------------------------------------------------------|----------------------------------------------------| +| T4113 | | Upon sending a DIRECT_REKEYING_TRIGGER message. | Upon receiving the DIRECT_REKEYING_REQUEST message from the remote UE. | Retransmission of DIRECT_REKEYING_TRIGGER message. | +| NOTE 1: The value of this timer is provided by the ProSe Function during the announce request and discovery update procedure for open ProSe direct discovery. | | | | | +| NOTE 2: The value of this timer is provided by the ProSe Function during the monitor request and discovery update procedure for open ProSe direct discovery. | | | | | +| NOTE 3: The value of this timer is provided by the ProSe Function during the match report procedure for open ProSe direct discovery. | | | | | +| NOTE 4: The value of this timer is provided by the ProSe Function during service authorisation procedure. | | | | | +| NOTE 5: The value of this timer is provided by the ProSe Function during the announce request and discovery update procedure for restricted ProSe direct discovery model A. | | | | | +| NOTE 6: The value of this timer is provided by the ProSe Function during the monitor request and discovery update procedure for restricted ProSe direct discovery model A. | | | | | +| NOTE 7: The value of this timer is assigned by the ProSe Function during the discoveree request procedure for restricted ProSe direct discovery model B. | | | | | +| NOTE 8: The value of this timer is assigned by the ProSe Function during the discoverer request procedure for restricted ProSe direct discovery model B. | | | | | +| NOTE 9: The value of this timer is provided by the ProSe UE-to-network relay UE during the TMGI monitoring request procedure. | | | | | +| NOTE 10: The value of this timer is assigned by the ProSe UE-to-network relay UE during the TMGI monitoring request procedure | | | | | +| NOTE 11: The value of this timer is provided by the ProSe UE-to-network relay UE during the cell ID announcement request procedure. | | | | | +| NOTE 12: The value of this timer is assigned by the ProSe UE-to-network relay UE during the cell ID announcement request procedure. | | | | | +| NOTE 13: The value of this timer is provided by the ProSe Function during the match report procedure for restricted ProSe direct discovery model A or match report procedure for restricted ProSe direct discovery model B. | | | | | + +**Table 13.2.2: ProSe direct services timers – ProSe Function side** + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|-------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4001 | NOTE 1 | Upon assigning a ProSe Application Code with an associated T4000 value to the UE, as described in subclause 6.2.2.3 and subclause 6.2.7.2. | Upon receiving a new DISCOVERY_REQ UEST message from the UE with the command set to "announce" for the same ProSe Application ID. | Delete the association between the UE, the requested ProSe Application ID and the corresponding ProSe Application Code allocated by the ProSe Function. | +| T4003 | NOTE 2 | Upon assigning a Discovery Filter with an associated T4002 value to the UE, as described in subclause 6.2.3.3 and subclause 6.2.7.2. | Upon receiving a new DISCOVERY_REQ UEST message from the UE with the command set to "monitor" for the same ProSe Application ID | Delete the association between the UE, the requested ProSe Application ID and the corresponding Discovery Filter allocated by the ProSe Function. | +| T4008 | NOTE 3 | Upon assigning a ProSe Restricted Code or ProSe Restricted Code Prefix with an associated T4007 value to the UE, as described in subclause 6.2.2A.3 and subclause 6.2.6.3. | Upon receiving a new DISCOVERY_REQ UEST message from the UE with the command set to "announce" for the same RPAUID or discovery entry ID. Set to be the same as the discovery entry in which this timer is running. | Delete the association between the UE, the RPAUID and the corresponding ProSe Restricted Code or ProSe Restricted Code Prefix allocated by the ProSe Function. | +| T4010 | NOTE 4 | Upon assigning a Restricted Discovery Filter with an associated T4009 value to the UE, as described in subclause 6.2.3A.3 and subclause 6.2.6.2. | Upon receiving a new DISCOVERY_REQ UEST message from the UE with the command set to "monitor" and discovery entry ID set to be the same as the discovery entry in which this timer is running. | Delete the association between the UE, the RPAUID and the corresponding Restricted Discovery Filter allocated by the ProSe Function. | +| T4012 | NOTE 5 | Upon assigning a ProSe Query Code, ProSe Response Code and Discovery Query Filter(s) with an associated T4011 value to the UE, as described in subclause 6.2.2B.3. | Upon receiving a new DISCOVERY_REQ UEST message from the UE with the command set to "response" for the same RPAUID or discovery entry ID. Set to be the same as the discovery entry in which this timer is running. | Delete the discovery entry in discoveree UE context which contains association between the UE, the RPAUID and the corresponding ProSe Query Code, ProSe Response Code, Discovery Query Filter(s) allocated by the ProSe Function. | + +| TIMER NUM. | TIMER VALUE | CAUSE OF START | NORMAL STOP | ON EXPIRY | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T4014 | NOTE 6 | Upon retrieving the ProSe Query Code, ProSe Response Code from discoveree UE context and assigning Discovery Response Filter(s) with an associated T4013 value to the UE, as described in subclause 6.2.3B.3. | Upon receiving a new DISCOVERY_REQ_UEST message from the UE with the command set to "query" and discovery entry ID set to be the same as the discovery entry in which this timer is running. | Delete the discovery entry in discoverer UE context which contains the association between the UE, the RPAUID and the corresponding Discovery Response Filter(s) allocated by the ProSe Function. | +| T4018 | NOTE 7 | Upon assigning a ProSe Discovery UE ID with an associated T4015 value in the ProSe service authorisation as described in subclause 5.1.3. | Upon assigning a new ProSe Discovery UE ID for the same UE. | Delete the UE context related to the restricted discovery. | +| NOTE 1: The value of this timer is assigned by the ProSe Function during the announce request and discovery update procedure for open ProSe direct discovery. | | | | | +| NOTE 2: The value of this timer is assigned by the ProSe Function during the monitor request and discovery update procedure for open ProSe direct discovery. | | | | | +| NOTE 3: The value of this timer is assigned by the ProSe Function during the announce request and discovery update procedure for restricted ProSe direct discovery model A. | | | | | +| NOTE 4: The value of this timer is assigned by the ProSe Function during the monitor request and discovery update procedure for restricted ProSe direct discovery model A. | | | | | +| NOTE 5: The value of this timer is assigned by the ProSe Function during the discoveree request procedure for restricted ProSe direct discovery model B. | | | | | +| NOTE 6: The value of this timer is assigned by the ProSe Function during the discoverer request procedure for restricted ProSe direct discovery model B. | | | | | +| NOTE 7: The value of this timer is assigned by the ProSe Function during the service authorisation procedure. | | | | | + +NOTE: Multiple timers T4001, T4003, T4008, T4010, T4012 and T4014 can run simultaneously in the ProSe Function. + +--- + +## Annex A (informative): IANA registrations + +### A.1 IANA registrations for MIME types + +#### A.1.1 General + +RFC 4288 [26], subclause 9, states the process that applies in case of changes to the registry of media types. Any changes to the format after the registration with IANA would invoke this procedure. + +#### A.1.2 application/3gpp-prose-pc3ch+xml + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +Vendor Tree – 3gpp-prose-pc3ch+xml + +Required parameters: + +None + +Optional parameters: + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303. + +Encoding considerations: + +binary. + +Security considerations: + +Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303 [25]. The information transported in this media type does not include active or executable content. Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 33.303. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +The media type allows for interoperability of messages transmitted over the PC3ch interface, including those related to transport of the usage information request of proximity services. The messages are sent between user equipment and mobile network. + +Published specification: + +3GPP TS 24.334 () + +Applications which use this media type: + +n/a + +Fragment identifier considerations: + +The handling in section 5 of IETF RFC 7303 applies. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +n/a + +Additional information: + +1. Deprecated alias names for this type: n/a +2. Magic number(s): n/a +3. File extension(s): n/a +4. Macintosh File Type Code(s): n/a +5. Object Identifier(s) or OID(s): n/a + +Intended usage: + +Common. + +Other information/general comment: + +The media type is intended to be used in proximity service procedures. + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## A.1.3 application/3gpp-prose+xml + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +Vendor Tree – 3gpp-prose+xml + +Required parameters: + +None + +Optional parameters: + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in section 9.1 of IETF RFC 7303. + +Encoding considerations: + +binary. + +Security considerations: + +Same as general security considerations for application/xml media type as specified in section 9.1 of IETF RFC 7303. The information transported in this media type does not include active or executable content. Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 33.303. + +This media type does not include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +The media type allows for interoperability of messages transmitted for ProSe over the PC3 interface. The messages are sent between user equipment and mobile network. + +Published specification: + +3GPP TS 24.334 () + +Applications which use this media type: + +n/a + +Fragment identifier considerations: + +The handling in section 5 of IETF RFC 7303 applies. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +n/a + +Additional information: + +1. Deprecated alias names for this type: n/a +2. Magic number(s): n/a +3. File extension(s): n/a +4. Macintosh File Type Code(s): n/a +5. Object Identifier(s) or OID(s): n/a + +Intended usage: + +Common. + +Other information/general comment: + +The media type is intended to be used in proximity service procedures. + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|------------|-----------|------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-03 | | | | | TS skeleton generated for submission at CT1#86bis | - | 0.0.0 | +| 2014-04 | CT1#86bis | | | | Implementation of C1-141576, C1-141623, C1-141533 and C1-141534. | 0.0.0 | 0.1.0 | +| 2014-05 | CT1#87 | | | | Implementation of C1-142123, C1-142152, C1-142153, C1-142187, C1-142188, C1-142189, C1-142190, C1-142191, C1-142192, C1-142195, C1-142198 and C1-142498. | 0.1.0 | 0.2.0 | +| 2014-06 | CT-64 | CP-140279 | | | Version 1.0.0 created for presentation for information to CT plenary | 0.2.0 | 1.0.0 | +| 2014-07 | CT1#88 | | | | Implementation of C1-142652, C1-142674, C1-142700, C1-142833, C1-142851, C1-142852, C1-142998, C1-143022, C1-143027, C1-143238, C1-143240, C1-143241, C1-143243, C1-143246, C1-143247, C1-143248, C1-143249, C1-143251, C1-143319, C1-143347, C1-143348, C1-143349, C1-143359 and C1-143360. Editorial corrections. | 1.0.0 | 1.1.0 | +| 2014-09 | CT-65 | CP-140630 | | | Version 2.0.0 created for presentation for approval to CT plenary | 1.1.0 | 2.0.0 | +| 2014-09 | CT-65 | CP-140717 | | | Plenary tdoc revised to include missing cover sheet | 1.1.0 | 2.0.0 | +| 2014-09 | Post CT-65 | | | | Version 12.0.0 created after approval | 2.0.0 | 12.0.0 | +| 2014-12 | CT-66 | CP-140847 | 0002 | 5 | Update of PC5_DISCOVERY message | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0003 | 4 | Update of provisioning parameters list in subclause 5.1.3 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0004 | 3 | Update "time parameter" to "UTC-based counter" | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0005 | 1 | Maximum number of retransmissions and retransmission timers in case of abnormal cases during ProSe direct discovery | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0006 | | Update of range for timers T4000, T4002 and T4004 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0007 | | Correction and clarification of Prose Function processing for monitor request procedure in ProSe direct discovery | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0009 | 4 | Methods for Server-initiated Procedures EPC-level ProSe Discovery | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0011 | 1 | ProSe Indication for ProSe Announcement and Monitoring | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0012 | 2 | Handling of unknown, unforeseen, and erroneous protocol data in TS 24.334 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0013 | 1 | Addition of CURRENT_TIME and MAX_OFFSET parameters for ProSe direct discovery | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0014 | 1 | Correction of HTTP RFC reference in TS 24.334 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0015 | 1 | Editorial changes to subclause 11.2.4 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0016 | 2 | Addition of Overview subclause to TS 24.334 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0017 | | Format of metadata | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0018 | 1 | Clarification of UE Identity Encoding | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0019 | 4 | Prose Service authorisation | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0021 | 1 | Correction on triggering condition and ProSe Function processing for Match Report procedure | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0022 | 2 | Definition for EPC Prose User ID | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0023 | 2 | Correction for PC3 EPC control Protocol cause value | 12.0.0 | 12.1.0 | + +| | | | | | | | | +|---------|------------|-----------|------|---|------------------------------------------------------------------------------------------------|--------|--------| +| 2014-12 | CT-66 | CP-140847 | 0024 | 2 | Correction for proximity request cancellation procedure | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0025 | 1 | Handling of Announce request in the ProSe function | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0026 | 1 | Trigger to initiate announce request procedure | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0027 | | Correction to match report procedure – storage of mapping | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0028 | 1 | Correction to UE context handling | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0029 | | Alignment on ProSe service authorisation update procedure | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0035 | 1 | Gaps between T4001/T4000 and T4003/T4002 timers in ProSe | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0036 | 1 | Addition of parameters for usage information reporting | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0037 | 1 | Update of subclause 8 | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0038 | | Erroneous Cause Values & editorial corrections | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0039 | | ProSe Function initiated ProSe Request Cancellation message | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0040 | 1 | Unknown ProSe App ID in Announce Request Procedure | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0042 | 2 | Correction to monitoring request procedure not accepted by ProSe Function | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0043 | | UE Identity coding for EPC-level ProSe discovery | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0044 | 2 | Use of mask for full matching | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0045 | 2 | Restructure of Discovery Filter IE | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0048 | 1 | Correction on Allowed Range parameter | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0049 | 1 | Correction on application registration using user's profile | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0010 | 4 | ProSe for UEs in Limited Service State | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0020 | 3 | Clarification on the service authorisation triggering condition | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0034 | 1 | Geographic Area Check for UICC-Configured Radio Resource for ProSe | 12.0.0 | 12.1.0 | +| 2014-12 | CT-66 | CP-140847 | 0050 | 1 | Clarification on ProSe Application ID authorization | 12.0.0 | 12.1.0 | +| 2015-01 | Post CT-66 | | | | Correct implementation of CR0018 | 12.1.0 | 12.1.1 | +| 2015-03 | CT-67 | CP-150071 | 0032 | 6 | Specifying PDN connection to be used to reach HPLMN ProSe Function | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0054 | 1 | Proximity Request Validation | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0055 | | Removal of Editor's note on XML schema namespace in TS 24.334 | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0057 | 1 | Information for IANA registration of MIME type application/3gpp-prose+xml | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0058 | 1 | Update of definition for UTC-based counter in TS 24.334 | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0060 | 2 | Clarification on the application identity check | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0062 | 1 | start of validity timer on the UE side during announce request procedure | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0064 | | Removal of text that should have been marked as deleted in agreed C1-144911 | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0066 | 2 | Alignment to Stage 2 regarding using provisioned radio resource for ProSe direct communication | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0067 | | Change the data type of EPUID in XML schema | 12.1.1 | 12.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|-----------------------------------------------------------------------------------------------------|--------|--------| +| 2015-03 | CT-67 | CP-150071 | 0069 | | Scope clarification for ProSe direct discovery in TS 24.334 – alternative 1 | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0071 | | Clarification for service continuity of ProSe direct communication service | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0072 | 1 | UE behaviour when moving out of a geographical area while performing ProSe direct communication | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0073 | 1 | Radio parameters and geographical areas for ProSe direct communication | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0075 | 1 | Update of XML semantic descriptions for ProSe discovery messages to include extensible XML elements | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0076 | 1 | Corrections to one-to-many direct communication | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0077 | 1 | TAU for ProSe Direct Discovery and ProSe Direct Communication | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0078 | 1 | Invalid Application Layer User ID for EPC level discovery | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0079 | 2 | Discovery Type element in PC3 message | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0080 | | Update scope of TS 24.334 | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0081 | 2 | Update clause 4.1 | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0089 | | Corrections to XML schema for direct discovery | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0052 | 1 | Usage information report - data format | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150071 | 0053 | 1 | Usage information report - procedures | 12.1.1 | 12.2.0 | +| 2015-03 | CT-67 | CP-150179 | 0065 | 3 | Adding behavior description of receiving UE for ProSe direct communication | 12.1.1 | 12.2.0 | +| 2015-06 | CT-68 | CP-150316 | 0068 | 7 | PLMN selection triggered by ProSe direct communication | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0090 | 1 | Stop the running T4000/T4002 before restart | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0095 | | Editor's notes on references to ASN.1 data types specified in TS 36.331 | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0096 | | ProSe Direct communication when UE cannot determine its location | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0103 | 1 | Correction of inconsistencies in Message format and Information Element definitions | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0104 | 1 | Addition of Match Report Refresh Timer T4006 | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0105 | | Removal of Editor's Note about Radio Parameter Configuration for ProSe Direct Communication | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0106 | 5 | ProSe direct discovery announcements to AS layer | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0107 | | Mointored PLMN use correction in Match report procedure | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0111 | 3 | Correction of service request triggering condition for ProSe direct service | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0114 | | Correct the wrong condition in Monitor request procedure | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0117 | 1 | Add the ProSe Application ID check operation in ProSe Function | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0118 | 1 | Update of ProSe IANA registration forms | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0120 | 1 | Service authorisation procedure update | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0121 | 1 | Correction of 'Not served by E-UTRAN' | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150316 | 0122 | | Security of HTTP messages | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150329 | 0093 | 1 | Condition for the ProSe function to remove the entry in UE's context | 12.3.0 | 13.0.0 | +| 2015-06 | CT-68 | CP-150329 | 0102 | 2 | Service authorisation procedure based on the location | 12.3.0 | 13.0.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|-----------------------------------------------------------------------------------------------------------|--------|--------| +| 2015-06 | CT-68 | CP-150329 | 0108 | | VPLMN ID deletion in the MATCH_REPORT message | 12.3.0 | 13.0.0 | +| 2015-06 | CT-68 | CP-150329 | 0115 | 1 | Service authorisation description alignment | 12.3.0 | 13.0.0 | +| 2015-06 | CT-68 | CP-150329 | 0116 | 1 | Clarification on how to use the Discovery Key | 12.3.0 | 13.0.0 | +| 2015-09 | CT-69 | CP-150528 | 0123 | 1 | Enhancement to announce request procedure for open ProSe Direct Discovery | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0124 | 1 | Enhancement to monitor request procedure for open ProSe Direct Discovery | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0125 | 1 | Restricted Discovery filters revocation | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0126 | 1 | New ProSe Restricted Code allocation | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0129 | 1 | Direct Discovery update for open discovery | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150517 | 0131 | 2 | Correction of 'Not served by E-UTRAN' | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150517 | 0132 | 2 | Stopping T4004 upon MATCH REPORT Reject | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0135 | 2 | Announce request procedure for restricted ProSe direct discovery Model A | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0136 | 1 | Monitor request procedure for restricted ProSe direct discovery model A | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0137 | 1 | Discoverer request procedure for restricted ProSe direct discovery model B | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0138 | 1 | Discoverer request procedure for restricted ProSe direct discovery model B | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0139 | 1 | Clarification to open ProSe direct discovery procedures | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150517 | 0141 | | Removal of Editor's note on PC3ch XML schema namespace in TS 24.334 | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150517 | 0143 | 1 | Removal of Discovery Filter ID | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0144 | 1 | Update of ProSe service authorisation for restricted ProSe direct discovery | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150517 | 0145 | 2 | Add the command check operation in the ProSe Function | 13.0.0 | 13.1.0 | +| 2015-09 | CT-69 | CP-150528 | 0148 | 2 | Restricted ProSe Direct Discovery with on-demand announcing | 13.0.0 | 13.1.0 | +| 2015-12 | CT-70 | CP-150708 | 0153 | 5 | ProSe direct discovery for public safety use - coding | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0154 | 5 | ProSe direct discovery for public safety use - UE-to-network relay procedures | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0155 | 5 | ProSe direct discovery for public safety use - group member discovery procedures | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0156 | 1 | The granularity for application authorisation check | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0157 | 1 | Timer T4007 handling for On Demand Announcing | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0158 | 2 | Associate the Target RPAUID and corresponding Restricted Discovery Filters | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0159 | 2 | Mandate the target RPAUID in the DISCOVERY_RESPONSE message for restricted ProSe direct discovery model B | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0160 | 3 | Authorisation check when the UE's context exist | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0162 | 1 | Figure clarification for Direct discovery update procedure for open discovery | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0164 | | Removal of Editor's Notes for Discovery Filter Update | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0165 | 1 | New ProSe Discovery Update message | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0166 | | Timer update | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0167 | 2 | Service authorisation trigger at the expiry of T4015 | 13.1.0 | 13.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------------------------|------------|--------| +| | | | | | | 0 | | +| 2015-12 | CT-70 | CP-150708 | 0168 | 3 | Non-Zero Discovery Entry ID | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0169 | 4 | Match report procedures for restricted ProSe direct discovery Model A | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0170 | 3 | Match report procedure for restricted ProSe direct discovery Model B | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0172 | 1 | Addition of UE handling of parameters Current Time and Max Offset | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0173 | 2 | Error handling for restricted discovery when application-controlled extension is used | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150692 | 0175 | | Fix the usage of Invalid UTC time error in the Match Report procedure | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0176 | 1 | Clean up for TS 24.334 | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0177 | 3 | PC5 signalling protocol for one-to-one ProSe direct communication | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0178 | 1 | Metadata upload during Discovery Request procedure | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0181 | 5 | PC5_DISCOVERY message format for restricted ProSe direct discovery | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0182 | 1 | Update of ProSe service authorisation for one-to-one communication | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0184 | 2 | Add ProSe Application Code check in the monitor request procedure | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150692 | 0186 | | Remove the Discovery Type from the DISCOVERY_RESPONSE message | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0187 | 2 | Announcing Alert procedure update | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0188 | 1 | Dynamic metadata support in Open direct discovery | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0189 | 7 | TMGI monitoring request procedure for eMBMS traffic relay | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0190 | 2 | Configuration for ProSe Function-initiated PC3 procedures for ProSe direct discovery | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150692 | 0192 | | Removal of Editor's notes on IANA registrations for ProSe MIME types | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0193 | 6 | Announcement of Relay Discovery Additional Information for public safety use | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0194 | 5 | PC5 discovery message format for PS discovery and Relay discovery additional Information | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0196 | 1 | Scope Clarification of ProSe Direct discovery when not served by E-UTRAN | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0199 | 3 | UE-to-network relay selection and reselection procedure | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0200 | | Value range of Requested Timer parameter | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0201 | 1 | Inter-PLMN discovery transmission | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0202 | 1 | ProSe Per-Packet Priority | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0203 | 1 | Add a validity timer about the ProSe Discovery UE ID in the ProSe Function | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0204 | 1 | Add the missed ACE-enabled-indicator in the XML Schema | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0205 | 2 | Cell ID announcement request procedure | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0206 | 2 | Correct a mistake about Discovery Type | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0207 | 2 | Update the Monitor request procedure for restricted ProSe direct discovery for the latest metadata receiving | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150710 | 0208 | 1 | Support for multiple ProSe Application Codes in element of DISCOVERY_RESPONSE message | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0209 | 2 | Invalid suffix information error in the Discovery Request message | 13.1.
0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0210 | 1 | Clarification on PF behaviour for open discovery | 13.1.
0 | 13.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------------------|--------|--------| +| | | | | | | 0 | | +| 2015-12 | CT-70 | CP-150708 | 0211 | | UE Timer handling | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150708 | 0212 | 1 | Per PLMN check authorisation | 13.1.0 | 13.2.0 | +| 2015-12 | CT-70 | CP-150692 | 0214 | 1 | Correction of triggering condition for PLMN selection triggered by ProSe direct communication | 13.1.0 | 13.2.0 | +| 2016-03 | CT-71 | CP-160157 | 0215 | | ProSe direct discovery for public safety use - Editor's notes in group member discovery procedures | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0216 | 2 | UE initiated discovery update procedure for announce request procedure for restricted discovery mode A | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0217 | 1 | UE initiated discovery update procedure for monitor request procedure for restricted discovery mode A | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0218 | 3 | Application Layer Group ID | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0219 | | ProSe Per-Packet Priority for UE-to-Network Relay | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0220 | 3 | Add QCI and PPP in the TMGI Monitoring request procedure | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0221 | | Correction about link layer identifier | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0222 | 1 | Discovery message signal strength measurement for relay selection/reselection with model A | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0223 | 1 | Discovery message signal strength measurement for relay selection/reselection with model B | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0224 | 2 | Restricted Discovery Filter correction | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0226 | 1 | Security parameters for restricted ProSe direct discovery for non-Public Safety use | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0227 | 1 | Security procedures for restricted ProSe direct discovery for public safety use | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0228 | | Corrections and clean-up for 24.334 | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0229 | | Removal of editor's note about ProSe Restricted Code format | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0230 | 1 | Transport aspect of eMBMS traffic relay | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0231 | 3 | PC5 Signalling message flooding for PC5 link quality measurement | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0232 | 2 | Indication to lower layers for relay discovery | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0234 | 4 | Radio resource parameter selection for ProSe direct discovery for public safety use | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0236 | 2 | Clarification on IP address configuration in the direct link setup procedure | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0237 | 2 | Triggering PDN connectivity request procedure for relaying | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0239 | 1 | Triggering condition on remote UE report procedure | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0240 | 1 | Content and format of User Info parameter for one-to-one ProSe direct communication | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0241 | 1 | Application controlled extension for open ProSe direct discovery | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0242 | 1 | Provisioning of mapping rules for QCI and ProSe Per-Packet Priority in UE-to-network Relay | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0243 | | Discovery Type Parameter | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0244 | 1 | Corrections to TMGI Request Procedure | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0245 | | Addition of provisioning parameter for security of relay discovery | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0246 | 1 | Removing Timer T4005 when 'Not served by E-UTRAN' | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0247 | | Adding the purpose to send PC5 discovery message in model A | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0248 | 1 | Add a new PC3 control cause value for discovery update | 13.2.0 | 13.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---------------------------------------------------------------------------------------------------------------------|--------|--------| +| | | | | | and announcing alert procedure | 0 | | +| 2016-03 | CT-71 | CP-160157 | 0250 | 2 | Clean up the mistakes related to PC3 control protocol cause value | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0251 | 1 | Remove the duplicated check in the relay selection procedure | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0252 | 1 | Update the relay reselection conditions | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0254 | 1 | PC5 discovery passing for inter-PLMN discovery transmission | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0255 | 2 | ProSe UE-to-network relaying policy control and charging requirements | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0256 | 3 | Public safety direct discovery parameters provided by the 3rd party application server | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0258 | | Removal of Editor's note on the usage of relay User Info ID for relay discovery | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0259 | 2 | Message Type field of PC5_DISCOVERY in match report procedures | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0262 | 1 | UE behaviour upon receiving PC5 signalling cause value#4 | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0263 | 1 | Match Report security parameter for restricted discovery | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0264 | 1 | Sending additional LSBs of the UTC based counter in PC5_DISCOVERY message | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0249 | 2 | Add Application Level Container in the DISCOVERY_RESPONSE message | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | CP-160157 | 0260 | 2 | Security establishment procedures for ProSe one-to-one communication | 13.2.0 | 13.3.0 | +| 2016-03 | CT-71 | | | | Various corrections after rapporteur's review | 13.3.0 | 13.3.1 | +| 2016-06 | CT-72 | CP-160311 | 0265 | 2 | Avoiding unnecessary requests in direct link rekeying procedure | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0266 | | Clarification to the definition of Suffix Range | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0267 | | Correction to number of UTC-based counter LSBs included in public safety direct discovery messages | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0268 | | Removal of Editor's notes on the coding of the ProSe Application Code Prefix and Suffix | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0269 | | Removal of Editor's notes with dependencies on RAN2 specifications | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160305 | 0271 | | Correction to the usage of the LSBs of the UTC-based counter in PC5_DISCOVERY message | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0272 | 1 | ProSe direct discovery in limited service state | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0273 | 1 | Corrections for semantic of spare bits and reserved values | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0274 | 1 | Corrections for reserved bits in GMDS Composition IE, RDAI Composition IE, URDS Composition IE, Status Indicator IE | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0275 | 2 | T4104 Correction | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0277 | | Correction for IP version selection | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0278 | 1 | Clarification on Layer 2 ID for unicast communication | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0279 | 1 | Correction on radio resource selection for ProSe direct discovery | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0282 | | Addition of provisioning of range for public safety discovery | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0283 | 1 | Remote UE IMEI Reporting via PC5 | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0285 | 1 | Triggers to initiate TMGI monitoring request procedure | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0288 | | Removing Per-PLMN Service Authorization for Remote UEs | 13.3.1 | 13.4.0 | +| 2016-06 | CT-72 | CP-160311 | 0289 | 1 | RSRP conditions for Relay and Remote UEs | 13.3.1 | 13.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------|------------|--------| +| 2016-06 | CT-72 | CP-160311 | 0286 | 1 | Clarification for inter-PLMN discovery support | 13.3.
1 | 13.4.0 | +| 2016-06 | CT-72 | | | | Various corrections | 13.4.
0 | 13.4.1 | + +| Change history | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|------------------------------------------------------------------------------------------------------------------------|--------------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160493 | 0290 | 1 | F | Target Info coding for Group member discovery solicitation | 13.5.0 | +| 2016-09 | CT#73 | CP-160493 | 0291 | 1 | F | Correction for signal strength measurement by PC5_Discovery message | 13.5.0 | +| 2016-12 | CT#74 | CP-160727 | 0295 | | F | Corrections to the XML schema used over the PC3 interface | 13.6.0 | +| 2016-12 | CT#74 | CP-160753 | 0292 | 2 | F | Clarification of the UE action when the UE receives the DISCOVERY_UPDATE_REQUEST message not including the Update Info | 14.0.0 | +| 2016-12 | CT#74 | CP-160753 | 0293 | 4 | F | Clarification of the UE action when the UE receives the DISCOVERY_UPDATE_REQUEST message including the Update Info | 14.0.0 | +| 2016-12 | CT#74 | CP-160754 | 0294 | 2 | B | Non-IP Support | 14.0.0 | +| 2016-12 | CT#74 | CP-160753 | 0296 | 1 | D | Editorial corrections to TS 24.334 | 14.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0297 | 1 | B | Update to Scope and Overview for WLAN DD | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0298 | 1 | B | Updates to ProSe Service Authorisation for WLAN Direct Discovery | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0299 | 1 | B | Updates to Announce request procedure for open WLAN based ProSe direct discovery | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0300 | 1 | B | Updates to Announce request procedure for restricted WLAN based ProSe direct discovery model A | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0301 | 1 | B | Updates to Discoveree request procedure for restricted ProSe direct discovery model B | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0302 | 1 | B | Updates to Discoverer request procedure for restricted ProSe direct discovery model B | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0303 | 1 | B | Updates to Monitor request procedure for open ProSe direct discovery | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0304 | 1 | B | Updates to Monitor request procedure for restricted ProSe direct discovery model A | 15.0.0 | +| 2017-09 | CT#77 | CP-172119 | 0305 | 2 | B | Definition of PC5_tech Parameter | 15.0.0 | +| 2017-12 | CT#78 | CP-173076 | 0306 | 2 | B | Updates to ProSe Service Authorisation for WLAN based Direct Discovery | 15.1.0 | +| 2017-12 | CT#78 | CP-173076 | 0307 | 1 | B | Updates to Match report procedure for open ProSe direct discovery | 15.1.0 | +| 2017-12 | CT#78 | CP-173076 | 0308 | 1 | B | Updates to Match report procedure for restricted ProSe direct discovery model A | 15.1.0 | +| 2017-12 | CT#78 | CP-173076 | 0309 | 1 | B | Updates to Match report procedure for restricted ProSe direct discovery model B | 15.1.0 | +| 2017-12 | CT#78 | CP-173076 | 0310 | 2 | B | Updates to XML Schema for WLAN based Direct Discovery | 15.1.0 | +| 2017-12 | CT#78 | CP-173076 | 0311 | 2 | B | Updates to Semantics for WLAN based Direct Discovery | 15.1.0 | +| 2018-09 | CT#81 | CP-182152 | 0312 | | F | Correction for reliable transmission over ProSe PC5 | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0313 | 2 | F | Corrections of coding of length fields in PC5 Signalling messages | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0314 | 1 | F | Correction of MBMS SAI IE to conform to TLV-E | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0315 | | F | Corrections to One to one ProSe direct communication release procedures | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0316 | | F | Correction of message names. | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0317 | | D | Duplicate clause numbering | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0319 | 1 | F | Missing reference and wrong cross reference | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0320 | | F | Correction of TV coding of IMEI IEI for PC5 signaling messages | 15.2.0 | +| 2018-09 | CT#81 | CP-182117 | 0323 | 1 | A | Correction of duplicate IEI values | 15.2.0 | +| 2018-09 | CT#81 | CP-182117 | 0326 | | A | Correction of GPI IE type | 15.2.0 | +| 2018-09 | CT#81 | CP-182158 | 0327 | | D | Correction of subclause heading styles | 15.2.0 | +| 2020-07 | SA#88e | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24368/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/marked/Rel-16/24_series/24368/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b88a7febad74a6ed93d28360b5fc263aeeffc4bd --- /dev/null +++ b/marked/Rel-16/24_series/24368/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f25a49a5dab54420a75d26737f883b66bc022067e91448d7e83400fe698c0ab +size 24956 diff --git a/marked/Rel-16/24_series/24368/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/24_series/24368/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e44046f677be8e8aaea0428374de3f521b574971 --- /dev/null +++ b/marked/Rel-16/24_series/24368/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63a16f803dd5fb72fa5087bea1feedcfa4828f71416e2a228569ce9cee4b03c2 +size 141953 diff --git a/marked/Rel-16/24_series/24368/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg b/marked/Rel-16/24_series/24368/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..531b043389f3c61fe51b656dfd17cc29b7dd0025 --- /dev/null +++ b/marked/Rel-16/24_series/24368/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ee88fcb8cc02571b26538d60d82beabcb4afa9a1cb883332592736de340faea +size 11438 diff --git a/marked/Rel-16/24_series/24368/raw.md b/marked/Rel-16/24_series/24368/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d5982fc7ca789f047bf4c352e8efd689affb03c8 --- /dev/null +++ b/marked/Rel-16/24_series/24368/raw.md @@ -0,0 +1,2262 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 NAS configuration MO..... | 7 | +| 5 NAS configuration MO parameters ..... | 10 | +| 5.1 General ..... | 10 | +| 5.2 Node: ..... | 10 | +| 5.3 /NAS_SignallingPriority ..... | 10 | +| 5.4 /AttachWithIMSI..... | 11 | +| 5.5 /MinimumPeriodicSearchTimer..... | 11 | +| 5.6 /NMO_I_Behaviour..... | 11 | +| 5.7 /Timer_T3245_Behaviour ..... | 12 | +| 5.8 /ExtendedAccessBarring ..... | 12 | +| 5.9 /Override_NAS_SignallingLowPriority..... | 12 | +| 5.10 /Override_ExtendedAccessBarring ..... | 13 | +| 5.10a /FastFirstHigherPriorityPLMNSearch..... | 13 | +| 5.10b /EUTRADisablingAllowedForEMMCause15 ..... | 13 | +| 5.10c /SM_RetryWaitTime ..... | 14 | +| 5.10d /SM_RetryAtRATChange ..... | 14 | +| 5.10e /Default_DCN_ID ..... | 14 | +| 5.10f //3GPP_PS_data_off..... | 15 | +| 5.10g //3GPP_PS_data_off/Exempted_service_list ..... | 15 | +| 5.10h Void..... | 15 | +| 5.10i //3GPP_PS_data_off/Exempted_service_list/Device_management_over_PS..... | 15 | +| 5.10j //3GPP_PS_data_off/Exempted_service_list/Bearer_independent_protocol ..... | 15 | +| 5.10k /ExceptionDataReportingAllowed ..... | 16 | +| 5.10l //3GPP_PS_data_off/Exempted_service_list_roaming..... | 16 | +| 5.10m //3GPP_PS_data_off/Exempted_service_list_roaming/Device_management_over_PS ..... | 16 | +| 5.10n //3GPP_PS_data_off/Exempted_service_list_roaming/Bearer_independent_protocol ..... | 17 | +| 5.10o //EARFCNList..... | 17 | +| 5.10p //EARFCNList/ ..... | 17 | +| 5.10q //EARFCNList//EARFCN ..... | 17 | +| 5.10r //EARFCNList//GeographicalArea..... | 18 | +| 5.10s //EARFCNList//GeographicalArea/Polygon ..... | 18 | +| 5.10t //EARFCNList//GeographicalArea/Polygon/ ..... | 18 | +| 5.10u //EARFCNList//GeographicalArea/Polygon// Coordinates ..... | 18 | +| 5.10v //EARFCNList//GeographicalArea/Polygon// Coordinates/ ..... | 19 | +| 5.10w //EARFCNList//GeographicalArea/Polygon// Coordinates//Latitude..... | 19 | +| 5.10x //EARFCNList//GeographicalArea/Polygon// Coordinates//Longitude ..... | 19 | +| 5.10y //RLOSPreferredPLMNList ..... | 19 | +| 5.10z //RLOSPreferredPLMNList/ ..... | 20 | +| 5.10za //RLOSPreferredPLMNList//PLMN..... | 20 | +| 5.10zb//RLOSPreferredPLMNList//PLMNPriority ..... | 20 | +| 5.10zc //MfgAssignUERadioCapId..... | 20 | +| 5.10zca //MfgAssignUERadioCapId/VendorID..... | 20 | +| 5.10zd //MfgAssignUERadioCapId/..... | 21 | +| 5.10ze //MfgAssignUERadioCapId//RCI..... | 21 | +| 5.10zf //MfgAssignUERadioCapId//UERadioConfigLTE ..... | 21 | +| 5.10zg //MfgAssignUERadioCapId//UERadioConfigNR ..... | 21 | +| 5.10zh //RLOSAppearedMCCList..... | 22 | +| 5.10zi //RLOSAppearedMCCList/ ..... | 22 | +| 5.10zj //RLOSAppearedMCCList//MCC ..... | 22 | +| 5.10zk //SNPN_Configuration ..... | 22 | + +5.10zl //SNPN\_Configuration/..... 22 + +5.10zm //SNPN\_Configuration//SNPN\_identifier..... 23 + +5.10zn //SNPN\_Configuration//3GPP\_PS\_data\_off..... 23 + +5.10zo //SNPN\_Configuration//3GPP\_PS\_data\_off/Exempted\_service\_list..... 23 + +5.10zp //SNPN\_Configuration//3GPP\_PS\_data\_off/ +Exempted\_service\_list/Device\_management\_over\_PS..... 24 + +5.10zq //SNPN\_Configuration//3GPP\_PS\_data\_off/ +Exempted\_service\_list/Bearer\_independent\_protocol..... 24 + +5.10zr /SNPN\_Configuration//SM\_RetryWaitTime..... 24 + +5.10zs /SNPN\_Configuration//Timer\_T3245\_Behaviour..... 24 + +5.11 /Ext ..... 25 + +**Annex A (informative): NAS configuration MO DDF ..... 26** + +**Annex B (informative): Change history ..... 42** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document defines a Management Object (MO) that can be used to configure the UE with parameters related to Non-Access Stratum (NAS) functionality. + +The MO is compatible with the OMA Device Management (DM) protocol specifications, version 1.2 and upwards, and is defined using the OMA DM Device Description Framework (DDF) as described in the Enabler Release Definition OMA-ERELD-DM-V1\_2 [2]. + +The MO consists of relevant parameters for NAS related configuration of a UE. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] OMA-ERELD-DM-V1\_2: "Enabler Release Definition for OMA Device Management". +- [3] 3GPP TS 23.122: "Non-Access-Stratum (NAS) functions related to Mobile Station (MS) in idle mode". +- [4] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [5] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [5A] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [6] 3GPP TS 31.102: "Characteristics of the USIM Application". +- [7] 3GPP TS 31.111: "Universal Subscriber Identity Module (USIM) Application Toolkit (USAT)". +- [8] 3GPP TS 36.101: "Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) radio transmission and reception". +- [9] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [10] 3GPP TS 36.304: "Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) procedures in idle mode". +- [11] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [12] 3GPP TS 23.221: "Architectural requirements". +- [13] 3GPP TS 23.003: "Numbering, addressing and identification". +- [14] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC) protocol specification". +- [15] 3GPP TS 38.331: "NR; Radio Resource Control (RRC); Protocol Specification". +- [16] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] apply. + +**Reserved:** The value "reserved" is assigned to a code point to indicate that it is reserved for future use. The present document specifies no processing rules for handling of "reserved" value by the receiving entity. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.122 [6] apply: + +**EHPLMN** + +**HPLMN** + +**VPLMN** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.501 [16] apply: + +**Stand-alone Non-Public Network** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.301 [5] apply: + +**In NB-S1 mode** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.221 [12] apply: + +**Restricted Local Operator Services** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.501 [11] apply: + +**SNPN access operation mode** + +## 3.2 Abbreviations + +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]. + +| | | +|--------|------------------------------------------------| +| ACL | Access Control List | +| DDF | Device Description Framework | +| DM | Device Management | +| EARFCN | E-UTRA Absolute Radio Frequency Channel Number | +| MO | Management Object | +| MTC | Machine-Type Communications | +| NAS | Non-Access Stratum | +| NB-IoT | Narrowband IoT | +| NID | Network Identifier | +| OMA | Open Mobile Alliance | +| RLOS | Restricted Local Operator Services | +| SNPN | Stand-alone Non-Public Network | + +# 4 NAS configuration MO + +The NAS configuration MO is used to manage configuration parameters related to NAS functionality for a UE supporting provisioning of such information. The presence and format of the non-access stratum configuration file on the USIM is specified in 3GPP TS 31.102 [6]. + +The MO identifier is: urn:oma:mo:ext-3gpp-nas-config:1.0. + +The OMA DM Access Control List (ACL) property mechanism (see OMA-ERELD-DM-V1\_2 [2]) may be used to grant or deny access rights to OMA DM servers in order to modify nodes and leaf objects of the NAS configuration MO. + +The following nodes and leaf objects are possible in the NAS configuration MO as described in figure 4-1: + +![ASN.1 structure diagram for NAS_SignallingPriority. It shows a sequence of fields including AttachWithIMSI, MinimumPeriodicSearchTimer, NMO_I_Behaviour, Timer_T3245_Behaviour, ExtendedAccessBarring, Override_NAS_SignallingLowPriority, Override_ExtendedAccessBarring, FastFirstHigherPriorityPLMNSearch, EUTRADisablingAllowedForEMMCause15, SM_RetryWaitTime, SM_RetryAtRATChange, ExceptionDataReportingAllowed, and Default_DCN_ID. It also includes 3GPP_PS_data_off (with Exempted_service_list and Exempted_service_list_roaming), EARFCNList (with EARFCN and GeographicalArea), RLOSPreferredPLMNList (with PLMN and PLMNPriority), RLOSAllowedMCCList (with MCC), MfgAssignUERadioCapId (with VendorID, RQ, UERadioConfigLTE, and UERadioConfigNR), SNPN_Configuration, and Ext?.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` +graph TD + Root[""] --- NAS_SignallingPriority["NAS_SignallingPriority?"] + Root --- AttachWithIMSI["AttachWithIMSI?"] + Root --- MinimumPeriodicSearchTimer["MinimumPeriodicSearchTimer?"] + Root --- NMO_I_Behaviour["NMO_I_Behaviour?"] + Root --- Timer_T3245_Behaviour["Timer_T3245_Behaviour?"] + Root --- ExtendedAccessBarring["ExtendedAccessBarring?"] + Root --- Override_NAS_SignallingLowPriority["Override_NAS_SignallingLowPriority?"] + Root --- Override_ExtendedAccessBarring["Override_ExtendedAccessBarring?"] + Root --- FastFirstHigherPriorityPLMNSearch["FastFirstHigherPriorityPLMNSearch?"] + Root --- EUTRADisablingAllowedForEMMCause15["EUTRADisablingAllowedForEMMCause15?"] + Root --- SM_RetryWaitTime["SM_RetryWaitTime?"] + Root --- SM_RetryAtRATChange["SM_RetryAtRATChange?"] + Root --- ExceptionDataReportingAllowed["ExceptionDataReportingAllowed?"] + Root --- Default_DCN_ID["Default_DCN_ID?"] + Root --- 3GPP_PS_data_off["3GPP_PS_data_off?"] + Root --- EARFCNList["EARFCNList?"] + Root --- RLOSPreferredPLMNList["RLOSPreferredPLMNList?"] + Root --- RLOSAllowedMCCList["RLOSAllowedMCCList?"] + Root --- MfgAssignUERadioCapId["MfgAssignUERadioCapId?"] + Root --- SNPN_Configuration["SNPN_Configuration?"] + Root --- Ext["Ext?"] + + 3GPP_PS_data_off --- Exempted_service_list["Exempted_service_list?"] + 3GPP_PS_data_off --- Exempted_service_list_roaming["Exempted_service_list_roaming?"] + + Exempted_service_list --- Device_management_over_PS1["Device_management_over_PS"] + Exempted_service_list --- Bearer_independent_p_protocol1["Bearer_independent_p_protocol"] + + Exempted_service_list_roaming --- Device_management_over_PS2["Device_management_over_PS"] + Exempted_service_list_roaming --- Bearer_independent_p_protocol2["Bearer_independent_p_protocol"] + + EARFCNList --- X_plus1["+"] + X_plus1 --- EARFCN["EARFCN"] + X_plus1 --- GeographicalArea["GeographicalArea"] + GeographicalArea --- SeeFigure4_2["See Figure 4-2"] + + RLOSPreferredPLMNList --- X_plus2["+"] + X_plus2 --- PLMN["PLMN"] + X_plus2 --- PLMNPriority["PLMNPriority"] + + RLOSAllowedMCCList --- X_plus3["+"] + X_plus3 --- MCC["MCC"] + + MfgAssignUERadioCapId --- VendorID["VendorID"] + MfgAssignUERadioCapId --- X_plus4["+"] + X_plus4 --- RQ["RQ"] + X_plus4 --- UERadioConfigLTE["UERadioConfigLTE?"] + X_plus4 --- UERadioConfigNR["UERadioConfigNR?"] + + SNPN_Configuration --- SeeFigure4_3["See Figure 4-3"] +``` + +ASN.1 structure diagram for NAS\_SignallingPriority. It shows a sequence of fields including AttachWithIMSI, MinimumPeriodicSearchTimer, NMO\_I\_Behaviour, Timer\_T3245\_Behaviour, ExtendedAccessBarring, Override\_NAS\_SignallingLowPriority, Override\_ExtendedAccessBarring, FastFirstHigherPriorityPLMNSearch, EUTRADisablingAllowedForEMMCause15, SM\_RetryWaitTime, SM\_RetryAtRATChange, ExceptionDataReportingAllowed, and Default\_DCN\_ID. It also includes 3GPP\_PS\_data\_off (with Exempted\_service\_list and Exempted\_service\_list\_roaming), EARFCNList (with EARFCN and GeographicalArea), RLOSPreferredPLMNList (with PLMN and PLMNPriority), RLOSAllowedMCCList (with MCC), MfgAssignUERadioCapId (with VendorID, RQ, UERadioConfigLTE, and UERadioConfigNR), SNPN\_Configuration, and Ext?. + +**Figure 4-1: The NAS configuration Management Object (1 of 3)**![Figure 4-1: The NAS configuration Management Object (1 of 3)](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg) + +``` + +graph LR + GA[Geographical Area] --> P[Polygon?] + P --> X1[+] + X1 --> C[Coordinates] + C --> X2[+] + X2 --> L[Latitude] + X2 --> Lon[Longitude] + +``` + +Figure 4-1: The NAS configuration Management Object (1 of 3) + +**Figure 4-2: The NAS configuration Management Object (2 of 3)**![Figure 4-2: The NAS configuration Management Object (2 of 3)](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` + +graph LR + SC[SNPN_Configuration?] --> X3[+] + X3 --> SI[SNPN_identifier] + X3 --> 3PD[3GPP_PS_data_off?] + 3PD --> ES[Exempted_service_list] + ES --> DM[Device_management_over_PS] + ES --> BIP[Bearer_independent_protocol?] + X3 --> SM[SM_RetryWaitTime?] + X3 --> TT[Timer_T3245_Behaviour?] + +``` + +Figure 4-2: The NAS configuration Management Object (2 of 3) + +**Figure 4-3: The NAS configuration Management Object (3 of 3)** + +# 5 NAS configuration MO parameters + +## 5.1 General + +This clause describes the parameters for the NAS configuration MO. + +## 5.2 Node: + +This interior node acts as a placeholder for zero or one accounts for a fixed node. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +## 5.3 /NAS\_SignallingPriority + +The NAS\_SignallingPriority leaf indicates a NAS signalling priority which is used to determine the setting of the low priority indicator to be included in NAS messages as specified in 3GPP TS 24.008 [4] and 3GPP TS 24.301 [5]. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: + +Possible values for the NAS signalling priority are specified in table 5.3.1. + +**Table 5.3.1: Values of NAS\_SignallingPriority leaf** + +| Value | Description | +|-------|-----------------------------| +| 0 | Reserved | +| 1 | NAS signalling low priority | +| 2-255 | Reserved | + +## 5.4 /AttachWithIMSI + +The AttachWithIMSI leaf indicates whether attach with IMSI is performed when moving to a non-equivalent PLMN as specified in 3GPP TS 24.008 [4] and 3GPP TS 24.301 [5]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that normal behaviour is applied. + - 1 Indicates that attach with IMSI is performed when moving to a non-equivalent PLMN. + +The default value 0 applies if this leaf is not provisioned. + +## 5.5 /MinimumPeriodicSearchTimer + +The MinimumPeriodicSearchTimer leaf gives a minimum value in minutes for the timer T controlling the periodic search for higher prioritized PLMNs as specified in 3GPP TS 23.122 [3]. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: 0-255 + +The default value 0 applies if this leaf is not provisioned. + +## 5.6 /NMO\_I\_Behaviour + +The NMO\_I\_Behaviour leaf indicates whether the "NMO I, Network Mode of Operation I" indication as specified in 3GPP TS 24.008 [4] is applied by the UE. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the "NMO I, Network Mode of Operation I" indication is not used. + - 1 Indicates that the "NMO I, Network Mode of Operation I" indication is used, if available. + +The default value 0 applies if this leaf is not provisioned. + +## 5.7 /Timer\_T3245\_Behaviour + +The Timer\_T3245\_Behaviour leaf indicates whether the timer T3245 and the related functionality as specified in 3GPP TS 24.008 [4], 3GPP TS 24.301 [5] , and 3GPP TS 24.501 [11] is used by the UE. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + +- 0 Indicates that the timer T3245 is not used. +- 1 Indicates that the timer T3245 is used. + +The default value 0 applies if this leaf is not provisioned. + +## 5.8 /ExtendedAccessBarring + +The ExtendedAccessBarring leaf indicates whether the extended access barring is applicable for the UE as specified in 3GPP TS 24.008 [4] and 3GPP TS 24.301 [5]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the extended access barring is not applied for the UE. + - 1 Indicates that the extended access barring is applied for the UE. + +The default value 0 applies if this leaf is not provisioned. + +## 5.9 /Override\_NAS\_SignallingLowPriority + +The Override\_NAS\_SignallingLowPriority leaf indicates whether the UE can override the NAS\_SignallingPriority leaf node configured to NAS signalling low priority. + +The setting of the low priority indicator included in NAS messages when the Override\_NAS\_SignallingPriority leaf exists is specified in 3GPP TS 24.008 [4] and 3GPP TS 24.301 [5]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the UE cannot override the NAS signalling low priority indicator + - 1 Indicates that the UE can override the NAS signalling low priority indicator + +The default value 0 applies if this leaf is not provisioned. + +If provisioned, this leaf is set to the same value as that provisioned for the Override\_ExtendedAccessBarring leaf, e.g., if the UE is configured to override the NAS signalling low access priority indicator, then UE is also configured to override extended access class barring (see 3GPP TS 23.401 [5A]). + +## 5.10 /Override\_ExtendedAccessBarring + +The Override\_ExtendedAccessBarring leaf indicates whether the UE can override ExtendedAccessBarring leaf node configured to extended access barring. + +The handling of extended access barring for the UE when the Override\_ExtendedAccessBarring leaf exists is specified in 3GPP TS 24.008 [4] and 3GPP TS 24.301 [5]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + +- 0 Indicates that the UE cannot override extended access barring +- 1 Indicates that the UE can override extended access barring + +The default value 0 applies if this leaf is not provisioned. + +If provisioned, this leaf is set to the same value as that provisioned for the Override\_NAS\_SignallingLowPriority leaf, e.g., if the UE is configured to override the NAS signalling low access priority indicator, then UE is also configured to override extended access class barring (see 3GPP TS 23.401 [5A]). + +## 5.10a /FastFirstHigherPriorityPLMNSearch + +The FastFirstHigherPriorityPLMNSearch leaf indicates whether the UE performs the first search for a higher priority PLMN after at least 2 minutes and at most T minutes upon entering a VPLMN as specified in 3GPP TS 23.122 [3]. + +- Occurrence: ZeroOrOne + - Format: bool + - Access Types: Get, Replace + - Values: 0, 1 +- 0 Indicates that the Fast First Higher Priority PLMN Search is disabled, see 3GPP TS 23.122 [3] +- 1 Indicates that the Fast First Higher Priority PLMN Search is enabled, see 3GPP TS 23.122 [3] + +The default value 0 applies if this leaf is not provisioned. + +## 5.10b /EUTRADisablingAllowedForEMMCause15 + +The EUTRADisablingAllowedForEMMCause15 leaf indicates whether the UE is allowed to disable the E-UTRA capability when it receives the Extended EMM cause IE with value "E-UTRAN not allowed" as described in 3GPP TS 24.301 [5]. + +- Occurrence: ZeroOrOne + - Format: bool + - Access Types: Get, Replace + - Values: 0, 1 +- 0 Indicates that "E-UTRA Disabling for EMM cause #15" is disabled, see 3GPP TS 24.301 [5] +- 1 Indicates that "E-UTRA Disabling for EMM cause #15" is enabled, see 3GPP TS 24.301 [5] + +The default value 0 applies if this leaf is not provisioned. + +## 5.10c /SM\_RetryWaitTime + +The SM\_RetryWaitTime leaf indicates a configured UE retry wait time value applicable when in HPLMN or EHPLMN (see 3GPP TS 23.122 [3]) for controlling the UE session management retry behaviour when prior session management request was rejected by the network with cause value #8, #27, #32, #33 as specified in 3GPP TS 24.008 [4] and 3GPP TS 24.301 [5], or when prior session management request was rejected by the network with cause value #8, #27, #32, #33, #70 as specified in 3GPP TS 24.501 [11]. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: 0-255 + +The default value of 12 minutes applies if this leaf is not provisioned. + +SM\_RetryWaitTime shall be coded in the same format as the value part of GPRS Timer 3 IE as specified in Table 10.5.163a/3GPP TS 24.008 [4] converted into a decimal value. + +## 5.10d /SM\_RetryAtRATChange + +The SM\_RetryAtRATChange leaf indicates the UE's retry behaviour when in HPLMN or EHPLMN (see 3GPP TS 23.122 [3]) after inter-system change between S1 mode and A/Gb or Iu mode or N1 mode as specified in 3GPP TS 24.008 [4], 3GPP TS 24.301 [5] and 3GPP TS 24.501 [11]. + +- Occurrence: ZeroOrOne + - Format: bool + - Access Types: Get, Replace + - Values: 0, 1 +- 0 Indicates that the UE is allowed to retry the corresponding ESM procedure in S1 mode if an SM procedure was rejected in A/Gb or Iu mode or a 5GSM procedure was rejected in N1 mode, and to retry the corresponding SM procedure in A/Gb or Iu mode or the corresponding 5GSM procedure in N1 mode if an ESM procedure was rejected in S1 mode, see 3GPP TS 24.008 [4], 3GPP TS 24.301 [5] and 3GPP TS 24.501 [11] +- 1 Indicates that the UE is not allowed to retry an SM procedure or the corresponding ESM procedure or the corresponding 5GSM procedure in any of the modes: A/Gb, Iu, S1 and N1 mode, see 3GPP TS 24.008 [4], 3GPP TS 24.301 [5] and 3GPP TS 24.501 [11] + +The default value 0 applies if this leaf is not provisioned. + +## 5.10e /Default\_DCN\_ID + +The Default\_DCN\_ID leaf indicates the default DCN-ID. + +- Occurrence: ZeroOrOne +- Format: int +- Access Types: Get, Replace +- Values: 0-65535 + +Default\_DCN\_ID shall be coded as DCN-ID as specified in 3GPP TS 23.003 [5], converted into a decimal value. + +## 5.10f //3GPP\_PS\_data\_off + +The interior node contains configuration parameters for 3GPP PS data off. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10g //3GPP\_PS\_data\_off/Exempted\_service\_list + +The interior node contains one or more services which are exempted of 3GPP PS data off when the UE is in its HPLMN or EHPLMN. If the Exempted\_service\_list\_roaming node is not present, this list is also used when the UE is in the VPLMN. + +- Occurrence: One +- Format: node +- Access Types: Get, Replace + +- Values: N/A + +## 5.10h Void + +## 5.10i + +### //3GPP\_PS\_data\_off/Exempted\_service\_list/Device\_management\_over\_PS + +The Device\_management\_over\_PS leaf indicates whether Device management over PS is a 3GPP PS data off exempt service when the UE is in its HPLMN or EHPLMN. + +- Occurrence: One +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 - Indicates that the device management over PS is not a 3GPP PS data off exempt service when the UE is in its HPLMN or EHPLMN. + - 1 - Indicates that the device management over PS is a 3GPP PS data off exempt service when the UE is in its HPLMN or EHPLMN. + +## 5.10j + +### //3GPP\_PS\_data\_off/Exempted\_service\_list/Bearer\_independent\_protocol + +The Bearer\_independent\_protocol leaf indicates whether Bearer independent protocol is a 3GPP PS data off exempt service when the UE is in its HPLMN or EHPLMN. + +- Occurrence: One +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 - Indicates that the bearer independent protocol is not a 3GPP PS data off exempt service when the UE is in its HPLMN or EHPLMN (see 3GPP TS 31.111 [7]). + - 1 - Indicates that the bearer independent protocol is a 3GPP PS data off exempt service when the UE is in its HPLMN or EHPLMN (see 3GPP TS 31.111 [7]). + +## 5.10k /ExceptionDataReportingAllowed + +For the UE in NB-S1 mode, the ExceptionDataReportingAllowed leaf indicates whether the UE is allowed to use the RRC establishment cause mo-ExceptionData, as specified in 3GPP TS 24.301 [5]. + +For the UE in NB-N1 mode, the ExceptionDataReportingAllowed leaf indicates whether the UE is allowed to use the RRC establishment cause mo-ExceptionData, as specified in 3GPP TS 24.501 [11]. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + +- 0 Indicates that the UE is not allowed to use the RRC establishment cause mo-ExceptionData. +- 1 Indicates that the UE is allowed to use the RRC establishment cause mo-ExceptionData. + +If this leaf is not provisioned, the value of 0 is used. + +## 5.10l //3GPP\_PS\_data\_off/Exempted\_service\_list\_roaming + +The interior node contains one or more services which are exempted of 3GPP PS data off when the UE is in the VPLMN. If this node is not present, the Exempted\_service\_list is used when the UE is in the VPLMN. + +- Occurrence: One +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10m + +### //3GPP\_PS\_data\_off/Exempted\_service\_list\_roaming/Device\_management\_over\_PS + +The Device\_management\_over\_PS leaf indicates whether Device management over PS is a 3GPP PS data off exempt service when the UE is in the VPLMN. + +- Occurrence: One + - Format: bool + - Access Types: Get, Replace + - Values: 0, 1 +- 0 - Indicates that the device management over PS is not a 3GPP PS data off exempt service when the UE is in the VPLMN. +- 1 - Indicates that the device management over PS is a 3GPP PS data off exempt service when the UE is in the VPLMN. + +## 5.10n + +### //3GPP\_PS\_data\_off/Exempted\_service\_list\_roaming/Bearer\_independent\_protocol + +The Bearer\_independent\_protocol leaf indicates whether Bearer independent protocol is a 3GPP PS data off exempt service when the UE is in the VPLMN. + +- Occurrence: One + - Format: bool + - Access Types: Get, Replace + - Values: 0, 1 +- 0 - Indicates that the bearer independent protocol is not a 3GPP PS data off exempt service when the UE is in the VPLMN (see 3GPP TS 31.111 [7]). +- 1 - Indicates that the bearer independent protocol is a 3GPP PS data off exempt service when the UE is in the VPLMN (see 3GPP TS 31.111 [7]). + +## 5.10o //EARFCNList + +This interior node contains a list of EARFCNs configured to the UE for initial cell search of MTC carrier or NB-IoT carrier as specified in 3GPP TS 36.304 [10]. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10p //EARFCNList/ + +This interior node acts as a placeholder for one or more EARFCNs and associated geographical area configured to the UE for initial cell search of MTC carrier or NB-IoT carrier as specified in 3GPP TS 36.304 [10]. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10q //EARFCNList//EARFCN + +The EARFCN leaf contains an EARFCN configured to the UE for initial cell search of MTC carrier or NB-IoT carrier as specified in 3GPP TS 36.304 [10]. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the EARFCN is defined by 3GPP TS 36.101 [8]. + +## 5.10r //EARFCNList//GeographicalArea + +The GeographicalArea node acts as a placeholder for the geographical area associated with an EARFCN configured to the UE. The EARFCN is used by the UE for initial cell search of MTC carrier or NB-IoT carrier as specified in 3GPP TS 36.304 [10] when the UE is within the associated geographical area. + +- Occurrence: One +- Format: Node +- Access Types: Get, Replace +- Values: N/A + +## 5.10s //EARFCNList//GeographicalArea/Polygon + +The Polygon node acts as a placeholder for polygon geographical area descriptions. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace + +- Values: N/A + +## 5.10t //EARFCNList//GeographicalArea/Polygon/ + +This interior node acts as a placeholder for one or more polygon geographical area descriptions. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +## 5.10u //EARFCNList//GeographicalArea/Polygon//Coordinates + +The Coordinates node acts as a placeholder for geographical coordinates outlining the borders of a polygon geographical area. + +- Occurrence: One +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10v //EARFCNList//GeographicalArea/Polygon//Coordinates/ + +This interior node acts as a placeholder for one or more geographical coordinates. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: + +NOTE: The upper limit of 15 specified in 3GPP TS 23.032 [9] for the number of points in a polygon shape does not apply to the number of coordinates in a geographical area described as a polygon for initial cell search of MTC or NB-IoT carrier. + +## 5.10w //EARFCNList//GeographicalArea/Polygon//Coordinates//Latitude + +The Latitude leaf contains the latitude of a geographical coordinate outlining the border of the polygon geographical area. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The Latitude is defined in subclause 6.1 of 3GPP TS 23.032 [9]. + +## 5.10x //EARFCNList//GeographicalArea/Polygon//Coordinates//Longitude + +The Longitude leaf contains the longitude of a geographical coordinate outlining the border of the polygon geographical area. + +- Occurrence: One +- Format: bin +- Access Types: Get, Replace +- Values: + +The Longitude is defined in subclause 6.1 of 3GPP TS 23.032 [9]. + +## 5.10y //RLOSPreferredPLMNList + +This interior node contains a list of RLOS preferred PLMNs configured to the UE for selection of a PLMN offering access to RLOS as specified in 3GPP TS 23.122 [3]. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10z //RLOSPreferredPLMNList/ + +This interior node acts as a placeholder for one or more RLOS preferred PLMNs configured to the UE for selection of a PLMN offering access to RLOS as specified in 3GPP TS 23.122 [3]. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10za //RLOSPreferredPLMNList//PLMN + +The PLMN leaf indicates the PLMN code of the RLOS preferred PLMN. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The PLMN is in the format defined by 3GPP TS 23.003 [13], with each digit of the MCC and MNC encoded as an ASCII character. + +## 5.10zb //RLOSPreferredPLMNList//PLMNPriority + +The PLMNPriority leaf represents the priority of the RLOS preferred PLMN in the RLOS preferred PLMN list and is represented as a numerical value. + +- Occurrence: One + +- Format: int +- Access Types: Get, Replace +- Values: + +The UE shall treat the PLMN with the lowest PLMNPriority value as the PLMN having the highest priority. If the UE finds multiple PLMNs with the same priority, the choice of the PLMN is UE implementation specific. + +## 5.10zc //MfgAssignUERadioCapId + +This interior node contains a list of manufacturer-assigned UE radio capability IDs configured in the UE as an alternative for signalling the radio capabilities container as specified in 3GPP TS 24.501 [11]. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +### 5.10zca//MfgAssignUERadioCapId/VendorID + +The VendorID leaf contains the Vendor ID for the manufacturer-assigned UE radio capability IDs configured in the UE. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the Vendor ID is defined by 3GPP TS 23.003 [13]. + +## 5.10zd //MfgAssignUERadioCapId/ + +This interior node acts as a placeholder for one or more Radio Configuration Identifiers (RCI) which identifies the UE radio configuration for which the manufacturer-assigned UE radio capability IDs are applicable as specified in 3GPP TS 23.003 [13]. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10ze //MfgAssignUERadioCapId//RCI + +The RCI leaf contains the Radio Configuration Identifier (RCI) which identifies the UE radio configuration as specified in 3GPP TS 23.003 [13]. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The format of the RCI is defined by 3GPP TS 23.003 [13]. + +## 5.10zf //MfgAssignUERadioCapId//UERadioConfigLTE + +The UERadioConfigLTE leaf contains the UE radio capabilities associated with the Radio Configuration Identifier (RCI), encoded as a binary string as specified in 3GPP TS 36.331 [14]. + +- Occurrence: ZeroOrOne +- Format: bin +- Access Types: Get, Replace +- Values: + +The UERadioConfigLTE is defined as the *UE-CapabilityRAT-ContainerList* in clause 6.3.6 of 3GPP TS 36.331 [14]. + +## 5.10zg //MfgAssignUERadioCapId//UERadioConfigNR + +The UERadioConfigNR leaf contains the UE radio capabilities associated with the Radio Configuration Identifier (RCI), encoded as a binary string as specified in 3GPP TS 38.331 [15]. + +- Occurrence: ZeroOrOne +- Format: bin +- Access Types: Get, Replace +- Values: + +The UERadioConfigNR is defined as the *UE-CapabilityRAT-ContainerList* in clause 6.3.3 of 3GPP TS 38.331 [15]. + +## 5.10zh //RLOSAllowedMCCList + +This interior node contains a list of RLOS allowed MCCs configured to the UE for selection of a PLMN offering access to RLOS as specified in 3GPP TS 23.122 [3]. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10zi //RLOSAllowedMCCList/ + +This interior node acts as a placeholder for one or more RLOS Allowed MCCs configured to the UE for selection of a PLMN offering access to RLOS as specified in 3GPP TS 23.122 [3]. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10zj //RLOSAllowedMCCList//MCC + +The MCC leaf indicates the MCC value of the RLOS allowed MCC. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace + +- Values: + +The MCC is in the format defined by 3GPP TS 23.003 [13], with each digit of the MCC encoded as an ASCII character. + +## 5.10zk //SNPN\_Configuration + +The leaf contains configuration parameters regarding a UE operating in SNPN access operation mode. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10zl //SNPN\_Configuration/ + +The leaf acts as a placeholder for a list of: + +- 1) SNPN identifier; +- 2) configuration parameters regarding 3GPP PS data off for a UE in the SNPN identified by the SNPN identifier; and +- 3) configured UE retry wait time value for a UE in the SNPN identified by the SNPN identifier. + +NOTE: For each of the elements in the list, 1) must be present and either 2), 3), or both needs to appear. + +- Occurrence: OneOrMore +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10zm //SNPN\_Configuration//SNPN\_identifier + +This leaf indicates the SNPN identifier for which the 3GPP\_PS\_data\_off leaf or SM\_RetryWaitTime leaf is applicable. + +- Occurrence: One +- Format: chr +- Access Types: Get, Replace +- Values: + +The PLMN and NID are in the format defined by 3GPP TS 23.003 [13], with each digit of the MCC and MNC of the PLMN and each digit of the assignment mode and NID value of the NID encoded as an ASCII character. + +## 5.10zn //SNPN\_Configuration//3GPP\_PS\_data\_off + +The interior node contains configuration parameters regarding 3GPP PS data off for a UE in the SNPN identified by the SNPN\_identifier leaf. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10zo + +### `//SNPN_Configuration//3GPP_PS_data_off/Exempted_service_list` + +This leaf contains one or more services which are exempted of 3GPP PS data off when the UE is in the SNPN identified by the SNPN\_identifier leaf. + +- Occurrence: One +- Format: node +- Access Types: Get, Replace +- Values: N/A + +## 5.10zp `//SNPN_Configuration//3GPP_PS_data_off/Exempted_service_list/Device_management_over_PS` + +This leaf indicates whether Device management over PS is a 3GPP PS data off exempt service when the UE is in the SNPN identified by the SNPN\_identifier leaf. + +- Occurrence: One +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 - Indicates that the device management over PS is not a 3GPP PS data off exempt service when the UE is in the SNPN identified by the SNPN\_identifier leaf. + - 1 - Indicates that the device management over PS is a 3GPP PS data off exempt service when the UE is in the SNPN identified by the SNPN\_identifier leaf. + +## 5.10zq `//SNPN_Configuration//3GPP_PS_data_off/Exempted_service_list/Bearer_independent_protocol` + +This leaf indicates whether Bearer independent protocol is a 3GPP PS data off exempt service when the UE is in the SNPN identified by the SNPN\_identifier leaf. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 - Indicates that the bearer independent protocol is not a 3GPP PS data off exempt service when the UE is the SNPN identified by the SNPN\_identifier leaf (see 3GPP TS 31.111 [7]). + - 1 - Indicates that the bearer independent protocol is a 3GPP PS data off exempt service when the UE is the SNPN identified by the SNPN\_identifier leaf (see 3GPP TS 31.111 [7]). + +## 5.10zr `/SNPN_Configuration//SM_RetryWaitTime` + +This leaf indicates a configured UE retry wait time value for a UE in the SNPN identified by the SNPN\_identifier leaf in order to control the UE session management retry behaviour when prior session management request was rejected by the network with cause value #8, #27, #32, #33, #70 as specified in 3GPP TS 24.501 [11]. + +- Occurrence: ZeroOrOne + +- Format: int +- Access Types: Get, Replace +- Values: 0-255 + +SM\_RetryWaitTime shall be coded in the same format as the value part of GPRS Timer 3 IE as specified in table 10.5.163a/3GPP TS 24.008 [4] converted into a decimal value. + +## 5.10zs /SNPN\_Configuration//Timer\_T3245\_Behaviour + +The Timer\_T3245\_Behaviour leaf indicates whether the timer T3245 and the related functionality as specified in 3GPP TS 24.501 [11] is used by the UE operating in SNPN access operation mode. + +- Occurrence: ZeroOrOne +- Format: bool +- Access Types: Get, Replace +- Values: 0, 1 + - 0 Indicates that the timer T3245 is not used. + - 1 Indicates that the timer T3245 is used. + +The default value 0 applies if this leaf is not provisioned. + +## 5.11 /Ext + +The Ext is an interior node for where the vendor specific information about the NAS configuration MO is being placed (vendor meaning application vendor, device vendor etc.). Usually the vendor extension is identified by vendor specific name under the ext node. The tree structure under the vendor identifier is not defined and can therefore include one or more un-standardized sub-trees. + +- Occurrence: ZeroOrOne +- Format: node +- Access Types: Get +- Values: N/A + +# Annex A (informative): NAS configuration MO DDF + +This DDF is the standardized minimal set. A vendor can define its own DDF for the complete device. This DDF can include more features than this minimal standardized version. + +``` + + + + + 1.2 + --The device manufacturer-- + --The device model-- + + + + + + + + NAS configuration + + + + + + + The NAS configuration Management Object. + + urn:oma:mo:ext-3gpp-nas-config:1.0 + + + + + + NAS_SignallingPriority + + + + + + + + + + + + NAS Signalling Priority. + + text/plain + + + + + + AttachWithIMSI + + + + + + + + + + + + Attach with IMSI. + + text/plain + + + + + +``` + +``` +MinimumPeriodicSearchTimer + + + + + + + + + + + + Minimum periodic search timer. + + text/plain + + + + + + NMO_I_Behaviour + + + + + + + + + + + + NMO I behaviour. + + text/plain + + + + + + Timer_T3245_Behaviour + + + + + + + + + + + + Timer T3245 Behaviour. + + text/plain + + + + + + ExtendedAccessBarring + + + + + + + + + + + + Extended Access Barring. + + text/plain + + + +``` + +``` + + Override_NAS_SignallingLowPriority + + + + + + + + + + + + Override NAS Signalling Low Priority. + + text/plain + + + + + + Override_ExtendedAccessBarring + + + + + + + + + + + + Override ExtendedAccessBarring. + + text/plain + + + + + + FastFirstHigherPriorityPLMNSearch + + + + + + + + + + + + FastFirstHigherPriorityPLMNSearch. + + text/plain + + + + + + EUTRADisablingAllowedForEMMCause15 + + + + + + + + + + + + EUTRADisablingAllowedForEMMCause15. + + text/plain + + + +``` + +----- + +----- + +``` + + + + + + SM_RetryWaitTime + + + + + + + + + + + + SM_RetryWaitTime + + text/plain + + + + + + SM_RetryAtRATChange + + + + + + + + + + + + SM_RetryAtRATChange + + text/plain + + + + + + ExceptionDataReportingAllowed + + + + + + + + + + + + ExceptionDataReportingAllowed. + + text/plain + + + + + + Default_DCN_ID + + + + + + + + + + + + Default_DCN_ID +``` + +``` + + text/plain + + + + + + 3GPP_PS_data_off + + + + + + + + + + + + + + + Configuration parameters for 3GPP PS data off. + + + + + + + Exempted_service_list + + + + + + + + + + + + + + + List of services which are exempted of 3GPP PS data off when the UE is +in its HPLMN or EHPLMN. + + + + + + + Device_management_over_PS + + + + + + + + + + + + + + + Device management over PS which is a 3GPP PS data off exempt +service when the UE is in its HPLMN or EHPLMN. + + text/plain + + + + + + Bearer_independent_protocol + +``` + +``` + + + + + + + + + + + + + +Bearer independent protocol which is a 3GPP PS data off exempt +service when the UE is in its HPLMN or EHPLMN. + + text/plain + + + + + + + + Exempted_service_list_roaming + + + + + + + + + + + + + + + List of services which are exempted of 3GPP PS data off when the UE is +in the VPLMN. + + + + + + + Device_management_over_PS + + + + + + + + + + + + + + + Device management over PS which is a 3GPP PS data off exempt +service when the UE is in the VPLMN. + + text/plain + + + + + + Bearer_independent_protocol + + + + + +``` + +``` + + + + + + + + + + + Bearer independent protocol which is a 3GPP PS data off exempt +service when the UE is in the VPLMN. + + text/plain + + + + + + + + EARFCNList + + + + + + + + + + + + + + + List of EARFCN for initial cell search of MTC carrier or NB-IoT +carrier. + + + + + + + + + + + + + + + + + + + + + + List of EARFCNs and associated geographical area for initial cell +search of MTC carrier or NB-IoT carrier. + + + + + + + EARFCN + + + + + + + + + + + + + +``` + +``` +EARFCN configured to the UE for initial cell search of MTC carrier +of NB-IoT carrier. + + text/plain + + + + + + GeographicalArea + + + + + + + + + + + + Geographical Area description. + + text/plain + + + + + Polygon + + + + + + + + + + + + Polygon Area description. + + + + + + + + + + + + + + + + + + + + + + + + + Coordinates + + + + + + + + + + + + Descriptions for geographical coordinates + + + + + +``` + +``` + + + text/plain + + + + + + + + + + + + + + + + + + + + + + + Latitude + + + + + + + + + + + + coordinate latitude + + text/plain + + + + + + Longitude + + + + + + + + + + + + coordinate longitude + + text/plain + + + + + + + + + + RLOSPreferredPLMNList + + + + + + + +``` + +``` + + + + + + + + + + List of RLOS preferred PLMNs. + + + + + + + + + + + + + + + + + + + + + + List of RLOS preferred PLMNs and associated priority. + + + + + + + PLMN + + + + + + + + + + + + PLMN code of the RLOS preferred PLMN. + + text/plain + + + + + + PLMNPriority + + + + + + + + + + + + Priority of the RLOS preferred PLMN. + + + + + + + + +``` + +``` + + MfgAssignUERadioCapId + + + + + + + + + + + + + + + List of manufacturer-assigned UE radio capability IDs. + + + + + + + Vendor ID + + + + + + + + + + + + Vendor ID. + + text/plain + + + + + + + + + + + + + + + + + + + + + List of manufacturer-assigned UE radio capability IDs and associated +radio configurations. + + + + + + + RCI + + + + + + + + + + + +``` + +``` +Radio Configuration Identifier. + + text/plain + + + + + + UERadioConfigLTE + + + + + + + + + + + + UE radio configuration associated with the RCI encoded as specified +in TS 36.331. + + + + + + + + UERadioConfigNR + + + + + + + + + + + + UE radio configuration associated with the RCI encoded as specified +in TS 38.331. + + + + + + + + + + RLOSAllowedMCCList + + + + + + + + + + + + + + + List of RLOS allowed MCCs. + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + List of RLOS allowed MCCs. + + + + + + + MCC + + + + + + + + + + + + MCC value of a RLOS allowed MCC. + + text/plain + + + + + + + + SNPN_Configuration + + + + + + + + + + + + + + + Configuration parameters regarding a UE operating in SNPN access operation +mode. + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + List of {SNPN identifier, configuration parameters regarding 3GPP PS +data off for a UE in the SNPN identified by the SNPN identifier, configured UE retry wait time value +for a UE in the SNPN identified by the SNPN identifier}. + + + + + + + SNPN_identifier + + + + + + + + + + + + SNPN identifier for which the 3GPP_PS_data_off leaf or +SM_RetryWaitTime leaf is applicable. + + text/plain + + + + + 3GPP_PS_data_off + + + + + + + + + + + + + + + Configuration parameters regarding 3GPP PS data off for a UE in the +SNPN identified by the SNPN identifier leaf. + + + + + + + Exempted_service_list + + + + + + + + + + + + + + + List of services which are exempted of 3GPP PS data off for a +UE in the SNPN identified by the SNPN_identifier leaf. + + + + + + + Device_management_over_PS + + +``` + +``` + + + + + + + + + + + + + + Device management over PS which is a 3GPP PS data off +exempt service for a UE in the SNPN identified by the SNPN_identifier leaf. + + text/plain + + + + + + Bearer_independent_protocol + + + + + + + + + + + + + + + Bearer_independent_protocol which is a 3GPP PS data off +exempt service for a UE in the SNPN identified by the SNPN_identifier leaf. + + text/plain + + + + + + + + + + SM_RetryWaitTime + + + + + + + + + + + + SM_RetryWaitTime for a UE in the SNPN identified by the +SNPN_identifier leaf + + text/plain + + + + + + Timer_T3245_Behaviour + + + + + + + + + + + +``` + +``` + + + + + + Timer_T3245_Behaviour for a UE in the SNPN identified by the +SNPN_identifier leaf + + text/plain + + + + + + + + + + Ext + + + + + + + + + + + A collection of all extension objects. + + + + + + + +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2010-10 | CT1#67 | | | | Includes the following contribution agreed by CT1: C1-104202 | | 0.1.0 | +| 2010-11 | CT1#68 | | | | Includes the following contribution agreed by CT1: C1-105247 | 0.1.0 | 0.2.0 | +| 2010-12 | CT#50 | CP-100719 | | | V1.0.0 created by MCC for presentation for information at CT-50 | 0.2.0 | 1.0.0 | +| 2010-12 | CT#50 | CP-100888 | | | V1.0.1 TS-number added at CT#50 | 1.0.0 | 1.0.1 | +| 2011-01 | CT1#69 | | | | Includes the following contributions agreed by CT1: C1-110073, C1-110308, C1-110484 | 1.0.1 | 1.1.0 | +| 2011-02 | CT1#70 | | | | Includes the following contributions agreed by CT1: C1-110790; C1-111456 | 1.1.0 | 1.2.0 | +| 2011-03 | CT-51 | CP-110153 | | | Version 2.0.0 created by MCC for presentation to CT-51 for approval | 1.2.0 | 2.0.0 | +| 2011-03 | CT-51 | | | | Version 10.0.0 created by MCC after approval at CT-51 | 2.0.0 | 10.0.0 | +| 2011-06 | CT-52 | CP-110462 | 0001 | 1 | Reference to NAS configuration in USIM | 10.0.0 | 10.1.0 | +| 2011-09 | CT-53 | CP-110695 | 0002 | 1 | Definition of reserved code point | 10.1.0 | 11.0.0 | +| 2012-06 | CT-56 | CP-120315 | 0004 | 2 | Override Low Priority Configuration | 11.0.0 | 11.1.0 | +| 2012-06 | CT-56 | | | | Re-ordering of subclauses of clause 5 | 11.1.0 | 11.1.1 | +| 2012-09 | CT-57 | CP-120589 | 0006 | | Correction on overriding configurations | 11.1.1 | 11.2.0 | +| 2013-12 | CT-62 | CP-130762 | 0007 | 3 | Fast higher priority PLMN search upon entering VPLMN | 11.2.0 | 12.0.0 | +| 2014-06 | CT-64 | CP-140331 | 0009 | | Addition of configuration parameter for EMM cause #15 extension | 12.0.0 | 12.1.0 | +| 2014-09 | CT-65 | CP-140643 | 0012 | 1 | "Override_NAS_SignallingLowPriority" and "Override_ExtendedAccessBarring" linkage | 12.1.0 | 12.2.0 | +| 2015-03 | CT-67 | CP-150069 | 0014 | 2 | Addition of UE retry configuration parameter to NAS MO | 12.2.0 | 12.3.0 | +| 2015-06 | CT-68 | CP-150323 | 0017 | 1 | Correcting DDF to be valid XML document | 12.3.0 | 13.0.0 | +| 2015-06 | CT-68 | CP-150329 | 0018 | | Clarification to the applicability of the UE retry wait time value or behaviour | 12.3.0 | 13.0.0 | +| 2015-09 | CT-69 | CP-150511 | 0020 | | NAS MO figure | 13.0.0 | 13.1.0 | +| 2015-12 | CT-70 | CP-150710 | 0021 | 1 | Setting of override EAB and override NSLP leaves | 13.1.0 | 13.2.0 | +| 2016-06 | CT-72 | CP-160309 | 0022 | 6 | UE configuration for exceptional data reporting | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-12 | CT#74 | CP-160738 | 0023 | 2 | B | Addition of default standardized DCN-ID | 14.0.0 | +| 2017-03 | CT#75 | CP-170130 | 0024 | 4 | B | 3GPP PS data off configuration for non-SIP services | 14.1.0 | +| 2017-03 | CT#75 | CP-170122 | 0026 | 3 | F | Resolve DCN-ID length | 14.1.0 | +| 2017-06 | CT#76 | CP-171092 | 0028 | | F | Correction on place of ExceptionDataReportingAllowed leaf | 14.2.0 | +| 2017-06 | CT#76 | CP-171085 | 0029 | | F | Removal of editor's note [WI PS_DATA_OFF-CT CR#0024] on APN(s) list and associated packet filter(s) | 14.2.0 | +| 2017-06 | CT#76 | CP-171085 | 0030 | 1 | F | Removal of editor's note [WI PS_DATA_OFF-CT CR#0024] on the need of updating the DDF | 14.2.0 | +| 2018-06 | CT#80 | CP-181056 | 0031 | 2 | F | Remove default value of exempted BIP service | 14.3.0 | +| 2018-06 | CT#80 | CP-181056 | 0035 | 1 | F | Remove the default value of Device management over PS | 14.3.0 | +| 2018-06 | CT#80 | CP-181056 | 0036 | 2 | F | Correction to Exempted_service_list sub-tree | 14.3.0 | +| 2018-06 | CT#80 | CP-181076 | 0032 | 1 | F | Enabling pre-provisioning of EARFCNs and associated geographical areas for initial cell search of MTC carrier or NB-IOT carrier | 15.0.0 | +| 2018-06 | CT#80 | CP-181074 | 0033 | 3 | B | Enabling 3GPP PS data off in roaming-NAS MO | 15.0.0 | +| 2018-09 | CT#81 | CP-182156 | 0038 | | F | Corrections for invalid DDF | 15.1.0 | +| 2019-03 | CT#83 | CP-190106 | 0040 | 1 | B | SINE_5G: Inter-RAT retry restriction in 5GS | 16.0.0 | +| 2019-06 | CT#84 | CP-191144 | 0041 | 1 | B | Configuration of RLOS preferred PLMN list | 16.1.0 | +| 2019-09 | CT#85 | CP-192070 | 0043 | 2 | F | 5GSM cause #27 and #70 for NAS MO SM_RetryWaitTime | 16.2.0 | +| 2019-09 | CT#85 | CP-192069 | 0044 | 1 | B | Provisioning of manufacturer-assigned UE radio capability ID to the UE | 16.2.0 | +| 2020-03 | CT#87e | CP-200125 | 0045 | | C | Finalizing provisioning of manufacturer-assigned UE radio capability IDs at the UE | 16.3.0 | +| 2020-03 | CT#87e | CP-200124 | 0046 | 2 | B | NAS configuration for restriction on access to RLOS | 16.3.0 | +| 2020-03 | CT#87e | CP-200107 | 0048 | 1 | C | MO exception data reporting for NB-IoT in 5G | 16.3.0 | +| 2020-06 | CT#88e | CP-201100 | 0050 | | F | Timer_T3245_Behaviour leaf applicable in 5GS | 16.4.0 | +| 2020-06 | CT#88e | CP-201135 | 0051 | 2 | B | Configuration parameters for a UE operating in SNPN access mode | 16.4.0 | +| 2020-09 | CT#89e | CP-202170 | 0052 | | F | Timer_T3245_Behaviour for SNPN | 16.5.0 | +| 2021-03 | CT#91e | CP-210114 | 0053 | 2 | F | SNPN access operation mode | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/24_series/24380/0eb348bf17d67bf96326e07011d1c1ad_img.jpg b/marked/Rel-16/24_series/24380/0eb348bf17d67bf96326e07011d1c1ad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d85120ef374f212c4721c1ae83f17758cae5ab06 --- /dev/null +++ b/marked/Rel-16/24_series/24380/0eb348bf17d67bf96326e07011d1c1ad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4326b5808ef6fd93712a9d64956f24ba1c927e02edb943df307d027260de388 +size 42567 diff --git a/marked/Rel-16/24_series/24380/1fae649671fd14cbde9dbcd190843a51_img.jpg b/marked/Rel-16/24_series/24380/1fae649671fd14cbde9dbcd190843a51_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55daf6a746a9d7f93606a3388f1727dee0b7a5c4 --- /dev/null +++ b/marked/Rel-16/24_series/24380/1fae649671fd14cbde9dbcd190843a51_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2a1dd033d92970543cdec76f7cdc27967f8570e01d7dc9ff65e2c4db1c6d49d +size 69509 diff --git a/marked/Rel-16/24_series/24380/2171964dcb66dd0072a4744be4666e4c_img.jpg b/marked/Rel-16/24_series/24380/2171964dcb66dd0072a4744be4666e4c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb0a35f100ceae9e06de060b313f8f324b9b0c19 --- /dev/null +++ b/marked/Rel-16/24_series/24380/2171964dcb66dd0072a4744be4666e4c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:112d839af9e6eaacdc5de135f33635ff1b7c5e8990b20ef42fb19bc0ee755901 +size 37920 diff --git a/marked/Rel-16/24_series/24380/26c5c426f93cf66d35d87228668dac68_img.jpg b/marked/Rel-16/24_series/24380/26c5c426f93cf66d35d87228668dac68_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1a26450dec2b35a11e21c502ff1a730e84c19be8 --- /dev/null +++ b/marked/Rel-16/24_series/24380/26c5c426f93cf66d35d87228668dac68_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:67cf2b71ca6865a311461aefa7f971fe6442440eeadf42485400546aa66f75bb +size 56843 diff --git a/marked/Rel-16/24_series/24380/278d1c1243d0a53388a65f31a65e7eb1_img.jpg b/marked/Rel-16/24_series/24380/278d1c1243d0a53388a65f31a65e7eb1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e4d58cc3a201a0a2008ba217d95487e203f2e93 --- /dev/null +++ b/marked/Rel-16/24_series/24380/278d1c1243d0a53388a65f31a65e7eb1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b38277c7d53e295cbace57eef01c9b89a0017cd1ea406b2a5da235f91d3f78ca +size 109124 diff --git a/marked/Rel-16/24_series/24380/351432d1a55458897fdc5e81ffc832fe_img.jpg b/marked/Rel-16/24_series/24380/351432d1a55458897fdc5e81ffc832fe_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e061dabdec7c3814aad5c55006f05e84685ff0a2 --- /dev/null +++ b/marked/Rel-16/24_series/24380/351432d1a55458897fdc5e81ffc832fe_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b2e74b00657cb87379cbfea9e7aa29c093979c1f7645a97b6e773cea3223a6d +size 19956 diff --git a/marked/Rel-16/24_series/24380/42dea302ac83c622dfe19d8f3c72233a_img.jpg b/marked/Rel-16/24_series/24380/42dea302ac83c622dfe19d8f3c72233a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..71f8e1b39a0b4e03cdf54d30263e2112aa73f6a6 --- /dev/null +++ b/marked/Rel-16/24_series/24380/42dea302ac83c622dfe19d8f3c72233a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e569ad60f1f5f0fb252a7fc36a346670116212c408f642715286d70368d16e28 +size 21248 diff --git a/marked/Rel-16/24_series/24380/64c76a4fd6b7918cd8a2704de0265e8d_img.jpg b/marked/Rel-16/24_series/24380/64c76a4fd6b7918cd8a2704de0265e8d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..92bb1a73f2e18d6100934a9caeecc06ce582cc4e --- /dev/null +++ b/marked/Rel-16/24_series/24380/64c76a4fd6b7918cd8a2704de0265e8d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b29e5070459a62cc86aab8f5fe74f2e0760a37801c7313d703f0824dd8343e23 +size 78225 diff --git a/marked/Rel-16/24_series/24380/738aa211ec8ef1c9162c577d0bea7eca_img.jpg b/marked/Rel-16/24_series/24380/738aa211ec8ef1c9162c577d0bea7eca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bccc1e9106e4554cadc3c3e3f7f2b7836b2903f2 --- /dev/null +++ b/marked/Rel-16/24_series/24380/738aa211ec8ef1c9162c577d0bea7eca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c31d752d23a68bc448c844085e6f5dd1734259a7a1a3159c7ec438d5e03a450 +size 65376 diff --git a/marked/Rel-16/24_series/24380/7c5564b9e8a382de9dfa5f44116cbf2b_img.jpg b/marked/Rel-16/24_series/24380/7c5564b9e8a382de9dfa5f44116cbf2b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0d859be91b8774519a5214895204623c8e55f66 --- /dev/null +++ b/marked/Rel-16/24_series/24380/7c5564b9e8a382de9dfa5f44116cbf2b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6bd43215141f89a0725f7902f80534463378cb1862ff8b52ea1efc8241e92957 +size 140387 diff --git a/marked/Rel-16/24_series/24380/8996ecf7b316181ca7ae4ff54ebeace5_img.jpg b/marked/Rel-16/24_series/24380/8996ecf7b316181ca7ae4ff54ebeace5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..997cecbfc9bb91472886a62304c6182d39bba205 --- /dev/null +++ b/marked/Rel-16/24_series/24380/8996ecf7b316181ca7ae4ff54ebeace5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:91a5dc3dd5c540accc8753bb0ce4c648d9b5c51720b125f971c74cd398b491c4 +size 23196 diff --git a/marked/Rel-16/24_series/24380/8acaddc2ebf496c7f758ab8dac1f442b_img.jpg b/marked/Rel-16/24_series/24380/8acaddc2ebf496c7f758ab8dac1f442b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..98baf16579e50fba671507cbf19454209f70f659 --- /dev/null +++ b/marked/Rel-16/24_series/24380/8acaddc2ebf496c7f758ab8dac1f442b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c62a705463b37e73a14408950f914f90c4eae80146adb53b075545b83105758d +size 20526 diff --git a/marked/Rel-16/24_series/24380/8eb10362804436579e3504de4480a5b6_img.jpg b/marked/Rel-16/24_series/24380/8eb10362804436579e3504de4480a5b6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c02960951c9735c033c3a775dcb9cd82e4e8fd2f --- /dev/null +++ b/marked/Rel-16/24_series/24380/8eb10362804436579e3504de4480a5b6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53578e9b0b61ec109bb14f579a4c8e9f33dceaae738a18bd2108a92714878799 +size 112967 diff --git a/marked/Rel-16/24_series/24380/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/24_series/24380/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3095a3fb1d2fdb2aa15498182499254e37600b7 --- /dev/null +++ b/marked/Rel-16/24_series/24380/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7186cc7611cb80810ff1e3d0688fe82dff7e5924fd3866a369f38471e7b6669c +size 32301 diff --git a/marked/Rel-16/24_series/24380/93c9262c68d25c26b8cf8cd547554d9f_img.jpg b/marked/Rel-16/24_series/24380/93c9262c68d25c26b8cf8cd547554d9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6dead922fe9de6b6d8eb511a98131e12139cf6e7 --- /dev/null +++ b/marked/Rel-16/24_series/24380/93c9262c68d25c26b8cf8cd547554d9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c28af552ec300ebd9552eb45cccc989292ae7a11b5635dc0966a4dfa5cd7988d +size 48075 diff --git a/marked/Rel-16/24_series/24380/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/24_series/24380/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b571d5125c4f36c9db3aa4bd7882b6158267b56 --- /dev/null +++ b/marked/Rel-16/24_series/24380/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b94e71ab8ac92284804952f0681f3a44323d6989abee5d93125f5f1f17eb133 +size 58741 diff --git a/marked/Rel-16/24_series/24380/9d47fe89bc71acebde670ea760ee6ffb_img.jpg b/marked/Rel-16/24_series/24380/9d47fe89bc71acebde670ea760ee6ffb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d28dab7160e9824de489fd79a3a9186992fd58f --- /dev/null +++ b/marked/Rel-16/24_series/24380/9d47fe89bc71acebde670ea760ee6ffb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ba954e6546f7d681928648204b36e6efa969f76fe8de72700cc77b942d4314d +size 45384 diff --git a/marked/Rel-16/24_series/24380/b8711ada890f740e219352d774acd75d_img.jpg b/marked/Rel-16/24_series/24380/b8711ada890f740e219352d774acd75d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..18bbf4a568a394db2f16219ec1ebfdf266558d57 --- /dev/null +++ b/marked/Rel-16/24_series/24380/b8711ada890f740e219352d774acd75d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:afe396544437becb04198e528fa02d81f001059d32ee0d30c01ceb714c12dc51 +size 43808 diff --git a/marked/Rel-16/24_series/24380/b8d1d78473c7e0df5d8059f40629021a_img.jpg b/marked/Rel-16/24_series/24380/b8d1d78473c7e0df5d8059f40629021a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b05152e3c5bfcb5ad9276e795e1e21760664c79 --- /dev/null +++ b/marked/Rel-16/24_series/24380/b8d1d78473c7e0df5d8059f40629021a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5548db4d6b87cd9695213c8fcc4ce91420e568db944248cd2c82b58b8dcc0ee1 +size 49333 diff --git a/marked/Rel-16/24_series/24380/bdedc4445bc14629d68d2fed555b83e9_img.jpg b/marked/Rel-16/24_series/24380/bdedc4445bc14629d68d2fed555b83e9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec2590ad759c0c0dbfb2ad6d3375e58f7d08c32f --- /dev/null +++ b/marked/Rel-16/24_series/24380/bdedc4445bc14629d68d2fed555b83e9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32eac890c474fdf7eff507da8c61f01cfeda3355f5b338611d7c53d7e2afcf12 +size 77643 diff --git a/marked/Rel-16/24_series/24380/bf2e682e30eceee92acd2243018fa614_img.jpg b/marked/Rel-16/24_series/24380/bf2e682e30eceee92acd2243018fa614_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7cb64e2d6c27164bc35cf9adfef93c37f9068d7e --- /dev/null +++ b/marked/Rel-16/24_series/24380/bf2e682e30eceee92acd2243018fa614_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b56d48954912c3c6bd705964867ebe9b3b8a655187123ebe3969f18d6c342dce +size 72002 diff --git a/marked/Rel-16/24_series/24380/cb801472c1446dfc10793c006674b0f6_img.jpg b/marked/Rel-16/24_series/24380/cb801472c1446dfc10793c006674b0f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..926092117d35ed89516deadce29669b068ce71d7 --- /dev/null +++ b/marked/Rel-16/24_series/24380/cb801472c1446dfc10793c006674b0f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37809e6cd645e8b5e0e648ffe0513174131e475d42c70210dacefde3793e573d +size 53042 diff --git a/marked/Rel-16/24_series/24380/cc7baa8e5118f4b42c01166637c738ea_img.jpg b/marked/Rel-16/24_series/24380/cc7baa8e5118f4b42c01166637c738ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2e5b2412f0a14655755f84160eddd6a79aa499c1 --- /dev/null +++ b/marked/Rel-16/24_series/24380/cc7baa8e5118f4b42c01166637c738ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc04822356c0ecf064559489c208095d85f52835e15b35f12fd82c7965ef6c60 +size 70166 diff --git a/marked/Rel-16/24_series/24380/daa086b264328b888e9d54b9bbad081e_img.jpg b/marked/Rel-16/24_series/24380/daa086b264328b888e9d54b9bbad081e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7db25d09b187d97c6899e8780a5a5c8fcd49d607 --- /dev/null +++ b/marked/Rel-16/24_series/24380/daa086b264328b888e9d54b9bbad081e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ccaf21dfb7bfc6e9519a7126fd66aec811d1e03104f408801e80b5679dd42e1f +size 111175 diff --git a/marked/Rel-16/24_series/24380/de1324b584dbd2fb53fcdde6e28b2182_img.jpg b/marked/Rel-16/24_series/24380/de1324b584dbd2fb53fcdde6e28b2182_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..faeee00a861a6930f4fd565ef124edd246fbdb1d --- /dev/null +++ b/marked/Rel-16/24_series/24380/de1324b584dbd2fb53fcdde6e28b2182_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b497c7047e818dc13384730259f9cf68766719441e66dd351ea84d6d155f9a2 +size 43734 diff --git a/marked/Rel-16/24_series/24380/f4e64712104f326ff259928d8126f1f6_img.jpg b/marked/Rel-16/24_series/24380/f4e64712104f326ff259928d8126f1f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d4b4478b04d4b92a706d6bfd266d0557ce5cbbb --- /dev/null +++ b/marked/Rel-16/24_series/24380/f4e64712104f326ff259928d8126f1f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa1ec119288bc57c303c8c58956b0456a2bc1ff75cbe42f8781c011e2f6782d2 +size 36374 diff --git a/marked/Rel-16/24_series/24380/f5cf5b5d69186f33dbfee9de41ccb17a_img.jpg b/marked/Rel-16/24_series/24380/f5cf5b5d69186f33dbfee9de41ccb17a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ffbcd5845c1690e9cb7628f4a964f82a99d672b4 --- /dev/null +++ b/marked/Rel-16/24_series/24380/f5cf5b5d69186f33dbfee9de41ccb17a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:adc27b2b5080806f282505f144a67703fdced0fec403a5a87465185af415182a +size 47566 diff --git a/marked/Rel-16/24_series/24380/fc0735d325f0ebd9214171975c68a888_img.jpg b/marked/Rel-16/24_series/24380/fc0735d325f0ebd9214171975c68a888_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..05ebffbf368b61a7a07abe542e684bc9b5419bbd --- /dev/null +++ b/marked/Rel-16/24_series/24380/fc0735d325f0ebd9214171975c68a888_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1ba64c7fc5abac378299ec11baa740d54136c4e54aca0f2381e037687722f52 +size 30853 diff --git a/marked/Rel-16/24_series/24380/raw.md b/marked/Rel-16/24_series/24380/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1d7c25f6aeabc921b0a3af8822a863018b52c800 --- /dev/null +++ b/marked/Rel-16/24_series/24380/raw.md @@ -0,0 +1,11331 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mission Critical Push To Talk (MCPTT) media plane control; Protocol specification (Release 16)** --- + +## Keywords + +MCPTT, IMS, Multimedia, IP, LTE + +## **3GPP** + +## Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet + + + +# Contents + +| | | +|---------------------------------------------------------------------|----| +| Foreword..... | 15 | +| 1 Scope..... | 16 | +| 2 References..... | 16 | +| 3 Definitions and abbreviations..... | 17 | +| 3.1 Definitions..... | 17 | +| 3.2 Abbreviations..... | 18 | +| 4 General..... | 19 | +| 4.1 Overview..... | 19 | +| 4.1.1 Floor Control..... | 19 | +| 4.1.1.1 General..... | 19 | +| 4.1.1.2 On-network floor control..... | 19 | +| 4.1.1.3 Off-network floor control..... | 21 | +| 4.1.1.4 Determine on-network effective priority..... | 21 | +| 4.1.1.5 Determine off-network effective priority..... | 21 | +| 4.1.2 Pre-established session call control..... | 22 | +| 4.1.2.1 General..... | 22 | +| 4.1.2.2 Call setup over pre-established session..... | 22 | +| 4.1.2.3 Release of a call which uses a pre-established session..... | 23 | +| 4.1.3 MBMS subchannel control..... | 23 | +| 4.1.3.1 General..... | 23 | +| 4.1.3.2 Start of a conversation..... | 23 | +| 4.1.3.3 During a conversation..... | 24 | +| 4.1.3.4 Ending the conversation..... | 24 | +| 4.1.3.5 Starting a call over unicast bearers..... | 24 | +| 4.1.3.6 Moving a conversation to unicast bearers..... | 24 | +| 4.1.3.7 MBMS bearer announcement over an MBMS bearer..... | 24 | +| 4.2 Internal structure of media plane control entities..... | 24 | +| 4.2.1 Controlling MCPTT function..... | 24 | +| 4.2.2 MCPTT client..... | 26 | +| 4.2.3 Participating MCPTT function..... | 28 | +| 4.2.3.1 General..... | 28 | +| 4.2.3.2 Internal structure of the participating MCPTT function..... | 28 | +| 4.2.3.3 The roles of the participating MCPTT function..... | 29 | +| 4.2.3.3.1 For the floor control procedures..... | 29 | +| 4.2.3.3.2 For the call over pre-established session procedures..... | 29 | +| 4.2.3.3.3 For the use of MBMS bearer procedures..... | 29 | +| 4.2.4 Non-controlling MCPTT function of an MCPTT group..... | 30 | +| 4.3 The media plane control channel..... | 31 | +| 4.3.1 General..... | 31 | +| 4.3.2 Control channel realization..... | 31 | +| 4.3.3 Establishing a media plane control channel..... | 32 | + +# Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|------------|---------------------------------------------------------------------------------|----| +| 4.3.3.1 | General..... | 32 | +| 5 | Entities..... | 32 | +| 5.1 | General..... | 32 | +| 5.2 | MCPTT client..... | 32 | +| 5.2.1 | Introduction..... | 32 | +| 5.2.2 | Floor participant in on-network mode..... | 33 | +| 5.2.3 | Floor participant in off-network mode..... | 33 | +| 5.3 | Controlling MCPTT function..... | 34 | +| 5.4 | Participating MCPTT function..... | 34 | +| 5.5 | Non-controlling MCPTT function..... | 34 | +| 6 | On-network floor control..... | 35 | +| 6.1 | General..... | 35 | +| 6.2 | Floor participant procedures..... | 35 | +| 6.2.1 | Floor participant procedures at MCPTT session initialization..... | 35 | +| 6.2.2 | Floor participant procedures at MCPTT call release..... | 35 | +| 6.2.3 | Floor participant procedures at MCPTT call modification..... | 35 | +| 6.2.4 | Floor participant state transition diagram for basic operation..... | 36 | +| 6.2.4.1 | General..... | 36 | +| 6.2.4.2 | State: 'Start-stop'..... | 37 | +| 6.2.4.2.1 | General..... | 37 | +| 6.2.4.2.2 | MCPTT call initiated, originating MCPTT user..... | 37 | +| 6.2.4.2.3 | MCPTT call established, terminating MCPTT user..... | 37 | +| 6.2.4.3 | State: 'U: has no permission'..... | 37 | +| 6.2.4.3.1 | General..... | 37 | +| 6.2.4.3.2 | Receive Floor Idle message (R: Floor Idle)..... | 38 | +| 6.2.4.3.3 | Receive Floor Taken message (R: Floor Taken)..... | 38 | +| 6.2.4.3.4 | Receive RTP media packets (R: RTP media)..... | 38 | +| 6.2.4.3.5 | Send Floor Request message (PTT button pressed)..... | 38 | +| 6.2.4.3.6 | Timer T103 (End of RTP media) expired..... | 39 | +| 6.2.4.3.7 | Receive Floor Release Multi Talker message (R: Floor Release Multi Talker)..... | 39 | +| 6.2.4.4 | State: 'U: pending Request'..... | 39 | +| 6.2.4.4.1 | General..... | 39 | +| 6.2.4.4.2 | Receive Floor Granted message (R: Floor Granted)..... | 39 | +| 6.2.4.4.3 | Void..... | 40 | +| 6.2.4.4.4 | Receive Floor Deny message (R: Floor Deny)..... | 40 | +| 6.2.4.4.5 | Timer T101 (Floor request) expired..... | 40 | +| 6.2.4.4.6 | Timer T101 (Floor Request) expired N times..... | 41 | +| 6.2.4.4.7 | Receive RTP media packets (R: RTP Media)..... | 41 | +| 6.2.4.4.8 | Send Floor Release message (PTT button released)..... | 41 | +| 6.2.4.4.9 | Receive Floor Queue Position Info message (R: Floor Queue Position Info)..... | 41 | +| 6.2.4.4.10 | Receive Floor Release Multi Talker message (R: Floor Release Multi talker)..... | 42 | +| 6.2.4.4.11 | Receive Floor Taken message (R: Floor Taken)..... | 42 | +| 6.2.4.5 | State: 'U: has permission'..... | 42 | +| 6.2.4.5.1 | General..... | 42 | +| 6.2.4.5.2 | Send RTP media packets (RTP media)..... | 43 | +| 6.2.4.5.3 | Send Floor Release message (PTT button released)..... | 43 | +| 6.2.4.5.4 | Receive Floor Revoke message (R: Floor Revoke)..... | 43 | +| 6.2.4.5.5 | Receive Floor Granted message (R: Floor Granted)..... | 44 | +| 6.2.4.5.6 | Receive RTP media packets (R: RTP Media)..... | 44 | +| 6.2.4.5.7 | Receive Floor Idle message (R: Floor Idle)..... | 44 | +| 6.2.4.5.8 | Receive Floor Taken message (R: Floor Taken)..... | 45 | +| 6.2.4.5.9 | Receive Floor Release Multi Talker message (R: Floor Release Multi talker)..... | 45 | +| 6.2.4.6 | State: 'U: pending Release'..... | 45 | +| 6.2.4.6.1 | General..... | 45 | +| 6.2.4.6.2 | Timer T100 (Floor Release) expired..... | 45 | +| 6.2.4.6.3 | Timer T100 (Floor release) expired N times..... | 46 | +| 6.2.4.6.4 | Receive Floor Idle message (R: Floor Idle)..... | 46 | +| 6.2.4.6.5 | Receive Floor Taken message (R: Floor Taken)..... | 46 | +| 6.2.4.6.6 | Receive RTP media packets (R: RTP Media)..... | 47 | + +| | | | +|------------|------------------------------------------------------------------------------------------------|----| +| 6.2.4.6.7 | Receive Floor Revoke message (R: Floor Revoke)..... | 47 | +| 6.2.4.6.8 | Receive Floor Granted message (R: Floor Granted)..... | 47 | +| 6.2.4.6.9 | Receive Floor Release Multi Talker message (R: Floor Release Multi talker)..... | 47 | +| 6.2.4.7 | In any state..... | 47 | +| 6.2.4.7.1 | General..... | 47 | +| 6.2.4.7.2 | Receive MCPTT call release – step 1 (R: MCPTT call release - 1)..... | 48 | +| 6.2.4.7.3 | Receive a Floor Control message with a Floor Indicator field (R: Floor Indicator)..... | 48 | +| 6.2.4.8 | State: 'Releasing'..... | 48 | +| 6.2.4.8.1 | General..... | 48 | +| 6.2.4.8.2 | Receive MCPTT call release – step 2 (R: MCPTT call release - 2)..... | 48 | +| 6.2.4.9 | State: 'U: queued'..... | 48 | +| 6.2.4.9.1 | General..... | 48 | +| 6.2.4.9.2 | Receive RTP media packets (R: RTP media)..... | 48 | +| 6.2.4.9.3 | Receive Floor Taken message (R: Floor Taken)..... | 49 | +| 6.2.4.9.4 | Receive Floor Granted message (R: Floor Granted)..... | 49 | +| 6.2.4.9.5 | Receive Floor Deny message (R: Floor Deny)..... | 49 | +| 6.2.4.9.6 | Send Floor Release message (PTT button released)..... | 50 | +| 6.2.4.9.7 | Receive Floor Queue Position Info message (R: Floor Queue Position Info)..... | 50 | +| 6.2.4.9.8 | Receive Floor Idle message (R: Floor Idle)..... | 50 | +| 6.2.4.9.9 | Send Floor Queue Position Request message (S: Floor Queue Position Request)..... | 51 | +| 6.2.4.9.10 | Timer T104 (Floor Queue Position Request) expired..... | 51 | +| 6.2.4.9.11 | Timer T104 (Floor Queue Position Request) expired N times..... | 51 | +| 6.2.4.9.12 | User indication for accept of pending request..... | 51 | +| 6.2.4.9.13 | Timer T132 (Queued granted user action) expires..... | 51 | +| 6.2.4.9.14 | Receive Floor Release Multi Talker message (R: Floor Release Multi talker)..... | 52 | +| 6.3 | Floor control server procedures..... | 52 | +| 6.3.1 | General..... | 52 | +| 6.3.2 | Controlling MCPTT function procedures at MCPTT call initialization..... | 52 | +| 6.3.2.1 | General..... | 52 | +| 6.3.2.2 | Initial procedures..... | 52 | +| 6.3.2.3 | Switching from a non-controlling MCPTT function mode to a controlling MCPTT function mode..... | 53 | +| 6.3.3 | MCPTT floor control procedures at MCPTT call release..... | 53 | +| 6.3.4 | Floor control server state transition diagram for general floor control operation..... | 54 | +| 6.3.4.1 | General..... | 54 | +| 6.3.4.2 | State: 'Start-stop'..... | 56 | +| 6.3.4.2.1 | General..... | 56 | +| 6.3.4.2.2 | MCPTT call initialization..... | 56 | +| 6.3.4.3 | State: 'G: Floor Idle'..... | 56 | +| 6.3.4.3.1 | General..... | 56 | +| 6.3.4.3.2 | Enter the 'G: Floor Idle' state..... | 57 | +| 6.3.4.3.3 | Receive Floor Request message (R: Floor Request)..... | 58 | +| 6.3.4.3.4 | Timer T7 (Floor Idle) expired..... | 58 | +| 6.3.4.3.5 | Timer T4 (Inactivity) expired..... | 59 | +| 6.3.4.3.6 | Receive an implicit floor request (R: Implicit floor request)..... | 59 | +| 6.3.4.4 | State: 'G: Floor Taken'..... | 59 | +| 6.3.4.4.1 | General..... | 59 | +| 6.3.4.4.2 | Enter the 'G: Floor Taken' state..... | 60 | +| 6.3.4.4.3 | Timer T1 (End of RTP media) expired..... | 61 | +| 6.3.4.4.4 | Timer T2 (Stop talking) expired..... | 61 | +| 6.3.4.4.5 | Receive RTP media packets (R: RTP media)..... | 61 | +| 6.3.4.4.6 | Receive Floor Release message (R: Floor Release)..... | 62 | +| 6.3.4.4.7 | Receive Floor Request message with pre-emptive priority (R: pre-emptive Floor Request)..... | 62 | +| 6.3.4.4.7a | Receive Floor Request message multi-talker (R: multi-talker Floor Request)..... | 63 | +| 6.3.4.4.8 | Receive Floor request message from permitted floor participant (R: Floor Request)..... | 64 | +| 6.3.4.4.9 | Timer T20 (Floor Granted) expired..... | 64 | +| 6.3.4.4.10 | Timer T20 (Floor Granted) expired N times..... | 65 | +| 6.3.4.4.11 | Permitted MCPTT client release (R: client release)..... | 65 | +| 6.3.4.4.12 | Receive an implicit floor request (R: Implicit floor request)..... | 65 | +| 6.3.4.5 | State: 'G: pending Floor Revoke'..... | 66 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------------------------|----| +| 6.3.4.5.1 | General..... | 66 | +| 6.3.4.5.2 | Enter the 'G: pending Floor Revoke' state..... | 66 | +| 6.3.4.5.3 | Receive RTP media packets (R: RTP media)..... | 66 | +| 6.3.4.5.4 | Receive Floor Release message (R: Floor Release)..... | 66 | +| 6.3.4.5.5 | Timer T3 (Stop talking grace) expired..... | 67 | +| 6.3.4.5.6 | Timer T1 (End of RTP media) expired..... | 67 | +| 6.3.4.6 | In any state..... | 68 | +| 6.3.4.6.1 | General..... | 68 | +| 6.3.4.6.2 | Receive MCPTT call release - 1..... | 68 | +| 6.3.4.6.3 | Receive an instruction to merge group calls (R: Merge)..... | 68 | +| 6.3.4.7 | State: 'Releasing'..... | 69 | +| 6.3.4.7.1 | General..... | 69 | +| 6.3.4.7.2 | Receive MCPTT call release - 2..... | 69 | +| 6.3.4.8 | State: 'G: Floor Initialising'..... | 69 | +| 6.3.4.8.1 | General..... | 69 | +| 6.3.4.8.2 | Enter the 'G: Initialising' state..... | 69 | +| 6.3.4.8.3 | Receiving a floor request from a constituent MCPTT group (R: mcptt-floor-request)..... | 69 | +| 6.3.4.8.4 | All final SIP responses received (R: final SIP responses)..... | 69 | +| 6.3.5 | Floor control server state transition diagram for basic floor control operation towards the floor participant..... | 70 | +| 6.3.5.1 | General..... | 70 | +| 6.3.5.2 | State: 'Start-stop'..... | 73 | +| 6.3.5.2.1 | General..... | 73 | +| 6.3.5.2.2 | SIP Session initiated..... | 73 | +| 6.3.5.3 | State: 'U: not permitted and Floor Idle'..... | 77 | +| 6.3.5.3.1 | General..... | 77 | +| 6.3.5.3.2 | Enter state 'U: not permitted and Floor Idle'..... | 77 | +| 6.3.5.3.3 | Send Floor Taken message (S: Floor Taken)..... | 77 | +| 6.3.5.3.4 | Receive Floor Request message (R: Floor Request)..... | 77 | +| 6.3.5.3.5 | Send Floor Grant message (S: Floor Grant)..... | 78 | +| 6.3.5.3.6 | Send Floor Deny message (S: Floor Deny)..... | 78 | +| 6.3.5.3.7 | Receive Floor Release message (R: Floor Release)..... | 78 | +| 6.3.5.3.8 | Receive RTP media packets (R: media)..... | 79 | +| 6.3.5.3.9 | Receive an implicit floor request (R: Implicit floor request)..... | 79 | +| 6.3.5.3.10 | Send Floor Idle message (S: Floor Idle)..... | 79 | +| 6.3.5.4 | State 'U: not permitted and Floor Taken'..... | 80 | +| 6.3.5.4.1 | General..... | 80 | +| 6.3.5.4.2 | Enter state 'U: not permitted and Floor Taken'..... | 80 | +| 6.3.5.4.3 | Send Floor Idle message (S: Floor Idle)..... | 80 | +| 6.3.5.4.4 | Receive Floor Request message (R: Floor Request)..... | 80 | +| 6.3.5.4.5 | Receive Floor Release message (R: Floor Release)..... | 84 | +| 6.3.5.4.6 | Receive RTP media packets (R: media)..... | 85 | +| 6.3.5.4.7 | Send Floor Queue Position Info message (R: Floor Queue Position Request)..... | 85 | +| 6.3.5.4.8 | Receive an implicit floor request (R: Implicit floor request)..... | 86 | +| 6.3.5.4.9 | Send Floor Granted message (S: Floor Granted)..... | 86 | +| 6.3.5.4.10 | Send Floor Taken message (S: Floor Taken)..... | 86 | +| 6.3.5.4.11 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker)..... | 87 | +| 6.3.5.5 | State: 'U: permitted'..... | 87 | +| 6.3.5.5.1 | General..... | 87 | +| 6.3.5.5.2 | Enter state 'U: permitted'..... | 87 | +| 6.3.5.5.3 | Receive Floor Release message (R: Floor Release)..... | 87 | +| 6.3.5.5.4 | Send Floor Idle message (S: Floor Idle)..... | 88 | +| 6.3.5.5.5 | Send Floor Revoke message (S: Floor Revoke)..... | 88 | +| 6.3.5.5.6 | Receive RTP media packets (R: media)..... | 88 | +| 6.3.5.5.7 | Receive Floor Request message (R: Floor Request)..... | 88 | +| 6.3.5.5.8 | Send RTP Media (S: media)..... | 89 | +| 6.3.5.5.9 | Send Floor Taken message (S: Floor Taken)..... | 89 | +| 6.3.5.5.10 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker)..... | 89 | +| 6.3.5.6 | State: 'U: pending Floor Revoke'..... | 89 | +| 6.3.5.6.1 | General..... | 89 | + +| | | | +|------------|------------------------------------------------------------------------------------------------------|-----| +| 6.3.5.6.2 | Enter state 'U pending Floor Revoke'..... | 90 | +| 6.3.5.6.3 | Timer T8 (media Revoke) expired..... | 90 | +| 6.3.5.6.4 | Receive RTP media packets (R: media)..... | 90 | +| 6.3.5.6.5 | Receive Floor Release message (R: Floor Release)..... | 90 | +| 6.3.5.6.6 | Send Floor Idle message (S: Floor Idle)..... | 91 | +| 6.3.5.6.7 | Send Floor Taken message (S: Floor Taken)..... | 91 | +| 6.3.5.6.8 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker)..... | 91 | +| 6.3.5.7 | State 'U: not permitted but sends media'..... | 91 | +| 6.3.5.7.1 | General..... | 91 | +| 6.3.5.7.2 | Enter state 'U: not permitted but sends media'..... | 92 | +| 6.3.5.7.3 | Timer T8 (Floor Revoke) expired..... | 92 | +| 6.3.5.7.4 | Receive Floor Release message (R: Floor Release)..... | 92 | +| 6.3.5.7.5 | Send Floor Taken message (S: Floor Taken)..... | 93 | +| 6.3.5.7.6 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker)..... | 93 | +| 6.3.5.8 | In any state..... | 93 | +| 6.3.5.8.1 | General..... | 93 | +| 6.3.5.8.2 | Receive MCPTT call release – 1..... | 93 | +| 6.3.5.8.3 | Receiving a merging instruction (R: Merge)..... | 94 | +| 6.3.5.9 | State: 'Releasing'..... | 94 | +| 6.3.5.9.1 | General..... | 94 | +| 6.3.5.9.2 | Receive MCPTT call release - 2..... | 94 | +| 6.3.5.10 | State: 'U: not permitted and initiating'..... | 94 | +| 6.3.5.10.1 | General..... | 94 | +| 6.3.5.10.2 | Enter the 'U: not permitted and initiating' state..... | 95 | +| 6.3.5.10.3 | Send Floor Taken message (S: Floor Taken)..... | 95 | +| 6.3.5.10.4 | Send Floor Idle message (S: Floor Idle)..... | 95 | +| 6.3.5.10.5 | Receive Floor Request message (R: Floor Request)..... | 95 | +| 6.3.5.10.6 | Send Floor Granted message (S: Floor Granted)..... | 96 | +| 6.3.5.10.7 | Receive a Floor Release message (S: Floor Release)..... | 96 | +| 6.3.5.10.8 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker)..... | 96 | +| 6.3.6 | Dual floor control..... | 97 | +| 6.3.6.1 | General..... | 97 | +| 6.3.6.2 | State: 'Start-stop'..... | 98 | +| 6.3.6.2.1 | General..... | 98 | +| 6.3.6.2.2 | Receive Floor Request message with overriding pre-emptive floor priority (R: Floor Request)..... | 98 | +| 6.3.6.3 | State: 'D: Floor Taken'..... | 98 | +| 6.3.6.3.1 | General..... | 98 | +| 6.3.6.3.2 | Enter state 'D: Floor Taken'..... | 98 | +| 6.3.6.3.3 | Timer T11 (End of RTP dual) expired..... | 99 | +| 6.3.6.3.4 | Timer T12 (Stop talking dual) expired..... | 100 | +| 6.3.6.3.5 | Receive RTP media packets (R: media)..... | 101 | +| 6.3.6.3.6 | Receive Floor Release message (R: Floor Release)..... | 101 | +| 6.3.6.3.7 | Receive Floor request message from permitted floor participant (R: Floor Request)..... | 102 | +| 6.3.6.3.8 | Permitted MCPTT client release..... | 102 | +| 6.3.6.3.9 | Receive Terminate (Terminate)..... | 103 | +| 6.3.6.4 | In any state..... | 103 | +| 6.3.6.4.1 | General..... | 103 | +| 6.3.6.4.2 | Receive MCPTT call release - 1..... | 103 | +| 6.3.6.5 | State: 'Releasing'..... | 103 | +| 6.3.6.5.1 | General..... | 103 | +| 6.3.6.5.2 | Receive MCPTT call release - 2..... | 103 | +| 6.4 | Participating MCPTT function floor control procedures..... | 104 | +| 6.4.1 | General..... | 104 | +| 6.4.2 | Receive floor control messages..... | 104 | +| 6.4.3 | Receive RTP media packets (R: RTP Media)..... | 105 | +| 6.4.4 | Release of session..... | 105 | +| 6.5 | Non-controlling MCPTT function of an MCPTT group..... | 105 | +| 6.5.1 | General..... | 105 | +| 6.5.2 | The MCPTT call initialization procedure in the non-controlling MCPTT function of an MCPTT group..... | 105 | + +| | | | +|------------|------------------------------------------------------------------------------------------------|-----| +| 6.5.2.1 | General..... | 105 | +| 6.5.2.2 | Initial procedures when a new SIP session is establishing a group session..... | 106 | +| 6.5.2.3 | Switching from a controlling MCPTT function mode to a non-controlling MCPTT function mode..... | 106 | +| 6.5.2.3.1 | Overview..... | 106 | +| 6.5.2.3.2 | Preparing for the switch to non-controlling MCPTT function (Step 1)..... | 106 | +| 6.5.2.3.3 | Start acting as a non-controlling MCPTT function (Step 2)..... | 107 | +| 6.5.3 | The MCPTT call release procedure in the non-controlling MCPTT function of an MCPTT group..... | 107 | +| 6.5.4 | Floor control server interface procedures..... | 108 | +| 6.5.4.1 | General..... | 108 | +| 6.5.4.2 | Receiving a Floor Request message..... | 108 | +| 6.5.4.3 | Receive Floor Release message..... | 108 | +| 6.5.4.4 | Receive Floor Queue Position Request message..... | 109 | +| 6.5.4.5 | Receive Floor Ack message..... | 109 | +| 6.5.4.6 | Receive Floor Granted message..... | 109 | +| 6.5.4.7 | Receive Floor Deny message..... | 110 | +| 6.5.4.8 | Receive Floor Idle message..... | 111 | +| 6.5.4.9 | Receive Floor Taken message..... | 112 | +| 6.5.4.10 | Receive Floor Revoke message..... | 113 | +| 6.5.4.11 | Receive Floor Queue Position Info message..... | 113 | +| 6.5.4.12 | Receive RTP media packets from controlling MCPTT function..... | 114 | +| 6.5.4.13 | Receive RTP media packets from an MCPTT client..... | 114 | +| 6.5.4.14 | MCPTT session release step 1..... | 114 | +| 6.5.4.15 | MCPTT session release step 2..... | 114 | +| 6.5.4.16 | Receiving a split instruction (R: Split)..... | 115 | +| 6.5.4.17 | Receive Floor Release Multi Talker message..... | 115 | +| 6.5.5 | Floor participant interface procedures..... | 115 | +| 6.5.5.1 | General..... | 115 | +| 6.5.5.2 | State: 'Start-Stop'..... | 116 | +| 6.5.5.2.1 | General..... | 116 | +| 6.5.5.2.2 | Participant invited to session..... | 116 | +| 6.5.5.3 | State: 'P: has no permission'..... | 116 | +| 6.5.5.3.1 | General..... | 116 | +| 6.5.5.3.2 | Receive Floor Idle message (R: Floor Idle)..... | 116 | +| 6.5.5.3.3 | Receive Floor Taken message (R: Floor Taken)..... | 116 | +| 6.5.5.3.4 | Receive Floor Request message (R: Floor Request)..... | 117 | +| 6.5.5.3.5 | Receive Floor Granted message (R: Floor Granted)..... | 117 | +| 6.5.5.3.6 | Receive Floor Deny message (R: Floor Deny)..... | 117 | +| 6.5.5.3.7 | Receive Floor Queue Position Info message (R: Floor Queue Position Info)..... | 117 | +| 6.5.5.3.8 | Receive Floor Queue Position Request message (R: Floor Queue Position Request)..... | 117 | +| 6.5.5.3.9 | Receive RTP media packets (R: RTP media)..... | 118 | +| 6.5.5.3.10 | Receive Floor Release message (R: Floor Release)..... | 118 | +| 6.5.5.3.11 | Receive split instruction (R: Split)..... | 118 | +| 6.5.5.3.12 | Receive Floor Release Multi Talker message..... | 119 | +| 6.5.5.4 | State: 'P: has permission'..... | 119 | +| 6.5.5.4.1 | General..... | 119 | +| 6.5.5.4.2 | Receive RTP media packets..... | 119 | +| 6.5.5.4.3 | Receive Floor Release message..... | 119 | +| 6.5.5.4.4 | Receive Floor Ack message..... | 119 | +| 6.5.5.4.5 | Receive Floor Idle message..... | 119 | +| 6.5.5.4.6 | Receive Floor Taken message..... | 120 | +| 6.5.5.4.7 | Receive Floor Revoke message..... | 120 | +| 6.5.5.4.8 | Receive split instruction (R: Split)..... | 120 | +| 6.5.5.4.9 | Receive Floor Release Multi Talker message..... | 120 | +| 6.5.5.5 | In any state..... | 120 | +| 6.5.5.5.1 | General..... | 120 | +| 6.5.5.5.2 | Receive Floor Ack message (R: Floor Ack)..... | 120 | +| 6.5.5.5.3 | MCPTT session release step 1 (MCPTT call release - 1)..... | 121 | +| 6.5.5.6 | State: 'P: Releasing'..... | 121 | +| 6.5.5.6.1 | General..... | 121 | + +| | | | +|------------|----------------------------------------------------------------------------------------------------|-----| +| 6.5.5.6.2 | MCPTT session release step 2 (MCPTT call release - 2)..... | 121 | +| 7 | Off-network floor control..... | 121 | +| 7.1 | General..... | 121 | +| 7.2 | Floor participant procedures..... | 122 | +| 7.2.1 | Floor participant procedures at MCPTT session initialization..... | 122 | +| 7.2.1.2 | Determine off-network floor priority..... | 122 | +| 7.2.2 | Floor participant procedures at MCPTT call release..... | 124 | +| 7.2.3 | Floor participant state diagram – basic operation..... | 124 | +| 7.2.3.1 | General..... | 124 | +| 7.2.3.2 | State: 'Start-stop'..... | 125 | +| 7.2.3.2.1 | General..... | 125 | +| 7.2.3.2.2 | MCPTT call established – originating MCPTT user..... | 126 | +| 7.2.3.2.3 | MCPTT group call established – terminating MCPTT user..... | 126 | +| 7.2.3.2.4 | MCPTT private call established – terminating MCPTT user..... | 126 | +| 7.2.3.2.5 | Send Floor Request message (PTT button pressed)..... | 126 | +| 7.2.3.2.6 | Receive Floor Taken message (R: Floor Taken)..... | 127 | +| 7.2.3.2.7 | Receive Floor Granted message (R: Floor Granted to other)..... | 127 | +| 7.2.3.2.8 | Receive RTP media (R: RTP media)..... | 127 | +| 7.2.3.2.9 | MCPTT broadcast call established – terminating MCPTT user..... | 127 | +| 7.2.3.3 | State: 'O: silence'..... | 128 | +| 7.2.3.3.1 | General..... | 128 | +| 7.2.3.3.2 | Send Floor Request message (PTT button pressed)..... | 128 | +| 7.2.3.3.3 | Receive RTP media (R: RTP media)..... | 128 | +| 7.2.3.3.4 | Receive Floor Granted message (R: Floor Granted to other)..... | 128 | +| 7.2.3.3.5 | Receive Floor Request message (R: Floor Request)..... | 129 | +| 7.2.3.3.6 | Receive Floor Taken message (R: Floor Taken)..... | 129 | +| 7.2.3.3.7 | Timer T230 (Inactivity) expired..... | 129 | +| 7.2.3.4 | State: 'O: has no permission'..... | 129 | +| 7.2.3.4.1 | General..... | 129 | +| 7.2.3.4.2 | Sending Floor Request message (PTT button pressed)..... | 130 | +| 7.2.3.4.3 | Receive Floor Release message (R: Floor Release)..... | 130 | +| 7.2.3.4.4 | Timer T203 (End of RTP media) expired..... | 130 | +| 7.2.3.4.5 | Receive Floor Granted message (R: Floor Granted to other)..... | 130 | +| 7.2.3.4.6 | Receive RTP media (R: RTP media)..... | 131 | +| 7.2.3.5 | State: 'O: has permission'..... | 131 | +| 7.2.3.5.1 | General..... | 131 | +| 7.2.3.5.2 | Send RTP Media packets (S: RTP Media)..... | 131 | +| 7.2.3.5.3 | Receive Floor Release message (R: Floor Release)..... | 132 | +| 7.2.3.5.4 | Receive Floor Request message (R: Floor Request)..... | 132 | +| 7.2.3.5.5 | Send Floor Release message (PTT button released with no pending request in queue)..... | 133 | +| 7.2.3.5.6 | Send Floor Granted message (PTT button released with pending request(s) in queue)..... | 133 | +| 7.2.3.5.7 | Receive Floor Request message with pre-emption indication (R: Floor Request with pre-emption)..... | 134 | +| 7.2.3.5.8 | Receive Floor Queue Position Request message (R: Floor Queue Position Request)..... | 134 | +| 7.2.3.5.9 | Transmission time limit warning (Timer T206 expires)..... | 134 | +| 7.2.3.5.10 | Transmission time limit reached with pending request(s) in queue (Timer T207 expires)..... | 135 | +| 7.2.3.5.11 | Transmission time limit reached with no pending request in queue (Timer T207 expires)..... | 135 | +| 7.2.3.6 | State: 'O: pending request'..... | 135 | +| 7.2.3.6.1 | General..... | 135 | +| 7.2.3.6.2 | Receive RTP media (R: RTP media)..... | 136 | +| 7.2.3.6.3 | Receive Floor Queue Position Info message (R: Floor Queue Position Info)..... | 136 | +| 7.2.3.6.4 | Receive Floor Deny message (R: Floor Deny)..... | 137 | +| 7.2.3.6.5 | Send Floor Release message (PTT button released)..... | 138 | +| 7.2.3.6.6 | Send Floor Taken message (Timer T201 expired N times)..... | 138 | +| 7.2.3.6.7 | Receive Floor Granted message (R: Floor Granted to me)..... | 138 | +| 7.2.3.6.8 | Receive Floor Granted message (R: Floor Granted to other)..... | 139 | +| 7.2.3.6.9 | Timer T201 (Floor Request) expired (Timer T201 expired)..... | 140 | +| 7.2.3.6.10 | Receive Floor Request message (R: Floor request)..... | 140 | +| 7.2.3.6.11 | Receive Floor Taken message (R: Floor Taken)..... | 141 | +| 7.2.3.7 | State: 'O: pending granted'..... | 141 | + +| | | | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 7.2.3.7.1 | General..... | 141 | +| 7.2.3.7.2 | Receive RTP media (R: RTP Media)..... | 141 | +| 7.2.3.7.3 | Timer T205 (Floor Granted) expired (timer T205 expired)..... | 141 | +| 7.2.3.7.4 | Timer T205 (Floor Granted) expired N times with pending request(s) in the queue (Timer T205 expired N times AND pending request(s) in queue)..... | 141 | +| 7.2.3.7.5 | Timer T205 (Floor Granted) expired N times with no pending request in the queue (Timer T205 expired N times AND no pending request in queue)..... | 142 | +| 7.2.3.7.6 | Timer T233 (Pending user action) expires with no pending request in the queue (Timer T233 expired AND no pending request in queue)..... | 142 | +| 7.2.3.7.7 | Timer T233 (Pending user action) expires with pending request(s) in the queue (Timer T233 expired AND pending request(s) in queue)..... | 142 | +| 7.2.3.7.8 | PTT button pressed..... | 143 | +| 7.2.3.7.9 | Receive Floor Release message (R: Floor Release)..... | 143 | +| 7.2.3.7.10 | Receive Floor Request message (R: Floor Request)..... | 143 | +| 7.2.3.8 | State: 'O: queued'..... | 143 | +| 7.2.3.8.1 | General..... | 143 | +| 7.2.3.8.2 | Receive RTP media (R: RTP media)..... | 144 | +| 7.2.3.8.3 | Receive Floor Queue Position Info message (R: Floor Queue Position Info)..... | 144 | +| 7.2.3.8.4 | Receive Floor Deny message (R: Floor Deny)..... | 144 | +| 7.2.3.8.5 | User indication for release of pending request..... | 145 | +| 7.2.3.8.6 | Receive Floor Granted message (R: Floor Granted to me)..... | 145 | +| 7.2.3.8.7 | Timer T233 (Pending user action) expires..... | 146 | +| 7.2.3.8.8 | User indication for accept of pending request..... | 146 | +| 7.2.3.8.9 | Receive Floor Granted message (R: Floor Granted to other)..... | 146 | +| 7.2.3.8.10 | Timer T203 (End of RTP media) expires..... | 146 | +| 7.2.3.8.11 | Send Floor Queue Position Request message (R: Request queue position info)..... | 147 | +| 7.2.3.8.12 | Timer T204 (Floor Queue Position request) expires..... | 147 | +| 7.2.3.8.13 | Timer T204 (Floor Queue Position request) expires N times..... | 147 | +| 7.2.3.9 | In any state..... | 148 | +| 7.2.3.9.1 | General..... | 148 | +| 7.2.3.9.2 | Receive MCPTT call release (R: MCPTT call release)..... | 148 | +| 8 | Coding..... | 148 | +| 8.1 | Introduction..... | 148 | +| 8.1.1 | General..... | 148 | +| 8.1.2 | RTCP: APP message format..... | 148 | +| 8.1.3 | Application specific data field..... | 150 | +| 8.1.4 | Handling of unknown messages and fields..... | 150 | +| 8.2 | Floor control..... | 150 | +| 8.2.1 | Introduction..... | 150 | +| 8.2.2 | Floor control messages..... | 151 | +| 8.2.2.1 | General..... | 151 | +| 8.2.2.2 | Void..... | 151 | +| 8.2.3 | Floor control specific fields..... | 151 | +| 8.2.3.1 | Introduction..... | 151 | +| 8.2.3.2 | Floor Priority field..... | 152 | +| 8.2.3.3 | Duration field..... | 153 | +| 8.2.3.4 | Reject Cause field..... | 153 | +| 8.2.3.5 | Queue Info field..... | 153 | +| 8.2.3.6 | Granted Party's Identity field..... | 154 | +| 8.2.3.7 | Permission to Request the Floor field..... | 154 | +| 8.2.3.8 | User ID field..... | 155 | +| 8.2.3.9 | Queue Size field..... | 155 | +| 8.2.3.10 | Message Sequence Number field..... | 156 | +| 8.2.3.11 | Queued User ID field..... | 156 | +| 8.2.3.12 | Source field..... | 157 | +| 8.2.3.13 | Track Info field..... | 157 | +| 8.2.3.14 | Message Type field..... | 158 | +| 8.2.3.15 | Floor Indicator field..... | 158 | +| 8.2.3.16 | SSRC field..... | 159 | +| 8.2.3.17 | List of Granted Users field..... | 160 | + +| | | | +|----------|--------------------------------------------------------|-----| +| 8.2.3.18 | List of SSRCs field..... | 161 | +| 8.2.3.19 | Functional Alias field..... | 161 | +| 8.2.3.20 | List of Functional Aliases field..... | 162 | +| 8.2.3.21 | Location field..... | 162 | +| 8.2.3.22 | List of Locations field..... | 163 | +| 8.2.4 | Floor Request message..... | 164 | +| 8.2.5 | Floor Granted message..... | 165 | +| 8.2.6 | Floor Deny message..... | 167 | +| 8.2.6.1 | General..... | 167 | +| 8.2.6.2 | Rejection cause codes and rejection cause phrase..... | 168 | +| 8.2.7 | Floor Release message..... | 169 | +| 8.2.8 | Floor Idle message..... | 170 | +| 8.2.9 | Floor Taken message..... | 170 | +| 8.2.10 | Floor Revoke message..... | 172 | +| 8.2.10.1 | General..... | 172 | +| 8.2.10.2 | Floor revoke cause codes and revoke cause phrases..... | 173 | +| 8.2.11 | Floor Queue Position Request message..... | 174 | +| 8.2.12 | Floor Queue Position Info message..... | 175 | +| 8.2.13 | Floor Ack message..... | 176 | +| 8.2.14 | Floor Release Multi Talker message..... | 177 | +| 8.3 | Pre-established session call control..... | 178 | +| 8.3.1 | Introduction..... | 178 | +| 8.3.2 | Pre-established session call control message..... | 178 | +| 8.3.3 | Pre-established session call control fields..... | 178 | +| 8.3.3.1 | Introduction..... | 178 | +| 8.3.3.2 | Media Streams field..... | 179 | +| 8.3.3.3 | MCPTT Session Identity field..... | 179 | +| 8.3.3.4 | Warning Text field..... | 180 | +| 8.3.3.5 | MCPTT Group Identity field..... | 181 | +| 8.3.3.6 | Answer State field..... | 181 | +| 8.3.3.7 | Inviting MCPTT User Identity field..... | 182 | +| 8.3.3.8 | Reason Code field..... | 182 | +| 8.3.3.9 | Handling of unknown fields and messages..... | 183 | +| 8.3.3.10 | PCK I_MESSAGE field..... | 183 | +| 8.3.4 | Connect message..... | 183 | +| 8.3.5 | Disconnect message..... | 185 | +| 8.3.6 | Acknowledgement message..... | 185 | +| 8.4 | MBMS subchannel control..... | 186 | +| 8.4.1 | Introduction..... | 186 | +| 8.4.2 | MBMS subchannel control messages..... | 186 | +| 8.4.3 | MBMS subchannel control specific fields..... | 186 | +| 8.4.3.1 | Introduction..... | 186 | +| 8.4.3.2 | MCPTT Group ID field..... | 187 | +| 8.4.3.3 | MBMS Subchannel field..... | 187 | +| 8.4.3.4 | TMGI field..... | 188 | +| 8.4.3.5 | Void..... | 188 | +| 8.4.3.6 | Monitoring state..... | 188 | +| 8.4.4 | Map Group To Bearer message..... | 189 | +| 8.4.5 | Unmap Group To Bearer message..... | 189 | +| 8.4.6 | Application Paging message..... | 190 | +| 8.4.7 | Bearer Announcement message..... | 191 | +| 8.5 | MBMS notifications..... | 191 | +| 8.5.1 | Introduction..... | 191 | +| 8.5.2 | MBMS notifications control messages..... | 192 | +| 8.5.3 | MBMS notifications control specific fields..... | 192 | +| 8.5.3.1 | Introduction..... | 192 | +| 8.5.3.2 | Status field..... | 192 | +| 8.5.3.3 | Status changing MCPTT User Identity field..... | 193 | +| 8.5.3.4 | Group call ongoing field..... | 193 | +| 8.5.3.5 | Group broadcast alias field..... | 194 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------------------------------------------|-----| +| 8.5.3.6 | Group regroup alias field..... | 194 | +| 8.5.4 | Group Dynamic Data Notify message..... | 195 | +| 9 | Call setup control over pre-established session..... | 196 | +| 9.1 | General..... | 196 | +| 9.2 | MCPTT client..... | 196 | +| 9.2.1 | General..... | 196 | +| 9.2.2 | Call setup control over pre-established session state machine..... | 197 | +| 9.2.2.1 | General..... | 197 | +| 9.2.2.2 | State: 'Start-stop'..... | 197 | +| 9.2.2.2.1 | General..... | 197 | +| 9.2.2.2.2 | Pre-established session started..... | 197 | +| 9.2.2.3 | State: 'U: Pre-established session not in use'..... | 198 | +| 9.2.2.3.1 | General..... | 198 | +| 9.2.2.3.2 | Receive Connect message (R: Connect)..... | 198 | +| 9.2.2.3.3 | Pre-established session stopped..... | 198 | +| 9.2.2.3.4 | Receive Disconnect message (R: Disconnect)..... | 198 | +| 9.2.2.3.5 | Receive SIP 2xx response (R:2xx response)..... | 198 | +| 9.2.2.3.6 | Receive SIP re-INVITE request (R: re-INVITE)..... | 199 | +| 9.2.2.4 | State: 'U: Pre-established session in use'..... | 199 | +| 9.2.2.4.1 | General..... | 199 | +| 9.2.2.4.2 | Receive Connect message (R: Connect)..... | 199 | +| 9.2.2.4.3 | Receive other floor control message (R: other message)..... | 199 | +| 9.2.2.4.4 | Receive RTP media packets (R:RTP packet)..... | 199 | +| 9.2.2.4.5 | Receive Disconnect message (R: Disconnect)..... | 199 | +| 9.2.2.4.6 | Receive SIP 2xx response (R: 2xx response)..... | 199 | +| 9.3 | Participating MCPTT function..... | 200 | +| 9.3.1 | General..... | 200 | +| 9.3.2 | Call setup control over pre-established session state machine for the participating MCPTT function..... | 200 | +| 9.3.2.1 | General..... | 200 | +| 9.3.2.2 | State: 'Start-stop'..... | 201 | +| 9.3.2.2.1 | General..... | 201 | +| 9.3.2.2.2 | Pre-established session started..... | 201 | +| 9.3.2.3 | State: 'G: Pre-established session not in use'..... | 201 | +| 9.3.2.3.1 | General..... | 201 | +| 9.3.2.3.2 | Receive SIP REFER request (R: SIP REFER)..... | 201 | +| 9.3.2.3.3 | Receive SIP INVITE request (R: SIP INVITE)..... | 201 | +| 9.3.2.3.4 | Pre-established session stopped..... | 202 | +| 9.3.2.3.5 | Receive SIP 200 (OK) response to the SIP re-INVITE request (R: 200 OK)..... | 202 | +| 9.3.2.4 | State: 'G: Pre-established session in use'..... | 203 | +| 9.3.2.4.1 | General..... | 203 | +| 9.3.2.4.2 | Receive floor control message (R: Floor control message)..... | 203 | +| 9.3.2.4.3 | Receive RTP media packets (R: RTP Media)..... | 203 | +| 9.3.2.4.4 | Receive call session release indication from MCPTT client (R: Call Release from MCPTT client)..... | 204 | +| 9.3.2.4.5 | Receive call session release indication from the controlling MCPTT function (R: Call Release from MCPTT server)..... | 204 | +| 9.3.2.4.6 | Receive pre-established session stopped indication from the MCPTT client (R: Pre-established Session Stopped from MCPTT client)..... | 204 | +| 9.3.2.4.7 | Receive Acknowledge message ((R: successful Ack) or (R: failure Ack))..... | 204 | +| 9.3.2.4.8 | Timer T55 (Connect) expired..... | 205 | +| 9.3.2.4.9 | Timer T55 (Connect) expired N times..... | 205 | +| 9.3.2.4.10 | Receive SIP 200 (OK) response (R: 200 OK)..... | 205 | +| 9.3.2.4.11 | Receive failed SIP response from the controlling MCPTT function (R: Call Release from the MCPTT server)..... | 206 | +| 9.3.2.5 | State: 'G: Call releasing'..... | 206 | +| 9.3.2.5.1 | General..... | 206 | +| 9.3.2.5.2 | Receive Acknowledge message (R: Ack)..... | 206 | +| 9.3.2.5.3 | Timer T56 (Disconnect) expired..... | 206 | +| 9.3.2.5.4 | Timer T56 (Disconnect) expired N times..... | 207 | + +| | | | +|-----------|----------------------------------------------------------------------------------|-----| +| 10 | MBMS subchannel control procedure..... | 207 | +| 10.1 | General..... | 207 | +| 10.2 | MBMS subchannel control procedure for the participating MCPTT function..... | 207 | +| 10.2.1 | General..... | 207 | +| 10.2.2 | State: 'Start-stop'..... | 208 | +| 10.2.2.1 | General..... | 208 | +| 10.2.2.2 | Send Map Group To Bearer message (R: Floor Request or Floor Taken)..... | 208 | +| 10.2.3 | State: 'M: A conversation is active'..... | 209 | +| 10.2.3.1 | General..... | 209 | +| 10.2.3.2 | Send Floor Idle message (R: Floor Idle)..... | 209 | +| 10.2.3.3 | Send Floor Taken message (R: Floor Taken)..... | 210 | +| 10.2.3.3a | Send Floor Release Multi Talker (R: Floor Release Multi Talker)..... | 211 | +| 10.2.3.4 | Send any other floor control message (R: Any other message)..... | 211 | +| 10.2.3.5 | Send RTP media packet over the MBMS subchannel (R: RTP packet)..... | 211 | +| 10.2.3.6 | Timer T15 (Conversation) expired..... | 212 | +| 10.2.3.7 | Timer T16 (Map Group To Bearer) expired..... | 212 | +| 10.2.3.8 | Timer T17 (Unmap Group To Bearer) expired..... | 212 | +| 10.2.3.9 | Timer T17 (Unmap Group To Bearer) expired Nth time..... | 212 | +| 10.2.3.10 | End conversation over the MBMS bearer (End conversation)..... | 213 | +| 10.2.3.11 | Group call released..... | 213 | +| 10.2.3.12 | Move conversation to unicast..... | 213 | +| 10.3 | MBMS subchannel control procedure for the MCPTT client..... | 213 | +| 10.3.1 | General..... | 213 | +| 10.3.2 | Conversation over a pre-activated MBMS bearer is started..... | 213 | +| 10.3.3 | Receive floor control messages and RTP media packets over a MBMS subchannel..... | 214 | +| 10.3.4 | Conversation ended..... | 214 | +| 10.3.5 | Receive Application Paging message..... | 214 | +| 10.3.6 | Receive MBMS bearer announcement over MBMS bearer..... | 214 | +| 10.4 | Header compression..... | 214 | +| 10.4.1 | General..... | 214 | +| 10.4.2 | Participating MCPTT function procedure for ROHC..... | 215 | +| 10.4.3 | MCPTT client procedure for ROHC..... | 215 | +| 10A | Additional MBMS procedures..... | 215 | +| 10A.1 | Group dynamic data notifications..... | 215 | +| 11 | Configurable parameters..... | 215 | +| 11.1 | Timers..... | 215 | +| 11.1.1 | Timers in the on-network floor participant..... | 215 | +| 11.1.2 | Timers in the off-network floor participant..... | 216 | +| 11.1.3 | Timers in the floor control server..... | 219 | +| 11.1.4 | Timers in the participating MCPTT function..... | 222 | +| 11.2 | Counters..... | 223 | +| 11.2.1 | Counters in the on-network floor participant..... | 223 | +| 11.2.2 | Counters in the off-network floor participant..... | 224 | +| 11.2.3 | Counters in the controlling MCPTT function..... | 224 | +| 11.2.4 | Counters in the participating MCPTT function..... | 225 | +| 12 | Extensions within the present document..... | 226 | +| 12.1 | Session description types defined within the present document..... | 226 | +| 12.1.1 | General..... | 226 | +| 12.1.2 | SDP "fmt" attribute for MCPTT..... | 226 | +| 12.1.2.1 | General..... | 226 | +| 12.1.2.2 | Semantics..... | 226 | +| 12.1.2.3 | Syntax..... | 227 | +| 13 | Media plane security..... | 227 | +| 13.1 | General..... | 227 | +| 13.2 | Derivation of SRTP/SRTCP master keys..... | 230 | +| 13.3 | Media plane encryption and decryption..... | 230 | +| 13.3.1 | General..... | 230 | +| 13.3.2 | The participating MCPTT function..... | 230 | + +| | | | +|--------|-------------------------------------------------------------------|-----| +| 13.3.3 | The MCPTT client..... | 232 | +| 13.3.4 | The controlling MCPTT function..... | 236 | +| 13.3.5 | The non-controlling MCPTT function..... | 238 | +| 14 | SDP offer/ answer procedures..... | 238 | +| 14.1 | General..... | 238 | +| 14.2 | Generating an SDP offer..... | 239 | +| 14.2.1 | General..... | 239 | +| 14.2.2 | "mc_queueing" fmtp attribute..... | 239 | +| 14.2.3 | "mc_priority" fmtp attribute..... | 239 | +| 14.2.4 | "mc_granted" fmtp attribute..... | 239 | +| 14.2.5 | "mc_implicit_request" fmtp attribute..... | 239 | +| 14.2.6 | "mc_no_floor_ctrl" fmtp attribute..... | 239 | +| 14.3 | Generating the SDP answer..... | 240 | +| 14.3.1 | General..... | 240 | +| 14.3.2 | "mc_queueing" fmtp attribute..... | 240 | +| 14.3.3 | "mc_priority" fmtp attribute..... | 240 | +| 14.3.4 | "mc_granted" fmtp attribute..... | 240 | +| 14.3.5 | "mc_implicit_request" fmtp attribute..... | 241 | +| 14.3.6 | "mc_ssrc" fmtp attribute..... | 241 | +| 14.3.7 | "mc_no_floor_ctrl" fmtp attribute..... | 241 | +| 14.4 | Offerer processing of the SDP answer..... | 241 | +| 14.5 | Modifying the media plane control channel..... | 241 | +| 14.6 | The use of SDP offer / answer procedures in off-network mode..... | 242 | +| 14.6.1 | General..... | 242 | +| 14.6.2 | fmtp attribute "mc_queueing"..... | 242 | + +**Annex A (informative): Signalling flows.....243** + +| | | | +|---------|--------------------------------------------------------------------------------------|-----| +| A.1 | Scope of signalling flows..... | 243 | +| A.2 | Introduction..... | 243 | +| A.2.1 | General..... | 243 | +| A.2.2 | Key required to interpret signalling flows..... | 243 | +| A.3 | On-network floor control signalling flows..... | 244 | +| A.3.1 | General..... | 244 | +| A.3.2 | Floor request when the floor is idle..... | 244 | +| A.3.3 | Floor request when floor is taken and queueing is not applied..... | 246 | +| A.3.4 | Floor request when floor is taken and queueing is applied..... | 247 | +| A.3.5 | Pre-emptive floor request when floor is taken..... | 248 | +| A.4 | Off-network floor control signalling flows..... | 250 | +| A.4.1 | General..... | 250 | +| A.4.2 | Off-network floor control during an MCPTT group call..... | 250 | +| A.4.2.1 | Floor request when the floor is idle..... | 250 | +| A.4.2.2 | Floor request when floor is taken and queueing of floor requests is not applied..... | 251 | +| A.4.2.3 | Floor request when floor is taken and queueing is applied..... | 252 | +| A.4.2.4 | Pre-emptive floor request when floor is taken..... | 254 | +| A.5 | Pre-established session signalling flows..... | 255 | +| A.5.1 | General..... | 255 | +| A.5.2 | Call Initialization..... | 255 | +| A.5.2.1 | Originating Side when initialization accepted..... | 255 | +| A.5.2.2 | Originating Side when initialization rejected..... | 257 | +| A.5.2.3 | Termination Side when call initialization accepted..... | 258 | +| A.5.3 | Call release..... | 259 | +| A.6 | MBMS subchannel control signalling flows..... | 260 | +| A.6.1 | General..... | 260 | +| A.6.2 | Announcing MBMS subchannels..... | 260 | +| A.6.3 | Initiating a conversation and requesting floor, originating side..... | 263 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------|------------| +| A.6.4 | Releasing floor and ending a conversation..... | 264 | +| Annex B (informative): | Media encapsulation for end-to-end distribution using MBMS bearers..... | 267 | +| Annex C (Informative): | Floor control state machine transitions tables..... | 269 | +| C.1 | Introduction..... | 269 | +| C.2 | Off-network tables..... | 269 | +| C.2.1 | Off-network call floor control state machine transitions..... | 269 | +| Annex D (informative): | Change history..... | 273 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document specifies the media plane control protocols and interactions with the media needed to support Mission Critical Push To Talk (MCPTT). + +The present document specifies protocol for using pre-established session to setup calls, floor control and managing MBMS subchannels over MBMS bearers on-network and off-network protocols for floor control. + +Mission critical communication services are services that require preferential handling compared to normal telecommunication services, e.g. in support of police or fire brigade. Floor control provides a mechanism for managing the right to transmit at a point in time during an MCPTT call. + +The MCPTT service and its associated media plane control protocols can be used for public safety applications and also for general commercial applications (e.g., utility companies and railways). + +The present document is applicable to User Equipment (UE) supporting the floor participant functionality, setting up calls using pre-established SIP sessions and using MBMS bearers for group communication and to floor control servers supporting these functions in the MCPTT system. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control Protocol specification". +- [3] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [4] 3GPP TS 24.483: "Mission Critical Services (MCS) Management Object (MO)". +- [5] 3GPP TS 23.379: "Functional architecture and information flows to support mission critical communication services; Stage 2". +- [6] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE); MB2 Reference Point; Stage 3". +- [7] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [8] IETF RFC 3711: "The Secure Real-time Protocol (SRTP)". +- [9] 3GPP TS 25.446: "MBMS synchronization protocol (SYNC)". +- [10] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [11] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [12] 3GPP TS 24.481: "Mission Critical Services (MCS) group management Protocol specification". +- [13] 3GPP TS 24.484: "Mission Critical Services (MCS) configuration management protocol specification". + +- [14] Void. +- [15] IETF RFC 3830: "MIKEY: Multimedia Internet KEYing". +- [16] IETF RFC 3711: "The Secure Real-time Transport Protocol (SRTP)". +- [17] IETF RFC 6509: "MIKEY-SAKKE: Sakai-Kashar Key Encryption in Multimedia Internet KEYing (MIKEY)". +- [18] 3GPP TS 33.180: "Security of the mission critical service". +- [19] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [20] IETF RFC 5795: "The Robust Header Compression (ROHC) Framework". +- [21] IETF RFC 3095: "RObust Header Compression (ROHC): Framework and four profiles: RTP, UDP, ESP, and uncompressed". +- [22] IETF RFC 5225: "RObust Header Compression Version 2 (ROHCv2): Profiles for RTP, UDP, IP, ESP and UDP-Lite". +- [23] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term or definition defined in the present document takes precedence over the definition of the same term or definition, if any, in 3GPP TR 21.905 [1]. + +**Active floor request queue:** The floor request queue used by the floor control server to queue received Floor Request messages. + +**Candidate arbitrator:** The queued floor participant in off-network to whom the floor was granted. Once the candidate arbitrator responds to the floor grant, it becomes the current arbitrator. + +**Controlling MCPTT function:** The MCPTT server performing a controlling role. + +**Conversation:** A number of media bursts exchanged between participants in a group call session. + +**Current arbitrator:** The floor participant in off-network currently arbitrating the floor. + +**Effective priority:** The priority decision determined by the floor control server based on multiple input parameters like floor priority, participant type, type of call etc. of the current floor request and of the current participant to which floor is granted if any and the local policy. + +**MBMS bearer:** The service provided by the EPS to deliver the same IP datagrams to multiple receivers in a designated location. + +**MBMS subchannel:** A logical channel which uses resources of an activated and announced MBMS bearer identified by the TMGI of the MBMS bearer and additional parameters, like UDP port, associated to a group or the MBMS subchannel used to e.g. inform when a conversation in a group call is started or ended. + +NOTE: In this release of the specifications the UDP port is the only parameter used for enabling the differentiation of media and media plane control packets belonging to different groups over the same MBMS bearer by a receiving MCPTT client. + +**Media burst:** A flow of media from an MCPTT client that has the permission to send media. + +**Media plane control protocols:** Protocols in the media plane used for floor control, pre-established session call control and MBMS subchannel control. + +**Participating MCPTT function:** The MCPTT server performing a participating role. + +**Passive floor request queue:** The floor request queue used by the non-controlling MCPTT function to store received Floor Request messages for monitoring purposes. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.379 [5] apply: + +**Ambient listening call** +**Floor control** +**Floor participant** +**Floor control server** +**Group call** +**MCPTT call** +**MCPTT server performing a controlling role** +**MCPTT server performing a participating role** +**MCPTT user** +**Mission critical push to talk** +**Multi-talker control** +**Private call** +**SIP core** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.379 [2] apply: + +**Non-controlling MCPTT function of an MCPTT group** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 33.180 [18] apply: + +**Client Server Key (CSK)** +**Client Server Key Identifier (CSK-ID)** +**Group Master Key (GMK)** +**Group Master Key Identifier (GMK-ID)** +**Multicast Key for Floor Control (MKFC)** +**Identifier of Multicast Key for Floor Control (MKFC-ID)** +**Multicast Signalling Key (MuSiK)** +**Multicast Signalling Key Identifier (MuSiK-ID)** +**Private Call Key (PCK)** +**Private Call Key Identifier (PCK-ID)** +**Signalling Protection Key (SPK)** +**Signalling Protection Key Identifier (SPK-ID)** +**MBMS SubChannel Control Key (MSCCK)** +**MBMS SubChannel Control Key Identifier (MSCCK-ID)** + +For the purposes of the present document, the following terms and definitions given in IETF RFC 3711 [16] apply: + +**SRTP master key (SRTP-MK)** +**SRTP master key identifier (SRTP-MKI)** +**SRTP master salt (SRTP-MS)** + +## 3.2 Abbreviations + +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]. + +| | | +|--------|------------------------------------------------| +| AS | Application Server | +| CID | Context ID | +| CSK | Client Server Key | +| CSK-ID | Client Server Key Identifier | +| D2D | Device to Device | +| DL | Downlink | +| GCS AS | Group Communication Service Application Server | +| GMK | Group Master Key | + +| | | +|----------|---------------------------------------------------------| +| GMK-ID | Group Master Key Identifier | +| GMS | Group Management Server | +| GUK-ID | Group User Key Identifier | +| IP | Internet Protocol | +| MBMS | Multimedia Broadcast and Multicast Service | +| MCMC | Mission Critical MBMS subchannel Control Protocol | +| MCPTT | Mission Critical Push To Talk | +| MKFC | Multicast Key for Floor Control | +| MKFC-ID | Identifier of Multicast Key for Floor Control (MKFC-ID) | +| MSCCK | MBMS SubChannel Control Key | +| MSCCK-ID | MBMS SubChannel Control Key Identifier | +| MuSiK | Multicast Signalling Key | +| MuSiK-ID | Multicast Signalling Key Identifier | +| PCK | Private Call Key | +| PCK-ID | Private Call Key Identifier | +| PTT | Push-To-Talk | +| RFC | Request For Comment | +| ROHC | Robust Header Compression | +| RTCP | RTP Control Protocol | +| RTP | Real-time Transport Protocol | +| SPK | Signalling Protection Key | +| SPK-ID | Signalling Protection Key Identifier | +| SRTCP | Secure RTCP | +| SRTP | Secure RTP | +| SRTP-MK | SRTP master key | +| SRTP-MKI | SRTP master key identifier | +| SRTP-MS | SRTP master salt | +| SSRC | Synchronization SouRcE | +| TMGI | Temporary Mobile Group Identity | +| UE | User Equipment | + +## 4 General + +### 4.1 Overview + +#### 4.1.1 Floor Control + +##### 4.1.1.1 General + +In a PTT group call after the call is setup, at a given time only a single group member is allowed to talk and all other affiliated group members listen to this talker. The control action for obtaining this mode of operation is known as floor control. The direct actors of floor control are the floor participants and the floor control server. A floor participant does the floor control related actions in the MCPTT client. The floor control server is the decision maker of the floor control. In on-network the floor control server is in the MCPTT server with the controlling role. In off-network no specific floor control server exists. The current talker plays the role of floor control server. + +Floor control actions in on-network are described in subclause 4.1.1.2. The differences for off-network floor control are described in subclause 4.1.1.3. + +NOTE: End-user actions as operation of the PTT button illustrates functionality but no end-user actions are mandated by the present document. + +##### 4.1.1.2 On-network floor control + +At any point in time a group member can request permission to talk. + +When all group members are silent, a group member can press the PTT button, meaning the request for permission to talk. The floor participant entity of this user reflects this request to the floor control server by sending a Floor Request message. If the floor control server decides to permit, it informs this permission for this request by sending a Floor Granted message to the requesting group member. The floor control server informs the initiation of the talk to the other group members by sending a Floor Taken message. Once the group member receives the permission, a permission indication (permission tone) is generated by the client to inform the user that they can talk. The media packets (encoded voice) are sent to the controlling MCPTT server and from there they are distributed to all listeners of this group. The release of the PTT button indicates the user's intention to end talking. Once the PTT button is released, the floor participant sends a Floor Release message to the floor control server indicating that this user has finished talking. This cycle, starting from the Floor Granted message and ending with Floor Release message, is known as 'talk burst' or 'media burst'. + +In the beginning of a call the initial talk permission request can be implied by the SIP message which initiates the call as specified in 3GPP TS 24.379 [2] without any specific Floor Request message. For ambient listening, the implied talk permission request can be applied to the user on the originating side or to the user on the terminating side. + +A group member can also request permission to talk by sending a Floor Request message during a talk burst. The floor control server can resolve this request in several ways. + +1. If this request has higher priority than the ongoing talk burst, the floor control server revokes the current talk burst by sending a Floor Revoke message to the current talker. The current talker is interrupted and the current media burst is ended by the current floor participant by sending a Floor Release message. Then the floor control server sends a Floor Granted message to the revoking user and send Floor Taken message to other group members. Then a new media burst starts. +2. If this request does not have higher priority and floor request queueing is not used the floor control server rejects this request by sending a Floor Deny message to the requester. Then a reject indication (reject tone) is generated for the user. The ongoing talk burst continues. +3. If request queueing is used the floor control server sends Floor Queue Position Info message indicating that there is no permission but the request is queued for potential permission when the current talk burst ends. Then a "queued" indication is generated for the user. The ongoing talk burst continues. + +In the case of an ambient listening call, the user initially granted the floor retains the floor for the duration of the call. + +During a talk burst, a queued user can ask its position in the queue by sending a Floor Queue Position Request message. Then the floor control server provides the information by sending Floor Queue Position Info message. A queued user can also remove itself from the queue by sending a Floor Release message. This kind of message exchange during a talk burst does not affect the ongoing talk burst. + +If request queueing is used, by the end of a talk burst, the floor control server gives the talk permission to the first pending request in the queue. For this, it sends the same messages as in the beginning of a talk burst; Floor Granted message to the permitted user and Floor Taken message to other group members. The permitted user is expected to press the PTT button after the permission tone within a well-defined short period of time. If PTT button is pressed the media burst continues normally until it is released. If not, the MCPTT client loses the talk permission. + +If queueing is used the ordering in the queue is affected by the priority of the users in the queue. + +A floor request with pre-emptive priority can be granted without revoking the current speaker. In this case media from both the overridden current talker and the overriding MCPTT user is distributed to selected participants at the same time. The list of participants that receive the overriding, overridden, or both transmissions is based on configuration. + +Pre-emptive priority without revoking the current talker is not applicable if the group is configured for audio cut-in floor control. + +If a group is configured as multi-talker group, floor request can be granted to a group member which is allowed to talk in this group without revoking the current talker, provided the number of simultaneous talkers is not greater than "maximum number of simultaneous talkers". If the upper limit is reached one of the talkers can be revoked or the current request can be denied based on relative priorities. If configured, when the floor request of an allowed user is not granted the participant requesting the floor may also be queued. + +During silence (when no talk burst is ongoing), the floor control server can send Floor Idle message to all floor participants from time to time. The floor control server sends Floor Idle message in the beginning of silence. + +Some of the floor control messages can be repeated as specified in state machines specified in clause 6. + +The call can be released after a long silence period. + +#### 4.1.1.3 Off-network floor control + +This subclause describes the special features for off-network floor control with respect to the on-network floor control. + +In off-network no specific floor control server exists. All floor control messages are sent to all group members. + +When a floor control server gives talk permission it sends a Floor Granted message. The information element which expresses the group member, to which this talk permission is given, implies to the other group members that the floor is taken. No other Floor Taken message is sent. + +After silence, a floor participant asks for talk permission by sending a Floor Request message. After a well-defined waiting period, if no response is received, this floor participant sends a Floor Taken message indicating itself in the information element which expresses the group member to which this talk permission is given and continues the talk burst. + +In off-network, the Floor Idle message is not used. + +Some of the floor control messages can be repeated as specified in the state machines specified in clause 7. + +Audio cut-in floor control is not applicable for off-network. + +#### 4.1.1.4 Determine on-network effective priority + +The floor control server can determine how to handle a received Floor Request message using a number of input parameters. Examples of input parameters that the floor control server can use are: + +1. the floor priority, using the value of the Floor Priority field in the Floor Request message; +2. the element as specified in 3GPP TS 24.481 [12]; +3. the element as specified in 3GPP TS 24.484 [13]; +4. the participant type, using the element specified in 3GPP TS 24.481 [12] or, in case a non-controlling MCPTT function is attached to a group call, the value in the Track Info field in the Floor Request message; +5. the type of call indicated in the Floor Indicator field; +6. the effective priority of the floor participant with the permission to send media, and the current type of the call (e.g. normal, imminent-peril, emergency, broadcast); and +7. any other information in the group document specified in 3GPP TS 24.481 [12] or information stored in the controlling MCPTT function outside the scope of the present document. + +Using a local policy and the above input parameters the floor control server can determine that a floor request is: + +1. pre-emptive such that the current talker is overridden; +2. pre-emptive such that the current talker is revoked; +3. not pre-emptive and put in the floor request queue, if queueing was negotiated; or +4. not-pre-emptive and rejected, if queueing was not negotiated. + +#### 4.1.1.5 Determine off-network effective priority + +The floor control participant can determine how to handle a received Floor Request message using the following input parameters: + +1. the floor priority, using the value of the Floor Priority field in the Floor Request message; + +2. the value of the "//Common/MCPTTGroupMemberList//UserPriority" leaf node of the sender of the Floor Request message, present in group configuration as specified in 3GPP TS 24.483 [4]; +3. the value of the "/OffNetwork/NumLevelHierarchy" leaf node present in service configuration as specified in 3GPP TS 24.483 [4]; +4. the type of call indicated in the Floor Indicator field; and +5. the effective priority of the floor participant with the permission to send media, and the current type of the call (e.g. normal, imminent-peril, emergency). + +Using the policy as described in subclause 7.2.1.2, and the above input parameters the floor control participant can determine that a floor request is: + +1. pre-emptive such that the current talker is revoked; +2. not pre-emptive and put in the floor request queue, if the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true"; or +3. not-pre-emptive and rejected, if the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false". + +## 4.1.2 Pre-established session call control + +### 4.1.2.1 General + +An MCPTT client can pre-establish a session with the participating MCPTT function for potential use when a call is setup. The establishment, the modification and the release of a pre-established session are specified in 3GPP TS 24.379 [2]. + +NOTE: The establishment of a pre-established session, for potential use when a call is setup, depends on the policy chosen by the MCPTT service provider. + +A pre-established session can be used when initiating a pre-arranged group call, a chat group call or a private call. Similarly, a pre-established session can be released for reuse after the termination of a pre-arranged group call, chat group call and private call. + +The media plane control messages related to call setup over a pre-established session are sent over the channel used for media plane control. The media plane control messages related to the release of a call which was setup over a pre-established session, without terminating the pre-established session, are sent over the channel used for media plane control. The unicast channel for media plane control is over the MCPTT-4 reference point. + +### 4.1.2.2 Call setup over pre-established session + +For a pre-arranged group call, when the originator initiates the call setup indicating the use of a pre-established session using SIP messages as specified in 3GPP TS 24.379 [2], the participating MCPTT function (which serves the originating MCPTT client) sends to the originating MCPTT client a Connect message after the controlling MCPTT function accepts the initiation of this call. After the reception of this Connect message the originating MCPTT client sends an Acknowledgment message indicating that the connection is accepted or indicating that the connection is not accepted. If the connection is accepted by the originating MCPTT client, the floor control for this call continues as specified in clause 6. + +For a pre-arranged group call if the controlling MCPTT function as triggered by an originating group member initiates a call as specified in 3GPP TS 24.379 [2], the participating MCPTT function which serves the terminating MCPTT client sends a Connect message to all affiliated MCPTT clients of this group. After the reception of the Connect message the terminating MCPTT client sends an Acknowledgment message indicating that the connection is accepted or indicating that the connection is not accepted. If the connection is accepted by the terminating MCPTT client, the floor control for this call continues as specified in clause 6. + +NOTE: If a terminating client does not have an available pre-established session, the call setup proceeds as in on-demand call setup as specified in 3GPP TS 24.379 [2]. + +For a chat group call, a group member can use a pre-established session when joining the chat group using SIP messages as specified in 3GPP TS 24.379 [2]. For a group member that has already joined the chat group call, the floor control between the MCPTT client (floor participant) and the MCPTT server (floor control server) continues as specified in clause 6. + +For a private call the procedures for the originator are the same as for the originator initiating a call for a pre-arranged call setup over a pre-established session, with the difference that the recipient of the call is a private user and not a pre-arranged group. + +For a private call if the controlling MCPTT function as triggered by the originator initiates a call as specified in 3GPP TS 24.379 [2], the participating MCPTT function (which serves the terminating MCPTT client) sends a Connect message to the terminating MCPTT client served by the participating MCPTT function if this MCPTT client has an available pre-established session and the commencement mode is automatic. If the commencement mode is manual the terminating MCPTT client is invited using SIP procedures as specified in 3GPP TS 24.379 [2]. + +#### 4.1.2.3 Release of a call which uses a pre-established session + +When a call is released by the controlling MCPTT function (as specified in 3GPP TS 24.379 [2]), the participating MCPTT function sends a Disconnect message to all MCPTT clients which used a pre-established session for this call. Then the call is released (see also 3GPP TS 24.379 [2]) and the pre-established session can be used for another call. + +When an MCPTT client leaves a call (as specified in 3GPP TS 24.379 [2]) which was setup over a pre-established session without releasing the pre-established session, this pre-established session can be used for another call. + +A call setup over a pre-established session can also be released by using the specifications in 3GPP TS 24.379 [2] (without the use of Disconnect message). As a result the pre-established session, which has been used for this call, is also released. + +#### 4.1.3 MBMS subchannel control + +##### 4.1.3.1 General + +The participating MCPTT function can use an MBMS bearer for the DL transmission of the media and the media control plane. + +The participating MCPTT function decides to activate an MBMS bearer. After the activation of the MBMS bearer, as specified in 3GPP TS 29.468 [6], the TMGI of this MBMS bearer is announced to the MCPTT clients in the MBMS service area of this MBMS bearer. This announcement enables the MCPTT client to listen (decode/demodulate) this MBMS bearer. The activation of an MBMS bearer and the announcement of the TMGI create a pool of MBMS subchannel resources without any association to a group or other purposes. + +The criteria for a participating MCPTT function to decide to activate and use an MBMS bearer is implementation dependent. + +An MBMS bearer can be used for the DL transmission for more than one group. For this, additional parameters like destination UDP port are used for enabling the differentiation of messages and packets belonging to different groups over the same MBMS bearer by a receiving MCPTT client. + +When a TMGI is announced a general purpose MBMS subchannel is created by defining an association between the identity of the general purpose MBMS subchannel (e.g. 'general purpose') and the TMGI (of the activated and announced MBMS bearer) together with the parameters (e.g. UDP port) differentiating this general purpose MBMS subchannel in this MBMS bearer. The parameters of this general purpose MBMS subchannel can be communicated to the MCPTT clients in the MBMS service area of this MBMS bearer using unicast over-the-air transmission or can be pre-defined and stored in the MCPTT user profile that is downloaded to the MCPTT UE. + +##### 4.1.3.2 Start of a conversation + +When a conversation is started (by an originating MCPTT client of a group) the participating MCPTT function can allocate an MBMS subchannel for this group by defining an association between this group (e.g. 'group id') and the TMGI (of the activated and announced MBMS bearer) with the parameters differentiating this MBMS subchannel in this MBMS bearer. The parameters of this MBMS subchannel are sent using the general purpose MBMS subchannel + +using the Map Group To Bearer message. The Map Group To Bearer message is repeated as long as the conversation is ongoing for improving the reception probability and to allow MCPTT clients arriving late to listen to the MBMS subchannel. + +The same MBMS subchannel can be used for media and media control plane of an MCPTT group, subjected to the restrictions stated in IETF RFC 5761 [7]. + +#### 4.1.3.3 During a conversation + +If an MBMS subchannel exists, the participating MCPTT function forwards the media plane control messages, received from the controlling MCPTT function via MBMS subchannel for media plane control. Only floor control messages which are transmitted to more than one affiliated group member are forwarded to the MBMS bearer (e.g. the Floor Taken and Floor Idle messages). The floor control messages can be repeated a configurable number of times for improving the reception probability. The participating MCPTT function forwards the media packets, received from the controlling MCPTT function, via the MBMS subchannel for media. + +Amongst all affiliated group members under this participating MCPTT function, the participating MCPTT function is informed or is enabled to deduce the group members which do not or cannot receive the MBMS subchannels. The participating MCPTT function forwards the media packets and the media plane control messages, received from the controlling MCPTT function, to the group members which do not or cannot receive the MBMS subchannels, using unicast bearers allocated for media and media plane control respectively. + +#### 4.1.3.4 Ending the conversation + +The participating MCPTT function can de-allocate an MBMS subchannel after a configurable period of silence in the conversation by removing the association to this group by sending the Unmap Group To Bearer message over this MBMS subchannel. The de-allocation of the MBMS subchannel frees the parameters used for differentiating this MBMS subchannel in this MBMS bearer. Therefore, the resources of a de-allocated MBMS subchannel can be reallocated for a conversation of another group. + +NOTE: The participating MCPTT function will activate MBMS bearers with general QoS characteristics suitable for MCPTT service and will map MBMS subchannels for media or media plane control only to MBMS bearers that can provide the QoS required by media or media plane control. + +#### 4.1.3.5 Starting a call over unicast bearers + +The participating MCPTT function can prior to starting a call over unicast bearers send an Application Paging message, using the MBMS subchannel, to the group intended for the conversation. The procedures to initiate the conversation over the unicast bearers then proceed as described in clause 10. + +#### 4.1.3.6 Moving a conversation to unicast bearers + +The participating MCPTT function can move an ongoing conversation from an MBMS bearer to unicast bearers by first sending an Application Paging message using the MBMS subchannel, and then sending an Unmap Group To Bearer message. After the Unmap Group To Bearer message the conversation continues using the unicast bearers. + +#### 4.1.3.7 MBMS bearer announcement over an MBMS bearer + +The participating MCPTT function can activate an MBMS bearer that previously has been announced over a unicast bearer by sending an MBMS bearer announcement over an MBMS bearer. The MCPTT client acknowledges that it can listen to the MBMS bearer by sending a listening status report. + +## 4.2 Internal structure of media plane control entities + +### 4.2.1 Controlling MCPTT function + +According to 3GPP TS 23.379 [5] the controlling MCPTT function is divided into a floor control server and a media distribution function. In the present document the internal structure of the MCPTT server is illustrated in figure 4.2-1. + +![Figure 4.2.1-1: Internal structure of floor control in the controlling MCPTT function. The diagram shows a nested box structure. The outermost box contains three stacked rectangular boxes. The top box contains a smaller rectangle on its right side. The middle box is empty. The bottom box is empty. This structure represents the internal components of the controlling MCPTT function.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +Figure 4.2.1-1: Internal structure of floor control in the controlling MCPTT function. The diagram shows a nested box structure. The outermost box contains three stacked rectangular boxes. The top box contains a smaller rectangle on its right side. The middle box is empty. The bottom box is empty. This structure represents the internal components of the controlling MCPTT function. + +NOTE: The real internal structure of the MCPTT server is implementation specific but a possible internal structure is shown to illustrate the procedures. + +**Figure 4.2.1-1: Internal structure of floor control in the controlling MCPTT function** + +All entities in the controlling MCPTT function are assumed to have a direct communication interface to the application and signalling plane. The interface to the application and signaling plane carries information about SIP session initialisation and SIP session release, SDP content, etc. + +The reference point MCPTT-3 is described in 3GPP TS 23.379 [5]. + +The floor control interface towards the MCPTT client receives and transmits the floor control messages from and to the MCPTT client via the participating MCPTT function or non-controlling MCPTT function. The procedures are controlled by a state machine described in subclause 6.3.5. One state machine is needed for each MCPTT client participating in an MCPTT call. A non-controlling MCPTT function is seen by the floor control interface towards the MCPTT client as an MCPTT client. + +The floor control arbitration logic is performing the floor control. The floor control arbitration logic is controlled by a state machine described in subclause 6.3.4. One state machine is needed per MCPTT call. + +The floor request queue is accessible both by the floor control interface towards the MCPTT client for all MCPTT clients in the call and the floor control arbitration logic. + +The network media interface is receiving and sending media from and to the associated MCPTT client via the participating MCPTT function or non-controlling MCPTT function. The network media interface is out of scope of the present document. One network media interface is needed for each MCPTT client participating in an MCPTT call. A non-controlling MCPTT function is seen by the network media interface as an MCPTT client. + +The media distributor is controlled by the floor control arbitration logic. The media distributor is out of scope of the present document. One media distributor is needed per MCPTT call. + +The internal interfaces are assumed to transport the following types of information. + +1. The interface between the network media interface and the floor control interface towards the MCPTT client: + - a. Indication that the network media interface has started to receive media packets from the associated MCPTT client or that media packets are no longer received from the associated MCPTT client. +- NOTE: It is an implementation option whether an indication e.g. is sent for every received RTP media packet or only when the first packet is received and then when no more RTP packets are received. +2. The interface between the floor control interface towards the MCPTT client and the floor control arbitration logic: + - a. Floor control messages to and from the associated MCPTT client, requests to create or delete the state machine instance for the associated MCPTT client. The floor control messages to the floor control arbitration logic are limited to floor control messages that will change the state of the floor. + 3. The interface between the network media interface and the media distributor: + - a. Media to and from associated MCPTT clients. This interface is out of scope of the present document. + 4. The interface between the floor control arbitration logic and the media distributor: + - a. Requests to start or stop distributing media to participants in the MCPTT call. Indication that the media distributor has started to receive media packets from the network media interface associated with the MCPTT client with the permission to send media or that media packets are no longer received from the network media interface from the associated MCPTT client. + 5. The interface between the floor control interface towards the MCPTT client and the floor request queue: + - a. Requests to store received Floor Request messages in the queue or requests to remove Floor Request messages from the queue and the queue content for building the Floor Queue Position Info message. + 6. The interface between the floor control arbitration logic and the floor request queue: + - a. Requests to store received Floor Request messages in the queue or requests to remove Floor Request messages from the queue. Indications that the queue is modified. + +## 4.2.2 MCPTT client + +According to 3GPP TS 23.379 [5] the MCPTT client is divided into a floor participant and a media mixer function. In the present document the internal structure of the MCPTT client is illustrated in figure 4.2.2-1. + +![Diagram of the internal structure of the MCPTT client. The client is shown as a large rectangle containing four stacked components: 'Application and signaling plane' at the top, 'Floor participant', 'Media mixer', and 'MBMS interface' at the bottom. An external 'MCPTT user' box is connected to the left side of the client. Reference points are indicated on the right: MCPTT-4 is connected to the Floor participant, MCPTT-7 to the Media mixer, MCPTT-8 to the MBMS interface, and MCPTT-6 is connected to the bottom of the client box.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +graph TD + subgraph MCPTT_client [MCPTT client] + direction TB + A[Application and signaling plane] + B[Floor participant] + C[Media mixer] + D[MBMS interface] + A --- B + B --- C + C --- D + end + User[MCPTT user] --- MCPTT_client + B --- MCPTT4[MCPTT-4] + C --- MCPTT7[MCPTT-7] + D --- MCPTT8[MCPTT-8] + MCPTT_client --- MCPTT6[MCPTT-6] + +``` + +Diagram of the internal structure of the MCPTT client. The client is shown as a large rectangle containing four stacked components: 'Application and signaling plane' at the top, 'Floor participant', 'Media mixer', and 'MBMS interface' at the bottom. An external 'MCPTT user' box is connected to the left side of the client. Reference points are indicated on the right: MCPTT-4 is connected to the Floor participant, MCPTT-7 to the Media mixer, MCPTT-8 to the MBMS interface, and MCPTT-6 is connected to the bottom of the client box. + +NOTE: The real internal structure of the MCPTT client is implementation specific but a possible internal structure is shown to illustrate the logic and the procedures. + +**Figure 4.2.2-1: Internal structure of the MCPTT client** + +All entities in the MCPTT client have a direct communication interface to the application and signalling plane. The interface to the application and signaling plane carries information about SIP session initialisation and SIP session release, SDP content, etc. + +The reference points MCPTT-4, MCPTT-6, MCPTT-7 and MCPTT-8 are described in 3GPP TS 23.379 [5]. + +The floor participant receives and sends floor control and pre-established session control message over the unicast bearer. + +The media mixer receives and sends RTP media packets over the unicast bearer. The media mixer indicates to the floor participant when RTP media packets are received and when RTP media packets are no longer received. The floor participant instructs the media mixer on how to handle media received from the user or received from the network either over the unicast bearer or over the MBMS bearer. + +The MBMS interface receives RTP media packets over the MBMS bearer. The RTP media packets are forwarded to the media mixer. + +The MBMS interface receives floor control messages and MBMS subchannel control messages over the MBMS bearer. The MBMS interface forward received floor control messages to the floor participants. + +The floor participant receives indication from the MCPTT client when the MCPTT user has pressed or released the PTT button. The MCPTT client can also provide notification towards the MCPTT user. Voice received from the MCPTT user is, on instruction from the floor participant, encoded by the media mixer and sent as RTP media packets over the unicast bearer. + +## 4.2.3 Participating MCPTT function + +### 4.2.3.1 General + +The participating MCPTT function performs the participating role of an MCPTT server as defined in 3GPP TS 23.379 [5]. The participating MCPTT function uses media plane control (non-SIP) messages when taking part in the floor control procedures as specified in clause 6, call over pre-established session as specified in clause 9 and the use of MBMS Bearer procedures as specified in clause 10. In the sequel the term 'controlling MCPTT function' is used for the entity which performs the controlling role of an MCPTT server. + +The following subclauses describe the assumed internal structure of a participating MCPTT function and the role of the participating function in the floor control procedures, the call over pre-established session procedures and the use of MBMS Bearer procedures. + +### 4.2.3.2 Internal structure of the participating MCPTT function + +In the present document the internal structure of the participating MCPTT function is illustrated in figure 4.2.3.2-1. + +![Diagram of the internal structure of the participating MCPTT function. The diagram shows a large box labeled 'Participating MCPTT function' containing four stacked sub-components: 'Application and signaling plane', 'Media and floor control messages distribution', 'MBMS bearer management', and 'GCS AS'. External reference points are indicated by lines: MCPTT-4 and MCPTT-7 on the left, MCPTT-3 on the right, and MCPTT-9 and MCPTT-8 on the bottom left.](e9b43ac020435f8121e8592f31afdc52_img.jpg) + +``` + +graph TD + subgraph PMCPF [Participating MCPTT function] + direction TB + A[Application and signaling plane] + B[Media and floor control messages distribution] + C[MBMS bearer management] + D[GCS AS] + A --- B + B --- C + C --- D + end + MCPTT4[MCPTT-4] --- PMCPF + MCPTT7[MCPTT-7] --- PMCPF + PMCPF --- MCPTT3[MCPTT-3] + MCPTT9[MCPTT-9] --- PMCPF + MCPTT8[MCPTT-8] --- PMCPF + +``` + +Diagram of the internal structure of the participating MCPTT function. The diagram shows a large box labeled 'Participating MCPTT function' containing four stacked sub-components: 'Application and signaling plane', 'Media and floor control messages distribution', 'MBMS bearer management', and 'GCS AS'. External reference points are indicated by lines: MCPTT-4 and MCPTT-7 on the left, MCPTT-3 on the right, and MCPTT-9 and MCPTT-8 on the bottom left. + +NOTE: The real internal structure of the participating MCPTT function is implementation specific but a possible internal structure is shown to illustrate the logic and the procedures. + +**Figure 4.2.3.2-1: Internal structure of the MCPTT client** + +All entities in the participating MCPTT function have a direct communication interface to the application and signalling plane. The interface to the application and signalling plane carries information about SIP session initialisation and SIP session release, SDP content, etc. + +The reference points MCPTT-3, MCPTT-4, MCPTT-7, MCPTT-8 and MCPTT-9 are described in 3GPP TS 23.379 [5]. + +The media and floor control message distribution receives media control messages and RTP media packets to and from the MCPTT client and the controlling MCPTT function and the non-controlling MCPTT function. Media plane control messages and RTP packets are forwarded as received when unicast bearers are used. If MBMS bearers are used for floor control messages, MBMS subchannel control messages and RTP media packets are sent to the MBMS bearer management. + +The MBMS bearer management receives floor control message and RTP media packets from the media and floor control message distribution when floor control messages and RTP media packets are sent over an MBMS bearer. + +MBMS bearer management also generates MBMS subchannel control message. Floor control message, RTP media packets and MBMS subchannel control messages are sent to the GCS AS for distribution over an MBMS bearer. The GCS AS is outside the scope of the present specification. + +#### 4.2.3.3 The roles of the participating MCPTT function + +##### 4.2.3.3.1 For the floor control procedures + +When a floor control message or a media packet is received from an MCPTT client, in the MCPTT-4 and MCPTT-7 reference points respectively, the participating MCPTT function forwards it to the controlling MCPTT function over MCPTT-3 reference point or to the application and signalling plane. When a floor control message or a media packet is received from the controlling MCPTT function, over MCPTT-3 reference point or the application and signalling plane, for MCPTT clients which do not use an MBMS subchannel, the participating MCPTT function forwards the floor control message to the MCPTT client over the MCPTT-4 and MCPTT-7 reference points respectively. For MCPTT clients which use an MBMS subchannel, for floor control messages directed to all of these MCPTT clients and for media packets, the participating MCPTT function forwards a single floor control message or a single media packet using the MBMS subchannel over MCPTT-9 and MCPTT-8 reference points respectively. + +When MCPTT clients are listening to the MBMS subchannel multiple copies of the same media packet destined to each individual MCPTT client are sent by the controlling MCPTT function while the participating MCPTT function only forwards one single media packet over the MBMS bearer. Any optimizations for not sending the media packet from the controlling MCPTT function to all MCPTT clients are out of scope of the present document. + +When MCPTT clients are listening to the MBMS subchannel multiple copies of the same Floor Idle message and Floor Taken message destined to each individual MCPTT client are sent by the controlling MCPTT function while the participating MCPTT function only forwards one single Floor Idle or Floor Taken message over the MBMS bearer. Any optimizations for not sending the Floor Idle or Floor Taken message from the controlling MCPTT function to all MCPTT clients are out of scope of the present document. + +The participating MCPTT function specifications related to the floor control are specified in subclause 6.4 for unicast media and media plane control delivery and in subclause 10.3.3 for MBMS delivery. + +##### 4.2.3.3.2 For the call over pre-established session procedures + +For a pre-established session between an MCPTT client and the participating MCPTT function, when a call is initiated over this pre-established session, the participating MCPTT function informs the originating MCPTT client the acceptance or rejection decision of the controlling MCPTT function by sending Connect or Disconnect messages respectively over MCPTT-4 reference point. When a call initiation is accepted by the controlling server and informed to the participating MCPTT function, the participating MCPTT function informs the terminating MCPTT client which has a pre-established session the initiation of this call, using Connect message over MCPTT-4 reference point. + +When the controlling MCPTT function informs the participating MCPTT function that a call which is setup over a pre-established session is released (either over the MCPTT-3 reference point or from application and signalling plane), the participating MCPTT function informs the MCPTT client the release of this call using Disconnect message over MCPTT-4 reference point. By the end of the release of the call the pre-established session is reserved for possible future use. + +When an Acknowledgment message is received, over the MCPTT-4 reference point, as result of a message informing the MCPTT client for the initiation, the rejection or the release related to a call conducted over a pre-established session, the participating MCPTT function communicates the positive or negative acknowledgment information towards the controlling MCPTT function according to the procedures in 3GPP TS 24.379 [2] (either over MCPTT-3 reference point or from application and signalling plane). + +The participating MCPTT function specifications related to the call setup over pre-established session are in subclause 9.3. + +##### 4.2.3.3.3 For the use of MBMS bearer procedures + +In the initiation of a conversation, if the MBMS bearer management in the participating MCPTT function decides to use an MBMS subchannel for the media plane control messages and the media packets, the participating MCPTT function sends a Map Group To Bearer message over the MCPTT-9 reference point, for indicating the association information + +between the group identity of this call and the TMGI of the MBMS bearer and additional parameters necessary for the identification of this MBMS subchannel using the general purpose MBMS subchannel already associated for the transmission of this information. In the termination of a conversation the participating MCPTT function sends an Unmap Group To Bearer message for terminating the association between the MBMS subchannel in use for this conversation and the group identity. + +The participating MCPTT function specifications related to the declaration of the association between an MBMS bearer and related parameters and the MBMS subchannel for media and media plane control are specified in subclause 10.3.2 and subclause 10.3.4. + +#### 4.2.4 Non-controlling MCPTT function of an MCPTT group + +According to 3GPP TS 24.379 [2] subclause 5.3 the MCPTT server can act in a non-controlling MCPTT function of an MCPTT group role. In the present document the internal structure of the non-controlling MCPTT function of an MCPTT group is illustrated in figure 4.2.4-1. + +![A block diagram showing the internal structure of the non-controlling MCPTT function. It consists of three nested rectangular boxes. The outermost box contains two stacked boxes inside it. The top box contains a smaller rectangle on its left side. The bottom box is empty. Faint text labels are visible within the boxes, likely representing functional blocks like 'MCPTT server', 'MCPTT client', and 'Application'.](fc0735d325f0ebd9214171975c68a888_img.jpg) + +A block diagram showing the internal structure of the non-controlling MCPTT function. It consists of three nested rectangular boxes. The outermost box contains two stacked boxes inside it. The top box contains a smaller rectangle on its left side. The bottom box is empty. Faint text labels are visible within the boxes, likely representing functional blocks like 'MCPTT server', 'MCPTT client', and 'Application'. + +NOTE: The real internal structure of the MCPTT server is implementation specific but a possible internal structure is shown to illustrate the logic and the procedures. + +**Figure 4.2.4-1: Internal structure of the non-controlling MCPTT function** + +All entities in the non-controlling MCPTT function of an MCPTT group are assumed to have a direct communication interface to the application and signalling plane. The interface to the application and signaling plane carries information about SIP session initialisation and SIP session release, SDP content, etc. + +The floor participant interface receives and transmits the floor control messages from and to the MCPTT client via the participating MCPTT function or non-controlling MCPTT function. The procedures are controlled by a state machine described in subclause 6.5.5. One state machine is needed for each MCPTT client participating in an MCPTT call. A non-controlling MCPTT function is seen by the floor participant interface as an MCPTT client. + +The floor control server interface is distributing floor control message to and from the floor control server in the controlling MCPTT function or non-controlling MCPTT function. The floor control server interface procedures are described in subclause 6.5.4. One floor control server interface is needed per MCPTT call. + +The network media interface is receiving and sending media from and to the associated MCPTT client via the participating MCPTT function or non-controlling MCPTT function. The network media interface is out of scope of the present document. One network media interface is needed for each MCPTT client participating in an MCPTT call. A non-controlling MCPTT function is seen by the network media interface as an MCPTT client. + +The media distributor is controlled by the floor control server interface. The media distributor is out of scope of the present document. One media distributor is needed per MCPTT call. + +The internal interfaces are assumed to transport the following type of information. + +1. The interface between the network media interface and the floor participant interface: + - a. Indication that the network media interface has started to receive media packets from the associated MCPTT client and requests from the floor participant interface to forward received RTP packets towards the media distributor or to stop forward RTP media packets to the media distributor. + +NOTE: It is an implementation option whether an indication e.g. is sent for every received RTP media packet or only when the first packet is received. +2. The interface between the floor participant interface and the floor control server interface: + - a. Floor control messages to and from the associated floor participant. The floor control message to the floor control server interface are limited to floor control messages that can result in an action towards the floor control server. +3. The interface between the network media interface and the media distributor: + - a. RTP media packets to and from associated MCPTT clients. This interface is out of scope of the present document. +4. The interface between the floor control server interface and the media distributor: + - a. Requests to start or stop distributing media to participants in the MCPTT call. Indication that the media distributor has started to receive media packets from the network media interface associated with the MCPTT client with the permission to send media. + +## 4.3 The media plane control channel + +### 4.3.1 General + +The media plane control channel is used for transport of messages associated with the floor control protocol, the pre-established session call control protocol and the MBMS bearer management protocol, all specified in the present document. + +### 4.3.2 Control channel realization + +The media plane control channel is realized by sending RTCP APP packets on top of UDP/IP. RTCP APP packets are defined in IETF RFC 3550 [3]. The MCPTT specific coding of the RTCP APP packets is defined in clause 8 of the present document. + +### 4.3.3 Establishing a media plane control channel + +#### 4.3.3.1 General + +The MCPTT client and the MCPTT server use the SDP offer/answer mechanism in order to negotiate the establishment of the media plane control channel. The SDP offer/answer procedures for negotiating media plane control channel capabilities are specified in clause 14. The ABNF is defined in clause 12. + +The media description ("m=" line) associated with the media plane control channel shall have the values as described in table 4.3.3.1-1. + +**Table 4.3.3.1-1: Media plane control channel media description** + +| Media description element | Value | +|---------------------------|---------------| +| | "application" | +| | RTCP port | +| | "udp" | +| | "MCPTT" | + +The port used for RTCP messages associated with the media plane control channel shall be different than ports used for RTCP messages associated with other "m=" lines (e.g. RTP) in the SDP. + +NOTE 1: As RTCP is used to transport messages on the media plane control channel, the "m=" line port value indicates an RTCP port. This is different from cases where an "m=" line is associated with an RTP-based stream, and the "m=" line port value indicates an RTP port. + +NOTE 2: In case the media plane control channel uses a different IP address than other media described in the SDP, a media plane control channel specific "c=" line also needs to be associated with the "m=" line associated with the media plane control channel. + +The format of the optional SDP fmtp attribute, when associated with the media plane control channel, is described in clause 12. + +The example below shows an SDP media description for a media plane control channel. + +``` +m=application 20032 udp MCPTT +a=fmtp:MCPTT mc_queueing;mc_priority=5;mc_granted +``` + +## 5 Entities + +### 5.1 General + +This clause associates the functional entities with the MCPTT roles described in the stage 2 architecture document (see 3GPP TS 23.379 [5]). + +### 5.2 MCPTT client + +#### 5.2.1 Introduction + +To be compliant with the procedures in the present document, an MCPTT client shall: + +1. support the role of an MCPTT client as specified 3GPP TS 23.379 [5]; +2. support the on-network MCPTT client role as specified in 3GPP TS 24.379 [2]; +3. support the off-network MCPTT client role as specified in 3GPP TS 24.379 [2]; and +4. support media plane security as specified in clause 13. + +To be compliant with the on-network procedures in the present document, an MCPTT client shall: + +1. provide the role of a floor participant in on-network mode as specified in subclause 5.2.2; +2. provide the media mixer function as described in subclause 4.2.2 and support the related procedures in subclause 6.2; +3. when operating in systems that support MBMS functionality, provide the MBMS interface as described in subclause 4.2.2 and support the related MBMS subchannel control procedure as specified in subclause 10.3; +4. provide PTT button events towards the on-network floor participant as specified in subclause 6.2; +5. provide means (sound, display, etc.) for indications towards the MCPTT user as specified in subclause 6.2; +6. support negotiating media plane control channel media level attributes as specified in subclause 4.3; and +7. support call setup control over pre-established session as specified in subclause 9.2. + +To be compliant with the off-network procedures in the present document, an MCPTT client shall: + +1. provide the role of a floor participant in off-network mode as specified in subclause 5.2.3; +2. support the role of an off-network floor participant as specified in 3GPP TS 23.379 [5] and in the present specification; +3. provide the media mixer function as described in subclause 4.2.2 and support the related procedures as specified in clause 7; +4. provide PTT button events towards the off-network floor participant as specified in clause 7; and +5. provide means (sound, display, etc.) for indications towards the MCPTT user as specified in clause 7. + +## 5.2.2 Floor participant in on-network mode + +To be compliant with the on-network procedures in the present document, a floor participant in on-network mode shall: + +1. support the on-network floor control procedures as defined in 3GPP TS 23.379 [5]; +2. support acting as an on-network floor participant as specified in subclause 6.2; and +3. support the on-network mode floor control protocol elements as specified in the clause 8. + +A floor participant in on-network mode may: + +1. support queueing of floor requests as specified in subclause 6.2 and subclause 4.1.1.2. + +## 5.2.3 Floor participant in off-network mode + +To be compliant with the off-network procedures in the present document, a floor participant in off-network mode shall: + +1. support off-network floor control procedures as specified in 3GPP TS 23.379 [5]; +2. support acting as an off-network floor participant as specified in clause 7; +3. support acting as an off-network floor control server as specified in clause 7; and +4. support the off-network mode floor control protocol elements in clause 8. + +A floor participant in off-network mode may: + +1. support queueing of floor requests as specified in clause 7 and subclause 4.1.1.3. + +## 5.3 Controlling MCPTT function + +An MCPTT server providing the controlling MCPTT function shall: + +1. support the role of a controlling MCPTT function as specified in 3GPP TS 23.379 [5]; +2. support negotiating media plane control channel media level attributes as specified in subclause 4.3; +3. provide floor control arbitration logic with an interface to MCPTT clients as described in subclause 4.2.1 and support the related procedures as specified in subclause 6.3; +4. provided a network media interface as described in subclause 4.2.1 and support associated procedures as specified in subclause 6.3; +5. provide a media distributor with a floor control interface towards the MCPTT clients as described in subclause 4.2.1 and support associated procedures in subclause 6.3; +6. support the on-network mode floor control protocol elements as specified in clause 8; and +7. support media plane security as specified in clause 13. + +An MCPTT server providing the controlling MCPTT function may: + +1. provide a floor request queue as described in subclause 4.2.1 and support the related procedures as specified in subclause 6.3 and subclause 4.3. + +## 5.4 Participating MCPTT function + +An MCPTT server providing the participating MCPTT function shall: + +1. support the role of a participating MCPTT function as specified in 3GPP TS 23.379 [5]; +2. distribute floor control messages as described in subclause 6.3 and support associated procedures as specified in subclause 6.4; +3. support call setup control over a pre-established session as specified in subclause 9.3; +4. when operating in systems that support and employ MBMS functionality, act as a GCS AS as specified in 3GPP TS 29.468 [6] and execute the related MBMS subchannel control procedures as specified in subclause 10.2; and +5. support media plane security as specified in clause 13. + +## 5.5 Non-controlling MCPTT function + +An MCPTT server providing the non-controlling MCPTT function of an MCPTT group shall: + +1. support floor control involving groups from multiple MCPTT systems as specified in 3GPP TS 24.379 [2]; +2. provide a floor control interface towards the controlling MCPTT function as described in subclause 4.2.4 and support the related procedures as specified in subclause 6.5; +3. provide a media interface towards the controlling MCPTT function as described in subclause 4.2.4 and support the related procedure as specified in subclause 6.5; +4. provide a media distributor as described in subclause 4.2.4 and the related procedures as specified in subclause 6.5; and +5. support media plane security as specified in clause 13. + +## 6 On-network floor control + +### 6.1 General + +This clause provides: + +1. the floor participant procedures in subclause 6.2; +2. the floor control server procedures in subclause 6.3; +3. the participating MCPTT function floor control procedures in subclause 6.4; and +4. the non-controlling MCPTT function of an MCPTT group in subclause 6.5. + +If media plane security is required, the MCPTT client, the controlling MCPTT function, the participating MCPTT function and the non-controlling MCPTT function shall perform the additional procedures in clause 13. + +### 6.2 Floor participant procedures + +#### 6.2.1 Floor participant procedures at MCPTT session initialization + +Based on the negotiations during the call establishment specified in 3GPP TS 24.379 [2], a new instance of the 'Floor participant state transition diagram for basic operation', as specified in subclause 6.2.4, shall be created for this call. + +The SIP INVITE request sent by the application and signalling plane: + +1. shall be regarded an implicit floor request when an implicit floor request is negotiated; and +2. shall not be regarded as an implicit floor request in case of a rejoin to an already on-going group call. + +**NOTE:** The floor participant can negotiate the use of prioritization of the Floor Request message. In that case, the floor participant can request permission to send media at a priority level that is either the same as or lower than the highest priority that was permitted to the participant in the MCPTT call initialization. If a floor participant is authorized for pre-emptive priority in the MCPTT call it is good practise to always request permission to send RTP media packets at a priority level that is lower than pre-emptive priority unless the user explicitly requests to pre-empt the current RTP media packets' sender. In any case pre-emptive priority will have no effect for audio cut-in floor control. + +#### 6.2.2 Floor participant procedures at MCPTT call release + +The MCPTT call release (whether it is initiated by the floor participant or floor control server) is a two-step procedure. + +- Step 1 The floor participant stops sending floor control messages and the MCPTT client stops sending RTP media packets. +- Step 2 When the application and signalling plane has determined that the MCPTT call is released, the corresponding instance of the 'Floor participant state transition diagram for basic operation' as specified in subclause 6.2.4 is terminated and the floor participant releases all the used resources. + +The user plane can initiate the release step 1, but the application and signalling plane always initiates the release step 2. + +#### 6.2.3 Floor participant procedures at MCPTT call modification + +Adding or removing media streams during an MCPTT call does not influence the floor control procedures. + +## 6.2.4 Floor participant state transition diagram for basic operation + +### 6.2.4.1 General + +The floor participant shall behave according to the state diagram and the state transitions specified in this subclause. + +Figure 6.2.4.1-1 shows the state diagram for 'Floor participant state transition diagram for basic operation'. + +![Floor participant state transition diagram for basic operation. The diagram shows seven states: Any State, Releasing, Start-stop, Ut: has no permission, Ut: queued, Ut: pending request, and Ut: has permission. Transitions are triggered by various events and conditions, leading between these states.](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +``` + +stateDiagram-v2 + [*] --> AnyState + AnyState --> Releasing : R: Floor indicator + Releasing --> Start-stop : R: MCPTT call release - 1 + Start-stop --> Releasing : R: MCPTT call release - 2 + Start-stop --> Ut: has no permission : MCPTT call initiated, originating MCPTT user + Start-stop --> Ut: queued : MCPTT call initiated, originating MCPTT user + Ut: has no permission --> Start-stop : MCPTT call initiated, originating MCPTT user OR MCPTT call established, terminating MCPTT user + Ut: has no permission --> Ut: pending request : PTT pressed + Ut: has no permission --> Ut: queued : R: Floor Deny OR Timer T101 exp. Ntimes + Ut: pending request --> Ut: has no permission : R: Floor Deny OR Timer T101 exp. Ntimes + Ut: pending request --> Ut: queued : R: Floor Queue Position Info + Ut: pending request --> Ut: pending release : R: Floor Revoke OR PTT button released + Ut: pending request --> Ut: has permission : R: Floor Granted + Ut: pending request --> Ut: queued : R: Floor Taken OR R: Floor Release Multi Talker OR R: RTP Media OR Timer T101 expired + Ut: pending release --> Ut: has no permission : R: Floor Idle OR R: Floor Taken OR R: RTP Media OR R: Floor Ack OR Timer T100 exp. Ntimes + Ut: pending release --> Ut: pending request : R: Floor Revoke OR PTT button released + Ut: pending release --> Ut: has permission : R: Floor Granted OR R: Floor Release Multi Talker OR S: RTP Media OR R: Floor Idle OR R: Floor Taken OR R: RTP Media + Ut: pending release --> Releasing : R: Floor Revoke OR R: Floor Granted OR R: Floor Release Multi Talker OR Timer T100 expired + Ut: queued --> Start-stop : MCPTT call initiated, originating MCPTT user + Ut: queued --> Ut: pending request : R: Floor Deny OR R: Floor Idle OR Timer T132 expired + Ut: queued --> Ut: has permission : R: Floor Granted + Ut: queued --> Ut: pending request : R: Floor Taken OR R: Floor Granted OR R: Floor Release Multi Talker OR R: RTP Media OR R: Floor Queue Position Info OR S: Request floor queue position OR Timer T104 expired + Ut: has permission --> Ut: pending request : R: Floor Granted + Ut: has permission --> Ut: pending release : PTT button released OR Timer T104 exp. Ntimes + Ut: has permission --> Ut: queued : R: Floor Taken OR R: Floor Release Multi Talker OR R: RTP Media OR R: Floor Idle OR R: Floor Taken OR R: RTP Media + +``` + +Floor participant state transition diagram for basic operation. The diagram shows seven states: Any State, Releasing, Start-stop, Ut: has no permission, Ut: queued, Ut: pending request, and Ut: has permission. Transitions are triggered by various events and conditions, leading between these states. + +**Figure 6.2.4.1-1: Floor participant state transition diagram for basic operation.** + +State details are explained in the following subclauses. + +If an RTP media packet or a floor control message arrives in a state where there is no specific procedure specified for the RTP media packets or the received floor control message, the floor participant shall discard the floor control message or the RTP media packet and shall remain in the current state. + +NOTE 1: A badly formatted RTP packet or floor control message received in any state is ignored by the floor participant and does not cause any change of the current state. + +NOTE 2: The state transition diagram is the same for groups configured for audio cut-in floor control but the U: queued state should never be visited. + +#### 6.2.4.2 State: 'Start-stop' + +##### 6.2.4.2.1 General + +When a new instance of the 'Floor participant state transition diagram for basic operation' is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly, when the call is released the state machine shall return to the Start-Stop state. + +##### 6.2.4.2.2 MCPTT call initiated, originating MCPTT user + +When a call is initiated as described in 3GPP TS 24.379 [2], the floor participant: + +1. shall create an instance of the 'Floor participant state transition diagram for basic operation'; +2. if the originating floor participant receives a floor control message before it receives the SIP 200 (OK) response, shall store the floor control message; + +NOTE: The originating floor participant might receive a floor control message before the SIP 200 (OK) response when initiating, joining or rejoining a call because of processing delays of the SIP 200 (OK) response in the SIP core. + +3. if the established MCPTT call is a chat group call and the SIP INVITE request is not an implicit floor request, shall enter the 'U: has no permission' state; and +4. if for the established MCPTT call the SIP INVITE request is an implicit floor request: + - a. shall start timer T101 (Floor Request) and initialise counter C101 (Floor Request) to 1; + - b. shall enter the 'U: pending Request' state; and + - c. if the floor participant has received and stored a floor control message before the reception of the SIP 200 (OK) response, shall act as if the floor control message was received in the 'U: pending Request' state after entering the 'U: pending Request' state. + +When the floor participant is rejoining an ongoing MCPTT call as described in 3GPP TS 24.379 [2] the floor participant shall enter the 'U: has no permission' state. + +##### 6.2.4.2.3 MCPTT call established, terminating MCPTT user + +When an MCPTT call is established, the terminating floor participant: + +1. shall create an instance of a 'Floor participant state transition diagram for basic operation'; and +2. shall enter the 'U: has no permission' state. + +NOTE: From a floor participant perspective the MCPTT call is established when the application and signalling plane sends the SIP 200 (OK) response. + +#### 6.2.4.3 State: 'U: has no permission' + +##### 6.2.4.3.1 General + +The floor participant is in this state when the floor participant is not sending RTP media packets or is not waiting for a floor control message response. + +In this state RTP media packets and floor control messages can be received. + +#### 6.2.4.3.2 Receive Floor Idle message (R: Floor Idle) + +Upon receiving a Floor Idle message, the participant: + +1. if the first bit in the subtype of the Floor Idle message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '5' (Floor Idle); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. may provide floor idle notification to the user, if it has not already done so; +3. shall stop the optional timer T103 (End of RTP media), if it is running; and +4. shall remain in the 'U: has no permission' state. + +#### 6.2.4.3.3 Receive Floor Taken message (R: Floor Taken) + +Upon receiving the Floor Taken message, the floor participant: + +1. if the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '2' (Floor Taken); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. may provide a floor taken notification to the user; +3. if the Floor Indicator field is included and the B-bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; +4. if the Floor Indicator field is included and the I-bit is set to '1' (multi-talker), shall provide a notification to the user indicating the type of call and may provide a list of current talkers; +5. should start the optional timer T103 (End of RTP media) for the participant for which Floor Taken message was received; and +6. shall remain in the 'U: has no permission' state. + +#### 6.2.4.3.4 Receive RTP media packets (R: RTP media) + +Upon receiving RTP media packets, the floor participant: + +1. shall request the MCPTT client to start rendering the received RTP media packets; +2. should restart/start the optional timer T103 (End of RTP media); and +3. shall remain in the 'U: has no permission' state. + +NOTE: RTP media packets can be received from multiple sources when dual floor control is applied by the floor control server (see subclause 6.3.6) or when multi-talker control is applied by the floor control server. The MCPTT client can differentiate between the different sources using the SSRC in the received RTP media packets. How the media mixer in the MCPTT client mixes the different RTP media stream sources is out of scope of the present document. + +#### 6.2.4.3.5 Send Floor Request message (PTT button pressed) + +Upon receiving an indication from the user to request permission to send media, the floor participant: + +1. shall send the Floor Request message toward the floor control server; The Floor Request message: + +- a. if a different priority than the normal priority is required, shall include the Floor Priority field with the priority not higher than negotiated with the floor control server as specified in subclause 14.3.3; + - b. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; and + - c. shall include the Location field: + - i. if the current location of the talker is not available or is not to be reported according to the MCPTT user profile, then the location type is set to '0' (Not provided); or + - ii. if the current location of the talker is available and may be reported according to the MCPTT user profile, then the location type and location value are set as specified in table 8.2.3.21-3; +2. shall start timer T101 (Floor Request) and initialise counter C101 (Floor Request) to 1; and + 3. shall enter the 'U: pending Request' state. + +#### 6.2.4.3.6 Timer T103 (End of RTP media) expired + +On expiry of timer T103 (End of RTP media), the floor participant: + +1. may provide a floor idle notification to the user; and +2. shall remain in the 'U: has no permission' state. + +#### 6.2.4.3.7 Receive Floor Release Multi Talker message (R: Floor Release Multi Talker) + +Upon receiving the Floor Release Multi Talker message, the floor participant: + +1. shall provide a notification to the user indicating that a participant has released the floor in a multi-talker group; and +2. shall remain in the 'U: has no permission' state. + +#### 6.2.4.4 State: 'U: pending Request' + +##### 6.2.4.4.1 General + +The floor participant is in this state when the floor participant is waiting for response to a Floor Request message. + +In this state the floor participant can receive RTP media packets and floor control messages. + +Timer T101 (Floor Request) is running in this state. + +Timer T103 (End of RTP media) can be running in this state but there is no action in this state if the timer expires. The timer is started as a preparation for the state change that occurs once a response to the Floor Request message is received. + +##### 6.2.4.4.2 Receive Floor Granted message (R: Floor Granted) + +Upon receiving a Floor Granted message from the floor control server or a floor granted indication in a SIP 200 (OK) response in the application and signalling layer, the floor participant: + +1. if the first bit in the subtype of the Floor Granted message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '1' (Floor Granted); + - b. shall include the Source field set to '0' (the floor participant is the source); and + +- c. if the call is a remotely initiated ambient listening call and if the user's MCPTT profile allows sending the user's location, shall include the location field. If sending the user's location is not allowed, the location field may be included with the location type field set to '0' (Not provided); +- 2. if the call is not an ambient listening call, shall provide floor granted notification to the user, if not already done; +- NOTE: Providing the floor granted notification to the user prior to receiving the Floor Granted message is an implementation option. +- 3. if the Floor Indicator field is included and the B-bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; + - 4. if the G-bit in the Floor Indicator is set to '1' (Dual floor) shall store an indication that the participant is overriding without revoke; + - 5. shall stop the optional timer T103 (End of RTP media), if running; + - 6. shall stop timer T101 (Floor Request); and + - 7. shall enter the 'U: has permission' state. + +#### 6.2.4.4.3 Void + +#### 6.2.4.4.4 Receive Floor Deny message (R: Floor Deny) + +Upon receiving a Floor Deny message, the floor participant: + +- 1. if the first bit in the subtype of the Floor Deny message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '3' (Floor Deny); and + - b. shall include the Source field set to '0' (the floor participant is the source); +- 2. shall provide floor deny notification to the user; +- 3. may display the floor deny reason to the user using information in the Reject Cause field; +- 4. shall stop timer T101 (Floor Request); and +- 5. shall enter the 'U: has no permission' state. + +#### 6.2.4.4.5 Timer T101 (Floor request) expired + +On expiry of timer T101 (Floor Request) less than the upper limit of counter C101 (Floor Request) times the timer is allowed to expire, the floor participant: + +- 1. shall send a Floor Request message towards the floor control server. The Floor Request message: + - a. if a different priority than the normal priority is required, shall include the Floor Priority field with the priority not higher than negotiated with the floor control server as specified in subclause 14.3.3; + - b. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; and + - c. shall include the Location field: + - i. if the current location of the talker is not available or is not to be reported according to the MCPTT user profile, then the location type is set to '0' (Not provided); or + - ii. if the current location of the talker is available and may be reported according to the MCPTT user profile, then the location type and location value are set as specified in table 8.2.3.21-3; +- 2. shall restart timer T101 (Floor request) and increment counter C101 (Floor Request) by 1; and + +3. shall remain in the 'U: pending Request' state. + +#### 6.2.4.4.6 Timer T101 (Floor Request) expired N times + +When timer T101 (Floor Request) expires by the upper limit of counter C101 (Floor Request), the floor participant: + +1. shall provide a floor request timeout notification to the user; and +2. shall enter the 'U: has no permission' state. + +#### 6.2.4.4.7 Receive RTP media packets (R: RTP Media) + +Upon receiving RTP media packets, the floor participant: + +1. shall request the MCPTT client to start rendering the received RTP media packets; +2. should start the optional timer T103 (End of RTP media) for the floor participant from which RTP packets were received; and +3. shall remain in the 'U: pending Request' state. + +NOTE: RTP media packets can be received from multiple sources when dual floor control is applied by the floor control server (see subclause 6.3.6) or when multi-talker control is applied by the floor control server. The MCPTT client can differentiate between the different sources using the SSRC in the received RTP media packets. How the media mixer in the MCPTT client mixes the different RTP media stream sources is out of scope of the present document. + +#### 6.2.4.4.8 Send Floor Release message (PTT button released) + +Upon receiving an indication from the user to release permission to send media, the floor participant: + +1. shall send a Floor Release message towards the floor control server; + - a. if the session is a broadcast call and if the session was established as a normal call, shall include the Floor Indicator with the A-bit set to '1' (Normal call); +2. may include the first bit in the subtype of the Floor Release message set to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall start timer T100 (Floor Release) and initialise counter C100 (Floor Release) to 1; +4. shall stop timer T101 (Floor Request); and +5. shall enter the 'U: pending Release' state. + +#### 6.2.4.4.9 Receive Floor Queue Position Info message (R: Floor Queue Position Info) + +Upon receiving a Floor Queue Position Info message, the floor participant: + +1. if the first bit in the subtype of the Floor Queue Position Info message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '9' (Floor Queue Position Info); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. shall provide floor request queued response notification to the MCPTT user; +3. may provide the queue position and priority to the MCPTT user; and +4. shall enter the 'U: queued' state. + +NOTE: For groups configured for audio cut-in floor control the floor participant will never receive Floor Queue Position Info. + +#### 6.2.4.4.10 Receive Floor Release Multi Talker message (R: Floor Release Multi talker) + +Upon receiving the Floor Release Multi Talker message, the floor participant: + +1. shall provide a notification to the user indicating that a participant has released the floor in a multi-talker group; and +2. shall remain in the 'U: pending Request' state. + +#### 6.2.4.4.11 Receive Floor Taken message (R: Floor Taken) + +Upon receiving a Floor Taken message, the floor participant: + +1. if the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '2' (Floor Taken); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. may provide floor taken notification to the user; +3. if the Floor Indicator field is included and the B-bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; +4. if the Floor Indicator field is included and the I-bit is set to '1' (multi-talker), shall provide a notification to the user indicating the type of call and may provide a list of current talkers; +5. should start the optional timer T103 (End of RTP media) for each new talker as received in Floor Taken message; +6. if the identity of the floor participant is not included in the List of Granted Users, shall stop timer T100 (Floor Release); and +7. if: + - a. the floor participant has requested the floor with pre-emptive floor priority; and + - b. the Floor Taken message is received as a result of the floor being taken by another floor participant;then remain in the 'U: pending request state'; +otherwise, enter the 'U: has no permission' state. + +NOTE: When the floor participant has requested the floor with/without pre-emptive floor priority, there is a possibility that this floor participant can also receive a Floor Grant creating a dual floor or Multi-talker scenario (multi-talker configuration limit reached or within the limit). + +#### 6.2.4.5 State: 'U: has permission' + +##### 6.2.4.5.1 General + +The floor participant is in this state when the MCPTT client is permitted to send RTP media. In this state the floor participant can receive floor control messages. + +In this state, the floor participant can release permission to send RTP media at any time, even before sending any media. + +The MCPTT client could have already buffered media when it enters this state. + +NOTE: If the floor participant was queued, the floor participant requests a confirmation from the MCPTT user before start sending media. If confirmed, the media sending starts otherwise the permission to send media is released. + +#### 6.2.4.5.2 Send RTP media packets (RTP media) + +Upon receiving indication from the MCPTT client that encoded voice is received from the user or if encoded voice is already buffered the floor participant: + +1. shall request the MCPTT client to start forward encoded voice to the MCPTT server; and +2. shall remain in the 'U: has permission' state. + +#### 6.2.4.5.3 Send Floor Release message (PTT button released) + +Upon receiving an indication from the user to release the permission to send RTP media, the floor participant: + +1. shall send a Floor Release message towards the floor control server. The Floor Release message: + - a. may include the first bit in the subtype of the Floor Release message set to '1' (acknowledgement is required) as specified in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- b. if the session is a broadcast call and if the session was established as a normal call, shall include the Floor Indicator with the A-bit set to '1' (Normal call); and + - c. if the Floor Granted message included the G-bit set to '1' (Dual floor), shall include the Floor Indicator with the G-bit set to '1' (Dual floor); +2. shall remove the indication that the participant is overriding without revoke if this indication is stored; +3. shall remove the indication that the participant is overridden without revoke if this indication is stored; +4. shall start timer T100 (Floor Release) and initialize counter C100 (Floor Release) to 1; and +5. shall enter the 'U: pending Release' state. + +#### 6.2.4.5.4 Receive Floor Revoke message (R: Floor Revoke) + +Upon receiving a Floor Revoke message, the floor participant: + +1. shall inform the user that the permission to send RTP media is being revoked; +2. may give information to the user about the reason for revoking the permission to send media; +3. shall request the media mixer in the MCPTT client discard any remaining buffered RTP media packets and to stop forwarding encoded voice to the MCPTT server; +- 4 if the G-bit in the Floor Indicator is set to '1' (Dual floor): + - a. shall send a Floor Release message. In the Floor Release message: + - i. shall include the Floor Indicator with the G-bit set to '1' (Dual floor); and + - ii. may set the first bit in the subtype to '1' (Acknowledgment is required) as described in subclause 8.2.2; +- 5 if the G-bit in the Floor Indicator is set to '0' (not Dual floor): + - a. shall send a Floor Release message. In the Floor Release message: + - i. shall include the Floor Indicator with the G-bit set to '0' (not Dual floor); and + - ii. may set the first bit in the subtype to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +6. shall start timer T100 (Floor Release) and initialize counter C100 (Floor Release) to 1; and +7. shall enter the 'U: pending Release' state. + +#### 6.2.4.5.5 Receive Floor Granted message (R: Floor Granted) + +Upon receiving a Floor Granted message from the floor control server, the floor participant: + +1. if the first bit in the subtype of the Floor Granted message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '1' (Floor Granted); and + - b. shall include the Source field set to '0' (the floor participant is the source); and +2. shall remain in the 'U: has permission' state. + +#### 6.2.4.5.6 Receive RTP media packets (R: RTP Media) + +Upon receiving RTP media packets the floor participant: + +1. shall request the MCPTT client, based on configuration, either to continue rendering or stop the rendering and start storing the received RTP media packets if an indication is stored that the participant is overriding without revoke; + +NOTE: The configuration whether to continue rendering or to start storing the incoming RTP media is out of the scope of the present document. + +2. shall request the MCPTT client to render the received RTP media packets if an indication is stored that the participant is overridden without revoke; and +3. shall remain in the 'U: has permission' state. + +NOTE: RTP media packets can be received from multiple sources when dual floor control is applied by the floor control server (see subclause 6.3.6) or when multi-talker control is applied by the floor control server. The MCPTT client can differentiate between the different sources using the SSRC in the received RTP media packets. How the media mixer in the MCPTT client mixes the different RTP media stream sources is out of scope of the present document. + +#### 6.2.4.5.7 Receive Floor Idle message (R: Floor Idle) + +Upon receiving a Floor Idle message from the floor control server, the floor participant: + +1. if an indication that the participant is overriding without revoke is stored: + - a. if the first bit in the subtype of the Floor Idle message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - i. shall include the Message Type field set to '1' (Floor Idle); and + - ii. shall include the Source field set to '0' (the floor participant is the source); + - b. shall remove the indication that the participant is overriding without revoke; and + - c. shall remain in the 'U: has permission' state; and +2. if the G-bit in the Floor Indicator is set to '1' (Dual Floor) and an indication that the participant is overridden without revoke is stored: + - a. if the first bit in the subtype of the Floor Idle message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + +- i. shall include the Message Type field set to '1' (Floor Idle); and + - ii. shall include the Source field set to '0' (the floor participant is the source); +- b. shall remove the indication that the participant is overridden without revoke; and +- c. shall remain in the 'U: has permission' state. + +#### 6.2.4.5.8 Receive Floor Taken message (R: Floor Taken) + +Upon receiving a Floor Taken message: + +1. if the G-bit in the Floor Indicator set to '1' (Dual Floor) the floor participant: + - a. shall inform the user that the call is overridden without revoke; + - b. shall store an indication that the participant is overridden without revoke; and + - c. shall remain in the 'U: has permission' state; and +2. if the I-bit in the Floor Indicator set to '1' (Multi-talker) the floor participant: + - a. may provide a floor taken notification to the user; + - b. should start the optional timer T103 (End of RTP media) for the participant for which Floor Taken message was received; + - c. shall provide a notification to the user indicating the type of call and may provide a list of current talkers; and + - d. shall remain in the 'U: has permission' state. + +#### 6.2.4.5.9 Receive Floor Release Multi Talker message (R: Floor Release Multi talker) + +Upon receiving the Floor Release Multi Talker message, the floor participant: + +1. shall provide a notification to the user indicating that the participant has released the floor in a multi-talker group; and +2. shall remain in the 'U: has permission' state. + +#### 6.2.4.6 State: 'U: pending Release' + +##### 6.2.4.6.1 General + +The floor participant is in this state when the floor participant is waiting for response to a Floor Release message. + +In this state the floor participant can receive floor control messages and RTP media packets. + +Timer T100 (Floor Release) is running can be running in this state. + +##### 6.2.4.6.2 Timer T100 (Floor Release) expired + +On expiry of timer T100 (Floor Release) less than the configurable number of the upper limit of counter C100 (Floor Release) times, the floor participant: + +1. shall send a Floor Release message towards the floor control server; +2. may set the first bit in the subtype of the Floor Release message to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall restart timer T100 (Floor Release) and increment counter C100 (Floor Release) by 1; and +4. shall remain in state 'U: pending Release'. + +#### 6.2.4.6.3 Timer T100 (Floor release) expired N times + +When timer T100 (Floor Release) expires by the upper limit of counter C100 (Floor Release) times, the floor participant: + +1. shall enter the 'U: has no permission' state. + +#### 6.2.4.6.4 Receive Floor Idle message (R: Floor Idle) + +Upon receiving a Floor Idle message, the floor participant: + +1. if the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '5' (Floor Idle); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. may provide a floor idle notification to the MCPTT user; +3. if the Floor Indicator field is included and the B-bit set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; +4. shall stop timer T100 (Floor Release); +5. if the session is not a broadcast group call or if the A-bit in the Floor Indicator field is set to '1' (Normal call), shall enter the 'U: has no permission' state; and +6. if the session was initiated as a broadcast group call: + - a. shall indicate to the MCPTT client the media transmission is completed; and + - b shall enter the 'Releasing' state. + +#### 6.2.4.6.5 Receive Floor Taken message (R: Floor Taken) + +Upon receiving a Floor Taken message, the floor participant: + +1. if the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '2' (Floor Taken); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. may provide floor taken notification to the user; +3. if the Floor Indicator field is included and the B-bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; +4. if the Floor Indicator field is included and the I-bit is set to '1' (multi-talker), shall provide a notification to the user indicating the type of call and may provide a list of current talkers; +5. should start the optional timer T103 (End of RTP media) for each new talker as received in Floor Taken message; +6. if the identity of the floor participant is not included in the List of Granted Users, shall stop timer T100 (Floor Release); and +7. shall enter the 'U: has no permission' state. + +#### 6.2.4.6.6 Receive RTP media packets (R: RTP Media) + +Upon receiving an indication from the MCPTT client that RTP media packets are received, the floor participant: + +1. shall request the MCPTT client to start rendering the RTP media packets; +2. should start the optional timer T103 (End of RTP media) for the participant from which the RTP packets were received; +3. shall stop timer T100 (Floor Release); and +4. shall enter the 'U: has no permission' state. + +NOTE: RTP media packets can be received from multiple sources when dual floor control is applied by the floor control server (see subclause 6.3.6) or when multi-talker control is applied by the floor control server. The MCPTT client can differentiate between the different sources using the SSRC in the received RTP media packets. How the media mixer in the MCPTT client mixes the different RTP media stream sources is out of scope of the present document. + +#### 6.2.4.6.7 Receive Floor Revoke message (R: Floor Revoke) + +Upon receiving a Floor Revoke message, the floor participant: + +1. may give information to the user that permission to send RTP media is being revoked; +2. may inform the user of the reason contained in the Floor Revoke message; and +3. shall remain in the 'U: pending Release' state. + +#### 6.2.4.6.8 Receive Floor Granted message (R: Floor Granted) + +Upon receiving a Floor Granted message, the floor participant: + +1. if the first bit in the subtype of the Floor Granted message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '1' (Floor Granted); and + - b. shall include the Source field set to '0' (the floor participant is the source); and +2. shall remain in the 'U: pending Release' state. + +#### 6.2.4.6.9 Receive Floor Release Multi Talker message (R: Floor Release Multi talker) + +Upon receiving the Floor Release Multi Talker message, the floor participant: + +1. shall provide a notification to the user indicating that the participant has released the floor in a multi-talker group; and +2. if the message is due to the participant having released the floor shall enter 'U: has no permission', otherwise shall remain in the 'U: pending Release' state. + +### 6.2.4.7 In any state + +#### 6.2.4.7.1 General + +This subclause describes the actions to be taken in all states defined for the basic state diagram with the exception of the 'Start-stop' state and the 'Releasing' state. + +#### 6.2.4.7.2 Receive MCPTT call release – step 1 (R: MCPTT call release - 1) + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane when the MCPTT call is going to be released or when the floor participant is leaving the MCPTT call, the floor participant: + +1. shall stop sending floor control messages; +2. shall request the MCPTT client to stop sending RTP media packets; and +3. shall enter the 'Releasing' state. + +#### 6.2.4.7.3 Receive a Floor Control message with a Floor Indicator field (R: Floor Indicator) + +Upon receiving any Floor Control message containing the Floor Indicator field, the floor participant: + +1. may provide notifications based on the Floor Indicator field to the user. + +NOTE: Any change of state due to receipt of the Floor Indicator field is described in other parts of this specification. + +#### 6.2.4.8 State: 'Releasing' + +##### 6.2.4.8.1 General + +The floor participant is in this state while waiting for the application and signalling plane to finalize the disconnection of an MCPTT call. + +##### 6.2.4.8.2 Receive MCPTT call release – step 2 (R: MCPTT call release - 2) + +Upon receiving an MCPTT call release step 2 request from the application and signalling, the floor participant: + +1. shall release all resources including any running timers associated with the MCPTT call; and +2. shall enter the 'Start-stop' state and terminate the current instance of the 'Floor control state machine – basic'. + +#### 6.2.4.9 State: 'U: queued' + +##### 6.2.4.9.1 General + +The floor participant uses this state when a Floor Request message has been queued by the floor control server, and is awaiting the Floor Granted message. + +In this state, the MCPTT client can receive RTP Media packets and the floor participant can send and receive floor control messages. + +The timer T104 (Floor Queue Position Request) can be running in this state. + +##### 6.2.4.9.2 Receive RTP media packets (R: RTP media) + +Upon receiving an indication from the media mixer in the MCPTT client that the media mixer is receiving RTP media packets, the floor participant: + +1. shall request to the media mixer to start rendering received RTP media packets; +2. should restart timer T103 (End of RTP media) from which RTP packets were received; and +3. shall remain in the 'U: queued' state. + +NOTE: RTP media packets can be received from multiple sources when dual floor control is applied by the floor control server (see subclause 6.3.6) or when multi-talker control is applied by the floor control server. The MCPTT client can differentiate between the different sources using the SSRC in the received RTP media packets. How the media mixer in the MCPTT client mixes the different RTP media stream sources is out of scope of the present document. + +#### 6.2.4.9.3 Receive Floor Taken message (R: Floor Taken) + +Upon receiving a Floor Taken message, the floor participant: + +1. may provide a floor taken notification to the MCPTT user; +2. if the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '2' (Floor Taken); and + - b. shall include the Source field set to '0' (the floor participant is the source); +3. if the Floor Indicator field is included and the I-bit is set to '1' (multi-talker), shall provide a notification to the user indicating the type of call and may provide a list of current talkers; +4. should start the optional timer T103 (End of RTP media); and +5. shall remain in the 'U: queued' state. + +#### 6.2.4.9.4 Receive Floor Granted message (R: Floor Granted) + +Upon receiving a Floor Granted message, the floor participant: + +1. if the first bit in the subtype of the Floor Granted message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '1' (Floor Granted); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. shall provide a floor granted notification to the MCPTT user; +3. if the Floor Indicator field is included and the B-bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; +4. shall stop timer T104 (Floor Queue Position Request), if running; +5. shall start timer T132 (Queued granted user action); +6. shall stop the optional timer T103 (End of RTP media), if running, and if associated to a participant for which the previously received Floor Taken did not include a Floor Indicator field with the G-bit set to '1' (Dual floor); +7. shall indicate the user that the floor is granted; and +8. shall remain in the 'U: queued' state. + +#### 6.2.4.9.5 Receive Floor Deny message (R: Floor Deny) + +Upon receiving a Floor Deny message, the floor participant: + +1. if the first bit in the subtype of the Floor Deny message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '3' (Floor Deny); and + - b. shall include the Source field set to '0' (the floor participant is the source); + +2. shall provide floor deny notification to the MCPTT user; +3. may display the deny reason to the user using information in the Reject Cause field; +4. shall stop timer T104 (Floor Queue Position Request), if running; and +5. shall enter the 'U: has no permission' state. + +#### 6.2.4.9.6 Send Floor Release message (PTT button released) + +Upon receiving an indication from the MCPTT user to release the queued floor request, the floor participant: + +1. shall send a Floor Release message. The Floor Release message: + - a. may include the Floor Indicator field changing a broadcast group call to a normal call; +2. may set the first bit in the subtype of the Floor Release message to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall start timer T100 (Floor Release) and initialise counter C100 (Floor Release) to 1; +4. shall stop timer T104 (Floor Queue Position Request), if running; +5. shall stop timer T132 (queued request granted user action); and +6. shall enter the 'U: pending Release' state. + +#### 6.2.4.9.7 Receive Floor Queue Position Info message (R: Floor Queue Position Info) + +Upon receiving a Floor Queue Position Info message, the floor participant: + +1. if the first bit in the subtype of the Floor Queue Position Info message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '9' (Floor Queue Position Info); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. if the message indicates that the request has been queued or if a request for the queue position was sent, the floor participant: + - a. may provide the queue position and priority (if available) to the MCPTT user; +3. shall stop the timer T104 (Floor Queue Position Request), if running; and +4. shall remain in the 'U: queued' state. + +#### 6.2.4.9.8 Receive Floor Idle message (R: Floor Idle) + +Upon receiving a Floor Idle message, the floor participant: + +1. if the first bit in the subtype of the Floor Idle message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '5' (Floor Idle); and + - b. shall include the Source field set to '0' (the floor participant is the source); +2. may provide a floor idle notification to the MCPTT user; +3. shall stop timer T104 (Floor Queue Position Request), if running; and + +4. shall enter the 'U: has no permission' state. + +#### 6.2.4.9.9 Send Floor Queue Position Request message (S: Floor Queue Position Request) + +Upon receipt of an indication from the MCPTT client to request the queue position, the floor participant: + +1. shall send the Floor Queue Position Request message; +2. shall start timer T104 (Floor Queue Position Request) and initialize counter C104 (Floor Queue Position Request) to 1; and +3. remain in the 'U: queued' state. + +#### 6.2.4.9.10 Timer T104 (Floor Queue Position Request) expired + +On expiry of timer T104 (Floor Queue Position Request) less than the upper limit of C104 (Floor Queue Position Request) times, the floor participant: + +1. shall send a Floor Queue Position Request message towards the floor control server; +2. shall restart timer T104 (Floor Queue Position Request) and increment counter C104 (Floor Queue Position Request) by 1; and +3. shall remain in the 'U: queued' state. + +#### 6.2.4.9.11 Timer T104 (Floor Queue Position Request) expired N times + +When timer T104 (Floor Queue Position Request) expires by the upper limit of counter C104 (Floor Queue Position Request) times, the floor participant: + +1. shall provide a floor queued timeout to the MCPTT client; +2. may set the first bit in the subtype of the Floor Release message to '1' (Acknowledgment is required) as described in subclause 8.2.2; +3. shall send the Floor Release message; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +4. shall enter the 'U: pending Release' state. + +#### 6.2.4.9.12 User indication for accept of pending request + +Upon receiving an indication from the user that the user wants to send media and the timer T132 (Queued granted user action) is running, the floor participant: + +1. shall stop timer T132 (queued request granted user action); and +2. shall enter 'U: has permission' state. + +#### 6.2.4.9.13 Timer T132 (Queued granted user action) expires + +Upon expiry of timer T132 (Queued granted user action) the floor participant: + +1. shall send Floor Release message; +2. may indicate the user that the floor is no more available; +3. may set the first bit in the subtype of the Floor Release message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +4. shall enter 'U: has no permission' state. + +#### 6.2.4.9.14 Receive Floor Release Multi Talker message (R: Floor Release Multi talker) + +Upon receiving the Floor Release Multi Talker message, the floor participant: + +1. shall provide a notification to the user indicating that a participant has released the floor in a multi-talker group; and +2. shall remain in the 'U: queued' state. + +### 6.3 Floor control server procedures + +#### 6.3.1 General + +The floor control server arbitration logic in the floor control server shall support the procedures in subclauses 6.3.2 and 6.3.3 and shall behave according to the floor control server state transition diagram for 'general floor control operation' in subclause 6.3.4. + +The floor control interface towards the MCPTT client in the floor control server shall behave according to the floor control server state transition diagram for 'basic floor control operation towards the floor participant' as specified in subclause 6.3.5. + +#### 6.3.2 Controlling MCPTT function procedures at MCPTT call initialization + +##### 6.3.2.1 General + +The subclause 6.3.2.2 describes the initial procedures when a new SIP session is establishing a group session or a private session with floor control. + +The subclause 6.3.2.3 describes the procedures when a non-controlling MCPTT function switches from the non-controlling mode to the controlling mode. + +##### 6.3.2.2 Initial procedures + +When an MCPTT call is established a new instance of the floor control server state machine for 'general floor control operation' is created. + +For each MCPTT client added to the MCPTT call, a new instance of the floor control server state machine for 'basic floor control operation towards the floor participant' is added. + +If the optional "mc\_queueing" feature is supported and has been negotiated as specified in clause 14, the floor control server could queue the implicit floor control request for the media-floor control entity. + +The initial SIP INVITE request or SIP REFER request to establish an MCPTT chat group call or to rejoin an ongoing MCPTT call is not handled as an implicit floor control request message by the floor control server unless explicitly stated in the SIP INVITE request or in the SIP REFER request. + +The permission to send media to the inviting MCPTT client due to implicit floor control request is applicable to both confirmed indication and unconfirmed indication. + +When the first unconfirmed indication is received from the invited participating MCPTT function (see 3GPP TS 24.379 [2]) the floor control server optionally can give an early indication to send RTP media packets, to the inviting MCPTT client. + +If an early indication to send RTP media packets is given to the inviting MCPTT client, the floor participant is granted the permission to send media and the MCPTT server buffers RTP media packets received from the MCPTT client at + +least until the first invited MCPTT client accepts the invitation or until the RTP media packet buffer maximum limit is exceeded. + +If the MCPTT server does not support or does not allow media buffering then an early indication to send RTP media packets is not given to the inviting MCPTT client, the floor participant is granted the permission to send media when the first invited MCPTT client accepts the media. + +Before the floor control server sends the first floor control message in the MCPTT call, the floor control server has to assign itself a SSRC identifier to be included in media floor control messages and quality feedback messages if the MCPTT server is supporting that option. A suitable algorithm to generate the SSRC identifier is described in IETF RFC 3550 [3]. + +The floor participant and the floor control server can negotiate the maximum priority level that the floor participant is permitted to request. The floor control server can pre-empt the current sender based on the negotiated maximum priority level that the floor participant is permitted to request and the priority level included in the Floor Request message. + +**NOTE:** The maximum priority level that a floor participant can use is negotiated as specified in subclause 14.3.3 and is based on group configuration data retrieved by the controlling MCPTT function from the group management server as described in 3GPP TS 24.481 [12] and service configuration data retrieved by the controlling MCPTT function from the configuration management server as described in 3GPP TS 24.484 [13]. + +For groups configured for audio cut-in floor control, pre-empting of the current sender is not according to priority. Each new floor request results in the floor being revoked from the current talker and being granted to the new requesting talker. + +The floor participant and the floor control server can negotiate queueing of floor requests using the "mc\_queueing" fmtp attribute as described in clause 14. If queueing is supported and negotiated, the floor control server queues the floor control request if a Floor Request message is received when another floor participant has the floor and the priority of the current speaker is the same or higher. Queueing is not permitted for groups configured for audio cut-in floor control. + +### 6.3.2.3 Switching from a non-controlling MCPTT function mode to a controlling MCPTT function mode + +When the MCPTT server switches from the non-controlling MCPTT function mode to controlling MCPTT function mode a new instance of the floor control server state machine for 'general floor control operation' is created. + +For each MCPTT client in the MCPTT call a new instance of the floor control server state machine for 'basic floor control operation towards the floor participant' is added. + +Any floor request in the passive floor request queue is moved to the active floor request queue. + +**NOTE:** The passive floor request queue is a floor request queue used by the non-controlling MCPTT function as specified in subclause 6.5.4 to monitor floor request sent by floor participants controlled by the non-controlling MCPTT function. + +### 6.3.3 MCPTT floor control procedures at MCPTT call release + +When an MCPTT client leaves an MCPTT call and the MCPTT call remains ongoing with the other MCPTT clients, the floor control server follows a two-step procedure. + +- Step 1 The MCPTT server stops sending floor control messages and RTP media packets to the MCPTT client leaving the MCPTT call and, the MCPTT server discards floor control messages and RTP media packets received from the MCPTT client leaving the MCPTT call. +- Step 2 When the application and signalling plane has determined that the MCPTT call with this floor participant has been released, the corresponding instance of the floor control server state machine for 'basic floor control operation towards the floor participant' is released. + +When an MCPTT call is released, the floor control server follows a two-step procedure. + +- Step 1 The MCPTT server stops sending floor control messages and RTP media packets to all floor participants in the MCPTT call. +- Step 2 When the application and signalling plane has determined that the MCPTT call has been released, the corresponding instance of the floor control server state machine for 'general floor control operation' are also terminated, along with any 'basic floor control operation towards the floor participant' state machines for the floor participants of this call. + +The floor control server state machine for general floor control operation initiates the MCPTT call release depending on the release policy specified in 3GPP TS 24.379 [2]. + +## 6.3.4 Floor control server state transition diagram for general floor control operation + +### 6.3.4.1 General + +The floor control server arbitration logic in the floor control server shall behave according to the state diagram and state transitions specified in this subclause. + +Figure 6.3.4.1-1 shows the general floor control operation states (G states) and the state transition diagram. + +![Floor control server state transition diagram for 'general floor control operation'](2cf3896394a2342a2b46c504ab9a8830_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Start-stop : R: Merge + [*] --> Releasing : R: MCPPT call release - 1 + Releasing --> Start-stop : R: MCPPT call release - 2 + Start-stop --> G: Initialising : MCPPT call initialization + Start-stop --> G: Floor Idle : MCPPT call initialization + G: Initialising --> G: Floor Idle : R: final SIP responses + G: Initialising --> G: Floor Taken : R: final SIP responses + G: Floor Idle --> G: Floor Taken : T1 (end of RTP media) expired OR R: Floor Release OR R: client release + G: Floor Idle --> G: Pending Floor Revoke : T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release + G: Floor Idle --> G: Floor Taken : R: Floor Request OR Floor request queued not_empty OR R: Implicit floor request + G: Floor Idle --> G: Floor Taken : T2 (stop talking) expired OR R: pre-emptive Floor request OR R: Implicit floor request OR R: multi-talker Floor Request + G: Floor Idle --> G: Floor Taken : R: Floor Release OR T3 (Stop talking grace) expired + G: Floor Taken --> G: Floor Idle : R: RTP Media OR R: Floor Request OR T20 (Floor Granted) expired OR T20 (Floor Granted expired N times OR R: pre-emptive Floor Request OR T1 (end of RTP media) expired, OR R: Floor Release OR R: multi-talker Floor Request OR R: client release + G: Floor Taken --> G: Pending Floor Revoke : R: RTP Media OR T1 (end of RTP media) expired + +``` + +The diagram illustrates the state transitions for a floor control server. It begins with an 'Any state' leading to 'Start-stop' via 'R: Merge' and to 'Releasing' via 'R: MCPPT call release - 1'. 'Releasing' transitions to 'Start-stop' via 'R: MCPPT call release - 2'. From 'Start-stop', 'MCPPT call initialization' leads to 'G: Initialising' and 'G: Floor Idle'. 'G: Initialising' transitions to 'G: Floor Idle' and 'G: Floor Taken' via 'R: final SIP responses'. 'G: Floor Idle' transitions to 'G: Floor Taken' via 'T1 (end of RTP media) expired OR R: Floor Release OR R: client release', 'R: Floor Request OR Floor request queued not\_empty OR R: Implicit floor request', 'T2 (stop talking) expired OR R: pre-emptive Floor request OR R: Implicit floor request OR R: multi-talker Floor Request', and 'R: Floor Release OR T3 (Stop talking grace) expired'. 'G: Floor Idle' also transitions to 'G: Pending Floor Revoke' via 'T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release'. 'G: Floor Taken' transitions to 'G: Floor Idle' via 'R: RTP Media OR R: Floor Request OR T20 (Floor Granted) expired OR T20 (Floor Granted expired N times OR R: pre-emptive Floor Request OR T1 (end of RTP media) expired, OR R: Floor Release OR R: multi-talker Floor Request OR R: client release' and to 'G: Pending Floor Revoke' via 'R: RTP Media OR T1 (end of RTP media) expired'. 'G: Pending Floor Revoke' transitions to 'G: Floor Idle' via 'T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release' and to 'G: Floor Taken' via 'R: RTP Media OR T1 (end of RTP media) expired'. 'G: Floor Idle' also has self-loops for 'T7 (Floor Idle) expired OR R: Floor Request OR T4 (inactivity) expired OR R: Implicit Floor request' and 'T4 (inactivity) expired'. + +Floor control server state transition diagram for 'general floor control operation' + +**Figure 6.3.4.1-1: Floor control server state transition diagram for 'general floor control operation'** + +The floor control arbitration logic in the floor control server shall keep one instance of the 'general floor control operation' state machine per MCPPT call. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following subclauses the floor control arbitration logic in the floor control server: + +1. shall discard the floor control message; +2. shall request the media distributor in the MCPTT server to discard any received RTP media packet; and +3. shall remain in the current state. + +State details are explained in the following subclauses. + +### 6.3.4.2 State: 'Start-stop' + +#### 6.3.4.2.1 General + +When a new instance of the 'general floor control operation' state machine is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly when the call is released the state machine shall return to the 'Start-stop' state or the related MCPTT call is released. + +#### 6.3.4.2.2 MCPTT call initialization + +When an MCPTT call is initiated as specified in 3GPP TS 24.379 [2] and + +1. if a confirmed indication is required and at least one invited MCPTT client has accepted the invitation; +2. if a confirmed indication is not required; or +3. if the initialised MCPTT call is a temporary group session; + +NOTE: A MCPTT group call is a temporary group session when the element is present in the element as specified in 3GPP TS 24.481 [12]. + +then the floor control arbitration logic in the floor control server: + +1. shall create an instance of the 'general floor control operation' state machine; +2. shall wait for the 'basic floor control operation towards the floor participant' to be initialized before continuing the following steps; +3. when the 'basic floor control operation towards the floor participant' state machine is initialized and the initialised session is not a temporary group session: + - a. if the "mc\_granted" fmtp attribute is not negotiated as specified in clause 14 or this is an ambient listening call: + - i. if the floor control server is granting an implicit floor request at MCPTT call establishment, shall act as if a Floor Request message was received and perform the actions specified in subclause 6.3.4.3.3; or + - ii. if the floor control server is not granting an implicit floor request at MCPTT call establishment, shall enter the 'G: Floor Idle' state as specified in subclause 6.3.4.3.2; or + - b. if the "mc\_granted" fmtp attribute is negotiated as specified in clause 14 and this is not an ambient listening call, shall enter the 'G: Floor Taken' state as specified in subclause 6.3.4.4.2; and +4. if the 'basic floor control operation towards the floor participant' state machine is initialized and the initialised session is a temporary group session, shall enter the 'G: Initialising' state as specified in the subclause 6.3.4.8.1. + +### 6.3.4.3 State: 'G: Floor Idle' + +#### 6.3.4.3.1 General + +The floor control arbitration logic in the floor control server is in this state when no MCPTT user currently has permission to send media. + +Timer T4 (Inactivity) and timer T7 (Floor Idle) can be running when the floor control arbitration logic in the floor control server is in this state. + +#### 6.3.4.3.2 Enter the 'G: Floor Idle' state + +When entering this state from any state except the 'Start-stop' state and if no MCPTT client negotiated support of queueing floor requests as described in clause 14, and the state machine specified in subclause 6.3.6 does not exist, the floor control arbitration logic in the floor control server: + +1. if there is a Track Info field associated with the floor control server state transition diagram for 'general floor control operation' stored, shall remove the Track Info field from the storage; +2. if the active floor request queue is empty the floor control server: + - a. shall send Floor Idle message to all floor participants. The Floor Idle message: + - i. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + - b. shall start timer T7 (Floor Idle) and initialise counter C7 (Floor Idle) to 1; + - c. shall start timer T4 (Inactivity); and + - d. shall set the general state to the 'G: Floor Idle' state; and +3. if the active floor request queue is not empty the floor control server: + - a. shall select a queued floor request from the top of the active floor request queue; + - b. shall remove that queued floor request from the active floor request queue; + - c. if the queued floor request includes a Track Info field, shall store the Track Info field and associate it with the floor control server state transition diagram for 'general floor control operation'; and + - d. shall enter the 'G: Floor Taken' state as specified in the subclause 6.3.4.4.2 with respect to that floor participant. + +When entering this state from any state except the 'Start-stop' state and the state machine specified in subclause 6.3.6 exists, the floor control arbitration logic in the floor control server: + +1. if there is a Track Info field associated with the floor control server state transition diagram for 'general floor control operation' stored, shall remove the Track Info field from the storage; +2. shall send Floor Idle message to all floor participants which are configured to listen to the overridden participant. The Floor Idle message: + - a. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +3. shall send Floor Taken message to floor participants which are configured to listen only to the overridden participant. The Floor Taken message: + - a. if privacy is not requested, shall include the granted MCPTT user's (overriding participant) MCPTT ID in the Granted Party's Identity field; + - b. shall include a Message Sequence Number field with a value increased with 1; + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +- d. shall include the Location field: + - i. if the current location of the talker is not available or is not to be reported according to the MCPTT user profile, then the location type is set to '0' (Not provided); or + - ii. if the current location of the talker (overriding participant) is available and may be reported according to the MCPTT user profile, then the location type and location value are set as specified in table 8.2.3.21-3; +- 4. shall set the general state to the 'G: Floor Taken' state; and +- 5. shall send the termination instruction to the 'dual floor control operation' state machine. + +#### 6.3.4.3.3 Receive Floor Request message (R: Floor Request) + +Upon receiving a floor request message (from a floor participant that is permitted to make a floor request) the floor control arbitration logic in the floor control server: + +- 1. shall reject the request if one of the following conditions is fulfilled: + - a. if there is only one MCPTT client in the MCPTT call; and + - b. element is present in the element as specified 3GPP TS 24.481 [12] for the associated floor participant; +- 2. if the floor request is rejected the floor control server: + - a. shall send the Floor Deny message. The Floor Deny message: + - i. shall include in the Reject Cause field the value: + - A. cause #3 (Only one participant), if there is only one MCPTT client in the MCPTT call; or + - B. cause #5 (Receive only), if the element is present in the element as specified in 3GPP TS 24.481 [12] for the associated floor participant; + - ii. may include an additional text string explaining the reason for rejecting the floor request in the value of the Reject Cause field; and + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; + - b. shall remain in the 'G: Floor Idle' state; and +- 3. if the floor request is granted the floor control server: + - a. shall stop timer T4 (Inactivity); + - b. shall stop timer T7 (Floor Idle); + - c. shall store the SSRC of floor participant granted the permission to send media until the floor is released associated to that floor request; + - d. if a Track Info field is included in the Floor Request message, shall store the received Track Info field, and + - e. shall enter the 'G: Floor Taken' state as specified in the subclause 6.3.4.4.2. + +#### 6.3.4.3.4 Timer T7 (Floor Idle) expired + +On expiry of timer T7 (Floor Idle) the floor control arbitration logic in the floor control server: + +- 1. shall restart timer T7 (Floor Idle) and increment counter C7 (Floor Idle) by 1 if counter C7 (Floor Idle) has not reached its upper limit; +- 2. shall send a Floor Idle message to all floor participants in the MCPTT call if counter C7 (Floor Idle) has not reached its upper limit. The Floor Idle message: + +- a. shall include a Message Sequence Number field with a value increased with 1; and +- 3. shall remain in the 'G: Floor Idle' state. + +#### 6.3.4.3.5 Timer T4 (Inactivity) expired + +On expiry of timer T4 (Inactivity) the floor control arbitration logic in the floor control server based on a configurable service provider policy either: + +- 1. shall indicate to the application and signalling plane that timer T4 (Inactivity) has expired; +- 2. if the application and signalling planes initiates MCPTT call release, shall enter the 'Releasing' state; and +- 3. if the application and signalling planes do not initiate MCPTT call release: + - a. should restart the T4 (Inactivity) timer; and + - b. shall remain in the 'G: Floor Idle' state. + +#### 6.3.4.3.6 Receive an implicit floor request (R: Implicit floor request) + +Upon receiving an implicit floor request due to an upgrade to an emergency group call or due to an upgrade to imminent peril call, the floor control arbitration logic in the floor control server: + +- 1. shall reject the request if there is only one MCPTT client in the MCPTT call; +- 2. if the floor request is rejected the floor control server: + - a. shall send the Floor Deny message. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #3 (Only one participant); and + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - b. shall remain in the 'G: Floor Idle' state; and +- 3. if the floor request is granted the floor control server: + - a. shall stop the timer T4 (Inactivity); + - b. shall stop the timer T7 (Floor Idle); + - c. shall store the SSRC of floor participant granted the permission to send media until the floor is released associated to that floor request; and + - d. shall enter the 'G: Floor Taken' state as specified in the subclause 6.3.4.4.2. + +#### 6.3.4.4 State: 'G: Floor Taken' + +##### 6.3.4.4.1 General + +The floor control arbitration logic in the floor control server uses this state when it has permitted one or more of the MCPTT clients in the MCPTT call to send media. + +Timer T1 (End of RTP media) is running when the floor control server is in this state. If configured to support multi-talker floor control, one instance of timer T1 (End of RTP media) is running per talker that is granted the floor. + +Timer T2 (End talking) can be running when the floor control server is in this state. If configured to support multi-talker floor control, one instance of timer T20 (Floor Granted) is running per talker that is granted the floor. + +Timer T20 (Floor Granted) is running to guarantee reliable delivery of the Floor Granted message, if the granted floor request was queued. If configured to support multi-talker floor control, one instance of timer T20 (Floor Granted) is running per talker that is granted the floor. + +If configured to support multi-talker, then the floor control arbitration logic maintains a list of MCPTT IDs of the currently granted talkers. + +#### 6.3.4.4.2 Enter the 'G: Floor Taken' state + +When entering this state the floor control arbitration logic in the floor control server: + +1. shall send a Floor Granted message to the floor participant to which the floor is granted. The Floor Granted message: + - a. shall include the value of timer T2 (Stop talking) in the Duration field; + - b. shall include the granted priority in the Floor priority field; + - c. if a Track Info field associated with the floor control server state transition diagram for 'general floor control operation' is stored, shall include the stored Track Info field; + - d. if a group call is a broadcast group call, system call, emergency call, an imminent peril call or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - e. if the call is a remotely initiated ambient listening call, shall set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: If the call is an ambient listening call and the ambient listening call type is remote-initiated, then the floor participant to which the floor is granted is the terminating floor participant of the call. Otherwise the floor is granted to the participant which requested the floor. + +2. shall start timer T20 (Floor Granted) if the floor request was queued for the participant to which the floor is granted and initialise the counter C20 (Floor Granted) to 1; +3. shall send Floor Taken message to all other floor participants. The Floor Taken message: + - a. if the floor is currently granted only to one participant: + - i shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field, if privacy is not requested; + - ii. may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; and + - iii. shall include the Location field: + - A. if the current location of the talker is not available or is not to be reported according to the MCPTT user profile, then the location type is set to '0' (Not provided); or + - B. if the current location of the talker is available and may be reported according to the MCPTT user profile, then the location type and location value are set as specified in table 8.2.3.21-3; + - b. if multi-talker is supported and the floor is currently granted to multiple participants: + - i. shall include the Floor Indicator field with the I-bit set to '1' (Multi-talker); + - ii. shall include the list of granted users in the multi-talker group in List of Granted Users field, including a new granted talker; + - iii. shall include the list of SSRCs of granted floor participants; + - iv) may include the list of functional aliases of the granted floor participants in the List of Functional Aliases field; and + - v. shall include the List of Locations of granted floor participants; + +- c. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; + - d. if the session is a broadcast group call or an ambient listening call, shall include the Permission to Request the Floor field set to '0'; + - e. if the session is not a broadcast group call, may include the Permission to Request the Floor field set to '1'; and + - f. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +4. shall start timer T1 (End of RTP media) for the participant to which the floor is granted; + 5. shall set the general state to 'G: Floor Taken' state; and + 6. if configured to support multi-talker floor control the group is configured to shall add the MCPTT identity of the participant to which the floor is granted to the list of currently granted talkers. + +#### 6.3.4.4.3 Timer T1 (End of RTP media) expired + +On expiry of timer T1 (End of RTP media), the floor control arbitration logic in the floor control server: + +1. shall stop the timer T2 (Stop talking) for the participant to which the floor is granted; if running; +2. shall stop timer T20 (Granted re-send) for the participant to which the floor is granted, if running; +3. shall request the media distributor in the MCPTT server to stop distributing RTP media packets received from the participant for which T1 (End of RTP media) has expired (with the exception of RTP media packets already in the buffer (if RTP media buffering is ongoing)) to other MCPTT clients; +4. if mutli-talker floor control is not supported; shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; and +5. if multi-talker floor control is supported, + - a. shall send a Floor Release Multi Talker message to all participants other than the one releasing floor. The Floor Release Multi Talker message: + - i. shall include SSRC field set to the SSRC of the floor participant for which T1 expired; and + - ii. shall include the User ID set to the MCPTT ID of the floor participant for which T1 expired; and + - b. shall remove the participant for which timer T1 expired from the list of currently granted talkers, and: + - i. if the list of currently granted talkers is empty, shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; and + - ii. if the list of currently granted talkers is not empty shall stay in state the 'G: Floor Taken'. + +#### 6.3.4.4.4 Timer T2 (Stop talking) expired + +On expiry of timer T2 (Stop talking), the floor control arbitration logic in the floor control server: + +1. shall stop timer T1 (End of RTP media) for the participant for which timer T2 has expired; +2. shall include the Reject Cause field with the value set to #2 (Media burst too long) in the Floor Revoke message sent in subclause 6.3.4.5.2; and +3. shall enter the 'G: pending Floor Revoke' state as specified in the subclause 6.3.4.5.2. + +#### 6.3.4.4.5 Receive RTP media packets (R: RTP media) + +Upon receiving an indication from the media distributor in the MCPTT server that RTP media packets are received from the permitted MCPTT client, the floor control arbitration logic in the floor control server: + +1. if the session is not an ambient listening call, shall start timer T2 (Stop talking) for the participant from which the RTP packet has been received, if not running; + 2. shall restart timer T1 (End of RTP media) for the participant from which the RTP packet has been received; + 3. shall stop timer T20 (Floor Granted) for the participant from which the RTP packet has been received, if running; + 4. shall instruct the media distributor to forward the RTP media packets to MCPTT clients according to local policy; and +- NOTE: If dual floor control is ongoing as described in subclause 6.3.6, the list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. +5. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.6 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop forwarding RTP media packets received from the participant that sent the Floor Release message; +2. shall stop timer T2 (Stop talking) for the participant that sent the Floor Release message, if running; +3. shall stop timer T20 (Granted re-send) for the participant that sent the Floor Release message, if running; +4. if mutli-talker floor control is not supported shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; and +5. if multi-talker floor control is supported, then: + - a. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - i. shall include SSRC field set to the SSRC of the floor participant that has released the floor; and + - ii. shall include the User ID set to the MCPTT ID of the floor participant releasing the floor; + - b. shall remove the participant that sent the Floor Release message from the list of currently granted talkers; and + - c. if the list of currently granted talkers is empty, shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; or if the list of currently granted talkers is not empty shall stay in state the 'G: Floor Taken'. + +#### 6.3.4.4.7 Receive Floor Request message with pre-emptive priority (R: pre-emptive Floor Request) + +NOTE 1: This procedure is also invoked from the subclause 6.3.5.4.4. + +If the group is not configured to support multi-talker feature control, on receipt of a floor request message with effective priority indicating pre-emptive priority, and if the effective priority of the floor participant with permission to send media is not the pre-emptive priority, or if the group is configured for audio cut-in, the floor control arbitration logic in the floor control server: + +1. based on local policy, select one of the following options: + - a. revoke the current speaker; or + - b. allow media from both the current speaker and from the participant now requesting floor with a pre-emptive floor priority; + +NOTE 2: If the group is configured for audio cut-in, media is allowed only for the participant now requesting the floor. + +2. if revoking current speaker is selected: + - a. shall stop timer T1 (End of RTP media), if running; + - b. shall stop timer T20 (Floor Granted), if running; + - c. shall include a Reject Cause field with the value set to #4 (Media Burst pre-empted) in the Floor Revoke message sent in subclause 6.3.4.5.2; + - d. shall enter the 'G: pending Floor Revoke' state as specified in the subclause 6.3.4.5.2; + - e. shall insert the floor participant into the active floor request queue to the position in front of all queued requests, if not inserted yet or update the position of the floor participant in the active floor request queue to the position in front of all other queued requests, if already inserted; and + - f. shall send a Floor Queue Position Info message to the requesting floor participant, if negotiated support of queueing of floor requests as specified in clause 14. The Floor Queue Position Info message: + - i. include the queue position and floor priority in the Queue Info field; and + - ii. if the Floor Request message included a Track Info field, shall include the received Track Info field; and +3. if allow media from both the current speaker and from the participant now requesting floor with a pre-emptive priority is selected: + - a. shall perform the actions specified in the subclause 6.3.6.2.2 + +#### 6.3.4.4.7a Receive Floor Request message multi-talker (R: multi-talker Floor Request) + +On receipt of a floor request message and if the group is configured as multi-talker group the floor control arbitration logic in the floor control server: + +1. shall select one of the following options: + - a. if the maximum number of simultaneous talkers applicable for multi-talker control is reached and if the floor request message has effective priority indicating pre-emptive priority, determine from all participants having permission to send media, the one with the lowest priority and revoke the floor from the participant with the lowest priority; or + - b. if the maximum number of simultaneous talkers applicable for multi-talker control is not reached, allow media from both the current speaker(s) and from the participant now requesting floor; +2. if revoking is selected: + - a. shall stop timer T1 (End of RTP media) for the participant from which the floor is revoked, if running; + - b. shall stop timer T20 (Floor Granted) for the participant from which the floor is revoked, if running; + - c. shall include a Reject Cause field with the value set to #4 (Media Burst pre-empted) in the Floor Revoke message sent in subclause 6.3.4.5.2; + - d. shall enter the 'G: pending Floor Revoke' state as specified in the subclause 6.3.4.5.2; + - e. shall insert the floor participant into the active floor request queue to the position in front of all queued requests, if not inserted yet or update the position of the floor participant in the active floor request queue to the position in front of all other queued requests, if already inserted; + - f. shall send a Floor Queue Position Info message to the requesting floor participant, if negotiated support of queueing of floor requests as specified in clause 14. The Floor Queue Position Info message: + - i. shall include the queue position and floor priority in the Queue Info field; and + - ii. if the Floor Request message included a Track Info field, shall include the received Track Info field; and +3. if allow media from both the current speaker(s) and from the participant now requesting floor is selected: + +- a. shall send a Floor Granted message to the requesting floor participant. The Floor Granted message: + - i. shall include the value of the T2 (Stop talking) timer in the Duration field; + - ii. shall include the granted priority in the Floor priority field; + - iii. if a Track Info field associated with the floor control server state transition diagram for 'multite-talker floor control operation' is stored, shall include the stored Track Info field; + - iv. shall include the Floor Indicator field with the I-bit set to '1' (Multi-talker); and + - v. shall include the SSRC of granted floor participant; +- b. shall add the MCPTT ID of the user to which the floor is granted to the list of currently granted talkers; +- c. shall send a Floor Taken message to any non-controlling MCPTT functions involved and to floor participants controlled by the controlling MCPTT function that will listen to the RTP media from the multi-talker MCPTT client according to local policy. The Floor Taken message: + - i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the associated functional alias in the Functional Alias field, if privacy is not requested; + - ii. shall include a Message Sequence Number field with a value increased with 1; + - iii. shall include the Floor Indicator field with the I-bit set to '1' (Multi-talker); + - iv. shall include the list of granted users in the multi-talker group in List of Granted Users field; + - v. shall include the list of SSRCs of granted floor participants; and + - vi) may include the list of functional aliases of the granted floor participants in the List of Functional Aliases field. +- d. shall start the T1 (End of RTP media) timer for the participant to which the floor is granted; +- e. shall start timer T20 (Floor Granted) for the participant to which the floor is granted, if the floor request was queued and initialise the counter C20 (Floor Granted) to 1; +- f. shall stay in the state to 'G: Floor Taken' state. + +#### 6.3.4.4.8 Receive Floor request message from permitted floor participant (R: Floor Request) + +Upon receiving a floor request message from the floor participant that has been granted permission to send media, the floor control arbitration logic in the floor control server: + +1. shall send a Floor Granted message to the previously granted floor participant. The Floor Granted message: + - a. shall include the value of timer T2 (Stop talking) running for this floor participant in the Duration field; + - b. shall include the granted priority in the Floor priority field; and + - c. if the Floor Request message included a Track Info field, shall include the received Track Info field; and +2. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.9 Timer T20 (Floor Granted) expired + +On expiry of timer T20 (Floor Granted), the floor control arbitration logic in the floor control server: + +1. shall send a Floor Granted message to the granted floor participant if counter C20 (Floor Granted) has not reached its upper limit: The Floor Granted message: + - a. shall include the value of timer T2 (Stop talking) in the Duration field; + +- b. shall include the granted priority in the Floor priority field; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. shall start timer T20 (Floor Granted) and increment counter C20 (Floor Granted) by 1 if counter C20 (Floor Granted) has not reached its upper limit; and + 3. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.10 Timer T20 (Floor Granted) expired N times + +When timer T20 (Floor Granted) expires and counter C20 (Floor Granted) reaches its upper limit, the floor control arbitration logic in the floor control server: + +1. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.11 Permitted MCPTT client release (R: client release) + +If the floor control server receives an indication from the floor control interface towards the MCPTT client that the MCPTT client has started to disconnect from the MCPTT call, the floor control arbitration logic in the floor control server: + +1. if multi-talker floor control is not supported shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; and +2. if multi-talker floor control is supported, + - a. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - i. shall include SSRC field set to the SSRC of the floor participant that has released the floor; and + - ii. shall include the User ID set to the MCPTT ID of the floor participant releasing the floor; and + - b. shall remove the participant which is disconnecting from the floor from the list of currently granted talkers, and: + - i. if the list of currently granted talkers is empty, shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; and + - ii. if the list of currently granted talkers is not empty shall stay in state the 'G: Floor Taken'. + +#### 6.3.4.4.12 Receive an implicit floor request (R: Implicit floor request) + +Upon receiving an implicit floor request due to an upgrade to an emergency group call or due to an upgrade to imminent peril call, the floor control arbitration logic in the floor control server: + +1. shall stop timer T1 (End of RTP media), if running; +2. shall stop timer T20 (Floor Granted), if running; +3. shall set the Reject Cause field in the Floor Revoke message to #4 (Media Burst pre-empted); +4. shall enter the 'G: pending Floor Revoke' state as specified in the subclause 6.3.4.5.2; +5. shall insert the floor participant into the active floor request queue to the position in front of all queued requests, if not inserted yet or update the position of the floor participant in the active floor request queue to the position in front of all other queued requests, if already inserted; and +6. shall send a Floor Queue Position Info message to the requesting floor participant, if negotiated support of queueing floor requests as specified in clause 14. The Floor Queue Position Request message: + - a. shall include the queue position and floor priority in the Queue Info field; and + +- b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications. + +#### 6.3.4.5 State: 'G: pending Floor Revoke' + +##### 6.3.4.5.1 General + +The floor control arbitration logic in the floor control server uses this state after having sent a Floor Revoke message to the permitted floor participant. + +Timer T3 (Stop talking grace) is running when the floor control arbitration logic in the floor control server is in this state. If the group is configured for audio cut-in floor control the value of timer T3 shall be considered to be zero. + +In this state the MCPTT server forwards RTP media packets to the other floor participants in the MCPTT call. + +##### 6.3.4.5.2 Enter the 'G: pending Floor Revoke' state + +When entering this state the floor control arbitration logic in the floor control server: + +1. shall send the Floor Revoke message to the permitted floor participant. The Floor Revoke message: + - a. shall include the reason for sending the Floor Revoke message in the value in the Reject Cause field; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, group is configured as multi-talker group, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. shall start timer T3 (Stop talking grace) for which a Floor Revoke message has been sent; and +3. shall set the general state to 'G: pending Floor Revoke'. + +##### 6.3.4.5.3 Receive RTP media packets (R: RTP media) + +Upon receiving an indication from the media distributor in the MCPTT server that RTP media packets are received from the permitted floor participant the floor control server: + +1. shall restart timer T1 (End of RTP media); + +NOTE 1: If the upper limit for timer T3 (Stop talking grace) is less than the upper limit of timer T1 (End of RTP media) then timer T1 (End of RTP media) will not expire. + +2. shall instruct the media distributor to forward the RTP media packets to MCPTT clients according to local policy; and + +NOTE 2: If dual floor control is ongoing as described in subclause 6.3.6, the list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +3. shall remain in the 'G: pending Floor Revoke' state. + +##### 6.3.4.5.4 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message for which a Floor Revoke message has been sent, the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop forwarding RTP media packets; +2. shall stop timer T1 (End of RTP media) , if running; +3. shall stop timer T3 (Stop talking grace); +4. if multi-talker floor control is supported, shall remove the participant from the list of currently granted talkers; + +5. if multi-talker floor control is supported, then: + - a. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - i shall include SSRC field set to the SSRC of the floor participant that has released the floor; and + - ii shall include the User ID set to the MCPTT ID of the floor participant releasing the floor; and +6. if the active floor request queue is not empty the floor control server shall enter the 'G: Idle' state as specified in the subclause 6.3.4.3.2; +7. if the active floor request queue is empty and the list of currently granted talkers is empty the floor control server shall enter the 'G: Idle' state as specified in the subclause 6.3.4.3.2; and +8. if the active floor request queue is empty and the list of currently granted talkers is not empty the floor control server shall enter the 'G: Floor Taken' state as specified in subclause 6.3.4.4.2. + +If configured to support multi-talker floor control and upon receiving a Floor Release message for which a Floor Revoke message has not been sent, the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop forwarding related RTP media packets; +2. shall stop timer T2 (Stop talking) for the participant that sent the Floor Release message, if running; +3. shall stop timer T20 (Granted re-send) for the participant that sent the Floor Release message, if running; +4. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - a shall include SSRC field set to the SSRC of the floor participant that has released the floor; and + - b shall include the User ID set to the MCPTT ID of the floor participant releasing the floor; +5. shall remove the participant that has sent the Floor Release message from the list of currently granted talkers and: + - a. if the list of currently granted talkers is empty, shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2; and + - b. if the list of currently granted talkers is not empty shall stay in state the 'G: Floor Taken'. + +#### 6.3.4.5.5 Timer T3 (Stop talking grace) expired + +On expiry of timer T3 (Stop talking grace) for which a Floor Revoke message has been sent, the floor control arbitration logic in the floor control server: + +1. shall indicate to the interface towards the MCPTT client that the general state machine is now 'G: Floor Idle'; +2. if multi-talker control is supported, shall remove the participant from the list of currently granted talkers; +3. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - a shall include SSRC field set to the SSRC of the floor participant for which T3 expired; and + - b shall include the User ID set to the MCPTT ID for which T3 expired; +4. if the active floor request queue is not empty the floor control server shall enter the 'G: Idle' state as specified in the subclause 6.3.4.3.2; +5. if the active floor request queue is empty and the list of currently granted talkers is empty the floor control server shall enter the 'G: Idle' state as specified in the subclause 6.3.4.3.2; and +6. if the active floor request queue is empty and the list of currently granted talkers is not empty the floor control server shall enter the 'G: Floor Taken' state as specified in subclause 6.3.4.4.2. + +#### 6.3.4.5.6 Timer T1 (End of RTP media) expired + +On expiry of timer T1 (End of RTP media) assigned to the participant for which a Floor Revoke message has been sent, the floor control arbitration logic in the floor control server: + +1. shall stop timer T3 (Stop talking grace); +2. if multi-talker feature is supported, + - a shall remove the participant from the list of currently granted talkers; + - b. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - i shall include SSRC field set to the SSRC of the floor participant for which timer T1 (End of RTP media) expired; and + - ii shall include the User ID set to the MCPTT ID of the floor participant for which timer T1 (End of RTP media) expired; and +3. if the floor is now empty; shall enter the 'G: Floor Idle' state as specified in the subclause 6.3.4.3.2. + +On expiry of timer T1 (End of RTP media) assigned to a participant different than the participant for which a Floor Revoke message has been sent, the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop forwarding related RTP media packets; +2. shall stop timer T2 (Stop talking) for the participant for which timer T1 (End of RTP media) expired, if running; +3. shall stop timer T20 (Granted re-send) for the participant, if running; +4. shall send a Floor Release Multi Talker message. The Floor Release Multi Talker message: + - a shall include SSRC field set to the SSRC of the floor participant for which T1 expired; and + - b shall include the User ID set to the MCPTT ID for which T1 expired; +5. if multi-talker floor control is supported, shall remove the participant for which timer T1 (End of RTP media) expired from the list of currently granted talkers and shall stay in the 'G: pending Floor Revoke' state. + +#### 6.3.4.6 In any state + +##### 6.3.4.6.1 General + +This subclause describes the actions to be taken in all states defined for the general state diagram with the exception of the 'Start-stop' state. + +##### 6.3.4.6.2 Receive MCPTT call release - 1 + +This subclause is used by the floor control arbitration logic in the floor control server when an MCPTT call is released. + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop sending RTP media packets MCPTT clients; and +2. shall enter the 'Releasing' state. + +##### 6.3.4.6.3 Receive an instruction to merge group calls (R: Merge) + +Upon receiving an instruction from the application and signalling plane to merge the ongoing group call with other group calls, the floor control server: + +1. shall perform the actions in subclause 6.5.2.3; + +2. shall enter the 'Start-stop' state. + +#### 6.3.4.7 State: 'Releasing' + +##### 6.3.4.7.1 General + +The floor control arbitration logic in the floor control server uses this state while waiting for the application and signalling plane to finalize the disconnection of an MCPTT call. + +##### 6.3.4.7.2 Receive MCPTT call release - 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control arbitration logic in the floor control server: + +1. shall release all resources reserved in the media plane including the instances used for the 'Floor control server state transition diagram for general floor control operation', and 'Floor control server state transition diagram for basic floor control operation towards the floor participant' state machines and any running timers associated with the state machines; and +2. shall enter the 'Start-stop' state. + +#### 6.3.4.8 State: 'G: Floor Initialising' + +##### 6.3.4.8.1 General + +The floor control arbitration logic in the floor control server uses this state while waiting for all invited constituent MCPTT groups to reply with a final SIP response. + +There are no timers running in this state. The floor control arbitration logic is relying on SIP timers in the signalling and application plane. + +##### 6.3.4.8.2 Enter the 'G: Initialising' state + +When entering this state the floor control arbitration logic: + +1. shall set the general state to the 'G: Initialising' state. + +##### 6.3.4.8.3 Receiving a floor request from a constituent MCPTT group (R: mcptt-floor-request) + +Upon receiving an indication from the application and signalling plane that a floor request is received from one of the invited constituent MCPTT groups in an application/vnd.3gpp.mcptt-floor-request+xml MIME body, the floor control arbitration logic: + +1. shall cache the application/vnd.3gpp.mcptt-floor-request+xml MIME body; and +2. remain in the 'G: Initialising' state. + +##### 6.3.4.8.4 All final SIP responses received (R: final SIP responses) + +Upon receiving an indication from the application and signalling plane that all invited constituent MCPTT groups have sent a final SIP response, the floor control arbitration logic: + +1. if at least one application/vnd.3gpp.mcptt-floor-request+xml MIME body exists with the element set to "general": + - a. shall select the floor participant with the highest priority as described in subclause 4.1.1.4: + - i. among the cached application/vnd.3gpp.mcptt-floor-request+xml MIME bodies with the element set to "general"; and + +- ii. the floor participant initialising the temporary group session as described in subclause 4.1.1.4, if the floor participant initialising the temporary group session negotiated implicit floor request as specified in clause 14; +- b. shall send a Floor Revoke message to all floor participants in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "general" that are not granted the permission to send media. The Floor Revoke message: + - i. shall include the value set to '4' (Media Burst pre-empted) in the Reject Cause field; + - ii. shall include information taken from the element in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "general" in the Track Info field; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- c. if the floor participant selected to be granted the floor is one of invited constituent MCPTT groups: + - i. shall convert the element to a format of a Track Info field and cache the Track Info field associated with the floor control server state transition diagram for 'general floor control operation'; and + - ii. shall enter the 'G: Taken' state as specified in the subclause 6.3.4.4.2 using the selected floor participant as the requesting floor participant; +- 2. if at least one application/vnd.3gpp.mcptt-floor-request+xml MIME body exists with the element set to "dual": + - a. shall select the floor participant with the highest priority as described in subclause 4.1.1.4 among the cached application/vnd.3gpp.mcptt-floor-request+xml MIME bodies with the element set to "dual"; and + - b. shall send a Floor Revoke message to all floor participants in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "dual" that are not granted the permission to send media. The Floor Revoke message: + - i. shall include the value set to '4' (Media Burst pre-empted) in the Reject Cause field; + - ii. shall include information taken from the element in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "general" in the Track Info field; + - iii. shall include the Floor Indicator with the G-bit set to '1' (Dual floor); + - iv. shall convert the element to a format of a Track Info field and cache the Track Info field associated with floor control server state transition diagram for 'dual floor control operation'; and + - v. shall enter the 'D: Floor Taken' state as specified in the subclause 6.3.6.3.2 using the selected floor participant as the requesting floor participant; and +- 3. if no cached application/vnd.3gpp.mcptt-floor-request+xml MIME with the element set to "general" body exists: + - a. if an implicit floor request is negotiated as described in clause 14 when the temporary group session was established, shall enter the 'G: Taken' state as specified in the subclause 6.3.4.4.2; and + - b. if an implicit floor request is not negotiated as described in clause 14 when the temporary group session was established, shall enter the 'G: Idle' state as specified in the subclause 6.3.4.3.2. + +## 6.3.5 Floor control server state transition diagram for basic floor control operation towards the floor participant + +### 6.3.5.1 General + +The floor control interface towards the MCPTT client in the floor control server shall behave according to the state diagram and state transitions specified in this subclause. + +Figure 6.3.5.1-1 shows the states and state transitions for an associated floor participant in the floor control server. + +![Floor control server state transition diagram for basic floor control operation towards the floor participant. The diagram shows states: Any state, Start-stop state, Releasing, U: not permitted and initiating, U: permitted, U: pending Floor Revoke, U: not permitted and Floor Idle, U: not permitted but sends media, and U: not permitted and Floor Taken. Transitions are triggered by events like SIP Session initiated, Floor Request, Floor Release, Floor Granted, Floor Idle, Floor Taken, or RTP media.](347010b7ac06d3ae97927fde0f784d7c_img.jpg) + +``` + +stateDiagram-v2 + AnyState: Any state + StartStop: Start-stop state + Releasing: Releasing + NotPermittedInitiating: U: not permitted and initiating + Permitted: U: permitted + PendingRevoke: U: pending Floor Revoke + NotPermittedIdle: U: not permitted and Floor Idle + NotPermittedMedia: U: not permitted but sends media + NotPermittedTaken: U: not permitted and Floor Taken + + AnyState --> StartStop : R: Merge + AnyState --> Releasing : R: MCPTT session release - 1 + Releasing --> StartStop : R: MCPTT session release - 2 + StartStop --> NotPermittedInitiating : SIP Session initiated + NotPermittedInitiating --> Permitted : S: Floor Granted + NotPermittedInitiating --> NotPermittedIdle : R: Floor Request OR +R: Floor Release OR +S: Floor Release +Multi Talker + NotPermittedInitiating --> NotPermittedTaken : [SIP session initiated AND +implicit floor request] + Permitted --> NotPermittedIdle : S: Floor Idle + Permitted --> Permitted : R: Floor Request +OR +R: RTP media OR +R: Floor Release OR +S: Floor Release +Multi Talker + Permitted --> PendingRevoke : S: Floor Revoke + Permitted --> NotPermittedTaken : S: Floor Taken + PendingRevoke --> Permitted : R: Floor Request OR +S: Floor Granted + PendingRevoke --> NotPermittedIdle : S: Floor Idle + PendingRevoke --> NotPermittedTaken : S: Floor Taken + PendingRevoke --> Permitted : T8 (Floor Revoke) expired OR +R: RTP media OR +R: Floor Release OR +S: Floor Release Multi Talker + NotPermittedIdle --> Permitted : S: Floor Idle + NotPermittedIdle --> NotPermittedIdle : Floor Request OR +Floor Release OR +R: Media OR +S: Floor Deny OR +R: Implicit floor request OR +S: Floor Idle + NotPermittedIdle --> NotPermittedMedia : R: RTP media + NotPermittedIdle --> NotPermittedTaken : S: Floor Taken + NotPermittedMedia --> NotPermittedIdle : R: Floor Release + NotPermittedMedia --> NotPermittedTaken : R: Floor Release + NotPermittedMedia --> NotPermittedIdle : R: RTP media + NotPermittedMedia --> NotPermittedTaken : R: RTP media + NotPermittedMedia --> PendingRevoke : T8 (Floor Revoke) expired OR +S: Floor Release Multi Talker OR +S: Floor Taken + NotPermittedTaken --> Permitted : S: Floor Taken + NotPermittedTaken --> NotPermittedIdle : S: Floor Idle + NotPermittedTaken --> NotPermittedMedia : R: Floor Release + NotPermittedTaken --> NotPermittedTaken : Floor Request OR +R: Floor Release OR +R: Floor Queue Position Request OR +R: Implicit floor request OR +S: Floor Release Multi Talker OR +S: Floor Taken + +``` + +Floor control server state transition diagram for basic floor control operation towards the floor participant. The diagram shows states: Any state, Start-stop state, Releasing, U: not permitted and initiating, U: permitted, U: pending Floor Revoke, U: not permitted and Floor Idle, U: not permitted but sends media, and U: not permitted and Floor Taken. Transitions are triggered by events like SIP Session initiated, Floor Request, Floor Release, Floor Granted, Floor Idle, Floor Taken, or RTP media. + +**Figure 6.3.5.1-1: Floor control server state transition diagram for basic floor control operation towards the floor participant** + +The floor control interface towards the MCPTT client in the floor control server shall create one instance of the 'basic floor control operations' state machine towards the MCPTT client for every floor participant served by the floor control server as follows: + +1. For pre-arranged group call in case of an originating MCPTT call, the 'basic floor control operation towards the floor participant' state machine shall be created when the MCPTT server sends the SIP 200 (OK) response towards the originating MCPTT client. +2. For pre-arranged group call in case of a terminating MCPTT call, the 'basic floor control operation towards the floor participant' state machine shall be created when the floor control server receives the SIP 200 (OK) response. +3. For chat group call the 'basic floor control operation state machine towards the floor participant' shall be created when the MCPTT server sends the SIP 200 (OK) response to the received initial SIP INVITE request. + +The floor participant associated to the 'basic floor control operation towards the floor participant' state machine is here referred to as the "associated floor participant". + +The external inputs to the state machine are: + +1. directives coming from the floor control arbitration logic; +2. floor messages sent by the floor participants; +3. media; and +4. in certain cases, SIP messages used for call handling. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following subclauses, the floor control interface towards the MCPTT client in the floor control server: + +1. shall discard the floor control message; +2. shall request the network media interface in the MCPTT server to discard any received RTP media packet; and +3. shall remain in the current state. + +State details are explained in the following subclauses. + +### 6.3.5.2 State: 'Start-stop' + +#### 6.3.5.2.1 General + +When a new instance of the 'basic floor control operations towards the floor participant' state machine is created, before any floor control related input is applied, the state machine is in the 'Start-stop' state. Similarly, when the call is released the state machine shall return to the Start-Stop state. + +An association between the floor control server and a floor participant in the MCPTT client is created, when the state machine is created; and + +1. in case of an originating MCPTT call, when the MCPTT server sends the SIP 200 (OK) response to the originating MCPTT client; and +2. in case of a terminating MCPTT call, when the floor control server receives the SIP 200 (OK) response sent from the terminating MCPTT client. + +#### 6.3.5.2.2 SIP Session initiated + +When a SIP Session is established and if: + +1. the session is not a temporary group call session; +2. the session is a temporary group call session and the associated floor participant is an invited MCPTT client (i.e. not a constituent MCPTT group); or + +3. the session is not an ambient listening call; + +then: + +NOTE 1: A MCPTT group call is a temporary group session when the element is present in the element as specified in 3GPP TS 24.481 [12]. + +1. if an MCPTT client initiates an MCPTT call with an implicit floor request, and the MCPTT call does not exist yet, the floor control interface towards the MCPTT client in the floor control server: + +- a. shall initialize a general state machine as specified in subclause 6.3.4.2.2; and + +NOTE 2: In the subclause 6.3.4.2.2 the 'general floor control operation' state machine will continue with the initialization of the 'general floor control operation' state machine. + +- b. shall enter the state 'U: permitted' as specified in the subclause 6.3.5.5.2; + +2. if the associated MCPTT client rejoins an ongoing MCPTT call without an implicit floor request or initiates or joins a chat group call without an implicit floor request or attempts to initiate an already existing MCPTT call without an implicit floor request, and + +- a. if an MCPTT call already exists but no MCPTT client has the permission to send a media, the floor control interface towards the MCPTT client in the floor control server: + +- i. should send a Floor Idle message to the MCPTT client. The Floor Idle message: + +- A. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + +- B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +- ii. shall enter the state 'U: not permitted and Floor Idle' as specified in the subclause 6.3.5.5.2; + +- b. if an MCPTT call is initiated, the floor control interface towards the MCPTT client in the floor control server: + +- i. shall enter the state 'U: not permitted and Floor Idle' as specified in the subclause 6.3.5.5.2; and + +- ii. shall initialize a general state machine as specified in subclause 6.3.4.2.2; and + +NOTE 3: In the subclause 6.3.4.2.2 the general state machine will continue with the initialization of the general state machine. + +- c. if another MCPTT client has the permission to send a media, the floor control interface towards the MCPTT client in the floor control server: + +- i. should send a Floor Taken message to the MCPTT client. The Floor Taken message: + +- A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + +- B. shall include a Message Sequence Number field with a value increased with 1; + +- C. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + +- D. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; and + +- E. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications + +- ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; + +3. if the associated floor participant attempts to initiate an already existing MCPTT call with an implicit floor request, and + - a. if no MCPTT client has the permission to send media, the floor control interface towards the MCPTT client in the floor control server: + - i. shall process the implicit floor request as if a Floor Request message was received as specified in subclause 6.3.4.3.3; and + - ii. shall enter the state 'U: permitted' as specified in the subclause 6.3.5.5.2; + - b. if the MCPTT client negotiated support of queueing floor requests as specified in clause 14 and if another MCPTT client has the permission to send media, the floor control interface towards the MCPTT client in the floor control server: + - i. shall set the priority level to the negotiated maximum priority level that the MCPTT client is permitted to request, except for pre-emptive priority, when high priority is used; +- NOTE 4: The maximum floor priority the floor participant is permitted to request is negotiated in the "mc\_priority" fmtp attribute as specified in clause 14. +- NOTE 5: The initial implicit floor request will not result in pre-emption when an MCPTT client is joining an ongoing MCPTT call. If the MCPTT client wants to pre-empt the current MCPTT client that is sending media, an explicit floor request with pre-emptive floor priority is required. +- ii. shall insert the MCPTT client into the active floor request queue to the position immediately following all queued floor requests with the same floor priority; + - iii. shall send a Floor Queue Position Info message to the MCPTT client. The Floor Queue Position Info message: + - A shall include the queue position and floor priority in the *Queue Info* field; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the *Floor Indicator* field with appropriate indications; + - iv. should send a Floor Queue Position Info message with the updated status to the MCPTT clients in the active floor request queue which negotiated queueing of floor requests as specified in clause 14, which have requested the queue status, whose queue position has been changed since the previous Floor Queue Position Info message and which is not the joining MCPTT client. The Floor Queue Position Info message: + - A shall include the queue position and floor priority in the *Queue Info* field; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the *Floor Indicator* field with appropriate indications; and + - v. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; and +- c. if the MCPTT client did not negotiate queueing of floor requests and if another MCPTT client has the permission to send media, the floor control interface towards the MCPTT client in the floor control server: + - i. shall send a Floor Taken message to the MCPTT client. The Floor Taken message: + - A. shall include the granted MCPTT user's MCPTT ID in the *Granted Party's Identity* field and may include the functional alias of the granted MCPTT user in the *Functional Alias* field, if privacy is not requested; + - B. shall include a *Message Sequence Number* field with a *Message Sequence Number* value increased with 1; + - C. if the session is a broadcast group call, shall include the *Permission to Request the floor* field set to '0'; + - D. if the session is not a broadcast group call, may include the *Permission to Request the floor* field set to '1'; and + +- E. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; and +4. if the MCPTT client is invited to the MCPTT call and +- a. if another MCPTT client has permission to send a media, the floor control interface towards the MCPTT client in the floor control server: + - i. should send a Floor Taken message to the MCPTT client. The Floor Taken message: + - A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + - B. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; + - C. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - D. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; and + - E. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; and + - b. if no other MCPTT client has the permission to send a media; the floor control interface towards the MCPTT client in the floor control server: + - i. should send a Floor Idle message to the MCPTT client. The Floor Idle message: + - A. shall include a Message Sequence Number field with a value increased with 1; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2. + +When a SIP Session is established and if the session is a temporary group call session and, + +- 1. if the associated floor participant is a constituent MCPTT group; or +- 2. if the associated floor participant is the initiator of the temporary group session; + +then the floor control interface towards the MCPTT client: + +- 1. shall initialize a general state machine as specified in subclause 6.3.4.2.2, if not already initiated; and +- 2. shall enter the 'U: not permitted and initiating' state as specified in subclause 6.3.5.10.2. + +When a SIP Session is established and if the session is an ambient listening call session then the floor control interface towards the MCPTT client: + +- 1. if the floor is granted to the associated floor participant + - a. shall forward the "Floor Granted" message to the associated floor participant; and + - b. shall enter the state 'U: permitted' as specified in the subclause 6.3.5.5.2; and +- 2. if the floor is not granted to the associated floor participant + - a. shall forward the "Floor Taken" message to the associated floor participant; and + +- b. shall enter the state 'U: not permitted Floor Taken' as specified in the subclause 6.3.5.4.2. + +### 6.3.5.3 State: 'U: not permitted and Floor Idle' + +#### 6.3.5.3.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state when the associated floor participant is not permitted to send media. + +#### 6.3.5.3.2 Enter state 'U: not permitted and Floor Idle' + +When entering this state the floor control interface towards the MCPTT client in the floor control server: + +1. if a Track Info field is stored, shall remove the Track Info field from the storage; and +2. shall set the state for the associated floor participant to 'U: not permitted and Floor Idle'. + +#### 6.3.5.3.3 Send Floor Taken message (S: Floor Taken) + +When a Floor Taken message is received from the floor control server arbitration logic, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Taken message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in subclause 8.2.2, and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2. + +#### 6.3.5.3.4 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. if the session is not a broadcast group call or if the session is a broadcast group call and the associated floor participant is the initiator of the broadcast group call, shall forward the Floor Request message to the floor control server arbitration logic; + +NOTE 1: The Floor Request message can contain a Floor Indicator field indicating that the floor request is an attempt to upgrade a group call to a broadcast group call. If the floor control arbitration logic accepts the floor request, the ongoing group call will be upgraded accordingly by the Floor Granted message and, for other participants, by the Floor Taken message. + +NOTE 2: Initiating a broadcast group call is done in the application and signalling plane using SIP. Initiating or upgrading a call to an emergency call or an imminent peril call is done in the application and signalling plane using SIP. + +2. if the session is a broadcast group call and the associated floor participant is not the initiator of the broadcast group call, shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #5 (Receive only); + - b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - c. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 3: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.5 Send Floor Grant message (S: Floor Grant) + +When a Floor Granted message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Granted messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the state 'U: permitted' as specified in subclause 6.3.5.5.2. + +#### 6.3.5.3.6 Send Floor Deny message (S: Floor Deny) + +When a Floor Deny message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Deny messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.7 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. shall send a Floor Idle message to the associated floor participant. The Floor Idle message: + - a. shall include a Message Sequence Number field with a value increased with 1; + - b. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + +3. if a Track Info field is included in the Floor Release message, shall use the topmost value and the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; +4. if a no Track Info field is included in the Floor Release message, shall use the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; +5. if the floor participant has a floor request in the queue, shall remove the queued floor request from the queue; and +6. shall remain in the state 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.8 Receive RTP media packets (R: media) + +Upon receiving an indication from the network media interface that RTP media packets are received with payload from the associated floor participant and if Floor Release message was received in the previous 'U: permitted' state, the floor control interface towards the MCPTT client in the floor control server: + +NOTE: Reception of unauthorized RTP media packets can only happen if the associated floor participant is in an MCPTT client. If the associated floor participant is a floor control server interface in a non-controlling MCPTT function of an MCPTT group, the unauthorized RTP media packets are handled in the non-controlling MCPTT function. + +1. shall request the network media interface in the MCPTT server to not forward the received RTP media packets to the media distributor in the MCPTT server; +2. shall send a Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the value set to #3 (No permission to send a Media Burst); and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall enter the 'U: not permitted but sends media' state as specified in the subclause 6.3.5.7.2. + +#### 6.3.5.3.9 Receive an implicit floor request (R: Implicit floor request) + +When an ongoing session is upgraded to an emergency group call and when the application and signalling plane indicates that a subsequent SDP offer included the "mc\_implicit\_request" fmtp attribute as described in clause 14, the floor control interface towards the MCPTT client in the floor control server: + +1. shall indicate to the floor control server arbitration logic that an implicit floor request is received due to an upgrade to an emergency group call; and +2. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.10 Send Floor Idle message (S: Floor Idle) + +When receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Idle message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Idle' state. + +### 6.3.5.4 State 'U: not permitted and Floor Taken' + +#### 6.3.5.4.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state when another MCPTT client (i.e. not the associated floor participant) has been given permission to send media. + +In this state RTP media packets received from the media distributor in the MCPTT server are forwarded to the associated floor participant by the network media interface in the MCPTT server. + +#### 6.3.5.4.2 Enter state 'U: not permitted and Floor Taken' + +When entering this state the floor control server: + +1. if a Track Info field is stored, shall remove the Track Info field from the storage; and +2. shall set the state to 'U: not permitted and Floor Taken'. + +#### 6.3.5.4.3 Send Floor Idle message (S: Floor Idle) + +When receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Idle message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. if an indication is stored that the participant is listening to media from two sources, i.e. dual floor control is applied, + - a. shall remain in the 'U: not permitted and Floor Taken' state; and + - b. shall remove the indication that a participant is listening to media from two sources; and +4. if an indication for dual floor control is not stored, shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2. + +#### 6.3.5.4.4 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message from the associated floor participant, if the group is configured for audio cut-in floor control, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Request message to the floor control server arbitration logic; and +2. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Request message from the associated floor participant, if the group is configured for multi-talker floor control, if the number of granted floor participants is below the configured maximum; and the MCPTT ID of the associated floor participants is in the list of allowed configured multi-talkers, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Request message to the floor control server arbitration logic; and +2. shall remain in the 'U: not permitted and Floor Taken' state. + +If the group is not configured for multi-talker floor control, upon receiving a Floor Request message, without a Floor Indicator field or with the Floor Indicator field included where the D-bit (Emergency call) and the E-bit (Imminent peril call) are set to '0', from the associated floor participant, and if the MCPTT client did not negotiate queueing of floor + +requests or did not include a priority in the "mc\_priority" fmp attribute as specified in clause 14, the floor control interface towards the MCPTT client in the floor control server: + +1. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - c. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 1: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Request message from the associated floor participant and the session is a broadcast group call or an ambient listening call, the floor control interface towards the MCPTT client in the floor control server: + +1. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #5 (Receive only); + - b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Request message from the associated floor participant and if the MCPTT client negotiated support of queueing of floor requests or included a floor priority in the "mc\_priority" or both as described in specified in clause 14 and according to local policy, the floor control interface towards the MCPTT client in the floor control server: + +NOTE 3: In case the group is configured for multi-talker floor control, then the following steps are only carried out in case the maximum number of allowed talkers is reached. + +1. shall determine the effective priority level as described in subclause 4.1.1.4 by using the following parameters: + - a. the floor priority shall be: + - i. the lower of the floor priority included in Floor Request message and the negotiated maximum floor priority that the MCPTT client is permitted to request, if the MCPTT client negotiated floor priority "mc\_priority" and floor priority is included in the Floor Request message; + - ii. the receive only floor priority, if the MCPTT client negotiated floor priority in the "mc\_priority" fmp attribute and if the negotiated maximum floor priority that the MCPTT client is permitted to request is "receive only"; + +- iii. the default priority, if the MCPTT client negotiated floor priority in the "mc\_priority" fmtp attribute, if the negotiated maximum floor priority that the MCPTT client is permitted to request is not receive only and if the floor priority is not included in the Floor Request message; and + - iv. the default priority, if the MCPTT client did not negotiate floor priority in the "mc\_priority" fmtp attribute; and + - b. the type of the call shall be + - i. if the Floor Indicator field is included in the message and the D-bit (Emergency call bit) is set to '1', determined to be an emergency call; + - ii. if the Floor Indicator field is included in the message and the E-bit (Imminent peril call) is set to '1', determined to be an imminent peril call; and + - iii. if the Floor Indicator field is not included in the message or the Floor Indicator field is included and neither the D-bit (Emergency call bit) nor the E-bit (Imminent peril call) is set to '1', determined to be a normal call; +2. if the effective priority is "receive only", the floor control interface towards the MCPTT client in the floor control server: +- a. shall send a Floor Deny message to the floor participant. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #5 (Receive only) ; + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iv. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state; +3. if +- a. a Track Info field is included in the Floor Request message, shall use the topmost value and the SSRC in the received Floor Request message to check if the floor participant has a queued floor request; or + - b. a Track Info field is not included in the Floor Request message, shall use the SSRC in the received Floor Request message to check if the floor participant has a queued floor request; +4. if the floor participant already has a queued floor request with the same effective priority level, the floor control interface towards the MCPTT client in the floor control server: +- a. shall send a Floor Queue Position Info message to the requesting MCPTT client, if the MCPTT client negotiated support of queueing of floor requests as specified in clause 14. The Floor Queue Position Info message: + - i. shall include the queue position and floor priority in the Queue Info field; + - ii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state +5. if the effective priority level is pre-emptive and there are no other pre-emptive requests in the active floor request queue and the effective priority level of the current MCPTT client with permission to send a media is not the pre-emptive priority, the floor control interface towards the MCPTT client in the floor control server: + +- a. shall forward the Floor Request message to the floor control server arbitration logic indicating that a Floor Request message with pre-emptive priority is received; and +- b. shall remain in the 'U: not permitted and Floor Taken' state + +NOTE 4: The Floor control server arbitration logic initiates revoking the permission to send media towards the current MCPTT client with the permission to send media as specified in the subclause 6.3.4.4.7; + +- 6. if the MCPTT client did not negotiate support of queueing of floor requests as specified in clause 14, the effective priority level is pre-emptive and either other pre-emptive request is queued or the effective priority level of the current MCPTT client with permission to send a media is the pre-emptive priority, the floor control interface towards the MCPTT client in the floor control server: + - a. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iv. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state; +- 7. if the MCPTT client did not negotiate "queueing" and the effective priority level is not pre-emptive, the floor control interface towards the MCPTT client in the floor control server: + - a. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iv. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state; and +- 8. if the MCPTT client negotiated support of queueing of floor requests as specified in clause 14 and the effective priority level is not pre-emptive, the floor control interface towards the MCPTT client in the floor control server: + - a. shall insert the MCPTT client into the active floor request queue, if not inserted yet, or update the position of the MCPTT client in the active floor request queue, if already inserted, to the position immediately following all queued requests at the same effective priority level; + - b. the floor control server shall send a Floor Queue Position Info message to the floor participant. The Floor Queue Position Info message: + - i. shall include the queue position and floor priority in the Queue Info field; + - ii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + - c. shall remain in the 'U: not permitted and Floor Taken' state; and + +- d. may set the first bit in the subtype of the Floor Queue Position message to '1' (Acknowledgment is required) as described in subclause 8.2.2. + +NOTE 5: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +#### 6.3.5.4.5 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant and if the MCPTT client did not negotiate support of queueing of floor requests or included a floor priority in the "mc\_priority" fmtp attribute as specified in clause 14, the floor control interface towards the MCPTT client in the floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. shall send a Floor Taken message to the associated floor participant. The Floor Taken message: + - a. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + - b. shall include a Message Sequence Number field with a value increased with 1; + - c. shall include the Permission to Request the floor field set to '0', if the floor participants are not allowed to request the floor; + - d. if the Floor Release message included a Track Info field, shall include the received Track Info field; + - e. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 1: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- f. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Release message from the associated floor participant and if the MCPTT client negotiated support of queueing of floor requests as specified in clause 14, the floor control interface towards the MCPTT client in the floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if + - a. a Track Info field is included in the Floor Release message, shall use the topmost value and the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; or + - b. if a Track Info field is not included in the Floor Release message, shall use the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; +3. shall remove the MCPTT client from the active floor request queue, if the MCPTT client was in the active floor request queue; + +4. shall send a Floor Taken message to the associated floor participant. The Floor Taken message: + - a. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + - b. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - c. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; + - d. if a Track Info field is included in the Floor Release message, shall include the received Track Info field; + - e. shall include a Message Sequence Number field with a value increased with 1; and + - f. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +5. may set the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +6. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.6 Receive RTP media packets (R: media) + +Upon receiving an indication from the network media interface in the MCPTT server that RTP media packets with payload are received from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +NOTE: Reception of unauthorized RTP media packets can only happen if the associated floor participant is in an MCPTT client. If the associated floor participant is a floor control server interface in a non-controlling MCPTT function of an MCPTT group, the unauthorized RTP media packets are handled in the non-controlling MCPTT function. + +1. shall request the network media interface to not forward the RTP media packets to the media distributor in the MCPTT server; +2. shall send a Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the Reject Cause value set to #3 (No permission to send a Media Burst); and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall enter the 'U: not permitted but sends media' state as specified in the subclause 6.3.5.7.2. + +#### 6.3.5.4.7 Send Floor Queue Position Info message (R: Floor Queue Position Request) + +Upon receiving a Floor Queue Position Request message from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. shall send the Floor Queue Position Info message. The Floor Queue Position Info message: + - a. shall include the queue position and floor priority in the Queue Info field; + - b. if a Track Info field is included in the Floor Queue Position Info message, shall include the received Track Info field; + - c. may include the first bit in the subtype of the Floor Queue Position Info message set to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.8 Receive an implicit floor request (R: Implicit floor request) + +When an ongoing session is upgraded to an emergency group call and when the application and signalling plane indicates that a subsequent SDP offer included the "mc\_implicit\_request" fmtp attribute as specified in clause 14, the floor control interface towards the MCPTT client in the floor control server: + +1. shall indicate to the floor control server arbitration logic that an implicit floor request is received due to an upgrade to an emergency group call; and +2. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.9 Send Floor Granted message (S: Floor Granted) + +When a Floor Granted message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Granted messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE 1: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. if the G-bit in the Floor Indicator is set to '1' (Dual floor) shall store an indication that the participant is overriding without revoke; and + +NOTE 2: The G-bit in the Floor Indicator is set to '1' as specified in subclause 6.3.6.3.2. + +4. shall enter the state 'U: permitted' as specified in subclause 6.3.5.5.2. + +#### 6.3.5.4.10 Send Floor Taken message (S: Floor Taken) + +When a Floor Taken message is received from the floor control arbitration logic in the MCPTT server, if the G-bit in the Floor Indicator is set to '1' (Dual floor) the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Taken message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in subclause 8.2.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall store an indication that the participant is listening to media from two sources; and +4. shall remain in the 'U: not permitted and Floor Taken' state. + +When a Floor Taken message is received from the floor control arbitration logic in the MCPTT server, if the I-bit in the Floor Indicator is set to '1' (multi-talker) the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Taken message to the associated floor participant; +2. shall store an indication that the participant is listening to media from more than one source; and + +3. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.11 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +When a Floor Release Multi Talker message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Release Multi Talker message to the associated floor participant; and +2. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.5 State: 'U: permitted' + +##### 6.3.5.5.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state when the associated floor participant has been given permission to send media. + +##### 6.3.5.5.2 Enter state 'U: permitted' + +When entering this state the floor control interface towards the MCPTT client in the floor control server: + +1. shall set the state for the associated floor participant to 'U: permitted'. + +##### 6.3.5.5.3 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if an indication that the participant is overriding without revoke is stored, + - a. shall forward the Floor Release message to the 'dual floor control operation' state machine of the floor control arbitration logic in the MCPTT server with the first bit in the subtype of the Floor Release message set to '0' (Acknowledgment is not required), if not already set; + - b. shall remove the indication that the participant is overriding without revoke; and + - c. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; +3. if an indication that the participant is overridden without revoke is stored, + - a. shall forward the Floor Release message to the general floor control operation state machine of the floor control arbitration logic in the MCPTT server with the first bit in the subtype of the Floor Release message set to '0' (Acknowledgment is not required), if not already set; + - b. shall remove the indication that the participant is overridden without revoke; and + - c. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; and +4. if no indication is stored: + - a. shall forward the Floor Release message to the general floor control operation state machine of the floor control arbitration logic in the MCPTT server with the first bit in the subtype of the Floor Release message set to '0' (Acknowledgment is not required), if not already set; and + - b. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.4 Send Floor Idle message (S: Floor Idle) + +Upon receiving the Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. if the G-bit in the Floor Indicator is set to '1' (Dual Floor) and an indication that the participant is overridden without revoke is stored + - a. shall send Floor Idle message to the associated floor participant; + - b. shall remove the indication that a participant is overridden without revoke; and + - c. shall remain in 'U: permitted state'; +2. if no indication is stored shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2; and +3. if an indication that the participant is overriding without revoke is stored + - a. shall send Floor Idle message to the associated floor participant; + - b. shall remove the indication that a participant is overriding without revoke; and + - c. shall remain in 'U: permitted state'. + +#### 6.3.5.5.5 Send Floor Revoke message (S: Floor Revoke) + +When receiving the Floor Revoke message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Revoke message to the floor participant; +2. if the Floor Revoke message includes the Track Info field, shall store the Track Info field; and +3. shall enter the state 'U pending Floor Revoke' as specified in the subclause 6.3.5.6.2. + +#### 6.3.5.5.6 Receive RTP media packets (R: media) + +Upon receiving an indication from the network media interface in the MCPTT server that RTP media packets with payload are received from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. if an indication that the participant is overriding without revoke is not stored, + - a. shall request the network media interface in the MCPTT server to forward RTP media packets to the media distributor in the MCPTT server. + +#### 6.3.5.5.7 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Request message to the floor control server arbitration logic in the MCPTT server; and + - b. shall instruct the media distributor to act as in subclause 6.3.4.4.5. +2. if an indication that the participant is overriding without revoke is stored, + - a. shall request the network media interface in the MCPTT server to forward RTP media packets to the media distributor in the MCPTT server; and + - b. shall instruct the media distributor to act as in subclause 6.3.6.3.5; and +3. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.8 Send RTP Media (S: media) + +When RTP packets are received from the media distributor, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the RTP packet to the associated floor participant if the indication that the participant is overridden without revoke is stored; +2. shall forward the RTP packet to the associated floor participant if the indication that the participant is overriding without revoke is stored; and +3. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.9 Send Floor Taken message (S: Floor Taken) + +When receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the G-bit in the Floor Indicator set to '1' (Dual Floor), the floor control interface towards the MCPTT client in the floor control server: + +1. shall send the Floor Taken message to the associated floor participant; +2. shall store an indication that the participant is overridden without revoke; and +3. shall remain in the 'U: permitted' state. + +When receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the G-bit in the Floor Indicator set to '0' (Not dual floor), the floor control interface towards the MCPTT client in the floor control server: + +1. shall send the Floor Taken message to the associated floor participant; and +2. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2. + +When receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the I-bit in the Floor Indicator set to '1' (multi-talker), the floor control interface towards the MCPTT client in the floor control server: + +1. shall send the Floor Taken message to the associated floor participant; +2. shall store an indication that the participant is listening to media from more than one source; and +3. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.10 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +When a Floor Release Multi Talker message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Release Multi Talker message to the associated floor participant; and +2. shall remain in the 'U: permitted' state. + +### 6.3.5.6 State: 'U: pending Floor Revoke' + +#### 6.3.5.6.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state during the grace period after sending the Floor Revoke message. + +In this state timer T8 (Floor Revoke) is running. + +#### 6.3.5.6.2 Enter state 'U pending Floor Revoke' + +When entering this state the floor control interface towards the MCPTT client in the floor control server: + +1. shall start timer T8 (Floor Revoke); and +2. shall enter the state 'U: pending Floor Revoke'. + +#### 6.3.5.6.3 Timer T8 (media Revoke) expired + +On expiry of timer T8 (Floor Revoke) the floor control interface towards the MCPTT client in the floor control server: + +1. shall retransmit the Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include the same Rejection Cause field and the same Floor Indicator field as in the previous sent Floor Revoke message; +2. shall start timer T8 (Floor Revoke); and +3. shall remain in the 'U: pending Floor Revoke' state. + +NOTE: The number of times the floor control server retransmits the Floor Revoke message and the action to take when the floor control server gives up is an implementation option. However, it is recommended that the MCPTT client is disconnected from the MCPTT call when the floor control server gives up. + +#### 6.3.5.6.4 Receive RTP media packets (R: media) + +Upon receiving an RTP media packet with payload from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward RTP media packets to the media distributor; and +2. shall remain in the 'U: pending Floor Revoke' state. + +#### 6.3.5.6.5 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client in the floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if the G-bit in the Floor Indicator is set to '1' (Dual floor): + - a. if the state in the 'general floor control operation' state machine is 'G: Taken': + - i. shall send a Floor Taken message to the associated floor participant. The Floor Taken message: + - A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field of the permitted MCPTT client and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2; and + - b. if the state in the 'general floor control operation' state machine is 'G: Idle': + - i. shall send a Floor Idle message to the associated floor participant; + +- ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - iii. shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2; and +3. if the G-bit in the Floor Indicator is set to '0': +- a. shall forward the Floor Release message to the floor control server arbitration logic; and + - b. shall remain in the state 'U: pending Floor Revoke'. + +#### 6.3.5.6.6 Send Floor Idle message (S: Floor Idle) + +Upon receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +NOTE 1: The Floor Idle message is sent when timer T3 (Stop talking grace) expires and when timer T1 (End of RTP media) expires and when there are no queued floor requests. + +1. shall send the Floor Idle message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2. + +#### 6.3.5.6.7 Send Floor Taken message (S: Floor Taken) + +Upon receiving a Floor Taken message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +NOTE 1: The Floor Taken message is sent when timer T3 (Stop talking grace) expires or when timer T1 (End of RTP media) expires and if there are queued floor requests. + +1. shall send the Floor Taken message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.3.2. + +#### 6.3.5.6.8 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +When a Floor Release Multi Talker message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Release Multi Talker message to the associated floor participant; and +2. shall remain in the 'U: pending Floor Revoke' state. + +### 6.3.5.7 State 'U: not permitted but sends media' + +#### 6.3.5.7.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state when it receives RTP media packets from the MCPTT client and the MCPTT client is not permitted to send media. + +Timer T8 (Floor Revoke) is running in this state. + +#### 6.3.5.7.2 Enter state 'U: not permitted but sends media' + +When entering this state the floor control interface towards the MCPTT client in the floor control server: + +1. shall start timer T8 (Floor Revoke); and +2. shall enter the state 'U: not permitted but sends media'. + +In this state the floor control interface towards the MCPTT client in the floor control server: + +1. shall not request the network media interface in the MCPTT server to forward RTP media packets from the MCPTT client to the media distributor in the MCPTT server. + +#### 6.3.5.7.3 Timer T8 (Floor Revoke) expired + +On expiry of timer T8 (Floor Revoke), the floor control interface towards the MCPTT client in the floor control server: + +1. shall send a Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include in the Rejection Cause field the value set to #3 (No permission to send a Media Burst); and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. shall restart timer T8 (Floor Revoke); and +3. shall remain in the 'U: not permitted but sends media' state. + +NOTE: The number of times the floor control server retransmits the Floor Revoke message and the action to take when the floor control server gives up is an implementation option. However, the recommended action is that the MCPTT client is disconnected from the MCPTT call. + +#### 6.3.5.7.4 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message, the floor control interface towards the MCPTT client in the floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if the general state is 'G: Floor Idle', the floor control interface towards the MCPTT client in the floor control server: + - a. shall send the Floor Idle message. The Floor Idle message: + - i. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2; and +3. if the general state is 'G: Floor Taken', the floor control interface towards the MCPTT client in the floor control server: + - a. shall send a Floor Taken message. The Floor Taken message: + +- i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; +- ii. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; +- iii. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; +- iv. may include the first bit in the subtype of the Floor Taken message set to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- v. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- c. shall enter the 'U: not permitted and Floor Taken' state as specified in the subclause 6.3.5.4.2. + +#### 6.3.5.7.5 Send Floor Taken message (S: Floor Taken) + +When receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the I-bit in the Floor Indicator set to '1' (multi-talker), the floor control interface towards the MCPTT client in the floor control server: + +1. shall send the Floor Taken message to the associated floor participant; +2. shall store an indication that the participant is listening to media from more than one source; and +3. shall remain in the 'U: not permitted but sends media' state. + +#### 6.3.5.7.6 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +When a Floor Release Multi Talker message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Release Multi Talker message to the associated floor participant; and +2. shall remain in the 'U: not permitted but sends media' state. + +#### 6.3.5.8 In any state + +##### 6.3.5.8.1 General + +This subclause describes the actions to be taken in all states defined for the basic state diagram with the exception of the 'Start-stop' and 'Releasing' states. + +##### 6.3.5.8.2 Receive MCPTT call release – 1 + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane e.g. when the MCPTT call is going to be released or when the MCPTT client leaves the MCPTT call, the floor control interface towards the MCPTT client in the floor control server: + +1. shall stop sending floor control messages to the associated floor participant; +2. shall request the network media interface to stop sending RTP media packets towards to the associated MCPTT client; +3. shall ignore any floor control messages received from the associated floor participant; +4. shall request the network media interface to stop forwarding RTP media packets from the associated MCPTT client to the media distributor in the MCPTT server; + +5. shall indicate to the floor control server arbitration logic in the MCPTT server that the MCPTT client has started to disconnect from the MCPTT call; and +6. shall enter the 'Releasing' state. + +#### 6.3.5.8.3 Receiving a merging instruction (R: Merge) + +Upon receipt of an instruction to merge with another group due to the group regrouping function, the floor control interface towards the MCPTT client: + +1. shall create an instance of the 'floor participant interface state transition' as specified in subclause 6.5.5; +2. shall move information associated with the instance used for 'basic floor control operation towards the floor participant' to the 'floor participant interface state transition' state machine; + +NOTE: Which information that needs to be moved is an implementation option. + +3. shall enter the 'Start-stop' state and terminate the 'basic floor control operation towards the floor participant' state machine associated with this floor participant and this MCPTT call; +4. if the state was 'U: not permitted and Floor Idle', 'U: not permitted Floor Taken', 'U: pending Floor Revoke', 'U: not permitted and initiating' or 'U: not permitted but sends media': + - a. shall enter the 'P: has no permission' state as specified in subclause 6.5.5; and + - b. shall perform actions specified in subclause 6.5.5.3; and +5. if the state was 'U: permitted': + - a. shall enter the 'P: has permission' state; and + - b. shall perform actions specified in subclause 6.5.5.4. + +#### 6.3.5.9 State: 'Releasing' + +##### 6.3.5.9.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state while waiting for the application and signalling plane to finalize the release of the MCPTT call or finalizing the removal of the MCPTT client from the MCPTT call. + +##### 6.3.5.9.2 Receive MCPTT call release - 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control interface towards the MCPTT client in the floor control server: + +1. shall request the network media interface to release all resources associated with this MCPTT client for this MCPTT call; and +2. shall enter the 'Start-stop' state and terminate the 'basic floor control operation towards the floor participant' state machine associated with this floor participant and this MCPTT call. + +#### 6.3.5.10 State: 'U: not permitted and initiating' + +##### 6.3.5.10.1 General + +The floor control interface towards the MCPTT client uses this state when waiting for the floor control arbitration logic to finalize the initialisation of the state machine to be used for a temporary group session. + +During this state Floor Request messages can be received from the non-controlling MCPTT function. Any Floor Request message received will be added to the queue according to the priority of the floor request determine as described in subclause 4.1.1.4. + +#### 6.3.5.10.2 Enter the 'U: not permitted and initiating' state + +The floor control interface towards the MCPTT client: + +1. shall set the state for the associated floor participant to 'U: not permitted and Initiating'. + +#### 6.3.5.10.3 Send Floor Taken message (S: Floor Taken) + +When a Floor Taken message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client: + +1. shall forward the Floor Taken messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the state 'U: not permitted and Floor Taken' as specified in subclause 6.3.5.4.2. + +#### 6.3.5.10.4 Send Floor Idle message (S: Floor Idle) + +When receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client: + +1. shall forward the Floor Idle message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the 'U: not permitted and Floor Idle' state as specified in the subclause 6.3.5.3.2. + +#### 6.3.5.10.5 Receive Floor Request message (R: Floor Request) + +Upon receipt of a Floor Request message, the floor control interface towards the MCPTT client: + +1. shall determine the effective priority level as described in subclause 4.1.1.4; +2. shall put the Floor Request message in the floor request queue according to the determined effective priority level; +3. if the value in the Track Info field is set to '1' (the floor participant in the MCPTT client supports queueing), shall send a Floor Queue Position Info message to the requesting non-Controlling MCPTT function, The Floor Queue Position Info message: + - a. shall include the queue position and floor priority in the Queue Info field; + - b. shall include the received Track Info field; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +4. if the value in the Track Info field is set to '0' (the floor participant in the MCPTT client does not support queueing), shall send the Floor Deny message. The floor Deny message: + +NOTE: A Floor Request from a MCPTT client in a constituent group can be received without the queueing capability if a floor participant in an ongoing constituent MCPTT group request floor while the floor was idle during the merging process. + +- a. shall include in the Reject Cause field the value cause '1' (Another MCPTT client has permission); + - b. shall include the received Track Info field; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +5. shall remain in the 'U: not permitted and initiating' state. + +#### 6.3.5.10.6 Send Floor Granted message (S: Floor Granted) + +When a Floor Granted message is received from the floor control arbitration logic, the floor control interface towards the MCPTT client: + +1. shall forward the Floor Granted messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in subclause 8.2.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the state 'U: permitted' as specified in subclause 6.3.5.5.2. + +#### 6.3.5.10.7 Receive a Floor Release message (S: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in subclause 8.2.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. shall use the topmost value and the SSRC in the Track Info field of the received Floor Release message to check if the floor participant has a queued floor request and if not, check if there is a floor request in one of the cached application/vnd.3gpp.mcptt-floor-request+xml MIME bodies; +3. shall remove the MCPTT client from the active floor request queue or the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body, if the MCPTT client was in the active floor request queue or in the application/vnd.3gpp.mcptt-floor-request+xml MIME body; and +4. shall remain in the 'U: not permitted and initiating' state. + +#### 6.3.5.10.8 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +When a Floor Release Multi Talker message is received from the floor control arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the floor control server: + +1. shall forward the Floor Release Multi Talker message to the associated floor participant; and +2. shall remain in the "U: not permitted and initiating' state. + +### 6.3.6 Dual floor control + +#### 6.3.6.1 General + +Dual floor control is used when a floor participant requests floor with a pre-emptive floor priority allowing the floor control in subclause 6.3.4 to continue without revoking the floor from the MCPTT client permitted to send media as specified in 3GPP TS 23.379 [5] subclause 10.9.1.3.2.2. + +The floor control server arbitration logic in the floor control server shall behave according to the state diagram and state transitions specified in this subclause. + +Figure 6.3.6.1-1 shows the 'dual floor control operation' states (D states) and the state transition diagram. + +![Floor control server state transition diagram for 'dual floor control operation' showing four states: Idle, Request, Granted, and Reserved, with various transitions between them.](986e77e2df3c318680a569774888f4aa_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Request + Request --> Idle + Request --> Granted + Request --> Reserved + Granted --> Idle + Granted --> Reserved + Reserved --> Idle + Reserved --> Request + +``` + +Floor control server state transition diagram for 'dual floor control operation' showing four states: Idle, Request, Granted, and Reserved, with various transitions between them. + +**Figure 6.3.6.1-1: Floor control server state transition diagram for 'dual floor control operation'** + +The floor control arbitration logic in the floor control server shall keep one instance of the 'dual floor control operation' state machine for a floor participant with pre-emptive floor priority where this MCPTT user is allowed to talk without revoking a current speaker with lower flow priority. + +NOTE: Only one MCPTT user with this type of pre-emptive floor priority can exist within an MCPTT call. + +The floor participant associated to the 'dual floor control operation' state machine is in the following subclauses referred to as the overriding MCPTT client. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following subclauses the floor control arbitration logic in the floor control server: + +- 1. shall discard the floor control message; +- 2. shall request the media distributor in the MCPTT server to discard any received RTP media packet; and + +3. shall remain in the current state. + +State details are explained in the following subclauses. + +### 6.3.6.2 State: 'Start-stop' + +#### 6.3.6.2.1 General + +When a new instance of the 'dual floor control operation' state machine is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly when the media burst is released the state machine shall return to the 'Start-Stop' state or the related MCPTT call is released. + +#### 6.3.6.2.2 Receive Floor Request message with overriding pre-emptive floor priority (R: Floor Request) + +When a floor participant request floor with an overriding pre-emptive priority is granted the floor the floor control arbitration logic: + +1. shall create one instance of the 'dual floor control operation' state machine; +2. shall store the SSRC of floor participant; +3. if a Track Info field is included in the Floor Request message, shall store the received Track Info field associated with the floor control server state transition diagram for 'dual floor control operation', and +4. shall enter the state 'D: Floor Taken' as specified in the subclause 6.3.6.3.2. + +### 6.3.6.3 State: 'D: Floor Taken' + +#### 6.3.6.3.1 General + +The floor control arbitration logic in the floor control server uses this state when it has permitted one floor participant to override a current speaker in an MCPTT call to send media. + +Timer T11 (End of RTP dual) can be running when the floor control server is in this state. + +Timer T12 (Stop talking dual) can be running when the floor control server is in this state. + +#### 6.3.6.3.2 Enter state 'D: Floor Taken' + +When entering this state the floor control arbitration logic in the floor control server: + +1. shall send a Floor Granted message to the requesting floor participant. The Floor Granted message: + - a. shall include the value of the T12 (Stop talking dual) timer in the Duration field; + - b. shall include the granted priority in the Floor priority field; + - c. if a Track Info field associated with the floor control server state transition diagram for 'dual floor control operation' is stored, shall include the stored Track Info field; + - d. shall include the Floor Indicator field with the G-bit set to '1' (Dual floor); + - e. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - f. if non-controlling MCPTT functions are involved, shall include the SSRC of granted floor participant; +2. shall send a Floor Idle message to any non-controlling MCPTT functions involved in the session and to those floor participants controlled by the controlling MCPTT function that will only listen to RTP media from the overriding MCPTT client according to local policy. The Floor Idle message: + +NOTE 1: The non-controlling MCPTT function will send the Floor Idle message to those floor participants controlled by the non-controlling MCPTT function that will only listen to RTP media from the overriding MCPTT client according to local policy when the non-controlling MCPTT function receives the Floor Taken with the G-bit set to '1' (Dual floor) in the Floor Indicator field. + +- i. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +3. shall send a Floor Taken message to any non-controlling MCPTT functions involved and to floor participants controlled by the controlling MCPTT function that will listen to the RTP media from the overriding MCPTT client according to local policy. The Floor Taken message: + +NOTE 2: The MCPTT client overridden by the overriding MCPTT client is still sending voice (overridden). The list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +- a. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + - b. shall include a Message Sequence Number field with a value increased with 1; + - c. shall include the Floor Indicator field with the G-bit set to '1' (Dual floor); and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +4. shall start the T11 (End of RTP dual) timer; and + 5. shall enter the state to 'D: Floor Taken' state. + +### 6.3.6.3.3 Timer T11 (End of RTP dual) expired + +On expiry of timer T11 (End of RTP dual), the floor control arbitration logic in the floor control server: + +1. shall stop the T12 (Stop talking dual) timer; if running; +2. shall request the media distributor in the MCPTT server to stop distributing RTP media packets received from the overriding MCPTT client to other MCPTT clients; + +NOTE: If dual floor control is ongoing as described in subclause 6.3.6, the list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +3. shall release all resources reserved in the media plane including the instances used for the 'dual floor control operation' state machine and any running timers associated with the state machine; +4. shall send a Floor Idle message to any non-controlling MCPTT functions and to those floor participants controlled by the controlling MCPTT functions receiving RTP media from the overriding MCPTT client. The Floor Idle message: + - a. shall include a Floor Indicator field with the G-bit set to '1' (Dual floor); + - b. shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +5. if the state in the 'general floor control operation' state machine is 'G: Taken'; + +- a shall send a Floor Taken message to any non-controlling MCPTT functions and to those floor participants controlled by the controlling MCPTT function that only received RTP media from the overriding MCPTT client. The Floor Taken message: + - i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field of the permitted MCPTT client and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + - ii. shall include a Message Sequence Number field with a value increased with 1; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 6. if the state in the 'general floor control operation' state machine is 'G: Idle', shall send a Floor Idle message to all floor participants. The Floor Idle message: + - a. shall include a Message Sequence Number field with a value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 7. shall enter the 'Start-stop' state. + +#### 6.3.6.3.4 Timer T12 (Stop talking dual) expired + +On expiry of the T12 (Stop talking dual) timer the floor control arbitration logic in the floor control server: + +- 1. shall stop the T11 (End of RTP dual) timer; +- 2. shall request the media distributor in the MCPTT server to stop distributing RTP media packets to other MCPTT client; +- 3. shall send the Floor Revoke message to the permitted participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the value set to #2 (Media burst too long) in the Floor Revoke message sent in subclause 6.3.4.5.2; + - b. shall include the Floor Indicator with the G-bit set to '1' (Dual floor); + - c. if a Track Info field associated with the dual floor is stored, shall include the stored Track Info field; and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 4. shall remove the stored Track info field associated with the dual floor; +- 5. if the state in the 'general floor control operation' state machine is 'G: Taken'; + - a. shall send a Floor Taken message to all non-controlling functions (if the session is a temporary group session involving non-controlling MCPTT functions) and to those floor participants that only received RTP media from the overriding MCPTT client. The Floor Taken message: + - i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field of the permitted MCPTT client and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; and + - ii. shall include a Message Sequence Number field with a value increased with 1; +- 6. if the state in the 'general floor control operation' state machine is 'G: Idle', shall send a Floor Idle message to all floor participants. The Floor Idle message: + +- a. shall include a Message Sequence Number field with a value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +7. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation'; and + 8. shall enter the 'Start-stop' state. + +#### 6.3.6.3.5 Receive RTP media packets (R: media) + +Upon receiving an indication from the media distributor in the MCPTT server that RTP media packets are received from the permitted MCPTT client, the floor control arbitration logic in the floor control server: + +1. shall start the T12 (Stop talking dual) timer, if not already running; +2. shall restart the T11 (End of RTP dual) timer; +3. shall instruct the media distributor to forward the received RTP media packets to any non-controlling MCPTT functions, to the overridden MCPTT client and to those MCPTT clients receiving RTP media from the overriding MCPTT client controlled by the controlling MCPTT functions according to local policy; and + +NOTE 1: The RTP media is sent to the MCPTT clients subjected to the maximum number of simultaneous transmissions received in one group call for override (N7) as indicated in 3GPP TS 23.379 [5]. + +NOTE 2: The non-controlling MCPTT function will forward the RTP media packets to MCPTT clients receiving RTP media from the overriding MCPTT client according to local policy in the non-controlling MCPTT function. + +4. shall remain in the 'D: Floor Taken' state. + +#### 6.3.6.3.6 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop distributing RTP media packets received from the overriding MCPTT client to other MCPTT client; +2. shall stop the T12 (Stop talking dual) timer, if running; +3. shall stop the T11 (End of RTP dual) timer; +4. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation' and any running timers associated with the state machine; +5. if the first bit in the subtype of the Floor Release message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2: + - a. shall send a Floor Ack message. The Floor Ack message: + - i. shall set the Source field to the value '2' (the controlling MCPTT function is the source); and + - ii. shall set the Message Type field to the value '4' (Floor Release); +6. shall send a Floor Idle message to any non-controlling MCPTT functions, to the overridden floor participant and to those floor participants controlled by the controlling MCPTT functions receiving RTP media from the overriding MCPTT client. The Floor Idle message: + - a. shall include an Floor Indicator field with the G-bit set to '1' (Dual floor); + +- b shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 7. if the state in the 'general floor control operation' state machine is 'G: Taken', + - a. shall send a Floor Taken message to any non-controlling MCPTT functions and to those floor participants that only received RTP media from the overriding MCPTT client. The Floor Taken message: + - i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field of the permitted MCPTT client and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested; + - ii. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - 8. if the state in the 'general floor control operation' state machine is 'G: Idle', shall send a Floor Idle message to all floor participants;. The Floor Idle message: + - a. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - 9. shall enter the 'Start-stop' state. + +#### 6.3.6.3.7 Receive Floor request message from permitted floor participant (R: Floor Request) + +Upon receiving a Floor Request message from the floor participant that has been granted permission to send overriding media, the floor control arbitration logic in the floor control server: + +- 1. shall send a Floor Granted message to the previously granted floor participant. The Floor Granted message: + - a. shall include the value of the T12 (Stop talking dual) timer in the Duration field; + - b. shall include the granted priority in the Floor priority field; + - c. if the Floor Request message included a Track Info field, shall include the received Track Info field; and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 2. shall remain in the 'D: Floor Taken' state. + +#### 6.3.6.3.8 Permitted MCPTT client release + +If the floor control server receives an indication from the floor control interface towards the MCPTT client that the MCPTT client has started to disconnect from the MCPTT call, the floor control arbitration logic in the floor control server: + +- 1. shall request the media distributor in the MCPTT server to stop distributing RTP media packets received from the overriding MCPTT client to other MCPTT clients; +- 2. shall send a Floor Idle message to any non-controlling MCPTT functions and to those floor participants controlled by the controlling MCPTT functions receiving RTP media from the overriding MCPTT client. The Floor Idle message: + +- a. shall include an Floor Indicator field with the G-bit set to '1' (Dual floor); + - b shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +3. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation' and any running timers associated with the state machine; and + 4. shall enter the 'Start-stop' state. + +#### 6.3.6.3.9 Receive Terminate (Terminate) + +Upon receiving the termination instruction, the floor control arbitration logic in the floor control server: + +1. shall set the value of timer T1 (End of RTP media) to the value of timer T11 (End of RTP dual) and start timer T1, if timer T11 (End of RTP dual) is running; +2. shall set the value of timer T2 (Stop talking) to the value of timer T12 (Stop talking dual) and start timer T2, if timer T12 (Stop talking dual) is running; +3. shall release all resources reserved in the media plane including the instances used for the dual floor control operation' state machine and stop any running timers associated with the state machine; and +4. shall enter the 'Start-stop' state. + +NOTE: The overriding participant continues to have the floor until its current talk burst is terminated. + +#### 6.3.6.4 In any state + +##### 6.3.6.4.1 General + +This subclause describes the actions to be taken in all states defined for the general state diagram with the exception of the 'Start-stop' state. + +##### 6.3.6.4.2 Receive MCPTT call release - 1 + +This subclause is used by the floor control arbitration logic in the floor control server when an MCPTT call is released. + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane the floor control arbitration logic in the floor control server: + +1. shall request the media distributor in the MCPTT server to stop sending RTP media packets MCPTT clients; and +2. shall enter the 'Releasing' state. + +#### 6.3.6.5 State: 'Releasing' + +##### 6.3.6.5.1 General + +The floor control arbitration logic in the floor control server uses this state while waiting for the application and signalling plane to finalize the disconnection of an MCPTT call. + +##### 6.3.6.5.2 Receive MCPTT call release - 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control arbitration logic in the floor control server: + +1. shall release all resources reserved in the media plane including the instances used for the dual floor control operation' state machine and any running timers associated with the state machine; and +2. shall enter the 'Start-stop' state. + +## 6.4 Participating MCPTT function floor control procedures + +### 6.4.1 General + +Once an on-demand MCPTT session is established or a pre-established session is in use when the participating MCPTT function receives floor control messages from the floor participant in the MCPTT client or from the floor control server in the controlling MCPTT function, the behaviour of the participating MCPTT function is described in the following subclauses. + +### 6.4.2 Receive floor control messages + +Upon receiving a floor control message the participating MCPTT function: + +1. shall immediately forward the floor control message to the floor control server if the message is received from the floor participant; +2. if an MBMS subchannel is not used for a conversation in the session the floor control message is associated with, shall immediately forward the floor control message to the floor participant if the message is received from the floor control server; and +3. if an MBMS subchannel is used for a conversation in the session the floor control message is associated with: + - a. if + - i. the floor control message is not a Floor Idle message or a Floor Taken message or a Floor Release Multi Talker message; + - ii. the MCPTT client has not reported "listening" status as specified in 3GPP TS 24.379 [2] subclause 14.2.3; + - iii. the MCPTT client has reported "not-listening" status as specified in 3GPP TS 24.379 [2] subclause 14.2.3 in the latest received MBMS bearer listening status report; or + - iv. the floor control message is a Floor Idle message or a Floor Taken message or a Floor Release Multi Talker message, protection of floor control messages sent over the MBMS subchannel from the participating MCPTT function to the served MCPTT clients is required, and the participating MCPTT function determined that the MCPTT client does not support MuSiK as specified in 3GPP TS 24.379 [2]; + +shall immediately forward the floor control message to the floor participant; and + +- b. if + - i. the MCPTT client has reported "listening" status as specified in 3GPP TS 24.379 [2] subclause 14.2.3 in the latest received MBMS bearer listening status report; and + - ii. if the floor control message is the Floor Idle message or the Floor Taken message or the Floor Release Multi Talker message, and: + - protection of floor control messages sent over the MBMS subchannel from the participating MCPTT function to the served MCPTT clients is not required; or + - the participating MCPTT function determined that the MCPTT client supports MuSiK as specified in 3GPP TS 24.379 [2]; + +shall perform actions as specified in subclause 10.2. + +NOTE: When the Floor Idle, Floor Taken, or Floor Release Multi Talker messages are discarded the messages are sent to the MCPTT clients over the MBMS subchannel allocated for the conversation as specified in subclause 10.2. + +### 6.4.3 Receive RTP media packets (R: RTP Media) + +Upon receiving RTP media packets the participating MCPTT function: + +1. shall immediately forward the RTP media packet to the controlling MCPTT function if the RTP packet is from an MCPTT client; and +2. if an MBMS subchannel is not used for a conversation in the session the RTP media packets are associated with, shall immediately forward the RTP media packets to the MCPTT client if the RTP packet is from the controlling MCPTT function or the non-controlling MCPTT function. +3. if an MBMS subchannel is used for a conversation in the session the RTP media packets are associated with and if RTP media packets are received from the controlling MCPTT function or the non-controlling MCPTT function: + - a. if + - i. the MCPTT client has not reported "listening" status as specified in 3GPP TS 24.379 [2] subclause 14.2.3; or + - ii. the MCPTT client has reported "not-listening" status as specified in 3GPP TS 24.379 [2] subclause 14.2.3 in the latest received MBMS bearer listening status report,shall immediately forward the RTP media packets to the MCPTT client; and + - b. if the MCPTT client has reported "listening" status as specified in 3GPP TS 24.379 [2] subclause 14.2.3 in the latest received MBMS bearer listening status report, shall perform actions as specified in subclause 10.2. + +### 6.4.4 Release of session + +When the participating function receives an indication from the application and signalling plane that session release is initiated, the participating MCPTT function: + +1. shall stop sending floor control messages towards the floor participant and the floor control server; and +2. shall stop sending RTP media packets towards the MCPTT client and towards the controlling MCPTT function. + +When the participating MCPTT function receives an indication from the application and signalling plane that the session is released, the participating MCPTT function: + +1. in case of a pre-established session, shall perform the actions in subclause 9.3.2; and +2. in case of an on-demand session, shall release the media resources associated with the session. + +## 6.5 Non-controlling MCPTT function of an MCPTT group + +### 6.5.1 General + +The floor control server interface in the non-controlling MCPTT function of an MCPTT group shall support the procedures in subclauses 6.5.2, 6.5.3 and 6.5.4. + +The floor participant interface in the non-controlling MCPTT function of an MCPTT group shall support the procedures in subclause 6.5.5. + +## 6.5.2 The MCPTT call initialization procedure in the non-controlling MCPTT function of an MCPTT group + +### 6.5.2.1 General + +The subclause 6.5.2.2 describes the initial procedures when a new SIP session is establishing a group session. + +The subclause 6.5.2.3 describes the procedure for switching from a controlling MCPTT function mode to a non-controlling MCPTT function mode. + +### 6.5.2.2 Initial procedures when a new SIP session is establishing a group session + +When receiving an indication from the application and signalling plane that a group session is initiated, the floor control server interface: + +1. shall initiate and store a message sequence number value with the value to be used in the Message Sequence Number field in the Floor Idle and Floor Taken messages; +2. shall for each MCPTT client in the MCPTT group controlled by the non-controlling MCPTT function that are participating in the session: + - a. generate a random temporary identifier between '0' and '4294967295'; + - b. store an association between the generated temporary identifier and the floor participant interface; + - c. store information about capabilities negotiated in the "mc\_queueing" and "mc\_priority" fmtp attributes as described in clause 14; + - d. store information whether the MCPTT client requested privacy or not; and + - e. initiate an instance of the 'floor participant state transition' state machine as specified in subclause 6.5.5; and +3. shall perform the actions in the subclause 6.5.4. + +When receiving an indication from the application and signalling plane that an MCPTT client has accepted an invitation to the session, the floor participant interface shall perform the actions in subclause 6.5.5. + +### 6.5.2.3 Switching from a controlling MCPTT function mode to a non-controlling MCPTT function mode + +#### 6.5.2.3.1 Overview + +The switching from working in a controlling MCPTT functional mode to a non-controlling MCPTT functional mode is a 2-step procedure. + +- Step 1 The controlling MCPTT function prepares for acting as a non-controlling MCPTT function. The step 1 procedure is specified in subclause 6.5.2.3.2. + +Before continuing with step 2 the application and signalling plane needs to receive a confirmation that the SIP session between the floor control server and the interface to the floor control server is established. + +- Step 2 The controlling MCPTT functions starts acting as a non-controlling MCPTT function. The step 2 procedure is specified in subclause 6.5.2.3.3. + +#### 6.5.2.3.2 Preparing for the switch to non-controlling MCPTT function (Step 1) + +When receiving a request from the application and signalling plane to prepare for merging with another group session, the floor control server: + +1. if in the 'G: taken' state, shall provide information about current speaker to the signalling and application plane; + +NOTE: The signalling and application plane will use the information about the current speaker to send a floor request in an SIP MESSAGE request as specified in 3GPP TS 24.379. + +2. shall release the instant used for 'general floor control operation'; and +3. shall for each MCPTT client in the MCPTT group controlled by the controlling MCPTT function and participating in the session: + - a. generate a random temporary identifier between '0' and '4294967295'; + - b. store an association between the generated temporary identifier and the floor participant interface; + - c. store information about capabilities negotiated in the "mc\_queueing" and "mc\_priority" fmtp attributes as specified in clause 14; + - d. store information whether the MCPTT client requested privacy or not; and + - e. initiate an instance of the 'floor participant state transition' state machine as specified in subclause 6.3.5.8.3. + +### 6.5.2.3.3 Start acting as a non-controlling MCPTT function (Step 2) + +When receiving a request from the application and signalling plane to finalize the switch to non-controlling MCPTT function behaviour, the floor control server: + +1. shall start acting as a floor control server interface; +2. if an active floor request queue exists, for each queued floor request in the active floor request queue: + +NOTE: The active floor request queue was built up when the non-controlling MCPTT function was acting as a floor control server. + +- a. shall send a Floor Request message to the floor control server. The Floor Request: + - i. shall include all fields included by the floor participant; + - ii. if a Track Info field is included, shall include the temporary identifier at the end of the value item; and + - iii. if a Track Info field is not included, shall include a Track Info field populated as follows: + - A. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; + - B. shall include a value based on the element specified in 3GPP TS 24.481 [12], if value in the element is available, otherwise set the value to "unknown"; and + - C. shall include the temporary identifier as the first value; +3. if an active floor request queue exists, shall move the active floor request queue to a passive floor request queue; and +4. shall perform the actions in the subclause 6.5.4. + +When receiving an indication from the application and signalling plane that an MCPTT client has joined the session, the floor participant interface shall perform the actions in subclause 6.5.5. + +## 6.5.3 The MCPTT call release procedure in the non-controlling MCPTT function of an MCPTT group + +When an MCPTT client leaves an MCPTT call and the MCPTT call remains ongoing with the other MCPTT clients, the non-controlling MCPTT function of an MCPTT group follows a two-step procedure: + +- Step 1 The floor participant interface stops sending floor control messages and RTP media packets to the MCPTT client leaving the MCPTT call and the floor participant interface discards floor control messages and RTP media packets received from the MCPTT client leaving the MCPTT call; and +- Step 2 When the application and signalling plane has determined that the session with this floor participant has been released, the corresponding instance of the 'floor participant state transition' state machine is released. + +When an MCPTT call is released, the floor control server interface follows a two-step procedure: + +- Step 1 The floor control server interface stops sending floor control messages and RTP media packets to MCPTT clients in the MCPTT call; and +- Step 2 When the application and signalling plane has determined that the MCPTT call has been released, resources in the floor control server interface are released, along with all 'floor participant state transition' state machines. + +The non-controlling MCPTT function of an MCPTT group can initiate an MCPTT call release depending on the release policy specified in 3GPP TS 24.379 [2]. + +## 6.5.4 Floor control server interface procedures + +### 6.5.4.1 General + +The floor control server interface is stateless with regards to the floor control message received and sent. + +The following subclauses specifies what the floor control server interface shall do when receiving a floor control message sent by the controlling MCPTT function or received at the floor participant interface and how the floor control server controls the media distribution function in the non-controlling MCPTT function. + +### 6.5.4.2 Receiving a Floor Request message + +Upon receiving a Floor Request message from one floor participant interface, the floor control server interface: + +1. shall forward the Floor Request message to the controlling MCPTT function. The Floor Request message: + - a. shall include all fields included by the floor participant; + - b. if a Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field populated as follows: + - i. shall include the "mc\_queueing" fmp attribute value negotiated as specified in clause 14 in the value; + - ii. shall include a value based on the element specified in 3GPP TS 24.481 [12], if value in the element is available, otherwise set the value to "unknown"; and + - iii. shall include the temporary identifier as the first value; and +2. if the value of the in the Track Info is '1' (the floor participant in the MCPTT client supports queueing), shall store the outgoing Floor Request message in the passive floor request queue. + +### 6.5.4.3 Receive Floor Release message + +Upon receiving a Floor Release message from one floor participant interface, the floor control server interface: + +NOTE: A Floor Release message can be received from the permitted floor participant and from any participant that is queued in the floor control server. + +1. shall forward a Floor Release message to the controlling MCPTT function. The Floor Release message: + - a. shall include all fields included by the floor participant in the Floor Release message; + - b. if a Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field as follows: + - i. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; and + - ii. shall include the temporary identifier as the first value; and +2. if a Floor Request message received from this floor participant is in the passive floor request queue, shall remove the floor request from the passive floor request queue. + +#### 6.5.4.4 Receive Floor Queue Position Request message + +Upon receiving a Floor Queue Position Request message from one floor participant interface, the floor control server interface: + +1. shall forward the Floor Queue Position Request message to the controlling MCPTT function. The Floor Queue Position Request message: + - a. shall include all fields included by the floor participant; + - b. if a Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field as follows: + - i. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; and + - ii. shall include the temporary identifier as the first value. + +#### 6.5.4.5 Receive Floor Ack message + +Upon receiving a Floor Ack message from one floor participant interface the floor control server interface: + +1. shall send the Floor Ack message towards the controlling MCPTT function. The Floor Ack message: + - a. shall include all fields included by the floor participant in the Floor Ack message; + - b. if Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field with temporary identifier as the first . + +#### 6.5.4.6 Receive Floor Granted message + +Upon receiving a Floor Granted message sent from the controlling MCPTT function, the floor control server interface: + +1. shall send the Floor Granted to the floor participant interface identified by the value at the end of the Track Info field. The Floor Granted message: + - a. shall include the fields as received with the following exceptions: + - i. if the Track Info field only contains one value, shall remove the Track Info field from the outgoing Floor Granted message; and + +- ii. if the Track Info field contains more than one value, shall remove the last value from the Track Info field from the outgoing Floor Granted message; and +2. if: +- a. a SSRC of granted floor participant and associate the stored value with dual floor is not stored, shall send a Floor Taken message populated as specified in step d. below to all participant interfaces with the exception of the floor participant interface to which the Floor Granted message is sent; + - b. a SSRC of granted floor participant associate with dual floor is stored and if the Floor Indicator field is not included in the Floor Granted message or if the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '0' (Not dual floor), shall send a Floor Taken message populated as specified in step d. below to all participant interfaces with the exception of: + - i. the floor participant interface to which the Floor Granted message is sent; and + - ii. the floor participants only listening to the overriding floor participant; + - c. the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '1' (Dual floor): + - i. shall send a Floor Taken message populated as specified in step d. below to floor participants that will listen to the RTP media from the overriding MCPTT client according to local policy; + +NOTE 1: The MCPTT client overridden by the overriding MCPTT client is still sending voice (overridden). The list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +d. The Floor Taken message: + +- i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field and may include the functional alias of the granted MCPTT user in the Functional Alias field, if privacy is not requested by the granted floor participant when the MCPTT client was invited to the session; + +NOTE 2: The privacy request was stored for each invited MCPTT client when the MCPTT client accepted the invitation as specified in subclause 6.5.2. + +- ii. shall include in the Message Sequence Number field the local value increased with 1; +- iii. shall include the Permission to Request Floor field to '0', if the group call is a broadcast group call; +- iv. may include the Permission to Request the Floor field set to '1', if the group call is not a broadcast group call; and +- v. shall set the first bit in the subtype of the Floor Taken message to '0' (acknowledgement is not required); and + +NOTE 3: A Floor Taken message sent to all participants does not require acknowledgement. + +- e. if the Floor Indicator field was included in the Floor Granted message, shall include the received Floor Indicator field; and + +3. if the Floor Request message received from the floor participant is in the passive floor request queue, shall remove the floor request from the passive floor request queue; and + +4 if the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '1' (Dual floor), shall send a Floor Idle message to those floor participants that will only listen to RTP media from the overriding MCPTT client. The Floor Idle message: + +- a. shall include the Floor Indicator field as received in the Floor Granted message with the G-bit set to '0' (Not dual floor); and + +- b. shall include in the Message Sequence Number field the local value increased with 1. + +#### 6.5.4.7 Receive Floor Deny message + +Upon receiving a Floor Deny message sent from the controlling MCPTT function, the floor control server interface: + +1. shall use the value at the end of the Track Info field to identify the floor participant interface; +2. if: + - a. the Track Info field only contains one value, shall remove the Track Info field from the outgoing Floor Granted message; and + - b. if the Track Info field contains more than one value, shall remove the last value from the Track Info field; +3. shall forward the Floor Deny message to the floor participant interface; and +4. if the Floor Request message received from the floor participant is in the passive floor request queue, shall remove the floor request from the passive floor request queue. + +#### 6.5.4.8 Receive Floor Idle message + +Upon receiving a Floor Idle message sent from the controlling MCPTT function, the floor control server interface: + +NOTE 1: The Floor Idle message can be either destined to floor participants in all MCPTT clients or is sent to the floor participant in a specific MCPTT client. In the latter case the Floor Idle message contains the Track Info field. + +1. if the Floor Idle message contains a Track Info field; + - a. shall use the value at the end of the Track Info field to identify the floor participant interface; + - b. if: + - i. the Track Info field only contains one value: + - A. shall remove the Track Info field from the outgoing Floor Idle message; + - B. shall increase the stored message sequence number value with 1; and + - C. shall include in the Message Sequence Number field the local value increased with 1; and + - ii. if the Track Info field contains more than one value, shall remove the last value from the Track Info field; and + - c. shall send the Floor Idle message to the floor participant interface; +2. if the Floor Idle message does not contain a Track Info field; + - a. shall set the first bit in the subtype of the Floor Idle message to '0' (acknowledgement is not required); + +NOTE 2: A Floor Idle message sent to all participants does not require acknowledgement. + +- b. if: + - i. the Floor Indicator field is not included in the Floor Idle message or if the Floor Indicator field is included and the G-bit is set to '0' (Not dual floor), shall send the Floor Idle message to all floor participant interfaces. The Floor Idle message: + - A. shall include received fields; and + +- B. shall include in the Message Sequence Number field the local value increased with 1; and + - ii. the Floor Indicator field is included in the Floor Idle message and the G-bit is set to '1' (Dual floor), + - A. shall send the Floor Idle message to floor participants listening to the overriding MCPTT client according to local policy. The Floor Idle message: + - shall include received fields; and + - shall include in the Message Sequence Number field the local value increased with 1; and + - B. shall discard the stored SSRC of granted floor participant associated with a dual floor; + - c. shall send a Floor Ack message towards the controlling MCPTT function if the first bit in the subtype of the received Floor Idle message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2. The Floor Ack message: + - i. shall include the Source field set to '3' (the non-controlling MCPTT function is the source); and + - ii. shall include the Message Type field set to '5' (Floor Idle); and +3. shall empty the passive floor request queue. + +#### 6.5.4.9 Receive Floor Taken message + +Upon receiving a Floor Taken message sent from the controlling MCPTT function, the floor control server interface: + +NOTE 1: The Floor Taken message can be either destined to floor participants in all MCPTT clients or is sent to the floor participant in a specific MCPTT client. In the latter case the Floor Taken message contains the Track Info field. + +1. if the Floor Taken message contains a Track Info field; + - a. shall use the value at the end of the Track Info field to identify the floor participant interface; + - b. if the Track Info field only contains one value: + - A. shall remove the Track Info field from the outgoing Floor Taken message; and + - B. shall include in the Message Sequence Number field the local value increased with 1; + - c. if the Track Info field contains more than one value, shall remove the last value from the Track Info field; and + - d. shall send the Floor Taken message to the floor participant interface; +2. if the Floor Taken message does not contain a Track Info field: + - a. shall set the first bit in the subtype of the Floor Taken message to '0' (acknowledgement is not required); + +NOTE 2: A Floor Taken message sent to all participants does not require acknowledgement. + +- b. if the Floor Indicator field is included in the Floor Taken message and the G-bit is set to '1' (Dual floor), shall store the SSRC of granted floor participant and associate the stored SSRC with dual floor; +- c. if there is no stored SSRC of granted floor participant associated with a dual floor, shall send the Floor Taken message to all floor participant interfaces. The Floor Taken message: + - i. shall include all received fields with the exception of the Message Sequence Number field; + +- ii. shall include in the Message Sequence Number field the local value increased with 1; +- d. if there is a stored SSRC of granted floor participant associated with a dual floor: + - i. if the Floor Indicator field is not included in the Floor Taken message or if the Floor Indicator field is included in the Floor Taken message and the G-bit is set to '0' (Not dual floor), shall send the Floor Taken message to all floor participant interfaces with the exception of the floor participants only listening to RTP media from the overriding floor participant. The Floor Idle message: + - A. shall include all received fields; and + - B. shall include in the Message Sequence Number field the local value increased with 1; and + - ii. if the Floor Indicator field is included in the Floor Taken message and the G-bit is set to '1' (Dual floor): + - A. shall send the Floor Taken message to all floor participants listening to the RTP media from the overriding MCPTT client according to local policy. The Floor Taken message: + - shall include all received fields; and + - shall include in the Message Sequence Number field the local value increased with 1; and + - B. shall send a Floor Idle message to those floor participants that will only listen to RTP media from the overriding MCPTT client according to local policy. The Floor Idle message: + - shall include all received fields; + - shall include in the Message Sequence Number field the local value increased with 1; and + - shall update the received Floor Indicator field and set the G-bit to '0' and; +- e. shall send a Floor Ack message towards the controlling MCPTT function if the first bit in the subtype of the received Floor Taken message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2. The Floor Ack message: + - i. shall include the Source field set to '3' (the non-controlling MCPTT function is the source); and + - ii. shall include the Message Type field set to '2' (Floor Taken); + +#### 6.5.4.10 Receive Floor Revoke message + +Upon receiving a Floor Revoke message from the controlling MCPTT function, the floor control server interface: + +1. shall use the value at the end of the Track Info field to identify the floor participant interface; +2. if: + - a. the Track Info field only contains one value, shall remove the Track Info field from the outgoing Floor Revoke message; and + - b. if the Track Info field contains more than one value, shall remove the last value from the Track Info field; and +3. shall forward the Floor Revoke message to the floor participant interface. + +#### 6.5.4.11 Receive Floor Queue Position Info message + +Upon receiving a Floor Queue Position Info message from the controlling MCPTT function, the floor control server interface: + +1. shall use the value at the end of the Track Info field to identify the floor participant interface; +2. if: + - a. the Track Info field only contains one value, shall remove the Track Info field from the outgoing Floor Granted message; and + - b. if the Track Info field contains more than one value, shall remove the last value from the Track Info field; and +3. shall forward the Floor Queue Position Info message to the floor participant interface. + +#### 6.5.4.12 Receive RTP media packets from controlling MCPTT function + +Upon receiving an indication from the media distributor that RTP media packets are received from the controlling MCPTT function, the floor control server interface: + +1. if a SSRC of granted floor participant associated with a dual floor is not stored shall request the network media distributor to forward received RTP media packets to all MCPTT clients in the session controlled by the non-controlling MCPTT function where the SSRC of the received RTP media packets are different to SSRC used by an MCPTT client; + +NOTE: If one of the MCPTT client controlled by the non-controlling MCPTT function is granted the floor, media originated from that MCPTT client is not distributed back to the MCPTT client granted the floor. + +2. if a SSRC of granted floor participant associated with a dual floor is stored and if the SSRC in the media packet is not the same as the stored SSRC, shall request the network media distributor to forward received RTP media packets to MCPTT clients controlled by the non-controlling MCPTT function: + - i. where the SSRC of the received RTP media packets are different to SSRC used by the MCPTT client; and + - ii. that are not only listening to the dual floor according to local policy; and +3. if a SSRC of granted floor participant associated with a dual floor is stored and if the SSRC in the media packet is the same as the stored SSRC, shall request the network media distributor to forward received RTP media packets to all MCPTT client: + - i. where the SSRC of the received RTP media packets are different to SSRC used by the MCPTT client; and + - ii. listening to the dual floor according to local policy. + +#### 6.5.4.13 Receive RTP media packets from an MCPTT client + +Upon receiving an indication from the media distribution function that RTP media packets are received from one of the network media interfaces, the floor control server interface: + +1. shall request the network media distributor to forward received RTP media packets towards the controlling MCPTT function. + +NOTE: If RTP media packets are received from an MCPTT client not permitted to send media, the floor participant interface will send a Floor Revoke message to the floor participant of the misbehaving MCPTT client without involving the floor control server interface. + +#### 6.5.4.14 MCPTT session release step 1 + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane e.g. when the session is going to be released, the floor control interface: + +1. shall ignore floor control message from the floor control server; +2. shall request the media distributor to stop distributing RTP media packets to the network media interface of the MCPTT clients; and + +3. shall ignore any floor control messages received from the floor participant interfaces. + +#### 6.5.4.15 MCPTT session release step 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control server interface: + +1. shall release all resources associated with this session. + +#### 6.5.4.16 Receiving a split instruction (R: Split) + +Upon receiving an instruction from the application and signalling plane to split the ongoing group session, as specified in 3GPP TS 24.379 [2] in subclause 10.1.1.5.2.4 for prearranged group call and in subclause 10.1.2.5.1.4 for chat group call, the floor control server interface: + +1. shall perform the actions in subclause 6.3.2.3. + +#### 6.5.4.17 Receive Floor Release Multi Talker message + +Upon receiving a Floor Release Multi Talker message sent from the controlling MCPTT function, the floor control server interface: + +1. shall use the value at the end of the Track Info field to identify the floor participant interface; +2. if: + - a. the Track Info field only contains one value, shall remove the Track Info field from the outgoing Floor Release Multi Talker message; and + - b. the Track Info field contains more than one value, shall remove the last value from the Track Info field; and +3. shall forward the Floor Release Multi Talker message to the floor participant interface. + +### 6.5.5 Floor participant interface procedures + +#### 6.5.5.1 General + +The floor participant interface shall behave according to the state diagram and state transitions specified in this subclause. + +Figure 6.5.5.1-1 shows the general floor control operation states (P states) and the state transition diagram. + +![State transition diagram for the floor participant interface. States: Start-stop, Releasing, Any state, P: has permission, P: has no permission. Transitions include R: MCPTT call release - 1, R: MCPTT call release - 2, R: Floor Ack, Participant invited to session, R: Split, R: Floor Idle OR R: Floor Taken, R: Floor Granted, R: RTP media OR R: Floor Release OR R: Floor Ack OR R: Floor Revoke OR R: Floor Taken Or R: Floor Release Multi Talker, R: Floor Idle OR R: Floor Taken OR R: Floor Request OR R: Floor Deny OR R: Floor Queue Position Info OR R: Floor Queue Position Request OR R: RTP media OR R: Floor Release OR R: Floor Release Multi Talker.](cc7baa8e5118f4b42c01166637c738ea_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Start-stop + Start-stop --> Releasing : R: MCPTT call release - 2 + Releasing --> Start-stop : R: MCPTT call release - 1 + Releasing --> Any state : R: Floor Ack + Start-stop --> P: has permission : R: Split + Start-stop --> P: has no permission : Participant invited to session + P: has permission --> Start-stop : R: Split + P: has permission --> P: has no permission : R: Floor Idle OR R: Floor Taken + P: has no permission --> P: has permission : R: Floor Granted + P: has permission --> [*] : R: RTP media OR R: Floor Release OR R: Floor Ack OR R: Floor Revoke OR R: Floor Taken Or R: Floor Release Multi Talker + P: has no permission --> [*] : R: Floor Idle OR R: Floor Taken OR R: Floor Request OR R: Floor Deny OR R: Floor Queue Position Info OR R: Floor Queue Position Request OR R: RTP media OR R: Floor Release OR R: Floor Release Multi Talker + +``` + +State transition diagram for the floor participant interface. States: Start-stop, Releasing, Any state, P: has permission, P: has no permission. Transitions include R: MCPTT call release - 1, R: MCPTT call release - 2, R: Floor Ack, Participant invited to session, R: Split, R: Floor Idle OR R: Floor Taken, R: Floor Granted, R: RTP media OR R: Floor Release OR R: Floor Ack OR R: Floor Revoke OR R: Floor Taken Or R: Floor Release Multi Talker, R: Floor Idle OR R: Floor Taken OR R: Floor Request OR R: Floor Deny OR R: Floor Queue Position Info OR R: Floor Queue Position Request OR R: RTP media OR R: Floor Release OR R: Floor Release Multi Talker. + +**Figure 6.5.5.1-1: The 'floor participant interface state transition' state diagram** + +The floor participant interface shall keep one instance of the 'floor participant interface state transition' state machine per MCPTT client in a session. + +The floor participant associated to the 'floor participant interface state transition' state machine is in the following subclauses referred to as the associated floor participant. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following subclauses the floor participant interface: + +1. shall discard the floor control message; +2. shall request the network media interface to discard any received RTP media packet; and +3. shall remain in the current state. + +State details are explained in the following subclauses. + +## 6.5.5.2 State: 'Start-Stop' + +### 6.5.5.2.1 General + +When a new instance of the 'Floor participant interface state transition' state machine is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly when the session is released the state machine shall return to the 'Start-stop' state. + +### 6.5.5.2.2 Participant invited to session + +When the floor participant interface receives an indication from the floor control server interface that an MCPTT client has accepted the invitation to a session (i.e. when the SIP 200 (OK) response to the initial SIP INVITE request is received as specified in 3GPP TS 24.379 [2]) , the floor participant interface: + +1. shall enter the 'P: has no permission' state. + +### 6.5.5.3 State: 'P: has no permission' + +#### 6.5.5.3.1 General + +The floor participant interface uses this state when the associated floor participant is not permitted to send media. + +#### 6.5.5.3.2 Receive Floor Idle message (R: Floor Idle) + +When the floor participant interface receives a Floor Idle message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Idle message to the floor participant; +2. if the first bit in the subtype of the Floor Idle message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2, shall store an indication that a Floor Ack message to a Floor Idle messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.3 Receive Floor Taken message (R: Floor Taken) + +When the floor participant interface receives a Floor Taken message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Taken message to the floor participant; +2. if the first bit in the subtype of the Floor Taken message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2, shall store an indication that a Floor Ack message to a Floor Taken messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.4 Receive Floor Request message (R: Floor Request) + +When the floor participant interface receives a Floor Request message from the floor participant, the floor participant interface: + +1. shall send the Floor Request message to the floor control server interface; and +2. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.5 Receive Floor Granted message (R: Floor Granted) + +When the floor participant interface receives a Floor Granted message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Granted message to the floor participant; +2. if the first bit in the subtype of the Floor Granted message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2, shall store an indication that a Floor Ack message to a Floor Granted messages is expected; and +3. shall enter the 'P: has permission' state. + +#### 6.5.5.3.6 Receive Floor Deny message (R: Floor Deny) + +When the floor participant interface receives a Floor Deny message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Deny message to the floor participant; +2. if the first bit in the subtype of the Floor Deny message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2, shall store an indication that a Floor Ack message to a Floor Deny messages is expected; and + +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.7 Receive Floor Queue Position Info message (R: Floor Queue Position Info) + +When the floor participant interface receives a Floor Queue Position Info message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Queue Position Info message to the floor participant; +2. if the first bit in the subtype of the Floor Queue Position Info message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2, shall store an indication that a Floor Ack message to a Floor Queue Position Info messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.8 Receive Floor Queue Position Request message (R: Floor Queue Position Request) + +When the floor participant interface receives a Floor Queue Position Request message from the floor participant, the floor participant interface: + +1. shall send the Floor Queue Position Request message to the floor control server interface; and +2. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.9 Receive RTP media packets (R: RTP media) + +When the floor participant interface receives an indication from the network media interface that RTP media packets are received from the media distributor, the floor participant interface + +1. shall instruct the network media interface to send the received RTP media packets towards the MCPTT client; and +2. shall remain in the 'P: has no permission' state. + +When the floor participant interface receives an indication from the network media interface that RTP media packets are received from the MCPTT client, the floor participant interface + +1. shall send a Floor Revoke message to the floor participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the value set to #3 (No permission to send a Media Burst); +2. shall store that a Floor Release message is expected from the floor participant; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.10 Receive Floor Release message (R: Floor Release) + +When the floor participant interface receives a Floor Release message from the floor participant, the floor participant interface: + +1. if a Floor Release message is not expected from the floor participant: + - a. if the first bit in the subtype of the Floor Release message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2, based on local policy: + - i shall send a Floor Ack message to the floor participant and set the first bit in the subtype of the Floor Release message to '0' (acknowledgement is not required) in the outgoing Floor Release message; or + - ii. wait for the Floor Ack from the floor control server; and + - b. shall forward the Floor Release message to the floor control server interface; + +2. if a Floor Release message is expected from the floor participant: + - a. if the first bit in the subtype of the Floor Release message is set to '1' (acknowledgement is required) as specified in subclause 8.2.2: + - i. shall send a Floor Ack message to the floor participant; and + - b. shall remove that a Floor Release message is expected from the floor participant; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.11 Receive split instruction (R: Split) + +Upon receiving an instruction to split the ongoing MCPTT call, to the floor participant interface: + +1. shall create a new instance of the 'basic floor control operation towards the floor participant' state machine; +2. shall move information associated with the instance used for 'floor participant interface state transition' to the 'basic floor control operation towards the floor participant' state machine; + +NOTE: Which information that needs to be moved is an implementation option. + +3. shall enter the 'Start-stop' state and terminate the 'floor participant state transition' state machine associated with this floor participant and this session; +4. if the state in 'general floor control operation' state machine is 'G: Floor Idle' state; shall enter the 'U: not permitted and Floor Idle' state as specified in subclause 6.3.5.3.2; and +5. if the state in 'general floor control operation' state machine is 'G: Floor Taken' state; shall enter the 'U: not permitted and Floor Taken' state as specified in subclause 6.3.5.4.2. + +#### 6.5.5.3.12 Receive Floor Release Multi Talker message + +When the floor participant interface receives a Floor Release Multi Talker message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Release Multi Talker message to the floor participant; and +2. shall remain in the 'P: has no permission' state. + +### 6.5.5.4 State: 'P: has permission' + +#### 6.5.5.4.1 General + +The floor participant interface uses this state when the floor participant has permission to send media + +#### 6.5.5.4.2 Receive RTP media packets + +When the floor participant interface receives an indication from the network media interface that RTP media packets are received from the MCPTT client, the floor participant interface: + +1. shall instruct the media interface to forward received RTP media packets towards the media distributor; and +2. shall remain in the 'P: has permission' state. + +#### 6.5.5.4.3 Receive Floor Release message + +When the floor participant interface receives a Floor Release message from the floor participant, the floor participant interface: + +1. shall send the Floor Release message to the floor control server interface; and + +3. shall remain in the 'P: has permission' state. + +#### 6.5.5.4.4 Receive Floor Ack message + +When the floor participant interface receives a Floor Ack message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Ack message to the floor participant; and +2. shall remain in the 'P: has permission' state. + +#### 6.5.5.4.5 Receive Floor Idle message + +When the floor participant interface receives a Floor Idle message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Idle message to the floor participant; +2. if the first bit in the subtype of the Floor Idle message is set to '1' (acknowledgement is required), shall store an indication that a Floor Ack message to a Floor Idle messages is expected; and +3. shall enter the 'P: has no permission' state. + +#### 6.5.5.4.6 Receive Floor Taken message + +When the floor participant interface receives a Floor Taken message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Taken message to the floor participant; +2. if the first bit in the subtype of the Floor Taken message is set to '1' (acknowledgement is required), shall store an indication that a Floor Ack message to a Floor Taken messages is expected; and +3. if the Floor Indicator field is included and the I-bit is set to '1' (multi-talker) shall remain in the 'P: has permission' state, otherwise shall enter the 'P: has no permission' state. + +#### 6.5.5.4.7 Receive Floor Revoke message + +When the floor participant interface receives a Floor Revoke message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Revoke message to the floor participant; +2. if the first bit in the subtype of the Floor Revoke message is set to '1' (acknowledgement is required), shall store an indication that a Floor Ack message to a Floor Revoke messages is expected; and +3. shall remain in the 'P: has permission' state. + +#### 6.5.5.4.8 Receive split instruction (R: Split) + +Upon receiving an instruction to split the ongoing MCPTT call, the floor participant interface: + +1. shall create a new instance of the 'basic floor control operation towards the floor participant' state machine as specified in subclause 6.3.5; +2. shall move information associated with the instance used for 'floor participant interface state transition' to the 'basic floor control operation towards the floor participant' state machine; + +NOTE: Which information that needs to be moved is an implementation option. + +3. shall enter the 'Start-stop' state and terminate the 'floor participant state transition' state machine associated with this floor participant and this session; and + +4. shall enter the 'U: permitted' state as specified in subclause 6.3.5.5.2. + +#### 6.5.5.4.9 Receive Floor Release Multi Talker message + +When the floor participant interface receives a Floor Release Multi Talker message from the floor control server interface, the floor participant interface: + +1. shall send the Floor Release Multi Talker message to the floor participant; and +2. shall remain in the 'P: has permission' state. + +#### 6.5.5.5 In any state + +##### 6.5.5.5.1 General + +This subclause describes the actions to be taken in all states defined for the 'floor participant state transition' diagram with the exception of the 'Start-stop' and 'Releasing' states. + +##### 6.5.5.5.2 Receive Floor Ack message (R: Floor Ack) + +If a Floor Ack message is received from the floor participant, the floor participant interface: + +1. if an indication exists that a Floor Ack message is expected for the message in the Message Type field; + - a. shall forward the Floor Ack message to the floor control server interface; and + - b. shall remove the indication that a Floor Ack message is expected for the message in the Message Type field; and + +NOTE: It is an implementation option what action to take if an indication exists that a Floor Ack message is expected for the message in the Message Type field, but the Floor Ack message is not received + +2. shall remain in the current state. + +If a Floor Ack message is received from the floor control server interface, the floor participant interface: + +1. shall send the Floor Ack message to the floor participant; and +2. shall remain in the current state. + +##### 6.5.5.5.3 MCPTT session release step 1 (MCPTT call release - 1) + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane e.g. when the session is going to be released or when the MCPTT client leaves the session, the floor participant interface: + +1. shall stop sending floor control messages to the floor participant; +2. shall request the network media interface to stop sending RTP media packets towards to the MCPTT client; +3. shall ignore any floor control messages received from the floor participant; +4. shall request the network media interface to stop forwarding RTP media packets from the MCPTT client to the media distributor; +5. shall indicate to the floor control server interface that the MCPTT client has started to disconnect from the session; and +6. shall enter the 'P: Releasing' state. + +### 6.5.5.6 State: 'P: Releasing' + +#### 6.5.5.6.1 General + +The floor participant interface uses this state while waiting for the application and signalling plane to finalize the release of the session or finalizing the removal of the MCPTT client from the session. + +#### 6.5.5.6.2 MCPTT session release step 2 (MCPTT call release - 2) + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor participant interface: + +1. shall request the network media interface to release all resources associated with this MCPTT client for this MCPTT call; and +2. shall enter the 'Start-stop' state and terminate the 'floor participant state transition' state machine associated with this floor participant and this session. + +--- + +## 7 Off-network floor control + +### 7.1 General + +A floor control session may be initiated only if there is a successfully established off-network call. + +In off-network, floor control is performed using floor control messages among the MCPTT clients without a centralized floor arbitrator. When off-network, if a floor control session is active, the floor arbitrator and the floor participant are co-located in the MCPTT client (see 3GPP TS 23.379 [5]). During a floor control session the MCPTT client currently speaking serves as the temporary floor arbitrator. All other MCPTT clients in the call play the role of floor participant. When the floor arbitrator grants the floor to another MCPTT client, that new MCPTT client, when starts to send media, becomes the new floor arbitrator and the former (the MCPTT client which granted the floor) becomes a floor participant. + +The procedures in subclause 7.2 are from the perspective of a single MCPTT client. No special message other than floor control messages and media is used for coordinating the floor arbitrator and floor participant status of the separate MCPTT clients participating in the off-network call. + +The floor control messages are always sent to all the participants of the call. Therefore they can be monitored by any MCPTT client listening to the call. + +In a floor control session queueing of floor requests may be supported. + +It is assumed that the MCPTT user presses the PTT button for requesting talk permission and keeps it pressed until the request is resolved. If queueing of floor requests is not supported, this request is either granted or rejected or no answer is received. If the request is granted the user is notified with talk permission tone (or equivalent) and the user continues to press the PTT until the user finishes the talk burst. If the request is rejected or no answer is received the user is notified and releases the PTT button. + +If queueing of floor requests is supported, the MCPTT user shall be notified when a floor request is queued and the MCPTT user shall release the PTT button. When, after queueing, the floor is granted to this user the MCPTT user shall be informed that the queued request is now granted. Then the MCPTT user should press the PTT button within a short duration. Otherwise, the grant is taken from this MCPTT user. An MCPTT user can appear in a queue only once. The floor request queue is transferred from the former to the new floor arbitrator. + +After the initiation of a floor control session the MCPTT client behaves according to the state machine presented in subclause 7.2.3. The state machine is designed such that in normal cases only one of the MCPTT clients, which participates in the call, acts as floor arbitrator and all others act as floor participants. However, there may be situations such that more than one MCPTT client are at an internal state causing them to act as floor arbitrator. A short sequence of floor control messages and RTP media packets are initiated to resolve these situations. + +## 7.2 Floor participant procedures + +### 7.2.1 Floor participant procedures at MCPTT session initialization + +This subclause applies when no active floor control session exists. + +Before a floor control entity is initiated a state machine with a single state, named as 'Start-stop' state, shall exist. At 'Start-stop' state, when the MCPTT client receives a request of the MCPTT call control entity to initiate the floor control as originating client, then the MCPTT client shall initiate a floor control entity and the floor control entity shall enter into the 'O: has permission' state. Otherwise, if MCPTT client receives a request of the MCPTT call control entity to initiate the floor control as terminating client, then the MCPTT client shall initiate a floor control entity and the floor control entity for an MCPTT group call shall enter into the 'O: silence' state or for both MCPTT private call and MCPTT broadcast call shall enter the 'O: has no permission' state. + +Once the session is initiated, the initial floor control messages are sent according to the state machine presented in subclause 7.2.3. Normally, once the session is started the originating MCPTT client has the floor implicitly. For an on-going off-network group call, if an MCPTT client joins later, then it starts the floor control session and takes the role of floor participant and enters 'O: silence' state. + +#### 7.2.1.2 Determine off-network floor priority + +Upon receiving a Floor Request message, to determine the floor priority of the Floor Request message, the floor arbitrator: + +1. shall check the presence of Floor Priority field in the received Floor Request message. If present, the floor arbitrator: + - a. shall determine the floor priority of the Floor Request message by choosing the lowest value from the following inputs: + - i. the value of the Floor Priority field in the received Floor Request message; + - ii. the value of the "/Common/MCPTTGroupMemberList//UserPriority" leaf node of the sender of the Floor Request message, present in group configuration as specified in 3GPP TS 24.483 [4]; and + - iii. the value of the "/OffNetwork/NumLevelHierarchy" leaf node present in service configuration as specified in 3GPP TS 24.483 [4]; and +2. if the Floor Priority field is not present in the Floor Request message, the floor arbitrator: + - a. shall use the minimum value allowed for the Floor Priority as floor priority of the Floor Request message. + +Once the floor priority of the Floor Request message is determined, to determine the effective priority of the Floor Request message, the floor arbitrator: + +1. shall check the type of call indicated by the Floor Indicator field of the received Floor Request message and: + - a. if the type of call indicated by the Floor Indicator field is Normal call: + - i. if the current type of the call is normal, shall continue to check the next input parameter from step 2; and + - ii. if the current type of the call is emergency or imminent-peril and: + - A. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true", shall queue the floor request; + - B. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false", shall deny the floor request; and + - C. shall skip step 2; + - b. if the type of call indicated by the Floor Indicator field is Imminent peril call and: + +- i. if the current type of the call is normal, shall pre-empt the current talker, grant the floor request and skip step 2; + - ii. if the current type of the call is imminent-peril, shall continue to check the next input parameter from step 2; and + - iii. if the current type of the call is emergency and: + - A. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true", shall queue the floor request; + - B. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false", shall deny the floor request; and + - C. shall skip step 2; and +- c. if the type of the call indicated by the Floor Indicator field is Emergency call and: +- i. if the current type of the call is normal or imminent-peril, shall pre-empt the current talker and grant the floor request; and + - ii. if the current type of the call is emergency and: + - A. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true", shall queue the floor request; + - B. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false", shall deny the floor request; and + - iii. shall skip step 2; and +2. shall compare the determined floor priority of the received Floor Request message to the effective priority of the current talker (determined at the time of floor grant to the current talker) and: +- a. if the effective priority of the current talker is equal to or higher than the determined floor priority of the Floor Request message and: + - i. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true", shall queue the floor request; and + - ii. if the value of "/OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false", shall deny the floor request; and + - b. if the determined floor priority of the Floor Request message is higher than that of the current talker, shall pre-empt the current talker and shall grant the floor request. + +## 7.2.2 Floor participant procedures at MCPTT call release + +This subclause applies when an active floor control session exists. + +When the off-network call is released the floor control session is terminated. The off-network floor control session can also be terminated when no media transmission or reception takes place during floor control session hold time, T230 (Inactivity). The termination of the floor control session as a result of the expiry of timer T230 (Inactivity) may terminate the call session. + +## 7.2.3 Floor participant state diagram – basic operation + +### 7.2.3.1 General + +The floor participant shall behave according to the state diagram and the transitions specified in this subclause. + +The received floor messages and the RTP media packets are inputs to the state machine according to their arrival order. They are not ignored unless otherwise stated. + +The MCPTT client also provides input to the state machine as request to talk (press PTT button) or as end of talk (release PTT button). + +Figure 7.2.3.1-1 show the 'Floor participant state diagram – basic operation'. + +![A state diagram for a floor participant. It consists of four yellow oval states: 'OFFERING REQUEST' (top left), 'OFFERED' (center), 'REQUEST GRANTED' (top right), and 'DISPATCHED' (bottom left). Transitions are indicated by arrows: a self-loop on 'OFFERING REQUEST', an arrow from 'OFFERING REQUEST' to 'OFFERED', an arrow from 'OFFERED' to 'REQUEST GRANTED', and an arrow from 'DISPATCHED' to a rectangular box on its right.](868ee7df1ec851f132ccf8c390de76a8_img.jpg) + +``` + +stateDiagram-v2 + [*] --> OFFERING_REQUEST + OFFERING_REQUEST --> OFFERING_REQUEST + OFFERING_REQUEST --> OFFERED + OFFERED --> REQUEST_GRANTED + DISPATCHED --> [ ] + +``` + +A state diagram for a floor participant. It consists of four yellow oval states: 'OFFERING REQUEST' (top left), 'OFFERED' (center), 'REQUEST GRANTED' (top right), and 'DISPATCHED' (bottom left). Transitions are indicated by arrows: a self-loop on 'OFFERING REQUEST', an arrow from 'OFFERING REQUEST' to 'OFFERED', an arrow from 'OFFERED' to 'REQUEST GRANTED', and an arrow from 'DISPATCHED' to a rectangular box on its right. + +**Figure 7.2.3.1-1: 'Floor participant state diagram – basic operation'** + +State details are explained in the following subclauses. + +If an RTP media packet or a floor control message arrives in a state where there is no specific procedure specified for the RTP media packet or the received floor control message, the floor participant shall discard the floor control message or the RTP media packet and shall remain in the current state. + +**NOTE:** A badly formatted RTP packet or floor control message received in any state is ignored by the floor participant and does not cause any change of the current state. + +### 7.2.3.2 State: 'Start-stop' + +#### 7.2.3.2.1 General + +When a new instance of the state machine is created, before any floor control related input is applied, the state machine is in the 'Start-stop' state. Similarly when the call is released or the floor control session is terminated, the state machine shall return to the 'Start-stop' state. + +#### 7.2.3.2.2 MCPTT call established – originating MCPTT user + +When an MCPTT call is established with session announcement including an explicit floor request, the originating floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. shall send Floor Granted message towards other floor participants. The Floor Granted message: + - a. shall include the granted priority in the Floor priority field; + - b. shall include the MCPTT user's own MCPTT ID in the User ID field; and + - c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +3. shall set the stored SSRC of the current floor arbitrator to its own SSRC; and +4. shall enter 'O: has permission' state. + +#### 7.2.3.2.3 MCPTT group call established – terminating MCPTT user + +When an MCPTT call is established the terminating floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. shall start timer T230 (Inactivity); and +3. shall enter 'O: silence' state. + +#### 7.2.3.2.4 MCPTT private call established – terminating MCPTT user + +When an MCPTT private call is established the terminating floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. shall start timer T203(End of RTP media); and +3. shall enter 'O: has no permission' state. + +#### 7.2.3.2.5 Send Floor Request message (PTT button pressed) + +If the floor participant receives an indication from the MCPTT user to send media, the floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. shall send the Floor Request message to other floor participants. The Floor Request message: + - a. if a different priority than the normal priority is required, shall include the Floor Priority field with the requested priority in the value; + - b. shall include the MCPTT ID of the MCPTT user in the value of the User ID field; and + - c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; + +3. shall initialize the counter C201 (Floor request) with value set to 1; +4. shall start the timer T201 (Floor request); and +5. shall enter 'O: pending request' state. + +#### 7.2.3.2.6 Receive Floor Taken message (R: Floor Taken) + +When a Floor Taken message is received, the floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. may provide a floor taken notification to the MCPTT user; +3. shall set the stored SSRC of the current floor arbitrator to the SSRC of granted floor participant field in the Floor Taken message; +4. shall start timer T203 (End of RTP media); and +5. shall enter 'O: has no permission' state. + +#### 7.2.3.2.7 Receive Floor Granted message (R: Floor Granted to other) + +When a Floor Granted message is received and if the User ID in the Floor Granted message does not match its own User ID, the floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. may provide a floor taken notification to the MCPTT user; +3. shall set the stored SSRC of the candidate floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +4. shall start timer T203 (End of RTP media); and +5. shall enter 'O: has no permission' state. + +#### 7.2.3.2.8 Receive RTP media (R: RTP media) + +Upon receiving RTP media packets, the floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. may provide a floor taken notification to the MCPTT user; +3. shall set the stored SSRC of the current floor arbitrator to the SSRC of RTP media packet; +4. shall restart timer T203 (End of RTP media); +5. shall request the MCPTT client to start rendering received RTP media packets; and +6. shall enter 'O: has no permission' state. + +#### 7.2.3.2.9 MCPTT broadcast call established – terminating MCPTT user + +When an MCPTT broadcast call is established the terminating floor participant: + +1. shall create an instance of a floor participant state transition diagram for basic operation state machine; +2. shall start timer T203 (End of RTP media); and +3. shall enter 'O: has no permission' state. + +NOTE: In MCPTT broadcast call, only originating MCPTT user is allowed to request floor and transmit media. A Floor Request message is locally denied to terminating MCPTT user, if requested. + +### 7.2.3.3 State: 'O: silence' + +#### 7.2.3.3.1 General + +When in this state the MCPTT client for the session is unaware of any MCPTT client acting as a floor arbitrator, has not itself initiated a floor control request and is not currently receiving RTP media packets. + +Timer T230 (Inactivity) is running in this state. + +#### 7.2.3.3.2 Send Floor Request message (PTT button pressed) + +If the floor participant receives an indication from the MCPTT user to send media, the floor participant: + +1. shall send the Floor Request message to other floor participants. The Floor Request message: + - a. if a priority different than the default floor priority is required, shall include the Floor Priority field with the requested priority in the element; + - b. shall include the MCPTT ID of the MCPTT user in the value of the User ID field; and + - c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +2. shall initialize the counter C201 (Floor request) with value set to 1; +3. shall stop timer T230 (Inactivity); +4. shall start timer T201 (Floor Request); and +5. shall enter 'O: pending request' state. + +#### 7.2.3.3.3 Receive RTP media (R: RTP media) + +Upon receiving RTP media packets and if there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. may provide a floor taken notification to the MCPTT user; +2. shall stop timer T230 (Inactivity); +3. shall set the stored SSRC of the current floor arbitrator to the SSRC of RTP media packet; +4. shall restart (or start, if not running already) timer T203 (End of RTP media); +5. shall request the MCPTT client to start rendering received RTP media packets; and +6. shall enter 'O: has no permission' state. + +Otherwise, if SSRC of floor participant sending the media matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall restart (or start, if not running already) timer T203 (End of RTP media); +2. shall stop timer T230 (Inactivity); +3. shall request the MCPTT client to start rendering received RTP media packets; and +4. shall enter 'O: has no permission' state. + +#### 7.2.3.3.4 Receive Floor Granted message (R: Floor Granted to other) + +When a Floor Granted message is received and if the User ID in the Floor Granted message does not match its own User ID, the floor participant: + +1. may provide a floor taken notification to the MCPTT user; +2. if the Floor Indicator field is included and the B-bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating that this is a broadcast group call; +3. shall set the stored SSRC of the candidate floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +4. shall stop timer T230 (Inactivity); +5. shall start timer T203 (End of RTP media); and +6. shall enter 'O: has no permission' state. + +#### 7.2.3.3.5 Receive Floor Request message (R: Floor Request) + +The transition is used in private call only. When a Floor Request message is received, the floor participant: + +1. shall send a Floor Granted message toward the other floor participant. The Floor Granted message: + - a. shall include the MCPTT ID of the Floor Request message received in User ID value of the User ID field; + - b. shall include the SSRC of the Floor Request message received in the SSRC of floor control server field; + - c. shall include the max duration as configured in the MCPTT client in the OffNetwork/MaxDuration parameter in the value of the Duration field; and + - d. shall include the priority of the Floor Request message received in the value of the Floor Priority field; +2. shall stop timer T230 (Inactivity); +3. shall start timer T205 (Floor Granted ); and +4. shall enter 'O: pending granted' state. + +#### 7.2.3.3.6 Receive Floor Taken message (R: Floor Taken) + +When a Floor Taken message is received, the floor participant: + +1. may provide a floor taken notification to the MCPTT user; +2. shall set the stored SSRC of the current floor arbitrator to the SSRC of granted floor participant field in the Floor Taken message; +3. shall stop timer T230 (Inactivity); +4. shall start timer T203 (End of RTP media); and +5. shall enter 'O: has no permission' state. + +#### 7.2.3.3.7 Timer T230 (Inactivity) expired + +Upon expiry of timer T230 (Inactivity), the floor participant: + +1. shall indicate to the call control that timer T230 (inactivity) has expired; +2. shall terminate the instance of floor participant state transition diagram; and +3. shall enter 'Start-stop' state. + +### 7.2.3.4 State: 'O: has no permission' + +#### 7.2.3.4.1 General + +In this state the MCPTT client does not have permission to send media. + +#### 7.2.3.4.2 Sending Floor Request message (PTT button pressed) + +If the floor participant receives an indication from the MCPTT user that the MCPTT user wants to send media, the floor participant: + +1. shall send the Floor Request message to other clients. The Floor Request message: + - a. if a priority different than the default floor priority is required, shall include the Floor Priority field with the requested priority in the element; + - b. shall include the MCPTT ID of the MCPTT user in the User ID field; and + - c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +2. shall initialize the counter C201 (Floor request) with value set to 1; +3. shall start timer T201 (Floor Request); and +4. shall enter 'O: pending request' state. + +#### 7.2.3.4.3 Receive Floor Release message (R: Floor Release) + +When a Floor Release message is received and if the SSRC in the Floor Release message matches with the stored SSRC of the current arbitrator or with the stored SSRC of the candidate arbitrator, the floor participant: + +1. may provide floor idle notification to the MCPTT user. +2. shall request the MCPTT client to stop rendering received RTP media packets; +3. shall stop timer T203 (End of RTP media); +4. shall start timer T230 (Inactivity); +5. shall clear the stored SSRC of the candidate arbitrator; +6. shall clear the stored SSRC of the current floor arbitrator; and +7. shall enter 'O: silence' state; + +#### 7.2.3.4.4 Timer T203 (End of RTP media) expired + +On expiry of T203 (End of RTP media) timer, the floor participant: + +1. may provide floor idle notification to the MCPTT user. +2. shall request the MCPTT client to stop rendering received RTP media packets; +3. shall start timer T230 (Inactivity); +4. shall clear the stored SSRC of the current floor arbitrator; and +5. shall enter 'O: silence' state; + +#### 7.2.3.4.5 Receive Floor Granted message (R: Floor Granted to other) + +When a Floor Granted message is received and if the value in the User ID field does not match its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall restart timer T203 (End of RTP media); +3. shall set the stored SSRC of the candidate floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +4. may provide a floor taken notification to the MCPTT user; +5. if the Floor Indicator field is included with the B-bit set to '1' (Broadcast group call), shall provide a notification to the user indicating that this is a broadcast group call; and +6. shall remain in the 'O: has no permission' state. + +#### 7.2.3.4.6 Receive RTP media (R: RTP media) + +Upon receiving RTP media packets and if there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to render the received RTP media packets; +2. shall set the stored SSRC of the current floor arbitrator to the SSRC of RTP media packet; +3. shall clear the stored SSRC of the candidate arbitrator, if any; +4. shall restart timer T203 (End of RTP media); and +5. shall remain in 'O: has no permission' state. + +Otherwise, if SSRC of floor participant sending the media matches the stored SSRC of current arbitrator, the floor participant: + +1. shall request the MCPTT client to render the received RTP media packets; +2. shall clear the stored SSRC of the candidate arbitrator, if any; +3. shall restart timer T203 (End of RTP media); and +4. shall remain in 'O: has no permission' state. + +Otherwise, if SSRC of floor participant sending the media packet matches with the stored SSRC of candidate arbitrator, the floor participant: + +1. shall request the MCPTT client to render the received RTP media packets; +2. shall set the stored SSRC of the current arbitrator to the SSRC of RTP media packet; +3. shall clear the stored SSRC of the candidate arbitrator; +4. shall restart timer T203 (End of RTP media); and +5. shall remain in 'O: has no permission' state. + +#### 7.2.3.5 State: 'O: has permission' + +##### 7.2.3.5.1 General + +In this state the MCPTT client is acting as a floor control server (floor arbitrator) and has the permission to send media. + +Timer T206 (Stop talking warning) and timer T207 (Stop Talking) are running in this state. + +#### 7.2.3.5.2 Send RTP Media packets (S: RTP Media) + +Upon receiving encoded media from the user or if encoded media is already buffered the floor participant: + +1. shall start timer T206 (Stop talking warning), if not running; +2. shall request the MCPTT client to start sending RTP media packets towards other MCPTT clients; and +3. shall remain in 'O: has permission' state. + +#### 7.2.3.5.3 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message and if the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true", the floor participant: + +1. shall remove the sender of the Floor Release message from the queue, if the value in the floor release message matches the value of the queued request; and +2. shall remain in 'O: has permission' state. + +#### 7.2.3.5.4 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message which is not pre-emptive as determined by subclause 4.1.1.5, in a session where: + +1. the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false"; or +2. the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true" but the F-bit in the Floor Indicator field is set to '0' (i.e. indicating that queueing of floor requests is not supported) or the Floor Indicator field is not included in the Floor Request message; + +then the floor participant: + +1. shall send the Floor Deny message. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - c. shall include the User ID field received in the Floor Request message; and +2. shall remain in 'O: has permission' state. + +Upon receiving a Floor Request message which is not pre-emptive as determined by subclause 4.1.1.5, and the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true" and the F-bit in the Floor Indicator field is set to '1' (i.e. indicating that queueing of the floor requests is supported) in the Floor Request message, the floor participant: + +1. if the Floor Request message is not already stored, then shall store the received Floor Request message; +2. if the pending request queue is not full, shall send the Floor Queue Position Info message. The Floor Queue Position Info message: + - a. shall include in the User ID field the MCPTT ID of the floor participant sending the Floor Request message; + - b. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - c. shall include the position in the floor request queue in the Queue Info field; and + - d. shall include the floor priority in the Queue Info field; + +3. if the pending request queue is full, shall send the Floor Deny message. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #7 (Queue full); + - b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - c. shall include the User ID field received in the Floor Request message; and +4. shall remain in 'O: has permission' state. + +#### 7.2.3.5.5 Send Floor Release message (PTT button released with no pending request in queue) + +Upon receiving an indication from the MCPTT user to release permission to send RTP media, the floor participant: + +1. shall stop timer T206 (Stop talking warning), if running; +2. shall stop timer T207 (Stop talking), if running; +3. shall send a Floor Release message towards other floor participants, if no queued requests exist: The Floor Release message: + - a. shall include the MCPTT ID of the MCPTT user in the User ID field; and + - b. if the session is not initiated as a broadcast group call with the B-bit set to '1' (Broadcast group call), shall include a Floor Indicator field set to '0' (normal call); +4. shall start timer T230 (Inactivity); +5. shall clear the stored SSRC of the current floor arbitrator; and +6. shall enter 'O: silence' state. + +#### 7.2.3.5.6 Send Floor Granted message (PTT button released with pending request(s) in queue) + +When no more encoded media is received from the user and if at least one Floor Request message is stored (i.e. queueing mode is used in the session), the floor participant: + +1. shall stop timer T206 (Stop talking warning), if running; +2. shall stop timer T207 (Stop talking), if running; +3. shall request the MCPTT client to stop sending RTP media packets towards other MCPTT clients; +4. shall send the Floor Granted message toward the other floor participants. The Floor Granted message: + - a. shall include the MCPTT ID of the first floor participant in the queue in the User ID field; + - b. shall include the SSRC of the first floor participant in the queue in the SSRC of the granted floor participant field; + - c. shall remove the first floor participant from the queue; + - d for the remaining floor participants in the queue: + - i. shall include the MCPTT ID of the floor participant in the Queued User ID field; + - ii. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - iii. shall include the queue position of the floor participant in the Queue Info field; and + - iv. shall include the priority of the floor participant in the Queue Info field; and + +- e. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +- 5. shall set the stored SSRC of the current floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +- 6. shall start timer T205 (Floor Granted ) and shall initiate counter C205 (Floor Granted ) to 1; and +- 7 shall enter the 'O: pending granted' state. + +#### 7.2.3.5.7 Receive Floor Request message with pre-emption indication (R: Floor Request with pre-emption) + +Upon receiving a Floor Request message which is pre-emptive as determined by subclause 4.1.1.5, the floor participant: + +- 1. shall stop timer T206 (Stop talking warning), if running; +- 2. shall stop timer T207 (Stop talking), if running; +- 3. shall request the MCPTT client to stop sending RTP media packets towards other MCPTT clients; +- 4. shall send a Floor Granted message towards the other floor participants. The Floor Granted message: + - a. shall include the MCPTT ID of the Floor Request message received in the User ID field; + - b. shall include the SSRC of floor participant sending the Floor Request message in the SSRC of floor control server field; and + - c. if the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "true", for each floor participant in the queue: + - i. shall include the MCPTT ID of the floor participant in the Queued User ID field; + - ii. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - iii. shall include the queue position of the floor participant in the Queue Info field; and + - iv. shall include the priority of the floor participant in the Queue Info field; +- 5. shall start timer T205 (Floor Granted) and shall initiate counter C205 (Floor Granted) to 1; +- 6. shall set the stored SSRC of the current floor arbitrator to the SSRC of the user to whom the floor was granted in the Floor Granted message; and +- 7. shall enter the 'O: pending granted' state. + +#### 7.2.3.5.8 Receive Floor Queue Position Request message (R: Floor Queue Position Request) + +Upon receiving a Floor Queue Position Request message, the floor participant: + +- 1. shall send the Floor Queue Position Info message. The Floor Queue Position Info message: + - a. shall include the floor participant's own MCPTT ID in the User ID field; + - b. shall include the queue position and floor priority in the Queue Info field; + - c. shall include the value of the SSRC of floor participant requesting floor queue status info field from the received Floor Queue Position Request message in the SSRC of queued floor participant field; and + - d. shall include the value of the User ID field from the received Floor Queue Position Request message in the Queued User ID field; and +- 2. remain in the 'O: has permission' state. + +#### 7.2.3.5.9 Transmission time limit warning (Timer T206 expires) + +When timer T206 (Stop talking warning) expires, the floor participant: + +1. may notify the MCPTT user that the transmission time limit is about to reach; +2. shall start timer T207 (Stop talking); and +3. shall remain in the current state. + +#### 7.2.3.5.10 Transmission time limit reached with pending request(s) in queue (Timer T207 expires) + +When the timer T207 (Stop talking) expires and if at least one Floor Request message is stored (i.e. queueing mode is used in the session), the floor participant: + +1. shall request the MCPTT client to stop sending RTP media packets towards other MCPTT clients; +2. shall send the Floor Granted message toward the other floor participants. The Floor Granted message: + - a. shall include the MCPTT ID of the first floor participant in the queue in the User ID field; + - b. shall include the SSRC of the first floor participant in the queue in the SSRC of the granted floor participant field; + - c. shall remove the first floor participant from the queue; + - d. for the remaining floor participants in the queue: + - i. shall include the MCPTT ID of the floor participant in the Queued User ID field; + - ii. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - iii. shall include the queue position of the floor participant in the Queue Info field; and + - iv. shall include the priority of the floor participant in the Queue Info field; and + - e. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +3. shall set the stored SSRC of the current floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +4. shall start timer T205 (Floor Granted ) and shall initiate counter C205 (Floor Granted ) to 1; and +5. shall enter the 'O: pending granted' state. + +#### 7.2.3.5.11 Transmission time limit reached with no pending request in queue (Timer T207 expires) + +When timer T207 (Stop talking) expires with no pending requests in the queue or if the value of "//OffNetwork/QueueUsage" leaf node present in the group configuration as specified in 3GPP TS 24.483 [4] is set to "false", the floor participant: + +1. shall send a Floor Release message towards other floor participants. The Floor Release message: + - a. shall include the MCPTT ID of the MCPTT user in the User ID field; and + - b. if the session is not initiated as a broadcast group call with the B-bit set to '1' (Broadcast group call), shall include a Floor Indicator field set to '0' (normal call); +2. shall start timer T230 (Inactivity); +3. shall clear the stored SSRC of the current floor arbitrator; and + +4. shall enter 'O: silence' state. + +### 7.2.3.6 State: 'O: pending request' + +#### 7.2.3.6.1 General + +In this state the MCPTT client is waiting for a response to a Floor request message. + +In this state timer T201 (Floor Request) is running. + +To resolve race condition between multiple simultaneous floor requests, the MCPTT client resets the counter associated with timer T201, if another floor request with higher priority or higher SSRC, in case the priority is same, is received. + +#### 7.2.3.6.2 Receive RTP media (R: RTP media) + +Upon receiving RTP media packets and if there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to render the RTP media packets; +2. shall reset the value of the counter C201 (Floor Request) to 1; +3. shall set the stored SSRC of the current floor arbitrator to the SSRC of RTP media packet; +4. shall restart (or start, if not running already) timer T203 (End of RTP media); and +5. shall remain in 'O: pending request' state. + +Otherwise, if SSRC of floor participant sending the media matches with the stored SSRC of current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to render the RTP media packets; +2. shall reset the value of the counter C201 (Floor Request) to 1; +3. shall restart (or start, if not running already) timer T203 (End of RTP media); and +4. shall remain in 'O: pending request' state. + +Otherwise, if SSRC of floor participant sending the media packet matches with the stored SSRC of candidate arbitrator, the floor participant: + +1. shall request the MCPTT client to render the RTP media packets; +2. shall reset the value of the counter C201 (Floor Request) to 1; +3. shall set the stored SSRC of the current arbitrator to the SSRC of RTP media packet; +4. shall clear the stored SSRC of the candidate arbitrator; +5. shall restart (or start, if not running already) timer T203 (End of RTP media); and +6. shall remain in 'O: pending request' state. + +#### 7.2.3.6.3 Receive Floor Queue Position Info message (R: Floor Queue Position Info) + +Upon receiving Floor Queue Position Info message, if the value in the Queued User ID field matches its own MCPTT ID and the value in the SSRC of floor control server field as received in the Floor Queue Position Info message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall update the queue status; +2. may notify the MCPTT user about the queue position received in the value in the Queue Info field; + +3. shall stop timer T201 (Floor Request); and +4. shall enter 'O: queued' state. + +Otherwise, if the value in the Queued User ID field matches its own MCPTT ID and there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. shall update the queue status; +2. shall set the stored SSRC of the current floor arbitrator to the value in the SSRC of floor control server field as received in the Floor Queue Position Info message; +3. may notify the MCPTT user about the queue position received in the value in the Queue Info field; +4. shall stop timer T201 (Floor Request); and +5. shall enter 'O: queued' state. + +Otherwise, if the value in the Queued User ID field matches its own MCPTT ID and the value in the SSRC of floor control server field as received in the Floor Queue Position Info message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall update the queue status; +2. shall set the stored SSRC of the current arbitrator to the value in the SSRC of the floor control server field as received in the Floor Queue Position Info message; +3. shall clear the stored SSRC of the candidate arbitrator; +4. may notify the MCPTT user about the queue position received in the value in the Queue Info field; +5. shall stop timer T201 (Floor Request); and +6. shall enter 'O: queued' state. + +#### 7.2.3.6.4 Receive Floor Deny message (R: Floor Deny) + +Upon receiving Floor Deny message, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Deny message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall stop the timer T201 (Floor Request); +2. shall provide floor deny notification to the user; +3. shall restart the timer T203 (End of RTP media); +4. may display the floor deny reason to the user using information in the Reject Cause field; and +5. shall enter 'O: has no permission' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. shall stop the timer T201 (Floor Request); +2. shall set the stored SSRC of the current floor arbitrator to the value in the SSRC of floor control server field as received in the Floor Deny message; +3. shall restart the timer T203 (End of RTP media); +4. shall provide floor deny notification to the user; +5. may display the floor deny reason to the user using information in the Reject Cause field; and + +6. shall enter 'O: has no permission' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Deny message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall stop the timer T201 (Floor Request); +2. shall set the stored SSRC of the current arbitrator to the SSRC of the floor control server as received in the Floor Deny message; +3. shall clear the stored SSRC of the candidate arbitrator; +4. shall restart the timer T203 (End of RTP media); +5. shall provide floor deny notification to the user; +6. may display the floor deny reason to the user using information in the Reject Cause field; and +7. shall enter 'O: has no permission' state. + +#### 7.2.3.6.5 Send Floor Release message (PTT button released) + +When an indication from the MCPTT user to release the pending request for the floor is received, the floor participant: + +1. shall send a Floor Release message towards other floor participants. The Floor Release message: + - a. shall include the MCPTT ID of the MCPTT user in the value of the User ID field; and + - b. if the session is not initiated as a broadcast group call with the B-bit set to '1' (Broadcast group call), shall include a Floor Indicator field set to '0' (normal call); +2. shall stop the timer T201 (Floor Request); +3. shall stop timer T203 (End of RTP media), if running; +4. shall start the timer T230 (Inactivity); +5. shall clear the stored SSRC of the current floor arbitrator; and +6. shall enter 'O: silence' state. + +#### 7.2.3.6.6 Send Floor Taken message (Timer T201 expired N times) + +When timer T201 (Floor Request) expires and counter C201 (Floor Request) reaches its upper limit, the floor participant: + +1. shall send the Floor Taken message toward the other floor participants. The Floor Taken message: + - a. shall include the floor participant's own SSRC in the SSRC of the granted floor participant field; + - b. shall include the floor participant's own MCPTT ID in the User ID field; and + - c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +2. shall set the stored SSRC of the current floor arbitrator to its own SSRC; +3. shall stop timer T203 (End of RTP media), if running; and +4. shall enter 'O: has permission' state. + +#### 7.2.3.6.7 Receive Floor Granted message (R: Floor Granted to me) + +Upon receiving Floor Granted message and if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall set the stored SSRC of the current floor arbitrator to its own SSRC; +3. shall stop timer T203 (End of RTP media), if running; +4. shall stop timer T201 (Floor Request); +5. may provide a floor granted notification to the MCPTT user; +6. if the Floor Indicator field is included and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +7. shall enter 'O: has permission' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. shall set the stored SSRC of the current floor arbitrator to its own SSRC; +2. shall stop timer T203 (End of RTP media); +3. shall stop timer T201 (Floor Request); +4. may provide a floor granted notification to the MCPTT user; +5. if the Floor Indicator field is included and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +6. shall enter 'O: has permission' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall set the stored SSRC of the current arbitrator to its own SSRC; +2. shall stop timer T203 (End of RTP media); +3. shall stop timer T201 (Floor Request); +4. may provide a floor granted notification to the MCPTT user; +5. shall clear the stored SSRC of the candidate arbitrator; +6. if the Floor Indicator field is included and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +7. shall enter 'O: has permission' state. + +#### 7.2.3.6.8 Receive Floor Granted message (R: Floor Granted to other) + +Upon receiving a Floor Granted message and if the value in the User ID field does not match its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of current arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall set the stored SSRC of the candidate arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; + +3. shall reset the counter C201 (Floor Request) associated with timer T201 (Floor Request) with the value set to 1; +4. shall restart timer T203 (End of RTP media); +5. shall restart timer T201 (Floor Request); +6. may provide a floor taken notification to the MCPTT user; +7. if the Floor Indicator field is included and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +8. shall remain in 'O: pending request' state. + +Otherwise, if the value in the User ID field does not match its own MCPTT ID and there is no stored SSRC of the current floor arbitrator, the floor participant: + +1. shall set the stored SSRC of the candidate floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +2. shall reset the counter C201 (Floor Request) associated with timer T201 (Floor Request) with the value set to 1; +3. shall restart timer T203 (End of RTP media); +4. shall restart timer T201 (Floor Request); +5. may provide a floor taken notification to the MCPTT user; +6. if the Floor Indicator field is included and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +7. shall remain in 'O: pending request' state. + +Otherwise, if the value in the User ID field does not match its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall set the stored SSRC of the candidate arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; +3. shall reset the counter C201 (Floor Request) associated with timer T201 (Floor Request) with the value set to 1; +4. shall restart timer T203 (End of RTP media); +5. shall restart timer T201 (Floor Request); +6. may provide a floor taken notification to the MCPTT user; +7. if the Floor Indicator field is included and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +8. shall remain in 'O: pending request' state. + +#### 7.2.3.6.9 Timer T201 (Floor Request) expired (Timer T201 expired) + +On expiry of timer T201 (Floor Request) if the counter C201 (Floor Request) has not reached its upper limit, the floor participant: + +1. shall send the Floor Request message to other floor participants. The Floor Request message: + - a. if a priority different than the default floor priority is required, shall include the Floor Priority field with the requested priority in the element; + - b. shall include the MCPTT ID of the own MCPTT user in the User ID field; and + +- c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +- 2. shall restart the timer T201 (Floor Request) and increment counter C201 (Floor Request) by 1; and +- 3. shall remain in the 'O: pending request' state. + +#### 7.2.3.6.10 Receive Floor Request message (R: Floor request) + +Upon receiving Floor Request message, if the priority of received request is higher than priority of the floor participant or if the SSRC of received request is higher, if the priority is same, the floor participant: + +- 1. shall reset the value of the counter C201 (Floor Request) to 1; +- 2. shall re-start timer T201 (Floor Request); and +- 3. shall remain in 'O: pending request' state. + +#### 7.2.3.6.11 Receive Floor Taken message (R: Floor Taken) + +Upon receiving a Floor Taken message, the floor participant: + +- 1. shall set the stored SSRC of the current floor arbitrator to the SSRC of granted floor participant field the Floor Taken message; +- 2. shall reset the value of the counter C201 (Floor request) to 1; +- 3. shall restart timer T201 (Floor request); and +- 4. shall remain in 'O: pending request' state. + +#### 7.2.3.7 State: 'O: pending granted' + +##### 7.2.3.7.1 General + +In this state the MCPTT client is waiting for another client to take over the role of floor arbitrator. + +The timer T205 (Floor Granted) is running in this state. + +##### 7.2.3.7.2 Receive RTP media (R: RTP Media) + +Upon receiving the RTP media and the SSRC of RTP media packet matches with the stored SSRC of current floor arbitrator, the floor participant: + +- 1. shall request the MCPTT client to render the received RTP media packets; +- 2. shall stop timer T205 (Floor Granted), if running; +- 3. shall stop timer T233 (Pending user action), if running; +- 4. shall start timer T203 (End of RTP media); and +- 5. shall enter 'O: has no permission' state. + +##### 7.2.3.7.3 Timer T205 (Floor Granted) expired (timer T205 expired) + +On expiry of timer T205 (Floor Granted) and counter C205 (Floor Granted) is less than the upper limit, the floor participant: + +- 1. shall send again the Floor Granted message toward the other floor participants. For each participant in the queue the Floor Granted message: + - a. shall include the MCPTT ID of the floor participant in the Queued User ID field; + +- b. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - c. shall include the queue position of the floor participant in the Queue Info field; and + - d. shall include the priority of the floor participant in the Queue Info field; +- 2. shall restart timer T205 (Floor Granted) and shall increment counter C205 (Floor Granted) by 1; and + - 3. shall remain in 'O: pending granted' state. + +**7.2.3.7.4 Timer T205 (Floor Granted) expired N times with pending request(s) in the queue +(Timer T205 expired N times AND pending request(s) in queue)** + +On the expiry of timer T205 (Floor Granted) for the configured upper limit of counter C205 (Floor Granted) with request pending in the queue, the floor participant: + +- 1. shall reset the value of counter C205 (Floor Granted) to 1; +- 2. shall start the timer T233 (Pending user action); and +- 3. shall remain in 'O: pending granted' state. + +**7.2.3.7.5 Timer T205 (Floor Granted) expired N times with no pending request in the queue +(Timer T205 expired N times AND no pending request in queue)** + +On the expiry of timer T205 (Floor Granted) for the configured upper limit of counter C205 (Floor Granted) with no request pending in the queue, the floor participant: + +- 1. shall reset the value of counter C205 (Floor Granted) to 1; +- 2. shall start timer T230 (Inactivity); +- 3. shall clear the stored SSRC of the current floor arbitrator; and +- 4. shall enter 'O: silence' state. + +**7.2.3.7.6 Timer T233 (Pending user action) expires with no pending request in the queue +(Timer T233 expired AND no pending request in queue)** + +On expiry of timer T233 (Pending user action) with no request pending in the queue, the floor participant: + +- 1. shall send a Floor Release message towards other floor participants. The Floor Release message: + - a. shall include the MCPTT ID of the MCPTT user in the User ID field; +- 2. shall start timer T230 (Inactivity); +- 3. shall clear the stored SSRC of the current floor arbitrator; and +- 4. shall enter 'O: silence' state. + +**7.2.3.7.7 Timer T233 (Pending user action) expires with pending request(s) in the queue +(Timer T233 expired AND pending request(s) in queue)** + +On the expiry of timer T233 (Pending user action) with more request(s) pending in the queue, the floor participant: + +- 1. shall send the Floor Granted message for the next pending request in the queue towards other floor participants. The Floor Granted message: + - a. shall include the MCPTT ID of the first floor participant in the queue in the User ID field; + - b. shall include the SSRC of the first floor participant in the queue in the SSRC of the granted floor participant field; + +- c. shall remove the first floor participant from the queue; + - d. for the remaining floor participants in the queue: + - i. shall include the MCPTT ID of the floor participant in the Queued User ID field; + - ii. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - iii. shall include the queue position of floor participant in the Queue Info field; + - iv. shall include the priority of the floor participant in the Queue Info field; and + - e. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +2. shall set the stored SSRC of the current floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; + 3. shall start timer T205 (Floor Granted); + 4. shall initialize the counter C205 (Floor Granted) with the value set to 1; and + 5. shall remain in 'O: pending granted' state. + +#### 7.2.3.7.8 PTT button pressed + +If the floor participant receives an indication from the MCPTT user to send media, the floor participant: + +1. may notify the MCPTT user about rejection; and, +2. shall remain in 'O: pending granted' state. + +#### 7.2.3.7.9 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message, the floor participant: + +1. shall remove the sender of the Floor Release message from the queue, if the User ID in the floor release message matches the queued request of User ID; and +2. shall remain in 'O: pending granted' state. + +#### 7.2.3.7.10 Receive Floor Request message (R: Floor Request) + +When a Floor Request message is received, the floor participant: + +1. if the SSRC in the received Floor Request message equals the stored SSRC of the current floor arbitrator, + - a. shall send again the Floor Granted message toward the other floor participants. For each participant in the queue the Floor Granted message: + - i. shall include the MCPTT ID of the floor participant in the Queued User ID field; + - ii. shall include the SSRC of the floor participant in the SSRC of queued floor participant field; + - iii. shall include the queue position of the floor participant in the Queue Info field; and + - iv. shall include the priority of the floor participant in the Queue Info field; and + - b. shall restart timer T205 (Floor Granted) and shall increment counter C205 (Floor Granted) by 1; +2. if the SSRC in the received Floor Request message does not equal the stored SSRC of the current floor arbitrator, shall send the Floor Deny message toward the other floor participant. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + +- b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - c. shall include the User ID field received in the Floor Request message; and +3. shall remain in 'O: pending granted' state. + +### 7.2.3.8 State: 'O: queued' + +#### 7.2.3.8.1 General + +In this state the MCPTT client is waiting for a response to a queued request. + +#### 7.2.3.8.2 Receive RTP media (R: RTP media) + +Upon receiving RTP media packets and the SSRC of RTP media packet matches with the stored SSRC of current floor arbitrator, the floor participant: + +- 1. shall request the MCPTT client to render the RTP media packets; +- 2. shall restart timer T203 (End of RTP media); and +- 3. shall remain in 'O: queued' state. + +Otherwise, if SSRC of floor participant sending the media packet matches with the stored SSRC of candidate arbitrator, the floor participant: + +- 1. shall request the MCPTT client to render the RTP media packets; +- 2. shall restart timer T203 (End of RTP media); +- 3. shall set the stored SSRC of the current arbitrator to the SSRC of RTP media packet; +- 4. shall clear the stored SSRC of the candidate arbitrator; and +- 5. shall remain in 'O: queued' state. + +#### 7.2.3.8.3 Receive Floor Queue Position Info message (R: Floor Queue Position Info) + +Upon receiving Floor Queue Position Info message, if the value in the Queued User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Queue Position Info message matches the stored SSRC of current floor arbitrator, the floor participant: + +- 1. shall update the queue position; +- 2. shall notify the MCPTT user about the queue position received in the value in the Queue Info field; +- 3. shall stop timer T204 (Floor Queue Position request); and +- 4. shall remain in 'O: queued' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Queue Position Info message matches the stored SSRC of candidate arbitrator, the floor participant: + +- 1. shall update the queue position; +- 2. shall set the stored SSRC of the current arbitrator to the SSRC of the floor control server as received in the Floor Queue Position Info message; +- 3. shall clear the stored SSRC of the candidate arbitrator; +- 4. shall notify the MCPTT user about the queue position received in the value in the Queue Info field; + +5. shall stop timer T204 (Floor Queue Position request); and +6. shall remain in 'O: queued' state. + +#### 7.2.3.8.4 Receive Floor Deny message (R: Floor Deny) + +Upon receiving Floor Deny message, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Deny message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall stop timer T204 (Floor Queue Position request), if running; +2. shall stop the timer T233 (Pending user action), if running; +3. shall provide floor deny notification to the user; +4. may display the floor deny reason to the user using information in the Reject Cause field; and +5. shall enter 'O: has no permission' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Deny message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall stop timer T204 (Floor Queue Position request), if running; +2. shall stop the timer T233 (Pending user action), if running; +3. shall set the stored SSRC of the current arbitrator to the SSRC of the floor control server as received in the Floor Deny message; +4. shall clear the stored SSRC of the candidate arbitrator; +5. shall provide floor deny notification to the user; +6. may display the floor deny reason to the user using information in the Reject Cause field; and +7. shall enter 'O: has no permission' state. + +#### 7.2.3.8.5 User indication for release of pending request + +When an indication from the MCPTT user to release the queued request for the floor is received, the floor participant: + +1. shall send a Floor Release message towards other floor participants. The Floor Release message: + - a. shall include the MCPTT ID of the MCPTT user in the User ID field; +2. shall stop timer T204 (Floor Queue Position request), if running; +3. shall stop timer T233 (Pending user action), if running; and +4. shall enter 'O: has no permission' state. + +#### 7.2.3.8.6 Receive Floor Granted message (R: Floor Granted to me) + +Upon receiving Floor Granted message and if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall start timer T233(Pending user action), if not running already; +3. shall notify the MCPTT user about of the floor grant; + +4. if the Floor Indicator field is included, and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +5. shall remain in 'O: queued' state. + +Otherwise, if the value in the User ID field matches its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall start timer T233(Pending user action), if not running already; +3. shall notify the MCPTT user about of the floor grant; +4. shall set the stored SSRC of the current arbitrator to its own SSRC; +5. shall clear the stored SSRC of the candidate arbitrator; +6. if the Floor Indicator field is included, and the B bit is set to '1' (Broadcast group call), shall provide a notification to the user indicating the type of call; and +7. shall remain in 'O: queued' state. + +#### 7.2.3.8.7 Timer T233 (Pending user action) expires + +On expiry of timer T233 (Pending user action), the floor participant: + +1. shall stop timer T204 (Floor Queue Position request), if running; +2. shall start timer T230 (Inactivity); and +3. shall enter 'O: silence' state. + +#### 7.2.3.8.8 User indication for accept of pending request + +If the floor participant receives an indication from the user that the user wants to send media and the timer T233 (pending user action) is running, the floor participant: + +1. shall stop timer T204 (Floor Queue Position request), if running; +2. shall stop the timer T233 (Pending user action); +3. shall set the stored SSRC of the current floor arbitrator to its own SSRC; and +4. shall enter 'O: has permission' state. + +#### 7.2.3.8.9 Receive Floor Granted message (R: Floor Granted to other) + +Upon receiving Floor Granted message and if the value in the User ID field does not match its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of current floor arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall restart timer T203 (End of RTP media); +3. shall set the stored SSRC of the candidate floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; and +4. shall remain in 'O: queued' state. + +Otherwise, if the value in the User ID field does not match its own MCPTT ID and SSRC of floor participant sending the Floor Granted message matches the stored SSRC of candidate arbitrator, the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; + +2. shall restart timer T203 (End of RTP media); +3. shall set the stored SSRC of the candidate floor arbitrator to the SSRC of user to whom the floor was granted in the Floor Granted message; and +4. shall remain in 'O: queued' state. + +#### 7.2.3.8.10 Timer T203 (End of RTP media) expires + +On expiry of timer T203 (End of RTP media), the floor participant: + +1. shall request the MCPTT client to stop rendering received RTP media packets; +2. shall send the Floor Request message to other floor participants. The Floor Request message: + - a. if a priority different than the default floor priority is required, shall include the Floor Priority field with the requested priority in the element; + - b. shall include the MCPTT ID in the value; and + - c. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; +3. shall stop timer T204 (Floor Queue Position request), if running; +4. shall initialize the counter C201 (Floor request) with value set to 1; +5. shall start timer T201 (Floor Request); +6. shall clear the stored SSRC of the current floor arbitrator; and +7. shall enter 'O: pending request' state. + +#### 7.2.3.8.11 Send Floor Queue Position Request message (R: Request queue position info) + +Upon receipt of an indication from the MCPTT client to request the queue position information, the floor participant: + +1. shall send the Floor Queue Position Request message; The Floor Queue Position Request message: + - a. shall include the SSRC of sent Floor Request message in SSRC of floor participant field; and + - b. shall include the own MCPTT User ID in User ID field; +2. shall initialize the counter C204 (Floor Queue Position request) with value set to 1; +3. shall start timer T204 (Floor Queue Position request); and +4. remain in the 'O: queued' state. + +#### 7.2.3.8.12 Timer T204 (Floor Queue Position request) expires + +Upon expiry of timer T204 (Floor Queue Position request), the floor participant: + +1. shall send the Floor Queue Position Request message; The Floor Queue Position Request message: + - a. shall include the SSRC of sent Floor Request message in SSRC of floor participant field; and + - b. shall include the own MCPTT User ID in User ID field; +2. shall increment the value of counter C204 (Floor Queue Position request) by 1; +3. shall start timer T204 (Floor Queue Position request); and +4. remain in the 'O: queued' state. + +#### 7.2.3.8.13 Timer T204 (Floor Queue Position request) expires N times + +Upon expiry of timer T204 (Floor Queue Position request) when the value of the counter C204 (Floor Queue Position request) is equal to the value upper limit, the floor participant: + +1. shall reset the counter C204 (Floor Queue Position request) with value set to 1; +2. shall start timer T230 (Inactivity); +3. shall clear the stored SSRC of the current floor arbitrator; and +4. shall enter 'O: silence' state. + +#### 7.2.3.9 In any state + +##### 7.2.3.9.1 General + +This subclause describes the actions to be taken in all states defined for the basic state diagram with the exception of the 'Start-stop' state. + +##### 7.2.3.9.2 Receive MCPTT call release (R: MCPTT call release) + +Upon receiving an MCPTT call release request from the application and signalling plane when the MCPTT call is going to be released, the floor participant: + +1. shall stop sending floor control messages towards other floor participants; +2. shall request the MCPTT client to stop sending and receiving RTP media packets; +3. shall release all resources including any running timers associated with the MCPTT call; +4. shall terminate the instance of floor participant state transition diagram; and +5. shall enter 'Start-stop' state. + +--- + +## 8 Coding + +### 8.1 Introduction + +#### 8.1.1 General + +The media plane control protocols specified in the present document are based on the RTCP Application Packets (RTCP: APP), as defined in IETF RFC 3550 [3], but the media plane control messages do not conform to the rules for compound RTCP packets or RTCP packet transmission. + +Each media plane control message is one RTCP: APP packet. These RTCP: APP packets are not to be sent in compound RTCP packets, but more than one media plane control message can be sent in a single IP packet. + +The three first 32-bit words in any of the media plane control protocols defined in the present document are structured commonly as described in subclause 8.1.2. + +Outside tables, binary values are expressed with a decimal value with single quotation marks e.g. 00000000 is '0', 00000001 is '1', 00000010 is '2' and so on. + +#### 8.1.2 RTCP: APP message format + +The definition of the fields in the RTCP APP packet is found in IETF RFC 3550 [3]. + +Table 8.1.2-1 shows the RTCP APP packet format. + +**Table 8.1.2-1: RTCP: APP message format** + +![](9d47fe89bc71acebde670ea760ee6ffb_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|----------------------------|---|---|---|---|---|---|---|------------|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| V=2 P Subtype | | | | | | | | PT=APP=204 | | | | | | | | length | | | | | | | | | | | | | | | | +| SSRC | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name (ASCII) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| application-dependent data | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Secure RTCP message part | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +**P** + +The padding bit P is set to '0'. + +**Subtype:** + +Dependent upon the relevant set of media plane control messages, as identified by the Name field, the possible Subtype values are defined in the following tables: + +- Name field = "MCPT" (i.e. Floor control): Table 8.2.2.1-1 +- Name field = "MCPC" (i.e. Pre-established session call control): Table 8.3.2-1 +- Name field= "MCMC" (i.e. MBMS subchannel control):Table 8.4.2-1 +- Name field= "MCNC" (i.e. Notification control): Table 8.5.2-1 + +**Length** + +The length field in the RTCP header is the length of the packet in 32-bit words, not counting the first 32-bit word in which the length field resides. + +NOTE: The length field can indicate message size longer than specified in this version of the protocol. This can be the case e.g. if message is of later version of this protocol. + +**SSRC** + +The content of this field is described for each floor control message separately. + +**Name** + +The 4-byte ASCII string in the RTCP header is used to define the set of media plane control messages to be unique with respect to other APP packets that the media plane might receive. + +The present document specified the use of the following names: + +1. For the floor control protocol specified in the present document the ASCII name string is: MCPT (Mission Critical Push-to-Talk). +2. For the pre-established session call control protocol specified in the present document the ASCII name string is: MCPC (Mission Critical Pre-established Session Control). +3. For the MBMS subchannel control protocol specified in the present document the ASCII name string is: MCMC (Mission Critical MBMS subchannel Control). + +**Application-dependent data** + +The application-dependent data contains zero or more application specific data fields is specified in subclause 8.1.3. + +This part is encrypted if SRTCP is used. + +**Secure RTCP message part** + +The content of the secure RTCP message part is in specified in clause 13 and in IETF RFC 3711 [16]. + +**8.1.3 Application specific data field** + +Each application specific data field is composed of: + +1. a field ID which is one octet long; +2. a length value which is: + - one octet long, if the field ID is less than 192; and + - two octets long, if the field ID is equal to or greater than 192; +3. a field value. The length in octets of the field value is indicated in the length value; and +4. a padding. The padding is zero, one, two, or three octets long. The value of the padding octet(s) is set to zero by sender and ignored by receiver. + +An application specific data field has always a multiple of 4 octets. + +Table 8.1.3-1 shows the application dependent data field structure when the field ID is less than 192. Table 8.1.3-2 shows the application dependent data field structure when the field ID is equal to or greater than 192. + +**Table 8.1.3.-1: Application specific data field structure when the field ID is less than 192** + +![](8acaddc2ebf496c7f758ab8dac1f442b_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|----------|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|-------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| Field ID | | | | | | | | Length value | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| : | | | | | | | | < | | | | | | | | Field value | | | | | | | | > | | | | | | | | | | | | | | | | +| : | | | | | | | | : | | | | | | | | : | | | | | | | | | | | | | | | | | | | | | | | | + +**Table 8.1.3.-2: Application specific data field structure when the field ID is equal to or greater than 192** + +![](42dea302ac83c622dfe19d8f3c72233a_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|----------|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|-------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| Field ID | | | | | | | | Length value | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| : | | | | | | | | < | | | | | | | | Field value | | | | | | | | > | | | | | | | | | | | | | | | | +| : | | | | | | | | : | | | | | | | | : | | | | | | | | : | | | | | | | | | | | | | | | | + +**8.1.4 Handling of unknown messages and fields** + +When an RTCP APP message is received, the receiver shall: + +1. ignore the whole message, if the subtype is unknown; +2. ignore the unspecified fields in the message (e.g. specified in future version of the protocol); and +3. ignore the syntactically incorrect optional fields. + +## 8.2 Floor control + +### 8.2.1 Introduction + +The floor control messages are coded as described in subclause 8.1.2 where the floor control message is part of the application-dependent data. + +For the floor control protocol the ASCII name string is: MCPT (Mission Critical Push-to-Talk). + +A list of floor control messages can be found in subclause 8.2.2.1. + +The same floor control messages are used for on-network, off-network floor control and over the MBMS subchannel control channel. + +In case of off-network, the floor participant that has the floor acts as the floor control server (referred to as floor arbitrator in clause 7) in the following subclauses. + +The floor control specific fields are specified in subclause 8.2.3. + +### 8.2.2 Floor control messages + +#### 8.2.2.1 General + +The table 8.2.2.1-1 provides a list of floor control messages. + +**Table 8.2.2.1-1: Floor control specific messages** + +| Message name | Subtype | Reference | Direction | +|------------------------------|---------|------------------|------------------------------------| +| Floor Request | 00000 | Subclause 8.2.4 | Client → server | +| Floor Granted | x0001 | Subclause 8.2.5 | Server → client | +| Floor Deny | x0011 | Subclause 8.2.6 | Server → client | +| Floor Release | x0100 | Subclause 8.2.7 | Client → server | +| Floor Idle | x0101 | Subclause 8.2.8 | Server → client | +| Floor Taken | x0010 | Subclause 8.2.9 | Server → client | +| Floor Revoke | 00110 | Subclause 8.2.10 | Server → client | +| Floor Queue Position Request | 01000 | Subclause 8.2.11 | Client → server | +| Floor Queue Position Info | x1001 | Subclause 8.2.12 | Server → client | +| Floor Ack | 01010 | Subclause 8.2.13 | Server → client
Client → server | +| Floor Release Multi Talker | 01111 | Subclause 8.2.14 | Server → client | + +NOTE: The floor control server is the server and the floor participant is the client. + +For some messages the first bit (marked as x in the subtype) can be used to indicate if the sender wants to have an acknowledgment. The x is coded as follows: + +'0' Acknowledgment is not required + +'1' Acknowledgment is required + +NOTE: Whether a message needs to be acknowledged or not is described in clauses 6. + +If an acknowledgment is required the Floor Ack message is used to acknowledge the message. + +### 8.2.2.2 Void + +## 8.2.3 Floor control specific fields + +### 8.2.3.1 Introduction + +This subclause describes the floor control specific data fields. + +The floor control messages can include floor control specific data fields contained in the application-dependent data of the floor control message. The floor control specific data fields follow the syntax specified in subclause 8.1.3. + +**Table 8.2.3.1-1: Void** + +Table 8.2.3.1-2 lists the available floor control specific data fields including the assigned field ID. + +**Table 8.2.3.1-2: Floor control specific data fields** + +| Field name | Field ID | | Reference | +|---------------------------------|----------|----------|--------------------| +| | Decimal | Binary | | +| Floor Priority | 000 | 00000000 | Subclause 8.2.3.2 | +| Duration | 001 | 00000001 | Subclause 8.2.3.3 | +| Reject Cause | 002 | 00000010 | Subclause 8.2.3.4 | +| Queue Info | 003 | 00000011 | Subclause 8.2.3.5 | +| Granted Party's Identity | 004 | 00000100 | Subclause 8.2.3.6 | +| Permission to Request the Floor | 005 | 00000101 | Subclause 8.2.3.7 | +| User ID | 006 | 00000110 | Subclause 8.2.3.8 | +| Queue Size | 007 | 00000111 | Subclause 8.2.3.9 | +| Message Sequence-Number | 008 | 00001000 | Subclause 8.2.3.10 | +| Queued User ID | 009 | 00001001 | Subclause 8.2.3.11 | +| Source | 010 | 00001010 | Subclause 8.2.3.12 | +| Track Info | 011 | 00001011 | Subclause 8.2.3.13 | +| Message Type | 012 | 00001100 | Subclause 8.2.3.14 | +| Floor Indicator | 013 | 00001101 | Subclause 8.2.3.15 | +| SSRC | 014 | 00001110 | Subclause 8.2.3.16 | +| List of Granted Users | 015 | 00001111 | Subclause 8.2.3.17 | +| List of SSRCs | 016 | 00010000 | Subclause 8.2.3.18 | +| Functional Alias | 017 | 00010001 | Subclause 8.2.3.19 | +| List of Functional Aliases | 018 | 00010010 | Subclause 8.2.3.20 | +| Location | 019 | 00010011 | Subclause 8.2.3.21 | +| List of Locations | 020 | 00010100 | Subclause 8.2.3.22 | + +The following subclauses describe the coding of each field. + +### 8.2.3.2 Floor Priority field + +The Floor Priority field describes the level of priority requested in a Floor Request message or granted in a Floor Granted message. The max floor priority that can be requested in a Floor Request message is negotiated between the MCPTT client and the controlling MCPTT function using the "mc\_priority" fmtp parameter as specified in clause 14. + +Table 8.2.3.2-1 describes the coding of the Floor Priority field. + +**Table 8.2.3.2-1: Floor Priority field coding** + +| | | | | +|---------------------|---------------------|---------------------|-----| +| 0 | 1 | 2 | 3 | +| 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 | + +``` + ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|Floor Priority |Floor Priority |Floor Priority |spare | +|field ID value |Length value |value | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value item and the spare bits. + +The value consists of 8 bit parameter giving the floor priority ('0' to '255') where '0' is the lowest priority and '255' is the highest priority. If the Floor Priority field is not included in the message the default priority is used as the Floor Priority value. The value of the default priority is '0'. The default priority is sometimes referred to as normal priority. Whether a floor priority is pre-emptive or not is determined: + +1. for on-network by the floor control server as described in subclause 4.1.1.4; and +2. for off-network by the floor arbitrator as described in subclause 4.1.1.5. + +The spare bits are set to zero. + +### 8.2.3.3 Duration field + +The Duration field describes the time in seconds for which the granted party is allowed to transmit. + +Table 8.2.3.3-1 describes the coding of the Duration field. + +**Table 8.2.3.3-1: Duration field coding** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|Duration |Duration |Duration value | +|field ID value |length value | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value item. + +The value is a binary value in seconds. + +#### 8.2.3.4 Reject Cause field + +The Reject Cause field contains a value and can contain a value. The content of the value is floor control message dependent and is described per individual floor control message carrying the Reject Cause field. + +Table 8.2.3.4-1 describes the coding of the Reject Cause field. + +**Table 8.2.3.4-1: Reject Cause field coding** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|Reject Cause |Reject Cause | Reject Cause | +|field ID |length | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: Reject Phrase : +: | +| (Padding) | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and indicates the total length in octets of the value and the value items excluding any padding octets. If the length field is set to '2', there is no value in the Reject Cause field. + +The value is a 16 bit binary value as defined in subclause 8.2.6.2 for Floor Deny message and as defined in subclause 8.2.10.2 for Floor Revoke message. + +The value is a text string encoded the text string in the SDES item CNAME as specified in IETF RFC 3550 [3]. + +If the length of the value is not a multiple of 4 bytes, the value is padded to a multiple of 4 bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.5 Queue Info field + +The Queue Info field includes information about the position for one MCPTT client in the floor request queue and the priority of the floor request. + +Table 8.2.3.5-1 describes the coding of the Queue Info field. + +**Table 8.2.3.5-1: Queue Info field coding** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Queue Info |Queue Info |Queue Position |Queue Priority | + |field ID value |length value |Info value | Level value | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value and the value items. + +The value is a binary value. The value has the value '254' if the MCPTT client is not queued. The value has the max value ('255') if the MCPTT client is queued but the MCPTT server is unable to determine the queue position or if MCPTT server policy is not to release information of the queue position to the MCPTT client. + +The value is coded as the value in subclause 8.2.3.2. + +### 8.2.3.6 Granted Party's Identity field + +The Granted Party's Identity field identifies the MCPTT user that is granted to send media. + +Table 8.2.3.6-1 describes the coding of the Granted Party's Identity field. + +**Table 8.2.3.6-1: Granted Party's Identity field coding** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Granted Party's|Granted Party's| Granted Party's Identity | + |Identity field |Identity length| : + |ID | | : + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ : + : : + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is coded as the value in subclause 8.2.3.8. + +The value is coded as the value in subclause 8.2.3.8. + +If the length of the value is not (2 + multiple of 4) bytes, the value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.7 Permission to Request the Floor field + +The Permission to Request the Floor field indicates whether receiving parties are allowed to request the floor or not. + +Table 8.2.3.7-1 describes the coding of the Permission to Request the Floor field. + +**Table 8.2.3.7-1: Permission to Request the Floor field coding** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Permission to | Permission to | Permission to Request | + | Request the | Request the | the Floor value | + | Floor field ID| Floor length | | + | | value | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value. + +The value is 16 bit binary value and coded as follows: + +'0' The receiver is not permitted to request floor. + +'1' The receiver is permitted to request floor. + +All other values are reserved for future use. + +### 8.2.3.8 User ID field + +The User ID field contains the MCPTT ID of an MCPTT user. + +Table 8.2.3.8-1 describes the coding of the User ID field. + +**Table 8.2.3.8-1: User ID field coding** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | User ID | User ID | User ID | + | field ID | length | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + : : + : : + | Padding | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and includes the value indicating the length in octets of the value item except padding. + +The value is coded as described in table 8.2.3.8-2. + +**Table 8.2.3.8-2: ABNF syntax of string values of the value** + +| | +|----------------------------| +| user-id = URI | +|----------------------------| + +If the length of the value is not (2 + multiple of 4) bytes value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes is to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.9 Queue Size field + +The Queue Size field contains the numbers of queued MCPTT clients in an MCPTT call. + +Table 8.2.3.9-1 describes the coding of the Queue size field. + +**Table 8.2.3.9-1: Queue Size field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|---|---|------------------|---|---|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Queue Size | | | | | | | | | | Queue Size | | | | | | | | | | Queue Size value | | | | | | | | | | | | +| field ID value | | | | | | | | | | length value | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value item. + +The value is a 16 bit binary value. + +### 8.2.3.10 Message Sequence Number field + +The Message Sequence Number field is used to bind a number of Floor Taken or bind a number of Floor Idle messages together. + +Table 8.2.3.10-1 describes the coding of the Message Sequence Number field. + +**Table 8.2.3.10-1: Message Sequence Number field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|-----------------|---|---|---|---|---|---|---|---|---|-------------------------------|---|---|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Message | | | | | | | | | | Message | | | | | | | | | | Message Sequence Number value | | | | | | | | | | | | +| Sequence Number | | | | | | | | | | Sequence Number | | | | | | | | | | | | | | | | | | | | | | +| field ID value | | | | | | | | | | length value | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value item. + +The value is a binary value. The value can be between '0' and '65535'. When the '65535' value is reached, the value starts from '0' again. + +### 8.2.3.11 Queued User ID field + +The Queued User ID field includes information about the identity of a queued MCPTT user. + +Table 8.2.3.11-1 describes the coding of the Queued User ID field. + +**Table 8.2.3.11-1: Queued User ID field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|----------------|---|---|---|---|---|---|---|---|---|----------------|---|---|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Queued User ID | | | | | | | | | | Queued User ID | | | | | | | | | | Queued User ID | | | | | | | | | | | | + +| | | | +|-------------------------------------------------------------------|--------|---| +| field ID | length | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | : | +| : | | : | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is coded as the value in subclause 8.2.3.8. + +The value is coded as the value in subclause 8.2.3.8. + +If the length of the value is not (2 + multiple of 4) bytes, the value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.12 Source field + +The Source field contains the source of the message. + +Table 8.2.3.12-1 describes the coding of the Source field. + +**Table 8.2.3.12-1: Source field coding** + +| | | | | +|-------------------------------------------|---------------------|---------------------|--------------| +| 0 | 1 | 2 | 3 | +| 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 | +| +---+---+---+---+---+---+---+---+---+---+ | | | | +| Source | Source | | Source value | +| field ID value | length value | | | +| +---+---+---+---+---+---+---+---+---+---+ | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value item. + +The value is a 16 bit binary value where: + +- '0' the floor participant is the source +- '1' the participating MCPTT function is the source +- '2' the controlling MCPTT function is the source +- '3' the non-controlling MCPTT function is the source + +All other values are reserved for future use. + +### 8.2.3.13 Track Info field + +The Track Info field contains the path a floor control message has been routed along with the priority and the queueing capability of the MCPTT client. + +Table 8.2.3.13-1 describes the coding of the Track Info field. + +**Table 8.2.3.13-1: Track Info field coding** + +| | | | | +|-------------------------------------------|------------------------|---------------------|-------------| +| 0 | 1 | 2 | 3 | +| 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 | +| +---+---+---+---+---+---+---+---+---+---+ | | | | +| Track Info | Track Info | Queueing | Participant | +| field ID value | length value | Capability | Type Length | +| | | value | value | +| +---+---+---+---+---+---+---+---+---+---+ | | | | +| | Participant Type value | | | +| : | | | : | + +``` + ++---------------------------------------------------------------+ +| Floor Participant Reference 1 | +: | : +| Floor Participant Reference n | ++---------------------------------------------------------------+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has a value indicating the total length in octets of the value and one or more value items. + +The value is an 8 bit binary value where: + +- '0' the floor participant in the MCPTT client does not support queueing +- '1' the floor participant in the MCPTT client supports queueing + +All other values are reserved for future use. + +The value is 8 bit binary value set to the length of the value. + +The value is string coded as specified in table 8.2.3.13-2: + +**Table 8.2.3.13-2: ABNF syntax of values of the value** + +| | +|---------------------------------------------------------------| +| participant-type = 1*( %x20-7E / UTF8-NONASCII ) | +|---------------------------------------------------------------| + +If the length of the value is not a multiple of 4 bytes, the value is padded to a multiple of 4 bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +NOTE 1: The content of the value is MCPTT service provider specific and out of scope of the present document. + +The value is a 32 bit binary value containing a reference to the floor participant in the non-controlling MCPTT function of an MCPTT group. + +NOTE 2: The reference to the floor participant is a value only understandable by the floor control server interface in the non-controlling MCPTT function of an MCPTT group. + +### 8.2.3.14 Message Type field + +The Message Type field contains the subtype of the floor control message that is acknowledged. + +Table 8.2.3.14-1 describes the coding of the Message Type field. + +**Table 8.2.3.14-1: Message Type field coding** + +``` + + 0 1 2 3 +0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|Message Type |Message Type |Message Type |Spare | +|field ID |Length | | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2' indicating the total length in octets of the value item and the spare bits. + +The value is an 8 bit binary value containing the binary value consisting of the 5 bit message subtype as coded in table 8.2.2.1-1 (including the first bit (used by some floor control messages to indicate that a Floor Ack message is requested) of the five bit subtype) preceded by "000". + +The spare bits are set to zero. + +### 8.2.3.15 Floor Indicator field + +The Floor Indicator contains additional information about a received floor control message. + +Table 8.2.3.15-1 describes the coding of the Floor Indicator field. + +**Table 8.2.3.15-1: Floor Indicator field coding** + +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|------------------------------|---|---|---|---|---|---|---|-----------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| Floor Indicator field ID value | | | | | | | | Floor Indicator Length value | | | | | | | | Floor Indicator value | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '2'. + +The value is a 16 bit bit-map named as shown in table 8.2.3.15-2: + +**Table 8.2.3.15-2: Floor Indicator bit marking** + +| | | | | | | | | | | | | | | | | +|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | +|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| + +When set to 1, the bit has the following meaning: + +- A = Normal call +- B = Broadcast group call +- C = System call +- D = Emergency call +- E = Imminent peril call +- F = Queueing supported +- G = Dual floor +- H = Temporary group call (NOTE 2) +- I = Multi-talker + +NOTE 1: The indicators C, D and E are only informative. There are no procedures specified for the C, D and E indicators in this release of the present document and the use of the indicators are implementation specific. + +NOTE 2: An MCPTT group call is a temporary group session when the element is present in the element as specified in 3GPP TS 24.481 [12]. + +Bits J to P are reserved for future use and are set to 0. + +There can be more than one bit set to 1 at the same time. The local policy in the floor control server decides which combinations are possible and the priority of the indications. + +### 8.2.3.16 SSRC field + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. An SSRC field can also have a Field ID and a length value. This subclause specifies an SSRC field including a Field ID and a length value. + +**Table 8.2.3.16-1: SSRC field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|----------------|---|---|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|---|---|------------|---|---|---|---|---|---|---|---|---|---|---|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | | | | | | | | | +| SSRC | | | | | | | | | | SSRC | | | | | | | | | | SSRC value | | | | | | | | | | | | | | | | | | | | +| field ID value | | | | | | | | | | length value | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | SSRC value | | | | | | | | | | Spare | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has the value '6' indicating the total length in octets of the value item and the spare bits. + +The value is coded as the SSSRC specified in IETF RFC 3550 [3]. + +The spare bits are set to zero. + +### 8.2.3.17 List of Granted Users field + +The List of Granted Users field contains a list of MCPTT IDs of MCPTT users that are allowed to send media in a multi-talker scenario. + +Table 8.2.3.17-1 describes the coding of the List of User IDs field. + +**Table 8.2.3.17-1: List of User IDs coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|-----------------|---|---|---|---|---|---|---|---|---|----------------|---|---|---|---|---|---|---|---|---|-------------|---|---|---|---|---|---|---|---|---|----------------|---|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | | | | | | | | | +| List of Granted | | | | | | | | | | List of User | | | | | | | | | | No of users | | | | | | | | | | User ID length | | | | | | | | | | +| Users field ID | | | | | | | | | | ID length | | | | | | | | | | | | | | | | | | | | value | | | | | | | | | | +| : | | | | | | | | | | User ID | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | +| : | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | +| : | | | | | | | | | | User ID length | | | | | | | | | | User ID | | | | | | | | | | : | | | | | | | | | | +| value | | | | | | | | | | | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | +| : | | | | | | | | | | User ID | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | +| : | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | +| | | | | | | | | | | : | | | | | | | | | | Padding | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and includes the value indicating the length in octets of the . + +The value is a binary value and includes the number of User ID entries in the list. + +The value is a binary value and includes the value indicating the length in octets of the value item except padding. + +The value is coded as described in table 8.2.3.17-2. + +**Table 8.2.3.17-2: ABNF syntax of string values of the value** + +``` + +user-id = URI + +``` + +If the length of the sum of all values and all values is not (1 + multiple of 4) bytes, then the sum shall be padded to (1 + multiple of 4) bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.18 List of SSRCs field + +The List of SSRCs field contains the list of SSRCs of the users that are allowed to send media in a multi-talker scenario. + +**Table 8.2.3.18-1: List of SSRCs field coding** + +![](f4e64712104f326ff259928d8126f1f6_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------|---|---|---|---|---|---|---|---|---|---------------|---|---|---|---|---|---|---|---|---|-------------|---|---|---|---|---|---|---|---|---|-------|---| +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| List of SSRCs | | | | | | | | | | List of SSRCs | | | | | | | | | | Number of | | | | | | | | | | Spare | | +| field ID value | | | | | | | | | | length value | | | | | | | | | | SSRCs value | | | | | | | | | | | | +| +-----+-----+-----+-----+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | SSRC value | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-----+-----+-----+-----+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | : | | | | | | | | | | | | | | | | | | | | | | +| +-----+-----+-----+-----+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | SSRC value | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-----+-----+-----+-----+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and has a value indicating the total length in octets of the value, spare bits and one or more value items. + +The value is a binary value and contains the number of SSRCs in the information field. + +The value is coded as the SSRC specified in IETF RFC 3550 [3]. value items have a length '4'. + +The spare bits are set to zero. + +### 8.2.3.19 Functional Alias field + +The Functional Alias field identifies the Functional Alias that the MCPTT user has chosen to use. + +Table 8.2.3.19-1 describes the coding of the Functional Alias field. + +**Table 8.2.3.19-1: Functional Alias field coding** + +![](8996ecf7b316181ca7ae4ff54ebeace5_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------|---|---|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|---|---|------------------|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| Functional | | | | | | | | | | Functional | | | | | | | | | | Functional Alias | | | | | | | | | | | | +| Alias field | | | | | | | | | | Alias length | | | | | | | | | | | | | | | | | | | | : | | +| ID | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | : | | +| +-----+-----+-----+-----+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | : | | | | | | | | | | | | | | | | | | | | | | +| +-----+-----+-----+-----+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and includes the value indicating the length in octets of the value item except padding. + +The value is coded as described in table 8.2.3.19-2. + +**Table 8.2.3.19-2: ABNF syntax of string values of the value** + +| | +|------------------------| +| Functional Alias = URI | +|------------------------| + +If the length of the value is not (2 + multiple of 4) bytes value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes is to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.20 List of Functional Aliases field + +The List of Functional Aliases field contains a list of Functional Aliases of MCPTT users that are allowed to send media in a multiple talker scenario. + +Table 8.2.3.20-1 describes the coding of the List of Functional ALiases field. + +**Table 8.2.3.20-1: List of Functional Aliases coding** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-------------------------------------------------------------------|------------------|---|---|---|---|---|---|------------------|---|---|---|---|---|---|---|-----------|---|---|---|---|---|---|---|-----------|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| List of FAs | | | | | | | | List of FAs | | | | | | | | No of FAs | | | | | | | | FA length | | | | | | | | +| field ID | | | | | | | | length | | | | | | | | | | | | | | | | value | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| : | Functional Alias | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | : | +| : | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| : | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | : | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| FA length | | | | | | | | Functional Alias | | | | | | | | | | | | | | | | | | | | | | | | +| value | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| : | Functional Alias | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | : | +| : | | | | | | | | | | | | | | | | Padding | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and includes the value indicating the length in octets of the . + +The value is a binary value and includes the number of Functional Alias entries in the list. + +The value is a binary value and includes the value indicating the length in octets of the value item except padding. + +The value is coded as described in table 8.2.3.17-2. + +**Table 8.2.3.20-2: ABNF syntax of string values of the value** + +| | +|------------------------| +| Functional Alias = URI | +|------------------------| + +If the length of the sum of all values and all values is not (1 + multiple of 4) bytes, then the sum shall be padded to (1 + multiple of 4) bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.21 Location field + +The location field contains the location of a user. + +**Table 8.2.3.21-1: Location field coding** + +![](7abc02f39b6084e0f27f07a8e8f9224f_img.jpg) + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Location field |Location length| Location | + |ID | | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + : : + : : + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and includes the value indicating the length in octets of the value except padding. + +The value is coded as follows: + +**Table 8.2.3.21-2: Location value coding** + +![](351432d1a55458897fdc5e81ffc832fe_img.jpg) + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Location Type | Location Value | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + : : + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is selected from table 8.2.3.21-3: + +**Table 8.2.3.21-3: Location type** + +| Location Type | Granted Party's Location type code | Granted Party's Location Value | +|------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| Not provided | 00000000 | 0 bits | +| ECGI | 00000001 | 56 bits = MCC + MNC + ECI | +| Tracking Area | 00000010 | 40 bits = MCC + MNC + 16 bits | +| PLMN ID | 00000011 | 24 bits = MCC+MNC | +| MBMS Service Area | 00000100 | 16 bits = [0-65535] | +| MBSFN Area ID | 00000101 | 8 bits = [0-255] | +| Geographic coordinates | 00000110 | 48 bits = latitude in first 24 bits + longitude in last 24 bits coded as in subclause 6.1 in 3GPP TS 23.032 [19]. | + +NOTE: It is preferred that geographic coordinates are sent. + +The format is specified in table 8.2.3.21-3. If location information of the requesting user is not available or is not allowed to be reported by the requesting user's MCPTT profile, the location type field is set to '0' (Not provided). + +If the length of the value is not (2 + multiple of 4) bytes, the value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.3.22 List of Locations field + +The List of Locations field contains the locations of users in a multi-talker scenario. + +**Table 8.2.3.22-1: List of Locations field coding** + +``` + + 0 1 2 3 +0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|List of |List of | Number of | Location | +|Locations field|Locations | Locations | | +|ID |length | | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: Location : +: : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: Location : +: : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and is set according to table 8.2.3.1-2. + +The value is a binary value and includes the value indicating the length in octets of the set of ( value plus values) except padding. + +The value is a binary value and shall be equal to the field in the List of Granted Users field (see 8.2.3.17). The location information shall be maintained in the same order as the users in the List of Granted Users to allow location information to be matched to the correct user. When the location information for a granted floor participant is not available or not allowed, the location type field for that granted floor participant shall be set to '0' (Not provided). + +The field is coded per subclause 8.2.3.21. The value for a granted user for whom location information is either not available or not allowed shall be set to 0 (Not provided). + +If the length of the sum of the set of values is not (1 + multiple of 4) bytes, then the sum shall be padded to (1 + multiple of 4) bytes. The value of the padding bytes is set to zero. The padding bytes are ignored by the receiver. + +### 8.2.4 Floor Request message + +The Floor Request message is a request from a floor participant to get permission to send media. The Floor Request message is used in the off-network mode and in the on-network mode. In the on-network mode the Floor Request message is only used over the unicast bearer. + +Table 8.2.4-1 shows the content of the Floor Request message. + +**Table 8.2.4-1: Floor Request message** + +``` + + 0 1 2 3 +0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|V=2|P| Subtype | PT=APP=204 | length | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| SSRC of floor participant sending the Floor Request message | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| name=MCPT | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Floor Priority field | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: User ID field : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Track Info field | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Floor Indicator field | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: Functional Alias field : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +: Location field : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor participant sending the Floor Request message. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Floor priority:** + +The Floor Priority field is coded as described in subclause 8.2.3.2. + +**User ID:** + +The User ID field is used in off-network only and is coded as described in subclause 8.2.3.8. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +**Functional Alias:** + +The Functional Alias field is coded as described in subclause 8.2.3.19. + +**Location:** + +The Location field is coded as described in subclause 8.2.3.21 and contains the location information of the requesting user. + +## 8.2.5 Floor Granted message + +The Floor Granted message is sent by the floor control server to inform the requesting floor participant that it has been granted the permission to send media. + +The Floor Granted message is used in the off-network mode and in the on-network mode. In the on-network mode the Floor Granted message is only used over the unicast bearer. + +Table 8.2.5-1 shows the content of the Floor Granted message. + +**Table 8.2.5-1: Floor Granted message** + +| 0 | | | | | | | | 1 | | | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|---------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| V=2 P Subtype PT=APP=204 length | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of floor control server/floor arbitrator | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name=MCPT | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Duration field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of granted floor participant field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Floor Priority field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| User ID field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +![](0eb348bf17d67bf96326e07011d1c1ad_img.jpg) + +| | +|----------------------------------------| +| Queue Size field | +| SSRC of queued floor participant field | +| Queued User ID field | +| Queue Info field | +| Track Info field | +| Floor Indicator field | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. However, any set of Queue size field, SSRC of queued floor participant field, Queued User ID field and the Queue Info field shall be kept together. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server for on-network and floor arbitrator for off-network. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Duration:** + +The Duration field is coded as specified in subclause 8.2.3.3. + +**SSRC of granted floor participant:** + +The SSRC of granted floor participant is coded as specified in subclause 8.2.3.16. + +**Floor Priority:** + +The Floor Priority field contains the granted floor priority and is coded as specified in subclause 8.2.3.2. + +**User ID:** + +The User ID field is used in off-network only. The User ID field carries the MCPTT ID of the floor participant granted the floor. The User ID field is coded as described in subclause 8.2.3.8. + +**Queue Size:** + +The Queue Size field is only applicable in off-network and contains the numbers of queued MCPTT clients in the MCPTT call. + +The Queue Size field is coded as specified in subclause 8.2.3.9. + +For each waiting floor participant the following set of fields are included: + +1. the SSRC of queued floor participant; +2. the Queued User ID field; and +3. the Queue info field. + +The set occurs as many times as the value in the Queue size field. + +**SSRC of queued floor participant:** + +The SSRC of queued floor participant is only applicable in off-network and carries the SSRC of the floor participant in the queue. + +The content of the SSRC of queued floor participant is coded as the SSRC specified in IETF RFC 3550 [3]. + +**Queued User ID:** + +The Queued User ID field is only applicable in off-network and contains the MCPTT ID of the floor participant in the queue. + +The Queued User ID field is coded as specified in subclause 8.2.3.11. + +**Queue Info:** + +The Queue Info field is only applicable in off-network and defines the queue position and granted floor priority in the queue. + +The Queue Info field is coded as specified in subclause 8.2.3.5. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +## 8.2.6 Floor Deny message + +### 8.2.6.1 General + +The Floor Deny message is sent as an action from the floor control server to the requesting floor participant to inform that the floor request was rejected. + +The Floor Deny message is used in the off-network mode and in the on-network mode. In the on-network mode the Floor Deny message is only used over the unicast bearer. + +Table 8.2.6.1-1 shows the content of the Floor Deny message. + +**Table 8.2.6.1-1: Floor Deny message** + +![](26c5c426f93cf66d35d87228668dac68_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|------------|---|---|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| V=2 P Subtype | | | | | | | | | | PT=APP=204 | | | | | | | | | | length | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of floor control server/floor arbitrator | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name=MCPT | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Reject Cause field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| User ID field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Track Info field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Floor Indicator field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server for on-network and floor arbitrator for off-network. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Reject Cause:** + +The Reject Cause field includes the reason for the rejecting the floor request and can be followed by a text-string explaining why the floor request was rejected. Therefore the length of the packet will vary depending on the size of the application dependent field. + +The Reject Cause field contains: + +1. a value; and +2. a value. + +Available values are listed in subclause 8.2.6.2. The Reject Cause field is coded as described in subclause 8.2.3.4. + +**User ID:** + +The User ID field is used in off-network only. The User ID carries the MCPTT ID of the requesting floor participant to which the Floor Deny message is sent. + +The User ID field is coded as specified in subclause 8.2.3.8. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +## 8.2.6.2 Rejection cause codes and rejection cause phrase + +Cause #1 - Another MCPTT client has permission + +The value set to '1' indicates that another MCPTT user has permission to send a media. + +Cause #2 - Internal floor control server error + +The value set to '2' indicates that the floor control server cannot grant the floor request due to an internal error. + +Cause #3 - Only one participant + +The value set to '3' indicates that the floor control server cannot grant the floor request, because the requesting party is the only participant in the MCPTT session. + +Cause #4 - Retry-after timer has not expired + +The value set to '4' indicates that the floor control server cannot grant the floor request, because timer T9 (Retry-after) has not expired after permission to send media has been revoked. + +Cause #5 - Receive only + +The value set to '5' indicates that the floor control server cannot grant the floor request, because the requesting party only has receive privilege. + +Cause #6 - No resources available + +The value set to '6' indicates that the floor control server cannot grant the floor request due to congestion. + +Cause #7 – Queue full + +The value set to 7 indicates that the floor control server cannot queue the floor request, because the queue is full. + +Cause #255 - Other reason + +The value set to '255' indicates that the floor control server does not grant the floor request due to the floor control server local policy. + +### 8.2.7 Floor Release message + +The Floor Release message is sent as an action from the floor participant to the floor control server to inform that the floor can be released. + +The Floor Release message can also be sent if the floor participant has a request in the floor request queue. In this case, the Floor Release message is sent to cancel the floor request in the queue. + +The Floor Release message is used in the off-network mode and in the on-network mode. In the on-network mode the Floor Release message is only used on the unicast bearer. + +Table 8.2.7-1 shows the content of the Floor Release message. + +**Table 8.2.7-1: Floor Release message** + +![](f5cf5b5d69186f33dbfee9de41ccb17a_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---------|---|---|---|---|---|------------|---|---|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| V=2 P | | | | Subtype | | | | | | PT=APP=204 | | | | | | | | | | length | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of floor participant with permission to send media | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name=MCPT | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| User ID field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Track Info field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Floor Indicator field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor participant with permission to send media. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**User ID:** + +The User ID field is used in off-network only. The User ID field carries the MCPTT ID of the floor participant sending the floor release message. + +The User ID field is coded as specified in subclause 8.2.3.8. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +## 8.2.8 Floor Idle message + +The Floor Idle message is sent as an action from the floor control server to the floor participant indicating that no floor participant has permission to send media. + +The Floor Idle message is only used in the on-network mode. The Floor Idle message is used over both the unicast and MBMS bearer. + +Table 8.2.8-1 shows the content of the Floor Idle message. + +**Table 8.2.8-1: Floor Idle message** + +![](c4fe9189f9c3abdaedd9f87a20325d7f_img.jpg) + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |V=2|P| Subtype | PT=APP=204 | length=2 | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | SSRC of floor control server | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | name=MCPT | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Message Sequence Number field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Track Info field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Floor Indicator field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Message Sequence Number:** + +The Message Sequence Number field is coded as specified in to subclause 8.2.3.10. + +**Track Info:** + +The Track Info field shall be included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +### 8.2.9 Floor Taken message + +The Floor Taken message is sent as an action from the floor control server to inform non-requesting floor participant(s) that someone has been granted permission to send media. + +The Floor Taken message is used in the off-network mode and in the on-network mode. In the on-network mode the Floor Taken message is used over both the unicast and MBMS bearer. + +Table 8.2.9-1 shows the content of the Floor Taken message. + +**Table 8.2.9-1: Floor Taken message** + +![](3757cff99b0ef34e2262435d7f8f6dfd_img.jpg) + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|---------------------|--------| +| 0 | 1 | 2 | 3 | +| 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 2 3 4 5 6 7 8 9 | 0 1 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| V=2 P | Subtype | PT=APP=204 | length | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | SSRC of floor control server/floor arbitrator | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | name=MCPT | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Granted Party's Identity field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Permission to Request the Floor field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | User ID field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Message Sequence Number field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Track Info field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Floor Indicator field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | SSRC of granted floor participant field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Functional Alias field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | List of Granted Users field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | List of SSRCs of granted floor participants field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | List of Functional Aliases field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | Location field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | +| | List of Locations of granted floor participants field | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server for on-network and floor arbitrator for off-network. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Granted Party's Identity:** + +The Granted Party's Identity field is coded as specified in subclause 8.2.3.6. + +**Permission to request the floor:** + +The Permission to Request the Floor field is coded as specified in subclause 8.2.3.7. + +**User ID:** + +The User ID field is used in off-network only. The User ID field carries the MCPTT user ID of the floor participant sending the Floor Taken message. + +The User ID field is coded as specified in subclause 8.2.3.8. + +**Message Sequence Number:** + +The Message Sequence Number field is coded as specified in to subclause 8.2.3.10. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +**SSRC of granted floor participant:** + +The SSRC of granted floor participant is coded as specified in subclause 8.2.3.16. The field is not used in multi-talker control scenario. + +**Functional Alias:** + +The Functional Alias field contains the functional alias of the granted party and is coded as specified in subclause 8.2.3.19. + +**List of Granted Users:** + +The List of Granted Users field is used in a multi-talker scenario. The List of Granted Users field is coded as specified in subclause 8.2.3.17 and indicates the list of users that have permission to send media. + +**List of SSRCs of granted floor participants:** + +The List of SSRCs field is used in a multi-talker scenario. The List of SSRCs of granted floor participants is coded as specified in subclause 8.2.3.18. The list contains the SSRCs in the same order as the corresponding user IDs in the List of Granted Users field. + +**List of Functional Aliases:** + +The List of Functional Aliases field is used in multi-talker scenario. The List of Functional Aliases field is coded as specified in subclause 8.2.3.20 and indicates the list of Functional Aliases that have permission to send media. The list contains the Functional Aliases in the same order as the corresponding user IDs in the List of Granted Users field. + +**Location:** + +The Location field is coded as specified in subclause 8.2.3.21 and contains the location of the granted party. + +**List of Locations of granted floor participants:** + +The List of Locations field is used in a multi-talker scenario. The List of Locations of granted floor participants is coded as specified in subclause 8.2.3.22. + +## 8.2.10 Floor Revoke message + +### 8.2.10.1 General + +The Floor Revoke message is sent from the floor control server to the floor participant with the permission to send media to inform that the permission to send media is revoked. + +The Floor Revoke message is used in the on-network mode. The Floor Revoke message is only used over the unicast bearer. + +Table 8.2.10.1-1 shows the content of the Floor Revoke message. + +**Table 8.2.10.1-1: Floor Revoke message** + +![](b8d1d78473c7e0df5d8059f40629021a_img.jpg) + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------|---|---|---|---------|---|---|---|---|---|------------|---|---|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| V=2 P | | | | Subtype | | | | | | PT=APP=204 | | | | | | | | | | length | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of floor control server | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name=MCPT | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Reject Cause value | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Track Info field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Floor Indicator field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Reject Cause:** + +The Reject Cause field for the Floor Revoke message includes cause value in the Reject Cause field explaining why the floor control server wants the floor participant to stop sending media and can be followed by additional information. Therefore the length of the packet can vary depending on the value of the rejection cause. + +The coding of the value is specified in subclause 8.2.3.4. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +### 8.2.10.2 Floor revoke cause codes and revoke cause phrases + +Cause #1 – Only one MCPTT client + +The value set to '1' indicates that the MCPTT client is the only MCPTT client in the MCPTT session or the only participant connected to a floor control server. No additional information included. + +Cause #2 – Media burst too long + +The value set to '2' indicates that the MCPTT User has talked too long (e.g., the stop-talking timer has expired). No additional information included. + +Cause #3 - No permission to send a Media Burst + +The value set to '3' indicates that the MCPTT client does not have permission to send media. No additional information is included. + +Cause #4 - Media Burst pre-empted + +The value set to '4' indicates that the MCPTT client 's permission to send a media is being pre-empted. No additional information is included. + +Cause #6 - No resources available + +The value set to '6' indicates that the floor control server can no longer grant MCPTT client to send media due to congestion. No additional information is included. + +Cause #255 – Other reason + +The value set to '255' indicates that the floor control server can no longer grant MCPTT client to send media due to the floor control server local policy. No additional information is included. + +### 8.2.11 Floor Queue Position Request message + +The Floor Queue Position Request message is a request from a floor participant to get information about the floor participant's position in the floor request queue. + +The Floor Queue Position Request message is used in the off-network mode and in the on-network mode. In the on-network mode the Floor Queue Position Request message is only used over the unicast bearer. + +Table 8.2.11-1 shows the content of the Floor Queue Position Request message. + +**Table 8.2.11-1: Floor Queue Position Request message** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |V=2|P| Subtype | PT=APP=204 | length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | SSRC of floor participant requesting floor queue status info | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | name=MCPT | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | User ID field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Track Info field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor participant that is requesting information about its position in the floor request queue. + +The SSRC field is coded as specified in IETF RFC 3550 [3]. + +**User ID:** + +The User ID field is used in off-network only. The User ID field carries the MCPTT user ID of the floor participant sending the Floor Queue Position Request message. + +The User ID field is coded as specified in subclause 8.2.3.8. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +## 8.2.12 Floor Queue Position Info message + +The Floor Queue Position Info message is sent by the floor control server to notify the floor participant of its position in the floor request queue. + +The Floor Queue Position Info message is used in off-network and in on-network mode. In the on-network mode the Floor Queue Position Info message is only used over the unicast bearer. + +Table 8.2.12-1 shows the content of the Floor Queue Position Info message. + +**Table 8.2.12-1: Floor Queue Position Info message** + +| 0 | | | | | | | | 1 | | | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| V=2 P Subtype PT=APP=204 length | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of floor control server/floor arbitrator | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name=MCPT | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| User ID field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| SSRC of queued floor participant field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Queued User ID field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Queue Info field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Track Info field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Floor Indicator field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server for on-network and floor arbitrator for off-network. + +The SSRC field is coded as specified in IETF RFC 3550 [3]. + +#### **User ID:** + +The User ID field is used in off-network only. The User ID field carries the MCPTT ID of the floor participant sending the Floor Queue Position Info message. + +The User ID value is coded as specified in subclause 8.2.3.8. + +#### **SSRC of queued floor participant:** + +The SSRC of queued floor participant is only applicable in off-network and shall carry the SSRC of the queued floor participant. + +The SSRC field shall be coded as specified in subclause 8.2.3.16. + +#### **Queued User ID:** + +The Queued User ID field is used in off-network only. The Queued User ID field carries the MCPTT ID of the queued floor participant. + +The Queued User ID value is coded as specified in subclause 8.2.3.8. + +#### **Queue Info:** + +The Queue Info field defines the queue position and granted floor priority in the queue. + +The Queue Info field is coded as specified in subclause 8.2.3.5. + +#### **Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +#### **Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +### **8.2.13 Floor Ack message** + +The Floor Ack message is used to acknowledge any floor control message that included the first bit (marked as x in the subtype) set to 1 (see subclause 8.2.2). + +The Floor Ack message is only used in the on-network mode. The Floor Ack message is only used over the unicast bearer. + +Table 8.2.13-1 shows the content of the Floor Ack message. + +**Table 8.2.13-1: Floor Ack message** + +![](0721cf4aa4a4582a03f2d132f3fdb523_img.jpg) + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |V=2|P| Subtype | PT=APP=204 | length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | SSRC of the sender | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | name=MCPT | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Message Type field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Track Info field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Location field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the source identified by the Source field. + +The SSRC field is coded as specified in IETF RFC 3550 [3]. + +**Source:** + +The Source field is coded as specified in subclause 8.2.3.12. + +**Message Type:** + +The Message Type field contains the floor control message that is acknowledged by the Floor Ack message. The Message Type field is coded as specified in subclause 8.2.3.14. + +**Track Info:** + +The Track Info field is included when an MCPTT call involves a non-controlling MCPTT function. The coding of the Track Info field is described in subclause 8.2.3.13. + +**Location:** + +The Location field is coded as described in subclause 8.2.3.21 and contains the location information of the granted floor user. This field shall be omitted when location information of the granted floor user is not allowed by the granted floor user's MCPTT profile, or alternatively may be included with the location type field set to '0' (Not provided). + +### 8.2.14 Floor Release Multi Talker message + +The Floor Release Multi Talker message is sent from the floor control server to the floor control participants to indicate that the indicated user has completed media transfer and floor is released. + +The Floor Release Multi Talker message is only used in the on-network mode. The Release Multi Talker message is used over both the unicast and MBMS bearer. + +Table 8.2.14-1 shows the content of the Floor Release Multi Talker message. + +**Table 8.2.14-1: Floor Release Multi Talker message** + +``` + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |V=2|P| Subtype | PT=APP=204 | length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | SSRC | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | name=MCPT | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | User ID field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Track Info field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Floor Indicator field | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype is coded according to table 8.2.2-1. + +**Length:** + +The length is coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field carries the SSRC of the floor control server for on-network and floor arbitrator for off-network.. + +The content of the SSRC field is coded as specified in IETF RFC 3550 [3]. + +**User ID:** + +The User ID carries the MCPTT ID of the floor participant releasing the floor. + +The User ID field is coded as specified in subclause 8.2.3.8. + +**Floor Indicator:** + +The Floor Indicator field is coded as described in subclause 8.2.3.15. + +## 8.3 Pre-established session call control + +### 8.3.1 Introduction + +The pre-established session call control messages shall be coded as described in subclause 8.1.2 where the pre-established session call control message is part of the application-dependent data. + +For the pre-established session call control protocol the ASCII name string shall be: MCPC (Mission Critical Pre-established session call Control). + +A list of pre-established session call control messages can be found in the subclause 8.3.2. + +Pre-established session call control specific fields are specified in subclause 8.3.3. + +### 8.3.2 Pre-established session call control message + +The table 8.3.2-1 provides a list of call control messages. + +**Table 8.3.2-1: Pre-established session call control specific messages** + +| Message name | Subtype | Reference | Direction | +|-----------------------------------------------------------------------------------------------|---------|-----------------|-----------------| +| Connect | x0000 | Subclause 8.3.4 | Server → client | +| Disconnect | x0001 | Subclause 8.3.5 | Server → client | +| Acknowledge | 00010 | Subclause 8.3.6 | Client → server | +| NOTE: The participating MCPTT function is the server and the floor participant is the client. | | | | + +For some messages the first bit (marked as x in the subtype) can be used to indicate if the sender wants to have an acknowledgment. The x is coded as follows: + +'0' Acknowledgment is not required + +'1' Acknowledgment is required + +NOTE: Whether a message needs to be acknowledged or not is described in clause 9. + +If an acknowledgment is required, the Acknowledge message is used to acknowledge the message. + +## 8.3.3 Pre-established session call control fields + +### 8.3.3.1 Introduction + +This subclause describes the pre-established session call control specific data fields. + +The pre-established session call control specific data fields are contained in the application-dependent data of the pre-established session call control message. The pre-established session call control specific data fields follow the syntax specified in subclause 8.1.3. + +**Table 8.3.3.1-1: Void** + +Table 8.3.3.1-2 lists the available data fields including the assigned field ID. + +**Table 8.3.3.1-2: Pre-established session call control data fields** + +| Field name | Field ID | | Reference | +|------------------------------|----------|----------|--------------------| +| | Decimal | Binary | | +| Media Streams | 000 | 00000000 | Subclause 8.3.3.2 | +| MCPTT Session Identity | 001 | 00000001 | Subclause 8.3.3.3 | +| Warning Text | 002 | 00000010 | Subclause 8.3.3.4 | +| MCPTT Group Identity | 003 | 00000011 | Subclause 8.3.3.5 | +| Answer State | 004 | 00000100 | Subclause 8.3.3.6 | +| Inviting MCPTT User Identity | 005 | 00000101 | Subclause 8.3.3.7 | +| Reason Code | 006 | 00000110 | Subclause 8.3.3.8 | +| PCK I_MESSAGE | 192 | 11000000 | Subclause 8.3.3.10 | + +The following subclauses describe the coding of each data field. + +### 8.3.3.2 Media Streams field + +The Media Streams field describes which media streams to use in the session. At the minimum one value shall be included. The value item is only needed when floor control applies during the MCPTT call. + +Table 8.3.3.2-1 describes the coding of the Media Streams field. + +**Table 8.3.3.2-1: Media Streams field coding** + +| 0 | | | | | | | | 1 | | | | | | | | | | | | 2 | | | | | | | | | | | | 3 | | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---------------|---|---|---|---|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|---|---|---|-----------------|---|---|---|---|---|---|---|---|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Media Stream | | | | | | | | Media Streams | | | | | | | | | | | | Media Stream | | | | | | | | | | | Control Channel | | | | | | | | | | | +| field ID value | | | | | | | | length value | | | | | | | | | | | | value | | | | | | | | | | | value | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value shall is a binary value indicating the length in octets of the value and value items. + +The value shall consist of 8 bit parameter giving the number of the "m=audio" m-line negotiated in the pre-established session. + +The value shall consist of 8 bit parameter giving the number of the "m=application" m-line negotiated in the pre-established session. The value is set to "0" when no floor control is used during the session. + +### 8.3.3.3 MCPTT Session Identity field + +The MCPTT Session Identity field contains the MCPTT session identity and the session type. + +Table 8.3.3.3-1 describes the coding of the MCPTT Session Identity field. + +**Table 8.3.3.3-1: MCPTT Session Identity field coding** + +| 0 | | | | | | | | 1 | | | | | | | | | | | | 2 | | | | | | | | | | | | 3 | | | | | | | | | | | | | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|----------------|---|---|---|---|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|---|---|---|---------------|---|---|---|---|---|---|---|---|--|--|--|--|--|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| MCPTT session | | | | | | | | MCPTT session | | | | | | | | | | | | Session Type | | | | | | | | | | | MCPTT Session | | | | | | | | | | | | | | | | | | | | | | +| identity field | | | | | | | | identity field | | | | | | | | | | | | | | | | | | | | | | | Identity | | | | | | | | | | | | | | | | | | | | | | +| ID | | | | | | | | length | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| : | | | | | | | | | | | | | | | | | | | | (Padding) | | | | | | | | | | | : | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value shall is a binary value indicating the length in octets of the value and value items. + +The value is coded as follows: + +- 00000000 = no session type +- 00000001 = private +- 00000011 = prearranged +- 00000100 = chat + +All other values are reserved for future use. + + value contains a SIP URI, which identifies the MCPTT session between the MCPTT client and the controlling MCPTT function; see 3GPP TS 24.379 [2] subclause 4.5. The value is coded specified in table 8.3.3.3-2. + +**Table 8.3.3.3-2: ABNF syntax of string values of the value** + +``` +mcptt-session-identity = SIP-URI +``` + +If the length of the value is not (1 + multiple of 4) bytes, the value shall be padded to (1 + multiple of 4) bytes. The value of the padding bytes should be set to zero. The padding bytes shall be ignored. + +#### 8.3.3.4 Warning Text field + +The Warning Text field contains the text string returned by the controlling MCPTT function in responses to a SIP INVITE request as described in 3GPP TS 24.379 [2] subclause 4.4. + +Table 8.3.3.4-1 describes the coding of the Warning Text field. + +**Table 8.3.3.4-1: Warning Text field coding** + +``` + + 0 1 2 3 +0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|Warning Text |Warning Text |Warning Text | +|field ID |length | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ : +: (Padding) : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value is a binary value indicating the length in octets of the value item excluding any padding octets. + +The value shall be coded as specified in 3GPP TS 24.379 [2] table 4.4.2-1. + +EXAMPLE: If the Warning: 399 "107 User not authorised to make private calls" is received, "107 User not authorised to make private calls" is included as the value. + +If the length of the value is not (2 + multiple of 4) bytes, the value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes should be set to zero. The padding bytes shall be ignored. + +#### 8.3.3.5 MCPTT Group Identity field + +The MCPTT Group Identity field contains a SIP URI identifying the group that an MCPTT client is invited to. + +Table 8.3.3.5-1 describes the coding of the MCPTT Group Identity field. + +**Table 8.3.3.5-1: MCPTT Group Identity field coding** + +``` + + 0 1 2 3 +0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|MCPTT Group |MCPTT Group |MCPTT Group Identity | +|identity field |identity field | | +|ID |length | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ : +: (Padding) : ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +``` + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value is a binary value indicating the length in octets of the value item except padding. + + value contains the MCPTT group identity or the temporary MCPTT group identity as defined in 3GPP TS 24.379 [2]. The value shall be coded as specified in the table 8.3.3.5-2. + +**Table 8.3.3.5-2: ABNF syntax of string values of the value** + +| | +|---------------------------------------| +| 
mcptt-group-identity = URI
| +|---------------------------------------| + +If the length of the value is not (2 + multiple of 4) bytes, the value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes should be set to zero. The padding bytes shall be ignored. + +### 8.3.3.6 Answer State field + +The Answer State field indicates if invited MCPTT users are invited using automatic or manual commencement mode. + +Table 8.3.3.6-1 describes the coding of the Answer State field. + +**Table 8.3.3.6-1: Answer State field coding** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-----------------------|---|---|---|---|---|---|---|---------------------------|---|---|---|---|---|---|---|--------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| Answer State field ID | | | | | | | | Answer State length value | | | | | | | | Answer State value | | | | | | | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value is a binary value and shall have the value '2' indicating the total length in octets of the value item. + +The value is a 16-bit binary value with the following values: + +'0' Unconfirmed + +'1' Confirmed + +All other values are reserved for future use. + +### 8.3.3.7 Inviting MCPTT User Identity field + +The Inviting MCPTT User Identity field contains the MCPTT ID identifying the inviting MCPTT user. + +Table 8.3.3.7-1 describes the coding of the Inviting MCPTT User Identity field. + +**Table 8.3.3.7-1: Inviting MCPTT User Identity field coding** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------------------|---|---|---|---|---|---|---|-------------------------------------|---|---|---|---|---|---|---|------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| Inviting MCPTT User Identity field ID | | | | | | | | Inviting MCPTT User Identity length | | | | | | | | Inviting MCPTT User Identity | | | | | | | | | | | | | | | | +| : | | | | | | | | | | | | | | | | (Padding) : | | | | | | | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value is a binary value indicating the length in octets of the value item except padding. + +The value contains the MCPTT ID of the inviting MCPTT user. The value shall be coded as specified in the table 8.3.3.7-2. The MCPTT ID is specified in 3GPP TS 24.379 [2]. + +**Table 8.3.3.7-2: ABNF syntax of string values of the value** + +| | +|-------------------------------------------------| +| inviting-mcptt-user-identity = URI | +|-------------------------------------------------| + +If the length of the value is not (2 + multiple of 4) bytes, the value shall be padded to (2 + multiple of 4) bytes. The value of the padding bytes should be set to zero. The padding bytes shall be ignored. + +### 8.3.3.8 Reason Code field + +The Reason Code field contains the answer to a pre-established call control message. + +Table 8.3.3.8-1 describes the coding of the Reason Code field. + +**Table 8.3.3.8-1: Reason Code field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|----------------|---|---|---|---|---|---|---|---|---|--------------|---|---|---|---|---|---|---|---|---|-------------|---|---|---|---|---|---|---|---|---|-------|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| Reason Code | | | | | | | | | | Reason Code | | | | | | | | | | Reason Code | | | | | | | | | | value | | | | | | | | | | +| field ID value | | | | | | | | | | length value | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value is a binary value and shall have the value '2' indicating the total length in octets of the value item. + +The value is a 16-bit binary value with the following values: + +- '0' Accepted +- '1' Busy +- '2' Not Accepted + +All other values are reserved for future use. + +### 8.3.3.9 Handling of unknown fields and messages + +When a pre-establish session control message is received the MCPTT client and the participating MCPTT function shall: + +1. ignore the whole message, if the subtype is unknown; +2. ignore the unspecified fields in the message (e.g. specified in future version of the pre-establish session control protocol); and +3. ignore the syntactically incorrect optional fields. + +### 8.3.3.10 PCK I\_MESSAGE field + +The PCK I\_MESSAGE field is a MIKEY payload containing a MIKEY-SAKKE I\_MESSAGE as defined in IETF RFC 6509 [17] and as received in the SIP INVITE message. The PCK I\_MESSAGE contains the PCK and PCK-ID (see 3GPP TS 24.379 [2] subclause 4.7). + +Table 8.3.3.10-1 describes the coding of the PCK I\_MESSAGE field. + +**Table 8.3.3.10-1: PCK I\_MESSAGE field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|----------------|---|---|---|---|---|---|---|---|---|--------------------|---|---|---|---|---|---|---|---|---|---------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| PCK I_MESSAGE | | | | | | | | | | PCK I_MESSAGE | | | | | | | | | | PCK I_MESSAGE | | | | | | | | | | | | | | | | | | | | +| field_ID value | | | | | | | | | | field_length value | | | | | | | | | | field value | | | | | | | | | | | | | | | | | | | | +| : | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | : | | | | | | | | | | +| : | | | | | | | | | | : | | | | | | | | | | (Padding) | | | | | | | | | | : | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.3.3.1-2. + +The value is a binary value indicating the length in octets of the value item. + +The value contains the MIKEY-SAKKE I\_MESSAGE for PCK as received in the SIP INVITE message. + +### 8.3.4 Connect message + +The Connect message is sent by the participating MCPTT function on the originating side to the MCPTT client to confirm the establishment of an MCPTT call or sent on the terminating side to initiate an MCPTT call. The Connect message is only used in the on-network mode and only sent over the unicast bearer. + +Table 8.3.4-1 shows the content of the Connect message. + +**Table 8.3.4-1: Connect message** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | +|----------------|---|---|---|---|---|---|---|---|---|--------------------------------------|---|---|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| V=2 P Subtype | | | | | | | | | | PT=APP=204 | | | | | | | | | | Length | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | SSRC of participating MCPTT function | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | name=MCPC | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | MCPTT Session Identity field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | MCPTT Group Identity field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | Media Streams field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | Warning Text field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | Answer State field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | Inviting MCPTT User Identity field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | PCK I_MESSAGE field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype shall be coded according to table 8.3.2-1. + +**Length:** + +The length shall be coded as specified in to subclause 8.1.2. + +**SSRC:** + +The SSRC field shall carry the SSRC of the participating MCPTT function. + +The SSRC field shall be coded as specified in IETF RFC 3550 [3]. + +**MCPTT Session Identity:** + +The MCPTT Session Identity field is coded as described in subclause 8.3.3.3. + +**MCPTT Group Identity:** + +The MCPTT Group Identity field is coded as described in subclause 8.3.3.5. + +**Media Streams:** + +The Media Streams field is coded as described in subclause 8.3.3.2. + +**Warning Text:** + +The Warning Text field is coded as described in subclause 8.3.3.4. + +**Answer State:** + +The Answer State field is coded as described in subclause 8.3.3.6. + +When the Answer State field is not included the value "confirmed" shall be assumed. + +**Inviting MCPTT User Identity:** + +The Inviting MCPTT User Identity field is coded as described in subclause 8.3.3.5. + +When the inviting MCPTT user requested privacy, the identity shall be used. + +**PCK I\_MESSAGE:** + +The PCK I\_MESSAGE is used to transport the PCK and PCK-ID for use in private call. + +This field is used when the terminating participating MCPTT function sends the Connect message to the terminating client for a private call. + +### 8.3.5 Disconnect message + +Table 8.3.5-1 shows the content of the Connect message. + +**Table 8.3.5-1: Disconnect message** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------------------------------|---|---|---------|---|---|---|---|------------|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 0 | | | | | | | | 1 | | | | | | | | 2 | | | | | | | | 3 | | | | | | | | +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | +| V=2 | | P | Subtype | | | | | PT=APP=204 | | | | | | | | Length | | | | | | | | | | | | | | | | +| SSRC of participating MCPTT function | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| name=MCPC | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| MCPTT Session Identity field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype shall be coded according to table 8.3.2-1. + +**Length:** + +The length shall be coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field shall carry the SSRC of the participating MCPTT function. + +The SSRC field shall be coded as specified in IETF RFC 3550 [3]. + +**MCPTT Session Identity:** + +The MCPTT Session Identity field is coded as described in subclause 8.3.3.3. + +### 8.3.6 Acknowledgement message + +Table 8.3.6-1 shows the content of the Acknowledgement message. + +**Table 8.3.6-1: Acknowledgement message** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | | | | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---------------------------|---|---|---|---|---|---|---|---|---|---|---|------------|---|---|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|---|---|---|---|---|---|---|--|--|--|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| V=2 P | | | | Subtype | | | | | | | | | | | | PT=APP=204 | | | | | | | | | | Length | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | SSRC of floor participant | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | name=MCPC | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | Reason Code field | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +With the exception of the three first 32-bit words the order of the fields are irrelevant. + +**Subtype:** + +The subtype shall be coded according to table 8.3.2-1. + +**Length:** + +The length shall be coded as specified in subclause 8.1.2. + +**SSRC:** + +The SSRC field shall carry the SSRC of the floor participant. + +The SSRC field shall be coded as specified in IETF RFC 3550 [3]. + +**Reason Code:** + +The Reason Code field is coded as described in subclause 8.3.3.8. + +## 8.4 MBMS subchannel control + +### 8.4.1 Introduction + +The MBMS subchannel control messages shall be coded as described in subclause 8.1.2 where the MBMS subchannel control message is part of the application-dependent data. + +For the MBMS subchannel control protocol the ASCII name string shall be: MCMC. + +The list of MBMS subchannel control messages can be found in the subclause 8.4.2. + +The MBMS subchannel control specific fields are specified in subclause 8.4.3. + +### 8.4.2 MBMS subchannel control messages + +Table 8.4.2-1 provides a list of MBMS subchannel control protocol messages. + +**Table 8.4.2-1: MBMS subchannel control protocol messages** + +| Message name | Subtype | Reference | Direction | +|------------------------------------------------------------------------------------------|---------|-----------------|-----------------| +| Map Group To Bearer | 00000 | subclause 8.4.4 | Server → client | +| Unmap Group To Bearer | 00001 | subclause 8.4.5 | Server → client | +| Application Paging | 00010 | subclause 8.4.6 | Server → client | +| Bearer Announcement | 00011 | subclause 8.4.7 | Server → client | +| NOTE: The participating MCPTT function is the server and the MCPTT client is the client. | | | | + +## 8.4.3 MBMS subchannel control specific fields + +### 8.4.3.1 Introduction + +This subclause describes the MBMS subchannel control specific data fields. + +The MBMS subchannel control specific data fields are contained in the application-dependent data of the MBMS subchannel control message. The MBMS subchannel control specific data fields follow the syntax specified in subclause 8.1.3. + +**Table 8.4.3.1-1: Void** + +Table 8.4.3.1-2 lists the available fields including the assigned Field ID. + +**Table 8.4.3.1-2: MBMS subchannel control specific data fields** + +| Field name | Field ID | | Description | +|------------------|----------|----------|--------------------| +| | Decimal | Binary | | +| MBMS Subchannel | 000 | 00000000 | Subclause 8.4.3.3 | +| TMGI | 001 | 00000001 | Subclause 8.4.3.4. | +| MCPTT Group ID | 002 | 00000010 | Subclause 8.4.3.2 | +| Monitoring State | 003 | 00000011 | Subcaluse 8.4.3.6 | + +### 8.4.3.2 MCPTT Group ID field + +The MCPTT Group ID field contains a SIP URI identifying the MCPTT group for which media and floor control messages are going to be broadcasted over a MBMS subchannel. + +The MCPTT Group ID field is coded as the MCPTT Group Identity field specified in subclause 8.3.3.5. + +### 8.4.3.3 MBMS Subchannel field + +The MBMS Subchannel field describes which MBMS subchannel to use for media and for floor control. + +Table 8.4.3.3-1 describes the coding of the MBMS Subchannel field. + +**Table 8.4.3.3-1: MBMS Subchannel field coding** + +| 0 | | | | | | | | | | 1 | | | | | | | | | | 2 | | | | | | | | | | 3 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---------------------------|---|---|---|---|---|---|---|--------|---|---|---|---|---|---|--------|---|---|---|---|---|---|---------|---|---|---|---|---|---|-------|---|---|---|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| MBMS Subchannel | | | | | | | MBMS Subchannel | | | | | | | | Audio | | | | | | | Floor | | | | | | | IP | | | | | | | spare | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| field ID value | | | | | | | length value | | | | | | | | m-line | | | | | | | m-line | | | | | | | Version | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | Number | | | | | | | Number | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | Floor control Port Number | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | Media Port Number | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | : IP Address : | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +The value is a binary value and shall be set according to table 8.4.3.1-2. + +The value is a binary value indicating the total length in octets of the http://schemas.xmlsoap.org/wsdl/http/ | +| soap | http://schemas.xmlsoap.org/wsdl/soap/ | +| soapenc | http://schemas.xmlsoap.org/soap/encoding/ | +| xs | http://www.w3.org/2001/XMLSchema | +| LCIRPLCSystem | http://www.3gpp.org/ftp/specs/archive/28_series/28303#LCIRPLCSystem | +| LCIRPNMData | http://www.3gpp.org/ftp/specs/archive/28_series/28303#LCIRPNMData | +| LCIRPLCRSystem | http://www.3gpp.org/ftp/specs/archive/28_series/28303#LCIRPLCRSystem | + +## B.2 Mapping + +### B.2.1 Operation mapping + +3GPP TS 28.302 [2] defines the semantics of operations. This chapter specifies the mapping of these operations to their SS equivalents. + +Table B.2.1.1: Mapping from IS operations to SS equivalents (scenario 1, interface OperationsInvokedByNM) + +| IS operation
(3GPP TS 28.302 [2]) | SS operation | Port | Support Qualifier | +|--------------------------------------|-------------------------|-------------|-------------------| +| requestLcRegistration | requestLcRegistration | LCIRPLCPort | M | +| requestLcDeRegistration | requestLcDeRegistration | LCIRPLCPort | M | +| getLSRAI | getLSRAI | LCIRPLCPort | M | + +Table B.2.1.2: Mapping from IS operations to SS equivalents (scenario 1, interface OperationsInvokedByLC) + +| IS operation
(3GPP TS 28.302 [2]) | SS operation | Port | Support Qualifier | +|--------------------------------------|----------------------|-------------|-------------------| +| getLSRAIConfirmation | getLSRAIConfirmation | LCIRPNMPort | M | + +Table B.2.1.3: Mapping from IS operations to SS equivalents (scenario 2, interface OperationsInvokedByNM) + +| IS operation
(3GPP TS 28.302 [2]) | SS operation | Port | Support Qualifier | +|--------------------------------------|---------------------------|-------------|-------------------| +| cellsUpdate | cellsUpdate | LCIRPLCPort | M | +| cellsConstraintsSatisfied | cellsConstraintsSatisfied | LCIRPLCPort | M | + +Table B.2.1.4: Mapping from IS operations to SS equivalents (scenario 2, interface OperationsInvokedByLC) + +| IS operation
(3GPP TS 28.302 [2]) | SS operation | Port | Support Qualifier | +|--------------------------------------|------------------------|-------------|-------------------| +| cellsConstraintsUpdate | cellsConstraintsUpdate | LCIRPNMPort | M | + +### B.2.2 Notification mapping + +3GPP TS 28.302 [2] defines the semantics of notifications. This clause specifies the mapping of these notifications to their SS equivalents. + +Table B.2.2.1: Mapping from IS operations to SS equivalents (scenario 1, interface NotificationsEmittedByLC) + +| IS notification
(3GPP TS 28.302 [2]) | SS notification | Port | Support Qualifier | +|-----------------------------------------|------------------------|-------------|-------------------| +| notifyLCRegistration | notifyLCRegistration | LCIRPLCPort | M | +| notifyLCDeRegistration | notifyLCDeRegistration | LCIRPLCPort | M | +| notifyZoneCreation | notifyZoneCreation | LCIRPLCPort | M | +| notifyZoneDeletion | notifyZoneDeletion | LCIRPLCPort | M | +| notifyZoneModification | notifyZoneModification | LCIRPLCPort | M | + +Table B.2.2.2: Mapping from IS operations to SS equivalents (scenario 1, interface NotificationsEmittedByNM) + +| IS notification
(3GPP TS 28.302 [2]) | SS notification | Port | Support Qualifier | +|-----------------------------------------|-------------------------|-------------|-------------------| +| notifyLSRAIConfirmation | notifyLSRAIConfirmation | LCIRPNMPort | M | + +Table B.2.2.3: Mapping from IS operations to SS equivalents (scenario 2, interface NotificationsEmittedByLC) + +| IS notification
(3GPP TS 28.302 [2]) | SS notification | Port | Support Qualifier | +|-----------------------------------------|------------------------|-------------|-------------------| +| notifyLCRegistration | notifyLCRegistration | LCIRPLCPort | M | +| notifyLCDeRegistration | notifyLCDeRegistration | LCIRPLCPort | M | + +Table B.2.2.4: Mapping from IS operations to SS equivalents (scenario 2, interface NotificationsEmittedByNM) + +| IS notification
(3GPP TS 28.302 [2]) | SS notification | Port | Support
Qualifier | +|-----------------------------------------|-----------------|------|----------------------| +| | | | | + +### B.2.3 Operation parameter mapping + +#### B.2.3.1 Operation requestLcRegistration + +##### B.2.3.1.1 Input parameters + +Table B.2.3.1.1.1: Mapping from IS requestLcRegistration input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| licenseId | licenseId | M | +| lCId | lCId | M | +| lRId | lRId | M | + +XML schema fragment of the requestLcRegistration request: + +``` + + + + + + + + + +``` + +##### B.2.3.1.2 Output parameters + +Table B.2.3.1.2.1: Mapping from IS requestLcRegistration output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| licenseId | licenseId | M | +| lCId | lCId | M | +| lRId | lRId | M | +| cause | cause | M | +| result | No direct mapping | -- | + +XML schema fragment of the requestLcRegistration response: + +``` + + + + + + + + + +``` + +##### B.2.3.1.3 Fault definition + +``` + + + + + + + +``` + +#### B.2.3.2 Operation `requestLcDeRegistration` + +##### B.2.3.2.1 Input parameters + +Table B.2.3.2.1.1: Mapping from IS `requestLcDeRegistration` input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| lCId | lCId | M | +| lRId | lRId | M | + +XML schema fragment of the `requestLcDeRegistration` request: + +``` + + + + + + + + +``` + +##### B.2.3.2.2 Output parameters + +Table B.2.3.2.2.2: Mapping from IS `requestLcDeRegistration` output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| lCId | lCId | M | +| lRId | lRId | M | +| cause | cause | M | +| result | No direct mapping | -- | + +XML schema fragment of the `requestLcDeRegistration` response: + +``` + + + + + + + + +``` + +##### B.2.3.2.3 Fault definition + +``` + + + + + + + +``` + +#### B.2.3.3 Operation `getLSRAI` + +##### B.2.3.3.1 Input parameters + +Table B.2.3.3.1.1: Mapping from IS `getLSRAI` input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| scope | scope | M | + +XML schema fragment of the `getLSRAI` request: + +``` + + +``` + +``` + + + + + + + +``` + +##### B.2.3.3.2 Output parameters + +Table B.2.3.3.2.1: Mapping from IS getLSRAI output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| ISRAI | ISRAI | M | +| status | No direct mapping | -- | + +XML schema fragment of the getLSRAI response: + +``` + + + + + + + + + +``` + +##### B.2.3.3.3 Fault definition + +``` + + + + + + + + + +``` + +#### B.2.3.4 Operation getLSRAIConfirmation + +##### B.2.3.4.1 Input parameters + +Table B.2.3.4.1.1: Mapping from IS getLSRAIConfirmation input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| status | No direct mapping | -- | + +XML schema fragment of the getLSRAIConfirmation request: + +``` + + + + + + + + +``` + +##### B.2.3.4.2 Output parameters + +Table B.2.3.4.2.1: Mapping from IS getLSRAIConfirmation output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| confirmedZoneList | confirmedZoneList | M | + +XML schema fragment of the getLSRAIConfirmation response: + +``` + + + + + + + + + +``` + +``` + + +``` + +##### B.2.3.4.3 Fault definition + +``` + + + + + + + +``` + +#### B.2.3.5 Operation cellsUpdate + +##### B.2.3.5.1 Input parameters + +Table B.2.3.5.1.1: Mapping from IS cellsUpdate input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| addedLSACells | addedLSACells | O | +| modifiedLSACells | modifiedLSACells | O | +| removedLSACells | removedLSACells | O | + +XML schema fragment of the cellsUpdate request: + +``` + + + + + + + + + +``` + +##### B.2.3.5.2 Output parameters + +Table B.2.3.5.2.1: Mapping from IS cellsUpdate output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| status | No direct mapping | -- | + +XML schema fragment of the cellsUpdate response: + +``` + + + + + + +``` + +##### B.2.3.5.3 Fault definition + +``` + + + + + + + +``` + +#### B.2.3.6 Operation `cellsConstraintsSatisfied` + +##### B.2.3.6.1 Input parameters + +Table B.2.3.6.1.1: Mapping from IS `cellsConstraintsSatisfied` input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|-------------------------------|-------------------------------|-----------| +| cellsConstraints | cellsConstraints | M | + +XML schema fragment of the `cellsConstraintsSatisfied` request: + +``` + + + + + + + +``` + +##### B.2.3.6.2 Output parameters + +Table B.2.3.6.2.1: Mapping from IS `cellsConstraintsSatisfied` output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| status | No direct mapping | -- | + +XML schema fragment of the `cellsConstraintsSatisfied` response: + +``` + + + + + + +``` + +##### B.2.3.6.3 Fault definition + +``` + + + + + + + +``` + +#### B.2.3.7 Operation `cellsConstraintsUpdate` + +##### B.2.3.7.1 Input parameters + +Table B.2.3.7.1.1: Mapping from IS `cellsConstraintsUpdate` input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|-------------------------------|-------------------------------|-----------| +| cellsConstraints | cellsConstraints | M | + +XML schema fragment of the `cellsConstraintsUpdate` request: + +``` + + + + + + + +``` + +##### B.2.3.7.2 Output parameters + +Table B.2.3.7.2.1: Mapping from IS `cellsConstraintsUpdate` output parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| status | No direct mapping | -- | + +XML schema fragment of the `cellsConstraintsUpdate` response: + +``` + + + + + + +``` + +##### B.2.3.7.3 Fault definition + +``` + + + + + + + +``` + +### B.2.4 Notification parameter mapping + +#### B.2.4.1 Notification `notifyLCRegistration` + +##### B.2.4.1.1 Input parameters + +Table B.2.4.1.1.1: Mapping from IS `notifyLCRegistration` input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| licenseId | licenseId | M | +| lCIId | lCIId | M | +| lRIId | lRIId | M | + +XML schema fragment of the `notifyLCRegistration` request: + +``` + + + + + + + + + + +``` + +#### B.2.4.2 Notification `notifyLCDeRegistration` + +##### B.2.4.2.1 Input parameters + +Table B.2.4.2.1.1: Mapping from IS `notifyLCDeRegistration` input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| licenseId | licenseId | M | +| lCIId | lCIId | M | +| lRIId | lRIId | M | + +XML schema fragment of the `notifyLCDeRegistration` request: + +``` + + + + + + + + + + + + +``` + +#### B.2.4.3 Notification notifyZoneCreation + +##### B.2.4.3.1 Input parameters + +Table B.2.4.3.1.1: Mapping from IS notifyZoneCreation input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| ISRAI | ISRAI | M | + +XML schema fragment of the notifyZoneCreation request: + +``` + + + + + + + + + + +``` + +#### B.2.4.4 Notification notifyZoneDeletion + +##### B.2.4.4.1 Input parameters + +Table B.2.4.4.1.1: Mapping from IS notifyZoneDeletion input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| ISRAI | ISRAI | M | + +XML schema fragment of the notifyZoneDeletion request: + +``` + + + + + + + + + + +``` + +#### B.2.4.5 Notification notifyZoneModification + +##### B.2.4.5.1 Input parameters + +Table B.2.4.5.1.1: Mapping from IS notifyZoneModification input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| ISRAI | ISRAI | M | + +XML schema fragment of the notifyZoneModification request: + +``` + + + + + + + + +``` + +#### B.2.4.6 Notification notifyLSRAIConfirmation + +##### B.2.4.6.1 Input parameters + +Table B.2.4.6.1.1: Mapping from IS notifyLSRAIConfirmation input parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| confirmedZoneList | confirmedZoneList | M | + +XML schema fragment of the notifyLSRAIConfirmation request: + +``` + + + + + + + + +``` + +## B.3 Solution Set definitions + +### B.3.1 WSDL definition structure + +Clause B.3.2 provides a graphical representation of the Licensed Shared Access (LSA) Controller (LC) IRP service. + +Clause B.3.3 defines the services which are supported by the Licensed Shared Access (LSA) Controller (LC) IRP agent in the LC and which are common for scenario 1 and scenario 2. + +Clause B.3.4 defines the services which are supported by the Licensed Shared Access (LSA) Controller (LC) IRP agent in the LC for scenario 1. + +Clause B.3.5 defines the services which are supported by the Licensed Shared Access (LSA) Controller (LC) IRP agent in the NM for scenario 1. + +Clause B.3.6 defines the services which are supported by the Licensed Shared Access (LSA) Controller (LC) IRP agent in the LC for scenario 2. + +Clause B.3.7 defines the services which are supported by the Licensed Shared Access (LSA) Controller (LC) IRP agent in the NM for scenario 2. + +### B.3.2 Graphical Representation + +A graphical representation is not provided in the present document. + +### B.3.3 WSDL specification "LCIRPLCRSystem.wsdl" + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + +``` + +### B.3.4 WSDL specification "LCIRPLCSystem.wsdl" (scenario 1) + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### B.3.5 WSDL specification "LCIRPNMSystem.wsdl" (scenario 1) + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + +``` + +### B.3.6 WSDL specification "LCIRPLCSystem.wsdl" (scenario 2) + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### B.3.7 WSDL specification "LCIRPNMSystem.wsdl" (scenario 2) + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|----------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170471 | | | | Presented for information and approval | 1.0.0 | +| 2017-06 | SA#76 | | | | | Upgrade to change control version | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28304/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/28_series/28304/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5052e7c8403c17b508153cead3139c4f29208cb1 --- /dev/null +++ b/marked/Rel-16/28_series/28304/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c495f36d664a56a7700ee1d973f90590deb6c0e6c569cffc7357fc979725cce +size 73131 diff --git a/marked/Rel-16/28_series/28304/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-16/28_series/28304/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e3fac759517374a2ba58fb5877150f06ff81420a --- /dev/null +++ b/marked/Rel-16/28_series/28304/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9938a62392698e243099f1f471b82d5c890d7f81312f95d2a85eac423c5ea74d +size 14583 diff --git a/marked/Rel-16/28_series/28304/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/28_series/28304/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c07b4d10721b82ce393af96bf6e6fd22c4bf1851 --- /dev/null +++ b/marked/Rel-16/28_series/28304/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de800b4403e5cc7a3b5e8bf6fe27e0002c1cf9f77efb47e202e0af5f76592426 +size 11980 diff --git a/marked/Rel-16/28_series/28304/e2c1c672349c10dccb2563eff6d8260e_img.jpg b/marked/Rel-16/28_series/28304/e2c1c672349c10dccb2563eff6d8260e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e764fd8410d294f3c3831a361f6e2d579d18caf5 --- /dev/null +++ b/marked/Rel-16/28_series/28304/e2c1c672349c10dccb2563eff6d8260e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb11ba334752511282d9a270751306ef252b869a8faee76130a53809a0afa2b4 +size 12967 diff --git a/marked/Rel-16/28_series/28304/raw.md b/marked/Rel-16/28_series/28304/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cdd68b0bbac44fa1fc658538ed2a63eb6472b685 --- /dev/null +++ b/marked/Rel-16/28_series/28304/raw.md @@ -0,0 +1,440 @@ + + +# 3GPP TS 28.304 V16.0.0 (2020-07) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Requirements (Release 16)** --- + +## --- **Keywords** + +energy efficiency, network management + +### **3GPP** + +### --- **Postal address** + +### --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +## --- Contents + +| | | +|---------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Concepts and background ..... | 6 | +| 4.1 General ..... | 6 | +| 4.2 Architecture ..... | 7 | +| 4.3 Functionality..... | 8 | +| 5 Business level requirements..... | 8 | +| 5.1 Requirements..... | 8 | +| 5.2 Actor roles ..... | 9 | +| 5.3 Telecommunication resources..... | 10 | +| 5.4 High-level use cases..... | 10 | +| 5.4.1 Use case: Managing the monitoring of PEE parameters ..... | 10 | +| 5.4.2 Use case: Controlling PEE related parameters ..... | 11 | +| 5.4.3 Use case: Supervising PEE related alarms ..... | 11 | +| 5.4.4 Use case: Monitoring PEE related configuration changes ..... | 12 | +| 6 Specification level requirements..... | 12 | +| 6.1 Requirements..... | 12 | +| 6.1.1 Requirements for solution 1 ..... | 12 | +| 6.1.2 Requirements for solution 2 ..... | 12 | +| 6.2 Actor roles ..... | 13 | +| 6.2.1 Actor roles for solution 1 ..... | 13 | +| 6.2.2 Actor roles for solution 2 ..... | 13 | +| 6.3 Telecommunication resources..... | 13 | +| 6.3.1 Telecommunication resources for solution 1..... | 13 | +| 6.3.2 Telecommunication resources for solution 2..... | 13 | +| 6.4 Use cases ..... | 13 | +| 6.4.1 Use cases for solution 1 ..... | 13 | +| 6.4.1.1 Use case: Initiating PEE performance management job..... | 13 | +| 6.4.1.2 Use case: Controlling PEE related threshold ..... | 13 | +| 6.4.1.3 Use case: Supervising PEE related alarms ..... | 13 | +| 6.4.1.4 Use case: Monitoring PEE related configuration changes..... | 14 | +| 6.4.2 Use cases for solution 2 ..... | 14 | +| Annex A (informative): Change history..... | 15 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.304 **Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Requirements** +- 28.305 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP): Information Service (IS) +- 28.306 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP): Solution Set (SS) definitions + +# --- 1 Scope + +The present document specifies the requirements for the control and monitoring of Power, Energy and Environmental (PEE) parameters in the following types of Radio Access Networks (RAN): GSM, UTRAN and E-UTRAN. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] ETSI ES 202 336-12 (V1.1.1) (2015-06): "Environmental Engineering (EE); Monitoring and control interface for infrastructure equipment (power, cooling and building environment systems used in telecommunication networks); Part 12: ICT equipment power, energy and environmental parameters monitoring information model". +- [4] ETSI ES 202 336-1 (V1.1.2) (2008-09): " Environmental Engineering (EE); Monitoring and Control Interface for Infrastructure Equipment (Power, Cooling and Building Environment Systems used in Telecommunication Networks) Part 1: Generic Interface". +- [5] 3GPP TS 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements". +- [6] 3GPP TS 32.411: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Requirements". +- [7] 3GPP TS 32.111-1: "Telecommunication management; Fault Management; Part 1: 3G fault management requirements". +- [8] 3GPP TS 32.611: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Requirements". +- [9] 3GPP TS 32.301: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Remote Management Server:** Application which controls and monitors power, energy and environmental parameters of Radio Access Networks. + +**Network Management layer Remote Management Server:** Remote Management Server which operates at the NM layer. + +**Vendor-Specific Remote Management Server:** Remote Management Server which operates at the DM layer. + +**XCU:** Defined in ETSI ES 202 336-12 [3]. + +**DGU:** Defined in ETSI ES 202 336-12 [3]. + +NOTE: The concept of Remote Management Server is introduced in ETSI ES 202 336-12 [3] – Figure 1 (Principles of the monitoring of ICT equipment power, energy and environment parameters). + +## 3.2 Abbreviations + +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]. + +| | | +|--------|---------------------------------| +| CU | Control Unit | +| DGU | Data Gathering Unit | +| NM-RMS | Network Management layer RMS | +| PEE | Power, Energy and Environmental | +| RMS | Remote Management Server | +| VS-RMS | Vendor-Specific RMS | +| XCU | XML enabled CU | + +# --- 4 Concepts and background + +## 4.1 General + +With regard to the control and monitoring of their Power, Energy and Environmental (PEE) parameters, base stations can be of two different types: + +- # either they have built-in sensors, which communicate with DM through Type-1 interface. In turn, DM communicates with the NM-RMS (see figure 4.1.1); +- # or they have external sensors, which communicate with the NM-RMS via: + - either XCU/DGU (see figure 4.1.1) + - or vendor-specific RMS (VS RMS) (see figure 4.1.1). + +The NM-RMS collects PEE parameters from part or whole of the radio access network and may also control PEE related parameters through either DM(s) and/or XCU/DGU(s) and/or VS-RMS(s). + +For this reason, it is beneficial to standardize the interface to control and monitor PEE parameters between the NM-RMS on the one hand and DM, XCU/DGU and VS-RMS on the other hand. This TS series specifies this Type-2 interface (see TS 32.101 [2]). + +![Overall architecture for the control and monitoring of PEE parameters. The diagram shows three layers: Network Element Layer, Element Management Layer, and Network Management Layer. In the Network Element Layer, there are two 'Telecom Site' boxes. The top one contains a 'Power Supply System' and a 'PEE XCU or DGU ES 202 336-12' connected by a 'Non-standardized interface'. The bottom one contains a 'Power system' and a 'Base Station' connected by a 'Type 1: Embedded sensors' interface. In the Element Management Layer, there are 'VS-RMS' and 'DM' boxes. In the Network Management Layer, there is an 'NM-RMS' box. Interfaces include '3GPP Type-2 interface' between NM-RMS and VS-RMS, '3GPP Type-1 interface' between DM and the bottom Telecom site, and a 'Type 2: External sensors A or A3 power interface' between the top Telecom site and NM-RMS.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +Overall architecture for the control and monitoring of PEE parameters. The diagram shows three layers: Network Element Layer, Element Management Layer, and Network Management Layer. In the Network Element Layer, there are two 'Telecom Site' boxes. The top one contains a 'Power Supply System' and a 'PEE XCU or DGU ES 202 336-12' connected by a 'Non-standardized interface'. The bottom one contains a 'Power system' and a 'Base Station' connected by a 'Type 1: Embedded sensors' interface. In the Element Management Layer, there are 'VS-RMS' and 'DM' boxes. In the Network Management Layer, there is an 'NM-RMS' box. Interfaces include '3GPP Type-2 interface' between NM-RMS and VS-RMS, '3GPP Type-1 interface' between DM and the bottom Telecom site, and a 'Type 2: External sensors A or A3 power interface' between the top Telecom site and NM-RMS. + +Figure 4.1.1: Overall architecture for the control and monitoring of PEE parameters + +## 4.2 Architecture + +The NM-RMS is a located in the NM layer (see also TS 32.101 [2]). + +VS-RMS is located in the DM layer (see also TS 32.101 [2]). + +XCU/DGU is located in the Network Element layer (see also TS 32.101 [2]). + +Possible interfaces between all these entities are depicted in figure 4.1.1. The three possible scenarios for this IRP are depicted in figures 4.2.1, 4.2.2 and 4.2.3. + +![NM-RMS to XCU/DGU Type-2 interface diagram. It shows a box labeled 'XCU/DGU' on the left and a box labeled 'NM-RMS' on the right, separated by a vertical dashed line representing the 'Type 2 interface'. A curved arrow labeled 'PEECMON IRP' points from the NM-RMS side towards the interface.](e2c1c672349c10dccb2563eff6d8260e_img.jpg) + +NM-RMS to XCU/DGU Type-2 interface diagram. It shows a box labeled 'XCU/DGU' on the left and a box labeled 'NM-RMS' on the right, separated by a vertical dashed line representing the 'Type 2 interface'. A curved arrow labeled 'PEECMON IRP' points from the NM-RMS side towards the interface. + +Figure 4.2.1: NM-RMS to XCU/DGU Type-2 interface + +![Diagram of NM-RMS to VS-RMS Type-2 interface](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram shows a VS-RMS block on the left and an NM-RMS block on the right, connected by a solid horizontal line. A vertical dashed line bisects the connection. Below the dashed line, an arrow points from the label 'Type 2 interface' to the connection. To the right of the arrow, the text 'PEECMON IRP' is shown, indicating the interface reference point. + +Diagram of NM-RMS to VS-RMS Type-2 interface + +**Figure 4.2.2: NM-RMS to VS-RMS Type-2 interface** + +![Diagram of NM-RMS to EM/DM Type-2 interface](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +The diagram shows an EM/DM block on the left and an NM-RMS block on the right, connected by a solid horizontal line. A vertical dashed line bisects the connection. Below the dashed line, an arrow points from the label 'Type 2 interface' to the connection. To the right of the arrow, the text 'PEECMON IRP or existing interface IRPs' is shown, indicating the interface reference point. + +Diagram of NM-RMS to EM/DM Type-2 interface + +**Figure 4.2.3: NM-RMS to EM/DM Type-2 interface** + +## 4.3 Functionality + +Both DM, XCU/DGU and VS-RMS offer a capability allowing the NM-RMS to control and monitor PEE parameters of one or more base stations. This TS series specifies the information model exposed by the DM, XCU/DGU and VS-RMS to the NM-RMS, and the operations enabling the control and monitoring of PEE parameters from the NM-RMS. + +This TS series describes two non-mutually exclusive solutions: + +- # Solution 1: based on existing 3GPP Interface IRPs to support controlling and monitoring of PEE parameters of base stations with built-in sensors. This solution may be used for the interface between DM and NM-RMS. +- # Solution 2: describing simplified functionalities according to ETSI ES 202 336-1 [4] and ES 202 336-12 [3]. This solution may be used for the interfaces between XCU/DGU and NM-RMS, between VS-RMS and NM-RMS and between DM and NM-RMS. + +Solution 1 is only applicable in case of scenario depicted in figure 4.2.3. + +Solution 2 is applicable in case of all scenarios depicted by figures 4.2.1, 4.2.2 and 4.2.3. + +# 5 Business level requirements + +## 5.1 Requirements + +NOTE 1: The next three business level requirements relate to the capability for the NM-RMS to initiate / stop the retrieval of power, energy and environmental parameters of selected base stations. + +**REQ-EECMON-CON-001:** The DM shall support a capability allowing the NM-RMS to initiate / stop the retrieval of power, energy and environmental parameters of selected base stations. + +**REQ-EECMON-CON-002:** The XCU/DGU shall support a capability allowing the NM-RMS to initiate / stop the retrieval of power, energy and environmental parameters of selected base stations. + +**REQ-EECMON-CON-003:** The VS-RMS shall support a capability allowing the NM-RMS to initiate / stop the retrieval of power, energy and environmental parameters of selected base stations. + +NOTE 2: The next three business level requirements relate to the capability for the NM-RMS to periodically receive power, energy and environmental parameters values for selected base stations. + +**REQ-EECMON-CON-004:** The DM shall support a capability allowing the NM-RMS to periodically receive measured power, energy and environmental parameters values, for selected base stations from DM. + +**REQ-EECMON-CON-005:** The XCU/DGU shall support a capability allowing the NM-RMS to periodically receive power, energy and environmental parameters values, for selected base stations from XCU/DGU. + +**REQ-EECMON-CON-006:** The VS-RMS shall support a capability allowing the NM-RMS to periodically receive power, energy and environmental parameters values, for selected base stations from VS-RMS. + +NOTE 3: The next three business level requirements relate to the capability for the NM-RMS to control some power, energy and environmental related parameters of selected base stations. + +**REQ-EECMON-CON-007:** The DM shall support a capability allowing the NM-RMS to control power, energy and environmental related parameters of selected base stations via DM. + +**REQ-EECMON-CON-008:** The XCU/DGU shall support a capability allowing the NM-RMS to control power, energy and environmental related parameters of selected base stations via XCU/DGU. + +**REQ-EECMON-CON-009:** The VS-RMS shall support a capability allowing the NM-RMS to control power, energy and environmental related parameters of selected base stations via VS-RMS. + +NOTE 4: The next three business level requirements relate to the capability for the NM-RMS to be notified in case of power, energy and environmental related alarms, for selected base stations, which can be detected by XCU/DGU or VS-RMS or DM. Examples of such alarms include: loss of connectivity between XCU/DGU or VS-RMS and external sensors, alarms internal to XCU/DGU or VS-RMS, power, energy and environmental parameters threshold crossing or reaching, etc. + +**REQ-EECMON-CON-010:** The DM shall support a capability allowing the NM-RMS to be notified in case of power, energy and environmental related alarms being detected by DM, for selected base stations. + +**REQ-EECMON-CON-011:** The XCU/DGU shall support a capability allowing the NM-RMS to be notified in case of power, energy and environmental related alarms being detected by XCU/DGU, for selected base stations. + +**REQ-EECMON-CON-012:** The VS-RMS shall support a capability allowing the NM-RMS to be notified in case of power, energy and environmental related alarms being detected by VS-RMS, for selected base stations. + +NOTE 5: The next three business level requirements relate to the capability for the NM-RMS to be notified in case of configuration changes, for selected base stations. + +**REQ-EECMON-CON-013:** The DM shall support a capability allowing the NM-RMS to be notified in case of PEE related configuration changes being detected by DM, for selected base stations. + +**REQ-EECMON-CON-014:** The XCU/DGU shall support a capability allowing the NM-RMS to be notified in case of PEE related configuration changes detected by XCU/DGU, for selected base stations. + +**REQ-EECMON-CON-015:** The VS-RMS shall support a capability allowing the NM-RMS to be notified in case of PEE related configuration changes detected by VS-RMS, for selected base stations. + +## 5.2 Actor roles + +The function at the NM-RMS controlling and monitoring PEE parameters of base stations in the radio access network. + +The function at the DM enabling to control and monitor PEE parameters of base stations with built-in sensors managed by the subject DM. + +The function at the XCU/DGU enabling to control and monitor PEE parameters of base stations with external sensors managed by the subject XCU/DGU. + +The function at the VS-RMS enabling to control and monitor PEE parameters of base stations with external sensors managed by the subject VS-RMS, via XCU/DGU. + +## 5.3 Telecommunication resources + +**NM-RMS:** The Network Management layer Remote Management Server controlling and monitoring PEE parameters of one or more base stations. + +**XCU/DGU:** The XCU/DGU, offering local capabilities to monitor and control PEE parameters of one or more base station(s). + +**VS-RMS:** The VS-RMS, offering capabilities to monitor and control PEE parameters of one or more base station(s). + +## 5.4 High-level use cases + +### 5.4.1 Use case: Managing the monitoring of PEE parameters + +| Use case stage | Evolution/Specification | <>
Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | The NM-RMS wants to monitor PEE parameters of base stations, some of which having built-in sensors, some others having external sensors. | | +| Actors and Roles | The function in the NM-RMS requesting PEE parameters via DM(s) and /or XCU/DGU(s) and/or VS-RMS(s). | | +| Telecom resources | NM-RMS, DM, XCU/DGU, VS-RMS. | | +| Assumptions | Connectivity exists between XCU/DGU, VS-RMS, DM and NM-RMS.
Connectivity exists between base stations and XCU/DGU, VS-RMS and DM. | | +| Pre-conditions | XCU/DGU, VS-RMS, DM and NM-RMS are up and running. | | +| Begins when | The NM-RMS requests the XCU/DGU or VS-RMS or DM to collect values of certain PEE parameters of one or more base station(s) by sending an appropriate request message to the XCU/DGU or VS-RMS or DM. | | +| Step 1 (M) | The XCU/DGU or VS-RMS or DM receives the request message. | | +| Step 2 (M) | The XCU/DGU or VS-RMS or DM processes the request message, identifies the requested PEE parameters and retrieves the requested PEE parameters values from selected base stations. | | +| Step 3 (M) | Periodically, the XCU/DGU or VS-RMS or DM sends to the NM-RMS the requested PEE parameters values in a response message. | | +| Ends when | The NM-RMSC requests XCU/DGU or VS-RMS or DM to stop collecting values of certain PEE parameters of one or more base station(s) by sending an appropriate message to the XCU/DGU or VS-RMS or DM. | | +| Exceptions | The NM-RMS does not receive the requested PEE parameters values. Numerous failure reasons may be indicated. | | +| Post-conditions | The requested PEE parameters values have been returned. | | +| Traceability | Requirement REQ-EECMON-CON-001, REQ-EECMON-CON-002, REQ-EECMON-CON-003, REQ-EECMON-CON-004, REQ-EECMON-CON-005, REQ-EECMON-CON-006 in clause 5.1. | | + +### 5.4.2 Use case: Controlling PEE related parameters + +| Use case stage | Evolution/Specification | <>
Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | The NM-RMS wants to control PEE related parameters of base stations, e.g. timers, thresholds, etc. | | +| Actors and Roles | The function in the NM-RMS controlling PEE related parameters via DM and/or XCU/DGU and/or VS-RMS. | | +| Telecom resources | NM-RMS, DM, XCU/DGU, VS-RMS. | | +| Assumptions | Connectivity exists between the DM, XCU/DGU, VS-RMS and the NM-RMS.
Connectivity exists between base stations and XCU/DGU, VS-RMS, DM. | | +| Pre-conditions | XCU/DGU, VS-RMS, DM and NM-RMS are up and running. | | +| Begins when | The NM-RMS requests the XCU/DGU or VS-RMS or DM to set values of certain PEE related parameters of one or more base station(s) by sending an appropriate request message to the XCU/DGU or VS-RMS or DM. | | +| Step 1 (M) | The XCU/DGU or VS-RMS or DM receives the request message. | | +| Step 2 (M) | The XCU/DGU or VS-RMS or DM processes the request message, identifies the requested PEE related parameters and sets the PEE related parameters values of selected base stations. | | +| Step 3 (M) | The XCU/DGU or VS-RMS or DM sends back to the NM-RMS the actual PEE related parameters values in a response message. | | +| Ends when | The NM-RMS has received the actual PEE related parameters values. | | +| Exceptions | The XCU/DGU or VS-RMS or DM cannot set the PEE related parameters to values provided by the NM-RMS.
Numerous failure reasons may be indicated. | | +| Post-conditions | The requested PEE related parameters values have been set on selected base stations. | | +| Traceability | Requirement REQ-EECMON-CON-007 , REQ-EECMON-CON-008 , REQ-EECMON-CON-009 in clause 5.1. | | + +### 5.4.3 Use case: Supervising PEE related alarms + +| Use case stage | Evolution/Specification | <>
Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | The NM-RMS wants to supervise PEE related alarms of base stations. | | +| Actors and Roles | The function in the NM-RMS supervising PEE related alarms via DM and/or XCU/DGU and/or VS-RMS. | | +| Telecom resources | NM-RMS, DM, XCU/DGU, VS-RMS. | | +| Assumptions | Connectivity exists between the DM, XCU/DGU, VS-RMS and the NM-RMS.
Connectivity exists between base stations and XCU/DGU, VS-RMS, DM. | | +| Pre-conditions | XCU/DGU, VS-RMS, DM and NM-RMS are up and running. | | +| Begins when | An alarm related to a PEE parameter occurs on a base station being supervised by the NM-RMS. | | +| Step 1 (M) | In case this alarm relates to a base station with external sensor, or relates to XCU/DGU or VS-RMS, or relates to the connectivity between the external sensor and XCU/DGU or VS-RMS, XCU/DGU or VS-RMS sends the corresponding alarm notification to NM-RMS.

In case this alarm relates to a base station with built-in sensor, DM sends the corresponding alarm notification to NM-RMS. | | +| Ends when | NM-RMS receives the alarm notification from XCU/DGU or VS-RMS or DM. | | +| Exceptions | Information conveyed in the alarm notification received by NM-RMS from XCU/DGU or VS-RMS or DM cannot be treated by NM-RMS. | | +| Post-conditions | NM-RMS has received the alarm notification from XCU/DGU or VS-RMS or DM. | | +| Traceability | Requirement REQ-EECMON-CON-010 , REQ-EECMON-CON-011 , REQ-EECMON-CON-012 , in clause 5.1. | | + +### 5.4.4 Use case: Monitoring PEE related configuration changes + +| Use case stage | Evolution/Specification | <>
Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | The NM-RMS wants to monitor PEE configuration changes such as e.g. new base station, new XCU/DGU. | | +| Actors and Roles | The function in the NM-RMS monitoring PEE related alarms via DM and/or XCU/DGU and/or VS-RMS. | | +| Telecom resources | NM-RMS, DM, XCU/DGU, VS-RMS. | | +| Assumptions | Connectivity exists between the DM, XCU/DGU, VS-RMS and the NM-RMS.
Connectivity exists between base stations and XCU/DGU, VS-RMS, DM. | | +| Pre-conditions | XCU/DGU, VS-RMS, DM and NM-RMS are up and running. | | +| Begins when | A PEE related configuration change occurs, related to a base station in scope of the NM-RMS. | | +| Step 1 (M) | In case this configuration change is detected on a base station with external sensor, or relates to XCU/DGU or VS-RMS, XCU/DGU or VS-RMS sends the corresponding configuration change notification to NM-RMS.

In case this PEE related configuration change relates to a base station with built-in sensor, DM sends the corresponding configuration change notification to NM-RMS. | | +| Ends when | NM-RMS receives the configuration change notification from XCU/DGU or VS-RMS or DM. | | +| Exceptions | Information conveyed in the configuration change notification received by NM-RMS from XCU/DGU or VS-RMS or DM cannot be treated by NM-RMS. | | +| Post-conditions | NM-RMS has received the configuration change notification from XCU/DGU or VS-RMS or DM. | | +| Traceability | Requirement REQ-EECMON-CON-013 , REQ-EECMON-CON-014 , REQ-EECMON-CON-015 in clause 5.1. | | + +# 6 Specification level requirements + +## 6.1 Requirements + +### 6.1.1 Requirements for solution 1 + +**REQ-PEECMON-OPT1-FUN-001:** for configuration management purposes, requirements from either 3GPP TS 32.601 [5] clause 4, or from 3GPP TS 32.611 [8] clause 4.3, shall apply. + +**REQ-PEECMON-OPT1-FUN-002:** for performance management purposes, requirements from 3GPP TS 32.411 [6] – clauses 4 and 5 - shall apply. + +**REQ-PEECMON-OPT1-FUN-003:** for fault management purposes, requirements from 3GPP TS 32.111-1 [7] – clauses 4 and 5 - shall apply. + +### 6.1.2 Requirements for solution 2 + +**REQ-PEECMON-OPT2-FUN-001:** The IRP Agent shall support a capability allowing the IRP Manager to initiate / stop the retrieval of power, energy and environmental parameters of selected base stations. + +**REQ-PEECMON-OPT2-FUN-002:** The IRP Agent shall support a capability allowing the IRP Manager to periodically receive measured power, energy and environmental parameters values, for selected base stations. + +**REQ-PEECMON-OPT2-FUN-003:** The IRP Agent shall support a capability allowing the IRP Manager to be notified in case of power, energy and environmental parameters related alarms, for selected base stations. + +**REQ-PEECMON-OPT2-FUN-004:** The IRP Agent shall support a capability allowing the IRP Manager to be notified in case of power, energy and environmental parameters related configuration changes being detected by the IRP Agent, for selected base stations. + +## 6.2 Actor roles + +### 6.2.1 Actor roles for solution 1 + +IRPManager at the NM-RMS, controlling and monitoring PEE parameters of base stations in the radio access network. + +IRPAgent at the DM, enabling to control and monitor PEE parameters of base stations with built-in sensors managed by the subject DM. + +### 6.2.2 Actor roles for solution 2 + +IRPManager at the NM-RMS, controlling and monitoring PEE parameters of base stations in the radio access network. + +IRPAgent at the DM, enabling to control and monitor PEE parameters of base stations with built-in sensors managed by the subject DM. + +IRPAgent at the XCU/DGU, enabling to control and monitor PEE parameters of base stations with external sensors managed by the subject XCU/DGU. + +IRPAgent at the VS- RMS, enabling to control and monitor PEE parameters of base stations with external sensors managed by the subject VS- RMS, via XCU/DGU. + +## 6.3 Telecommunication resources + +### 6.3.1 Telecommunication resources for solution 1 + +**NM-RMS:** The Network Management layer Remote Management Server controlling and monitoring PEE parameters of one or more base stations. + +### 6.3.2 Telecommunication resources for solution 2 + +All telecommunication resources, as defined in clause 5.3. + +## 6.4 Use cases + +### 6.4.1 Use cases for solution 1 + +#### 6.4.1.1 Use case: Initiating PEE performance management job + +IRPManager initiates a PM job by sending appropriate request to IRPAgent, in compliance with PM IRP – cf. 3GPP TS 32.411 [6]. This use case corresponds to the high-level use case "Managing the monitoring of PEE parameters" (cf. clause 5.4.1 of the present document). + +#### 6.4.1.2 Use case: Controlling PEE related threshold + +IRPManager sends appropriate request to IRPAgent, in compliance with PM IRP – cf. 3GPP TS 32.411 [6]. This use case corresponds to the high-level use case "Controlling PEE related parameters" (cf. clause 5.4.2 of the present document). + +#### 6.4.1.3 Use case: Supervising PEE related alarms + +In case of PEE related alarms, IRPAgent emits alarm notifications to inform IRPManager, in compliance with Alarm IRP – cf. 3GPP TS 32.111-1 [7]. This use case corresponds to the high-level use case "Supervising PEE related alarms" (cf. clause 5.4.3 of the present document). + +#### 6.4.1.4 Use case: Monitoring PEE related configuration changes + +In case of PEE related configuration changes, IRP Agent emits configuration change notifications to inform IRP Manager, in compliance with Notification IRP – cf. 3GPP TS 32.301 [2]. This use case corresponds to the high-level use case "Monitoring PEE related configuration changes" (cf. clause 5.4.4 of the present document). + +### 6.4.2 Use cases for solution 2 + +See use cases in clause 5.4. + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|-----------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-03 | SA#79 | SP-180071 | | | | Presented for approval | 2.0.0 | +| 2018-03 | SA#79 | | | | | Upgrade to change control version | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28305/2de714cedbbdd36f901f71bafa78f75a_img.jpg b/marked/Rel-16/28_series/28305/2de714cedbbdd36f901f71bafa78f75a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e1b95f79684b6b917d1b7fd9f45ca555824890e7 --- /dev/null +++ b/marked/Rel-16/28_series/28305/2de714cedbbdd36f901f71bafa78f75a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9b015601da6e1dfbb6944fb542447f061c5545c0594bad57c9800a552c4801f +size 87100 diff --git a/marked/Rel-16/28_series/28305/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg b/marked/Rel-16/28_series/28305/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a04e3a6b741fdd1dbae65b872649392023a656e1 --- /dev/null +++ b/marked/Rel-16/28_series/28305/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbe1eb64225567725746e9428b0d41cce909728bea8f9ffead019e1f0e5fe7db +size 60927 diff --git a/marked/Rel-16/28_series/28305/731f533b0599c8e42a063f06e4332045_img.jpg b/marked/Rel-16/28_series/28305/731f533b0599c8e42a063f06e4332045_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dfbfac1ca0fbe9dba5eccf719cb7cbf37d00ad90 --- /dev/null +++ b/marked/Rel-16/28_series/28305/731f533b0599c8e42a063f06e4332045_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f49ec5006aa399cfbbc3373ab0209ea1b360134a7aa5252b558a4f1d916abd65 +size 39490 diff --git a/marked/Rel-16/28_series/28305/raw.md b/marked/Rel-16/28_series/28305/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e1fb0d8bccb7f14ea6c3fddf906ea090e6294e33 --- /dev/null +++ b/marked/Rel-16/28_series/28305/raw.md @@ -0,0 +1,1034 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 System overview ..... | 8 | +| 4.1 System Context ..... | 8 | +| 5 Model ..... | 9 | +| 5.1 Model for solution 1 ..... | 9 | +| 5.1.0 Introduction ..... | 9 | +| 5.1.1 Imported and associated information entities..... | 9 | +| 5.1.1.1 Imported information entities and local labels ..... | 9 | +| 5.1.1.2 Associated information entities and local labels..... | 10 | +| 5.1.2 Class diagrams..... | 10 | +| 5.1.2.1 Relationships..... | 10 | +| 5.1.2.2 Inheritance ..... | 10 | +| 5.1.3 Class definitions ..... | 10 | +| 5.1.4 Attribute definitions..... | 10 | +| 5.1.5 Common notifications ..... | 10 | +| 5.2 Model for solution 2..... | 10 | +| 5.2.0 Introduction ..... | 10 | +| 5.2.1 Imported and associated information entities..... | 10 | +| 5.2.1.1 Imported information entities and local labels ..... | 10 | +| 5.2.1.2 Associated information entities and local labels..... | 10 | +| 5.2.2 Class diagrams..... | 11 | +| 5.2.2.1 Relationships..... | 11 | +| 5.2.2.2 Inheritance ..... | 11 | +| 5.2.3 Class definitions ..... | 11 | +| 5.2.3.1 PEEMonitoredEntity..... | 11 | +| 5.2.3.1.1 Definition ..... | 11 | +| 5.2.3.1.2 Attributes..... | 11 | +| 5.2.3.1.3 Attribute constraints ..... | 11 | +| 5.2.3.1.4 Notifications..... | 11 | +| 5.2.3.1.5 State diagram..... | 11 | +| 5.2.3.2 PEEMEDescription..... | 12 | +| 5.2.3.2.1 Definition ..... | 12 | +| 5.2.3.2.2 Attributes..... | 12 | +| 5.2.3.2.3 Attribute constraints ..... | 12 | +| 5.2.3.2.4 Notifications..... | 12 | +| 5.2.3.2.5 State diagram..... | 12 | +| 5.2.3.3 PEEMeasurementData ..... | 12 | +| 5.2.3.3.1 Definition ..... | 12 | +| 5.2.3.3.2 Attributes..... | 13 | +| 5.2.3.3.3 Attribute constraints ..... | 13 | +| 5.2.3.3.4 Notifications..... | 13 | +| 5.2.3.3.5 State diagram..... | 13 | +| 5.2.3.4 PEEAlarmInformation ..... | 13 | +| 5.2.3.4.1 Definition ..... | 13 | +| 5.2.3.4.2 Attributes..... | 13 | +| 5.2.3.4.3 Attribute constraints ..... | 13 | +| 5.2.3.4.4 Notifications..... | 13 | +| 5.2.3.4.5 State diagram..... | 14 | +| 5.2.3.5 PEEConfigInformation ..... | 14 | + +| | | | +|-----------|-------------------------------------------|----| +| 5.2.3.5.1 | Definition ..... | 14 | +| 5.2.3.5.2 | Attributes ..... | 14 | +| 5.2.3.5.3 | Attribute constraints ..... | 14 | +| 5.2.3.5.4 | Notifications ..... | 14 | +| 5.2.3.5.5 | State diagram ..... | 14 | +| 5.2.3.6 | PEECMONIRP ..... | 14 | +| 5.2.3.6.1 | Definition ..... | 14 | +| 5.2.3.6.2 | Attributes ..... | 14 | +| 5.2.3.6.3 | Attribute constraints ..... | 14 | +| 5.2.3.6.4 | Notifications ..... | 14 | +| 5.2.3.6.5 | State diagram ..... | 14 | +| 5.2.4 | Attribute definitions ..... | 15 | +| 5.2.4.1 | Attribute properties ..... | 15 | +| 5.2.4.2 | Constraints ..... | 17 | +| 5.2.5 | Common notifications ..... | 17 | +| 6 | Interface Definition ..... | 17 | +| 6.1 | Interface definition for solution 1 ..... | 17 | +| 6.1.1 | Class diagram ..... | 17 | +| 6.2 | Interface definition for solution 2 ..... | 17 | +| 6.2.1 | Class diagram ..... | 17 | +| 6.2.2 | Generic rules ..... | 18 | +| 6.2.3 | CMONOperations_1 Interface (M) ..... | 18 | +| 6.2.3.1 | Operation readMEDescription (M) ..... | 18 | +| 6.2.3.1.1 | Definition ..... | 18 | +| 6.2.3.1.2 | Input parameters ..... | 19 | +| 6.2.3.1.3 | Output parameters ..... | 19 | +| 6.2.3.1.4 | Pre-condition ..... | 19 | +| 6.2.3.1.5 | Post-condition ..... | 19 | +| 6.2.3.1.6 | Exception ..... | 19 | +| 6.2.3.2 | Operation writeMEDescription (M) ..... | 19 | +| 6.2.3.2.1 | Definition ..... | 19 | +| 6.2.3.2.2 | Input parameters ..... | 20 | +| 6.2.3.2.3 | Output parameters ..... | 20 | +| 6.2.3.2.4 | Pre-condition ..... | 20 | +| 6.2.3.2.5 | Post-condition ..... | 20 | +| 6.2.3.2.6 | Exception ..... | 20 | +| 6.2.4 | CMONOperations_2 Interface (M) ..... | 20 | +| 6.2.4.1 | Operation readMEConfiguration (M) ..... | 20 | +| 6.2.4.1.1 | Definition ..... | 20 | +| 6.2.4.1.2 | Input parameters ..... | 21 | +| 6.2.4.1.3 | Output parameters ..... | 21 | +| 6.2.4.1.4 | Pre-condition ..... | 21 | +| 6.2.4.1.5 | Post-condition ..... | 21 | +| 6.2.4.1.6 | Exception ..... | 21 | +| 6.2.4.2 | Operation writeMEConfiguration (M) ..... | 22 | +| 6.2.4.2.1 | Definition ..... | 22 | +| 6.2.4.2.2 | Input parameters ..... | 22 | +| 6.2.4.2.3 | Output parameters ..... | 22 | +| 6.2.4.2.4 | Pre-condition ..... | 22 | +| 6.2.4.2.5 | Post-condition ..... | 22 | +| 6.2.4.2.6 | Exception ..... | 23 | +| 6.2.5 | CMONOperations_3 Interface (M) ..... | 23 | +| 6.2.5.1 | Operation createCMONPMJob (M) ..... | 23 | +| 6.2.5.1.1 | Definition ..... | 23 | +| 6.2.5.1.2 | Input parameters ..... | 23 | +| 6.2.5.1.3 | Output parameters ..... | 24 | +| 6.2.5.1.4 | Pre-condition ..... | 24 | +| 6.2.5.1.5 | Post-condition ..... | 24 | +| 6.2.5.1.6 | Exception ..... | 24 | +| 6.2.5.1.7 | Constraints ..... | 24 | + +- 6.2.5.2 Operation stopCMONPMJob (M)..... 24 + - 6.2.5.2.1 Definition ..... 24 + - 6.2.5.2.2 Input parameters..... 24 + - 6.2.5.2.3 Output parameters ..... 24 + - 6.2.5.2.4 Pre-condition ..... 25 + - 6.2.5.2.5 Post-condition..... 25 + - 6.2.5.2.6 Exception..... 25 + - 6.2.5.2.7 Constraints..... 25 +- 6.2.6 CMONNotifications\_1 Interface (M)..... 25 + - 6.2.6.1 Notification notifyMeasurementData (M) ..... 25 + - 6.2.6.1.1 Definition ..... 25 + - 6.2.6.1.2 Input parameters..... 26 +- 6.2.7 CMONNotifications\_2 Interface (M)..... 27 + - 6.2.7.1 Notification notifyAlarm (M) ..... 27 + - 6.2.7.1.1 Definition ..... 27 + - 6.2.7.1.2 Input parameters..... 27 +- 6.2.8 CMONNotifications\_3 Interface (M)..... 27 + - 6.2.8.1 Notification notifyConfigurationChange (M)..... 27 + - 6.2.8.1.1 Definition ..... 27 + - 6.2.8.1.2 Input parameters..... 28 +- 6.2.9 CMONNotifications\_4 Interface (M)..... 28 + - 6.2.9.1 Notification notifyThresholdCrossingOrReaching (M)..... 28 + - 6.2.9.1.1 Definition ..... 28 + - 6.2.9.1.2 Input parameters..... 28 +- Annex A (informative): Change history..... 29 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.304 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Requirements +- 28.305 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP): Information Service (IS)** +- 28.306 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document specifies the control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP) Information Service (IS). + +It specifies the semantics and behaviour of operations, notifications and their parameters visible across Itf-N in a protocol and technology neutral way. It does not define their syntax and encoding. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] ETSI ES 202 336-12 (V1.1.1) (2015-06): " Environmental Engineering (EE); Monitoring and control interface for infrastructure equipment (power, cooling and building environment systems used in telecommunication networks); Part 12: ICT equipment power, energy and environmental parameters monitoring information model". +- [3] 3GPP TS 32.150: "Integration Reference Point (IRP) Concept and definitions". +- [4] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [7] 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Information Service (IS)". +- [8] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [9] 3GPP TS 28.304: "Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Requirements". +- [10] ITU-T Recommendation X.733: "Information Technology – Open Systems Interconnection – Systems Management: Alarm Reporting Function". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|---------|---------------------------------| +| CU | Control Unit | +| DGU | Digital Gathering Unit | +| NM-RMS | Network Management layer RMS | +| PEE | Power, Energy and Environmental | +| PEECMON | PEE Control and Monitoring | +| RMS | Remote Management Server | +| VSE | Vendor-Specific Extension | +| VS-RMS | Vendor Specific RMS | +| XCU | XML enabled CU | + +# 4 System overview + +## 4.1 System Context + +The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [3], sub-clause 4.7. + +![Figure 4.1.1: System Context. Three diagrams showing the system context for different RMS types (XCU/DGU, VS-RMS, EM/DM) connected to an NM-RMS via a Type 2 interface, with PEECMON IRP or existing IRPs.](731f533b0599c8e42a063f06e4332045_img.jpg) + +The figure consists of three vertically stacked diagrams, each representing a different system context. Each diagram shows a box on the left (XCU/DGU, VS-RMS, or EM/DM) connected by a solid horizontal line to a box on the right labeled NM-RMS. A vertical dashed line separates the two boxes, and this interface is labeled "Type 2 interface". Below the interface, a curved arrow points to the right, with a label "PEECMON IRP" or "PEECMON IRP or existing IRPs" next to it. + +- The top diagram shows XCU/DGU connected to NM-RMS. The interface is labeled "Type 2 interface". A curved arrow points to the right, with a label "PEECMON IRP" next to it. +- The middle diagram shows VS-RMS connected to NM-RMS. The interface is labeled "Type 2 interface". A curved arrow points to the right, with a label "PEECMON IRP" next to it. +- The bottom diagram shows EM/DM connected to NM-RMS. The interface is labeled "Type 2 interface". A curved arrow points to the right, with a label "PEECMON IRP or existing IRPs" next to it. + +Figure 4.1.1: System Context. Three diagrams showing the system context for different RMS types (XCU/DGU, VS-RMS, EM/DM) connected to an NM-RMS via a Type 2 interface, with PEECMON IRP or existing IRPs. + +Figure 4.1.1: System Context + +# 5 Model + +## 5.1 Model for solution 1 + +## 5.1.0 Introduction + +NOTE: Void. + +Due to the fact that existing CM, PM, and FM interface IRPs are applicable to solution 1, the model definition of this solution can refer to model definitions from Basic CM IRP (TS 32.602 [5]), Bulk CM IRP (TS 32.612 [6]), PM IRP (TS 32.412 [7]) and Alarm IRP (TS 32.111-2 [8]). + +Use cases and requirement for Solution 1 are described in 28.304 [9]. + +### 5.1.1 Imported and associated information entities + +#### 5.1.1.1 Imported information entities and local labels + +None. + +#### 5.1.1.2 Associated information entities and local labels + +None. + +### 5.1.2 Class diagrams + +#### 5.1.2.1 Relationships + +Due to the fact that existing CM, PM, and FM interface IRPs are applicable to solution 1, the model definition of this solution can refer to model definitions from Basic CM IRP (TS 32.602 [5]), Bulk CM IRP (TS 32.612 [6]), PM IRP (TS 32.412 [7]) and Alarm IRP (TS 32.111-2 [8]). + +#### 5.1.2.2 Inheritance + +Due to the fact that existing CM, PM, and FM interface IRPs are applicable to solution 1, the model definition of this solution can refer to model definitions from Basic CM IRP (TS 32.602 [5]), Bulk CM IRP (TS 32.612 [6]), PM IRP (TS 32.412 [7]) and Alarm IRP (TS 32.111-2 [8]). + +### 5.1.3 Class definitions + +Due to the fact that existing CM, PM, and FM interface IRPs are applicable to solution 1, the model definition of this solution can refer to model definitions from Basic CM IRP (TS 32.602 [5]), Bulk CM IRP (TS 32.612 [6]), PM IRP (TS 32.412 [7]) and Alarm IRP (TS 32.111-2 [8]). + +### 5.1.4 Attribute definitions + +NOTE: Void. + +Attributes related to the control and monitoring of power, energy and environmental parameters in radio access networks are defined in IOC `ManagedFunction` – cf. 3GPP TS 28.622 [4]. + +### 5.1.5 Common notifications + +No additional notifications compared to those applicable to IOC `ManagedFunction` – cf. 3GPP TS 28.622 [4]. + +## 5.2 Model for solution 2 + +### 5.2.0 Introduction + +This clause introduces the set of classes (i.e. IOCs, SupportIOCs) that encapsulate information used by the CMON IRP for the control and monitoring of PEE parameters in radio access networks. The intent is to identify the information required for the CMONIRP implementation of its operations and notification emission. This clause provides the overview of all support object classes in UML. Subsequent clauses provide more detailed specification of various aspects of these support object classes. + +### 5.2.1 Imported and associated information entities + +#### 5.2.1.1 Imported information entities and local labels + +There is no imported information entity. + +#### 5.2.1.2 Associated information entities and local labels + +There is no associated information entity. + +### 5.2.2 Class diagrams + +#### 5.2.2.1 Relationships + +![UML Class diagram showing relationships between PEECMONIRP and various interfaces.](4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg) + +``` + +classDiagram + class CMONOperations_1 { + -readMEDescription() + -writeMEDescription() + } + class CMONOperations_2 { + -readMEConfiguration() + -writeMEConfiguration() + } + class CMONOperations_3 { + -createCMONPMJob() + -stopCMONPMJob() + } + class PEECMONIRP { + } + class CMONNotifications_1 { + -notifyMeasurementData() + } + class CMONNotifications_2 { + -notifyAlarm() + } + class CMONNotifications_3 { + -notifyConfigurationChange() + } + class CMONNotifications_4 { + -notifyThresholdCrossingOrReaching() + } + + PEECMONIRP --> CMONOperations_1 + PEECMONIRP --> CMONOperations_2 + PEECMONIRP --> CMONOperations_3 + PEECMONIRP --> CMONNotifications_1 : <> + PEECMONIRP --> CMONNotifications_2 : <> + PEECMONIRP --> CMONNotifications_3 : <> + PEECMONIRP --> CMONNotifications_4 : <> + +``` + +UML Class diagram showing relationships between PEECMONIRP and various interfaces. + +Figure 5.2.2.1.1: Information model for solution 2 - Relationships + +#### 5.2.2.2 Inheritance + +There is no inheritance defined. + +### 5.2.3 Class definitions + +#### 5.2.3.1 PEEMonitoredEntity + +##### 5.2.3.1.1 Definition + +This IOC represents the monitoring of a base station whose Power, Energy and Environmental (PEE) parameters are monitored. It can apply to a GERAN, UTRAN or E-UTRAN base station. It can apply to a base station with either a built-in sensor or an external sensor. + +##### 5.2.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| mEId | M | M | - | M | - | + +##### 5.2.3.1.3 Attribute constraints + +None. + +##### 5.2.3.1.4 Notifications + +None. + +##### 5.2.3.1.5 State diagram + +None. + +#### 5.2.3.2 PEEMEDescription + +##### 5.2.3.2.1 Definition + +This IOC provides a description of the monitored entity. + +##### 5.2.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------|-------------------|------------|------------|-------------|--------------| +| siteIdentification | M | M | M | - | M | +| siteLatitude | CM | M | M | - | M | +| siteLongitude | CM | M | M | - | M | +| siteDescription | M | M | M | - | M | +| equipmentType | M | M | M | - | M | +| environmentType | M | M | M | - | M | +| powerInterface | M | M | M | - | M | +| xcuDguDescription | CM | M | M | - | M | +| sensorDescription | CM | M | M | - | M | +| vSRmsDescription | CM | M | M | - | M | + +##### 5.2.3.2.3 Attribute constraints + +| Name | Definition | +|-------------------|-------------------------------------------------------------------------------------------------| +| xcuDguDescription | It shall be supported only in case of base stations with external sensors. | +| sensorDescription | It shall be supported only in case of base stations with external sensors. | +| vSRmsDescription | It shall be supported only in case of base stations with external sensors monitored via VS-RMS. | +| siteLatitude | It shall be supported only in case of UTRAN or E-UTRAN base stations. | +| siteLongitude | It shall be supported only in case of UTRAN or E-UTRAN base stations. | + +##### 5.2.3.2.4 Notifications + +None. + +##### 5.2.3.2.5 State diagram + +None. + +#### 5.2.3.3 PEEMeasurementData + +##### 5.2.3.3.1 Definition + +This IOC represents the PEE measurements of the monitored entity. + +##### 5.2.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|------------|-------------|--------------| +| powerAverage | M | M | - | M | - | +| powerMin | M | M | - | M | - | +| powerMax | M | M | - | M | - | +| energyConsumption | M | M | - | M | - | +| temperatureAverage | M | M | - | M | - | +| temperatureMin | M | M | - | M | - | +| temperatureMax | M | M | - | M | - | +| voltageAverage | M | M | - | M | - | +| voltageMin | M | M | - | M | - | +| voltageMax | M | M | - | M | - | +| currentAverage | M | M | - | M | - | +| currentMin | M | M | - | M | - | +| currentMax | M | M | - | M | - | +| humidityAverage | M | M | - | M | - | +| humidityMin | M | M | - | M | - | +| humidityMax | M | M | - | M | - | +| collectionBeginTime | M | M | - | M | - | +| collectionEndTime | M | M | - | M | - | + +##### 5.2.3.3.3 Attribute constraints + +None. + +##### 5.2.3.3.4 Notifications + +None. + +##### 5.2.3.3.5 State diagram + +None. + +#### 5.2.3.4 PEEAlarmInformation + +##### 5.2.3.4.1 Definition + +This IOC represents the alarm information of the monitored entity. + +##### 5.2.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------|-------------------|------------|------------|-------------|--------------| +| alarmId | M | M | - | M | - | +| alarmTime | M | M | - | M | - | +| alarmType | M | M | - | M | - | +| perceivedSeverity | M | M | - | M | - | +| probableCause | M | M | - | M | - | +| additionalText | O | M | - | M | - | + +##### 5.2.3.4.3 Attribute constraints + +None. + +##### 5.2.3.4.4 Notifications + +None. + +##### 5.2.3.4.5 State diagram + +None. + +#### 5.2.3.5 PEEConfigInformation + +##### 5.2.3.5.1 Definition + +This IOC represents the PEE related configuration information of the monitored entity. + +##### 5.2.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|-------------------------|-------------------|------------|------------|-------------|--------------| +| powerMinThreshold | M | M | - | M | - | +| powerMaxThreshold | M | M | - | M | - | +| temperatureMinThreshold | M | M | - | M | - | +| temperatureMaxThreshold | M | M | - | M | - | +| voltageMinThreshold | M | M | - | M | - | +| voltageMaxThreshold | M | M | - | M | - | +| currentMinThreshold | M | M | - | M | - | +| currentMaxThreshold | M | M | - | M | - | +| humidityMinThreshold | M | M | - | M | - | +| humidityMaxThreshold | M | M | - | M | - | + +##### 5.2.3.5.3 Attribute constraints + +None. + +##### 5.2.3.5.4 Notifications + +None. + +##### 5.2.3.5.5 State diagram + +None. + +#### 5.2.3.6 PEECMONIRP + +##### 5.2.3.6.1 Definition + +PEECMONIRP is the representation of the Power, Energy and Environmental (PEE) parameters management capabilities specified by the present document. + +##### 5.2.3.6.2 Attributes + +None. + +##### 5.2.3.6.3 Attribute constraints + +None. + +##### 5.2.3.6.4 Notifications + +None. + +##### 5.2.3.6.5 State diagram + +None. + +### 5.2.4 Attribute definitions + +#### 5.2.4.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------|---------------------------------------------------------------------------------|-------------------------------------------------| +| currentMinThreshold | It indicates the minimum current threshold value to be used for raising alarms. | type: Real
multiplicity: 1
isOrdered: N/A | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| | allowedValues: see ETSI ES 202 336-12 [2] – Clauses 4.4.3.3, 4.4.3.4, Annex B | isUnique: N/A
defaultValue: Null
isNullable: True | +| currentMaxThreshold | It indicates the maximum current threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – Clauses 4.4.3.3, 4.4.3.4, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| environmentType | It indicates the type of environment of the monitored entity.

allowedValues: see ETSI ES 202 336-12 [2] – Clause 4.4.1. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| equipmentType | It indicates the type of equipment of the monitored entity.

allowedValues: see ETSI ES 202 336-12 [2] – Clause 4.4.1. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| humidityMinThreshold | It indicates the minimum humidity threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – clause 4.4.3.3, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| humidityMaxThreshold | It indicates the maximum humidity threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – clause 4.4.3.3, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| mEId | It identifies the monitored entity.

allowedValues: N/A | type: Integer
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| powerInterface | It indicates the type of power interface of the monitored entity.

allowedValues: see ETSI ES 202 336-12 [2] – Clause 4.4.1. | type: <>
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| powerMinThreshold | It indicates the minimum power threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – clauses 4.4.3.1, 4.4.3.4, Annex A | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| powerMaxThreshold | It indicates the maximum power threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – clauses 4.4.3.1, 4.4.3.4, Annex A | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| sensorDescription | It gives a description of the sensor.

allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| siteDescription | It gives a description of the site of the monitored entity.

allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| | | defaultValue: False
isNullable: False | +| siteIdentification | It gives an identification of the site of the monitored entity.

allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| siteLatitude | The latitude of the site location based on the World Geodetic System (1984 version) global reference frame (WGS 84).

Positive values correspond to north of 0 degrees latitude (northern hemisphere).

allowedValues: -90.0000 to +90.0000 | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| siteLongitude | The longitude of the site location based on the World Geodetic System (1984 version) global reference frame (WGS 84).

Positive values correspond to east of 0 degrees longitude.

allowedValues: -180.0000 to +180.0000 | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| temperatureMinThreshold | It indicates the minimum temperature threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – clause 4.4.3.4, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| temperatureMaxThreshold | It indicates the maximum temperature threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – clause 4.4.3.4, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| voltageMinThreshold | It indicates the minimum voltage threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – Clauses 4.4.3.3, 4.4.3.4, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| voltageMaxThreshold | It indicates the maximum voltage threshold value to be used for raising alarms.

allowedValues: see ETSI ES 202 336-12 [2] – Clauses 4.4.3.3, 4.4.3.4, Annex B | type: Real
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: Null
isNullable: True | +| vsRmsDescription | It gives a description of the VS-RMS.

allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | +| xcuDguDescription | It gives a description of the XCU/DGU.

allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: False
isNullable: False | + +#### 5.2.4.2 Constraints + +| Name | Affected attribute(s) | Definition | +|----------------------|-----------------------|-------------------------------------------------------------| +| inv_TimerConstraints | ntfTimeTickTimer | The ntfTimeTickTimer is lower than or equal to ntfTimeTick. | + +### 5.2.5 Common notifications + +None. + +# 6 Interface Definition + +## 6.1 Interface definition for solution 1 + +### 6.1.1 Class diagram + +None. + +## 6.2 Interface definition for solution 2 + +### 6.2.1 Class diagram + +![Class diagram representing interfaces for solution 2. A central class <> PEECMONIRP is shown with associations to several interfaces. It has solid line associations to CMONOperations_1, CMONOperations_2, and CMONOperations_3. It has dashed line associations labeled <> to CMONNotifications_1, CMONNotifications_2, CMONNotifications_3, and CMONNotifications_4. Each interface box lists its operations.](2de714cedbbdd36f901f71bafa78f75a_img.jpg) + +``` + +classDiagram + class CMONOperations_1 { + -readMEDescription() + -writeMEDescription() + } + class CMONOperations_2 { + -readMEConfiguration() + -writeMEConfiguration() + } + class CMONOperations_3 { + -createCMONPMJob() + -stopCMONPMJob() + } + class PEECMONIRP { + <> + } + class CMONNotifications_1 { + -notifyMeasurementData() + } + class CMONNotifications_2 { + -notifyAlarm() + } + class CMONNotifications_3 { + -notifyConfigurationChange() + } + class CMONNotifications_4 { + -notifyThresholdCrossingOrReaching() + } + + PEECMONIRP --> CMONOperations_1 + PEECMONIRP --> CMONOperations_2 + PEECMONIRP --> CMONOperations_3 + PEECMONIRP ..> CMONNotifications_1 : <> + PEECMONIRP ..> CMONNotifications_2 : <> + PEECMONIRP ..> CMONNotifications_3 : <> + PEECMONIRP ..> CMONNotifications_4 : <> + +``` + +Class diagram representing interfaces for solution 2. A central class <> PEECMONIRP is shown with associations to several interfaces. It has solid line associations to CMONOperations\_1, CMONOperations\_2, and CMONOperations\_3. It has dashed line associations labeled <> to CMONNotifications\_1, CMONNotifications\_2, CMONNotifications\_3, and CMONNotifications\_4. Each interface box lists its operations. + +Figure 6.2.1.1: Class diagram representing interfaces for solution 2 + +### 6.2.2 Generic rules + +Rule 1: each operation with at least one input parameter supports a pre-condition valid\_input\_parameter which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports + +an exception operation\_failed\_invalid\_input\_parameter which is raised when pre-condition valid\_input\_parameter is false. The exception has the same entry and exit state. + +Rule 2: Each operation with at least one optional input parameter supports a set of pre-conditions supported\_optional\_input\_parameter\_yyy where "yyy" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception operation\_failed\_unsupported\_optional\_input\_parameter\_yyy which is raised when (a) the pre-condition supported\_optional\_input\_parameter\_yyy is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state. + +Rule 3: each operation shall support a generic exception operation\_failed\_internal\_problem which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state. + +### 6.2.3 CMONOperations\_1 Interface (M) + +#### 6.2.3.1 Operation readMEDescription (M) + +##### 6.2.3.1.1 Definition + +The IRPManager invokes this operation to read description data of the monitored entity. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-001
REQ-EECMON-CON-002
REQ-EECMON-CON-003 | | + +##### 6.2.3.1.2 Input parameters + +| Name | Qualifier | Matching Type | Comment | +|-------------------|-----------|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mEld | M | mEld of the PEEMonitoredEntity instance. | This parameter contains the identification of the monitored entity. | +| attributeNameList | O | List of attribute names (in PEEMEDescription). | This parameter contains the list of names of attributes of the monitored entity, from PEEMEDescription. If the list is not provided, name+value pairs for all attributes of the monitored entity shall be returned. | + +##### 6.2.3.1.3 Output parameters + +| Name | Qualifier | Matching Information | Comment | +|------------------|-----------|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| mEld | M | mEld of the PEEMonitoredEntity instance. | This parameter contains the identification of the monitored entity. | +| attNameValueList | M | List of attribute name (in PEEMEDescription) and value pairs | This parameter contains a list of attribute name+value of the monitored entity. | +| status | M | ENUM (OperationSucceeded, OperationFailed) | If allInformationReturned is true, status = OperationSucceeded.
If operation_failed is true, status = OperationFailed. | + +##### 6.2.3.1.4 Pre-condition + +None. + +##### 6.2.3.1.5 Post-condition + +allInformationReturned. + +| Assertion Name | Definition | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allInformationReturned | For all attributes of the input parameter attributeNameList, their names and values are returned. All their values remain unchanged as the result of this operation. | + +##### 6.2.3.1.6 Exception + +| Assertion Name | Definition | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: One of the input parameters is invalid or the post-condition is not true.
Returned Information: The output parameter status.
Exit state: Entry state. | + +#### 6.2.3.2 Operation writeMDescription (M) + +##### 6.2.3.2.1 Definition + +The IRPManager invokes this operation to modify description data of the monitored entity. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-007
REQ-EECMON-CON-008
REQ-EECMON-CON-009 | | + +##### 6.2.3.2.2 Input parameters + +| Name | Qualifier | Matching Type | Comment | +|------------------|-----------|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| mEId | M | mEId of the PEEMonitoredEntity instance. | This parameter contains the identification of the monitored entity. | +| attNameValueList | M | List of attribute name (in PEEMEDescription) and value pairs | This parameter contains the list of attribute name+value of the monitored entity, for attributes in PEEMEDescription. | + +##### 6.2.3.2.3 Output parameters + +| Name | Qualifier | Matching Information | Comment | +|------------------|-----------|--------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| mEId | M | mEId of the PEEMonitoredEntity instance. | This parameter contains the identification of the monitored entity. | +| attNameValueList | M | List of attribute name (in PEEMEDescription) and value pairs | This parameter contains a list of attribute name+value of the modified attributes of the monitored entity after the operation has been achieved. | +| status | M | ENUM (OperationSucceeded, OperationFailed) | If allInformationReturned is true, status = OperationSucceeded.
If operation_failed is true, status = OperationFailed. | + +##### 6.2.3.2.4 Pre-condition + +None. + +##### 6.2.3.2.5 Post-condition + +allAttributesCorrectlyModified. + +| Assertion Name | Definition | +|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allAttributesCorrectlyModified | All attributes of the input parameter attributeNameList have been correctly modified as requested by this operation. All their modified values are returned. | + +##### 6.2.3.2.6 Exception + +| Assertion Name | Definition | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: One of the input parameters is invalid or the post-condition is not true.
Returned Information: The output parameter status.
Exit state: Entry state. | + +### 6.2.4 CMONOperations\_2 Interface (M) + +#### 6.2.4.1 Operation readMEConfiguration (M) + +##### 6.2.4.1.1 Definition + +The IRPManager invokes this operation to read threshold values on PEE parameters for one monitored entity. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-007
REQ-EECMON-CON-008
REQ-EECMON-CON-009 | | + +##### 6.2.4.1.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|-------------------|-------------------|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mEId | M | PEEMonitoredEntity.mEId | This parameter contains the mEId of the PEEMonitoredEntity instance. | +| thresholdNameList | O | List of threshold names (in PEEMEConfiguration) | This parameter contains the list of threshold names for the monitored entity instances, where threshold name corresponds to an attribute name in PEEConfigInformation. If the list is not provided, name+value pairs for all thresholds of the monitored entity shall be returned. | + +##### 6.2.4.1.3 Output parameters + +| Parameter Name | Support Qualifier | Matching Information / Information Type / Legal Values | Comment | +|------------------------|-------------------|--------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mEId | M | PEEMonitoredEntity.mEId | This parameter contains the mEId of the PEEMonitoredEntity instance whose threshold(s) have been read. | +| thresholdNameValueList | M | List of threshold name and value pairs | This parameter contains the list of threshold name+value pairs set for the monitored entity instance, where threshold name corresponds to an attribute name in PEEConfigInformation. | +| status | M | ENUM (OperationSucceeded, OperationFailed) | If allInformationReturned is true, status = OperationSucceeded.
If operation_failed is true, status = OperationFailed. | + +##### 6.2.4.1.4 Pre-condition + +None. + +##### 6.2.4.1.5 Post-condition + +allInformationReturned. + +| Assertion Name | Definition | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allInformationReturned | For all thresholds of the input parameter thresholdNameList, their names and values are returned. All their values remain unchanged as the result of this operation. | + +##### 6.2.4.1.6 Exception + +| Assertion Name | Definition | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: One of the input parameters is invalid or the post-condition is not true.
Returned Information: The output parameter status.
Exit state: Entry state. | + +#### 6.2.4.2 Operation writeMEConfiguration (M) + +##### 6.2.4.2.1 Definition + +The IRPManager invokes this operation to write threshold values on PEE parameters of one monitored entity. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-007
REQ-EECMON-CON-008
REQ-EECMON-CON-009 | | + +##### 6.2.4.2.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|------------------------|-------------------|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mEId | M | List of | This parameter contains the Id of PEEMonitoredEntity instance whose threshold(s) are to be written. | +| thresholdNameValueList | M | List of threshold name and value pairs | This parameter contains the list of threshold name+value pairs for the monitored entity instance, where threshold name corresponds to an attribute name in PEEConfigInformation.

Each threshold name+value pair defines the value of the monitored threshold. If the value is (a) crossed or (b) reached, a thresholdCrossing notification shall be emitted by the PEECMONIRP Agent. | + +##### 6.2.4.2.3 Output parameters + +| Parameter Name | Support Qualifier | Matching Information / Information Type / Legal Values | Comment | +|------------------------|-------------------|--------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mEId | M | PEEMonitoredEntity.mEId | This parameter contains the Id of the PEEMonitoredEntity instance whose threshold(s) have been written. | +| thresholdNameValueList | M | List of threshold name and value pairs | This parameter contains the list of threshold name+value pairs set for the monitored entity instance, where threshold name corresponds to an attribute name in PEEConfigInformation. | +| status | M | ENUM (OperationSucceeded, OperationFailed) | If allInformationReturned is true, status = OperationSucceeded.
If operation_failed is true, status = OperationFailed. | + +##### 6.2.4.2.4 Pre-condition + +None. + +##### 6.2.4.2.5 Post-condition + +allThresholdsCorrectlyModified. + +| Assertion Name | Definition | +|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| allThresholdsCorrectlyModified | All thresholds of the input parameter thresholdNameValueList have been correctly modified as requested by this operation. All their values are returned. | + +##### 6.2.4.2.6 Exception + +| Assertion Name | Definition | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: One of the input parameters is invalid or the post-condition is not true.
Returned Information: The output parameter status.
Exit state: Entry state. | + +### 6.2.5 CMONOperations\_3 Interface (M) + +#### 6.2.5.1 Operation createCMONPMJob (M) + +##### 6.2.5.1.1 Definition + +The IRPManager invokes this operation to create a PEE measurement job on one or more monitored entity(ies). The PEE measurement job starts immediately and run indefinitely until a stopCMONPMJob request is received by IRPAgent. + +The way the address of the entity to which notifications containing measurement data are sent is provisioned, is not in the scope of this document. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-001
REQ-EECMON-CON-002
REQ-EECMON-CON-003 | | + +##### 6.2.5.1.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|---------------------|-------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mEIdList | M | List of | This parameter contains the list of mEIds of PEEMonitoredEntity instances whose measurement(s) are to be collected. | +| measurementNameList | M | List of measurement names | This parameter contains the list of names of measurements to be collected. Each measurement name shall correspond to an attribute name of PEEMeasurementData. | +| granularityPeriod | M | A number of minutes. See Comment for legal values | It specifies the period between two successive measurements. The value can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours and 24 hours.
The minimum granularity period is 5 minutes in most cases, but for some measurements it may only make sense to collect data in a larger granularity period.
It also specifies the period between two successive emissions of notifyMeasurementData notifications. | + +##### 6.2.5.1.3 Output parameters + +| Parameter Name | Support Qualifier | Matching Information / Information Type / Legal Values | Comment | +|----------------|-------------------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| jobId | M | Measurement job id | Unique identifier of the measurement job among all the existing measurement jobs in a PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). The uniqueness is guaranteed by the Operator. | +| status | M | ENUM (Success, Failure, PartialSuccess) | An operation may fail because of a specified (e.g. invalid granularity period, invalid measurement name) or unspecified reason. | + +##### 6.2.5.1.4 Pre-condition + +None. + +##### 6.2.5.1.5 Post-condition + +None. + +##### 6.2.5.1.6 Exception + +| Assertion Name | Definition | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: One of the input parameters is invalid.
Returned Information: The output parameter status.
Exit state: Entry state. | + +##### 6.2.5.1.7 Constraints + +None. + +#### 6.2.5.2 Operation stopCMONPMJob (M) + +##### 6.2.5.2.1 Definition + +The IRPManager invokes this operation to stop an ongoing PEE measurement job on one or more monitored entity(ies). The PEE measurement job stops immediately. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-001
REQ-EECMON-CON-002
REQ-EECMON-CON-003 | | + +##### 6.2.5.2.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|----------------|-------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| jobId | M | Measurement job id | Identifier of the measurement job among all the existing measurement jobs in a PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). | + +##### 6.2.5.2.3 Output parameters + +| Parameter Name | Support Qualifier | Matching Information / Information Type / Legal Values | Comment | +|----------------|-------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| status | M | ENUM (Success, Failure, PartialSuccess) | An operation may fail because of a specified (e.g. unknown job, job cannot be stopped) or unspecified reason. | + +##### 6.2.5.2.4 Pre-condition + +None. + +##### 6.2.5.2.5 Post-condition + +cMONPMJobStopped. + +| Assertion Name | Definition | +|------------------|------------------------------| +| cMONPMJobStopped | The PM job has been stopped. | + +##### 6.2.5.2.6 Exception + +| Assertion Name | Definition | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | Condition: One of the input parameters is invalid or the post-condition is not true.
Returned Information: The output parameter status.
Exit state: Entry state. | + +##### 6.2.5.2.7 Constraints + +None. + +### 6.2.6 CMONNotifications\_1 Interface (M) + +#### 6.2.6.1 Notification notifyMeasurementData (M) + +##### 6.2.6.1.1 Definition + +The PEECMONIRP Agent notifies the PEECMONIRP Manager with measurement data. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-004
REQ-EECMON-CON-005
REQ-EECMON-CON-006 | | + +##### 6.2.6.1.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|--------------------|-------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationId | M | | Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). | +| notificationHeader | M | | This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. | +| notificationType | M | "Measurement data" | | +| jobId | M | Measurement job id | Unique identifier of the measurement job. | +| measHeader | | |

This is the measurement result notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp ("collectionBeginTime").

The "collectionBeginTime" is a time stamp that refers to the start of the first measurement collection interval (granularity period) that is covered by the collected measurement results that are sent in this notification.

| +| measData | M | Measurement data |

It represents the sequence of zero or more measurement result items. It can be empty in case no measurement data can be provided. The individual "measData" elements can appear in any order.

Each "measData" element contains the mEId of the PEEMonitoredEntity instance, and the list of measurement results pertaining to that PEEMonitoredEntity instance ("measInfo").

Each "measInfo" is a pair of measurement name ("measName") and the corresponding result(s) ("measValues").

"measName" shall correspond to an attribute name in PEEMeasurementData.

"measValues" contains the list of measurement results for the resource being measured.

| +| measFooter | M | | The measurement result notification footer to be inserted in each notification. It includes a time stamp, which refers to the end of the overall measurement collection interval that is covered by the collected measurement results being sent in this notification. | + +### 6.2.7 CMONNotifications\_2 Interface (M) + +#### 6.2.7.1 Notification notifyAlarm (M) + +##### 6.2.7.1.1 Definition + +The PEECMONIRP Agent notifies the PEECMONIRP Manager of a new alarm. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-010
REQ-EECMON-CON-011
REQ-EECMON-CON-012 | | + +##### 6.2.7.1.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|--------------------|-------------------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationId | M | | Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). | +| notificationHeader | M | | This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. | +| notificationType | M | "Alarm notification" | | +| alarmId | M | | Unique alarm id among alarm ids generated by the PEECMONIRP Agent. | +| alarmTime | M | All values indicating valid time. | It indicates the date and time when the alarm is raised by the alarmed PEECMonitoredEntity instance. | +| alarmType | M | | See Event Types in TS 32.111-2 [8] – Annex A. | +| perceivedSeverity | M | | Critical, Major, Minor, Warning, Indeterminate, Cleared: see [10]. | +| probableCause | M | | See Probable Causes in TS 32.111-2 [8] – Annex B. | +| additionalText | O | N/A | It can carry semantics that is outside the scope of this IRP specification. It may provide the identification of the site from which the alarm has been originated. It may contain further information on the alarm. | + +### 6.2.8 CMONNotifications\_3 Interface (M) + +#### 6.2.8.1 Notification notifyConfigurationChange (M) + +##### 6.2.8.1.1 Definition + +The PEECMONIRP Agent notifies the PEECMONIRP Manager of a change of configuration. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-013
REQ-EECMON-CON-014
REQ-EECMON-CON-015 | | + +##### 6.2.8.1.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|--------------------|-------------------|--------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationId | M | | Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). | +| notificationHeader | M | | This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. | +| notificationType | M | "Configuration Change notification" | | +| mEId | M | mEId of the PEEMonitoredEntity instance. | This parameter contains the identification of the monitored entity. | +| attNameValueList | M | List of attribute name (in PEEMEDescription) and value pairs | This parameter contains a list of attribute name+value pairs of the monitored entity, for which a value change happened. | + +### 6.2.9 CMONNotifications\_4 Interface (M) + +#### 6.2.9.1 Notification notifyThresholdCrossingOrReaching (M) + +##### 6.2.9.1.1 Definition + +The PEECMONIRP Agent notifies the PEECMONIRP Manager of a threshold crossing. + +| Referenced TS | Requirement label | Comment | +|--------------------|----------------------------------------------------------------|---------| +| 3GPP TS 28.304 [9] | REQ-EECMON-CON-013
REQ-EECMON-CON-014
REQ-EECMON-CON-015 | | + +##### 6.2.9.1.2 Input parameters + +| Parameter Name | Support Qualifier | Information Type / Legal Values | Comment | +|--------------------|-------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationId | M | | Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). | +| notificationHeader | M | | This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. | +| notificationType | M | "Threshold crossing or reaching notification" | | +| mEId | M | mEId of the PEEMonitoredEntity instance. | This parameter contains the identification of the monitored entity. | +| thresholdInfo | M | | It indicates crossed threshold information such as:
  • The name of the threshold (corresponding to an attribute of PEEConfigInformation) whose value has crossed a threshold,
  • The threshold value,
  • The observed value that have crossed or reached the threshold value.
| + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----------|-----|-----|-------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-03 | SA#79 | | | | | Upgrade to change control version | 15.0.0 | +| 2018-12 | SA#82 | SP-181039 | 000
1 | 1 | F | Include information about referencers to CM, PM and FM IRPs | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28306/raw.md b/marked/Rel-16/28_series/28306/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3a1f74a8464b0d25e2b1f00d3495b2b019a47ce6 --- /dev/null +++ b/marked/Rel-16/28_series/28306/raw.md @@ -0,0 +1,2607 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------------|-----------| +| Foreword ..... | 6 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Solution Set Definitions ..... | 8 | +| Annex A (normative): Solution Set definitions for solution 1..... | 9 | +| A.1 CORBA Solution Set ..... | 9 | +| A.2 SOAP Solution Set and XML Definitions ..... | 9 | +| A.3 REST Solution Set ..... | 9 | +| Annex B (normative): Solution Set definitions for solution 2..... | 10 | +| B.1 CORBA Solution Set ..... | 10 | +| B.2 SOAP Solution Set..... | 10 | +| B.3 REST Solution Set ..... | 10 | +| B.3.0 Introduction ..... | 10 | +| B.3.1 Architectural Features ..... | 10 | +| B.3.2 Mapping ..... | 10 | +| B.3.2.1 Operation mapping ..... | 10 | +| B.3.2.2 Notification mapping..... | 11 | +| B.3.3 CMONOperations_1 interface..... | 11 | +| B.3.3.1 Description..... | 11 | +| B.3.3.2 Resource structure and methods ..... | 11 | +| B.3.3.3 Sequence diagrams (informative) ..... | 12 | +| B.3.3.3.1 Flow of the readMEDescription operation..... | 12 | +| B.3.3.3.2 Flow of the writeMEDescription operation ..... | 12 | +| B.3.3.4 Resources ..... | 13 | +| B.3.3.4.1 Introduction ..... | 13 | +| B.3.3.4.2 Resource: Individual monitored entity..... | 13 | +| B.3.3.4.2.1 Description ..... | 13 | +| B.3.3.4.2.2 Resource definition..... | 13 | +| B.3.3.4.2.3 Resource methods..... | 13 | +| B.3.3.4.2.3.1 GET ..... | 13 | +| B.3.3.4.2.3.2 PATCH ..... | 14 | +| B.3.3.5 Data Model ..... | 14 | +| B.3.3.5.1 Introduction ..... | 14 | +| B.3.3.5.2 Resource and notification data types..... | 14 | +| B.3.3.5.2.1 Introduction ..... | 14 | +| B.3.3.5.2.2 Type: AttributeNameList..... | 14 | +| B.3.3.5.2.3 Type: AttNameValueList ..... | 15 | +| B.3.4 CMONOperations_2 interface..... | 15 | +| B.3.4.1 Description..... | 15 | +| B.3.4.2 Resource structure and attributes..... | 15 | +| B.3.4.3 Sequence diagrams (informative) ..... | 15 | +| B.3.4.3.1 Flow of the readMEConfiguration operation ..... | 15 | +| B.3.4.3.2 Flow of the writeMEConfiguration operation..... | 16 | +| B.3.4.4 Resources ..... | 17 | +| B.3.4.4.1 Introduction ..... | 17 | +| B.3.4.4.2 Resource: Individual monitored entity..... | 17 | + +| | | | +|---------------|------------------------------------------------------|----| +| B.3.4.4.2.1 | Description ..... | 17 | +| B.3.4.4.2.2 | Resource definition..... | 17 | +| B.3.4.4.2.3 | Resource methods..... | 17 | +| B.3.4.4.2.3.1 | GET..... | 17 | +| B.3.4.4.2.3.2 | PUT..... | 17 | +| B.3.4.5 | Data Model ..... | 18 | +| B.3.4.5.1 | Introduction ..... | 18 | +| B.3.4.5.2 | Resource and notification data types..... | 18 | +| B.3.4.5.2.1 | Introduction ..... | 18 | +| B.3.4.5.2.2 | Type: ThresholdNameValueList ..... | 18 | +| B.3.5 | CMONOperations_3 interface..... | 18 | +| B.3.5.0 | Introduction..... | 18 | +| B.3.5.1 | createCMONPMJob operation ..... | 18 | +| B.3.5.1.1 | Description ..... | 18 | +| B.3.5.1.2 | Resource structure and attributes ..... | 18 | +| B.3.5.1.3 | Flow of the createCMONPMJob operation ..... | 19 | +| B.3.5.1.4 | Resource: cmonpmjobs ..... | 19 | +| B.3.5.1.4.1 | Description ..... | 19 | +| B.3.5.1.4.2 | Resource definition..... | 19 | +| B.3.5.1.4.3 | Resource method: POST ..... | 19 | +| B.3.5.1.5 | Data Model..... | 20 | +| B.3.5.1.5.1 | Introduction ..... | 20 | +| B.3.5.1.5.2 | Data Type: MeIdList ..... | 20 | +| B.3.5.1.5.3 | Data Type: MeasurementNameList..... | 20 | +| B.3.5.1.5.4 | Data Type: GranularityPeriod ..... | 20 | +| B.3.5.1.5.5 | Data Type: ServerJobId..... | 20 | +| B.3.5.2 | stopCMONPMJob operation ..... | 21 | +| B.3.5.2.1 | Description ..... | 21 | +| B.3.5.2.2 | Resource structure and attributes ..... | 21 | +| B.3.5.2.3 | Flow of the stopCMONPMJob operation ..... | 21 | +| B.3.5.2.4 | Resource: individual cmonpmjob instance ..... | 22 | +| B.3.5.2.4.1 | Description ..... | 22 | +| B.3.5.2.4.2 | Resource definition..... | 22 | +| B.3.5.2.4.3 | Resource method: DELETE ..... | 22 | +| B.3.5.2.5 | Data Model..... | 22 | +| B.3.5.2.5.1 | Introduction ..... | 22 | +| B.3.5.2.5.2 | Data Type: CmonPmJobId ..... | 22 | +| B.3.6 | CMONNotifications_1 interface ..... | 22 | +| B.3.6.0 | Introduction..... | 22 | +| B.3.6.1 | notifyMeasurementData notification ..... | 22 | +| B.3.6.1.1 | Description ..... | 22 | +| B.3.6.1.2 | Resource structure and attributes ..... | 23 | +| B.3.6.1.3 | Flow of the notifyMeasurementData notification ..... | 23 | +| B.3.6.1.4 | Resource: notification endpoint ..... | 23 | +| B.3.6.1.4.1 | Description ..... | 23 | +| B.3.6.1.4.2 | Resource definition..... | 23 | +| B.3.6.1.4.3 | Resource method: POST ..... | 24 | +| B.3.6.1.5 | Data Model..... | 24 | +| B.3.6.1.5.1 | Introduction ..... | 24 | +| B.3.6.1.5.2 | Data Type: NotificationHeader ..... | 24 | +| B.3.6.1.5.3 | Data Type: MeasDataCollection ..... | 25 | +| B.3.7 | CMONNotifications_2 interface ..... | 25 | +| B.3.7.0 | Introduction..... | 25 | +| B.3.7.1 | notifyAlarm notification ..... | 25 | +| B.3.7.1.1 | Description ..... | 25 | +| B.3.7.1.2 | Resource structure and attributes ..... | 25 | +| B.3.7.1.3 | Flow of the notifyAlarm notification ..... | 25 | +| B.3.7.1.4 | Resource: notification endpoint ..... | 26 | +| B.3.7.1.4.1 | Description ..... | 26 | +| B.3.7.1.4.2 | Resource definition..... | 26 | +| B.3.7.1.4.3 | Resource method: POST ..... | 26 | +| B.3.7.1.5 | Data Model..... | 27 | + +| | | | +|------------------------|-----------------------------------------------------------------|----| +| B.3.7.1.5.1 | Introduction ..... | 27 | +| B.3.7.1.5.2 | Data Type: NotificationHeader ..... | 27 | +| B.3.7.1.5.3 | Data Type: AlarmInformation ..... | 27 | +| B.3.8 | CMONNotifications_3 interface ..... | 27 | +| B.3.8.0 | Introduction..... | 27 | +| B.3.8.1 | notifyConfigurationChange notification ..... | 27 | +| B.3.8.1.1 | Description ..... | 27 | +| B.3.8.1.2 | Resource structure and attributes ..... | 28 | +| B.3.8.1.3 | Flow of the notifyConfigurationChange notification ..... | 28 | +| B.3.8.1.4 | Resource: notification endpoint ..... | 28 | +| B.3.8.1.4.1 | Description ..... | 28 | +| B.3.8.1.4.2 | Resource definition..... | 28 | +| B.3.8.1.4.3 | Resource method: POST ..... | 29 | +| B.3.8.1.5 | Data Model..... | 29 | +| B.3.8.1.5.1 | Introduction ..... | 29 | +| B.3.8.1.5.2 | Data Type: NotificationHeader ..... | 29 | +| B.3.8.1.5.3 | Data Type: ConfigurationChangeInformation..... | 29 | +| B.3.9 | CMONNotifications_4 interface ..... | 29 | +| B.3.9.0 | Introduction..... | 29 | +| B.3.9.1 | notifyThresholdCrossingOrReaching notification..... | 30 | +| B.3.9.1.1 | Description ..... | 30 | +| B.3.9.1.2 | Resource structure and attributes ..... | 30 | +| B.3.9.1.3 | Flow of the notifyThresholdCrossingOrReaching notification..... | 30 | +| B.3.9.1.4 | Resource: notification endpoint ..... | 31 | +| B.3.9.1.4.1 | Description ..... | 31 | +| B.3.9.1.4.2 | Resource definition..... | 31 | +| B.3.9.1.4.3 | Resource method: POST ..... | 31 | +| B.3.9.1.5 | Data Model..... | 31 | +| B.3.9.1.5.1 | Introduction ..... | 31 | +| B.3.9.1.5.2 | Data Type: NotificationHeader ..... | 31 | +| B.3.9.1.5.3 | Data Type: ThresholdCrossingOrReachingInformation ..... | 32 | +| B.3.10 | URI structure and supported content formats ..... | 32 | +| B.3.11 | Solution Set definitions ..... | 32 | +| B.3.11.1 | Solution set definition structure ..... | 32 | +| B.3.11.2 | OpenAPI definition "CMONOperations_1.json" ..... | 33 | +| B.3.11.3 | OpenAPI definition "CMONOperations_2.json" ..... | 35 | +| B.3.11.4 | OpenAPI definition "CMONOperations_3.json" ..... | 38 | +| B.3.11.5 | OpenAPI definition "CMONNotifications_1.json" ..... | 40 | +| B.3.11.6 | OpenAPI definition "CMONNotifications_2.json" ..... | 42 | +| B.3.11.7 | OpenAPI definition "CMONNotifications_3.json" ..... | 43 | +| B.3.11.8 | OpenAPI definition "CMONNotifications_4.json" ..... | 45 | +| Annex C (informative): | Change history..... | 47 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project, Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- TS 28.304 Control and monitoring of Power, Energy and Environmental (PEE) Integration Reference Point (IRP); Requirements +- TS 28.305 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Information Service (IS) +- TS 28.306 Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Solution Set (SS) definitions** + +# --- 1 Scope + +The present document specifies the Solution Set definitions for the control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP). + +The Solution Set definitions are related to 3GPP TS 28.305 V15.0.X [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.305: "Control and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP); Information Service (IS)". +- [3] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [4] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.416: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] 3GPP TS 32.111-6: "Telecommunication management; Fault Management; Part 6: Alarm Integration Reference Point (IRP): Solution Set (SS) definitions".[9] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 2818: "HTTP Over TLS". +- [11] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2". +- [12] 3GPP TS 33 310: "Network Domain Security (NDS); Authentication Framework (AF)". +- [13] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +# --- 4 Solution Set Definitions + +The present document defines the following Solution Set definitions: + +- Annex A provides the Solution Set definitions for solution 1. +- Annex B provides the Solution Set definitions for solution 2. + +# --- Annex A (normative): Solution Set definitions for solution 1 + +## A.1 CORBA Solution Set + +This clause specifies the CORBA Solution Set for the solution 1 of this IRP whose semantics are specified in 3GPP TS 28.305 [2] – clauses 5.1 and 6.1. + +The CORBA Solution Set for solution 1 is based on Corba Solution Sets defined in TS 28.623 [6], TS 32.606 [4], TS 32.616 [3], TS 32.416 [7], TS 32.111-6 [8]. + +## --- A.2 SOAP Solution Set and XML Definitions + +This clause specifies the SOAP Solution Set and XML definitions for the solution 1 of this IRP whose semantics are specified in 3GPP TS 28.305 [2] – clauses 5.1 and 6.1. + +The SOAP Solution Set and XML definitions for solution 1 are based on: + +- XML definitions in TS 28.623 [6], +- SOAP Solution Sets defined in TS 32.606 [4], TS 32.616 [3], TS 32.416 [7], TS 32.111-6 [8]. + +## --- A.3 REST Solution Set + +The REST Solution Set is not applicable to the solution 1 of this IRP. + +# Annex B (normative): Solution Set definitions for solution 2 + +## B.1 CORBA Solution Set + +The CORBA Solution Set is not applicable to the solution 2 of this IRP. + +## B.2 SOAP Solution Set + +The SOAP Solution Set is not applicable to the solution 2 of this IRP. + +## B.3 REST Solution Set + +## B.3.0 Introduction + +This annex specifies the REST Solution Set for the solution 2 of this IRP whose semantics are specified in 3GPP TS 28.305 [2] – clauses 5.2 and 6.2. + +### B.3.1 Architectural Features + +The overall architectural feature of PEECMON IRP solution 2 is specified in 3GPP TS 28.305 [2]. + +This clause specifies features that are specific to the REST SS. + +### B.3.2 Mapping + +#### B.3.2.1 Operation mapping + +PEECMON IRP IS (3GPP TS 28.305 [2]) defines semantics of operation and notification visible across the PEECMON IRP. Tables B.3.2.1.1 to B.3.2.2.4 indicate, per interface, the mapping of operations and notifications to their equivalents defined in this SS. + +**Table B.3.2.1.1: Mapping for CMONOperations\_1 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|------------------------------|-----------| +| readMEDescription | GET | /peemonitoredentities/{meid} | M | +| writeMEDescription | PATCH | /peemonitoredentities/{meid} | M | + +**Table B.3.2.1.2: Mapping for CMONOperations\_2 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|------------------------------|-----------| +| readMEConfiguration | GET | /peemonitoredentities/{meid} | M | +| writeMEConfiguration | PUT | /peemonitoredentities/{meid} | M | + +**Table B.3.2.1.3: Mapping for CMONOperations\_3 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|-----------------------|-----------| +| createCMONPMJob | POST | /cmonpmjobs | M | +| stopCMONPMJob | DELETE | /cmonpmjobs/{pmjobid} | M | + +#### B.3.2.2 Notification mapping + +**Table B.3.2.2.1: Mapping for CMONNotifications\_1 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|-----------------------------------------|-----------| +| notifyMeasurementData | POST | Notification endpoint (client provided) | M | + +**Table B.3.2.2.2: Mapping for CMONNotifications\_2 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|-----------------------------------------|-----------| +| notifyAlarm | POST | Notification endpoint (client provided) | M | + +**Table B.3.2.2.3: Mapping for CMONNotifications\_3 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|-----------------------------------------|-----------| +| notifyConfigurationChange | POST | Notification endpoint (client provided) | M | + +**Table B.3.2.2.4: Mapping for CMONNotifications\_4 interface** + +| IS Operations/ notifications in 3GPP TS 28.305 [2] | HTTP Method | Resource URI | Qualifier | +|----------------------------------------------------|-------------|-----------------------------------------|-----------| +| notifyThresholdCrossing | POST | Notification endpoint (client provided) | M | + +### B.3.3 CMONOperations\_1 interface + +#### B.3.3.1 Description + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.3.1. + +#### B.3.3.2 Resource structure and methods + +All resource URIs of the API shall use the base URI specification defined in clause XXX. The string "cmonoperations\_1" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relative to the above base URI. + +Figure B.3.3.2.1 shows the overall resource URI structure defined for the CMONOperations\_1 interface. + +![Diagram showing the resource URI structure for the CMONOperations_1 interface. The base URI is {apiRoot}/cmonoperations_1/v1. A line descends from this base to a rounded rectangle containing /peemonitoredentities. From this rectangle, another line descends to a second rounded rectangle containing /{meid}.](a7079ddb124df3f1ee13ae406c7c8982_img.jpg) + +``` + +graph TD + Base["{apiRoot}/cmonoperations_1/v1"] --> PE["/peemonitoredentities"] + PE --> MEID["/{meid}"] + +``` + +Diagram showing the resource URI structure for the CMONOperations\_1 interface. The base URI is {apiRoot}/cmonoperations\_1/v1. A line descends from this base to a rounded rectangle containing /peemonitoredentities. From this rectangle, another line descends to a second rounded rectangle containing /{meid}. + +**Figure B.3.3.2.1: Resource URI structure of the CMONOperations\_1 interface** + +#### B.3.3.3 Sequence diagrams (informative) + +##### B.3.3.3.1 Flow of the readMEDescription operation + +This clause describes a sequence flow for reading all attribute values of an individual monitored entity. + +![Sequence diagram for readMEDescription operation](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +A sequence diagram illustrating the flow of the readMEDescription operation. It features two lifelines: Client and Server. The Client sends a GET request to the Server with the message '1. GET .../peemonitoredentities/{meld}'. The Server responds with '2. 200 OK (meld, attNameValueList)'. The Client and Server lifelines are represented by dashed vertical lines with rectangular boxes at the top and bottom. + +Sequence diagram for readMEDescription operation + +**Figure B.3.3.3.1.1: Flow of the readMEDescription operation** + +NOTE: In figure B.3.3.3.1.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +- 1. Client sends a GET request to an individual monitored entity resource, addressed by the appropriate monitored entity identifier in its resource URI. +- 2. Server returns a "200 OK" response to the NM-RMS, and includes the monitored entity Id and a data structure of type "attNameValueList" in the payload body. + +##### **B.3.3.3.2 Flow of the writeMEDescription operation** + +This clause describes a sequence flow for modifying a list of attribute values of an individual monitored entity. + +![Sequence diagram for writeMEDescription operation](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +A sequence diagram illustrating the flow of the writeMEDescription operation. It features two lifelines: Client and Server. The Client sends a PATCH request to the Server with the message '1. PATCH .../peemonitoredentities/{meld}{attNameValueList}'. The Server responds with '2. 200 OK (meld, attNameValueList)'. The Client and Server lifelines are represented by dashed vertical lines with rectangular boxes at the top and bottom. + +Sequence diagram for writeMEDescription operation + +**Figure B.3.3.3.2.1: Flow of the writeMEDescription operation** + +NOTE: In figure B.3.3.3.2.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. Client sends a PATCH request to an individual monitored entity resource, addressed by the appropriate monitored entity identifier in its resource URI, which includes in the payload body a data structure of type "attNameValueList", containing the list of attribute name and value pairs corresponding to attributes to be modified. +2. Server returns a "200 OK" response to the NM-RMS, and includes the monitored entity Id and a data structure of type "attNameValueList" in the payload body, containing the list of attribute name and value pairs corresponding to attributes whose values have been modified. + +#### B.3.3.4 Resources + +##### B.3.3.4.1 Introduction + +This clause defines all the resources and methods provided by the CMONOperations\_1 interface. + +##### B.3.3.4.2 Resource: Individual monitored entity + +##### B.3.3.4.2.1 Description + +This resource represents an individual monitored entity. + +##### B.3.3.4.2.2 Resource definition + +##### B.3.3.4.2.3 Resource methods + +###### B.3.3.4.2.3.1 GET + +The client can use this method to get the value of all attributes of an individual monitored entity. + +**Table B.3.3.4.2.3.1-1: Details of the GET request on this resource** + +| Data type | Cardinality | Description | +|------------------|--------------------|---------------------------------| +| meld | 1 | The Id of the monitored entity. | + +**Table B.3.3.4.2.3.1-2: Details of the GET response on this resource** + +| Data type | Cardinality | Response codes | Description | +|------------------|--------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------| +| meld | 1 | 200 OK | The request was accepted and completed. | +| AttNameValueList | 1 | | The response body shall contain the monitored entity Id and attribute name and value pairs for the monitored entity. | + +###### B.3.3.4.2.3.2 PATCH + +The client can use this method to write the value of a list of attributes of an individual monitored entity. + +**Table B.3.3.4.2.3.2-1: Details of the PATCH request on this resource** + +| Data type | Cardinality | Description | +|------------------|--------------------|------------------------------------------------------------| +| meld | 1 | The Id of the monitored entity. | +| AttNameValueList | 1 | The list of names and values of attributes to be modified. | + +**Table B.3.3.4.2.3.1-2: Details of the PATCH response on this resource** + +| Data type | Cardinality | Response codes | Description | +|------------------|--------------------|-----------------------|---------------------------------------------------------------------------------------------------------------| +| meld | 1 | 200 OK | The request was accepted and completed. | +| AttNameValueList | 1 | | The response body shall contain the monitored entity Id and attribute modifications for the monitored entity. | + +#### B.3.3.5 Data Model + +##### B.3.3.5.1 Introduction + +This clause defines the request and response data structures of the CMONOperations\_1 interface. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### B.3.3.5.2 Resource and notification data types + +##### B.3.3.5.2.1 Introduction + +This clause defines the data structures to be used in the resource representations and notifications for the CMONOperations\_1 interface. + +##### B.3.3.5.2.2 Type: AttributeNameList + +**Table B.3.3.5.2.2-1: Definition of the AttributeNameList data type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------------|------------------|--------------------|-----------------------------------------------| +| attributeName | String | 0..N | Name of the attribute whose value is queried. | + +##### B.3.3.5.2.3 Type: AttNameValueList + +**Table B.3.3.5.2.3-1: Definition of the AttNameValueList data type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------------|---------------------|--------------------|-------------------------------------| +| attributeNameValue | Structure (inlined) | 0..N | Pair of name+value of an attribute. | +| > attributeName | String | 1 | Name of the attribute. | +| > attributeValue | Any | 1 | Value of the attribute. | + +### B.3.4 CMONOperations\_2 interface + +#### B.3.4.1 Description + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.4. + +#### B.3.4.2 Resource structure and attributes + +All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonoperations\_2" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relatively to the above base URI. + +Figure B.3.4.3.2.1 shows the overall resource URI structure defined for the CMONOperations\_2 interface. + +![Figure B.3.4.3.2.1: Resource URI structure of the CMONOperations_2 interface](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +graph TD; Root["{apiRoot}/cmonoperations_2/v1"] --- PE["/pemonitoreidentities"]; PE --- ME["/{meid}"]; +``` + +The diagram illustrates the hierarchical structure of the Resource URI. It starts with the root path `{apiRoot}/cmonoperations_2/v1`, which branches into the `/pemonitoreidentities` resource, which in turn branches into the `/{meid}` resource. + +Figure B.3.4.3.2.1: Resource URI structure of the CMONOperations\_2 interface + +Figure B.3.4.3.2.1: Resource URI structure of the CMONOperations\_2 interface + +#### B.3.4.3 Sequence diagrams (informative) + +##### B.3.4.3.1 Flow of the readMEConfiguration operation + +This clause describes a sequence flow for reading threshold values of an individual monitored entity instance. + +![Figure B.3.4.3.1.1: Flow of the readMEConfiguration operation](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` +sequenceDiagram; participant Client; participant Server; Note left of Client: Client; Note right of Server: Server; Client->>Server: 1. GET .../pemonitoreidentities/{meid}(thresholdNameList); Server-->>Client: 2. 200 OK (meld, thresholdNameValueList); Note left of Client: Client; Note right of Server: Server; +``` + +The sequence diagram shows the interaction between a Client and a Server for the readMEConfiguration operation. The Client sends a GET request to the Server, and the Server responds with a 200 OK status, including the monitored entity Id and a data structure of type "thresholdNameValueList". + +Figure B.3.4.3.1.1: Flow of the readMEConfiguration operation + +Figure B.3.4.3.1.1: Flow of the readMEConfiguration operation + +NOTE: in figure B.3.4.3.1.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. Client sends a GET request to an individual monitored entity resource, addressed by the appropriate monitored entity identifier in its resource URI. +2. Server returns a "200 OK" response to Client, and includes the monitored entity Id and a data structure of type "thresholdNameValueList" in the payload body. + +##### B.3.4.3.2 Flow of the writeMEConfiguration operation + +This clause describes a sequence flow for writing threshold values of an individual monitored entity instance. + +![Sequence diagram showing the flow of the writeMEConfiguration operation. A Client sends a PUT request to a Server. The Server modifies threshold values and returns a 200 OK response.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant Client + participant Server + Client->>Server: 1. PUT .../peemonitoredentities/{meld}{thresholdNameValueList} + Note right of Server: Modifies threshold values of +the monitored entity instance +resource + Server-->>Client: 2. 200 OK (meld, thresholdNameValueList) + +``` + +Sequence diagram showing the flow of the writeMEConfiguration operation. A Client sends a PUT request to a Server. The Server modifies threshold values and returns a 200 OK response. + +Figure B.3.4.3.2.1: Flow of the writeMEConfiguration operation + +NOTE: in figure B.3.4.3.2.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Client sends a PUT request to the individual monitored entity instance resource; +2. The Server modifies values of the thresholds of the monitored entity instance resource; +3. The Server returns a “200 OK” response to the Client, with a payload body containing the monitored entity Id and the actual values of the thresholds in a data structure of type “thresholdNameValueList”. + +#### B.3.4.4 Resources + +##### B.3.4.4.1 Introduction + +This clause defines all the resources and methods provided by the CMONOperations\_2 interface. + +##### B.3.4.4.2 Resource: Individual monitored entity + +##### B.3.4.4.2.1 Description + +This resource represents an individual monitored entity. + +##### B.3.4.4.2.2 Resource definition + +##### B.3.4.4.2.3 Resource methods + +###### B.3.4.4.2.3.1 GET + +The client can use this method to get the value of all threshold values of an individual monitored entity. + +**Table B.3.4.4.2.3.1-1: Details of the GET request on this resource** + +| Data type | Cardinality | Description | +|-----------|-------------|--------------------------| +| meld | 1 | The monitored entity Id. | + +**Table B.3.4.4.2.3.1-2: Details of the GET response on this resource** + +| Data type | Cardinality | Response codes | Description | +|--------------------------------|--------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| meld
ThresholdNameValueList | 1 | 200 OK | The request was accepted and completed. The response body shall contain the monitored entity Id and threshold name and value pairs of the monitored entity. | + +###### **B.3.4.4.2.3.2 PUT** + +The client can use this method to write the value of a list of thresholds of an individual monitored entity. + +**Table B.3.3.4.2.3.2-1: Details of the PUT request on this resource** + +| Data type | Cardinality | Description | +|------------------------|--------------------|------------------------------------------------------------| +| meld | 1 | The monitored entity Id | +| ThresholdNameValueList | 1 | The list of names and values of thresholds to be modified. | + +**Table B.3.4.4.2.3.1-2: Details of the PUT response on this resource** + +| Data type | Cardinality | Response codes | Description | +|--------------------------------|--------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| meld
ThresholdNameValueList | 1 | 200 OK | The request was accepted and completed. The response body shall contain the monitored entity Id and threshold modifications for the monitored entity. | + +#### **B.3.4.5 Data Model** + +##### **B.3.4.5.1 Introduction** + +This clause defines the request and response data structures of the CMONOperations\_2 interface. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### **B.3.4.5.2 Resource and notification data types** + +##### **B.3.4.5.2.1 Introduction** + +This clause defines the data structures to be used in the resource representations and notifications for the CMONOperations\_2 interface. + +##### **B.3.4.5.2.2 Type: ThresholdNameValueList** + +**Table B.3.4.5.2.2-1: Definition of the ThresholdNameValueList data type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------------|---------------------|--------------------|------------------------------------| +| thresholdNameValue | Structure (inlined) | 0..N | Pair of name+value of a threshold. | +| > thresholdName | String | 1 | Name of the threshold. | +| > thresholdValue | Any | 1 | Value of the threshold. | + +### **B.3.5 CMONOperations\_3 interface** + +### **B.3.5.0 Introduction** + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.5. + +#### B.3.5.1 createCMONPMJob operation + +##### B.3.5.1.1 Description + +The semantics of this operation is described in 3GPP TS 28.305 [2] – clause 6.2.5.1. + +##### B.3.5.1.2 Resource structure and attributes + +All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonoperations\_3" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relative to the above base URI. + +Figure B.3.5.1.2.1 shows the overall resource URI structure defined for the createCMONPMJob operation. + +![Resource URI structure diagram showing {apiRoot}/cmonoperations_3/v1 branching to /cmonpmjobs.](3fa8bfee86764e3c3a1a6fbbe61bbd52_img.jpg) + +``` + +graph TD + Root["{apiRoot}/cmonoperations_3/v1"] --> Path["/cmonpmjobs"] + +``` + +Resource URI structure diagram showing {apiRoot}/cmonoperations\_3/v1 branching to /cmonpmjobs. + +Figure B.3.5.1.2.1: Resource URI structure of the createCMONPMJob operation + +##### B.3.5.1.3 Flow of the createCMONPMJob operation + +This clause describes a sequence flow for creating an individual cmonpmjob instance. + +![Sequence diagram showing Client sending a POST request to Server, Server creating a resource, and Server returning a 201 Created response.](7b8b192e2853ef28d28eff0241ebe86b_img.jpg) + +``` + +sequenceDiagram + participant Client + participant Server + Note right of Server: 2. Creates Cmonpmjob instance resource + Client->>Server: 1. POST .../cmonpmjobs(CreateCmonpmjobParameters) + Server-->>Client: 3. 201 Created (cmonpmjobid) + +``` + +Sequence diagram showing Client sending a POST request to Server, Server creating a resource, and Server returning a 201 Created response. + +Figure B.3.5.1.3.1: Flow of the createCMONPMJob operation + +NOTE: in figure B.3.4.1.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Client sends a POST request to the cmonpmjobs resource, including in the payload body a data structure of type “Createcmonpmjobparamaters”; +2. The Server creates a new Cmonpmjob instance, and the associated Cmonpmjob instance identifier; +3. The Server returns a “201 Created” response to the Client, containing a representation of the Cmonpmjob instance resource just created by the Server, and provides the URI of the newly created resource in the “Location” HTTP header. + +##### B.3.5.1.4 Resource: cmonpmjobs + +##### B.3.5.1.4.1 Description + +This resource represents cmonpmjobs. The client can use this resource to request the creation of a new instance of cmonpmjob. + +##### B.3.5.1.4.2 Resource definition + +The resource URI is: {apiRoot}/cmonoperations\_3/v1/cmonpmjobs + +##### B.3.5.1.4.3 Resource method: POST + +The client can use this method to create an individual cmonpmjob instance. + +**Table B.3.5.1.4.3-1: Details of the POST request on this resource** + +| Data type | Cardinality | Description | +|---------------------|-------------|----------------------------------------------------------------------------------------------| +| MeldList | 1 | The list of mElds of PEEMonitoredEntity instances on which measurements are to be collected. | +| MeasurementNameList | 1 | The list of names of measurements to be collected. | +| GranularityPeriod | 1 | The granularity period. | + +**Table B.3.5.1.4.3-2: Details of the POST response on this resource** + +| Data type | Cardinality | Response codes | Description | +|-------------|-------------|---------------------------|------------------------------------------------------------------------------------------------------------| +| CmonPmJobId | 1 | 201 Created (cmonpmjobid) | The request was accepted. The new instance of cmonpmjob is created by Server and its Id is sent to Client. | + +#### B.3.5.1.5 Data Model + +##### B.3.5.1.5.1 Introduction + +This clause defines the request and response data structures of the createCMONPMJob operation. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +###### B.3.5.1.5.2 Data Type: MeldList + +**Table B.3.5.1.5.2-1: Definition of the MeldList data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|------------|-------------|------------------------------------------| +| mEld | Identifier | 1..N | Identifier of monitored entity instance. | + +###### B.3.5.1.5.3 Data Type: MeasurementNameList + +**Table B.3.5.1.5.3-1: Definition of the MeasurementNameList data type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------|-----------|-------------|----------------------------------------------------------------------------------------------| +| measurementName | String | 1..N | Name of the the measurement. It shall correspond to an attribute name of PEEMeasurementData. | + +##### B.3.5.1.5.4 Data Type: GranularityPeriod + +**Table B.3.5.1.5.4-1: Definition of the GranularityPeriod data type** + +| Attribute name | Data type | Cardinality | Description | +|-------------------|-----------|-------------|------------------------------------------------------------------------------------| +| granularityPeriod | Integer | 1 | It specifies the period between two successive measurements. Expressed in munutes. | + +##### B.3.5.1.5.5 Data Type: ServerJobId + +**Table B.3.5.1.5.6-1: Definition of the CmonPmJobId data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|------------|-------------|-------------------------------------------------------| +| cmonmjobid | Identifier | 1 | Identifier of cmonpmjob instance, assigned by Server. | + +#### B.3.5.2 stopCMONPMJob operation + +##### B.3.5.2.1 Description + +The semantics of this operation is described in 3GPP TS 28.305 [2] – clause 6.2.5.2. + +##### B.3.5.2.2 Resource structure and attributes + +All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonoperations\_3" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relative to the above base URI. + +Figure B.3.5.2.2.1 shows the overall resource URI structure defined for the stopCMONPMJob operation. + +![Diagram showing the resource URI structure for the stopCMONPMJob operation. The root URI is {apiRoot}/cmonoperations_3/v1. A vertical line descends from this root to a box containing /cmonpmjobs. From this box, another vertical line descends to a box containing /{cmonpmjobid}.](37819f1170c36655c57129b6bd8a5ceb_img.jpg) + +``` + +graph TD + Root["{apiRoot}/cmonoperations_3/v1"] --- Box1["/cmonpmjobs"] + Box1 --- Box2["/{cmonpmjobid}"] + +``` + +Diagram showing the resource URI structure for the stopCMONPMJob operation. The root URI is {apiRoot}/cmonoperations\_3/v1. A vertical line descends from this root to a box containing /cmonpmjobs. From this box, another vertical line descends to a box containing /{cmonpmjobid}. + +Figure B.3.5.2.2.1: Resource URI structure of the stopCMONPMJob operation + +##### B.3.5.2.3 Flow of the stopCMONPMJob operation + +This clause describes a sequence flow for stopping an individual cmonpmjob. + +![Sequence diagram showing the flow of the stopCMONPMJob operation. A Client sends a DELETE request to a Server. The Server deletes the Cmonpmjob instance resource. The Server returns a 204 No Content response to the Client.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant Client + participant Server + Note right of Server: 2. Deletes Cmonpmjob instance resource + Client->>Server: 1. DELETE .../cmonpmjobs/(cmonpmjobId) + Server-->>Client: 3. 204 No Content + +``` + +Sequence diagram showing the flow of the stopCMONPMJob operation. A Client sends a DELETE request to a Server. The Server deletes the Cmonpmjob instance resource. The Server returns a 204 No Content response to the Client. + +Figure B.3.5.2.3.1: Flow of the stopCMONPMJob operation + +NOTE: in figure B.3.5.2.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Client sends a DELETE request to the individual cmonpmjob instance resource; +2. The Server deletes the cmonpmjob instance resource, and the associated cmonpmjob instance identifier; +3. The Server returns a “204 No Content” response to the Client, with an empty payload body. + +##### B.3.5.2.4 Resource: individual cmonpmjob instance + +##### B.3.5.2.4.1 Description + +This resource represents an individual cmonpmjob instance. + +##### B.3.5.2.4.2 Resource definition + +The resource URI is: {apiRoot}/cmonoperations\_3/v1/cmonpmjobs/{cmonpmjobId} + +##### B.3.5.2.4.3 Resource method: DELETE + +The client can use this method to delete an individual cmonpmjob instance. + +**Table B.3.5.2.4.3-1: Details of the DELETE request on this resource** + +| Data type | Cardinality | Description | +|-------------|-------------|-----------------------------------| +| CmonPmJobId | 1 | The Id of the cmonpmjob instance. | + +**Table B.3.5.2.4.3-2: Details of the DELETE response on this resource** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|----------------|------------------------------------------------------------------------| +| N/A | | 204 | The request was accepted. The cmonpmjob instance is deleted by Server. | + +#### B.3.5.2.5 Data Model + +##### B.3.5.2.5.1 Introduction + +This clause defines the request and response data structures of the stopCMONPMJob operation. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### B.3.5.2.5.2 Data Type: CmonPmJobId + +**Table B.3.5.2.5.2-1: Definition of the CmonPmJobId data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|------------|-------------|-------------------------------------| +| cmonpmjobid | Identifier | 1 | Identifier of a cmonpmjob instance. | + +### B.3.6 CMONNotifications\_1 interface + +### B.3.6.0 Introduction + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.6. + +#### B.3.6.1 notifyMeasurementData notification + +##### B.3.6.1.1 Description + +The semantics of this notification is described in 3GPP TS 28.305 [2] – clause 6.2.6.1. + +##### B.3.6.1.2 Resource structure and attributes + +All resource URI of the API shall use the base URI specification defined in clause B.3.10. The string "cmonnotifications\_1" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URI in the clauses below are defined relatively to the above base URI. + +NOTE: This version of the specification does not define how the Client URL is provisioned to the Server. + +##### B.3.6.1.3 Flow of the notifyMeasurementData notification + +This clause describes a sequence flow for notifying measurement data. + +![Sequence diagram showing the flow of the notifyMeasurementData notification. The diagram consists of two vertical lifelines labeled 'Server' at the top and bottom. A solid horizontal arrow points from the top 'Server' box to the top 'Client' box, labeled '1. POST <>(MeasDataNotification)'. A solid horizontal arrow points from the top 'Client' box back to the top 'Server' box, labeled '3. 204 No Content'. Dashed vertical lines extend downwards from the top boxes to the bottom boxes, representing the continuation of the lifelines.](bf96e9da8f2d27ba1e84274f0f1a691d_img.jpg) + +Sequence diagram showing the flow of the notifyMeasurementData notification. The diagram consists of two vertical lifelines labeled 'Server' at the top and bottom. A solid horizontal arrow points from the top 'Server' box to the top 'Client' box, labeled '1. POST <>(MeasDataNotification)'. A solid horizontal arrow points from the top 'Client' box back to the top 'Server' box, labeled '3. 204 No Content'. Dashed vertical lines extend downwards from the top boxes to the bottom boxes, representing the continuation of the lifelines. + +Figure B.3.6.1.3.1: Flow of the notifyMeasurementData notification + +NOTE: in figure B.3.6.1.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Server generates a notification which includes measurement data, and sends it in the body of a POST request to the Client URI; +2. The Client acknowledges the successful delivery of the notification by returning a “204 No Content” response. + +##### B.3.6.1.4 Resource: notification endpoint + +##### B.3.6.1.4.1 Description + +This resource represents a notification endpoint. The Server can use this resource to send notifications to the Client, which has provided the URI of this resource. + +##### B.3.6.1.4.2 Resource definition + +The resource URI has been provided by the Client. + +##### B.3.6.1.4.3 Resource method: POST + +The Server can use this method to send a notification to the Client. + +**Table B.3.6.1.4.3-1: Details of the POST request on this resource** + +| Data type | Cardinality | Description | +|--------------------|-------------|-------------------------------------| +| NotificationHeader | 1 | The header of the notification. | +| MeasDataCollection | 1 | The collection of measurement data. | + +**Table B.3.6.1.4.3-2: Details of the POST response on this resource** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|----------------|----------------------------------------------| +| None | | 204 | The notification was delivered successfully. | + +#### B.3.6.1.5 Data Model + +##### B.3.6.1.5.1 Introduction + +This clause defines the request and response data structures of the notifyMeasurementData notification. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### B.3.6.1.5.2 Data Type: NotificationHeader + +**Table B.3.6.1.5.2-1: Definition of the NotificationHeader data type** + +| Attribute name | Data type | Cardinality | Description | +|------------------|---------------------|-------------|-----------------------------------------------------| +| notificationId | Identifier | 1 | Identifier of the notification instance. | +| notificationType | String | 1 | The type of notification (=“MeasDataNotification”). | +| senderInfo | Structure (inlined) | 1 | Information about the sender of the notification. | +| >senderName | String | 1 | The name of the sender. | +| >senderType | String | 1 | The type of the sender. | +| >vendorName | String | 1 | The name of the vendor of the sender. | + +##### B.3.6.1.5.3 Data Type: MeasDataCollection + +**Table B.3.6.1.5.3-1: Definition of the MeasDataCollection data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------------|---------------------|-------------|-----------------------------------------------------------------------------------------------------------| +| MeasHeader | Structure (inlined) | 1 | The measurement header. | +| >measFormatVersion | String | 1 | The format version of the measurement data collection | +| >collectionBeginTime | DateTime | 1 | The start of the measurement collection interval (granularity period) for the collected measurement data. | +| >jobId | Identifier | 1 | The identifier of the cmonpmjob thanks to which these measurement data are collected. | +| MeasData | Structure (inlined) | 1..N | The measurement data. | +| >mEld | Identifier | | Identifier of the monitored entity instance | +| >measInfo | Structure (inlined) | 1..N | The sequence of measurements, values and related information. | +| >>measName | String | 1 | The name of the measurement | +| >>measValue | Any | 1 | The value of the measurement | +| MeasFooter | Structure (inlined) | 1 | The measurement footer. | +| >collectionEndTime | DateTime | 1 | The end of the measurement collection interval (granularity period) for the collected measurement data. | + +### B.3.7 CMONNotifications\_2 interface + +### B.3.7.0 Introduction + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.7. + +#### B.3.7.1 notifyAlarm notification + +##### B.3.7.1.1 Description + +The semantics of this notification is described in 3GPP TS 28.305 [2] – clause 6.2.7.1. + +##### B.3.7.1.2 Resource structure and attributes + +All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonnotifications\_2" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relative to the above base URI. + +NOTE: This version of the specification does not define how the Client URL is provisioned to the Server. + +##### B.3.7.1.3 Flow of the notifyAlarm notification + +This clause describes a sequence flow for notifying an alarm. + +![Sequence diagram showing the flow of the notifyAlarm notification between a Server and a Client. The Server sends a POST request to the Client URL with an AlarmNotification. The Client responds with a 204 No Content status.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant Server + participant Client + Server->>Client: 1. POST <>(AlarmNotification) + Client-->>Server: 3. 204 No Content + +``` + +Sequence diagram showing the flow of the notifyAlarm notification between a Server and a Client. The Server sends a POST request to the Client URL with an AlarmNotification. The Client responds with a 204 No Content status. + +Figure B.3.7.1.3.1: Flow of the notifyAlarm notification + +NOTE: in figure B.3.6.1.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Client generates a notification which includes alarm data, and sends it in the body of a POST request to the Server URI; +2. The Server acknowledges the successful delivery of the notification by returning a “204 No Content” response. + +##### B.3.7.1.4 Resource: notification endpoint + +###### B.3.7.1.4.1 Description + +This resource represents a notification endpoint. The Server can use this resource to send notifications to the Client, which has provided the URI of this resource. + +##### B.3.7.1.4.2 Resource definition + +The resource URI has been provided by the Client. + +###### B.3.7.1.4.3 Resource method: POST + +The Server can use this method to send a notification to the Client. + +**Table B.3.7.1.4.3-1: Details of the POST request on this resource** + +| Data type | Cardinality | Description | +|--------------------|--------------------|----------------------------------| +| NotificationHeader | 1 | The header of the notification. | +| AlarmInformation | 1 | The information about the alarm. | + +**Table B.3.7.1.4.3-2: Details of the POST response on this resource** + +| Data type | Cardinality | Response codes | Description | +|------------------|--------------------|-----------------------|----------------------------------------------| +| None | | 204 | The notification was delivered successfully. | + +#### B.3.7.1.5 Data Model + +##### B.3.7.1.5.1 Introduction + +This clause defines the request and response data structures of the notifyAlarm notification. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### B.3.7.1.5.2 Data Type: NotificationHeader + +**Table B.3.7.1.5.2-1: Definition of the NotificationHeader data type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------------|---------------------|--------------------|---------------------------------------------------| +| notificationId | Identifier | 1 | Identifier of the notification instance. | +| notificationType | String | 1 | The type of notification (= "AlarmNotification"). | +| senderInfo | Structure (inlined) | 1 | Information about the sender of the notification. | +| >senderName | String | 1 | The name of the sender. | +| >senderType | String | 1 | The type of the sender. | +| >vendorName | String | 1 | The name of the vendor of the sender. | + +##### B.3.7.1.5.3 Data Type: AlarmInformation + +**Table B.3.7.1.5.3-1: Definition of the AlarmInformation data type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------------|------------------|--------------------|--------------------------------------------| +| alarmId | Identifier | 1 | See 3GPP TS 28.305 [2] – clause 6.2.7.1.2. | +| alarmTime | DateTime | 1 | See 3GPP TS 28.305 [2] – clause 6.2.7.1.2. | +| alarmType | String | 1 | See 3GPP TS 28.305 [2] – clause 6.2.7.1.2. | +| perceivedSeverity | String | 1 | See 3GPP TS 28.305 [2] – clause 6.2.7.1.2. | +| probableCause | String | 1 | See 3GPP TS 28.305 [2] – clause 6.2.7.1.2. | +| additionalText | String | 0..1 | See 3GPP TS 28.305 [2] – clause 6.2.7.1.2. | + +### B.3.8 CMONNotifications\_3 interface + +### B.3.8.0 Introduction + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.8. + +#### B.3.8.1 notifyConfigurationChange notification + +##### B.3.8.1.1 Description + +The semantics of this notification is described in 3GPP TS 28.305 [2] – clause 6.2.8.1. + +##### B.3.8.1.2 Resource structure and attributes + +All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonnotifications\_3" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relatively to the above base URI. + +NOTE: This version of the specification does not define how the Client URL is provisioned to the Server. + +##### B.3.8.1.3 Flow of the notifyConfigurationChange notification + +This clause describes a sequence flow for notifying a configuration change. + +![Sequence diagram showing the flow of the notifyConfigurationChange notification. The Client sends a POST request to the Server, and the Server responds with a 204 No Content.](356eb99ab9489bbd647223390a913903_img.jpg) + +``` +sequenceDiagram + participant Client + participant Server + Note left of Client: Client + Note right of Server: Server + Client->>Server: 1. POST <>(ConfigurationChangeNotification) + Server-->>Client: 3. 204 No Content +``` + +Sequence diagram showing the flow of the notifyConfigurationChange notification. The Client sends a POST request to the Server, and the Server responds with a 204 No Content. + +Figure B.3.8.1.3.1: Flow of the notifyConfigurationChange notification + +NOTE: in figure B.3.8.1.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Client generates a notification which includes configuration change data, and sends it in the body of a POST request to the Server URI; +2. The Server acknowledges the successful delivery of the notification by returning a “204 No Content” response. + +##### B.3.8.1.4 Resource: notification endpoint + +###### B.3.8.1.4.1 Description + +This resource represents a notification endpoint. The Server can use this resource to send notifications to the Client, which has provided the URI of this resource. + +##### B.3.8.1.4.2 Resource definition + +The resource URI has been provided by the Client. + +###### B.3.8.1.4.3 Resource method: POST + +The Server can use this method to send a notification to the Client. + +**Table B.3.8.1.4.3-1: Details of the POST request on this resource** + +| Data type | Cardinality | Description | +|--------------------------------|-------------|-------------------------------------------------| +| NotificationHeader | 1 | The header of the notification. | +| ConfigurationChangeInformation | 1 | The information about the configuration change. | + +**Table B.3.8.1.4.3-2: Details of the POST response on this resource** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|----------------|----------------------------------------------| +| None | | 204 | The notification was delivered successfully. | + +#### B.3.8.1.5 Data Model + +##### B.3.8.1.5.1 Introduction + +This clause defines the request and response data structures of the notifyConfigurationChange notification. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### B.3.8.1.5.2 Data Type: NotificationHeader + +**Table B.3.8.1.5.2-1: Definition of the NotificationHeader data type** + +| Attribute name | Data type | Cardinality | Description | +|------------------|---------------------|-------------|----------------------------------------------------------------| +| notificationId | Identifier | 1 | Identifier of the notification instance. | +| notificationType | String | 1 | The type of notification (=“ConfigurationChangeNotification”). | +| senderInfo | Structure (inlined) | 1 | Information about the sender of the notification. | +| >senderName | String | 1 | The name of the sender. | +| >senderType | String | 1 | The type of the sender. | +| >vendorName | String | 1 | The name of the vendor of the sender. | + +##### B.3.8.1.5.3 Data Type: ConfigurationChangeInformation + +**Table B.3.8.1.5.3-1: Definition of the ConfigurationChangeInformation data type** + +| Attribute name | Data type | Cardinality | Description | +|------------------|----------------|-------------|--------------------------------------------| +| mEId | Identifier | 1 | See 3GPP TS 28.305 [2] – clause 6.2.8.1.2. | +| attNameValueList | KeyValuesPairs | 1..N | See 3GPP TS 28.305 [2] – clause 6.2.8.1.2. | + +### B.3.9 CMONNotifications\_4 interface + +#### B.3.9.0 Introduction + +The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.9. + +#### B.3.9.1 notifyThresholdCrossingOrReaching notification + +##### B.3.9.1.1 Description + +The semantics of this notification is described in 3GPP TS 28.305 [2] – clause 6.2.9.1. + +##### B.3.9.1.2 Resource structure and attributes + +All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonnotifications\_4" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relative to the above base URI. + +NOTE: This version of the specification does not define how the Client URL is provisioned to the Server. + +##### B.3.9.1.3 Flow of the notifyThresholdCrossingOrReaching notification + +This clause describes a sequence flow for notifying that a threshold has been crossed or reached. + +![Sequence diagram showing the flow of the notifyThresholdCrossingOrReaching notification. The diagram consists of two vertical lifelines labeled 'Server' and 'Client'. The interaction starts with the Client sending a POST request to the Server (Step 1). The Server responds with a 204 No Content (Step 3).](f2ea0f64a770b22b902820457d262265_img.jpg) + +``` +sequenceDiagram + participant Client + participant Server + Note left of Client: Client generates notification + Client->>Server: 1. POST <>(ThresholdCrossingOrReachingNotification) + Note right of Server: Server acknowledges + Server-->>Client: 3. 204 No Content +``` + +Sequence diagram showing the flow of the notifyThresholdCrossingOrReaching notification. The diagram consists of two vertical lifelines labeled 'Server' and 'Client'. The interaction starts with the Client sending a POST request to the Server (Step 1). The Server responds with a 204 No Content (Step 3). + +Figure B.3.9.1.3.1: Flow of the notifyThresholdCrossingOrReaching notification + +NOTE: in figure B.3.9.1.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM. + +This operation consists of the following steps: + +1. The Client generates a notification which includes threshold crossing information, and sends it in the body of a POST request to the Server URI; +2. The Server acknowledges the successful delivery of the notification by returning a “204 No Content” response. + +##### B.3.9.1.4 Resource: notification endpoint + +###### B.3.9.1.4.1 Description + +This resource represents a notification endpoint. The Server can use this resource to send notifications to the Client, which has provided the URI of this resource. + +###### B.3.9.1.4.2 Resource definition + +The resource URI has been provided by the Client. + +###### B.3.9.1.4.3 Resource method: POST + +The Server can use this method to send a notification to the Client. + +**Table B.3.9.1.4.3-1: Details of the POST request on this resource** + +| Data type | Cardinality | Description | +|----------------------------------------|-------------|----------------------------------------------------------| +| NotificationHeader | 1 | The header of the notification. | +| ThresholdCrossingOrReachingInformation | 1 | The information about the threshold crossing / reaching. | + +**Table B.3.9.1.4.3-2: Details of the POST response on this resource** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|----------------|----------------------------------------------| +| None | | 204 | The notification was delivered successfully. | + +#### B.3.9.1.5 Data Model + +##### B.3.9.1.5.1 Introduction + +This clause defines the request and response data structures of the notifyThresholdCrossingOrReaching notification. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them. + +##### B.3.9.1.5.2 Data Type: NotificationHeader + +**Table B.3.9.1.5.2-1: Definition of the NotificationHeader data type** + +| Attribute name | Data type | Cardinality | Description | +|------------------|---------------------|-------------|------------------------------------------------------------------------| +| notificationId | Identifier | 1 | Identifier of the notification instance. | +| notificationType | String | 1 | The type of notification (=“ThresholdCrossingOrReachingNotification”). | +| senderInfo | Structure (inlined) | 1 | Information about the sender of the notification. | +| >senderName | String | 1 | The name of the sender. | +| >senderType | String | 1 | The type of the sender. | +| >vendorName | String | 1 | The name of the vendor of the sender. | + +###### B.3.9.1.5.3 Data Type: ThresholdCrossingOrReachingInformation + +**Table B.3.9.1.5.3-1: Definition of the ThresholdCrossingInformation data type** + +| Attribute name | Data type | Cardinality | Description | +|-------------------------|---------------------|-------------|--------------------------------------------| +| mEId | Identifier | 1 | See 3GPP TS 28.305 [2] – clause 6.2.9.1.2. | +| thresholdInfo | Structure (inlined) | 1..N | See 3GPP TS 28.305 [2] – clause 6.2.9.1.2. | +| >thresholdName | String | 1 | See 3GPP TS 28.305 [2] – clause 6.2.9.1.2. | +| >thresholdValue | (any type) | 1 | See 3GPP TS 28.305 [2] – clause 6.2.9.1.2. | +| >thresholdObservedValue | (any type) | 1 | See 3GPP TS 28.305 [2] – clause 6.2.9.1.2. | + +### B.3.10 URI structure and supported content formats + +This clause specifies the URI prefix and the supported formats applicable to the APIs defined in the present document. + +All resource URIs of the APIs shall have the following prefix: + +{apiRoot}/{apiName}/{apiVersion}/ + +where: + +{apiRoot} indicates the scheme ("http" or "https"), the host name and optional port, and an optional prefix path. + +{apiName} indicates the interface name in an abbreviated form. The {apiName} of each interface is defined in the clause specifying the corresponding interface. + +{apiVersion} indicates the current version of the API and is defined in the clause specifying the corresponding interface. + +For HTTP requests and responses that have a body, the content format JSON (see IETF RFC 7159 [9]) shall be supported. The JSON format shall be signalled by the content type "application/json". + +All APIs shall support and use HTTP over TLS (also known as HTTPS) (see IETF RFC 2818 [10]). TLS version 1.2 as defined by IETF RFC 5246 [11] shall be supported. + +NOTE 1: The HTTP protocol elements mentioned in the present document originate from the HTTP specification; HTTPS runs the HTTP protocol in a TLS layer. The present document therefore uses the statement above to mention "HTTP request", "HTTP header", etc., without explicitly calling out whether or not these are run over TLS. + +NOTE 2: There are a number of best practices and guidelines how to configure and implement TLS 1.2 in a secure manner, as security threats evolve. A detailed specification of those is beyond the scope of the present document; the reader is referred to external documentation such as Annex E of 3GPP TS 33 310 [12]. + +All resource URIs of the API shall comply with the URI syntax as defined in IETF RFC 3986 [13]. An implementation that dynamically generates resource URI parts (path segments, query parameter values) shall ensure that these parts only use the character set that is allowed by IETF RFC 3986 [13] for these parts. + +NOTE 3: This means that characters which are not part of this allowed set need to be escaped using percentencoding as defined by IETF RFC 3986 [13]. + +### B.3.11 Solution Set definitions + +#### B.3.11.1 Solution set definition structure + +B.3.11.2 of the present document defines the OpenAPI schema `CMONOperations_1.json` for the `CMONOperations_1` interface defined in 3GPP TS 28.305 [2]. + +Note: To conform to RESTful principles, B.3.11.2 defines the following additional operation which is not described in 3GPP TS 28.305 [2] + +GET /cmonoperations\_1/v1/peemonitoredentities + +B.3.11.3 of the present document defines the OpenAPI schema `CMONOperations_2.json` for the `CMONOperations_2` interface defined in 3GPP TS 28.305 [2]. + +Note: To conform to RESTful principles, B.3.11.3 defines the following additional operation which is not described in 3GPP TS 28.305 [2] + +GET /cmonoperations\_2/v1/peemonitoredentities + +B.3.11.4 of the present document defines the OpenAPI schema `CMONOperations_3.json` for the `CMONOperations_3` interface defined in 3GPP TS 28.305 [2]. + +Note: To conform to RESTful principles, B.3.11.4 defines the following additional operations which are not described in 3GPP TS 28.305 [2] + +GET /cmonoperations\_3/v1/cmonpmjobs + +GET /cmonoperations\_3/v1/cmonpmjobs/{CMONPMJobId} + +B.3.11.5 of the present document defines the OpenAPI schema `CMONNotifications_1.json` for the `CMONNotifications_1` interface defined in 3GPP TS 28.305 [2]. + +B.3.11.6 of the present document defines the OpenAPI schema `CMONNotifications_2.json` for the `CMONNotifications_2` interface defined in 3GPP TS 28.305 [2]. + +B.3.11.7 of the present document defines the OpenAPI schema CMONNotifications\_3.json for the CMONNotifications\_3 interface defined in 3GPP TS 28.305 [2]. + +B.3.11.8 of the present document defines the OpenAPI schema CMONNotifications\_4.json for the CMONNotifications\_4 interface defined in 3GPP TS 28.305 [2]. + +#### B.3.11.2 OpenAPI definition "CMONOperations\_1.json" + +``` +{ + "swagger": "2.0", + "info": { + "title": "CMONOperations_1 Interface", + "description": "PEE Monitoring", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonoperations_1/v1", + "produces": [ + "application/json" + ], + "paths": { + "/peemonitoredentities": { + "get": { + "summary": "Read descriptions for all monitored entities", + "description": "The client can use this method to get a list of all monitored entities +and their descriptions.", + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "meid": { + "type": "string", + "description": "Monitored entity ID" + }, + "Description": { + "$ref": "#/definitions/PEEMEDescription" + } + } + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/peemonitoredentities/{meid}": { + "get": { + "summary": "Read description for a monitored entity", + "description": "The client can use this method to get the description of an individual +monitored entity.", + "parameters": [ + { + "in": "path", + "name": "meid", + "description": "Monitored Entity ID", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "type": "object", + } + } + } + } + } + } +} +``` + +``` + "properties": { + "meid": { + "type": "string", + "description": "Monitored entity ID" + }, + "Description": { + "$ref": "#/definitions/PEEMEDescription" + } + } + } + }, + "404": { + "description": "Invalid identifier" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } +}, +"patch": { + "summary": "Modify description for a monitored entity", + "description": "The client can use this method to modify the description of an +individual monitored entity.", + "parameters": [ + { + "in": "path", + "name": "meid", + "description": "Monitored Entity ID", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "Description", + "description": "Attributes of an individual monitored entity.", + "schema": { + "$ref": "#/definitions/PEEMEDescription" + } + } + ], + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "type": "object", + "properties": { + "meid": { + "type": "string", + "description": "Monitored entity ID" + }, + "Description": { + "$ref": "#/definitions/PEEMEDescription" + } + } + } + }, + "404": { + "description": "Invalid identifier" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } +} +} +}, +"definitions": { + "PEEMEDescription": { + "type": "object", + "properties": { + "siteIdentification": { + "type": "string", +``` + +``` + + "description": "Identification of the site of the monitored entity." + }, + "siteLatitude": { + "type": "string", + "description": "The latitude of the site location." + }, + "siteLongitude": { + "type": "string", + "description": "The longitude of the site location." + }, + "siteDescription": { + "type": "string", + "description": "Description of the site of the monitored entity." + }, + "equipmentType": { + "type": "string", + "description": "Indicates the type of equipment of the monitored entity." + }, + "environmentType": { + "type": "string", + "description": "Indicates the type of environment of the monitored entity." + }, + "powerInterface": { + "type": "string", + "description": "Indicates the type of power interface of the monitored entity." + }, + "xcuDguDescription": { + "type": "string", + "description": "Description of the XCU/DGU." + }, + "sensorDescription": { + "type": "string", + "description": "Description of the sensor." + }, + "vSRmsDescription": { + "type": "string", + "description": "Description of the VS-RMS." + } + } +}, +"Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } +} + +``` + +#### B.3.11.3 OpenAPI definition "CMONOperations\_2.json" + +``` + +{ + "swagger": "2.0", + "info": { + "title": "CMONOperations_2 Interface", + "description": "PEE Configurations", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonoperations_2/v1", + "produces": [ + "application/json" + ], + "paths": { + "/peemonitoredentities": { + "get": { + "summary": "Read configurations for all monitored entities", + "description": "The client can use this method to get a list of all monitored entities and their configurations.", + "responses": { + "200": { + +``` + +``` + "description": "The request was accepted and completed", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "meid": { + "type": "string", + "description": "Monitored entity ID" + }, + "Configuration": { + "$ref": "#/definitions/PEEMEConfiguration" + } + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/peemonitoredentities/{meid}": { + "get": { + "summary": "Read configuration for a monitored entity", + "description": "The client can use this method to get the configuration of an individual +monitored entity", + "parameters": [ + { + "in": "path", + "name": "meid", + "description": "Monitored Entity ID", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "type": "object", + "properties": { + "meid": { + "type": "string", + "description": "Monitored entity ID" + }, + "Configuration": { + "$ref": "#/definitions/PEEMEConfiguration" + } + } + } + }, + "404": { + "description": "Invalid identifier" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "put": { + "summary": "Modify configuration for a monitored entity", + "description": "The client can use this method to modify the configuration of an +individual monitored entity.", + "parameters": [ + { + "in": "path", + "name": "meid", + "description": "Monitored Entity ID", + "required": true, + "type": "string" + } + ], + +``` + +``` + }, + { + "in": "body", + "name": "PEEMEConfigurationData", + "description": "Configuration data.", + "schema": { + "$ref": "#/definitions/PEEMEConfiguration" + } + } + ], + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "$ref": "#/definitions/PEEMEConfiguration" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } +} +}, +"definitions": { + "PEEMEConfiguration": { + "type": "object", + "description": "Threshold values. Threshold monitoring is disabled for an attribute if the +threshold is empty or undefined.", + "properties": { + "powerMinThreshold": { + "type": "string", + "description": "Threshold value for minimum power usage" + }, + "powerMaxThreshold": { + "type": "string", + "description": "Threshold value for maximum power usage" + }, + "temperatureMinThreshold": { + "type": "string", + "description": "Threshold value for minimum temperature" + }, + "temperatureMaxThreshold": { + "type": "string", + "description": "Threshold value for maximum temperature" + }, + "voltageMinThreshold": { + "type": "string", + "description": "Threshold value for minimum voltage" + }, + "voltageMaxThreshold": { + "type": "string", + "description": "Threshold value for maximum voltage" + }, + "currentMinThreshold": { + "type": "string", + "description": "Threshold value for minimum current" + }, + "currentMaxThreshold": { + "type": "string", + "description": "Threshold value for maximum current" + }, + "humidityMinThreshold": { + "type": "string", + "description": "Threshold value for minimum humidity" + }, + "humidityMaxThreshold": { + "type": "string", + "description": "Threshold value for maximum humidity" + }, + "reportingURL": { + "type": "string", + "description": "The URL where notifications should be sent when any threshold is +reached or crossed" + } + } + } +} +``` + +``` + + } + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } +} +} + +``` + +#### B.3.11.4 OpenAPI definition "CMONOperations\_3.json" + +``` + +{ + "swagger": "2.0", + "info": { + "title": "CMONOperations_3 Interface", + "description": "PEE Performance Monitoring", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonoperations_3/v1", + "produces": [ + "application/json" + ], + "paths": { + "/cmonpmjobs": { + "get": { + "summary": "Read list of performance monitoring jobs", + "description": "Read a list of all performance monitoring jobs and their attributes.", + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cmonpmjobid": { + "type": "string", + "description": "The performance monitoring job ID." + }, + "CMONPMJobData": { + "$ref": "#/definitions/CMONPMJob" + } + } + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "post": { + "summary": "Create new performance monitoring job", + "description": "The client can use this method to create a new performance monitoring job.", + "parameters": [ + { + "in": "body", + "name": "CMONPMJobData", + "description": "Measurement configuration for CMON PM job.", + "schema": { + "$ref": "#/definitions/CMONPMJob" + } + } + ], + "responses": { + +``` + +``` + + "201": { + "description": "Created", + "headers": { + "Location": { + "description": "Link to new performance monitoring job", + "type": "string" + } + }, + "schema": { + "type": "object", + "properties": { + "cmonpmjobid": { + "type": "string", + "description": "The performance monitoring job ID." + }, + "CMONPMJobData": { + "$ref": "#/definitions/CMONPMJob" + } + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } +} +}, +"/cmonpmjobs/{CMONPMJobId}": { + "get": { + "summary": "Read a single performance monitoring job", + "description": "Read the value of all attributes of an individual performance monitoring +job.", + "parameters": [ + { + "in": "path", + "name": "CMONPMJobId", + "description": "Performance monitoring job ID", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was accepted and completed", + "schema": { + "type": "object", + "properties": { + "cmonpmjobid": { + "type": "string", + "description": "The performance monitoring job ID." + }, + "CMONPMJobData": { + "$ref": "#/definitions/CMONPMJob" + } + } + } + }, + "404": { + "description": "Invalid identifier" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "summary": "Delete a single performance monitoring job", + "description": "The client can use this method to delete a performance monitoring job.", + "parameters": [ + { + "in": "path", + "name": "CMONPMJobId", + +``` + +``` + "description": "Performance monitoring job ID", + "required": true, + "type": "string" + } +}, +"responses": { + "204": { + "description": "The resource was deleted" + }, + "404": { + "description": "Invalid identifier" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } +} +} +} +}, +"definitions": { + "CMONPMJob": { + "type": "object", + "properties": { + "meIdList": { + "type": "array", + "description": "List of monitored entities", + "items": { + "type": "string", + "description": "Identification of monitored entity." + } + }, + "measurementNames": { + "type": "array", + "description": "List of measurements", + "items": { + "type": "string", + "description": "Measurement name.", + "enum": [ + "powerAverage", + "powerMin", + "powerMax", + "energyConsumption", + "temperatureAverage", + "temperatureMin", + "voltageAverage", + "voltageMin", + "voltageMax", + "currentAverage", + "currentMin", + "currentMax", + "humidityAverage", + "humidityMin", + "humidityMax" + ] + } + }, + "granularityPeriod": { + "type": "integer", + "description": "The period (in minutes) between two successive measurements.", + "enum": [ 5, 15, 30, 60, 720, 1440 ] + }, + "reportingURL": { + "type": "string", + "description": "The URL where notifications should be sent." + } + } + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } +} +} +``` + +``` + } +} +``` + +#### B.3.11.5 OpenAPI definition "CMONNotifications\_1.json" + +``` +{ + "swagger": "2.0", + "info": { + "title": "CMONNotifications_1 Interface", + "description": "PEE Performance Measurement Reporting", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonnotifications_1/v1", + "produces": [ + "application/json" + ], + "paths": { + "/": { + "post": { + "summary": "New performance measurement report", + "description": "The client can use this method to submit a new performance measurement +report.", + "parameters": [ + { + "in": "body", + "name": "CMONPMReport", + "description": "Measurement report for CMON PM job.", + "schema": { + "$ref": "#/definitions/CMONPMReport" + } + } + ], + "responses": { + "204": { + "description": "Created" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "CMONPMReport": { + "type": "object", + "properties": { + "notificationHeader": { + "description": "Header information for the notification", + "properties": { + "notificationId": { + "type": "string", + "description": "Unique identifier of the notification" + } + }, + }, + "senderInfo": { + "description": "Information about the sender of the notification", + "properties": { + "senderName": { + "type": "string", + "description": "The name of the sender" + }, + "senderType": { + "type": "string", + "description": "The type of the sender" + }, + "vendorName": { + "type": "string", + "description": "The name of the vendor of the sender" + } + } + } + } + } + } +} +``` + +``` + } + } +}, +"measurementHeader": { + "description": "Header information for the measurement", + "properties": { + "measFormatVersion": { + "type": "string", + "description": "The format version of the measurement data collection" + }, + "collectionBeginTime": { + "type": "string", + "description": "The start of the measurement collection interval " + }, + "cmnopmjobid": { + "type": "string", + "description": "The performance monitoring job ID" + } + } +}, +"measurementData": { + "type": "array", + "items": { + "type": "object", + "properties": { + "meId": { + "type": "string", + "description": "Identification of monitored entity." + }, + "measurementInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/MeasurementInfo" + } + } + } + } +}, +"measurementFooter": { + "description": "Footer information for the measurement", + "properties": { + "collectionEndTime": { + "type": "string", + "description": "The end of the measurement collection interval" + } + } +} +} +}, +"MeasurementInfo": { + "type": "object", + "properties": { + "measurementName": { + "type": "string", + "description": "Measurement name.", + "enum": [ + "powerAverage", + "powerMin", + "powerMax", + "energyConsumption", + "temperatureAverage", + "temperatureMin", + "voltageAverage", + "voltageMin", + "voltageMax", + "currentAverage", + "currentMin", + "currentMax", + "humidityAverage", + "humidityMin", + "humidityMax" + ] + }, + "measurementValue": { + "type": "string", + "description": "Measurement value." + } + } +} +``` + +``` + + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } +} + +``` + +#### B.3.11.6 OpenAPI definition "CMONNotifications\_2.json" + +``` + +{ + "swagger": "2.0", + "info": { + "title": "CMONNotifications_2 Interface", + "description": "PEE Fault Reporting", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonnotifications_2/v1", + "produces": [ + "application/json" + ], + "paths": { + "/": { + "post": { + "summary": "New fault notification", + "description": "The client can use this method to submit a new fault report.", + "parameters": [ + { + "in": "body", + "name": "CMONAlarm", + "description": "Fault notification for CMON alarm.", + "schema": { + "$ref": "#/definitions/CMONAlarm" + } + } + ], + "responses": { + "204": { + "description": "Created" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "CMONAlarm": { + "type": "object", + "properties": { + "notificationHeader": { + "description": "Header information for the notification", + "properties": { + "notificationId": { + "type": "string", + "description": "Unique identifier of the notification" + } + }, + "senderInfo": { + "description": "Information about the sender of the notification", + "properties": { + "senderName": { + "type": "string", + "description": "The name of the sender" + }, + "senderType": { + +``` + +``` + + "type": "string", + "description": "The type of the sender" + }, + "vendorName": { + "type": "string", + "description": "The name of the vendor of the sender" + } + } + } +}, +"alarmInformation": { + "description": "Alarm details", + "properties": { + "alarmId": { + "type": "string", + "description": "The fault report ID" + }, + "alarmTime": { + "type": "string", + "description": "Time at which the alarm was raised" + }, + "alarmType": { + "type": "string", + "description": "See Event Types in TS 32.111-2 - Annex A" + }, + "perceivedSeverity": { + "type": "string", + "description": "Alarm severity, see ITU-T Recommendation X.733", + "enum": [ + "Critical", + "Major", + "Minor", + "Warning", + "Cleared" + ] + }, + "probableCause": { + "type": "string", + "description": "See Probable Causes in TS 32.111-2 - Annex B" + }, + "additionalText": { + "type": "string", + "description": "Further information on the alarm" + } + } +} +} +} +}, +"Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } +} +} +} +} +} + +``` + +#### B.3.11.7 OpenAPI definition "CMONNotifications\_3.json" + +``` + +{ + "swagger": "2.0", + "info": { + "title": "CMONNotifications_3 Interface", + "description": "PEE Configuration Change Reporting", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonnotifications_3/v1", + "produces": [ + "application/json" + ], +} + +``` + +``` + + "paths": { + "/": { + "post": { + "summary": "New configuration change notification", + "description": "The client can use this method to submit a new configuration change +report.", + "parameters": [ + { + "in": "body", + "name": "CMONConfigChange", + "description": "Configuration change notification.", + "schema": { + "$ref": "#/definitions/CMONConfigChange" + } + } + ], + "responses": { + "204": { + "description": "Created" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "CMONConfigChange": { + "type": "object", + "properties": { + "notificationHeader": { + "description": "Header information for the notification", + "properties": { + "notificationId": { + "type": "string", + "description": "Unique identifier of the notification" + }, + "senderInfo": { + "description": "Information about the sender of the notification", + "properties": { + "senderName": { + "type": "string", + "description": "The name of the sender" + }, + "senderType": { + "type": "string", + "description": "The type of the sender" + }, + "vendorName": { + "type": "string", + "description": "The name of the vendor of the sender" + } + } + } + } + }, + "configurationChangeInformation": { + "description": "Configuration change details", + "properties": { + "meId": { + "type": "string", + "description": "Monitored entity ID" + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attributeName": { + "type": "string", + "description": "Name of the PEEMEDescription attribute which has +changed", + "enum": [ + "siteIdentification", + +``` + +``` + + "siteLatitude", + "siteLongitude", + "siteDescription", + "equipmentType", + "environmentType", + "powerInterface", + "xcuDguDescription", + "sensorDescription", + "vSRmsDescription" + ] + }, + "attributeValue": { + "type": "string", + "description": "New value of the attribute" + } + } + } + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } +} + +``` + +#### B.3.11.8 OpenAPI definition "CMONNotifications\_4.json" + +``` + +{ + "swagger": "2.0", + "info": { + "title": "CMONNotifications_4 Interface", + "description": "PEE Threshold Reporting", + "version": "1.0.0" + }, + "host": "www.example.org", + "schemes": [ + "http", + "https" + ], + "basePath": "/cmonnotifications_4/v1", + "produces": [ + "application/json" + ], + "paths": { + "/": { + "post": { + "summary": "New threshold notification", + "description": "The client can use this method to submit a new threshold report.", + "parameters": [ + { + "in": "body", + "name": "CMONThreshold", + "description": "Threshold notification.", + "schema": { + "$ref": "#/definitions/CMONThreshold" + } + } + ], + "responses": { + "204": { + "description": "Created" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + } +} + +``` + +``` + + } + }, + "definitions": { + "CMONThreshold": { + "type": "object", + "properties": { + "notificationHeader": { + "description": "Header information for the notification", + "properties": { + "notificationId": { + "type": "string", + "description": "Unique identifier of the notification" + }, + "senderInfo": { + "description": "Information about the sender of the notification", + "properties": { + "senderName": { + "type": "string", + "description": "The name of the sender" + }, + "senderType": { + "type": "string", + "description": "The type of the sender" + }, + "vendorName": { + "type": "string", + "description": "The name of the vendor of the sender" + } + } + } + } + }, + "thresholdEventInformation": { + "description": "Threshold event details", + "properties": { + "meId": { + "type": "string", + "description": "Monitored entity ID" + }, + "thresholdInfo": { + "description": "Threshold event details", + "properties": { + "thresholdName": { + "type": "string", + "description": "Name of the threshold which has been reached or crossed", + "enum": [ + "powerMinThreshold", + "powerMaxThreshold", + "temperatureMinThreshold", + "temperatureMaxThreshold", + "voltageMinThreshold", + "voltageMaxThreshold", + "currentMinThreshold", + "currentMaxThreshold", + "humidityMinThreshold", + "humidityMaxThreshold" + ] + }, + "thresholdValue": { + "type": "string", + "description": "Configured threshold value" + }, + "observedValue": { + "type": "string", + "description": "Actual value of the attribute" + } + } + } + } + } + } + } + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } +} + +``` + +... A - E +    } +    } +} +} + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|-----------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-03 | SA#79 | SP-180073 | | | | Presented for approval | 2.0.0 | +| 2018-03 | SA#79 | | | | | Upgrade to change control version | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28307/raw.md b/marked/Rel-16/28_series/28307/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..06bb581e6e84121a3425f3598dba7829115ea9ad --- /dev/null +++ b/marked/Rel-16/28_series/28307/raw.md @@ -0,0 +1,288 @@ + + +# 3GPP TS 28.307 V16.0.0 (2020-07) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. Below the "P" is a red signal icon. Underneath the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 Concepts and background ..... | 7 | +| 5 Business Level Requirements ..... | 7 | +| 6 Specification level requirements..... | 7 | +| 6.1 Requirements..... | 7 | +| 6.2 Actor roles..... | 7 | +| 6.3 Telecommunication resources..... | 7 | +| 6.4 Use cases ..... | 8 | +| 6.4.1 Activate collection measurement job for an area in UTRAN ..... | 8 | +| 6.4.2 De-activate collection measurement job in UTRAN..... | 8 | +| Annex A (informative): Change history..... | 9 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 +- 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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +## **TS 28.307: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements** + +TS 28.308: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS) + +TS 28.309: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Solution Set (SS) definitions + +One main motivation of mobile network evolution is to improve the user experience why the evaluation at the UE side is vital to network operators, especially when the operators provide some real-time services which require for example high data rate and low latency like streaming services (typically video services). + +Quality of Experience (QoE) information collection provides detailed information at session level on a number of UEs. + +The operator can initiate logging of QoE information of an end user service. The collected information (specified in 3GPP TS 26.247 [2]) cannot be deduced from performance measurements in the mobile network. + +The QoE information is information collected by the end user application in the UE. + +The QoE information is collected by the management system (e.g. an Operations System (OS) in TMN terminology) for analysis and/or KPI calculations. + +# 1 Scope + +The present document addresses Integration Reference Point (IRP) requirements for the function Quality of Experience (QoE) measurement collection in UMTS and LTE. The measurements that are collected are DASH [2] and MTSI [5] measurements. + +The function includes collecting QoE information from UEs frequenting a specified area. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [3] 3GPP TS 28.404: "Telecommunication management; Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements". +- [4] 3GPP TS 25.331: "Radio Resource Control (RRC); Protocol specification". +- [5] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +NRS Network Request Session +NOTE: See TS 28.404 [3]. + +RECS RECORDing Session +NOTE: See 3GPP TS 28.404 [3]. + +UERS UE Request Session +NOTE: See 3GPP TS 28.404 [3]. + +# 4 Concepts and background + +The collection of QoE information for a specified end user service/end user service type either from UEs in a specified area. The collected information is transported to a collection centre, where it can be analysed and/or KPIs can be calculated. + +A collection can be requested by an operator technician via the management system to the traffic network. As the network do not have any knowledge which UEs have the capability to record the requested data, therefore the UEs will report whether they have this capability or not when a session set up. UEs that has this capability that match the request from the management system will be requested to start recording the requested information when the request constraints are met. The UE will make the recorded data available for management system. + +# 5 Business Level Requirements + +See business level requirements in 3GPP TS 28.404 [3]. + +# 6 Specification level requirements + +## 6.1 Requirements + +**REQ-EUSPC-FUN-1:** The IRPManager shall have a capability to request collection of QoE information per end user service/end user service type for a specified area. + +**REQ-EUSPC-FUN-2:** The IRPManager shall have a capability to request the collection of QoE information to be stopped before the time for the NRS has expired. + +**REQ-EUSPC-FUN-3:** The IRPAgent shall have a capability to notify the IRPManager when a collection of QoE information has been stopped before the time for the NRS has expired. + +## 6.2 Actor roles + +Please see respective use case. + +## 6.3 Telecommunication resources + +Please see respective use case. + +## 6.4 Use cases + +### 6.4.1 Activate collection measurement job for an area in UTRAN + +**Table 6.4.1-1: Activate collection measurement job for an area** + +| Use case stage | Evolution/Specification | <>
Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To start collecting QoE information for an end user service type in a specified area. | | +| Actors and roles | IRPManager: Request the start of collection of QoE information. | | +| Telecom resources | The RNC and the UE | | +| Assumptions | There are UEs that has the capability to provide the requested information in the specified area. | | +| Pre-conditions | None. | | +| Begins when | The IRPManager requests that a NRS shall be started. | | +| Step 1(M) | An IRPAgent receives the request and forwards it to the appropriate RNC(s). | | +| Step 2 (M) | The RNC starts a NRS for the specified area and start checking for UEs that supports QoE information collection. | | +| Step 3 (M) | For UEs that support QoE information collection, the RNC starts a UERS and forwards the request of collection QoE information to the UE. See ref. 3GPP TS 25.331 [4]. | | +| Step 4 (M) | When the requested end user service is started in the UE, it starts a RECS and records the requested information. | | +| Step 5 (M) | The UE reports the recorded information to a collection centre via the RNC as long as the end user service session is active during the time for the NRS. | | +| Step 6 (M) | When the end user service session ends the UE stops the RECS and reports the collected data to a collection centre via the RNC. | | +| Ends when | When the time for the NRS elapses or when the IRPManager sends a request for de-activation. | | +| Exceptions | | | +| Post-conditions | None. | | +| Traceability | REQ-EUSPC-FUN-1. | | +| NOTE: | Steps 4, 5 and 6 are repeated in a NRS for every time a session that starts the requested end user service in the UE. | | + +NOTE: A similar use case is valid for LTE. + +### 6.4.2 De-activate collection measurement job in UTRAN + +**Table 6.4.2-1: De-activate collection measurement job** + +| Use case stage | Evolution/Specification | <>
Related use | +|-------------------|---------------------------------------------------------------------------------------------|-------------------------| +| Goal | To stop collecting more QoE information for an NRS before the time for the NRS has expired. | | +| Actors and roles | IRPManager: Request to stop the collection of QoE information. | | +| Telecom resources | The RAN node, HSS and the UE | | +| Assumptions | None. | | +| Pre-conditions | A NRS is started. | | +| Begins when | The IRPManager requests that a NRS shall be stopped. | | +| Step 1 (M) | An IRPAgent receives the request and forwards it to the RNC or the HSS. | | +| Step 2 (O) | The HSS transfers the request to the RNC via the SGSN. | | +| Step 3 (M) | The RNC node stops the NRS and informs the UE to not start new RECS. | | +| Step 4 (O) | The RNC node informs HSS, via SGSN, that the NRS is stopped. | | +| Step 5 (O) | The HSS stops the NRS. | | +| Ends when | When the IRP Manager receives the notification that the NRS is stopped. | | +| Exceptions | None. | | +| Post-conditions | None. | | +| Traceability | REQ-EUSPC-FUN-3 and REQ-EUSPC-FUN-4. | | + +NOTE: A similar use case is valid for LTE. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|----|---------|-----|------------------------------------------------------------------------------------------------------------|----------------| +| Date | Meeting | TDoc | CR | Re
v | Cat | Subject/Comment | New
version | +| 2017-10 | SA5#115 | S5-175398 | | | | R15 pCR 28.307-000 Introduction and Scope for QoE IRP requirements | 0.1.0 | +| 2017-10 | SA5#115 | S5-175399 | | | | R15 pCR 28.307-000 Introduction of specification level use cases and requirements for QoE IRP requirements | 0.1.0 | +| 2019-01 | Sa5#123 | S5-191296 | | | | Including DASH and MTSI in Scope | 0.2.0 | +| 2019-01 | Sa5#123 | S5-191297 | | | | Restrict to UMTS and LTE | 0.2.0 | +| 2020-03 | SA5#129e | S5-201388 | | | | Rapporteur's clean up (using new TS template) | 0.3.0 | +| 2020-03 | SA5#129e | S5-201394 | | | | Remove SBA | 0.3.0 | +| 2020-03 | SA5#129e | | | | | EditHelp review | 0.4.0 | +| 2020-06 | | | | | | EditHelp review (editorial changes only) | 0.4.1 | +| 2020-06 | SA#88e | SP-200474 | | | | Presented for information and approval | 1.0.0 | +| 2020-07 | SA#88e | | | | | Upgrade to change control version | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28308/raw.md b/marked/Rel-16/28_series/28308/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e0d09477bd739732cfd1fbb51bd09f4df9fe0cd2 --- /dev/null +++ b/marked/Rel-16/28_series/28308/raw.md @@ -0,0 +1,738 @@ + + +# 3GPP TS 28.308 V16.0.0 (2020-07) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS) (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, sans-serif font. Below the "G" and "P" are three red curved lines representing signal waves. + +3GPP logo + +A GLOBAL INITIATIVE + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 System Overview ..... | 7 | +| 4.1 System context ..... | 7 | +| 4.2 Compliance rules..... | 7 | +| 5 Information Object Classes..... | 8 | +| 5.1 Imported and associated information entities..... | 8 | +| 5.1 Imported information entities and local labels ..... | 8 | +| 5.2 Class diagram..... | 9 | +| 5.2.1 Relationships ..... | 9 | +| 5.2.2 Inheritance ..... | 9 | +| 5.3 Class definitions ..... | 9 | +| 5.3.1 QMCJob..... | 9 | +| 5.3.1.1 Definition ..... | 9 | +| 5.3.1.2 Attributes ..... | 10 | +| 5.3.1.3 Attribute constraints..... | 10 | +| 5.3.1.4 Notifications..... | 10 | +| 5.3.1.5 State diagram ..... | 10 | +| 5.3.2 QMCRecord..... | 10 | +| 5.3.2.1 Definition..... | 10 | +| 5.3.2.2 Attributes ..... | 10 | +| 5.3.3 QMCIRP..... | 10 | +| 5.3.3.1 Definition ..... | 10 | +| 5.3.4 ManagedEntity..... | 10 | +| 5.3.4.1 Definition ..... | 10 | +| 5.4 Information relationship definitions..... | 11 | +| 5.4.1 relation-qMCIRP-qMCJob (M)..... | 11 | +| 5.4.1.1 Definition ..... | 11 | +| 5.4.1.2 Roles ..... | 11 | +| 5.4.2 relation-qMCJob-managedEntity (M) ..... | 11 | +| 5.4.2.1 Definition ..... | 11 | +| 5.4.2.2 Roles ..... | 11 | +| 5.4.3 relation-qMCJob-qMCRecord (M)..... | 11 | +| 5.4.3.1 Definition ..... | 11 | +| 5.4.3.2 Roles ..... | 11 | +| 5.5 Attribute definitions ..... | 12 | +| 5.5.1 Attribute properties..... | 12 | +| 6 Interface Definition ..... | 13 | +| 6.1 Class diagram representing interfaces..... | 13 | +| 6.2 Generic rules ..... | 13 | +| 6.3 QoEIRPManagement Interface (M)..... | 14 | +| 6.3.1 Operation activateAreaQMCJob (M)..... | 14 | +| 6.3.1.1 Definition ..... | 14 | +| 6.3.1.2 Input parameters ..... | 14 | +| 6.3.1.3 Output parameters..... | 14 | +| 6.3.1.4 Pre-condition..... | 15 | +| 6.3.1.5 Post-condition ..... | 15 | +| 6.3.1.6 Exceptions..... | 15 | +| 6.3.1.6.1 notuniqueQoEReference..... | 15 | + +| | | | +|------------------------|-----------------------------------------------------------|----| +| 6.3.2 | Operation deactivateQMCJob (M) ..... | 15 | +| 6.3.2.1 | Definition ..... | 15 | +| 6.3.2.2 | Input parameters ..... | 15 | +| 6.3.2.3 | Output parameters ..... | 15 | +| 6.3.2.4 | Pre-condition ..... | 16 | +| 6.3.2.5 | Post-condition ..... | 16 | +| 6.3.2.6 | Exceptions ..... | 16 | +| 6.3.3 | Operation listQMCJob (M) ..... | 16 | +| 6.3.3.1 | Definition ..... | 16 | +| 6.3.3.2 | Input parameters ..... | 16 | +| 6.3.3.3 | Output parameters ..... | 16 | +| 6.3.3.4 | Pre-condition ..... | 17 | +| 6.3.3.5 | Post-condition ..... | 17 | +| 6.3.3.6 | Exceptions ..... | 17 | +| 6.3.4 | Operation listActivatedQMCJobs (M) ..... | 17 | +| 6.3.4.1 | Definition ..... | 17 | +| 6.3.4.2 | Input parameters ..... | 17 | +| 6.3.4.3 | Output parameters ..... | 17 | +| 6.3.5 | Notification notifyNetworkRequestSessionFailure (O) ..... | 18 | +| 6.3.5.1 | Definition ..... | 18 | +| 6.3.5.2 | Input parameters ..... | 18 | +| 6.3.5.3 | Triggering event ..... | 18 | +| 6.3.5.3.1 | From state ..... | 18 | +| 6.3.5.3.2 | To state ..... | 18 | +| Annex A (informative): | Change history ..... | 19 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 28.307: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements + +**TS 28.308: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS)** + +TS 28.309: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Solution Set (SS) definitions + +One main motivation of mobile network evolution is to improve the user experience why the evaluation at the UE side is vital to network operators, especially when the operators provide some real-time services which require for example high data rate and low latency like streaming services (typically video services). + +Quality of Experience (QoE) information collection provides detailed information at session level on a number of UEs. + +The operator can initiate logging of QoE information of an end user service. The collected information (specified in Reference 3GPP TS 26.247 [4]) cannot be deduced from performance measurements in the mobile network. + +The QoE information is information collected by the end user application in the UE. + +The collected QoE information is collected by the management system (e.g. an Operations System (OS) in TMN terminology) for analysis and/or KPI calculations. + +# 1 Scope + +The present document addresses the operations and notifications for the function Quality of Experience (QoE) measurement collection in UMTS and LTE. The measurements that are collected are DASH [4] and MTSI [9] measurements. + +The function includes collecting QoE information from UEs frequenting a specified area. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [3] 3GPP TS 28.307: "Telecommunication management; Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements". +- [4] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [5] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Information Service (IS)". +- [8] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [10] 3GPP TS 28.404: "Telecommunication management; Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements". +- [11] 3GPP TS 28.307: "Telecommunication management; Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements". +- [12] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)". +- [13] 3GPP TS 32.156: "Integration Reference Point (IRP) Information Service (IS) template". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in TR 21.905 [1] and TS 32.150 [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] and TS 32.150 [2]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|-----|----------------------------| +| QoE | Quality of Experience | +| QMC | QoE Measurement Collection | + +# 4 System Overview + +## 4.1 System context + +The general definition of the System Context for the present IRP is found in TS 32.150 [2] clause 4.7. + +In addition, the set of related IRP(s) relevant to the present IRP is shown in the two diagrams below. + +![Figure 4.1.1: System Context A. A diagram showing the relationship between an IRPManager (NM) and an IRPAgent (EM). The IRPManager is connected to the IRPAgent via a solid line. The IRPAgent is connected to multiple NEs via a dotted line. A dashed vertical line separates the NM and EM domains. An arrow labeled 'Itf-N' points from the QoE Measurement Collection IRP to the IRPAgent.](ef7a88e04d1939ee09bafd5c3072adf8_img.jpg) + +The diagram illustrates the system context for the IRP. On the left, a box labeled 'NM' contains 'IRPManager'. On the right, a box labeled 'EM' contains 'IRPAgent'. A solid horizontal line connects 'IRPManager' and 'IRPAgent'. To the right of 'IRPAgent', a dotted line connects it to a box labeled 'NEs'. A dashed vertical line runs between the 'NM' and 'EM' boxes. Below the 'EM' box, an arrow labeled 'Itf-N' points from a vertical line labeled 'QoE Measurement Collection IRP' to the 'IRPAgent'. + +Figure 4.1.1: System Context A. A diagram showing the relationship between an IRPManager (NM) and an IRPAgent (EM). The IRPManager is connected to the IRPAgent via a solid line. The IRPAgent is connected to multiple NEs via a dotted line. A dashed vertical line separates the NM and EM domains. An arrow labeled 'Itf-N' points from the QoE Measurement Collection IRP to the IRPAgent. + +Figure 4.1.1: System Context A + +![Figure 4.1.2: System Context B. A diagram showing the relationship between an IRPManager (NM) and an IRPAgent (NE). The IRPManager is connected to the IRPAgent via a solid line. A dashed vertical line separates the NM and NE domains. An arrow labeled 'Itf-N' points from the QoE Measurement Collection IRP to the IRPAgent.](6f119d066b5e51370df585ce69c94fb4_img.jpg) + +The diagram illustrates the system context for the IRP. On the left, a box labeled 'NM' contains 'IRPManager'. On the right, a box labeled 'NE' contains 'IRPAgent'. A solid horizontal line connects 'IRPManager' and 'IRPAgent'. A dashed vertical line runs between the 'NM' and 'NE' boxes. Below the 'NE' box, an arrow labeled 'Itf-N' points from a vertical line labeled 'QoE Measurement Collection IRP' to the 'IRPAgent'. + +Figure 4.1.2: System Context B. A diagram showing the relationship between an IRPManager (NM) and an IRPAgent (NE). The IRPManager is connected to the IRPAgent via a solid line. A dashed vertical line separates the NM and NE domains. An arrow labeled 'Itf-N' points from the QoE Measurement Collection IRP to the IRPAgent. + +Figure 4.1.2: System Context B + +## 4.2 Compliance rules + +For general definitions of compliance rules related to qualifiers (Mandatory/Optional/Conditional) for *operations, notifications and parameters* (of operations and notifications) please refer to TS 32.150 [2]. + +# 5 Information Object Classes + +## 5.1 Imported and associated information entities + +## 5.1 Imported information entities and local labels + +| Label reference | Local label | +|----------------------------------------------------------|-----------------| +| TS 28.622 [5], information object class, Top | Top | +| TS 28.622 [5], information object class, IRPAGENT | IRPAGENT | +| TS 28.622 [5], information object class, GenericIRP | GenericIRP | +| TS 32.302 [6], information object class, NotificationIRP | NotificationIRP | +| TS 32.342 [7], information object class, FileTransferIRP | FileTransferIRP | +| TS 32.602 [8], information object class, ManagedEntity | ManagedEntity | + +## 5.2 Class diagram + +### 5.2.1 Relationships + +![UML Class diagram showing relationships between ManagedGenericIRP, QMCIRP, QMCRecord, QMJob, and ManagedEntity.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +classDiagram + class ManagedGenericIRP["«InformationObjectClass»\nManagedGenericIRP"] + class QMCIRP["«InformationObjectClass»\nQMCIRP"] + class QMCRecord["«InformationObjectClass»\nQMCRecord"] + class QMJob["«InformationObjectClass»\nQMJob"] + class ManagedEntity["«ProxyClass»\nManagedEntity"] + + ManagedGenericIRP <|-- QMCIRP + QMCIRP "1" o-- "0..n" QMJob : relation-QMCIRP-QMJob + QMCRecord "0..n" o-- QMJob : relation-QMCJob-QMCRecord + QMJob "1" o-- "1..n" ManagedEntity : relation-QMCJob-managedEntity + +``` + +UML Class diagram showing relationships between ManagedGenericIRP, QMCIRP, QMCRecord, QMJob, and ManagedEntity. + +Figure 5.2.1.1 + +### 5.2.2 Inheritance + +![UML Class diagram showing inheritance relationships between Top, ManagedGenericIRP, QMJob, QMCRecord, and QMCIRP.](5a24ac755b962fd5f0183f13de0726de_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass»\nTop"] + class ManagedGenericIRP["«InformationObjectClass»\nManagedGenericIRP"] + class QMJob["«InformationObjectClass»\nQMJob"] + class QMCRecord["«InformationObjectClass»\nQMCRecord"] + class QMCIRP["«InformationObjectClass»\nQMCIRP"] + + QMJob <|-- Top + QMCRecord <|-- Top + QMCIRP <|-- ManagedGenericIRP + +``` + +UML Class diagram showing inheritance relationships between Top, ManagedGenericIRP, QMJob, QMCRecord, and QMCIRP. + +Figure 5.2.2.1 + +## 5.3 Class definitions + +### 5.3.1 QMCJob + +#### 5.3.1.1 Definition + +It represents a task that controls the QMC and collects data from the applications in the UE (i.e. collects the QMCReportContainer of multiple ManagedEntity instances). The QoEReference is a unique ID, which identifies the network request session that has been created by the QMCJob and activated to one or multiple ManagedEntity instance(s). + +When a QMCJob is created, none of attributes be modified via the Itf-N: + +- If for any reason the QMCIRP determines that a QMC session has been activated in its ManagedEntity(ies) the QMCIRP shall emit the "notifyQMCSessionLocalActivation" notification to the subscribed IRPManagers to inform the active QMC Sessions. The IRPManagers can decide whether they deactivate the QMC session or keep the QMC session active. (E.g. if the QoEReference is colliding with an existing QMCJob's QoEReference, the IRPManager may decide to immediately deactivate the QMC session in that ManagedEntity.) + +The QMCJob shall use its information to activate and configure QMC session(s) in the requested ManagedEntity instance(s). When the QMCIRP determines that there are available QMCReport files, it shall emit a notification to all subscribed IRPManagers informing the availability of the files. The method and the notification of the available files is described in the File Transfer IRP (TS 32.342 [7]). + +- If a QMCJob receives an indication from one of its ManagedEntity that starting a network request session is failed for any reason, the "notifyNetworkRequestSessionFailure" notification may be emitted to inform all subscribed IRPManagers that there was a network request session that was not started in the ManagedEntity. + +| Referenced TS | Requirement label | Comment | +|----------------|-------------------|---------| +| TS 28.404 [10] | REQ-EUSPC-CON-1 | | +| TS 28.404 [10] | REQ-EUSPC-CON-4 | | +| TS 28.404 [10] | REQ-EUSPC-CON-5 | | +| TS 28.307 [11] | REQ-EUSPC-FUN-1 | | +| TS 28.307 [11] | REQ-EUSPC-FUN-2 | | + +#### 5.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------|-------------------|------------|------------|-------------|--------------| +| serviceType | M | T | T | T | F | +| areaScope | M | T | T | T | F | +| qoECollectionEntityAddress | M | T | T | T | F | +| pLMNTarget | M | T | T | T | F | +| qMCTarget | M | T | T | T | F | +| qoEReference | M | T | T | T | F | +| qMCConfigurationFile | M | T | T | T | F | + +#### 5.3.1.3 Attribute constraints + +None. + +#### 5.3.1.4 Notifications + +The common notifications defined in clause 5.5 are valid for this IOC, without exceptions or additions. + +#### 5.3.1.5 State diagram + +None. + +### 5.3.2 QMCRecord + +#### 5.3.2.1 Definition + +TQMCRecord is the representation of the files containing the information from the network request session. + +#### 5.3.2.2 Attributes + +| Attribute name | Visibility | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------|------------|-------------------|----------------|-----------------| +| fileName | + | M | M | - | + +### 5.3.3 QMCIRP + +#### 5.3.3.1 Definition + +QMCIRP is the representation of the QMC management capabilities specified by the present document. This IOC inherits from ManagedGenericIRP IOC specified in TS 32.312 [12]. + +### 5.3.4 ManagedEntity + +#### 5.3.4.1 Definition + +For area based QMC the ManagedEntity represents the role that can be played by an instance of the following IOCs: + +- UtranCell +- E-UtranCell + +## 5.4 Information relationship definitions + +### 5.4.1 relation-qMCIRP-qMCJob (M) + +#### 5.4.1.1 Definition + +This represents the relationship between QMCIRP and the QMCJob. + +#### 5.4.1.2 Roles + +| Name | Definition | +|---------------|------------------------------| +| theQMCIRP | It represents the QMCIRP | +| theQMCJobList | It represents the QMCJobList | + +### 5.4.2 relation-qMCJob-managedEntity (M) + +#### 5.4.2.1 Definition + +This represents the relationship between QMCJob and the ManagedEntity. + +#### 5.4.2.2 Roles + +| Name | Definition | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| theManagedEntity | The ManagedEntity, when playing this role, represents the actual network resource instance, where a network request session is activated. | +| theQMCJob | It represents the QMCJob | + +### 5.4.3 relation-qMCJob-qMCRecord (M) + +#### 5.4.3.1 Definition + +This represents the relationship between QMCJob and the QMCRecord. + +#### 5.4.3.2 Roles + +| Name | Definition | +|--------------|------------------------------| +| theQMCJob | It represents the QMCJob | +| theQMCRecord | It represents the QMCRecord. | + +## 5.5 Attribute definitions + +### 5.5.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| serviceType | It identifies an individual UE for a specified end user service/end user service type.

allowedValues: DASH (0), MTSI (1) | type: Integer
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | +| areaScope | The area scope parameter defines the area in terms of cells or Tracking Area/Routing Area/Location Area where the QMC shall take place.

allowedValues:
The area scope parameter in UMTS is either:
  • - List of cells, identified by CGI. Maximum 32 CGI can be defined.
  • - List of Routing Area, identified by RAI. Maximum of 8 RAIs can be defined.
  • - List of Location Area, identified by LAI. Maximum of 8 LAIs can be defined.
The area scope parameter in LTE is either:
  • - list of cells, identified by E-UTRAN-CGI. Maximum 32 CGI can be defined.
  • - List of Tracking Area, identified by TAC. Maximum of 8 TAC can be defined.
| type: String
multiplicity: 1..*
isOrdered: N/A
isUnique: True
defaultValue: None
isNullable: False | +| goECollectionEntityAddress | It indicates the IP address to which the QMC records shall be transferred. Ipv4 or Ipv6 address(es) may be used.
allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | +| pLMNTarget | This parameter defines the PLMN for which sessions shall be selected in the network request session in case of area based QMC when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Furthermore, several PLMNs can be used for not shared RAN cases as well as for shared RAN cases.). Only the sessions may be selected where the PLMN that the UE reports as selected PLMN is the same as the PLMN Target.

Note that the PLMN Target might differ from the PLMN specified in the Network Request Session Id, as that specifies the PLMN that is containing the management system requesting the network request session from the NE. | type: PLMNId
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | +| qMCtarget | The QMC target parameter specifies it the QMC is area based or individual UE based.

  • - Area based QMC (0)
| type: Integer
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| | NOTE: Individual UE based QMC is not supported in this release.

allowedValues: ... | | +| qoEReference | The QoE reference parameter specify the network request session. The QoE reference shall be globally unique therefore it is composed as follows:

MCC+MNC+QMC ID, where the MCC and MNC are coming with the QMC activation request from the management system to identify one PLMN containing the management system, and QMC ID is a 3 byte Octet String.

The QMC ID is generated by the management system or the operator.

It is used to identify the QoE measurement collection job in the traffic nodes and in the measurement collection centre. | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | +| qMCConfigurationFile | The QMC configuration file is a container that is specified in TS 26.247 and TS 26.114
allowedValues: N/A | type: String
multiplicity: 1
isOrdered: N/A
isUnique: N/A
defaultValue: None
isNullable: False | + +# --- 6 Interface Definition + +## 6.1 Class diagram representing interfaces + +Each interface is defined in one or more UML compliant class diagrams (see also TS 32.156 [13]). + +## 6.2 Generic rules + +Rule 1: each operation with at least one input parameter supports a pre-condition `valid_input_parameter` which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception `operation_failed_invalid_input_parameter` which is raised when pre-condition `valid_input_parameter` is false. The exception has the same entry and exit state. + +Rule 2: Each operation with at least one optional input parameter supports a set of pre-conditions `supported_optional_input_parameter_yyy` where "yyy" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception `operation_failed_unsupported_optional_input_parameter_yyy` which is raised when (a) the pre-condition `supported_optional_input_parameter_yyy` is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state. + +Rule 3: each operation shall support a generic exception `operation_failed_internal_problem` which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state. + +NOTE: These rules are mapped at the solution set level. Pre-conditions and exceptions, generated by these rules, need not appear explicitly in the present document. + +## 6.3 QoEIRPManagement Interface (M) + +### 6.3.1 Operation activateAreaQMCJob (M) + +#### 6.3.1.1 Definition + +This operation support IRPManager's request to create an AreaQMCJob through Itf-N. + +Once the AreaQMCJob has been created, the attributes of the QMCJob will not be modified during the lifetime of the QMCJob. + +One QMCJob can manage network request sessions in one or more ManagedEntity. + +| Referenced TS | Requirement label | Comment | +|---------------|-------------------|---------| +| TS 28.307 [3] | REQ-EUSPC-FUN-1 | | + +#### 6.3.1.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|----------------------------|-----------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| iOCInstance | M | ManagedEntity.objectInstance | It specifies the DN of ManagedEntity instance where QMC session is to be activated. | +| qoEReference | M | QMCJob.qoeReference | It identifies the QMC Session. | +| qMCTarget | M | QMCJob.qMCTarget | It specifies if the QMC is areabased or individual UE based. In the present release only area based is supported. | +| qoECollectionEntityAddress | M | QMCJob.qoECollectionEntityAddress | It specifies the address to the QoE Collection Entity that is associated to the QMCJob. See TS 32.422 [9]. | +| serviceType | M | QMCJob.serviceType | It specifies which service is to record information. | +| areaScope | M | QMCJob.areaScope | It specifies the area (Cells/TA/RA/LA) where the QoE measurements shall be collected. | +| pLMNTarget | CM | QMCJob.pLMNTarget | It specifies which PLMN that the subscriber of the session to be recorded uses as selected PLMN. | +| qMCConfigurationFile | M | QMCJob.qMCConfiguration.File | It specifies the configuration of the QoE measurement to be recorded. See TS 26.247 [4] for DASH and TS 26.114 [9] for MTSI. | + +#### 6.3.1.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|-----------------|-----------|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| status | M | ENUM (Success, Failure, PartialSuccess) | | +| unsupportedList | M | List of | It specifies what attributes are not supported when a QMC session is activated. The list can contain one or all of the elements and relevant only for error cases. | + +#### 6.3.1.4 Pre-condition + +validQoEReference + +| Assertion Name | Definition | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| validQoEReference | The qoEReference input parameter is valid, which means that the QM CIRP is aware of such QMCJob , which has this qoEReference value and is aware of the ManagedEntity holding such network request session. | + +#### 6.3.1.5 Post-condition + +networkRequestSessionisactivated + +| Assertion Name | Definition | +|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| networkRequestSessionisactivated | The network request session identified by the qoEReference is activated in the requested ManagedEntity instance and the QMCJob is started. | + +#### 6.3.1.6 Exceptions + +##### 6.3.1.6.1 notuniqueQoEReference + +| Exception Name | Definition | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notuniqueQoEReference | Condition: ( validqoEReference ) is false.
Returned Information: output parameter status is set to "Failure".
Exit state: Entry State. | + +### 6.3.2 Operation deactivateQMCJob (M) + +#### 6.3.2.1 Definition + +This operation supports `IPRManager`'s request to stop a `QMCJob` through `Itf-N`. When this operation is received in the requested `ManagedEntity` instances the network request session shall be deactivated. + +| Referenced TS | Requirement label | Comment | +|---------------|-------------------|---------| +| TS 28.307 [3] | REQ-EUSPC-FUN-3 | | + +#### 6.3.2.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|---------------------------|-----------|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| iOCInstance | M | ManagedEntity.objectInstance | It specifies the DN of ManagedEntity instance where QMC session is to be deactivated. | +| qoEReference | M | QMCJob.qoEReference | It identifies the QMC Session. | +| qMCTarget | M | QMCJob.qMCTarget | It specifies if the QMC is area based or individual UE based. In the present release only area based is supported. | + +#### 6.3.2.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|-----------------|-----------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| status | M | ENUM (Success, Failure, PartialSuccess) | The operation may fail because of a specified or an unspecified reason. | +| unsupportedList | M | List of | It specifies what attributes are not supported when a QMC session is activated. The list can contain one or all of the elements and relevant only for error cases. | + +#### 6.3.2.4 Pre-condition + +validQoEReference + +| Assertion Name | Definition | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| validQoEReference | The qoEReference input parameter is valid, which means that the QMCIRP is aware of such QMCJob, which has this qoEReference value and is aware of the ManagedEntity holding such network request session. | + +#### 6.3.2.5 Post-condition + +networkRequestSessionisdeactivated + +| Assertion Name | Definition | +|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| networkRequestSessionisdeactivated | The network request session identified by the qoEReference is deactivated in the requested ManagedEntity instance and the QMCJob is stopped. | + +#### 6.3.2.6 Exceptions + +| Exception Name | Definition | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notuniqueQoEReference | Condition: (validQoEReference) is false.
Returned Information: output parameter status is set to "Failure".
Exit state: Entry State. | + +### 6.3.3 Operation listQMCJob (M) + +#### 6.3.3.1 Definition + +This operation support IPRManager's request to list the parameters of a specific QMCJob through Itf-N. + +#### 6.3.3.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|----------------|-----------|---------------------|-------------------------------------------------------------------------------| +| qoEReference | M | QMCJob.qoEReference | It specifies the network request session that is requested for interrogation. | + +#### 6.3.3.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------------------|-----------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| iOCInstance | M | ManagedElement.objectInstance | It specifies the DN of ManagedElement instance where a network request session is requested to be listed. | +| Status | M | ENUM (Success, Failure) | The operation may fail because of a specified or an unspecified reason. | +| qoEReference | M | QMCJob.qoEReference | It identifies the network request session. | +| qMCTarget | M | QMCJob.qMCTarget | It specifies if the QMC is area based or individual UE based. In the present release only area based is supported. | +| qoECollectionEntityAddress | M | QMCJob.qoECollectionEntityAddress | It specifies the address to the QoE Collection Entity that is associated to the QMCJob. See TS 32.422 [9]. | +| serviceType | M | QMCJob.serviceType | It specifies which service is to record information. | +| areaScope | M | QMCJob.areaScope | It specifies the area (Cells/TA/RA/LA) in which the QMC is to be performed. | +| pLMNTarget | CM | QMCJob.pLMNTarget | It specifies which PLMN that the subscriber of the session to be recorded uses as selected PLMN. | +| qMCConfigurationFile | M | QMCJob.qMCConfiguration.File | It specifies the configuration of the QoE measurement to be recorded. See TS 26.247 [4] for DASH and TS 26.114 [9] for MTSI. | + +#### 6.3.3.4 Pre-condition + +validQoEReference + +| Assertion Name | Definition | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| validQoEReference | The qoEReference input parameter is valid, which means that the QMCIRP is aware of such QMCJob, which has this qoEReference value and is aware of the ManagedEntity holding such network request session. | + +#### 6.3.3.5 Post-condition + +qoEReferenceFound + +| Assertion Name | Definition | +|-------------------|---------------------------------------------------------------------------------------------------------| +| qoEReferenceFound | The QMCIRP has found the requested QMCJob with the qoEReference and can read the configured parameters. | + +#### 6.3.3.6 Exceptions + +| Exception Name | Definition | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notuniqueQoEReference | Condition: (validQoEReference) is false.
Returned Information: output parameter status is set to "Failure".
Exit state: Entry State. | + +### 6.3.4 Operation listActivatedQMCJobs (M) + +#### 6.3.4.1 Definition + +This operation support IRPManager's request to list all the activated QMCJobs through Itf-N. + +#### 6.3.4.2 Input parameters + +No input parameters for this operation. + +#### 6.3.4.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|------------------|-----------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qoEReferenceList | M | List of <
QMCJob.qoeReference.objectinstance > | The qoEReferenceList provides the identification of each activated network request session.
If no qoEReference can be found, then this list is empty and status is "Success" | +| status | M | ENUM (Success, Failure) | The operation may fail because of a specified or an unspecified reason. | + +### 6.3.5 Notification `notifyNetworkRequestSessionFailure` (O) + +#### 6.3.5.1 Definition + +The `QMCIRP` notifies all subscribed `IRPManagers` and the `QoE Collection Entity` if a network request session in a `ManagedEntity` has not been started due to any problem. + +#### 6.3.5.2 Input parameters + +| Parameter Name | Qualifiers | Matching Information | Comment | +|-------------------------------|------------|-----------------------------------------------------|---------------------| +| objectClass | M,Y | QMCIRP.objectClass | Notification header | +| objectInstance | M,Y | QMCIRP.objectInstance | Notification header | +| eventTime | M,Y | -- | Notification header | +| notificationType | M,Y | " notifyNetworkRequestSessionFailure " | Notification header | +| systemDN | M,Y | -- | Notification header | +| notificationID | O,Y | -- | Notification header | +| qoEReference | M,Y | QMCJob.qoEReference | | +| reason | O,N | -- | | + +#### 6.3.5.3 Triggering event + +##### 6.3.5.3.1 From state + +`problemInManagedEntity` + +| Assertion Name | Definition | +|-------------------------------------|---------------------------------------------------------------------------------------------| +| problemInManagedEntity | Because of a problem the ManagedEntity cannot start a network request session. | + +##### 6.3.5.3.2 To state + +`NetworkRequestSessionFailureReported` + +| Assertion Name | Definition | +|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| NetworkRequestSessionFailureReported | The " notifyNetworkRequestSessionFailure " notification is emitted to the subscribed IRPManager(s) . | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|------------|----|-----|-----|------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | SA5#115 | S5-175400 | | | | R15 pCR 28.308-000 Introduction and Scope for QoE IRP Information Service | 0.1.0 | +| 2017-10 | SA5#115 | S5-175160 | | | | Rel-15 pCR 28.308 References and System Overview for QoE IRP Information Service | 0.1.0 | +| 2017-10 | SA5#115 | S5-175402 | | | | pCR 28.308 Information Object Classes and Interface Definition for QoE IRP Information Service | 0.1.0 | +| 2019-08 | SA5#126 | S5-195504 | | | | Scope | 0.2.0 | +| 2019-08 | SA5#126 | S5-195506 | | | | Add QMCJob | 0.2.0 | +| 2020-03 | SA5#129e | S5-2013889 | | | | Rapporteur's clean up (using new TS template) | 0.3.0 | +| 2020-03 | SA5#129e | S5-201396 | | | | Remove SBA | 0.3.0 | +| 2020-04 | SA5#130e | S5-202302 | | | | pCR R16 28308-030 QMC operations | 0.4.0 | +| 2020-06 | SA5#131e | S5-203328 | | | | Addition of QMC operations and notifications | 0.5.0 | +| 2020-06 | SA5#131e | | | | | EditHelp review (editorial and introduction of explanation of modal verbs). | 0.5.1 | +| 2020-06 | SA#88-e | SP-200475 | | | | Presented for information and approval | 1.0.0 | +| 2020-07 | SA#88e | | | | | Upgrade to change control version | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28309/raw.md b/marked/Rel-16/28_series/28309/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7ee2c45e74d467d683253642b482aa53eefb1771 --- /dev/null +++ b/marked/Rel-16/28_series/28309/raw.md @@ -0,0 +1,1315 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Solution Set (SS) definitions (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, stylized font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| Foreword ....................................................................................................................................................................... | 5 | +| Introduction ................................................................................................................................................................... | 6 | +| 1 Scope................................................................................................................................................................... | 7 | +| 2 References........................................................................................................................................................... | 7 | +| 3 Definitions of terms, symbols and abbreviations ................................................................................................. | 8 | +| 3.1 Terms................................................................................................................................................................... | 8 | +| 3.2 Symbols............................................................................................................................................................... | 8 | +| 3.3 Abbreviations ..................................................................................................................................................... | 8 | +| 4 Solution Set definitions........................................................................................................................................ | 8 | +| Annex A (normative): CORBA Solution Set (SS) ................................................................................................... | 9 | +| A.0 Introduction......................................................................................................................................................... | 9 | +| A.1 Architectural features......................................................................................................................................... | 9 | +| A.1.1 Syntax for Distinguished Names (DN) .......................................................................................................... | 9 | +| A.1.2 Notification services....................................................................................................................................... | 9 | +| A.1.3 Push and pull style......................................................................................................................................... | 9 | +| A.1.4 Support multiple notifications in one push operation ................................................................................... | 9 | +| A.1.5 QoE management notification interface......................................................................................................... | 9 | +| A.1.5.0 Introduction ................................................................................................................................................. | 9 | +| A.1.5.1 Method push (M)................................................................................................................................. | 9 | +| A.2 Mapping ........................................................................................................................................................... | 10 | +| A.2.1 Operation and notification mapping.............................................................................................................. | 10 | +| A.2.2 Operation parameter mapping....................................................................................................................... | 10 | +| A.2.3 Notification parameter mapping.................................................................................................................... | 12 | +| A.3 Solution Set (SS) definitions............................................................................................................................ | 14 | +| A.3.1 IDL definition structure................................................................................................................................. | 14 | +| A.3.2 IDL specification (file name "QMCIRPConstDefs.idl") ............................................................................... | 15 | +| A.3.3 IDL specification (file name "QMCIRPSystem.idl") ................................................................................... | 16 | +| A.3.4 IDL specification (file name "QMCIRPNotifications.idl") .......................................................................... | 18 | +| Annex B (normative): XML definitions ................................................................................................................... | 19 | +| B.0 Introduction......................................................................................................................................................... | 19 | +| B.1 Architectural Features ....................................................................................................................................... | 19 | +| B.1.1 Syntax for Distinguished Names (DN) .......................................................................................................... | 19 | +| B.1.2 Notification services....................................................................................................................................... | 19 | +| B.1.3 IOC definitions............................................................................................................................................... | 19 | +| B.1.4 Supported W3C specification......................................................................................................................... | 19 | +| B.2 Mapping ........................................................................................................................................................... | 19 | +| B.3 Solution Set (SS) definitions............................................................................................................................ | 19 | +| B.3.1 XML definition structure ............................................................................................................................... | 19 | +| B.3.2 XML schema "QMCIRPNotif.xsd" ............................................................................................................... | 21 | +| B.3.3 XML schema "QMCIRPIOCs.xsd" ............................................................................................................... | 22 | +| Annex C (normative): SOAP Solution Set ............................................................................................................... | 23 | +| C.0 Introduction......................................................................................................................................................... | 23 | +| C.1 Architectural features......................................................................................................................................... | 23 | +| C.1.0 General ........................................................................................................................................................... | 23 | +| C.1.1 Syntax for Distinguished Names (DN) .......................................................................................................... | 23 | + +| | | | +|-------------------------------|----------------------------------------------|-----------| +| C.1.2 | Notification services..... | 23 | +| C.1.3 | Supported W3C specifications..... | 23 | +| C.1.4 | Prefixes and namespaces..... | 23 | +| C.2 | Mapping ..... | 24 | +| C.2.1 | Operation and notification mapping..... | 24 | +| C.2.2 | Operation parameter mapping..... | 24 | +| C.2.3 | Notification parameter mapping..... | 25 | +| C.3 | Solution Set (SS) definitions..... | 26 | +| C.3.1 | WSDL definition structure ..... | 26 | +| C.3.2 | WSDL specification "QMCIRPSystem.wsdl" ..... | 26 | +| Annex D (informative): | Change history..... | 31 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +- TS 28.307: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements +- TS 28.308: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS) +- **TS 28.309: Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Solution Set (SS) definitions** + +The present document is part of a TS-family which describes the information service necessary for the Telecommunication Management (TM) of 3G systems. The TM principles and TM architecture are specified in 3GPP TS 32.101 [2] and 3GPP TS 32.102 [3]. + +Quality of Experience (QoE) information collection provides detailed information at session level on a number of UEs. The QoE information from a number of UEs is collected by the management system (e.g. an Operations System (OS) in TMN terminology) for analysis and/or KPI calculations. + +# --- 1 Scope + +The present document specifies the Solution Set definitions for the IRP whose semantics are specified in Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP): Information Service (3GPP TS 28.308 [19]). The present document is applicable to UMTS networks and EPS networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [5] 3GPP TS 32.442: "Telecommunication management; Trace Management Integration Reference Point (IRP): Information Service (IS)". +- [6] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP): Requirements". +- [7] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [8] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set definitions". +- [9] OMG TC Document telecom/98-11-01: "OMG Notification Service". +() +- [10] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)". +- [11] W3C REC-xml-20001006: "Extensible Markup Language (XML) 1.0 (Second Edition)". +- [12] W3C REC-xmlschema-0-20010502: "XML Schema Part 0: Primer". +- [13] W3C REC-xmlschema-1-20010502: "XML Schema Part 1: Structures". +- [14] W3C REC-xmlschema-2-20010502: "XML Schema Part 2: Datatypes". +- [15] W3C SOAP 1.1 specification (). +- [16] W3C XPath 1.0 specification (). +- [17] W3C WSDL 1.1 specification (). +- [18] W3C SOAP 1.2 specification (). + +[19] 3GPP TS 28.308: "Telecommunication management; Quality of Experience (QoE) measurement collection Integration Reference Point (IRP): Information Service (IS)". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in TR 21.905 [1] apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1] and 3GPP TS 32.150 [4]. + +**IRP document version number string (or "IRPVersion"):** See 3GPP TS 32.311 [6]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1], in 3GPP TS 32.150 [4], 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]. + +| | | +|----|--------------------| +| DN | Distinguished Name | +| SS | Solution Set | + +# --- 4 Solution Set definitions + +The present document defines the following 3GPP QMC Management IRP Solution Set definitions: + +- Annex A provides the CORBA Solution Set. +- Annex B provides the XML definitions. +- Annex C provides the SOAP Solution Set. + +# --- Annex A (normative): CORBA Solution Set (SS) + +## A.0 Introduction + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in QoE Management IRP: Information Service (3GPP TS 28.308 [19]). + +### --- A.1 Architectural features + +The overall architectural feature of QMC Management IRP is specified in 3GPP TS 28.308 [19]. + +#### A.1.1 Syntax for Distinguished Names (DN) + +The format of a Distinguished Name (DN) is defined in 3GPP TS 32.300 [7]. + +The version of this IRP is represented as a string (see also 3GPP TS 32.311 [6]). + +#### A.1.2 Notification services + +Notifications are sent according to the Notification IRP: CORBA SS (see 3GPP TS 32.306 [8]). + +The contents of the QMCIRP notifications are defined in the present document. + +#### A.1.3 Push and pull style + +OMG Notification Service defines two styles of interaction. One is called push style. In this style, IRPAgent pushes notifications to IRPManager as soon as they are available. The other is called pull style. In this style, IRPAgent keeps the notifications till IRPManager requests for them. + +This CORBA SS specifies that support of Push style is Mandatory (M) and that support of Pull style is Optional (O). + +#### A.1.4 Support multiple notifications in one push operation + +For efficiency reasons, IRPAgent may send multiple notifications using one single push operation. To pack multiple notifications into one push operation, IRPAgent may wait and not invoke the push operation as soon as notifications are available. To avoid IRPAgent to wait for an extended period of time that is objectionable to IRPManager, IRPAgent shall implement an IRPAgent wide timer configurable by administrator. On expiration of this timer, IRPAgent shall invoke push if there is at least one notification to be conveyed to IRPManager. This timer is re-started after each push invocation. + +#### A.1.5 QoE management notification interface + +#### A.1.5.0 Introduction + +OMG CORBA Notification push operation is used to realise the notification of QMCIRP Notifications. All the notifications in this interface are implemented using this `push_structured_event` method. + +##### A.1.5.1 Method `push` (M) + +``` + +module CosNotifyComm { + ... + interface SequencePushConsumer : NotifyPublish { + void push_structured_events( + in CosNotification::EventBatch notifications) + raises( CosEventComm::Disconnected); + }; + // SequencePushConsumer + ... +}; // CosNotifyComm + +``` + +NOTE 1: The `push_structured_events` method takes an input parameter of type `EventBatch` as defined in the OMG `CosNotification` module (OMG Notification Service [9]). This data type is the same as a sequence of Structured Events. Upon invocation, this parameter will contain a sequence of Structured Events being delivered to `IRPManager` by `IRPAgent` to which it is connected. + +NOTE 2: The maximum number of events that will be transmitted within a single invocation of this operation is controlled by `IRPAgent` wide configuration parameter. + +NOTE 3: The amount of time the supplier (`IRPAgent`) of a sequence of Structured Events will accumulate individual events into the sequence before invoking this operation is controlled by `IRPAgent` wide configuration parameter as well. + +NOTE 4: `IRPAgent` may push `EventBatch` with only one Structured Event. + +### A.2 Mapping + +#### A.2.1 Operation and notification mapping + +QMCIRP: IS 3GPP TS 28.309 [19] defines semantics of operation and notification visible across the QMCIRP. Table A.2.1.1 indicates mapping of these operations and notifications to their equivalents defined in this SS. + +**Table A.2.1.1: Mapping from IS Operations and Notification to SS equivalents** + +| IS Operations/ notification 3GPP TS 28.308 [19] | SS Method | Qualifier | +|-------------------------------------------------|-----------------------------------------------|-----------| +| activateAreaQMCJob | activateAreaQMCJob | M | +| deactivateQMCJob | deactivateQMCJob | M | +| listQMCJob | listQMCJob | M | +| listActivatedQMCJobs | listActivatedQMCJobs | M | +| notifyNetworkRequestSessionFailure | push_structured_events(See subclause A.1.5.1) | O | + +#### A.2.2 Operation parameter mapping + +The QMCIRP: IS 3GPP TS 28.308 [19] defines semantics of parameters carried in operations across the QMCIRP. The following tables indicate the mapping of these parameters, as per operation, to their equivalents defined in this SS. + +**Table A.2.2.1: Mapping from IS `activateAreaQMCJob` parameters to SS equivalents** + +| IS Operation parameter | SS Method parameter | Qualifier | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| iOCInstance | KernelCmConstDefs::DN moInstance | M | +| qoEReference | QmcIRPConstDefs::QoeReference qoeReference | M | +| qMCTarget | QmcIRPConstDefs::QmcTarget qmcTarget | M | +| qoECollectionEntityAddress | QmcIRPConstDefs::QoeCollectionEntityAddress qoeCollectionEntityAddress | M | +| serviceType | QmcIRPConstDefs:: ServiceType serviceType | M | +| areaScope | QmcIRPConstDefs::DNSet | M | +| pLMNTarget | QmcIRPConstDefs: PLMNTarget pLMNTarget | CM | +| qMCConfigurationFile | QmcIRPConstDefs: QmcConfigurationFile qmcConfigurationFile | M | +| unsupportedList | QmcIRPConstDefs: UnsupportedList unsupportedList | M | +| status | Return value of type QmcIRPConstDefs::Result
Exception:
ActivateAreaQMCJob
NotUniqueQoEReference
ManagedGenericIRPSystem::InvalidParameter,
ManagedGenericIRPSystem::ValueNotSupported | M | + +**Table A.2.2.2: Mapping from IS `deactivateQMCJob` parameters to SS equivalents** + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------------------------------------------------------------------------------------------|-----------| +| iOCInstance | KernelCmConstDefs::DN moInstance | M | +| qoEReference | QmcIRPConstDefs::QoeReference qoeReference | M | +| qMCTarget | QmcIRPConstDefs::QmcTarget qmcTarget | M | +| status | Return value of type QmcIRPConstDefs::Result
Exception:
DeactivateQMCJob
NotUniqueQoEReference | M | +| unsupportedList | QmcIRPConstDefs: UnsupportedList unsupportedList | M | + +**Table A.2.2.3: Mapping from IS `listQMCJob` parameters to SS equivalents** + +| IS Operation parameter | SS Method parameter | Qualifier | +|----------------------------|---------------------------------------------------------------------------------------------------|-----------| +| iOCInstance | KernelCmConstDefs::DN moInstance | M | +| status | Return value of type QmcIRPConstDefs::Result
Exception:
ListQMCJob
NotUniqueQoEReference | M | +| qoEReference | QmcIRPConstDefs::QoeReference qoeReference | M | +| qMCTarget | QmcIRPConstDefs::QmcTarget qmcTarget | M | +| qoECollectionEntityAddress | QmcIRPConstDefs::QoeCollectionEntityAddress qoeCollectionEntityAddress | M | +| serviceType | QmcIRPConstDefs:: ServiceType serviceType | M | +| areaScope | QmcIRPConstDefs::DNSet | M | +| pLMNTarget | QmcIRPConstDefs: PLMNTarget pLMNTarget | CM | +| qMCConfigurationFile | QmcIRPConstDefs: QmcConfigurationFile qmcConfigurationFile | M | + +**Table A.2.2.4: Mapping from IS `listActivatedQMCJobs` parameters to SS equivalents** + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|----------------------------------------------------|-----------| +| qoEReferenceList | QmcIRPConstDefs::QoEReferenceList qoeReferenceList | M | +| status | Return value of type QmcIRPConstDefs::Result | M | + +#### A.2.3 Notification parameter mapping + +The QMCIRP: IS 3GPP TS 28.309 [19] defines semantics of parameters carried in notifications. The following table indicates the mapping of these parameters to their OMG CORBA Structured Event (defined in OMG Notification Service [9]) equivalents. The composition of OMG Structured Event, as defined in the OMG Notification Service [9], is: + +``` +Header + Fixed Header + domain_name + type_name + event_name + Variable Header +Body + filterable_body_fields + remaining_body +``` + +The following tables list all OMG Structured Event attributes in the second column. The first column identifies the QMCIRP: IS 3GPP TS 28.308 [19] defined notification parameters. + +**Table A.2.3.1: Mapping for `notifyNetworkRequestSessionFailure`** + +| IS Parameters | OMG CORBA Structured Event attribute | Qualifier | Comment | +|-----------------------------------------|---------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| There is no corresponding IS attribute. | domain_name | M | It carries the IRP document version number string. See subclause 3.1. It indicates the syntax and semantics of the Structured Event as defined by the present document. | +| notificationType | type_name | M | This is constant string "notifyNetworkRequestSessionFailure". | +| There is no corresponding IS attribute. | event_name | M | It carries no information. | +| There is no corresponding IS attribute. | Variable Header | M | The Variable Header consists of a single name/value (NV) pair, namely Priority. | +| objectClass,
objectInstance | One NV pair of filterable_body_fields | M | NV stands for name-value pair. Order arrangement of NV pairs is not significant. The name of NV-pair is always encoded in string.

Name of this NV pair is the MANAGED_OBJECT_INSTANCE of interface AttributeNameValue of module NotificationIRPConstDefs.

Value of NV pair is a string. See corresponding table in Notification IRP: CORBA SS (3GPP TS 32.306 [8]). | +| notificationId | One NV pair of remaining_body | O | Name of NV pair is the NOTIFICATION_ID of interface AttributeNameValue of module NotificationIRPConstDefs.

Value of NV pair is a long. See corresponding table in Notification IRP: CORBA SS (3GPP TS 32.306 [8]). | +| eventTime | One NV pair of filterable_body_fields | M | Name of NV pair is the EVENT_TIME of interface AttributeNameValue of module NotificationIRPConstDefs.

Value of NV pair is IRPTime. See corresponding table in Notification IRP: CORBA SS (3GPP TS 32.306 [8]). | +| systemDN | One NV pair of filterable_body_fields | M | Name of NV pair is the SYSTEM_DN of interface AttributeNameValue of module NotificationIRPConstDefs.

Value of NV pair is a string. See corresponding table in Notification IRP: CORBA SS (3GPP TS 32.306 [8]). | +| qoEReference | One NV pair of filterable_body_fields | M | Name of NV pair is the QOE_REFERENCE of qmclRPNotifications::notifyNetworkRequestSessionFailure.

Value of NV pair is QoeReference of module QmclRPConstDefs. | +| reason | One NV pair of remaining_body | O | Name of NV pair is the REASON of qmclRPNotifications:: notifyNetworkRequestSessionFailure.

Value of NV pair is a string. | + +### --- A.3 Solution Set (SS) definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the constants and types used by the QMC Management IRP. + +Clause A.3.3 defines the operations which are performed by the QMC Management IRP agent. + +Clause A.3.4 defines the notifications which are emitted by the QMC Management IRP agent. + +### A.3.2 IDL specification (file name "QMCIRPConstDefs.idl") + +``` + +//File: QMCIRPConstDefs.idl +#ifndef _QMC_IRP_CONST_DEFS_IDL_ +#define _QMC_IRP_CONST_DEFS_IDL_ +#include + +// This statement shall appear after all include statements +#pragma prefix "3gppsa5.org" + +/** Module: QMCIRPConstDefs +This module contains commonly used definitions for QMC IRP +===== +*/ +module QMCIRPConstDefs +{ + enum Result Enum {SUCESS, FAILURE, PARTIAL_SUCCESS}; + + typedef struct QoeReference + { + short mcc; + short mnc; + unsigned long qmcId; + }; + + typedef sequence QoEReferenceList; + + typedef string QoeCollectionEntityAddress; + + enum QmcTarget {AREA_BASED_QMC, INDIVIDUAL_BASED_UE }; + + enum ServiceType {DASH,MTSI}; + + typedef string QmcConfigurationFile; + + typedef sequence DNSet; + + enum UnsupportedItem {MANAGED_ENTITY, QMC_TARGET, AREA_SCOPE, SERVICE_TYPE, PLMN_TARGET}; + typedef sequence UnsupportedList; + + /** + * This block identifies attributes which are included as part of the + * notifications defined within QMCIRP. These attribute values should not + * clash with those defined for the attributes of notification + * header (see IDL of Notification IRP). + */ + + interface AttributeNameValue + { + const string QOE_REFERENCE = "QOE_REFERENCE"; + const string QMC_TARGET = "QMC_TARGET"; + const string MO_INSTANCE = "MO_INSTANCE"; + const string REASON = "REASON"; + }; + +}; + +``` + +#### A.3.3 IDL specification (file name “QMCIRPSystem.idl”) + +``` + +//File: QMCIRPSystem.idl +#ifdef _QMC_IRP_SYSTEM_IDL_ +#define _QMC_IRP_SYSTEM_IDL_ + +#include +#include +#include +#include + +//This statement shall appear after all include statements +#pragma prefix "3gppsa5.org" + +/* Module: QMCIRPSystem +This module contains the specification of all operations of QMC IRP Agent. +===== +*/ +module QMCIRP +{ + exception ActivateAreaQMCJob { string reason; }; + exception NotUniqueQMCReference { string reason; }; + exception DeactivateQMCJob { string reason; }; + exception ListQMCJob { string reason; }; + exception ListActivatedQMCJob { string reason; }; + + interface QMCIRP + { + + /** + * Request to activate a QMCJob through Itf-N. + **/ + + QMCIRPConstDefs::ResultEnum activateAreaQMCJob ( + in KernelCmConstDefs::DN moInstance, + in QMCIRPConstDefs::QoeReference qoeReference, + in QMCIRPConstDefs::QmcTarget qmcTarget, + in QMCIRPConstDefs::QoeCollectionEntityAddress qoeCollectionEntityAddress, + in QMCIRPConstDefs::DNSet areaScope, + in QMCIRPConstDefs::ServiceType serviceType, + in QMCIRPConstDefs::PLMNTarget pLMNTarget, + in QMCIRPConstDefs::QmcConfigurationFile qmcConfigurationFile, + out QMCIRPConstDefs:: UnsupportedList unsupportedList + ) + raises (ActivateAreaQMCJob, + NotUniqueQoeReference, + GenericIRPManagementSystem::InvalidParameter, + GenericIRPManagementSystem::ValueNotSupported, + GenericIRPManagementSystem::OperationNotSupported + ); + + /** + * Request to deactivate a QMCJob through Itf-N. + **/ + + QMCIRPConstDefs::ResultEnum deactivateQMCJob ( + in KernelCmConstDefs::DN moInstance, + in QMCIRPConstDefs::QoeReference qoeReference, + in QMCIRPConstDefs::QmcTarget qmcTarget, + out QMCIRPConstDefs:: UnsupportedList unsupportedList) + raises (DeactivateQMCJob, + NotUniqueQoeReference, + GenericIRPManagementSystem::InvalidParameter, + GenericIRPManagementSystem::ValueNotSupported, + GenericIRPManagementSystem::OperationNotSupported); + + /** + * Request to list the parameters of a specific QMCJob through Itf-N. + **/ + + QMCIRPConstDefs::ResultEnum listQMCJob ( + in QMCIRPConstDefs::QoeReference qoeReference, + out KernelCmConstDefs::DN moInstance, + out QMCIRPConstDefs::QoeReference qoeReference, + out QMCIRPConstDefs::QmcTarget qmcTarget, + out QMCIRPConstDefs::QoeCollectionEntityAddress qoeCollectionEntityAddress, + ) + } +} + +``` + +``` + out QMCIRPConstDefs::ServiceType serviceType, + out QMCIRPConstDefs::DNSet areaScope, + out QMCIRPConstDefs::PLMNTarget pLMNTarget, + out QMCIRPConstDefs::QmcConfigurationFile qmcConfigurationFile + ) + + raises (ListQMCJob, + NotUniqueQoEReference, + GenericIRPManagementSystem::InvalidParameter, + GenericIRPManagementSystem::ValueNotSupported, + GenericIRPManagementSystem::OperationNotSupported); + + /** + * Request to list the activated QMCJobs through Itf-N. + */ + + QMCIRPConstDefs::ResultEnum listActivatedQMCJob ( + out QMCIRPConstDefs:: QoEReferenceList qoeReferenceList) + raises (ListActivatedQMCJob, + GenericIRPManagementSystem::InvalidParameter, + GenericIRPManagementSystem::ValueNotSupported, + GenericIRPManagementSystem::OperationNotSupported); + +}; + +#endif // _QMC_IRP_SYSTEM_IDL_ +``` + +#### A.3.4 IDL specification (file name “QMCIRPNotifications.idl”) + +``` +//File: QMCIRPNotifications.idl +#ifdef _QMC_IRP_NOTIFICATIONS_IDL_ +#define _QMC_IRP_NOTIFICATIONS_IDL_ + +#include +#include + +// This statement shall appear after all include statements +#pragma prefix "3gppsa5.org" + +/* Module: QMCIRPNotifications +This module contains the specification of all notifications of QMC IRP Agent. +===== +*/ +module QMCIRPNotifications +{ + + /** + * Constant definitions for the notifyNetworkRequestSessionFailure notification + **/ + + interface NotifyNetworkRequestSessionFailure: NotificationIRPNotifications::Notify + { + const string EVENT_TYPE = "notifyNetworkRequestSessionFailure"; + + /** + * This constant defines the name of the QoeReference property. + * The data type for the value of this property is + * QMCIRPConstDefs::QoeReference. + **/ + + const string QOE_REFERENCE = QMCIRPConstDefs::AttributeNameValue::QOE_REFERENCE; + + /** + * This constant defines the name of the reason property. + * The data type for the value of this property is string. + **/ + + const string REASON = QMCIRPConstDefs::AttributeNameValue::REASON; + }; + +}; + +#endif // _QMC_IRP_NOTIFICATIONS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 Introduction + +This annex contains the XML definitions for the QMC Management IRP for the IRP whose semantics is specified in QMC Management IRP: Information Service (3GPP TS 28.308 [19]). + +This XML definitions specification defines the XML syntax of the QMC Management IRP XML Data File. + +### --- B.1 Architectural Features + +The overall architectural feature of QMC Management IRP is specified in 3G TS 28.308 [19]. This clause specifies features that are specific to the XML definitions. + +#### B.1.1 Syntax for Distinguished Names (DN) + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [7]. + +#### B.1.2 Notification services + +This annex defines the XML syntax of QMC Management IRP notifications that is to be used for the QMC Management IRP SOAP Solution Set and in conjunction with Notification Log IRP XML definitions for Notification Log IRP XML Data File and the NL IRP XML Notification Format. + +### B.1.3 IOC definitions + +This annex defines the XML syntax for the IOC definitions of the QMC Management IRP IS [19], which are used by the XML definitions for the QMC Management IRP notifications and the QMC Management IRP IS operations. + +### B.1.4 Supported W3C specification + +The Extensible Markup Language (XML) 1.0 (Second Edition) [11], XML Schema Part 0: Primer [12], XML Schema Part 1: Structures[13] and XML Schema Part 2: Datatypes [14] are supported. + +## --- B.2 Mapping + +Not present in the current version of the present document. + +## --- B.3 Solution Set (SS) definitions + +### B.3.1 XML definition structure + +Clause B.3.2 provides XML definitions of QMC Management IRP notifications as defined in [19]. These definitions are to be used for the QMC Management IRP SOAP Solution Set. For QMC IRP XML File Name Conventions the generic file name definitions as specified by the FT IRP apply (see [10]). + +Clause B.3.3 provides XML definitions of QMC Management IOC as defined in [19]. + +### B.3.2 XML schema "QM CIRP Notif.xsd" + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### B.3.3 XML schema "QM CIRPIOCs.xsd" + +``` + + + + + elementFormDefault="qualified" attributeFormDefault="unqualified"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# --- Annex C (normative): SOAP Solution Set + +## C.0 Introduction + +This annex specifies the SOAP Solution Set for the IRP whose semantics are specified in QMC Management IRP: Information Service (3GPP TS 28.308 [19]). + +## --- C.1 Architectural features + +### C.1.0 General + +The overall architectural feature of the QMC Management IRP is specified in 3GPP TS 28.308 [19]. This clause specifies features that are specific to the SOAP solution set. + +### C.1.1 Syntax for Distinguished Names (DN) + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [7]. + +### C.1.2 Notification services + +The Trace Management IRP SOAP SS uses the Notification IRP SOAP SS of 3GPP TS 32.306 [8]. The IRP Agent shall support the push interface model, which means that the IRP Agent sends trace management notifications to the IRP Manager as soon as new events occur. The IRP Manager does not need to check ("pull") for events. + +### C.1.3 Supported W3C specifications + +The SOAP 1.1 specification [15] and WSDL 1.1 specification [17] are supported. + +The SOAP 1.2 specification [18] is supported optionally. + +The present document uses "document" style in WSDL file. + +The present document uses "literal" encoding style in WSDL file. + +The filter language used in the SS is the XPath Language (see W3C XPath 1.0 specification [16]). IRP Agents may throw a FilterComplexityLimit fault when a given filter is too complex. + +Relevant definitions are imported from the QMC Management IRP XML definitions of Annex B + +### C.1.4 Prefixes and namespaces + +The present document uses a number of namespace prefixes throughout that are listed in Table C.1.4.1. + +**Table C.1.4.1: Prefixes and Namespaces used in the present document** + +| PREFIX | NAMESPACE | +|------------------|---------------------------------------------------------------------------------| +| (no prefix) | http://schemas.xmlsoap.org/wsdl/ | +| soap | http://schemas.xmlsoap.org/wsdl/soap/ | +| QMCIRPSystem | http://www.3gpp.org/ftp/specs/archive/28_series/28.309#QMCIRPSystem | +| QMCIRPData | http://www.3gpp.org/ftp/specs/archive/28_series/28.309#QMCIRPData | +| xti | http://www.3gpp.org/ftp/specs/archive/28_series/28.309#QMCIRPIOCs | +| xn | http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm | +| genericIRPSystem | http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem | +| ntfIRPNtfSystem | http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem | + +### C.2 Mapping + +### C.2.1 Operation and notification mapping + +The QMC Management IRP IS (3GPP TS 28.308 [19]) defines semantics of operation and notification visible across the Itf-N. Table C.2.1.1 indicates mapping of these operations and notifications to their equivalents defined in this SS. + +**Table C.2.1.1: Mapping from IS Operation to SS Equivalents** + +| IS Operations in 3GPP TS 32.442 [5] | SS Operations | SS Port | Qualifier | +|-------------------------------------|----------------------|------------------------|-----------| +| activateAreaQMCJob | activateAreaQMCJob | QMCIRPManagementPort | M | +| deactivateQMCJob | deactivateQMCJob | QMCIRPManagementPort | M | +| listQMCJob | listQMCJob | QMCIRPManagementPort | M | +| listActivatedQMCJobs | listActivatedQMCJobs | QMCIRPManagementPort | O | +| notifyNetworkRequestSessionFailure | notify (note 1) | NotificationIRPNtfPort | O | + +NOTE 1: The IS equivalent maps to an XML definition specified in Annex B, and this being an input parameter to the operation notify under the port type ntfIRPNtfSystem:NotificationIRPNtf and under the binding ntfIRPNtfSystem:NotificationIRPNtf of 3GPP TS 32.306 [8]. + +### C.2.2 Operation parameter mapping + +The QMC Management IRP IS (3GPP TS 28.308 [19]) defines semantics of parameters carried in the operations. The tables below show the mapping of these parameters, as per operation, to their equivalents defined in this SS. + +**Table C.2.2.1: Mapping from IS activateAreaQMCJob parameters to SS equivalents** + +| IS Operation parameter | SS Method parameter | Qualifier | +|----------------------------|----------------------------|-----------| +| iOCInstance | iOCInstance | M | +| qoEReference | qoEReference | M | +| qMCTarget | qMCTarget | M | +| qoECollectionEntityAddress | qoECollectionEntityAddress | M | +| areaScope | areaScope | M | +| unsupportedList | unsupportedList | M | +| status | status | M | +| pLMNTarget | pLMNTarget | CM | +| qMCConfigurationFile | qMCConfigurationFile | M | +| serviceType | serviceType | M | + +Table C.2.2.2: Mapping from IS deactivateQMCJob parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| goEReference | goEReference | M | +| qMCTarget | qMCTarget | M | +| status | status | M | +| unsupportedList | unsupportedList | M | + +Table C.2.2.3: Mapping from IS listQMCJob parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|----------------------------|----------------------------|-----------| +| iOCInstance | iOCInstance | M | +| goEReference | goEReference | M | +| qMCTarget | qMCTarget | M | +| goECollectionEntityAddress | goECollectionEntityAddress | M | +| areaScope | areaScope | M | +| status | status | M | +| pLMNTarget | pLMNTarget | CM | +| qMCConfigurationFile | qMCConfigurationFile | M | +| serviceType | serviceType | M | + +Table C.2.2.4: Mapping from IS listActivatedQMCJobs parameters to SS equivalents + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------|-----------| +| goEReferenceList | goEReferenceList | M | +| status | status | M | + +### C.2.3 Notification parameter mapping + +The QMC Management IRP IS (3GPP TS 28.308 [19]) defines semantics of parameters carried in notifications. The following tables indicate the mapping of these parameters to their SS equivalents. + +Table C.2.3.1: Mapping for notifyNetworkRequestSessionFailure + +| IS Parameters | Parameters | Qualifier | Comment | +|------------------|------------------|-----------|---------| +| objectClass | objectClass | M | | +| objectInstance | objectInstance | M | | +| eventTime | eventTime | M | | +| notificationType | notificationType | M | | +| systemDN | systemDN | M | | +| notificationID | notificationID | O | | +| goEReference | goEReference | M | | +| reason | reason | O | | + +### C.3 Solution Set (SS) definitions + +### C.3.1 WSDL definition structure + +Clause C.3.2 defines the services which are supported the QMC Management IRP agent. + +### C.3.2 WSDL specification "QMCIRPSystem.wsdl" + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# --- Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|-----------------------------------------------------|-------------| +| Date | Meeting | Tdoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-08 | | S5-204317 | | | | TS skeleton including the solution set | 0.0.0 | +| 2020-08 | | S5-204670 | | | | Draft TS 28.309 | 0.1.0 | +| 2020-09 | SA#89e | SP-200757 | | | | Presented for approval | 1.0.0 | +| 2020-09 | SA#89e | | | | | Upgrade to change control version + EditHelp review | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28310/124c6108c63173818afb8ed49521e22d_img.jpg b/marked/Rel-16/28_series/28310/124c6108c63173818afb8ed49521e22d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93933be39623a94b9539ce859553f34fdb243a16 --- /dev/null +++ b/marked/Rel-16/28_series/28310/124c6108c63173818afb8ed49521e22d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:016d9d645c7a16f691eff7fb89dc133a7f60434e49bdcaf31b77c4af7db3e08d +size 79861 diff --git a/marked/Rel-16/28_series/28310/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/28_series/28310/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..212a1d037855ed89a96719a6e777c1cf7254bc73 --- /dev/null +++ b/marked/Rel-16/28_series/28310/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:680d3e58572bbd51591c7a36b9751da5b3c821cecd72cbb77a52138dd2d48a48 +size 62565 diff --git a/marked/Rel-16/28_series/28310/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/28_series/28310/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b60fed7204298160f97f027f3d6d8a9d07cc0614 --- /dev/null +++ b/marked/Rel-16/28_series/28310/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e6d4c2ab3a3758c41cfa0c8cdfd86a3f9ed4e74dd0fb9f49f1a03aa0df6dd56e +size 72113 diff --git a/marked/Rel-16/28_series/28310/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/28_series/28310/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c9ca1ac09bd86e7627192265d51b1d8b473eb68 --- /dev/null +++ b/marked/Rel-16/28_series/28310/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:744e2125b5951eeef8a974e3ba282845c0545155c7ea50b806e4be2eb2a1a915 +size 40721 diff --git a/marked/Rel-16/28_series/28310/f7d969388c4f7e30cd04a061314bfa0e_img.jpg b/marked/Rel-16/28_series/28310/f7d969388c4f7e30cd04a061314bfa0e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d7e797bbdb497db91ef1027a0910b08a25c3ccf --- /dev/null +++ b/marked/Rel-16/28_series/28310/f7d969388c4f7e30cd04a061314bfa0e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48a490c58022f1aa105b25fb38d35643304f04a93ed6ab01c172b26bc40c90e2 +size 49831 diff --git a/marked/Rel-16/28_series/28310/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/28_series/28310/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..693cea0d47529e5fcce9c1d31c7cfc5c9cc62bc2 --- /dev/null +++ b/marked/Rel-16/28_series/28310/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:496a7794348efc04ae1ccadad3a2105c588a09ed33cd512cd57640ceae332462 +size 24994 diff --git a/marked/Rel-16/28_series/28310/raw.md b/marked/Rel-16/28_series/28310/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e1db2babda40ed305ce8881d4d87e0bcb8672cce --- /dev/null +++ b/marked/Rel-16/28_series/28310/raw.md @@ -0,0 +1,1043 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Concepts and overview ..... | 9 | +| 4.1 EE KPIs Overview ..... | 9 | +| 4.2 Management services ..... | 10 | +| 4.3 Energy saving..... | 10 | +| 4.3.1 Introduction ..... | 10 | +| 4.3.2 Concepts ..... | 10 | +| 5 Specification level requirements..... | 11 | +| 5.1 Use cases ..... | 11 | +| 5.1.1 Data Volume (DV) collection ..... | 11 | +| 5.1.1.1 Applicability ..... | 11 | +| 5.1.1.2 DV measurement control..... | 11 | +| 5.1.1.3 DV measurement data file reporting..... | 11 | +| 5.1.1.4 DV measurement data streaming..... | 11 | +| 5.1.2 Power, Energy and Environmental (PEE) measurement collection ..... | 12 | +| 5.1.2.1 Applicability ..... | 12 | +| 5.1.2.2 PEE measurement control..... | 12 | +| 5.1.2.3 PEE measurement data file reporting ..... | 12 | +| 5.1.2.4 PEE measurement data streaming..... | 12 | +| 5.1.2.5 PEE fault supervision..... | 12 | +| 5.1.2.6 PEE configuration management ..... | 12 | +| 5.1.3 Energy saving use cases ..... | 12 | +| 5.1.3.1 General..... | 12 | +| 5.1.3.2 Capacity booster cell partially overlaid by candidate cell(s)..... | 13 | +| 5.1.3.2.1 Introduction ..... | 13 | +| 5.1.3.2.2 Intra-RAT energy saving..... | 13 | +| 5.1.3.2.3 Inter-RAT energy saving..... | 13 | +| 5.1.3.3 Capacity booster cell fully overlaid by candidate cell(s)..... | 13 | +| 5.2 Requirements..... | 15 | +| 5.2.1 Requirements for Data Volume (DV) measurement..... | 15 | +| 5.2.1.1 Applicability ..... | 15 | +| 5.2.1.2 Requirements for DV measurement control ..... | 15 | +| 5.2.1.3 Requirements for DV measurement data file reporting..... | 15 | +| 5.2.1.4 Requirements for DV measurement data streaming service..... | 15 | +| 5.2.2 Requirements for Power, Energy and Environmental (PEE) measurement..... | 15 | +| 5.2.2.1 Applicability ..... | 15 | +| 5.2.2.2 Requirements for PEE measurement control..... | 15 | +| 5.2.2.3 Requirements for PEE measurement data file reporting ..... | 16 | +| 5.2.2.4 Requirements for PEE measurement data streaming..... | 16 | +| 5.2.2.5 Requirements for PEE fault supervision..... | 16 | +| 5.2.2.6 Requirements for PEE configuration management ..... | 16 | +| 5.2.3 Requirements for energy saving..... | 16 | +| 5.2.3.1 Requirements for capacity booster cell overlaid by candidate cell(s) ..... | 16 | +| 5.3 Actor roles ..... | 17 | +| 5.4 Telecommunication resources..... | 17 | +| 6 Solutions for energy efficiency ..... | 17 | +| 6.1 Solutions for assessment of mobile network data energy efficiency ..... | 17 | +| 6.2 Solutions for energy saving..... | 18 | +| 6.2.1 Overview ..... | 18 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------|-----------| +| 6.2.2 | Centralized energy saving solution ..... | 18 | +| 6.2.2.1 | Procedures..... | 18 | +| 6.2.2.1.1 | Energy saving activation ..... | 18 | +| 6.2.2.1.2 | Energy saving deactivation ..... | 19 | +| 6.2.2.2 | Management services..... | 20 | +| 6.2.3.2.1 | MnS component type A..... | 20 | +| 6.2.3.2.2 | MnS Component Type B..... | 20 | +| 6.2.3.2.2.1 | Objective and targets ..... | 20 | +| 6.2.3.2.2.2 | Control information ..... | 20 | +| 6.2.3.2.3 | MnS Component Type C..... | 20 | +| 6.2.3.2.3.1 | Parameters to be optimized ..... | 20 | +| 6.2.3.2.3.2 | Performance measurements..... | 21 | +| 6.2.3 | Distributed energy saving solution ..... | 23 | +| 6.2.3.0 | Management service components used for Distributed SON ES solution ..... | 23 | +| 6.2.3.1 | Management services..... | 23 | +| 6.2.3.1.1 | MnS component type A..... | 23 | +| 6.2.3.1.2 | MnS Component Type B..... | 23 | +| 6.2.3.1.2.1 | Objective and targets ..... | 23 | +| 6.2.3.1.2.2 | Control information ..... | 24 | +| 6.2.3.1.3 | MnS Component Type C..... | 24 | +| 6.2.3.1.3.1 | Parameters to be optimized ..... | 24 | +| 6.2.3.1.3.2 | Performance measurements..... | 24 | +| 6.2.3.2 | Procedures..... | 25 | +| 6.2.3.2.1 | Energy saving activation ..... | 25 | +| 6.2.3.2.2 | Energy saving deactivation ..... | 25 | +| Annex A (informative): | Plant UML source code..... | 27 | +| A.1 | Distributed energy saving activation..... | 27 | +| A.2 | Distributed energy saving deactivation ..... | 27 | +| A.3 | Centralized energy saving activation ..... | 27 | +| A.4 | Centralized energy saving deactivation..... | 28 | +| Annex B (informative): | Change history..... | 29 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" shall not be used as substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies concepts, use cases, requirements and solutions for the energy efficiency assessment and optimization for energy saving of 5G networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] ETSI ES 203 228: "Environmental Engineering (EE); Assessment of mobile network energy efficiency". +- [3] ETSI ES 202 336-1 V1.2.1: "Environmental Engineering (EE); Monitoring and Control Interface for Infrastructure Equipment (Power, Cooling and Building Environment Systems used in Telecommunication Networks) Part 1: Generic Interface". +- [4] ETSI ES 202 336-12 V1.1.1: "Environmental Engineering (EE); Monitoring and control interface for infrastructure equipment (power, cooling and building environment systems used in telecommunication networks); Part 12: ICT equipment power, energy and environmental parameters monitoring information model". +- [5] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [6] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [7] 3GPP TS 28.545: "Management and orchestration; Fault Supervision (FS)". +- [8] 3GPP TS 32.432: "Telecommunication management; Performance measurement: File format definition". +- [9] 3GPP TS 32.435: "Telecommunication management; Performance measurement; eXtensible Markup Language (XML) file format definition". +- [10] 3GPP TS 32.436: "Telecommunication management; Performance measurement: Abstract Syntax Notation 1 (ASN.1) file format definition". +- [11] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [12] 3GPP TS 38.401: "NG-RAN; Architecture description". +- [13] 3GPP TS 38.300: "NR; Overall description; Stage-2". +- [14] 3GPP TR 37.816: "Study on RAN-centric data collection and utilization for LTE and NR". +- [15] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [16] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [17] 3GPP TS 32.551: "Energy Saving Management (ESM); Concepts and requirements". + +[18] 3GPP TS 28.554: "Management and orchestration; 5G end to end Key Performance Indicators (KPI)". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +**Candidate cell:** cell which can provide coverage when the original cell goes into energySaving state. + +**energySaving state:** state in which some functions of a cell or a network element or network function are powered-down. + +NOTE 1: In energySaving state, the cell or network element or network function is still controllable. + +NOTE 2: This is the state when the traffic goes below a certain threshold. + +**notEnergySaving state:** state when no energy saving in progress. + +NOTE 3: This is the state when the traffic goes above a certain threshold. + +**ES activation:** procedure to power down a cell or network element or network function for energy saving purposes. + +NOTE 4: As a result, the subject cell or network element or network function goes into energySaving state. + +**ES deactivation:** procedure to power up a cell or network element or network function. + +NOTE 5: As a result, the subject cell or network element or network function goes into notEnergySaving state. + +**ES Probing procedure:** procedure executed by an ES probing capable cell triggered by Cell Activation procedure or ES deactivation procedure. + +NOTE 6: The ES probing procedure [17] assists the decision whether the cell will transfer to notEnergySaving state or remain in energySaving state. + +NOTE 7: During the ES probing procedure the ES probing capable cell is not carrying traffic, while it can perform measurements and be visible to the UEs in its coverage. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|-----|---------------------------------| +| DV | Data Volume | +| EC | Energy Consumption | +| EE | Energy Efficiency | +| PEE | Power, Energy and Environmental | +| PNF | Physical Network Function | +| VNF | Virtualized Network Function | + +# 4 Concepts and overview + +## 4.1 EE KPIs Overview + +Telecommunication networks energy efficiency KPIs are defined by various SDOs / organizations and are of various natures. They can be applied to either: + +- whole networks (i.e. end-to-end), or to +- sub-networks (e.g. the radio access network), or to +- single network elements, or to +- telecommunication sites, which contain network elements and site equipment. + +NOTE 1: Data centers used by network operators are considered in the present document as telecommunication sites. + +Moreover, EE KPIs can also be categorized according to the operator's network life cycle phase they may apply to, e.g.: + +- during the Buy phase, mobile network operators may be willing to compare network elements from various vendors from an EE standpoint. Some EE KPIs and measurement methods have been specified for this purpose. +- during the Design / Build phase, mobile network operators are always faced to several design options, and may be willing to compare them from an EE standpoint. This may happen for the whole network, sub-networks and for telecom sites. For telecom sites, EE KPIs have been specified. +- during the Run phase, mobile network operators need to assess the energy efficiency of the live network, as a whole (i.e. end-to-end), or for sub-networks, or for single network elements or telecom sites. Some EE KPIs and measurement methods have also been specified for this purpose. + +NOTE 2: EE KPIs in the present document are only applicable for the Run phase. + +Generally, EE KPIs for network elements are expressed in terms of Data Volume divided by the Energy Consumption of the considered network elements. In the case of radio access networks, an EE KPI variant may also be used, expressed by the Coverage Area divided by the Energy Consumption of the considered network elements. + +The calculation of the energy efficiency of 5G networks relies on the following principles: + +- it is based on the two high-level EE KPIs defined in ETSI ES 203 228 [2]: + +$$EE_{MN,DV} = \frac{DV_{MN}}{EC_{MN}}$$ + +- , and + +$$EE_{MN,CoA} = \frac{coverage\ area}{EC_{MN}}$$ + +- + +- $EE_{MN,DV}$ may apply to the whole 5G network whereas $EE_{MN,CoA}$ may apply only to NG-RAN; +- $EE_{MN,DV}$ requires the collection of both Data Volumes (DV) and Energy Consumption (EC) of 5G Network Functions (NF); +- In NG-RAN, DV is measured per cell; +- In 5GC, DV is measured per NF; +- EC definition and measurement method for 5G PNFs rely on ETSI ES 202 336-1 [3] and ETSI ES 202 336-12 [4]; +- EC is measured by PEE parameters (cf. ETSI ES 202 336-12 [4] – Annexes A and B); + +- PEE measurements requirements for all deployment scenario in NG-RAN: The 3GPP management system responsible for the management of the gNB (single or multiple vendor gNB) shall be able to collect PEE measurements data from all PNFs in the gNB, in the same way as the other PM measurements; +- When gNBCU/gNBCU-CP/gNBCU-UP energy consumption is assumed to be very small compared to gNBDU and given that, in some cases, the gNBCU/gNBCU-CP/gNBCU-UP may be virtualized, the present document only considers the energy consumed in gNBDU(s) (in case of split scenarios) and in non-split gNBs (see clause 4.2.1 of 3GPP TS 28.541 [11] and clause 6.1.1 of 3GPP TS 38.401 [12]). There might be a need for some correction in KPI between the different deployment scenarios. + +NOTE 3: The vendor(s) of 2-split (gNBDU/gNBCU) or 3-split gNB/en-gNB components (gNBDU/gNBCU-CP/gNBCU-UP) may be same or different depending on the implementations. + +- EC definition and measurement method for 5G VNFs are not in the scope of 3GPP; +- In the present document, it is assumed that NG-RAN is only composed of base stations with built-in sensors (cf. ETSI ES 202 336-12 [4] – clause 4.4.1). + +## 4.2 Management services + +The management services required for the assessment of the energy efficiency of 5G networks are listed below: + +- Performance management services (cf. [5] – clause 4.3): + - Measurement job control service for NF. + - Performance data file reporting service for NF. + - Performance data streaming service for NF. +- Management services for network function provisioning (cf. [6] – clause 6.3): + - Provisioning for NF. + - Provisioning data report for NF. +- Management services for Fault Supervision (cf. [7] – clause 4.1.1): + - Fault supervision data report service for NF. + - Fault supervision data control service for NF. + +## 4.3 Energy saving + +### 4.3.1 Introduction + +Operators are aiming at decreasing power consumption in 5G networks to lower their operational expense with energy saving management solutions. With the foreseen deployment of more NR base stations, e.g., small base stations with massive MIMO in high-band, energy saving becomes even more urgent and challenging. + +Management of 5G networks contributes to energy saving by reducing energy consumption of 5G networks, while maintaining coverage, capacity and quality of service. The permitted impact on coverage, capacity and quality of service is determined by operator's decision. + +### 4.3.2 Concepts + +Two energy saving states can be conceptually identified for cells, NEs and NFs. + +Conceptually, a cell or a network element or network function may be on one of these two states with respect to energy saving: + +- notEnergySaving state +- energySaving state + +Based on the above energy saving states, a full energy saving solution includes two elementary procedures: + +- Energy saving activation (change from notEnergySaving state to energySaving state) +- Energy saving deactivation (change from energySaving state to notEnergySaving state) + +When a cell is in energy saving state it may need candidate cells to pick up the load. However a cell in energySaving state should not cause coverage holes or create undue load on the surrounding cells. All traffic on that cell is expected to be drained to other overlaid/umbrella candidate cells before the cell moves to energySaving state. + +A cell in energySaving state is not considered as a cell outage or a fault condition. No alarms should be raised for any condition that is a consequence of a subject cell or network element or network function moving into energySaving state. + +# --- 5 Specification level requirements + +## 5.1 Use cases + +### 5.1.1 Data Volume (DV) collection + +#### 5.1.1.1 Applicability + +The use cases for Data Volume measurement control, data file reporting and streaming in the following clauses 5.1.1.x are valid for all 5GS network functions. + +#### 5.1.1.2 DV measurement control + +Use cases specified in [5] – clause 5.1.1.1 ("NF measurement job control service") – apply for measurement job control of Data Volume. + +Depending on scenarios, NF measurement job control services may not exist. In such a case, the NF measurement control of DV may be achieved as specified in [6] – clause 5.1.18 ("Configuration of a 3GPP NF instance"). + +Traceability: REQ-DVMCS-FUN-001, REQ-DVMCS-FUN-002, REQ-DVMCS-FUN-003, REQ-DVMCS-FUN-004, REQ-DVMCS-FUN-005, REQ-PEEMCS-FUN-006. + +#### 5.1.1.3 DV measurement data file reporting + +Use cases specified in [5] – clause 5.1.1.2 – apply for Data Volume measurement data file reporting, in compliance with [8], [9], [10]. + +Traceability: REQ-DVFRS-FUN-010, REQ-DVFRS-FUN-011. + +#### 5.1.1.4 DV measurement data streaming + +Use cases specified in [5] – clause 5.1.1.3 – apply for Data Volume measurement data streaming. + +Traceability: REQ-DVDS-FUN-020. + +### 5.1.2 Power, Energy and Environmental (PEE) measurement collection + +#### 5.1.2.1 Applicability + +The requirements for PEE measurement control, data file reporting and streaming, fault supervision and configuration management in the following clauses 5.1.2.x are only valid for 5GS physical network functions. + +#### 5.1.2.2 PEE measurement control + +Use cases specified in [5] – clause 5.1.1.1 ("NF measurement job control service") – apply for measurement job control of PEE parameters. + +Depending on scenarios, NF measurement job control services may not exist. In such a case, the NF measurement control of PEE parameters may be achieved as specified in [6] – clause 5.1.18 ("Configuration of a 3GPP NF instance"). + +Traceability: REQ-PEEMCS-FUN-001, REQ-PEEMCS-FUN-002, REQ-PEEMCS-FUN-003, REQ-PEEMCS-FUN-004, REQ-PEEMCS-FUN-005. + +#### 5.1.2.3 PEE measurement data file reporting + +Use cases specified in [5] – clause 5.1.1.2 – apply for PEE measurement data file reporting, in compliance with [8], [9], [10]. + +Traceability: REQ-PEEFRS-FUN-010, REQ-PEEFRS-FUN-011. + +#### 5.1.2.4 PEE measurement data streaming + +Use cases specified in [5] – clause 5.1.1.3 – apply for PEE measurement data streaming. + +Traceability: REQ-PEEDS-FUN-020. + +#### 5.1.2.5 PEE fault supervision + +Use cases specified in [7] – clause 5.1.13 ("Report alarm notifications of NF instance") – apply for PEE fault supervision. + +Traceability: REQ-PEEFSS-FUN-020. + +#### 5.1.2.6 PEE configuration management + +Use cases specified in [6] – clause 5.1.18 - apply for PEE configuration management. + +Traceability: REQ-PEECMS-FUN-030, REQ-PEECMS-FUN-031. + +### 5.1.3 Energy saving use cases + +#### 5.1.3.1 General + +The objective of energy saving is to lower OPEX for mobile operators, through the reduction of power consumption in the mobile networks that is becoming more urgent and challenging, as there are much more network elements in NR (e.g., small cells with massive MIMO in higher frequency bands) than those used in LTE (TR 37.816 [14], TS 38.300 [13]). One typical scenario of energy saving is to switch off capacity boosters when the traffic demand is low, and re-activated them on a need basis (see clause 5.6 in TR 37.816 [14]). + +The energy saving consists of two scenarios where the capacity booster cell - gNB is fully or partially overlaid by the candidate cell(s). + +#### 5.1.3.2 Capacity booster cell partially overlaid by candidate cell(s) + +##### 5.1.3.2.1 Introduction + +Figure 5.1.3.2.1-1 shows that a NR capacity booster cell is partially overlaid by the gNB or eNB candidate cell(s). There can be two cases of energy saving: + +- Intra-RAT energy saving if the candidate cell is a gNB +- Inter-RAT energy saving if the candidate cell is an eNB + +![Diagram showing an NR capacity booster cell partially overlaid by two candidate cells, gNB or eNB candidate cell #A and gNB or eNB candidate cell #B.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +The diagram illustrates a network topology where an NR capacity booster cell is partially overlaid by two candidate cells. At the center is a pink oval representing the 'NR capacity booster cell', which contains a small antenna icon. To the left is a cell tower icon labeled 'gNB or eNB candidate cell #A'. To the right is another cell tower icon labeled 'gNB or eNB candidate cell #B'. Two large, overlapping circles represent the coverage areas of the candidate cells. The central booster cell is positioned such that it is partially covered by both circles, indicating that its coverage area is shared with the candidate cells. + +Diagram showing an NR capacity booster cell partially overlaid by two candidate cells, gNB or eNB candidate cell #A and gNB or eNB candidate cell #B. + +**Figure 5.1.3.2.1-1: NR capacity booster cell partially overlaid by candidate cells** + +Traceability: REQ-ESCOL-FUN-1, REQ-ESCOL-FUN-2, REQ-ESCOL-FUN-3, REQ-ESCOL-FUN-4, REQ-ESCOL-FUN-5, REQ-ESCOL-FUN-6, REQ-ESCOL-FUN-7. + +##### 5.1.3.2.2 Intra-RAT energy saving + +Intra-RAT energy saving focuses on a scenario where the gNB candidate cells provides the coverage for the NR capacity booster cells that is switched off. Intra-RAT energy saving (ES) consists of distributed energy saving where the energy saving decision is made in the NR cells with MnS producer(s) assist to provide relevant information, such as policies, and centralized energy saving where the energy saving decision is made in MnS producer (see clause 15.4 in TS 38.300 [13]). + +For the distributed energy saving, the NR capacity booster cell may decide to enter the energy saving mode when it detects that its traffic load is below certain threshold, and its coverage can be provided by the candidate cells. However, the NR capacity booster cell can be switched off only after the handover actions to off-load its traffic to the candidate cells is completed (see clause 15.4.2 in TS 38.300 [13]). The candidate cell decides to re-activate the NR capacity booster cell when it detects additional capacity is needed (see clause 15.4.2 in TS 38.300 [13]). + +For the centralized energy saving, MnS producer collects the traffic load performance measurements from the NR capacity booster cell and candidate cells, and may request a NR capacity booster cell to enter the energy saving mode when its traffic is below certain threshold. The NR capacity booster may initiate handover actions to off-load the traffic to the neighbouring cells (see clause 15.4.2 in TS 38.300 [13]) prior to entering into the energy saving mode. + +##### 5.1.3.2.3 Inter-RAT energy saving + +Inter-RAT energy saving focuses on a scenario where the LTE eNB provides basic coverage, with the gNB providing the capacity booster that can be switched off, based on its own cell load information or by MnS producer(s). The LTE eNB is allowed to activate the dormant capacity booster NR cell (see clause 5.6 in TR 37.816 [14]). + +Inter-RAT energy saving consists of centralized energy saving where the energy saving decision is made in MnS producer. The inter-RAT energy saving is almost the same as the intra-RAT energy with the exception that the candidate cells are eNB. + +#### 5.1.3.3 Capacity booster cell fully overlaid by candidate cell(s) + +An NG-RAN node, which connects with 5GC to provide boost capacity, may enter into energySaving state if there is radio coverage by other radio systems – be another NG-RAN node or an entity of another radio access technology - for the whole coverage area of the NG-RAN node in question, see figure 5.1.3.3-1 for gNB capacity booster cell fully overlaid by candidate cell(s) case. + +![Figure 5.1.3.3-1: gNB capacity booster cell fully overlaid by candidate cell(s). The diagram shows two states: 'before ES activation' and 'ES is activated'. In the 'before' state, Cell B (gNB not in ES) is inside Cell A (gNB / (e)NB). A UE is connected to Cell A. In the 'ES is activated' state, Cell B is now 'in ES' (Energy Saving) and is disconnected from the UE, which remains connected to Cell A.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +The diagram illustrates the activation of Energy Saving (ES) for a gNB capacity booster cell (Cell B) that is fully overlaid by a candidate cell (Cell A). On the left, labeled 'before ES activation', Cell B is shown as a yellow circle inside a larger yellow circle representing Cell A. Cell B is labeled 'gNB not in ES'. A User Equipment (UE) icon is connected to Cell A. A large grey arrow labeled 'ES activation' points to the right. On the right, labeled 'ES is activated', Cell B is now a grey circle labeled 'Cell B in ES'. The UE is no longer connected to Cell B, and Cell B is disconnected from the network, while Cell A continues to provide coverage. + +Figure 5.1.3.3-1: gNB capacity booster cell fully overlaid by candidate cell(s). The diagram shows two states: 'before ES activation' and 'ES is activated'. In the 'before' state, Cell B (gNB not in ES) is inside Cell A (gNB / (e)NB). A UE is connected to Cell A. In the 'ES is activated' state, Cell B is now 'in ES' (Energy Saving) and is disconnected from the UE, which remains connected to Cell A. + +**Figure 5.1.3.3-1: gNB capacity booster cell fully overlaid by candidate cell(s)** + +This use case applies both for Intra- and Inter-RAT Energy Saving. + +##### Inter-frequency Intra-RAT gNB Coverage + +Two gNB cells (Cell A, Cell B) with separate frequency bands cover the same geographical area. Cell B has a smaller size than Cell A and is covered totally by Cell A. Generally, Cell A is deployed to provide continuous coverage of the area, while Cell B increases the capacity of the special sub-areas, such as hot spots. The ES activation procedure in the coverage of Cell B (ES area) may be triggered in case that light traffic in Cell B is detected. Cell B ES activation may also be triggered when the traffic of ES area (measured by candidate Cell A) resumes to a high level. A Cell B capable of ES probing can execute the ES probing procedure and based on Cell B measurements the centralized or distributed ES management can decide if the Cell B needs to be activated and take portion of the traffic from Cell A. + +##### Inter-RAT gNB Coverage + +Two IRAT cells (Cell A, Cell B) cover the same geographical area. gNB Cell B is totally covered by inter-RAT Cell A (such as legacy system UMTS or LTE). Cell A is deployed to provide continuous coverage of basic eMBB services in the area, while Cell B enhances the capability of the area to support eMBB services with high data rate or URLLC services. The ES activation in the coverage of Cell B (ES area) may be triggered in case that no eMBB services with high data rate or URLLC traffic in Cell B is detected or load threshold for going into energySaving state is reached. Cell B ES deactivation may be triggered when the eMBB services with high data rate or URLLC service request in ES area is restarted again or load threshold for going out of energySaving state (i.e. going into notEnergySaving state) is reached. A Cell B capable of ES probing can execute the ES probing procedure and based on Cell B measurements the centralized or distributed ES management can decide if the Cell B needs to be activated and take portion of the traffic from Cell A. + +Different scenarios of gNB capacity booster cell fully overlaid by candidate cell(s) are listed in below table 5.1.3.3-1. + +**Table 5.1.3.3-1: Different scenarios of gNB capacity booster cell fully overlaid by candidate cell(s)** + +| Scenario | Capacity booster | Coverage provider | Scenario | +|----------|------------------|-------------------|----------------------------| +| 1 | gNB | eNB | Inter-RAT ES | +| 2 | gNB | gNB | Intra-RAT ES | +| 3 | gNB | eNB and gNB | Intra-RAT ES, Inter-RAT ES | +| 4 | gNB | NB | Inter-RAT ES | +| 5 | gNB | eNB and NB | Inter-RAT ES | + +Traceability: REQ-ESCOL-FUN-1, REQ-ESCOL-FUN-2, REQ-ESCOL-FUN-3, REQ-ESCOL-FUN-4, REQ-ESCOL-FUN-5, REQ-ESCOL-FUN-6, REQ-ESCOL-FUN-7. + +## 5.2 Requirements + +### 5.2.1 Requirements for Data Volume (DV) measurement + +#### 5.2.1.1 Applicability + +The requirements for Data Volume measurement control, data file reporting and streaming in the following clauses 5.2.1.x are valid for all 5GS network functions. + +#### 5.2.1.2 Requirements for DV measurement control + +**REQ-DVMCS-FUN-001:** The management service producer responsible for DV measurement control shall have the capability allowing its authorized consumer to request starting the collection of DV measurement data of NF(s). + +**REQ-DVMCS-FUN-002:** The management service producer responsible for DV measurement control shall have the capability allowing its authorized consumer to indicate the reporting method, granularity period, reporting period, etc. for DV measurement data of NF(s). + +**REQ-DVMCS-FUN-003:** The management service producer responsible for DV measurement control shall have the capability to generate the DV measurement data of NF(s) according to the request of the consumer. + +**REQ-DVMCS-FUN-004:** The management service producer responsible for DV measurement control shall have the capability allowing its authorized consumer to request stopping the collection of DV measurement data of NF(s). + +**REQ-DVMCS-FUN-005:** The management service producer responsible for DV measurement control shall have the capability allowing its authorized consumer to query the information about the ongoing collection of DV measurement data of NF(s). + +#### 5.2.1.3 Requirements for DV measurement data file reporting + +**REQ-DVFRS-FUN-010:** The management service producer responsible for DV performance data file reporting shall have the capability to send the notification about DV performance data (of NF(s)) file ready to its authorized consumer. + +**REQ-DVFRS-FUN-011:** The management service producer responsible for DV performance data file reporting shall have the capability to allow its authorized consumer to fetch the DV performance data (of NF(s)) file. + +#### 5.2.1.4 Requirements for DV measurement data streaming service + +**REQ-DVDS-FUN-020:** The management service producer responsible for DV performance data streaming shall have the capability to send the stream containing DV performance data (of NF(s)) to its authorized consumer. + +### 5.2.2 Requirements for Power, Energy and Environmental (PEE) measurement + +#### 5.2.2.1 Applicability + +The requirements for PEE measurement control, data file reporting and streaming, fault supervision and configuration management in the following clauses 5.2.2.x are only valid for 5GS physical network functions. + +#### 5.2.2.2 Requirements for PEE measurement control + +**REQ-PEEMCS-FUN-001:** The management service producer responsible for PEE measurement control shall have the capability allowing its authorized consumer to request starting the collection of PEE measurement data of NF(s). + +**REQ-PEEMCS-FUN-002:** The management service producer responsible for PEE measurement control shall have the capability allowing its authorized consumer to indicate the reporting method, granularity period, reporting period, etc. for PEE measurement data of NF(s). + +**REQ-PEEMCS-FUN-003:** The management service producer responsible for PEE measurement control shall have the capability to generate the PEE measurement data of NF(s) according to the request of the consumer. + +**REQ-PEEMCS-FUN-004:** The management service producer responsible for PEE measurement control shall have the capability allowing its authorized consumer to request stopping the collection of PEE measurement data of NF(s). + +**REQ-PEEMCS-FUN-005:** The management service producer responsible for PEE measurement control shall have the capability allowing its authorized consumer to query the information about the ongoing collection of PEE measurement data of NF(s). + +**REQ-PEEMCS-FUN-006:** The management service producer responsible for PEE measurement control shall have the capability collecting the PEE measurement data of PNF(s) in gNB according to the request of the consumer. + +#### 5.2.2.3 Requirements for PEE measurement data file reporting + +**REQ-PEEFRS-FUN-010:** The management service producer responsible for PEE performance data file reporting shall have the capability to send the notification about PEE performance data (of NF(s)) file ready to its authorized consumer. + +**REQ-PEEFRS-FUN-011:** The management service producer responsible for PEE performance data file reporting shall have the capability to allow its authorized consumer to fetch the PEE performance data (of NF(s)) file. + +#### 5.2.2.4 Requirements for PEE measurement data streaming + +**REQ-PEEDS-FUN-020:** The management service producer responsible for PEE performance data streaming shall have the capability to send the stream containing PEE performance data (of NF(s)) to its authorized consumer + +#### 5.2.2.5 Requirements for PEE fault supervision + +**REQ-PEEFSS-FUN-020:** The management service producer responsible for PEE fault supervision shall have the capability allowing its authorized consumer to be notified in case of PEE related alarms. + +#### 5.2.2.6 Requirements for PEE configuration management + +**REQ-PEECMS-FUN-030:** The management service producer responsible for PEE configuration management shall have the capability allowing its authorized consumer to modify configurable PEE related parameters. + +**REQ-PEECMS-FUN-031:** The management service producer responsible for PEE configuration management shall have the capability allowing its authorized consumer to be notified in case of PEE related configuration changes. + +### 5.2.3 Requirements for energy saving + +#### 5.2.3.1 Requirements for capacity booster cell overlaid by candidate cell(s) + +**REQ-ESCOL-FUN-1:** The management service producer responsible for energy saving should have the capability allowing its authorized consumer to configure the cell overlaid relations, and energy saving policies, and to enable or disable the function for a NR capacity booster cell to enter energy saving mode. + +**REQ-ESCOL-FUN-2:** The management service producer responsible for energy saving should have the capability to send notifications to the authorized consumer to indicate the energy saving mode has been activated or deactivated in the NR capacity booster cell. + +**REQ-ESCOL-FUN-3:** The management service producer responsible for energy saving should have the capability allowing its authorized consumer to collect the traffic load performance measurements of NR capacity booster and candidate cells. + +**REQ-ESCOL-FUN-4:** The management service producer responsible for energy saving should have the capability allowing its authorized consumer to request the NR capacity booster cell to enter the energy saving mode. + +**REQ-ESCOL-FUN-5:** The management service producer responsible for energy saving should have the capability allowing its authorized consumer to deactivate the energy saving mode of a NR capacity booster cell. + +**REQ-ESCOL-FUN-6:** The management service producer responsible for energy saving should have the capability allowing its authorized consumer to configure one or more related cells as the candidate cells to take over the coverage when the original NR capacity booster cell is going into energy saving mode. + +**REQ-ESCOL-FUN-7:** The management service producer responsible for energy saving should have the capability allowing its authorized consumer to request the NR capacity booster cell to leave the energy saving mode. + +## 5.3 Actor roles + +Consumers of management services involved in use cases and requirements - see clauses 5.1 and 5.2. + +## 5.4 Telecommunication resources + +The telecommunication resources include network function management functions and/or the managed network functions. + +# --- 6 Solutions for energy efficiency + +## 6.1 Solutions for assessment of mobile network data energy efficiency + +Assessment of NG-RAN data EE is based on the high-level mobile network data EE KPI defined in clause 3.1 and clause 5.3 of ETSI ES 203 228 [2]: + +$$EE_{MN,DV} = \frac{DV_{MN}}{EC_{MN}}$$ + +NG-RAN data EE KPI is obtained by the data volume divided by Energy Consumption (EC) of the considered network elements. The KPI is defined for both non-split and split gNB scenarios. This KPI is defined in clause 6.7.1 of TS 28.554 [18]. + +The following PEE (Power, Energy and Environmental) measurement may be used as the $EC_{MN}$ : + +- PNF Energy consumption (cf. clause 5.1.1.19.3 of TS 28.552 [15]): This measurement provides the energy consumed (in kilowatt-hours) by the subject gNB. + +## 6.2 Solutions for energy saving + +### 6.2.1 Overview + +For the scenarios where the capacity booster cell is fully or partially overlaid by the candidate cell(s), the key of energy saving solution is that 3GPP management system or NG-RAN node owning the capacity booster cell has the capability to autonomously decide to deactivate such capacity booster cell to lower energy consumption (in energySaving state) or activate the capacity booster cell in energySaving state back to notEnergySaving state due to the increasing traffic above the threshold. The cell activation/deactivation decision is typically based on the load information of the related cells and the energy saving policies set by operators. + +ES activation procedure and ES deactivation procedure may be initiated in different ways as below: + +- Centralized ES solution + - Consumer of centralized MnS for ES requests the producer to configure ES procedure trigger points (e.g. cell traffic load crossing threshold), monitoring the traffic situation of capacity booster cells and candidate cells. + - Consumer of centralized MnS for ES requests the producer to instruct the capacity booster cells to move from notEnergySaving state into energySaving state (e.g. according to some traffic performance measurements which cross below some load thresholds) + - Consumer of centralized MnS for ES requests the producer to instruct the capacity booster cells to move from energySaving state into notEnergySaving state (e.g. according to some traffic performance measurements which cross above some load thresholds) +- Distributed ES solution + - NF provisioning MnS consumer requests the producer to set policies and conditions when these policies/conditions are met, the capacity booster cells will move from notEnergySaving state into + +energySaving state. Examples for policies/conditions are: A time period, during which energy saving is or not allowed; load thresholds to be considered for energy saving decisions; which of the RATs should be considered with priority in Inter-RAT scenario. + +- Based on these policies/conditions and further information - e.g. the operational status of the candidate cell to take over the coverage- the NG-RAN node controls the energy saving procedures (ES activation procedure and ES deactivation procedure) in the network nodes. The network operator is informed about configuration changes which are triggered by the NG-RAN nodes. For example, the gNB owning the capacity booster cells moves itself to/from energySaving state autonomously and sends notifications of configuration changes to operator. + +### 6.2.2 Centralized energy saving solution + +#### 6.2.2.1 Procedures + +##### 6.2.2.1.1 Energy saving activation + +NOTE: The centralized energy saving solution in clause 6.2.2 is Domain-Centralized ES solution because the scope of the centralized ES solution is for NR only. + +Figure 6.2.2.1.1-1 depicts a procedure that describes how MnS producer of Domain Centralized SON ES management makes the NR capacity booster cell enter the energySaving state. + +![Sequence diagram for Centralized energy saving activation. Lifelines: MnS producer of Centralized ES, Performance Assurance MnS producer, Provisioning MnS producer, NR Capacity Booster Cell, NR Cells. The process involves collecting traffic load measurements, analyzing them, and if a decision is made, modifying MOI attributes, configuring the cell, possibly initiating handovers, and finally entering the energySaving state and notifying the MnS producer.](124c6108c63173818afb8ed49521e22d_img.jpg) + +``` + +sequenceDiagram + participant MnS producer of Centralized ES + participant Performance Assurance MnS producer + participant Provisioning MnS producer + participant NR Capacity Booster Cell + participant NR Cells + + Note left of MnS producer: Analyzes traffic load performance measurements + + Note right of Performance Assurance MnS producer: 1. Collects traffic load performance measurements + Note right of Provisioning MnS producer: 1. Collects traffic load performance measurements + + MnS producer->>Performance Assurance MnS producer: 2. Collects traffic load performance measurements + + opt If decision is taken that the NR capacity booster cell should enter the energySaving state + Note right of MnS producer: 3. modifyMOIAttributes (NR Capacity Booster Cell, (energySaving, old value = 'off', new value = 'on')) + MnS producer->>Provisioning MnS producer: 3. modifyMOIAttributes (NR Capacity Booster Cell, (energySaving, old value = 'off', new value = 'on')) + Note right of Provisioning MnS producer: 4. Configures NR Capacity Booster Cell + Provisioning MnS producer->>NR Capacity Booster Cell: 4. Configures NR Capacity Booster Cell + Note right of NR Capacity Booster Cell: 5. May initiate handover actions + Note right of Provisioning MnS producer: 6. Configures Candidate Cells + Provisioning MnS producer->>NR Cells: 6. Configures Candidate Cells + Note right of NR Cells: 7. Enters energySaving state + Note right of Provisioning MnS producer: 8. Informs that energySaving state has changed + Provisioning MnS producer->>MnS producer: 9. notifyMOIAttributeValueChanges (NR Capacity Booster Cell, (energySaving, old value = 'off', new value = 'on')) + end + +``` + +Sequence diagram for Centralized energy saving activation. Lifelines: MnS producer of Centralized ES, Performance Assurance MnS producer, Provisioning MnS producer, NR Capacity Booster Cell, NR Cells. The process involves collecting traffic load measurements, analyzing them, and if a decision is made, modifying MOI attributes, configuring the cell, possibly initiating handovers, and finally entering the energySaving state and notifying the MnS producer. + +Figure 6.2.2.1.1-1: Centralized energy saving activation + +It is assumed that all relevant MOIs have been created. + +###### Energy saving activation: + +The MnS producer for Domain centralized ES collects the traffic load performance measurements from the NR capacity booster cell and candidate cells. + +The MnS producer for Domain centralized ES analyzes the traffic load performance measurements and decides that the NR capacity booster cell should enter the energySaving state. + +The MnS producer for Domain centralized ES consumes the management service for NF provisioning with *modifyMOIAttributes* operation to request the NR capacity booster cell to enter the energySaving state. + +The NR capacity booster cell may initiate handover actions to off-load the traffic to the neighbour cells (see clause 15.4.2 in TS 38.300 [13]), prior to entering into the energySaving state, and then change to the energySaving state, leading to a *notifyMOIAttributeValueChanges* being sent to the MnS producer for Domain centralized ES that the NR capacity booster cell has entered the energySaving state. + +##### 6.2.2.1.2 Energy saving deactivation + +Figure 6.2.2.1.2-1 depicts a procedure that describes how MnS producer of Domain Centralized ES management makes the NR capacity booster cell leave the energySaving state. + +![Sequence diagram for Centralized energy saving deactivation. Lifelines: MnS producer of Centralized ES, Performance Assurance MnS producer, Provisioning MnS producer, NR Capacity Booster Cell, NR Cells. The process involves collecting traffic load measurements, analyzing them, and if capacity is needed, reactivating the NR Capacity Booster cell by modifying its MOI attributes and notifying other components.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant MN1 as MnS producer of Centralized ES + participant MN2 as Performance Assurance MnS producer + participant MN3 as Provisioning MnS producer + participant NRB as NR Capacity Booster Cell + participant NC as NR Cells + + Note left of MN1: 1. Collects traffic load performance measurements + MN2->>MN1: 2. Collects traffic load performance measurements + Note left of MN1: 3. Analyzes traffic load performance measurements + opt if capacity is needed + Note left of MN1: 4. Decision is taken to reactivate the NR capacity booster cell + MN1->>MN3: 5. modifyMOIAttributes (NR Capacity Booster Cell, (energySaving, old value = 'on', new value = 'off')) + MN3->>NRB: 5. Configures NR Capacity Booster Cell + Note right of NRB: 6. May initiate handover actions + MN3->>NC: 7. Configures Candidate Cells + Note right of NRB: 7. Leaves energySaving state + NRB->>MN3: 8. Informs that energySaving state has changed + MN3->>MN1: 9. notifyMOIAttributeValueChanges (NR Capacity Booster Cell, (energySaving, old value = 'on', new value = 'off')) + end + +``` + +Sequence diagram for Centralized energy saving deactivation. Lifelines: MnS producer of Centralized ES, Performance Assurance MnS producer, Provisioning MnS producer, NR Capacity Booster Cell, NR Cells. The process involves collecting traffic load measurements, analyzing them, and if capacity is needed, reactivating the NR Capacity Booster cell by modifying its MOI attributes and notifying other components. + +Figure 6.2.2.1.2-1: Centralized energy saving deactivation + +###### **Energy saving deactivation:** + +The MnS producer for Domain centralized ES collects the traffic load performance measurements from the candidate cells. + +The MnS producer for Domain centralized ES decides to re-activate the NR capacity booster cell if it detects that the capacity is needed (see clause 15.4.2 in TS 38.300 [13]). + +The MnS producer for Domain centralized ES consumes the management service for NF provisioning with *modifyMOIAttributes* operation to re-activate the NR capacity booster cell, and changes to the notEnergySaving state, leading to a *notifyMOIAttributeValueChanges* being sent to the consumer to indicate that the NR capacity booster cell has been re-activated. + +#### **6.2.2.2 Management services** + +##### **6.2.3.2.1 MnS component type A** + +| MnS Component Type A | Note | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| +| Operations defined in clause 11.1.1 of TS 28.532 [16]:
- createMOI
- getMOIAttributes
- modifyMOIAttributes
- deleteMOI | Supported by the Provisioning MnS for NF, as defined in TS 28.531 [6]. | +| Notifications defined in clause 11.1.1 of TS 28.532 [16]:
- notifyMOICreation
- notifyMOIAttributeValueChanges
- notifyMOIDeletion
- notifyMOIChanges | Supported by the Provisioning MnS for NF, as defined in TS 28.531 [6]. | + +##### 6.2.3.2.2 MnS Component Type B + +###### 6.2.3.2.2.1 Objective and targets + +The objective of ES is to automatically set parameters so as to maximize NG-RAN data energy efficiency - see Table 6.2.3.2.2.1-1. + +**Table 6.2.3.2.2.1-1. Energy Saving targets** + +| Targets | Definition | Legal Values | +|-------------------------------|-----------------------------------------------------------------------------------------|--------------| +| NG-RAN data Energy Efficiency | Data Volume (DV) divided by Energy Consumption (EC) of the considered network elements. | In bit/J. | + +###### 6.2.3.2.2.2 Control information + +The parameters in CESManagementFunction IOC, which is defined in TS 28.541 [11], are used to control the Domain-centralized SON ES functionality. + +##### 6.2.3.2.3 MnS Component Type C + +##### 6.2.3.2.3.1 Parameters to be optimized + +This is out of the scope of the present document. + +###### 6.2.3.2.3.2 Performance measurements + +Performance measurements related to Domain-centralized ES are captured in Table 6.2.3.2.3.2-1: + +**Table 6.2.3.2.3.2-1. Energy saving management related performance measurements** + +| Performance measurements | Description | Related targets | +|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| DRB.PdcpsduVolumeDL_Filter | Data Volume (amount of PDCP SDU bits) in the downlink delivered to PDCP layer – see clause 5.1.2.1.1.1 of TS 28.552 [15], per configured PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DRB.PdcpsduVolumeUL_Filter | Data Volume (amount of PDCP SDU bits) in the uplink delivered from PDCP layer to higher layers – see clause 5.1.2.1.2.1 of TS 28.552 [15], per configured PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DL Cell PDCP SDU Data Volume on X2 Interface | Data Volume (amount of PDCP SDU bits) in the downlink delivered on X2 interface in DC-scenarios – see clause 5.1.2.1.1.2 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI or QCI in NR option 3).
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DL Cell PDCP SDU Data Volume on Xn Interface | Data Volume (amount of PDCP SDU bits) in the downlink delivered on Xn interface in DC-scenarios scenarios – see clause 5.1.2.1.1.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| UL Cell PDCP SDU Data Volume on X2 Interface | Data Volume (amount of PDCP SDU bits) in the uplink delivered on X2 interface in NSA scenarios – see clause 5.1.2.1.2.2 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI or QCI in NR option 3).
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| UL Cell PDCP SDU Data Volume on Xn Interface | Data Volume (amount of PDCP SDU bits) in the uplink delivered on Xn interface in SA scenarios – see clause 5.1.2.1.2.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DRB.F1uPdcpsduVolumeDL_Filter | Data Volume (amount of PDCP SDU bits) in the downlink delivered from GNB-CU-UP to GNB-DU (F1-U interface) – see clause 5.1.3.6.2.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI. In case of split gNBs | NG-RAN data Energy Efficiency | +| DRB.XnuPdcpsduVolumeDL_Filter | Data Volume (amount of PDCP SDU bits) in the downlink delivered from GNB-CU-UP to external gNB-CU-UP (Xn-U interface) – see clause 5.1.3.6.2.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI. In case of split gNBs | NG-RAN data Energy Efficiency | +| DRB.X2uPdcpsduVolumeDL_Filter | Data Volume (amount of PDCP SDU bits) in the downlink delivered from GNB-CU-UP to external eNB (X2-U interface) – see clause 5.1.3.6.2.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI). In case of split gNBs. | NG-RAN data Energy Efficiency | +| DRB.F1uPdcpsduVolumeUL_Filter | Data Volume (amount of PDCP SDU bits) in the uplink delivered to GNB-CU-UP from GNB-DU (F1-U interface) – see clause 5.1.3.6.2.4 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI. In case of split gNBs | NG-RAN data Energy Efficiency | +| DRB.XnuPdcpsduVolumeUL_Filter | Data Volume (amount of PDCP SDU bits) in the uplink delivered to GNB-CU-UP from external gNB-CU-UP (Xn-U interface) – see clause 5.1.3.6.2.4 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI. In case of split gNBs | NG-RAN data Energy Efficiency | + +| | | | +|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| DRB.X2uPdcpSduVolumeUL_Filter | Data Volume (amount of PDCP SDU bits) in the uplink delivered to GNB-CU-UP from external eNB (X2-U interface) – see clause 5.1.3.6.2.4 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI). In case of split gNBs. | NG-RAN data Energy Efficiency | +| PNF Energy consumption | Energy consumed – see clause 5.1.1.19.3 of TS 28.552 [15] | NG-RAN data Energy Efficiency | + +### 6.2.3 Distributed energy saving solution + +#### 6.2.3.0 Management service components used for Distributed SON ES solution + +The MnS components used for (Distributed SON ES solution are listed in the following clauses 6.2.3.1.1, 6.2.3.1.2 and 6.2.3.1.3. + +#### 6.2.3.1 Management services + +##### 6.2.3.1.1 MnS component type A + +| MnS Component Type A | Note | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| +| Operations defined in clause 11.1.1 of TS 28.532 [16]:
- createMOI
- getMOIAttributes
- modifyMOIAttributes
- deleteMOI | Supported by the Provisioning MnS for NF, as defined in TS 28.531 [6]. | +| Notifications defined in clause 11.1.1 of TS 28.532 [16]:
- notifyMOICreation
- notifyMOIAttributeValueChanges
- notifyMOIDeletion
- notifyMOIChanges | Supported by the Provisioning MnS for NF, as defined in TS 28.531 [6]. | + +##### 6.2.3.1.2 MnS Component Type B + +###### 6.2.3.1.2.1 Objective and targets + +The objective of ES is to automatically set parameters so as to maximize NG-RAN data energy efficiency - see Table 6.2.3.1.2.1-1. + +**Table 6.2.3.1.2.1-1. Energy Saving targets** + +| Targets | Definition | Legal Values | +|-------------------------------|-----------------------------------------------------------------------------------------|--------------| +| NG-RAN data Energy Efficiency | Data Volume (DV) divided by Energy Consumption (EC) of the considered network elements. | In bit/J. | + +###### 6.2.3.1.2.2 Control information + +The parameters in DESManagementFunction IOC, which is defined in TS 28.541 [11], are used to control the Distributed SON ES functionality. + +##### 6.2.3.1.3 MnS Component Type C + +###### 6.2.3.1.3.1 Parameters to be optimized + +This is out of the scope of the present document. + +###### 6.2.3.1.3.2 Performance measurements + +Performance measurements related to Distributed SON ES are captured in Table 6.2.3.1.3.2-1: + +**Table 6.2.3.1.3.2-1. Energy saving management related performance measurements** + +| Performance measurements | Description | Related targets | +|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| DRB.PdcpSduVolumeDL_Filter | Data Volume (amount of PDCP SDU bits) in the downlink delivered to PDCP layer – see clause 5.1.2.1.1.1 of TS 28.552 [15], per configured PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DRB.PdcpSduVolumeUL_Filter | Data Volume (amount of PDCP SDU bits) in the uplink delivered from PDCP layer to higher layers – see clause 5.1.2.1.2.1 of TS 28.552 [15], per configured PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DL Cell PDCP SDU Data Volume on X2 Interface | Data Volume (amount of PDCP SDU bits) in the downlink delivered on X2 interface in DC-scenarios – see clause 5.1.2.1.1.2 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI or QCI in NR option 3).
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| DL Cell PDCP SDU Data Volume on Xn Interface | Data Volume (amount of PDCP SDU bits) in the downlink delivered on Xn interface in DC-scenarios scenarios – see clause 5.1.2.1.1.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| UL Cell PDCP SDU Data Volume on X2 Interface | Data Volume (amount of PDCP SDU bits) in the uplink delivered on X2 interface in NSA scenarios – see clause 5.1.2.1.2.2 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI or QCI in NR option 3).
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| UL Cell PDCP SDU Data Volume on Xn Interface | Data Volume (amount of PDCP SDU bits) in the uplink delivered on Xn interface in SA scenarios – see clause 5.1.2.1.2.3 of TS 28.552 [15], per PLMN ID and per QoS level (mapped 5QI) and per S-NSSAI.
In case of non-split gNBs. | NG-RAN data Energy Efficiency | +| PNF Energy consumption | Energy consumed – see clause 5.1.1.19.3 of TS 28.552 [15] | NG-RAN data Energy Efficiency | + +#### 6.2.3.2 Procedures + +##### 6.2.3.2.1 Energy saving activation + +Figure 6.2.3.2.1-1 depicts a procedure that describes how MnS producer of Distributed ES management makes the NR capacity booster cell enter the energySaving state. + +![Sequence diagram for Distributed energy saving activation. Lifelines: MnS producer of Distributed ES, Provisioning MnS producer, Distributed Energy Saving function. The process involves configuring cell overlaid relations, ES policy, and switching on energy saving functionality. An optional block titled 'If decision is taken that NR capacity booster cell should enter energySaving state' contains the step to notify MOI attribute value changes.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant MnS producer of Distributed ES + participant Provisioning MnS producer + participant Distributed Energy Saving function + + MnS producer of Distributed ES->>Provisioning MnS producer: 1. modifyMOIAttributes to configure cell overlaid relations + Provisioning MnS producer->>Distributed Energy Saving function: 2. Configure cell overlaid relations + MnS producer of Distributed ES->>Provisioning MnS producer: 3. modifyMOIAttributes to configure ES policy (incl. thresholds) + Provisioning MnS producer->>Distributed Energy Saving function: 4. Configure ES policy (incl. thresholds) + MnS producer of Distributed ES->>Provisioning MnS producer: 5. modifyMOIAttributes to set ESwitch to 'ON' + Provisioning MnS producer->>Distributed Energy Saving function: 6. Switch on energy saving functionality + + opt If decision is taken that NR capacity booster cell should enter energySaving state + Distributed Energy Saving function->>Provisioning MnS producer: 7. Inform that energySaving state has been changed to 'ON' + Provisioning MnS producer->>MnS producer of Distributed ES: 8. notifyMOIAttributeValueChanges (energySaving, old value = 'off', new value = 'on') + end + + MnS producer of Distributed ES + Provisioning MnS producer + Distributed Energy Saving function + +``` + +Sequence diagram for Distributed energy saving activation. Lifelines: MnS producer of Distributed ES, Provisioning MnS producer, Distributed Energy Saving function. The process involves configuring cell overlaid relations, ES policy, and switching on energy saving functionality. An optional block titled 'If decision is taken that NR capacity booster cell should enter energySaving state' contains the step to notify MOI attribute value changes. + +Figure 6.2.3.2.1-1: Distributed energy saving activation + +It is assumed that all relevant MOIs have been created. + +###### Energy saving activation: + +The MnS producer for distributed ES management consumes the management service for NF provisioning with *modifyMOIAttributes* operation to: + +- Configure the cell overlaid relations for NR capacity booster cells, and macro cells as candidate cells +- Configure the ES policy that includes the thresholds for the energy saving activation and deactivation for NR capacity booster cells and candidate cells +- Enable the distribute energy saving function for intra-RAT or inter-RAT. + +NOTE: Void + +The distributed ES function makes decision for the NR capacity booster cell to enter the energySaving state based on the cell traffic load information (see clause 15.4.2 in TS 38.300 [13]). + +The distributed ES function changes to the energySaving state, leading to a *notifyMOIAttributeValueChanges* (see clause 5.1.9 in TS 28.532 [16]) being sent to the MnS producer for distributed ES management to indicate the NR capacity booster has entered the energySaving state. + +##### 6.2.3.2.2 Energy saving deactivation + +Figure 6.2.3.2.2-1 depicts a procedure that describes how Distributed ES function makes the NR capacity booster cell leave the energySaving state. + +![Sequence diagram for Distributed energy saving deactivation. Lifelines: MnS producer of Distributed ES, Provisioning MnS producer, Distributed Energy Saving function. The process involves monitoring traffic load, detecting a need for additional capacity, and then re-activating the cell. An optional block titled 'If decision is taken to re-activate the NR capacity booster cell' contains the step to notify MOI attribute value changes.](f7d969388c4f7e30cd04a061314bfa0e_img.jpg) + +``` + +sequenceDiagram + participant MnS producer of Distributed ES + participant Provisioning MnS producer + participant Distributed Energy Saving function + + Note right of Distributed Energy Saving function: Monitors the traffic load of the candidate cell + Note right of Distributed Energy Saving function: Detects that additional capacity is needed + + opt If decision is taken to re-activate the NR capacity booster cell + Distributed Energy Saving function->>Provisioning MnS producer: 8. Inform that energySaving state has been changed to 'OFF' + Provisioning MnS producer->>MnS producer of Distributed ES: 9. notifyMOIAttributeValueChanges (energySaving, old value = 'on', new value = 'off') + end + + MnS producer of Distributed ES + Provisioning MnS producer + Distributed Energy Saving function + +``` + +Sequence diagram for Distributed energy saving deactivation. Lifelines: MnS producer of Distributed ES, Provisioning MnS producer, Distributed Energy Saving function. The process involves monitoring traffic load, detecting a need for additional capacity, and then re-activating the cell. An optional block titled 'If decision is taken to re-activate the NR capacity booster cell' contains the step to notify MOI attribute value changes. + +Figure 6.2.3.2.2-1: Distributed energy saving deactivation + +###### Energy saving deactivation: + +The distributed ES function monitors the traffic load of candidate cell, and decides to re-activate the NR capacity booster cell when it detects that additional capacity is needed (see clause 15.4.2 in TS 38.300 [13]). + +The distributed ES function changes to the notEnergySaving state, leading to a notifyMOIAttributeValueChanges being sent to the MnS producer for distributed ES management to indicate the NR capacity booster has been re-activated. + +# Annex A (informative): Plant UML source code + +## A.1 Distributed energy saving activation + +``` +@startuml + +title Distributed energy saving activation Diagram + +participant "MnS producer of Distributed ES" as MnSProdDSON +participant "Provisioning MnS producer" as MnSProdProv +participant "Distributed Energy Saving function" as DESFunction + +MnSProdProv <- MnSProdDSON: 1. modifyMOIAttributes to configure cell overlaid relations +DESFunction <- MnSProdProv: 2. Configure cell overlaid relations +MnSProdProv <- MnSProdDSON: 3. modifyMOIAttributes to configure ES policy (incl. thresholds) +DESFunction <- MnSProdProv: 4. Configure ES policy (incl. thresholds) +MnSProdProv <- MnSProdDSON: 5. modifyMOIAttributes to set ESswitch to 'ON' +DESFunction <- MnSProdProv: 6. Switch on energy saving functionality + +opt if decision is taken that NR capacity booster cell should enter energySaving state + +DESFunction -> MnSProdProv: 7. Inform that energySaving state has been changed to 'ON' +MnSProdProv -> MnSProdDSON: 8. notifyMOIAttributeValueChanges (energySaving, old value = 'off', new value = 'on') +end + +@enduml +``` + +## A.2 Distributed energy saving deactivation + +``` +@startuml + +title Distributed energy saving deactivation Diagram + +participant "MnS producer of Distributed ES" as MnSProdDSON +participant "Provisioning MnS producer" as MnSProdProv +participant "Distributed Energy Saving function" as DESFunction + +note over DESFunction: Monitors the traffic load of the candidate cell +note over DESFunction: Detects that additional capacity is needed + +opt if decision is taken to re-activate the NR capacity booster cell + +DESFunction -> MnSProdProv: 8. Inform that energySaving state has been changed to 'OFF' +MnSProdProv -> MnSProdDSON: 9. notifyMOIAttributeValueChanges (energySaving, old value = 'on', new value = 'off') +end + +@enduml +``` + +## A.3 Centralized energy saving activation + +``` +@startuml + +title Centralized energy saving activation Diagram + +participant "MnS producer of Centralized ES" as MnSProdCSON +participant "Performance Assurance MnS producer" as MnSProdPA +participant "Provisioning MnS producer" as MnSProdProv +participant "NR Capacity Booster Cell" as NRCapacityBCell +participant "NR Cells" as NRCandidateCells + +MnSProdPA <- NRCapacityBCell: 1. Collects traffic load performance measurements +MnSProdPA <- NRCandidateCells: 1. Collects traffic load performance measurements + +MnSProdPA -> MnSProdCSON: 2. Collects traffic load performance measurements +``` + +... A - F + +``` + +note over MnSProdCSOn: Analyzes traffic load performance measurements + +opt if decision is taken that the NR capacity booster cell should enter the energySaving state +MnSProdCSOn -> MnSProdProv: 3. modifyMOIAttributes (NR Capacity Booster Cell, (energySaving, +old value = 'off', new value = 'on')) +MnSProdProv -> NRCapacityBCell: 4. Configures NR Capacity Booster Cell +note over NRCapacityBCell: 5. May initiate handover actions +MnSProdProv -> NRCandidateCells: 6. Configures Candidate Cells +note over NRCapacityBCell: 7. Enters energySaving state +NRCapacityBCell -> MnSProdProv: 8. Informs that energySaving state has changed +MnSProdProv -> MnSProdCSOn: 9. notifyMOIAttributeValueChanges (NR Capacity Booster Cell, +(energySaving, old value = 'off', new value = 'on')) +end + +@enduml + +``` + +## A.4 Centralized energy saving deactivation + +``` + +@startuml + +title Centralized energy saving deactivation Diagram + +participant "MnS producer of Centralized ES" as MnSProdCSOn +participant "Performance Assurance MnS producer" as MnSProdPA +participant "Provisioning MnS producer" as MnSProdProv +participant "NR Capacity Booster Cell" as NRCapacityBCell +participant "NR Cells" as NRCandidateCells + +MnSProdPA <- NRCandidateCells: 1. Collects traffic load performance measurements +MnSProdPA -> MnSProdCSOn: 2. Collects traffic load performance measurements +note over MnSProdCSOn: 3. Analyzes traffic load performance measurements + +opt if capacity is needed +note over MnSProdCSOn: 4. Decision is taken to reactivate the NR capacity booster cell +MnSProdCSOn -> MnSProdProv: 5. modifyMOIAttributes (NR Capacity Booster Cell, (energySaving, +old value = 'on', new value = 'off')) +MnSProdProv -> NRCapacityBCell: 5. Configures NR Capacity Booster Cell +note over NRCapacityBCell: 6. May initiate handover actions +MnSProdProv -> NRCandidateCells: 7. Configures Candidate Cells +note over NRCapacityBCell: 7. Leaves energySaving state +NRCapacityBCell -> MnSProdProv: 8. Informs that energySaving state has changed +MnSProdProv -> MnSProdCSOn: 9. notifyMOIAttributeValueChanges (NR Capacity Booster Cell, +(energySaving, old value = 'on', new value = 'off')) +end + +@enduml + +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2020-03 | SA#87-e | SP-200198 | | | | Presented for approval | | 2.0.0 | +| 2020-03 | SA#87-e | | | | | Upgrade to change control version | | 16.0.0 | +| 2020-06 | SA#88-e | SP-200496 | 0001 | 1 | F | Update on D-SON ES solution management service | | 16.1.0 | +| 2020-09 | SA#89-e | SP-200734 | 0002 | - | F | Add missing requirements traceability for energy saving use cases | | 16.2.0 | +| 2020-12 | SA#90e | SP-201047 | 0003 | - | F | Correction on general descriptions of centralized energy saving activation and deactivation | | 16.3.0 | +| 2020-12 | SA#90e | SP-201047 | 0004 | - | F | Corrections on distributed ES solution | | 16.3.0 | +| 2020-12 | SA#90e | SP-201047 | 0005 | - | F | Correction on general descriptions of distributed energy saving activation and deactivation | | 16.3.0 | +| 2020-12 | SA#90e | SP-201047 | 0007 | - | F | Remove the distributed scenario from the inter-RAT energy saving use case | | 16.3.0 | +| 2021-03 | SA#91e | SP-210143 | 0009 | 1 | F | Introducing the ES probing procedure | | 16.4.0 | +| 2021-06 | SA#92e | SP-210408 | 0014 | - | F | Update on energy saving management services | | 16.5.0 | +| 2021-12 | SA#94e | SP-211460 | 0019 | 1 | F | Update energy saving solutions | | 16.6.0 | +| 2023-09 | SA#101 | SP-230940 | 0028 | 1 | F | Update NG-RAN data EE KPI definition with reference to TS 28.554 | | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28311/21ad58fee90f2be50708ff541d225507_img.jpg b/marked/Rel-16/28_series/28311/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..01675ea13b9cb11337d0ff044105d384a45f97a0 --- /dev/null +++ b/marked/Rel-16/28_series/28311/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe1a179d40c7a851b05b31d7809b2a61b5418c9a8443a6dc41a069ccdb651d34 +size 29573 diff --git a/marked/Rel-16/28_series/28311/220869911a1ecfa1dd4aa6d750319aad_img.jpg b/marked/Rel-16/28_series/28311/220869911a1ecfa1dd4aa6d750319aad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7c5f4d631ea5be16a8b32a2e85e2bf9c05a5d13 --- /dev/null +++ b/marked/Rel-16/28_series/28311/220869911a1ecfa1dd4aa6d750319aad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3152ff780dd8dbfccb0e91d5cb4d7f50a37425d278fd6af866fc18d3e09a41e +size 9666 diff --git a/marked/Rel-16/28_series/28311/3da1a07cb87051bf616c9876db958cf0_img.jpg b/marked/Rel-16/28_series/28311/3da1a07cb87051bf616c9876db958cf0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7360f02a2b236ecbefa2f79bf9ba7cac46f4ae63 --- /dev/null +++ b/marked/Rel-16/28_series/28311/3da1a07cb87051bf616c9876db958cf0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:68d4222f10d39164fce2ec9fdee85ea220b3179dc77ceaf908c63abf6eec47d9 +size 49535 diff --git a/marked/Rel-16/28_series/28311/3f1987804d7d78bc3b3bc560e974280a_img.jpg b/marked/Rel-16/28_series/28311/3f1987804d7d78bc3b3bc560e974280a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df9b36ff9fa063bcfe38cf87dbf83f51e877f333 --- /dev/null +++ b/marked/Rel-16/28_series/28311/3f1987804d7d78bc3b3bc560e974280a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30b9d27969bed7313e46481c7f4fa2c6e88d6bfe540a4c0921812ab8110b0dc3 +size 10237 diff --git a/marked/Rel-16/28_series/28311/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/28_series/28311/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0461cc52b7fe6f798a55fb6c36044d7a6471d1d --- /dev/null +++ b/marked/Rel-16/28_series/28311/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81f4ff7bd33682d6a5d91bfafd2031b105ffd114d8857914faee764e6ddac6ab +size 10655 diff --git a/marked/Rel-16/28_series/28311/8273dd9e88cb864939dec7736d4172cb_img.jpg b/marked/Rel-16/28_series/28311/8273dd9e88cb864939dec7736d4172cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..349812661f250f523d853461b88c1b17b060f8dd --- /dev/null +++ b/marked/Rel-16/28_series/28311/8273dd9e88cb864939dec7736d4172cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a56ae60c02db8cf04110410a0b18177f57d5cf54192acdf708e5b244069e1dcd +size 10829 diff --git a/marked/Rel-16/28_series/28311/90ee16ccc0ad16aeca48087797d7b07f_img.jpg b/marked/Rel-16/28_series/28311/90ee16ccc0ad16aeca48087797d7b07f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..281b0a6744e87b4dd48ccb9308e1468dac23af26 --- /dev/null +++ b/marked/Rel-16/28_series/28311/90ee16ccc0ad16aeca48087797d7b07f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f939d05b09d94f1493483f8c713bebf7053c801ad9061924b5d9e1b50b018c09 +size 13848 diff --git a/marked/Rel-16/28_series/28311/99bae07626f60f9ede10e2e387ef7051_img.jpg b/marked/Rel-16/28_series/28311/99bae07626f60f9ede10e2e387ef7051_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d3fe7cee35fd02b323bdfe0ca3d3d835bf07d7d --- /dev/null +++ b/marked/Rel-16/28_series/28311/99bae07626f60f9ede10e2e387ef7051_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7725ba64596f5e0a7f78fa4b80acdf8eba7b51252eb9d0bbb166df3a9a3aa2de +size 62240 diff --git a/marked/Rel-16/28_series/28311/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/marked/Rel-16/28_series/28311/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82bd5f8edcdb636063c490e1739f99806a3a185a --- /dev/null +++ b/marked/Rel-16/28_series/28311/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:073ba07fda93fa01a8444b3d30daba22fba125931ec77a1531526c429ec7bf85 +size 9337 diff --git a/marked/Rel-16/28_series/28311/bffdddb47fced140f8d17fdc2a29f592_img.jpg b/marked/Rel-16/28_series/28311/bffdddb47fced140f8d17fdc2a29f592_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2bcd697a1483cae2f36fa6c75c754558c33d9928 --- /dev/null +++ b/marked/Rel-16/28_series/28311/bffdddb47fced140f8d17fdc2a29f592_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7146f3a3a54badda4080caf082f1e3facca63e628887243f2625ccb0442109a6 +size 10616 diff --git a/marked/Rel-16/28_series/28311/e190b6ddb7c2e64b940749a1c5612256_img.jpg b/marked/Rel-16/28_series/28311/e190b6ddb7c2e64b940749a1c5612256_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54157fdf9e43c23ebabf0828368d8a129dcbd3aa --- /dev/null +++ b/marked/Rel-16/28_series/28311/e190b6ddb7c2e64b940749a1c5612256_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:475c825b39bf738bc987da3fc95ba0e421c16bbc5f2f9aab4d450b86f5f1600c +size 10261 diff --git a/marked/Rel-16/28_series/28311/raw.md b/marked/Rel-16/28_series/28311/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6b985361d20e29c188ac22a02b5aa92fe8792f7c --- /dev/null +++ b/marked/Rel-16/28_series/28311/raw.md @@ -0,0 +1,1951 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 9 | +| 5 Policy management architecture ..... | 9 | +| 6 Business level requirements..... | 10 | +| 6.1 Requirements..... | 10 | +| 6.2 Actor roles ..... | 10 | +| 6.3 Telecommunication resources..... | 10 | +| 6.4 High-level use cases..... | 10 | +| 6.4.1 Deploy the network function ..... | 10 | +| 7 Specification level requirements..... | 10 | +| 7.1 Requirements..... | 10 | +| 7.2 Actor roles ..... | 11 | +| 7.3 Telecommunications resources ..... | 11 | +| 7.4 Use cases ..... | 11 | +| 7.4.1 Create a policy in the context of NFV..... | 11 | +| 7.4.2 Delete a policy in the context of NFV..... | 12 | +| 7.4.3 Update a policy in the context of NFV..... | 12 | +| 7.4.4 Query a policy in the context of NFV ..... | 13 | +| 7.4.5 Activate a policy in the context of NFV..... | 13 | +| 7.4.6 Deactivate a policy in the context of NFV ..... | 14 | +| 7.4.7 Reporting policy conflicts in the context of NFV ..... | 14 | +| 8 Policy management procedures ..... | 14 | +| 8.1 General description for policy management procedures..... | 14 | +| 8.2 Policy Creation..... | 15 | +| 8.3 Policy Deletion..... | 15 | +| 8.4 Policy Update ..... | 15 | +| 8.5 Policy Query..... | 15 | +| 8.6 Policy Activation..... | 16 | +| 8.7 Policy Deactivation ..... | 16 | +| 8.8 Policy Conflicts Notification..... | 16 | +| 9 Information Object Classes..... | 16 | +| 9.1 Information entities imported and local label ..... | 16 | +| 9.2 Class diagram..... | 17 | +| 9.2.1 Attributes and relationships ..... | 17 | +| 9.2.2 Inheritance ..... | 17 | +| 9.3 Information object classes definition ..... | 17 | +| 9.3.1 Policy..... | 17 | +| 9.3.1.1 Definition ..... | 17 | +| 9.3.1.2 Attributes ..... | 18 | +| 9.3.2 PolicyList ..... | 18 | +| 9.3.2.1 Definition ..... | 18 | +| 9.3.2.2 Attributes ..... | 18 | +| 9.3.3 PolicyManagementIRP..... | 18 | +| 9.3.3.1 Definition ..... | 18 | +| 9.3.3.2 Attribute ..... | 18 | +| 9.3.3.3 Notifications..... | 18 | +| 9.4 Information relationship definitions..... | 18 | + +| | | | +|---------------------------------------------------|-----------------------------------------------------|-----------| +| 9.4.1 | relation-PolicyManagementIRP-PolicyList (M) ..... | 18 | +| 9.4.1.1 | Definition ..... | 18 | +| 9.4.1.2 | Role ..... | 18 | +| 9.4.1.3 | Constraint ..... | 19 | +| 9.4.2 | relation-PolicyList-Policy (M) ..... | 19 | +| 9.4.2.1 | Definition ..... | 19 | +| 9.4.2.2 | Role ..... | 19 | +| 9.4.2.3 | Constraint ..... | 19 | +| 9.5 | Information attribute definitions ..... | 19 | +| 9.5.0 | Introduction ..... | 19 | +| 9.5.1 | Definitions and legal values ..... | 20 | +| 10 | Interface definition ..... | 20 | +| 10.1 | Class diagram ..... | 20 | +| 10.2 | PolicyManagementIRPOperations_Interface (M) ..... | 21 | +| 10.2.1 | Operation createPolicy (M) ..... | 21 | +| 10.2.1.1 | Input parameters ..... | 21 | +| 10.2.1.2 | Output parameters ..... | 21 | +| 10.2.1.3 | Results ..... | 21 | +| 10.2.2 | Operation deletePolicy (M) ..... | 21 | +| 10.2.2.1 | Input parameters ..... | 21 | +| 10.2.2.2 | Output parameters ..... | 21 | +| 10.2.2.3 | Results ..... | 21 | +| 10.2.3 | Operation updatePolicy (M) ..... | 22 | +| 10.2.3.1 | Input parameters ..... | 22 | +| 10.2.3.2 | Output parameters ..... | 22 | +| 10.2.3.3 | Results ..... | 22 | +| 10.2.4 | Operation queryPolicy (M) ..... | 22 | +| 10.2.4.1 | Input parameters ..... | 22 | +| 10.2.4.2 | Output parameters ..... | 22 | +| 10.2.4.3 | Results ..... | 23 | +| 10.2.5 | Operation activatePolicy (M) ..... | 23 | +| 10.2.5.1 | Input parameters ..... | 23 | +| 10.3.5.2 | Output parameters ..... | 23 | +| 10.3.5.3 | Results ..... | 23 | +| 10.2.6 | Operation deactivatePolicy (M) ..... | 23 | +| 10.2.6.1 | Input parameters ..... | 23 | +| 10.2.6.2 | Output parameters ..... | 23 | +| 10.2.6.3 | Results ..... | 23 | +| 10.2.7 | Operation queryPolicyList (M) ..... | 24 | +| 10.2.7.1 | Input parameters ..... | 24 | +| 10.2.7.2 | Output parameters ..... | 24 | +| 10.2.7.3 | Results ..... | 24 | +| 10.3 | PolicyManagementIRPNotification_Interface (M) ..... | 24 | +| 10.3.1 | policyConflictNotification ..... | 24 | +| 10.3.1.1 | Input parameters ..... | 24 | +| 10.3.1.2 | Triggering Event ..... | 24 | +| 10.3.1.2.1 | From-state ..... | 24 | +| 10.3.1.2.2 | To-state ..... | 24 | +| 11 | Solution Set (SS) definitions ..... | 24 | +| Annex A (normative): XML definitions ..... | | 26 | +| A.1 | General ..... | 26 | +| A.2 | Architectural features ..... | 26 | +| A.3 | Mapping ..... | 26 | +| A.3.1 | General mapping ..... | 26 | +| A.3.2 | Information Object Class (IOC) mapping ..... | 26 | +| A.4 | Solution Set definitions ..... | 26 | +| A.4.1 | XML definition structure ..... | 26 | + +| | | | +|-------|-----------------------------------------|----| +| A.4.2 | Graphical Representation ..... | 26 | +| A.4.3 | XML Schema “PolicyManagement.xsd” ..... | 26 | + +# **Annex B (normative): SOAP Solution Set ..... 30** + +| | | | +|-----------|-----------------------------------------------------------|----| +| B.1 | General..... | 30 | +| B.2 | Architectural features..... | 30 | +| B.3 | Mapping ..... | 30 | +| B.3.1 | Operation and notification mapping..... | 30 | +| B.3.2 | Operation parameter mapping..... | 30 | +| B.3.2.0 | General ..... | 30 | +| B.3.2.1 | Operation createPolicy ..... | 31 | +| B.3.2.1.1 | Input parameters ..... | 31 | +| B.3.2.1.2 | Output parameters..... | 31 | +| B.3.2.2 | Operation deletePolicy ..... | 31 | +| B.3.2.2.1 | Input parameters ..... | 31 | +| B.3.2.2.2 | Output parameters..... | 31 | +| B.3.2.3 | Operation updatePolicy ..... | 32 | +| B.3.2.3.1 | Input parameters ..... | 32 | +| B.3.2.3.2 | Output parameters..... | 32 | +| B.3.2.4 | Operation queryPolicy ..... | 32 | +| B.3.2.4.1 | Input parameters ..... | 32 | +| B.3.2.4.2 | Output parameters..... | 33 | +| B.3.2.5 | Operation activatePolicy ..... | 33 | +| B.3.2.5.1 | Input parameters ..... | 33 | +| B.3.2.5.2 | Output parameters..... | 33 | +| B.3.2.6 | Operation deactivatePolicy ..... | 33 | +| B.3.2.6.1 | Input parameters ..... | 33 | +| B.3.2.6.2 | Output parameters..... | 33 | +| B.3.2.7 | Operation queryPolicyList ..... | 34 | +| B.3.2.7.1 | Input parameters ..... | 34 | +| B.3.2.7.2 | Output parameters..... | 34 | +| B.3.2.8 | Operation policyConflictNotification ..... | 34 | +| B.3.2.8.1 | Input parameters ..... | 34 | +| B.3.2.8.2 | Output parameters..... | 34 | +| B.4 | Solution Set definitions ..... | 34 | +| B.4.1 | WSDL definition structure ..... | 34 | +| B.4.2 | Graphical Representation ..... | 34 | +| B.4.3 | WSDL specification “PolicyManagementIRPSystem.wsdl” ..... | 34 | + +| | | | +|------------------------|---------------------|----| +| Annex C (informative): | Change history..... | 40 | +|------------------------|---------------------|----| + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document contains the architecture, requirements, use cases, procedures and definitions of interfaces for policy management for 4G networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] ETSI GR NFV-IFA 023 (V3.1.1): "Network Function Virtualisation (NFV); Management and Orchestration; Report on Policy Management in MANO; Release 3". +- [3] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management: Information Service (IS)". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|------|-------------------------------------------------| +| EM | Element Management | +| IRP | Integration Reference Point | +| NE | Network Element | +| NFVI | Network Functions Virtualization Infrastructure | +| NFVO | Network Functions Virtualization Orchestrator | +| NM | Network Management | +| PAF | Policy Administration Function | +| PF | Policy Function | +| VIM | Virtualized Infrastructure Manager | +| VNF | Virtualized Network Function | +| VNFM | VNF Manager | + +# 4 Overview + +NFV policy management system may have policy conflict problem, which is a newly created policy may be conflict with an existing policy. + +There are two potential policy conflict detection approaches, one is policy conflict detection in the Policy Function (PF), which makes the policy execution decisions, and the other one is policy conflict detection in the Policy Administration Function (PAF), which defines the network policy. There are multiple scenarios for policy conflict. For example, if the events are the same and the same condition are triggered (e.g. scaling policy on a VNF), but two policies have different actions, the conflict should be detected and resolved. It is not easy for one PF to resolve all of scenarios of the policy conflict. Hence, it is reasonable to enable PAF to resolve policy conflict, while the conflict detected by PAF or PF based on different specific scenarios, and the present document try to resolve the problem. + +# 5 Policy management architecture + +In order to delegate the support of policy control for virtualized NFs such as automatic scale in/out under certain condition , 3GPP management system would use the ETSI NFV defined related policy features/services. Consequently, two important logical functions are needed for the definition of the 3GPP policy management architecture. + +- 1) Policy Administration Function (PAF) provides the services as follows: + - Allows the operator to define and administrate the network policy +- 2) Policy Function (PF) makes the decision for policy execution and provides the services as follows: + - Activating/deactivating the network policy + - Event subscription/notification of the network policy execution + - Providing relevant data and parameters during the process of policy execution (e.g. execution time consuming) + +The 3GPP global policy management system would affect the behavior of all 3GPP defined nodes and would delegate the support of policy for virtualized NFs in ETSI MANO systems [2]. For NFV related policy management, 3GPP mainly focus on NM acting as PAF and EM acted as PF, and the interface between the NM and EM can be updated to support policy related operations. Hence, 3GPP policy management architecture under NFV scenario is as follows. + +![Diagram of NFV policy management architecture in reference point presentation. It shows the 3GPP management system (NM (PAF) and EM (PF)) interacting with the NFV-MANO (NFVO, VNFM, VIM) and the VNF. Interfaces include Itf-N (add new policy interface), Os-Ma-nfvo, Ve-Vnfm-em, Ve-Vnfm-vnf, and Nf-Vi.](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +The diagram illustrates the NFV policy management architecture. On the left, the '3GPP management system' contains two main components: 'NM (PAF)' at the top and 'EM (PF)' below it. These two components are connected by a vertical interface labeled 'Itf-N(add new policy interface)' in blue. Below the EM (PF) is a 'VNF' block. At the bottom is the 'NFVI' block. On the right, the 'NFV-MANO' system is shown, containing 'NFV Orchestrator (NFVO)', 'VNF Manager (VNFM)', and 'Virtualised Infrastructure Manager (VIM)'. The NM (PAF) connects to the NFVO via the 'Os-Ma-nfvo' interface. The EM (PF) connects to the VNFM via the 'Ve-Vnfm-em' interface. The VNF connects to the VNFM via the 'Ve-Vnfm-vnf' interface. The NFVI connects to the VIM via the 'Nf-Vi' interface. The VNF also connects to the NFVI. + +Diagram of NFV policy management architecture in reference point presentation. It shows the 3GPP management system (NM (PAF) and EM (PF)) interacting with the NFV-MANO (NFVO, VNFM, VIM) and the VNF. Interfaces include Itf-N (add new policy interface), Os-Ma-nfvo, Ve-Vnfm-em, Ve-Vnfm-vnf, and Nf-Vi. + +Figure 5-1: NFV policy management architecture in reference point presentation + +NFV related policy interfaces between 3GPP management system and MANO such as Os-Ma-nfvo and Ve-Vnfm-em have been defined by ETSI. + +# 6 Business level requirements + +## 6.1 Requirements + +**REQ-POM\_PO-CON-1** 3GPP management system should be able to support the capability about the network policy. + +## 6.2 Actor roles + +See detailed actors and roles for each use case in clause 6.4. + +## 6.3 Telecommunication resources + +See detailed telecommunication resources for each use case in clause 6.4. + +## 6.4 High-level use cases + +### 6.4.1 Deploy the network function + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | According to the network deployment policy, 3GPP system use the policy to deploy the corresponding network. | | +| Actors and Roles | NM create/delete/update/query/activate/deactivate the network deployment policy, EM execute the NM's policy operation request, and notifies NM policy conflict, if exist. | | +| Telecom resources | 3GPP management system (EM, NM) | | +| Assumptions | 3GPP management system want to deploy a network | | +| Pre conditions | The operator designs the network deployment requirement and need deploy the network based on the requirement. | | +| Begins when | There is a new network policy about the network deployment. | | +| Step 1 (M) | The operator sets up the network deployment policy through NM. | | +| Step 2 (M) | The NM activates the policy and notifies related EM. | | +| Step 3 (M) | The EM follows the policy to design the network then the network is instantiated by the management system. | | +| Ends when | The EM informs the NM that the policy has been executed. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The network is correctly configured and normally running | | +| Traceability | REQ-POM_PO-CON-1 | | + +# 7 Specification level requirements + +## 7.1 Requirements + +### **REQ-POM-FUN-01** + +The IRPAgent shall provide the capability to allow the IRPManager to create the network policy. + +### **REQ-POM-FUN-02** + +The IRPAgent shall provide the capability to allow the IRPManager to delete the network policy. + +### **REQ-POM-FUN-03** + +The IRPAgent shall provide the capability to allow the IRPManager to update the network policy. + +### **REQ-POM-FUN-04** + +The IRP Agent shall provide the capability to allow the IRP Manager to query the network policy. + +### REQ-POM-FUN-05 + +The IRP Agent shall provide the capability to allow the IRP Manager to activate the network policy. + +### REQ-POM-FUN-06 + +The IRP Agent shall provide the capability to allow the IRP Manager to deactivate the network policy. + +### REQ-POM-FUN-07 + +The IRP Agent should notify the IRP Manager when there is a network policy conflict. + +## 7.2 Actor roles + +See detailed actors and roles for each use case in clause 7.4. + +## 7.3 Telecommunications resources + +See detailed telecommunication resources for each use case in clause 7.4. + +## 7.4 Use cases + +### 7.4.1 Create a policy in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To create a policy such as deploying the SBC from IMS and P-GW from EPC in the same Data Centre. | | +| Actors and Roles | IRP Manager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The systems is correctly configured and normally running. | | +| Begins when | The IRP Manager decides to create a policy. | | +| Step 1 (M) | The IRP Manager makes a decision to create a network policy according to the network requirements, such as deploying the SBC. | | +| Step 2 (M) | After the completion of the policy creation process, the IRP Agent informs the IRP Manager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy is created and stored in the IRP Agent. | | +| Traceability | REQ-POM-FUN -01 | | + +### 7.4.2 Delete a policy in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To delete a policy such as deploying the SBC from IMS and P-GW from EPC in the same Data Center. | | +| Actors and Roles | IRPManager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The systems is correctly configured and normally running. There is a network policy stored in the IRPAgent. | | +| Begins when | The IRPManager decides to delete a policy. | | +| Step 1 (M) | The IPRManager makes a decision to delete the existing policy. | | +| Step 2 (M) | After the completion of the policy deletion process, the IRPAgent informs the IRPManager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy is deleted in the IRPAgent. | | +| Traceability | REQ-POM-FUN -02 | | + +### 7.4.3 Update a policy in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To update an existing network policy. | | +| Actors and Roles | IRPManager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The systems is correctly configured and normally running. There is a network policy stored in the IRPAgent. | | +| Begins when | The IRPManager decides to update a policy. | | +| Step 1 (M) | The IPRManager makes a decision to update the existing policy. | | +| Step 2 (M) | After the completion of the policy update process, the IRPAgent informs the IRPManager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy is updated and stored in the IRPAgent. | | +| Traceability | REQ-POM-FUN -03 | | + +### 7.4.4 Query a policy in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To query an existing network policy. | | +| Actors and Roles | IRPManager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The systems is correctly configured and normally running. There is a network policy stored in the IRPAgent. | | +| Begins when | The IRPManager decides to query a policy. | | +| Step 1 (M) | The IPRManager makes a decision to query the existing policy. | | +| Step 2 (M) | After the completion of the policy query process, the IRPAgent informs the IRPManager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy information is returned to the IPRManager. | | +| Traceability | REQ-POM-FUN -04 | | + +### 7.4.5 Activate a policy in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To activate an existing network policy. | | +| Actors and Roles | IRPManager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The systems is correctly configured and normally running. There is a network policy stored in the IRPAgent. | | +| Begins when | The IRPManager decides to active a policy. | | +| Step 1 (M) | The IPRManager makes a decision to active the existing policy. | | +| Step 2 (M) | After the completion of the policy activation process, the IRPAgent informs the IRPManager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy is activated in the IRPAgent. | | +| Traceability | REQ-POM-FUN -05 | | + +### 7.4.6 Deactivate a policy in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To query an existing network policy. | | +| Actors and Roles | IRPManager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The systems is correctly configured and normally running. There is an active network policy stored in the IRPAgent. | | +| Begins when | The IRPManager decides to deactivate a policy. | | +| Step 1 (M) | The IPRManager makes a decision to deactivate the existing policy. | | +| Step 2 (M) | After the completion of the policy deactivation process, the IRPAgent informs the IRPManager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy is deactivated in the IRPAgent. | | +| Traceability | REQ-POM-FUN -06 | | + +### 7.4.7 Reporting policy conflicts in the context of NFV + +| Use Case Stage | Evolution / Specification | <>
Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To query an existing network policy. | | +| Actors and Roles | IRPManager as user | | +| Telecom resources | 3GPP management system (NM, EM). | | +| Assumptions | 3GPP management systems are running normally, scenarios and policy requirements are clearly defined. | | +| Pre conditions | The system is correctly configured and normally running. There is a network policy stored in the IRPAgent. | | +| Begins when | The IRPManager decides to update a policy. | | +| Step 1 (M) | The IRPManager makes a decision to query the existing policy. | | +| Step 2 (M) | After the completion of the policy conflicts notification process, the IRPAgent informs the IRPManager on the result of the process. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The policy conflicts notification is returned to the IRPManager. | | +| Traceability | REQ-POM-FUN -07 | | + +# 8 Policy management procedures + +## 8.1 General description for policy management procedures + +There are two kinds of management procedures. The first kind includes those operations that allow the NM to invoke policy management operations towards the EM. + +- Policy Creation +- Policy Deletion +- Policy Update +- Policy Query +- Policy Activation +- Policy Deactivation + +The second kind includes the operation that the EM notifies NM policy conflicts found in EM. + +- Policy Conflicts Notification. + +## 8.2 Policy Creation + +After the NM (IRP Manager) decides to create a policy (ies), it will send the create request to the EM (IRP Agent). + +![Sequence diagram showing the policy creation message flow between NM (IRP Manager) and EM (IRP Agent).](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +``` + +sequenceDiagram + participant NM as NM (IRP Manager) + participant EM as EM (IRP Agent) + Note left of NM: Create request + NM->>EM: Create + EM-->>NM: Response + +``` + +Sequence diagram showing the policy creation message flow between NM (IRP Manager) and EM (IRP Agent). + +Figure 8.2: policy creation message flow + +## 8.3 Policy Deletion + +After the NM (IRP Manager) decides to delete a policy (ies), it will send the delete request to the EM (IRP Agent). + +![Sequence diagram for policy deletion message flow between NM (IRP Manager) and EM (IRP Agent).](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant NM as NM (IRP Manager) + participant EM as EM (IRP Agent) + NM->>EM: Delete + EM-->>NM: Response +``` + +A sequence diagram showing the interaction between the NM (IRP Manager) and the EM (IRP Agent) for policy deletion. The NM sends a 'Delete' message to the EM, and the EM responds with a 'Response' message. + +Sequence diagram for policy deletion message flow between NM (IRP Manager) and EM (IRP Agent). + +**Figure 8.3: policy deletion message flow** + +## 8.4 Policy Update + +After the NM (IRP Manager) decides to update a policy (ies), it will send the update request to the EM (IRP Agent). + +![Sequence diagram for policy update message flow between NM (IRP Manager) and EM (IRP Agent).](bffdddb47fced140f8d17fdc2a29f592_img.jpg) + +``` +sequenceDiagram + participant NM as NM (IRP Manager) + participant EM as EM (IRP Agent) + NM->>EM: Update + EM-->>NM: Response +``` + +A sequence diagram showing the interaction between the NM (IRP Manager) and the EM (IRP Agent) for policy update. The NM sends an 'Update' message to the EM, and the EM responds with a 'Response' message. + +Sequence diagram for policy update message flow between NM (IRP Manager) and EM (IRP Agent). + +**Figure 8.4: policy update message flow** + +## 8.5 Policy Query + +After the NM (IRP Manager) decides to query a policy, it will send the query request to the EM (IRP Agent). For the query request, the EM (IRP Agent) sends back the response with the policy to the NM (IRP Manager). + +![Sequence diagram for policy query message flow between NM (IRP Manager) and EM (IRP Agent).](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` +sequenceDiagram + participant NM as NM (IRP Manager) + participant EM as EM (IRP Agent) + NM->>EM: Query + EM-->>NM: Response +``` + +A sequence diagram showing the interaction between the NM (IRP Manager) and the EM (IRP Agent) for policy query. The NM sends a 'Query' message to the EM, and the EM responds with a 'Response' message. + +Sequence diagram for policy query message flow between NM (IRP Manager) and EM (IRP Agent). + +**Figure 8.5: policy query message flow** + +## 8.6 Policy Activation + +After the NM (IRP Manager) decides to activate a policy (ies), it will send the policy activation request to the EM (IRP Agent). + +![Sequence diagram for policy activation message flow between NM (IRP Manager) and EM (IRP Agent).](220869911a1ecfa1dd4aa6d750319aad_img.jpg) + +``` +sequenceDiagram + participant NM as NM (IRP Manager) + participant EM as EM (IRP Agent) + NM->>EM: Active + EM-->>NM: Response +``` + +A sequence diagram showing the interaction between the NM (IRP Manager) and the EM (IRP Agent) for policy activation. The NM sends an 'Active' message to the EM, and the EM responds with a 'Response' message. + +Sequence diagram for policy activation message flow between NM (IRP Manager) and EM (IRP Agent). + +**Figure 8.6: policy activation message flow** + +## 8.7 Policy Deactivation + +After the NM (IRP Manager) decides to deactivate a policy (ies), it will send the policy deactivation request to the EM (IRP Agent). + +![Sequence diagram for policy deactivation message flow between NM (IRP Manager) and EM (IRP Agent).](8273dd9e88cb864939dec7736d4172cb_img.jpg) + +``` +sequenceDiagram + participant NM as NM (IRP Manager) + participant EM as EM (IRP Agent) + NM->>EM: Deactive + EM-->>NM: Response +``` + +A sequence diagram showing the interaction between the NM (IRP Manager) and the EM (IRP Agent) for policy deactivation. The NM sends a 'Deactive' message to the EM, and the EM responds with a 'Response' message. + +Sequence diagram for policy deactivation message flow between NM (IRP Manager) and EM (IRP Agent). + +**Figure 8.7: policy deactivation message flow** + +## 8.8 Policy Conflicts Notification + +When the EM (IRP Agent) receives new or updated policy (ies) from NM (IRP Manager), it will check whether the each received policy is conflicts with the previous storage policy. If the conflict is detected, the EM (IRP Agent) will notify the information to the NM (IRP Manager). + +![Sequence diagram showing a 'Notify' message flow from EM (IRP Agent) to NM (IRP Manager).](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +The diagram is a sequence diagram with two lifelines: NM (IRP Manager) on the left and EM (IRP Agent) on the right. A horizontal arrow labeled 'Notify' points from the EM lifeline to the NM lifeline. Vertical lines extend downwards from the bottom of each box, representing the timeline of each entity. + +Sequence diagram showing a 'Notify' message flow from EM (IRP Agent) to NM (IRP Manager). + +Figure 8.8: policy conflicts notification message flow + +# 9 Information Object Classes + +## 9.1 Information entities imported and local label + +| Label reference | Local label | +|------------------------------------------------------------|-------------------| +| TS 32.312 [3], information object class, ManagedGenericIRP | ManagedGenericIRP | + +## 9.2 Class diagram + +### 9.2.1 Attributes and relationships + +This clause introduces the set of Information Object Classes (IOCs) that encapsulate capabilities contained within the IRP. This clause provides the overview of all support object classes in UML. Subsequent clauses provide more detailed specification of various aspects of these support object classes. + +![UML Class Diagram showing relationships between PolicyManagementIRP, PolicyList, and Policy.](21ad58fee90f2be50708ff541d225507_img.jpg) + +``` +classDiagram + class PolicyManagementIRP["«SupportIOC»\nPolicyManagementIRP"] + class PolicyList["«SupportIOC»\nPolicyList"] + class Policy["«SupportIOC»\nPolicy"] + + PolicyManagementIRP "1" *-- "*" PolicyList : relation-PolicyManagementIRP-PolicyList + PolicyList "1" o-- "*" Policy : relation-PolicyList-Policy +``` + +The diagram shows three classes: **«SupportIOC» PolicyManagementIRP**, **«SupportIOC» PolicyList**, and **«SupportIOC» Policy**. **PolicyManagementIRP** has a composition relationship with **PolicyList** (multiplicity 1 to \*), labeled **relation-PolicyManagementIRP-PolicyList**. **PolicyList** has an aggregation relationship with **Policy** (multiplicity 1 to \*), labeled **relation-PolicyList-Policy**. + +UML Class Diagram showing relationships between PolicyManagementIRP, PolicyList, and Policy. + +Figure 9.2.1: Information Object Class UML Diagram + +### 9.2.2 Inheritance + +This IOC inherits from **ManagedGenericIRP** IOC specified in TS.32.312 [3]. + +![UML Class Diagram showing inheritance from ManagedGenericIRP to PolicyManagementIRP.](90ee16ccc0ad16aeca48087797d7b07f_img.jpg) + +``` +classDiagram + class ManagedGenericIRP["«SupportIOC»\nManagedGenericIRP"] + class PolicyManagementIRP["«SupportIOC»\nPolicyManagementIRP"] + + PolicyManagementIRP --|> ManagedGenericIRP +``` + +The diagram shows **«SupportIOC» PolicyManagementIRP** inheriting from **«SupportIOC» ManagedGenericIRP**. + +UML Class Diagram showing inheritance from ManagedGenericIRP to PolicyManagementIRP. + +Figure 9.2.2: Information Object Class UML Diagram + +## 9.3 Information object classes definition + +### 9.3.1 Policy + +#### 9.3.1.1 Definition + +This IOC represents a network policy. + +#### 9.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWriteble | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| policyId | M | T | F | T | T | +| policyPriority | M | T | T | F | T | +| policyStatus | M | T | T | F | T | +| policyType | M | T | T | F | T | +| policyContent | M | T | T | F | T | + +### 9.3.2 PolicyList + +#### 9.3.2.1 Definition + +PolicyList is the representation of the list of Policy. + +#### 9.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWriteble | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| policyListId | M | T | F | T | T | +| policyIdList | M | T | F | T | T | + +### 9.3.3 PolicyManagementIRP + +#### 9.3.3.1 Definition + +PolicyManagementIRP is the representation of the policy management capabilities specified by the present document. This Support IOC inherits from ManagedGenericIRP Support IOC specified in 3GPP TS 32.312 [x]. + +#### 9.3.3.2 Attribute + +There is no additional attribute defined for this IOC besides those inherited. + +#### 9.3.3.3 Notifications + +| Name | Qualifier | Notes | +|----------------------------|-----------|--------------------------------------------------------------------------------------------------------| +| policyConflictNotification | M | If there is network policy conflict(s), then the IRPAgent may send this notification to the IPRmanager | + +## 9.4 Information relationship definitions + +### 9.4.1 relation-PolicyManagementIRP-PolicyList (M) + +#### 9.4.1.1 Definition + +This represents the relationship between PolicyManagementIRP and PolicyList. + +#### 9.4.1.2 Role + +| Name | Definition | +|------------------------|----------------------------------------| +| thePolicyList | It represents the PolicyList. | +| thePolicyManagementIRP | It represents the PolicyManagementIRP. | + +#### 9.4.1.3 Constraint + +| Name | Definition | +|--------------------|---------------------------------------------------------------------------------------------------------| +| uniquePolicyListId | The policyListIds playing the role of thePolicyList are unique within a particular PolicyManagementIRP. | + +### 9.4.2 relation-PolicyList-Policy (M) + +#### 9.4.2.1 Definition + +This represents the relationship between `PolicyList` and `Policy`. + +#### 9.4.2.2 Role + +| Name | Definition | +|----------------------------|---------------------------------------------| +| thePolicy | It represents the Policy . | +| thePolicyList | It represents the PolicyList . | + +#### 9.4.2.3 Constraint + +| Name | Definition | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| uniquePolicyId | The policyIds of all Policys , playing the role of the Policy , are unique within a particular PolicyManagementIRP and PolicyList . | + +## 9.5 Information attribute definitions + +### 9.5.0 Introduction + +This clause defines the semantics of the attributes used in `SupportIOCs`. + +### 9.5.1 Definitions and legal values + +| Attribute Name | Definition | Legal Values | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| +| policyId | It identifies the Policy instance (and distinguishes it from all other existing and stopped Policy instances of the PolicyManagementIRP Agent). | Any identifier. Value type is string. | +| policyPriority | It specifies the priority of Policy | Its value should be one of the following:
Low,
Medium,
High | +| policyStatus | It specifies the status of Policy . If a policy is activated, and then its status is active. If it is deactivated ,then its status is deactivated | Its value should be one of the following:
Activated,
Deactivated | +| policyType | It identifies a name of one policy type | Its value is network operator specific.
Value type is string. | +| policyContent | It identifies the content of a network policy | Its value is network operator specific.
Value type is string. | +| policyListId | It identifies the singleton PolicyList of the PolicyManagementIRP Agent. | Any identifier. Value type is string. | +| policyIdList | It is an array list of Policy.policyId . | Value type is array. | +| policyConflictNotification | It specifies which policies conflict. | Its value is vendor specific. Value type is string. | + +# 10 Interface definition + +## 10.1 Class diagram + +![UML Class Diagram showing PolicyManagementIRP as a base class for PolicyManagementIRPOperations and PolicyManagementIRPNotification.](3da1a07cb87051bf616c9876db958cf0_img.jpg) + +``` + +classDiagram + class PolicyManagementIRP { + <> + } + class PolicyManagementIRPOperations { + <> + createPolicy() + deletePolicy() + updatePolicy() + queryPolicy() + activatePolicy() + deactivatePolicy() + listPolicys() + } + class PolicyManagementIRPNotification { + <> + policyConflictNotification() + } + PolicyManagementIRP <|-- PolicyManagementIRPOperations + PolicyManagementIRP <|-- PolicyManagementIRPNotification + +``` + +UML Class Diagram showing PolicyManagementIRP as a base class for PolicyManagementIRPOperations and PolicyManagementIRPNotification. + +Figure 10.1: Class Diagram + +## 10.2 PolicyManagementIRPOperations\_Interface (M) + +### 10.2.1 Operation createPolicy (M) + +#### 10.2.1.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|--------------------------------------------------| +| designer | M | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy.name | See clause 9.5.1 (definitions and legal values). | +| policyPriority | M | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy.policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy.policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.1.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|--------------------------------------------------| +| designer | M | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy.name | See clause 9.5.1 (definitions and legal values). | +| policyId | M | Policy.policyId | See clause 9.5.1 (definitions and legal values). | +| policyPriority | M | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy.policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy.policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.1.3 Results + +In case of success, the corresponding policy information is created by the EM (IRP Agent). In case of failure, appropriate error information is returned. + +### 10.2.2 Operation deletePolicy (M) + +#### 10.2.2.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|----------------------|--------------------------------------------------| +| policyId | M | Policy.policyId | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.2.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|--------------------------------------------------------------------------------------| +| designer | M | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy.name | See clause 9.5.1 (definitions and legal values). | +| policyId | M | Policy.policyId | The policyId of the deleted policy. See clause 9.5.1 (definitions and legal values). | +| policyPriority | M | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy.policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy.policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.2.3 Results + +In case of success, the policy information are deleted by the EM (IRP Agent), and the corresponding deleted policy information is returned to the NM (IRP Manager). In case of failure, appropriate error information is returned. + +### 10.2.3 Operation updatePolicy (M) + +#### 10.2.3.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|-------------------------------------------------------------------------------------------------------| +| designer | O | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | O | Policy.name | See clause 9.5.1 (definitions and legal values). | +| policyId | M | Policy.policyId | See clause 9.5.1 (definitions and legal values). This parameter's value is not allowed to be updated. | +| policyPriority | O | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). This parameter's value is allowed to be updated. | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). This parameter's value is allowed to be updated. | +| policyType | O | Policy.policyType | See clause 9.5.1 (definitions and legal values). This parameter's value is allowed to be updated. | +| policyContent | O | Policy.policyContent | See clause 9.5.1 (definitions and legal values). This parameter's value is allowed to be updated. | + +#### 10.2.2.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|--------------------------------------------------------------------------------------| +| designer | M | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy.name | See clause 9.5.1 (definitions and legal values). | +| policyId | M | Policy.policyId | The policyId of the deleted policy. See clause 9.5.1 (definitions and legal values). | +| policyPriority | M | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy.policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy.policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.2.3 Results + +In case of success, the corresponding policy information is updated by the EM (IRP Agent). In case of failure, appropriate error information is returned. + +### 10.2.4 Operation queryPolicy (M) + +#### 10.2.4.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|----------------------|--------------------------------------------------| +| policyId | M | Policy.policyId | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.4.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|--------------------------------------------------------------------------------------| +| designer | M | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy.name | See clause 9.5.1 (definitions and legal values). | +| policyId | M | Policy.policyId | The policyId of the deleted policy. See clause 9.5.1 (definitions and legal values). | +| policyPriority | M | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy.policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy.policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.4.3 Results + +In case of success, the corresponding policy information is returned by the EM (IRP Agent). In case of failure, appropriate error information is returned. + +### 10.2.5 Operation activatePolicy (M) + +#### 10.2.5.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|----------------------|--------------------------------------------------| +| policyId | M | Policy.policyId | See clause 9.5.1 (definitions and legal values). | + +#### 10.3.5.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|-----------------------|--------------------------------------------------------------------------------------| +| designer | M | Policy.designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy.name | See clause 9.5.1 (definitions and legal values). | +| PolicyId | M | Policy.policyId | See clause 9.5.1 (definitions and legal values). Identifier of the activated Policy. | +| policyPriority | M | Policy.policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy.policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy.policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy.policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.3.5.3 Results + +In case of success, the policy(ies) information are activated by the EM (IRP Agent) , and the activated policy information is returned to the NM (IRP Manager). In case of failure, appropriate error information is returned. + +### 10.2.6 Operation deactivatePolicy (M) + +#### 10.2.6.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|----------------------|--------------------------------------------------| +| policyId | M | Policy. policyId | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.6.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|------------------------|--------------------------------------------------------------------------------------| +| designer | M | Policy. designer | See clause 9.5.1 (definitions and legal values). | +| name | M | Policy. name | See clause 9.5.1 (definitions and legal values). | +| PolicyId | M | Policy. policyId | See clause 9.5.1 (definitions and legal values). Identifier of the activated Policy. | +| policyPriority | M | Policy. policyPriority | See clause 9.5.1 (definitions and legal values). | +| policyStatus | M | Policy. policyStatus | See clause 9.5.1 (definitions and legal values). | +| policyType | M | Policy. policyType | See clause 9.5.1 (definitions and legal values). | +| policyContent | M | Policy. policyContent | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.6.3 Results + +In case of success, the policy(ies) information are deactivated by the EM (IRP Agent), and the deactivated policy information is returned to the NM (IRP Manager). In case of failure, appropriate error information is returned. + +### 10.2.7 Operation queryPolicyList (M) + +#### 10.2.7.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|--------------------------|--------------------------------------------------| +| policyListId | M | PolicyList. policyListId | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.7.2 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|--------------------------|--------------------------------------------------| +| policyListId | M | PolicyList. policyListId | See clause 9.5.1 (definitions and legal values). | +| policyIdList | M | PolicyList. policyIdList | See clause 9.5.1 (definitions and legal values). | + +#### 10.2.7.3 Results + +In case of success, the EM (IRP Agent) returns the corresponding policy information. In case of failure, appropriate error information is returned. + +## 10.3 PolicyManagementIRPNotification\_Interface (M) + +### 10.3.1 policyConflictNotification + +#### 10.3.1.1 Input parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|---------------------|-----------|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------| +| activatedPolicyList | M | List of and their corresponding policy is activated. | See clause 9.5.1 (definitions and legal values). Identifier(s) of the activated Policy. | + +#### 10.3.1.2 Triggering Event + +##### 10.3.1.2.1 From-state + +internalProblem + +| Assertion Name | Definition | +|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| internalProblem | Because of a network policy conflict's problem, PolicyManagementIRP Agent decides that it no longer can maintain the policy in any policyStatus but "deactivated". | + +##### 10.3.1.2.2 To-state + +policyConflictNotification + +| Assertion Name | Definition | +|----------------------------|-------------------------------------| +| policyConflictNotification | There is network policyconflict(s). | + +# --- 11 Solution Set (SS) definitions + +The present document defines the following policy management Solution Set Definitions: + +- Annex A provides the XML Definitions. +- Annex B provides the SOAP Solution Set. + +# Annex A (normative): XML definitions + +## A.1 General + +This annex contains the XML definitions for the policy management Integration Reference Point. + +## A.2 Architectural features + +The overall architectural feature of policy management IRP is specified, this clause specifies features that are specific to the Schema definitions. + +The present document provides the main part of the XML file format definition for the policy management IRP IS. + +The other parts of this XML definition are NRM-specific parts. All NRM IRPs that include SS-level XML definition are in the scope of the policy management IRP. + +## A.3 Mapping + +### A.3.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the Information Model. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the Information Model. + +### A.3.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of the present document. + +## A.4 Solution Set definitions + +### A.4.1 XML definition structure + +Clause A.4.2 provides a graphical representation of the XML elements. + +Clause A.4.3 provides the schema fragment for policy management (policy creation/deletion/update/query/activation/deactivation/conflicts notification) XML files. + +### A.4.2 Graphical Representation + +The graphical representation is not present in the current version of the present document. + +### A.4.3 XML Schema “PolicyManagement.xsd” + +``` + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex B (normative): SOAP Solution Set + +## B.1 General + +This annex contains the XML definitions for the policy management Integration Reference Point. + +## B.2 Architectural features + +The overall architectural feature of the policy management IRP is specified in the present document. This clause specifies features that are specific to the SOAP Solution Set. + +The present document uses "document" style in the WSDL description. + +The present document uses "literal" encoding style in the WSDL description. + +## B.3 Mapping + +### B.3.1 Operation and notification mapping + +Policy management IRP management: Clause 9 defines semantics of operation visible across the Itf-N. Table B.3 indicates mapping of these operations to their equivalents defined in this SS. + +**Table B.3: Mapping from IS Operation to SS Equivalents** + +| IS Operation | SS Operation | Qualifier | +|----------------------------|----------------------------|-----------| +| createPolicy | createPolicy | M | +| deletePolicy | deletePolicy | M | +| updatePolicy | updatePolicy | M | +| queryPolicy | queryPolicy | M | +| activatePolicy | activatePolicy | M | +| deactivatePolicy | deactivatePolicy | M | +| queryPolicyList | queryPolicyList | M | +| policyConflictNotification | policyConflictNotification | M | + +### B.3.2 Operation parameter mapping + +#### B.3.2.0 General + +The clause 10 defines semantics of parameters carried in operations. The tables below show the mapping of these parameters, as per operation, to their equivalents defined in this SS. + +#### B.3.2.1 Operation `createPolicy` + +##### B.3.2.1.1 Input parameters + +**Table B.3.2.1.1: Mapping from IS `createPolicy` input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +##### B.3.2.1.2 Output parameters + +**Table B.3.2.1.2: Mapping from IS createPolicy output parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +#### B.3.2.2 Operation deletePolicy + +##### B.3.2.2.1 Input parameters + +**Table B.3.2.2.1: Mapping from IS deletePolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| policyId | policyInfoId | M | + +##### B.3.2.2.2 Output parameters + +**Table B.3.2.2.2: Mapping from IS deletePolicy output parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +#### B.3.2.3 Operation updatePolicy + +##### B.3.2.3.1 Input parameters + +**Table B.3.2.3.1: Mapping from IS updatePolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | O | +| name | name | O | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | O | +| policyStatus | policyStatus | M | +| policyType | policyType | O | +| policyContent | policyContent | O | + +##### B.3.2.3.2 Output parameters + +**Table B.3.2.3.2: Mapping from IS updatePolicy output parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +#### B.3.2.4 Operation queryPolicy + +##### B.3.2.4.1 Input parameters + +**Table B.3.2.4.1: Mapping from IS queryPolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| policyId | policyInfoId | M | + +##### B.3.2.4.2 Output parameters + +**Table B.3.2.4.2: Mapping from IS queryPolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +#### B.3.2.5 Operation activatePolicy + +##### B.3.2.5.1 Input parameters + +**Table B.3.2.5.1: Mapping from IS activatePolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| policyId | policyInfoId | M | + +##### B.3.2.5.2 Output parameters + +**Table B.3.2.5.2: Mapping from IS startSession input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +#### B.3.2.6 Operation deactivatePolicy + +##### B.3.2.6.1 Input parameters + +**Table B.3.2.6.1: Mapping from IS deactivatePolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| policyId | policyInfoId | M | + +##### B.3.2.6.2 Output parameters + +**Table B.3.2.6.2: Mapping from IS deactivatePolicy input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| designer | designer | M | +| name | name | M | +| policyId | policyInfoId | M | +| policyPriority | policyPriority | M | +| policyStatus | policyStatus | M | +| policyType | policyType | M | +| policyContent | policyContent | M | + +#### B.3.2.7 Operation queryPolicyList + +##### B.3.2.7.1 Input parameters + +**Table B.3.2.7.1: Mapping from IS listPolicys input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| policyListId | policyListId | M | + +##### B.3.2.7.2 Output parameters + +**Table B.3.2.7.2: Mapping from IS listPolicys output parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| policyListId | policyListId | M | +| policyIdList | policyIdList | M | + +#### B.3.2.8 Operation policyConflictNotification + +##### B.3.2.8.1 Input parameters + +**Table B.3.2.8.1: Mapping from IS policyConflictNOtification output parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| activatedPolicyList | activatedPolicyList | M | + +##### B.3.2.8.2 Output parameters + +Void. + +## B.4 Solution Set definitions + +### B.4.1 WSDL definition structure + +The present document defines the main part of what are supported by the policy management IRP agent. + +### B.4.2 Graphical Representation + +The graphical representation is not present in the current version of the present document. + +### B.4.3 WSDL specification “PolicyManagementIRPSystem.wsdl” + +``` + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|------------------|------------------------------------------------------------------------------------------------------|----|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2018-09 | | | | | | Skeleton | | 0.0.0 | +| 2018-10 | SA5#121 | S5-186398
S5-186468 | | | | Update to implement the agreed pCRs in SA5#121:
S5-186398 pCR 28.311 Add Scope
S5-186468 Rel-16 draft TS Skeleton 28.311 | | 0.1.0 | +| 2018-11 | SA5#122 | S5-187385
S5-187386 | | | | Update to implement the agreed pCRs in SA5#122:
S5-187385 Add Policy management architecture
S5-187386 Add Business level requirements | | 0.2.0 | +| 2019-06 | SA5#125
Adhoc | S5-194428
S5-194429
S5-194430
S5-194431
S5-194432
S5-194433
S5-194434
S5-194435 | | | | Update to implement the agreed pCRs in SA5#125Adhoc:
S5-194428 Policy Management Procedures
S5-194429 Policy Creation
S5-194430 Policy Deletion
S5-194431 Policy Update
S5-194432 Policy Query
S5-194433 Policy Activation
S5-194434 Policy Deactivation
S5-194435 Policy Conflicts Notification | | 0.3.0 | +| 2019-08 | SA5#126 | S5-195179
S5-195843
S5-195845
S5-195846
S5-195847 | | | | Update to implement the agreed pCRs in SA5#126:
S5-195179 Add abbreviations
S5-195843 Add references
S5-195845 Add overview
S5-195846 Rewrite business level requirements
S5-195847 Add specification level requirements | | 0.4.0 | +| 2019-10 | SA5#127 | S5-196658 | | | | Update to implement the agreed pCRs in SA5#127:
S5-196658 Add Solution Set(SS) definitions | | 0.5.0 | +| 2019-11 | SA5#128 | S5-197763
S5-197764
S5-197765
S5-197766 | | | | Update to implement the agreed pCRs in SA5#128:
S5-197763 pCR 28.311 Add Information Object Classes
S5-197764 pCR 28.311 Add XML definition
S5-197765 pCR 28.311 Add SOAP Solution Set
S5-197766 pCR 28.311 Rewrite interface | | 0.6.0 | +| 2019-12 | SA#86 | SP-191185 | | | | Presented for information and approval | | 1.0.0 | +| 2019-12 | SA#86 | | | | | Change control version | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28312/raw.md b/marked/Rel-16/28_series/28312/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e06fb64ca3c460cbfef2270ba3d99b28e1989a92 --- /dev/null +++ b/marked/Rel-16/28_series/28312/raw.md @@ -0,0 +1,296 @@ + + +# 3GPP TS 28.312 V0.1.0 (2020-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Intent driven management services for mobile networks (Release 17 )** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, stylized font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 Concepts and Background ..... | 7 | +| 4.1 Intent concept ..... | 7 | +| 4.1.1 Introduction ..... | 7 | +| 4.1.2 Intent categorizes based on user types..... | 7 | +| 4.1.3 Intent categorizes based on management scenario types..... | 7 | +| 4.2 Intent driven MnS..... | 8 | +| 4.3 Intent driven closed-loop..... | 8 | +| 5 Specification Level Requirements ..... | 9 | +| 5.1 Use cases ..... | 9 | +| 5.2 Requirements..... | 9 | +| 6 Stage 2 definition for Intent Driven Management ..... | 9 | +| 7 Stage 3 definition for Intent Driven Management ..... | 9 | +| Annex <X> (informative): Change history ..... | 10 | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 + +**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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +# --- 1 Scope + +The present document specifies concept, use cases, requirements and solutions for the intent driven management for service or network management. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +... + +[x] <#> [ (up to and including) {yyyy[-mm]}V } [onwards] ] ] : "". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +**Intent:** A desire to reach a certain state for a specific service or network management workflow. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +<symbol> <Explanation> + +## 3.3 Abbreviations + +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]. + +<ABBREVIATION> <Expansion> + +# 4 Concepts and Background + +Editor's note: this clause will contain concepts and overview information relevant to the intent driven management. + +## 4.1 Intent concept + +### 4.1.1 Introduction + +An intent is a desire to reach a certain state/position for a specific service or network management workflow. The intent expression information may include particular objective and possibly some related details. Intent can be categorized based on different user types or different management scenario types. + +### 4.1.2 Intent categorizes based on user types + +Based on roles related to 5G networks and network slicing management defined in clause 4.8 in TS 28.530[X], different kinds of intents are applicable for different kinds of standardized reference interfaces. + +![Figure 4.1.2-1: High-level model of different kind of intents expressed by different roles. The diagram shows a vertical stack of roles and their interactions. From top to bottom: Communication Service Customer (Client), Communication Service Provider (Provider), Network Operator (Client), Virtualization Infrastructure Service Provider (Provider), and Data Center Service Provider (Client). These are paired with Network Equipment Provider (incl. VNF Supplier), NFVI Supplier, and Hardware Supplier (all Providers). Dashed lines labeled Intent-CSC, Intent-CSP, and Intent-NOP connect the top three roles to their respective intent types. A bracket on the left groups the top two roles with the text 'E.g.: End user, Small & Medium Enterprise, Large enterprise, Vertical, Other CSP, etc.'](e2c1c672349c10dccb2563eff6d8260e_img.jpg) + +``` + +graph TD + subgraph Roles + CSC[Communication Service Customer] -- Client --> CSP[Communication Service Provider] + CSP -- Provider --> NO[Network Operator] + NO -- Client --> VISP[Virtualization Infrastructure Service Provider] + VISP -- Provider --> DCSP[Data Center Service Provider] + end + NO -- Client --> NEP[Network Equipment Provider incl. VNF Supplier] + VISP -- Provider --> NFVI[NFVI Supplier] + DCSP -- Client --> HS[Hardware Supplier] + CSC -.-> IntentCSC[Intent-CSC] + CSP -.-> IntentCSP[Intent-CSP] + NO -.-> IntentNOP[Intent-NOP] + E["E.g.: End user, Small & Medium Enterprise, Large enterprise, Vertical, Other CSP, etc."] -.-> CSC + E -.-> CSP + +``` + +Figure 4.1.2-1: High-level model of different kind of intents expressed by different roles. The diagram shows a vertical stack of roles and their interactions. From top to bottom: Communication Service Customer (Client), Communication Service Provider (Provider), Network Operator (Client), Virtualization Infrastructure Service Provider (Provider), and Data Center Service Provider (Client). These are paired with Network Equipment Provider (incl. VNF Supplier), NFVI Supplier, and Hardware Supplier (all Providers). Dashed lines labeled Intent-CSC, Intent-CSP, and Intent-NOP connect the top three roles to their respective intent types. A bracket on the left groups the top two roles with the text 'E.g.: End user, Small & Medium Enterprise, Large enterprise, Vertical, Other CSP, etc.' + +Figure 4.1.2-1: High-level model of different kind of intents expressed by different roles + +- **Intent from Communication Service Customer (Intent-CSC):** Intent from Communication Service Customer enables Communication Service Customer (CSC) to provide what CSC would like to do for the communication service without knowing how to do the detailed management for communication service. For example, Intent-CSC can be 'Enable a V2X communication service for a group of vehicles in certain time'. +- **Intent from Communication Service Provider (Intent-CSP):** Intent from Communication Service Provider enables Communication Service Provider (CSP) to express an intent about what CSP would like to do for network without knowing how to do the detailed management for network. For example, Intent-CSP can be 'Provide a network service supporting V2X communications for highway-417 to support 500 vehicles simultaneously'. +- **Intent from Network Operator (Intent-NOP):** Intent from Network Operator enables Network Operator (NOP) to provide what NOP would like to do for group of network elements (i.e. subnetwork) management and control without knowing how to do the detailed management for the network elements. For example, Intent-NOP can be 'Provide a radio network service to satisfy the specified coverage requirements and UE throughput requirement in certain area'. + +### 4.1.3 Intent categorizes based on management scenario types + +Based on different the scenarios for network and service management, different kinds of intents are applicable for different kinds of management scenario types. + +- **Intent for network and service design/planning** +- **Intent for network and service deployment** +- **Intent for network and service maintenance** + +- **Intent for network and service optimization/assurance** + +**Editor's Note:** the detailed intent categorizes for different kinds of management scenario types need to be further discussed, for example, whether the Intent for network and service design/planning and Intent for network and service maintenance is needed. + +## 4.2 Intent driven MnS + +Introduction of service-based architecture for 5G, in combination with functional model of business roles, exceeds the level of complexity for managing network in different scenarios (including scenarios for design/planning, deployment, maintenance and optimization) both in a single and multivendor network. New/simpler ways of managing are needed. + +An Intent driven MnS allows its consumer to express intents for managing the network and services and obtain the feedback of intent evaluation result. The Intent-driven MnS producer have the following capabilities: + +- Translate the received intent to executable actions as follows: + - Performing service or network management tasks + - Identifying, formulating and activating service or network management policies +- Evaluate the result/information about the intent fulfilment (e.g. the intent is satisfied or not). + +The following figure 4.2-1 shows the model of Intent-driven MnS. + +![Figure 4.2-1: Intent-driven MnS diagram showing MnS Consumer, Intent-driven MnS, and MnS Producer components.](7affafe7362a2d2d072e9d4bf515f0bb_img.jpg) + +The diagram shows a vertical stack of three components. At the top is a rectangular box labeled 'MnS Consumer'. Below it is a small circle with a dot inside, labeled 'Intent-driven MnS'. At the bottom is a rectangular box labeled 'MnS Producer'. All three components are connected by a single vertical line. + +Figure 4.2-1: Intent-driven MnS diagram showing MnS Consumer, Intent-driven MnS, and MnS Producer components. + +**Figure 4.2-1: Intent-driven MnS** + +The MnS of various kinds are specified for deployment over many standardized reference interfaces. So, the Intent-driven MnS could in principle, be specified for deployment over the same set of standardized reference interfaces, as a replacement of or as an addition to the deployed non-Intent driven MnS. + +## 4.3 Intent driven closed-loop + +Intent can be used for management and control of closed-loop automation (e.g. intent can be used as the goals for the closed-loop), which means the intent can be translated to policies and management tasks by MnS producer to execute the closed-loop automation. In the intent driven management approach, how MnS producer using closed-loop automation mechanisms to satisfy the intent is the implementation of the MnS producer and shall not be standardized. The closed-loop automation of Intent driven MnS producer is shown in the figure 4.3-1. + +![Figure 4.3-1: Intent driven closed-loop diagram showing the interaction between Intent driven MnS Consumer, Intent driven MnS Producer, and ManagedEntity.](ef7a88e04d1939ee09bafd5c3072adf8_img.jpg) + +The diagram illustrates a closed-loop system. At the top, a box labeled 'Intent driven MnS Consumer' is connected to a central box labeled 'Intent driven MnS Producer' via two arrows: a downward arrow labeled 'Intent' and an upward arrow labeled 'Feedback'. Below the 'Intent driven MnS Producer' is a box labeled 'ManagedEntity'. A dashed rectangular box encloses the 'Intent driven MnS Producer' and the 'ManagedEntity'. Inside this dashed box, a curved arrow on the left points from the 'ManagedEntity' back to the 'Intent driven MnS Producer', labeled 'Continuously monitoring'. Another curved arrow on the right points from the 'Intent driven MnS Producer' to the 'ManagedEntity', labeled 'Continuously adjust to fulfill the intent requirement'. + +Figure 4.3-1: Intent driven closed-loop diagram showing the interaction between Intent driven MnS Consumer, Intent driven MnS Producer, and ManagedEntity. + +**Figure 4.3-1 Intent driven closed-loop** + +# --- 5 Specification Level Requirements + +Editor's note: this clause will contain specific use case and requirements for intent driven management. + +## 5.1 Use cases + +Editor's note: this clause will contain specific use case for intent driven management. The use case can be categorized into some sub-clauses (e.g. one sub-clause for deployment related use case, and one sub-clause for optimization related use cases) + +## 5.2 Requirements + +Editor's note: this clause will contain specific requirements for intent driven management. + +# --- 6 Stage 2 definition for Intent Driven Management + +Editor's note: this clause will specify the stage2 definition for Intent driven management which may include the management operations, management entities and management information + +# --- 7 Stage 3 definition for Intent Driven Management + +Editor's note: this clause will specify the solution set for Intent Driven Management defined in clause 6. + +# --- Annex <X> (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-------------------------------------|----|-----|-----|---------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-10 | SA5#127 | S5-196174 | | | | TS 28.312_000 | 0.0.0 | +| 2020-08 | SA5#132<br>e | S5-204460<br>S5-204461<br>S5-204462 | | | | 1. pCR 28.312 Add scope<br>2. pCR 28.312 Add skeleton<br>3. pCR 28.312 Add concept and background | 0.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28313/raw.md b/marked/Rel-16/28_series/28313/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..672f686c82f1c14b600173646b972ed621ba8db8 --- /dev/null +++ b/marked/Rel-16/28_series/28313/raw.md @@ -0,0 +1,1526 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Self-Organizing Networks (SON) for 5G networks (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +# **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + +<http://www.3gpp.org> + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions of terms, symbols and abbreviations ..... | 9 | +| 3.1 Terms..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Concepts and background ..... | 9 | +| 4.1 SON concepts..... | 9 | +| 4.1.1 Overview ..... | 9 | +| 4.1.2 Centralized SON..... | 10 | +| 4.1.2.1 Introduction..... | 10 | +| 4.1.2.2 Cross Domain-Centralized SON..... | 11 | +| 4.1.2.3 Domain-Centralized SON..... | 11 | +| 4.1.3 Distributed SON ..... | 11 | +| 4.1.4 Hybrid SON..... | 12 | +| 4.2 Self-establishment of new RAN NE in network ..... | 12 | +| 4.2.1 Introduction ..... | 12 | +| 4.2.2 Network configuration data handling..... | 13 | +| 4.2.3 Plug and connect to management system..... | 13 | +| 4.2.4 Self-configuration ..... | 13 | +| 5 Business level requirements..... | 13 | +| 5.1 Requirements..... | 13 | +| 5.1.1 Distributed SON management..... | 13 | +| 5.2 Actor roles ..... | 13 | +| 5.3 Telecommunication resources..... | 14 | +| 6 Specification level requirements..... | 14 | +| 6.1 Requirements..... | 14 | +| 6.1.1 Distributed SON management..... | 14 | +| 6.1.1.1 RACH Optimization (Random Access Optimisation)..... | 14 | +| 6.1.1.2 MRO (Mobility Robustness Optimisation)..... | 14 | +| 6.1.1.3 ANR management in NG-RAN..... | 14 | +| 6.1.1.4 PCI configuration and re-configuration ..... | 15 | +| 6.1.2 Centralized SON..... | 15 | +| 6.1.2.1 PCI configuration..... | 15 | +| 6.1.2.2 Requirements for RAN NE plug and connect to management system..... | 15 | +| 6.1.2.3 Requirements for self-configuration of a new RAN NE ..... | 15 | +| 6.2 Actor roles ..... | 15 | +| 6.3 Telecommunication resources..... | 15 | +| 6.4 Use cases ..... | 16 | +| 6.4.1 Distributed SON management..... | 16 | +| 6.4.1.1 RACH Optimization (Random Access Optimisation)..... | 16 | +| 6.4.1.2 MRO (Mobility Robustness Optimisation)..... | 17 | +| 6.4.1.3 ANR management..... | 18 | +| 6.4.1.3.1 Starting the ANR function..... | 18 | +| 6.4.1.3.2 Stopping the ANR function..... | 18 | +| 6.4.1.3.3 Sending notification of added or deleted NCR ..... | 19 | +| 6.4.1.3.4 Handover Whitelisting ..... | 19 | +| 6.4.1.3.5 Handover Blacklisting..... | 20 | +| 6.4.1.3.6 Prohibiting X2 or Xn connection to a peer node (X2/Xn blacklisting) ..... | 20 | +| 6.4.1.3.7 Prohibiting handover over X2 or Xn (X2/Xn handover blacklisting)..... | 21 | +| 6.4.1.4 PCI configuration..... | 21 | + +| | | | +|---------------------------------------------------------|-------------------------------------------------------------------|-----------| +| 6.4.1.4.1 | Initial PCI configuration..... | 21 | +| 6.4.1.4.2 | PCI re-configuration..... | 22 | +| 6.4.2 | Centralized SON..... | 22 | +| 6.4.2.1 | PCI configuration..... | 22 | +| 6.4.2.1.1 | Initial PCI configuration..... | 22 | +| 6.4.2.1.2 | PCI re-configuration..... | 23 | +| 6.4.2.2 | Use case for establishment of a new RAN NE in network..... | 23 | +| 6.4.2.2.1 | Use case for RAN NE plug and connect to management system ..... | 23 | +| 6.4.2.2.2 | Use case for self-configuration of a new RAN NE..... | 25 | +| 7 | Management services for SON ..... | 27 | +| 7.1 | Management services for D-SON management..... | 27 | +| 7.1.1 | RACH Optimization (Random Access Optimisation) ..... | 27 | +| 7.1.1.1 | MnS component type A ..... | 27 | +| 7.1.1.2 | MnS Component Type B definition..... | 27 | +| 7.1.1.2.1 | Targets information ..... | 27 | +| 7.1.1.2.2 | Control information..... | 27 | +| 7.1.1.2.3 | Parameters to be updated..... | 28 | +| 7.1.1.3 | MnS Component Type C definition..... | 28 | +| 7.1.1.3.1 | Performance measurements..... | 28 | +| 7.1.2 | MRO (Mobility Robustness Optimisation) ..... | 28 | +| 7.1.2.1 | MnS component type A ..... | 28 | +| 7.1.2.2 | MnS Component Type B definition..... | 28 | +| 7.1.2.2.1 | Targets information ..... | 28 | +| 7.1.2.2.2 | Control information..... | 29 | +| 7.1.2.2.3 | Parameters to be updated..... | 29 | +| 7.1.2.3 | MnS Component Type C definition..... | 29 | +| 7.1.2.3.1 | Performance measurements..... | 29 | +| 7.1.3 | PCI configuration ..... | 30 | +| 7.1.3.1 | MnS component type A ..... | 30 | +| 7.1.3.2 | MnS Component Type B definition..... | 31 | +| 7.1.3.2.1 | Control information..... | 31 | +| 7.1.3.2.2 | Parameters to be updated..... | 31 | +| 7.1.3.3 | MnS Component Type C definition..... | 31 | +| 7.1.3.3.1 | Notification information..... | 31 | +| 7.1.4 | ANR management ..... | 31 | +| 7.2 | Management services for C-SON ..... | 32 | +| 7.2.1 | PCI configuration ..... | 32 | +| 7.2.1.1 | MnS component type A ..... | 32 | +| 7.2.1.2 | MnS Component Type B definition..... | 32 | +| 7.2.1.2.1 | Control information..... | 32 | +| 7.2.1.2.2 | Parameters to be updated..... | 32 | +| 7.2.1.3 | MnS Component Type C definition..... | 32 | +| 7.2.1.3.1 | Notifications information ..... | 32 | +| 7.2.1.3.2 | Performance measurements..... | 33 | +| 8 | SON procedures ..... | 33 | +| 8.1 | Introduction ..... | 33 | +| 8.2 | Distributed SON management ..... | 33 | +| 8.2.1 | RACH Optimization (Random Access Optimisation) ..... | 33 | +| 8.2.2 | MRO (Mobility Robustness Optimisation) ..... | 34 | +| 8.2.3 | PCI configuration ..... | 36 | +| 8.2.3.1 | Initial PCI configuration ..... | 36 | +| 8.2.3.2 | PCI re-configuration ..... | 37 | +| 8.3 | Centralized SON ..... | 37 | +| 8.3.1 | PCI configuration ..... | 37 | +| 8.3.1.1 | Initial PCI configuration ..... | 37 | +| 8.3.1.2 | PCI re-configuration ..... | 38 | +| 8.3.2 | Procedures for establishment of a new RAN NE in network ..... | 39 | +| 8.3.2.1 | Procedures for RAN NE plug and connect to management system ..... | 39 | +| 8.3.2.2 | Procedures for self-configuration management..... | 40 | +| <b>Annex A (informative): PlantUML source code.....</b> | | <b>42</b> | + +A.1 Procedures for establishment of a new RAN NE in network ..... 42 +A.1.1 Procedure for plug and connect to management system..... 42 +A.1.2 Procedure for self-configuration management..... 42 +**Annex B (informative): Change history ..... 44** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project Technical Specification Group Services and System Aspects Management and orchestration of networks, as identified below: + +**TS 28.313: Management and orchestration; Self-Organizing Networks (SON) for 5G networks.** + +TS 28.552: Management and orchestration; 5G performance measurements. + +TS 28.541: Management and orchestration; Self-Organizing Networks (SON) Network Resource Model (NRM) for 5G networks. + +# --- 1 Scope + +The present document specifies the concepts, use cases, requirements, and procedures for the SON functions in 5GS. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.500: "Telecommunication Management; Self-Organizing Networks (SON); Concepts and requirements". +- [3] 3GPP TS 28.532: "Management and orchestration; Generic management services" +- [4] 3GPP TS 38.321 "NR; Medium Access Control (MAC) protocol specification". +- [5] 3GPP TS 28.552 "Management and orchestration; 5G performance measurements". +- [6] 3GPP TS 32.511 " Telecommunication management; Automatic Neighbour Relation (ANR) management; Concepts and requirements". +- [7] 3GPP TS 38.300 "NR; Overall description; Stage-2". +- [8] Void +- [9] 3GPP TS 38.331: "NR; Radio Resource Control (RRC) protocol specification". +- [10] Void +- [11] 3GPP TS 28.531 "Management and orchestration; Provisioning". +- [12] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [13] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [14] Void +- [15] 3GPP TS 32.508: "Telecommunication management; Procedure flows for multi-vendor plug-and-play eNodeB connection to the network". +- [16] 3GPP TS 38.133: "NR; Requirements for support of radio resource management". +- [17] Void + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +**Centralized SON (C-SON):** SON solution where SON algorithms are executed in the 3GPP management system. Centralized SON has two variants: + +- **Cross Domain-Centralized SON:** SON solution where SON algorithms are executed in the 3GPP Cross Domain layer. +- **Domain-Centralized SON:** SON solution where SON algorithms are executed in the Domain layer. + +**Distributed SON (D-SON):** SON solution where SON algorithms are executed in the Network Function layer. + +**Hybrid SON:** SON solution where SON algorithms are executed at two or more of the following layers: NF layer or Domain layer or 3GPP Cross Domain layer. + +**Searchlist:** list of frequencies and supporting information to be used for neighbour cell measurements, which contains entries for NG-RAN and supported IRATs. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|--------|--------------------------------------| +| ANR | Automatic Neighbour Relation | +| NCR | Neighbour Cell Relation | +| NG-RAN | Next Generation Radio Access Network | + +# 4 Concepts and background + +## 4.1 SON concepts + +### 4.1.1 Overview + +Based on the location of the SON algorithm, SON is categorized into four different solutions that are possible for implementing various SON use cases, the solution is selected depending on the needs of the SON use cases. + +- a) Centralized SON: + - 1) Cross Domain-Centralized SON + - 2) Domain-Centralized SON +- b) Distributed SON +- c) Hybrid SON. + +The SON algorithm is not standardized by 3GPP. + +The following figure illustrates the overview of SON Framework. + +![Figure 4.1.1-1: Overview of SON Framework. The diagram shows three stacked layers. The top layer is '3GPP Cross Domain Layer' containing 'Cross Domain-Centralized SON'. The middle layer is 'Domain Layer' containing 'Domain-Centralized SON'. The bottom layer is 'Network Function Layer' containing 'Distributed SON'. Double-headed vertical arrows connect the top layer to the middle, and the middle to the bottom. Red ovals encircle the SON components in each layer, and red arrows point from the layer name to the SON component within it.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +Figure 4.1.1-1: Overview of SON Framework. The diagram shows three stacked layers. The top layer is '3GPP Cross Domain Layer' containing 'Cross Domain-Centralized SON'. The middle layer is 'Domain Layer' containing 'Domain-Centralized SON'. The bottom layer is 'Network Function Layer' containing 'Distributed SON'. Double-headed vertical arrows connect the top layer to the middle, and the middle to the bottom. Red ovals encircle the SON components in each layer, and red arrows point from the layer name to the SON component within it. + +**Figure 4.1.1-1: Overview of SON Framework** + +### 4.1.2 Centralized SON + +#### 4.1.2.1 Introduction + +Centralized SON (C-SON) means that the SON algorithm executes in the 3GPP management system. The centralized SON concept has been defined for LTE in TS 32.500 [2]. + +Figure 4.1.2.1-1 shows a generic C-SON process, where the SON algorithms execute in the 3GPP management system interact with network functions in RAN and/or CN to implement SON functions. The SON algorithm may consist of the following functionalities: + +- Monitoring: monitor the network(s) by collecting management data, including the data provided by MDAS. +- Analysis: analyse the management data to determine if there are issues in the network(s) that need to be resolved. +- Decision: makes the decision on the SON actions to resolve the issues. +- Execution: execute the SON actions. +- Evaluation: evaluate whether the issues have been solved by analysing the management data + +**NOTE:** The management data as well as the exact algorithm may vary for different SON cases. For example, for automated creation of NSI, NSSI and/or NFs related cases, the management data may be SLA requirements received from service management layer; for automated optimization related cases, the management data may be performance measurements of the networks; for automated healing related cases, the management data may be alarm information of the networks. The management data and the algorithm are to be specified case by case. + +![Diagram of the C-SON process. A central '3GPP management system' oval contains a 'SON algorithm' loop: Monitoring -> Evaluation -> Execution -> Decision -> Analysis. A 'No' from Analysis loops back to Monitoring, and a 'Yes' from Analysis leads to Execution. Below the management system are two ovals: 'NF (CN)' on the left and 'NF (RAN)' on the right. Green double-headed arrows connect the 'SON algorithm' loop to both the 'NF (CN)' and 'NF (RAN)' ovals.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +Diagram of the C-SON process. A central '3GPP management system' oval contains a 'SON algorithm' loop: Monitoring -> Evaluation -> Execution -> Decision -> Analysis. A 'No' from Analysis loops back to Monitoring, and a 'Yes' from Analysis leads to Execution. Below the management system are two ovals: 'NF (CN)' on the left and 'NF (RAN)' on the right. Green double-headed arrows connect the 'SON algorithm' loop to both the 'NF (CN)' and 'NF (RAN)' ovals. + +Figure 4.1.2.1-1: C-SON process + +#### 4.1.2.2 Cross Domain-Centralized SON + +The Cross Domain-Centralized SON means that the SON algorithm executes in the 3GPP Cross Domain layer. + +For Cross Domain-Centralized SON, the MnF(s) in 3GPP Cross Domain layer monitors the networks via management data, analyses the management data, makes decisions on the SON actions, and executes the SON actions. + +#### 4.1.2.3 Domain-Centralized SON + +The Domain-Centralized SON means the SON algorithm executes in the Domain layer. + +For Domain-Centralized SON, the MnF(s) in Domain layer monitors the networks via management data, analyses the management data, makes decisions on the SON actions, and executes the SON actions. + +The MnF(s) in 3GPP Cross Domain is responsible for management and control of the Domain-Centralized SON function. The management and control may include switching on/off a Domain-Centralized SON function, making policies for a Domain-Centralized SON function, and/or evaluating the performance of a Domain-Centralized SON function. + +### 4.1.3 Distributed SON + +The distributed SON (D-SON) means that the SON algorithm is located in the NFs. The distributed SON concept has been defined for LTE in TS 32.500 [2]. + +For D-SON, the NFs monitors the network events, analyses the network data, makes decisions on the SON actions and executes the SON actions in the network nodes. + +Figure 4.1.3-1 shows that the 3GPP management system (MnF in Domain or 3GPP Cross Domain) is responsible for the following functions: + +a) D-SON management function: + +- 1) Switch on/off a D-SON function, +- 2) Provide policies, targets, and supplementary information (e.g., the range attributes) for a D-SON function. + +b) D-SON evaluation function: evaluate whether the issues have been resolved, and may apply D-SON management actions. + +![Figure 4.1.3-1: D-SON process diagram. At the top, a large oval labeled '3GPP management system' contains two stacked boxes: 'D-SON management' and 'D-SON evaluation' connected by a double-headed arrow. Below this, two circles labeled 'NF (CN)' and 'NF (RAN)' are shown. Each circle contains a circular arrow diagram with four colored segments (blue, red, yellow, green) and the text 'SON algorithm'. Green arrows point from the 'D-SON evaluation' box in the management system to the 'SON algorithm' in both the NF (CN) and NF (RAN) circles.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +Figure 4.1.3-1: D-SON process diagram. At the top, a large oval labeled '3GPP management system' contains two stacked boxes: 'D-SON management' and 'D-SON evaluation' connected by a double-headed arrow. Below this, two circles labeled 'NF (CN)' and 'NF (RAN)' are shown. Each circle contains a circular arrow diagram with four colored segments (blue, red, yellow, green) and the text 'SON algorithm'. Green arrows point from the 'D-SON evaluation' box in the management system to the 'SON algorithm' in both the NF (CN) and NF (RAN) circles. + +Figure 4.1.3-1: D-SON process + +### 4.1.4 Hybrid SON + +The hybrid SON (H-SON) means the SON algorithm are executed at two or more of the following levels: NF layer, Domain layer or 3GPP Cross Domain layer. The hybrid SON concept has been defined for LTE in TS 32.500 [2]. + +The 3GPP management system (i.e. MnF(s) in Domain or 3GPP Cross Domain) and NFs work together, in a coordinated manner, to build up a complete SON algorithm. The decisions on SON actions may be made by 3GPP management system and/or NFs, depending on the specific cases. + +Figure 4.1.4-1 shows that the C-SON component is monitoring and executes SON actions. + +![Figure 4.1.4-1: H-SON process diagram. At the top, a large oval labeled '3GPP management system' contains a flowchart: 'Monitoring' -> 'Evaluation' -> 'Execution' -> 'Decision' -> 'Analysis'. 'Analysis' has a 'Yes' path to 'Execution' and a 'No' path back to 'Monitoring'. Below this, the text 'SON algorithm' is present. Below the management system, two circles labeled 'NF (CN)' and 'NF (RAN)' are shown. Each circle contains a circular arrow diagram with four colored segments (blue, red, yellow, green) and the text 'SON algorithm'. Green arrows point from the 'SON algorithm' text in the management system to the 'SON algorithm' in both the NF (CN) and NF (RAN) circles.](fbfa653853daf5541118a9ddecb92284_img.jpg) + +Figure 4.1.4-1: H-SON process diagram. At the top, a large oval labeled '3GPP management system' contains a flowchart: 'Monitoring' -> 'Evaluation' -> 'Execution' -> 'Decision' -> 'Analysis'. 'Analysis' has a 'Yes' path to 'Execution' and a 'No' path back to 'Monitoring'. Below this, the text 'SON algorithm' is present. Below the management system, two circles labeled 'NF (CN)' and 'NF (RAN)' are shown. Each circle contains a circular arrow diagram with four colored segments (blue, red, yellow, green) and the text 'SON algorithm'. Green arrows point from the 'SON algorithm' text in the management system to the 'SON algorithm' in both the NF (CN) and NF (RAN) circles. + +Figure 4.1.4-1: H-SON process + +## 4.2 Self-establishment of new RAN NE in network + +### 4.2.1 Introduction + +Self-establishment of new RAN NE in network describes the procedure of a new NG-RAN NE can automatically establish when it is powered up and connect to the IP network in multi-vendor scenario, which includes: + +- Network Configuration data handling + +- Plug and connect to management system +- Self-Configuration + +### 4.2.2 Network configuration data handling + +Network configuration data handling makes the network configuration data available to the management system support self-configuration process, which may include network configuration data preparation, network configuration data transfer and network configuration data validation. This happens except all of the network configuration data for NE can be generated by the management system supporting self-configuration process. + +**Network configuration data preparation:** This makes the network configuration data ready in operator's network management system who provides the network configuration data. How to prepare the network configuration data in operator's network management system is out of scope of the present document. + +**Network configuration data transfer:** This transfers the Network configuration data from network configuration data Provider to the network configuration data Consumer. + +**Network configuration data validation:** This validates the syntax and semantics of network configuration data. It takes place in the network configuration data Consumer. + +### 4.2.3 Plug and connect to management system + +Plug and connect to management system connects the deployed NE to its management system providing support for self-configuration process as automatically as possible. The following functionality is included: initial IP Autoconfiguration service, Certificate enrolment, establish secure connection, establish connect to management system providing support for self-configuration process. + +### 4.2.4 Self-configuration + +Self-configuration puts the NE into a state to be ready to carry traffic in an automated manner. Self-configuration includes following functionality: create self-configuration task, monitor self-configuration process, generate configuration data if needed, download and activate software, download and active configuration data, perform self-test and update network resource model, etc. + +# --- 5 Business level requirements + +## 5.1 Requirements + +### 5.1.1 Distributed SON management + +**REQ-NR-ANR-CON-01** For NG-RAN ANR management, the initial status of a newly created NCR by the ANR function to a NG-RAN cell shall be such that HO is allowed, X2 or Xn connection setup is allowed, and the NCR is allowed to be removed by the ANR function in the gNB. + +**REQ-NR-ANR-CON-02** NG-RAN ANR management shall support NCRs from NG-RAN to NG-RAN and from NG-RAN to E-UTRAN. + +**REQ-NR-ANR-CON-03** For E-UTRAN ANR management, the initial status of a newly created NCR by ANR function to a NG-RAN cell shall be such that HO is allowed, X2 connection setup is allowed, and the NCR is allowed to be removed by the ANR function in the eNB. + +**REQ-NR-ANR-CON-04** E-UTRAN ANR management shall support NCRs from E-UTRAN to NG-RAN, in addition to support to other technologies, described in TS 32.511 [6] clause 5.1. + +## 5.2 Actor roles + +Not applicable + +## 5.3 Telecommunication resources + +Not applicable + +# --- 6 Specification level requirements + +## 6.1 Requirements + +### 6.1.1 Distributed SON management + +#### 6.1.1.1 RACH Optimization (Random Access Optimisation) + +**REQ-RACH-FUN-1** MnS producer should have a capability allowing the authorized consumer to set and update the targets for RACH optimization function. + +**REQ-RACH-FUN-2** MnS producer should have a capability allowing an authorized consumer to enable or disable the RACH optimization function. + +**REQ-RACH-FUN-3** MnS producer should have a capability allowing the authorized consumer to collect performance measurements that are used to evaluate the RACH performance. + +#### 6.1.1.2 MRO (Mobility Robustness Optimisation) + +**REQ-MRO-FUN-1** The MnS producer should have a capability allowing the MnS consumer to set the targets, HO offset ranges, and control parameters for MRO function. + +**REQ-MRO-FUN-2** The MnS producer should have a capability allowing the MnS consumer to collect the handover related performance measurements that are used to evaluate the MRO performance. + +**REQ-MRO-FUN-3** MnS producer should have a capability allowing the MnS consumer to enable or disable the MRO function. + +**REQ-MRO-FUN-4** The producer of provisioning MnS should have a capability allowing the MnS consumer to update the targets, HO offset ranges, and control information for MRO function. + +#### 6.1.1.3 ANR management in NG-RAN + +The business level requirements in clause 5.1.1 are decomposed into the following specification level requirements, applicable for NG-RAN: + +**REQ-NR-ANR-FUN-01** Producer of provisioning MnS shall support a capability allowing an authorized consumer to request establishment of an Xn connection to the neighbour gNB, or an Xn connection to the neighbour ng-eNB. + +**REQ-NR-ANR-FUN-02** Producer of provisioning MnS shall support a capability allowing an authorized consumer to request that an existing Xn connection to a neighbour gNB, or an Xn connection to a neighbour ng-eNB to be released, and that the establishment of such a connection is prohibited. + +**REQ-NR-ANR-FUN-03** Producer of provisioning MnS shall support a capability allowing an authorized consumer to request that an NCR is allowed to be removed. + +**REQ-NR-ANR-FUN-04** Producer of provisioning MnS shall support a capability allowing an authorized consumer to request that an NCR is not allowed to be removed. + +**REQ-NR-ANR-FUN-05** Producer of provisioning MnS shall support a capability allowing an authorized consumer to disable or enable the ANR function in one or more gNBs. + +#### 6.1.1.4 PCI configuration and re-configuration + +**REQ-DPCI-CONFIG-FUN-1** producer of provisioning MnS should have a capability allowing an authorized consumer to set or update the list(s) of PCI value(s) for NR cell(s). + +**REQ-DPCI-CONFIG-FUN-2** producer of provisioning MnS should have a capability allowing an authorized consumer to enable or disable the PCI configuration function. + +**REQ-DPCI-CONFIG-FUN-3** producer of provisioning MnS should have a capability to notify the authorized consumer with the PCI value(s) being selected for NR cell(s). + +**REQ-DPCI-CONFIG-FUN-4** producer of fault supervision MnS should have a capability to notify the authorized consumer about the detection or resolution of PCI collision or PCI confusion problems for NR cells. + +**REQ-DPCI-CONFIG-FUN-5** producer of provisioning MnS should have a capability allowing an authorized consumer to configure or re-configure the PCI list at the PCI configuration function. + +### 6.1.2 Centralized SON + +#### 6.1.2.1 PCI configuration + +**REQ-CPCI-CONFIG-FUN-1** producer of provisioning MnS should have a capability allowing an authorized consumer to configure or re-configure the PCI value(s) for NR cell(s). + +**REQ-CPCI-CONFIG-FUN-2** producer of provisioning MnS should have a capability to notify the authorized consumer with the PCI value(s) being assigned to NR cell(s). + +**REQ-CPCI-CONFIG-FUN-3** producer of fault supervision MnS should have a capability to notify the authorized consumer about the detection or resolution of PCI collision or PCI confusion problems for NR cells. + +#### 6.1.2.2 Requirements for RAN NE plug and connect to management system + +**REQ-PnC-CON-1** NE shall be able to get its own IP addresses and MnF IP address without manual configuration during plug and play for a NE connection to the network. + +#### 6.1.2.3 Requirements for self-configuration of a new RAN NE + +**REQ-SCM-CON-1** The MnS for self-configuration management shall have the capability allowing MnS consumer request MnS producer to create, query and delete Self-configuration management profile. + +**REQ-SCM-CON-2** The MnS for Self-configuration management shall have the capability allowing MnS consumer obtain the progress of self-configuration process from MnS producer. + +## 6.2 Actor roles + +See use cases in clause 6.4. + +## 6.3 Telecommunication resources + +See use cases in clause 6.4. + +## 6.4 Use cases + +### 6.4.1 Distributed SON management + +#### 6.4.1.1 RACH Optimization (Random Access Optimisation) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To automatically configure the RACH parameters in a cell in order to achieve the optimal network performance by reducing the network access time, and minimize the failures. | | +| <b>Actors and Roles</b> | D-SON management function to support RACH Optimization function. | | +| <b>Telecom resources</b> | - gNB;<br>- The producer of provisioning MnS | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - 5G NR cells are in operation.<br>- RACH Optimization function is in operation. | | +| <b>Begins when</b> | The D-SON management function decides to enable the RACH Optimization function. | | +| <b>Step 1 (M)</b> | The D-SON management function requests the producer of provisioning MnS to set the targets for the RACH optimization function. | | +| <b>Step 2 (M)</b> | The D-SON management function requests the producer of provisioning MnS to enable the RACH optimization function. | | +| <b>Step 3 (M)</b> | The D-SON management function collects the RACH related measurements, and analyse them to evaluate the RACH performance. | | +| <b>Step 4 (O)</b> | If the D-SON management function determines that the RACH performance does not meet the target, it updates the targets for RACH optimization function; | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The RACH performance has been optimized. | | +| <b>Traceability</b> | REQ-RACH-FUN-1, REQ-RACH-FUN-2, REQ-RACH-FUN-3 | | + +#### 6.4.1.2 MRO (Mobility Robustness Optimisation) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To automatically configure the handover parameters in cells in order to improve the handover performance. | | +| <b>Actors and Roles</b> | D-SON management function to support MRO function. | | +| <b>Telecom resources</b> | - gNB;<br>- The producer of provisioning MnS | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - 5G NR cells are in operation.<br>- MRO is in operation. | | +| <b>Begins when</b> | The D-SON management decides to enable MRO function. | | +| <b>Step 1 (M)</b> | The D-SON management function requests the producer of provisioning MnS to set the targets, HO offset ranges, and control information for the MRO function. | | +| <b>Step 2 (M)</b> | The D-SON management function requests the producer of provisioning MnS to enable the MRO function. | | +| <b>Step 3 (M)</b> | The MRO function detects handover issues (e.g. too late HO, too early HO and HO to a wrong cell) in intra-RAT or inter-RAT mobility by analysing reports from UEs and network side information, and acts to mitigate the HO issues by adjusting HO related parameters. | | +| <b>Step 4 (M)</b> | The D-SON management function collects MRO related measurements, and analyses them to evaluate the MRO performance. | | +| <b>Step 5 (M)</b> | The D-SON management function performs the following action, if the MRO performance does not meet the target:<br>1. Update the targets for MRO function.<br>2. Update the ranges for MRO function.<br>3. Update the control information for MRO function. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The MRO performance has been optimized. | | +| <b>Traceability</b> | REQ-MRO-FUN-1, REQ- MR-FUN-2, REQ-MRO-FUN-3, REQ-MRO-FUN-4 | | + +#### 6.4.1.3 ANR management + +##### 6.4.1.3.1 Starting the ANR function + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is to make the ANR function in the gNB is enabled. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management | | +| <b>Telecom resources</b> | The MnS producer of D-SON management<br>gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is not active.<br><br>The gNB may have NCRs. The NCRs may be configured by a MnS consumer or may have been added by the ANR function if the ANR function has been active previously. | | +| <b>Begins when</b> | The Use Case begins when the MnS consumer decides to enable the ANR function in a gNB. | | +| <b>Step 1 (M)</b> | The MnS consumer enables the ANR function in the gNB. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The ANR function in gNB is successfully enabled by the MnS consumer, or if unsuccessful, still disabled. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0h | | + +##### 6.4.1.3.2 Stopping the ANR function + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is to make the ANR function in the gNB is disabled. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management | | +| <b>Telecom resources</b> | The MnS producer of D-SON management<br>gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is active | | +| <b>Begins when</b> | The Use Case begins when the MnS consumer decides to disable the ANR function in a gNB. | | +| <b>Step 1 (M)</b> | The MnS consumer disables the ANR function in the gNB. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The ANR function in gNB is successfully disabled by the MnS consumer, or if unsuccessful, still enabled. All existing NCRs, whether created by ANR or otherwise are unaltered. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0h | | + +##### 6.4.1.3.3 Sending notification of added or deleted NCR + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is for the MnS producer to send a notification of added or deleted NCR to the MnS consumer. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management. | | +| <b>Telecom resources</b> | The MnS producer of D-SON management.<br>gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is active | | +| <b>Begins when</b> | An NCR is added or deleted. This could be the result of either the ANR function's action, or the creation of the deletion of an NCR by a MnS consumer. | | +| <b>Step 1 (M)</b> | The MnS producer sends a notification to the MnS consumer. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The MnS consumer is aware of the creation or deletion of the NCR. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0m | | + +##### 6.4.1.3.4 Handover Whitelisting + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is to make an NCR present in the NCRT, useful for handovers. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management | | +| <b>Telecom resources</b> | The MnS producer of D-SON management<br>gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is active. | | +| <b>Begins when</b> | The Use Case begins when the MnS consumer decides to whitelist an NCR. | | +| <b>Step 1 (O)</b> | The MnS consumer creates the NCR<br>This step is executed if the wanted NCR not already present in the NCRT. | | +| <b>Step 2 (M)</b> | The MnS consumer marks the NCR so that handovers are allowed, and so that the ANR function is not allowed to remove the NCR. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The wanted NCR is present in the NCRT. It is protected from being removed by the ANR function. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0c, REQ-NR-ANR-FUN-0i | | + +##### 6.4.1.3.5 Handover Blacklisting + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is to make an NCR is present in the NCRT and made unavailable for handovers. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management | | +| <b>Telecom resources</b> | The MnS producer of D-SON management gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is active. | | +| <b>Begins when</b> | The Use Case begins when the MnS consumer decides to blacklist an NCR. | | +| <b>Step 1 (O)</b> | The MnS consumer creates the NCR.<br>This step is executed if the wanted NCR not already present in the NCRT. | | +| <b>Step 2 (M)</b> | The MnS consumer marks the NCR so that handovers are prohibited, and so that the ANR function is not allowed to remove the NCR. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The wanted NCR is present in the NCRT. It is protected from being removed by the ANR function. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0d, REQ-NR-ANR-FUN-0i | | + +##### 6.4.1.3.6 Prohibiting X2 or Xn connection to a peer node (X2/Xn blacklisting) + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is to prohibit a gNB from setting up an X2 or Xn connection to a peer gNB or eNB. If such a connection existed, it is brought down. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management | | +| <b>Telecom resources</b> | The MnS producer of D-SON management gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is active. | | +| <b>Begins when</b> | The Use Case begins when the MnS consumer decides to prohibit the setting up of X2 or Xn connections to a peer node. | | +| <b>Step 1 (M)</b> | The MnS consumer configures the MnS producer with the peer node into the list of nodes for which X2 or Xn connections are prohibited. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The peer node is in the black-list. If an X2 or Xn connection was present to the peer node, it is brought down. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0g | | + +##### 6.4.1.3.7 Prohibiting handover over X2 or Xn (X2/Xn handover blacklisting) + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The goal is to prohibit a gNB from using an X2 or Xn connection to a peer gNB or eNB for handover. | | +| <b>Actors and Roles</b> | A MnS consumer of the MnS of D-SON management. | | +| <b>Telecom resources</b> | The MnS producer of D-SON management gNB | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The ANR function is active. | | +| <b>Begins when</b> | The Use Case begins when the MnS consumer decides to prohibit using the X2 or Xn connection to a peer node for handover. | | +| <b>Step 1 (M)</b> | The MnS consumer configures the MnS producer to mark the NCR to the peer node so that handovers over the X2 or Xn connection are prohibited. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails and retry is unsuccessful. | | +| <b>Post Conditions</b> | The gNB is prohibited from using the using the X2 or Xn connection to the peer node for handovers. | | +| <b>Traceability</b> | REQ-NR-ANR-FUN-0o | | + +#### 6.4.1.4 PCI configuration + +##### 6.4.1.4.1 Initial PCI configuration + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To automatically configure the PCIs for NR cells that have not been assigned with PCIs. | | +| <b>Actors and Roles</b> | D-SON management function to support initial PCI configuration. | | +| <b>Telecom resources</b> | - gNB;<br>- The producer of provisioning MnS | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - 5G NR cells are in operation.<br>- No PCI values have been assigned to NR cells. | | +| <b>Begins when</b> | The D-SON management function decided to configure the PCI list for NR cell(s). | | +| <b>Step 1 (M)</b> | The D-SON management function requests the producer of provisioning MnS to configure the PCI list at the PCI configuration function. | | +| <b>Step 2 (M)</b> | The D-SON management function requests the producer of provisioning MnS to enable the PCI configuration function at NR cell(s). | | +| <b>Step 3 (M)</b> | The PCI configuration function selects PCI value(s) from the list of PCI values provided by the producer of provisioning MnS. | | +| <b>Step 4 (M)</b> | The producer of provisioning MnS notifies the consumer with the PCI value(s) being assigned for the NR cell(s). | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The PCI value of a NR cell has been selected. | | +| <b>Traceability</b> | REQ-DPCI-CONFIG-FUN-1, REQ-DPCI-CONFIG-FUN-2, REQ-DPCI-CONFIG-FUN-3, REQ-DPCI-CONFIG-FUN-5 | | + +##### 6.4.1.4.2 PCI re-configuration + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To automatically re-configure the PCIs of NR, due to the PCI collision or PCI confusion problems. | | +| <b>Actors and Roles</b> | D-SON management function to support PCI re-configuration. | | +| <b>Telecom resources</b> | - gNB;<br>- The producer of provisioning MnS<br>- The producer of fault supervision MnS | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - 5G NR cell(s) have been assigned with PCI value(s).<br>- The PCI configuration function is in operation, and enabled. | | +| <b>Begins when</b> | PCI configuration function has detected the PCI problem of PCI collision or PCI confusion for NR cell(s). | | +| <b>Step 1 (M)</b> | The D-SON management function receives an alarm from the producer of fault supervision MnS indicating the PCI collision or PCI confusion problems for an NR cell(s). | | +| <b>Step 2 (M)</b> | The D-SON management function requests the producer of provisioning MnS to re-configure the PCI list at the PCI configuration function. | | +| <b>Step 3 (M)</b> | The PCI configuration function selects PCI value(s) from the PCI list. | | +| <b>Step 4 (M)</b> | The producer of provisioning MnS notifies the consumer with the PCI value(s) being assigned for the NR cell(s). | | +| <b>Step 5 (M)</b> | The D-SON management function receives a clear alarm notification from the producer of fault supervision MnS. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The PCI collision or PCI confusion have been resolved. | | +| <b>Traceability</b> | <b>REQ-DPCI-CONFIG-FUN-3, REQ-DPCI-CONFIG-FUN-4, REQ-DPCI-CONFIG-FUN-5</b> | | + +### 6.4.2 Centralized SON + +#### 6.4.2.1 PCI configuration + +##### 6.4.2.1.1 Initial PCI configuration + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To automatically configure the PCIs of NR cell(s) that have not been assigned with PCI value(s). | | +| <b>Actors and Roles</b> | C-SON function to support PCI configuration. | | +| <b>Telecom resources</b> | - gNB;<br>- The producer of provisioning MnS | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - 5G NR cells have not been assigned with PCI values yet.<br>- The C-SON has been enabled. | | +| <b>Begins when</b> | The C-SON function decides to configure PCI values for NR cell(s). | | +| <b>Step 1 (M)</b> | The C-SON function determines the PCI value(s) for the NR cell(s) that have no collision or confusion with its neighbours. | | +| <b>Step 2 (M)</b> | The C-SON function requests the producer of provisioning MnS to configure the PCI value(s) at the NR cell(s). | | +| <b>Step 3 (M)</b> | The producer of provisioning MnS notifies the consumer with the PCI value(s) being assigned for the NR cell(s). | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The PCI value of a NR cell has been selected. | | +| <b>Traceability</b> | <b>REQ-CPCI-CONFIG-FUN-1, REQ-CPCI-CONFIG-FUN-2</b> | | + +##### 6.4.2.1.2 PCI re-configuration + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To automatically re-configure the PCIs of NR cells, due to the PCI collision or PCI confusion problems. | | +| <b>Actors and Roles</b> | C-SON to support PCI re-configuration. | | +| <b>Telecom resources</b> | <ul style="list-style-type: none"> <li>- gNB;</li> <li>- The producer of provisioning MnS</li> <li>- The producer of fault supervision MnS</li> </ul> | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- 5G NR cells are in operation.</li> <li>- The C-SON function has been in operation, and enabled.</li> </ul> | | +| <b>Begins when</b> | The C-SON function requests the producer of provisioning MnS to collect the PCI related measurements reported by NG-RAN. | | +| <b>Step 1 (M)</b> | The C-SON function analyses the PCI related information and detects that NR cells have experienced PCI conflict or confusion issues. | | +| <b>Step 2 (M)</b> | The producer of fault supervision MnS notifies the C-SON function about the PCI collision or PCI confusion problems for NR cell(s). | | +| <b>Step 3 (M)</b> | The C-SON function determines the new PCI value(s), and requests the producer of provisioning MnS to re-configure the PCI value for the NR cell(s) experienced PCI conflict or confusion issues. | | +| <b>Step 4 (M)</b> | The producer of provisioning MnS notifies the C-SON function about the resolution of PCI collision or PCI confusion problems for NR cell(s). | | +| <b>Step 4 (M)</b> | The producer of fault supervision MnS notifies the consumer-SON function about the resolution of PCI collision or PCI confusion problems for NR cell(s). | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The PCI value of a NR cell has been selected. | | +| <b>Traceability</b> | <b>REQ-CPCI-CONFIG-FUN-1, REQ-CPCI-CONFIG-FUN-2, REQ-CPCI-CONFIG-FUN-3</b> | | + +#### 6.4.2.2 Use case for establishment of a new RAN NE in network + +##### 6.4.2.2.1 Use case for RAN NE plug and connect to management system + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | <p>After NE installation, connect the NE to its MnF providing support for self-configuration process, and to the External Network(s) as automatically as possible.</p> <p>The NE described in this use case can be gNB in non-split scenario and gNB-DU in split scenario.</p> <p>NOTE: The NE within virtualization or other type of RAN NE (e.g. GNB-CU) is not addressed in this use case.</p> | | +| <b>Actors and Roles</b> | NE | | +| <b>Telecom resources</b> | <p>IP networks: Non-Secure Operator Network, External Network, and its elements like DHCP server optionally DNS, CA/RA servers, Security Gateway(s) (each protecting one or more Secure Operator Networks), Secure Operator Network(s) including MnF providing support for self-configuration process.</p> | | + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Assumptions | There is a functional power supply for the NE. There may be one or more IP Autoconfiguration Services like DHCP and Router Advertisements and zero or more DNS servers. | | +| Pre conditions | <p>The NE is installed.</p> <p>IP connectivity exists between the involved telecom resources.<br/>The involved telecom resources are functional.<br/>The relevant information is stored and available:</p> <ul style="list-style-type: none"> <li>- Vendor Certificate at the NE</li> <li>- Operator Certificate at the CA/RA</li> <li>- For the External Network or Non-Secure Operator Network: <ul style="list-style-type: none"> <li>- (Outer) IP autoconfiguration information at the IP Autoconfiguration Service <ul style="list-style-type: none"> <li>- FQDN of the initial OAM SeGW at the NE and/or FQDN or IP address of the initial OAM SeGW at the IP Autoconfiguration Service</li> <li>- FQDN of the CA/RA servers at the NE and/or FQDN or IP address of the CA/RA servers at the IP Autoconfiguration Service</li> <li>- If FQDNs need to be resolved, corresponding IP address(es) at the DNS server(s)</li> </ul> </li> </ul> </li> <li>- For the Secure Operator Network: <ul style="list-style-type: none"> <li>- (Inner) IP autoconfiguration information at the IP Autoconfiguration Service or at the initial OAM SeGW</li> <li>- FQDN or IP address of the initial MnF at the NE and/or DHCP Server of the Secure Operator Network.</li> <li>- If FQDNs need to be resolved, corresponding IP address(es) at the DNS server(s)</li> <li>- Configuration and software for the NE at the MnF(s)</li> </ul> </li> </ul> | | +| Begins when | The NE is installed. | | +| Step 1 (M) | If a VLAN ID is available the NE uses it. Otherwise the NE uses the native VLAN where PnP traffic is sent and received untagged | | +| Step 2 (M) | The NE acquires its IP address through stateful or stateless IP autoconfiguration. This may provide 0 or more DNS server addresses. | | +| Step 3 (M) | The NE acquires the IP address of the CA/RA server. The FQDN of the CA/RA server may be pre-configured in the NE or the FQDN or IP address of the CA/RA server may be provided by the IP Autoconfiguration Service. FQDNs are resolved through the DNS if necessary. Information provided by the IP Autoconfiguration Services shall supersede those pre-configured at the NE. | | +| Step 4 (M) | The NE performs Certificate Enrolment. | | +| Step 5 (M) | The NE acquires the IP address of the OAM SeGW. The FQDN of the OAM SeGW may be pre-configured in the NE or the FQDN or the IP address of the OAM SeGW may be provided by the IP Autoconfiguration Service. FQDNs are resolved through the DNS if necessary. | | +| Step 6 (M) | <p>The NE establishes a secure connection (tunnel) to the Security Gateway given by Step 5.</p> <p>The NE receives its (inner) IP autoconfiguration information (which may be the same as the outer IP address obtained in step2) and optionally the address of one or more DNS servers within the Secure Operator Network from the Configuration Parameters of IKEv2 during tunnel establishment.</p> | | +| Step 7 (M) | The NE acquires the IP address of the correct MnF by either, issuing a DHCP request including the NE's vendor information, resolving FQDNs via DNS if necessary, or by having a pre-configured FQDN (including the NE's vendor information) resolved via DNS. | | + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| Step 8 (M) | <p>The NE establishes a connection to the provided MnF and acquires its configuration and software if any.</p> <p>The configuration may contain an address to another MnF that this specific node shall use as MnF.</p> <p>The configuration may contain an address to another SeGW that should be used before connecting to the MnF.</p> <p>The MnF may then</p> <ul style="list-style-type: none"> <li>- release the connection to the current MnF and OAM SeGW and then restart (returning to step 1),</li> <li>- release the connection to the current MnF and OAM SeGW and then return to step 6,</li> <li>- release the connection to the current MnF and then repeat step 8, or</li> <li>- continue with step 9.</li> </ul> | | +| Step 9 (M) | The NE establishes a connection to the External Network(s) using the transport (VLAN ID, IP addresses) and security parameters provided in step 8. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | One or more secure connections exist between the NE and the MnF and the External Network(s). Via the connection to the MnF the NE can receive further instructions to become operational and carry user traffic, e.g. the administrativeState is set to "unlocked". | Clause 6.4.2.2.2<br>Use case for self-configuration of a new RAN NE | +| Traceability | All requirements of clause 6.1.2.2 | | + +##### 6.4.2.2.2 Use case for self-configuration of a new RAN NE + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| Goal (*) | After installation, put in an automated manner the NE into a state to be ready to carry traffic. | | +| Actors and Roles (*) | MnF providing support for self-configuration process act as MnS<br>Producer for Self-configuration management | | +| Telecom resources | NE<br>MnS Consumer of Self-configuration management | | +| Assumptions | IP network connectivity exists between the NE and the MnF(s) providing support for the self-configuration process. | | +| Pre conditions | The NE is installed and connected to an IP network. | Clause 6.4.2.2.1 Use case for Plug and connect to management system | +| Begins when | The field personnel start the self-configuration process. It is also possible that the process is triggered automatically after the completion of an NE self-test or receiving the self-configuration management profile creation request from MnS Consumer for self-configuration management. | | +| Step 1 (O) | MnF providing support for self-configuration process may notify MnS Consumer of self-configuration management about the start of the self configuration process. | | + +| Use Case<br>Stage | Evolution / Specification | <<Uses>><br>Related use | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Step 1 (*)<br>(M O) | <p>The order of the bullet points in the list below does not imply any statements on the order of execution.</p> <ul style="list-style-type: none"> <li>- An NE IP address is allocated to the new NE.</li> <li>- Basic information about the transport network (e. g. gateways) environment is provided to the NE. With this information the NE is able to exchange IP packets with other internet hosts.</li> <li>- The NE provides information about its type, hardware and other relevant data about itself to the MnF(s) providing support for the self-configuration process.</li> <li>- The address(es) of the MnF(s) providing support for the self-configuration process (e.g. MnF for software download, MnF for configuration data download) is provided to the NE. The address is equal to an IP address and a port number, or a DNS name and port number, or an URI.</li> </ul> <p>The address(es) of the MnF(s) providing support for normal OAM functions after completion of the self-configuration process are provided to the NE. The address is equal to an IP address and a port number, or a DNS name and port number, or an URI.</p> <ul style="list-style-type: none"> <li>- The NE connects to the MnF providing support for the software download.</li> <li>- The decision which software or software packages have to be downloaded to the NE is taken.</li> <li>- The software is downloaded into the NE.</li> <li>- The NE connects to the MnF providing support for the configuration data download.</li> <li>- The configuration data for the NE is made available by either preparing it or making prepared configuration data available.</li> <li>- The configuration data is downloaded into the NE.</li> <li>- Dependent External nodes are updated with new configuration data as well (if required).</li> <li>- The NE connects to the MnF providing support for normal OAM functions after completion of the self-configuration process.</li> <li>- The inventory system in the MnF is informed that a new NE is in the field.</li> <li>- The NE performs a self-test. Self-tests of different types can run at different places within the self-configuration procedure.</li> <li>- The operator is informed about the progress of the self-configuration process and important events occurring during the self-configuration process.</li> <li>- The network resource models are updated during and after the self-configuration process.</li> <li>- SW is installed, i.e. prepared in such a way, that the NE is ready to use it. NE is allowed to use the SW.</li> </ul> | | +| Step 3 (O) | MnF providing support for self-configuration process may notify MnS Consumer of Self-configuration management about the progress of the self configuration during self-configuration process. | | +| Ends when (*) | Ends when all steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | | | +| Post Conditions | The NE is ready to carry traffic. | | +| Traceability (*) | All requirements of clause 6.1.2.3 | | + +# 7 Management services for SON + +## 7.1 Management services for D-SON management + +### 7.1.1 RACH Optimization (Random Access Optimisation) + +#### 7.1.1.1 MnS component type A + +**Table 7.1.1.1-1: RACH optimization type A** + +| MnS Component Type A | Note | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| +| Operations and notifications defined in clause 11.1.1 of TS 28.532 [3]:<br>- createMOI operation<br>- getMOIAttributes operation<br>- modifyMOIAttributes operation<br>- deleteMOI operation<br>- notifyMOIAttributeValueChanges operation<br>- notifyMOICreation<br>- notifyMOIDeletion<br>- notifyMOIChanges | It is supported by Provisioning MnS for NF, as defined in 28.531 [11]. | +| Operations defined in clause 11.3.1.1.1 in TS 28.532 [3] and clause 6.2.3 of TS 28.550 [12]:<br>- notifyFileReady operation<br>- reportStreamData operation | It is supported by Performance Assurance MnS for NFs, as defined in 28.550 [12]. | + +#### 7.1.1.2 MnS Component Type B definition + +##### 7.1.1.2.1 Targets information + +The targets of RACH optimization are shown in Table 7.1.2.1.1-1. + +**Table 7.1.1.1.2-1: RACH optimization targets** + +| Targets | Definition | Legal Values | +|--------------------------------------|-----------------------------------------------------------|---------------------------| +| UE access delay probability | The probability distribution of UE access delay per cell. | CDF of access delay | +| Number of preambles sent probability | The probability of the number of preambles sent per cell. | CDF of access probability | + +##### 7.1.1.2.2 Control information + +The parameter is used to control the RACH optimization function. + +**Table 7.1.1.2.2-1: RACH optimization control** + +| Control parameter | Definition | Legal Values | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| RACH optimization control | This attribute allows authorized consumer to enable/disable the RACH optimization functionality. See attribute <code>drachOptimizationControl</code> in TS 28.541 [13]. | Boolean<br>On, off | + +##### 7.1.1.2.3 Parameters to be updated + +Void. + +#### 7.1.1.3 MnS Component Type C definition + +##### 7.1.1.3.1 Performance measurements + +Performance measurements related to the RACH optimization are captured in Table 7.1.1.3.1-1: + +**Table 7.1.1.3.1-1: RACH optimization related performance measurements** + +| Performance measurements | Description | Related targets | +|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| Distribution of RACH preambles sent | Distribution of the number of preambles UEs sent to achieve synchronization per SSB, where the number of preambles sent corresponds to PREAMBLE_TRANSMISSION_COUNTER (see clause 5.1.1 in TS 38.321 [4]) in UE. | UE access delay probability per SSB | +| Distribution of UEs access delay per SSB | Distribution of the time needed for UEs to successfully attach to the network per SSB. | Number of preambles send per SSB probability | + +### 7.1.2 MRO (Mobility Robustness Optimisation) + +#### 7.1.2.1 MnS component type A + +**Table 7.1.2.1-1: MRO type A** + +| MnS Component Type A | Note | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| Operations and notifications defined in clause 11.1.1 of TS 28.532 [3]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- getMOIAttributes operation</li> <li>- modifyMOIAttributes operation</li> <li>- deleteMOI operation</li> <li>- notifyMOIAttributeValueChanges operation <ul style="list-style-type: none"> <li>- notifyMOICreation</li> <li>- notifyMOIDeletion</li> <li>- notifyMOIChanges</li> </ul> </li> </ul> | It is supported by Provisioning MnS for NF, as defined in TS 28.531 [11]. | +| Operations defined in clause 11.3.1.1 in TS 28.532 [3] and clause 6.2.3 of TS 28.550 [12]: <ul style="list-style-type: none"> <li>- notifyFileReady operation</li> <li>- reportStreamData operation</li> </ul> | It is supported by Performance Assurance MnS for NFs, as defined in TS 28.550 [12]. | + +#### 7.1.2.2 MnS Component Type B definition + +##### 7.1.2.2.1 Targets information + +The targets of MRO are shown in the Table 7.1.2.2.1-1. + +**Table 7.1.2.2.1-1: MRO targets** + +| Target Name | Definition | Legal Values | +|---------------------------------------|------------------------------------------------------------------------------------------------------|-----------------------------| +| Total handover failure rate | (the number of failure events related to handover) / (the total number of handover events) | [0..100] in unit percentage | +| Total intra-RAT handover failure rate | (the number of failure events related to intra-RAT handover) / (the total number of handover events) | [0..100] in unit percentage | +| Total inter-RAT handover failure rate | (the number of failure events related to inter-RAT handover) / (the total number of handover events) | [0..100] in unit percentage | + +##### 7.1.2.2.2 Control information + +The parameter is used to control the MRO function. + +**Table 7.1.2.2.2-1: MRO control** + +| Control parameter | Definition | Legal Values | +|----------------------|--------------------------------------------------------------------------------------------------------------------------|--------------------| +| MRO function control | This attribute allows the operator to enable/disable the MRO functionality. See attribute dmroControl in TS 28.541 [13]. | Boolean<br>On, off | + +##### 7.1.2.2.3 Parameters to be updated + +**Table 7.1.2.2.3-1: Ranges of handover parameters** + +| Control parameters | Definition | Legal Values | +|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Maximum deviation of Handover Trigger | This parameter defines the maximum allowed absolute deviation of the Handover Trigger, from the default point of operation (see clause 15.5.2.5 in TS 38.300 [7] and clause 9.2.2.61 in TS 38.423 [17]). | [-20..20] in unit 0.5 dB | +| Minimum time between Handover Trigger changes | This parameter defines the minimum allowed time interval between two Handover Trigger change performed by MRO. This is used to control the stability and convergence of the algorithm (see clause 15.5.2.5 in TS 38.300 [7]). | [0.. 604800] in unit Seconds | +| Tstore_UE_cntxt | The timer used for detection of too early HO, too late HO and HO to wrong cell. Corresponds to Tstore_UE_cntxt timer described in clause 15.5.2.5 in TS 38.300 [7]. | [0..1023] in unit 100 milliseconds | + +#### 7.1.2.3 MnS Component Type C definition + +##### 7.1.2.3.1 Performance measurements + +Performance measurements related MRO are captured in Table 7.1.2.3.1-1: + +**Table 7.1.2.3.1-1. MRO related performance measurements** + +| Performance measurements | Description | Related targets | +|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| Number of handover events | Includes all successful and unsuccessful handover events (see clause 5.1.1.6 in TS 28.552 [5]). | Total handover failure rate | +| Number of handover failures | Includes unsuccessful handover events with failure causes (see clause 5.1.1.6 in TS 28.552 [5]). | Total handover failure rate | +| Number of intra-RAT handover events | Includes all successful and unsuccessful intra-RAT handover events (see clauses 5.1.1.6.1 and 5.1.1.6.2 in TS 28.552 [5]). | Total intra-RAT handover failure rate | +| Number of intra-RAT handover failures | Includes unsuccessful intra-RAT handover events with failure causes (see clauses 5.1.1.6.1 and 5.1.1.6.2 in TS 28.552 [5]). | Total intra-RAT handover failure rate | +| Number of inter-RAT handover events | Includes all successful and unsuccessful inter-RAT handover events (see clause 5.1.1.6.3 in TS 28.552 [5]). | Total inter-RAT handover failure rate | + +| Performance measurements | Description | Related targets | +|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| Number of inter-RAT handover failures | Includes unsuccessful inter-RAT handover events with failure causes (see clause 5.1.1.6.3 in TS 28.552 [5]). | Total inter-RAT handover failure rate | +| Number of intra-RAT too late handover failures | Detected when an RLF occurs after the UE has stayed for a long period of time in the source cell; the UE attempts to re-establish the radio link connection in the target cell (see clause 5.1.1.25.1 in TS 28.552 [5]). | | +| Number of intra-RAT too early handover failures | Detected when an RLF occurs shortly after a successful handover from a source cell to a target cell or a handover failure occurs during the handover procedure; the UE attempts to re-establish the radio link connection in the source cell (see clause 5.1.1.25.1 in TS 28.552 [5]). | | +| Number of intra-RAT handover failures to wrong cell | Detected when an RLF occurs shortly after a successful handover from a source cell to a target cell or a handover failure occurs during the handover procedure; the UE attempts to re-establish the radio link connection in a cell other than the source cell or the target cell (see clause 5.1.1.25.1 in TS 28.552 [5]). | | +| Number of inter-RAT too late handover failures | Detected when an RLF occurs after the UE has stayed in an NG-RAN cell for a long period of time; the UE attempts to reconnect to a cell belonging to an E-UTRAN node (see clause 5.1.1.25.2 in TS 28.552 [5]). | | +| Number of inter-RAT too early handover failures | Detected when an RLF occurs shortly after a successful handover from an E-UTRAN cell to a target cell in a NG-RAN node (see clause 5.1.1.25.2 in TS 28.552 [5]). | | +| Number of unnecessary handover to another RAT | Detected when a UE is handed over from NG-RAN to other system (e.g. UTRAN) even though quality of the NG-RAN coverage was sufficient for the service used by the UE (see clause 5.1.1.25.3 in TS 28.552 [5]). | | +| Number of inter-RAT handover ping pong | Detected when an UE is handed over from a cell in a source system (e.g. NG-RAN) to a cell in a target system different from the source system (e.g. E-UTRAN), then within a predefined limited time the UE is handed over back to a cell in the source system, while the coverage of the source system was sufficient for the service used by the UE (see clause 5.1.1.25.4 in TS 28.552 [5]). | | + +### 7.1.3 PCI configuration + +#### 7.1.3.1 MnS component type A + +**Table 7.1.3.1-1: PCI type A** + +| MnS Component Type A | Note | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| +| Operations and notifications defined in clause 11.1.1 of TS 28.532 [3]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- getMOIAttributes operation</li> <li>- modifyMOIAttributes operation</li> <li>- deleteMOI operation</li> <li>- notifyMOIAttributeValueChanges operation <ul style="list-style-type: none"> <li>- notifyMOICreation</li> <li>- notifyMOIDeletion</li> <li>- notifyMOIChanges</li> </ul> </li> </ul> | It is supported by Provisioning MnS for NF, as defined in 28.531 [11]. | + +#### 7.1.3.2 MnS Component Type B definition + +##### 7.1.3.2.1 Control information + +The parameter is used to control the D-SON PCI configuration function. + +**Table 7.1.3.2.1-1: PCI control** + +| Control parameter | Definition | Legal Values | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| PCI configuration control | This attribute allows authorized consumer to enable/disable the D-SON PCI configuration functionality. See attribute dPciConfigurationControl in TS 28.541 [13]. | enable, disable | + +##### 7.1.3.2.2 Parameters to be updated + +The table below lists the parameter related to the D-SON PCI configuration function. + +**Table 7.1.3.2.2-1: PCI update** + +| Parameters | Definition | Legal Values | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| PCI list | The list of PCI values to be used by D-SON PCI configuration function to assign the PCI for NR cells. (See attribute nRPciList in TS 28.541 [13]). | List of integers | + +#### 7.1.3.3 MnS Component Type C definition + +##### 7.1.3.3.1 Notification information + +The table below lists the notifications related to D-SON PCI configuration. + +**Table 7.1.3.3-1: PCI performance measurements** + +| Performance measurements | Description | Note | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|------| +| PCI collision notification | The collision notification is used to indicate two neighbouring cells of a serving cell are using the same PCIs. | | +| PCI Confusion notification | The confusion notification is used to indicate that a serving cell has 2 neighbouring cells that are using the same PCI value. | | + +### 7.1.4 ANR management + +This management service is used for management of ANR, and ANR is specified in TS 38.300 [7], clauses 15.3.3. + +Stage 2 for ANR management is located in TS 28.541 [13], clauses 4.3.2.2, 4.3.2.3, 4.3.32.2 and 4.3.32.3. + +Stage 3 for ANR management is located in TS 28.541 [13], clauses C.4.3, D.4.3, and E.5. + +## 7.2 Management services for C-SON + +### 7.2.1 PCI configuration + +#### 7.2.1.1 MnS component type A + +**Table 7.2.1.1-1: PCI type A** + +| MnS Component Type A | Note | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| +| Operations and notifications defined in clause 11.1.1 of TS 28.532 [3]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- getMOIAttributes operation</li> <li>--- modifyMOIAttributes operation <ul style="list-style-type: none"> <li>-- deleteMOI operation</li> </ul> </li> <li>- notifyMOIAttributeValueChanges operation <ul style="list-style-type: none"> <li>- notifyMOICreation</li> <li>- notifyMOIDeletion</li> <li>- notifyMOIChanges</li> </ul> </li> </ul> | It is supported by Provisioning MnS for NF, as defined in 28.531 [11]. | +| Operations defined in clause 11.3.1.1.1 in TS 28.532 [3] and clause 6.2.3 of TS 28.550 [12]: <ul style="list-style-type: none"> <li>- notifyFileReady operation</li> <li>- reportStreamData operation</li> </ul> | It is supported by Performance Assurance MnS for NFs, as defined in 28.550 [12]. | + +#### 7.2.1.2 MnS Component Type B definition + +##### 7.2.1.2.1 Control information + +The parameter is used to control the C-SON PCI configuration function. + +**Table 7.2.1.2.1-1: PCI control** + +| Control parameter | Definition | Legal Values | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| PCI configuration control | This attribute allows authorized consumer to enable/disable the C-SON PCI configuration functionality. See attribute <code>cPciConfigurationControl</code> in TS 28.541 [13]. | disable, enable | + +##### 7.2.1.2.2 Parameters to be updated + +The table below lists the parameter related to the C-SON PCI configuration function. + +**Table 7.2.1.2.2-1: PCI dupdate** + +| Updated parameters | Definition | Legal Values | +|--------------------|-------------------------------------------------|--------------| +| NR PCI | This parameter contains the PCI of the NR cell. | Integer | + +#### 7.2.1.3 MnS Component Type C definition + +##### 7.2.1.3.1 Notifications information + +The table below lists the notifications related to PCI configuration are generated from the NR cells. + +**Table 7.2.1.3.1-1: PCI notification** + +| Notification information | Description | Note | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|------| +| PCI collision notification | The collision notification is used to indicate two neighbouring cells are using the same PCIs. | | +| PCI Confusion notification | The confusion notification is used to indicate that a serving cell has 2 neighbouring cells that are using the same PCI value. | | + +##### 7.2.1.3.2 Performance measurements + +Performance measurements related to the PCI configuration are collected from the NR cells. + +**Table 7.2.1.3.2-1. PCI related performance measurements** + +| Performance measurements | Description | Note | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| PCI of candidate cells | The measurement contains cumulative counter with subcounters that is identified by the PCI value(s) of the candidate cells, and is derived from <i>MeasResultListNR</i> (see clause 6.3.2 in TS 38.331 [9]) where it contains PCI in <i>PhysCellId</i> , and RSRP/RSRQ in <i>MeasQuantityResults</i> of candidate cells. It is generated when the RSRP received from the candidate cells exceeds certain thresholds. | | + +# 8 SON procedures + +## 8.1 Introduction + +The procedures listed in clause 8 are some of all the possibilities, and are not exhaustive. + +## 8.2 Distributed SON management + +### 8.2.1 RACH Optimization (Random Access Optimisation) + +Figure 8.2.1-1 depicts a procedure that describes how D-SON management function can manage the RACH optimization (D-SON) function. It is assumed that the D-SON management function has consumed the performance assurance management service to collect RACH optimisation related measurements. + +![Sequence diagram for RACH Optimization procedure showing interactions between Producer of performance assurance MnS, D-SON management function, Producer of provisioning MnS, and RACH optimization function.](1841f348dfa81a3438d4e1f8465d9ac7_img.jpg) + +``` + +sequenceDiagram + participant PMnS as Producer of performance assurance MnS + participant DSON as D-SON management function + participant PMnS_prov as Producer of provisioning MnS + participant ROF as RACH optimization function + + Note right of DSON: 1. modifyMOIAttributes to set the targets + DSON->>PMnS_prov: 1. modifyMOIAttributes to set the targets + Note right of PMnS_prov: 1.a. set the targets + PMnS_prov->>ROF: 1.a. set the targets + + Note right of DSON: 2. modifyMOIAttributes to enable the RACH optimization function + DSON->>PMnS_prov: 2. modifyMOIAttributes to enable the RACH optimization function + Note right of PMnS_prov: 2.a. enable the RACH optimization function + PMnS_prov->>ROF: 2.a. enable the RACH optimization function + + loop Loop + Note right of ROF: 3. Perform actions to optimize the RACH performance + ROF->>PMnS: 4. Collected performance measurements related to RACH performance + PMnS->>DSON: 4. Collected performance measurements related to RACH performance + Note right of DSON: 5. analyses the measurements to evaluate the RACH performance + DSON->>DSON: 5. analyses the measurements to evaluate the RACH performance + + opt Opt: Check If the RACH optimization performance meets the targets + Note right of DSON: 6. modifyMOIAttributes to update the targets If the RACH optimization performance does not meet the targets + DSON->>PMnS_prov: 6. modifyMOIAttributes to update the targets If the RACH optimization performance does not meet the targets + Note right of PMnS_prov: 6.a. update the targets + PMnS_prov->>ROF: 6.a. update the targets + end + end + +``` + +Sequence diagram for RACH Optimization procedure showing interactions between Producer of performance assurance MnS, D-SON management function, Producer of provisioning MnS, and RACH optimization function. + +Figure 8.2.1-1: RACH Optimization procedure + +1. The D-SON management function consumes the provisioning MnS with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [3]) to configure the targets for RACH optimization function. + - 1.a The provisioning MnS sets the targets for RACH optimization (D-SON) function (NOTE). +2. The D-SON management function consumes the provisioning MnS with *modifyMOIAttributes* operation to enable the RACH optimization function for a given NR cell **if it is not enabled**. + - 2.a The provisioning MnS enables the RACH optimization (D-SON) function (NOTE). +3. The RACH optimization (D-SON) function receives the RACH information report from UE(s), and analyses them to determine the actions to optimize the RACH performance if the performance does not meet the targets by updating the RACH parameters. +4. The D-SON management function collects the RACH related performance measurements. +5. The D-SON management function analyses the measurements to evaluate the RACH performance, + - Opt: Check If the RACH optimization performance meets the targets + 6. *modifyMOIAttributes* to update the targets If the RACH optimization performance does not meet the targets + - 6.a. update the targets + +6. The D-SON management function consumes the provisioning MnS with *modifyMOIAttributes* operation to update the targets of the RACH optimization function, when the RACH optimization performance does not meet the targets: + +6.a The provisioning MnS updates the targets for RACH optimization function (NOTE). + +NOTE: The interface between provisioning MnS and RACH optimization is not subject to standardization. + +### 8.2.2 MRO (Mobility Robustness Optimisation) + +Figure 8.2.2-1 depicts a procedure that describes how D-SON management function can manage the MRO function. It is assumed that the D-SON management function has consumed the performance assurance MnS to create PM jobs to collect handover related measurements. + +![Sequence diagram for MRO procedure showing interactions between Producer of performance assurance MnS, D-SON management function, Producer of provisioning MnS, and MRO function.](446100c084b94817a19c319fa776b412_img.jpg) + +``` + +sequenceDiagram + participant PM as Producer of performance assurance MnS + participant DSON as D-SON management function + participant PMnS as Producer of provisioning MnS + participant MRO as MRO function + + Note right of DSON: 1. modifyMOIAttributes to set the targets + DSON->>PMnS: 1. modifyMOIAttributes to set the targets + PMnS->>MRO: 1.a. set the targets + Note right of DSON: 2. modifyMOIAttributes to set the ranges + DSON->>PMnS: 2. modifyMOIAttributes to set the ranges + PMnS->>MRO: 2.a. set the ranges + Note right of DSON: 3. modifyMOIAttributes to set the control parameters + DSON->>PMnS: 3. modifyMOIAttributes to set the control parameters + PMnS->>MRO: 3.a. set the control parameters + Note right of DSON: 4. modifyMOIAttributes to enable the MRO function + DSON->>PMnS: 4. modifyMOIAttributes to enable the MRO function + PMnS->>MRO: 4.a. enable the MRO function + + loop Loop + Note right of MRO: 5. Perform actions to optimize the MRO performance + MRO->>PM: 6. Collect performance measurements related to MRO performance + Note right of DSON: 7. analyses the measurements to evaluate the MRO performance + DSON->>DSON: 7. analyses the measurements to evaluate the MRO performance + + opt If the MRO performance meets the targets + Note right of DSON: 8.1 modifyMOIAttributes to update the targets + DSON->>PMnS: 8.1 modifyMOIAttributes to update the targets + PMnS->>MRO: 8.1.a. update the targets + Note right of DSON: 8.2 modifyMOIAttributes to update the ranges + DSON->>PMnS: 8.2 modifyMOIAttributes to update the ranges + PMnS->>MRO: 8.2.a. update the ranges + Note right of DSON: 8.3 modifyMOIAttributes to update the control parameters + DSON->>PMnS: 8.3 modifyMOIAttributes to update the control parameters + PMnS->>MRO: 8.3.a. update the control parameters + end + end + +``` + +Sequence diagram for MRO procedure showing interactions between Producer of performance assurance MnS, D-SON management function, Producer of provisioning MnS, and MRO function. + +Figure 8.2.2-1: MRO procedure + +1. The D-SON management function consumes the provisioning MnS with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [3]) to configure targets for the MRO function. + +1.a The provisioning MnS sets the targets for MRO function (NOTE). + +2. The MRO management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to configure the ranges of handover parameters. + +2.a The MnS of provisioning sets the ranges for MRO function (NOTE). + +3. The MRO management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to configure the MRO control parameters (e.g. Maximum deviation of Handover Trigger, Minimum time between Handover Trigger changes). + +3.a The MnS of provisioning sets the MRO control parameters for MRO function (NOTE). + +4. The D-SON management function consumes the NF provisioning MnS with *modifyMOIAttributes* operation to enable the MRO function for a given NR cell **if it is not enabled**. + - 4.a The provisioning MnS enables the MRO function (NOTE). +5. The MRO function receives MRO information reports from UE(s), and analyses them to determine the actions to optimize the MRO performance. If the performance does not meet the targets, it updates the handover parameters. +6. The D-SON management function collects MRO related performance measurements. +7. The D-SON management function analyses the measurements to evaluate the MRO performance, +8. The D-SON management function performs one of the following actions, when the MRO performance does not meet the targets: + - 8.1. Consume the MnS of provisioning with *modifyMOIAttributes* operation to update the targets of the MRO function; + - 8.1.a The MnS of provisioning updates the targets for MRO function (NOTE). + - 8.2. Consume the MnS of provisioning with *modifyMOIAttributes* operation to update the ranges of the handover parameters; + - 8.2.a The MnS of provisioning updates the ranges of the handover parameters (NOTE). + - 8.3. Consume the MnS of provisioning with *modifyMOIAttributes* operation to update the control parameters; + - 8.3.a The MnS of provisioning updates the control parameters (NOTE). + +NOTE: The interface between provisioning MnS and MRO function is not subject to standardization. + +### 8.2.3 PCI configuration + +#### 8.2.3.1 Initial PCI configuration + +Figure 8.2.3.1-1 depicts a procedure that describes how D-SON management function can manage the PCI configuration (D-SON) function to assign the PCI values to NR cells the first time. + +![Sequence diagram showing the Initial PCI configuration procedure. The D-SON management function sends 'modifyMOIAttributes to set PCI list' to the Producer of provisioning MnS, which then sends 'set the PCI list' to the PCI configuration (D-SON) function. Next, the D-SON management function sends 'modifyMOIAttributes to enable the PCI config function' to the Producer, which forwards 'enable PCI config function' to the PCI configuration function. The PCI configuration function then selects a PCI value from the list, reports it back to the Producer, and finally, the Producer sends 'notifyMOIAttributeValueChange' to the D-SON management function to indicate the assigned value.](409498e57b1f988b2b604d12cd997002_img.jpg) + +``` + +sequenceDiagram + participant D-SON as D-SON management function + participant Producer as Producer of provisioning MnS + participant PCI_Func as PCI configuration (D-SON) function + + D-SON->>Producer: 1. modifyMOIAttributes to set PCI list + Producer->>PCI_Func: 1.a. set the PCI list + D-SON->>Producer: 2. modifyMOIAttributes to enable the PCI config function + Producer->>PCI_Func: 2.a. enable PCI config function + Note right of PCI_Func: 3. Select a PCI value +from the PCI list + PCI_Func->>PCI_Func: + PCI_Func->>Producer: 4. Report the PCI value + Producer->>D-SON: 5. notifyMOIAttributeValueChange to indicate the PCI value being assigned + +``` + +Sequence diagram showing the Initial PCI configuration procedure. The D-SON management function sends 'modifyMOIAttributes to set PCI list' to the Producer of provisioning MnS, which then sends 'set the PCI list' to the PCI configuration (D-SON) function. Next, the D-SON management function sends 'modifyMOIAttributes to enable the PCI config function' to the Producer, which forwards 'enable PCI config function' to the PCI configuration function. The PCI configuration function then selects a PCI value from the list, reports it back to the Producer, and finally, the Producer sends 'notifyMOIAttributeValueChange' to the D-SON management function to indicate the assigned value. + +Figure 8.2.3.1-1: Initial PCI configuration procedure + +1. The D-SON management function consumes the MnS of NF provisioning with *modifyMOIAttributes* operation to configure the PCI list for NR cell(s). + - 1.a The MnS of provisioning sets the PCI list at the PCI configuration (D-SON) function (NOTE) + +2. The D-SON management function consumes the MnS of NF provisioning with *modifyMOIAttributes* operation to enable the PCI configuration function for NR cell(s) **if it is not enabled**. + - 2.a The MnS of provisioning enables the PCI configuration (D-SON) function (NOTE). +3. The PCI configuration (D-SON) function selects PCI value(s) from the PCI list. +4. The PCI configuration (D-SON) function reports the PCI value(s) being assigned to the MnS of NF provisioning. +5. The MnS of NF provisioning sends a notification *notifyMOIAttributeValueChange* to D-SON management function to indicate the PCI value(s) being assigned to NR cell(s). + +NOTE: The interface between MnS of NF provisioning and PCI configuration (D-SON) function is not subject to standardization. + +#### 8.2.3.2 PCI re-configuration + +Figure 8.2.3.2-1 depicts a procedure that describes how D-SON management function can re-configure the PCI list for NR cell(s) when PCI collision or PCI confusion issues were detected. + +![Sequence diagram for PCI re-configuration procedure. Lifelines: D-SON management function, Producer of provisioning MnS, Producer of fault supervision MnS, and PCI configuration (D-SON) function. The sequence starts with the PCI configuration function detecting a collision (1), reporting to fault supervision (2), notifying D-SON (3), D-SON calling modifyMOIAttributes (4), fault supervision calling re-configure (5), PCI configuration selecting a value (6), reporting back (7), and finally D-SON sending notifyMOIAttributeValueChange (8) and fault supervision confirming resolution (9).](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +``` + +sequenceDiagram + participant D-SON as D-SON management function + participant MnS as Producer of provisioning MnS + participant FMS as Producer of fault supervision MnS + participant PCI as PCI configuration (D-SON) function + + Note left of D-SON: Loop + PCI->>FMS: 1. Detect PCI collision or confusion + FMS->>D-SON: 2. notifyNewAlarm for PCI collision or confusion + D-SON->>MnS: 3. modifyMOIAttributes to re-config PCI list + MnS->>PCI: 3.a. Re-configure the PCI list + PCI->>PCI: 4. Select a PCU value from the PCI list + PCI->>MnS: 5. Report the PCI value + MnS->>D-SON: 6. notifyMOIAttributeValueChange to indicate the new PCI value + PCI->>FMS: 7. PCI collision or confusion resolved + D-SON->>MnS: 8. notifyClearedAlarm for PCI collision or confusion + +``` + +Sequence diagram for PCI re-configuration procedure. Lifelines: D-SON management function, Producer of provisioning MnS, Producer of fault supervision MnS, and PCI configuration (D-SON) function. The sequence starts with the PCI configuration function detecting a collision (1), reporting to fault supervision (2), notifying D-SON (3), D-SON calling modifyMOIAttributes (4), fault supervision calling re-configure (5), PCI configuration selecting a value (6), reporting back (7), and finally D-SON sending notifyMOIAttributeValueChange (8) and fault supervision confirming resolution (9). + +Figure 8.2.3.2-1: PCI re-configuration procedure + +1. The PCI configuration (D-SON) function detects and reports the PCI collision or PCI confusion problems for NR cell(s) to MnS of fault supervision (NOTE). +2. The producer of fault supervision MnS sends a notification *notifyNewAlarm* to D-SON management function to report the PCI collision or PCI confusion problems detected on NR cell(s). +3. The D-SON management function consumes the MnS of NF provisioning with *modifyMOIAttributes* operation to re-configure the PCI list for NR cell(s). + - 3.a The MnS of NF provisioning re-configures the PCI list for NR cell(s) (NOTE). +4. The PCI configuration (D-SON) function selects PCI value(s) from the updated PCI list. +5. The PCI configuration (D-SON) function reports the PCI value(s) being assigned to the MnS of NF provisioning. +6. The MnS of NF provisioning sends a notification *notifyMOIAttributeValueChange* to D-SON management function to indicate the PCI value(s) being assigned to NR cell(s). +7. The PCI configuration (D-SON) function notifies MnS of fault supervision that the PCI collision or PCI confusion problems have been resolved (NOTE). + +8. The producer of fault supervision MnS sends a notification *notifyClearedAlarm* to D-SON management function to report the PCI collision or PCI confusion problems being resolved. + +NOTE: The interface between MnS of NF provisioning and PCI configuration (D-SON) function is not subject to standardization. + +## 8.3 Centralized SON + +### 8.3.1 PCI configuration + +#### 8.3.1.1 Initial PCI configuration + +Figure 8.3.1.1-1 depicts a procedure that describes how C-SON can assign the PCI values to NR cells the first time. + +![Sequence diagram for Initial PCI configuration procedure. Lifelines: C-SON function, Producer of provisioning MnS, and NF for NR cell(s). The sequence starts with the C-SON function performing an internal step '1. Determine the PCI value(s) for NR cell(s)'. It then sends a '2. modifyMOIAttributes to configure the PCI value(s)' message to the Producer of provisioning MnS. The Producer of provisioning MnS sends a '2.a. set the PCI value for NR cell(s)' message to the NF for NR cell(s). Finally, the Producer of provisioning MnS sends a '3. notifyMOIAttributeValueChange to indicate the PCI value being assigned' message back to the C-SON function.](a8050baf48cc2c8e25d5ea2d1a67ef39_img.jpg) + +``` + +sequenceDiagram + participant C-SON function + participant Producer of provisioning MnS + participant NF for NR cell(s) + Note left of C-SON function: 1. Determine the PCI value(s) for NR cell(s) + C-SON function->>Producer of provisioning MnS: 2. modifyMOIAttributes to configure the PCI value(s) + Producer of provisioning MnS->>NF for NR cell(s): 2.a. set the PCI value for NR cell(s) + Producer of provisioning MnS->>C-SON function: 3. notifyMOIAttributeValueChange to indicate the PCI value being assigned + +``` + +Sequence diagram for Initial PCI configuration procedure. Lifelines: C-SON function, Producer of provisioning MnS, and NF for NR cell(s). The sequence starts with the C-SON function performing an internal step '1. Determine the PCI value(s) for NR cell(s)'. It then sends a '2. modifyMOIAttributes to configure the PCI value(s)' message to the Producer of provisioning MnS. The Producer of provisioning MnS sends a '2.a. set the PCI value for NR cell(s)' message to the NF for NR cell(s). Finally, the Producer of provisioning MnS sends a '3. notifyMOIAttributeValueChange to indicate the PCI value being assigned' message back to the C-SON function. + +Figure 8.3.1.1-1: Initial PCI configuration procedure + +1. The C-SON determines the PCI value(s) for NR cell(s). +2. The C-SON consumes the MnS of NF provisioning with *modifyMOIAttributes* operation to configure the PCI value(s) for NR cell(s). +- 2.a The MnS of provisioning sets the PCI value(s) for NR cell(s) (NOTE) +3. The producer of provisioning MnS sends a notification *notifyMOIAttributeValueChange* to C-SON function to indicate the PCI value(s) being assigned to NR cell(s). + +NOTE: The interface between MnS of provisioning and PCI configuration (D-SON) function is not subject to standardization. + +#### 8.3.1.2 PCI re-configuration + +Figure 8.3.1.2-1 depicts a procedure that describes how C-SON function can re-configure the PCI list for NR cell(s) when PCI collision or PCI confusion issues were detected. It is assumed that the C-SON function has consumed the MnS of performance assurance to create PM jobs to collect PCI related measurements. + +![](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +| C-SON function | Producer of provisioning MnS | Producer of performance assurance MnS | NF for NR cell(s) | +|----------------------------------------------------------------------------------|------------------------------|---------------------------------------|-------------------| +| <b>Loop</b> | | | | +| 1. Collect performance measurements | | | | +| 2. Analyze NRM data and measurements to detect PCI collision or confusion issues | | | | +| <b>Opt A PCI collision or confusion issue has been detected</b> | | | | +| 3. Determine the new PCI value(s) for NR cell(s) with issues | | | | +| 4. <i>modifyMOIAttributes</i> to re-config the PCI value | | | | +| | | 4.a. Set the new PCI value | | +| 5. <i>notifyMOIAttributeValueChange</i> to indicate the PCI value being assigned | | | | + +Figure 8.3.1.2-1: PCI re-configuration procedure + +1. The C-SON function collects PCI related performance measurements that are derived from *MeasResultListNR* (see clause 6.3.2 in TS 38.331 [9]) from producer of performance assurance MnS. +2. The C-SON function analyses the NRM data and PCI related measurements to detect the PCI collision or PCI confusion problems for NR cell(s). +3. The C-SON function determines the new PCI value(s) for NR cell(s). +4. The C-SON function consumes the MnS of NF provisioning with *modifyMOIAttributes* operation to re-configure the PCI values for NR cell(s). + - 4.a The MnS of NF provisioning set the PCI value(s) for NR cell(s). +5. The producer of provisioning MnS sends a notification *notifyMOIAttributeValueChange* to C-SON function to indicate the PCI value(s) being assigned to NR cell(s). + +### 8.3.2 Procedures for establishment of a new RAN NE in network + +#### 8.3.2.1 Procedures for RAN NE plug and connect to management system + +The Figure 8.3.2.1-1 illustrates the procedure for plug and connect to management system. The NE described in this procedure can be gNB in non-split scenario and gNB-DU in split scenario. + +NOTE 1: The NE within virtualization is not addressed. + +![Sequence diagram for 'Plug and connect to management system' procedure. The diagram shows the interaction between a Network Element (NE) and several servers: IP autoconfiguration server, public DNS server, CA/RA, SeGW, secure DNS server, secure DHCP server, and MnF. The process starts with an 'alt [VLAN ID is available]' block where the NE either uses an available VLAN ID or its native VLAN ID. This is followed by four 'ref' blocks: 2. Initial IP Autoconfiguration, 3. Certificate Enrolment, 4. Establishing Secure Connection, and 5. Establishing Connection to MnF. The sequence diagram is mirrored at the top and bottom with the NE on the left and the servers on the right.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +" Plug and connect to management system" + +Sequence diagram for 'Plug and connect to management system' procedure. The diagram shows the interaction between a Network Element (NE) and several servers: IP autoconfiguration server, public DNS server, CA/RA, SeGW, secure DNS server, secure DHCP server, and MnF. The process starts with an 'alt [VLAN ID is available]' block where the NE either uses an available VLAN ID or its native VLAN ID. This is followed by four 'ref' blocks: 2. Initial IP Autoconfiguration, 3. Certificate Enrolment, 4. Establishing Secure Connection, and 5. Establishing Connection to MnF. The sequence diagram is mirrored at the top and bottom with the NE on the left and the servers on the right. + +**Figure 8.3.2.1-1: Procedures for plug and connect to management system** + +1. If a VLAN ID is available, the NE uses it. Otherwise the NE uses the native VLAN where PnP traffic is sent and received untagged. + +2. NE invokes the "Initial IP Autoconfiguration" procedure and acquires its IP address through stateful or stateless IP Autoconfiguration. There may be additional information provided to the NE. + +NOTE 2: The detailed "Initial IP Autoconfiguration" procedure refers to clause 5.2 of TS 32.508 [15]. + +3. NE invokes the "Certificate Enrolment" procedure. + +NOTE 3: The detailed "Certificate Enrolment" procedure refers to clause 5.3 of TS 32.508 [15]. + +4. NE invokes the "Establishing Secure Connection" procedure and connects to the OAM SeGW. + +NOTE 4: The detailed "Establishing Secure Connection" procedure refers to clause 5.4 of TS 32.508 [15]. + +5. NE invokes the "Establishing Connection to MnF" procedure. + +NOTE 5: The detailed "Establishing Connection to MnF" procedure refers to clause 5.5 of TS 32.508 [15] and MnF act as the role of EM. + +#### 8.3.2.2 Procedures for self-configuration management + +The Figure 8.3.2.2-1 illustrates the procedure for start self-configuration management. + +![Sequence diagram titled 'Procedures for self-configuration management' showing interactions between MnS Consumer and MnS Producer of self-configuration management. The diagram includes a request-response for creating a management profile, followed by a loop for the self-configuration process. Inside the loop, there's an optional notification of creation, a loop for stop points/steps, an optional resume request from the consumer, and a final notification of deletion.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +**" Procedures for self-configuration management "** + +``` + +sequenceDiagram + actor MnS Consumer of self-configuration management + participant MnS Producer of self-configuration management + + Note over MnS Consumer, MnS Producer: " Procedures for self-configuration management " + + MnS Consumer->>MnS Producer: 1. createScManagementProfile request + MnS Producer-->>MnS Consumer: 2. Create ScManagementProfile + MnS Producer-->>MnS Consumer: 3. createScManagementProfile response + + loop NE start its self-configuration process + opt NotifyScProcessCreation + MnS Producer-->>MnS Consumer: 4. NotifyScProcessCreation + end + + loop stop point or step is arrived + MnS Producer-->>MnS Consumer: 5. NotifyScProcessStage + + opt if the stop point is arrived + MnS Consumer->>MnS Producer: 6. ResumeScProcess + end + end + + MnS Producer-->>MnS Consumer: 7. NotifyScProcessDeletion + end + +``` + +Sequence diagram titled 'Procedures for self-configuration management' showing interactions between MnS Consumer and MnS Producer of self-configuration management. The diagram includes a request-response for creating a management profile, followed by a loop for the self-configuration process. Inside the loop, there's an optional notification of creation, a loop for stop points/steps, an optional resume request from the consumer, and a final notification of deletion. + +**Figure 8.3.2.2-1: Procedures for self-configuration management** + +1. MnS consumer of self-configuration management sends `createScManagementProfile` request for NE(s) of a certain type to MnS producer of self-configuration management. NE information, stop point information and step information may be included in the request. +2. MnS producer of self-configuration management creates `ScManagementProfile` instance for NE(s) specified in the received request. +3. MnS producer of self-configuration management sends the `create ScManagementProfile` response to MnS producer of self-configuration management. +4. For each NE (specified in the created `ScManagementProfile`) starting its self-configuration process, MnS producer of self-configuration management sends `NotifyScProcessCreation` notification to MnS consumer of self-configuration management. +5. When arrival at a stop point (e.g. stop point waiting for the network configuration data) or step described in corresponding `ScManagementProfile`, MnS producer of self-configuration management sends `NotifyProcessStage` notification to MnS consumer of self-configuration management. +6. If arrival at a stop point in step 5), MnS consumer of self-configuration management sends `ResumeScProcess` request to MnS producer of self-configuration management. If the self-configuration process is suspended at a stop point and is waiting for the network configuration data, the request include network configuration data or information indicating location of network configuration data. +7. When the self-configuration process is terminated, the MnS producer of self-configuration management sends `NotifyScProcessDeletion` notification to MnS consumer of self-configuration management. + +# Annex A (informative): PlantUML source code + +## A.1 Procedures for establishment of a new RAN NE in network + +### A.1.1 Procedure for plug and connect to management system + +The following PlantUML source code is used to describe the procedure for multi-vendor plug and connect to management system, as depicted by Figure 8.3.2.1-1: + +``` +@startuml +title " Plug and connect to management system" +actor NE +participant "IP autoconfgiuration server" as IP_Server +participant "public DNS server" as P_DNS_Server +participant "CA/RA" as CA_RA +participant SeGW +participant "secure DNS server" as S_DNS_Server +participant "secure DHCP server" as S_DHCP_Server +participant MnF +alt VLAN ID is available +NE->>NE: 1a.use available VLAN Id +Else +NE->>NE: 1b.use native VLAN Id +End +Ref over NE, IP_Server: 2. Initial IP Autoconfiguration +Ref over NE, IP_Server, CA_RA: 3. Certificate Enrolment +Ref over NE, IP_Server, CA_RA, SeGW: 4. Establishing Secure Connection +Ref over NE, IP_Server, CA_RA, SeGW, MnF: 5 Establishing Connection to MnF + +skinparam sequenceActorBackgroundColor #FFFFFF +skinparam sequenceParticipantBackgroundColor #FFFFFF +skinparam noteBackgroundColor #FFFFFF +autonumber "'.'." +skinparam monochrome true +skinparam shadowing false +@enduml +``` + +### A.1.2 Procedure for self-configuration management + +The following PlantUML source code is used to describe the procedure for self-configuration management, as depicted by Figure 8.3.2.2-1: + +``` +@startuml +title " Procedures for self-configuration management " +actor "MnS Consumer of \n self-configuration management" as SC +participant "MnS Producer of \n self-configuration management" as SP +SC -> SP: 1. createScManagementProfile request +SP -> SP: 2. Create ScManagementProfile +SP -> SC: 3. createScManagementProfile response +loop [Corresponding NE start its self-configuration process] +opt +SP -> SC: 4. NotifyScProcessCreation +end +||| +loop stop point or step is arrived +SP -> SC: 5. NotifyScProcessStage +opt if the stop point is arrived +SC -> SP: 6. ResumeScProcess +end +end +||| +SP->>SC: 7.NotifyScProcessDeletion +end +``` + +``` +skinparam sequenceActorBackgroundColor #FFFFFF +skinparam sequenceParticipantBackgroundColor #FFFFFF +skinparam noteBackgroundColor #FFFFFF +autonumber "#'. '" +skinparam monochrome true +skinparam shadowing false +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-09 | SA#89e | | | | | Upgrade to change control version | 16.0.0 | +| 2020-12 | SA#90e | SP-201045 | 0001 | - | F | Add subclause reference for ranges of handover parameters | 16.1.0 | +| 2020-12 | SA#90e | SP-201045 | 0002 | - | F | Corrections on notification information of PCI configuration | 16.1.0 | +| 2020-12 | SA#90e | SP-201045 | 0004 | 1 | F | Address the issues discovered by Edithelp | 16.1.0 | +| 2020-12 | SA#90e | SP-201045 | 0005 | - | F | Fix the wrong references | 16.1.0 | +| 2020-12 | SA#90e | SP-201045 | 0006 | - | F | Change RACH control attributes from beam to cell | 16.1.0 | +| 2021-12 | SA#94e | SP-211462 | 0031 | - | F | Correction of Figure 8.3.2.2-1 title for self-configuration | 16.2.0 | +| 2022-09 | SA#97e | SP-220853 | 0049 | 1 | F | Correction of intra-RAT and inter-RAT too early and too late handover failures description | 16.3.0 | +| 2023-03 | SA#99 | SP-230203 | 0055 | - | F | Align the attribute name of SON case with TS 28.541 | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28390/raw.md b/marked/Rel-16/28_series/28390/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..16f6d88a8ebe541d46ff6f230b141a4b3e927f75 --- /dev/null +++ b/marked/Rel-16/28_series/28390/raw.md @@ -0,0 +1,309 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +- Foreword ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions, symbols and abbreviations..... 6 + - 3.1 Definitions..... 6 + - 3.2 Abbreviations ..... 6 +- 4 NGCOR Fault Management Solution Profile ..... 6 + - 4.1 Requirement statements ..... 6 + - 4.2 System context ..... 9 + - 4.3 SP ..... 9 +- Annex A (informative): Change history..... 11 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The objective of this specification is to define a set of Solution Profiles (SPs) for Interface IRPs. Each SP identifies the necessary and sufficient subset of the 3GPP IRP defined solutions (solutions) required for the network management of a specific operating environment or domain, including that defined for the converged management environments. + +A specific operating environment or domain is characterised by a set of Requirement statements. In other words, the solutions identified in a specific SP would satisfy the Requirements listed in that same SP. + +An SP, in its simplest form, is nothing else than a list of solutions (e.g. 3GPP IRP defined operations). The purpose is to place a combination of solutions under a common (SP) *name* so that: + +- Operators and vendors need not decide arbitrarily which solutions are to be used to satisfy the Requirements; +- There is one document where readers can have a clear view of solutions, specified in various IRP specifications, required to satisfy the Requirements. + +This version of the TS contains a number of SPs defined in clause 4 and onwards, one clause for each SP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [2] NGMN Alliance NGCOR: "Next Generation Converged Operations Requirements" v1.3. +- [3] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP); Information Service (IS)". +- [4] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.352: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.332: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.122: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP); Information Service (IS)". +- [8] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [8] and TS 32.150 [1] apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [8]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [8], TS 32.150 [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 [8]. + +| | | +|-------|---------------------------------------------------| +| FM | Fault Management | +| NGCOR | Next Generation Converged Operations Requirements | +| SP | Solution Profile | + +# --- 4 NGCOR Fault Management Solution Profile + +## 4.1 Requirement statements + +These requirement statements, pertaining to fault management, are extracted from [2]. The REQ-GEN (1..22) statements are from section 2 of [2]. The REQ-FM (1..8) statements are from section 5 of [2]. + +### ***REQ-GEN (1..22)*** + +#### **REQ-GEN (1) “Plug & Play”** + +It must be possible to implement the interfaces between the OSS easy and efficient by lowest costs and smallest effort (ideally without any development and/or configuration). The standard specification must enable “Plug&Play” (e.g. by unambiguously defined interface capabilities). Priority: Major + +#### **REQ-GEN (2) Useful** + +It must deliver efficient support for the OSS business processes. The standard specification interface must deliver the needed OSS semantics to support the process. Priority: Major + +#### **REQ-GEN (3) Re-Useable/ Generic** + +The standard interface specification must be generic enough, to enable the re-use in different integration scenarios. Priority: Essential + +#### **REQ-GEN (4) Simple** + +The standard interface specification must be simple (that means: the interface should offer only really necessary capabilities), so that people which have not been involved in the specification are able to understand it (or even do not need to understand the details), so that they are able to implement, maintain and use the interface. Priority: Essential + +#### **REQ-GEN (5) Flexible/ Extendible** + +The interface can be extended and refined, from basic setup to more complex implementations without impact on the other communication partners. It must be possible to extend the interface capabilities (methods and attributes), without breaking the standard. The standard interface specification must enable this. Priority: Major + +#### **REQ-GEN (6) Fine grained (as far as needed)** + +Means: Focus on using valid Use case to motivate the interface design. In such case, the standard Interface specification will be of the correct grade of grain. Fine grained functionality ONLY where really needed and absolutely necessary to support the common basic process. Adding more and more capabilities into the standard interface specification will lead to complex and expensive implementations (which often hinders the adoption of the interface) and might lead to a dilution of the scope of the interface and overlapping functionality with other interfaces. Priority: Major + +#### **REQ-GEN (7) Standardized/ Open** + +The requirement means, that we need an “unambiguously standardized specification” without room for interpretation (which usually hinders Plug & Play, s.o.). This standard can be an existing specification or a new one. NGMN-NGCOR will not specify any standard. The specification and everything needed to make use of the standard (e.g. appendixes to the specification-document which are not part of the document itself, etc.) must be freely available and useable for everyone. Priority: Essential + +#### **REQ-GEN (8) Mature/ Stable** + +The standard interface specification must be stable and mature, to avoid expensive changes on implemented interfaces. Changes in the application or in the interface implementation at one of the communication partners may not lead to the need for changes in the application or in the interface implementation of the other communication partners. (Please consider that this requirement does not assume any specific type of implementation technology.) The standard interface specification must enable this capability. Priority: Major + +#### **REQ-GEN (9)** + +Changes in the application or in the interface implementation at one of the communication partners may not lead to the need for changes in the application or in the interface implementation of the other communication partners. (Please consider that this requirement does not assume any specific type of implementation technology.) Priority: Essential + +#### **REQ-GEN (10) Evolutionary** + +OSS standard interface specification shall re-use already existing, widely adopted and mature IT standards (e.g. transport protocols) to avoid “reinventing the wheel”. The interface standard specification must be independent from underlying infrastructure. The standard must be agnostic to the implementation-platform (e.g. the standard may not rely on capabilities of a specific Operating System). Priority: Essential + +#### **REQ-GEN (11)** + +The interface standard specification must be independent from underlying infrastructure. The standard must be agnostic to the implementation-platform (e.g. the standard may not rely on capabilities of a specific Operating System). Priority: Essential + +#### **REQ-GEN (12) Certifiable** + +The Interface must be specified in a way that makes it technically possible to validate an implementation compliancy. Beside of that, the standard should include a mechanism to certify the standard compliancy of the interface implementation. Priority: Major + +#### **REQ-GEN (13) Compatible** + +It must be possible to implement a new version of an interface specification at one of the communication partners while the other communication partners still use an old version of the interface specification. This “mixed versions” of interface implementations can be used without any impact on the communication partners or the interface implementations of the communication partners. The standard interface specification must enable this capability. Priority: Essential + +#### **REQ-GEN (14) Interoperable** + +The interface implementation shall be based on an interoperable portfolio of standard interfaces/ interface specifications to support different dynamic and configurable OSS business workflow and processes using a common architecture and a common information model. The standard must enable this by delivering the standard portfolio of interfaces and interface specifications. Priority: Major + +#### **REQ-GEN (15) Scalable** + +The standard interface specification must be able to be enlarged to accommodate a growth of traffic. Priority: Essential + +#### **REQ-GEN (16) Secure** + +The standard interface specification has to be able to ensure confidentiality, integrity and availability of the data, which is transferred by the interface. Priority: Minor + +#### **REQ-GEN (17) Reliable** + +The interface implementation has to ensure the reliability of the data, which is transferred by the interface. The standard interface specification must enable this capability. Priority: Essential + +#### **REQ-GEN (18) Interface Robustness** + +No interface dependencies on availability between NMS and EMS if one of the EMSs (Server) communication partners is not available. The standard interface specification must enable this capability. Priority: Essential + +#### **REQ-GEN (19) Simple Trace and Logging** + +The standard interface specification must deliver a simple “trace and logging” functionality (in readable text format). +Priority: Essential + +#### **REQ-GEN (20) 1:1 Relation between Event MO Instances and Inventory MO Instances** + +Priority: Major + +#### **REQ-GEN (21) “MO Instance” Attribute Information Structure for EMS $\leftrightarrow$ NMS Event Interfaces** + +Priority: Major + +#### **REQ-GEN (22) M : N Connectivity** + +Multiple EMS applications might be connected (logically) to multiple NMS applications (M : N). +Priority: Major + +#### **REQ-FM (1) X.733 Event/Alarm Attributes** + +The event/alarm must contain structured information according to the X.733 specification. Priority: Essential + +#### **REQ-FM (2) Event/Alarm Transport** + +It must be possible to send (Server) [and receive/listen to (Client) event/alarms]. See also REQ-FM (9), +Priority: Essential + +#### **REQ-FM (3) Clear – Event/Alarm Transport** + +It must be possible to send [and receive/listen to] “clear” - event/alarm events. Priority: Essential + +#### **REQ-FM (4) Unambiguous ID** + +It must be possible to correlate between clear-event/alarm and the original event/alarm, by using an unambiguous ID. +Priority: Essential + +#### **REQ-FM (5) Event/Alarm Query** + +Priority: Essential + +#### **REQ-FM (6) Heartbeat** + +The interface has to support a heartbeat capability which allows EMS to send heartbeats (configurable) and NMS to receive/listen to heartbeats. Priority: Essential + +#### **REQ-FM (7) Supplementary Information contained within alarm** + +The interface has to provide all information required for correlation. Priority: Essential + +#### **REQ-FM (8) Co-operative alarm acknowledgement (OPTIONAL)** + +The interface shall support a co-operative alarm-acknowledgement function as described in 3GPP TS 32.111-1 (Optional feature). Priority: Minor + +#### **REQ-FM (9) Reliable Event/Alarm Communication (supported by EMS)** + +- EMS buffers event/alarms if they cannot be sent to the NMS +- EMS sends event/alarms immediately as soon as the connectivity to the NMS is up again + +Priority: Essential + +#### **REQ-FM (10) Configurable EMS Heartbeat Message** + +EMS will send heartbeats in regular (configurable) intervals to NMS. Priority: Essential + +#### **REQ-FM (11) Alarm Suppression** + +The EMS - NMS - Fault Management interface should enable the alarm suppression. Priority: Major + +#### **REQ-FM (12) Summary Alarms** + +EMS interface summary should provide summary alarm functionality. Priority: Major + +#### **REQ-FM (13) Re-Synchronization** + +The NMS must be able to synchronize the own event/alarm list with the EMS event/alarm lists. Priority: Essential + +## 4.2 System context + +The general definition of “System Context” can be found in 3GPP TS 32.150 [1] subclause 4.7. + +The set of related IRP(s) relevant to this SP is shown in the following diagram. + +![Diagram showing the system context with IRPManager (NM), IRPAgent (EM), and NEs connected via Itf-N interface. A list of IRPs is shown below the interface.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +The diagram illustrates the system context for the Fault Management SP. On the left, a box labeled 'NM' contains 'IRPManager'. On the right, a box labeled 'EM' contains 'IRPAgent'. A solid line connects 'IRPManager' to 'IRPAgent'. To the right of 'IRPAgent', a dotted line connects it to a box labeled 'NEs'. A vertical dashed line, labeled 'Itf-N' at its base, separates the 'NM' and 'EM' components. Below the 'Itf-N' label, a list of IRPs is shown, with a curved arrow pointing from the list to the interface line. The IRPs listed are: Alarm IRP, Notification IRP, Communication Surveillance IRP, Notification Log IRP, and Advanced Alarming Management IRP. + +Diagram showing the system context with IRPManager (NM), IRPAgent (EM), and NEs connected via Itf-N interface. A list of IRPs is shown below the interface. + +**Figure 4.2-1: System Context** + +## 4.3 SP + +This section specifies the Fault Management SP for NGCOR. Specifically, this SP identifies the necessary and sufficient subset of the IRP Interface operations that can satisfy the fault management requirements stated in [2]. The SP is presented in the Table below. + +The column labels identify the fault management specific and the general requirements stated in [2], presented by column labels as REQ-FM(..) and REQ-GEN(..). The row labels identify the various IRP Interface operations. An empty cell means that the related operation does not support the related requirement. A cell marked has the following meanings. + +- X: The related operation supports the related requirement; +- A: The related operation supports the related requirement. REQ-FM (1) requires the use of ITU-T X.733 defined structured information. Current IRP solution supports the use of all X.733 defined Probable Causes. Current IRP solution supports a subset of X.733 defined Event Type. Enhancement of current IRP may need to be considered. +- B: the related operation supports the related requirement. REQ-FM (5) requires a ‘query’ type of service for both alarms and events. Current IRP supports a ‘query’ type service for alarms (e.g. result of a query is carried by the response of the query request). The current IRP supports an export facility with filtering capability for events (e.g. result of an query is carried in a file and not in the response of the query request). +- C: The related operation supports the related requirement. REQ-FM (12) requires support of Toggle and Transient Rule of activateAAMRule (..) only. +- \*: Some requirements are stated in a general form (e.g. “REQ-GEN (2) Useful”) and are related to the design principle of the protocol and implementation. They are not related to any particular operation(s) or notification(s); nevertheless these IRPs in general support those requirements. Their requirement column headings are marked with a “\*” (e.g. “REQ-FM(9)”). + +**Table 4.3-1: NGCOR FM SP** + +| | REQ-FM (..) | | | | | | | | | | | | | REQ-GEN (..) | | | +|-----------------------------|-------------|---|---|---|---|---|---|---|----|----|----|----|----|--------------|----|--------| +| | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9* | 10 | 11 | 12 | 13 | 1-18* | 19 | 20-22* | +| <b>Alarm IRP [3]</b> | | | | | | | | | | | | | | | | | +| acknowledgeAlarms | | | | | | | | X | | | | | | | | | +| getAlarmList | A | | | | X | | | | | | X | | X | | | | +| notifyNewAlarm | A | X | | | | | X | | | | | | | | | | +| notifyAckStateChanged | | X | | | | | | X | | | | | | | | | +| notifyChangedAlarm | | X | | | | | | | | | | | | | | | +| notifyClearedAlarm | | X | X | X | | | | | | | | | | | | | +| notifyAlarmListRebuilt | | X | | | | | | | | | | | X | | | | +| <b>AAM IRP [7]</b> | | | | | | | | | | | | | | | | | +| activateAAMRule | | | | | | | | | | | | C | | | | | +| deactivateAAMRule | | | | | | | | | | | | X | | | | | +| getAAMRules | | | | | | | | | | | | X | | | | | +| <b>Notification IRP [4]</b> | | | | | | | | | | | | | | | | | +| subscribe | | X | | | | | | | | | X | | | | | | +| unsubscribe | | X | | | | | | | | | X | | | | | | +| <b>CS IRP [5]</b> | | | | | | | | | | | | | | | | | +| setHeartbeatPeriod | | | | | | X | | | | X | | | | | | | +| triggerHeartbeat | | | | | | X | | | | | | | | | | | +| notifyHeartbeat | | | | | | X | | | | | | | | | | | +| <b>NL IRP [6]</b> | | | | | | | | | | | | | | | | | +| subscribeLog | | | | | | | | | | | | | | | X | | +| unsubscribeLog | | | | | | | | | | | | | | | X | | +| exportLogRecords | | | | | B | | | | | | | | | | X | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2013-06 | SA#60 | SP-130280 | | | Presented to SA Plenary for approval | 1.1.1 | 2.0.0 | +| 2013-06 | | | | | Upgrade of approved version | 2.0.0 | 12.0.0 | +| 2014-12 | SA#66 | SP-140798 | 001 | 1 | Remove feature support statement | 12.0.0 | 12.1.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.1.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28402/raw.md b/marked/Rel-16/28_series/28402/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..dd7c63e38a35ad21b4e11b5bd3ab09bb5caf8a17 --- /dev/null +++ b/marked/Rel-16/28_series/28402/raw.md @@ -0,0 +1,252 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 6 + +2 References..... 6 + +3 Definitions and abbreviations ..... 7 + +3.1 Definitions..... 7 + +3.2 Abbreviations ..... 7 + +4 Measurements related to ePDG..... 8 + +4.1 Tunnel establishment measurements..... 8 + +4.1.1 Attempted tunnel establishment ..... 8 + +4.1.2 Successful tunnel establishment..... 8 + +4.1.3 Failed tunnel establishment ..... 8 + +5 Measurements related to 3GPP AAA Server..... 9 + +5.1 Attached subscribers measurement ..... 9 + +5.1.1 Mean number of attached subscribers ..... 9 + +5.1.2 Maximum number of attached subscribers..... 9 + +**Annex A (informative): Use cases for performance measurements definition..... 10** + +A.1 Use case for tunnel establishment measurements ..... 10 + +A.2 Use case for attached subscribers measurement ..... 10 + +Annex B (informative): Change history..... 11 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 32.401 Performance Management (PM); Concept and requirements +- 52.402 Performance Management (PM); Performance measurements – GSM +- 32.404 Performance Management (PM); Performance measurements - Definitions and template +- 32.405 Performance Management (PM); Performance measurements Universal Terrestrial Radio Access Network (UTRAN) +- 32.406 Performance Management (PM); Performance measurements Core Network (CN) Packet Switched (PS) domain +- 32.407 Performance Management (PM); Performance measurements Core Network (CN) Circuit Switched (CS) domain +- 32.408 Performance Management (PM); Performance measurements Teleservice +- 32.409 Performance Management (PM); Performance measurements IP Multimedia Subsystem (IMS) +- 32.425 Telecommunication management; Performance Management (PM); Performance measurements Evolved Universal Terrestrial Radio Access Network (E-UTRAN) +- 32.426 Telecommunication management; Performance Management (PM); Performance measurements Evolved Packet Core (EPC) network +- 32.452 Performance Management (PM); Performance measurements Home Node B Subsystem (HNS) +- 32.453 Performance Management (PM); Performance measurements Home enhanced Node B Subsystem (HeNS) +- 28.402 Performance Management (PM); Performance measurements for Evolved Packet Core (EPC) and non-3GPP access Interworking System** + +The present document is part of a set of specifications, which describe the requirements and information model necessary for the standardized Operation, Administration and Maintenance (OA&M) of the Evolved Packet Core (EPC) and non-3GPP access Interworking System (TS 23.402 [4]). + +During the lifetime of EPC and non-3GPP access network interworking, its logical and physical configuration undergo changes of varying degrees and frequencies in order to optimize the utilization of the network resources. These changes are executed through network configuration management activities and/or network engineering, see TS 32.600 [1]. + +Many of the activities involved in the daily operation and future network planning of interworking require data on which to base decisions. This data refers to the load carried by the network and the grade of service offered. In order to produce this data performance measurements are executed in the NEs, which comprise the network. The data can then be transferred to an external system, e.g. an Operations System (OS) in TMN terminology, for further evaluation. + +Annex B of TS 32.404 [2] helps in the definition of new performance measurements that can be submitted to 3GPP for potential adoption and inclusion in the present document. Annex B of TS 32.404 [2] discusses a top-down performance measurement definition methodology that focuses on how the end-user of performance measurements can use the measurements. + +# 1 Scope + +The present document describes the measurements for EPC and non-3GPP access network interworking. + +TS 32.401 [3] describes Performance Management concepts and requirements. + +The present document is valid for all measurement types provided by an implementation of EPC and non-3GPP access Interworking System. Only measurement types that are specific to EPC and non-3GPP access interworking are defined within the present documents. Vendor specific measurement types used in EPC and non-3GPP access Interworking System are not covered. Instead, these could be applied according to manufacturer's documentation. + +Measurements related to "external" technologies (such as ATM or IP) as described by "external" standards bodies (e.g. ITU-T or IETF) are only be referenced within this specification, wherever there is a need identified for the existence of such a reference. + +The definition of the standard measurements is intended to result in comparability of measurement data produced in a multi-vendor network, for those measurement types that can be standardised across all vendors' implementations. + +The structure of the present document is as follows: + +- Header 1: Network Element (e.g. measurements related to ePDG); +- Header 2: Measurement function (e.g. Tunnel establishment); +- Header 3: Measurements. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [2] 3GPP TS 32.404: "Performance Management (PM); Performance measurements - Definitions and template". +- [3] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements". +- [4] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [5] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [5] 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 [5]. + +The measurement names defined in the present document are all beginning with a prefix containing the measurement family name. This family name identifies all measurements which relate to a given functionality and it may be used for measurement administration (see TS 32.401 [3]). + +The list of families currently used in the present document is as follows: + +- SUB (measurements related to Subscriber Management) +- TUN (measurements related to Tunnel Establishment Management) + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [5] 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 [5]. + +| | | +|------|------------------------------------------| +| AAA | Access, Authentication and Authorisation | +| ePDG | Evolved Packet Data Gateway | + +# --- 4 Measurements related to ePDG + +## 4.1 Tunnel establishment measurements + +The measurements types defined in subclause 4.1 are subject to the "2 out of 3 approach". + +### 4.1.1 Attempted tunnel establishment + +- a) This measurement provides the number of attempted tunnel establishment +- b) CC +- c) Receipt of tunnel establishment request message from UE to ePDG +- d) A single integer value +- e) TUN.TunEst Att +- f) EPDGFunction +- g) Valid for packet switched traffic. +- h) EPS + +### 4.1.2 Successful tunnel establishment + +- a) This measurement provides the number of successful tunnel establishment +- b) CC. +- c) Transmission of tunnel establishment response message from ePDG to UE +- d) A single integer value. +- e) TUN.TunEstSucc +- f) EPDGFunction +- g) Valid for packet switched traffic. +- h) EPS + +### 4.1.3 Failed tunnel establishment + +- a) This measurement provides the number of failed tunnel establishment +- b) CC +- c) Transmission of tunnel establishment reject message from ePDG to UE +- d) A single integer value. +- e) TUN.TunEstFail +- f) EPDGFunction +- g) Valid for packet switched traffic. +- h) EPS + +# --- 5 Measurements related to 3GPP AAA Server + +## 5.1 Attached subscribers measurement + +### 5.1.1 Mean number of attached subscribers + +- a) This measurement provides the mean number of attached state subscribers +- b) SI +- c) This measurement is obtained by sampling at a pre-defined interval the number of attached subscribers in AAA server and then taking the arithmetic mean +- d) A single integer value +- e) SUB.AttachedSubNbrMean +- f) 3GPPAAAServerFunction, 3GPPAAProxyFunction +- g) Valid for packet switching +- h) Combined + +### 5.1.2 Maximum number of attached subscribers + +- a) This measurement provides the maximum number of attached state subscribers +- b) SI +- c) This measurement is obtained by sampling at a pre-defined interval the number of attached subscribers in AAA server and then taking the maximum +- d) A single integer value +- e) SUB.AttachedSubNbrMax +- f) 3GPPAAAServerFunction, 3GPPAAProxyFunction +- g) Valid for packet switching +- h) Combined + +# --- Annex A (informative): Use cases for performance measurements definition + +This annex provides the use cases for the EPC and non-3GPP access Interworking System performance measurements defined in clause 4 and clause 5. + +## --- A.1 Use case for tunnel establishment measurements + +It needs to setup secure tunnels between non-3GPP UE and remote tunnel endpoint once UE attaches to interworking system. The tunnel resides between the non-3GPP UE and ePDG. In order to guarantee the user experiences, the tunnel should be established before the data is transmitted. During the period of tunnel establishment, ePDG may reject the tunnel establishment due to QoS profile request or policy enforcement in AAA servers. Those rejections would impact subsequent traffic transmission and user experiences. + +It is desirable for operators to get the indications before massive rejection happened. + +## --- A.2 Use case for attached subscribers measurement + +Non-3GPP UE attach status indicates whether the non-3GPP UE is now being served by the EPC. + +The non-3GPP UE attach status is maintained by the 3GPP AAA Server. In the attached state, the UE can initiate packets and receive services via EPC and non-3GPP access network interworking. Operators need to have the knowledge of the number of attached subscribers in AAA server or AAA proxy server to evaluate the capacity status of servers. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | | +|----------------|-------|-----------|----|-----|----------------------------------------------------------------------|--|--|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | | | Old | New | +| 2013-04 | | | | | Initial version for TS skeleton | | | 0.0.0 | 0.0.1 | +| 2013-05 | | | | | Update the draft with the comments at the meeting and email approval | | | 0.0.1 | 0.1.0 | +| 2013-06 | | | | | Add performance measurement to TUN | | | 0.1.0 | 0.2.0 | +| 2014-09 | | | | | Move the applicable counters from 28.401. Corrections of the scope | | | 0.2.0 | 0.3.0 | +| 2014-09 | | | | | Editorial corrections | | | 0.3.0 | 0.3.1 | +| 2014-09 | SP-65 | SP-140547 | | | Presented for information and approval | | | 0.3.1 | 1.0.0 | +| | | | | | Upgrade to Rel-12 version | | | 1.0.0 | 12.0.0 | +| 2016-01 | SP-70 | | | | Upgrade to Rel-13 (MCC) | | | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|--|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28403/raw.md b/marked/Rel-16/28_series/28403/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..804a02c98a3bb57bc45193ffca9bada23049a7d5 --- /dev/null +++ b/marked/Rel-16/28_series/28403/raw.md @@ -0,0 +1,306 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Measurement family ..... | 6 | +| 5 Measurements related to WLAN ..... | 6 | +| 5.1 Measurements related to WLAN AP data volume..... | 6 | +| 5.1.1 Number of incoming unicast IP packets received at WLAN AP ..... | 6 | +| 5.1.2 Number of outgoing unicast IP packets transmitted by WLAN AP..... | 6 | +| 5.1.3 Number of incoming multicast IP packets received at WLAN AP ..... | 7 | +| 5.1.4 Number of outgoing multicast IP packets transmitted by WLAN AP ..... | 7 | +| 5.1.5 Number of incoming broadcast IP packets received at WLAN AP ..... | 7 | +| 5.1.6 Number of outgoing broadcast IP packets transmitted by WLAN AP..... | 8 | +| 5.2 Measurements related to CSMA/CA protocol ..... | 8 | +| 5.2.1 Number of successful RTS responses ..... | 8 | +| 5.2.2 Number of failed RTS responses..... | 8 | +| 5.2.3 Number of failed ACK responses..... | 8 | +| 5.3 Measurements related to WLAN data packets..... | 9 | +| 5.3.1 Number of successful MPDU receptions ..... | 9 | +| 5.3.2 Number of failed MPDU receptions..... | 9 | +| 5.4 Measurements related to station association ..... | 9 | +| 5.4.1 Number of associated stations ..... | 9 | +| <b>Annex A (informative): Use cases for performance measurements definition.....</b> | <b>11</b> | +| A.1 Use case for WLAN AP data volume related measurements ..... | 11 | +| A.2 Use case for CSMA/CA protocol related measurements..... | 11 | +| A.3 Use case for WLAN data packets related measurements ..... | 11 | +| A.4 Use case for station association measurements..... | 11 | +| Annex B (informative): Change history..... | 12 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 32.401 Performance Management (PM); Concept and requirements +- 52.402 Performance Management (PM); Performance measurements – GSM +- 32.404 Performance Management (PM); Performance measurements - Definitions and template +- 32.405 Performance Management (PM); Performance measurements Universal Terrestrial Radio Access Network (UTRAN) +- 32.406 Performance Management (PM); Performance measurements Core Network (CN) Packet Switched (PS) domain +- 32.407 Performance Management (PM); Performance measurements Core Network (CN) Circuit Switched (CS) domain +- 32.408 Performance Management (PM); Performance measurements Teleservice +- 32.409 Performance Management (PM); Performance measurements IP Multimedia Subsystem (IMS) +- 32.425 Performance Management (PM); Evolved Performance measurements Universal Terrestrial Radio Access Network (E-UTRAN) +- 32.426 Performance Management (PM); Evolved Packet Core (EPC) +- 28.401 Telecommunication management; Performance Management (PM); Performance measurements for Core Network (CN) and non-3GPP access Interworking System +- 28.402 Telecommunication management; Performance Management (PM); Performance measurements for Evolved Packet Core (EPC) and non-3GPP access Interworking System +- 28.403 Performance Management (PM); Performance measurements for Wireless Local Area Network (WLAN)** + +# --- 1 Scope + +The present document describes the measurements for WLAN. + +TS 32.401 [3] describes Performance Management concepts and requirements. + +The present document is valid for all measurement types provided by an implementation of a WLAN. + +Only measurement types that are specific to WLAN are defined within the present document. Vendor specific measurement types used in WLAN are not covered. Instead, these could be applied according to manufacturer's documentation. + +Measurements related to "external" technologies (such as WLAN or IP) as described by "external" standards bodies (e.g. IEEE or IETF) are only referenced within the present document, wherever there is a need identified for the existence of such a reference. + +The definition of the standard measurements is intended to result in comparability of measurement data produced in a multi-vendor network, for those measurement types that can be standardised across all vendors' implementations. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [2] 3GPP TR 32.841: "Telecommunication management; Study on Wireless Local Area Network (WLAN) management". +- [3] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements". +- [4] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [5] IETF RFC 2863: "The Interfaces Group MIB". +- [6] IEEE 802.11™-2012: "IEEE Standard for Information technology--Telecommunications and information exchange between systems Local and metropolitan area networks--Specific requirements Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [4] apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [4]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [4] 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 [4]. + +| | | +|---------|---------------------------------------------------| +| ACK | Acknowledgement | +| CSMA/CA | Carrier Sense Multiple Access/Collision Avoidance | +| CTS | Clear to Send | +| FCS | Frame Check Sum | +| MPDU | MAC Protocol Data Unit | +| PER | Packet Error Rate | +| RTS | Request to Send | +| TF | Transparent Forwarding | + +# --- 4 Measurement family + +The measurement names defined in the present document are all beginning with a prefix containing the measurement family name (e.g. RRC.AttConnEstab.Cause). This family name identifies all measurements which relate to a given functionality and it may be used for measurement administration (see TS 32.401 [3]). + +# --- 5 Measurements related to WLAN + +## 5.1 Measurements related to WLAN AP data volume + +### 5.1.1 Number of incoming unicast IP packets received at WLAN AP + +- a) This measurement provides the number of incoming unicast IP packets received at the WLAN AP (see `ifHCInUcastPkts` in IF-MIB [5]). +- b) TF. +- c) This counter is defined in IF-MIB in IETF RFC 2863 [5]. +- d) A single integer value. +- e) `IP.InUnicastPacketWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.1.2 Number of outgoing unicast IP packets transmitted by WLAN AP + +- a) This measurement provides the number of outgoing unicast IP packets transmitted by the WLAN AP (see `ifHCOutUcastPkts` in IF-MIB in IETF RFC 2863 [5]). +- b) TF. +- c) This counter is defined in IF-MIB in IETF RFC 2863 [5]. +- d) A single integer value. +- e) `IP.OutUnicastPacketWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.1.3 Number of incoming multicast IP packets received at WLAN AP + +- a) This measurement provides the number of incoming multicast IP packets received at the WLAN AP (see `ifHCInMulticastPkts` in IF-MIB in IETF RFC 2863 [5]). +- b) TF. +- c) This counter is defined in IF-MIB in IETF RFC 2863 [5]. +- d) A single integer value. +- e) `IP.InMulticastPacketWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.1.4 Number of outgoing multicast IP packets transmitted by WLAN AP + +- a) This measurement provides the number of outgoing multicast IP packets transmitted by the WLAN AP (see `ifHCOutMulticastPkts` in IF-MIB in IETF RFC 2863 [5]). +- b) TF. +- c) This counter is defined in IF-MIB in IETF RFC 2863 [5]. +- d) A single integer value. +- e) `IP.OutMulticastPacketWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.1.5 Number of incoming broadcast IP packets received at WLAN AP + +- a) This measurement provides the number of incoming broadcast IP packets received at the WLAN AP (see `ifHCInBroadcastPkts` in IF-MIB in IETF RFC 2863 [5]). +- b) TF. +- c) This counter is defined in IF-MIB in IETF RFC 2863 [5]. +- d) A single integer value. +- e) `IP.InBroadcastPacketWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.1.6 Number of outgoing broadcast IP packets transmitted by WLAN AP + +- a) This measurement provides the number of outgoing broadcast IP packets transmitted by the WLAN AP (see `ifHCOutBroadcastPkts` in IF-MIB in IETF RFC 2863 [5]). +- b) TF. +- c) This counter is defined in IF-MIB in IETF RFC 2863 [5]. + +- d) A single integer value. +- e) IP.OutBroadcastPacketWlanAP. +- f) APFunction. +- g) Valid for packet switched traffic. +- h) Combined. + +## 5.2 Measurements related to CSMA/CA protocol + +### 5.2.1 Number of successful RTS responses + +- a) This measurement provides the number of CTS (Clear to Send) received in response to an RTS (Request to Send) at the WLAN AP (see `dot11RTSSuccessCount` in IEEE802dot11-MIB in IEEE 802.11 [6]). +- b) TF. +- c) This counter is defined in IEEE802dot11-MIB in IEEE 802.11 [6]. +- d) A single integer value. +- e) MAC.SuccRtsWlanAP. +- f) APFunction. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.2.2 Number of failed RTS responses + +- a) This measurement provides the number of CTS not received in response to an RTS at the WLAN AP (see `dot11RTSFailureCount` in IEEE802dot11-MIB in IEEE 802.11 [6]). +- b) TF. +- c) This counter is defined in IEEE802dot11-MIB in IEEE 802.11 [6]. +- d) A single integer value. +- e) MAC.FailRtsWlanAP. +- f) APFunction. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.2.3 Number of failed ACK responses + +- a) This measurement provides the number of ACK (Acknowledgement) not received after transmitting the data at the WLAN AP (see `dot11ACKFailureCount` in IEEE802dot11-MIB in IEEE 802.11 [6]). +- b) TF. +- c) This counter is defined in IEEE802dot11-MIB in IEEE 802.11 [6]. +- d) A single integer value. +- e) MAC.FailAckWlanAP. +- f) APFunction. +- g) Valid for packet switched traffic. + +- h) Combined. + +## 5.3 Measurements related to WLAN data packets + +### 5.3.1 Number of successful MPDU receptions + +- a) This measurement provides the number of incoming MPDU (MAC Protocol Data Unit) successfully received at the WLAN AP (see `dot11ReceivedFragmentCount` in IEEE802dot11-MIB in IEEE 802.11 [6]). +- b) TF. +- c) This counter is defined in IEEE802dot11-MIB in IEEE 802.11 [6]. +- d) A single integer value. +- e) `MAC.successMpduWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +### 5.3.2 Number of failed MPDU receptions + +- a) This measurement provides the number of MPDU received with FCS (Frame Check Sum) error at the WLAN AP (see `dot11FCSSErrorCount` in IEEE802dot11-MIB in IEEE 802.11 [6]). +- b) TF. +- c) This counter is defined in IEEE802dot11-MIB in IEEE 802.11 [6]. +- d) A single integer value. +- e) `MAC.failedMpduWlanAP`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +## 5.4 Measurements related to station association + +### 5.4.1 Number of associated stations + +- a) This measurement provides the number of stations (see `dot11AssociatedStationCount` from IEEE802dot11-MIB in IEEE 802.11 [6]) that are associated with the WLAN AP. +- b) TF. +- c) This counter is defined in IEEE802dot11-MIB in IEEE 802.11 [6]. +- d) A single integer value. +- e) `NumberOfAssociatedStation`. +- f) `APFunction`. +- g) Valid for packet switched traffic. +- h) Combined. + +# --- Annex A (informative): Use cases for performance measurements definition + +## A.1 Use case for WLAN AP data volume related measurements + +WLAN AP data volume related measurements are used to measure data volume on the WLAN air interface, including incoming and outgoing data packets at IP layer. The measurements provide indication on how much UE traffic have been carried over the WLAN. If the data volume measurements are too low, it may indicate to operators that potential problems exist at a WLAN AP to prevent UEs from transmitting or receiving the data packets. If the data volume measurements are too high, it may signal the hot spot areas where additional WLAN APs may need to be deployed. + +## --- A.2 Use case for CSMA/CA protocol related measurements + +CSMA/CA (Carrier sense multiple access with collision avoidance) is a technology used in WLAN AP to enable multiple UEs to access a common wireless carrier without conflict. CSMA/CA protocol related measurements count the number of successful RTS / CTS responses, failed RTS/CTS responses, and failed ACK responses that are tied closely to the WLAN performance. For example, higher percentage of RTS failure rate (i.e. the number of failed RTS response / (the number of failed RTS response + the number of successful RTS response) may indicate higher number of conflicts among AP and UEs that prevent the UE from responding with CTS. Failed ACK responses indicate that AP has received CTS to send the data packet, but the UE cannot receive data packet successfully. Therefore, higher percentage rate of ACK failure rate (i.e. the number of failed ACK responses / (the number of failed ACK responses + the number of successful ACK responses) may indicate higher number of data packets being corrupted or lost, due to reasons, such as interferences, signal fading, etc. So, higher percentage of RTS and ACK failure rates may indicate to operators why the users are suffering from poor WLAN performance. + +## --- A.3 Use case for WLAN data packets related measurements + +WLAN data packets related measurements include the number of successful MPDU reception, and the number of failed MPDU reception that can be used to calculate WLAN Packet Error Rate (PER). WLAN PER may indicate to operators the performance of a WLAN AP. For example, higher WLAN packet error rate may imply poor WLAN performance. + +## --- A.4 Use case for station association measurements + +A station is associated with a WLAN AP, when the station passed the authentication process, and is able to gain full access to the WLAN AP. Association allows the WLAN AP to record each station so that frames may be received from a station or sent to a station. The station association measurements enable operators to compute the mean and maximum numbers of associated station in a given interval that provide statistical information on how many station(s) are served by the WLAN AP. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-12 | SP-70 | SP-150689 | | | Presented for approval | 1.2.0 | 2.0.0 | +| | | | | | Upgrade to Rel-13 | 2.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-12 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28404/raw.md b/marked/Rel-16/28_series/28404/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..65df36b7ec15795c8e2af2c0c56c5c0119f16ec6 --- /dev/null +++ b/marked/Rel-16/28_series/28404/raw.md @@ -0,0 +1,285 @@ + + + + + + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 5 + +2 References..... 5 + +3 Definitions and abbreviations ..... 5 + +3.1 Definitions..... 5 + +3.2 Abbreviations ..... 5 + +4 Concepts and background ..... 6 + +4.1 Concepts..... 6 + +4.2 Background ..... 6 + +5 Business Level Requirements ..... 6 + +5.1 Requirements..... 6 + +5.1.1 Collecting QoE information from end user services for UTRAN and LTE..... 6 + +5.2 Actor roles ..... 7 + +5.3 Telecommunication resources..... 7 + +5.4 High-level use cases..... 7 + +5.4.1 Collecting QoE information from a specific end user service type..... 7 + +5.4.2 Void ..... 8 + +5.4.3 Collecting QoE information from end user service type of specific streaming sources ..... 8 + +5.4.4 Indication of QoE information collection..... 8 + +5.4.5 Change collecting QoE information ..... 9 + +5.4.6 Void ..... 10 + +6 Specification level requirements..... 10 + +6.1 Requirements..... 10 + +Annex A (informative): Change history..... 11 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +**TS 28.404: "Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements";** + +TS 28.405: "Quality of Experience (QoE) measurement collection; Control and configuration"; + +TS 28.406: "Quality of Experience (QoE) measurement collection; Information definition and transport"; + +One main motivation of mobile network evolution is to improve the user experience, which is why the evaluation of the user experience at the UE side is vital to network operators. This is especially true when the operators provide high bit rate real-time services like streaming services (typically video services), where even intermittent quality degradation is very annoying. Many of these streaming services are a significant part of the commercial traffic growth rate, therefore the focus is on the end users' experience . + +Quality of Experience (QoE) information collection provides detailed information at call level on a number of UEs. + +The capability to log information within a UE, and in particular the QoE of an end user service, initiated by an operator, provides the operator with QoE information. The collected information (specified in TS 26.247 [2]) cannot be deduced from performance measurements in the mobile network. + +The QoE information is information collected by the end user application in the UE. + +The QoE information is collected by the management system for analysis and/or KPI calculations. + +# --- 1 Scope + +The present document addresses concepts, business level use cases and requirements for the function Quality of Experience (QoE) measurement collection in UMTS and LTE. The measurements that are collected are DASH [2] and MTSI [3] measurements. + +The function includes collecting QoE information from UEs frequenting a specified area . + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 26.247: " Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [3] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [4] 3GPP TS 28.307: "Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|-----|-----------------------| +| QoE | Quality of Experience | +|-----|-----------------------| + +# --- 4 Concepts and background + +## 4.1 Concepts + +A network request session is a session in the mobile network when the network checks for UEs that have the capability to provide requested information. + +An UE request session is a session in the network when the network has found an UE that has the capability to provide the requested information and the request is forwarded to the UE. + +A recording session is a session in the UE when it initiates recording of the requested end user service/end user service type and record the requested information. + +## 4.2 Background + +The collection of QoE information for a specified end user service/end user service type either from UEs in a specified area . The collected information is transported to a collection centre, where it can be analysed and/or KPIs can be calculated. + +A collection can be requested by an operator technician via the management system to the traffic network. As the network do not have any knowledge which UEs have the capability to record the requested data, therefore the UEs will report whether they have this capability or not when a session set up. UEs that has this capability that match the request from the management system will be requested to start recording the requested information when the request constraints are met. The UE will make the recorded data available for management system. + +# --- 5 Business Level Requirements + +## 5.1 Requirements + +### 5.1.1 Collecting QoE information from end user services for UTRAN and LTE + +**REQ-EUSPC-CON-1:** The operator shall have a capability to request collection of QoE information per end user service/end user service type for a specified area. The request may include an address of a collection centre to which the collected information shall be delivered. + +**REQ-EUSPC-CON-2:** The application providing the end user service performance information should have the capability to provide this information to a collection centre. + +**REQ-EUSPC-CON-3:** It should be possible to restrict the QoE information collection to a subset of the sessions in a UE using an end user service/end user service type. + +**REQ-EUSPC-CON-4:** Void. + +**REQ-EUSPC-CON-5:** The management system shall have a capability to request collection of end user service performance information for a specific service type provided by specific streaming sources. The request may include information of streaming sources for which the information shall be collected. + +**REQ-EUSPC-CON-6:** The 3GPP network shall have a capability to forward an indication to the management system that a recording session has been started. + +**REQ-EUSPC-CON-7:** The operator shall have a capability to stop the collection of QoE information job. + +**REQ-EUSPC-CON-8:** Void. + +**REQ-EUSPC-CON-9:** Void. + +**REQ-EUSPC-CON-10:** Void. + +NOTE: The QoE information to be collected are specified in ref. 3GPP TS 26.247 [2] and TS 3GPP TS 26.114 [3]. + +## 5.2 Actor roles + +See each use case in clause 5.4. + +## 5.3 Telecommunication resources + +See each use case in clause 5.4. + +## 5.4 High-level use cases + +### 5.4.1 *Collecting QoE information from a specific end user service type* + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Allow the operator to obtain QoE information for an end user service type based on a 5% of those sessions in a UE(s) in a specified area using a specific end user service type, in a specified collection centre. | | +| Actors and roles | The operator which is the requester of the QoE information. | | +| Telecom resources | The management system, the mobile network and the UE. | | +| Assumptions | The application providing an end user service type is able to provide QoE information about its end user service performance. | | +| Pre-conditions | Selected end users are using the specified end user service type. | | +| Begins when | The management system receives a request from the operator. | | +| Step 1 (M) | The management system receives a request from the operator and transfers it to the mobile network. | | +| Step 2 (M) | The mobile network receives the request, starts a network request session and starts to check which connections fulfil the request. | | +| Step3 (M) | When a connection is found that fulfils the request, the mobile network starts an UE request session and transfers the request to the UE. | | +| Step 4 (M) | When the requested end user service type is started in the UE, it records the requested information for 5% of sessions of the requested service type and sends the recorded information to the specified collection centre. | | +| Ends when | The network request session expires. | | +| Exceptions | | | +| Post-conditions | The collected information is present in the specified collection centre. | | +| Traceability | <b>REQ-EUSPC-CON-1, REQ-EUSPC-CON-2 and REQ-EUSPC-CON-3</b> | | +| NOTE Step 3 to 4 is repeated for all UEs that access the network in the specified area during the network request session. | | | + +### 5.4.2 Void + +### 5.4.3 Collecting QoE information from end user service type of specific streaming sources + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Allow the operator to obtain QoE information from end user service type from specific streaming sources. | | +| Actors and roles | The operator which is the requester of the QoE information. | | +| Telecom resources | The management system, the mobile network and the UE. | | +| Assumptions | The application providing streaming video service is able to provide QoE information about its end user performance. | | +| Pre-conditions | The selected end users are using the specified end user service type from the specified streaming sources. | | +| Begins when | The operator requests a QoE information collection for a specific service type from specific streaming sources. | | +| Step 1 (M) | When the management system receives a request from the operator, it transfers the request to the mobile network. | | +| Step 2 (M) | When the mobile network receives the request it starts a network request session and starts to check which connections fulfil the request. | | +| Step 3 (M) | When a connection is found, the mobile network starts a UE request session and transfers the request to the UE. | | +| Step 4 (M) | When the specified service type is started in the UE, the UE checks whether the streaming source is consistent with any of the streaming sources set by the request, and if yes, the UE collects relevant QoE information and send to the network. | | +| Ends when | The network request session expires. | | +| Exceptions | | | +| Post-conditions | The collected information is present in the specified collection center. | | +| Traceability | <b>REQ-EUSPC-CON-2, REQ-EUSPC-CON-3 and REQ-EUSPC-CON-5.</b> | | + +### 5.4.4 Indication of QoE information collection + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Provide the OAM system with an indication that a recording session has started and subsequently allow the OAM system to modify the QoE measurement configuration e.g. the QoE configured area if the number of sessions are too small or too large.<br>The indication may also be used to determine whether or not to terminate the QoE information collection if sufficient number of recording sessions have been started. | | +| Actors and roles | The operator which is the requester of the QoE information. | | +| Telecom resources | The management system and the RAN node. | | +| Assumptions | | | +| Pre-conditions | Selected end users have been requested to provide QoE Information when the specified end user service type is used. | | +| Begins when | The application layer sends AT command including streaming indication to access stratum. | | + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Step 1 (M) | When the RAN node receives the streaming indication from the UE access stratum, the RAN node sends an indication to the triggering OAM system that a recording session has been started. | | +| Ends when | The management system has received the indication that a recording session has been started. | | +| Exceptions | | | +| Post-conditions | The OAM system is able to decide if the ongoing QoE measurement collection needs modification and if sufficient data has been obtained for analysis.<br>The OAM system can use the indications to trigger evaluation of collected data. | | +| Traceability | <b>REQ-EUSPC-CON-6</b> | | +| | | | + +### 5.4.5 Change collecting QoE information + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Allow the operator to change an ongoing QoE information collection job. | | +| Actors and roles | The operator which is the requester of changing the QoE information collection job. | | +| Telecom resources | The management system, the mobile network and the UE. | | +| Assumptions | - | | +| Pre-conditions | The QoE collection job is active. | | +| Begins when | The operator has information that QoE information collection job needs to have more information as collected data will not be sufficient or that the collected information is enough. | | +| Step 1 (M) | The management system receives a request from the operator to terminate the ongoing QoE information collection job. | | +| Step 2 (M) | For all connections where the UE has been requested to start the QoE job, the mobile network transfer the termination request to the UE, which terminates the specified QoE collection information job. | | +| Step 3 (M) | When all QoE collections are terminated in the UEs for the specified QoE information collection job, the mobile network finish to terminate the QoE information collection job. | | + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Step 4 (O) | If collected information will not be sufficient, the operator initiates a new QoE information collection job. | Collecting QoE information from a specific end user service type, or Collecting QoE information from end user service type from a specific user. | +| Ends when | The network request session is terminated (when sufficient amount of data is collected), or when the new network request is started (when the collected data will not be sufficient). | | +| Exceptions | | | +| Post-conditions | The network request session is terminated or the new network request is started. | | +| Traceability | <b>REQ-EUSPC-CON-1 and REQ-EUSPC-CON-7</b> | | +| | | | + +### 5.4.6 Void + +# 6 Specification level requirements + +## 6.1 Requirements + +Specification level requirements for the management of QoE Measurement Collection is specified in [4]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | SA#85 | | | | | Change control version | 16.0.0 | +| 2019-12 | SA#86 | SP-191179 | 0001 | - | F | Revise the Introduction | 16.1.0 | +| 2020-03 | SA#87E | SP-200177 | 0002 | - | C | Removing Signalling Based Activation | 16.2.0 | +| 2021-09 | SA#93e | SP-210883 | 0004 | - | F | Aligning with RAN specifications 36.331 and 25.331 | 16.3.0 | +| 2022-12 | SA#98e | SP-221169 | 0011 | 2 | F | Flow correction and clean up | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28405/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/28_series/28405/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..242e0b65d992ff762077bd646a3773b01a75067e --- /dev/null +++ b/marked/Rel-16/28_series/28405/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d2cd47968f4616c92d37d45722cb62f5c7eab5e80c03c9e91113c3013fb8eab7 +size 64181 diff --git a/marked/Rel-16/28_series/28405/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg b/marked/Rel-16/28_series/28405/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9558e262433ca0f4e5609498439bcb78a1c4d317 --- /dev/null +++ b/marked/Rel-16/28_series/28405/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d812581f3969bfd26cab2134dc401e079f1f3b3827814e8459a083fb41a8bdd +size 38018 diff --git a/marked/Rel-16/28_series/28405/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/28_series/28405/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f1f0cfd315dec2bf559a4007704c2ad7fee9f91 --- /dev/null +++ b/marked/Rel-16/28_series/28405/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:632b8530a371b8be5dcaea4750189cba834ae108b507e9d795782e840dabd07c +size 7600 diff --git a/marked/Rel-16/28_series/28405/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/28_series/28405/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26fd53abef53f6006c18b37e7980ad7d9fc921af --- /dev/null +++ b/marked/Rel-16/28_series/28405/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c809a272a0875e9ab4896d0496e46dd775d4ff800da817a9e1c51203f5d3c05 +size 5792 diff --git a/marked/Rel-16/28_series/28405/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/28_series/28405/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c04a7c43a7a9d9c353141106cf3d88a0890bfb79 --- /dev/null +++ b/marked/Rel-16/28_series/28405/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55afd97ff0bd4fd45224759982bbc17d05d1310d8ace52e1db1a3e9fa49a0344 +size 64867 diff --git a/marked/Rel-16/28_series/28405/c9d8a18a6137ad054b841d7a614afb48_img.jpg b/marked/Rel-16/28_series/28405/c9d8a18a6137ad054b841d7a614afb48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..12a9b00598320ddee25927d262bf41be17e4ed88 --- /dev/null +++ b/marked/Rel-16/28_series/28405/c9d8a18a6137ad054b841d7a614afb48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:787b82503680e2409b7f2694f8b08ebe0d25338f22aaeb3a556b21239316af34 +size 39216 diff --git a/marked/Rel-16/28_series/28405/raw.md b/marked/Rel-16/28_series/28405/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5098f86cc17025cd2a53cadba16e64ef1de25dff --- /dev/null +++ b/marked/Rel-16/28_series/28405/raw.md @@ -0,0 +1,616 @@ + + +# 3GPP TS 28.405 V16.2.0 (2021-12) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Services and System Aspects; +Telecommunication management; +Quality of Experience (QoE) measurement collection; +Control and configuration +(Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring a stylized '5G' with three green signal waves emanating from the top right of the 'G'. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base. + +3GPP logo + +A GLOBAL INITIATIVE + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 7 | +| 4 Quality of Experience (QoE) measurement collection ..... | 7 | +| 4.1 Management based activation in UTRAN ..... | 7 | +| 4.1.1 Activation of measurement collection job and reporting of collected information in UTRAN..... | 7 | +| 4.1.2 Handling of measurement collection at handover in UTRAN ..... | 8 | +| 4.1.2.1 Handover between cells within an RNC..... | 8 | +| 4.1.2.2 Handover between RNCs..... | 8 | +| 4.1.3 Deactivation of measurement collection job in UTRAN ..... | 10 | +| 4.1.3.1 Forced deactivation in UTRAN..... | 10 | +| 4.1.3.2 Deactivation of recording session in UTRAN ..... | 10 | +| 4.2 Management based activation in LTE..... | 10 | +| 4.2.1 Activation of measurement collection job and reporting of collected information in LTE ..... | 10 | +| 4.2.2 Handling of measurement collection at handover in LTE..... | 11 | +| 4.2.2.1 Handover between cells within an eNB..... | 11 | +| 4.2.2.2 Handover between eNBs ..... | 11 | +| 4.2.3 Deactivation of measurement collection job in LTE..... | 13 | +| 4.2.3.1 Forced deactivation..... | 13 | +| 4.2.3.2 Deactivation of recording session..... | 13 | +| 4.2.4 Void ..... | 13 | +| 5 Quality of Experience (QoE) measurement management parameters ..... | 13 | +| 5.1 QoE collection entity address (M) ..... | 13 | +| 5.2 QoE reference (M) ..... | 13 | +| 5.3 PLMN target (CM)..... | 13 | +| 5.4 Area scope (CM)..... | 14 | +| 5.5 QMC configuration file (container) (M) ..... | 14 | +| 5.6 QMC target (M) ..... | 14 | +| 5.7 Recording session id (M) ..... | 14 | +| 5.8 Service type (M)..... | 14 | +| Annex A (informative): Change history..... | 15 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 +- 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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 28.404: "Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements"; + +**TS 28.405: "Quality of Experience (QoE) measurement collection; Control and configuration";** + +TS 28.406: "Quality of Experience (QoE) measurement collection; Information definition and transport". + +One main motivation of mobile network evolution is to improve the user experience, which is why the evaluation of the user experience at the UE side is vital to network operators. This is especially true when the operators provide high bit rate real-time services like streaming services (typically video services), where even intermittent quality degradation is very annoying. Many of these streaming services are a significant part of the commercial traffic growth rate, therefore the focus is on the end users' experience. + +Quality of Experience (QoE) information collection provides detailed information at session level on a number of UEs. + +The capability to log information within a UE, and in particular the QoE of an end user service, initiated by an operator, provides the operator with QoE information. The collected information (specified in 3GPP TS 26.247 [6]) cannot be deduced from performance measurements in the mobile network. + +The QoE information is information collected by the end user application in the UE. + +The QoE information is collected by the management system for analysis and/or KPI calculations. + +# 1 Scope + +The present document addresses the mechanisms used for the function Quality of Experience (QoE) measurement collection in UMTS and LTE. The measurements that are collected are DASH [6] and MTSI [7] measurements. + +The function includes collecting QoE information from UEs frequenting a specified area or an individual UE for a specified end user service/end user service type. The document describes the activation and deactivation of a network request session, UE request session and recording session and also the reporting of recorded information [2]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.404: "Telecommunication management;Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements". +- [3] 3GPP TS 28.308: "Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS)". +- [4] 3GPP TS 25.331: "Radio Resource Control (RRC) protocol specification". +- [5] 3GPP TS 27.007: "AT command set for User Equipment (UE)". +- [6] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [7] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [8] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC) protocol specification". +- [9] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [10] 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|-----|------------------------------| +| DM | Domain Manager | +| MCE | Measurement Collector Entity | +| NB | Node B | +| QMC | QoE Measurement Collection | +| QoE | Quality of Experience | + +# 4 Quality of Experience (QoE) measurement collection + +## 4.1 Management based activation in UTRAN + +### 4.1.1 Activation of measurement collection job and reporting of collected information in UTRAN + +The parameters for the network request session are sent from the management system to the RNCs that host the cells that are included in the collection job request in the *activateAreaQMCJob* operation [3]. The RNC starts a network request session, with the *Network request session id* [3] given in *activateAreaQMCJob* operation [3]. For the duration of the network request session, the RNC(s) checks for connections where the UE has the UE Application Layer Measurement Capability [10]. The UE Application Layer Measurement Capability is sent from the UE to RNC (via the core network) in message INITIAL UE MESSAGE [10]. + +When a session is found that has a UE with the UE Application Layer Measurement Capability, the RNC starts a UE request session by sending a MEASUREMENT CONTROL message [4] to the UE via the NB. + +The AT command +CAPPLEVMC [5] activates provisioning of measurement reporting from the lower layers to the application within the UE by an unsolicited result code +CAPPLEVMC. When information about a measurement report is received in the UE from the network, the unsolicited result code +CAPPLEVMC contains the relevant parameters (*service\_type*, *start\_stop-indication* and *config-file* & *config-file length* if applicable) that are provided from the lower layers in the UE to the application. + +![Sequence diagram illustrating QMC activation and reporting in UTRAN. The diagram shows interactions between MCE, NM, DM/EM, RNC, and UE (Access Stratum and Application Level).](c9d8a18a6137ad054b841d7a614afb48_img.jpg) + +``` + +sequenceDiagram + participant MCE + participant NM + participant DM/EM + participant RNC + participant UE as UE + Note right of UE: Access Stratum + Note right of UE: Application Level + + NM->>DM/EM: 1. activateAreaQMCJob + Note left of DM/EM: - Service type +- Area scope +- QoE CE Address +- PLMN target +- QMC Target +- QoE reference +- QMC Config. file + DM/EM->>RNC: 2. activateAreaQMCJob + Note left of RNC: - Service Type +- Area scope +- QoE CE Address +- PLMN target +- QMC Target +- QoE reference +- QMC Config. file + Note right of RNC: 3. Start finding a UE that match the criteria. + RNC->>UE: 4. RRCConnectionReconfiguration + Note left of UE: - Service Type +- QoE reference +- QMC Config. file + UE->>UE: 5. +CAPPLEVMC + Note left of UE: - Service Type +- QoE reference +- QMC Config. file + Note right of UE: 6. Application starts and QoE measurement collection is initiated + UE->>RNC: 7. +CAPPLEVMR + Note left of UE: Recording Session Indication + RNC->>NM: 8. MeasurementReport + Note left of RNC: - Recording Session Indication + NM->>DM/EM: 9. Notification + Note left of NM: - Recording Session Indication + Note right of UE: 10. Measurement collection completed + UE->>RNC: 11. +CAPPLEVMR + Note left of UE: - QoE reference +- Report +- QoE reference +- Recording session id + RNC->>NM: 12. Measurement Report + Note left of RNC: - QoE reference +- Report +- QoE reference +- Recording session id + NM->>MCE: 13. Report + Note left of NM: - QoE reference +- Recording session id + +``` + +Sequence diagram illustrating QMC activation and reporting in UTRAN. The diagram shows interactions between MCE, NM, DM/EM, RNC, and UE (Access Stratum and Application Level). + +Figure 4.1.1-1: QMC activation and reporting in UTRAN + +- The NM sends *activateAreaQMCJob* to DM/EM that controls the impacted RNC(s), and includes the parameters: *serviceType*, *areaScope*, *qoECollectionEntityAddress*, *pLMNTarget*, *qMCTarget*, *qoEReference* and QMC configuration file. +- The DM/EM forwards *activateAreaQMCJob* to impacted RNC(s), and includes the parameters: *serviceType*, *areaScope*, *qoECollectionEntityAddress*, *pLMNTarget*, *qMCTarget*, *qoEReference* and QMC configuration file. + +3. The RNC checks for connections where the UE has the UE Application Layer Measurement Capability [10] that match the criteria for `serviceType` in the `activateAreaQMCJob`. +4. When a connection is found that has the UE Application Layer Measurement Capability [10], the RNC start a UE request session and stores the associated `QoECollectionEntityAddress`, sends the message `RRConnectionReconfiguration` to the UE, and includes the following: `serviceType`, `qoEReference` and QMC configuration file. +5. The access stratum in the UE sends the AT command `+CAPPLEVMC` to application level and includes the following: `serviceType`, `qoEReference` and QMC configuration file. +6. When the application in the `serviceType` starts, the QMC is initiated. +7. The application layer sends the AT command `+CAPPLEVMR` including a recording session indication that a session has started to the access stratum. +8. The UE sends the message `MeasurementReport` including the recording session indication to the RNC. +9. The RNC sends a notification including the recording session indication to the NM. +10. When the QMC is completed, the recorded information is collected in a QMC report [6], [7], including `qoEReference` and `recordingSessionId`. The `qoEReference`, `Client Id` [6], [7] in the reporting container (that represent the UE request session), and `recordingSessionId` are needed in the QMC collection entity for post processing purposes. +11. The application layer sends the AT command `+CAPPLEVMR` including `qoEReference` and the QMC report to the access stratum. +12. The UE sends the message `MeasurementReport` including `qoEReference` and the QMC report to the RNC. +13. The RNC sends the QMC report to the MCE associated to the `qoEReference`. + +### 4.1.2 Handling of measurement collection at handover in UTRAN + +#### 4.1.2.1 Handover between cells within an RNC + +When handover is made, the measurement area is checked. + +- If the mobile is inside the measurement area after the handover, the RNC sends in an indication that the UE is inside the measurement area in the `RRConnectionReconfiguration` message [4] to the UE. The UE send the `+CAPPLEVMC` AT command [5] to the application to inform that recording shall start if the application becomes active (when the UE moves into the measurement area). +- If the mobile has moved outside the measurement area, there is no indication that the UE is inside the measurement area in the `RRConnectionReconfiguration` message [4] from the RNC to the UE. The UE sends the `+CAPPLEVMC` AT command [5] to the application to inform that recording shall not be started even if the application becomes active. + +#### 4.1.2.2 Handover between RNCs + +The figure 4.1.2.2-1 and the text below describes the handling at handover between RNCs. + +![Sequence diagram showing the handling of QMC activation in case of handover in UTRAN. The diagram involves MCE, NM, Source RNC, Target RNC, UE (Access Stratum), and UE (Application Level). The process starts with a Handover Request from Source RNC to Target RNC, followed by a Handover Request Ack, RRCReconfiguration, and RRCReconfigurationComplete. The UE's access stratum sends +CAPPLEVMC to the application level. When the application becomes active, QMC is initiated. The application layer sends +CAPPLEVMR to the access stratum, which then sends a MeasurementReport to the Target RNC. The Target RNC sends a Notification to the NM, which then sends a Report to the MCE. The process ends with a Measurement collection completed message.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant MCE + participant NM + participant Source RNC + participant Target RNC + participant UE as UE + Note right of UE: Access Stratum + Note right of UE: Application Level + + Source RNC->>Target RNC: 1. Handover Request + Note right of Target RNC: 2. If a recording session has not started, the target RNC checks if the target cell is inside the areaScope or not + Target RNC->>Source RNC: 3. Handover Request Ack + Source RNC->>UE: 4. RRCReconfiguration + Note right of UE: 5. +CAPPLEVMC + UE->>Target RNC: 6. RRCReconfigurationComplete + Note right of UE: 7. When the application becomes active, QMC is initiated if the UE is inside the areaScope + Note right of UE: 8. +CAPPLEVMR + Note right of UE: -Recording session Indication + UE->>Target RNC: 9. MeasurementReport + Note right of Target RNC: -Recording session Indication + Target RNC->>NM: 10. Notification + Note right of NM: -Recording session Indication + Note right of UE: 11. Measurement collection completed + Note right of UE: 12. +CAPPLEVMR + Note right of UE: - QoE reference + Note right of UE: - Report + Note right of UE: - QoE reference + Note right of UE: - Recording session ID + UE->>Target RNC: 13. Measurement Report + Note right of Target RNC: - QoE reference + Note right of Target RNC: - Report + Note right of Target RNC: - QoE reference + Note right of Target RNC: - Recording session ID + Target RNC->>MCE: 14. Report + Note right of MCE: - QoE reference + Note right of MCE: - Recording session ID + +``` + +Sequence diagram showing the handling of QMC activation in case of handover in UTRAN. The diagram involves MCE, NM, Source RNC, Target RNC, UE (Access Stratum), and UE (Application Level). The process starts with a Handover Request from Source RNC to Target RNC, followed by a Handover Request Ack, RRCReconfiguration, and RRCReconfigurationComplete. The UE's access stratum sends +CAPPLEVMC to the application level. When the application becomes active, QMC is initiated. The application layer sends +CAPPLEVMR to the access stratum, which then sends a MeasurementReport to the Target RNC. The Target RNC sends a Notification to the NM, which then sends a Report to the MCE. The process ends with a Measurement collection completed message. + +**Figure 4.1.2.2-1: Handling of QMC activation in case of handover in UTRAN** + +1. Source RNC sends the message `HandoverRequest` to Target RNC and includes `areaScope`, `qoECollectionEntityAddress` and a recording session indication indicating whether a recording session has started. +2. If a recording session has not started, the target RNC checks if the target cell is inside the `areaScope` or not. +3. The target RNC sends the message `Handover Request Ack` to the source RNC. +4. The source RNC sends the message `RRCReconfiguration` to the UE. +5. The access stratum in the UE sends the AT command `+CAPPLEVMC` to application level. +6. The UE sends the message `RRCReconfigurationComplete` to the RNC. +7. When the application becomes active, QMC is initiated if the UE is inside the `areaScope`. +8. The application layer sends the AT command `+CAPPLEVMR` including a recording session indication to the access stratum. +9. The UE sends the message `MeasurementReport` including the recording session indication to the RNC. +10. The RNC sends a notification including the recording session indication to the NM. +11. When the QMC is completed, the recorded information is collected in a QMC report [6] and [7]. including `qoEReference` and `recordingSessionId`. The `qoEReference`, `Client Id` [6] and [7] in the reporting container (that represent the UE request session) and `recordingSessionId` are needed in the QoE collection entity for post processing purposes. +12. The application layer sends the AT command `+CAPPLEVMR` including `qoEReference` and the QMC report to the access stratum. +13. The UE sends the message `MeasurementReport` including `qoEReference` and the QMC report to the RNC. +14. The RNC sends the QMC report to the MCE associated to the `qoEReference`. + +### 4.1.3 Deactivation of measurement collection job in UTRAN + +#### 4.1.3.1 Forced deactivation in UTRAN + +If the operator technician or the management application wants to deactivate a measurement collection job before the pre-set time has expired, the management system sends the deactivateQMCJob operation [3] to the RNC. The RNC sets the network request session to ended, but does not delete the UE request session id and the Collection Entity Address parameters [3], as the UE still may send reports which shall be sent to the collection centre. For UE request sessions which have reported that a recording session is started, the RNC sends the MeasurementControl message [4] with the DeactivateJob request to relevant UEs. The Access stratum sends +CAPPLEVMC AT command [5] to the application with the DeactivateJob request. The application stops the recording session and stops recording of the requested information. The UE request session id and the Collection Entity Address parameters [3] in the RNC are deleted when the UE request session is ended. + +#### 4.1.3.2 Deactivation of recording session in UTRAN + +Regardless of whether the pre-set time has elapsed or not, the recording session continues to be active until the session for the application is ended. + +## 4.2 Management based activation in LTE + +### 4.2.1 Activation of measurement collection job and reporting of collected information in LTE + +The parameters for the network request session are sent from the management system to the eNBs that host the cells that are included in the collection job request in the activateAreaQMCJob operation [3]. The eNB starts a network request session, with the Network request session id [3] given in activateAreaQMCJob operation [3]. For the duration of the network request session, the eNB(s) checks for connections where the UE has the QoE-MeasReport capability [8] for collection of streaming services or the QoE-MTSI-MeasReport capability [8] for collection of MTSI services. The UE capability is sent from the UE to eNB via the core network in message UE CAPABILITY INFO INDICATION [9]. + +When a session is found that has a UE with the wanted UE capability, the eNB starts a UE request session and sends a RRCConnectionReconfiguration [8] to the UE. + +The AT command +CAPPLEVMC [5] activates provisioning of measurement reporting from the lower layers to the application within the UE by an unsolicited result code +CAPPLEVMC. When information about a measurement report is received in the UE from the network, the unsolicited result code +CAPPLEVMC contains the relevant parameters (service\_type, start\_stop-indication and config-file & config-file length if applicable) that are provided from the lower layers in the UE to the application. + +![Sequence diagram showing QMC activation and reporting in LTE. Lifelines: MCE, NM, DM/EM, eNB, UE (Access Stratum), UE (Application Level). The process involves activateAreaQMCJob from NM to DM/EM, then to eNB. eNB finds a matching UE and sends RRCConnectionReconfiguration to UE AS. UE AS sends +CAPPLEVMC to UE App Level. UE App Level starts measurement collection and sends MeasurementReport back to eNB. eNB sends Notification to DM/EM and Report to NM.](4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg) + +``` + +sequenceDiagram + participant NM as NM + participant DM/EM as DM/EM + participant eNB as eNB + participant UE_AS as UE Access Stratum + participant UE_APP as UE Application Level + + NM->>DM/EM: activateAreaQMCJob + activate DM/EM + DM/EM->>eNB: activateAreaQMCJob + deactivate DM/EM + Note right of eNB: Start finding a UE that match the criteria. + eNB->>UE_AS: RRCConnectionReconfiguration + UE_AS->>UE_APP: +CAPPLEVMC + Note right of UE_APP: Application starts and QoE measurement collection is initiated + UE_APP->>UE_AS: MeasurementReport + UE_AS->>eNB: MeasurementReport + eNB->>DM/EM: Notification + eNB->>NM: Report + +``` + +Sequence diagram showing QMC activation and reporting in LTE. Lifelines: MCE, NM, DM/EM, eNB, UE (Access Stratum), UE (Application Level). The process involves activateAreaQMCJob from NM to DM/EM, then to eNB. eNB finds a matching UE and sends RRCConnectionReconfiguration to UE AS. UE AS sends +CAPPLEVMC to UE App Level. UE App Level starts measurement collection and sends MeasurementReport back to eNB. eNB sends Notification to DM/EM and Report to NM. + +Figure 4.2.1-1: QMC activation and reporting in LTE + +1. The NM sends `activateAreaQMCJob` to DM/EM that controls the impacted eNB(s), and includes the parameters: `serviceType`, `areaScope`, `qoECollectionEntityAddress`, `pLMNTarget`, `qoETarget`, `qoEReference` and QMC configuration file. +2. The DM/EM forwards `activateAreaQMCJob` to impacted eNB(s), and includes the parameters: `serviceType`, `areaScope`, `qoECollectionEntityAddress`, `pLMNTarget`, `qoETarget`, `qoEReference` and QMC configuration file. +3. The eNB checks for connections where the UE has the UE capability [9] that match the criteria for `serviceType` in the `activateAreaQMCJob`. +4. When a connection is found that has the wanted UE capability [9], the eNB starts a UE request session and stores the associated `QoECollectionEntityAddress`, sends the message `RRConnectionReconfiguration` to the UE, and includes the following: `serviceType`, `qoEReference` and QMC configuration file. +5. The access stratum in the UE sends the AT command `+CAPPLEVMC` to application level and includes the following: `serviceType`, `qoEReference` and QMC configuration file. +6. When the application in the `serviceType` starts, the QMC is initiated. +7. The application layer sends the AT command `+CAPPLEVMR` including a recording session indication that indicates that a session is started to the access stratum. +8. The UE sends the message `MeasReportAppLayer` including the recording session indication to the eNB. +9. The eNB sends a notification including the recording session indication to the NM. +10. When the QMC is completed, the recorded information is collected in a QMC report [6], [7], including `qoEReference` and `recordingSessionId`. The `qoEReference`, `Client Id` [6] and [7] in the reporting container (that represent the UE request session), and `recordingSessionId` are needed in the QMC collection entity for post processing purposes. +11. The application layer sends the AT command `+CAPPLEVMR` including `qoEReference` and the QMC report to the access stratum. +12. The UE sends the message `MeasReportAppLayer` including `qoEReference` and the QMC report to the eNB. +13. The eNB sends the QMC report to the MCE associated to the `qoEReference`. + +### 4.2.2 Handling of measurement collection at handover in LTE + +#### 4.2.2.1 Handover between cells within an eNB + +When handover is made and no `Recording session id` is provided, the measurement area is checked. + +- If the mobile is inside the measurement area after the handover, the eNB sends in an indication that the UE is inside the measurement area in the `RRConnectionReconfiguration` message [8] to the UE. The UE send the `+CAPPLEVMC` AT command [5] to the application to inform that recording shall start if the application becomes active (when the UE moves into the measurement area). +- If the mobile has moved outside the measurement area, there is no indication that the UE is inside the measurement area in the `RRConnectionReconfiguration` message [8] from the eNB to the UE. The UE sends the `+CAPPLEVMC` AT command [5] to the application to inform that recording shall not be started even if the application becomes active. + +#### 4.2.2.2 Handover between eNBs + +The figure 4.2.2.2-1 and the text below describes the handling at handover between eNBs. + +![Sequence diagram showing the handling of QMC activation in case of handover in LTE. The diagram involves MCE, NM, Source eNB, Target eNB, and UE (Access Stratum and Application Level).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant MCE + participant NM + participant Source eNB + participant Target eNB + participant UE as UE + Note right of UE: Access Stratum | Application Level + + Source eNB->>Target eNB: 1. Handover Request + Note right of Target eNB: 2. The target eNB checks if the target cell is inside the areaScope or not. + Target eNB-->>Source eNB: 3. Handover Request Acknowledge + Source eNB->>UE: 4. RRCConnectionReconfiguration + Note right of UE: 5. +CAPPLEVMR + UE-->>Target eNB: 6. RRCReconfigurationComplete + Note right of UE: 7. When the application becomes active, QMC is initiated if the UE is inside the areaScope + Note right of UE: 8. +CAPPLEVMR + Note right of UE: - Recording session Indication + Target eNB-->>NM: 9. MeasReportAppLayer + Note right of NM: - Recording session Indication + NM-->>MCE: 10. Notification + Note right of UE: 11. Measurement collection completed + Note right of UE: 12. +CAPPLEVMR + Note right of UE: - QoE reference + Note right of UE: - Report + Note right of UE: - QoE reference + Note right of UE: - Recording session ID + Target eNB-->>UE: 13. MeasReportAppLayer + Note right of UE: - QoE reference + Note right of UE: - Report + Note right of UE: - QoE reference + Note right of UE: - Recording session ID + Target eNB-->>MCE: 14. Report + Note right of NM: - QoE reference + Note right of NM: - Recording session ID + +``` + +Sequence diagram showing the handling of QMC activation in case of handover in LTE. The diagram involves MCE, NM, Source eNB, Target eNB, and UE (Access Stratum and Application Level). + +Figure 4.2.2.2-1: Handling of QMC activation in case of handover in LTE + +1. Source eNB sends the message `HandoverRequest` to Target eNB and includes `areaScope` and `qoECollectionEntityAddress`. +2. The target eNB checks if the target cell is inside the `areaScope` or not. +3. The target eNB sends the message `HandoverRequestAcknowledge` to the source eNB. +4. The source eNB sends the message `RRCConnectionReconfiguration` to the UE. +5. The access stratum in the UE sends the AT command `+CAPPLEVMC` to application level. +6. The UE sends the message `RRCConnectionReconfigurationComplete` to the eNB. +7. When the application becomes active, QMC is initiated if the UE is inside the `areaScope`. +8. The application layer sends the AT command `+CAPPLEVMR` including a recording session indication indicating that a session has started to the access stratum. +9. The UE sends the message `MeasReportAppLayer` including the recording session indication to the eNB. +10. The eNB sends a notification including the recording session indication to the NM. +11. When the QMC is completed, the recorded information is collected in a QMC report [6], [7], including `qoEReference` and `recordingSessionId`. The `qoEReference`, `Client Id` [6] and [7] in the reporting container (that represent the UE request session) and `recordingSessionId` are needed in the QoE collection entity for post processing purposes. +12. The application layer sends the AT command `+CAPPLEVMR` including `qoEReference` and the QMC report to the access stratum. +13. The UE sends the message `MeasReportAppLayer` including `qoEReference` and the QMC report to the eNB. +14. The eNB sends the QMC report to the MCE associated to the `qoEReference`. + +### 4.2.3 Deactivation of measurement collection job in LTE + +#### 4.2.3.1 Forced deactivation + +When the operator technician or the management application wants to deactivate a measurement collection job, the management system sends the `deactivateQMCJob` operation [3] to the eNB. The eNB sets the network request session to ended, but does not delete the `UE request session id` and the `Collection Entity Address` parameters [3], as the UE still may send reports which shall be sent to the collection centre. For UE request sessions which have reported that a recording session is started, the eNB sends the `RRCConnectionReconfiguration` message [8] to relevant UEs. The `RRCConnectionReconfiguration` message is including *measConfigAppLayer* set to discard application layer measurement report information in *otherConfig* [8]. The Access stratum sends `+CAPPLEVMC AT` command [5] to the application with the discard request. The application stops the recording session and stops recording of the requested information. The `UE request session id` and the `Collection Entity Address` parameters [3] in the eNB are deleted when the UE request session is ended. + +#### 4.2.3.2 Deactivation of recording session + +Regardless of whether the pre-set time has elapsed or not, the recording session continues to be active until the session for the application is ended. + +### 4.2.4 Void + +# --- 5 Quality of Experience (QoE) measurement management parameters + +## 5.1 QoE collection entity address (M) + +This is a parameter which defines the IP address to which the QMC records shall be transferred. Ipv4 or Ipv6 address(es) may be used. + +## 5.2 QoE reference (M) + +The QoE reference parameter specifies the network request session. The QoE reference shall be globally unique therefore it is composed as follows: + +MCC+MNC+QMC ID, where the MCC and MNC are coming with the QMC activation request from the management system to identify one PLMN containing the management system, and QMC ID is a 3 byte Octet String. + +The QMC ID is generated by the management system or the operator. + +It is used to identify the QoE measurement collection job in the traffic nodes and in the measurement collection centre. + +## 5.3 PLMN target (CM) + +This parameter defines the PLMN for which sessions shall be selected in the network request session in case of area based QMC when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Furthermore, several PLMNs can be used for not shared RAN cases as well as for shared RAN cases.). Only the sessions may be selected where the PLMN that the UE reports as selected PLMN is the same as the PLMN Target. + +Note that the PLMN Target might differ from the PLMN specified in the Network Request Session Id, as that specifies the PLMN that is containing the management system requesting the Network Request Session from the NE. + +The parameter is mandatory if network sharing is deployed. + +## 5.4 Area scope (CM) + +The area scope parameter defines the area in terms of cells or Tracking Area/Routing Area/Location Area where the QMC shall take place. If the parameter is not present the QMC shall be done throughout the PLMN specified in PLMN target. + +The area scope parameter in UMTS is either: + +- List of cells, identified by CGI. Maximum 32 CGI can be defined. +- List of Routing Area, identified by RAI. Maximum of 8 RAIs can be defined. +- List of Location Area, identified by LAI. Maximum of 8 LAIs can be defined. + +The area scope parameter in LTE is either: + +- list of cells, identified by E-UTRAN-CGI. Maximum 32 CGI can be defined. +- List of Tracking Area, identified by TAC. Maximum of 8 TAC can be defined. + +The parameter is mandatory if area based QMC is requested. + +## 5.5 QMC configuration file (container) (M) + +The QMC configuration file is a container that is specified in [6] or [7]. + +## 5.6 QMC target (M) + +The QMC target parameter specifies if the QMC is area based or individual UE based. + +- Area based QMC (0) + +NOTE: Individual UE based QMC is not supported in this release. + +## 5.7 Recording session id (M) + +This parameter shall be a 2 byte octet string. The recording session id shall be the same for the whole session in the application, while for each different session in the application the recording session id shall be changed. The recording session id is generated by the application in the UE. + +It is used in the measurement collection centre to identify which session within a UE has collected information in the application. + +## 5.8 Service type (M) + +Which kind of service that shall be recorded. + +- DASH (0) +- MTSI (1) + +DASH measurements are specified in [6]. MTSI measurements are specific in [7]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-07 | SA#88e | | | | | Upgrade to version under change control | 16.0.0 | +| 2021-09 | SA#93e | SP-210883 | 0001 | - | F | Aligning with RAN specifications 36.331 and 25.331 | 16.1.0 | +| 2021-12 | SA#94e | SP-211454 | 0004 | 1 | F | Correct the description of QoE reference and PLMN target | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28406/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/28_series/28406/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7da231c11e9363dfbec927a3f2ec0d3af46812c5 --- /dev/null +++ b/marked/Rel-16/28_series/28406/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d95c30c127bbc53b3010b2ab7f75a615ed936270e0a499bcf49d22c19160c89e +size 9744 diff --git a/marked/Rel-16/28_series/28406/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/28_series/28406/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9d8a0284c66772e0ddf9b7e74f73f3c991a98f7 --- /dev/null +++ b/marked/Rel-16/28_series/28406/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c966f857ba2381fb31dcd6458b261d0adc0a9022d7ea86ce4f6d94237914e707 +size 5804 diff --git a/marked/Rel-16/28_series/28406/raw.md b/marked/Rel-16/28_series/28406/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7de6039593899cffa4bfa2477c040edfffae1876 --- /dev/null +++ b/marked/Rel-16/28_series/28406/raw.md @@ -0,0 +1,394 @@ + + +# 3GPP TS 28.406 V16.0.0 (2020-07) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Services and System Aspects; +Telecommunication management; +Quality of Experience (QoE) measurement collection; +Information definition and transport +(Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text is a green graphic element consisting of three curved lines of increasing height, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected at the top by a single horizontal line. Below the "P" is a red graphic element consisting of three curved lines of increasing height, similar to the 5G logo. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 7 | +| 4 QoE record contents..... | 7 | +| 4.1 General ..... | 7 | +| 4.2 QoE metrics for 3GP-DASH..... | 7 | +| 4.2.1 QoE Metric Definitions ..... | 7 | +| 4.2.1.1 Introduction..... | 7 | +| 4.2.1.2 Representation Switch Events ..... | 7 | +| 4.2.1.3 Average Throughput..... | 7 | +| 4.2.1.4 Initial Playout Delay ..... | 7 | +| 4.2.1.5 Buffer Level ..... | 7 | +| 4.2.1.6 Play List ..... | 8 | +| 4.2.1.7 MPD Information..... | 8 | +| 4.2.1.8 Playout Delay for Media Start-up..... | 8 | +| 4.2.1.9 Device information ..... | 8 | +| 4.2.2 Quality Metrics for Progressive Download..... | 8 | +| 4.2.3 Quality Metrics for DASH ..... | 8 | +| 4.3 QoE metrics for MTSI..... | 10 | +| 4.3.1 Metrics Definition ..... | 10 | +| 4.3.1.1 Corruption duration metric ..... | 10 | +| 4.3.1.2 Successive loss of RTP packets..... | 10 | +| 4.3.1.3 Frame rate ..... | 10 | +| 4.3.1.4 Jitter duration..... | 10 | +| 4.3.1.5 Sync loss duration..... | 10 | +| 4.3.1.6 Round-trip time ..... | 10 | +| 4.3.1.7 Average codec bitrate..... | 10 | +| 4.3.1.8 Codec information ..... | 10 | +| <b>Annex A (informative): Change history.....</b> | <b>11</b> | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 28.404: "Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements"; + +TS 28.405: "Quality of Experience (QoE) measurement collection; Control and configuration"; + +**TS 28.406: "Quality of Experience (QoE) measurement collection; Information definition and transport".** + +One main motivation of the mobile network evolution is to improve the user experience, which is why the evaluation of the user experience? at the UE side is vital to network operators. This is especially true when the operators provide high bit rate real-time services like streaming services (typically video services), where even intermittent quality degradation is very annoying. Many of these streaming services are a significant part of the commercial traffic growth rate, therefore the focus is on the end users' experience. + +Quality of Experience (QoE) information collection provides detailed information at session level on a number of UEs. + +The capability to log information within a UE, and in particular the QoE of an end user service, initiated by an operator, provides the operator with QoE information. The collected information (specified in 3GPP TS 26.247 [7]) cannot be deduced from performance measurements in the mobile network. + +The QoE information is information collected by the end user application in the UE. + +The QoE information is collected by the management system for analysis and/or KPI calculations. + +# --- 1 Scope + +The present document describes Quality of Experience (QoE) measurement collection record content definition and management. It covers the Quality of Experience (QoE) measurement data content, their format and transfer across UMTS networks and LTE networks. The measurements that are collected are DASH [7] and MTSI [8] measurements. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.404: "Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements". +- [3] 3GPP TS 28.405: "Quality of Experience (QoE) measurement collection; Control and configuration". +- [4] 3GPP TS 28.307: " Telecommunication management; Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 28.308: "Management of Quality of Experience (QoE) measurement collection Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 25.331: "Radio Resource Control (RRC) protocol specification". +- [7] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [8] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|----------|-------------------------------------------| +| 3GP | 3GPP file format | +| 3GP-DASH | 3GPP Dynamic Adaptive Streaming over HTTP | +| MPD | Media Presentation Description | +| MTSI | Multimedia Telephony Service for IMS | +| QMC | QoE Measurement Collection | +| QoE | Quality of Experience | + +# --- 4 QoE record contents + +## 4.1 General + +The QoE record may contain QoE metrics for 3GP-DASH and MTSI. + +## 4.2 QoE metrics for 3GP-DASH + +### 4.2.1 QoE Metric Definitions + +#### 4.2.1.1 Introduction + +This clause provides the general QoE metric definitions and measurement framework. + +The semantics are defined using an abstract syntax. Items in this abstract syntax have one of the following primitive types (Integer, Real, Boolean, Enum, String) or one of the following compound types: + +- Objects: an unordered sequence of (key, value) pairs, where the key always has string type and is unique within the sequence. +- List: an ordered list of items. +- Set: an unordered set of items. + +Additionally, there are two kinds of timestamp defined, i.e. *real time* (wall-clock time) and *media time*. + +#### 4.2.1.2 Representation Switch Events + +Clause 10.2.3 in TS 26.247 [7] defines the metrics for representation switch events. + +#### 4.2.1.3 Average Throughput + +Clause 10.2.4 in TS 26.247 [7] defines the metric for average throughput. + +#### 4.2.1.4 Initial Playout Delay + +Clause 10.2.5 in TS 26.247 [7] defines the metric for initial playout delay. + +#### 4.2.1.5 Buffer Level + +Clause 10.2.6 in TS 26.247 [7] defines the metrics for buffer level status events. + +#### 4.2.1.6 Play List + +Clause 10.2.7 in TS 26.247 [7] defines the metric for play list. + +#### 4.2.1.7 MPD Information + +Clause 10.2.8 in TS 26.247 [7] defines the metric for MPD information. + +#### 4.2.1.8 Playout Delay for Media Start-up + +Clause 10.2.9 in TS 26.247 [7] defines the metric for playout delay for Media Start-up. + +#### 4.2.1.9 Device information + +Clause 10.2.10 in TS 26.247 [7] defines the metric for playout delay for device information. + +### 4.2.2 Quality Metrics for Progressive Download + +The following metrics shall be supported by progressive download clients supporting the QoE reporting feature: + +- Average Throughput (Clause 4.2.1.3), +- Initial Playout Delay (Clause 4.2.1.4), +- Buffer Level (Clause 4.2.1.5), +- Play List (Clause 4.2.1.6), and +- Device information (Clause 4.2.1.9). + +### 4.2.3 Quality Metrics for DASH + +The following metrics shall be supported by 3GP-DASH clients supporting the QoE reporting feature: + +- List of Representation Switch Events (Clause 4.2.1.2). +- Average Throughput (Clause 4.2.1.3). +- Initial Playout Delay (Clause 4.2.1.4). +- Buffer Level (Clause 4.2.1.5). +- Play List (Clause 4.2.1.6). +- MPD Information (Clause 4.2.1.7). +- Device information (Clause 4.2.1.9). + +The `@metrics` attribute contains a list of quality metric keys listing all metrics that the DASH shall collect and report. + +The semantics of the attributes within the **Metrics** element are provided in Table 1. The XML-syntax of a **Metrics** element is provided in Table 2. + +Table 1: Semantics of Metrics element + +| Element or Attribute Name | Use | Description | +|---------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>Metrics</b> | | DASH metric element | +| @metrics | M | This attribute lists all quality metrics (as a list of quality metric keys as defined in clause 4.2.1.1, separated by a whitespace) that the client shall report.<br>Certain keys allow specifying a measurement interval or period over which a single value of the metric is derived and potentially also other parameters controlling the collection of the metrics. The parameters, if any, are included in parenthesis after the key and their semantics are specified in clause 4.2.1.1 with the metric definition itself. | +| <b>Range</b> | 0..N | When specified, it indicates the time period during which quality metric collection is requested. When not present, quality metric collection is requested for the whole duration of the content. | +| @starttime | O | When specified, it indicates the start time of the quality metric collection operation. When not present, quality metric collection is requested from the beginning of content consumption. For services with <b>MPD@type</b> "Live", the start time of quality metric collection can be obtained in wallclock time by adding the value of this attribute indicated in media time to the value of the <b>MPD@availabilityStartTime</b> attribute. For services with <b>MPD@type</b> "OnDemand", the start time is indicated in media time and is relative to the <i>PeriodStart</i> time of the first period in this MPD. | +| @duration | O | When specified, it indicates the duration of the quality metric collection period. The value of this attribute is expressed in media time. | +| <b>Reporting</b> | 1..N | Descriptors that provide information about the requested Quality Reporting method and formats, and Auxiliary Reporting method and format. | + +**Legend:** +For attributes: M=Mandatory, O=Optional, OD=Optional with Default Value, CM=Conditionally Mandatory. +For elements: <minOccurs>...<maxOccurs> (N=unbounded) +Elements are **bold**; attributes are non-bold and preceded with an @. + +Table 2: XML-Syntax of Metrics element + +``` + +<!-- QoE Collection and Reporting --> +<xs:complexType name="MetricsType"> + <xs:sequence> + <xs:element name="Reporting" type="DescriptorType" maxOccurs="unbounded"/> + <xs:element name="Range" type="RangeType" minOccurs="0" maxOccurs="unbounded"/> + <xs:any namespace="##other" processContents="lax" minOccurs="0" +maxOccurs="unbounded"/> + </xs:sequence> + <xs:attribute name="metrics" type="xs:string" use="required"/> + <xs:anyAttribute namespace="##other" processContents="lax"/> +</xs:complexType> + +<xs:complexType name="RangeType"> + <xs:sequence> + <xs:any namespace="##other" processContents="lax" minOccurs="0" +maxOccurs="unbounded"/> + </xs:sequence> + <xs:attribute name="startTime" type="xs:duration" use="optional"/> + <xs:attribute name="duration" type="xs:duration" use="required"/> + <xs:anyAttribute namespace="##other" processContents="lax"/> +</xs:complexType> + +``` + +## 4.3 QoE metrics for MTSI + +### 4.3.1 Metrics Definition + +An MTSI client supporting the QoE metrics feature shall support the reporting of the metrics in this clause. The metrics are valid for speech, video and text media, and are calculated for each measurement resolution interval "Measure-Resolution". They are reported to the server according to the measurement reporting interval "Sending-Rate" and after the end of the session. + +#### 4.3.1.1 Corruption duration metric + +Clause 16.2.1 in TS 26.114 [8] defines the metric for corruption duration. + +#### 4.3.1.2 Successive loss of RTP packets + +Clause 16.2.2 in TS 26.114 [8] defines the metric for successive loss of RTP packets. + +#### 4.3.1.3 Frame rate + +Clause 16.2.3 in TS 26.114 [8] defines the metric for frame rate. + +#### 4.3.1.4 Jitter duration + +Clause 16.2.4 in TS 26.114 [8] defines the metric for jitter duration. + +#### 4.3.1.5 Sync loss duration + +Clause 16.2.5 in TS 26.114 [8] defines the metric for sync loss duration. + +#### 4.3.1.6 Round-trip time + +Clause 16.2.6 in TS 26.114 [8] defines the metric for round-trip time. + +#### 4.3.1.7 Average codec bitrate + +Clause 16.2.7 in TS 26.114 [8] defines the metric for average codec bitrate. + +#### 4.3.1.8 Codec information + +Clause 16.2.8 in TS 26.114 [8] defines the metric for codec information. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|------------------------|----|-----|-----|--------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2019-10 | SA5#127 | S5-196170<br>S5-196171 | | | | Add Introduction<br>Add scope and reference | | 0.1.0 | +| 2019-11 | SA5#127 | | | | | Used new TS template | | 0.1.1 | +| 2020-03 | SA5#129e | S5-201404 | | | | Remove SBA | | 0.2.0 | +| 2020-04 | SA5#130e | S5-202010 | | | | Add definitions of terms, symbols and abbreviations | | 0.3.0 | +| 2020-04 | SA5#130e | S5-202406 | | | | Add QoE record contents | | 0.3.0 | +| 2020-06 | | | | | | Corrections for editHelp (editorial and introduction of explanation of modal verbs). | | 0.3.1 | +| 2020-06 | SA#88-e | SP-200477 | | | | Presented for information and approval | | 1.0.0 | +| 2020-07 | SA#88e | | | | | Upgrade to change control version | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28500/367926125450c2bc3f4bdca9d59a62ba_img.jpg b/marked/Rel-16/28_series/28500/367926125450c2bc3f4bdca9d59a62ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2ed7e548c51e6bc6f3d6456556a4a2e6b972656 --- /dev/null +++ b/marked/Rel-16/28_series/28500/367926125450c2bc3f4bdca9d59a62ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:729e374bdc6e722c1db946f900825098ae0c9ab29ec476ac24fb590c7e55acd9 +size 34941 diff --git a/marked/Rel-16/28_series/28500/740442c999390734911677f01af0316d_img.jpg b/marked/Rel-16/28_series/28500/740442c999390734911677f01af0316d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94807e8dc5c3b53a799a7a29da2a962996627d68 --- /dev/null +++ b/marked/Rel-16/28_series/28500/740442c999390734911677f01af0316d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ae12a8f96ee470b7f5efa3731af41365f45ca84de96993d24fb02b413d5ef07 +size 8913 diff --git a/marked/Rel-16/28_series/28500/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg b/marked/Rel-16/28_series/28500/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..835ab4e00e8dff1cbb3b83c583c91ba81e380f17 --- /dev/null +++ b/marked/Rel-16/28_series/28500/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04ff57698d6597fff3746ddb6639d655545a6a9506602197843ac9a6672ef784 +size 10667 diff --git a/marked/Rel-16/28_series/28500/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg b/marked/Rel-16/28_series/28500/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f8118af923f05749243c4b743083d1dc6ddaad33 --- /dev/null +++ b/marked/Rel-16/28_series/28500/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98b68a8bc18cfa8e71ba984f751de1b5f1f5ade4966d72412f9596fb1143d406 +size 67655 diff --git a/marked/Rel-16/28_series/28500/raw.md b/marked/Rel-16/28_series/28500/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..edda9353cc3ada8b6fe8e46fb20a88878cbce482 --- /dev/null +++ b/marked/Rel-16/28_series/28500/raw.md @@ -0,0 +1,776 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Background and concepts ..... | 8 | +| 4.1 Background ..... | 8 | +| 4.2 Concepts..... | 8 | +| 4.2.1 NE and VNF ..... | 8 | +| 4.2.2 The relationship between NE and VNF..... | 9 | +| 5 Business level requirements..... | 9 | +| 5.1 Requirements..... | 9 | +| 5.1.1 General requirements..... | 9 | +| 5.1.2 FM requirements ..... | 10 | +| 5.1.3 CM requirements ..... | 10 | +| 5.1.4 PM requirements ..... | 10 | +| 5.1.5 LCM requirements..... | 11 | +| 5.2 Actor roles ..... | 12 | +| 5.3 Telecommunications resources ..... | 12 | +| 5.4 High-level use cases..... | 12 | +| 5.4.1 FM use cases..... | 12 | +| 5.4.1.1 Use case of VNF Healing triggered by 3GPP management system ..... | 12 | +| 5.4.1.2 Use case of virtualization-specific aspect failure detection and notification by NFV-MANO ..... | 13 | +| 5.4.1.3 Use case of alarms correlation by 3GPP management system ..... | 13 | +| 5.4.2 CM use cases ..... | 13 | +| 5.4.2.1 Use case of adding a MO related to a VNF ..... | 14 | +| 5.4.2.2 Use case of associating the MO with a certain VNF instance ..... | 14 | +| 5.4.2.3 Use case of configuring the VNF by 3GPP management system..... | 15 | +| 5.4.2.4 Use case of removing the MO of a VNF from managed nodes..... | 15 | +| 5.4.2.5 Modify non-application information and configuration of a VNF instance managed by NFV-MANO ..... | 16 | +| 5.4.2.6 Retrieve non-application information of a VNF instance managed by NFV-MANO..... | 16 | +| 5.4.3 PM use cases..... | 17 | +| 5.4.3.1 Use case of mitigating the VNF performance bottleneck..... | 17 | +| 5.4.3.2 Use case for collection of VNF PM data related to virtualized resource from NFV-MANO ..... | 17 | +| 5.4.4 LCM use cases..... | 18 | +| 5.4.4.1 Use case of NS instance Deployment..... | 18 | +| 5.4.4.2 Use case of updating an NS instance to a different NSD version..... | 19 | +| 5.4.4.3 Use cases of NE deployment in the context of NFV ..... | 20 | +| 5.4.4.3.1 Use case of NE deployment in the scenario of Managed Object(s) creation is after the VNF instantiation ..... | 20 | +| 5.4.4.4 Use case for notifications about VNF lifecycle changes ..... | 20 | +| 5.4.4.5 Use case of VNF instance scaling through operation request by 3GPP management system..... | 22 | +| 5.4.4.6 Use case of enabling/disabling the auto-scaling of the corresponding VNF instance(s)..... | 23 | +| 5.4.4.7 Determination on the termination of the corresponding VNF instance(s)..... | 23 | +| 6 Management architecture ..... | 24 | +| 6.1 Overview ..... | 24 | +| 6.1.1 Management architecture ..... | 24 | +| 6.1.2 Functional blocks in the management architecture ..... | 25 | +| 6.1.2.1 NM..... | 25 | +| 6.1.2.2 EM/DM..... | 25 | +| 6.1.2.3 NFV-MANO..... | 25 | + +6.1.2.4 NFVI ..... 25 +6.2 Management interfaces ..... 26 +6.2.1 Overview ..... 26 +6.2.2 Itf-N ..... 26 +6.2.3 Os-Ma-nfvo ..... 26 +6.2.4 Ve-Vnfm-em and Ve-Vnfm-vnf..... 26 +Annex A: Change history ..... 27 + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +Traditionally, telecommunication equipment is provided as equipment with integrated software and hardware. Virtualization technologies decouple the software and hardware, and the network function software can be executed on COTS hardware. + +The mobile network will be composed of virtualized network functions and non-virtualized network elements in the future. Virtualized network functions, like traditional non-virtualized network elements, need also to be managed. + +Due to the decoupling of network function software and hardware, ETSI ISG NFV introduces the NFV Management and Orchestration architecture, which interacts with 3GPP network management system, to realize the management of virtualized network functions lifecycle and resource allocation. 3GPP specifies the management solution of mobile networks that include virtualized network functions and clarifies the relationship between 3GPP management architecture and ETSI ISG NFV Management and Orchestration architecture. + +The present document specifies the management concept, requirements and architecture for mobile networks that include virtualized network functions. + +# --- 1 Scope + +The present document specifies the management concepts, the management requirements and use cases from operators' perspective for mobile networks that include virtualized network functions which can be part of EPC or IMS, and provides the management architecture for these mobile networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] ETSI GS NFV-IFA 010: "Network Functions Virtualisation (NFV); Management and Orchestration; Functional Requirements Specification". +- [3] ETSI GS NFV-MAN 001 V1.1.1: "Network Function Virtualisation (NFV); Management and Orchestration". +- [4] ETSI GS NFV 003 V1.2.1: "Network Functions Virtualisation (NFV); Terminology for Main Concepts in NFV". +- [5] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [6] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements". +- [7] 3GPP TS 32.111-1: "Telecommunication management; Fault Management; Part 1: 3G fault management requirements". +- [8] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [9] ETSI GS NFV-IFA 013 v2.1.1: "Network Function Virtualization (NFV); Management and Orchestration; Os-Ma-nfvo Reference Point - Interface and Information Model Specification". +- [10] ETSI GS NFV-IFA 008 v2.1.1: "Network Functions Virtualisation (NFV); Management and Orchestration; Ve-Vnfm Reference Point - Interface and Information Model Specification". +- [11] 3GPP TS 28.510: " Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements". +- [12] 3GPP TS 32.102: "Telecommuncations management; Architecture" + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.101 [5], TS 32.111-1 [7], TS 32.150 [8], TS 32.401 [6] 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]. + +**Consumer Role:** See service consumer in clause 5 of 3GPP TS 32.101 [5]. See consumer in ETSI GS NFV-MAN 001 [3]). + +**LifeCycle Management (LCM):** Defined in ETSI GS NFV 003 [4]. + +NOTE 1: How to define the lifecycle management of 3GPP network and entity is FFS. + +**Network Functions Virtualisation Infrastructure (NFVI):** Defined in ETSI GS NFV 003 [4]. + +**Network Functions Virtualisation Management and Orchestration (NFV-MANO):** Defined in ETSI GS NFV 003 [4]. + +**Network Functions Virtualisation Orchestrator (NFVO):** Defined in ETSI GS NFV 003 [4]. + +**NS:** Network Service defined in ETSI GS NFV 003 [4]. + +NOTE 2: The NS defined by ETSI NFV documents is not equivalent to 3GPP services. The latter requires the former for network orchestration in case the network includes virtualized network functions. + +**Physical Network Function (PNF):** Defined in ETSI GS NFV 003 [4]. + +NOTE 3: From 3GPP perspective, non-virtualized NE is a typical example of PNF. + +**Producer Role:** See service producer in clause 5 of 3GPP TS 32.101 [5]. See producer in ETSI GS NFV-MAN 001[3]). + +**Scaling:** Defined in ETSI GS NFV 003 [4]. + +**Virtual Machine (VM):** Defined in ETSI GS NFV 003 [4]. + +**Virtualised Infrastructure Manager (VIM):** Defined in ETSI GS NFV 003 [4]. + +**Virtualised Network Function (VNF):** Defined in ETSI GS NFV 003 [4]. + +NOTE 4: From 3GPP perspective, it corresponds to the application level function of NE, which is defined in 3GPP TS 32.101 [5]. + +**Virtualised Network Function Manager (VNFM):** Defined in ETSI GS NFV 003 [4]. + +**Virtualised Network Function Package (VNF Package):** Defined in ETSI GS NFV 003 [4]. + +**VNF Healing:** Defined in ETSI GS NFV-IFA010 [2]. + +## 3.2 Abbreviations + +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]. + +| | | +|-------|-----------------------------------------------| +| CAPEX | CAPital EXpenditure | +| COTS | Commercial Off-The-Shelf | +| LCM | LifeCycle Management | +| NFV | Network Functions Virtualization | +| NFVO | Network Functions Virtualization Orchestrator | +| NS | Network Service | +| NSD | NS Descriptor | +| OPEX | OPerating EXpense | +| OSS | Operations Support System | +| VIM | Virtualized Infrastructure Manager | +| VNF | Virtualized Network Function | +| VNFM | Virtualized Network Function Manager | + +# 4 Background and concepts + +## 4.1 Background + +It is expected that future implementation options for the entities of the 3GPP system include various technologies for virtualization. Network and service providers make use of different information in several different ways which also may vary from network to network and from time to time. Hence, entities of the 3GPP system that have been implemented with virtualization options should be managed in the same manner as entities implemented with non-virtualization options, to the extent possible. + +Virtualized 3GPP entities still require some underlying hardware resources. One of the NFV business objectives is that VNFs are procured independently from the underlying hardware resources. The underlying hardware resources are expected to be administered independently from the virtualized entities required for the 3GPP system. + +## 4.2 Concepts + +### 4.2.1 NE and VNF + +1. The components of NE can be shown as below (see Figure 4.2.1-1), where a Network Function (NF) is a processing function in a network which has defined functional behaviour and defined interfaces: + +![Diagram of NE components](7affafe7362a2d2d072e9d4bf515f0bb_img.jpg) + +A diagram showing the components of a Network Element (NE). It consists of a large outer rectangle labeled 'NE' at the top left. Inside this rectangle, there are two stacked boxes: the top box is labeled '3GPP NF(s)' and the bottom box is labeled 'Dedicated hardware'. + +Diagram of NE components + +**Figure 4.2.1-1: NE components** + +2. A VNF is NF(s) that runs on a NFV Infrastructure (NFVI) (see Figure 4.2.1-2): + +![Diagram of VNF running on NFVI](740442c999390734911677f01af0316d_img.jpg) + +A diagram showing a Virtual Network Function (VNF) running on NFV Infrastructure (NFVI). It consists of two main parts. The top part is a large rectangle labeled 'VNF' at the top left, which contains a smaller box labeled '3GPP NF(s)'. Below this 'VNF' rectangle is a separate, smaller rectangle labeled 'NFVI'. + +Diagram of VNF running on NFVI + +**Figure 4.2.1-2: VNF running on NFVI** + +**Note:** A VNF holds the following: a) functionality of the NF(s), b) elements for supporting the NF functionalities (the set a) and b) referred as application part of the VNF), and c) elements enabling VNF to run on NFVI (referred as virtualization-specific part of the VNF). Examples of elements for supporting the NF functionalities are library, database, protocol stacks. From this perspective, for the same type of NF, the function of a VNF is equivalent to the NF realized by an NE. The VNF set-a and set-b are managed by EM using the Type 1 interface (subclause 5.1.2.1 of [5]) in case the EM is not realized by the above mentioned VNF. In the case the EM and NF are realized within one VNF, the managing interface between EM and NF is not defined. The VNF set-c is managed by VNFM using the ETSI NFV defined Ve-Vnfm-vnf Reference Point (subclause 5.3 of [10]) between VNFM and VNF. + +3. Examples for the NE instance + +The same telecommunication function of an NE instance could be carried as illustrated in the following examples (see also Figure 4.2.1-3): + +EXAMPLE 1: One VNF instance composed of one or more VNFC instances running on NFVI. + +EXAMPLE 2: NF(s) running on dedicated hardware, where the the NF is 3GPP defined mobile network function (as described in Figure 7.3.3.1 in TS 32.102 [12]). + +![Figure 4.2.1-3: Examples of NE instances. a) virtualized NE instance (example 1): A dashed box labeled 'VNF Instance' contains three boxes: 'VNFC-a', '...', and 'VNFC-x'. Below this box is a solid box labeled 'NFVI'. b) NE instance (example 2): A solid box labeled 'NF(s)' is above a solid box labeled 'Dedicated hardware'.](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +a) virtualized NE instance (example 1) + +b) NE instance (example 2) + +Figure 4.2.1-3: Examples of NE instances. a) virtualized NE instance (example 1): A dashed box labeled 'VNF Instance' contains three boxes: 'VNFC-a', '...', and 'VNFC-x'. Below this box is a solid box labeled 'NFVI'. b) NE instance (example 2): A solid box labeled 'NF(s)' is above a solid box labeled 'Dedicated hardware'. + +**Figure 4.2.1-3 Examples of NE instances: a) virtualized and b) non-virtualized.** + +### 4.2.2 The relationship between NE and VNF + +From 3GPP perspective, VNF contains the NE's Network Function(s). The relation between NE instance and VNF instance depends on the relation between the NFs of NE and the functions contained within VNF. + +**Relation1:** The NE instance is 1:1 related to VNF instance if the VNF contains the whole Network Function(s) of the NE. + +# 5 Business level requirements + +## 5.1 Requirements + +### 5.1.1 General requirements + +**REQ-NFV-CON-1** Operator shall be able to manage mobile networks that include virtualized network functions and shall be able to identify whether the managed nodes are virtualized or not. + +**REQ-NFV-CON-2** The management of mobile networks that include virtualized network functions should reuse the 3GPP existing management solutions as much as possible. + +**REQ-NFV-CON-3** NM and EM in 3GPP management system managing the virtualized 3GPP entities shall be able to manage physical 3GPP entities also. + +**REQ-NFV-CON-4** 3GPP management system shall support a capability allowing operators to manage mobile networks that include virtualized network functions with the assistance from NFV-MANO. + +**REQ-NFV-CON-5** The reference points between 3GPP management system and NFV-MANO shall support a capability allowing 3GPP management system to request information required for management from NFV-MANO. + +**REQ-NFV-CON-6** The performance of the 3GPP management system should be adequate to achieve the objective of 3GPP service time to market. + +**REQ-NFV-CON-7** The virtualized resources from NFVI, on which the VNF relies, should be collaboratively managed by 3GPP management system and NFV-MANO. + +**NOTE:** Management of the virtualized resources from NFVI is NFV-MANO's responsibility, and "collaboratively managed" refers to the need for NFV-MANO to take into account the requirements from 3GPP management system about the VNF's virtualized resources during the VNF lifecycle management and deliver to 3GPP management system VNF performance data related to virtualized resources, VNF fault information related to virtualized resources and VNF instance information. + +### 5.1.2 FM requirements + +**REQ-NFV\_FM\_SYS-CON-1** The Operator shall be able to manage and deal with the virtualized network function alarms and NFVI alarms, which are not related to virtualized network function, through 3GPP management system and NFV-MANO respectively. + +**REQ-NFV\_FM\_SYS-CON-2** 3GPP management system shall be able to receive the virtualized network function alarm which includes the correlated virtualized resource fault information and process the alarm. + +**REQ-NFV\_FM\_SYS-CON-3** The virtualized network function alarm, which 3GPP management system acquired, shall include correct alarm type, alarm severity and possible cause information. + +**REQ-NFV\_FM\_SYS-CON-4** 3GPP management system shall be able to request NFV-MANO to recover the virtualized network function when VNF automatic recovery is not enabled in NFV-MANO. + +**REQ-NFV\_FM\_SYS-CON-5** 3GPP management system shall be able to receive the virtualized network function alarms when NFV-MANO performs VNF automatic recovery. + +**REQ-NFV\_FM\_SYS-CON-7** NFV-MANO shall support the subscription capability allowing 3GPP management system to subscribe to the VNF instance fault report related to virtualized resource(s) and virtualization-specific failures. + +### 5.1.3 CM requirements + +**REQ-NFV\_CM\_SYS-CON-1** 3GPP management system shall be able to manage both physical and virtualized 3GPP entities with corresponding managed objects and attributes. + +**REQ-NFV\_CM\_SYS-CON-2** 3GPP management system shall be able to perform necessary virtualized 3GPP entity configuration due to the VNF lifecycle management operation from NFV-MANO. + +**REQ-NFV\_CM\_SYS-CON-3** 3GPP management system shall be able to re-configure involved neighbour physical and virtualized 3GPP entities if needed due to one NS or VNF LCM operation. + +**REQ-NFV\_CM\_SYS-CON-4** In order to minimize 3GPP service disruption when a VNF instance is scaled, the scaling shall not modify the existing connections with other network entities. + +**REQ-NFV\_CM\_SYS-CON-5** 3GPP management system shall be able to request NFV-MANO to modify non-application information and configuration about a VNF instance managed by NFV-MANO (supported by requirements Os-Ma-nfvo.NsLcm.019 and Os-Ma-nfvo.NsLcm.020 in [9], and Ve-Vnfm-em.VnfLcm.008 and Ve-Vnfm-em.VnfCm.001 in [10]). + +**REQ-NFV\_CM\_SYS-CON-6** 3GPP management system shall be able to query NFV-MANO non-application information about a VNF instance managed by NFV-MANO (supported by requirement Os-Ma-nfvo.NsLcm.015 in [9] and Ve-Vnfm-em.VnfLcm.004 in [10]). + +### 5.1.4 PM requirements + +**REQ-NFV\_PM\_SYS-CON-1** The key performance indicators which are defined for physical entities shall be applicable to virtualized entities in 3GPP core network. + +**REQ-NFV\_PM\_SYS-CON-2** 3GPP management system shall support the performance measurements for virtualized 3GPP entity and 3GPP management system shall be informed of the performance measurement result of virtualized resources on which the virtualized 3GPP entity relies. + +**REQ-NFV\_PM\_SYS-CON-3** 3GPP management system shall be able to request the VNF LCM operation towards NFV-MANO to mitigate the VNF performance bottleneck according to the results of the VNF performance measurements. + +**REQ-NFV\_PM\_SYS-CON-4** NFV-MANO shall be able to provide VNF PM data related to virtualized resource to 3GPP management system. + +**REQ-NFV\_PM\_SYS-CON-5** NFV-MANO shall support the subscription capability allowing 3GPP management system to subscribe to the VNF performance measurement report related to virtualized resource. + +### 5.1.5 LCM requirements + +**REQ-NFV\_LCM\_SYS-CON-1** 3GPP management system shall be able to request NFV-MANO to perform NS LCM operations (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-2** 3GPP management system shall be able to request NFV-MANO to perform NSD management operations (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-3** 3GPP management system shall be able to request NFV-MANO to perform VNF package/software management operations (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-4** 3GPP management system shall be able to request NFV-MANO to perform VNF LCM operations (defined in ETSI GS NFV-IFA 008 [10]). + +**REQ-NFV\_LCM\_SYS-CON-5** 3GPP management system shall support the capability to receive NS lifecycle change notifications from NFV-MANO (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-6** 3GPP management system shall support the capability to receive the NSD management notifications from NFV-MANO (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-7** 3GPP management system shall be able to request updating the NS instance (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-8** 3GPP management system shall support the VNF package/software management notifications from NFV-MANO (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-9** 3GPP management system shall support the capability to receive the VNF LCM change notifications from NFV-MANO (defined in ETSI GS NFV-IFA 008 [10]). + +**REQ-NFV\_LCM\_SYS-CON-10** 3GPP management system shall be able to request scaling a virtualized network function to NFV-MANO (defined in ETSI GS NFV-IFA 008 [10]). + +**REQ-NFV\_LCM\_SYS-CON-11** 3GPP management system shall be able to request executing the VNF Healing of a virtualized network function to NFV-MANO. +**REQ-NFV\_LCM\_SYS-CON-12** 3GPP management system shall have the authority to determine the termination of a VNF instance(s). + +**REQ-NFV\_LCM\_SYS-CON-13** NFV-MANO shall have the capability allowing 3GPP management system to enable/disable the auto-scaling towards the corresponding VNF instance(s). + +**REQ-NFV\_LCM\_SYS-CON-14** NFV-MANO shall support the subscription capability allowing 3GPP management system to subscribe to the NS lifecycle change notifications (defined in ETSI GS NFV-IFA 013 [9]). + +**REQ-NFV\_LCM\_SYS-CON-15** NFV-MANO shall support the subscription capability allowing 3GPP management system to subscribe to the VNF lifecycle change notifications (defined in ETSI GS NFV-IFA 008 [10]). + +**REQ-NFV\_LCM\_SYS-CON-16** NFV-MANO shall have the capability allowing 3GPP management system to provide the affinity and anti-affinity information in the NSD. + +**REQ-NFV\_LCM\_SYS-CON-17** Operator shall be able to instantiate and manage multiple NS created using the same NSD but with specific parameterization (location, capacity, addresses). + +## 5.2 Actor roles + +See detailed actors and roles for each use case in clause 5.4. + +## 5.3 Telecommunications resources + +See detailed telecommunications resources for each use case in clause 5.4. + +## 5.4 High-level use cases + +### 5.4.1 FM use cases + +#### 5.4.1.1 Use case of VNF Healing triggered by 3GPP management system + +NOTE: In the context of this use case, VNF Healing [2] refers to corrective actions performed by the NFV-MANO to recover a VNF which fails to perform as expected, and it concerns the actions for which the NFV-MANO is responsible, e.g. corrective action(s) toward virtualised resources, instantiation of VNFC, configuration of VNF non-application specific parameters, etc. + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To execute VNF Healing for a virtualized network function. | | +| Actors and Roles | 3GPP management system requests to execute the VNF Healing. | | +| Telecom resources | 3GPP management system.<br>NFV-MANO.<br>VNF. | | +| Assumptions | 3GPP management system is subscribed to VNF lifecycle change notifications from the NFV-MANO. | | +| Pre-conditions | The subject VNF instance is not being healed at the moment. | | +| Begins when | A faulty virtualization-specific aspect of the VNF has been notified to 3GPP management system. | | +| Step 1 (M) | 3GPP management system determines that VNF Healing of the VNF is needed. | | +| Step 2 (M) | 3GPP management system requests the NFV-MANO to execute the VNF Healing based on the information in the request. | | +| Step 3 (M) | NFV-MANO notifies 3GPP management system about the end and the result of the VNF Healing execution. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | The VNF Healing procedure in step 2 fails. | | +| Post-conditions | The faulty virtualization-specific aspect of the VNF is recovered. | | +| Traceability | <b>REQ-NFV_LCM_SYS-CON-11</b> | | + +#### 5.4.1.2 Use case of virtualization-specific aspect failure detection and notification by NFV-MANO + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To notify the 3GPP management system of a virtualization-specific failure of a virtualized network functions. | | +| Actors and Roles | 3GPP management system receives the fault report.<br>NFV-MANO notifies about VNF-related virtualization faults. | | +| Telecom resources | 3GPP management system.<br>NFV-MANO.<br>VNF. | | +| Assumptions | 3GPP management system is subscribed to VNF-related virtualization-specific fault reports from the NFV-MANO. | | +| Pre-conditions | N/A | | +| Begins when | A virtualization-specific fault affecting the VNF is notified to NFV-MANO. | | +| Step 1 (M) | NFV-MANO creates VNF-related virtualization fault report about the faulty virtualization-specific aspect. | | +| Step 2 (M) | NFV-MANO sends the VNF-related virtualization fault report to the 3GPP management system. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The 3GPP management system is notified about the virtualization-specific failure of the subject VNF. | | +| Traceability | <b>REQ-NFV_FM_SYS-CON-7</b> | | + +#### 5.4.1.3 Use case of alarms correlation by 3GPP management system + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To correlate VNF alarms in a mobile network that includes virtualized network functions. | | +| Actors and Roles | 3GPP management system correlates VNF alarms. | | +| Telecom resources | NFV-MANO<br>VNF<br>NFVI | | +| Assumptions | 3GPP management system has the alarm correlation function.<br>3GPP management system is subscribed to VNF-related virtualized resource fault reports from the NFV-MANO.<br>The virtualized resource failure affects the corresponding VNF. | | +| Pre-conditions | | | +| Begins when | NFV-MANO detects the virtualized resource fault affecting the VNF. | | +| Step 1 (M) | NFV-MANO creates VNF fault report related to virtualized resource and sends it to the 3GPP management system. | | +| Step 2 (M) | 3GPP management system receives the VNF fault report related to virtualized resource. 3GPP management system also receives VNF application alarm(s) of a faulty NE. | | +| Step 3 (M) | 3GPP management system implements alarm correlation based on the virtualized resource alarm(s) from NFV-MANO and VNF application alarm(s) from NE. | | +| Step 4 (M) | 3GPP management system generates the final VNF application fault report including the above correlated alarm(s). | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | 3GPP management system will process the alarm(s) based on the final fault report. | | +| Traceability | <b>REQ-NFV_FM_SYS-CON-2, REQ-NFV_FM_SYS-CON-7</b> | | + +### 5.4.2 CM use cases + +Editor's note: The following UCs (i.e. 5.4.2.1, 5.4.2.2, 5.4.2.3, 5.4.2.4) will be revisited when the relationship between MO and VNF instance is clear. + +#### 5.4.2.1 Use case of adding a MO related to a VNF + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To add a MO related to a VNF. | | +| Actors and Roles | 3GPP management system. | | +| Telecom resources | 3GPP management system.<br>VNF. | | +| Assumptions | | | +| Pre conditions | N/A | | +| Begins when | Operator has decided to add a MO related to the VNF. | | +| Step 1 (M) | 3GPP management system creates the MO related to the VNF.<br>Note: the MO creation operation here means Basic CM IRP. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The MO is available for 3GPP management system. | | +| Traceability | <b>REQ-NFV_CM_SYS-CON-2</b> | | + +#### 5.4.2.2 Use case of associating the MO with a certain VNF instance + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To associate the MO with a certain VNF instance. | | +| Actors and Roles | 3GPP management system. | | +| Telecom resources | 3GPP management system.<br>VNF. | | +| Assumptions | | | +| Pre conditions | 3GPP management system has known the VNF instance identifier. | | +| Begins when | Operator has decided to associate the MO with a certain VNF instance. | | +| Step 1 (M) | 3GPP management system associates the MO with a certain VNF instance.<br>NOTE: The associating operation may happen during the process of creation of MO or after it. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The MO is associated with The VNF instance. And the MO can be managed by 3GPP management system. | | +| Traceability | <b>REQ-NFV_CM_SYS-CON-2</b> | | + +#### 5.4.2.3 Use case of configuring the VNF by 3GPP management system + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To configure the VNF with MO attributes. | | +| Actors and Roles | 3GPP management system. | | +| Telecom resources | 3GPP management system.<br><br>VNF. | | +| Assumptions | | | +| Pre conditions | 3GPP management system has added a MO related to the VNF. | | +| Begins when | Operator has decided to configure the VNF. | | +| Step 1 (M) | 3GPP management system configures the VNF with MO attributes. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The VNF has been configured by 3GPP management system. | | +| Traceability | <b>REQ-NFV_CM_SYS-CON-2</b> | | + +#### 5.4.2.4 Use case of removing the MO of a VNF from managed nodes + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To remove the MO of a VNF from managed nodes. | | +| Actors and Roles | 3GPP management system. | | +| Telecom resources | 3GPP management system.<br>VNF. | | +| Assumptions | | | +| Pre conditions | 3GPP services provided by the VNF instance have been released.<br>NFV-MANO has already terminated the VNF instance. | | +| Begins when | Operator has decided to remove the MO of the VNF instance from managed nodes. | | +| Step 1 (M) | 3GPP management system removes the MO of the VNF instance. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The MO of the VNF instance has been removed from managed nodes. | | +| Traceability | <b>REQ-NFV_CM_SYS-CON-2</b> | | + +#### 5.4.2.5 Modify non-application information and configuration of a VNF instance managed by NFV-MANO + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To modify by 3GPP management system non-application information and configuration of a subject VNF instance. Such an information and configuration is managed by NFV-MANO (see clause 9.4.2 in ETSI GS NFV-IFA 008 [10]); for instance, VNF instance name and meta data. | | +| <b>Actors and Roles</b> | 3GPP management system requests the modification of VNF instance information and/or configuration. | | +| <b>Telecom resources</b> | 3GPP management system.<br>NFV-MANO | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | N/A | | +| <b>Begins when</b> | 3GPP management system determines to modify certain non-application information and/or configuration held by NFV-MANO of a subject VNF instance. | | +| <b>Step 1 (M)</b> | 3GPP management system sends a request to NFV-MANO to modify the non-application information and/or configuration about the subject VNF instance (see related interface requirements in clause 5.2.1.1 in ETSI GS NFV-IFA 008 [10] and in clause 5.3.2 in ETSI GS NFV-IFA 013 [9]). | | +| <b>Step 2 (M)</b> | NFV-MANO modifies the requested information and/or configuration about the subject VNF instance. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The non-application information and/or configuration of the subject VNF instance managed by NFV-MANO instance has been modified. | | +| <b>Traceability</b> | <b>REQ-NFV_CM_SYS-CON-5</b> | | + +#### 5.4.2.6 Retrieve non-application information of a VNF instance managed by NFV-MANO + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To retrieve by 3GPP management system from NFV-MANO non-application information of a subject VNF instance. Such information about a subject VNF instance is information managed by NFV-MANO (see clause 9.4.2 in ETSI GS NFV-IFA 008 [10]). | | +| Actors and Roles | 3GPP management system queries the VNF instance information. | | +| Telecom resources | 3GPP management system.<br>NFV-MANO | | +| Assumptions | N/A | | +| Pre-conditions | N/A | | +| Begins when | 3GPP management system determines to retrieve certain information about a subject VNF instance that is managed by NFV-MANO. | | +| Step 1 (M) | 3GPP management system sends a request to NFV-MANO querying the needed non-application information about the subject VNF instance (see related interface requirements in clause 5.2.1.1 in ETSI GS NFV-IFA 008 [10] and in clause 5.3.2 in ETSI GS NFV-IFA 013 [9]). | | +| Step 2 (M) | NFV-MANO returns to 3GPP management system the information requested about the subject VNF instance. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | 3GPP management system has the non-application information about the subject VNF instance managed by NFV-MANO. | | +| Traceability | REQ-NFV_CM_SYS-CON-6 | | + +### 5.4.3 PM use cases + +#### 5.4.3.1 Use case of mitigating the VNF performance bottleneck + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To mitigate the VNF performance bottleneck. | | +| Actors and Roles | 3GPP management system. | | +| Telecom resources | NFV-MANO<br>VNF | | +| Assumptions | 3GPP management system is set up to collect VNF performance measurements and NFV-MANO is set up to collect VNF performance measurements related to virtualized resource. | | +| Pre-conditions | VNF application threshold crossing trigger and VNF-related virtualized resource threshold crossing trigger have been set up by corresponding system(s) (i.e. 3GPP management system or NFV-MANO system). | | +| Begins when | The VNF performance measurement report(s), VNF performance measurement report(s) related to virtualized resource or the thresholds crossing alarm(s) are generated. | | +| Step 1 (M) | 3GPP management system receives the VNF performance measurement report(s), VNF performance measurement report(s) related to virtualized resource or the thresholds crossing alarm(s). | | +| Step 2 (M) | 3GPP management system decides to optimize the VNF performance and mitigate the VNF performance bottleneck. | | +| Step 3 (M) | 3GPP management system requests VNF LCM operation (e.g. expansion) towards NFV-MANO. | | +| Ends when | NFV-MANO executes the VNF LCM operation. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The VNF performance bottleneck has been mitigated after the VNF LCM operation. | | +| Traceability | REQ-NFV_PM_SYS-CON-3 | | + +#### 5.4.3.2 Use case for collection of VNF PM data related to virtualized resource from NFV-MANO + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | 3GPP management system gets the VNF PM data related to virtualized resource. | | +| Actors and Roles | 3GPP management system | | +| Telecom resources | 3GPP management system<br>NFV-MANO | | +| Assumptions | NFV-MANO is set up to collect VNF-related virtualized resource performance measurements and generates the report of VNF PM data related to virtualized resource. | | +| Pre-conditions | The collection mechanism for VNF PM data related to virtualized resource has been established both at 3GPP management system and NFV-MANO. | | +| Begins when | 3GPP management system needs the VNF PM data which are related to virtualized resource and sets the PM job for them. And VNF PM data related to virtualized resource is generated by NFV-MANO. | | +| Step 1 (M) | NFV-MANO provides the VNF PM data related to virtualized resource to 3GPP management system. | | +| Step 2 (M) | 3GPP management system receives the VNF PM data related to virtualized resource. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed. | | +| Exceptions | None. | | +| Post-conditions | 3GPP management system has the performance data desired. | | +| Traceability | <b>REQ-NFV_PM_SYS-CON-2, REQ-NFV_PM_SYS-CON-4</b> | | + +### 5.4.4 LCM use cases + +#### 5.4.4.1 Use case of NS instance Deployment + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To deploy a NS instance in a mobile network that includes virtualized network functions | | +| Actors and Roles | 3GPP management system (NM part). | | +| Telecom resources | NFV-MANO. | | +| Assumptions | Existing VNF instance(s) could be used by the new NS instance.<br>Any NSD may be reused for instantiating multiple NS instances.<br>3GPP management system is subscribed to receive NS lifecycle change notifications. | | +| Pre-conditions | The NSD to be used for the NS instantiation has been on-boarded on NFV-MANO. | | +| Begins when | 3GPP management system determines that a new NS instance is to be instantiated. | | +| Step 1 (M) | 3GPP management system determines the type and capacity of a NS instance, and sets NS instantiation request with proper parameters. | | +| Step 2 (M) | 3GPP management system sends NS instantiation request to NFV-MANO. | | +| Step 3 (M) | NFV-MANO instantiates the NS instance based on request from 3GPP management system. | | +| Ends when | 3GPP management system receives notification from NFV-MANO that a new NS instance is instantiated. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | A new NS instance is ready for service. | | +| Traceability | <b>REQ-NFV_LCM_SYS-CON-1, REQ-NFV_LCM_SYS-CON-5, REQ-NFV_LCM_SYS-CON-17</b> | | + +#### 5.4.4.2 Use case of updating an NS instance to a different NSD version + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | The network operator through 3GPP management system can decide when and has the capacity to update the NS instance (created based on an NSD of certain version) to correspond to a different NSD version. | | +| <b>Actors and Roles</b> | 3GPP management system. | | +| <b>Telecom resources</b> | NFV-MANO | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The information, to update an existing NS instance, to correspond to a different NSD version exists.<br>The different NSD version has been on-boarded on NFV-MANO. | | +| <b>Begins when</b> | 3GPP management system needs to update an existing NS instance (created based on an NSD of certain version) to correspond to the different NSD version. | | +| <b>Step 1 (M)</b> | 3GPP management system requests to NFV-MANO to update the NS instance to correspond to the different NSD version, instructing NFV-MANO not to synchronize automatically the NS instance to the different NSD version. | | +| <b>Step 2 (M)</b> | NFV-MANO executes the NS update operation and acknowledges to 3GPP management system the successful update of the NS instance to correspond to the different NSD version. | | +| <b>Step 3 (M)</b> | 3GPP management system requests to NFV-MANO to update the NS instance based on the different NSD version. | | +| <b>Step 4 (M)</b> | NFV-MANO executes the NS update operation and acknowledges to 3GPP management system the successful NS instance update. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NS instance has been updated to correspond to the different NSD version. | | +| <b>Traceability</b> | REQ-NFV_LCM_SYS-CON-1, REQ-NFV_LCM_SYS-CON-7 | | + +#### 5.4.4.3 Use cases of NE deployment in the context of NFV + +##### 5.4.4.3.1 Use case of NE deployment in the scenario of Managed Object(s) creation is after the VNF instantiation + +| Use Case Stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To deploy a NE in a mobile network that includes virtualized network functions | | +| Actors and Roles | 3GPP management system (NM, EM) creates and configures Managed Object(s) for the corresponding VNF instance.<br>NFV-MANO system instantiates VNF instance according to the request from 3GPP management system. | | +| Telecom resources | 3GPP management system<br>NFV-MANO system | | +| Assumptions | 3GPP management system and NFV-MANO system are in operational status. | | +| Pre-conditions | Operator has decided the type and capacity of the NE to be deployed. | | +| Begins when | Operator decides to deploy a new NE. | | +| Step 1 (M) | 3GPP management system sends the VNF instantiation request to NFV-MANO system. | | +| Step 2 (M) | NFV-MANO system instantiates the VNF instance. | | +| Step 3 (M) | 3GPP management system receives the result of VNF instantiation from NFV-MANO system. | | +| Step 4 (M) | 3GPP management system creates Managed Object(s) for the instantiated VNF instance when needed. | | +| Step 5 (M) | 3GPP management system configures the VNF instance with Managed Object attributes when needed. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The new NE is deployed and ready for providing service. | | +| Traceability | TBD | | + +#### 5.4.4.4 Use case for notifications about VNF lifecycle changes + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To monitor by 3GPP management system of lifecycle changes on VNF instances. | | +| Actors and Roles | 3GPP management system subscribes to and receives VNF lifecycle change notifications. | | +| Telecom resources | 3GPP management system.<br>NFV-MANO system.<br>VNF. | | +| Assumptions | | | +| Pre-conditions | NFV-MANO system is running. | | +| Begins when | 3GPP management system determines to monitor VNF lifecycle changes on a managed VNF instance. | | +| Step 1 (M) | 3GPP management system requests a subscription to NFV-MANO system to receive VNF lifecycle change notifications regarding a managed VNF instance. | | +| Step 2 (M) | NFV-MANO system creates a subscription and acknowledges the subscription to 3GPP management system. | | +| Step 3 (M) | When managed VNF instance has a lifecycle change, NFV-MANO system creates and sends VNF lifecycle change notification including information to identify the VNF instance subject to lifecycle change, the type of procedure, and whether it is the start or end of the procedure. | | +| Ends when | 3GPP management system unsubscribes to VNF lifecycle change notifications regarding the managed VNF instance. | | +| Exceptions | | | +| Post-conditions | The 3GPP management system has information about VNF lifecycle changes of the managed VNF instance. | | +| Traceability | <b>REQ-NFV_LCM_SYS-CON-9, REQ-NFV_LCM_SYS-CON-15</b> | | + +NOTE: VNF lifecycle change notifications are supported by NFV-MANO system [2]. + +#### 5.4.4.5 Use case of VNF instance scaling through operation request by 3GPP management system + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Goal | To expand/contract a VNF instance by scaling the VNF instance. | | +| Actors and Roles | 3GPP management system detects the need for scaling and sends the VNF scaling request. | | +| Telecom resources | 3GPP management system.<br>NFV-MANO system.<br>VNF.<br>NFVI. | | +| Assumptions | 3GPP management system is subscribed to VNF lifecycle change notifications from the NFV-MANO system. | | +| Pre-conditions | The subject VNF instance is not being scaled at the moment. VNFM (part of NFV-MANO system) does not have any auto-scaling scripts or the policy for auto-scaling is not in use or active.<br>Note: Determining whether "the subject VNF instance is not being scaled" can be done through the lifecycle change notification as described in clause 5.4.4.4 of TS 28.500. Determining whether "there is no auto-scaling scripts or policy for auto-scaling is not used or active" can be done by sending a query request for the subject VNF instance from the 3GPP management system to the NFV-MANO system as described in clause 6.4.7 of TS 28.510 [11]. | "Use case for notifications about VNF lifecycle changes" (see clause 5.4.4.4 of TS 28.500)<br><br>"Retrieve VNF instance information from VNFM by EM" (see clause 6.4.7 in TS 28.510 [11]) | +| Begins when | 3GPP management system detected the need to scale and have determined the scaling action (expand/contract). | | +| Step 1 (M) | 3GPP management system sends to NFV-MANO system a request to expand/contract the managed VNF instance. | | +| Step 2 (M) | NFV-MANO system executes the scaling of the VNF instance. | | +| Step 3 (M) | NFV-MANO system notifies 3GPP management system about the end of the VNF scaling execution. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The VNF instance has been scaled (expansion/contraction). | | +| Traceability | <b>REQ-NFV_LCM_SYS-CON-4, REQ-NFV_LCM_SYS-CON-9, REQ-NFV_LCM_SYS-CON-10</b> | | + +#### 5.4.4.6 Use case of enabling/disabling the auto-scaling of the corresponding VNF instance(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | According to the management requirement, operators need to enable/disable the auto-scaling of a VNF instance(s). | | +| Actors and Roles | 3GPP management system requests the enabling/disabling the auto-scaling of the corresponding VNF instance(s) for an NE. | | +| Telecom resources | NFV-MANO, VNF | | +| Assumptions | The auto-scaling, which means automatic procedure controlled and executed by NFV-MANO to scale the capacity of a VNF instance. | | +| Pre-conditions | | | +| Begins when | The operator decides to enable/disable the auto-scaling of the corresponding VNF instance(s) for an NE. | | +| Step 1 (M) | 3GPP management system requests NFV-MANO to enable/disable the auto-scaling of the corresponding VNF instance(s) for the subject NE. | | +| Step 2 (M) | NFV-MANO enables/disables the auto-scaling function towards the specific VNF instance(s). | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The auto-scaling of the corresponding VNF instance(s) for an NE is enabled/disabled. | | +| Traceability | <b>REQ-NFV_LCM_SYS-CON-13</b> | | + +#### 5.4.4.7 Determination on the termination of the corresponding VNF instance(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | The operator determines to terminate a VNF instance(s) based on the operator's needs or the pre-configuration policy. | | +| Actors and Roles | 3GPP management system requests the termination of the corresponding VNF instance(s) for an NE. | | +| Telecom resources | NFV-MANO, VNF | | +| Assumptions | The operator makes the decision to terminate the corresponding VNF instance(s) for an NE. | | +| Pre-conditions | | | +| Begins when | 3GPP management system completes the preparation for the VNF termination. | | +| Step 1 (M) | 3GPP management system requests NFV-MANO to terminate the corresponding VNF instance(s). | | +| Step 2 (M) | NFV-MANO completes the termination operation towards the specific VNF instance(s). | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | | | +| Traceability | <b>REQ-NFV_LCM_SYS-CON-12</b> | | + +# 6 Management architecture + +## 6.1 Overview + +The following clauses elaborate the management architecture of mobile networks which include virtualized network functions and clarify the relationship between 3GPP management architecture and NFV-MANO framework (ETSI GS NFV-MAN 001 [3]). + +The following clauses focus on the aspects of the NFV introduction in mobile network and the impacts to the existing 3GPP management system, which is composed of NM and DM/EM (as shown in figure 6.1.1-1). Hence, they mainly address the functionalities to 3GPP management system and the requirements on the NFV-MANO through related reference points (i.e. Os-Ma-nfvo, Ve-Vnfm-em, Ve-Vnfm-vnf). They do not address any of the definitions of the NFV-MANO framework and interfaces. The detailed descriptions for those are in-scope of ETSI NFV documents, which are referred to below. + +### 6.1.1 Management architecture + +Figure 6.1.1-1 illustrates the management architecture of mobile networks that include virtualized network functions. + +![Figure 6.1.1-1: The mobile network management architecture mapping relationship between 3GPP and NFV-MANO architectural framework. The diagram shows the interaction between the 3GPP management system (NM, DM/EM) and the NFV-MANO framework (NFVO, VNFM, VIM) for managing network elements (NE (PNF), VNF) on the NFVI. Key interfaces and reference points shown include Itf-N, Os-Ma-nfvo, Ve-Vnfm-em, Ve-Vnfm-vnf, Or-Vi, Vi-Vnfm, Vn-Nf, and Nf-Vi.](ab846b81e78dbc8da2a6f9511e2f248a_img.jpg) + +The diagram illustrates the management architecture mapping between the 3GPP management system and the NFV-MANO framework. On the left, the 3GPP management system includes the Network Management (NM) block, which is part of the OSS/BSS. Below NM are the Domain Management (DM) and Element Management (EM) blocks. These manage Network Elements (NE (PNF)) and Virtual Network Functions (VNF). The VNFs run on the NFVI (NFVI). On the right, the NFV-MANO framework includes the NFV Orchestrator (NFVO), VNF Manager (VNFM), and Virtualised Infrastructure Manager (VIM). The NM block connects to the NFVO via the Os-Ma-nfvo reference point. The EM block connects to the VNFM via the Ve-Vnfm-em reference point. The VNF block connects to the VNFM via the Ve-Vnfm-vnf reference point. The NFVI block connects to the VIM via the Nf-Vi reference point. The NFVO connects to the VNFM via the Or-Vi reference point. The VNFM connects to the VIM via the Vi-Vnfm reference point. The NM block also connects to the DM/EM block via the Itf-N interface. The DM/EM block connects to the NE (PNF) and VNF blocks via the Itf-N interface. The VNF block connects to the NFVI via the Vn-Nf interface. + +Figure 6.1.1-1: The mobile network management architecture mapping relationship between 3GPP and NFV-MANO architectural framework. The diagram shows the interaction between the 3GPP management system (NM, DM/EM) and the NFV-MANO framework (NFVO, VNFM, VIM) for managing network elements (NE (PNF), VNF) on the NFVI. Key interfaces and reference points shown include Itf-N, Os-Ma-nfvo, Ve-Vnfm-em, Ve-Vnfm-vnf, Or-Vi, Vi-Vnfm, Vn-Nf, and Nf-Vi. + +**Figure 6.1.1-1: The mobile network management architecture mapping relationship between 3GPP and NFV-MANO architectural framework** + +Physical mobile network management mainly relies on the interface Itf-N. With the introduction of NFV, mobile network management needs to also specify the virtualized network functions management. It involves not only one interface Itf-N, but also the interaction with NFV-MANO through defined reference points. + +The management architecture in present document aligns with the NFV-MANO framework (ETSI NFV-MAN 001 [3]) with emphasis on the following aspects: + +- 1) Mobile network is composed of physical and virtualized network elements. Application-specific aspects of both VNFs and PNFs, corresponding to physical NEs, shall be managed by 3GPP management system. +- 2) The architecture identifies the following entities which are defined in TS 32.101 [5], both of them are needed to extend the management functionalities for virtualized network and VNF: + - NM, which plays one of the roles of OSS/BSS and is the consumer of reference point Os-Ma-nfvo. + - DM/EM, if the EM includes the extended functionality, it can manage both PNF(s) and VNF(s). +- 3) The architecture identifies the following entities that share interfaces with NM, DM/EM and VNF: + - NFV Orchestrator (NFVO) + - VNF Manager (VNFM) +- 4) The architecture identifies the following main interfaces/reference points: + - Itf-N, the interface between NM and DM/EM + - Os-Ma-nfvo, the reference point between OSS/BSS and NFVO. + +NOTE: In 3GPP specification, NM plays one of the roles of OSS/BSS. + +- Ve-Vnfm-em, the reference point between EM and VNFM. +- Ve-Vnfm-vnf, the reference point between VNF and VNFM. + +### 6.1.2 Functional blocks in the management architecture + +#### 6.1.2.1 NM + +NM plays one of the roles of OSS/BSS. It provides the functions for the management of mobile network which includes virtualized network functions. The NM supports FCAPS management functions of the mobile network (e.g. IMS, EPC) and 3GPP service (e.g. data service, voice service) and supports the management of mobile network lifecycle. NM initiates the lifecycle management of ETSI-defined NS and VNF, which are related to mobile network, through interaction with NFV-MANO. + +#### 6.1.2.2 EM/DM + +EM/DM is responsible for FCAPS management functionality for a VNF on an application level and physical NE on a domain and element level. This mainly includes: + +- Fault management for VNF and physical NE. +- Configuration management for VNF and physical NE. +- Accounting management for VNF and physical NE. +- Performance measurement and collection for VNF and physical NE. +- Security management for VNF and physical NE. + +EM/DM participates in lifecycle management functionality for a VNF. This includes: + +- Request the lifecycle management operation for a VNF to VNFM. +- Exchange of information regarding the VNF and Virtualized Resources associated with the VNF. + +#### 6.1.2.3 NFV-MANO + +NFV-MANO is composed of NFV Orchestrator (NFVO), VNF Manager (VNFM) and VIM. The main functionalities of those are defined in ETSI GS NFV-MAN 001 [3]. + +#### 6.1.2.4 NFVI + +NFVI is composed of the hardware and software components that together provide the infrastructure resources where VNFs are deployed. The infrastructure resources contain the hardware resources, virtualization layer software and the virtualized resources which the VNF relies on. The main functionalities are defined in ETSI GS NFV-MAN 001 [3]. + +## 6.2 Management interfaces + +### 6.2.1 Overview + +The following clauses describe the high level functionalities of the Itf-N interface, the Os-Ma-nfvo, Ve-Vnfm-em and Ve-Vnfm-vnf reference points from 3GPP perspective. + +### 6.2.2 Itf-N + +The interface is used for FCAPS exchanges between NM and EM/DM, which includes both VNF and physical NE FCAPS management functions. + +### 6.2.3 Os-Ma-nfvo + +This reference point is used for NS lifecycle management, NS performance management, NS fault management, NSD management and VNF Package management produced by NFVO as defined by ETSI GS NFV-IFA 013 [9]. + +### 6.2.4 Ve-Vnfm-em and Ve-Vnfm-vnf + +These reference points are mainly used for VNF lifecycle management, the information delivery of VNF and VR failure or performance measurement information and virtualization configuration, etc. + +# --- Annex A: Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-01 | SA#74 | | | | | Version under change control | 14.0.0 | +| 2017-03 | SA#75 | SP-170143 | 0001 | 1 | F | Clarify interface/reference point related to VNF capabilities | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28510/raw.md b/marked/Rel-16/28_series/28510/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..15bdaeab06cfcd0623d264fe8a3b3f8849c022f1 --- /dev/null +++ b/marked/Rel-16/28_series/28510/raw.md @@ -0,0 +1,541 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Background and concepts ..... | 6 | +| 4.1 Configuration management in the context of NFV ..... | 6 | +| 5 Business level requirements..... | 6 | +| 5.1 Requirements..... | 6 | +| 5.2 Actor roles ..... | 7 | +| 5.3 Telecommunications resources ..... | 7 | +| 5.4 High-level use cases..... | 7 | +| 5.4.1 Create Managed Object for Network Element in the context of NFV ..... | 7 | +| 5.4.2 Delete MOI(s) for Network Element in the context of NFV..... | 8 | +| 5.4.3 Update the configuration parameters corresponding to the subject VNF instance (application part) after a VNF instance is scaled ..... | 8 | +| 5.4.4 Retrieve virtualized NE information by NM..... | 9 | +| 6 Specification level requirements..... | 9 | +| 6.1 Requirements..... | 9 | +| 6.1.1 Requirements for Itf-N ..... | 9 | +| 6.1.2 Requirements for Os-Ma-nfvo ..... | 10 | +| 6.1.3 Requirements for Ve-Vnfm-em..... | 10 | +| 6.1.4 Requirements for Ve-Vnfm-vnf ..... | 10 | +| 6.2 Actor roles ..... | 10 | +| 6.3 Telecommunication resources..... | 10 | +| 6.4 Use cases ..... | 10 | +| 6.4.1 MOI creation related use cases..... | 10 | +| 6.4.1.1 Introduction..... | 10 | +| 6.4.1.2 Create MOI(s) after a VNF is instantiated (Triggered by NM)..... | 11 | +| 6.4.1.3 Create MOI(s) after a VNF is instantiated (Triggered by EM) ..... | 11 | +| 6.4.1.4 Create MOI(s) for a specified VNF instance (Triggered by NM)..... | 12 | +| 6.4.1.5 Associate MOI(s) with a VNF instance (Triggered by NM)..... | 12 | +| 6.4.1.6 Bulk MOIs creation ..... | 13 | +| 6.4.2 Configure VNF instance with Managed Object attributes ..... | 14 | +| 6.4.3 Delete the MOI(s) corresponding to a VNF instance (application part) ..... | 15 | +| 6.4.4 Update the MOI(s) corresponding to the subject VNF instance (application part) after a VNF instance is scaled (Triggered by NM)..... | 15 | +| 6.4.5 Update the MOI(s) corresponding to the subject VNF instance (application part) after a VNF instance is scaled (Triggered by EM)..... | 16 | +| 6.4.6 Void ..... | 16 | +| 6.4.7 Void ..... | 16 | +| 6.4.8 Void..... | 16 | +| 6.4.9 Enable/disable the auto-scaling of the VNF instance(s) corresponding to an NE..... | 16 | +| 6.4.10 VNF instance information synchronization..... | 17 | +| Annex A (informative): Change history..... | 18 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +**TS 28.510: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements.** + +TS 28.511: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Procedures. + +TS 28.512: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 2. + +TS 28.513: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 3. + +# 1 Scope + +The present document (together with the relevant requirements described in [1], [2], [3] and [4]) specifies the requirements applicable to Configuration Management (CM) of virtualized network functions. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.500: "Telecommunication management; Management concept,, architecture and requirements for mobile networks that include virtualized network functions". +- [5] ETSI GS NFV-IFA 008 (V2.1.1): "Network Function Virtualisation (NFV); Management and Orchestration; Ve-Vnfm reference point - Interface and Information Model Specification". +- [6] ETSI GS NFV-IFA 010 (V2.1.1): "Network Functions Virtualisation (NFV); Management and Orchestration; Functional requirements specification". +- [7] ETSI GS NFV-IFA 013 (V2.1.1): "Network Function Virtualisation (NFV); Management and Orchestration; Os-Ma-nfvo reference point - Interface and Information Model Specification". +- [8] 3GPP TS 28.525: "Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements". +- [9] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)" + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [4] 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] or in 3GPP TS 28.500 [4]. + +**VNF application specific parameters:** parameters for realizing the network element function. + +NOTE: VNF application specific parameters are defined by 3GPP. Examples can be network element name, network element address, etc. + +**VNF non-application specific parameters:** parameters for instantiating/scaling/terminating a VNF instance. + +NOTE: VNF non-application specific parameters are defined by ETSI NFV ISG and are related to the VNF deployment on virtualized infrastructure. An example can be VM parameters. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [4] 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] or in 3GPP TS 28.500 [4]. + +| | | +|-----|-------------------------| +| MO | Managed Object | +| MOI | Managed Object Instance | + +# --- 4 Background and concepts + +## 4.1 Configuration management in the context of NFV + +3GPP Configuration Management (CM) has system modification functions and system monitoring functions (as described in [3]). + +The decoupling of software and hardware in NFV gives rise to the need to model the VNF application specific parameters (i.e. 3GPP service related) by 3GPP whilst modelling the VNF non-application specific parameters (i.e. non-3GPP service related) in ETSI GS NFV-IFA 008 [5]. + +For Configuration Management, NM and EM manage NEs and NRs and the related configuration parameters (e.g. identification, port, neighbour relation) which are modelled as the MO(s) and MO attributes. The MO attributes, which are defined by 3GPP, typically are VNF application specific parameters. + +# --- 5 Business level requirements + +## 5.1 Requirements + +**REQ-NFV\_CM-CON-1** EM shall be able to perform necessary virtualized network function configuration due to the VNF lifecycle management from VNFM: + +- Add the VNF as managed node after VNF instantiation. +- Remove the VNF from managed nodes after VNF termination. +- Configure the VNF after some VNF LCM operations (i.e. instantiation). +- Re-configure the VNF after some VNF LCM operations (e.g. scaling, update/upgrade, etc.). + +**REQ-NFV\_CM-CON-2** 3GPP management system shall have a capability to create MO(s) corresponding to a VNF instance. + +**REQ-NFV\_CM-CON-3** 3GPP management system shall have a capability to configure the MO(s) corresponding to a VNF instance. + +**REQ-NFV\_CM-CON-4** Void + +**REQ-NFV\_CM-CON-5** Void + +**REQ-NFV\_CM-CON-6** Void + +**REQ-NFV\_CM-CON-7** Void + +**REQ-NFV\_CM-CON-8** 3GPP management system shall have a capability to delete MOI(s) related to a VNF instance. + +**REQ-NFV\_CM-CON-9** NM shall have a capability retrieving views of virtualized NEs from various management systems (e.g. EM, NFVO). + +**REQ-NFV\_CM-CON-10** 3GPP management system shall have a capability to manage bulk creation of MOIs representing NEs whose software components are designed to run on NFVI. + +## 5.2 Actor roles + +See detailed actors and roles for each use case in clause 5.4. + +## 5.3 Telecommunications resources + +See detailed telecommunication resources for each use case in clause 5.4. + +## 5.4 High-level use cases + +### 5.4.1 Create Managed Object for Network Element in the context of NFV + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To create Managed Object (MO) for a new NE that includes virtualized network functions. | | +| Actors and Roles | 3GPP management system (EM, NM) creates MO for NE.<br>NFV MANO system instantiates VNF instance and configures VNF non-application specific parameters for VNF instance. | | +| Telecom resources | NFV MANO system (NFVO, VNFM), 3GPP management system (EM, NM) | | +| Assumptions | NFV MANO system has already instantiated a VNF instance using the related VNF Package. | | +| Pre conditions | N/A | | +| Begins when | Operator has decided to create MO for a new NE. | | +| Step 1 (M) | 3GPP management system adds the VNF instance as a NE MO. 3GPP management system can configure the VNF instance with application specific parameters during the creation process of NE MO. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The MO for a new NE is added into 3GPP management system and is ready for further configuration management (e.g. new or additional application-specific parameters configuration can happen). | | +| Traceability | REQ-NFV_CM-CON-2, REQ-NFV_CM-CON-3 | | + +### 5.4.2 Delete MOI(s) for Network Element in the context of NFV + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To delete MOI(s) for a NE that includes virtualized network function. | | +| Actors and Roles | 3GPP management system (EM, NM) deletes MOI(s) for NE. | | +| Telecom resources | 3GPP management system (EM, NM). | | +| Assumptions | The MOI(s) for the NE to be deleted has been created. | | +| Pre conditions | The NE services have been released. | | +| Begins when | Operator has decided to delete the MOI(s) for a NE. | | +| Step 1 (M) | 3GPP management system deletes the MOI(s) for the subject NE. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The MOI(s) for the NE are deleted. | | +| Traceability | REQ-NFV_CM-CON-8 | | + +### 5.4.3 Update the configuration parameters corresponding to the subject VNF instance (application part) after a VNF instance is scaled + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Update the configuration parameters corresponding to the subject VNF instance (application part) after the VNF is scaled. | | +| Actors and Roles | 3GPP management system (EM, NM). | | +| Telecom resources | NFV MANO (NFVO, VNFM), 3GPP management system (EM, NM) | | +| Assumptions | | | +| Pre-conditions | | | +| Begins when | 3GPP management system is aware that the VNF instance has been scaled and determines the configuration parameters need to be updated. | | +| Step 1 (M) | 3GPP management system updates the configuration parameters corresponding to the subject VNF instance (application part). | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The configuration parameters corresponding to the subject VNF instance (application part) are updated. | | +| Traceability | REQ-NFV_CM-CON-3 | | + +### 5.4.4 Retrieve virtualized NE information by NM + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | NM updates its view of its managed virtualized NEs. | | +| Actors and Roles | NM | | +| Telecom resources | EM, NFVO. | | +| Assumptions | None | | +| Pre-conditions | None | | +| Begins when | NM determines a need to update its view of its managed VNFs. | | +| Step 1 (M) | NM requests NFVO to provide information of VNFs (see clause 7.3.6 in ETSI GS NFV-IFA 013 [7]).<br><br>NM requests EM to provide information of virtualized NEs. This information is VNF application-specific. | | +| Step 2 (M) | NFVO responds with the information requested. NM updates its view of its managed virtualized NE,<br><br>EM responds to NM with the information requested. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | NM has the information to update its view of its managed virtualized NEs. | | +| Traceability | REQ-NFV_CM-CON-9, | | + +# 6 Specification level requirements + +## 6.1 Requirements + +### 6.1.1 Requirements for Itf-N + +**REQ-NFV\_CM\_Itf-N-FUN-1** The IRP Agent shall support the capability allowing IRP Manager to manage the mobile networks that include virtualized network functions. + +**REQ-NFV\_CM\_Itf-N-FUN-2** The IRP Agent shall support the capability allowing IRP Manager to differentiate the virtualized and non-virtualized network functions. + +**REQ-NFV\_CM\_Itf-N-FUN-3** IRP Agent shall support the capability to allow IRP Manager to create the MOI(s) corresponding to a VNF instance (application part) and configure the attribute(s) of the MOI(s). + +**REQ-NFV\_CM\_Itf-N-FUN-4** IRP Agent shall support the capability to notify IRP Manager of the completion of the MOI(s) creation and configuration. + +**REQ-NFV\_CM\_Itf-N-FUN-5** IRP Agent shall support the capability to allow IRP Manager to delete the MOI(s) corresponding to a VNF instance (application part). + +**REQ-NFV\_CM\_Itf-N-FUN-6** IRP Agent shall support the capability to allow IRP Manager to update the Managed Object instance(s) corresponding to a VNF instance (application part). + +**REQ-NFV\_CM\_Itf-N-FUN-7** IRP Agent shall support the capability to notify IRP Manager the change of the Managed Object instance(s) corresponding to a VNF instance (application part). + +**REQ-NFV\_CM\_Itf-N-FUN-8** IRP Agent shall support the capability to allow IRP Manager to set the MOI(s) to associate with a VNF instance (application part) and configure the attribute(s) of the MOI(s). + +**REQ-NFV\_CM\_Itf-N-FUN-9** IRP Agent shall support a capability allowing IRP Manager to request enabling/disabling the auto-scaling of the VNF instance(s) corresponding to an NE. + +### 6.1.2 Requirements for Os-Ma-nfvo + +None. + +### 6.1.3 Requirements for Ve-Vnfm-em + +None. + +### 6.1.4 Requirements for Ve-Vnfm-vnf + +None. + +## 6.2 Actor roles + +See detailed actors and roles for each use case in clause 6.4. + +## 6.3 Telecommunication resources + +See detailed telecommunication resources for each use case in clause 6.4. + +## 6.4 Use cases + +### 6.4.1 MOI creation related use cases + +#### 6.4.1.1 Introduction + +The MO instance and VNF instance can exist independently. The 3GPP management system maintains the unidirectional relationships (MOI points to VNF instance) between MO instances and the corresponding VNF instances. + +There are following potential scenarios to maintain the relationship between MO instances and VNF instances. + +Scenario 1: The NM initiated MO instance creation operation (a new version of create MO operation) over Itf-N provides the available VNF instance identifier as an input parameter. The created MO instance representing vNE has the relationship with the selected VNF instance. + +Scenario 2: The NM initiated MO instance creation operation (a new version of create MO operation) over Itf-N has a parameter indicating whether a new VNF needs to be instantiated by EM. The presence of the indicator triggers the VNF instantiation request from EM to VNFM. The created MO instance representing vNE has the relationship with the new created VNF instance. + +Scenario 3: NM initiates MO instance creation operation using existing create MO operation over Itf-N. NM initiates the VNF instantiation operation via Os-Ma-nfvo. NM sets the relationship between MO instance representing vNE and VNF instance by SetMOAttribute operation (in Bulk or Basic CM IRP). + +Scenario 4: NM initiates the VNF instantiation operation via Os-Ma-nfvo. After the VNF instantiation is complete, the vNE starts execution and informs its presence to EM. + +EM would then create the MOI(s) representing the vNE. EM populates this newly created MOI with VNF identifier received from vNE. EM then notifies NM that the MOI(s) representing the newly installed vNE is created. NM can now exercise CM related operations on the said MOI from now on. + +Scenario 5: NM requests (conveyed via the Bulk CM IRP file) EM to create a set of MOI(s) representing a set of vNE. + +EM would initiate necessary VNF instantiation operations towards VNFM. After a VNF instantiation is complete, the vNE starts execution and informs its presence to EM. + +EM would then create the MOI(s) representing the vNE. EM populates this newly created MOI with VNF identifier received from vNE. EM then notifies NM that the MOI(s) representing the newly installed vNE is created. NM can now exercise CM related operations on the said MOI from now on. + +Editor's note: given that there can be multiple number of NMs, VNFM, EMs, NFVOs in an operator network and that there are five scenarios (UCs) documented to relate MOI(s) creation and VNF instance instantiation, there is a need to analyse if NM (or EM) can correctly determine which scenario will be selected. + +#### 6.4.1.2 Create MOI(s) after a VNF is instantiated (Triggered by NM) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Create the MOI(s) corresponding to a VNF instance (application part) and configure the attribute(s) of the MOI(s) after the VNF is instantiated. | | +| Actors and Roles | 3GPP NM. | | +| Telecom resources | 3GPP NM, 3GPP EM, NFVO | | +| Assumptions | | | +| Pre-conditions | The MOI(s) for the subject VNF instance have not been created. | | +| Begins when | NM receives the message indicating the subject VNF has been instantiated from NFVO or EM. | | +| Step 1 (M) | NM sends a request to EM to create the MOI(s) corresponding to the subject VNF instance (application part) and configure the attribute(s) of the MOI(s). | | +| Step 2 (M) | EM creates the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 3 (M) | EM configures the attribute(s) of the created MOI(s). | | +| Step 4 (M) | EM notifies NM of the completion of the MOI(s) creation and configuration. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to a VNF instance (application part) is/are created and configured. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-3, REQ-NFV_CM_Itf-N-FUN-4 | | + +#### 6.4.1.3 Create MOI(s) after a VNF is instantiated (Triggered by EM) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Create the MOI(s) corresponding to a VNF instance (application part) and configure the attribute(s) of the MOI(s) after the VNF is instantiated. | | +| Actors and Roles | 3GPP EM. | | +| Telecom resources | 3GPP EM, VNFM | | +| Assumptions | | | +| Pre-conditions | The MOI(s) for the subject VNF instance have not been created. | | +| Begins when | EM receives the message indicating the VNF has been instantiated from VNFM; | | +| Step 1 (M) | EM creates the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 2 (M) | EM configures the attribute(s) of the created MOI(s). | | +| Step 3 (M) | EM notifies NM of the completion of the MOI(s) creation and the VNF configuration. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to a VNF instance (application part) is/are created and configured. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-4 | | + +#### 6.4.1.4 Create MOI(s) for a specified VNF instance (Triggered by NM) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Create the MOI(s) corresponding to an existing VNF instance (application part) and configure the attribute(s) of the MOI(s) after the VNF is instantiated if needed. | | +| Actors and Roles | 3GPP NM. | | +| Telecom resources | 3GPP NM, 3GPP EM, NFVO | | +| Assumptions | | | +| Pre-conditions | The MOI(s) for the subject specified VNF instance have not been created.<br>NM receives the message indicating the subject VNF has been instantiated. | | +| Begins when | Operator decides to create MOI(s) for an existing VNF instance. | | +| Step 1 (M) | NM sends a request to EM to create the MOI(s) with the VNF instance identifier and configure the attribute(s) of the MOI(s). | | +| Step 2 (M) | EM creates the MOI(s) and sets the relevant MOI(s) attributes with the VNF instance identifier. | | +| Step 3 (O) | EM may configure other attribute(s) of the created MOI(s) if needed. | | +| Step 4 (M) | EM notifies NM of the completion of the MOI(s) creation and configuration. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to an existing VNF instance (application part) is/are created and configured. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-3, REQ-NFV_CM_Itf-N-FUN-4 | | + +#### 6.4.1.5 Associate MOI(s) with a VNF instance (Triggered by NM) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Associate MOI(s) with a VNF instance and configure the attribute(s) of the MOI(s) if needed. | | +| Actors and Roles | 3GPP NM. | | +| Telecom resources | 3GPP NM, 3GPP EM | | +| Assumptions | NM has subscribed to the <code>attributeValueChange</code> notification. | | +| Pre-conditions | The corresponding VNF instance has been instantiated and the VNF instance identifier has been notified to NM.<br>The MOI(s) has been created. | | +| Begins when | Operator decides to associate MOI(s) with an existing VNF instance. | | +| Step 1 (M) | NM sends a request with the VNF instance identifier to EM to associate MOI(s) with the VNF instance identified by the identifier. The other configuration parameters are also included in the request if needed. | | +| Step 2 (M) | EM sets the attributes of the created MOI(s) with the VNF instance Identifier. | | +| Step 3 (M) | EM responds NM of the completion of the association of MOI(s) and VNF instance. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to the specified VNF instance is/are created. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-8 | | + +#### 6.4.1.6 Bulk MOIs creation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | <p>To deploy large number of network elements whose software components are designed to run on NFVI.</p> <p>(The term NE used in this UC refers to network elements whose software components are designed to run on NFVI.)</p> | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | EM, NFVO, network planned data. | | +| <b>Assumptions</b> | <p>Operator has the network planned data for NEs and is ready for their deployment. The planned data contains information about the to-be-deployed NEs.</p> <p>During the VNF instantiation process, the VNF:</p> <ul style="list-style-type: none"> <li>a) is given the managing EM IP address, or;</li> <li>b) is given the managing EM name and sufficient information to access a directory server that can resolve the EM name to IP address – such that VNF can request the directory server to resolve the EM name to EM IP address, or;</li> <li>c) uses MvPnP (see requirements in clause 5.2 of [9]) to establish connection to its managing EM.</li> </ul> | | +| <b>Pre-conditions</b> | <p>For each wanted NE, operator knows the number and the types of VNFs needed.</p> <p>EM would keep records of all incoming messages that bear VNF ID and the VNF address (see Step 6).</p> | | +| <b>Begins when</b> | <p>Operator decides to deploy the NEs of specified types.</p> <p>Operator constructs a “Bulk Configuration Data File” (File) [see clause 10 of [9]] that captures</p> <ul style="list-style-type: none"> <li>the number of NEs (and types) wanted where one or more MOI(s) are representing software components designed to run on NFVI.</li> </ul> | | +| <b>Step 1 (M)</b> | Operator instructs NM to deploy the planned NEs using information of the File. | | +| <b>Step 2 (M)</b> | <p>NM, based on information in the File and the knowledge described in Pre-conditions, requests NFVO to instantiate all VNF(s) required for the deployment of all NEs wanted [Note 1.]</p> <p>NFVO, using VNFM/VIM, instantiates the VNFs requested for instantiation and responds to NM with the VNF IDs of the successfully instantiated VNFs [Note 1].</p> | | +| <b>Step 3 (M)</b> | <p>NM updates the File by capturing:</p> <ul style="list-style-type: none"> <li>the received VNF ID(s) in MOI's vnfIdList [Note 2] attribute.</li> </ul> | | +| <b>Step 4 (M)</b> | NM transfers the File (see procedure in [9]) to EM to deploy the planned network in accordance to the File information. | | +| <b>Step 5 (M)</b> | <p>EM creates sets of MOIs (where one set corresponds to one NE) in its Management Information Base (MIB) in accordance to the File information.</p> <p>The MOIs' vnfIdList attributes has the corresponding VNF IDs as values.</p> <p>The NE attribute operation state is set to Disabled.</p> | | +| <b>Step 6 (M)</b> | <p>When a VNF is instantiated, it knows its managing EM address (because of assumption a, b or c). VNF sends a message that bear its VNF ID and its VNF address, to its managing EM.</p> | | + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Step 7 (M)</b> | EM examines its records (see Pre-condition) or on reception of message from VNF that bears the VNF ID and the VNF address, will try to identify if the MOI(s) whose vnfIdList has an vnfId that is same as the VNF ID received. When found, the EM considers that the VNF is running on NFVI.<br><br>When all VNF instance(s) of a NE are running on NFVI, the operation state of the NE is changed to Enabled.<br><br>EM notifies NM of the NE whose operation state is Enabled. | | +| <b>Ends when</b> | The above steps have successfully completed. | | +| <b>Exceptions</b> | -- | | +| <b>Post-conditions</b> | The network resource model instance tree, maintained by EM, corresponding to the information of the File is created and the state of all NE(s) are Enabled. | | +| <b>Traceability</b> | REQ-NFV_CM-CON-10 | | +| | Note 1: NM may issue InstantiateNsRequest (clause 7.3.3. [8]) to NFVO or issue UpdateNsRequest to NFVO with input parameter updateType==instantiateVnf (clause 7.3.5 of [8]), based on his knowledge of NS instances in existence.<br><br>Note 2: It is assumed that MOIs would have an attribute called vnfListId whose elements are identifier of VNF instance involved. | | + +### 6.4.2 Configure VNF instance with Managed Object attributes + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Configure an existing VNF instance with Managed Object attributes. | | +| Actors and Roles | IRPManager | | +| Telecom resources | | | +| Assumptions | | | +| Pre conditions | The MOI(s) for the NE have been created. | | +| Begins when | Operator decides to configure Managed Object attributes for an existing VNF instance. | | +| Step 1 (M) | IRPManager sends a request to IRPAgent to configure the VNF instance over Itf-N. | | +| Step 2 (M) | IRPAgent configures the VNF instance with Managed Object attributes. | | +| Step 3 (M) | IRPAgent returns the result of the VNF instance configuration to IRPManager over Itf-N. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The VNF instance has been configured with Managed Object attributes. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-6 | | + +### 6.4.3 Delete the MOI(s) corresponding to a VNF instance (application part) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Delete the MOI(s) corresponding to the subject VNF instance (application part). | | +| Actors and Roles | 3GPP NM | | +| Telecom resources | 3GPP NM, 3GPP EM | | +| Assumptions | | | +| Pre-conditions | The 3GPP services provided by the VNF instance where its relevant MOI(s) are to be deleted have been released | | +| Begins when | The operator decides to delete the MOI(s) corresponding to a VNF instance (application part). | | +| Step 1 (M) | NM sends a request to EM to delete the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 2 (M) | EM deletes the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 3 (M) | EM notifies NM of the completion of the MOI(s) deletion. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to the subject VNF instance (application part) are deleted. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-5. | | + +### 6.4.4 Update the MOI(s) corresponding to the subject VNF instance (application part) after a VNF instance is scaled (Triggered by NM) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| Goal | Update the attributes of the MOI(s) corresponding to the subject VNF instance (application part) after a VNF has been scaled. | | +| Actors and Roles | 3GPP NM | | +| Telecom resources | 3GPP NM, 3GPP EM | | +| Assumptions | | | +| Pre-conditions | The MOI(s) for the subject VNF instance have not been updated. | | +| Begins when | NM learns that the VNF instance has been scaled, and decides the MOI(s) corresponding to the subject VNF instance (application part) need to be updated. | See use case in clause 6.4.3.4 in TS 28.525 [8] | +| Step 1 (M) | NM sends a request to EM to update the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 2 (M) | EM updates the attributes of the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 3 (M) | EM sends the notifications to NM about the update of the MOI(s). | | +| Ends when (*) | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to the subject VNF instance (application part) are updated. | | +| Traceability (*) | REQ-NFV_CM_Itf-N-FUN-6, REQ-NFV_CM_Itf-N-FUN-7 | | + +### 6.4.5 Update the MOI(s) corresponding to the subject VNF instance (application part) after a VNF instance is scaled (Triggered by EM) + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Update the attributes of the MOI(s) corresponding to the subject VNF instance (application part) after a VNF instance is scaled. | | +| Actors and Roles | 3GPP NM | | +| Telecom resources | 3GPP NM, 3GPP EM, VNFM | | +| Assumptions | | | +| Pre-conditions | The MOI(s) for the subject VNF instance have not been updated. | | +| Begins when | EM receives the message indicating the VNF has been scaled from VNFM and decides the MOI(s) corresponding to the subject VNF instance (application part) need to be updated. | | +| Step 1 (M) | EM updates the attributes of the MOI(s) corresponding to the subject VNF instance (application part). | | +| Step 2 (M) | EM sends the notifications to NM about the update of the MOI(s). | | +| Ends when (*) | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The MOI(s) corresponding to the subject VNF instance (application part) are updated. | | +| Traceability (*) | REQ-NFV_CM_Itf-N-FUN-7 | | + +6.4.6 Void + +6.4.7 Void + +6.4.8 Void + +### 6.4.9 Enable/disable the auto-scaling of the VNF instance(s) corresponding to an NE + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| Goal | Enable/Disable the auto-scaling of the VNF instance(s) corresponding to an NE. | | +| Actors and Roles | IRPManager | | +| Telecom resources | IRPAgent, VNFM | | +| Assumptions | | | +| Pre-conditions | | | +| Begins when | The operator decides to enable/disable the auto-scaling of the VNF instance(s) corresponding to an NE. | | +| Step 1 (M) | IRPManager requests IRPAgent to change the value of the auto-scaling attribute on VNF instance(s) corresponding to an NE. | | +| Step 2 (M) | EM requests VNFM to enable/disable the auto-scaling of the subject VNF instance(s). | Use case defined in clause 6.4.1.6 of [8]. | +| Step 3 (M) | IRPAgent notifies IRPManager of the completion result of enabling/disabling the auto-scaling of the VNF instance(s) corresponding to an NE. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The auto-scaling of the VNF instance(s) corresponding to an NE is enabled/disabled. | | +| Traceability | REQ-NFV_CM_Itf-N-FUN-9 | | + +### 6.4.10 VNF instance information synchronization + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Synchronize the VNF related information in a ManagedFunction instance with the corresponding VNF information in MANO side. | | +| <b>Actors and Roles</b> | IRP Agent | | +| <b>Telecom resources</b> | IRP Manager, VNFM | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | EM has subscribed the VnfLifecycleChangeNotification and VnfInfoAttributeValueChangeNotification (see clause 7.3.3 of [5]). | | +| <b>Begins when</b> | EM receives VnfLifecycleChangeNotification or VnfInfoAttributeValueChangeNotification (see clause 7.3.3 of [5]) from VNFM. | | +| <b>Step 1 (O)</b> | EM performs QueryVNF operation (see clause 7.2.9 of [5]) and obtains the current information of the corresponding VnfInfo object. | | +| <b>Step 2 (O)</b> | If the attribute values on EM do not match those of the current VnfInfo, EM updates these values. | | +| <b>Step 3 (O)</b> | If the attribute values of MOI(s) exposed to IRP Manager are changed, IRP Agent notifies IRP Manager about the attribute value changes. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The VNF related information in the ManagedFunction instance is synchronized with the corresponding VNF information in MANO side. | | +| <b>Traceability</b> | | | + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-09 | SA#77 | SP-170651 | 0001 | - | F | Remove the duplicated use cases and requirements | 14.1.0 | +| 2018-03 | SA#79 | SP-180058 | 0003 | 1 | F | Scope extension | 14.2.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28511/raw.md b/marked/Rel-16/28_series/28511/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..54f14b6051ff34089d4137813194ab34ab18ed55 --- /dev/null +++ b/marked/Rel-16/28_series/28511/raw.md @@ -0,0 +1,343 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Configuration Management procedures..... 6 + - 4.1 Introduction ..... 6 + - 4.2 MO configuration procedure..... 6 + - 4.3 Procedure of updating MOI(s) after a VNF is scaled..... 6 + - 4.4 MO creation..... 8 + - 4.4.1 MO creation after VNF instantiation (triggered by EM)..... 8 + - 4.4.2 MO creation for a specified VNF instance..... 8 + - 4.5 VNF termination triggers MO attribute value change ..... 9 + - 4.6 Enabling/disabling the auto-scaling initiated through Itf-N..... 10 + - 4.7 VNF instance information synchronization ..... 10 +- Annex A (informative): Change history..... 12 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.510: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements. +- TS 28.511: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Procedures.** +- TS 28.512: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 2. +- TS 28.513: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 3. + +# --- 1 Scope + +The present document specifies the Configuration Management (CM) procedures for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.510: "Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements" +- [3] GS NFV-IFA 008 (V2.1.1) (2016-10): "Network Functions Virtualisation (NFV); Management and Orchestration; Ve-Vnfm Reference Point – Interface and Information Model Specification". +- [4] 3GPP TS 28.526: "Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Procedures". +- [5] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [7] 3GPP TS 28.500: "Telecommunication management; Management concept,, architecture and requirements for mobile networks that include virtualized network functions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [7] 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] or in 3GPP TS 28.500 [7]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [7] 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] or in 3GPP TS 28.500 [7]. + +# 4 Configuration Management procedures + +## 4.1 Introduction + +The procedures listed in clause 4, as some of all the possibilities, are not exhaustive. + +## 4.2 MO configuration procedure + +This procedure shows how to configure the attributes of the existing MO corresponding to a VNF instance. + +Main steps for MO configuration: + +- 1) NM sends a request of configuring the attributes of the existing MO corresponding to a VNF instance to EM, this request includes relevant parameters for the MO configuration. +- 2) When EM receives the MO configuration request, it configures the attributes of the existing MO. +- 3) EM responds the result of the MO configuration to NM. + +![Sequence diagram of MO configuration procedure](47e8c2042061e08a14e012472e9fdbaa_img.jpg) + +``` +sequenceDiagram + participant NM + participant EM + participant NE(VNF) + Note left of NM: 1.MO configuration request + NM->>EM: + Note right of EM: 2.Configure the attributes of the MO + EM->>NE(VNF): + Note left of NM: 3.MO configuration response + EM->>NM: +``` + +The diagram illustrates the MO configuration procedure through a sequence of three messages between three entities: NM (Network Manager), EM (Element Manager), and NE(VNF) (Network Element/ VNF). The sequence starts with NM sending a '1.MO configuration request' to EM. EM then sends a '2.Configure the attributes of the MO' message to NE(VNF). Finally, EM sends a '3.MO configuration response' back to NM. + +Sequence diagram of MO configuration procedure + +Figure 4.2-1: MO configuration procedure + +## 4.3 Procedure of updating MOI(s) after a VNF is scaled + +This procedure shows how to update corresponding MOI(s) after a VNF is scaled. The procedure can be triggered by NM or EM. + +### Scenario 1: Triggered by NM + +The use case for scenario 1 is in clause 6.4.5 of [2]. In this case, the main steps of the procedure are: + +- 1) NM receives the message indicating the VNF instance has been scaled from NFVO (refer to step 3 of procedure in clause 4.2.3.3 of TS 28.526 [4]). +- 2) NM decides the MOI(s) corresponding to the subject VNF instance need to be updated. +- 3) NM sends a request to EM to update the MOI(s) corresponding to the subject VNF instance. +- 4) EM updates the attributes of the MOI(s) corresponding to the subject VNF instance. +- 5) EM sends the notification to NM about the update of the MOI(s). + +NOTE: The assumption of this scenario is that NM can know the relationship between VNF instance and corresponding MOI(s). + +![Sequence diagram for Figure 4.3-1 showing the procedure of updating MOI(s) after a VNF is scaled (Triggered by NM).](49ee89a1d5852ab005dbbab6de09a8a6_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant NFVO + Note right of NFVO: 1. Notify + Note left of NM: 2. Decides the MOI(s) +need to be updated + Note right of EM: 3. Update the MOI(s): setMOAttributes + Note right of EM: 4. Updates the MOI(s) + Note left of NM: 5. Notifies the update of MOI(s) + +``` + +The diagram illustrates a sequence of interactions between three entities: NM (Network Manager), EM (Element Manager), and NFVO (NFV Orchestrator). The process begins with a 'Notify' message from NFVO to EM. NM then 'Decides the MOI(s) need to be updated'. EM performs 'Update the MOI(s): setMOAttributes' and 'Updates the MOI(s)'. Finally, EM sends a notification to NM, labeled 'Notifies the update of MOI(s)'. + +Sequence diagram for Figure 4.3-1 showing the procedure of updating MOI(s) after a VNF is scaled (Triggered by NM). + +Figure 4.3-1: Procedure of updating MOI(s) after a VNF is scaled (Triggered by NM) + +### Scenario 2: Triggered by EM + +The use case for scenario 2 is in clause 6.4.6 of [2]. In this case, the main steps of the procedure are: + +- 1) EM receives the message indicating the subject VNF has been scaled from VNFM. +- 2) EM decides the MOI(s) corresponding to the subject VNF instance need to be updated. +- 3) EM updates the attributes of the MOI(s) corresponding to the subject VNF instance. +- 4) EM sends the notification to NM about the update of the MOI(s) plus the related information abstained in step 1. + +![Sequence diagram for Figure 4.3-2 showing the procedure of updating MOI(s) after a VNF is scaled (Triggered by EM).](ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + Note right of VNFM: 1. A VNF has been scaled + Note right of EM: 2. Decides the MOI(s) +need to be updated + Note right of EM: 3. Updates the attributes +of the MOI(s) + Note left of NM: 4. Notifies the update of the MOI(s) + +``` + +The diagram illustrates a sequence of interactions between NM (Network Manager), EM (Element Manager), and VNFM (VNF Manager). The process starts with a message 'A VNF has been scaled' from VNFM to EM. EM then 'Decides the MOI(s) need to be updated' and 'Updates the attributes of the MOI(s)'. Finally, EM sends a notification to NM, labeled 'Notifies the update of the MOI(s)'. + +Sequence diagram for Figure 4.3-2 showing the procedure of updating MOI(s) after a VNF is scaled (Triggered by EM). + +Figure 4.3-2: Procedure of updating MOI(s) after a VNF is scaled (Triggered by EM) + +## 4.4 MO creation + +### 4.4.1 MO creation after VNF instantiation (triggered by EM) + +The figure 4.4.1-1 illustrates the procedure of creating MO after the corresponding VNF instantiation is triggered by EM. + +![Sequence diagram showing MO creation after VNF instantiation. Entities: NM, EM, VNFM. Steps: 1. EM receives message indicating the VNF has been instantiated. 2. EM creates MOI(s) and sets attributes. 3. EM sends notifyObjectCreation to NM. 4. EM configures attributes of the created MOI(s).](5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg) + +``` + +sequenceDiagram + participant VNFM + participant EM + participant NM + Note right of VNFM: 1. EM receives message indicating the VNF has been instantiated. + Note right of EM: 2. Creates MOI(s) and sets attributes of the created MOI(s) referring to the new VNF instance. + EM->>NM: 3. notifyObjectCreation + Note right of EM: 4. Configures the attributes of the created MOI(s), if needed. + +``` + +Sequence diagram showing MO creation after VNF instantiation. Entities: NM, EM, VNFM. Steps: 1. EM receives message indicating the VNF has been instantiated. 2. EM creates MOI(s) and sets attributes. 3. EM sends notifyObjectCreation to NM. 4. EM configures attributes of the created MOI(s). + +**Figure 4.4.1-1: MO creation after VNF instantiation (triggered by EM)** + +- 1) When the new VNF instance is allocated with virtualized resources and configured with non-application parameters successfully, VNFM sends a *Notify* (see clause 7.3.3 [3]), carrying *VnfLifecycleChangeNotification* information element to EM with attributes *vnfInstanceId*, *status = "result"*, *operation = "instantiation"*, *lifecycleOperationOccurrenceId*, *affectedVnfc*, *affectedVl*, and *affectedVirtualStorage* (see clause 9.5.2 [3]) to indicate the end and the successful result of VNF instantiation, the parameter see clause 4.5 of [4]. +- 2) EM creates the MOI(s) and sets attributes of the created MOI(s) (i.e. VNF Instance Id) referring to the new VNF instance. +- 3) EM sends a *notifyObjectCreation* [6] to NM to indicate the result of the MO creation to NM. +- 4) EM may configure the attributes of the created MOI(s) if needed and send NM the *attributeValueChange* [6] notifications if NM has subscribed to the *attributeValueChange* notification. + +### 4.4.2 MO creation for a specified VNF instance + +Operator wants to create MOI(s) corresponding to a specified VNF instance. Operator, via NM, knows the identifier of the specific VNF instance via NM reception of the VNF instance instantiated notification. + +The figure 4.4.2-1 illustrates the procedure of creating MOI(s) for a specified VNF instance. + +![Sequence diagram showing the interaction between NM and EM for creating an MO with a VNF instance identifier. The diagram consists of two lifelines, NM and EM, and a box for the EM's internal process. Step 1: NM sends a 'CreateMORequest' message to EM. Step 2: EM creates the MOI(s) and sets the relevant MOI(s) attribute. Step 3: EM sends a 'notifyObjectCreation' message back to NM.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` +sequenceDiagram + participant NM + participant EM + Note right of EM: 2. EM creates the MOI(s) and sets the relevant MOI(s) attribute. + NM->>EM: 1. CreateMORequest + EM->>NM: 3. notifyObjectCreation +``` + +Sequence diagram showing the interaction between NM and EM for creating an MO with a VNF instance identifier. The diagram consists of two lifelines, NM and EM, and a box for the EM's internal process. Step 1: NM sends a 'CreateMORequest' message to EM. Step 2: EM creates the MOI(s) and sets the relevant MOI(s) attribute. Step 3: EM sends a 'notifyObjectCreation' message back to NM. + +**Figure 4.4.2-1: Creating MO with VNF instance identifier specified** + +- 1) NM sends a *createMO* (see clause 7.6.1 in [5]) to EM to create MOI(s) corresponding to the specified VNF instance with VNF instance identifier included. The other configuration parameters are also included in the request if needed. +- 2) EM creates the MOI(s) and sets the relevant MOI(s) attribute with the VNF Instance identifier referring to the specified VNF instance. EM may configure other attributes of the created MOI(s) if needed. +- 3) EM sends a *notifyObjectCreation* [6] to NM to indicate the result of the MO creation to NM. + +## 4.5 VNF termination triggers MO attribute value change + +This procedure shows the action of EM when it receives the VNF lifecycle change notification indicating a VNF instance has been terminated. It is assumed that a MO has been created to represent a VNF instance, and EM has subscribed to receive the VNF lifecycle change notification from VNFM: + +- 1) VNFM sends a *Notify* (see clause 7.3.3 [3]), carrying *VnfLifecycleChangeNotification* to EM (see clause 9.5.2 [3]) to indicate the result of VNF termination, when the VNF termination operation is completed. +- 2) EM detects that a VNF instance has been terminated by checking the attributes `status = "result"` and `operation = "termination"`, and decides to modify the MO attribute to remove the association with the VNF instance identified by `vnfInstanceId`. +- 3) EM sends a *notifyAttributeValueChange* [6] to NM to indicate the MO attribute value has been changed. + +![Sequence diagram for VNF termination triggers MO attribute value change. Lifelines: NM, EM, VNFM. Step 1: VNFM sends 'Notify' to EM. Step 2: EM performs internal action 'Modify the MO attribute to remove the association with the VNF instance'. Step 3: EM sends 'notifyAttributeValueChange' to NM.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + VNFM->>EM: 1. Notify + Note over EM: 2. Modify the MO attribute to remove +the association with +the VNF instance + EM->>NM: 3. notifyAttributeValueChange + +``` + +Sequence diagram for VNF termination triggers MO attribute value change. Lifelines: NM, EM, VNFM. Step 1: VNFM sends 'Notify' to EM. Step 2: EM performs internal action 'Modify the MO attribute to remove the association with the VNF instance'. Step 3: EM sends 'notifyAttributeValueChange' to NM. + +**Figure 4.5-1: VNF termination triggers MO attribute value change** + +## 4.6 Enabling/disabling the auto-scaling initiated through Itf-N + +Figure 4.6-1 depicts the procedure of enabling/disabling the auto-scaling of the VNF instance(s) corresponding to an NE through Itf-N. + +1. NM sends to EM a *setMOAttributes* (see clause 7.6.3 in [5]) to EM with the item <vnfInfoList.isAutoScalingEnabled, TRUE/FALSE, replace> in the attribute `modificationList` for enabling/disabling the auto-scaling. +2. EM requests VNFM to enable/disable the auto-scaling of the VNF instance(s) (see procedure in clause 4.2.6.1 of [4]). +3. EM sends a *notifyAttributeValueChange* [6] to NM to indicate the MO attribute(s) value has been changed.. + +![Sequence diagram for enabling/disabling the auto-scaling initiated through Itf-N. Lifelines: NM, EM, VNFM. Step 1: NM sends 'setMOAttributes' to EM. Step 2: EM performs internal action 'EM requests VNFM to enable/disable the auto-scaling of the VNF instance(s)'. Step 3: EM sends 'notifyAttributeValueChange' to NM.](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + NM->>EM: 1. setMOAttributes + Note over EM: 2. EM requests VNFM to enable/disable the +auto-scaling of the VNF instance(s) + EM->>NM: 3. notifyAttributeValueChange + +``` + +Sequence diagram for enabling/disabling the auto-scaling initiated through Itf-N. Lifelines: NM, EM, VNFM. Step 1: NM sends 'setMOAttributes' to EM. Step 2: EM performs internal action 'EM requests VNFM to enable/disable the auto-scaling of the VNF instance(s)'. Step 3: EM sends 'notifyAttributeValueChange' to NM. + +**Figure 4.6-1: Enabling/disabling the auto-scaling initiated through Itf-N** + +## 4.7 VNF instance information synchronization + +Figure 4.7-1 depicts the procedure of VNF instance information synchronization from MANO side to 3GPP side. + +1. VNFM notifies EM with *VnfLifecycleChangeNotification* or *VnfInfoAttributeValueChangeNotification* (see clause 7.3.3 of [3]). + +2. EM sends *QueryVnfRequest* to VNFM with *filter* and *attributeSelector* to query the VNF instance information (see clause 7.2.9 [3]). +3. VNFM sends *QueryVnfResponse* to EM with *vnfInfo* (see clause 9.4.2 of [3]). +4. If the attribute values on EM do not match those of the current *VnfInfo*, EM updates these values. +5. IPRAgent notifies IPRManager about the attribute value changes. + +![Sequence diagram for VNF instance information synchronization between NM, EM, and VNFM.](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` +sequenceDiagram + participant NM + participant EM + participant VNFM + Note right of VNFM: 1. Notify + EM->>VNFM: 2. QueryVnfRequest + VNFM-->>EM: 3. QueryVnfResponse + opt Attribute values do not match VnfInfo + Note right of EM: 4. AttributeValueChange + EM->>NM: 5. Notify(AttributeValueChange) + end +``` + +The sequence diagram illustrates the interaction between three entities: NM (Network Manager), EM (Element Manager), and VNFM (VNF Manager). The process begins with a 'Notify' message from VNFM to EM. EM then sends a 'QueryVnfRequest' to VNFM, which responds with 'QueryVnfResponse'. An optional block titled '[Attribute values do not match VnfInfo]' contains two steps: EM sends an 'AttributeValueChange' message to itself, and then EM sends a 'Notify(AttributeValueChange)' message to NM. + +Sequence diagram for VNF instance information synchronization between NM, EM, and VNFM. + +Figure 4.7-1: VNF instance information synchronization + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170473 | | | | Presented for approval | 2.0.0 | +| 2017-06 | SA#76 | | | | | Upgrade to change control version | 14.0.0 | +| 2018-03 | SA#79 | SP-180058 | 0002 | 1 | F | Scope extension | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28512/raw.md b/marked/Rel-16/28_series/28512/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ce68eab2c727fb6ff34560919a748db6a2204a5e --- /dev/null +++ b/marked/Rel-16/28_series/28512/raw.md @@ -0,0 +1,129 @@ + + + + + + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 5 + +2 References..... 5 + +3 Definitions and abbreviations ..... 5 + +3.1 Definitions..... 5 + +3.2 Abbreviations ..... 6 + +4 Information Model Definition..... 6 + +4.1 Itf-N..... 6 + +5 Interface Definition ..... 6 + +5.1 Itf-N..... 6 + +5.2 CM interface over Os-Ma-nfvo..... 6 + +5.3 CM interface over Ve-Vnfm-em..... 6 + +5.4 CM interface over Ve-Vnfm-vnf..... 6 + +Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.510: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements +- TS 28.511: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Procedures +- TS 28.512: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 2** +- TS 28.513: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 3 + +# --- 1 Scope + +The present document is Configuration Management stage 2 specification for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)". +- [3] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [4] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 28.708: "Telecommunication management; Evolved Packet Core (EPC); Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 28.705: "Telecommunication management; IP Multimedia Subsystem (IMS); Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 28.500: "Telecommunication management; Management concept,, architecture and requirements for mobile networks that include virtualized network functions". +- [8] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS) ". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [7] 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] or in 3GPP TS 28.500 [7]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [7] 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] or in 3GPP TS 28.500 [7]. + +# --- 4 Information Model Definition + +## 4.1 Itf-N + +For Itf-N configuration management of virtualized network functions which can be part of EPC or IMS, the IOCs defined in 3GPP TS 28.622 [4], 28.708[5] and 28.705[6] shall be reused. + +In 3GPP TS 28.622 [4], a new attribute *vnfParametersList* is added in the IOC *ManagedFunction* (see clause 4.3.4 in [4]) to support the configuration management of virtualized network functions which can be part of EPC or IMS. + +# --- 5 Interface Definition + +## 5.1 Itf-N + +For Itf-N configuration management of virtualized network functions which can be part of EPC or IMS, the operations defined in 3GPP TS 32.602 [2] and TS 32.612 [8] and notifications defined in 3GPP TS 32.662 [3] shall be reused. + +## 5.2 CM interface over Os-Ma-nfvo + +None. + +## 5.3 CM interface over Ve-Vnfm-em + +None. + +## 5.4 CM interface over Ve-Vnfm-vnf + +None. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170474 | | | | Presented for information and approval | 1.0.0 | +| 2017-06 | SA#76 | | | | | Upgrade to change control version | 14.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28513/raw.md b/marked/Rel-16/28_series/28513/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d8832addd14d6de899dd72dc98e266aa49d079ca --- /dev/null +++ b/marked/Rel-16/28_series/28513/raw.md @@ -0,0 +1,98 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 6 +- 4 Interface definitions ..... 6 + - 4.1 Itf-N..... 6 +- 5 NRM Solution Set definitions..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.510: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements +- TS 28.511: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Procedures +- TS 28.512: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 2 +- TS 28.513: Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Stage 3** + +# --- 1 Scope + +The present document is Configuration Management stage 3 specification for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions".[3] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [4] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [5] 3GPP TS 32.666: "Telecommunication management; Configuration Management (CM); Kernel CM Integration Reference Point (IRP); Solution Set (SS) definitions".[6] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 28.709: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] 3GPP TS 28.706: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions" + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +# --- 4 Interface definitions + +## 4.1 Itf-N + +For Itf-N configuration management of virtualized network functions which can be part of EPC or IMS, the interface IRP solution sets defined in 3GPP TS 32.606 [3], TS 32.616 [4] and TS 32.666 [5] shall be used. + +# --- 5 NRM Solution Set definitions + +For Itf-N configuration management of virtualized network functions which can be part of EPC or IMS, the NRMs defined in 3GPP TS 28.623 [6], TS 28.709 [7] and TS 28.706 [8] shall be used. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170475 | | | | Presented for information and approval | 1.0.0 | +| 2017-06 | SA#76 | | | | | Upgrade to change control version | 14.0.0 | +| 2017-08 | SA#80 | SP-180417 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28515/raw.md b/marked/Rel-16/28_series/28515/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ec6f41bc9243a2702659aa135233a41f1a67636c --- /dev/null +++ b/marked/Rel-16/28_series/28515/raw.md @@ -0,0 +1,341 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Concepts and background ..... | 6 | +| 4.1 Fault Management in the context of NFV..... | 6 | +| 5 Business level requirements..... | 6 | +| 5.1 Requirements..... | 6 | +| 5.2 Actor roles ..... | 6 | +| 5.3 Telecommunications resources ..... | 6 | +| 5.4 High-level use cases..... | 7 | +| 5.4.1 NE alarm correlation in the context of NFV ..... | 7 | +| 5.4.2 NFVI Maintenance coordination..... | 7 | +| 6 Specification level requirements..... | 8 | +| 6.1 Requirements..... | 8 | +| 6.1.1 Requirements for Itf-N ..... | 8 | +| 6.1.2 Requirements for Os-Ma-nfvo ..... | 8 | +| 6.1.3 Requirements for Ve-Vnfm-em..... | 8 | +| 6.1.4 Requirements for Ve-Vnfm-vnf ..... | 8 | +| 6.2 Actor roles ..... | 8 | +| 6.3 Telecommunications resources ..... | 8 | +| 6.4 Use cases ..... | 9 | +| 6.4.1 NE alarm correlation in the context of NFV ..... | 9 | +| 6.4.2 VNF Healing through operation request to VNFM by EM..... | 9 | +| 6.4.3 Virtualization-specific aspect failure detection and notification by VNFM ..... | 10 | +| 6.4.4 Virtualization-specific aspect failure detection and notification by EM ..... | 11 | +| 6.4.5 NE alarm reporting in the context of NFV ..... | 11 | +| 6.4.6 Virtualization-specific aspect failure notification by VNFM..... | 12 | +| Annex A (informative): Change history..... | 13 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +**TS 28.515 "Fault Management (FM) for mobile networks that include virtualized network functions; Requirements".** + +TS 28.516 "Fault Management (FM) for mobile networks that include virtualized network functions; Procedures". + +TS 28.517 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 2". + +TS 28.518 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 3". + +# --- 1 Scope + +The present document (together with the relevant requirements described in [2], [3], [4] and [5]) specifies the requirements applicable to Fault Management (FM) of mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [3] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [4] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [5] 3GPP TS 32.111-1: "Telecommunication management; Fault Management; Part 1: 3G fault management requirements". +- [6] ETSI GS NFV-IFA 010 (V2.2.1): "Network Functions Virtualisation (NFV); Management and Orchestration; Functional Requirements Specification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +| | | +|-------|--------------------------------| +| VM | Virtual Machine | +| vNIC | virtual Network Interface Card | +| vPORT | virtual Port | + +# --- 4 Concepts and background + +## 4.1 Fault Management in the context of NFV + +Fault Management functionality traditionally includes fault detection, generation of alarms, clearing of alarms, alarm forwarding and filtering, storage and retrieval of alarms, correlation of alarms and events, alarm root cause analysis and fault recovery. With introduction of virtualized network functions (VNFs) into mobile networks, Fault Management + +functionality is distributed over different functional blocks. These different functional blocks may be located at different levels such as NFV Infrastructure (NFVI) level, NE level, NFV Management and Orchestration level and 3GPP network management level. + +The decoupling of software from hardware by means of virtualization changes the way in which the faults were managed in non-virtualized NE deployments: + +- Physical hardware faults of NFVI are detected by NFVI and corrected jointly with the support from NFV-MANO. Only information about those faults (e.g. faults corresponding to the virtualized resources) that affect the proper functioning of VNF needs to be provided to 3GPP management system. +- VNF-related virtualized resource fault information needs to be sent from NFV-MANO to 3GPP management system, and then 3GPP management system can take some necessary actions. +- VNF application fault information needs to be sent from the VNF instance to the corresponding 3GPP management system that is responsible for taking some necessary actions. +- VNF virtualization-specific fault information is detected by VNF and needs to be sent from the VNF instance to both the VNFM and the corresponding 3GPP management system so that they can take necessary actions accordingly. + +# --- 5 Business level requirements + +## 5.1 Requirements + +**REQ-NFV\_FM-CON-1** The faulty virtualization-specific aspect of a virtualized network function shall be able to be recovered. + +**REQ-NFV\_FM-CON-2** 3GPP management system shall be able to get VNF application fault reports about a faulty NE. + +**REQ-NFV\_FM-CON-3** 3GPP management system shall be able to get VNF virtualization-related fault reports from NFV-MANO. + +**REQ-NFV\_FM-CON-4** The content of the fault information from VNF application fault reports and VNF virtualization-related fault reports shall enable 3GPP management system to correlate VNF application fault(s) with VNF virtualization-related fault(s). + +**REQ-NFV\_FM-CON-5** EM shall be able to send to VNFM a request to recover the faulty virtualization-specific aspect of a virtualized network function. + +## 5.2 Actor roles + +See actors and roles of each use case in clause 5.4. + +## 5.3 Telecommunications resources + +See telecom resources of each use case in clause 5.4. + +## 5.4 High-level use cases + +### 5.4.1 NE alarm correlation in the context of NFV + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To correlate NE alarms in a mobile network that includes virtualized network functions. | | +| Actors and Roles | 3GPP management system (EM, NM) correlates NE alarms.<br>NFV MANO functional entity VNFM notifies virtualized resource alarms to 3GPP management system. | | +| Telecom resources | VNFM, 3GPP management system (EM, NM) | | +| Assumptions | - 3GPP management system can get VNF application alarms of the faulty NE, and<br>- VNFM can get virtualized resource alarms and identify the corresponding VNF instance. | | +| Pre conditions | N/A | | +| Begins when | There is a new failure which may impact the virtualized resource and the corresponding NE application. | | +| Step 1 (M) | 3GPP management system gets VNF application alarm(s) of a faulty NE.<br>VNFM gets virtualized resource alarm(s) and notifies the corresponding VNF instance related virtualized resource alarm(s) to 3GPP management system. | | +| Step 2 (M) | Based on the virtualized resource alarm(s) sent from VNFM and those VNF application alarms reported from NE, 3GPP management system makes alarm correlation. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | The virtualized resource alarm(s) and VNF application alarm(s) are correlated by 3GPP management system. | | +| Traceability | REQ-MAMO_FM-CON-3, REQ-MAMO_FM-CON-4, REQ-MAMO_FM-CON-5 | | + +### 5.4.2 NFVI Maintenance coordination + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To avoid the unwanted impact to VNF application from NFVI maintenance | | +| Actors and Roles | NM, NFVO, VNFM, VIM | | +| Telecom resources | NFVO, VNFM, VIM, NFVI | | +| Assumptions | There is an agreement that NFV-MANO system should get permission from NM before scheduled NFVI maintenance, managed by NFV-MANO, can start. | | +| Pre conditions | N/A | | +| Begins when | NFVO receives a notification from VIM informing about NFVI maintenance impacting the VRs (Virtualised Resources) that are used by a NS instance (e.g. the subordinative VNF instances and Virtual Links). | | +| Step 1 (M) | NFVO informs NM about the NFVI maintenance. | | +| Step 2 (M) | NM confirms the NFVI maintenance positively or not positively. | | +| Step 3 (M) | NFVO acts according to the response from NM. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | NFVI maintenance activity has been coordinated between NM and NFVO. | | +| Traceability | FFS | | + +# 6 Specification level requirements + +## 6.1 Requirements + +### 6.1.1 Requirements for Itf-N + +**REQ-NFV\_FM\_Itf-N-FUN-1** IRP Agent shall have the capability to send VNF application alarms to IRP Manager. + +**REQ-NFV\_FM\_Itf-N-FUN-2** IRP Agent should have the capability to send VNF instance related virtualized resource alarms to IRP Manager. + +**REQ-NFV\_FM\_Itf-N-FUN-3** The existing AlarmIRP should be reused as much as possible. + +### 6.1.2 Requirements for Os-Ma-nfvo + +None. + +### 6.1.3 Requirements for Ve-Vnfm-em + +**REQ-NFV\_FM\_Ve-Vnfm-em-FUN-1** The Ve-Vnfm-em reference point shall support a capability allowing VNFM to notify EM the VNF and/or VNFC instance related virtualized resource failure reports, in which information (e.g. VM Identifier, vNIC/vPORT Identifier) of faulty VNF and/or VNFC instance is included. + +**REQ-NFV\_FM\_Ve-Vnfm-em-FUN-2** The Ve-Vnfm-em reference point shall support a capability allowing VNFM to notify EM and other authorized consumers who can play the role of EM, the virtualization-specific aspect failure reports, in which information of faulty VNF and VNFC instance(s) is included. + +**REQ-NFV\_FM\_Ve-Vnfm-em-FUN-3** The Ve-Vnfm-em reference point shall support the EM to send to VNFM a request to execute the VNF Healing of a virtualized network function indicating the corresponding healing procedure and VNFC instance(s). + +**REQ-NFV\_FM\_Ve-Vnfm-em-FUN-4** The Ve-Vnfm-em reference point shall support a capability allowing EM to subscribe/unsubscribe to VNF and VNFC instance related alarm notification provided by the VNFM. + +### 6.1.4 Requirements for Ve-Vnfm-vnf + +**REQ-NFV\_FM\_Ve-Vnfm-vnf-FUN-1** The Ve-Vnfm-vnf reference point shall support the capability for the VNF virtualization-specific component to notify about faulty virtualization-specific aspects to VNFM. + +## 6.2 Actor roles + +See actors and roles of each use case in clause 6.4. + +## 6.3 Telecommunications resources + +See telecom resources of each use case in clause 6.4. + +## 6.4 Use cases + +### 6.4.1 NE alarm correlation in the context of NFV + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To correlate NE alarms in a mobile network that includes virtualized network functions. | | +| Actors and Roles | EM or NM correlates NE alarms.<br>VNFM notifies virtualized resource alarms to EM.<br>EM sends VNF application failure reports and VNF instance related virtualized failure reports to NM. | | +| Telecom resources | NM, EM, VNFM | | +| Assumptions | 3GPP management system (EM, NM) can get VNF application alarms of the faulty NE. VNFM can get virtualized resource alarms and identify the corresponding VNF instance. | | +| Pre conditions | N/A | | +| Begins when | There is a new failure which may impact the virtualized resource and the corresponding NE application. | | +| Step 1 (M) | EM sends VNF application failure reports of a fault NE to NM. | | +| Step 2 (M) | VNFM sends VNF instance related virtualized failure reports to EM, in which information of the failed VNF instance is included. EM reports VNF instance related virtualized failure reports to NM.<br>NOTE: Sequence of step 1 and step 2 may be reversed. | | +| Step 3 (M) | Based on the virtualized resource failure reports sent from VNFM and VNF application alarms, EM or NM makes the alarm correlation. | | +| Ends when | Ends when all steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | Failure reports of a faulty NE are reported and correlated by 3GPP management system. | | +| Traceability | REQ-NFV_FM_Itf-N-FUN-1, REQ-NFV_FM_Itf-N-FUN-2, REQ-NFV_FM_Ve-Vnfm-em-FUN-1 | | + +### 6.4.2 VNF Healing through operation request to VNFM by EM + +NOTE: In the context of this use case, VNF Healing [6] refers to corrective actions performed by the VNFM to recover a VNF which fails to perform as expected, and/or its VNFC instances and internal VNF Virtual Link(s), and it concerns the actions for which the VNFM is responsible, i.e., corrective action(s) toward virtualised resources, instantiation of VNFC, configuration of VNF deployment specific parameters, etc. + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To recover the faulty virtualization-specific aspect of a virtualized network function by executing a VNF Healing through an operation request to VNFM by EM and notify about the execution of the VNF healing through reference point Ve-Vnfm-em. | | +| Actors and Roles | EM requests the VNFM to execute the VNF healing based on the information included in the request. | | +| Telecom resources | EM.<br>VNFM.<br>VNF. | | +| Assumptions | EM is subscribed to VNF lifecycle change notifications from the VNFM. | | +| Pre-conditions | The subject VNF instance is not being healed at the moment. | | +| Begins when | A faulty virtualization-specific aspect of the VNF has been notified to EM. | | +| Step 1 (M) | EM determines that VNF Healing is needed. | | +| Step 2 (M) | EM requests the VNFM to execute the VNF Healing with indication of VNF Components to recover and indication of the healing procedure to execute with input parameters as required. | | +| Step 3 (O) | VNFM sends to EM a notification about the start of the VNF healing execution. | | +| Step 4 (M) | The VNFM executes the procedure to heal the VNF instance. | | +| Step 5 (M) | VNFM sends to EM a notification about the end and the result of the VNF Healing execution. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | The VNF Healing procedure in step 4 fails. | | +| Post-conditions | The faulty virtualization-specific aspect of the VNF is recovered. | | +| Traceability | REQ-NFV_FM_Ve-Vnfm-em-FUN-3 | | + +### 6.4.3 Virtualization-specific aspect failure detection and notification by VNFM + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To notify the EM about a virtualization-specific failure of a virtualized network function through Ve-Vnfm-em reference point. | | +| Actors and Roles | VNF virtualization-specific component. | | +| Telecom resources | EM.<br>VNFM.<br>VNF. | | +| Assumptions | - VNFM receives virtualised resource fault reports from VIM.<br>- VNF application-specific fault is reported to the EM.<br>- EM is subscribed to VNF-related virtualization fault reports from the VNFM. | | +| Pre-conditions | N/A | | +| Begins when | The virtualization-specific failure is detected by the VNF virtualization-specific component. | | +| Step 1 (M) | VNF virtualization-specific component sends virtualization-specific fault notification to VNFM over Ve-Vnfm-vnf reference point. | | +| Step 2 (M) | VNFM creates VNF virtualization-related fault report about the VNF and its VNF Components. | | +| Step 3 (M) | VNFM sends the VNF virtualization-related fault report to the EM over Ve-Vnfm-em reference point. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The EM is notified about the virtualization-specific failure of the subject VNF. | | +| Traceability | REQ-NFV_FM_Ve-Vnfm-vnf-FUN-1, REQ-NFV_FM_Ve-Vnfm-em-FUN-2 | | + +### 6.4.4 Virtualization-specific aspect failure detection and notification by EM + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To notify the EM about a virtualization-specific failure of a virtualized network function. | | +| Actors and Roles | VNF virtualization-specific component | | +| Telecom resources | EM.<br>VNFM.<br>VNF. | | +| Assumptions | - VNF application-specific fault is reported to the EM.<br>- EM is subscribed to VNF-related virtualization fault reports. | | +| Pre-conditions | N/A | | +| Begins when | The virtualization-specific failure is detected by the VNF virtualization-specific component. | | +| Step 1 (M) | VNF virtualization-specific component sends virtualization-specific fault notification to EM. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The EM is notified about the virtualization-specific failure of the subject VNF. | | +| Traceability | | | + +### 6.4.5 NE alarm reporting in the context of NFV + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To send or notify NE alarms in a mobile network that includes virtualized network functions. | | +| Actors and Roles | EM reports NE alarms to NM.<br>NFV MANO functional entity VNFM notifies VNF instance alarms related to virtualized resource to 3GPP management system EM. | | +| Telecom resources | VNFM, EM, NM | | +| Assumptions | EM can detect VNF application alarms of the faulty NE, and VNFM can get virtualized resource alarms, identify the corresponding VNF instance and notify the corresponding VNF instance alarm to EM. | | +| Pre conditions | N/A | | +| Begins when | There is a failure which impacts the NE application and/or the corresponding virtualized resources. | | +| Step 1 (M) | EM detects VNF application alarm(s) of a faulty NE. | | +| Step 2 (M) | If there is virtualized resource alarm(s), VNFM notifies the corresponding VNF instance alarm(s) with related virtualized resource information to EM. | | +| Step 3 (M) | EM reports the NE application alarm(s) and/or the VNF instance alarm(s) sent from VNFM to NM over Itf-N. | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post Conditions | NE alarms are sent from EM to NM. | | +| Traceability | REQ-NFV_FM_Itf-N-FUN-3 | | + +### 6.4.6 Virtualization-specific aspect failure notification by VNFM + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To notify authorized consumer who can play the role of EM about virtualization-specific aspect alarms. | | +| Actors and Roles | The consumer | | +| Telecom resources | VNFM | | +| Assumptions | The consumer that requires the VNF-related virtualization fault information produced by VNFM, has a subscription to receive such information, | | +| Pre-conditions | N/A | | +| Begins when | VNFM is aware of a VNF virtualization-specific aspect problem. | | +| Step 1 (M) | VNFM creates an alarm record. | | +| Step 2 (M) | VNFM sends the alarm record to the consumer(s) which has subscribed to receiving such information. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The consumer(s) has received the virtualization-specific aspects failure information. | | +| Traceability | REQ-NFV_FM_Ve-Vnfm-em-FUN-2 | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170505 | 0001 | - | F | Update text in the scope to align with other NFV TSs | 14.1.0 | +| 2018-06 | SA#80 | SP-180417 | 0002 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28516/raw.md b/marked/Rel-16/28_series/28516/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..06108c38db4f71e39ebe4466b97e7328200f7a20 --- /dev/null +++ b/marked/Rel-16/28_series/28516/raw.md @@ -0,0 +1,297 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Fault Management procedures ..... 6 + - 4.1 Introduction ..... 6 + - 4.2 NE alarm correlation in the context of NFV ..... 7 + - 4.2.1 NE alarm correlation made by EM in the context of NFV..... 7 + - 4.2.2 NE alarm correlation made by NM in the context of NFV ..... 8 + - 4.3 Virtualization-specific aspect failure detection and notification..... 9 + - 4.3.1 Virtualization-specific aspect failure detection and notification by VNFM ..... 9 + - 4.3.2 Virtualization-specific aspect failure detection and notification by EM..... 10 + - 4.4 VNF Healing with operation request to VNFM by EM through Ve-Vnfm-em..... 11 +- Annex A (informative): Change history..... 12 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 28.515 "Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". + +**TS 28.516 "Fault Management (FM) for mobile networks that include virtualized network functions; Procedures".** + +TS 28.517 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 2". + +TS 28.518 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 3". + +# --- 1 Scope + +The present document specifies the Fault Management procedures for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP) Information Service (IS)". +- [3] ETSI GS NFV-IFA 008 (V2.1.1): "Network Functions Virtualisation (NFV); Management and Orchestration; Ve-Vnfm Reference Point - Interface and Information Model Specification". +- [4] 3GPP TS 28.515: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". +- [5] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [5] 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] or in 3GPP TS 28.500 [5]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [5] 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] or in 3GPP TS 28.500 [5]. + +| | | +|-------|----------------------------------------| +| VM | Virtual Machine | +| VNFC | Virtualized Network Function Component | +| vNIC | virtual Network Interface Card | +| vPORT | virtual Port | + +# --- 4 Fault Management procedures + +## 4.1 Introduction + +The overview of alarm data flow procedures in context of NFV is showed as Figure 4.1-1 3GPP view of FM data flows. + +![Figure 4.1-1: 3GPP view of alarm data flows for NE/VNF. The diagram shows the following components and flows: OSS (top left) connected to NFVO (top right) via Os-Ma-Nfvo. OSS is connected to EM (middle left) via Itf-N. NFVO is connected to VNFM (middle right) via Or-Vnfm. VNFM is connected to VIM (bottom right) via Vi-Vnfm. VIM is connected to NFVI (bottom left) via Nf-Vi. NFVI is connected to VNF (middle left) via Vn-Nf. VNF is connected to EM via Ve-Vnfm-vnf. EM is connected to NE (bottom left) via Type 1. NE is connected to EM via Z. NE Alarm. VNF is connected to EM via X. VNF Alarm. VNFM is connected to EM via Ve-Vnfm-em. VNFM is connected to VIM via Vi-Vnfm. VNFM is connected to NFVO via Or-Vi. The following alarm flows are indicated: 1. Virtualized resources Alarm (VIM to VNFM), 2. VNF Alarm related to virtualized resources (VNFM to EM), 3. Virtualization-specific Alarm (VNF to VNFM), X. VNF Alarm (VNF to EM), Y. NE/VNF Alarm (EM to OSS), Z. NE Alarm (NE to EM).](88b0f3f4393228e9ea4d6542aef7c399_img.jpg) + +Figure 4.1-1: 3GPP view of alarm data flows for NE/VNF. The diagram shows the following components and flows: OSS (top left) connected to NFVO (top right) via Os-Ma-Nfvo. OSS is connected to EM (middle left) via Itf-N. NFVO is connected to VNFM (middle right) via Or-Vnfm. VNFM is connected to VIM (bottom right) via Vi-Vnfm. VIM is connected to NFVI (bottom left) via Nf-Vi. NFVI is connected to VNF (middle left) via Vn-Nf. VNF is connected to EM via Ve-Vnfm-vnf. EM is connected to NE (bottom left) via Type 1. NE is connected to EM via Z. NE Alarm. VNF is connected to EM via X. VNF Alarm. VNFM is connected to EM via Ve-Vnfm-em. VNFM is connected to VIM via Vi-Vnfm. VNFM is connected to NFVO via Or-Vi. The following alarm flows are indicated: 1. Virtualized resources Alarm (VIM to VNFM), 2. VNF Alarm related to virtualized resources (VNFM to EM), 3. Virtualization-specific Alarm (VNF to VNFM), X. VNF Alarm (VNF to EM), Y. NE/VNF Alarm (EM to OSS), Z. NE Alarm (NE to EM). + +**Figure 4.1-1: 3GPP view of alarm data flows for NE/VNF** + +The alarm data flow and the alarm mapping of VNF instance application alarm and VNF instance related virtualized resource alarm are described as below: + +- Flow-1 VIM reports virtualized resources alarm data to VNFM (out of scope of the present document). +- Flow-2 VNFM sends VNF alarm data related to virtualized resources (mapped to VNF instance, correlated or not-correlated) to EM. +- Flow-3 VNF reports virtualization-specific alarm data to VNFM. +- Flow-X Via 3GPP Type 1 interface VNF instance reports VNF instance application alarm data and virtualization-specific alarm data to EM. +- Flow-Z Via 3GPP Type 1 interface non-virtualized NEs report alarm data to EM. +- Flow-Y Via 3GPP Itf-N EM sends the following: VNF instance application alarm data and virtualization-specific alarm data (received via Flow-X), VNF alarm data related to virtualized resources (received via Flow-2), non-virtualized NE alarm data (received via Flow-Z), and/or correlated VNF instance alarm data. + +EM may make the alarm correlation based on information contained in Flow-X, Flow-Z and Flow-2, using the same VNF/VNFC instance identifier based on the VNF instance alarm data related to virtualized resource and VNF instance application alarm data. EM may report the correlated VNF instance alarm data to NM. + +NM may make the alarm correlation based on information contained in Flow-X, Flow-Y, Flow-Z and Flow-2, using the same VNF/VNFC instance identifier based on the VNF instance alarm data related to virtualized resource and VNF instance application alarm data. + +The procedures listed in clause 4, as some of all the possibilities, are not exhaustive. + +## 4.2 NE alarm correlation in the context of NFV + +### 4.2.1 NE alarm correlation made by EM in the context of NFV + +When a new failure occurs from the virtualized resource and it impacts the corresponding NE application, EM can make the alarm correlation based on the virtualized resource failure report sent from VNFM and VNF application alarms. + +The figure 4.2.1-1 illustrates the procedure of EM makes NE alarms correlation in a mobile network that includes virtualized network functions. + +Error! No +text of specified style in + +7 + +Error! No text of specified style in + +![Sequence diagram showing the procedure of NE alarm correlation made by EM in the context of NFV. Lifelines: NM, EM, VNFM, NFVO, VIM, NE/VNF. The process involves: 1. A new failure occurs from the virtualized resource and it impacts corresponding NE application. 2. VNFM received virtualized resource alarms as described in ETSI NFV ISG. 3. VNFM sends a Notify message to EM. 4. NE/VNF sends VNF application alarms to EM. 5. EM correlates the VNF instance related to virtualized resource with VNF application alarms. 6. EM sends a notifyNewAlarm message to NM.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` +sequenceDiagram + participant NM + participant EM + participant VNFM + participant NFVO + participant VIM + participant NE/VNF + + Note right of NE/VNF: 1. A new failure occurs from the virtualized resource and it impacts corresponding NE application + Note right of VNFM: 2. VNFM received virtualized resource alarms as described in ETSI NFV ISG + VNFM->>EM: 3.Notify + NE/VNF->>EM: 4.Sends VNF application alarms + Note left of EM: 5.Correlates the VNF instance related to virtualized resource with VNF application alarms + EM->>NM: 6.notifyNewAlarm +``` + +Sequence diagram showing the procedure of NE alarm correlation made by EM in the context of NFV. Lifelines: NM, EM, VNFM, NFVO, VIM, NE/VNF. The process involves: 1. A new failure occurs from the virtualized resource and it impacts corresponding NE application. 2. VNFM received virtualized resource alarms as described in ETSI NFV ISG. 3. VNFM sends a Notify message to EM. 4. NE/VNF sends VNF application alarms to EM. 5. EM correlates the VNF instance related to virtualized resource with VNF application alarms. 6. EM sends a notifyNewAlarm message to NM. + +**Figure 4.2.1-1: Procedure of NE alarm correlation made by EM in the context of NFV** + +- 1) A new failure occurs from the virtualized resource and it impacts the corresponding NE application. +- 2) VNFM received virtualized resource alarms as described in ETSI NFV ISG. +- 3) VNFM sends VNF instance alarms related to virtualized resource to EM. The VNF and/or VNFC alarms related to virtualized resource include AlarmId, affected VNF identifier, affected VNFC identifiers, and FaultDetails which provides additional information about the virtualized resource fault, for example the resource identifier which causes the fault (e.g. VM identifier, vNIC identifier or vPORT identifier). The Alarm information element see clause 9.3.4 of [3]. +- 4) NE/VNF sends VNF application alarms to EM through proprietary interface, the corresponding VNF instance identifier and/or VNFC identifier should be included. + +NOTE: There is no sequence restriction on EM receives VNF instance alarms related virtualized resource and EM receives VNF application alarms. + +- 5) EM correlates the received VNF instance alarms related to virtualized resource with the received VNF application alarms. +- 6) EM sends the correlated alarm information to NM over Itf-N. The alarm information that carries correlated alarm information is specified in TS 32.111-2 [2]. + +### 4.2.2 NE alarm correlation made by NM in the context of NFV + +When a new failure occurred from the virtualized resource and it impacts corresponding NE application, NM can make the alarm correlation based on the virtualized resource failure report sent from VNFM and VNF application alarms. + +The figure 4.2.2-1 illustrates the procedure of NM makes NE alarms correlation in a mobile network that includes virtualized network functions. + +![Sequence diagram showing the procedure of NE alarm correlation made by NM in the context of NFV. Lifelines: NM, EM, VNFM, NFVO, VIM, NE/VNF. The process involves a failure in NE/VNF, alarm reception by VNFM, notification to EM, and subsequent alarm correlation by NM.](35a7554182eb055209552843f341a1ae_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + participant NFVO + participant VIM + participant NE/VNF + + Note right of NE/VNF: 1. A new failure occurs from the virtualized resource and it impacts corresponding NE application + Note right of VNFM: 2.VNFM received virtualized resource alarms as described in ETSI NFV ISG + VNFM->>EM: 3.Notify + EM->>NM: 4.notifyNewAlarm + NE/VNF->>EM: 5.Sends VNF application alarms + EM->>NM: 6.notifyNewAlarm + Note left of NM: 7.Correlates the VNF instance related to virtualized resource with VNF application alarms + +``` + +Sequence diagram showing the procedure of NE alarm correlation made by NM in the context of NFV. Lifelines: NM, EM, VNFM, NFVO, VIM, NE/VNF. The process involves a failure in NE/VNF, alarm reception by VNFM, notification to EM, and subsequent alarm correlation by NM. + +**Figure 4.2.2-1: Procedure of NE alarm correlation made by NM in the context of NFV** + +- 1) A new failure occurs from the virtualized resource and it impacts corresponding NE application. + - 2) VNFM receives virtualized resource alarms as described in [3]. + - 3) VNFM sends VNF instance alarms related to virtualized resource to EM. The VNF and/or VNFC alarms related to virtualized resource include AlarmId, affected VNF identifier, affected VNFC identifiers, and FaultDetails which provides additional information about the virtualized resource fault, for example the resource identifier which causes the fault (e.g. VM identifier, vNIC identifier or vPORT identifier). The Alarm information element see clause 9.3.4 of [3]. + - 4) EM sends VNF instance alarms related to virtualized resource to NM. + - 5) NE/VNF sends VNF application alarms to EM through proprietary interface, the corresponding VNF instance identifier and/or VNFC identifier should be included. + - 6) EM sends VNF application failure report of a NE to NM over Itf-N. The information in the failure report sees alarm information in TS 32.111-2 [2]. +- NOTE: There is no sequence restriction on EM receives VNF instance alarms related virtualized resource and NM receives VNF application failure report. +- 7) Based on the VNF instance alarms related to virtualized resource sent from VNFM and VNF application failure report, NM makes the alarm correlation. + +## 4.3 Virtualization-specific aspect failure detection and notification + +### 4.3.1 Virtualization-specific aspect failure detection and notification by VNFM + +The figure 4.3.1-1 illustrates the procedure of notifying the EM about a virtualization-specific failure of a virtualized network function when virtualization-specific aspect failure detection and notification by VNFM. + +![Sequence diagram illustrating the procedure of virtualization-specific aspect failure detection and notification by VNFM. The diagram shows three lifelines: EM, VNFM, and NE/VNF. The sequence of messages is: 1. EM sends a SubscribeRequest of VNF-related virtualization fault reports to VNFM. 2. NE/VNF's virtualization-specific component detects the failure. 3. NE/VNF sends a virtualization-specific alarm notification to VNFM. 4. VNFM creates a VNF virtualization-related fault report (shown in a dashed box). 5. VNFM sends a Notify message to EM.](dbe553cf16dd14073b89a8263a428664_img.jpg) + +``` +sequenceDiagram + participant EM + participant VNFM + participant NE/VNF + Note right of NE/VNF: 2.VNF virtualization-specific component detects the virtualization-specific failure + EM->>VNFM: 1.SubscribeRequest of VNF-related virtualization fault reports + NE/VNF->>VNFM: 3.Virtualization-specific alarm notification + Note right of VNFM: 4.VNFM creates VNF virtualization-related fault report + VNFM->>EM: 5.Notify +``` + +Sequence diagram illustrating the procedure of virtualization-specific aspect failure detection and notification by VNFM. The diagram shows three lifelines: EM, VNFM, and NE/VNF. The sequence of messages is: 1. EM sends a SubscribeRequest of VNF-related virtualization fault reports to VNFM. 2. NE/VNF's virtualization-specific component detects the failure. 3. NE/VNF sends a virtualization-specific alarm notification to VNFM. 4. VNFM creates a VNF virtualization-related fault report (shown in a dashed box). 5. VNFM sends a Notify message to EM. + +**Figure 4.3.1-1: Procedure of virtualization-specific aspect failure detection and notification by VNFM** + +- 1) EM subscribes to VNF-related virtualization fault reports. +- 2) A new virtualization-specific failure occurs and is detected by VNF virtualization-specific component. +- 3) VNF sends virtualization-specific fault notification to VNFM. +- 4) VNFM creates VNF virtualization-related fault report as described in ETSI NFV ISG. +- 5) VNFM sends VNF instance alarms generated due to changes in the state of virtualized resources used by the VNFs and their constituent VNFC instances to EM. The VNF and/or VNFC alarms related to virtualized resources include AlarmId, affected VNF identifier, affected VNFC identifiers, and FaultDetails which provides additional information about the fault, for example the resource identifier which causes the fault (e.g. VM identifier, vNIC identifier or vPORT identifier). The Alarm information element see clause 9.3.4 of [3]. + +### 4.3.2 Virtualization-specific aspect failure detection and notification by EM + +The figure 4.3.2-1 illustrates the procedure of notifying the EM about a virtualization-specific failure of a virtualized network function. + +![Sequence diagram showing virtualization-specific aspect failure detection and notification by EM. Lifelines: EM and NE/VNF. Step 1: VNF virtualization-specific component detects failures. Step 2: Sends virtualization-specific fault notification to EM.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` +sequenceDiagram + participant NE/VNF + participant EM + Note right of NE/VNF: 1.VNF virtualization-specific component detects the virtualization-specific failures + NE/VNF->>EM: 2.Sends virtualization-specific fault notification +``` + +Sequence diagram showing virtualization-specific aspect failure detection and notification by EM. Lifelines: EM and NE/VNF. Step 1: VNF virtualization-specific component detects failures. Step 2: Sends virtualization-specific fault notification to EM. + +**Figure 4.3.2-1: Procedure of virtualization-specific aspect failure detection and notification by EM** + +- 1) A new virtualization-specific failure occurs and is detected by VNF virtualization-specific component. +- 2) VNF sends virtualization-specific fault notification to EM through proprietary interfaces, the corresponding VNF instance identifier and/or VNFC identifier should be included. + +## 4.4 VNF Healing with operation request to VNFM by EM through Ve-Vnfm-em + +![Sequence diagram showing VNF Healing procedure. Lifelines: EM, VNFM, NFVO, VIM. Step 1: EM determines to initiate healing. Step 2: HealVnfRequest to VNFM. Step 3: HealVnfResponse from VNFM. Step 4: Notify from VNFM to EM. Step 5: Heal VNF (grouped interaction between VNFM, NFVO, VIM). Step 6: Notify from VNFM to EM.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +``` +sequenceDiagram + participant EM + participant VNFM + participant NFVO + participant VIM + Note left of EM: 1. EM determines to initiate a healing procedure to recover the faulty virtualization-specific aspects of the VNF. + EM->>VNFM: 2. HealVnfRequest + VNFM-->>EM: 3. HealVnfResponse + VNFM->>EM: 4.Notify + Note right of VNFM: 5. Heal VNF + Note right of VNFM: 6.Notify +``` + +Sequence diagram showing VNF Healing procedure. Lifelines: EM, VNFM, NFVO, VIM. Step 1: EM determines to initiate healing. Step 2: HealVnfRequest to VNFM. Step 3: HealVnfResponse from VNFM. Step 4: Notify from VNFM to EM. Step 5: Heal VNF (grouped interaction between VNFM, NFVO, VIM). Step 6: Notify from VNFM to EM. + +**Figure 4.4-1: Procedure of VNF Healing through operation request to VNFM by EM** + +- 1) EM determines to initiate a healing procedure to recover the faulty virtualization-specific aspects of the VNF. + +- 2) EM sends to VNFM a *HealVnfRequest* with input parameters `vnfInstanceId`, `vnfcInstanceId`, `cause`, `additionalParam`, and `healScript` to heal the VNF instance (see clause 7.2.10.2 of [3]). +- 3) VNFM sends to EM a *HealVnfResponse* acknowledging the request with parameter `lifecycleOperationOccurrenceId` providing the identifier of the VNF lifecycle operation occurrence (see clause 7.2.10.3 of [3]). +- 4) VNFM sends to EM a *Notify* (see clause 7.3.3 of [3]) carrying a `VnfLifecycleChangeNotification` information element with attributes `vnfInstanceId`, `lifecycleOperationOccurrenceId`, `operation = "HealVnf"`, and `status = "start"` to indicate the start of the VNF healing execution (see clause 9.5.2.3 [3]). +- 5) VNFM executes the healing, see clause 7.2.10 of [3]. +- 6) VNFM sends to EM a *Notify* (see clause 7.3.3 [3]) carrying a `VnfLifecycleChangeNotification` information element, with attributes `vnfInstanceId`, `lifecycleOperationOccurrenceId`, `operation = "HealVnf"`, `notificationType = "result"` to indicate the end and the result of the VNF healing execution. Depending on the result, additional parameters `affectedVnfc`, `affectedVirtualLink`, and `affectedVirtualStorage` provide information about the VNFC, VL and virtualised storage resources affected during the lifecycle operation (see clauses 9.5.2.3 of [3]). + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | SA#80 | SP-180417 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28517/raw.md b/marked/Rel-16/28_series/28517/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4895e0b3809282c988e68996f4ed765be0ef6d3d --- /dev/null +++ b/marked/Rel-16/28_series/28517/raw.md @@ -0,0 +1,246 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 General descriptions..... 5 +- 5 Information model definition ..... 6 + - 5.1 Itf-N..... 6 + - 5.2 Os-Ma-nfvo ..... 6 + - 5.3 Ve-Vnfm-em ..... 6 + - 5.4 Ve-Vnfm-vnf..... 6 + - 5.5 Mapping rule for alarm information elements ..... 6 + - 5.5.1 For construction of notifyNewAlarm ..... 6 + - 5.5.2 For construction of notifyClearedAlarm ..... 7 + - 5.5.3 For construction of notifyChangedAlarm ..... 8 + - 5.5.4 For construction of notifyAckStateChangedAlarm..... 8 +- 6 Interface definition ..... 9 + - 6.1 Itf-N..... 9 + - 6.2 Ve-Vnfm-em ..... 9 +- Annex A (informative): Change history..... 10 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 28.515 "Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". + +TS 28.516 "Fault Management (FM) for mobile networks that include virtualized network functions; Procedures". + +**TS 28.517 "Fault Management (FM) for mobile networks that include virtualized network functions; stage 2".** + +TS 28.518 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 3". + +# --- 1 Scope + +The present document is Fault Management stage 2 specification for mobile networks that include virtualized network functions which can be part of EPC or IMS. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP); Information Service (IS)". +- [3] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [4] 3GPP TS 28.515: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". +- [5] ETSI GS NFV-IFA 008 (V2.1.1): "Network Functions Virtualisation (NFV); Management and Orchestration; Ve-Vnfm reference point – Interface and Information Model Specification". +- [6] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [6] 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] or in 3GPP TS 28.500 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [6] 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] or in 3GPP TS 28.500 [6]. + +# --- 4 General descriptions + +For VNF Fault Management stage 2 solution over Itf-N, the Alarm IRP IS is applicable. The overall architectural feature of Alarm IRP is specified in TS 32.111-2 [2]. The Alarm IRP IS defines the semantics of alarms and the interactions visible across the reference point in a protocol neutral way. It defines the semantics of the operations and notifications visible in the Alarm IRP. It does not define the syntax or encoding of the operations, notifications and their parameters. For the purpose of notification, Notification IRP [3] is needed. + +# --- 5 Information model definition + +## 5.1 Itf-N + +For Itf-N VNF alarm management, the IOCs defined by AlarmIRP which is specified in clause 5 of 3GPP TS 32.111-2 [2] shall be used. + +## 5.2 Os-Ma-nfvo + +None. + +## 5.3 Ve-Vnfm-em + +For Ve-Vnfm-em alarm management, the information elements and notifications which are specified in subclause 9.3 of IFA 008 [5] for VNF alarm management shall be used. + +## 5.4 Ve-Vnfm-vnf + +None. + +## 5.5 Mapping rule for alarm information elements + +### 5.5.1 For construction of notifyNewAlarm + +The following table shows the rule on how to construct the various attributes of notifyNewAlarm (see clause 6.8.1 of TS 32.111-2 [2]). + +The first column shows the notifyNewAlarm notification attributes. + +The second column shows the "Attributes of the Alarm information element" (see clause 9.3.4.2 of [5]) used by AlarmNotification (see clause 9.3.2 of [5]) produced by VNFM. + +**Table 5.5.1: Mapping rule for notifyNewAlarm** + +| <b>NotifyNewAlarm attributes of TS 32.111-2 [2]</b> | <b>Attributes of Alarm information elements in AlarmNotification of [5]</b> | <b>Notes</b> | +|-----------------------------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| objectClass | | This and the next 3GPP defined attribute are used for the DN of an MOI (whose attribute vnflncIdList contains one vnflncId). | +| objectInstance | | See above | +| notificationId | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| eventTime | eventTime | | +| systemDN | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| notificationType | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| probableCause | probableCause | | +| perceivedSeverity | perceivedSeverity | | +| rootCauseIndicator | isRootCause | | +| alarmType | faultType | | +| specificProblem | faultDetails | | +| correlatedNotifications | correlatedAlarmId | | +| backedUpStatus | | Not used | +| backUpObject | | Not used | +| trendIndication | | Not used | +| thresholdInfo | | Not used | +| stateChangeDefinition | | Not used | +| monitoredAttributes | | Not used | +| proposedRepairActions | | Not used | +| additionalText | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| additionalInformation | managedObjectId, vnfcId | This is a list of two elements (encoded as strings) separated by a semicolon. The first element is a string "vnfcId:abc" where 'abc' is managedObjectId (of second column). The second element is a string "vnfcId:xyz" where xyz is the vnfcId (of second column). | +| alarmId | alarmId | | + +### 5.5.2 For construction of notifyClearedAlarm + +The following table shows the rule on how to construct the various attributes of notifyClearedAlarm (see clause 6.8.3 of TS 32.111-2 [2]). + +The first column shows the notifyClearedAlarm notification attributes. + +The second column shows the "Attributes of the AlarmClearedNotification (see clause 9.3.3.3 of [5]) produced by VNFM. + +**Table 5.5.2: Mapping rule for notifyClearedAlarm** + +| <b>NotifyClearedAlarm attributes of TS 32.111-2 [2]</b> | <b>Attributes of Alarm information elements in AlarmNotification of [5]</b> | <b>Notes</b> | +|---------------------------------------------------------|-----------------------------------------------------------------------------|-----------------------------------------------------| +| objectClass | | See Notes of Table 5.5.1 | +| objectInstance | | See Notes of Table 5.5.1 | +| notificationId | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| eventTime | alarmClearedTime | | +| systemDN | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| notificationType | | See entry in Table 6.8.3.2 of TS 32.111-2 [2] | +| probableCause | | Use the probableCause of the related notifyNewAlarm | +| perceivedSeverity | | Use the value 'cleared'. | +| alarmType | | Use the alarmType of the related notifyNewAlarm. | +| correlated Notifications | | See entry in Table 6.8.3.2 of TS 32.111-2 [2] | +| clearUserId | | Not used. | +| clearSystemId | | Not used | +| alarmId | alarmId | | + +### 5.5.3 For construction of notifyChangedAlarm + +The following table shows the rule on how to construct the various attributes of notifyChangedAlarm (see clause 6.8.1 of TS 32.111-2 [2]). + +The first column shows the notifyChangedAlarm notification attributes. + +The second column shows the “Attributes of the Alarm information element” (see clause 9.3.4.2 of [5]) used by AlarmNotification (see clause 9.3.2 of [5]) produced by VNFM. + +**Table 5.5.3: Mapping rule for notifyChangedAlarm** + +| <b>NotifyChangedAlarm attributes of TS 32.111-2 [2]</b> | <b>Attributes of Alarm information elements in AlarmNotification of [5]</b> | <b>Notes</b> | +|---------------------------------------------------------|-----------------------------------------------------------------------------|-----------------------------------------------| +| objectClass | | See Notes of Table 5.5.1 | +| objectInstance | | See Notes of Table 5.5.1 | +| notificationId | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| eventTime | alarmChangedTime | | +| systemDN | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| notificationType | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| probableCause | probableCause | | +| perceivedSeverity | perceivedSeverity | | +| alarmType | faultType | | +| alarmId | alarmId | | + +### 5.5.4 For construction of notifyAckStateChangedAlarm + +The following table shows the rule on how to construct the various attributes of notifyAckStateChangedAlarm (see clause 6.8.2 of TS 32.111-2 [2]). + +The first column shows the notifyAckStateChangedAlarm notification attributes. + +The second column shows the “Attributes of the Alarm information element” (see clause 9.3.4.2 of [5]) used by AlarmNotification (see clause 9.3.2 of [5]) produced by VNFM. + +**Table 5.5.4: Mapping rule for notifyAckStateChangedAlarm** + +| <b>NotifyAckStateChangedAlarm attributes of [3]</b> | <b>Attributes of Alarm information elements in AlarmNotification of [2]</b> | <b>Notes</b> | +|-----------------------------------------------------|-----------------------------------------------------------------------------|-----------------------------------------------| +| objectClass | | See Notes of Table 5.5.1 | +| objectInstance | | See Notes of Table 5.5.1 | +| notificationId | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| eventTime | eventTime | | +| systemDN | | See above | +| notificationType | | See entry in Table 6.8.1.2 of TS 32.111-2 [2] | +| probableCause | probableCause | | +| perceivedSeverity | perceivedSeverity | | +| alarmType | faultType | | +| alarmId | alarmId | | +| ackState | ackState | | +| ackUserId | | | +| ackSystemId | | | + +# 6 Interface definition + +## 6.1 Itf-N + +For Itf-N VNF alarm management, the operations and notifications defined by AlarmIRP which is specified in 3GPP TS 32.111-2 [2] shall be used. + +## 6.2 Ve-Vnfm-em + +For REQ-NFV\_FM\_Ve-Vnfm-em-FUN-1 specified in 3GPP TS 28.515 [4], the Notify operation specified in clause 7.5.3 of ETSI GS NFV-IFA 008 [5] shall be used. + +For REQ-NFV\_FM\_Ve-Vnfm-em-FUN-2 specified in 3GPP TS 28.515 [4], the Notify operation specified in clause 7.5.3 of ETSI GS NFV-IFA 008 [5] shall be used. + +For REQ-NFV\_FM\_Ve-Vnfm-em-FUN-3 specified in 3GPP TS 28.515 [4], the Heal VNF operation specified in clause 7.2.10 of ETSI GS NFV-IFA 008 [5] shall be used. + +For REQ-NFV\_FM\_Ve-Vnfm-em-FUN-4 specified in 3GPP TS 28.515 [4], the Subscribe operation specified in clause 7.5.2 of ETSI GS NFV-IFA 008 [5] shall be used. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------|--|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2017-06 | SA#76 | SP-170505 | 0001 | - | D | Update text in Itf-N interface clause to align with other clauses | | 14.1.0 | +| 2018-06 | SA#80 | SP-180417 | 0002 | 1 | B | Scope extension to cover RAN | | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28518/raw.md b/marked/Rel-16/28_series/28518/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..815c26221d820f3865f3c7b75efebe4c1b479916 --- /dev/null +++ b/marked/Rel-16/28_series/28518/raw.md @@ -0,0 +1,118 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 General descriptions..... 6 +- 5 Solution Set Definitions ..... 6 + - 5.1 Itf-N..... 6 + - 5.2 Ve-Vnfm-em ..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 28.515 "Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". + +TS 28.516 "Fault Management (FM) for mobile networks that include virtualized network functions; Procedures". + +TS 28.517 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 2". + +**TS 28.518 "Fault Management (FM) for mobile networks that include virtualized network functions; Stage 3".** + +# --- 1 Scope + +The present document is Fault Management stage 3 specification for mobile networks that include virtualized network functions which can be part of EPC or IMS. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.111-2 "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [3] 3GPP TS 32.111-6 "Telecommunication management; Fault Management; Part 6: Alarm Integration Reference Point (IRP): Solution Set (SS) definitions". +- [4] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [5] ETSI GS NFV-SOL 002 (V2.3.1): "Network Function Virtualisation (NFV) Release 2; Protocols and Data Models; RESTful protocols specification for the Ve-Vnfm Reference Point". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [4] 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] or in 3GPP TS 28.500 [4]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and in 3GPP TS 28.500 [4] 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] or in 3GPP TS 28.500 [4]. + +| | | +|------|-------------------------------| +| IS | Information Service | +| SOAP | Simple Object Access Protocol | +| SS | Solution Set | + +# --- 4 General descriptions + +For VNF Fault Management Stage 3 solution over Itf-N, the Alarm IRP SS is applicable. The overall description of Alarm IRP SS is specified in TS 32.111-6 [3]. The semantics of Alarm IRP SS are specified in Alarm IRP Information Service TS 32.111-2 [2]. Three solution sets are contained in [3], which are the CORBA Solution Set, the XML definitions and the SOAP Solution Set. + +For VNF Fault Management Stage 3 solution over Ve-Vnfm reference point, the corresponding RESTful solution of ETSI GS NFV-SOL 002 [5] shall be used as specified in clause 5.2. + +# --- 5 Solution Set Definitions + +## 5.1 Itf-N + +For Itf-N VNF alarm management, the following Solution Set Definitions defined by AlarmIRP which is specified in 3GPP TS 32.111-6 [3] shall be used: + +Annex A of 3GPP TS 32.111-6 [3] provides the CORBA Solution Set. + +Annex B of 3GPP TS 32.111-6 [3] provides the XML Definitions. + +Annex C of 3GPP TS 32.111-6 [3] provides the SOAP Solution Set. + +## 5.2 Ve-Vnfm-em + +For Ve-Vnfm-em VNF alarm management, the following shall be used: + +- the RESTful API URI structure and supported content formats specified in clause 4.2 of ETSI GS NFV-SOL 002 [5], and +- the RESTful API common procedures specified in clause 4.3 of ETSI GS NFV-SOL 002 [5], and +- the RESTful API common data types specified in clause 4.4 of ETSI GS NFV-SOL 002 [5], and +- the VNF FM RESTful API resource structure, methods, resources, data model and handling of errors specified in clause 7 of ETSI GS NFV-SOL 002 [5]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | SA#78 | SP-170964 | 0001 | - | F | Update the reference to ETSI GS NFV-SOL 002 | 14.1.0 | +| 2018-06 | SA#80 | SP-180417 | 0002 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28520/raw.md b/marked/Rel-16/28_series/28520/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..613c7d95b124bfa7ae25c1d212186ee33ba42143 --- /dev/null +++ b/marked/Rel-16/28_series/28520/raw.md @@ -0,0 +1,484 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Concepts and background ..... | 6 | +| 4.1 Overview ..... | 6 | +| 4.2 Performance measurement data collection methods ..... | 6 | +| 5 Business level requirements..... | 7 | +| 6 Specification level requirements..... | 7 | +| 6.1 Introduction ..... | 7 | +| 6.2 Requirements..... | 7 | +| 6.2.1 Requirements for Itf-N ..... | 7 | +| 6.2.2 Requirements for Os-Ma-nfvo ..... | 8 | +| 6.2.3 Requirements for Ve-Vnfm-em..... | 8 | +| 6.2.4 Requirements for Ve-Vnfm-vnf ..... | 9 | +| 6.3 Actor roles ..... | 9 | +| 6.4 Telecommunications resources ..... | 9 | +| 6.5 Use cases..... | 9 | +| 6.5.1 Measurement job operations..... | 9 | +| 6.5.1.1 Measurement job creation for 3GPP NF performance measurements related to VR ..... | 9 | +| 6.5.1.2 3GPP NF performance measurement related to VR job deletion..... | 10 | +| 6.5.1.3 Measurement job suspension for 3GPP NF performance measurements related to VR ..... | 10 | +| 6.5.1.4 Measurement job resumption for 3GPP NF performance measurements related to VR..... | 11 | +| 6.5.1.5 3GPP NF performance measurement related to VR job listing..... | 11 | +| 6.5.2 Threshold monitoring operations ..... | 12 | +| 6.5.2.1 Threshold creation for monitoring 3GPP NF performance measurement related to VR ..... | 12 | +| 6.5.2.2 Threshold deletion for monitoring 3GPP NF performance measurement related to VR ..... | 13 | +| 6.5.2.3 Threshold listing for monitoring VNF performance measurement related to VR..... | 13 | +| 6.5.3 Performance measurement notifications ..... | 14 | +| 6.5.3.1 3GPP NF performance measurements related to VR available notification..... | 14 | +| 6.5.3.2 Performance alarm for 3GPP NF performance measurement related to VR..... | 14 | +| 6.5.3.3 VNF performance measurements related to VR available notification ..... | 15 | +| 6.5.3.4 VNF performance measurement related to VR threshold crossing notification..... | 15 | +| 6.5.4 Subscription operations ..... | 15 | +| 6.5.4.1 EM subscribe the notification for VNF performance measurement related to VR ..... | 16 | +| 6.5.4.2 EM unsubscribe the notification for VNF performance measurement related to VR ..... | 16 | +| <b>Annex A (informative): Change history.....</b> | <b>17</b> | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +**TS 28.520: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements** + +TS 28.521: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Procedures + +TS 28.522: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 2 + +TS 28.523: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 3 + +# --- 1 Scope + +The present document (together with the relevant requirements described in [2], [3], [4], [5] and [6]) specifies the requirements applicable to Performance Management (PM) of mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements". +- [3] 3GPP TS 32.411: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Requirements". +- [4] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [5] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [6] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [7] 3GPP TS 32.426: "Telecommunication management; Performance Management (PM); Performance measurements Evolved Packet Core (EPC) network". +- [8] ETSI GS NFV-IFA 006 (V2.1.0): "Network Function Virtualisation (NFV); Management and Orchestration; Vi-Vnfm Reference Point - Interface and Information Model Specification". +- [9] 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Information Service (IS)". +- [10] ETSI GS NFV-IFA008 (V2.1.1): "Network Function Virtualization (NFV); Management and Orchestration; Ve-Vnfm Reference Point - Interface and Information Model Specification". +- [11] 3GPP TS 28.521: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Procedures". +- [12] 3GPP TS 28.522: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 2". +- [13] 3GPP TS 28.522: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [4], 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] or in 3GPP TS 28.500 [4]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [4], 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] or in 3GPP TS 28.500 [4]. + +| | | +|------|----------------------------------------| +| NF | Network Function | +| NFVI | NFV Infrastructure | +| VNFC | Virtualized Network Function Component | +| VR | Virtualized Resource | + +# --- 4 Concepts and background + +## 4.1 Overview + +The evaluation of PLMN-system behaviour will require performance data collected and recorded by VNF(s) according to a schedule established by the EM [2]. However, not all of these measurements will be required all the time, or from every VNF. Therefore, it is necessary to administer the measurements so as to determine which measurement types, on which measured resources, at which times, are to be executed (see TS 32.401 [2]). + +The essence of NFV is to migrate the execution of network functions from vertically integrated hardware to the industry standard COTS (commercial off-the-shelf) servers in the data centre. Performance measurements that are independent of the migration (e.g. handover, tracking area update ... related measurements [7]) are not impacted. Therefore, these performance measurements can be reused. + +Other performance measurement that are to measure the hardware usages (e.g. MME Processor usage [7]) are impacted by the Virtualized Resource (VR) performance measurements. + +## 4.2 Performance measurement data collection methods + +Figure 4.2-1 shows the PM data collection methods for virtualized networks. + +When it is necessary to collect the PM data (i.e. PM data related to 3GPP Network Function and 3GPP NF PM data related to VR), NM needs to create a PM collection task at EM. So EM knows the measurement types, the measured resources, the recording periods and collection times wanted (see TS 32.401 [2]). + +For PM data related to 3GPP Network Function collection, EM will request VNF(s) to collect the PM data related to 3GPP Network Function as specified by NM. + +For VNF PM data related to VR collection, EM will create a PM collection task at VNFM to collect VNF/VNFC PM data related to VR, based on the information provided by NM, so VNFM knows the measurement types, the measured resources, the recording periods, and collection times wanted. Then, VNFM will create a PM collection task at VIM, based on the information provided by EM (see clause 7.7.2 [8]). VIM will request NFVI to collect the VR PM data as specified by VNFM. + +The various PM data collected are stored in data repositories. Data stored in data repositories may be fetched by NM (or any authorized user). + +![Figure 4.2-1: PM data collection methods for virtualized networks. The diagram shows the flow of performance metric (PM) data from various network functions to a central Repository. NM (Network Manager) connects to EM (Element Manager) via Itf-N. EM contains a 'PM collection task' and a 'Repository'. EM connects to NFVO (NFV Orchestrator) via Os-Ma-nfvo. NFVO connects to VNFM (VNF Manager) via Or-Vnfm. VNFM contains a 'PM collection task' and a 'Repository'. VNFM connects to VNF #1 and VNF #2 via Ve-Vnfm-vnf. VNF #1 and VNF #2 connect to NFVI (NFV Infrastructure) via Vn-Nf. NFVI connects to VIM (Virtualized Infrastructure Manager) via Nf-Vi. VIM contains a 'PM collection task' and a 'Repository'. Arrows indicate data flow: 'VNF App. PM data' from VNFs to EM's Repository; 'VR PM data' from NFVI to VIM's Repository; and dashed arrows from EM's and VIM's Repositories to VNFM's Repository. A vertical line labeled 'Or-Vi' connects NFVO and VIM.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +Figure 4.2-1: PM data collection methods for virtualized networks. The diagram shows the flow of performance metric (PM) data from various network functions to a central Repository. NM (Network Manager) connects to EM (Element Manager) via Itf-N. EM contains a 'PM collection task' and a 'Repository'. EM connects to NFVO (NFV Orchestrator) via Os-Ma-nfvo. NFVO connects to VNFM (VNF Manager) via Or-Vnfm. VNFM contains a 'PM collection task' and a 'Repository'. VNFM connects to VNF #1 and VNF #2 via Ve-Vnfm-vnf. VNF #1 and VNF #2 connect to NFVI (NFV Infrastructure) via Vn-Nf. NFVI connects to VIM (Virtualized Infrastructure Manager) via Nf-Vi. VIM contains a 'PM collection task' and a 'Repository'. Arrows indicate data flow: 'VNF App. PM data' from VNFs to EM's Repository; 'VR PM data' from NFVI to VIM's Repository; and dashed arrows from EM's and VIM's Repositories to VNFM's Repository. A vertical line labeled 'Or-Vi' connects NFVO and VIM. + +Figure 4.2-1: PM data collection methods for virtualized networks + +# 5 Business level requirements + +None. + +# 6 Specification level requirements + +## 6.1 Introduction + +Note: The UCs/Requirements/Procedures/solutions defined in the present document, TS 28.521 [11], TS 28.522 [12] and TS 28.523 [13] are focused only on the protocol design/sequences that occur between systems and are not on the method/algorithm for mapping/processing/conversion of the performance metric types produced by VNFM/VIM to “3GPP NF performance measurements related to VR”. + +## 6.2 Requirements + +### 6.2.1 Requirements for Itf-N + +**REQ-NFV\_PM\_Itf-N-FUN-1** IRPAgent should have the capability to send 3GPP NF performance alarms related VR to IRPManager. + +**REQ-NFV\_PM\_Itf-N-FUN-2** IRPAgent should have the capability allowing IRPManager to create measurement job for collecting the 3GPP NF performance measurements related to VR. + +**REQ-NFV\_PM\_Itf-N-FUN-3** IRPAgent should have the capability to send the VNF PM data related to VR available notification to the IRPManager. + +**REQ-NFV\_PM\_Itf-N-FUN-4** IRPAgent should have the capability allowing IRPManager to create a threshold for the 3GPP NF performance measurements related to VR. + +**REQ-NFV\_PM\_Itf-N-FUN-5** IRPAgent should have the capability allowing IRPManager to delete a threshold for the 3GPP NF performance measurements related to VR. + +**REQ-NFV\_PM\_Itf-N-FUN-6** IRP Agent should have the capability allowing IRP Manager to list the detailed information of a threshold for the 3GPP NF performance measurements related to VR. + +**REQ-NFV\_PM\_Itf-N-FUN-7** IRP Agent should have the capability allowing IRP Manager to suspend a measurement job for 3GPP NF performance measurements related to VR (see 3GPP TS 32.411 [3]). + +**REQ-NFV\_PM\_Itf-N-FUN-8** IRP Agent should have the capability allowing IRP Manager to resume a measurement job for 3GPP NF performance measurements related to VR (see 3GPP TS 32.411 [3]). + +### 6.2.2 Requirements for Os-Ma-nfvo + +None. + +### 6.2.3 Requirements for Ve-Vnfm-em + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-1** The Ve-Vnfm-em reference point shall have the capability allowing VNFM to receive request to collect the VNF/VNFC performance measurement related to VR identified with the VNF/VNFC identifier (see Ve-Vnfm-em.VnfPm.01 in clause 5.2.1.6 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-2** The Ve-Vnfm-em reference point shall have the capability allowing VNFM to make the VNF/VNFC performance measurements related VR available with the VNF/VNFC identifier (see Ve-Vnfm-em.VnfPm.01 in clause 5.2.1.6 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-3** The Ve-Vnfm-em reference point shall support a capability allowing EM to subscribe for the notifications on the availability of the VNF/VNFC performance measurements related to VR (see Ve-Vnfm-em.VnfPm.05 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-4** The Ve-Vnfm-em reference point shall have the capability allowing EM to create a PM job to collect the VNF/VNFC performance measurements related to VR (see Ve-Vnfm-em.VnfPm.02 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-5** The Ve-Vnfm-em reference point shall have the capability allowing EM to delete one or more PM job(s) (see Ve-Vnfm-em.VnfPm.03 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-6** The Ve-Vnfm-em reference point shall support a capability allowing EM to subscribe for the notifications related to VNF/VNFC threshold crossing alarms (see Ve-Vnfm-em.VnfPm.09 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-7** The Ve-Vnfm-em reference point shall support a capability allowing EM to unsubscribe the notifications related to VNF/VNFC performance measurement related to VR. + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-8** The Ve-Vnfm-em reference point shall have the capability allowing EM to query the details of one or more PM job(s) (see Ve-Vnfm-em.VnfPm.05 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-9** The Ve-Vnfm-em reference point shall have the capability allowing VNFM to notify EM about the availability of VNF/VNFC performance information related to VR (see Ve-Vnfm-em.VnfPm.02 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-10** The Ve-Vnfm-em reference point shall have the capability allowing VNFM to notify EM about a threshold crossing being detected for a VNF/VNFC performance measurement related to VR (see Ve-Vnfm-em.VnfPm.08 in [10]). + +**REQ-NFV\_PM\_Ve-Vnfm-em-FUN-11** The Ve-Vnfm-em reference point shall have the capability allowing EM to create, delete, and query the thresholds on VNF/VNFC performance information related to VR (see Ve-Vnfm-em.VnfPm.07 in [10]). + +### 6.2.4 Requirements for Ve-Vnfm-vnf + +None. + +## 6.3 Actor roles + +See detailed actors and roles for each use case in clause 6.5. + +## 6.4 Telecommunications resources + +See detailed telecommunication resources for each use case in clause 6.5. + +## 6.5 Use cases + +### 6.5.1 Measurement job operations + +#### 6.5.1.1 Measurement job creation for 3GPP NF performance measurements related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to know whether the 3GPP NF performance issue (if any) is caused by resource shortage. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | | | +| <b>Begins when</b> | NM decides to create a measurement job to collect the 3GPP NF performance measurements related to VR. | | +| <b>Step 1 (M)</b> | NM sends a request to EM to create a measurement job for 3GPP NF performance measurements related to VR (see clause 7.3.1 [9]). | | +| <b>Step 2 (M)</b> | EM sends request(s) to VNFM to create the PM job(s) for VNF/VNFC performance measurements, based on the information provided by NM (see clause 7.4.2 [10]), if the measurement job requested by step 1 cannot be supported by the existing PM jobs of VNFM. | | +| <b>Step 3 (M)</b> | VNFM sends response(s) to EM with the identifier of the PM job(s) to indicate that the PM job(s) have been created successfully (see clause 7.4.2 [10]). | | +| <b>Step 4 (M)</b> | EM sends a response to NM to indicate the result of the measurement job creation (see clause 7.3.1.3 [9]). | | +| <b>Ends when (*)</b> | NM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | NM is notified that the measurement job has been created. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Itf-N-FUN-2, REQ-NFV_PM_Ve-Vnfm-em-FUN-4, REQ-NFV_PM_Ve-Vnfm-em-FUN-2 | | + +#### 6.5.1.2 3GPP NF performance measurement related to VR job deletion + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to stop a performance measurement job that was created to collect the 3GPP NF PM data related to VR. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | A performance measurement job for 3GPP NF PM data related to VR collection already exists. | | +| <b>Begins when</b> | NM decides to stop the measurement job. | | +| <b>Step 1 (M)</b> | NM sends a request to EM to stop a measurement job (see clause 7.3.2 [9]). | | +| <b>Step 2 (O)</b> | EM may send a request to VNFM to delete the corresponding PM job(s), with a PM job identifier, that were used to support the measurement job of step 1 (see clause 7.4.3 [10]).<br>It is up to EM to decide whether to delete the above-mentioned PM jobs through VNFM. | | +| <b>Step 3 (O)</b> | VNFM sends a response to EM with the identifier of the PM job being deleted (see clause 7.4.3 [10]). | | +| <b>Step 4 (M)</b> | EM sends a response to NM to indicate the result of PM job deletion (see clause 7.3.2.3 [9]). | | +| <b>Ends when (*)</b> | NM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | No PM data can be collected. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-5, REQ-NFV_PM_Ve-Vnfm-em-FUN-2 | | + +#### 6.5.1.3 Measurement job suspension for 3GPP NF performance measurements related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to suspend a measurement job that is collecting the 3GPP NF performance measurements related to VR. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | A measurement job exists for collecting the 3GPP NF performance measurements related to VR. | | +| <b>Begins when</b> | NM decides to suspend the measurement job. | | +| <b>Step 1 (M)</b> | NM sends a request to EM with the <code>jobId</code> to suspend a measurement job (see clause 7.3.3 [9]). | | +| <b>Step 2 (M)</b> | EM stops the reporting of the measurement result data for the measurement job identified by the <code>jobId</code> . | | +| <b>Step 3 (O)</b> | EM may send a request to VNFM to delete the PM job(s), identified by the <code>pmJobId</code> that were used to support the measurement job identified by the <code>jobId</code> .<br>It is up to EM to decide whether to delete the above-mentioned PM jobs through VNFM. | | +| <b>Step 4 (O)</b> | VNFM sends a response to EM with the identifier of the performance job being deleted. | | +| <b>Step 5 (M)</b> | EM sends a response to NM to indicate the result of measurement job suspension (see clause 7.3.3.3 [9]). | | +| <b>Ends when (*)</b> | NM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The measurement job is suspended. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Itf-N-FUN-7, REQ-NFV_PM_Ve-Vnfm-em-FUN-6, REQ-NFV_PM_Ve-Vnfm-em-FUN-2 | | + +#### 6.5.1.4 Measurement job resumption for 3GPP NF performance measurements related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to resume a suspended measurement job for 3GPP NF performance measurements related to VR. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | EM supports the Optional operation suspend.<br>A measurement job for 3GPP NF performance measurements related to VR has been suspended. | | +| <b>Begins when</b> | NM decides to resume the suspended measurement job. | | +| <b>Step 1 (M)</b> | NM sends a request to EM with the jobId to resume a suspended measurement job (see clause 7.3.4 [9]). | | +| <b>Step 2 (CM)</b> | If the PM jobs used to support the measurement job identified by the jobId do not exist anymore, EM sends a request to VNFM to create the PM job(s).<br>The condition of the support qualifier is: the PM jobs used to support the measurement job identified by the jobId do not exist anymore. | | +| <b>Step 3 (CM)</b> | VNFM sends a response to EM with the identifier of the PM job(s) being created.<br>The condition of the support qualifier is: step 2 has been executed. | | +| <b>Step 4 (M)</b> | EM sends a response to NM to indicate the measurement job has been resumed (see clause 7.3.4.3 [9]). | | +| <b>Ends when (*)</b> | NM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The measurement job is resumed. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Itf-N-FUN-8, REQ-NFV_PM_Ve-Vnfm-em-FUN-7, REQ-NFV_PM_Ve-Vnfm-em-FUN-2 | | + +#### 6.5.1.5 3GPP NF performance measurement related to VR job listing + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to list the information of all or a set of specified current performance measurement job. | | +| <b>Actors and Roles</b> | EM. | | +| <b>Telecom resources</b> | EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | One or more performance measurement jobs for VNF PM data related to VR collection already exist | | +| <b>Begins when</b> | EM decides to get the list of the measurement jobs. | | +| <b>Step 1 (M)</b> | EM sends a request to VNFM to list the measurement jobs with the query criteria (see clause 7.4.6 [10]). | | +| <b>Step 2 (M)</b> | VNFM sends a response to EM with the detailed information of the PM job in the list (see clause 7.4.6 [10]). | | +| <b>Ends when (*)</b> | EM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | PM job information is available. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-8 | | + +### 6.5.2 Threshold monitoring operations + +#### 6.5.2.1 Threshold creation for monitoring 3GPP NF performance measurement related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to create a threshold to monitor the 3GPP NF performance measurement related to VR that may or may not be defined in a measurement job. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | EM supports the optional PMIRPOperations_2 Interface (see clause 7.4 of 3GPP PM IRP [9]). | | +| <b>Begins when</b> | NM decides to create a threshold to monitor the 3GPP NF performance measurement related VR. | | +| <b>Step 1 (M)</b> | NM sends a request to EM to create a threshold (see clause 7.4.1 [9]) to monitor the 3GPP NF performance measurement related to VR. | | +| <b>Step 2 (O)</b> | EM sends a request to VNFM to create a threshold to monitor the VNF/VNFC performance measurement related to VR (see clause 7.4.7 [10]), if the threshold requested by step 1 cannot be supported by the existing threshold(s) of VNFM.. | | +| <b>Step 3 (O)</b> | VNFM sends a response to EM with the identifiers of the thresholds being created (see clause 7.4.7 [10]). | | +| <b>Step 4 (M)</b> | EM sends a response to NM to indicate the result of the threshold creation (see clause 7.4.1.3 [9]). | | +| <b>Ends when (*)</b> | NM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The threshold is created to monitor the 3GPP NF PM data related to VR. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-11, REQ-NFV_PM_Itf-N-FUN-4 | | + +#### 6.5.2.2 Threshold deletion for monitoring 3GPP NF performance measurement related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to delete a threshold that has been created to monitor the 3GPP NF performance measurement related to VR. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | The threshold to monitor the 3GPP NF performance measurement related to VR already exists.<br>EM supports the optional PMIRPOperations_2 Interface (see clause 7.4 of 3GPP PM IRP [9]). | | +| <b>Begins when</b> | NM decides to delete a threshold. | | +| <b>Step 1 (M)</b> | NM sends a request to EM to delete a threshold (see clause 7.4.2 [9]). | | +| <b>Step 2 (O)</b> | EM may send a request to VNFM to delete the threshold(s) that were used to support the threshold of step 1 (see clause 7.4.8 [10]).<br>It is up to EM to decide whether to delete the above-mentioned threshold(s) through VNFM. | | +| <b>Step 3 (O)</b> | VNFM sends a response to EM with the identifier of the threshold(s) being deleted (see clause 7.4.8 [10]). | | +| <b>Step 4 (M)</b> | EM sends a response to NM to indicate the result of threshold deletion (see clause 7.4.1.3 [9]). | | +| <b>Ends when (*)</b> | NM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The PM data threshold monitoring is not available to NM. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-11, REQ-NFV_PM_Itf-N-FUN-5 | | + +#### 6.5.2.3 Threshold listing for monitoring VNF performance measurement related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to list the detailed information of thresholds that are used to monitor the VNF performance measurement related to VR | | +| <b>Actors and Roles</b> | EM. | | +| <b>Telecom resources</b> | EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | EM supports the optional PMIRPOOperations_2 Interface (see clause 7.4 of 3GPP PM IRP [9]). | | +| <b>Begins when</b> | EM needs to know the detailed information of thresholds being created. | | +| <b>Step 1 (M)</b> | EM sends a request to VNFM to list the thresholds that are identified by a list of threshold identifiers(see clause 7.4.9 [10]), | | +| <b>Step 2 (M)</b> | VNFM sends a response to EM with the details of thresholds (see clause 7.4.9 [10]). | | +| <b>Ends when (*)</b> | EM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The PM threshold information is available to EM. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-11 | | + +### 6.5.3 Performance measurement notifications + +#### 6.5.3.1 3GPP NF performance measurements related to VR available notification + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable NM to be notified when the 3GPP NF performance measurement related to VR file(s) are available. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | VNFM/VIM have been set up to collect 3GPP NF performance measurement related to VR. | | +| <b>Begins when</b> | The 3GPP NF performance measurements related to VR for a VNF, are available at EM. | | +| <b>Step 1 (M)</b> | EM notifies NM the availability of the 3GPP NF performance measurements related to VR files for a particular VNF (see clause 8.1 [9]). | | +| <b>Ends when (*)</b> | NM receives the notification. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The NM is notified. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Itf-N-FUN-3 | | + +#### 6.5.3.2 Performance alarm for 3GPP NF performance measurement related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to send performance alarm to NM. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NM, EM | | +| <b>Assumptions</b> | NM is a subscriber for receiving alarm notification from EM. | | +| <b>Pre-conditions</b> | Threshold has been created to monitor the 3GPP NF performance measurement related to VR. | | +| <b>Begins when</b> | EM detects that the VNF/VNFC performance measurements related to VR has crossed the threshold. | | +| <b>Step 1 (M)</b> | EM determines to generate a performance alarm, by adding the 3GPP NF related VR performance alarm into its Alarm List, and sending a 3GPP NF related VR performance alarm to NM. | | +| <b>Ends when (*)</b> | NM receives the performance alarm. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | NM is notified. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Itf-N-FUN-1 | | + +#### 6.5.3.3 VNF performance measurements related to VR available notification + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to be notified when the 3GPP NF performance measurement related to VR file(s) are available. | | +| <b>Actors and Roles</b> | EM. | | +| <b>Telecom resources</b> | EM, VNFM, VIM | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | VNFM/VIM have been set up to collect 3GPP NF performance measurement related to VR. | | +| <b>Begins when</b> | The 3GPP NF performance measurements related to VR for a VNF, are available at VNFM. | | +| <b>Step 1 (M)</b> | VNFM notifies EM the availability of the VNF/VNFC performance measurements related to VR files for a particular VNF/VNFC identified by the object instance ID (see clause 7.4.5 [10]). | | +| <b>Ends when (*)</b> | EM receives the notification. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The EM is notified. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-9, REQ-NFV_PM_Ve-Vnfm-em-FUN-4 | | + +#### 6.5.3.4 VNF performance measurement related to VR threshold crossing notification + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to receive the threshold crossing notification of VNF performance measurement related to VR from VNFM. | | +| <b>Actors and Roles</b> | EM. | | +| <b>Telecom resources</b> | EM, VNFM, VIM | | +| <b>Assumptions</b> | EM is a subscriber for receiving threshold crossing notification from VNFM. | | +| <b>Pre-conditions</b> | Threshold has been created to monitor the VNF/VNFC performance measurement related to VR. | | +| <b>Begins when</b> | VNFM detects that the VNF/VNFC performance measurements related to VR has crossed the threshold. | | +| <b>Step 1 (M)</b> | VNFM notifies EM that a threshold has been crossed on a VNF/VNFC PM data related to VR performance measurement (see clause 7.4.5 [10]). | | +| <b>Ends when (*)</b> | EM receives the performance alarm. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | EM is notified. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-10, REQ-NFV_PM_Ve-Vnfm-em-FUN-4 | | + +### 6.5.4 Subscription operations + +#### 6.5.4.1 EM subscribe the notification for VNF performance measurement related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to subscribe the notification for the VNF performance measurement related to VR. | | +| <b>Actors and Roles</b> | EM. | | +| <b>Telecom resources</b> | EM, VNFM | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | | | +| <b>Begins when</b> | EM decides to subscribe the VNF performance measurement related to VR. | | +| <b>Step 1 (M)</b> | EM sends a request to VNFM to subscribe the VNF related VR performance measurements (see clause 7.4.4 [10]). | | +| <b>Step 2 (M)</b> | VNFM sends a response to EM with the identifiers of the subscription (see clause 7.4.4 [10]). | | +| <b>Ends when (*)</b> | EM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | EM has subscribed the notification of the VNF performance measurement related to VR. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em -FUN-3, REQ-NFV_PM_Ve-Vnfm-em -FUN-6 | | + +#### 6.5.4.2 EM unsubscribe the notification for VNF performance measurement related to VR + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable EM to unsubscribe the notification for the VNF performance measurement related to VR. | | +| <b>Actors and Roles</b> | EM. | | +| <b>Telecom resources</b> | EM, VNFM | | +| <b>Assumptions</b> | The VNF instance is in operation. | | +| <b>Pre-conditions</b> | | | +| <b>Begins when</b> | EM decides to unsubscribe the VNF performance measurement related to VR. | | +| <b>Step 1 (M)</b> | EM sends a request to VNFM with the identifier of subscription to unsubscribe the VNF performance measurement related to VR. | | +| <b>Step 2 (M)</b> | VNFM sends a response to EM with the identifiers of the un-subscription that has been unsubscribed. | | +| <b>Ends when (*)</b> | EM receives the response. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | EM has unsubscribed the notification of the VNF performance measurement related to VR. | | +| <b>Traceability (*)</b> | REQ-NFV_PM_Ve-Vnfm-em-FUN-7 | | + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | SA#80 | SP-180553 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28521/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/28_series/28521/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..85d6d3f233f22eebb8ea8aebd0e5f02bc1264773 --- /dev/null +++ b/marked/Rel-16/28_series/28521/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0737104a9b2786d0e5e6488cdeb5bebe83d1696ff1025a0084952bfeae7baa23 +size 82584 diff --git a/marked/Rel-16/28_series/28521/740442c999390734911677f01af0316d_img.jpg b/marked/Rel-16/28_series/28521/740442c999390734911677f01af0316d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a5a21d3b212a3d770698a9e005c7e29c813f706 --- /dev/null +++ b/marked/Rel-16/28_series/28521/740442c999390734911677f01af0316d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0458652880dfd6afe7491e672e49075b5fb834cddf22e31dc1fe9b6f88471f02 +size 14050 diff --git a/marked/Rel-16/28_series/28521/7a0db9703b68b3d06cdaeefc084c0006_img.jpg b/marked/Rel-16/28_series/28521/7a0db9703b68b3d06cdaeefc084c0006_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9e756a300d24f159ee6c82a2deb97a2655e19a77 --- /dev/null +++ b/marked/Rel-16/28_series/28521/7a0db9703b68b3d06cdaeefc084c0006_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ac7be658b8fc93d4e8e92b330dba0ce19321f1228bd0be051c8edb9a58acbe9 +size 11707 diff --git a/marked/Rel-16/28_series/28521/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/28_series/28521/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..abf2b5cc3d6bc75ab8b182bfaa620c90c72a91ac --- /dev/null +++ b/marked/Rel-16/28_series/28521/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:973bf45caa8ded5fe97aaecc9ef77ccaf8e69e8a09adaae72924ae9cde7b3d0d +size 101226 diff --git a/marked/Rel-16/28_series/28521/b28af4985cdef1e519e3aaf26561dcb3_img.jpg b/marked/Rel-16/28_series/28521/b28af4985cdef1e519e3aaf26561dcb3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c7c8414a958e9173d5cb12884991f840f8c27f18 --- /dev/null +++ b/marked/Rel-16/28_series/28521/b28af4985cdef1e519e3aaf26561dcb3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f29800be015a5dcd7de48c849574f008272b7a1e9fb686da0996a0091532d7d5 +size 28164 diff --git a/marked/Rel-16/28_series/28521/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/28_series/28521/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df0d5b07f470d13b87ccec5098d870e64a3714bb --- /dev/null +++ b/marked/Rel-16/28_series/28521/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:802d25c5d557f16d796db5fb8d81ad638686ea7dde58240d31eb7b29cd1b8eec +size 11867 diff --git a/marked/Rel-16/28_series/28521/e1a0d046fbe7f28f5e93a47091851747_img.jpg b/marked/Rel-16/28_series/28521/e1a0d046fbe7f28f5e93a47091851747_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa1731e5244e11266bfe4eaf0b0ff7ea118b6c27 --- /dev/null +++ b/marked/Rel-16/28_series/28521/e1a0d046fbe7f28f5e93a47091851747_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:535c41130a50d224bd76d054e6108f635117d50d5cdb4e597be0695c6c9895cd +size 12912 diff --git a/marked/Rel-16/28_series/28521/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/28_series/28521/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8788c96e9e194824905d8520828251d549546ed0 --- /dev/null +++ b/marked/Rel-16/28_series/28521/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b2f20348ab2cea768357c297dad720be18b312e6cd7bd9f6396e86f1ee50d10e +size 59482 diff --git a/marked/Rel-16/28_series/28521/raw.md b/marked/Rel-16/28_series/28521/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e46a3897423a3cf2c5a97cb3e25bfdd8b05920ad --- /dev/null +++ b/marked/Rel-16/28_series/28521/raw.md @@ -0,0 +1,381 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 5 + +2 References..... 5 + +3 Definitions and abbreviations ..... 5 + +3.1 Definitions..... 5 + +3.2 Abbreviations ..... 6 + +4 Performance Management procedures..... 6 + +4.1 Introduction ..... 6 + +4.2 Threshold creation for monitoring the 3GPP NF performance measurements related to VR ..... 6 + +4.3 VNF PM data related to VR job creation procedure..... 7 + +4.4 VNF PM data related to VR subscription procedure ..... 8 + +4.5 VNF PM data related to VR available notification procedure..... 8 + +4.6 PM job deletion for VNF/VNFC performance measurements related to VR..... 9 + +4.7 Measurement job suspension for 3GPP NF performance measurements related to VR..... 9 + +4.8 Measurement job resumption for 3GPP NF performance measurements related to VR ..... 9 + +4.9 Performance alarm notification procedure for NF performance measurements related to VR ..... 10 + +Annex A (informative): Change history..... 12 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.520: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements. +- TS 28.521: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Procedures.** +- TS 28.522: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 2. +- TS 28.523: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 3. + +# 1 Scope + +The present document specifies the Performance Management procedures for mobile networks that include virtualized network functions S. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Information Service (IS)". +- [3] ETSI GS NFV-IFA008 V2.1.1 (2016-10): "Network Function Virtualization (NFV); Management and Orchestration; Ve-Vnfm Reference Point - Interface and Information Model Specification". +- [4] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM) Notification Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.426: "Telecommunication management; Performance Management (PM); Performance measurements Evolved Packet Core (EPC) network". +- [7] 3GPP TS 28.500: "Telecommunication management; Concept, architecture and requirements for mobile networks that include virtualized network functions" + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], in 3GPP TS 28.500 [7] 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] or in 3GPP TS 28.500 [7]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], in 3GPP TS 28.500 [3] 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] or in 3GPP TS 28.500 [7]. + +# 4 Performance Management procedures + +## 4.1 Introduction + +The procedures listed in clause 4, as some of all the possibilities, are not exhaustive. + +## 4.2 Threshold creation for monitoring the 3GPP NF performance measurements related to VR + +Figure 4.2-1 depicts a procedure that describes how the 3GPP NF performance measurements related VR threshold crossing notification is generated. If the threshold is created to monitor a performance measurement directly without association with a PM job, then step 1 to 4 are not needed: + +1. NM sends a request to EM to create a measurement job (see clause 7.3.1 of [2]) to collect the 3GPP NF performance measurements related VR. The job is defined by the parameters, such as `iOCName` and `iOCInstanceList` ... etc. as listed in clause 7.3.1.2 of [2]. +2. EM sends a request with `sourceSelector`, `performanceMetric`, `performanceMetricGroup`, `collectionPeriod`, `reportingPeriod`, `reportingBoundary` (see clause 7.6.2.2 of [3]), to VNFM to create a PM job to collect VNF/VNFC PM data related to VR. +3. VNFM sends a response with `pmJobId` (see clause 7.6.2.3 of [3]) to EM to indicate the PM job that has been created. +4. EM sends a response to NM with `jobId` that is mapped from `pmJobId`, and `status = Success` (see clause 7.3.1.3 of [2]). +5. NM sends a request to EM to create thresholds (see clause 7.4.1 of [2]) that are defined by parameters, such as `iOCName`, `iOCInstanceList`, and `thresholdInfoList` (see clause 7.4.1.2 of [2]) to monitor the 3GPP NF performance measurements related VR. +6. EM sends a request to VNFM with `sourceSelector`, `performanceMetric`, `thresholdType`, `thresholdDetails` (see clause 7.6.7.2 of [3]), to create the thresholds for monitoring the measurement types specified in `sourceSelector`. +7. VNFM sends a response to EM with `thresholdId` (see clause 7.6.7.3 of [3]) to indicate the identifiers of thresholds that have been created. +8. EM sends a response to NM with `monitorId`, and `status = Success` (see clause 7.4.1.3 of [2]). +9. NM sends a request to EM to subscribe the 3GPP NF performance measurements related VR threshold crossing notification (see clause 6.3.1 of [4]). +10. EM sends a request with `filter` (see clause 7.6.4.2 of [3]) to VNFM to subscribe the VNF/VNFC performance information related VR threshold crossing notification. +11. VNFM sends a response with `subscriptionId` (see clause 7.6.4.3 of [3]) to EM to indicate the notification subscription that has been subscribed. +12. EM sends a response to NM to indicate that the 3GPP NF performance measurements related VR threshold crossing notification has been subscribed (see clause 6.3.1 of [4]). +13. VNFM sends a notification with `thresholdId`, `crossingDirection`, `objectInstanceId`, `performanceMetric`, `performanceValue` (see clause 9.7.9.3 of [3]) to EM to indicate the threshold identified by `objectInstanceId` has been crossed. +14. EM sends a notification with the object instance ID to NM to indicate that the threshold identified by object instance has been crossed. + +![Sequence diagram showing the 3GPP NF performance measurements related VR threshold crossing notification procedure. The diagram involves three lifelines: NM, EM, and VNFM. The sequence of messages is as follows: 1. NM sends a 'Create a measurement job for 3GPP NF performance measurements related to VR' to EM. 2. EM sends a 'Create a PM job for VNF/VNFC performance measurements related to VR' to VNFM. 3. VNFM sends a 'Response of PM job creation' to EM. 4. EM sends a 'Response of PM job creation' to NM. 5. NM sends a 'create a threshold for monitoring the 3GPP NF performance measurements related To VR' to EM. 6. EM sends a 'create a threshold for monitoring the VNF/VNFC performance measurements related To VR' to VNFM. 7. VNFM sends a 'Response of threshold creation' to EM. 8. EM sends a 'Response of threshold creation' to NM. 9. NM sends a 'Subscribe the threshold crossing notification of a 3GPP NF performance measurements related to VR' to EM. 10. EM sends a 'Subscribe the threshold crossing notification of a VNF/VNFC performance measurements related to VR' to VNFM. 11. VNFM sends a 'Response of notification subscription' to EM. 12. EM sends a 'Response of notification subscription' to NM. 13. VNFM sends a 'Threshold crossing notification' to EM. 14. EM sends a 'Threshold crossing notification' to NM.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + NM->>EM: 1. Create a measurement job for 3GPP NF performance measurements related to VR + EM->>VNFM: 2. Create a PM job for VNF/VNFC performance measurements related to VR + VNFM-->>EM: 3. Response of PM job creation + EM-->>NM: 4. Response of PM job creation + NM->>EM: 5. create a threshold for monitoring the 3GPP NF performance measurements related To VR + EM->>VNFM: 6. create a threshold for monitoring the VNF/VNFC performance measurements related To VR + VNFM-->>EM: 7. Response of threshold creation + EM-->>NM: 8. Response of threshold creation + NM->>EM: 9. Subscribe the threshold crossing notification of a 3GPP NF performance measurements related to VR + EM->>VNFM: 10. Subscribe the threshold crossing notification of a VNF/VNFC performance measurements related to VR + VNFM-->>EM: 11. Response of notification subscription + EM-->>NM: 12. Response of notification subscription + VNFM->>EM: 13. Threshold crossing notification + EM->>NM: 14. Threshold crossing notification + +``` + +Sequence diagram showing the 3GPP NF performance measurements related VR threshold crossing notification procedure. The diagram involves three lifelines: NM, EM, and VNFM. The sequence of messages is as follows: 1. NM sends a 'Create a measurement job for 3GPP NF performance measurements related to VR' to EM. 2. EM sends a 'Create a PM job for VNF/VNFC performance measurements related to VR' to VNFM. 3. VNFM sends a 'Response of PM job creation' to EM. 4. EM sends a 'Response of PM job creation' to NM. 5. NM sends a 'create a threshold for monitoring the 3GPP NF performance measurements related To VR' to EM. 6. EM sends a 'create a threshold for monitoring the VNF/VNFC performance measurements related To VR' to VNFM. 7. VNFM sends a 'Response of threshold creation' to EM. 8. EM sends a 'Response of threshold creation' to NM. 9. NM sends a 'Subscribe the threshold crossing notification of a 3GPP NF performance measurements related to VR' to EM. 10. EM sends a 'Subscribe the threshold crossing notification of a VNF/VNFC performance measurements related to VR' to VNFM. 11. VNFM sends a 'Response of notification subscription' to EM. 12. EM sends a 'Response of notification subscription' to NM. 13. VNFM sends a 'Threshold crossing notification' to EM. 14. EM sends a 'Threshold crossing notification' to NM. + +**Figure 4.2-1: 3GPP NF performance measurements related VR threshold crossing notification procedure** + +## 4.3 VNF PM data related to VR job creation procedure + +Figure 4.3-1 depicts a procedure that describes how VNF PM data related to VR job is created: + +- EM sends a *CreatePmJobRequest* to VNFM with the following parameters (see clause 7.6.2.2 of [3]) to create a PM job: + - *sourceSelector*: It identifies the VNF/VNFC for which the PM data is to be collected. + - *performanceMetric* or *performanceMetricGroup*: It defines the type of performance metric(s), or the group of performance metric(s). Only one of the two is present. + - *collectionPeriod*: it specifies the periodicity at which the VNFM will collect performance information. + - *reportingPeriod*: It specifies the periodicity at which the VNFM will report to the EM about performance information, + - *reportingBoundary*: It identifies a boundary after which the reporting will stop, and is optional. +- VNFM sends a *CreatePmJobResponse* to EM with *pmJobId* (see clause 7.6.2.3 of [3]) to indicate the PM job that has been created. + +![Sequence diagram showing EM sending a CreatePmJobRequest to VNFM and receiving a CreatePmJobResponse.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note left of EM: Error! No + Note right of VNFM: Error! No text of specified style in + EM->>VNFM: 1. CreatePmJobRequest + VNFM-->>EM: 2. CreatePmJobResponse + +``` + +Sequence diagram showing EM sending a CreatePmJobRequest to VNFM and receiving a CreatePmJobResponse. + +Figure 4.3-1: VNF PM data related to VR job creation procedure + +## 4.4 VNF PM data related to VR subscription procedure + +Figure 4.4-1 depicts a procedure that describes howto create a subscription to monitor VNF PM data related to VR: + +1. EM sends a *SubscribeRequest* to VNFM with *filter* (see clause 7.6.4.2 of [3]) to subscribe the VNF PM data related to VR available notification. +2. VNFM sends a *SubscribeResponse* to EM with *subscriptionId* (see clause 7.6.4.3 of [3]) to indicate the notification subscription that has been subscribed. + +![Sequence diagram showing EM sending a SubscribeRequest to VNFM and receiving a SubscribeResponse.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + EM->>VNFM: 1. SubscribeRequest + VNFM-->>EM: 2. SubscribeResponse + +``` + +Sequence diagram showing EM sending a SubscribeRequest to VNFM and receiving a SubscribeResponse. + +Figure 4.4-1: subscription for VNF PM data related to VR procedure + +## 4.5 VNF PM data related to VR available notification procedure + +Figure 4.5-1 depicts a procedure that describes how VNF PM data related to VR available notification is generated. EM has subscribed to receive the notification from VNFM. NM has subscribed to receive the notification from EM: + +1. VNFM invokes an operation called *Notify* (see clause 7.6.5 of [3]) to send a *PerformanceInformationAvailableNotification* to EM (see clause 9.7.8 of [3]) with *objectInstanceId*, the identifier of the VNF or VNFC instances (see clause 9.7.8.3 of [3]), to indicate the VNF PM data related to VR identified by *objectInstanceId* is available. +2. EM invokes a notification called *notifyFileReady* (see clause 6.5.1 of [5]) to NM with *object instance IDs* to indicate that the VNF PM data related to VR identified by *object instance ID* is available. + +![Sequence diagram showing VNFM sending a Notify to EM, and EM sending a notifyFileReady to NM.](740442c999390734911677f01af0316d_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + Note left of NM: Error! No + Note right of EM: Error! No text of specified style in + VNFM->>EM: 1. Notify + EM-->>NM: 2. notifyFileReady + +``` + +Sequence diagram showing VNFM sending a Notify to EM, and EM sending a notifyFileReady to NM. + +Figure 4.5-1: VNF PM data related to VR available notification procedure + +## 4.6 PM job deletion for VNF/VNFC performance measurements related to VR + +Figure 4.6-1 depicts a procedure PM job deletion for VNF/VNFC performance measurements related to VR. + +1. EM sends a *DeletePmJobRequest* to VNFM with the *pmJobId* (see clause 7.4.3.2 of [3]) to identify the PM jobs to be deleted. + +- VNFM sends a *DeletePmJobResponse* to EM with *deletedPmJobId* (see clause 7.4.3.3 of [3]) to identify the PM jobs that have been deleted. + +![Sequence diagram showing PM job deletion. Lifelines: EM and VNFM. Step 1: EM sends DeletePmJobRequest to VNFM. Step 2: VNFM sends DeletePmJobResponse back to EM.](7a0db9703b68b3d06cdaeefc084c0006_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note left of EM: + EM->>VNFM: 1. DeletePmJobRequest + VNFM-->>EM: 2. DeletePmJobResponse + +``` + +Sequence diagram showing PM job deletion. Lifelines: EM and VNFM. Step 1: EM sends DeletePmJobRequest to VNFM. Step 2: VNFM sends DeletePmJobResponse back to EM. + +Figure 4.6-1: PM job deletion for VNF/VNFC performance measurements related to VR + +## 4.7 Measurement job suspension for 3GPP NF performance measurements related to VR + +Figure 4.7-1 depicts a procedure on measurement job suspension for 3GPP NF performance measurements related to VR: + +- NM invokes the *suspendMeasurementJob* operation (see clause 7.3.3 of [2]) with *jobId* to request EM to suspend the measurement job for 3GPP NF performance measurements related to VR. +- EM stops the reporting of the measurement result data for the measurement job identified by the *jobId*. +- EM responses the *suspendMeasurementJob* operation (see clause 7.3.1 of [2]) to NM with the result of the measurement job suspension. + +![Sequence diagram showing measurement job suspension. Lifelines: NM and EM. Step 1: NM sends suspendMeasurementJob request to EM. Step 2: EM performs internal action 'Stop the reporting of the measurement result data for the measurement job'. Step 3: EM sends suspendMeasurementJob response back to NM.](b28af4985cdef1e519e3aaf26561dcb3_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + NM->>EM: 1. suspendMeasurementJob request + Note right of EM: 2. Stop the reporting of the measurement result data for the measurement job + EM-->>NM: 3. suspendMeasurementJob response + +``` + +Sequence diagram showing measurement job suspension. Lifelines: NM and EM. Step 1: NM sends suspendMeasurementJob request to EM. Step 2: EM performs internal action 'Stop the reporting of the measurement result data for the measurement job'. Step 3: EM sends suspendMeasurementJob response back to NM. + +Figure 4.7-1: Measurement job suspension for 3GPP NF performance measurements related to VR + +## 4.8 Measurement job resumption for 3GPP NF performance measurements related to VR + +Figure 4.8-1 depicts a procedure on measurement job resumption for 3GPP NF performance measurements related to VR: + +- NM invokes the *resumeMeasurementJob* operation (see clause 7.3.3 of [2]) with *jobId* to request EM to resume the measurement job for 3GPP NF performance measurements related to VR. +- If the PM jobs used to support the measurement job identified by the *jobId* do not exist anymore, EM requests VNFM to create the PM job(s), according to the procedure defined in clause 4.3. +- EM resumes the reporting of the measurement result data for the measurement job identified by the *jobId*. +- EM responses the *resumeMeasurementJob* operation (see clause 7.3.1 of [2]) to NM with the result of the measurement job resumption. + +![Sequence diagram for measurement job resumption. Lifelines: NM, EM, VNFM. Step 1: NM sends 'resumeMeasurementJob request' to EM. Step 2: EM sends a request to VNFM to create PM job(s) if they don't exist (enclosed in a dashed box). Step 3: EM resumes reporting measurement result data (enclosed in a solid box). Step 4: EM sends 'resumeMeasurementJob response' back to NM.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NM + participant EM + participant VNFM + NM->>EM: 1. resumeMeasurementJob request + rect rgb(255, 255, 255) + Note right of EM: 2. If the PM jobs used to support the +measurement job identified by the jobId do not +exist, EM requests VNFM to create the PM job(s) +according to the procedure defined in clause 4.3. + EM-->>VNFM: + VNFM-->>EM: + end + rect rgb(255, 255, 255) + Note right of EM: 3. Resume the reporting of the +measurement result data for the +measurement job + end + EM->>NM: 4. resumeMeasurementJob response + +``` + +Sequence diagram for measurement job resumption. Lifelines: NM, EM, VNFM. Step 1: NM sends 'resumeMeasurementJob request' to EM. Step 2: EM sends a request to VNFM to create PM job(s) if they don't exist (enclosed in a dashed box). Step 3: EM resumes reporting measurement result data (enclosed in a solid box). Step 4: EM sends 'resumeMeasurementJob response' back to NM. + +**Figure 4.8-1: Measurement job resumption for 3GPP NF performance measurements related to VR** + +## 4.9 Performance alarm notification procedure for NF performance measurements related to VR + +Figure 4.9-1 depicts a procedure that describes how EM can generate a performance alarm when threshold crossing notifications are received from VNFM. It is assumed that EM has subscribed to receive the threshold crossing notification from VNFM: + +1. VNFM sends a *ThresholdCrossedNotification* with the following parameters (see clause 9.7.9.3 of [3]) to EM to indicate the threshold that has been crossed: + - `thresholdId`: identifies the threshold which has been crossed. + - `crossingDirection`: indicates whether the threshold was crossed in upward or downward direction. + - `objectInstanceId`: identifies the VNF or VNFC instance for which the threshold has been crossed. + - `performanceMetric`: indicates the performance metric associated with the threshold. + - `performanceValue`: indicates the value of the metric that resulted in threshold crossing. +2. EM maps the `performanceValue` to the performance measurements for 3GPP NF related to VR, and determines whether or which alarm notification (i.e., `notifyNewAlarm`, `notifyChangedAlarm` or `notifyClearedAlarm` for the measurements defined in TS 32.426 [6]) should be sent to NM (see Annex B in [2]), based on the `ThresholdMonitor` created by NM (see clause 7.4.1.1 in [2]). + +Note: How EM to perform mapping depends on the definition/specification of "performance measurements for 3GPP NF related to VR" and of `performanceMetric`, which are not defined in the present specification. + +3. If an alarm needs to be generated: + - 3.1. EM saves the performance alarm to the `AlarmList`. + - 3.2.a. If the performance alarm is a new alarm, then EM sends a *notifyNewAlarm* notification to NM. + - 3.2.b. If the performance alarm is a changed alarm, then EM sends to NM either a *notifyChangedAlarm* notification, or *notifyClearedAlarm* follow by a *notifyNewAlarm* notifications if *notifyChangedAlarm* is not supported. + - 3.2.c. If the performance alarm is a cleared alarm, then EM sends a *notifyClearedAlarm* notification to NM. + +![Sequence diagram showing performance alarm notification procedure between NM, EM, and VNFM. The process starts with VNFM sending a ThresholdCrossedNotification to EM. EM then performs a mapping of the notification to a performance alarm. An 'Alt' block labeled 'Alt' with the condition '(An alarm is generated)' contains step 3.1 'Save the alarm to AlarmList'. Below this, another 'Alt' block contains three options: 3.2.a notifyNewAlarm (New alarm), 3.2.b notifyChangedAlarm (Changed alarm), and 3.2.c notifyClearedAlarm (Cleared alarm), each sending a message to NM.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` +sequenceDiagram + participant NM + participant EM + participant VNFM + Note left of NM: Error! No text of specified style in ----- + Note right of VNFM: Error! No text of specified style in ----- + Note center: 11 + VNFM->>EM: 1. Notify (ThresholdCrossedNotification) + EM->>EM: 2. Mapping of threshold crossing notification to performance alarm + alt An alarm is generated + EM->>EM: 3.1 Save the alarm to AlarmList + alt New alarm + EM-->>NM: 3.2.a notifyNewAlarm + else Changed alarm + EM-->>NM: 3.2.b notifyChangedAlarm + else Cleared alarm + EM-->>NM: 3.2.c notifyClearedAlarm + end + end +``` + +Sequence diagram showing performance alarm notification procedure between NM, EM, and VNFM. The process starts with VNFM sending a ThresholdCrossedNotification to EM. EM then performs a mapping of the notification to a performance alarm. An 'Alt' block labeled 'Alt' with the condition '(An alarm is generated)' contains step 3.1 'Save the alarm to AlarmList'. Below this, another 'Alt' block contains three options: 3.2.a notifyNewAlarm (New alarm), 3.2.b notifyChangedAlarm (Changed alarm), and 3.2.c notifyClearedAlarm (Cleared alarm), each sending a message to NM. + +Figure 4.9-1: Performance alarm notification procedure for NF performance measurements related to VR + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | | | | | Upgraded to change control version | 14.0.0 | +| 2017-06 | SA#80 | SP-180417 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28522/raw.md b/marked/Rel-16/28_series/28522/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..229ea073019b37514873553ee2d7f5e97dfe19c4 --- /dev/null +++ b/marked/Rel-16/28_series/28522/raw.md @@ -0,0 +1,148 @@ + + + + + + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 5 + +2 References..... 5 + +3 Definitions and abbreviations ..... 5 + +3.1 Definitions..... 5 + +3.2 Abbreviations ..... 5 + +4 General descriptions..... 6 + +5 Information Model Definition..... 6 + +5.1 Itf-N..... 6 + +5.2 Os-Ma-nfvo ..... 6 + +5.3 Ve-Vnfm-em ..... 6 + +5.4 Ve-Vnfm-vnf..... 6 + +6 Interface Definition ..... 6 + +6.1 Itf-N ..... 6 + +6.2 Os-Ma-nfvo ..... 6 + +6.3 Ve-Vnfm-em ..... 7 + +6.4 Ve-Vnfm-vnf..... 7 + +Annex A (informative): Change history..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.520: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements. +- TS 28.521: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Procedures. +- TS 28.522: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 2.** +- TS 28.523: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 3. + +# --- 1 Scope + +The present document is the Performance Management stage 2 specification for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Information Service (IS)". +- [3] 3GPP TS 28.520: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements". +- [4] ETSI GS NFV IFA 008 V2.1.1 (2016-10): "Network Functions Virtualisation (NFV); Management and Orchestration; Ve-Vnfm reference point – Interface and Information Model Specification". +- [5] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [6] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)" + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], in 3GPP TS 28.500 [3] 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] or in 3GPP TS 28.500 [3]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], in 3GPP TS 28.500 [3] 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] or in 3GPP TS 28.500 [3]. + +# --- 4 General descriptions + +For the stage 2 solution of Performance Management for mobile networks that include virtualized network functions over Itf-N, the PM IRP IS (TS 32.412 [2]) is applicable. For the purpose of notification, Notification IRP [6] is needed. + +# --- 5 Information Model Definition + +## 5.1 Itf-N + +For Performance Management for 3GPP Network Function over Itf-N, the IOCs defined by PM IRP specified in clause 6 of 3GPP TS 32.412 [2] are reused. + +## 5.2 Os-Ma-nfvo + +None. + +## 5.3 Ve-Vnfm-em + +For Ve-Vnfm-em Performance Management, the information elements and notifications which are specified in subclause 9.7 of ETSI GS NFV-IFA 008 [4] for VNF Performance Management shall be used. + +## 5.4 Ve-Vnfm-vnf + +None + +# --- 6 Interface Definition + +## 6.1 Itf-N + +For the stage 2 solution of Performance Management for mobile networks that include virtualized network functions over Itf-N, the operations and notifications defined by PM IRP specified in 3GPP TS 32.412 [2] are reused. + +## 6.2 Os-Ma-nfvo + +None. + +## 6.3 Ve-Vnfm-em + +For Ve-Vnfm-em performance management, the operations defined in clause 7.4 of ETSI GS NFV-IFA 008 [4] for VNF Performance Management interface shall be used, and the information elements and notifications which are specified in subclause 9.7 of ETSI GS NFV-IFA 008 [4] for VNF performance management shall be used. + +## 6.4 Ve-Vnfm-vnf + +None. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | | | | | Upgrade to change control version | 14.0.0 | +| 2017-06 | SA#80 | SP-180417 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28523/raw.md b/marked/Rel-16/28_series/28523/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6eb78aa92dbffe1aff0c825f4ae4da478e83db95 --- /dev/null +++ b/marked/Rel-16/28_series/28523/raw.md @@ -0,0 +1,111 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 General descriptions..... 5 +- 5 Interface Solution Sets ..... 6 + - 5.1 Itf-N..... 6 + - 5.2 Os-Ma-nfvo ..... 6 + - 5.3 Ve-Vnfm-em ..... 6 + - 5.4 Ve-Vnfm-vnf..... 6 +- Annex A (informative): Change history..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.520: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements +- TS 28.521: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Procedures +- TS 28.522: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 2 +- TS 28.523: Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Stage 3** + +# --- 1 Scope + +The present document is the Performance Management stage 3 specification for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Telecommunication management; Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [3] 3GPP TS 32.416: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [4] ETSI GS NFV SOL 002 (V0.0.2) (2016-05): "Network Functions Virtualisation; Protocols and Data Models; RESTful protocols specification for the Ve-Vnfm Reference Point; Release 2". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], in 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], in 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +# --- 4 General descriptions + +The stage 3 solution over Itf-N reuses the solution sets for PM IRP as specified in 3GPP TS 32.416 [3]. The stage 3 solution over Ve-Vnfm-em reuses the solutions for performance management interface as specified in ETSI GS NFV SOL 002 [4]. + +# --- 5 Interface Solution Sets + +## 5.1 Itf-N + +For the stage 3 solution of Performance Management for mobile networks that include virtualized network functions over Itf-N, the solution sets for PM IRP specified in 3GPP TS 32.416 [3] are reused. + +## 5.2 Os-Ma-nfvo + +None. + +## 5.3 Ve-Vnfm-em + +For the stage 3 solution of Performance Management for mobile networks that include virtualized network functions over Ve-Vnfm-em, the following shall be used: + +- the RESTful API resource structure and methods specified in clause 4.2 of ETSI GS NFV-SOL 002 [4], and +- the RESTful API sequence diagrams specified in clause 6.3 of ETSI GS NFV-SOL 002 [4], and +- the RESTful API resources specified in clause 6.4 of ETSI GS NFV-SOL 002 [4], and +- the RESTful API data model specified in clause 6.5 of ETSI GS NFV-SOL 002 [4]. + +## 5.4 Ve-Vnfm-vnf + +None. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170468 | | | | Presented for information and approval | 1.0.0 | +| 2017-06 | SA#76 | | | | | Upgrade to change control version | 14.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0001 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28525/raw.md b/marked/Rel-16/28_series/28525/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2c6d2ff2097a7cf5b06073f529e0253d17fc0f54 --- /dev/null +++ b/marked/Rel-16/28_series/28525/raw.md @@ -0,0 +1,1686 @@ + + + + +Error! No text +of specified + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Concepts and background ..... | 7 | +| 5 Business level requirements..... | 7 | +| 5.1 Requirements..... | 7 | +| 5.2 Actor roles ..... | 8 | +| 5.3 Telecommunications resources ..... | 8 | +| 5.4 High-level use cases..... | 9 | +| 5.4.1 Enabling/disabling the auto-scaling of the corresponding VNF instance(s) for an NE ..... | 9 | +| 5.4.2 NS scaling using VNF LCM operation (that is a part of NS LCM operation) based on PM data monitoring at NM level ..... | 9 | +| 5.4.3 Enabling/disabling the auto-scaling of the corresponding VNF instance(s) through NFVO as part of NS LCM ..... | 10 | +| 5.4.4 VNF application software update use cases ..... | 10 | +| 5.4.4.1 Introduction..... | 10 | +| 5.4.4.2 VNF application software update when application software is not part of VNF Package ..... | 10 | +| 5.4.4.3 VNF application software update when application software is part of VNF Package ..... | 11 | +| 5.4.4.3.1 VNF application software update when application software is part of VNF Package and performing synchronization with NFV-MANO by NM ..... | 11 | +| 5.4.5 Providing initial configuration data in VNF instantiation use cases ..... | 11 | +| 5.4.5.1 Introduction..... | 11 | +| 5.4.5.2 Managing EM IP address provided to instantiated VNF using MVPNP ..... | 11 | +| 5.4.5.3 Managing EM IP address provided to instantiated VNF by VNFM ..... | 14 | +| 5.4.5.3.1 Managing EM IP address provided to VNFM by EM as VNF configuration data..... | 14 | +| 5.4.5.3.2 Managing EM IP address provided to VNFM by EM as VNF instantiation parameter ..... | 15 | +| 6 Specification level requirements..... | 15 | +| 6.1 Requirements..... | 15 | +| 6.1.1 Requirements for Itf-N ..... | 15 | +| 6.1.2 Requirements for Os-Ma-nfvo ..... | 15 | +| 6.1.3 Requirements for Ve-Vnfm-em..... | 18 | +| 6.1.4 Requirements for Ve-Vnfm-vnf ..... | 18 | +| 6.2 Actor roles ..... | 19 | +| 6.3 Telecommunications resources ..... | 19 | +| 6.4 Use cases..... | 19 | +| 6.4.1 VNF Instance use cases ..... | 19 | +| 6.4.1.1 VNF identifier creation ..... | 19 | +| 6.4.1.2 VNF instantiation..... | 20 | +| 6.4.1.2.1 VNF instantiation initiated through Ve-Vnfm-em ..... | 20 | +| 6.4.1.2.2 VNF instantiation initiated through Os-Ma-nfvo..... | 20 | +| 6.4.1.3 VNF scaling ..... | 21 | +| 6.4.1.3.1 VNF instance scaling through operation request to VNFM by EM..... | 21 | +| 6.4.1.4 VNF instance termination..... | 22 | +| 6.4.1.4.1 VNF instance termination initiated through Ve-Vnfm-em ..... | 22 | +| 6.4.1.4.2 Remove VNF instance from NS through Os-Ma-nfvo ..... | 22 | +| 6.4.1.5 Notifications about VNF lifecycle changes ..... | 23 | +| 6.4.1.6 Enabling/disabling the auto-scaling of a VNF instance..... | 23 | +| 6.4.1.7 Retrieve VNF instance information from VNFM by EM..... | 24 | +| 6.4.1.8 Retrieve VNF instance information by NM through NFVO as part of the NS query ..... | 24 | +| 6.4.1.9 Modify non-application information and non-application configuration attributes of a VNF instance by NM through NFVO as part of NS update ..... | 25 | + +| | | | +|------------------------|-------------------------------------------------------------------------------------------|----| +| 6.4.2 | VNF Package use cases ..... | 25 | +| 6.4.2.1 | VNF Package on-boarding..... | 25 | +| 6.4.2.2 | VNF Package enabling ..... | 26 | +| 6.4.2.3 | VNF Package disabling ..... | 26 | +| 6.4.2.4 | VNF Package deleting ..... | 26 | +| 6.4.2.5 | Delete VNF Package operation, when in use ..... | 27 | +| 6.4.2.6 | Abort VNF Package deletion operation..... | 27 | +| 6.4.2.7 | VNF Package querying..... | 28 | +| 6.4.2.8 | Fetch VNF Package operation ..... | 28 | +| 6.4.2.9 | Fetch On-boarded VNF Package Artefacts operation ..... | 29 | +| 6.4.2.10 | Notify operation on VNF package management interface ..... | 29 | +| 6.4.2.11 | Subscribe operation at the VNF Package management interface ..... | 30 | +| 6.4.3 | NS Instance use cases..... | 31 | +| 6.4.3.1 | NS instantiation..... | 31 | +| 6.4.3.1.1 | Instantiation of a new NS ..... | 31 | +| 6.4.3.1.2 | Instantiation of a new NS with existing VNF instances and new VL instances ..... | 32 | +| 6.4.3.1.3 | Instantiation of a new NS with existing NS instances and new VL instances ..... | 32 | +| 6.4.3.2 | NS instance termination..... | 33 | +| 6.4.3.3 | NS instance querying..... | 33 | +| 6.4.3.4 | NS scaling using VNF scaling operation initiated through Os-Ma-nfvo reference point ..... | 34 | +| 6.4.3.5 | Updating an NS instance to correspond to a different NSD version ..... | 35 | +| 6.4.3.6 | Associating a different NSD version to an NS instance as part of NS update ..... | 36 | +| 6.4.3.7 | Addition of a new VL to an existing NS instance ..... | 36 | +| 6.4.3.8 | Addition of an existing VNF instance to an existing NS instance..... | 37 | +| 6.4.3.9 | Addition of a new SAP to an existing NS instance ..... | 37 | +| 6.4.3.10 | Notification regarding NS instance lifecycle changes ..... | 38 | +| 6.4.3.11 | Subscription regarding NS instance lifecycle changes ..... | 38 | +| 6.4.3.12 | Create NS Identifier..... | 39 | +| 6.4.3.13 | Delete NS instance identifier ..... | 39 | +| 6.4.3.14 | Addition of PNF to the NS instance ..... | 40 | +| 6.4.3.15 | Add an existing VNF instance with connectivity ..... | 40 | +| 6.4.3.16 | Add external connectivity to a PNF or VNF instance ..... | 40 | +| 6.4.3.17 | Add a virtual link to a NS instance ..... | 41 | +| 6.4.3.18 | Change external connectivity to a PNF or VNF instance ..... | 42 | +| 6.4.3.19 | Add VNF forwarding graph to a NS instance..... | 42 | +| 6.4.3.20 | Update VNF forwarding graph in a NS instance..... | 42 | +| 6.4.4 | NS Descriptor use cases ..... | 43 | +| 6.4.4.1 | NS Descriptor (NSD) On-boarding ..... | 43 | +| 6.4.4.2 | Enabling NS Descriptor instance..... | 44 | +| 6.4.4.3 | Disabling NS Descriptor instance..... | 44 | +| 6.4.4.4 | Query NSD operation ..... | 45 | +| 6.4.4.5 | Delete NS Descriptor operation, when in use..... | 45 | +| 6.4.4.6 | Delete NS Descriptor operation, when not in use..... | 46 | +| 6.4.4.7 | Updating NSD instance ..... | 46 | +| 6.4.4.8 | Updating NSD user defined data ..... | 47 | +| 6.4.4.9 | Subscribe to NSD change notifications ..... | 47 | +| 6.4.4.10 | Notify operation on management changes in NSDs..... | 48 | +| 6.4.5 | PNFD Use Cases ..... | 48 | +| 6.4.5.1 | Introduction..... | 48 | +| 6.4.5.2 | On-board PNFD operation..... | 48 | +| 6.4.5.3 | Create a new version of already on-boarded PNFD ..... | 49 | +| 6.4.5.4 | Update of the user defined data on PNFD ..... | 49 | +| 6.4.5.5 | Delete PNFD operation..... | 50 | +| 6.4.5.6 | Query PNFD operation ..... | 50 | +| Annex A (informative): | Change history..... | 51 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +**TS 28.525: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements.** + +TS 28.526: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Procedures. + +TS 28.527: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 2. + +TS 28.528: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 3. + +# 1 Scope + +The present document (together with the relevant requirements described in [2], [3] and [4]) specifies the requirements applicable to Lifecycle Management (LCM) for mobile networks that include virtualized network functions. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Telecommunication management; Concept, architecture and requirements for mobile networks that include virtualized network functions". +- [3] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [4] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [5] ETSI GS NFV-IFA 010 (V2.2.1) (2016-09): "Network Functions Virtualisation (NFV); Management and Orchestration; Functional Requirements Specification". +- [6] ETSI GS NFV-IFA 013 (V2.1.1) (2016-10): "Network Function Virtualisation (NFV); Management and Orchestration; Os-Ma-nfvo reference point - Interface and Information Model Specification". +- [7] 3GPP TS 28.520: "Telecommunication management; Performance Management (PM) for mobile networks that include virtualized network functions; Requirements". +- [8] ETSI GS NFV-IFA 008 (V2.1.1) (2016-10): "Network Function Virtualisation (NFV); Management and Orchestration; Ve-Vnfm reference point - Interface and Information Model Specification". +- [9] ETSI GS NFV-IFA 011 (V2.1.1) (2016-10): "Network Functions Virtualisation (NFV); Management and Orchestration; VNF Packaging Specification". +- [10] ETSI GS NFV-IFA 014 (V2.1.1) (2016-10) "Network Functions Virtualisation (NFV); Management and Orchestration; Network Service Templates Specification". +- [11] 3GPP TS 28.510: "Telecommunication management; Configuration Management (CM) for mobile networks that include virtualized network functions; Requirements". +- [12] 3GPP TS 28.515: "Telecommunication management; Fault Management (FM) for mobile networks that include virtualized network functions; Requirements". +- [13] 3GPP TS 32.501: "Telecommunication management; Self-configuration of network elements; Concepts and requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +# --- 4 Concepts and background + +3GPP mobile network management standards incorporate the Life Cycle Management (LCM) provided by the ETSI NFV defined NFVO and VNFM functional blocks, facilitating the installation, dimensioning, layer 2 and 3 interconnection, healing and recovery of 3GPP-defined network functions that are virtualized. + +Some requirements specified in TS 28.500 [2], TS 28.510 [11], TS 28.515 [12], TS 28.520 [7] and TS 28.525 specifications on telecommunication management for mobile networks that include virtualized network functions, are related to or using the LCM exposed by NFVO and VNFM functional blocks. The LCM operation requests, responses and notifications can carry parameters. In the context of the 3GPP mobile network management standards, the parameters used in the LCM operation requests, responses and notifications are not the 3GPP-defined network function parameters. + +# --- 5 Business level requirements + +## 5.1 Requirements + +**REQ-NFV\_LCM-CON-1** VNFM shall have a capability to handle subscription and un-subscription to VNF lifecycle change notifications (see requirements Vnfm.VnfLcm.001 in [5] and Ve-Vnfm-em.VnfLcm.001 in [8]). + +**REQ-NFV\_LCM-CON-2** VNFM shall have the capability to process a request for scaling a virtualized network function (see requirements Vnfm.VnfS.001, Vnfm.VnfS.002, Vnfm.VnfS.003, Vnfm.VnfS.004 in [5] and Ve-Vnfm-em.VnfLcm.001 in [8]). + +**REQ-NFV\_LCM-CON-3** VNFM shall have the capability to notify about lifecycle changes of a virtualized network function (see requirements Vnfm.VnfLcm.001 in [5], Ve-Vnfm-em.VnfLcm.002, Ve-Vnfm-em.VnfLcm.003 and Ve-Vnfm-em.VnfLcm.004 in [8]). + +**REQ-NFV\_LCM-CON-4** EM shall have a capability allowing NM to enable/disable the auto-scaling of the corresponding VNF instance(s) for an NE. + +**REQ-NFV\_LCM-CON-5** VNFM shall provide a capability allowing EM to enable/disable the auto-scaling of a specific VNF instance(s) (see requirement Ve-Vnfm-em.VnfCm.001 in [8] and clause 7.1.12 in [9]). + +**REQ-NFV\_LCM-CON-6** NFVO shall have the capability allowing NM to request instantiation of a NS (see requirements Nfvo.NsI.001 in [5] and Os-Ma-nfvo.NsLcm.001 in [6]). + +**REQ-NFV\_LCM-CON-7** NFVO shall have the capability allowing NM to request termination of a NS (see requirements Nfvo.NsT.001 in [5] and Os-Ma-nfvo.NsLcm.002 in [6]). + +**REQ-NFV\_LCM-CON-8** NFVO shall have the capability allowing NM to request querying a NS (see requirement Os-Ma-nfvo.NsLcm.003 in [6]). + +**REQ-NFV\_LCM-CON-9** NFVO shall have the capability allowing NM to request scaling of a NS (see requirements Nfvo.NsS.001, Nfvo.NsS.002 and Os-Ma-nfvo.NsLcm.004 in [6]). + +**REQ-NFV\_LCM-CON-10**NFVO shall have the capability allowing NM to request updating of a NS (see requirements Nfvo.NsU.001 and Os-Ma-nfvo.NsLcm.005 in [6]). + +**REQ-NFV\_LCM-CON-11**NFVO shall have the capability allowing NM to request healing of a NS (see requirement Os-Ma-nfvo.NsLcm.010 in [6]). + +**REQ-NFV\_LCM-CON-12**NFVO shall have the capability allowing NM to request scaling of a virtualized network function as part of NS scaling (see requirements Nfvo.NsS.003 in [5] and Os-Ma-nfvo.NsLcm.014 in [6]). + +NOTE 1: Disabling auto-scaling means VNFM is not allowed to start new auto-scaling operation to scale the corresponding VNF instance(s). + +NOTE 2: Enabling auto-scaling means VNFM is allowed to start new auto-scaling operation to scale the corresponding VNF instance(s). + +**REQ-NFV\_LCM-CON-13**NFVO shall provide a capability allowing NM to request enabling/disabling the auto-scaling of specific VNF instance(s) as part of NS updating (see requirement Os-Ma-nfvo.NsLcm.020 in [6] and clause 7.1.12 in [9]). + +**REQ-NFV\_LCM-CON-14**NM shall have the capability to synchronize with the NFVO changes performed by 3GPP management system related to configuration and information managed by NFV-MANO about NS and VNF instances. + +**REQ-NFV\_LCM-CON-15**VNF instance shall support the capability to use MvPnP (see requirements in clause 5.2 of [13]) to establish connection to its managing Element Manager without manual configuration. + +**REQ-NFV\_LCM-CON-16**The VNFM shall have a capability to allow EM to query information held by the VNFM about a VNF instance. + +**REQ-NFV\_LCM-CON-17**The NFVO shall have a capability to allow NM to query information about a VNF instance as part of NS querying (see requirement Nfvo.VnfLcm.006 in ETSI GS NFV-IFA 010 [5] and Os-Ma-nfvo.NsLcm.015 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM-CON-18**The NFVO shall have a capability to allow NM to request modifying non-application configuration attributes of a VNF instance as part of NS update (covered by requirement Os-Ma-nfvo.NsLcm.020 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM-CON-19**The NFVO shall have a capability to allow NM to request modifying non-application information about a VNF instance as part of NS update (covered by requirement Os-Ma-nfvo.NsLcm.019 in ETSI GS NFV-IFA 013 [6]). + +## 5.2 Actor roles + +See detailed actors and roles for each use case in clause 5.4. + +## 5.3 Telecommunications resources + +See detailed telecommunication resources for each use case in clause 5.4. + +## 5.4 High-level use cases + +### 5.4.1 Enabling/disabling the auto-scaling of the corresponding VNF instance(s) for an NE + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable/Disable the auto-scaling of a VNF instance(s). | | +| <b>Actors and Roles</b> | NM requests the enabling/disabling the auto-scaling of the corresponding VNF instance(s) for an NE. | | +| <b>Telecom resources</b> | EM, NM, VNFM | | +| <b>Assumptions</b> | The auto-scaling, which means automatic procedure controlled and executed by the VNFM to scale the capacity of a VNF instance, is supported by VNFM. | | +| <b>Pre-conditions</b> | | | +| <b>Begins when</b> | The operator decides to enable/disable the auto-scaling of the corresponding VNF instance(s) for an NE. | | +| <b>Step 1 (M)</b> | NM requests EM to enable/disable the auto-scaling of the corresponding VNF instance(s) for the subject NE. | | +| <b>Step 2 (M)</b> | EM requests VNFM to enable/disable the auto-scaling of the specific VNF instance(s). | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The auto-scaling of the corresponding VNF instance(s) for an NE is enabled/disabled. | | +| <b>Traceability</b> | REQ-NFV_LCM-CON-4, REQ-NFV_LCM-CON-5 | | + +### 5.4.2 NS scaling using VNF LCM operation (that is a part of NS LCM operation) based on PM data monitoring at NM level + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To execute VNF LCM operation as a part of NS LCM operation when the threshold crossing of VNF application PM data is detected. | | +| <b>Actors and Roles</b> | NM requests the VNF LCM operation as a part of NS LCM operation. NFVO executes the VNF LCM operation as a part of NS LCM operation based on the request from NM. | | +| <b>Telecom resources</b> | NM, NFVO, VNF | | +| <b>Assumptions</b> | NM is receiving VNF application specific performance measurements.<br>The VNF is a part of a NS. | | +| <b>Pre-conditions</b> | NM monitors VNF application specific PM data. | | +| <b>Begins when</b> | NM detected threshold crossing on a VNF application performance measurement. | | +| <b>Step 1 (M)</b> | NM sends the NFVO a NS scaling request including target VNF instance and type of scaling (e.g., expansion). | | +| <b>Step 2 (M)</b> | NFVO sends to NM a notification about the start of the NS scaling execution. | | +| <b>Step 3 (M)</b> | The NFVO executes the procedure to scale the NS instance. | | +| <b>Step 4 (M)</b> | NFVO sends to NM a notification about the end of the NS scaling execution. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | Threshold crossing condition of VNF application is resolved as a result of NS scaling operation. | | +| <b>Traceability</b> | REQ-NFV_LCM-CON-12 | | + +### 5.4.3 Enabling/disabling the auto-scaling of the corresponding VNF instance(s) through NFVO as part of NS LCM + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable/Disable the auto-scaling functionality of a VNF instance(s) as part of NS LCM operation. | | +| <b>Actors and Roles</b> | NM requests, as part of NS LCM, to enable/disable the auto-scaling of the corresponding VNF instance(s). | | +| <b>Telecom resources</b> | NM.<br>NFVO.<br>VNFM. | | +| <b>Assumptions</b> | The auto-scaling, which means automatic procedure controlled and executed by the VNFM to scale the capacity of a VNF instance, is supported. | | +| <b>Pre-conditions</b> | N/A | | +| <b>Begins when</b> | The operator decides to enable/disable the auto-scaling of the certain VNF instance(s). | | +| <b>Step 1 (M)</b> | NM requests NFVO, as part of NS LCM, to enable/disable the auto-scaling of the corresponding VNF instance(s). | | +| <b>Step 2 (M)</b> | NFVO (together with VNFM) enables/disables the auto-scaling of the specific VNF instance(s). | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The auto-scaling of the corresponding VNF instance(s) is enabled/disabled. | | +| <b>Traceability</b> | REQ-NFV_LCM-CON-13 | | + +### 5.4.4 VNF application software update use cases + +#### 5.4.4.1 Introduction + +There are two possibilities with regards to the relation between VNF application software and VNF Package: + +- the VNF application software is part, or +- it is not a part of the VNF package. + +The use cases in clause 5.4.4 introduce the different VNF application software update cases. + +#### 5.4.4.2 VNF application software update when application software is not part of VNF Package + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Update the VNF application software when the application software is not part of the VNF Package. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NM, EM and VNF | | +| <b>Assumptions</b> | 1) The VNF application software is not part of the VNF package.<br>2) The VNF application software update does not require a change of the VNF's underlying virtualized resources or internal VNFC(s) topology/composition. | | +| <b>Pre-conditions</b> | The new application software is available. | | +| <b>Begins when</b> | Operator decides to update the application software and instructs the NM to do so. | | +| <b>Step 1 (M)</b> | NM requests EM to update the application software. | | +| <b>Step 2 (M)</b> | EM updates the application software. | | +| <b>Step 3 (M)</b> | EM notifies NM about the completion of the application software update. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The VNF application software is updated. | | +| <b>Traceability</b> | FFS | | + +#### 5.4.4.3 VNF application software update when application software is part of VNF Package + +##### 5.4.4.3.1 VNF application software update when application software is part of VNF Package and performing synchronization with NFV-MANO by NM + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Update the VNF instance application software (software) when the software is part of the VNF Package. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | EM<br>NFV-MANO system<br>VNF | | +| <b>Assumptions</b> | 1) The software is part of the VNF package.<br>2) The software update does not require a change of the VNF's underlying virtualised resources or internal VNFC(s) topology/composition. | | +| <b>Pre-conditions</b> | The new VNF package, with the updated software, is on board on NFV-MANO.<br>See NOTE1. | | +| <b>Begins when</b> | Operator decides to update the software (with the new VNF package) and instructs the NM to do so. | | +| <b>Step 1 (M)</b> | NM requests EM to update the software. | | +| <b>Step 2 (M)</b> | EM acted to update the software. | | +| <b>Step 3 (M)</b> | EM notifies NM about the completion of the software update. | | +| <b>Step 4 (M)</b> | NM confirms the normality of 3GPP service and requests NFVO to update the VNF instance information. The updated VNF instance information would capture information of the new VNF package.<br>See NOTE2. | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The software and the VNF instance information are updated. | | +| <b>Traceability</b> | REQ-NFV_LCM-CON-14 | | + +NOTE 1: It is assumed that the package integrity is verified as part of the on-boarding process. + +NOTE 2: How NFVO updates the VNF instance information and whether there is a need for additional steps on NFV-MANO to avoid introducing any security threat or failure (e.g. run-time integrity check) is out of the scope of the present document. + +### 5.4.5 Providing initial configuration data in VNF instantiation use cases + +#### 5.4.5.1 Introduction + +There are several possibilities with regards to providing the initial configuration data (e.g. IP address of the managing EM) to the VNF in instantiation use cases. Some of the possibilities (those described in clauses 5.4.5.3.1 and 5.4.5.3.2) rely on functionalities provided by the VNFM while others (described in clause 5.4.5.2) may be considered independent from the ETSI NFV defined functional blocks. + +#### 5.4.5.2 Managing EM IP address provided to instantiated VNF using MVPNP + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable connection of newly instantiated VNF to the managing Element Manager | | +| <b>Actors and Roles</b> | VNF | | +| <b>Telecom resources</b> | IP networks: Non-Secure Operator Network, External Network, and its elements like DHCP server optionally DNS, CA/RA servers, Security Gateway(s) (each protecting one or more Secure Operator Networks);<br>Secure Operator Network and its elements such as DHCP server, DNS server, Element Manager(s) | | +| <b>Assumptions</b> | The vendor of 3GPP NE implemented as a VNF prefers to utilize the MVPnP standardized mechanisms for VNF connection to the Element Manager.<br>There may be one or more IP Autoconfiguration Services like DHCP and Router Advertisements and zero or more DNS servers. | | +| <b>Pre-conditions</b> | IP connectivity exists between the involved telecom resources.<br>The involved telecom resources are functional.<br>The relevant information is stored and available: <ul style="list-style-type: none"> <li>- Vendor Certificate at the VNF</li> <li>- Operator Certificate at the CA/RA (in case VNF connects to operator secure network via SeGW)</li> <li>- For the External Network or Non-Secure Operator Network (in case VNF connects to operator secure network via SeGW): <ul style="list-style-type: none"> <li>- (Outer) IP autoconfiguration information at the IP Autoconfiguration Service</li> <li>- FQDN of the initial OAM SeGW at the VNF and/or FQDN or IP address of the initial OAM SeGW at the IP Autoconfiguration Service</li> <li>- FQDN of the CA/RA servers at the VNF and/or FQDN or IP address of the CA/RA servers at the IP Autoconfiguration Service</li> <li>- If FQDNs need to be resolved, corresponding IP address(es) at the DNS server(s)</li> </ul> </li> <li>- For the Secure Operator Network: <ul style="list-style-type: none"> <li>- (Inner) IP autoconfiguration information at the IP Autoconfiguration Service or at the initial OAM SeGW</li> <li>- FQDN or IP address of the initial EMS at the VNF and/or DHCP Server of the Secure Operator Network.</li> <li>- If FQDNs need to be resolved, corresponding IP address(es) at the DNS server(s)</li> <li>- Configuration and software for the VNF at the EM(s)</li> </ul> </li> </ul> | | +| <b>Begins when</b> | VNFM instantiates a new VNF instance implementing 3GPP NE | | +| <b>Step 1 (M)</b> | If a VLAN ID is available, the VNF uses it. Otherwise the VNF uses the native VLAN where PnP traffic is sent and received untagged | | +| <b>Step 2 (M)</b> | The VNF acquires its IP address through stateful or stateless IP autoconfiguration. This may provide 0 or more DNS server addresses. | | +| <b>Step 3 (M)</b> | The VNF acquires the IP address of the CA/RA server. The FQDN of the CA/RA server may be pre-configured in the VNF or the FQDN or IP address of the CA/RA server may be provided by the IP Autoconfiguration Service. FQDNs are resolved through the DNS if necessary. Information provided by the IP Autoconfiguration Services shall supersede those pre-configured at the VNF. | | +| <b>Step 4 (M)</b> | The VNF performs Certificate Enrolment. | | +| <b>Step 5 (M)</b> | The VNF acquires the IP address of the OAM SeGW. The FQDN of the OAM SeGW may be pre-configured in the VNF or the FQDN or the IP address of the OAM SeGW may be provided by the IP Autoconfiguration Service. FQDNs are resolved through the DNS if necessary. | | +| <b>Step 6 (M)</b> | The VNF establishes a secure connection (tunnel) to the Security Gateway given by Step 5.<br>The VNF receives its (inner) IP autoconfiguration information (which may be the same as the outer IP address obtained in step2) and optionally the address of one or more DNS servers within the Secure Operator Network from the Configuration Parameters of IKEv2 during tunnel establishment. | | +| <b>Step 7 (M)</b> | The VNF acquires the IP address of the correct Element Manager by either, issuing a DHCP request including the VNF provider information, resolving FQDNs via DNS if necessary, or by having a pre-configured FQDN (including the VNF provider information) resolved via DNS. | | + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Step 8 (M)</b> | <p>The VNF establishes a connection to the provided EM and acquires its configuration and software if any.</p> <p>The configuration may contain an address to another EM that this specific node shall use as EM.</p> <p>The configuration may contain an address to another SeGW that should be used before connecting to the EM.</p> <p>The VNF may then</p> <ul style="list-style-type: none"> <li>- release the connection to the current EM and OAM SeGW and then restart (returning to step 1),</li> <li>- release the connection to the current EM and OAM SeGW and then return to step 6,</li> <li>- release the connection to the current EM and then repeat step 8, or</li> <li>- continue with step 9.</li> </ul> | | +| <b>Step 9 (M)</b> | <p>The VNF establishes necessary application (e.g. 3GPP signaling) layer connection(s) to the neighbor NEs using the transport (VLAN ID, IP addresses) and security parameters provided in step 8.</p> | | +| <b>Ends when</b> | <p>Ends when all mandatory steps identified above are successfully completed or when an exception occurs.</p> | | +| <b>Exceptions</b> | <p>One of the steps identified above fails.</p> | | +| <b>Post-conditions</b> | <p>One or more secure connections exist between the VNF and the Element Manager.</p> <p>The 3GPP NE (VNF instance) is being managed by EM.</p> <p>Via the connection to the Element Manager the VNF instance can receive further instructions to become operational and carry user traffic, e.g. the administrativeState is set to "unlocked".</p> | | +| <b>Traceability</b> | REQ-NFV_LCM-CON-15 | | + +#### 5.4.5.3 Managing EM IP address provided to instantiated VNF by VNFM + +##### 5.4.5.3.1 Managing EM IP address provided to VNFM by EM as VNF configuration data + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable connection of newly instantiated VNF to the managing EM | | +| <b>Actors and Roles</b> | EM | | +| <b>Telecom resources</b> | VNFM<br>VNF<br>Managing EM | | +| <b>Assumptions</b> | The vendor of 3GPP NE implemented as a VNF prefers to utilize the ETSI NFV standardized mechanisms for initial VNF configuration. | | +| <b>Pre-conditions</b> | The pre-conditions applicable to VNF instantiation requested by EM have been satisfied. | | +| <b>Begins when</b> | Operator decides to instantiate new VNF implementing 3GPP NE | | +| <b>Step 1 (M)</b> | EM requests VNFM to create a new VNF identifier (according to [8] clause 7.2.2) | | +| <b>Step 2 (M)</b> | VNFM creates a new VnfInfo object and returns the VNF instance identifier to the EM (according to [8] clause 7.2.2.4) | | +| <b>Step 3 (M)</b> | EM provides the managing EM IP address to the VNFM as a parameter of modify VNF configuration operation (according to [8] clause 7.6.2) together with VNF instance identifier received in step 2 | | +| <b>Step 4 (M)</b> | VNFM updates the VnfInfo object with configuration data (managing EM IP address) received from EM and returns the operation result to EM (according to [8] clause 7.6.2.4) | | +| <b>Step 5 (M)</b> | EM request VNFM to instantiate a new VNF and provides specific VNF instance identifier received in step 2 (according to [8] clause 7.2.3) | | +| <b>Step 6 (M)</b> | VNFM initiates the VNF instantiation and returns the operation result to EM (according to [8] clause 7.2.3.4). The VNF instance is not associated to any NS, (see NOTE in clause 7.2.3.4 in [8]). | | +| <b>Step 7 (M)</b> | VNFM provides the newly instantiated VNF with the managing EM IP address using set initial configuration operation (according to [8] clause 6.2.2, see note 1) | | +| <b>Step 8 (O)</b> | If EM is subscribed to the VNF LCM notifications (according to [8] clause 7.3.2), VNFM notifies EM about the progress of VNF instantiation (according to [8] clause 7.3.3) | | +| <b>Step 9 (M)</b> | Newly instantiated VNF connects to the managing EM | | +| <b>Ends when</b> | Managing EM is able to manage the 3GPP NE (VNF instance) | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The 3GPP NE (VNF instance which is not associated to any NS) is being managed by EM | | +| <b>Traceability</b> | | | + +NOTE 1: Step depends on the VNF behaviour that is outside of scope of 3GPP. + +##### 5.4.5.3.2 Managing EM IP address provided to VNFM by EM as VNF instantiation parameter + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Enable connection of newly instantiated VNF to the managing EM | | +| <b>Actors and Roles</b> | EM | | +| <b>Telecom resources</b> | VNFM<br>VNF<br>Managing EM | | +| <b>Assumptions</b> | The vendor of 3GPP NE implemented as a VNF prefers to utilize the ETSI NFV standardized mechanisms for initial VNF configuration. | | +| <b>Pre-conditions</b> | The pre-conditions applicable to VNF instantiation requested by EM have been satisfied. | | +| <b>Begins when</b> | Operator decides to instantiate new VNF implementing 3GPP NE | | +| <b>Step 1 (M)</b> | EM requests VNFM to create a new VNF identifier (according to [8] clause 7.2.2) | | +| <b>Step 2 (M)</b> | VNFM creates a new VnfInfo object and returns the VNF instance identifier to the EM (according to [8] clause 7.2.2.4) | | +| <b>Step 3 (M)</b> | EM request VNFM to instantiate a new VNF and provides specific VNF instance identifier received in step 2 and provides the managing EM IP address to the VNFM as additional parameter of instantiation (according to [8] clause 7.2.3) | | +| <b>Step 4 (M)</b> | VNFM maps the managing EM IP address value received as additional parameter of instantiation to the VNF configuration data (see note 1). | | +| <b>Step 5 (M)</b> | VNFM updates the VnfInfo object with configuration data (managing EM IP address) received from EM, initiates the VNF instantiation and returns the operation result to EM (according to [8] clause 7.2.3.4) | | +| <b>Step 6 (M)</b> | VNFM provides the newly instantiated VNF with the managing EM IP address using set initial configuration operation (according to [8] clause 6.2.2, see note 2) | | +| <b>Step 7 (O)</b> | If EM is subscribed to the VNF LCM notifications (according to [8] clause 7.3.2), VNFM notifies EM about the progress of VNF instantiation (according to [8] clause 7.3.3) | | +| <b>Step 8 (M)</b> | Newly instantiated VNF (but not associated to any NS, see NOTE in clause 7.2.3.4 in [8]) connects to the managing EM | | +| <b>Ends when</b> | Managing EM is able to manage the 3GPP NE (VNF instance) | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The 3GPP NE (VNF instance which is not associated to any NS) is being managed by EM | | +| <b>Traceability</b> | | | +| NOTE 1: The mechanism for mapping additional parameter of instantiation into VNF configuration data is out of scope of 3GPP. | | | +| NOTE 2: Step depends on the VNF behaviour that is outside of scope of 3GPP. | | | + +# 6 Specification level requirements + +## 6.1 Requirements + +### 6.1.1 Requirements for Itf-N + +None. + +### 6.1.2 Requirements for Os-Ma-nfvo + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-1** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS instantiation request based on on-boarded NSD and parameterization specific for an NS (see requirement Os-Ma-nfvo.NsLcm.001 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-2** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS instantiation request using existing VNF instances (see requirement Os-Ma-nfvo.NsLcm.008 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-3** The Os-Ma-nfvo reference point shall have the capability allowing NM to send VNF Package on-boarding request (see requirement Os-Ma-nfvo.VnfPkgm.001 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-4** The Os-Ma-nfvo reference point shall have the capability allowing NM to receive notification on the VNF Package on-boarding (see requirement Os-Ma-nfvo.VnfPkgm.006 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-5** The Os-Ma-nfvo reference point shall have the capability allowing NFVO to send information about VNF instances that constitute a NS (see requirements Os-Ma-nfvo.NsLcm.003 and Os-Ma-nfvo.NsLcm.015 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-6** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS termination request (see requirement Os-Ma-nfvo.NsLcm.002 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-7** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS query request (see requirement Os-Ma-nfvo.NsLcm.003 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-8** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS scaling request (see requirement Os-Ma-nfvo.NsLcm.004 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-9** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS updating request (see requirement Os-Ma-nfvo.NsLcm.005 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-10** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS healing request (see requirement Os-Ma-nfvo.NsLcm.010 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-11** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NS scaling request with scaling of VNF instances as part of NS scaling (see requirement Os-Ma-nfvo.NsLcm.014 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-12** The Os-Ma-nfvo reference point shall have the capability allowing NM to enable VNF Package (see requirement Os-Ma-nfvo.VnfPkgm.003 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-13** The Os-Ma-nfvo reference point shall have the capability allowing NM to disable VNF Package (see requirement Os-Ma-nfvo.VnfPkgm.002 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-14** The Os-Ma-nfvo reference point shall have the capability allowing NM to send NSD on-boarding request (see requirement Os-Ma-nfvo.Nsd.001 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-15** The Os-Ma-nfvo reference point shall have the capability allowing NM to receive acknowledgement on the NSD on-boarding (see requirement Os-Ma-nfvo.Nsd.001 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-16** The Os-Ma-nfvo reference point shall have the capability allowing NM to send a request with instantiating a VNF instance as part of the update of a NS (see requirement Os-Ma-nfvo.NsLcm.012 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-17** The Os-Ma-nfvo reference point shall have the capability allowing NFVO to notify the addition, deletion or modification of the VNF instance, as result of the NS lifecycle change (see requirement Os-Ma-nfvo.NsLcm.002 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-18** The Os-Ma-nfvo reference point shall have the capability allowing NM to remove an existing VNF instance from a NS instance as part of the update of a NS (see requirement Os-Ma-nfvo.NsLcm.013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-19** The Os-Ma-nfvo reference point shall have the capability allowing NM to subscribe/un-subscribe to NS instance lifecycle change notifications (see requirement Os-Ma-nfvo.NsLcm.001 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-20** The Os-Ma-nfvo reference point shall have the capability allowing NM to receive notifications regarding NS instance lifecycle changes (see requirement Os-Ma-nfvo.003 and Os-Ma-nfvo.NsLcm.001 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-21** The Os-Ma-nfvo reference point shall have the capability allowing NM to update an NSD (see requirement Os-Ma-nfvo.Nsd.004 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-22** The Os-Ma-nfvo reference point shall have the capability allowing NM to associate a different NSD version to an NS instance as part of NS update (see requirement Os-Ma-nfvo.NsLcm.025 in [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-23** The Os-Ma-nfvo reference point shall have the capability allowing NM to request the creation of a new VL instance interconnecting specific external CPs of specific VNF instances belonging to the same NS instance as part of the update of a NS. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-24** The Os-Ma-nfvo reference point shall have the capability allowing NM to request the addition of an existing VNF instance as part of the update of a NS (see requirement Os-Ma-nfvo.NsLcm.013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-25** The Os-Ma-nfvo reference point shall have the capability allowing NM to request the creation of a new SAP instance exposing specific external CP of a specific VNF instance belonging to the NS instance as part of the update of a NS. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-26** The Os-Ma-nfvo reference point shall have the capability allowing NM to request the instantiation of a new NS instance by adding existing VNF instances and new VL instances interconnecting specific external CPs of specific VNF instances. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-27** The Os-Ma-nfvo reference point shall have the capability allowing NM to request the instantiation of a new NS instance by adding existing NS instances and new VL instances interconnecting specific SAPs of specific nested NS instances. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-28** The Os-Ma-nfvo reference point shall have the capability allowing NM to create a new version of already on-boarded PNFD using Update PNFD operation (see requirement Os-Ma-nfvo.Nsd.010 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-29** The Os-Ma-nfvo reference point shall have the capability allowing NM to request creation of a NS instance identifier, and an associated instance of an NsInfo information element to enable further NS instantiation (see requirement Os-Ma-nfvo.NsLcm.021 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-30** The Os-Ma-nfvo reference point shall have the capability allowing NM to update the user defined data on PNFD using Update PNFD operation (See requirement Os-Ma-nfvo.Nsd.010 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-31** The Os-Ma-nfvo reference point shall have the capability allowing NM to delete one or more PNFDs (see requirement Os-Ma-nfvo.Nsd.011 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-32** The Os-Ma-nfvo reference point shall have the capability allowing NM to query the NFVO on certain attributes of one or more PNFDs (see requirement Os-Ma-nfvo.Nsd.012 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-33** The Os-Ma-nfvo reference point shall have the capability allowing NM to subscribe to receive notifications sent by the NFVO about changes of the NSD(s) (see requirement Os-Ma-nfvo.Nsd.013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-34** The Os-Ma-nfvo reference point shall have the capability allowing NM to receive notifications sent by the NFVO about changes of the NSD(s) (see requirements Os-Ma-nfvo.Nsd.007, Os-Ma-nfvo.Nsd.008 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-35** The Os-Ma-nfvo reference point shall have the capability allowing NM to request deletion of a NS instance identifier (See requirement Os-Ma-nfvo.NsLcm.022 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-36** The Os-Ma-nfvo reference point shall support a capability allowing NM to retrieve information about a VNF instance as part of NS querying (see requirement Os-Ma-nfvo.NsLcm.015 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-37** The Os-Ma-nfvo reference point shall support a capability allowing NM to request modifying non-application configuration attributes of a VNF instance as part of NS update (covered by requirement Os-Ma-nfvo.NsLcm.020 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-38** The Os-Ma-nfvo reference point shall support a capability allowing NM to request modifying non-application information about a VNF instance as part of NS update (covered by requirement Os-Ma-nfvo.NsLcm.019 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request to add an existing VNF instance to a NS with connectivity to other VNF instance or PNF as part of NS update. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request the addition of the external connectivity to a PNF or VNF instance as part of NS update. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request the addition of virtual link to a NS instance as part of NS update. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request to change of the external connectivity to a PNF or VNF instance as part of NS update. + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request the on-boarding of PNFD (covered by requirement Os-Ma-nfvo.Nsd.009 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request the addition of the VNFFG as part of NS update (covered by requirement Os-Ma-nfvo.NsLcm.027 in ETSI GS NFV-IFA 013 [6]). + +**REQ-NFV\_LCM\_Os-Ma-nfvo-FUN-x** The Os-Ma-nfvo reference point shall support a capability allowing NM to request the update of the VNFFG as part of NS update (covered by requirement Os-Ma-nfvo.NsLcm.027 in ETSI GS NFV-IFA 013 [6]). + +### 6.1.3 Requirements for Ve-Vnfm-em + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-1** The Ve-Vnfm-em reference point shall support a capability allowing EM to send VNF instantiation request (see requirement Ve-Vnfm-em.VnfLcm.002 in [8]). + +**NOTE:** According to [8], the new VNF instance is instantiated but not associated to any NS (see note in clause 7.2.3.4 in [8]). The note in clause 7.2.3.4 in [8] reads: "In the present document, the operation result of the VNF instantiation request by EM cannot be determined to have the same result as VNF instantiation request as part of the NS LCM update operation performed through the NFVO (see clauses 7.3.5 and 8.3.4.10 in ETSI GS NFV-IFA 013 [Error: Reference source not found]), in particular in what concerns re-using the newly VNF instance at the NFVO level and associating it to a corresponding NS." + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-2** The Ve-Vnfm-em reference point shall support a capability allowing VNFM to inform EM the result of VNF instantiation (see requirement Ve-Vnfm-em.VnfLcm.001 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-3** The Ve-Vnfm-em reference point shall support a capability allowing EM to request the scaling of a VNF instance indicating the type of VNFC to scale and the number of scaling steps (see requirement Ve-Vnfm-em.VnfLcm.001 and clause 7.2.7.2 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-4** The Ve-Vnfm-em reference point shall support a capability allowing VNFM to notify about VNF instance lifecycle changes indicating the type of lifecycle procedure, whether it is the start or the end of the procedure, and the results of lifecycle procedure with indication of errors if the procedure is not successful (see requirement Ve-Vnfm-em.VnfLcm.002 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-5** The Ve-Vnfm-em reference point shall support a capability allowing EM to subscribe/un-subscribe to VNF instance lifecycle change notifications (see clause 7.5 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-6** The Ve-Vnfm-em reference point shall support a capability allowing EM to send VNF termination request (see requirement Ve-Vnfm-em.VnfLcm.003 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-7** The Ve-Vnfm-em reference point shall support a capability allowing VNFM to inform EM the result of VNF termination (see requirement Ve-Vnfm-em.VnfLcm.002 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-8** The Ve-Vnfm-em reference point shall support a capability allowing EM to request VNFM to enable/disable the auto-scaling of a specific VNF instance(s) (see requirement Ve-Vnfm-em.VnfCm.001 in [8] and clause 7.1.12 in [9]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-9** The Ve-Vnfm-em reference point shall support a capability allowing EM to request VNFM to create the VNF identifier (see requirement Ve-Vnfm-em.VnfLcm.001 in [8]). + +**REQ-NFV\_LCM\_Ve-Vnfm-em-FUN-10** The Ve-Vnfm-em reference point shall support a capability allowing EM to retrieve from VNFM, information about a VNF instance, including VNFC instances and the configured virtual resources supporting the subject VNF instance. + +### 6.1.4 Requirements for Ve-Vnfm-vnf + +None. + +## 6.2 Actor roles + +See detailed actors and roles for each use case in clause 6.4. + +## 6.3 Telecommunications resources + +See detailed telecommunication resources for each use case in clause 6.4. + +## 6.4 Use cases + +### 6.4.1 VNF Instance use cases + +#### 6.4.1.1 VNF identifier creation + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | EM requests to create a VNF identifier. | | +| Actors and Roles | EM | | +| Telecom resources | VNFM | | +| Assumptions | N/A | | +| Pre-conditions | NFVO is running. | | +| Begins when | EM decides to request to create a VNF identifier. | | +| Step 1 (M) | EM sends a request to VNFM to create the VNF identifier (see clause 7.2.2 [8]) | | +| Step 2 (M) | VNFM returns <code>vnfInstanceId</code> to EM to indicate the creation of VNF identifier (see clause 7.2.2.3 [8]) | | +| Ends when | Ends when EM receives the <code>vnfInstanceId</code> . | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The VNF identifier is created. | | +| Traceability | REQ-NFV LCM Ve-Vnfm-em-FUN-9 | | + +#### 6.4.1.2 VNF instantiation + +##### 6.4.1.2.1 VNF instantiation initiated through Ve-Vnfm-em + +| Use Case Stage | Evolution / Specification | <<Uses>> Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Goal | Create a VNF instance based on the local needs of the EM (e.g. for VNF validation prior to deployments in production environment). | | +| Actors and Roles | EM | | +| Telecom resources | VNFM | | +| Assumptions | The association of the new VNF instance to a NS instance enabling the VNF LCM granting operations and VR management is out of scope of 3GPP. | | +| Pre-conditions | The VNF Package for the VNF instantiation is enabled and is available to the VNFM. EM is subscribed to the VNF LCM notifications (see clause 7.3.2 [8]). | | +| Begins when | EM decides to instantiate a new VNF instance. | | +| Step 1 (M) | EM requests VNFM to create a new VNF instance Identifier (see clause 7.2.2 [8]) using the VNFD Id to identify the VNF Package to be used for instantiation. | | +| Step 2 (M) | VNFM responds to EM with new VNF instance Identifier | | +| Step 3 (M) | EM requests VNFM to instantiate the new VNF (see clause 7.2.3 [8]). | | +| Step 4 (M) | VNFM responds to EM with the operation result containing the lifecycle operation occurrence Id | | +| Step 5 (M) | VNFM sends the VNF lifecycle change notification to EM indicating the start of VNF instantiation procedure (see clause 7.3.3 [8]). | | +| Step 6 (M) | VNFM sends the VNF lifecycle change notification to EM indicating the success or failure of the VNF instantiation, when the VNF instantiation procedure is completed (see clause 7.3.3 [8]). | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | A new VNF instance is instantiated but not associated to any NS (.see NOTE in clause 7.2.3.4 in [8]). | | +| Traceability | REQ-NFV_LCM_Ve-Vnfm-em-FUN-1, REQ-NFV_LCM_Ve-Vnfm-em-FUN-2. | | + +##### 6.4.1.2.2 VNF instantiation initiated through Os-Ma-nfvo + +| Use Case Stage | Evolution / Specification | <<Uses>> Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Goal | Enable NM to add a VNF instance to a NS via Os-Ma-nfvo reference point. | | +| Actors and Roles | NM | | +| Telecom resources | NM, NFVO | | +| Assumptions | N/A | | +| Pre-conditions | The VNF Package for the VNF instantiation is enabled. | | +| Begins when | NM decides to instantiate a VNF instance that is part of an NS. | | +| Step 1 (M) | NM sends a request to NFVO to instantiate a VNF instance as part of the update of a NS (see clause 7.3.3 in ETSI GS NFV-IFA 013 [6]) and the VNF parameters/values, including those captured in vendor specific name value pairs, carried by such request are only related to VNF virtualization aspects and are not VNF application specific.. | | +| Step 2 (M) | NFVO sends the NS Lifecycle Change notification to NM indicating the addition of the VNF instance (see clause 5.3.3 [6]), when the VNF instantiation procedure is completed. | | +| Ends when | Ends when NM receives the notification from NFVO indicating the VNF instance has been successfully instantiated. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | A new VNF instance is instantiated. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-16, REQ-NFV_LCM_Os-Ma-nfvo-FUN-18 | | + +#### 6.4.1.3 VNF scaling + +##### 6.4.1.3.1 VNF instance scaling through operation request to VNFM by EM + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To expand/contract a VNF instance by scaling the VNF instance through operation request to VNFM by EM, and notify about the execution of the VNF instance scaling through reference point Ve-Vnfm-em. | | +| Actors and Roles | EM detects whether a scaling execution is needed and requests the VNFM to execute the VNF scaling. | | +| Telecom resources | EM.<br>VNFM.<br>VNF | | +| Assumptions | EM is subscribed to VNF lifecycle change notifications from the VNFM.<br>See note 1. | | +| Pre-conditions | The subject VNF instance is not being scaled at the moment. VNFM does not have any auto-scaling scripts or the policy for auto-scaling is not in used or active (see note 2). | | +| Begins when | EM detected the need (e.g., triggered by MO attribute value modification from NM) to scale and have determined the scaling action (expand/contract). | | +| Step 1 (M) | EM sends the VNFM a request to scale a VNF with an indication of the type of VNF Components to scale, and value of scaling. | | +| Step 2 (M) | VNFM sends to EM a notification about the start of the VNF scaling execution. | | +| Step 3 (M) | The VNFM executes the procedure to scale the VNF instance. | | +| Step 4 (M) | VNFM sends to EM a notification about the end of the VNF scaling execution. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The VNF instance has been scaled (expansion/contraction). | | +| Traceability | REQ-NFV_LCM_Ve-Vnfm-em-FUN-3, REQ-NFV_LCM_Ve-Vnfm-em-FUN-4 | | +| NOTE 1: In the case where VNF scaling is triggered by MOI attribute value changes, the IRPManager (Operator) is aware of the MO attributes whose value changes can trigger VNF scaling actions. How the IRPManager (Operator) knows the names of the MO attributes whose value change can trigger VNF scaling is out of scope of this specification (e.g. could be stated in NRM attribute definitions or in product documentation). | | | +| NOTE 2: How 3GPP management system can determine if Pre-conditions are true is FFS. | | | + +#### 6.4.1.4 VNF instance termination + +##### 6.4.1.4.1 VNF instance termination initiated through Ve-Vnfm-em + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable EM to terminate a VNF instance which is no longer needed for testing and integration purpose. | | +| Actors and Roles | EM | | +| Telecom resources | VNFM | | +| Assumptions | The VNF instance being terminated does not participate in any NS (see note 1). | | +| Pre-conditions | The VNF instance to be terminated is no longer needed. The VNF instance has been instantiated (see NOTE in clause 7.2.3.4 in [8]) by the EM. | | +| Begins when | EM decides to terminate a VNF instance. | | +| Step 1 (M) | EM sends the request (see clause 5.2.1.1 [8]), to VNFM via Ve-Vnfm-em reference point to terminate the identified VNF instance. | | +| Step 2 (M) | VNFM sends the VNF lifecycle change notification to EM indicating the start of VNF termination procedure (see clause 5.2.1.2 [8]). | | +| Step 3 (M) | VNFM sends the VNF lifecycle change notification to EM indicating the result (e.g. success or failure) of VNF termination, when the VNF termination procedure is completed (see clause 5.2.1.2 [8]). | | +| Ends when | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The VNF instance is terminated. | | +| Traceability | REQ-NFV_LCM_Ve-Vnfm-em-FUN-6, REQ-NFV_LCM_Ve-Vnfm-em-FUN-7 | | + +NOTE 1: Participation of the VNF instance in a NS is not known to the EM/VNFM and could only be determined by the NFVO (e.g. during granting operation). Potential negative impact to the NS instance can be prevented by the granting operation. + +##### 6.4.1.4.2 Remove VNF instance from NS through Os-Ma-nfvo + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to delete a VNF instance from a NS via Os-Ma-nfvo reference point. | | +| Actors and Roles | NM | | +| Telecom resources | NM, NFVO | | +| Assumptions | N/A | | +| Pre-conditions | The VNF instance to be terminated is no longer needed, | | +| Begins when | NM decides that VNF instance is no longer needed as part of the NS. | | +| Step 1 (M) | NM sends a request to NFVO to remove a VNF instance from a NS instance (see clauses 5.3.2 [6]). | | +| Step 2 (M) | NFVO sends the NS Lifecycle Change notification to NM indicating the removal of the VNF instance (see clauses 5.3.3 [6]). | | +| Ends when | Ends when the VNF instance is removed from NS. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The VNF is removed from NS. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-17, REQ-NFV_LCM_Os-Ma-nfvo-FUN-18 | | + +#### 6.4.1.5 Notifications about VNF lifecycle changes + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To monitor by EM the lifecycle changes of one or more VNF instance(s). | | +| Actors and Roles | EM subscribes to and receives VNF lifecycle change notifications. | | +| Telecom resources | EM.<br>VNFM.<br>VNF. | | +| Assumptions | | | +| Pre-conditions | VNFM is running. | | +| Begins when | EM determines to monitor VNF lifecycle changes on one or more managed VNF instance(s). | | +| Step 1 (M) | EM requests a subscription to VNFM to receive VNF lifecycle change notifications regarding one or more managed VNF instance(s). | | +| Step 2 (M) | VNFM creates a subscription and acknowledges the creation of the subscription to EM. | | +| Step 3 (M) | VNFM monitors the lifecycles of the identified managed VNF instance(s). | | +| Step 4 (M) | VNFM creates a VNF lifecycle change notification including information: identity the managed VNF instance, the type of lifecycle change including the beginning or the end of the procedure affecting the lifecycle changes. | | +| Step 5 (M) | VNFM sends to EM the VNF lifecycle change notification(s). | | +| Ends when | EM unsubscribes to VNF lifecycle change notification regarding the managed VNF instance(s). | | +| Exceptions | | | +| Post-conditions | EM has information about VNF lifecycle changes of the one or more managed VNF instance(s). | | +| Traceability | REQ-NFV_LCM_Ve-Vnfm-em-FUN-4, REQ-NFV_LCM_Ve-Vnfm-em-FUN-5 | | + +Note: VNF lifecycle change notifications are supported by NFV-MANO system [5]. + +#### 6.4.1.6 Enabling/disabling the auto-scaling of a VNF instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable/Disable the auto-scaling of a VNF instance (e.g.needed for testing and integration purposes). | | +| Actors and Roles | EM | | +| Telecom resources | VNFM | | +| Assumptions | The auto-scaling is supported.<br>In cases where NM is aware of the VNF instance (e.g. it was instantiated by NM request), it is expected that NM is made aware of the of auto-scaling enable/disable flag value change resulting from this Use Case. | | +| Pre-conditions | | | +| Begins when | EM decides to enable/disable the auto-scaling of a VNF instance. | | +| Step 1 (M) | EM requests VNFM to enable/disable the auto-scaling of a VNF instance. | | +| Step 2 (M) | VNFM notifies EM of the completion result of enabling/disabling the auto-scaling of the subject VNF instance. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The auto-scaling of the VNF instance is enabled/disabled. | | +| Traceability | REQ-NFV_LCM_Ve-Vnfm-em-FUN-8 | | + +#### 6.4.1.7 Retrieve VNF instance information from VNFM by EM + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To retrieve by EM from VNFM, information of a subject VNF instance. | | +| Actors and Roles | EM queries the VNF instance information. | | +| Telecom resources | EM.<br>VNFM.<br>VNF. | | +| Assumptions | N/A | | +| Pre-conditions | N/A | | +| Begins when | EM determines to retrieve certain information about the subject VNF instance. | | +| Step 1 (M) | EM sends a request to VNFM over the Ve-Vnfm-em reference point querying certain information about the subject VNF instance. | | +| Step 2 (M) | VNFM sends to EM over the Ve-Vnfm-em reference point the information requested about the subject VNF instance. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | EM has the information about the subject VNF instance. | | +| Traceability | REQ-NFV_LCM-CON-16, REQ-NFV_LCM_Ve-Vnfm-em-FUN-10 | | + +#### 6.4.1.8 Retrieve VNF instance information by NM through NFVO as part of the NS query + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To retrieve by NM through NFVO information about a subject VNF instance as part of the query of a NS. Such information about a subject VNF instance is maintained by NFV-MANO (see clause 9.4.2 in ETSI GS NFV-IFA 008 [5]). | | +| Actors and Roles | NM queries the information about a subject VNF instance which is part of NS instance. | | +| Telecom resources | NM.<br>NFVO.<br>VNFM. | | +| Assumptions | N/A | | +| Pre-conditions | The subject VNF instance is part of the NS instance. | | +| Begins when | NM determines to retrieve certain information about the subject VNF instance. | | +| Step 1 (M) | As part of query of a NS, NM sends a request to NFVO over the Os-Ma-nfvo reference point querying certain information about the subject VNF instance (see clause 7.3.6 in ETSI GS NFV-IFA 013 [7]). | | +| Step 2 (M) | NFVO sends to NM over the Os-Ma-nfvo reference point the information requested about the subject VNF instance. | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | NM has the information about the subject VNF instance. | | +| Traceability | REQ-NFV_LCM-CON-17, REQ-NFV_LCM_Os-Ma-nfvo-FUN-36 | | + +#### 6.4.1.9 Modify non-application information and non-application configuration attributes of a VNF instance by NM through NFVO as part of NS update + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To request by NM the modification of non-application information and non-application configuration attribute(s) of a subject VNF instance. Such information about a subject VNF instance is managed by NFV-MANO (see clause 9.4.2 in ETSI GS NFV-IFA 008 [5]), for which certain attributes are writable/modifiable (see clauses 7.2.11 and 7.4.2 in ETSI GS NFV-IFA 008 [5]), e.g. VNF instance name, VNF external connectivity. | | +| <b>Actors and Roles</b> | NM requests modifying the non-application information and non-application configuration attributes of the VNF instance which is part of the NS instance. | | +| <b>Telecom resources</b> | NM.<br>NFVO.<br>VNFM. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The subject VNF instance is part of the NS instance. | | +| <b>Begins when</b> | NM determines to modify certain non-application information and/or non-application configuration attribute(s) managed by NFV-MANO about the subject VNF instance that is part of an identified NS instance. | | +| <b>Step 1 (M)</b> | NM sends a request to NFVO over the Os-Ma-nfvo reference point to modify the needed non-application attribute(s) about the subject VNF instance as part of the NS update operation (see clause 7.3.5 in ETSI GS NFV-IFA 013 [7]). | | +| <b>Step 2 (M)</b> | NFVO sends an acknowledgement of the NS update request to the NM. | | +| <b>Step 3 (M)</b> | NFVO sends to NM an NS Lifecycle Change notification about the start of the NS update execution (see clause 7.4.3 in ETSI GS NFV-IFA 013 [7]). | | +| <b>Step 4 (M)</b> | NFVO executes the procedure to update the NS instance. | | +| <b>Step 5 (M)</b> | NFVO sends to NM the NS Lifecycle Change notification to indicate the completion of the modification of requested attributes of the VNF instance as part of NS update (see clause 7.4.3 in ETSI GS NFV-IFA 013 [7]). | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The non-application information and/or non-application configuration attribute(s) managed by NFV-MANO of the subject VNF instance has been modified. | | +| <b>Traceability</b> | REQ-NFV_LCM-CON-18, REQ-NFV_LCM-CON-19, REQ-NFV_LCM_Os-Ma-nfvo-FUN-37, REQ-NFV_LCM_Os-Ma-nfvo-FUN-38 | | + +### 6.4.2 VNF Package use cases + +#### 6.4.2.1 VNF Package on-boarding + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | VNF Package on-boarding | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NM.NFVO | | +| <b>Assumptions</b> | - The VNF Package is supplied by the NM<br>- On-boarding is triggered by the NM | | +| <b>Pre-conditions</b> | NFVO is running.<br>NM is operational.<br>The NM possesses a VNF Package which is not on-boarded yet | | +| <b>Begins when</b> | NM layer determines the need for on-boarding of the VNF Package | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO on the VNF package on-boarding as specified in [6] | | +| <b>Step 2 (M)</b> | NFVO processes the VNF Package and on-boarding proceeds | | +| <b>Step 3 (M)</b> | NFVO acknowledges to the NM successful package on-boarding. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The VNF Package is on-boarded. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-3 | | + +#### 6.4.2.2 VNF Package enabling + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable a previously disabled VNF Package instance, allowing again its use for instantiation of new VNF with this package. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Enablement is triggered by the NM. | | +| Pre-conditions | A VNF Package is in the "Disabled, Not in use" or "Disabled, In use" state. | | +| Begins when | NM determines the need for enabling of the VNF Package. | | +| Step 1 (M) | NM sends a request to the NFVO to enable the VNF package. | | +| Step 2 (M) | NFVO processes the request and enables the VNF Package. | | +| Step 3 (M) | NFVO acknowledges to the NM successful enablement of the VNF package. | | +| Exceptions | | | +| Post-conditions | The VNF Package is enabled and available for use for instantiation of new VNF(s) with this package. | | +| Traceability | | | + +#### 6.4.2.3 VNF Package disabling + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | VNF Package disabling. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Disabling is triggered by the NM. | | +| Pre-conditions | A VNF Package is on-boarded, available for use for instantiation of new VNF instance(s) and is not marked as deletion pending | | +| Begins when | NM layer determines the need for disabling of the VNF Package. | | +| Step 1 (M) | NM sends a request to the NFVO to disable the VNF package | | +| Step 2 (M) | NFVO processes the request and disables the VNF Package. | | +| Step 3 (M) | NFVO acknowledges to the NM successful operation of disabling the VNF package. | | +| Exceptions | | | +| Post-conditions | The VNF Package is on-boarded, disabled and cannot be used for instantiation of new VNF instance(s) with this package. | | +| Traceability | | | + +#### 6.4.2.4 VNF Package deleting + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------|-------------------------| +| Goal | VNF Package deleting. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Deletion is triggered by the NM. | | +| Pre-conditions | The VNF Package is in "Disabled, Not in use" state defined in [6], clause D1.2 | | +| Begins when | NM layer determines the need for deletion of the VNF Package. | | +| Step 1 (M) | NM sends a request to the NFVO to delete the VNF package as specified in [6], clause 7.7.5. | | +| Step 2 (M) | NFVO processes the request and deletes the VNF Package. | | +| Step 3 (M) | NFVO indicates to the NM the result of the operation. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The VNF Package is deleted. | | +| Traceability | | | + +#### 6.4.2.5 Delete VNF Package operation, when in use + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Delete VNF Package | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | NM has an active subscription at the NFVO for notifications on deletion of the VNF Package.<br>Deletion of the VNF Package is triggered by the NM. | | +| Pre-conditions | A VNF Package is in "Disabled, In use" state as defined in [6], Annex D. | | +| Begins when | NM layer determines the need for deletion of the VNF Package. | | +| Step 1 (M) | NM sends a request to the NFVO to delete the VNF package as specified in [6], clause 7.7.5. | | +| Step 2 (M) | NFVO processes the request and moves the VNF Package to the "Deletion Pending" state. | | +| Step 3 (M) | NFVO responds to the NM with notification of the result of the Delete VNF Package operation indicating that the VNF Package is now marked as delete pending. | | +| Step 4 (M) | After the last VNF terminated, the NFVO deletes the VNF Package and sends VNF Package change notification that indicates deletion of the VNF Package. | | +| Step 5 (M) | NM receives the notification on deletion. | | +| Exceptions | | | +| Post-conditions | The VNF Package is deleted and no further operations with the package are possible. | | +| Traceability | | | + +#### 6.4.2.6 Abort VNF Package deletion operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Abort VNF Package deletion. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Deletion of the VNF Package was earlier triggered by the NM when the VNF Package was in use. | | +| Pre-conditions | A VNF Package is in "Deletion Pending" state defined in [6], Annex D. | | +| Begins when | When the VNF Package is in use, the NM layer determines the need for abort of the deletion of the VNF Package e.g. because of expected further use of the package. | | +| Step 1 (M) | NM sends a request to the NFVO to abort deletion of the VNF package as specified in [6], clause 7.7.12. | | +| Step 2 (M) | NFVO processes the request and moves the VNF Package to the "Disabled, In use" state. | | +| Step 3 (M) | NFVO sends a response message to the NM. | | +| Exceptions | | | +| Post-conditions | The VNF Package deletion is aborted and the VNF Package is in the "Disabled, In use" state. | | +| Traceability | | | + +#### 6.4.2.7 VNF Package querying + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Obtain properties of the VNF Package. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | VNF Package querying is triggered by the NM. | | +| Pre-conditions | A VNF Package is on-boarded | | +| Begins when | NM layer determines the need for querying of the VNF Package. | | +| Step 1 (M) | NM layer sends a request to the NFVO to query the VNF package as specified in [6], clause 7.7.6 | | +| Step 2 (M) | NFVO processes the request. | | +| Step 3 (M) | NFVO acknowledges to the NM layer successful operation and returns the result of the operation. | | +| Exceptions | | | +| Post-conditions | The NM layer possesses up-to-date information of the VNF Package, | | +| Traceability | | | + +#### 6.4.2.8 Fetch VNF Package operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | In case when the VNF Package has been on-boarded by another NM layer entity, fetch a whole VNF Package. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Fetch operation is triggered by the NM layer entity. | | +| Pre-conditions | | | +| Begins when | NM layer entity determines the need for fetching a whole VNF Package. | | +| Step 1 (M) | NM sends a fetch request to the NFVO to obtain the whole VNF Package using the VNFD identifier assigned by the VNF provider, as specified in [6], clause 7.7.9 or the identifier of information held by the NFVO about the VNF Package as specified in [6], clause 7.7.10. | | +| Step 2 (M) | NFVO sends to the NM the fetch response that contains information requested by the NM. | | +| Exceptions | | | +| Post-conditions | The NM possesses the requested information. | | +| Traceability | | | + +#### 6.4.2.9 Fetch On-boarded VNF Package Artefacts operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| +| Goal | Fetch selected artefacts of the VNF Package. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Fetch operation is triggered by the NM layer entity. | | +| Pre-conditions | The VNF Package is on-boarded. | | +| Begins when | NM layer entity determines the need for fetching selected artefacts contained in the VNF package. | | +| Step 1 (M) | The NM queries the NFVO for the VNF Package Information | Clause 6.4.2.7:<br>Use case for<br>VNF Package<br>querying | +| Step 2 (M) | The NFVO responds to the NM with the result of the query that contains the VNF Package information | Clause 6.4.2.7:<br>Use case for<br>VNF Package<br>querying | +| Step 3 (M) | NM sends a fetch request to the NFVO to obtain the selected artefacts contained in the VNF package as specified in [6], clause 7.7.11. The artefacts are addressed using access information obtained in response to the Query On-boarded VNF Package Information operation. | | +| Step 4 (M) | NFVO sends to the NM the fetch response that contains copy of the artefacts requested by the NM. | | +| Exceptions | | | +| Post-conditions | The NM possesses the requested information. | | +| Traceability | | | + +#### 6.4.2.10 Notify operation on VNF package management interface + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | NM to receive notifications related to changes of VNF Packages sent by the NFVO. | | +| Actors and Roles | NFVO. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | NM has an active subscription at the NFVO for certain notifications related to changes of VNF Packages such as VNF Package on-boarding and VNF Package Change notifications. The subscription includes a filter for selecting the VNF Package(s) and related change notifications. | | +| Pre-conditions | | | +| Begins when | There is a change in the VNF Package that triggers a notification matching the filter in the subscription, see [6], clause 7.7.8. | | +| Step 1 (M) | NFVO sends the notification on the change, to the NM. | | +| Step 2 (M) | The NM receives the notification. | | +| Exceptions | | | +| Post-conditions | The NM possesses information carried by the received notification. | | +| Traceability | | | + +#### 6.4.2.11 Subscribe operation at the VNF Package management interface + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To subscribe with a filter for the notifications related to changes of VNF Packages sent by the NFVO. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | Subscription is triggered by the NM layer. | | +| Pre-conditions | | | +| Begins when | NM layer determines the need to subscribe with a filter for the notifications related to changes of VNF Packages sent by the NFVO. | | +| Step 1 (M) | NM sends to the NFVO request for subscription to certain notifications related to changes of certain VNF Package(s) as specified in [6], clause 7.7.7. | | +| Step 2 (M) | NFVO responds to the NM with the result of the operation indicating if the subscription has been successful or not, and, in the case of success, identification of the subscription realized. | | +| Exceptions | | | +| Post-conditions | In the case of successful subscription, the NM is registered to receive notifications related to changes of VNF Packages sent by the NFVO and matching the filter | | +| Traceability | | | + +### 6.4.3 NS Instance use cases + +#### 6.4.3.1 NS instantiation + +##### 6.4.3.1.1 Instantiation of a new NS + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Goal | To instantiate a NS with necessary input parameterization through operation request from NM on the Os-Ma-nfvo reference point in order to honour specific NS usage, e.g. geographical location, capacity, etc. | | +| Actors and Roles | NM requests the NS instantiation | | +| Telecom resources | NM.<br>NFVO | | +| Assumptions | NS may contain VNFs, PNFs and nested NSs. | | +| Pre-conditions | The VNF Package(s) of the VNF(s) to be instantiated as part of the NS are on-boarded.<br>The NSD for the NS instantiation is on-boarded.<br>A NS instance identifier and an associated instance of a NsInfo information element have been created.<br>PNFDs for PNF constituents of NS have been on-boarded. | Clause 6.4.2.1:<br>Use case for VNF Package on-boarding<br>Clause 6.4.4.1:<br>Use case for Network Service Descriptor (NSD) On-boarding.<br>Clause 6.4.3.12:<br>Create NS Identifier | +| Begins when | NM determines (e.g., by operator request) that a new NS needs to be instantiated honouring certain usage and input requirements. | | +| Step 1 (M) | NM sends to NFVO a request to instantiate the new NS indicating in the request information about the target NSD and additional parameterization for the specific NS to instantiate (see clause 7.3.3 in ETSI GS NFV-IFA013 [6]).<br><br>In case the NS instantiation request required VNF(s) instantiation or configuration, the VNFs' parameters/values, including those captured in vendor specific name value pairs, carried by such request are only related to VNF virtualization aspects and are not VNF application specific. | | +| Step 2 (M) | NFVO sends to NM a notification about the start of the NS instantiation (see clause 7.4.3 in ETSI GS NFV-IFA 013 [6]). | | +| Step 3 (M) | NFVO executes with rest of NFV-MANO system the instantiation of the NS. | | +| Step 4 (M) | NFVO sends to NM a notification about the results of the NS instantiation execution (see clause 7.4.3 in ETSI GS NFV-IFA 013 [6]). | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | A new NS is instantiated. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-1 | | + +##### 6.4.3.1.2 Instantiation of a new NS with existing VNF instances and new VL instances + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Goal | Interconnect specific external CPs of specific VNF instances by adding them to a new NS. | | +| Actors and Roles | NM | | +| Telecom resources | NFVO | | +| Assumptions | NM is subscribed for NS LCM notifications | | +| Pre-conditions | The VNF instances being interconnected already exist (have been instantiated) and do not belong to the same NS instance.<br>A NS instance identifier and an associated instance of a NsInfo information element have been created. | Clause 6.4.3.12:<br>Create NS Identifier | +| Begins when | NM determines (e.g. by operator's request) the need for interconnecting the VNF instances that do not belong to the same NS. | | +| Step 1 (M) | NM sends a request to the NFVO to instantiate a new NS instance by adding existing VNF instances to it and creating new instances of VL connecting specific external CPs of specific VNF instances belonging to this NS instance. | | +| Step 2 (M) | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request. | | +| Step 3 (M) | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| Step 4 (M) | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| Step 5 (M) | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The new NS instance has been created with identified VNF instances interconnected according to the operator's needs | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-26 | | + +##### 6.4.3.1.3 Instantiation of a new NS with existing NS instances and new VL instances + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Goal | Interconnect specific SAPs of specific NS instances by adding them to a new NS. | | +| Actors and Roles | NM | | +| Telecom resources | NFVO | | +| Assumptions | NM is subscribed for NS LCM notifications | | +| Pre-conditions | The NS instances with SAPs being interconnected already exist (have been instantiated) and do not belong to the same NS instance.<br>A NS instance identifier and an associated instance of a NsInfo information element have been created. | Clause 6.4.3.12:<br>Create NS Identifier | +| Begins when | NM determines (e.g. by operator's request) the need for interconnecting the NS instances that do not belong to the same NS. | | +| Step 1 (M) | NM sends a request to the NFVO to instantiate a new NS instance by adding existing NS instances to it and creating new instances of VL connecting specific SAPs of specific nested NS instances belonging to this NS instance. | | +| Step 2 (M) | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request. | | +| Step 3 (M) | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| Step 4 (M) | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| Step 5 (M) | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The new NS instance has been created with identified nested NS instances interconnected according to the operator's needs | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-27 | | + +#### 6.4.3.2 NS instance termination + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to terminate a NS instance | | +| Actors and Roles | NM. | | +| Telecom resources | NFVO. | | +| Assumptions | NS termination is triggered by the NM. | | +| Pre-conditions | NS instance(s) exist..<br>NFVO is running.<br>NM is operational | | +| Begins when | NM determines to terminate a NS instance. | | +| Step 1 (M) | NM sends a request to the NFVO to terminate a NS instance. | | +| Step 2 (M) | NFVO terminates the NS instance and all those VNF instances associated only with the NS instance | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | In case of success, the NS instance has been terminated and all those VNF instances associated only with this NS instance have been terminated. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-6 | | + +#### 6.4.3.3 NS instance querying + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to obtain information on one or more NS instance(s) | | +| Actors and Roles | NM. | | +| Telecom resources | NFVO. | | +| Assumptions | NS querying is triggered by the NM. | | +| Pre-conditions | One or more NS instance(s) exist.<br>NFVO is running.<br>NM is operational | | +| Begins when | NM determines to query one or more NS instance(s). | | +| Step 1 (M) | NM sends a request to the NFVO to query one or more NS instance(s) with queryFilter specifying identifiers and attributeSelector providing a list of attribute names of NS. | | +| Step 2 (M) | NFVO processes the request. | | +| Step 3 (M) | NFVO send to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The NM possesses up-to-date information of the NS instance(s) | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-7 | | + +#### 6.4.3.4 NS scaling using VNF scaling operation initiated through Os-Ma-nfvo reference point + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To scale a VNF instance by scaling the NS instance through operation request to NFVO by NM, and notify about the execution of the NS instance scaling through reference point Os-Ma-nfvo. | | +| Actors and Roles | NM detects whether a scaling execution is needed and requests the NFVO to execute the NS scaling. | | +| Telecom resources | NM, NFVO | | +| Assumptions | | | +| Pre-conditions | The subject NS instance is not being scaled at the moment. | | +| Begins when | NM detected the need to scale and have determined the scaling target VNF instance(s) and action (i.e. addition, expansion, contraction or removal). | | +| Step 1 (M) | NM sends the NFVO a request to scale a NS with an indication of the target VNF instance to scale, type of scaling and value of scaling as necessary. | | +| Step 2 (M) | The NFVO sends to NM a notification about the start of the NS scaling execution. | | +| Step 3 (M) | The NFVO executes the procedure to scale the NS instance. | | +| Step 4 (M) | NFVO sends to NM a notification about the end of the NS scaling execution. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | The NS instance has been scaled. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-8, REQ-NFV_LCM_Os-Ma-nfvo-FUN-11 | | + +#### 6.4.3.5 Updating an NS instance to correspond to a different NSD version + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| <b>Goal</b> | The network operator through 3GPP management system can decide the time when and has the capacity to update the NS instance to correspond to a different NSD version when such update synchronization has not automatically been performed by the NFVO. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | The NM is subscribed to NS lifecycle change notifications from the NFVO. | | +| <b>Pre-conditions</b> | The NS to update is instantiated.<br>The new NSD version is available to the NM. | Clause 6.4.3.1.1: Use case of NS instantiation | +| <b>Begins when</b> | NM determines to update the existing NS instance, e.g., due to changes in its VNF instances. | | +| <b>Step 1 (M)</b> | The NSD instance is updated with the new NSD version (see clause 7.2.5 in ETSI GS NFV-IFA 013 [6]). | Clause 6.4.4.7: Use case for updating NSD instance | +| <b>Step 2 (M)</b> | The NS instance is associated to the newly on-boarded NSD version.<br><br>NOTE: The automatic update synchronization by NFVO is set to false (see clause 8.3.4.19 in ETSI GS NFV-IFA 013 [6]). | Clause 6.4.3.6: Use case for associating a new NSD version to an NS instance as part of NS update | +| <b>Step 3 (M)</b> | NM sends a request to NFVO to update the NS instance with the necessary update information, e.g., addition, removal or modification of existing VNF instances part of the NS instance (see clause 7.3.5 in ETSI GS NFV-IFA 013 [6]). | | +| <b>Step 4 (M)</b> | NFVO acknowledges the NS instance update request providing information to identify the lifecycle operation occurrence (see clause 7.3.5 in ETSI GS NFV-IFA 013 [6]). | | +| <b>Step 5 (M)</b> | NFVO sends to NM a notification indicating the start of the NS update lifecycle changes. The notification identifies the NS instance affected for the lifecycle change, the lifecycle operation occurrence and the type of lifecycle operation (see clause 8.3.2.2 in ETSI GS NFV-IFA 013 [6]). | | +| <b>Step 6 (M)</b> | NFVO sends to NM a notification indicating the end result of the NS update lifecycle changes. The notification identifies the NS instance affected for the lifecycle change, the lifecycle operation occurrence, the type of lifecycle operation and information about the entities part of the NS instance affected by the lifecycle change (see clause 8.3.2.2 in ETSI GS NFV-IFA 013 [6]). | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NS instance has been updated to correspond to the different NSD version. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-9, REQ-NFV_LCM_Os-Ma-nfvo-FUN-17, REQ-NFV_LCM_Os-Ma-nfvo-FUN-20 | | + +#### 6.4.3.6 Associating a different NSD version to an NS instance as part of NS update + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| <b>Goal</b> | The network operator through 3GPP management system has the capacity to associate an existing NS instance to a different NSD version as part of NS update, so that the NS instance lifecycle management and NS instance updates can be performed according to the different NSD version. | | +| <b>Actors and Roles</b> | NM. | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The different NSD version to associate the NS instance to is already on-boarded. | Clause 6.4.4.7:<br>Use case for updating NSD instance. | +| <b>Begins when</b> | NM determines to associate the different NSD version to the existing NS instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO as part of NS update to associate the different NSD version to the NS instance by providing the identifier of the on-boarded different version and indication of whether the NS instance will be automatically synchronized to the new NSD by the NFVO (see clause 8.3.4.15 in ETSI GS NFV-IFA 013 [6]).<br>NOTE: The present use case does not elaborate in the additional steps that can occur when automatic synchronization is performed. | | +| <b>Step 2 (M)</b> | NFVO acknowledges to the NM the successful NS update operation (see clause 7.3.5 in ETSI GS NFV-IFA 013 [6]). | | +| <b>Ends when</b> | Ends when all steps identified above are completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NS instance is associated to the different NSD version. | | +| <b>Traceability</b> | REQ- NFV_LCM_Os-Ma-nfvo-FUN-22 | | + +#### 6.4.3.7 Addition of a new VL to an existing NS instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Interconnect specific external CPs of specific VNF instances. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed for NS LCM notifications | | +| <b>Pre-conditions</b> | The VNF instances being interconnected already exist (have been instantiated) and belong to the same NS instance. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) the need for interconnecting the VNF instances. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the NS instance by creating a new instance of VL with specific external CPs of specific VNF instances belonging to this NS instance. | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request. | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The identified VNF instances are interconnected according to the operator's needs | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-23 | | + +#### 6.4.3.8 Addition of an existing VNF instance to an existing NS instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Add an existing VNF instances to the existing NS instance. | | +| Actors and Roles | NM | | +| Telecom resources | NFVO | | +| Assumptions | NM is subscribed for NS LCM notifications | | +| Pre-conditions | The VNF instance being added already exist (has been instantiated) and does not belong to this NS instance.<br>The VNFD (VNF type) of the VNF instance being added is already known to the NSD of the NS where the VNF instance is being added to.<br>The DF of the VNF instance being added matches one of the VNF profiles in the NSD of the NS where the VNF instance is being added to. | | +| Begins when | NM determines (e.g. by operator's request) the need for adding an existing VNF instance to an existing NS instance. | | +| Step 1 (M) | NM sends a request to the NFVO to update the NS instance by adding the existing instance of VNF and if needed, with VNF profile to be used for this VNF instance (see [6] clauses 7.3.5 and 8.3.4.3). | | +| Step 2 (M) | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request. | | +| Step 3 (M) | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| Step 4 (M) | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| Step 5 (M) | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The identified VNF instances have been added to the NS instance according to the operator's needs | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-24 | | + +#### 6.4.3.9 Addition of a new SAP to an existing NS instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Add new Service Access Point exposing specific external CP of a specific VNF instance. | | +| Actors and Roles | NM | | +| Telecom resources | NFVO | | +| Assumptions | NM is subscribed for NS LCM notifications | | +| Pre-conditions | The VNF instance who's external CP is being exposed as SAP already exists (has been instantiated) and belongs to the same NS instance where the new SAP is being added. | | +| Begins when | NM determines (e.g. by operator's request) the need for exposing a specific VNF external CP as a new SAP. | | +| Step 1 (M) | NM sends a request to the NFVO to update the NS instance by creating a new instance of SAP exposing specific external CP of a specific VNF instance belonging to this NS instance. | | +| Step 2 (M) | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request. | | +| Step 3 (M) | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| Step 4 (M) | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| Step 5 (M) | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The identified external CP of the identified VNF instance is exposed as a new SAP according to the operator's needs | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-25 | | + +#### 6.4.3.10 Notification regarding NS instance lifecycle changes + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to obtain the lifecycle change notifications on one or more NS instance(s). | | +| Actors and Roles | NM receives NS lifecycle change notifications. | | +| Telecom resources | NFVO | | +| Assumptions | | | +| Pre-conditions | NFVO is running.<br>NM subscribed for the notifications related to NS lifecycle changes. | | +| Begins when | NFVO monitors the lifecycles of the identified NS instance and the NS lifecycle is changed | | +| Step 1 (M) | NFVO creates NS lifecycle change notification including information: identity of the NS instance, the type of lifecycle change including the beginning or the end of the procedure affecting the lifecycle changes. | | +| Step 2 (M) | NFVO sends to NM the NS lifecycle change notifications. | | +| Ends when | NM unsubscribes to NS lifecycle change notification. | | +| Exceptions | | | +| Post-conditions | NM has information about the lifecycle changes of the one or more managed NS instance(s). | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-20 | | + +#### 6.4.3.11 Subscription regarding NS instance lifecycle changes + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To subscribe by NM the lifecycle changes on one or more NS instance(s). | | +| Actors and Roles | NM subscribes NS instance lifecycle change notifications. | | +| Telecom resources | NFVO | | +| Assumptions | | | +| Pre-conditions | NFVO is running.<br>NM is operational | | +| Begins when | NM determines to subscribe lifecycle changes on one or more NS instance(s). | | +| Step 1 (M) | NM requests a subscription to NFVO to receive the lifecycle change notifications regarding one or more NS instance(s). | | +| Step 2 (M) | NFVO creates a subscription and acknowledges the creation of the subscription to NM. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | | | +| Post-conditions | NM is subscribed to lifecycle changes of the one or more managed NS instance(s). | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-19 | | + +#### 6.4.3.12 Create NS Identifier + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To create a NS instance identifier and associated instance of a NsInfo information element to enable further NS instantiation. | | +| Actors and Roles | NM requests creation of the NS Identifier | | +| Telecom resources | NM.<br>NFVO | | +| Assumptions | | | +| Pre-conditions | The NSD is on-boarded. | | +| Begins when | NM determines (e.g., by operator request) that a new NS instance identifier, and an associated instance of a NsInfo information element are needed to enable NS instantiation based on the NSD. | | +| Step 1 (M) | NM sends to NFVO a Create NS Identifier request with reference to the NSD and additional information like NS name (see clause 7.3.2 in ETSI GS NFV-IFA013 [6]). | | +| Step 2 (M) | NFVO creates the NS Identifier and the associated instance of NsInfo information element and sends the response to the NM | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | A new NS instance identifier and an associated instance of a NsInfo information element are created and can be used in further NS instantiation. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-29 | | + +#### 6.4.3.13 Delete NS instance identifier + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | To delete the NS instance identifier and the associated instance of a NsInfo information element after the NS instance termination. | | +| Actors and Roles | NM requests deletion of the NS instance identifier. | | +| Telecom resources | NM, NFVO | | +| Assumptions | | | +| Pre-conditions | NS instance is terminated. | | +| Begins when | NM determines (e.g., by operator request) that the NS instance identifier and the associated instance of NsInfo information element of the terminated NS instance are needed to be deleted. | | +| Step 1 (M) | NM sends to NFVO a Delete NS Identifier request (see clause 7.3.8 in ETSI GS NFV-IFA013 [6]). | | +| Step 2 (M) | NFVO deletes the NS Identifier and sends the response to the NM. | | +| Ends when | All the steps identified above are successfully completed. | | +| Exceptions | One of the steps identified above fails. | | +| Post-conditions | The NS instance identifier are deleted. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-35 | | + +#### 6.4.3.14 Addition of PNF to the NS instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Add an existing PNF to the existing NS instance. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | The PNF being added already exist and does not belong to this NS instance.<br>The PNFD of the PNF being added is already known to the NSD of the NS where the PNF is being added to. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) the need for adding an existing PNF to an existing NS instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the NS instance by adding the existing PNF (see [6] clauses 7.3.5). | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The identified PNF has been added to the NS instance according to the operator's needs. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.3.15 Add an existing VNF instance with connectivity + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Add an existing VNF instance to a NS with connectivity to other VNF instance or PNF. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | A VNF instance has been instantiated. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) to add an existing VNF instance to a NS with connectivity to other VNF instance or PNF. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to add an existing VNF instance to a NS (see clause 7.3.5 in [6]) with VNF instance identifier and connectivity information for the external CP instances. | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The existing VNF instance has been added with connectivity to other VNF instance or PNF in the NS. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.3.16 Add external connectivity to a PNF or VNF instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Add external connectivity to a PNF or VNF instance. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | A PNF or VNF instance has been added or instantiated in an NS instance without the external connectivity, or a new external connectivity is needed due to PNF or VNF upgrade. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) that it is necessary to add the external connectivity to an existing PNF or VNF instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the NS instance (see clause 7.3.5 in [6]) to add the external connectivity to an existing PNF or VNF instance. | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The external connectivity has been added to the PNF or VNF instance according to the operator's needs. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.3.17 Add a virtual link to a NS instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Add a virtual link to a NS instance. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | The NS where the virtual link is to be added has been instantiated.<br>The virtual link descriptor and virtual link profile for the virtual link to be added are available in the NSD either on-boarded previously or updated. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) that it is necessary to add a virtual link to an existing NS instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the NS instance (see clause 7.3.5 in [6]) to add a virtual link. | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | A virtual link has been added to the NS instance according to the operator's needs. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.3.18 Change external connectivity to a PNF or VNF instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Change external connectivity to a PNF or VNF instance. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | A PNF or VNF instance has been added or instantiated in an NS instance. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) that it is necessary to change the external connectivity to an existing PNF or VNF instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the NS instance (see clause 7.3.5 in [6]) to change the external connectivity to an existing PNF or VNF instance. | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The external connectivity has been changed to the PNF or VNF instance according to the operator's needs. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.3.19 Add VNF forwarding graph to a NS instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Add VNF forwarding graph to a NS instance. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | An NS instance, containing the VNF instances and all necessary components (e.g. VLs, CPs, SAPs, ...) to form a VNFFG, has been instantiated, VNFFGD for the VNFFG to be added already exists. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) that it is necessary to add a VNFFG to a NS instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the NS instance (see clause 7.3.5 in [6]) by adding a VNFFG to a NS instance. | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId and processes the request | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The VNFFG has been added to the NS instance according to the operator's needs. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.3.20 Update VNF forwarding graph in a NS instance + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Update VNF forwarding graph in a NS instance. | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NFVO | | +| <b>Assumptions</b> | NM is subscribed to receive the NS LCM notifications. | | +| <b>Pre-conditions</b> | An NS instance with VNFFG already exists,<br>VNFFGD for the VNFFG to be updated already exists. | | +| <b>Begins when</b> | NM determines (e.g. by operator's request) that it is necessary to update the VNFFG in a NS instance. | | +| <b>Step 1 (M)</b> | NM sends a request to the NFVO to update the VNFFG (e.g. addition, deletion, and modification of NFP) in a NS instance via the NS update operation (see clause 7.3.5 in [6]). | | +| <b>Step 2 (M)</b> | NFVO returns to the NM lifecycleOperationOccurrenceId, and the identifier of new NFP if the update is to add a NFP to the existing VNFFG, and processes the request. | | +| <b>Step 3 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating start of the operation. | | +| <b>Step 4 (M)</b> | NFVO sends to NM Lifecycle Change Notifications indicating progress of the operation. | | +| <b>Step 5 (M)</b> | NFVO sends to NM Lifecycle Change Notification indicating result of the operation. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The VNFFG has been updated to the NS instance according to the operator's needs. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +### 6.4.4 NS Descriptor use cases + +#### 6.4.4.1 NS Descriptor (NSD) On-boarding + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | NSD On-boarding | | +| <b>Actors and Roles</b> | NM | | +| <b>Telecom resources</b> | NM, NFVO | | +| <b>Assumptions</b> | NSD on-boarding is triggered by the NM layer | | +| <b>Pre-conditions</b> | NFVO is running.<br>NM layer is operational.<br>The NM layer possesses the NSD | | +| <b>Begins when</b> | NM layer determines the need for on-boarding of the NSD | | +| <b>Step 1 (M)</b> | NM layer sends a request to the NFVO on the NSD on-boarding as specified in [6], clause 7.2.2. | | +| <b>Step 2 (M)</b> | NFVO processes the request and on-boarding proceeds. | | +| <b>Step 3 (M)</b> | NFVO acknowledges to the NM layer successful NSD on-boarding. | | +| <b>Exceptions</b> | | | +| <b>Post-conditions</b> | The NSD is on-boarded. | | +| <b>Traceability</b> | REQ-NFV_LCM_Os-Ma-nfvo-FUN-14, REQ-NFV_LCM_Os-Ma-nfvo-FUN-15 | | + +#### 6.4.4.2 Enabling NS Descriptor instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | NS Descriptor instance enabling | | +| Actors and Roles | NM | | +| Telecom resources | NM, NFVO | | +| Assumptions | NS Descriptor instance enabling is triggered by the NM layer | | +| Pre-conditions | NFVO is running.<br>NM layer is operational.<br>There is a NS Descriptor instance in one of the following states: "Disabled, In use" or "Disabled, Not in use" defined in [6], clause D2.2 | | +| Begins when | NM layer determines the need for enabling the NS Descriptor instance | | +| Step 1 (M) | NM layer sends a request to the NFVO on enabling the NS Descriptor instance as specified in [6], clause 7.2.3. | | +| Step 2 (M) | NFVO processes the request and enables the NS Descriptor instance | | +| Step 3 (M) | NFVO acknowledges to the NM layer successful enablement of the NS Descriptor instance. | | +| Exceptions | | | +| Post-conditions | The NS Descriptor instance is enabled. | | +| Traceability | | | + +#### 6.4.4.3 Disabling NS Descriptor instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | NS Descriptor instance disabling | | +| Actors and Roles | NM | | +| Telecom resources | NM, NFVO | | +| Assumptions | NS Descriptor instance disabling is triggered by the NM layer | | +| Pre-conditions | NFVO is running.<br>NM layer is operational.<br>There is a NS Descriptor instance in one of the states "Enabled, In use" or "Enabled, Not in use" defined in [6], clause D2.2 | | +| Begins when | NM layer determines the need for disabling the NS Descriptor instance | | +| Step 1 (M) | NM layer sends a request to the NFVO on disabling the NS Descriptor instance as specified in [6], clause 7.2.4. | | +| Step 2 (M) | NFVO processes the request and disables the NS Descriptor instance | | +| Step 3 (M) | NFVO acknowledges to the NM layer successful disabling of the NS Descriptor instance | | +| Exceptions | | | +| Post-conditions | The NS Descriptor instance is disabled | | +| Traceability | | | + +#### 6.4.4.4 Query NSD operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to obtain information on one or more NS Descriptors (NSDs) | | +| Actors and Roles | NM. | | +| Telecom resources | NFVO. | | +| Assumptions | NSD querying is triggered by the NM. | | +| Pre-conditions | One or more NSDs are on-boarded.<br>NFVO is running.<br>NM is operational | | +| Begins when | NM determines to query one or more NSD(s). | | +| Step 1 (M) | NM sends a request to the NFVO to query one or more NSD(s), with the filter defining the NSDs on which the query applies, and the attribute selector providing a list of attribute names of the NSD(s), according to [6], clause 7.2.7 | | +| Step 2 (M) | NFVO processes the request. | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The NM possesses the requested information on the NSD(s) | | +| Traceability | | | + +#### 6.4.4.5 Delete NS Descriptor operation, when in use + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Delete one or more NS Descriptor(s) that are in use. | | +| Actors and Roles | NM | | +| Telecom resources | NM, NFVO | | +| Assumptions | Deletion of the NS Descriptor (NSD) is triggered by the NM layer | | +| Pre-conditions | NFVO is running.<br>NM layer is operational.<br>There are one or several NSD(s) in the state "Disabled, In use" defined in [6], clause D2.2 | | +| Begins when | NM layer determines the need for deletion of the NSDs | | +| Step 1 (M) | NM layer sends a request to the NFVO on deletion of the NSDs as specified in [6], clause 7.2.6. | | +| Step 2 (M) | NFVO processes the request and transfers the NSDs into the Deletion Pending state. | | +| Step 3 (M) | NFVO responds to the NM layer with the result of the operation including indication that the NSDs are marked as delete pending. | | +| Step 4 (M) | After the last NS associated with certain NSD is terminated, the NFVO deletes the NSD. | | +| Exceptions | | | +| Post-conditions | The NSDs are deleted | | +| Traceability | | | + +#### 6.4.4.6 Delete NS Descriptor operation, when not in use + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Delete one or more NS Descriptor(s), a single version of an NSD or all versions. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO | | +| Assumptions | Deletion of the NS Descriptor (NSD) is triggered by the NM layer | | +| Pre-conditions | NFVO is running.<br>NM layer is operational.<br>There is a group of NSD(s) to be deleted that are all in the state "Disabled, Not in use" as defined in [6], clause D2.2 | | +| Begins when | NM layer determines the need for deletion of the group of the NSD(s). | | +| Step 1 (M) | NM layer sends a request to the NFVO on deletion of the NSD(s) as specified in [6], clause 7.2.6. | | +| Step 2 (M) | NFVO processes the request and deletes the NSD(s). | | +| Step 3 (M) | NFVO responds to the NM layer with the result of the operation. | | +| Exceptions | | | +| Post-conditions | The NSD(s) are deleted | | +| Traceability | | | + +#### 6.4.4.7 Updating NSD instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| +| Goal | The network operator through 3GPP management system has the capacity to update an on-boarded NSD instance on the NFVO. An NSD update creates a new NSD version and the previous on-boarded versions of the NSD are not modified (see clause 7.2.5.1 in ETSI GS NFV-IFA 013 [6]). | | +| Actors and Roles | NM. | | +| Telecom resources | NFVO | | +| Assumptions | N/A | | +| Pre-conditions | The NSD to update has been on-boarded. | Clause 6.4.4.1:<br>Use case for NS<br>Descriptor (NSD)<br>On-boarding | +| Begins when | NM determines to update the existing on-boarded NSD. | | +| Step 1 (M) | NM sends a request to the NFVO to update the NSD by providing the identifier of the existing on-boarded version of the NSD to update, the new NSD version, and optionally additional user defined data (see clause 7.2.5 in ETSI GS NFV-IFA 013 [6]). | | +| Step 2 (M) | NFVO acknowledges to the NM the successful NSD update providing the identifier of the newly on-boarded NSD version (see clause 7.2.5 in ETSI GS NFV-IFA 013 [6]). | | +| Ends when | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails.<br>The NSD to update is in deletion pending state.<br>The new NSD version does not correspond to be a different version of the existing on-boarded NSD to update. | | +| Post-conditions | The newly NSD version is on-boarded. | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-21 | | + +#### 6.4.4.8 Updating NSD user defined data + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Update the user defined data in the NS Descriptor | | +| Actors and Roles | NM | | +| Telecom resources | NM, NFVO | | +| Assumptions | NS Descriptor update is triggered by the NM layer | | +| Pre-conditions | NFVO is running.<br>NM layer is operational.<br>There is an onboarded NS Descriptor (NSD). | | +| Begins when | NM layer determines the need for update of the user defined data in the NSD. | | +| Step 1 (M) | NM layer sends a request to the NFVO on update of the user defined data in the NSD as specified in [6], clause 7.2.5. | | +| Step 2 (M) | NFVO processes the request and updates the NSD resulting in update of the user defined data of the NSD. | | +| Step 3 (M) | NFVO sends response message to the NM layer, indicating successful NSD update. | | +| Exceptions | | | +| Post-conditions | The NSD is updated. | | +| Traceability | | | + +#### 6.4.4.9 Subscribe to NSD change notifications + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable the NM to subscribe with a filter for the notifications related to changes of one or several NSDs, sent by the NFVO | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | | | +| Pre-conditions | NFVO is operational.<br>NM is operational. | | +| Begins when | NM determines a need in subscription to notifications on changes of certain NSD(s). | | +| Step 1 (M) | NM sends a request to the NFVO, according to [6], clause 7.2.12.<br>The request contains the input filter for selecting the NSD(s) and the related change notifications to subscribe to. This filter can contain information about specific types of changes to subscribe to, or attributes of the NsdInfo. | | +| Step 2 (M) | NFVO processes the request and registers the NM to receive notifications about changes of NSD(s). | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The NM is registered to receive notifications about changes of the NSD(s). | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-33 | | + +#### 6.4.4.10 Notify operation on management changes in NSDs + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable the NM to receive notifications related to NSD management changes, sent by the NFVO. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | | | +| Pre-conditions | NFVO is operational.<br>NM is operational.<br>The NM is subscribed to notifications related to management changes of NSD instances matching the filter defined at the time of the subscription. | | +| Begins when | NFVO monitors the NSD instances matching the filter and detects the management change in one of the NSD instances. | | +| Step 1 (M) | NFVO sends to the NM the notification according to [6], clause 7.2.13. | | +| Exceptions | | | +| Post-conditions | The NM received the notification. | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-34 | | + +### 6.4.5 PNFD Use Cases + +#### 6.4.5.1 Introduction + +PNFD lifecycle operations are considered exclusively in the context of definitions of the PNF connection points where the PNF may connect to a VL and PNF connection points exposure as service access points, see clause 6.6 [10], particularly the Table 6.6.2.2-1: Attributes of the Pnfd information element. + +#### 6.4.5.2 On-board PNFD operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to perform On-board PNFD operation. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | PNFD on-boarding is triggered by the NM. | | +| Pre-conditions | NFVO is running.<br>NM is operational. | | +| Begins when | NM determines a need in on-boarding a PNFD to make it available for use by NS Descriptors (NSDs). | | +| Step 1 (M) | NM sends a PNFD on-board request to the NFVO, according to [6], clause 7.2.8.<br>The request contains the PNFD to be on-boarded. | | +| Step 2 (M) | NFVO processes the request and on-boards the PNFD. | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The PNFD is on-boarded and available for use by NS Descriptors. | | +| Traceability | REQ-NFV_LCM_Os-Ma-nfvo-FUN-x | | + +#### 6.4.5.3 Create a new version of already on-boarded PNFD + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to create a new version of already on-boarded PNFD using Update PNFD operation. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | | | +| Pre-conditions | NFVO is operational.<br>NM is operational.<br>The old version of the PNFD is on-boarded. | | +| Begins when | NM determines a need in creation of a new version of already on-boarded PNFD using Update PNFD operation. | | +| Step 1 (M) | NM sends a Update PNFD request to the NFVO, according to [6], clause 7.2.9. The request contains the PNFD to be created as a new version of the existing PNFD. | | +| Step 2 (M) | NFVO processes the request and creates a new version of the PNFD | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The new version of the PNFD is created and available for use by NS Descriptors. | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-28 | | + +#### 6.4.5.4 Update of the user defined data on PNFD + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to update the user defined data on PNFD using Update PNFD operation. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | | | +| Pre-conditions | NFVO is operational.<br>NM is operational.<br>PNFD is on-boarded. | | +| Begins when | NM determines a need in updating the user defined data on PNFD using Update PNFD operation. | | +| Step 1 (M) | NM sends a Update PNFD request to the NFVO, according to [6], clause 7.2.9. The request contains the user defined data to be updated and does not contain new PNFD to be created. | | +| Step 2 (M) | NFVO processes the request and updates the user defined data on the PNFD. | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The user defined data on the PNFD is updated. | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-30 | | + +#### 6.4.5.5 Delete PNFD operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to delete the PNFDs. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | | | +| Pre-conditions | NFVO is operational.<br>NM is operational.<br>The PNFD(s) are on-boarded and not in use in any of the NSs that are in the active or NOT_INSTANTIATED state. | | +| Begins when | NM determines a need in deletion of the PNFD(s). | | +| Step 1 (M) | NM sends a Delete PNFD request to the NFVO, according to [6], clause 7.2.10.<br>The request contains<br>- identification of the on-boarded instance(s) of the PNFD(s) to be deleted.<br>- indication if the delete operation is to be applied on all versions of these PNFD instances. | | +| Step 2 (M) | NFVO processes the request and deletes the PNFD(s) as requested. | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The PNFD(s) are deleted as requested. | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-31 | | + +#### 6.4.5.6 Query PNFD operation + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Enable NM to query the NFVO concerning details of one or more PNFDs. | | +| Actors and Roles | NM. | | +| Telecom resources | NM, NFVO. | | +| Assumptions | | | +| Pre-conditions | NFVO is operational.<br>NM is operational.<br>The PNFD(s) are on-boarded. | | +| Begins when | NM determines a need in querying of the PNFD(s). | | +| Step 1 (M) | NM sends a Query PNFD request to the NFVO, according to [6], clause 7.2.11.<br>The request contains<br>- Filter conditions to select the PNFDs on which the query applies, based on attributes of the PNFDs<br>- A list of attribute names of the PNFD. If present, only these attributes are returned for the instances of PNFD matching the filter. If absent, the complete PNFD instances are returned. | | +| Step 2 (M) | NFVO processes the request and provides the requested information. | | +| Step 3 (M) | NFVO sends to the NM the result of the operation. | | +| Exceptions | | | +| Post-conditions | The information on the PNFDs provided to the NM as requested. | | +| Traceability | REQ- NFV_LCM_Os-Ma-nfvo-FUN-32 | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170504 | 0001 | 1 | F | Moving LCM supported use cases and requirements from TS 28.510 | 14.1.0 | +| 2017-06 | SA#76 | SP-170504 | 0002 | 2 | F | VNF application software update | 14.1.0 | +| 2018-03 | SA#79 | SP-180059 | 0004 | 1 | F | Scope extension | 14.2.0 | +| 2018-03 | SA#79 | SP-180059 | 0005 | 1 | F | Use case of NS instantiation | 14.2.0 | +| 2018-03 | SA#79 | SP-180059 | 0006 | 1 | F | Use cases of PNF addition, removal, and modification | 14.2.0 | +| 2018-06 | SA#80 | SP-180417 | 0009 | 2 | B | Add use case of adding VNF instance to a NS with connectivity | 15.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0010 | 2 | B | Add use case of adding external connectivity to a PNF or VNF instance | 15.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0011 | 2 | B | Add use case of adding NS virtual link to a NS instance | 15.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0013 | 2 | B | Add use case of changing external connectivity to a PNF or VNF instance | 15.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0014 | 2 | B | Adding requirement for PNFD on-boarding use case | 15.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0016 | 1 | B | Use case and requirement of adding VNFFG to a NS instance | 15.0.0 | +| 2018-06 | SA#80 | SP-180417 | 0017 | 1 | B | Use case and requirement of updating VNFFG in a NS instance | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28526/43837b056625d3d6ce615e4c02f163bb_img.jpg b/marked/Rel-16/28_series/28526/43837b056625d3d6ce615e4c02f163bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9922449816260bbd6e53860824b61705e6480b7a --- /dev/null +++ b/marked/Rel-16/28_series/28526/43837b056625d3d6ce615e4c02f163bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6769d1f25d9d458f9dba3f07511e2869c94a128d641e7d59de7540742d356068 +size 36980 diff --git a/marked/Rel-16/28_series/28526/61a1c017e34df13360be6319539570df_img.jpg b/marked/Rel-16/28_series/28526/61a1c017e34df13360be6319539570df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..29cab8646df7bebbdc6f12eac34aa647a511dae6 --- /dev/null +++ b/marked/Rel-16/28_series/28526/61a1c017e34df13360be6319539570df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0107e25ed2774cf74109a7136dce547a231776d7fdfe8ba64b62b7fce4f44acb +size 14820 diff --git a/marked/Rel-16/28_series/28526/836b0790cef5469a167fa8931df4e408_img.jpg b/marked/Rel-16/28_series/28526/836b0790cef5469a167fa8931df4e408_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2f33e87a6d7ee5f641cd2c8c6dba1fce2b54348 --- /dev/null +++ b/marked/Rel-16/28_series/28526/836b0790cef5469a167fa8931df4e408_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b8652284c14871d4b0926968f90186883417a13fd8ba130617e8ee68b1f1192 +size 12523 diff --git a/marked/Rel-16/28_series/28526/cab0834804fb031b43865554cc8d06ab_img.jpg b/marked/Rel-16/28_series/28526/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..96ba6a3fa8de2b9422a077323ff0e1165e05681d --- /dev/null +++ b/marked/Rel-16/28_series/28526/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cebd7e04aa93f2ebbde561335e4af41247fe5d4171f82db866a24fa08dca383 +size 22268 diff --git a/marked/Rel-16/28_series/28526/raw.md b/marked/Rel-16/28_series/28526/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3047affa803a4d1b705ce2c585724aa33c92ae79 --- /dev/null +++ b/marked/Rel-16/28_series/28526/raw.md @@ -0,0 +1,1718 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 Lifecycle Management procedures ..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 VNF Instance procedures..... | 7 | +| 4.2.1 VNF Identifier creation ..... | 7 | +| 4.2.2 VNF instantiation ..... | 7 | +| 4.2.2.1 VNF instantiation by EM request..... | 7 | +| 4.2.2.2 VNF instantiation as part of NS update initiated through Os-Ma-nfvo..... | 8 | +| 4.2.2.3 Provide IP address of the managing EM in VNF instantiation..... | 9 | +| 4.2.2.4 Query VNF instance information through Ve-Vnfm-em ..... | 11 | +| 4.2.3 VNF scaling..... | 12 | +| 4.2.3.1 Scale VNF instance initiated by EM..... | 12 | +| 4.2.3.2 Scale VNF instance to a level initiated by EM..... | 12 | +| 4.2.3.3 VNF scaling as part of NS scaling initiated through Os-Ma-nfvo ..... | 13 | +| 4.2.4 VNF instance termination..... | 14 | +| 4.2.4.1 VNF termination by EM request ..... | 14 | +| 4.2.4.2 VNF termination by removing VNF instance from NS..... | 14 | +| 4.2.5 Notifications about VNF lifecycle changes..... | 15 | +| 4.2.6 Autoscaling enabling/disabling ..... | 16 | +| 4.2.6.1 Autoscaling enabling/disabling initiated through Ve-Vnfm-em ..... | 16 | +| 4.2.6.2 Autoscaling enabling/disabling through Os-Ma-nfvo ..... | 16 | +| 4.2.7 Subscribing to VNF lifecycle change notifications through Ve-Vnfm-em..... | 16 | +| 4.2.8 3GPP network function software update when application software is part of VNF Package and synchronization of VNF instance information is performed through Os-Ma-nfvo..... | 17 | +| 4.3 VNF Package procedures..... | 17 | +| 4.3.1 VNF package on-boarding ..... | 17 | +| 4.3.2 VNF Package enabling..... | 18 | +| 4.3.3 VNF Package disabling ..... | 18 | +| 4.3.4 VNF Package deleting..... | 19 | +| 4.3.5 Abort VNF package deletion..... | 19 | +| 4.3.6 VNF Package querying..... | 19 | +| 4.3.7 Fetch VNF Package..... | 20 | +| 4.3.8 Notify operation on VNF Package management interface..... | 20 | +| 4.3.9 Subscribe operation on VNF Package management interface..... | 21 | +| 4.3.10 Fetch on-boarded VNF Package artifacts..... | 21 | +| 4.4 NS Instance procedures..... | 22 | +| 4.4.1 NS Instance instantiation..... | 22 | +| 4.4.2 NS Instance termination ..... | 23 | +| 4.4.3 NS Instance querying ..... | 23 | +| 4.4.3.1 Query NS instance information through Os-Ma-nfvo ..... | 23 | +| 4.4.4 NS Instance scaling ..... | 24 | +| 4.4.5 NS Instance updating..... | 25 | +| 4.4.5.1 NS update to associate an NS instance to a different NSD version..... | 25 | +| 4.4.5.2 Modifying VNF instance information through Os-Ma-nfvo ..... | 25 | +| 4.4.5.3 Modifying VNF instance configuration through Os-Ma-nfvo ..... | 26 | +| 4.4.5.4 NS update to add a PNF to the NS instance ..... | 27 | +| 4.4.5.5 NS update to modify a PNF in the NS instance..... | 28 | +| 4.4.5.6 NS update to remove a PNF from the NS instance..... | 29 | +| 4.4.5.7 NS update to associate an VNF instance with a VNF profile..... | 29 | + +Figure 4.4.5.7-1 contains a procedure to show how the connectivity of a VNF instance can be added or changed by associating such VNF instance with a new or updated VnfProfile that includes the NS virtual link information. It is assumed that the NSD with the new or updated VnfProfile has been uploaded to the NFVO, and the NSD has been associated with the NS containing such VNF instance, according to clause 4.4.5.1..... 29 + +4.4.5.8 NS update to associate an PNF with a PNF profile ..... 30 + +Figure 4.4.5.8-1 contains a procedure to show how the connectivity of a PNF can be added or changed by associating such PNF with a new or updated PnfProfile that includes the NS virtual link information. It is assumed that the NSD with the new or updated PnfProfile has been uploaded to the NFVO, and the NSD has been associated with the NS containing such PNF, according to clause 4.4.5.1..... 30 + +4.4.6 Subscription regarding NS Instance lifecycle changes..... 30 + +4.4.7 Create NS Instance identifier..... 31 + +4.4.8 Delete NS Instance identifier..... 31 + +4.4.9 Procedure for the Notify operation for notifications to NM..... 32 + +4.5 NS Descriptor (NSD) procedures..... 32 + +4.5.1 NSD on-boarding..... 32 + +4.5.2 NSD enabling ..... 33 + +4.5.3 NSD disabling ..... 33 + +4.5.4 NSD querying..... 34 + +4.5.5 NSD deletion ..... 34 + +4.5.6 NSD updating ..... 35 + +4.5.7 Subscribe to NSD change notifications..... 35 + +4.5.8 Notify operation for NSD management changes..... 36 + +4.6 PNFD procedures ..... 37 + +4.6.1 PNFD on-boarding ..... 37 + +4.6.2 PNFD updating ..... 37 + +4.6.3 PNFD deletion ..... 37 + +4.6.4 PNFD querying..... 38 + +Annex A (informative): Change history..... 39 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.525: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements. +- TS 28.526: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Procedures.** +- TS 28.527: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 2. +- TS 28.528: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 3. + +# --- 1 Scope + +The present document specifies the Life Cycle Management (LCM) procedures for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Management concept, architecture and requirements for mobile networks that include virtualized network functions". +- [3] 3GPP TS 28.525: "Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements". +- [4] ETSI GS NFV-IFA008 V2.1.1 (2016-10) "Network Function Virtualization (NFV); Management and Orchestration; Ve-Vnfm Reference Point - Interface and Information Model Specification". +- [5] ETSI GS NFV-IFA013 V3.1.2 (2018-08) "Network Function Virtualization (NFV); Management and Orchestration; Os-Ma-nfvo Reference Point - Interface and Information Model Specification". +- [6] 3GPP TS 32.508: "Telecommunication management; Procedure flows for multi-vendor plug-and-play eNode B connection to the network". +- [7] 3GPP TS 32.532: "Telecommunication management; Software management (SwM); Integration Reference Point (IRP); Information Service (IS)". +- [8] ETSI GS NFV-IFA011 V2.1.1 (2016-10) "Network Function Virtualization (NFV); Management and Orchestration; VNF Packaging Specification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +# 4 Lifecycle Management procedures + +## 4.1 Introduction + +The procedures listed in clause 4, as some of all the possibilities, are not exhaustive. + +## 4.2 VNF Instance procedures + +### 4.2.1 VNF Identifier creation + +Figure 4.2.1-1 depicts the procedure of VNF instance identifier creation initiated through Ve-Vnfm-em reference point (see clause 7.2.2 of GS NFV-IFA008 [4]) + +1. EM sends to VNFM a *CreateVnfIdentifierRequest* with parameter `vnfId`, `vnfInstanceName` and `vnfInstanceDescription` to create a VNF instance identifier (`vnfInstanceId`) and an associated instance of an `NsInfo` information element (see clause 7.2.2.2 of GS NFV-IFA008 [4]). +2. VNFM sends to EM a *CreateVnfIdentifierResponse* with parameter `vnfInstanceId` identifying the instance identifier of the VNF has been created (see clause 7.2.2.3 of GS NFV-IFA008 [4]). +3. VNFM sends to EM a *Notify* (see clause 7.3.3 of GS NFV-IFA008 [4]) carrying `VnfIdentifierCreationNotification` information element with attribute `vnfInstanceId` to indicate the VNF instance identifier creation (see clause 9.5.7 of GS NFV-IFA008 [4]). + +![Sequence diagram showing VNF identifier creation. 1. EM sends CreateVnfIdentifierRequest to VNFM. 2. VNFM sends CreateVnfIdentifierResponse to EM. 3. VNFM sends Notify to EM.](e2c1c672349c10dccb2563eff6d8260e_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + EM->>VNFM: 1. CreateVnfIdentifierRequest + VNFM->>EM: 2. CreateVnfIdentifierResponse + VNFM->>EM: 3. Notify + +``` + +Sequence diagram showing VNF identifier creation. 1. EM sends CreateVnfIdentifierRequest to VNFM. 2. VNFM sends CreateVnfIdentifierResponse to EM. 3. VNFM sends Notify to EM. + +**Figure 4.2.1-1 Procedures of VNF identifier creation** + +### 4.2.2 VNF instantiation + +#### 4.2.2.1 VNF instantiation by EM request + +Figure 4.2.2.1-1 depicts a procedure of VNF instantiation by EM request. It is assumed that EM has subscribed to receive the VNF lifecycle change notification from VNFM. As a result of this procedure, the new VNF instance is not associated to any NS (see NOTE in clause 7.2.3.4 in [4]). + +1. EM sends *CreateVnfRequest* to VNFM with `vnfDescriptorId`, `vnfInstanceName`, and `vnfInstanceDescription` to create the VNF identifier (see clause 7.2.2 [4]). +2. VNFM sends *CreateVnfResponse* to EM with `vnfInstanceId` to indicate the creation of a new instance of a VNF information element (see clause 7.2.2.3 [4]). +3. EM sends *InstantiateVnfRequest* to VNFM with input parameters, listed in clause 7.2.3.2 [4] to instantiate a VNF (see clause 7.2.3 [4]). +4. VNFM sends *InstantiateVnfResponse* with `lifecycleOperationOccurrenceId` to EM (see clause 7.2.3.3 [4]). +5. VNFM send a *Notify* (see clause 7.5.3 [4]), carrying `VnfLifecycleChangeNotification` information element to EM with attributes `vnfInstanceId`, `status = "start"`, `operation = "instantiation"`, `lifecycleOperationOccurrenceId`, `affectedVnfc`, `affectedVl`, and `affectedVirtualStorage` to indicate the start of VNF instantiation (see clause 9.5.1 [4]). + +- VNFM send a *Notify* (see clause 7.5.3 [4]), carrying *VnfLifecycleChangeNotification* information element to EM with attributes *vnfInstanceId*, *status* = "result", *operation* = "instantiation", *lifecycleOperationOccurrenceId*, *affectedVnfc*, *affectedVl*, and *affectedVirtualStorage* to indicate the result of VNF instantiation, when the VNF instantiation operation is completed (see clause 9.5.1 [4]). + +![Sequence diagram illustrating the VNF instantiation procedure between NM and NFVO. The sequence consists of four steps: 1. NM sends UpdateNsRequest - ModifyPnf to NFVO; 2. NFVO returns UpdateNsResponse to NM; 3. NFVO sends Notify - NsLifecycleChangeNotification (start) to NM; 4. NFVO sends Notify - NsIdentifierChangeNotification (result) to NM.](35a7554182eb055209552843f341a1ae_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. UpdateNsRequest - ModifyPnf + NFVO-->>NM: 2. UpdateNsResponse + NFVO-->>NM: 3. Notify - NsLifecycleChangeNotification (start) + NFVO-->>NM: 4. Notify - NsIdentifierChangeNotification (result) + +``` + +Sequence diagram illustrating the VNF instantiation procedure between NM and NFVO. The sequence consists of four steps: 1. NM sends UpdateNsRequest - ModifyPnf to NFVO; 2. NFVO returns UpdateNsResponse to NM; 3. NFVO sends Notify - NsLifecycleChangeNotification (start) to NM; 4. NFVO sends Notify - NsIdentifierChangeNotification (result) to NM. + +Figure 4.2.2.1-1: VNF instantiation procedure + +#### 4.2.2.2 VNF instantiation as part of NS update initiated through Os-Ma-nfvo + +Figure 4.2.2.2-1 depicts the procedure of instantiating a VNF instance as part of an NS update through the Os-Ma-nfvo reference point (see clause 7.3.5 [5]). + +- NM sends to NFVO an *UpdateNsRequest* with parameters *nsInstanceId*, *updateType* = "InstantiateVnf", *instantiateVnfData*, and *updateTime* to instantiate the VNF instance (see clause 7.3.5.2 [5]). The *instantiateVnfData* contains the parameters that are needed for VNF instantiation, including *vnfId*, *flavourId*, and can include in addition the parameters *instantiationLevelId*, *vnfInstanceName*, etc (see clause 8.3.4.12 [5]). +- NFVO sends to NM an *UpdateNsResponse* with parameter *lifecycleOperationOccurrenceId* providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.5.3 [5]). +- NFVO sends to NM a *Notify* (see clause 7.4.3 [5]), carrying *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "UpdateNs", and *notificationType* = "start" to indicate the start of the NS update that includes the VNF instantiation (see clause 8.3.2.2 [5]). +- NFVO sends to NM a *Notify* (see clause 7.4.3 [5]), carrying *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "UpdateNs", *notificationType* = "result" to indicate the end result of the NS update that includes the VNF instantiation, and *affectedVnf* providing information about the added VNF instance. The *affectedVnf* includes parameters *vnfInstanceId*, *vnfId*, *vnfProfileId*, *vnfName* and *changeType* = "instantiated" (see clauses 8.3.2.2 and 8.3.2.3 [5]). + +![Sequence diagram showing the interaction between NM and NFVO for VNF instantiation as part of NS update. The sequence is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM. The arrows for steps 3 and 4 are on the left side of the NM lifeline.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note right of NFVO: 1. UpdateNsRequest + NM->>NFVO: 1. UpdateNsRequest + Note right of NFVO: 2. UpdateNsResponse + NFVO-->>NM: 2. UpdateNsResponse + Note right of NFVO: 3. Notify + NFVO-->>NM: 3. Notify + Note right of NFVO: 4. Notify + NFVO-->>NM: 4. Notify + +``` + +Sequence diagram showing the interaction between NM and NFVO for VNF instantiation as part of NS update. The sequence is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM. The arrows for steps 3 and 4 are on the left side of the NM lifeline. + +**Figure 4.2.2.2-1: VNF instantiation as part of NS update initiated through Os-Ma-nfvo** + +#### 4.2.2.3 Provide IP address of the managing EM in VNF instantiation + +Figure 4.2.2.3-1 depicts a procedure of providing the IP address of the managing EM to the VNF in instantiation. As a result of this procedure, the new VNF instance is not associated to any NS (see NOTE in clause 7.2.3.4 in [4]). The figure uses UML notation to show multiple options available. + +1. EM sends *CreateVnfIdentifierRequest* with parameters `vnfId`, and optionally `vnfInstanceName` and `vnfInstanceDescription` to VNFM (see clause 7.2.2 [4]). +2. VNFM creates a new `VnfInfo` object +3. VNFM sends *CreateVnfIdentifierResponse* with the new VNF identifier to EM (see clause 7.2.2 [4]). + +If the Multi-vendor Plug and Play connection to the network method is not used and managing EM IP address is provided as VNF configuration data, the steps 4.1.1 through 4.1.4 are executed. + +- 4.1.1. EM sends *ModifyVnfConfigurationRequest* with parameters `vnfInstanceId`, `vnfConfigurationData`, `extVirtualLink` and `vnfcConfigurationData` to VNFM (see clause 7.6.2 [4]). The managing EM IP address value used in parameter `vnfConfigurationData`. +- 4.1.2. VNFM sets the `vnfConfigurationData` in the `VnfInfo` object. +- 4.1.3. VNFM sends *ModifyVnfConfigurationResponse* to EM (see clause 7.6.2 [4]). +- 4.1.4. EM sends *InstantiateVnfRequest* with parameters `vnfInstanceId`, `flavourId`, `instantiationLevelId`, `extVirtualLink`, `extManagedVirtualLink`, `localizationLanguage` and `additionalParam` to VNFM (see clause 7.2.3 [4]). +Note: The `extVirtualLink` may be known to the EM (e.g. provided by another entity). + +If the Multi-vendor Plug and Play connection to the network method is not used and managing EM IP address is provided as additional parameter for instantiation, the steps 4.2.1 through 4.2.3 are executed. + +- 4.2.1. EM sends *InstantiateVnfRequest* with parameters `vnfInstanceId`, `flavourId`, `instantiationLevelId`, `extVirtualLink`, `extManagedVirtualLink`, `localizationLanguage` and `additionalParam` to VNFM (see clause 7.2.3 [4]). The managing EM IP address value used in parameter `additionalParam`. +- 4.2.2. VNFM maps the managing EM IP address value received in parameter `additionalParam` of *InstantiateVnfRequest* to `vnfConfigurationData` (see Note 1). + +NOTE 1: the specific mechanism for this mapping (e.g. vendor specific LCM script or specific VNFM) is out of scope of 3GPP + +- 4.2.3. VNFM sets the `vnfConfigurationData` in the `VnfInfo` object. + +If the Multi-vendor Plug and Play connection to the network method is used to provide the managing EM IP address to VNF, step 4.3.1 is executed. + +- 4.3.1. EM sends *InstantiateVnfRequest* with parameters `vnfInstanceId`, `flavourId`, `instantiationLevelId`, `extVirtualLink`, `extManagedVirtualLink`, `localizationLanguage` and `additionalParam` to VNFM (see clause 7.2.3 [4]). +5. VNFM initiates the VNF instantiation process. +6. VNFM sends *InstantiateVnfResponse* with the new `lifecycleOperationOccurrenceId` to EM (see clause 7.2.3 [4]). +7. VNFM sends *SetInitialConfigurationRequest* with parameters `vnfInstanceId`, `vnfConfigurationData` and `vnfcConfigurationData` to VNF (see clause 6.2.2 [4]). +8. VNF sends *SetInitialConfigurationResponse* with parameters `vnfConfigurationData` and `vnfcConfigurationData` to VNFM (see clause 6.2.2 [4]). +9. If Multi-vendor Plug and Play connection to the network method is used to provide the managing EM IP address to VNF, VNF performs the EM discovery (see "Establishing connection to Element Manager" procedure in clause 5.5 of TS 32.508 [6]). +10. VNF connects to the managing EM. +11. "Normal" NE management by the EM over Type-1 interface (e.g. s/w update, configuration) begins. + +![Sequence diagram illustrating the procedure to provide the IP address of the managing EM in VNF instantiation. Lifelines: EM, VNFM, VnfInfo, VNF. The process involves creating a VNF identifier, configuring the VNF with the EM IP address (either as vnfConfigurationData or additionalParam), instantiating the VNF, and then performing normal NE management.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + participant VnfInfo + participant VNF + + Note left of EM: Error! No + Note right of VNFM: 11 + Note right of VnfInfo: Error! No text of specified style in + + EM->>VNFM: 1. CreateVnfIdentifierRequest() + VNFM-->>VnfInfo: 2. Create + VNFM-->>EM: 3. CreateVnfIdentifierResponse() + + alt MVPNP not used + alt EM IP Address provided as vnfConfigurationData + EM->>VNFM: 4.1.1 ModifyVnfConfigurationRequest(vnfConfigurationData=EM_IP_Addr) + VNFM-->>VnfInfo: 4.1.2 SetConfData + VNFM-->>EM: 4.1.3 ModifyVnfConfigurationResponse() + EM->>VNFM: 4.1.4 InstantiateVnfRequest() + else EM IP Address provided as additionalParam + EM->>VNFM: 4.2.1 InstantiateVnfRequest(additionalParam=EM_IP_Addr) + Note right of VNFM: ref 4.2.2 Map additionalParam value to vnfConfigurationData + VNFM-->>VnfInfo: 4.2.3 SetConfData + end + else MVPNP is used + EM->>VNFM: 4.3.1 InstantiateVnfRequest() + end + + VNFM-->>VNF: 5. Instantiate + VNFM-->>EM: 6. InstantiateVnfResponse() + VNFM->>VNF: 7. SetInitialConfigurationRequest() + VNF-->>VNFM: 8. SetInitialConfigurationResponse() + + opt MVPNP used + Note right of VNF: ref 9. MVPNP EM discovery + end + + VNF->>EM: 10. Connect + + Note right of EM: ref 11. "Normal" NE management by the EM over Type-1 interface (e.g. s/w update, configuration) + +``` + +Sequence diagram illustrating the procedure to provide the IP address of the managing EM in VNF instantiation. Lifelines: EM, VNFM, VnfInfo, VNF. The process involves creating a VNF identifier, configuring the VNF with the EM IP address (either as vnfConfigurationData or additionalParam), instantiating the VNF, and then performing normal NE management. + +**Figure 4.2.2.3-1: Provide IP address of the managing EM in VNF instantiation procedure** + +#### 4.2.2.4 Query VNF instance information through Ve-Vnfm-em + +Figure 4.2.2.4-1 depicts the procedure of querying VNF instance information through the Ve-Vnfm-em reference point (see clause 7.2.9 [4]). + +1. EM sends to VNFM a *QueryVnfRequest* with parameters *filter* and *attributeSelector* used to filter the VNF instance(s) and select the information attributes that are requested to be returned (see clause 7.2.9.2 [4]). +2. VNFM sends to EM a *QueryVnfResponse* with parameter *vnfInfo* providing the information that is selected according to parameters *filter* and *attributeSelector* (see clause 7.2.9.3 [4]). + +![Sequence diagram showing the interaction between EM and VNFM for querying VNF instance information. EM sends a QueryVnfRequest to VNFM, and VNFM returns a QueryVnfResponse.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note right of EM: 1. QueryVnfRequest + EM->>VNFM: QueryVnfRequest + Note left of VNFM: 2. QueryVnfResponse + VNFM-->>EM: QueryVnfResponse + +``` + +Sequence diagram showing the interaction between EM and VNFM for querying VNF instance information. EM sends a QueryVnfRequest to VNFM, and VNFM returns a QueryVnfResponse. + +Figure 4.2.2.4-1: Query VNF instance information through Ve-Vnfm-em + +### 4.2.3 VNF scaling + +#### 4.2.3.1 Scale VNF instance initiated by EM + +Figure 4.2.3.1-1 depicts a procedure of scaling VNF instance (see clause 7.2.8 [4]). + +1. EM sends *ScaleVnfRequest* with parameters `vnfInstanceId`, `type`, `aspectId`, and `numberOfSteps` to scale the VNF instance (see clause 7.2.8 [4]). +2. VNFM sends *ScaleVnfResponse* with the identifier of the VNF lifecycle operation occurrence `lifecycleOperationOccurrenceId` to EM (see clause 7.2.8). +3. VNFM send a *Notify* (see clause 7.5.3 [4]), carrying `VnfLifecycleChangeNotification` information element, to EM with attributes `vnfInstanceId`, `status = "start"`, `operation` to indicate the start of VNF scaling (see clause 9.5.1 [4]). +4. VNFM send a *Notify* (see clause 7.5.3 [4]), carrying `VnfLifecycleChangeNotification` information element, to EM with attributes `vnfInstanceId`, `status = "result"`, `operation` to indicate the result of VNF scaling, when the VNF scaling operation is completed (see clause 9.5.1 [4]). + +![Sequence diagram showing the procedure for scaling a VNF instance initiated by EM. EM sends a ScaleVnfRequest to VNFM, which responds with ScaleVnfResponse, followed by two Notify messages from VNFM to EM.](fbfa653853daf5541118a9ddecb92284_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note right of EM: 1. ScaleVnfRequest + EM->>VNFM: ScaleVnfRequest + Note left of VNFM: 2. ScaleVnfResponse + VNFM-->>EM: ScaleVnfResponse + Note left of VNFM: 3. Notify + VNFM-->>EM: Notify + Note left of VNFM: 4. Notify + VNFM-->>EM: Notify + +``` + +Sequence diagram showing the procedure for scaling a VNF instance initiated by EM. EM sends a ScaleVnfRequest to VNFM, which responds with ScaleVnfResponse, followed by two Notify messages from VNFM to EM. + +Figure 4.2.3.1-1: Scale VNF instance procedure + +#### 4.2.3.2. Scale VNF instance to a level initiated by EM + +Figure 4.2.3.2-1 depicts a procedure of scaling VNF instance to a level (see clause 7.2.9 [4]). + +1. EM sends *ScaleVnfToLevelRequest* with parameters `vnfInstanceId`, and (`instantiationLevelId` or `scaleInfo`) to scale the VNF instance to a level defined by `instantiationLevelId` or `scaleInfo` (see clause 7.2.9 [4]). +2. VNFM sends *ScaleVnfToLevelResponse* with the identifier of the VNF lifecycle operation occurrence `lifecycleOperationOccurrenceId` to EM (see clause 7.2.9 [4]). +3. VNFM send a *Notify* (see clause 7.5.3 [4]), carrying `VnfLifecycleChangeNotification` information element, to EM with attributes `vnfInstanceId`, `status = "start"`, `operation` to indicate the start of VNF scaling (see clause 9.5.1 [4]). + +4. VNFM send a *Notify* (see clause 7.5.3 [4]), carrying *VnfLifecycleChangeNotification* information element, to EM with attributes *vnfInstanceId*, *status* = "result", *operation* to indicate the result of VNF scaling, when the VNF scaling operation is completed (see clause 9.5.1 [4]). + +![Sequence diagram showing the interaction between EM and VNFM for scaling a VNF instance to a level. The steps are: 1. ScaleVnfToLevelRequest from EM to VNFM; 2. ScaleVnfToLevelResponse from VNFM to EM; 3. Notify from VNFM to EM; 4. Notify from VNFM to EM.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note left of EM: + EM->>VNFM: 1. ScaleVnfToLevelRequest + VNFM-->>EM: 2. ScaleVnfToLevelResponse + Note right of VNFM: + VNFM-->>EM: 3. Notify + Note right of VNFM: + VNFM-->>EM: 4. Notify + +``` + +Sequence diagram showing the interaction between EM and VNFM for scaling a VNF instance to a level. The steps are: 1. ScaleVnfToLevelRequest from EM to VNFM; 2. ScaleVnfToLevelResponse from VNFM to EM; 3. Notify from VNFM to EM; 4. Notify from VNFM to EM. + +Figure 4.2.3.2-1: Scale VNF instance to a level procedure + +#### 4.2.3.3 VNF scaling as part of NS scaling initiated through Os-Ma-nfvo + +Figure 4.2.3.3-1 depicts the procedure of scaling VNF instance for which the NM has selected the NS instance within which the subject VNF instance is intended to be scaled (see clause 7.3.4 [5]). + +1. NM sends to NFVO a *ScaleNsRequest* with parameters *nsInstanceId*, *scaleType* = "SCALE\_VNF", *scaleVnfData*, and *scaleTime* to scale the VNF instance(s) (see clause 7.3.5.2 [5]). The *scaleVnfData* contains the parameters that are needed for scaling a specific VNF instance, including among others *vnfInstanceId*, *type*, and either *scaleToLevelData* or *scaleByStepData* depending on the type of scaling (see clauses 8.3.4.9.2, 8.3.4.10 and 8.3.4.11 [5]). +2. NFVO sends to NM a *ScaleNsResponse* with parameter *lifecycleOperationOccurrenceId* providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.5.3 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "ScaleNs", and *notificationType* = "start" to indicate the start of the NS scaling that is being performed through specific VNF scaling (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "ScaleNs", *notificationType* = "result" to indicate the end result of the NS scaling performed through specific VNF scaling, and *affectedVnf* providing information about the scaled VNF instance(s), including *vnfInstanceId*, *vnfId*, *vnfProfileId*, *vnfName* and *changeType* = "scaled" (see clauses 8.3.2.2 and 8.3.2.3 [5]). + +![Sequence diagram showing the interaction between NM and NFVO for VNF scaling as part of NS scaling. The steps are: 1. ScaleNsRequest from NM to NFVO; 2. ScaleNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. ScaleNsRequest + NFVO-->>NM: 2. ScaleNsResponse + Note right of NFVO: + NFVO-->>NM: 3. Notify + Note right of NFVO: + NFVO-->>NM: 4. Notify + +``` + +Sequence diagram showing the interaction between NM and NFVO for VNF scaling as part of NS scaling. The steps are: 1. ScaleNsRequest from NM to NFVO; 2. ScaleNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM. + +Figure 4.2.3.3-1: VNF scaling as part of NS scaling initiated through Os-Ma-nfvo + +### 4.2.4 VNF instance termination + +#### 4.2.4.1 VNF termination by EM request + +Figure 4.2.4.1-1 depicts a procedure of VNF termination by EM request, when this VNF instance is not needed. The VNF instance has been instantiated (see NOTE in clause 7.2.3.4 in [8]) by the EM. It is assumed that EM has subscribed to receive the VNF lifecycle change notification from VNFM. The VNF instance identifier will be deleted after the VNF termination. + +1. EM sends *TerminateVnfRequest* to VNFM with *vnfInstanceId* to terminate the VNF instance (see clause 7.2.7 [4]). +2. VNFM sends *TerminateVnfResponse* with *lifecycleOperationOccurrenceId* to EM (see clause 7.2.7.3 [4]). +3. VNFM sends a *Notify* (see clause 7.5.3 [4]), carrying *VnfLifecycleChangeNotification* to EM with attributes *vnfInstanceId*, *status* = “start”, *operation* = “termination” to indicate the start of VNF termination (see clause 9.5.1 [4]). +4. VNFM sends a *Notify* (see clause 7.5.3 [4]), carrying *VnfLifecycleChangeNotification* to EM with attributes *vnfInstanceId*, *affectedVnfc*, *affectedVirtualLink*, *affectedVirtualStorage*, *status* = “result”, *operation* = “termination” to indicate the result of VNF termination, when the VNF termination operation is completed (see clause 9.5.1 [4]). +5. EM sends *DeleteVnfIdentifierRequest* to VNFM with *vnfInstanceId* to delete the VNF instance identifier (see clause 7.2.8 [4]). +6. VNFM sends a *Notify* (see clause 7.5.3 [4]), carrying *VnfIdentifierDeletionNotification* information element to EM with attributes *vnfInstanceId* (see clause 9.5.8 [4]). + +![Sequence diagram showing the VNF termination procedure between EM and VNFM. The steps are: 1. EM sends TerminateVnfRequest to VNFM; 2. VNFM sends TerminateVnfResponse to EM; 3. VNFM sends Notify to EM; 4. VNFM sends Notify to EM; 5. EM sends DeleteVnfIdentifierRequest to VNFM; 6. VNFM sends Notify to EM.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note left of EM: + EM->>VNFM: 1. TerminateVnfRequest + VNFM-->>EM: 2. TerminateVnfResponse + Note right of VNFM: + VNFM->>EM: 3. Notify + Note right of VNFM: + VNFM->>EM: 4. Notify + Note left of EM: + EM->>VNFM: 5. DeleteVnfIdentifierRequest + Note right of VNFM: + VNFM->>EM: 6. Notify + +``` + +Sequence diagram showing the VNF termination procedure between EM and VNFM. The steps are: 1. EM sends TerminateVnfRequest to VNFM; 2. VNFM sends TerminateVnfResponse to EM; 3. VNFM sends Notify to EM; 4. VNFM sends Notify to EM; 5. EM sends DeleteVnfIdentifierRequest to VNFM; 6. VNFM sends Notify to EM. + +Figure 4.2.4.1-1: VNF termination procedure + +#### 4.2.4.2 VNF termination by removing VNF instance from NS + +Figure 4.2.4.2-1 depicts the procedure of VNF termination by removing VNF instance from NS through Os-Ma-Nfvo reference point (see clause 7.3.5 of GS NFV-IFA013 [5]) + +1. NM sends to NFVO an *UpdateNsRequest* with parameter *nsInstanceId*, *updateType* = “RemoveVnf”, *RemoveVnfInstanceId* and *updateTime* to remove the VNF instance(s) from NS (see clause 7.2.2.2 of GS NFV-IFA013 [5]). The *RemoveVnfInstanceId* identifies the VNF instance to be removed from the NS. + +2. NFVO remove the target VNF instance and sends to NM an *UpdateNsResponse* with parameter `vnfInstanceId` and `lifecycleOperationOccurrenceId` providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.5.3 of GS NFV-IFA013 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 of GS NFV-IFA013 [5]) carrying an `NsLifecycleChangeNotification` information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation = "UpdateNs"` and `notificationType = "start"` to indicate the start of the NS updating that is being performed through removing specific VNF instance(s) (see clause 8.3.2.2 of GS NFV-IFA013[5]). +4. If the NFVO decides to terminate the NS instance, it sends to NM a *Notify* (see clause 7.4.3 of GS NFV-IFA013 [5]) carrying an `NsLifecycleChangeNotification` information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation = "UpdateNs"` and `notificationType = "result"` to indicate the end result of the NS updating performed through removing specific VNF(s) removal, and `affectedVnf` providing information about the removed VNF instance(s), including `vnfInstanceId`, `vnfdId`, `vnfProfileId`, `vnfName` and `changeType = "terminated"` (see clause 8.3.2.2 and 8.3.2.3 of GS NFV-IFA013 [5]). + +![Sequence diagram showing the procedures of VNF termination by removing VNF from NS instance. The diagram involves two participants: NM and NFVO. The sequence of messages is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM.](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. UpdateNsRequest + NM->>NFVO: 1. UpdateNsRequest + Note right of NFVO: 2. UpdateNsResponse + NFVO->>NM: 2. UpdateNsResponse + Note right of NFVO: 3. Notify + NFVO->>NM: 3. Notify + Note right of NFVO: 4. Notify + NFVO->>NM: 4. Notify + +``` + +Sequence diagram showing the procedures of VNF termination by removing VNF from NS instance. The diagram involves two participants: NM and NFVO. The sequence of messages is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM. + +**Figure 4.2.4.2-1 Procedures of VNF termination by removing VNF from NS instance** + +### 4.2.5 Notifications about VNF lifecycle changes + +Figure 4.2.5-1 depicts the procedure of notification on VNF instance lifecycle change notifications through the Ve-Vnfm-em reference point (see clause 7.3.3 [4]). + +1. VNFM sends to EM a *Notify* according to clause 7.3.3 in [4]. This operation sends to EM the notifications supported on the VNF lifecycle change notification interface. + +![Sequence diagram showing notifications about VNF lifecycle changes. The diagram involves two participants: EM and VNFM. The sequence of messages is: 1. Notify from VNFM to EM.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + Note right of VNFM: 1. Notify + VNFM->>EM: 1. Notify + +``` + +Sequence diagram showing notifications about VNF lifecycle changes. The diagram involves two participants: EM and VNFM. The sequence of messages is: 1. Notify from VNFM to EM. + +**Figure 4.2.5-1: Notifications about VNF lifecycle changes** + +The following notifications can be notified/sent by this operation: + +- `VnfLifecycleChangeNotification`. See clause 9.5.2 [4] with the list of attributes in the Table 9.5.2.3-1 [4]. +- `VnfInfoAttributeValueChangeNotification`. See clause 9.5.6 [4] with the list of attributes in the Table 9.5.6.3-1 [4]. +- `VnfIdentifierCreationNotification`. See clause 9.5.7 [4] with the list of attributes in the Table 9.5.7.3-1 [4]. +- `VnfIdentifierDeletionNotification`. See clause 9.5.8 [4] with the list of attributes in the Table 9.5.8.3-1 [4]. + +### 4.2.6 Autoscaling enabling/disabling + +#### 4.2.6.1 Autoscaling enabling/disabling initiated through Ve-Vnfm-em + +Figure 4.2.6.1-1 depicts the procedure of enabling/disabling the autoscaling of a VNF instance through the Ve-Vnfm-em reference point. + +1. EM sends to VNFM a *ModifyVnfConfigurationRequest* (see clause 7.6.2 [4]) with input parameter `vnfInstanceId`, `vnfConfigurationData.autoScalable = TRUE/FALSE` (see clause 7.1.12 [8]) for enabling/disabling the autoscaling. +2. VNFM sends to EM a *ModifyVnfConfigurationResponse* (see clause 7.6.2 [4]). +3. VNFM send a *Notify* (see clause 7.6.4 [4]), carrying `VnfConfigAttributeValueChangeNotification` information element, to EM with attributes `vnfInstanceId`, `changedConfig` to inform about the changed VNF configuration. (see clause 9.2.7 [4]). + +![Sequence diagram showing the procedure of enabling/disabling autoscaling initiated through Ve-Vnfm-em. The diagram shows two lifelines: EM and VNFM. The sequence of messages is: 1. EM sends a ModifyVnfConfigurationRequest to VNFM; 2. VNFM sends a ModifyVnfConfigurationResponse to EM; 3. VNFM sends a Notify message to EM.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` +sequenceDiagram + participant EM + participant VNFM + Note left of EM: + EM->>VNFM: 1. ModifyVnfConfigurationRequest + VNFM-->>EM: 2. ModifyVnfConfigurationResponse + VNFM-->>EM: 3. Notify +``` + +Sequence diagram showing the procedure of enabling/disabling autoscaling initiated through Ve-Vnfm-em. The diagram shows two lifelines: EM and VNFM. The sequence of messages is: 1. EM sends a ModifyVnfConfigurationRequest to VNFM; 2. VNFM sends a ModifyVnfConfigurationResponse to EM; 3. VNFM sends a Notify message to EM. + +Figure 4.2.6.1-1: Autoscaling enabling/disabling initiated through Ve-Vnfm-em + +#### 4.2.6.2 Autoscaling enabling/disabling through Os-Ma-nfvo + +For enabling/disabling the autoscaling initiated through Os-Ma-nfvo, the procedure in clause 4.4.5.3 of the present document about “Modifying VNF instance configuration through Os-Ma-nfvo” applies. The `vnfConfigurationData` contained in the `modifyVnfConfigData` parameter that is carried in the *UpdateNsRequest* of step 1 of the referred procedure provides the information for enabling/disabling the autoscaling of the corresponding VNF instance (refer to the `autoScalable` attribute of `VnfConfigurableProperties` in clause 7.1.12 in [8]). + +### 4.2.7 Subscribing to VNF lifecycle change notifications through Ve-Vnfm-em + +Figure 4.2.7-1 depicts the procedure of subscribing to VNF lifecycle change notifications through the Ve-Vnfm-em reference point (see clause 7.3.2 [4]). + +1. EM sends to VNFM a *SubscribeRequest* with input parameter `filter` for selecting the notifications, which can be on the VNF instance(s) of interest or other attributes of the notification (see clause 7.3.2.2 [4]). +2. VNFM sends to EM a *SubscribeResponse* with parameter `subscriptionId` providing the identifier of the subscription realized (see clause 7.3.2.3 [4]). + +![Sequence diagram showing the interaction between EM and VNFM for subscribing to VNF lifecycle change notifications. The EM sends a '1. SubscribeRequest' to the VNFM, and the VNFM responds with '2. SubscribeResponse'.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant EM + participant VNFM + EM->>VNFM: 1. SubscribeRequest + VNFM-->>EM: 2. SubscribeResponse + +``` + +Sequence diagram showing the interaction between EM and VNFM for subscribing to VNF lifecycle change notifications. The EM sends a '1. SubscribeRequest' to the VNFM, and the VNFM responds with '2. SubscribeResponse'. + +**Figure 4.2.7-1: Subscribing to VNF lifecycle change notifications through Ve-Vnfm-em** + +### 4.2.8 3GPP network function software update when application software is part of VNF Package and synchronization of VNF instance information is performed through Os-Ma-nfvo + +Figure 4.2.8-1 depicts the procedure of updating the application software of the virtualized 3GPP network function when the software is part of the VNF Package and the software update does not require a change of the VNF's underlying virtualised resources or internal VNFC(s) topology/composition. + +1. NM requests to EM to update the software, EM acts to update the software, and notifies to NM about the completion of the software update using the Software Management IRP [7]. +2. Once the NM confirms the normality of service of the 3GPP network function whose software has been updated, NM requests to NFVO to update the VNF instance information (see procedure in clause 4.4.5.2) capturing the information of the new VNF Package for the 3GPP network function whose software has been updated. + +![Sequence diagram showing the interaction between EM, NM, and NFVO. Step 1 involves NM requesting EM to update software. Step 2 involves NM requesting NFVO to modify VNF instance information.](43837b056625d3d6ce615e4c02f163bb_img.jpg) + +``` + +sequenceDiagram + participant EM + participant NM + participant NFVO + Note over EM, NM: 1. NM requests to EM to update the software, EM acts to update the software and notifies to NM about the completion of the software update. + Note over NM, NFVO: 2. Modification of VNF instance information corresponding to updated 3GPP network function + +``` + +Sequence diagram showing the interaction between EM, NM, and NFVO. Step 1 involves NM requesting EM to update software. Step 2 involves NM requesting NFVO to modify VNF instance information. + +**Figure 4.2.8-1: 3GPP network function application software update when application software is part of VNF Package and synchronization of VNF instance information is performed through Os-Ma-nfvo** + +## 4.3 VNF Package procedures + +### 4.3.1 VNF package on-boarding + +Figure 4.4-1 depicts a procedure of VNF package on-boarding, + +1. NM sends *OnboardVnfPackageRequest* to NFVO with input parameters listed in clause 7.7.2.2 [5] to on-board a VNF package (see clause 7.7.2 [5]). +2. NFVO sends *OnboardVnfPackageResponse* to NM with *vnfPackageId* to indicate a VNF package has been on-boarded (see clause 7.7.2.3 [5]). + +![Sequence diagram for VNF package on-boarding procedure between NM and NFVO. Step 1: NM sends OnboardVnfPackageRequest to NFVO. Step 2: NFVO sends OnboardVnfPackageResponse to NM.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. OnboardVnfPackageRequest + NFVO-->>NM: 2. OnboardVnfPackageResponse + +``` + +Sequence diagram for VNF package on-boarding procedure between NM and NFVO. Step 1: NM sends OnboardVnfPackageRequest to NFVO. Step 2: NFVO sends OnboardVnfPackageResponse to NM. + +Figure 4.4-1: VNF package on-boarding procedure + +### 4.3.2 VNF Package enabling + +Figure 4.3.2-1 depicts the procedure of VNF package enabling. + +1. NM sends *EnableVnfPackageRequest* to NFVO with parameter *onboardedVnfPkgInfoId* to enable a VNF package (see clause 7.7.3.2 of GS NFV-IFA013 [5]). +2. NFVO sends *EnableVnfPackageResponse* to NM (see clause 7.7.3.3 of GS NFV-IFA013 [5]). +3. NFVO sends to NFVO a *Notify* (see clause 7.7.8 of GS NFV-IFA013 [5]) carrying *VnfPackageChangeNotification*, information element with attribute *onboardedVnfPkgInfoId*, *vnfId* and *operationalState* = “Enabled” to indicate the VNF package enabling (see clause 8.6.9 of GS NFV-IFA013 [5]) + +![Sequence diagram for VNF package enabling procedures. Step 1: NM sends EnableVnfPackageRequest to NFVO. Step 2: NFVO sends EnableVnfPackageResponse to NM. Step 3: NFVO sends Notify to itself.](51db757d054ce1ce83c436a3578b56ca_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. EnableVnfPackageRequest + NFVO-->>NM: 2. EnableVnfPackageResponse + NFVO->>NFVO: 3. Notify + +``` + +Sequence diagram for VNF package enabling procedures. Step 1: NM sends EnableVnfPackageRequest to NFVO. Step 2: NFVO sends EnableVnfPackageResponse to NM. Step 3: NFVO sends Notify to itself. + +Figure 4.3.2-1 Procedures of VNF package enabling + +### 4.3.3 VNF Package disabling + +Figure 4.3.3-1 depicts the procedure of VNF Package disabling. + +1. NM sends *DisableVnfPackageRequest* to NFVO with *onboardedVnfPkgInfoId* to disable a previously enabled VNF Package instance, preventing further use for instantiation of new VNF instances with this package (unless and until the VNF Package is re-enabled) (see clause 7.7.4 [5]). +2. NFVO sends *DisableVnfPackageResponse* to NM to indicate the result of the operation (see clause 7.7.4.4 [5]). + +![Sequence diagram for VNF Package disabling procedure. Step 1: NM sends DisableVnfPackageRequest to NFVO. Step 2: NFVO sends DisableVnfPackageResponse to NM.](7b8b192e2853ef28d28eff0241ebe86b_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. DisableVnfPackageRequest + NFVO-->>NM: 2. DisableVnfPackageResponse + +``` + +Sequence diagram for VNF Package disabling procedure. Step 1: NM sends DisableVnfPackageRequest to NFVO. Step 2: NFVO sends DisableVnfPackageResponse to NM. + +Figure 4.3.3-1: VNF Package disabling procedure + +### 4.3.4 VNF Package deleting + +Figure 4.3.4-1 depicts the procedure of VNF Package deleting. + +1. NM sends *DeleteVnfPackageRequest* to NFVO with *onboardedVnfPkgInfoId* to delete a VNF Package (see clause 7.7.5 [5]). +2. NFVO sends *DeleteVnfPackageResponse* to NM to indicate the result of the operation (see clause 7.7.5.4 [5]). + +![Sequence diagram for VNF Package deleting procedure between NM and NFVO. Step 1: NM sends OnboardNsdRequest to NFVO. Step 2: NFVO sends OnboardNsdResponse to NM. Step 3: NFVO sends Notify to NM.](10781f43062bf3e9601a1e086710556c_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. OnboardNsdRequest + NFVO-->>NM: 2. OnboardNsdResponse + NFVO-->>NM: 3. Notify + +``` + +Sequence diagram for VNF Package deleting procedure between NM and NFVO. Step 1: NM sends OnboardNsdRequest to NFVO. Step 2: NFVO sends OnboardNsdResponse to NM. Step 3: NFVO sends Notify to NM. + +Figure 4.3.4-1: VNF Package deleting procedure + +### 4.3.5 Abort VNF package deletion + +Figure 4.3.5-1 depicts the procedure to abort deletion of a VNF Package that is in deletion pending state. + +1. NM sends *AbortPackageDeletionRequest* to NFVO with *onboardedVnfPkgInfoId* to delete a VNF Package (see clause 7.7.12 [5]). +2. NFVO sends *AbortPackageDeletionResponse* to NM to indicate the result of the operation (see clause 7.7.12.4 [5]). + +![Sequence diagram for Abort VNF Package deletion procedure between NM and NFVO. Step 1: NM sends EnableNsdRequest to NFVO. Step 2: NFVO sends EnableNsdResponse to NM. Step 3: NFVO sends Notify to NM.](04f51626e2e10a16e3eb2c4b33cb2742_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. EnableNsdRequest + NFVO-->>NM: 2. EnableNsdResponse + NFVO-->>NM: 3. Notify + +``` + +Sequence diagram for Abort VNF Package deletion procedure between NM and NFVO. Step 1: NM sends EnableNsdRequest to NFVO. Step 2: NFVO sends EnableNsdResponse to NM. Step 3: NFVO sends Notify to NM. + +Figure 4.3.5-1: Abort VNF Package deletion procedure + +### 4.3.6 VNF Package querying + +Figure 4.3.6-1 depicts a procedure to query from the NFVO for information it has stored about one or more VNF Packages. + +1. NM sends *QueryOnboardedVnfPkgInfoRequest* to NFVO with *filter* and *attributeSelector* used to filter the VNF Packages on which the query applies, based on the attributes of *OnboardedVnfPkgInfo* and select the information attributes of *OnboardedVnfPkgInfo* that are requested to be returned (see clause 7.7.6 [5]). +2. NFVO sends *QueryOnboardedVnfPkgInfoResponse* to NM with parameter *queryResult* providing the information that is selected according to parameters *filter* and *attributeSelector* (see clause 7.7.6.4 [5]). + +![Sequence diagram for VNF Package querying procedure between NM and NFVO. Step 1: NM sends DisableNsdRequest to NFVO. Step 2: NFVO sends DisableNsdResponse to NM. Step 3: NFVO sends Notify to NM.](61a1c017e34df13360be6319539570df_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. DisableNsdRequest + NFVO-->>NM: 2. DisableNsdResponse + NFVO-->>NM: 3. Notify + +``` + +Sequence diagram for VNF Package querying procedure between NM and NFVO. Step 1: NM sends DisableNsdRequest to NFVO. Step 2: NFVO sends DisableNsdResponse to NM. Step 3: NFVO sends Notify to NM. + +Figure 4.3.6-1: VNF Package querying procedure + +### 4.3.7 Fetch VNF Package + +Figure 4.3.7-1 depicts a procedure to fetch from the NFVO a whole VNF Package based on the VNFD identifier that has been assigned by the VNF Provider. + +NOTE 1: In cases where NM already knows the value of `onboardedVnfPkgInfoId` for the VNF Package it wishes to fetch, it may skip the steps 1 and 2 below (execution of procedure begins at step 3). + +1. NM sends *QueryOnboardedVnfPkgInfoRequest* to NFVO with `filter` parameter set to VNFD identifier that has been assigned by the VNF Provider and `attributeSelector` set to `OnboardedVnfPkgId` (see clause 7.7.6 [5]). +2. NFVO sends *QueryOnboardedVnfPkgInfoResponse* to NM with parameter `queryResult` providing the `OnboardedVnfPkgId` identifier allocated by NFVO to the corresponding VNF package (see clause 7.7.6.4 [5]). +3. NM sends *FetchOnboardedVnfPackageRequest* to NFVO with `onboardedVnfPkgInfoId` parameter identifying the VNF Package to fetch (see clause 7.7.10 [5]). +4. NFVO sends *FetchOnboardedVnfPackageResponse* to NM with the `vnfPackage` requested (see clause 7.7.10.4 [5]). + +![Sequence diagram for Fetch VNF Package procedure. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. NM sends DeleteNsdRequest to NFVO; 2. NFVO sends DeleteNsdResponse to NM; 3. NFVO sends Notify to NM.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: Fetch VNF Package procedure + NM->>NFVO: 1. DeleteNsdRequest + NFVO-->>NM: 2. DeleteNsdResponse + NFVO-->>NM: 3. Notify + +``` + +Sequence diagram for Fetch VNF Package procedure. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. NM sends DeleteNsdRequest to NFVO; 2. NFVO sends DeleteNsdResponse to NM; 3. NFVO sends Notify to NM. + +Figure 4.3.7-1: Fetch VNF Package procedure + +### 4.3.8 Notify operation on VNF Package management interface + +Figure 4.3.8-1 depicts the procedure of notification on VNF package management interface. + +1. NFVO sends *Notify* message to NM per 7.7.8 [5]. This operation sends to NM the notifications supported on the VNF Package management interface. To receive notifications, the NM performs an explicit *Subscribe* operation beforehand (see clause 7.7.11 [5]). + +![Sequence diagram for Notify operation on VNF Package management interface procedure. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. NM sends UpdateNsdRequest to NFVO; 2. NFVO sends UpdateNsdResponse to NM; 3. NFVO sends Notify to NM.](cd141897aa368dbbaa398ace230cdd85_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: Notify operation on VNF Package management interface procedure + NM->>NFVO: 1. UpdateNsdRequest + NFVO-->>NM: 2. UpdateNsdResponse + NFVO-->>NM: 3. Notify + +``` + +Sequence diagram for Notify operation on VNF Package management interface procedure. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. NM sends UpdateNsdRequest to NFVO; 2. NFVO sends UpdateNsdResponse to NM; 3. NFVO sends Notify to NM. + +Figure 4.3.8-1: Notify operation on VNF Package management interface procedure + +The following notification can be notified/sent by this operation: + +- *VnfPackageOnBoardingNotification*. See clause 8.6.8 [5] with the list of attributes in the Table 8.6.8.3-1 [5]. +- *VnfPackageChangeNotification*. See clause 8.6.9 [5] with the list of attributes in the Table 8.6.9.3-1 [5]. + +### 4.3.9 Subscribe operation on VNF Package management interface + +Figure 4.3.9-1 depicts a procedure to subscribe for notifications on VNF package management interface. + +1. NM sends *SubscribeRequest* to NFVO with `inputFilter` selecting the VNF Package(s) and the related change notifications to subscribe to. This filter can contain information about specific types of changes to subscribe to, or attributes of the VNF Package (see clause 7.7.7 [5]). +2. NFVO sends *SubscribeResponse* to NM with the list of `subscriptionId` identifier of the subscription realized (see clause 7.7.7.4 [5]). + +![Sequence diagram for Figure 4.3.9-1: Subscribe operation on VNF Package management interface procedure. The diagram shows two lifelines, NM and NFVO. Step 1: NM sends a 'SubscribeRequest' message to NFVO. Step 2: NFVO sends a 'SubscribeResponse' message back to NM.](a3472689858b068ef469213682965325_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note left of NM: 1. SubscribeRequest + NM->>NFVO: 1. SubscribeRequest + Note right of NFVO: 2. SubscribeResponse + NFVO-->>NM: 2. SubscribeResponse +``` + +Sequence diagram for Figure 4.3.9-1: Subscribe operation on VNF Package management interface procedure. The diagram shows two lifelines, NM and NFVO. Step 1: NM sends a 'SubscribeRequest' message to NFVO. Step 2: NFVO sends a 'SubscribeResponse' message back to NM. + +Figure 4.3.9-1: Subscribe operation on VNF Package management interface procedure + +### 4.3.10 Fetch on-boarded VNF Package artifacts + +Figure 4.3.10-1 depicts a procedure to fetch from the NFVO selected artifacts contained in an on-boarded VNF package. + +1. NM sends *FetchOnboardedVnfPackageArtifactsRequest* to NFVO with `onboardedVnfPkgInfoId` parameter identifying specific on-boarded VNF Package and `artifactAccessInformation` parameter listing individual package artifacts to fetch (see clause 7.7.11 [5]). +2. NFVO sends *FetchOnboardedVnfPackageArtifactsResponse* to NM with the list of `vnfPackageArtifact` (e.g. files) requested (see clause 7.7.11.4 [5]). + +![Sequence diagram for Figure 4.3.10-1: Fetch on-boarded VNF Package artifacts procedure. The diagram shows two lifelines, NM and NFVO. Step 1: NM sends a 'FetchOnboardedVnfPackageArtifactsRequest' message to NFVO. Step 2: NFVO sends a 'FetchOnboardedVnfPackageArtifactsResponse' message back to NM.](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note left of NM: 1. FetchOnboardedVnfPackageArtifactsRequest + NM->>NFVO: 1. FetchOnboardedVnfPackageArtifactsRequest + Note right of NFVO: 2. FetchOnboardedVnfPackageArtifactsResponse + NFVO-->>NM: 2. FetchOnboardedVnfPackageArtifactsResponse +``` + +Sequence diagram for Figure 4.3.10-1: Fetch on-boarded VNF Package artifacts procedure. The diagram shows two lifelines, NM and NFVO. Step 1: NM sends a 'FetchOnboardedVnfPackageArtifactsRequest' message to NFVO. Step 2: NFVO sends a 'FetchOnboardedVnfPackageArtifactsResponse' message back to NM. + +Figure 4.3.10-1: Fetch on-boarded VNF Package artifacts procedure + +## 4.4 NS Instance procedures + +### 4.4.1 NS Instance instantiation + +Figure 4.4.1-1 depicts the procedure of an NS instantiation initiated through the Os-Ma-nfvo reference point (see clause 7.3.3 [5]). The procedure includes the steps of creating first the corresponding NS instance identifier. + +1. NM sends to NFVO a *CreateNsIdentifierRequest* with parameters `nsId`, `nsName`, and `nsDescription` to create an NS instance identifier (`nsInstanceId`) and an associated instance of an `NsInfo` information element (see clause 7.3.2.2 [5]). +2. NFVO sends to NM a *CreateNsIdentifierResponse* with parameter `nsInstanceId` identifying the instance of the NS that has been created (see clause 7.3.2.3 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.4.3 [5]) carrying `NsIdentifierCreationNotification` information element with attribute `nsInstanceId` to indicate the NS instance identifier creation (see clause 8.3.2.9 [5]). +4. NM sends to NFVO an *InstantiateNsRequest* with parameters `nsInstanceId` and `flavourId`. Additional parameters can be provided including `sapData`, `pnfInfo`, `locationConstraints`, `additionalParamsForNs`, `additionalParamForVnf`, `startTime`, + +nsInstantiationLevelId, and additionalAffinityOrAntiAffinityRule. In addition, if the NS instantiation includes reusing existing VNF instances and/or NS instances, parameters vnfInstanceData and nestedNsInstanceId are provided, respectively. See clause 7.3.3.2 [5]. + +5. NFVO sends to NM an *InstantiateNsResponse* with parameter lifecycleOperationOccurrenceId providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.3.3 [5]). +6. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "NsInstantiation", and notificationType = "start" to indicate the start of the NS instantiation (see clause 8.3.2.2 [5]). +7. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "NsInstantiation", and notificationType = "result" to indicate the end result of the NS instantiation. According to the results of the NS instantiation, additional information is provided in the notification with parameters affectedVnf, affectedPnf, affectedVl, affectedVnffg, affectedNs and affectedSap (see clause 8.3.2.2 [5]). + +![Sequence diagram showing the interaction between NM and NFVO for NS instantiation. The sequence is: 1. CreateNsIdentifierRequest (NM to NFVO), 2. CreateNsIdentifierResponse (NFVO to NM), 3. Notify (NFVO to NM), 4. InstantiateNsRequest (NM to NFVO), 5. InstantiateNsResponse (NFVO to NM), 6. Notify (NFVO to NM), 7. Notify (NFVO to NM).](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note right of NFVO: 1. CreateNsIdentifierRequest + NM->>NFVO: + Note right of NFVO: 2. CreateNsIdentifierResponse + NFVO->>NM: + Note right of NFVO: 3. Notify + NFVO->>NM: + Note right of NM: 4. InstantiateNsRequest + NM->>NFVO: + Note right of NFVO: 5. InstantiateNsResponse + NFVO->>NM: + Note right of NFVO: 6. Notify + NFVO->>NM: + Note right of NFVO: 7. Notify + NFVO->>NM: + +``` + +Sequence diagram showing the interaction between NM and NFVO for NS instantiation. The sequence is: 1. CreateNsIdentifierRequest (NM to NFVO), 2. CreateNsIdentifierResponse (NFVO to NM), 3. Notify (NFVO to NM), 4. InstantiateNsRequest (NM to NFVO), 5. InstantiateNsResponse (NFVO to NM), 6. Notify (NFVO to NM), 7. Notify (NFVO to NM). + +Figure 4.4.1-1: NS instantiation + +### 4.4.2 NS Instance termination + +Figure 4.4.2-1 depicts the procedure of an NS instance termination initiated through the Os-Ma-Nfvo reference point (see clause 7.3.7 [5]). + +1. NM sends to NFVO a *TerminateNsRequest* with parameter nsInstanceId and terminateTime (see clause 7.3.7 [5]). +2. NFVO sends to NM a *TerminateNsResponse* with parameter lifecycleOperationOccurrenceId providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.7.3 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "TerminationNs", and "notificationType" = "start" to indicate the start of the NS termination (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, + +operation = “TerminationNs”, and notificationType = “result” to indicate the end result of the NS termination (see clause 8.3.2.2 [5]). + +![Sequence diagram for NS instance termination between NM and NFVO. The sequence is: 1. TerminiateNsRequest (NM to NFVO), 2. TerminiateNsResponse (NFVO to NM), 3. Notify (NFVO to NM), 4. Notify (NFVO to NM).](844077b3034f0030b404207db0ad76b4_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. TerminiateNsRequest + NFVO-->>NM: 2. TerminiateNsResponse + NFVO-->>NM: 3. Notify + NFVO-->>NM: 4. Notify + +``` + +Sequence diagram for NS instance termination between NM and NFVO. The sequence is: 1. TerminiateNsRequest (NM to NFVO), 2. TerminiateNsResponse (NFVO to NM), 3. Notify (NFVO to NM), 4. Notify (NFVO to NM). + +**Figure 4.4.2-1: NS instance termination** + +### 4.4.3 NS Instance querying + +#### 4.4.3.1 Query NS instance information through Os-Ma-nfvo + +Figure 4.4.3.1-1 depicts the procedure of NS querying through the Os-Ma-nfvo reference point (see clause 7.3.6 in [5]) used also to query information about the constituents of the NS instance, including VNF instances. + +1. NM sends to NFVO a *QueryNsRequest* with parameters `filter` and `attributeSelector` used to filter the NS instances on which the query applies, based on attributes of the NS instance and select the information attributes that are requested to be returned (see clause 7.3.6.2 [5]). + +In particular, the `filter` can be set to select certain VNF instances(s) that are part of an NS, by providing their identifiers with the `attributeSelector` set to select certain attributes of the VNF instances. + +2. NFVO sends to NM a *QueryNsResponse* with parameter `queryNsResult` providing the information that is selected according to parameters `filter` and `attributeSelector` (see clause 7.3.6.3 [5]). + +![Sequence diagram for NS instance querying through Os-Ma-nfvo between NM and NFVO. The sequence is: 1. QueryNsRequest (NM to NFVO), 2. QueryNsResponse (NFVO to NM).](2119293733c74fc64de88aefd597f4bb_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. QueryNsRequest + NFVO-->>NM: 2. QueryNsResponse + +``` + +Sequence diagram for NS instance querying through Os-Ma-nfvo between NM and NFVO. The sequence is: 1. QueryNsRequest (NM to NFVO), 2. QueryNsResponse (NFVO to NM). + +**Figure 4.4.3.1-1: Query NS instance information through Os-Ma-nfvo** + +### 4.4.4 NS Instance scaling + +Figure 4.4.4-1 depicts a procedure for NS Instance scaling. Scaling an NS instance can be performed by explicitly adding/removing existing VNF instances to/from the NS instance, by leveraging on the abstraction mechanism provided by the NS scaling aspects and NS levels information elements declared in the NSD or by scaling individual VNF instances (as described by the Use Case 6.4.3.4 in [3]) that are part of the NS itself. When adding VNFs and nested NSs - already existing or not - to the NS to be scaled, the NFVO shall follow the indications provided by the dependencies attribute, as specified in the corresponding NSD. + +1. NM sends *ScaleNsRequest* to NFVO with `nsInstanceId` parameter identifying the NS Instance being scaled, `scaleType` parameter with possible values [SCALE\_NS, SCALE\_VNF] indicating the type of scaling to be performed, list of `scaleNsData` providing necessary scale information when `scaleType` = SCALE\_NS or list of `scaleVnfData` providing necessary scale information when `scaleType` = SCALE\_VNF and `scaleTime` indicating the scale time of the NS if it's not expected to start immediately (see clause 7.3.4 [5]). +2. NFVO sends *ScaleNsResponse* to NM with the `lifecycleOperationOccurrenceId` identifier of the NS lifecycle operation occurrence (see clause 7.3.4.4 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an `NsLifecycleChangeNotification` information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation` = "ScaleNs", and `notificationType` = "start" to indicate the start of the NS scale (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an `NsLifecycleChangeNotification` information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation` = "ScaleNs", `notificationType` = "result" to indicate the result of NS scale. Per the changes in the NS instance performed because of the NS scale, additional information is provided in the notification with parameters `affectedVnf`, `affectedPnf`, `affectedVl`, `affectedVnffg`, `affectedNs` and `affectedSap` (see clause 8.3.2.2 [5]). + +![Sequence diagram showing the NS Instance scaling procedure between NM and NFVO. NM sends an UpdatePnfdRequest to NFVO, and NFVO responds with an UpdatePnfdResponse.](4b87467ad9642943235f48f7d4b59449_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. UpdatePnfdRequest + NFVO-->>NM: 2. UpdatePnfdResponse + +``` + +Sequence diagram showing the NS Instance scaling procedure between NM and NFVO. NM sends an UpdatePnfdRequest to NFVO, and NFVO responds with an UpdatePnfdResponse. + +Figure 4.4.4-1: NS Instance scaling procedure + +### 4.4.5 NS Instance updating + +#### 4.4.5.1 NS update to associate an NS instance to a different NSD version + +Figure 4.4.5.1-1 depicts the procedure of NS update to associate an NS instance to a different NSD version. + +1. NM sends to NFVO an *UpdateNsRequest* with parameters `nsInstanceId`, `updateType` = "AssociateNewNsdVersion", `assocNewNsdVersionData`, and `updateTime` to associate a new NSD version to the NS instance (see clause 7.3.5.2 [5]). The `assocNewNsdVersionData` contains the parameter `newNsdId`, and can include in addition the parameter `sync` to indicate whether the NS instance should be automatically synchronized to the new NSD by the NFVO. +2. NFVO sends to NM an *UpdateNsResponse* with parameter `lifecycleOperationOccurrenceId` providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.5.3 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an `NsLifecycleChangeNotification` information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation` = "UpdateNs", and `notificationType` = "start" to indicate the start of the NS update (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an `NsLifecycleChangeNotification` information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation` = "UpdateNs", `notificationType` = "result" to indicate the end result of NS update. According to the changes in the NS instance performed as a result of the NS update, additional information is + +provided in the notification with parameters *affectedVnf*, *affectedPnf*, *affectedVl*, *affectedVnffg*, *affectedNs* and *affectedSap* (see clause 8.3.2.2 [5]). + +![Sequence diagram for NS update to associate an NS instance to a different NSD version. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM.](e354b57563dae469c00b412b2abdf765_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. UpdateNsRequest + NM->>NFVO: 1. UpdateNsRequest + Note right of NFVO: 2. UpdateNsResponse + NFVO->>NM: 2. UpdateNsResponse + Note right of NFVO: 3. Notify + NFVO->>NM: 3. Notify + Note right of NFVO: 4. Notify + NFVO->>NM: 4. Notify + +``` + +Sequence diagram for NS update to associate an NS instance to a different NSD version. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM. + +Figure 4.4.5.1-1: NS update to associate an NS instance to a different NSD version + +#### 4.4.5.2 Modifying VNF instance information through Os-Ma-nfvo + +Figure 4.4.5.2-1 depicts the procedure of modifying VNF instance information through the Os-Ma-nfvo reference point (see clause 7.3.5 [5]). + +1. NM sends to NFVO an *UpdateNsRequest* with parameters *nsInstanceId*, *updateType* = "ModifyVnfInformation", *modifyVnfInfoData*, and *updateTime* to modify the VNF instance information (see clause 7.3.5.2 [5]). The *modifyVnfInfoData* contains the parameters that are needed for VNF instance information modification, namely *vnfInstanceId*, and list of *newValues* (see clause 8.3.4.17 [5]). +2. NFVO sends to NM an *UpdateNsResponse* with parameter *lifecycleOperationOccurrenceId* providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.5.3 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "UpdateNs", and *notificationType* = "start" to indicate the start of the NS update that includes the VNF instance information modification (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "UpdateNs", *notificationType* = "result" to indicate the end result of NS update that includes the VNF instance information modification, and *affectedVnf* providing information about the VNF instance whose information has been modified, including *vnfInstanceId*, *vnfId*, *vnfProfileId*, *vnfName* and *changeType* = "information modified" (see clauses 8.3.2.2 and 8.3.2.3 [5]). + +![Sequence diagram for modifying VNF instance information through Os-Ma-nfvo. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM.](ea4fd10a9a501c602f2bea0f7f711877_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. UpdateNsRequest + NM->>NFVO: 1. UpdateNsRequest + Note right of NFVO: 2. UpdateNsResponse + NFVO->>NM: 2. UpdateNsResponse + Note right of NFVO: 3. Notify + NFVO->>NM: 3. Notify + Note right of NFVO: 4. Notify + NFVO->>NM: 4. Notify + +``` + +Sequence diagram for modifying VNF instance information through Os-Ma-nfvo. The diagram shows two lifelines: NM and NFVO. The sequence of messages is: 1. UpdateNsRequest from NM to NFVO; 2. UpdateNsResponse from NFVO to NM; 3. Notify from NFVO to NM; 4. Notify from NFVO to NM. + +Figure 4.4.5.2-1: Modifying VNF instance information through Os-Ma-nfvo + +#### 4.4.5.3 Modifying VNF instance configuration through Os-Ma-nfvo + +Figure 4.4.5.3-1 depicts the procedure of modifying VNF instance configuration through the Os-Ma-nfvo reference point (see clause 7.3.5 [5]). + +1. NM sends to NFVO an *UpdateNsRequest* with parameters nsInstanceId, updateType = "ModifyVnfConfig", modifyVnfConfigData, and updateTime to modify the VNF instance configuration (see clause 7.3.5.2 [5]). The modifyVnfConfigData contains the parameters that are needed for VNF instance configuration modification, namely vnfInstanceId, list of vnfConfigurationData and list of extVirtualLink (see clause 8.3.4.18 [5]). +2. NFVO sends to NM an *UpdateNsResponse* with parameter lifecycleOperationOccurrenceId providing the identifier of the NS lifecycle operation occurrence (see clause 7.3.5.3 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "UpdateNs", and notificationType = "start" to indicate the start of the NS update that includes the VNF instance configuration modification (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "UpdateNs", notificationType = "result" to indicate the end result of the NS update that includes the VNF instance configuration modification, and affectedVnf providing information about the modified VNF instance whose configuration has been modified, including vnfInstanceId, vnfId, vnfProfileId, vnfName and changeType = "configuration modified" (see clauses 8.3.2.2 and 8.3.2.3 [5]). + +![Sequence diagram showing the interaction between NM and NFVO for modifying VNF instance configuration. The sequence consists of four steps: 1. NM sends UpdateNsRequest to NFVO; 2. NFVO sends UpdateNsResponse to NM; 3. NFVO sends Notify (start) to NM; 4. NFVO sends Notify (result) to NM.](392a79ccd95e682ccd08f35ab2e64144_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: 1. UpdateNsRequest + NM->>NFVO: 1. UpdateNsRequest + Note right of NFVO: 2. UpdateNsResponse + NFVO->>NM: 2. UpdateNsResponse + Note right of NFVO: 3. Notify + NFVO->>NM: 3. Notify + Note right of NFVO: 4. Notify + NFVO->>NM: 4. Notify + +``` + +Sequence diagram showing the interaction between NM and NFVO for modifying VNF instance configuration. The sequence consists of four steps: 1. NM sends UpdateNsRequest to NFVO; 2. NFVO sends UpdateNsResponse to NM; 3. NFVO sends Notify (start) to NM; 4. NFVO sends Notify (result) to NM. + +Figure 4.4.5.3-1: Modifying VNF instance configuration through Os-Ma-nfvo + +#### 4.4.5.4 NS update to add a PNF to the NS instance + +Figure 4.4.5.4-1 depicts the procedure of NS update to add a PNF to the NS instance (see clause 7.3.5 [5]). It is assumed that the PNFD of the PNF to be added has been on-boarded, and the NS where the PNF instances are to be added has been instantiated. + +1. NM sends to NFVO an *UpdateNsRequest* (see clause 7.3.5 of [5]) with the following parameters (see clause 7.3.5.2 of [5]) to on-board the NSD: + - nsInstanceId: the identifier of the NS instance being updated. + - updateType = "AddPnf" to indicate the type of update operation. + - addPnfData: the PNF information that contain the following attributes (see clause 8.3.4.32.2 of [5]): + - > pnfId: the identifier of the PNF; + - > pnfName: human readable name of the PNF; + +- > pnfdId: identifier (reference to) the PNFD related to this PNF; + - > pnfProfileId: identifier (reference to) the PNF Profile to be used for this PNF; + - > cpData: information of the external CP of the PNF. +2. NFVO sends to NM an *UpdateNsResponse* (see clause 7.3.5 of [5]) with the attribute *lifecycleOperationOccurrenceId* that is the identifier of the NS lifecycle operation occurrence. + 3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation = "NsUpdate"*, and *notificationType = "start"* to indicate the start of the NS instantiation (see clause 8.3.2.2 [5]). + 4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation = "NsUpdate"*, and *notificationType = "result"* to indicate the end result of the NS instantiation (see clause 8.3.2.2 [5]). + +![Sequence diagram showing the interaction between NM and NFVO for NS update to add a PNF. The sequence is: 1. NM sends UpdateNsRequest - AddPnf to NFVO; 2. NFVO sends UpdateNsResponse to NM; 3. NFVO sends Notify - NsLifecycleChangeNotification (start) to NM; 4. NFVO sends Notify - NsIdentifierChangeNotification (result) to NM.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: Add PNF to NS instance + NM->>NFVO: 1. UpdateNsRequest - AddPnf + NFVO-->>NM: 2. UpdateNsResponse + NFVO-->>NM: 3. Notify - NsLifecycleChangeNotification (start) + NFVO-->>NM: 4. Notify - NsIdentifierChangeNotification (result) + +``` + +Sequence diagram showing the interaction between NM and NFVO for NS update to add a PNF. The sequence is: 1. NM sends UpdateNsRequest - AddPnf to NFVO; 2. NFVO sends UpdateNsResponse to NM; 3. NFVO sends Notify - NsLifecycleChangeNotification (start) to NM; 4. NFVO sends Notify - NsIdentifierChangeNotification (result) to NM. + +Figure 4.4.5.4-1: NS update to add a PNF to the NS instance + +#### 4.4.5.5 NS update to modify a PNF in the NS instance + +Figure 4.4.5.5-1 depicts the procedure of NS update to modify the PNF to the NS instance (see clause 7.3.5 [5]). It is assumed that the NS where the PNF instances are to be modified has been instantiated. + +1. NM sends to NFVO an *UpdateNsRequest* (see clause 7.3.5 of [5]) with the following parameters (see clause 7.3.5.2 of [5]) to on-board the NSD: + - *nsInstanceId*: the identifier of the NS instance being updated. + - *updateType = "ModifyPnf"* to indicate the type of update operation. + - *modifyPnfData*: the PNF information that contain the following attributes (see clause 8.3.4.33.2 of [5]): + - > *pnfId*: the identifier of the PNF; + - > *pnfName*: human readable name of the PNF; + - > *cpData*: information of the external CP of the PNF. +2. NFVO sends to NM an *UpdateNsResponse* (see clause 7.3.5 of [5]) with the attribute *lifecycleOperationOccurrenceId* that is the identifier of the NS lifecycle operation occurrence. +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation = "NsUpdate"*, and *notificationType = "start"* to indicate the start of the NS instantiation (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, + +operation = "NsUpdate ", and notificationType = "result" to indicate the end result of the NS instantiation (see clause 8.3.2.2 [5]). + +![Sequence diagram for NS update to modify a PNF in the NS instance. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest – ModifyPnf (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify – NsLifecycleChangeNotification (start) (NFVO to NM), and 4. Notify – NsIdentifierChangeNotification (result) (NFVO to NM).](eb5677b570ab2a3e9d8f5d35ca5b8a4d_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. UpdateNsRequest – ModifyPnf + NFVO-->>NM: 2. UpdateNsResponse + NFVO-->>NM: 3. Notify – NsLifecycleChangeNotification (start) + NFVO-->>NM: 4. Notify – NsIdentifierChangeNotification (result) + +``` + +Sequence diagram for NS update to modify a PNF in the NS instance. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest – ModifyPnf (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify – NsLifecycleChangeNotification (start) (NFVO to NM), and 4. Notify – NsIdentifierChangeNotification (result) (NFVO to NM). + +Figure 4.4.5.5-1: NS update to modify a PNF in the NS instance + +#### 4.4.5.6 NS update to remove a PNF from the NS instance + +Figure 4.4.5.6-1 depicts the procedure of NS update to remove the PNF from the NS instance (see clause 7.3.5 [5]). It is assumed that the NS where the PNF instances are to be removed has been instantiated. + +1. NM sends to NFVO an *UpdateNsRequest* (see clause 7.3.5 of [5]) with the following parameters (see clause 7.3.5.2 of [5]) to on-board the NSD: + - nsInstanceId: the identifier of the NS instance being updated. + - updateType = "RemovePnf" to indicate the type of update operation. + - removePnfId: the identifier of the PNF(s) in the NS instance that are to be removed. +2. NFVO sends to NM an *UpdateNsResponse* (see clause 7.3.5 of [5]) with the attribute lifecycleOperationOccurrenceId that is the identifier of the NS lifecycle operation occurrence. +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "NsUpdate", and notificationType = "start" to indicate the start of the NS instantiation (see clause 8.3.2.2 [5]). +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an NsLifecycleChangeNotification information element with attributes nsInstanceId, lifecycleOperationOccurrenceId, operation = "NsUpdate ", and notificationType = "result" to indicate the end result of the NS instantiation (see clause 8.3.2.2 [5]). + +![Sequence diagram for NS update to remove a PNF from the NS instance. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest – RemovePnf (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify – NsLifecycleChangeNotification (start) (NFVO to NM), and 4. Notify – NsIdentifierChangeNotification (result) (NFVO to NM).](9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. UpdateNsRequest – RemovePnf + NFVO-->>NM: 2. UpdateNsResponse + NFVO-->>NM: 3. Notify – NsLifecycleChangeNotification (start) + NFVO-->>NM: 4. Notify – NsIdentifierChangeNotification (result) + +``` + +Sequence diagram for NS update to remove a PNF from the NS instance. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest – RemovePnf (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify – NsLifecycleChangeNotification (start) (NFVO to NM), and 4. Notify – NsIdentifierChangeNotification (result) (NFVO to NM). + +Figure 4.4.5.6-1: NS update to remove a PNF from the NS instance + +#### 4.4.5.7 NS update to associate an VNF instance with a VNF profile + +Figure 4.4.5.7-1 contains a procedure to show how the connectivity of a VNF instance can be added or changed by associating such VNF instance with a new or updated VnfProfile that includes the NS virtual link information. It is assumed that the NSD with the new or updated VnfProfile has been uploaded to the NFVO, and the NSD has been associated with the NS containing such VNF instance, according to clause 4.4.5.1. + +![Sequence diagram for Figure 4.4.5.7-1: Associate an VNF instance with a VNF profile. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify - start (NFVO to NM), 4. Notify - result (NFVO to NM).](6ca05954842b17f14dfd52f26b9d43d2_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. UpdateNsRequest - Associate a VNF instance with a new or updated VnfProfile + NM->>NFVO: 1. UpdateNsRequest + Note left of NFVO: 2. UpdateNsResponse - Associate a VNF instance with a new or updated VnfProfile + NFVO-->>NM: 2. UpdateNsResponse + Note left of NFVO: 3. Notify - NsLifecycleChangeNotification (start) + NFVO-->>NM: 3. Notify - start + Note left of NFVO: 4. Notify - NsLifecycleChangeNotification (result) + NFVO-->>NM: 4. Notify - result +``` + +Sequence diagram for Figure 4.4.5.7-1: Associate an VNF instance with a VNF profile. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify - start (NFVO to NM), 4. Notify - result (NFVO to NM). + +Figure 4.4.5.7-1: Associate an VNF instance with a VNF profile + +1. NM sends to NFVO an *UpdateNsRequest* (see clause 7.3.5 [5]) with parameters `nsInstanceId`, `updateType = "AssocVnfWithVnfProfile"`, `vnfInstanceId` and `vnfProfileId` to associate the VNF instance with the VNF profile. +2. NFVO sends to NM an *UpdateNsResponse* (see clause 7.3.5 [5]) with the attribute `lifecycleOperationOccurrenceId` that is the identifier of the NS lifecycle operation occurrence. +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation = "NsUpdate"`, and `notificationType = "start"` to indicate the start of the NS update. +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes `nsInstanceId`, `lifecycleOperationOccurrenceId`, `operation = "NsUpdate"`, and `notificationType = "result"` to indicate the end result of the NS update. + +#### 4.4.5.8 NS update to associate an PNF with a PNF profile + +Figure 4.4.5.8-1 contains a procedure to show how the connectivity of a PNF can be added or changed by associating such PNF with a new or updated PnfProfile that includes the NS virtual link information. It is assumed that the NSD with the new or updated PnfProfile has been uploaded to the NFVO, and the NSD has been associated with the NS containing such PNF, according to clause 4.4.5.1. + +![Sequence diagram for Figure 4.4.5.8-1: Associate an PNF with a PNF profile. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify - start (NFVO to NM), 4. Notify - result (NFVO to NM).](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. UpdateNsRequest - Associate a PNF with a new or updated PnfProfile + NM->>NFVO: 1. UpdateNsRequest + Note left of NFVO: 2. UpdateNsResponse - Associate a PNF with a new or updated PnfProfile + NFVO-->>NM: 2. UpdateNsResponse + Note left of NFVO: 3. Notify - NsLifecycleChangeNotification (start) + NFVO-->>NM: 3. Notify - start + Note left of NFVO: 4. Notify - NsLifecycleChangeNotification (result) + NFVO-->>NM: 4. Notify - result +``` + +Sequence diagram for Figure 4.4.5.8-1: Associate an PNF with a PNF profile. The diagram shows four messages between NM and NFVO: 1. UpdateNsRequest (NM to NFVO), 2. UpdateNsResponse (NFVO to NM), 3. Notify - start (NFVO to NM), 4. Notify - result (NFVO to NM). + +Figure 4.4.5.8-1: Associate an PNF with a PNF profile + +1. NM sends to NFVO an *UpdateNsRequest* (see clause 7.3.5 [5]) with parameters *nsInstanceId*, *updateType* = "AssocPnfWithPnfProfile", *pnfId* and *pnfProfileId* to associate the PNF instance with the PNF profile. +2. NFVO sends to NM an *UpdateNsResponse* (see clause 7.3.5 [5]) with the attribute *lifecycleOperationOccurrenceId* that is the identifier of the NS lifecycle operation occurrence. +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "NsUpdate", and *notificationType* = "start" to indicate the start of the NS update. +4. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying an *NsLifecycleChangeNotification* information element with attributes *nsInstanceId*, *lifecycleOperationOccurrenceId*, *operation* = "NsUpdate ", and *notificationType* = "result" to indicate the end result of the NS update. + +### 4.4.6 Subscription regarding NS Instance lifecycle changes + +The Figure 4.4.6-1 depicts a procedure of subscription to NS instance lifecycle change notifications + +1. NM sends *SubscribeRequest* message to NFVO with input parameter *filter* described in 7.4.2.2 [5] used for selecting the notifications, which can be on the NS instance(s) of interest or other attributes of the notification, to subscribe for the notifications sent by the NFVO supported on the NS lifecycle change notification interface. +2. NFVO sends *SubscribeResponse* message to NM to indicate if the subscription has been successful or not with a standard success/error result. Output parameter *subscriptionId* is specified in 7.4.2.3 [5] to provide the identifier of the subscription realized. After successful subscription, the consumer (NM) is registered to receive notifications supported on the NS lifecycle change notification interface. For a particular subscription, only notifications matching the filter will be delivered to the consumer (see clause 7.4.2.4 [5]). + +![Sequence diagram showing the subscription process between NM and NFVO. NM sends a SubscribeRequest to NFVO, and NFVO responds with a SubscribeResponse.](24c9e038a791677ed33100667b64f7e6_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. SubscribeRequest + NFVO-->>NM: 2. SubscribeResponse + +``` + +Sequence diagram showing the subscription process between NM and NFVO. NM sends a SubscribeRequest to NFVO, and NFVO responds with a SubscribeResponse. + +Figure 4.4.6-1: Subscribing to NS lifecycle change notifications through Os-Ma-nfvo + +### 4.4.7 Create NS Instance identifier + +Figure 4.4.7-1 depicts a procedure for creation of an NS instance identifier, and an associated instance of an *NsInfo* information element, identified by that identifier, in the *NOT\_INSTANTIATED* state without instantiating the NS or doing any additional lifecycle operation(s). It allows the immediate return of an NS instance identifier that can be used in subsequent lifecycle operations, such as the *Instantiate NS* operation (see NS state model in clause D.3 [5]). + +1. NM sends *CreateNsIdentifierRequest* to NFVO with *nsdId* parameter referencing the NSD used to create this NS instance, *nsName* parameter providing human readable name of the NS instance and *nsDescription* parameter providing human readable description of the NS instance (see clause 7.3.2 [5]). +2. NFVO sends *CreateNsIdentifierResponse* to NM with the *nsInstanceId* identifier of the instance of a NS that has been created (see clause 7.3.2.4 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.4.3 [5]) carrying *NsIdentifierCreationNotification* information element with attribute *nsInstanceId* to indicate the NS instance identifier creation (see clause 8.3.2.9 [5]). + +![Sequence diagram for Create NS Instance identifier procedure](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. CreateNsIdentifierRequest + NFVO-->>NM: 2. CreateNsIdentifierResponse + NFVO-->>NM: 3. Notify + +``` + +A sequence diagram showing the interaction between NM and NFVO for the 'Create NS Instance identifier procedure'. The sequence consists of three steps: 1. NM sends a 'CreateNsIdentifierRequest' to NFVO; 2. NFVO returns a 'CreateNsIdentifierResponse' to NM; 3. NFVO sends a 'Notify' message to NM. + +Sequence diagram for Create NS Instance identifier procedure + +Figure 4.4.7-1: Create NS Instance identifier procedure + +### 4.4.8 Delete NS Instance identifier + +Figure 4.4.8-1 depicts the procedure of an NS instance identifier deletion initiated through the Os-Ma-Nfvo reference point (see clause 7.3.8 [5]). + +1. NM sends to NFVO a *DeleteNsRequest* with parameter `nsInstanceId` to delete the NS instance identifier (see clause 7.3.8.2 [5]). +2. NFVO sends to NM a *DeleteNsResponse* (see clause 7.3.8.2 [5]). +3. NFVO sends to NM a *Notify* (see clause 7.4.3 [5]) carrying *NsIdentifierObjectDeletionNotification* information element with attributes `nsInstanceId` to indicate the result of the NS instance identifier deletion (see clause 8.3.2.10 [5]). + +![Sequence diagram for NS instance identifier deletion](dc1f232cfd39be5c20b21374ad4c04c0_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1.DeleteNsRequest + NFVO-->>NM: 2.DeleteNsResponse + NFVO-->>NM: 3. Notify + +``` + +A sequence diagram showing the interaction between NM and NFVO for 'NS instance identifier deletion'. The sequence consists of three steps: 1. NM sends a 'DeleteNsRequest' to NFVO; 2. NFVO returns a 'DeleteNsResponse' to NM; 3. NFVO sends a 'Notify' message to NM. + +Sequence diagram for NS instance identifier deletion + +Figure 4.4.8-1: NS instance identifier deletion + +### 4.4.9 Procedure for the Notify operation for notifications to NM + +The Figure 4.4.9-1 depicts a procedure of notification on NS instance lifecycle change notifications + +1. NFVO sends *Notify* message to NM according to 7.4.3 [5]. This operation distributes to subscribers the notifications supported on the NS lifecycle changes notification interface. In order to receive notifications, the consumer (NM) has to perform an explicit Subscribe operation beforehand. + +![Sequence diagram for the Notify operation](da6000b1371b5528262d4f9cb2f2707c_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NFVO-->>NM: 1. Notify + +``` + +A sequence diagram showing the interaction between NM and NFVO for the 'Notify operation'. The sequence consists of one step: 1. NFVO sends a 'Notify' message to NM. + +Sequence diagram for the Notify operation + +Figure 4.4.9-1: Procedure for the Notify operation + +The following notifications can be notified/sent by this operation: + +- NsLifecycleChangeNotification. See clause 8.3.2.2 [5] with the list of attributes in the Table 8.3.2.2.3-1 [5]. +- NsIdentifierCreationNotification. See clause 8.3.2.9 [5] with the attribute nsInstanceId per Table 8.3.2.9.3-1 [5]. +- NsIdentifierDeletionNotification. See clause 8.3.2.10 [5] with the attribute nsInstanceId per Table 8.3.2.10.3-1. + +## 4.5 NS Descriptor (NSD) procedures + +### 4.5.1 NSD on-boarding + +Figure 4.5.1-1 depicts a procedure for on-boarding an NSD in the NFVO. Associated descriptors (VLD and VNFFGD), that are part of the NSD, are on-boarded at the same time. All descriptors needed by the NSD: VNFD, PNFD and NSD for nested NSs shall be on-boarded before being able to successfully on-board the NSD. + +1. NM sends *OnboardNsdRequest* to NFVO with *nsd* parameter representing the NSD to be on-boarded and list of *userDefinedData* key-value pairs providing user defined data for the NSD (see clause 7.2.2 [5]). +2. NFVO sends *OnboardNsdResponse* to NM with the *nsdInfoId* identifier of the on-boarded instance of the NSD (see clause 7.2.2.4 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.2.13 [5]) carrying *NsdOnBoardingNotification* information element with attributes *nsdInfoId* and *nsdId* to indicate on-boarding of NSD (see clause 8.2.6 [5]). + +![Sequence diagram of NSD on-boarding procedure between NM and NFVO.](f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note left of NM: + NM->>NFVO: 1. OnboardNsdRequest + NFVO-->>NM: 2. OnboardNsdResponse + NFVO->>NM: 3. Notify +``` + +The diagram illustrates the interaction between the Network Manager (NM) and the Network Function Virtualization Orchestrator (NFVO) for NSD on-boarding. It consists of three steps: 1. NM sends an OnboardNsdRequest to NFVO; 2. NFVO responds with an OnboardNsdResponse; 3. NFVO sends a Notify message to NM. + +Sequence diagram of NSD on-boarding procedure between NM and NFVO. + +Figure 4.5.1-1: NSD on-boarding procedure + +### 4.5.2 NSD enabling + +Figure 4.5.2-1 depicts a procedure for enabling a previously disabled NSD instance, allowing again its use for instantiation of new network service with this descriptor. The "In use/Not in use" sub-state does not change as a result of the operation. + +1. NM sends *EnableNsdRequest* to NFVO with *nsdInfoId* parameter representing the identifier of on-boarded NSD to be enabled (see clause 7.2.3 [5]). +2. NFVO sends *EnableNsdResponse* to NM to indicate the result of the operation (see clause 7.2.3.4 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.2.13 [5]) carrying *NsdChangeNotification* information element with attributes *nsdInfoId*, *changeType*, *operationalState* and *deletionPending* to indicate a change of status of NSD (see clause 8.2.7 [5]). + +![Sequence diagram for NSD enabling procedure between NM and NFVO.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note left of NM: ----< + NM->>NFVO: 1. EnableNsdRequest + NFVO-->>NM: 2. EnableNsdResponse + NFVO-->>NM: 3. Notify +``` + +A sequence diagram illustrating the NSD enabling procedure. It features two lifelines, NM and NFVO. The interaction begins with a message '1. EnableNsdRequest' from NM to NFVO. NFVO responds with '2. EnableNsdResponse' back to NM. Finally, NFVO sends a '3. Notify' message to NM. There is a dashed line with an arrow pointing left from the top of the NM lifeline, labeled '----<'. + +Sequence diagram for NSD enabling procedure between NM and NFVO. + +Figure 4.5.2-1: NSD enabling procedure + +### 4.5.3 NSD disabling + +Figure 4.5.3-1 depicts a procedure for disabling a previously enabled NSD instance, preventing any further use for instantiation of new network service with this descriptor. The "In use/Not in use" sub-state does not change because of the operation. + +1. NM sends *DisableNsdRequest* to NFVO with *nsdInfoId* parameter representing the identifier of on-boarded NSD to be disabled (see clause 7.2.4 [5]). +2. NFVO sends *DisableNsdResponse* to NM to indicate the result of the operation (see clause 7.2.4.4 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.2.13 [5]) carrying *NsdChangeNotification* information element with attributes *nsdInfoId*, *changeType*, *operationalState* and *deletionPending* to indicate a change of status of NSD (see clause 8.2.7 [5]). + +![Sequence diagram for NSD disabling procedure between NM and NFVO.](1b893df61c2b73b7a85e65fc1f58e203_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. DisableNsdRequest + NFVO-->>NM: 2. DisableNsdResponse + NFVO-->>NM: 3. Notify +``` + +A sequence diagram illustrating the NSD disabling procedure. It features two lifelines, NM and NFVO. The interaction begins with a message '1. DisableNsdRequest' from NM to NFVO. NFVO responds with '2. DisableNsdResponse' back to NM. Finally, NFVO sends a '3. Notify' message to NM. + +Sequence diagram for NSD disabling procedure between NM and NFVO. + +Figure 4.5.3-1: NSD disabling procedure + +### 4.5.4 NSD querying + +Figure 4.5.4-1 depicts the procedure of querying NSD information through the Os-Ma-nfvo reference point (see clause 7.2.7 [5]). + +1. NM sends to NFVO a *QueryNsdRequest* with parameters *filter* and *attributeSelector* used to filter the NSDs on which the query applies and the attributes that will be returned for the instances of NSD(s) matching the filter (see clause 7.2.7.2 [5]). +2. NFVO sends to NM a *QueryNsdResponse* with parameter *queryResult* providing the information that is selected according to parameters *filter* and *attributeSelector* (see clause 7.2.7.3 [5]). The result of the operation indicates if it has been successful or not with a standard success/error result. + +![Sequence diagram showing the interaction between NM and NFVO for querying NSD information. NM sends a QueryNsdRequest to NFVO, and NFVO returns a QueryNsdResponse.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. QueryNsdRequest + NM->>NFVO: QueryNsdRequest + Note left of NFVO: 2. QueryNsdResponse + NFVO-->>NM: QueryNsdResponse +``` + +Sequence diagram showing the interaction between NM and NFVO for querying NSD information. NM sends a QueryNsdRequest to NFVO, and NFVO returns a QueryNsdResponse. + +Figure 4.5.4-1: Query NSD information through Os-Ma-nfvo + +### 4.5.5 NSD deletion + +Figure 4.5.5-1 depicts a procedure for deletion of one or more NSD(s). It is possible to delete only a single version of an NSD or all versions. An NSD can only be deleted when there is no instantiated NS using it. An NSD in the deletion pending state can no longer be enabled, disabled or updated. It is not possible to instantiate NS(s) using an NSD in the deletion pending state. + +1. NM sends *DeleteNsdRequest* to NFVO with list of *nsdInfoId* parameter representing the identifier(s) of on-boarded NSD to be deleted and an optional *applyOnAllVersions* parameter indicating if the delete operation is to be applied on all versions of this NSD. By default, if *applyOnAllVersions* parameter is not present, the request applies only on the current NSD version. (see clause 7.2.6 [5]). +2. NFVO sends *DeleteNsdResponse* to NM with list of *deletedNsdInfoId* parameter representing the identifier(s) of deleted NSD(s) to indicate the result of the operation (see clause 7.2.6.4 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.2.13 [5]) carrying *NsdChangeNotification* information element with attributes *nsdInfoId*, *changeType*, *operationalState* and *deletionPending* to indicate a change of status of NSD (see clause 8.2.7 [5]). + +![Sequence diagram showing the NSD deletion procedure. NM sends a DeleteNsdRequest to NFVO, NFVO returns a DeleteNsdResponse, and then NFVO sends a Notify message to subscribers.](836b0790cef5469a167fa8931df4e408_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. DeleteNsdRequest + NM->>NFVO: DeleteNsdRequest + Note left of NFVO: 2. DeleteNsdResponse + NFVO-->>NM: DeleteNsdResponse + Note left of NFVO: 3. Notify + NFVO-->>Subscribers: Notify +``` + +Sequence diagram showing the NSD deletion procedure. NM sends a DeleteNsdRequest to NFVO, NFVO returns a DeleteNsdResponse, and then NFVO sends a Notify message to subscribers. + +Figure 4.5.5-1: NSD deletion procedure + +### 4.5.6 NSD updating + +Figure 4.5.6-1 depicts a procedure for updating an already on-boarded NSD, creating a new version of the NSD. The procedure can also be used to update the *userDefinedData* of an existing *NsdInfo* information element without creating a new version of the NSD. The previous versions of the NSDs are not modified. It is possible to add (remove) constituent descriptors (i.e. VNFDs, PNFDs, nested NSDs, VLDs, VNFFGDs and Service Access Point Descriptors (SAPDs)) to (from) an NSD via the Update NSD operation. This is done by changing the various descriptor references in the new NSD. For example, to add VNFDs to an NSD, the NM adds corresponding VNFD identifiers to the list of *vnfdIds* in the new NSD. To remove VNFDs, the NM simply does not include the *vnfdIds* (of the VNFDs to be removed) in the new NSD. + +1. NM sends *UpdateNsdRequest* to NFVO with *nsdInfoId* parameter representing the identifier of on-boarded NSD to be updated, an optional (only present if the NSD itself is updated) *nsd* parameter representing the new NSD to be created and list of *userDefinedData* key-value pairs optional parameter representing the user defined data to be updated (for existing keys, the value is replaced). At least one of the two parameters (*nsd* or *userDefinedData*) needs to be present. If *nsd* is not present, the operation is used only to update existing or add additional user defined data using the *userDefinedData* parameter (see clause 7.2.5 [5]). + +2. NFVO sends *UpdateNsdResponse* to NM with *nsdInfoId* parameter representing the identifier of the updated NSD to indicate the result of the operation (see clause 7.2.5.4 [5]). +3. NFVO sends to subscribers a *Notify* (see clause 7.2.13 [5]) carrying *NsdChangeNotification* information element with attributes *nsdInfoId*, *changeType*, *operationalState* and *deletionPending* to indicate a change of status of NSD (see clause 8.2.7 [5]). + +![Sequence diagram showing the NSD updating procedure between NM and NFVO. Step 1: NM sends UpdateNsdRequest to NFVO. Step 2: NFVO sends UpdateNsdResponse to NM. Step 3: NFVO sends Notify to NM.](9870bf462aa0d916a16d14b5a100c60a_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. UpdateNsdRequest + NFVO-->>NM: 2. UpdateNsdResponse + NFVO-->>NM: 3. Notify + +``` + +Sequence diagram showing the NSD updating procedure between NM and NFVO. Step 1: NM sends UpdateNsdRequest to NFVO. Step 2: NFVO sends UpdateNsdResponse to NM. Step 3: NFVO sends Notify to NM. + +Figure 4.5.6-1: NSD updating procedure + +### 4.5.7 Subscribe to NSD change notifications + +The Figure 4.5.7-1 depicts a procedure of subscription to NSD change notifications. + +1. NM sends *SubscribeRequest* message to NFVO with input parameter *filter* for selecting the NSD(s) and the related change notifications to subscribe to, as described in 7.2.12 [5]. The filter can contain information about specific types of changes to subscribe to, or attributes of the *NsdInfo*. +2. NFVO sends *SubscribeResponse* message to the NM to indicate if the subscription has been successful or not with a standard success/error result. Output parameter *subscriptionId* is specified in 7.2.12.3 [5] to provide the identifier of the subscription realized. After successful subscription, the consumer (NM) is registered to receive notifications supported on the NSD Management interface. For a particular subscription, only notifications matching the filter will be delivered to the consumer (see clause 7.2.13.1 [5] for full list of possible notifications). + +![Sequence diagram showing the subscription procedure between NM and NFVO. Step 1: NM sends SubscribeRequest to NFVO. Step 2: NFVO sends SubscribeResponse to NM.](b2ddf2a678bd20b1b491023eb1db6458_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. SubscribeRequest + NFVO-->>NM: 2. SubscribeResponse + +``` + +Sequence diagram showing the subscription procedure between NM and NFVO. Step 1: NM sends SubscribeRequest to NFVO. Step 2: NFVO sends SubscribeResponse to NM. + +Figure 4.5.7-1: Subscribing to NSD change notifications through Os-Ma-nfvo + +### 4.5.8 Notify operation for NSD management changes + +The Figure 4.5.8-1 depicts a procedure of delivery of notifications related to NSD management changes. + +1. NFVO sends *Notify* message to the NM according to the clause 7.2.13 in [5]. This operation delivers to the NM the notifications related to NSD Management changes. In order to receive notifications, the NM shall perform an explicit *Subscribe* operation beforehand. + +![Sequence diagram for Figure 4.5.8-1: Procedure for the Notify operation for NSD management changes. It shows two lifelines, NM and NFVO. A message labeled '1. Notify' is sent from the NFVO lifeline to the NM lifeline.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note right of NFVO: 1. Notify + NFVO->>NM: 1. Notify +``` + +Sequence diagram for Figure 4.5.8-1: Procedure for the Notify operation for NSD management changes. It shows two lifelines, NM and NFVO. A message labeled '1. Notify' is sent from the NFVO lifeline to the NM lifeline. + +Figure 4.5.8-1: Procedure for the Notify operation for NSD management changes + +The following notifications can be sent by this operation: + +- NsdOnBoardingNotification. See clause 8.2.6 in [5]. + +The notification contains the following parameters: + +- nsdInfoId: Identifier of the on-boarded instance of the NSD +- nsdId: Identifies the NSD being on-boarded. +- NsdChangeNotification. See clause 8.2.7 in [5]. + +The notification contains the following parameters: + +- nsdInfoId: Identifier of the on-boarded instance of the NSD. +- changeType: It categorizes the type of change. Possible values can be "change of operational state of an on-boarded NSD", "NSD in deletion pending", and "deletion of an NSD". +- operationalState: New operational state of the NSD. Only present when changeType is "change of operational state". +- deletionPending: Indicates if the deletion of the NSD instance has been requested but the NSD still being used by instantiated NSs. Only present when changeType is "NSD in deletion pending". + +## 4.6 PNFD procedures + +### 4.6.1 PNFD on-boarding + +Figure 4.6.1-1 depicts a procedure for on-boarding a PNFD in the NFVO, making it available to be used by NSDs. + +1. NM sends *OnboardPnfdRequest* to NFVO with *pnfd* parameter representing the PNFD to be on-boarded and list of *userDefinedData* key-value pairs providing user defined data for the PNFD (see clause 7.2.8 [5]). +2. NFVO sends *OnboardPnfdResponse* to NM with the *pnfdInfoId* identifier of the on-boarded instance of the PNFD (see clause 7.2.8.4 [5]). + +![Sequence diagram for Figure 4.6.1-1: PNFD on-boarding procedure. It shows two lifelines, NM and NFVO. Step 1: A message '1. OnboardPnfdRequest' is sent from NM to NFVO. Step 2: A message '2. OnboardPnfdResponse' is sent from NFVO back to NM.](44c70af075e4d9bbc6fbe267a666b3b0_img.jpg) + +``` +sequenceDiagram + participant NM + participant NFVO + Note right of NM: 1. OnboardPnfdRequest + NM->>NFVO: 1. OnboardPnfdRequest + Note left of NFVO: 2. OnboardPnfdResponse + NFVO->>NM: 2. OnboardPnfdResponse +``` + +Sequence diagram for Figure 4.6.1-1: PNFD on-boarding procedure. It shows two lifelines, NM and NFVO. Step 1: A message '1. OnboardPnfdRequest' is sent from NM to NFVO. Step 2: A message '2. OnboardPnfdResponse' is sent from NFVO back to NM. + +Figure 4.6.1-1: PNFD on-boarding procedure + +### 4.6.2 PNFD updating + +Figure 4.6.2-1 depicts a procedure for updating a PNFD, creating a new version of already on-boarded PNFD. The procedure can also be used to update the userDefinedData of an existing PnfInfo information element without creating a new version of the PNFD. The previous versions of the PNFD are not modified. + +1. NM sends *UpdatePnfdRequest* to NFVO with `pnfdInfoId` parameter representing the identifier of on-boarded PNFD to be updated, an optional (only present if the PNFD itself is updated) `pnfd` parameter representing the new PNFD to be created and list of `userDefinedData` key-value pairs optional parameter representing the user defined data to be updated (for existing keys, the value is replaced). At least one of the two parameters (`pnfd` or `userDefinedData`) needs to be present. If `pnfd` is not present, the operation is used only to update existing or add additional user defined data using the `userDefinedData` parameter (see clause 7.2.9 [5]). +2. NFVO sends *UpdatePnfdResponse* to NM with `pnfdInfoId` parameter representing the identifier of the updated PNFD to indicate the result of the operation (see clause 7.2.9.4 [5]). + +![Sequence diagram for PNFD updating procedure. It shows two lifelines: NM and NFVO. Step 1: NM sends a message '1. UpdatePnfdRequest' to NFVO. Step 2: NFVO sends a message '2. UpdatePnfdResponse' back to NM.](fb18a83d10ebdad8e3e5ea2e86b36136_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: NM sends UpdatePnfdRequest to NFVO + NM->>NFVO: 1. UpdatePnfdRequest + Note right of NFVO: NFVO sends UpdatePnfdResponse to NM + NFVO-->>NM: 2. UpdatePnfdResponse + +``` + +Sequence diagram for PNFD updating procedure. It shows two lifelines: NM and NFVO. Step 1: NM sends a message '1. UpdatePnfdRequest' to NFVO. Step 2: NFVO sends a message '2. UpdatePnfdResponse' back to NM. + +Figure 4.6.2-1: PNFD updating procedure + +### 4.6.3 PNFD deletion + +Figure 4.6.3-1 depicts a procedure for deletion of one or more PNFD(s). A PNFD can only be deleted when there is no NS (in the active or NOT\_INSTANTIATED state) using it. It is not possible to instantiate NSs that include a PNFD in deletion pending state. + +1. NM sends *DeletePnfdRequest* to NFVO with list of `pnfdInfoId` parameter representing the identifier(s) of on-boarded PNFD(s) to be deleted and an optional `applyOnAllVersions` parameter indicating if the delete operation is to be applied on all versions of this PNFD. By default, if `applyOnAllVersions` parameter is not present, the request applies only on the current PNFD version. (see clause 7.2.10 [5]). +2. NFVO sends *DeletePnfdResponse* to NM with list of `deletedPnfdInfoId` parameter representing the identifier(s) of deleted PNFD(s) to indicate the result of the operation (see clause 7.2.10.4 [5]). + +![Sequence diagram for PNFD deletion procedure. It shows two lifelines: NM and NFVO. Step 1: NM sends a message '1. DeletePnfdRequest' to NFVO. Step 2: NFVO sends a message '2. DeletePnfdResponse' back to NM.](e38206fcefa2045af01d494b2956775a_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + Note left of NM: NM sends DeletePnfdRequest to NFVO + NM->>NFVO: 1. DeletePnfdRequest + Note right of NFVO: NFVO sends DeletePnfdResponse to NM + NFVO-->>NM: 2. DeletePnfdResponse + +``` + +Sequence diagram for PNFD deletion procedure. It shows two lifelines: NM and NFVO. Step 1: NM sends a message '1. DeletePnfdRequest' to NFVO. Step 2: NFVO sends a message '2. DeletePnfdResponse' back to NM. + +Figure 4.6.3-1: PNFD deletion procedure + +### 4.6.4 PNFD querying + +Figure 4.6.4-1 depicts a procedure to query the NFVO concerning details of one or more PNFDs. + +1. NM sends *QueryPnfdRequest* to NFVO with `filter` and `attributeSelector` used to filter the PNFD(s) on which the query applies, based on the attributes of `PnfdInfo` and select the information attributes of `PnfdInfo` that are requested to be returned (see clause 7.2.11 [5]). + +2. NFVO sends *QueryPnfdResponse* to NM with parameter *queryResult* providing the information of the on-boarded PNFD matching the input *filter* that is selected according to *attributeSelector* (see clause 7.2.11.4 [5]). + +![Sequence diagram showing the PNFD querying procedure between NM and NFVO.](04cfca33e3fc26513abe649d7474f733_img.jpg) + +``` + +sequenceDiagram + participant NM + participant NFVO + NM->>NFVO: 1. QueryPnfdRequest + NFVO-->>NM: 2. QueryPnfdResponse + +``` + +The diagram illustrates a sequence of two messages between two entities, NM and NFVO. NM sends a 'QueryPnfdRequest' message to NFVO, and NFVO responds with a 'QueryPnfdResponse' message. The messages are numbered 1 and 2 respectively. + +Sequence diagram showing the PNFD querying procedure between NM and NFVO. + +**Figure 4.6.4-1: PNFD querying procedure** + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-03 | SA#79 | SP-180059 | 0002 | 1 | F | Scope extension | 14.1.0 | +| 2018-03 | SA#79 | SP-180059 | 0004 | 1 | F | Procedures of PNF addition, removal, and modification | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-12 | SA#82 | SP-181040 | 0014 | 1 | F | Add a procedure to associate an VNF instance with a VNF profile | 15.1.0 | +| 2018-12 | SA#82 | SP-181040 | 0015 | 1 | F | Add a procedure to associate an PNF with a PNF profile | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28527/raw.md b/marked/Rel-16/28_series/28527/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..92bd89bc458d4cd9c1b79408c86511816d21285b --- /dev/null +++ b/marked/Rel-16/28_series/28527/raw.md @@ -0,0 +1,113 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Information model definition ..... 5 + - 4.1 Os-Ma-nfvo ..... 5 + - 4.2 Ve-Vnfm-em ..... 6 +- 5 Interface definitions ..... 6 + - 5.1 Os-Ma-nfvo ..... 6 + - 5.2 Ve-Vnfm-em ..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.525: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements. +- TS 28.526: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Procedures. +- TS 28.527: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 2.** +- TS 28.528: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 3. + +# --- 1 Scope + +The present document is the Life Cycle Management (LCM) stage 2 specification for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Telecommunication management; Concept, architecture and requirements for mobile networks that include virtualized network functions". +- [3] ETSI GS NFV-IFA 008 (V2.1.1): "Network Functions Virtualisation (NFV); Management and Orchestration; Ve-Vnfm reference point – Interface and Information Model Specification". +- [4] ETSI GS NFV-IFA 013 (V2.1.1): "Network Functions Virtualisation (NFV); Management and Orchestration; Os-Ma-nfvo reference point – Interface and Information Model Specification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +# --- 4 Information model definition + +## 4.1 Os-Ma-nfvo + +For Os-Ma-nfvo NS lifecycle management (LCM) and VNF lifecycle as part of NS LCM, the information elements and notifications related to NS lifecycle management which are specified in clause 8.3 of ETSI GS NFV-IFA 013 [4] shall be used. + +## 4.2 Ve-Vnfm-em + +For Ve-Vnfm-em VNF lifecycle management, the following shall be used: + +- the information elements related to VNF lifecycle management which are specified in clause 9.4 of ETSI GS NFV-IFA 008 [3], + +- the information elements and notifications related to VNF lifecycle changes which are specified in clause 9.5 of ETSI GS NFV-IFA 008 [3], and +- the information elements and notifications related to multiple interfaces which are specified in clause 9.8 of ETSI GS NFV-IFA 008 [3]. + +# --- 5 Interface definitions + +## 5.1 Os-Ma-nfvo + +For NS lifecycle management the operations of the NS Lifecycle Management interface specified in clause 7.3 of ETSI GS NFV-IFA 013 [4] shall be used. + +For NS lifecycle change notifications and notification subscription management, the operations of the NS Lifecycle Change Notification interface specified in clause 7.4 of ETSI GS NFV-IFA 013 [4] shall be used. + +## 5.2 Ve-Vnfm-em + +For VNF lifecycle management the operations of the VNF Lifecycle Management interface specified in clause 7.2 of ETSI GS NFV-IFA 008 [3] shall be used. + +For VNF lifecycle change notifications and notification subscription management, the operations of the VNF Lifecycle Change Notification interface specified in clause 7.3 of ETSI GS NFV-IFA 008 [3] shall be used. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----------|-----|-----|----------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | SP-170122 | | | | Presented for information and approval | 1.0.0 | +| 2017-03 | SA#75 | | | | | Upgrade to change control version | 14.0.0 | +| 2018-06 | SA#80 | SP-180417 | 000<br>1 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28528/raw.md b/marked/Rel-16/28_series/28528/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c37f8e8ec883b8a0518935f45ba7a5c76dd2d0a2 --- /dev/null +++ b/marked/Rel-16/28_series/28528/raw.md @@ -0,0 +1,123 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Data model and interface definitions ..... 5 + - 4.1 Os-Ma-nfvo ..... 5 + - 4.2 Ve-Vnfm-em ..... 6 +- Annex <A> (informative): Change history ..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.525: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements +- TS 28.526: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Procedures +- TS 28.527: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 2 +- TS 28.528: Telecommunication management; Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Stage 3** + +# --- 1 Scope + +The present document is the Life Cycle Management (LCM) stage 3 specification for mobile networks that include virtualized network functions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.500: "Telecommunication management; Concept, architecture and requirements for mobile networks that include virtualized network functions". +- [3] ETSI GS NFV-SOL 002 (V2.3.1): "Network Function Virtualisation (NFV) Release 2; Protocols and Data Models; RESTful protocols specification for the Ve-Vnfm Reference Point". +- [4] ETSI GS NFV-SOL 005 ( V2.5.1): "Network Functions Virtualisation (NFV); Protocols and Data Models; RESTful protocols specification for the Os-Ma-Nfvo Reference Point". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 28.500 [2] 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] or in 3GPP TS 28.500 [2]. + +# --- 4 Data model and interface definitions + +## 4.1 Os-Ma-nfvo + +For Os-Ma-nfvo NSD management, the following shall be used: + +- the RESTful API URI structure and supported content formats specified in clause 4.2 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common procedures specified in clause 4.3 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common data types specified in clause 4.4 of ETSI GS NFV-SOL 005 [4], and + +- the NSD management RESTful API resource structure, methods, resources and data model specified in clause 5 of ETSI GS NFV-SOL 005 [4]. + +For Os-Ma-nfvo NS lifecycle management, the following shall be used: + +- the RESTful API URI structure and supported content formats specified in clause 4.2 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common procedures specified in clause 4.3 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common data types specified in clause 4.4 of ETSI GS NFV-SOL 005 [4], and +- the NS LCM RESTful API resource structure, methods, resources and data model specified in clause 6 of ETSI GS NFV-SOL 005 [4]. + +For Os-Ma-nfvo NS lifecycle change notification, the following shall be used: + +- the RESTful API URI structure and supported content formats specified in clause 4.2 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common procedures specified in clause 4.3 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common data types specified in clause 4.4 of ETSI GS NFV-SOL 005 [4], and +- the NS lifecycle change notification RESTful API resource structure, methods, resources and data model specified in clause 7 of ETSI GS NFV-SOL 005 [4]. + +For Os-Ma-nfvo VNF package management, the following shall be used: + +- the RESTful API URI structure and supported content formats specified in clause 4.2 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common procedures specified in clause 4.3 of ETSI GS NFV-SOL 005 [4], and +- the RESTful API common data types specified in clause 4.4 of ETSI GS NFV-SOL 005 [4], and +- the VNF package management RESTful API resource structure, methods, resources and data model specified in clause 10 of ETSI GS NFV-SOL 005 [4]. + +## 4.2 Ve-Vnfm-em + +For Ve-Vnfm-em VNF lifecycle management, the following shall be used: + +- the RESTful API URI structure and supported content formats specified in clause 4.2 of ETSI GS NFV-SOL 002 [3], and +- the RESTful API common procedures specified in clause 4.3 of ETSI GS NFV-SOL 002 [3], and +- the RESTful API common data types specified in clause 4.4 of ETSI GS NFV-SOL 002 [3], and +- the VNF LCM RESTful API resource structure, methods, resources, data model and handling of errors specified in clause 5 of ETSI GS NFV-SOL 002 [3]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | SA#78 | SP-170964 | 0001 | 1 | F | Update the references to ETSI NFV SOL specifications | 14.1.0 | +| 2018-06 | SA#80 | SP-180417 | 0002 | 1 | B | Scope extension to cover RAN | 15.0.0 | +| 2018-12 | SA#82 | SP-181041 | 0003 | - | F | Fix outdated reference | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28530/4801720824e4b5e2361a5564f91cfb70_img.jpg b/marked/Rel-16/28_series/28530/4801720824e4b5e2361a5564f91cfb70_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d9413a76eed129905b78ce17f11fbbb030801850 --- /dev/null +++ b/marked/Rel-16/28_series/28530/4801720824e4b5e2361a5564f91cfb70_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e02788576590d09eed790fcaaa006b52dd9e7e0b5daada71959f3d56f098b36a +size 56244 diff --git a/marked/Rel-16/28_series/28530/5b4e774d63e0e0ed73801a9247755e5f_img.jpg b/marked/Rel-16/28_series/28530/5b4e774d63e0e0ed73801a9247755e5f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49c3820613ec68b077927076aef51182e239306c --- /dev/null +++ b/marked/Rel-16/28_series/28530/5b4e774d63e0e0ed73801a9247755e5f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e603fb04a57f197dcf24492de24390c4f0ff897f2214a5b4802601660e7119ae +size 103929 diff --git a/marked/Rel-16/28_series/28530/76b0cd79baaedd942af4dc42f2e764b8_img.jpg b/marked/Rel-16/28_series/28530/76b0cd79baaedd942af4dc42f2e764b8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0b5d11754cad78d96bc734a9dd3469bdfdf86cd --- /dev/null +++ b/marked/Rel-16/28_series/28530/76b0cd79baaedd942af4dc42f2e764b8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c221ebff26cace9d8349f6f4123964917dcc33e38968f80503a3154af3b925f3 +size 56586 diff --git a/marked/Rel-16/28_series/28530/8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg b/marked/Rel-16/28_series/28530/8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..68d656d83a877311d1faa1a5b56df8f6add6b9cd --- /dev/null +++ b/marked/Rel-16/28_series/28530/8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9480c7c88b340474389f5db9ca47df2383242235e684ff829e5cbcecbbfc47e2 +size 46293 diff --git a/marked/Rel-16/28_series/28530/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg b/marked/Rel-16/28_series/28530/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f378f21d50d7239031db1fec72a6d74de554cce3 --- /dev/null +++ b/marked/Rel-16/28_series/28530/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf963c0be93b6cd9848035b064a8e93d4c5db2fdc6b99ca3e3b57f0118b77552 +size 34542 diff --git a/marked/Rel-16/28_series/28530/cab0834804fb031b43865554cc8d06ab_img.jpg b/marked/Rel-16/28_series/28530/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ebc210fe6f95bdcfb3bd3a209a3662d99697cd42 --- /dev/null +++ b/marked/Rel-16/28_series/28530/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fce307443d35613485e0cfb7e10427507e6ff25361bfd5c985139b349c76dea9 +size 20728 diff --git a/marked/Rel-16/28_series/28530/d4af765160d04ecef538e5066006dc77_img.jpg b/marked/Rel-16/28_series/28530/d4af765160d04ecef538e5066006dc77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bbe67c5c237ff0621e4ae9c9da975c5c319df338 --- /dev/null +++ b/marked/Rel-16/28_series/28530/d4af765160d04ecef538e5066006dc77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:644a6f3f1438cea497d46fcc08c437707be3352b5a97ba7fc66af04a287ac6e6 +size 42922 diff --git a/marked/Rel-16/28_series/28530/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg b/marked/Rel-16/28_series/28530/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..918992193f386dd1b2c69b578bdfa305c3ff079f --- /dev/null +++ b/marked/Rel-16/28_series/28530/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:89808d7cb2b69a9c406bc01e92c677e91aa6ee652358384e77121e2f70a1ff88 +size 54000 diff --git a/marked/Rel-16/28_series/28530/raw.md b/marked/Rel-16/28_series/28530/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d4f2fbd6c35ab955ac7c812a67f12bc1efa4bbb0 --- /dev/null +++ b/marked/Rel-16/28_series/28530/raw.md @@ -0,0 +1,992 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 Concepts and background ..... | 7 | +| 4.1 General concepts ..... | 7 | +| 4.1.1 Management of 5G networks and network slicing..... | 7 | +| 4.1.2 Types of communication services ..... | 8 | +| 4.1.3 Communication services using network slices..... | 8 | +| 4.1.4 Communication services requirements..... | 9 | +| 4.1.5 NetworkSlice instance Lifecycle and relationship to service instances ..... | 10 | +| 4.1.6 Network Slice as a Service (NSaaS)..... | 10 | +| 4.1.7 Network slices as NOP internals ..... | 11 | +| 4.1.8 Network slice delivery concepts..... | 12 | +| 4.1.9 Tenant information concept..... | 12 | +| 4.2 Principles..... | 12 | +| 4.2.1 General Principles ..... | 12 | +| 4.2.2 Principles of network slicing management framework..... | 13 | +| 4.3 Management aspects of network slicing ..... | 13 | +| 4.3.1 Introduction ..... | 13 | +| 4.3.2 Preparation..... | 14 | +| 4.3.3 Commissioning..... | 14 | +| 4.3.4 Operation ..... | 14 | +| 4.3.5 Decommissioning..... | 14 | +| 4.4 Managed network slice concepts..... | 15 | +| 4.4.1 General ..... | 15 | +| 4.5 Network slice subnet concepts..... | 15 | +| 4.6 Slice profile and service profile concepts ..... | 16 | +| 4.6.1 Slice profile ..... | 16 | +| 4.6.2 Service profile ..... | 16 | +| 4.7 Coordination with management systems of non-3GPP parts..... | 16 | +| 4.8 Roles related to 5G networks and network slicing management ..... | 17 | +| 5 Business level requirements..... | 18 | +| 5.1 Requirements..... | 18 | +| 5.1.1 General requirements..... | 18 | +| 5.1.2 Network slicing management..... | 19 | +| 5.1.3 CM requirements ..... | 20 | +| 5.2 Actor roles ..... | 21 | +| 5.3 Telecommunication resources..... | 21 | +| 5.4 High-level use cases..... | 21 | +| 5.4.1 Network slicing supporting communication services..... | 21 | +| 5.4.2 Provisioning of a network slice instance ..... | 22 | +| 5.4.3 Provisioning of a NetworkSliceSubnet instance ..... | 23 | +| 5.4.4 Performance management of a NetworkSlice instance ..... | 24 | +| 5.4.5 Performance management of a NetworkSliceSubnet instance..... | 24 | +| 5.4.6 Report fault management data of a NetworkSlice instance..... | 25 | +| 5.4.7 Report fault management data of a NetworkSliceSubnet instance ..... | 25 | +| 5.4.8 Multiple operator support for network slicing..... | 26 | +| 5.4.9 Manage network slice with agreed performance..... | 26 | +| 5.4.10 Communication services using network with or without slicing ..... | 27 | +| 5.4.11 Exposure of network slice management data for Network Slice as a Service (NSaaS) case ..... | 27 | +| 5.4.12 Exposure of network slice management capability ..... | 28 | + +| | | | +|------------------------|-----------------------------------------------------------------------------------------|----| +| 5.4.13 | To modify the network slice instance due to changed demand..... | 28 | +| 5.4.14 | Management data analytics for 5G networks ..... | 29 | +| 5.4.15 | Capacity management of network slice instances and network slice subnet instances ..... | 29 | +| 6 | High level features ..... | 30 | +| 6.1 | General ..... | 30 | +| 6.2 | Self-Organizing Networks (SON) for 5G networks ..... | 30 | +| 6.3 | Management data analytics for 5G networks ..... | 30 | +| 6.4 | Closed loop SLS Assurance ..... | 30 | +| 6.5 | Energy Efficiency(EE) for 5G networks ..... | 30 | +| Annex A (informative): | Change history..... | 31 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +Network slicing is a key feature for 5G. Network slicing is a paradigm where logical networks/partitions are created, with appropriate isolation, resources and optimized topology to serve a purpose or service category (e.g. use case/traffic category, or for MNO internal reasons) or customers (logical system created "on demand"). + +# --- 1 Scope + +The present document specifies the concepts, use cases and requirements for management of network slicing in mobile networks. The 3GPP management system directly manages only the parts of the network that consist of network functions specified in 3GPP (e.g. 5G RAN, 5G CN and IMS). For the network functions specified by other SDOs, the management impact of network slicing is addressed as required. For example, regarding the Transport Network (TN) part supporting connectivity within and between CN and RAN parts, 3GPP management system may provide link requirements (e.g. topology, QOS parameters) to the TN management system. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.261 "Service requirements for next generation new services and markets". +- [3] 3GPP TS 23.501: " System Architecture for the 5G system". +- [4] 3GPP TS 38.401 "NG-RAN; Architecture description". +- [5] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [6] 3GPP TS 28.541: "Management and orchestration ; 5G Network Resource Model (NRM); Stage 2 and stage3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**network slice:** a logical network that provides specific network capabilities and network characteristics, supporting various service properties for network slice customers. + +NOTE 1: NetworkSlice Information Object Class (IOC) (refer to TS 28.541 [6]) is used to model network slice. + +NOTE 2: Represent network slice defined in TS 23.501 [3] with added service properties. + +**NetworkSlice instance:** A Managed Object Instance (MOI) of NetworkSlice IOC. + +NOTE 3: NetworkSlice instance represents service view of a network slice which exposes the root NetworkSliceSubnet instance . + +**network slice subnet:** a representation of a set of network functions and the associated resources (e.g. compute, storage and networking resources) supporting network slice. + +NOTE 4: NetworkSliceSubnet IOC (refer to TS 28.541 [x]) is used to model network slice subnet which may include core network functions and/or RAN network functions and/or other network slice subnets. The network slice instance defined in TS 23.501 [3] can be reflected via the NetworkSliceSubnet IOC and the allocated resources. + +**NetworkSliceSubnet instance:** A Managed Object Instance (MOI) of NetworkSliceSubnet IOC. + +**Service Level Specification (SLS) :** a set of service level requirements associated with a Service Level Agreement (SLA) to be satisfied by a network slice. + +NOTE: Void + +## 3.2 Abbreviations + +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]. + +| | | +|----------|-------------------------------------------| +| CSC | Communication Service Customer | +| CSMF | Communication Service Management Function | +| CSP | Communication Service Provider | +| DN | Data Network | +| MNO | Mobile Network Operator | +| NOP | Network Operator | +| NSaaS | Network Slice as a Service | +| NSaaS-C | Network Slice as a Service Customer | +| NSaaS-SP | Network Slice as a Service Provider | +| NSMF | Network Slice Management Function | +| NSC | Network Slice Customer | +| NSSMF | Network Slice Subnet Management Function | +| NSP | Network Slice Provider | +| SLA | Service Level Agreement | +| SLS | Service Level Specification | +| TN | Transport Network | + +# --- 4 Concepts and background + +## 4.1 General concepts + +### 4.1.1 Management of 5G networks and network slicing + +5G system consists of 5G Access Network (AN), 5G Core Network and UE, see TS 23.501 [3]. + +5G system is expected to be able to provide optimized support for a variety of different communication services, different traffic loads, and different end user communities, see clause 4 of TS 22.261 [2]. For example, the communication services using network slicing may include: + +- V2X services + +The 5G system aims to enhance its capability to meet KPIs that emerging V2X applications require. For these advanced applications, the requirements, such as data rate, reliability, latency, communication range and speed, are made more stringent, see clause 4 of TS 22.261 [2]. + +- 5G seamless eMBB service with FMC + +As one of the key technologies to enable network slicing, fixed mobile convergence (FMC) which includes wireless-to-the-everything (WTTx) and fibre-to-the-everything (FTTx), is expected to provide native support for network slicing. For optimization and resource efficiency, the 5G system will select the most appropriate 3GPP or non-3GPP access technology for a communication service, potentially allowing multiple access technologies to be used simultaneously for one or more services active on a UE, see clause 6.3 of TS 22.261 [2]. + +- massive IoT connections + +Support for massive Internet of Things (mIoT) brings many new requirements in addition to MBB enhancements, see clause 4 of TS 22.261 [2]. Communication services with massive IoT connections such as smart households, smart grid, smart agriculture and smart meter will require the support of a large number and high density IoT devices to be efficient and cost effective, see TS 23.501 [3]. Operators can use one or more network slices to provide these communication services, which require similar network characteristics, to different vertical industries. + +The next generation 3GPP management system is expected to support the management of 3GPP 5G system and 3GPP legacy systems. + +3GPP management system directly manages 3GPP managed network components (e.g. 5G RAN, 5G CN). For non-3GPP domains (e.g. DCN, TN), 3GPP management system needs to coordinate with the corresponding management systems of the non-3GPP domains. + +### 4.1.2 Types of communication services + +Communication services offered by Communication Service Providers (CSPs) to Communication Service Customers (CSCs) are of various categories, among which: + +- Business to consumer (B2C) services, e.g. mobile web browsing, 5G voice, Rich Communication Services, etc. +- Business to business (B2B) services, e.g. Internet access, LAN interconnection, etc. +- Business to household (B2H) services, e.g. Internet access, MBMS, VOIP, VPN, etc. +- Business to business to everything (B2B2X) services: e.g. services offered to other CSPs (e.g. international roaming, RAN sharing, etc.) offering themselves communication services to their own customers. B2B2X service type includes B2B2 applied recursively, i.e. B2B2B, B2B2B2B, etc. + +NOTE: How to derive different network slice related requirements from different categories of communication services is not in the scope of the present document. + +A communication service offered by CSPs can include a bundle of specific B2C, B2B, B2H or B2B2X type of services. Taking as an example the B2C type of services, a bundle could include: data (for mobile web browsing), voice (through 5G voice), and messaging (via Rich Communication Services). In this case, each one of the individual B2C may be fulfilled by different PDU connectivity services provided via corresponding PDU sessions. + +### 4.1.3 Communication services using network slices + +As an example, a variety of communication services provided by multiple network slice(s) are illustrated in the figure 4.1.3.1. Figure 4.1.3.1 is only for illustrative purposes to highlight the combination and relationship of communication services to network slices without depicting any UE. An actual network slice deployment offering communication services to UEs will need to comply with the 5G system architecture defined in TS 23.501 [3] and TS 38.401 [4]. + +![Diagram illustrating the relationship between communication services, network slices, and network slice subnets. The diagram is divided into two views: Management view and Network view. In the Management view, a box labeled CSC is at the top. Below it is a box labeled CSP containing a circle labeled CS. An arrow labeled 'offer' points from CS to CSC. Below the CSP box is a shaded box labeled NOP containing a circle labeled NS. An arrow points from NS to CS. In the Network view, a box labeled 'Network Slice' contains three boxes: NF, NF, and DN. A dashed line connects NS in the Management view to the first NF in the Network view.](ebff22fb5dd6f50a90e44dca0f82f285_img.jpg) + +Diagram illustrating the relationship between communication services, network slices, and network slice subnets. The diagram is divided into two views: Management view and Network view. In the Management view, a box labeled CSC is at the top. Below it is a box labeled CSP containing a circle labeled CS. An arrow labeled 'offer' points from CS to CSC. Below the CSP box is a shaded box labeled NOP containing a circle labeled NS. An arrow points from NS to CS. In the Network view, a box labeled 'Network Slice' contains three boxes: NF, NF, and DN. A dashed line connects NS in the Management view to the first NF in the Network view. + +**Figure 4.1.3.1: A variety of communication services provided by multiple network slices** + +Figure 4.1.3.1 illustrates the relationship between communication services, network slices, and network slice subnets: + +- network slice subnet AN-1 and network slice subnet AN-2 each contain distinct sets of AN NFs. network slice subnet CN-1, network slice subnet CN-2 and network slice subnet CN-3 each contain distinct sets of CN NFs. The TN supporting connectivity facilitates the communication between CN and AN NFs. network slice subnet A combines network slice subnet AN-1 with network slice subnet CN-1 and corresponding TN connectivity. network slice subnet B combines network slice subnet AN-2 and network slice subnet CN-2 and corresponding TN connectivity. network slice subnet C combines network slice subnet AN-2 with network slice subnet CN-3 and corresponding TN connectivity. The network slice subnet AN-2 is shared between network slice subnet B and network slice subnet C, while network slice subnet AN-1 is dedicated to network slice subnet A. +- NOP offers network slice subnet A as a network slice A, in this relationship network slice A represents network slice subnet A with associated Service Level Specification (SLS). NOP also offers network slice subnet B as network slice B and network slice subnet C as network slice C. The SLS of network slice A satisfies the service requirements of communication service 1 and communication service 2. The SLS of network slice B satisfies the service requirements of communication service 2. The SLS of network slice C satisfies the service requirements of communication service 3. +- The communication service 1 is supported by network slice A. The communication service 2 may be supported by either network slice A or network slice B. The communication service 3 is supported by network slice C. + +### 4.1.4 Communication services requirements + +eMBB service type aims at supporting high data rates and high traffic densities as outlined in TS 22.261 [2], Table 7.1-1 "Performance requirements for high data rate and traffic density scenarios". URLLC service type aims at supporting the requirements in TS 22.261 [2], Table 7.2.2-1 "Performance requirements for low-latency and high-reliability services." related to high reliability and low latency scenarios. mIoT service type aims at supporting a large number and high density of IoT devices efficiently and cost effectively, see TS 23.501 [3]. + +Depending on the service type (eMBB, URLLC, mIoT), different service types may include different network slice related requirements, for example: + +- Area traffic capacity requirement + +- Charging requirement +- Coverage area requirement +- Degree of isolation requirement +- End-to-end latency requirement +- Mobility requirement +- Overall user density requirement +- Priority requirement +- Service availability requirement +- Service reliability requirement +- UE speed requirement + +### 4.1.5 NetworkSlice instance Lifecycle and relationship to service instances + +An NetworkSlice instance may support multiple service instances if it satisfies their service level requirements or has been modified to support these requirements. When a service instance is to be supported, it may trigger an operation phase of the NetworkSlice instance lifecycle for activation or modification(s) of an existing NetworkSlice instance, or it may trigger a commissioning phase of the NetworkSlice instance lifecycle for creation of a new NetworkSlice instance. When a service instance no longer needs to be supported by an NetworkSlice instance, it may trigger an operation phase of the NetworkSlice instance lifecycle for de-activation or modification(s) of an existing NetworkSlice instance, or it may trigger a decommissioning phase of the NetworkSlice instance lifecycle for termination of an existing NetworkSlice instance. + +### 4.1.6 Network Slice as a Service (NSaaS) + +Network Slice as a Service (NSaaS) can be offered by a CSP to its CSC in the form of a service. This service allows CSC to use the network slice as the end user or optionally allows CSC to manage the network slice as manager via management interface exposed by the CSP. In turn, these CSC can play the role of CSP and offer their own services (e.g. communication services) on top of the network slice obtained from the CSP. For example, a network slice customer can also play the role of NOP and could build their own network containing the network slice obtained from the CSP as a "building block". In this model, both CSP offering NSaaS and CSC consuming NSaaS have the knowledge of the existence of network slices. Depending on service offering, CSP offering NSaaS may impose limits on the NSaaS management capabilities exposure to the CSC, and the CSC can manage the network slice according to NSaaS management capabilities exposed and agreed upon limited level of management by the CSP. + +The NSaaS offered by the CSP could be characterized by certain properties (capabilities to satisfy service level requirements), e.g. + +- radio access technology, +- bandwidth, +- end-to-end latency, +- reliability, +- guaranteed / non-guaranteed QoS, +- security level, etc. + +Figure 4.1.6.1 illustrates some examples on how network slices can be utilized to deliver communication services, including network slice as a Service. For simplicity this figure omits the details of how NFs are being managed and does not show their groupings into network slice subnet: + +- a) A Network Slice as a Service (NSaaS) is provided to CSC-A by CSP-A. Unlike the communication service delivered to end customers, in NSaaS, the offered service is the actual network slice. + +- b) CSC-A can use the network slice obtained from CSP-A to support own Communication Services or may add additional network functions to the obtained NSaaS and offer the resulting combination as a new network slice to CSP-B. In this case, CSC-A plays the role of NOP-B and builds his own network. The network slice obtained by CSC-A from CSP-A becomes a "building block" or a network slice subnet of CSC-A in its role of NOP-B. The NOP-B (a.k.a. CSC-A) combines this network slice subnet with other network slice subnets and offers the new network slice subnet as network slice to CSP-B. +- c) CSP-B can use the network slice obtained from CSC-A / NOP-B to deliver communication services to its end customers (as CSC-B). + +![Figure 4.1.6.1: Examples of Network Slice as a Service (NSaaS) being utilized to deliver communication services to end customers. The diagram is split into two parts, (a) and (b), each showing a 'Management view' and a 'Network view'.](5b4e774d63e0e0ed73801a9247755e5f_img.jpg) + +The diagram illustrates two scenarios for utilizing network slices. +**Part (a):** In the Management view, CSP-A offers NSaaS to NOP-A, which is associated with an NS. In the Network view, a Network Slice is shown containing two NF (Network Function) blocks. +**Part (b):** In the Management view, CSP-B offers CS to CSC-B / NOP-B, which is associated with an NS. In the Network view, a Network Slice is shown containing two NF blocks and a DN (Data Network) block. +Arrows indicate the flow of services: 'offer' from CSP-A to NSaaS, 'associates' from NSaaS to NS, and 'offer' from CSP-B to CS. Dashed lines connect the Management view components to the Network view components. + +Figure 4.1.6.1: Examples of Network Slice as a Service (NSaaS) being utilized to deliver communication services to end customers. The diagram is split into two parts, (a) and (b), each showing a 'Management view' and a 'Network view'. + +**Figure 4.1.6.1: Examples of Network Slice as a Service (NSaaS) being utilized to deliver communication services to end customers** + +NOTE: In Figure 4.1.6.1, NS represents network slice, CS represents communication service + +### 4.1.7 Network slices as NOP internals + +In the "network slices as NOP internals" model, network slices are not part of the NOP service offering and hence are not visible to its customers. However, the NOP, to provide support to communication services, may decide to deploy network slices, e.g. for internal network optimization purposes. This model allows CSC to use the network as the end user or optionally allows CSC to monitor the service status (assurance of the SLA associated with the internally offered network slice). + +The CSP should be able to provide the service status information (e.g. service performance, fault information, traffic data, etc) to CSC via the management exposure interface. + +Figure 4.1.7.1 illustrates an example on how network slices can be utilized to deliver communication services: + +- a) A network slice is used as NOP internal, and CSP delivers communication services to end customers (CSC). +- b) The CSC should be able to monitor the network and service status information (e.g. service performance, fault information, traffic data, etc.) provided by CSP. + +![Diagram illustrating network slice delivery concepts. It shows three layers: Management view, Network view, and a top layer with CSC and CSP. The Management view contains a Communication Service (CS) and a Network Slice (NS). The Network view contains two Network Functions (NF) and a Data Network (DN) within a Network Slice. Arrows show the flow from CSC to CS, CS to NS, and NS to the Network Slice.](d4af765160d04ecef538e5066006dc77_img.jpg) + +The diagram illustrates the relationship between different views of a network slice. At the top, a box contains 'CSC' and 'CSP'. An arrow labeled 'offer' points from 'CSP' to 'CS' (Communication Service) in the 'Management view'. Below 'CS' is 'NS' (Network Slice) in the 'Management view', connected by a solid arrow. Below the 'Management view' is the 'Network view', which contains a 'Network Slice' box. Inside this box are two 'NF' (Network Function) boxes and a 'DN' (Data Network) box. A dashed arrow points from 'NS' in the Management view to the 'Network Slice' in the Network view. + +Diagram illustrating network slice delivery concepts. It shows three layers: Management view, Network view, and a top layer with CSC and CSP. The Management view contains a Communication Service (CS) and a Network Slice (NS). The Network view contains two Network Functions (NF) and a Data Network (DN) within a Network Slice. Arrows show the flow from CSC to CS, CS to NS, and NS to the Network Slice. + +**Figure 4.1.7.1: Examples of network slice as NOP internals** + +NOTE: In Figure 4.1.7.1, NS represents network slice, CS represents communication service + +### 4.1.8 Network slice delivery concepts + +Network slices are provided in different compositions to the customer which may include access to different management capabilities and network slice provisioning procedures for the customer. + +For example, a network slice may be delivered + +- to meet customer's communication service requirements without any exposure of internal network slice structures (applicable to both individual subscribers and NSaaS); or +- to meet the network slice requirements, with some exposure of the internal network slice structures (e.g. NFs, topology, etc.) and with some network monitoring capability as enabled by the provider; or +- to meet the network slice requirements with some exposure of the internal network slice structures (e.g. NFs) with some management capabilities as enabled by the provider. + +### 4.1.9 Tenant information concept + +The purpose of tenant information concept is to support multiple tenant environment in 5G network management. The 3GPP management system may use tenant information for the following: + +- Associating communication services with the tenant. +- Controlling access of the tenant in relation to management capabilities. + +## 4.2 Principles + +### 4.2.1 General Principles + +The 5G network management framework is built upon the following principles: + +- Support management of 5G networks with or without network slicing features. +- Support management across multiple operator's scenario. +- Support interaction with non-3GPP management system. +- Support service-based management. + +### 4.2.2 Principles of network slicing management framework + +The 5G network slicing management framework is built upon the following principles: + +1. Standardized management service interfaces of the network slicing management services. +2. Standardized management service interfaces of network function management services. +3. Multi-vendor interaction utilizing the standardized management service interfaces of the network slicing management services, as well as the standardized management service interfaces of the network function related management functions. +4. A simple network slicing set of management functions to simplify the management of network function(s) from the slicing management point-of-view. +5. Network slicing management services are capable to support various Network Operator deployment options to support diverse use cases, and a set of generic management services applicable to all kinds of network functions. + +Figure 4.2.2.1 illustrates the basic principle of standardized management services for network slicing management related capabilities. + +![Diagram illustrating the basic principle of standardized management services for network slicing management related capabilities. It shows two boxes: 'Network slicing management services' on the left and 'Network function management services' on the right. Both boxes are connected to a central label 'Standardized management services' via lines with circular endpoints.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +The diagram shows two rectangular boxes side-by-side. The left box is labeled 'Network slicing management services' and the right box is labeled 'Network function management services'. Above the boxes, the text 'Standardized management services' is centered. Two vertical lines with small circles at their top ends connect each box to this central text. + +Diagram illustrating the basic principle of standardized management services for network slicing management related capabilities. It shows two boxes: 'Network slicing management services' on the left and 'Network function management services' on the right. Both boxes are connected to a central label 'Standardized management services' via lines with circular endpoints. + +**Figure 4.2.2.1: Standardized network slicing management services and network function management services** + +## 4.3 Management aspects of network slicing + +### 4.3.1 Introduction + +This clause describes management aspects of network slicing, which can be described by the four phases shown in Figure 4.3.1.1, the phases are: + +- Preparation +- Commissioning +- Operation +- Decommissioning + +![Figure 4.3.1.1: Management aspects of network slicing. A flowchart showing the lifecycle of a Network Slice Instance. The lifecycle is divided into four main phases: Preparation, Commissioning, Operation, and Decommissioning. Preparation includes Design, On-boarding, and Network environment preparation. Commissioning includes Creation. Operation includes Activation, Supervision, Reporting, Modification, and De-activation. Decommissioning includes Termination. The entire lifecycle is enclosed in a dashed box labeled 'Lifecycle of a Network Slice Instance'.](4801720824e4b5e2361a5564f91cfb70_img.jpg) + +``` + +graph LR + subgraph Preparation + Design[Design] --> Onboarding[On-boarding] + NetworkEnv[Network environment preparation] + end + subgraph Commissioning + Creation[Creation] + end + subgraph Operation + Activation[Activation] + subgraph Supervision_Reporting [Supervision and Reporting] + Supervision[Supervision] + Reporting[Reporting] + end + Modification[Modification] + Deactivation[De-activation] + Supervision <--> Modification + Reporting <--> Modification + end + subgraph Decommissioning + Termination[Termination] + end + Preparation --> Commissioning + Commissioning --> Activation + Activation --> Supervision + Deactivation --> Termination + Termination --> Decommissioning + style Preparation fill:none,stroke-dasharray: 5 5 + style Commissioning fill:none,stroke-dasharray: 5 5 + style Operation fill:none,stroke-dasharray: 5 5 + style Decommissioning fill:none,stroke-dasharray: 5 5 + style Design fill:none,stroke-dasharray: 5 5 + style Onboarding fill:none,stroke-dasharray: 5 5 + style NetworkEnv fill:none,stroke-dasharray: 5 5 + style Creation fill:none,stroke-dasharray: 5 5 + style Activation fill:none,stroke-dasharray: 5 5 + style Supervision fill:none,stroke-dasharray: 5 5 + style Reporting fill:none,stroke-dasharray: 5 5 + style Modification fill:none,stroke-dasharray: 5 5 + style Deactivation fill:none,stroke-dasharray: 5 5 + style Termination fill:none,stroke-dasharray: 5 5 + subgraph Lifecycle [Lifecycle of a Network Slice Instance] + Commissioning + Operation + Decommissioning + end + Lifecycle -.-> Preparation + Lifecycle -.-> Termination + +``` + +Figure 4.3.1.1: Management aspects of network slicing. A flowchart showing the lifecycle of a Network Slice Instance. The lifecycle is divided into four main phases: Preparation, Commissioning, Operation, and Decommissioning. Preparation includes Design, On-boarding, and Network environment preparation. Commissioning includes Creation. Operation includes Activation, Supervision, Reporting, Modification, and De-activation. Decommissioning includes Termination. The entire lifecycle is enclosed in a dashed box labeled 'Lifecycle of a Network Slice Instance'. + +**Figure 4.3.1.1: Management aspects of network slicing** + +Each phase, described in subsequent clauses, defines high level tasks and should include appropriate verification of the output of each task. + +### 4.3.2 Preparation + +In the preparation phase the NetworkSlice instance does not exist. The preparation phase includes network slice design, network slice capacity planning, on-boarding and evaluation of the network functions, preparing the network environment and other necessary preparations required to be done before the creation of an NetworkSlice instance. + +### 4.3.3 Commissioning + +NetworkSlice instance provisioning in the commissioning phase includes creation of the NetworkSlice instance. During NetworkSlice instance creation all needed resources are allocated and configured to satisfy the network slice requirements. The creation of an NetworkSlice instance can include creation and/or modification of the NetworkSlice instance constituents. + +### 4.3.4 Operation + +The Operation phase includes the activation, supervision, performance reporting (e.g. for KPI monitoring), resource capacity planning, modification, and de-activation of an NetworkSlice instance. + +Activation makes the NetworkSlice instance ready to support communication services. + +Resource capacity planning includes any actions that calculates resource usage based on an NetworkSlice instance provisioning, and performance monitoring and generates modification policies as a result of the calculation. + +NOTE: Automation of resource capacity planning is out of scope of the present document. + +NetworkSlice instance modification could be including e.g. capacity or topology changes. The modification can include creation or modification of NetworkSlice instance constituents. NetworkSlice instance modification can be triggered by receiving new network slice requirements or as the result of supervision/reporting + +The deactivation includes actions that make the NetworkSlice instance inactive and stops the communication services. + +Network slice provisioning actions in the operation phase involves activation, modification and de-activation of an NetworkSlice instance. + +### 4.3.5 Decommissioning + +NetworkSlice instance provisioning in the decommissioning phase includes decommissioning of non-shared constituents if required and removing the NetworkSlice instance specific configuration from the shared constituents. After the decommissioning phase, the NetworkSlice instance is terminated and does not exist anymore. + +## 4.4 Managed network slice concepts + +### 4.4.1 General + +From a management point of view a network slice is complete in the sense that it includes all the network function instances, with their supporting resources, to provide service for certain business purpose (e.g. to support a certain set of communication services, provide PNI-NPNs, etc. in NSaaS model) or operational efficiencies purpose (e.g. to + +optimize operator internal O&M procedures in network slice as NOP internals model). In other words, the network slice is complete because it completely satisfies the associated SLS. + +The following concepts are related to network slicing management: + +- a. Services which are supported by network slices (services whose service level requirements are satisfied by the SLS associated with the network slices). +- b. Network slice subnet instances and networks composed of PNF, VNF or both and offered as network slices. +- c. Network function (PNFs, VNFs) grouped into network slice subnets. +- d. Resources which support the network (e.g. virtualized resource, non-virtualized resource) + +The management aspects of the network slice are represented by management of the CN part, and AN part which are directly managed by the 3GPP management system, and management of non-3GPP part which is not directly managed by the 3GPP management system. The non-3GPP part includes TN parts. The 3GPP management system provides the network slice requirements to the corresponding management systems of those non-3GPP parts, e.g. the TN part supports connectivity within and between CN and AN parts. For the TN part, the 3GPP management system provides the TN topology requirements and individual TN links' QoS attributes requirements to the TN management system. + +The 3GPP management system maintains the network topology and the related QOS requirements. + +![Diagram of a network slice instance showing App (UE) connected to RAN NFs, which are connected to a central TN, which is connected to CN NFs, which are connected to an App Server. The RAN NFs, TN, and CN NFs are grouped within a dashed blue box labeled 'Network Slice Instance'.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +The diagram illustrates a network slice instance. On the left, three 'App (UE)' circles are connected to three 'RAN NFs' (Radio Access Network Network Functions) inside a dashed blue box labeled 'Network Slice Instance'. Each 'RAN NF' is connected to a central 'TN' (Transport Network) circle. The 'TN' circle is connected to three 'CN NFs' (Core Network Network Functions) inside the same dashed blue box. Each 'CN NF' is connected to a 'TN' circle, which is then connected to an 'App Server' circle on the right. The 'RAN NFs', 'TN', and 'CN NFs' are grouped within the 'Network Slice Instance' box, indicating they are part of the slice's internal components. + +Diagram of a network slice instance showing App (UE) connected to RAN NFs, which are connected to a central TN, which is connected to CN NFs, which are connected to an App Server. The RAN NFs, TN, and CN NFs are grouped within a dashed blue box labeled 'Network Slice Instance'. + +**Figure 4.4.1.1: Example of a network slice** + +## 4.5 Network slice subnet concepts + +The network slice subnet represents a group of network functions (including their corresponding resources) that form part or complete constituents of a network slice. The grouping of the network functions allows the management of each group of network functions to be conducted independently of the network slice. + +The network slice subnet concepts include the following aspects: + +- A network slice subnet constituent may include network function(s) and other constituent network slice subnet(s). +- A network slice subnet may be shared by two or more network slices, this is called a shared constituent of network slice. This sharing may be direct or indirect. The direct sharing implies that the network slice subnet is offered as network slice multiple times. The indirect sharing implies that the network slice subnet is either a constituent of a network slice subnet shared by two or more network slices, or is shared by two or more network slice subnet(s) which are in turn offered as different network slices. +- A network slice subnet may be shared by two or more network slice subnet(s), this is also called a shared constituent of network slice subnet. The sharing may be direct or indirect. The direct sharing implies that network slice subnet is a constituent of two or more network slice subnets. The indirect sharing implies that network slice subnet is a constituent of a shared network slice subnet. +- A network slice subnet that is dedicated to one network slice and is not shared as a constituent by two or more network slice subnet(s) is called a non-shared network slice subnet. + +- A network slice subnet may contain instances of CN network functions only, or instances of AN network functions only, or any combination thereof. +- A network slice subnet may additionally have information representing a set of links with capacities to provide connection between network functions. This information is also known as TN requirements of the network slice subnet. +- The resources used, and whose management aspects are represented by a network slice subnet comprise physical and logical resources. In case of virtualization, virtualized resources may be used. + +## 4.6 Slice profile and service profile concepts + +### 4.6.1 Slice profile + +The network slice subnet has an associated set of requirements (e.g. those derived from service level requirements) that are applicable to the network slice subnet constituents, such set is called slice profile. TN requirements (e.g. set of QoS attributes for the links interconnecting network slice subnet constituent network functions) is an example of requirements that may be included in the slice profile. The slice profile may be common (applicable to all network slice subnet constituents, regardless of their types) or specific (applicable to only AN network function or only to CN network function network slice subnet constituents). + +### 4.6.2 Service profile + +Depending on industry requirements and operator's requirements, different service profiles may be used to represent SLS associated with network slices. + +The following are examples for service profiles: + +- A service profile is used to capture a set of requirements for the new network slice such as (eMBB, MIoT, URLLC). +- A service profile is used to capture a set of specific industry requirements for creation of network slice such as V2X, smart grid, Remote Healthcare. + +## 4.7 Coordination with management systems of non-3GPP parts + +When providing an end to end communication service, the network may use non-3GPP parts (e.g. Data centre network (DCN), Transport network (TN)) in addition to the network components defined in 3GPP. Therefore, in order to ensure the performance of a communication service according to the business requirements, the 3GPP management system has to coordinate with the management systems of the non-3GPP parts (e.g., MANO system) when preparing a network slice for this service. This coordination may include obtaining capabilities of the non-3GPP parts and providing the slice specific requirements and other requirements on the non-3GPP parts. Figure 4.7.1 illustrates an example for the coordination with management of TN part (e.g., directly or via MANO system). + +The 3GPP management system identifies the requirements on involved network domains, such as RAN, CN and non-3GPP parts of a slice by deriving them from the customer requirements to the services supported by the network slice. The derived requirements are sent to the corresponding management systems. The coordination may also include related management data exchange between those management systems and the 3GPP management system. + +![Diagram illustrating the coordination between 3GPP and TN management systems. At the top, a dashed box labeled '3GPP Mgmt System' is connected to a 'TN Mngt Sys' box below it. The '3GPP Mgmt System' has arrows labeled 'Manage RAN' and 'Manage CN' pointing to the 'RAN' and 'CN' sections respectively. The 'TN Mngt Sys' has an arrow labeled 'TN COOR' pointing to the 'RAN' section. The 'RAN' section contains 'Users', 'RAN NFs', and 'TN' nodes. The 'CN' section contains 'CN NFs' and 'TN' nodes. The 'RAN' and 'CN' sections are connected by a 'TN' node. The 'CN' section is connected to an 'APP Server'.](8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg) + +Diagram illustrating the coordination between 3GPP and TN management systems. At the top, a dashed box labeled '3GPP Mgmt System' is connected to a 'TN Mngt Sys' box below it. The '3GPP Mgmt System' has arrows labeled 'Manage RAN' and 'Manage CN' pointing to the 'RAN' and 'CN' sections respectively. The 'TN Mngt Sys' has an arrow labeled 'TN COOR' pointing to the 'RAN' section. The 'RAN' section contains 'Users', 'RAN NFs', and 'TN' nodes. The 'CN' section contains 'CN NFs' and 'TN' nodes. The 'RAN' and 'CN' sections are connected by a 'TN' node. The 'CN' section is connected to an 'APP Server'. + +**Figure 4.7.1: Example of coordination between 3GPP and TN management systems** + +## 4.8 Roles related to 5G networks and network slicing management + +In the context of next generation networks, responsibilities regarding operations have to be clearly defined and assigned to roles. The roles related to 5G networks and network slicing management include: + +- Communication Service Customer (CSC): Uses communication services. +- Communication Service Provider (CSP): Provides communication services. Designs, builds and operates its communication services. The CSP provided communication service can be built with or without network slice. +- Network Operator (NOP): Designs, builds and operates networks and provides related services, including network services and network slices. +- Network Equipment Provider (NEP): Supplies network equipment to network. For sake of simplicity, VNF Supplier is considered here as a type of Network Equipment Provider. This can be provided also in the form of one or more appropriate VNF(s). +- Virtualization Infrastructure Service Provider (VISP): Provides virtualized infrastructure services. Designs, builds and operates its virtualization infrastructure(s). Virtualization Infrastructure Service Providers may also offer their virtualized infrastructure services to other types of customers including to Communication Service Providers directly, i.e. without going through the Network Operator. +- Data Centre Service Provider (DCSP): Provides data centre services. Designs, builds and operates its data centres. +- NFVI Supplier: Supplies network function virtualization infrastructure to its customers. +- Hardware Supplier: Supplies hardware. + +Depending on actual scenarios: + +- each role can be played by one or more organizations simultaneously; +- an organization can play one or several roles simultaneously (for example, a company can play CSP and NOP roles simultaneously). + +![Figure 4.8.1: High-level model of roles. A hierarchical diagram showing the relationships between various network roles. At the top is 'Communication Service Customer' (Client) connected to 'Communication Service Provider' (Provider). Below CSP is 'Network Operator' (Client) connected to 'Network Equipment Provider (incl. VNF Supplier)' (Provider). Below NO is 'Virtualization Infrastructure Service Provider' (Client) connected to 'NFVI Supplier' (Provider). Below VISP is 'Data Center Service Provider' (Client) connected to 'Hardware Supplier' (Provider). A bracket on the left groups the top two roles with the text 'E.g.: End user, Small & Medium Enterprise, Large enterprise, Vertical, Other CSP, etc.'](76b0cd79baaedd942af4dc42f2e764b8_img.jpg) + +``` + +graph TD + CSC[Communication Service Customer] -- Client --> CSP[Communication Service Provider] + CSP -- Provider --> CSC + NO[Network Operator] -- Client --> NEP[Network Equipment Provider incl. VNF Supplier] + NEP -- Provider --> NO + VISP[Virtualization Infrastructure Service Provider] -- Client --> NFVI[NFVI Supplier] + NFVI -- Provider --> VISP + DCSP[Data Center Service Provider] -- Client --> HS[Hardware Supplier] + HS -- Provider --> DCSP + +``` + +Figure 4.8.1: High-level model of roles. A hierarchical diagram showing the relationships between various network roles. At the top is 'Communication Service Customer' (Client) connected to 'Communication Service Provider' (Provider). Below CSP is 'Network Operator' (Client) connected to 'Network Equipment Provider (incl. VNF Supplier)' (Provider). Below NO is 'Virtualization Infrastructure Service Provider' (Client) connected to 'NFVI Supplier' (Provider). Below VISP is 'Data Center Service Provider' (Client) connected to 'Hardware Supplier' (Provider). A bracket on the left groups the top two roles with the text 'E.g.: End user, Small & Medium Enterprise, Large enterprise, Vertical, Other CSP, etc.' + +**Figure 4.8.1: High-level model of roles** + +In case of Network Slice as a Service (NSaaS) (cf. clause 4.1.6), the Communication Service Provider (CSP) role can be refined into NSaaS Provider (NSaaS-P) role – or, in short, Network Slice Provider (NSP) - and the Communication Service Customer (CSC) role can be refined into NSaaS Customer (NSaaS-C) role – or, in short, Network Slice Customer (NSC). A NSC can, in turn, offer its own communication services to its own customers, being thus CSP at the same time. A tenant might take the role of a NSC. + +## 4.9 Void + +# 5 Business level requirements + +## 5.1 Requirements + +### 5.1.1 General requirements + +**REQ-5GNS-CON-01** The network slicing management architecture shall allow any deployment options within the Network Operator's domain. + +**REQ-5GNS-CON-02** The set of network slicing management functions shall be generic to all kinds of network function and network function provider. + +**REQ-5GNS-CON-05** The network slicing management architecture shall provide capabilities to manage the total view of all created slice instances. + +**REQ-5GNS-CON-06** The network slicing management architecture should provide management capabilities that are dedicated to each network slice. The management dedicated to a network slice shall work independently from the management dedicated to another network slice. + +**REQ-5GNS-CON-07** The network slicing management architecture shall allow managing multiple network slices simultaneously or independently along with their lifecycle. + +**REQ-5GNS-CON-08** The 3GPP management system shall have the capability to determine to use network with or without slicing based on network related requirements. + +**REQ-5GNS-CON-09** The 3GPP management system shall, when given the capacity increase or decrease of a network slice, be able to calculate the capacity increase or decrease of a RAN slice subnet, CN slice subnet and derive corresponding requirements for the TN part that support the network slice. + +**REQ-5GNS-CON-10** The 3GPP management system shall be able to modify the capacity of a RAN slice subnet to a given value. + +**REQ-5GNS-CON-11** The 3GPP management system shall be able to modify the capacity of a CN slice subnet to a given value. + +**REQ-5GNS-CON-12** The 3GPP management system shall be able to communicate the TN requirements corresponding to the network slice capacity change. + +**REQ-5GNS-CON-13** The 3GPP management system shall be able to provide management data analytics to authorized consumers. + +**REQ-5GNS-CON-14** The 3GPP management system shall be able to collect and analyse relevant management data. + +**REQ-MnSD-FUN-15** The MnS producer shall have the capability allowing its authorized consumer to obtain information about MnS capabilities. + +### 5.1.2 Network slicing management + +**REQ-3GPPMS-CON-01** The 3GPP management system shall have the capability to create a new or use an existing NetworkSlice instance according to the communication service requirements. + +**REQ-3GPPMS-CON-02** The 3GPP management system shall have the capability to translate the communication service requirements to network slice related requirements. + +**REQ-3GPPMS-CON-03** The 3GPP management system shall have the capability to create a new or use an existing NetworkSlice instance according to the network slice related requirements + +**NOTE:** The network slice related requirements include requirements such as: area traffic capacity, charging, coverage area, degree of isolation, end-to-end latency, mobility, overall user density, priority, service availability, service reliability, UE speed. + +**REQ-3GPPMS -CON-04** The 3GPP management system shall be able to create a NetworkSlice instance. + +**REQ-3GPPMS -CON-05** The 3GPP management system shall have the capability to monitor the network slice related data and provide the agreed data to an authorized consumer. + +**REQ-3GPPMS -CON-06** The 3GPP management system shall be able to create a NetworkSliceSubnet instance. + +**REQ-3GPPMS-CON-07** The 3GPP management system shall be able to evaluate the feasibility of providing a new NetworkSlice instance which does not impact with the existing NetworkSlice instance(s). + +**REQ-3GPPMS-CON-07a** The 3GPP management system should have the capability of allocating the resources of NetworkSlice instances according to the priority. + +**REQ-3GPPMS-CON-08** The 3GPP management system should have the capability of re-allocating the resources of NetworkSlice instances according to the priority. + +**REQ-3GPPMS-CON-09** The 3GPP management system shall be able to manage the NetworkSlice instance lifecycle. + +**REQ-3GPPMS-CON-10** The 3GPP management system shall be able to provide link requirements related to the network slice (e.g. topology, QOS parameters) to the appropriate management system that handles the TN part related to the slice (e.g. via NFV MANO). + +**REQ-3GPPMS-CON-11** The 3GPP management system shall be able to report performance measurement data of a NetworkSlice instance to the NOP. + +**REQ-3GPPMS-CON-12** The 3GPP management system shall be able to report performance measurement data of a NetworkSliceSubnet instance to the NOP. + +**REQ-3GPPMS-CON-13** The 3GPP management system shall be able to report fault management data of a NetworkSlice instance. + +**REQ-3GPPMS-CON-14** The 3GPP management system shall be able to report fault management data of a NetworkSliceSubnet instance. + +**REQ-3GPPMS-CON-15** The 3GPP management system shall be able to activate a NetworkSlice instance. + +**REQ-3GPPMS-CON-16** The 3GPP management system shall be able to de-activate a NetworkSlice instance. + +**REQ-3GPPMS-CON-17** The 3GPP management system shall be able to modify a NetworkSlice instance. + +**REQ-3GPPMS-CON-18** The 3GPP management system shall be able to terminate a NetworkSlice instance. + +**REQ-3GPPMS-CON-19** The 3GPP management system shall be able to activate a NetworkSliceSubnet instance. + +**REQ-3GPPMS-CON-20** The 3GPP management system shall be able to modify a NetworkSliceSubnet instance. + +**REQ-3GPPMS-CON-21** The 3GPP management system shall be able to de-activate a NetworkSliceSubnet instance. + +**REQ-3GPPMS-CON-22** The 3GPP management system shall be able to terminate a NetworkSliceSubnet instance. + +**REQ-3GPPMS-CON-23** The 3GPP management system shall support slice capacity management. + +**REQ-3GPPMS-CON-24** The 3GPP management system shall support inter-slice orchestration (e.g., orchestrated provisioning of multiple slices and resolving issues on quality, fault, and anomaly, among multiple slices). + +**REQ-3GPPMS-CON-25** The 3GPP management system shall support collection and analysis of the status and events of the NetworkSlice instance resources for the purpose of fault management. + +**REQ-3GPPMS-CON-26** The 3GPP management system shall support collection and analysis of the status and events of the NetworkSlice instance resources for the purpose of performance management. + +**REQ-3GPPMS-CON-27** The 3GPP management system shall have the capability of exposing network slice management data for Network Slice as a Service (NSaaS) to the authorized consumer. + +**REQ-3GPPMS-CON-28** The 3GPP management system shall have the capability to differentiate communication services provided by a single NetworkSlice instance when the NetworkSlice instance is used to support multiple communication services. + +**REQ-3GPPMS-CON-29** The 3GPP management system shall have the capability to perform network slice related operations (e.g., performance monitoring) considering requirements for each communication service when the network slice is used to support multiple communication services. + +**REQ-3GPPMS-CON-30** The 3GPP management system shall be able to expose the network slice management services such as performance management, fault supervision and provisioning management to the authorized consumer based on the mutual agreement between consumer and operator. + +**REQ-3GPPMS-CON-31** The 3GPP management system shall have the capability to expose, based on the mutual agreement between consumer and operator, the network slice assurance services to the authorized consumers. + +**REQ-3GPPMS-CON-32** The 3GPP management system shall have the capability to expose, based on the mutual agreement between consumer and operator, the network slice control and configuration services to the authorized consumers and to resolve potential conflicts + +### 5.1.3 CM requirements + +**REQ-3GPPCM-CON-01** The 3GPP management system shall have a capability to configure NF instances. + +## 5.2 Actor roles + +Consumers of a network management service. A consumer can be a Network Operator (NOP) or Communication Service Provider (CSP). + +## 5.3 Telecommunication resources + +The Telecommunication resources include network management functions and/or the managed network functions/resources. + +## 5.4 High-level use cases + +### 5.4.1 Network slicing supporting communication services + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | A communication service provider (CSP) uses the network slicing service provided by operator to offer communication services to end users. | | +| <b>Actors and Roles</b> | A CSP request a NOP to provide a network slice | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The CSP and the operator negotiate and sign the communication service requirements contract a.k.a. Service Level Agreement (SLA). | | +| <b>Begins when</b> | The CSP declares communication service(s) requirements to the operator. These requirements are called Service Level Specification (SLS). The operator triggers the NetworkSlice instance preparation phase which includes the on-boarding and verification of network function products, feasibility check, preparing the necessary network environment, which are used to support the lifecycle of NetworkSlice instances and any other preparations that are needed in the network. | | +| <b>Step 1 (M)</b> | Based on the SLS (e.g. coverage area, number and distribution of users, traffic demand, mobility, latency, etc.), the operator prepares the corresponding NetworkSlice instance. | | +| <b>Step 2 (M)</b> | After the NetworkSlice instance preparation phase, the operator triggers the deployment of an NetworkSlice instance.<br>1) If the CSP plans to operate services across multiple operators' administrative domains, this may require cross-country operations. The operator management system will perform cross-domain collaboration with the management systems from other administrative domains for NetworkSlice instance deployment.<br>2) If customization of TN is required, the operator management system and TN management system will first cooperate on network planning of TN.<br>3) The operator management system performs overall mapping and coordination among different technical domains in order to provide the end-to-end services via the NetworkSlice instance. If CSP uses the NSaaS provided by operator to offer multiple communication services to end users, related operations (e.g., performance monitoring) are performed considering requirements for each communication service. | | +| <b>Step 3 (O)</b> | If requested, the operator provides management data of the NetworkSlice instance to the authorized CSP according to the communication service requirements.<br>Examples of management data that could be provided to CSP include service availability and reliability, UE traffic information, etc. | | +| <b>Ends when</b> | The operator maintains the NetworkSlice instance during the lifecycle of the NetworkSlice instance. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NetworkSlice instance(s) is provided by the operator to the CSP to support one or more communication services. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-01, REQ-3GPPMS-CON-02, REQ-3GPPMS-CON-03, REQ-3GPPMS-CON-04, REQ-3GPPMS-CON-05, REQ-3GPPMS-CON-07, REQ-3GPPMS-CON-08, REQ-3GPPMS-CON-09, REQ-3GPPMS-CON-10, REQ-3GPPMS -CON-28, REQ-3GPPMS -CON-29 | | + +### 5.4.2 Provisioning of a network slice instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| <b>Goal</b> | To perform operations of the provisioning of a NetworkSlice instance. | | +| <b>Actors and Roles</b> | A Network Operator (NOP) plays the role of a Network Slice Provider. | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | None | | +| <b>Pre-conditions</b> | Preparation for the NetworkSlice instance is done.<br>For creation, NetworkSlice instance is not existing.<br><br>For activation, modification, de-activation, or termination, the NetworkSlice instance is existing. | | +| <b>Begins when</b> | The 3GPP management system has received a request from the Network Operator. | | +| <b>Step 1 (M)</b> | The 3GPP management system assesses the feasibility of executing the request, e.g., checks the inventory and the required NetworkSlice instance constituents, and reserves available resources. | | +| <b>Step 2 (M)</b> | The 3GPP management system performs the LCM operations required according to the request (create, activate, modify, de-activate, or terminate) on one or more NetworkSliceSubnet instance(s). For shared NetworkSliceSubnet(s), the 3GPP management system performs required actions. | 5.4.3<br>Provisioning of a NetworkSliceSubnet instance | +| <b>Step 3 (M)</b> | The 3GPP management system replies to the Network Operator that the requested operation is completed. | | +| <b>Ends when</b> | All the mandatory steps have passed. | | +| <b>Exceptions</b> | In case the feasibility check fails, the use case fails and the 3GPP management system rejects the request with the reason included in the reply.<br>In case any of the LCM operations fail, the use case fails and the 3GPP management system replies to the Network Operator that the requested operation is failed with the reason included in the reply. | | +| <b>Post-conditions</b> | A NetworkSlice instance has been provisioned. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-04, REQ-3GPPMS-CON-15, REQ-3GPPMS-CON-16, REQ-3GPPMS-CON-17, REQ-3GPPMS-CON-18. | | + +### 5.4.3 Provisioning of a NetworkSliceSubnet instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To perform operations of the provisioning of a NetworkSliceSubnet instance. | | +| <b>Actors and Roles</b> | A Network Operator (NOP) plays the role of a Network Slice Provider (NSP) responsible for the network slice subnet. | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | None | | +| <b>Pre-conditions</b> | Preparation for the NetworkSliceSubnet instance is completed.<br>For the creation use case an NetworkSliceSubnet instance does not exist.<br><br>For activation, modification, de-activation or termination use cases, the NetworkSliceSubnet instance exists. | | +| <b>Begins when</b> | The 3GPP management system has received a request from the Network Operator. | | +| <b>Step 1 (M)</b> | The 3GPP management system assesses the feasibility of executing the request, e.g., checks the inventory and the required NetworkSliceSubnet instance constituents, and reserves available resources. | | +| <b>Step 2 (M)</b> | The 3GPP management system performs the LCM operations required according to the request (activate, modify, de-activate, or terminate) on one or more NetworkSliceSubnet instance(s) constituents. In case the required LCM operation is create a new NetworkSliceSubnet instance constituent is created. | | +| <b>Step 3 (M)</b> | The 3GPP management system replies to the Network Operator that the requested operation is completed. | | +| <b>Ends when</b> | All the mandatory steps have passed. | | +| <b>Exceptions</b> | In case the feasibility check fail, the use case fails and the 3GPP management system rejects the request with the reason included in the reply.<br>In case any of the LCM operations fail, the use case fails and the 3GPP management system replies to the Network Operator that the requested operation has failed with the reason included in the reply. | | +| <b>Post-conditions</b> | A NetworkSliceSubnet instance has been provisioned. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-06, REQ-3GPPMS-19, REQ-3GPPMS-CON-20, REQ-3GPPMS-CON-21, REQ-3GPPMS-CON-22 | | + +### 5.4.4 Performance management of a NetworkSlice instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| +| <b>Goal</b> | To report performance measurement data of a NetworkSlice instance to the NOP. | | +| <b>Actors and Roles</b> | A Network Operator (NOP) plays the role of a Network Slice Provider (NSP) | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NetworkSlice instance has been activated. | | +| <b>Begins when</b> | The NOP requests performance measurement and monitoring on the NetworkSlice instance. | | +| <b>Step 1 (M)</b> | For each NetworkSliceSubnet instance associated with the NetworkSlice instance the 3GPP management system fetches NetworkSliceSubnet instance-level performance measurement data. | Performance management of a NetworkSliceSubnet instance | +| <b>Step 2 (M)</b> | The 3GPP management system generates the network slice-level performance measurement data and sends the network slice-level performance measurement data to the NOP. | | +| <b>Ends when</b> | The performance measurement and monitoring ends as scheduled or when requested by the NOP. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NOP receives the network slice-level performance measurement data from the 3GPP management system. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-11 | | + +NOTE: Steps 1 and 2 may be executed on demand, or repeatedly according to a schedule. + +### 5.4.5 Performance management of a NetworkSliceSubnet instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To report performance measurement data of a NetworkSliceSubnet instance to the NOP. | | +| <b>Actors and Roles</b> | A Network Operator (NOP) plays the role of a Network Slice Provider responsible for the network slice subnet. | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NetworkSliceSubnet instance has been activated. | | +| <b>Begins when</b> | The NOP requests performance measurement and monitoring on the NetworkSliceSubnet instance. | | +| <b>Step 1 (M)</b> | For each component of the NetworkSliceSubnet instance the 3GPP management system fetches performance measurement data on the components of the NetworkSliceSubnet instance. | | +| <b>Step 2 (M)</b> | The 3GPP management system generates the network slice subnet-level performance measurement data and sends the network slice subnet-level performance measurement data to the NOP. | | +| <b>Ends when</b> | The performance measurement and monitoring ends as scheduled or when requested by the NOP. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NOP receives the network slice subnet-level performance measurement data from the 3GPP management system. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-12 | | + +NOTE: Steps 1 and 2 may be executed on demand, or repeatedly according to a schedule. + +### 5.4.6 Report fault management data of a NetworkSlice instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To report fault management data of a NetworkSlice instance to the NOP. | | +| <b>Actors and Roles</b> | Network Operator (NOP) | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NetworkSlice instance is created. | | +| <b>Begins when</b> | The 3GPP management system detects a fault on the NetworkSlice instance that needs NOP intervention. | | +| <b>Step 1 (M)</b> | The 3GPP management system generates fault management data of the NetworkSlice instance and reports the fault management data to the NOP. | | +| <b>Step 2 (M)</b> | When the fault is recovered, the 3GPP management system updates the fault management data of the NetworkSlice instance to the NOP. | | +| <b>Ends when</b> | The NOP has the fault management data of NetworkSlice instance. | | +| <b>Exceptions</b> | In case any of the mandatory steps fail, the use case fails. | | +| <b>Post-conditions</b> | N/A | | +| <b>Traceability</b> | REQ-3GPPMS-CON-13 | | + +### 5.4.7 Report fault management data of a NetworkSliceSubnet instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To report fault management data of a NetworkSliceSubnet instance to the NOP. | | +| <b>Actors and Roles</b> | Network Operator (NOP) | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NetworkSliceSubnet instance is created. | | +| <b>Begins when</b> | The 3GPP management system detects a fault on the NetworkSliceSubnet instance that needs operator intervention. | | +| <b>Step 1 (M)</b> | The 3GPP management system generates fault management data of the NetworkSliceSubnet instance and reports to the NOP. | | +| <b>Step 2 (M)</b> | When the fault is recovered, the 3GPP management system updates the fault management data of the NetworkSliceSubnet instance to the NOP. | | +| <b>Ends when</b> | The NOP has the fault management data of NetworkSliceSubnet instance. | | +| <b>Exceptions</b> | In case any of the mandatory steps fail, the use case fails. | | +| <b>Post-conditions</b> | N/A | | +| <b>Traceability</b> | REQ-3GPPMS-CON-14 | | + +### 5.4.8 Multiple operator support for network slicing + +| Use Case | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | Create a communication service spanning multiple NetworkSlice instance hosted across multiple operators | | +| <b>Actors and Roles</b> | Communication service provider (CSP)<br>Network Operator (NOP) A, Network Operator (NOP) B | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | The business level agreement(s) between CSP and NOPs to support the management system interaction is done | | +| <b>Pre-conditions</b> | None | | +| <b>Begins when</b> | Communication service provider receives a request to deploy a 5G Communication service | | +| <b>Step 1 (M)</b> | The CSP requests NOP A to create the NetworkSlice instance and NOP B to create another NetworkSlice instance to support the communication service | | +| <b>Step 2 (M)</b> | NOP A and NOP B's 3GPP management system evaluates if they can support the respective NetworkSlice instances, and, if they can, the 3GPP management systems create the corresponding NetworkSlice instance and respond positively to the CSP | | +| <b>Step 3 (M)</b> | The communication services provider instantiates the service over the multiple NetworkSlice instances | | +| <b>Ends when</b> | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | A communication service across multiple operators is created | | +| <b>Traceability</b> | REQ-3GPPMS-CON-01, REQ-3GPPMS-CON-02 | | + +### 5.4.9 Manage network slice with agreed performance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To manage network slice with agreed performance to CSP | | +| <b>Actors and Roles</b> | A Communication Service Provider (CSP) requests the Network Operator (NOP) to provide a NetworkSlice instance | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | | | +| <b>Pre-conditions</b> | The NOP has the capability to manage network slices. | | +| <b>Begins when</b> | A set of service requirements (e.g. business scenario, isolation, throughput, latency, coverage, etc.) have been provided by the CSP. | | +| <b>Step 1 (M)</b> | NOP creates a customized NetworkSlice instance with performance that meet CSP's requirements. | | +| <b>Step 2 (M)</b> | NOP make use of 3GPP management system to monitor the NetworkSlice instance performance. | | +| <b>Step 3 (M)</b> | When NOP detects that the monitored NetworkSlice instance performance does not meet the agreed performance requirement, the NOP requests the 3GPP management system to executes some actions (e.g. scale in/out, modification, etc.), so that the NetworkSlice instance performance requirements are fulfilled.<br>NOTE: The step 2 and 3 are executed continuously until the "ends when". | | +| <b>Ends when</b> | The NetworkSlice instance is terminated. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NetworkSlice instance performance requirements requested by CSP are fulfilled. | | +| <b>Traceability</b> | | | + +### 5.4.10 Communication services using network with or without slicing + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | A communication service provider (CSP) uses the 5G network and network slicing service provided by operator to offer communication services to end users. | | +| <b>Actors and Roles</b> | Communication Service Provider (CSP) requests the Network Operator (NOP) to support its network requirements | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | CSP derives the network related requirements (e.g. isolation, latency, coverage) from the communication service related requirements. | | +| <b>Begins when</b> | CSP provides the network related requirements to the NOP. | | +| <b>Step 1 (M)</b> | NOP decides to use network with or without slicing based on the network related requirements received and/or pre-configured network planning or optimization policies. For example, If CSP requires an isolated network, NOP may decide to use a network slice. | | +| <b>Step 2 (M)</b> | In case of using network with slicing, NOP create a NetworkSlice instance or reuse an existing NetworkSlice instance to satisfy the network related requirements.<br>Otherwise, NOP deploys a new network without slicing or utilize the existing network without slicing to satisfy the network related requirements. | | +| <b>Step 3 (M)</b> | NOP notifies CSP that the network is ready. | | +| <b>Ends when</b> | Ends when all mandatory steps identified above are successfully completed or when an exception occurs. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | Network with or without slicing can be utilized to provide communication service. | | +| <b>Traceability</b> | REQ-5GNS-CON-08 | | + +### 5.4.11 Exposure of network slice management data for Network Slice as a Service (NSaaS) case + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To expose network slice management data to a Communication Service Provider (CSP) consuming Network Slice as a Service (NSaaS) based on mutual agreement. | | +| <b>Actors and Roles</b> | A Communication Service Provider (CSP) provides limited management data to a Communication Service Customer (CSC) | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | Network slice management data of network slice can be exposed to the CSP consuming NSaaS according to the pre-defined agreements. | | +| <b>Pre-conditions</b> | 1. NSaaS level exposure has been agreed upon and the CSP offering the NSaaS is aware of it.<br>2. An NetworkSlice instance used for NSaaS is created. | | +| <b>Begins when</b> | The CSP consuming NSaaS wants to get the management data of the NetworkSlice instance. | | +| <b>Step 1 (M)</b> | The CSP consuming NSaaS sends requests to the 3GPP management system for the exposure management data of NetworkSlice instance. | | +| <b>Step 2 (M)</b> | The 3GPP management system provides the CSP consuming NSaaS of exposed management data for the NSaaS scenario. | | +| <b>Ends when</b> | The network slice management data is provided. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The CSP consuming NSaaS is aware of the management data of the NetworkSlice instance. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-27 | | + +### 5.4.12 Exposure of network slice management capability + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To expose limited network slice management capability to a Communication Service Customer (CSC) consuming Network Slice as a Service (NSaaS) based on mutual agreement. | | +| <b>Actors and Roles</b> | A Communication Service Provider (CSP) provides limited management capability to a Communication Service Customer (CSC) | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | Network slice management capability of 3GPP management system can be partially exposed to the CSC consuming NSaaS according to the pre-defined agreements. | | +| <b>Pre-conditions</b> | Level of management exposure has been agreed upon and the CSP offering the NSaaS service is aware of it. | | +| <b>Begins when</b> | The CSC consuming NSaaS wants to get certain management capability to manage the NetworkSlice instance, e.g., PM, FM, CM, based on the mutual agreement between CSC and CSP. | | +| <b>Step 1 (M)</b> | The CSC consuming NSaaS sends requests to the 3GPP management system for the exposure of management capability of NetworkSlice instance. | | +| <b>Step 2 (M)</b> | The 3GPP management system provides the CSC consuming NSaaS with the requested capability via appropriate methods, e.g., exposing network slice management service to the CSC. | | +| <b>Ends when</b> | The network slice management capability is provided. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The limited network slice management capability has been exposed to the CSC consuming NSaaS. | | +| <b>Traceability</b> | REQ-3GPPMS -CON-30, REQ-3GPPMS -CON-31, REQ-3GPPMS -CON-32 | | + +### 5.4.13 To modify the network slice instance due to changed demand + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To modify a NetworkSlice instance due to changed demand | | +| <b>Actors and Roles</b> | A Network Operator (NOP) plays the role of a Network Slice Provider (NSP). | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | None | | +| <b>Pre-conditions</b> | A network slice is activated | | +| <b>Begins when</b> | The NOP has received a request to modify the capacity of a NetworkSlice instance. For example, in case there is an increased demand in call capacity in specific geographical area, the request indicates the needed capacity increase amount in that specific geographical area | | +| <b>Step 1 (M)</b> | The NOP initiates the 3GPP management system to process the request | | +| <b>Step 2 (M)</b> | The 3GPP management system analyses the request and identifies that one or more supporting network slice subnets need to be modified with X1 amount, X2 amount, X3 amount etc. | | +| <b>Step 3 (M)</b> | 3GPP system derives new TN requirements | | +| <b>Step 4 (M)</b> | The 3GPP management system initiates modification of the capacity of the identified supporting slice subnets with X1 amount, X2 amount, X3 amount etc | | +| <b>Step 5 (M)</b> | 3GPP system communicates new TN requirements | | +| <b>Ends when</b> | All capacity modification activities (of step 3) have been completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NetworkSlice instance capacity is modified according to demand. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-17, REQ-3GPPMS-CON-20, REQ-5GNS-CON-9, REQ-5GNS-CON-10, REQ-5GNS-CON-11, REQ-5GNS-CON-12 | | + +### 5.4.14 Management data analytics for 5G networks + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To provide management data analytics services to authorized customers (e.g., re-configuring for more efficient operation and maintenance) | | +| <b>Actors and Roles</b> | Network Operator (NOP) | | +| <b>Telecom resources</b> | NetworkSlice instance<br>3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The 3GPP management system has the capability to collect the related network data for analysis. | | +| <b>Begins when</b> | The 3GPP management system receives network data analytics request. | | +| <b>Step 1 (M)</b> | The 3GPP management system checks if the existing management data is sufficient to generate the network data analytics information. 3GPP management system may trigger to obtain more network data for analytics purpose, such as new measurement jobs, subscriptions to alarm notifications. | | +| <b>Step 2 (M)</b> | For management data analytics purposes, 3GPP management system may request services (e.g., management data analytics, PM, FM) from the related NetworkSlice instance constituents. | | +| <b>Step 3 (M)</b> | 3GPP management system sends the analytics results to the NOP. | | +| <b>Ends when</b> | NOP has the required network data analytics information. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NOP receives network data analytics information from the 3GPP management system, the information could be utilized for optimizing the network. | | +| <b>Traceability</b> | REQ-5GNS-CON-13, REQ-5GNS-CON-14 | | + +### 5.4.15 Capacity management of network slice instances and network slice subnet instances + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To support capacity management of NetworkSlice instances and NetworkSliceSubnet instances. | | +| <b>Actors and Roles</b> | A Network Operator (NOP) plays the role of a Network Slice Provider responsible for the network slice capacity management. | | +| <b>Telecom resources</b> | 3GPP management system | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The capacity optimization objectives have been set by the NOP | | +| <b>Begins when</b> | The NOP requests capacity management process of the NetworkSlice instances and NetworkSliceSubnet instances when the pre-set resource optimization objectives need to be satisfied. | | +| <b>Step 1 (M)</b> | The 3GPP management system obtains information needed for the optimization process such as network slice provisioning requirements, existing active or non-active NetworkSlice instance and/or NetworkSliceSubnet instance resource information, and performance measurement data by requesting the feasibility check operation. | Feasibility check | +| <b>Step 2 (M)</b> | The 3GPP management system performs resource optimization process based on the information obtained in Step 1. The goal of the process is to find an optimal resource capacity availability against the target objective. | | +| <b>Step 3 (M)</b> | The 3GPP management system proceeds with network slice (NetworkSlice instance and/or NetworkSliceSubnet instance) provisioning or modification processes until it meets the resource capacity optimization objective. | | +| <b>Step 4 (M)</b> | The 3GPP management system updates capacity availability information after provisioning or modification processes. | | +| <b>Ends when</b> | The capacity management ends as it meets the optimization objective. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NOP receives the updated capacity management information from the 3GPP management system. | | +| <b>Traceability</b> | REQ-3GPPMS-CON-23 | | + +# --- 6 High level features + +## 6.1 General + +The present clause describes the high level features of the 5G management system and network slicing. + +## 6.2 Self-Organizing Networks (SON) for 5G networks + +In order to reduce the operating expenses associated with the management of increasing number of nodes from more than one vendor the feature of the Self-Organizing Network (SON) was introduced. Automation of some network planning, configuration and optimisation processes via the use of SON functions can help the network operator to reduce operating expenses by reducing manual involvement in such tasks. Based on the location of the SON algorithm, SON is categorized into four different solutions: Cross Domain-Centralized SON, Domain-Centralized SON, Distributed SON and Hybrid SON. + +## 6.3 Management data analytics for 5G networks + +The 5G networks have capability to support a variety of communication services, such as IoT and eMBB. The increasing flexibility of the networks to support services with diverse requirements may present operational and management challenges. 5G networks management system can therefore benefit from management data analytics for improving networks performance and efficiency to accommodate and support the diversity of services and requirements. The management data analytics utilize the collection of network data (including e.g. service, slicing and/or network functions related data) to perform analytics in order to assist and complement management services for an optimum network performance and service assurance. + +## 6.4 Closed loop SLS Assurance + +Closed loop SLS Assurance relies on a set of management services in a control loop which consists of the steps of Monitoring, Analysis, Decision and Execution to assure the communication service. The adjustment of the resources used for the communication service is completed by the continuous iteration of the steps in the control loop with SLS assurance. Closed loop SLS assurance can be deployed at domain level or cross domain level. + +## 6.5 Energy Efficiency(EE) for 5G networks + +Operators are aiming at decreasing power consumption in 5G networks to lower their operational expense with energy saving management solutions. With the foreseen deployment of more NR base stations, e.g., small base stations with massive MIMO in high-band, energy saving becomes even more urgent and challenging. Management of 5G networks contributes to energy saving by reducing energy consumption of 5G networks, while maintaining coverage, capacity and quality of service. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2018-12 | SA#82 | SP-181041 | 0001 | - | F | Align title with TS database | | 15.1.0 | +| 2018-12 | SA#82 | SP-181042 | 0002 | 1 | F | Fix gap of requirement for Network Slicing priority | | 15.1.0 | +| 2018-12 | SA#82 | SP-181043 | 0003 | 1 | F | Replace MF with managed function | | 15.1.0 | +| 2019-09 | SA#85 | SP-190742 | 0009 | 1 | F | Fix inconsistencies related to service requirements | | 15.2.0 | +| 2019-09 | SA#85 | SP-190753 | 0007 | 2 | B | Add MnS query related requirement | | 16.0.0 | +| 2019-12 | SA#86 | SP-191159 | 0010 | 1 | F | Clean up for inconsistency | | 16.1.0 | +| 2019-12 | SA#86 | SP-191171 | 0011 | 1 | B | Add description for tenant information | | 16.1.0 | +| 2019-12 | SA#86 | SP-191173 | 0013 | 1 | A | Fix inconsistencies in the usage of word instance | | 16.1.0 | +| 2020-07 | SA#88E | SP-200497 | 0022 | 3 | B | Extend roles related to 5G networks and network slicing management | | 16.2.0 | +| 2020-07 | SA#88E | SP-200485 | 0025 | 2 | F | Cleanup Network Slice related definitions in OAM space | | 16.2.0 | +| 2020-07 | SA#88E | SP-200485 | 0027 | 1 | F | update slice NRM to align with refined slice definitions | | 16.2.0 | +| 2020-09 | SA#89e | SP-200724 | 0028 | 1 | F | Replacement of instance of the term MF/managed function with network function | | 16.3.0 | +| 2020-09 | SA#89e | SP-200724 | 0029 | 1 | F | Corrections | | 16.3.0 | +| 2020-12 | SA#90e | SP-201050 | 0032 | - | F | Add abbreviation | | 16.4.0 | +| 2020-12 | SA#90e | SP-201053 | 0033 | 1 | F | Decouple communication service and network slice | | 16.4.0 | +| 2020-12 | SA#90e | SP-201053 | 0034 | 1 | F | Move service profile definition from 28531 | | 16.4.0 | +| 2020-12 | SA#90e | SP-201050 | 0035 | - | F | Correction of missing Figure 4.1.7.1 Examples of network slice as NOP internals | | 16.4.0 | +| 2020-12 | SA#90e | SP-201088 | 0036 | - | F | Add the chapter of high level features | | 16.4.0 | +| 2021-12 | SA#94e | SP-211464 | 0049 | - | F | Correct tenant phrasing | | 16.5.0 | +| 2023-03 | SA#99 | SP-230199 | 0055 | 1 | F | Correct network slice abbreviations | | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28535/raw.md b/marked/Rel-16/28_series/28535/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9a386da95e380d910511f67147d7e11093429ff1 --- /dev/null +++ b/marked/Rel-16/28_series/28535/raw.md @@ -0,0 +1,565 @@ + + +# 3GPP TS 28.535 V16.6.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Management services for communication service assurance; Requirements (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. The "3" and "G" are connected by a red, curved line. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|----------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Concepts and background ..... | 7 | +| 4.1 Void..... | 7 | +| 4.2 Management control loops..... | 7 | +| 4.2.1 Overview ..... | 7 | +| 4.2.2 Control loops ..... | 8 | +| 4.2.3 Open control loops ..... | 9 | +| 4.2.4 Closed control loops..... | 9 | +| 4.2.4.1 Description..... | 9 | +| 4.2.4.2 Lifecycle phases..... | 10 | +| 4.2.4.2 Lifecycle phases..... | 11 | +| 4.3 Communication service assurance service..... | 12 | +| 5 Business level use cases and requirements ..... | 13 | +| 5.1 Use cases ..... | 13 | +| 5.1.1 Communication service assurance..... | 13 | +| 5.1.2 Communication service assurance for shared resources ..... | 13 | +| 5.1.3 Void ..... | 14 | +| 5.1.4 Void ..... | 14 | +| 6 Specification level use cases and requirements ..... | 14 | +| 6.1 Use cases ..... | 14 | +| 6.1.1 Communication service quality assurance and optimization ..... | 14 | +| 6.1.2 NWDAF assisted communication service SLS Assurance ..... | 14 | +| 6.1.3 5G Core assisted SLS communication service Assurance ..... | 15 | +| 6.1.4 Communication service SLS assurance control ..... | 15 | +| 6.2 Requirements..... | 16 | +| <b>Annex A (informative): Change history .....</b> | <b>17</b> | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document describes closed control loop assurance solution enabling a service provider or an operator to continuously deliver the requested level of communication service quality to the customer and is part of a TS-family covering the 3rd Generation Partnership Project Technical Specification Group Services and System Aspects Management and orchestration of networks, as identified below: + +**TS 28.535: Management Services for Communication Service Assurance; Requirements** + +TS 28.536: Management Services for Communication Service Assurance; Stage 2 and stage 3 + +The solution described builds upon the management services specifications as identified below: + +TS 28.530: Management and orchestration; Concepts, use cases and requirements + +TS 28.533: Management and orchestration; Architecture framework + +TS 28.532: Management and orchestration; Generic management services + +TS 28.540: Management and orchestration; 5G Network Resource Model (NRM); Stage 1 + +TS 28.541: Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3 + +TS 28.531: Management and orchestration; Provisioning + +TS 28.545: Management and orchestration; Fault Supervision (FS) + +TS 28.550: Management and orchestration; Performance assurance + +TS 28.552: Management and orchestration; 5G performance measurements + +TS 28.554: Management and orchestration; 5G End to end Key Performance Indicators (KPI) + +# --- 1 Scope + +The present document describes, concepts and background, and specifies use cases and requirements for closed control loop communication service assurance solution that adjusts and optimizes the services provided by NG-RAN and 5GC. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.261: "Service requirements for the 5G system". +- [3] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [4] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [5] ETSI GS ZSM 002 (V1.1.1) (2019-08): "Zero-touch network and Service Management (ZSM); Reference Architecture". +- [6] 3GPP TS 28.545: "Management and orchestration; Fault Supervision (FS)". +- [7] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [8] 3GPP TS 28.554: "Management and orchestration; 5G end to end Key Performance Indicators (KPI)". +- [9] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [10] 3GPP TS 23.003: " Numbering, addressing and identification". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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]. + +**communication services:** subset of 3GPP defined services. Examples of 3GPP services (e.g. 5G LAN, URLLC) can be found in TS 22.261 [2]. + +**service level specification:** specification of the minimum acceptable standard of service. + +**SLA requirements:** service and network requirements derived from SLAs. + +NOTE: A provider can add additional requirements not directly derived from SLA's, associated to provider internal [business] goals. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|---------|-------------------------------------------------------| +| CN | Core Network | +| CS | Communication Service | +| CSA | Communication Service Assurance | +| CSC | Communication Service Customer | +| CSP | Communication Service Provider | +| eMBB | enhanced Mobile BroadBand | +| KPI | Key Performance Indicator | +| MDAS | Management Data Analytics Service | +| MnS | Management Service | +| NF | Network Function | +| NSI | NetworkSlice Instance | +| NSSI | NetworkSlice Subnet Instance | +| NSP | NetworkSlice Provider | +| NWDAF | Network Data Analytics Function | +| QoE | Quality of Experience | +| SD | Slice Differentiator | +| SLA | Service Level agreement | +| SLS | Service Level Specification | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SST | Slice/ServiceType | + +# --- 4 Concepts and background + +## 4.1 Void + +## 4.2 Management control loops + +### 4.2.1 Overview + +For communication service assurance one can identify two interactions of management control loops: + +- 1) Between the CSC and the CSP: In this case, the CSC provides the requirements for an assured communication service to the CSP, the CSP provides the corresponding communication service, the CSP also provides feedback to the CSC. The CSP adjusts the resources used by a communication service or the CSC adjusts the SLS continuously to achieve the assured requirements. +- 2) Between the CSP and the NSP: the communication service provided by CSP requires the network capabilities. For example, the CSP requires a certain network latency. The NSP management system adjusts the network or CSP adjusts the latency requirement continuously to satisfy the latency requirement. + +![Figure 4.2.1.1: Communication service closed control loop assurance diagram. The diagram shows a hierarchical structure. At the top is a box labeled 'CSC'. Below it is a large box labeled 'Communication service closed loop assurance'. Inside this box, at the top, is a box labeled 'SLS input'. Below it is a box labeled 'Communication service lifecycle management'. Below that is another box labeled 'Network realization close loop assurance'. Inside this inner box, at the top, is a box labeled 'Cross-domain management'. Below it are two boxes, 'AN' on the left and 'CN' on the right. Arrows indicate a flow from 'SLS input' to 'Communication service lifecycle management', then to 'Cross-domain management', then to 'AN' and 'CN', and finally back to 'Communication service lifecycle management'. There are also curved arrows from 'CSC' to 'SLS input' and from 'AN' and 'CN' back to 'CSC'.](d0abac95583b52a3b35f74a215567334_img.jpg) + +Figure 4.2.1.1: Communication service closed control loop assurance diagram. The diagram shows a hierarchical structure. At the top is a box labeled 'CSC'. Below it is a large box labeled 'Communication service closed loop assurance'. Inside this box, at the top, is a box labeled 'SLS input'. Below it is a box labeled 'Communication service lifecycle management'. Below that is another box labeled 'Network realization close loop assurance'. Inside this inner box, at the top, is a box labeled 'Cross-domain management'. Below it are two boxes, 'AN' on the left and 'CN' on the right. Arrows indicate a flow from 'SLS input' to 'Communication service lifecycle management', then to 'Cross-domain management', then to 'AN' and 'CN', and finally back to 'Communication service lifecycle management'. There are also curved arrows from 'CSC' to 'SLS input' and from 'AN' and 'CN' back to 'CSC'. + +**Figure 4.2.1.1: Communication service closed control loop assurance** + +Figure 4.2.1.1 gives a high level description of interaction process involved in the management closed control loop. + +Generally, the management control loop for CSA consists of the steps Monitoring, Analysis, Decision and Execution. The adjustment of the resources used for the communication service is completed by the continuous iteration of the steps in a management control loop. As described in clause 4.2.4.2, the management closed control loop for the resources used for the communication service is deployed in the preparation phase and takes effect during the preparation phase and operation phase. + +Figure 4.2.1.2 shows the overall process of communication service assurance using a management control loop. + +![Figure 4.2.1.2: Management Control Loop diagram. The diagram shows a linear sequence of four boxes: 'Monitor', 'Analytic', 'Decision', and 'Execution'. Arrows connect them in this order. Below the 'Execution' box is a box labeled 'Resources used by communication service'. An arrow points from 'Execution' to this box, and another arrow points from this box back to the 'Monitor' box, completing a feedback loop.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +Figure 4.2.1.2: Management Control Loop diagram. The diagram shows a linear sequence of four boxes: 'Monitor', 'Analytic', 'Decision', and 'Execution'. Arrows connect them in this order. Below the 'Execution' box is a box labeled 'Resources used by communication service'. An arrow points from 'Execution' to this box, and another arrow points from this box back to the 'Monitor' box, completing a feedback loop. + +**Figure 4.2.1.2: Management Control Loop** + +### 4.2.2 Control loops + +A control loop is a building block for management of networks and services. The basic principle of any control loop is to adjust the value of a measured or observed variable (expressed as for example an attribute) to equal the value of a desired goal (expressed as for example an attribute). The producer of the measurements or observations, the control service, and the controlled entity are all required to create a control loop. + +For the control loop to act on input in the context of the set goal, the control loop provided through following four steps that continuously consume and produce information from each other in a loop in the following sequence monitor, analyse, decide and execute. + +A control loop can be an open control loop in which case a human operator or other management entity intervenes inside the loop A control loop can be closed and operates without human operator or other management entity + +involvement inside the loop other than possibly the initial configuration of the measurement producer and configuration of control loop. + +### 4.2.3 Open control loops + +In an open control loop, the human operator intervenes in one or more of the process steps inside the loop, see Figure 4.2.3.1. The human operator is in control of the steps in the control loop, including decisions taken in the loop. The management system collects, analyses and presents the data to the operator, but the operator decides which action to take. In this case, the completion time for control loop is dependent on availability and reaction time of a human operator or other management entity. + +![Diagram of an open control loop showing a human operator intervening in the decision step.](dbe553cf16dd14073b89a8263a428664_img.jpg) + +The diagram illustrates an open control loop. A central box labeled 'Control service' contains four process steps: 'analyze', 'decide', 'execute', and 'monitor', arranged in a clockwise cycle. A human operator icon is positioned in the center of this cycle, with arrows pointing to the 'analyze' and 'decide' steps. The 'analyze' step points to 'decide', 'decide' points to 'execute', 'execute' points to 'monitor', and 'monitor' points back to 'analyze'. An external 'goal' arrow points into the 'decide' step. Below the 'Control service' box, an 'Observation producer' provides 'input' to the 'monitor' step, and the 'execute' step produces an 'output' to a 'Controlled entity'. + +Diagram of an open control loop showing a human operator intervening in the decision step. + +Figure 4.2.3.1: Open control loop entities + +### 4.2.4 Closed control loops + +#### 4.2.4.1 Description + +In a closed control loop, there is no direct involvement of a human operator or other management entity in the control loop, the control loop is fully automated. As shown in Figure 4.2.4.1 the human operator or management entity is not directly controlling the details inside the process steps but provides control outside the loop. For example, configuring goals for the control loop to make autonomous decisions within the boundaries of the set goal. Once the control loop is configured with the goal, the controlled entity is adjusted according to the set goals. + +In a closed control loop the input to the control loop provided by human operator or other management entity may include the goal or policies. The output of the closed control loop may include closed control loop status to a human operator or other management entity. + +Typically, the goal is set within certain parameter boundaries, the closed control loop can automatically adjust the output based on the input within the parameter boundaries. Once a control loop cannot automatically adjust, the human operator or other management entity needs to be informed. The human operator or other management entity may decide to change the management of closed control loop so that it becomes an open control loop, where decisions are made by the human operator or other management entity and not by the closed control loop. + +![Diagram of a closed control loop entity. A central box labeled 'Control service' contains four sub-components: 'analyze', 'decide', 'execute', and 'monitor'. Arrows show a clockwise flow: analyze to decide, decide to execute, execute to monitor, and monitor back to analyze. Below the 'Control service' box, an 'Observation producer' sends 'input' to the 'monitor' component. The 'execute' component sends an 'output' to a 'Controlled entity' box. To the right of the 'Control service' box, a human icon labeled 'goal' is connected via a double-headed arrow.](e6df2733626a85205c1db682e6259c46_img.jpg) + +Diagram of a closed control loop entity. A central box labeled 'Control service' contains four sub-components: 'analyze', 'decide', 'execute', and 'monitor'. Arrows show a clockwise flow: analyze to decide, decide to execute, execute to monitor, and monitor back to analyze. Below the 'Control service' box, an 'Observation producer' sends 'input' to the 'monitor' component. The 'execute' component sends an 'output' to a 'Controlled entity' box. To the right of the 'Control service' box, a human icon labeled 'goal' is connected via a double-headed arrow. + +**Figure 4.2.4.1: Closed control loop entities** + +#### 4.2.4.2 Lifecycle phases + +Communication service assurance is enabled by closed control loops which have their own lifecycle. The lifecycle phases for closed control loops are preparation, commissioning, operation and decommissioning. + +##### - **Preparation phase:** + +Providing a closed control loop starts with preparation, which includes control loop design, collection of relevant goal information from an SLS and preparing the required network configuration for measurement collection. The result of the preparation phase is a closed control loop design. + +##### - **Commissioning phase:** + +Once a closed control loop is prepared, one instance of the closed control loop design is instantiated by configuring the measurement collection and the goals in the network. During this phase the closed control loop may be deployed to allow the network to converge to a state where the communication service assurance is stable and within the boundaries of the SLS. The instantiation activity results in a closed control loop that is ready for operation. + +##### - **Operation phase:** + +After the commissioning phase, the closed control loop is operational. The activation includes actions that make a closed control loop run to pursue its goal(s). It may include subscription to relevant management services. In the operation phase the closed control loop is first activated. The monitor activity typically includes the real-time or periodic calculation of KPIs that are relevant to the closed control loop and comparison with the goal(s) assigned to the given closed control loop. This activity may result in further actions that involve the other activities in the operation phase, e.g. evaluate and update & upgrade, in order to change the closed control loop settings and improve its performance. The evaluate activity also includes the evaluation of results of Execution step of closed control loops by e.g. investigating differences between the current traffic data and the data taken before the execution. The criteria of this evaluation can be done by specific values such as SLS. The update & upgrade activity includes actions that change the settings of the closed control loop instance to change its behaviour and improve its performance to pursue the assigned goal(s). The update may include changes in the parameters of the management functions that constitute the closed control loop (e.g. changing data sources, KPIs being calculated, models, policies, etc.). The upgrade may include changes in the software version of the management functions. These activities can be executed dynamically while the closed control loop is regularly operating and executing actions, or they can be executed upon a request received from an authorized consumer. The deactivation activity includes actions that make the closed control loop stop to run. + +##### - **Decommissioning phase:** + +When the closed control loop is no longer needed, after being deactivated the closed control loop is decommissioned and after that the lifecycle of the closed control loop is completed. + +Figure 4.2.4.2.1 highlights the lifecycle phase sequence involved in the closed control loop assurance. + +#### 4.2.4.2 Lifecycle phases + +Communication service assurance is enabled by closed control loops which have their own lifecycle. The lifecycle phases for closed control loops are preparation, commissioning, operation and decommissioning. + +##### - **Preparation phase:** + +Providing a closed control loop starts with preparation, which includes control loop design, collection of relevant goal information from an SLS and preparing the required network configuration for measurement collection. The result of the preparation phase is a closed control loop design. + +##### - **Commissioning phase:** + +Once a closed control loop is prepared, one instance of the closed control loop design is instantiated by configuring the measurement collection and the goals in the network. During this phase the closed control loop may be deployed to allow the network to converge to a state where the communication service assurance is stable and within the boundaries of the SLS. The instantiation activity results in a closed control loop that is ready for operation. + +##### - **Operation phase:** + +After the commissioning phase, the closed control loop is operational. The activation includes actions that make a closed control loop run to pursue its goal(s). It may include subscription to relevant management services. In the operation phase the closed control loop is first activated. The monitor activity typically includes the real-time or periodic calculation of KPIs that are relevant to the closed control loop and comparison with the goal(s) assigned to the given closed control loop. This activity may result in further actions that involve the other activities in the operation phase, e.g. evaluate and update & upgrade, in order to change the closed control loop settings and improve its performance. The evaluate activity also includes the evaluation of results of Execution step of closed control loops by e.g. investigating differences between the current traffic data and the data taken before the execution. The criteria of this evaluation can be done by specific values such as SLS. The update & upgrade activity includes actions that change the settings of the closed control loop instance to change its behaviour and improve its performance to pursue the assigned goal(s). The update may include changes in the parameters of the management functions that constitute the closed control loop (e.g. changing data sources, KPIs being calculated, models, policies, etc.). The upgrade may include changes in the software version of the management functions. These activities can be executed dynamically while the closed control loop is regularly operating and executing actions, or they can be executed upon a request received from an authorized consumer. The deactivation activity includes actions that make the closed control loop stop to run. + +##### - **Decommissioning phase:** + +When the closed control loop is no longer needed, after being deactivated the closed control loop is decommissioned and after that the lifecycle of the closed control loop is completed. + +Figure 4.2.4.2.1 highlights the lifecycle phase sequence involved in the closed control loop assurance. + +![A flow diagram showing the lifecycle phases of a closed control loop: Preparation, Commissioning, Operation, and Decommissioning, connected by arrows in a linear sequence.](ec98c4d2d93f28dfc8eb9d5e5730f62d_img.jpg) + +``` +graph LR; A[Preparation] --> B[Commissioning]; B --> C[Operation]; C --> D[Decommissioning]; +``` + +A flow diagram showing the lifecycle phases of a closed control loop: Preparation, Commissioning, Operation, and Decommissioning, connected by arrows in a linear sequence. + +**Figure 4.2.4.2.1: Lifecycle phases of a closed control loop** + +## 4.3 Communication service assurance service + +Communication service assurance relies on a set of management services that together provide the CSP with the capability to assure the communication service as per agreement (for example an SLS) with a CSC (e.g. enterprise). The overall solution and information flows between management services and the closed control loop steps [5] are shown in Figure 4.3.1. + +![Figure 4.3.1: Overview of closed control loop information flows. The diagram shows a cyclic process with four main steps: Monitor, Analyze, Decide, and Execute. Monitor contains a Data collection service (MnS) and a Controlled entity (Resources used by communication service). Analyze contains Analytics services (MnF). Decide contains Decision support services (MnF). Execute contains Provisioning services (MnS) and Orchestration & control. Information flows: Monitor to Analyze (information), Analyze to Decide (insight), Decide to Execute (decision), Execute to Monitor (data via Resources used by communication service).](7f17c430b9598e4d748a8041457810b3_img.jpg) + +The diagram illustrates the closed control loop information flows for communication service assurance. It consists of four main control steps arranged in a cycle: Monitor, Analyze, Decide, and Execute. Each step is represented by a rectangular box containing specific management services (MnF or MnS) and/or controlled entities. + +- Monitor:** Contains a **Data collection service** (MnS) and a **Controlled entity** (Resources used by communication service). +- Analyze:** Contains **Analytics services** (MnF). +- Decide:** Contains **Decision support services** (MnF). +- Execute:** Contains **Provisioning services** (MnS) and **Orchestration & control**. + +Information flows between these steps are as follows: + +- An arrow labeled **information** points from the **Monitor** step to the **Analyze** step. +- An arrow labeled **insight** points from the **Analyze** step to the **Decide** step. +- An arrow labeled **decision** points from the **Decide** step to the **Execute** step. +- An arrow labeled **data** points from the **Execute** step to the **Monitor** step, passing through a box labeled **Resources used by communication service**. + +Legend: + +- Control step (represented by a rectangle) +- MnF (represented by a rounded rectangle) +- MnS (capabilities) (represented by a circle) +- Controlled entity (Resources used by communication service) (represented by a rectangle with a smaller rectangle inside) + +Figure 4.3.1: Overview of closed control loop information flows. The diagram shows a cyclic process with four main steps: Monitor, Analyze, Decide, and Execute. Monitor contains a Data collection service (MnS) and a Controlled entity (Resources used by communication service). Analyze contains Analytics services (MnF). Decide contains Decision support services (MnF). Execute contains Provisioning services (MnS) and Orchestration & control. Information flows: Monitor to Analyze (information), Analyze to Decide (insight), Decide to Execute (decision), Execute to Monitor (data via Resources used by communication service). + +**Figure 4.3.1: Overview of closed control loop information flows** + +In Figure 4.3.1 the controlled entity represents the resources used by a communication service and the assurance of this communication service is provided by the closed control loop between the different management services provided by the management system. + +The input to the closed control loop is the data concerning the resources used by the communication service and corresponding service KPIs which is monitored by the closed control loop and step "Monitor", analyzed by the closed control loop step "Analyze", a decision on potential solution by the closed control loop step "Decide" which may be a possible action for the closed control loop step "Execute", The role of the decision support services is to provide variable degrees of automated decision making and human oversight support. The following two examples demonstrate how a closed control loop can be used: + +- when a service experience degradation is detected (for example due to resource shortage or faults in the network), the resources used by a communication service may be adjusted automatically to improve the service experience +- the data associated with the communication service is monitored by the management services for data collection, this management service provides information to an assurance root cause analysis management service (example of an analytics service) and based on that information the assurance root cause analysis takes place, followed by proposing activities, mitigation or suggestions to solve the problem. The proposed activities, for example mitigation or problem-solving suggestion(s) are executed through provisioning services to bring the behaviour of the communication service within the requested boundaries of the metrics (SLS goals) that are controlled by the closed control loop. + +The management services available for the closed control loop steps for "Monitor", "Analyze" and "Decide" are based on file transfer described in TS 28.550 [3], or data streaming described in TS 28.550 [3] and notifications described in TS 28.545 [6]. + +The information provided from the "Monitor" step to the "Analyze" step includes performance measurements (see TS 28.552 [7]), KPI's (see TS 28.554 [8]), performance threshold monitoring events and fault supervision events (see TS 28.532 [9]). + +The insights provided from the "Analyze" step to the "Decide" step includes analytics outcomes that are not specified in the present document. + +The decision support services provided from the "Decide" step to the "Execute" step are not specified in the present document. + +# --- 5 Business level use cases and requirements + +## 5.1 Use cases + +### 5.1.1 Communication service assurance + +The CSP needs to meet the CSC expectations on automation as well as internal goals on CAPEX and OPEX efficiency. + +The CSP has access to capabilities, procedures and tools that can address both CAPEX and OPEX in the provisioning and management of communication services to their customers (CSC). The CSC expects the CSP to offer a variety of communication services including business critical communication services that allow the CSC (e.g. Enterprise) to run their applications in a predictable manner [2]. Hence automation of the onboarding of the CSC application, which will use communication services provided by the CSP, on a 5GS, is a requirement to meet the following needs: + +- reduce the complexity for a CSC application to be on-boarded on a 5GS, +- improve the network performance over time, based on predicting communication service behaviour; +- assure the target goals for a CSC, and +- reduce the cost ownership through automation. + +During the operation of the communication service the CSP provides assurance of service quality requirements and CSP meets the CSC expectations on automation as well as internal goals on CAPEX and OPEX efficiency. + +**REQ-CSA\_NSA-FUN-01** The 3GPP management system shall have capabilities to receive communication service requirements from its authorized consumers. + +**REQ-CSA\_NSA-FUN-02** The 3GPP management system shall have capabilities to monitor, and report to its authorized consumers the degree of fulfilment of committed communication service requirements of authorized consumers. + +**REQ-CSA\_NSA-FUN-03** The 3GPP management system shall have capabilities to take actions to adjust the 5GS in order to meet the communication service requirements of authorized consumers. + +**REQ-CSA\_NSA-FUN-04** The 3GPP management system shall have capabilities to act to fulfil the service quality requirements of authorized consumers. + +### 5.1.2 Communication service assurance for shared resources + +In this scenario, it is assumed that the SLA's for the two communication services will allow them to share resources, for example RAN resources. + +The management systems CS-Assurance service receives the request from Order Care and using a MDAS CS preparation assistance service, explores and evaluates communication service realisation and impact on other communication services, if any. + +Once the Order Care has committed to an SLA with a CSC, the management system activates the communication service. + +As the communication service operates, a management service for communication service assurance, CSA, continuously monitors the SLA fulfilment using MDAS, PM assurance services [3] including and core network NWD AF QoE analytics service, if available. + +Based on goals for SLA fulfilment, or other KPIs, the CSA service may initiate an action when SLA goals are not met, be that over- or under fulfilment. The CSA service may use an MDAS to assist in selecting proper action and how to best execute the action. + +The CSA service triggers the action by using provisioning service [4] towards RAN, transport and core network and monitors the effect of the change. + +REQ-CSIA\_CON-01: The 3GPP management system shall have the capability providing a management service for assisting in assessing (evaluating) a target SLA for a requested communication service. + +REQ-CSIA\_CON-02: The 3GPP management system shall have the capability providing a management service for assisting in asserting an agreed SLA for a requested communication service. + +### 5.1.3 Void + +### 5.1.4 Void + +# --- 6 Specification level use cases and requirements + +## 6.1 Use cases + +### 6.1.1 Communication service quality assurance and optimization + +The goal of the use case is to enable communication service quality assurance and optimization for the set of services provided by the network to certain group (category) of UEs. For example, the set can include the communication services provided via certain NSI(s) or to IoT devices in certain area. + +The group of NG-RAN and 5GC nodes (deployed and active), which are essential for the set of E2E services, provide provisioning and PM management services. It is also assumed that the providers of the related NSI / NSSI provisioning and PM management services are deployed and active. + +The management system is consuming the afore mentioned management services either directly or through proxy nodes that re-expose the management services; the management system is aware of the performance requirements imposed on the set of communication services. + +The management system is collecting the service experience information and monitoring the key performance indicators, KPIs, related to the targeted services. Analytics hosted by the MDAAF may be utilized for processing of the network data to derive and analyse the KPIs. If the service quality assurance and optimization function detects performance degradation the 3GPP management system may continuously modify the configuration parameters in the corresponding NG-RAN and 5GC nodes and NSI(s)/NSSI(s), to satisfy the SLA requirement. In case that changes of communication service SLS are needed, those changes may result as input to the 3GPP management system. + +If the network performance does not recover or improve, the management system may further adjust the network configuration or roll back to the previous configuration. At all times the management system continues to collect the network data and to monitor the performance indicators. + +### 6.1.2 NWDAF assisted communication service SLS Assurance + +The goal of this use case is to assure the SLSs (Service Level Specifications) for a particular communication service is crucial for the 5G network management. The negotiated SLS for a particular communication service should be assured in an autonomous way. + +3GPP management system can be leveraged to enable autonomous SLS assurance for a deployed communication service. 3GPP management system can collect QoE data, related to network slice and applications, from NWDAF. + +Since the data collected will relate to network slice and a single NSI may be serving multiple communication services, the corresponding QoE data for the target communication service needs to be ascertained. Once the QoE data for a communication service is known, the SLS breach can also be ascertained. If the SLS is breached, the root cause analysis is performed to find the cause for SLS breach. Depending on the location of cause (at RAN or at, 5GC), remedial actions will be initiated to mitigate the SLS breach and network optimization is done so that the negotiated SLS can be assured. + +The QoE analytical data from NWDAF is per Application for an NSI. It is crucial to derive which communication service is associated to the QoE data from the data received from NWDAF in order to ascertain the SLS breach. + +### 6.1.3 5G Core assisted SLS communication service Assurance + +The goal of this use case is to describe 5G Core management to assure compliance to SLSs (Service Level Specifications) for a communication service in 3GPP management system. + +3GPP management system receives the SLS requirements that required by CSP or NOP. 3GPP management system is capable to translate e2e SLS goal and set the 5GC goal(s) of SLS related to 5GC and activate a closed control loop for service assurance goal(s). To fulfill the SLS requirements, 3GPP management system is capable to configure the management resource and 5GC network functions (e.g. AMF, SMF, NWDAF) to monitor measurements and fault alarms that are relevant to the SLS. Since, for example, a network slice for eMBB can provide multiple communications services, one or multiple closed control loops for service assurance goals are set, and the network resource and performance measurements which are relevant to the SLS. + +During the process of service assurance of 5GC, the 5GC domain MDAS provider can be used to provide analysis of 5GC related network resource, virtual resources and performance assurance related to SLS in 5GC. The 5GC domain analysis report may be provided to 3GPP management system as part of the analysis result(s) of 5GC SLS. + +Together with the report from NWDAF, performance measurements and fault alarms related to 5GC NFs are also available for analysis of any potential service degradation. + +### 6.1.4 Communication service SLS assurance control + +The goal of this use case is to enable the MnS consumer to control the communication service SLS assurance closed control loop(s) (e.g. specify the SLS to be assured, enable/disable the SLS assurance, specify the assurance time for certain SLS) and obtain the SLS fulfilment information provided by MnS producer. It is assumed that the MnS producer maintains SLS assurance closed control loops for multiple SLSs. The detailed SLSs for network slice assurance are captured in ServiceProfile (e.g. latency, Throughput) associated to network slice and the detailed SLS for network slice subnet assurance are captured in SliceProfile (e.g. latency, Throughput) associated to network slice subnet. + +When an MnS producer receives an SLS assurance closed control loops(s) creation request with SLS assurance requirements for certain managed Entity (i.e. network slice, network slice subnet) from an MnS consumer, the SLS assurance requirements may include information of which SLS should be assured (e.g. latency should be assured), the SLS assurance granularity (e.g. per UE, per Network Slice, per S-NSSAI), SLS assurance condition (e.g. SLS assurance duration time, SLS assurance fulfilment requirements (e.g. the ratio of the SLS assurance time during the whole service usage time) ), the MnS producer create SLS closed control loop managed object instance contained by the specified managed Entity (i.e. NetworkSlice, NetworkSliceSubnet) and configures the received SLS assurance requirements in the created SLS closed control loop managed object instances. The MnS producer performs the network and/or service management to satisfy the SLS assurance requirements by adjusting the network (e.g. adjust the network topology, configure RRM policy) to satisfy the required SLS assurance requirements. + +During the SLS assurance closed control loop operation phase, the MnS consumer may request MnS producer to enable/disable the corresponding SLS assurance or update the SLS assurance requirements if needed, then MnS producer update corresponding the SLS assurance closed control loop managed object instance to ensure the MnS producer perform the SLS assurance closed control loop based on the new request. + +During the SLS assurance closed control loop operation phase, the MnS producer may report the SLS assurance closed control loop progress information and fulfilment information (e.g. SLS assurance requirements is satisfied or not) to the MnS consumer. + +## 6.2 Requirements + +**REQ-CSA-CON-01** The 3GPP management system shall have the capability to take actions for a set of communication services serving certain group of UEs based on the target SLS. + +**REQ-CSA-CON-02** The 3GPP management system shall have the capability to collect service experience information. + +**REQ-CSA-CON-03** The 3GPP management system shall have the capability to analyse the performance information related to the set of communication services serving certain group of UEs. + +**REQ-CSA-CON-04** The 3GPP management system shall have the capability to modify the configuration parameters related to the set of communication services serving certain group of UEs. + +**REQ-CSA-CON-05** The 3GPP management system shall have the capability to collect NSI related data from one or more 5GC NF(s). + +NOTE 1: An example for NSI related data may be QoE data. + +**REQ-CSA-CON-06** The 3GPP management system shall have the capability to derive which communication service is associated to the QoE data from the collected NSI related QoE data. + +NOTE 1a: A communication service in the 3GPP management system is identified by an S-NSSAI (the Slice/ServiceType, SST in the S-NSSAI identifies a communication service which can be detailed using the SliceDifferentiator, SD), see TS 23.003 [10]. + +**REQ-CSA-CON-07** The 3GPP management system shall have the capability to ascertain SLS breach. + +**REQ-CSA-CON-08** The 3GPP management system shall have the capability to perform the root cause analysis (e.g., identifying the underlying reason) for an SLS breach. + +**REQ-CSA-CON-09** The 3GPP management system shall have the capability to take corrective actions to assure the target goal. + +**REQ-CSA-CON-10** The 3GPP management system shall have the capability to translate network slice requirements to cross domain network slice subnet SLS goal and single domain network slice subnet SLS goal. + +**REQ-CSA-CON-11** The 3GPP management system shall have the capability to collect single domain SLS analysis as input to cross domain SLS analysis. + +**REQ-CSA-CON-12** The 3GPP management system shall have the capability to allow its authorized consumer to control the SLS assurance (e.g. specify the SLS to be assured, enable/disable, specify the assurance time and update the SLS assurance requirements). + +**REQ-CSA-CON-13** The 3GPP management system shall have the capability to allow its authorized consumer to obtain the SLS assurance fulfilment status information. + +NOTE 2: The management system refers to the producer of management service for SLS assurance. + +**REQ-LCM-CON-01** The 3GPP management system shall have the capability of lifecycle management of a closed control loop. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-07 | SA#88e | | | | | Upgrade to change control version | 16.0.0 | +| 2020-09 | SA#89e | SP-200750 | 0008 | - | F | Add abbreviations to clause 3.3 | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0009 | - | F | Correction of requirements text in clause 5.1.1 | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0010 | - | F | Remove Editors Notes from clause 5.1.2 | 16.1.0 | +| 2020-12 | SA#90e | SP-201056 | 0011 | - | F | Update and make closed control loop term consistent | 16.2.0 | +| 2020-12 | SA#90e | SP-201050 | 0012 | - | F | Corrections to clause 4.1 and 4.2.1 | 16.2.0 | +| 2020-12 | SA#90e | SP-201056 | 0014 | - | F | Update figure and description of Communication service assurance service | 16.2.0 | +| 2021-03 | SA#91e | SP-210151 | 0029 | - | F | Clarify intelligence in clause 4 | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0035 | 1 | F | Remove use cases clause 5.1.3 and 5.1.4 | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0036 | 1 | F | Update use cases and requirements to replace Communication Service | 16.3.0 | +| 2021-06 | SA#92e | SP-210402 | 0042 | - | F | Remove description of communication service lifecycle | 16.4.0 | +| 2021-06 | SA#92e | SP-210402 | 0044 | - | F | Update management control loops with lifecycle description | 16.4.0 | +| 2021-12 | SA#94e | SP-211470 | 0058 | 1 | F | Clarify business requirements | 16.5.0 | +| 2021-12 | SA#94e | SP-211470 | 0060 | - | F | Clarify business requirement and correct punctuation | 16.5.0 | +| 2021-12 | SA#94e | | 0061 | 1 | F | Clarify communication service in requirement CSA-CON-06 | 16.5.0 | +| 2023-09 | SA#101 | SP-230940 | 0071 | - | F | Rel-16 CR for TS28.535 Fix invalid clause and wrong description of requirements | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28536/21ad58fee90f2be50708ff541d225507_img.jpg b/marked/Rel-16/28_series/28536/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be05d4daab9d464d0c5d3c5b94db98a128d2966c --- /dev/null +++ b/marked/Rel-16/28_series/28536/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c1370453aa7b6a2cb81b99bc9e241a8c9c8b4673d089581a02aeee3524ca2ba +size 55401 diff --git a/marked/Rel-16/28_series/28536/2ba086df3506f81bae3a9b53725dcfea_img.jpg b/marked/Rel-16/28_series/28536/2ba086df3506f81bae3a9b53725dcfea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9e9c49818d8b06155c93bd85bef9be3e946b49f --- /dev/null +++ b/marked/Rel-16/28_series/28536/2ba086df3506f81bae3a9b53725dcfea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d95f607d4264915d946b21ace56369c60b0446b9de57132da283da3b2665ed3 +size 19715 diff --git a/marked/Rel-16/28_series/28536/5793a44ffdadd039928e2f9fe6daae06_img.jpg b/marked/Rel-16/28_series/28536/5793a44ffdadd039928e2f9fe6daae06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..943def540d0aff89acebc055bce5a2548f63a119 --- /dev/null +++ b/marked/Rel-16/28_series/28536/5793a44ffdadd039928e2f9fe6daae06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62bc101ffb8d5024728277f7dddf0008564360c33965a781c82d55b28d6253d7 +size 35188 diff --git a/marked/Rel-16/28_series/28536/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/28_series/28536/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1896fe1bca6d6ad188bb3d0a7b32543e540e54f9 --- /dev/null +++ b/marked/Rel-16/28_series/28536/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8f3f90f33454e14926be7d61a4732f7960aa7084068906dcd5956dd5e0fc4b2f +size 9291 diff --git a/marked/Rel-16/28_series/28536/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/28_series/28536/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..77fdb36b6c0a2aca0513bfda82c7fb53d7e2ac8f --- /dev/null +++ b/marked/Rel-16/28_series/28536/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a71bd2777737420adbe491eda68514731540ccbc8f621218907d5d62f1ce349e +size 5654 diff --git a/marked/Rel-16/28_series/28536/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg b/marked/Rel-16/28_series/28536/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9492c0570c4b3fbe411009a6b1a25093dbed3d91 --- /dev/null +++ b/marked/Rel-16/28_series/28536/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:964f673f25065cdcf01a5706a60a3c6fc5e0493e02cc1801009865928539caf7 +size 69109 diff --git a/marked/Rel-16/28_series/28536/b28af4985cdef1e519e3aaf26561dcb3_img.jpg b/marked/Rel-16/28_series/28536/b28af4985cdef1e519e3aaf26561dcb3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c31867b5be77d5628dfdfb838f6e48839a2aa11e --- /dev/null +++ b/marked/Rel-16/28_series/28536/b28af4985cdef1e519e3aaf26561dcb3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0faa09145704b74b13ffe9343b95319aa3a4c05e7c905856a062dacb1151220e +size 50170 diff --git a/marked/Rel-16/28_series/28536/raw.md b/marked/Rel-16/28_series/28536/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c8da45cbf70abfaec612d19a53d345efacf88c72 --- /dev/null +++ b/marked/Rel-16/28_series/28536/raw.md @@ -0,0 +1,863 @@ + + +# 3GPP TS 28.536 V16.5.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Management services for communication service assurance; Stage 2 and stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. The "3" and "G" are connected by a red curved line. Below the text is the phrase "A GLOBAL INITIATIVE" in a smaller, all-caps, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Communication service assurance service..... | 7 | +| 4.1 Stage 2 ..... | 7 | +| 4.1.1 Void ..... | 7 | +| 4.1.2 Model..... | 7 | +| 4.1.2.1 Imported and associated information entities ..... | 7 | +| 4.1.2.1.1 Imported information entities and local labels..... | 7 | +| 4.1.2.1.2 Associated information entities and local labels ..... | 8 | +| 4.1.2.2 Class diagram..... | 8 | +| 4.1.2.2.1 Relationships..... | 8 | +| 4.1.2.2.2 Inheritance ..... | 8 | +| 4.1.2.3 Class definitions..... | 9 | +| 4.1.2.3.1 AssuranceClosedControlLoop ..... | 9 | +| 4.1.2.3.2 AssuranceGoal ..... | 9 | +| 4.1.2.3.3 Void..... | 10 | +| 4.1.2.3.4 Void..... | 10 | +| 4.1.2.3.5 AssuranceTarget <<dataType>>..... | 10 | +| 4.1.2.4 Attribute definitions ..... | 10 | +| 4.1.2.4.1 Attribute properties ..... | 10 | +| 4.1.2.4.2 Constraints..... | 13 | +| 4.1.2.4.3 Notifications ..... | 13 | +| 4.1.2.5 Common notifications..... | 13 | +| 4.1.2.5.1 Alarm notifications..... | 13 | +| 4.1.2.5.2 Configuration notifications ..... | 13 | +| 4.1.3 Procedures ..... | 14 | +| 4.1.3.1 SLS Assurance Procedure..... | 14 | +| 4.2 Stage 3 ..... | 15 | +| 4.2.1 Solution Set (SS) for JSON/YAML ..... | 15 | +| <b>Annex A (informative): Control loop deployed in different layers .....</b> | <b>16</b> | +| A.1 Introduction ..... | 16 | +| A.2 Control loop in communication service layer ..... | 16 | +| A.3 Control loop in network slice layer..... | 16 | +| A.4 Control loop in network slice subnet layer..... | 17 | +| A.5 Control loop in NF layer ..... | 17 | +| <b>Annex B (normative): OpenAPI definition of the COSLA NRM .....</b> | <b>18</b> | +| B.1 General..... | 18 | +| B.2 Solution Set (SS) definitions..... | 18 | +| B.2.1 OpenAPI document "TS28536_CoslaNrm.yml" ..... | 18 | +| <b>Annex C (normative): AssuranceClosedControlLoop state management .....</b> | <b>21</b> | +| <b>Annex D (informative): Change history.....</b> | <b>23</b> | + + + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document describes closed control loop assurance solution enabling a service provider or an operator to continuously deliver the requested level of communication service quality to the customer and is part of a TS-family covering the 3rd Generation Partnership Project Technical Specification Group Services and System Aspects Management and orchestration of networks, as identified below: + +TS 28.535: Management Services for Communication Service Assurance; Requirements + +# **TS 28.536: Management Services for Communication Service Assurance; Stage 2 and stage 3** + +The solution described builds upon the management services specifications as identified below: + +TS 28.530: Management and orchestration; Concepts, use cases and requirements + +TS 28.533: Management and orchestration; Architecture framework + +TS 28.532: Management and orchestration; Generic management services. + +TS 28.540: Management and orchestration; 5G Network Resource Model (NRM); Stage 1 + +TS 28.541: Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3 + +TS 28.531: Management and orchestration; Provisioning + +TS 28.545: Management and orchestration; Fault Supervision (FS) + +TS 28.550: Management and orchestration; Performance assurance + +TS 28.552: Management and orchestration; 5G performance measurements + +TS 28.554: Management and orchestration; 5G End to end Key Performance Indicators (KPI) + +# --- 1 Scope + +The present document describes the management services for communication service assurance and specifies stage 2 and stage 3 for closed control loop communication service assurance solution that adjusts and optimizes the services provided by NG-RAN and 5GC. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] Void +- [3] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [4] Void +- [5] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [7] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [8] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [10] 3GPP TS 32.160: "Management and orchestration; Management service template". +- [11] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [12] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [13] 3GPP TS 28.554: "Management and orchestration; 5G end to end Key Performance Indicators (KPI)". +- [14] 3GPP TS 28.625: "State Management Data Definition Integration Reference Point (IRP); Information Service (IS)". +- [15] ITU-T Recommendation X.731: "Information technology - Open Systems Interconnection - Systems Management: State management function". +- [16] Void + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|-------|-----------------------------------| +| COSLA | Closed control loop SLS Assurance | +| CSC | Communication Service Customer | +| CSP | Communication Service Provider | +| IOC | Information Object Class | +| IS | Information Service | +| JSON | JavaScript Object Notation | +| YAML | YAML Ain't Markup Language | +| MDAS | Management Data Analytics Service | +| MDT | Minimization of Drive Tests | +| MnS | Management Service | +| NF | Network Function | +| NRM | Network Resource Model | +| NSSI | NetworkSlice Subnet Instance | +| NWDAF | NetWork Data Analytics Function | +| QoE | Quality of Experience | +| SLA | Service Level agreement | +| SLS | Service Level Specification | + +# --- 4 Communication service assurance service + +## 4.1 Stage 2 + +### 4.1.1 Void + +### 4.1.2 Model + +#### 4.1.2.1 Imported and associated information entities + +##### 4.1.2.1.1 Imported information entities and local labels + +| Label reference | Local label | +|-------------------------|-------------| +| TS 28.622 [5], IOC, Top | Top | + +##### 4.1.2.1.2 Associated information entities and local labels + +| Label reference | Local label | +|--------------------------------------------|--------------------| +| TS 28.622 [5], IOC, SubNetwork | SubNetwork | +| TS 28.541 [6], IOC, NetworkSlice | NetworkSlice | +| TS 28.541 [6], IOC, NetworkSliceSubnet | NetworkSliceSubnet | +| TS 28.622 [5], IOC, ManagedElement | ManagedElement | +| TS 28.541 [6], attribute, serviceProfileId | serviceProfileId | +| TS 28.541 [6], attribute, sliceProfileId | sliceProfileId | + +#### 4.1.2.2 Class diagram + +##### 4.1.2.2.1 Relationships + +This clause depicts the set of classes that encapsulates the information relevant for this MnS. This clause provides an overview of the relationships between relevant classes in UML. + +![UML Class diagram showing relationships between AssuranceGoal, AssuranceClosedControlLoop, SubNetwork, ManagedElement, NetworkSlice, and NetworkSliceSubnet.](b28af4985cdef1e519e3aaf26561dcb3_img.jpg) + +``` + +classDiagram + class SubNetwork["«InformationObjectClass» SubNetwork"] + class ManagedElement["«InformationObjectClass» ManagedElement"] + class AssuranceGoal["«InformationObjectClass» AssuranceGoal"] + class AssuranceClosedControlLoop["«InformationObjectClass» AssuranceClosedControlLoop"] + class NetworkSlice["«InformationObjectClass» NetworkSlice"] + class NetworkSliceSubnet["«InformationObjectClass» NetworkSliceSubnet"] + + AssuranceGoal "*" --> "1" AssuranceClosedControlLoop : «names» + SubNetwork "1" --> "*" AssuranceClosedControlLoop : «names» + ManagedElement "1" --> "*" AssuranceClosedControlLoop : «names» + AssuranceClosedControlLoop "*" --> "1" NetworkSlice + AssuranceClosedControlLoop "*" --> "1" NetworkSliceSubnet + + note for SubNetwork "{xor}" + SubNetwork -.-> note + ManagedElement -.-> note + +``` + +UML Class diagram showing relationships between AssuranceGoal, AssuranceClosedControlLoop, SubNetwork, ManagedElement, NetworkSlice, and NetworkSliceSubnet. + +Figure 4.1.2.2.1.1: Assurance management NRM fragment + +##### 4.1.2.2.2 Inheritance + +![UML Class diagram showing inheritance relationships from Top to AssuranceClosedControlLoop and AssuranceGoal.](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass» Top"] + class AssuranceClosedControlLoop["«InformationObjectClass» AssuranceClosedControlLoop"] + class AssuranceGoal["«InformationObjectClass» AssuranceGoal"] + + AssuranceClosedControlLoop --|> Top + AssuranceGoal --|> Top + +``` + +UML Class diagram showing inheritance relationships from Top to AssuranceClosedControlLoop and AssuranceGoal. + +Figure 4.1.2.2.2.1: Assurance management inheritance relationships + +#### 4.1.2.3 Class definitions + +##### 4.1.2.3.1 AssuranceClosedControlLoop + +###### 4.1.2.3.1.1 Definition + +This IOC represents assurance closed control loop, an assurance closed control loop monitors and adjusts the resources associated with a `NetworkSlice` or `NetworkSliceSubnet` in order to meet the objectives described by one or more assurance goals. The capabilities include: + +- state management of an `AssuranceClosedControlLoop` +- to keep track of the lifecycle of an `AssuranceClosedControlLoop` + +A consumer can check the effectiveness of the `assuranceClosedControlLoop` by consulting the performance measurements [12] and KPI's [13] associated with the target and comparing values of the targets with the values of the characteristics related attributes reported by the performance assurance service. + +###### 4.1.2.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------------------------------|-------------------|------------|------------|-------------|--------------| +| <code>operationalState</code> | M | T | F | F | T | +| <code>administrativeState</code> | M | T | T | F | T | +| <code>controlLoopLifeCyclePhase</code> | M | T | T | F | T | + +###### 4.1.2.3.1.3 Constraints + +No constraints have been defined for this document. + +###### 4.1.2.3.1.4 Notifications + +The common notifications defined in clause 4.1.2.5 are valid for this IOC, without exceptions or additions. + +##### 4.1.2.3.2 AssuranceGoal + +###### 4.1.2.3.2.1 Definition + +This class represents the subset of attributes (typically characteristics attributes) from an SLS, i.e. a `ServiceProfile` or a `SliceProfile`, that are subject to assurance requirements. A single instance of `AssuranceGoal` represents a list of assurance targets. The assurance goal includes information about the time a goal should be observed and the status of the the goal fulfilment + +NOTE: A `NetworkSlice` or `NetworkSliceSubnet` can support multiple instances of `AssuranceGoal`. + +###### 4.1.2.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|-------------------------------------------|-------------------|------------|------------|-------------|--------------| +| <code>assuranceTargetList</code> | M | T | F | F | T | +| <code>sliceProfileId</code> | CM | T | T | F | T | +| <code>serviceProfileId</code> | CM | T | T | F | T | +| <code>observationTime</code> | M | T | T | F | T | +| <code>AssuranceGoalStatusObserved</code> | O | T | F | F | T | +| <code>AssuranceGoalStatusPredicted</code> | O | T | F | F | T | +| <b>Attributes related to role</b> | | | | | | +| <code>networkSliceRef</code> | CM | T | T | F | T | +| <code>networkSliceSubnetRef</code> | CM | T | T | F | T | + +###### 4.1.2.3.2.3 Attribute constraints + +| Name | Definition | +|-----------------------|--------------------------------------------------------------| +| sliceProfileId | Condition: the AssuranceGoal applies to a NetworkSliceSubNet | +| serviceProfileId | Condition: the AssuranceGoal applies to a NetworkSlice | +| networkSliceSubnetRef | Condition: the AssuranceGoal applies to a NetworkSliceSubNet | +| networkSliceRef | Condition: the AssuranceGoal applies to a NetworkSlice | + +###### 4.1.2.3.2.4 Notifications + +The common notifications defined in subclause 4.1.2.5 are valid for this IOC, without exceptions or additions. + +##### 4.1.2.3.3 Void + +##### 4.1.2.3.4 Void + +##### 4.1.2.3.5 AssuranceTarget <<dataType>> + +###### 4.1.2.3.5.1 Definition + +This data type represents a single attribute name-value-pair of which one or more are included in an AssuranceGoal. + +###### 4.1.2.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------|-------------------|------------|------------|-------------|--------------| +| assuranceTargetName | M | T | F | F | T | +| assuranceTargetValue | M | T | F | F | T | + +###### 4.1.2.3.5.3 Attribute constraints + +No constraints have been defined for this document. + +###### 4.1.2.3.5.4 Notifications + +The common notifications defined in clause 4.1.2.5 are valid for the <<IOC>> using this <<dataType>> as one of its attributes, shall be applicable. + +#### 4.1.2.4 Attribute definitions + +##### 4.1.2.4.1 Attribute properties + +The following table defines the properties of attributes that are specified in the present document. + +Table 4.1.2.4.1.1 + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| controlLoopLifeCyclePhase | It indicates the lifecycle phase of the AssuranceClosedControlLoop instance.<br><br>AllowedValues: Preparation, Commissioning, Operation and Decommissioning. | type: Enum<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: NULL<br>isNullable: False | +| assuranceTargetName | The name of the attribute which is part of AssuranceTarget.<br>The assuranceTargetName shall be equal to the name of an attribute in the relevant ServiceProfile or SliceProfile. The relevant ServiceProfile or SliceProfile is identified by the attribute serviceProfileId or sliceProfileId in the AssuranceGoal. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| assuranceTargetValue | The value of the attribute which is part of AssuranceTarget | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| assuranceTargetList | This is an attribute containing a list of AssuranceTarget(s) that are part of an AssuranceGoal | type: AssuranceTarget<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| observationTime | It indicates the time duration over which an AssuranceGoal is observed.<br>The observation time is expressed in seconds. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| assuranceGoalStatusObserved | It holds the status of the observed goal fulfilment to the assuranceGoal<br><br>allowedValues: "FULFILLED", "NOT_FULFILLED" | type: ENUM<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| assuranceGoalStatusPredicted | It holds the status of the predicted future goal fulfilment to the assuranceGoal<br><br>allowedValues: "FULFILLED", "NOT_FULFILLED" | type: ENUM<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| networkSliceRef | It holds the reference to the NetworkSlice instance subject to assurance requirements | type: Dn<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| networkSliceSubnetRef | It holds the reference to the NetworkSliceSubnet instance subject to assurance requirements | type: Dn<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| | | | +|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| operationalState | It indicates the operational state of the AssuranceClosedControlLoop instance. It describes whether the resource is installed and partially or fully operable (Enabled) or the resource is not installed or not operable (Disabled).<br><br>Allowed values; Enabled/Disabled<br><br>allowedValues: "ENABLED", "DISABLED".<br>The meaning of these values is as defined in 3GPP TS 28.625 [14] and ITU-T X.731 [15]. | type: ENUM<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: Disabled<br>allowedValues: Enabled, Disabled<br>isNullable: False | +| administrativeState | It indicates the administrative state of the AssuranceClosedControlLoop instance. It describes the permission to use or the prohibition against using the AssuranceClosedControlLoop instance. The administrative state is set by the MnS consumer.<br><br>Allowed values; Locked/Unlocked<br><br>allowedValues: "LOCKED", "UNLOCKED".<br>The meaning of these values is as defined in 3GPP TS 28.625 [14] and ITU-T X.731 [15]. | type: ENUM<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: Locked<br>allowedValues: Locked, Unlocked<br>isNullable: False | +| NOTE 1: Void<br>NOTE 2: Void | | | + +##### 4.1.2.4.2 Constraints + +No constraints have been identified for this document. + +##### 4.1.2.4.3 Notifications + +This subclause presents a list of notifications, defined in [7], that provisioning management service consumer can receive. The notification parameter `objectClass/objectInstance`, defined in [10], would capture the DN of an instance of an IOC defined in the present document. + +#### 4.1.2.5 Common notifications + +##### 4.1.2.5.1 Alarm notifications + +This clause presents a list of notifications, defined in TS 28.532 [7], that an MnS consumer may receive. The notification header attribute `objectClass/objectInstance`, defined in TS 32.302 [8], shall capture the DN of an instance of a class defined in the present document. + +| Name | Qualifier | Notes | +|-------------------------------------|-----------|-------| +| notifyNewAlarm | M | -- | +| notifyClearedAlarm | M | -- | +| notifyAckStateChanged | M | -- | +| notifyAlarmListRebuilt | M | -- | +| notifyChangedAlarm | O | -- | +| notifyCorrelatedNotificationChanged | O | -- | +| notifyChangedAlarmGeneral | O | -- | +| notifyComments | O | -- | +| notifyPotentialFaultyAlarmList | O | -- | + +##### 4.1.2.5.2 Configuration notifications + +This clause presents a list of notifications, defined in TS 28.532 [7], that an MnS consumer may receive. The notification header attribute `objectClass/objectInstance`, defined in TS 32.302 [8], shall capture the DN of an instance of a class defined in the present document. + +| Name | Qualifier | Notes | +|--------------------------------|-----------|-------| +| notifyMOICreation | O | -- | +| notifyMOIDeletion | O | -- | +| notifyMOIAttributeValueChanges | O | -- | +| notifyEvent | O | -- | + +### 4.1.3 Procedures + +#### 4.1.3.1 SLS Assurance Procedure + +![Sequence diagram of the SLS Assurance Procedure. Lifelines: AssuranceControlLoop Consumer, Entities Participating in loop, Provisioning MnS Provider, Performance/Fault MnS Provider, Analytical_data Provider. The procedure involves deriving goals, subscribing to data, receiving data, analyzing fulfillment, deciding on actions, and reporting fulfillment.](9ae17964ddd9b814c7d905b1af2fddf2_img.jpg) + +``` + +sequenceDiagram + participant Consumer as AssuranceControlLoop Consumer + participant Entities as Entities Participating in loop + participant Provisioning as Provisioning MnS Provider + participant Performance as Performance/Fault MnS Provider + participant Analytical as Analytical_data Provider + + Note left of Consumer: 1. derive the AssuranceControlLoopGoals from ServiceProfile or SliceProfile + Consumer->>Entities: 2. AssuranceControlLoopGoal + loop For each data source + Entities->>Performance: 3. Subscribe for PM/FM/QoE/MDT data + Entities->>Analytical: 4. Subscribe for Analytical Data + end + loop For each observation period + Performance->>Entities: 5. Receive PM/FM/QoE/MDT data + Analytical->>Entities: 6. Receive Analytical Data + Note left of Entities: 7. Analyze Assurance Fulfillment + Note left of Entities: 8. Decision Action + Entities->>Provisioning: 9. Execute Action + Provisioning->>Entities: 10. Action Completed + end + Entities->>Consumer: 11. AssuranceControlLoopGoal Fulfillment + +``` + +Sequence diagram of the SLS Assurance Procedure. Lifelines: AssuranceControlLoop Consumer, Entities Participating in loop, Provisioning MnS Provider, Performance/Fault MnS Provider, Analytical\_data Provider. The procedure involves deriving goals, subscribing to data, receiving data, analyzing fulfillment, deciding on actions, and reporting fulfillment. + +Figure 4.1.3.1.1 SLS assurance procedure + +For the purpose of the procedure shown in Figure 4.1.3.1.1 "entities participating in the loop" refers to any entity in the 3GPP management system responsible for the functioning of an ACCL to ensure the AssuranceControlLoopGoal required by an AssuranceControlLoop\_Consumer. + +1. AssuranceControlLoop\_consumer derives AssuranceControlLoopGoal from the ServiceProfile or SliceProfile. +2. AssuranceControlLoop\_consumer provides the AssuranceControlLoopGoal to Entities\_Participating\_in\_loop by utilizing the provision management services defined in as defined in clause 11.1.1.3 of TS 28.532 [7]. + +NOTE 1: In case the Entities\_Participating\_in\_loop represents CrossDomain\_Entities\_Participating\_in\_loop, the AssuranceControlLoopGoal is the attribute(s) of the ServiceProfile. In case the Entities\_Participating\_in\_loop represents Domain\_Entities\_Participating\_in\_loop, the AssuranceControlLoopGoal is the attribute(s) of the SliceProfile. + +3. Entities\_Participating\_in\_loop subscribes the related performance data (e.g., the packet delay related measurements), fault data, QoE data (e.g., buffer level) and MDT data from respective sources by utilizing the Operation establishStreamingConnection as defined in clause 6.2.1 of TS 28.550 [3]. +4. Entities\_Participating\_in\_loop, optionally, subscribes the related analytical data from MDAS producer or network functions, e.g., NWDAF. In case of NWDAF as a provider, Nnwdaf\_EventsSubscription Service as defined in clause 4.2 of TS 29.520 [11] is used. + +5. Entities\_Participating\_in\_loop collects the related performance, fault, QoE and MDT data (e.g., the packet delay related measurements), fault data, QoE data (e.g., buffer level) and MDT data from respective sources by utilizing the Operation establishStreamingConnection as defined in clause 6.2.1 of TS 28.550 [3]. + 6. Entities\_Participating\_in\_loop, optionally, collects the related analytical data from MDAS producer or network functions, e.g., NWDAF. In case of NWDAF as a provider, Nnwdaf\_EventsSubscription Service as defined in clause 4.2 of TS 29.520 [11] is used. + 7. Entities\_Participating\_in\_loop assesses if the AssuranceControlLoopGoal has been fulfilled. + 8. Entities\_Participating\_in\_loop assesses if and which action to take in case the AssuranceControlLoopGoal has not been fulfilled. + 9. As per the mitigation action (e.g., scale out) resources are changed, the generic provisioning management service as defined in clause 11.1 of TS 28.532 [7] is utilized for the same. + 10. Action completed. +- NOTE 2: The Entities\_Participating\_in\_loop continues to monitor and analyse the performance and perform the adjustment until the attribute(s) of SliceProfile is assured. +11. AssuranceControlLoop\_consumer receives the confirmation of assurance fulfilment from Entities\_Participating\_in\_loop by utilizing the provision management services defined in clause 11.1.1.3 of TS 28.532 [7]. + +## 4.2 Stage 3 + +### 4.2.1 Solution Set (SS) for JSON/YAML + +The JSON/YAML solution set is documented in clause B.2. + +# Annex A (informative): Control loop deployed in different layers + +## A.1 Introduction + +This example gives a high-level view of control loops deployed in different layers, which consists of control loop in communication service layer, control loop in network slice layer, control loop in network slice subnet layer and control loop in NF layer, as described as Figure A.1.1, where the analytic could be leverage MDAS, and different control loops can provide input (interact with) to other control loops (in the same layer or different layers) and obtain the output from other control loops (in the same layer or different layers). + +![Diagram showing four stacked control loops in different layers: communication service layer, network slice layer, network slice subnet layer, and NF layer. Each layer contains a sub-loop with Monitor, Analytic (e.g. MDA), Decision, and Execution components. Vertical double-headed arrows connect adjacent layers, indicating interaction.](21ad58fee90f2be50708ff541d225507_img.jpg) + +``` +graph TD; subgraph L1 [Control loop in communication service layer]; M1[Monitor] --- A1["Analytic(e.g. MDA)"] --- D1[Decision] --- E1[Execution]; end; subgraph L2 [Control loop in network slice layer]; M2[Monitor] --- A2["Analytic(e.g. MDA)"] --- D2[Decision] --- E2[Execution]; end; subgraph L3 [Control loop in network slice subnet layer]; M3[Monitor] --- A3["Analytic(e.g. MDA)"] --- D3[Decision] --- E3[Execution]; end; subgraph L4 [Control loop in NF layer]; M4[Monitor] --- A4["Analytic(e.g. MDA)"] --- D4[Decision] --- E4[Execution]; end; L1 <--> L2; L2 <--> L3; L3 <--> L4; +``` + +Diagram showing four stacked control loops in different layers: communication service layer, network slice layer, network slice subnet layer, and NF layer. Each layer contains a sub-loop with Monitor, Analytic (e.g. MDA), Decision, and Execution components. Vertical double-headed arrows connect adjacent layers, indicating interaction. + +Figure A.1.1: Control loop in different layers + +## A.2 Control loop in communication service layer + +SLA/SLS requirements provided from CSC are translated into serviceProfile, which represents the requirements for communication service assurance to the CSP. Coordination between control loop in communication service layer and control loop in network slice layer is needed to calculate the communication service resource requirements and to assure the communication service SLA/SLS requirements. + +When the communication service is active, network slice performance is monitored and analysed for the communication service according to end user service experiences. + +If service degradation occurs or it is predicted, the 3GPP management system could take actions, i.e. the allocated resources are scaled up or the SLS is adjusted based on pre-agreement/interaction between CSP and CSC. + +## A.3 Control loop in network slice layer + +After receiving SLA/SLS requirements from service profile and completing the network slice provisioning, the network slice performance (e.g. KPI, QoE) are monitored and reported. Compared to the SLA/SLS requirements from service profile, when network slice performance is not met, the 3GPP management system identifies the root cause and may reconfigure the resources according to analytical report from MDAS producer. The network slice resources are also modified accordingly in case the network slice performance requirement needs to be changed based on communication service requirement adjustment. + +## A.4 Control loop in network slice subnet layer + +After decomposing service profile to slice profile, the performance requirements for each network slice subnet are obtained. The 3GPP management system could have the capability of service observation (e.g., the supervision to the NSSI) based on MDAS. Based on such observation and comparison with initial subnet performance requirements, management actions on the NSSI might be performed if NSSI performance requirements fulfillment indicates a problem. Another possible scenario is that, when the NSSI performance requirement is changed because of the network slice modification management action, the NSSI resources might be also reconfigured. + +## A.5 Control loop in NF layer + +NOTE: The control loop in NF layer is not addressed in the present document. + +# --- Annex B (normative): OpenAPI definition of the COSLA NRM + +## B.1 General + +This annex contains the OpenAPI definition of the COSLA NRM in YAML format. + +The Information Service (IS) of the COSLA NRM is defined in clause 4. + +Mapping rules to produce the OpenAPI definition based on the IS are defined in TS 32.160 [10]. + +## --- B.2 Solution Set (SS) definitions + +### B.2.1 OpenAPI document "TS28536\_CoslaNrm.yml" + +``` +openapi: 3.0.1 + +info: + title: coslaNrm + version: 16.4.0 + description: > + OAS 3.0.1 specification of the Cosla NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 28.536 V16.4.0; Cosla NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ + +paths: {} + +components: + schemas: + +#----- Type definitions ----- + + ControlLoopLifeCyclePhase: + type: string + enum: + - PREPARATION + - COMMISSIONING + - OPERATION + - DECOMMISSIONING + + ObservationTime: + type: integer + + AssuranceGoalStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceGoalStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTarget: + type: object + properties: + assuranceTargetName: +``` + +``` + type: string + assuranceTargetValue: + type: string + +AssuranceTargetList: + type: array + items: + $ref: '#/components/schemas/AssuranceTarget' + +#----- Definition of concrete IOCs ----- + +MnS: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + - type: object + properties: + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + +SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + +ManagedElement-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + +AssuranceClosedControlLoop-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + controlLoopLifeCyclePhase: + $ref: '#/components/schemas/ControlLoopLifeCyclePhase' + AssuranceGoal: + $ref: '#/components/schemas/AssuranceGoal-Multiple' + +AssuranceGoal-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + observationTime: + $ref: '#/components/schemas/ObservationTime' +``` + +``` + assuranceTargetList: + $ref: '#/components/schemas/AssuranceTargetList' + assuranceGoalStatusObserved: + $ref: '#/components/schemas/AssuranceGoalStatusObserved' + assuranceGoalStatusPredicted: + $ref: '#/components/schemas/AssuranceGoalStatusPredicted' + serviceProfileId: + type: string + sliceProfileId: + type: string + networkSliceRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + networkSliceSubnetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + +#----- Definition of JSON arrays for name-contained IOCs ----- +SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + +ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + +AssuranceClosedControlLoop-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + +AssuranceGoal-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceGoal-Single' + +#----- Definitions in TS 28.536 for TS 28.623 ----- + +resources-coslaNrm: + oneOf: + - $ref: '#/components/schemas/MnS' + + - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + - $ref: '#/components/schemas/AssuranceGoal-Single' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' +``` + +# Annex C (normative): AssuranceClosedControlLoop state management + +An AssuranceClosedControlLoop is a logical object in the management system that represents complex interaction between the assurance information and configuration information of a grouping of resources. At any time, the management system needs to know the state of an AssuranceClosedControlLoop. + +The ITU-T X.731 [15], to which [14] refers, has defined the inter-relation between the administrative state and operational state of systems in general. Figure X.1 shows the state diagram of an AssuranceClosedControlLoop, where the number in the Figure identify the state changes. The explanations for the state changes are described in Table C.1. + +![Figure C.1: AssuranceClosedControlLoop state diagram. The diagram shows two main states: 'Unlocked' and 'Locked'. Each state contains two sub-states: 'Disabled' and 'Enabled'. Transitions are numbered 0 through 5. State 0 (Initial and Final state) leads to 'Locked & Disabled'. State 1 leads to 'Locked & Enabled'. State 2 leads to 'Locked' (either 'Disabled' or 'Enabled'). State 3 leads to 'Unlocked' (either 'Disabled' or 'Enabled'). State 4 is a transition between 'Disabled' and 'Enabled' within the same administrative state. State 5 is a self-loop on the initial state.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Locked: 0 + state "Locked" as Locked { + [*] --> Disabled: 1 + Disabled --> Enabled: 1 + Enabled --> Disabled: 4 + } + Locked --> [*]: 5 + state "Unlocked" as Unlocked { + [*] --> Disabled: 3 + Disabled --> Enabled: 1 + Enabled --> Disabled: 4 + } + Unlocked --> [*]: 2 + +``` + +Figure C.1: AssuranceClosedControlLoop state diagram. The diagram shows two main states: 'Unlocked' and 'Locked'. Each state contains two sub-states: 'Disabled' and 'Enabled'. Transitions are numbered 0 through 5. State 0 (Initial and Final state) leads to 'Locked & Disabled'. State 1 leads to 'Locked & Enabled'. State 2 leads to 'Locked' (either 'Disabled' or 'Enabled'). State 3 leads to 'Unlocked' (either 'Disabled' or 'Enabled'). State 4 is a transition between 'Disabled' and 'Enabled' within the same administrative state. State 5 is a self-loop on the initial state. + +**Figure C.1: AssuranceClosedControlLoop state diagram** + +In an AssuranceClosedControlLoop deployment scenario, the interactions between various management services allow the reconfiguration of the resources controlled by the AssuranceClosedControlLoop based on predefined goal(s). The interactions specified under the column "The state transition events and actions" of Table C.1 shall be present for the state transition. + +**Table C.1: The AssuranceClosedControlLoop state transition table** + +| Trigger number | The state transition events and actions | State | +|----------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| 0 | The Assurance MnS producer responds positively to the "create ACCL" message, the ACCL is created and the state is set to Locked | Locked & Disabled | +| 1 | The Assurance MnS producer has assurance goals to fulfil and starts or resumes operation by setting the operational state to Enabled | Locked & Enabled | +| 2 | The Assurance MnS consumer suspends operation of the ACCL by setting the administrative state to Locked | Locked<br>(Enabled or Disabled) | +| 3 | The Assurance MnS consumer resumes operation of the ACCL by setting the administrative state to Unlocked. | Unlocked | + +| | | | +|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| | | (Enabled or Disabled) | +| 4 | The Assurance MnS producer does not have any assurance goals to fulfil and suspends operation by setting the operational state to Disabled | Disabled<br>(Locked or Unlocked) | +| 5 | The Assurance MnS producer responds positively to the “delete ACCL” message, the ACCL is deleted, and the state is set to NULL (the Initial and Final state) | NULL | + +NOTE: The trigger numbers in the first column represent the state changes in Figure C.1 + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-07 | SA#88e | | | | | Upgrade to change control version | 16.0.0 | +| 2020-09 | SA#89e | SP-200749 | 0001 | - | F | Update control loop deployed in different layers with SLA decomposition | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0004 | - | F | Add references to clause 4.1.2.3 | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0005 | - | F | Correct title and add references in clause 4.1.1 | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0006 | - | F | Remove Editor's Note in clause 4.1.1 | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0007 | - | F | Replace Editors Note in clause Annex A.5 with a Note | 16.1.0 | +| 2020-09 | SA#89e | SP-200750 | 0003 | - | F | Add abbreviations to clause 3.3 | 16.1.0 | +| 2020-12 | SA#90e | SP-201050 | 0008 | - | F | Update references to other specifications | 16.2.0 | +| 2020-12 | SA#90e | SP-201056 | 0011 | - | F | Update and make closed control loop term consistent | 16.2.0 | +| 2020-12 | SA#90e | SP-201056 | 0013 | - | F | Add Annex on state management | 16.2.0 | +| 2020-12 | SA#90e | SP-201056 | 0016 | - | F | Implement Assurance Closed Loop model changes | 16.2.0 | +| 2020-12 | SA#90e | | | | | Correction in history table of SP numbers | 16.2.1 | +| 2021-03 | SA#91e | SP-210151 | 0017 | - | F | Remove conflicting attribute definitions | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0018 | - | F | Clarify modelling of AssuranceGoal | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0019 | 3 | F | Correct OpenAPI definition of the COSLA NRM | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0022 | - | F | Remove overview from stage 2 description | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0025 | 2 | F | Correct the misalignment information for COSLA NRM | 16.3.0 | +| 2021-03 | SA#91e | SP-210151 | 0027 | 1 | F | Add explanation of entities in closed loop | 16.3.0 | +| 2022-06 | SA#96 | SP-220497 | 0045 | - | F | Fixing OpenAPI Discoverability issue in CoslaNrm.yaml stage 3 | 16.4.0 | +| 2022-06 | SA#96 | SP-220497 | 0047 | - | F | OpenAPI file name and dependence change for coslaNrm.yaml | 16.4.0 | +| 2022-06 | SA#96 | SP-220504 | 0051 | - | F | Minor correction on the format for cosla yaml file | 16.4.0 | +| 2022-06 | SA#96 | SP-220504 | 0053 | - | F | Correct attribute properties of assuranceTargetList | 16.4.0 | +| 2022-06 | SA#96 | | | | | CR implementation issues in Annex B.2.1 | 16.4.1 | +| 2023-09 | SA#101 | SP-230940 | 0060 | 1 | F | Rel-16 CR for TS28.536 Fix ambiguous description in SLS Assurance Procedure | 16.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28537/0b87abe67b21a93777287649c33e755d_img.jpg b/marked/Rel-16/28_series/28537/0b87abe67b21a93777287649c33e755d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..34bdb4fc426bcea810844821e3c51e071a6077e5 --- /dev/null +++ b/marked/Rel-16/28_series/28537/0b87abe67b21a93777287649c33e755d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc1476bd271e4e34df425141e260d1eb4ab90ca0fc9a77ae73d9c4c1427506d7 +size 75728 diff --git a/marked/Rel-16/28_series/28537/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/28_series/28537/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0862aaf64b06e1bc162f25f8953e61d4050c9d31 --- /dev/null +++ b/marked/Rel-16/28_series/28537/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:593f7b7bb50d3b49cafba066a110aafa3d62623b503194171b19673b9c6f1d2c +size 53703 diff --git a/marked/Rel-16/28_series/28537/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/28_series/28537/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ee3cc1620a7c23b31de9d0ad9d3e8385a1489e2 --- /dev/null +++ b/marked/Rel-16/28_series/28537/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a1151d04be5463a54a3dfb4cfee09f3ddb0524b9fe543949a004725242d702b +size 58755 diff --git a/marked/Rel-16/28_series/28537/raw.md b/marked/Rel-16/28_series/28537/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cb7f9518e5fb1fd7418450d54c097caf50c24454 --- /dev/null +++ b/marked/Rel-16/28_series/28537/raw.md @@ -0,0 +1,404 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +Foreword ..... 4 + +1 Scope..... 6 + +2 References..... 6 + +3 Definitions of terms, symbols and abbreviations..... 6 + +3.1 Terms..... 6 + +3.2 Symbols..... 6 + +3.3 Abbreviations ..... 6 + +4 Heartbeat..... 6 + +4.1 Overview ..... 6 + +4.2 Specification level requirements ..... 7 + +4.2.1 Use cases ..... 7 + +4.2.1.1 Configuring heartbeat notification periodicity ..... 7 + +4.2.1.2 Requesting immediate heartbeat notification ..... 7 + +4.2.1.3 Emitting periodic heartbeat notifications..... 8 + +4.2.2 Requirements..... 8 + +4.2.2.1 Requirements for controlling heartbeat ..... 8 + +4.2.2.2 Requirements for notifying heartbeat ..... 8 + +4.3 Procedures for heartbeat..... 8 + +4.3.1 Procedure for configuring heartbeat notification periodicity ..... 8 + +4.3.2 Procedure for requesting immediate heartbeat notification..... 9 + +4.3.3 Procedure for notifying periodic heartbeat notifications ..... 9 + +**Annex A (informative): Heartbeat PlantUML source code ..... 10** + +A.1 Procedure for configuring heartbeat notification periodicity..... 10 + +A.2 Procedure for requesting immediate heartbeat notification ..... 11 + +A.3 Procedure for notifying periodic heartbeat notifications ..... 11 + +Annex B (informative): Change history..... 13 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" shall not be used as substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies use cases, requirements and procedures for management capabilities of 5G networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 28.532: "Management and orchestration; Generic management services". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|-----|--------------------| +| MnS | Management Service | +|-----|--------------------| + +# --- 4 Heartbeat + +## 4.1 Overview + +The communication between Management Service (MnS) producers and MnS consumers shall be monitored, and communication link breaks between them shall be discovered by MnS consumers as early as possible. The behaviour of the MnS consumers, after detection of communication failure, is outside the scope of the present document. + +## 4.2 Specification level requirements + +### 4.2.1 Use cases + +#### 4.2.1.1 Configuring heartbeat notification periodicity + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To configure the periodicity at which the management service producer shall emit heartbeat notifications to its authorized management service consumer. | | +| <b>Actors and Roles</b> | An authorized consumer of the management service. | | +| <b>Telecom resources</b> | The management service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The periodicity requested by the management service consumer has a valid value. | | +| <b>Begins when</b> | The management service consumer sends a request to the management service producer to set the periodicity at which it shall emit heartbeat notifications. | | +| <b>Step 1</b> | The management service producer receives the request and sets its internal countdown timer to a value (which can be zero) equal to the periodicity requested by the management service consumer. | | +| <b>Step 2</b> | The management service producer sends a heartbeat notification to all authorized management service consumer(s), provided they previously subscribed to heartbeat notifications. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The notification periodicity has been configured according to the management service consumer request.<br>A heartbeat notification is sent out to all authorized management service consumer(s). | | +| <b>Traceability</b> | REQ-HB-CTRL-FUN-2. | | + +#### 4.2.1.2 Requesting immediate heartbeat notification + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To trigger the emission of an immediate heartbeat notification by the management service producer. | | +| <b>Actors and Roles</b> | An authorized consumer of the management service. | | +| <b>Telecom resources</b> | The management service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | N/A | | +| <b>Begins when</b> | The soliciting management service consumer sends a request to the management service producer to emit immediately a heartbeat notification. | | +| <b>Step 1</b> | The management service producer receives the request and sends immediately a heartbeat notification to all authorized management service consumer(s) who had previously subscribed to heartbeat notifications.<br>The management service producer count down timer is not impacted. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The immediate heartbeat notification has been emitted according to the soliciting management service consumer request. | | +| <b>Traceability</b> | REQ-HB-CTRL-FUN-3, REQ-HB-NOTIF-FUN-2. | | + +#### 4.2.1.3 Emitting periodic heartbeat notifications + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| <b>Goal</b> | To send periodic heartbeat notifications at the periodicity requested by the management service consumer. | | +| <b>Actors and Roles</b> | An authorized producer of the management service. | | +| <b>Telecom resources</b> | The management service consumer. | | +| <b>Assumptions</b> | The heartbeat notification periodicity has been configured according to the management service consumer request. | Configuring heartbeat notification periodicity | +| <b>Pre-conditions</b> | N/A | | +| <b>Begins when</b> | The internal countdown timer managed by the management service producer has reached the value 0. | | +| <b>Step 1</b> | The management service producer sends a heartbeat notification to all authorized management service consumer(s), provided they previously subscribed to heartbeat notifications.. | | +| <b>Step 2</b> | The management service producer resets its internal countdown timer to the value of the heartbeat notification periodicity. | Configuring heartbeat notification periodicity | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The periodic heartbeat notification has been emitted to all authorized management service consumer(s) at the requested periodicity. | | +| <b>Traceability</b> | REQ-HB-NOTIF-FUN-1. | | + +### 4.2.2 Requirements + +#### 4.2.2.1 Requirements for controlling heartbeat + +REQ-HB-CTRL-FUN-1: The management service provider shall have the capability to allow its authorized consumer to read the heartbeat period. + +REQ-HB-CTRL-FUN-2: The management service provider shall have the capability to allow its authorized consumer to set the heartbeat period. + +REQ-HB-CTRL-FUN-3: The management service provider shall have the capability to allow its authorized consumer to request the emission of an immediate heartbeat notification. + +#### 4.2.2.2 Requirements for notifying heartbeat + +REQ-HB-NOTIF-FUN-1: The management service provider shall have the capability to send periodic heartbeat notifications to its authorized consumer at the frequency specified by the management service consumer. + +REQ-HB-NOTIF-FUN-2: The management service provider shall have the capability to send immediate heartbeat notifications to its authorized consumer, upon request from the management service consumer. + +## 4.3 Procedures for heartbeat + +### 4.3.1 Procedure for configuring heartbeat notification periodicity + +Figure 4.3.1-1 illustrates the procedure for configuring the periodicity of heartbeat notifications using operations and notifications of the provisioning MnS (see clause 11.1.1 of [2]). + +![Sequence diagram for Figure 4.3.1-1: Procedure for configuring heartbeat notification periodicity. It shows an MnS Consumer sending a modifyMOIAttributes message to an MnS Provider, which updates an internal countdown timer and sends a notifyHeartbeat notification back to the consumer. A note indicates the consumer must have previously subscribed.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + actor MnS Consumer + participant MnS Provider + Note right of MnS Provider: Internal Countdown Timer := newHeartbeatPeriodValue + Note left of MnS Consumer: Provided he previously subscribed to heartbeat notifications + MnS Consumer->>MnS Provider: modifyMOIAttributes ('heartbeatNtfPeriod', newHeartbeatPeriodValue) + MnS Provider-->>MnS Consumer: notifyHeartbeat notification + Note right of MnS Provider: Start countdown immediately + +``` + +Sequence diagram for Figure 4.3.1-1: Procedure for configuring heartbeat notification periodicity. It shows an MnS Consumer sending a modifyMOIAttributes message to an MnS Provider, which updates an internal countdown timer and sends a notifyHeartbeat notification back to the consumer. A note indicates the consumer must have previously subscribed. + +Figure 4.3.1-1: Procedure for configuring heartbeat notification periodicity + +### 4.3.2 Procedure for requesting immediate heartbeat notification + +Figure 4.3.2-1 illustrates the procedure for requesting immediate heartbeat notification using operations and notifications of the provisioning MnS (see clause 11.1.1 of [2]). + +![Sequence diagram for Figure 4.3.2-1: Procedure for requesting immediate heartbeat notification. It shows an MnS Consumer sending a modifyMOIAttributes message with triggerHeartbeatNtf set to TRUE to an MnS Provider. The provider sends immediate heartbeat notifications to all subscribed consumers and sets the triggerHeartbeatNtf attribute to FALSE.](0b87abe67b21a93777287649c33e755d_img.jpg) + +``` + +sequenceDiagram + actor MnS Consumer + participant MnS Provider + participant Other MnS Consumers + Note right of MnS Provider: Send immediate heartbeat notification to all MnS Consumers who previously subscribed to heartbeat notifications + MnS Consumer->>MnS Provider: modifyMOIAttributes ('triggerHeartbeatNtf', TRUE) + MnS Provider-->>MnS Consumer: notifyHeartbeat notification + MnS Provider-->>Other MnS Consumers: notifyHeartbeat notification + Note right of MnS Provider: triggerHeartbeatNtf:= FALSE + +``` + +Sequence diagram for Figure 4.3.2-1: Procedure for requesting immediate heartbeat notification. It shows an MnS Consumer sending a modifyMOIAttributes message with triggerHeartbeatNtf set to TRUE to an MnS Provider. The provider sends immediate heartbeat notifications to all subscribed consumers and sets the triggerHeartbeatNtf attribute to FALSE. + +Figure 4.3.2-1: Procedure for requesting immediate heartbeat notification + +### 4.3.3 Procedure for notifying periodic heartbeat notifications + +Figure 4.3.3-1 illustrates the procedure for notifying periodic heartbeat notifications using operations and notifications of the provisioning MnS (see clause 11.1.1 of [2]). + +![UML Sequence diagram showing the procedure for notifying periodic heartbeat notifications. The diagram features two lifelines: 'MnS Provider' (actor) and 'MnS Consumers' (participant). The sequence of messages is: 1. MnS Provider sends a 'Send heartbeat notification to all MnS Consumers who previously subscribed to heartbeat notifications' message to MnS Consumers. 2. MnS Provider sends a 'notifyHeartbeat notification' message to MnS Consumers. 3. MnS Provider performs an internal action 'Reinitialize its internal countdown timer to the value of heartbeatNtfPeriod'. 4. MnS Provider performs an internal action 'Start countdown'.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + actor MnS Provider + participant MnS Consumers + Note left of MnS Provider: Send heartbeat notification to all MnS Consumers who previously subscribed to heartbeat notifications + MnS Provider->>MnS Consumers: notifyHeartbeat notification + Note left of MnS Provider: Reinitialize its internal countdown timer to the value of heartbeatNtfPeriod + Note left of MnS Provider: Start countdown + +``` + +UML Sequence diagram showing the procedure for notifying periodic heartbeat notifications. The diagram features two lifelines: 'MnS Provider' (actor) and 'MnS Consumers' (participant). The sequence of messages is: 1. MnS Provider sends a 'Send heartbeat notification to all MnS Consumers who previously subscribed to heartbeat notifications' message to MnS Consumers. 2. MnS Provider sends a 'notifyHeartbeat notification' message to MnS Consumers. 3. MnS Provider performs an internal action 'Reinitialize its internal countdown timer to the value of heartbeatNtfPeriod'. 4. MnS Provider performs an internal action 'Start countdown'. + +Figure 4.3.3-1: Procedure for notifying periodic heartbeat notifications + +# Annex A (informative): Heartbeat PlantUML source code + +## A.1 Procedure for configuring heartbeat notification periodicity + +The following PlantUML source code is used to describe the procedure for configuring heartbeat notification periodicity, as depicted by Figure 4.3.1-1: + +``` + +@startuml +title "Configuring heartbeat notification periodicity" + +actor "MnS Consumer" as CONS +participant "MnS Provider" as PROV +CONS -> PROV: modifyMOIAttributes ('heartbeatNtfPeriod', newHeartbeatPeriodValue) + +note over PROV + Internal Countdown Timer := newHeartbeatPeriodValue +endnote + +PROV -> CONS: notifyHeartbeat notification +note left + Provided he previously + subscribed to heartbeat + notifications +end note + +note over PROV + Start countdown immediately +endnote + +@enduml + +``` + +## --- A.2 Procedure for requesting immediate heartbeat notification + +The following PlantUML source code is used to describe the procedure for requesting immediate heartbeat notification, as depicted by Figure 4.3.2-1: + +``` +@startuml + +title "Requesting immediate heartbeat notification" + +actor "MnS Consumer" as CONS +participant "MnS Provider" as PROV +collections "Other MnS Consumers" as OTHER +CONS -> PROV: modifyMOIAttributes ('triggerHeartbeatNtf', TRUE) + +rnote over PROV +Send immediate heartbeat notification +to all MnS Consumers who previously +subscribed to heartbeat notifications +endrnote + +PROV -> CONS: notifyHeartbeat notification +PROV -> OTHER: notifyHeartbeat notification + +rnote over PROV +triggerHeartbeatNtf:= FALSE +endrnote + +@enduml +``` + +## --- A.3 Procedure for notifying periodic heartbeat notifications + +The following PlantUML source code is used to describe the procedure for notifying periodic heartbeat notifications, as depicted by Figure 4.3.3-1: + +``` +@startuml + +title "Notifying periodic heartbeat notifications" + +actor "MnS Provider" as PROV +collections "MnS Consumers" as CONS + +rnote over PROV +Send heartbeat notification to all +MnS Consumers who previously +subscribed to heartbeat notifications +endrnote + +PROV -> CONS: notifyHeartbeat notification + +rnote over PROV +Reinitialize its internal countdown +timer to the value of heartbeatNtfPeriod +endrnote + +rnote over PROV +Start countdown +endrnote + +@enduml +``` + + + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|----|-----|-----|------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-02 | SA5#129-e | S5-201108 | | | | First draft, including EditHelp comments | 0.1.0 | +| 2020-03 | SA#87-e | SP-200197 | | | | Presented for approval | 1.0.0 | +| 2020-03 | SA#87-e | | | | | Upgrade to changecontrol version | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28540/raw.md b/marked/Rel-16/28_series/28540/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..dd3a7d90f34d28821468ba43c3d1aec879fb29eb --- /dev/null +++ b/marked/Rel-16/28_series/28540/raw.md @@ -0,0 +1,280 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Concepts and background ..... | 6 | +| 4.1 NR and NG-RAN deployment scenarios ..... | 6 | +| 4.2 MR-DC..... | 6 | +| 4.3 5GC architecture ..... | 7 | +| 4.4 Data storage architecture..... | 7 | +| 4.5 AMF load balancing insides AMF Region/AMF Set..... | 7 | +| 4.6 5GC NFs supporting edge computing..... | 7 | +| 4.7 General information for network slice instance and network slice subnet instance ..... | 7 | +| 4.8 Remote Interference Management ..... | 7 | +| 5 Requirements ..... | 7 | +| 5.1 Requirements for management of NG-RAN..... | 7 | +| 5.2 Requirements for management of MR-DC ..... | 8 | +| 5.3 Requirements for management of 5GC NFs ..... | 8 | +| 5.4 Requirements for management of AMF Set ..... | 9 | +| 5.5 Requirements for management of edge computing..... | 9 | +| 5.6 Requirements for management of network slice and network slice subnet ..... | 9 | +| 5.7 Requirements Remote Interference Management..... | 9 | +| Annex A (informative): Change history..... | 10 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects Management and orchestration of networks, as identified below: + +**TS 28.540: Management and orchestration of 5G networks; Network Resource Model (NRM); Stage 1.** + +TS 28.541: Management and orchestration of 5G networks; Network Resource Model (NRM); Stage 2 and stage 3. + +# --- 1 Scope + +The present document specifies the requirements for the Network Resource Model (NRM) definition of NR, NG-RAN, 5G Core Network (5GC) and network slice, to support the management for: + +- variety of 5G radio access network functions and features, covering management for NR connectivity options defined in 3GPP TS 37.340 [5] and NG-RAN architectural options defined in 3GPP TS 38.401 [4]. +- variety of 5GC network functions and features defined in 3GPP TS 23.501 [2]. +- network slice and network slice subnet. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System". +- [3] 3GPP TS 38.300: "NR; Overall description; Stage-2". +- [4] 3GPP TS 38.401: "NG-RAN; Architecture description". +- [5] 3GPP TS 37.340: "NR; Multi-connectivity; Overall description; Stage 2". +- [6] 3GPP TS 28.531: "Management and orchestration of 5G networks; Provisioning". +- [7] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [8] GSMA NG.116 – "Generic Network Slice Template" v1.0 (2019-05-23). + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**5G Core Network:** Defined in 3GPP TS 23.501 [2]. + +**AMF Region:** Defined in 3GPP TS 23.501 [2]. + +**AMF Set:** Defined in 3GPP TS 23.501 [2]. + +**en-gNB:** Defined in 3GPP TS 37.340 [5]. + +**gNB:** Defined in 3GPP TS 38.300 [3]. + +**gNB Central Unit (gNB-CU):** Defined in 3GPP TS 38.401 [4]. + +**gNB-CU-Control Plane (gNB-CU-CP):** Defined in 3GPP TS 38.401 [4]. + +**gNB-CU-User Plane (gNB-CU-UP):** Defined in 3GPP TS 38.401 [4]. + +**gNB Distributed Unit (gNB-DU):** Defined in 3GPP TS 38.401 [4]. + +**ng-eNB:** Defined in 3GPP TS 38.300 [3]. + +**NG-RAN:** Defined in 3GPP TS 23.501 [2]. + +## 3.2 Abbreviations + +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]. + +| | | +|--------|-----------------------------------------| +| 5GC | 5G Core network | +| 5GS | 5G System | +| AMF | Access and Mobility Management Function | +| EN-DC | E-UTRA-NR Dual Connectivity | +| EPS | Evolved Packet System | +| MR-DC | Multi-RAT Dual Connectivity | +| NG-RAN | NG Radio Access Network | +| NR | New Radio | +| PCF | Policy Control Function | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | +| UDSF | Unstructured Data Storage Function | + +# --- 4 Concepts and background + +## 4.1 NR and NG-RAN deployment scenarios + +According to NG-RAN architecture defined in 3GPP TS 38.300 [3], An NG-RAN node is either a gNB or an ng-eNB connected to 5GC. + +A gNB may consist of a gNB-CU and one or more gNB-DU(s), and a gNB-CU may consist of a gNB-CU-CP and one or more gNB-CU-UP. From functional split point of view, there have following gNB deployment scenarios which are specified in 3GPP TS 38.401 [4]: + +- 1) gNB which does not consist split function. +- 2) gNB which consists of gNB-CU and gNB-DU(s). +- 3) gNB which consists of gNB-CU-CP, gNB-CU-UP(s) and gNB-DU(s). + +Abovementioned deployment scenarios apply to en-gNB also. + +Part of gNB (e.g. gNB-CU) can be deployed as virtualized network function. + +## 4.2 MR-DC + +Besides single connectivity operation, E-UTRAN, NR and NG-RAN support Multi-RAT Dual Connectivity (MR-DC) operation defined in 3GPP TS 37.340 [5], which can be further divided into following two categories based on connected core network types. + +- 1) MR-DC with the EPC via EN-DC, the NR node in EN-DC is called en-gNB. +- 2) MR-DC with the 5GC via either NG-RAN E-UTRA-NR Dual Connectivity (NGEN-DC) or NR-E-UTRA Dual Connectivity (NE-DC). + +There are different user plane connectivity options of the master node and secondary node involved in MR-DC (see detail in 3GPP TS 37.340 [5]). + +## 4.3 5GC architecture + +The 5G architecture is defined as service-based and the interaction between network functions is represented in the following two ways: + +- Service-based representation +- Reference point representation + +The network functions composed 5GC is specified in 3GPP TS 23.501 [2], network functions within the 5GC control plane shall only use service-based interfaces for their interactions. + +## 4.4 Data storage architecture + +5G system architecture allows UDM, PCF and NEF to store their data in the Unified Data Repository (UDR), and allows any NF to store and retrieve its unstructured data (e.g. UE context) into/from a UDSF. + +## 4.5 AMF load balancing insides AMF Region/AMF Set + +When deploying AMF Region or AMF Set, AMF load balancing insides AMF Region/AMF Set is achieved by setting a weight factor for each AMF according to its relative capacity compared to other AMFs, see detail in clause 5.19.3 of 3GPP TS 23.501 [2]. + +## 4.6 5GC NFs supporting edge computing + +Edge computing enables operator and 3rd party services to be hosted close to the UE's access point of attachment, so as to achieve an efficient service delivery through the reduced end-to-end latency and load on the transport network, see details in clause 5.13 of 3GPP TS 23.501 [2]. + +## 4.7 General information for network slice instance and network slice subnet instance + +The general information used to describe network slice instance and network slice subnet instance are specified in TS 28.531 [6]. + +## 4.8 Remote Interference Management + +A remote interference scenario may involve a number of victim and aggressor cells, where the gNBs execute Remote Interference Management (RIM) coordination on behalf of their respective cells. Aggressor and victim gNBs or cells can be grouped into semi-static sets, where each cell is assigned a set ID, and is configured with a RIM Reference Signal (RIM-RS) and the radio resources associated with the set ID. As defined in 3GPP TS 38.300 [3]. + +# --- 5 Requirements + +## 5.1 Requirements for management of NG-RAN + +The following specific requirements apply to NG-RAN: + +**REQ-NGRAN\_NRM-CON-001:** The NRM definitions shall support management of NG-RAN, containing gNB or/and ng-eNB. + +**REQ-NGRAN\_NRM-CON-002:** The NRM definitions shall support management of either gNB without split function or gNB with split functions defined in 3GPP TS 38.401 [4]. + +**REQ-NGRAN\_NRM-CON-003:** The NRM definitions shall support management of virtualized network functions that are part of gNB, e.g. virtualized gNB-CU. + +**REQ-NGRAN\_NRM-CON-004:** The NRM definitions shall support management of intra-NG-RAN handover between any combinations of gNB and ng-eNB. + +**REQ-NGRAN\_NRM-CON-005:** The NRM definitions shall support management of inter-system handover between 5GS and EPS. + +**REQ-NGRAN\_NRM-CON-006:** The NRM definitions shall support management of network slicing feature in NG-RAN. + +**REQ-NGRAN\_NRM-CON-007:** The NRM definitions shall have a read-only representation of NR beam properties in NG-RAN. + +**REQ-NGRAN\_NRM-CON-008:** The NRM definitions shall support configuration of sector carrier coverage properties in NG-RAN. + +## 5.2 Requirements for management of MR-DC + +The following specific requirements apply to MR-DC management, including management of NR in EN-DC and other MR-DC operations. + +**REQ-MRDC\_NRM-CON-001:** The NRM definitions shall support management of NR node in EN-DC operation (en-gNB). + +**REQ-MRDC\_NRM-CON-002:** The NRM definitions shall support management of en-gNB with different user plane connectivity options defined in 3GPP TS 37.340 [5]. + +**REQ-MRDC\_NRM-CON-003:** The NRM definitions shall support management of NG-RAN nodes in NGEN-DC operation. + +**REQ-MRDC\_NRM-CON-004:** The NRM definitions shall support management different user plane connectivity options in NGEN-DC operation defined in 3GPP TS 37.340 [5]. + +**REQ-MRDC\_NRM-CON-005:** The NRM definitions shall support management of NG-RAN nodes in EN-DC operation. + +**REQ-MRDC\_NRM-CON-006:** The NRM definitions shall support management different user plane connectivity options in NE-DC operation defined in 3GPP TS 37.340 [5]. + +## 5.3 Requirements for management of 5GC NFs + +The following specific requirements apply to management of 5GC NFs: + +**REQ-5GC\_NRM-CON-001:** The NRM definitions shall support management of 5GC containing variety of network functions defined in 3GPP TS 23.501 [2]. + +**REQ-5GC\_NRM-CON-002:** The NRM definitions should support management of all the relationships between network functions and corresponding data storage functions where the network functions store/retrieve their data. + +**REQ-5GC\_NRM-CON-003:** The NRM definitions shall support management of interworking between 5GC and EPC. + +**REQ-5GC\_NRM-CON-004:** The NRM definitions shall support management of network slicing feature in 5GC. + +**REQ-5GC\_NRM-CON-005:** The NRM definitions shall support management of 5GC network function services independently to align with requirements of 3GPP TS 23.501 [2]. + +**REQ-5GC\_NRM-CON-006:** The NRM definitions shall support NF service instance registration, deregistration, update, etc., with NRF during NF service instance lifecycle to align with requirements of 3GPP TS 23.501 [2] and 3GPP TS 23.502 [x]. + +**REQ-5GC\_NRM-CON-007:** The NRM definitions shall support configuration of NF profile for NF Service registration and discovery to align with requirements of 3GPP TS 23.501 [2] and 3GPP TS 23.502 [7]. + +## 5.4 Requirements for management of AMF Set + +**REQ-AMFSET\_NRM-CON-001:** The NRM definitions shall support management of AMF Region and AMF Set, including AMF load balancing management. + +## 5.5 Requirements for management of edge computing + +**REQ-ECM\_NRM-CON-001** The NRM definitions shall support management of 5GC NFs supporting edge computing. + +## 5.6 Requirements for management of network slice and network slice subnet + +The following requirements apply to network slice and network slice subnet: + +**REQ-NS\_NRM-CON-001:** The NRM definitions shall support management of network slice. + +**REQ-NS\_NRM-CON-002:** The NRM definitions shall support management of network slice subnet. + +**REQ-NS\_NRM-CON-003:** The NRM definitions shall support the attributes of the Generic network Slice Template (GST) defined by GSMA [8]. + +## 5.7 Requirements Remote Interference Management + +**REQ-NGRAN\_NRM-CON-001:** The NRM definitions should support Remote Interference Management. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-12 | SA#82 | SP-181046 | 0001 | 2 | C | Support read-only representation of NR beam properties in NG-RAN NRM definitions | 15.1.0 | +| 2019-06 | SA#84 | SP-190373 | 0002 | 1 | B | Update NRM requirement to support SBA management | 16.0.0 | +| 2019-12 | SA#86 | SP-191166 | 0003 | 2 | B | Add OAM support for RIM parameters | 16.1.0 | +| 2019-12 | SA#86 | SP-191170 | 0004 | 1 | C | Add GSMA GST mapping related requirements | 16.1.0 | +| 2019-12 | SA#86 | SP-191166 | 0007 | 1 | B | Add requirement on NR sector carrier coverage configuration | 16.1.0 | +| 2020-03 | SA#87E | SP-200169 | 0009 | - | F | Correction of requirement number | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28545/raw.md b/marked/Rel-16/28_series/28545/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..eb75738f7ea1a3f86ffcb17eb8faa4050795cc5c --- /dev/null +++ b/marked/Rel-16/28_series/28545/raw.md @@ -0,0 +1,819 @@ + + + + +. + +. + +# Contents + +| | | +|-----------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 General..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.1.1 Alarm related services ..... | 7 | +| 5 Specification level requirements..... | 7 | +| 5.1 Use cases ..... | 7 | +| 5.1.1 Report alarm notifications of NSI ..... | 7 | +| 5.1.2 Subscription of alarm notifications of NSI..... | 8 | +| 5.1.3 Unsubscription of alarm notifications of NSI ..... | 8 | +| 5.1.4 Get alarm list of NSI..... | 9 | +| 5.1.5 Acknowledge alarms of NSI ..... | 9 | +| 5.1.6 Clear alarms of NSI..... | 10 | +| 5.1.7 Report alarm notifications of NSSI ..... | 10 | +| 5.1.8 Subscription of alarm notifications of NSSI ..... | 11 | +| 5.1.9 Unsubscription of alarm notifications of NSSI ..... | 11 | +| 5.1.10 Get alarm list of NSSI ..... | 12 | +| 5.1.11 Acknowledge alarms of NSSI ..... | 12 | +| 5.1.12 Clear alarms of NSSI..... | 13 | +| 5.1.13 Report alarm notifications of NF instance..... | 13 | +| 5.1.14 Subscription of alarm notifications of NF instance ..... | 14 | +| 5.1.15 Unsubscription of alarm notifications of NF instance..... | 14 | +| 5.1.16 Get alarm list of NF instance..... | 15 | +| 5.1.17 Acknowledge alarms of NF instance..... | 15 | +| 5.1.18 Clear alarms of NF instance ..... | 16 | +| 5.1.19 Notify changed alarms of NSI..... | 16 | +| 5.1.20 Notify changed alarms of NSSI..... | 17 | +| 5.1.21 Notify changed alarms of NF instance ..... | 17 | +| 5.1.22 Notify cleared alarms of NSI..... | 18 | +| 5.1.23 Notify cleared alarms of NSSI ..... | 18 | +| 5.1.24 Notify cleared alarms of NF instance..... | 19 | +| 5.1.25 Notify acknowledgement state change of NSI alarms..... | 19 | +| 5.1.26 Notify acknowledgement state change of NSSI alarms ..... | 20 | +| 5.1.27 Notify acknowledgement state change of NF instance alarms..... | 20 | +| 5.2 Requirements..... | 20 | +| 5.2.1 Requirements for fault supervision data report service for NSI..... | 20 | +| 5.2.2 Requirements for fault supervision data control service for NSI..... | 21 | +| 5.2.3 Requirements for fault supervision data report service for NSSI..... | 21 | +| 5.2.4 Requirements for fault supervision data control service for NSSI..... | 22 | +| 5.2.5 Requirements for fault supervision data report service for NF ..... | 22 | +| 5.2.6 Requirements for fault supervision data control service for NF ..... | 22 | +| 6 Fault Supervision management services components..... | 23 | +| 6.1 Management services for network slice fault supervision ..... | 23 | +| 6.2 Management services for network slice subnet fault supervision..... | 23 | +| 6.3 Management services for network function fault supervision ..... | 24 | +| 6.4 Management Service components used for configurable FM control ..... | 24 | +| 7 Alarm loss detection..... | 25 | +| 8 Virtualized resource alarm correlation..... | 26 | + +9 Procedures for fault supervision management services..... 26 +9.1 Alarm subscription and notification..... 26 +Annex A (informative): Change history..... 28 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3rd Generation Partnership Project Technical Specification Group Services and System Aspects Management and orchestration of networks, as identified below: + +TS 28.545: Management and orchestration; Fault Supervision (FS) + +# --- 1 Scope + +The present document specifies use cases and requirements for fault supervision of 5G networks and network slicing. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.532: "Management and orchestration; Management services". +- [3] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [4] 3GPP TS 28.516: "Fault Management (FM) for mobile networks that include virtualized network functions; Procedure". +- [5] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|------|----------------------------------------| +| FS | Fault Supervision | +| ME | Managed Element | +| MnS | Management Service | +| NSI | Network Slice Instance | +| NSSI | Network Slice Subnet Instance | +| VNF | Virtualized Network Function | +| VNFC | Virtualized Network Function Component | + +# 4 General + +## 4.1 Overview + +### 4.1.1 Alarm related services + +The following management services are needed for fault supervision: + +**Table 4.1.1: Management services for fault supervision** + +| Management Service | Description | +|-------------------------------------------------|------------------------------------------------------------| +| Fault supervision data report service for NSI | To support the consumer to get NSI alarm data. | +| Fault supervision data control service for NSI | To support the consumer to control NSI alarm data. | +| Fault supervision data report service for NSSI | To support the consumer to get NSSI alarm data. | +| Fault supervision data control service for NSSI | To support the consumer to control NSSI alarm data. | +| Fault supervision data report service for NF | To support the consumer to get NF instance alarm data. | +| Fault supervision data control service for NF | To support the consumer to control NF instance alarm data. | + +# 5 Specification level requirements + +## 5.1 Use cases + +### 5.1.1 Report alarm notifications of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To report NSI alarm notifications. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSI is deployed<br>An authorized consumer has subscribed the alarm notifications of an NSI<br>The producer of fault supervision data report service for NSI has subscribed the alarm notifications of the NSI constituents. | | +| <b>Begins when</b> | A failure or severe performance degradation of NSI is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data report service for NSI collects alarm information of NSSIs and/or NF instances associated with the NSI as well as other information if needed. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSI sends the alarm notification to its authorized consumer when a new alarm notification is generated and this alarm notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the alarm notification of the NSI or the authorized consumer unsubscribes the alarm notifications of the NSI or the NSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the alarm notification of the NSI | | +| <b>Traceability</b> | REQ-FSDR_NSI-FUN-1, REQ-FSDR_NSI-FUN-4, REQ-FSDR_NSI-FUN-9 | | + +### 5.1.2 Subscription of alarm notifications of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To subscribe NSI alarm notifications | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSI is deployed | | +| <b>Begins when</b> | An authorized consumer wants to subscribe the alarm notifications of an NSI | | +| <b>Step 1 (M)</b> | The authorized consumer sends request to the producer of fault supervision data report service for NSI to subscribe alarm notifications of an NSI. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSI sends the response of the completion of the subscription to the authorized consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The alarm notifications of an NSI have been subscribed by the authorized consumer. | | +| <b>Traceability</b> | REQ-FSDR_NSI-FUN-2 | | + +### 5.1.3 Unsubscription of alarm notifications of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To unsubscribe NSI alarm notifications | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSI is deployed<br>An authorized consumer has subscribed the alarm notifications of an NSI from a producer of fault supervision data report service for NSI. | | +| <b>Begins when</b> | The authorized consumer wants to unsubscribe the alarm notifications of an NSI. | | +| <b>Step 1 (M)</b> | The authorized consumer sends request to the producer of fault supervision data report service for NSI to unsubscribe alarm notifications of an NSI. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSI sends the response of the completion of the unsubscription to the authorized consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The alarm notifications of the NSI has been unsubscribed by the authorized consumer. | | +| <b>Traceability</b> | REQ-FSDR_NSI-FUN-3 | | + +### 5.1.4 Get alarm list of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To get alarm list of NSI. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data report service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSI has been deployed.<br>The producer of the fault supervision data report service for NSI is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to get the alarm list of an NSI. | | +| <b>Step 1 (M)</b> | The authorized consumer requires the producer of the fault supervision data report service for NSI to report the alarm list of the NSI. | | +| <b>Step 2 (M)</b> | The Producer of the fault supervision data report service for NSI sends the alarm list to the the authorized consumer. The alarm list contains the alarm(s) which satisfy the filter condition if exists. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The authorized consumer has got the alarm list of the NSI. | | +| <b>Traceability</b> | REQ-FSDR_NSI-FUN-5, REQ-FSDR_NSI-FUN-6 | | + +### 5.1.5 Acknowledge alarms of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To acknowledge one or multiple alarms of NSI. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data control service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSI has been deployed.<br>The producer of the fault supervision data control service for NSI is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to acknowledge one or multiple alarms of an NSI. | | +| <b>Step 1 (M)</b> | The authorized consumer sends the request to the producer of the fault supervision data control service for NSI to acknowledge one or multiple alarms of the NSI. | | +| <b>Step 2 (M)</b> | The producer of the fault supervision data control service for NSI acknowledges the alarms based on the request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The alarms of the NSI have been acknowledged. | | +| <b>Traceability</b> | REQ-FSDC_NSI-FUN-1 | | + +### 5.1.6 Clear alarms of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To clear one or multiple alarms of NSI. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data control service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSI has been deployed.<br>The producer of the fault supervision data control service for NSI is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to clear one or multiple alarms of an NSI. | | +| <b>Step 1 (M)</b> | The authorized consumer sends the request to the producer of the fault supervision data control service for NSI to clear one or multiple alarms of the NSI. | | +| <b>Step 2 (M)</b> | The producer of the fault supervision data control service for NSI clears the alarms based on the request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The alarms of the NSI have been cleared. | | +| <b>Traceability</b> | REQ-FSDC_NSI-FUN-2 | | + +### 5.1.7 Report alarm notifications of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To report NSSI alarm notifications. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSSI is deployed<br>An authorized consumer has subscribed the alarm notifications of an NSSI.<br>The producer of fault supervision data report service for NSSI has subscribed the alarm notifications of NSSI constituents. | | +| <b>Begins when</b> | A failure or severe performance degradation of NSSI is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data report service for NSSI collects alarm information of constituent NSSIs and/or NF instances associated with the NSSI as well as other information if needed. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSSI sends the alarm notification to its authorized consumer when a new alarm notification is generated and this alarm notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | An authorized consumer receives the alarm notification of an NSSI or the authorized consumer unsubscribes the alarm notifications of the NSSI or the NSSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The authorized consumer receives the alarm notification of the NSSI | | +| <b>Traceability</b> | REQ-FSDR_NSSI-FUN-1, REQ-FSDR_NSSI-FUN-4, REQ-FSDR_NSSI-FUN-9 | | + +### 5.1.8 Subscription of alarm notifications of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To subscribe NSSI alarm notifications | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSSI is deployed | | +| <b>Begins when</b> | An authorized consumer wants to subscribe the alarm notifications of an NSSI | | +| <b>Step 1 (M)</b> | The authorized consumer sends request to the producer of fault supervision data report service for NSSI to subscribe alarm notifications of an NSSI. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSSI sends the response of the completion of the subscription to the authorized consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The alarm notifications of an NSSI have been subscribed by the authorized consumer. | | +| <b>Traceability</b> | REQ-FSDR_NSSI-FUN-2 | | + +### 5.1.9 Unsubscription of alarm notifications of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To unsubscribe NSSI alarm notifications | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSSI is deployed<br>An authorized consumer has subscribed the alarm notifications of an NSSI from the producer of fault supervision data report service for NSSI. | | +| <b>Begins when</b> | An authorized consumer wants to unsubscribe the alarm notifications of an NSSI. | | +| <b>Step 1 (M)</b> | The authorized consumer sends request to the producer of fault supervision data report service for NSSI to unsubscribe alarm notifications of an NSSI. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSSI sends the response of the completion of the unsubscription to the authorized consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The alarm notifications of the NSSI has been unsubscribed by the authorized consumer. | | +| <b>Traceability</b> | REQ-FSDR_NSSI-FUN-3 | | + +### 5.1.10 Get alarm list of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To get alarm list of NSSI. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data report service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instances | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSSI has been deployed.<br>The producer of the fault supervision data report service for NSSI is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to get the alarm list of an NSSI. | | +| <b>Step 1 (M)</b> | The authorized consumer requires the producer of the fault supervision data report service for NSSI to report the alarm list of the NSSI. | | +| <b>Step 2 (M)</b> | The producer of the fault supervision data report service for NSSI sends the alarm list to the the authorized consumer. The alarm list contains the alarm(s) which satisfy the filter condition if exists. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The authorized consumer has got the alarm list of the NSSI. | | +| <b>Traceability</b> | REQ-FSDR_NSSI-FUN-5, REQ-FSDR_NSSI-FUN-6 | | + +### 5.1.11 Acknowledge alarms of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To acknowledge one or multiple alarms of NSSI. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data control service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSSI has been deployed.<br>The producer of the fault supervision data control service for NSSI is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to acknowledge one or multiple alarms of an NSSI. | | +| <b>Step 1 (M)</b> | The authorized consumer sends the request to the producer of the fault supervision data control service for NSSI to acknowledge one or multiple alarms of the NSSI. | | +| <b>Step 2 (M)</b> | The producer of the fault supervision data control service for NSSI acknowledges the alarms based on the request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The alarms of the NSSI have been acknowledged. | | +| <b>Traceability</b> | REQ-FSDC_NSSI-FUN-1 | | + +### 5.1.12 Clear alarms of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To clear one or multiple alarms of NSSI. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data control service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSSI has been deployed.<br>The producer of the fault supervision data control service for NSSI is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to clear one or multiple alarms of an NSSI. | | +| <b>Step 1 (M)</b> | The authorized consumer sends the request to the producer of the fault supervision data control service for NSSI to clear one or multiple alarms of the NSSI. | | +| <b>Step 2 (M)</b> | The procedure of the fault supervision data control service for NSSI clears the alarms based on the request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The alarms of the NSSI have been cleared. | | +| <b>Traceability</b> | REQ-FSDC_NSSI-FUN-2 | | + +### 5.1.13 Report alarm notifications of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To report NF instance alarm notifications. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NF is deployed<br>An authorized consumer has subscribed the alarm notifications of an NF instance. | | +| <b>Begins when</b> | A failure or severe performance degradation of NF instance is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data report service for NF sends the alarm notification to its authorized consumer when a new alarm notification is generated and this alarm notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | An authorized consumer receives the alarm notification of the NF instance or the authorized consumer unsubscribes the alarm notifications of the NF instance or the NF instance is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The authorized consumer receives the alarm notification of the NF instance | | +| <b>Traceability</b> | REQ-FSDR_NF-FUN-1, REQ-FSDR_NF-FUN-5, REQ-FSDR_NF-FUN-11 | | + +### 5.1.14 Subscription of alarm notifications of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To subscribe NF instance alarm notifications | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NF is deployed | | +| <b>Begins when</b> | An authorized consumer wants to subscribe the alarm notifications of an NF instance | | +| <b>Step 1 (M)</b> | The authorized consumer sends request to producer of fault supervision data report service for NF to subscribe alarm notifications of an NF instance. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NF sends the response of the completion of the subscription to the authorized consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The alarm notifications of an NF instance have been subscribed by the authorized consumer. | | +| <b>Traceability</b> | REQ-FSDR_NF-FUN-3 | | + +### 5.1.15 Unsubscription of alarm notifications of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To unsubscribe NF instance alarm notifications | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NF is deployed<br>An authorized consumer has subscribed the alarm notifications of an NF instance from a producer of fault supervision data report service for NF. | | +| <b>Begins when</b> | An authorized consumer wants to unsubscribe the alarm notifications of an NF instance. | | +| <b>Step 1 (M)</b> | The authorized consumer sends request to the producer of fault supervision data report service for NF to unsubscribe alarm notifications of an NF instance. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NF sends the response of the completion of the unsubscription to the authorized consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails. | | +| <b>Post-conditions</b> | The alarm notifications of the NF instance has been unsubscribed by the authorized consumer. | | +| <b>Traceability</b> | REQ-FSDR_NF-FUN-4 | | + +### 5.1.16 Get alarm list of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To get alarm list of NF instance. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data report service for NF. | | +| <b>Telecom resources</b> | Network function instances | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NF instance has been deployed.<br>The producer of the fault supervision data report service for NF is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to get the alarm list of an NF instance. | | +| <b>Step 1 (M)</b> | The authorized consumer requires the producer of the fault supervision data report service for NF to report the alarm list of the NF instance. | | +| <b>Step 2 (M)</b> | The producer of the fault supervision data report service for NF sends the alarm list to the the authorized consumer. The alarm list contains the alarm(s) which satisfy the filter condition if exists. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The authorized consumer has got the alarm list of the NF. | | +| <b>Traceability</b> | REQ-FSDR_NF-FUN-6, REQ-FSDR_NF-FUN-8 | | + +### 5.1.17 Acknowledge alarms of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To acknowledge one or multiple alarms of NF instance. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data control service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NF instance has been deployed.<br>The producer of the fault supervision data control service for NF is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to acknowledge one or multiple alarms of an NF instance. | | +| <b>Step 1 (M)</b> | The authorized consumer sends the request to the producer of the fault supervision data control service for NF to acknowledge one or multiple alarms of the NF instance. | | +| <b>Step 2 (M)</b> | The producer of the fault supervision data control service for NF acknowledges the alarms based on the request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The alarms of the NF instance have been acknowledged. | | +| <b>Traceability</b> | REQ-FSDC_NF-FUN-1 | | + +### 5.1.18 Clear alarms of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To clear one or multiple alarms of NF instance. | | +| <b>Actors and Roles</b> | An authorized consumer of the fault supervision data control service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NF instance has been deployed.<br>The producer of the fault supervision data control service for NF is in operation. | | +| <b>Begins when</b> | The authorized consumer decides to clear one or multiple alarms of an NF instance. | | +| <b>Step 1 (M)</b> | The authorized consumer sends the request to the producer of the fault supervision data control service for NF to clear one or multiple alarms of the NF instance. | | +| <b>Step 2 (M)</b> | The procedure of the fault supervision data control service for NF clears the alarms based on the request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The alarms of the NF instance have been cleared. | | +| <b>Traceability</b> | REQ-FSDC_NF-FUN-2 | | + +### 5.1.19 Notify changed alarms of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify changed alarms of NSI. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSI is deployed<br>An authorized consumer has subscribed the notifications of an NSI. | | +| <b>Begins when</b> | A change of <code>perceivedSeverity</code> attribute value (except to the value "Cleared") in <code>AlarmInformation</code> in <code>AlarmList</code> of NSI is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data report service for NSI generates a changed alarm notification. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSI sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the changed alarm notification of the NSI or the authorized consumer unsubscribes the notifications of the NSI or the NSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the changed alarm notification of the NSI | | +| <b>Traceability</b> | REQ-FSDR_NSI-FUN-7 | | + +### 5.1.20 Notify changed alarms of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify changed alarms of NSSI. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSSI is deployed<br>An authorized consumer has subscribed the notifications of an NSSI. | | +| <b>Begins when</b> | A change of <code>perceivedSeverity</code> attribute value (except to the value "Cleared") in <code>AlarmInformation</code> in <code>AlarmList</code> of NSSI is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data report service for NSSI generates a changed alarm notification. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NSSI sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the changed alarm notification of the NSSI or the authorized consumer unsubscribes the notifications of the NSSI or the NSSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the changed alarm notification of the NSSI | | +| <b>Traceability</b> | REQ-FSDR_NSSI-FUN-7 | | + +### 5.1.21 Notify changed alarms of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify changed alarms of NF instance. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data report service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NF instance is deployed<br>An authorized consumer has subscribed the notifications of an NF instance. | | +| <b>Begins when</b> | A change of <code>perceivedSeverity</code> attribute value (except to the value "Cleared") in <code>AlarmInformation</code> in <code>AlarmList</code> of NF instance is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data report service for NF generates a changed alarm notification of the NF instance. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data report service for NF sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the changed alarm notification of the NF instance or the authorized consumer unsubscribes the notifications of the NF instance or the NF instance is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the changed alarm notification of the NF instance | | +| <b>Traceability</b> | REQ-FSDR_NF-FUN-9 | | + +### 5.1.22 Notify cleared alarms of NSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify cleared alarms of NSI. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data control service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSI is deployed<br>An authorized consumer has subscribed the notifications of an NSI. | | +| <b>Begins when</b> | An alarm clearing of the NSI is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data control service for NSI generates a cleared alarm notification. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data control service for NSI sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the cleared alarm notification of the NSI or the authorized consumer unsubscribes the notifications of the NSI or the NSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the cleared alarm notification of the NSI | | +| <b>Traceability</b> | REQ-FSDR_NSI-FUN-8 | | + +### 5.1.23 Notify cleared alarms of NSSI + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify cleared alarms of NSSI. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data control service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSSI is deployed<br>An authorized consumer has subscribed the notifications of an NSSI. | | +| <b>Begins when</b> | An alarm clearing of the NSSI is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data control service for NSSI generates a cleared alarm notification. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data control service for NSSI sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the cleared alarm notification of the NSSI or the authorized consumer unsubscribes the notifications of the NSSI or the NSSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the cleared alarm notification of the NSSI | | +| <b>Traceability</b> | REQ-FSDR_NSSI-FUN-8 | | + +### 5.1.24 Notify cleared alarms of NF instance + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify cleared alarms of NF instance. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data control service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NF instance is deployed<br>An authorized consumer has subscribed the notifications of an NF instance. | | +| <b>Begins when</b> | An alarm clearing of NF instance is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data control service for NF generates a cleared alarm notification of the NF instance. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data control service for NF sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the cleared alarm notification of the NF instance or the authorized consumer unsubscribes the notifications of the NF instance or the NF instance is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the cleared alarm notification of the NF instance | | +| <b>Traceability</b> | REQ-FSDR_NF-FUN-10 | | + +### 5.1.25 Notify acknowledgement state change of NSI alarms + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify acknowledgement state change of NSI alarms. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data control service for NSI. | | +| <b>Telecom resources</b> | Network slice instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSI is deployed<br>An authorized consumer has subscribed the notifications of an NSI. | | +| <b>Begins when</b> | An acknowledgement state change of the NSI alarms is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data control service for NSI generates an acknowledgement state change notification. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data control service for NSI sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the acknowledgement state change notification of the NSI or the authorized consumer unsubscribes the notifications of the NSI or the NSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the acknowledgement state change notification of the NSI | | +| <b>Traceability</b> | REQ-FSDC_NSI-FUN-4 | | + +### 5.1.26 Notify acknowledgement state change of NSSI alarms + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify acknowledgement state change of NSSI alarms. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data control service for NSSI. | | +| <b>Telecom resources</b> | Network slice subnet instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NSSI is deployed<br>An authorized consumer has subscribed the notifications of an NSSI. | | +| <b>Begins when</b> | An acknowledgement state change of the NSSI alarms is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data control service for NSSI generates an acknowledgement state change notification. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data control service for NSSI sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the acknowledgement state change notification of the NSSI or the authorized consumer unsubscribes the notifications of the NSSI or the NSSI is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the acknowledgement state change notification of the NSSI | | +| <b>Traceability</b> | REQ-FSDC_NSSI-FUN-4 | | + +### 5.1.27 Notify acknowledgement state change of NF instance alarms + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To notify acknowledgement state change of NF instance alarms. | | +| <b>Actors and Roles</b> | An authorized consumer of fault supervision data control service for NF. | | +| <b>Telecom resources</b> | Network function instance | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | An NF instance is deployed<br>An authorized consumer has subscribed the notifications of an NF instance. | | +| <b>Begins when</b> | An acknowledgement state change of the NF instance alarms is detected. | | +| <b>Step 1 (M)</b> | The producer of fault supervision data control service for NF generates an acknowledgement state change notification of the NF instance. | | +| <b>Step 2 (M)</b> | The producer of fault supervision data control service for NF sends the generated notification to its authorized consumer if this notification satisfies the filter condition if exists. | | +| <b>Ends when</b> | The authorized consumer receives the acknowledgement state change notification of the NF instance or the authorized consumer unsubscribes the notifications of the NF instance or the NF instance is terminated. | | +| <b>Exceptions</b> | In case any of the mandatory steps in the use case fails | | +| <b>Post-conditions</b> | The authorized consumer receives the acknowledgement state change notification of the NF instance | | +| <b>Traceability</b> | REQ-FSDC_NF-FUN-4 | | + +## 5.2 Requirements + +### 5.2.1 Requirements for fault supervision data report service for NSI + +**REQ-FSDR\_NSI-FUN-1** The fault supervision data report service for NSI shall have the capability to provide alarm notifications of an NSI to its authorized consumer. + +**REQ-FSDR\_NSI-FUN-2** The fault supervision data report service for NSI shall have the capability to allow its authorized consumer to subscribe the alarm notifications of an NSI. + +**REQ-FSDR\_NSI-FUN-3** The fault supervision data report service for NSI shall have the capability to allow its authorized consumer to unsubscribe the alarm notifications of an NSI. + +**REQ-FSDR\_NSI-FUN-4** The fault supervision data report service for NSI shall have the capability to allow its authorized consumer to provide the filter for alarm notifications. + +**REQ-FSDR\_NSI-FUN-5** The fault supervision data report service for NSI shall have the capability to provide the alarm list of an NSI. + +**REQ-FSDR\_NSI-FUN-6** The fault supervision data report service for NSI shall have the capability to allow its authorized consumer to provide the filter for the alarms. + +**REQ-FSDR\_NSI-FUN-7** The fault supervision data report service for NSI shall have the capability to provide changed alarm notifications of an NSI to its authorized consumer. + +**REQ-FSDR\_NSI-FUN-8** The fault supervision data report service for NSI shall have the capability to provide cleared alarm notifications of an NSI to its authorized consumer. + +**REQ-FSDR\_NSI-FUN-9** The fault supervision data report service for NSI shall have the capability to provide new generated alarm notifications of an NSI to its authorized consumer. + +### 5.2.2 Requirements for fault supervision data control service for NSI + +**REQ-FSDC\_NSI-FUN-1** The fault supervision data control service for NSI shall have the capability to satisfy the request to acknowledge one or multiple alarms of an NSI. + +**REQ-FSDC\_NSI-FUN-2** The fault supervision data control service for NSI shall have the capability to satisfy the request to clear one or multiple alarms of an NSI. + +**REQ-FSDC\_NSI-FUN-3** Void. + +**REQ-FSDC\_NSI-FUN-4** The fault supervision data control service for NSI shall have the capability to provide acknowledgement state change notifications of an NSI to its authorized consumer. + +### 5.2.3 Requirements for fault supervision data report service for NSSI + +**REQ-FSDR\_NSSI-FUN-1** The fault supervision data report service for NSSI shall have the capability to provide alarm notifications of a network slice subnet instance to its authorized consumer. + +**REQ-FSDR\_NSSI-FUN-2** The fault supervision data report service for NSSI shall have the capability to allow its authorized consumer to subscribe the alarm notifications of an NSSI. + +**REQ-FSDR\_NSSI-FUN-3** The fault supervision data report service for NSSI shall have the capability to allow its authorized consumer to unsubscribe the alarm notifications of an NSSI. + +**REQ-FSDR\_NSSI-FUN-4** The fault supervision data report service for NSSI shall have the capability to allow its authorized consumer to provide the filter for alarm notifications. + +**REQ-FSDR\_NSSI-FUN-5** The fault supervision data report service for NSSI shall have the capability to provide the alarm list of an NSSI. + +**REQ-FSDR\_NSSI-FUN-6** The fault supervision data report service for NSSI shall have the capability to allow its authorized consumer to provide the filter for the alarms. + +**REQ-FSDR\_NSSI-FUN-7** The fault supervision data report service for NSSI shall have the capability to provide changed alarm notifications of an NSSI to its authorized consumer. + +**REQ-FSDR\_NSSI-FUN-8** The fault supervision data report service for NSSI shall have the capability to provide cleared alarm notifications of an NSSI to its authorized consumer. + +**REQ-FSDR\_NSSI-FUN-9** The fault supervision data report service for NSSI shall have the capability to provide new generated alarm notifications of an NSSI to its authorized consumer. + +### 5.2.4 Requirements for fault supervision data control service for NSSI + +**REQ-FSDC\_NSSI-FUN-1** The fault supervision data control service for NSSI shall have the capability to satisfy the request to acknowledge one or multiple alarms of an NSSI. + +**REQ-FSDC\_NSSI-FUN-2** The fault supervision data control service for NSSI shall have the capability to satisfy the request to clear one or multiple alarms of an NSSI. + +**REQ-FSDC\_NSSI-FUN-3** Void. + +**REQ-FSDC\_NSSI-FUN-4** The fault supervision data control service for NSSI shall have the capability to provide acknowledgement state change notifications of an NSSI to its authorized consumer. + +### 5.2.5 Requirements for fault supervision data report service for NF + +**REQ-FSDR\_NF-FUN-1** The fault supervision data report service for NF shall have the capability to provide alarm notifications of a network function instance to its authorized consumer. + +**REQ-FSDR\_NF-FUN-2** The fault supervision data report service for NF shall have the capability to provide alarm notifications of virtualized resources correlated with an NF instance to its authorized consumer. + +**REQ-FSDR\_NF-FUN-3** The fault supervision data report service for NF shall have the capability to allow its authorized consumer to subscribe the alarm notifications of an NF instance. + +**REQ-FSDR\_NF-FUN-4** The fault supervision data report service for NF shall have the capability to allow its authorized consumer to unsubscribe the alarm notifications of an NF instance. + +**REQ-FSDR\_NF-FUN-5** The fault supervision data report service for NF shall have the capability to allow its authorized consumer to provide the filter for alarm notifications. + +**REQ-FSDR\_NF-FUN-6** The fault supervision data report service for NF shall have the capability to provide the alarm list of an NF instance. + +**REQ-FSDR\_NF-FUN-7** The fault supervision data report service for NF shall have the capability to provide the alarm list of virtualized resources correlated with an NF instance. + +**REQ-FSDR\_NF-FUN-8** The fault supervision data report service for NF shall have the capability to allow its authorized consumer to provide the filter for the alarms. + +**REQ-FSDR\_NF-FUN-9** The fault supervision data report service for NF shall have the capability to provide changed alarm notifications of an NF instance to its authorized consumer. + +**REQ-FSDR\_NF-FUN-10** The fault supervision data report service for NF shall have the capability to provide cleared alarm notifications of an NF instance to its authorized consumer. + +**REQ-FSDR\_NF-FUN-11** The fault supervision data report service for NF shall have the capability to provide new generated alarm notifications of an NF instance to its authorized consumer. + +### 5.2.6 Requirements for fault supervision data control service for NF + +**REQ-FSDC\_NF-FUN-1** The fault supervision data control service for NF shall have the capability to satisfy the request to acknowledge one or multiple alarms of an NF instance. + +**REQ-FSDC\_NF-FUN-2** The fault supervision data control service for NF shall have the capability to satisfy the request to clear one or multiple alarms of an NF instance. + +**REQ-FSDC\_NF-FUN-3** Void. + +**REQ-FSDC\_NF-FUN-4** The fault supervision data control service for NF shall have the capability to provide acknowledgement state change notifications of an NF instance to its authorized consumer. + +# 6 Fault Supervision management services components + +## 6.1 Management services for network slice fault supervision + +The management services for network slice fault supervision are listed in table 6.1-1. + +**Table 6.1-1: Management services for network slice fault supervision** + +| Management service | MnS Component Type A | MnS Component Type B | MnS Component Type C | Note | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|-------------------------------------------|-------------------------------------------------------------------------| +| FS Data Report for NSI | Following operations and notifications defined in TS 28.532[2]:<br>getAlarmList<br>subscribe<br>unsubscribe<br>notifyNewAlarm<br>notifyAlarmListRebuilt<br>notifyChangedAlarm | NSI information model defined in TS 28.541[3] | Alarm information defined in TS 28.532[2] | This management service enables its consumer to get NSI alarm data. | +| FS Control for NSI | Following operations and notifications defined in TS 28.532[2]:<br>acknowledgeAlarms<br>clearAlarms<br>notifyAckStateChanged<br>notifyClearedAlarm<br>unacknowledgeAlarms | NSI information model defined in TS 28.541[3] | Alarm information defined in TS 28.532[2] | This management service enables its consumer to control NSI alarm data. | + +## 6.2 Management services for network slice subnet fault supervision + +The management services for network slice subnet fault supervision are listed in table 6.2-1. + +**Table 6.2-1: Management services for network slice subnet fault supervision** + +| Management service | MnS Component Type A | MnS Component Type B | MnS Component Type C | Note | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-------------------------------------------|--------------------------------------------------------------------------| +| FS Data Report for NSSI | Following operations and notifications defined in TS 28.532[2]:<br>getAlarmList<br>subscribe<br>unsubscribe<br>notifyNewAlarm<br>notifyAlarmListRebuilt<br>notifyChangedAlarm | NSSI information model defined in TS 28.541[3] | Alarm information defined in TS 28.532[2] | This management service enables its consumer to get NSSI alarm data. | +| FS Control for NSSI | Following operations and notifications defined in TS 28.532[2]:<br>acknowledgeAlarms<br>clearAlarms<br>notifyAckStateChanged<br>notifyClearedAlarm<br>unacknowledgeAlarms | NSSI information model defined in TS 28.541[3] | Alarm information defined in TS 28.532[2] | This management service enables its consumer to control NSSI alarm data. | + +## 6.3 Management services for network function fault supervision + +The management services for network function fault supervision are listed in table 6.3-1. + +**Table 6.3-1: Management services for NF fault supervision** + +| Management service | MnS Component Type A | MnS Component Type B | MnS Component Type C | Note | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|-------------------------------------------|------------------------------------------------------------------------| +| FS Data Report for NF | Following operations and notifications defined in TS 28.532[2]:<br>getAlarmList<br>subscribe<br>unsubscribe<br>notifyNewAlarm<br>notifyAlarmListRebuilt<br>notifyChangedAlarm | NF(s)/ME(s) information model defined in TS 28.541 and TS 28.541[3] | Alarm information defined in TS 28.532[2] | This management service enables its consumer to get NF alarm data. | +| FS Control for NF | Following operations and notifications defined in TS 28.532[2]:<br>acknowledgeAlarms<br>clearAlarms<br>notifyAckStateChanged<br>notifyClearedAlarm<br>unacknowledgeAlarms | NF(s)/ME(s) information model defined in TS 28.541 and TS 28.541[3] | Alarm information defined in TS 28.532[2] | This management service enables its consumer to control NF alarm data. | + +## 6.4 Management Service components used for configurable FM control + +The MnS components used for configurable FM control are listed in table 6.4-1. The configurable FM control approach and fault supervision management service described in clause 6.1 - 6.3 are two alternative solutions used for fault management. + +**Table 6.4-1: MnS component used for configurable FM control** + +| <b>Management purpose</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | +|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Configurable FM control for NE/NF | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[2]:<br>Operations:<br>- getMOIAttributes<br>- modifyMOIAttributes<br><br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in FM control NRM fragment in TS 28.622 [5] :<br><br>-AlarmList<br>-ManagedElement | +| Configurable FM control for NetworkSlice | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[2]:<br>Operations:<br>- getMOIAttributes<br>- modifyMOIAttributes<br><br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in FM control NRM fragment in TS 28.622 [5] / TS 28.541[3]:<br><br>-AlarmList<br>-NetworkSlice | +| Configurable FM control for NetworkSliceSubnet | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[2]:<br>Operations:<br>- getMOIAttributes<br>- modifyMOIAttributes<br><br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in FM control NRM fragment in TS 28.622 [5] / TS 28.541[3]:<br><br>-AlarmList<br>-NetworkSliceSubnet | +| Configurable FM control for SubNetwork | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[2]:<br>Operations:<br>- getMOIAttributes<br>- modifyMOIAttributes<br><br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in FM control NRM fragment in TS 28.622 [5] :<br><br>-AlarmList<br>-SubNetwork | + +# 7 Alarm loss detection + +The present document does not specify methods for a management service consumer to detect alarm loss. The use of alarmId to detect alarm loss is an arrangement made between management service producer and management service consumer. The use of such arrangement is outside the scope of the present document. For example, management service producer may use integer sequence (e.g. 1, 2, 3, 4, 5, ...) as alarmId instances for its alarms. Based on this knowledge, the management service consumer can detect alarm loss. + +The present document does not specify how a management service producer can determine if management service consumer has received alarms correctly. + +The present document does not specify methods for a management consumer and a management service producer to recover alarm loss. The only mechanism recommended to deal with alarm loss is the use of getAlarmList operation. The present document does not specify conditions under which the management service consumer should invoke this operation. + +# --- 8 Virtualized resource alarm correlation + +The authorized MnS consumer request VNF application alarms and VNF instance alarms related to virtualized resource from MnS producer by consuming the fault supervision MnS. MnS producer obtain the VNF application alarms (including affected VNF/VNFC instance identifier and detailed VNF alarm information) from the VNF, and the VNF instance alarms related to virtualized resource (including affected VNF/VNFC instance identifier and detailed NFVI/VM alarm information) received from the VNFM. Based on the above obtained alarms, MnS producer can correlate the VNF application alarms and the VNF and/or VNFC alarms related to virtualized resource according to affected VNF instance identifier and/or VNFC instance identifiers. The detailed procedure for virtualized resource alarm correlation procedure see corresponding procedure of NE alarm correlation made by EM in the context of NFV described in TS 28.516[4] and the MnS producer act as the role of EM. + +The authorized MnS consumer requests NSSI alarms including alarm reports related to virtualized resource by consuming the fault supervision MnS. The MnS producer should collect alarm report related to virtualized resource according to affected VNF instance identifier corresponding to the NF instance in the NSSI. + +# --- 9 Procedures for fault supervision management services + +## 9.1 Alarm subscription and notification + +The Figure 9.1-1 illustrates procedures of alarm subscription, supervision and notification for MOI(s). + +![Sequence diagram illustrating the procedures for MOI alarm subscription, supervision, and notification between a Consumer and an FS Data Report management service producer.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` +sequenceDiagram + participant Consumer + participant FS Data Report management service producer + Note right of FS Data Report management service producer: 27 + Consumer->>FS Data Report management service producer: 1. subscribe request(SubscriptionRequest) + Note right of FS Data Report management service producer: 2. Check whether subscription is accepted. + opt if subscription is accepted + Note right of FS Data Report management service producer: 3. Create subscription resources + FS Data Report management service producer-->>Consumer: 4. subscribe response (succeed) + loop for each MOI under supervision + Note right of FS Data Report management service producer: 5. Check whether conditions of notification meet + opt if conditions meet + FS Data Report management service producer-->>Consumer: 6. notify + end + end + end +``` + +The sequence diagram shows the interaction between a Consumer and an FS Data Report management service producer. The process begins with the Consumer sending a 'subscribe request(SubscriptionRequest)' to the producer. The producer then checks if the subscription is accepted. If accepted, it creates subscription resources and sends a 'subscribe response (succeed)' back to the consumer. The producer then enters a loop for each MOI under supervision, checking if the conditions of notification are met. If the conditions are met, it sends a 'notify' message to the consumer. + +Sequence diagram illustrating the procedures for MOI alarm subscription, supervision, and notification between a Consumer and an FS Data Report management service producer. + +**Figure 9.1-1 Procedures for MOI alarm subscription, supervision and notification** + +1. The authorized consumer sends subscribe request to FS Data Report management service producer to establish subscription to alarm notifications. The authorized consumer includes subscriber's URI and filter in the subscribe request message. +2. The FS Data Report management service producer checks whether the subscribe request is accepted. +3. If the subscription is accepted, the FS Data Report management service producer creates the subscription resources for the subscriber. If the subscribe request requires the FS Data Report management service producer to collect new types of alarm from the constituent MOI(s), it includes the new alarm type and identifier of MOI into the filter and acts as consumer to request the subscription operation for each constituent MOI. +4. When FS Data Report management service producer successfully creates the subscription resources, it sends success response to authorized consumer. +5. For each MOI under fault supervision monitored, FS Data Report management service producer supervises if the conditions are matched by new or changed alarm(s) as indicated in filter in subscribe request, including the received alarm notification of constituent MOI(s). When the FS Data Report management service producer receives the alarms of the constituent MOI(s), it generates the alarm information for the subscription or adds them to the correlated notification related to the alarm information for the subscription. +6. The FS Data Report management service producer notifies the alarms to the authorized consumer. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-09 | SA#81 | | | | | Upgrade to change control version | 15.0.0 | +| 2018-12 | SA#82 | SP-181045 | 0001 | 1 | F | Correction for Requirements of Fault Supervision (FS) Service | 15.1.0 | +| 2020-07 | SA#88-e | SP-200501 | 0006 | 1 | F | Update clause 8 virtualized resource alarm correlation | 15.2.0 | +| 2020-07 | SA#88-e | SP-200490 | 0005 | 1 | B | Add description for MnS components used for configurable FM control | 16.0.0 | +| 2020-09 | SA#89e | SP-200724 | 0007 | 1 | F | Update description of MnS components used for configurable FM control | 16.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28550/raw.md b/marked/Rel-16/28_series/28550/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2ad3044b3a2520b6c3fb9f1b1dbf1e54c4cdd628 --- /dev/null +++ b/marked/Rel-16/28_series/28550/raw.md @@ -0,0 +1,2866 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Concepts and overview ..... | 9 | +| 4.1 Overview ..... | 9 | +| 4.2 Management data analytics ..... | 9 | +| 4.3 PM services ..... | 10 | +| 4.4 PM services for multiple tenant support ..... | 10 | +| 5 Specification level requirements..... | 11 | +| 5.1 Use cases ..... | 11 | +| 5.1.0 Introduction ..... | 11 | +| 5.1.1 NF PM services ..... | 11 | +| 5.1.1.1 NF measurement job control service ..... | 11 | +| 5.1.1.1.1 Creation of measurement job for NF(s) ..... | 11 | +| 5.1.1.1.2 Termination of measurement job for NF(s) ..... | 12 | +| 5.1.1.1.3 Query of measurement jobs for NF(s)..... | 12 | +| 5.1.1.2 NF performance data file reporting service ..... | 13 | +| 5.1.1.2.1 3GPP NF performance data file reporting..... | 13 | +| 5.1.1.3 NF performance data streaming service ..... | 13 | +| 5.1.1.3.1 3GPP NF performance data streaming..... | 13 | +| 5.1.1.4 NF performance threshold monitoring ..... | 14 | +| 5.1.1.4.1 Creation of threshold monitoring for NF performance measurements ..... | 14 | +| 5.1.1.4.2 Termination of threshold monitoring for NF performance measurements ..... | 15 | +| 5.1.2 NSSI PM services..... | 16 | +| 5.1.2.1 NSSI measurement job control service..... | 16 | +| 5.1.2.1.1 Creation of measurement job for NSSI(s)..... | 16 | +| 5.1.2.1.2 Termination of measurement job for NSSI(s)..... | 17 | +| 5.1.2.1.3 Query of measurement jobs for NSSI(s)..... | 17 | +| 5.1.2.2 NSSI performance data file reporting service..... | 18 | +| 5.1.2.2.1 NSSI performance data file reporting ..... | 18 | +| 5.1.2.3 NSSI performance data streaming service..... | 18 | +| 5.1.2.3.1 NSSI performance data streaming..... | 18 | +| 5.1.2.4 NSSI performance threshold monitoring ..... | 19 | +| 5.1.2.4.1 Creation of threshold monitoring for NSSI performance measurements..... | 19 | +| 5.1.2.4.2 Termination of threshold monitoring for NSSI performance measurements..... | 20 | +| 5.1.3 NSI PM services ..... | 21 | +| 5.1.3.1 NSI measurement job control service..... | 21 | +| 5.1.3.1.1 Creation of measurement job for NSI(s)..... | 21 | +| 5.1.3.1.2 Termination of measurement job for NSI(s)..... | 22 | +| 5.1.3.1.3 Query of measurement jobs for NSI(s)..... | 23 | +| 5.1.3.2 NSI performance data file reporting service..... | 23 | +| 5.1.3.2.1 NSI performance data file reporting..... | 23 | +| 5.1.3.3 NSI performance data streaming service..... | 24 | +| 5.1.3.3.1 NSI performance data streaming..... | 24 | +| 5.1.3.4 NSI performance threshold monitoring ..... | 25 | +| 5.1.3.4.1 Creation of threshold monitoring for NSI performance measurements..... | 25 | +| 5.1.3.4.2 Termination of threshold monitoring for NSI performance measurements ..... | 26 | +| 5.1.4 Network/Sub-network PM services..... | 27 | +| 5.1.4.1 Network/Sub-network measurement job control service..... | 27 | +| 5.1.4.1.1 Creation of measurement job for network(s)/sub-network(s)..... | 27 | +| 5.1.4.1.2 Termination of measurement job for network(s)/sub-network(s)..... | 28 | +| 5.1.4.1.3 Query of measurement jobs for network(s)..... | 28 | +| 5.1.4.2 Network/Sub-network performance data file reporting service ..... | 29 | + +| | | | +|-----------|----------------------------------------------------------------------------------------------------------------------------|----| +| 5.1.4.2.1 | Network/Sub-network performance data file reporting ..... | 29 | +| 5.1.4.3 | Network/Sub-network performance data streaming service..... | 29 | +| 5.1.4.3.1 | Network/Sub-network performance data streaming ..... | 29 | +| 5.1.5 | Management data analytics ..... | 30 | +| 5.1.5.1 | Management data analytics for NSIs/NSSIs..... | 30 | +| 5.1.5.2 | Management data analytics for network..... | 31 | +| 5.1.6 | MnS responsible for KPI job control..... | 32 | +| 5.1.6.1 | Creation of KPI job..... | 32 | +| 5.1.6.2 | Termination of KPI job..... | 32 | +| 5.1.6.3 | Query of KPI jobs..... | 33 | +| 5.1.7 | Performance management supporting multiple tenants in the NSaaS scenario ..... | 33 | +| 5.2 | Requirements..... | 34 | +| 5.2.1 | Requirements for NF measurement job control service ..... | 34 | +| 5.2.2 | Requirements for NF performance data file reporting service ..... | 34 | +| 5.2.3 | Requirements for NF performance data streaming service ..... | 34 | +| 5.2.4 | Requirements for NSSI measurement job control service..... | 34 | +| 5.2.5 | Requirements for NSSI performance data file reporting service ..... | 35 | +| 5.2.6 | Requirements for NSSI performance data streaming service..... | 35 | +| 5.2.7 | Requirements for NSI measurement job control service..... | 35 | +| 5.2.8 | Requirements for NSI performance data file reporting service..... | 35 | +| 5.2.9 | Requirements for NSI performance data streaming service..... | 35 | +| 5.2.10 | Requirements for network/sub-network measurement job control service..... | 36 | +| 5.2.11 | Requirements for network/sub-network performance data file reporting service..... | 36 | +| 5.2.12 | Requirements for network/sub-network performance data streaming service ..... | 36 | +| 5.2.13 | Management data analytics service ..... | 36 | +| 5.2.14 | Management service for NF performance threshold monitoring ..... | 37 | +| 5.2.15 | Requirements for MnS responsible for KPI production..... | 37 | +| 5.2.16 | Requirements for performance management supporting multiple tenants..... | 37 | +| 6. | Performance assurance specific operations and notifications..... | 37 | +| 6.1 | Measurement job control related operations ..... | 37 | +| 6.1.1 | Operation createMeasurementJob (M)..... | 37 | +| 6.1.1.1 | Definition ..... | 37 | +| 6.1.1.2 | Input parameters ..... | 39 | +| 6.1.1.3 | Output parameters..... | 41 | +| 6.1.1.4 | Exceptions..... | 41 | +| 6.1.2 | Operation stopMeasurementJob (M)..... | 41 | +| 6.1.2.1 | Definition ..... | 41 | +| 6.1.2.2 | Input parameters ..... | 42 | +| 6.1.2.3 | Output parameters..... | 42 | +| 6.1.2.4 | Exceptions..... | 42 | +| 6.1.3 | Operation listMeasurementJobs (M)..... | 42 | +| 6.1.3.1 | Definition ..... | 42 | +| 6.1.3.2 | Input parameters ..... | 42 | +| 6.1.3.3 | Output parameters..... | 43 | +| 6.1.3.4 | Exceptions..... | 43 | +| 6.2 | Performance data streaming related operations ..... | 43 | +| 6.3 | Performance threshold monitoring related operations and notifications ..... | 43 | +| 7. | Performance assurance services components ..... | 43 | +| 7.1 | Measurement job control services..... | 43 | +| 7.2 | Performance data file reporting services..... | 44 | +| 7.3 | Performance data streaming services..... | 45 | +| 7.4 | Management service for performance threshold monitoring ..... | 46 | +| 7.5 | MnS responsible for KPI job control ..... | 47 | +| 7.6 | Management service components used for configurable performance measurement control ..... | 47 | +| 8 | RESTful HTTP-based solution set of performance measurement job control service specific operations and notifications ..... | 49 | +| 8.1 | Mapping of operations ..... | 49 | +| 8.1.1 | Introduction ..... | 49 | +| 8.1.2 | Operation createMeasurementJob ..... | 49 | +| 8.1.3 | Operation listMeasurementJobs..... | 49 | + +| | | | +|-------------------------------|----------------------------------------------------------------------|-----------| +| 8.1.4 | Operation stopMeasurementJob..... | 50 | +| 8.2 | Resources ..... | 50 | +| 8.2.0 | Resource structure ..... | 50 | +| 8.2.1 | Resource definitions ..... | 51 | +| 8.2.1.1 | Void ..... | 51 | +| 8.2.1.2 | Resource "/measJobs"..... | 51 | +| 8.2.1.2.1 | Description ..... | 51 | +| 8.2.1.2.2 | URI..... | 51 | +| 8.2.1.2.3 | HTTP methods ..... | 51 | +| 8.2.1.3 | Resource "/measJobs/{jobId}"..... | 52 | +| 8.2.1.3.1 | Description ..... | 52 | +| 8.2.1.3.2 | URI..... | 52 | +| 8.2.1.3.3 | HTTP methods ..... | 52 | +| 8.3 | Data type definitions ..... | 54 | +| 8.3.1 | General ..... | 54 | +| 8.3.2 | Void ..... | 54 | +| 8.3.3 | Void ..... | 54 | +| 8.3.4 | Structured general data types..... | 54 | +| 8.3.5 | Structured path data types ..... | 54 | +| 8.3.6 | Query, message body and resource data types ..... | 55 | +| 8.3.6.1 | Type measJobCreation-RequestType ..... | 55 | +| 8.3.6.2 | Type measJobCreation-ResponseType..... | 55 | +| 8.3.6.3 | Type measJobsRetrieval-ResponseType ..... | 55 | +| 8.3.6.4 | Type error-ResponseType..... | 55 | +| 8.3.6.5 | Type measJobInfo-ResourceType ..... | 56 | +| 8.3.7 | Referenced structured data types..... | 56 | +| 8.3.7.1 | Type schedule-Type..... | 56 | +| 8.3.7.2 | Type timeInterval-Type ..... | 56 | +| 8.3.7.3 | Type scheduleOfDay-Type..... | 56 | +| 8.3.7.4 | Void ..... | 57 | +| 8.3.7.5 | Type unsupportedMeas-Type ..... | 57 | +| 8.3.8 | Simple data types and enumerations ..... | 57 | +| 8.3.8.1 | General..... | 57 | +| 8.3.8.2 | Simple data types ..... | 57 | +| 8.3.8.3 | Enumeration reportingMethod-Type ..... | 57 | +| 8.3.8.4 | Enumeration priority-Type ..... | 57 | +| 8.3.8.5 | Enumeration scheduleOption-Type ..... | 57 | +| 8.3.8.6 | Enumeration dayOfWeek-Type..... | 58 | +| 9 | Void..... | 58 | +| <b>Annex A (informative):</b> | <b>Void.....</b> | <b>59</b> | +| <b>Annex B (informative):</b> | <b>Procedures for performance assurance services.....</b> | <b>60</b> | +| B.1 | NF measurement job creation ..... | 60 | +| B.2 | NSSI measurement job creation..... | 61 | +| B.3 | NSI measurement job creation..... | 62 | +| B.4 | Network measurement job creation ..... | 64 | +| B.5 | NF measurement job termination..... | 65 | +| B.6 | NSSI measurement job termination ..... | 66 | +| B.7 | NSI measurement job termination ..... | 67 | +| B.8 | Network measurement job termination..... | 68 | +| <b>Annex C (normative):</b> | <b>Performance Data Stream Unit content description .....</b> | <b>69</b> | +| <b>Annex D (informative):</b> | <b>Performance data streaming holistic sequence .....</b> | <b>70</b> | +| D.1 | Performance data streaming for starting measurement collection ..... | 70 | + +| | | | +|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|-----------| +| D.1.1 | Sequence flow ..... | 70 | +| D.1.2 | PlantUML codes..... | 71 | +| D.2 | Performance data streaming for stopping measurement collection ..... | 72 | +| D.2.1 | Sequence flow ..... | 72 | +| D.2.2 | PlantUML codes..... | 73 | +| <b>Annex E (normative): OpenAPI specification .....</b> | | <b>74</b> | +| E.1 | Introduction ..... | 74 | +| E.2 | OpenAPI document " TS28550_PerMeasJobCtlMnS.yaml"..... | 74 | +| E.3 | Void..... | 78 | +| <b>Annex F (normative): Threshold crossing notifications triggering .....</b> | | <b>79</b> | +| F.1 | Threshold crossing notifications triggering for cumulative counters ..... | 79 | +| F.2 | Threshold crossing notifications triggering for measurements that are not cumulative counters ..... | 80 | +| <b>Annex G (normative): ASN.1 definition for performance data stream units .....</b> | | <b>81</b> | +| G.1 | ASN.1 definition rule ..... | 81 | +| G.2 | ASN.1 definition ..... | 81 | +| <b>Annex H (normative): NSI and NSSI performance assurance .....</b> | | <b>83</b> | +| H.1 | General..... | 83 | +| H.2 | Procedure of NSI and NSSI performance assurance ..... | 83 | +| <b>Annex I (informative): Change history .....</b> | | <b>85</b> | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the stage 1, 2 and 3 of performance assurance related management services for 5G networks including network slicing. + +The present document does not specify the performance data, i.e. performance measurements, Key Performance Indicators (KPIs). + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [3] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [4] ITU-T Recommendation X.721 (1992): "Information technology - Open Systems Interconnection - Structure of management information: Definition of management information". +- [5] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [6] ISO 8601:2000(E) Data elements and interchange formats – Information interchange – Representation of dates and times". +- [7] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [8] Void +- [9] Void +- [10] Void +- [11] Void +- [12] Void +- [13] 3GPP TS 28.628: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [14] 3GPP TS 32.158: "Management and orchestration; Design rules for Representational State Transfer (REST) Solution Sets (SS)". +- [15] ITU-T Recommendation X.680 (08/2015) "Information Technology - Abstract Syntax Notation One (ASN.1): Specification of basic notation" (Same as the ISO/IEC International Standard 8824-1). +- [16] ITU-T Recommendation X.681 (08/2015) "Information Technology - Abstract Syntax Notation One (ASN.1): Information object specification" (Same as the ISO/IEC International Standard 8824-2). + +- [17] ITU-T Recommendation X.691 (08/2015) "Information technology - ASN.1 encoding rules: Specification of Packed Encoding Rules (PER)" (Same as the ISO/IEC International Standard 8825-2). +- [18] IETF RFC 6455: "The WebSocket Protocol". +- [19] IETF RFC 793: "TRANSMISSION CONTROL PROTOCOL". +- [20] Void. +- [21] 3GPP TS 28.554: "Management and orchestration; 5G end to end Key Performance Indicators (KPI)". +- [22] 3GPP TS 23.288: " Technical Specification Group Services and System Aspects; Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [23] 3GPP TS 28.530: "Technical Specification Group Services and System Aspects; Management and orchestration; Concepts, use cases and requirements". +- [24] 3GPP TS 28.531: " Management and orchestration; Provisioning". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +# --- 4 Concepts and overview + +## 4.1 Overview + +The 5G networks and network slicing are designed to support eMBB, URLLC and mIoT services. Some services have ultra-low latency, high data capacity, and strict reliability requirements, as any faults or performance issues in the networks can cause service failure which may result in property damage and body injury. Therefore, it is necessary to collect real-time performance data that can be used by analytic applications (e.g., network optimization, SON, etc.) to detect the potential issues in advance, and take appropriate actions to prevent or mitigate the issues. Also, the performance data shall be able to be consumed by multiple analytic applications with specific purposes. + +## 4.2 Management data analytics + +The raw performance data of NFs of the mobile network can be analysed, together with other management data (e.g., alarm information, configuration data), and formed into one or more management analytical data for NFs, sub-networks, NSSIs or NSIs. The management analytical data can be used to diagnose ongoing issues impacting the performance of the mobile network and predict any potential issues (e.g., potential failure and/or performance degradation). For example, the analysis of NSI/NSSI resource usage can form a management analytical data indicating whether a certain resource is deteriorating. The analysis and correlation of the overall performance data of mobile network may indicate overload situation and potential failure(s). + +SON Capacity and Coverage Optimization (CCO) is one typical case that may consume the management analytical data. CCO provides optimal coverage and capacity for the E-UTRAN, see clause 4.5 of TS 28.628 [13], which may also be applicable for 5G radio networks. The management analytical data related to coverage and capacity help the SON + +CCO to realise the situation of coverage and capacity or interference, and to trigger corresponding optimization if needed. + +NOTE: Details of the management analytical data including e.g. format, categorisation and method/algorithm of calculations are to be defined. + +## 4.3 PM services + +The PM for 5G networks and network slicing is comprised of the management services listed in the table 4.3-1 below: + +**Table 4.3-1: PM services for 5G networks and network slicing** + +| Management service | Description | +|-----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Measurement job control service for NF | The management service for creating, terminating and querying the measurement job(s) for the NF(s). | +| Performance data file reporting service for NF | The management service for reporting the NF performance data file. | +| Performance data streaming service for NF | The management service for reporting the NF performance data stream. | +| Measurement job control service for NSSI | The management service for creating, terminating and querying the measurement job(s) for the NSSI(s). | +| Performance data file reporting service for NSSI | The management service for reporting the NSSI performance data file. | +| Performance data streaming service for NSSI | The management service for reporting the NSSI performance data stream. | +| Measurement job control service for NSI | The management service for creating, terminating and querying the measurement job(s) for the NSI(s). | +| Performance data file reporting service for NSI | The management service for reporting the NSI performance data file. | +| Performance data streaming service for NSI | The management service for reporting the NSI performance data stream. | +| Measurement job control service for network/sub-network | The management service for creating, terminating and querying the measurement job(s) for the network(s)/subnetwork(s). The measurement job for the network(s)/subnetwork(s) is to collect the network/subnetwork performance data that are not specific to network slicing. | +| Performance data file reporting service for network/sub-network | The management service for reporting the file of the network/subnetwork performance data that is not specific to network slicing. | +| Performance data streaming service for network/sub-network | The management service for reporting the stream of the network/subnetwork performance data that is not specific to network slicing. | +| MnS responsible for KPI job control | The management service for creating, terminating and querying the KPI job(s) | + +## 4.4 PM services for multiple tenant support + +The MnS consumer, acting on behalf of a tenant, may get the performance measurements of a network slice.. Performance measurements specified in TS 28.552 [1] can be split into sub-counters per S-NSSAI. 3GPP management system can use these sub-counters to distinguish performance measurements for different tenants, which might be required when performance measurements are exposed as part of Network Slice as a Service (NSaaS) specified in TS 28.530 [23]. + +# 5 Specification level requirements + +## 5.1 Use cases + +### 5.1.0 Introduction + +The steps of the use cases are logical illustration on how the management service request can be fulfilled. Depending on the deployment scenario, other steps can be used to fulfil the management service request. + +### 5.1.1 NF PM services + +#### 5.1.1.1 NF measurement job control service + +##### 5.1.1.1.1 Creation of measurement job for NF(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to create a measurement job for collecting the performance data of NF(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NF measurement job control service. | | +| <b>Telecom resources</b> | NF(s);<br>Producer of the NF measurement job control service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The NF(s) have been deployed.<br>- The NF measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to create measurement job for collecting the performance data of NF(s). | | +| <b>Step 1 (M)</b> | The authorized consumer requests the NF measurement job control service producer to create measurement job to collect the performance data of NF(s).<br>The request needs to indicate that the performance data needs to be reported by performance data file or by performance data streaming. | | +| <b>Step 2 (M)</b> | The NF measurement job control service producer requests the NF(s) to collect the performance data, per the received measurement job creation request. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The measurement job for NF(s) has been created, and the NF measurement job control service producer generates the performance data for the NF measurement job. | | +| <b>Traceability</b> | <b>REQ-MJCS_NF-FUN-1, REQ-MJCS_NF-FUN-2, REQ-MJCS_NF-FUN-3, REQ-MJCS_NF-FUN-4 and REQ-MJCS_NF-FUN-7</b> | | + +##### 5.1.1.1.2 Termination of measurement job for NF(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request the NF measurement job control service producer to terminate a NF measurement job. | | +| <b>Actors and Roles</b> | An authorized consumer of NF measurement job control service. | | +| <b>Telecom resources</b> | NF(s)<br>NF measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NF measurement job has been created. | | +| <b>Begins when</b> | The authorized consumer does not need the NF measurement job that is collecting the performance data of NF(s). | | +| <b>Step 1 (M)</b> | The authorized consumer requests the NF measurement job control service producer to terminate a measurement job that is collecting the performance data of NF(s). | | +| <b>Step 2 (M)</b> | The NF measurement job control service producer terminates the measurement job and may request the NF(s) to stop collecting the measurements requested by the measurement job. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NF measurement job is terminated, or still retained but not does not serve the subject consumer anymore. | | +| <b>Traceability</b> | <b>REQ-MJCS_NF-FUN-5</b> | | + +##### 5.1.1.1.3 Query of measurement jobs for NF(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to query the ongoing NF measurement jobs (i.e. the NF measurement jobs that have been created by the subject consumer and not terminated). | | +| <b>Actors and Roles</b> | An authorized consumer of NF measurement job control service. | | +| <b>Telecom resources</b> | NF(s)<br>NF measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NF measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to query the ongoing NF measurement jobs. | | +| <b>Step 1 (M)</b> | The authorized consumer queries the information about the ongoing NF measurement jobs from the NF measurement job control service producer. | | +| <b>Step 2 (M)</b> | The NF measurement job control service producer provides the information about the ongoing NF measurement jobs to the consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The information about the ongoing NF measurements jobs are available to the consumer. | | +| <b>Traceability</b> | <b>REQ-MJCS_NF-FUN-6</b> | | + +#### 5.1.1.2 NF performance data file reporting service + +##### 5.1.1.2.1 3GPP NF performance data file reporting + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to get the performance data file of 3GPP NF(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NF performance data file reporting service. | | +| <b>Telecom resources</b> | Producer of the NF performance data file reporting service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NF has been deployed.</li> <li>- The NF performance data file reporting service producer is in operation.</li> <li>- The NF performance data file reporting service consumer has subscribed the notification about NF performance data file ready.</li> </ul> | | +| <b>Begins when</b> | The performance data file of 3GPP NF is ready at the NF performance data file reporting service producer. | | +| <b>Step 1 (M)</b> | The NF performance data file reporting service producer sends the notification about performance data file ready to the authorized consumer. | | +| <b>Step 2 (M)</b> | The authorized consumer fetches the performance data file from the NF performance data file reporting service producer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The performance data file of 3GPP NF have been reported. | | +| <b>Traceability</b> | <b>REQ-PDFR_NF-FUN-1, REQ-PDFR_NF-FUN-2</b> | | + +#### 5.1.1.3 NF performance data streaming service + +##### 5.1.1.3.1 3GPP NF performance data streaming + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to receive the performance data stream of 3GPP NF(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NF performance data streaming service. | | +| <b>Telecom resources</b> | Producer of the NF performance data streaming service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NF has been deployed.</li> <li>- The NF performance data streaming service producer is in operation.</li> <li>- The NF performance data streaming service consumer has subscribed for receiving the performance data stream from the NF performance data streaming service producer.</li> </ul> | | +| <b>Begins when</b> | The performance data of 3GPP NF is ready at the NF performance data streaming service producer. | | +| <b>Step 1 (M)</b> | The NF performance data streaming service producer sends the NF performance data stream to the consumer. | | +| <b>Ends when</b> | The NF performance data streaming service consumer receives the performance data stream. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | | | +| <b>Traceability</b> | REQ-PDS_NF-FUN-1 | | + +#### 5.1.1.4 NF performance threshold monitoring + +##### 5.1.1.4.1 Creation of threshold monitoring for NF performance measurements + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request creation of threshold monitoring for NF performance measurements. | | +| <b>Actors and Roles</b> | An authorized consumer monitoring service for NF performance threshold monitoring. | | +| <b>Telecom resources</b> | Producer of management service for NF performance threshold monitoring. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NF has been deployed.</li> <li>- The management service for NF performance threshold monitoring is in operation.</li> <li>- The authorized consumer of management service for NF performance threshold monitoring has subscribed to the threshold crossing notifications.</li> </ul> | | +| <b>Begins when</b> | The authorized consumer needs to create performance threshold monitoring for NF performance measurements. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the management service producer to create performance threshold monitoring for NF performance measurements. The request contains the threshold information with the conditions for triggering the threshold crossing notifications, and the information about the threshold monitoring target to receive the notifications. | | +| <b>Step 2 (O)</b> | The service producer may reject the request, if <ul style="list-style-type: none"> <li>- the NF performance measurements included in the threshold monitor are not being collected (e.g., by a measurement job or by NRM configurations); or</li> <li>- the NF performance measurements included in the threshold monitor are being collected but with a GP different from the monitoring GP of this request.</li> </ul> | | +| <b>Step 3 (M)</b> | The management service producer for NF performance threshold monitoring requests the NF(s) to monitor the performance measurements. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NF performance threshold monitoring has been created, and the target will receive the threshold crossing notifications when performance threshold is crossed or reached. | | +| <b>Traceability</b> | REQ-THMS_NF-FUN-1, REQ-THMS_NF-FUN-3 | | + +##### 5.1.1.4.2 Termination of threshold monitoring for NF performance measurements + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request termination of threshold monitoring for NF performance measurements. | | +| <b>Actors and Roles</b> | An authorized consumer of management service for NF performance threshold monitoring. | | +| <b>Telecom resources</b> | Producer of management service for NF performance threshold monitoring. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NF has been deployed.</li> <li>- The producer of management service for NF performance threshold monitoring is in operation.</li> <li>- The threshold monitoring for NF performance measurements has been created for the authorized consumer.</li> </ul> | | +| <b>Begins when</b> | The authorized consumer needs to terminate the performance threshold monitoring for NF performance measurements. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the management service producer to terminate the performance threshold monitoring for NF performance measurements. | | +| <b>Step 2 (M)</b> | The management service producer stops the subject threshold monitoring, and requests the NF(s) to stop monitoring the performance measurements. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The threshold monitoring for NF performance measurements is stopped. | | +| <b>Traceability</b> | <b>REQ-THMS_NF-FUN-2</b> | | + +### 5.1.2 NSSI PM services + +#### 5.1.2.1 NSSI measurement job control service + +##### 5.1.2.1.1 Creation of measurement job for NSSI(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to create a measurement job for collecting the performance data of NSSI(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NSSI measurement job control service. | | +| <b>Telecom resources</b> | NSSI(s);<br>NSSI measurement job control service producer;<br>NF measurement job control service producer;<br>NF performance data file reporting service producer and/or NF performance data streaming service producer;<br>NSSI performance data file reporting service producer and/or NSSI performance data streaming service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The NSSI(s) have been deployed.<br>- The NSSI measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to create measurement job for collecting the performance data of NSSI(s). | | +| <b>Step 1 (M)</b> | The authorized consumer requests the NSSI measurement job control service producer to create a NSSI measurement job to collect the performance data of NSSI(s).<br>The request needs to indicate that the performance data needs to be reported by performance data file or by performance data streaming. | | +| <b>Step 2 (M)</b> | The NSSI measurement job control service producer decomposes the performance data type(s) of NSSI into performance data type(s) of the constituent NSSI(s) and/or NF(s). The NSSI measurement job control service producer checks whether the decomposed performance data types of the constituent NSSI(s) and NF(s) can be collected by the existing measurement job(s) for NSSI(s) and/or NF(s). If new measurement job(s) for the constituent NSSI(s) and/or NF(s) are required, the NSSI measurement job control service producer consumes the NSSI measurement job control service and/or the NF measurement job control service to create the new measurement job(s) for the constituent NSSI(s) and/or NF(s) respectively (according to the use case "Creation of measurement job for NF" as described in clause 5.1.1.1.1). | Creation of measurement job for NF | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The measurement job for NSSI has been created, and the NSSI measurement job control service producer consumes the NSSI performance data file reporting service and/or NSSI performance data streaming service to get the performance data of the constituent NSSI(s), and/or consumes the NF performance data file reporting service and/or NF performance data streaming service to get the performance data of the constituent NF(s), and generates the performance data for the NSSI measurement job. | NSSI performance data file reporting;<br>NSSI performance data streaming;<br>NF performance data file reporting;<br>NF performance data streaming | +| <b>Traceability</b> | REQ-MJCS_NSSI-FUN-1, REQ-MJCS_NSSI-FUN-2, REQ-MJCS_NSSI-FUN-3, REQ-MJCS_NSSI-FUN-4 and REQ-MJCS_NSSI-FUN-7 | | + +##### 5.1.2.1.2 Termination of measurement job for NSSI(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to request the NSSI measurement job control service producer to terminate a NSSI measurement job. | | +| <b>Actors and Roles</b> | An authorized consumer of NSSI measurement job control service. | | +| <b>Telecom resources</b> | NSSI(s)<br>NSSI measurement job control service producer.<br>NF measurement job control service producer | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSSI measurement job has been created. | | +| <b>Begins when</b> | The authorized consumer does not need the NSSI measurement job. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the NSSI measurement job control service producer to terminate a measurement job that is collecting the performance data of NSSI(s). | | +| <b>Step 2 (M)</b> | The NSSI measurement job control service producer terminates the NSSI measurement job, and may<br>- request the corresponding NSSI measurement job control service producer(s) to terminate the supporting measurement job(s) of the constituent NSSI(s), and/or<br>- consume the NF measurement job control service to request termination of the supporting measurement job(s) of the constituent NF(s) (according to the use case "Termination of measurement job for NF(s)" as described in clause 5.1.1.1.2). | Termination of measurement job for NF(s) | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NSSI measurement job is terminated. | | +| <b>Traceability</b> | REQ-MJCS_NSSI-FUN-5 | | + +##### 5.1.2.1.3 Query of measurement jobs for NSSI(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to query the ongoing NSSI measurement jobs (i.e. the NSSI measurement jobs that have been created by the subject consumer and not terminated). | | +| <b>Actors and Roles</b> | An authorized consumer of NSSI measurement job control service. | | +| <b>Telecom resources</b> | NSSI measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSSI measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to query the ongoing NSSI measurement jobs. | | +| <b>Step 1 (M)</b> | The authorized consumer queries the information about the ongoing NSSI measurement jobs from the NSSI measurement job control service producer. | | +| <b>Step 2 (M)</b> | The NSSI measurement job control service producer provides the information about the ongoing NSSI measurement jobs to the consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The information about the ongoing NSSI measurements jobs are available to the consumer. | | +| <b>Traceability</b> | REQ-MJCS_NSSI-FUN-6 | | + +#### 5.1.2.2 NSSI performance data file reporting service + +##### 5.1.2.2.1 NSSI performance data file reporting + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to get the performance data file of 3GPP NSSI(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NSSI performance data file reporting service. | | +| <b>Telecom resources</b> | Producer of the NSSI performance data file reporting service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSSI has been deployed.</li> <li>- The NSSI performance data file reporting service producer is in operation.</li> <li>- The NSSI performance data file reporting service consumer has subscribed the notification about performance data file ready.</li> </ul> | | +| <b>Begins when</b> | The performance data file of 3GPP NSSI(s) is ready at the NSSI performance data file reporting service producer. | | +| <b>Step 1 (M)</b> | The NSSI performance data file reporting service producer sends the notification about performance data file ready to the authorized consumer. | | +| <b>Step 2 (M)</b> | The authorized consumer fetches the performance data file from the NSSI performance data file reporting service producer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The performance data file of 3GPP NSSI have been reported. | | +| <b>Traceability</b> | REQ-PDFR_NSSI-FUN-1, REQ-PDFR_NSSI-FUN-2 | | + +#### 5.1.2.3 NSSI performance data streaming service + +##### 5.1.2.3.1 NSSI performance data streaming + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to receive the performance data stream of NSSI(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NSSI performance data streaming service. | | +| <b>Telecom resources</b> | Producer of the NSSI performance data streaming service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSSI has been deployed.</li> <li>- The NSSI performance data streaming service producer is in operation.</li> <li>- The NSSI performance data streaming service consumer has subscribed for receiving the performance data stream from the NSSI performance data streaming service producer.</li> </ul> | | +| <b>Begins when</b> | The performance data of 3GPP NSSI is ready at the NSSI performance data streaming service producer. | | +| <b>Step 1 (M)</b> | The NSSI performance data streaming service producer sends the NSSI performance data stream to the consumer. | | +| <b>Ends when</b> | The NSSI performance data streaming service consumer receives the performance data stream. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | | | +| <b>Traceability</b> | REQ-PDS_NSSI-FUN-1 | | + +#### 5.1.2.4 NSSI performance threshold monitoring + +##### 5.1.2.4.1 Creation of threshold monitoring for NSSI performance measurements + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request creation of threshold monitoring for NSSI performance measurements. | | +| <b>Actors and Roles</b> | An authorized consumer monitoring service for NSSI performance threshold monitoring. | | +| <b>Telecom resources</b> | Producer of management service for NSSI performance threshold monitoring. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSSI has been deployed.</li> <li>- The management service for NSSI performance threshold monitoring is in operation.</li> <li>- The authorized consumer of management service for NSSI performance threshold monitoring has subscribed to the threshold crossing notifications.</li> </ul> | | +| <b>Begins when</b> | The authorized consumer needs to create performance threshold monitoring for NSSI performance measurements. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the management service producer to create performance threshold monitoring for NSSI performance measurements. The request contains the threshold information with the conditions for triggering the threshold crossing notifications. | | +| <b>Step 2 (M)</b> | The management service producer for NSSI performance threshold monitoring requests the NSSI(s) to monitor the performance measurements. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | <p>The NSSI performance threshold monitoring has been created.</p> <p>The NSSI monitors the performance measurements, and when the condition is met (e.g., a specific threshold is crossed or reached), the NSSI</p> <ul style="list-style-type: none"> <li>- sends the threshold crossing notification to the consumer; or</li> <li>- reports the threshold crossing event to NSSI performance threshold monitoring service producer, who then sends the threshold crossing notification to the consumer.</li> </ul> | | +| <b>Traceability</b> | | | + +##### 5.1.2.4.2 Termination of threshold monitoring for NSSI performance measurements + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request termination of threshold monitoring for NSSI performance measurements. | | +| <b>Actors and Roles</b> | An authorized consumer of management service for NSSI performance threshold monitoring. | | +| <b>Telecom resources</b> | Producer of management service for NSSI performance threshold monitoring. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSSI has been deployed.</li> <li>- The producer of management service for NSSI performance threshold monitoring is in operation.</li> <li>- The threshold monitoring for NSSI performance measurements has been created for the authorized consumer.</li> </ul> | | +| <b>Begins when</b> | The authorized consumer needs to terminate the performance threshold monitoring for NSSI performance measurements. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the management service producer to terminate the performance threshold monitoring for NSSI performance measurements. | | +| <b>Step 2 (M)</b> | The management service producer stops the subject threshold monitoring, and requests the NSSI(s) to stop monitoring the performance measurements. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The threshold monitoring for NSSI performance measurements is stopped. | | +| <b>Traceability</b> | | | + +### 5.1.3 NSI PM services + +#### 5.1.3.1 NSI measurement job control service + +##### 5.1.3.1.1 Creation of measurement job for NSI(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to create a measurement job for collecting the performance data of NSI(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NSI measurement job control service. | | +| <b>Telecom resources</b> | NSI(s);<br>NSI measurement job control service producer;<br><br>The set of<br>NSSI measurement job control service producer,<br>NSSI performance data file reporting service producer and/or NSSI performance data streaming service producer; and/or<br>The set of<br>NF measurement job control service producer,<br>NF performance data file reporting service producer and/or NF performance data streaming service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The NSI(s) have been deployed.<br>- The NSI measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to create measurement job for collecting the performance data of NSI(s). | | +| <b>Step 1 (M)</b> | The authorized consumer requests the NSI measurement job control service producer to create a NSI measurement job to collect the performance data of NSI(s).<br>The request needs to indicate that the performance data needs to be reported by performance data file or by performance data streaming. | | +| <b>Step 2 (M)</b> | The NSI measurement job control service producer decomposes the performance data type of NSI(s) into performance data type(s) of the constituent NSSI(s) and/or of constituent NF(s).<br>- The NSI measurement job control service producer checks whether the decomposed performance data of the constituent NSSI(s) can be collected by the existing measurement job(s) for NSSI(s). If new measurement job(s) for the constituent NSSI(s) are required, the NSI measurement job control service producer consumes the NSSI measurement job control service to create the new measurement job(s) for the constituent NSSI(s) (according to the use case "Creation of measurement job for NSSI(s)" as described in clause 5.1.2.1.1); or<br>- The NSI measurement job control service producer checks whether the decomposed performance data of the constituent NF(s) can be collected by the existing measurement job(s) for NF(s). If new measurement job(s) for the constituent NF(s) are required, NSI measurement job control service producer requests the NF PM measurement job control service producer to create the new measurement job(s) for the constituent NF(s) (according to the use case "Creation of measurement job for NF" as described in clause 5.1.1.1.1). | Creation of measurement job for NSSI; and/or<br>Creation of measurement job for NF | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The measurement job for NSI has been created, and the NSI measurement job control service producer consumes the NSSI performance data file reporting service, NSSI performance data streaming service, the NF performance data file reporting service and/or NF performance data streaming service to get the performance data of the constituent NSSI(s) and/or NF(s), and generates the performance data for the NSI measurement job. | NSSI performance data file reporting;<br><br>NSSI performance data streaming<br><br>NF performance data file reporting;<br><br>and/or<br><br>NF performance data streaming | +| <b>Traceability</b> | REQ-MJCS_NSI-FUN-1, REQ-MJCS_NSI-FUN-2, REQ-MJCS_NSI-FUN-3, REQ-MJCS_NSI-FUN-4 and REQ-MJCS_NSI-FUN-7. | | + +##### 5.1.3.1.2 Termination of measurement job for NSI(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to request the NSI measurement job control service producer to terminate a NSI measurement job. | | +| <b>Actors and Roles</b> | An authorized consumer of NSI measurement job control service. | | +| <b>Telecom resources</b> | NSI(s);<br>NSI measurement job control service producer;<br>NSSI measurement job control service producer;<br>NF measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSI measurement job has been created. | | +| <b>Begins when</b> | The authorized consumer does not need the NSI measurement job. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the NSI measurement job control service producer to terminate a NSI measurement job that is collecting the performance data of NSI(s). | | +| <b>Step 2 (M)</b> | The NSI measurement job control service producer terminates the NSI measurement job, and may<br>- consume the NSSI measurement job control service to request termination of the supporting measurement job(s) of the constituent NSSI(s) if any (according to the use case "Termination of measurement job for NSSI(s)" as described in clause 5.1.2.1.2), and<br>- consume the NF measurement job control service to request termination of the supporting measurement job(s) of the constituent NF(s) if any (according to the use case "Termination of measurement job for NF(s)" as described in clause 5.1.1.1.2). | Termination of measurement job for NSSI(s);<br><br>Termination of measurement job for NF(s) | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The NSI measurement job is terminated, or still retained to serve other consumers according to step 2. | | +| <b>Traceability</b> | <b>REQ-MJCS_NSI-FUN-5</b> | | + +##### 5.1.3.1.3 Query of measurement jobs for NSI(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to query the ongoing NSI measurement jobs (i.e. the NSI measurement jobs that have been created by the subject consumer and not terminated). | | +| <b>Actors and Roles</b> | An authorized consumer of NSI measurement job control service. | | +| <b>Telecom resources</b> | NSI(s)<br>NSI measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The NSI measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to query the ongoing NSI measurement jobs. | | +| <b>Step 1 (M)</b> | The authorized consumer queries the information about the ongoing NSI measurement jobs from the NSI measurement job control service producer. | | +| <b>Step 2 (M)</b> | The NSI measurement job control service producer provides the information about the ongoing NSI measurement jobs to the consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The information about the ongoing NSI measurements jobs are available to the consumer. | | +| <b>Traceability</b> | <b>REQ-MJCS_NSI-FUN-6</b> | | + +#### 5.1.3.2 NSI performance data file reporting service + +##### 5.1.3.2.1 NSI performance data file reporting + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to get the performance data file of 3GPP NSI(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NSI performance data file reporting service. | | +| <b>Telecom resources</b> | Producer of the NSI performance data file reporting service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSI has been deployed.</li> <li>- The NSI performance data file reporting service producer is in operation.</li> <li>- The NSI performance data file reporting service consumer has subscribed the notification about performance data file ready.</li> </ul> | | +| <b>Begins when</b> | The performance data file of 3GPP NSI(s) is ready at the NSI performance data file reporting service producer. | | +| <b>Step 1 (M)</b> | The NSI performance data file reporting service producer sends the notification about performance data file ready to the authorized consumer. | | +| <b>Step 2 (M)</b> | The authorized consumer fetches the performance data file from the NSI performance data file reporting service producer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The performance data file of 3GPP NSI have been reported. | | +| <b>Traceability</b> | REQ-PDFR_NSI-FUN-1, REQ-PDFR_NSI-FUN-2 | | + +#### 5.1.3.3 NSI performance data streaming service + +##### 5.1.3.3.1 NSI performance data streaming + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to receive the performance data stream of NSI(s). | | +| <b>Actors and Roles</b> | An authorized consumer of NSI performance data streaming service. | | +| <b>Telecom resources</b> | Producer of the NSI performance data streaming service. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSI has been deployed.</li> <li>- The NSI performance data streaming service producer is in operation.</li> <li>- The NSI performance data streaming service consumer has subscribed for receiving the performance data stream from the NSI performance data streaming service producer.</li> </ul> | | +| <b>Begins when</b> | The performance data of 3GPP NSI is ready at the NSI performance data streaming service producer. | | +| <b>Step 1 (M)</b> | The NSI performance data streaming service producer sends the NSI performance data stream to the consumer. | | +| <b>Ends when</b> | The NSI performance data streaming service consumer receives the performance data stream. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | | | +| <b>Traceability</b> | REQ-PDS_NSI-FUN-1 | | + +#### 5.1.3.4 NSI performance threshold monitoring + +##### 5.1.3.4.1 Creation of threshold monitoring for NSI performance measurements + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request creation of threshold monitoring for NSI performance measurements. | | +| <b>Actors and Roles</b> | An authorized consumer monitoring service for NSI performance threshold monitoring. | | +| <b>Telecom resources</b> | Producer of management service for NSI performance threshold monitoring. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSI has been deployed.</li> <li>- The management service for NSI performance threshold monitoring is in operation.</li> <li>- The authorized consumer of management service for NSI performance threshold monitoring has subscribed to the threshold crossing notifications.</li> </ul> | | +| <b>Begins when</b> | The authorized consumer needs to create performance threshold monitoring for NSI performance measurements. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the management service producer to create performance threshold monitoring for NSI performance measurements. The request contains the threshold information with the conditions for triggering the threshold crossing notifications. | | +| <b>Step 2 (M)</b> | The management service producer for NSI performance threshold monitoring requests the NSI(s) to monitor the performance measurements. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | <p>The NSI performance threshold monitoring has been created.</p> <p>The NSI monitors the performance measurements, and when the condition is met (e.g., a specific threshold is crossed or reached), the NSI</p> <ul style="list-style-type: none"> <li>- sends the threshold crossing notification to the consumer; or</li> <li>- reports the threshold crossing event to NSI performance threshold monitoring service producer, who then sends the threshold crossing notification to the consumer.</li> </ul> | | +| <b>Traceability</b> | | | + +##### 5.1.3.4.2 Termination of threshold monitoring for NSI performance measurements + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request termination of threshold monitoring for NSI performance measurements. | | +| <b>Actors and Roles</b> | An authorized consumer of management service for NSI performance threshold monitoring. | | +| <b>Telecom resources</b> | Producer of management service for NSI performance threshold monitoring. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The 3GPP NSI has been deployed.</li> <li>- The producer of management service for NSI performance threshold monitoring is in operation.</li> <li>- The threshold monitoring for NSI performance measurements has been created for the authorized consumer.</li> </ul> | | +| <b>Begins when</b> | The authorized consumer needs to terminate the performance threshold monitoring for NSI performance measurements. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the management service producer to terminate the performance threshold monitoring for NSI performance measurements. | | +| <b>Step 2 (M)</b> | The management service producer stops the subject threshold monitoring, and requests the NSI(s) to stop monitoring the performance measurements. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The threshold monitoring for NSI performance measurements is stopped. | | +| <b>Traceability</b> | | | + +### 5.1.4 Network/Sub-network PM services + +#### 5.1.4.1 Network/Sub-network measurement job control service + +##### 5.1.4.1.1 Creation of measurement job for network(s)/sub-network(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to create a measurement job for collecting the network/sub-network performance data that are not specific to network slicing. | | +| <b>Actors and Roles</b> | An authorized consumer of network measurement job control service. | | +| <b>Telecom resources</b> | Network(s)/sub-network(s);<br>Network measurement job control service producer;<br>NF measurement job control service producer;<br>NF performance data file reporting service producer and/or NF performance data streaming service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The network(s)/sub-network(s) have been deployed;<br>- The network measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to create a network measurement job for collecting the network performance data that are not specific to network slicing. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the network measurement job control service producer to create measurement job to collect the network performance data that are not specific to network slicing.<br>The request needs to indicate that the performance data needs to be reported by performance data file or by performance data streaming. | | +| <b>Step 2 (M)</b> | The network measurement job control service producer decomposes the performance data type of network/sub-network into performance data type(s) of the constituent 3GPP NF(s).<br>The network measurement job control service producer whether the decomposed performance data type(s) of the constituent NF(s) can be collected by the existing measurement job(s) for NF(s). If new measurement job(s) for the constituent NF(s) are required, the network measurement job control service producer requests the NF measurement job control service producer to create the new measurement job(s) for the constituent NF(s) (according to the use case "Creation of measurement job for NF" as described in clause 5.1.1.1.1). | Creation of measurement job for NF | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The measurement job for network(s)/sub-network(s) has been created, and the network measurement job control service producer consumes the NF performance data file reporting service and/or NF performance data streaming service to get the performance data of the constituent NF(s), and generates the performance data for the network measurement job. | NF performance data file reporting;<br>NF performance data streaming | +| <b>Traceability</b> | REQ-MJCS_NW-FUN-1, REQ-MJCS_NW-FUN-2, REQ-MJCS_NW-FUN-3, REQ-MJCS_NW-FUN-4 and REQ-MJCS_NW-FUN-7 | | + +##### 5.1.4.1.2 Termination of measurement job for network(s)/sub-network(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to request the network measurement job control service producer to terminate a network measurement job. | | +| <b>Actors and Roles</b> | An authorized consumer of network measurement job control service. | | +| <b>Telecom resources</b> | NSSI(s);<br>Network measurement job control service producer;<br>NF measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The network measurement job has been created. | | +| <b>Begins when</b> | The authorized consumer does not need the network measurement job. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the network measurement job control service producer to terminate a network measurement job that is collecting the performance data of network(s)/sub-network(s). | | +| <b>Step 2 (M)</b> | The network measurement job control service producer terminates the network measurement job, and may consume the NF measurement job control service to request termination of the supporting measurement job(s) of the constituent NF(s) (according to the use case "Termination of measurement job for NF(s)" as described in clause 5.1.1.1.2). | Termination of measurement job for NF(s) | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The network measurement job is terminated, or still retained to serve other consumers according to step 2. | | +| <b>Traceability</b> | REQ-MJCS_NW-FUN-5 | | + +##### 5.1.4.1.3 Query of measurement jobs for network(s) + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to query the ongoing network measurement jobs (i.e. the network measurement jobs that have been created by the subject consumer and not terminated). | | +| <b>Actors and Roles</b> | An authorized consumer of network measurement job control service. | | +| <b>Telecom resources</b> | Network(s)/sub-network(s)<br>Network measurement job control service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The network measurement job control service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to query the ongoing network measurement jobs. | | +| <b>Step 1 (M)</b> | The authorized consumer queries the information about the ongoing network measurement jobs from the network measurement job control service producer. | | +| <b>Step 2 (M)</b> | The network measurement job control service producer provides the information about the ongoing network measurement jobs to the consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The information about the ongoing network measurements jobs are available to the consumer. | | +| <b>Traceability</b> | REQ-MJCS_NW-FUN-6 | | + +#### 5.1.4.2 Network/Sub-network performance data file reporting service + +##### 5.1.4.2.1 Network/Sub-network performance data file reporting + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to get the network/sub-network performance data that are not specific to network slicing. | | +| <b>Actors and Roles</b> | An authorized consumer of network/sub-network performance data file reporting service. | | +| <b>Telecom resources</b> | Network/sub-network performance data file reporting service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The network/sub-network has been deployed.</li> <li>- The network/sub-network performance data file reporting service producer is in operation.</li> <li>- The network/sub-network performance data file reporting service consumer has subscribed the notification about performance data file ready.</li> </ul> | | +| <b>Begins when</b> | The performance data file of network/sub-network is ready at the network/sub-network performance data file reporting service producer. | | +| <b>Step 1 (M)</b> | The network/sub-network performance data file reporting service producer sends the notification about performance data file ready to the authorized consumer. | | +| <b>Step 2 (M)</b> | The authorized consumer fetches the network /sub-network performance data file from the network/sub-network performance data file reporting service producer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The network/sub-network performance data file have been reported. | | +| <b>Traceability</b> | <b>REQ-PDFR_NW-FUN-1, REQ-PDFR_NW-FUN-2</b> | | + +#### 5.1.4.3 Network/Sub-network performance data streaming service + +##### 5.1.4.3.1 Network/Sub-network performance data streaming + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to receive the stream of the network/sub-network performance data that are not specific to network slicing. | | +| <b>Actors and Roles</b> | An authorized consumer of network/sub-network performance data streaming service. | | +| <b>Telecom resources</b> | Network/Sub-network performance data streaming service producer. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | <ul style="list-style-type: none"> <li>- The network/sub-network has been deployed.</li> <li>- The network/sub-network performance data streaming service producer is in operation.</li> <li>- The network/sub-network performance data streaming service consumer has subscribed for receiving the performance data stream from the network/sub-network performance data streaming service producer.</li> </ul> | | +| <b>Begins when</b> | The performance data of network is ready at the network/sub-network performance data streaming service producer. | | +| <b>Step 1 (M)</b> | The network/sub-network performance data streaming service producer sends the network/sub-network performance data stream to the consumer. | | +| <b>Ends when</b> | The Network/sub-network performance data streaming service consumer receives the network performance data stream. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | | | +| <b>Traceability</b> | <b>REQ-PDS_NW-FUN-1</b> | | + +### 5.1.5 Management data analytics + +#### 5.1.5.1 Management data analytics for NSIs/NSSIs + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to collect management analytical data for NSIs/NSSIs. | | +| <b>Actors and Roles</b> | An authorized consumer of management data analytics service. | | +| <b>Telecom resources</b> | NSI(s), NSSI(s), NF(s);<br>Producer of management data analytics service;<br>Producer of measurement job control service for NSI(s);<br>Producer of measurement job control service for NSSI(s);<br>Producer of measurement job control service for NF(s);<br>Producer of performance data file reporting service for NSI(s);<br>Producer of performance data file reporting service for NSSI(s);<br>Producer of performance data file reporting service for NF(s); | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The NSI(s) have been deployed.<br>- The management data analytics service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer subscribes to the management analytical data for NSI(s)/NSSI(s). | | +| <b>Step 1 (M)</b> | The management data analytics service producer determines what performance measurements of NSI(s), NSSI(s) and NF(s) are needed to generate the subject management analytical data. | | +| <b>Step 2 (M)</b> | The management data analytics service producer checks whether the required NSI performance measurements can be collected by the existing measurement job(s) for NSI(s), NSSI(s) and NF(s).<br>- If new measurement job(s) for the NSI(s) are required, the management data analytics service producer consumes the NSI measurement job control service to create the new measurement job(s) for the NSI(s) (according to the use case "Creation of measurement job for NSI(s)" as described in clause 5.1.3.1.1);<br>- If new measurement job(s) for the NSSI(s) are required, the management data analytics service producer consumes the NSSI measurement job control service to create the new measurement job(s) for the NSSI(s) (according to the use case "Creation of measurement job for NSSI(s)" as described in clause 5.1.2.1.1);<br>- If new measurement job(s) for the NF(s) are required, the management data analytics service producer consumes the NF measurement job control service to create the new measurement job(s) for the NF(s) (according to the use case "Creation of measurement job for NF(s)" as described in clause 5.1.1.1.1). | Creation of measurement job for NSI(s);<br>Creation of measurement job for NSSI(s);<br>Creation of measurement job for NF(s) | +| <b>Ends when</b> | The consumer unsubscribes to the management analytical data for NSI(s)/NSSI(s). | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The management data analytics service producer consumes the performance data reporting related services to get the required performance measurements for NSI(s), NSSI(s) and NF(s), generate the management analytical data based on the collected performance measurements, and makes the management analytical data available to the management service responsible for reporting the data. | | +| <b>Traceability</b> | <b>REQ-MDAS-FUN-1</b> | | + +#### 5.1.5.2 Management data analytics for network + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| <b>Goal</b> | To enable the authorized consumer to collect management analytical data for the network. | | +| <b>Actors and Roles</b> | An authorized consumer of network management data analytics service. | | +| <b>Telecom resources</b> | 3GPP network(s);<br>Producer of network management data analytics service;<br>Producer of measurement job control service for NF(s);<br>Producer of performance data file reporting service for NF(s); | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The 3GPP network(s) have been deployed.<br>- The network management data analytics service producer is in operation. | | +| <b>Begins when</b> | The authorized consumer subscribes to the service of management analytical data for network(s). | | +| <b>Step 1 (M)</b> | The network management data analytics service producer determines what performance measurements of NF(s) are needed to generate the subject network management analytical data. | | +| <b>Step 2 (M)</b> | The management data analytics service producer checks whether the required network performance measurements can be collected by the existing measurement job(s) for NF(s).<br>- If new measurement job(s) for the constituent NF(s) are required, the management data analytics service producer consumes the NF measurement job control service to create the new measurement job(s) for the NF(s) (according to the use case "Creation of measurement job for NF(s)" as described in clause 5.1.1.1.1). | Creation of measurement job for NF(s) | +| <b>Step 3 (M)</b> | The management data analytics service producer consumes the performance data reporting related services to get the required performance measurements for NF(s) and generates the management analytical KPI(s) based on the collected performance measurements. | | +| <b>Ends when</b> | The consumer unsubscribes to the management analytical data for network(s). | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The management analytical data is available to the management service responsible for reporting the data to the consumer. | | +| <b>Traceability</b> | REQ-MDAS-FUN-2 | | + +### 5.1.6 MnS responsible for KPI job control + +#### 5.1.6.1 Creation of KPI job + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to create a KPI job for collecting the KPIs of one or more object instance(s). | | +| <b>Actors and Roles</b> | An authorized consumer of the MnS responsible for KPI job control. | | +| <b>Telecom resources</b> | NSSI(s), Network slice(s), Network(s)/sub-network(s);<br>Producer of the MnS responsible for KPI job control.<br>Producers of measurement job control services | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | - The NF(s), NSSI(s), Network slice(s) and Network(s)/sub-network(s) have been deployed.<br>- The producer of the MnS responsible for KPI job control is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to create KPI job for collecting the KPIs of one or more object instance(s). | | +| <b>Step 1 (M)</b> | The authorized consumer requests the producer of the MnS responsible for KPI job control to create KPI job to calculate and collect the KPIs of the subject object instance(s).<br>The request needs to indicate that the KPIs needs to be reported by performance data file or by performance data streaming. | | +| <b>Step 2 (M)</b> | The producer of the MnS responsible for KPI job control identifies the performance measurement type(s) used for the KPI(s) and checks whether the corresponding performance measurement type(s) can be collected by the existing measurement job(s). | | +| <b>Step 3 (M)</b> | If measurement(s) are missing for the calculation of KPI(s), the management function hosting the producer of the MnS responsible for KPI job control would consume the necessary measurement MnS, for the missing measurement(s). | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The KPI job for the subject object instance(s) has been created, and the producer of the MnS responsible for KPI job control generates the KPIs for the KPI job. | | +| <b>Traceability</b> | <b>REQ- KJCS_FUN-1, REQ- KJCS_FUN-2, REQ- KJCS_FUN-3</b> | | + +#### 5.1.6.2 Termination of KPI job + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to request the producer of the MnS responsible for KPI job control to terminate a KPI job. | | +| <b>Actors and Roles</b> | An authorized consumer of the MnS responsible for KPI job control. | | +| <b>Telecom resources</b> | NSSI(s), Network slice(s), Network(s)/sub-network(s);<br>The producer of the MnS responsible for KPI job control. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The KPI job has been created. | | +| <b>Begins when</b> | The authorized consumer does not need the KPI job that is calculating or collecting the KPIs. | | +| <b>Step 1 (M)</b> | The authorized consumer requests the producer of the MnS responsible for KPI job control to terminate a KPI job that is calculating or collecting the KPIs. | | +| <b>Step 2 (M)</b> | The producer of the MnS responsible for KPI job control terminates the KPI job. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The KPI job is terminated | | +| <b>Traceability</b> | <b>REQ- KJCS_FUN-4</b> | | + +#### 5.1.6.3 Query of KPI jobs + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the authorized consumer to query which KPI jobs are ongoing (i.e. the KPI jobs that have been created by the subject consumer and not terminated). | | +| <b>Actors and Roles</b> | An authorized consumer of the MnS responsible for KPI job control. | | +| <b>Telecom resources</b> | NSSI(s), Network slice(s), Network(s)/sub-network(s);<br>The producer of the MnS responsible for KPI job control. | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The producer of the MnS responsible for KPI job control is in operation. | | +| <b>Begins when</b> | The authorized consumer needs to query the ongoing KPI jobs. | | +| <b>Step 1 (M)</b> | The authorized consumer queries the information which KPI jobs are ongoing from the producer of the MnS responsible for KPI job control. | | +| <b>Step 2 (M)</b> | The producer of the MnS responsible for KPI job control provides the information which KPI jobs are ongoing to the consumer. | | +| <b>Ends when</b> | All the steps identified above are successfully completed. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | The information about the ongoing KPI jobs are available to the consumer. | | +| <b>Traceability</b> | <b>REQ- KJCS_FUN-5</b> | | + +### 5.1.7 Performance management supporting multiple tenants in the NSaaS scenario + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| <b>Goal</b> | To enable the tenant obtain their own network slice performance data in the Network Slice as a Service (NSaaS) scenario. | | +| <b>Actors and Roles</b> | Tenant plays the role of network slice performance data consumer | | +| <b>Telecom resources</b> | Network slice performance data provider as the network slice performance data file/streaming report MnS producer<br>Network slice subnet data provider as the network slice subnet performance data file/streaming report MnS producer | | +| <b>Assumptions</b> | N/A | | +| <b>Pre-conditions</b> | The tenant related S-NSSAI(s) is configured for network slice | | +| <b>Begins when</b> | The authorized network slice performance data consumer(s) (i.e. tenant) request the network slice performance data provider to report his own performance data. | | +| <b>Step 1 (M)</b> | Network slice performance data provider request the network slice subnet performance data provider report the network slice subnet and/or network function performance data with information indicating the performance data needs to be collected in S-NSSAI granularity. | | +| <b>Step 2 (M)</b> | Network slice subnet performance data provider report the network slice subnet performance data, and the network slice subnet performance data in S-NSSAI granularity should be included (i.e. which means the corresponding S-NSSAI(s) is included in the network slice subnet performance data) | | +| <b>Step 3 (M)</b> | Based on the network slice subnet performance data in S-NSSAI granularity, the network slice performance data provider derive the network slice performance data for the tenant (e.g. calculate the network slice performance data based on all the network slice subnet performance data related to corresponding S-NSSAI(s)). | | +| <b>Ends when</b> | Network slice performance data provider report the tenant's own network slice performance data to the tenant, the S-NSSAI information may be included. | | +| <b>Exceptions</b> | One of the steps identified above fails. | | +| <b>Post-conditions</b> | Tenant obtain their own network slice performance data individually in the Network Slice as a Service (NSaaS) scenario. | | +| <b>Traceability</b> | <b>REQ-PM_NSI-FUN-1</b> | | + +## 5.2 Requirements + +### 5.2.1 Requirements for NF measurement job control service + +**REQ-MJCS\_NF-FUN-1** The management service producer responsible for NF measurement job control shall have the capability allowing its authorized consumer to request creation of a measurement job to collect the performance data of NF(s). + +**REQ-MJCS\_NF-FUN-2** The management service producer responsible for NF measurement job control shall have the capability allowing its authorized consumer to indicate the reporting method (i.e. by performance data file or by performance data streaming) for the performance data when requesting to create a measurement job for NF(s). + +**REQ-MJCS\_NF-FUN-3** The management service producer responsible for NF measurement job control shall have the capability to fulfill the consumer's request to create a measurement job for NF(s). + +**REQ-MJCS\_NF-FUN-4** The management service producer responsible for NF measurement job control shall have the capability to generate the performance data of NF(s) according to the measurement job. + +**REQ-MJCS\_NF-FUN-5** The management service producer responsible for NF measurement job control shall have the capability to fulfill the request from its authorized consumer to terminate a NF measurement job. + +**REQ-MJCS\_NF-FUN-6** The management service producer responsible for NF measurement job control shall have the capability allowing its authorized consumer to query the information about the ongoing NF measurement jobs. + +**REQ-MJCS\_NF-FUN-7** The management service producer responsible for NF measurement job control may reject a NF measurement job creation request. + +### 5.2.2 Requirements for NF performance data file reporting service + +**REQ-PDFR\_NF-FUN-1** The management service producer responsible for NF performance data file reporting shall have the capability to send the notification about NF performance data file ready to its authorized consumer. + +**REQ-PDFR\_NF-FUN-2** The management service producer responsible for NF performance data file reporting shall have the capability to allow its authorized consumer to fetch the performance data file of NF(s). + +### 5.2.3 Requirements for NF performance data streaming service + +**REQ-PDS\_NF-FUN-1** The management service producer responsible for NF performance data streaming shall have the capability to send the NF performance data stream to its authorized consumer. + +### 5.2.4 Requirements for NSSI measurement job control service + +**REQ-MJCS\_NSSI-FUN-1** The management service producer responsible for NSSI measurement job control shall have the capability allowing its authorized consumer to request creation of a measurement job to collect the performance data of NSSI(s). + +**REQ-MJCS\_NSSI-FUN-2** The management service producer responsible for NSSI measurement job control shall have the capability allowing its authorized consumer to indicate the reporting method (i.e. by performance data file or by performance data streaming) for the performance data when requesting to create a measurement job for NSSI(s). + +**REQ-MJCS\_NSSI-FUN-3** The management service producer responsible for NSSI measurement job control shall have the capability to generate the performance data of NSSI(s). + +**REQ-MJCS\_NSSI-FUN-4** The management service producer responsible for NSSI measurement job control shall have the capability to fulfill the consumer's request to create a measurement job for NSSI(s). + +**REQ-MJCS\_NSSI-FUN-5** The management service producer responsible for NSSI measurement job control shall have the capability to fulfill the request from its authorized consumer to terminate a NSSI measurement job. + +**REQ-MJCS\_NSSI-FUN-6** The management service producer responsible for NSSI measurement job control shall have the capability to fulfil the request from its authorized consumer to query the information about the ongoing NSSI measurement jobs. + +**REQ-MJCS\_NSSI-FUN-7** The management service producer responsible for NSSI measurement job control may reject a NSSI measurement job creation request. + +### 5.2.5 Requirements for NSSI performance data file reporting service + +**REQ-PDFR\_NSSI-FUN-1** The management service producer responsible for NSSI performance data file reporting shall have the capability to send the notification about NSSI performance data file ready to its authorized consumer. + +**REQ-PDFR\_NSSI-FUN-2** The management service producer responsible for NSSI performance data file reporting shall have the capability to allow its authorized consumer to fetch the performance data file of NSSI(s). + +### 5.2.6 Requirements for NSSI performance data streaming service + +**REQ-PDS\_NSSI-FUN-1** The management service producer responsible for NSSI performance data streaming shall have the capability to send the NSSI performance data stream to its authorized consumer. + +### 5.2.7 Requirements for NSI measurement job control service + +**REQ-MJCS\_NSI-FUN-1** The management service producer responsible for NSI measurement job control shall have the capability allowing its authorized consumer to request creation of a measurement job to collect the performance data of NSI(s). + +**REQ-MJCS\_NSI-FUN-2** The management service producer responsible for NSI measurement job control shall have the capability allowing its authorized consumer to indicate the reporting method (i.e. by performance data file or by performance data streaming) for the performance data when requesting to create a measurement job for NSI(s). + +**REQ-MJCS\_NSI-FUN-3** The management service producer responsible for NSI measurement job control shall have the capability to generate the performance data of NSI(s). + +**REQ-MJCS\_NSI-FUN-4** The management service producer responsible for NSI measurement job control shall have the capability to fulfill the consumer's request to create a measurement job for NSI(s). + +**REQ-MJCS\_NSI-FUN-5** The management service producer responsible for management service producer responsible for NSI measurement job control shall have the capability to fulfill the request from its authorized consumer to terminate a NSI measurement job. + +**REQ-MJCS\_NSI-FUN-6** The management service producer responsible for NSI measurement job control shall have the capability to fulfill the request from its authorized consumer to query the information about the ongoing NSI measurement jobs. + +**REQ-MJCS\_NSI-FUN-7** The management service producer responsible for NSI measurement job control may reject a NSI measurement job creation request. + +### 5.2.8 Requirements for NSI performance data file reporting service + +**REQ-PDFR\_NSI-FUN-1** The management service producer responsible for NSI performance data file reporting shall have the capability to send the notification about NSI performance data file ready to its authorized consumer. + +**REQ-PDFR\_NSI-FUN-2** The management service producer responsible for NSI performance data file reporting shall have the capability to allow its authorized consumer to fetch the performance data file of NSI(s). + +### 5.2.9 Requirements for NSI performance data streaming service + +**REQ-PDS\_NSI-FUN-1** The management service producer responsible for NSI performance data streaming shall have the capability to send the NSI performance data stream to its authorized consumer. + +### 5.2.10 Requirements for network/sub-network measurement job control service + +**REQ-MJCS\_NW-FUN-1** The management service producer responsible for network/sub-network measurement job control shall have the capability allowing its authorized consumer to request creation of a measurement job to collect the network/sub-network performance data that are not specific to network slicing. + +**REQ-MJCS\_NW-FUN-2** The management service producer responsible for network/sub-network measurement job control shall have the capability allowing its authorized consumer to indicate the reporting method (i.e. by performance data file or by performance data streaming) for the performance data that are not specific to network slicing when requesting to create a measurement job for network(s)/sub-network(s). + +**REQ-MJCS\_NW-FUN-3** The management service producer responsible for network/sub-network measurement job control shall have the capability to generate the network/sub-network performance data that are not specific to network slicing. + +**REQ-MJCS\_NW-FUN-4** The management service producer responsible for network/sub-network measurement job control shall have the capability to fulfill the consumer's request to create a measurement job for network(s)/sub-network(s). + +**REQ-MJCS\_NW-FUN-5** The management service producer responsible for network/sub-network measurement job control shall have the capability to fulfill the request from its authorized consumer to terminate a network/sub-network measurement job. + +**REQ-MJCS\_NW-FUN-6** The management service producer responsible for network/sub-network measurement job control shall have the capability to fulfill the request from its authorized consumer to query the information about the ongoing network measurement jobs. + +**REQ-MJCS\_NW-FUN-7** The management service producer responsible for network/sub-network measurement job control may reject a network/sub-network measurement job creation request. + +### 5.2.11 Requirements for network/sub-network performance data file reporting service + +**REQ-PDFR\_NW-FUN-1** The management service producer responsible for network/sub-network performance data file reporting shall have the capability to send the notification about network/sub-network performance data file ready to its authorized consumer. + +**REQ-PDFR\_NW-FUN-2** The management service producer responsible for network/sub-network performance data file reporting shall have the capability to allow its authorized consumer to fetch the performance data file of network(s)/sub-network(s). + +### 5.2.12 Requirements for network/sub-network performance data streaming service + +**REQ-PDS\_NW-FUN-1** The management service producer responsible for network/sub-network performance data streaming shall have the capability to send the network/sub-network performance data stream to its authorized consumer. + +### 5.2.13 Management data analytics service + +**REQ-MDAS-FUN-1** The management data analytics service producer shall have the capability allowing its authorized consumer to request collection of management analytical data for NSIs/NSSIs. + +**REQ-MDAS-FUN-2** The management data analytics service producer shall have the capability allowing its authorized consumer to request collection of management analytical data for network(s). + +### 5.2.14 Management service for NF performance threshold monitoring + +**REQ-THMS\_NF-FUN-1** The management service producer responsible for NF performance threshold monitoring shall have the capability to fulfill the consumer's request to create a performance threshold monitoring for the performance measurements of NF(s). + +**REQ-THMS\_NF-FUN-2** The management service producer responsible for NF performance threshold monitoring shall have the capability to fulfill the request from its authorized consumer to terminate a performance threshold monitoring. + +**REQ-THMS\_NF-FUN-3** The management service producer responsible for NF performance threshold monitoring shall have the capability to allow the threshold monitoring notification target to receive the threshold crossing notifications. + +### 5.2.15 Requirements for MnS responsible for KPI production + +**REQ-KJCS\_FUN-1** The management service producer responsible for KPI production shall have the capability allowing its authorized consumer to request production of KPI(s) of one or more object instance(s). + +**REQ-KJCS\_FUN-2** The management service producer responsible for KPI production shall have the capability allowing its authorized consumer to indicate the reporting method (i.e. by performance data file or by performance data streaming) for the KPI(s). + +**REQ-KJCS\_FUN-3** The management service producer responsible for KPI production shall have the capability to produce KPI(s) of one or more object instance(s) according to request of its authorized consumer. + +**REQ-KJCS\_FUN-4** The management service producer responsible for KPI production shall have the capability allowing its authorized consumer to request termination of the production of KPI(s). + +**REQ-KJCS\_FUN-5** The management service producer responsible for KPI production shall have the capability allowing its authorized consumer to query the information which KPI jobs are ongoing. + +### 5.2.16 Requirements for performance management supporting multiple tenants + +**REQ-PM\_NSI-FUN-1** The network slice performance data provider shall have the capability to allow its authorized consumer(s) acting the role of tenant to obtain its own network slice performance data in the Network Slice as a Service scenario. + +# --- 6. Performance assurance specific operations and notifications + +## 6.1 Measurement job control related operations + +### 6.1.1 Operation createMeasurementJob (M) + +#### 6.1.1.1 Definition + +This operation supports the authorized consumer to request the procedure of measurement job control related MnS or KPI job control related MnS to create a measurement job. + +One measurement job can collect the value of one or multiple measurement types which are the performance measurements and assurance data defined in TS 28.552 [2], or collect the value of one or multiple KPIs defined in TS 28.554 [21]. + +When a measurement type or KPI is collected by one measurement job for a given instance (e.g., an NF instance or a subnetwork instance), another measurement job creation request which wants to collect the same measurement type or KPI for the same instance with different granularity period may be rejected. This behaviour shall be consistent for a given implementation by a specific management service producer. + +There are two different methods for the performance data to be reported: + +- Performance data file method: In this method the performance data is accumulated for certain time before it is reported; the data will be delivered as a file. +- Performance data streaming method: In this method, the performance data streaming producer, when the performance data are ready, sends the performance data to the consumer (i.e., stream target). The volume of the performance data reported by streaming is expected to be small, and the Granularity period of the performance data stream needs to be configurable and is expected to be short. + +#### 6.1.1.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| iOCName | M | The IOC name defined of the NRMs (e.g., as defined in TS 28.541 [3]), or the class name defined locally in the performance data related specifications (e.g., TS 28.552 [2], TS 28.554 [21]). | It specifies one object class name. The consumer requests to collect one or more measurement type(s) of the instances of this class. | +| iOCInstanceList | M | List of DN | <p>It specifies the list of DNs of object instances whose measurements or KPIs of the corresponding type(s) are to be collected.</p> <p>An empty list means that for all instances (including the object instances existing at the time of measurement job creation, and the instances added later) known by the management service producer the measurements or KPIs will be collected.</p> <p>If the MnS consumer represents a tenant, the object instances to be collected measurements should satisfy the conditions listed in Clause 4.4.</p> | +| measurementCategoryList | M | List of measurement type names (see TS 28.552 [2]) or KPI names (see TS 28.554 [21]). | <p>It specifies the measurement type(s) or KPI(s) to be measured.</p> <p>If the measurement job is for the collection of performance measurement(s), the elements of the measurementCategoryList shall be one of the following forms:</p> <ul style="list-style-type: none"> <li>- The form "family.measurementName.subcounter" can be used in order to retrieve a specified subcounter of a measurement type.</li> <li>- The form "family.measurementName" can be used in order to retrieve a specific measurement type. In case the measurement type includes subcounters, all subcounters will be retrieved.</li> <li>- The form "family" can be used in order to retrieve all measurement types in this family.</li> </ul> <p>If the measurement job is for the collection of KPI(s), the elements of the measurementCategoryList shall be the KPI name defined in TS 28.554 [21].</p> | +| reportingMethod | M | The reporting method of the collected performance data. | <p>It specifies the method for the collected performance data to be reported. One of the following methods can be selected:</p> <ul style="list-style-type: none"> <li>- by performance data file</li> <li>- by performance data streaming (optional).</li> </ul> | +| granularityPeriod | M | The period between generation of two successive measurements. | <p>The management service producer will produce the value of the measurements or KPIs at the end of each granularityPeriod.</p> <p>For performance measurements collection:</p> <p>If the reportingMethod is performance data file reporting:</p> <ul style="list-style-type: none"> <li>- The value of granularityPeriod can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours or 24 hours or other values (see Note 1 below).</li> </ul> <p>If the reportingMethod is performance data streaming:</p> <ul style="list-style-type: none"> <li>- The value of granularityPeriod is an integer value in seconds (see Note 1 below).</li> </ul> <p>For KPIs collection:</p> <ul style="list-style-type: none"> <li>- The value of granularityPeriod can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours or 24 hours or other values (see Note 1 below).</li> </ul> | + +| Parameter Name | Qualifier | Information type | Comment | +|-----------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingPeriod | M | The period between two successive performance data reporting. | <p>Applicable when the <code>reportingMethod</code> is performance data file reporting.</p> <p>The performance data report(s) are produced when the reporting period arrives.</p> <p>The <code>reportingPeriod</code> shall be one or multiple of <code>granularityPeriod</code>. The measurement or KPI value of each <code>granularityPeriod</code> will be made available to the performance data reporting related service producer, who will prepare the performance data file(s) for each <code>reportingPeriod</code>. If the consumer has subscribed to the <code>notifyFileReady</code> and <code>notifyFilePreparationError</code> notifications from the performance data reporting related service producer, the consumer will receive the notifications about the result of the performance data file preparation from that producer with the interval as defined by <code>reportPeriod</code>;</p> | +| startTime | O | It specifies the begin time from which the measurement job will be active. | <p>All values that indicate valid timestamp. Default value is "start now". If <code>startTime</code> is in the past, the current time will be used and the job will start immediately.</p> <p>When a measurement job becomes active, it does not mean that the measurement job immediately starts generation of the measurements or KPIs. The consumer can set the detailed time frame (e.g. <code>dailySchedule</code> or <code>weeklySchedule</code>) by <code>schedule</code> parameter for a measurement job to generate the measurements or KPIs. If there is no time frame scheduled, the measurement job immediately starts generation of the measurements or KPIs when it becomes active.</p> | +| stopTime | O | It specifies the end time after which the measurement job will be stopped. | <p>The value indicates valid timestamp and shall be later than <code>startTime</code> and current time. This attribute may carry the value "indefinitely". Default value is to run indefinitely.</p> | +| schedule | O | It specifies the detailed time frames (within the <code>startTime</code> and <code>stopTime</code> ) during which the measurement job is active and monitors the measurement type(s) or KPI(s). | <p>Its value is only one of the following, <code>dailyScheduling</code> or <code>weeklyScheduling</code>. The legal values for them refer to ITU-T Recommendation X.721 [4]. The legal values for them are as follows.</p> <p><code>dailyScheduling</code>:<br/> <code>{{ intervalStart {hour 0, minute 0},<br/> intervalEnd {hour 23, minute 59}}}</code></p> <p><code>weeklyScheduling</code>:<br/> <code>{{ daysOfWeek '1111111'B,<br/> intervalsOfDay {dailyScheduling}}}</code></p> <p>Default value is "daily".</p> | +| streamTarget | M | It specifies the target of performance data streams carrying the performance data stream unit(s). | Applicable when the <code>reportingMethod</code> is performance data streaming. | +| priority | O | It specifies the priority of measurement job | <p>Its value should be one of the following:<br/> Low,<br/> Medium,<br/> High</p> <p>Default value is "Medium"</p> | +| reliability | O | It specifies the reliability of measurement job | <p>Its value is vendor specific. See NOTE 2.</p> | + +NOTE 1: The `granularityPeriod` defines the measurement or KPI data production rate. The supported rates are dependent on the capacity of the producer involved (e.g. the processing power of the producer, number of measurements or KPIs being collected by the producer at the time, the complexity of the measurement type or KPI involved etc) and therefore, it cannot be standardized for all producers involved. The supported rates can only reflect the negotiated agreement between producer and the consumer involved. + +NOTE 2: meaning of "reliability" is not defined in the present document. + +#### 6.1.1.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|-----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| jobId | M | It identifies the measurement job instance (and distinguishes it from all other ongoing and stopped measurement job instances that have been created for the subject consumer). | Unique identifier of the measurement job from all the ongoing and stopped Measurement jobs that have been created for the subject consumer. | +| unsupportedList | M | List of <<br>iOC instance,<br>measurement type or KPI name,<br>reason<br>> | To create a measurement job, best-effort is required. The parameter of 'unsupportedList' has to be returned if status = PartialSuccess.<br>The reason can be any of:<br>- Measurement type or KPI name is unknown.<br>- Measurement type or KPI name is invalid.<br>- Measurement type or KPI name is not supported in the specific implementation.<br>- Measurement type or KPI name is already monitored for the IOC instance with a different granularityPeriod.<br>- The related IOC instance is unknown (e.g. it does not exist at the time of this operation invocation).<br>- Insufficient capacity to monitor the related IOC instance(s).<br>- (For KPI only) At least one related measurement job is not activated.<br>- The object instance listed in iOCInstanceList does not satisfy the condition in clause 4.4 in multiple tenant environment. | +| status | M | ENUM (Success, Failure, PartialSuccess) | An operation may fail because of a specified or unspecified reason. | + +#### 6.1.1.4 Exceptions + +| Exception Name | Definition | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| invalidStartTime | <b>Condition:</b> startTime is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| invalidStopTime | <b>Condition:</b> stopTime is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| invalidSchedule | <b>Condition:</b> schedule is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| invalidReportingMethod | <b>Condition:</b> reportingMethod is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| invalidGranularityPeriod | <b>Condition:</b> granularityPeriod is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| invalidReportingPeriod | <b>Condition:</b> reportingPeriod is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| highWorkLoad | <b>Condition:</b> no sufficient capacity<br><b>Returned Information:</b> Name of the exception and the detailed reason which is one of: CpuBusy; DiskShortage, LowMemory, maxJobReached, otherReason; status is set to 'Failure'. | +| noValidMeasurementType | <b>Condition:</b> all measurement type or KPI names are invalid (i.e. none of the measurement type or KPI names are valid).<br><b>Returned information:</b> output parameter status is set to 'Failure'. | +| invalidPriority | <b>Condition:</b> priority is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| invalidReliability | <b>Condition:</b> reliability is invalid.<br><b>Returned Information:</b> Name of the exception; status is set to 'Failure'. | +| lackofMeasurementJobs | <b>Condition:</b> At least one related measurement job is not activated.<br><b>Returned Information:</b> Name of the exception and the name(s) of the measurement(s) whose job is not activated; status is set to 'Failure'. | + +### 6.1.2 Operation stopMeasurementJob (M) + +#### 6.1.2.1 Definition + +This operation supports the authorized consumer to request the measurement job control related service producer to terminate a measurement job. + +Whether the measurement job is removed from the management service producer is vendor specific and out of scope of the present document. + +The measurement job shall be stopped at the end of the `granularityPeriod`. + +After the job has been stopped, the performance data reporting related notification (i.e. `notifyFileReady` or `notifyFilePreparationError`) and the performance data stream unit(s) for the last `granularityPeriod` shall be emitted, by the performance data reporting related service producer immediately. + +#### 6.1.2.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|--------------------|-----------|-----------------------|-------------------------------------------------| +| <code>jobId</code> | M | See subclause 6.1.1.3 | It specifies the measurement job to be stopped. | + +#### 6.1.2.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|---------------------|-----------|-------------------------|---------------------------------------------------------------------| +| <code>Status</code> | M | ENUM (Success, Failure) | An operation may fail because of a specified or unspecified reason. | + +#### 6.1.2.4 Exceptions + +| Exception Name | Definition | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| <code>unknownJob</code> | <b>Condition:</b> the <code>jobId</code> does not exist.<br><b>Returned information:</b> output parameter <code>status</code> is set to 'Failure'. | +| <code>jobCannotBeStopped</code> | <b>Condition:</b> the measurement job cannot be stopped.<br><b>Returned information:</b> output parameter <code>status</code> is set to 'Failure'. | + +### 6.1.3 Operation listMeasurementJobs (M) + +#### 6.1.3.1 Definition + +This operation supports the authorized consumer to request the measurement job control related service producer to list the information of all or a set of specified ongoing measurement jobs. + +#### 6.1.3.2 Input parameters + +| Parameter Name | Qualifier | Information type | Comment | +|------------------------|-----------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <code>jobIdList</code> | M | List of <code>jobId</code> of the measurement jobs | This parameter specifies the criteria to list the measurement jobs. If the parameter specifies the list of <code>jobId</code> to be retrieved, then the corresponding information of measurement jobs will be returned. If the parameter contains no information, all the measurement jobs are retrieved. | + +#### 6.1.3.3 Output parameters + +| Parameter Name | Qualifier | Matching Information | Comment | +|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| jobInfoList | M | List of <attributes (refer to input and output parameter of operation createMeasurementJob in clause 6.1.1.2 and clause 6.1.1.3) of measurement job:<br>- jobId<br>- iOCName<br>- iOCInstanceList<br>- measurementCategoryList<br>- granularityPeriod<br>- reportingMethod<br>- reportingPeriod<br>- startTime<br>- stopTime<br>- streamTarget<br>- schedule<br>- priority<br>- reliability> | Returned information of corresponding Measurement Jobs matching the input criteria. If no match, then the length of the jobInfoList will be 0 (with status == Success).<br><br>If the measurement job is created using non-empty iOCInstanceList in createMeasurementJob, then iOCInstanceList here shall contain the DNs of the supported IOC instances.<br><br>If the measurement job is created using empty iOCInstanceList, then iOCInstanceList here shall be empty as well. | +| status | M | ENUM (Success, Failure) | An operation may fail because of a specified or unspecified reason. | + +#### 6.1.3.4 Exceptions + +| Exception Name | Definition | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| invalidJobIdList | <b>Condition:</b> jobIdList specified in the input parameter is valid.<br><b>Returned information:</b> output parameter status is set to 'Failure'. | + +## 6.2 Performance data streaming related operations + +See 3GPP TS 28.532 [7]. + +## 6.3 Performance threshold monitoring related operations and notifications + +See 3GPP TS 28.532 [7]. + +# --- 7. Performance assurance services components + +## 7.1 Measurement job control services + +The components of measurement job control services for NFs, NSSIs, NSIs and networks/sub-networks are listed in table 7.1-1. + +**Table 7.1-1: Components of measurement job control services** + +| <b>Management service</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | <b>Management service component type C</b> | +|---------------------------------------------------|--------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------------------------------------| +| Measurement job control services for NFs | createMeasurementJob | IOCs for 5G NFs, as defined in TS 28.541 [3] | Performance measurements and assurance data for 5G NFs, as defined in TS 28.552 [2]. | +| | stopMeasurementJob | | | +| | listMeasurementJobs | | | +| Measurement job control services for NSSIs | createMeasurementJob | IOC(s) for NSSI, as defined in TS 28.541 [3]. | Performance measurements and assurance data for NSSI, as defined in TS 28.552 [2]. | +| | stopMeasurementJob | | | +| | listMeasurementJobs | | | +| Measurement job control services for NSIs | createMeasurementJob | IOC(s) for NSI, as defined in TS 28.541 [3] | Performance measurements and assurance data for NSI, as defined in TS 28.552 [2]. | +| | stopMeasurementJob | | | +| | listMeasurementJobs | | | +| Measurement job control services for sub-networks | createMeasurementJob | IOC(s) for sub-network, as defined in TS 28.541 [3] | Performance measurements and assurance data for sub-network, as defined in TS 28.552 [2]. | +| | stopMeasurementJob | | | +| | listMeasurementJobs | | | + +## 7.2 Performance data file reporting services + +The components of performance data file reporting services for NFs, NSSIs, NSIs and networks/sub-networks are listed in table 7.2-1. + +**Table 7.2-1: Components of performance data file reporting services** + +| <b>Management service</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | <b>Management service component type C</b> | +|-----------------------------------------------------------|------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------| +| Performance data file reporting services for NFs | notifyFileReady (see TS 28.532 [7]) | IOCs for 5G NFs, as defined in TS 28.541 [3] | Performance measurements for 5G NFs, as defined in TS 28.552 [2]. | +| | notifyFilePreparationError (see TS 28.532 [7]) | | | +| | listAvailableFiles (see TS 28.532 [7]) | | | +| | subscribe (see TS 28.532 [7]) | | | +| | unsubscribe (see TS 28.532 [7]) | | | +| Performance data file reporting services for NSSIs | notifyFileReady (see TS 28.532 [7]) | IOC(s) for NSSI, as defined in TS 28.541 [3]. | Performance measurements for NSSI, as defined in TS 28.552 [2]. | +| | notifyFilePreparationError (see TS 28.532 [7]) | | | +| | listAvailableFiles (see TS 28.532 [7]) | | | +| | subscribe (see TS 28.532 [7]) | | | +| | unsubscribe (see TS 28.532 [7]) | | | +| Performance data file reporting services for NSIs | notifyFileReady (see TS 28.532 [7]) | IOC(s) for NSI, as defined in TS 28.541 [3]. | Performance measurements for NSI, as defined in TS 28.552 [2]. | +| | notifyFilePreparationError (see TS 28.532 [7]) | | | +| | listAvailableFiles (see TS 28.532 [7]) | | | +| | subscribe (see TS 28.532 [7]) | | | +| | unsubscribe (see TS 28.532 [7]) | | | +| Performance data file reporting services for sub-networks | notifyFileReady (see TS 28.532 [7]) | IOC(s) for sub-network, as defined in TS 28.622 [5]. | Performance measurements for sub-network, as defined in TS 28.552 [2]. | +| | notifyFilePreparationError (see TS 28.532 [7]) | | | +| | listAvailableFiles (see TS 28.532 [7]) | | | +| | subscribe (see TS 28.532 [7]) | | | +| | unsubscribe (see TS 28.532 [7]) | | | + +## 7.3 Performance data streaming services + +The components of performance data streaming services for NFs, NSSIs, NSIs and networks/sub-networks are listed in table 7.3-1. + +**Table 7.3-1: Components of performance data streaming services** + +| <b>Management service</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | <b>Management service component type C</b> | +|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Performance data streaming service for NFs | The following operations defined in TS 28.532 [7]:<br>establishStreamingConnectioncreateMeasurementJob;<br>terminateStreamingConnection;<br>stopMeasurementJob;<br>reportStreamData;listMeasurementJobs<br>getConnectionInfo;<br>getStreamInfo;<br>addStreamInfo;<br>updateStreamInfo;<br>deleteStreamInfo. | IOCs for 5G NFs, as defined in TS 28.541 [3] | Performance measurements and KPIs for 5G NFs, as defined in TS 28.552 [2] and TS 28.554 [21]. | +| Performance data streaming service for NSSIs | The following operations defined in TS 28.532 [7]:<br>establishStreamingConnection;<br>terminateStreamingConnection;<br>reportStreamData;<br>getConnectionInfo;<br>getStreamInfo;<br>addStreamInfo;<br>updateStreamInfo;<br>deleteStreamInfo.createMeasurementJob;<br>stopMeasurementJob;<br>listMeasurementJobs | IOC(s) for NSSI, as defined in TS 28.541 [3]. | Performance measurements and KPIs for NSSI, as defined in TS 28.552 [2] and TS 28.554 [21]. | +| Performance data streaming service for NSIs | The following operations defined in TS 28.532 [7]:<br>establishStreamingConnection;<br>terminateStreamingConnection;<br>reportStreamData;<br>getConnectionInfo;<br>getStreamInfo;<br>addStreamInfo;<br>updateStreamInfo;<br>deleteStreamInfo.createMeasurementJob;<br>stopMeasurementJob;<br>listMeasurementJobs | IOC(s) for NSI, as defined in TS 28.541 [3]. | Performance measurements and KPIs for NSI, as defined in TS 28.552 [2] and TS 28.554 [21]. | +| Performance data streaming service for sub-networks | The following operations defined in TS 28.532 [7]:<br>establishStreamingConnection;<br>terminateStreamingConnection;<br>reportStreamData;<br>getConnectionInfo;<br>getStreamInfo;<br>addStreamInfo;<br>updateStreamInfo;<br>deleteStreamInfo.createMeasurementJob;<br>stopMeasurementJob;<br>listMeasurementJobs | IOC(s) for sub-network, as defined in TS 28.622 [5]. | Performance measurements and KPIs for sub-network, as defined in TS 28.552 [2] and TS 28.554 [21]. | + +## 7.4 Management service for performance threshold monitoring + +The components of management service for performance threshold monitoring for NFs, are listed in table 7.4-1. + +**Table 7.4-1: Components of management service for performance threshold monitoring** + +| <b>Management service</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | <b>Management service component type C</b> | +|------------------------------------------|----------------------------------------------------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| Performance threshold monitoring for NFs | createMOI operation (see TS 28.532 [7]) | <<IOC>>ThresholdMonitoringCapability, and <<IOC>>ThresholdMonitoring, as defined in TS 28.622 [5] | Performance measurements for 5G NFs, as defined in TS 28.552 [2]. | +| | getMOIAttributes operation (see TS 28.532 [7]) | | | +| | modifyMOIAttributes operation (see TS 28.532 [7]) | | | +| | deleteMOI operation (see TS 28.532 [7]) | | | +| | notifyThresholdCrossing notification (see TS 28.532 [7]) | | | + +## 7.5 MnS responsible for KPI job control + +The components of MnS responsible for KPI job control are listed in table 7.5-1. + +**Table 7.5-1: Components of MnS responsible for KPI job control** + +| <b>Management service</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | <b>Management service component type C</b> | +|-------------------------------------|--------------------------------------------|------------------------------------------------------------|------------------------------------------------------------------| +| MnS responsible for KPI job control | createMeasurementJob | IOCs for 5G network resources, as defined in TS 28.541 [3] | Key Performance Indicators (KPIs), as defined in TS 28.554 [21]. | +| | stopMeasurementJob | | | +| | listMeasurementJobs | | | + +## 7.6 Management service components used for configurable performance measurement control + +The MnS components used for configurable performance measurement control are listed in table 7.6-1. The configurable performance measurement control approach and measurement job control service described in clause 7.1 are two alternative solutions used for controlling performance measurement. + +**Table 7.6-1: MnS components used for configurable performance measurement control** + +| <b>Management purpose</b> | <b>Management service component type A</b> | <b>Management service component type B</b> | +|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configurable performance measurement control for NE/NF | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[7]:<br>Operations:<br>- createMOI<br>- getMOIAttributes<br>- modifyMOIAttributes<br>- deleteMOI<br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in performance measurement control NRM fragment in TS 28.622 [5] /TS 28.541[3]:<br>-PerfMetricJob<br>-ManagedElement or concrete ManagedFunction | +| Configurable performance measurement control for NetworkSlice | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[7]:<br>Operations:<br>- createMOI<br>- getMOIAttributes<br>- modifyMOIAttributes<br>- deleteMOI<br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in performance measurement control NRM fragment in TS 28.622 [5] /TS 28.541[3]:<br>PerfMetricJob<br><br>-NetworkSlice | +| Configurable performance measurement control for NetworkSliceSubnet | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[7]:<br>Operations:<br>- createMOI<br>- getMOIAttributes<br>- modifyMOIAttributes<br>- deleteMOI<br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in performance measurement control NRM fragment in TS 28.622 [5] / TS 28.541[3]:<br>PerfMetricJob<br><br>-NetworkSliceSubnet | +| Configurable performance measurement control for SubNetwork | Following operations/notifications defined in Clause 11.1.1 in TS 28.532[7]:<br>Operations:<br>- createMOI<br>- getMOIAttributes<br>- modifyMOIAttributes<br>- deleteMOI<br>Notifications:<br>- notifyMOICreation<br>- notifyMOIAttributeValueChanges<br>- notifyMOIDeletion<br>- notifyMOIChanges | Following IOCs defined in performance measurement control NRM fragment in TS 28.622 [5]:<br>PerfMetricJob<br><br>-SubNetwork | + +# 8 RESTful HTTP-based solution set of performance measurement job control service specific operations and notifications + +## 8.1 Mapping of operations + +### 8.1.1 Introduction + +The IS operations are mapped to SS equivalents according to table 8.1.1-1. + +**Table 8.1.1-1: Mapping of IS operations to SS equivalents** + +| IS operation | HTTP Method | Resource URI | Qualifier | +|----------------------|-------------|-------------------|-----------| +| createMeasurementJob | POST | /measJobs | M | +| listMeasurementJobs | GET | /measJobs | M | +| | | /measJobs/{jobId} | M | +| stopMeasurementJob | DELETE | /measJobs/{jobId} | M | + +### 8.1.2 Operation createMeasurementJob + +The IS operation parameters are mapped to SS equivalents according to table 8.1.2-1 and table 8.1.2-2. + +**Table 8.1.2-1: Mapping of IS operation input parameters to SS equivalents (HTTP POST)** + +| IS operation parameter name | SS parameter location | SS parameter name | SS parameter type | Qualifier | +|-----------------------------|-----------------------|-------------------------|---------------------|-----------| +| iOCName | request body | iOCName | string | M | +| iOCInstanceList | request body | iOCInstanceList | array(uri-Type) | M | +| measurementCategoryList | request body | measurementCategoryList | array(string) | M | +| reportingMethod | request body | reportingMethod | reportingMethodType | M | +| granularityPeriod | request body | granularityPeriod | Integer | M | +| reportingPeriod | request body | reportingPeriod | Integer | M | +| startTime | request body | startTime | dateTime-Type | O | +| stopTime | request body | stopTime | dateTime-Type | O | +| schedule | request body | schedule | ScheduleType | O | +| streamTarget | request body | streamTarget | string | M | +| priority | request body | priority | PriorityType | O | +| reliability | request body | reliability | string | O | + +**Table 8.1.2-2: Mapping of IS operation output parameters to SS equivalents (HTTP POST)** + +| IS operation parameter name | SS parameter location | SS parameter name | SS parameter type | Qualifier | +|-----------------------------|----------------------------------------|-------------------|-----------------------------|-----------| +| jobId | Location header | href | uri-Type | M | +| unsupportedList | response body | unsupportedList | array(unsupportedMeas-Type) | M | +| status | response status codes<br>response body | n/a<br>error | n/a<br>error-ResponseType | M | + +### 8.1.3 Operation listMeasurementJobs + +The IS operation parameters are mapped to SS equivalents according to table 8.1.3-1 and table 8.1.3-2. + +**Table 8.1.3-1: Mapping of IS operation input parameters to SS equivalents (HTTP GET)** + +| IS operation parameter name | SS parameter location | SS parameter name | SS parameter type | Qualifier | +|-----------------------------|-----------------------|-------------------------------|--------------------------------|-----------| +| jobIdList | Path<br>Query | MeasJobs/{jobId}<br>jobIdList | jobId: string<br>array(string) | O | + +**Table 8.1.3-2: Mapping of IS operation output parameters to SS equivalents (HTTP POST)** + +| IS operation parameter name | SS parameter location | SS parameter name | SS parameter type | Qualifier | +|-----------------------------|----------------------------------------|-------------------|--------------------------------|-----------| +| jobInfoList | response body | data | measJobsRetrieval-ResponseType | O | +| status | response status codes<br>response body | n/a<br>error | n/a<br>error-ResponseType | M | + +### 8.1.4 Operation stopMeasurementJob + +The IS operation parameters are mapped to SS equivalents according to table 8.1.4-1 and table 8.1.4-2. + +**Table 8.1.4-1: Mapping of IS operation input parameters to SS equivalents (HTTP DELETE)** + +| IS operation parameter name | SS parameter location | SS parameter name | SS parameter type | Qualifier | +|-----------------------------|-----------------------|-------------------|-------------------|-----------| +| jobId | path | /MeasJobs/{jobId} | jobId:string | M | + +**Table 8.1.4-2: Mapping of IS operation output parameters to SS equivalents (HTTP DELETE)** + +| IS operation parameter name | SS parameter location | SS parameter name | SS parameter type | Qualifier | +|-----------------------------|----------------------------------------|-------------------|---------------------------|-----------| +| status | response status codes<br>response body | n/a<br>error | n/a<br>error-ResponseType | M | + +## 8.2 Resources + +### 8.2.0 Resource structure + +Figure 8.2.0-1 shows the resource structure of the performance measurement job control service. + +![A hierarchical diagram showing the resource URI structure. The root node is {MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}. It branches down to /measJobs, which in turn branches down to /{jobId}.](8825e92f1c325d7393a17cdcdf31a292_img.jpg) + +``` + +graph TD + Root["{MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}"] --> MeasJobs["/measJobs"] + MeasJobs --> JobId["/{jobId}"] + +``` + +A hierarchical diagram showing the resource URI structure. The root node is {MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}. It branches down to /measJobs, which in turn branches down to /{jobId}. + +**Figure 8.2.0-1: Resource URI structure of the performance measurement job control service** + +Table 8.2.0-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.2.0-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|---------------|--------------|-------------|--------------------------------------------| +| measJobs | /measJobs | GET | Retrieve all or a list of measurement jobs | +| | | POST | Create a measurement job | + +| | | | | +|---------|-------------------|--------|----------------------------| +| measJob | /measJobs/{jobId} | GET | Retrieve a measurement job | +| | | DELETE | Stop a measurement job | + +### 8.2.1 Resource definitions + +#### 8.2.1.1 Void + +#### 8.2.1.2 Resource “/measJobs” + +##### 8.2.1.2.1 Description + +This resource represents a collection of measurement jobs. + +##### 8.2.1.2.2 URI + +Resource URI = {MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}/measJobs + +The resource URI variables a defined in the following table. + +**Table 8.2.1.2.2-1: URI variables** + +| Name | Definition | +|------------|---------------------------------------| +| MnSRoot | See subclause 4.4.3 of TS 32.158 [14] | +| MnSVersion | See subclause 4.4.3 of TS 32.158 [14] | + +##### 8.2.1.2.3 HTTP methods + +###### 8.2.1.2.3.1 HTTP POST + +This method shall support the URI query parameters specified in the following table. + +**Table 8.2.1.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Description | S<br>Q | +|------|-----------|-------------|--------| +| | | | | + +This method shall support the request data structures, the response data structures and response codes specified in the following table. + +**Table 8.2.1.2.3.1-2: Data structures supported by the POST request body on this resource** + +| Data type | Description | SQ | +|-----------------------------|------------------------------------------------------------------|----| +| measJobCreation-RequestType | The resource representation of the measurement job to be created | M | + +**Table 8.2.1.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | Response codes | Description | S<br>Q | +|------------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------|--------| +| measJobCreation-ResponseType | 201 Created | In case of success the representation of the created measurement job is returned. | M | +| | 202 Partially created | In case of partial success the representation of the created measurement job with unsupported list is returned. | | +| error-Type | 4xx/5xx | Returned in case of an error | M | + +###### 8.2.1.2.3.2 HTTP GET + +This method shall support the URI query parameters specified in the following table. + +**Table 8.2.1.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Description | S<br>Q | +|-----------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| jobIdList | Array (string) | This parameter extends the set of targeted resources beyond the base resource identified with the path component of the URI. No scoping mechanism is specified in the present release. | O | + +This method shall support the request data structures, the response data structures and response codes specified in the following tables. + +**Table 8.2.1.2.3.2-2: Data structures supported by the GET request body on this resource** + +| Data type | Description | SQ | +|-----------|-------------|----| +| | | | + +**Table 8.2.1.2.3.2-3: Data structures supported by the GET response body on this resource** + +| Data type | Response codes | Description | S<br>Q | +|--------------------------------|----------------|---------------------------------------------------------------------|--------| +| measJobsRetrieval-ResponseType | 200 OK | The resource representations of the measurement job list retrieved. | M | +| error-ResponseType | 4xx/5xx | Returned in case of an error | M | + +#### 8.2.1.3 Resource “/measJobs/{jobId}” + +##### 8.2.1.3.1 Description + +This resource represents a measurement job. + +##### 8.2.1.3.2 URI + +Resource URI = {MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}/measJobs/{jobId} + +The resource URI variables a defined in the following table. + +**Table 8.2.1.3.2-1: URI variables** + +| Name | Definition | +|------------|---------------------------------------| +| MnSRoot | See subclause 4.4.3 of TS 32.158 [14] | +| MnSVersion | See subclause 4.4.3 of TS 32.158 [14] | +| jobId | The id of the measurement job | + +##### 8.2.1.3.3 HTTP methods + +###### 8.2.1.3.3.1 HTTP GET + +This method shall support the URI query parameters specified in the following table. + +**Table 8.2.1.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Description | S<br>Q | +|------|-----------|-------------|--------| +| | | | | + +This method shall support the request data structures, the response data structures and response codes specified in the following tables. + +**Table 8.2.1.3.3.1-2: Data structures supported by the GET request body on this resource** + +| <b>Data type</b> | <b>Description</b> | <b>SQ</b> | +|------------------|--------------------|-----------| +| n/a | n/a | n/a | + +**Table 8.2.1.3.3.1-3: Data structures supported by the GET response body on this resource** + +| <b>Data type</b> | <b>Response codes</b> | <b>Description</b> | <b>SQ</b> | +|--------------------------------|-----------------------|----------------------------------------------------------------|-----------| +| measJobsRetrieval-ResponseType | 200 OK | The resource representations of the measurement job retrieved. | M | +| error-ResponseType | 4xx/5xx | Returned in case of an error | M | + +###### 8.2.1.3.3.2 HTTP DELETE + +This method shall support the URI query parameters specified in the following table. + +**Table 8.2.1.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| <b>Name</b> | <b>Data type</b> | <b>Description</b> | <b>SQ</b> | +|-------------|------------------|--------------------|-----------| +| | | | | + +This method shall support the request data structures, the response data structures and response codes specified in the following tables. + +**Table 8.2.1.3.3.2-2: Data structures supported by the DELETE request body on this resource** + +| <b>Data type</b> | <b>Description</b> | <b>SQ</b> | +|------------------|--------------------|-----------| +| n/a | n/a | n/a | + +**Table 8.2.1.3.3.2-3: Data structures supported by the DELETE response body on this resource** + +| <b>Data type</b> | <b>Response codes</b> | <b>Description</b> | <b>SQ</b> | +|--------------------|-----------------------|------------------------------------------------|-----------| +| n/a | 204 No Content | In case of success no message body is returned | M | +| error-ResponseType | 4xx/5xx | Returned in case of an error | M | + +## 8.3 Data type definitions + +### 8.3.1 General + +Table 8.3.1-1: Data types defined in this specification + +| Data type | Reference | Description | +|--------------------------------------------------|-----------|---------------------------------------------------------------------------------------| +| <b>General types</b> | | | +| dateTime-Type | 8.3.8.2 | Data type of date and time. | +| uri-Type | 8.3.8.2 | The data type of a URI | +| <b>Types used in paths</b> | | | +| <b>Types used in query parts</b> | | | +| <b>Types used in request bodies</b> | | | +| measJobCreation-RequestType | 8.3.6.1 | Used in the request body of HTTP POST describing the measurement job to be created | +| <b>Types used in response bodies</b> | | | +| measJobCreation-ResponseType | 8.3.6.2 | Used in the response body of HTTP POST describing the measurement job created | +| measJobsRetrieval-ResponseType | 8.3.6.3 | Used in the response body of HTTP GET describing the measurement job(s) retrieved | +| error-ResponseType | 8.3.6.4 | Used in the response body describing the error. | +| <b>Types used for resources</b> | | | +| measJobInfo-ResourceType | 8.3.6.5 | Used for representation of the measurement job information. | +| <b>Types referenced by the definitions above</b> | | | +| reportingMethod-Type | 8.3.8.3 | This defines the data type for reporting method. | +| schedule-Type | 8.3.7.1 | This defines the data type for schedule. | +| priority-Type | 8.3.8.4 | This defines the data type for priority of the measurement job. | +| unsupportedMeas-Type | 8.3.7.5 | This defines the data type for the unsupported measurement types for an IOC instance. | + +Table 8.3.1-2: Data types imported + +| Data type | Reference | Description | +|-----------|-----------|-------------| +| | | | + +### 8.3.2 Void + +### 8.3.3 Void + +### 8.3.4 Structured general data types + +None. + +### 8.3.5 Structured path data types + +None. + +### 8.3.6 Query, message body and resource data types + +#### 8.3.6.1 Type measJobCreation-RequestType + +**Table 8.3.6.1-1: Definition of type measJobCreation-RequestType** + +| Attribute name | Data type | Description | S<br>Q | +|-------------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------| +| iOCName | string | The IOC name of the IOC instances for which the measurement job is to be created. | M | +| iOCInstanceList | array(uri-Type) | The URI(s) of the IOC instances for which the measurement job is to be created. | M | +| measurementCategoryList | array(string) | The list of measurement type(s) to be measured. | M | +| reportingMethod | reportingMethod-Type | The reporting method of the measurements to be collected, i.e., by performance data file or by performance data streaming. | M | +| granularityPeriod | Integer | The granularity period of the measurement job. | M | +| reportingPeriod | Integer | The reporting period of the measurement job. | M | +| startTime | dateTime-Type | The begin time from which the measurement job will be active. | O | +| stopTime | dateTime-Type | The end time after which the measurement job will be stopped. | O | +| schedule | schedule-Type | The detailed time frames (within the startTime and stopTime) during which the measurement job is active and monitors the measurement type(s). | O | +| streamTarget | string | The target of performance data streams carrying the performance data stream unit(s). | M | +| priority | priority-Type | The priority of the measurement job. | O | +| reliability | string | The reliability of the measurement job. | O | + +#### 8.3.6.2 Type measJobCreation-ResponseType + +**Table 8.3.6.2-1: Definition of type measJobCreation-ResponseType** + +| Attribute name | Data type | Description | S<br>Q | +|-----------------|-----------------------------|----------------------------------------------------------------------------------|--------| +| unsupportedList | array(unsupportedMeas-Type) | The list of unsupported IOC instances, unsupported measurement types and reason. | M | + +#### 8.3.6.3 Type measJobsRetrieval-ResponseType + +**Table 8.3.6.3-1: Definition of type measJobsRetrieval-ResponseType** + +| Attribute name | Data type | Description | S<br>Q | +|----------------|---------------------------------|------------------------------------------|--------| +| jobInfoList | array(measJobInfo-ResourceType) | The list of measurement job information. | M | + +#### 8.3.6.4 Type error-ResponseType + +**Table 8.3.6.4-1: Definition of type error-ResponseType** + +| Attribute name | Data type | Description | S<br>Q | +|----------------|-----------|-----------------------------------------------------------------|--------| +| error | object | Key indicating the response body containing an error | M | +| > errorInfo | string | Attribute allowing to convey error information in string format | M | + +#### 8.3.6.5 Type measJobInfo-ResourceType + +**Table 8.3.6.3-1: Definition of type measJobsRetrieval-ResponseType** + +| Attribute name | Data type | Description | S<br>Q | +|-------------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------| +| href | uri-Type | The URI of the measurement job. | M | +| iOCName | string | The IOC name of the IOC instances for which the measurement job created. | M | +| iOCInstanceList | array(uri-Type) | The URI(s) of the IOC instances for which the measurement job is created. | M | +| measurementCategoryList | array(string) | The list of measurement type(s) measured. | M | +| reportingMethod | reportingMethod-Type | The reporting method of the measurements, i.e., by performance data file or by performance data streaming. | M | +| granularityPeriod | Integer | The granularity period of the measurement job. | M | +| reportingPeriod | Integer | The reporting period of the measurement job. | M | +| startTime | dateTime-Type | The begin time from which the measurement job is active. | O | +| stopTime | dateTime-Type | The end time after which the measurement job will be stopped. | O | +| schedule | schedule-Type | The detailed time frames (within the startTime and stopTime) during which the measurement job is active and monitors the measurement type(s). | O | +| streamTarget | string | The target of performance data streams carrying the performance data stream unit(s). | M | +| priority | priority-Type | The priority of the measurement job. | O | +| reliability | string | The reliability of the measurement job. | O | + +### 8.3.7 Referenced structured data types + +#### 8.3.7.1 Type schedule-Type + +**Table 8.3.7.1-1: Definition of schedule-Type** + +| Attribute name | Data type | Description | S<br>Q | +|----------------|---------------------------|----------------------------------------------|--------| +| scheduleOption | scheduleOption-Type | It indicates the schedule is daily or weekly | M | +| dailySchedule | array(timeInterval-Type) | It defines the daily schedule. | M | +| weeklySchedule | array(scheduleOfDay-Type) | It defines the weekly schedule. | M | + +#### 8.3.7.2 Type timeInterval-Type + +**Table 8.3.7.2-1: Definition of timeInterval-Type** + +| Attribute name | Data type | Description | S<br>Q | +|----------------|-----------|------------------------------------------------------------------------|--------| +| intervalStart | string | It defines the start time of the schedule, by a string in Time format. | M | +| intervalEnd | string | It defines the end time of the schedule, by a string in Time format.s | M | + +#### 8.3.7.3 Type scheduleOfDay-Type + +**Table 8.3.7.3-1: Definition of scheduleOfDay-Type** + +| Attribute name | Data type | Description | S<br>Q | +|----------------|--------------------------|-------------------------------------|--------| +| dayOfWeek | dayOfWeek-Type | It defines the day of a week. | M | +| intervalsOfDay | array(timeInterval-Type) | It defines the schedule of the day. | M | + +#### 8.3.7.4 Void + +#### 8.3.7.5 Type unsupportedMeas-Type + +**Table 8.3.7.5-1: Definition of unsupportedMeas-Type** + +| Attribute name | Data type | Description | S<br>Q | +|---------------------|-----------|------------------------------------------------------------------------------------------------|--------| +| iOCInstance | uri-Type | The URI of the IOC instance. | M | +| measurementTypeName | string | It defines the measurement type name that the IOC Instance as indicated above does not support | M | +| reason | string | It specifies the reason that measurement type name is not supported by the IOC instance | M | + +### 8.3.8 Simple data types and enumerations + +#### 8.3.8.1 General + +This subclause defines simple data types and enumerations that are used by the data structures defined in the previous subclauses. + +#### 8.3.8.2 Simple data types + +**Table 8.3.8.2-1: Simple data types** + +| Type name | Type definition | Description | +|---------------|-----------------|--------------------------------------------------------| +| dateTime-Type | string | The data type for date and time in “date-time” format. | +| uri-Type | string | The type of a URI | + +#### 8.3.8.3 Enumeration reportingMethod-Type + +**Table 8.3.8.3-1: Enumeration reportingMethod-Type** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------| +| file | It indicates that the performance data are to be reported by performance data file. | +| streaming | It indicates that the performance data are to be reported by performance data streaming. | + +#### 8.3.8.4 Enumeration priority-Type + +**Table 8.3.8.4-1: Enumeration priority-Type** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------------| +| Low | It indicates that the priority of the measurement job is low | +| medium | It indicates that the priority of the measurement job is medium | +| high | It indicates that the priority of the measurement job is high | + +#### 8.3.8.5 Enumeration scheduleOption-Type + +**Table 8.3.8.5-1: Enumeration scheduleOption-Type** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------| +| daily | It indicates the schedule of the measurement job is daily. | +| weekly | It indicates the schedule of the measurement job is weekly. | + +#### 8.3.8.6 Enumeration dayOfWeek-Type + +**Table 8.3.8.6-1: Enumeration dayOfWeek-Type** + +| Enumeration value | Description | +|-------------------|-----------------------------------| +| Monday | It indicates Monday of a week. | +| Tuesday | It indicates Tuesday of a week. | +| Wednesday | It indicates Wednesday of a week. | +| Thursday | It indicates Thursday of a week. | +| Friday | It indicates Friday of a week. | +| Saturday | It indicates Saturday of a week. | +| Sunday | It indicates Sunday of a week. | + +# --- 9 Void + +# Annex A (informative): Void + +# Annex B (informative): Procedures for performance assurance services + +## B.1 NF measurement job creation + +The Figure B.1-1 illustrates an example of procedure for creating a measurement job for NF(s). + +![Sequence diagram showing the procedure for NF measurement job creation between a Consumer, an NF measurement job control service producer, and one or more NFs. The process involves a request from the Consumer, a check for new measurement types, a loop for each NF to be measured (including a request and acknowledgment), and a final response to the Consumer.](3e8e3bdb3d90f0856266d4eaf36abba1_img.jpg) + +``` + +sequenceDiagram + actor Consumer + participant Producer as NF measurement job control service producer + participant NF as NF + + Note right of Producer: 2. Check if new measurement type(s) need to be collected from the NF(s) to be measured + + loop For each NF to be measured + opt If new measurement type(s) need to be collected from the NF + Producer->>NF: 3a. Request to collect performance data + NF-->>Producer: 3b. Acknowledge the request + end + end + + Consumer->>Producer: 1a. CreateMeasurementJob (request) + Producer-->>Consumer: 1b. CreateMeasurementJob (response) + +``` + +Sequence diagram showing the procedure for NF measurement job creation between a Consumer, an NF measurement job control service producer, and one or more NFs. The process involves a request from the Consumer, a check for new measurement types, a loop for each NF to be measured (including a request and acknowledgment), and a final response to the Consumer. + +**Figure B.1-1: Example of procedure for NF measurement job creation** + +- 1a. The authorized consumer invokes the `CreateMeasurementJob` operation (see clause 6.1.1) to NF measurement job control service producer to request creation of a measurement job for NF(s). +2. The NF measurement job control service producer checks if new measurement type(s) need to be collected from the NF(s) to be measured. +3. For each NF to be measured, if new measurements type(s) need to be collected: + - 3a. the NF measurement job control service producer requests NF to collect the performance data; + - 3b. the NF measurement job control service producer receives the acknowledgement of the request from NF. +- 1b. The NF measurement job control service producer returns the result of `CreateMeasurementJob` operation (see clause 6.1.1) to the consumer. + +If the NF measurement job is successfully created, the NF measurement job control service producer will collect the performance data from the NF(s) accordingly, and make the measurement results available to the NF performance data reporting service producer for each reporting period. + +## B.2 NSSI measurement job creation + +The Figure B.2-1 illustrates an example of procedure for creating a measurement job for NSSI(s). + +This procedure is only applicable for the scenario where the NSSI measurement type(s) can be decomposed into the measurement data type(s) of the constituent NSSI(s) and NF(s). + +![Sequence diagram for NSSI measurement job creation showing interactions between Consumer, NSSI measurement job control service producer, NF measurement job control service producer, and NF.](e05434e963901d7e9c0bf5a6758200ed_img.jpg) + +``` + +sequenceDiagram + participant C as Consumer + participant NSSI_P as NSSI measurement job +control service producer + participant NF_P as NF measurement job +control service producer + participant NF as NF + + C->>NSSI_P: 1a. CreateMeasurementJob (request) + + Note over NSSI_P: 2. Decompose the measurement type(s) of each +NSSI into measurement type(s) of the constituent +NSSI(s) and/or NF(s), and check if new +measurement type(s) need to be collected for the +constituent NSSI(s) and/or NF(s) + + loop For each constituent NSSI to be measured + opt If new measurement type(s) need to be collected for the NSSI + rect rgb(255, 255, 255) + Note over NSSI_P, NF_P: ref: 3. NSSI measurement job creation procedure (this procedure) + end + end + end + + loop For each constituent NF to be measured + opt If new measurement type(s) need to be collected for the NF + rect rgb(255, 255, 255) + Note over NSSI_P, NF: ref: 4. NF measurement job creation procedure (see annex B.1) + end + end + end + + NSSI_P-->>C: 1b. CreateMeasurementJob (response) + +``` + +Sequence diagram for NSSI measurement job creation showing interactions between Consumer, NSSI measurement job control service producer, NF measurement job control service producer, and NF. + +**Figure B.2-1: Example of procedure for NSSI measurement job creation** + +- 1a. The authorized consumer invokes the `CreateMeasurementJob` operation (see clause 6.1.1) to NSSI measurement job control service producer to request creation of a measurement job for NSSI(s). +2. The NSSI measurement job control service producer decomposes the measurement type(s) of each NSSI to the measurement type(s) of the constituent NSSI(s) and/or NF(s), and checks if new measurement type(s) need to be collected for the constituent NSSI(s) and/or NF(s). +3. For each constituent NSSI to be measured, if new measurements type(s) need to be collected, the NSSI measurement job control service producer acts as consumer of another NSSI measurement job control service instance, and requests the corresponding NSSI measurement job control service producer to request creation of measurement job for the NSSI (following the same procedure as illustrated in this figure). + +It is also possible to create one measurement job to collect the performance data for multiple NSSI(s). + +4. For each constituent NF to be measured, if new measurements type(s) need to be collected, the NSSI measurement job control service producer acts as consumer of NF measurement job control service, and requests the corresponding NF measurement job control service producer to request creation of measurement job for the NF (according to the NF measurement job creation procedure as illustrated in clause B.1). + +It is also possible to create one measurement job to collect the performance data for multiple NF(s). + +- 1b. The NSSI measurement job control service producer returns the result of `CreateMeasurementJob` operation (see clause 6.1.1) to the consumer. + +If the NSSI measurement job is successfully created, the NSSI measurement job control service producer will collect the performance data for the constituent NSSI(s) and/or NF(s) accordingly, generate the measurement results for the measured NSSI(s) and make the measurement results available to the NSSI performance data reporting service producer for each reporting period. + +## --- B.3 NSI measurement job creation + +This Figure B.3-1 illustrates an example of procedure for creating a measurement job for NSI(s). + +This procedure is only applicable for the scenario where the NSI measurement type(s) can be decomposed into the measurement data type(s) of the constituent NSSI(s) or NF(s). + +![Sequence diagram illustrating the procedure for NSI measurement job creation. Lifelines: Consumer, NSI measurement job control service producer, NSSI measurement job control service producer, NF measurement job control service producer, and NF. The process involves a request from the Consumer, decomposition of measurement types, and recursive job creation for constituent NSSIs and NFs.](fd3cbb53e991f8209ba17b398f426e13_img.jpg) + +``` + +sequenceDiagram + actor Consumer + participant NSI as NSI measurement job control service producer + participant NSSI as NSSI measurement job control service producer + participant NF as NF measurement job control service producer + participant NFs as NF + + Note right of NSI: 2. Decompose the measurement type(s) of each NSI into measurement type(s) of the constituent NSSI(s) and/or NF(s), and check if new measurement type(s) need to be collected for the constituent NSSI(s) and/or NF(s) + + loop For each constituent NSSI to be measured + opt If new measurement type(s) need to be collected for the NSSI + ref 3. NSSI measurement job creation procedure (see annex B.2) + end + end + + loop For each constituent NF to be measured + opt If new measurement type(s) need to be collected for the NF + ref 4. NF measurement job creation procedure (see annex B.1) + end + end + + Consumer->>NSI: 1a. CreateMeasurementJob (request) + NSI-->>Consumer: 1b. CreateMeasurementJob (response) + +``` + +Sequence diagram illustrating the procedure for NSI measurement job creation. Lifelines: Consumer, NSI measurement job control service producer, NSSI measurement job control service producer, NF measurement job control service producer, and NF. The process involves a request from the Consumer, decomposition of measurement types, and recursive job creation for constituent NSSIs and NFs. + +**Figure B.3-1: Example of procedure for NSI measurement job creation** + +- 1a. The authorized consumer invokes the `CreateMeasurementJob` operation (see clause 6.1.1) to NSI measurement job control service producer to request creation of a measurement job for NSI(s). +2. The NSI measurement job control service producer decomposes the measurement type(s) of each NSI to the measurement type(s) of the constituent NSSI(s) and/or NF(s), and checks if new measurement type(s) need to be collected for the constituent NSSI(s) and/or NF(s). +3. For each constituent NSSI to be measured, if new measurements type(s) need to be collected, the NSI measurement job control service producer acts as consumer of the NSSI measurement job control service, and requests the corresponding NSSI measurement job control service producer to request creation of measurement job for the NSSI (according to the procedure as illustrated in clause B.2). + +It is also possible to create one measurement job to collect the performance data for multiple NSSI(s). + +4. For each constituent NF to be measured, if new measurements type(s) need to be collected, the NSI measurement job control service producer acts as consumer of NF measurement job control service, and requests the corresponding NF measurement job control service producer to request creation of measurement job for the NF (according to the NF measurement job creation procedure as illustrated in clause B.1). + +It is also possible to create one measurement job to collect the performance data for multiple NF(s). + +- 1b. The NSI measurement job control service producer returns the result of `CreateMeasurementJob` operation (see clause 6.1.1) to the consumer. + +If the NSI measurement job is successfully created, the NSI measurement job control service producer will collect the performance data for the constituent NSSI(s) and/or NF(s) accordingly, generate the measurement results for the measured NSI(s) and make the measurement results available to the NSI performance data reporting service producer for each reporting period. + +## B.4 Network measurement job creation + +This Figure B.4-1 illustrates an example of procedure for creating a measurement job for network/subnetwork(s). + +This procedure is only applicable for the scenario where the network/subnetwork measurement type(s) can be decomposed into the measurement data type(s) of the constituent NF(s). + +![Sequence diagram illustrating the procedure for network measurement job creation. The diagram shows four lifelines: Consumer, Network/sub-network measurement job control service producer, NF measurement job control service producer (stack), and NF (stack). The process starts with the Consumer sending a '1a. CreateMeasurementJob (request)' to the Network/sub-network measurement job control service producer. The producer then performs an internal step: '2. Decompose the measurement type(s) of each network/subnetwork into measurement type(s) of the constituent NF(s), and check if new measurement type(s) need to be collected for the constituent NF(s)'. A 'loop' labeled 'For each constituent NF to be measured' follows. Inside the loop, an 'opt' block labeled 'If new measurement type(s) need to be collected for the NF' contains a 'ref' block labeled '3. NF measurement job creation procedure (see annex B.1)'. Finally, the Network/sub-network measurement job control service producer sends a '1b. CreateMeasurementJob (response)' back to the Consumer.](a057800564be3506d2d87b6a4daee25b_img.jpg) + +``` + +sequenceDiagram + participant Consumer + participant NSMJCSP as Network/sub-network measurement job control service producer + participant NMJCSP as NF measurement job control service producer + participant NF as NF + + Note right of NSMJCSP: 2. Decompose the measurement type(s) of each network/subnetwork into measurement type(s) of the constituent NF(s), and check if new measurement type(s) need to be collected for the constituent NF(s) + + loop For each constituent NF to be measured + opt If new measurement type(s) need to be collected for the NF + ref NF measurement job creation procedure (see annex B.1) + end + end + + Consumer->>NSMJCSP: 1a. CreateMeasurementJob (request) + NSMJCSP-->>Consumer: 1b. CreateMeasurementJob (response) + +``` + +Sequence diagram illustrating the procedure for network measurement job creation. The diagram shows four lifelines: Consumer, Network/sub-network measurement job control service producer, NF measurement job control service producer (stack), and NF (stack). The process starts with the Consumer sending a '1a. CreateMeasurementJob (request)' to the Network/sub-network measurement job control service producer. The producer then performs an internal step: '2. Decompose the measurement type(s) of each network/subnetwork into measurement type(s) of the constituent NF(s), and check if new measurement type(s) need to be collected for the constituent NF(s)'. A 'loop' labeled 'For each constituent NF to be measured' follows. Inside the loop, an 'opt' block labeled 'If new measurement type(s) need to be collected for the NF' contains a 'ref' block labeled '3. NF measurement job creation procedure (see annex B.1)'. Finally, the Network/sub-network measurement job control service producer sends a '1b. CreateMeasurementJob (response)' back to the Consumer. + +**Figure B.4-1: Example of procedure for network measurement job creation** + +- 1a. The authorized consumer invokes the `CreateMeasurementJob` operation (see clause 6.1.1) to network measurement job control service producer to request creation of a measurement job for network/subnetwork(s). +- 1b. The network measurement job control service producer returns the result of `CreateMeasurementJob` operation (see clause 6.1.1) to the consumer. +2. The network measurement job control service producer decomposes the measurement type(s) of each network/subnetwork to the measurement type(s) of the constituent NF(s), and checks if new measurement type(s) need to be collected for the constituent NF(s). +3. For each constituent NF to be measured, if new measurements type(s) need to be collected, the network/sub-network measurement job control service producer acts as consumer of NF measurement job control service, and requests the corresponding NF measurement job control service producer to request creation of measurement job for the NF (according to the NF measurement job creation procedure as illustrated in annex B.1). + +It is also possible to create one measurement job to collect the performance data for multiple NF(s). + +If the network measurement job is successfully created, the network measurement job control service producer will collect the performance data for the constituent NF(s) accordingly, generate the measurement results for the measured network/subnetwork(s) and make the measurement results available to the network performance data reporting service producer for each reporting period. + +## B.5 NF measurement job termination + +This Figure B.5-1 illustrates an example of procedure for stopping a measurement job for NF(s). + +![Sequence diagram illustrating the procedure for NF measurement job termination. The diagram shows interactions between a Consumer, an NF measurement job control service producer, and multiple NFs. The process starts with the Consumer sending a StopMeasurementJob request to the producer, which returns a response. The producer then checks if the measurement collection activity needs to be stopped at the NF(s). A loop labeled 'For each NF being measured' contains an optional block 'If the measurement collection activity need to be stopped at the NF'. Inside this block, the producer sends a 'Request to stop collecting performance data' to the NF, and the NF responds with 'Acknowledge the request'.](dd6c544ab685b25dd17f59456efcfbfc_img.jpg) + +``` +sequenceDiagram + actor Consumer + participant Producer as NF measurement job control service producer + participant NF + Note right of Producer: 2. Check if the measurement collection activity needs to be stopped at the NF(s) + loop For each NF being measured + opt If the measurement collection activity need to be stopped at the NF + Producer->>NF: 3a. Request to stop collecting performance data + NF-->>Producer: 3b. Acknowledge the request + end + end +``` + +Sequence diagram illustrating the procedure for NF measurement job termination. The diagram shows interactions between a Consumer, an NF measurement job control service producer, and multiple NFs. The process starts with the Consumer sending a StopMeasurementJob request to the producer, which returns a response. The producer then checks if the measurement collection activity needs to be stopped at the NF(s). A loop labeled 'For each NF being measured' contains an optional block 'If the measurement collection activity need to be stopped at the NF'. Inside this block, the producer sends a 'Request to stop collecting performance data' to the NF, and the NF responds with 'Acknowledge the request'. + +**Figure B.5-1: Example of procedure for NF measurement job termination** + +- 1a. The authorized consumer invokes the `StopMeasurementJob` operation (see clause 6.1.2) to NF measurement job control service producer to request termination of a measurement job for NF(s). +- 1b. The NF measurement job control service producer returns the result of `StopMeasurementJob` operation (see clause 6.1.2) to the consumer. +2. The NF measurement job control service producer checks if the measurement collection activity needs to be stopped at the NF(s). +3. For each NF being measured, if the measurement collection activity needs to be stopped at the NF(s), + - 3a. the NF measurement job control service producer requests NF to stop collecting the performance data; + - 3b. the NF measurement job control service producer receives the acknowledgement of the request from NF. + +## B.6 NSSI measurement job termination + +This Figure B.6-1 illustrates an example of procedure for stopping a measurement job for NSSI(s). + +This procedure is only applicable for the scenario where the NSSI measurement type(s) can be decomposed into the measurement data type(s) of the constituent NSSI(s) and NF(s). + +![Sequence diagram illustrating the procedure for NSSI measurement job termination. The diagram shows interactions between a Consumer, NSSI measurement job control service producer, NF measurement job control service producer, and NF. The process involves a request from the Consumer to the NSSI producer, a response, a check for jobs to stop, a loop for NSSI job termination, and a loop for NF job termination.](677bcb564410628b8b966ad87b394888_img.jpg) + +``` + +sequenceDiagram + actor Consumer + participant NSSI_MJCP as NSSI measurement job control service producer + participant NSSI_MJCPs as NSSI measurement job control service producer + participant NF_MJCP as NF measurement job control service producer + participant NFs as NF + + Note right of NSSI_MJCP: 2. Check if the measurement job(s) for the constituent NSSI(s) and/or NF(s) need to be stopped + + Consumer->>NSSI_MJCP: 1a. StopMeasurementJob (request) + NSSI_MJCP-->>Consumer: 1b. StopMeasurementJob (response) + + loop For each measurement job for the constituent NSSI(s) needs to be stopped + ref For each measurement job for the constituent NSSI(s) needs to be stopped + Note right of NSSI_MJCP: 3. NSSI measurement job termination procedure (this procedure) + end + end + + loop For each measurement job for the constituent NF(s) needs to be stopped + ref For each measurement job for the constituent NF(s) needs to be stopped + Note right of NF_MJCP: 4. NF measurement job termination procedure (see annex B.5) + end + end + +``` + +Sequence diagram illustrating the procedure for NSSI measurement job termination. The diagram shows interactions between a Consumer, NSSI measurement job control service producer, NF measurement job control service producer, and NF. The process involves a request from the Consumer to the NSSI producer, a response, a check for jobs to stop, a loop for NSSI job termination, and a loop for NF job termination. + +**Figure B.6-1: Example of procedure for NSSI measurement job termination** + +- 1a. The authorized consumer invokes the `StopMeasurementJob` operation (see clause 6.1.2) to NSSI measurement job control service producer to request termination of a measurement job for NSSI(s). +- 1b. The NSSI measurement job control service producer returns the result of `StopMeasurementJob` operation (see clause 6.1.2) to the consumer. +2. The NSSI measurement job control service producer checks if the measurement job(s) for the constituent NSSI(s) and/or NF(s) need to be stopped. +3. For each measurement job for the constituent NSSI(s) needs to be stopped, the NSSI measurement job control service producer acts as consumer of another NSSI measurement job control service instance, and requests the corresponding NSSI measurement job control service producer to terminate the measurement job for the constituent NSSI(s) (following the same procedure as illustrated in this figure). +4. For each measurement job for the constituent NF(s) needs to be stopped, the NSSI measurement job control service producer acts as consumer of NF measurement job control service, and requests the corresponding NF measurement job control service producer to terminate the measurement job for the NF(s) (according to the NF measurement job termination procedure as illustrated in clause B.5). + +## B.7 NSI measurement job termination + +This Figure B.7-1 illustrates an example of procedure for stopping a measurement job for NSI(s). + +This procedure is only applicable for the scenario where the NSI measurement type(s) can be decomposed into the measurement data type(s) of the constituent NSSI(s) and NF(s). + +![Sequence diagram illustrating the procedure for NSI measurement job termination. Lifelines: Consumer, NSI measurement job control service producer, NSSI measurement job control service producer (stack), NF measurement job control service producer (stack), and NF (stack).](9e26cd5584f423e1b2155fb341db579f_img.jpg) + +``` +sequenceDiagram + actor Consumer + participant NSI as NSI measurement job control service producer + participant NSSI as NSSI measurement job control service producer + participant NF as NF measurement job control service producer + Note right of NSI: 2. Check if the measurement job(s) for the constituent NSSI(s) and/or NF(s) need to be stopped + loop For each measurement job for the constituent NSSI(s) needs to be stopped + Note right of NSI: 3. NSI measurement job termination procedure (see annex B.6) + end + loop For each measurement job for the constituent NF(s) needs to be stopped + Note right of NSI: 4. NF measurement job termination procedure (see annex B.5) + end +``` + +The sequence diagram shows the interaction for NSI measurement job termination. It begins with the Consumer sending a '1a. StopMeasurementJob (request)' to the NSI measurement job control service producer, which responds with '1b. StopMeasurementJob (response)'. The NSI producer then performs an internal check (step 2). It enters a loop for each measurement job for the constituent NSSI(s) that needs to be stopped, where it executes the NSI measurement job termination procedure (step 3). Another loop follows for each measurement job for the constituent NF(s) that needs to be stopped, where it executes the NF measurement job termination procedure (step 4). + +Sequence diagram illustrating the procedure for NSI measurement job termination. Lifelines: Consumer, NSI measurement job control service producer, NSSI measurement job control service producer (stack), NF measurement job control service producer (stack), and NF (stack). + +**Figure B.7-1: Example of procedure for NSI measurement job termination** + +- 1a. The authorized consumer invokes the `StopMeasurementJob` operation (see clause 6.1.2) to NSI measurement job control service producer to request creation of a measurement job for NSI(s). +- 1b. The NSI measurement job control service producer returns the result of `StopMeasurementJob` operation (see clause 6.1.2) to the consumer. +2. The NSI measurement job control service producer checks if the measurement job(s) for the constituent NSSI(s) and/or NF(s) need to be stopped. +3. For each measurement job for the constituent NSSI(s) needs to be stopped, the NSI measurement job control service producer acts as consumer of the NSSI measurement job control service, and requests the corresponding NSSI measurement job control service producer to terminate the measurement job for the constituent NSSI(s) (according to the NSSI measurement job termination procedure as illustrated in clause B.6). +4. For each measurement job for the constituent NF(s) needs to be stopped, the NSI measurement job control service producer acts as consumer of NF measurement job control service, and requests the corresponding NF measurement job control service producer to terminate the measurement job for the NF(s) (according to the NF measurement job termination procedure as illustrated in clause B.5). + +## B.8 Network measurement job termination + +This Figure B.8-1 illustrates an example of procedure for stopping a measurement job for network/subnetwork(s). + +This procedure is only applicable for the scenario where the network/subnetwork measurement type(s) can be decomposed into the measurement data type(s) of the constituent NF(s). + +![Sequence diagram for Network measurement job termination. Lifelines: Consumer, Network/sub-network measurement job control service producer, NF measurement job control service producer, and NF. Step 1a is StopMeasurementJob (request) from Consumer to Network/sub-network producer. Step 1b is StopMeasurementJob (response) back. Step 2 is an internal check. A loop contains step 3, which is a reference to the NF measurement job termination procedure in annex B.5.](6031b46d356ee24f96bfe37ee2cb7616_img.jpg) + +``` + +sequenceDiagram + participant C as Consumer + participant NP as Network/sub-network +measurement job control +service producer + participant PP as NF measurement job +control service producer + participant NF as NF + + C->>NP: 1a. StopMeasurementJob (request) + NP-->>C: 1b. StopMeasurementJob (response) + + Note over NP: 2. Check if the measurement job(s) for the +constituent NF(s) need to be stopped + + loop For each measurement job for the constituent NF(s) needs to be stopped + rect rgb(255, 255, 255) + Note over NP, NF: ref + Note over NP, NF: 3. NF measurement job termination procedure (see annex B.5) + end + end + +``` + +Sequence diagram for Network measurement job termination. Lifelines: Consumer, Network/sub-network measurement job control service producer, NF measurement job control service producer, and NF. Step 1a is StopMeasurementJob (request) from Consumer to Network/sub-network producer. Step 1b is StopMeasurementJob (response) back. Step 2 is an internal check. A loop contains step 3, which is a reference to the NF measurement job termination procedure in annex B.5. + +**Figure B.8-1: Example of procedure for network measurement job creation** + +- 1a. The authorized consumer invokes the `StopMeasurementJob` operation (see clause 6.1.2) to network measurement job control service producer to request termination of a measurement job for network/subnetwork(s). +- 1b. The network measurement job control service producer returns the result of `StopMeasurementJob` operation (see clause 6.1.2) to the consumer. +2. The network measurement job control service producer checks if the measurement job(s) for the constituent NF(s) need to be stopped. +3. For each measurement job for the constituent NF(s) needs to be stopped, the network measurement job control service producer acts as consumer of NF measurement job control service, and requests the corresponding NF measurement job control service producer to terminate the measurement job for the NF(s) (according to the NF measurement job termination procedure as illustrated in clause B.5). + +# Annex C (normative): Performance Data Stream Unit content description + +Table C-1 lists all the Performance Data Stream Unit content items. It also provides an explanation of the individual items. + +**Table C-1: Performance Data Stream Unit content description** + +| Performance Data Stream Unit Content | Description | +|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| streamId | The streamId of the performance data stream. | +| granularityPeriodEndTime | Time stamp referring to the end of the granularity period. | +| measResults | This parameter contains the sequence of result values for the observed measurement types or KPIs.<br>The "measResults" sequence shall have the same number of elements, which follow the same order as the measurement types or KPIs presented in "performanceMetrics" for the subject stream in the input parameter streamInfoList of the establishStreamingConnection operation (see clause 6.2.1.2). | + +# Annex D (informative): Performance data streaming holistic sequence + +## D.1 Performance data streaming for starting measurement collection + +### D.1.1 Sequence flow + +This annex shows the holistic sequence for performance data streaming, starting from starting the measurement collection (by job or configuration) to sending the performance data to the performance data streaming consumer (stream target). + +![Sequence diagram showing the flow of performance data streaming starting from measurement collection. It involves five actors: Consumer of MnS for measurement control, Producer of MnS for measurement control, NF, Producer of MnS for performance data streaming, and Consumer of MnS for performance data streaming. The flow includes alternative paths for measurement job control and configurable measurement control, followed by configuration, streaming setup, and a loop for measurement collection and reporting.](0c88b98a59dd5d549fed7b13c0ca6536_img.jpg) + +``` + +sequenceDiagram + participant C_MC as Consumer of MnS for measurement control + participant P_MC as Producer of MnS for measurement control + participant NF as NF + participant P_PS as Producer of MnS for performance data streaming + participant C_PS as Consumer of MnS for performance data streaming + + alt Measurement job control service + C_MC->>P_MC: 1a. createMeasurementJob (measurement control parameters) + else configurable measurement control service (i.e., NRM fragment based MnS) + alt create new MOI for collecting measurements + C_MC->>P_MC: 1b. createMOI (for PerfMetricJob IOC) + else update existing MOI for collecting new measurements + C_MC->>P_MC: 1c. modifyMOI (for PerfMetricJob MOI) + end + end + + P_MC->>NF: 2. Configure measurement collection (proprietary) + NF->>P_PS: 3. Set up streaming information for new measurements (proprietary) + + alt No streaming(WebSocket) connection exists + P_PS->>C_PS: 4a. establishStreamingConnection() + else Streaming (WebSocket) connection exists + alt add new stream(s) + P_PS->>C_PS: 4b. addStreamInfo() + else update existing stream(s) + P_PS->>C_PS: 4c. updateStreamInfo() + end + end + + loop while measurement collection is active + P_PS->>NF: 5. Collect measurements + NF-->>P_PS: + P_PS->>NF: 6. Report measurements (proprietary) + P_PS->>C_PS: 7. reportStreamData() + end + +``` + +Sequence diagram showing the flow of performance data streaming starting from measurement collection. It involves five actors: Consumer of MnS for measurement control, Producer of MnS for measurement control, NF, Producer of MnS for performance data streaming, and Consumer of MnS for performance data streaming. The flow includes alternative paths for measurement job control and configurable measurement control, followed by configuration, streaming setup, and a loop for measurement collection and reporting. + +**Figure D.1.1-1** + +1. The consumer of MnS for measurement control requests the MnS producer to start the measurement collection by the following two alternatives: + - 1) by the measurement job control service + - 1a. The MnS consumer invokes the `createMeasurementJob` operation towards the MnS producer; + - 2) by the configurable measurement control service (a.k.a, NRM fragment-based measurement control service). + - 1b. The MnS consumer creates a new `PerfMetricJob` MOI, by invoking the `createMOI` operation towards the MnS producer; or + - 1c. The MnS consumer modifies an existing `PerfMetricJob` MOI to add new measurements to be collected, by invoking the `modifyMOIAttributes` operation towards the MnS producer. +2. The producer of MnS for measurement control configures the NF to collect the measurements. The mechanism of this step is vendor specific. If producer of MnS for measurement control is in the NF, this step can be skipped. + +3. The NF triggers the producer of MnS for performance data streaming to set up the streaming information for the new measurements to be collected. The mechanism of this step is vendor specific. If producer of MnS for performance data streaming is in the NF, this step can be skipped. +4. The producer of MnS for performance data streaming communicates with the consumer to: + - 4a. establish the streaming (WebSocket) connection containing the stream information if it does not exist yet, by invoking the `establishStreamingConnection` operation; + - 4b. add the stream information for the new measurements if they will be reported by new streams, by invoking the `addStreamInfo` operation; + - 4c. update the stream information for the new measurements if they will be reported by existing streams, by invoking the `updateStreamInfo` operation. +5. The NF collects the measurements. This step is the internal behaviour of the NF. +6. The NF report the collected measurements to the producer of MnS for performance data streaming. The mechanism of this step is vendor specific. If producer of MnS for performance data streaming is in the NF, this step can be skipped. +7. The producer of MnS for performance data streaming sends the collected measurements to the consumer via performance data streams, by invoking the `reportStreamData` operation. + +### D.1.2 PlantUML codes + +``` +@startuml +skinparam shadowing false +skinparam monochrome true +hide footbox + +participant "Consumer of MnS for\nmeasurement control" as MC +participant "Producer of MnS for\nmeasurement control" as MP +participant "NF" as NF +participant "Producer of MnS for\nperformance data streaming" as SP +participant "Consumer of MnS for\nperformance data streaming" as SC + +alt Measurement job control service +else configurable measurement control service (i.e., NRM fragment based MnS) +alt create new MOI for collecting measurements +MC -> MP : 1b. createMOI\n(for PerfMetricJob IOC) +Else update existing MOI for collecting new measurements +MC -> MP : 1c. modifyMOIAttributes\n(for PerfMetricJob MOI) end +end + +MP --> NF: 2. Configure measurement\n collection (proprietary) + +activate NF +NF --> SP: 3. Set up streaming information\n for new measurements (proprietary) +alt No streaming(WebSocket) connection exists +SP->SC: 4a. establishStreamingConnection() + +else Streaming (WebSocket) connection exists +alt add new stream(s) +SP->SC: 4b. addStreamInfo() +else update existing stream(s) +SP->SC: 4c. updateStreamInfo() +end +end + +Loop while measurement collection\n is active +NF->NF: 5. Collect measurements +NF --> SP: 6. Report measurements\n (proprietary) +SP -> SC: 7. reportStreamData() +end + +@enduml +``` + +## D.2 Performance data streaming for stopping measurement collection + +### D.2.1 Sequence flow + +This annex shows the holistic sequence for performance data streaming in connection with the measurement collection termination. + +![Sequence diagram showing the interaction between Consumer of MnS for measurement control, Producer of MnS for measurement control, NF, Producer of MnS for performance data streaming, and Consumer of MnS for performance data streaming. The diagram details the steps to stop measurement collection and streaming.](4d5d6207a6d444ae745057ebc3ddcd86_img.jpg) + +``` + +sequenceDiagram + participant Consumer of MnS for measurement control + participant Producer of MnS for measurement control + participant NF + participant Producer of MnS for performance data streaming + participant Consumer of MnS for performance data streaming + + alt Measurement job control service + Consumer of MnS for measurement control->>Producer of MnS for measurement control: 1a. stopMeasurementJob (jobId) + alt delete the MOI to terminate measurements collection + Consumer of MnS for measurement control->>Producer of MnS for measurement control: 1b. deleteMOI (for PerfMetricJob MOI) + else update existing MOI to terminate measurements collection + Consumer of MnS for measurement control->>Producer of MnS for measurement control: 1c. modifyMOIAttributes (for PerfMetricJob MOI) + end + else configurable measurement job control service (i.e., NRM fragment based MnS) + Consumer of MnS for measurement control->>Producer of MnS for measurement control: 1b. deleteMOI (for PerfMetricJob MOI) + Consumer of MnS for measurement control->>Producer of MnS for measurement control: 1c. modifyMOIAttributes (for PerfMetricJob MOI) + end + + Producer of MnS for measurement control->>NF: 2. terminate measurement collection (proprietary) + NF->>NF: 3. stop collecting the measurements + NF->>Producer of MnS for performance data streaming: 4. terminate streaming for the measurements (proprietary) + + alt Streaming (WebSocket) connection is not needed anymore (e.g., no measurements need to be reported to the stream target) + Producer of MnS for performance data streaming->>Consumer of MnS for performance data streaming: 5a. terminateStreamingConnection() + else Streaming (WebSocket) connection is still needed + alt delete the obsolete stream(s) + loop For all of streams need to be deleted + Producer of MnS for performance data streaming->>Consumer of MnS for performance data streaming: 5b. deleteStreamInfo() + end + else update existing stream(s) + Producer of MnS for performance data streaming->>Consumer of MnS for performance data streaming: 5c. updateStreamInfo() + end + end + +``` + +Sequence diagram showing the interaction between Consumer of MnS for measurement control, Producer of MnS for measurement control, NF, Producer of MnS for performance data streaming, and Consumer of MnS for performance data streaming. The diagram details the steps to stop measurement collection and streaming. + +Figure D.2.1-1 + +1. The consumer of MnS for measurement control requests the MnS producer to stop the measurement collection by the following two alternatives: + - 1) by the measurement job control service + - 1a. The MnS consumer invokes the `stopMeasurementJob` operation towards the MnS producer; + - 2) by the configurable measurement control service (a.k.a, NRM fragment-based measurement control service) + - 1b. The MnS consumer deletes the `PerfMetricJob` MOI, by invoking the `deleteMOI` operation towards the MnS producer; + - 1c. The MnS consumer modifies the `PerfMetricJob` MOI with deletion of the measurements that do not need to be collected anymore, by invoking the `modifyMOIAttributes` operation towards the MnS producer. +2. The producer of MnS for measurement control requests the NF to stop collecting the measurements. The mechanism of this step is vendor specific. If producer of MnS for measurement control is in the NF, this step can be skipped. +3. The NF stops collecting the measurements. This step is the internal behaviour of the NF. + +4. The NF triggers the producer of MnS for performance data streaming to terminate streaming for the measurements. The mechanism of this step is vendor specific. If producer of MnS for performance data streaming is in the NF, this step can be skipped. +5. The producer of MnS for performance data streaming communicates with the consumer to: + - 5a. terminate the streaming (WebSocket) connection if no measurements need to be reported to the consumer anymore, by invoking the `terminateStreamingConnection` operation; + - 5b. delete the information for the stream(s) obsoleted due to the termination of the measurements collection if the streaming connection still needs to be retained, by invoking the `deleteStreamInfo` operation; + - 5c. update the information for the stream(s) partially affected by the termination of the measurements collection, by invoking the `updateStreamInfo` operation. + +### D.2.2 PlantUML codes + +``` +@startuml +skinparam shadowing false +skinparam monochrome true +hide footbox + +participant "Consumer of MnS for\n measurement control" as MC +participant "Producer of MnS for\n measurement control" as MP +participant "NF" as NF +participant "Producer of MnS for\n performance data streaming" as SP +participant "Consumer of MnS for\n performance data streaming" as SC + +alt Measurement job control service +MC -> MP : 1a. stopMeasurementJob\n(jobId) +else configurable measurement job control service (i.e., NRM fragment based MnS) +alt delete the MOI to terminate measurements collection +MC -> MP : 1b. deleteMOI\n(for PerfMetricJob MOI) +Else update existing MOI to terminate measurements collection +MC -> MP : 1c. modifyMOIAttributes\n(for PerfMetricJob MOI) end +end + +MP --> NF : 2. terminate measurement\n collection (proprietary) + +NF -> NF : 3. stop collecting the measurements +NF --> SP : 4. terminate streaming for the\n measurements (proprietary) +alt Streaming (WebSocket) connection is not needed anymore\n (e.g., no measurements need to be reported to the stream target) +SP->SC : 5a. terminateStreamingConnection() + +else Streaming (WebSocket) connection is still needed +alt delete the obsolete stream(s) +loop For all of streams need to be deleted +SP->SC : 5b. deleteStreamInfo() +end +else update existing stream(s) +SP->SC : 5c. updateStreamInfo() +end +end + +@enduml +``` + +# Annex E (normative): OpenAPI specification + +## E.1 Introduction + +This clause describes the capabilities of the Management Services in the structure of the OpenAPI Specification Version 3.0.1. The OpenAPI document is represented in the YAML format option. + +## E.2 OpenAPI document " TS28550\_PerMeasJobCtlMnS.yaml" + +``` + +openapi: 3.0.1 +info: + title: TS 28.550 Performance Measurement Job Control Service + version: 16.8.0 + description: >- + OAS 3.0.1 specification of the Performance Measurement Job Control Service + @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.550 V16.8.0; Performance assurance + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/ +servers: +- url: '{MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}' + variables: + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX +paths: + /measJobs: + post: + summary: Create a measurement job + description: To create a measurement job the representation of the measurement job is POSTed + on the /measJobs collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-RequestType' + responses: + '201': + description: Success case ("201 Created"). The representation of the newly created + measurement job resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-ResponseType' + '202': + description: Partial success case ("202 Partially created"). The representation of the + newly created measurement job resource with unsupported list shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Read resources of measurement jobs + description: 'With HTTP GET, resources of measurement jobs are read. The resources to be read + are identified with the path component (base resource) and the query component (jobIdList) of the + URI. The fields query component allows to select the resource properties to be returned.' + parameters: + - name: jobIdList + in: query + description: This parameter identifies the list of jobId to select the resources from the + collection resources identified with the path component of the URI. + +``` + +``` + + required: true + schema: + type: array + items: + type: string + responses: + '200': + description: 'Success case ("200 OK"). The resources identified in the request for +retrieval are returned in the response message body. In case the fields query parameter is used, the +selected resources are returned.' + content: + application/json: + schema: + $ref: '#/components/schemas/measJobsRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +'/measJobs/{jobId}': + get: + summary: Read resource of a single measurement job + description: 'With HTTP GET, resource of a measurement job is read. The resource to be read is +identified with the path component of the URI.' + parameters: + - name: jobId + in: path + description: Identifies the measurement job to be read. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '200': + description: 'Success case ("200 OK"). The resource identified in the path for retrieval +is returned in the response message body. ' + content: + application/json: + schema: + $ref: '#/components/schemas/measJobsRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: Delete a single measurement job + description: 'The measurement job is deleted by deleting the corresponding measurement job +resource. The resource to be deleted is identified with the path component of the URI.' + parameters: + - name: jobId + in: path + description: Identifies the measurement job to be deleted. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '204': + description: 'Success case ("204 No Content"). The measurement job resource has been +deleted. The response message body is absent.' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-Time + uri-Type: + type: string + measJobCreation-RequestType: + type: object + properties: + iOCName: + +``` + +``` + type: string + iOCInstanceList: + type: array + items: + $ref: '#/components/schemas/uri-Type' + measurementCategoryList: + type: array + items: + type: string + reportingMethod: + $ref: '#/components/schemas/reportingMethod-Type' + granularityPeriod: + type: integer + reportingPeriod: + type: integer + startTime: + $ref: '#/components/schemas/dateTime-Type' + stopTime: + $ref: '#/components/schemas/dateTime-Type' + schedule: + $ref: '#/components/schemas/schedule-Type' + streamTarget: + type: string + priority: + $ref: '#/components/schemas/priority-Type' + reliability: + type: string +measJobCreation-ResponseType: + type: object + properties: + unsupportedList: + type: array + items: + $ref: '#/components/schemas/unsupportedMeas-Type' +measJobsRetrieval-ResponseType: + type: object + properties: + jobInfoList: + type: array + items: + $ref: '#/components/schemas/measJobInfo-ResourceType' +error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string +measJobInfo-ResourceType: + type: object + properties: + href: + $ref: '#/components/schemas/uri-Type' + iOCName: + type: string + iOCInstanceList: + type: array + items: + $ref: '#/components/schemas/uri-Type' + measurementCategoryList: + type: array + items: + type: string + reportingMethod: + $ref: '#/components/schemas/reportingMethod-Type' + granularityPeriod: + type: integer + reportingPeriod: + type: integer + startTime: + $ref: '#/components/schemas/dateTime-Type' + stopTime: + $ref: '#/components/schemas/dateTime-Type' + schedule: + $ref: '#/components/schemas/schedule-Type' + streamTarget: + type: string +``` + +``` +priority: + $ref: '#/components/schemas/priority-Type' +reliability: + type: string +schedule-Type: + type: object + properties: + scheduleOption: + $ref: '#/components/schemas/scheduleOption-Type' + dailySchedule: + type: array + items: + $ref: '#/components/schemas/timeInterval-Type' + weeklySchedule: + type: array + items: + $ref: '#/components/schemas/scheduleOfDay-Type' +timeInterval-Type: + type: object + properties: + intervalStart: + type: string + format: Time + intervalEnd: + type: string + format: Time +scheduleOfDay-Type: + type: object + properties: + dayOfWeek: + $ref: '#/components/schemas/dayOfWeek-Type' + intervalsOfDay: + type: array + items: + $ref: '#/components/schemas/timeInterval-Type' +unsupportedMeas-Type: + type: object + properties: + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measurementTypeName: + type: string + reason: + type: string +reportingMethod-Type: + type: string + enum: + - file + - streaming +priority-Type: + type: string + enum: + - low + - medium + - high +scheduleOption-Type: + type: string + enum: + - daily + - weekly +dayOfWeek-Type: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday +``` + +## --- E.3 Void + +# Annex F (normative): Threshold crossing notifications triggering + +## F.1 Threshold crossing notifications triggering for cumulative counters + +For the threshold monitoring of performance measurements that are cumulative counters, the notification notifyThresholdCrossing is emitted immediately when the cumulative counter of measured events reached the threshold, without waiting to the end of the monitoring granularity period (GP). + +![A line graph showing 'Measurement value' on the y-axis and 'Time' on the x-axis. The graph is divided into two 'Monitoring GP' (granularity period) segments by vertical lines. Four horizontal dashed lines represent 'Threshold #1' (value 2), 'Threshold #2' (value 5), 'Threshold #3' (value 8), and 'Threshold #4' (value 10). In the first segment, the counter increases from 0 and crosses thresholds #1, #2, #3, and #4. In the second segment, after resetting to 0, it crosses thresholds #1 and #2. Yellow dots mark the points where thresholds are crossed, and orange dashed arrows point from these dots to the corresponding threshold lines, indicating the emission of a notification. A legend at the bottom shows an orange dashed arrow pointing to a yellow dot with the text 'Emits NotifyThresholdCrossing notification'.](72f8f68566ae1c43d361dd4b990b5631_img.jpg) + +A line graph showing 'Measurement value' on the y-axis and 'Time' on the x-axis. The graph is divided into two 'Monitoring GP' (granularity period) segments by vertical lines. Four horizontal dashed lines represent 'Threshold #1' (value 2), 'Threshold #2' (value 5), 'Threshold #3' (value 8), and 'Threshold #4' (value 10). In the first segment, the counter increases from 0 and crosses thresholds #1, #2, #3, and #4. In the second segment, after resetting to 0, it crosses thresholds #1 and #2. Yellow dots mark the points where thresholds are crossed, and orange dashed arrows point from these dots to the corresponding threshold lines, indicating the emission of a notification. A legend at the bottom shows an orange dashed arrow pointing to a yellow dot with the text 'Emits NotifyThresholdCrossing notification'. + +Figure F.1-1: Threshold crossing notifications triggering for cumulative counters + +## F.2 Threshold crossing notifications triggering for measurements that are not cumulative counters + +For the threshold monitoring of performance measurements that are not cumulative counters, the notification notifyThresholdCrossing is emitted at the end of the monitoring granularity period (GP) if the measurement value reached or crossed the threshold. + +The threshold crossing notification event time field indicates the time during the Monitoring GP that the threshold was crossed. + +![A line graph showing measurement values over time across three monitoring granularities (GP 1, GP 2, GP 3). Four horizontal dashed lines represent Threshold #1, #2, #3, and #4. The measurement line starts at 0, rises to T2 in GP 1, falls to T5 in GP 2, and rises to T6 in GP 3. Notifications are indicated by upward-pointing triangles at the end of each GP.](faff5ea2bac20b616b62b35da5a5d67c_img.jpg) + +The figure is a line graph with 'Measurement value' on the y-axis and 'Time' on the x-axis. The x-axis is divided into three segments labeled 'Monitoring GP 1', 'Monitoring GP 2', and 'Monitoring GP 3'. Four horizontal dashed lines represent thresholds, labeled from bottom to top as 'Threshold #1', 'Threshold #2', 'Threshold #3', and 'Threshold #4'. The measurement line starts at the origin (0) and rises through GP 1, crossing Threshold #1 (T1) and Threshold #2 (T2) before reaching the end of GP 1. At the end of GP 1, an upward-pointing triangle indicates a notification. The line then falls through GP 2, crossing Threshold #3 (T3) and Threshold #2 (T4) before reaching the end of GP 2. At the end of GP 2, another upward-pointing triangle indicates a notification. The line then rises through GP 3, crossing Threshold #1 (T5) and Threshold #2 (T6) before reaching the end of GP 3. At the end of GP 3, a third upward-pointing triangle indicates a notification. A legend at the bottom shows an upward-pointing triangle with a dashed line and a yellow circle, labeled 'Emits NotifyThresholdCrossing notification'. + +A line graph showing measurement values over time across three monitoring granularities (GP 1, GP 2, GP 3). Four horizontal dashed lines represent Threshold #1, #2, #3, and #4. The measurement line starts at 0, rises to T2 in GP 1, falls to T5 in GP 2, and rises to T6 in GP 3. Notifications are indicated by upward-pointing triangles at the end of each GP. + +**Figure F.2-1: Threshold crossing notifications triggering for measurements that are not cumulative counters** + +Thresholds configured in both directions would emit the following notifications: + +Notifications are emitted for Threshold #1 (T1) and Threshold #2 (T2) at end of Monitoring GP 1. + +Notifications are emitted for Threshold #2 (T3) and Threshold #1 (T4) at end of Monitoring GP 2. + +Notifications are emitted for Threshold #1 (T5) and Threshold #2 (T6) at end of Monitoring GP 3. + +# Annex G (normative): ASN.1 definition for performance data stream units + +## G.1 ASN.1 definition rule + +For performance data streaming, the type of WebSocket Data frame shall be binary (with opcode of 0x2). + +This subclause specifies the abstract syntax notation one (ASN.1) definition for the Performance Data Stream Units as Payload data of WebSocket Data frame. + +The Performance Data Stream Units are described using ASN.1 as specified in ITU-T Rec. X.680 [15] and X.681 [16]. Transfer syntax for Performance Data Stream Units is derived from their ASN.1 definitions by use of Packed Encoding Rules (PER), aligned as specified in ITU-T Rec. X.691 [17]. + +The following encoding rules apply in addition to what has been specified in ITU-T Rec. X.691 [17]: + +- When a bit string value is placed in a bit-field as specified in clause 15.6 to 15.11 in ITU-T Rec X.691 [c], the leading bit of the bit string value shall be placed in the leading bit of the bit-field, and the trailing bit of the bit string value shall be placed in the trailing bit of the bit-field; +- When decoding a BIT STRING or OCTET STRING constrained with a Contents Constraint, PER decoders are required to never report an error if there are extraneous zero or non-zero bits at the end of the BIT STRING or OCTET STRING. + +NOTE: The terms 'leading bit' and 'trailing bit' are defined in ITU-T Rec. X.680 [15]. When using the 'bstring' notation, the leading bit of the bit string value is on the left, and the trailing bit of the bit string value is on the right. + +## G.2 ASN.1 definition + +``` +-- ASN1START +PerformanceDataStreamUnits-Schema DEFINITIONS AUTOMATIC TAGS ::= +BEGIN +-- PDSUs-START + +PDSUs ::= + SEQUENCE OF PDSU + +PDSU ::= SEQUENCE { + streamId INTEGER, + granularityPeriodEndTime DATE-TIME, + standardizedMeasResults SEQUENCE OF MeasValue, + vendorSpecificMeasResults SEQUENCE OF MeasValue OPTIONAL -- may be omitted +} + +MeasValue ::= CHOICE { + integerValue INTEGER, + realValue REAL, + stringValue VisibleString, + subCounters SubCounterListType, + ... -- allow extension in futher version +} + +-- uses recursion for the value to support multi-dimensional measurements +SubCounterListType ::= SEQUENCE { + subCounterIndex SubCounterIndexType, + subCounterValue MeasValue OPTIONAL -- "empty" bins are allowed +} + +SubCounterIndexType ::= CHOICE { + sum VisibleString ("SUM"), + binIndex INTEGER, + qos-5QI INTEGER, + qos-QCI INTEGER, + cause INTEGER, + stringIndex VisibleString, + plmn OCTET STRING (SIZE(3)), -- definition from TS 38.413 + sNSSAI SEQUENCE { -- definition from TS 38.413 + sst OCTET STRING (SIZE(1)), + sd OCTET STRING (SIZE(3)) + } +} +``` + +----- + +----- + +``` + }, + ... +} + +-- PDSUs-STOP +END +-- ASN1STOP +``` + +# Annex H (normative): NSI and NSSI performance assurance + +## H.1 General + +After network slice instance is created, 3GPP management system creates all resources to the NSI and configurations satisfy the network slice requirements, including the performance of NSI requested according to network slice SLS (as part of SLA). In order to guarantee the performance of network slice, NSI modification can be triggered by NSI provisioning service. During the NSI performance supervision, the end to end KPIs defined in TS 28.554 [21], performance measurements defined in TS 28.552[2] and optionally slice QoE provided by NWDAF in 3GPP TS 23.288 [22] should be used for SLA fulfilment evaluation. According to the evaluation result, NSI modification defined in TS 28.531[24] can be triggered for network slice performance assurance. + +## H.2 Procedure of NSI and NSSI performance assurance + +This Figure H.2-1 illustrates the procedure of performance assurance for NSI(s) or NSSI(s). + +![Sequence diagram showing the procedure for NSI and NSSI performance assurance. Lifelines: NSMS_Consumer, NSMS_Producer, NSSMS_Producer, NFMS_Producer, NFV-MANO, NWDAF. The process starts with NSI allocation, followed by a loop 'Until NSI deactivation' containing steps: 2. Slice QoE from NWDAF, 3. Check whether the performance requirements meet, 4a. NSI modification procedure, and 4b. NSSI modification procedure.](6334c962f5e106e3331e59946e4d166e_img.jpg) + +``` + +sequenceDiagram + participant NSMS_Consumer + participant NSMS_Producer + participant NSSMS_Producer + participant NFMS_Producer + participant NFV-MANO + participant NWDAF + + Note over NSMS_Consumer: (User icon) + rect rgb(255, 255, 255) + Note over NSMS_Producer, NFV-MANO: 1. NSI allocation + end + loop Until NSI deactivation + NWDAF-->>NSSMS_Producer: 2. Slice QoE from NWDAF + Note over NSMS_Producer, NSSMS_Producer: 3. Check whether the performance requirements meet + opt + Note over NSMS_Producer: 4a. NSI modification procedure + Note over NSSMS_Producer: 4b. NSSI modification procedure + end + end + +``` + +Sequence diagram showing the procedure for NSI and NSSI performance assurance. Lifelines: NSMS\_Consumer, NSMS\_Producer, NSSMS\_Producer, NFMS\_Producer, NFV-MANO, NWDAF. The process starts with NSI allocation, followed by a loop 'Until NSI deactivation' containing steps: 2. Slice QoE from NWDAF, 3. Check whether the performance requirements meet, 4a. NSI modification procedure, and 4b. NSSI modification procedure. + +**Figure H.2-1: Example of procedure for NSI and NSSI performance assurance** + +1. The authorized consumer requests NSMS\_Producer to allocate a new NSI. NSMS\_Producer consumes provisioning services provided by NSSMS\_Producer to create the NSI. After NSI allocation, the NSMS\_Producer and NSSMS\_Producer perform NSI and NSSI performance supervision. +2. The NSMS\_Producer or NSSMS\_Producer may get slice QoE analytics provided by NWDAF. +3. The NSMS\_Producer or NSSMS\_Producer checks whether the performance requirements can be met by NSI or NSSI by utilizing the end to end KPIs defined in TS 28.554 [21], performance measurements defined in TS 28.552[2] and slice QoE analytics provided by NWDAF in 3GPP TS 23.288 [22]. + +- 4a. If the performance requirements of NSI cannot be met, the NSMS\_Producer triggers the NSI modification procedure. NSMS\_Producer modifies the capacity of the network slice, or modifies the network slice configuration to guarantee the performance requirements. +- 4b. If the performance requirements of NSSI cannot be met, the NSSMS\_Producer of CN modifies virtualized resources and the configuration of 5GC NFs to guarantee the performance requirements. NSSMS\_Producer of AN reconfigures RRMPolicy to optimize performance. + +# Annex I (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-03 | SA#83 | SP-190122 | 0003 | 1 | F | Add the missing RESTful API definitions | 15.1.0 | +| 2019-03 | SA#83 | SP-190122 | 0007 | 1 | F | Correction on MDAS | 15.1.0 | +| 2019-03 | SA#83 | SP-190111 | 0004 | 1 | B | Add operations for performance data streaming | 16.0.0 | +| 2019-06 | SA#84 | SP-190371 | 0008 | 1 | B | Add performance threshold monitoring service | 16.1.0 | +| 2019-09 | SA#85 | SP-190748 | 0009 | 3 | A | Add the missing stage 3 solutions for performance data streaming | 16.2.0 | +| 2019-09 | SA#85 | SP-190746 | 0010 | - | F | Correction on StreamInfoList | 16.2.0 | +| 2019-09 | SA#85 | SP-190748 | 0012 | - | A | Correction on performance data file reporting service components | 16.2.0 | +| 2019-09 | SA#85 | SP-190746 | 0013 | - | F | Correction on performance data streaming service components | 16.2.0 | +| 2019-09 | SA#85 | SP-190748 | 0016 | 1 | A | Remove the PM file format | 16.2.0 | +| 2019-09 | SA#85 | SP-190746 | 0027 | 1 | B | NSI and NSSI performance assurance | 16.2.0 | +| 2019-09 | SA#85 | SP-190746 | 0028 | 1 | B | Add use case for NSI performance threshold monitoring | 16.2.0 | +| 2019-09 | SA#85 | SP-190746 | 0029 | 1 | B | Add use case for NSSI performance threshold monitoring | 16.2.0 | +| 2019-12 | SA#86 | SP-191171 | 0030 | 1 | B | Add performance management service enhancement for tenant support | 16.3.0 | +| 2019-12 | SA#86 | SP-191174 | 0033 | 2 | A | Add stream information management related operations | 16.3.0 | +| 2019-12 | SA#86 | SP-191150 | 0034 | 4 | B | Add UC and requirements for KPI job control | 16.3.0 | +| 2019-12 | SA#86 | SP-191150 | 0038 | 1 | B | Add management service responsible for KPI job control | 16.3.0 | +| 2019-12 | SA#86 | SP-191150 | 0039 | - | F | Update the description of scope | 16.3.0 | +| 2019-12 | SA#86 | SP-191150 | 0042 | 1 | B | Enhance performance data report related operations to support KPI reporting | 16.3.0 | +| 2020-03 | SA#87E | SP-200181 | 0044 | 1 | A | Update the performance data streaming procedure | 16.4.0 | +| 2020-03 | SA#87E | SP-200181 | 0046 | 1 | A | Add streaming procedure for measurement collection termination | 16.4.0 | +| 2020-07 | SA#88-E | SP-200497 | 0052 | 4 | B | Clarify performance measurement for a tenant | 16.5.0 | +| 2020-07 | SA#88-E | SP-200484 | 0054 | - | F | Correct Typo of Reference | 16.5.0 | +| 2020-07 | SA#88-E | SP-200492 | 0056 | 1 | A | Add description for MnS components used for configurable performance measurement control | 16.5.0 | +| 2020-07 | SA#88-E | SP-200497 | 0057 | 1 | B | Add use case for performance management supporting multiple tenant | 16.5.0 | +| 2020-07 | SA#88-E | SP-200485 | 0058 | - | C | Convert performance measurement job control API to YAML | 16.5.0 | +| 2020-09 | SA#89E | SP-200738 | 0059 | - | F | Update description of MnS components used for configurable PM control | 16.6.0 | +| 2020-09 | SA#89E | SP-200724 | 0061 | - | F | Correction of performance data streaming sequence flow | 16.6.0 | +| 2020-09 | SA#89E | SP-200731 | 0063 | - | A | Remove the streaming solution from 28.550 | 16.6.0 | +| 2020-12 | SA#90e | SP-201057 | 0064 | - | F | Clarification on emission of threshold crossing notifications for non-cumulative counters | 16.7.0 | +| 2020-12 | SA#90e | SP-201088 | 0065 | - | F | Update attribute measType used in Annex C | 16.7.0 | +| 2021-09 | SA#93e | SP-210880 | 0068 | 1 | A | Correction of OpenAPI | 16.8.0 | +| 2022-06 | SA#96 | SP-220498 | 0069 | - | F | OpenAPI file name and dependence change | 16.9.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28611/raw.md b/marked/Rel-16/28_series/28611/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6281156460d1f2abbe39c206baafd84c7e5ce35f --- /dev/null +++ b/marked/Rel-16/28_series/28611/raw.md @@ -0,0 +1,146 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Concepts and background ..... | 6 | +| 5 Requirements ..... | 6 | +| Annex A (informative): Change history..... | 7 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +**TS 28.611: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Requirements"** + +TS 28.612: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" + +TS 28.616: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions" + +# --- 1 Scope + +The present document describes the Network Resource Model (NRM) Integration Reference Point (IRP) requirements for the EPC and WLAN interworking system according to the structure defined in 3GPP TS 23.402 [8] (e.g. ePDG, 3GPP AAA, etc). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [6] Void +- [7] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [8] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Integration Reference Point (IRP):** See 3GPP TS 32.150 [5]. + +**Information Service (IS):** See 3GPP TS 32.150 [5]. + +**Solution Set (SS):** See 3GPP TS 32.150 [5]. + +**IRP Solution Set:** See 3GPP TS 32.101 [1]. + +## 3.2 Abbreviations + +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]. + +| | | +|------|------------------------------------------| +| AAA | Access, Authentication and Authorisation | +| ePDG | evolved Packet Data Gateway | +| IRP | Integration Reference Point | +| IOC | Information Object Class | +| NRM | Network Resource Model | + +# --- 4 Concepts and background + +The architectures of enhancement for non-3GPP access (i.e. WLAN) to 3GPP system are defined in 3GPP TS 23.402 [8]. + +In TS 23.402, three kinds of architectures are defined, using S2a, S2b and S2c interface separately. + +The architectures of S2a and S2c don't introduce new network elements in 3GPP system, while the architecture S2b introduces a new network element to support the interworking: + +- evolved Packet Data Gateway (ePDG) (clause 4.3.4 of 3GPP TS 23.402 [8]). + +The above interworking related network element should be managed by the 3GPP OAM, and the corresponding NRM IRP needs to be defined. + +Based on the above characteristics, this specification defines the evolved 3GPP interworking WLAN NRM IRP requirements. + +# --- 5 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [2]. +- b) IRP-related requirements in 3GPP TS 32.102 [3]. +- c) IRP-related requirements in 3GPP TS 32.600 [4]. + +In addition to the above, the following more specific requirements apply: + +###### **REQ-EPC\_WLAN-CON-001** + +The Network Resource Model defined by this IRP shall contain ePDG specific IOCs and related definitions. This requirement should be satisfied when the S2b architecture is implemented. + +###### **REQ-EPC\_WLAN-CON-002** + +The Network Resource Model defined by this IRP shall contain 3GPP AAA specific IOCs and related definitions. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|-----|-----|---------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| Oct 2011 | SA5-79 | | -- | -- | Initial version for TS skeleton | --- | 0.0.1 | +| Feb 2012 | SA5-81 | | | | Added NRM IRP requirements | 0.0.1 | 0.1.0 | +| Aug 2013 | | | | | Revise the document title and release information | 0.1.0 | 0.1.1 | +| Sep 2013 | SA-61 | SP-130448 | | | Presented for information | 0.1.1 | 1.0.0 | +| Sep 2013 | - | - | | | MCC clean-up | 1.0.0 | 1.0.1 | +| Nov 2013 | | | | | Remove editor notes | 1.0.1 | 1.1.1 | +| Dec 2013 | SA-62 | SP-130633 | | | Presented for approval | 1.1.1 | 2.0.0 | +| Dec 2013 | | | | | Version after approval | 2.0.0 | 12.0.0 | +| Sep 2014 | SA-65 | SP-140560 | 004 | - | Remove unused reference | 12.0.0 | 12.1.0 | +| Dec 2014 | SA-66 | SP-140798 | 005 | 1 | Remove feature support statement | 12.1.0 | 12.2.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.2.0 | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | 14.0.0 | +| 2018-12 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | 15.0.0 | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28612/35a7554182eb055209552843f341a1ae_img.jpg b/marked/Rel-16/28_series/28612/35a7554182eb055209552843f341a1ae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6a779d31682b2acc223613f8066c7ee6c660750 --- /dev/null +++ b/marked/Rel-16/28_series/28612/35a7554182eb055209552843f341a1ae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48161b626a776270cac015051994632e97456a824e936c214dcec021d1989999 +size 51132 diff --git a/marked/Rel-16/28_series/28612/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg b/marked/Rel-16/28_series/28612/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4588d7c19ac8671e3d86f526a383f3652c11c6b4 --- /dev/null +++ b/marked/Rel-16/28_series/28612/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e07973a3aafb46ba3245703c8f0835cf9999fab9c2ecfdc432957cff24d84903 +size 58810 diff --git a/marked/Rel-16/28_series/28612/raw.md b/marked/Rel-16/28_series/28612/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8f5c192cc8613851f977e736c605197599b4e33a --- /dev/null +++ b/marked/Rel-16/28_series/28612/raw.md @@ -0,0 +1,375 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 7 | +| 4.1 Imported information entities and local labels..... | 7 | +| 4.2 Class diagram..... | 7 | +| 4.2.1 Relationships ..... | 7 | +| 4.2.2 Inheritance ..... | 8 | +| 4.3 Class definitions ..... | 8 | +| 4.3.1 Link_3GPPAAAServer_PGW ..... | 8 | +| 4.3.1.1 Definition ..... | 8 | +| 4.3.1.2 Attributes ..... | 8 | +| 4.3.1.3 Attribute constraints..... | 8 | +| 4.3.1.4 Notifications..... | 8 | +| 4.3.2 Link_3GPPAAAServer_HSS ..... | 8 | +| 4.3.2.1 Definition ..... | 8 | +| 4.3.2.2 Attributes ..... | 8 | +| 4.3.2.3 Attribute constraints..... | 9 | +| 4.3.2.4 Notifications..... | 9 | +| 4.3.3 Link_3GPPAAProxy_3GPPAAAServer..... | 9 | +| 4.3.3.1 Definition ..... | 9 | +| 4.3.3.2 Attributes ..... | 9 | +| 4.3.3.3 Attribute constraints..... | 9 | +| 4.3.3.4 Notifications..... | 9 | +| 4.3.4 3GPPAAProxyFunction ..... | 9 | +| 4.3.4.1 Definition ..... | 9 | +| 4.3.4.2 Attributes ..... | 9 | +| 4.3.4.3 Attribute constraints..... | 9 | +| 4.3.4.4 Notifications..... | 9 | +| 4.3.5 3GPPAAAServerFunction..... | 9 | +| 4.3.5.1 Definition ..... | 9 | +| 4.3.5.2 Attributes ..... | 9 | +| 4.3.5.3 Attribute constraints..... | 10 | +| 4.3.5.4 Notifications..... | 10 | +| 4.4 Attribute definitions ..... | 10 | +| 4.4.1 Attribute properties..... | 10 | +| 4.4.2 Constraints ..... | 10 | +| 4.5 Common notifications ..... | 10 | +| 4.5.1 Alarm notifications ..... | 10 | +| 4.5.2 Configuration notifications..... | 10 | +| Annex A (informative): Change history..... | 11 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- TS 28.611: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Requirements"; +- TS 28.612: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" ;** +- TS 28.616: " Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +The interface Itf-N, defined in 3GPP TS 32.102 [3], is built up by a number of Integration Reference Points (IRPs) and a related Name Convention, which realize the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TS 32.103 [13]. + +# 1 Scope + +The present document is an Integration Reference Point (IRP) named "Evolved Packet Core (EPC) and non-3GPP access interworking system Network resource Model (NRM) IRP; Information Service (IS)", through which an 'IRP Agent' (typically an Element Manager or Network Element) can communicate configuration management information to one or several 'IRP Managers' (typically Network Managers) concerning interworking network resources. + +The present document specifies the semantics and behaviour of Information Object Class (IOC) attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +It reuses relevant parts of the generic NRM in 3GPP TS 28.622 [6], either by direct reuse or sub-classing, and in addition to that defines specific IOCs in EPC and non-3GPP access interworking systems. + +In order to access the information defined by this NRM, an interface IRP is needed, such as the Basic CM IRP IS (3GPP TS 32.602 [7]) or the Bulk CM IRP IS (3GPP TS 32.612 [8]). However, which interface IRP is applicable is outside the scope of the present document. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 25.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP): Information Service (IS)". +- [8] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [9] Void. +- [10] 3GPP TS 28.708: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [11] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [12] 3GPP TS 28.705: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +- [13] 3GPP TS 32.103: "Telecommunication management; Integration Reference Point (IRP) overview and usage guide". +- [14] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [15] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [16] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.101 [2], TS 32.102 [3], TS 32.150 [14], TS 28.622 [6], TS 32.600 [4] 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]. + +## 3.2 Abbreviations + +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]. + +| | | +|-----|--------------------------| +| DN | Distinguished Name | +| IOC | Information Object Class | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|---------------------------------------|-------------| +| 3GPP TS 28.622 [6], IOC, Link | Link | +| 3GPP TS 28.708 [10], IOC, PGWFunction | PGWFunction | +| 3GPP TS 28.705 [12], IOC, HSSFunction | HSSFunction | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) encapsulating the information relevant for this IRP. This clause provides an overview of the relationships between relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +![UML Class diagram showing relationships between PGWFunction, Link_3GPPAAAServer_PGW, HSSFunction, 3GPPAAAServerFunction, Link_3GPPAAProxy_3GPPAAAServer, and 3GPPAAProxyFunction. The diagram includes associations with multiplicities and reference points (S6b, SWd, SWx).](ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg) + +``` + +classDiagram + class PGWFunction["«InformationObjectClass» +PGWFunction +(from 28.708)"] + class Link_3GPPAAAServer_PGW["«InformationObjectClass» +Link_3GPPAAAServer_PGW"] + class HSSFunction["«InformationObjectClass» +HSSFunction +(from 28.705)"] + class 3GPPAAAServerFunction["«InformationObjectClass» +3GPPAAAServerFunction"] + class Link_3GPPAAProxy_3GPPAAAServer["«InformationObjectClass» +Link_3GPPAAProxy_3GPPAAAServer"] + class 3GPPAAProxyFunction["«InformationObjectClass» +3GPPAAProxyFunction"] + + PGWFunction "*" -- "*" Link_3GPPAAAServer_PGW + Link_3GPPAAAServer_PGW .. "*" 3GPPAAAServerFunction + HSSFunction "*" -- "*" 3GPPAAAServerFunction + Link_3GPPAAAServer_PGW .. "*" Link_3GPPAAProxy_3GPPAAAServer + Link_3GPPAAAServer_PGW .. "*" 3GPPAAProxyFunction + HSSFunction "*" -- "*" Link_3GPPAAAServer_HSS + Link_3GPPAAAServer_HSS .. "*" 3GPPAAProxyFunction + Link_3GPPAAProxy_3GPPAAAServer .. "*" 3GPPAAProxyFunction + + note for PGWFunction "S6b ref.point" + note for Link_3GPPAAProxy_3GPPAAAServer "SWd ref.point" + note for Link_3GPPAAAServer_HSS "SWx ref.point" + +``` + +UML Class diagram showing relationships between PGWFunction, Link\_3GPPAAAServer\_PGW, HSSFunction, 3GPPAAAServerFunction, Link\_3GPPAAProxy\_3GPPAAAServer, and 3GPPAAProxyFunction. The diagram includes associations with multiplicities and reference points (S6b, SWd, SWx). + +Figure 4.2.1.1 IOC containment and association diagram + +### 4.2.2 Inheritance + +![IOC inheritance diagram showing ManagedFunction and Link as base classes for various 3GPPAA functions and links.](35a7554182eb055209552843f341a1ae_img.jpg) + +``` +classDiagram + class ManagedFunction["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + class Link["«InformationObjectClass» +Link +(from 28.622)"] + class 3GPPAAPProxyFunction["«InformationObjectClass» +3GPPAAPProxyFunction"] + class 3GPPAAPServerFunction["«InformationObjectClass» +3GPPAAPServerFunction"] + class Link_3GPPAAPServer_HSS["«InformationObjectClass» +Link_3GPPAAPServer_HSS"] + class Link_3GPPAAPProxy_3GPPAAPServer["«InformationObjectClass» +Link_3GPPAAPProxy_3GPPAAPServer"] + class Link_3GPPAAPServer_PGW["«InformationObjectClass» +Link_3GPPAAPServer_PGW"] + + ManagedFunction <|-- 3GPPAAPProxyFunction + ManagedFunction <|-- 3GPPAAPServerFunction + Link <|-- Link_3GPPAAPServer_HSS + Link <|-- Link_3GPPAAPProxy_3GPPAAPServer + Link <|-- Link_3GPPAAPServer_PGW +``` + +IOC inheritance diagram showing ManagedFunction and Link as base classes for various 3GPPAA functions and links. + +Figure 4.2.2.1: IOC inheritance diagram + +## 4.3 Class definitions + +### 4.3.1 Link\_3GPPAAPServer\_PGW + +#### 4.3.1.1 Definition + +This IOC represents the S6b reference point as defined in 3GPP TS 23.402 [5]. + +#### 4.3.1.2 Attributes + +None. + +#### 4.3.1.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +The common notifications defined in clause 4.5 are valid without exceptions or additions for this IOC. + +### 4.3.2 Link\_3GPPAAPServer\_HSS + +#### 4.3.2.1 Definition + +This IOC represents the SWx reference point as defined in 3GPP 23.402 [5]. + +#### 4.3.2.2 Attributes + +None. + +#### 4.3.2.3 Attribute constraints + +None. + +#### 4.3.2.4 Notifications + +The common notifications defined in clause 4.5 are valid without exceptions or additions for this IOC. + +### 4.3.3 Link\_3GPPAAProxy\_3GPPAAAServer + +#### 4.3.3.1 Definition + +This IOC represents the SWd reference point as defined in 3GPP 23.402 [5]. + +#### 4.3.3.2 Attributes + +None. + +#### 4.3.3.3 Attribute constraints + +None. + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid without exceptions or additions for this IOC. + +### 4.3.4 3GPPAAProxyFunction + +#### 4.3.4.1 Definition + +This IOC represents the 3GPP Access, Authentication and Authorisation (AAA) Proxy functionality. For more information about the 3GPP AAA Proxy, see 3GPP TS 23.402 [5]. + +#### 4.3.4.2 Attributes + +None. + +#### 4.3.4.3 Attribute constraints + +None. + +#### 4.3.4.4 Notifications + +The common notifications defined in clause 4.5 are valid without exceptions or additions for this IOC. + +### 4.3.5 3GPPAAAServerFunction + +#### 4.3.5.1 Definition + +This IOC represents the 3GPP Access, Authentication and Authorisation (AAA) Server functionality. For more information about the 3GPP AAA server, see 3GPP TS 23.402 [5]. + +#### 4.3.5.2 Attributes + +None. + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.5 are valid without exceptions or additions for this IOC. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +None. + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This clause presents a list of notifications, defined in 3GPP TS 32.111-2 [11], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in 3GPP TS 32.302 [16], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|---------------------------------------------|---------------------------------------|-------| +| <code>notifyAckStateChanged</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyChangedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyClearedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyNewAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyComments</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyAlarmListRebuilt</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyPotentialFaultyAlarmList</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | + +### 4.5.2 Configuration notifications + +This clause presents a list of notifications, defined in 3GPP TS 32.662 [15], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in 3GPP TS 32.302 [16], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|-----------------------------------------|-----------|-------| +| <code>notifyAttributeValueChange</code> | O | | +| <code>notifyObjectCreation</code> | O | | +| <code>notifyObjectDeletion</code> | O | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|-------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| Feb 2012 | | | -- | -- | Initial draft | -- | 0.0.1 | +| Dec 2012 | | | | | Add IOCs definition | 0.0.1 | 0.1.1 | +| May 2013 | | | | | Revise the skeleton align with TS 28.622 according to the agreed S5-131062 | 0.1.1 | 0.1.2 | +| Jun 2013 | | | | | Add common notifications according to agreed pCR S5-131065 | 0.1.2 | 0.2.0 | +| Aug 2013 | | | | | Revise the NRM diagram to align with 28- series | 0.2.0 | 0.3.0 | +| Sep 2013 | SA#61 | SP-130449 | | | Presented for information | 0.3.0 | 1.0.0 | +| Sep 2013 | - | - | | | MCC clean-up | 1.0.0 | 1.0.1 | +| Nov 2013 | | | | | Align with IS template | 1.0.1 | 1.0.2 | +| Dec 2013 | SA#62 | SP-130634 | | | Presented for approval | 1.0.2 | 2.0.0 | +| Dec 2013 | | | | | Version after approval | 2.0.0 | 12.0.0 | +| Sep 2014 | SA#65 | SP-140614 | 001 | 1 | Move IOCs from discontinued TS 28.602 - align with TSG SA decision to remove I-WLAN | 12.0.0 | 12.1.0 | +| Dec 2014 | SA#66 | SP-140798 | 002 | 1 | Remove feature support statement | 12.1.0 | 12.2.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.2.0 | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | 14.0.0 | +| 2018-12 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | 15.0.0 | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28616/raw.md b/marked/Rel-16/28_series/28616/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..53fb8ff05e6bb39e0ca32c07729af61deaacbdb1 --- /dev/null +++ b/marked/Rel-16/28_series/28616/raw.md @@ -0,0 +1,552 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution set definitions..... | 8 | +| <b>Annex A (normative): CORBA solution set .....</b> | <b>9</b> | +| A.0 General..... | 9 | +| A.1 Architectural features..... | 9 | +| A.1.0 Introduction..... | 9 | +| A.1.1 Syntax for Distinguished Names..... | 9 | +| A.1.2 Rules for NRM extensions ..... | 9 | +| A.2 Mapping ..... | 9 | +| A.2.1 General mapping ..... | 9 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC Link_3GPPAAAServer_PGW ..... | 9 | +| A.2.2.2 IOC Link_3GPPAAAServer_HSS ..... | 9 | +| A.2.2.3 IOC Link_3GPPAAProxy_3GPPAAAServer ..... | 9 | +| A.2.2.4 IOC 3GPPAAProxyFunction ..... | 10 | +| A.2.2.5 IOC 3GPPAAAServerFunction..... | 10 | +| A.3 Solution set definitions..... | 11 | +| A.3.1 IDL definition structure..... | 11 | +| A.3.2 IDL specification "EPCn3aINetworkResourcesNRMDefs.idl"..... | 11 | +| <b>Annex B (normative): XML definitions.....</b> | <b>13</b> | +| B.0 General..... | 13 | +| B.1 Architectural features..... | 13 | +| B.1.0 Introduction..... | 13 | +| B.1.1 Syntax for Distinguished Names..... | 13 | +| B.2 Mapping ..... | 13 | +| B.2.1 General mapping ..... | 13 | +| B.2.2 Information Object Class (IOC) mapping..... | 13 | +| B.3 Solution set definitions..... | 14 | +| B.3.1 XML definition structure ..... | 14 | +| B.3.2 Graphical representation ..... | 14 | +| B.3.3 XML schema "EPCn3aINrm.xsd" ..... | 14 | +| Annex C (informative): Change history..... | 17 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- TS 28.611: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- TS 28.612: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM); Integration Reference Point (IRP) Information Service (IS) ". +- TS 28.616: "Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Evolved Packet Core (EPC) and non-3GPP access Interworking System Network Resource Model (NRM) IRP, through which an IRP<sub>Agent</sub> can communicate configuration management information to one or several IRP<sub>Managers</sub> concerning EPC and non-3GPP access interworking system resources. The EPC and non-3GPP access Interworking System NRM IRP comprises a set of specifications defining requirements, a protocol neutral information service and one or more solution sets. + +The present document specifies the solution sets for the EPC and non-3GPP access interworking system NRM IRP. + +This solution set specification is related to 3GPP TS 28.612 V14.0.X [4]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". +- [2] Void. +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.612: "Telecommunication management; Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] 3GPP TS 28.623: "Generic network resources Integration Reference Point (IRP); Solution Set (SS) definitions". +- [9] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.600 [3] 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]. + +**XML file:** See definition in 3GPP TS 28.623 [8]. + +**XML document:** See definition in 3GPP TS 28.623 [8]. + +**XML declaration:** See definition in 3GPP TS 28.623 [8]. + +**XML element:** See definition in 3GPP TS 28.623 [8]. + +**empty XML element:** See definition in 3GPP TS 28.623 [8]. + +**XML content (of an XML element):** See definition in 3GPP TS 28.623 [8]. + +**XML start-tag:** See definition in 3GPP TS 28.623 [8]. + +**XML end-tag:** See definition in 3GPP TS 28.623 [8]. + +**XML empty-element tag:** See definition in 3GPP TS 28.623 [8]. + +**XML attribute specification:** See definition in 3GPP TS 28.623 [8]. + +**DTD:** See definition in 3GPP TS 28.623 [8]. + +**XML schema:** See definition in 3GPP TS 28.623 [8]. + +**XML namespace:** See definition in 3GPP TS 28.623 [8]. + +**XML complex type:** See definition in 3GPP TS 28.623 [8]. + +**XML element type:** See definition in 3GPP TS 28.623 [8]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1], TS 32.600 [3], 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]. + +| | | +|-----|--------------------------| +| CM | Configuration Management | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| IOC | Information Object Class | +| MO | Managed Object | +| MOC | Managed Object Class | +| SS | Solution Set | +| XSD | XML Schema Definition | + +# --- 4 Solution set definitions + +This specification defines the following 3GPP Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP solution set definitions: + +- 3GPP Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP CORBA SS (see Annex A) +- 3GPP Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP XML definitions (see Annex B) + +# --- Annex A (normative): CORBA solution set + +## A.0 General + +This annex contains the CORBA solution set for the IRP whose semantics is specified in Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP: Information Service (IS) (3GPP TS 28.612 [4]). + +--- + +## A.1 Architectural features + +### A.1.0 Introduction + +The overall architectural feature of Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resources IRP is specified in 3GPP TS 28.612 [4]. + +This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of 3GPP TS 28.623 [8]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.2 of 3GPP TS 28.623 [8]. + +--- + +### A.2 Mapping + +#### A.2.1 General mapping + +See clause A.2.1 of 3GPP TS 28.623 [8]. + +#### A.2.2 Information Object Class (IOC) mapping + +#### A.2.2.1 IOC Link\_3GPPAAAServer\_PGW + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [8]. + +#### A.2.2.2 IOC Link\_3GPPAAAServer\_HSS + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [8]. + +#### A.2.2.3 IOC Link\_3GPPAAProxy\_3GPPAAAServer + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [8]. + +#### A.2.2.4 IOC 3GPPAAProxyFunction + +**Table A.2.2.4: Mapping from NRM IOC 3GPPAAProxyFunction attributes to SS equivalent MOC 3GPPAAProxyFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | id | string | + +##### A.2.2.5 IOC 3GPPAAAServerFunction + +**Table A.2.2.5: Mapping from NRM IOC 3GPPAAAServerFunction attributes to SS equivalent MOC 3GPPAAAServerFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | id | string | + +## A.3 Solution set definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP. + +#### A.3.2 IDL specification + +"EPCn3aINetworkResourcesNRMDefs.idl" + +``` +// File: EPCn3aINetworkResourcesNRMDefs.idl +#ifndef _EPCN3AINETWORKRESOURCESNRMDEFS_IDL_ +#define _EPCN3AINETWORKRESOURCESNRMDEFS_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module EPCn3aINetworkResourcesNRMDefs +{ + /** + * Definitions for MO class Link_3GPPAAAServer_PGW + */ + interface Link_3GPPAAAServer_PGW : GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_3GPPAAAServer_PGW"; + // No New Attribute Names + // + }; + /** + * Definitions for MO class Link_3GPPAAAServer_HSS + */ + interface Link_3GPPAAAServer_HSS : GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_3GPPAAAServer_HSS"; + // No New Attribute Names + // + }; + /** + * Definitions for MO class Link_3GPPAAProxy_3GPPAAAServer + */ + interface Link_3GPPAAProxy_3GPPAAAServer : GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_3GPPAAProxy_3GPPAAAServer"; + // No New Attribute Names + // + }; + /** + * Definitions for MO class 3GPPAAProxyFunction + */ + interface 3GPPAAProxyFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "3GPPAAProxyFunction"; + // Attribute Names + // + const string id = "id"; + }; + /** + * Definitions for MO class 3GPPAAAServerFunction + */ + interface 3GPPAAAServerFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "3GPPAAAServerFunction"; + // Attribute Names + // + const string id = "id"; + }; +}; +#endif // _EPCN3AINETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +This annex contains the XML definitions for the Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP as it applies to Itf-N, in accordance with Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP IS definitions in 3GPP TS 28.612 [4]. + +The XML file formats are based on XML [9], XML Schema [10] [11] and XML Namespace [12] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of Evolved Packet Core (EPC) and non-3GPP access interworking system Network Resources IRP is specified in 3GPP TS 28.612 [4]. + +This clause specifies features that are specific to the schema definitions. + +The XML definitions in the present document specify the schema for a configuration content. + +When using the XML definitions for a configuration file transfer with the Bulk CM IRP, using either CORBA solution set of 3GPP TS 32.616 [7] or SOAP Solution Set of 3GPP TS 32.616 [7], the basic part of the XML file format definition is provided by 3GPP TS 32.616 [7]. The XML definitions in the present document provide the schema for the configuration content to be included in such a configuration file. + +When using the XML definitions with a SOAP solution set of any interface IRP that perform operations on managed objects, for example the Basic CM IRP SOAP SS of 3GPP TS 32.606 [6], the XML definitions in the present document provide the schema for the configuration content operated on by the interface IRP. Such configuration content can be name of managed object and, if applicable, IOC attributes. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +## --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## B.3 Solution set definitions + +#### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [7]. + +Annex B.3.3 of the present document defines the NRM-specific XML schema EPCn3aINrm.xsd for the "Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP IS" defined in 3GPP TS 28.612 [4]. + +XML schema EPCn3aINrm.xsd explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [7]. + +#### B.3.2 Graphical representation + +The graphical representation is not present in the current version of this specification. + +#### B.3.3 XML schema "EPCn3aINrm.xsd" + +``` +<?xml version="1. 1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.616 Evolved Packet Core (EPC) and non-3GPP access interworking system NRM IRP + XML schema definition + epcn3aiNrm.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.616#epcn3aiNrm" + elementFormDefault="qualified" + attributeFormDefault="unqualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:epcn3ai="http://www.3gpp.org/ftp/specs/archive/28_series/28.616#epcn3aiNrm" +> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + + <!-- EPC and non-3GPP access Interworking NRM IRP IS class associated XML elements --> + + <element name="Link_3GPPAAAServer_PGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epcn3ai:Link_3GPPAAAServer_PGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + + <element name="Link_3GPPAAAServer_HSS" +``` + +``` + + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epcn3ai:Link_3GPPAAAServer_HSSOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_3GPPAAProxy_3GPPAAAServer" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epcn3ai:Link_3GPPAAProxy_3GPPAAAServerOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="3GPPAAProxyFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + </complexContent> + </complexType> +</element> + +<element + name="3GPPAAAServerFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> +<element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element>> + +<element name="Link_3GPPAAAServer_PGWOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="Link_3GPPAAAServer_HSSOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="Link_3GPPAAProxy_3GPPAAAServerOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> + +</schema> +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------------------------------------------|--|--|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | | | Old | New | +| Dec 2013 | | | | | Version after approval | | | 2.0.0 | 12.0.0 | +| Jun 2014 | SA#64 | SP-140333 | 001 | - | Upgrade W3C XML Schema version from 1.0 to 1.1 | | | 12.0.0 | 12.1.0 | +| Sep 2014 | SA#65 | SP-140614 | 002 | 1 | Move IOCs/MOCs from discontinued TS 28.606 - align with TSG SA decision to remove I-WLAN | | | 12.1.0 | 12.2.0 | +| Dec 2014 | SA#66 | SP-140798 | 003 | 1 | Remove feature support statement | | | 12.2.0 | 12.3.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | | 12.3.0 | <b>13.0.0</b> | + +| Change history | | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | | 13.1.0 | | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | 14.0.0 | | +| 2017-06 | SA#76 | SP-170514 | 0005 | - | F | Update link from IRP SS to IS | | 14.1.0 | | +| 2017-06 | SA#76 | SP-170510 | 0006 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | | 14.1.0 | | +| 2018-12 | - | - | - | - | - | Update to Rel-15 version (MCC) | | 15.0.0 | | +| 2019-09 | SA#85 | SP-190751 | 0007 | - | F | Remove not used reference and add reference instead of abbreviation | | 15.1.0 | | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | 16.0.0 | | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28620/raw.md b/marked/Rel-16/28_series/28620/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..62fbfa730fb695d730ab99ba71f87cdd21b4fedb --- /dev/null +++ b/marked/Rel-16/28_series/28620/raw.md @@ -0,0 +1,581 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-------------------------------------------------------------------|-----------| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 UIM – Partition operational ..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 Class diagram..... | 8 | +| 4.3 Class definitions..... | 9 | +| 4.3.1 <i>Domain_</i> ..... | 9 | +| 4.3.1.1 Definition ..... | 9 | +| 4.3.1.2 Attributes ..... | 10 | +| 4.3.2 <i>ManagedElement_</i> ..... | 10 | +| 4.3.2.1 Definition ..... | 10 | +| 4.3.2.2 Attributes ..... | 10 | +| 4.3.3 <i>Function_</i> ..... | 10 | +| 4.3.3.1 Definition ..... | 10 | +| 4.3.3.2 Attributes ..... | 10 | +| 4.3.4 <i>ManagementSystem_</i> ..... | 11 | +| 4.3.4.1 Definition ..... | 11 | +| 4.3.4.2 Attributes ..... | 11 | +| 4.3.5 <i>TopologicalLink_</i> ..... | 11 | +| 4.3.5.1 Definition..... | 11 | +| 4.3.5.2 Attributes ..... | 11 | +| 4.3.6 <i>TerminationPointEncapsulation_</i> ..... | 11 | +| 4.3.6.1 Definition..... | 11 | +| 4.3.6.2 Attributes ..... | 12 | +| 4.3.6.3 Attribute constraints..... | 12 | +| 4.3.7 <i>LayerTermination_</i> ..... | 12 | +| 4.3.7.1 Definition..... | 12 | +| 4.3.7.2 Attributes ..... | 12 | +| 4.3.7.3 Attribute constraints..... | 12 | +| 4.3.8 <i>Top_</i> ..... | 12 | +| 4.3.8.1 Definition..... | 12 | +| 4.3.8.2 Attributes ..... | 13 | +| 5 UIM – Partition inventory..... | 13 | +| 6 UIM – Class attribute definitions..... | 14 | +| 6.1 Attribute properties ..... | 14 | +| <b>Annex A (informative): Void.....</b> | <b>17</b> | +| <b>Annex B (informative): Void.....</b> | <b>18</b> | +| <b>Annex C (informative): Rationale and Usage of TPE/LT .....</b> | <b>19</b> | +| <b>Annex D (informative): Change history.....</b> | <b>21</b> | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +As a result of the analysis of the requirements for the harmonization of the 3GPP and TM Forum Information Models in the context of FMC basic use cases were developed [6], [14]. These use cases led to the recognition that it would be necessary to define common model elements applicable for wire-line and wireless networks. This document defines these common model elements. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] ATM Forum, Technical Committee, Network Management, M4 Network View CMIP MIB Specification, "CMIP Specification for the M4 Interface", Sep, 1995. +- [2] 3GPP TS 28,652: "Evolved Universal Terrestrial Radio Access (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".. +- [3] Void. +- [4] Void. +- [5] 3GPP TS 32.622 "Generic network resources IRP: NRM". +- [6] 3GPP TR 32.833 "Study on Management of Converged Networks". +- [7] TM Forum GB922,"Information Framework (SID) Suite, Release 9.5"<http://www.tmforum.org/DocumentsInformation/GB922InformationFramework/45189/article.html>. +- [8] TM Forum MTOSI 2.1:(<http://www.tmforum.org/MTOSIRelease21/11998/home.html>). +- [9] Void. +- [10] Void. +- [11] TM Forum "SD1-18\_layers.pdf" (part of [8]) (Especially "4.2.7 ATM and SDH capable STM-4"). +- [12] Void. +- [13] Void. +- [14] TM Forum TR 166 "Information Model Federation Concepts and Principles" (<http://collab.tmforum.org/sf/go/doc13634?nav=1>). +- [15] Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM). +- [16] TM Forum MTOSI "SD1-25\_objectNaming.pdf". +- [17] ITU-T X.200 (07/1994) "Information technology – Open Systems Interconnection – Basic Reference Model: The basic model". +- [18] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". + +- [19] ITU-T G.805: "TRANSMISSION SYSTEMS AND MEDIA, DIGITAL SYSTEMS AND NETWORKS Digital networks – General aspects: Generic functional architecture of transport networks". +- [20] 3GPP TS 28.622 "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of this document, the following definitions, symbols and abbreviations apply. For definitions, symbols and abbreviations not found here. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [18] 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 [18]. + +| | | +|-------|---------------------------------------------------------| +| CP | Connection Point | +| DM | Domain Manager | +| DN | Distinguished Name | +| EM | Element Manager | +| FNIM | Federated Network Information Model | +| FMC | Fixed Mobile Convergence | +| IOC | Information Managed Object | +| LR | Layer Rate | +| LT | Layer Termination | +| ME | Managed Element | +| MTNM | Multi Technology Network Management (TM Forum) | +| MTOSI | Multi Technology Operations System Interface (TM Forum) | +| NRM | Network Resource Model (3GPP) | +| SDO | Standards Development Organization | +| SID | Shared Information & Data Model (TM Forum) | +| SLF | Subscription Location Function (3GPP) | +| TPE | Termination Point Encapsulation | +| UIM | Umbrella Information Model | +| VCAT | Virtual Concatenation | + +# --- 4 UIM – Partition operational + +## 4.1 Introduction + +This section introduces a number of classes that form the UIM. These classes are represented in UML and are implementation neutral views in that they only capture the semantics of the model from both a purpose neutral and purpose specific perspective. They do not: + +- Include syntax or representation of the information in a system or on-the-wire between systems; +- Relate to the protocol used to create/delete/read/write/modify the NM information. + +Various SDOs and organizations are expected to use the UIM classes for definition of Domain/Technology-specific model classes. This procedure will maximize the probability of the domain/technology specific concrete classes (from various SDOs) being semantically consistent, a necessary characteristic for FMC NM purposes. + +The Generic NRM IRP [20] defines abstract classes and other NRM IRPs such as E-UTRAN NRM IRP [2] define concrete classes. The Generic NRM IRP abstract classes are harmonized (if not identical) to those defined in this document. + +The UIM defined in this document provides the set of classes etc. that strengthen consistency of representation in the fixed and mobile environments. For management of an FNIM solution many other classes will be required in addition to those in the UIM. + +The UIM cannot be used directly for implementation. Implementation classes must be derived from those in the UIM by Inheritance or some other appropriate mechanism. + +Implementation classes derived from those in the UIM (e.g. for the fixed environment) must use different names from those used in the UIM. + +Where an implementation class is essentially identical to that in UIM the name of the implementation class should be the same as that of the UIM minus the underscore, e.g. the UIM class "Function\_" would become "Function". + +## 4.2 Class diagram + +The criteria for choosing these classes is their relevance to (e.g. can be used by) Domain/Technology-specific model classes (e.g. 3GPP network resource model [2], ATM network management model [1], TMF MTNM [8]. + +Note that this set of classes is basic in that their definitions and usage are necessary for the harmonization of various Domain/Technology-specific model classes, forming the so-called FNIM. + +These classes are *abstract*. Other classes are for further study. + +- *Domain\_* (similar to SubNetwork of 3GPP [20] and MultiLayerSubNetwork of SID/MTOSI [7]) +- *Function\_* (similar to ManagedFunction of 3GPP [20] and LogicalResource of SID/MTOSI [7]) +- *LayerTermination\_* (similar to a single layer in the layerParameterList\_T structure of SID/MTOSI [7]) +- *ManagedElement\_* (similar to ManagedElement of 3GPP [20] and SID/MTOSI [7]) +- *ManagementSystem\_* (similar to ManagementNode of 3GPP [20] and OperationsSystem of SID/MTOSI [7]) +- *TerminationPointEncapsulation\_* (similar to TerminationPoint of SID/MTOSI [7]) +- *Top\_* (similar to Top [20] of 3GPP and RootEntity of SID/MTOSI [7]) +- *TopologicalLink\_* (similar to Link [20] of 3GPP and TopologicalLink of SID/MTOSI [7]) + +![UML Class diagram showing relationships between Domain_, ManagedElement_, Function_, ManagementSystem_, TerminationPointEncapsulation_, LayerTermination_, and TopologicalLink_ classes. The diagram includes inheritance, association, and composition relationships with multiplicity and role names.](78d5774278a3f4a614f8c0ae485ce8d9_img.jpg) + +``` + +classDiagram + class Domain_ { + <<InformationObjectClass>> + } + class ManagedElement_ { + <<InformationObjectClass>> + } + class Function_ { + <<InformationObjectClass>> + } + class ManagementSystem_ { + <<InformationObjectClass>> + } + class TerminationPointEncapsulation_ { + <<InformationObjectClass>> + } + class LayerTermination_ { + <<InformationObjectClass>> + } + class TopologicalLink_ { + <<InformationObjectClass>> + } + + Domain_ <|-- ManagementSystem_ + Domain_ <|-- ManagedElement_ + Domain_ <|-- Function_ + Domain_ <|-- TopologicalLink_ + ManagedElement_ <|-- Function_ + TerminationPointEncapsulation_ <|-- Function_ + LayerTermination_ <|-- Function_ + + Domain_ "1" *-- "*" ManagementSystem_ : <<names>> + Domain_ "1" *-- "*" ManagedElement_ : <<names>> + Domain_ "1" *-- "*" Function_ : <<names>> + Domain_ "1" *-- "*" TopologicalLink_ : <<names>> + + ManagementSystem_ "1" *-- "*" ManagedElement_ : + managedElement + ManagementSystem_ "1" *-- "*" Function_ : + managedBy + + Function_ "1" *-- "*" LayerTermination_ : + zEnd + Function_ "1" *-- "*" TopologicalLink_ : + aEnd + +``` + +UML Class diagram showing relationships between Domain\_, ManagedElement\_, Function\_, ManagementSystem\_, TerminationPointEncapsulation\_, LayerTermination\_, and TopologicalLink\_ classes. The diagram includes inheritance, association, and composition relationships with multiplicity and role names. + +Figure 1: Class diagram + +Note: The above class diagram shows the naming and as well as inheritance relations. + +![Figure 2: Inheritance class diagram showing Top_ as the root class for Domain_, ManagementSystem_, ManagedElement_, TopologicalLink_, LayerTermination_, Function_, and TerminationPointEncapsulation_.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +classDiagram + class Top_ + class Domain_ + class ManagementSystem_ + class ManagedElement_ + class TopologicalLink_ + class LayerTermination_ + class Function_ + class TerminationPointEncapsulation_ + + Top_ <|-- Domain_ + Top_ <|-- ManagementSystem_ + Top_ <|-- ManagedElement_ + Top_ <|-- TopologicalLink_ + Top_ <|-- LayerTermination_ + Top_ <|-- Function_ + Top_ <|-- TerminationPointEncapsulation_ + +``` + +Figure 2: Inheritance class diagram showing Top\_ as the root class for Domain\_, ManagementSystem\_, ManagedElement\_, TopologicalLink\_, LayerTermination\_, Function\_, and TerminationPointEncapsulation\_. + +Figure 2: Inheritance class diagram + +## 4.3 Class definitions + +### 4.3.1 *Domain\_* + +#### 4.3.1.1 Definition + +This class groups managed entities: + +- Such that the group represents a topological structure which describes the potential for connectivity; +- Subject to common administration; +- With common characteristics. + +A domain is a partition of instances of managed entities. + +#### 4.3.1.2 Attributes + +The *Domain\_* IOC includes attributes inherited from *Top\_* IOC (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------------|-------------------|------------|------------|-------------|--------------| +| dnPrefix | M | M | - | - | M | +| | | T | F | F | T | +| userLabel | M | M | M | - | M | +| | | T | T | F | T | +| userDefinedNetworkType | M | M | M | - | M | +| | | T | T | F | T | + +### 4.3.2 *ManagedElement\_* + +#### 4.3.2.1 Definition + +This (and its contained *Function\_* (s)) represents telecommunications resources (e.g. equipment) within the telecommunications network. This group performs Managed Element (ME) functions, e.g., provides support and/or service to the subscriber. + +This can also provide access to a grouping of equipments for management purposes. + +An ME communicates with a manager (directly or indirectly) for the purpose of being monitored and/or controlled. MEs may or may not additionally perform element management functionality. + +An ME (and its contained *Function\_* (s)) may or may not be geographically distributed. An ME (and its contained *Function\_* (s)) is often referred to as a "Network Element". + +#### 4.3.2.2 Attributes + +The ManagedElement\_ IOC includes attributes inherited from Top\_ IOC (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------------------|-------------------|------------|------------|-------------|--------------| +| dnPrefix | M | M | - | - | M | +| | | T | F | F | T | +| managedElement<br>TypeList | O | M | - | - | M | +| | | T | F | F | T | +| userLabel | M | M | M | - | M | +| | | T | T | F | T | +| locationName | M | M | - | - | M | +| | | T | F | F | T | +| <b>Attribute related<br/>to role</b> | | | | | | +| managedBy | O | M | - | - | M | +| | | T | F | F | T | + +### 4.3.3 *Function\_* + +#### 4.3.3.1 Definition + +This represents a process, task, transformation or a relation between inputs and outputs. + +#### 4.3.3.2 Attributes + +The Function\_ IOC includes attributes inherited from Top\_ IOC (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| userLabel | O | M | M | - | M | +| | | T | T | F | T | + +### 4.3.4 *ManagementSystem\_* + +#### 4.3.4.1 Definition + +This represents a telecommunications management system (DM/EM) that contains functionality for managing a number of MEs. The management system communicates with the MEs directly or indirectly over one or more interfaces for the purpose of monitoring and/or controlling these MEs. + +This class has similar characteristics as the *ManagedElement\_*. The main difference between these two classes is that the *ManagementSystem\_* has a special association to the MEs that it is responsible for managing. + +#### 4.3.4.2 Attributes + +The ManagementSystem\_ IOC includes attributes inherited from Top\_ IOC (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------------------|-------------------|------------|------------|-------------|--------------| +| userLabel | M | M | M | - | M | +| | | T | T | F | T | +| <b>Attribute related<br/>to role</b> | | | | | | +| managedElements | O | M | - | - | M | +| | | T | F | F | T | + +### 4.3.5 *TopologicalLink\_* + +#### 4.3.5.1 Definition + +The *TopologicalLink\_* represents a communication relationship between network entities and indicates that information is intended to flow between those network entities. The *TopologicalLink\_* always represents a logical relationship. + +#### 4.3.5.2 Attributes + +The *TopologicalLink\_* IOC includes attributes inherited from *Top\_ IOC* (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| userLabel | M | M | M | - | M | +| | | T | T | F | T | +| layerProtocolNameList | O | M | - | - | M | +| | | T | F | F | T | +| <b>Attribute related to role</b> | | | | | | +| aEnd | M | M | - | - | M | +| | | T | F | F | T | +| zEnd | M | M | - | - | M | +| | | T | F | F | T | + +### 4.3.6 *TerminationPointEncapsulation\_* + +#### 4.3.6.1 Definition + +The *TerminationPointEncapsulation\_* (TPE) represents one or more functions that terminate/originate a signal that adapt a signal for use, and that enable a signal to propagate. Hence a TPE can represent the end point of a signal flow (see Annex C (informative): Rationale and Usage of TPE/LT for information on structure). + +The TPE can also represent the intermediate point of a signal flow. See Annex C (informative): Rationale and Usage of TPE/LT for information on TPE structure. + +A TPE is capable of encapsulating multiple transport functions (G.805 termination functions, adapters, points etc.) at many different layers where the encapsulated transport functions are all related to the same signal flow. There are specific rules that guide encapsulation (see Annex C (informative): Rationale and Usage of TPE/LT for information on usage). The encapsulated layers may be exposed (of its details of the transport assembly) via usage of instances of *LayerTermination\_* (LT). + +The TPE deals equivalently with unidirectional and bidirectional flows. + +#### 4.3.6.2 Attributes + +The *TerminationPointEncapsulation\_* IOC includes attributes inherited from *Top\_ IOC* (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| tpeType | CM | M | - | - | M | +| | | T | F | F | T | + +#### 4.3.6.3 Attribute constraints + +| Name | Definition | +|---------------------------|-------------------------------------------------------------------------------------------------------------| +| tpeType Support Qualifier | The condition is "The subject class instance name-contains one or more <i>LayerTermination_</i> instances". | + +### 4.3.7 *LayerTermination\_* + +#### 4.3.7.1 Definition + +The *LayerTermination\_* (LT) encapsulates the functions and points associated with one instance of a layer []. The functions include the adapter functions, the termination functions and the connection points of that layer. In this case the term layer is essentially synonymous with the term protocol as use by other standards. All functions encapsulated have the same signal granularity, closely associated characteristic type and essential rate. A specific *LayerTermination\_* may be equipped with a subset of capabilities. Where the TPE is semi-transparent the layers encapsulated by a TPE are exposed by the *LayerTermination\_* set that it contains. + +The *LayerTermination\_* provides the relevant layer parameters for the semi-transparent TPE cases. + +The *LayerTermination\_* allows for detailed layer description of a TPE (potentially representing a port) and for precise association of the TPE with a *TopologicalLink\_* (or other representatives of forwarding relationship). + +#### 4.3.7.2 Attributes + +The *LayerTermination\_* IOC includes attributes inherited from *Top\_* IOC (defined in clause 4.3.8) and the following attributes: + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------------|-------------------|------------|------------|-------------|--------------| +| layerProtocol NameList | M | M | - | - | M | +| | | T | F | F | T | +| direction | M | M | - | - | M | +| | | T | F | F | T | +| ltType | M | M | - | - | M | +| | | T | F | F | T | +| index | CM | M | - | - | M | +| | | T | F | F | T | + +#### 4.3.7.3 Attribute constraints + +| Name | Definition | +|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| index Support Qualifier | The condition is "More than one <i>LayerTermination_</i> instances (named-contained by the same <i>TerminationPointEncapsulation_</i> instance) are associated with the same signal flow." | + +### 4.3.8 *Top\_* + +#### 4.3.8.1 Definition + +The *Top\_* is a logical construct representing the origin of definitions for all classes defined for the converged network management purposes. All other classes specified in this document and in other FNIM specifications must inherit from *Top\_* directly or indirectly. + +#### 4.3.8.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | M | - | +| | | T | F | T | F | + +# --- 5 UIM – Partition inventory + +Void. + +# --- 6 UIM – Class attribute definitions + +## 6.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| direction | Represents the flow of traffic within the LT.<br><br>allowedValues: The allowed values are:<br>➤ Client-Server: Signal flows down the LT, e.g. traffic is taken from a number of low rate clients and multiplexed into a higher rate server.<br>➤ Server-Client: Signal flows up the LT.<br>➤ Bidirectional: Signal flow is both Client-Server and Server-Client. | type: String<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| dnPrefix | It carries the DN Prefix information or no information. See Annex C of 32.300 [2] for one usage of this attribute.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: F<br>isUnique: T<br>defaultValue: None<br>isNullable: False | +| id | An attribute whose class name and value can be used as an RDN when naming an instance of the object class. This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance.<br><br>allowedValues: format of allowed values to be conformant with TS 32.300 [3]. | type: String<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| index | Provides any relevant indexing of the LT (channel number, e.g. '3')<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| layerProtocolNameList | Name(s) and additional descriptive information such as version number for the protocol(s)/layer(s) used for the associated communication link. Syntax and semantic is not specified.<br><br>allowedValues: allowed value examples: "X2AP", "LR Optical Channel" | type: String<br>multiplicity: 1..*<br>isOrdered: F<br>isUnique: T<br>defaultValue: None<br>isNullable: True | +| locationName | The physical location (e.g. an address) of an entity represented by a (derivative of) <i>ManagedElement_</i> . It may contain no information to support the case where the derivative of <i>ManagedElement_</i> needs to represent a distributed multi-location NE.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| ltType | The name of the specification that describes the internal construction of the LT, indicating for example that it possesses a G.805 CP but no G.805 TCP (see [11]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: F<br>isUnique: T<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| managedElementTypeList | <p>It is a multi-valued attribute with one or more unique elements. Thus, it may represent one ME functionality or a combination of more than one functionality.</p> <p>The actual syntax and encoding of this attribute is Solution Set specific.</p> <p>allowedValues:<br/> 1) The allowed values of this attribute are the names of the IOC(s) that are (a) derived/subclassed from <code>ManagedFunction</code> and (b) directly name-contained by <code>ManagedElement</code> IOC (on the first level below <code>ManagedElement</code>), but with the string "Function" excluded.<br/> 2) If a <code>ManagedElement</code> contains multiple instances of a <code>ManagedFunction</code> this attribute will not contain repeated values.<br/> 3) The capitalisation (usage of upper/lower case) of characters in this attribute is insignificant. Thus, the NodeB should be case insensitive when reading these values.<br/> 4) Two examples of allowed values are:<br/> <ul style="list-style-type: none"> <li>NodeB;</li> <li>HLR, VLR.</li> </ul> </p> | type: String<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| tpeType | <p>The name of the specification that describes the construction of the TPE emphasising for example the access to the TPE and whether it is associated with a physical port directly or not (see [11]).</p> <p>allowedValues: N/A</p> | type: String<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| userDefinedNetworkType | <p>Textual information indicating network type, e.g. "UTRAN". It may contain no information if there is no appropriate network type can be used.</p> <p>allowedValues: N/A</p> | type: String<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| userLabel | <p>A user-friendly (and user assignable) name of this object.</p> <p>allowedValues: N/A</p> | type: String<br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| <b>Attribute related to role</b> | | | +| aEnd | <p>The value of this attribute shall be a list of Distinguished Name of the alphabetically first instance in the <code>Link</code> subclass name to which this link/relation is associated (i.e., pointing to the instance of <X> as described in the definition of <code>Link</code> IOC in the present document). As an example, with <code>Link_As_Slf</code>, <code>aEnd</code> would contain the Distinguished Name of the <code>AsFunction</code> instance, and the <code>zEnd</code> would contain the Distinguished Name of <code>SlfFunction</code> instance.</p> <p>allowedValues:<br/> 1) For the instance whose class is defined by 3GPP, the format of the allowed values would be in conformant with that defined in TS 32.300 [3].<br/> 2) See Note1.</p> | type: DN<br>multiplicity: *<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False<br>passedById: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| managedBy | This relates to the role played by <i>ManagementSystem_</i> in the relation between <i>ManagedSystem_</i> and <i>ManagedElement_</i> . This attribute contains a list of the DN(s) of the related subclasses of <i>ManagementSystem_</i> instance(s).<br>allowedValues: N/A | type: DN<br>multiplicity: *<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False<br>passedByld: True | +| managedElements | This relates to the role played by <i>ManagedElement_</i> in the relation between <i>ManagedSystem_</i> and <i>ManagedElement_</i> . This attribute contains a list of the DN(s) of the related subclasses of <i>ManagedElement_</i> instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: *<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False<br>passedByld: True | +| zEnd | <p>The value of this attribute shall be a list of Distinguished Name of the alphabetically second instance in the <i>Link</i> subclass name to which this link/relation is associated (i.e., pointing to the instance of <Y> as described in the definition of Link IOC in the present document).</p> <p>As an example, with <i>Link_As_Slf</i>, aEnd would contain the Distinguished Name of the <i>AsFunction</i> instance, and the zEnd would contain the Distinguished Name of <i>SlfFunction</i> instance.</p> <p>allowedValues:<br/>1) For the instance whose class is defined by 3GPP, the format of the allowed values would be in conformant with that defined in TS 32.300 [3].<br/>2)See Note1.</p> | type: DN<br>multiplicity: *<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False<br>passedByld: True | + +Note 1: For the instance whose class is defined by TM Forum, the format of the allowed values would be in conformant with that defined in TM Forum MTOSI SD1-25\_objectNaming [16]. + +# --- Annex A (informative): Void + +# Annex B (informative): Void + +# Annex C (informative): Rationale and Usage of TPE/LT + +This Annex provides the rationale and the usage of LT in conjunction with TPE. + +## Rationale + +A TPE is capable of encapsulating multiple transport functions (G.805 [19] termination functions, adapters, points etc.) at many different layers where the encapsulated transport functions are all related to the same signal flow. See Figure 11: UIM related to TM Forum model and ITU-T concepts. + +The TPE is used to both reduce the instances of objects required to represent a given transport assembly and to also simplify the translation from traditional environments where layering is not fully represented. + +The encapsulation may be opaque, i.e. not exposing the layering, or semi-transparent, exposing the explicit layering but compacted into a single TPE instance. In the former case, TPE instance does not need to name-contain any LT. In the latter case, TPE instance needs to name-contain instances of LT. + +The TPE deals equivalently with unidirectional and bidirectional flows. A bidirectional flow is where pairings of unidirectional flows have some shared fate or are considered as related in some way such that all entities associated with the whole bidirectional flow will be encapsulated in one TPE. Where a bidirectional flow is encapsulated it is possible to connect to only one of the two directions of flow and this can be represented through parameters of the TPE. + +## Usage + +The TPE provides a place against which to raise alarms, display parameters and set attributes associated with the signal flow. + +The TPE can be related: + +- Directly to one or more physical ports (i.e. that the signal is associated directly with an externally visible connector) + - Note that a physical port could also be related to more than one TPE; +- To logical functions that anchor the signal flow (i.e. it is floating between flexible functions in the equipment with no externally visible connector); +- To another supporting TPE to represent a client signal of the supporting TPE where there may be many instances of client; + - Note that there may be many instances of server TPE that feed a single client (e.g., in the case of VCAT) + +For background see SD1-18 Functional Modelling Concepts [11] and naming refer to SD1-25 Object Naming [16]. + +![Diagram showing the mapping between Expanded G.805 Representation, Rationalized Representation, Grouping into TM Forum PTP and CTP, and Umbrella Model across layers LRz, LRy, LRx, and LRw.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +The diagram illustrates the relationship between four network models across four layers: LRz, LRy, LRx, and LRw. Each layer is separated by a horizontal dashed red line. + +- LRz:** + - Expanded G.805:** CP (top) -> AP -> CP (bottom). + - Rationalized:** CP / FP (top) -> AP -> CP / FP (bottom). + - TM Forum:** CTP (top, green box) -> CTP (bottom, green box). + - Umbrella Model:** LT (top) 'Binds to' 1 TPE (top, green box). +- LRy:** + - Expanded G.805:** TCP (top) -> AP -> TCP (bottom). + - Rationalized:** TCP / FEP (top) -> CP / FP -> AP -> CP / FP -> TCP / FEP (bottom). The middle CP / FP is labeled 'Semi-flexible SNC / FR'. + - TM Forum:** CTP (top, green box) -> PTP (bottom, purple box). + - Umbrella Model:** LT (top) 'encapsulates' TPE (top, green box). +- LRx:** + - Expanded G.805:** TCP (top) -> AP -> TCP (bottom). + - Rationalized:** TCP / FEP (top) -> CP / FP -> AP -> CP / FP -> TCP / FEP (bottom). The middle CP / FP is labeled 'Fixed (degenerate) SNC / FR'. + - TM Forum:** PTP (top, purple box) -> PTP (bottom, purple box). + - Umbrella Model:** LT (top) 'encapsulates' TPE (top, purple box). An arrow labeled '(Ordered)' points from the bottom LT to the bottom TPE. +- LRw:** + - Expanded G.805:** TCP (top) -> AP -> TCP (bottom). + - Rationalized:** TCP / FEP (top) -> AP -> TCP / FEP (bottom). + - TM Forum:** (Not explicitly shown in the diagram, but implied by the layer structure). + - Umbrella Model:** (Not explicitly shown in the diagram, but implied by the layer structure). + +Diagram showing the mapping between Expanded G.805 Representation, Rationalized Representation, Grouping into TM Forum PTP and CTP, and Umbrella Model across layers LRz, LRy, LRx, and LRw. + +## Key + +AP = Access Point + CP = Connection Point + CTP = Connection Termination Point (several different usages) + FEP = Forwarding End Point + FIP = Forwarding Intermediate Point + FR = Forwarding Relationship + LR = Layer Rate (approximately equivalent to protocol) + LT = Layer Termination + +PTP = Physical Termination Point + SNC = SubNetwork Connection + TCP = Termination Connection Point + TPE = Termination Point Encapsulation + +Flexibility at LRy and LRz +Layers for example: + +- LRx = MS +- LRy = VC4 +- LRz = 140M + +Figure 11: UIM related to TM Forum model and ITU-T concepts + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|----------|----|-----|--------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2013-03 | | | | | Approved version | 2.0.0 | 11.0.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-06 | SA#76 | SP-170507 | 0007 | 1 | A | Remove Editor notes and correct references | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2019-09 | SA#85 | SP-190744 | 0014 | 2 | F | Update class definition with inheritance information | <b>15.1.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28621/raw.md b/marked/Rel-16/28_series/28621/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c5dc3441a08193e76922af9163f0ec1dd8f9c2ae --- /dev/null +++ b/marked/Rel-16/28_series/28621/raw.md @@ -0,0 +1,137 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Requirements ..... | 7 | +| Annex A (informative): Change history..... | 8 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +## **28.621: Generic Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** + +28.622: Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) + +28.623: Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +Configuration Management (CM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. CM actions have the objective to control and monitor the actual configuration on the Network Elements (NEs) and network resources , and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. + +CM actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimisation programme (e.g. modifications), and to maintain the overall Quality of Service (QoS). The CM actions are initiated either as single actions on single NEs of the 3G network, or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the requirements for the present IRP: Generic Network Resource Model IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] Void +- [5] Void +- [6] Void +- [7] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [8] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [9] 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 [9]. + +**Element Manager (EM):** provides a package of end-user functions for management of a set of closely related types of Network Elements (NEs). These functions can be divided into two main categories: + +- *Element Management Functions* for management of NEs on an individual basis. These are basically the same functions as supported by the corresponding local terminals. +- *Sub-Network Management Functions* that are related to a network model for a set of NEs constituting a clearly defined sub-network, which may include relations between the NEs. This model enables additional functions on the sub-network level (typically in the areas of network topology presentation, alarm correlation, service impact analysis and circuit provisioning). + +**IRP:** See 3GPP TS 32.101 [1]. + +**IRP Information Service:** See 3GPP TS 32.101 [1]. + +**IRP Solution Set:** See 3GPP TS 32.101 [1]. + +**Information Object Class (IOC):** See 3GPP TS 28.622 [8] clause 3.1 Information Object Class (IOC). + +**Network Element (NE):** is a discrete telecommunications entity, which can be, managed over a specific interface e.g. the RNC. + +**Network resource:** See definition in TS 28.622 [8]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [9] 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 [9]. + +| | | +|-----|--------------------------| +| CM | Configuration Management | +| IOC | Information Object Class | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- IRP-related requirements in 3GPP TS 32.101 [1]. +- IRP-related requirements in 3GPP TS 32.102 [2]. +- IRP-related requirements in 3GPP TS 32.600 [3]. + +In addition, the NRM defined by this IRP: + +- Shall be generic, i.e. not contain any domain specific definitions such as UTRAN or CN entities. Examples of generic entities are: High-level IOCs for containment of other more domain-specific IOCs, and abstract IOCs for sub-classing by other more domain-specific IOCs. +- Shall support management of UMTS-GSM Inter-system handover. +- Shall support communications for telecommunication network management purposes, including management of converged networks. +- Is a member of the Federated Network Information Model (FNIM) [6] and its information is derived from FNIM Umbrella Information Model (UIM) [7]. +- Shall support management of networks that include virtualized network functions. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|-----------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2012-12 | | | | | New version after approval | 2.0.0 | 11.0.0 | +| 2014-06 | SA#64 | SP-140358 | 001 | - | Move the feature support statements into a separate table | 11.0.0 | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|-------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2016-12 | SA#74 | SP-160857 | 0003 | 1 | B | Adding the generic configuration requirement to support management of VNFs | | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | | <b>15.0.0</b> | +| 2019-09 | SA#85 | SP-190751 | 0004 | - | F | Correction of NR definition to avoid misalignment with RAN2 | | <b>15.1.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28624/raw.md b/marked/Rel-16/28_series/28624/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..350ecfb1b2116ca761047fb8d7c11162471b7a33 --- /dev/null +++ b/marked/Rel-16/28_series/28624/raw.md @@ -0,0 +1,148 @@ + + + + + + +# --- Contents + +| | | +|---------------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.3 Abbreviations ..... | 5 | +| 4 Requirements for the State Management IRP ..... | 6 | +| 4.1 Introduction to requirements ..... | 6 | +| 4.2 Requirements..... | 6 | +| Annex A (informative): Change history..... | 7 | + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.624: State Management Data Definition Integration Reference Point (IRP); Requirements** +- 28.625: State Management Data Definition Integration Reference Point (IRP); Information Service (IS) +- 28.626: State Management Data Definition Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [3], the requirements for the present IRP: State Management Data Definition. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.625: "Telecommunication management; State Management Data Definition Integration Reference Point (IRP); Information Service (IS) ". +- [5] 3GPP TS 28.702: "Telecommunication management; Core Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [6] 3GPP TS 28.652: "Telecommunication management; UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [7] 3GPP TS 28.655: "Telecommunication management; GERAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [8] ITU-T Recommendation X.731: "Information technology, Open Systems Interconnection, Systems Management: State management function". +- [9] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [10] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [11] 3GPP TS.28.622: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [12] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [12], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] 3GPP, TS 32.600 [3] 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 [12] and 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [3]. + +**IRP:** See 3GPP TS 32.101 [1]. + +**Information Object Class (IOC):** See definition in TS 28.622 [11]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [11]. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [12] 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 [12]. + +| | | +|----|--------------------------| +| CM | Configuration Management | +|----|--------------------------| + +# --- 4 Requirements for the State Management IRP + +## 4.1 Introduction to requirements + +The management state of a managed object represents the instantaneous condition of availability and operability of the associated resource from the point of view of management. Different classes of managed object have a variety of state attributes that express and control aspects of the operation of their associated resource that are peculiar to each class. However, the management state is expected to be common to a large number of resources and for this reason is to be standardized; it expresses key aspects of their usability at any given time. Its purpose is to control the general availability of a resource and to make visible information about that general availability. + +State Management Data Definition IRP is defined to specify and to standardise the generic attributes for modelling and managing the resources of 3G networks at the Itf-N. There are a variety of managed objects and the related network resources. It is the task of designers of specific managed object classes to model the state conditions of the associated network resources using the generic attributes provided in the State Management Data Definition IRP. Different managed objects and the network resources they model may require different subsets of the attributes defined in the State Management Data Definition IRP. Examples of network resource models can be found in 3GPP TS 28.625 [4], 3GPP TS 28.702 [5], 3GPP TS 28.652 [6] and 3GPP TS 28.655 [7]. + +## 4.2 Requirements + +The following requirements apply for the State Management IRP: + +- A. IRP-related requirements in 3GPP TS 32.101 [1]. +- B. IRP-related requirements in 3GPP TS 32.102 [2]. +- C. IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- A) Shall support communications for telecommunication network management purposes, including management of converged networks. +- B) Is a member of the Federated Network Information Model (FNIM) [9] and its information is derived from FNIM Umbrella Information Model (UIM) [10]. + +In addition to the above, the following more specific requirements apply: + +- 1. The State Management Data Definition IRP IS shall specify state attributes, modelling operability, usage and administration related to 3G network resources. + - operability: whether or not the resource is physically installed and working, if applicable. + +- usage: whether or not the resource is actively in use at a specific instant, and if so, whether or not it has spare capacity for additional users at that instant. A resource is said to be "in use" when it has received one or more requests for service that it has not yet completed or otherwise discharged, or when some part of its capacity has been allocated, and not yet reclaimed, as a result of a previous service request. +- administration: permission to use or prohibition against using the resource, imposed through the management services. + +The semantics and the value ranges of these state attributes shall be based on ITU-T Recommendation X.731 [8] while extensions and omissions may be made. + +2. The State Management Data Definition IRP IS shall specify status attributes, modelling more detailed information about other aspects of the state of the corresponding 3G network resources that may affect their operability and usage. The status attributes also contain more detailed information about the administrative constraints on its operation that are controlled by a manager. The semantics and the value ranges of these status attributes shall be based on ITU-T Recommendation X.731 [8] while extensions and omissions may be made. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|--------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| Dec 2012 | SA#58 | | | | Draft sent for information and approval | 0.1.0 | 1.0.0 | +| Dec 2012 | | | | | New version after approval | 1.0.0 | 11.0.0 | +| Jun-2014 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | 11.0.0 | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2018-06 | - | - | 0002 | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | SA#85 | SP-190751 | 0002 | - | F | Remove NR with wrong definition to avoid misalignment with RAN2 | 15.1.0 | +| 2019-09 | SA#85 | | | | | Editorial revision to correct version on cover page | 15.1.1 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28625/raw.md b/marked/Rel-16/28_series/28625/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fad4df194390c2ac47fb36070618aee95d0f3eb0 --- /dev/null +++ b/marked/Rel-16/28_series/28625/raw.md @@ -0,0 +1,184 @@ + + + + + + +# --- Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 6 | +| 4.1 Information entities imported and local labels..... | 6 | +| 4.2 Class diagram ..... | 6 | +| 4.2.1 Relationships ..... | 6 | +| 4.2.2 Inheritance ..... | 6 | +| 4.3 Class definitions ..... | 7 | +| 4.3.1 StateManagementEntity ..... | 7 | +| 4.3.1.1 Definition ..... | 7 | +| 4.3.1.2 Attributes ..... | 7 | +| 4.3.1.3 Attribute constraints..... | 7 | +| 4.4 Attribute definitions ..... | 7 | +| 4.4.1 Attribute properties..... | 7 | +| Annex A (informative): Change history..... | 10 | + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.624 State Management Data Definition Integration Reference Point (IRP); Requirements; +- 28.625 State Management Data Definition Integration Reference Point (IRP); Information Service (IS) ;** +- 28.626 State Management Data Definition Integration Reference Point (IRP); Solution Set (SS) definitions. + +This specification is part of a set that has been developed for converged management solutions. + +# --- 1 Scope + +The present document specifies the State Management Data Definition IRP Information Service that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +The present document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] Void +- [4] Void +- [5] Void +- [6] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [7] ITU-T Recommendation X.731: "Information technology - Open Systems Interconnection - Systems Management: State management function". +- [8] ITU-T Recommendation X.733: "Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function". +- [9] Void +- [10] Void +- [11] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the abbreviations given in TR 21.905 [11], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.600 [6] 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 [11], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [11], 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 [11]. + +| | | +|-----|--------------------------| +| CM | Configuration Management | +| IOC | Information Object Class | + +# 4 Model + +## 4.1 Information entities imported and local labels + +| Label reference | Local label | +|-----------------|-------------| +| | | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +There is no relationship. + +### 4.2.2 Inheritance + +There are no inheritance relationships. + +## 4.3 Class definitions + +### 4.3.1 StateManagementEntity + +#### 4.3.1.1 Definition + +StateManagementEntity is an Archetype, that may represent any IOC defined in the Network Resource Models, e.g. Generic Network Resource Model, Core Network Resource Model, UTRAN Network Resource Model or GERAN Network Resource Model. + +The attributes defined for this Archetype can be imported and used in any IOC of the Network Resource Models, where such attributes are needed. These attributes shall be used in the same way as defined in the ITU-T Recommendation X.731 [7] and ITU-T Recommendation X.733 [8], unless otherwise stated. That document gives also examples of state diagrams, defining possible state transitions when one or more of the state attributes defined here are used in a class. + +#### 4.3.1.2 Attributes + +The following attributes are defined for this Archetype. + +| Attribute Name | +|---------------------| +| operationalState | +| usageState | +| administrativeState | +| alarmStatus | +| proceduralStatus | +| availabilityStatus | +| controlStatus | +| standbyStatus | +| unknownStatus | + +#### 4.3.1.3 Attribute constraints + +None. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table gives the definition and legal values for each attribute. + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| operationalState | It indicates the operational state of the object instance. "It describes whether or not the resource is physically installed and working." [7]<br>This attribute is READ-ONLY.<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "Enabled", "Disabled" . | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| usageState | It indicates the usage state of the object instance. "It describes whether or not the resource is actively in use at a specific instant, and if so, whether or not it has spare capacity for additional users at that instant." [7]<br>This attribute is READ-ONLY.<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "Idle", "Active", "Busy". | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| administrativeState | It indicates the administrative state of the object instance. "It describes the permission to use or prohibition against using the resource, imposed through the management services." [7]<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "Locked", "Shutting down", "Unlocked". | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| alarmStatus | It indicates the alarm status of the object instance. This is mapped to the perceived severity of the most severe active alarm associated to the object instance.<br>The meaning of these values is as defined for the attribute perceived severity in ITU-T Recommendation X.733 [8].<br><br>allowedValues: "Cleared", "Indeterminate", "Warning", "Minor", "Major", "Critical". | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| proceduralStatus | It indicates the procedural status of the object instance.<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "Initialisation required", "Not initialised", "Initialising", "Reporting", "Terminating".<br>The meaning of NULL value is the same as "empty set" defined in ITU-T Recommendation X.731 [7]: "If the value of this attribute is an empty set the managed object is ready, for example, the initialization is complete". | type: String<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| availabilityStatus | It indicates the availability status of the object instance.<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "In test", "Failed", "Power off", "Off line", "Off duty", "Dependency", "Degraded", "Not installed", "Log full". | type: String<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| controlStatus | It indicates the control status of the object instance.<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "Subject to test", "Part of services locked", "Reserved for test", "Suspended". | type: String<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| standbyStatus | It indicates the standby status of the object instance.<br>The meaning of these values is as defined in ITU-T Recommendation X.731 [7].<br><br>allowedValues: "Hot standby", "Cold standby", "Providing service". | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| unknownStatus | <p>It indicates whether the state of the resource represented by the managed object is unknown.</p> <p>"True" (state is unknown, the values of the state attributes may not reflect the actual state of the resource);</p> <p>"False" (state is known, the values of the state attributes reflect the actual state of the resource).</p> <p>allowedValues: "True", "False".</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|---------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SP-64 | SP-140332 | 001 | - | Add definition of NULL for proceduralStatus | 11.0.0 | 11.1.0 | +| | | SP-140358 | 002 | - | remove the feature support statements | | | +| 2014-09 | | | | | Upgrade to Rel-12 | 11.1.0 | 12.0.0 | +| 2016-01 | SP-70 | | | | Upgrade to Rel-13 (MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2019-09 | SA#85 | SP-190751 | 0003 | - | F | Remove not used abbreviation to avoid misalignment with RAN2 | <b>15.1.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28626/raw.md b/marked/Rel-16/28_series/28626/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6508d1d23ebed6a2a63d74af6a040e41d863b2b8 --- /dev/null +++ b/marked/Rel-16/28_series/28626/raw.md @@ -0,0 +1,811 @@ + + + + + + +# --- Contents + +| | | +|-----------------------------------------------------------------------|-----------| +| <b>Foreword.....</b> | <b>5</b> | +| <b>Introduction.....</b> | <b>5</b> | +| <b>1 Scope.....</b> | <b>5</b> | +| <b>2 References .....</b> | <b>5</b> | +| <b>3 Definitions and abbreviations.....</b> | <b>6</b> | +| 3.1 Definitions ..... | 6 | +| 3.2 Abbreviations..... | 7 | +| <b>4 Solution Set (SS) definitions .....</b> | <b>7</b> | +| <b>Annex A (normative):    CORBA Solution Set (SS).....</b> | <b>8</b> | +| <b>A.1 Architectural features.....</b> | <b>8</b> | +| A.1.1 Syntax for Distinguished Names ..... | 8 | +| <b>A.2 Mapping .....</b> | <b>8</b> | +| A.2.1 General mapping ..... | 8 | +| A.2.2 Information Object Class (IOC) mapping ..... | 8 | +| <b>A.3 Solution Set definitions .....</b> | <b>9</b> | +| A.3.1 IDL definition structure..... | 9 | +| A.3.2 IDL specification “StateManagementIRPConstDefs.idl” ..... | 10 | +| A.3.3 IDL specification “StateManagementIRPOptConstDefs.idl” ..... | 12 | +| A.3.4 IDL specification “StateManagementIRPCommonConstDefs.idl” ..... | 14 | +| <b>Annex B (normative):    XML definitions.....</b> | <b>16</b> | +| <b>B.0 General.....</b> | <b>16</b> | +| <b>B.1 Architectural features.....</b> | <b>16</b> | +| B.1.0 Introduction ..... | 16 | +| B.1.1 Syntax for Distinguished Names ..... | 16 | +| <b>B.2 Mapping .....</b> | <b>16</b> | +| <b>B.3 Solution Set definitions .....</b> | <b>16</b> | +| B.3.1 XML definition structure..... | 16 | +| B.3.2 XML schema “stateManagementIRP.xsd” ..... | 17 | +| <b>Annex C (normative):    JSON definitions.....</b> | <b>18</b> | +| <b>C.1 General.....</b> | <b>18</b> | +| <b>C.2 Architectural features.....</b> | <b>18</b> | +| C.2.1 Introduction ..... | 18 | +| C.2.2 Syntax for Distinguished Names ..... | 18 | +| <b>C.3 Mapping .....</b> | <b>19</b> | +| C.3.1 Attributes mapping ..... | 19 | +| <b>C.4 Solution Set (SS) definitions .....</b> | <b>19</b> | + +C.4.1 JSON definition structure ..... 19 +C.4.2 Graphical representation..... 19 +C.4.3 JSON schema "stateManagementNrm.json" ..... 19 +Annex D (Informative): Change history..... 21 + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.624 State Management Data Definition Integration Reference Point (IRP); Requirements. +- 28.625 State Management Data Definition Integration Reference Point (IRP); Information Service (IS). +- 28.626 State Management Data Definition Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document specifies the Solution Set (SS) definitions for the IRP whose semantics is specified in State Management Data Definition IRP: Information Service (IS) (3GPP TS 28.625 [2]). + +This Solution Set definitions specification is related to 3GPP TS 28.625 V14.0.X [2]. + +# --- 2 References + +The following documents contain provisions, which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 28.623: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [2] 3GPP TS 28.625: "Telecommunication management; State Management Data Definition Integration Reference Point (IRP): Information Service (IS)". +- [3] ITU-T Recommendation X.721: "Information technology - Open Systems Interconnection - Structure of management information: Definition of management information". +- [4] ITU-T Recommendation M.3100: "Generic network information model". +- [5] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [8] Void. +- [9] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures.. +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [11] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [12] ITU-T Recommendation X.721: "Information technology - Open Systems Interconnection - Structure of management information: Definition of management information". +- [13] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [14] 3GPP TS 32.158: "Management and orchestration; Design rules for REpresentational State Transfer (REST) Solution Sets (SS) ". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions defined in 3GPP TS 32.672 [2] apply, and the following XML terms and definitions apply: + +**XML file:** See definition of [1]. + +**XML document:** See definition of [1]. + +**XML declaration:** See definition of [1]. + +**XML element:** See definition of [1]. + +**empty XML element:** See definition of [1]. + +**XML content (of an XML element):** See definition of [1]. + +**XML start-tag:** See definition of [1]. + +**XML end-tag:** See definition of [1]. + +**XML empty-element tag:** See definition of [1]. + +**XML attribute specification:** See definition of [1]. + +**DTD:** See definition of [1]. + +**XML schema:** See definition of [1]. + +**XML namespace:** See definition of [1]. + +**XML complex type:** See definition of [1]. + +**XML element type:** See definition of [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IDL | Interface Definition Language | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| NE | Network Element | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set (SS) definitions + +This specification defines the following 3GPP State Management Data Definition IRP Solution Set definitions: + +- 3GPP State Management Data Definition IRP CORBA SS (Annex A). +- 3GPP State Management Data Definition IRP XML definitions (Annex B). +- 3GPP State Management Data Definition IRP JSON definitions (Annex C). + +# --- Annex A (normative): CORBA Solution Set (SS) + +## A.1 Architectural features + +The overall architectural feature of State Management Data Definition IRP is specified in 3GPP TS 28.625 [2]. + +This clause specifies features that are specific to the CORBA SS. + +### A.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [13]. + +## --- A.2 Mapping + +### A.2.1 General mapping + +None. + +### A.2.2 Information Object Class (IOC) mapping + +Table 1 provides the mapping of the information object classes defined in the IS of the State Management IRP [2] to the equivalent of this CORBA Solution Set. + +**Table 1: Mapping of IOCs** + +| IOCs defined in State Management Data Definition<br>IRP IS [2] | CORBA SS Method | +|----------------------------------------------------------------|-----------------------------------------------------| +| StateManagementEntity | No mapping applicable for this <<Archetype>> class. | + +**Table 2: Mapping of Attributes** + +| <b>Attributes defined in State Management Data Definition IRP IS [2]</b> | <b>CORBA SS Method attributes</b> | <b>Qualifier</b> | +|--------------------------------------------------------------------------|-------------------------------------------------------------|------------------| +| operationalState | OperationalState (ITU-T Recommendation X.721 [3]) | M | +| operationalState | OperationalStateTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| usageState | UsageState (ITU-T Recommendation X.721 [3]) | M | +| usageState | UsageStateTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| administrativeState | AdministrativeState (ITU-T Recommendation X.721 [3]) | M | +| administrativeState | AdministrativeStateTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| alarmStatus | AlarmStatus (ITU-T Recommendation M.3100 [4]) | M | +| alarmStatus | AlarmStatusTypeOpt (ITU-T Recommendation M.3100 [4]) | O | +| proceduralStatus | ProceduralStatus (ITU-T Recommendation X.721 [3]) | M | +| proceduralStatus | ProceduralStatusTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| availabilityStatus | AvailabilityStatus (ITU-T Recommendation X.721 [3]) | M | +| availabilityStatus | AvailabilityStatusTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| controlStatus | ControlStatus (ITU-T Recommendation X.721 [3]) | M | +| controlStatus | ControlStatusTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| standbyStatus | StandbyStatus (ITU-T Recommendation X.721 [3]) | M | +| standbyStatus | StandbyStatusTypeOpt (ITU-T Recommendation X.721 [3]) | O | +| unknownStatus | UnknownStatus (ITU-T Recommendation X.721 [3]) | M | +| unknownStatus | UnknownStatusTypeOpt (ITU-T Recommendation X.721 [3]) | O | + +## A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 contains const definitions for State Management Data Definition IRP. + +Clause A.3.3 contains commonly used optional definitions for State Management Data Definition IRP. + +Clause A.3.4 contains commonly used definitions for State Management Data Definition IRP. + +### A.3.2 IDL specification “StateManagementIRPConstDefs.idl” + +``` + +//File:- StateManagementIRPConstDefs.idl +#ifndef _STATE_MANAGEMENT_IRP_CONST_DEFS_IDL_ +#define _STATE_MANAGEMENT_IRP_CONST_DEFS_IDL_ + +#include "CosNotification.idl" +#include "ManagedGenericIRPConstDefs.idl" +#include <StateManagementIRPCommonConstDefs.idl> +#include <StateManagementIRPOptConstDefs.idl> + +// This statement must appear after all include statements +#pragma prefix "3gppsa5.org" + +/* ## Module: StateManagementIRPConstDefs +This module contains commonly used definitions for State Management IRP +===== +*/ +module StateManagementIRPConstDefs +{ +/* +Constant definitions for state management notifications uses when populating the +Cos::Structured event. +The "name" party of the structured event carries the following constant definitions +appropriate to the state being notified. +Refer to TS 32.666 regarding how to populate the structured event +*/ +interface AttributeNameValue { + const string OPERATIONAL_STATE = "operationalState"; + const string USAGE_STATE = "usageState"; + const string ADMINISTRATIVE_STATE = "administrativeState"; + const string ALARM_STATUS = "alarmStatus"; + const string PROCEDURAL_STATUS = "proceduralStatus"; + const string AVAILABILITY_STATUS = "availabilityStatus"; + const string CONTROL_STATUS = "controlStatus"; + const string STANDBY_STATUS = "standbyStatus"; + const string UNKNOWN_STATUS = "unknownStatus"; +}; + +/* +The following structures provide the new state value, +and the optional old state value +The structures are passed in the value part of the cos structured event +*/ +struct OperationalStateOldNewValue{ + StateManagementIRPCommonConstDefs::OperationalState new; + StateManagementIRPOptConstDefs::OperationalStateTypeOpt old; +}; + +struct UsageStateOldNewValue{ + StateManagementIRPCommonConstDefs::UsageState new; + StateManagementIRPOptConstDefs::UsageStateTypeOpt old; +}; + +struct AdministrativeStateOldNewValue{ + StateManagementIRPCommonConstDefs::AdministrativeState new; + StateManagementIRPOptConstDefs::AdministrativeStateTypeOpt old; +}; + +struct AlarmStatusOldNewValue{ + StateManagementIRPCommonConstDefs::AlarmStatus new; + StateManagementIRPOptConstDefs::AlarmStatusTypeOpt old; +}; + +struct ProceduralStatusOldNewValue{ + StateManagementIRPCommonConstDefs::ProceduralStatusValues new; + StateManagementIRPOptConstDefs::ProceduralStatusTypeOpt old; +}; + +struct AvailabilityStatusOldNewValue{ + StateManagementIRPCommonConstDefs::AvailabilityStatusValues new; +}; + +``` + +``` + StateManagementIRPOptConstDefs:: AvailabilityStatusTypeOpt old; +}; + +struct ControlStatusOldNewValue{ + StateManagementIRPCommonConstDefs::ControlStatusValues new; + StateManagementIRPOptConstDefs::ControlStatusTypeOpt old; +}; + +struct StandbyStatusOldNewValue{ + StateManagementIRPCommonConstDefs::StandbyStatus new; + StateManagementIRPOptConstDefs::StandbyStatusTypeOpt old; +}; + +struct UnknownStatusOldNewValue{ + StateManagementIRPCommonConstDefs::UnknownStatus new; + StateManagementIRPOptConstDefs::UnknownStatusTypeOpt old; +}; + +}; +#endif // _STATE_MANAGEMENT_IRP_CONST_DEFS_IDL_ +``` + +### A.3.3 IDL specification “StateManagementIRPOptConstDefs.idl” + +``` +//File:-StateManagementIRPOptConstDefs.idl +#ifndef _STATE_MANAGEMENT_IRP_OPT_CONST_DEFS_IDL_ +#define _STATE_MANAGEMENT_IRP_OPT_CONST_DEFS_IDL_ + +#include "CosNotification.idl" +#include "ManagedGenericIRPConstDefs.idl" +#include "StateManagementIRPCommonConstDefs.idl" +// This statement must appear after all include statements +#pragma prefix "3gppsa5.org" + +/** ## Module: StateManagementIRPOptConstDefs +This module contains commonly used optional definitions for State Management IRP +===== +*/ +module StateManagementIRPOptConstDefs +{ + + /** + Definition of Operational State based on X.721 [3], if optional. + */ + union OperationalStateTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::OperationalState operational_state; + }; + + /** + Definition of Usage State based on X.721 [3], if optional. + */ + union UsageStateTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::UsageState usage_state; + }; + + /** + Definition of Administrative State based on X.721 [3], if optional. + */ + union AdministrativeStateTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::AdministrativeState administrative_state; + }; + + /** + Definition of Alarm Status based on M.3100 [4], if optional. + */ + union AlarmStatusTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::AlarmStatus alarm_status; + }; + + /** + Definition of Procedural Status based on X.721 [3], if optional. + */ + union ProceduralStatusTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::ProceduralStatus procedural_status; + }; + + /** + Definition of Availability Status based on X.721 [3], if optional. + */ + union AvailabilityStatusTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::AvailabilityStatus availability_status; + }; + + /** + Definition of Control Status based on X.721 [3], if optional. + */ + union ControlStatusTypeOpt switch(boolean) + { + case TRUE: StateManagementIRPCommonConstDefs::ControlStatus control_status; + }; + + /** + Definition of Standby Status based on X.721 [3], if optional. + */ +} +``` + +``` +*/ +union StandbyStatusTypeOpt switch(boolean) +{ + case TRUE: StateManagementIRPCommonConstDefs::StandbyStatus standby_status; +}; + +/* +Definition of Unknown Status based on X.721 [3], if optional. +*/ +union UnknownStatusTypeOpt switch(boolean) +{ + case TRUE: StateManagementIRPCommonConstDefs::UnknownStatus unknown_status; +}; + +}; +#endif // _STATE_MANAGEMENT_IRP_OPT_CONST_DEFS_IDL_ +``` + +### A.3.4 IDL specification + +#### “StateManagementIRPCommonConstDefs.idl” + +``` +//File: StateManagementIRPCommonConstDefs.idl +#ifndef _STATE_MANAGEMENT_IRP_COMMON_CONST_DEFS_IDL_ +#define _STATE_MANAGEMENT_IRP_COMMON_CONST_DEFS_IDL_ + +// This statement must appear after all include statements +#pragma prefix "3gppsa5.org" + +/* Module: StateManagementIRPCommonConstDefs +This module contains commonly used definitions for State Management IRP +===== +*/ +module StateManagementIRPCommonConstDefs +{ + /* + Definition of Operational State based on X.721 [3], if mandatory. + */ + enum OperationalState + { + Disabled, Enabled + }; + + /* + Definition of Usage State based on X.721 [3], if mandatory. + */ + enum UsageState + { + Idle, Active, Busy + }; + + /* + Definition of Administrative State based on X.721 [3], if mandatory. + */ + enum AdministrativeState + { + Locked, Unlocked, ShuttingDown + }; + + /* + Definition of Alarm Status based on M.3100 [4], if mandatory. + */ + enum AlarmStatus + { + CLEARED, INDETERMINATE, WARNING, MINOR, MAJOR, CRITICAL + }; + + /* + Definition of Procedural Status based on X.721 [3], if mandatory. + */ + enum ProceduralStatusValues + { + InitializationRequired, NotInitialized, Initializing, Reporting, + Terminating + }; + typedef sequence <ProceduralStatusValues,5> ProceduralStatus; + + /* + Definition of Availability Status based on X.721 [3], if mandatory. + */ + enum AvailabilityStatusValues + { + InTest, Failed, PowerOff, OffLine, OffDuty, Dependency, Degraded, + NotInstalled, LogFull + }; + typedef sequence <AvailabilityStatusValues,9> AvailabilityStatus; + + /* + Definition of Control Status based on X.721 [3], if mandatory. + */ + enum ControlStatusValues + { + SubjectToTest, PartOfServicesLocked, ReservedForTest, Suspended + }; + typedef sequence <ControlStatusValues,4> ControlStatus; +} +``` + +``` +/* +Definition of Standby Status based on X.721 [3], if mandatory. +*/ +enum StandbyStatus +{ + HotStandby, ColdStandby, ProvidingService +}; + +/* +Definition of Unknown Status based on X.721 [3], if mandatory +(if switch is TRUE then value equal to TRUE implies "unknown status"). +*/ +union UnknownStatus switch(boolean) +{ + case TRUE: boolean value; +}; + +}; +#endif // _STATE_MANAGEMENT_IRP_COMMON_CONST_DEFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +This annex specifies the XML file format definition for the Bulk Configuration Management IRP IS [5] for the IRP whose semantics is specified in State Management Data Definition IRP: Information Service (IS) (3GPP TS 28.625 [2]). + +The XML file formats are based on XML [7], XML Schema [9][10] and XML Namespace [11] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of State Management IRP is specified in 3GPP TS 28.625 [2]. + +This clause specifies features that are specific to the XML Schema definitions. + +### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +## --- B.2 Mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [6]. + +Clause B.3.2 defines the XML schema `stateManagementIRP.xsd` for the State Management IRP: Information Service (IS) defined in 3GPP TS 28.625 [2]. + +The definition of the XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [6]. + +### B.3.2 XML schema “stateManagementIRP.xsd” + +``` + +<?xml version="1.1" encoding="UTF-8"?> +<!-- + 3GPP TS 28.626 State Management IRP + Bulk CM Configuration data file XML schema + stateManagementIRP.xsd +--> +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:sm= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" +> + <!-- State Management IRP related XML types --> + <simpleType name="operationalStateType"> + <restriction base="string"> + <enumeration value="enabled"/> + <enumeration value="disabled"/> + </restriction> + </simpleType> + <simpleType name="usageStateType"> + <restriction base="string"> + <enumeration value="idle"/> + <enumeration value="active"/> + <enumeration value="busy"/> + </restriction> + </simpleType> + <simpleType name="administrativeStateType"> + <restriction base="string"> + <enumeration value="locked"/> + <enumeration value="unlocked"/> + <enumeration value="shuttingDown"/> + </restriction> + </simpleType> + <simpleType name="alarmStatusType"> + <restriction base="string"> + <enumeration value="cleared"/> + <enumeration value="indeterminate"/> + <enumeration value="warning"/> + <enumeration value="minor"/> + <enumeration value="major"/> + <enumeration value="critical"/> + </restriction> + </simpleType> + <simpleType name="proceduralStatusElementType"> + <restriction base="string"> + <enumeration value="initializationRequired"/> + <enumeration value="notInitialized "/> + <enumeration value="initializing"/> + <enumeration value="reporting"/> + <enumeration value="terminating"/> + </restriction> + </simpleType> + <complexType name="proceduralStatusType"> + <sequence minOccurs="0" maxOccurs="5"> + <element name="proceduralStatusElement" type="sm:proceduralStatusElementType"/> + </sequence> + </complexType> + <simpleType name="availabilityStatusElementType"> + <restriction base="string"> + <enumeration value="inTest"/> + <enumeration value="failed"/> + <enumeration value="powerOff"/> + <enumeration value="offLine"/> + <enumeration value="offDuty"/> + <enumeration value="dependency"/> + <enumeration value="degraded"/> + <enumeration value="notInstalled"/> + <enumeration value="logFull"/> + </restriction> + </simpleType> + <complexType name="availabilityStatusType"> + <sequence minOccurs="0" maxOccurs="9"> + <element name="availabilityStatusElement" type="sm:availabilityStatusElementType"/> + </sequence> + </complexType> +</schema> + +``` + +``` +</sequence> +</complexType> +<simpleType name="controlStatusElementType"> + <restriction base="string"> + <enumeration value="subjectToTest"/> + <enumeration value="partOfServicesLocked"/> + <enumeration value="reservedForTest"/> + <enumeration value="suspended"/> + </restriction> +</simpleType> +<complexType name="controlStatusType"> + <sequence minOccurs="0" maxOccurs="4"> + <element name="controlStatusElement" type="sm:controlStatusElementType"/> + </sequence> +</complexType> +<simpleType name="standbyStatusType"> + <restriction base="string"> + <enumeration value="hotStandby"/> + <enumeration value="coldStandby"/> + <enumeration value="providingService"/> + </restriction> +</simpleType> +<simpleType name="unknownStatusType"> + <restriction base="boolean"> + <pattern value="true"/> + <pattern value="false"/> + </restriction> +</simpleType> +<element name="operationalState" type="sm:operationalStateType"/> +<element name="usageState" type="sm:usageStateType"/> +<element name="administrativeState" type="sm:administrativeStateType"/> +<element name="alarmStatus" type="sm:alarmStatusType"/> +<element name="proceduralStatus" type="sm:proceduralStatusType"/> +<element name="availabilityStatus" type="sm:availabilityStatusType"/> +<element name="controlStatus" type="sm:controlStatusType"/> +<element name="standbyStatus" type="sm:standbyStatusType"/> +<element name="unknownStatus" type="sm:unknownStatusType"/> +</schema> +``` + +# --- Annex C (normative): JSON definitions + +## C.1 General + +This annex specifies the JSON file format definition for the NRM whose semantics is specified in State Management Data Definition IRP: Information Service (IS) (3GPP TS 28.625 [2]). + +## --- C.2 Architectural features + +### C.2.1 Introduction + +The overall architectural feature of State Management IRP is specified in 3GPP TS 28.625 [2]. + +This clause specifies features that are specific to the JSON Schema definitions. + +### C.2.2 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +## C.3 Mapping + +### C.3.1 Attributes mapping + +Mapping from the attributes of IOC defined in the information model to SS equivalent definitions are listed in the following table. + +| Object Attributes | JSON definitions' Name | JSON Type | +|---------------------|------------------------|---------------------| +| operationalState | operationalState | OperationalState | +| usageState | usageState | UsageState | +| administrativeState | administrativeState | AdministrativeState | +| alarmStatus | alarmStatus | AlarmStatus | +| proceduralStatus | proceduralStatus | ProceduralStatus | +| availabilityStatus | availabilityStatus | AvailabilityStatus | +| controlStatus | controlStatus | ControlStatus | +| standbyStatus | standbyStatus | StandbyStatus | +| unknownStatus | unknownStatus | UnknownStatus | + +## C.4 Solution Set (SS) definitions + +### C.4.1 JSON definition structure + +JSON is used as resource representations format carried in the HTTP request and HTTP response message bodies. The properties (key-value pairs) on an object are defined using the properties keyword. + +The definition of the JSON resource object complies with the generic rules defined in 3GPP TS 32.158 [14]. + +### C.4.2 Graphical representation + +The graphical representation is not present in the current version of the present document. + +### C.4.3 JSON schema "stateManagementNrm.json" + +``` +{ + "$schema": "http://json-schema.org/draft-05/schema#", + "id": "http://3gpp.org/28626/stateManagementNrm.json", + "description": "JSON based solution set definitions for State Management NRM", + "definitions": { + "AdministrativeState": { + "enum": ["Locked", "Unlocked", "ShuttingDown"] + }, + "OperationalState": { + "enum": ["Enabled", "Disabled"] + }, + "AvailabilityStatus": { + "enum": ["InTest", "Failed", "PowerOff", "OffLine", "OffDuty", "Dependency", "Degraded", +"NotInstalled", "LogFull"] + }, + "UsageState": { + "enum": ["Idle", "Active", "Busy"] + }, + "AlarmStatus": { + "enum": ["Cleared", "Indeterminate", "Warning", "Minor", "Major", "Critical"] + }, + "ProceduralStatus": { + "enum": ["InitialisationRequired", "NotInitialised", "Initialising", "Reporting", +"Terminating"] + }, + "ControlStatus": { + "enum": ["SubjectToTest", "PartOfServicesLocked", "ReservedForTest", "Suspended"] + }, + "StandbyStatus": { + "enum": ["HotStandby", "ColdStandby", "ProvidingService"] + }, + "UnknownStatus": { + "enum": ["True", "False"] + } + } +} +``` + +} + +} + +# Annex D (Informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SA#64 | SP-140332 | 001 | - | upgrade XSD | 11.0.0 | 11.1.0 | +| | | SP-140358 | 002 | - | remove the feature support statements | | | +| 2014-09 | SA#65 | SP-140560 | 003 | - | Update the link from Solution Set to Information Service due to the end of Release 12 | 11.1.0 | 12.0.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13(MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0005 | - | F | Update link from IRP SS to IS | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-03 | - | | 0007 | 1 | F | Update State management data definition Solution Set to support JSON | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28627/raw.md b/marked/Rel-16/28_series/28627/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..99c9be44d7bf8cd5a14385137273cebf2be57d09 --- /dev/null +++ b/marked/Rel-16/28_series/28627/raw.md @@ -0,0 +1,1182 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 Concepts and background ..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Self-Optimization Concept..... | 9 | +| 4.2.1 Logical Function Blocks..... | 9 | +| 4.2.1.1 Self-Optimization Input Monitoring Function (SO_MON_F) ..... | 9 | +| 4.2.1.2 Triggering Optimization Function (TG_F)..... | 9 | +| 4.2.1.3 Optimization Fallback Function (O_FB_F)..... | 9 | +| 4.2.1.4 Self-Optimization Progress Update Function (SO_PGS_UF)..... | 9 | +| 4.2.1.5 NRM IRP Update Function (NRM_UF) ..... | 9 | +| 4.2.1.6 Self-Optimization Monitoring and Management Function (SO_MMF) ..... | 9 | +| 4.2.1.6.1 Self-Optimization Monitoring and Management Function (SO_MMF_NM) ..... | 9 | +| 4.2.1.6.2 Self-Optimization Monitoring and Management Function (SO_MMF_EM)..... | 9 | +| 4.2.1.7 Load Balancing Function (LB_F)..... | 10 | +| 4.2.1.8 Interference Control Function (IC_F)..... | 10 | +| 4.2.1.9 Coverage and Capacity Function (CC_F)..... | 10 | +| 4.2.1.10 RACH Optimization Function (RACH_F)..... | 10 | +| 4.2.1.11 HandOver Optimization Function (HO_F)..... | 10 | +| 4.2.1.12 NM centralized Coverage and Capacity Function (CC_F_NM) ..... | 10 | +| 4.2.1.13 Self-Optimization for AAS Function (SO_AAS_F)..... | 10 | +| 4.3 SON Coordination Concepts..... | 10 | +| 5 Business level requirements..... | 11 | +| 5.0 General ..... | 11 | +| 5.1 Requirements..... | 11 | +| 5.1.1 Self-Optimization Monitoring and Management ..... | 11 | +| 5.1.2 Load Balancing..... | 11 | +| 5.1.3 Handover (HO) Parameter optimization..... | 12 | +| 5.1.4 Interference control..... | 12 | +| 5.1.5 Coverage and Capacity optimization..... | 12 | +| 5.1.6 RACH optimization..... | 12 | +| 5.1.7 SON Coordination ..... | 12 | +| 5.1.8 Active Antenna System (AAS) management..... | 13 | +| 5.2 Actor roles ..... | 13 | +| 5.3 Telecommunications Resources..... | 13 | +| 5.4 High-Level use case ..... | 13 | +| 5.4.1 Load Balancing..... | 13 | +| 5.4.2 Interference control..... | 15 | +| 5.4.3 Coverage and capacity optimization..... | 16 | +| 5.4.4 NM centralized Coverage and Capacity Optimization..... | 18 | +| 5.4.4.0 General..... | 18 | +| 5.4.4.1 Use case 1: Cell coverage adapting to traffic demand..... | 18 | +| 5.4.4.2 Use case 2: Coverage and accessibility ..... | 18 | +| 5.4.4.3 Use case 3: LTE coverage holes with underlaid UTRAN/GERAN ..... | 18 | +| 5.4.4.4 Use case 4: LTE Connection failure ..... | 19 | +| 5.4.4.5 Use case 5: Radio link quality ..... | 21 | +| 5.4.5 SON for AAS ..... | 21 | +| 5.4.5.1 General..... | 21 | +| The Active Antenna Systems (AAS) can enable system optimization to be adaptive to traffic demands and address network evolution issues through flexible software re-configuration of the BS and antenna system. .... | 21 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------|-----------| +| 5.4.5.2 | Use case 1: Cell splitting ..... | 21 | +| 5.4.5.3 | Use case 2: Cell Merging..... | 22 | +| 5.4.5.4 | Use case 3: Cell Shaping ..... | 22 | +| 6 | Specification level requirements..... | 23 | +| 6.1 | Requirements..... | 23 | +| 6.1.1 | Self-Optimization Monitoring and Management ..... | 23 | +| 6.1.1.1 | Management Part..... | 23 | +| 6.1.2 | Load Balancing..... | 23 | +| 6.1.3 | Handover (HO) Parameter optimization..... | 23 | +| 6.1.3.1 | HO failure categorization..... | 23 | +| 6.1.3.1.1 | HO failures due to too late and too early HO triggering..... | 23 | +| 6.1.3.2 | Reducing inefficient use of network resources due to unnecessary HOs ..... | 25 | +| 6.1.3.3 | Requirements ..... | 26 | +| 6.1.4 | Interference control ..... | 26 | +| 6.1.5 | Coverage and capacity optimization..... | 26 | +| 6.1.6 | RACH optimization..... | 26 | +| 6.1.7 | SON Coordination ..... | 26 | +| 6.1.8 | NM centralized coverage and capacity optimization ..... | 27 | +| 6.1.9 | AAS management..... | 27 | +| 6.2 | Actor roles ..... | 27 | +| 6.3 | Telecommunications Resources..... | 28 | +| 6.4 | Use case..... | 28 | +| 6.4.1 | Use case Self-Optimization Monitoring and Management ..... | 28 | +| 6.4.2 | Use case Load Balancing Allowed/Prohibited Management ..... | 28 | +| 6.4.3 | Use case NM centralized Coverage and Capacity Optimization..... | 30 | +| 7 | Functions and Architecture ..... | 31 | +| 7.1 | Self-Optimization Logical Architecture..... | 31 | +| 7.2 | Self-Optimization Reference Model ..... | 31 | +| <b>Annex A (informative):</b> | <b>Steps for SON self-optimization Technical Specifications.....</b> | <b>33</b> | +| <b>Annex B (informative):</b> | <b>General descriptions related to NM centralized CCO high level use cases .....</b> | <b>34</b> | +| B.1 | General ..... | 34 | +| B.2 | Monitoring of UE distribution..... | 35 | +| <b>Annex C (informative):</b> | <b>Change history.....</b> | <b>37</b> | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- 28.627: “**Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP): Requirements**” +- 28.628: “**Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)**” +- 28.629: “**Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions**” + +# --- 1 Scope + +The present document describes concept and requirements of SON Policy management for Self-Optimization and SON coordination. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [4] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [5] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [6] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [7] 3GPP TS 37.320: "Universal Terrestrial Radio Access (UTRA) and Evolved Universal Terrestrial Radio Access (E-UTRA); Radio measurement collection for Minimization of Drive Tests (MDT); Overall description; Stage 2". +- [8] 3GPP TS 36.133: "Evolved Universal Terrestrial Radio Access (E-UTRA); Requirements for support of radio resource management". +- [9] 3GPP TS 36.213: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical layer procedures". +- [10] 3GPP TS 36.321: "Evolved Universal Terrestrial Radio Access (E-UTRA); Medium Access Control (MAC) protocol specification". +- [11] 3GPP TS 36.214: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical layer; Measurements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TS 32.101 [1], TS 32.102 [2], TS 32.150 [3] and TR 21.905 [4], in that order. + +**Target:** Target provides a clear basis for assessing performance of self-optimization functions. Targets need to be carefully specified in terms of a series of performance measurements and/or KPIs, which can be specific, and which can + +be used also to identify problems. A target should be expressed in terms of a specific value or specific value range. The present document does not specify the specific value or desired value range of each target since those should be set by operators according to their policy and different network situation. + +**Trigger condition:** The condition at which self-optimization should be triggered. Different self-optimization algorithms may have different trigger conditions for achieving same objectives and targets. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|----------------------------------------------------| +| AAS | Active Antenna System | +| CCO | Coverage and Capacity Optimization | +| CQI | Channel Quality Indicator | +| EM | Element Manager | +| eNodeB | evolved NodeB | +| EPC | Evolved Packet Core | +| E-UTRA | Evolved Universal Terrestrial Radio Access | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| HO | Handover | +| ICIC | Inter Cell Interference Coordination | +| LB | Load Balancing | +| LTE | Long Term Evolution | +| NE | Network Element | +| NM | Network Manager | +| NRM | Network Resource Model | +| OAM | Operation Administration Maintenance | +| PRB | Physical Resource Block | +| RCEF | RRC Connection Establishment Failure | +| RLF | Radio Link Failure | +| RSRP | Reference Signal Received Power | +| RSRQ | Reference Signal Received Quality | +| SON | Self Organizing Networks | +| UE | User Equipment | + +# --- 4 Concepts and background + +## 4.1 Overview + +A self-optimization functionality will monitor input data such as performance measurements, fault alarms, notifications etc. After analyzing the input data, optimization decisions will be made according to the optimization algorithms. Finally, corrective actions on the affected network node(s) will be triggered automatically or manually when necessary. + +IRPManager should be able to control the self-optimization procedures according to the operator's objectives and targets. + +The following diagram is illustrated how the self-optimization functionality works: + +![Flowchart of the logical view of a self-optimization procedure. The process starts with 'Monitor input data', which loops back to itself via a 'Loop: Keep Monitoring' callout. It then proceeds to 'Analyse input data with Optimization Algorithms'. A decision diamond follows, with a 'No' path leading to 'Execute corrective actions' and a 'Yes' path leading to another decision diamond 'Is system status better after the corrective actions?'. From the second decision, a 'Yes' path leads to 'One time Self-optimization procedure ends', while a 'No' path leads to a 'Fallback' box. The 'Fallback' box notes that the system may need to be reversed to its previous status. Both the 'Yes' path from the first decision and the 'Fallback' box lead back to the 'Monitor input data' step.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` +graph TD; A[Monitor input data] -- "Loop: Keep Monitoring" --> A; A --> B[Analyse input data with Optimization Algorithms]; B --> C{ }; C -- No --> D[Execute corrective actions]; D --> E{Is system status better after the corrective actions?}; E -- Yes --> F[One time Self-optimization procedure ends]; E -- No --> G[Fallback may be needed to reverse the system to the previous status, which is before the corrective actions executed.]; F --> A; G --> A; C -- Yes --> A; +``` + +Flowchart of the logical view of a self-optimization procedure. The process starts with 'Monitor input data', which loops back to itself via a 'Loop: Keep Monitoring' callout. It then proceeds to 'Analyse input data with Optimization Algorithms'. A decision diamond follows, with a 'No' path leading to 'Execute corrective actions' and a 'Yes' path leading to another decision diamond 'Is system status better after the corrective actions?'. From the second decision, a 'Yes' path leads to 'One time Self-optimization procedure ends', while a 'No' path leads to a 'Fallback' box. The 'Fallback' box notes that the system may need to be reversed to its previous status. Both the 'Yes' path from the first decision and the 'Fallback' box lead back to the 'Monitor input data' step. + +**Figure 4-1 Logical view of self-optimization procedure** + +The self-optimization functionality working procedure could be interpreted logically as following: + +1. The self-optimization functionality keeps monitoring input data according to the operator's objectives and targets. +2. Whenever the objectives and targets are not met, optimization algorithms will be triggered. +3. Corrective actions are provided and executed. +4. Then the self-optimization functionality evaluates the result of the executed corrective actions. + +- a) If the system status is not satisfactory after the corrective actions' execution, fallback may be needed to reverse the system configuration to the previous status, which is before the corrective actions executed. +- b) If the system status is satisfactory after the corrective actions' execution, the one time self-optimization procedure ends. + +5. Self-optimization functionality returns to monitoring the input data. + +## 4.2 Self-Optimization Concept + +### 4.2.1 Logical Function Blocks + +#### 4.2.1.1 Self-Optimization Input Monitoring Function (SO\_MON\_F) + +This functional bloc supports the following functions: [SO1]. + +#### 4.2.1.2 Triggering Optimization Function (TG\_F) + +This functional bloc supports the following functions: [SO2], [SO3]. + +#### 4.2.1.3 Optimization Fallback Function (O\_FB\_F) + +This functional bloc supports the following functions: [SO7], [SO9], [SO10]. + +#### 4.2.1.4 Self-Optimization Progress Update Function (SO\_PGS\_UF) + +This function updates the self-optimization progress and important events to the operator: [SO11] + +#### 4.2.1.5 NRM IRP Update Function (NRM\_UF) + +This function updates the E-UTRAN and EPC NRM IRP with the optimization modification if needed. + +#### 4.2.1.6 Self-Optimization Monitoring and Management Function (SO\_MMF) + +This function monitors the self-optimization process and provides the operator with this information. This function must be able to get information about all other functional blocs. In addition to this it allows the operator to control the execution of the self-optimization process. + +This function also resolves conflicts of different SON functions trying to change or actually changing parameter values in different directions or reports such conflicts, if they cannot be solved. + +##### 4.2.1.6.1 Self-Optimization Monitoring and Management Function (SO\_MMF\_NM) + +SO\_MMF\_NM (IRP Manager): representing the NM portion of SO\_MMF (necessary monitoring and limited interaction capabilities to support an automated optimization), as well as related IRPManager functionality + +In a centralized conflict resolution approach SO\_MMF\_NM identifies and resolves conflicts. + +In distributed and hybrid conflict resolution approach SO\_MMF\_NM sends policy directions towards the SO\_MMF\_EM. + +##### 4.2.1.6.2 Self-Optimization Monitoring and Management Function (SO\_MMF\_EM) + +SO\_MMF\_EM (IRP Agent): representing the portion of SO\_MMF operating below Itf-N, as well as related IRPAgent functionality + +In distributed and hybrid conflict resolution approach SO\_MMF\_EM identifies, resolves and/or reports conflicts, according to the policy directions received by SO\_MMF\_NM. + +In case SO\_MMF\_EM is not able to solve a conflict, it will request the SO\_MMF\_NM to resolve the conflict. + +#### 4.2.1.7 Load Balancing Function (LB\_F) + +This function handles the load balancing optimization. + +#### 4.2.1.8 Interference Control Function (IC\_F) + +This function handles the interference control optimization. + +#### 4.2.1.9 Coverage and Capacity Function (CC\_F) + +This function handles the Coverage and Capacity Optimization. + +#### 4.2.1.10 RACH Optimization Function (RACH\_F) + +This function handles the RACH optimization. + +#### 4.2.1.11 HandOver Optimization Function (HO\_F) + +This function handles the handover optimization. + +#### 4.2.1.12 NM centralized Coverage and Capacity Function (CC\_F\_NM) + +This function represents the NM centralized Coverage and Capacity Optimization (operating above Itf-N) as well as the related IRP Manager functionality. + +CC\_F\_NM analyses monitoring data, determines improvement actions, sends configuration data, and if necessary raises an operator action notification. + +#### 4.2.1.13 Self-Optimization for AAS Function (SO\_AAS\_F) + +This function handles the AAS optimization. + +## 4.3 SON Coordination Concepts + +When multiple SON functions attempt to change some (same or associated) network configuration parameters of some (same or associated) nodes, one or more of these SON functions may not be able to achieve the operator's specified SON target(s) (for individual SON function) since they may have conflicting demands on network resources. This situation is considered as "SON functions in conflict" and requires conflict prevention or resolution. Detection of "SON functions in conflict" can be Use Case specific (for example, two SON functions make change at the same time or during the impact time interval). + +The associated network configuration parameters include parameters within the same network element or parameters of different network elements with impact between each other. For example, the associated parameters of one cell are the parameters of its neighbour cells. Another typical association example is the TX power, antenna azimuth and tilt of one cell are associated with each other. + +Different SON functions may have dependencies with each other. The behaviour of one SON function may have influence on other SON functions. For example, CCO function may adjust the Neighbour Relation due to coverage optimization, and then the changed NR will have an influence on Handover Parameter Optimization function. + +SON coordination is to detect, prevent or resolve conflicts or negative influences between SON functions to make SON functions comply with operator's policy. + +# --- 5 Business level requirements + +## 5.0 General + +The following general and high-level requirement applies for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [2]. +- b) IRP-related requirements in 3GPP TS 32.102 [3]. +- c) IRP-related requirements in 3GPP TS 32.600 [5]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [6] and its information is derived from FNIM Umbrella Information Model (UIM) [6] + +## 5.1 Requirements + +### 5.1.1 Self-Optimization Monitoring and Management + +**REQ-SO\_MM-CON-1** IRPManager shall be able to control the self-optimization functions. + +**REQ-SO\_MM-CON-2** The self-optimization complex corrective actions shall be executed in a consistent and coordinated way. + +**REQ-SO\_MM-CON-3** Self-optimization functions shall reuse existing standardized solutions as much as possible. + +**REQ-SO\_MM-CON-4** void + +**REQ-SO\_MM-CON-5** The IRPAgent shall support a capability allowing the IRPManager to know the success or failure result of Self-Optimization. + +**REQ-SO\_MM-CON-6** The trigger conditions of self-optimization functions should be able to be managed by the IRPManager. The trigger condition may be the scheduled time to start a self-optimization function or a period of time during which a self-optimization function is forbidden to be started or the event (i.e. do not meet objectives or targets) to start a self-optimization function. Each self-optimization function shall have its own set of trigger condition. + +**REQ-SO\_MM-CON-7** For the self-optimization functions which need continuous monitoring, the IRPManager should be able to manage the execution of self-optimization actions (e.g. setting a period of time during which a self-optimization action is forbidden to be executed). + +**REQ-SO\_MM-CON-8** Each self-optimization function shall have one or several related performance indicator, which may be used as objective to evaluate the performance before the self-optimization is initiated and after the self-optimization function is completed. + +**REQ-SO\_MM-CON-9** For operator controlled (open loop) SON function, the IRPAgent shall support a capability allowing IRPManager to know the information about the self-optimization actions. The necessity of this capability will be decided case by case. + +**REQ-SO\_MM-CON-10** The IRPAgent shall support a capability allowing IRPManager to know the information about the execution result of self-optimization actions. + +### 5.1.2 Load Balancing + +**REQ-SO\_LB-CON-1** The optimization of load balancing shall be performed with minimal human intervention. + +**REQ-SO\_LB-CON-2** The following scenarios shall be considered in optimization of load balancing. Each scenario shall include the load balancing on intra-frequency, inter-frequency, and inter-RAT. + +1. Overlapping Coverage +2. Hierarchical Coverage +3. Neighbouring Coverage + +### 5.1.3 Handover (HO) Parameter optimization + +**REQ-SO\_HO-CON-1** HO parameter optimization shall be performed with no human intervention as much as possible. + +**REQ-SO\_HO-CON-2** HO parameter optimization function shall aim at reducing the number of HO failures as well as reducing inefficient use of network resources due to unnecessary handovers. In particular, the HO parameter + +optimization function shall aim at reducing the number of HO related failures that cause degradation in user experience, such as call drops, radio link failures before, during or shortly after HO, and reduced data rates. + +### 5.1.4 Interference control + +**REQ-SO\_IC-CON-1** Interference control shall be performed with as little human intervention as possible. + +**REQ-SO\_IC-CON-2** The following scenarios shall be considered in interference control. + +1. Uplink inter cell interference coordination +2. Downlink inter cell interference coordination + +### 5.1.5 Coverage and Capacity optimization + +**REQ-SO\_CC-CON-1** Coverage and capacity optimization shall be performed with minimal human intervention. + +**REQ-SO\_CC-CON-2** Operator shall be able to configure the objectives and targets for the coverage and capacity optimization function. + +**REQ-SO\_CC-CON-3** Operator shall be able to configure the objectives and targets for the coverage and capacity optimization functions differently for different areas of the network. + +**REQ-SO\_CC-CON-4** The collection of data used as input into the coverage and capacity optimization function shall be automated to the maximum extent possible and shall require minimum possible amount of dedicated resources. + +**REQ-SO\_CC-CON-5** The following scenarios shall be considered in coverage and capacity optimization. + +1. E-UTRAN Coverage holes with 2G/3G coverage +2. E-UTRAN Coverage holes without any other radio coverage +3. E-UTRAN Coverage holes with isolated island cell coverage +4. E-UTRAN cells with too large coverage + +**REQ-SO\_CC-CON-6** The operator shall be able to manage tradeoffs between coverage and capacity using policies. + +### 5.1.6 RACH optimization + +**REQ-SO\_RO-CON-1** RACH optimization shall be performed with minimal human intervention. + +### 5.1.7 SON Coordination + +**REQ-SON\_COORD-CON-1** SON coordination shall allow the prevention and resolution of conflicts between SON functions. + +**REQ-SON\_COORD-CON-2** In case the SON coordination function is below Itf-N, the IRP Agent should support the capability for the IRP Manager to define policies for the case that SON functions request conflicting parameter values. In case no policy is given, the IRP Agent shall apply default policies. + +Note: A policy describes an expected behaviour from the IRP Agent. Examples for such policies: + +- i) Prioritizing SON functions in case of conflicts +- ii) Assigning weights to SON targets +- iii) Prohibiting further changes of a parameter for a certain amount of time +- iv) Selecting preferred value ranges +- v) Telling the IRP Agent to report conflicts + +**REQ-SON\_COORD-CON-3** For the case that the IRP Agent does not resolve the case of SON functions requesting conflicting values for parameters, the IRP Agent should support the capability for the IRP Manager to decide about the parameter values. + +**REQ-SON\_COORD-CON-4** The IRP Agent shall support a capability allowing the IRP Manager to configure the SON coordination policy. The coordination includes the following aspects: + +- 1) Coordination between SON functions below Itf-N and CM operations over Itf-N. +- 2) Coordination between different SON functions. + +### 5.1.8 Active Antenna System (AAS) management + +**REQ-SO\_AAS-CON-1** AAS operations (including Cell Splitting, Cell Merging, Cell Shaping) shall be performed with no or minimal human intervention. + +**REQ-SO\_AAS-CON-2** Operator shall be able to configure and manage the new split or merged cells (which is created from Cell Splitting or Cell Merging operations) in automated manner. + +**REQ-SO\_AAS-CON-3** Operator shall be notified about the creation of split or merged cells as soon as possible after they are split or merged from the original cell(s). + +**REQ-SO\_AAS-CON-4** Operator shall be able to configure the shaped cell (due to Cell Shaping operation) in automated manner with pre-defined alternative coverage configurations. + +**REQ-SO\_AAS-CON-5** The AAS operations (including Cell Splitting, Cell Merging, Cell Shaping) shall be performed with coordination from OAM configuration on neighbour eNBs, to keep coverage, inter-cell interference and handover settings under control. + +## 5.2 Actor roles + +Managed system: The entity performing an IRP Agent role. + +Managing system: The entity performing the IRP Manager role. + +## 5.3 Telecommunications Resources + +The managed E-UTRAN/EPC network equipments are viewed as relevant telecommunications resources in this specification. + +## 5.4 High-Level use case + +### 5.4.1 Load Balancing + +#### 1. Overlapping Coverage + +In this scenario, two same size cells overlap each other. Cell A and cell B both cover the same area. The load balancing between cell A and Cell B may be considered. The load balancing could be carried out between Cell A and Cell B regardless of the UE location within the coverage of the cells. + +![Diagram of Overlapping Coverage showing two cells, Cell A and Cell B, with a shared LB Area.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +The diagram illustrates overlapping coverage between two cells, Cell A and Cell B, on a 3D plane. Cell A is an orange oval at the top, and Cell B is a blue oval at the bottom. A dashed line outlines the overlapping region, which is labeled 'LB Area'. Vertical dashed lines connect the corners of the cells to the plane. + +Diagram of Overlapping Coverage showing two cells, Cell A and Cell B, with a shared LB Area. + +**Figure 5.4.1-1: Overlapping Coverage** + +#### Hierarchical Coverage + +In this scenario, two different size cells overlap each other. Cell B that has a smaller area is covered totally by cell A, which has a bigger size. The load balancing between cell A and Cell B may be considered. The load balancing could be carried out from Cell B to Cell A regardless of the UE location within the coverage of the cell B. Only UE located in the overlapping coverage could be considered in the scenario of Cell A to Cell B. + +![Diagram of Hierarchical Coverage showing Cell B completely inside Cell A, with a shared LB Area.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +The diagram illustrates hierarchical coverage where Cell B is entirely within Cell A. Cell A is a larger orange oval at the top, and Cell B is a smaller blue oval at the bottom. A dashed line outlines the overlapping region, which is labeled 'LB Area'. Vertical dashed lines connect the corners of the cells to the plane. + +Diagram of Hierarchical Coverage showing Cell B completely inside Cell A, with a shared LB Area. + +**Figure 5.4.1-2: Hierarchical Coverage** + +#### Neighbouring Coverage + +In this scenario, there are some overlapped area between two neighbour cell A and cell B. This is the usual neighbour cells scenario in EUTRAN. The load balancing between cell A and Cell B may be considered. Load Balancing could only be carried out for UE located in the overlapping coverage of Cell A and Cell B. + +![Diagram of Neighbouring Coverage showing two overlapping cells, Cell A and Cell B, with a shaded 'LB Area' at their intersection.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +The diagram illustrates two adjacent cells, Cell A (orange oval) and Cell B (blue oval), on a 2D plane. Cell B is partially enclosed by a dashed red line. The overlapping region between Cell A and Cell B is shaded with a grey stippled pattern and labeled 'LB Area' in a callout box. + +Diagram of Neighbouring Coverage showing two overlapping cells, Cell A and Cell B, with a shaded 'LB Area' at their intersection. + +Figure 5.4.1-3: Neighbouring Coverage + +### 5.4.2 Interference control + +#### 1. Uplink inter cell interference coordination + +In this scenario, cell-edge UEs like UE A and B belong to different cell, and they are assigned the same physical resource block (PRB). When they transmit uplink messages, e.g. UE A sends message to its serving cell A, its neighbour cell B may also receives it; UE B has a similar situation. Therefore, cell A cannot judge which is signal-comes from UE A, and which is interference-comes from UE B, so as cell B. In this situation, inter cell interference coordination is essential to compensate for the system performance loss and increase cell edge users' bit rate. + +![Diagram of Uplink Inter Cell Interference Coordination showing two cells, Cell A and Cell B, with user equipment (UE) A and B at the edge. Arrows indicate signals and interference between the UEs and the cells.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +The diagram shows two overlapping circles representing Cell A (red outline) and Cell B (black outline). UE A is located in the overlapping region, closer to Cell B's center. UE B is also in the overlapping region, closer to Cell A's center. Each cell contains a base station icon. Arrows indicate the following: UE A to Cell A (Signal, solid red), UE A to Cell B (Interference, dashed red), UE B to Cell B (Signal, solid black), and UE B to Cell A (Interference, dashed black). + +Diagram of Uplink Inter Cell Interference Coordination showing two cells, Cell A and Cell B, with user equipment (UE) A and B at the edge. Arrows indicate signals and interference between the UEs and the cells. + +Figure 5.4.2-1: Uplink Inter Cell Interference Coordination + +#### 2. Downlink inter cell interference coordination + +In this scenario, when UE located in cell-edge area, it is much adapted to suffer downlink interference from its neighbour cell in case that there is another UE occupying the same PRB in the same region belonging to its neighbour cell. So downlink inter cell interference coordination is essential to restrain interference and increase system capacity. + +![Diagram illustrating downlink inter cell interference coordination between Cell A and Cell B. A User Equipment (UE) is located at the edge of Cell A, receiving a 'Signal' from its own base station and 'Interference' from the base station of Cell B. The UE is also receiving a 'Signal' from Cell B's base station.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +The diagram shows two overlapping circular areas representing Cell A (red outline) and Cell B (black outline). A UE (User Equipment) icon is positioned at the boundary between the two cells. A solid arrow labeled 'Signal' points from the base station in Cell A to the UE. A dashed arrow labeled 'Interference' points from the base station in Cell B to the UE. Another solid arrow labeled 'Signal' points from the base station in Cell B to the UE. The labels 'Cell A' and 'Cell B' are placed below their respective circles. + +Diagram illustrating downlink inter cell interference coordination between Cell A and Cell B. A User Equipment (UE) is located at the edge of Cell A, receiving a 'Signal' from its own base station and 'Interference' from the base station of Cell B. The UE is also receiving a 'Signal' from Cell B's base station. + +Figure 5.4.2-2: Downlink inter cell interference coordination + +### 5.4.3 Coverage and capacity optimization + +Although, it is of primary interest to provide coverage to users during a roll-out, it is equally important to enhance the capacity of the network during operation. As such, both coverage and capacity are considered in the use case and supported by the SON function. The CCO SON function should be configured through appropriate objectives and targets in order to meet the operator's requirement on coverage and capacity, and the prioritization between them. + +#### 1. E-UTRAN Coverage holes with 2G/3G coverage + +In this scenario, legacy systems, e.g. 2G/3G provide radio coverage together with E-UTRAN. However, in the first deployment stage of E-UTRAN, unsuitable planning or error parameters settings will lead to coverage holes in some area. In this scenario, there may be too many IRAT HOs. The SON use case coverage and capacity optimization should enable to detect this kind of problems on network coverage automatically. Another case similar with this is that coverage problems exist between different frequencies in E-UTRAN, i.e. inter-frequency case. For simple reasons, this case is also described here. + +![Diagram illustrating coverage holes with 2G/3G coverage. A large light blue oval represents '2G/3G/Different freq of LTE Coverage'. Below it, four smaller orange ovals represent 'Specific Freq Coverage of LTE'. A green arrow points to the gap between the two sets of coverage, labeled 'Coverage holes'.](f57a881fcbcaf494a7dedc4f61224991_img.jpg) + +The diagram shows a large light blue oval at the top labeled '2G/3G/Different freq of LTE Coverage'. Below it, there are four smaller orange ovals arranged in two pairs, collectively labeled 'Specific Freq Coverage of LTE'. A green arrow points upwards to the gap between the large oval and the smaller ovals, with the text 'Coverage holes' written below the arrow. + +Diagram illustrating coverage holes with 2G/3G coverage. A large light blue oval represents '2G/3G/Different freq of LTE Coverage'. Below it, four smaller orange ovals represent 'Specific Freq Coverage of LTE'. A green arrow points to the gap between the two sets of coverage, labeled 'Coverage holes'. + +Figure 5.4.3-1: Coverage holes with 2G/3G coverage + +#### 2. E-UTRAN Coverage holes without any other radio coverage + +In this scenario, there is no 2G/3G coverage except E-UTRAN. In the first deployment stage of E-UTRAN, unsuitable planning or error parameters settings will lead to un-continuous coverage in some area. That will lead to many drop calls because of bad coverage. The SON use case coverage and capacity optimization should enable to detect this kind of problems on network coverage automatically. + +![Diagram showing coverage holes between two pairs of E-UTRAN radio coverage areas.](8307f6b04df072c9332f9987e034272c_img.jpg) + +The diagram illustrates two pairs of dark blue ovals, each pair representing the 'Radio Coverage of E-UTRAN'. Between the two pairs, there is a gap. A green arrow points upwards from the text 'Coverage holes' into this gap, indicating the area not covered by the radio signals. + +Diagram showing coverage holes between two pairs of E-UTRAN radio coverage areas. + +Figure 5.4.3-2: Coverage holes without any other radio coverage + +#### 3. E-UTRAN Coverage holes with isolated island cell coverage + +In this scenario, the actual coverage area of an isolated island cell is smaller than the planned isolated island cell area. The uncovered planned cell area is the coverage holes that need to be detected and optimized by the coverage and capacity optimization. + +![Diagram showing an isolated island cell with actual coverage smaller than planned coverage.](36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg) + +The diagram shows a large light blue oval labeled 'Planned Isolated Island Cell of E-UTRAN'. Inside this oval is a smaller orange oval labeled 'Actual Isolated Island Cell of E-UTRAN'. The area between the two ovals represents the 'Coverage holes'. Two green arrows point from the text 'Coverage holes' (one on the left, one on the right) into this gap. + +Diagram showing an isolated island cell with actual coverage smaller than planned coverage. + +Figure 5.4.3-3: Coverage holes with isolated island cell coverage + +#### 4. E-UTRAN cells with too large coverage + +In this scenario, the operator does a gradual network evolution using LTE cells in location where higher capacity is needed. Here the actual LTE coverage is greater than the planned LTE coverage. The overflow area is shown in figure 5.4.3.4. The problem with a too large coverage is that the planned capacity may not be reached. As such, it is important to keep the coverage within the planned area. + +![Diagram showing actual LTE coverage exceeding planned LTE coverage, creating overflow areas.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +The diagram shows two horizontal ovals. The top, larger orange oval is labeled 'Actual LTE coverage'. The bottom, smaller yellow oval is labeled 'Planned LTE coverage'. The area between the two ovals, where the actual coverage exceeds the planned coverage, is labeled 'Overflow area' at both the left and right ends, indicated by brackets and dashed lines. + +Diagram showing actual LTE coverage exceeding planned LTE coverage, creating overflow areas. + +Figure 5.4.3-4: Difference between actual and planned LTE coverage + +### 5.4.4 NM centralized Coverage and Capacity Optimization + +#### 5.4.4.0 General + +Annex B gives general descriptions related to the use cases in this section. + +#### 5.4.4.1 Use case 1: Cell coverage adapting to traffic demand + +Cell coverage is typically estimated at the time of network planning, where exact distribution of users is hard to take into account. However, the service performance as seen by the user will depend among others on the traffic load in the particular cell, e.g. on the number of users that has to share the cell resources at a particular location. Therefore, there may be a need to adapt cell sizes to the typical distribution of traffic demand from time to time when the distribution of users or the environmental situation are changing (e.g. rush hours). + +The CCO function needs to detect such service performance problems caused by load imbalances, for which it may need to collect, for example, information about number of active UEs, IP Throughput, Packet Delay, Drop, Loss Rate, Data Volume measurements and environmental information (e.g. the location of freeway, stadiums). The CCO function may also collect information of the used/available capacity estimated by the eNodeB itself, based on resource management algorithms implemented in the eNodeB. An example describing the UE location distribution via two-dimensional bins measurements is shown in Annex B.2. + +Based on the collected information, the CCO function may decide to adjust capacity or coverage areas of the related cells. + +#### 5.4.4.2 Use case 2: Coverage and accessibility + +Typically, the network has to provide basic coverage that ensures accessibility and connectivity. Basic coverage could mean, for example, that a certain level of signal strength should be reached in the cell area and accessibility attempts, i.e. RRC connection attempts and random access attempts must reach certain level of success rate. + +The CCO function may collect RSRP/RSRQ measurements (with or without location information included), RLF events, RRC setup failure reports and random access performance measurements, which could be indications of bad coverage. To further separate uplink and downlink related coverage problems, uplink interference, signal quality and power measurements may be used. The different types of reports related to the same incident and user should be possible to be correlated so the CCO function can identify the source of the problem and can take the right corrective action. A potential way is the correlation of uplink and/or downlink MDT data (e.g. M2, M3) and RLF report data (e.g. RSRP/RSRQ) may be used to analyze whether the RLF is caused by uplink coverage problem. + +#### 5.4.4.3 Use case 3: LTE coverage holes with underlaid UTRAN/GERAN + +LTE is typically deployed in areas with dense population in an attempt to mitigate traffic congestion during the peak hours. Therefore, initial LTE deployment may be patchy with underlaid UTRAN/GERAN networks that provide basic coverage. Figure 5.4.4.3-1 shows that there may be coverage holes between LTE cells. + +![Figure 5.4.4.3-1: LTE coverage hole with underlaid UTRAN/GERAN. The diagram shows a horizontal axis labeled 'Location' and a vertical axis labeled 'Signal Strength'. Two large ovals represent UTRAN/GERAN #1 (tan) and UTRAN/GERAN #2 (green). Within UTRAN/GERAN #1 is E-UTRAN #A (blue), and within UTRAN/GERAN #2 is E-UTRAN #B (blue). A 'Coverage hole' is indicated between E-UTRAN #A and E-UTRAN #B. A dashed line represents the signal strength path of a UE moving from left to right, showing a significant drop in the coverage hole area. An arrow points to this drop as the 'Inter-RAT HO trigger point'.](1c427123350e0e73e2a109b79069314b_img.jpg) + +Figure 5.4.4.3-1: LTE coverage hole with underlaid UTRAN/GERAN. The diagram shows a horizontal axis labeled 'Location' and a vertical axis labeled 'Signal Strength'. Two large ovals represent UTRAN/GERAN #1 (tan) and UTRAN/GERAN #2 (green). Within UTRAN/GERAN #1 is E-UTRAN #A (blue), and within UTRAN/GERAN #2 is E-UTRAN #B (blue). A 'Coverage hole' is indicated between E-UTRAN #A and E-UTRAN #B. A dashed line represents the signal strength path of a UE moving from left to right, showing a significant drop in the coverage hole area. An arrow points to this drop as the 'Inter-RAT HO trigger point'. + +**Figure 5.4.4.3-1: LTE coverage hole with underlaid UTRAN/GERAN** + +The LTE coverage holes may be detected by the Inter-RAT measurements. The network can capture measurements (e.g. RSRP, RSRQ, cell ID, location, time stamp at the time of Inter-RAT handover), which can be collected for the CCO function and used to identify coverage holes in the LTE network. + +The LTE coverage holes may be detected also using measurements performed by UEs in the idle mode. + +When an UE is in "any cell selection" or "camped on any cell" state, the periodic logging stops. + +When the UE re-enters "camped normally" state and the duration timer has not expired, the periodic logging is restarted (see clause 5.1.1.2 of 3GPP TS 37.320 [7]). + +Figure 5.4.4.3-2 is an example to show that an LTE coverage hole can be detected when an UE stops and resumes logging MDT measurements. + +![Figure 5.4.4.3-2: LTE coverage holes with and without underlaid UTRAN detected by logged MDT. The diagram consists of two parts, A and B, showing hexagonal cell layouts. A legend indicates that small circles represent 'Logged MDT measurements'. Part A, titled 'E-UTRAN cells with coverage hole', shows four cells: E-UTRAN Cell A, E-UTRAN Cell B, E-UTRAN Cell C, and E-UTRAN Cell D. A path of logged measurements starts in Cell A, passes through Cell B, and ends at the boundary between Cell C and Cell D, with a gap in Cell C labeled 'LTE Coverage hole'. Part B, titled 'E-UTRAN cells with UTRAN overlaid', shows the same E-UTRAN cells but with a UTRAN Cell X overlaid in the center. The path of logged measurements starts in Cell A, passes through Cell B, continues through Cell X into Cell D, and ends in Cell D, with a gap in Cell X labeled 'LTE Coverage hole'.](327ba94498e3381cf08eb41e3fd3d77f_img.jpg) + +Figure 5.4.4.3-2: LTE coverage holes with and without underlaid UTRAN detected by logged MDT. The diagram consists of two parts, A and B, showing hexagonal cell layouts. A legend indicates that small circles represent 'Logged MDT measurements'. Part A, titled 'E-UTRAN cells with coverage hole', shows four cells: E-UTRAN Cell A, E-UTRAN Cell B, E-UTRAN Cell C, and E-UTRAN Cell D. A path of logged measurements starts in Cell A, passes through Cell B, and ends at the boundary between Cell C and Cell D, with a gap in Cell C labeled 'LTE Coverage hole'. Part B, titled 'E-UTRAN cells with UTRAN overlaid', shows the same E-UTRAN cells but with a UTRAN Cell X overlaid in the center. The path of logged measurements starts in Cell A, passes through Cell B, continues through Cell X into Cell D, and ends in Cell D, with a gap in Cell X labeled 'LTE Coverage hole'. + +**Figure 5.4.4.3-2: LTE coverage holes with and without underlaid UTRAN detected by logged MDT** + +#### 5.4.4.4 Use case 4: LTE Connection failure + +While in idle mode UE enters an area of coverage problems (such as weak coverage, overshoot coverage, pilot pollution and DL and UL channel coverage mismatch etc.), the UE attempts to establish the RRC connection but fails (RCEF report is logged). + +![Diagram illustrating the correlation of RCEF with MDT data in idle mode. A dashed line with arrows represents the idle mode path. A red circle with an 'X' represents an RCEF event. Green circles represent MDT data samples. The path shows the UE moving from the top-left cell, through the center cell, to the bottom-right cell, with an RCEF event occurring in the center cell.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +idle mode + +RCEF event + +MDT data samples + +Diagram illustrating the correlation of RCEF with MDT data in idle mode. A dashed line with arrows represents the idle mode path. A red circle with an 'X' represents an RCEF event. Green circles represent MDT data samples. The path shows the UE moving from the top-left cell, through the center cell, to the bottom-right cell, with an RCEF event occurring in the center cell. + +**Figure 5.4.4.4-1 Correlation of RCEF with MDT data** + +Another case is when the UE is in connected mode, loses the connection and then tries to reconnect to the network but it fails. + +![Diagram illustrating the correlation of RLF and RCEF with MDT data. A dashed line with arrows represents the connected mode path, and a dashed line with arrows represents the idle mode path. A red circle with an 'X' represents an RCEF event, and a red circle with an 'X' represents an RLF event. Green circles represent MDT data samples, and a large green circle represents an RRC Connection Setup. The path shows the UE moving from the top-left cell, through the center cell, to the bottom-right cell. An RLF event occurs in the center cell, followed by an RCEF event. The UE then attempts to reconnect in the bottom-right cell.](2eb23c2210154279f8013a1594fbcc5a_img.jpg) + +connected mode + +idle mode + +RCEF event + +RLF event + +MDT data samples + +RRC Connection Setup + +Diagram illustrating the correlation of RLF and RCEF with MDT data. A dashed line with arrows represents the connected mode path, and a dashed line with arrows represents the idle mode path. A red circle with an 'X' represents an RCEF event, and a red circle with an 'X' represents an RLF event. Green circles represent MDT data samples, and a large green circle represents an RRC Connection Setup. The path shows the UE moving from the top-left cell, through the center cell, to the bottom-right cell. An RLF event occurs in the center cell, followed by an RCEF event. The UE then attempts to reconnect in the bottom-right cell. + +**Figure 5.4.4.4-2 Correlation of RLF and RCEF with MDT data** + +In both cases the CCO function would need to identify the reason of failure, for which it may need to combine the logged RCEF report with other measurement data, potentially including also measurements made by the RAN or with other incidents and measurements reported by the UE (e.g. RLF report, RSRP/RSRQ reports). For detailed analysis of connection failures and Coverage and Capacity Optimization, all the different pieces of information connected to the occurrence of the same incident need to be combined, and the combined data will be used by the CCO function. + +For detailed analysis of connection failures and CCO, information may be required about the radio conditions of the network prior to and at the moment when the connection failure occurs. In E-UTRAN this data may be collected e.g. by utilizing the potentially enhanced Logged MDT and/or Immediate MDT procedures depending on the specific failure scenario. + +#### 5.4.4.5 Use case 5: Radio link quality + +The service performance (e.g. throughput) as seen by the user is largely dependent on the quality of the radio link (e.g. CQI, see 3GPP TS 36.213 [9]), which is influenced by signal strength, interference, and other conditions. It should be possible for the CCO function to collect information about the radio quality combined with user performance (e.g. IP throughput, CQI, UL SINR) and determine whether the radio link is a bottleneck in service performance. The CCO function may decide to change the signal strength of the investigated cell or that of an interfering nearby cell e.g. by modifying antenna tilt or power settings in order to improve radio link quality. + +The CQI can be used as a direct indicator of the Signal to Interference and Noise Ratio (SINR) conditions seen by the UE at actual data transmissions, for which neither RSRP nor RSRQ (see 3GPP TS 36.214 [11]) would be suitable. Note that RSRP is indicative only to the signal strength of the Reference Symbol (RS), while RSRQ is derived from RSRP as the ratio of RSRP versus RSSI (i.e. total received signal power in the RSSI measurement bandwidth), which is not equal to SINR. Moreover RSRP and RSRQ are measured separately from actual user plane transmissions, while CQI is measured and reported when data is actually transmitted. + +For example, by observing the UE reported CQI values during a collection period (similarly to the collection period as used in case of existing MDT measurements) it is possible to determine whether the UE was in a poor radio condition at that time. Although the instantaneous CQI value is influenced by fast link variations (e.g. by fast fading), the fast fluctuations are typically around some centre value, which is characteristic to the particular radio environment and can be used by the CCO function to evaluate radio link quality. + +Collecting the UE reported Rank Indicator (RI) in a similar way could be used to evaluate radio link quality from spatial multiplexing point of view. The RI reports give information about whether the UE has found the radio link quality good enough to use spatial multiplexing. + +### 5.4.5 SON for AAS + +#### 5.4.5.1 General + +The Active Antenna Systems (AAS) can enable system optimization to be adaptive to traffic demands and address network evolution issues through flexible software re-configuration of the BS and antenna system. + +SON mechanism with OAM support can be beneficial to optimize the inter-operability of AAS operations for the following AAS capabilities: + +- 1) Cell splitting. +- 2) Cell merging. +- 3) Cell Shaping. + +#### 5.4.5.2 Use case 1: Cell splitting + +Cell Splitting adopts higher order sectorisation (vertical, horizontal or a combination) to an eNB by changing the coefficients of the antenna elements of an active antenna system (AAS) to form more antenna beams, each beam may be presented by one cell. + +The number of cells split by AAS from an original cell is not fixed, i.e. it is flexible based on the antenna capability. + +The cells newly split from an original cell may or may not change the coverage of the original cell. In order to simplify the description, the term SO-Cell and SP-Cell are used to signify the original cell and the new cell split from the original cell in Cell Splitting. + +As Cell Splitting operation is changing coverage, interference and handover settings for SP-cells and their neighbours, coordination with neighbour eNBs is needed to keep coverage and inter-cell interference under control. + +The SP-Cells need to be manageable as soon as possible after they are split from the SO-Cell + +The SP-Cell, once split from the SO-Cell, needs to be made known to management system as soon as possible, at least before AAS operation is applied to the SP-Cell. + +The PCI of the SP-Cell may be or may be not the same as the PCI of the SO-Cell, however PCI conflict or confusion with other cells needs to be avoided. So the PCI or PCI range of each SP-Cell may be pre-allocated. + +ECGI of each SP-Cell needs to be globally unique, it should be possible to be configured (or pre-configured) by OAM. + +#### 5.4.5.3 Use case 2: Cell Merging + +Cell Merging is the contrary operation of Cell Splitting. + +The number of cells can be merged by AAS into one cell is not fixed, i.e. it is based on AAS algorithm. + +The cell merged from the original cells (in respect to Cell Merging) may or may not change the coverage of these original cells. In order to simplify the description, the term MO-Cell and MT-Cell are used to signify the original cell and the target cell merged from the original cells in Cell Merging. + +As Cell Merging operation is changing coverage, interference and handover settings created by the cell under consideration, coordination with neighbour eNBs is needed to keep coverage, interference and handover settings under control. + +The entity triggering the Cell Merging should be the same as the entity triggering the Cell Splitting for one active antenna system. + +For Cell Merging, the MT-Cell is normally assigned with a new ECGI, but may inherit the PCI from one of its MO-cells. So, in the view of other (e.g. neighbour/adjacent) cells, the Cell Merging is the case that one MO-Cell (whose id is continuously used by the MT-Cell) enlarges its coverage while the other MO-Cells become unavailable. + +#### 5.4.5.4 Use case 3: Cell Shaping + +Cell Shaping adapts the cell edge to load demand while maintaining the main coverage unchanged. + +As Cell Shaping operation is changing coverage, interference and handover settings created by the cell under consideration, coordination with neighbour eNBs is needed to keep coverage, inter-cell interference and handover settings under control. + +If the eNB executes Cell Shaping in a fully unconstrained manner, it may decrease the reliability of handovers with its neighbour cells since in this case an appropriate handover margin cannot be guaranteed. So, the eNB may be pre-configured with alternative coverage configurations and the eNB may autonomously select and switch between these configurations using AAS operations including Cell Shaping. the number of allowed coverage configurations is limited. + +The eNB needs to consider each allowed coverage configuration, to: + +- 1) make the right selection for the coverage change during Cell Shaping; and +- 2) set the proper handover margin with neighbour cells. + +Therefore, each pre-configured coverage configuration should include a state identifier and the range of the parameters (e.g. tilt, power) affecting the coverage range. + +# --- 6 Specification level requirements + +## 6.1 Requirements + +### 6.1.1 Self-Optimization Monitoring and Management + +#### 6.1.1.1 Management Part + +**REQ-SO\_MM-FUN-1** IRPManager shall be able to configure objectives and targets for the self-optimization functions. + +**REQ-SO\_MM-FUN-2** For open loop, IRPManager shall be able to configure whether a confirmation is needed before the execution of optimization actions. The necessity of a confirmation will be decided case by case. + +**REQ-SO\_MM-FUN-3** For open loop, IRPManager shall be able to confirm the execution of optimization actions in case IRPManager configured a confirmation is needed. + +**REQ-SO\_MM-FUN-4** For open loop, IRPManager shall provide information to the IRPManager about the optimization actions. The necessity of this capability will be decided case by case. + +**REQ-SO\_MM-FUN-5** IRPManager shall provide information to the IRPManager about the execution result of self-optimization actions. + +**REQ-SO\_MM-FUN-6** The IRPManager shall provide information to the IRPManager about the outcome of self-optimization. + +**REQ-SO\_MM-FUN-7** IRPManager shall be able to configure the values of KPIs or performance counters which may be used to trigger the optimization function. + +**REQ-SO\_MM-FUN-8** When the IRPManager is aware of disruptive situations for the SON functionality, it shall support optimization functions in coping with them as much as possible without the need for an intervention from the IRPManager. Disruptive situations are e.g. an outage of a cell, the insertion of a new cell, deactivation of a cell etc. + +### 6.1.2 Load Balancing + +**REQ-SO\_LB-FUN-1** The IRPManager shall be able to disable/enable the load balancing function. + +**REQ-SO\_LB-FUN-2** The IRPManager shall be informed about the eNodeB load. + +**REQ-SO\_LB-FUN-3** The IRPManager shall be able to request that load balancing be allowed from source cell to target cell. + +**REQ-SO\_LB-FUN-4** The IRPManager shall be able to request that load balancing be prohibited from source cell to target cell. + +**REQ-SO\_LB-FUN-5** The IRPManager shall inform the IRPManager about success or failure of IRPManager operations to allow load balancing, prohibit load balancing. + +### 6.1.3 Handover (HO) Parameter optimization + +#### 6.1.3.1 HO failure categorization + +##### 6.1.3.1.1 HO failures due to too late and too early HO triggering + +HO failures can be categorized as follows: + +- HO failures due to too late HO triggering +- HO failures due to too early HO triggering +- Failures due to HO to a wrong cell + +Consequently, the HO parameter optimisation should aim at detecting and mitigating too early HOs, too late HOs and HOs to a wrong cell. The following subsections provide the scenarios for too early HO, too late HO and HO to a wrong cell triggering leading to HO failures. + +###### 6.1.3.1.1.1 Too late HO triggering + +Example scenario for too late HO triggering is shown in Figure 6-1. If the UE mobility is more aggressive than what the HO parameter settings allow for, the HO could be triggered when the signal strength of the serving cell is already too low or may not be triggered at all if a radio link failure preempts it. The connection may be re-established on a different cell from the serving cell. This is a common scenario in areas where user mobility is very high, such as along the highways, train lines etc. + +![Figure 6-1: Too late HO triggering scenario diagram](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +The diagram shows two overlapping circular coverage areas, Cell A (light blue) and Cell B (light green). A User Equipment (UE) icon is shown moving from Cell A towards Cell B. An arrow points from the UE to an 'X' mark located just outside the boundary of Cell B, indicating a radio link failure before the handover was completed. A legend at the top indicates 'Cell A X = radio link failure Cell B'. + +Figure 6-1: Too late HO triggering scenario diagram + +Due to fast movement and inadequate HO parameter setting, UE leaves the source cell coverage before the HO is triggered + +**Figure 6-1 – Too late HO triggering scenario** + +###### 6.1.3.1.1.2 Too early HO triggering + +Example scenario for too early HO triggering is shown in Figure 6-2. HO can be triggered when the UE enters unintended island of coverage of the target cell inside the intended coverage area of the serving cell. When the UE exits the island of coverage of the target cell, it cannot acquire the target cell any more and the HO fails, potentially leading to a radio link failure. This is a typical scenario for areas where fragmented cell coverage is inherent to the radio propagation environment, such as dense urban areas. + +![Figure 6-2: Too early HO triggering scenarios diagram](19a5f0db57a21a0e82a7f326083e96fd_img.jpg) + +The diagram shows two overlapping circular coverage areas, Cell A (light blue) and Cell B (light green). Cell B has a smaller, dashed circular 'island of coverage' inside Cell A. A UE icon is shown moving from Cell A into this island. A red dot on the UE indicates the HO triggering point. As the UE moves out of the island, an arrow points to an 'X' mark, indicating an HO failure. A legend at the top indicates 'Cell A X = HO failure Cell B' and '● = HO triggering'. A label at the bottom points to the dashed circle: 'Island of coverage of Cell B inside the coverage area of Cell A'. + +Figure 6-2: Too early HO triggering scenarios diagram + +**Figure 6-2 – Too early HO triggering scenarios** + +###### 6.1.3.1.1.3 HO to a wrong cell + +Example scenario for HO to a wrong cell is shown in Figure 6-3. In this scenario UE is moved from cell A to cell C, but because the HO parameter not optimized and a cell A sends a wrong HO command performs a handover to cell B and then a RLF happens. After that UE re-establishes connection with cell C. + +![Diagram illustrating HO to a wrong cell scenarios. It shows three cells: Cell A (blue), Cell B (white), and Cell C (white). A mobile device is shown moving from Cell A towards Cell B. A red dot indicates an HO triggering point at the boundary between Cell A and Cell B. An 'X' marks a radio link failure at the same point. A blue arrow points from the device towards Cell C. A text label points to the failure point: 'Radio link failure due to unproper HO parameter setting between cell A and cell B'. A legend indicates: '● = HO triggering' and 'X = radio link failure'.](26d664119ad25250780f554633444e54_img.jpg) + +● = HO triggering +X = radio link failure + +Cell A + +Cell B + +Cell C + +Radio link failure due to unproper HO parameter setting between cell A and cell B + +Diagram illustrating HO to a wrong cell scenarios. It shows three cells: Cell A (blue), Cell B (white), and Cell C (white). A mobile device is shown moving from Cell A towards Cell B. A red dot indicates an HO triggering point at the boundary between Cell A and Cell B. An 'X' marks a radio link failure at the same point. A blue arrow points from the device towards Cell C. A text label points to the failure point: 'Radio link failure due to unproper HO parameter setting between cell A and cell B'. A legend indicates: '● = HO triggering' and 'X = radio link failure'. + +**Figure 6-3 –HO to a wrong cell scenarios** + +#### 6.1.3.2 Reducing inefficient use of network resources due to unnecessary HOs + +HO procedure is resource-consuming and therefore costly to the network operator. Sometimes, the combination of user mobility patterns and cell coverage boundary layout can generate frequent unnecessary HOs that consume NW resources inefficiently. This scenario is illustrated in Figure 6-4a. HO parameter optimisation function should aim at detecting such scenarios. These scenarios sometimes can be remedied by HO parameter optimisation, as illustrated in Figure 6-4b. Since the goal of reducing unnecessary HOs can sometimes be opposed to the goal of reducing the number of HO failures, operators should be able to set the tradeoff point. + +![Diagram illustrating frequent HOs causing inefficient use of network resources. It shows two cells: Cell A (blue) and Cell B (white). A mobile device is shown moving from Cell A towards Cell B. Multiple red dots, representing HO triggering points, are clustered along the boundary between the two cells. A legend indicates: '● = HO triggering'.](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +Cell A + +● = HO triggering + +Cell B + +Diagram illustrating frequent HOs causing inefficient use of network resources. It shows two cells: Cell A (blue) and Cell B (white). A mobile device is shown moving from Cell A towards Cell B. Multiple red dots, representing HO triggering points, are clustered along the boundary between the two cells. A legend indicates: '● = HO triggering'. + +**Figure 6-4a – Frequent HOs cause inefficient use of NW resources** + +![Diagram illustrating HO parameter adjustment preventing frequent HOs. It shows two cells: Cell A (blue) and Cell B (white). A mobile device is shown moving from Cell A towards Cell B. The boundary between the cells is shown with a dotted line. Several red dots, representing HO triggering points, are shown near the boundary, but some are crossed out with an 'X'. A text label points to these crossed-out dots: 'HOs not triggered due to HO parameter adjustment'. A legend indicates: '● = HO triggering'.](ea4fd10a9a501c602f2bea0f7f711877_img.jpg) + +Cell A + +Cell B + +HOs not triggered due to HO parameter adjustment + +Diagram illustrating HO parameter adjustment preventing frequent HOs. It shows two cells: Cell A (blue) and Cell B (white). A mobile device is shown moving from Cell A towards Cell B. The boundary between the cells is shown with a dotted line. Several red dots, representing HO triggering points, are shown near the boundary, but some are crossed out with an 'X'. A text label points to these crossed-out dots: 'HOs not triggered due to HO parameter adjustment'. A legend indicates: '● = HO triggering'. + +**Figure 6-4b – HO parameter adjustment prevents frequent HOs** + +Additionally, incorrect cell reselection parameters setting may result unwanted handover right after RRC connection setup, HO parameter optimization function should also aim at detecting misalignment between cell reselection parameters and handover parameters setting and adjust the parameters to avoid such scenarios. + +#### 6.1.3.3 Requirements + +**REQ-SO\_HO-FUN-1** HO parameter optimisation function shall aim at detecting too early handover, too late handover and handover to a wrong cell. + +**REQ-SO\_HO-FUN-2** HO parameter optimisation function shall aim at detecting inefficient use of network resources due to unnecessary HOs. + +**REQ-SO\_HO-FUN-3** HO parameter optimisation function shall aim at meeting the objectives and targets for the HO optimisation function + +**REQ-SO\_HO-FUN-4** The objectives for the HO parameter optimisation function shall reflect the desired tradeoff between the reduction in the number of HO related failures and the reduction of inefficient use of network resources due to HOs. + +**REQ-SO\_HO-FUN-5** The IRPManager shall be able to disable/enable the HO parameter optimization function. + +### 6.1.4 Interference control + +**REQ-SO\_IC-FUN-1** The IRPManager shall be able to disable/enable the Interference Control function. + +**REQ-SO\_IC-FUN-2** The IRPManager shall be able to request that ICIC be allowed from source cell to target cell. + +**REQ-SO\_IC-FUN-3** The IRPManager shall be able to request that ICIC be prohibited from source cell to target cell. + +**REQ-SO\_IC-FUN-4** An IRPAgent shall inform the IRPManager about success or failure of IRPManager operations to allow ICIC, prohibit ICIC. + +### 6.1.5 Coverage and capacity optimization + +**REQ-SO\_CC-FUN-1** Performance measurements with geographical binning may be used as inputs into the coverage and capacity optimization function. + +**REQ-SO\_CC-FUN-2** CCO function shall aim at providing optimal capacity and coverage for the radio network while considering the trade-off between capacity and coverage. + +**REQ-SO\_CC-FUN-3** The IRPAgent shall support a capability allowing the IRPManager to enable or disable the CCO function. + +### 6.1.6 RACH optimization + +**REQ-SO\_RO-FUN-1** The IRPAgent shall support enabling and disabling the RACH optimization function. + +### 6.1.7 SON Coordination + +The following requirements apply when the SON coordination function is in NM layer. + +**REQ-SON\_COORD-FUN-1** The IRPAgent shall provide the capability to inform the IRPManager whether a SON function is activated or not. + +**REQ-SON\_COORD-FUN-2** The IRPAgent shall provide the capability to inform the IRPManager about which SON functions modified configuration parameter(s). + +**REQ-SON\_COORD-FUN-3** The IRPAgent should provide the capability to inform the IRPManager about the time duration how long the configuration parameter(s) should not be modified. + +**REQ-SON\_COORD-FUN-4** The IRPAgent should provide the capability to inform the IRPManager about the SON targets which are the justification for the configuration change. + +The following requirements apply when the SON coordination function is below Itf-N. + +**REQ-SON\_COORD-FUN-5** The IRPAgent should provide a capability to allow the IRPManager to configure the priority of SON functions in case of conflicts. + +**REQ-SON\_COORD-FUN-6** The IRPAgent shall provide the capability for the IRPManager to be informed when the SON coordination function could not resolve a conflict. This information should include the involved SON functions, the involved configuration parameters and/or the involved SON targets. + +### 6.1.8 NM centralized coverage and capacity optimization + +**REQ-SO\_CC\_NM-FUN-1** The IRPAgent shall support a capability allowing the IRPManager to initiate needed performance measurements that are not already active and to receive performance measurements. + +**REQ-SO\_CC\_NM-FUN-2** The IRPAgent shall support a capability allowing the IRPManager to order one single trace session for several job types of radio measurements (e.g. a combination of MDT/RLF/RCEF measurements) using one single operation. + +**REQ-SO\_CC\_NM-FUN-3** The IRPAgent shall support a capability allowing the IRPManager to receive recorded MDT/RLF/RCEF measurements. + +**REQ-SO\_CC\_NM-FUN-4** The IRPAgent shall support a capability allowing the IRPManager to configure attributes that affect coverage and capacity. + +**REQ-SO\_CC\_NM-FUN-5** The IRPAgent shall support a capability allowing the IRPManager to receive indications that parameters have changed their values. + +### 6.1.9 AAS management + +**REQ-SO\_AAS-FUN-1** The IRPAgent should support a capability allowing IRPManager to switch on/off the specific AAS operations (including Cell Splitting, Cell Merging, Cell Shaping) respectively. + +**REQ-SO\_AAS-FUN-2** The IRPAgent should support a capability allowing IRPManager to set the quantity of allowed split cells to be split from the original cell. + +**REQ-SO\_AAS-FUN-3** The IRPAgent should support a capability allowing IRPManager to pre-configure the ECGI for the potential split or merged cells. + +**REQ-SO\_AAS-FUN-4** The IRPAgent should support a capability allowing IRPManager to pre-allocate the PCI range(s) for the potential split or merged cells. + +**REQ-SO\_AAS-FUN-5** The IRPAgent should support a capability allowing IRPManager to pre-configure the range of parameters affecting the coverage for each potential split cell. + +**REQ-SO\_AAS-FUN-6** The IRPAgent should be able to notify IRPManager about the creation of split or merged cell as soon as possible after it is split or merged from the original cell(s). + +**REQ-SO\_AAS-FUN-7** The IRPAgent should support a capability allowing IRPManager to modify the ECGI and PCI of the split or merged cells. + +**REQ-SO\_AAS-FUN-8** The IRPAgent should enable management operations with the newly created split cell as soon as possible after it is split from the original cell. + +**REQ-SO\_AAS-FUN-9** For NM centralized AAS SON, the AAS operations (i.e. Cell Splitting, Cell Merging, or Cell Shaping) at the eNB should be configured by OAM in coordination with OAM configuration of the neighbour eNBs to keep coverage, inter-cell interference and handover settings under control. + +**REQ-SO\_AAS-FUN-10** The IRPAgent should support a capability allowing IRPManager to pre-configure the alternative coverage configurations (including a state identifier, the range of parameters which affect coverage (e.g. tilt, power)), then SON for Cell Shaping operation can autonomously select and switch between these configurations. + +## 6.2 Actor roles + +No new actor. + +## 6.3 Telecommunications Resources + +No new telecommunications resources. + +## 6.4 Use case + +### 6.4.1 Use case Self-Optimization Monitoring and Management + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal (*) | Optimize the system in an automated manner. | | +| Actors and Roles (*) | IRPManager as user | | +| Telecom resources | The E-UTRAN/EPC network including its management system. | | +| Assumptions | The network is properly installed and running. | | +| Pre conditions | The self-optimization objectives and targets have been set by operators | | +| Begins when | Based on the monitored input parameters (KPIs, Alarms, etc.), targets for the objectives defined for the self-optimization functions are not met. | | +| Step 1 (*) (M O) | <p>The order of the bullet points in the list below does not imply any statements on the order of execution.</p> <ul style="list-style-type: none"> <li>[SO1] The input parameters (KPIs, Alarms, etc.) are monitored continuously.</li> <li>[SO2] When the monitored parameters do not meet the optimization targets, the optimization function is triggered.</li> <li>[SO3] Optimisation function proposes corrective actions.</li> <li>[SO4] Operator may confirm the execution/activation of the proposed actions if needed.</li> <li>[SO5] Corrective actions are executed.</li> <li>[SO6] Optimisation function monitors system status for a certain pre-defined monitoring time period.</li> <li>[SO7] The configuration prior to the corrective action is memorised if needed.</li> <li>[SO8] If the system status is satisfactory during the monitoring time period, then go to [SO1].</li> <li>[SO9] Operator may confirm if fallback is needed.</li> <li>[SO10] Fallback is executed.</li> <li>[SO11] The operator is informed about the progress and important events occurring during the self-optimization process.</li> </ul> | | +| Step n (M O) | | | +| Ends when (*) | Ends when all steps identified above are successfully completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails and retry is unsuccessful.. | | +| Post Conditions | System is operating normally. | | +| Traceability (*) | REQ-SO_MM-FUN-1, REQ-SO_MM-FUN-2, REQ-SO_MM-FUN-3, REQ-SO_MM-FUN-4, REQ-SO_MM-FUN-5, REQ-SO_MM-FUN-6 | | + +### 6.4.2 Use case Load Balancing Allowed/Prohibited Management + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal (*) | The load balancing (LB) can be allowed/prohibited from a source cell to a target cell by the IRPManager. | | +| Actors and Roles (*) | IRPManager as user | | +| Telecom resources | The E-UTRAN/EPC network including its OSS. | | +| Assumptions | There is operator's policy for LB allowing/prohibiting management. For example:<br>LB from the higher priority cell to the lower priority cell is allowed; reverse is prohibited.<br>LB between an eNB cell and another eNB cell which belongs to another unwanted PLMN is prohibited. | | +| Pre conditions | The network is operational. | | +| Begins when | | | +| Step 1 (*) (M) | The IRPManager makes a decision to allow/prohibit LB from a source cell to a target cell:<br>According to operator's policy, or<br>According to some information got in run time. For example:<br>LB would always fail between some particular cells in case of some inappropriate parameters setting. In that situation, the LB function located at eNB may make a decision to prohibit LB between these particular cells and notify this information to the IRPManager.<br>After the CM parameters adjusting, the LB between those cells may be allowed again based on the good values of relative PM counters. | | +| Step 2 (*) (M) | The IRPAgent is instructed by the IRPManager to allow/prohibit LB from the source cell to the target cell. | | +| Step 3 (*) (M) | The LB is allowed / prohibited from the source cell to the target cell by the corresponding eNB(s). | | +| Step 4 (*) (M) | Reporting of the allowing/prohibiting LB operation result to the IRPManager. | | +| Ends when (*) | Ends when all steps identified above are completed or when an exception occurs. | | +| Exceptions | One of the steps identified above fails and retry is unsuccessful. | | +| Post Conditions | The LB is allowed/prohibited from a source cell to a target cell successfully or unsuccessfully. | | +| Traceability (*) | REQ-SO_LB-FUN-3, REQ-SO_LB-FUN-4, REQ-SO_LB-FUN-5 | | + +### 6.4.3 Use case NM centralized Coverage and Capacity Optimization + +| Use Case Stage | Evolution / Specification | <<Uses>><br>Related use | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | Optimize the Coverage and Capacity in the network | | +| Actors and Roles | IRPManager as user and IRPAGENT as client | | +| Telecom resources | The E-UTRAN network including its NM and DM/EM.<br>The CCO function that is located in the NM. | | +| Assumptions | There is no EM centralised CCO function in operation. | | +| Pre-conditions | The network is operational. The CCO function requests the IRPAGENT to subscribe the needed performance measurements via the IRPManager that are not already subscribed. The IRPAGENT initiates the requested performance measurements that are not already active. | | +| Begins when | The operator turns on the CCO function. | | +| Step 1 (M) | The CCO function waits for performance measurements. | | +| Step 2 (M) | The IRPAGENT delivers the performance measurements to the CCO function via the IRPManager. | | +| Step 3 (M) | The CCO function evaluates if there are any potential improvements to be made. If no more detailed information is needed to determine an improvement action, go to step 9. | | +| Step 4 (M) | The CCO function initiates detailed improvement analysis, e.g. MDT measurements, in the area for which a potential improvement has been identified, via the IRPManager to the IRPAGENT. | | +| Step 5 (M) | The IRPAGENT initiates the requested session and transfers the result to the TCE specified by the CCO function. | | +| Step 6 (M) | The network information is transferred to the CCO function that evaluates whether an improvement action can be applied. | | +| Step 7 (M) | The CCO function initiates the IRPManager to instruct the IRPAGENT to apply improvement actions (re-configure some attributes). | | +| Step 8 (M) | The IRPAGENT applies the improvement actions and informs the CCO function via the IRPManager. | | +| Step 9 (M) | The CCO function goes to step 1. | | +| Ends when | Ends when the operator turns off the CCO function. | | +| Exceptions | If no improvement action can be applied and the coverage and capacity situation is very bad (e.g. no coverage on any RAT is detected in an area), the operator is informed and the CCO function is turned off for that area. | | +| Post Conditions | The network is operational. | | +| Traceability | REQ-SO_CC_NM-FUN-1, REQ-SO_CC_NM-FUN-2, REQ-SO_CC_NM-FUN-3, REQ-SO_CC_NM-FUN-4 and REQ-SO_CC_NM-FUN-5. | | + +# 7 Functions and Architecture + +## 7.1 Self-Optimization Logical Architecture + +The lines between the functional blocks do not indicate specific 3GPP interfaces. + +For the abbreviations used, please see the headlines of clause 4.2. + +![Figure 7.1-1 Self-Optimization logical architecture diagram](fc0735d325f0ebd9214171975c68a888_img.jpg) + +The diagram illustrates the Self-Optimization logical architecture. At the top, an 'Actor' block is connected via a double-headed vertical arrow to a green 'SO\_MMF' block. Below 'SO\_MMF' is a thick horizontal black line representing a bus. Below this bus, five yellow blocks are arranged horizontally: 'SO\_MON\_F', 'TG\_F', 'O\_FB\_F', 'SO\_PG\_UF', and 'NRM\_UF'. Each of these five blocks has a double-headed vertical arrow connecting it to the bus above and another double-headed vertical arrow connecting it to a corresponding block in the row below. The bottom row consists of six yellow blocks: 'SO\_AAS\_F', 'LB\_F', 'IC\_F', 'CC\_F', 'RACH\_F', and 'HO\_F'. + +Figure 7.1-1 Self-Optimization logical architecture diagram + +Figure 7.1-1 Self-Optimization logical architecture + +## 7.2 Self-Optimization Reference Model + +The SO\_MMF has a part located in the EM and a part located at the NM. + +For the abbreviations used, please refer to clause 4.2. + +![Figure 7.2-1 Self-Optimization reference model diagram](dfa6249d64e9f63db89f2c5b7bbd01de_img.jpg) + +The diagram illustrates the Self-Optimization reference model. At the top is a green block labeled 'SO\_MMF\_NM (IRPManager)'. Below it is a horizontal red line labeled 'Itf-N'. Below the red line is another green block labeled 'SO\_MMF\_EM (IRPAgent)'. Below 'SO\_MMF\_EM' is a thick horizontal black line representing a bus. Below this bus, five yellow blocks are arranged horizontally: 'SO\_MON\_F', 'TG\_F', 'O\_FB\_F', 'SO\_PG\_UF', and 'NRM\_UF'. Each of these five blocks has a double-headed vertical arrow connecting it to the bus above and another double-headed vertical arrow connecting it to a corresponding block in the row below. The bottom row consists of six yellow blocks: 'SO\_AAS\_F', 'LB\_F', 'IC\_F', 'CC\_F', 'RACH\_F', and 'HO\_F'. + +Figure 7.2-1 Self-Optimization reference model diagram + +Figure 7.2-1 Self-Optimization reference model + +# --- Annex A (informative): Steps for SON self-optimization Technical Specifications + +The TSs for SON self-optimization shall follow the steps below. + +## 1. Goal + +<The concise goal statement for the purpose of this self-optimization> + +## 2. Problem Scenarios + +The problem scenarios need to be optimized under the goal. This part may contain multiple problem scenarios + +<PS 1...> + +<PS 2...> + +## 3. Parameters to be Optimized + +The list of parameters needs to be optimized to resolve the problems under the goal. The parameters listed here are the overall parameters need to be optimized; it does not imply that all of the parameters are required to be open over Itf-N. + +<Parameter 1, 2, 3...> + +## 4. Architecture and Responsibilities + +The suitable architecture to optimize the parameters above, it can be centralized, distributed or hybrid SON architectures. + +And based on the architecture, the clear split of the responsibilities among NM, EM and NE should be stated here. This will result in the work split among 3GPP WGs. + +## 5. Performance Measurements and NRMs + +### Performance measurements: + +List of the performance measurements which are required via Itf-N to recognize the problem scenarios, and to monitor the result of self-optimization, based on the selected architecture and responsibilities. + +This part only includes the descriptions for the performance measurements, and the detailed definitions will be defined in TS 32.425/32.426. + +<Performance measurement 1> + +<Performance measurement 2> + +### NRMs: + +The parameters need to be modeled in NRM, to support the optimizations required over Itf-N according to the selected architecture and split responsibilities. + +<Parameters 1, 2, ...> + +# --- Annex B (informative): General descriptions related to NM centralized CCO high level use cases + +## B.1 General + +Coverage and capacity are two closely related characteristics of a cellular network, which largely determine the network capabilities in terms of providing a certain grade of service for a given number of customers in a given geographical + +area and on a given set of radio spectrum. In order to utilize cell resources in the most efficient way and to serve as many customers as possible with the required level of service, there is a need to configure cell resources according to the actual radio conditions, propagation environment and traffic needs. + +Such an optimization process shall be automated with minimal manual intervention and has to be based upon actual network conditions, i.e. measured data obtained from UEs and from the network. + +Looking for coverage holes or finding capacity improvement possibilities manually is particularly time consuming, costly and requires expert knowledge. Therefore, an automated CCO function can significantly contribute to OPEX reductions. + +The use cases for NM centralized CCO can only work during long optimisation cycles (5 minutes or longer). This means that optimisation in or near real time is excluded. Typically, the optimization cycle for NM centralized CCO is 24 hours. + +NM centralized CCO is divided into 3 stages: + +- 1) Monitoring +- 2) Detailed improvement analysis +- 3) Improvement action + +![Diagram of NM Centralized CCO function stages showing a clockwise cycle of Monitoring, Detailed improvement analysis, and Improvement action.](dfaa8b98082261913dac00eae86b2889_img.jpg) + +``` +graph TD; Monitoring --> Detailed_improvement_analysis[Detailed improvement analysis]; Detailed_improvement_analysis --> Improvement_action[Improvement action]; Improvement_action --> Monitoring; +``` + +The diagram illustrates the NM Centralized CCO function stages as a clockwise cycle. It consists of three light blue arrows forming a circle. The top arrow points from 'Monitoring' (on the left) to 'Detailed improvement analysis' (on the right). The bottom-right arrow points from 'Detailed improvement analysis' to 'Improvement action' (at the bottom). The bottom-left arrow points from 'Improvement action' back to 'Monitoring'. + +Diagram of NM Centralized CCO function stages showing a clockwise cycle of Monitoring, Detailed improvement analysis, and Improvement action. + +**Figure B.1-1: NM Centralized CCO function stages** + +**Monitoring** is constantly active and monitors the whole network all the time to find potential improvements. This is done by using performance monitoring. For the monitoring step to detect improvement possibilities there is no need to continuously report fine granular detailed information, since at this stage it is wanted to detect the existence of the improvement opportunity and not necessarily the exact location and reason of the improvement opportunity. This allows aggregations in PM measurements (e.g. in space and time), which makes the continuous monitoring scalable for the whole network without losing the detection capability. + +**Detailed improvement analysis** may be activated for the area where monitoring has detected an improvement opportunity in order to do a more fine grained assessment of the improvement possibility and its localisation. This is done by using a fine grained detection function/tool, e.g. MDT with periodic measurements. Detailed improvement analysis is optional and only needed if the monitoring stage does not give sufficient information. + +**Improvement action** will determine and apply specific improvement action(s). The action may be to reconfigure some cell parameters, e.g. output power. To reconfigure any attribute, the existing CM operations over Itf-N are reused. When no automated corrective action can be applied, the CCO function may provide information to the operator (for example, a new base station site may be installed in the area where an improvement is needed). + +## B.2 Monitoring of UE distribution + +Figure B.2-1 shows an example of how the UE distribution can be monitored periodically by two-dimensional bins measurements, which are created by $T_{ADV}$ (Timing Advanced) and AOA (Angle Of Arrival) measurements reported by connected mode UE (see clause 10.2 and 10.3 of TS 3GPP TS 36.133 [8]). In figure B.2-1, "D" denotes the distance between the base station antenna and the UE, "C" is the speed of light in air, and " $T_{ADV}$ " represents the $T_{ADV}$ -index multiplied by $T_s$ (the basic time unit). + +![Figure B.2-1: Two-dimensional bin measurements. A polar plot showing UE distribution in a cell. The plot is a hexagon with concentric dashed circles representing distance bins and radial lines representing angle bins. A legend indicates UE counts per bin: 5-10 (grey), 11-20 (green), and 21-30 (blue). A formula D = C x TAdv / 2 is shown. Labels 'N' and 'AOA' are present.](54b5c00e104d6abae06037df2ce1f075_img.jpg) + +For example: + +- 5 – 10 UE (Grey) +- 11 – 20 UE (Green) +- 21 – 30 UE (Blue) + +Formula: $D = C \times T_{Adv} / 2$ + +Figure B.2-1: Two-dimensional bin measurements. A polar plot showing UE distribution in a cell. The plot is a hexagon with concentric dashed circles representing distance bins and radial lines representing angle bins. A legend indicates UE counts per bin: 5-10 (grey), 11-20 (green), and 21-30 (blue). A formula D = C x TAdv / 2 is shown. Labels 'N' and 'AOA' are present. + +**Figure B.2-1 Two-dimensional bin measurements** + +An example of a definition of two-dimensional bin measurements that show the UE distribution in a cell is shown below: + +### Measurement description (example): + +This measurement provides two-dimensional bins to monitor the UE distribution across geographical area (e.g. in a cell). The two-dimensional bins are formed from Timing Advance ( $T_{ADV}$ ) and Angle of Arrival (AOA), + +where $T_{ADV} = 1) N_{TA}$ – for UEs that are uplink timing aligned (TS 36.213 [4]) + +2) 11 bits Timing Advance value – for UEs that are not uplink timing aligned (TS 36.321 [10]) + +AOA (TS 36.133 [8]) = measured on any part of the uplink transmission, such as user data frame or PRACH, or via Sounding Reference Signals. + +The table below illustrates an example implementation with x and y ranges [0..10] and [0..11] respectively. x and y are integers within the implementation specific ranges. + +| | Index y – AOA (Unit Degree °) (ref. TS 36.133 [4] sect 10.2) | | | | | | | | | | | | +|--|--------------------------------------------------------------|---|---|---|---|---|---|---|---|---|----|----| +| | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | + +| <b>Index x – T<sub>ADV</sub><br/>(Unit T<sub>s</sub>)</b><br>(ref. TS 36.133 [4]<br>sect 10.3) | | 0°-<br>30° | 30°<br>-<br>60° | 60°<br>-<br>90° | 90°<br>-<br>120° | 120°<br>-<br>150° | 150°<br>-<br>180° | 180°<br>-<br>210° | 210°<br>-<br>240° | 240°<br>-<br>270° | 270°<br>-<br>300° | 300°<br>-<br>330° | 330°<br>-<br>360° | +|------------------------------------------------------------------------------------------------|---------------------------|------------|-----------------|-----------------|------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------| +| 0 | $0 \leq T_{ADV} < 48$ | | | | | | | | | | | | | +| 1 | $48 \leq T_{ADV} < 96$ | | | | | | | | | | | | | +| 2 | $96 \leq T_{ADV} < 144$ | | | | | | | | | | | | | +| 3 | $144 \leq T_{ADV} < 192$ | | | | | | | | | | | | | +| 4 | $192 \leq T_{ADV} < 288$ | | | | | | | | | | | | | +| 5 | $288 \leq T_{ADV} < 384$ | | | | | | | | | | | | | +| 6 | $384 \leq T_{ADV} < 576$ | | | | | | | | | | | | | +| 7 | $576 \leq T_{ADV} < 768$ | | | | | | | | | | | | | +| 8 | $768 \leq T_{ADV} < 960$ | | | | | | | | | | | | | +| 9 | $960 \leq T_{ADV} < 2048$ | | | | | | | | | | | | | +| 10 | $2048 \leq T_{ADV}$ | | | | | | | | | | | | | + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|-----------------------------------------------------------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | 11.0.0 | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | <b>12.0.0</b> | +| 2014-12 | SA#66 | SP-140801 | 003 | 1 | Add NM centralized Coverage and Capacity Optimization (CCO) logical description | 12.0.0 | <b>13.0.0</b> | +| | | | 004 | - | Add references and abbreviations related to Coverage and Capacity Optimization (CCO) | | | +| | | | 005 | - | Improve and correct business level requirements for Coverage and Capacity Optimization (CCO) | | | +| | | | 007 | 1 | Add specification level requirements for NM centralized Coverage and Capacity Optimization (CCO) | | | +| | | | 008 | 1 | Add specification level use case for NM centralized Coverage and Capacity Optimization (CCO) | | | +| 2015-03 | SA#67 | SP-150063 | 006 | 2 | Add NM centralized Coverage and Capacity Optimization (CCO) high level use cases and general descriptions | 13.0.0 | <b>13.1.0</b> | +| 2016-03 | SA#71 | SP-160031 | 010 | 1 | Correction of Business level requirements for Handover Parameter Optimization | 13.1.0 | <b>13.2.0</b> | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-01 | SA#78 | SP-170968 | 0014 | 1 | B | Add SON for AAS management requirements | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28628/raw.md b/marked/Rel-16/28_series/28628/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6bfc2118201c81ad1c7f7a5a58bcd0057701b76a --- /dev/null +++ b/marked/Rel-16/28_series/28628/raw.md @@ -0,0 +1,1912 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 SON Policy and optimization function definitions ..... | 9 | +| 4.1 Monitoring and management operations for self-optimization..... | 9 | +| 4.1.1 Monitoring and management function ..... | 9 | +| 4.1.1.1 Usage of Itf-N ..... | 9 | +| 4.2 Load balancing optimization function..... | 9 | +| 4.2.1 Objective and targets ..... | 9 | +| 4.2.2 Parameters To Be Optimized..... | 10 | +| 4.2.3 Optimization method ..... | 10 | +| 4.2.3.1 Problem detection ..... | 10 | +| 4.2.3.2 Problem solution ..... | 11 | +| 4.2.4 Architecture ..... | 11 | +| 4.2.4.1 Definition of logical functions ..... | 11 | +| 4.2.4.2 Location of logical functions ..... | 11 | +| 4.2.5 PM ..... | 11 | +| 4.3 Handover (HO) parameter optimization function ..... | 12 | +| 4.3.1 Objective and targets ..... | 12 | +| 4.3.2 Parameters To Be Optimized..... | 12 | +| 4.3.3 Optimization method ..... | 13 | +| 4.3.3.1 Problem detection ..... | 13 | +| 4.3.3.2 Problem solution ..... | 13 | +| 4.3.4 Architecture ..... | 13 | +| 4.3.4.1 Definition of logical functions ..... | 13 | +| 4.3.4.2 Location of logical functions ..... | 14 | +| 4.3.5 PM ..... | 14 | +| 4.4 Interference control function..... | 15 | +| 4.5 Capacity and coverage optimization function..... | 15 | +| 4.5.4 Architecture ..... | 16 | +| 4.5.4.1 Definition of logical functions ..... | 16 | +| 4.5.4.2 Location of logical functions ..... | 16 | +| 4.5.6 MDT measurements ..... | 20 | +| 4.6 RACH Optimization Function ..... | 20 | +| 4.6.1 Objective and targets ..... | 20 | +| 4.6.2 Parameters to be optimized ..... | 20 | +| 4.6.3 Optimization method ..... | 21 | +| 4.6.3.1 Problem detection ..... | 21 | +| 4.6.3.2 Problem solution ..... | 21 | +| 4.6.4 PM ..... | 21 | +| 4.7 SON coordination..... | 21 | +| 4.7.1 Introduction ..... | 21 | +| 4.7.2 Coordination between SON functions below Itf-N and non-SON CM operations over itf-N ..... | 22 | +| 4.7.2.1 Description ..... | 22 | +| 4.7.2.2 Prevention..... | 22 | +| 4.7.2.3 Resolution..... | 22 | +| 4.7.3 Coordination between different SON functions ..... | 23 | +| 4.7.3.0 General..... | 23 | +| 4.7.3.1 Coordination between Cell Outage Compensation and Energy Saving Management ..... | 23 | +| 4.7.3.1.1 Description ..... | 23 | +| 4.7.3.1.2 Prevention..... | 23 | + +| | | | +|-----------|--------------------------------------------------------------------------------------------------------------------|----| +| 4.7.3.1.3 | Resolution..... | 23 | +| 4.7.3.2 | Coordination among Cell Outage Compensation, Capacity and Coverage Optimization, and Energy Saving Management..... | 23 | +| 4.7.3.2.1 | Description ..... | 23 | +| 4.7.3.2.2 | Prevention..... | 24 | +| 4.7.3.2.3 | Resolution..... | 24 | +| 4.7.3.3 | Coordination between Cell Outage Compensation and Automatic Neighbour Relation ..... | 24 | +| 4.7.3.3.1 | Description ..... | 24 | +| 4.7.3.3.2 | Prevention..... | 25 | +| 4.7.3.3.3 | Resolution..... | 25 | +| 4.7.3.4 | Coordination between HandOver parameter Optimization and Load Balancing Optimization..... | 25 | +| 4.7.3.4.1 | Description ..... | 25 | +| 4.7.3.4.2 | Prevention..... | 25 | +| 4.7.3.4.3 | Resolution..... | 25 | +| 4.7.4 | General SON coordination solutions..... | 25 | +| 4.7.4.1 | Overview..... | 25 | +| 4.7.4.2 | Conflict prevention ..... | 26 | +| 4.7.4.3 | Conflict resolution ..... | 27 | +| 4.8 | SON for AAS management..... | 28 | +| 4.8.1 | Objective and targets ..... | 28 | +| 4.8.2 | Parameters to be optimized ..... | 28 | +| 4.8.3 | Optimization method ..... | 28 | +| 4.8.3.1 | Problem detection ..... | 28 | +| 4.8.3.2 | Problem solution ..... | 28 | +| 4.8.4 | Architecture ..... | 28 | +| 4.8.4.1 | Definition of logical functions ..... | 28 | +| 4.8.4.2 | Location of logical functions ..... | 29 | +| 4.8.5 | PM ..... | 29 | +| 5 | Model ..... | 31 | +| 5.1 | Imported information entities and local labels..... | 31 | +| 5.2 | Class diagrams..... | 31 | +| 5.2.1 | Relationships ..... | 31 | +| 5.2.2 | Inheritance ..... | 37 | +| 5.3 | Class definitions ..... | 39 | +| 5.3.1 | SONTargets ..... | 39 | +| 5.3.1.1 | Definition ..... | 39 | +| 5.3.1.2 | Attributes ..... | 39 | +| 5.3.1.3 | Attribute constraints..... | 40 | +| 5.3.1.4 | Notifications..... | 40 | +| 5.3.2 | SONControl ..... | 40 | +| 5.3.2.1 | Definition ..... | 40 | +| 5.3.2.2 | Attributes ..... | 40 | +| 5.3.2.3 | Attribute constraints..... | 41 | +| 5.3.2.4 | Notifications..... | 41 | +| 5.3.3 | ES Policies ..... | 41 | +| 5.3.3.1 | Definition ..... | 41 | +| 5.3.3.2 | Attributes ..... | 41 | +| 5.3.3.3 | Attribute constraints..... | 41 | +| 5.3.3.4 | Notifications..... | 41 | +| 5.3.4 | EUtranCellSON..... | 42 | +| 5.3.4.1 | Definition ..... | 42 | +| 5.3.4.2 | Attributes ..... | 42 | +| 5.3.4.3 | Attribute constraints..... | 42 | +| 5.3.4.4 | Notifications..... | 42 | +| 5.3.5 | EnergySavingProperties ..... | 42 | +| 5.3.5.1 | Definition ..... | 42 | +| 5.3.5.2 | Attributes ..... | 42 | +| 5.3.5.3 | Attribute constraints..... | 43 | +| 5.3.5.4 | Notifications..... | 43 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------|-----------| +| 5.3.6 | IOC SONFuncInfo..... | 43 | +| 5.3.6.1 | Definition ..... | 43 | +| 5.3.6.2 | Attributes ..... | 43 | +| 5.3.6.3 | Attribute constraints..... | 43 | +| 5.3.6.4 | Notifications..... | 43 | +| 5.3.7 | IOC SONCoordinationPolicies ..... | 43 | +| 5.3.7.1 | Definition ..... | 43 | +| 5.3.7.2 | Attributes ..... | 44 | +| 5.3.7.3 | Attribute constraints..... | 44 | +| 5.3.7.4 | Notifications..... | 44 | +| 5.3.8 | interRatEsPolicies..... | 44 | +| 5.3.8.1 | Definition ..... | 44 | +| 5.3.8.2 | Attributes ..... | 44 | +| 5.3.8.3 | Attribute constraints..... | 44 | +| 5.3.8.4 | Notifications..... | 45 | +| 5.4 | Attribute definitions ..... | 46 | +| 5.4.1 | Attribute properties..... | 46 | +| 5.4.2 | Constraints ..... | 57 | +| 5.5 | Common notifications ..... | 57 | +| 5.5.2 | Configuration notifications..... | 57 | +| <b>Annex A (informative):</b> | <b>Target Achievement Evaluation .....</b> | <b>59</b> | +| <b>Annex B (informative):</b> | <b>Examples of how to use general SON coordination solutions .....</b> | <b>60</b> | +| B.1 | Coordination of COC and CCO using priority of SON functions ..... | 60 | +| B.2 | Coordination of COC, CCO and ES using priority of SON functions ..... | 60 | +| B.3 | Coordination of COC, CCO and ES based on the cell state ..... | 61 | +| <b>Annex C (informative):</b> | <b>State diagram for Distributed and EM-centralized Energy Saving Management .....</b> | <b>61</b> | +| Annex D (informative): | Change history..... | 64 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- 28.627: Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- 28.628: Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)** +- 28.629: Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Self Organizing Networks (SON) Policy Network Resource Model (NRM) IRP, through which an IRP Agent can communicate management information to one or several IRP Managers concerning SON policies. The SON policy NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the protocol neutral SON policy NRM IRP: Information Service (IS). + +In order to access the information defined by this NRM, an Interface IRP such as the "Basic CM IRP" is needed (3GPP TS 32.602 [11]). However, which Interface IRP is applicable is outside the scope of the present document. + +The present document also contains stage 2 descriptions for those functionalities for the Self-Optimization OAM, SON coordination and Energy Saving Management. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [4] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [5] 3GPP TS 28.627: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP): Requirements". +- [6] 3GPP TS 36.331: "Technical Specification Group Radio Access Network; Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". +- [7] 3GPP TS 36.423: "Technical Specification Group Radio Access Network; Evolved Universal Terrestrial Radio Access Network (E-UTRAN); X2 Application Protocol (X2AP)". +- [8] 3GPP TS 32.425: "Technical Specification Group Services and System Aspects; Telecommunication management; Performance Management (PM); Performance measurements; Evolved Universal Terrestrial Radio Access Network (E-UTRAN)". +- [9] 3GPP TS 28.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)". +- [10] 3GPP TS 28.658: "Telecommunication management; Configuration Management (CM); Evolved Universal Terrestrial Radio Access Network (E-UTRAN) network resources Integration Reference Point (IRP): Network Resource Model (NRM)". +- [11] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP) Information Service (IS)". + +- [12] 3GPP TS 36.413: "Technical Specification Group Radio Access Network; Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (SIAP)". +- [13] 3GPP TS 36.314: "Evolved Universal Terrestrial Radio Access (E-UTRA); Layer 2 - Measurements". +- [14] 3GPP TS 36.300: " Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2 ". +- [15] 3GPP TS 37.320: "Universal Terrestrial Radio Access (UTRA) and Evolved Universal Terrestrial Radio Access (E-UTRA); Radio measurement collection for Minimization of Drive Tests (MDT); Overall description; Stage 2". +- [16] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [17] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [18] Void . +- [19] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [20] 3GPP TS 48.008: "Mobile Switching Centre-Base Station System (MSC-BSS) interface; Layer 3 specification". +- [21] 3GPP TS 32.405: "Telecommunication management; Performance Management (PM); Performance measurements; Universal Terrestrial Radio Access Network (UTRAN)". +- [22] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [23] 3GPP TS 32.423: "Telecommunication management; Subscriber and equipment trace; Trace data definition and management". +- [24] 3GPP TS 36.133: "Evolved Universal Terrestrial Radio Access (E-UTRA); Requirements for support of radio resource management". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TS 32.101 [1], TS 32.102 [2], TS 32.150 [3] and TR 21.905 [4] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TS 28.627 [5], TS 32.101 [1], TS 32.102 [2] and TR 21.905 [4], in that order. + +**Target:** See 3GPP TS 28.627 [5]. + +**Trigger condition:** See 3GPP TS 28.627 [5]. + +**Hand-Over parameter Optimisation:** See clause 4.3 of this document and Mobility Robustness Optimisation (MRO) are synonyms (see TS 36.300 [14]). + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [4], TS 28.627 [5] 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 [4] and TS 28.627 [5]. + +| | | +|-----|------------------------------| +| AAS | Active Antenna System | +| AoA | Angle of Arrival | +| CAC | Composite Available Capacity | + +| | | +|-------------|----------------------------------------------------| +| CCO | Capacity and Coverage Optimization | +| CDF | Cumulative Distribution Function | +| COC | Cell Outage Compensation | +| CQI | Channel Quality Indicator | +| EM | Element Manager | +| eNodeB, eNB | evolved NodeB | +| ESM | Energy Saving Management | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| GNSS | Global Navigation Satellite System | +| HO | Handover | +| HOO | HandOver parameter Optimization | +| ICIC | Inter Cell Interference Coordination | +| IOC | Information Object Class | +| LB | Load Balancing | +| LBO | Load Balancing Optimization | +| MDT | Minimization of Drive Tests | +| MRO | Mobility Robustness Optimisation | +| NM | Network Manager | +| NRM | Network Resource Model | +| OAM | Operation Administration Maintenance | +| PM | Performance Measurement | +| RACH | Random Access Channel | +| RLF | Radio Link Failure | +| RO | RACH Optimization | +| RSCP | Received Signal Code Power | +| RSRP | Reference Signal Received Power | +| RSRQ | Reference Signal Received Quality | +| RTWP | Received Total Wideband Power | +| SON | Self Organizing Networks | +| TA | Timing Advance | +| UE | User Equipment | + +# 4 SON Policy and optimization function definitions + +## 4.1 Monitoring and management operations for self-optimization + +### 4.1.1 Monitoring and management function + +#### 4.1.1.1 Usage of Itf-N + +For specifically defined Itf-N NRM Interface see clause 5. + +## 4.2 Load balancing optimization function + +### 4.2.1 Objective and targets + +The objective of LB Optimization is to cope with undesired traffic load distribution and to minimize the number of handovers and redirections needed to achieve the load balancing. One of the following targets or the combination of the following targets shall be used. The specific target value or values shall be configured by operators. Operators should assign weights for targets being used. + +Targets drawn from the following table can be configured for LBO: + +| Target Name | Definition | Legal Values | +|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| RRC connection establishments failure rate related to load | <p>The number of Failed RRC connection establishments related to load/ The total number of Attempted RRC connection establishments.</p> <p>The target is met if the actual rate is smaller than the target value.</p> | Integer [0..100] in unit percentage | +| E-RAB setup failure rate related to load | <p>The number of E-RAB setup failure related to load/ The total number of attempted E-RAB setup</p> <p>For E-RAB setup failure related to load, the causes “Reduce load in serving cell” and “Radio resources not available” defined in TS 36.413 [12] could be used.</p> <p>The target is met if the actual rate is smaller than the target value.</p> | Integer [0..100] in unit percentage | +| RRC Connection Abnormal Release Rate Related to Load | <p>The number of abnormal RRC connection release related to load/ The total number of RRC connection release.</p> <p>The target is met if the actual rate is smaller than the target value.</p> | Integer [0..100] in unit percentage | +| E-RAB Abnormal Release Rate Related to Load | <p>The number of E-RAB abnormal release related to load/ The total number of E-RAB release</p> <p>For E-RAB setup failure related to load, the causes “Reduce load in serving cell” and “Radio resources not available” defined in TS 36.413 [12] could be used.</p> <p>The target is met if the actual rate is smaller than the target value.</p> | Integer [0..100] in unit percentage | +| Rate of failures related to handover | <p>(the number of failure events related to handover) / (the total number of handover events)</p> <p>The target is met if the actual rate is smaller than the target value.</p> | Integer [0..100] in unit percentage | + +For the following targets out of the above table, the target values depend on the composite available capacity range in the cell and are defined separately for uplink and downlink. For these tuples can be configured, indicating the capacity ranges together with the target value valid in that range. + +RRC connection establishments failure rate related to load, + +E-RAB setup failure rate related to load, + +RRC Connection Abnormal Release Rate Related to Load, + +E-RAB Abnormal Release Rate Related to Load + +For the following targets shall be identical with the corresponding targets defined in Handover Optimization. + +Rate of failures related to handover + +### 4.2.2 Parameters To Be Optimized + +To reach load optimization target, LBO may optimize some mobility settings (HO and/or idle mobility configuration) defined in TS 36.331 [6]. + +### 4.2.3 Optimization method + +#### 4.2.3.1 Problem detection + +The problem detection is out of scope of this specification. + +#### 4.2.3.2 Problem solution + +The problem solution is out of scope of this specification. + +### 4.2.4 Architecture + +#### 4.2.4.1 Definition of logical functions + +**LB Monitor Function:** This function is used for monitoring the load balance optimization (e.g. Monitoring related performance counters or alarms). + +**LB Policy control function:** This function is used for configuring the load balance optimization policies. + +#### 4.2.4.2 Location of logical functions + +![Diagram showing the location of logical functions in a network architecture. At the top, NM (IRPManager) contains LB Policy Control Function and LB Monitor Function. Below it, DM contains LB Policy Control Function, LB Monitor Function, and EM. At the bottom, three eNB units are shown, each containing an LB decision function. The first eNB is connected to DM. The second eNB is connected to the first eNB via an X2 interface. The third eNB is connected to the second eNB via an X2 interface and also contains an EM function. A dashed line labeled Itf-N separates NM from the rest of the architecture.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +The diagram illustrates the distribution of logical functions across network elements. The NM (IRPManager) at the top contains the LB Policy Control Function and LB Monitor Function. Below it, the DM contains the LB Policy Control Function, LB Monitor Function, and EM. At the bottom, three eNB units are shown. The first eNB contains the LB decision function and is connected to the DM. The second eNB also contains the LB decision function and is connected to the first eNB via an X2 interface. The third eNB contains the LB decision function and an EM function, and is connected to the second eNB via an X2 interface. A dashed line labeled Itf-N separates the NM from the DM and eNBs. + +Diagram showing the location of logical functions in a network architecture. At the top, NM (IRPManager) contains LB Policy Control Function and LB Monitor Function. Below it, DM contains LB Policy Control Function, LB Monitor Function, and EM. At the bottom, three eNB units are shown, each containing an LB decision function. The first eNB is connected to DM. The second eNB is connected to the first eNB via an X2 interface. The third eNB is connected to the second eNB via an X2 interface and also contains an EM function. A dashed line labeled Itf-N separates NM from the rest of the architecture. + +For Load Balancing, the SON LB decision algorithm is located in eNB. The detailed SON functionalities in eNB are out of scope of this specification. + +### 4.2.5 PM + +IRPManager may collect Load balancing related performance measurements. Performance Measurements related with Load balancing are captured in the table below: + +| Performance measurement name | Description | Related targets | +|--------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| +| The number of Failed RRC connection establishments related to load | Refer to 3GPP TS 32.425 [8]<br>Failed RRC connection establishments | RR connection establishments failure rate related to load | +| The total number of Attempted RRC connection establishments | Refer to 3GPP TS 32.425 [8]<br>Attempted RRC connection establishments | RR connection establishments failure rate related to load | +| The number of E-RAB setup failure related to load | Refer to 3GPP TS 32.425 [8]<br>Number of initial SAE Bearers failed to setup | E-RAB setup failure rate related to load | +| The total number of attempted E-RAB setup | Refer to 3GPP TS 32.425 [8]<br>Number of initial SAE Bearers attempted to setup | E-RAB setup failure rate related to load | +| The number of abnormal RRC connection release related to load | Number of UE CONTEXT Release Request initiated by eNodeB | RR Connection Abnormal Release Rate Related to Load | +| The total number of RRC connection release | Number of Successful UE Context Release | RR Connection Abnormal Release Rate Related to Load | +| The number of E-RAB abnormal release related to load | Refer to 3GPP TS 32.425 [8]<br>Number of SAE Bearers requested to release initiated by eNodeB per cause | E-RAB Abnormal Release Rate Related to Load | +| The total number of E-RAB release | Refer to 3GPP TS 32.425 [8]<br>Number of SAE Bearers successfully released | E-RAB Abnormal Release Rate Related to Load | +| the number of failure events related to handover | Refer to 4.3.5 | Rate of failures related to handover | +| the total number of handover events | Refer to 4.3.5 | Rate of failures related to handover | + +NOTE: The monitoring of performance measurements will make use of existing PM IRP. + +## 4.3 Handover (HO) parameter optimization function + +### 4.3.1 Objective and targets + +For intra-LTE, one of the following targets or the combination of the following targets shall be used. The specific target value shall be configured by operators. Operators should assign weights for targets being used. + +| Target Name | Definition | Legal Values | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| Rate of failures related to handover | $\frac{\text{(the number of failure events related to handover)}}{\text{(the total number of handover events)}}$ <p>The target is met if the actual rate is smaller than the target value.</p> | Integer [0..100] in unit percentage | + +The objective of minimizing the number of unnecessary handovers shall always be pursued in case the other target/s configured by the operator is/are achieved. This objective may not need configuration of a target value. + +### 4.3.2 Parameters To Be Optimized + +The tables below summarise the handover parameters in TS 36.331 [6]. + +**Table 4.3.2-1. Handover parameters that may be optimized for intra-frequency and inter-frequency handovers** + +| Event | Summary | Tunable parameters | +|-------|------------------------------------------------------------------------------------|-----------------------------------------------------| +| A3 | Neighbour becomes offset better than serving | Ofn, Ofs, Ocn, Ocs, Hys, Off, timeToTrigger | +| A4 | Neighbour becomes better than threshold | Ofn, Ocn, Hys, Thresh, Off, timeToTrigger | +| A5 | Serving becomes worse than threshold1 and neighbour becomes better than threshold2 | Ofn, Ocn, Hys, Thresh1, Thresh2, Off, timeToTrigger | + +**Table 4.3.2-2. Handover parameters that may be optimised for inter RAT handover** + +| Event | Summary | Tunable parameters | +|-------|----------------------------------------------------------------------------------------------|-------------------------------------------| +| B1 | Inter RAT Neighbour becomes better than threshold | Ofn, Hys, Thresh, timeToTrigger | +| B2 | Serving becomes worse than threshold1 and inter RAT neighbour becomes better than threshold2 | Ofn, Hys, Thresh1, Thresh2, timeToTrigger | + +### 4.3.3 Optimization method + +#### 4.3.3.1 Problem detection + +HO Parameter Optimization Function shall focus on detecting the problem scenarios described in TS 28.627 [5]; namely: too early handovers, too late handovers and inefficient use of NW resources due to HOs. For more information about these scenarios see TS 28.627 [5] section 6.1.3. + +The following inputs may be used for the identification of the problem scenarios: + +- Event capture and analysis +- UE measurements +- Performance measurements + +In event capture and analysis, the eNodeB exploits event information associated with a UE context, such as evidence of previous handovers (UE History, see TS 36.423 [7]) and HO failure details (such as in which cell the handover failed and where the UE re-established the connection). + +UE measurements are sent within UE measurement reports and they may indicate whether HOs are too early or too late. + +HO-related performance measurements (PMs) collected at the source and / or target eNB can be useful in detecting HO-related issues on the cell level. Since the impact of incorrect HO parameter setting will also be on the cell-level, PMs can provide useful information that can be used to detect and resolve HO-related issues due to incorrect parameter settings. + +#### 4.3.3.2 Problem solution + +HO Parameter Optimization Function will aim at optimizing the HO parameters listed in Section 4.3.2 in such way to mitigate the problem scenarios discussed in Section 4.3.3.1. The optimization algorithms will not be specified. The exact set of HO parameters that may be adjusted by the algorithms is dictated by the choice of triggered HO measurements made by the RRM entity in an eNodeB. + +### 4.3.4 Architecture + +#### 4.3.4.1 Definition of logical functions + +**HO Parameter Optimization Monitor Function:** This function is used for monitoring the handover parameter optimization (e.g. monitoring related performance counters or alarms). + +**HO Parameter Optimization Policy Control Function:** This function is used for configuring the handover parameter optimization policies. + +#### 4.3.4.2 Location of logical functions + +For HandOver (HO) parameter optimization there are several options for the location of the SON algorithm: + +1. The SON algorithm is located in the eNB(s). +2. The SON algorithm is located in the EM, the parameter changes are executed in the eNBs. + +An example for the first option is shown in figure 4.3.4.2: + +![Diagram illustrating the location of logical functions for SON algorithm. The diagram shows a hierarchy: NM (Network Management) at the top, connected via a dashed line labeled 'Itf-N' to DM (Domain Management). DM contains HO Parameter Optimization Policy Control Function, HO Parameter Optimization Monitor Function, and an EM (Element Management) block. DM is connected to three eNB (evolved NodeB) units. Each eNB contains an HO Parameter Optimization algorithm. The eNBs are connected to each other via X2 interfaces. The third eNB also contains an EM block.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +The diagram illustrates the network management hierarchy for SON algorithm placement. At the top is the Network Management (NM) block, which contains two logical functions: 'HO Parameter Optimization Policy Control Function' and 'HO Parameter Optimization Monitor Function'. NM is connected via a dashed line labeled 'Itf-N' to the Domain Management (DM) block. DM contains 'HO Parameter Optimization Policy Control Function', 'HO Parameter Optimization Monitor Function', and an Element Management (EM) block. DM is connected to three evolved NodeB (eNB) units. Each eNB contains an 'HO Parameter Optimization algorithm'. The eNBs are interconnected via X2 interfaces. The third eNB also contains an EM block. + +Diagram illustrating the location of logical functions for SON algorithm. The diagram shows a hierarchy: NM (Network Management) at the top, connected via a dashed line labeled 'Itf-N' to DM (Domain Management). DM contains HO Parameter Optimization Policy Control Function, HO Parameter Optimization Monitor Function, and an EM (Element Management) block. DM is connected to three eNB (evolved NodeB) units. Each eNB contains an HO Parameter Optimization algorithm. The eNBs are connected to each other via X2 interfaces. The third eNB also contains an EM block. + +**Figure 4.3.4.2: Example when the SON algorithm is located in the eNB(s)** + +The detailed SON functionalities in eNB are out of scope of this specification. + +### 4.3.5 PM + +IRPManager shall collect HO-related performance measurements from the source and / or target eNB which can be useful in detecting HO-related issues on the cell level. The following input can be used for the identification of the problem scenarios specified: + +The number of RLF event happened within an interval after handover success. + +The number of unnecessary handovers to another RAT without RLF. + +Performance Measurements related to handover failure are captured in the table below. + +The Performance Measurements are for outgoing handovers. Further, they should be available on a cell relation basis. + +| Performance measurement name | Description | Related targets | +|------------------------------------------|------------------------------------------------------------|--------------------------------------| +| Number of handover events | Includes successful handovers plus all identified failures | Rate of failures related to handover | +| Number of HO failures | All failure cases | Rate of failures related to handover | +| Number of too early HO failures | Too early HO failure cases | Rate of failures related to handover | +| Number of too late HO failures | Too late HO failure cases | Rate of failures related to handover | +| Number of HO failures to wrong cell | HO failures to wrong cell | Rate of failures related to handover | +| Number of unnecessary HOs to another RAT | Unnecessary HOs to each of different RATs | | + +NOTE: The monitoring of performance measurements will make use of existing PM IRP. + +## 4.4 Interference control function + +## 4.5 Capacity and coverage optimization function + +### 4.5.1 Objective and targets + +The objective of capacity and coverage optimization is to provide optimal coverage and capacity for the radio network. A tradeoff between capacity and coverage needs to be considered. + +The detailed target(s) FFS. + +### 4.5.2 Parameters to be optimized + +To reach capacity and coverage optimization targets, the following parameters may be optimized: + +- Downlink transmit power +- Antenna tilt +- Antenna azimuth + +### 4.5.3 Optimization method + +#### 4.5.3.1 Problem detection + +The main symptoms of capacity and coverage optimization problems (see TS 37.320 [15]) are: + +**Coverage hole:** A coverage hole is an area where the pilot signal strength is below a threshold which is required by a UE to access the network, or the SINRs of both serving and neighbor cells is below a level needed to maintain the basic service. Coverage holes are usually caused by physical obstructions such as new buildings, hills, or by unsuitable antenna parameters, or just inadequate RF planning. UEs around coverage hole will suffer from call drop and radio link failure. Typical phenomenon of coverage hole is either HO failure happens frequently and cannot be optimized by HO parameter optimization or call drop happens frequently and cannot be rescued by RRC re-establishment. + +**Weak coverage:** Weak coverage occurs when the pilot signal strength or the SNR (or SINR) of serving cell is below the level needed to maintain a planned performance requirement (e.g. cell edge bit-rate). + +**Pilot pollution:** In areas where coverage of different cells overlap a lot, interference levels are high, power levels are high, energy consumption is high and cell performance may be low. Typically in this situation UEs may experience high SNR to more than one cell and high interference levels. + +**Overshoot coverage:** Overshoot occurs when coverage of a cell reaches far beyond what is planned. It can occur as an “island” of coverage in the interior of another cell, which may not be a direct neighbor. Reasons for overshoot may be reflections in buildings or across open water, lakes etc. UEs in this area may suffer call drops or high interference. + +**DL and UL channel coverage mismatch:** DL channel coverage is larger than UL channel coverage is one typical scenario of DL and UL channel coverage mismatch. The UE will suffer UL problems when it moves into the mismatch area. + +In a realistic network, these symptoms may be tolerated to a certain level. These symptoms may indicate a real problem when combined with other factors such as frequency of symptoms, duration of symptoms, or affected population. + +The following inputs may be used for the identification of the problem scenarios: + +- UE measurements +- Performance measurements +- Alarms, other monitoring information e.g. trace data + +UE measurements are sent within UE measurement reports and they may indicate the capacity and coverage problem. + +Capacity and coverage related performance measurements collected at the source and / or target eNB can be useful in detecting capacity and coverage related issues on the cell level. Minimizing Driver Test (MDT) or HO-related performance measurements may be used also in detecting capacity and coverage related issues on the cell level. + +Alarms, other monitoring information e.g. trace data can be correlated to get an unambiguous indication of capacity and coverage problem. + +#### 4.5.3.2 Problem solution + +Capacity and coverage optimization function will aim at optimizing the parameters listed in Section 4.5.2 in such way to mitigate the problem scenarios discussed in Section 4.5.3.1. + +### 4.5.4 Architecture + +#### 4.5.4.1 Definition of logical functions + +**CCO Monitor Function:** This function is used for monitoring the capacity and coverage optimization (e.g. monitoring related performance counters, UE measurements or alarms). + +**CCO Policy Control Function:** This function is used for configuring the capacity and coverage optimization policies. + +#### 4.5.4.2 Location of logical functions + +For capacity and coverage optimization (CCO), there are several options for the location of the centralized CCO SON algorithm: + +- 1) The CCO SON algorithm is located in the DM. The capacity and coverage optimization decision is made by the DM centralized CCO algorithm. +- 2) The CCO SON algorithm is located in the NM. The capacity and coverage optimization decision is made by the NM centralized CCO algorithm. + +An example for the first option is shown in figure 4.5.4.2-1: + +![Diagram showing network architecture with NM, DM, and eNB components. NM contains CCO Policy Control and Monitor functions. DM contains CCO Policy Control, Monitor, EM, and CCO Algorithm. Three eNBs are shown at the bottom, connected by X2 interfaces. The first eNB is connected to DM. The second eNB is connected to DM and the first eNB. The third eNB is connected to DM and the second eNB, and contains its own EM function. A dashed line labeled Itf-N separates NM and DM.](8307f6b04df072c9332f9987e034272c_img.jpg) + +The diagram illustrates a network architecture for CCO SON. At the top, the Network Management (NM) block contains two yellow rectangles: 'CCO Policy Control Function' and 'CCO Monitor Function'. Below NM is a dashed horizontal line labeled 'Itf-N'. Below the interface is the Domain Management (DM) block, which contains four components: 'CCO Policy Control Function', 'CCO Monitor Function', a light blue rectangle 'EM', and a yellow oval 'CCO Algorithm'. At the bottom, three teal rectangles represent eNBs. The first eNB on the left is connected to the DM block. The second eNB in the middle is connected to the DM block and the first eNB via a double-headed arrow labeled 'X2'. The third eNB on the right is connected to the DM block and the second eNB via a double-headed arrow labeled 'X2'. This third eNB also contains a light blue rectangle labeled 'EM'. + +Diagram showing network architecture with NM, DM, and eNB components. NM contains CCO Policy Control and Monitor functions. DM contains CCO Policy Control, Monitor, EM, and CCO Algorithm. Three eNBs are shown at the bottom, connected by X2 interfaces. The first eNB is connected to DM. The second eNB is connected to DM and the first eNB. The third eNB is connected to DM and the second eNB, and contains its own EM function. A dashed line labeled Itf-N separates NM and DM. + +**Figure 4.5.4.2-1: Example when the CCO SON algorithm is located in DM** + +An example for the second option is shown in figure 4.5.4.2-2: + +![Diagram showing SON functions (CCO, COC, ES, HOO, LBO) and Network parameters and/or elements (Antenna Para, Cell switch on/off, Downlink TX Power, Handover Parameters). Includes a legend for RF related and RRM related items.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +The diagram illustrates the relationship between SON functions and network parameters. It is organized into two rows of boxes. The top row, labeled 'SON functions', contains five boxes: CCO, COC, and ES are solid orange boxes; HOO and LBO are dashed blue boxes. The bottom row, labeled 'Network parameters and/or elements', contains four boxes: 'Antenna Para (Tilt, Azimuth)', 'Cell switch on/off', and 'Downlink TX Power' are solid orange boxes; 'Handover Parameters' is a dashed blue box. Lines connect the top boxes to the bottom boxes: CCO, COC, and ES each have lines to the three orange boxes; HOO has a line to the blue box; LBO has a line to the blue box. Below the diagram is a 'Legend:' with two boxes: a solid orange box labeled 'RF related' and a dashed blue box labeled 'RRM related'. + +Diagram showing SON functions (CCO, COC, ES, HOO, LBO) and Network parameters and/or elements (Antenna Para, Cell switch on/off, Downlink TX Power, Handover Parameters). Includes a legend for RF related and RRM related items. + +**Figure 4.5.4.2-2: Example when the CCO SON algorithm is located in NM** + +The detailed CCO SON algorithm in OAM (NM centralized or EM centralized) is out of scope of this specification. + +### 4.5.5 PM + +The IRPAgent shall support a capability allowing the IRPManager to collect CCO related performance measurements to know the situation of coverage or interference which may then trigger corresponding optimization procedures. Performance measurements related with CCO are captured in the tables 4.5.5-1 (E-UTRAN) and 4.5.5-2 (UTRAN) below: + +**Table 4.5.5-1: E-UTRAN performance measurements for CCO** + +| <b>Performance measurement name</b> | <b>Description</b> | <b>Comment</b> | +|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| RSRP level | Refer to 3GPP TS 32.425 [8]<br>RSRP related measurements. | | +| RSRQ level | Refer to 3GPP TS 32.425 [8]<br>RSRQ related measurements. | | +| RACH usage | Refer to 3GPP TS 32.425 [8]<br>- Mean number of RACH preambles received.<br>- Distribution of RACH preambles sent.<br>- Distribution of RACH access delay.<br>- Percentage of contentious RACH attempts.<br>- Number of UE RACH reports received.<br>- Percentage of time when all dedicated RACH preambles are used. | | +| Power utilization | Refer to 3GPP TS 32.425 [8]<br>- Maximum carrier transmit power.<br>- Mean carrier transmit power. | | +| CQI distribution | Refer to 3GPP TS 32.425 [8]<br>- Wideband CQI distribution<br>- Average sub-band CQI. | | +| UE power headroom | Refer to 3GPP TS 32.425 [8]<br>- UE power headroom related measurements. | | +| RRC connection related | Refer to 3GPP TS 32.425 [8]<br>- Failed RRC connection establishments.<br>- Attempted RRC connection establishments.<br>- Number of UE CONTEXT Release Request initiated by eNodeB.<br>- Successful UE CONTEXT Release. | | +| E-RAB related | Refer to 3GPP TS 32.425 [8]<br>-Number of initial SAE Bearers failed to setup.<br>-Number of initial SAE Bearers attempted to setup.<br>-Number of SAE Bearers requested to release initiated by eNodeB per cause.<br>-Number of SAE Bearers successfully released. | | +| PRB Usage | Refer to 3GPP TS 32.425 [8]<br>- DL Total PRB Usage.<br>- UL Total PRB Usage.<br>- DL PRB full utilisation.<br>- UL PRB full utilisation. | | + +**Table 4.5.5-2: UTRAN performance measurements for CCO** + +| <b>Performance measurement name</b> | <b>Description</b> | <b>Comment</b> | +|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| Signal strength and quality | Refer to 3GPP TS 32.405 [21]<br>- P-CCPCH RSCP.<br>- UTRAN RSCP. | | +| Received total wideband power | Refer to 3GPP TS 32.405 [21]<br>- Mean Received Total Wideband Power of an UTRAN Cell.<br>- Maximum Received Total Wideband Power of an UTRAN Cell. | | + +### 4.5.6 MDT measurements + +The IRP Agent shall support a capability allowing the IRP Manager to collect CCO related MDT measurements to know the situation of coverage or interference which may then trigger corresponding optimization procedures. MDT measurements related with CCO are captured in the tables 4.5.6-1 (E-UTRAN) and 4.5.6-2 (UTRAN). + +**Table 4.5.6-1: E-UTRAN MDT measurements for CCO** + +| MDT measurement name | Description | Comment | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| RLF | - Radio Link Failure events (refer to TS 36.331 [6], TS 32.423 [23]). | | +| Location | - CellId (refer to TS 36.331 [6], TS 32.422 [22], TS 37.320 [15], TS 32.423 [23]).<br>- GNSS (refer to TS 36.331 [6], TS 32.422 [22], TS 37.320 [15], TS 32.423 [23])<br>- TA/AoA (refer to TS 36.133 [24], TS 32.422 [22], TS 37.320 [15], TS 32.423 [23]). | | +| UL Interference power | - M3: Received Interference Power measurement by eNB (Refer to 3GPP TS 32.422 [22], TS 37.320 [15]). | | +| RSRP and RSRQ level | - M1: RSRP and RSRQ measurement by UE (Refer to TS 32.422 [22]). | | + +**Table 4.5.6-2: UTRAN MDT measurements for CCO** + +| MDT measurement name | Description | Comment | +|-------------------------------|---------------------------------------------------------------------------------|---------| +| Location | - CellId (refer to TS 32.422 [22], TS 37.320 [15]). | | +| Received total wideband power | - M5: Received total wideband power (RTWP) by Node B (refer to TS 32.422 [22]). | | + +## 4.6 RACH Optimization Function + +### 4.6.1 Objective and targets + +The objective of RACH Optimization is to automatically set several parameters related to the performance of RACH. One of the following targets shall be used. The specific target value shall be configured by operators. + +| Target Name | Definition | Legal Values | +|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Access Probability, <i>AP</i> | The probability that the UE has access after a certain random access attempt number.<br><br>The target is met if the actual access probability is higher than the target probability value. | CDF of access attempts. See section 5.5.1 | +| Access Delay Probability, <i>ADP</i> | The probability distribution of Access Delay expected to be experienced by UEs accessing the RACH Channel.<br><br>The target is met if the actual access probability is higher than the target probability value. | CDF of delays. See section 5.5.1 | + +### 4.6.2 Parameters to be optimized + +To achieve RACH optimization target, RACH optimization function may optimize several parameters defined in TS 36.300 [14] section 22.4.3. + +### 4.6.3 Optimization method + +#### 4.6.3.1 Problem detection + +The problem detection is out of scope of this specification since the RACH optimization entity resides in the eNB. + +#### 4.6.3.2 Problem solution + +The problem solution is out of scope of this specification since the RACH optimization entity resides in the eNB. + +### 4.6.4 PM + +The IRP Agent shall support a capability allowing the IRP Manager to collect RACH optimization related performance measurements. Performance measurements related with RACH optimization are captured in the table below: + +| Performance measurement name | Description | Related targets | +|-------------------------------------|-------------------------------------------------------------------------------------|-------------------------------| +| Distribution of RACH preambles sent | Refer to 3GPP TS 32.425 [8]<br>Cumulative Distribution of RACH preambles sent by UE | Access Probability, AP | +| Distribution of RACH access delay | Refer to 3GPP TS 32.425 [8]<br>Cumulative Distribution of RACH Access Delay | Access Delay Probability, ADP | + +## 4.7 SON coordination + +### 4.7.1 Introduction + +There may be conflicts or dependencies between SON functions; SON coordination means preventing or resolving conflicts or negative influences between SON functions to make SON functions comply with operator's policy. + +As the example shown in figure 4.7.1.1, there is mesh relationship between SON functions and network parameters (or network elements) in which conflicts or negative influences may happen if no SON coordination. + +![Diagram illustrating the mesh relationship between SON functions and network parameters. The diagram shows five SON functions (CCO, COC, ES, HOO, LBO) and four network parameters (Antenna Para (Tilt, Azimuth), Cell switch on/off, Downlink TX Power, Handover Parameters). Solid lines connect CCO, COC, and ES to the first three parameters. Dashed lines connect HOO and LBO to the fourth parameter. A legend indicates that solid boxes are RF related and dashed boxes are RRM related.](a7835229df7a34816e1d35b5bbbc8c9e_img.jpg) + +The diagram illustrates the mesh relationship between SON functions and network parameters. The SON functions are CCO, COC, ES, HOO, and LBO. The network parameters are Antenna Para (Tilt, Azimuth), Cell switch on/off, Downlink TX Power, and Handover Parameters. The legend indicates that RF related elements are shown with solid boxes and lines, while RRM related elements are shown with dashed boxes and lines. + +``` + +graph TD + subgraph SON_functions + CCO[CCO] + COC[COC] + ES[ES] + HOO[HOO] + LBO[LBO] + end + subgraph Network_parameters + AP[Antenna Para (Tilt, Azimuth)] + CS[Cell switch on/off] + DTP[Downlink TX Power] + HP[Handover Parameters] + end + CCO --- AP + CCO --- CS + CCO --- DTP + COC --- AP + COC --- CS + COC --- DTP + ES --- AP + ES --- CS + ES --- DTP + HOO -.- HP + LBO -.- HP + style CCO stroke-width:2px + style COC stroke-width:2px + style ES stroke-width:2px + style HOO stroke-dasharray: 5 5,stroke-width:2px + style LBO stroke-dasharray: 5 5,stroke-width:2px + style AP stroke-width:2px + style CS stroke-width:2px + style DTP stroke-width:2px + style HP stroke-dasharray: 5 5,stroke-width:2px + +``` + +Diagram illustrating the mesh relationship between SON functions and network parameters. The diagram shows five SON functions (CCO, COC, ES, HOO, LBO) and four network parameters (Antenna Para (Tilt, Azimuth), Cell switch on/off, Downlink TX Power, Handover Parameters). Solid lines connect CCO, COC, and ES to the first three parameters. Dashed lines connect HOO and LBO to the fourth parameter. A legend indicates that solid boxes are RF related and dashed boxes are RRM related. + +Figure 4.7.1.1: Mesh relationship between SON functions and network parameters (or network elements) + +### 4.7.2 Coordination between SON functions below Itf-N and non-SON CM operations over itf-N + +#### 4.7.2.1 Description + +Conflict may arise between non-SON CM operation via Itf-N and the SON functions (in particularly self-optimization function) below Itf-N in the following scenario. + +The network parameters can be changed by the non-SON CM operations via Itf-N, meanwhile, the SON functions below Itf-N may also require changing the parameters. If these parameters are some (same or associated) parameters of some (same or associated) nodes which will be changed by the non-SON CM operations and the SON functions below Itf-N, conflict arises. (Conflict see clause 4 of 28.627[5]) + +For example, the non-SON CM operation via Itf-N may try to reduce the CIO (cell individual offset) parameter, it makes the HO trigger between cells (e.g., HO from cell A to cell B) become more difficult. But in the meanwhile, the SON function MRO may try to increase the CIO parameter, it makes the HO easier. In this case, if the conflict is not coordinated, the parameter may be modified twice. Then the failed rate related with handover may rise or ping-pong handover may arise between the two cells. + +In case the SON function below Itf-N and non-SON CM operation via Itf-N has conflict, the SON function below Itf-N shall take into account and re-evaluate, if applicable, any non-SON CM operation changes via Itf-N. + +As showing in the following example, At Time T3, after Non-SON operation has finished the modification, SON function below Itf-N shall take the non-SON CM operation changes into account for further SON analysis. + +![Timeline diagram illustrating the coordination between non-SON CM operations and SON functions. A horizontal axis represents 'Time'. At time T1, an oval labeled 'SON functions below Itf-N' has an upward arrow to the timeline, labeled 'Modify'. At time T2, an oval labeled 'Non-SON operation over Itf-N' has a downward arrow to the timeline, labeled 'Modify'. Between T1 and T2, a blue box contains the text '(same or associated) parameters of (same or associated) nodes'. At time T3, another oval labeled 'SON functions below Itf-N' has an upward arrow to the timeline, labeled 'Reanalysis'.](04dc3838022e96d8d5548bb1b777b38c_img.jpg) + +Timeline diagram illustrating the coordination between non-SON CM operations and SON functions. A horizontal axis represents 'Time'. At time T1, an oval labeled 'SON functions below Itf-N' has an upward arrow to the timeline, labeled 'Modify'. At time T2, an oval labeled 'Non-SON operation over Itf-N' has a downward arrow to the timeline, labeled 'Modify'. Between T1 and T2, a blue box contains the text '(same or associated) parameters of (same or associated) nodes'. At time T3, another oval labeled 'SON functions below Itf-N' has an upward arrow to the timeline, labeled 'Reanalysis'. + +#### 4.7.2.2 Prevention + +In a real network, it is possible that non-SON CM operations via Itf-N and several SON functions below Itf-N are running at the same time, and they may try to change the same or associated parameters during a short time period. So coordination is needed to prevent this kind of conflicts. + +#### 4.7.2.3 Resolution + +Refer to common coordination solutions part. + +### 4.7.3 Coordination between different SON functions + +#### 4.7.3.0 General + +NOTE: The coordination between different SON functions should be decided case by case. + +#### 4.7.3.1 Coordination between Cell Outage Compensation and Energy Saving Management + +##### 4.7.3.1.1 Description + +A conflict could arise between energy saving and cell outage compensation in the following scenario. + +One or more candidate cells are configured to possibly take coverage of the original cell. The original cell is in energySaving state or is about to enter energySaving state. One or more candidate cells go into outage with the consequence that coverage of the original cell can not be provided any more. + +##### 4.7.3.1.2 Prevention + +Prevention is hardly possible, except making the cells as outage proof as possible. But cell outages can happen even to the most stable cell in a network. + +##### 4.7.3.1.3 Resolution + +If the original cell is in energySaving state, it shall leave energySaving state. + +If the original cell is about to enter energySaving state, it shall not go into energySaving state until candidate cell outage is recovered and candidate cell is able to provide the coverage. + +The original cell may go into the energySaving state after the candidate cell outage is recovered and coverage of the original cell can be taken over by candidate cell again. + +#### 4.7.3.2 Coordination among Cell Outage Compensation, Capacity and Coverage Optimization, and Energy Saving Management + +##### 4.7.3.2.1 Description + +Capacity and Coverage Optimization (CCO), Cell Outage Compensation (COC) and Energy Saving Management (ESM) may require changes to the coverage and/or capacity of one or more cells during the same time period, which could lead to the following issue: + +![Diagram illustrating a typical scenario for the coordination among COC, CCO, and ESM. It shows a hexagonal grid of cells. Cell 1 (Cell11) is the central cell, colored light green. Cell 2 (Cell2) is to its right, colored red. Cell 3 (Cell3) is above Cell 1, colored blue. Cell 4 (Cell4) is to the right of Cell 2, colored white. The surrounding cells are also white. The diagram shows Cell 1 in outage (light green), Cell 2 as a compensation candidate (red), Cell 3 as another compensation candidate (blue), and Cell 4 as a regular cell (white).](0a33d798beb830894643ca8e71b7ab26_img.jpg) + +Diagram illustrating a typical scenario for the coordination among COC, CCO, and ESM. It shows a hexagonal grid of cells. Cell 1 (Cell11) is the central cell, colored light green. Cell 2 (Cell2) is to its right, colored red. Cell 3 (Cell3) is above Cell 1, colored blue. Cell 4 (Cell4) is to the right of Cell 2, colored white. The surrounding cells are also white. The diagram shows Cell 1 in outage (light green), Cell 2 as a compensation candidate (red), Cell 3 as another compensation candidate (blue), and Cell 4 as a regular cell (white). + +**Figure 4.7.3.2 Coordination among COC, CCO, and ESM** + +Figure 4.7.3.2 is a typical scenario for the coordination among COC, CCO and ESM. + +Cell 1 is detected in outage, COC will try to compensate the outage Cell 1 by reconfiguring the RF configuration of some compensation candidate cells, e.g., TX power, antenna tilt and antenna azimuth of Cell 2 and Cell 3. + +Before the outage Cell 1 is compensated, CCO may detect the degrading of coverage related KPI (e.g., success rate of RRC connection establishments, cell throughput) of Cell 1 and its neighbour cells (Cell 2 and other blue cells) and make a conclusion that there is a coverage problem in this KPI degraded area. + +Meanwhile, ESM is operating on Cell 2 to compensate the coverage of its neighboring cell (Cell 4) which is going into energySaving state. + +From the time point at which the outage Cell 1 is detected until Cell 1 has been compensated by Cell 2 and Cell 3, during this period, if there is no coordination among COC, CCO and ESM, there will be possibly different settings for adjusting TX power, antenna tilt and antenna azimuth of Cell 2 for COC, CCO or ESM purposes respectively. It's most likely that the adjustment from COC, ESM and optimization from CCO may conflict in the common affected outage compensation candidate cell(s) (Cell 2 in the above example). + +It is also possible that ESM is operating on Cell 2 to compensate the coverage of Cell 4 that is in energySaving state, while COC detects that Cell 1 has outage, and requests Cell 2 to compensate the coverage of Cell 1. COC and ESM need to be coordinated to determine if this request can be accepted. + +After the outage cell comes back to normal, the COC exits the coordination scenario, while CCO and ESM continue to work and need to be well coordinated. For example, CCO may adjust the antenna tilt of Cell 2 in a downward direction to improve the coverage signal quality, but ESM may adjust the antenna tilt of Cell 2 in an opposite direction to enlarge its coverage area for purpose of ES compensation. Therefore, coordination should be continued between CCO and ESM to resolve the possible configuration conflict on Cell 2. + +Other conflict scenarios could be: + +Cell A is compensating to provide coverage for Cell B that is in energySaving state. COC detects that Cell A has outage. Since Cell A is not able to provide the coverage for Cell B any more, Cell B needs to be covered by another cell, or to deactivate energy saving. + +Cell A is in energySaving state. COC detects Cell B has outage, and requests Cell A to compensate the coverage of Cell B. Cell A may need to terminate energy saving in order to compensate the coverage of Cell B. + +Cell A which is compensating Cell B in outage shall not go into energySaving state as long as its compensation for Cell B is needed. + +##### 4.7.3.2.2 Prevention + +Prevention is hardly possible. + +##### 4.7.3.2.3 Resolution + +Refer to clause 4.7.4 General SON coordination solutions. + +#### 4.7.3.3 Coordination between Cell Outage Compensation and Automatic Neighbour Relation + +##### 4.7.3.3.1 Description + +In case one cell is detected in outage, COC will try to compensate the outage cell by reconfiguring the RF configuration of some compensation candidate cells. As a result of this, there will be new NRs (neighbour relations) which reflect the new topology relations. + +For a stable network, ANR could be deactivated for the purpose of system resource saving. If ANR is deactivated, the new NRs cannot be captured in NRT by ANR. Network performance, for example, handover will be impacted negatively by the NRT which lacks of the new NRs. + +##### 4.7.3.3.2 Prevention + +Prevention is hardly possible, except making the cells as outage proof as possible. But cell outages can happen even to the most stable cell in a network. + +##### 4.7.3.3.3 Resolution + +The ANR function should monitor if a cell outage or cell outage compensation takes place within its area. If this happens, then the ANR function should check the NRs of the affected cells (for example the outage cell and its neighbours and neighbours' neighbours). In case the ANR function in the the affected area is deactivated, the possible NRs change of the affected cells should be taken as a factor to reactivate the ANR function. + +#### 4.7.3.4 Coordination between HandOver parameter Optimization and Load Balancing Optimization + +##### 4.7.3.4.1 Description + +HOO function and LBO function both optimize network performance by adjusting handover parameters such as CIO, Hysteresis, TTT, etc. Conflicts may happen when HOO function and LBO function are changing the same or associated handover parameters in opposite direction or towards the same direction but on different scales. + +For example, HOO function may adjust handover parameters (e.g. *decrease* CIO of source cell A to target cell B) to minimize the number of too early handovers from cell A to cell B whilst LBO function may adjust handover parameters (e.g. *increase* the CIO of source cell A to target cell B) to make the handover from cell A to cell B more easier in case the load of cell B is much less than cell A. + +##### 4.7.3.4.2 Prevention + +Prevention is hardly possible unless switch off HOO function or LBO function. However, disabling the complete HOO function or LBO function cannot fulfil the requirement that both handover performance and load performance need to be improved at the same time. + +##### 4.7.3.4.3 Resolution + +For the coordination between HOO and LBO, IRPManager should assign priorities for HOO function and LBO function or weights for targets of HOO function and LBO function according to operator's policy. + +The policy should cover different scenarios well: + +- Policy may assign higher priority for HOO function than LBO function or higher weight for target of HOO function than targets of LBO function when resolving MRO issues (HO too early/too late/to wrong cell) is the main objective of network optimization, e.g. in handover optimization scenario for better coverage. +- Policy may assign lower priority for HOO function than LBO function or lower weight for target of HOO function than targets of LBO function when enhancing load performance is the main objective of network optimization, e.g. in load optimization scenario for better capacity. + +Concrete way of using priority or weights of targets, refers to clause 4.7.4 General SON coordination solutions. + +### 4.7.4 General SON coordination solutions + +#### 4.7.4.1 Overview + +As described in TS 28.627 [5], multiple SON functions may have conflicting demands on network resources. This situation is considered as “SON functions in conflict” and requires conflict prevention or resolution. A SON Coordination Function will be responsible for preventing or resolving conflicts. + +Conflict needs to be detected when there is “SON functions in conflict”. Policies can be preset by operator to SON Coordination Function to avoid conflict on certain associated resources (network elements and/or parameters) among SON functions. + +Conflict prevention is to take some advanced methods to prevent the occurrence of conflict. However, no matter what implementation is chosen, it is impossible to guarantee that 100% of conflicts will be prevented, so conflict detection and resolution are needed. Conflict detection should be taken firstly as the pre-condition of conflict resolution. + +The SON Coordination Function is a logical function, which means it can be implemented as a separate function entity or as part of SON function. + +When the SON Coordination Function is implemented as a separate function entity, all the SON functions send the necessary information to the SON Coordination Function, the SON Coordination Function coordinate these SON functions as a centralized control point. This centralized coordination approach fulfills the requirements of SON coordination in a large area scope, for example, the coordination between NM centralized SON functions and distributed SON functions. + +In some other situations, coordination is only needed in a smaller area, for example, the coordination between distributed SON functions inside one domain. Then the SON Coordination Function can be implemented as part of each SON function. The necessary coordination information can be inter-exchanged between each SON functions to achieve coordination as well. + +The SON Coordination Function may reside above or below Itf-N. Figure 4.7.4.1 shows an example of a SON Coordination Function, which is a separate function entity, above Itf-N. + +![Diagram illustrating the SON Coordination entity located in the Network Management (NM) domain. The NM domain contains the SON Coordination Function (green square) and SON_X (orange circle). The NM domain is connected via a dashed line labeled 'Itf-N' to the Element Management (EM) domain, which contains SON_Y (purple circle). The EM domain is connected to three eNB domains: eNB (SON_A) (blue circle), eNB (SON_B) (red circle), and eNB (SON_C) (green circle). The eNB (SON_C) domain also contains an EM domain (yellow rectangle).](20136850feb70fd71c7d41cdae203ebb_img.jpg) + +``` + +graph TD + NM[NM] --- ItfN[Itf-N] + ItfN --- EM[EM] + EM --- eNB_A[eNB SON_A] + EM --- eNB_B[eNB SON_B] + EM --- eNB_C[eNB SON_C] + NM --- SON_Coord[SON Coordination Function] + NM --- SON_X[SON_X] + EM --- SON_Y[SON_Y] + eNB_A --- SON_A[SON_A] + eNB_B --- SON_B[SON_B] + eNB_C --- SON_C[SON_C] + eNB_C --- EM_C[EM] + +``` + +Diagram illustrating the SON Coordination entity located in the Network Management (NM) domain. The NM domain contains the SON Coordination Function (green square) and SON\_X (orange circle). The NM domain is connected via a dashed line labeled 'Itf-N' to the Element Management (EM) domain, which contains SON\_Y (purple circle). The EM domain is connected to three eNB domains: eNB (SON\_A) (blue circle), eNB (SON\_B) (red circle), and eNB (SON\_C) (green circle). The eNB (SON\_C) domain also contains an EM domain (yellow rectangle). + +**Figure 4.7.4.1: Example of SON Coordination entity located in NM** + +The SON Coordination Function may be responsible for conflict prevention, conflict resolution, or both in parallel. + +#### 4.7.4.2 Conflict prevention + +To prevent conflicts between the SON functions, the SON functions may ask the SON Coordination function for permission before changing some specific configuration parameters. The SON Coordination Function should check the SON coordination interdependency policy between this requesting SON function and other SON function(s) upon receiving the permission request from the SON function. SON coordination interdependency policy which is pre-configured can help the SON Coordination Function to find which SON function(s) possibly conflict with this requesting SON function. + +As a basis for decisions, the SON Coordination Function will typically use one or some of the following inputs received from the SON function(s) + +- Which SON functions are modifying configuration parameters (including information about vendor, release etc.) +- Configuration parameters intended to be changed and/or their existing and proposed new values + +- The time duration how long the configuration parameter should not be interfered with (“impact time”) +- The state of SON functions +- The SON targets which are the justification for the configuration change. +- Possible impact of a parameter change on other objects (“impact area”) +- The state of certain managed objects +- Possible impact of the parameter change on Key Performance Indicators +- Priority of SON functions, which can be used to determine the execution order of requests from different SON functions in case of conflicts +- SON coordination policies + +The SON Coordination Function sends the decision back to the requesting SON function; the decision may be confirmation or suspension or rejection of the SON executing request, or other actions like configuration of specific parameters with specific value. + +After SON function executes action, the SON Coordination Function is then informed about the result (successful/unsuccessful, parameters changes) of the executed SON action. + +The SON Coordination Function may prevent parameter changes by one or more SON functions for a specified time period after the same parameter has been changed by another SON function. + +The SON Coordination Function may inform a SON Function of a managed object state change which may impact calculation of KPIs. + +Detailed description of how to use general SON coordination solutions are in Annex B. + +#### 4.7.4.3 Conflict resolution + +The SON Coordination Function should detect conflicts and attempt to resolve the conflicts. + +To detect conflicts, the SON Coordination Function will typically analyse one or some of the following types of data + +- Key Performance Indicators which indicate if SON functions are meeting their targets or improving network performance +- Measurements which indicate if SON functions are meeting their targets or improving network performance +- Unacceptable oscillations in configuration parameters + +To resolve conflicts, the SON Coordination Function will typically use one or some of following methods + +- Enabling/disabling/suspending certain SON functions +- Stopping/suspending/modifying certain SON actions +- Modifying certain configuration parameters + +## 4.8 SON for AAS management + +### 4.8.1 Objective and targets + +The objective of SON for AAS management is to perform AAS operations (i.e. Cell Splitting, Cell Merging, Cell Shaping) in automated manner, and the new split/merged cells or shaped cells can be configured and optimized automatically with no or minimum service interrupt. + +One of the following targets or the combination of the following targets shall be used. The specific target value or values shall be configured by operators. Operators should assign weights for targets being used. + +**Table 4.8.1-1. Targets related to SON for AAS management** + +| Target Name | Definition | Legal Values | +|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| PDCP data volume load rate | (DL cell PDCP SDU Data Volume + UL cell PDCP SDU Data Volume) / nominal capacity of PDCP data volume<br><br>The target is met if the actual rate is inside the target value range. | Integer [0..100] in unit of percentage | +| IP throughput load rate | (IP Throughput in DL + IP Throughput in UL) / nominal capacity of IP Throughput<br><br>The target is met if the actual rate is inside the target value range | Integer [0..100] in unit of percentage | +| Active UE amount load rate | (Average number of active UEs on the DL + Average number of active UEs on the UL) / nominal capacity of Active UE amount<br><br>The target is met if the actual rate is inside the target value range | Integer [0..100] in unit of percentage | +| Rate of failures related to handover | (the number of failure events related to handover) / (the total number of handover events)<br><br>The target is met if the actual rate is smaller than the target value. | Integer [0..100] in unit of percentage | + +### 4.8.2 Parameters to be optimized + +To reach AAS optimization targets, the following parameters may be considered in SON for AAS algorithm: + +- Downlink transmit power +- Antenna downlink tilt and/or beam width +- Reference signal power + +### 4.8.3 Optimization method + +#### 4.8.3.1 Problem detection + +The problem detection is out of scope of this specification. + +#### 4.8.3.2 Problem solution + +The problem solution is out of scope of this specification. + +### 4.8.4 Architecture + +#### 4.8.4.1 Definition of logical functions + +**AAS Monitor Function:** This function is used for monitoring the AAS optimization (e.g. monitoring related performance counters or alarms). + +**AAS Policy Control Function:** This function is used for configuring the AAS optimization policies. + +#### 4.8.4.2 Location of logical functions + +For AAS, there are several options for the location of the SON for AAS algorithm: + +- 1) The SON for AAS algorithm is located in the eNB(s). +- 2) The SON for AAS algorithm is located in the EM/DM level, the AAS optimization decision is made by the EM/DM centralized SON for AAS algorithm. +- 3) The SON for AAS algorithm is located in the NM level, the AAS optimization decision is made by the NM centralized SON for AAS algorithm. + +An example for the first option is shown in figure 4.8.4.2-1: + +![Diagram illustrating the SON for AAS algorithm architecture. At the top, the NM (Network Management) block contains 'AAS Policy Control Function' and 'AAS Monitor Function'. Below it, separated by a dashed line labeled 'Itf-N', is the DM block, which also contains 'AAS Policy Control Function' and 'AAS Monitor Function', plus an 'EM' (Element Management) block. The DM block is connected to three eNB (evolved NodeB) blocks. Each eNB block contains a 'SON for AAS algorithm' oval. The first eNB is connected to the second, and the second to the third, via 'X2' interfaces. The third eNB also contains an 'EM' block. Solid lines connect the NM block to the DM block and to the third eNB block. Dashed lines connect the DM block to the first and second eNB blocks.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +Diagram illustrating the SON for AAS algorithm architecture. At the top, the NM (Network Management) block contains 'AAS Policy Control Function' and 'AAS Monitor Function'. Below it, separated by a dashed line labeled 'Itf-N', is the DM block, which also contains 'AAS Policy Control Function' and 'AAS Monitor Function', plus an 'EM' (Element Management) block. The DM block is connected to three eNB (evolved NodeB) blocks. Each eNB block contains a 'SON for AAS algorithm' oval. The first eNB is connected to the second, and the second to the third, via 'X2' interfaces. The third eNB also contains an 'EM' block. Solid lines connect the NM block to the DM block and to the third eNB block. Dashed lines connect the DM block to the first and second eNB blocks. + +**Figure 4.8.4.2-1: Example when the SON for AAS algorithm is located in the eNB(s)** + +The detailed SON functionalities in eNB are out of scope of this specification. + +### 4.8.5 PM + +The IRP Agent shall support a capability allowing the IRP Manager to collect AAS related performance measurements to know the situation of coverage or performance, which may then trigger relevant OAM coordination operations, or corresponding AAS operations (i.e. Cell Splitting, Cell Merging, Cell Shaping) if NM centralized SON for AAS option is used. Performance measurements related with AAS are captured in the table below: + +**Table 4.8.5-1. Performance measurements related to SON for AAS management** + +| <b>Performance measurement name</b> | <b>Description</b> | <b>Related targets</b> | +|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| DL cell PDCP SDU Data Volume | Refer to 3GPP TS 32.425 [8]<br>Data volume in the DL delivered from PDCP layer to RLC layer | PDCP data volume load rate | +| UL cell PDCP SDU Data Volume | Refer to 3GPP TS 32.425 [8]<br>Data volume in the UL delivered from PDCP layer to RLC layer | PDCP data volume load rate | +| IP Throughput in DL | Refer to 3GPP TS 32.425 [8]<br>IP throughput in downlink | IP Throughput load rate | +| IP Throughput in UL | Refer to 3GPP TS 32.425 [8]<br>IP throughput in uplink | IP Throughput load rate | +| Average number of active UEs on the DL | Refer to 3GPP TS 32.425 [8]<br>average number of UEs that have DTCH data queued on the downlink | Active UE amount load rate | +| Average number of active UEs on the UL | Refer to 3GPP TS 32.425 [8]<br>average number of UEs that have DTCH data queued on the uplink | Active UE amount load rate | +| Attempted outgoing handovers per handover cause | Refer to 3GPP TS 32.425 [8]<br>number of attempted outgoing handovers per handover cause and LTE target cell specific. | Rate of failures related to handover | +| Successful outgoing handovers per handover cause | Refer to 3GPP TS 32.425 [8]<br>number of successful outgoing handovers per handover cause and LTE target cell specific | Rate of failures related to handover | +| Attempted outgoing intra-eNB/RN handovers per handover cause | Refer to 3GPP TS 32.425 [8]<br>number of attempted outgoing intra-eNB/RN handovers per handover cause | Rate of failures related to handover | +| Successful outgoing intra-eNB/RN handovers per handover cause | Refer to 3GPP TS 32.425 [8]<br>number of successful outgoing intra-eNB/RN handovers per handover cause | Rate of failures related to handover | +| Attempted outgoing inter-eNB handover preparation | Refer to 3GPP TS 32.425 [8]<br>number of attempted outgoing inter-eNB handover preparations | Rate of failures related to handover | +| Attempted outgoing inter-eNB handover executions per handover cause | Refer to 3GPP TS 32.425 [8]<br>number of attempted outgoing inter-eNB handovers per handover cause | Rate of failures related to handover | +| Successful outgoing inter-eNB handover executions per handover cause | Refer to 3GPP TS 32.425 [8]<br>number of successful outgoing inter-eNB handovers per handover cause | Rate of failures related to handover | + +# 5 Model + +## 5.1 Imported information entities and local labels + +| Label reference | Local label | +|---------------------------------------------|-------------------| +| 3GPP TS 28.622 [9], IOC, Top | Top | +| 3GPP TS 28.622 [9], IOC, SubNetwork | SubNetwork | +| 3GPP TS 28.658 [10], IOC, ENBFunction | ENBFunction | +| 3GPP TS 28.658 [10], IOC, EUtranRelation | EUtranRelation | +| 3GPP TS 28.658 [10], IOC, EUtranGenericCell | EUtranGenericCell | + +## 5.2 Class diagrams + +### 5.2.1 Relationships + +This subclause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This subclause provides the overview of the relationships of relevant classes in UML. Subsequent subclauses provide more detailed specification of various aspects of these classes. + +![UML Class diagram showing relationships between SONControl, SubNetwork, ManagedElement, ENBFunction, EUtranGenericCell, and SONTarget classes.](5456ef9dc49ffc9cbb93cf1dd8052884_img.jpg) + +``` + +classDiagram + class SONControl + class SubNetwork { + <<InformationObjectClass>> + (from 28.622) + } + class ManagedElement { + <<InformationObjectClass>> + (from 28.622) + } + class ENBFunction { + <<InformationObjectClass>> + (from 28.658) + } + class EUtranGenericCell { + <<InformationObjectClass>> + (from 28.658) + } + class SONTarget1 { + <<InformationObjectClass>> + SONTarget + (from 28.628) + } + class SONTarget2 { + <<InformationObjectClass>> + SONTarget + (from 28.628) + } + class SONTarget3 { + <<InformationObjectClass>> + SONTarget + (from 28.628) + } + + SONControl --> SubNetwork : 1 *-- 0..1 : <<names>> + SONControl --> ENBFunction : 1 *-- 0..1 : <<names>> + SubNetwork --> SONTarget1 : 1 *-- 0..1 : <<names>> + SubNetwork --> ManagedElement : 1 *-- * : <<names>> + ManagedElement --> ENBFunction : 1 *-- * : <<names>> + ENBFunction --> SONTarget2 : 1 *-- 0..1 : <<names>> + ENBFunction --> EUtranGenericCell : 1 *-- * : <<names>> + EUtranGenericCell --> SONTarget3 : 1 *-- 0..1 : <<names>> + + note for SONControl "{XOR}" + +``` + +The diagram illustrates the relationships between several Information Object Classes (IOCs). At the top, a class labeled `SONControl` has two associations, each marked with a multiplicity of 1 at the `SONControl` end and 0..1 at the other end, with the role name `<<names>>`. These associations lead to `SubNetwork` (from 28.622) and `ENBFunction` (from 28.658). A yellow note box containing `{XOR}` is positioned between these two associations. `SubNetwork` has an association with `SONTarget` (from 28.628) with a multiplicity of 1 at the `SubNetwork` end and 0..1 at the `SONTarget` end, role name `<<names>>`. `SubNetwork` also has a composition relationship with `ManagedElement` (from 28.622) with a multiplicity of 1 at the `SubNetwork` end and \* at the `ManagedElement` end, role name `<<names>>`. `ManagedElement` has a composition relationship with `ENBFunction` (from 28.658) with a multiplicity of 1 at the `ManagedElement` end and \* at the `ENBFunction` end, role name `<<names>>`. `ENBFunction` has an association with `SONTarget` (from 28.628) with a multiplicity of 1 at the `ENBFunction` end and 0..1 at the `SONTarget` end, role name `<<names>>`. Finally, `ENBFunction` has a composition relationship with `EUtranGenericCell` (from 28.658) with a multiplicity of 1 at the `ENBFunction` end and \* at the `EUtranGenericCell` end, role name `<<names>>`. `EUtranGenericCell` has an association with `SONTarget` (from 28.628) with a multiplicity of 1 at the `EUtranGenericCell` end and 0..1 at the `SONTarget` end, role name `<<names>>`. + +UML Class diagram showing relationships between SONControl, SubNetwork, ManagedElement, ENBFunction, EUtranGenericCell, and SONTarget classes. + +NOTE 1: IOC `SONControl` shall be instantiated whenever one or more IOC `SONTargets` are instantiated. + +Figure 5.2.1-1: Cell view of SON Policy NRM + +![UML Class Diagram showing containment relationships for ES Policies NRM IOCs. The diagram includes four main classes: SubNetwork (from 28.622), ManagedElement (from 28.622), ENBFunction (from 28.658), and EUtranGenericCell (from 28.658). SubNetwork contains ManagedElement (1 to *), which contains ENBFunction (1 to *), which contains EUtranGenericCell (1 to *). Each of these four classes also has a containment relationship with an ESPolicies class (1 to 0..1).](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +classDiagram + class SubNetwork["«InformationObjectClass» SubNetwork (from 28.622)"] + class ManagedElement["«InformationObjectClass» ManagedElement (from 28.622)"] + class ENBFunction["«InformationObjectClass» ENBFunction (from 28.658)"] + class EUtranGenericCell["«InformationObjectClass» EUtranGenericCell (from 28.658)"] + class ESPolicies1["«InformationObjectClass» ESPolicies"] + class ESPolicies2["«InformationObjectClass» ESPolicies"] + class ESPolicies3["«InformationObjectClass» ESPolicies"] + + SubNetwork "1" *-- "*" ManagedElement : «names» + ManagedElement "1" *-- "*" ENBFunction : «names» + ENBFunction "1" *-- "*" EUtranGenericCell : «names» + SubNetwork "1" *-- "0..1" ESPolicies1 : «names» + ENBFunction "1" *-- "0..1" ESPolicies2 : «names» + EUtranGenericCell "1" *-- "0..1" ESPolicies3 : «names» + +``` + +UML Class Diagram showing containment relationships for ES Policies NRM IOCs. The diagram includes four main classes: SubNetwork (from 28.622), ManagedElement (from 28.622), ENBFunction (from 28.658), and EUtranGenericCell (from 28.658). SubNetwork contains ManagedElement (1 to \*), which contains ENBFunction (1 to \*), which contains EUtranGenericCell (1 to \*). Each of these four classes also has a containment relationship with an ESPolicies class (1 to 0..1). + +Figure 5.2.1-2: ES Policies NRM IOCs (Containment Relationship) + +NOTE 2: Also IOC SONControl is used for intra-LTE ES purposes – see clause 5.3.2.2 – but is not shown in Figure 5.2.1-2 to avoid the impression that there would an additional instance of this IOC be needed for intra-LTE ES. + +![UML Class Diagram showing containment relationship for SON control on cell level. EUtranGenericCell (from 28.658) contains EUtranCellSON (1 to 0..1).](a05e675f8651ae7ccea1d0d68691d1a9_img.jpg) + +``` + +classDiagram + class EUtranGenericCell["«InformationObjectClass» EUtranGenericCell (from 28.658)"] + class EUtranCellSON["«InformationObjectClass» EUtranCellSON"] + + EUtranGenericCell "1" *-- "0..1" EUtranCellSON : «names» + +``` + +UML Class Diagram showing containment relationship for SON control on cell level. EUtranGenericCell (from 28.658) contains EUtranCellSON (1 to 0..1). + +Figure 5.2.1-3: IOCs to control SON on cell level (Containment Relationship) + +![UML class diagram showing Information Object Classes (IOCs) for SON coordination with containment relationships.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +The diagram illustrates the Information Object Classes (IOCs) for SON coordination, showing containment relationships between various network elements and their associated policies and information. + +**Classes and Relationships:** + +- SubNetwork (from 28.622)**: + - Self-relationship: A directed association labeled "<names>" with a multiplicity of 1 at the source and 1 at the target. + - Relationship with **ManagedElement (from 28.622)**: A directed association labeled "<names>" with a multiplicity of 1 at the source and \* at the target. + - Relationship with **SONCoordinationPolicies**: A directed association labeled "<names>" with a multiplicity of 1 at the source and 0.1 at the target. + - Relationship with **SONFuncInfo**: A directed association labeled "<names>" with a multiplicity of 1 at the source and 0.1 at the target. +- ManagedElement (from 28.622)**: + - Relationship with **ENBFunction (from 28.658)**: A directed association labeled "<names>" with a multiplicity of 1 at the source and \* at the target. +- ENBFunction (from 28.658)**: + - Relationship with **SONCoordinationPolicies**: A directed association labeled "<names>" with a multiplicity of 1 at the source and 0.1 at the target. + - Relationship with **SONFuncInfo**: A directed association labeled "<names>" with a multiplicity of 1 at the source and 0.1 at the target. + - Relationship with **EUTranGenericCell (from 28.658)**: A directed association labeled "<names>" with a multiplicity of 1 at the source and \* at the target. +- EUTranGenericCell (from 28.658)**: + - Relationship with **SONCoordinationPolicies**: A directed association labeled "<names>" with a multiplicity of 1 at the source and 0.1 at the target. + +UML class diagram showing Information Object Classes (IOCs) for SON coordination with containment relationships. + +Figure 5.2.1-4: IOCs for SON coordination (Containment Relationship) + +![UML Class Diagram showing containment relationships between InformationObjectClasses.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` +classDiagram + class SubNetwork["«InformationObjectClass»\nSubNetwork\n(from 28.622)"] + class ManagedElement["«InformationObjectClass»\nManagedElement\n(from 28.622)"] + class ENBFunction["«InformationObjectClass»\nENBFunction\n(from 28.658)"] + class EUTranGenericCell["«InformationObjectClass»\nEUTranGenericCell\n(from 28.658)"] + class InterRatEsPolicies1["«InformationObjectClass»\nInterRatEsPolicies"] + class InterRatEsPolicies2["«InformationObjectClass»\nInterRatEsPolicies"] + class InterRatEsPolicies3["«InformationObjectClass»\nInterRatEsPolicies"] + + SubNetwork "1" *-- "1" SubNetwork : «names» + SubNetwork "1" *-- "0..1" InterRatEsPolicies1 : «names» + SubNetwork "1" *-- "*" ManagedElement : «names» + ManagedElement "1" *-- "*" ENBFunction : «names» + ENBFunction "1" *-- "0..1" InterRatEsPolicies2 : «names» + ENBFunction "1" *-- "*" EUTranGenericCell : «names» + EUTranGenericCell "1" *-- "0..1" InterRatEsPolicies3 : «names» +``` + +The diagram illustrates the containment relationships between several InformationObjectClasses. At the top, the **SubNetwork** class (from 28.622) has a self-association labeled «names» with a multiplicity of 1 at both ends. It also has a containment relationship with the **InterRatEsPolicies** class (multiplicity 0..1) and the **ManagedElement** class (multiplicity \*), both labeled «names». The **ManagedElement** class (from 28.622) has a containment relationship with the **ENBFunction** class (multiplicity \*), labeled «names». The **ENBFunction** class (from 28.658) has a containment relationship with the **InterRatEsPolicies** class (multiplicity 0..1) and the **EUTranGenericCell** class (multiplicity \*), both labeled «names». Finally, the **EUTranGenericCell** class (from 28.658) has a containment relationship with the **InterRatEsPolicies** class (multiplicity 0..1), labeled «names». + +UML Class Diagram showing containment relationships between InformationObjectClasses. + +**Figure 5.2.1-5: Inter-RAT ES Policies NRM IOCs (Containment Relationship, part 1)** + +NOTE 3: Also IOC SONControl is used for inter-RAT ES purposes – see clause 5.3.2.2 – but is not shown in Figure 5.2.1-5 to avoid the impression that there would an additional instance of this IOC be needed for inter-RAT ES. + +![UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 2).](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +classDiagram + class SubNetwork { + <<InformationObjectClass>> + (from 28.622) + } + class ExternalENBFunction { + <<InformationObjectClass>> + (from 28.658) + } + class ExternalEUTranGenericCell { + <<InformationObjectClass>> + (from 28.658) + } + class InterRatEsPolicies { + <<InformationObjectClass>> + } + + SubNetwork "1" *-- "1" SubNetwork : «names» + SubNetwork "1" *-- "*" ExternalENBFunction : «names» + ExternalENBFunction "1" *-- "*" ExternalEUTranGenericCell : «names» + SubNetwork "1" -- "0..1" InterRatEsPolicies : «names» + ExternalENBFunction "1" -- "0..1" InterRatEsPolicies : «names» + ExternalEUTranGenericCell "1" -- "0..1" InterRatEsPolicies : «names» + +``` + +The diagram illustrates the containment hierarchy for Inter-RAT ES Policies NRM IOCs. It features three main classes: **SubNetwork** (from 28.622), **ExternalENBFunction** (from 28.658), and **ExternalEUTranGenericCell** (from 28.658). These classes are linked by containment relationships (indicated by solid diamonds) and named associations (indicated by open arrows labeled «names»). + +- SubNetwork** has a self-containment relationship (1 to 1) and contains **ExternalENBFunction** (1 to \*). +- ExternalENBFunction** contains **ExternalEUTranGenericCell** (1 to \*). +- Each of the three main classes has a named association with **InterRatEsPolicies** (1 to 0..1). + +UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 2). + +Figure 5.2.1-6: Inter-RAT ES Policies NRM IOCs (Containment Relationship, part 2) + +![UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 3).](0ee9d674085524d589646a6c3fb21ec3_img.jpg) + +``` + +classDiagram + class SubNetwork { + <<InformationObjectClass>> + (from 28.622) + } + class ManagedElement { + <<InformationObjectClass>> + (from 28.622) + } + class RNCFunction { + <<InformationObjectClass>> + (from 28.652) + } + class UTRANGenericCell { + <<InformationObjectClass>> + (from 28.652) + } + class InterRatEsPolicies { + <<InformationObjectClass>> + } + + SubNetwork "1" *-- "1" SubNetwork : «names» + SubNetwork "1" *-- "*" ManagedElement : «names» + ManagedElement "1" *-- "*" RNCFunction : «names» + RNCFunction "1" *-- "*" UTRANGenericCell : «names» + SubNetwork "1" -- "0..1" InterRatEsPolicies : «names» + RNCFunction "1" -- "0..1" InterRatEsPolicies : «names» + UTRANGenericCell "1" -- "0..1" InterRatEsPolicies : «names» + +``` + +The diagram illustrates the containment hierarchy for Inter-RAT ES Policies NRM IOCs. It features four main classes: **SubNetwork** (from 28.622), **ManagedElement** (from 28.622), **RNCFunction** (from 28.652), and **UTRANGenericCell** (from 28.652). These classes are linked by containment relationships (indicated by solid diamonds) and named associations (indicated by open arrows labeled «names»). + +- SubNetwork** has a self-containment relationship (1 to 1) and contains **ManagedElement** (1 to \*). +- ManagedElement** contains **RNCFunction** (1 to \*). +- RNCFunction** contains **UTRANGenericCell** (1 to \*). +- SubNetwork**, **RNCFunction**, and **UTRANGenericCell** each have a named association with **InterRatEsPolicies** (1 to 0..1). + +UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 3). + +Figure 5.2.1-7: Inter-RAT ES Policies NRM IOCs (Containment Relationship, part 3) + +NOTE 4: Also IOC SONControl is used for inter-RAT ES purposes – see clause 5.3.2.2 – but is not shown in Figure 5.2.1-7 to avoid the impression that there would an additional instance of this IOC be needed for inter-RAT ES. SONControl is contained by Subnetwork or RncFunction when esSwitch attribute is applied in SONControl. + +![UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 4).](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` + +classDiagram + class SubNetwork["«InformationObjectClass» SubNetwork (from 28.622)"] + class ExternalRNCFunction["«InformationObjectClass» ExternalRNCFunction (from 28.652)"] + class ExternalUTRANGenericCell["«InformationObjectClass» ExternalUTRANGenericCell (from 28.652)"] + class InterRatEsPolicies["«InformationObjectClass» InterRatEsPolicies"] + + SubNetwork "1" *-- "1" SubNetwork : «names» + SubNetwork "1" *-- "*" ExternalRNCFunction : «names» + ExternalRNCFunction "1" *-- "*" ExternalUTRANGenericCell : «names» + SubNetwork "1" -- "0..1" InterRatEsPolicies : «names» + ExternalRNCFunction "1" -- "0..1" InterRatEsPolicies : «names» + ExternalUTRANGenericCell "1" -- "0..1" InterRatEsPolicies : «names» + +``` + +This UML class diagram illustrates the containment relationships for Inter-RAT ES Policies NRM IOCs (part 4). It features three main classes: **«InformationObjectClass» SubNetwork (from 28.622)**, **«InformationObjectClass» ExternalRNCFunction (from 28.652)**, and **«InformationObjectClass» ExternalUTRANGenericCell (from 28.652)**. These classes are linked by containment relationships (indicated by solid diamonds) with the stereotype «names». SubNetwork contains SubNetwork (1:1) and ExternalRNCFunction (1:\*). ExternalRNCFunction contains ExternalUTRANGenericCell (1:\*). Each of these three classes also has a directed association (indicated by an open arrow) to **«InformationObjectClass» InterRatEsPolicies** with the stereotype «names», with a multiplicity of 0..1 at the target end. + +UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 4). + +Figure 5.2.1-8: Inter-RAT ES Policies NRM IOCs (Containment Relationship, part 4) + +![UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 5).](fcbc3c31776721edc98ceb1944ec438f_img.jpg) + +``` + +classDiagram + class ManagedElement["«InformationObjectClass» ManagedElement (from 28.622)"] + class BssFunction["«InformationObjectClass» BssFunction (from 28.655)"] + class BtsSiteMgr["«InformationObjectClass» BtsSiteMgr (from 28.655)"] + class GamCell["«InformationObjectClass» GamCell (from 28.655)"] + class InterRatEsPolicies["«InformationObjectClass» InterRatEsPolicies"] + + ManagedElement "1" *-- "*" BssFunction : «names» + BssFunction "1" *-- "*" BtsSiteMgr : «names» + BtsSiteMgr "1" *-- "*" GamCell : «names» + ManagedElement "1" -- "0..1" InterRatEsPolicies : «names» + BtsSiteMgr "1" -- "0..1" InterRatEsPolicies : «names» + GamCell "1" -- "0..1" InterRatEsPolicies : «names» + +``` + +This UML class diagram illustrates the containment relationships for Inter-RAT ES Policies NRM IOCs (part 5). It features four main classes: **«InformationObjectClass» ManagedElement (from 28.622)**, **«InformationObjectClass» BssFunction (from 28.655)**, **«InformationObjectClass» BtsSiteMgr (from 28.655)**, and **«InformationObjectClass» GamCell (from 28.655)**. These classes are linked by containment relationships (indicated by solid diamonds) with the stereotype «names». ManagedElement contains BssFunction (1:\*). BssFunction contains BtsSiteMgr (1:\*). BtsSiteMgr contains GamCell (1:\*). Additionally, ManagedElement, BtsSiteMgr, and GamCell each have a directed association (indicated by an open arrow) to **«InformationObjectClass» InterRatEsPolicies** with the stereotype «names», with a multiplicity of 0..1 at the target end. + +UML Class Diagram showing containment relationships for Inter-RAT ES Policies NRM IOCs (part 5). + +Figure 5.2.1-9: Inter-RAT ES Policies NRM IOCs (Containment Relationship, part 5) + +![UML Class Diagram showing containment relationships between InformationObjectClass entities: SubNetwork, ExternalBssFunction, ExternalGsmCell, and InterRatEsPolicies.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +This UML class diagram illustrates containment relationships between several *«InformationObjectClass»* entities. The entities are represented as blue rectangular boxes. **SubNetwork (from 28.622)** has a self-containment relationship labeled *«names»* with a multiplicity of 1 at both ends. It has a composition relationship with **ExternalBssFunction (from 28.655)**, labeled *«names»*, with a multiplicity of 1 at both ends. **ExternalBssFunction (from 28.655)** has a composition relationship with **ExternalGsmCell (from 28.655)**, also labeled *«names»*, with a multiplicity of 1 at both ends. Finally, **ExternalGsmCell (from 28.655)** has a composition relationship with **InterRatEsPolicies**, labeled *«names»*, with a multiplicity of 1 at the ExternalGsmCell end and 0..1 at the InterRatEsPolicies end. + +UML Class Diagram showing containment relationships between InformationObjectClass entities: SubNetwork, ExternalBssFunction, ExternalGsmCell, and InterRatEsPolicies. + +Figure 5.2.1-10: Inter-RAT ES Policies NRM IOCs (Containment Relationship, part 6) + +### 5.2.2 Inheritance + +This subclause depicts the inheritance relationships. + +![UML Class Diagram showing inheritance hierarchy for SON Policy NRM IOCs: Top, SONControl, and SONTarget.](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +This UML class diagram shows an inheritance hierarchy. At the top is the **«InformationObjectClass» Top** class. Below it are two classes, **«InformationObjectClass» SONControl** and **«InformationObjectClass» SONTarget**, both of which inherit from **Top** as indicated by the hollow triangle arrows pointing to the base class. + +UML Class Diagram showing inheritance hierarchy for SON Policy NRM IOCs: Top, SONControl, and SONTarget. + +Figure 5.2.2-1: SON Policy NRM Inheritance Hierarchy + +![UML Class Diagram showing inheritance hierarchy for ES Policies NRM IOCs: Top, ESPolicies, and InterRatEsPolicies.](9ff1b32449ea068bba9647d71904bd59_img.jpg) + +This UML class diagram shows an inheritance hierarchy. At the top is the **«InformationObjectClass» Top** class. Below it are two classes, **«InformationObjectClass» ESPolicies** and **«InformationObjectClass» InterRatEsPolicies**, both of which inherit from **Top** as indicated by the hollow triangle arrows pointing to the base class. + +UML Class Diagram showing inheritance hierarchy for ES Policies NRM IOCs: Top, ESPolicies, and InterRatEsPolicies. + +Figure 5.2.2-2: ES Policies NRM IOCs (Inheritance Relationship) + +![UML Class Diagram showing inheritance for IOC to control SON on cell level. A class box labeled '«InformationObjectClass» Top' is at the top. Below it, a class box labeled '«InformationObjectClass» EUtranCellSON' has a solid line with an open triangle arrowhead pointing to the 'Top' class, indicating inheritance.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass» Top"] + class EUtranCellSON["«InformationObjectClass» EUtranCellSON"] + EUtranCellSON --|> Top + +``` + +UML Class Diagram showing inheritance for IOC to control SON on cell level. A class box labeled '«InformationObjectClass» Top' is at the top. Below it, a class box labeled '«InformationObjectClass» EUtranCellSON' has a solid line with an open triangle arrowhead pointing to the 'Top' class, indicating inheritance. + +**Figure 5.2.2-3: Inheritance for IOC to control SON on cell level** + +![UML Class Diagram showing energy saving properties NRM IOCs inheritance relationship. A class box labeled '«InformationObjectClass» Top' is at the top. Below it, a class box labeled '«InformationObjectClass» EnergySavingProperties' has a solid line with an open triangle arrowhead pointing to the 'Top' class, indicating inheritance.](382a9c9e4816bd229191ab4591424dd8_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass» Top"] + class EnergySavingProperties["«InformationObjectClass» EnergySavingProperties"] + EnergySavingProperties --|> Top + +``` + +UML Class Diagram showing energy saving properties NRM IOCs inheritance relationship. A class box labeled '«InformationObjectClass» Top' is at the top. Below it, a class box labeled '«InformationObjectClass» EnergySavingProperties' has a solid line with an open triangle arrowhead pointing to the 'Top' class, indicating inheritance. + +**Figure 5.2.2-4: Energy saving properties NRM IOCs (Inheritance Relationship)** + +![UML Class Diagram showing IOCs for SON coordination inheritance relationship. A class box labeled '«InformationObjectClass» Top' is at the top. Below it, two class boxes are shown: '«InformationObjectClass» SONCoordinationPolicies' on the left and '«InformationObjectClass» SONFuncInfo' on the right. Both have solid lines with open triangle arrowheads pointing to the 'Top' class, indicating inheritance.](896e86ed12aff206d302c64f2e3091fa_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass» Top"] + class SONCoordinationPolicies["«InformationObjectClass» SONCoordinationPolicies"] + class SONFuncInfo["«InformationObjectClass» SONFuncInfo"] + SONCoordinationPolicies --|> Top + SONFuncInfo --|> Top + +``` + +UML Class Diagram showing IOCs for SON coordination inheritance relationship. A class box labeled '«InformationObjectClass» Top' is at the top. Below it, two class boxes are shown: '«InformationObjectClass» SONCoordinationPolicies' on the left and '«InformationObjectClass» SONFuncInfo' on the right. Both have solid lines with open triangle arrowheads pointing to the 'Top' class, indicating inheritance. + +**Figure 5.2.2-5: IOCs for SON coordination (Inheritance Relationship)** + +## 5.3 Class definitions + +### 5.3.1 SONTargets + +#### 5.3.1.1 Definition + +This IOC represents targets for SON functions and their relative weights. + +Target hierarchy rule: + +An NRM IOC instance X may name-contain an IOC SONTargets instance T. The rule states that: + +- If X name-contains a SONTargets instance T, then T is applicable to X. +- If X and all its superior instances do not name-contain any SONTargets instance, then no SONTargets instance is applicable to X. + +- If X does not name-contain any SONTargets instance, but one or more of X's superior instances name-contain a SONTargets instance, then the SONTargets instance of the superior instance closest to X, in X's naming tree, is applicable to X. + +#### 5.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| hoFailureRate | O *) | M | M | - | M | +| rrcConnectionEstablishmentFailureRateCharacteristic | O *) | M | M | - | M | +| rrcConnectionAbnormalReleaseRateCharacteristic | O *) | M | M | - | M | +| eRabSetupFailureRateCharacteristic | O *) | M | M | - | M | +| eRabAbnormalReleaseRateCharacteristic | O *) | M | M | - | M | +| rachOptAccessProbability | CM **) | M | M | - | M | +| rachOptAccessDelayProbability | CM **) | M | M | - | M | +| pDCPDataVolumeLoadRate | O *) | M | M | - | M | +| iPThroughputLoadRate | O *) | M | M | - | M | +| activeUEAmountLoadRate | O *) | M | M | - | M | + +\*) Note 1: At least one of the attributes shall be supported. + +\*\*) Note 2: Only one of these attributes shall be present. + +#### 5.3.1.3 Attribute constraints + +| Name | Definition | +|----------------------------------------------------|-------------------------------------------------------------------------------------| +| rachOptAccessProbability CM Support Qualifier | RACH Optimization is supported and Access Probability is supported as target. | +| rachOptAccessDelayProbability CM Support Qualifier | RACH Optimization is supported and Access Delay Probability is supported as target. | + +#### 5.3.1.4 Notifications + +The common notifications defined in subclause 5.5 are valid for this IOC, without exceptions or additions. + +### 5.3.2 SONControl + +#### 5.3.2.1 Definition + +This IOC represents the possibility to switch on or off SON functions. This is provided for AAS optimization, Handover parameter optimization, Load Balancing optimization, Energy Saving, RACH optimization and Cell Outage Compensation. + +#### 5.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| aasSplitSwitch | CM | M | M | - | M | +| aasMergeSwitch | CM | M | M | - | M | +| aasShapeSwitch | CM | M | M | - | M | +| hooSwitch | CM | M | M | - | M | +| lboSwitch | CM | M | M | - | M | +| esSwitch | CM | M | M | - | M | +| roSwitch | CM | M | M | - | M | +| cocSwitch | CM | M | M | - | M | + +#### 5.3.2.3 Attribute constraints + +| Name | Definition | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| aasSplitSwitch CM Support Qualifier | Active Antenna System (AAS) optimization function is supported. | +| aasMergeSwitch CM Support Qualifier | Active Antenna System (AAS) optimization function is supported. | +| aasShapeSwitch CM Support Qualifier | Active Antenna System (AAS) optimization function is supported. | +| hooSwitch CM Support Qualifier | Handover (HO) parameter Optimization function is supported. | +| lboSwitch CM Support Qualifier | Load Balancing Optimization function is supported. | +| esSwitch Support Qualifier | The condition is “Distributed or EM-Centralized ESM architecture is supported”. | +| roSwitch CM Support Qualifier | RACH Optimization is supported. | +| cocSwitch Support Qualifier | The condition is “CoC is supported”. Only allowed to be present, if SONControl is contained in subnetwork IOC instance. | + +#### 5.3.2.4 Notifications + +The common notifications defined in subclause 5.5 are valid for this IOC, without exceptions or additions. + +### 5.3.3 ESPolicies + +#### 5.3.3.1 Definition + +This IOC represents the energy saving policies information. This object class is valid in a distributed ES architecture or in an EM-centralized ES architecture. + +#### 5.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------------------------|-------------------|------------|------------|-------------|--------------| +| esActivationOriginalCellLoadParameters | CM | M | M | - | M | +| esActivationCandidateCellsLoadParameters | CM | M | M | - | M | +| esDeactivationCandidateCellsLoadParameters | CM | M | M | - | M | +| esNotAllowedTimePeriod | O | M | M | - | M | + +#### 5.3.3.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------|--------------------------------------------------------------------------------------| +| esActivationOriginalCellLoadParameters | The condition is "Intra-RAT ESM is supported AND the cell acts as an original cell". | +| esActivationCandidateCellsLoadParameters | The condition is "Intra-RAT ESM is supported AND the cell acts as a candidate cell". | +| esDeactivationCandidateCellsLoadParameters | The condition is "Intra-RAT ESM is supported AND the cell acts as a candidate cell". | + +#### 5.3.3.4 Notifications + +The common notifications defined in subclause 5.5 are valid for this IOC, without exceptions or additions. + +### 5.3.4 EUTranCellSON + +#### 5.3.4.1 Definition + +This IOC represents the parameters for control of SON functions on E-UTRAN cell level. + +#### 5.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------|-------------------|------------|------------|-------------|--------------| +| alterCovConfig | CM | M | M | - | M | +| maximumDeviationHoTrigger | CM | M | M | - | M | +| minimumTimeBetweenHoTriggerChange | CM | M | M | - | M | +| replacedCells | CM | M | M | - | M | + +#### 5.3.4.3 Attribute constraints + +| Name | Definition | +|-----------------------------------------------------|-----------------------------------------------| +| alterCovConfig CM Support Qualifier | AAS optimization function is supported. | +| maximumDeviationHoTrigger Support Qualifier | The condition is "HOO function is supported". | +| minimumTimeBetweenHoTriggerChange Support Qualifier | The condition is "HOO function is supported". | +| replacedCells CM Support Qualifier | AAS optimization function is supported. | + +#### 5.3.4.4 Notifications + +The common notifications defined in subclause 5.5 are valid for this IOC, without exceptions or additions. + +### 5.3.5 EnergySavingProperties + +#### 5.3.5.1 Definition + +This IOC represents the energy saving properties of a network element supporting Energy Saving Management functionality. + +#### 5.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|------------|-------------|--------------| +| energySavingState | M | M | - | - | M | +| energySavingControl | CM | M | M | - | M | +| isProbingCapable | O | M | - | - | M | + +#### 5.3.5.3 Attribute constraints + +| Name | Definition | +|------------------------------------------|-------------------------------------------------------------------------------------| +| energySavingControl CM Support Qualifier | The condition is "ESM functionality supports and uses NM-Centralized architecture". | + +#### 5.3.5.4 Notifications + +The common notifications defined in subclause 5.5 are valid for this IOC. Notification notifyAttributeValueChange shall be supported for attribute energySavingState. + +### 5.3.6 IOC SONFuncInfo + +#### 5.3.6.1 Definition + +This IOC represents information of SON functions, to support SON coordination. In case of SON coordination function is located below Itf-N, this IOC is used together with SONCoordinationPolicies IOC for SON coordination purpose. + +SONFuncInfo hierarchy rule: + +An NRM IOC instance X may name-contain an IOC SONFuncInfo instance T. The rule states that: + +- If X name-contains a SONFuncInfo instance T, then T is applicable to X. +- If X and all its superior instances do not name-contain any SONFuncInfo instance, then no SONFuncInfo instance is applicable to X. +- If X does not name-contain any SONFuncInfo instance, but one or more of X's superior instances name-contain a SONFuncInfo instance, then the SONFuncInfo instance of the superior instance closest to X, in X's naming tree, is applicable to X. + +#### 5.3.6.2 Attributes + +| Attribute Name | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------------------|-------------------|----------------|-----------------| +| sonFuncCapabilityBelowItfN | M | M | - | + +#### 5.3.6.3 Attribute constraints + +None. + +#### 5.3.6.4 Notifications + +The common notifications defined in subclause 5.6.1 are valid for this IOC, without exceptions or additions. + +### 5.3.7 IOC SONCoordinationPolicies + +#### 5.3.7.1 Definition + +This IOC represents the SON coordination policies that are selected by IRPManagers from the IRP Agent supported policies in the case of a separate SON coordination function is located below Itf-N (i.e., EM centralized SON coordination) or SON coordination function is implemented as part of each SON function (i.e., distributed SON coordination). For EM centralized SON coordination case, the case that the SON function is located above Itf-N and the corresponding SON coordination function is below Itf-N is not in the scope of this release. + +This IOC is not intended to be used by IRPManager to create SON coordination policies that are not supported by IRP Agent. The selected SON coordination policies are used by SON coordination function to coordinate the SON functions with potential conflicts, in case no SON coordination policies are selected by IRPManager, the default SON coordination policies are applied to the SON coordination function below Itf-N; the default SON coordination policies are per agreement between IRPManager and IRP Agent, the value of the default SON coordination policies is out of the scope of this specification. + +SONCoordinationPolicies hierarchy rule: + +An NRM IOC instance X may name-contain an IOC SONCoordinationPolicies instance T. The rule states that: + +- If X name-contains a SONCoordinationPolicies instance T, then T is applicable to X. +- If X and all its superior instances do not name-contain any SONCoordinationPolicies instance, then no SONCoordinationPolicies instance is applicable to X. +- If X does not name-contain any SONCoordinationPolicies instance, but one or more of X's superior instances name-contain a SONCoordinationPolicies instance, then the SONCoordinationPolicies instance of the superior instance closest to X, in X's naming tree, is applicable to X. + +#### 5.3.7.2 Attributes + +| Attribute Name | Support Qualifier | Read Qualifier | Write Qualifier | +|------------------------|-------------------|----------------|-----------------| +| selectedSonCoordPolicy | CM | M | M | +| sonFuncPriorityOrder | CM | M | M | + +#### 5.3.7.3 Attribute constraints + +#### 5.3.7.4 Notifications + +| Name | Definition | +|------------------------------------------------|-----------------------------------------------------------------------------------| +| selectedSonCoordPolicy CM<br>Support Qualifier | SON coordination function below ltf-N supports more than one coordination policy. | +| sonFuncPriorityOrder CM<br>Support Qualifier | The selectedSonCoordPolicy equals to "BaseOnPriority". | + +The common notifications defined in subclause 5.6.1 are valid for this IOC, without exceptions or additions. + +### 5.3.8 interRatEsPolicies + +#### 5.3.8.1 Definition + +This IOC represents the inter-RAT energy saving policies information. This object class is valid in a distributed ES architecture or in an EM-centralized ES architecture. + +#### 5.3.8.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------|-------------------|------------|------------|-------------|--------------| +| interRatEsActivationOriginalCellParameters | CM | M | M | - | M | +| interRatEsActivationCandidateCellParameters | CM | M | M | - | M | +| interRatEsDeactivationCandidateCellParameters | CM | M | M | - | M | + +#### 5.3.8.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| interRatEsActivationOriginalCellParameters CM Support Qualifier | The condition is "The cell acts as an original cell" AND inter-RAT ESM is supported. | +| interRatEsActivationCandidateCellParameters CM Support Qualifier | The condition is "The cell acts as a candidate cell" AND inter-RAT ESM is supported. | +| interRatEsDeactivationCandidateCellParameters CM Support Qualifier | The condition is "The cell acts as a candidate cell" AND inter-RAT ESM is supported. | + +#### 5.3.8.4 Notifications + +The common notifications defined in subclause 5.6.1 are valid for this IOC, without exceptions or additions. + +## 5.4 Attribute definitions + +### 5.4.1 Attribute properties + +The following table defines the attributes that are present in the Information Object Classes (IOCs) of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| aasSplitSwitch | This attribute allows the operator to enable/disable the AAS cell splitting functionality.<br><br>allowedValues: on, off | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| aasMergeSwitch | This attribute allows the operator to enable/disable the AAS cell merging functionality.<br><br>allowedValues: on, off | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| aasShapeSwitch | This attribute allows the operator to enable/disable the AAS cell shaping functionality.<br><br>allowedValues: on, off | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| activeUEAmountLoadRate | This indicates the assigned SON target of the sum number of active UE in DL and UL divided by the nominal capacity of active UE amount, together with its targetWeight.<br><br>This target is suitable for AAS.<br><br>allowedValues: A set of three numbers:<br><br>targetLowerThreshold:<br>Integer 0..100 (representing a percentage)<br><br>targetUpperThreshold:<br>Integer 0..100 (representing a percentage)<br><br>targetWeight:<br>Integer 1..N. (The higher the number the higher the weight) | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| alterCovConfig | <p>This holds a list of alternative coverage configurations which are used for AAS optimization function to select and switch between these configurations. Each coverage configuration contains the following entries:</p> <ul style="list-style-type: none"> <li>- StateId, which indicates the identifier of the coverage configuration, see 3GPP TS 36.423 [7];</li> <li>- horizontalHBW, which indicates the horizontal half-power beamwidth (see NOTE 1);</li> <li>- verticalHBW, which indicates the vertical half-power beamwidth (see NOTE 1);</li> <li>- maximumTransmissionPowerRange, which indicates the range of maximumTransmissionPower, see TS 28.658 [10];</li> <li>- referenceSignalPowerRange, which indicates the range of referenceSignalPower, see TS 28.658 [10]</li> </ul> <p>allowedValues:<br/>StateId:<br/>See 3GPP TS 36.423 [7] subclause 9.1.2.8 for value range of identifier of the coverage configuration.</p> <p>horizontalHBW:<br/>Integer 0..360 (representing an angle in degrees)</p> <p>verticalHBW:<br/>Integer 0..360 (representing an angle in degrees)</p> <p>maximumTransmissionPowerRange:<br/>see 3GPP TS 28.658 [10] subclause 4.4.1 for value range of maximumTransmissionPower.</p> <p>referenceSignalPowerRange:<br/>see 3GPP TS 28.658 [10] subclause 4.4.1 for value range of referenceSignalPower.</p> | <p>type: <<data type>><br/>multiplicity: 1..*<br/>isOrdered: N/A<br/>isUnique: N/A<br/>defaultValue: None<br/>isNullable: True</p> | +| cocSwitch | <p>This attribute allows the operator to enable/disable the COC functionality.</p> <p>allowedValues: on, off</p> | <p>type: <<enumeration>><br/>multiplicity: 1<br/>isOrdered: N/A<br/>isUnique: N/A<br/>defaultValue: None<br/>isNullable: True</p> | +| energySavingControl | <p>This attribute allows the IRPManager to initiate energy saving activation or deactivation. Its value can not be changed by the IRPAgent.</p> <p>allowedValues: toBeEnergySaving, toBeNotEnergySaving</p> | <p>type: <<enumeration>><br/>multiplicity: 1<br/>isOrdered: N/A<br/>isUnique: N/A<br/>defaultValue: None<br/>isNullable: True</p> | +| energySavingState | <p>Specifies the status regarding the energy saving in the cell.<br/>If the value of energySavingControl is toBeEnergySaving, then it shall be tried to achieve the value isEnergySaving for the energySavingState.<br/>If the value of energySavingControl is toBeNotEnergySaving, then it shall be tried to achieve the value isNotEnergySaving for the energySavingState.</p> <p>allowedValues: isNotEnergySaving, isEnergySaving.</p> | <p>type: <<enumeration>><br/>multiplicity: 1<br/>isOrdered: N/A<br/>isUnique: N/A<br/>defaultValue: None<br/>isNullable: True</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| eRabAbnormalReleaseRateCharacteristic | <p>The target is on the number of E-RAB abnormal release related to load divided by the total number of attempted E-RAB setups.</p> <p>This attribute allows to define for a value the composite available capacity (CAC) range in which the target is valid. For this, it contains one characteristic dependent on Uplink CAC, one for Downlink CAC:<br/> eRabAbnormalReleaseRateCharacteristicDownlink and<br/> eRabAbnormalReleaseRateCharacteristicUplink.</p> <p>At least one of these characteristics must be present. Together with the characteristic its targetWeight as a SON target is defined as part of this attribute. The characteristics have the following structure:<br/> eRabAbnormalReleaseRateCharacteristicDownlink:<br/> List of one or more entries, each consisting of:<br/>     lowerEndOfCacRange,<br/>     upperEndOfCacRange,<br/>     eRabAbnormalReleaseRateTarget<br/> eRabAbnormalReleaseRateCharacteristicUplink:<br/> List of one or more entries, each consisting of:<br/>     lowerEndOfCacRange,<br/>     upperEndOfCacRange,<br/>     eRabAbnormalReleaseRateTarget</p> <p>Remark:<br/> Formula for composite available capacity:<br/> Available Capacity = Cell Capacity Class Value * Capacity Value<br/> For definition of Cell Capacity Class Value and Capacity Value see TS 36.331 [6]. These definitions lead to a value range of a composite available capacity from 0..10000.<br/> 36.423 [7] has cell capacity class value as optional parameter in case of intra-LTE load balancing. If cell capacity class value is not present, then 36.423 assumes that bandwidth should be used instead to assess the capacity.</p> <p>This target is suitable for LBO.</p> <p>allowedValues:<br/> lowerEndOfCacRange and upperEndOfCacRange:<br/> Integer 0..10000</p> <p>eRabAbnormalReleaseRateTarget:<br/> Integer 0..100 (representing a percentage)</p> <p>targetWeight:<br/> Integer 1..N. The higher the number the higher the weight.</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eRabSetupFailureRateCharacteristic | <p>The target is on the number of E-RAB setup failures related to load divided by the total number of attempted E-RAB setups.</p> <p>For E-RAB setup failure related to load the causes “Reduce load in serving cell” and “Radio resources not available” defined in TS 36.413 are used.</p> <p>This attribute allows to define for a value the composite available capacity (CAC) range in which the target is valid. For this, it contains one characteristic dependent on Uplink CAC, one for Downlink CAC:</p> <p>eRabSetupFailureRateCharacteristicDownlink and eRabSetupFailureRateCharacteristicUplink.</p> <p>At least one of these characteristics must be present. Together with the characteristic its targetWeight as a SON target is defined as part of this attribute. The characteristics have the following structure:</p> <p>eRabSetupFailureRateCharacteristicDownlink:</p> <p>List of one or more entries, each consisting of:</p> <ul style="list-style-type: none"> <li>LowerEndOfCacRange,</li> <li>UpperEndOfCacRange,</li> <li>eRabSetUpFailureRateTarget</li> </ul> <p>eRabSetupFailureRateCharacteristicUplink:</p> <p>List of one or more entries, each consisting of:</p> <ul style="list-style-type: none"> <li>LowerEndOfCacRange,</li> <li>UpperEndOfCacRange,</li> <li>eRabSetUpFailureRateTarget</li> </ul> <p>For CAC see eRabAbnormalReleaseRateCharacteristic</p> <p>This target is suitable for LBO.</p> <p>allowedValues:</p> <p>lowerEndOfCacRange and upperEndOfCacRange and targetWeight:</p> <p>See eRabAbnormalReleaseRateCharacteristic</p> <p>eRabSetUpFailureRateTarget:</p> <p>Integer 0..100 (representing a percentage)</p> | <p>type: <<data type>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| esActivationOriginalCellLoadParameters | <p>This attribute is relevant, if the cell acts as an original cell.</p> <p>This attribute indicates the traffic load threshold and the time duration, which are used by distributed ES algorithms to allow a cell to enter the energySaving state. The time duration indicates how long the load needs to have been below the threshold.</p> <p>allowedValues:</p> <p>Threshold: Integer 0..100 (Percentage of PRB usage, see 3GPP TS 36.314 [13])</p> <p>TimeDuration: Integer (in unit of seconds)</p> | <p>type: <<data type>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| esActivationCandidateCellsLoadParameters | <p>This attribute is relevant, if the cell acts as a candidate cell.</p> <p>This attribute indicates the traffic load threshold and the time duration, which are used by distributed ES algorithms level to allow a n 'original' cell to enter the energySaving state. Threshold and duration are applied to the candidate cell(s) which will provides coverage backup of an original cell when it is in the energySaving state. The threshold applies in the same way for a candidate cell, no matter for which original cell it will provide backup coverage.</p> <p>The time duration indicates how long the traffic in the candidate cell needs to have been below the threshold before any original cells which will be provided backup coverage by the candidate cell enters energy saving state.</p> <p>allowedValues: Threshold: Integer 0..100 (Percentage of PRB usage (see 3GPP TS 36.314 [13]) )<br/>TimeDuration: Integer (in unit of seconds)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| esDeactivationCandidateCellsLoadParameters | <p>This attribute is relevant, if the cell acts as a candidate cell.</p> <p>This attribute indicates the traffic load threshold and the time duration which is used by distributed ES algorithms to allow a cell to leave the energySaving state. Threshold and time duration are applied to the candidate cell when it which provides coverage backup for the cell in energySaving state. The threshold applies in the same way for a candidate cell, no matter for which original cell it provides backup coverage.</p> <p>The time duration indicates how long the traffic in the candidate cell needs to have been above the threshold to wake up one or more original cells which have been provided backup coverage by the candidate cell.</p> <p>allowedValues: Threshold: Integer 0..100 (Percentage of PRB usage (see 3GPP TS 36.314 [13]) )<br/>TimeDuration: Integer (in unit of seconds)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| esNotAllowedTimePeriod | <p>This attribute can be used to prevent a cell entering energySaving state.</p> <p>This attribute indicates a list of time periods during which inter-RAT energy saving is not allowed.</p> <p>Time period is valid on the specified day and time of every week.</p> <p>allowedValues: The legal values are as follows:<br/>startTime and endTime:<br/>All values that indicate valid UTC time. endTime should be later than startTime.</p> <p>periodOfDay: structure of startTime and endTime.</p> <p>daysOfWeekList: list of weekday.<br/>weekday: Monday, Tuesday, ... Sunday.</p> <p>List of time periods:<br/>{ { daysOfWeek    daysOfWeekList,<br/>  periodOfDay      dailyPeriod } }</p> | type: <<data type>><br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| esSwitch | This attribute determines whether the energy saving function is enabled or disabled.<br><br>allowedValues: On, Off | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hoFailureRate | This indicates the assigned HOO target of the number of failure events related to handover divided by the total number of handover events, together with its targetWeight.<br><br>This target is suitable for HOO or LBO.<br><br>allowedValues: A set of two numbers: the first indicates a percentage, the second a targetWeight (see eRabAbnormalReleaseRateCharacteristic). | type: <<data type>><br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hooSwitch | This attribute determines whether the Handover parameter Optimization Function is activated or deactivated.<br><br>allowedValues: On, Off | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| interRatEsActivationOriginalCellParameters | This attribute is relevant, if the cell acts as an original cell.<br>This attribute indicates the traffic load threshold and the time duration, which are used by distributed inter-RAT ES algorithms to allow an original cell to enter the energySaving state. The time duration indicates how long the traffic load (both for UL and DL) needs to have been below the threshold.<br><br>In case the original cell is an EUTRAN cell, the load information refers to Composite Available Capacity Group IE (see 3GPP TS 36.413 [12] Annex B.1.5) and the following applies:<br>Load = (100 - 'Capacity Value') * 'Cell Capacity Class Value', where 'Capacity Value' and 'Cell Capacity Class Value' are defined in 3GPP TS 36.423 [7].<br><br>In case the original cell is a UTRAN cell, the load information refers to Cell Load Information Group IE (see 3GPP TS 36.413 [12] Annex B.1.5) and the following applies:<br>Load= 'Load Value' * 'Cell Capacity Class Value', where 'Load Value' and 'Cell Capacity Class Value' are defined in 3GPP TS 25.413 [19].<br><br>If the 'Cell Capacity Class Value' is not known, then 'Cell Capacity Class Value' should be set to 1 when calculating the load, and the load threshold should be set in range of 0..100.<br><br>allowedValues:<br>LoadThreshold: Integer 0..10000<br>TimeDuration: Integer 0..900 (in unit of seconds) | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| interRatEsActivationCandidateCellParameters | <p>This attribute is relevant, if the cell acts as a candidate cell.</p> <p>This attribute indicates the traffic load threshold and the time duration, which are used by distributed inter-RAT ES algorithms to allow an original cell to enter the energySaving state. Threshold and time duration are applied to the candidate cell(s) which will provides coverage backup of an original cell when it is in the energySaving state.</p> <p>The time duration indicates how long the traffic load (both for UL and DL) in the candidate cell needs to have been below the threshold before any original cells which will be provided backup coverage by the candidate cell enters energySaving state.</p> <p>In case the candidate cell is a UTRAN or GERAN cell, the load information refers to Cell Load Information Group IE(see 3GPP TS 36.413 [12] Annex B.1.5) and the following applies:<br/> Load= 'Load Value' * 'Cell Capacity Class Value', where 'Load Value' and 'Cell Capacity Class Value' are defined in 3GPP TS 25.413 [19] (for UTRAN) / TS 48.008 [20] (for GERAN).</p> <p>If the 'Cell Capacity Class Value' is not known, then 'Cell Capacity Class Value' should be set to 1 when calculating the load, and the load threshold should be set in range of 0..100.</p> <p>allowedValues:<br/> LoadThreshold: Integer 0..10000<br/> TimeDuration: Integer 0..900 (in unit of seconds)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| interRatEsDeactivationCandidateCellParameters | <p>This attribute is relevant, if the cell acts as a candidate cell.</p> <p>This attribute indicates the traffic load threshold and the time duration which is used by distributed inter-RAT ES algorithms to allow an original cell to leave the energySaving state. Threshold and time duration are applied to the candidate cell which provides coverage backup for the cell in energySaving state.</p> <p>The time duration indicates how long the traffic load (either for UL or DL) in the candidate cell needs to have been above the threshold to wake up one or more original cells which have been provided backup coverage by the candidate cell.</p> <p>For the load see the definition of interRatEsActivationCandidateCellParameters.</p> <p>allowedValues:<br/> LoadThreshold: Integer 0..10000<br/> TimeDuration: Integer 0..900 (in unit of seconds)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipThrouputLoadRate | <p>This indicates the assigned SON target of the total IP throughput in DL and UL divided by the nominal capacity of total IP throughput, together with its targetWeight.</p> <p>This target is suitable for AAS.</p> <p>allowedValues: A set of three numbers:</p> <p>targetLowerThreshold:<br/>Integer 0..100 (representing a percentage)</p> <p>targetUpperThreshold:<br/>Integer 0..100 (representing a percentage)</p> <p>targetWeight:<br/>Integer 1..N. (The higher the number the higher the weight).</p> | <p>type: <<data type>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| lboSwitch | <p>This attribute determines whether the Load Balancing Optimization Function is activated or deactivated.</p> <p>allowedValues: On, Off</p> | <p>type: <<enumeration>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| maximumDeviationHoTrigger | <p>This parameter allows the IRPManager to define the maximum allowed absolute deviation of the cell pair specific part of Handover Trigger (as defined in [14] (§22.4.1.4), from the default point of operation</p> <p>allowedValues: Integer (+1..+96)<br/>Unit: 0.5 dB</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| isProbingCapable | <p>This attribute indicates whether this cell is capable of performing the ES probing procedure. During this procedure the eNB owning the cell indicates its presence to UEs for measurement purposes, but prevents idle mode UEs from camping on the cell and prevents incoming handovers to the same cell. If this parameter is absent, then probing is not done.</p> <p>allowedValues: yes, no</p> | <p>type: <<enumeration>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| minimumTimeBetweenHoTriggerChange | <p>This parameter defines the minimum allowed time interval between two changes of the Handover Trigger performed by MRO.</p> <p>allowedValues: Integer (0..1440)<br/>Unit: Minutes</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| pDCPDataVolumeLoadRate | <p>This indicates the assigned SON target of the total PDCP data volume in DL and UL divided by the nominal capacity of total PDCP data volume, together with its targetWeight.</p> <p>This target is suitable for AAS.</p> <p>allowedValues: A set of three numbers:</p> <p>targetLowerThreshold:<br/>Integer 0..100 (representing a percentage)</p> <p>targetUpperThreshold:<br/>Integer 0..100 (representing a percentage)</p> <p>targetWeight:<br/>Integer 1..N. (The higher the number the higher the weight).</p> | <p>type: <<data type>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| <code>rachOptAccessDelayProbability</code> | <p>This is a list of target Access Delay probability (<math>AD_P</math>) for the RACH optimization function.</p> <p>Each instance <math>AD_P</math> of the list is the target time before the UE gets access on the random access channel, for the <math>P</math> percent of the successful RACH Access attempts with lowest access delay, over an unspecified sampling period.</p> <p>This target is suitable for RO.</p> <p>allowedValues: Each element of the list, <math>AD_{Pn}</math>, is a pair (<math>a</math>, <math>b</math>) where <math>a</math> is the targetProbability (in %) and <math>b</math> is the access delay (in milliseconds).</p> <p>The legal values for <math>a</math> are 25, 50, 75, 90.<br/>The legal values for <math>b</math> are 10 to 560.</p> <p>If <math>AD_{Px}</math>'s <math>a</math> is larger than that of <math>AD_{Py}</math>, then <math>AD_{Px}</math>'s <math>b</math> must be larger than that of <math>AD_{Py}</math>.</p> <p>The number of elements specified is 4. The number of elements supported is vendor specific. The choice of supported values for <math>a</math> and <math>b</math> is vendor-specific.</p> | type: <<data type>><br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <code>rachOptAccessProbability</code> | <p>This is a list of target Access Probability (<math>AP_n</math>) for the RACH optimization function.</p> <p>Each instance <math>AP_n</math> of the list is the probability that the UE gets access on the random access channel within <math>n</math> number of attempts, over an unspecified sampling period.</p> <p>This target is suitable for RO.</p> <p>allowedValues: Each element of the list, <math>AP_n</math>, is a pair (<math>a</math>, <math>n</math>) where <math>a</math> is the targetProbability (in %) and <math>n</math> is the access attempt number.</p> <p>The legal values for <math>a</math> are 25, 50, 75, 90.<br/>The legal values for <math>n</math> are 1 to 200.</p> <p>If <math>AP_x</math>'s <math>a</math> is larger than that of <math>AP_y</math>, then <math>AP_x</math>'s <math>n</math> must be larger than that of <math>AP_y</math>.</p> <p>The number of elements specified is 4. The number of elements supported is vendor specific. The choice of supported values for <math>a</math> and <math>n</math> is vendor-specific.</p> | type: <<data type>><br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <code>replacedCells</code> | <p>This holds a list of local identify of the cells which have been replaced by the subject cell within the eNodeB.</p> <p>allowedValues of each entry: Integer (0..255)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <code>roSwitch</code> | <p>This attribute determines whether the RACH Optimization function is activated or deactivated.</p> <p>allowedValues: On, Off</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| rrcConnectionAbnormalReleaseRateCharacteristic | <p>The target is on the number of abnormal RRC connection releases related to load divided by the total number of RRC connection releases.</p> <p>This attribute allows to define for a value the composite available capacity (CAC) range in which the target is valid. For this, it contains one characteristic dependent on Uplink CAC, one for Downlink CAC:<br/> rrcConnectionAbnormalReleaseRateCharacteristicDownlink and<br/> rrcConnectionAbnormalReleaseRateCharacteristicUplink.</p> <p>At least one of these characteristics must be present. Together with the characteristic its targetWeight as a SON target is defined as part of this attribute. The characteristics have the following structure:<br/> rrcConnectionAbnormalReleaseRateCharacteristicDownlink:<br/> List of one or more entries, each consisting of:<br/>     lowerEndOfCacRange,<br/>     upperEndOfCacRange,<br/>     rrcConnectionAbnormalReleaseRateTarget<br/> rrcConnectionAbnormalReleaseRateCharacteristicUplink:<br/> List of one or more entries, each consisting of:<br/>     lowerEndOfCacRange,<br/>     upperEndOfCacRange,<br/>     rrcConnectionAbnormalReleaseRateTarget</p> <p>For CAC see<br/> eRabAbnormalReleaseRateCharacteristic</p> <p>This target is suitable for LBO.</p> <p>allowedValues: lowerEndOfCacRange and upperEndOfCacRange and targetWeight:<br/> See eRabAbnormalReleaseRateCharacteristic</p> <p>rrcConnectionAbnormalReleaseRateTarget:<br/> Integer 0..100 (representing a percentage)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| rrcConnectionEstablishmentFailureRateCharacteristic | <p>The target is on the number of RRC connection establishment failures related to load divided by the total number of attempted RRC connection establishments.</p> <p>This attribute allows to define for a value the composite available capacity (CAC) range in which the target is valid. For this, it contains one characteristic dependent on Uplink CAC, one for Downlink CAC:<br/> rrcConnectionEstablishmentFailureRateCharacteristicDownlink and<br/> rrcConnectionEstablishmentFailureRateCharacteristicUplink.</p> <p>At least one of these characteristics must be present. Together with the characteristic its targetWeight as a SON target is defined as part of this attribute. The characteristics have the following structure:<br/> rrcConnectionEstablishmentFailureRateCharacteristicDownlink:<br/> List of one or more entries, each consisting of:<br/> lowerEndOfCacRange,<br/> upperEndOfCacRange,<br/> rrcConnectionEstablishmentFailureRateTarget</p> <p>get<br/> rrcConnectionEstablishmentFailureRateCharacteristicUplink:<br/> List of one or more entries, each consisting of:<br/> lowerEndOfCacRange,<br/> upperEndOfCacRange,<br/> rrcConnectionEstablishmentFailureRateTarget</p> <p>get<br/> For CAC see<br/> eRabAbnormalReleaseRateCharacteristic</p> <p>This target is suitable for LBO.</p> <p>allowedValues: lowerEndOfCacRange and upperEndOfCacRange and targetWeight:<br/> See eRabAbnormalReleaseRateCharacteristic</p> <p>rrcConnectionEstablishmentFailureRateTarget:<br/> Integer 0..100 (representing a percentage)</p> | type: <<data type>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| selectedSonCoordPolicy | <p>This attribute indicates the SON coordination policy that is selected by IRPManager in case the SON coordination function is located below Itf-N. The selected SON coordination policy is one of the enumed value from BaseOnPriority and BaseOnState, wherein</p> <ul style="list-style-type: none"> <li>- BaseOnPriority, representing that the coordination is based on the priority order of the SON functions listed in "sonFuncPriorityOrder" attribute;</li> <li>- BaseOnState, representing the coordination is based on the cell state.</li> </ul> <p>allowedValues: BaseOnPriority, BaseOnState</p> <p>The examples of SON coordination for some certain conflicting cases based on priority and state are depicted in Annex B.</p> | type: << enumeration >><br>multiplicity: 0..1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| sonFuncCapabilityBelowItfN | <p>This attribute represents the SON functions supported below Itf-N.</p> <p>It is a list of SON function name. The SON function name is one of the enumerated value from anr, hoo, lbo, es, coc, cco and aas, wherein</p> <ul style="list-style-type: none"> <li>- anr representing automated neighbor relation;</li> <li>- hoo representing handover parameter optimization;</li> <li>- lbo representing load balancing optimization;</li> <li>- es representing energy saving;</li> <li>- coc representing cell outage compensation;</li> <li>- cco representing coverage and capacity optimization.</li> <li>- aas representing active antenna system optimization</li> </ul> <p>allowedValues:<br/>List of SON function name.<br/>SON function name: Enumerated {anr, hoo, lbo, es, coc, cco, aas}</p> | type: <<dataType>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sonFuncPriorityOrder | <p>This attribute indicates the priority order of SON functions below Itf-N for SON coordination purpose, in case the <code>selectedSonCoordPolicy</code> equals to “BaseOnPriority”.</p> <p>It is a list of SON function name, see the detailed description in “<code>sonFuncCapabilityBelowItfN</code>” attribute.</p> <p>The priority order is indicated by the sequence of the SON function name in the list, i.e., the first element in the list takes the highest priority, and the last element in the list takes the lowest priority.</p> <p>In case of <code>selectedSonCoordPolicy</code> does not equal to “BaseOnPriority”, this sequence of the SON function name in the list is not used as priority order for SON coordination.</p> <p>allowedValues:<br/>List of SON function name.<br/>SON function name: Enumerated {anr, hoo, lbo, es, coc, cco, aas}</p> | type: <<dataType>><br>multiplicity: 0..1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| NOTE : The half-power beamwidth is, in a radiation pattern cut containing the direction of the maximum of a lobe, the angle between two directions in which the radiation intensity is one-half the maximum value. | | | + +### 5.4.2 Constraints + +None. + +## 5.5 Common notifications + +### 5.5.1 Alarm notifications + +None. + +### 5.5.2 Configuration notifications + +This subclause presents a list of notifications, defined in [17], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [16], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | + +# --- Annex A (informative): Target Achievement Evaluation + +To evaluate the result of the optimization the target achievement needs to be evaluated. This can be done by calculating the Total Target Achievement as follows. + +The Total Target Achievement is the sum of the products of the individual target achievement (difference between target and performance) and the individual targetWeights: + +$$\begin{aligned} \text{Total Target Achievement} = & \\ & \text{Sum}_{i=1..n} [ ( \text{minTarget}_i - \text{performance}_i ) \times \text{weight}_i ] \\ & + \text{Sum}_{j=1..n} [ ( \text{performance}_j - \text{maxTarget}_j ) \times \text{weight}_j ] \end{aligned}$$ + +where minTarget is a target to be minimized and maxTarget is a target to be maximized. + +For targets with a substructure (like \*Characteristic, see §5.5.1) the above formula is applied to each individual substructure target. + +The higher the Total Target Achievement, the better is the result of the optimization. + +# --- Annex B (informative): Examples of how to use general SON coordination solutions + +Examples of how to use general SON coordination solutions are as below: + +## --- B.1 Coordination of COC and CCO using priority of SON functions + +To prevent conflicting setting as illustrated in clause 4.7.3.2.1, the cell(s) which may need to be coordinated between COC and CCO, i.e., the impact area information, should be known by the SON Coordination Function. By comparing the priorities of COC and CCO, SON Coordination Function will decide to do the high-priority action and suspend the low-priority action on the coordinated cell(s). The priorities of COC and CCO can be preset by operator to SON Coordination Function, or SON Coordination Function inquires the default priority of COC and CCO to each of them. + +The cell which needs to be coordinated between COC and CCO is: + +- The cell in which there is coverage or capacity problem and CCO action is needed, meanwhile the cell is outage or compensating or going to compensate for outage; or +- The cell which is located in the CCO optimization analysis area for other cell which has coverage or capacity problem, meanwhile the cell is outage or compensating or going to compensate for outage; + +After the high-priority SON function executes action, the SON Coordination Function is informed about the result (successful/unsuccessful, parameters changes) of the executed high-priority SON action. Then, SON Coordination Function will analyse the latest network situation to decide how to deal with the suspended low-priority SON action, for example, resuming or rejecting. + +## --- B.2 Coordination of COC, CCO and ES using priority of SON functions + +To prevent conflicting adjustment from COC, ES and optimization from CCO in the common affected cell(s) (e.g., Cell 2 in the Figure 4.7.3.2), the cell(s) which may need to be coordinated among COC, CCO and ES, i.e., the impact area information, should be known by the SON Coordination Function. By comparing the priorities of COC, CCO and ES, SON Coordination Function will decide to do the highest-priority action and suspend the low-priority actions on the coordinated cell(s). The priorities of COC, CCO and ES can be preset by operator to SON Coordination Function, or SON Coordination Function inquires the default priority of COC, CCO and ES to each of them. + +The cell which needs to be coordinated among COC, CCO and ES is: + +- The cell in which there is coverage or capacity problem and CCO action is needed, meanwhile the cell is outage or compensating or going to compensate for outage or ES; or +- The cell which is located in the CCO optimization analysis area for other cell which has coverage or capacity problem, meanwhile the cell is outage or compensating or going to compensate for outage or ES; + +After the highest-priority SON function executes action, the SON Coordination Function is informed about the result (successful/unsuccessful, parameters changes) of the executed highest-priority SON action. Then, SON Coordination Function will analyse the latest network situation to decide how to deal with the suspended low-priority SON actions, for example, resuming or rejecting. + +## --- B.3 Coordination of COC, CCO and ES based on the cell state + +The following lists the examples of how SON Coordination Function (SCF) can resolve the conflicts between COC, CCO, and ES functions based on cell state. Although not shown, priority may be used to along with the cell state to resolve the conflicts. + +**Possible conflict #1:** COC requests a cell that is compensating an energy saving cell to compensate an outage cell + +**Resolution:** When COC requests SCF that cell A is going to compensate an outaged cell, SCF should check whether cell A is compensating an energy saving cell. If so, SCF should check whether cell A can compensate both the outage cell and the energy saving cell concurrently. If not, the SCF may disallow cell A to compensate an energy saving cell. + +**Possible conflict #2:** COC requests a cell that is being changed or going to be changed by CCO to compensate an outage cell + +**Resolution:** When COC requests SCF that cell A is going to compensate an outaged cell, SCF should check whether CCO is updating parameters to optimize the capacity and coverage of cell A. If so, SCF may not allow cell A to compensate an outaged cell; otherwise SCF should allow cell A to compensate an outage cell. + +**Possible conflict #3:** ES requests a candidate cell that is compensating an outage cell to compensate an energy saving cell + +**Resolution:** When ES request SCF that cell A is to compensate a cell going to enter energy saving, SCF should check the `cOCStatus.state` of cell A. If `cOCStatus.state = cOCCompensating`, SCF should check whether cell A can compensate both the outage cell and the energy saving cell concurrently. If not, the SCF may disallow cell A to compensate an energy saving cell. + +**Possible conflict #4:** ES requests a cell that is being changed or going to be changed by CCO to compensate an energy saving cell + +**Resolution:** When ES requests SCF that cell A is going to compensate a cell going to enter energy saving, SCF should check whether CCO is updating parameters to optimize the capacity and coverage of cell A. If so, SCF may not allow cell A to compensate an energy saving cell; otherwise SCF should allow cell A to compensate an outage cell. + +**Possible conflict #5:** CCO is going to change the configuration parameter of a cell that is compensating an outage cell + +**Resolution:** When CCO requests SCF that cell A is going to change the configuration parameter, SCF should check the `cOCStatus.state` of cell A. If `cOCStatus.state = cOCCompensating`, SCF should disallow cell A to change the configuration parameter. + +# --- Annex C (informative): State diagram for Distributed and EM-centralized Energy Saving Management + +Energy Saving Management “state” attributes are available at various levels: + +- SubNetwork IOC level, via the attribute `esSwitch` defined in the IOC `SonControl`; +- ENBFunction IOC level, via the attribute `esSwitch` defined in the IOC `SonControl`; + +- EUtranGenericCell IOC level, via the locally defined attribute isChangeForEnergySavingAllowed, and via the attribute energySavingState defined in the IOC EnergySavingProperties. + +The following figure provides an overview of Energy Saving Management related IOCs, state attribute names and possible values, for Distributed and EM-centralized Energy Saving Management: + +![UML Class Diagram showing Information Object Classes (IOCs) and their relationships for Energy Saving Management. The diagram includes SubNetwork, SONControl, ENBFunction, ESPolicies, EUtranGenericCell, and EnergySavingProperties. Notes indicate ES-related state attributes: esSwitch (R/M) [On, Off] for SONControl, isChangeForEnergySavingAllowed (R/W) [Yes, No] for EUtranGenericCell, and energySavingState (R) [isEnergySaving, isNotEnergySaving] for EnergySavingProperties.](68a5a1a1a761c652b4b4c56da7cf9914_img.jpg) + +``` + +classDiagram + class SubNetwork["«InformationObjectClass» +TS 32.622::SubNetwork"] + class SONControl["«InformationObjectClass» +TS 32.622::SONControl"] + class ENBFunction["«InformationObjectClass» +TS 32.762::ENBFunction"] + class ESPolicies["«InformationObjectClass» +TS 32.622::ESPolicies"] + class EUtranGenericCell["«InformationObjectClass» +TS 32.762::EUtranGenericCell"] + class EnergySavingProperties["«InformationObjectClass» +TS 32.622::EnergySavingProperties"] + + SubNetwork "1" *-- "0..*" SONControl : «names» + SubNetwork "1" *-- "0..*" ENBFunction : «names» + SONControl "1" *-- "0..*" ESPolicies : «names» + ENBFunction "1" *-- "0..*" ESPolicies : «names» + ENBFunction "1" *-- "0..*" EUtranGenericCell : «names» + EUtranGenericCell "1" *-- "0..*" EnergySavingProperties : «names» + + note right of SONControl: ES-related state attribute: +esSwitch (R/M) [On, Off] + note right of EUtranGenericCell: ES-related state attribute: +isChangeForEnergySavingAllowed (R/W) [Yes, No] + note right of EnergySavingProperties: ES-related state attribute: +energySavingState (R) [isEnergySaving, isNotEnergySaving] + +``` + +UML Class Diagram showing Information Object Classes (IOCs) and their relationships for Energy Saving Management. The diagram includes SubNetwork, SONControl, ENBFunction, ESPolicies, EUtranGenericCell, and EnergySavingProperties. Notes indicate ES-related state attributes: esSwitch (R/M) [On, Off] for SONControl, isChangeForEnergySavingAllowed (R/W) [Yes, No] for EUtranGenericCell, and energySavingState (R) [isEnergySaving, isNotEnergySaving] for EnergySavingProperties. + +**Figure C-1: IOCs and state attributes for Distributed and EM-centralized ESM** + +Dependencies exist between distributed ESM state attributes. The diagram below shows which allowed combinations of attribute state values, and which state transitions, are valid and which are not. + +![State diagram for Distributed and EM-centralized ESM. The diagram shows two main states based on 'esSwitch': 'esSwitch = On' and 'esSwitch = Off'. Each state contains two sub-states based on 'isChangeForEnergySavingAllowed': 'Yes' and 'No'. The 'Yes' sub-states contain 'energySavingState' transitions between 'isEnergySaving' and 'isNotEnergySaving'. The 'No' sub-states contain 'energySavingState = isNotEnergySaving'. Transitions are numbered 1 through 8. A callout 'SubNetwork/ENBFunction' points to the 'esSwitch' attribute. Another callout 'EutranGenericCell' points to the 'isChangeForEnergySavingAllowed' and 'energySavingState' attributes.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +State diagram for Distributed and EM-centralized ESM. The diagram shows two main states based on 'esSwitch': 'esSwitch = On' and 'esSwitch = Off'. Each state contains two sub-states based on 'isChangeForEnergySavingAllowed': 'Yes' and 'No'. The 'Yes' sub-states contain 'energySavingState' transitions between 'isEnergySaving' and 'isNotEnergySaving'. The 'No' sub-states contain 'energySavingState = isNotEnergySaving'. Transitions are numbered 1 through 8. A callout 'SubNetwork/ENBFunction' points to the 'esSwitch' attribute. Another callout 'EutranGenericCell' points to the 'isChangeForEnergySavingAllowed' and 'energySavingState' attributes. + +**Figure C-2: State diagram for Distributed and EM-centralized ESM** + +## **Description:** + +- The ESM-related state attribute *esSwitch* is used by IRPManager to switch on / off the ESM functionality, in the distributed and EM-centralized architectures. This attribute has two possible values: On, Off. It can be set at the sub-network level and at the eNodeB level; +- The ESM-related state attribute *isChangeForEnergySavingAllowed* is used by IRPManager to prohibit or allow configuration changes of cells individually, within a eNodeB / sub-network, for ESM purposes by the IRPAgent. This attribute has two possible values: Yes, No. +- The ESM-related state attribute *energySavingState* is used to reflect the actual status of a cell regarding the energy saving. This attribute has two possible values: *isEnergySaving*, *isNotEnergySaving*. + +Figure C-2 describes the following state transitions: + +- Transition from (*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isNotEnergySaving*) to ((*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isEnergySaving*)): happens when: +ES Policies attached to the subject cell and to candidate for compensation cells, e.g. threshold and duration, are satisfied and allow entering Energy Saving state. +- Transition from (*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isEnergySaving*) to (*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isNotEnergySaving*): happens when: +ES Policies attached to the subject cell and to candidate for compensation cells, e.g. threshold and duration, are satisfied and allow leaving Energy Saving state. +- Transition from (*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes) to (*esSwitch* = On and *isChangeForEnergySavingAllowed* = No and *energySavingState* = *isNotEnergySaving*): happens when: +IRP Manager sets the attribute *isChangeForEnergySavingAllowed* to “No”. + +- 4) Transition from (*esSwitch* = On and *isChangeForEnergySavingAllowed* = No and *energySavingState* = *isNotEnergySaving*) to *isChangeForEnergySavingAllowed* = Yes: happens when: + IRP Manager sets the attribute *isChangeForEnergySavingAllowed* to “Yes”. +- 5) Transition from (*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes) to (*esSwitch* = Off and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isNotEnergySaving*): happens when: + IRP Manager sets the attribute *esSwitch* to “Off”. +- 6) Transition from (*esSwitch* = Off and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isNotEnergySaving*) to (*esSwitch* = On and *isChangeForEnergySavingAllowed* = Yes and *energySavingState* = *isNotEnergySaving*): happens when: + IRP Manager sets the attribute *esSwitch* to “On”. +- 7) Transition from (*esSwitch* = On and *isChangeForEnergySavingAllowed* = No and *energySavingState* = *isNotEnergySaving*) to (*esSwitch* = Off and *isChangeForEnergySavingAllowed* = No and *energySavingState* = *isNotEnergySaving*): happens when: + IRP Manager sets the attribute *esSwitch* to “Off”. +- 8) Transition from (*esSwitch* = Off and *isChangeForEnergySavingAllowed* = No and *energySavingState* = *isNotEnergySaving*) to (*esSwitch* = On and *isChangeForEnergySavingAllowed* = No and *energySavingState* = *isNotEnergySaving*): happens when: + IRP Manager sets the attribute *esSwitch* to “On”. + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|----------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2013-03 | SA#59 | SP-130060 | 001 | - | Rel-11 CR 28.628 SON coordination synchronization with 32.522 | 11.0.0 | 11.1.0 | +| 2013-06 | SA#60 | SP-130304 | 002 | 1 | SON coordination synchronization with 32.522 | 11.1.0 | 11.2.0 | +| | | | 003 | - | Energy saving synchronization with 32.522 | | | +| | | | 004 | - | Correction of attribute constraints | | | +| 2013-09 | SA#61 | SP-130441 | 005 | - | Add missing Object class id for SONPolicy IOCs | 11.2.0 | 11.3.0 | +| 2014-06 | SA#64 | SP-140358 | 007 | - | remove the feature support statements | 11.3.0 | 11.4.0 | +| 2014-09 | | | | | Upgrade to Rel-12 | 11.4.0 | 12.0.0 | +| 2014-12 | SA#66 | SP-140798 | 008 | 1 | Change <i>esState</i> in the Annex C text with the correct name of the attribute | 12.0.0 | 12.1.0 | +| 2015-03 | SA#67 | SP-150063 | 009 | 1 | Add NM centralized Coverage and Capacity Optimization (CCO) logical description | 12.1.0 | 13.0.0 | +| 2015-06 | SA#68 | SP-150320 | 010 | 3 | Add measurements for NM centralized Coverage and Capacity Optimization (CCO) | 13.0.0 | 13.1.0 | +| 2015-09 | SA#69 | SP-150419 | 011 | 1 | Add NM-Centralized CCO related measurements and delete redundant ones | 13.1.0 | 13.2.0 | +| | | | 013 | 1 | Correct coverage hole definition for NM centralized Coverage and Capacity Optimization (CCO) | | | + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|------------------------------------------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-01 | SA#78 | SP-170968 | 0016 | 4 | B | Add SON for AAS deployment management description and attributes | 15.0.0 | +| 2019-03 | SA#83 | SP-190125 | 0017 | - | F | Correction of AAS IP Throughput load rate definition | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | +| 2020-09 | SA#89e | SP-200813 | 0018 | - | F | Modify TOP as parent IOC | 16.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28629/raw.md b/marked/Rel-16/28_series/28629/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8c97db5f9e0963d0a41142ce31420311c12bd8cf --- /dev/null +++ b/marked/Rel-16/28_series/28629/raw.md @@ -0,0 +1,1239 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set definitions..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural Features..... | 8 | +| A.1.0 Introduction ..... | 8 | +| A.1.1 Syntax for Distinguished Names and Versions..... | 8 | +| A.2 Mapping ..... | 8 | +| A.2.1 General mapping ..... | 8 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC SONTargets ..... | 9 | +| A.2.2.2 IOC SONControl ..... | 9 | +| A.2.2.3 IOC ESPolicies ..... | 9 | +| A.2.2.4 IOC EUtranCellSON..... | 10 | +| A.2.2.5 IOC EnergySavingProperties ..... | 10 | +| A.2.2.6 IOC SONFuncInfo..... | 10 | +| A.2.2.7 IOC SONCoordinationPolicies ..... | 10 | +| A.2.2.8 IOC InterRatEsPolicies ..... | 10 | +| A.3 Solution Set definitions ..... | 11 | +| A.3.1 IDL definition structure..... | 11 | +| A.3.2 IDL specification “SONPolicyNetworkResourcesNRMDefs.idl”..... | 11 | +| <b>Annex B (normative): XML definitions.....</b> | <b>16</b> | +| B.0 General..... | 16 | +| B.1 Architectural features..... | 16 | +| B.1.0 Introduction ..... | 16 | +| B.1.1 Syntax for Distinguished Names..... | 16 | +| B.2 Mapping ..... | 16 | +| B.2.1 General mapping ..... | 16 | +| B.2.2 Information Object Class (IOC) mapping..... | 16 | +| B.3 Solution Set definitions ..... | 17 | +| B.3.1 XML definition structure ..... | 17 | +| B.3.2 XML Schema “sonPolicyNrm.xsd”..... | 17 | +| Annex C (informative): Change history..... | 23 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.627: Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.628: Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.629: Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document specifies the Solution Set definitions for the IRP whose semantics is specified in 3GPP TS 28.628 [4] SON Policy Network Resource Model IRP: Information Service (IS). + +This Solution Set definitions specification is related to 3GPP TS 28.628 V15.0.X [4]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 28.628: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [5] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [6] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [8] 3GPP TS 28.623: "Generic network resources Integration Reference Point (IRP); Solution Set (SS) definition". +- [9] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 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 TS 28.628 [4], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and TR 21.905 [1], in that order. + +**XML file:** See definition of [8]. + +**XML document:** See definition of [8]. + +**XML declaration:** See definition of [8]. + +**XML element:** See definition of [8]. + +**empty XML element:** See definition of [8]. + +**XML content (of an XML element):** See definition of [8]. **XML start-tag:** See definition of [8]. + +**XML end-tag:** See definition of [8]. + +**XML empty-element tag:** See definition of [8]. + +**XML attribute specification:** See definition of [8]. + +**DTD:** See definition of [8]. + +**XML schema:** See definition of [8]. + +**XML namespace:** See definition of [8]. + +**XML complex type:** See definition of [8]. + +**XML element type:** See definition of [8]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1], 3GPP TS 28.628 [4] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TS 28.628 [4], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and TR 21.905 [1], in that order. + +| | | +|--------|-------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DTD | Document Type Definition | +| eNodeB | evolved NodeB | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set definitions + +This specification defines the following 3GPP SON Policy NRM IRP Solution Set definitions: + +- 3GPP SON Policy NRM IRP CORBA SS (see Annex A) +- 3GPP SON Policy NRM IRP XML definitions (see Annex B) + +# Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in SON Policy NRM IRP: Information Service (3GPP TS 28.628 [4]). + +## A.1 Architectural Features + +### A.1.0 Introduction + +The overall architectural feature of CS IRP is specified in 3GPP TS 28.628 [4]. + +This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names and Versions + +See clause A.1.1 of [8] + +### A.2 Mapping + +#### A.2.1 General mapping + +See clause A.1.1 of [8] + +#### A.2.2 Information Object Class (IOC) mapping + +#### A.2.2.1 IOC SONTargets + +| IS Attributes | SS Attributes | SS Type | +|-------------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------| +| hoFailureRate | hoFailureRate | GenericSONPolicyNRMAttributeType<br>s:: HooTarget | +| rrcConnection<br>EstablishmentFailure<br>RateCharacteristic | rrcConnection<br>EstablishmentFailure<br>RateCharacteristic | GenericSONPolicyNRMAttributeType<br>s: CacTargetLink | +| rrcConnection<br>AbnormalReleaseRate<br>Characteristic | rrcConnection<br>AbnormalReleaseRate<br>Characteristic | GenericSONPolicyNRMAttributeType<br>s: CacTargetLink | +| eRabSetupFailure<br>RateCharacteristic | eRabSetupFailure<br>RateCharacteristic | GenericSONPolicyNRMAttributeType<br>s: CacTargetLink | +| eRabAbnormalRelease<br>RateCharacteristic | eRabAbnormalRelease<br>RateCharacteristic | GenericSONPolicyNRMAttributeType<br>s: CacTargetLink | +| rachOptAccessProbability | rachOptAccessProbability | GenericSONPolicyNRMAttributeType<br>s: AccessProbabilityROTargetSet | +| rachOptAccessDelayProbability | rachOptAccessDelayProbability | GenericSONPolicyNRMAttributeType<br>s:<br>AccessDelayProbabilityROTargetSet | +| pDCPDataVolumeLoadRate | pDCPDataVolumeLoadRate | GenericSONPolicyNRMAttributeType<br>s: AasTarget | +| iPThroughputLoadRate | iPThroughputLoadRate | GenericSONPolicyNRMAttributeType<br>s: AasTarget | +| activeUEAmountLoadRate | activeUEAmountLoadRate | GenericSONPolicyNRMAttributeType<br>s: AasTarget | + +\*) NOTE 1: At least one of the attributes shall be supported. +\*\*) NOTE 2: Only one of these attributes shall be present. + +#### A.2.2.2 IOC SONControl + +| IS Attributes | SS Attributes | SS Type | +|-----------------------------------------------------------------------------------|----------------|---------| +| hooSwitch | hooSwitch | boolean | +| lboSwitch | lboSwitch | boolean | +| cocSwitch | cocSwitch | boolean | +| esSwitch | esSwitch | boolean | +| roSwitch | roSwitch | boolean | +| aasSplitSwitch | aasSplitSwitch | boolean | +| aasMergeSwitch | aasMergeSwitch | boolean | +| aasShapeSwitch | aasShapeSwitch | boolean | +| NOTE: For all conditional qualifiers, see attribute constraints in TS 28.628 [4]. | | | + +#### A.2.2.3 IOC ESPolicies + +| IS Attributes | SS Attributes | SS Type | +|--------------------------------------------|--------------------------------------------|------------------------| +| esActivationOriginalCellLoadParameters | esActivationOriginalCellLoadParameters | CellLoadParameters | +| esActivationCandidateCellsLoadParameters | esActivationCandidateCellsLoadParameters | CellLoadParameters | +| esDeactivationCandidateCellsLoadParameters | esDeactivationCandidateCellsLoadParameters | CellLoadParameters | +| esNotAllowedTimePeriod | esNotAllowedTimePeriod | ESNotAllowedTimePeriod | + +#### A.2.2.4 IOC EutranCellSON + +| IS Attributes | SS Attributes | SS Type | +|-----------------------------------|-----------------------------------|---------------------------------------------------------------------------| +| maximumDeviationHoTrigger | maximumDeviationHoTrigger | GenericSONPolicyNRMAAttributeTypes::MaximumDeviationHoTriggerType | +| minimumTimeBetweenHoTriggerChange | minimumTimeBetweenHoTriggerChange | GenericSONPolicyNRMAAttributeTypes::MinimumTimeBetweenHoTriggerChangeType | +| alterCovConfig | alterCovConfig | GenericSONPolicyNRMAAttributeTypes::AntennaCovConfigListType | +| replacedCells | replacedCells | GenericSONPolicyNRMAAttributeTypes::CellLocalIDListType | + +#### A.2.2.5 IOC EnergySavingProperties + +| IS Attributes | SS Attributes | SS Type | +|---------------------|---------------------|-----------------------------------------------------------------| +| energySavingState | energySavingState | GenericSONPolicyNRMAAttributeTypes::EnergySavingStateEnumType | +| energySavingControl | energySavingControl | GenericSONPolicyNRMAAttributeTypes::EnergySavingControlEnumType | +| isProbingCapable | isProbingCapable | Boolean | + +#### A.2.2.6 IOC SONFuncInfo + +| IS Attributes | SS Attributes | SS Type | +|----------------------------|----------------------------|---------------------------------------------------------| +| sonFuncCapabilityBelowItfN | sonFuncCapabilityBelowItfN | GenericSONPolicyNRMAAttributeTypes: SonFuncNameListType | + +#### A.2.2.7 IOC SONCoordinationPolicies + +| Attributes | SS Attributes | SS Type | +|------------------------|------------------------|---------------------------------------------------------| +| selectedSonCoordPolicy | selectedSonCoordPolicy | GenericSONPolicyNRMAttributeTypes::SonCoordPoliciesType | +| sonFuncPriorityOrder | sonFuncPriorityOrder | GenericSONPolicyNRMAttributeTypes::SonFuncNameListType | + +A.2.2.8 IOC + +##### InterRatEsPolicies + +| IS Attributes | SS Attributes | SS Type | +|-----------------------------------------------|-----------------------------------------------|----------------------------| +| interRatEsActivationOriginalCellParameters | interRatEsActivationOriginalCellParameters | RelativeCellLoadParameters | +| interRatEsActivationCandidateCellParameters | interRatEsActivationCandidateCellParameters | RelativeCellLoadParameters | +| interRatEsDeactivationCandidateCellParameters | interRatEsDeactivationCandidateCellParameters | RelativeCellLoadParameters | + +## A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 defines the constants and types used by the SON Policy NRM IRP. + +### A.3.2 IDL specification “SONPolicyNetworkResourcesNRMDefs.idl” + +``` +//File:SONPolicyNetworkResourcesNRMDefs.idl +#ifdef _SONPOLICYNETWORKRESOURCESNRMDefs_IDL_ +#define _SONPOLICYNETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#include "TimeBase.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module SONPolicyNetworkResourcesNRMDefs +{ + /* + * Definitions for MO class SONTargets + */ + interface SONTargets: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "SONTargets"; + // Attribute Names + // + const string id = "id"; + const string hoFailureRate = "hoFailureRate"; + const string rrcConnectionEstablishmentFailureRateCharacteristic = +"rrcConnectionEstablishmentFailureRateCharacteristic"; + const string rrcConnectionAbnormalReleaseRateCharacteristic = +"rrcConnectionAbnormalReleaseRateCharacteristic"; + const string eRabSetupFailureRateCharacteristic = "eRabSetupFailureRateCharacteristic"; + const string eRabAbnormalReleaseRateCharacteristic = +"eRabAbnormalReleaseRateCharacteristic"; + const string rachOptAccessProbability = "rachOptAccessProbability"; + const string rachOptAccessDelayProbability = "rachOptAccessDelayProbability"; + const string pDCPDataVolumeLoadRate = "pDCPDataVolumeLoadRate"; + const string iPThroughputLoadRate = "iPThroughputLoadRate"; + const string activeUEAmountLoadRate = "activeUEAmountLoadRate"; + }; + + /* + * Definitions for MO class SONControl + */ + interface SONControl: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "SONControl"; + }; +} +``` + +``` +// Attribute Names +// +const string id = "id"; +const string hooSwitch = "hooSwitch"; +const string lboSwitch = "lboSwitch"; +const string cocSwitch = "cocSwitch"; +const string esSwitch = "esSwitch"; +const string roSwitch = "roSwitch"; +const string aasSwitch = "aasSplitSwitch"; +const string aasSwitch = "aasMergeSwitch"; +const string aasSwitch = "aasShapeSwitch"; +}; + +/* + * Definitions for MO class ESPolicies + */ +interface ESPolicies: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "ESPolicies"; + // Attribute Names + // + const string id = "id"; + const string esActivationOriginalCellLoadParameters = +"esActivationOriginalCellLoadParameters"; + const string esActivationCandidateCellsLoadParameters = +"esActivationCandidateCellsLoadParameters"; + const string esDeactivationCandidateCellsLoadParameters = +"esDeactivationCandidateCellsLoadParameters"; + + const string esNotAllowedTimePeriod = "esNotAllowedTimePeriod"; +}; + +/* + * Definitions for MO class InterRatEsPolicies + */ +interface ESPolicies: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "InterRatEsPolicies"; + // Attribute Names + // + const string id = "id"; + const string interRatEsActivationOriginalCellParameters = +"interRatEsCellActivationOriginalCellParameters"; + const string interRatEsActivationCandidateCellParameters = +"interRatEsActivationCandidateCellParameters"; + const string interRatEsDeactivationCandidateCellParameters = +"interRatEsDeactivationCandidateCellParameters"; + +} + +/* + * Definitions for MO class EUtranCellSON + */ +interface EUtranCellSON: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "EUtranCellSON"; + // Attribute Names + // + const string id = "id"; + const string maximumDeviationHoTrigger = "maximumDeviationHoTrigger"; + const string minimumTimeBetweenHoTriggerChange = "minimumTimeBetweenHoTriggerChange"; + const string alterCovConfig = "AlterCovConfig"; + const string replacedCells = "ReplacedCells"; +}; + +/* + * Definitions for MO class EnergySavingProperties + */ + +interface EnergySavingProperties: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "EnergySavingProperties"; + // Attribute Names + // + const string id = "id"; + const string energySavingState= "energySavingState"; + const string energySavingControl= "energySavingControl"; + const string isProbingCapable = "isProbingCapable"; +} +``` + +``` +}; + +/* + * Definitions for MO class SONFuncInfo + */ +interface SONFuncInfo: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "SONFuncInfo"; + // Attribute Names + // + const string id = "id"; + const string sonFuncCapabilityBelowItfN = "sonFuncCapabilityBelowItfN"; +}; + +/* + * Definitions for MO class SONCoordinationPolicies + */ +interface SONCoordinationPolicies: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "SONCoordinationPolicies"; + // Attribute Names + // + const string id = "id"; + const string selectedSonCoordPolicy = "selectedSonCoordPolicy"; + const string sonFuncPriorityOrder = "sonFuncPriorityOrder"; +}; + +}; + +module GenericSONPolicyNRMAttributeTypes +{ + /* + * Composite Availble Capacity (CAC)target type related to RRC/eRAB setup + */ + struct CacTarget + { + unsigned short lower_end_of_cac_range; + unsigned short upper_end_of_cac_range; + unsigned short target_value; + unsigned short target_weight; + }; + + typedef sequence<CacTarget> CacTargetList; + + struct CacTargetLink + { + CacTargetList uplink_cac_target; + CacTargetList downlink_cac_target; + }; + + /* + * HOO target type + */ + struct HooTarget + { + unsigned short target_value; + unsigned short target_priority; + }; + + typedef sequence<HooTarget> HooTargetList; + + /* + * Cell load parameters type related to energy saving + */ + struct CellLoadParameters + { + unsigned short load_threshold; + unsigned short time_duration; + }; + + /* + + /* + * Cell load parameters type related to energy saving + */ + struct RelativeCellLoadParameters + { + unsigned short relative_load_threshold; + unsigned short time_duration; + }; +} +``` + +``` +}; +/* + +typedef TimeBase::UtcT UTCTime; +struct PeriodOfDay +{ + UTCTime start_time; + UTCTime end_time; +}; + +enum WeekDayType +{ + MONDAY, + TUESDAY, + WEDNESDAY, + THURSDAY, + FRIDAY, + SATURDAY, + SUNDAY +}; + +typedef sequence <WeekDayType> DaysOfWeek; +struct TimePeriodElement +{ + DaysOfWeek days; + PeriodOfDay period_of_day; +}; + +typedef sequence<TimePeriodElement> ESNotAllowedTimePeriod; + +/* + * Rach Optimization target type + */ +enum ROTargetType +{ + RO_ACCESS_PROBABILITY, + RO_ACCESS_DELAY_PROBABILITY +}; + +enum ROProbability +{ + 25percent, + 50percent, + 75percent, + 90percent +}; + +typedef unsigned short (10..560) AccessDelayRange; +typedef unsigned short (1..200) AccessNumberAttemptRange; + +struct accessProbabilityROTarget +{ + ROProbability rOProbability; + AccessNumberAttemptRange attemptNumber; +}; + +struct accessDelayProbabilityROTarget +{ + ROProbability rOProbability; + AccessDelayRange accessDelay; +}; + +typedef sequence <accessProbabilityROTarget,4> AccessProbabilityROTargetSet; +typedef sequence <accessDelayProbabilityROTarget,4> AccessDelayProbabilityROTargetSet; + +union RachOptTarget switch (ROTargetType) +{ + case RO_ACCESS_PROBABILITY: AccessProbabilityROTargetSet aPTargets; + case RO_ACCESS_DELAY_PROBABILITY: AccessDelayProbabilityROTargetSet aDPTargets; +}; + +/* + * Active Antenna System (AAS) Target Type + */ +struct AasTarget +{ + unsigned short target_lower_threshold; + unsigned short target_upper_threshold; + unsigned short target_weight; +}; +``` + +``` +/* + +typedef unsigned short (1..96) MaximumDeviationHoTriggerType; + +typedef unsigned short (0..1440) MinimumTimeBetweenHoTriggerChangeType; + +struct AntennaPowerRange +{ + unsigned short AntennaPowerLowerThreshold; + unsigned short AntennaPowerUpperThreshold; +}; + +struct AntennaCovConfigType +{ + unsigned short stateId; + unsigned short (0..360) horizontalHBW; + unsigned short (0..360) verticalHBW; + AntennaPowerRange maximumTransmissionPowerRange; + AntennaPowerRange referenceSignalPowerRange; +}; + +typedef sequence <AntennaCovConfigType> AntennaCovConfigListType; + +typedef unsigned short (0..255) CellLocalIDType; + +typedef sequence <CellLocalIDType> CellLocalIDListType; + +enum energySavingStateEnumType +{ + IS_ENERGYSAVING, + IS_NOT_ENERGYSAVING +}; + +enum energySavingControlEnumType +{ + TO_BE_ENERGYSAVING, + TO_BE_NOT_ENERGYSAVING +}; + +enum SonFuncNameType +{ + ANR, + HOO, + LBO, + ES, + COC, + CCO, + AAS +}; + +typedef sequence <SonFuncNameType> SonFuncNameListType; + +enum SonCoordPoliciesType +{ + BASE_ON_PRIORITY, + BASE_ON_STATE +}; + +}; + +#endif // _SONPOLICYNETWORKRESOURCESNRMDIFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +The annex specifies the XML definitions for the SON Policy NRM IRP as it applies to Itf-N, in accordance with SON Policy NRM IRP [4]. + +The XML file formats are based on XML [9], XML Schema [10] [11] and XML Namespace [12] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of SON Policy Network Resource Model IRP is specified in 3GPP TS 28.628 [4]. This clause specifies features that are specific to the XML definitions. + +The XML definitions of this document specify the schema for a configuration content. + +When using the XML definitions for a configuration file transfer with the Bulk CM IRP, using either CORBA Solution Set or SOAP Solution Set of 3GPP TS 32.616 [5], the basic part of the XML file format definition is provided by 3GPP TS 32.616 [5]. The XML definitions of this document provide the schema for the configuration content to be included in such a configuration file. + +When using the XML definitions with a SOAP solution set of any interface IRP that perform operations on managed objects, for example the Basic CM IRP SOAP SS of 3GPP TS 32.606 [6], the XML definitions of this document provides the schema for the configuration content operated on by the interface IRP. Such configuration content can be name of managed object and, if applicable, IOC attributes. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [7]. + +## --- B.2 Mapping + +### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +### B.2.2 Information Object Class (IOC) mapping + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [5]. + +Annex A of the present document defines the NRM-specific XML schema `sonPolicyNrm.xsd` for the SON Policy NRM IRP IS defined in 3GPP TS 28.628 [4]. + +XML schema `sonPolicyNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [5]. + +## B.3 Solution Set definitions + +### B.3.1 XML definition structure + +Clause B.3.2 provides XML definitions of SON Policy NRM IRP IOCs as defined in 3GPP TS 28.628 [4]. + +### B.3.2 XML Schema “sonPolicyNrm.xsd” + +The following XML schema sonPolicyNrm.xsd is the NRM-specific schema for the SON Policy Network Resource Model IRP NRM defined in 3GPP TS 28.628 [4]: + +``` +<?xml version="1.1" encoding="UTF-8"?> +<!-- + 3GPP TS 28.629 SON Policy Network Resource Model IRP + XML schema definition + sonPolicyNrm.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.629#sonPolicyNrm" + elementFormDefault="qualified" + attributeFormDefault="unqualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:sp="http://www.3gpp.org/ftp/specs/archive/28_series/28.629#sonPolicyNrm" +> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + + <!--SON Policy NRM IRP IS class associated XML elements --> + + <!-- CAC Range: 0~10000 --> + <simpleType name="cacRange"> + <restriction base="unsignedShort"> + <maxInclusive value="10000"/> + </restriction> + </simpleType> + + <!-- Relative Cell Load Range: 0~10000 --> + <simpleType name="relativeCellLoadRange"> + <restriction base="unsignedShort"> + <maxInclusive value="10000"/> + </restriction> + </simpleType> + + <!--time duration Range: 0-900 --> + <simpleType name="timeDurationRange"> + <restriction base="unsignedShort"> + <maxInclusive value="900"/> + </restriction> + </simpleType> + + <!-- Rate: representing a percentage --> + <simpleType name="rateRange"> + <restriction base="unsignedShort"> + <maxInclusive value="100"/> + </restriction> + </simpleType> + + <!-- RACH Optimization Probability --> + <simpleType name="ROProbability"> + <restriction base="unsignedShort"> + <enumeration value="25"/> + <enumeration value="50"/> + <enumeration value="75"/> + <enumeration value="90"/> + </restriction> + </simpleType> + + <simpleType name="WeekDay"> + <restriction base="string"> + <enumeration value="Monday"/> + <enumeration value="Tuesday"/> + <enumeration value="Wednesday"/> + <enumeration value="Thursday"/> + </restriction> + </simpleType> +</schema> +``` + +``` +<enumeration value="Friday"/> +<enumeration value="Saturday"/> +<enumeration value="Sunday"/> +</restriction> +</simpleType> + +<complexType name="WeekDays"> + <sequence> + <element name="day" type="sp:WeekDay" maxOccurs="7"/> + </sequence> +</complexType> + +<!-- Weight: 1~N. Higher the number, higher the weight --> +<complexType name="LBOTarget"> + <sequence> + <element name="lowerEndOfCacRange" type="sp:cacRange" minOccurs="0"/> + <element name="upperEndOfCacRange" type="sp:cacRange" minOccurs="0"/> + <element name="Rate" type="sp:rateRange" minOccurs="0"/> + <element name="Weight" type="unsignedShort" minOccurs="0"/> + </sequence> +</complexType> + +<complexType name="LBOLinkTarget"> + <sequence> + <element name="UplinkTarget" type="sp:LBOTarget" minOccurs="0"/> + <element name="DownlinkTarget" type="sp:LBOTarget" minOccurs="0"/> + </sequence> +</complexType> + +<complexType name="HooTarget"> + <sequence> + <element name="Rate" type="sp:rateRange" minOccurs="0"/> + <element name="Weight" type="unsignedShort" minOccurs="0"/> + </sequence> +</complexType> + +<complexType name="CellLoadParameters"> + <sequence> + <element name="LoadThreshold" type="sp:rateRange" minOccurs="0"/> + <element name="TimeDuration" type="unsignedShort" minOccurs="0"/> + </sequence> +</complexType> + +<complexType name="RelativeCellLoadParameters"> + <sequence> + <element name="LoadThreshold" type="sp:relativeCellLoadRange"/> + <element name="TimeDuration" type="sp:timeDurationRange"/> + </sequence> +</complexType> + +<!-- Time shall be specified in UTC format --> + +<complexType name="DailyPeriod"> + <sequence> + <element name="StartTime" type="time"/> + <element name="EndTime" type="time"/> + </sequence> +</complexType> + +<complexType name="TimePeriod"> + <sequence> + <element name="Day" type="sp:WeekDays"/> + <element name="PeriodOfDay" type="sp:DailyPeriod"/> + </sequence> +</complexType> + +<!--Time period type in which energy saving is not allowed--> +<complexType name="ESNotAllowedTimePeriod"> + <sequence> + <element name="TimePeriodList" type="sp:TimePeriod"/> + </sequence> +</complexType> + +<simpleType name="AccessDelayRange"> + <restriction base="unsignedShort"> +``` + +``` +<minInclusive value="10"/> +<maxInclusive value="560"/> +</restriction> +</simpleType> + +<complexType name="AccessDelayProbabilityROTarget"> + <sequence> + <element name="Probability" type="sp:ROProbability"/> + <element name="AccessDelay" type="sp:AccessDelayRange"/> + </sequence> +</complexType> + +<complexType name="AccessDelayProbabilityTargetSet"> + <sequence> + <element name="AccessDelayProbabilityTarget" type="sp:AccessDelayProbabilityROTarget" +maxOccurs="4"/> + </sequence> +</complexType> + +<simpleType name="AccessNumberAttemptRange"> + <restriction base="unsignedShort"> + <minInclusive value="1"/> + <maxInclusive value="200"/> + </restriction> +</simpleType> + +<complexType name="AccessProbabilityROTarget"> + <sequence> + <element name="Probability" type="sp:ROProbability"/> + <element name="AccessNumber" type="sp:AccessNumberAttemptRange"/> + </sequence> +</complexType> + +<complexType name="AccessProbabilityTargetSet"> + <sequence> + <element name="AccessProbabilityTarget" type="sp:AccessProbabilityROTarget" maxOccurs="4"/> + </sequence> +</complexType> + +<complexType name="rachOptTarget"> + <choice maxOccurs="4"> + <element name="rachOptAccessProbability" type="sp:AccessProbabilityTargetSet"/> + <element name="rachOptAccessDelayProbability" type="sp:AccessDelayProbabilityTargetSet"/> + </choice> +</complexType> + +<!-- Weight: 1~N. Higher the number, higher the weight --> +<complexType name="AasTarget"> + <sequence> + <element name="TargetLowerThreshold" type="sp:rateRange" minOccurs="0"/> + <element name="TargetUpperThreshold" type="sp:rateRange" minOccurs="0"/> + <element name="Weight" type="unsignedShort" minOccurs="0"/> + </sequence> +</complexType> + +<simpleType name="MaximumDeviationHoTriggerType"> + <restriction base="unsignedShort"> + <minInclusive value="1"/> + <maxInclusive value="96"/> + </restriction> +</simpleType> + +<simpleType name="MinimumTimeBetweenHoTriggerChangeType"> + <restriction base="unsignedShort"> + <maxInclusive value="1440"/> + </restriction> +</simpleType> + +<!-- Cell Local ID Range: 0-255 --> +<simpleType name="CellLocalIDType"> + <restriction base="unsignedShort"> + <maxInclusive value="255"/> + </restriction> +</simpleType> + +<!-- Cell Local ID List --> +``` + +``` +<complexType name="CellLocalIDListType"> + <sequence> + <element name="CellLocalID" type="sp:CellLocalIDType"/> + </sequence> +</complexType> + +<!-- Cell Coverage State Range: 0-15 --> +<simpleType name="CellCovStateType"> + <restriction base="unsignedShort"> + <maxInclusive value="15"/> + </restriction> +</simpleType> + +<!-- Beamwidth Range: 0-360 --> +<simpleType name="Beamwidth"> + <restriction base="unsignedShort"> + <maxInclusive value="360"/> + </restriction> +</simpleType> + +<!-- Antenna transmission Power Range: -60..50 --> +<simpleType name="AntennaPowerType"> + <restriction base="unsignedShort"> + <minInclusive value="-60"/> + <maxInclusive value="50"/> + </restriction> +</simpleType> + +<complexType name="AntennaPowerRangeType"> + <sequence> + <element name="AntennaPowerLowerThreshold" type="sp:AntennaPowerType"/> + <element name="AntennaPowerUpperThreshold" type="sp:AntennaPowerType"/> + </sequence> +</complexType> + +<!-- Antenna coverae configuration --> +<complexType name="AntennaCovConfigType"> + <sequence> + <element name="SateID" type="sp:CellCovStateType "/> + <element name="HorizontalHBW" type="sp:Beanwidth"/> + <element name="VerticalHBW" type="sp:Beanwidth"/> + <element name="MaxTransmissionPowerRange" type="sp:AntennaPowerRangeType"/> + <element name="ReferenceSignalPowerRange" type="sp:AntennaPowerRangeType"/> + </sequence> +</complexType> + +<!-- Antenna coverae configuration List --> +<complexType name="AntennaCovConfigListType"> + <sequence> + <element name="AntennaCovConfig" type="sp:AntennaCovConfigType" maxOccurs="16"/> + </sequence> +</complexType> + +<simpleType name="energySavingStateEnumType"> + <restriction base="string"> + <enumeration value="isEnergySaving"/> + <enumeration value="isNotEnergySaving"/> + </restriction> +</simpleType> + +<simpleType name="energySavingControlEnumType"> + <restriction base="string"> + <enumeration value="toBeEnergySaving"/> + <enumeration value="toBeNotEnergySaving"/> + </restriction> +</simpleType> + +<simpleType name="SonFuncNameType"> + <restriction base="string"> + <enumeration value="anr"/> + <enumeration value="hoo"/> + <enumeration value="lbo"/> + <enumeration value="es"/> + <enumeration value="coc"/> + <enumeration value="cco"/> + <enumeration value="aas"/> + </restriction> +</simpleType> +``` + +``` + +</simpleType> + +<simpleType name="SonCoordPoliciesType"> + <restriction base="string"> + <enumeration value="baseOnPriority"/> + <enumeration value="baseOnState"/> + </restriction> +</simpleType> + +<complexType name="SonFuncNameListType"> + <sequence> + <element name="SonFuncName" type="sp:SonFuncNameType" maxOccurs="unbounded"/> + </sequence> +</complexType> + +<element name="SONTarget"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="hoFailureRate" type="sp:HooTarget" minOccurs="0"/> + <element name="rrcConnectionEstablishmentFailureRate" type="sp:LBOLinkTarget" +minOccurs="0"/> + <element name="rrcConnectionAbnormalReleaseRate" type="sp:LBOLinkTarget" +minOccurs="0"/> + <element name="eRabSetupFailureRate" type="sp:LBOLinkTarget" minOccurs="0"/> + <element name="eRabAbnormalReleaseRate" type="sp:LBOLinkTarget" minOccurs="0"/> + <element name="rachOpt" type="sp:rachOptTarget" minOccurs="0"/> + <element name="pDCPDataVolumeLoadRate" type="sp:Aas Target" minOccurs="0"/> + <element name="iPTThroughputLoadRate" type="sp:AasTarget" minOccurs="0"/> + <element name="activeUEAmountLoadRate" type="sp:Aas Target" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SONControl"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!--Switch:ON/OFF--> + <element name="hooSwitch" type="boolean" minOccurs="0"/> + <element name="lboSwitch" type="boolean" minOccurs="0"/> + <element name="cocSwitch" type="boolean" minOccurs="0"/> + <element name="esSwitch" type="boolean" minOccurs="0"/> + <element name="roSwitch" type="boolean" minOccurs="0"/> + <element name="aasSplit Switch" type="boolean" minOccurs="0"/> + <element name="aasMergeSwitch" type="boolean" minOccurs="0"/> + <element name="aasShapeSwitch" type="boolean" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="ESPPolicies"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + +``` + +``` + + <element name="esActivationOriginalCellLoadParameters" +type="sp:CellLoadParameters" minOccurs="0"/> + <element name="esActivationCandidateCellsLoadParameters" +type="sp:CellLoadParameters" minOccurs="0"/> + <element name="esDeactivationCandidateCellsLoadParameters" +type="sp:CellLoadParameters" minOccurs="0"/> + <element name="esNotAllowedTimePeriod" type="sp:ESNotAllowedTimePeriod"/> + </all> + </complexType> + </element> + </sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="InterRatEsPolicies"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes"> + <complexType> + <all> + <element name="interRatEsActivationOriginalCellParameters" +type="sp:RelativeCellLoadParameters" minOccurs="0"/> + <element name="interRatEsActivationCandidateCellParameters" +type="sp:RelativeCellLoadParameters" minOccurs="0"/> + <element name="interRatEsDeactivationCandidateCellParameters" +type="sp:RelativeCellLoadParameters" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EUTranCellSON"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes"> + <complexType> + <all> + <element name="maximumDeviationHoTrigger" +type="sp:MaximumDeviationHoTriggerType" minOccurs="0"/> + <element name="minimumTimeBetweenHoTriggerChange" +type="sp:MinimumTimeBetweenHoTriggerChangeType" minOccurs="0"/> + <element name="alterCovConfig" +type="sp:AntennaCovConfigListType" minOccurs="0"/> + <element name="replacedCells" +type="sp:CellLocalIDListType" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EnergySavingProperties"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="energySavingState" type="sp:energySavingStateEnumType"/> + <element name="energySavingControl" type="sp:energySavingControlEnumType" +minOccurs="0"/> + <element name="isProbingCapable" type="boolean" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + </element> + </sequence> + </extension> + </complexContent> +</complexType> +</element> + +<element name="SONFuncInfo"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="sonFuncCapabilityBelowItfN" type="sp:SonFuncNameListType"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SONCoordinationPolicies"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="selectedSonCoordPolicy" type="sp:SonCoordPoliciesType" +minOccurs="0"/> + <element name="sonFuncPriorityOrder" type="sp:SonFuncNameListType" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +</schema> +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------|-----|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2013-06 | SA#60 | SP-130304 | 001 | 1 | SON coordination synchronization with 32.526 | F | 11.0. | 11.1. | +| | | | 002 | 1 | Energy saving synchronization with 32.526 | | 0 | 0 | +| 2013-09 | SA#61 | SP-130441 | 003 | 1 | Add missing Object class id for SONPolicy IOCs | F | 11.1.<br>0 | 11.2.<br>0 | +| 2014-06 | SA#64 | SP-140332 | 004 | 1 | upgrade XSD | F | 11.2.<br>0 | 11.3.<br>0 | +| | | SP-140358 | 005 | - | remove the feature support statements | F | | | +| 2014-09 | SA#65 | SP-140560 | 006 | - | Update the link from Solution Set to Information Service due to the end of Release 12 | C | 11.3.<br>0 | 12.0.<br>0 | +| 2015-12 | SA#70 | SP-150691 | 008 | 1 | Align id attribute definitions | A | 12.0.<br>0 | 12.1.<br>0 | +| 2016-01 | | | | | Upgrade to Rel-13(MCC) | | 12.1.<br>0 | 13.0.<br>0 | + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------|-------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2016-06 | SA#72 | SP-160407 | 0012 | - | F | Update the link from IRP Solution Set to IRP Information Service | | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0013 | - | F | Update link from IRP SS to IS | | 14.1.0 | +| 2018-01 | SA#78 | SP-170968 | 0014 | 2 | B | Add SON for AAS management attributes | | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28631/raw.md b/marked/Rel-16/28_series/28631/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..27707215ba85c9c1332066f579067f2e04b12b78 --- /dev/null +++ b/marked/Rel-16/28_series/28631/raw.md @@ -0,0 +1,123 @@ + + + + + + +# --- Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 +- 3.1 Definitions ..... 5 +- 3.2 Abbreviations ..... 5 +- 4 Requirements ..... 6 +- Annex A (informative):Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# Ready for Converged Management + +This specification is part of a set that has been developed for converged management solutions. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 32.690: Inventory Management (IM): Requirements +- 28.631: Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** +- 28.632: Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- 28.633: Inventory Management (IM) Network Resource Model Integration Reference Point (IRP), Solution Set (SS) definitions + +Inventory Management (IM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. IM actions have the objective to monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. The final goal of IM is the establishment of an accurate and timely model of the actual inventory in the NEs or NRs. + +IM actions may be requested to reflect changes initiated by Configuration Management (CM) actions or to make sure that the inventory model is in synch with the actual inventory. IM actions are initiated either as single actions on single NEs of the 3G network or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [3], the requirements for the present IRP: Inventory Management (IM )Network Resource Model (NRM) IRP. + +## --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [6] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**data:** See 3GPP TS 32.600 [3]. + +**IRP:** See 3GPP TS 32.101 [1]. + +**Network Resource Model (NRM):** See 3GPP TS 28.622 [4]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----|-----------------------------| +| EPS | Evolved Packet System | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | +| SON | Self-Organized Network | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- A) IRP-related requirements in 3GPP TS 32.101 [1]. +- B) IRP-related requirements in 3GPP TS 32.102 [2]. +- C) IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- D) Shall support communications for telecommunication network management purposes, including management of converged networks. +- E) Is a member of the Federated Network Information Model (FNIM) [5] and its information is derived from FNIM Umbrella Information Model (UIM) [6] + +In addition to the above, the following more specific requirements apply: + +**REQ-IM\_NRM-CON-001:** The NRM defined by this IRP shall provide inventory data over Itf-N of network entities in the 3G network. + +**REQ-IM\_NRM-CON-002:** The NRM defined by this IRP shall provide inventory data over Itf-N of network entities in the EPS network including those installed by SON functionality. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | 11.0.0 | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28632/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/marked/Rel-16/28_series/28632/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a274159213545e530a1a8279231612dc05dd463e --- /dev/null +++ b/marked/Rel-16/28_series/28632/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2ad2b27f595a14d66e480f3151eefc96c0eb697d105013a83aba1068390d609a +size 38025 diff --git a/marked/Rel-16/28_series/28632/1c94fd3cebf58af136144f14160d128e_img.jpg b/marked/Rel-16/28_series/28632/1c94fd3cebf58af136144f14160d128e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d0220d3379b5759b139ff0b2199aea112f869bb --- /dev/null +++ b/marked/Rel-16/28_series/28632/1c94fd3cebf58af136144f14160d128e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2cf26316b512cab672ed8cfaff189a8eb7a181e09c2414fe8400c0b82af929cb +size 48344 diff --git a/marked/Rel-16/28_series/28632/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/28_series/28632/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b924734142aafa16d221224159225ffad2ee8696 --- /dev/null +++ b/marked/Rel-16/28_series/28632/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f5433e0384c49190c706d3fbe1666a4b66f870b3d99ec9f3289fa6ad7e834f8 +size 69539 diff --git a/marked/Rel-16/28_series/28632/raw.md b/marked/Rel-16/28_series/28632/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0615b720da9829da1cf8cc2daef87f40503b8522 --- /dev/null +++ b/marked/Rel-16/28_series/28632/raw.md @@ -0,0 +1,768 @@ + + + + +Error! No text of specified style in document. + +2 + +Error! No text of specified style in + +# Contents + +Foreword ..... 5 + +Introduction ..... 5 + +1 Scope..... 6 + +2 References..... 6 + +3 Definitions and abbreviations ..... 7 + +3.1 Definitions..... 7 + +3.2 Abbreviations ..... 7 + +4 Model ..... 8 + +4.1 Imported information entities and local labels..... 8 + +4.2 Class diagram..... 8 + +4.2.1 Relationships ..... 8 + +4.2.2 Inheritance ..... 10 + +4.3 Class definitions ..... 11 + +4.3.1 InventoryUnit ..... 11 + +4.3.1.1 Definition ..... 11 + +4.3.1.2 Attributes ..... 11 + +4.3.1.3 Attribute constraints..... 11 + +4.3.1.4 Notifications..... 11 + +4.3.2 InventoryUnitNE ..... 11 + +4.3.2.1 Definition ..... 11 + +4.3.2.2 Attributes ..... 12 + +4.3.2.3 Attribute constraints..... 12 + +4.3.2.4 Notifications..... 12 + +4.3.3 InventoryUnitHw ..... 12 + +4.3.3.1 Definition ..... 12 + +4.3.3.2 Attributes ..... 12 + +4.3.3.3 Attribute constraints..... 13 + +4.3.3.4 Notifications..... 13 + +4.3.4 InventoryUnitSw ..... 13 + +4.3.4.1 Definition ..... 13 + +4.3.4.2 Attributes ..... 13 + +4.3.4.3 Attribute constraints..... 13 + +4.3.4.4 Notifications..... 13 + +4.3.5 InventoryUnitLic ..... 13 + +4.3.5.1 Definition ..... 13 + +4.3.5.2 Attributes ..... 14 + +4.3.5.3 Attribute constraints..... 14 + +4.3.5.4 Notifications..... 14 + +4.3.6 TmaInventoryUnit ..... 14 + +4.3.6.1 Definition ..... 14 + +4.3.6.2 Attributes ..... 14 + +4.3.6.3 Attribute constraints..... 15 + +4.3.6.4 Notifications..... 15 + +4.3.7 AntennaInventoryUnit ..... 15 + +4.3.7.1 Definition ..... 15 + +4.3.7.2 Attributes ..... 15 + +4.3.7.3 Attribute constraints..... 15 + +4.3.7.4 Notifications..... 16 + +4.4 Attribute definitions ..... 17 + +4.4.1 Attribute properties..... 17 + +4.4.2 Constraints ..... 24 + +4.5 Common notifications ..... 24 + +4.5.1 Alarm notifications ..... 24 + +4.5.2 Configuration notifications..... 24 + +Annex A (informative): Change history..... 25 + +Error! No text of specified style in document. + +**4** + +Error! No text of specified style in + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +32.690 Inventory Management (IM): Requirements + +28.631 Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements + +**28.632 Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)** + +28.633 Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +Inventory Management (IM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. IM actions have the objective to monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. The final goal of IM is the establishment of an accurate and timely model of the actual inventory in the NEs or NRs. + +IM actions may be requested to reflect changes initiated by Configuration Management (CM) actions or to make sure that the inventory model is in synch with the actual inventory. IM actions are initiated either as single actions on single NEs of the 3G network or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document specifies the Inventory Management (IM) Network Resource Model (NRM) that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +The present document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 28.662: "Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 28.642: "Telecommunication management; Configuration Management (CM): UTRAN network resources Integration Reference Point (IRP): Network Resource Model (NRM)". +- [7] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [8] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and Definitions". +- [9] Void +- [10] 3GPP TS 28.622: " Generic Network Resource Model (NRM) Integration Reference Point (IRP);Information Service (IS)". +- [11] 3GPP TS 32.690: "Telecommunication management; Inventory Management (IM): Requirements". +- [12] 3GPP TS 25.466: "UTRAN Iuant interface: Application Part". +- [13] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [4] and the following apply: + +**Association:** See definition in TS 28.622 [10]. + +**Managed Element (ME):** See definition in TS 28.622 [10]. + +**Managed Object (MO):** See definition in TS 28.622 [10]. + +**Management Information Model (MIM):** See definition in TS 28.622 [10]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [10]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|-----------------------------------------------------------------| +| DN | Distinguished Name (see 3GPP TS 32.300 [7]) | +| IM | Inventory Management | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| ITU-T | International Telecommunication Union, Telecommunication Sector | +| MIM | Management Information Model | +| MO | Managed Object | +| MOC | Managed Object Class | +| NE | Network Element | +| NM | Network Manager | +| NRM | Network Resource Model | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [7]) | +| TMN | Telecommunications Management Network | +| UML | Unified Modelling Language | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | UMTS Terrestrial Radio Access Network | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|---------------------------------------------------------------|-----------------| +| 28.622 [10], Information Object Class, <i>Top</i> | Top | +| 28.622 [10], Information Object Class, <i>ManagedElement</i> | ManagedElement | +| 28.622 [10], information object class, <i>ManagedFunction</i> | ManagedFunction | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of IOCs that encapsulate information relevant for this service. This clause provides the overview of all information object classes in UML. Subsequent clauses provide more detailed specification of various aspects of these information object classes. + +The inventory NRM contains two alternatives for inventory data modeling. Alternative 1 is for NE structure and hardware inventory. Alternative 2 is an extended version for inventory information modeling consisting of NE structure, hardware, software and license data inventory. + +Alternative 1, hardware inventory model + +![UML Class diagram for Alternative 1 - Inventory Management NRM Containment/Naming and Association diagram. The diagram shows three classes: ManagedElement (from TS 28.622), ManagedFunction (from TS 28.622), and InventoryUnit. ManagedElement is the base class for ManagedFunction and InventoryUnit. ManagedFunction has a 1-to-1 association with InventoryUnit labeled '+relatedFunction'. InventoryUnit has a 1-to-many containment relationship with VsDataContainer (from TS 28.622). Both ManagedElement and InventoryUnit have a 1-to-many association with VsDataContainer labeled '<<names>>'.](1c94fd3cebf58af136144f14160d128e_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + ManagedElement + (from TS 28.622) + } + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction + (from TS 28.622) + } + class InventoryUnit { + <<InformationObjectClass>> + InventoryUnit + } + class VsDataContainer { + <<InformationObjectClass>> + VsDataContainer + } + + ManagedElement <|-- ManagedFunction + ManagedElement <|-- InventoryUnit + ManagedElement "1" *-- "0..*" VsDataContainer : <<names>> + InventoryUnit "1" *-- "0..*" VsDataContainer : <<names>> + ManagedFunction "1" -- "1" InventoryUnit : +relatedFunction + +``` + +UML Class diagram for Alternative 1 - Inventory Management NRM Containment/Naming and Association diagram. The diagram shows three classes: ManagedElement (from TS 28.622), ManagedFunction (from TS 28.622), and InventoryUnit. ManagedElement is the base class for ManagedFunction and InventoryUnit. ManagedFunction has a 1-to-1 association with InventoryUnit labeled '+relatedFunction'. InventoryUnit has a 1-to-many containment relationship with VsDataContainer (from TS 28.622). Both ManagedElement and InventoryUnit have a 1-to-many association with VsDataContainer labeled '<>'. + +NOTE: The listed cardinality numbers represent transient as well as steady-state numbers, and reflect all managed object creation and deletion scenarios. + +**Figure 4.2.1-1: Alternative 1 - Inventory Management NRM Containment/Naming and Association diagram** + +Each IOC instance is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [7] that expresses its containment hierarchy. As an example, the DN of a IOC representing a InventoryUnit could have a format like: + +SubNetwork=Sweden, meContext=MEC-Gbg-1, ManagedElement=RNC-Gbg-1, InventoryUnit=Inv-1. + +Alternative 2, extended model for hardware, software and licence inventory: + +![UML Class diagram showing ManagedElement, InventoryUnitNE, InventoryUnitSw, InventoryUnitHw, InventoryUnitLic, and ManagedFunction classes and their associations.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + ManagedElement + (from TS 28.622) + } + class InventoryUnitNE { + <<SupportIOC>> + InventoryUnitNE + } + class InventoryUnitSw { + <<SupportIOC>> + InventoryUnitSw + } + class InventoryUnitHw { + <<SupportIOC>> + InventoryUnitHw + } + class InventoryUnitLic { + <<SupportIOC>> + InventoryUnitLic + } + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction + (from TS 28.622) + } + + ManagedElement "1" *-- "0..*" InventoryUnitNE : +nEList + ManagedElement "1" *-- "0..*" InventoryUnitSw : +sWList + ManagedElement "1" *-- "0..*" InventoryUnitHw : +hWList + ManagedElement "1" *-- "0..*" InventoryUnitLic : +IICList + InventoryUnitNE "0..*" -- "0..*" InventoryUnitNE : +nEList + InventoryUnitNE "0..*" -- "0..*" InventoryUnitSw : +sWList + InventoryUnitNE "0..*" -- "0..*" InventoryUnitHw : +hWList + InventoryUnitNE "0..*" -- "0..*" InventoryUnitLic : +IICList + InventoryUnitSw "0..*" -- "0..*" InventoryUnitNE : +nEList + InventoryUnitSw "0..*" -- "0..*" InventoryUnitSw : +sWList + InventoryUnitSw "0..*" -- "0..*" InventoryUnitHw : +hWList + InventoryUnitSw "0..*" -- "0..*" InventoryUnitLic : +IICList + InventoryUnitHw "0..*" -- "0..*" InventoryUnitNE : +nEList + InventoryUnitHw "0..*" -- "0..*" InventoryUnitSw : +sWList + InventoryUnitHw "0..*" -- "0..*" InventoryUnitHw : +hWList + InventoryUnitHw "0..*" -- "0..*" InventoryUnitLic : +IICList + InventoryUnitLic "0..*" -- "0..*" InventoryUnitNE : +nEList + InventoryUnitLic "0..*" -- "0..*" InventoryUnitSw : +sWList + InventoryUnitLic "0..*" -- "0..*" InventoryUnitHw : +hWList + InventoryUnitLic "0..*" -- "0..*" InventoryUnitLic : +IICList + InventoryUnitNE "0..*" -- "0..1" ManagedFunction : +mFunction + InventoryUnitSw "0..*" -- "0..1" ManagedFunction : +mFunction + InventoryUnitHw "0..*" -- "0..1" ManagedFunction : +mFunction + InventoryUnitLic "0..*" -- "0..1" ManagedFunction : +mFunction + +``` + +UML Class diagram showing ManagedElement, InventoryUnitNE, InventoryUnitSw, InventoryUnitHw, InventoryUnitLic, and ManagedFunction classes and their associations. + +Figure 4.2.1-2: Alternative 2 - Inventory Management NRM Containment/Naming and Association diagram + +NOTE: Inventory information upload in alternative 2 is done using the FT IRP and related FT IRP notification capabilities + +### 4.2.2 Inheritance + +This subclause depicts the inheritance relationships that exist between IOCs. + +Figure 4.2.2 shows the inheritance hierarchy for the IM NRM. + +![UML Class Diagram showing the inheritance hierarchy for the IM NRM. The hierarchy starts with 'Top' (from TS 28.622) at the root, followed by 'InventoryUnit', which is then inherited by 'AntennaInventoryUnit' and 'TmaInventoryUnit'.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` +classDiagram + class Top { + <<InformationObjectClass>> + Top + (from TS 28.622) + } + class InventoryUnit { + <<InformationObjectClass>> + InventoryUnit + } + class AntennaInventoryUnit { + <<InformationObjectClass>> + AntennaInventoryUnit + } + class TmaInventoryUnit { + <<InformationObjectClass>> + TmaInventoryUnit + } + Top <|-- InventoryUnit + InventoryUnit <|-- AntennaInventoryUnit + InventoryUnit <|-- TmaInventoryUnit +``` + +UML Class Diagram showing the inheritance hierarchy for the IM NRM. The hierarchy starts with 'Top' (from TS 28.622) at the root, followed by 'InventoryUnit', which is then inherited by 'AntennaInventoryUnit' and 'TmaInventoryUnit'. + +**Figure 4.2.2-1: Inventory Management NRM Inheritance Hierarchy** + +## 4.3 Class definitions + +### 4.3.1 InventoryUnit + +#### 4.3.1.1 Definition + +This IOC represents inventory information for an Inventory Unit. + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| inventoryUnitType | M | M | - | - | - | +| vendorUnitFamilyType | CM | M | - | - | - | +| vendorUnitTypeNumber | CM | M | - | - | - | +| versionNumber | O | M | - | - | - | +| vendorName | M | M | - | - | - | +| serialNumber | CM | M | - | - | - | +| dateOfManufacture | O | M | - | - | - | +| dateOfLastService | O | M | - | - | - | +| unitPosition | O | M | - | - | - | +| manufacturerData | O | M | - | - | - | +| <b>Attribute related to role</b> | | | | | | +| relatedFunction | O | M | - | - | - | + +#### 4.3.1.3 Attribute constraints + +| Name | Definition | +|-------------------------------------------|----------------------------| +| vendorUnitFamilyType CM Support Qualifier | The inventory is hardware. | +| vendorUnitTypeNumber CM Support Qualifier | The inventory is hardware. | +| serialNumber CM Support Qualifier | The inventory is hardware. | + +#### 4.3.1.4 Notifications + +There is no notification defined. + +### 4.3.2 InventoryUnitNE + +#### 4.3.2.1 Definition + +This SupportIOC represents the logical and physical structure of the NE. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| neId | M | M | - | - | - | +| customerIdentifier | O | M | - | - | - | +| productName | M | M | - | - | - | +| vendorName | M | M | - | - | - | +| productType | O | M | - | - | - | +| salesUniqueId | O | M | - | - | - | +| operatorUniqueName | O | M | - | - | - | +| siteId | O | M | - | - | - | +| additionalInformation | O | M | - | - | - | +| <b>Attribute related to role</b> | | | | | | +| mFunction | O | M | - | - | - | +| liCList | O | M | - | - | - | +| hwList | O | M | - | - | - | +| swList | O | M | - | - | - | + +#### 4.3.2.3 Attribute constraints + +None. + +#### 4.3.2.4 Notifications + +There is no notification defined. + +### 4.3.3 InventoryUnitHw + +#### 4.3.3.1 Definition + +This SupportIOC represents the hardware components. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| hwId | M | M | - | - | - | +| hwType | M | M | - | - | - | +| hwName | O | M | - | - | - | +| hwVersion | M | M | - | - | - | +| vendorName | O | M | - | - | - | +| salesUniqueId | O | M | - | - | - | +| hwUnitLocation | M | M | - | - | - | +| model | O | M | - | - | - | +| hwCapability | O | M | - | - | - | +| modificationDate | O | M | - | - | - | +| manualDataEntry | O | M | - | - | - | +| additionalInformation | O | M | - | - | - | +| <b>Attribute related to role</b> | | | | | | +| mFunction | O | M | - | - | - | +| liCList | O | M | - | - | - | +| nEList | O | M | - | - | - | +| swList | O | M | - | - | - | + +#### 4.3.3.3 Attribute constraints + +None. + +#### 4.3.3.4 Notifications + +There is no notification defined. + +### 4.3.4 InventoryUnitSw + +#### 4.3.4.1 Definition + +This SupportIOC represents the software components. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| swId | M | M | - | - | - | +| swName | O | M | - | - | - | +| swVersion | O | M | - | - | - | +| vendorName | O | M | - | - | - | +| salesUniqueId | O | M | - | - | - | +| classification | M | M | - | - | - | +| swStatus | O | M | - | - | - | +| swInstallationTime | O | M | - | - | - | +| swActivationTime | O | M | - | - | - | +| additionalInformation | O | M | - | - | - | +| Attribute related to role | | | | | | +| mFunction | O | M | - | - | - | +| lICList | O | M | - | - | - | +| nEList | O | M | - | - | - | +| hWList | O | M | - | - | - | + +#### 4.3.4.3 Attribute constraints + +None. + +#### 4.3.4.4 Notifications + +There is no notification defined. + +### 4.3.5 InventoryUnitLic + +#### 4.3.5.1 Definition + +This SupportIOC represents the licence components. + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| licId | M | M | - | - | - | +| licType | O | M | - | - | - | +| vendorName | O | M | - | - | - | +| validity | O | M | - | - | - | +| key | O | M | - | - | - | +| licStatus | O | M | - | - | - | +| licActivationTime | O | M | - | - | - | +| salesUniqueId | O | M | - | - | - | +| additionalInformation | O | M | - | - | - | +| <b>Attribute related to role</b> | | | | | | +| mFunction | O | M | - | - | - | +| sWList | O | M | - | - | - | +| nELList | O | M | - | - | - | +| hWList | O | M | - | - | - | + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +There is no notification defined. + +### 4.3.6 TmaInventoryUnit + +#### 4.3.6.1 Definition + +This IOC represents inventory information for a Tower Mounted Amplifier Unit. + +#### 4.3.6.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------------------|-------------------|------------|------------|-------------|--------------| +| tmaNumberOfNon-LinearGainValues | CM | M | - | - | - | +| tmaNon-LinearGainValue | CM | M | O | - | - | +| tmaAdditionalDataFieldNumber | CO | M | O | - | - | +| tmaAntennaModelNumber | CO | M | O | - | - | +| tmaAntennaOperatingBands | CO | M | O | - | - | +| tmaBeamwidthForEachOpBandInBandOrder | CO | M | O | - | - | +| tmaGainForEachOpBandInBandOrder | CO | M | O | - | - | +| tmaInstallationDate | CO | M | O | - | - | +| tmaInstallersId | CO | M | O | - | - | +| tmaMaxSupportedGain | CO | M | O | - | - | +| tmaMinSupportedGain | CO | M | O | - | - | + +#### 4.3.6.3 Attribute constraints + +| Name | Definition | +|-----------------------------------------------------------|-------------------------------------------| +| tmaNumberOfNon-LinearGainValues CM Support Qualifier | It is supported over the luant interface. | +| tmaNon-LinearGainValue CM Support Qualifier | It is supported over the luant interface. | +| tmaAdditionalDataFieldNumber CO Support Qualifier | It is supported over the luant interface. | +| tmaAntennaModelNumber CO Support Qualifier | It is supported over the luant interface. | +| tmaAntennaOperatingBands CO Support Qualifier | It is supported over the luant interface. | +| tmaBeamwidthForEachOpBandInBandOrder CO Support Qualifier | It is supported over the luant interface. | +| tmaGainForEachOpBandInBandOrder CO Support Qualifier | It is supported over the luant interface. | +| tmaInstallationDate CO Support Qualifier | It is supported over the luant interface. | +| tmaInstallersId CO Support Qualifier | It is supported over the luant interface. | +| tmaMaxSupportedGain CO Support Qualifier | It is supported over the luant interface. | +| tmaMinSupportedGain CO Support Qualifier | It is supported over the luant interface. | + +#### 4.3.6.4 Notifications + +There is no notification defined. + +### 4.3.7 AntennalInventoryUnit + +#### 4.3.7.1 Definition + +This IOC represents inventory information for an Antenna Unit. + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------|-------------------|------------|------------|-------------|--------------| +| maxTiltValue | CO | M | O | - | - | +| minTiltValue | CO | M | O | - | - | +| mechanicalOffset | CO | M | O | - | - | +| baseElevation | CO | M | O | - | - | +| latitude | CO | M | O | - | - | +| longitude | CO | M | O | - | - | +| patternLabel | CO | M | O | - | - | + +#### 4.3.7.3 Attribute constraints + +| Name | Definition | +|---------------------------------------|-------------------------------------------| +| maxTiltValue CO Support Qualifier | It is supported over the luant interface. | +| minTiltValue CO Support Qualifier | It is supported over the luant interface. | +| mechanicalOffset CO Support Qualifier | It is supported over the luant interface. | +| baseElevation CO Support Qualifier | It is supported over the luant interface. | +| latitude CO Support Qualifier | It is supported over the luant interface. | +| longitude CO Support Qualifier | It is supported over the luant interface. | +| patternLabel CO Support Qualifier | It is supported over the luant interface. | + +#### 4.3.7.4 Notifications + +There is no notification defined. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table defines the attributes that are present in several Information Object Classes of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| baseElevation | The elevation in meters above sea level at the base of the antenna structure. This value, when subtracted from height (see TS 28.662 [5]), provides the height of the antenna above the ground.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behavior is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iuant interface according to Ref. 3GPP TS 25.466 [12].<br><br>allowedValues: An integral value representing a number of meters in 0.1 meter increments. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| additionalInformation | Supplementary information about inventory data (if any)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| classification | Name of installed SW (e.g. SW release, SW build, SW patches)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| customerIdentifier | Unique identification of a vendors' customer<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| dateOfManufacture | Date of Manufacture of inventory unit.<br><br>allowedValues: N/A | type: DateTime<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| dateOfLastService | Date of last service or repair of inventory unit.<br><br>allowedValues: N/A | type: DateTime<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hwCapability | Hardware capability e.g. capacity, size (empty value is possible)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hwName | Mnemonic of hw inventory unit family type (e.g. Fan, PSU) assigned by vendor.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hwType | Type of the HW unit e.g. equipment holder, carriage<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hwUnitLocation | Unique physical / logical location identifier within NE<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| | | | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| hwVersion | Version / revision no. of current unit e.g. firmware version (empty value possible in case no versioning is available)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| inventoryUnitId | An attribute whose 'name+value' can be used as an RDN when naming an instance of this object class. This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| inventoryUnitType | Type of inventory unit (see TS 32.690 [11])<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| key | License activation key according to the used licensing system<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| licActivationTime | It indicates the date and time when the license was activated.<br><br>allowedValues: All values indicating valid time. | type: DateTime<br>multiplicity: 0..1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| licId | Unique identifier of a license (e.g. name, code)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| licStatus | License status – applicable only for managed licenses (e.g. scheduled, valid, expired, invalid, capacity violated)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| licType | Describing type of current license (e.g. capacity, particular feature, no. of subscribers)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| manualDataEntry | Indicates whether unit is passive (manual insertion of inventory data is needed) or active (inventory data can be read from the unit)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| | | | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| latitude | The latitude of the antenna location based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to the northern hemisphere.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behavior is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iuant interface according to Ref. 3GPP TS 25.466 [12].<br><br>allowedValues: Valid values described in 3GPP TS 23.032 [13]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| longitude | The longitude of the antenna location based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to degrees east of 0 degrees longitude.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behavior is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iuant interface according to Ref. 3GPP TS 25.466 [12].<br><br>allowedValues: Valid values described in 3GPP TS 23.032 [13]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| manufacturerData | Manufacturer specific data of inventory unit.<br><br>allowedValues: N/A | type: DateTime<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| model | Equipment configuration, e.g. standard hardware unit or a variant that may contain additional disk capacity (empty value possible)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| modificationDate | Date/time stamp of last change (e.g. repair action)<br><br>allowedValues: N/A | type: DateTime<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| neId | Vendor defined unique identifier of a logical or physical network element unit<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| operatorUniqueName | Unique NE identifier used by operator<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| productName | NE name classifying a vendor's product family or function<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| | | | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| productType | Identifier of the e.g. platform, in case the product can be based on different HW/SW platforms (not used for logical NEs)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| salesUniqueId | Unique identifier used by vendor (used e.g. for ordering a new unit)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hwId | Hardware identifier allocated by the vendor, e.g. the serial number<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| maxTiltValue | The maximum amount of tilt the RET system can support. Note: See "Maximum supported tilt" in Ref. 3GPP TS 25.466 [12].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| mechanicalOffset | This is a value representing a non-adjustable tilt value, which is imparted to the antenna due to the physical installation.<br>The actual tilt at any point in time is the summation of mechanicalOffset and retTiltValue.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behavior is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iuant interface according to Ref. 3GPP TS 25.466 [12].<br>A single integral value corresponding to an angle in degrees between 0 and 360 with a resolution of 0.1 degrees.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| minTiltValue | The minimum amount of tilt the RET system can support. Note: See "Minimum supported tilt" in Ref. 3GPP TS 25.466 [12].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| patternLabel | The pattern name is a textual, alpha-numeric string to allow identification of the antenna pattern along with the antenna vendor information such as model number, etc.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behavior is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iuant interface according to Ref. 3GPP TS 25.466 [12].<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| serialNumber | Serial number of inventory unit.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| | | | +|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| siteId | NE site in customer network<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| swActivationTime | It indicates the date and time when the software was activated.<br><br>allowedValues: All values indicating valid time. | type: DateTime<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| swId | Unique identifier of a SW unit<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| swName | Software release name used<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| swInstallationTime | It indicates the date and time when the software installation process ended and the software was installed.<br><br>allowedValues: All values indicating valid time. | type: DateTime<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| swStatus | Status of the SW unit (e.g. installed, archived)<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| swVersion | Version identifier of the software unit<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaAdditionalDataFieldNumber | This attribute identifies a standard data field which has no operational impact. Used by the procedures SetDeviceData and GetDevicedata. Defined in Table B.3 of 3GPP TS 25.466 [12].<br><br>allowedValues: See TS 25.466 [12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaAntennaModelNumber | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br><br>allowedValues: See TS 25.466 [12]. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaAntennaOperatingBands | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br><br>allowedValues: See TS 25.466 [12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| | | | +|--------------------------------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| tmaBeamwidthForEachOpBandInBandOrder | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: BitString<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaGainForEachOpBandInBandOrder | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: BitString<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaInstallationDate | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaInstallersId | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaMaxSupportedGain | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaMinSupportedGain | A data field defined in Table B.3 of 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaNon-LinearGainValue | Defined in 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaNumberOfNon-LinearGainValues | Defined in 3GPP TS 25.466 [12].<br>allowedValues: See TS 25.466 [12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| | | | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| unitPosition | <p>Position of inventory unit (e.g. Rack, shelf, slot, etc.).</p> <p>Depending on the implementation of the inventory unit in the managed system, the value and meaning of this attribute may vary.</p> <p>For example, if a system has three levels and types of inventory units representing Rack, Shelf and Slot respectively (i.e. the Managed Element contains multiple Rack inventory units, each Rack inventory unit contains multiple Shelf inventory units and each Shelf inventory unit contains multiple Slot inventory units), then for this example:</p> <ul style="list-style-type: none"> <li>- for the Inventory Unit representing a Rack, the Frame Identification code may be used as the value of this attribute;</li> <li>- for the Inventory Unit representing a Shelf, the Rack Shelf code may be used as the value of this attribute;</li> <li>- for the Inventory Unit representing a Slot, the position code may be used as the value of this attribute.</li> </ul> <p>allowedValues: N/A</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| validity | <p>License validity which may include one of the elements duration, end (expiration date) or forever</p> <p>allowedValues: N/A</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| vendorName | <p>Name of inventory unit vendor (or vendors may provide manufacturer name)</p> <p>allowedValues: N/A</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| vendorUnitFamilyType | <p>Mnemonic of inventory unit family type (e.g. Fan, PSU) assigned by vendor.</p> <p>allowedValues: N/A</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| vendorUnitTypeNumber | <p>A vendor/manufacturer defined and assigned number which uniquely identifies the unit type and optionally for backward compatibility reasons only, also version (used for replacing HW units, spares).</p> <p>allowedValues: N/A</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| versionNumber | <p>The version information related to vendorUnitTypeNumber.</p> <p>allowedValues: N/A</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: True</p> | +| <b>Attribute related to role</b> | | | +| hwList | <p>This attribute carries the set of DN(s) of related InventoryUnitHw(s).</p> <p>allowedValues: N/A</p> | <p>type: DN</p> <p>multiplicity: 1..*</p> <p>isOrdered: False</p> <p>isUnique: True</p> <p>defaultValue: None</p> <p>isNullable: True</p> | + +| | | | +|-----------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| liCList | This attribute carries the set of DN(s) of related InventoryUnitLic(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| mFunction | This attribute carries the DN of related ManagedFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| nEList | This attribute carries the set of DN(s) of related InventoryUnitNE(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| relatedFunction | This attribute carries the DN of related ManagedFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| sWList | This attribute carries the set of DN(s) of related InventoryUnitSw(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +None. + +### 4.5.2 Configuration notifications + +None. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +|---------|-------|-----------|-----|-----|----------------------------------------------------|--------|---------------| +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | 11.0. | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | <b>12.0.0</b> | +| 2014-10 | | | | | Editorial correction: removal of hidden text (MCC) | 12.0.0 | <b>12.0.1</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.1 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | SA#78 | SP-170964 | 0004 | 1 | F | Remove unused reference | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28633/raw.md b/marked/Rel-16/28_series/28633/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b5fcc90002371b84ea29684eab90d8e2ca953360 --- /dev/null +++ b/marked/Rel-16/28_series/28633/raw.md @@ -0,0 +1,594 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------------|----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set definitions ..... | 6 | +| <b>Annex A (normative): XML definitions.....</b> | <b>7</b> | +| A.0 General..... | 7 | +| A.1 Architectural features..... | 7 | +| A.1.0 Introduction ..... | 7 | +| A.1.1 Syntax for Distinguished Names..... | 7 | +| A.2 Mapping ..... | 7 | +| A.3 Solution Set definitions ..... | 7 | +| A.3.1 XML definition structure ..... | 7 | +| A.3.2 XML schema "inventoryNrm.xsd" ..... | 8 | +| A.3.3 XML schema "inventoryNrmAlt2.xsd" ..... | 10 | +| Annex B (informative): Change history..... | 13 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 32.690: Inventory Management (IM); Requirements. +- 28.631: Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.632: Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.633: Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +Inventory Management (IM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. IM actions have the objective to monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. The final goal of IM is the establishment of an accurate and timely model of the actual inventory in the NEs or NRs. + +The present document covers the Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions. + +# --- 1 Scope + +The present document provides the NRM-specific part related to the Inventory Management NRM IRP IS in 3GPP TS 28.632 [1] of solution set definitions. + +This Solution Set definitions specification is related to 3GPP TS 28.632 V 14.0.X [1]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 28.632: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [2] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [3] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [4] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [5] Void +- [6] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [7] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [8] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [9] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [10] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)". +- [11] 3GPP TS 28.623: "Generic network resources Integration Reference Point (IRP); Solution Set (SS) definition". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**XML file:** See definition of [11]. + +**XML document:** See definition of [11]. + +**XML declaration:** See definition of [11]. + +**XML element:** See definition of [11]. + +**empty XML element:** See definition of [11]. + +**XML content (of an XML element):** See definition of [13]. + +**XML start-tag:** See definition of [11]. + +**XML end-tag:** See definition of [11]. + +**XML empty-element tag:** See definition of [11]. + +**XML attribute specification:** See definition of [11]. + +**DTD:** See definition of [11]. + +**XML schema:** See definition of [11]. + +**XML namespace:** See definition of [11]. + +**XML complex type:** See definition of [11]. + +**XML element type:** See definition of [11]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|-------------------------------------------| +| CORBA | Common Object Request Broker Architecture | +| DTD | Document Type Definition | +| IM | Inventory Management | +| IRP | Integration Reference Point | +| IS | Information Service | +| NRM | Network Resource Model | +| XML | eXtensible Markup Language | +| XSD | XML Schema Definition | + +# --- 4 Solution Set definitions + +This specification defines the following 3GPP Inventory Management (IM) Network Resource Model (NRM) IRP Solution Set (SS) definitions: + +- 3GPP Inventory Management (IM) Network Resource Model (NRM) IRP XML definitions (Annex A) + +CORBA Solution Set is not present in the current version of this specification. + +# --- Annex A (normative): XML definitions + +## A.0 General + +This annex provides the NRM-specific part related to the Inventory Management NRM IRP IS in 3GPP TS 28.632 [1] of the XML file format definition for the Bulk Configuration Management IRP IS in 3GPP TS 32.612 [2] as well as for use with File Transfer IRP [10]. + +The XML file formats are based on XML [4], XML Schema [6] [7] and XML Namespace [8] standards. + +## --- A.1 Architectural features + +### A.1.0 Introduction + +The overall architectural feature of Inventory Management NRM IRP IS is specified in 3GPP TS 28.632 [1]. + +This clause specifies features that are specific to the XML Schema definitions. + +### A.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [9]. + +## --- A.2 Mapping + +The mapping is not present in the current version of this specification. + +## --- A.3 Solution Set definitions + +### A.3.1 XML definition structure + +The overall description of the file format of inventory data XML files is provided by 3GPP TS 32.616 [3]. + +A.3.2 defines the NRM-specific XML schema `inventoryNrm.xsd` for the Inventory Management NRM IRP IS alternative 1 defined in 3GPP TS 28.632 [1]. + +A.3.3 defines the NRM-specific XML schema `inventoryNrmAlt2.xsd` for the Inventory Management NRM IRP IS alternative 2 as defined in 3GPP TS 28.632 [1]. + +XML schema `inventoryNrmAlt1.xsd` and `inventoryNrmAlt2.xsd` explicitly declare NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [3]. + +### A.3.2 XML schema "inventoryNrm.xsd" + +The following XML schema `inventoryNrm.xsd` is the NRM-specific schema for the Inventory Management NRM IRP IS alternative 1 defined in 3GPP TS 28.632 [1]. + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.633 Inventory Management NRM IRP + Inventory data file NRM-specific XML schema + inventoryNrm.xsd +--> +``` + +``` +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.633#inventoryNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:in= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.633#inventoryNrm" +> + + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + /> + + <!-- Inventory Management Alternative 1 NRM IRP NRM class associated XML elements --> + <simpleType name="eightOctetsType"> + <restriction base="hexBinary"> + <length value="8"/> + </restriction> + </simpleType> + <simpleType name="fourOctetsType"> + <restriction base="hexBinary"> + <length value="4"/> + </restriction> + </simpleType> + <simpleType name="angleValueType"> + <restriction base="short"> + <minInclusive value="0"/> + <maxInclusive value="3600"/> + </restriction> + </simpleType> + + <element + name="InventoryUnit" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element + name="attributes" + minOccurs="0"> + <complexType> + <all> + <element + name="inventoryUnitType" + type="string" + /> + <element + name="vendorUnitFamilyType" + type="string" + minOccurs="0" + /> + <element + name="vendorUnitTypeNumber" + type="string" + minOccurs="0" + /> + <element + name="vendorName" + type="string"/> + <element + name="serialNumber" + type="string" + minOccurs="0"/> + <element + name="dateOfManufacture" + type="date" + minOccurs="0"/> + <element + name="dateOfLastService" + type="date" + minOccurs="0"/> + <element +``` + +``` + + name="unitPosition" + type="string" + minOccurs="0"/> + <element + name="manufacturerData" + type="string" + minOccurs="0"/> + <element + name="versionNumber" + type="string" + minOccurs="0"/> + <element name="relatedFunction" type="xn:dn" minOccurs="0"/> + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="in:InventoryUnit"/> + <element ref="xn:VsDataContainer"/> + <element ref="in:TmaInventoryUnit"/> + <element ref="in:AntennaInventoryUnit"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="TmaInventoryUnit" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from InventoryUnit--> + <element name="inventoryUnitType" type="string"/> + <element name="vendorUnitFamilyType" type="string" minOccurs="0"/> + <element name="vendorUnitTypeNumber" type="string" minOccurs="0"/> + <element name="vendorName" type="string"/> + <element name="serialNumber" type="string" minOccurs="0"/> + <element name="dateOfManufacture" type="date" minOccurs="0"/> + <element name="dateOfLastService" type="date" minOccurs="0"/> + <element name="unitPosition" type="string" minOccurs="0"/> + <element name="manufacturerData" type="string" minOccurs="0"/> + <element name="versionNumber" type="string" minOccurs="0"/> + <element name="relatedFunction" type="xn:dn" minOccurs="0"/> + <!-- End of inherited attributes from InventoryUnit --> + <element name="tmaNumberOfNonLinearGainValues" type="short" minOccurs="0"/> + <element name="tmaNonLinearGainValue" type="short" minOccurs="0"/> + <element name="tmaAdditionalDataFieldNumber" type="short" minOccurs="0"/> + <element name="tmaAntennaModelNumber" type="string" minOccurs="0"/> + <element name="tmaAntennaOperatingBands" type="short" minOccurs="0"/> + <element name="tmaBeamwidthForEachOpBandInBandOrder" type="in:eightOctetsType" +minOccurs="0"/> + <element name="tmaGainForEachOpBandInBandOrder" type="in:fourOctetsType" +minOccurs="0"/> + <element name="tmaInstallationDate" type="string" minOccurs="0"/> + <element name="tmaInstallersId" type="string" minOccurs="0"/> + <element name="tmaMaxSupportedGain" type="short" minOccurs="0"/> + <element name="tmaMinSupportedGain" type="short" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="in:InventoryUnit"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="AntennaInventoryUnit" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + +``` + +``` + +<element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from InventoryUnit--> + <element name="inventoryUnitType" type="string"/> + <element name="vendorUnitFamilyType" type="string" minOccurs="0"/> + <element name="vendorUnitTypeNumber" type="string" minOccurs="0"/> + <element name="vendorName" type="string"/> + <element name="serialNumber" type="string" minOccurs="0"/> + <element name="dateOfManufacture" type="date" minOccurs="0"/> + <element name="dateOfLastService" type="date" minOccurs="0"/> + <element name="unitPosition" type="string" minOccurs="0"/> + <element name="manufacturerData" type="string" minOccurs="0"/> + <element name="versionNumber" type="string" minOccurs="0"/> + <element name="relatedFunction" type="xn:dn" minOccurs="0"/> + <!-- End of inherited attributes from InventoryUnit--> + <element name="maxTiltValue" type="in:angleValueType" minOccurs="0"/> + <element name="minTiltValue" type="in:angleValueType" minOccurs="0"/> + <element name="mechanicalOffset" type="in:angleValueType" minOccurs="0"/> + <element name="baseElevation" type="integer" minOccurs="0"/> + <element name="latitude" type="decimal" minOccurs="0"/> + <element name="longitude" type="decimal" minOccurs="0"/> + <element name="patternLabel" type="string" minOccurs="0"/> + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="in:InventoryUnit"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +</schema> + +``` + +### A.3.3 XML schema "inventoryNrmAlt2.xsd" + +The following XML schema inventoryNrmAlt2.xsd is the NRM-specific schema for the Inventory Management NRM IRP IS alternative 2 defined in 3GPP TS 28.632 [1]. + +``` + +<?xml version="1.1" encoding="UTF-8"?> +<!-- + 3GPP TS 28.633 Inventory Management NRM IRP + Inventory data file NRM-specific XML schema + inventoryNrmAlt2.xsd +--> +<schema xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:in="http://www.3gpp.org/ftp/specs/archive/28_series/28.633#inventoryNrmAlt2" + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.633#inventoryNrmAlt2" + elementFormDefault="qualified"> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + <!-- Inventory Management Alternative 2 NRM IRP NRM class associated XML elements --> + <element name="InventoryUnitNE" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="neId" type="string"/> + <element name="customerIdentifier" type="string" minOccurs="0"/> + <element name="productName" type="string"/> + <element name="vendorName" type="string"/> + <element name="productType" type="string" minOccurs="0"/> + <element name="salesUniqueId" type="string" minOccurs="0"/> + <element name="operatorUniqueName" type="string" minOccurs="0"/> + <element name="siteId" type="integer" minOccurs="0"/> + <element name="additionalInformation" type="string" +minOccurs="0"/> + <element name="hWList" type="xn:dnList" minOccurs="0"/> + <element name="sWList" type="xn:dnList" minOccurs="0"/> + <element name="lICList" type="xn:dnList" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> + </element> +</schema> + +``` + +``` + + <element name="mFunction" type="xn:dn" minOccurs="0"/> + </all> + </complexType> +</element> +<element ref="in:InventoryUnitNE" minOccurs="0" maxOccurs="unbounded"/> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="InventoryUnitHw" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="hwId" type="string"/> + <element name="hwType" type="string"/> + <element name="hwName" type="string" minOccurs="0"/> + <element name="vendorName" type="string" minOccurs="0"/> + <element name="hwVersion" type="string"/> + <element name="salesUniqueId" type="string" minOccurs="0"/> + <element name="hwUnitLocation" type="string"/> + <element name="model" type="string" minOccurs="0"/> + <element name="hwCapability" type="string" minOccurs="0"/> + <element name="modificationDate" type="string" minOccurs="0"/> + <element name="manualDataEntry" type="string" minOccurs="0"/> + <element name="additionalInformation" type="string" minOccurs="0"/> + + <element name="nEList" type="xn:dnList" minOccurs="0"/> + <element name="sWList" type="xn:dnList" minOccurs="0"/> + <element name="lICList" type="xn:dnList" minOccurs="0"/> + <element name="mFunction" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <element ref="in:InventoryUnitHw" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="InventoryUnitSw" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="swId" type="string"/> + <element name="swName" type="string" minOccurs="0"/> + <element name="vendorName" type="string" minOccurs="0"/> + <element name="swVersion" type="string" minOccurs="0"/> + <element name="salesUniqueId" type="string" minOccurs="0"/> + <element name="classification" type="string"/> + <element name="swInstallationTime" type="dateTime" minOccurs="0"/> + + <element name="swActivationTime" type="dateTime" minOccurs="0"/> + <element name="swStatus" type="string" minOccurs="0"/> + <element name="additionalInformation" type="string" minOccurs="0"/> + + <element name="nEList" type="xn:dnList" minOccurs="0"/> + <element name="hWList" type="xn:dnList" minOccurs="0"/> + <element name="lICList" type="xn:dnList" minOccurs="0"/> + <element name="mFunction" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <element ref="in:InventoryUnitSw" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` +</element> +<element name="InventoryUnitLic" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="licId" type="string"/> + <element name="licType" type="string" minOccurs="0"/> + <element name="vendorName" type="string" minOccurs="0"/> + <element name="validity" type="string" minOccurs="0"/> + <element name="key" type="string" minOccurs="0"/> + <element name="licActivationTime" type="dateTime" +minOccurs="0"/> + <element name="licStatus" type="string" minOccurs="0"/> + <element name="salesUniqueId" type="string" minOccurs="0"/> + <element name="additionalInformation" type="string" +minOccurs="0"/> + <element name="nELList" type="xn:dnList" minOccurs="0"/> + <element name="hWList" type="xn:dnList" minOccurs="0"/> + <element name="sWList" type="xn:dnList" minOccurs="0"/> + <element name="mFunction" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <element ref="in:InventoryUnitLic" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +</schema> +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SA#64 | SP-140332 | 001 | - | upgrade XSD | 11.0.0 | 11.1.0 | +| | | SP-140358 | 002 | - | remove the feature support statements | | | +| 2014-09 | SA#65 | SP-140560 | 003 | - | Update the link from Solution Set to Information Service due to the end of Release 12 | 11.1.0 | 12.0.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13 (MCC) | 12.0.0 | 13.0.0 | +| 2016-03 | SA#71 | SP-160031 | 006 | - | Make the XML schema well formed | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-06 | SA#72 | SP-160407 | 0007 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.2.0 | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0008 | - | F | Update link from IRP SS to IS | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28651/raw.md b/marked/Rel-16/28_series/28651/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a0593b36ba83efe64d7972591830f1326386850c --- /dev/null +++ b/marked/Rel-16/28_series/28651/raw.md @@ -0,0 +1,127 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Requirements ..... 6 +- Annex A (informative): Change history..... 6 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +**28.651 UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** + +28.652 UTRAN Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS) + +28.653 UTRAN Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the requirements for the present IRP: Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [5] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [6] 3GPP TS.28.622: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.130: "Telecommunication management; Network sharing; Concepts and requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**IRP:** See 3GPP TS 32.101 [1]. + +**Information Object Class (IOC):** See definition in TS 28.622 [6]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|--------------------------------------------| +| CM | Configuration Management | +| FDD | Frequency Division Duplex | +| GSM | Global System for Mobile communication | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | +| TDD | Time Division Duplex | +| UMTS | Universal Mobile Telecommunications System | + +# 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- IRP-related requirements in 3GPP TS 32.101 [1]. +- IRP-related requirements in 3GPP TS 32.102 [2]. +- IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- Shall support communications for telecommunication network management purposes, including management of converged networks. +- Is a member of the Federated Network Information Model (FNIM) [4] and its information is derived from FNIM Umbrella Information Model (UIM) [5]. + +In addition, the following more specific requirements apply: + +**REQ-UTRAN\_NRM-CON-001:** The NRM defined by this IRP shall contain UTRAN specific IOCs and related definitions, supporting UTRAN network entities, which shall include FDD and TDD mode aspects. + +**REQ-UTRAN\_NRM-CON-002:** The NRM defined by this IRP shall support management of UMTS-GSM inter-system handover. + +**REQ-UTRAN\_NRM-CON-003:** The NRM defined by this IRP shall support the management of shared UTRAN. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|----------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2014-12 | SA#66 | SP-140800 | 002 | - | Add requirement for the management of shared UTRAN | B | 12.0.0 | <b>12.1.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.1.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28652/1b5a812c8aa20fd5cba28e97001d32de_img.jpg b/marked/Rel-16/28_series/28652/1b5a812c8aa20fd5cba28e97001d32de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5ad0ad7b359fd33c6a7c8433411cfc9986e39a2a --- /dev/null +++ b/marked/Rel-16/28_series/28652/1b5a812c8aa20fd5cba28e97001d32de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2cfa8e83655f17f5ec82796e52127cd5eef8bc4b50b88532a015fbab6b94e68f +size 52307 diff --git a/marked/Rel-16/28_series/28652/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/28_series/28652/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9abf5ee350826a9bbff20f78fa34a69c66c3cc28 --- /dev/null +++ b/marked/Rel-16/28_series/28652/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4172183bd850ba68475639a35751ac4fad3b3c6be4c00430b5af146d7daeecc +size 66901 diff --git a/marked/Rel-16/28_series/28652/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg b/marked/Rel-16/28_series/28652/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..48bbd5eea774f59fdba6ce55df1aa7fee15ec265 --- /dev/null +++ b/marked/Rel-16/28_series/28652/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1fc8486a8bb8b9a3755d8ca979410e55595eaeeee93587f70f3c487f12a346a0 +size 60894 diff --git a/marked/Rel-16/28_series/28652/704082cc3e11776bda29595c76411362_img.jpg b/marked/Rel-16/28_series/28652/704082cc3e11776bda29595c76411362_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..11d3b59c9ac035b20e5d2c9ad734f34160082718 --- /dev/null +++ b/marked/Rel-16/28_series/28652/704082cc3e11776bda29595c76411362_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e931da8b9fe40c7e3fbf623ab6d740e97de4fb0f787d45cffcf5850be8a32a8 +size 93913 diff --git a/marked/Rel-16/28_series/28652/8e14350b4b669119a3bdfca7869110ca_img.jpg b/marked/Rel-16/28_series/28652/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aebafb6474e73c56ed1804caa001c67981f44914 --- /dev/null +++ b/marked/Rel-16/28_series/28652/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd7ef9aa536dbd1c10c304b0e8e17cdefa9bd71b62a349c1052932b1af045d55 +size 35075 diff --git a/marked/Rel-16/28_series/28652/f1091147d93cee4dfa88498610e395a7_img.jpg b/marked/Rel-16/28_series/28652/f1091147d93cee4dfa88498610e395a7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..985c10925b8734aae8dec1914ee299ee66777e6f --- /dev/null +++ b/marked/Rel-16/28_series/28652/f1091147d93cee4dfa88498610e395a7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6cbd9b5e15dd54e58295f9cc45bb19914b45191486a1beaf85c2350237701410 +size 54325 diff --git a/marked/Rel-16/28_series/28652/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/28_series/28652/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c2bff9123d2318fa093e63a069eea878ac58e65 --- /dev/null +++ b/marked/Rel-16/28_series/28652/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:573b48fb63a3b6c48d12d1bcfc06471ceac73bcf7893a6598852a3172c3d4783 +size 13240 diff --git a/marked/Rel-16/28_series/28652/raw.md b/marked/Rel-16/28_series/28652/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..01919812c5e5f28a408859512c3636b8a4253b40 --- /dev/null +++ b/marked/Rel-16/28_series/28652/raw.md @@ -0,0 +1,1386 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 10 | +| 4 Model ..... | 11 | +| 4.1 Imported information entities and local labels..... | 11 | +| 4.2 Class diagrams..... | 12 | +| 4.2.1 Relationships ..... | 12 | +| 4.2.2 Inheritance ..... | 15 | +| 4.3 Class definitions ..... | 16 | +| 4.3.1 RNCFunction..... | 16 | +| 4.3.1.1 Definition ..... | 16 | +| 4.3.1.2 Attributes ..... | 16 | +| 4.3.1.3 Attribute constraints..... | 16 | +| 4.3.1.4 Notifications..... | 16 | +| 4.3.2 NodeBFunction..... | 16 | +| 4.3.2.1 Definition ..... | 16 | +| 4.3.2.2 Attributes ..... | 16 | +| 4.3.2.3 Attribute constraints..... | 16 | +| 4.3.2.4 Notifications..... | 16 | +| 4.3.3 IubLink ..... | 17 | +| 4.3.3.1 Definition ..... | 17 | +| 4.3.3.2 Attributes ..... | 17 | +| 4.3.3.3 Attribute constraints..... | 17 | +| 4.3.3.4 Notifications..... | 17 | +| 4.3.4 UtranRelation ..... | 17 | +| 4.3.4.1 Definition ..... | 17 | +| 4.3.4.2 Attributes ..... | 17 | +| 4.3.4.3 Attribute constraints..... | 18 | +| 4.3.4.4 Notifications..... | 18 | +| 4.3.5 ExternalRncFunction..... | 18 | +| 4.3.5.1 Definition ..... | 18 | +| 4.3.5.2 Attributes ..... | 18 | +| 4.3.5.3 Attribute constraints..... | 18 | +| 4.3.5.4 Notifications..... | 18 | +| 4.3.6 UtranGenericCell..... | 18 | +| 4.3.6.1 Definition ..... | 18 | +| 4.3.6.2 Attributes ..... | 18 | +| 4.3.6.3 Attribute constraints..... | 20 | +| 4.3.6.4 Notifications..... | 20 | +| 4.3.7 ExternalUTRANGenericCell..... | 20 | +| 4.3.7.1 Definition ..... | 20 | +| 4.3.7.2 Attributes ..... | 20 | +| 4.3.7.3 Attribute constraints..... | 21 | +| 4.3.7.4 Notifications..... | 21 | +| 4.3.8 UtranCellFDD ..... | 21 | +| 4.3.8.1 Definition ..... | 21 | +| 4.3.8.2 Attributes ..... | 21 | +| 4.3.8.3 Attribute constraints..... | 22 | +| 4.3.8.4 Notifications..... | 22 | +| 4.3.9 UtranCellTDD ..... | 22 | +| 4.3.9.1 Definition ..... | 22 | + +- 4.3.9.2 Attributes ................................................................................................................................. 22 +- 4.3.9.3 Attribute constraints.................................................................................................................. 22 +- 4.3.9.4 Notifications.............................................................................................................................. 22 +- 4.3.10 UtranCellTDDLcr .................................................................................................................... 23 + - 4.3.10.1 Definition ........................................................................................................................ 23 + - 4.3.10.2 Attributes ......................................................................................................................... 23 + - 4.3.10.3 Attribute Constraints......................................................................................................... 23 + - 4.3.10.4 Notifications...................................................................................................................... 23 +- 4.3.11 UtranCellTDDHcr ................................................................................................................... 23 + - 4.3.11.1 Definition ........................................................................................................................ 23 + - 4.3.11.2 Attributes ......................................................................................................................... 23 + - 4.3.11.3 Attribute constraints.......................................................................................................... 23 + - 4.3.11.4 Notifications...................................................................................................................... 23 +- 4.3.12 ExternalUtranCellFDD .......................................................................................................... 23 + - 4.3.12.1 Definition ........................................................................................................................ 23 + - 4.3.12.2 Attributes ......................................................................................................................... 24 + - 4.3.12.3 Attribute constraints.......................................................................................................... 24 + - 4.3.12.4 Notifications...................................................................................................................... 24 +- 4.3.13 ExternalUtranCellTDD .......................................................................................................... 24 + - 4.3.13.1 Definition ........................................................................................................................ 24 + - 4.3.13.2 Attributes ......................................................................................................................... 24 + - 4.3.13.3 Attribute constraints.......................................................................................................... 24 + - 4.3.13.4 Notifications...................................................................................................................... 24 +- 4.3.14 ExternalUtranCellTDDHcr ..................................................................................................... 25 + - 4.3.14.1 Definition ........................................................................................................................ 25 + - 4.3.14.2 Attributes ......................................................................................................................... 25 + - 4.3.14.3 Attribute constraints.......................................................................................................... 25 + - 4.3.14.4 Notifications...................................................................................................................... 25 +- 4.3.15 ExternalUtranCellTDDLcr ..................................................................................................... 25 + - 4.3.15.1 Definition ........................................................................................................................ 25 + - 4.3.15.2 Attributes ......................................................................................................................... 25 + - 4.3.15.3 Attribute constraints.......................................................................................................... 25 + - 4.3.15.4 Notifications...................................................................................................................... 25 +- 4.3.16 EP\_IuCS ................................................................................................................................. 26 + - 4.3.16.1 Definition ........................................................................................................................ 26 + - 4.3.16.2 Attributes ......................................................................................................................... 26 + - 4.3.16.3 Attribute constraints.......................................................................................................... 26 + - 4.3.16.4 Notifications...................................................................................................................... 26 +- 4.3.17 EP\_IuPS ................................................................................................................................. 26 + - 4.3.17.1 Definition ........................................................................................................................ 26 + - 4.3.17.2 Attributes ......................................................................................................................... 26 + - 4.3.17.3 Attribute constraints.......................................................................................................... 26 + - 4.3.17.4 Notifications...................................................................................................................... 26 +- 4.3.18 EP\_Iur..................................................................................................................................... 26 + - 4.3.18.1 Definition ........................................................................................................................ 26 + - 4.3.18.2 Attributes ......................................................................................................................... 27 + - 4.3.18.3 Attribute constraints.......................................................................................................... 27 + - 4.3.18.4 Notifications...................................................................................................................... 27 +- 4.4 Attribute definitions ................................................................................................................... 28 + - 4.4.1 Attribute properties.............................................................................................................. 28 + - 4.4.2 Constraints ............................................................................................................................ 38 +- 4.5 Common notifications ................................................................................................................ 38 + - 4.5.1 Alarm notifications .............................................................................................................. 38 + - 4.5.2 Configuration notifications................................................................................................... 38 +- Annex A (informative): RET Control Architecture................................................................................ 39** +- Annex B (informative): Change history ................................................................................................... 40** + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.651: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- 28.652: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS) ".** +- 28.653: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +# --- 1 Scope + +The present document specifies the UTRAN Network Resource Model (NRM) that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +The present document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] 3GPP TS 25.401: "UTRAN Overall Description". +- [5] 3GPP TS 25.433: "UTRAN Iub Interface NBAP Signalling". +- [6] 3GPP TS 28.655: "Telecommunication management; GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [8] 3GPP TS 28.625: "Telecommunication management; State Management Data Definition Integration Reference Point (IRP): Information Service (IS)". +- [9] 3GPP TS 25.331: "Radio Resource Control (RRC) protocol specification". +- [10] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [11] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [12] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [13] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [14] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [15] 3GPP TS 23.002: "Network Architecture". +- [16] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +- [17] 3GPP TS 28.662: “Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)”. +- [18] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [19] 3GPP TS 25.466: "UTRAN Iu interface: Application Part". +- [20] 3GPP TS 28.732: " Telecommunication management; Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [21] 3GPP TS 28.702: " Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [22] 3GPP TS 32.130: " Telecommunication management; Network sharing; Concepts and requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following definitions apply. For definitions not found here, please refer to 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 28.622 [16] and 3GPP TS 32.600 [14]. + +**Antenna:** Within the present document an Antenna is the set of radiating elements involved in the transmission and reception of Radio Frequency energy to support the Uu interface of a UTRAN cell. See Annex A for more detail. + +**Association:** See definition in TS 28.622 [16]. + +**Managed Element (ME):** See definition in TS 28.622 [16]. + +**Managed Object (MO):** See definition in TS 28.622 [16]. + +**Management Information Model (MIM):** See definition in TS 28.622 [16]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [16]. + +**Node B:** A logical node responsible for radio transmission/reception in one or more cells to/from the User Equipment. It terminates the Iub interface towards the RNC. + +**TMA:** See TS 25.466 [19]. + +**Tower Mounted Amplifier:** See TS 25.466 [19]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|-------------------------------------------------------| +| CN | Core Network | +| DN | Distinguished Name (see 3GPP TS 32.300 [13]) | +| FDD | Frequency Division Duplex | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| Iub | Interface between RNC and Node B | +| Mcps | Mega-chips per second | +| ME | Managed Element | +| MIM | Management Information Model | +| MO | Managed Object | +| NRM | Network Resource Model | +| PS | Packet Switched | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [13]) | +| RET | Remote control of Electrical Tilting (RET) antenna | +| RNC | Radio Network Controller | +| TDD | Time Division Duplex | +| TMA | Tower Mounted Amplifier | +| UML | Unified Modelling Language | +| UTRA | Universal Terrestrial Radio Access | +| UTRAN | Universal Terrestrial Radio Access Network | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| <b>Label reference</b> | <b>Local label</b> | +|------------------------------------------------------|-----------------------------------------| +| 3GPP TS 28.622 [16], IOC, ManagedElement | <code>ManagedElement</code> | +| 3GPP TS 28.622 [16], IOC, ManagedFunction | <code>ManagedFunction</code> | +| 3GPP TS 28.622 [16], IOC, MeContext | <code>MeContext</code> | +| 3GPP TS 28.622 [16], IOC, SubNetwork | <code>SubNetwork</code> | +| 3GPP TS 28.622 [16], IOC, Top | <code>Top</code> | +| 3GPP TS 28.622 [16], IOC, VsDataContainer | <code>VsDataContainer</code> | +| 3GPP TS 28.622 [16], IOC, EP_RP | <code>EP_RP</code> | +| 3GPP TS 28.655 [6], IOC, ExternalGSMCell | <code>ExternalGSMCell</code> | +| 3GPP TS 28.655 [6], IOC, GsmCell | <code>GsmCell</code> | +| 3GPP TS 28.655 [6], IOC, GsmRelation | <code>GsmRelation</code> | +| 3GPP TS 28.625 [8], attribute, operationalState | <code>operationalState</code> | +| 3GPP TS 28.662 [17], IOC, AntennaFunction | <code>AntennaFunction</code> | +| 3GPP TS 28.662 [17], IOC, TmaFunction | <code>TmaFunction</code> | +| 3GPP TS 28.662 [17], IOC, SectorEquipmentFunction | <code>SectorEquipmentFunction</code> | +| 3GPP TS 28.662 [17], IOC, CellReferences | <i><code>CellReferences</code></i> | +| 3GPP TS 28.702 [21], IOC, MscServerFunction | <code>MscServerFunction</code> | +| 3GPP TS 28.702 [21], IOC, SGSNFunction | <code>SGSNFunction</code> | +| 3GPP TS 28.732 [20], IOC, TransportNetworkInterface | <code>TransportNetworkInterface</code> | +| 3GPP TS 28.732 [20], IOC, ATMChannelTerminationPoint | <code>ATMChannelTerminationPoint</code> | +| 3GPP TS 28.732 [20], IOC, ATMPathTerminationPoint | <code>ATMPathTerminationPoint</code> | + +## 4.2 Class diagrams + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates information relevant for this IRP. This subclause provides the overview of the relationships of relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +The following figures show the containment/naming hierarchy and the associations of the information object classes defined in the present document. They are split in several figures only for a readability purpose. + +![UML Class diagram showing relationships between RNCFunction, IubLink, EP_IuCS, EP_IuPS, and UTRANGenericCell. RNCFunction is the root class with four associations: 1) to EP_IuPS (role 'names', 1 to *), 2) to EP_IuCS (role 'names', 1 to *), 3) to IubLink (role 'names', 1 to *), and 4) to UTRANGenericCell (role 'names', 1 to *). IubLink has two associations: 1) to UTRANGenericCell (role 'iubLink', 0..1 to 0..1) and 2) to EP_IuCS (role 'uTRANGenericCell', 0..1 to *).](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` + +classDiagram + class RNCFunction { + <<InformationObjectClass>> + } + class IubLink { + <<InformationObjectClass>> + } + class EP_IuCS { + <<InformationObjectClass>> + } + class EP_IuPS { + <<InformationObjectClass>> + } + class UTRANGenericCell { + <<InformationObjectClass>> + } + + RNCFunction "1" *-- "*" EP_IuPS : names + RNCFunction "1" *-- "*" EP_IuCS : names + RNCFunction "1" *-- "*" IubLink : names + RNCFunction "1" *-- "*" UTRANGenericCell : names + IubLink "0..1" -- "0..1" UTRANGenericCell : iubLink + IubLink "0..1" -- "*" EP_IuCS : uTRANGenericCell + +``` + +UML Class diagram showing relationships between RNCFunction, IubLink, EP\_IuCS, EP\_IuPS, and UTRANGenericCell. RNCFunction is the root class with four associations: 1) to EP\_IuPS (role 'names', 1 to \*), 2) to EP\_IuCS (role 'names', 1 to \*), 3) to IubLink (role 'names', 1 to \*), and 4) to UTRANGenericCell (role 'names', 1 to \*). IubLink has two associations: 1) to UTRANGenericCell (role 'iubLink', 0..1 to 0..1) and 2) to EP\_IuCS (role 'uTRANGenericCell', 0..1 to \*). + +**Figure 4.2.1-1: Transport view UTRAN NRM Containment/Naming and Association diagram** + +NOTE 1: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +NOTE 2: The AntennaFunction instances (referenced by a role-attribute of IOC CellReferences inherited by *UTRANGenericCell*) is required when supporting RET. For a description and clarification of RET, please refer to Annex A. + +NOTE 3: The AntennaFunction Instances can be associated with a particular NodeBFunction instance (via *IubLink* and *UTRANGenericCell*). These AntennaFunction instances and NodeBFunction instance must be contained by the same ManagedElement instance. + +NOTE 4: The TmaFunction Instances can be associated with a particular NodeBFunction instance (via *IubLink* and *UTRANGenericCell*). These TmaFunction Instances and NodeBFunction instance must be contained by the same ManagedElement instance. + +NOTE 5: Please see TS 28.662 [17] for the definitions of the five associations between a) *UtranGenericCell* and AntennaFunction b) between *UtranGenericCell* and SectorEquipmentFunction c) between *UtranGenericCell* and TmaFunction d) between SectorEquipmentFunction and AntennaFunction and e) between SectorEquipmentFunction and TmaFunction. + +![UML Class Diagram: Transport view UTRAN NRM Containment/Naming and Association diagram](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +classDiagram + class SubNetwork { + <<InformationObjectClass>> + (from 28.622) + } + class ExternalRNCFunction { + <<InformationObjectClass>> + +controllingRNC 0..1 + +controlledCellList * + } + class ExternalUTRANGenericCell { + <<InformationObjectClass>> + } + class RNCFunction { + <<InformationObjectClass>> + } + class UTRANGenericCell { + <<InformationObjectClass>> + } + class AdjacentCell { + <<ProxyClass>> + } + class UTRANRelation { + <<InformationObjectClass>> + } + class GSMRelation { + <<InformationObjectClass>> + (from 28.655) + } + + SubNetwork "1" *-- "*" ExternalRNCFunction : «names» + SubNetwork "1" *-- "*" ExternalUTRANGenericCell : «names» + ExternalRNCFunction "1" *-- "*" ExternalUTRANGenericCell : «names» + RNCFunction "1" *-- "*" UTRANGenericCell : «names» + UTRANGenericCell "1" *-- "*" UTRANRelation : «names» + UTRANGenericCell "1" *-- "*" GSMRelation : «names» + AdjacentCell "0..1" -- "*" UTRANRelation : +adjacentCell + AdjacentCell "0..1" -- "*" GSMRelation : +adjacentCell + + note for AdjacentCell "It represents ExternalUTRANGenericCell or UTRANGenericCell." + +``` + +The diagram illustrates the transport view of the UTRAN NRM. It shows the following classes and their relationships: + +- SubNetwork** (from 28.622): Contains **ExternalRNCFunction** and **ExternalUTRANGenericCell** (naming relationships). +- ExternalRNCFunction**: Contains **ExternalUTRANGenericCell** (naming relationship). It has attributes `+controllingRNC` (0..1) and `+controlledCellList` (\*). +- RNCFunction**: Contains **UTRANGenericCell** (naming relationship). +- UTRANGenericCell**: Contains **UTRANRelation** and **GSMRelation** (naming relationships). +- AdjacentCell** (ProxyClass): Associated with **UTRANRelation** and **GSMRelation** (association relationship `+adjacentCell`). + +A note indicates that **AdjacentCell** represents **ExternalUTRANGenericCell** or **UTRANGenericCell**. + +UML Class Diagram: Transport view UTRAN NRM Containment/Naming and Association diagram + +**Figure 4.2.1-1: Transport view UTRAN NRM Containment/Naming and Association diagram** + +NOTE 6: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +NOTE 7: The relation between *GSMRelation* and *GSMCell* is optional. It may be present if both the *UTRANGenericCell* and the *GSMCell* are managed by the same management node. + +NOTE 8: The *UtranRelation* and *GsmRelation* can be name-contained under IOCs defined in other NRMs. + +NOTE 9: *ExternalUTRANGenericCell* is contained under *SubNetwork* or *ExternalRncFunction*. + +![UML Class Diagram showing UTRANRelation and VsDataContainer classes. UTRANRelation has a 1-to-many association with VsDataContainer labeled 'names'. VsDataContainer also has a self-referential 'names' association.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +classDiagram + class UTRANRelation { + <<InformationObjectClass>> + } + class VsDataContainer { + <<InformationObjectClass>> + (from 28.622) + } + UTRANRelation "1" --> "*" VsDataContainer : <<names>> + VsDataContainer "1" --> "*" VsDataContainer : <<names>> + +``` + +UML Class Diagram showing UTRANRelation and VsDataContainer classes. UTRANRelation has a 1-to-many association with VsDataContainer labeled 'names'. VsDataContainer also has a self-referential 'names' association. + +**Figure 4.2.1-2: Cell view UTRAN NRM Containment/Naming and Association diagram** + +NOTE 10: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +NOTE 11: Each instance of the *VsDataContainer* shall only be contained under one IOC. The *VsDataContainer* can be contained under IOCs defined in other NRMs. + +![Complex UML Class Diagram showing ManagedElement, TransportNetworkInterface, ATMChannelTerminationPoint, RNCFunction, IubLink, and NodeBFunction classes and their relationships.](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + (from 28.622) + } + class TransportNetworkInterface { + <<InformationObjectClass>> + (from 28.732) + } + class ATMChannelTerminationPoint { + <<InformationObjectClass>> + (from 28.732) + } + class RNCFunction { + <<InformationObjectClass>> + } + class IubLink { + <<InformationObjectClass>> + } + class NodeBFunction { + <<InformationObjectClass>> + } + + ManagedElement "1" --> "*" TransportNetworkInterface : <<names>> + TransportNetworkInterface "1" --> "*" ATMChannelTerminationPoint : <<names>> + ManagedElement "1" --> "*" RNCFunction : <<names>> + ManagedElement "1" --> "*" NodeBFunction : <<names>> + RNCFunction "1" --> "*" IubLink : <<names>> + NodeBFunction "1" --> "*" IubLink : <<names>> + + RNCFunction "1" -- "*" ATMChannelTerminationPoint : + aTMChannelTerminationPoint + NodeBFunction "1" -- "1" ATMChannelTerminationPoint : - aTMPathTerminationPoint + IubLink "0..1" -- "*" ATMChannelTerminationPoint : + iubLink + +``` + +Complex UML Class Diagram showing ManagedElement, TransportNetworkInterface, ATMChannelTerminationPoint, RNCFunction, IubLink, and NodeBFunction classes and their relationships. + +**Figure 4.2.1-3: VsDataContainer Containment/Naming and Association in UTRAN NRM diagram** + +NOTE 1: The *ATMChannelTerminationPoint* is name-contained under IOCs defined in the Transport Network NRM. + +NOTE 2: The group of *ATMChannelTerminationPoints* associated with an *IubLink* (the relation *AssociatedWith1*) represent the RNC end of the ATM Virtual Channel Connections (transport connection) between an RNC and a NodeB. + +NOTE 3: An *ATMChannelTerminationPoint* can be associated with more than one *IubLink* for the case of AAL2 multiplexing/switching, i.e. to allow an ATM Channel at the RNC to be connected to multiple NodeBs. + +**Figure 4.2.1-4: UTRAN Transport Network NRM Containment/Naming and Association diagram** + +The VsDataContainer is only used for the Bulk CM IRP. + +Each IOC instance is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [13] that expresses its containment hierarchy. As an example, the DN of an IOC instance representing a cell could have a format like: + +SubNetwork=Sweden, MeContext=MEC-Gbg-1, ManagedElement=RNC-Gbg-1, RncFunction=RF-1, UtranCell=Gbg-1. + +![Association diagram of EP_Iur, EP_IuCS and EP_IuPS](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +It represents a BSSFunction (from 28.655) or RNCFunction. + +``` + +classDiagram + class RNCFunction["«InformationObjectClass» +RNCFunction"] + class EP_Iur["«InformationObjectClass» +EP_Iur"] + class RNC_BSS_Function["«ProxyClass» +RNC_BSS_Function"] + class EP_IuCS["«InformationObjectClass» +EP_IuCS"] + class MSCServerFunction["«InformationObjectClass» +MSCServerFunction +(from 28.702)"] + class EP_IuPS["«InformationObjectClass» +EP_IuPS"] + class SGSNFunction["«InformationObjectClass» +SGSNFunction +(from 28.702)"] + + RNCFunction "1" --* "*" EP_Iur : «names» + EP_Iur "*" -- "0..1" RNC_BSS_Function : + connectedRNCId + EP_IuCS "*" -- "0..1" MSCServerFunction : + connMSCNumber + EP_IuPS "*" -- "0..1" SGSNFunction : + connSGSNNumber + +``` + +Association diagram of EP\_Iur, EP\_IuCS and EP\_IuPS + +Figure 4.2.1-5: Association diagram of EP\_Iur, EP\_IuCS and EP\_IuPS + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +Figure 4.2.2.1 shows the inheritance hierarchy for the UTRAN NRM. + +![UTRAN NRM Inheritance Hierarchy](704082cc3e11776bda29595c76411362_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass» +Top +(from 28.622)"] + class EP_RP["«InformationObjectClass» +EP_RP +(from 28.622)"] + class ManagedFunction["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + + class EP_IuPS["«InformationObjectClass» +EP_IuPS"] + class EP_Iur["«InformationObjectClass» +EP_Iur"] + class EP_IuCS["«InformationObjectClass» +EP_IuCS"] + + class UTRANRelation["«InformationObjectClass» +UTRANRelation"] + class IubLink["«InformationObjectClass» +IubLink"] + class CellReferences["«InformationObjectClass» +CellReferences +(from 28.662)"] + + class NodeBFunction["«InformationObjectClass» +NodeBFunction"] + class RNCFunction["«InformationObjectClass» +RNCFunction"] + class ExternalRNCFunction["«InformationObjectClass» +ExternalRNCFunction"] + + class UTRANGenericCell["«InformationObjectClass» +UTRANGenericCell"] + class ExternalUTRANGenericCell["«InformationObjectClass» +ExternalUTRANGenericCell"] + + class UtranCellFDD["«InformationObjectClass» +UtranCellFDD"] + class UtranCellTDD["«InformationObjectClass» +UtranCellTDD"] + class ExternalUtranCellFDD["«InformationObjectClass» +ExternalUtranCellFDD"] + class ExternalUtranCellTDD["«InformationObjectClass» +ExternalUtranCellTDD"] + + class UtranCellTDDHcr["«InformationObjectClass» +UtranCellTDDHcr"] + class UtranCellTDDLcr["«InformationObjectClass» +UtranCellTDDLcr"] + class ExternalCellTDDHcr["«InformationObjectClass» +ExternalCellTDDHcr"] + class ExternalCellTDDLcr["«InformationObjectClass» +ExternalCellTDDLcr"] + + Top <|-- EP_RP + Top <|-- ManagedFunction + EP_RP <|-- EP_IuPS + EP_RP <|-- EP_Iur + EP_RP <|-- EP_IuCS + Top <|-- UTRANRelation + Top <|-- IubLink + Top <|-- CellReferences + ManagedFunction <|-- NodeBFunction + ManagedFunction <|-- RNCFunction + ManagedFunction <|-- ExternalRNCFunction + CellReferences <|-- UTRANGenericCell + ManagedFunction <|-- ExternalUTRANGenericCell + UTRANGenericCell <|-- UtranCellFDD + UTRANGenericCell <|-- UtranCellTDD + ExternalUTRANGenericCell <|-- ExternalUtranCellFDD + ExternalUTRANGenericCell <|-- ExternalUtranCellTDD + UtranCellTDD <|-- UtranCellTDDHcr + UtranCellTDD <|-- UtranCellTDDLcr + ExternalUtranCellTDD <|-- ExternalCellTDDHcr + ExternalUtranCellTDD <|-- ExternalCellTDDLcr + +``` + +UTRAN NRM Inheritance Hierarchy + +Figure 4.2.2.1: UTRAN NRM Inheritance Hierarchy + +## 4.3 Class definitions + +### 4.3.1 RNCFunction + +#### 4.3.1.1 Definition + +This IOC represents RNC functionality. For more information about the RNC, see 3GPP TS 23.002 [15]. + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| mcc | M | M | M | - | M | +| mnc | M | M | M | - | M | +| rncId | M | M | M | - | M | +| siptoSupported | M | M | - | - | M | +| tceIDMappingInfoList | CM | M | M | - | M | +| sharNetTceMappingInfoList | CM | M | M | - | M | + +#### 4.3.1.3 Attribute constraints + +| Name | Definition | +|---------------------------|-----------------------------------------------------------------------------| +| tceIDMappingInfoList | The condition is "MDT function is supported" and only one PLMN is supported | +| sharNetTceMappingInfoList | The condition is "MDT function and several PLMNs are supported" | + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.2 NodeBFunction + +#### 4.3.2.1 Definition + +This IOC represents Node B functionality. For more information about the Node B, see 3GPP TS 23.002 [15]. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| | | | | | | +| <b>Attribute related to role</b> | | | | | | +| iubLink | M | M | - | - | M | + +#### 4.3.2.3 Attribute constraints + +| Name | Definition | +|-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| nodeBFunction-iubLink M support qualifier | When a particular IubLink identifies this particular NodeBFunction, this particular NodeBFunction must identify the particular IubLink. | + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 IubLink + +#### 4.3.3.1 Definition + +This IOC represents the logical link to a Node B as seen from the RNC. For more information about the RNC, see 3GPP TS 23.002 [15]. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| uTRANGenericCell | M | M | M | - | M | +| nodeBFunction | M | M | - | - | M | +| aTMChannelTerminationPoint | M | M | - | | | + +#### 4.3.3.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <i>IubLink-UTRANCell M support qualifier</i> | <i>When a particular IubLink identifies a particular UTRANGenericCell derivative, that particular UTRANGenericCell derivative must have identified this particular IubLink.</i> | +| <i>IubLink-NodeBFunction M support qualifier</i> | <i>When a particular IubLink identifies a particular NodeBFunction, that particular NodeBFunction must identify this particular IubLink.</i> | +| <i>IubLink-ATMChannelTerminationPoint</i> | <i>When a particular IubLink identifies a particular ATMChannelTerminationPoint, that particular ATMChannelTerminationPoint must identify this particular IubLink.</i> | + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.4 UtranRelation + +#### 4.3.4.1 Definition + +The UtranRelation IOC contains radio network related parameters for the relation to the *UTRANGenericCell* or *ExternalUTRANGenericCell* IOC. + +The *UTRANGenericCell* and the *ExternalUTRANGenericCell* may be an FDD mode cell, a lcr (low chip rate) 1.28 Mcps TDD mode cell or a hcr (high chip rate) 3.84 (7.68) Mcps TDD mode cell. + +NOTE: In handover relation terms, the cell containing the UTRAN Relation object is the source cell for the handover. The cell referred to in the UTRAN relation object is the target cell for the handover. This defines a one-way handover relation where the direction is *from* source cell *to* target cell. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +|----------------|-------------------|------------|------------|-------------|--------------| + +| | | | | | | +|----------------------------------|---|---|---|---|---| +| id | M | M | - | M | - | +| <b>Attribute related to role</b> | | | | | | +| adjacentCell | M | M | M | - | M | + +#### 4.3.4.3 Attribute constraints + +| <b>Name</b> | <b>Definition</b> | +|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| <i>adjacentCell M support qualifier</i> | <i>This attribute can hold either an UTRANGenericCell (or its derivative) DN or an ExternalUTRANGenericCell (or its derivative) DN or no information.</i> | + +#### 4.3.4.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.5 ExternalRncFunction + +#### 4.3.5.1 Definition + +This IOC represents an RNC function controlled by another IRPAgent. For more information about the RNC, see 3GPP TS 23.002 [15]. + +#### 4.3.5.2 Attributes + +| <b>Attribute name</b> | <b>Support Qualifier</b> | <b>isReadable</b> | <b>isWritable</b> | <b>isInvariant</b> | <b>isNotifyable</b> | +|----------------------------------|--------------------------|-------------------|-------------------|--------------------|---------------------| +| mcc | M | M | M | - | M | +| mnc | M | M | M | - | M | +| rncId | M | M | M | - | M | +| <b>Attribute related to role</b> | | | | | | +| controlledCellList | O | M | - | - | M | + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.6 UtranGenericCell + +#### 4.3.6.1 Definition + +This abstract IOC represents the common properties of radio cells of different types (FDD, TDD) controlled by an RNC. For more information about radio cells, see 3GPP TS 23.002 [15]. + +The IOC UtranCellFDD and UtranCellTDD (1,28 Mcps TDD mode cell or a 3.84 (7.68) Mcps TDD mode cell) inherit from that abstract IOC. + +#### 4.3.6.2 Attributes + +| <b>Attribute name</b> | <b>Support Qualifier</b> | <b>isReadable</b> | <b>isWritable</b> | <b>isInvariant</b> | <b>isNotifyable</b> | +|-----------------------|--------------------------|-------------------|-------------------|--------------------|---------------------| +|-----------------------|--------------------------|-------------------|-------------------|--------------------|---------------------| + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------|----|---|---|---|----------------| +| cId | M | M | M | - | M | +| localCellId | M | M | M | - | M | +| maximumTransmissionPower | M | M | M | - | M | +| pichPower | CM | M | O | - | M | +| pchPower | CM | M | O | - | M | +| fachPower | CM | M | O | - | M | +| cellMode | M | M | - | - | M | +| lac | M | M | M | - | M | +| rac | CM | M | M | - | M | +| sac | M | M | M | - | M | +| uraList | CM | M | M | - | M | +| hsFlag | CM | M | - | - | M | +| hsEnable | CM | M | M | - | M | +| numOfHspdschs | CM | M | M | - | M | +| numOfHsschs | CM | M | M | - | M | +| frameOffset | CO | M | - | - | M | +| cellIndividualOffset | CO | M | - | - | M | +| hcsPrio | CO | M | - | - | M | +| maximumAllowedUlTxPower | CO | M | - | - | M | +| snaInformation | CO | M | - | - | M | +| qrxlevMin | CO | M | - | - | M | +| deltaQrxlevmin | CO | M | - | - | M | +| qhcs | CO | M | - | - | M | +| penaltyTime | CO | M | - | - | M | +| referenceTimeDifferenceToCell | CO | M | - | - | M | +| readSFNIndicator | CO | M | - | - | M | +| restrictionStateIndicator | CO | M | - | - | M | +| dpcModeChangeSupportIndicator | CO | M | - | - | M | +| operationalState (See Note 1) | O | M | - | - | M (see Note 2) | +| nsPlmnIdList | CM | M | M | - | M | +| <b>Attribute related to role</b> | | | | | | +| relatedAntennaList | CO | M | M | - | M | +| relatedSectorEquipment | CM | M | - | - | M | +| relatedTMAList | CO | M | - | - | M | +| iubLink | M | M | - | - | M | +| Note 1: No state propagation shall be implied.<br>Note 2: The attribute value change is conveyed by the <code>notifyStateChange</code> notification. | | | | | | + +#### 4.3.6.3 Attribute constraints + +| Name | Definition | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <i>relatedAntennaList and relatedTMAList CO support qualifier</i> | The IOC <i>SectorEquipmentFunction</i> (see 28.662 [17]) is not used | +| <i>relatedSectorEquipment CM support qualifier</i> | The IOC <i>SectorEquipmentFunction</i> (see 28.662 [17]) is used | +| <i>uTRANGenericCell-IubLink M support qualifier</i> | When a particular <i>UtranGenericCell</i> derivative identifies a particular <i>IubLink</i> , that particular <i>IubLink</i> must have identified this particular <i>UtranGenericCell</i> derivative. | +| <i>rac and uralList CM support qualifier</i> | The PLMN contains a PS CN. | +| <i>hsFlag, hsEnable, numOfHspdschs and numOfHsschs CM support qualifier</i> | The HSDPA feature is not supported by vendor specific extension mechanisms. | +| <i>pichPower, pchPower and fachPower CM support qualifier</i> | The attributes <i>pichPower</i> , <i>pchPower</i> and <i>fachPower</i> are not supported by vendor specific extension mechanisms. | +| <i>frameOffset, cellIndividualOffset, hcsPrio, maximumAllowedUlTxPower, snaInformation, qrxlevMin, deltaQrxlevmin, qhcs, penaltyTime, referenceTimeDifferenceToCell, readSFNIndicator, restrictionStateIndicator and dpcModeChangeSupportIndicator CO support qualifier</i> | ltf-p2p is supported. | +| <i>nsPlmnIdList CM support qualifier</i> | Network sharing is supported (see 32.130 [22]) | + +#### 4.3.6.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC. In addition, the following set of notification, defined in 3GPP TS 32.662 [10], is also valid. + +| Name | Qualifier | Notes | +|--------------------------|-----------|-------| +| <i>notifyStateChange</i> | O | | + +### 4.3.7 ExternalUTRANGenericCell + +#### 4.3.7.1 Definition + +This abstract IOC represents the properties of a radio cell controlled by another IRP Agent. This IOC contains necessary attributes for inter-system and intra-system handover. It also contains a subset of the attributes of related IOCs controlled by another IRP Agent. The way to maintain consistency between the attribute values of these IOCs is outside the scope of the present document. + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +|----------------|-------------------|------------|------------|-------------|--------------| + +| | | | | | | +|----------------------------------|----|---|---|---|---| +| cId | M | M | M | - | M | +| mcc | M | M | M | - | M | +| mnc | M | M | M | - | M | +| rncId | M | M | M | - | M | +| cellMode | M | M | - | - | M | +| lac | M | M | M | - | M | +| rac | CM | M | M | - | M | +| hsFlag | CM | M | - | - | M | +| frameOffset | CO | M | - | - | M | +| cellIndividualOffset | CO | M | - | - | M | +| hcsPrio | CO | M | - | - | M | +| maximumAllowedUlTxPower | CO | M | - | - | M | +| qrxlevMin | CO | M | - | - | M | +| deltaQrxlevmin | CO | M | - | - | M | +| qhcs | CO | M | - | - | M | +| penaltyTime | CO | M | - | - | M | +| referenceTimeDifferenceToCell | CO | M | - | - | M | +| readSFNIndicator | CO | M | - | - | M | +| restrictionStateIndicator | CO | M | - | - | M | +| dpcModeChangeSupportIndicator | CO | M | - | - | M | +| snaInformation | CO | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| controllingRNC | O | M | - | - | M | + +#### 4.3.7.3 Attribute constraints + +| Name | Definition | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| +| <i>rac</i> CM support qualifier | The PLMN contains a PS CN. | +| <i>hsFlag</i> CM support qualifier | The HSDPA feature is not supported by vendor specific extension mechanisms. | +| <i>frameOffset</i> , <i>cellIndividualOffset</i> , <i>hcsPrio</i> , <i>maximumAllowedUlTxPower</i> , <i>qrxlevMin</i> , <i>deltaQrxlevmin</i> , <i>qhcs</i> , <i>penaltyTime</i> , <i>referenceTimeDifferenceToCell</i> , <i>readSFNIndicator</i> , <i>restrictionStateIndicator</i> , <i>dpcModeChangeSupportIndicator</i> and <i>snaInformation</i> CO support qualifier | Itf-p2p is supported. | + +#### 4.3.7.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.8 UtranCellFDD + +#### 4.3.8.1 Definition + +This IOC represents a FDD radio cell controlled by an RNC. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.8.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +|----------------|-------------------|------------|------------|-------------|--------------| + +| | | | | | | +|---------------------------------|----|---|---|---|---| +| uarfcnUl | O | M | M | - | M | +| uarfcnDl | O | M | M | - | M | +| primaryScramblingCode | O | M | M | - | M | +| primaryCpichPower | O | M | M | - | M | +| primarySchPower | O | M | M | - | M | +| secondarySchPower | O | M | M | - | M | +| bchPower | O | M | M | - | M | +| aichPower | O | M | - | - | M | +| qqualMin | CO | M | - | - | M | +| cellCapabilityContainerFDD | CO | M | - | - | M | +| txDiversityIndicator | CO | M | - | - | M | +| temporaryOffset1 | CO | M | - | - | M | +| temporaryOffset2 | CO | M | - | - | M | +| sttdSupportIndicator | CO | M | - | - | M | +| closedLoopModelSupportIndicator | CO | M | - | - | M | + +#### 4.3.8.3 Attribute constraints + +| Name | Definition | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------| +| <i>aichPower CM support qualifier</i> | <i>The attribute aichPower is not supported by vendor specific extension mechanisms.</i> | +| <i>qqualMin, cellCapabilityContainerFDD, txDiversityIndicator temporaryOffset1, temporaryOffset2, sttdSupportIndicator and closedLoopModelSupportIndicator CO support qualifier</i> | <i>Itf-p2p is supported.</i> | + +#### 4.3.8.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.9 UtranCellTDD + +#### 4.3.9.1 Definition + +This IOC is an abstract class representing the common properties of TDD high chip rate (hcr) and TDD low chip rate (lcr) radio cells controlled by an RNC. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.9.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------|-------------------|------------|------------|-------------|--------------| +| uarfcn | O | M | M | - | M | +| cellParameterId | O | M | M | - | M | +| primaryCcpchPower | O | M | M | - | M | +| cellCapabilityContainerTDD | CO | M | - | - | M | +| sctdIndicator | CO | M | - | - | M | +| dpchConstantValue | CO | M | - | - | M | + +#### 4.3.9.3 Attribute constraints + +| Name | Definition | +|---------------------------------------------------------------------------------------------|------------------------------| +| <i>cellCapabilityContainerTDD, sctdIndicator and dpchConstantValue CO support qualifier</i> | <i>Itf-p2p is supported.</i> | + +#### 4.3.9.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.10 UtranCellTDDLcr + +#### 4.3.10.1 Definition + +This IOC represents a TDD low chip rate (lcr) radio cell controlled by an RNC. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.10.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------|-------------------|------------|------------|-------------|--------------| +| uarfcnLCRList | O | M | M | - | M | +| fpachPower | O | M | O | - | M | +| dwPchPower | O | M | M | - | M | +| tstdIndicator | CO | M | - | - | M | +| timeSlotLcrList | O | M | M | - | M | + +#### 4.3.10.3 Attribute Constraints + +| Name | Definition | +|------------------------------------|-----------------------| +| tstdIndicator CO support qualifier | Itf-p2p is supported. | + +#### 4.3.10.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.11 UtranCellTDDHcr + +#### 4.3.11.1 Definition + +This IOC represents a TDD high chip rate (hcr) radio cell controlled by an RNC. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.11.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------|-------------------|------------|------------|-------------|--------------| +| schPower | O | M | M | - | M | +| temporaryOffset1 | CO | M | - | - | M | +| syncCase | CO | M | - | - | M | +| timeSlotForSch | CO | M | - | - | M | +| schTimeSlot | CO | M | - | - | M | +| timeSlotHcrList | O | M | M | - | M | + +#### 4.3.11.3 Attribute constraints + +| Name | Definition | +|---------------------------------------------------------------------------------|-----------------------| +| temporaryOffset1, syncCase, timeSlotForSch and schTimeSlot CO support qualifier | Itf-p2p is supported. | + +#### 4.3.11.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.12 ExternalUtranCellFDD + +#### 4.3.12.1 Definition + +This IOC represents a FDD radio cell controlled by another IRP agent. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.12.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------------|-------------------|------------|------------|-------------|--------------| +| uarfcnUl | O | M | M | - | M | +| uarfcnDl | O | M | M | - | M | +| primaryScramblingCode | O | M | M | - | M | +| primaryCpichPower | O | M | M | - | M | +| qqualMin | CO | M | - | - | M | +| cellCapabilityContainerFDD | CO | M | - | - | M | +| txDiversityIndicator | CO | M | - | - | M | +| temporaryOffset1 | CO | M | - | - | M | +| temporaryOffset2 | CO | M | - | - | M | +| sttdSupportIndicator | CO | M | - | - | M | +| closedLoopModelSupportIndicator | CO | M | - | - | M | + +#### 4.3.12.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| <i>qqualMin, cellCapabilityContainerFDD, txDiversityIndicator, temporaryOffset1, temporaryOffset2, sttdSupportIndicator and closedLoopModelSupportIndicator CO support qualifier</i> | <i>Itf-p2p is supported.</i> | + +#### 4.3.12.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.13 ExternalUtranCellTDD + +#### 4.3.13.1 Definition + +This IOC is an abstract class representing the common properties of TDD high chip rate (hcr) and TDD low chip rate (lcr) radio cells controlled by another IRP agent. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.13.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------|-------------------|------------|------------|-------------|--------------| +| uarfcn | O | M | M | - | M | +| cellParameterId | O | M | M | - | M | +| primaryCcpchPower | O | O | O | - | M | +| cellCapabilityContainerTDD | CO | M | - | - | M | +| sctdIndicator | CO | M | - | - | M | +| dpchConstantValue | CO | M | - | - | M | + +#### 4.3.13.3 Attribute constraints + +| Name | Definition | +|---------------------------------------------------------------------------------------------|------------------------------| +| <i>cellCapabilityContainerTDD, sctdIndicator and dpchConstantValue CO support qualifier</i> | <i>Itf-p2p is supported.</i> | + +#### 4.3.13.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.14 ExternalUtranCellTDDHcr + +#### 4.3.14.1 Definition + +This IOC represents a TDD high chip rate (hcr) radio cell controlled by another IRP agent. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.14.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------|-------------------|------------|------------|-------------|--------------| +| <code>temporaryOffset1</code> | CO | M | - | - | M | +| <code>syncCase</code> | CO | M | - | - | M | +| <code>timeSlotForSch</code> | CO | M | - | - | M | +| <code>schTimeSlot</code> | CO | M | - | - | M | +| <code>timeSlotHcrList</code> | O | M | - | - | M | + +#### 4.3.14.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| <i><code>temporaryOffset1</code>, <code>syncCase</code>, <code>timeSlotForSch</code> and <code>schTimeSlot</code> CO support qualifier</i> | <i>Itf-p2p is supported.</i> | + +#### 4.3.14.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.15 ExternalUtranCellTDDLcr + +#### 4.3.15.1 Definition + +This IOC represents a TDD low chip rate (lcr) radio cell controlled by another `IRPAgent`. For more information about radio cells, see 3GPP TS 23.002 [15]. + +#### 4.3.15.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------------------|-------------------|------------|------------|-------------|--------------| +| <code>tstdIndicator</code> | CO | M | - | - | M | +| <code>timeSlotLcrList</code> | O | M | - | - | M | + +#### 4.3.15.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------------------|------------------------------| +| <i><code>tstdIndicator</code> CO support qualifier</i> | <i>Itf-p2p is supported.</i> | + +#### 4.3.15.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.16 EP\_IuCS + +#### 4.3.16.1 Definition + +This IOC represents an end point of the Iu-CS interface. For more information Iu-CS interface, see 3GPP TS 23.002 [15]. + +#### 4.3.16.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------|-------------------|------------|------------|-------------|--------------| +| <code>connMscNumber</code> | CO | M | - | - | M | + +#### 4.3.16.3 Attribute constraints + +| Name | Definition | +|-------------------------------------------------|---------------------------------------------------| +| <code>connMscNumber</code> CO support qualifier | <i>The <code>farEndEntity</code> is supported</i> | + +#### 4.3.16.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.17 EP\_IuPS + +#### 4.3.17.1 Definition + +This IOC represents an end point of the Iu-PS interface. For more information Iu-PS interface, see 3GPP TS 23.002 [15]. + +#### 4.3.17.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------|-------------------|------------|------------|-------------|--------------| +| <code>connSgsnNumber</code> | CO | M | - | - | M | + +#### 4.3.17.3 Attribute constraints + +| Name | Definition | +|--------------------------------------------------|---------------------------------------------------| +| <code>connSgsnNumber</code> CO support qualifier | <i>The <code>farEndEntity</code> is supported</i> | + +#### 4.3.17.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.18 EP\_Iur + +#### 4.3.18.1 Definition + +This IOC represents an end point of the Iur interface. For more information Iur interface, see 3GPP TS 23.002 [15]. + +#### 4.3.18.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| <code>connectedRNCId</code> | CO | M | - | - | M | + +#### 4.3.18.3 Attribute constraints + +| Name | Definition | +|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <code>connectedRNCId</code><br>CO support qualifier | <p>The far end entity is supported.</p> <p>When supported, It either</p> <ul style="list-style-type: none"> <li>a) identifies one connected RNC; in such case, it contains one RNC-Id or</li> <li>b) identifies one connected BSC; in such case, it contains one RNC-Id to indentify BSC. (See “RNC-Id” in TS 23.003 [3]).</li> </ul> | + +#### 4.3.18.4 Notifications + +The common configuration notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table defines the attributes that are present in several Information Object Classes (IOCs) of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| aichPower | The Power of the the AICHchannel in an FDD cell, "AICH Power" in TS 25.433 [5].<br><br>allowedValues: See "AICH Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| bchPower | The power of the broadcast channel in the FDD mode cell, "BCH Power" in TS 25.433 [5].<br><br>allowedValues: See "DL Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cellCapabilityContainerFDD | Defined in 3GPP TS 25.423.<br>This attribute has 32 bits. Each bit indicates whether a cell supports a particular functionality.<br><br>allowedValues: See 'CellCapabilityContainer-FDD' in 3GPP TS 25.423. | type: BitString<br>multiplicity: 1<br>isOrdered: T<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cellCapabilityContainerTDD | Defined in 3GPP TS 25.423.<br>This attribute has 32 bits. Each bit indicates whether a cell supports a particular functionality.<br><br>allowedValues: See 'CellCapabilityContainer-TDD' in 3GPP TS 25.423. | type: BitString<br>multiplicity: 1<br>isOrdered: T<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cellIndividualOffset | Defined in 3GPP TS 25.331 (25.423). Attribute relevant for HO decision. Used to offset measured quantity value.<br><br>allowedValues: See "Cell individual offset" in TS 25.331 [9]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| cellMode | An attribute that identifies the cell mode.<br><br>allowedValues: FDD mode", "1.28McpsTDD mode", "3.84McpsTDD mode", "7.68McpsTDD mode". | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| cellParameterId | This attribute identifies unambiguously the TDD mode cell: 3.84 and 7.68 Mcps TDD - Code Groups, Scrambling Codes, Midambles and Toffset, or 1.28 Mcps TDD - SYNC-DL and SYNC-UL sequences, the scrambling codes and the midamble codes.<br>"Cell Parameter ID" in TS 25.433 [5]<br><br>allowedValues: See "Cell Parameter ID" in TS 25.433 [5]. | type: Integer<br>multiplicity: 0..1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| cId | The attribute is the identifier of a cell in one RNC, "C-id" in TS 25.401 [4] and "C-ID" in TS 25.433 [5].<br><br>allowedValues: see "C-ID" in TS 25.433 [5]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| closedLoopMode1SupportIndicator | Power control, defined in 3GPP TS 25.423<br>The Closed Loop Mode1 Support Indicator indicates whether the particular cell is capable to support Closed loop mode1 or not.<br><br>allowedValues: supported, not supported | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| connMscNumber | The MSC number of the far end MSC Server connected by the Iu-CS interface for which the end point is modelled, "MSC number" in TS 23.003 [3].<br><br>allowedValues: See "MSC number" in TS 23.003 [3] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| connectedRNCId | The RNC-Id of the far end RNC or BSC connected by the Iur interface for which the end point is modelled, "RNC-Id" in TS 23.003 [3].<br><br>allowedValues: See "RNC-Id" in TS 23.003 [3] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| connSgsnNumber | The SGSN number of the far end SGSN connected by the Iu-PS interface for which the end point is modelled, "SGSN number" in TS 23.003 [3].<br><br>allowedValues: See "SGSN number" in TS 23.003 [3] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| dpcModeChangeSupportIndicator | Power control, defined in 3GPP TS 25.423<br>The DPC Mode Change Support Indicator IE indicates that the particular cell is capable to support DPC mode change.<br><br>allowedValues: supported, not supported | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| deltaQrxlevmin | Cell (re)selection, defined in 3GPP TS 25.331<br>If present, the actual value of Qrxlevmin = Qrxlevmin + DeltaQrxlevmin.<br><br>allowedValues: See "DeltaQrxlevmin" in TS 25.331 [9]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| dpchConstantValue | DPCH Constant Value is the power margin in dB used by a UE to set the proper uplink power, "DPCH Constant Value" in Ref. TS 25.433 [5].<br><br>allowedValues: See "Constant Value" in TS 25.433 [5]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| dwPchPower | DwPCH Power is the power that shall be used for transmitting the DwPCH in a 1.28 Mcps TDD cell, "DwPCH Power" in TS 25.433 [5].<br><br>allowedValues: See "DwPCH Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| fachPower | The maximum power of the FACH transport channel that may be used in the cell, "Max FACH Power" in Ref 3GPP TS 25.433 [5].<br><br>allowedValues: See "DL Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| fpachPower | The maximum power of the FPACH channel that shall be used in TDD cell, "FPACH Power" in TS 25.433 [5].<br><br>allowedValues: See "FPACH Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| frameOffset | Neighbouring cells monitoring, defined in TS 25.423<br>Frame Offset is the required offset between the dedicated channel downlink transmission frames (CFN, Connection Frame Number) and the broadcast channel frame offset (Cell Frame Number). The Frame Offset is used in the translation between Connection Frame Number (CFN) on Iub/Iur and least significant 8 bits of SFN (System Frame Number) on Uu. The Frame Offset is UE and cell specific.<br><br>allowedValues: 0..255 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hcsPrio | Cell (re)selection for HCS<br>Defined in TS 25.331 [9].<br>This specifies the HCS priority level (0-7) for serving cell and neighbouring cells.<br>HCS priority level 0 means lowest priority and HCS priority level 7 means highest priority.<br><br>allowedValues: See "HCS_OFF <sub>mbms</sub> " in TS 25.331 [9]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| hsEnable | A label indicating whether or not HSDPA is enabled in the UTRAN cell. A value of 0 represents that HSDPA is not enabled and a value of 1 represents that HSDPA is enabled. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: 0,1<br>isNullable: True | +| hsFlag | A label indicating whether or not HSDPA is supported in the UTRAN cell. A value of 0 indicates that HSDPA is not supported and a value of 1 indicates that HSDPA is supported.<br><br>allowedValues: 0,1 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| id | An attribute whose "name+value" can be used as an RDN when naming an instance of the object class. This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: False | +| lac | Location Area Code, "LAC" in TS 23.003 [3].<br><br>allowedValues: See "LAC" in TS 25.413 [18]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| localCellId | The Local Cell id is used to uniquely identify the set of resources defined in a Node B to support a cell. It must be unique in Node B at a minimum, but may be unique in UTRAN. "Local Cell Identifier" TS 25.401 [4], "Local Cell ID" in 3GPP TS 25.433 [5].<br><br>allowedValues: See "Local Cell ID" in TS 25.433 [5]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| maximumAllowedULTxPower | Cell (re)selection, defined in TS 25.331 [9].<br>This information element indicates the maximum allowed uplink transmit power.<br><br>allowedValues: See "Maximum allowed UL TX power" in TS 25.331 [9].<br>A single integral value in dBm. Range: (-50..33). | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maximumTransmissionPower | <p>The maximum transmission power of a cell. It is the maximum power for all downlink channels added together, that is allowed to be used simultaneously in a cell, "Maximum Transmission Power" in TS 25.433 [5].</p> <p>allowedValues: See "Maximum Transmission Power" in TS 25.433 [5].</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| mcc | <p>Mobile Country Code, MCC (part of the PLMN Identifier) in, TS 23.003 [3].</p> <p>allowedValues: See "MCC" in "PLMN identity" in TS 25.413 [19].</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| mnc | <p>Mobile Network Code, "MNC" (part of the PLMN Identity) in TS 23.003 [3].</p> <p>allowedValues: See "MNC" in "PLMN identity" in TS 25.413 [18].</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| nsPlmnIdList | <p>List of unique identities for PLMN. Each element of the list is a tuple made up of mcc and mnc.</p> <p>allowedValues: A list of up to five entries of PLMN Identifiers.</p> <p>Note: A cell can broadcast up to 6 PLMN-id's. This is to support the case that one cell can be used by up to 6 operators' core networks.</p> <p>In case a cell is not shared, this attribute shall contain no information.</p> <p>In case a cell is shared (see TS 32.130 [22]):<br/> 1) this attribute shall contain the PLMN Id's of the Participating Operators;<br/> 2) the Master Operator PLMN Id is captured at RNCFunction level (attributes mcc and mnc).</p> <p>In case the Master Operator is also a Participating Operator, its PLMN Id is captured only at RNCFunction level.</p> <p>The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC).</p> <p>See TS 23.003 [3] subclause 2.2 and 12.1.<br/> See also TS 25.331 [9] sections 10.3.1.11 and 10.3.1.7a.</p> | <p>type: <<datatype>></p> <p>multiplicity: 0..5</p> <p>isOrdered: False</p> <p>isUnique: True</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| numOfHspdschs | <p>In FDD: the number of codes at the defined spreading factor(SF=16), within the complete code tree. See TS 25.433 [5].</p> <p>In TDD: the number of HS-PDSCHs in a Cell; TS 25.433 [5].</p> <p>allowedValues:<br/> 1. Range: (0..15) for FDD mode,<br/> 2. Range: (0..95) for TDD mode</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| numOfHssccchs | <p>The number of HS-SCCHs for one cell. See TS 25.433 [5].</p> <p>allowedValues: 1..32</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| pchPower | The power of PCH transport channel in the cell, "PCH Power" in Ref 3GPP TS 25.433 [5].<br><br>allowedValues: See "DL Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| penaltyTime | Cell (re)selection for HCS, defined in 3GPP TS 25.331 (TS 25.304)<br>This specifies the time duration for which the TEMPORARY_OFFSET is applied for a neighbouring cell.<br><br>allowedValues: See "Penalty_time" in TS 25.331 [9]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pichPower | The Power of the PICH channel in the cell, "PICH Power" in TS 25.433 [5].<br><br>allowedValues: See "PICH Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| primaryCcpchPower | The power of the primary CCPCH channel in the TDD cell, "PCCPCH Power" in TS 25.433 [5].<br><br>allowedValues: See "PCCPCH Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| primaryCpichPower | The power of the primary CPICH channel in the FDD mode cell, "Primary CPICH Power" in TS 25.433 [5].<br><br>allowedValues: See "Primary CPICH Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| primarySchPower | The power of the primary synchronisation channel in the FDD mode cell, "Primary SCH Power" in TS 25.433 [5].<br><br>allowedValues: See "DL Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| primaryScramblingCode | The primary DL scrambling code used by the FDD mode cell, "Primary Scrambling Code" in TS 25.433 [5].<br><br>allowedValues: See "Primary Scrambling Code" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qhcs | Cell (re)selection for HCS, defined in TS 25.331 [9].<br>This specifies the quality threshold levels for applying prioritised hierarchical cell re-selection.<br><br>allowedValues: See "Qhcs" in TS 25.331 [9] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qqualMin | Cell (re)selection, defined in TS 25.331 [9].<br>This specifies the minimum required quality level in the cell in dB. It is only applicable for FDD cells.<br><br>allowedValues: See "QqualMin" in TS 25.331 [9]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| qrxlevMin | Cell (re)selection, defined in TS 25.331 [9].<br>This specifies the minimum required RX level in the cell in dBm.<br><br>allowedValues: See "QrxlevMin" in TS 25.331 [9]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rac | Routing Area Code, "RAC" in TS 23.003 [3].<br><br>allowedValues: See "RAC" in TS 25.413 [18]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| readSFNIndicator | Neighbouring cells monitoring, defined in TS 25.331 [9].<br><br>allowedValues: See "Read SFN indicator" in TS 25.331 [9] | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| referenceTimeDiff<br>erenceToCell | Neighbouring cells monitoring, defined in TS 25.331 [9].<br>In the System Information message, the reference time difference to cell indicates the timing difference between the primary CCPCH of the current cell and the primary CCPCH of a neighbouring cell.<br>In the Measurement Control message, the reference time difference to cell indicates the timing difference between UE uplink transmission timing and the primary CCPCH of a neighbouring cell.<br><br>allowedValues:<br>1. See "Reference time difference to cell" in TS 25.331 [9].<br>2. A single integral value in chips. Range: (0..38400) by steps of 40, 256 or 2560. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| restrictionStateI<br>ndicator | Cell Access Control, defined in TS 25.423<br>The Restriction state indicator is the identifier indicates whether the cell is "Cell Reserved for Operator Use" or not. It is provided by DRNS and reported to SRNC.<br><br>allowedValues: cell reserved for operation, cell accessible | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rncId | IOC <i>ExternalUTRANGenericCell</i> and <i>ExternalRncFunction</i> :<br>Unique RNC ID for the associated RNC, "RNC Id" in TS 23.003 [3].<br>IOC <i>RncFunction</i> :<br>Unique RNC ID, "RNC Id" in TS 23.003 [3].<br><br>allowedValues: See "RNC-ID" in TS 25.413 [18]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| sac | Service Area Code, "SAC" in TS 23.003 [3].<br><br>allowedValues: See "SAC" in TS 25.413 [18]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| schPower | The power of the synchronisation channel in 3.84 Mcps TDD cell.<br><br>allowedValues: See "DL Power" in TS 25.433 [5]. | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| schTimeSlot | <p>The SCH Time Slot IE represents the first time slot (k) of a pair of time slots inside a Radio Frame that is assigned to the Physical Channel SCH.</p> <p>allowedValues: See "SCH Time Slot" in TS 25.433 [5].</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| sctdIndicator | <p>This attribute indicates whether SCTD is used, "SCDT Indicator" in TS 25.433 [5].</p> <p>See "SCDT Indicator" in TS 25.433 [5].</p> <p>allowedValues: active, inactive</p> | <p>type: <<enumeration>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| secondarySchPower | <p>The power of the secondary synchronisation channel in the FDD mode cell, "Secondary SCH Power" in TS 25.433 [5].</p> <p>allowedValues: See "DL Power" in TS 25.433 [5].</p> | <p>type: Real</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| sharNetTceMappingInfoList | <p>This attribute includes a list of elements. Each element is a tuple of shared PLMN Id (called "PLMN Target"), TCE ID and the corresponding TCE IP address.</p> <p>In case of network sharing and Logged MDT, this attribute is used to translate from the TCE IP Address to TCE ID when a Logged MDT is ordered to the UE and to translate the TCE ID to TCE IP address when the UE has sent the log to the network.</p> <p>Each element is a tuple of shared PLMN Id (called "PLMN Target"), TCE ID and the corresponding TCE IP address.</p> <p>allowedValues: See "PLMN Target", "Trace Collection Entity Address" and "Trace Collection Entity Id" in 3GPP TS 32.422 [12].</p> | <p>type: <<dataType>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| siptoSupported | <p>This attribute indicates whether the RNC supports SIPTO function. A value of 0 represents that SIPTO is not supported and a value of 1 represents that SIPTO is supported (by the RNC).</p> <p>allowedValues: 0..1</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| snaInformation | <p>Shared Networks Access Control, defined in 3GPP TS 25.423 [5].</p> <p>This information element contains a list of Shared Network Areas, identified by the Shared Network Area Code (SNAC) which a certain cell belongs to.</p> <p>allowedValues: See "shared networks access control" defined in 3GPP TS 25.423 [5].</p> | <p>type: <<dataType>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| sttdSupportIndicator | <p>Power control, defined in 3GPP TS 25.423.</p> <p>The STTD Support Indicator indicates whether the STTD can be applied to DL DPCH and F-DPCH in the cell or not.</p> <p>allowedValues: active, inactive</p> | <p>type: <<enumeration>></p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| syncCase | <p>The SCH and PCCPCH in a TDD cell are mapped on one or two downlink slots per frame. There are two cases of Sync Case as follows</p> <ul style="list-style-type: none"> <li>- SCH and PCCPCH allocated in a single TS#k</li> <li>- SCH allocated in two TS: TS#k and TS#k+8. PCCPCH allocated in TS#k</li> </ul> <p>See "Synch Case" in TS 25.433 [5].</p> <p>allowedValues: See "Sync Case" in TS 25.433 [5].</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tceIDMappingInfoList | <p>This attribute includes a list of TCE ID and the corresponding TCE IP address. It is used in Logged MDT case to provide the information to the RNC to get the corresponding TCE IP address when there is an MDT log received from the UE. This attribute is used if only one PLMN is supported.</p> <p>allowedValues: See "Trace Collection Entity Address" and "Trace Collection Entity Id" in 3GPP TS 32.422 [12].</p> | type: <<dataType>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| temporaryOffset1 | <p>Cell (re)selection for HCS, defined in 3GPP TS 25.331 (TS 25.304).</p> <p>This specifies the offset applied to the H and R criteria for a neighbouring cell for the duration of PENALTY_TIME. It is used for TDD and GSM cells and for FDD cells in case the quality measure for cell selection and re-selection is set to CPICH RSCP.</p> <p>allowedValues: See "Temporary_offset1" in TS 25.331 [9].</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| temporaryOffset2 | <p>Cell (re)selection for HCS, defined in 3GPP TS 25.331 (TS 25.304).</p> <p>This specifies the offset applied to the H and R criteria for a neighbouring cell for the duration of PENALTY_TIME. It is used for FDD cells in case the quality measure for cell selection and re-selection is set to CPICH Ec/No.</p> <p>allowedValues: See "Temporary_offset2" in TS 25.331 [9].</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeSlotForSch | <p>The Time Slot represents the time interval assigned to a Physical Channel referred to the start of a Radio Frame,</p> <p>allowedValues: See "SCH Time Slot" in TS 25.433 [5].</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| timeSlotHcrList | <p>This attribute defines the time slot configuration information in the TDD cell.</p> <p>It is a list which contains 15 (for 3.84 or 7.68 Mcps TDD cell) items.</p> <p>allowedValues:<br/>An item has three parts: timeSlotId, timeSlotDirection, timeSlotStatus. ( TS 25.433 [5]) where:</p> <p style="padding-left: 20px;">timeSlotId:<br/>type: Integer<br/>allowedValues: 0..14;</p> <p style="padding-left: 20px;">timeSlotDirection:<br/>type: <<enumeration>><br/>allowedValues: UI, DI;</p> <p style="padding-left: 20px;">timeSlotStatus:<br/>type: <<enumeration>><br/>allowedValues: Active, Not active;</p> | <p>type: <<dataType>><br/>multiplicity: 15<br/>isOrdered: False<br/>isUnique: True<br/>defaultValue: None<br/>isNullable: False</p> | +| timeSlotLcrList | <p>This attribute defines the time slot configuration information in the TDD cell.</p> <p>It is a list which contains 7 (for 1.28 Mcps TDD cell) items.</p> <p>allowedValues:<br/>An item has three parts: timeSlotId, timeSlotDirection, timeSlotStatus, corresponding to Time Slot LCR, Time Slot Direction, Time Slot Status ( TS 25.433 [5]).</p> <p>If multiple frequencies exist within the cell, the timeSlotList indicates the Time Slot configuration of Primary Frequency.</p> <p style="padding-left: 20px;">timeSlotId:<br/>type: Integer<br/>allowedValues: 0..6;</p> <p style="padding-left: 20px;">timeSlotDirection:<br/>type: <<enumeration>><br/>allowedValues: UI, DI;</p> <p style="padding-left: 20px;">timeSlotStatus:<br/>Type: <<enumeration>><br/>allowedValues: Active, Not active;</p> | <p>type: <<dataType>><br/>multiplicity: 7<br/>isOrdered: False<br/>isUnique: True<br/>defaultValue: None<br/>isNullable: False</p> | +| tmaFunctionList | <p>This is a referential attribute to list the DNs of TmaFunction(s) that support the <i>UTRANGenericCell</i>.</p> <p>allowedValues: See TS 32.300 [13] for definition of DN.</p> | <p>type: DN<br/>multiplicity: 1..*<br/>isOrdered: False<br/>isUnique: True<br/>defaultValue: None<br/>isNullable: True</p> | +| tstdIndicator | <p>This attribute indicates whether TSTD is used. See "TSDT Indicator" in TS 25.433 [5].</p> <p>allowedValues: active, inactive</p> | <p>type: <<enumeration>><br/>multiplicity: 1<br/>isOrdered: N/A<br/>isUnique: N/A<br/>defaultValue: None<br/>isNullable: False</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| txDiversityIndicator | Defined in 3GPP TS 25.331 (25.423)<br>This attribute indicates whether following conditions are satisfied:<br>Primary CPICH is broadcast from two antennas<br>STTD is applied to Primary CCPCH<br>TSTD is applied to Primary SCH and Secondary SCH<br><br>allowedValues: See "TX Diversity Indicator" in TS 25.331 [9] | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| uarfcn | The UTRA absolute Radio Frequency Channel number for TDD mode cell, UARFCN ( TS 25.433 [5]). For 1.28Mcps TDD, if multiple frequencies exist within the cell, the uarfcn indicates the frequency of Primary Frequency.<br><br>allowedValues: 0..16383 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| uarfcnLCRList | For 1.28 Mcps TDD, if multiple frequencies exist within the cell, this is a list of items (the UARFCN and Time Slot configuration information of the Secondary Frequencies).<br><br>allowedValues:<br>1. An item has two parts: uarfcn and timeSlotListLcr. The second part is a list of elements which have the sub-elements: timeSlotId, timeSlotDirection, timeSlotStatus.<br><br>2. These attributes correspond to "UARFCN, Time Slot LCR, Time Slot Direction, Time Slot Status" (TS 25.433 [5]).<br><br>3. For "uarfcn, timeSlotId, timeSlotDirection, timeSlotStatus", see "UARFCN, Time Slot LCR, Time Slot Direction, Time Slot Status" in TS 25.433 [5].<br><br>4. For maximum number of the Secondary Frequencies per cell, see "maxFrequencyinCell-1" in TS 25.433 [5]. | type: See note.<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| uarfcnDl | The DL UTRA absolute Radio Frequency Channel number for FDD mode cell.<br><br>allowedValues: See "UARFCN" in TS 25.433 [5]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| uarfcnUl | The UL UTRA absolute Radio Frequency Channel number for FDD mode cell.<br><br>allowedValues: See "UARFCN" in TS 25.433 [5]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| uraList | A list of UTRAN Registration Area identities that an UtranCell can belong to.<br><br>allowedValues:<br>1. For URA, see "URA identity" in TS 25.331[9], subclause 10.3.2.6.<br>2. For maximum number of URAs per cell, see "maxURA" in TS 25.331 [9], subclause 10.3.10. | type: Integer<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| <b>Attribute related to role</b> | | | +| iubLink | This attribute carries a IubLink DN.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| atmChannelTerminationPoint | This attribute carries the set of <i>ATMChannelTerminationPoint</i> 's DN(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: F<br>isUnique: T<br>defaultValue: None<br>isNullable: True | +| nodeBFunction | This attribute carries a <i>NodeBFunction</i> DN.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| utrANGenericCell | This attribute carries the set of related <i>UTRANGenericCell</i> derivatives' DN(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: F<br>isUnique: T<br>defaultValue: None<br>isNullable: True | +| adjacentCell | It carries the DN of the <i>UtranGenericCell</i> or the <i>ExternalUTRANGenericCell</i> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| controlledCellList | This attribute carries a set of DNs of derivatives of <i>ExternalUTRANGenericCell</i> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: F<br>isUnique: T<br>defaultValue: None<br>isNullable: True | +| relatedAntennaList | This is an attribute to list the DNs of <i>AntennaFunction</i> (s) (see TS 28.662 [17]) that support the <i>UTRANGenericCell</i> .<br><br>See “relatedAntennaList” in TS 28.662 [17]<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| relatedSectorEquipment | This is an attribute to the DN of <i>SectorEquipment</i> (see TS 28.662 [17]) that supports the <i>UTRANGenericCell</i> .<br><br>See “relatedSectorEquipment” TS 28.662 [17].<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| relatedTmaList | This is an attribute to list the DNs of <i>TmaFunction</i> (s) (see TS 28.662 [17]) that support the <i>UTRANGenericCell</i> .<br><br>See “relatedTmaList” TS 28.662 [17].<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| iubLink | This attribute carries a <i>IubLink</i> DN.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| controllingRNC | This attribute carries one ExternalRNCFunction DN.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This subclause presents a list of notifications, defined in [11], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [7], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|---------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [11]) | | + +### 4.5.2 Configuration notifications + +This subclause presents a list of notifications, defined in [10], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [7], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | + +# Annex A (informative): RET Control Architecture + +The Itf-N provides an abstraction of resources to allow the monitor and control of physical resource from the network level management systems. For RET, the antenna tilt is controlled via a control unit which is located within the NodeB (from a management perspective). The control unit sends commands to actuators located at the tower top, in order to read, and to adjust antenna tilt values. + +The `AntennaFunction` class will report failures and malfunctions of either the control unit, or the tilt. + +There are several configurations of antennae. Some support the transmission of several frequencies from a single radome while others are deployed as an array in order to provide effective coverage. + +Hence in the UTRAN model there is an N:M relationship between the `UtranCell` class and the `AntennaFunction` class, permitting the model to support all possibilities. The figure B.1 below illustrates the RET architecture. + +![Overall RET architecture diagram showing NMS (IRP Manager), IRP Agent, EM, Node B, and RET components and their interfaces (Itf-N, Itf-B).](f1091147d93cee4dfa88498610e395a7_img.jpg) + +``` + +graph TD + NMS["NMS (IRP Manager)"] + + subgraph "System Context A" + IRP_EM_A["IRP Agent +EM"] + end + + subgraph "System Context B" + NodeB_L["Node B"] + IRP_EM_B["IRP Agent +EM"] + RET_L["RET"] + end + + NodeB_R["Node B"] + RET_R["RET"] + + Antenna_L((Antenna)) + Antenna_R((Antenna)) + + NMS <-- "Itf-N (System Context A)" --> IRP_EM_A + NMS <-- "Itf-N (System Context B)" --> IRP_EM_B + IRP_EM_A -- "Itf-B" --> NodeB_R + + NodeB_L <--> Antenna_L + NodeB_R <--> Antenna_R + + IRP_EM_B --- NodeB_L + RET_L --- NodeB_L + RET_R --- NodeB_R + +``` + +The diagram illustrates the overall RET architecture. At the top center is a box labeled 'NMS (IRP Manager)'. Below it is a box containing 'IRP Agent' and 'EM' representing System Context A. To the left and right are boxes labeled 'Node B'. The 'Node B' on the left (System Context B) contains its own 'IRP Agent' and 'EM' sub-box, which is connected to the 'NMS (IRP Manager)' via a double-headed arrow labeled 'Itf-N (System Context B)'. The 'IRP Agent' in System Context A is connected to the 'Node B' on the right via an arrow labeled 'Itf-B'. Each 'Node B' contains a 'RET' component and is connected to its respective antenna icon by a double-headed arrow. + +Overall RET architecture diagram showing NMS (IRP Manager), IRP Agent, EM, Node B, and RET components and their interfaces (Itf-N, Itf-B). + +Figure B.1: Overall RET architecture + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|----------------------------------------------------------------------------|-----|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2013-03 | SA#59 | SP-130057 | 001 | 1 | CR R11 28.652 Addition of missing Network Sharing support for MDT | F | 11.0.0 | 11.1.0 | +| 2013-09 | SA#61 | SP-130433 | 002 | 1 | UTRAN NRM Correction of wrong import references | F | 11.1.0 | 11.2.0 | +| 2014-06 | SA#64 | SP-140332 | 003 | 2 | Correction of operationalState attribute definitions | F | 11.2.0 | 11.3.0 | +| | | | 004 | 1 | Correct synCase attribute description and usage of BITSTRING(32) data type | F | | | +| | | SP-140359 | 005 | - | remove the feature support statements | F | | | +| 2014-09 | | | | | Correction of editorial issues(MCC) | | 11.3.0 | 11.3.1 | +| 2014-09 | | | | | Upgrade to Rel-12 (MCC) | | 11.3.1 | 12.0.0 | +| 2014-12 | SA#66 | SP-140800 | 008 | 2 | Add support for sharing of UTRAN | B | 12.0.0 | 12.1.0 | +| 2015-06 | SA#68 | SP-150316 | 011 | - | Add missing IOC notification support | A | 12.1.0 | 12.2.0 | +| | | | 013 | - | Correct IsNullable properties for power attributes | A | | | +| 2015-12 | SA#70 | SP-150691 | 014 | 1 | Align id attribute definitions | A | 12.2.0 | 12.3.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13(MCC) | | 12.3.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28653/raw.md b/marked/Rel-16/28_series/28653/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1482ed84af3faf40c488a9ac9971699e1747ac9f --- /dev/null +++ b/marked/Rel-16/28_series/28653/raw.md @@ -0,0 +1,2814 @@ + + + + + + +# Contents + +Foreword .....5 + +Introduction .....5 + +1 Scope.....6 + +2 References.....6 + +3 Definitions and abbreviations .....7 + +3.1 Definitions.....7 + +3.2 Abbreviations .....7 + +4 Solution Set Definitions .....8 + +**Annex A (normative): CORBA Solution Set.....9** + +A.0 Introduction.....9 + +A.1 Architectural features.....9 + +A.1.0 General .....9 + +A.1.1 Syntax for Distinguished Names.....9 + +A.1.2 Rules for NRM extensions .....9 + +A.2 Mapping .....10 + +A.2.1 General mapping .....10 + +A.2.2 Information Object Class (IOC) mapping.....10 + +A.2.2.1 IOC RncFunction.....10 + +A.2.2.2 IOC UtranGenericCell.....11 + +A.2.2.3 IOC NodeBFunction.....12 + +A.2.2.4 IOC IubLink .....12 + +A.2.2.5 IOC ExternalUtranGenericCell .....13 + +A.2.2.6 Void.....14 + +A.2.2.7 IOC ExternalRncFunction .....14 + +A.2.2.8 UtranCellFDD .....14 + +A.2.2.9 UtranCellTDD .....15 + +A.2.2.10 UtranCellTDDLcr.....15 + +A.2.2.11 UtranCellTDDHcr .....16 + +A.2.2.12 ExternalUtranCellFDD .....16 + +A.2.2.13 ExternalUtranCellTDD.....17 + +A.2.2.14 ExternalUtranCellTDDHcr.....17 + +A.2.2.15 ExternalUtranCellTDDLcr.....17 + +A.2.2.16 IOC UtranRelation.....18 + +A.2.2.17 IOC EP\_IuCS .....18 + +A.2.2.18 IOC EP\_IuPS.....18 + +A.2.2.19 IOC EP\_Iur .....18 + +A.3 Solution Set definitions .....19 + +A.3.1 IDL definition structure.....19 + +A.3.2 IDL specification "UtranNetworkResourcesNRMDefs.idl" .....19 + +**Annex B (normative): XML Definitions.....26** + +B.0 Introduction.....26 + +B.1 Architectural features.....26 + +B.1.0 General .....26 + +B.1.1 Syntax for Distinguished Names.....26 + +B.2 Mapping .....26 + +B.2.1 General mapping .....26 + +B.2.2 Information Object Class (IOC) mapping.....26 + +B.3 Solution Set definitions .....27 + +B.3.1 XML definition structure .....27 + +B.3.2 Graphical Representation .....27 +B.3.3 XML schema "utranNrm.xsd" .....28 +Annex C (informative): Change history.....48 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.651: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- 28.652: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- 28.653: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definition".** + +# --- 1 Scope + +The present document specifies the Solution Sets for the UTRAN NRM IRP. + +This Solution Set specification is related to 3GPP TS 28.652 V14.0.X [4]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.652: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [9] Void +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [13] 3GPP TS 28.623: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definition". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For terms and definitions please refer to 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.600 [3] and 3GPP TS 28.652 [4]. + +**XML file:** See definition of [13]. + +**XML document:** See definition of [13]. + +**XML declaration:** See definition of [13]. + +**XML element:** See definition of [13]. + +**empty XML element:** See definition of [13]. + +**XML content (of an XML element):** See definition of [13]. + +**XML start-tag:** See definition of [13]. + +**XML end-tag:** See definition of [13]. + +**XML empty-element tag:** See definition of [13]. + +**XML attribute specification:** See definition of [13]. + +**DTD:** See definition of [13]. + +**XML schema:** See definition of [13]. + +**XML namespace:** See definition of [13]. + +**XML complex type:** See definition of [13]. + +**XML element type:** See definition of [13]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IS | Information Service | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SIPTO | Selected IP Traffic Offload | +| SS | Solution Set | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP UTRAN NRM IRP Solution Set Definitions: + +- 3GPP UTRAN NRM IRP CORBA SS (Annex A) + +- 3GPP UTRAN NRM IRP XML Definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 Introduction + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in UTRAN NRM IRP: Information Service (TS 28.652 [4]). + +## --- A.1 Architectural features + +### A.1.0 General + +The overall architectural feature of UTRAN Network Resources IRP is specified in 3GPP TS 28.652 [4]. This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [13]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [13]. + +### --- A.2 Mapping + +#### A.2.1 General mapping + +See clause A.1.2.1 of [13]. + +#### A.2.2 Information Object Class (IOC) mapping + +##### A.2.2.1 IOC RncFunction + +**Mapping from NRM IOC RncFunction attributes to SS equivalent MOC RncFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------------------|---------------------------|----------------------------------------------------------| +| mcc | mcc | long | +| mnc | mnc | long | +| rncId | rncId | long | +| siptoSupported | siptoSupported | short | +| tcelDMappingInfoList | tcelDMappingInfoList | GenericNRMAtributeTypes::<br>TcelDMappingInfoListType | +| sharNetTceMappingInfoList | sharNetTceMappingInfoList | genericEUTRANNRMAtributeTypes::<br>SharNetTceMappingInfo | + +##### A.2.2.2 IOC UtranGenericCell + +**Mapping from NRM IOC UtranGenericCell attributes and associations to SS equivalent MOC UtranGenericCell attributes** + +| IS Attributes | SS Attributes | SS Type | +|----------------------------------|-------------------------------|------------------------------------------------------------------| +| cId | cId | long | +| localCellId | localCellId | long | +| relatedAntennaList | relatedAntennaList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| maximumTransmissionPower | maximumTransmissionPower | short | +| lac | lac | long | +| pichPower | pichPower | float | +| pchPower | pchPower | float | +| fachPower | fachPower | float | +| rac | rac | long | +| sac | sac | long | +| uraList | uraList | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | +| associatedWith/utranCell-IubLink | utranCellIubLink | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| cellMode | cellMode | GenericNRMAAttributeTypes::CellModeEnumType | +| operationalState | operationalState | StateManagementIRPOptConstDefs::OperationalStateTypeOpt | +| hsFlag | hsFlag | short | +| hsEnable | hsEnable | short | +| numOfHspdschs | numOfHspdschs | short | +| numOfHssccchs | numOfHssccchs | short | +| frameOffset | frameOffset | short | +| cellIndividualOffset | cellIndividualOffset | float | +| hcsPrio | hcsPrio | short | +| maximumAllowedU1TxPower | maximumAllowedU1TxPower | short | +| snaInformation | snaInformation | GenericNRMAAttributeTypes::snaInformationType | +| qrxlevMin | qrxlevMin | short | +| deltaQrxlevmin | deltaQrxlevmin | short | +| qhcs | qhcs | short | +| penaltyTime | penaltyTime | short | +| referenceTimeDifferenceToCell | referenceTimeDifferenceToCell | short | +| readSFNIndicator | readSFNIndicator | Boolean | +| restrictionStateIndicator | restrictionStateIndicator | GenericNRMAAttributeTypes::restrictionStateEnumType | +| dpcModeChangeSupportIndicator | dpcModeChangeSupportIndicator | GenericNRMAAttributeTypes::dpcModeChangeSupportEnumType | +| relatedTmaList | relatedTmaList | GenericNetworkResourceIRPSystem::AttributeTypes::MOReferenceSet | +| relatedSectorEquipment | relatedSectorEquipment | GenericNetworkResourceIRPSystem::AttributeTypes::MOReference | +| nsPlmnIdList | nsPlmnIdList | GenericNRMAAttributeTypes::NsPlmnIdListType | + +| IS Attributes | SS Attributes | SS Type | +|----------------------------------------------------------------------------------------------------|---------------|---------| +| NOTE 1: For all support qualifiers with the value "O", see attribute constraints in TS28.652 [4]. | | | +| NOTE 2: For all support qualifiers with the value "CO" see attribute constraints in TS 28.652 [4]. | | | +| NOTE 3: For all support qualifiers with the value "CM" see attribute constraints in TS 28.652 [4]. | | | + +#### A.2.2.3 IOC NodeBFunction + +##### Mapping from NRM IOC NodeBFunction attributes and associations to SS equivalent MOC NodeBFunction attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------------------------------|----------------------|-------------------------------------------------------------------| +| connectedTo/<br>nodeBFunction-IubLink | nodeBFunctionIubLink | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReference | + +#### A.2.2.4 IOC IubLink + +##### Mapping from NRM IOC IubLink attributes and associations to SS equivalent MOC IubLink attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------------------------------------------|---------------------------------------|----------------------------------------------------------------------| +| AssociatedWith/<br>IubLink-UtranCell | IubLinkUtranCell | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReferenceSet | +| ConnectedTo/<br>IubLink-NodeBFunction | IubLinkNodeBFunction | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReference | +| AssociatedWith1/<br>IubLink-ATMChannelTerminationPoint | IubLinkATMChannelTermination<br>Point | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReference | + +#### A.2.2.5 IOC ExternalUtranGenericCell + +##### Mapping from NRM IOC ExternalUtranGenericCell attributes and associations to SS equivalent MOC ExternalUtranGenericCell attributes + +| IS Attributes | SS Attributes | SS Type | +|-------------------------------|-------------------------------|---------------------------------------------------------------| +| cId | cId | long | +| mcc | mcc | short | +| mnc | mnc | short | +| rncId | rncId | long | +| cellMode | cellMode | GenericNRMAAttributeTypes::CellModeEnumType | +| lac | lac | long | +| rac | rac | long | +| controllingRnc | controllingRnc | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| hsFlag | hsFlag | short | +| frameOffset | frameOffset | short | +| cellIndividualOffset | cellIndividualOffset | long | +| hcsPrio | hcsPrio | short | +| maximumAllowedUltePower | maximumAllowedUltePower | short | +| qrxlevMin | qrxlevMin | short | +| deltaQrxlevmin | deltaQrxlevmin | short | +| Qhcs | qhcs | short | +| penaltyTime | penaltyTime | short | +| referenceTimeDifferenceToCell | referenceTimeDifferenceToCell | short | +| readSFNIndicator | readSFNIndicator | Boolean | +| restrictionStateIndicator | restrictionStateIndicator | GenericNRMAAttributeTypes::restrictionStateEnumType | +| dpcModeChangeSupportIndicator | dpcModeChangeSupportIndicator | GenericNRMAAttributeTypes::dpcModeChangeSupportEnumType | +| snaInformation | snaInformation | GenericNRMAAttributeTypes::snaInformationType | + +NOTE 1: For all support qualifiers with the value "O", see attribute constraints in TS 28.652 [4]. +NOTE 2: For all support qualifiers with the value "CO" see attribute constraints in TS 28.652 [4]. +NOTE 3: For all support qualifiers with the value "CM" see attribute constraints in TS 28.652 [4]. + +#### A.2.2.6 Void + +##### A.2.2.7 IOC ExternalRncFunction + +Mapping from NRM IOC ExternalRncFunction attributes and associations to SS equivalent MOC ExternalRncFunction attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------|--------------------|------------------------------------------------------------------| +| mcc | mcc | long | +| mnc | mnc | long | +| rncId | rncId | long | +| controlledCellList | controlledCellList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +NOTE: For all support qualifiers with the value "O", see attribute constraints in TS 28.652 [4]. + +#### A.2.2.8 UtranCellFDD + +Mapping from NRM IOC UtranCellFDD attributes and associations to SS equivalent MOC UtranCellFDD attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------------------------|---------------------------------|-------------------------------------------------------------------| +| uarfcnUl | uarfcnUl | short | +| uarfcnDl | uarfcnDl | short | +| primaryScramblingCode | primaryScramblingCode | short | +| primaryCpichPower | primaryCpichPower | float | +| primarySchPower | primarySchPower | float | +| secondarySchPower | secondarySchPower | float | +| bchPower | bchPower | float | +| aichPower | aichPower | float | +| qqualMin | qqualMin | float | +| cellCapabilityContainerFDD | cellCapabilityContainerFDD | FDDNetworkResourceMAttributeTypes::CellCapabilityContainerFDDType | +| txDiversityIndicator | txDiversityIndicator | FDDNetworkResourceMAttributeTypes::txDiversityIndicatorEnumType | +| temporaryOffset1 | temporaryOffset1 | short | +| temporaryOffset2 | temporaryOffset2 | short | +| sttdSupportIndicator | sttdSupportIndicator | FDDNetworkResourceMAttributeTypes::sttdSupportEnumType | +| closedLoopModelSupportIndicator | closedLoopModelSupportIndicator | FDDNetworkResourceMAttributeTypes::closedLoopMode1EnumType | + +NOTE: For all support qualifiers with the value "CO" see attribute constraints in TS 28.652 [4]. + +#### A.2.2.9 UtranCellTDD + +Mapping from NRM IOC UtranCellTDD attributes and associations to SS equivalent MOC UtranCellTDD attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------------------------------------------------------------------------------------|----------------------------|-------------------------------------------------------------------| +| uarfcn | uarfcn | short | +| cellParameterId | cellParameterId | long | +| primaryCcpchPower | primaryCcpchPower | float | +| cellCapabilityContainerTDD | cellCapabilityContainerTDD | TDDNetworkResourceMAttributeTypes::cellCapabilityContainerTDDType | +| sctdIndicator | sctdIndicator | TDDNetworkResourceMAttributeTypes::sctdSupportEnumType | +| dpchConstantValue | dpchConstantValue | long | +| NOTE: For all support qualifiers with the value "CO" see attribute constraints in TS 28.652 [4]. | | | + +##### A.2.2.10 UtranCellTDDLcr + +Mapping from NRM IOC UtranCellTDDLcr attributes and associations to SS equivalent MOC UtranCellTDDLcr attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------------------------------------------------------------------------------------|---------------------|------------------------------------------------------| +| uarfcnLCRList | uarfcnLCRList | TDDNRMAAttributeTypes::UarfcnLCRListConfigStructType | +| dwPchPower | dwPchPower | float | +| fpachPower | fpachPower | float | +| tstdIndicator | tstdIndicator | TDDNRMAAttributeTypes::tstdIndicatorEnumType | +| timeSlotLCRLis<br>t | timeSlotLCRLis<br>t | TDDNRMAAttributeTypes::TimeSlotListConfigStructType | +| NOTE: For all support qualifiers with the value "CO" see attribute constraints in TS 28.652 [4]. | | | + +##### A.2.2.11 UtranCellTDDHcr + +Mapping from NRM IOC UtranCellTDDHcr attributes and associations to SS equivalent MOC UtranCellTDDHcr attributes + +| IS Attributes | SS Attributes | SS Type | +|------------------|------------------|-----------------------------------------------------| +| schPower | schPower | float | +| temporaryOffset1 | temporaryOffset1 | short | +| syncCase | syncCase | short | +| timeSlotForSch | timeSlotForSch | short | +| schTimeSlot | schTimeSlot | short | +| timeSlotHCRLList | timeSlotHCRLList | TDDNRMAAttributeTypes::TimeSlotListConfigStructType | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +##### A.2.2.12 ExternalUtranCellFDD + +Mapping from NRM IOC ExternalUtranCellFDD attributes and associations to SS equivalent MOC ExternalUtranCellFDD attributes + +| IS Attributes | SS Attributes | SS Type | +|----------------------------|----------------------------|-------------------------------------------------------------------| +| uarfcnU1 | uarfcnU1 | short | +| uarfcnD1 | uarfcnD1 | short | +| primaryScramblingCode | primaryScramblingCode | short | +| primaryCpichPower | primaryCpichPower | float | +| qqualMin | qqualMin | long | +| cellCapabilityContainerFDD | cellCapabilityContainerFDD | FDDNetworkResourceMAttributeTypes::CellCapabilityContainerFDDType | +| txDiversityIndicator | txDiversityIndicator | FDDNetworkResourceMAttributeTypes::txDiversityIndicatorEnumType | +| temporaryOffset1 | temporaryOffset1 | short | +| temporaryOffset2 | temporaryOffset2 | short | +| sttdSupportIndicator | sttdSupportIndicator | FDDNetworkResourceMAttributeTypes::sttdSupportEnumType | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +#### A.2.2.13 ExternalUtranCellTDD + +Mapping from NRM IOC ExternalUtranCellTDD attributes and associations to SS equivalent MOC ExternalUtranCellTDD attributes + +| IS Attributes | SS Attributes | SS Type | +|----------------------------|----------------------------|-------------------------------------------------------------------| +| uarfcn | uarfcn | short | +| cellParameterId | cellParameterId | long | +| primaryCcpchPower | primaryCcpchPower | float | +| cellCapabilityContainerTDD | cellCapabilityContainerTDD | TDDNetworkResourceMAttributeTypes::CellCapabilityContainerFDDType | +| sctdIndicator | sctdIndicator | TDDNetworkResourceMAttributeTypes::sctdSupportEnumType | +| dpchConstantValue | dpchConstantValue | long | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +##### A.2.2.14 ExternalUtranCellTDDHcr + +Mapping from NRM IOC ExternalUtranCellTDDHcr attributes and associations to SS equivalent MOC ExternalUtranCellTDDHcr attributes + +| IS Attributes | SS Attributes | SS Type | +|------------------|------------------|-----------------------------------------------------| +| temporaryOffset1 | temporaryOffset1 | short | +| syncCase | syncCase | short | +| timeSlotForSch | timeSlotForSch | short | +| schTimeSlot | schTimeSlot | short | +| timeSlotHCRList | timeSlotHCRList | TDDNRMAAttributeTypes::TimeSlotListConfigStructType | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +##### A.2.2.15 ExternalUtranCellTDDLcr + +Mapping from NRM IOC ExternalUtranCellTDDLcr attributes and associations to SS equivalent MOC ExternalUtranCellTDDLcr attributes + +| IS Attributes | SS Attributes | SS Type | +|-----------------|-----------------|-----------------------------------------------------| +| tstdIndicator | tstdIndicator | TDDNRMAAttributeTypes::tstdIndicatorEnumType | +| timeSlotLCRList | timeSlotLCRList | TDDNRMAAttributeTypes::TimeSlotListConfigStructType | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +##### A.2.2.16 IOC UtranRelation + +##### Mapping from NRM IOC UtranRelation attributes and associations to SS equivalent MOC UtranRelation attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| adjacentCell | adjacentCell | string | + +#### A.2.2.17 IOC EP\_luCS + +##### Mapping from NRM IOC EP\_luCS attributes and associations to SS equivalent MOC EP\_luCS attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|----------------| +| connMscNumber | connMscNumber | unsigned short | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +#### A.2.2.18 IOC EP\_luPS + +##### Mapping from NRM IOC EP\_luPS attributes and associations to SS equivalent MOC EP\_luPS attributes + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|----------------| +| connSgsnNumber | connSgsnNumber | unsigned short | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +#### A.2.2.19 IOC EP\_lur + +##### Mapping from NRM IOC EP\_lur attributes and associations to SS equivalent MOC EP\_lur attributes + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|----------------| +| connectedRncId | connectedRncId | unsigned short | + +NOTE: For all support qualifiers with the value “CO” see attribute constraints in TS 28.652 [4]. + +## A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the UTRAN NRM IRP. + +#### A.3.2 IDL specification "UtranNetworkResourcesNRMDefs.idl" + +``` +//File:UtranNetworkResourcesNRMDefs.idl +#ifndef _UTRANNETWORKRESOURCESNRMDefs_IDL_ +#define _UTRANNETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module UtranNetworkResourcesNRMDefs +{ + + /** + * Definitions for MO class RncFunction + */ + interface RncFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "RncFunction"; + // Attribute Names + // + const string mcc= "mcc"; + const string mnc= "mnc"; + const string rncId= "rncId"; + const string siptoSupported= "siptoSupported"; + const string tceIDMappingInfoList= "tceIDMappingInfoList"; + const string sharNetTceMappingInfoList= "sharNetTceMappingInfoList"; + }; + /** + * Definitions for MO class UtranGenericCell + */ + interface UtranGenericCell : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "UtranGenericCell"; + // Attribute Names + // + const string utranCellIubLink = "utranCellIubLink"; + const string cId= "cId"; + const string localCellId= "localCellId"; + const string maximumTransmissionPower= "maximumTransmissionPower"; + const string relatedAntennaList= "relatedAntennaList"; + const string primarySchPower= "primarySchPower"; + const string secondarySchPower= "secondarySchPower"; + const string bchPower= "bchPower"; + const string fpachPower= "fpachPower"; + const string pichPower= "pichPower"; + const string pchPower= "pchPower"; + const string fachPower= "fachPower"; + const string cellMode = "cellMode"; + + const string lac= "lac"; + const string rac= "rac"; + const string sac= "sac"; + const string uralList= "uralList"; + const string operationalState = "operationalState"; + const string relatedTmaList = "relatedTmaList"; + const string hsFlag = "hsFlag"; + const string hsEnable = "hsEnable"; + const string numOfHspdschs = "numOfHspdschs"; + const string numOfHssccchs = "numOfHssccchs"; + const string snaInformation = "snaInformation"; + const string frameOffset = "frameOffset"; + const string cellIndividualOffset = "cellIndividualOffset"; + const string hcsPrio = "hcsPrio"; + const string maximumAllowedUlTxPower = "maximumAllowedUlTxPower"; + const string qrxlevMin = "qrxlevMin"; + }; +} +``` + +----- + +----- + +``` + const string deltaQrxlevmin = "deltaQrxlevmin"; + const string qhcs = "qhcs"; + const string penaltyTime = "penaltyTime"; + const string referenceTimeDifferenceToCell = "referenceTimeDifferenceToCell"; + const string readSFNIndicator = "readSFNIndicator"; + const string restrictionStateIndicator = "restrictionStateIndicator"; + const string dpcModeChangeSupportIndicator = "dpcModeChangeSupportIndicator"; + const string nsPlmnIdList = "nsPlmnIdList"; + const string relatedSectorEquipment = "relatedSectorEquipment"; + }; + + /** + * Definitions for MO class NodeBFunction + */ + interface NodeBFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "NodeBFunction"; + // Attribute Names + // + const string nodeBFunctionIubLink = "nodeBFunctionIubLink"; + }; + + /** + * Definitions for MO class IubLink + */ + interface IubLink : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "IubLink"; + // Attribute Names + // + const string iubLinkNodeBFunction = "iubLinkNodeBFunction"; + const string iubLinkUtranCell = "iubLinkUtranCell"; + const string iubLinkATMChannelTerminationPoint = "iubLinkATMChannelTerminationPoint"; + }; + + /** + * Definitions for MO class UtranRelation + */ + interface UtranRelation : GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "UtranRelation"; + // Attribute Names + // + const string id = "id"; + const string adjacentCell = "adjacentCell"; + }; + + /** + * Definitions for MO class ExternalUtranGenericCell + */ + interface ExternalUtranGenericCell : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalUtranGenericCell"; + // Attribute Names + // + const string cId = "cId"; + const string mcc = "mcc"; + const string mnc = "mnc"; + const string rncId = "rncId"; + const string cellMode = "cellMode"; + const string uarfcn = "uarfcn"; + const string cellParameterId = "cellParameterId"; + const string lac = "lac"; + const string rac = "rac"; + const string controllingRnc = "controllingRnc"; + const string hsFlag = "hsFlag"; + const string frameOffset = "frameOffset"; + const string cellIndividualOffset = "cellIndividualOffset"; + const string hcsPrio = "hcsPrio"; + const string maximumAllowedUlTxPower = "maximumAllowedUlTxPower"; + const string qrxlevMin = "qrxlevMin"; + const string deltaQrxlevmin = "deltaQrxlevmin"; + const string qhcs = "qhcs"; + const string penaltyTime = "penaltyTime"; + const string referenceTimeDifferenceToCell = "referenceTimeDifferenceToCell"; + const string readSFNIndicator = "readSFNIndicator"; + const string restrictionStateIndicator = "restrictionStateIndicator"; + }; + +``` + +``` + const string dpcModeChangeSupportIndicator = "dpcModeChangeSupportIndicator"; + }; + /** + * Definitions for MO class ExternalRncFunction + */ + interface ExternalRncFunction : + GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalRncFunction"; + // Attribute Names + // + const string mcc = "mcc"; + const string mnc = "mnc"; + const string rncId = "rncId"; + const string controlledCellList = "controlledCellList"; + }; + + /** + * Definitions for MO class UtranCellFDD + */ + interface UtranCellFDD : UtranGenericCell + { + const string CLASS = "UtranCellFDD"; + // Attribute Names + // + const string uarfcnUl = "uarfcnUl"; + const string uarfcnDl = "uarfcnDl"; + const string primaryScramblingCode = "primaryScramblingCode"; + const string primaryCpichPower = "primaryCpichPower"; + const string primarySchPower = "primarySchPower"; + const string secondarySchPower = "secondarySchPower"; + const string bchPower = "bchPower"; + const string aichPower = "aichPower"; + const string qqualMin = "qqualMin"; + const string cellCapabilityContainerFDD = "cellCapabilityContainerFDD"; + const string txDiversityIndicator = "txDiversityIndicator"; + const string temporaryOffset1 = "temporaryOffset1"; + const string temporaryOffset2 = "temporaryOffset2"; + const string sttdSupportIndicator = "sttdSupportIndicator"; + const string closedLoopModelSupportIndicator = "closedLoopModelSupportIndicator"; + }; + + /** + * Definitions for MO class UtranCellTDD + */ + interface UtranCellTDD : UtranGenericCell + { + const string CLASS = "UtranCellTDD"; + // Attribute Names + // + const string uarfcn = "uarfcn"; + const string cellParameterId = "cellParameterId"; + const string primaryCcpchPower = "primaryCcpchPower"; + const string cellCapabilityContainerTDD = "cellCapabilityContainerTDD"; + const string sctdIndicator = "sctdIndicator"; + const string dpchConstantValue = "dpchConstantValue"; + }; + + /** + * Definitions for MO class UtranCellTDDLcr + */ + interface UtranCellTDDLcr : UtranCellTDD + { + const string CLASS = "UtranCellTDDLcr"; + // Attribute Names + // + const string uarfcnLCRList = "uarfcnLCRList"; + const string fpachPower = "fpachPower"; + const string dwPchPower = "dwPchPower"; + const string tstdIndicator = "tstdIndicator"; + const string timeSlotLCRList = "timeSlotLCRList"; + }; + + /** + * Definitions for MO class UtranCellTDDHcr + */ + interface UtranCellTDDHcr : UtranCellTDD + { + const string CLASS = "UtranCellTDDHcr"; + }; + +``` + +``` + // Attribute Names + // + const string schPower = "schPower"; + const string temporaryOffset1 = "temporaryOffset1"; + const string syncCase = "syncCase"; + const string timeSlotForSch = "timeSlotForSch"; + const string schTimeSlot = "schTimeSlot"; + const string timeSlotHCRLList = "timeSlotHCRLList"; +}; + +/** + * Definitions for MO class ExternalUtranCellFDD + */ +interface ExternalUtranCellFDD : ExternalUtranGenericCell +{ + const string CLASS = "ExternalUtranCellFDD"; + // Attribute Names + // + const string uarfcnUl = "uarfcnUl"; + const string uarfcnDl = "uarfcnDl"; + const string primaryScramblingCode = "primaryScramblingCode"; + const string primaryCpichPower = "primaryCpichPower"; + const string qqualMin = "qqualMin"; + const string cellCapabilityContainerFDD = "cellCapabilityContainerFDD"; + const string txDiversityIndicator = "txDiversityIndicator"; + const string temporaryOffset1 = "temporaryOffset1"; + const string temporaryOffset2 = "temporaryOffset2"; + const string sttdSupportIndicator = "sttdSupportIndicator"; + const string closedLoopModelSupportIndicator = "closedLoopModelSupportIndicator"; +}; + +/** + * Definitions for MO class ExternalUtranCellTDD + */ +interface ExternalUtranCellTDD : ExternalUtranGenericCell +{ + const string CLASS = "ExternalUtranCellTDD"; + // Attribute Names + // + const string uarfcn = "uarfcn"; + const string cellParameterId = "cellParameterId"; + const string primaryCcpchPower = "primaryCcpchPower"; + const string cellCapabilityContainerTDD = "cellCapabilityContainerTDD"; + const string sctdIndicator = "sctdIndicator"; + const string dpchConstantValue = "dpchConstantValue"; +}; + +/** + * Definitions for MO class ExternalUtranCellTDDHcr + */ +interface ExternalUtranCellTDDHcr : ExternalUtranCellTDD +{ + const string CLASS = "ExternalUtranCellTDDHcr"; + // Attribute Names + // + const string temporaryOffset1 = "temporaryOffset1"; + const string syncCase = "syncCase"; + const string timeSlotForSch = "timeSlotForSch"; + const string schTimeSlot = "schTimeSlot"; + const string timeSlotHCRLList = "timeSlotHCRLList"; +}; + +/** + * Definitions for MO class ExternalUtranCellTDDLcr + */ +interface ExternalUtranCellTDDLcr : ExternalUtranCellTDD +{ + const string CLASS = "ExternalUtranCellTDDLcr"; + // Attribute Names + // + const string tstdIndicator = "tstdIndicator"; + const string timeSlotLCRLList = "timeSlotLCRLList"; +}; + +/** + * Definitions for MO class EP_IuCS + */ +interface EP_IuCS : GenericNetworkResourcesNRMDefs::EP_RP +{ + const string CLASS = "EP_IuCS"; + // Attribute Name +} +``` + +``` + // + const string connMscNumber = "connMscNumber"; + }; + + /** + * Definitions for MO class EP_IuPS + */ + interface EP_IuPS : GenericNetworkResourcesNRMDefs::EP_RP + { + const string CLASS = "EP_IuPS"; + // Attribute Name + // + const string connSgsnNumber= "connSgsnNumber"; + }; + + /** + * Definitions for MO class EP_Iur + */ + interface EP_Iur : GenericNetworkResourcesNRMDefs::EP_RP + { + const string CLASS = "EP_Iur"; + // Attribute Name + // + const string connectedRncId= "connectedRncId"; + }; + +}; + +/** + * This module adds datatype definitions for both FDD and TDD mode + * attributes used in the NRM which are not the basic datatypes + * already defined in CORBA. + */ +module GenericNRMAttributeTypes +{ + enum CellModeEnumType + { + FDDMode, + TDDMode_1_28Mcps, + TDDMode_3_84Mcps + }; + enum RestrictionStateEnumType + { + cellReservedForOperatorUse, + cellAccessible + }; + enum DpcModeChangeEnumType + { + dpcModeChange_supported, + dpcModeChange_not_supported + }; + typedef long SNAC; + struct snaInformationType + { + long mcc; + long mnc; + sequence<SNAC> snalist; + }; + + struct TceIDMappingInfo + { + short tceID; + string tceIPAddr; + }; + + typedef sequence<TceIDMappingInfo> TceIDMappingInfoListType; + + structNs PlmnIdType + { + short mcc; + short mnc; + }; + + const short NS_ PLMNID_LIST_LENGTH = 5; + typedef sequence<NsPlmnIdType>NsPlmnIdListType; + +}; +``` + +``` + + struct SharNetTceMappingInfo + { + long PLMNId; + short tceID; + string tceIPAddr; + }; + typedef sequence<SharNetTceMappingInfo> SharNetTceMappingInfoListType; +}; + +/** + * This module adds datatype definitions for FDD mode attributes + * used in the NRM which are not the basic datatypes already defined + * in CORBA. + */ +module FDDNRMAttributeTypes +{ + enum SttdSupportEnumType + { + active, + inactive + }; + + enum txDiversityIndicatorEnumType + { + none, + primaryCpichBroadcastFrom2Antennas, + sttdAppliedToPrimaryCCPCH, + tstdAppliedToPrimarySchAndSecondarySch + }; + + enum ClosedLoopModelEnumType + { + closedLoopModel_supported, + closedLoopModel_not_supported + }; + + typedef octet CellCapabilityContainerFDDBit; + //CellCapabilityContainerFDDBits: + const unsigned long Flexible_Hard_Split_Support_Indicator = 0; + const unsigned long Delayed_Activation_Support_Indicator = 1; + const unsigned long HS_DSCH_Support_Indicator = 2; + const unsigned long DSCH_Support_Indicator = 3; + const unsigned long F_DPCH_Support_Indicator = 4; + const unsigned long E_DCH_Support_Indicator = 5; + const unsigned long E_DCH_TTI2ms_Support_Indicator = 6; + const unsigned long E_DCH_2sf2and2sf4_and_all_inferior_SFs_Support_Indicator = 7; + const unsigned long E_DCH_2sf2_and_all_inferior_SFs_Support_Indicator = 8; + const unsigned long E_DCH_2sf4_and_all_inferior_SFs_Support_Indicator = 9; + const unsigned long E_DCH_sf4_and_all_inferior_SFs_Support_Indicator = 10; + const unsigned long E_DCH_sf8_and_all_inferior_SFs_Support_Indicator = 11; + const unsigned long E_DCH_HARQ_IR_Combining_Support_Indicator = 12; + const unsigned long E_DCH_HARQ_Chase_Combining_Support_Indicator = 13; + typedef sequence <CellCapabilityContainerFDDBit> CellCapabilityContainerFDDType; + +}; + +/** + * This module adds datatype definitions for TDD mode attributes + * used in the NRM which are not the basic datatypes already defined + * in CORBA. + */ +module TDDNRMAttributeTypes +{ + enum ActivityStatusType + { + active, + inactive + }; + + typedef ActivityStatusType TstdIndicatorEnumType; + typedef ActivityStatusType SctdSupportEnumType; + typedef ActivityStatusType TimeSlotStatusType; + + typedef octet CellCapabilityContainerTDDBit; + const unsigned long Delayed_Activation_Support_Indicator = 0; + const unsigned long HS_DSCH_Support_Indicator = 1; + const unsigned long DSCH_Support_Indicator = 2; + typedef sequence <CellCapabilityContainerTDDBit> CellCapabilityContainerTDDType; +}; + +``` + +``` +enum TimeSlotDirectionType +{ + UL, + DL +}; + +struct TimeSlotConfigStructType +{ + short timeSlotId; + TimeSlotDirectionType timeSlotDirection; + TimeSlotStatusType timeSlotStatus; +}; + +typedef sequence<TimeSlotConfigStructType> TimeSlotListConfigStructType; + +struct UarfcnLCRConfigStructType +{ + short uarfcn; + TimeSlotListConfigStructType timeSlotLCRList; +}; + +typedef sequence<UarfcnLCRConfigStructType> UarfcnLCRListConfigStructType; +}; + +#endif // _UTRANNETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML Definitions + +## B.0 Introduction + +This annex contains the XML Definitions for the UTRAN NRM IRP as it applies to Itf-N, in accordance with UTRAN NRM IRP IS definitions [4]. + +The XML file formats are based on XML [8], XML Schema [10] [11] and XML Namespace [12] standards. + +### --- B.1 Architectural features + +### B.1.0 General + +The overall architectural feature of UTRAN Network Resources IRP is specified in 3GPP TS 28.652 [4]. + +This clause specifies features that are specific to the Schema definitions. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +## --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [7]. + +Annex B.3.3 of the present document defines the NRM-specific XML schema `utranNrm.xsd` for the UTRAN Network Resources IRP NRM defined in 3GPP TS 28.652 [4]. + +XML schema `utranNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [7]. + +### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +#### B.3.3 XML schema "utranNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.653 UTRAN NRM IRP + Bulk CM Configuration data file NRM-specific XML schema + utranNrm.xsd +--> + +<schema + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:un="http://www.3gpp.org/ftp/specs/archive/28_series/28.653#utranNrm" + xmlns:gn="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + xmlns:sm="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.653#utranNrm" + elementFormDefault="qualified"> + <import + namespace= +"http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + /> + <import + namespace= +"http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + /> + <import + namespace= +"http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + /> + + <!-- UTRAN Network Resources IRP NRM attribute related XML types --> + + <simpleType name="localCellId"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="268435455"/> + </restriction> + </simpleType> + + <simpleType name="cId"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="65535"/> + </restriction> + </simpleType> + + <simpleType name="uarfcnAnyMode"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="16383"/> + </restriction> + </simpleType> + + <simpleType name="primaryScramblingCode"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="511"/> + </restriction> + </simpleType> + + <simpleType name="primaryCpichPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-10"/> + <maxInclusive value="+50"/> + </restriction> + </simpleType> + + <simpleType name="maximumTransmissionPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="0"/> + <maxInclusive value="50"/> + </restriction> + </simpleType> +</schema> +``` + +``` +</simpleType> + +<simpleType name="primarySchPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-35"/> + <maxInclusive value="+15"/> + </restriction> +</simpleType> + +<simpleType name="secondarySchPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-35"/> + <maxInclusive value="+15"/> + </restriction> +</simpleType> + +<simpleType name="bchPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-35"/> + <maxInclusive value="+15"/> + </restriction> +</simpleType> + +<simpleType name="aichPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-22"/> + <maxInclusive value="+5"/> + </restriction> +</simpleType> + +<simpleType name="fpachPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-150"/> + <maxInclusive value="+400"/> + </restriction> +</simpleType> + +<simpleType name="pichPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-10"/> + <maxInclusive value="+5"/> + </restriction> +</simpleType> + +<simpleType name="pchPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-350"/> + <maxInclusive value="+150"/> + </restriction> +</simpleType> + +<simpleType name="fachPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-350"/> + <maxInclusive value="+150"/> + </restriction> +</simpleType> + +<simpleType name="lac"> + <union> + <simpleType> + <restriction base="integer"> + <minInclusive value="1"/> + <maxInclusive value="65533"/> + </restriction> + </simpleType> + <simpleType> + <restriction base="integer"> + <minInclusive value="65535"/> + <maxInclusive value="65535"/> + </restriction> + </simpleType> + </union> +</simpleType> +``` + +``` + + </restriction> + </simpleType> +</union> +</simpleType> + +<simpleType name="rac"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="255"/> + </restriction> +</simpleType> + +<simpleType name="sac"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="65535"/> + </restriction> +</simpleType> + +<complexType name="uraList"> + <sequence> + <element name="ura" maxOccurs="8"> + <simpleType> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="65535"/> + </restriction> + </simpleType> + </element> + </sequence> +</complexType> + +<simpleType name="cellMode"> + <restriction base="string"> + <enumeration value="FDDMode"/> + <enumeration value="3-84McpsTDDMode"/> + <enumeration value="1-28McpsTDDMode"/> + </restriction> +</simpleType> + +<simpleType name="cellParameterId"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="127"/> + </restriction> +</simpleType> + +<simpleType name="primaryCcpchPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-15"/> + <maxInclusive value="+40"/> + </restriction> +</simpleType> + +<simpleType name="dwPchPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-15"/> + <maxInclusive value="+40"/> + </restriction> +</simpleType> + +<simpleType name="schPower"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-35"/> + <maxInclusive value="+15"/> + </restriction> +</simpleType> + +<complexType name="timeSlotLCRList"> + <sequence> + <element name="timeSlot" maxOccurs="7"> + <complexType> + <all> + <element name="timeSlotId" minOccurs="1"> + <simpleType> +``` + +``` +<restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="6"/> +</restriction> +</simpleType> +</element> +<element name="timeSlotDirection" minOccurs="1"> + <simpleType> + <restriction base="string"> + <enumeration value="UL"/> + <enumeration value="DL"/> + </restriction> + </simpleType> +</element> +<element name="timeSlotStatus" minOccurs="1"> + <simpleType> + <restriction base="string"> + <enumeration value="Active"/> + <enumeration value="Not-Active"/> + </restriction> + </simpleType> +</element> +</all> +</complexType> +</element> +</sequence> +</complexType> + +<complexType name="timeSlotHCRLList"> + <sequence> + <element name="timeSlot" maxOccurs="15"> + <complexType> + <all> + <element name="timeSlotId" minOccurs="1"> + <simpleType> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="14"/> + </restriction> + </simpleType> + </element> + <element name="timeSlotDirection" minOccurs="1"> + <simpleType> + <restriction base="string"> + <enumeration value="UL"/> + <enumeration value="DL"/> + </restriction> + </simpleType> + </element> + <element name="timeSlotStatus" minOccurs="1"> + <simpleType> + <restriction base="string"> + <enumeration value="Active"/> + <enumeration value="Not-Active"/> + </restriction> + </simpleType> + </element> + </all> + </complexType> + </element> + </sequence> +</complexType> + +<simpleType name="restrictionStateIndicator"> + <restriction base="string"> + <enumeration value="cellReservedForOperatorUse"/> + <enumeration value="cellAccessible"/> + </restriction> +</simpleType> + +<simpleType name="dpcModeChangeSupport"> + <restriction base="string"> + <enumeration value="dpcModeChangeSupported"/> + <enumeration value="dpcModeChangeNotSupported"/> + </restriction> +</simpleType> +``` + +``` +<simpleType name="stdtSupport"> + <restriction base="string"> + <enumeration value="active"/> + <enumeration value="inactive"/> + </restriction> +</simpleType> + +<simpleType name="closedLoopModel"> + <restriction base="string"> + <enumeration value="closedLoopModelSupported"/> + <enumeration value="closedLoopModelNotSupported"/> + </restriction> +</simpleType> + +<simpleType name="frameOffset"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="255"/> + </restriction> +</simpleType> + +<simpleType name="cellIndividualOffset"> + <restriction base="decimal"> + <fractionDigits value="1"/> + <minInclusive value="-10"/> + <maxInclusive value="10"/> + </restriction> +</simpleType> + +<simpleType name="hcsPrio"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="7"/> + </restriction> +</simpleType> + +<simpleType name="maximumAllowedUtxPower"> + <restriction base="integer"> + <minInclusive value="-50"/> + <maxInclusive value="33"/> + </restriction> +</simpleType> + +<simpleType name="grxlevMin"> + <restriction base="integer"> + <minInclusive value="-115"/> + <maxInclusive value="-25"/> + </restriction> +</simpleType> + +<simpleType name="deltaGrxlevmin"> + <restriction base="integer"> + <minInclusive value="-4"/> + <maxInclusive value="-2"/> + </restriction> +</simpleType> + +<simpleType name="qhcs"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="99"/> + </restriction> +</simpleType> + +<simpleType name="penaltyTime"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="60"/> + </restriction> +</simpleType> + +<simpleType name="referenceTimeDifferenceToCell"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="38400"/> + </restriction> +</simpleType> +``` + +``` +<simpleType name="readSFNIndicator"> + <restriction base="string"> + <enumeration value="TRUE"/> + <enumeration value="FALSE"/> + </restriction> +</simpleType> + +<complexType name="snaList"> + <sequence> + <element name="snac" maxOccurs="65535"> + <simpleType> + <restriction base="integer"> + <minInclusive value="1"/> + <maxInclusive value="65536"/> + </restriction> + </simpleType> + </element> + </sequence> +</complexType> + +<complexType name="snaInformation"> + <sequence> + <element name="mcc"> + <simpleType> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="999"/> + </restriction> + </simpleType> + </element> + <element name="mnc"> + <simpleType> + <restriction base="integer"> + <enumeration value="0"/> + <enumeration value="999"/> + </restriction> + </simpleType> + </element> + <element name="snaList" type="un:snaList"/> + </sequence> +</complexType> + +<simpleType name="qqualMin"> + <restriction base="integer"> + <minInclusive value="-24"/> + <maxInclusive value="0"/> + </restriction> +</simpleType> + +<simpleType name="temporaryOffset1"> + <restriction base="integer"> + <minInclusive value="3"/> + <maxInclusive value="21"/> + </restriction> +</simpleType> + +<simpleType name="temporaryOffset2"> + <restriction base="integer"> + <minInclusive value="2"/> + <maxInclusive value="12"/> + </restriction> +</simpleType> + +<simpleType name="txDiversityIndicator"> + <restriction base="string"> + <enumeration value="none"/> + <enumeration value="PrimaryCpichBroadcastFrom2Antennas"/> + <enumeration value="SttdAppliedToPrimaryCCPCH"/> + <enumeration value="TstdAppliedToPrimarySchAndSecondarySch"/> + </restriction> +</simpleType> + +<complexType name="cellCapabilityContainerFDD"> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> +``` + +``` + + <all> + <element name="Flexible_Hard_Split_Support_Indicator" minOccurs="0"/> + <element name="Delayed_Activation_Support_Indicator" minOccurs="0"/> + <element name="HS_DSCH_Support_Indicator" minOccurs="0"/> + <element name="DSCH_Support_Indicator" minOccurs="0"/> + <element name="F_DPCH_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_TTI2ms_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_2sf2_and_all_inferior_SFs_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_2sf4_and_all_inferior_SFs_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_sf4_and_all_inferior_SFs_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_sf8_and_all_inferior_SFs_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_HARQ_IR_Combining_Support_Indicator" minOccurs="0"/> + <element name="E_DCH_HARQ_Chase_Combining_Support_Indicator" minOccurs="0"/> + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> + +<simpleType name="sctdIndicator"> + <restriction base="string"> + <enumeration value="active"/> + <enumeration value="inactive"/> + </restriction> +</simpleType> + +<simpleType name="dpchConstantValue"> + <restriction base="integer"> + <minInclusive value="-10"/> + <maxInclusive value="10"/> + </restriction> +</simpleType> + +<complexType name="cellCapabilityContainerTDD"> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="Delayed_Activation_Support_Indicator" minOccurs="0"/> + <element name="HS_DSCH_Support_Indicator" minOccurs="0"/> + <element name="DSCH_Support_Indicator" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> +</complexType> + +<simpleType name="tstdIndicator"> + <restriction base="string"> + <enumeration value="active"/> + <enumeration value="inactive"/> + </restriction> +</simpleType> + +<simpleType name="timeSlotForSch"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="14"/> + </restriction> +</simpleType> + +<simpleType name="schTimeSlot"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="6"/> + </restriction> +</simpleType> + +``` + +``` + + </restriction> + </simpleType> + + <simpleType name="syncCase"> + <restriction base="string"> + <enumeration value="SCH and PCCPCH allocated in a single TS"/> + <enumeration value="SCH and PCCPCH allocated in two TS, TS#k and TS#k+8"/> + </restriction> + </simpleType> + + <simpleType name="hsFlag"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="1"/> + </restriction> + </simpleType> + + <simpleType name="hsEnable"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="1"/> + </restriction> + </simpleType> + + <simpleType name="numOfHspdschs"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="95"/> + </restriction> + </simpleType> + + <complexType name="NsPlmnId"> + <sequence> + <element name="mcc" type="short"/> + <element name="mnc" type="short"/> + </sequence> + </complexType> + <complexType name="NsPlmnIdListType"> + <sequence> + <element name="nsPlmnId" type="un:NsPlmnId" minOccurs="0" maxOccurs="5"/> + </sequence> + </complexType> + + <simpleType name="numOfHssccchs"> + <restriction base="integer"> + <minInclusive value="1"/> + <maxInclusive value="32"/> + </restriction> + </simpleType> + + <simpleType name="eightOctets"> + <restriction base="hexBinary"> + <length value="8"/> + </restriction> + </simpleType> + + <complexType name="uarfcnLCRList"> + <sequence> + <element name="uarfcnLCR" maxOccurs="11"> + <complexType> + <all> + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="1"/> + <element name="timeSlotLCRList" type="un:timeSlotLCRList" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </complexType> + + <simpleType name="siptoSupported"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="1"/> + </restriction> + </simpleType> + + <complexType name="TceIDMappingInfo"> +``` + +``` + + <sequence> + <element name="tceID" type="short"/> + <element name="tceIPAddr" type="string"/> + </sequence> + </complexType> + <complexType name="TceIDMappingInfoList"> + <sequence> + <element name="tceIDMappingInfo" type="un:TceIDMappingInfo" minOccurs="0"/> + </sequence> + </complexType> + + <complexType name="SharNetTceMappingInfo"> + <sequence> + <element name="pLMNId" type="long"/> + <element name="tceID" type="short"/> + <element name="tceIPAddr" type="string"/> + </sequence> + </complexType> + <complexType name="SharNetTceMappingInfoList"> + <sequence> + <element name="sharNetTceMappingInfo" type="un:SharNetTceMappingInfo" minOccurs="0"/> + </sequence> + </complexType> + + <!-- UTRAN Network Resources IRP NRM class associated XML elements --> + + <element + name="RncFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="siptoSupported" type="un:siptoSupported" minOccurs="0"/> + <element name="tceIDMappingInfoList" type="un:TceIDMappingInfoList" minOccurs="0"/> + <element name="sharNetTceMappingInfoList" type="un:SharNetTceMappingInfoList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:UtranCellFDD"/> + <element ref="un:UtranCellTDDLcr"/> + <element ref="un:UtranCellTDDHcr"/> + <element ref="un:IubLink"/> + <element ref="un:RncFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + + <element + name="NodeBFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + +``` + +``` + + <element name="peeParametersList" type="xn:peeParametersListType" minOccurs="0"/> + <element name="nodeBFunctionIubLink" type="string" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:NodeBFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="UtranGenericCell" abstract="true"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="localCellId" type="un:localCellId" minOccurs="0"/> + <element name="maximumTransmissionPower" + type="un:maximumTransmissionPower" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="pichPower" type="un:pichPower" minOccurs="0"/> + <element name="pchPower" type="un:pchPower" minOccurs="0"/> + <element name="fachPower" type="un:fachPower" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="sac" type="un:sac" minOccurs="0"/> + <element name="uraList" type="un:uraList" minOccurs="0"/> + <element name="utranCellIubLink" type="xn:dn" minOccurs="0"/> + <element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> + <element name="operationalState" + type="sm:operationalStateType" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="hsEnable" type="un:hsEnable" minOccurs="0"/> + <element name="numOfHspdschs" type="un:numOfHspdschs" minOccurs="0"/> + <element name="numOfHssccchs" type="un:numOfHssccchs" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" + type="un:cellIndividualOffset" minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUtxPower" + type="un:maximumAllowedUtxPower" minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="nsPlmnIdList" type="un:NsPlmnIdListType" minOccurs="0"/> + <element name="restrictionStateIndicator" + type="un:restrictionStateIndicator" minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" + type="un:dpcModeChangeSupport" minOccurs="0"/> + <element name="relatedSectorEquipment" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:UtranRelation"/> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranGenericCellOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + + </complexType> + </element> + + <element name="UtranCellFDD"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!-- Inherited attributes from UtranGenericCell --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="localCellId" type="un:localCellId" minOccurs="0"/> + <element name="maximumTransmissionPower" + type="un:maximumTransmissionPower" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="pichPower" type="un:pichPower" minOccurs="0"/> + <element name="pchPower" type="un:pchPower" minOccurs="0"/> + <element name="fachPower" type="un:fachPower" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="sac" type="un:sac" minOccurs="0"/> + <element name="uraList" type="un:uraList" minOccurs="0"/> + <element name="utranCellIubLink" type="xn:dn" minOccurs="0"/> + <element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> + <element name="operationalState" + type="sm:operationalStateType" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="hsEnable" type="un:hsEnable" minOccurs="0"/> + <element name="numOfHspdschs" type="un:numOfHspdschs" minOccurs="0"/> + <element name="numOfHssccchs" type="un:numOfHssccchs" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" + type="un:cellIndividualOffset" minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlteTxPower" + type="un:maximumAllowedUlteTxPower" minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevMin" type="un:deltaQrxlevMin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="nsPlmnIdList" type="un:NsPlmnIdListType" minOccurs="0"/> + <element name="restrictionStateIndicator" + type="un:restrictionStateIndicator" minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" + type="un:dpcModeChangeSupport" minOccurs="0"/> + <element name="relatedSectorEquipment" type="xn:dn" minOccurs="0"/> + <!-- End of inherited attributes from UtranGenericCell --> + + <element name="uarfcnUl" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="uarfcnDl" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="primaryScramblingCode" type="un:primaryScramblingCode" + minOccurs="0"/> + <element name="primaryCpichPower" type="un:primaryCpichPower" minOccurs="0"/> + <element name="primarySchPower" type="un:primarySchPower" minOccurs="0"/> + <element name="secondarySchPower" type="un:secondarySchPower" minOccurs="0"/> + <element name="bchPower" type="un:bchPower" minOccurs="0"/> + <element name="aichPower" type="un:aichPower" minOccurs="0"/> + <element name="qqualMin" type="un:qqualMin" minOccurs="0"/> + <element name="cellCapabilityContainerFDD" type="un:cellCapabilityContainerFDD" + minOccurs="0"/> + <element name="txDiversityIndicator" type="un:txDiversityIndicator" + minOccurs="0"/> + <element name="temporaryOffset1" type="un:temporaryOffset1" minOccurs="0"/> + <element name="temporaryOffset2" type="un:temporaryOffset2" minOccurs="0"/> + <element name="sttdSupportIndicator" type="un:sttdSupport" minOccurs="0"/> + <element name="closedLoopModelSupportIndicator" type="un:closedLoopModel" + minOccurs="0"/> + +``` + +``` + + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:UtranRelation"/> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranCellFDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="UtranCellTDD" abstract="true"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!-- Inherited attributes from UtranGenericCell --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="localCellId" type="un:localCellId" minOccurs="0"/> + <element name="maximumTransmissionPower" + type="un:maximumTransmissionPower" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="pichPower" type="un:pichPower" minOccurs="0"/> + <element name="pchPower" type="un:pchPower" minOccurs="0"/> + <element name="fachPower" type="un:fachPower" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="sac" type="un:sac" minOccurs="0"/> + <element name="uraList" type="un:uraList" minOccurs="0"/> + <element name="utranCellIubLink" type="xn:dn" minOccurs="0"/> + <element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> + <element name="operationalState" + type="sm:operationalStateType" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="hsEnable" type="un:hsEnable" minOccurs="0"/> + <element name="numOfHspdschs" type="un:numOfHspdschs" minOccurs="0"/> + <element name="numOfHssccchs" type="un:numOfHssccchs" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" + type="un:cellIndividualOffset" minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlteTxPower" + type="un:maximumAllowedUlteTxPower" minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="nsPlmnIdList" type="un:NsPlmnIdListType" minOccurs="0"/> + <element name="restrictionStateIndicator" + type="un:restrictionStateIndicator" minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" + type="un:dpcModeChangeSupport" minOccurs="0"/> + <element name="relatedSectorEquipment" type="xn:dn" minOccurs="0"/> + <!-- End of inherited attributes from UtranGenericCell --> + + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="cellParameterId" type="un:cellParameterId" minOccurs="0"/> + <element name="primaryCcPchPower" type="un:primaryCcPchPower" minOccurs="0"/> + <element name="cellCapabilityContainerTDD" type="un:cellCapabilityContainerTDD" + minOccurs="0"/> + <element name="sctdIndicator" type="un:sctdIndicator" minOccurs="0"/> + <element name="dpchConstantValue" type="un:dpchConstantValue" minOccurs="0"/> + +``` + +``` + + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:UtranRelation"/> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranCellTDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="UtranCellTDDLcr"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!-- Inherited attributes from UtranGenericCell via UtranCellTDD --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="localCellId" type="un:localCellId" minOccurs="0"/> + <element name="maximumTransmissionPower" + type="un:maximumTransmissionPower" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="pichPower" type="un:pichPower" minOccurs="0"/> + <element name="pchPower" type="un:pchPower" minOccurs="0"/> + <element name="fachPower" type="un:fachPower" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="sac" type="un:sac" minOccurs="0"/> + <element name="uraList" type="un:uraList" minOccurs="0"/> + <element name="utranCellIubLink" type="xn:dn" minOccurs="0"/> + <element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> + <element name="operationalState" + type="sm:operationalStateType" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="hsEnable" type="un:hsEnable" minOccurs="0"/> + <element name="numOfHspdschs" type="un:numOfHspdschs" minOccurs="0"/> + <element name="numOfHssccchs" type="un:numOfHssccchs" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" + type="un:cellIndividualOffset" minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlteTxPower" + type="un:maximumAllowedUlteTxPower" minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="nsPlmnIdList" type="un:NsPlmnIdListType" minOccurs="0"/> + <element name="restrictionStateIndicator" + type="un:restrictionStateIndicator" minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" + type="un:dpcModeChangeSupport" minOccurs="0"/> + <element name="relatedSectorEquipment" type="xn:dn" minOccurs="0"/> + <!-- End of inherited attributes from UtranGenericCell via UtranCellTDD --> + + <!-- Inherited attributes from UtranCellTDD --> + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="cellParameterId" type="un:cellParameterId" minOccurs="0"/> + <element name="primaryCcPchPower" type="un:primaryCcPchPower" minOccurs="0"/> + <element name="cellCapabilityContainerTDD" type="un:cellCapabilityContainerTDD" + minOccurs="0"/> + <element name="scdIndicator" type="un:scdIndicator" minOccurs="0"/> + <element name="dpchConstantValue" type="un:dpchConstantValue" minOccurs="0"/> + +``` + +``` + +<!-- End of inherited attributes from UtranCellTDD --> + +<element name="uarfcnLCRList" type="un:uarfcnLCRList" minOccurs="0"/> +<element name="fpachPower" type="un:fpachPower" minOccurs="0"/> +<element name="dwPchPower" type="un:dwPchPower" minOccurs="0"/> +<element name="tstdIndicator" type="un:tstdIndicator" minOccurs="0"/> +<element name="timeSlotLCRList" type="un:timeSlotLCRList" minOccurs="0"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> +<element ref="un:UtranRelation"/> +<element ref="gn:GsmRelation"/> +<element ref="un:UtranCellTDDLcrOptionallyContainedNrmClass"/> +<element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="UtranCellTDDHcr"> +<complexType> +<complexContent> +<extension base="xn:NrmClass"> +<sequence> +<element name="attributes" minOccurs="0"> +<complexType> +<all> + +<!-- Inherited attributes from UtranGenericCell via UtranCellTDD --> +<element name="userLabel" type="string" minOccurs="0"/> +<element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> +<element name="cId" type="un:cId" minOccurs="0"/> +<element name="localCellId" type="un:localCellId" minOccurs="0"/> +<element name="maximumTransmissionPower" + type="un:maximumTransmissionPower" minOccurs="0"/> +<element name="cellMode" type="un:cellMode" minOccurs="0"/> +<element name="pichPower" type="un:pichPower" minOccurs="0"/> +<element name="pchPower" type="un:pchPower" minOccurs="0"/> +<element name="fachPower" type="un:fachPower" minOccurs="0"/> +<element name="lac" type="un:lac" minOccurs="0"/> +<element name="rac" type="un:rac" minOccurs="0"/> +<element name="sac" type="un:sac" minOccurs="0"/> +<element name="uraList" type="un:uraList" minOccurs="0"/> +<element name="utranCellIubLink" type="xn:dn" minOccurs="0"/> +<element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> +<element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> +<element name="operationalState" + type="sm:operationalStateType" minOccurs="0"/> +<element name="hsFlag" type="un:hsFlag" minOccurs="0"/> +<element name="hsEnable" type="un:hsEnable" minOccurs="0"/> +<element name="numOfHspdschs" type="un:numOfHspdschs" minOccurs="0"/> +<element name="numOfHssccchs" type="un:numOfHssccchs" minOccurs="0"/> +<element name="frameOffset" type="un:frameOffset" minOccurs="0"/> +<element name="cellIndividualOffset" + type="un:cellIndividualOffset" minOccurs="0"/> +<element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> +<element name="maximumAllowedUltrTxPower" + type="un:maximumAllowedUltrTxPower" minOccurs="0"/> +<element name="snaInformation" type="un:snaInformation" minOccurs="0"/> +<element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> +<element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> +<element name="qhcs" type="un:qhcs" minOccurs="0"/> +<element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> +<element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> +<element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> +<element name="nsPlmnIdList" type="un:NsPlmnIdListType" minOccurs="0"/> +<element name="restrictionStateIndicator" + type="un:restrictionStateIndicator" minOccurs="0"/> +<element name="dpcModechangeSupportIndicator" + type="un:dpcModeChangeSupport" minOccurs="0"/> +<element name="relatedSectorEquipment" type="xn:dn" minOccurs="0"/> +<!-- End of inherited attributes from UtranGenericCell via UtranCellTDD --> + +<!-- Inherited attributes from UtranCellTDD --> + +``` + +``` + + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="cellParameterId" type="un:cellParameterId" minOccurs="0"/> + <element name="primaryCcpcpPower" type="un:primaryCcpcpPower" minOccurs="0"/> + <element name="cellCapabilityContainerTDD" type="un:cellCapabilityContainerTDD" + minOccurs="0"/> + <element name="sctdIndicator" type="un:sctdIndicator" minOccurs="0"/> + <element name="dpchConstantValue" type="un:dpchConstantValue" minOccurs="0"/> + <!-- End of inherited attributes from UtranCellTDD --> + + <element name="schPower" type="un:schPower" minOccurs="0"/> + <element name="temporaryOffset1" type="un:temporaryOffset1" minOccurs="0"/> + <element name="syncCase" type="un:syncCase" minOccurs="0"/> + <element name="timeSlotForSch" type="un:timeSlotForSch" minOccurs="0"/> + <element name="schTimeSlot" type="un:schTimeSlot" minOccurs="0"/> + <element name="timeSlotHCRLList" type="un:timeSlotHCRLList" minOccurs="0"/> + </all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:UtranRelation"/> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranCellTDDHcrOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="IubLink"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="iubLinkUtranCell" type="xn:dnList" minOccurs="0"/> + <element name="iubLinkATMChannelTerminationPoint" type="xn:dn" minOccurs="0"/> + <element name="iubLinkNodeBFunction" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:IubLinkOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="UtranRelation"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="adjacentCell" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:UtranRelationOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + +<element + name="ExternalUtranGenericCell" abstract="true" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="controllingRnc" type="xn:dn" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" type="un:cellIndividualOffset" + minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlTxPower" type="un:maximumAllowedUlTxPower" + minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="restrictionStateIndicator" type="un:restrictionStateIndicator" + minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" type="un:dpcModeChangeSupport" + minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:ExternalUtranGenericCellOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ExternalUtranCellFDD" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!-- Inherited attributes from ExternalUtranGenericCell --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="controllingRnc" type="xn:dn" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" type="un:cellIndividualOffset" + +``` + +``` + + minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlTxPower" type="un:maximumAllowedUlTxPower" + minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevMin" type="un:deltaQrxlevMin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="restrictionStateIndicator" type="un:restrictionStateIndicator" + minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" type="un:dpcModeChangeSupport" + minOccurs="0"/> + <!-- End of inherited attributes from ExternalUtranGenericCell --> + + <element name="uarfcnUl" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="uarfcnDl" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="primaryScramblingCode" type="un:primaryScramblingCode" + minOccurs="0"/> + <element name="primaryCpichPower" type="un:primaryCpichPower" minOccurs="0"/> + <element name="aichPower" type="un:aichPower" minOccurs="0"/> + <element name="qqualMin" type="un:qqualMin" minOccurs="0"/> + <element name="cellCapabilityContainerFDD" type="un:cellCapabilityContainerFDD" + minOccurs="0"/> + <element name="txDiversityIndicator" type="un:txDiversityIndicator" + minOccurs="0"/> + <element name="temporaryOffset1" type="un:temporaryOffset1" minOccurs="0"/> + <element name="temporaryOffset2" type="un:temporaryOffset2" minOccurs="0"/> + <element name="stdSupportIndicator" type="un:stdSupport" minOccurs="0"/> + <element name="closedLoopModelSupportIndicator" type="un:closedLoopModel" + minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:ExternalUtranCellFDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ExternalUtranCellTDD" abstract="true" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!-- Inherited attributes from ExternalUtranGenericCell --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="controllingRnc" type="xn:dn" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" type="un:cellIndividualOffset" + minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlTxPower" type="un:maximumAllowedUlTxPower" + minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + +``` + +``` + + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="restrictionStateIndicator" type="un:restrictionStateIndicator" + minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" type="un:dpcModeChangeSupportIndicator" + minOccurs="0"/> + <!-- End of inherited attributes from ExternalUtranGenericCell --> + + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="cellParameterId" type="un:cellParameterId" minOccurs="0"/> + <element name="primaryCcpchPower" type="un:primaryCcpchPower" minOccurs="0"/> + <element name="cellCapabilityContainerTDD" + type="un:cellCapabilityContainerTDD" minOccurs="0"/> + <element name="scdIndicator" type="un:scdIndicator" minOccurs="0"/> + <element name="dpchConstantValue" type="un:dpchConstantValue" minOccurs="0"/> + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:ExternalUtranCellTDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ExternalUtranCellTDDHcr" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!--Inherited attributes from ExternalUtranGenericCell via ExternalUtranCellTDD--> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="controllingRnc" type="xn:dn" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" type="un:cellIndividualOffset" + minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedUlTxPower" type="un:maximumAllowedUlTxPower" + minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="restrictionStateIndicator" type="un:restrictionStateIndicator" + minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" type="un:dpcModeChangeSupportIndicator" + minOccurs="0"/> + <!-- End of inherited attributes from ExternalUtranGenericCell --> + + <!-- Inherited attributes from ExternalUtranCellTDD --> + +``` + +``` + + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="cellParameterId" type="un:cellParameterId" minOccurs="0"/> + <element name="primaryCcpchPower" type="un:primaryCcpchPower" minOccurs="0"/> + <element name="cellCapabilityContainerTDD" + type="un:cellCapabilityContainerTDD" minOccurs="0"/> + <element name="scdIndicator" type="un:scdIndicator" minOccurs="0"/> + <element name="dpchConstantValue" type="un:dpchConstantValue" minOccurs="0"/> + <!-- End of inherited attributes from ExternalUtranCellTDD --> + + <element name="temporaryOffset1" type="un:temporaryOffset1" minOccurs="0"/> + <element name="syncCase" type="un:syncCase" minOccurs="0"/> + <element name="timeSlotForSch" type="un:timeSlotForSch" minOccurs="0"/> + <element name="schTimeSlot" type="un:schTimeSlot" minOccurs="0"/> + <element name="timeSlotHCRLList" type="un:timeSlotHCRLList" minOccurs="0"/> + </all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:ExternalUtranCellTDDHcrOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ExternalUtranCellTDDLcr" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + + <!--Inherited attributes from ExternalUtranGenericCell via ExternalUtranCellTDD--> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cId" type="un:cId" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="cellMode" type="un:cellMode" minOccurs="0"/> + <element name="lac" type="un:lac" minOccurs="0"/> + <element name="rac" type="un:rac" minOccurs="0"/> + <element name="controllingRnc" type="xn:dn" minOccurs="0"/> + <element name="hsFlag" type="un:hsFlag" minOccurs="0"/> + <element name="frameOffset" type="un:frameOffset" minOccurs="0"/> + <element name="cellIndividualOffset" type="un:cellIndividualOffset" + minOccurs="0"/> + <element name="hcsPrio" type="un:hcsPrio" minOccurs="0"/> + <element name="maximumAllowedU1TxPower" type="un:maximumAllowedU1TxPower" + minOccurs="0"/> + <element name="snaInformation" type="un:snaInformation" minOccurs="0"/> + <element name="qrxlevMin" type="un:qrxlevMin" minOccurs="0"/> + <element name="deltaQrxlevmin" type="un:deltaQrxlevmin" minOccurs="0"/> + <element name="qhcs" type="un:qhcs" minOccurs="0"/> + <element name="penaltyTime" type="un:penaltyTime" minOccurs="0"/> + <element name="referenceTimeDifferenceToCell" + type="un:referenceTimeDifferenceToCell" minOccurs="0"/> + <element name="readSFNIndicator" type="un:readSFNIndicator" minOccurs="0"/> + <element name="restrictionStateIndicator" type="un:restrictionStateIndicator" + minOccurs="0"/> + <element name="dpcModeChangeSupportIndicator" type="un:dpcModeChangeSupport" + minOccurs="0"/> + <!-- End of inherited attributes from ExternalUtranGenericCell --> + + <!-- Inherited attributes from ExternalUtranCellTDD --> + <element name="uarfcn" type="un:uarfcnAnyMode" minOccurs="0"/> + <element name="cellParameterId" type="un:cellParameterId" minOccurs="0"/> + <element name="primaryCcpchPower" type="un:primaryCcpchPower" minOccurs="0"/> + <element name="cellCapabilityContainerTDD" + type="un:cellCapabilityContainerTDD" minOccurs="0"/> + <element name="scdIndicator" type="un:scdIndicator" minOccurs="0"/> + +``` + +``` + + <element name="dpchConstantValue" type="un:dpchConstantValue" minOccurs="0"/> + <!-- End of inherited attributes from ExternalUtranCellTDD --> + + <element name="tstdIndicator" type="un:tstdIndicator" minOccurs="0"/> + <element name="timeSlotLCRList" type="un:timeSlotLCRList" minOccurs="0"/> + </all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:ExternalUtranCellLcrOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ExternalRncFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="mcc" type="string" minOccurs="0"/> + <element name="mnc" type="string" minOccurs="0"/> + <element name="rncId" type="string" minOccurs="0"/> + <element name="controlledCellList" type="xn:dnList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="un:ExternalUtranCellFDD"/> + <element ref="un:ExternalUtranCellTDDHcr"/> + <element ref="un:ExternalUtranCellTDDLcr"/> + <element ref="un:ExternalRncFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EP_Iur"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="connectedRncId" type="string" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="RncFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="NodeBFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="UtranGenericCellOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="UtranCellFDDOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="UtranCellTDDOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="UtranCellTDDLcrOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="UtranCellTDDHcrOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="IubLinkOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="UtranRelationOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + +``` + +``` + +<element name="ExternalUtranGenericCellOptionallyContainedNrmClass" + type="xn:NrmClass" abstract="true"/> +<element name="ExternalUtranCellFDDOptionallyContainedNrmClass" + type="xn:NrmClass" abstract="true"/> +<element name="ExternalUtranCellTDDOptionallyContainedNrmClass" + type="xn:NrmClass" abstract="true"/> +<element name="ExternalUtranCellTDDHcrOptionallyContainedNrmClass" + type="xn:NrmClass" abstract="true"/> +<element name="ExternalUtranCellTDDLcrOptionallyContainedNrmClass" + type="xn:NrmClass" abstract="true"/> +<element name="ExternalRncFunctionOptionallyContainedNrmClass" + type="xn:NrmClass" abstract="true"/> + +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------------------------------------------|-----|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2013-03 | SA#59 | SP-130057 | 001 | - | CR R11 28.653 Alignment with 28.652: Addition of missing Network Sharing support for MDT | F | 11.0.0 | 11.1.0 | +| 2013-06 | | | | | Addition of missing Table of Contents (MCC) | | 11.1.0 | 11.1.1 | +| 2013-09 | SA#61 | SP-130433 | 002 | 1 | UTRAN NRM SS Correction of wrong import references and name space identifiers | F | 11.1.1 | 11.2.0 | +| 2014-02 | | | | | Corrected Clause numbering for Change History Annex (MCC) | | 11.2.0 | 11.2.1 | +| 2014-06 | SA#64 | SP-140332 | 003 | 1 | upgrade XSD | F | 11.2.1 | 11.3.0 | +| | | SP-140359 | 005 | - | remove the feature support statements | F | | | +| 2014-09 | SA#65 | SP-140558 | 006 | - | correction of data type | F | 11.3.0 | 11.4.0 | +| | | SP-140560 | 007 | - | Update the link from Solution Set to Information Service due to the end of Release 12 | C | 11.4.0 | 12.0.0 | +| 2014-12 | SA#66 | SP-140800 | 009 | 1 | Add support for sharing of UTRAN | B | 12.0.0 | 12.1.0 | +| 2015-12 | SA#70 | SP-150691 | 010 | - | Align id attribute definitions | A | 12.1.0 | 12.2.0 | +| 2016-01 | SA#70 | | | | Upgrade to Release 13 (MCC) | | 12.2.0 | 13.0.0 | +| 2016-03 | SA#71 | SP-160031 | 014 | - | Make the XML schema well formed | A | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-06 | SA#72 | SP-160407 | 0012 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.2.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0016 | - | F | Update link from IRP SS to IS | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0017 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-03 | SA#79 | SP-180060 | 0018 | - | B | Add attribute peeParametersList to UTRAN NRM SS | 15.0.0 | +| 2020-07 | - | - | - | - | | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28654/raw.md b/marked/Rel-16/28_series/28654/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d57c7c6b0e44f9989ac230157ddac4e4cb28e810 --- /dev/null +++ b/marked/Rel-16/28_series/28654/raw.md @@ -0,0 +1,118 @@ + + + + + + +# --- Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 +- 3.1 Definitions..... 5 +- 3.2 Abbreviations ..... 5 +- 4 Requirements ..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.654: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** +- 28.655: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- 28.656: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the requirements for the present IRP: GERAN Network Resource Model (NRM) Integration Reference Point (IRP). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [5] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [6] 3GPP TS.28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**IRP:** See 3GPP TS 32.101 [1]. + +**Network Resource Model (NRM):** See definition in TS 32.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IRP | Integration Reference Point | +| IS | Information Service (see [1]) | +| NRM | Network Resource Model | +| UMTS | Universal Mobile Telecommunications System | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [1]. +- b) IRP-related requirements in 3GPP TS 32.102 [2]. +- c) IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- a) Shall support communications for telecommunication network management purposes, including management of converged networks. +- b) Is a member of the Federated Network Information Model (FNIM) [4] and its information is derived from FNIM Umbrella Information Model (UIM) [5]. + +In addition to the above, the following more specific requirements apply: + +**REQ-GERAN\_NRM-CON-001:** The Network Resource Model defined by this IRP shall contain GERAN specific classes and related definitions, supporting the management of GERAN Network entities. + +**REQ-GERAN\_NRM-CON-002:** The Network Resource Model defined by this IRP shall support management of UMTS-GSM Inter-system handover. + +# Annex A (informative): Change history + +| <b>Change history</b> | | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|--------------------------------------------------|------------|------------|---------------| +| <b>Date</b> | <b>TSG #</b> | <b>TSG Doc.</b> | <b>CR</b> | <b>Rev</b> | <b>Subject/Comment</b> | <b>Cat</b> | <b>Old</b> | <b>New</b> | +| 2014-06 | SA#64 | SP-140359 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28655/1c94fd3cebf58af136144f14160d128e_img.jpg b/marked/Rel-16/28_series/28655/1c94fd3cebf58af136144f14160d128e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ea8c008adddcb34a1937b6de941b678155f23ed --- /dev/null +++ b/marked/Rel-16/28_series/28655/1c94fd3cebf58af136144f14160d128e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de5e4e147c58a4b8a6689279e7275f66ccd6647bfa8d1d77cd9a527de5431284 +size 57101 diff --git a/marked/Rel-16/28_series/28655/1c953f32bd34345dfd68fddf8a3736d6_img.jpg b/marked/Rel-16/28_series/28655/1c953f32bd34345dfd68fddf8a3736d6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f1e9e373314197d996e1a12a454e3fff2880a91 --- /dev/null +++ b/marked/Rel-16/28_series/28655/1c953f32bd34345dfd68fddf8a3736d6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:39ed698e6c74c932cccdfa06522543773108a0b742fd232a4892c64619a9ae61 +size 79294 diff --git a/marked/Rel-16/28_series/28655/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/28_series/28655/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44d007610fda6dd4e4a7243181e566796095f2fd --- /dev/null +++ b/marked/Rel-16/28_series/28655/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1bb31011d668e8be97b2633d9429f3027110baadb78a1f20a8e6959d872e392 +size 19526 diff --git a/marked/Rel-16/28_series/28655/raw.md b/marked/Rel-16/28_series/28655/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5d7fc57e19813bdffa171ec6600d21edda18b79c --- /dev/null +++ b/marked/Rel-16/28_series/28655/raw.md @@ -0,0 +1,550 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Forward ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 6 | +| 4.1 Imported information entities and local labels..... | 6 | +| 4.2 Class diagram..... | 7 | +| 4.2.1 Relationships ..... | 7 | +| 4.2.2 Inheritance ..... | 8 | +| 4.3 Class definitions ..... | 8 | +| 4.3.1 BSSFunction..... | 8 | +| 4.3.1.1 Definition ..... | 8 | +| 4.3.1.2 Attributes ..... | 9 | +| 4.3.1.3 Attribute constraints..... | 9 | +| 4.3.1.4 Notifications..... | 9 | +| 4.3.2 BTSSiteMgr ..... | 9 | +| 4.3.2.1 Definition ..... | 9 | +| 4.3.2.2 Attributes ..... | 9 | +| 4.3.2.3 Attribute constraints..... | 9 | +| 4.3.2.4 Notifications..... | 9 | +| 4.3.3 GSMCell ..... | 9 | +| 4.3.3.1 Definition ..... | 9 | +| 4.3.3.2 Attributes ..... | 10 | +| 4.3.3.3 Attribute constraints..... | 10 | +| 4.3.3.4 Notifications..... | 10 | +| 4.3.4 GSMRelation..... | 10 | +| 4.3.4.1 Definition ..... | 10 | +| 4.3.4.2 Attributes ..... | 11 | +| 4.3.4.3 Attribute constraints..... | 11 | +| 4.3.4.4 Notifications..... | 11 | +| 4.3.5 ExternalGSMCell ..... | 11 | +| 4.3.5.1 Definition ..... | 11 | +| 4.3.5.2 Attributes ..... | 12 | +| 4.3.5.3 Attribute constraints..... | 12 | +| 4.3.5.4 Notifications..... | 12 | +| 4.3.6 ExternalBSSFunction..... | 12 | +| 4.3.6.1 Definition ..... | 12 | +| 4.3.6.2 Attributes ..... | 12 | +| 4.3.6.3 Attribute constraints..... | 12 | +| 4.3.6.4 Notifications..... | 12 | +| 4.4 Attribute definitions ..... | 13 | +| 4.4.1 Attribute properties..... | 13 | +| 4.4.2 Constraints ..... | 17 | +| 4.5 Common notifications ..... | 17 | +| 4.5.1 Alarm notifications ..... | 17 | +| 4.5.2 Configuration notifications..... | 17 | +| Annex A (informative): Change history..... | 18 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.654: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- 28.655: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)** +- 28.656: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document specifies the GERAN Network Resource Model (NRM) that can be communicated between an IRP Agent and IRP Managers for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [4] 3GPP TS 44.018: "Mobile radio interface layer 3 specification; Radio Resource Control (RRC) protocol". +- [5] 3GPP TS 45.008: "Radio subsystem link control". +- [6] 3GPP TS 45.002: "Multiplexing and multiple access on the radio path". +- [7] 3GPP TS 23.002: "Network architecture". +- [8] 3GPP TS 23.003: "Numbering, Addressing and Identification". +- [9] 3GPP TS 28.652: "Telecommunication management; Configuration Management (CM); UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [10] 3GPP TS 28.658: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [11] 3GPP TS 32.111-2: "Telecommunication management; Fault Management (FM); Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [12] 3GPP TS 28.662: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [13] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [14] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [15] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [16] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". + +- [17] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM; Information service (IS)". +- [18] 3GPP TS 28.625: "Telecommunication Management; State Management Data Definition Integration Reference Point (IRP): Information Service (IS)". +- [19] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [19], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [14] 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 [19], 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and 3GPP TS 32.600 [14]. + +**Association:** See definition in TS 28.622 [16]. + +**Managed Element (ME):** See definition in TS 28.622 [16]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [16]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [19] 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 [19]. + +| | | +|-----|-------------------------------------------------------| +| DN | Distinguished Name (see 3GPP TS 32.300 [13]) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| ME | Managed Element | +| NR | Neighbour cell Relation | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [13]) | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|----------------------------------------------------------------|------------------| +| 3GPP TS 28.622 [16], information object class, ManagedElement | ManagedElement | +| 3GPP TS 28.622 [16], information object class, ManagedFunction | ManagedFunction | +| 3GPP TS 28.622 [16], information object class, SubNetwork | SubNetwork | +| 3GPP TS 28.622 [16], information object class, Top | Top | +| 3GPP TS 28.622 [16], information object class, VsDataContainer | VsDataContainer | +| 3GPP TS 28.652 [9], information object class, UTRANRelation | UTRANRelation | +| 3GPP TS 28.658 [10], information object class, EUTRANRelation | EUTRANRelation | +| 3GPP TS 28.625 [18], attribute, operationalState | operationalState | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes that encapsulate information relevant for this service. This clause provides the overview of all classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +The figures below show the containment/naming hierarchy and the associations of the GERAN NRM. + +![GERAN NRM Containment/Naming and Association diagram showing class hierarchies and associations.](1c953f32bd34345dfd68fddf8a3736d6_img.jpg) + +``` + +classDiagram + class SubNetwork["«InformationObjectClass» SubNetwork (from 28.622)"] + class ExternalBSSFunction["«InformationObjectClass» ExternalBSSFunction"] + class ExternalGSMCell["«InformationObjectClass» ExternalGSMCell"] + class ManagedElement["«InformationObjectClass» ManagedElement (from 28.622)"] + class BSFunction["«InformationObjectClass» BSFunction"] + class BTSSiteManager["«InformationObjectClass» BTSSiteManager"] + class GSMCell["«InformationObjectClass» GSMCell"] + class GSMRelation["«InformationObjectClass» GSMRelation"] + class UTRANRelation["«InformationObjectClass» UTRANRelation (from 28.652)"] + class AdjacentCell["«ProxyClass» AdjacentCell"] + + SubNetwork "1" *-- "*" ExternalBSSFunction : «names» + SubNetwork "1" *-- "*" ExternalGSMCell : «names» + ExternalBSSFunction "1" *-- "*" ExternalGSMCell : «names» + ManagedElement "1" *-- "*" BSFunction : «names» + BSFunction "1" *-- "*" BTSSiteManager : «names» + BTSSiteManager "1" *-- "*" GSMCell : «names» + GSMCell "1" *-- "*" GSMRelation : «names» + GSMCell "1" *-- "*" UTRANRelation : «names» + GSMCell "1" -- "*" AdjacentCell : + adjacentCell + AdjacentCell : It represents ExternalGSMCell or GSMCell. + +``` + +The diagram illustrates the containment and naming hierarchy of classes in the GERAN NRM. It shows two main vertical hierarchies. The left hierarchy starts with **SubNetwork** (from 28.622) at the top, which contains **ExternalBSSFunction** and **ExternalGSMCell**. **ExternalBSSFunction** further contains **ExternalGSMCell**. The right hierarchy starts with **ManagedElement** (from 28.622) at the top, which contains **BSFunction**, which contains **BTSSiteManager**, which contains **GSMCell**. **GSMCell** contains **GSMRelation** and **UTRANRelation** (from 28.652). Additionally, **GSMCell** is associated with **AdjacentCell** (a ProxyClass), which is noted to represent **ExternalGSMCell** or **GSMCell**. All containment relationships are labeled with «names» and cardinalities 1 to \*. + +GERAN NRM Containment/Naming and Association diagram showing class hierarchies and associations. + +NOTE 1: The listed cardinality numbers represent transient as well as steady-state numbers, and reflect all managed object creation and deletion scenarios. + +NOTE 2: The **ExternalBSSFunction** is used in the Core Network NRM. + +**Figure 4.2.1-1: GERAN NRM Containment/Naming and Association diagram** + +Each Managed Object is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [13] that expresses its containment hierarchy. As an example, the DN of an IOC representing a cell could have a format like: + +SubNetwork =Sweden, MeContext =MEC-Gbg-1, ManagedElement =RNC-Gbg-1, BSFunction=BSS1. + +![Figure 4.2.1-2: GERAN NRM Containment/Naming and Association diagram. The diagram shows two classes: «InformationObjectClass» GSMRelation and «InformationObjectClass» VsDataContainer (from 28.622). GSMRelation has a 1-to-many association with VsDataContainer, labeled «names». VsDataContainer has a 1-to-many association back to GSMRelation, also labeled «names». Both associations are represented by lines with diamond-shaped connectors at the '1' end.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +classDiagram + class GSMRelation["«InformationObjectClass»\nGSMRelation"] + class VsDataContainer["«InformationObjectClass»\nVsDataContainer\n(from 28.622)"] + GSMRelation "1" *-- "*" VsDataContainer : «names» + VsDataContainer "1" *-- "*" GSMRelation : «names» + +``` + +Figure 4.2.1-2: GERAN NRM Containment/Naming and Association diagram. The diagram shows two classes: «InformationObjectClass» GSMRelation and «InformationObjectClass» VsDataContainer (from 28.622). GSMRelation has a 1-to-many association with VsDataContainer, labeled «names». VsDataContainer has a 1-to-many association back to GSMRelation, also labeled «names». Both associations are represented by lines with diamond-shaped connectors at the '1' end. + +NOTE 1: The listed cardinality numbers represent transient as well as steady-state numbers, and reflect all managed object creation and deletion scenarios. + +NOTE 2: Each instance of the VsDataContainer shall only be contained under one IOC. The VsDataContainer can be contained under IOCs defined in other NRMs. + +**Figure 4.2.1-2: GERAN NRM Containment/Naming and Association diagram** + +The VsDataContainer is only used for the Bulk CM IRP. + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +Figure 4.2.2-1 shows the inheritance hierarchy for the GERAN NRM. + +![Figure 4.2.2-1: GERAN NRM Inheritance Hierarchy. The diagram shows a hierarchy of classes. At the top is «InformationObjectClass» Top (from 28.622). Below it is «InformationObjectClass» GSMRelation, which inherits from Top. Below Top is «InformationObjectClass» ManagedFunction (from 28.622), which also inherits from Top. Below ManagedFunction are five classes that inherit from it: «InformationObjectClass» ExternalBSSFunction, «InformationObjectClass» BSSFunction, «InformationObjectClass» BTSSiteManager, «InformationObjectClass» ExternalGSMCell, and «InformationObjectClass» GSMCell.](1c94fd3cebf58af136144f14160d128e_img.jpg) + +``` + +classDiagram + class Top["«InformationObjectClass»\nTop\n(from 28.622)"] + class GSMRelation["«InformationObjectClass»\nGSMRelation"] + class ManagedFunction["«InformationObjectClass»\nManagedFunction\n(from 28.622)"] + class ExternalBSSFunction["«InformationObjectClass»\nExternalBSSFunction"] + class BSSFunction["«InformationObjectClass»\nBSSFunction"] + class BTSSiteManager["«InformationObjectClass»\nBTSSiteManager"] + class ExternalGSMCell["«InformationObjectClass»\nExternalGSMCell"] + class GSMCell["«InformationObjectClass»\nGSMCell"] + + GSMRelation --|> Top + ManagedFunction --|> Top + ExternalBSSFunction --|> ManagedFunction + BSSFunction --|> ManagedFunction + BTSSiteManager --|> ManagedFunction + ExternalGSMCell --|> ManagedFunction + GSMCell --|> ManagedFunction + +``` + +Figure 4.2.2-1: GERAN NRM Inheritance Hierarchy. The diagram shows a hierarchy of classes. At the top is «InformationObjectClass» Top (from 28.622). Below it is «InformationObjectClass» GSMRelation, which inherits from Top. Below Top is «InformationObjectClass» ManagedFunction (from 28.622), which also inherits from Top. Below ManagedFunction are five classes that inherit from it: «InformationObjectClass» ExternalBSSFunction, «InformationObjectClass» BSSFunction, «InformationObjectClass» BTSSiteManager, «InformationObjectClass» ExternalGSMCell, and «InformationObjectClass» GSMCell. + +**Figure 4.2.2-1: GERAN NRM Inheritance Hierarchy** + +## 4.3 Class definitions + +### 4.3.1 BSSFunction + +#### 4.3.1.1 Definition + +This IOC represents BSS functionality. For more information about the BSS, see Ref 3GPP TS 23.002 [7]. + +#### 4.3.1.2 Attributes + +None. + +#### 4.3.1.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5.1 are valid for this IOC, without exceptions or additions. + +### 4.3.2 BTSSiteMgr + +#### 4.3.2.1 Definition + +This IOC contains site specific information for a BTS site. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------|-------------------|------------|------------|-------------|----------------| +| latitude | O | M | M | - | O | +| longitude | O | M | M | - | O | +| operationalState (see NOTE 1) | CM | M | - | - | M (see NOTE 2) | + +NOTE 1: No state propagation shall be implied. + +NOTE 2: The attribute value change is conveyed by the notifyStateChange notification. + +#### 4.3.2.3 Attribute constraints + +| Name | Definition | +|---------------------------------------|----------------------------------------| +| operationalState CM support qualifier | The State Management IRP is supported. | + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC In addition, the following set of notification, defined in 3GPP TS 32.662 [17], is also valid. + +| Name | Qualifier | Notes | +|-------------------|-----------|-------| +| notifyStateChange | O | | + +### 4.3.3 GSMCell + +#### 4.3.3.1 Definition + +This IOC represents the GSM radio cell. The applicability of instantiation of this class is depending on the ME type. It may only be instantiated under ME of type BSC. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|------------|-------------|--------------| +| cellIdentity | M | M | M | - | M | +| cellAllocation | M | M | M | - | M | +| ncc | M | M | M | - | M | +| bcc | M | M | M | - | M | +| lac | M | M | M | - | M | +| mcc | M | M | M | - | M | +| mnc | M | M | M | - | M | +| rac | CM | M | M | - | M | +| racc | CM | M | M | - | M | +| tsc | CM | M | M | - | M | +| rxLevAccessMin | M | M | M | - | M | +| msTxPwrMaxCCH | M | M | M | - | M | +| rfHoppingEnabled | M | M | M | - | M | +| hoppingSequenceList | M | M | M | - | M | +| plmnPermitted | M | M | M | - | M | + +#### 4.3.3.3 Attribute constraints + +| Name | Definition | +|---------------------------|----------------------------------------------------------------------| +| rac CM support qualifier | GPRS is supported in the cell. | +| racc CM support qualifier | GPRS is supported in the cell. | +| tsc CM support qualifier | RET, TMA etc. are not modelled according to Ref 3GPP TS 28.662 [12]. | + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.4 GSMRelation + +#### 4.3.4.1 Definition + +This IOC contains a Neighbour Cell Relation (NCR) from a source cell to a target cell, where the target cell is a GSMCell or ExternalGSMCell instance. + +NOTE: In handover relation terms, the cell containing the GSMRelation object is the source cell for the handover. The cell referred to in the GSMRelation object is the target cell for the handover. This defines a one-way handover relation where the direction is *from* source cell *to* target cell. + +The source cell can be a GSMCell instance. This is the case for an Intra-GERAN NCR. + +The source cell can be a UTRANGenericCell instance. This is the case for Inter-RAT NCR from UTRAN to GERAN. See 3GPP TS 28.652 [9]. + +The source cell can be an EUTRANGenericCell instance. This is the case for Inter-RAT NCR from E-UTRAN to GERAN. See 3GPP TS 28.658 [10]. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| bcchFrequency | CM | M | - | - | M | +| ncc | CM | M | - | - | M | +| bcc | CM | M | - | - | M | +| lac | CM | M | - | - | M | +| isHOAllowed | CM | M | M | - | M | +| isRemoveAllowed | CM | M | M | - | M | +| isESCoveredBy | CM | M | M | - | M | +| <b>Attribute related to role</b> | | | | | | +| adjacentCell | CM | M | - | - | M | + +#### 4.3.4.3 Attribute constraints + +| Name | Definition | +|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bcchFrequency CM support qualifier | The EM does not guarantee consistency between the cell definition and what is broadcast on system information and RET, TMA etc. are not modelled according to Ref 3GPP TS 28.662 [12]. | +| ncc CM support qualifier | The EM does not guarantee consistency between the cell definition and what is broadcast on system information. | +| bcc CM support qualifier | The EM does not guarantee consistency between the cell definition and what is broadcast on system information. | +| lac CM support qualifier | The EM does not guarantee consistency between the cell definition and what is broadcast on system information. | +| isRemoveAllowed Support Qualifier | The condition is "Inter-RAT ANR function is supported in the source cell, and the source cell is an EUTRANGenericCell or a UTRANGenericCell". | +| isHOAllowed Support Qualifier | The condition is "Inter-RAT ANR function is supported in the source cell, and the source cell is an EUTRANGenericCell or a UTRANGenericCell". | +| isESCoveredBy Support Qualifier | The condition is "The source cell is an E-UTRAN or UTRAN cell which supports Inter-RAT Energy Saving". | +| adjacentCell Support Qualifier | <p>The conditions are:</p> <p>“The target cell and the serving cell (name-containing this GSMRelation) are managed by different IRPAGENT” or “the target cell and the serving cell (name-containing this GSMRelation) are managed by the same IRPAGENT”.</p> <p>When former condition is true, the role-attribute holds the DN of an ExternalGSMCell instance. When the latter condition is true, the role-attribute holds the DN of a GSMCell instance.</p> | + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.5 ExternalGSMCell + +#### 4.3.5.1 Definition + +This IOC represents a radio cell controlled by another IRPAGENT. This IOC has necessary attributes for inter-system handover. It contains a subset of the attributes of related IOCs controlled by another IRPAGENT. To maintain the consistency between the attribute values of these two IOCs is outside the scope of this document. + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| cellIdentity | M | M | M | - | M | +| bcchFrequency | M | M | M | - | M | +| ncc | M | M | M | - | M | +| bcc | M | M | M | - | M | +| lac | M | M | M | - | M | +| mcc | M | M | M | - | M | +| mnc | M | M | M | - | M | +| rac | CM | M | M | - | M | +| racc | CM | M | M | - | M | + +#### 4.3.5.3 Attribute constraints + +| Name | Definition | +|---------------------------|--------------------------------| +| rac CM support qualifier | GPRS is supported in the cell. | +| racc CM support qualifier | GPRS is supported in the cell. | + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +### 4.3.6 ExternalBSSFunction + +#### 4.3.6.1 Definition + +This IOC represents a BSSFunction controlled by another IRP Agent. It contains a subset of the attributes of related IOCs controlled by another IRP Agent. To maintain the consistency between the attribute values of these two IOCs is outside the scope of the present document. + +#### 4.3.6.2 Attributes + +None. + +#### 4.3.6.3 Attribute constraints + +None. + +#### 4.3.6.4 Notifications + +The common notifications defined in subclause 4.5.2 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table defines the properties of attributes specified in the present document. + +**Table 4.4.1: Attributes** + +| Attribute Name | Documentation and Allowed values | Properties | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| GSMCell.bcc | Base station colour code, BCC (part of BSIC). Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ExternalGSMCell.bcc | Base station colour code, BCC (part of BSIC). Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| GSMRelation.bcc | Base station colour code, BCC (part of BSIC. Ref 3GPP TS 44.018 [4]) for another GSM cell or the external GSM cell, that is broadcast in System Information in the Cell.<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ExternalGsmCell.bcchFrequency | This attribute contains the absolute radio frequency channel number of the BCCH channel of the GSM cell.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| GSMRelation.bcchFrequency | This attribute contains the absolute radio frequency channel number of the BCCH channel of another GSM cell or the external GSM cell, that is broadcast in System Information in the Cell.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cellAllocation | This attribute defines the set of radio frequencies allocated and available to a cell, the first element sets the BCCH frequency, Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 0..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| cellIdentity | Cell Identity (Ref 3GPP TS 24.008 [3]).<br><br>See Ref 3GPP TS 24.008 [3].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hoppingSequenceList | This attribute defines a sequence of structures. Each structure has two elements. One element carries the MA as defined in 44.018 [4] and the other element carries the HSN as defined in 45.502 [6].<br><br>allowedValues: N/A | type: <<datatype>><br>multiplicity: 1<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| isESCoveredBy | <p>The value of the attribute is configured by the IRPManager and is not changed by the IRPAgent. It indicates whether the adjacentCell according to this planning provides no, partial or full Inter-RAT coverage for the cell which name-contains the GSMRelation instance.</p> <p>Adjacent cells with this attribute equal to “yes” are recommended to be considered as candidate cells to take over the coverage when the original cell is about to be transferred to energySaving state.</p> <p>The entirety of adjacent cells with this property equal to “partial” are recommended to be considered as entirety of candidate cells to take over the coverage when the original cell is about to be transferred to energySaving state.</p> <p>allowedValues: No, partial, yes</p> | type: ENUM<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| GSMCell.lac | <p>Location Area Code (LAC). Ref 3GPP TS 24.008 [3].</p> <p>See Ref 3GPP TS 24.008 [3].</p> <p>allowedValues: N/A</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| GSMRelation.lac | <p>Location Area Code, LAC (Ref 3GPP TS 24.008 [3]) for another GSM cell or the external GSM cell, that is broadcast in System Information in the Cell.</p> <p>See Ref 3GPP TS 24.008 [3].</p> <p>allowedValues: N/A</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| latitude | <p>The latitude of the site manager location based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to the northern hemisphere.</p> <p>allowedValues: -90.0000 to +90.0000</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| longitude | <p>The longitude of the site manager location based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to degrees east of 0 degrees longitude.</p> <p>allowedValues: -180.0000 to +180.0000</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mcc | <p>Mobile Country Code, MCC (part of the PLMN Id, Ref. 3GPP TS 23.003 [8]).</p> <p>See Ref 3GPP TS 24.008 [3].</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: False | +| mnc | <p>Mobile Network Code, MNC (part of the PLMN Id, Ref. 3GPP TS 23.003 [8]).</p> <p>See Ref 3GPP TS 24.008 [3].</p> <p>allowedValues: N/A</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| msTxPwrMaxCCH | Maximum Transmission Power for a Mobile Station on a CCH. Attribute description Ref 3GPP TS 45.008 [5] (MS_TXPWR_MAX_CCH).<br><br>See Ref 3GPP TS 45.008 [5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| GSMCell.ncc | Network Colour Code, NCC (part of BSIC). Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ExternalGSMCell.ncc | Network Colour Code, NCC (part of BSIC. Ref 3GPP TS 44.018 [4]) for another GSM cell or the external GSM cell, that is broadcast in System Information in the Cell.<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| plmnPermitted | Network Colour Code Permitted. Attribute description reference 3GPP TS 45.008 [5] (NCC_PERMITTED).<br><br>See Ref 3GPP TS 45.008 [5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rac | Routing Area Code, RAC. Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| racc | Routing Area Colour Code, RACC. Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rfHoppingEnabled | Indicates if frequency hopping is enabled.<br><br>Boolean value false represents 'disabled'; true represents 'enabled'.<br><br>allowedValues: False, True. | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rxLevAccessMin | Minimum Access Level. Attribute description Ref 3GPP TS 45.008 [5] (RXLEV_ACCESS_MIN)<br><br>See Ref 3GPP TS 45.008 [5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tsc | Training Sequence Code, an attribute of the class channel in Ref 3GPP TS 44.018 [4].<br><br>See Ref 3GPP TS 44.018 [4].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| isHOAllowed | <p>This indicates if HO is allowed or prohibited.</p> <p>If true, handover is allowed from source cell to target cell. The source cell is identified by the name-containing UTRANGenericCell or EUTRANGenericCell of the GSMRelation that has the isHOAllowed. The target cell is referenced by the GSMRelation that has this isHOAllowed.</p> <p>If false, handover shall not be allowed.</p> <p>allowedValues: False, True.</p> | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| isRemoveAllowed | <p>This indicates if the subject GSMRelation can be removed (deleted) or not.</p> <p>If true, the subject GSMRelation instance can be removed (deleted).</p> <p>If false, the subject GSMRelation instance shall not be removed (deleted) by any entity but an IRPManager.</p> <p>allowedValues: False, True.</p> | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| Attribute related to role | | | +| adjacentCell | <p>This holds the DN of GSMCell or ExternalGSMCell.</p> <p>allowedValues: N/A</p> | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This clause presents a list of notifications, defined in 3GPP TS 32.111-2 [11], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in 3GPP TS 32.302 [15], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|---------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [11]) | | + +### 4.5.2 Configuration notifications + +This clause presents a list of notifications, defined in 3GPP TS 32.662 [17], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in 3GPP TS 32.302 [15], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | + + + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SA#64 | SP-140332 | 001 | 1 | Correct hopping sequence list data type | 11.0.0 | 11.1.0 | +| | | SP-140359 | 002 | - | remove the feature support statements | | | +| 2014-09 | SA#65 | SP-140558 | 004 | - | Correction of operationalState attribute definitions | 11.1.0 | 11.2.0 | +| 2014-09 | | | | | Automatic upgrade (MCC) | 11.2.0 | 12.0.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13 (MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-06 | SA#72 | SP-160408 | 0008 | - | A | The attributes "longitude" and "latitude" are lacking detailed definition | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-09 | SA#85 | SP-190751 | 0009 | - | F | Correction of NR to NCR and Remove not needed abbreviations | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28656/raw.md b/marked/Rel-16/28_series/28656/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0521423d3290c149446c6944531d2a7b862e77dd --- /dev/null +++ b/marked/Rel-16/28_series/28656/raw.md @@ -0,0 +1,802 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set Definitions ..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.2 Rules for NRM extensions ..... | 8 | +| A.2 Mapping ..... | 9 | +| A.2.1 General mapping ..... | 9 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC BSSFunction..... | 9 | +| A.2.2.2 IOC BTSSiteMgr..... | 9 | +| A.2.2.3 IOC GSMCell..... | 10 | +| A.2.2.4 IOC GSMRelation..... | 10 | +| A.2.2.5 IOC ExternalGSMCell ..... | 10 | +| A.2.2.6 IOC ExternalBSSFunction ..... | 11 | +| A.3 Solution Set definitions..... | 12 | +| A.3.1 IDL definition structure..... | 12 | +| A.3.2 IDL specification "GeranNetworkResourcesNRMDefs.idl" ..... | 12 | +| <b>Annex B (normative): XML Definitions.....</b> | <b>14</b> | +| B.0 General..... | 14 | +| B.1 Architectural features..... | 14 | +| B.1.0 General ..... | 14 | +| B.1.1 Syntax for Distinguished Names..... | 14 | +| B.2 Mapping ..... | 14 | +| B.2.1 General mapping ..... | 14 | +| B.2.2 Information Object Class (IOC) mapping..... | 14 | +| B.3 Solution Set definitions..... | 15 | +| B.3.1 XML definition structure ..... | 15 | +| B.3.2 Graphical Representation..... | 15 | +| B.3.3 XML schema "geranNrm.xsd"..... | 16 | +| Annex C (informative): Change history..... | 20 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.654: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.655: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.656: GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named GERAN Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning GERAN resources. The GERAN NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set definitions. + +The present document specifies the Solution Set definitions for the GERAN NRM IRP. + +This Solution Set specification is related to 3GPP TS 28.655 V14.0.X [4]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.655: "Telecommunication management; GERAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [9] Void +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For terms and definitions please refer to 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.600 [3] and 3GPP TS 28.655 [4]. + +**XML file:** See definition of [6]. + +**XML document:** See definition of [6]. + +**XML declaration:** See definition of [6]. + +**XML element:** See definition of [6]. + +**empty XML** See definition of [6]. + +**XML content (of an XML element):** See definition of [6]. + +**XML start-tag:** See definition of [6]. + +**XML end-tag:** See definition of [6]. + +**XML empty-element tag:** See definition of [6]. + +**XML attribute specification:** See definition of [6]. + +**DTD:** See definition of [6]. + +**XML schema:** See definition of [6]. + +**XML namespace:** See definition of [6]. + +**XML complex type:** See definition of [6]. + +**XML element type:** See definition of [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IS | Information Service | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP GERAN NRM IRP Solution Set Definitions: + +- 3GPP GERAN NRM IRP CORBA SS (Annex A) +- 3GPP GERAN NRM IRP XML Definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in GERAN NRM IRP: Information Service (TS 28.655 [4]). + +--- + +### A.1 Architectural features + +The overall architectural feature of GERAN NRM IRP is specified in 3GPP TS 28.655 [4]. +This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [5]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [5]. + +### A.2 Mapping + +#### A.2.1 General mapping + +See clause A.2.1 of [5]. + +#### A.2.2 Information Object Class (IOC) mapping + +##### A.2.2.1 IOC BSSFunction + +**Mapping from NRM IOC BSSFunction attributes to SS equivalent MOC BssFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | bssFunctionId | string | +| userLabel | userLabel | string | + +##### A.2.2.2 IOC BTSSiteMgr + +**Mapping from NRM IOC BTSSiteMgr attributes to SS equivalent MOC BtsSiteMgr attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------|------------------|---------------------------------------------------------| +| id | btsSiteMgrId | string | +| userLabel | userLabel | string | +| latitude | latitude | long | +| longitude | longitude | long | +| operationalState | operationalState | StateManagementIRPOptConstDefs::OperationalStateTypeOpt | + +#### A.2.2.3 IOC GSMCell + +##### Mapping from NRM IOC GSMCell attributes to SS equivalent MOC GsmCell attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------------|---------------------|-----------------------------------------------------------| +| id | gsmCellId | string | +| userLabel | userLabel | string | +| cellIdentity | cellIdentity | long | +| cellAllocation | cellAllocation | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | +| ncc | ncc | long | +| bcc | bcc | long | +| lac | lac | long | +| mcc | mcc | long | +| mnc | mnc | long | +| rac | rac | long | +| racc | racc | long | +| tsc | tsc | long | +| rxLevAccessMin | rxLevAccessMin | long | +| msTxPwrMaxCCH | msTxPwrMaxCCH | long | +| rfHoppingEnabled | rfHoppingEnabled | boolean | +| hoppingSequenceList | hoppingSequenceList | GeranNRMAAttributeTypes::HoppingSequenceListType | +| plmnPermitted | plmnPermitted | long | + +#### A.2.2.4 IOC GSMRelation + +##### Mapping from NRM IOC GSMRelation attributes to SS equivalent MOC GsmRelation attributes + +| IS Attributes | SS Attributes | SS Type | +|-----------------|-----------------|------------------------------------------------| +| id | gsmRelationId | string | +| adjacentCell | adjacentCell | string | +| bcchFrequency | bcchFrequency | long | +| ncc | ncc | long | +| bcc | bcc | long | +| lac | lac | long | +| isHOAllowed | isHOAllowed | boolean | +| isRemoveAllowed | isRemoveAllowed | boolean | +| isESCoveredBy | isESCoveredBy | GeranNRMAAttributeTypes::IsEsCoveredByEnumType | + +#### A.2.2.5 IOC ExternalGSMCell + +##### Mapping from NRM IOC ExternalGSMCell attributes to SS equivalent MOC ExternalGsmCell attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|-------------------|---------| +| id | externalGsmCellId | string | +| userLabel | userLabel | string | +| cellIdentity | cellIdentity | long | +| bcchFrequency | bcchFrequency | long | +| ncc | ncc | long | +| bcc | bcc | long | +| Lac | lac | long | +| mcc | mcc | long | +| mnc | mnc | long | +| rac | rac | long | +| racc | racc | long | + +#### A.2.2.6 IOC ExternalBSSFunction + +**Mapping from NRM IOC ExternalBSSFunction attributes to SS equivalent MOC ExternalBssFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|-----------------------|---------| +| id | externalBssFunctionId | string | +| userLabel | userLabel | string | + +### A.3 Solution Set definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the GERAN NRM IRP. + +#### A.3.2 IDL specification "GeranNetworkResourcesNRMDefs.idl" + +``` +//File: GeranNetworkResourcesNRMDefs.idl +#ifndef GeranNetworkResourcesNRMDefs_idl +#define GeranNetworkResourcesNRMDefs_idl +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module GeranNetworkResourcesNRMDefs +{ + /** + * Definitions for MO class BssFunction + */ + interface BssFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "BssFunction"; + // Attribute Names + // + const string bssFunctionId = "bssFunctionId"; + }; + + /** + * Definitions for MO class BtsSiteMgr + */ + interface BtsSiteMgr : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "BtsSiteMgr"; + // Attribute Names + // + const string btsSiteMgrId = "btsSiteMgrId"; + const string latitude = "latitude"; + const string longitude = "longitude"; + const string operationalState = "operationalState"; + }; + + /** + * Definitions for MO class GsmCell + */ + interface GsmCell : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "GsmCell"; + // Attribute Names + // + const string gsmCellId = "gsmCellId"; + const string cellIdentity = "cellIdentity"; + const string cellAllocation = "cellAllocation"; + const string ncc = "ncc"; + const string bcc = "bcc"; + const string lac = "lac"; + const string mcc = "mcc"; + const string mnc = "mnc"; + const string rac = "rac"; + const string racc = "racc"; + const string tsc = "tsc"; + const string rxLevAccessMin = "rxLevAccessMin"; + const string msTxPwrMaxCCH = "msTxPwrMaxCCH"; + const boolean rfHoppingEnabled = "rfHoppingEnabled"; + const string hoppingSequenceList = "hoppingSequenceList"; + const string plmnPermitted = "plmnPermitted"; + }; + + /** + * Definitions for MO class GsmRelation + */ + interface GsmRelation : GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "GsmRelation"; + }; +} +``` + +``` + // Attribute Names + // + const string gsmRelationId = "gsmRelationId"; + const string adjacentCell = "adjacentCell"; + const string bcchFrequency = "bcchFrequency"; + const string ncc = "ncc"; + const string bcc = "bcc"; + const string lac = "lac"; + const string isHOAllowed = "isHOAllowed"; + const string isRemoveAllowed = "isRemoveAllowed"; + const string isESCoveredBy = "isESCoveredBy"; + }; + + /** + * Definitions for MO class ExternalGsmCell + */ + interface ExternalGsmCell : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalGsmCell"; + // Attribute Names + // + const string externalGsmCellId = "externalGsmCellId"; + const string cellIdentity = "cellIdentity"; + const string bcchFrequency = "bcchFrequency"; + const string ncc = "ncc"; + const string bcc = "bcc"; + const string lac = "lac"; + const string mcc = "mcc"; + const string mnc = "mnc"; + const string rac = "rac"; + const string racc = "racc"; + }; + + /** + * Definitions for MO class ExternalBssFunction + */ + interface ExternalBssFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalBssFunction"; + // Attribute Names + // + const string externalBssFunctionId = "externalBssFunctionId"; + }; +}; + +module GeranNRMAtributeTypes +{ + enum isEsCoveredByEnumType + { + no, + partial, + yes + }; + + typedef sequence<boolean> MAType; + + struct HoppingSequenceType + { + MAType ma; + short hsn; + }; + + typedef sequence<HoppingSequenceType> HoppingSequenceListType; +}; + +#endif +``` + +# --- Annex B (normative): XML Definitions + +## B.0 General + +This annex contains the XML Definitions for the GERAN NRM IRP as it applies to Itf-N, in accordance with GERAN NRM IRP IS definitions [4]. + +The XML file formats are based on XML [8], XML Schema [10] [11] and XML Namespace [12] standards. + +### --- B.1 Architectural features + +#### B.1.0 General + +The overall architectural feature of GERAN NRM IRP is specified in 3GPP TS 28.655 [4]. + +This clause specifies features that are specific to the Schema definitions. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +### --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is nNot present in the current version of this specification. + +## --- B.3 Solution Set definitions + +#### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [7]. + +Annex B.3.3 of the present document defines the NRM-specific XML schema `geranNrm.xsd` for the GERAN Network Resources IRP NRM defined in 3GPP TS 32.652 [4]. + +XML schema `geranNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [7]. + +#### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +#### B.3.3 XML schema "geranNrm.xsd" + +``` + +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.656 GERAN NRM IRP + Bulk CM Configuration data file NRM-specific XML schema + geranNrm.xsd +--> + +<schema + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:un="http://www.3gpp.org/ftp/specs/archive/28_series/28.653#utranNrm" + xmlns:gn="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + xmlns:sm="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + xmlns:en="http://www.3gpp.org/ftp/specs/archive/28_series/28.659#eutranNrm" + xmlns:sp="http://www.3gpp.org/ftp/specs/archive/28_series/28.629#sonPolicyNrm" + xmlns:gr="http://www.3gpp.org/ftp/specs/archive/28_series/28.663#genericRanNrm" + + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + elementFormDefault="qualified" +> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.653#utranNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.659#eutranNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.629#sonPolicyNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28\_series/28.663#genericRanNrm" + /> + <simpleType name="isESCoveredByEnumType"> + <restriction base="string"> + <enumeration value="no"/> + <enumeration value="partial"/> + <enumeration value="yes"/> + </restriction> + </simpleType> + + <complexType name="MA"> + <sequence> + <element name="rfSelected" type="boolean" minOccurs="0"/> + </sequence> + </complexType> + <complexType name="HoppingSequence"> + <sequence> + <element name="ma" type="gn:MA" minOccurs="0"/> + <element name="hsn" type="short" minOccurs="0"/> + </sequence> + </complexType> + <complexType name="HoppingSequenceList"> + <sequence> + <element name="hoppingSequence" type="gn:HoppingSequence" minOccurs="0"/> + </sequence> + </complexType> + + <!-- GERAN Network Resources IRP NRM class associated XML elements --> + + <element +``` + +``` + + name="BssFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gn:BtsSiteMgr"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="BtsSiteMgr"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element ref="gr:latitude" minOccurs="0"/> + <element ref="gr:longitude" minOccurs="0"/> + <element +name="operationalState" +type="sm:operationalStateType" +minOccurs="0" +/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gn:GsmCell"/> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:InterRatEsPolicies"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="GsmCell"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cellIdentity"/> + <element name="cellAllocation"/> + <element name="ncc"/> + <element name="bcc"/> + <element name="lac"/> + <element name="mcc"/> + <element name="mnc"/> + <element name="rac" minOccurs="0"/> + <element name="racc" minOccurs="0"/> + +``` + +``` + + <element name="tsc" minOccurs="0"/> + <element name="rxLevAccessMin"/> + <element name="msTxPwrMaxCCH"/> + <element name="rfHoppingEnabled"/> + <element name="hoppingSequenceList"/> + <element name="plmnPermitted"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranRelation"/> + <element ref="en:EUTranRelation"/> + <element ref="xn:VsDataContainer"/> + <element ref="gn:GsmCellOptionallyContainedNrmClass"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:InterRatEsPolicies"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="GsmRelation"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="adjacentCell"/> + <element name="bcchFrequency" minOccurs="0"/> + <element name="ncc" minOccurs="0"/> + <element name="bcc" minOccurs="0"/> + <element name="lac" minOccurs="0"/> + <element name="isRemoveAllowed" type="boolean" minOccurs="0"/> + <element name="isHOAllowed" type="boolean" minOccurs="0"/> + <element name="isESCoveredBy" type="gn:isESCoveredByEnumType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ExternalGsmCell" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cellIdentity"/> + <element name="bcchFrequency"/> + <element name="ncc"/> + <element name="bcc"/> + <element name="lac"/> + <element name="mcc"/> + <element name="mnc"/> + <element name="rac" minOccurs="0"/> + <element name="racc" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> +</choice> +<choice minOccurs="0" maxOccurs="1"> + <element ref="sp:InterRatEsPolicies"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ExternalBssFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gn:ExternalGsmCell"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="GsmCellOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +</schema> +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------|---------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New | +| 2014-06 | SA#64 | SP-140332 | 001 | - | upgrade XSD | F | 11.0.0 | 11.1.0 | +| | | SP-140332 | 002 | 1 | Use the latest version of 32.656 as base | F | | | +| | | SP-140359 | 003 | - | remove the feature support statements | F | | | +| 2014-09 | SA#65 | SP-140560 | 005 | - | Update the link from Solution Set to Information Service due to the end of Release 12 | C | 11.1.0 | 12.0.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13(MCC) | | 12.0.0 | 13.0.0 | +| 2016-03 | SA#71 | SP-160031 | 008 | - | Make the XML schema well formed | A | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New<br>version | | +| 2016-06 | SA#72 | SP-160408 | 0011 | 1 | A | Correct the definition of hoppingSequenceList - Align with 28.655 | | 13.2.0 | +| 2016-06 | SA#72 | SP-160407 | 0012 | - | F | Update the link from IRP Solution Set to IRP Information Service | | 13.2.0 | +| 2016-06 | SA#72 | SP-160408 | 0015 | - | A | Namespace reference for the XML attributes "latitude" and "longitude" is missing | | 13.2.0 | +| 2016-09 | SA#73 | SP-160620 | 0016 | - | F | Correct the link from IRP Solution Set to IRP Information Service | | 13.3.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0017 | - | F | Update link from IRP SS to IS | | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0018 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28657/raw.md b/marked/Rel-16/28_series/28657/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8c5edc8a42b5243a2889066cba5f2d5d10453707 --- /dev/null +++ b/marked/Rel-16/28_series/28657/raw.md @@ -0,0 +1,162 @@ + + + + + + +# --- Contents + +| | | +|-------------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Requirements ..... | 6 | +| 4.1 General requirements..... | 6 | +| 4.2 Requirements for management of E-UTRAN..... | 6 | +| 4.3 Requirements for management of ng-eNB..... | 7 | +| Annex A (informative): Change history..... | 8 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +**TS 28.657 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** + +TS 28.658 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS) + +TS 28.659 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the Requirements for the E-UTRAN and ng-eNB Network Resource Model (NRM). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [5] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". +- [6] 3GPP TS 32.511: "Telecommunication management; Automatic Neighbour Relation (ANR) management; Concepts and requirements". +- [7] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [8] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [9] 3GPP TS 32.130: "Telecommunication management; Network sharing; Concepts and requirements". +- [10] 3GPP TS 37.340: "NR; Multi-connectivity; Overall description; Stage 2". +- [11] 3GPP TS 38.300: "NR; Overall description; Stage-2". +- [12] 3GPP TS 28.540: " Management and orchestration of 5G networks; Network Resource Model (NRM); Stage 1". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TS 32.150 [4], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [5] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TS 32.150 [4], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [5], in this order. + +**ng-eNB:** Defined in 3GPP TS 38.300 [11]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TS 32.150 [4], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [5] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TS 32.150 [4], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [5], in this order. + +| | | +|---------|----------------------------------------------------| +| CM | Configuration Management | +| EN-DC | E-UTRA-NR Dual Connectivity | +| NE-DC | NR-E-UTRA Dual Connectivity | +| NGEN-DC | NG-RAN E-UTRA-NR Dual Connectivity | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| IRP | Integration Reference Point | +| NB-IoT | NarrowBand Internet of Things | +| NR | New Radio | +| NRM | Network Resource Model | + +# --- 4 Requirements + +## 4.1 General requirements + +The following general and high-level requirement applies for the present IRP: + +- IRP-related requirements in 3GPP TS 32.101 [1]; +- IRP-related requirements in 3GPP TS 32.102 [2]; +- IRP-related requirements in 3GPP TS 32.600 [3]; +- ANR management related requirements in 3GPP TS 32.511 [6]; +- E-UTRAN sharing related requirements in 3GPP TS 32.130 [9]. + +The NRM defined by this IRP: + +- Shall support communications for telecommunication network management purposes, including management of converged networks. +- Is a member of the Federated Network Information Model (FNIM) [7] and its information is derived from FNIM Umbrella Information Model (UIM) [8] + +## 4.2 Requirements for management of E-UTRAN + +In addition to sub-clause 4.1, the following more specific requirements apply to E-UTRAN NRM: + +**REQ-EUTRAN\_NRM-CON-001:** The NRM defined by this IRP shall contain E-UTRAN specific IOCs and related definitions, supporting E-UTRAN network entities. + +**REQ-EUTRAN\_NRM-CON-002:** The NRM defined by this IRP shall support management of inter-system handover between EPS and UMTS, between EPS and GSM, and between EPS and CDMA2000. + +**REQ-EUTRAN\_NRM-CON-003:** The NRM defined by this IRP shall support management of Inter-Radio Access Technology Automatic Neighbour Relation (IRAT ANR) from E-UTRAN to UTRAN, from E-UTRAN to GERAN, and from E-UTRAN to CDMA2000. + +**REQ-EUTRAN\_NRM-CON-004:** The NRM defined by this IRP shall support management of Intra-E-UTRAN handover. + +**REQ-EUTRAN\_NRM-CON-005:** The NRM defined by this IRP shall support management of Intra-E-UTRAN Automatic Neighbour Relation (ANR). + +**REQ-EUTRAN\_NRM-CON-006:** The NRM defined by this IRP shall support management of E-UTRAN relaying by having a Relay Node (RN) wirelessly connect to a Donor eNB (DeNB). + +**REQ-EUTRAN\_NRM-CON-007:** The NRM defined by this IRP shall support the management of designation of individual cells as reserved for special use, i.e. such that only UEs with an operator-specified subset of Access Classes 10 to 15 can use those cells. + +**REQ-EUTRAN\_NRM-CON-008:** The NRM defined by this IRP shall support the management of shared E-UTRAN. + +**REQ-EUTRAN\_NRM-CON-009:** The NRM defined by this IRP shall support the management of NB-IoT. + +**REQ-EUTRAN\_NRM-CON-010:** The NRM defined by this IRP shall support the management of Master eNB in EN-DC (see 3GPP TS 37.340 [10]). + +## 4.3 Requirements for management of ng-eNB + +As ng-eNB is one RAN node type of NG-RAN [x], so the NG-RAN NRM requirements defined in TS 28.540 [12] apply to ng-eNB NRM. In addition, the ng-eNB related MD-DC management requirements defined in TS 28.540 [12] apply to ng-eNB NRM also, including management of ng-eNB in NGEN-DC or NE-DC operation. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------|-----|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140359 | 002 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | 12.0.0 | +| 2014-12 | SA#66 | SP-140800 | 003 | - | Add requirement for the management of shared E-UTRAN | B | 12.0.0 | 12.1.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.1.0 | 13.0.0 | + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------|-------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2016-06 | SA#72 | SP-160419 | 0005 | 2 | B | Adding NB-IoT management requirement | | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | 14.0.0 | +| 2018-06 | SA#80 | SP-180421 | 0006 | - | B | Add requirement to support EN-DC management | | 15.0.0 | +| 2018-09 | SA#81 | SP-180828 | 0008 | - | B | Add requirement to support ng-eNB management | | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28658/1439cb942d9e363bbb3161b5540dd8c6_img.jpg b/marked/Rel-16/28_series/28658/1439cb942d9e363bbb3161b5540dd8c6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..86663bd09a4d6fca0a6c2243ffd14f3937ae8d2e --- /dev/null +++ b/marked/Rel-16/28_series/28658/1439cb942d9e363bbb3161b5540dd8c6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f89991e037311a15c6c202801ddb5e19e7518f9c0ed5d928d421b168e499c2b +size 66745 diff --git a/marked/Rel-16/28_series/28658/18442e4e239480f0c3c95b547aa8fde2_img.jpg b/marked/Rel-16/28_series/28658/18442e4e239480f0c3c95b547aa8fde2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6713894c90367efc05a59885d8cdb10a298f7d23 --- /dev/null +++ b/marked/Rel-16/28_series/28658/18442e4e239480f0c3c95b547aa8fde2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9fb74c91802b413b17814493fd07c26847d4ff6f7281795892a2e0080c4a5067 +size 68432 diff --git a/marked/Rel-16/28_series/28658/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/28_series/28658/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cda5ed4602ed7ad75294e00d304e9d79cf1d55a1 --- /dev/null +++ b/marked/Rel-16/28_series/28658/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9cb31ff8c940364d0d2a696e8d3ead1f2d32d6f26d89a177c4648f7c34825f81 +size 33789 diff --git a/marked/Rel-16/28_series/28658/237b76118be454462fc9b4e96adaa6c7_img.jpg b/marked/Rel-16/28_series/28658/237b76118be454462fc9b4e96adaa6c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c6b9362cd525a985ced4e145355e5c2abcbf420 --- /dev/null +++ b/marked/Rel-16/28_series/28658/237b76118be454462fc9b4e96adaa6c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e2b4eb61264c017949578a191b73c45d9a5887d8550142125225af5d347abf4 +size 91929 diff --git a/marked/Rel-16/28_series/28658/41a438d7e4adc17c3a4005e7c9500091_img.jpg b/marked/Rel-16/28_series/28658/41a438d7e4adc17c3a4005e7c9500091_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..181dab1e248b26b52d906c1a899c43349668e9c6 --- /dev/null +++ b/marked/Rel-16/28_series/28658/41a438d7e4adc17c3a4005e7c9500091_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30488a67683a223f4d9020061e24623af24acadc8dbd6a2aef0707125305fc56 +size 23242 diff --git a/marked/Rel-16/28_series/28658/4356776ca004ecba5d599667a155d7d4_img.jpg b/marked/Rel-16/28_series/28658/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3013af6e8b2ecac775c42c744b2c59c5fab6333d --- /dev/null +++ b/marked/Rel-16/28_series/28658/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd136dd2c02100efc548ab51ebefe10897228b3af049087d98877f40e0e972c2 +size 61332 diff --git a/marked/Rel-16/28_series/28658/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/28_series/28658/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e64b691c972e0f1713a156053e01161509a8bc6 --- /dev/null +++ b/marked/Rel-16/28_series/28658/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:67d6fc8f8003dafb9a775e843963ccc8ddeaee6380a55413f5c7a23fef63e0c5 +size 80010 diff --git a/marked/Rel-16/28_series/28658/853f59c89931a666c07903b31d098277_img.jpg b/marked/Rel-16/28_series/28658/853f59c89931a666c07903b31d098277_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b302e6fa3415c03992f1434de21606dd13f43443 --- /dev/null +++ b/marked/Rel-16/28_series/28658/853f59c89931a666c07903b31d098277_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da59fac663ea8217332a8e360dd8d888e4938365b7968a4dbe4cf57f855f73d9 +size 81003 diff --git a/marked/Rel-16/28_series/28658/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg b/marked/Rel-16/28_series/28658/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc1c2ebc4ebc70bf73e2b9a7a1cd383423d0d282 --- /dev/null +++ b/marked/Rel-16/28_series/28658/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcc484cfc7d94da636ecee233dcc53242d75ac1f2d8ec21e3a3cd9d6a28a82d3 +size 39902 diff --git a/marked/Rel-16/28_series/28658/9b1ec0090070bdf52ea28763b8d52477_img.jpg b/marked/Rel-16/28_series/28658/9b1ec0090070bdf52ea28763b8d52477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6013e56071d44c4ae58961d225213a7c33fe9cc8 --- /dev/null +++ b/marked/Rel-16/28_series/28658/9b1ec0090070bdf52ea28763b8d52477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86b863f418e6e298b095cda234db6919f479c71d6a3a0852c74e01c82309bbd9 +size 91251 diff --git a/marked/Rel-16/28_series/28658/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/28_series/28658/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a86a1dfbc052f729d09947e34a86dc0915d7fc21 --- /dev/null +++ b/marked/Rel-16/28_series/28658/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9dfd0258f1e01f7c327dfd668fcec864b26ede67c840718303616562f66d7a1 +size 79611 diff --git a/marked/Rel-16/28_series/28658/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/marked/Rel-16/28_series/28658/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e298bb5fa980e45e77e0a53468654ab50556fbd0 --- /dev/null +++ b/marked/Rel-16/28_series/28658/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1731ecea0aa43453c9e28453137e97da3c1a8ec372f7f9f4ea0f98b40b1bde11 +size 55395 diff --git a/marked/Rel-16/28_series/28658/cab0834804fb031b43865554cc8d06ab_img.jpg b/marked/Rel-16/28_series/28658/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d285c96eb4a479eba427617a6c35f83659d59f87 --- /dev/null +++ b/marked/Rel-16/28_series/28658/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e4c559e1e0bfd46c1fbda9d98078c44359fe2d826c5e981ced3105366f533d4 +size 168073 diff --git a/marked/Rel-16/28_series/28658/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/marked/Rel-16/28_series/28658/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..370c34bea095044d4d90947ed6584b1f36bba951 --- /dev/null +++ b/marked/Rel-16/28_series/28658/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:284d5d250c11c9a2ccc810dbbe8cde44d36dd4abbd288a5c2319c53cbf6f3bbd +size 170700 diff --git a/marked/Rel-16/28_series/28658/raw.md b/marked/Rel-16/28_series/28658/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b2c6b5ed3bf357de57676f1ffef49a3038135207 --- /dev/null +++ b/marked/Rel-16/28_series/28658/raw.md @@ -0,0 +1,1890 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Model ..... | 10 | +| 4.1 Imported and associated information ..... | 10 | +| 4.1.1 Imported information entities and local labels ..... | 10 | +| 4.1.2 Associated information entities and local labels ..... | 11 | +| 4.2 Class diagram..... | 11 | +| 4.2.1 Relationships ..... | 11 | +| 4.2.2 Inheritance ..... | 18 | +| 4.3 Class definitions ..... | 19 | +| 4.3.1 ENBFunction..... | 19 | +| 4.3.1.1 Definition ..... | 19 | +| 4.3.1.2 Attributes ..... | 19 | +| 4.3.1.3 Attribute constraints..... | 20 | +| 4.3.1.4 Notifications..... | 20 | +| 4.3.2 ExternalENBFunction..... | 20 | +| 4.3.2.1 Definition ..... | 20 | +| 4.3.2.2 Attributes ..... | 20 | +| 4.3.2.3 Attribute constraints..... | 20 | +| 4.3.2.4 Notifications..... | 20 | +| 4.3.3 EUtranGenericCell ..... | 20 | +| 4.3.3.1 Definition ..... | 20 | +| 4.3.3.2 Attributes ..... | 21 | +| 4.3.3.3 Attribute constraints..... | 22 | +| 4.3.3.4 Notifications..... | 22 | +| 4.3.4 ExternalEUtranGenericCell ..... | 22 | +| 4.3.4.1 Definition ..... | 22 | +| 4.3.4.2 Attributes ..... | 22 | +| 4.3.4.3 Attribute constraints..... | 23 | +| 4.3.4.4 Notifications..... | 23 | +| 4.3.5 EUtranCellFDD..... | 23 | +| 4.3.5.1 Definition ..... | 23 | +| 4.3.5.2 Attributes ..... | 23 | +| 4.3.5.3 Attribute constraints..... | 23 | +| 4.3.5.4 Notifications..... | 23 | +| 4.3.6 ExternalEUtranCellFDD..... | 23 | +| 4.3.6.1 Definition ..... | 23 | +| 4.3.6.2 Attributes ..... | 23 | +| 4.3.6.3 Attribute constraints..... | 23 | +| 4.3.6.4 Notifications..... | 23 | +| 4.3.7 EUtranCellTDD..... | 24 | +| 4.3.7.1 Definition ..... | 24 | +| 4.3.7.2 Attributes ..... | 24 | +| 4.3.7.3 Attribute constraints..... | 24 | +| 4.3.7.4 Notifications..... | 24 | +| 4.3.8 ExternalEUtranCellTDD..... | 24 | +| 4.3.8.1 Definition ..... | 24 | +| 4.3.8.3 Attribute constraints..... | 24 | +| 4.3.8.4 Notifications..... | 24 | +| 4.3.9 EUtranRelation..... | 24 | + +| | | | +|----------|----------------------------------------|----| +| 4.3.9.1 | Definition ..... | 24 | +| 4.3.9.2 | Attributes ..... | 25 | +| 4.3.9.3 | Attribute constraints..... | 25 | +| 4.3.9.4 | Notifications..... | 25 | +| 4.3.10 | Link_ENB_ENB ..... | 25 | +| 4.3.10.1 | Definition ..... | 25 | +| 4.3.10.2 | Attributes ..... | 25 | +| 4.3.10.3 | Attribute constraints..... | 25 | +| 4.3.10.4 | Notifications..... | 25 | +| 4.3.11 | Cdma2000Relation..... | 26 | +| 4.3.11.1 | Definition ..... | 26 | +| 4.3.11.2 | Attributes ..... | 26 | +| 4.3.11.3 | Attribute constraints..... | 26 | +| 4.3.11.4 | Notifications..... | 26 | +| 4.3.12 | MCEFunction..... | 26 | +| 4.3.12.1 | Definition ..... | 26 | +| 4.3.12.2 | Attributes ..... | 26 | +| 4.3.12.3 | Attribute constraints..... | 26 | +| 4.3.12.4 | Notifications..... | 26 | +| 4.3.13 | MBSFNArea..... | 26 | +| 4.3.13.1 | Definition ..... | 26 | +| 4.3.13.2 | Attributes ..... | 27 | +| 4.3.13.3 | Attribute constraints..... | 27 | +| 4.3.13.4 | Notifications..... | 27 | +| 4.3.14 | Link_MCE_ENB ..... | 27 | +| 4.3.14.1 | Definition ..... | 27 | +| 4.3.14.2 | Attributes ..... | 27 | +| 4.3.14.3 | Attribute constraints..... | 27 | +| 4.3.14.4 | Notifications..... | 27 | +| 4.3.15 | Link_MCE_MME ..... | 27 | +| 4.3.15.1 | Definition ..... | 27 | +| 4.3.15.2 | Attributes ..... | 27 | +| 4.3.15.3 | Attribute constraints..... | 27 | +| 4.3.15.4 | Notifications..... | 27 | +| 4.3.16 | RNFunction ..... | 28 | +| 4.3.16.1 | Definition ..... | 28 | +| 4.3.16.2 | Attributes ..... | 28 | +| 4.3.16.3 | Attribute constraints..... | 28 | +| 4.3.16.4 | Notifications..... | 28 | +| 4.3.17 | ExternalRNFunction..... | 28 | +| 4.3.17.1 | Definition ..... | 28 | +| 4.3.17.2 | Attributes ..... | 28 | +| 4.3.17.3 | Attribute constraints..... | 28 | +| 4.3.17.4 | Notifications..... | 28 | +| 4.3.18 | DeNBCapability..... | 28 | +| 4.3.18.1 | Definition ..... | 28 | +| 4.3.18.2 | Attributes ..... | 29 | +| 4.3.18.3 | Attribute constraints..... | 29 | +| 4.3.18.4 | Notifications..... | 29 | +| 4.3.19 | CellOutageCompensationInformation..... | 29 | +| 4.3.19.1 | Definition ..... | 29 | +| 4.3.19.2 | Attributes ..... | 29 | +| 4.3.19.3 | Attribute constraints..... | 29 | +| 4.3.19.4 | Notifications..... | 29 | +| 4.3.20 | QciDscpMapping..... | 29 | +| 4.3.20.1 | Definition ..... | 29 | +| 4.3.20.2 | Attributes ..... | 29 | +| 4.3.20.3 | Attribute constraints..... | 29 | +| 4.3.20.4 | Notifications..... | 30 | +| 4.3.21 | EUtranCellNMCentralizedSON..... | 30 | +| 4.3.21.1 | Definition ..... | 30 | + +| | | | +|-------------------------------|-------------------------------------------------------------|-----------| +| 4.3.21.2 | Attributes ..... | 31 | +| 4.3.21.3 | Attribute constraints..... | 32 | +| 4.3.21.4 | Notifications..... | 32 | +| 4.3.22 | WTFunction ..... | 32 | +| 4.3.22.1 | Definition ..... | 32 | +| 4.3.22.2 | Attributes ..... | 32 | +| 4.3.22.3 | Attribute constraints..... | 32 | +| 4.3.22.4 | Notifications..... | 32 | +| 4.3.23 | EP_Xw ..... | 32 | +| 4.3.23.1 | Definition ..... | 32 | +| 4.3.23.2 | Attributes ..... | 32 | +| 4.3.23.3 | Attribute constraints..... | 32 | +| 4.3.23.4 | Notifications..... | 32 | +| 4.3.24 | WLANMobilitySet ..... | 33 | +| 4.3.24.1 | Definition ..... | 33 | +| 4.3.24.2 | Attributes ..... | 33 | +| 4.3.24.3 | Attribute constraints..... | 33 | +| 4.3.24.4 | Notifications..... | 33 | +| 4.3.25 | MemberWLAN <<datatype>>..... | 33 | +| 4.3.25.1 | Definition ..... | 33 | +| 4.3.25.2 | Attributes ..... | 33 | +| 4.3.25.3 | Attribute constraints..... | 33 | +| 4.3.25.4 | Notifications..... | 33 | +| 4.3.26 | PLMNId <<datatype>> ..... | 33 | +| 4.3.26.1 | Definition ..... | 33 | +| 4.3.26.2 | Attributes ..... | 34 | +| 4.3.26.3 | Attribute constraints..... | 34 | +| 4.3.26.4 | Notifications..... | 34 | +| 4.3.27 | EUTranFreqRelation ..... | 34 | +| 4.3.27.1 | Definition ..... | 34 | +| 4.3.27.2 | Attributes ..... | 34 | +| 4.3.27.3 | Attribute constraints..... | 34 | +| 4.3.27.4 | Notifications..... | 34 | +| 4.3.28 | EUTranFrequency ..... | 35 | +| 4.3.28.1 | Definition ..... | 35 | +| 4.3.28.2 | Attributes ..... | 35 | +| 4.3.28.3 | Attribute constraints..... | 35 | +| 4.3.28.4 | Notifications..... | 35 | +| 4.4 | Attribute definitions ..... | 36 | +| 4.4.1 | Attribute properties..... | 36 | +| 4.4.2 | Constraints ..... | 56 | +| 4.5 | Common notifications ..... | 57 | +| 4.5.1 | Alarm notifications ..... | 57 | +| 4.5.2 | Configuration notifications..... | 57 | +| <b>Annex A (informative):</b> | <b>Notifications during a Cell Outage Compensation.....</b> | <b>58</b> | +| Annex B (informative): | Change history..... | 62 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- TS 28.657 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- TS 28.658 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)** +- TS 28.659 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document specifies the E-UTRAN network resource information that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +The E-UTRAN NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the protocol neutral E-UTRAN NRM IRP: Information Service (IS). It reuses relevant parts of the Generic NRM IRP: IS in 3GPP TS 28.622 [6], either by direct reuse or sub-classing, and in addition to that defines E-UTRAN specific Information Object Classes. + +In order to access the information defined by this NRM, an Interface IRP such as the "Basic CM IRP" is needed (3GPP TS 32.602 [7]). However, which Interface IRP is applicable is outside the scope of the present document. + +The present document also specifies the ng-eNB network resource information that can be communicated among NG-RAN management system, including management of MR-DC operations which ng-eNB is involved in. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [5] 3GPP TS 28.628: "Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP) Information Service (IS)". +- [8] 3GPP TS 36.321: "Universal Terrestrial Access Network (UTRAN); Medium Access Control (MAC) protocol specification". +- [9] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [10] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA) Radio Resource Control (RRC); Protocol specification". + +- [11] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [12] 3GPP TS 36.211: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical Channels and Modulation" +- [13] 3GPP TS 36.101: "Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) radio transmission and reception" +- [14] 3GPP TS 36.104: "Evolved Universal Terrestrial Radio Access (E\_UTRA); Base Station (BS) radio transmission and reception" +- [15] 3GPP TS 32.500: "Telecommunication Management; Self-Organizing Networks (SON); Concepts and requirements" +- [16] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions" +- [17] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications" +- [18] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)" +- [19] 3GPP TS 23.002: "Network Architecture" +- [20] 3GPP TS 32.652: "Telecommunication management; Configuration Management (CM); GERAN network resources Integration Reference Point (IRP); Network Resource Model (NRM)" +- [21] 3GPP TS 28.652: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" +- [22] 3GPP2 S.S0028-D "OAM&P for cdma2000 (Overview, 3GPP R7 Delta Specification, 3GPP2 Network Resource Model IRP)" +- [23] 3GPP TS 28.708: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)" +- [24] 3GPP TS 36.423: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); X2 application protocol (X2AP)". +- [25] 3GPP TS 36.213: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical layer procedures". +- [26] 3GPP TS 28.625: "Telecommunication management; State Management Data Definition Integration Reference Point (IRP); Information Service (IS)". +- [27] 3GPP TS 36.413: "Evolved Universal Terrestrial Access Network (E-UTRAN); S1 Application Protocol (SIAP)". +- [28] 3GPP TS 36.443: "Evolved Universal Terrestrial Access Network (E-UTRAN); M2 Application Protocol (M2AP)". +- [29] 3GPP TS 22.011: "Service accessibility". +- [30] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [31] 3GPP TS 28.662: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [32] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM; Information service (IS)". +- [33] 3GPP TS 23.203: "Policy and charging control architecture". + +- [34] 3GPP TS 23.207: "End-to-end Quality of Service (QoS) concept and architecture". +- [35] RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [36] 3GPP TS 45.008: "Technical Specification Group GSM/EDGE Radio Access Network; Radio subsystem link control". +- [37] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [38] 3GPP TS 36.133: "Universal Terrestrial Access Network (UTRAN); Requirements for support of radio resource management". +- [39] 3GPP TS 28.657: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [40] 3GPP TS 28.541: "Management and orchestration of 5G networks Network Resource Model (NRM); Stage 2 and stage 3". +- [41] 3GPP TS 38.300: "NR; Overall description; Stage-2". +- [42] 3GPP TS 23.501: "System Architecture for the 5G System". +- [43] 3GPP TS 36.463: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN) and Wireless LAN (WLAN); Xw application protocol (XwAP)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TS 32.150 [16], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [17] and the following apply. + +**Association:** See definition in TS 28.622 [6]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +**eNodeB:** A logical node responsible for radio transmission/reception in one or more cells to/from the User Equipment. It terminates the S1 interface towards the EPC. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TS 32.150 [16], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [17] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TS 28.657 [39], TS 32.150 [16], TS 32.101 [1], TS 32.102 [2] and TS 21.905 [17], in that order. + +| | | +|---------|-----------------------------------------------------------------| +| DeNB | Donor eNodeB | +| DN | Distinguished Name (see 3GPP TS 32.300 [4]) | +| E-UTRA | Evolved Universal Terrestrial Radio Access | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| MBSFN | Multimedia Broadcast multicast service Single Frequency Network | +| NCR | Neighbour Cell Relation | +| PM | Performance Management | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [4]) | +| RN | Relay Node | + +# 4 Model + +## 4.1 Imported and associated information + +### 4.1.1 Imported information entities and local labels + +| Label reference | Local label | +|------------------------------------------------------------|----------------------------| +| 3GPP TS 28.625 [26], attribute, administrativeState | administrativeState | +| 3GPP TS 28.625 [26], attribute, availabilityStatus | availabilityStatus | +| 3GPP TS 28.625 [26], attribute, operationalState | operationalState | +| 3GPP TS 28.622 [6], IOC, ManagedFunction | ManagedFunction | +| 3GPP TS 28.622 [6], IOC, Link | Link | +| 3GPP TS 28.708 [23], IOC, MMEFunction | MMEFunction | +| 3GPP TS 28.708 [23], IOC, ExternalMMEFunction | ExternalMMEFunction | +| 3GPP TS 28.708 [23], IOC, ServingGwFunction | ServingGwFunction | +| 3GPP TS 28.708 [23], IOC, ServingGwCFunction | ServingGwCFunction | +| 3GPP TS 28.708 [23], IOC, ExternalServingGwCFunction | ExternalServingGwCFunction | +| 3GPP TS 28.652 [21], IOC, UtranRelation | UtranRelation | +| 3GPP TS 28.662 [31], IOC, AntennaFunction | AntennaFunction | +| 3GPP TS 28.662 [31], IOC, TmaFunction | TmaFunction | +| 3GPP TS 32.652 [20], IOC, GsmRelation | GsmRelation | +| 3GPP2 TS S.S0028 [22], IOC, ExternalSector | ExternalSector | +| 3GPP TS 28.708 [23], IOC, EP_RP_EPS | EP_RP_EPS | +| 3GPP TS 28.708 [23], IOC, QCISet | QCISet | +| 3GPP TS 28.662 [31], IOC, SectorEquipmentFunction | SectorEquipmentFunction | +| 3GPP TS 28.628 [5], IOC, EnergySavingProperties | EnergySavingProperties | +| 3GPP TS 28.541 [40], IOC, EP_X2C | EP_X2C | +| 3GPP TS 28.541 [40], IOC, EP_X2U | EP_X2U | +| 3GPP TS 28.541 [40], IOC, EP_XnC | EP_XnC | +| 3GPP TS 28.541 [40], IOC, EP_XnU | EP_XnU | +| 3GPP TS 28.541 [40], IOC, EP_NgC | EP_NgC | +| 3GPP TS 28.541 [40], IOC, EP_NgU | EP_NgU | +| 3GPP TS 28.541 [40], IOC, AMFFunction | AMFFunction | +| 3GPP TS 28.541 [40], IOC, UPFFunction | UPFFunction | +| 3GPP TS 28.541 [40], IOC, GNBCUCPFunction | GNBCUCPFunction | +| 3GPP TS 28.541 [40], IOC, GNBCUUPFunction | GNBCUUPFunction | +| 3GPP TS 28.541 [40], attribute, sNSSAIList | sNSSAIList | +| 3GPP TS 28.622 [6], IOC, EP_RP | EP_RP | +| 3GPP TS 28.541 [40], IOC, NRCellRelation | NRCellRelation | +| 3GPP TS 28.541 [40], IOC, NRReqRelation | NRFreqRelation | +| 3GPP TS 28.541 [40], IOC, NRFrequency | NRFrequency | +| 3GPP TS 28.541 [40], IOC, NRNetwork | NRNetwork | +| 3GPP TS 28.541 [40], IOC, EUtranNetwork | EUtranNetwork | +| 3GPP TS 28.541 [40], attribute, cellIndividualOffset | cellIndividualOffset | +| 3GPP TS 28.541 [40], attribute, blackListEntry | blackListEntry | +| 3GPP TS 28.541 [40], attribute, blackListEntryIdleMode | blackListEntryIdleMode | +| 3GPP TS 28.541 [40], attribute, cellReselectionPriority | cellReselectionPriority | +| 3GPP TS 28.541 [40], attribute, cellReselectionSubPriority | cellReselectionSubPriority | +| 3GPP TS 28.541 [40], attribute, pMax | pMax | +| 3GPP TS 28.541 [40], attribute, qOffsetFreq | qOffsetFreq | +| 3GPP TS 28.541 [40], attribute, qQualMin | qQualMin | +| 3GPP TS 28.541 [40], attribute, qRxLevMin | qRxLevMin | +| 3GPP TS 28.541 [40], attribute, threshXHighP | threshXHighP | +| 3GPP TS 28.541 [40], attribute, threshXHighQ | threshXHighQ | +| 3GPP TS 28.541 [40], attribute, threshXLowP | threshXLowP | +| 3GPP TS 28.541 [40], attribute, threshXLowQ | threshXLowQ | +| 3GPP TS 28.541 [40], attribute, tReselectionEutraSfHigh | tReselectionEutraSfHigh | +| 3GPP TS 28.541 [40], attribute, tReselectionEutraSfMedium | tReselectionEutraSfMedium | + +### 4.1.2 Associated information entities and local labels + +| Label reference | Local label | +|-----------------------------------------|----------------| +| 3GPP TS 28.622 [6], IOC, Top | Top | +| 3GPP TS 28.622 [6], IOC, ManagedElement | ManagedElement | +| 3GPP TS 28.622 [6], IOC, SubNetwork | SubNetwork | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides the overview of the relationships of relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +![Figure 4.2.1-1: Cell relation view. This UML class diagram shows the relationships between various Information Object Classes (IOCs) related to cell management. At the top, 'InformationObjectClass' (MMEFunction) and 'InformationObjectClass' (ManagedElement) are shown. 'MMEFunction' has a relationship with 'InformationObjectClass' (Link_MCE_END) via an 'M3 ref point'. 'ManagedElement' has a relationship with 'InformationObjectClass' (ENBFunction) via an 'M2 ref point'. 'ENBFunction' is associated with 'InformationObjectClass' (EUTranGenericCell) via a 'CellIdList'. 'EUTranGenericCell' is the central class, which has relationships with 'InformationObjectClass' (CellOutageCompensationInformation), 'InformationObjectClass' (EnergySavingProperties), and 'InformationObjectClass' (EUTranCellINMCentralizedSON) via '«names»' associations.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +Figure 4.2.1-1: Cell relation view. This UML class diagram shows the relationships between various Information Object Classes (IOCs) related to cell management. At the top, 'InformationObjectClass' (MMEFunction) and 'InformationObjectClass' (ManagedElement) are shown. 'MMEFunction' has a relationship with 'InformationObjectClass' (Link\_MCE\_END) via an 'M3 ref point'. 'ManagedElement' has a relationship with 'InformationObjectClass' (ENBFunction) via an 'M2 ref point'. 'ENBFunction' is associated with 'InformationObjectClass' (EUTranGenericCell) via a 'CellIdList'. 'EUTranGenericCell' is the central class, which has relationships with 'InformationObjectClass' (CellOutageCompensationInformation), 'InformationObjectClass' (EnergySavingProperties), and 'InformationObjectClass' (EUTranCellINMCentralizedSON) via '«names»' associations. + +Figure 4.2.1-1: Cell relation view + +![Figure 4.2.1.1-1a: Cell and frequency relation view. This UML class diagram shows the relationships between various Information Object Classes (IOCs) related to cell and frequency management. At the top, 'InformationObjectClass' (ENBFunction) is shown. Below it, 'InformationObjectClass' (EUTranGenericCell) is the central class, which has relationships with 'InformationObjectClass' (EUTranRelation), 'InformationObjectClass' (NRCellRelation), 'InformationObjectClass' (EUTranFreqRelation), 'InformationObjectClass' (NRFreqRelation), 'InformationObjectClass' (EUTranFrequency), and 'InformationObjectClass' (NRFrequency) via '«names»' associations. 'EUTranRelation' and 'NRCellRelation' are associated with 'ProxyClass' (AdjacentCell) and 'ProxyClass' (AdjacentNRCell) respectively. 'EUTranFreqRelation' and 'NRFreqRelation' are associated with 'InformationObjectClass' (EUTranFrequency) and 'InformationObjectClass' (NRFrequency) respectively. 'SubNetwork' is shown at the top right, with relationships to 'InformationObjectClass' (ExternalENBFunction), 'InformationObjectClass' (ExternalGNBCUPFunction), 'InformationObjectClass' (ExternalEUTranCell), and 'InformationObjectClass' (ExternalNRCellCU). Notes indicate that 'AdjacentCell' represents ExternalEUTranCellTDD/FDD or EUTranCellTDD/FDD, and 'AdjacentNRCell' represents NRCellCU or ExternalNRCellCU.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +Figure 4.2.1.1-1a: Cell and frequency relation view. This UML class diagram shows the relationships between various Information Object Classes (IOCs) related to cell and frequency management. At the top, 'InformationObjectClass' (ENBFunction) is shown. Below it, 'InformationObjectClass' (EUTranGenericCell) is the central class, which has relationships with 'InformationObjectClass' (EUTranRelation), 'InformationObjectClass' (NRCellRelation), 'InformationObjectClass' (EUTranFreqRelation), 'InformationObjectClass' (NRFreqRelation), 'InformationObjectClass' (EUTranFrequency), and 'InformationObjectClass' (NRFrequency) via '«names»' associations. 'EUTranRelation' and 'NRCellRelation' are associated with 'ProxyClass' (AdjacentCell) and 'ProxyClass' (AdjacentNRCell) respectively. 'EUTranFreqRelation' and 'NRFreqRelation' are associated with 'InformationObjectClass' (EUTranFrequency) and 'InformationObjectClass' (NRFrequency) respectively. 'SubNetwork' is shown at the top right, with relationships to 'InformationObjectClass' (ExternalENBFunction), 'InformationObjectClass' (ExternalGNBCUPFunction), 'InformationObjectClass' (ExternalEUTranCell), and 'InformationObjectClass' (ExternalNRCellCU). Notes indicate that 'AdjacentCell' represents ExternalEUTranCellTDD/FDD or EUTranCellTDD/FDD, and 'AdjacentNRCell' represents NRCellCU or ExternalNRCellCU. + +Figure 4.2.1.1-1a: Cell and frequency relation view + +NOTE A: The above NRM fragment uses `SubNetwork` to hold both NR and LTE external entities and frequencies. + +![UML Class Diagram: Cell and frequency relation view](1439cb942d9e363bbb3161b5540dd8c6_img.jpg) + +``` + +classDiagram + class ENBFunction["«InformationObjectClass» +ENBFunction"] + class EUTranGenericCell["«InformationObjectClass» +EUTranGenericCell"] + class EUTranFreqRelation["«InformationObjectClass» +EUTranFreqRelation"] + class EUTranFrequency["«InformationObjectClass» +EUTranFrequency"] + class NRCellRelation["«InformationObjectClass» +NRCellRelation"] + class NRFreqRelation["«InformationObjectClass» +NRFreqRelation"] + class NRFrequency["«InformationObjectClass» +NRFrequency"] + class AdjacentCell["«ProxyClass» +AdjacentCell"] + class AdjacentNRCell["«ProxyClass» +AdjacentNRCell"] + class EUTranNetwork["«InformationObjectClass» +EUTranNetwork"] + class ExternalENBFunction["«InformationObjectClass» +ExternalENBFunction"] + class ExternalEUTranCell["«InformationObjectClass» +ExternalEUTranCell"] + class NRNetwork["«InformationObjectClass» +NRNetwork"] + class ExternalGNBCUPFunction["«InformationObjectClass» +ExternalGNBCUPFunction"] + class ExternalNRCellCU["«InformationObjectClass» +ExternalNRCellCU"] + + ENBFunction "1" *-- "*" EUTranGenericCell : <<names>> + EUTranGenericCell "1" *-- "*" EUTranFreqRelation : <<names>> + EUTranFreqRelation "1" -- "1" EUTranFrequency + EUTranGenericCell "1" *-- "*" NRCellRelation : <<names>> + EUTranGenericCell "1" *-- "*" NRFreqRelation : <<names>> + NRCellRelation "1" -- "1" AdjacentCell + NRFreqRelation "1" -- "1" NRFrequency + EUTranNetwork "1" *-- "*" ExternalENBFunction : <<names>> + ExternalENBFunction "1" *-- "*" ExternalEUTranCell : <<names>> + EUTranFrequency "1" -- "1..*" ExternalEUTranCell + NRNetwork "1" *-- "*" ExternalGNBCUPFunction : <<names>> + ExternalGNBCUPFunction "1" *-- "*" ExternalNRCellCU : <<names>> + NRFrequency "1" -- "1..*" ExternalNRCellCU + AdjacentNRCell "1" -- "*" EUTranGenericCell + +``` + +*It represents ExternalEUTranCellTDD/FDD or EUtranCellTDD/FDD.* (Note for AdjacentCell) + +*It represents NRCellCU or ExternalNRCellCU.* (Note for AdjacentNRCell) + +UML Class Diagram: Cell and frequency relation view + +**Figure 4.2.1.1-1b: Cell and frequency relation view** + +NOTE B: The above NRM fragment uses `NRNetwork` to hold NR external entities and frequency and using `EUtranNetwork` to hold LTE external entities and frequency. The `NRNetwork` and `EUtranNetwork` are subclasses of `SubNetwork` (defined in TS 28.622[6]) with no additional attributes. The reason using `NRNetwork` and `EUtranNetwork` is for a clean separation of NR external entities and frequency and LTE external entities and frequency. + +![UML Class Diagram: Inheritance view of ManagedFunctions](853f59c89931a666c07903b31d098277_img.jpg) + +``` + +classDiagram + class ManagedFunction["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + class QciDescpMapping["«InformationObjectClass» +QciDescpMapping"] + class DeNBCapability["«InformationObjectClass» +DeNBCapability"] + class EUtranGenericCell["«InformationObjectClass» +EUtranGenericCell"] + class ServingCell["«ProxyClass» +ServingCell"] + class EUtranCellFDD["«InformationObjectClass» +EUtranCellFDD"] + class EUtranCellTDD["«InformationObjectClass» +EUtranCellTDD"] + class ExternalEUtranCellFDD["«InformationObjectClass» +ExternalEUtranCellFDD"] + class ExternalEUtranCellTDD["«InformationObjectClass» +ExternalEUtranCellTDD"] + class MCEFunction["«InformationObjectClass» +MCEFunction"] + class ENBFunction["«InformationObjectClass» +ENBFunction"] + class ExternalENBFunction["«InformationObjectClass» +ExternalENBFunction"] + class RNFunction["«InformationObjectClass» +RNFunction"] + class ExternalRNFunction["«InformationObjectClass» +ExternalRNFunction"] + + ManagedFunction <|-- QciDescpMapping + ManagedFunction <|-- DeNBCapability + ManagedFunction <|-- EUtranGenericCell + ManagedFunction <|-- ServingCell + EUtranGenericCell <|-- EUtranCellFDD + EUtranGenericCell <|-- EUtranCellTDD + ServingCell <|-- ExternalEUtranCellFDD + ServingCell <|-- ExternalEUtranCellTDD + ManagedFunction <|-- MCEFunction + ManagedFunction <|-- ENBFunction + ManagedFunction <|-- ExternalENBFunction + ENBFunction <|-- RNFunction + ExternalENBFunction <|-- ExternalRNFunction + +``` + +UML Class Diagram: Inheritance view of ManagedFunctions + +NOTE 1: If an instance of the *ServesRN* association is present, then a corresponding instance of *ServedByEGC* must be present. In this case, the `ENBFunction` and `RNFunction` instances are under the management scope of the same IRPAgent. + +If an instance of the *ServesExtRN* association is present, then a corresponding instance of *ServedByExtEGC* must be present. In this case, the *ENBFunction* and *RNFunction* instances are under the management scope of two different IRPAgents. + +NOTE 2: The modelling of the DeNB capability as a separate IOC or as attributes of `ENBFunction` is FFS + +Figure 4.2.1-2: E-UTRAN relaying view of E-UTRAN and ng-eNB NRM + +![UML Class diagram showing ENBFunction and its associations with various InformationObjectClasses and ProxyClasses.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +The diagram illustrates the E-UTRAN relaying view of E-UTRAN and ng-eNB NRM. It features a central class **ENBFunction** («InformationObjectClass») which has associations with seven other classes, each labeled with «Name» and multiplicity «\*». + +- ENBFunction** is associated with **EP\_RP\_EPS** («InformationObjectClass»), which in turn is associated with **FarEnd\_EPS1** («ProxyClass»). A note indicates that **FarEnd\_EPS1** represents MMEFunction (TS 28.708) or ExternalMMEFunction (TS 28.708) or ServingGwFunction or ServingGwCFunction or ExternalServingGwFunction or ExternalServingGwCFunction (TS 28.708) or RNFunction or ExternalRNFunction. +- ENBFunction** is associated with **EP\_X2C** («InformationObjectClass»), which is associated with **FarEnd\_X2C** («ProxyClass»). A note indicates that **FarEnd\_X2C** represents ENBFunction or ExternalENBFunction or GNBCUCPFunction (TS 28.541). +- ENBFunction** is associated with **EP\_X2U** («InformationObjectClass»), which is associated with **FarEnd\_X2U** («ProxyClass»). A note indicates that **FarEnd\_X2U** represents ENBFunction or ExternalENBFunction or GNBCUUPFunction (TS 28.541). +- ENBFunction** is associated with **EP\_NgC** («InformationObjectClass»), which is associated with **AMFFunction** («InformationObjectClass»). +- ENBFunction** is associated with **EP\_NgU** («InformationObjectClass»), which is associated with **UPPFunction** («InformationObjectClass»). +- ENBFunction** is associated with **EP\_XnC** («InformationObjectClass»), which is associated with **FarEnd\_XnC** («ProxyClass»). A note indicates that **FarEnd\_XnC** represents ENBFunction or ExternalENBFunction or GNBCUCPFunction (TS 28.541). +- ENBFunction** is associated with **EP\_XnU** («InformationObjectClass»), which is associated with **FarEnd\_XnU** («ProxyClass»). A note indicates that **FarEnd\_XnU** represents ENBFunction or ExternalENBFunction or GNBCUUPFunction (TS 28.541). + +Each association between an InformationObjectClass and a ProxyClass or InformationObjectClass is labeled with multiplicity «1» at both ends. + +UML Class diagram showing ENBFunction and its associations with various InformationObjectClasses and ProxyClasses. + +Figure 4.2.1-3: Transport view of E-UTRAN and ng-eNB NRM + +![UML Class Diagram showing the MBMS view of E-UTRAN NRM 1, illustrating relationships between MMEFunction, ManagedElement, MCEFunction, ENBFunction, and related link and cell classes.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +classDiagram + class MMEFunction { + <<InformationObjectClass>> + (from 32.752) + } + class ManagedElement { + <<InformationObjectClass>> + (from 28.622) + } + class Link_MCE_MME { + <<InformationObjectClass>> + } + class MCEFunction { + <<InformationObjectClass>> + } + class ENBFunction { + <<InformationObjectClass>> + } + class Link_MCE_ENB { + <<InformationObjectClass>> + } + class MBSFNArea { + <<InformationObjectClass>> + } + class EUtranGenericCell { + <<InformationObjectClass>> + } + + ManagedElement "1" *-- "*" MCEFunction : <<names>> + ManagedElement "1" *-- "*" ENBFunction : <<names>> + MCEFunction "1" *-- "*" MBSFNArea : <<names>> + ENBFunction "1" *-- "*" EUtranGenericCell : <<names>> + MMEFunction "*" -- "*" MCEFunction + MBSFNArea "*" --> "*" EUtranGenericCell : + CellIdList + + Link_MCE_MME .. MMEFunction + Link_MCE_MME .. MCEFunction + Link_MCE_ENB .. MCEFunction + Link_MCE_ENB .. ENBFunction + +``` + +The diagram shows the containment and association relationships for MBMS in E-UTRAN NRM. **ManagedElement** contains multiple **MCEFunction** and **ENBFunction** instances via composition (indicated by the diamond and «names» stereotype). **MCEFunction** further contains **MBSFNArea**, and **ENBFunction** contains **EUtranGenericCell**. There is a directed association from **MBSFNArea** to **EUtranGenericCell** labeled "+ CellIdList". Reference points are indicated by dashed lines: **Link\_MCE\_MME** (M3 ref point) connects **MMEFunction** and **MCEFunction**, while **Link\_MCE\_ENB** (M2 ref point) connects **MCEFunction** and **ENBFunction**. + +UML Class Diagram showing the MBMS view of E-UTRAN NRM 1, illustrating relationships between MMEFunction, ManagedElement, MCEFunction, ENBFunction, and related link and cell classes. + +**Figure 4.2.1-4: MBMS view of E-UTRAN NRM 1** + +NOTE 1: This is E-UTRAN NRM containment/relationship Figure form view of MBMS when MCE and ENB belong to one Network Element. + +![UML Class Diagram showing MBMS view of E-UTRAN NRM 2. Classes include MMFunction, ManagedElement, Link_MCE_MME, MCEFunction, ENBFunction, Link_MCE_ENB, MBSTNArea, and EUtranGenericCell. Relationships include containment and association with multiplicities and reference points M2 and M3.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +The diagram illustrates the MBMS view of E-UTRAN NRM 2. It features several Information Object Classes (IOCs) and their relationships: + +- MMFunction** (from 32.752) is associated with **MCEFunction** (multiplicity \*). +- ManagedElement** (from 28.622) contains **MCEFunction** (multiplicity 1) and **ENBFunction** (multiplicity 1). The associations are labeled «names». +- Link\_MCE\_MME** is associated with **MCEFunction** (multiplicity \*). A note indicates this is the **M3 ref point**. +- MCEFunction** contains **Link\_MCE\_ENB** (multiplicity 1) and **MBSTNArea** (multiplicity 1). The association with **Link\_MCE\_ENB** is labeled «names» and is identified as the **M2 ref point**. +- ENBFunction** contains **Link\_MCE\_ENB** (multiplicity 1) and **EUtranGenericCell** (multiplicity 1). The association with **Link\_MCE\_ENB** is labeled «names». +- MBSTNArea** is associated with **EUtranGenericCell** (multiplicity \*). + ++ CellIdList + +UML Class Diagram showing MBMS view of E-UTRAN NRM 2. Classes include MMFunction, ManagedElement, Link\_MCE\_MME, MCEFunction, ENBFunction, Link\_MCE\_ENB, MBSTNArea, and EUtranGenericCell. Relationships include containment and association with multiplicities and reference points M2 and M3. + +Figure 4.2.1-5: MBMS view of E-UTRAN NRM 2 + +NOTE 2: This is E-UTRAN NRM containment/relationship Figure form view of MBMS when MCE and ENB belong to different Network Elements. + +![UML Class Diagram showing SON related Attributes NRM IOCs (Containment Relationship). Classes include EUtranGenericCell, CellOutageCompensationInformation, EnergySavingProperties (from 32.522), and EUtranCellNMCentralizedSON. Relationships show containment with multiplicities and «names» labels.](9ae17964ddd9b814c7d905b1af2fddf2_img.jpg) + +The diagram illustrates the SON related Attributes NRM IOCs (Containment Relationship). It features the following Information Object Classes (IOCs) and their relationships: + +- EUtranGenericCell** contains **CellOutageCompensationInformation** (multiplicity 1), **EnergySavingProperties** (from 32.522) (multiplicity 1), and **EUtranCellNMCentralizedSON** (multiplicity 1). The associations are labeled «names». +- CellOutageCompensationInformation** is associated with **EUtranGenericCell** (multiplicity 0..1). +- EnergySavingProperties** (from 32.522) is associated with **EUtranGenericCell** (multiplicity 0..1). +- EUtranCellNMCentralizedSON** is associated with **EUtranGenericCell** (multiplicity 0..1). + +UML Class Diagram showing SON related Attributes NRM IOCs (Containment Relationship). Classes include EUtranGenericCell, CellOutageCompensationInformation, EnergySavingProperties (from 32.522), and EUtranCellNMCentralizedSON. Relationships show containment with multiplicities and «names» labels. + +Figure 4.2.1-6: SON related Attributes NRM IOCs (Containment Relationship) + +![UML Class Diagram showing two parallel relationships. The top relationship consists of <<InformationObjectClass>> WTFunction (1) --> <<InformationObjectClass>> EP_Xw (*) via association <<names>>, which then points (1) to <<ProxyClass>> FarEnd_Xw1. A note indicates this proxy class represents ENBFunction or ExternalENBFunction. The bottom relationship is identical but uses ENBFunction, EP_Xw, and FarEnd_Xw2, with a note indicating it represents WTFunction.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +classDiagram + class WTFunction["<<InformationObjectClass>> WTFunction"] + class EP_Xw1["<<InformationObjectClass>> EP_Xw"] + class FarEnd_Xw1["<<ProxyClass>> FarEnd_Xw1"] + class ENBFunction["<<InformationObjectClass>> ENBFunction"] + class EP_Xw2["<<InformationObjectClass>> EP_Xw"] + class FarEnd_Xw2["<<ProxyClass>> FarEnd_Xw2"] + + WTFunction "1" *-- "*" EP_Xw1 : <<names>> + EP_Xw1 "1" --> "1" FarEnd_Xw1 + ENBFunction "1" *-- "*" EP_Xw2 : <<names>> + EP_Xw2 "1" --> "1" FarEnd_Xw2 +``` + +UML Class Diagram showing two parallel relationships. The top relationship consists of <> WTFunction (1) --> <> EP\_Xw (\*) via association <>, which then points (1) to <> FarEnd\_Xw1. A note indicates this proxy class represents ENBFunction or ExternalENBFunction. The bottom relationship is identical but uses ENBFunction, EP\_Xw, and FarEnd\_Xw2, with a note indicating it represents WTFunction. + +Figure 4.2.1- + +7: Non-collocated LWA NRM + +![UML Class Diagram showing a hierarchy. <<InformationObjectClass>> ENBFunction (1) --> <<InformationObjectClass>> WLANMobilitySet (*) via association <<names>>. <<InformationObjectClass>> WLANMobilitySet (1) --> <<datatype>> MemberWlan (*) via association <<names>>.](41a438d7e4adc17c3a4005e7c9500091_img.jpg) + +``` +classDiagram + class ENBFunction["<<InformationObjectClass>> ENBFunction"] + class WLANMobilitySet["<<InformationObjectClass>> WLANMobilitySet"] + class MemberWlan["<<datatype>> MemberWlan"] + + ENBFunction "1" *-- "*" WLANMobilitySet : <<names>> + WLANMobilitySet "1" --> "*" MemberWlan : <<names>> +``` + +UML Class Diagram showing a hierarchy. <> ENBFunction (1) --> <> WLANMobilitySet (\*) via association <>. <> WLANMobilitySet (1) --> <> MemberWlan (\*) via association <>. + +Figure 4.2.1-8: WLAN Mobility Set NRM for LWA and LWIP + +### 4.2.2 Inheritance + +![UML Class Diagram showing inheritance for InformationObjectClass. The diagram is divided into three sections. The top section shows ManagedFunction (from 28.622) as a base class for EUTranGenericCell, ENBFunction, ExternalENBFunction, and ServingCell. EUTranGenericCell is further specialized by EUTranCellFDD, EUTranCellTDD, and MCEFunction. ENBFunction is specialized by RNFunction. ExternalENBFunction is specialized by ExternalRNFunction. ServingCell is specialized by ExternalEUTranCellFDD and ExternalEUTranCellTDD. QciDscpMapping and DeNBCapability inherit from ManagedFunction. The middle section shows Top (from 28.622) as a base class for CellOutageCompensationInformation, EUTranRelation, EnergySavingProperties (from 28.628), Cdma2000Relation, EUTranCellINMCentralizedSON, and MBSFNArea. EnergySavingProperties has a composition relationship with Top. The bottom section shows Link (from 28.622) as a base class for Link_ENB_ENB, Link_MCE_ENB, and Link_MCE_MME.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +``` +classDiagram + class QciDscpMapping + class DeNBCapability + class ManagedFunction { + <<InformationObjectClass>> + (from 28.622) + } + class EUTranGenericCell + class ENBFunction + class ExternalENBFunction + class ServingCell + class EUTranCellFDD + class EUTranCellTDD + class MCEFunction + class RNFunction + class ExternalRNFunction + class ExternalEUTranCellFDD + class ExternalEUTranCellTDD + class Top { + <<InformationObjectClass>> + (from 28.622) + } + class CellOutageCompensationInformation + class EUTranRelation + class EnergySavingProperties { + <<InformationObjectClass>> + (from 28.628) + } + class Cdma2000Relation + class EUTranCellINMCentralizedSON + class MBSFNArea + class Link { + <<InformationObjectClass>> + (from 28.622) + } + class Link_ENB_ENB + class Link_MCE_ENB + class Link_MCE_MME + + QciDscpMapping --|> ManagedFunction + DeNBCapability --|> ManagedFunction + EUTranGenericCell --|> ManagedFunction + ENBFunction --|> ManagedFunction + ExternalENBFunction --|> ManagedFunction + ServingCell --|> ManagedFunction + EUTranCellFDD --|> EUTranGenericCell + EUTranCellTDD --|> EUTranGenericCell + MCEFunction --|> EUTranGenericCell + RNFunction --|> ENBFunction + ExternalRNFunction --|> ExternalENBFunction + ExternalEUTranCellFDD --|> ServingCell + ExternalEUTranCellTDD --|> ServingCell + CellOutageCompensationInformation --|> Top + EUTranRelation --|> Top + EnergySavingProperties --|> Top + EnergySavingProperties --|> Top + Cdma2000Relation --|> Top + EUTranCellINMCentralizedSON --|> Top + MBSFNArea --|> Top + Link_ENB_ENB --|> Link + Link_MCE_ENB --|> Link + Link_MCE_MME --|> Link +``` + +UML Class Diagram showing inheritance for InformationObjectClass. The diagram is divided into three sections. The top section shows ManagedFunction (from 28.622) as a base class for EUTranGenericCell, ENBFunction, ExternalENBFunction, and ServingCell. EUTranGenericCell is further specialized by EUTranCellFDD, EUTranCellTDD, and MCEFunction. ENBFunction is specialized by RNFunction. ExternalENBFunction is specialized by ExternalRNFunction. ServingCell is specialized by ExternalEUTranCellFDD and ExternalEUTranCellTDD. QciDscpMapping and DeNBCapability inherit from ManagedFunction. The middle section shows Top (from 28.622) as a base class for CellOutageCompensationInformation, EUTranRelation, EnergySavingProperties (from 28.628), Cdma2000Relation, EUTranCellINMCentralizedSON, and MBSFNArea. EnergySavingProperties has a composition relationship with Top. The bottom section shows Link (from 28.622) as a base class for Link\_ENB\_ENB, Link\_MCE\_ENB, and Link\_MCE\_MME. + +![UML Class Diagram showing E-UTRAN NRM Inheritance Hierarchy. The diagram shows several InformationObjectClass boxes connected by inheritance arrows. At the top level, there are three boxes: '<<InformationObjectClass>> ManagedFunction (from 28.622)', '<<InformationObjectClass>> EP_RP (from 28.622)', and '<<InformationObjectClass>> ManagedFunction (from 28.622)'. Below the first ManagedFunction is 'WTFunction'. Below EP_RP is 'EP_Xw'. Below the second ManagedFunction is 'WLANMobilitySet'. At the bottom level, there are two boxes: '<<InformationObjectClass>> EUtranFreqRelation' and '<<InformationObjectClass>> EUtranFrequency'. Both of these point to a central box labeled '<<InformationObjectClass>> TOP'.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +classDiagram + class WTFunction { + <<InformationObjectClass>> + WTFunction + } + class EP_RP { + <<InformationObjectClass>> + EP_RP (from 28.622) + } + class EP_Xw { + <<InformationObjectClass>> + EP_Xw + } + class ManagedFunction_1 { + <<InformationObjectClass>> + ManagedFunction (from 28.622) + } + class ManagedFunction_2 { + <<InformationObjectClass>> + ManagedFunction (from 28.622) + } + class WLANMobilitySet { + <<InformationObjectClass>> + WLANMobilitySet + } + class TOP { + <<InformationObjectClass>> + TOP + } + class E_UtranFreqRelation { + <<InformationObjectClass>> + E_UtranFreqRelation + } + class E_UtranFrequency { + <<InformationObjectClass>> + E_UtranFrequency + } + + WTFunction --|> ManagedFunction_1 + EP_Xw --|> EP_RP + WLANMobilitySet --|> ManagedFunction_2 + E_UtranFreqRelation --|> TOP + E_UtranFrequency --|> TOP + +``` + +UML Class Diagram showing E-UTRAN NRM Inheritance Hierarchy. The diagram shows several InformationObjectClass boxes connected by inheritance arrows. At the top level, there are three boxes: '<> ManagedFunction (from 28.622)', '<> EP\_RP (from 28.622)', and '<> ManagedFunction (from 28.622)'. Below the first ManagedFunction is 'WTFunction'. Below EP\_RP is 'EP\_Xw'. Below the second ManagedFunction is 'WLANMobilitySet'. At the bottom level, there are two boxes: '<> EUtranFreqRelation' and '<> EUtranFrequency'. Both of these point to a central box labeled '<> TOP'. + +Figure 4.2.2-1: E-UTRAN NRM Inheritance Hierarchy + +## 4.3 Class definitions + +### 4.3.1 ENBFunction + +#### 4.3.1.1 Definition + +This IOC represents eNB functionality defined in TS 36.300 [11] or ng-eNB defined in TS 38.300 [41]. For more information about the eNB, see 3GPP TS 23.002 [19]. For more information about the ng-eNB, see 3GPP TS 38.300 [41]. + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| intraANRSwitch | CM | M | M | - | M | +| iRATANRSwitch | CM | M | M | - | M | +| eNBId | M | M | - | - | M | +| x2BlackList | CM | M | M | - | M | +| x2WhiteList | CM | M | M | - | M | +| x2HOLockList | CM | M | M | - | M | +| x2IpAddressList | O | M | - | - | M | +| tceIDMappingInfoList | CM | M | M | - | M | +| sharNetTceMappingInfoList | CM | M | M | - | M | +| netListeningRSForRIBS | CM | M | M | - | M | +| lWIPSeGWList | CM | M | M | - | M | + +#### 4.3.1.3 Attribute constraints + +| Name | Definition | +|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| <code>intraANRSwitch Support Qualifier</code> | The condition is "ANR function is supported". | +| <code>iRATANRSwitch Support Qualifier</code> | The condition is "ANR function is supported". | +| <code>x2BlackList Support Qualifier</code> | The condition is "ANR function is supported". | +| <code>x2WhiteList Support Qualifier</code> | The condition is "ANR function is supported". | +| <code>x2HOBBlackList Support Qualifier</code> | The condition is "ANR function is supported". | +| <code>tceIDMappingInfoList Support Qualifier</code> | The condition is "MDT function is supported" and only one PLMN is supported | +| <code>sharNetTceMappingInfoList Support Qualifier</code> | The condition is "MDT function and several PLMNs are supported". | +| <code>netListeningRSForRIBS Support Qualifier</code> | The condition is "Radio Interface Based Synchronization function is supported". | +| <code>lwipSeGWList Support Qualifier</code> | The IOC represents the eNB functionality defined in TS 36.300 [11], and the LWIP is supported by the represented eNB functionality. | + +NOTE 1: The above mentioned SON or MDT related conditions do not apply to ng-eNB. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.2 ExternalENBFunction + +#### 4.3.2.1 Definition + +This IOC represents an external eNB functionality. For more information about the eNB, see 3GPP TS 23.002 [19]. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------|-------------------|------------|------------|-------------|--------------| +| <code>eNBId</code> | M | M | M | - | M | + +#### 4.3.2.3 Attribute constraints + +None. + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 EUtranGenericCell + +#### 4.3.3.1 Definition + +This abstract IOC represents the common properties of an E-UTRAN generic cell provided by eNB function or an NG-RAN generic cell provided by ng-eNB function. For more information about E-UTRAN cells, see 3GPP TS 23.401 [9]. For more information about NG-RAN cells, see 3GPP TS 38.300 [41]. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|----------------| +| cellLocalId | M | M | M | - | M | +| cellLocalIdList | CM | M | M | - | M | +| cellSize | M | M | M | - | M | +| plmnIdList | M | M | M | - | M | +| cellAccessInfoList | O | M | M | - | M | +| tac | M | M | M | - | M | +| pci | M | M | CM | - | M | +| pciList | CM | M | M | - | M | +| maximumTransmissionPower | M | M | CM | - | M | +| nbIoTcellFlag (see Note 3) | CM | M | - | - | M | +| referenceSignalPower | M | M | M | - | M | +| pb | M | M | M | - | M | +| partOfSectorPower | CM | M | M | - | M | +| relatedTmaList | CO | M | - | - | M | +| relatedAntennaList | CO | M | - | - | M | +| relatedSector | CM | M | - | - | M | +| cellResvInfo | CM | M | M | - | M | +| allowedAccessClasses | M | M | M | - | M | +| isChangeForEnergySavingAllowed | CM | M | M | - | M | +| operationalState (see Note 1) | CM | M | - | - | M (see Note 2) | +| administrativeState (see Note 1) | CM | M | - | - | M (see Note 2) | +| availabilityStatus (see Note 1) | CM | M | - | - | M (see Note 2) | +| ngranCellFlag | CM | M | - | - | M | +| sNSSAILList | CM | M | M | - | M | + +Note 1: No state propagation is implied. + +Note 2: The attribute value change is conveyed by the `notifyStateChange` notification. + +Note 3: For NB-IoT, as indicated in the relevant subclauses in TS 36.300 [12], a number of E-UTRA protocol functions supported by all UEs are not used for NB-IoT and need not be supported by eNBs and UEs only using NB-IoT. The attributes `cellLocalId`, `tac`, `pci`, `maximumTransmissionPower` are Mandatory for NB-IoT cell, Whether other attributes are needed for NB-IoT cell are out of scope of this document. + +#### 4.3.3.3 Attribute constraints + +| Name | Definition | +|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------| +| cellLocalIdList CM Support Qualifier | Active Antenna System management function is supported | +| pci CM Write Qualifier | NM-Centralized PCI assignment (see TS 32.500, ref [15] subclause 6.1.6) is supported. | +| pciList CM Support Qualifier | Either EM-Centralized or Distributed PCI assignment (see TS 32.500, ref [15] subclause 6.1.6) is supported. | +| partOfSectorPower CM support qualifier | The IOC SectorEquipmentFunction is used. | +| maximumTransmissionPower CM Write Qualifier | The IOC SectorEquipmentFunction is not used. | +| relatedTmaList CO Support Qualifier | The IOC SectorEquipmentFunction is not used. | +| relatedAntennaList CO Support Qualifier | The IOC SectorEquipmentFunction is not used. | +| relatedSector CM Support Qualifier | The IOC SectorEquipmentFunction is used. | +| cellResvInfo CM Support Qualifier | The MBSFN Transmission (see TS 36.300, ref[11] subclause 15.3.3) is supported. | +| isChangeForEnergySavingAllowed CM Support Qualifier | The energy saving functionality is supported and uses distributed architecture. | +| nbIoTcellFlag CM Support Qualifier | The NB-IoT (see TS 36.300 ref [11]) is supported. | +| ngrancellFlag CM Support Qualifier | The ng-eNB (see TS 38.300 ref [y]) function is supported. | +| sNnSSAIList CM Support Qualifier | The condition is “network slicing feature is supported”. | + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC. In addition, the following set of notification, defined in 3GPP TS 32.662 [32], is also valid. + +| Name | Qualifier | Notes | +|-------------------|-----------|-------| +| notifyStateChange | O | | + +### 4.3.4 ExternalEUTranGenericCell + +#### 4.3.4.1 Definition + +This abstract IOC represents the properties of an E-UTRAN generic cell controlled by another IRP Agent. This IOC contains necessary attributes for inter-system and intra-system handover. It also contains a subset of the attributes of related IOCs controlled by another IRP Agent. The way to maintain consistency between the attribute values of these IOCs is outside the scope of the present document. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| Ppci | M | M | M | - | M | +| plmnIdList | M | M | M | - | M | +| cellLocalId | M | M | M | - | M | +| eNBId | CM | M | M | - | M | + +#### 4.3.4.3 Attribute constraints + +| Name | Definition | +|----------------------------|-------------------------------------------------------------------------------------| +| eNBId CM Support Qualifier | This instance of ExternalEUTranGenericCell IOC is directly contained by SubNetwork. | + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.5 EUTranCellFDD + +#### 4.3.5.1 Definition + +This IOC represents the properties of E-UTRAN FDD cell provided by eNB or NG-RAN FDD cell provided by ng-eNB.. + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| earfcnDl | M | M | M | - | M | +| earfcnUl | M | M | M | - | M | + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.6 ExternalEUTranCellFDD + +#### 4.3.6.1 Definition + +This IOC represents the common properties of external E-UTRAN FDD cell provided by eNB or NG-RAN FDD cell provided by ng-eNB. + +#### 4.3.6.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| earfcnDl | M | M | M | - | M | +| earfcnUl | M | M | M | - | M | + +#### 4.3.6.3 Attribute constraints + +None. + +#### 4.3.6.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.7 EUTranCellTDD + +#### 4.3.7.1 Definition + +This IOC represents the properties of E-UTRAN cell TDD provided by eNB or NG-RAN TDD cell provided by ng-eNB. + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------|-------------------|------------|------------|-------------|--------------| +| earfcn | M | M | M | - | M | +| sfAssignment | M | M | M | - | M | +| specialSfPatterns | M | M | M | - | M | + +#### 4.3.7.3 Attribute constraints + +None. + +#### 4.3.7.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.8 ExternalEUTranCellTDD + +#### 4.3.8.1 Definition + +This IOC represents the common properties of external E-UTRAN cell TDD provided by eNB or NG-RAN TDD cell provided by ng-eNB. + +| 4.3.8.2 AttributesAttribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| earfcn | M | M | M | - | M | + +#### 4.3.8.3 Attribute constraints + +None. + +#### 4.3.8.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.9 EUTranRelation + +#### 4.3.9.1 Definition + +This IOC represents a NCR from a source cell to a target cell, where the target cell is a EUTranGenericCell or ExternalEUTranGenericCell instance. + +The source cell can be an EUTranGenericCell instance. This is the case for an Intra-E-UTRAN NCR. + +The source cell can be a UtranGenericCell instance. This is the case for Inter-RAT NCR from UTRAN to E-UTRAN. See 3GPP TS 28.652 [21]. + +The source cell can be a GsmCell instance. This is the case for Inter-RAT NCR from GERAN to E-UTRAN. See 3GPP TS 32.652 [20]. + +NCRs are unidirectional. + +#### 4.3.9.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | M | - | +| tCI | O | M | M | - | M | +| isRemoveAllowed | CM | M | M | - | M | +| isHOAllowed | CM | M | M | - | M | +| isICICInformationSendAllowed | CM | M | M | - | M | +| isLBAllowed | CM | M | M | - | M | +| isESCoveredBy | CM | M | M | - | M | +| qOffset | CM | M | M | - | M | +| cellIndividualOffset | CM | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| adjacentCell | M | M | M | - | M | + +#### 4.3.9.3 Attribute constraints + +| Name | Definition | +|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| isRemoveAllowed Support Qualifier | The condition is "ANR function is supported in the source cell, and the source cell is an EUTRANGenericCell or a UTRANGenericCell". | +| isHOAllowed Support Qualifier | The condition is "ANR function is supported in the source cell, and the source cell is an EUTRANGenericCell or a UTRANGenericCell". | +| isICICInformationSendAllowed Support Qualifier | The condition is "ICIC function is supported". | +| isLBAllowed Support Qualifier | The condition is "LB function is supported". | +| isESCoveredBy Support Qualifier | The condition is "Energy Saving function is supported". | +| qOffset Support Qualifier | The condition is "Neither an EM-centralized nor a distributed SON function support the SON use cases for which this attribute is relevant (see §6.5.1)". | +| cellIndividualOffset Support Qualifier | The condition is "HOO function is supported" or "Load Balancing Optimization function is supported". | + +#### 4.3.9.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.10 Link\_ENB\_ENB + +#### 4.3.10.1 Definition + +This IOC represents the link between two ENBFunction. + +#### 4.3.10.2 Attributes + +None. + +#### 4.3.10.3 Attribute constraints + +None. + +#### 4.3.10.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.11 Cdma2000Relation + +#### 4.3.11.1 Definition + +This IOC represents a NCR from one EUTRANGenericCell to a CDMA2000 sector. NCRs are directional. + +See 3GPP2 TS S.S0028 [22] + +#### 4.3.11.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | M | - | +| <b>Attribute related to role</b> | | | | | | +| adjacentSector | M | M | - | - | M | + +#### 4.3.11.3 Attribute constraints + +None. + +#### 4.3.11.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.12 MCEFunction + +#### 4.3.12.1 Definition + +This IOC represents MCE functionality. For more information about the MCE, see 3GPP TS 36.300 [11]. + +#### 4.3.12.2 Attributes + +None. + +#### 4.3.12.3 Attribute constraints + +None. + +#### 4.3.12.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.13 MBSFNArea + +#### 4.3.13.1 Definition + +This IOC represents MBSFN Area. For more information about MBSFN Area, see 3GPP TS 36.300 [11]. + +#### 4.3.13.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | M | - | +| mbsfnAreaId | M | M | M | - | M | +| <b>Attribute related to role</b> | | | | | | +| cellIdList | M | M | M | - | M | + +#### 4.3.13.3 Attribute constraints + +None. + +#### 4.3.13.4 Notifications + +| Name | Qualifier | Notes | +|----------------------------|-----------------------------------------|-------| +| notifyAttributeValueChange | See Kernel CM IRP (3GPP TS 32.662 [32]) | | +| notifyObjectCreation | See Kernel CM IRP (3GPP TS 32.662 [32]) | | +| notifyObjectDeletion | See Kernel CM IRP (3GPP TS 32.662 [32]) | | + +### 4.3.14 Link\_MCE\_ENB + +#### 4.3.14.1 Definition + +This IOC models the M2 reference point as defined in TS 36.300 [11]. + +#### 4.3.14.2 Attributes + +None. + +#### 4.3.14.3 Attribute constraints + +None. + +#### 4.3.14.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.15 Link\_MCE\_MME + +#### 4.3.15.1 Definition + +This IOC models the M3 reference point as defined in TS 36.300 [11]. + +#### 4.3.15.2 Attributes + +None. + +#### 4.3.15.3 Attribute constraints + +None. + +#### 4.3.15.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.16 RNFunction + +#### 4.3.16.1 Definition + +This IOC represents Relay Node (RN) functionality. For more information about RN, see 3GPP TS 36.300 [11]. + +#### 4.3.16.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| candidateDeNBCells | M | M | M | - | M | +| Attribute related to role | | | | | | +| servingCell | M | M | M | - | M | + +#### 4.3.16.3 Attribute constraints + +None. + +#### 4.3.16.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.17 ExternalRNFunction + +#### 4.3.17.1 Definition + +This IOC represents the properties of a Relay Node (RN) controlled by another IRP Agent. For more information about RN, see 3GPP TS 36.300 [11]. + +#### 4.3.17.2 Attributes + +None. + +#### 4.3.17.3 Attribute constraints + +None. + +#### 4.3.17.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.18 DeNBCapability + +#### 4.3.18.1 Definition + +This IOC represents the capability for an eNodeB to act as a Donor eNodeB (DeNB) functionality. For more information about the DeNB, see 3GPP TS 36.300 [11]. + +#### 4.3.18.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| maxNbrRNAllowed | M | M | M | - | M | +| <b>Attribute related to role</b> | | | | | | +| servedRN | M | M | M | - | M | + +#### 4.3.18.3 Attribute constraints + +None. + +#### 4.3.18.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.19 CellOutageCompensationInformation + +#### 4.3.19.1 Definition + +This IOC represents information relevant in case of a Cell Outage Compensation taking place. + +#### 4.3.19.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | M | - | +| cOCStatus | M | M | - | - | M | +| isCOCAllowed | M | M | M | - | M | + +#### 4.3.19.3 Attribute constraints + +None. + +#### 4.3.19.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, with the addition that `notifyAttributeValueChange` shall be supported (Support Qualifier M). + +### 4.3.20 QciDscpMapping + +#### 4.3.20.1 Definition + +This IOC represents a set of mapping between QCI and DSCP. + +#### 4.3.20.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------|-------------------|------------|------------|-------------|--------------| +| qciDscpMappingList | M | M | M | - | M | + +#### 4.3.20.3 Attribute constraints + +N one. + +#### 4.3.20.4 Notifications + +| Name | Qualifier | Notes | +|-----------------------------------------|-----------------------------------------|-------| +| <code>notifyAttributeValueChange</code> | See Kernel CM IRP (3GPP TS 32.662 [32]) | | +| <code>notifyObjectCreation</code> | See Kernel CM IRP (3GPP TS 32.662 [32]) | | +| <code>notifyObjectDeletion</code> | See Kernel CM IRP (3GPP TS 32.662 [32]) | | + +### 4.3.21 EUtranCellNMCentralizedSON + +#### 4.3.21.1 Definition + +This abstract IOC represents the properties of an E-UTRAN generic cell which relate to SON functions. Its purpose is to enable configuration and tuning of the cell behaviour by the operator for SON functions which are not (yet) implemented in the eNodeB. NMS level SON should consider when configuring and tuning the cell the correlation of different attributes to optimise the eNodeB and network performance. For more information about cells, see 3GPP TS 23.401 [9]. + +#### 4.3.21.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------------------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | M | - | +| a1ThresholdRsrp | CM | M | M | - | M | +| a1ThresholdRsrq | CM | M | M | - | M | +| a2ThresholdRsrp | CM | M | M | - | M | +| a2ThresholdRsrq | CM | M | M | - | M | +| a3Offset | CM | M | M | - | M | +| a4ThresholdRsrp | CM | M | M | - | M | +| a4ThresholdRsrq | CM | M | M | - | M | +| a5Threshold1Rsrp | CM | M | M | - | M | +| a5Threshold1Rsrq | CM | M | M | - | M | +| b1ThresholdUtraRscp | CM | M | M | - | M | +| b1ThresholdUtraEcN0 | CM | M | M | - | M | +| b1ThresholdGeran | CM | M | M | - | M | +| b1ThresholdCdma2000 | CM | M | M | - | M | +| b2Threshold1Rsrp | CM | M | M | - | M | +| b2Threshold1Rsrq | CM | M | M | - | M | +| b2Threshold2UtraRscp | CM | M | M | - | M | +| b2Threshold2UtraEcN0 | CM | M | M | - | M | +| b2Threshold2Geran | CM | M | M | - | M | +| b2Threshold2Cdma2000 | CM | M | M | - | M | +| commonChannelPowerOffset | CM | M | M | - | M | +| configurationIndex | CM | M | M | - | M | +| contentionResolutionTimer | CM | M | M | - | M | +| hysteresisEutraA1 | CM | M | M | - | M | +| hysteresisEutraA2 | CM | M | M | - | M | +| hysteresisEutraA3 | CM | M | M | - | M | +| hysteresisEutraA4 | CM | M | M | - | M | +| hysteresisEutraA5 | CM | M | M | - | M | +| hysteresisIratB1 | CM | M | M | - | M | +| hysteresisIratB2 | CM | M | M | - | M | +| numberOfRaPreambles | CM | M | M | - | M | +| preambleInitialReceivedTargetPower | CM | M | M | - | M | +| preambleTransMax | CM | M | M | - | M | +| pMax | CM | M | M | - | M | +| powerRampingStep | CM | M | M | - | M | +| qHyst | CM | M | M | - | M | +| qOffsetUtra | CM | M | M | - | M | +| qOffsetGeran | CM | M | M | - | M | +| qOffsetCdma2000 | CM | M | M | - | M | +| qQualMinUtra | CM | M | M | - | M | +| qRxLevMinEutraSib1 | CM | M | M | - | M | +| qRxLevMinEutraSib3 | CM | M | M | - | M | +| qRxLevMinGeran | CM | M | M | - | M | +| qRxLevMinUtra | CM | M | M | - | M | +| responseWindowSize | CM | M | M | - | M | +| rootSequenceIndex | CM | M | M | - | M | +| sIntraSearch | CM | M | M | - | M | +| sizeOfRAPreamblesGroupA | CM | M | M | - | M | +| timeToTriggerEutraA1 | CM | M | M | - | M | +| timeToTriggerEutraA2 | CM | M | M | - | M | +| timeToTriggerEutraA3 | CM | M | M | - | M | +| timeToTriggerEutraA4 | CM | M | M | - | M | +| timeToTriggerEutraA5 | CM | M | M | - | M | +| timeToTriggerIratB1 | CM | M | M | - | M | +| timeToTriggerIratB2 | CM | M | M | - | M | +| tReselectionCdma2000 | CM | M | M | - | M | +| tReselectionEutra | CM | M | M | - | M | +| tReselectionGeran | CM | M | M | - | M | +| tReselectionUtra | CM | M | M | - | M | +| tStoreUeContext | CM | M | M | - | M | + +#### 4.3.21.3 Attribute constraints + +| Name | Definition | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| All Support Qualifiers | The condition is "Neither an EM-centralized nor a distributed SON function support the SON use cases for which this attribute is relevant (see §6.5.1)". | + +#### 4.3.21.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.22 WTFunction + +#### 4.3.22.1 Definition + +This IOC represents WT functionality defined in TS 36.300 [11]. + +#### 4.3.22.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| wLANInfoList | M | M | M | - | M | + +#### 4.3.22.3 Attribute constraints + +None. + +#### 4.3.22.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.23 EP\_Xw + +#### 4.3.23.1 Definition + +This IOC represents the end point of Xw reference point defined in TS 36.300 [11]. + +#### 4.3.23.2 Attributes + +No additional attributes to the ones inherited from the IOC EP\_RP defined in TS 28.622 [6]. + +#### 4.3.23.3 Attribute constraints + +None. + +#### 4.3.23.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.24 WLANMobilitySet + +#### 4.3.24.1 Definition + +This IOC represents the managed WLAN mobility set for LWA and LWIP. For more information about the WLAN mobility set, see 3GPP TS 36.300 [11]. + +#### 4.3.24.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| | | | | | | + +#### 4.3.24.3 Attribute constraints + +None. + +#### 4.3.24.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.25 MemberWLAN <<datatype>> + +#### 4.3.25.1 Definition + +This <<datatype>> represents the information about a member WLAN of a WLAN mobility set. + +#### 4.3.25.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------|-------------------|------------|------------|-------------|--------------| +| wLANId | M | T | T | - | T | +| wLANGeoLocation | O | T | T | - | T | +| isLWASupported | M | T | T | - | T | +| isLWIPSupported | M | T | T | - | T | + +#### 4.3.25.3 Attribute constraints + +None. + +#### 4.3.25.4 Notifications + +The subclause 4.5 of the <<IOC>> using this <<dataType>> as one of its attributes, shall be applicable. + +### 4.3.26 PLMNId <<dataType>> + +#### 4.3.26.1 Definition + +This <<dataType>> represents the information of a PLMN identification. + +#### 4.3.26.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| mCC | M | T | T | F | T | +| mNC | M | T | T | F | T | + +#### 4.3.26.3 Attribute constraints + +None. + +#### 4.3.26.4 Notifications + +The subclause 4.5 of the <<IOC>> using this <<dataType>> as one of its attributes, shall be applicable. + +### 4.3.27 EUTranFreqRelation + +#### 4.3.27.1 Definition + +This IOC, together with the target EUTranFrequency, represents the frequency properties applicable to the referencing cell relation. + +#### 4.3.27.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| cellIndividualOffset | O | T | T | F | T | +| blackListEntry | O | T | T | F | T | +| blackListEntryIdleMode | O | T | T | F | T | +| cellReselectionPriority | O | T | T | F | T | +| cellReselectionSubPriority | O | T | T | F | T | +| pMax | O | T | T | F | T | +| qOffsetFreq | O | T | T | F | T | +| qQualMin | O | T | T | F | T | +| qRxLevMin | M | T | T | F | T | +| threshXHighP | M | T | T | F | T | +| threshXHighQ | CM | T | T | F | T | +| threshXLowP | M | T | T | F | T | +| threshXLowQ | CM | T | T | F | T | +| tReselectionEutra | M | T | T | F | T | +| tReselectionEutraSfHigh | O | T | T | F | T | +| tReselectionEutraSfMedium | O | T | T | F | T | +| <b>attribute related to role</b> | | | | | | +| eUtraFrequencyRef | M | T | T | F | T | + +#### 4.3.27.3 Attribute constraints + +| Name | Definition | +|----------------------------------------|------------------------------------------------------------------------------------------------| +| threshXHighQ <b>Support Qualifiers</b> | Condition: The Struct Member threshServingLowQ in SIB3 is used in systemInformationBlockType3. | + +#### 4.3.27.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.28 EUTranFrequency + +#### 4.3.28.1 Definition + +This IOC represents certain E-UTRAN frequency properties. + +#### 4.3.28.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------------|-------------------|------------|------------|-------------|--------------| +| earfcnDL | M | T | T | F | T | +| multiBandInfoListEutra | M | T | F | F | T | + +#### 4.3.28.3 Attribute constraints + +None. + +#### 4.3.28.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + + + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| a1ThresholdRsrp | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a1. Actual value is IE value -140 dBm. Corresponds to parameter a1-Threshold.Threshold-RSRP specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 97 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a1ThresholdRsqrq | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a1. Actual value is (IE value -40)/2 dB. Corresponds to parameter a1-Threshold.Threshold-RSRQ specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 34 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a2ThresholdRsrp | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a2. Actual value is IE value -140 dBm. Corresponds to parameter a2-Threshold.Threshold-RSRP specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 97 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a2ThresholdRsqrq | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a2. Actual value is (IE value -40)/2 dB. Corresponds to parameter a2-Threshold.Threshold-RSRQ specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 34 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a3Offset | Offset to be used in evaluation of EUTRA measurement report triggering condition for event a3. Mapping to values in dB is specified in [38]. Corresponds to parameter a3-Offset specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: -30 : 30 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a4ThresholdRsrp | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a4. Actual value is IE value -140 dBm. Corresponds to parameter a4-Threshold.Threshold-RSRP specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 97 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| a4ThresholdRsrq | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a4. Actual value is (IE value -40)/2 dB. Corresponds to parameter a4-Threshold.Threshold-RSRQ specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Robustness Optimization.<br><br>allowedValues: 0 : 34 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a5Threshold1Rsrp | RSRP Threshold1 to be used in evaluation of EUTRA measurement report triggering condition for event a5. Actual value is IE value -140 dBm. Corresponds to parameter a5-Threshold1.Threshold-RSRP specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Robustness Optimization.<br><br>allowedValues: 0 : 97 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| a5Threshold1Rsrq | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event a5. Actual value is (IE value -40)/2 dB. Corresponds to parameter a5-Threshold1.Threshold-RSRQ specified in ReportConfigEUTRA IE in [10]. This attribute may be used for Robustness Optimization.<br>allowedValues: 0 : 34. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| adjacentCell | This attribute contains the DN of a EUTranGenericCell or ExternalEUTranGenericCell.<br><br>allowedValues: N/A. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| adjacentSector | This attribute contains the DN of an ExternalSector.<br><br>allowedValues: N/A. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| allowedAccessClasses | This holds information for access classes (10-15) – [3GPP TS 22.011] that are allowed for the eUTRANCell.<br>The access classes are:<br>Class 10 – emergency call<br>Class 11- For PLMN Use.<br>Class 12 - Security Services;<br>Class 13- Public Utilities (e.g. water/gas suppliers);<br>Class 14- Emergency Services;<br>Class 15 - PLMN Staff;<br><br>allowedValues: See TS 22.011 [29] and 36.331 [10] for more details on the definition and SIB2 broadcast message definition. | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: “all access classes are allowed”<br>isNullable: False | +| b1ThresholdCdma2000 | Threshold to be used in CDMA2000 triggering condition for event b1. Mapping to actual dBm values is specified in 3GPP TS 45.008. Corresponds to parameter b1-ThresholdCDMA2000 specified in ReportConfigInterRAT IE in [10]. This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:63. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| b1ThresholdGeran | Threshold to be used in GERAN triggering condition for event b1. Mapping to actual dBm values is specified in 3GPP TS 45.008. Corresponds to parameter b1-ThresholdGERAN specified in ReportConfigInterRAT IE in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:63. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| b1ThresholdUtraEcN0 | EcN0 threshold to be used in UTRA triggering condition for event b1. Mapping to actual dBm values is specified in 3GPP TS 25.133. Corresponds to parameter b1-ThresholdULTA:utra-EcN0 specified in ReportConfigInterRAT IE in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:49. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| b1ThresholdUtraRscp | RSCP threshold to be used in UTRA triggering condition for event b1. Mapping to actual dBm values is specified in 3GPP TS 25.133. Corresponds to parameter b1-ThresholdULTA:utra-RSCP specified in ReportConfigInterRAT IE in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: -5:91 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| b2Threshold1Rsrp | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event b2. Actual value is IE value -140 dBm. Corresponds to parameter b2-Threshold1.Threshold-RSRP specified in ReportConfigInterRAT IE in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 97 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| b2Threshold1Rsrq | RSRP Threshold to be used in evaluation of EUTRA measurement report triggering condition for event b2. Actual value is (IE value -40)/2 dB. Corresponds to parameter b2-Threshold1.Threshold-RSRQ specified in ReportConfigInterRAT IE in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 34 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| b2Threshold2Cdma2000 | Threshold to be used in CDMA2000 measurement report triggering condition for event b2. Mapping to actual dBm values is specified in [36]. Corresponds to parameter b2-Threshold2CDMA2000 specified in ReportConfigInterRAT IE in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 : 63 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| b2Threshold2Geran | <p>Threshold to be used in GERAN measurement report triggering condition for event b2. Mapping to actual dBm values is specified in [36]. Corresponds to parameter b2-Threshold2GERAN specified in ReportConfigInterRAT IE in [10].</p> <p>This attribute may be used for Mobility Robustness Optimization.</p> <p>allowedValues: 0 : 63</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| b2Threshold2UtraEcN0 | <p>EcN0 threshold to be used in UTRA measurement report triggering condition for event b2. Mapping to actual dBm values is specified in 3GPP TS 25.133. Corresponds to parameter b2-Threshold2ULTRA:utra-EcN0 specified in ReportConfigInterRAT IE in [10].</p> <p>This attribute may be used for Mobility Robustness Optimization.</p> <p>allowedValues: 0 : 49</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| b2Threshold2UtraRscp | <p>RSCP threshold to be used in UTRA measurement report triggering condition for event b2. Mapping to actual dBm values is specified in 3GPP TS 25.133. Corresponds to parameter b2-Threshold2ULTRA:utra-RSCP specified in ReportConfigInterRAT IE in [10].</p> <p>This attribute may be used for Mobility Robustness Optimization.</p> <p>allowedValues: -5 : 91</p> | <p>type: Integer</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| candidateDeNBcells | <p>A list of ECGIs of the candidates DeNB cells for the subject Relay Node in Attach for RN operation (phase 2), see 36.300[4].</p> <p>allowedValues: See 3GPP TS 36.413[27], 36.300[4]</p> | <p>type: <<dataType>></p> <p>multiplicity: 1..*</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| cellIdList | <p>This holds a list of DN of EUTranGenericCell. These cells all belong to one MBSFN Area.</p> <p>allowedValues: N/A</p> | <p>type: DN</p> <p>multiplicity: 1</p> <p>isOrdered: N/A</p> <p>isUnique: N/A</p> <p>defaultValue: None</p> <p>isNullable: False</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| cellAccessInfoList | <p>A list of entries where an entry identifies a PLMN sharing the cell resources.</p> <p>The presence of this attribute indicates that the EUTRAN cell is supporting RAN sharing for PLMN(s) using different TAC and Cell-ID for the cell.</p> <p>An entry has four attributes: <code>plmnId</code>, <code>tac</code>, <code>cellId</code>, <code>managementServiceExposed</code>.</p> <p>The <code>plmnId</code> identifies the PLMN sharing the cell resources.</p> <p>The <code>tac</code> and the <code>cellId</code> are used by the PLMN (identified by <code>plmnId</code>) sharing the cell resources.</p> <p>The <code>managementServiceExposed</code> indicates the management services (e.g. FM) exposed to the PLMN (identified by <code>plmnId</code>). The precise semantics of this attribute is not specified.</p> <p>One <code>plmnId</code> (value) can be included at most once in this list. The PLMN identified cannot be the primary PLMN. Its identifier cannot be included in the <code>plmnIdList</code>.</p> | type: <<dataType>><br>multiplicity: 1..5<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cellIndividualOffset | <p>Offset applicable to a neighbouring cell. It is used for evaluating the neighbouring cell for handover in connected mode. This attribute corresponds to parameter <code>cellIndividualOffset</code> in <code>MeasObjectEUTRA</code> IE in [10].</p> <p>This attribute is used by the <code>HandOver</code> parameter Optimization (HOO) function or <code>Load Balancing Optimization (LBO)</code> function.</p> <p>allowedValues:<br/> dB-24, dB-22, dB-20, dB-18, dB-16, dB-14, dB-12, dB-10, dB-08, dB-06, dB-05, dB-04, dB-03, dB-02, dB-01, dB+00, dB+01, dB+02, dB+03, dB+04, dB+05, dB+06, dB+08, dB+10, dB+12, dB+14, dB+16, dB+18, dB+20, dB+22, dB+24</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| cellLocalId | <p>Unambiguously identify a cell within an eNodeB.</p> <p>allowedValues: 0 : 255.</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| cellLocalIdList | <p>This holds a list of cell local identities that can be assigned to the <code>cellLocalId</code> attribute of the new split or merged cells by the Active Antenna System operations. The assignment algorithm is not specified.</p> <p>allowedValues of each entry: 0 : 255</p> | type: Integer<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| cellResvInfo | <p>This attribute represents whether the cell is MBSFN Area Reserved Cell or not. See TS 36.300[11] for MBSFN Area Reserved Cell.</p> <p>allowedValues: See 3GPP TS 36.443 [28] for Cell Reservation Info.</p> | type:<<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| cellSize | <p>See cell-Size in TS 36.423 [24].</p> <p>allowedValues: See cell-Size in TS 36.423 [24].</p> | <p>type: <<enumeration>><br/> multiplicity: 1<br/> isOrdered: N/A<br/> isUnique: True<br/> defaultValue: None<br/> isNullable: False</p> | +| cOCStatus | <p>This attribute holds the information about cell outage compensation (COC) activities for the cell which name contains the <code>CellOutageCompensationInformation</code> IOC instance.</p> <p>The initial state is <code>cOCDeactive</code>.</p> <p>When a cell outage is detected and its compensation starts, then the state is <code>cOCActivating</code>.</p> <p>When COC function decides that all activities to activate the compensation are done, the state changes to <code>cOCActive</code>.</p> <p>When outage of cell is ended and activities to remove the compensation are ongoing, the state changes to <code>cOCDeactivating</code>.</p> <p>When outage of cell ends and all activities to remove the compensation are done, the state changes back to <code>cOCDeactive</code>.</p> <p>In case of errors during activation or deactivation, this attribute also contains a list of elements which could not be reconfigured by the COC function.</p> <p>If there are no errors during activation or deactivation, the list of elements shall be empty.</p> <p>For an example how <code>notifyAttributeValueChange</code> notifications related to this attribute are used to inform an <code>IRPManager</code> about COC activities see Annex A.</p> <p>allowedValues: This element contains 2 parts, state and errorList<br/> state = enumerated<br/> {<br/>   <code>cOCActivating</code>,<br/>   <code>cOCActive</code>,<br/>   <code>cOCDeactivating</code>,<br/>   <code>cOCDeactive</code><br/> }<br/> errorList = list of DNs</p> | <p>type: <<dataType>><br/> multiplicity: 1<br/> isOrdered: N/A<br/> isUnique: N/A<br/> defaultValue: None<br/> isNullable: False</p> | +| commonChannelPowerOffset | <p>Power offset of the Primary Synchronization Channel, Secondary Synchronization Channel and Physical Broadcast Channel with respect to the referenceSignalPower. Value in dB is the actual value divided by 10. For example, value -30 represents -3dB; value 120 represent 12dB etc. This attribute may be used for Coverage and Capacity Optimization and ICIC.</p> <p>allowedValues: -350:150.</p> | <p>type: Integer<br/> multiplicity: 1<br/> isOrdered: N/A<br/> isUnique: N/A<br/> defaultValue: None<br/> isNullable: False</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| configurationIndex | Provides index into the table defining PRACH resources within the frame. Corresponds to PRACH-Configuration-Index parameter defined in [10] and [12].<br>This attribute may be used for RACH Optimization.<br><br>allowedValues: 0:63. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| contentionResolutionTimer | Contention resolution timer. Corresponds to parameter mac-ContentionResolutionTimer specified in [10] and in [8]. Value sfn corresponds to n subframes.<br>This attribute may be used for RACH Optimization.<br><br>allowedValues:{sf8, sf16, sf24, sf32, sf40, sf48,sf56, sf64} | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| earfcn | It is the frequency number for the central frequency. See 3GPP TS 36.104[14].<br><br>allowedValues: See 3GPP TS 36.104[14]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| earfcnDl | Specifies the channel number for the central DL frequency. The mapping from channel number to physical frequency is described in 3GPP specification TS 36.101 [13] subclause 5.7.3.<br><br>allowedValues: See EARFCN in TS 36.101 [13] subclause 5.7.3 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| earfcnUl | Specifies the channel number for the central UL frequency. The mapping from channel number to physical frequency is described in 3GPP specification TS 36.101 [13] subclause 5.7.3.<br><br>allowedValues: See EARFCN in TS 36.101 [13] subclause 5.7.3 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| eNBId | Unambiguously identifies an eNodeB within a PLMN<br><br>allowedValues: See 3GPP TS 36.413[27], 36.300[4] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hysteresisEutraA1 | Hysteresis applied to entry and leave condition of a report triggering event A1. Maps to the instance of the <i>hysteresis</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A1.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hysteresisEutraA2 | Hysteresis applied to entry and leave condition of a report triggering event A2. Maps to the instance of the <i>hysteresis</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A2.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| hysteresisEutr aA3 | Hysteresis applied to entry and leave condition of a report triggering event A3. Maps to the instance of the <i>hysteresis</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A3.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hysteresisEutr aA4 | Hysteresis applied to entry and leave condition of a report triggering event A4. Maps to the instance of the <i>hysteresis</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A4.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hysteresisEutr aA5 | Hysteresis applied to entry and leave condition of a report triggering event A5. Maps to the instance of the <i>hysteresis</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A5.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hysteresisIrat B1 | Hysteresis applied to entry and leave condition of the IRAT report triggering event B1. Maps to <i>hysteresis</i> IE specified in <i>ReportConfigInterRAT</i> IE in [10] corresponding to event B1.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hysteresisIrat B2 | Hysteresis applied to entry and leave condition of the IRAT report triggering event B2. Maps to <i>hysteresis</i> IE specified in <i>ReportConfigInterRAT</i> IE in [10] corresponding to event B2.<br>This attribute may be used for Mobility Robustness Optimization.<br>allowedValues: 0:30. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| id | An attribute whose "name+value" can be used as an RDN when naming an instance of the object class.<br>This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: False | +| intraANRSwitch | This attribute determines whether the intra E-UTRAN ANR function is activated or deactivated.<br><br>If "on", the intra E-UTRAN ANR function may add or remove intra E-UTRAN Neighbour Relations, i.e. add or remove <i>EUtranRelation</i> instances from <i>EUtranGenericCells</i> of this <i>ENBFunction</i> .<br>If "off", the intra E-UTRAN ANR Function must not add or remove Neighbour Relations, i.e. add or remove <i>EUtranRelation</i> instances from <i>EUtranGenericCells</i> of this <i>ENBFunction</i> .<br><br>allowedValues: on, off | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: on<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| iRATANRSwitch | <p>This attribute determines whether the IRAT ANR function is activated or deactivated.</p> <p>If “on”, the IRAT ANR function may add or remove IRAT Neighbour Relations, i.e. add or remove UtranRelation or GsmRelation instances from EUTranGenericCells of this ENBFunction.</p> <p>If “off”, the IRAT ANR Function must not add or remove IRAT Neighbour Relations, i.e. add or remove UtranRelation or GsmRelation instances from EUTranGenericCells of this ENBFunction.</p> <p>allowedValues: on, off</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: on<br>isNullable: False | +| isChangeForEnergySavingAllowed | <p>This attribute allows to IRPManager to prohibit or allow configuration changes of the cell for ESM purposes by the IRPAgent. This restriction also applies to instances name contained in such cells. Their attribute values can not be changed by the IRPAgent.</p> <p>allowedValues: yes,no</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| isCOCAAllowed | <p>This attribute allows to IRPManager to prohibit or allow configuration changes of the cell for cell outage compensation purposes by the IRPAgent. This restriction also applies to instances name contained in such cells. Their attribute values can not be changed by the IRPAgent.</p> <p>allowedValues: yes,no</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| isESCoveredBy | <p>The value of the attribute is configured by the IRPManager and is not changed by the IRPAgent. It indicates whether the adjacentCell according to this planning provides no, partial or full coverage for the cell which name-contains the EUTranRelation instance.</p> <p>Adjacent cells with this attribute equal to “yes” are recommended to be considered as candidate cells to take over the coverage when the original cell is about to be transferred to energySaving state. The entirety of adjacent cells with this property equal to “partial” are recommended to be considered as entirety of candidate cells to take over the coverage when the original cell is about to be transferred to energySaving state.</p> <p>allowedValues: no, partial, yes</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| isHOAllowed | <p>This indicates if HO is allowed or prohibited.</p> <p>If TRUE, handover is allowed from source cell to target cell. The source cell is identified by the name-containing EUTranGenericCell or UtranGenericCell of the EUTranRelation that has the isHOAllowed. The target cell is referenced by the EUTranRelation that has this isHOAllowed.</p> <p>If FALSE, handover shall not be allowed.</p> <p>allowedValues: TRUE, FALSE</p> | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| isICICInformationSendAllowed | <p>This indicates if ICIC (Inter Cell Interference Coordination) load information message (see TS 36.423 [24] Section 9.1.2.1 LOAD INFORMATION) sending is allowed or prohibited.</p> <p>If 'yes', ICIC load information message sending is allowed from source cell to target cell. The source cell is identified by the name-containing <code>EUtranGenericCell</code> of the <code>EUtranRelation</code> that has the <code>isICICInformationSendAllowed</code>. The target cell is referenced by the <code>EUtranRelation</code> that has this <code>isICICInformationSendAllowed</code>.</p> <p>If 'no', ICIC load information message sending shall not be allowed.</p> <p>allowedValues: yes,no</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| isLBAllowed | <p>This indicates if load balancing is allowed or prohibited from source cell to target cell.</p> <p>If 'yes', load balancing is allowed from source cell to target cell. The source cell is identified by the name-containing <code>EUtranGenericCell</code> of the <code>EUtranRelation</code> that has the <code>isLBAllowed</code>. The target cell is referenced by the <code>EUtranRelation</code> that has this <code>isLBAllowed</code>.</p> <p>If 'no', load balancing shall be prohibited from source cell to target cell.</p> <p>allowedValues: yes,no</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| isLWASupported | <p>This element indicates whether LWA is supported between the eNB and this WLAN.</p> <p>allowed values: yes, no</p> | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: yes<br>isNullable: False | +| isLWIPSupported | <p>This attribute indicates whether LWIP is supported between the eNB and this WLAN.</p> <p>allowed values: yes, no</p> | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: yes<br>isNullable: False | +| isRemoveAllowed | <p>This indicates if the subject <code>EUtranRelation</code> can be removed (deleted) or not.</p> <p>If TRUE, the subject <code>EUtranRelation</code> instance can be removed (deleted).</p> <p>If FALSE, the subject <code>EUtranRelation</code> instance shall not be removed (deleted) by any entity but an IRPManager.</p> <p>allowedValues: TRUE, FALSE</p> | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lWIPSeGWList | <p>This attribute contains a list of <code>IWIPSeGWInfo</code>, and each <code>IWIPSeGWInfo</code> includes the following elements:</p> <ul style="list-style-type: none"> <li>- <code>LWIPSeGWId</code><br/>This element identifies the LWIP SeGW.</li> <li>- <code>LWIPSeGWIpAddressList</code><br/>This element provides the IP addresses of the LWIP SeGW.</li> </ul> | type: <<dataType>><br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| maximumTransmissionPower | This is the maximum possible for all downlink channels, used simultaneously in a cell, added together. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| maxNbrRNsAllowed | This is an integer indicating the maximum number of RNs allowed to be connected. It is a number which can be configured by the operator to control the node/network load. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mbsfnAreaId | This is the identifier of MBSFN Area.<br>See TS 36.300[11] for MBSFN Area.<br><br>allowedValues: See 3GPP TS 36.443 [28] for mbsfnAreaId | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mCC | This is the Mobile Country Code (MCC) of the PLMN identifier. See TS 23.003 [3] subclause 2.2 and 12.1.<br><br>allowedValues: a bounded string of 3 characters representing 3 digits. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mNC | This is the Mobile Network Code (MNC) of the PLMN identifier. See TS 23.003 [3] subclause 2.2 and 12.1.<br><br>allowedValues: A bounded string of 2 or 3 characters representing 2 or 3 digits. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| nbIoTcellFlag | This attribute represents whether the cell is supporting NB-IoT or not.<br>See TS 36.300 [11] for NB-IoT cell.<br><br>allowedValues: yes, no. | type:<<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ngranCellFlag | This attribute represents whether the cell is provided by ng-eNB or not.<br>See TS 38.300 [y] for ng-eNB cell.<br><br>allowedValues: yes, no. | type:<<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| netListeningRS<br>ForRIBS | <p>This specifies the configuration of RS (reference signals) for RIBS (radio interface based synchronization) by means of network listening, see Radio Interface based Synchronization in TS 36.300 [11].</p> <p>It is a list of structures where each structure contains the following elements:</p> <ul style="list-style-type: none"> <li>- RS_pattern</li> <li>- Number of CRS ports</li> <li>- Periodicity</li> <li>- Offset</li> </ul> <p>allowedValues:<br/> RS_pattern: CRS only; or CRS and PRS;<br/> CRS (Cell-specific Reference Signal) see clause 6.10.1.1 and 6.10.1.2 in TS 36.211 [12].<br/> PRS (Positioning Reference Signal) see clause 6.10.4.1 and 6.10.4.2 in TS 36.211 [12].<br/> Number of CRS ports: 1 or 2;<br/> Periodicity: 1280ms, 2560ms, 5120ms, or 10240ms;<br/> Offset: range from "0" to (Periodicity-1) wherein the reference signal offset is in number of subframes starting from SFN 0 and subframe 0.</p> <p>More than one network listening reference signal configuration may be configured with a maximum of 4 configurations per eNB.</p> | type: <<dataType>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| numberOfRaPreambles | <p>Number of non-dedicated random access preambles. Corresponds to parameter numberOfRA-Preambles specified in [10] and in [8]. Value n4 corresponds to 4, n8 corresponds to 8 and so on.</p> <p>This attribute may be used for RACH Optimization.</p> <p>allowedValues:<br/> n4,n8,n12,n16,n20,n24,n28,n32,n36,n40,n44,n48,n52,n56,n60,n64</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| partOfSectorPower | <p>This is the requested part (i.e. %) of the total radio power available to the SectorEquipmentFunction. The requested % power should be allocated to the cell.</p> <p>allowedValues: 1 : 100</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pb | <p><math>P_B</math>, which is described in Section 5.2 of TS 36.213 [25]</p> <p>allowedValues: See 3GPP TS 36.213[25]</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pci | <p>This holds the Physical Cell Identity (PCI) of the cell (for NM-Centralized, EM-Centralized and Distributed PCI assignment cases).</p> <p>In the case of NM-Centralized PCI assignment, see TS 36.300, [11] subclause 22.3.5, IRPManager signals a specific value by writing this attribute.</p> <p>allowedValues: See TS 36.211 [12] subclause 6.11 for legal values of pci.</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| pciList | <p>This holds a list of physical cell identities that can be assigned to the pci attribute by eNB. The assignment algorithm is not specified.</p> <p>This attribute shall be supported if and only if the EM-Centralized or Distributed PCI Assignment is supported. See TS 32.500, ref [15] subclause 6.1.6.</p> <p>allowedValues: See TS 36.211 [12] subclause 6.1.1 for legal values of pci. The number of pci in the list is 1 to 504.</p> | type: Integer<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| plmnIdList | <p>List of unique identities for PLMN.<br/> Note: A cell can broadcast up to 6 PLMN-id's. This is to support the case that one cell can be used by up to 6 operators' core networks. The PLMN(s) included in this list will use the same single tracking area code (tac) and the same Cell Identity (cellLocalId) for sharing the radio access network resources. See TS 36.300 [11] subclause 10.1.7.</p> <p>One member of plmnIdList is the primary PLMN Id. See TS 36.331 [10] subclause 6.2.2: SystemInformationBlockType1/cellAccessRelatedInformation/plmn-IdentityList is a SEQUENCE (SIZE (1..6)).</p> <p>A PLMN Id included in this list cannot be included in the cellAccessInfoList.</p> <p>allowedValues: A list of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC). MCC and MNC are of type string. See TS 23.003 [3] subclause 2.2 and 12.1.</p> | type: PLMNID<br>multiplicity: 1..6<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pMax | <p>This parameter is used to limit the allowed UE uplink transmission power on the serving EUTRA frequency. Value in dBm. Corresponds to parameter p-Max specified in SIB1 and SIB3 in [10].</p> <p>This attribute may be used for RACH Optimization.</p> <p>allowedValues: -30 : 33</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| powerRampingStep | <p>Power increase factor between subsequent random access preamble transmissions. Value in dB. Value dB2 corresponds to 2 dB and so on. Corresponds to parameter powerRampingStep specified in [10] and in [8].</p> <p>This attribute may be used for RACH Optimization.</p> <p>allowedValues: dB0, dB2, dB4, dB6</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| preambleInitialReceivedTargetPower | <p>This parameter denotes the baseline for computation of the transmit power for random access power transmission. Corresponds to parameter preambleInitialReceivedTargetPower specified in [10] and in [8]. Value dBm-120 corresponds to -120 dBm and so on.</p> <p>This attribute may be used for RACH Optimization.</p> <p>allowedValues: dBm-120, dBm-118, dBm-116, dBm-114, dBm-112, dBm-110, dBm-108, dBm-106, dBm-104, dBm-102, dBm-100, dBm-98, dBm-96, dBm-94, dBm-92, dBm-90</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| preambleTransMax | Maximum number of random access preamble transmissions. Corresponds to parameter preambleTransMax specified in [10] and in [8].<br>This attribute may be used for RACH Optimization.<br><br>allowedValues: n3, n4, n5, n6, n7, n8, n10, n20, n50, n100, n200 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qciDscpMappingList | It is a list of mapping between QCI and DSCP, each mapping is a structure including the element QCI and DSCP;<br>Wherein<br>- QCI represents the number of the QCI (Ref. 3GPP TS 23.203[33]);<br>- DSCP represents the DiffServ codepoint (Ref. 3GPP TS 23.207[34] and RFC 2474[35]).<br><br>allowedValues: For QCI, Ref. 3GPP TS 23.203[33];<br>For DSCP, Ref. RFC 2474[35] | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qHyst | Hysteresis value applied to serving cell for evaluating cell ranking criteria. Value in dB.<br>Corresponds to parameter q-Hyst specified in SIB3 in [10] and in [34].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: dB0, dB1, dB2, dB3, dB4, dB5, dB6, dB8, dB10, dB12, dB14, dB16, dB18, dB20, dB22, dB24 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qOffset | Offset applicable to a specific neighbouring cell used for evaluating the cell as a candidate for cell re-selection. Corresponds to parameter q-OffsetCell broadcast in SIB4 for intra-frequency cells and in SIB5 for inter-frequency cells, specified in [10].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: dB-24, dB-22, dB-20, dB-18, dB-16, dB-14, dB-12, dB-10, dB-8, dB-6, dB-5, dB-4, dB-3, dB-2, dB-1, dB0, dB1, dB2, dB3, dB4, dB5, dB6, dB8, dB10, dB12, dB14, dB16, dB18, dB20, dB22, dB24 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qOffsetCdma2000 | Indicates a CDMA2000-specific offset to be applied when evaluating triggering conditions for measurement reporting in connected mode.<br>Corresponds to parameter offsetFreq included in the IE MeasObjectCDMA2000 specified in 3GPP TS 36.331. This value will apply to all CDMA2000 frequencies.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: -15..15 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| qOffsetGeran | Indicates a GERAN-specific offset to be applied when evaluating triggering conditions for measurement reporting in connected mode. Corresponds to parameter offsetFreq included in the IE MeasObjectGERAN specified in 3GPP TS 36.331. . This value will apply to all GERAN frequencies.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: -15..15 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qOffsetUtra | Indicates a UTRA-specific offset to be applied when evaluating triggering conditions for measurement reporting in connected mode. Corresponds to parameter offsetFreq included in the IE MeasObjectUTRA specified in 3GPP TS 36.331. This value will apply to all UTRA frequencies.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: -15..15 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qQualMinUtra | Minimum required received EcIo level on this UTRA FDD carrier. Value in dB. Corresponds to parameter q-QualMin in SIB6 in [10] and in [30]. This attribute applies to all UTRA frequencies.<br>This attribute may be used for Coverage and Capacity Optimization and ICIC.<br><br>allowedValues: -24 :0 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qRxLevMinEUtra<br>Sib1 | Minimum required received RSRP level of a E-UTRA cell for cell selection. Actual value in dBm is obtained by multiplying by 2. Corresponds to parameter q-rxLevMin in SIB1 in [10] and in [34].<br>This attribute may be used for Coverage and Capacity Optimization and ICIC.<br><br>allowedValues: -70 :-22 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qRxLevMinEUtra<br>Sib3 | Minimum required received RSRP level for intra-frequency E-UTRA cell re-selection. Actual value in dBm is obtained by multiplying by 2. Corresponds to parameter q-rxLevMin in SIB3 in [10] and in [34].<br>This attribute may be used for Coverage and Capacity Optimization and ICIC.<br><br>allowedValues: -70 :-22 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| qRxLevMinGeran | Minimum required received RSSI level on a GERAN frequency carrier for re-selection to a GERAN carrier. Actual value in dBm is value * 2 - 115. Corresponds to parameter q-rxLevMin in SIB7 in [10] and to RXLEV_ACCESS_MIN in [31]. This attribute applies to all GERAN frequencies.<br>This attribute may be used for Coverage and Capacity Optimization and ICIC.<br><br>allowedValues: 0 : 63 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| qRxLevMinUtra | Minimum required received RSCP level on a UTRA frequency carrier. Actual value in dBm is obtained by multiplying by 2 plus 1. Corresponds to parameter q-rxLevMin in SIB6 in [10] and in [30]. This attribute applies to all UTRA frequencies. This attribute may be used for Coverage and Capacity Optimization and ICIC.<br><br>allowedValues: -60 :-13 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| referenceSignalPower | This defines the cell specific downlink reference signal transmit power, which is described in 3GPP TS 36.213[25]<br><br>allowedValues: See 3GPP TS 36.331[10] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| relatedAntennaList | This is an attribute to list the DNs of AntennaFunction(s)(see TS 28.662[31]) that support the EUtranGenericCell.<br><br>allowedValues: See 'relatedAntennaList' in Ref. 3GPP TS 28.662 [31] | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| relatedSector | This is an attribute to the DN of SectorEquipmentFunction (see TS 28.662[31]) that support the EUtranGenericCell.<br><br>allowedValues: See 'SectorEquipmentFunction' in Ref. 3GPP TS 28.662 [31]. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| relatedTmaList | This is an attribute to list the DNs of TmaFunction(s) (see TS 28.662[31]) that support the EUtranGenericCell.<br><br>allowedValues: See 'relatedTmaList' in Ref. 3GPP TS 28.662 [31]. | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| responseWindowSize | Denotes the duration of the random access response window. Corresponds to parameter ra-ResponseWindowSize specified in 3GPP TS 36.331 section 6.3.2 and in 3GPP TS 36.321 section 5.1.4. Value sfn corresponds to n subframes.<br><br>This attribute may be used for RACH Optimization.<br><br>allowedValues: sf2, sf3, sf4, sf5, sf6, sf7, sf8,sf10 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rootSequenceIndex | Logical root sequence index used to determine 64 physical RACH preamble sequences available in the cell. Corresponds to RACH_ROOT_SEQUENCE parameter defined in [10] and [12].<br><br>This attribute may be used for RACH Optimization.<br><br>allowedValues: 0 : 837 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br><br>isNullable: False | +| servedRN | This attribute contains the DNs of one or more associated instances of RNFunction and ExternalRNFunction. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| servingCell | This attribute contains the DN of one associated instance of EutranGenericCell or ExternalEutranGenericCell. | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sfAssignment | This is the uplink-downlink subframe configuration number of a TDD E-UTRAN cell.<br><br>allowedValues: See 3GPP TS 36.211[12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sharNetTceMappingInfoList | This attribute includes a list of elements. Each element is a tuple of shared PLMN Id (called "PLMN Target"), TCE ID and the corresponding TCE IP address.<br><br>In case when several PLMNs and Logged MDT are supported, this attribute is used to translate from the TCE IP Address to TCE ID when a Logged MDT is ordered to the UE and to translate the TCE ID to TCE IP address when the UE has sent the log to the network.<br><br>allowedValues: See "Trace Collection Entity Address" and "Trace Collection Entity Id" in 3GPP TS 32.422 [25].<br>The "PLMN Target" shall be one of the PLMNs listed in plmnIdList. | type: <<dataType>><br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sIntraSearch | Threshold for intra-frequency measurements. Actual value in dB is obtained by multiplying by 2. Corresponds to parameter s-IntraSearch specified in SIB3 in [10] and in [34].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0: 31 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sizeOfRAPreamblesGroupA | Size of the random access preamble group A. Corresponds to parameter sizeOfRAP-PreamblesGroup specified in [10] and [8].<br>This attribute may be used for RACH Optimization.<br><br>allowedValues: n4, n8, n12, n16, n20, n24, n28, n32, n36, n40, n44, n48, n52, n56, n60 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| specialSfPatterns | This is the special subframe configuration number of a TDD E-UTRAN cell.<br><br>allowedValues: See 3GPP TS 36.211[12]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tac | Common Tracking Area Code for the PLMNs. The identity used to identify tracking areas.<br><br>allowedValues:<br>a) It is the Tracking Area Code (TAC).<br><br>b) A cell can only broadcast one TAC. See TS 36.300 [11], section 10.1.7 (PLMNID and TAC relation).<br><br>c) TAC is defined in TS 23.003 [3], section 19.4.2.3. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| tceIDMappingInfoList | <p>This attribute includes a list of TCE ID and the corresponding TCE IP address. It is used in Logged MDT case to provide the information to the eNodeB to get the corresponding TCE IP address when there is an MDT log received from the UE.</p> <p>This attribute is used if only one PLMN is supported.</p> <p>allowedValues: See “Trace Collection Entity Address” and “Trace Collection Entity Id” in 3GPP TS 32.422 [30].</p> | type: <<dataType>><br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tCI | <p>This is the Target Cell Identifier. It consists of E-UTRAN Cell Global Identifier (ECGI) and Physical Cell Identifier (PCI) of the target cell.</p> <p>The EUtranRelation.tCI identifies the target cell from the perspective of the EUtranGenericCell, the name-containing instance of the subject EUtranRelation instance.</p> <p>allowedValues: The Target Cell Identifier is defined in TS 36.300 [11]. See TS 36.211 [12] subclause 6.11 for legal values of the PCI.</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeToTriggerEutraA1 | <p>Time during which measurement report triggering condition needs to be met in order to trigger a measurement report for event A1. Maps to the <i>timeToTrigger</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A1. Value ms0 corresponds to 0 miliseconds etc.</p> <p>This attribute may be used for Mobility Robustness Optimization.</p> <p>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeToTriggerEutraA2 | <p>Time during which measurement report triggering condition needs to be met in order to trigger a measurement report for event A2. Maps to the <i>timeToTrigger</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A2. Value ms0 corresponds to 0 miliseconds etc.</p> <p>This attribute may be used for Mobility Robustness Optimization.</p> <p>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeToTriggerEutraA3 | <p>Time during which measurement report triggering condition needs to be met in order to trigger a measurement report for event A3. Maps to the <i>timeToTrigger</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A3. Value ms0 corresponds to 0 miliseconds etc.</p> <p>This attribute may be used for Mobility Robustness Optimization.</p> <p>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120</p> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| timeToTriggerE<br>utraA4 | Time during which measurement report triggering condition needs to be met in order to trigger a measurement report for event A4. Maps to the <i>timeToTrigger</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A4. Value ms0 corresponds to 0 miliseconds etc.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeToTriggerE<br>utraA5 | Time during which measurement report triggering condition needs to be met in order to trigger a measurement report for event A5. Maps to the <i>timeToTrigger</i> IE specified in <i>ReportConfigEUTRA</i> IE in [10] corresponding to event A5. Value ms0 corresponds to 0 miliseconds etc.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeToTriggerI<br>ratB1 | Time during which IRAT measurement report triggering condition needs to be met in order to trigger IRAT measurement report for event B1. Maps to <i>timeToTrigger</i> IE specified in <i>ReportConfigInterRAT</i> IE in [10] corresponding to event B1. Value ms0 corresponds to 0 milliseconds etc.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| timeToTriggerI<br>ratB2 | Time during which IRAT measurement report triggering condition needs to be met in order to trigger IRAT measurement report for event B2. Maps to <i>timeToTrigger</i> IE specified in <i>ReportConfigInterRAT</i> IE in [10] corresponding to event B2. Value ms0 corresponds to 0 milliseconds etc.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: ms0, ms40, ms64, ms80, ms100, ms128, ms160, ms256, ms320, ms480, ms512, ms640, ms1024, ms1280, ms2560, ms5120 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tReselectionCd<br>ma2000 | Cell reselection timer for reselection to a CDMA2000 band. Value in seconds. Corresponds to parameter t-ReselectionCDMA2000 specified in SIB8 in [10] and to TreselecitonCDMA_HRPD or TreselecitonCDMA_1xRTT in [34]<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 :7 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tReselectionEU<br>tra | Cell reselection timer for intra frequency E-UTRA cell reselection. Value in seconds. Corresponds to parameter t-ReselectionEUTRA specified in SIB3 in [10] and in [34].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 :7 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| tReselectionGeran | Cell reselection timer for reselection to a GERAN frequency carrier. Value in seconds. Corresponds to parameter t-ReselectionGERAN specified in SIB7 in [10] and to TreselectionGERA in [34].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 :7 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tReselectionUtra | Cell reselection timer for reselection to a UTRA frequency carrier. Value in seconds. Corresponds to parameter t-ReselectionUTRA specified in SIB6 in [10] and in [34].<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 :7 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| tStoreUeContext | The timer used for detection of too early HO. Corresponds to Tstore_UE_cntxt timer described in [11]. Value in 100 milliseconds.<br>This attribute may be used for Mobility Robustness Optimization.<br><br>allowedValues: 0 :1023 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| wLANGeoLocation | This attribute provides the latitude and longitude of the location of the WLAN.<br><br>allowed values:<br>for latitude: - 90 to 90<br>for longitude: - 180 to 180 | type: <<dataType>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| wLANId | This attribute identifies the WLAN by the BSSID, the SSID, and/or the HESSID (see clause 9.2.7 of TS 36.463 [43]).<br>allowedValues: see the BSSID, SSID, and/or the HESSID in clause 9.2.7 of TS 36.463 [43]. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: Yes<br>defaultValue: None<br>isNullable: False | +| wLANInfoList | This attribute contains a list of WLANInfo, and each WLANInfo includes the following elements:<br>- WLANId<br>This element identifies the WLAN by the BSSID, the SSID, and/or the HESSID (see TS 36.463 [43]).<br><br>- WLANOperationalState<br>This element indicates whether the WLAN is in operation normally or abnormally.<br><br>- EnbWithLWARelation<br>This element identifies the eNB, by the DN, with which the subject WLAN has LWA relation.<br><br>allowedValues: N/A | type: String<br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: No default value<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| x2BlackList | <p>This is a list of DNs of ENBFunction and ExternalENBFunction. If the target node DN is a member of the source node's ENBFunction.x2BlackList, the source node is:</p> <ol style="list-style-type: none"> <li>1) Prohibited from sending X2 connection request to target node;</li> <li>2) Forced to tear down established X2 connection to target node</li> <li>3) Not allowed to accept incoming X2 connection request from target node.</li> </ol> <p>The same DN may appear here and in ENBFunction.x2WhiteList. In such case, the DN in x2WhiteList shall be treated as if it is absent.</p> | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| x2HOBBlackList | <p>This is a list of DNs of ENBFunction and ExternalENBFunction. The ENBFunction.x2HOBBlackList identifies a list of neighbour ENBFunction and ExternalENBFunction with whom the subject ENBFunction is prohibited to use X2 interface for HOs even if the X2 interface exists between them.</p> | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| x2IpAddressList | <p>Represents one or more IP addresses used by ENBFunction for this ENBFunction's X2 Interface</p> <p>allowedValues: One or more IPv4 or IPv6 addresses</p> | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| x2WhiteList | <p>This is a list of DNs of ENBFunction and ExternalENBFunction. If the target node DN is a member of the source node's ENBFunction.x2WhiteList, the source node :</p> <ul style="list-style-type: none"> <li>- Is allowed to request the establishment of X2 connection with the target node;</li> <li>- Is not allowed to initiate the tear down of established X2 connection to target node</li> </ul> <p>The same DN may appear here and in ENBFunction.x2BlackList. In such case, the DN here shall be treated as if it is absent.</p> | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| eutranFrequency | <p>This attribute contains the DN of the referenced EUTraFrequency.</p> <p>allowedValues: N/A</p> | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| multiBandInfoListEutra | <p>It is a list of additional frequency bands the frequency belongs to.</p> <p>allowedValues: { 1..256 }</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This subclause presents a list of notifications, defined in [18], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [37], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|---------------------------------------------|---------------------------------------|-------| +| <code>notifyAckStateChanged</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | +| <code>notifyChangedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | +| <code>notifyClearedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | +| <code>notifyNewAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | +| <code>notifyComments</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | +| <code>notifyAlarmListRebuilt</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | +| <code>notifyPotentialFaultyAlarmList</code> | See Alarm IRP (3GPP TS 32.111-2 [18]) | | + +### 4.5.2 Configuration notifications + +This subclause presents a list of notifications, defined in [32], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [37], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|-----------------------------------------|-----------|-------| +| <code>notifyAttributeValueChange</code> | O | | +| <code>notifyObjectCreation</code> | O | | +| <code>notifyObjectDeletion</code> | O | | + +# Annex A (informative): Notifications during a Cell Outage Compensation + +The following sequence diagrams and table show an example how notifications of IOC `CellOutageCompensationInformation` and other notifications are used to inform an IRPManager about the COC activities. + +The sequence diagrams show the basic event flow, the table gives more details on selected, most relevant, content of the notifications. + +![Flowchart of COC part 1](237b76118be454462fc9b4e96adaa6c7_img.jpg) + +OCI: +`OutageCompensationInformation` + +``` +graph TD; Start{{Cell fails, COC starts}} --> Init["state=cOCAActivating<br/>errorList is empty"]; Init --> Reconf["Reconfigure other cell"]; Reconf --> ReconfSuccess{Reconf successful?}; ReconfSuccess -- No --> AddError["Add other cell to errorList"]; AddError --> OutageCompensated{Outage compensated?}; ReconfSuccess -- Yes --> SendNotif["cell sends notification"]; SendNotif --> OutageCompensated; OutageCompensated -- Yes --> Active["state=cOCActive<br/>OCI sends notification"]; OutageCompensated -- No --> MoreReconf{More reconfigurations?}; MoreReconf -- Yes --> Reconf; MoreReconf -- No --> Active; Active --> End{{Wait for end of Cell outage}} +``` + +The flowchart illustrates the process of Cell Outage Compensation (COC) part 1. It begins with a hexagonal start node labeled "Cell fails, COC starts". This leads to a rectangular process node: "state=cOCAActivating" and "errorList is empty". The next step is a rectangular process node: "Reconfigure other cell". A decision diamond "Reconf successful?" follows. If "No", it goes to a rectangular process node: "Add other cell to errorList", which then leads to the "Outage compensated?" decision diamond. If "Yes", it goes directly to the "Outage compensated?" decision diamond. From "Outage compensated?", if "Yes", it goes to a rectangular process node: "state=cOCActive" and "OCI sends notification", which then leads to a hexagonal end node: "Wait for end of Cell outage". If "No", it goes to a decision diamond "More reconfigurations?". If "Yes", it loops back to the "Reconfigure other cell" node. If "No", it goes to the "state=cOCActive" and "OCI sends notification" process node. + +Flowchart of COC part 1 + +Figure A-1: Sequence diagram of COC, part 1 + +![Flowchart of COC part 2 sequence diagram. It starts with 'Cell outage of compensated cell ends' (hexagon), followed by 'state=cOCDeactivating, errorList is empty' (rectangle). Then 'Reconfigure other cell' (rectangle). A decision 'Reconf successful?' (diamond) follows. If 'No', it goes to 'Add other cell to errorList' (rectangle). If 'Yes', it goes to 'cell sends notification' (rectangle). Both lead to 'Outage compensation removed?' (diamond). If 'Yes', it goes to 'state=cOCDeactive, OCI sends notification' (rectangle). If 'No', it goes to 'More reconfigurations?' (diamond). If 'Yes', it loops back to 'Reconfigure other cell'. If 'No', it goes to 'state=cOCDeactive, OCI sends notification' (rectangle). Finally, 'COC ended' (hexagon).](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +OCI: +OutageCompensationInformation + +``` + +graph TD + Start{{Cell outage of compensated cell ends}} --> Init["state=cOCDeactivating +errorList is empty"] + Init --> Reconf[Reconfigure other cell] + Reconf --> ReconfSuccess{Reconf successful?} + ReconfSuccess -- No --> AddError["Add other cell +to errorList"] + ReconfSuccess -- Yes --> CellNotif["cell sends +notification"] + AddError --> OutageRemoved{Outage compensation removed?} + CellNotif --> OutageRemoved + OutageRemoved -- Yes --> Deactive["state=cOCDeactive +OCI sends notification"] + OutageRemoved -- No --> MoreReconf{More reconfigurations?} + MoreReconf -- Yes --> Reconf + MoreReconf -- No --> Deactive + Deactive --> End{{COC ended}} + +``` + +Flowchart of COC part 2 sequence diagram. It starts with 'Cell outage of compensated cell ends' (hexagon), followed by 'state=cOCDeactivating, errorList is empty' (rectangle). Then 'Reconfigure other cell' (rectangle). A decision 'Reconf successful?' (diamond) follows. If 'No', it goes to 'Add other cell to errorList' (rectangle). If 'Yes', it goes to 'cell sends notification' (rectangle). Both lead to 'Outage compensation removed?' (diamond). If 'Yes', it goes to 'state=cOCDeactive, OCI sends notification' (rectangle). If 'No', it goes to 'More reconfigurations?' (diamond). If 'Yes', it loops back to 'Reconfigure other cell'. If 'No', it goes to 'state=cOCDeactive, OCI sends notification' (rectangle). Finally, 'COC ended' (hexagon). + +Figure A-2: Sequence diagram of COC, part 2 + +Legend for the table: + +Notifications in *italic font* are not directly triggered by COC activities, but help to give a full picture.:Notification content in **bold font** indicates a changed attribute value. + +| Time | Event | Notification | Selected notification content *) | +|------|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| +| T1 | Outage of cell 1. COC is done for this cell. | <i>notifyNewAlarm, originated by EUTranGenericCell instance representing cell 1</i><br><i>notifyAttributeValueChan</i> | <b>notificationId=notiAlCell1</b><br><b>correlatedNotifications={ }</b><br><b>notificationId=COC1</b> | + +| Time | Event | Notification | Selected notification content *) | +|-----------------------------|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | ge of<br>CellOutageCompensationIn<br>formation instance name<br>contained in<br>EUtranGenericCell instance<br>representing cell 1. | correlatedNotifications={ notiAlCell1 };<br>cOCStatus.state = <b>cOCActivating</b><br>cOCStatus.errorList={} | +| T2 | COC reconfigures cell 2 | notifyAttributeValueChan<br>ge of EUtranGenericCell<br>instance representing cell 2 | notificationId=avcCell2comp<br>correlatedNotifications={COC1} | +| T3 | COC reconfigures cell 3 | notifyAttributeValueChan<br>ge of EUtranGenericCell<br>instance representing cell 3 | notificationId= avcCell3comp<br>correlatedNotifications={ COC1} | +| T4 | COC tries to reconfigure<br>cell 4 without success | notifyAttributeValueChan<br>ge of<br>CellOutageCompensationIn<br>formation instance name<br>contained in<br>EUtranGenericCell instance<br>representing cell 1 | notificationId=COC2<br>correlatedNotifications={COC1}<br>cOCStatus.state =<br><b>cOCActivating</b><br>cOCStatus.errorList={cell4} | +| <b>Case: COC successful</b> | | | | +| T5a | COC function decides, that<br>no further actions are<br>necessary. | notifyAttributeValueChan<br>ge of<br>CellOutageCompensationIn<br>formation instance contained in<br>EUtranGenericCell instance<br>representing cell 1 | notificationId=COC5a<br>correlatedNotifications={COC1}<br>cOCStatus.state = <b>cOCActive</b><br>cOCStatus.errorList={cell4} | +| T6a | Outage of cell 1 ends | <i>notifyClearedAlarm, originated by<br/>EUtranGenericCell instance<br/>representing cell 1</i><br><br>notifyAttributeValueChan<br>ge of<br>CellOutageCompensationIn<br>formation instance name<br>contained in<br>EUtranGenericCell instance<br>representing cell 1 | <i>notification Id= clearAlCell1<br/>correlatedNotifications={ notiAlCell1,<br/>COC1}</i><br><br>Notification Id=COC6a<br>correlatedNotifications={COC1, COC5a,<br>clearAlCell1}<br>cOCStatus.state =<br><b>cOCDeactivating</b><br>cOCStatus.errorList={} | +| T7a | COC tries to reconfigure<br>cell 2 without success | In case of unsuccessful<br>reconfiguration:<br>notifyAttributeValueChan<br>ge of<br>CellOutageCompensationIn<br>formation instance name<br>contained in<br>EUtranGenericCell instance<br>representing cell 1 | Notification Id=COC7a<br>correlatedNotifications={COC1, COC5a,<br>COC6a, clearAlCell1}<br>cOCStatus.state=<br><b>cOCDeactivating;</b><br>cOCStatus.errorList ={cell2} | +| T8a | COC reconfigures cell 3 | notifyAttributeValueChan<br>ge of EUtranGenericCell<br>instance representing cell 3<br><br>notifyAttributeValueChan<br>ge of | notification Id= avcCell3decomp<br>correlatedNotifications={ COC1, COC5a,<br>avcCell3comp }<br><br>Notification Id=COC8a<br>correlatedNotifications={COC1, | + +| Time | Event | Notification | Selected notification content *) | +|---------------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | CellOutageCompensationInformation instance name contained in EUTranGenericCell instance representing cell 1. | clearAlCell1}<br>cOCStatus.state= <b>cOCDeactive</b><br>cOCStatus.errorList={cell2} | +| <b>Case: COC not successful</b> | | | | +| T5b | COC function decides, that compensation was not successful | notifyAttributeValueChange of CellOutageCompensationInformation instance name contained in EUTranGenericCell instance representing cell 1 | Notification Id=COC5b<br>correlatedNotifications={COC1}<br>cOCStatus.state= <b>cOCActive</b><br>cOCStatus.errorList={cell4} | +| T6b | Outage of cell 1 ends | <i>notifyClearedAlarm, originated by EUTranGenericCell instance representing cell 1</i><br><br>notifyAttributeValueChange of CellOutageCompensationInformation instance name contained in EUTranGenericCell instance representing cell 1 | <i>notification Id= clearAlCell1<br/>correlatedNotifications={ notiAlCell1, COC1}</i><br><br>Notification Id=COC6b<br>correlatedNotifications={COC1, clearAlCell1}<br>cOCStatus.state= <b>cOCDeactivating</b><br>cOCStatus.errorList={} | +| T7b | COC reconfigures cell 2 | notifyAttributeValueChange of EUTranGenericCell instance representing cell 2 | notification Id= avcCell2decomp<br>correlatedNotifications={COC1, COC5b, avcCell2comp } | +| T8b | COC reconfigures cell 3 | notifyAttributeValueChange of EUTranGenericCell instance representing cell 3<br><br>notifyAttributeValueChange of CellOutageCompensationInformation instance name contained in EUTranGenericCell instance representing cell 1. | notification Id= avcCell3decomp<br>correlatedNotifications={ COC1, COC5b, avcCell3comp }<br><br>Notification Id=COC8b<br>correlatedNotifications={COC1, clearAlCell1}<br>cOCStatus.state= <b>cOCDeactive</b><br>cOCStatus.errorList={} | + +\*) Remarks: + +There may be some content of the correlatedNotifications and/or additionalInformation field, which is not related to COC. This additional content is not shown for better readability and must be kept unchanged by COC. + +NotificationId's are only examples. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2012-11 | | | | | First draft | | 0.1.0 | +| 2012-12 | SA#58 | | | | Presented for information and approval | 0.1.0 | 1.0.0 | +| 2012-12 | | | | | New version after approval | 1.0.0 | 11.0.0 | +| 2013-03 | SA#59 | SP-130048 | 001 | 1 | Rel 11 CR 28658 - Correction of attribute name relatedSector | 11.0.0 | 11.1.0 | +| | | SP-130057 | 002 | 1 | CR R11 28.658 Addition of missing Network Sharing support for MDT | | | +| 2013-06 | SA#60 | SP-130304 | 003 | 1 | Energy saving synchronization with 32.762 | 11.1.0 | 11.2.0 | +| | | | 004 | 2 | Align the link inheritance with 28.622 | | | +| 2013-12 | SA#62 | SP-130614 | 006 | 1 | Add blacklist member | 11.2.0 | 11.3.0 | +| 2014-06 | SA#64 | SP-140359 | 008 | - | remove the feature support statements | 11.3.0 | 11.4.0 | +| 2014-09 | SA#65 | SP-140558 | 009 | - | Align operationalState and other state attribute definitions | 11.4.0 | 11.5.0 | +| 2014-10 | | | | | Automatic upgrade (MCC) | 11.5.0 | 12.0.0 | +| 2014-12 | SA#66 | SP-140798 | 011 | 1 | Add missing OAM support for radio interface based synchronization - Align with TS 36.300 | 12.0.0 | 12.1.0 | +| | | | | | | | | +| 2015-12 | SA#70 | SP-150691 | 013 | 1 | Align id attribute definitions | 12.1.0 | 12.2.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13(MCC) | 12.2.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-06 | SA#72 | SP-160419 | 0016 | 1 | B | Adding NB-IoT cell type attribute in EUtranGenericCell IOC | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-09 | SA#77 | SP-170653 | 0019 | 2 | B | Support E-UTRAN new sharing arrangement | 14.1.0 | +| 2018-01 | SA#78 | SP-170968 | 0020 | 1 | B | Add attribute of E-UTRAN cell IOC to support SON for AAS management | 15.0.0 | +| 2018-06 | SA#80 | SP-180421 | 0021 | 1 | B | Update E-UTRAN IS definitions to support EN-DC management | 15.1.0 | +| 2018-09 | SA#81 | SP-180828 | 0028 | 2 | B | Update E-UTRAN IS definitions to support ng-eNB management | 15.2.0 | +| 2018-09 | SA#81 | SP-180829 | 0030 | 1 | | Changes for EPC CUPS in E-UTRAN NRM | 15.2.0 | +| 2018-09 | SA#81 | SP-180830 | 0031 | - | F | Wrong terminology | 15.2.0 | +| 2018-12 | SA#82 | SP-181156 | 0032 | 1 | F | Update Figure 4.2.1-3 Transport view of E-UTRAN and ng-eNB NRM | 15.3.0 | +| 2018-12 | SA#82 | SP-181156 | 0033 | 1 | B | Add IOC for supporting management of non-collocated LWA | 16.0.0 | +| 2018-12 | SA#82 | SP-181049 | 0035 | 3 | B | Add WLANMobilitySet IOC | 16.0.0 | +| 2019-03 | SA#83 | SP-190124 | 0042 | 1 | B | Enhance ENBFunction for LWIP management | 16.1.0 | +| 2019-03 | SA#83 | SP-190126 | 0043 | 1 | A | Correct PLMN ID List Type in Stage 2 | 16.1.0 | +| 2019-03 | SA#83 | SP-190132 | 0048 | - | A | Resolution of Editor's note | 16.1.0 | +| 2019-03 | SA#83 | SP-190134 | 0049 | 1 | F | Correct PLMN ID data type definition | 16.1.0 | +| 2019-12 | SA#86 | SP-191173 | 0050 | 1 | A | Add missing (E-UTRAN) cell and freq relation | 16.2.0 | +| 2020-07 | SA#88-e | SP-200489 | 0052 | 1 | F | Update NRM attribute definitions | 16.3.0 | +| 2020-12 | SA#90e | SP-201064 | 0054 | - | A | Add missing inheritance diagram for EUtranFrequency and EUtranFreqRelation | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28659/raw.md b/marked/Rel-16/28_series/28659/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..515ec69b0bccfb2eb55593c7060e03780b9db934 --- /dev/null +++ b/marked/Rel-16/28_series/28659/raw.md @@ -0,0 +1,3051 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Foreword ................................................................................................................................................................... | 5 | +| Introduction ............................................................................................................................................................... | 5 | +| 1 Scope.................................................................................................................................................................. | 6 | +| 2 References.......................................................................................................................................................... | 6 | +| 3 Definitions and abbreviations ............................................................................................................................ | 7 | +| 3.1 Definitions ................................................................................................................................................... | 7 | +| 3.2 Abbreviations .............................................................................................................................................. | 7 | +| 4 Solution Set Definitions ..................................................................................................................................... | 8 | +| <b>Annex A (normative): CORBA Solution Set..................................................................................................</b> | <b>9</b> | +| A.0 General.............................................................................................................................................................. | 9 | +| A.1 Architectural features........................................................................................................................................ | 9 | +| A.1.1 Syntax for Distinguished Names.................................................................................................................. | 9 | +| A.1.2 Rules for NRM extensions ........................................................................................................................... | 9 | +| A.1.2.1 Allowed extensions ............................................................................................................................... | 9 | +| A.1.2.2 Extensions not allowed.......................................................................................................................... | 9 | +| A.2 Mapping .......................................................................................................................................................... | 10 | +| A.2.1 General mapping ........................................................................................................................................ | 10 | +| A.2.2 Information Object Class (IOC) mapping................................................................................................... | 10 | +| A.2.2.1 IOC ENBFunction............................................................................................................................... | 10 | +| A.2.2.2 IOC EUtranGenericCell ................................................................................................................. | 11 | +| A.2.2.3 IOC ExternalEUtranGenericCell ........................................................................................... | 12 | +| A.2.2.4 IOC EUtranCellFDD....................................................................................................................... | 12 | +| A.2.2.5 IOC ExternalEUtranCellFDD.................................................................................................. | 12 | +| A.2.2.6 IOC EUtranRelation........................................................................................................................ | 13 | +| A.2.2.7 IOC Link_ENB_ENB .......................................................................................................................... | 14 | +| A.2.2.8 IOC Cdma2000Relation................................................................................................................. | 14 | +| A.2.2.9 IOC ExternalENBFunction............................................................................................................. | 14 | +| A.2.2.10 IOC EUtranCellTDD....................................................................................................................... | 14 | +| A.2.2.11 IOC ExternalEUtranCellTDD.................................................................................................. | 14 | +| A.2.2.12 IOC MCEFunction.............................................................................................................................. | 14 | +| A.2.2.13 IOC MBSFNArea................................................................................................................................ | 15 | +| A.2.2.14 IOC RNFunction ................................................................................................................................ | 15 | +| A.2.2.15 IOC DeNBCapability......................................................................................................................... | 15 | +| A.2.2.16 IOC ExternalRNFunction.............................................................................................................. | 15 | +| A.2.2.17 IOC QciDscpMapping....................................................................................................................... | 15 | +| A.2.2.18 IOC CellOutageCompensationInformation........................................................................... | 16 | +| A.2.2.19 IOC EUtranCellNMCentralizedSON ..................................................................................... | 17 | +| A.2.2.20 IOC WTFunction ............................................................................................................................... | 19 | +| A.2.2.21 IOC EP_Xw ....................................................................................................................................... | 19 | +| A.2.2.22 IOC WLANMobilitySet ................................................................................................................... | 19 | +| A.2.2.23 IOC Link_MCE_ENB ....................................................................................................................... | 19 | +| A.2.2.23 IOC Link_MCE_MME ....................................................................................................................... | 19 | +| A.2.2.23 IOC EUtranFreqRelation.............................................................................................................. | 20 | +| A.2.2.24 IOC EUtranFrequency ................................................................................................................... | 20 | +| A.3 Solution Set definitions.................................................................................................................................... | 21 | +| A.3.1 IDL definition structure.............................................................................................................................. | 21 | +| A.3.2 IDL specification "EUtranNetworkResourcesNRMDefs.idl".................................................................. | 21 | + +| | | | +|-------------------------------|----------------------------------------------|-----------| +| <b>Annex B (normative):</b> | <b>XML Definitions.....</b> | <b>32</b> | +| B.0 | General..... | 32 | +| B.1 | Architectural features..... | 32 | +| B.1.1 | Syntax for Distinguished Names..... | 32 | +| B.2 | Mapping ..... | 32 | +| B.2.1 | General mapping ..... | 32 | +| B.2.2 | Information Object Class (IOC) mapping ..... | 32 | +| B.3 | Solution Set definitions ..... | 33 | +| B.3.1 | XML definition structure ..... | 33 | +| B.3.2 | Graphical Representation ..... | 33 | +| B.3.3 | XML schema "eutranNrm.xsd" ..... | 34 | +| <b>Annex C (informative):</b> | <b>Change history.....</b> | <b>53</b> | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- TS 28.657 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- TS 28.658 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- TS 28.659 Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named E-UTRAN Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning E-UTRAN resources. The E-UTRAN NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the E-UTRAN NRM IRP. + +This Solution Set specification is related to 3GPP TS 28.658 V16.2.X [4]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.153: "Telecommunication management; Integration Reference Point (IRP) technology specific templates, rules and guidelines". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.658: "Telecommunications management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] 3GPP TS 28.623: "Generic network resources Integration Reference Point (IRP); Solution Set (SS) definition". +- [9] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [13] 3GPP TS 28.541: " Management and orchestration of 5G networks; Network Resource Model (NRM); Stage 2 and stage 3". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.600 [3] 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]. + +**XML file:** See definition of [8]. + +**XML document:** See definition of [8]. + +**XML declaration:** See definition of [8]. + +**XML element:** See definition of [8]. + +**empty XML element:** See definition of [8]. + +**XML content (of an XML element):** See definition of [8]. + +**XML start-tag:** See definition of [8]. + +**XML end-tag:** See definition of [8]. + +**XML empty-element tag:** See definition of [8]. + +**XML attribute specification:** See definition of [8]. + +**DTD:** See definition of [8]. + +**XML schema:** See definition of [8]. + +**XML namespace:** See definition of [8]. + +**XML complex type:** See definition of [8]. + +**XML element type:** See definition of [8]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1], TS 32.600 [3], 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]. + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IS | Information Service | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +XSD XML Schema Definition + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP E-UTRAN NRM IRP Solution Set Definitions: + +- 3GPP E-UTRAN NRM IRP CORBA SS (Annex A). +- 3GPP E-UTRAN NRM IRP XML Definitions (Annex B). + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in E-UTRAN NRM IRP: Information Service (TS 28.658 [4]). + +--- + +### A.1 Architectural features + +The overall architectural feature of E-UTRAN Network Resources IRP is specified in 3GPP TS 28.658 [4]. This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [8]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [8]. + +##### A.1.2.1 Allowed extensions + +See clause A.2.1 of [8]. + +##### A.1.2.2 Extensions not allowed + +See clause A.2.1 of [8]. + +### A.2 Mapping + +#### A.2.1 General mapping + +See clause A.2.1 of [8]. + +#### A.2.2 Information Object Class (IOC) mapping + +##### A.2.2.1 IOC `ENBFunction` + +**Mapping from NRM IOC ENBFunction attributes and associations to SS equivalent MOC +ENBFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|-------------------------------------------------------------------------------|---------------------------|----------------------------------------------------------------------| +| eNBId | eNBId | unsignedLong | +| intraANRSwitch | intraANRSwitch | boolean | +| iRATANRSwitch | iRATANRSwitch | boolean | +| x2BlackList | x2BlackList | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReferenceSet | +| x2WhiteList | x2WhiteList | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReferenceSet | +| x2HOBlackList | x2HOBlackList | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReferenceSet | +| x2IpAddressList | x2IpAddressList | genericEUTRANNRMAttributeTypes::<br>ipAddressListType | +| tceIDMappingInfoList | tceIDMappingInfoList | genericEUTRANNRMAttributeTypes::<br>TceIDMappingInfoListType | +| sharNetTceMappingInfoList | sharNetTceMappingInfoList | genericEUTRANNRMAttributeTypes::<br>SharNetTceMappingInfo | +| netListeningRSForRIBS | netListeningRSForRIBS | genericEUTRANNRMAttributeTypes::<br>NetListeningRSForRIBS | +| lWIPSeGWList | lWIPSeGWList | genericEUTRANNRMAttributeTypes::<br>lWIPSeGWListType | +| NOTE: For all conditional qualifiers, see attribute constraints in 28.658 [4] | | | + +##### A.2.2.2 IOC EUtranGenericCell + +##### Mapping from NRM IOC EUtranGenericCell attributes and associations to SS equivalent MOC EUtranGenericCell attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------------------|--------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| cellLocalId | cellLocalId | unsignedShort | +| cellLocalIdList | cellLocalIdList | genericEUTRANRMAAttributeTypes::cellLocalIdListType | +| cellSize | cellSize | genericEUTRANRMAAttributeTypes::cellSizeEnumType | +| plmnIdList | plmnIdList<br>Note: the first plmnId in the SS attribute plmnIdList is the primary PLMN id | genericEUTRANRMAAttributeTypes::plmnIdListType | +| cellAccessInfoList | cellAccessInfoList | genericEUTRANRMAAttributeTypes::cellAccessInfoListType | +| tac | tac | long | +| pci | pci | short | +| pciList | pciList | genericEUTRANRMAAttributeTypes::pciListType | +| maximumTransmissionPower | maximumTransmissionPower | short | +| referenceSignalPower | referenceSignalPower | short | +| pb | pb | short | +| partOfSectorPower | partOfSectorPower | short | +| relatedTmaList | relatedTmaList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| relatedAntennaList | relatedAntennaList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| relatedSector | relatedSector | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| operationalState | operationalState | StateManagementIRPOptConstDefs::OperationalStateTypeOpt | +| administrativeState | administrativeState | StateManagementIRPOptConstDefs::AdministrativeStateTypeOpt | +| availabilityStatus | availabilityStatus | StateManagementIRPOptConstDefs::AvailabilityStatusTypeOpt | +| cellResvInfo | cellResvInfo | genericEUTRANRMAAttributeTypes::cellResvInfoType | +| nbIoTcellFlag | nbIoTcellFlag | genericEUTRANRMAAttributeTypes::yesNoType | +| allowedAccessClasses | allowedAccessClasses | genericEUTRANRMAAttributeTypes::allowedAccessEnumClassesType | +| isChangeForEnergySavingAllowed | isChangeForEnergySavingAllowed | GenericNetworkResourcesIRPSystem::AttributeTypes::yesNoType | + +| <b>IS Attributes</b> | <b>SS Attributes</b> | <b>SS Type</b> | +|-------------------------------------------------------------------------------|----------------------|----------------| +| Note: For all conditional qualifiers, see attribute constraints in 28.658 [4] | | | + +#### A.2.2.3 IOC `ExternalEUTranGenericCell` + +**Mapping from NRM IOC `ExternalEUTranGenericCell` attributes and associations to SS equivalent MOC `ExternalEUTranGenericCell` attributes** + +| <b>IS Attributes</b> | <b>SS Attributes</b> | <b>SS Type</b> | +|----------------------|---------------------------------------------------------------------------------------------------------|------------------------------------------------| +| pci | pci | short | +| plmnIdList | plmnIdList<br>Note: the first plmnId in the SS attribute <code>plmnIdList</code> is the primary PLMN id | genericEUTRANNRMAttributeTypes::plmnIdListType | +| cellLocalId | cellLocalId | unsignedShort | +| eNBId | eNBId | unsignedLong | + +#### A.2.2.4 IOC `EUTranCellFDD` + +**Mapping from NRM IOC `EUTranCellFDD` attributes and associations to SS equivalent MOC `EUTranCellFDD` attributes** + +| <b>IS Attributes</b> | <b>SS Attributes</b> | <b>SS Type</b> | +|----------------------|----------------------|----------------| +| earfcnDl | earfcnDl | short | +| earfcnUl | earfcnUl | short | + +#### A.2.2.5 IOC `ExternalEUTranCellFDD` + +**Mapping from NRM IOC `ExternalEUTranCellFDD` attributes and associations to SS equivalent MOC `ExternalEUTranCellFDD` attributes** + +| <b>IS Attributes</b> | <b>SS Attributes</b> | <b>SS Type</b> | +|----------------------|----------------------|----------------| +| earfcnDl | earfcnDl | short | +| earfcnUl | earfcnUl | short | + +#### A.2.2.6 IOC `EUTranRelation` + +##### Mapping from NRM IOC **EUTranRelation** attributes and associations to SS equivalent MOC **EUTranRelation** attributes + +| IS Attributes | SS Attributes | SS Type | +|-------------------------------------------------------------------------------|------------------------------|-------------------------------------------------------------------| +| id | id | string | +| tCI | tCI | long | +| isRemoveAllowed | isRemoveAllowed | boolean | +| isHOAllowed | isHOAllowed | boolean | +| adjacentCell | adjacentCell | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReference | +| isICICInformationSendAllowed | isICICInformationSendAllowed | boolean | +| isLBAllowed | isLBAllowed | boolean | +| isESCoveredBy | isESCoveredBy | genericEUTRANNRMAttributeTypes::IsEsCoveredByEnumType | +| cellIndividualOffset | cellIndividualOffset | genericEUTRANNRMAttributeTypes::qOffsetEnumType | +| qOffset | qOffset | genericEUTRANNRMAttributeTypes::qOffsetEnumType | +| NOTE: For all conditional qualifiers, see attribute constraints in 28.658 [4] | | | + +#### A.2.2.7 IOC Link\_ENB\_ENB + +None. + +#### A.2.2.8 IOC Cdma2000Relation + +**Mapping from NRM IOC Cdma2000Relation attributes and associations to SS equivalent MOC Cdma2000Relation attributes** + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|---------------------------------------------------------------| +| id | id | string | +| adjacentSector | adjacentSector | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.9 IOC ExternalENBFunction + +**Mapping from NRM IOC ExternalENBFunction attributes and associations to SS equivalent MOC ExternalENBFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|--------------| +| eNBId | eNBId | unsignedLong | + +#### A.2.2.10 IOC EUtranCellTDD + +**Mapping from NRM IOC EUtranCellTDD attributes and associations to SS equivalent MOC EUtranCellTDD attributes** + +| IS Attributes | SS Attributes | SS Type | +|-------------------|-------------------|---------| +| earfcn | earfcn | short | +| sfAssignment | sfAssignment | short | +| specialSfPatterns | specialSfPatterns | short | + +#### A.2.2.11 IOC ExternalEUtranCellTDD + +**Mapping from NRM IOC ExternalEUtranCellTDD attributes and associations to SS equivalent MOC ExternalEUtranCellTDD attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| earfcn | earfcn | short | + +#### A.2.2.12 IOC MCEFunction + +None. + +#### A.2.2.13 IOC MBSFNArea + +**Mapping from NRM IOC MBSFNArea attributes and associations to SS equivalent MOC MBSFNArea attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|------------------------------------------------------------------| +| id | id | string | +| mbsfnAreaId | mbsfnAreaId | short | +| cellIdList | cellIdList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +#### A.2.2.14 IOC `RNFunction` + +**Mapping from NRM IOC `RNFunction` attributes and associations to SS equivalent MOC `RNFunction` attributes** + +| IS Attributes | SS Attributes | SS Type | +|--------------------|--------------------|-------------------------------------------------------------------| +| servingCell | servingCell | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReference | +| candidateDeNBCells | candidateDeNBCells | genericEUTRANNRMAttributeTypes::<br>EcgiListType | + +#### A.2.2.15 IOC `DeNBCapability` + +**Mapping from NRM IOC `DeNBCapability`attributes and associations to SS equivalent MOC `DeNBCapability`attributes** + +| IS Attributes | SS Attributes | SS Type | +|-----------------|-----------------|----------------------------------------------------------------------| +| servedRN | servedRN | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::MOReferenceSet | +| maxNbrRNAllowed | maxNbrRNAllowed | unsignedShort | + +#### A.2.2.16 IOC `ExternalRNFunction` + +None. + +#### A.2.2.17 IOC `QciDscpMapping` + +**Mapping from NRM IOC `QciDscpMapping` attributes and associations to SS equivalent MOC `QciDscpMapping` attributes** + +| IS Attributes | SS Attributes | SS Type | +|--------------------|--------------------|------------------------------------------------------------| +| qciDscpMappingList | qciDscpMappingList | genericEUTRANNRMAttributeTypes::<br>qciDscpMappingListType | + +##### A.2.2.18 IOC CellOutageCompensationInformation + +##### Mapping from NRM IOC CellOutageCompensationInformation attributes and associations to SS equivalent MOC CellOutageCompensationInformation attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|------------------------------|---------------------------------------------------------------------| +| id | id | string | +| cOCStatus | cellOutageCompensationStatus | GenericSONPolicyNRMAttributeTypes::<br>cellOutageCompensationStatus | +| isCOCAAllowed | isCOCAAllowed | Boolean | + +#### A.2.2.19 IOC EUtranCellNMCentralizedSON + +**Mapping from NRM IOC `EUtranCellNMCentralizedSON` attributes and associations to SS equivalent MOC `EUtranCellNMCentralizedSON` attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------------------------|------------------------------------|----------------------------------------------------------------------------| +| id | id | string | +| a1ThresholdRsrp | a1ThresholdRsrp | unsignedShort | +| a1ThresholdRsrq | a1ThresholdRsrq | unsignedShort | +| a2ThresholdRsrp | a2ThresholdRsrp | unsignedShort | +| a2ThresholdRsrq | a2ThresholdRsrq | unsignedShort | +| a3Offset | a3Offset | short | +| a4ThresholdRsrp | a4ThresholdRsrp | unsignedShort | +| a4ThresholdRsrq | a4ThresholdRsrq | unsignedShort | +| a5Threshold1Rsrp | a5Threshold1Rsrp | unsignedShort | +| a5Threshold1Rsrq | a5Threshold1Rsrq | unsignedShort | +| b1ThresholdUltraRscp | b1ThresholdUltraRscp | short | +| b1ThresholdUltraEcN0 | b1ThresholdUltraEcN0 | unsignedShort | +| b1ThresholdGeran | b1ThresholdGeran | unsignedShort | +| b1ThresholdCdma2000 | b1ThresholdCdma2000 | unsignedShort | +| b2Threshold1Rsrp | b2Threshold1Rsrp | unsignedShort | +| b2Threshold1Rsrq | b2Threshold1Rsrq | unsignedShort | +| b2Threshold2UltraRscp | b2Threshold2UltraRscp | short | +| b2Threshold2UltraEcN0 | b2Threshold2UltraEcN0 | unsignedShort | +| b2Threshold2Geran | b2Threshold2Geran | unsignedShort | +| b2Threshold2Cdma2000 | b2Threshold2Cdma2000 | unsignedShort | +| commonChannelPowerOffset | commonChannelPowerOffset | short | +| configurationIndex | configurationIndex | unsignedShort | +| contentionResolutionTimer | contentionResolutionTimer | genericEUTRANRMAAttributeTypes::contentionResolutionTimerEnumType | +| hysteresisEutraA1 | hysteresisEutraA1 | unsignedShort | +| hysteresisEutraA2 | hysteresisEutraA2 | unsignedShort | +| hysteresisEutraA3 | hysteresisEutraA3 | unsignedShort | +| hysteresisEutraA4 | hysteresisEutraA4 | unsignedShort | +| hysteresisEutraA5 | hysteresisEutraA5 | unsignedShort | +| hysteresisIratB1 | hysteresisIratB1 | unsignedShort | +| hysteresisIratB2 | hysteresisIratB2 | unsignedShort | +| numberOfRaPreambles | numberOfRaPreambles | genericEUTRANRMAAttributeTypes::numberOfRaPreamblesEnumType | +| preambleInitialReceivedTargetPower | preambleInitialReceivedTargetPower | genericEUTRANRMAAttributeTypes::preambleInitialReceivedTargetPowerEnumType | +| preambleTransMax | preambleTransMax | genericEUTRANRMAAttributeTypes::preambleTransMaxEnumType | +| pMax | pMax | short | +| powerRampingStep | powerRampingStep | genericEUTRANRMAAttributeTypes::powerRampingStepEnumType | +| qHyst | qHyst | genericEUTRANRMAAttributeTypes::qHystEnumType | + +| IS Attributes | SS Attributes | SS Type | +|-------------------------|-------------------------|----------------------------------------------------------------| +| qOffsetUtra | qOffsetUtra | unsignedShort | +| qOffsetGeran | qOffsetGeran | unsignedShort | +| qOffsetCdma2000 | qOffsetCdma2000 | unsignedShort | +| qQualMinUtra | qQualMinUtra | unsignedShort | +| qRxLevMinEUtraSib1 | qRxLevMinEUtraSib1 | short | +| qRxLevMinEUtraSib3 | qRxLevMinEUtraSib3 | short | +| qRxLevMinGeran | qRxLevMinGeran | unsignedShort | +| qRxLevMinUtra | qRxLevMinUtra | short | +| responseWindowSize | responseWindowSize | genericEUTRANNRMAttributeTypes::responseWindowSizeEnumType | +| rootSequenceIndex | rootSequenceIndex | unsignedShort | +| sIntraSearch | sIntraSearch | unsignedShort | +| sizeOfRAPreamblesGroupA | sizeOfRAPreamblesGroupA | genericEUTRANNRMAttributeTypes::sizeOfRAPreambleGroupAEnumType | +| timeToTriggerEutraA1 | timeToTriggerEutraA1 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| timeToTriggerEutraA2 | timeToTriggerEutraA2 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| timeToTriggerEutraA3 | timeToTriggerEutraA3 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| timeToTriggerEutraA4 | timeToTriggerEutraA4 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| timeToTriggerEutraA5 | timeToTriggerEutraA5 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| timeToTriggerIratB1 | timeToTriggerIratB1 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| timeToTriggerIratB2 | timeToTriggerIratB2 | genericEUTRANNRMAttributeTypes::timeToTriggerEUtraEnumType | +| tReselectionCdma2000 | tReselectionCdma2000 | unsignedShort | +| tReselectionEUtra | tReselectionEUtra | unsignedShort | +| tReselectionGeran | tReselectionGeran | unsignedShort | +| tReselectionUtra | tReselectionUtra | unsignedShort | +| tStoreUeContext | tStoreUeContext | unsignedShort | + +Note: For all conditional qualifiers, see attribute constraints in 28.658 [4] + +#### A.2.2.20 IOC `WTFunction` + +##### Mapping from NRM IOC **WTFunction** attributes and associations to SS equivalent MOC **WTFunction** attributes + +| <b>IS Attributes</b> | <b>SS Attributes</b> | <b>SS Type</b> | +|---------------------------|---------------------------|------------------------------------------------------------------------| +| <code>wLANInfoList</code> | <code>wLANInfoList</code> | GenericNetworkResourcesIRPSystem::<br>AttributeTypes::WLANInfoListType | + +#### A.2.2.21 IOC `EP_Xw` + +None. + +##### A.2.2.22 IOC `WLANMobilitySet` + +##### Mapping from NRM IOC **WLANMobility** attributes and associations to SS equivalent MOC **WLANMobilitySet** attributes + +| <b>IS Attributes</b> | <b>SS Attributes</b> | <b>SS Type</b> | +|----------------------|----------------------|----------------| +| | | | + +#### A.2.2.23 IOC `Link_MCE_ENB` + +None. + +#### A.2.2.23 IOC `Link_MCE_MME` + +None. + +#### A.2.2.23 IOC EUtranFreqRelation + +| IS Attributes | SS Attributes | SS Type | +|----------------------------|----------------------------|-------------------------------------------------| +| cellIndividualOffset | cellIndividualOffset | genericEUTRANRMAAttributeTypes::qOffsetEnumType | +| blackListEntry | blackListEntry | unsignedLong | +| blackListEntryIdleMode | blackListEntryIdleMode | unsignedLong | +| cellReselectionPriority | cellReselectionPriority | unsignedLong | +| cellReselectionSubPriority | cellReselectionSubPriority | unsignedShort | +| pMax | pMax | unsignedLong | +| qOffsetFreq | qOffsetFreq | unsignedLong | +| qQualMin | qQualMin | unsignedLong | +| qRxLevMin | qRxLevMin | unsignedLong | +| threshXHighP | threshXHighP | unsignedLong | +| threshXHighQ | threshXHighQ | unsignedLong | +| threshXLowP | threshXLowP | unsignedLong | +| threshXLowQ | threshXLowQ | unsignedLong | +| tReselectionEutra | tReselectionEutra | unsignedShort | +| tReselectionEutraSfHigh | tReselectionEutraSfHigh | unsignedShort | +| tReselectionEutraSfMedium | tReselectionEutraSfMedium | unsignedShort | +| eUtraFrequencyRef | eUtraFrequencyRef | string | + +#### A.2.2.24 IOC EUtranFrequency + +| IS Attributes | SS Attributes | SS Type | +|------------------------|------------------------|--------------| +| earfcnDL | earfcnDL | unsignedLong | +| multiBandInfoListEutra | multiBandInfoListEutra | unsignedLong | + +## A.3 Solution Set definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the E-UTRAN NRM IRP. + +#### A.3.2 IDL specification "EUtranNetworkResourcesNRMDefs.idl" + +``` +//File:EUtranNetworkResourcesNRMDefs.idl +#ifndef _EUTRANNETWORKRESOURCESNRMDefs_IDL_ +#define _EUTRANNETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#include "EPCResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module EUtranNetworkResourcesNRMDefs +{ + /* + * Definitions for MO class ENBFunction + */ + interface ENBFunction: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ENBFunction"; + // Attribute Names + // + const string intraANRSwitch= "intraANRSwitch"; + const string iRATANRSwitch= "iRATANRSwitch"; + const string eNBId = "eNBId"; + const string x2BlackList= "x2BlackList"; + const string x2WhiteList= "x2WhiteList"; + const string x2HOBlackList= "x2HOBlackList"; + const string x2IpAddressList= "x2IpAddressList"; + const string tceIDMappingInfoList= "tceIDMappingInfoList"; + const string sharNetTceMappingInfoList= "sharNetTceMappingInfoList"; + const string netListeningRSForRIBS= "netListeningRSForRIBS"; + const string lWIPSeGWList = "lWIPSeGWList"; + }; + + /* + * Definitions for MO class RNFunction + */ + interface RNFunction: ENBFunction + { + const string CLASS = "RNFunction"; + // Attribute Names + // + const string servingCell = "servingCell"; + const string candidateDeNBCells = "candidateDeNBCells"; + }; + + /* + * Definitions for MO class DeNBCapability + */ + interface DeNBCapability: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "DeNBCapability"; + // Attribute Names + // + const string servedRN= "servedRN"; + const string maxNbrRNAllowed= "maxNbrRNAllowed"; + }; + + /* + * Definitions for MO class ExternalRNFunction + */ + interface ExternalRNFunction: ExternalENBFunction + { + const string CLASS = "ExternalRNFunction"; + // Attribute Names + // + }; + + /* +``` + +``` + +/* + * Definitions for MO class EUtranGenericCell + */ +interface EUtranGenericCell: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "EUtranGenericCell"; + // Attribute Names + // + const string cellLocalId = "cellLocalId"; + const string cellLocalIdList = "cellLocalIdList"; + const string cellSize = "cellSize"; + const string plmnIdList = "plmnIdList"; + const string cellAccessInfoList = "cellAccessInfoList"; + const string tac = "tac"; + const string pci = "pci"; + const string pciList = "pciList"; + const string operationalState = "operationalState"; + const string administrativeState = "administrativeState"; + const string availabilityStatus = "availabilityStatus"; + const string maximumTransmissionPower = "maximumTransmissionPower"; + const string referenceSignalPower = "referenceSignalPower"; + const string pb = "pb"; + const string partOfSectorPower = "partOfSectorPower"; + const string relatedTmaList = "relatedTmaList"; + const string relatedAntennaList = "relatedAntennaList"; + const string relatedSector = "relatedSector"; + const string allowedAccessClasses = "allowedAccessClasses"; + const string isChangeForEnergySavingAllowed = "isChangeForEnergySavingAllowed"; + const string cellResvInfo = "cellResvInfo"; + const string nbIoTcellFlag = "nbIoTcellFlag"; +}; + +/* + * Definitions for MO class ExternalEUtranGenericCell + */ +interface ExternalEUtranGenericCell: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ExternalEUtranGenericCell"; + // Attribute Names + // + const string pci= "pci"; + const string plmnIdList = "plmnIdList"; + const string cellLocalId = "cellLocalId"; + const string eNBId = "eNBId"; +}; + +/* + * Definitions for MO class EUtranCellFDD + */ +interface EUtranCellFDD: EUtranGenericCell +{ + const string CLASS = "EUtranCellFDD"; + // Attribute Names + // + const string earfcnDl = "earfcnDl"; + const string earfcnUl = "earfcnUl"; +}; + +/* + * Definitions for MO class ExternalEUtranCellFDD + */ +interface ExternalEUtranCellFDD: ExternalEUtranGenericCell +{ + const string CLASS = "ExternalEUtranCellFDD"; + // Attribute Names + // + const string earfcnDl = "earfcnDl"; + const string earfcnUl = "earfcnUl"; +}; + +/* + * Definitions for MO class EUtranCellTDD + */ +interface EUtranCellTDD: EUtranGenericCell +{ + +``` + +``` + const string CLASS = "EUtranCellTDD"; + // Attribute Names + // + const string earfcn = "earfcn"; + const string sfAssignment = "sfAssignment"; + const string specialSfPatterns = "specialSfPatterns"; + + }; + + /* + * Definitions for MO class ExternalEUtranCellTDD + */ + interface ExternalEUtranCellTDD: ExternalEUtranGenericCell + { + const string CLASS = "ExternalEUtranCellTDD"; + // Attribute Names + // + const string earfcn = "earfcn"; + + }; + + /* + * Definitions for MO class EUtranRelation + */ + interface EUtranRelation: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "EUtranRelation"; + // Attribute Names + // + const string id = "id"; + const string tCI = "tCI"; + const string isRemoveAllowed = "isRemoveAllowed"; + const string isHOAllowed = "isHOAllowed"; + const string adjacentCell = "adjacentCell"; + const string isICICInformationSendAllowed = "isICICInformationSendAllowed"; + const string isLBAllowed = "isLBAllowed"; + const string cellIndividualOffset = "cellIndividualOffset"; + const string qOffset = "qOffset"; + + }; + + /* + * Definitions for MO class Link_ENB_ENB + */ + interface Link_ENB_ENB: GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_ENB_ENB"; + // Attribute Names + // + + }; + + /* + * Definitions for MO class Cdma2000Relation + */ + interface Cdma2000Relation:GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "Cdma2000Relation"; + // Attribute Names + // + const string id = "id"; + const string adjacentSector = "adjacentSector"; + + }; + + /* + * Definitions for MO class ExternalENBFunction + */ + interface ExternalENBFunction: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalENBFunction"; + // Attribute Names + // + const string eNBId = "eNBId"; + + }; + + /* + * Definitions for MO class MCEFunction + */ +``` + +``` + + */ + interface MCEFunction: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "MCEFunction"; + // Attribute Names + // + }; + + /* + * Definitions for MO class Link_MCE_ENB + */ + interface Link_MCE_ENB: GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_MCE_ENB"; + // Attribute Names + // + }; + + /* + * Definitions for MO class Link_MCE_MME + */ + interface Link_MCE_MME: GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_MCE_MME"; + // Attribute Names + // + }; + + /* + * Definitions for MO class MBSFNArea + */ + interface MBSFNArea: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "MBSFNArea"; + // Attribute Names + // + const string id = "id"; + const string mbsfnAreaId= "mbsfnAreaId"; + const string cellIdList= "cellIdList"; + }; + + /* + * Definitions for MO class EnergySavingProperties + */ + interface EnergySavingProperties: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "EnergySavingProperties"; + // Attribute Names + // + const string id = "id"; + const string energySavingState= "energySavingState"; + const string energySavingControl= "energySavingControl"; + }; + + /* + * Definitions for MO class CellOutageCompensationInformation + */ + interface CellOutageCompensationInformation: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "CellOutageCompensationInformation"; + // Attribute Names + // + const string id = "id"; + const string cellOutageCompensationStatus = "cellOutageCompensationStatus"; + const string isCOAllowed = + "isCOAllowed"; + }; + + /* + * Definitions for MO class EUtranCellNMCCentralizedSON + */ +``` + +``` +interface EUtranCellNMCentralizedSON: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "EUtranCellNMCentralizedSON"; + // Attribute Names + // + const string id = "id"; + const string a1ThresholdRsrp = "a1ThresholdRsrp"; + const string a1ThresholdRsrq = "a1ThresholdRsrq"; + const string a2ThresholdRsrp = "a2ThresholdRsrp"; + const string a2ThresholdRsrq = "a2ThresholdRsrq"; + const string a3Offset = "a3Offset"; + const string a4ThresholdRsrp = "a4ThresholdRsrp"; + const string a4ThresholdRsrq = "a4ThresholdRsrq"; + const string a5Threshold1Rsrp = "a5Threshold1Rsrp"; + const string a5Threshold1Rsrq = "a5Threshold1Rsrq"; + const string b1ThresholdUtraRscp = "b1ThresholdUtraRscp"; + const string b1ThresholdUtraEcN0 = "b1ThresholdUtraEcN0"; + const string b1ThresholdGeran = "b1ThresholdGeran"; + const string b1ThresholdCdma2000 = "b1ThresholdCdma2000"; + const string b2Threshold1Rsrp = "b2Threshold1Rsrp"; + const string b2Threshold1Rsrq = "b2Threshold1Rsrq"; + const string b2Threshold2UtraRscp = "b2Threshold2UtraRscp"; + const string b2Threshold2UtraEcN0 = "b2Threshold2UtraEcN0"; + const string b2Threshold2Geran = "b2Threshold2Geran"; + const string b2Threshold2Cdma2000 = "b2Threshold2Cdma2000"; + const string commonChannelPowerOffset = "commonChannelPowerOffset"; + const string configurationIndex = "configurationIndex"; + const string contentionResolutionTimer = "contentionResolutionTimer"; + const string hysteresisEutraA1 = "hysteresisEutraA1"; + const string hysteresisEutraA2 = "hysteresisEutraA2"; + const string hysteresisEutraA3 = "hysteresisEutraA3"; + const string hysteresisEutraA4 = "hysteresisEutraA4"; + const string hysteresisEutraA5 = "hysteresisEutraA5"; + const string hysteresisIratB1 = "hysteresisIratB1"; + const string hysteresisIratB2 = "hysteresisIratB2"; + const string numberOfRaPreambles = "numberOfRaPreambles"; + const string preambleInitialReceivedTargetPower = "preambleInitialReceivedTargetPower"; + const string preambleTransMax = "preambleTransMax"; + const string pMax = "pMax"; + const string powerRampingStep = "powerRampingStep"; + const string qHyst = "qHyst"; + const string qOffsetUtra = "qOffsetUtra"; + const string qOffsetGeran = "qOffsetGeran"; + const string qOffsetCdma2000 = "qOffsetCdma2000"; + const string qQualMinUtra = "qQualMinUtra"; + const string qRxLevMinEutraSib1 = "qRxLevMinEutraSib1"; + const string qRxLevMinEutraSib3 = "qRxLevMinEutraSib3"; + const string qRxLevMinGeran = "qRxLevMinGeran"; + const string qRxLevMinUtra = "qRxLevMinUtra"; + const string responseWindowSize = "responseWindowSize"; + const string rootSequenceIndex = "rootSequenceIndex"; + const string sIntraSearch = "sIntraSearch"; + const string sizeOfRAPreamblesGroupA = "sizeOfRAPreamblesGroupA"; + const string timeToTriggerEutraA1 = "timeToTriggerEutraA1"; + const string timeToTriggerEutraA2 = "timeToTriggerEutraA2"; + const string timeToTriggerEutraA3 = "timeToTriggerEutraA3"; + const string timeToTriggerEutraA4 = "timeToTriggerEutraA4"; + const string timeToTriggerEutraA5 = "timeToTriggerEutraA5"; + const string timeToTriggerIratB1 = "timeToTriggerIratB1"; + const string timeToTriggerIratB2 = "timeToTriggerIratB2"; + const string tReselectionCdma2000 = "tReselectionCdma2000"; + const string tReselectionEutra = "tReselectionEutra"; + const string tReselectionGeran = "tReselectionGeran"; + const string tReselectionUtra = "tReselectionUtra"; + const string tStoreUeContext = "tStoreUeContext"; +}; + +/* + * Definitions for MO class EUtranFreqRelation + */ +interface EUtranFreqRelation: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "EUtranFreqRelation"; + // Attribute Names + // + const string cellIndividualOffset = "cellIndividualOffset"; + const string blackListEntry = "blackListEntry"; + const string blackListEntryIdleMode = "blackListEntryIdleMode"; +} +``` + +``` + const string cellReselectionPriority = "cellReselectionPriority"; + const string cellReselectionSubPriority = "cellReselectionSubPriority"; + const string pMax = "pMax"; + const string qOffsetFreq = "qOffsetFreq"; + const string qQualMin = "qQualMin"; + const string qRxLevMin = "qRxLevMin"; + const string threshXHighP = "threshXHighP"; + const string threshXHighQ = "threshXHighQ"; + const string threshXLowP = "threshXLowP"; + const string threshXLowQ = "threshXLowQ"; + const string tReselectionEutra = "tReselectionEutra"; + const string tReselectionEutraSfHigh = "tReselectionEutraSfHigh"; + const string tReselectionEutraSfMedium = "tReselectionEutraSfMedium"; + const string eUtraFrequencyRef = "eUtraFrequencyRef"; +}; + +/* + * Definitions for MO class EUtranFrequency + */ +interface EUtranFrequency: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "EUtranFrequency"; + // Attribute Names + // + const string earfcnDL = "earfcnDL"; + const string multiBandInfoListEutra = "multiBandInfoListEutra"; +}; + +/* + * Definitions for MO class WTFunction + */ +interface WTFunction: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "WTFunction"; + // Attribute Names + // + const string id = "id"; + const string wLANInfoList = "wLANInfoList"; +}; + +/* + * Definitions for MO class EP_Xw + */ +interface EP_Xw: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "EP_Xw"; +}; + +/* + * Definitions for MO class WLANMobilitySet + */ +interface WLANMobilitySet: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "WLANMobilitySet"; + // Attribute Names + // +}; + +/* + * Definitions for MO class MemberWLAN + */ +interface MemberWLAN +{ + const string CLASS = "MemberWLAN"; + // Attribute Names + // + const string wLANId = "memberWlanList"; + const string wLANGeoLocation = "wLANGeoLocation"; + const string isLWASupported = "isLWASupported"; + const string isLWIPSupported = "isLWIPSupported"; +}; + +module genericEUTRANNRMAAttributeTypes +{ + typedef sequence<string> cellLocalIdListType; + + enum CellSizeEnumType +``` + +``` + +{ + verysmall, + small, + medium, + large +}; + +enum AllowedAccessClassesValues +{ + EmergencyCall, + ForPLMNUse, + SecurityServices, + PublicUtilities, + EmergencyServices, + PLMNStaff +}; +typedef sequence < AllowedAccessClassesValues, 6> AllowedAccessClasses + +struct PlmnIdType +{ + // A bounded string of 3 characters representing 3 digits. + string mcc; + // A bounded string of 2 or 3 characters representing 2 or 3 digits. + string mnc; +}; +const short PLMNID_LIST_LENGTH = 6; +typedef sequence<PlmnIdType > plmnIdListType; + +struct CellAccessInfoType +{ + PlmnIdType plmnId; + long tac; + unsigned short cellId; + string managementServiceExposed; +}; +typedef sequence <CellAccessInfoType, 5> cellAccessInfoListType; + +const short NO_OF_PCIS = 504; +typedef sequence<short, NO_OF_PCIS> pciListType; + +typedef sequence<string> ipAddressListType; + +enum CellResvInfoType +{ + reservedCell, + nonReservedCell +}; + +struct QciDscpMappingType +{ + short qci; + short dscp; +}; +typedef sequence<QciDscpMappingType> QciDscpMappingListType; + +struct EcgiType +{ + // A bounded string of 3 characters representing 3 digits. + string mcc; + // A bounded string of 2 or 3 characters representing 2 or 3 digits. + string mnc; + unsigned long eci +}; +typedef sequence <EcgiType> EcgiListType; + +enum isEsCoveredByEnumType +{ + no, + partial, + yes +}; + +enum yesNoType +{ + no, + +``` + +``` + + yes +}; + +struct TceIDMappingInfo +{ + short tceID; + string tceIPAddr; +}; +typedef sequence<TceIDMappingInfo> TceIDMappingInfoListType; + +struct SharNetTceMappingInfo +{ + PlmnIdType plmnId; + short tceID; + string tceIPAddr; +}; +typedef sequence<SharNetTceMappingInfo> SharNetTceMappingInfoListType; + +enum CellOutageCompensationState +{ + cOCActivating, + cOCActive, + cOCDeactivating, + cOCDeactive +}; + +enum qOffsetEnumType +{ + dB-24, + dB-22, + dB-20, + dB-18, + dB-16, + dB-14, + dB-12, + dB-10, + dB-8, + dB-6, + dB-5, + dB-4, + dB-3, + dB-2, + dB-1, + dB0, + dB1, + dB2, + dB3, + dB4, + dB5, + dB6, + dB8, + dB10, + dB12, + dB14, + dB16, + dB18, + dB20, + dB22, + dB24 +}; + +enum contentionResolutionTimerEnumType +{ + sf8, + sf16, + sf24, + sf32, + sf40, + sf48, + sf56, + sf64 +}; + +enum numberOfRaPreamblesEnumType +{ + n4, + n8, +}; +``` + +``` + n12, + n16, + n20, + n24, + n28, + n32, + n36, + n40, + n44, + n48, + n52, + n56, + n60, + n64 +}; + +enum preambleInitialReceivedTargetPowerEnumType +{ + dBm-120, + dBm-118, + dBm-116, + dBm-114, + dBm-112, + dBm-110, + dBm-108, + dBm-106, + dBm-104, + dBm-102, + dBm-100, + dBm-98, + dBm-96, + dBm-94, + dBm-92, + dBm-90 +}; + +enum preambleTransMaxEnumType +{ + n3, + n4, + n5, + n6, + n7, + n8, + n10, + n20, + n50, + n100, + n200 +}; + +enum powerRampingStepEnumType +{ + dB0, + dB2, + dB4, + dB6 +}; + +enum qHystEnumType +{ + dB0, + dB1, + dB2, + dB3, + dB4, + dB5, + dB6, + dB8, + dB10, + dB12, + dB14, + dB16, + dB18, + dB20, + dB22, + dB24 +}; +``` + +``` +enum responseWindowSizeEnumType +{ + sf2, + sf3, + sf4, + sf5, + sf6, + sf7, + sf8, + sf10 +}; + +enum sizeOfRAPreambleGroupAEnumType +{ + n4, + n8, + n12, + n16, + n20, + n24, + n28, + n32, + n36, + n40, + n44, + n48, + n52, + n56, + n60, +}; + +enum timeToTriggerEUTraEnumType +{ + ms0, + ms40, + ms64, + ms80, + ms100, + ms128, + ms160, + ms256, + ms320, + ms480, + ms512, + ms640, + ms1024, + ms1280, + ms2560, + ms5120 +}; + +typedef sequence<string> DnList; + +struct CellOutageCompensationStatus +{ + CellOutageCompensationState cellOutageCompensationState; + DnList errorList; +}; + +struct ReferenceSignalPattern +{ + yesNoType prs_supported; +}; + +enum ReferenceSignalPeriodicity +{ + ms1280, + ms2560, + ms5120, + ms10240 +}; + +const short MAX_CONFIGURATION_NO = 4; +struct NetListeningRefSignalType +{ + ReferenceSignalPattern referenceSignalPattern; + short num_of_crs_ports; +}; +``` + +``` + + ReferenceSignalPeriodicity referenceSignalPeriodicity; + unsigned short referenceSignalOffset; + }; + typedef sequence<NetListeningRefSignalType, MAX_CONFIGURATION_NO> NetListeningRSForRIBS; + + struct WLANInfoType + { + string WLANId; + enum WLANOperationalState + { + Disabled, Enabled + }; + string EnbWithLWARelation; + }; + typedef sequence<WLANInfoType> WLANInfoListType; + + struct GeoLocationType + { + short latitude; + short longitude; + }; + + struct LWIPSeGWInfoType + { + string LWIPSeGWId; + ipAddressListType LWIPSeGWIpAddressList; + }; + typedef sequence<LWIPSeGWInfoType> LWIPSeGWListType; + +}; + +#endif // _EUTRANNETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML Definitions + +## B.0 General + +This annex contains the XML Definitions for the E-UTRAN NRM IRP as it applies to Itf-N, in accordance with UTRAN NRM IRP IS definitions [4]. + +The XML file formats are based on XML [9], XML Schema [10] [11] and XML Namespace [12] standards. + +### --- B.1 Architectural features + +The overall architectural feature of E-UTRAN Network Resources IRP is specified in 3GPP TS 28.658 [4]. This clause specifies features that are specific to the Schema definitions. + +The XML definitions of this document specify the schema for a configuration content. + +When using the XML definitions for a configuration file transfer with the Bulk CM IRP, using either CORBA Solution Set of 3GPP TS 32.616 [7] or SOAP Solution Set of 3GPP TS 32.616 [7], the basic part of the XML file format definition is provided by 3GPP TS 32.616 [7]. The XML definitions of this document provide the schema for the configuration content to be included in such a configuration file. + +When using the XML definitions with a SOAP Solution Set of any Interface IRP that perform operations on managed objects, for example the Basic CM IRP SOAP SS of 3GPP TS 32.606 [6], the XML definitions of this document provides the schema for the configuration content operated on by the interface IRP. Such configuration content can be name of managed object and, if applicable, IOC attributes. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +### --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +#### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [7]. + +Annex B.3.3 of the present document defines the NRM-specific XML schema `eutranNrm.xsd` for the E-UTRAN Network Resources IRP NRM defined in 3GPP TS 28.658 [4]. + +XML schema `eutranNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [7]. + +#### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +#### B.3.3 XML schema "eutranNrm.xsd" + +``` + +<?xml version="1.1" encoding="UTF-8"?> +<!-- + 3GPP TS 28.659 E-UTRAN Network Resource Model IRP + XML schema definition + eutranNrm.xsd +--> +<schema xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:nr="http://www.3gpp.org/ftp/specs/archive/28_series/28.541#nrNrm" + xmlns:en="http://www.3gpp.org/ftp/specs/archive/28_series/28.659#eutranNrm" + xmlns:ngc="http://www.3gpp.org/ftp/specs/archive/28_series/28.541#ngcNrm" + xmlns:epc="http://www.3gpp.org/ftp/specs/archive/28_series/28.709#epcNrm" + xmlns:un="http://www.3gpp.org/ftp/specs/archive/28_series/28.653#utranNrm" + xmlns:gn="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + xmlns:sm="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + xmlns:sp="http://www.3gpp.org/ftp/specs/archive/28_series/28.629#sonPolicyNrm" + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.659#eutranNrm" + elementFormDefault="qualified"> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.541#nrNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.541#ngcNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.709#epcNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.653#utranNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.629#sonPolicyNrm"/> + <complexType name="IpAddressList"> + <sequence> + <element name="ipAddress" type="string" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </complexType> + <simpleType name="EnbId"> + <restriction base="unsignedLong"> + <maxInclusive value="268435455"/> + </restriction> + </simpleType> + <simpleType name="Eci"> + <restriction base="unsignedLong"> + <maxInclusive value="268435455"/> + </restriction> + </simpleType> + <simpleType name="CellLocalId"> + <restriction base="unsignedShort"> + <maxInclusive value="255"/> + </restriction> + </simpleType> + <complexType name="CellLocalIdList"> + <sequence> + <element name="cellLocalId" type="en:CellLocalId" minOccurs="0"/> + </sequence> + </complexType> + <simpleType name="cellSize"> + <restriction base="string"> + <enumeration value="verysmall"/> + <enumeration value="small"/> + <enumeration value="medium"/> + <enumeration value="large"/> + </restriction> + </simpleType> + <simpleType name="allowedAccessClassesElementType"> + <restriction base="string"> + <enumeration value="EmergencyCall"/> + <enumeration value="ForPLMNUse"/> + <enumeration value="SecurityServices"/> + <enumeration value="PublicUtilities"/> + <enumeration value="EmergencyServices"/> + <enumeration value="PLMNStaff"/> + </restriction> + </simpleType> + <complexType name="allowedAccessClassesType"> + <sequence minOccurs="0" maxOccurs="6"> + <element name="allowedAccessClassesElement" type="en:allowedAccessClassesElementType"/> + </sequence> + </complexType> + <complexType name="PLMNId"> + +``` + +``` +<sequence> + <element name="mcc" type="MCC"/> + <element name="mnc" type="MNC"/> +</sequence> +</complexType> +<simpleType name="MCC"> + <restriction base="string"> + <pattern value="[0-9]{3}"/> + </restriction> +</simpleType> +<simpleType name="MNC"> + <restriction base="string"> + <pattern value="[0-9]{3}|[0-9]{2}"/> + </restriction> +</simpleType> +<complexType name="PLMNIdList"> + <sequence> + <element name="pLMNId" type="en:PLMNId" maxOccurs="6"/> + <!-- The first pLMNId of the pLMNIdList is primary PLMN id --> + </sequence> +</complexType> +<complexType name="CellAccessInfo"> + <sequence> + <element name="plmnId" type="en:PLMNId"/> + <element name="tac" type="long"/> + <element name="cellId" type="long"/> + </sequence> +</complexType> + +<complexType name="CellAccessInfoList"> + <sequence> + <element name="cellAccessInfo" type="en:CellAccessInfo" maxOccurs="5"/> + </sequence> +</complexType> + +<complexType name="EcgiList"> + <sequence> + <element name="plmnId" type="en:PLMNId" minOccurs="0"/> + <element name="eci" type="en:Eci" minOccurs="0"/> + </sequence> +</complexType> +<simpleType name="Pci"> + <restriction base="unsignedShort"> + <maxInclusive value="503"/> + <!-- Minimum value is 0, maximum value is 3x167+2=503 --> + </restriction> +</simpleType> +<complexType name="PciList"> + <sequence> + <element name="pci" type="en:Pci" maxOccurs="504"/> + </sequence> +</complexType> +<simpleType name="cellResvInfoType"> + <restriction base="string"> + <enumeration value="reservedCell"/> + <enumeration value="nonReservedCell"/> + </restriction> +</simpleType> +<simpleType name="mbsfnAreaIdType"> + <restriction base="unsignedLong"> + <maxInclusive value="255"/> + </restriction> +</simpleType> +<complexType name="QciDscpMappingType"> + <sequence> + <element name="qci" type="short"/> + <element name="dscp" type="short"/> + </sequence> +</complexType> +<complexType name="QciDscpMappingListType"> + <sequence> + <element name="QciDscpMappingPair" type="en:QciDscpMappingType"/> + </sequence> +</complexType> +<simpleType name="isEsCoveredByEnumType"> + <restriction base="string"> + <enumeration value="no"/> + <enumeration value="partial"/> + </restriction> +</simpleType> +``` + +``` +<enumeration value="yes"/> +</restriction> +</simpleType> +<simpleType name="yesNoType"> + <restriction base="string"> + <enumeration value="yes"/> + <enumeration value="no"/> + </restriction> +</simpleType> +<simpleType name="QOffsetEnumType"> + <restriction base="string"> + <enumeration value="dB-24"/> + <enumeration value="dB-22"/> + <enumeration value="dB-20"/> + <enumeration value="dB-18"/> + <enumeration value="dB-16"/> + <enumeration value="dB-14"/> + <enumeration value="dB-12"/> + <enumeration value="dB-10"/> + <enumeration value="dB-8"/> + <enumeration value="dB-6"/> + <enumeration value="dB-5"/> + <enumeration value="dB-4"/> + <enumeration value="dB-3"/> + <enumeration value="dB-2"/> + <enumeration value="dB-1"/> + <enumeration value="dB0"/> + <enumeration value="dB1"/> + <enumeration value="dB2"/> + <enumeration value="dB3"/> + <enumeration value="dB4"/> + <enumeration value="dB5"/> + <enumeration value="dB6"/> + <enumeration value="dB8"/> + <enumeration value="dB10"/> + <enumeration value="dB12"/> + <enumeration value="dB14"/> + <enumeration value="dB16"/> + <enumeration value="dB18"/> + <enumeration value="dB20"/> + <enumeration value="dB22"/> + <enumeration value="dB24"/> + </restriction> +</simpleType> +<simpleType name="ContentionResolutionTimerEnumType"> + <restriction base="string"> + <enumeration value="sf8"/> + <enumeration value="sf16"/> + <enumeration value="sf24"/> + <enumeration value="sf32"/> + <enumeration value="sf40"/> + <enumeration value="sf48"/> + <enumeration value="sf56"/> + <enumeration value="sf64"/> + </restriction> +</simpleType> +<simpleType name="NumberOfRaPreamblesEnumType"> + <restriction base="string"> + <enumeration value="n4"/> + <enumeration value="n8"/> + <enumeration value="n12"/> + <enumeration value="n16"/> + <enumeration value="n20"/> + <enumeration value="n24"/> + <enumeration value="n28"/> + <enumeration value="n32"/> + <enumeration value="n36"/> + <enumeration value="n40"/> + <enumeration value="n44"/> + <enumeration value="n48"/> + <enumeration value="n52"/> + <enumeration value="n56"/> + <enumeration value="n60"/> + <enumeration value="n64"/> + </restriction> +</simpleType> +<simpleType name="PreambleInitialReceivedTargetPowerEnumType"> + <restriction base="string"> +``` + +``` +<enumeration value="dBm-120"/> +<enumeration value="dBm-118"/> +<enumeration value="dBm-116"/> +<enumeration value="dBm-114"/> +<enumeration value="dBm-112"/> +<enumeration value="dBm-110"/> +<enumeration value="dBm-108"/> +<enumeration value="dBm-106"/> +<enumeration value="dBm-104"/> +<enumeration value="dBm-102"/> +<enumeration value="dBm-100"/> +<enumeration value="dBm-98"/> +<enumeration value="dBm-96"/> +<enumeration value="dBm-94"/> +<enumeration value="dBm-92"/> +<enumeration value="dBm-90"/> +</restriction> +</simpleType> +<simpleType name="PreambleTransMaxEnumType"> + <restriction base="string"> + <enumeration value="n3"/> + <enumeration value="n4"/> + <enumeration value="n5"/> + <enumeration value="n6"/> + <enumeration value="n7"/> + <enumeration value="n8"/> + <enumeration value="n10"/> + <enumeration value="n20"/> + <enumeration value="n50"/> + <enumeration value="n100"/> + <enumeration value="n200"/> + </restriction> +</simpleType> +<simpleType name="PowerRampingStepEnumType"> + <restriction base="string"> + <enumeration value="dB0"/> + <enumeration value="dB2"/> + <enumeration value="dB4"/> + <enumeration value="dB6"/> + </restriction> +</simpleType> +<simpleType name="QHystEnumType"> + <restriction base="string"> + <enumeration value="dB0"/> + <enumeration value="dB1"/> + <enumeration value="dB2"/> + <enumeration value="dB3"/> + <enumeration value="dB4"/> + <enumeration value="dB5"/> + <enumeration value="dB6"/> + <enumeration value="dB8"/> + <enumeration value="dB10"/> + <enumeration value="dB12"/> + <enumeration value="dB14"/> + <enumeration value="dB16"/> + <enumeration value="dB18"/> + <enumeration value="dB20"/> + <enumeration value="dB22"/> + <enumeration value="dB24"/> + </restriction> +</simpleType> +<simpleType name="ResponseWindowSizeEnumType"> + <restriction base="string"> + <enumeration value="sf2"/> + <enumeration value="sf3"/> + <enumeration value="sf4"/> + <enumeration value="sf5"/> + <enumeration value="sf6"/> + <enumeration value="sf7"/> + <enumeration value="sf8"/> + <enumeration value="sf10"/> + </restriction> +</simpleType> +<simpleType name="SizeOfRAPreambleGroupAEnumType"> + <restriction base="string"> + <enumeration value="n4"/> + <enumeration value="n8"/> + <enumeration value="n12"/> + </restriction> +</simpleType> +``` + +``` +<enumeration value="n16"/> +<enumeration value="n20"/> +<enumeration value="n24"/> +<enumeration value="n28"/> +<enumeration value="n32"/> +<enumeration value="n36"/> +<enumeration value="n40"/> +<enumeration value="n44"/> +<enumeration value="n48"/> +<enumeration value="n52"/> +<enumeration value="n56"/> +<enumeration value="n60"/> +</restriction> +</simpleType> +<simpleType name="TimeToTriggerEUtraEnumType"> + <restriction base="string"> + <enumeration value="ms0"/> + <enumeration value="ms40"/> + <enumeration value="ms64"/> + <enumeration value="ms80"/> + <enumeration value="ms100"/> + <enumeration value="ms128"/> + <enumeration value="ms160"/> + <enumeration value="ms256"/> + <enumeration value="ms320"/> + <enumeration value="ms480"/> + <enumeration value="ms512"/> + <enumeration value="ms640"/> + <enumeration value="ms1024"/> + <enumeration value="ms1280"/> + <enumeration value="ms2560"/> + <enumeration value="ms5120"/> + </restriction> +</simpleType> +<simpleType name="ThresholdRsrpRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="97"/> + </restriction> +</simpleType> +<simpleType name="ThresholdRsrqRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="34"/> + </restriction> +</simpleType> +<simpleType name="OffsetRangeType"> + <restriction base="short"> + <minInclusive value="-30"/> + <maxInclusive value="30"/> + </restriction> +</simpleType> +<simpleType name="ThresholdUtraRscpRangeType"> + <restriction base="short"> + <minInclusive value="-5"/> + <maxInclusive value="91"/> + </restriction> +</simpleType> +<simpleType name="ThresholdUtraEcN0RangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="49"/> + </restriction> +</simpleType> +<simpleType name="ThresholdGeranRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="63"/> + </restriction> +</simpleType> +<simpleType name="ThresholdCDMA2000RangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="63"/> + </restriction> +</simpleType> +<simpleType name="CommonChannelPowerOffsetRangeType"> + <restriction base="short"> +``` + +``` +<minInclusive value="-350"/> +<maxInclusive value="150"/> +</restriction> +</simpleType> +<simpleType name="ConfigurationIndexRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="63"/> + </restriction> +</simpleType> +<simpleType name="HysteresisRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="30"/> + </restriction> +</simpleType> +<simpleType name="PMaxRangeType"> + <restriction base="short"> + <minInclusive value="-30"/> + <maxInclusive value="33"/> + </restriction> +</simpleType> +<simpleType name="QOffsetRangeType"> + <restriction base="short"> + <minInclusive value="-15"/> + <maxInclusive value="15"/> + </restriction> +</simpleType> +<simpleType name="QQualMinUtraRangeType"> + <restriction base="short"> + <minInclusive value="-24"/> + <maxInclusive value="0"/> + </restriction> +</simpleType> +<simpleType name="QRxLevMinEUtraRangeType"> + <restriction base="short"> + <minInclusive value="-77"/> + <maxInclusive value="-22"/> + </restriction> +</simpleType> +<simpleType name="QRxLevMinGeranRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="63"/> + </restriction> +</simpleType> +<simpleType name="QRxLevMinUtraRangeType"> + <restriction base="short"> + <minInclusive value="-60"/> + <maxInclusive value="-13"/> + </restriction> +</simpleType> +<simpleType name="RootSequenceIndexRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="837"/> + </restriction> +</simpleType> +<simpleType name="SIntraSearchRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="31"/> + </restriction> +</simpleType> +<simpleType name="TReselectionRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="7"/> + </restriction> +</simpleType> +<simpleType name="TStoreUeContextRangeType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="1023"/> + </restriction> +</simpleType> + +<complexType name="TceIDMappingInfo"> +``` + +``` +<sequence> + <element name="tceID" type="short"/> + <element name="tceIPAddr" type="string"/> +</sequence> +</complexType> +<complexType name="TceIDMappingInfoList"> + <sequence> + <element name="tceIDMappingInfo" type="en:TceIDMappingInfo" minOccurs="0"/> + </sequence> +</complexType> + +<complexType name="SharNetTceMappingInfo"> + <sequence> + <element name="pLMNId" type="en:PLMNId"/> + <element name="tceID" type="short"/> + <element name="tceIPAddr" type="string"/> + </sequence> +</complexType> +<complexType name="SharNetTceMappingInfoList"> + <sequence> + <element name="sharNetTceMappingInfo" type="en:SharNetTceMappingInfo" minOccurs="0"/> + </sequence> +</complexType> + +<simpleType name="cellOutageCompensationState"> + <restriction base="string"> + <enumeration value="cOCActivating"/> + <enumeration value="cOCActive"/> + <enumeration value="cOCDeactivating"/> + <enumeration value="cOCDeactive"/> + </restriction> +</simpleType> +<complexType name="cellOutageCompensationStatus"> + <sequence> + <element name="cellOutageCompensationState" type="en:cellOutageCompensationState"/> + <element name="errorList" type="xn:dnList"/> + </sequence> +</complexType> +<element name="CellOutageCompensationInformation"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes"> + <complexType> + <all> + <element name="cellOutageCompensationStatus" + type="en:cellOutageCompensationStatus"/> + <element name="isCOCAllowed" type="boolean"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<simpleType name="NumOfCRSPorts"> + <restriction base="unsignedShort"> + <minInclusive value="1"/> + <maxInclusive value="2"/> + </restriction> +</simpleType> + +<complexType name="ReferenceSignalPattern"> + <sequence> + <element name="prsSupported" type="en:yesNoType"/> + </sequence> +</complexType> + +<simpleType name="ReferenceSignalPeriodicity"> + <restriction base="string"> + <enumeration value="ms1280"/> + <enumeration value="ms2560"/> + <enumeration value="ms5120"/> + <enumeration value="ms10240"/> + </restriction> +</simpleType> +``` + +``` + +</simpleType> + +<simpleType name="ReferenceSignalOffset"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="10239"/> + </restriction> +</simpleType> + +<complexType name="NetListeningRefSignalType"> + <sequence> + <element name="referenceSignalPattern" type="en:ReferenceSignalPattern"/> + <element name="numOfCRSPorts" type="en:NumOfCRSPorts"/> + <element name="referenceSignalPeriodicity" type="en:ReferenceSignalPeriodicity"/> + <element name="referenceSignalOffset" type="en:ReferenceSignalOffset"/> + </sequence> +</complexType> + +<complexType name="NetListeningRSForRIBS"> + <sequence> + <element name="netListeningRefSignal" type="en:NetListeningRefSignalType" maxOccurs="4"/> + </sequence> +</complexType> + +<simpleType name="WLANOperationalStateType"> + <restriction base="string"> + <enumeration value="enabled"/> + <enumeration value="disabled"/> + </restriction> +</simpleType> + +<complexType name="WLANInfoType"> + <sequence> + <element name="wLANId" type="string"/> + <element name="wLANOperationalState" type="en:WLANOperationalStateType"/> + <element name="enbWithLWARelation" type="xn:dn"/> + </sequence> +</complexType> + +<complexType name="WLANInfoTypeListType"> + <sequence> + <element name="wLANInfo" type="en:WLANInfoType"/> + </sequence> +</complexType> + +<complexType name="GeoLocationType"> + <sequence> + <element name="latitude" type="short"/> + <element name="longitude" type="short"/> + </sequence> +</complexType> + +<complexType name="LWIPSeGWListType"> + <sequence> + <element name="LWIPSeGWId" type="string"/> + <element name="LWIPSeGWIpAddressList" type="en:IpAddressList"/> + </sequence> +</complexType> + +<element name="EUtranCellNMCentralizedSON"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes"> + <complexType> + <all> + <element name="a1ThresholdRsrp" type="en:ThresholdRsrpRangeType" minOccurs="0"/> + <element name="a1ThresholdRsrq" type="en:ThresholdRsrqRangeType" minOccurs="0"/> + <element name="a2ThresholdRsrp" type="en:ThresholdRsrpRangeType" minOccurs="0"/> + <element name="a2ThresholdRsrq" type="en:ThresholdRsrqRangeType" minOccurs="0"/> + <element name="a3Offset" type="en:OffsetRangeType" minOccurs="0"/> + <element name="a4ThresholdRsrp" type="en:ThresholdRsrpRangeType" minOccurs="0"/> + <element name="a4ThresholdRsrq" type="en:ThresholdRsrqRangeType" minOccurs="0"/> + <element name="a5Threshold1Rsrp" type="en:ThresholdRsrpRangeType" minOccurs="0"/> + <element name="a5Threshold1Rsrq" type="en:ThresholdRsrqRangeType" minOccurs="0"/> + + <element name="b1ThresholdUtraRscp" type="en:ThresholdUtraRscpRangeType" +minOccurs="0"/> + +``` + +``` + +minOccurs="0"/> + <element name="b1ThresholdUtraEcN0" type="en:ThresholdUtraEcN0RangeType" +minOccurs="0"/> + <element name="b1ThresholdGeran" type="en:ThresholdGeranRangeType" minOccurs="0"/> + <element name="b1ThresholdCdma2000" type="en:ThresholdCDMA2000RangeType" +minOccurs="0"/> + <element name="b2Threshold1Rsrp" type="en:ThresholdRsrpRangeType" minOccurs="0"/> + <element name="b2Threshold1Rsq" type="en:ThresholdRsqRangeType" minOccurs="0"/> + <element name="b2Threshold2UtraRscp" type="en:ThresholdUtraRscpRangeType" +minOccurs="0"/> + <element name="b2Threshold2UtraEcN0" type="en:ThresholdUtraEcN0RangeType" +minOccurs="0"/> + <element name="b2Threshold2Geran" type="en:ThresholdGeranRangeType" +minOccurs="0"/> + <element name="b2Threshold2Cdma2000" type="en:ThresholdCDMA2000RangeType" +minOccurs="0"/> + <element name="commonChannelPowerOffset" +type="en:CommonChannelPowerOffsetRangeType" minOccurs="0"/> + <element name="configurationIndex" type="en:ConfigurationIndexRangeType" +minOccurs="0"/> + <element name="contentionResolutionTimer" +type="en:ContentionResolutionTimerEnumType" minOccurs="0"/> + <element name="hysteresisEutraA1" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="hysteresisEutraA2" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="hysteresisEutraA3" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="hysteresisEutraA4" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="hysteresisEutraA5" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="hysteresisIratB1" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="hysteresisIratB2" type="en:HysteresisRangeType" minOccurs="0"/> + <element name="numberOfRaPreambles" type="en:NumberOfRaPreamblesEnumType" +minOccurs="0"/> + <element name="preambleInitialReceivedTargetPower" +type="en:PreambleInitialReceivedTargetPowerEnumType" minOccurs="0"/> + <element name="preambleTransMax" type="en:PreambleTransMaxEnumType" +minOccurs="0"/> + <element name="pMax" type="en:PMaxRangeType" minOccurs="0"/> + <element name="powerRampingStep" type="en:PowerRampingStepEnumType" +minOccurs="0"/> + <element name="qHyst" type="en:PreambleInitialReceivedTargetPowerEnumType" +minOccurs="0"/> + <element name="qOffsetUtra" type="en:QOffsetRangeType" minOccurs="0"/> + <element name="qOffsetGeran" type="en:QOffsetRangeType" minOccurs="0"/> + <element name="qOffsetCdma2000" type="en:QOffsetRangeType" minOccurs="0"/> + <element name="qQualMinUtra" type="en:QQualMinUtraRangeType" minOccurs="0"/> + <element name="qRxLevMinEutraSib1" type="en:QRxLevMinEutraRangeType" +minOccurs="0"/> + <element name="qRxLevMinEutraSib3" type="en:QRxLevMinEutraRangeType" +minOccurs="0"/> + <element name="qRxLevMinGeran" type="en:QRxLevMinGeranRangeType" minOccurs="0"/> + <element name="qRxLevMinUtra" type="en:QRxLevMinUtraRangeType" minOccurs="0"/> + <element name="responseWindowSize" type="en:ResponseWindowSizeEnumType" +minOccurs="0"/> + <element name="rootSequenceIndex" type="en:RootSequenceIndexRangeType" +minOccurs="0"/> + <element name="sIntraSearch" type="en:SIntraSearchRangeType" minOccurs="0"/> + <element name="sizeOfRAPreamblesGroupA" type="en:SizeOfRAPreambleGroupAEnumType" +minOccurs="0"/> + <element name="timeToTriggerEutraA1" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="timeToTriggerEutraA2" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="timeToTriggerEutraA3" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="timeToTriggerEutraA4" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="timeToTriggerEutraA5" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="timeToTriggerIratB1" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="timeToTriggerIratB2" type="en:TimeToTriggerEutraEnumType" +minOccurs="0"/> + <element name="tReselectionCdma2000" type="en:TReselectionRangeType" +minOccurs="0"/> + <element name="tReselectionEutra" type="en:TReselectionRangeType" minOccurs="0"/> + <element name="tReselectionGeran" type="en:TReselectionRangeType" minOccurs="0"/> + <element name="tReselectionUtra" type="en:TReselectionRangeType" minOccurs="0"/> + <element name="tStoreUeContext" type="en:TStoreUeContextRangeType" minOccurs="0"/> + </all> +</complexType> + +``` + +``` + + </element> + </sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="ENBFunction" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" minOccurs="0"/> + <element name="intraANRSwitch" type="boolean" minOccurs="0"/> + <element name="iRATANRSwitch" type="boolean" minOccurs="0"/> + <element name="enbId" type="en:EnbId" minOccurs="0"/> + <element name="x2BlackList" type="xn:dnList" minOccurs="0"/> + <element name="x2WhiteList" type="xn:dnList" minOccurs="0"/> + <element name="x2HOBlackList" type="xn:dnList" minOccurs="0"/> + <element name="x2IpAddressList" type="string" minOccurs="0"/> + <element name="tceIDMappingInfoList" type="en:TceIDMappingInfoList" +minOccurs="0"/> + <element name="sharNetTceMappingInfoList" type="en:SharNetTceMappingInfoList" +minOccurs="0"/> + <element name="netListeningRSForRIBS" type="en:NetListeningRSForRIBS" +minOccurs="0"/> + <element name="lWIPSeGWList" type="en:lWIPSeGWListType" minOccurs="0"/> + <!-- linkList attribute is to be added when defined in the IS --> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:EUTranCellFDD"/> + <element ref="en:EUTranCellTDD"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="nn:EP_X2C"/> + <element ref="nn:EP_X2U"/> + <element ref="nn:EP_NgC"/> + <element ref="nn:EP_NgU"/> + <element ref="nn:EP_XnC"/> + <element ref="nn:EP_XnU"/> + <element ref="en:ENBFunctionOptionallyContainedNrmClass"/> + <element ref="en:DeNBCapability"/> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:ESPPolicies"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="RNFunction" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" minOccurs="0"/> + <element name="servingCell" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:EP_RP_EPS"/> + <element ref="en:RNFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + </sequence> + </extension> +</complexContent> +</complexType> +</element> +<element name="DeNBCapability"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" minOccurs="0"/> + <element name="servedRN" type="xn:dnList" minOccurs="0"/> + <element name="maxNbrRNAllowed" type="unsignedShort"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="ExternalRNFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="candidateDeNBCells" type="en:EcgiList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:EP_RP_EPS"/> + <element ref="en:ExternalRNFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="ExternalENBFunction" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="enbId" type="en:EnbId" minOccurs="0"/> + <!-- Attributes are to be added when defined in the IS --> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:ExternalEUTranCellFDD"/> + <element ref="en:ExternalEUTranCellTDD"/> + <element ref="en:ExternalENBFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:InterRatEsPolicies"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + </complexType> + </element> + <element name="EUtranCellFDD"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from EUtranGenericCell--> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cellLocalId" type="en:CellLocalId"/> + <element name="cellLocalIdList" type="en:CellLocalIdList" minOccurs="0"/> + <element name="cellSize" type="en:cellSize"/> + <element name="pLMNIdList" type="en:PLMNIdList"/> + <element name="cellAccessInfoList" type="en:CellAccessInfoList"/> + <element name="tac" type="long"/> + <element name="pci" type="en:Pci"/> + <element name="pciList" type="en:PciList" minOccurs="0"/> + <element name="maximumTransmissionPower" type="short"/> + <element name="partOfSectorPower" type="short" minOccurs="0"/> + <element name="referenceSignalPower" type="short"/> + <element name="pb" type="short"/> + <element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedSector" type="xn:dn" minOccurs="0"/> + <element name="operationalState" type="sm:operationalStateType" minOccurs="0"/> + <element name="administrativeState" type="sm:administrativeStateType" + minOccurs="0"/> + <element name="availabilityStatus" type="sm:availabilityStatusType" + minOccurs="0"/> + <element name="allowedAccessClasses" type="en:allowedAccessClassesType"/> + <element name="cellResvInfo" type="en:cellResvInfoType" minOccurs="0"/> + <element name="nbIoTcellFlag" type="en:yesNoType" minOccurs="0"/> + <element name="isChangeForEnergySavingAllowed" + type="en:yesNoType" minOccurs="0"/> + <element name="ngranCellFlag" type="en:yesNoType" minOccurs="0"/> + <element name="nSSAI" type="nr:nSSAI" minOccurs="0"/> + <!-- End of inherited attributes from EUtranGenericCell --> + <element name="earfcnDl" type="short"/> + <element name="earfcnUl" type="short"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:EUtranRelation"/> + <element ref="en:Cdma2000Relation"/> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranRelation"/> + <element ref="en:EUtranCellFDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:EnergySavingProperties"/> + <element ref="sp:ES Policies"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + <element name="ExternalEUtranCellFDD" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from ExternalEUtranGenericCell--> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="pci" type="en:Pci"/> + <element name="pLMNIdList" type="en:PLMNIdList"/> + <element name="cellAccessInfoList" type="en:CellAccessInfoList"/> + +``` + +``` + + <element name="cellLocalId" type="en:CellLocalId"/> + <element name="enbId" type="en:EnbId" minOccurs="0"/> + <!-- End of inherited attributes from ExternalEUtranGenericCell --> + <element name="earfcnDl" type="short"/> + <element name="earfcnUl" type="short"/> + </all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:ExternalEUtranCellFDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +<choice minOccurs="0"> + <element ref="en:CellOutageCompensationInformation"/> +</choice> +<choice minOccurs="0" maxOccurs="1"> + <element ref="sp:InterRatEsPolicies"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="EUtranCellTDD"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from EUtranGenericCell--> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="cellLocalId" type="en:CellLocalId"/> + <element name="cellLocalIdList" type="en:CellLocalIdList" minOccurs="0"/> + <element name="cellSize" type="en:cellSize"/> + <element name="pLMNIdList" type="en:PLMNIdList"/> + <element name="cellAccessInfoList" type="en:CellAccessInfoList"/> + + <element name="tac" type="long"/> + <element name="pci" type="en:Pci" /> + <element name="pciList" type="en:PciList" minOccurs="0"/> + <element name="maximumTransmissionPower" type="short"/> + <element name="partOfSectorPower" type="short" minOccurs="0"/> + <element name="referenceSignalPower" type="short"/> + <element name="pb" type="short"/> + <element name="relatedTmaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedAntennaList" type="xn:dnList" minOccurs="0"/> + <element name="relatedSector" type="xn:dn" minOccurs="0"/> + <element name="operationalState" type="sm:operationalStateType" minOccurs="0"/> + <element name="administrativeState" type="sm:administrativeStateType" + minOccurs="0"/> + <element name="availabilityStatus" type="sm:availabilityStatusType" + minOccurs="0"/> + <element name="allowedAccessClasses" type="en:allowedAccessClassesType"/> + <element name="cellResvInfo" type="en:cellResvInfoType" minOccurs="0"/> + <element name="nbIoTcellFlag" type="en:yesNoType" minOccurs="0"/> + <element name="isChangeForEnergySavingAllowed" + type="en:yesNoType" minOccurs="0"/> + <element name="ngranCellFlag" type="en:yesNoType" minOccurs="0"/> + <element name="nSSAI" type="nr:nSSAI" minOccurs="0"/> + <!-- End of inherited attributes from EUtranGenericCell --> + <element name="earfcn" type="short"/> + <element name="sfAssignment" type="short"/> + <element name="specialSfPatterns" type="short"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:EUtranRelation"/> + <element ref="en:Cdma2000Relation"/> + <element ref="gn:GsmRelation"/> + <element ref="un:UtranRelation"/> + <element ref="en:EUtranCellTDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:EnergySavingProperties"/> + <element ref="sp:ES Policies"/> + </choice> + <choice minOccurs="0"> + <element ref="en:CellOutageCompensationInformation"/> + </choice> + </sequence> + </extension> + </complexContent> +</complexType> +</element> +<element name="ExternalEUtranCellTDD" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from ExternalEUtranGenericCell--> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> +<element name="pci" type="en:Pci"/> + <element name="pLMNIdList" type="en:PLMNIdList"/> + <element name="cellLocalId" type="en:CellLocalId"/> + <element name="enbId" type="en:EnbId" minOccurs="0"/> + <!-- End of inherited attributes from ExternalEUtranGenericCell --> + <element name="earfcn" type="short"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:ExternalEUtranCellTDDOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:InterRatEsPolicies"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="EUtranRelation"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="tCI" type="long" minOccurs="0"/> + <element name="isRemoveAllowed" type="boolean" minOccurs="0"/> + <element name="isHOAllowed" type="boolean" minOccurs="0"/> + <element name="isICICInformationSendAllowed" type="boolean" minOccurs="0"/> + <element name="isLBAAllowed" type="boolean" minOccurs="0"/> + <element name="adjacentCell" type="xn:dn"/> + <element name="isEsCoveredBy" type="en:isEsCoveredByEnumType" minOccurs="0"/> + <element name="cellIndividualOffset" type="en:QOffsetEnumType" minOccurs="0"/> + <element name="qOffset" type="en:QOffsetEnumType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:EUtranRelationOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="Cdma2000Relation"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + +``` + +``` + +<sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="adjacentSector" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:Cdma2000RelationOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="Link_ENB_ENB" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from Link --> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + <!-- End of inherited attributes from Link --> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:Link_ENB_ENBOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="MCEFunction" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" minOccurs="0"/> + <!-- Attributes are to be added when defined in the IS --> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:MCEFunctionOptionallyContainedNrmClass"/> + <element ref="en:MBSFNArea"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="MBSFNArea" > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + +``` + +``` +<element name="mbsfnAreaId" type="en:mbsfnAreaIdType" minOccurs="0"/> +<element name="cellIdList" type="xn:dnList" minOccurs="0"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> +<element ref="en:MBSFNAreaOptionallyContainedNrmClass"/> +<element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="Link_MCE_ENB" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> +<complexType> +<complexContent> +<extension base="xn:NrmClass"> +<sequence> +<element name="attributes" minOccurs="0"> +<complexType> +<all> +<!-- Inherited attributes from Link --> +<element name="aEnd" type="xn:dn" minOccurs="0"/> +<element name="linkType" type="xn:linkType" minOccurs="0"/> +<element name="protocolName" type="string" minOccurs="0"/> +<element name="protocolVersion" type="string" minOccurs="0"/> +<element name="userLabel" type="string" minOccurs="0"/> +<element name="zEnd" type="xn:dn" minOccurs="0"/> +<!-- End of inherited attributes from Link --> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> +<element ref="en:Link_MCE_ENBOptionallyContainedNrmClass"/> +<element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="Link_MCE_MME" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> +<complexType> +<complexContent> +<extension base="xn:NrmClass"> +<sequence> +<element name="attributes" minOccurs="0"> +<complexType> +<all> +<!-- Inherited attributes from Link --> +<element name="aEnd" type="xn:dn" minOccurs="0"/> +<element name="linkType" type="xn:linkType" minOccurs="0"/> +<element name="protocolName" type="string" minOccurs="0"/> +<element name="protocolVersion" type="string" minOccurs="0"/> +<element name="userLabel" type="string" minOccurs="0"/> +<element name="zEnd" type="xn:dn" minOccurs="0"/> +<!-- End of inherited attributes from Link --> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> +<element ref="en:Link_MCE_MMEOptionallyContainedNrmClass"/> +<element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="QciDscpMapping" +substitutionGroup="en:RNFunctionOptionallyContainedNrmClass" +> +<complexType> +<complexContent> +<extension base="xn:NrmClass"> +``` + +``` + + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="QciDscpMappingList" type="en:QciDscpMappingListType"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> +</complexContent> +</complexType> +</element> + +<element name="EUtranFreqRelation"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from ManagedFunction --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" +minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" +minOccurs="0"/> + <element name="priority" type="integer" minOccurs="0"/> + <element name="measurements" type="xn:MeasurementTypesAndGPsList" +minOccurs="0"/> + <!--End of inherited attributes from ManagedFunction --> + <element name="cellIndividualoffset" type="nr:qOffsetRangeList"/> + <element name="blackListEntry" type="nr:blackListEntry" minOccurs="0"/> + <element name="blackListEntryIdleMode" type="nr:blackListEntryIdleMode" +minOccurs="0"/> + <element name="cellReselectionPriority" type="nr:cellReselectionPriority"/> + <element name="cellReselectionSubPriority" +type="nr:cellReselectionSubPriority"/> + <element name="pMax" type="nr:PMaxRangeType" minOccurs="0"/> + <element name="qOffsetFreq" type="nr:qOffsetFreq" minOccurs="0"/> + <element name="qQualMin" type="nr:qQualMin" minOccurs="0"/> + <element name="qRxLevMin" type="nr:qRxLevMin" minOccurs="0"/> + <element name="threshXHighP" type="nr:threshxhighp" minOccurs="0"/> + <element name="threshXHighQ" type="nr:threshxhighq" minOccurs="0"/> + <element name="threshXLowP" type="nr:threshxlownp" minOccurs="0"/> + <element name="threshXLowQ" type="nr:threshxlownq" minOccurs="0"/> + <element name="tReselectionEutran" type="nn:Treselecionnr" minOccurs="0"/> + <element name="tReselectionEutranSfHigh" type="nn:Treselecionnrshigh" +minOccurs="0"/> + <element name="tReselectionEutranSfMedium" type="nn:Treselecionnrsmfmedium" +minOccurs="0"/> + <element name="eUtranFrequencyRef" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:MeasurementControl"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:EnergySavingProperties"/> + <element ref="sp:ESPolicies"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EUtranFrequency" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + +``` + +``` + +<complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from ManagedFunction --> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" +minOccurs="0"/> + <element name="peeParametersList" type="xn:peeParametersListType" +minOccurs="0"/> + <element name="priority" type="integer" minOccurs="0"/> + <element name="measurements" type="xn:MeasurementTypesAndGPsList" +minOccurs="0"/> + <!--End of inherited attributes from ManagedFunction --> + <element name="earfcnDl" type="short"/> + <element name="multiFrequencyBandListEutra" type="nn:MultifrequencyBandlistnr" +minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + <choice minOccurs="0" maxOccurs="1"> + <element ref="sp:EnergySavingProperties"/> + <element ref="sp:ESPPolicies"/> + </choice> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:MeasurementControl"/> + </choice> + </sequence> + </extension> + </complexContent> +</complexType> +</element> +<element name="WTFunction" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="wLANInfoList" type="en:WLANInfoListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:WTFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EP_Xw"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="farEndEntity" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:EP_xwOptionallyContainedNrmClass"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + + </extension> + </complexContent> +</complexType> +</element> + +<element name="WLANMobilitySet" substitutionGroup="en:ENBFunctionOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="en:WLANMobilitySetOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="MemberWLAN" substitutionGroup="en:WLANMobilitySetOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="wLANId" type="string"/> + <element name="wLANGeoLocation" type="en:GeoLocationType" minOccurs="0"/> + <element name="isLWASupported" type="boolean"/> + <element name="isLWIPSupported" type="boolean"/> + </all> + </complexType> + </element> + </complexContent> + </complexType> +</element> + +<!-- The element definition for EP_RP_EPS is available through +the epcNrm.xsd (3GPP TS 28.709), by using epc:EP_RP_EPS --> +<element name="ENBFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ExternalENBFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="EUtranCellFDDOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ExternalEUtranCellFDDOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="EUtranCellTDDOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ExternalEUtranCellTDDOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="EUtranRelationOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Cdma2000RelationOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_ENB_ENBOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="MCEFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_MCE_ENBOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_MCE_MMEOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="MBSFNAreaOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="RNFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ExternalRNFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="WTFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="EP_xwOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="WLANMobilitySetOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 03-2013 | SA#59 | SP-130048 | 001 | 1 | Correction of attribute name relatedSector | 11.0.0 | 11.1.0 | +| | | SP-130057 | 002 | - | Alignment with 28.658: Addition of missing Network Sharing support for MDT | | | +| 06-2013 | SA#60 | SP-130304 | 003 | 1 | Energy saving synchronization with 32.766 | 11.1.0 | 11.2.0 | +| 12-2013 | SA#62 | SP-130614 | 005 | 1 | Add blacklist member | 11.2.0 | 11.3.0 | +| 06-2014 | SA#64 | SP-140332 | 006 | - | upgrade XSD | 11.3.0 | 11.4.0 | +| | | SP-140332 | 007 | 1 | Add the missing attribute cellResvInfo in IDL specification | | | +| | | SP-140359 | 008 | - | remove the feature support statements | | | +| 09-2014 | SA#65 | SP-140560 | 009 | - | Update the link from Solution Set to Information Service due to the end of Release 12 | 11.4.0 | 12.0.0 | +| 12-2014 | SA#66 | SP-140797 | 011 | - | Remove obsolete EUtranRelationSon - Align with 28.658 | 12.0.0 | 12.1.0 | +| | | SP-140798 | 012 | - | Add missing OAM support for radio interface based synchronization - Align with TS 36.300 | | | +| 12-2015 | SA#70 | SP-150691 | 014 | 1 | Align id attribute definitions | 12.1.0 | 12.2.0 | +| 01-2016 | SA#70 | | | | Upgrade to Rel-13 (MCC) | 12.2.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-06 | SA#72 | SP-160419 | 0016 | 1 | B | Adding NB-IoT cell type attribute in EUTranGenericCell IOC – Align with IS | 13.1.0 | +| 2016-06 | SA#72 | SP-160407 | 0017 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0018 | - | F | Update link from IRP SS to IS | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0019 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2017-09 | SA#77 | SP-170653 | 0020 | 2 | B | Support E-UTRAN sharing enhancement | 14.2.0 | +| 2018-01 | SA#78 | SP-170968 | 0021 | - | B | Adding attribute of IOC EUTranGenericCell to support SON for AAS deployment management | 15.0.0 | +| 2018-03 | SA#79 | SP-180060 | 0022 | - | B | Add attribute peeParametersList to solution set definitions | 15.1.0 | +| 2018-09 | SA#81 | SP-180828 | 0025 | - | B | Update E-UTRAN SS definitions to support ng-eNB management | 15.2.0 | +| 2018-12 | SA#82 | SP-181049 | 0026 | 1 | B | Add IOC for supporting management of non-collocated LWA | 16.0.0 | +| 2018-12 | SA#82 | SP-181049 | 0027 | 2 | B | Add WLANMobilitySet IOC | 16.0.0 | +| 2019-03 | SA#83 | SP-190124 | 0033 | 1 | B | Enhance ENBFunction for LWIP management | 16.1.0 | +| 2019-03 | SA#83 | SP-190126 | 0034 | - | A | Correct PLMN ID Type in Solution Set Stage 3 | 16.1.0 | +| 2019-12 | SA#86 | SP-191173 | 0037 | - | A | Update XML solution set to support EUTRAN frequency relation | 16.2.0 | +| 2019-12 | SA#86 | SP-191173 | 0038 | 1 | A | Add missing stage 3 CORBA/IDL solution | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28661/raw.md b/marked/Rel-16/28_series/28661/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e255252d6fac7e1c16e4c3f4d5326a741e71bbdc --- /dev/null +++ b/marked/Rel-16/28_series/28661/raw.md @@ -0,0 +1,128 @@ + + + + + + +# Contents + +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 6 +- 4 Requirements ..... 6 +- Annex A (informative): Change history..... 7 + +# Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.661 Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Requirements** +- 28.662 Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS) +- 28.663 Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Solution Set (SS) definitions + +# 1 Scope + +The present document defines, in addition to the requirements defined in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TS 32.600 [4], the Requirements for the common and generic radio access network equipments that may be shared between BSS in GSM, UTRAN and E-UTRAN. + +The present document can be used also for managing the equipment that can be shared by several RATs, even in the cases when it is not being shared. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [6] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [7] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [8] 3GPP TS 25.106: "UTRA repeater radio transmission and reception". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.150 [5], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 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 TS 32.150 [5], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TR 21.905 [1], in this order. + +## 3.2 Abbreviations + +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]. + +| | | +|-----|------------------------| +| BSS | Base Station Subsystem | +|-----|------------------------| + +| | | +|---------|--------------------------------------------| +| CAPEX | Capital Expenditure | +| E-UTRAN | Evolved UTRAN | +| GSM | Global System for Mobile communications | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | +| RAN | Radio Access Network | +| RAT | Radio Access Technology | +| UTRAN | Universal Terrestrial Radio Access Network | + +# --- 4 Requirements + +It is common that operators operate more than one RAT. To save CAPEX, some radio equipment can be shared between the different RATs. Radio equipment can also be shared within a RAT. This NRM makes it easy to operate such shared radio equipment and to understand the consequences in all affected RATs when a change is made in a shared equipment. + +The following general and high-level requirement applies for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [2]. +- b) IRP-related requirements in 3GPP TS 32.102 [3]. +- c) IRP-related requirements in 3GPP TS 32.600 [4]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [6] and its information is derived from FNIM Umbrella Information Model (UIM) [7] + +In addition, the following more specific requirements apply: + +**REQ-GRAN\_NRM-CON-001:** The NRM defined by this IRP shall contain IOCs and related definitions, supporting equipment that may be shared between BSS, UTRAN and E-UTRAN networks. + +**REQ-GRAN\_NRM-CON-002:** The IRPAgent shall support a capability allowing the IRPManager to know which RATs are served by each managed object. + +**REQ-GRAN\_NRM-CON-003:** The IRPAgent shall support a capability allowing the IRPManager to perform basic configuration and retrieve inventory information of repeater (see 3GPP TS 25.106 [8]). + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------|-----|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2013-09 | SA#61 | SP-130433 | 001 | 3 | Add missing Repeater Object requirements definitions | F | 11.0.0 | 11.1.0 | +| 2014-06 | SA#64 | SP-140359 | 002 | - | remove the feature support statements | F | 11.1.0 | 11.2.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.2.0 | 12.0.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | 14.0.0 | + +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +|---------|---------|------|----|-----|-----|---------------------------------|-------------| +| 2018-06 | | | | | | Upgrade to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28662/07b17a620c75522d53916a11e12d1bff_img.jpg b/marked/Rel-16/28_series/28662/07b17a620c75522d53916a11e12d1bff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d79f10b0499c20f55c5e07dc4a7e93f27f3bed18 --- /dev/null +++ b/marked/Rel-16/28_series/28662/07b17a620c75522d53916a11e12d1bff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f72d7fb90beead2ce8d36a0f8e3443bd8074f5ed6856284fd01268941e25f4a4 +size 14304 diff --git a/marked/Rel-16/28_series/28662/1c94fd3cebf58af136144f14160d128e_img.jpg b/marked/Rel-16/28_series/28662/1c94fd3cebf58af136144f14160d128e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fce2dc5389cee9581adcc26082a7629b51a8935e --- /dev/null +++ b/marked/Rel-16/28_series/28662/1c94fd3cebf58af136144f14160d128e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5b1f1c0c535a566fd00862cdc6e72af3e839d15b95d91bbb2f99c6a1b14ad4f +size 30394 diff --git a/marked/Rel-16/28_series/28662/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/28_series/28662/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f19314ce56ec144929c20ed48fd9ea6724018519 --- /dev/null +++ b/marked/Rel-16/28_series/28662/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:97d6471de22cda09034075c8673510878b1730363894ea8842a6411e77191c44 +size 24985 diff --git a/marked/Rel-16/28_series/28662/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-16/28_series/28662/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6da86ee59a6ff540100334c76ced7b0e19694638 --- /dev/null +++ b/marked/Rel-16/28_series/28662/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20a4455858e74bbef1ec5f4abf4c78887c969696f3a39ad88e720ae1a15c0dda +size 18849 diff --git a/marked/Rel-16/28_series/28662/c9d8a18a6137ad054b841d7a614afb48_img.jpg b/marked/Rel-16/28_series/28662/c9d8a18a6137ad054b841d7a614afb48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2baff59abc46427c70a9b05826142016b381a8e --- /dev/null +++ b/marked/Rel-16/28_series/28662/c9d8a18a6137ad054b841d7a614afb48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dda59e27252934284c3b1ff734b848cc94c8818a4609b12d59e357582289398c +size 15655 diff --git a/marked/Rel-16/28_series/28662/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg b/marked/Rel-16/28_series/28662/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..83fc8b09e3d94d8ced64f319336a01772fd59c71 --- /dev/null +++ b/marked/Rel-16/28_series/28662/ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18a8426c7abdbf4a1d9cab0b0e69bc078e9646fc3004950ecb8816ccc0210155 +size 59675 diff --git a/marked/Rel-16/28_series/28662/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/28_series/28662/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..64ef5bd90380011eca99378955772f5c3401fb8f --- /dev/null +++ b/marked/Rel-16/28_series/28662/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9938334481b0b37c1d0b46bfe668e98e931aeba5b23d498c7f25dedb527acf8 +size 25429 diff --git a/marked/Rel-16/28_series/28662/raw.md b/marked/Rel-16/28_series/28662/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5f16cbe9067931900b8a19d560770e6606bda8ae --- /dev/null +++ b/marked/Rel-16/28_series/28662/raw.md @@ -0,0 +1,801 @@ + + + + +Error! No +text of + +Error! No text of specified style in +the document. + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 7 | +| 4.1 Imported information entities and local labels..... | 7 | +| 4.2 Class diagrams..... | 7 | +| 4.2.1 Relationships ..... | 7 | +| 4.2.2 Inheritance ..... | 8 | +| 4.3 Class definitions ..... | 9 | +| 4.3.1 SectorEquipmentFunction..... | 9 | +| 4.3.1.1 Definition ..... | 9 | +| 4.3.1.2 Attributes ..... | 9 | +| 4.3.1.3 Attribute constraints..... | 9 | +| 4.3.1.4 Notifications..... | 10 | +| 4.3.2 AntennaFunction ..... | 10 | +| 4.3.2.1 Definition ..... | 10 | +| 4.3.2.2 Attributes ..... | 10 | +| 4.3.2.3 Attribute constraints..... | 10 | +| 4.3.2.4 Notifications..... | 10 | +| 4.3.3 TMAFunction..... | 11 | +| 4.3.3.1 Definition ..... | 11 | +| 4.3.3.2 Attributes ..... | 11 | +| 4.3.3.3 Attribute Constraints..... | 11 | +| 4.3.3.4 Notifications..... | 11 | +| 4.3.4 GSMCellPart..... | 12 | +| 4.3.4.1 Definition ..... | 12 | +| 4.3.4.2 Attributes ..... | 12 | +| 4.3.4.3 Attribute constraints..... | 12 | +| 4.3.4.4 Notifications..... | 12 | +| 4.3.5 CommonBsFunction..... | 12 | +| 4.3.5.1 Definition ..... | 12 | +| 4.3.5.2 Attributes ..... | 12 | +| 4.3.5.3 Attribute constraints..... | 12 | +| 4.3.5.4 Notifications..... | 13 | +| 4.3.6 CellReferences..... | 13 | +| 4.3.6.1 Definition ..... | 13 | +| 4.3.6.2 Attributes ..... | 13 | +| 4.3.6.3 Attribute constraints..... | 13 | +| 4.3.6.4 Notifications..... | 13 | +| 4.3.7 RepeaterFunction..... | 13 | +| 4.3.7.1 Definition ..... | 13 | +| 4.3.7.2 Attributes ..... | 13 | +| 4.3.7.3 Attribute constraints..... | 14 | +| 4.3.7.4 Notifications..... | 14 | +| 4.3.8 ProxyCell <<ProxyClass>>..... | 14 | +| 4.3.8.1 Definition ..... | 14 | +| 4.3.8.3 Attribute constraints..... | 14 | +| 4.3.8.4 Notifications..... | 14 | +| 4.3.9 ProxyBsFunction <<ProxyClass>>..... | 14 | +| 4.3.8.1 Definition ..... | 14 | +| 4.3.8.3 Attribute constraints..... | 14 | + +| | | | +|------------------------|----------------------------------|----| +| 4.3.8.4 | Notifications..... | 14 | +| 4.4 | Attribute definitions ..... | 15 | +| 4.4.1 | Attribute properties..... | 15 | +| 4.4.2 | Constraints ..... | 21 | +| 4.5 | Common Notifications ..... | 22 | +| 4.5.1 | Alarm notifications ..... | 22 | +| 4.5.2 | Configuration notifications..... | 22 | +| Annex A (informative): | Change history..... | 23 | + +# Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.661: Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Requirements; +- 28.662: Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS);** +- 28.663: Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document specifies the Generic Radio Access Network (RAN) network resource model (NRM) that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +In order to access the information defined by this NRM, an Interface IRP such as the "Basic CM IRP" is needed (3GPP TS 32.602 [5]). However, which Interface IRP is applicable is outside the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [5] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP) ; Information Service (IS)". +- [6] Void. +- [7] 3GPP TS 36.104: "Evolved Universal Terrestrial Radio Access (E\_UTRA); Base Station (BS) radio transmission and reception". +- [8] Void. +- [9] Void. +- [10] 3GPP TS 28.661: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [11] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [12] 3GPP TS 28.652: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) ". +- [13] 3GPP TS 28.658: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [14] 3GPP TS 28.655:"Telecommunication management; GSM/EDGE Radio Access Network (GERAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +- [15] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [16] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [17] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". +- [18] 3GPP TS 25.106: "Technical Specification Group Radio Access Network; UTRA repeater radio transmission and reception". +- [19] 3GPP TS 45.005: "Radio transmission and reception". +- [20] 3GPP TS 45.010: "Radio subsystem synchronization". +- [21] 3GPP TS 25.104: "Base Station (BS) radio transmission and reception (FDD)". +- [22] 3GPP TS 25.105: "Base Station (BS) radio transmission and reception (TDD)". +- [23] 3GPP TS 38.104: "NR; Base Station (BS) radio transmission and reception". +- [24] 3GPP TS 28.541: "NR and NG-RAN Network Resource Model (NRM) stage 2 and stage 3". +- [25] 3GPP TS 28.652: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [26] 3GPP TS 37.466: "Iuant Interface: Application Part". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the definitions given in TR 21.905 [1], TS 32.150 [4], TS 32.101 [2], TS 32.102 [3] and the following apply. The definitions defined in the present document take precedence over those, if any, in TS 32.150 [4], TS 32.101 [2], TS 32.102 [3] and TR 21.905 [1], in that order. + +**Network Resource Model (NRM):** See definition in TS 28.622 [15]. + +## 3.2 Abbreviations + +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]. + +| | | +|-----|-----------------------------| +| CM | Configuration Management | +| DN | Distinguished Name | +| IOC | Information Object Class | +| RDN | Relative Distinguished Name | +| SS | Solution Set | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|---------------------------------------------|-------------------| +| 3GPP TS 28.622 [15], IOC, ManagedFunction | ManagedFunction | +| 3GPP TS 28.652 [12], IOC, UtranGenericCell | UtranGenericCell | +| 3GPP TS 28.658 [13], IOC, EUtranGenericCell | EUtranGenericCell | +| 3GPP TS 28.655 [14], IOC, GSMCell | GSMCell | +| 3GPP TS 28.541 [24], IOC, NRSectorCarrier | NRSectorCarrier | +| 3GPP TS 28.541 [24], IOC, NRCellDU | NRCellDU | +| 3GPP TS 28.658 [13], IOC, ENBFunction | ENBFunction | +| 3GPP TS 28.652 [25], IOC, NodeBFunction | NodeBFunction | +| 3GPP TS 28.655 [14], IOC, BssFunction | BssFunction | + +## 4.2 Class diagrams + +### 4.2.1 Relationships + +This subclause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This subclause provides the overview of the relationships of relevant classes in UML. Subsequent subclauses provide more detailed specification of various aspects of these classes. + +![UML Class diagram showing relationships between GSMCellPart, ProxyCell, GSMCell, TMAFunction, SectorEquipmentFunction, AntennaFunction, and ManagedElement. ProxyCell is a proxy for GSMCellPart and has an XOR relationship with GSMCell and SectorEquipmentFunction. SectorEquipmentFunction has a 1..* relationship with AntennaFunction and a 1 relationship with TMAFunction. ManagedElement has a 1 relationship with SectorEquipmentFunction and a 1..* relationship with AntennaFunction.](ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg) + +``` + +classDiagram + class GSMCellPart["«InformationObjectClass»\nGSMCellPart"] + class ProxyCell["«ProxyClass»\nProxyCell"] + class GSMCell["«InformationObjectClass»\nGSMCell"] + class TMAFunction["«InformationObjectClass»\nTMAFunction"] + class SectorEquipmentFunction["«InformationObjectClass»\nSectorEquipmentFunction"] + class AntennaFunction["«InformationObjectClass»\nAntennaFunction"] + class ManagedElement["«InformationObjectClass»\nManagedElement"] + + GSMCellPart "*" --> "*" GSMCell : <<names>> + ProxyCell "*" --> "*" GSMCellPart + ProxyCell "*" --> "*" SectorEquipmentFunction + ProxyCell ..> "*" GSMCell : XOR + ProxyCell ..> "*" SectorEquipmentFunction : XOR + TMAFunction "*" --> "*" SectorEquipmentFunction + SectorEquipmentFunction "1" --> "1" TMAFunction + SectorEquipmentFunction "*" --> "*" AntennaFunction : 1..* + SectorEquipmentFunction "*" --> "*" ManagedElement : <<names>> + AntennaFunction "*" --> "*" ManagedElement : <<names>> + AntennaFunction "*" --> "*" SectorEquipmentFunction : 1..* + +``` + +It represents GSMCellPart, UtranGenericCell of 28.652 and EUtranGenericCell of 28.658 for GERAN sharing, UTRAN sharing and E-UTRAN sharing cases respectively. + +UML Class diagram showing relationships between GSMCellPart, ProxyCell, GSMCell, TMAFunction, SectorEquipmentFunction, AntennaFunction, and ManagedElement. ProxyCell is a proxy for GSMCellPart and has an XOR relationship with GSMCell and SectorEquipmentFunction. SectorEquipmentFunction has a 1..\* relationship with AntennaFunction and a 1 relationship with TMAFunction. ManagedElement has a 1 relationship with SectorEquipmentFunction and a 1..\* relationship with AntennaFunction. + +Figure 4.2.1.1: UTRAN/E-UTRAN/NR/GERAN sharing (1/2) + +![UML Class diagram showing relationships between NRCellDU, NRSectorCarrier, and SectorEquipmentFunction. NRCellDU has a 0..1 relationship with NRSectorCarrier. NRSectorCarrier has a 1 relationship with SectorEquipmentFunction.](c9d8a18a6137ad054b841d7a614afb48_img.jpg) + +``` + +classDiagram + class NRCellDU["«InformationObjectClass»\nNRCellDU"] + class NRSectorCarrier["«InformationObjectClass»\nNRSectorCarrier"] + class SectorEquipmentFunction["«InformationObjectClass»\nSectorEquipmentFunction"] + + NRCellDU "0..1" --> "*" NRSectorCarrier + NRSectorCarrier "*" --> "0..1" SectorEquipmentFunction + +``` + +UML Class diagram showing relationships between NRCellDU, NRSectorCarrier, and SectorEquipmentFunction. NRCellDU has a 0..1 relationship with NRSectorCarrier. NRSectorCarrier has a 1 relationship with SectorEquipmentFunction. + +Figure 4.2.1.2: UTRAN/E-UTRAN/NR/GERAN sharing (2/2) + +![UML Class Diagram for CommonBsFunction NRM fragment](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + } + class ProxyBsFunction { + <<ProxyClass>> + } + class CommonBsFunction { + <<InformationObjectClass>> + } + ManagedElement "1" *-- "*" ProxyBsFunction : <<names>> + ManagedElement "1" *-- "*" CommonBsFunction : <<names>> + ProxyBsFunction "1..*" -- "1" CommonBsFunction + note for ProxyBsFunction "It represents ENBFunction of 28.658, NodeBFunction of 28.652 and BssFunction of 28.655." + +``` + +UML Class Diagram for CommonBsFunction NRM fragment + +Figure 4.2.1.3: CommonBsFunction NRM fragment + +![UML Class Diagram for RepeaterFunction NRM fragment](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + } + class RepeaterFunction { + <<InformationObjectClass>> + } + class ExternalUtranGenericCell { + <<InformationObjectClass>> + } + ManagedElement "1" *-- "*" RepeaterFunction : <<names>> + RepeaterFunction "1" --> ExternalUtranGenericCell + +``` + +UML Class Diagram for RepeaterFunction NRM fragment + +Figure 4.2.1.4: RepeaterFunction NRM fragment + +![UML Class Diagram for RepeaterFunction related VsDataContainer Containment/Naming and Association diagram](07b17a620c75522d53916a11e12d1bff_img.jpg) + +``` + +classDiagram + class RepeaterFunction { + <<InformationObjectClass>> + } + class VsDataContainer { + <<InformationObjectClass>> + } + RepeaterFunction "1" *-- "*" VsDataContainer : <<names>> + VsDataContainer "1" *-- "*" VsDataContainer : <<names>> + +``` + +UML Class Diagram for RepeaterFunction related VsDataContainer Containment/Naming and Association diagram + +Figure 4.2.1.5: RepeaterFunction related VsDataContainer Containment/Naming and Association diagram + +### 4.2.2 Inheritance + +This subclause depicts the inheritance relationships. + +![UML Class Diagram for Inheritance diagram (1/2)](1c94fd3cebf58af136144f14160d128e_img.jpg) + +``` + +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + } + class RepeaterFunction { + <<InformationObjectClass>> + } + class TMAFunction { + <<InformationObjectClass>> + } + class SectorEquipmentFunction { + <<InformationObjectClass>> + } + class CommonBsFunction { + <<InformationObjectClass>> + } + class GSMCellPart { + <<InformationObjectClass>> + } + class AntennaFunction { + <<InformationObjectClass>> + } + RepeaterFunction --|> ManagedFunction + TMAFunction --|> ManagedFunction + SectorEquipmentFunction --|> ManagedFunction + CommonBsFunction --|> ManagedFunction + GSMCellPart --|> ManagedFunction + AntennaFunction --|> ManagedFunction + +``` + +UML Class Diagram for Inheritance diagram (1/2) + +Figure 4.2.2.1: Inheritance diagram (1/2) + +![Inheritance diagram showing ProxyCell inheriting from CellReferences, which inherits from Top.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +It represents GSMCellPart, UTranGenericCell of 28.652 and EUTranGenericCell of 28.658 for GERAN sharing, UTRAN sharing and E-UTRAN sharing cases respectively. + +``` + +classDiagram + ProxyCell --|> CellReferences + CellReferences --|> Top + class ProxyCell { + <<ProxyClass>> + } + class CellReferences { + <<InformationObjectClass>> + } + class Top { + <<InformationObjectClass>> + } + +``` + +Inheritance diagram showing ProxyCell inheriting from CellReferences, which inherits from Top. + +Figure 4.2.21.2: Inheritance diagram (2/2) + +## 4.3 Class definitions + +### 4.3.1 SectorEquipmentFunction + +#### 4.3.1.1 Definition + +This IOC represents a set of cells within a geographical area that has common functions relating to AntennaFunction, TMAFunction and supporting equipment, such as power amplifier. + +This IOC is required as part of the capability to satisfy the Requirements statement identified below. + +| Referenced TS | Requirement label | Comment | +|---------------------|----------------------|---------| +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-001 | | +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-002 | | + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| fqBand | CM | T | F | F | T | +| eUTRANFqBands | CM | T | F | F | T | +| nRFqBands | CM | T | F | F | T | +| uTRANFDDFqBands | CM | T | F | F | T | +| uTRANTDDFqBands | CM | T | F | F | T | +| confOutputPower | O | T | T | F | F | +| <b>Attribute related to role</b> | | | | | | +| theTMAList | CM | T | F | F | T | +| theAntennaList | CM | T | F | F | T | +| theCellList | CM | T | F | F | T | +| theNRSectorCarrierList | CM | T | F | F | T | + +#### 4.3.1.3 Attribute constraints + +| Name | Definition | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fqBand CM Support Qualifier | Condition: EUTRAN is supported, and only one EUTRAN frequency band is supported, and eUTRANFqBands is not used. | +| eUTRANFqBands CM Support Qualifier | Condition: EUTRAN is supported, and fqBand is not used. | +| nRFqBands CM Support Qualifier | Condition: NR is supported. | +| uTRANFDDFqBands CM Support Qualifier | Condition: UTRAN FDD is supported. | +| uTRANTDDFqBands CM Support Qualifier | Condition: UTRAN TDD is supported. | +| theTMAList CM Support Qualifier | Condition: Association between SectorEquipmentFunction and AntennaFunction is absent AND is supporting the UTRAN/E-UTRAN sharing/non-sharing case OR is supporting the GERAN sharing case. In such case, at least one TMAFunction is present. | +| theAntennaList CM Support Qualifier | Condition: Association between SectorEquipmentFunction and TMAFunction is absent AND is supporting the UTRAN/E-UTRAN sharing/non-sharing OR is supporting GERAN sharing case. In such case, at least one AntennaFunction is present. | +| theCellList CM Support Qualifier | Condition: Supporting UTRAN/E-UTRAN sharing (and non-sharing) cases. In such case, at least one UtranGenericCell/EUtranGenericCell is present. | + +| | | +|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| | Condition: Supporting the GERAN sharing case. In such case, at least one GSMCellPart is present. | +| theNRSectorCarrierList<br>CM Support Qualifier | Condition: Supporting NR sharing and non-sharing cases. In such cases, at least one NRSectorCarrier is present. | + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.2 AntennaFunction + +#### 4.3.2.1 Definition + +This IOC represents an array of radiating elements that may be tilted to adjust the RF coverage of a cell(s). + +This IOC is required as part of the capability to satisfy the Requirements statement identified below. + +| Referenced TS | Requirement label | Comment | +|---------------------|----------------------|---------| +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-001 | | +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-002 | | + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | IsNotifiable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| retTiltValue | O | T | T | F | T | +| bearing | O | T | T | F | T | +| retGroupName | O | T | T | F | T | +| height | O | T | T | F | T | +| maxAzimuthValue | O | T | T | F | T | +| minAzimuthValue | O | T | T | F | T | +| horizBeamwidth | O | T | T | F | T | +| vertBeamwidth | O | T | T | F | T | +| <b>Attribute related to role</b> | | | | | | +| theCellList | CM | T | F | F | T | + +#### 4.3.2.3 Attribute constraints + +| Name | Definition | +|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| theCellList CM Support Qualifier | Condition: Association between SectorEquipmentFunction and ProxyCell is absent; and association SectorEquipmentFunction and NRSectorCarrier is absent.. | + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 TMAFunction + +#### 4.3.3.1 Definition + +This IOC represents a Tower Mounted Amplifier or a number of TMA subunits within one TMA, each separately addressable by a specific index at the application layer. + +This IOC is required as part of the capability to satisfy the Requirements statement identified below. + +| Referenced TS | Requirement label | Comment | +|---------------------|----------------------|---------| +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-001 | | +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-002 | | + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| tmaSubunitNumber | M | T | T | F | T | +| tmaStateFlag | M | T | O | F | T | +| tmaFunctionFlag | M | T | T | F | T | +| tmaMinGain | M | T | F | F | T | +| tmaMaxGain | M | T | F | F | T | +| tmaResolution | M | T | F | F | T | +| tmaGainFigure | M | T | O | F | T | +| tmaNumberOfSubunits | M | T | F | F | T | +| tmaBaseStationId | CO | T | CO | F | T | +| tmaSectorId | CO | T | CO | F | T | +| tmaAntennaBearing | CO | T | CO | F | T | +| tmaInstalledMechanicalTilt | CO | T | CO | F | T | +| tmaSubunitType | CO | T | CO | F | T | +| tmaSubunitRxFrequencyBand | CO | T | CO | F | T | +| tmaSubunitTxFrequencyBand | CO | T | CO | F | T | +| tmaGainResolution | CO | T | CO | F | T | +| <b>Attribute related to role</b> | | | | | | +| theCellList | CM | T | F | F | T | + +#### 4.3.3.3 Attribute Constraints + +| Name | Definition | +|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| theCellList CM Support Qualifier | Condition: Association between SectorEquipmentFunction and ProxyCellList is absent ; and association between SectorEquipmentFunction and NRSectorCarrier is absent. | + +| Name | Definition | +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| The CO support qualifier of the attributes tmaBaseStationId through tmaGainResolution | Condition: The TMA subunit supports the read operation in 3GPP TS 37.466 [26] | +| The CO write qualifier of the attributes tmaBaseStationId through tmaGainResolution | Condition: The TMA subunit supports the write operation in 3GPP TS 37.466 [26] | + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.4 GSMCellPart + +#### 4.3.4.1 Definition + +A GSM cell can consist of a number of carriers. These carriers can be configured in a number of ways, for example, the carriers can have different propagation properties which are sent with different antenna tilt, with different RF power, different radio band and even possibly different antenna. + +The various GSMCellPart instances capture different radio propagation properties allowing different frequency planning schemes, e.g. some GSMCellPart instances can use frequency groups planned for tighter frequency reuse. + +Hence, a GSM cell can, and in some cases must, be distributed on more than one SectorEquipmentFunction. + +This IOC is required as part of the capability to satisfy the Requirements statement identified below. + +| Referenced TS | Requirement label | Comment | +|---------------------|----------------------|---------| +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-001 | | +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-002 | | + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| aRFCN | M | T | T | F | T | +| tsc | M | T | T | F | T | +| aTA | M | T | T | F | T | +| <b>Attribute related to role</b> | | | | | | +| theSectorEquipment | M | T | F | F | T | + +#### 4.3.4.3 Attribute constraints + +None + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.5 CommonBsFunction + +#### 4.3.5.1 Definition + +This IOC represents common aspects of Base Station (BS) functionality shared by several radio access technologies. + +| Referenced TS | Requirement label | Comment | +|---------------------|----------------------|---------| +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-001 | | +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-002 | | + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| sharedTechnologies | M | T | O | F | T | +| <b>Attribute related to role</b> | | | | | | +| theProxyBsList | M | T | F | F | T | + +#### 4.3.5.3 Attribute constraints + +None + +#### 4.3.5.4 Notifications + +There is no notification defined. + +### 4.3.6 CellReferences + +#### 4.3.6.1 Definition + +This IOC represents the three references to TMAFunction, SectorEquipmentFunction and AntennaFunction. The references are used by various classes of cells, e.g. *UtranGenericCell*. + +This is an abstract class. + +#### 4.3.6.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| relatedSectorEquipment | CM | T | F | F | T | +| relatedTMAList | CM | T | F | F | T | +| relatedAntennaList | CM | T | F | F | T | + +#### 4.3.6.3 Attribute constraints + +| Name | Definition | +|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| relatedSectorEquipment CM Support Qualifier | Condition: Supporting the GERAN sharing case. In such case, there shall be at least one GSMCellPart present at one end of this association. | +| relatedAntennaList CM Support Qualifier | Condition: Association between SectorEquipmentFunction and ProxyCell is absent. | +| relatedTMAList CM Support Qualifier | Condition: Association between SectorEquipmentFunction and ProxyCell is absent. | + +#### 4.3.6.4 Notifications + +There is no notification defined. + +### 4.3.7 RepeaterFunction + +#### 4.3.7.1 Definition + +This IOC represents the management aspect of a repeater. For the information on repeater see 3GPP TS 25.106 [18]. + +This IOC is required as part of the capability to satisfy the Requirements statement identified below. + +| Referenced TS | Requirement label | Comment | +|---------------------|----------------------|---------| +| 3GPP TS 28.661 [10] | REQ-GRAN_NRM-CON-003 | | + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| priority | M | T | T | F | T | +| latitude | M | T | F | F | F | +| longitude | M | T | F | F | F | +| ctrlConnMode | M | T | T | F | T | +| environmentInfo | M | T | - | F | - | +| powerSwitch | M | T | T | F | T | +| ulAttenuation | M | T | T | F | T | +| dlAttenuation | M | T | T | F | T | +| firmwareVer | M | T | F | F | F | +| repeaterType | M | T | F | F | F | +| <b>Attribute related to role</b> | | | | | | +| externalUTRANCell | M | T | F | F | T | + +#### 4.3.7.3 Attribute constraints + +None. + +#### 4.3.7.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.8 ProxyCell <<ProxyClass>> + +#### 4.3.8.1 Definition + +This IOC represents GSMCellPart, UTranGenericCell and EUtranGenericCell. + +#### 4.3.8.3 Attribute constraints + +See respective IOCs + +#### 4.3.8.4 Notifications + +See respective IOCs. + +### 4.3.9 ProxyBsFunction <<ProxyClass>> + +#### 4.3.8.1 Definition + +This IOC represents ENBFunction, NodeBFunction and BssFunction. + +#### 4.3.8.3 Attribute constraints + +See respective IOCs. + +#### 4.3.8.4 Notifications + +See respective IOCs. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| arfcn | This attribute (Absolute Radio Frequency Channel Number) defines a pair of Radio Frequency (RF) channel frequencies for uplink and downlink use.<br><br>See 3GPP TS 45.005 [19] clause 2 for the ARFCN for GSM. ARFCN are based on a 200 kHz channel raster.<br><br>allowedValues: See 3GPP TS 45.005 [19] clause 2 | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| ata | This attribute (allowed Timing Advance) defines the signal sent by the BTS to the MS which the MS uses to advance its timings of transmissions to the BTS so as to compensate for propagation delay.<br><br>allowedValues: See 3GPP TS 45.010 [20] | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| bearing | The bearing in degrees that the antenna is pointing in. Antenna bearing" in Ref. 3GPP TS 25.463 [8].<br><br>allowedValues: See "Antenna bearing" in 3GPP TS 25.463 [8]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| confOutputPower | It defines the allowed total power to use for all cells together in this sector. It may be set by the operator and/or limited by HW limitation or licensed power, e.g.: 20, 40, 60, 80, 120 watts<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| ctrlConnMode | Remote communication mode used by a repeater to send and receive control message, such as GSM SMS, WCDMA SMS, Circle Switch Data-CSD, Package Switch Dat-IP, Serial port.<br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| dlAttenuation | Downlink signal attenuation of the device to change downlink gain.<br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| environmentInfo | The repeater device is located either in the building or out of the building.<br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| eUTRANFqBands | This is the list of LTE frequency bands supported by the hardware associated with the SectorEquipmentFunction.<br>The earfcnDl and earfcnUl or earfcn of LTE cells associated with the SectorEquipmentFunction must be assigned with value within one of the specified eUTRANFqBands values.<br><br>allowedValues: A list of frequency bands expressed as strings.<br>Valid frequency band values are specified in sub-clause 5.7.3 in 36.104 [7].<br>For HW not supporting LTE frequency bands, the list shall be empty. | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| firmwareVer | Version of the device firmware.<br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| fqBand | This is the LTE frequency band supported by the hardware associated with the SectorEquipmentFunction. The earfcnDl and earfcnUl of cells associated with the SectorEquipmentFunction must be assigned with value within this fqBand value.<br><br>allowedValues: See clause 5 Table 5.2-1 “E-UTRA frequency band” of 3GPP TS 36.104 [7]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| nRFqBands | This is the list of NR frequency bands supported by the hardware associated with the SectorEquipmentFunction.<br><br>The arfcnDl and arfcnUl of the NRSectorCarrier must be assigned with value within one of the specified nRFqBands values – if the attributes on NRSectorCarriers are set.<br><br>The arfcnDl and arfcnUl of the NRCellDU associated with the NRSectorCarrier must be assigned with value within one of the specified nRFqBands values – if there is a NRCellDU associated with the NRSectorCarrier.<br><br>allowedValues:<br>A list of frequency bands expressed as strings.<br>Valid frequency band values are specified in sub-clause 5.4.2 in 3GPP TS 38.104 [23].<br>For HW not supporting NR frequency bands, the list shall be empty. | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| height | The height of an antenna above sea level.<br><br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behavior is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the luant interface according to Ref. 3GPP TS 37.466 [26].<br><br>An integral value representing a number of meters in 0.1 meter increments.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| horizBeamwidth | The 3 dB power beamwidth of the antenna pattern in the horizontal plane. A value of 360 indicates an omnidirectional antenna.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behaviour is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the luant interface according to Ref. 3GPP TS37.466 [26].<br><br>A single integral value corresponding to an angle in degrees between 0 and 360.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| latitude | The latitude of the antenna location based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to the northern hemisphere.<br>allowedValues: -90.0000 to +90.0000 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| longitude | The longitude of the antenna location based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to degrees east of 0 degrees longitude.<br>allowedValues: -180.0000 to +180.0000 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| maxAzimuthValue | The maximum amount of change of azimuth the RET system can support. This is the change in degrees clockwise from bearing.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behaviour is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iu-int interface according to Ref. 3GPP TS 37.466 [26].<br><br>A single integral value corresponding to an angle in degrees between 0 and 360 with a resolution of 0.1 degrees.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| minAzimuthValue | The minimum amount of change of azimuth the RET system can support. This is the change in degrees counter-clockwise from bearing.<br>Note: The value of this attribute has no operational impact on the network, e.g. the NE behaviour is not affected by the value setting of this attribute. Note as well that this attribute is not supported over the Iu-int interface according to Ref. 3GPP TS 25.466 [9].<br><br>A single integral value corresponding to an angle in degrees between 0 and 360 with a resolution of 0.1 degrees.<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| priority | The priority of a repeater decided by an operator.<br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| powerSwitch | Power switch of device which has two status: ON/OFF.<br>allowedValues: ON, OFF | type: Boolean<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| relatedAntennaList | This attribute contains the DNs of one or more AntennaFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: T<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| relatedSectorEquipment | This attribute contains the DN of one SectorEquipmentFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| relatedTMAList | This attribute contains the DNs of one or more TmaFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: T<br>defaultValue: None<br>isNullable: True | +| repeaterType | The repeater type defined by operator, such as wide band, frequency selective, indoor and fiber optic.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| retGroupName | The group name is a textual, alpha-numeric string to define a logical grouping of antennas which may be in different cells.<br><br>This attribute permits the definition of a logical grouping of the antennas. This may be defined either at installation time, or by management activity to provisioning the group name via the Itf-N.<br><br>allowedValues: N/A (String size is bounded to 80 characters.) | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| retTiltValue | The electrical tilt setting of the antenna, "Tilt value" in Ref. 3GPP TS 37.466 [26].<br><br>allowedValues: See "Tilt value" in Ref. 3GPP TS 37.466 [26]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| sharedTechnologies | This attribute defines the radio access technologies sharing the common functionalities of a Base Station (BS).<br><br>allowedValues: GSM, UMTS, LTE, or any combination thereof | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaAntennaBearing | A data field defined in Table B.3 of 3GPP TS 37.466 [26].<br><br>See definition in 3GPP TS 37.466 [26].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaBaseStationId | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| tmaFunctionFlag | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity:<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaGainFigure | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaGainResolution | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaInstalledMechanicalTilt | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaMaxGain | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaMinGain | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaNumberOfSubunits | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: -- | Defined in 3GPP TS 37.466 [26]<br><br>type: --<br>multiplicity: --<br>isOrdered: --<br>isUnique: --<br>defaultValue: --<br>isNullable: -- | +| tmaResolution | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaSectorId | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| tmaStateFlag | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaSubunitNumber | Defined in 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaSubunitRxFrequencyBand | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: See 3GPP TS 37.466 [26]. | type: Integer<br>multiplicity: 2<br>isOrdered: True<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| tmaSubunitType | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| tmaSubunitTxFrequencyBand | A data field defined in Table B.3 of 3GPP TS 37.466 [26]<br><br>allowedValues: See 3GPP TS 37.466 [26]. | type: Integer<br>multiplicity: 2<br>isOrdered: True<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| tsc | This attribute has the same definition as the one used in GsmCell IOC. The presence of GsmCellPart means the tsc attribute in GsmCell IOC instance is irrelevant (not applicable).<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| ulAttenuation | Uplink signal attenuation of the device to change uplink gain.<br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| uTRANFDDFqBands | This is the list of UTRAN FDD frequency bands supported by the hardware associated with the SectorEquipmentFunction.<br>The arfcnDl and arfcnUl of UTRAN FDD cells associated with the SectorEquipmentFunction must be assigned with value within one of the specified uTRANFDDFqBands values.<br>allowedValues: A list of frequency bands expressed as strings.<br>Valid frequency band values are specified in sub-clause 5.2 of 3GPP TS 25.104 [21]. | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| uTRANtDDFqBands | This is the list of UTRAN TDD frequency bands supported by the hardware associated with the <i>SectorEquipmentFunction</i> .<br>The <i>earfcn</i> of UTRAN TDD cells associated with the <i>SectorEquipmentFunction</i> must be assigned with value within one of the specified <i>uTRANtDDFqBands</i> values.<br>allowedValues: A list of frequency bands expressed as strings.<br>Valid frequency band values are specified in sub-clause 5.2 of 3GPP TS 25.105 [22]. | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| vertBeamwidth | The 3 dB power beamwidth of the antenna pattern in the vertical plane.<br><br>The value of this attribute has no operational impact on the network, e.g. the NE behaviour is not affected by the value setting of this attribute.<br><br>This attribute is not supported over the Iuant interface according to Ref. 3GPP TS 37.466 [26].<br><br>allowedValues: A single integral value corresponding to an angle in degrees between 0 and 180. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <b>Attribute related to role</b> | | | +| externalUTRANCell | This role (when present) represents <i>repeaterFunction</i> capability to identify one <i>ExternalUtranCell</i> .<br>When present, it shall contain one <i>ExternalUtranCell</i> DN.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| theAntennaList | This attribute contains the DNs of one or more <i>AntennaFunction</i> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theCellList | This attribute contains the DNs of <i>EUtranGenericCell</i> or <i>UtranGenericCell</i> if associations between them exist.<br><br>This attribute contains the DNs of <i>GSMCellPart</i> if association between them exist.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theProxyBsList | A <i>CommonBsFunction</i> instance serves a number of <i>ProxyBsFunction</i> instances. This <i>CommonBsFunction</i> role-attribute contains a list of DNs of <i>ENBFunction</i> (3GPP TS 28.658 [13]), <i>NodeBFunction</i> (3GPP TS 28.652 [12]) and <i>BssFunction</i> (3GPP TS 28.655 [14]) that it serves.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theTMAList | This attribute contains the DNs of one or more <i>TMAFunction</i> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +### 4.4.2 Constraints + +None + +## 4.5 Common Notifications + +### 4.5.1 Alarm notifications + +This subclause presents a list of notifications, defined in 3GPP TS 32.111-2 [11], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in 3GPP TS 32.302 [16], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|---------------------------------------------|---------------------------------------|-------| +| <code>notifyAckStateChanged</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyChangedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyClearedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyNewAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyComments</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyAlarmListRebuilt</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | +| <code>notifyPotentialFaultyAlarmList</code> | See Alarm IRP (3GPP TS 32.111-2 [11]) | | + +### 4.5.2 Configuration notifications + +This subclause presents a list of notifications, defined in 3GPP TS 32.662 [17], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in 3GPP TS 32.302[16], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|-----------------------------------------|-----------|-------| +| <code>notifyAttributeValueChange</code> | O | | +| <code>notifyObjectCreation</code> | O | | +| <code>notifyObjectDeletion</code> | O | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2013-09 | SA#61 | SP-130433 | 0001 | | F | Add missing Repeater Object IS definitions | 11.1.0 | +| 2014-06 | SA#64 | SP-140359 | 0002 | | F | remove the feature support statements | 11.2.0 | +| 2014-10 | - | - | - | | | Update to Rel-12 version (MCC) | <b>12.0.0</b> | +| 2016-01 | - | - | - | | | Update to Rel-13 version (MCC) | <b>13.0.0</b> | +| 2016-06 | SA#72 | SP-160408 | 0005 | 1 | A | Correcting references and reintroducing attributes. | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-12 | SA#82 | SP-181156 | 0007 | 1 | F | Correct SectorEquipmentFunction property to support NR. | 15.1.0 | +| 2018-12 | SA#82 | SP-181156 | 0008 | 2 | F | Align NR frequency bands supported by the hardware associated with the SectorEquipmentFunction | 15.1.0 | +| 2019-09 | SA#85 | SP-190751 | 0009 | - | F | Correct references and add reference to TR21.905 | 15.2.0 | +| 2019-12 | SA#86 | SP-191173 | 0010 | 1 | F | Correct use of ProxyCellList | 15.3.0 | +| 2020-07 | - | - | - | - | | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28663/raw.md b/marked/Rel-16/28_series/28663/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5d295f66ac29e109f1ac6e9ca9017fb2ef0ca35a --- /dev/null +++ b/marked/Rel-16/28_series/28663/raw.md @@ -0,0 +1,999 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set Definition..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 Introduction..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.2 Rules for NRM extensions ..... | 8 | +| A.1.2.1 Allowed extensions ..... | 8 | +| A.1.2.2 Extensions not allowed..... | 8 | +| A.2 Mapping ..... | 9 | +| A.2.1 General mapping ..... | 9 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC SectorEquipmentFunction ..... | 9 | +| A.2.2.2 IOC AntennaFunction ..... | 9 | +| A.2.2.3 IOC TmaFunction..... | 10 | +| A.2.2.4 IOC CommonBSFunction ..... | 10 | +| A.2.2.5 IOC GSMCellPart ..... | 10 | +| A.2.2.6 IOC RepeaterFunction..... | 11 | +| A.3 Solution Set definitions ..... | 12 | +| A.3.1 IDL definition structure..... | 12 | +| A.3.2 IDL specification "GenericRanNRMDefs.idl" ..... | 12 | +| A.3.3 IDL specification (file name "RepeaterNetworkResourcesNRMDefs.idl") ..... | 13 | +| <b>Annex B (normative): XML definitions.....</b> | <b>15</b> | +| B.0 General..... | 15 | +| B.1 Architectural features..... | 15 | +| B.1.0 General ..... | 15 | +| B.1.1 Syntax for Distinguished Names..... | 15 | +| B.2 Mapping ..... | 15 | +| B.2.1 General mapping ..... | 15 | +| B.2.2 Information Object Class (IOC) mapping..... | 15 | +| B.3 Solution Set definitions ..... | 16 | +| B.3.1 XML definition structure ..... | 16 | +| B.3.2 Graphical Representation..... | 16 | +| B.3.3 XML schema "genericRanNrm.xsd"..... | 17 | +| B.3.4 XML schema (file name "repeaterNrm.xsd") ..... | 20 | +| Annex C (informative): Change history..... | 22 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.661: Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Requirements; +- 28.662: Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS); +- 28.663: **Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Generic Radio Access Network (RAN) Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning Generic RAN resources. The Generic RAN NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the Generic RAN NRM IRP. + +This Solution Set specification is related to 3GPP TS 28.662 V15.0.X [4]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". +- [2] Void +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.662: "Generic Radio Access Network (RAN) Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [8] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [9] Void. +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [13] 3GPP TS 28.623: "Generic network resources Integration Reference Point (IRP); Solution Set (SS) definition". +- [14] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], 3GPP TS 32.600 [3] 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] and 3GPP TS 32.600 [3]. + +**XML file:** See definition of [13]. + +**XML document:** See definition of [13]. + +**XML declaration:** See definition of [13]. + +**XML element:** See definition of [13]. + +**empty XML element:** See definition of [13]. + +**XML content (of an XML element):** See definition of [13]. + +**XML start-tag:** See definition of [13]. + +**XML end-tag:** See definition of [13]. + +**XML empty-element tag:** See definition of [13]. + +**XML attribute specification:** See definition of [13]. + +**DTD:** See definition of [13]. + +**XML schema:** See definition of [13]. + +**XML namespace:** See definition of [13]. + +**XML complex type:** See definition of [13]. + +**XML element type:** See definition of [13]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [14]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1], 3GPP TS 32.600 [3], 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] and 3GPP TS 32.600 [3]. + +| | | +|-----|--------------------------| +| CM | Configuration Management | +| DTD | Document Type Definition | +| IOC | Information Object Class | +| MO | Managed Object | +| MOC | Managed Object Class | +| SS | Solution Set | + +# --- 4 Solution Set (SS) definition + +This specification defines the following 3GPP Generic RAN NRM IRP Solution Set Definitions: + +- 3GPP Generic RAN NRM IRP CORBA SS (Annex A) + +- 3GPP Generic RAN NRM IRP XML Definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 Introduction + +This clause contains the CORBA Solution Set for the IRP whose semantics is specified in Generic RAN NRM IRP: Information Service (TS 28.662 [4]). + +--- + +## A.1 Architectural features + +The overall architectural feature of Generic RAN Network Resources IRP is specified in 3GPP TS 28.662 [4]. This clause specifies features that are specific to the CORBA SS. + +### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [13]. + +### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [13]. + +#### A.1.2.1 Allowed extensions + +See clause A.2.1 of [13]. + +#### A.1.2.2 Extensions not allowed + +See clause A.2.1 of [13]. + +## A.2 Mapping + +### A.2.1 General mapping + +See clause A.2.1 of [13]. + +### A.2.2 Information Object Class (IOC) mapping + +#### A.2.2.1 IOC SectorEquipmentFunction + +**Mapping from NRM IOC SectorEquipmentFunction attributes and associations to SS equivalent MOC SectorEquipmentFunction attributes** + +| IS Attribute | SS Attribute | SS Type | +|--------------------|--------------------|------------------------------------------------------------------| +| id | id | string | +| fqBand | fqBand | short | +| eUTRANFqBands | eUTRANFqBands | GenericRanNRMAtributeTypes::eUTRANFqBandsListType | +| nRFqBands | nRFqBands | GenericRanNRMAtributeTypes::nRFqBandsListType | +| uTRANFDDFqBands | uTRANFDDFqBands | GenericRanNRMAtributeTypes::uTRANFDDFqBandsListType | +| uTRANTDDFqBands | uTRANTDDFqBands | GenericRanNRMAtributeTypes::uTRANTDDFqBandsListType | +| confOutputPower | confOutputPower | short | +| relatedTmaList | relatedTmaList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| relatedAntennaList | relatedAntennaList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| relatedCellList | relatedCellList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +#### A.2.2.2 IOC AntennaFunction + +**Mapping from NRM IOC AntennaFunction attributes and associations to SS equivalent MOC AntennaFunction attributes** + +| IS Attribute | SS Attribute | SS Type | +|-----------------|-----------------|------------------------------------------------------------------| +| id | id | string | +| retTiltValue | retTiltValue | short | +| bearing | bearing | short | +| retGroupName | retGroupName | string | +| height | height | short | +| maxAzimuthValue | maxAzimuthValue | short | +| minAzimuthValue | minAzimuthValue | short | +| horizBeamwidth | horizBeamwidth | short | +| vertBeamwidth | vertBeamwidth | short | +| relatedCellList | relatedCellList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +NOTE: For all support qualifiers with the value "0", see attribute constraints in TS 28.622 [4]. + +#### A.2.2.3 IOC TmaFunction + +##### Mapping from NRM IOC TmaFunction attributes and associations to SS equivalent MOC TmaFunction attributes + +| IS Attribute | SS Attribute | SS Type | +|----------------------------|----------------------------|------------------------------------------------------------------| +| id | id | string | +| tmaSubunitNumber | tmaSubunitNumber | unsigned short | +| tmaStateFlag | tmaStateFlag | unsigned short | +| tmaFunctionFlag | tmaFunctionFlag | unsigned short | +| tmaMinGain | tmaMinGain | unsigned short | +| tmaMaxGain | tmaMaxGain | unsigned short | +| tmaResolution | tmaResolution | unsigned short | +| tmaGainFigure | tmaGainFigure | unsigned short | +| tmaNumberOfSubunits | tmaNumberOfSubunits | unsigned short | +| tmaBaseStationId | tmaBaseStationId | string | +| tmaSectorId | tmaSectorId | string | +| tmaAntennaBearing | tmaAntennaBearing | unsigned short | +| tmaInstalledMechanicalTilt | tmaInstalledMechanicalTilt | short | +| tmaSubunitType | tmaSubunitType | unsigned short | +| tmaSubunitRxFrequencyBand | tmaSubunitRxFrequencyBand | sequence of unsigned short | +| tmaSubunitTxFrequencyBand | tmaSubunitTxFrequencyBand | sequence of unsigned short | +| tmaGainResolution | tmaGainResolution | unsigned short | +| relatedCellList | relatedCellList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +Editor's note: The attributes tmaSubunitType, tmaSubunitRxFrequencyBand, tmaSubunitTxFrequencyBand, tmaGainResolution, tmaBaseStationId and tmaSectorId are to be checked if they should be moved to inventory. + +#### A.2.2.4 IOC CommonBSFunction + +##### Mapping from NRM IOC CommonBSFunction attributes and associations to SS equivalent MOC CommonBSFunction attributes + +| IS Attribute | SS Attribute | SS Type | +|--------------------|--------------------|---------| +| id | id | string | +| sharedTechnologies | sharedTechnologies | short | + +#### A.2.2.5 IOC GSMCellPart + +##### Mapping from NRM IOC GSMCellPart attributes and associations to SS equivalent MOC GSMCellPart attributes + +| IS Attribute | SS Attribute | SS Type | +|------------------------|------------------------|------------------------------------------------------------------| +| id | id | string | +| aRFCN | aRFCN | string | +| tsc | tsc | long | +| aTA | aTA | short | +| relatedSectorEquipment | relatedSectorEquipment | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +#### A.2.2.6 IOC RepeaterFunction + +**Mapping from NRM IOC RepeaterFunction attributes to SS equivalent MOC RepeaterFunction attributes** + +| IS Attribute | SS Attribute | SS Type | +|-------------------|-----------------------------------|---------------------------------------------------------------| +| id | repeaterFunctionId | string | +| userLabel | userLabel | string | +| priority | priority | long | +| latitude | latitude | float | +| longitude | longitude | float | +| ctrlConnMode | ctrlConnMode | ctrlConnMode | +| environmentInfo | environmentInfo | string | +| powerSwitch | powerSwitch | powerSwitch | +| ulAttenuation | ulAttenuation | long | +| dlAttenuation | dlAttenuation | long | +| firmwareVer | firmwareVer | string | +| repeaterType | repeaterType | repeaterType | +| externalUTRANCell | repeaterFunctionExternalUtranCell | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +## A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clauses A.3.2 and A.3.3 define the MO classes for the Generic RAN NRM IRP. + +### A.3.2 IDL specification "GenericRanNRMDefs.idl" + +``` +//File:GenericRanNRMDefs.idl +#ifndef _GENERICRANNRMDefs_IDL_ +#define _GENERICRANNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module GenericRanNRMDefs +{ + /** + * Definitions for MO class AntennaFunction + */ + interface AntennaFunction: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "AntennaFunction"; + // Attribute Names + // + const string id = "id"; + const string retTiltValue = "retTiltValue"; + const string bearing = "bearing"; + const string retGroupName = "retGroupName"; + const string height = "height"; + const string maxAzimuthValue = "maxAzimuthValue"; + const string minAzimuthValue = "minAzimuthValue"; + const string horizBeamwidth = "horizBeamwidth"; + const string vertBeamwidth = "vertBeamwidth"; + const string relatedCellList = "relatedCellList"; + }; + + /** + * Definitions for MO class TmaFunction + */ + interface TmaFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "TmaFunction"; + // Attribute Names + // + const string id = "id"; + const string tmaSubunitNumber = "tmaSubunitNumber"; + const string tmaStateFlag = "tmaStateFlag"; + const string tmaFunctionFlag = "tmaFunctionFlag"; + const string tmaMinGain = "tmaMinGain"; + const string tmaMaxGain = "tmaMaxGain"; + const string tmaResolution = "tmaResolution"; + const string tmaGainFigure = "tmaGainFigure"; + const string tmaNumberOfSubunits = "tmaNumberOfSubunits"; + const string tmaBaseStationId = "tmaBaseStationId"; + const string tmaSectorId = "tmaSectorId"; + const string tmaAntennaBearing = "tmaAntennaBearing"; + const string tmaInstalledMechanicalTilt = "tmaInstalledMechanicalTilt"; + const string tmaSubunitType = "tmaSubunitType"; + const string tmaSubunitRxFrequencyBand = "tmaSubunitRxFrequencyBand"; + const string tmaSubunitTxFrequencyBand = "tmaSubunitTxFrequencyBand"; + const string tmaGainResolution = "tmaGainResolution"; + const string relatedCellList = "relatedCellList"; + }; + + /** + * Definitions for MO class SectorEquipmentFunction + */ + interface SectorEquipmentFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + +``` + +``` + +const string CLASS = "SectorEquipmentFunction"; +// Attribute Names +// +const string id = "id"; +const string fqBand = "fqBand"; +const string eUTRANFqBands = "eUTRANFqBands"; +const string nRFqBands = "nRFqBands"; +const string uTRANFDDFqBands = "uTRANFDDFqBands"; +const string uTRANFDFFqBands = "uTRANFDFFqBands"; +const string confOutputPower = "confOutputPower"; +const string relatedTmaList = "relatedTmaList"; +const string relatedAntennaList = "relatedAntennaList"; +const string relatedCellList = "relatedCellList"; +}; + +/* + * Definitions for MO class CommonBSFunction + */ +interface CommonBSFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "CommonBSFunction"; + // Attribute Names + // + const string id = "id"; + const string sharedTechnologies = "sharedTechnologies"; +}; + +/* + * Definitions for MO class GSMCellPart + */ +interface GSMCellPart : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "GSMCellPart"; + // Attribute Names + // + const string id = "id"; + const string aRFCN = "aRFCN"; + const string tsc = "tsc"; + const string aTA = "aTA"; + const string relatedSectorEquipment = "relatedSectorEquipment"; +}; + +}; + +module GenericRanNRMAtributeTypes +{ + typedef sequence<string> eUTRANFqBandsListType; + typedef sequence<string> nRFqBandsListType; + typedef sequence<string> uTRANFDDFqBandsListType; + typedef sequence<string> uTRANFDFFqBandsListType; +}; + +#endif // _GENERICRANNRMDEFS_IDL_ + +``` + +### A.3.3 IDL specification (file name "RepeaterNetworkResourcesNRMDefs.idl") + +``` + +//File:RepeaterNetworkResourcesNRMDefs.idl +#ifndef _REPEATERNETWORKRESOURCESNRMDEFS_IDL_ +#define _REPEATERNETWORKRESOURCESNRMDEFS_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module RepeaterNetworkResourcesNRMDefs +{ + /** + * Definitions for MO class RepeaterFunction + */ + interface RepeaterFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "RepeaterFunction"; + // Attribute Names + } +} + +``` + +``` + // + const string repeaterFunctionId = "repeaterFunctionId"; + const string priority = "priority"; + const string latitude = "latitude"; + const string longitude = "longitude"; + const string ctrlConnMode = "ctrlConnMode"; + const string environmentInfo = "environmentInfo"; + const string powerSwitch = "powerSwitch"; + const string dLAttenuation = "dLAttenuation"; + const string uLAttenuation = "uLAttenuation"; + const string firmwareVer = "firmwareVer"; + const string repeaterType = "repeaterType"; + const string repeaterFunctionExternalUtranCell = "repeaterFunctionExternalUtranCell"; +}; + +enum ctrlConnMode +{ + GSM_SMS, + WCDMA_SMS, + CIRCLE_SWITCH_DATA_CSD, + PACKAGE_SWITCH_DATA_IP, + SERIAL_PORT +}; + +enum powerSwitch {ON,OFF}; + +enum repeaterType +{ + WIDE_BAND_REPT_FUNCTION, + FREQ_SEL_REPT_FUNCTION, + FIBER_REPT_FUNCTION, + INDOOR_REPT_FUNCTION, + FREQ_SHIFT_REPT_FUNCTION +}; +}; +#endif // _REPEATERNETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +This annex contains the XML Definitions for the Generic RAN NRM IRP as it applies to Itf-N, in accordance with Generic RAN NRM IRP IS definitions [4]. + +The XML file formats are based on XML [8], XML Schema [10] [11] and XML Namespace [12] standards. + +## --- B.1 Architectural features + +### B.1.0 General + +The overall architectural feature of Generic RAN Network Resources IRP is specified in 3GPP TS 28.662 [4]. This clause specifies features that are specific to the Schema definitions. + +The XML definitions of this document specify the schema for a configuration content. + +When using the XML definitions for a configuration file transfer with the Bulk CM IRP, using either CORBA Solution Set of 3GPP TS 32.616 [7] or SOAP Solution Set of 3GPP TS 32.616 [7], the basic part of the XML file format definition is provided by 3GPP TS 32.616 [7]. The XML definitions of this document provide the schema for the configuration content to be included in such a configuration file. + +When using the XML definitions with a SOAP Solution Set of any Interface IRP that perform operations on managed objects, for example the Basic CM IRP SOAP SS of 3GPP TS 32.606 [6], the XML definitions of this document provides the schema for the configuration content operated on by the interface IRP. Such configuration content can be name of managed object and, if applicable, IOC attributes. + +### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +## --- B.2 Mapping + +### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [7]. + +Annex B.3.3 of the present document defines the NRM-specific XML schema `genericRanNrm.xsd` for the Generic RAN Network Resources IRP NRM defined in 3GPP TS 28.662 [4] (except Repeater object). + +XML schema `genericRanNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM (except Repeater object) Annex B.3.4 of the present document defines the NRM-specific XML schema `repeaterNrm.xsd` for the Repeater object of the Generic RAN Network Resources IRP NRM defined in 3GPP TS 28.662 [4]. + +XML schema `repeaterNrm.xsd` explicitly declares NRM-specific XML element types for Repeater object defined in the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [7]. + +### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +### B.3.3 XML schema "genericRanNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> +<!-- + 3GPP TS 28.663 Generic RAN Network Resources IRP + Bulk CM Configuration data file NRM-specific XML schema + genericRanNrm.xsd +--> +<schema xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:gn="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + xmlns:gr="http://www.3gpp.org/ftp/specs/archive/28_series/28.663#genericRanNrm" + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.663#genericRanNrm" + elementFormDefault="qualified"> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm"/> + + <!-- Generic RAN Network Resources IRP NRM attribute related XML types --> + + <simpleType name="angleValue"> + <restriction base="short"> + <minInclusive value="0"/> + <maxInclusive value="3600"/> + </restriction> + </simpleType> + + <simpleType name="retGroupName"> + <restriction base="string"> + <maxLength value="80"/> + </restriction> + </simpleType> + + <simpleType name="bearing"> + <restriction base="short"> + <minInclusive value="0"/> + <maxInclusive value="360"/> + </restriction> + </simpleType> + + <simpleType name="tmaFunctionFlag"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="1"/> + </restriction> + </simpleType> + + <simpleType name="tmaStateFlag"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="1"/> + </restriction> + </simpleType> + + <simpleType name="fourOctets"> + <restriction base="hexBinary"> + <length value="4"/> + </restriction> + </simpleType> + + <complexType name="FqBandsList"> + <sequence> + <element name="fqBand" type="string" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </complexType> + + <!-- Generic RAN Network Resources IRP NRM class associated XML elements --> + + <element name="SectorEquipmentFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> +``` + +``` + + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + <element name="fqBand" type="short" /> + <element name="eUTRANFqBands" type="gr:FqBandsList" /> + <element name="nRFqBands" type="gr:FqBandsList" /> + <element name="uTRANFDDFqBands" type="gr:FqBandsList" /> + <element name="uTRANTDDFqBands" type="gr:FqBandsList" /> + <element name="confOutputPower" type="short" minOccurs="0"/> + <element name="relatedTmaList" type="xn:dnList" /> + <element name="relatedAntennaList" type="xn:dnList" /> + <element name="relatedCellList" type="xn:dnList" /> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gr:SectorEquipmentFunctionOptionallyContainedNrmClass"/> + + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="AntennaFunction" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + <element name="retTiltValue" type="gr:angleValue" +minOccurs="0"/> + <element name="bearing" type="gr:bearing" minOccurs="0"/> + <element name="retGroupName" type="gr:retGroupName" +minOccurs="0"/> + <element name="height" type="short" minOccurs="0"/> + <element name="maxAzimuthValue" type="gr:angleValue" +minOccurs="0"/> + <element name="minAzimuthValue" type="gr:angleValue" +minOccurs="0"/> + <element name="horizBeamwidth" type="gr:angleValue" +minOccurs="0"/> + <element name="vertBeamwidth" type="gr:angleValue" +minOccurs="0"/> + <element name="relatedCellList" type="xn:dnList" /> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gr:AntennaFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="TmaFunction" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + <element name="tmaSubunitNumber" type="unsignedShort" /> + +``` + +``` + + <element name="tmaStateFlag" type="gr:tmaStateFlag" /> + <element name="tmaFunctionFlag" type="gr:tmaFunctionFlag" /> + <element name="tmaMinGain" type="unsignedShort" /> + <element name="tmaMaxGain" type="unsignedShort" /> + <element name="tmaResolution" type="unsignedShort" /> + <element name="tmaGainFigure" type="unsignedShort" /> + <element name="tmaNumberOfSubunits" type="unsignedShort" /> + <element name="tmaBaseStationId" type="string" minOccurs="0"/> + <element name="tmaSectorId" type="string" minOccurs="0"/> + <element name="tmaAntennaBearing" type="unsignedShort" +minOccurs="0"/> + <element name="tmaInstalledMechanicalTilt" type="short" +minOccurs="0"/> + <element name="tmaSubunitType" type="unsignedShort" +minOccurs="0"/> + <element name="tmaSubunitRxFrequencyBand" type="gr:fourOctets" +minOccurs="0"/> + <element name="tmaSubunitTxFrequencyBand" type="gr:fourOctets" +minOccurs="0"/> + <element name="tmaGainResolution" type="unsignedShort" +minOccurs="0"/> + <element name="relatedCellList" type="xn:dnList"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gr:TmaFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="GSMCellPart" substitutionGroup="gn:GsmCellOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + <element name="aRFCN" type="string"/> + <element name="tsc" type="long"/> + <element name="aTA" type="short"/> + <element name="relatedSectorEquipment" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gr:GSMCellPartOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="CommonBSFunction" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + <element name="sharedTechnologies" type="short"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="gr:CommonBSFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </complexContent> + </complexType> +</element> + +<element name="SectorEquipmentFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="AntennaFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="TmaFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="GSMCellPartOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="CommonBSFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +</schema> + +``` + +### B.3.4 XML schema (file name "repeaterNrm.xsd") + +``` + +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.663 Generic RAN Network Resources IRP + Bulk CM Configuration data file NRM-specific XML schema + repeaterNrm.xsd +--> + +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.663#repeaterNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:rn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.663#repeaterNrm" +> + + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + /> + + <!-- Repeater Network Resources IRP NRM attribute related XML types --> + + <simpleType name="priority"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="268435455"/> + </restriction> + </simpleType> + + <simpleType name="dLAttenuation"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="268435455"/> + </restriction> + </simpleType> + + <simpleType name="uLAttenuation"> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="268435455"/> + </restriction> + </simpleType> + + <simpleType name="latitude"> + <restriction base="decimal"> + <fractionDigits value="4"/> + <minInclusive value="-90.0000"/> + <maxInclusive value="90.0000"/> + </restriction> + </simpleType> + +``` + +``` + +<simpleType name="longitude"> + <restriction base="decimal"> + <fractionDigits value="4"/> + <minInclusive value="-180.0000"/> + <maxInclusive value="180.0000"/> + </restriction> +</simpleType> + +<simpleType name="ctrlConnMode"> + <restriction base="string"> + <enumeration value="GSM_SMS"/> + <enumeration value="WCDMA_SMS"/> + <enumeration value="CIRCLE_SWITCH_DATA_CSD"/> + <enumeration value="PACKAGE_SWITCH_DAT_IP"/> + <enumeration value="SERIAL_PORT"/> + </restriction> +</simpleType> + +<simpleType name="powerSwitch"> + <restriction base="string"> + <enumeration value="ON"/> + <enumeration value="OFF"/> + </restriction> +</simpleType> + +<simpleType name="repeaterType"> + <restriction base="string"> + <enumeration value="WideBandReptFunction"/> + <enumeration value="FreqSelReptFunction"/> + <enumeration value="FiberReptFunction"/> + <enumeration value="IndoorReptFunction"/> + <enumeration value="FreqShiftReptFunction"/> + </restriction> +</simpleType> + +<!-- Repeater Network Resources IRP NRM class associated XML elements --> + +<element + name="RepeaterFunction " + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="priority" type="rn:priority"/> + <element name="latitude" type="rn:latitude"/> + <element name="longitude" type="rn:longitude"/> + <element name="ctrlConnMode" type="rn:ctrlConnMode"/> + <element name="environmentInfo" type="string"/> + <element name="powerSwitch" type="rn:powerSwitch"/> + <element name="dLAttenuation" type="rn:dLAttenuation"/> + <element name="uLAttenuation" type="rn:uLAttenuation"/> + <element name="firmwareVer" type="string"/> + <element name="repeaterType" type="rn:repeaterType"/> + <element name="repeaterFunctionExternalUtranCell" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2013-09 | SA#61 | SP-130443 | 0001 | 1 | F | Add missing Repeater Object SS definitions | 11.1.0 | | +| 2014-06 | SA#64 | SP-140332 | 0002 | - | F | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.2.0 | | +| | | SP-140359 | 0003 | - | F | remove the feature support statements | 11.2.0 | | +| 2014-09 | SA#65 | SP-140560 | 0004 | - | C | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | | +| 2015-12 | SA#70 | SP-150691 | 0005 | - | A | Make the XML schema well formed | 12.1.0 | | +| 2016-01 | SA#70 | | | | | Upgrade to Rel-13 (MCC) | 13.0.0 | | +| 2016-06 | SA#72 | SP-160408 | 0009 | - | A | Make the XML schema well formed | 13.1.0 | | +| 2016-06 | SA#72 | SP-160407 | 0010 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | | +| 2016-06 | SA#72 | SP-160408 | 0012 | - | A | XML attribute "longitude" is incorrectly defined | 13.1.0 | | +| 2016-09 | SA#73 | SP-160620 | 0014 | - | F | Correction in XML code | 13.2.0 | | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | | +| 2017-06 | SA#76 | SP-170514 | 0015 | - | F | Update link from IRP SS to IS | 14.1.0 | | +| 2017-06 | SA#76 | SP-170510 | 0016 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | | +| 2018-12 | SA#82 | SP-181156 | 0018 | 1 | F | Align frequency bands supported by the hardware associated with the SectorEquipmentFunction | 15.1.0 | | +| 2018-12 | SA#82 | SP-181156 | 0019 | 1 | F | Align SectorEquipmentFunction properties with that defined in stage 2 | 15.1.0 | | +| 2019-09 | SA#85 | SP-190752 | 0020 | - | F | Correct references and add definition of NRM | 15.2.0 | | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28667/raw.md b/marked/Rel-16/28_series/28667/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a54760c218e68d4ee7b70c7be8d41c17506d90c6 --- /dev/null +++ b/marked/Rel-16/28_series/28667/raw.md @@ -0,0 +1,245 @@ + + + + + + +# --- Contents + +| | | +|----------------------------------------------------------------------------------------------------|----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Concepts and background ..... | 6 | +| 4.1 General ..... | 6 | +| 4.2 Architecture ..... | 6 | +| 4.3 Functionality ..... | 6 | +| 5 Business level requirements..... | 6 | +| 5.1 Requirements..... | 6 | +| 5.2 Actor roles ..... | 6 | +| 5.3 Telecommunications resources ..... | 6 | +| 5.4 High-level use cases..... | 7 | +| 5.4.1 Use Case: Read planned data from the RPT..... | 7 | +| 6 Specification level requirements..... | 7 | +| 6.1 Requirements..... | 7 | +| 6.2 Actor roles ..... | 7 | +| 6.3 Telecommunications resources ..... | 7 | +| 6.4 Use cases ..... | 8 | +| 6.4.1 Use Case 1: Read planned site data ..... | 8 | +| 6.4.2 Use Case 2: Read planned antenna data ..... | 8 | +| 6.4.3 Use Case 3: Find out the planned antennas supporting a planned cell..... | 8 | +| 6.4.4 Use Case 4: Find out the planned cells supported by a planned antenna ..... | 8 | +| 6.4.5 Use Case 5: Find out the RAT of a planned cell ..... | 8 | +| <b>Annex A (informative): Relation of RPT Planned Data, ARCF data and configuration data .....</b> | <b>9</b> | +| Annex B (informative): Change history ..... | 10 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +**28.667 Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Requirements** + +28.668 Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Information Service (IS) + +28.669 Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document specifies the requirements of the Radio Planning Tool Access (RPTA) Integration Reference Point (IRP). This IRP allows to read site and antenna data from RPTs. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.501: "Telecommunication management; Self-configuration of network elements; Concepts and requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Radio Planning Tool:** The tool which is used for radio network planning, where the planning process typically includes radio frequencies assigning, sites and site locations determination, traffic planning, interference analysis, and configuration parameters planning to provide sufficient coverage and capacity for a radio network. + +**Planned Data:** It is the data exposed by the RPT for read access by the NM. + +## 3.2 Abbreviations + +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]. + +| | | +|------|-----------------------------------| +| NMLS | Network Management Layer Service | +| RPT | Radio Planning Tool | +| RPTA | Radio Planning Tool Access (RPTA) | +| SC | Service Consumer | +| SP | Service Provider | + +# --- 4 Concepts and background + +## 4.1 General + +The initial planning of radio parameters is typically done with specialized tools called Radio Planning Tools (RPTs). RPTs generate throughput and capacity estimations as well as predictions for coverage and interference maps. RPTs utilize site and antenna (equipment) information, as well as geographic data (e.g. terrain data, type of land usage, building data and road data). This data has to be entered into the tools. + +In order to improve the initial network planning, planned site and antenna data are adjusted until the estimated system performance meets the requirements within the given deployment constraints. + +Information about the sites and antennas is needed also by other applications, like SON applications or CM applications on NM level. For this reason it is beneficial if this data can be read via standardized interfaces. + +In contrast to configuration information it is normally not possible to read this data from the network elements. + +The only place where this data is available in many deployment scenarios is in the RPT. Though this data represents initial planning, site data and antenna data are not likely to be changed very often, so that there is a fair chance that the data stored by the RPT represents also the actual situation in the network. + +For this reason it is beneficial to have a read access to site and antenna data stored by the RPT. + +It is to be noted that this TS series is only about the read access to site and antenna data. It is not concerned with any other functionality the RPT might have, nor with how the read data is used, nor if the read data represents the actual information about the network or if the data is outdated. Reading of site and antenna data stored by the RPT is hence the only use case in scope. + +## 4.2 Architecture + +The RPT is a kind of NMLS (see TS 32.101 [2]). + +## 4.3 Functionality + +The RPT offers a capability allowing read access to site and antenna data. The RPT is a Service Provider (SP) and the NM a Service Consumer (SC). The RPTA IRP specifies the information model exposed by the RPT, and the operations to access it. + +# --- 5 Business level requirements + +## 5.1 Requirements + +**REQ-RPT\_NRM-CON-001:** The RPT shall support a capability allowing the NM to retrieve planned data from the RPT. + +## 5.2 Actor roles + +The function at the NM requesting to read planned data from the RPT. + +## 5.3 Telecommunications resources + +**RPT:** The Radio Planning Tool storing the planned data and exposing it by its Service Provider (SP) function. + +**NM:** The Network Manager requesting the planned data by its Service Consumer (SC) function. + +**SP in the RPT:** The Service Provider (SP) in the RPT offering read access to planned data in the RPT. + +**SC in the NM:** The Service Consumer (SC) in the NM using services offered by the RPT. + +## 5.4 High-level use cases + +### 5.4.1 Use Case: Read planned data from the RPT + +| Use case stage | Evolution/Specification | <<Uses>><br>Related use | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Goal | The NM reads planned data from the RPT. | | +| Actors and Roles | The function in the NM requesting to read planned data from the RPT. | | +| Telecom resources | RPT, NM, SP in the RPT, SC in the NM. | | +| Assumptions | Connectivity exists between RPT SP and the NM SC, so that SP and SC can communicate. | | +| Pre-conditions | The network is planned and the planned data is stored and available in the RPT. | | +| Begins when | The NM SC requests the RPT SP to provide certain planned data stored in the RPT by sending an appropriate request message to the RPT SP. | | +| Step 1 (M) | The RPT SP receives the request message. | | +| Step 2 (M) | The RPT processes the request message, identifies the requested planned data and retrieves the requested planned data. | | +| Step 3 (M) | The RPT SP sends back to the NM SC the requested planned data in a response message. | | +| Ends when | The NM SC has received the requested planned data. | | +| Exceptions | The NM SC does not receive the requested planned data. Numerous failure reasons may be indicated. | | +| Post-conditions | The requested planned data has been returned.<br>The planned data stored in RPT before and after the exchange of the request/response messages are identical. | | +| Traceability | Requirement REQ-RPT_NRM-CON-001 in clause 5.1. | | + +# 6 Specification level requirements + +## 6.1 Requirements + +**REQ-RPT\_NRM-FUN-001:** The RPT shall support a capability allowing the NM to retrieve planned site data (e.g. site latitude, site longitude) from the RPT. + +**REQ-RPT\_NRM-FUN-002:** The RPT shall support a capability allowing the NM to retrieve planned antenna data (e.g. antenna latitude, antenna longitude, antenna type, pattern label, antenna tilt) from the RPT. + +**REQ-RPT\_NRM-FUN-003:** The RPT shall support a capability allowing the NM to find out the planned antennas supporting a planned cell. + +**REQ-RPT\_NRM-FUN-004:** The RPT shall support a capability allowing the NM to find out the planned cells supported by a planned antenna. + +**REQ-RPT\_NRM-FUN-005:** The RPT shall support a capability allowing the NM to find out the RAT of a planned cell. + +## 6.2 Actor roles + +See clause 5.2. + +## 6.3 Telecommunications resources + +See clause 5.3. + +## 6.4 Use cases + +### 6.4.1 Use Case 1: Read planned site data + +The use case in clause 5.4.1 describes in generic fashion the use case on reading planned data from the RPT. In the use case "Read planned site data" this information is planned site data. + +### 6.4.2 Use Case 2: Read planned antenna data + +The use case in clause 5.4.1 describes in generic fashion the use case on reading planned data from the RPT. In the use case "Read planned antenna data" this information is planned antenna data. + +### 6.4.3 Use Case 3: Find out the planned antennas supporting a planned cell + +The use case in clause 5.4.1 describes in generic fashion the use case on reading planned data from the RPT. In the use case "Find out the planned antennas supporting a planned cell" this information is data about which planned antennas support a planned cell. The data returned contains thus for each cell identifier a set of antenna identifiers. + +### 6.4.4 Use Case 4: Find out the planned cells supported by a planned antenna + +The use case in clause 5.4.1 describes in generic fashion the use case on reading planned data from the RPT. In the use case "Find out the planned cells supported by a planned antenna" this information is data about which planned cells are supported by a planned antenna. The data returned contains thus for each antenna identifier a set of cell identifiers. + +### 6.4.5 Use Case 5: Find out the RAT of a planned cell + +The use case in clause 5.4.1 describes in generic fashion the use case on reading planned data from the RPT. In the use case "Find out the RAT of a planned cell" this information is data about the RATs of the planned cells. + +# --- Annex A (informative): Relation of RPT Planned Data, ARCF data and configuration data + +There are several kinds of data defined in 32- and 28-series standards. + +ARCF data are the data which are required for successful activation (of e.g. cell, eNB) that require coordination between several cells and cannot be generated below Itf-N. Some of the ARCF data may be used directly as eNodeB configuration data and some of the ARCF data may be used to generate more other eNodeB configuration data. eNodeB will use the ARCF data together with other configuration data as initial eNodeB radio configuration data. The eNodeB initial radio configuration data will be used for self-configuration. + +Configuration data are normally defined as NRM IRP data. + +Planned Data, which is the data exposed by the RPT for read access by the NM, may be different from those used during NM normal operation of the actual network. + +The relation between different kinds of data is: + +- 1) The Planned Data are stored in RPT. NM or other NM layer applications can retrieve Planned Data from RPT. Some of the Planned Data retrieved from RPT can be used directly as configuration data or ARCF data (e.g. antenna data like antennaAzimuth and antennaTilt). +- 2) Some of the ARCF data are used as configuration data directly and other ARCF data are used to generate more other configuration data, see TS 32.501 [3]. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-12 | SA#66 | SP-140792 | | | Presented for approval | 1.2.0 | 2.0.0 | +| | | | | | Version after approval | 2.0.0 | 12.0.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13(MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28668/0236eff05bcb8f3a343ea7933aaa306b_img.jpg b/marked/Rel-16/28_series/28668/0236eff05bcb8f3a343ea7933aaa306b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c4a64cd9c57bc0dd137a45eeec078f4ff0c6835 --- /dev/null +++ b/marked/Rel-16/28_series/28668/0236eff05bcb8f3a343ea7933aaa306b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8202f04b6181ba90b90acebd8a98aece684bea57b7fb12c6b3e5a0952954a54e +size 12388 diff --git a/marked/Rel-16/28_series/28668/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/28_series/28668/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4669bb54d05cf77523b11477b56404bfebd2a232 --- /dev/null +++ b/marked/Rel-16/28_series/28668/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:217b24ecbbb7277b04ed5e4f2e0ebde405a1e62a0df3595652c0c5dd5376940d +size 18972 diff --git a/marked/Rel-16/28_series/28668/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-16/28_series/28668/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f86b7dffd257c071cf49bf3c604706911e37569e --- /dev/null +++ b/marked/Rel-16/28_series/28668/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f42cf79654dff74c86aeb58cdc3bad73cf3861db9c6b547eb3700703a9360eaf +size 34102 diff --git a/marked/Rel-16/28_series/28668/e1a0d046fbe7f28f5e93a47091851747_img.jpg b/marked/Rel-16/28_series/28668/e1a0d046fbe7f28f5e93a47091851747_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d547ca7cacc205820ad13357f063e20e58dbe6b6 --- /dev/null +++ b/marked/Rel-16/28_series/28668/e1a0d046fbe7f28f5e93a47091851747_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3218b6b9055a9ada4db421fc1aeab5367fe17ad9c6b96e69b8dce799b05d774 +size 26329 diff --git a/marked/Rel-16/28_series/28668/raw.md b/marked/Rel-16/28_series/28668/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5379565dc6f98cd99eca6498ea43b71782b34158 --- /dev/null +++ b/marked/Rel-16/28_series/28668/raw.md @@ -0,0 +1,601 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 System overview ..... | 7 | +| 4.1 System Context ..... | 7 | +| 4.2 Compliance rules..... | 7 | +| 5 Information Object Classes..... | 7 | +| 5.1 Imported information entities and local labels..... | 7 | +| 5.2 Class diagram..... | 8 | +| 5.2.1 Attributes and relationships ..... | 8 | +| 5.2.2 Inheritance ..... | 8 | +| 5.3 Information object class definitions ..... | 9 | +| 5.3.1 Antenna ..... | 9 | +| 5.3.1.1 Definition ..... | 9 | +| 5.3.1.2 Attributes ..... | 9 | +| 5.3.1.3 Attribute constraints..... | 9 | +| 5.3.1.4 Notifications..... | 9 | +| 5.3.2 Cell..... | 9 | +| 5.3.2.1 Definition ..... | 9 | +| 5.3.2.2 Attributes ..... | 9 | +| 5.3.2.3 Attribute constraints..... | 9 | +| 5.3.2.4 Notifications..... | 10 | +| 5.3.3 GSMCell ..... | 10 | +| 5.3.3.1 Definition ..... | 10 | +| 5.3.3.2 Attributes ..... | 10 | +| 5.3.3.3 Attribute constraints..... | 10 | +| 5.3.3.4 Notifications..... | 10 | +| 5.3.4 EUTRANCell ..... | 10 | +| 5.3.4.1 Definition ..... | 10 | +| 5.3.4.2 Attributes ..... | 10 | +| 5.3.4.3 Attribute constraints..... | 10 | +| 5.3.4.4 Notifications..... | 10 | +| 5.3.5 Site..... | 11 | +| 5.3.5.1 Definition ..... | 11 | +| 5.3.5.2 Attributes ..... | 11 | +| 5.3.5.3 Attribute constraints..... | 11 | +| 5.3.5.4 Notifications..... | 11 | +| 5.3.6 SiteList ..... | 11 | +| 5.3.6.1 Definition ..... | 11 | +| 5.3.6.2 Attributes ..... | 11 | +| 5.3.6.3 Attribute constraints..... | 11 | +| 5.3.6.4 Notifications..... | 11 | +| 5.3.7 UTRANCell ..... | 12 | +| 5.3.7.1 Definition ..... | 12 | +| 5.3.7.2 Attributes ..... | 12 | +| 5.3.7.3 Attribute constraints..... | 12 | +| 5.3.7.4 Notifications..... | 12 | +| 5.4 Information relationship definitions ..... | 12 | +| 5.4.1 A1 (M)..... | 12 | +| 5.4.1.1 Definition ..... | 12 | +| 5.4.1.2 Roles ..... | 12 | + +5.4.1.3 Constraints ..... 12 + +5.5 Information attribute definitions ..... 13 + +5.5.1 Definition and legal values..... 13 + +5.5.2 Constraints ..... 14 + +6 Interface definitions ..... 14 + +6.1 Class diagram representing interfaces..... 14 + +6.2 Generic rules ..... 15 + +6.3 RptOperations\_1 Interface (M) ..... 15 + +6.3.1 Operation getPlannedData (M) ..... 15 + +6.3.1.1 Definition ..... 15 + +6.3.1.2 Input parameters ..... 15 + +6.3.1.3 Output parameters ..... 15 + +6.3.1.4 Pre-condition..... 15 + +6.3.1.5 Post-condition ..... 16 + +6.3.1.6 Exception ..... 16 + +Annex A (informative): Change history..... 17 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.667 Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Requirements +- 28.668 Radio Planning Tool Access (RPTA) Integration Reference Point (IRP): Information Service (IS)** +- 28.669 Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document specifies the Radio Planning Tool Access (RPTA) management operations as well as support object classes, attributes and relations that can be communicated between the Service Provider in the RPT and one or several Service Consumers in the NM. + +This document specifies the semantics and behaviour of management operations, support object classes, attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +This IRP allows the NM to read planned site and antenna data from the RPT. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [3] 3GPP TS 28.632: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [4] 3GPP TS 28.662: "Telecommunication management; Generic Radio Access Network (RAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 28.667: "Telecommunication management; Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Requirements". +- [6] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Radio Planning Tool:** See TS 28.667 [5]. + +## 3.2 Abbreviations + +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]. + +| | | +|------|----------------------------------| +| RPT | Radio Planning Tool | +| RPTA | Radio Planning Tool (RPT) Access | +| SC | Service Consumer | +| SP | Service Provider | + +# 4 System overview + +## 4.1 System Context + +The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [6], subclause 4.7. The RPT is the SP, the NM is the SC. + +![Diagram of System Context for Type 7 interface](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +The diagram illustrates the system context for a Type 7 interface. On the left, a box labeled 'RPT' contains a smaller box labeled 'SP'. On the right, a box labeled 'NM' contains a smaller box labeled 'SC'. A solid horizontal line connects the 'SP' box to the 'SC' box. A vertical dashed line, labeled 'Type 7 interface' at its base, separates the two sides. A curved arrow points from the label 'RPTA IRP' to the dashed line. + +Diagram of System Context for Type 7 interface + +Figure 4.1.1: System Context for Type 7 interface + +## 4.2 Compliance rules + +For general definitions of compliance rules related to qualifiers (Mandatory/Optional/Conditional) for *operations, notifications and parameters* (of operations and notifications) please refer to 3GPP TS 32.150 [6]. + +A SP that incorporates vendor-specific extensions shall support normal communication with a 3GPP SA5-compliant SC with respect to all Mandatory and Optional managed object classes, attributes, associations, operations, parameters and notifications without requiring the SC to have any knowledge of the extensions. + +Given that: + +- rules for vendor-specific extensions remain to be fully specified; and +- many scenarios under which SC and SP interwork may exist. + +It is recognized that the SC, even though it is not required to have knowledge of vendor-specific extensions, may be required to be implemented with an awareness that extensions can exist and behave accordingly. + +# 5 Information Object Classes + +## 5.1 Imported information entities and local labels + +None. + +## 5.2 Class diagram + +### 5.2.1 Attributes and relationships + +![UML Class diagram showing relationships between SiteList, Site, Antenna, and Cell classes.](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +``` +classDiagram + class SiteList { + <<SupportIOC>> + } + class Site { + <<SupportIOC>> + } + class Antenna { + <<SupportIOC>> + } + class Cell { + <<SupportIOC>> + } + SiteList "1" *-- "*" Site : + Site "1" *-- "*" Antenna : theSupportingAntennas + Site "1" *-- "*" Cell : theSupportedCells +``` + +The diagram illustrates the information model of the RPTA IRP. It consists of four classes: **SiteList**, **Site**, **Antenna**, and **Cell**, all stereotyped as **<<SupportIOC>>**. **SiteList** has a composition relationship with **Site** (multiplicity 1 to \*). **Site** has composition relationships with **Antenna** (multiplicity 1 to \*, role name **theSupportingAntennas**) and **Cell** (multiplicity 1 to \*, role name **theSupportedCells**). **Antenna** has a role name **A1** with a multiplicity of \*. + +UML Class diagram showing relationships between SiteList, Site, Antenna, and Cell classes. + +Figure 5.2.1-1: Information Model of the RPTA IRP + +### 5.2.2 Inheritance + +![UML Class diagram showing inheritance from Cell to GSMCell, UTRANCell, and EUTRANCell.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +``` +classDiagram + class Cell { + <<SupportIOC>> + } + class GSMCell { + <<SupportIOC>> + } + class UTRANCell { + <<SupportIOC>> + } + class EUTRANCell { + <<SupportIOC>> + } + Cell <|-- GSMCell + Cell <|-- UTRANCell + Cell <|-- EUTRANCell +``` + +The diagram shows inheritance relationships. The base class is **Cell** (stereotype **<<SupportIOC>>**). It is inherited by three subclasses: **GSMCell**, **UTRANCell**, and **EUTRANCell**, all of which also have the stereotype **<<SupportIOC>>**. + +UML Class diagram showing inheritance from Cell to GSMCell, UTRANCell, and EUTRANCell. + +Figure 5.2.2-1: Inheritance diagram + +## 5.3 Information object class definitions + +### 5.3.1 Antenna + +#### 5.3.1.1 Definition + +This SupportIOC represents an antenna. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-002 | | +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-003 | | +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-004 | | + +#### 5.3.1.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|-------------------------|-------------------|----------------|-----------------| +| antennaId | M | M | - | +| antennaName | M | M | - | +| antennaPatternLabel | M | M | - | +| antennaType | M | M | - | +| antennaLongitude | M | M | - | +| antennaLatitude | M | M | - | +| antennaAltitude | M | M | - | +| antennaBearing | M | M | - | +| antennaMechanicalOffset | M | M | - | +| theSupportedCells | M | M | - | + +#### 5.3.1.3 Attribute constraints + +None. + +#### 5.3.1.4 Notifications + +None. + +### 5.3.2 Cell + +#### 5.3.2.1 Definition + +This SupportIOC represents a cell. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-003 | | +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-004 | | + +#### 5.3.2.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|-----------------------|-------------------|----------------|-----------------| +| cellId | M | M | - | +| theSupportingAntennas | M | M | - | + +#### 5.3.2.3 Attribute constraints + +None. + +#### 5.3.2.4 Notifications + +None. + +### 5.3.3 GSMCell + +#### 5.3.3.1 Definition + +This SupportIOC represents a GSM cell. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-005 | | + +#### 5.3.3.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------|-------------------|----------------|-----------------| +| | | | | + +#### 5.3.3.3 Attribute constraints + +None. + +#### 5.3.3.4 Notifications + +None. + +### 5.3.4 EUTRANCell + +#### 5.3.4.1 Definition + +This SupportIOC represents an E-UTRAN cell. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-005 | | + +#### 5.3.4.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------|-------------------|----------------|-----------------| +| | | | | + +#### 5.3.4.3 Attribute constraints + +None. + +#### 5.3.4.4 Notifications + +None. + +### 5.3.5 Site + +#### 5.3.5.1 Definition + +This SupportIOC represents a site. A site designates the location of the base station (TR 21.905 [1]), and properties associated to the site such as site address, exact location and site name. In case the antenna is not at the same location as the (rest of the) base station, site designates the location of the main base station equipment. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-001 | | + +#### 5.3.5.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------|-------------------|----------------|-----------------| +| siteId | M | M | - | + +| | | | | +|---------------|---|---|---| +| siteAddress | M | M | - | +| siteName | M | M | - | +| siteLongitude | M | M | - | +| siteLatitude | M | M | - | +| siteAltitude | O | M | - | + +#### 5.3.5.3 Attribute constraints + +None. + +#### 5.3.5.4 Notifications + +None. + +### 5.3.6 SiteList + +#### 5.3.6.1 Definition + +This SupportIOC represents a list of sites. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-001 | | + +#### 5.3.6.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------|-------------------|----------------|-----------------| +| | | | | + +#### 5.3.6.3 Attribute constraints + +None. + +#### 5.3.6.4 Notifications + +None. + +### 5.3.7 UTRANCell + +#### 5.3.7.1 Definition + +This SupportIOC represents a UTRAN cell. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-005 | | + +#### 5.3.7.2 Attributes + +| Attribute name | Support Qualifier | Read Qualifier | Write Qualifier | +|----------------|-------------------|----------------|-----------------| +| | | | | + +#### 5.3.7.3 Attribute constraints + +None. + +#### 5.3.7.4 Notifications + +None. + +## 5.4 Information relationship definitions + +### 5.4.1 A1 (M) + +#### 5.4.1.1 Definition + +This association represents the bidirectional relation between Antenna and Cell. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-003 | | +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-FUN-004 | | + +#### 5.4.1.2 Roles + +| Name | Definition | +|-----------------------|---------------------------------------------------------------------------| +| theSupportingAntennas | This role represents the Antenna instances supporting a Cell instance. | +| theSupportedCells | This role represents the Cell instances supported by an Antenna instance. | + +#### 5.4.1.3 Constraints + +None. + +## 5.5 Information attribute definitions + +### 5.5.1 Definition and legal values + +The following table defines the attributes that are present in the Support Object Classes of the present document. + +| Attribute Name | Definition | Information Type / Legal Values | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| antennaBearing | The bearing that the antenna is pointing to, see TS 23.032 [2]<br><br>allowedValues: see TS 23.032 [2]<br><br>NOTE: Identical to TS 28.662 [4] AntennaFunction::bearing | type: Integer | +| antennaAltitude | The elevation of the antenna above sea level.<br><br>allowedValues: An integral value representing a number of meters in 0.1 meter increments.<br><br>NOTE: Identical to TS 28.662 [4] AntennaFunction::height | type: Integer | +| antennaId | Operator defined antenna identifier<br><br>allowedValues: N/A | type: String | +| antennaLatitude | The latitude of the antenna location based on the World Geodetic System (1984 version) global reference frame (WGS 84).<br><br>Positive values correspond to north of 0 degrees latitude (northern hemisphere).<br><br>allowedValues: valid values are described in TS 23.032 [2]<br><br>NOTE: Identical to TS 28.632 [3] AntennaInventoryUnit::latitude<br><br><i>Editor's note: The exact definition is ffs, and needs to be aligned with other definitions of latitude/longitude.</i> | type: Real | +| antennaLongitude | The longitude of the antenna location based on the World Geodetic System (1984 version) global reference frame (WGS 84).<br><br>Positive values correspond to east of 0 degrees longitude.<br><br>allowedValues: valid values are described in TS 23.032 [2]<br><br>NOTE: Identical to TS 28.632 [3] AntennaInventoryUnit::longitude<br><br><i>Editor's note: The exact definition is ffs, and needs to be aligned with other definitions of latitude/longitude.</i> | type: Real | + +| Attribute Name | Definition | Information Type / Legal Values | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| antennaMechanicalOffset | <p>This is a value representing a non-adjustable tilt value, which is imparted to the antenna due to the physical installation.</p> <p>The actual tilt at any point in time is the summation of mechanicalOffset and retTiltValue.</p> <p>A single integral value corresponding to an angle in degrees between 0 and 360 with a resolution of 0.1 degrees.</p> <p>allowedValues: N/A</p> <p>NOTE: Identical to TS 28.632 [3] AntennalInventoryUnit::mechanicalOffset</p> | type: Integer | +| antennaName | <p>Name of the antenna. It is a free text field.</p> <p>allowedValues: N/A</p> | type: String | +| antennaPatternLabel | <p>The radiation pattern of the antenna, also referred to as antenna pattern.</p> <p>allowedValues: N/A</p> <p>NOTE: Identical to TS 28.632 [3] AntennalInventoryUnit::patternlabel</p> | type: String | +| antennaType | <p>The type of the antenna. Types are e.g. repeaters, remote antennas, power dividers.</p> <p>allowedValues: N/A</p> | Type: String | +| cellId | Operator defined cell identifier. | type: String | +| siteAddress | <p>Address of the site</p> <p>allowedValues: N/A</p> | type: String | +| siteAltitude | <p>The elevation of the site above sea level.</p> <p>allowedValues: An integral value representing a number of meters in 0.1 meter increments.</p> | type: Integer | +| siteId | <p>Operator defined site identifier.</p> <p>allowedValues: N/A</p> | type: String | +| siteLatitude | <p>The latitude of the site location based on the World Geodetic System (1984 version) global reference frame (WGS 84).</p> <p>Positive values correspond to north of 0 degrees latitude (northern hemisphere).</p> <p>allowedValues: valid values are described in 3GPP TS 23.032 [2]</p> <p><i>Editor's note: The exact definition is ffs, and needs to be aligned with other definitions of latitude/longitude.</i></p> | type: Real | +| siteLongitude | <p>The longitude of the site location based on the World Geodetic System (1984 version) global reference frame (WGS 84).</p> <p>Positive values correspond to east of 0 degrees longitude.</p> <p>allowedValues: valid values are described in 3GPP TS 23.032 [2]</p> <p><i>Editor's note: The exact definition is ffs, and needs to be aligned with other definitions of latitude/longitude.</i></p> | type: Real | +| siteName | <p>Name of the site. It is a free text field.</p> <p>allowedValues: N/A</p> | type: String | +| <b>Attributes related to role</b> | | | +| theSupportedCells | This attribute carries a set of cellId. | | +| theSupportingAntennas | This attribute carries a set of antennaId. | | + +### 5.5.2 Constraints + +None. + +# 6 Interface definitions + +## 6.1 Class diagram representing interfaces + +![UML Class diagram showing a class RptIRP (labeled <<SupportIOC>>) inheriting from an interface RptOperations_1 (labeled <<Interface>>). The interface defines a method getPlannedData().](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +classDiagram + class RptIRP { + <<SupportIOC>> + } + class RptOperations_1 { + <<Interface>> + getPlannedData() + } + RptIRP ..|> RptOperations_1 + +``` + +UML Class diagram showing a class RptIRP (labeled <>) inheriting from an interface RptOperations\_1 (labeled <>). The interface defines a method getPlannedData(). + +Figure 6.1-1: Class diagram representing interfaces + +## 6.2 Generic rules + +Rule 1: Each operation with at least one input parameter supports a pre-condition `valid_input_parameter` which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception `operation_failed_invalid_input_parameter` which is raised when pre-condition `valid_input_parameter` is false. The exception has the same entry and exit state. + +Rule 2: Each operation with at least one optional input parameter supports a set of pre-conditions `supported_optional_input_parameter_xxx` where "xxx" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception `operation_failed_unsupported_optional_input_parameter_xxx` which is raised when (a) the pre-condition `supported_optional_input_parameter_xxx` is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state. + +Rule 3: Each operation shall support a generic exception `operation_failed_internal_problem` that is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state. + +## 6.3 RptOperations\_1 Interface (M) + +### 6.3.1 Operation getPlannedData (M) + +#### 6.3.1.1 Definition + +The NM invokes this operation to read planned data from the RPT. + +| Referenced TS | Requirement label | Comment | +|--------------------|---------------------|---------| +| 3GPP TS 28.667 [5] | REQ-RPT_NRM-CON-001 | | + +#### 6.3.1.2 Input parameters + +| Name | Qualifier | Matching Type | Comment | +|-------|-----------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scope | M | Information specifying the scope | This parameter defines the subset of planned data to be returned. In Rel-12 only all planned data can be selected. The absence of an input parameter is equivalent to ALL. The semantics of scope is undefined in Rel-12. | + +#### 6.3.1.3 Output parameters + +| Name | Qualifier | Matching Information | Comment | +|-------------|-----------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| plannedData | M | SiteList | This parameter returns all planned data held by the RPT. The data structure is described by the information model specified in subclause 5. | +| status | M | ENUM (OperationSucceeded, OperationFailed) | If allScopedPlannedDataReturned is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. | + +#### 6.3.1.4 Pre-condition + +networkPlanned + +| Assertion Name | Definition | +|----------------|---------------------------------------------------------------------------------------------| +| networkPlanned | The network is planned and the planned data is stored and available for reading in the RPT. | + +#### 6.3.1.5 Post-condition + +allScopedPlannedDataReturned + +| Assertion Name | Definition | +|------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| allScopedPlannedDataReturned | All data selected by the scope input parameter is returned. The planned data in the RPT is not affected by this operation. | + +#### 6.3.1.6 Exception + +| Assertion Name | Definition | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operation_failed | <b>Condition:</b> The pre-condition is false or the post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|-------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-12 | SA#66 | SP-140793 | | | Presented for approval | 1.2.0 | 2.0.0 | +| | | | | | Version after approval | 2.0.0 | 12.0.0 | +| 2016-01 | SA#70 | | | | Upgrade to Rel-13 (MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28669/raw.md b/marked/Rel-16/28_series/28669/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bcd67b64a742e1e1ae61e4337b86b33e3686aa6a --- /dev/null +++ b/marked/Rel-16/28_series/28669/raw.md @@ -0,0 +1,900 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------|-----------| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Solution Set Definitions ..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 Introduction..... | 8 | +| <b>Annex B (normative): XML definitions.....</b> | <b>9</b> | +| B.0 Introduction..... | 9 | +| B.1 Architectural features..... | 9 | +| B.1.1 General ..... | 9 | +| B.1.2 Description of the XML definitions ..... | 9 | +| B.2 Mapping ..... | 9 | +| B.3 Solution Set definitions..... | 9 | +| B.3.1 XML Schema "rptaIrPIOCs.xsd" ..... | 9 | +| B.3.2 XML Schema "rptaIRPopR.xsd" ..... | 11 | +| <b>Annex C (normative): HTTP Solution Set .....</b> | <b>13</b> | +| C.0 Introduction..... | 13 | +| C.1 Architectural features..... | 13 | +| C.1.1 General ..... | 13 | +| C.1.2 Supported Specifications..... | 13 | +| C.1.3 Introduction to HTTP-GET ..... | 13 | +| C.1.4 Usage of HTTP-GET ..... | 14 | +| C.1.5 Request-URI..... | 14 | +| C.1.6 Headers..... | 14 | +| C.2 Mapping ..... | 15 | +| C.2.0 Introduction..... | 15 | +| C.2.1 Operation and Notification mapping..... | 15 | +| C.2.2 Operation parameter mapping..... | 16 | +| C.3 Solution Set definitions..... | 17 | +| C.3.1 XML Schema "rptaIRPHTTP.xsd" ..... | 17 | +| C.3.2 JSON definition structure..... | 17 | +| <b>Annex D (normative): SOAP Solution Set.....</b> | <b>19</b> | +| D.0 Introduction..... | 19 | +| D.1 Architectural features..... | 19 | +| D.1.1 General ..... | 19 | +| D.1.2 Supported W3C specifications..... | 19 | +| D.1.3 Filter language..... | 19 | +| D.2 Mapping ..... | 20 | +| D.2.1 Operation and Notification mapping..... | 20 | +| D.2.2 Operation parameter mapping..... | 21 | + +D.2.2.1 Operation getPlannedData.....21 +D.2.2.1.1 Input parameters .....21 +D.2.2.1.2 Output parameters.....21 +D.2.2.1.3 Fault definition.....21 +D.3 Solution Set definitions.....21 +D.3.1 WSDL definition structure .....21 +D.3.2 Graphical Representation .....22 +D.3.3 WSDL specification "RPTAIRPSystem.wsdl" .....23 +Annex E (informative): Change history.....25 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.667: Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Requirements. +- 28.668: Radio Planning Tool Access (RPTA) Integration Reference Point (IRP): Information Service (IS). +- 28.669: Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Solution Set (SS). +definitions** + +# --- 1 Scope + +The present document specifies the Solution Set definitions (SS) of the Radio Planning Tool Access (RPTA) Integration Reference Point (IRP). This IRP allows the NM to read planned site and antenna data from the RPT. + +This Solution Set specification is related to 3GPP TS 28.668 V14.0.X [4]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 28.668: "Telecommunication management; Radio Planning Tool Access (RPTA) Integration Reference Point (IRP); Information Service (IS)". +- [5] IETF RFC 2616: "Hypertext Transfer Protocol -- HTTP/1.1" (<https://www.ietf.org/rfc/rfc2616.txt>) +- [6] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format" (<https://www.ietf.org/rfc/rfc7159.txt>) +- [7] W3C SOAP 1.1 specification (<http://www.w3.org/TR/2000/NOTE-SOAP-20000508/>) +- [8] W3C WSDL 1.1 specification (<http://www.w3.org/TR/2001/NOTE-wsdl-20010315>) +- [9] W3C XPath 1.0 specification (<http://www.w3.org/TR/1999/REC-xpath-19991116>) +- [10] W3C SOAP 1.2 specification (<http://www.w3.org/TR/soap12-part1/>) +- [11] IETF RFC 7230: "[HTTP/1.1: Message Syntax and Routing](https://www.ietf.org/rfc/rfc7230.txt)" (<https://www.ietf.org/rfc/rfc7230.txt>) +- [12] IETF RFC 7231: "[HTTP/1.1: Semantics and Content](https://www.ietf.org/rfc/rfc7231.txt)" (<https://www.ietf.org/rfc/rfc7231.txt>) +- [13] IETF RFC 7232: "[HTTP/1.1: Conditional Requests](https://www.ietf.org/rfc/rfc7232.txt)" (<https://www.ietf.org/rfc/rfc7232.txt>) +- [14] IETF RFC 7233: "[HTTP/1.1: Range Requests](https://www.ietf.org/rfc/rfc7233.txt)" (<https://www.ietf.org/rfc/rfc7233.txt>) +- [15] IETF RFC 7234: "[HTTP/1.1: Caching](https://www.ietf.org/rfc/rfc7234.txt)" (<https://www.ietf.org/rfc/rfc7234.txt>) +- [16] IETF RFC 7235: "[HTTP/1.1: Authentication](https://www.ietf.org/rfc/rfc7235.txt)" (<https://www.ietf.org/rfc/rfc7235.txt>) + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 28.668 [4] 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]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|----------------------------------| +| IS | Information Service | +| SS | Solution Set | +| WSDL | Web Service Description Language | + +# --- 4 Solution Set Definitions + +The present document defines the following RPTA IRP Solution Set Definitions: + +Annex A provides the CORBA Solution Set. + +Annex B provides the XML Definitions. + +Annex C provides the HTTP Solution Set. + +Annex D provides the SOAP Solution Set. + +# --- Annex A (normative): CORBA Solution Set + +## A.0 Introduction + +This annex specifies the CORBA Solution Set for the IRP whose semantics are specified in 3GPP TS 28.668 [4]. + +This annex is not provided in the current version of the present document. + +# Annex B (normative): XML definitions + +## B.0 Introduction + +This annex specifies the XML definitions for the IRP whose semantics are specified in 3GPP TS 28.668 [4]. + +## B.1 Architectural features + +### B.1.1 General + +The overall architectural feature of RPTA IRP is specified in 3GPP TS 28.668 [3]. This clause specifies features that are specific to the XML definitions. + +### B.1.2 Description of the XML definitions + +This annex specifies the XML definitions for the Support IOCs of the RPTA IRP in rptaIrpIOCs.xsd. It provides also the XML type definitions used for constructing the getPlannedData() response in rptaIRPOpR.xsd. + +## B.2 Mapping + +The mapping is not present in this version of the present document. + +## B.3 Solution Set definitions + +### B.3.1 XML Schema "rptaIrpIOCs.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.669 Radio Planning Tool Access (RPTA) IRP + XML Schema definitions of the Support Object Classes + rptaIrpIOCs.xsd +--> + +<schema + + <!-------> + <!-- Name spaces + --> + <!-------> + + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIrpIOCs" + + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xpi="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIrpIOCs" + elementFormDefault="qualified"> + + <!-------> + <!-- RPTA IRP information model attribute type related XML types + --> + <!-------> + + <simpleType name="angleType"> + <restriction base="short"> + <minInclusive value="0"/> + <maxInclusive value="3600"/> + </restriction> + </simpleType> + + <simpleType name="bearingType"> + <restriction base="short"> + <minInclusive value="0"/> + <maxInclusive value="360"/> + </restriction> + </simpleType> +``` + +``` + +</simpleType> + +<complexType name="idListType"> + <sequence minOccurs="0" maxOccurs="unbounded"> + <element name="id" type="string"/> + </sequence> +</complexType> + +<simpleType name="longitudeType"> + <restriction base="decimal"> + <fractionDigits value="4"/> + <minInclusive value="-180.0000"/> + <maxInclusive value="+180.0000"/> + </restriction> +</simpleType> + +<simpleType name="latitudeType"> + <restriction base="decimal"> + <fractionDigits value="4"/> + <minInclusive value="-90.0000"/> + <maxInclusive value="+90.0000"/> + </restriction> +</simpleType> + +<!-- RPTA IRP information model class associated XML elements --> +<!-------> + +<element name="Antenna"> + <complexType> + <element name="attributes" minOccurs="0"> + <complexType> + <sequence> + <element name="antennaId" type="string"/> + <element name="antennaName" type="string"/> + <element name="antennaPatternLabel" type="string"/> + <element name="antennaType" type="string"/> + <element name="antennaLongitude" type="xrpi:longitudeType"/> + <element name="antennaLatitude" type="xrpi:latitudeType"/> + <element name="antennaAltitude" type="short"/> + <element name="antennaBearing" type="xrpi:bearingType"/> + <element name="antennaMechanicalOffset" type="xrpi:angleType"/> + <element name="theSupportedCells" type="xrpi:idListType"/> + </sequence> + </complexType> + </element> + </complexType> +</element> + +<element name="Cell" abstract="true"> + <complexType> + <element name="attributes" minOccurs="0"> + <complexType> + <sequence> + <element name="cellId" type="string"/> + <element name="theSupportingAntennas" type="xrpi:idListType"/> + </sequence> + </complexType> + </element> + </complexType> +</element> + +<element + name="GSMCell" + substitutionGroup="Cell"> +</element> + +<element + name="UTRANCell" + substitutionGroup="Cell"> +</element> + +<element + name="EUTRANCell" + substitutionGroup="Cell"> +</element> + +<element name="Site"> + +``` + +``` + + <complexType> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="siteId" type="string"/> + <element name="siteAddress" type="string"/> + <element name="siteName" type="string"/> + <element name="siteLongitude" type="xrpi:longitudeType"/> + <element name="siteLatitude" type="xrpi:latitudeType"/> + <element name="siteAltitude" type="short" use="optional"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xrpi:Antenna"/> + <element ref="xrpi:Cell"/> + </choice> + </sequence> + </complexType> + </element> + + <element name="SiteList"> + <complexType> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xrpi:Site"/> + </choice> + </sequence> + </complexType> + </element> + +</schema> + +``` + +### B.3.2 XML Schema "rptaIRPOpR.xsd" + +``` + +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.669 Radio Planning Tool Access (RPTA) IRP + RPTA IRP XML Schema definitions for the operation response + rptaIRPOpR.xsd +--> + +<schema + + <!------------------------------------------------------------------------> + <!-- Name spaces --> + <!------------------------------------------------------------------------> + + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPOpR" + + elementFormDefault="qualified" + + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xrpi="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPIOCs" + xmlns:xrpo="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPOpR"> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/32_series/28.669#rptaIRPIOCs"/> + + <!------------------------------------------------------------------------> + <!-- Type definitions --> + <!------------------------------------------------------------------------> + + <complexType name="plannedDataOutType"> + <sequence> + <element name="header"> + <complexType> + <attribute name="dataFormatVersion" type="string" use="required"/> + <attribute name="senderName" type="string" use="optional"/> + <attribute name="vendorName" type="string" use="optional"/> + </complexType> + </element> + </sequence> + </complexType> + +``` + +``` +</element> +<element name="plannedData" maxOccurs="unbounded"> + <complexType> + <element ref="xrpi:SiteList"/> + </complexType> +</element> +<element name="footer"> + <complexType> + <attribute name="dateTime" type="dateTime" use="required"/> + </complexType> +</element> +</sequence> +</complexType> + +<simpleType name="operationStatusType"> + <restriction base="string"> + <enumeration value="operationSucceeded"/> + <enumeration value="operationFailed"/> + </restriction> +</simpleType> + +</schema> +``` + +# --- Annex C (normative): HTTP Solution Set + +## C.0 Introduction + +This annex specifies the HTTP Solution Set for the IRP whose semantics are specified in 3GPP TS 28.668 [4]. The HTTP Solution Set is specific for this IRP, and not applicable to any other IRP. + +--- + +## C.1 Architectural features + +### C.1.1 General + +The overall architectural feature of RPTA IRP is specified in 3GPP TS 28.668 [4]. This clause specifies features that are specific to the HTTP SS. + +### C.1.2 Supported Specifications + +HTTP 1.1 [5] is supported. + +JSON [6] is supported. + +NOTE: IETF RFC 2616 [5] is superseded by RFC 7230 [11] RFC 7231 [12], RFC 7232 [13], RFC 7233 [14], RFC 7234 [15], and RFC 7235 [16]. These specifications are function wise identical to RFC 2616. + +### C.1.3 Introduction to HTTP-GET + +IETF RFC 2616 [5] specifies the Hypertext Transfer Protocol (HTTP) Version 1.1 (HTTP/1.1). Chapter 1.4 of this document describes the overall operation: + +*“The HTTP protocol is a request/response protocol. A client sends a request to the server in the form of a request method, URI, and protocol version, followed by a MIME-like message containing request modifiers, client information, and possible body content over a connection with a server. The server responds with a status line, including the message's protocol version and a success or error code, followed by a MIME-like message containing server information, entity metainformation, and possible entity-body content.”* + +Chapter 5 of [5] specifies the HTTP request message and chapter 6 the HTTP response message. The definitions are repeated below for convenience: + +``` +Request = Request-Line ; + *(( general-header ; + | request-header ; + | entity-header ) CRLF) ; + CRLF + [ message-body ] ; +``` + +``` +Request-Line = Method SP Request-URI SP HTTP-Version CRLF +``` + +``` +Response = Status-Line ; + *(( general-header ; + | response-header ; + | entity-header ) CRLF) ; + CRLF + [ message-body ] ; +``` + +``` +Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF +``` + +### C.1.4 Usage of HTTP-GET + +The operation `getPlannedData` is mapped to the HTTP method `GET`. The RPT data to be retrieved is identified by the `Request-URI`. The data is returned in the `message-body` of the `Response` message. + +The `message-body` carries a: + +- XML instance document (XML option); + +or a + +- JSON instance document (JSON option). + +The syntax of the message body is described by: + +- the XML Schema definition of `rptaIRPHTTP.xsd` given in Chapter C.3.1 (XML option); +- the JSON syntax provided in Chapter C.3.2 (JSON option). + +### C.1.5 Request-URI + +The `Request-URI` can be configured or can be discovered by means that are outside the scope of the present document. + +### C.1.6 Headers + +The present document does not make any recommendations on the use of headers. + +## C.2 Mapping + +### C.2.0 Introduction + +The RPTA IRP: IS 3GPP TS 28.668 [4] defines semantics of operations and notifications visible across the Type-7 interface. Table C.2.1-1 indicates mapping of these operations and notifications to their equivalents defined in this SS. + +### C.2.1 Operation and Notification mapping + +**Table C.2.1-1: Mapping from IS Operation to SS equivalents** + +| IS Operation<br>(3GPP TS 28.668 [4]) | SS Method | Qualifier | +|--------------------------------------|-----------------|-----------| +| getPlannedData | HTTP method GET | M | + +### C.2.2 Operation parameter mapping + +Reference 3GPP TS 28.668 [4] defines semantics of parameters carried in operations across the Type-7 interface. The following tables indicate the mapping of these parameters to their equivalents defined in this SS. + +**Table C.2.2-1: Mapping from IS getPlannedData parameters to SS equivalents (XML option)** + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------------------------------------|-----------| +| scope | Request-URI in the Request-Line (Request message) | M | +| plannedData | message-body (Response message): plannedDataOut | M | +| status | message-body (Response message): status | M | + +**Table C.2.2-2: Mapping from IS getPlannedData parameters to SS equivalents (JSON option)** + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|---------------------------------------------------|-----------| +| scope | Request-URI in the Request-Line (Request message) | M | +| plannedData | message-body (Response message): siteList | M | +| status | Status-Line (Response message) | M | + +## C.3 Solution Set definitions + +### C.3.1 XML Schema "rptaIRPHTTP.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.669 Radio Planning Tool Access (RPTA) IRP + XML Schema for the HTTP Solution Set + rptaIRPHTTP.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPHTTP" + elementFormDefault="qualified"> + + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xrph="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPHTTP" + xmlns:xrpi="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPIOCs" + xmlns:xrpo="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPOpR" + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPIOCs"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPOpR"/> + + <element name="getPlannedDataResponse"> + <complexType> + <sequence> + <element name="plannedDataOut" type="xrpo:plannedDataOutType"/> + <element name="status" type="xrpo:operationStatusType"/> + </sequence> + </complexType> + </element> + +</schema> +``` + +### C.3.2 JSON definition structure + +There is no schema language available for JSON. An example for a JSON instance document is provided below. This example provides the general structure and syntax of a standard compliant JSON instance. This example shall be extended only with additional site, antenna and cell elements. No other modifications are standard compliant. + +``` +{ + "sitelist": + [ + { "siteId": "123", + "siteAddress": "Xstreet", + "siteName": "bla", + "siteLongitude": "+148.3429", + "siteLatitude": "-37.4507", + "siteAltitude": "257", + + "antenna": + [ + { "antennaId": "12", + "antennaName": "Peter", + "antennaPatternLabel": "abc", + "antennaType": "abc", + "antennaLongitude": "+148.3429", + "antennaLatitude": "-37.4507", + "antennaAltitude": "257", + "antennaBearing": "309", + "antennaMechanicalOffset": "28", + "theSupportedCells": [5, 6] }, + + { "antennaId": "23", + [ ... ] + "theSupportedCells": [7] } + ], + + "cell": + [ +``` + +``` + {"cellId":"5", + "theSupportingAntennas":[12]}, + {"cellId":"6", + "theSupportingAntennas":[12]}, + {"cellId":"7", + "theSupportingAntennas":[23]} + ] +}, +{"siteId": "456", + [...], + "siteAltitude":"278", + + "antenna": + [ + {"antennaId":"45", + [...], + "theSupportedCells":[5,6]} + ], + + "cell": + [ + {"cellId":"5", "theSupportingAntennas":[45]}, + {"cellId":"6", "theSupportingAntennas":[45]} + ] +} +] +} +``` + +# --- Annex D (normative): SOAP Solution Set + +## D.0 Introduction + +This annex specifies the SOAP Solution Set for the IRP whose semantics are specified in 3GPP TS 28.668 [4]. + +## --- D.1 Architectural features + +### D.1.1 General + +The overall architectural feature of RPTA IRP is specified in 3GPP TS 28.668 [4]. This clause specifies features that are specific to the SOAP SS. + +### D.1.2 Supported W3C specifications + +The SOAP 1.1 specification [7] and WSDL 1.1 specification [8] are supported. + +The SOAP 1.2 specification [10] is supported optionally. + +The present document uses "document" style in the WSDL description. + +The present document uses "literal" encoding style in the WSDL description. + +### D.1.3 Filter language + +The filter language used in the SS is the XPath Language (see W3C XPath 1.0 specification [9]). Service Provider may throw a FilterComplexityLimit fault when a given filter is too complex. + +## --- D.2 Mapping + +#### D.2.1 Operation and Notification mapping + +**Table D.2.1-1: Mapping from IS Operation to SS equivalents** + +| <b>IS Operation</b> | <b>SS Operation</b> | <b>Qualifier</b> | +|---------------------|---------------------|------------------| +| getPlannedData | getPlannedData | M | + +### D.2.2 Operation parameter mapping + +#### D.2.2.1 Operation getPlannedData + +##### D.2.2.1.1 Input parameters + +**Table D.2.2.1.1-1: Mapping from IS getPlannedData input parameters to SS equivalents** + +| IS Operation parameter | SS Operation parameter | Qualifier | +|------------------------|------------------------|-----------| +| scope | queryXPathExp | M | + +Here is the XML schema fragment of the getPlannedData request: + +``` +<element name="getPlannedDataRequest"> + <complexType> + <sequence> + <element name="queryXPathExp" type="string"/> + </sequence> + </complexType> +</element> +``` + +NOTE: In Rel-12 only all planned data can be selected. The semantics of all is conveyed by an empty string. + +##### D.2.2.1.2 Output parameters + +**Table D.2.2.1.2-1: Mapping from IS getPlannedData output parameters to SS equivalents** + +| IS Operation parameter | SS Method parameter | Qualifier | +|------------------------|----------------------------|-----------| +| plannedData | RPTAIRPData:plannedDataOut | M | +| status | RPTAIRPData:status | M | + +Here is the XML schema fragment of the getPlannedData response: + +``` +<element name="getPlannedDataResponse"> + <complexType> + <sequence> + <element name="plannedDataOut" type="xrpo:plannedDataOutType"/> + <element name="status" type="xrpo:operationStatusType"/> + </sequence> + </complexType> +</element> +``` + +##### D.2.2.1.3 Fault definition + +``` +<element name="getPlannedDataFault"> + <simpleType> + <restriction base="string"> + <enumeration value="operationFailed"/> + </restriction> + </simpleType> +</element> +``` + +## D.3 Solution Set definitions + +### D.3.1 WSDL definition structure + +Clause D.3.2 provides a graphical representation of the RPTA IRP service. + +Clause D.3.3 defines the services which are supported the RPTA IRP client. + +### D.3.2 Graphical Representation + +A graphical representation is not provided in the current version of the present document. + +### D.3.3 WSDL specification "RPTAIRPSystem.wsdl" + +``` +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.669 Radio Planning Tool Access (RPTA) IRP + wsdl definition of the RPTA IRP + rptAIRPSystem.wsdl +--> + +<definitions + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#RPTAIRPSystem"> + + xmlns="http://schemas.xmlsoap.org/wsdl/" + xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" + + xmlns:RPTAIRPSystem="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#RPTAIRPSystem" + xmlns:RPTAIRPData="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#RPTAIRPData" + + <!--> + <!-- Type and element definitions --> + <!--> + + <types> + <schema + + <!--> + <!-- Name spaces --> + <!--> + + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#RPTAIRPData" + + xmlns="http://www.w3.org/2001/XMLSchema"> + xmlns:xrpi="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPIOCs" + xmlns:xrpo="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPOpR" + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPIOCs"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#rptaIRPOpR"/> + + <!--> + <!-- Element definitions --> + <!--> + + <element name="getPlannedDataRequest"> + <complexType> + <sequence> + <element name="queryXpathExp" type="string"/> + </sequence> + </complexType> + </element> + + <element name="getPlannedDataResponse"> + <complexType> + <sequence> + <element name="plannedDataOut" type="xrpo:plannedDataOutType"/> + <element name="status" type="xrpo:operationStatusType"/> + </sequence> + </complexType> + </element> + + <element name="getPlannedDataFault"> + <simpleType> + <restriction base="string"> + <enumeration value="operationFailed"/> + </restriction> + </simpleType> + </element> + + </schema> + </types> + + <!--> + <!-- Operation data elements definition --> + <!--> +``` + +``` +<message name="getPlannedDataRequest"> + <part name="parameter" element="RPTAIRPData:getPlannedDataRequest"/> +</message> + +<message name="getPlannedDataResponse"> + <part name="parameter" element="RPTAIRPData:getPlannedDataResponse"/> +</message> + +<message name="getPlannedDataFault"> + <part name="parameter" element="RPTAIRPData:getPlannedDataFault"/> +</message> + +<!-- Operations definition --> +<!--> + +<portType name="RptaOperations1PortType"> + + <operation name="getPlannedData"> + <input message="RPTAIRPSystem:getPlannedDataRequest"/> + <output message="RPTAIRPSystem:getPlannedDataResponse"/> + <fault name="getPlannedDataFault" message="RPTAIRPSystem:getPlannedDataFault"/> + </operation> + +</portType> + +<!-- Message format and protocol details --> +<!--> + +<binding name="RptaOperations1Binding" type="RPTAIRPSystem:RptaOperations1PortType"> + + <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> + + <operation name="getPlannedData"> + <soap:operation + soapAction="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#getPlannedData"/> + <input> + <soap:body use="literal"/> + </input> + <output> + <soap:body use="literal"/> + </output> + <fault name="getPlannedDataFault"> + <soap:fault name="getPlannedDataFault" use="literal"/> + </fault> + </operation> + +</binding> + +<!-- Web Service definition --> +<!--> + +<service name="RPTAIRPService"> + <port name="RptaOperationalPort" binding="RPTAIRPSystem:RptOperation1Binding"> + <soap:address location="http://www.3gpp.org/ftp/specs/archive/28_series/28.669#RPTAIRP"/> + </port> +</service> + +</definitions> +``` + +# Annex E (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|----------|-----|-----|------------------------------------------------------------------|--|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| | | | | | | Version after approval | | 12.0.0 | +| 2016-01 | SA#70 | | | | | Upgrade to Rel-13 (MCC) | | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 001<br>1 | - | F | Update the link from IRP Solution Set to IRP Information Service | | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 001<br>2 | - | F | Update link from IRP SS to IS | | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28671/raw.md b/marked/Rel-16/28_series/28671/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..603cf1280ffd1f255dc3795e5e026ee165c0f549 --- /dev/null +++ b/marked/Rel-16/28_series/28671/raw.md @@ -0,0 +1,152 @@ + + + + + + +# --- Contents + +- Foreword ..... 5 +- Introduction ..... 5 +- 1 Scope..... 6 +- 2 References..... 6 +- 3 Definitions, symbols and abbreviations ..... 6 +- 3.1 Definitions ..... 6 +- 3.2 Abbreviations ..... 7 +- 4 Concepts and background ..... 8 +- 5 Requirements ..... 8 +- Annex A (informative): Change history..... 9 + +# --- Foreword + +This Technical Report has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- 28.671: Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements** +- 28.672: Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS) +- 28.673: Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network ResourceModel (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The document describes the requirements for Home NodeB Subsystem (HNS), which includes Home NodeB (HNB) and Home NodeB gateway (HNB GW). The HNS NRM IRP requirements are targeted on both HNB and HNB GW NRM. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 25.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [6] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [7] 3GPP TS 25.467: "UTRAN architecture for 3G Home NodeB; Stage 2". +- [8] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [9] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +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]. + +**Integration Reference Point (IRP):** See 3GPP TS 32.150 [5]. + +**Information Service (IS):** See 3GPP TS 32.150 [5]. + +**Solution Set (SS):** See 3GPP TS 32.150 [5]. + +**IRP Solution Set:** See 3GPP TS 32.101 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|--------------------------------------| +| CN | Core Network | +| GW | Gateway | +| HNB | Home Node B | +| HNS | Home Node B Subsystem | +| IRP | Integration Reference Point | +| IOC | Information Object Class | +| NRM | Network Resource Model | +| SCTP | Stream Control Transmission Protocol | + +# --- 4 Concepts and background + +HNB Subsystem is defined in TS 23.060 [6]. According to the definition, a HNB subsystem consists of a HNB and a HNB GW. The HNB Subsystem appears as an RNS to the core network and is connected by means of the Iu-CS interface to the MSC and by means of the Iu-PS interface to the SGSN. + +Detailed functions of HNB and HNB GW are described in TS 25.467 [7]. To be more specific, HNB is a Customer Premise Equipment that offers the Uu Interface to the UE. It provides RAN connectivity and supports RNC like functions as well as UE registration over Iuh. HNB Gateway (HNB-GW) terminates Iuh from HNB and appears as an RNC to the existing Core network using existing Iu interface. It supports HNB registration and UE registration over Iuh. + +Based on the above characteristics, this specification defines respective HNS NRM IRP requirements. + +# --- 5 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [2]. +- b) IRP-related requirements in 3GPP TS 32.102 [3]. +- c) IRP-related requirements in 3GPP TS 32.600 [4]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [8] and its information is derived from FNIM Umbrella Information Model (UIM) [9] + +In addition to the above, the following more specific requirements apply: + +**REQ-HNS\_GW-CON-001** The Network Resource Model defined by this IRP shall contain HNB GW specific IOCs and related definitions. + +**REQ-HNS\_GW-CON-002** The Network Resource Model defined by this IRP shall provide support for enabling consistency between HNB GW, HNB and related core network nodes. + +**REQ-HNS\_GW-CON-003** The NRM specified by this IRP shall be able to view configuration information of the HNB GW entity. More detailed information is as follows: + +Shall allow for the viewing of basic configuration information including version, equipment type, equipment provider and unique identification, etc. + +Shall allow for the viewing of network configuration information including IP address, sub-network mask, default gateway and port configuration information, etc. + +Shall allow for the viewing of service related configuration information, for example the maximum number of HNB to be registered, the maximum number of packets to be forwarded, etc. + +**REQ-HNS\_GW-CON-004** The NRM specified by this IRP shall capture Iuh interface information of HNB GW. More detailed information is as follows: + +Shall allow for the viewing of basic configuration information including Iuh identification etc. + +Shall allow for the viewing of network configuration information including SCTP management information, etc. + +**REQ-HNS\_GW-CON-005** The NRM specified by this IRP shall capture the identity of registered HNB. + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140360 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28672/raw.md b/marked/Rel-16/28_series/28672/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b36bdd7022f45c5d605e69e7d4c32a8ef55d35a6 --- /dev/null +++ b/marked/Rel-16/28_series/28672/raw.md @@ -0,0 +1,472 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 7 | +| 4.1 Information entities imported and local labels..... | 7 | +| 4.2 Class diagram..... | 8 | +| 4.2.1 Relationships ..... | 8 | +| 4.2.2 Inheritance ..... | 9 | +| 4.3 Class definitions ..... | 10 | +| 4.3.1 HNBGWFunction..... | 10 | +| 4.3.1.1 Definition ..... | 10 | +| 4.3.1.2 Attributes ..... | 10 | +| 4.3.1.3 Notifications..... | 10 | +| 4.3.2 IuhSignLinkTp ..... | 10 | +| 4.3.2.1 Definition ..... | 10 | +| 4.3.2.2 Attributes ..... | 10 | +| 4.3.2.3 Notifications..... | 10 | +| 4.3.3 EP_Iuh ..... | 10 | +| 4.3.3.1 Definition ..... | 10 | +| 4.3.3.2 Attributes ..... | 11 | +| 4.3.3.3 Attribute constraints..... | 11 | +| 4.3.3.4 Notifications..... | 11 | +| 4.3.4 HMSFunction ..... | 11 | +| 4.3.4.1 Definition ..... | 11 | +| 4.3.4.2 Attributes ..... | 11 | +| 4.3.4.3 Notifications..... | 11 | +| 4.3.5 HNB..... | 11 | +| 4.3.5.1 Definition ..... | 11 | +| 4.3.5.2 Attributes ..... | 11 | +| 4.3.5.3 Notifications..... | 12 | +| 4.3.6 HNBProfile ..... | 12 | +| 4.3.6.1 Definition ..... | 12 | +| 4.3.6.2 Attributes ..... | 12 | +| 4.3.7 LocalGWFunction ..... | 12 | +| 4.3.7.1 Definition ..... | 12 | +| 4.3.7.2 Attributes ..... | 12 | +| 4.3.7.3 Notifications..... | 13 | +| 4.4 Attribute definitions ..... | 14 | +| 4.4.1 Attribute Properties ..... | 14 | +| 4.4.2 Constraints..... | 16 | +| 4.5.1 Alarm notifications..... | 16 | +| 4.5.2 Configuration notifications..... | 16 | +| Annex A (informative): Change history..... | 16 | + +# --- Foreword + +This Technical Report has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- 28.671: Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements. +- 28.672: Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS).** +- 28.673: Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document specifies the Home Node B Subsystem (HNS) Network Resource Model (NRM) IRP (that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks). + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +In order to access the information defined by this NRM, an IRP IS is needed, such as the Basic CM IRP IS (3GPP TS 32.602 [7]) or the Bulk CM IRP IS (3GPP TS 32.612 [8]). However, which IS that is applicable is outside the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 25.467: "Technical Specification Group Radio Access Network (UTRAN); UTRAN Architecture for 3G HNB". +- [5] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRMs) Integration Reference Point (IRP): Information Service (IS)". +- [7] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP): Information Service (IS)". +- [8] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [9] TR-196, "Femto Access Point Device Data Model", Broadband Forum, 2009, <http://broadband-forum.org/technical/download/TR-196.pdf>. +- [10] 3GPP TS 28.702: "Telecommunication management; Core Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [11] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [12] 3GPP TS 23.002: "Network Architecture". +- [13] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [14] IETF RFC 4293: "SNMPv2 Management Information Base for the Internet Protocol using SMIv2". + +- [15] IETF RFC3873: "Stream Control Transmission Protocol (SCTP) Management Information Base (MIB)". +- [16] 3GPP TS 32.583: "Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Procedure flows for Type 1 Interface HNB to HNB Management System (HMS)" +- [17] 3GPP TS 23.002: "Technical Specification Group Services and Systems Aspects; Network architecture" +- [18] 3GPP TS 22.220: "Service requirements for Home Node B (HNB) and Home eNode B (HeNB)" +- [19] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [20] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description;Stage 2". +- [21] 3GPP TS 23.401 "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [22] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following definitions and abbreviations apply. For definitions and abbreviations not found here, please refer to 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TS 32.600 [5]. + +**Association:** See definition in TS 28.622 [6]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +**Home Node B Management System (HMS):** See TS 32.583 [16]. + +**HNB GW:** See TS 25.467 [4]. + +**Home Node B Subsystem (HNS):** See TS 23.002 [17]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| DN | Distinguished Name | +| GW | Gateway | +| HNB | Home Node B | +| HNS | Home Node B Subsystem | +| IOCs | Information Object Classes | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | +| UTRAN | Universal Terrestrial Radio Access Network | + +# --- 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|------------------------------------------|-----------------| +| 3GPP TS 28.622 [6], IOC, ManagedElement | ManagedElement | +| 3GPP TS 28.622 [6], IOC, ManagedFunction | ManagedFunction | +| 3GPP TS 28.622 [6], IOC, ManagementNode | ManagementNode | +| 3GPP TS 28.622 [6], IOC, Subnetwork | Subnetwork | +| 3GPP TS 28.622 [6], IOC, Top | Top | +| 3GPP TS 28.622 [6], IOC, VsDataContainer | VsDataContainer | +| 3GPP TS 28.702 [10], IOC, IupsLink | IupsLink | +| 3GPP TS 28.702 [10], IOC, IucsLink | IucsLink | +| 3GPP TS 28.702 [10], IOC, IubcLink | IubcLink | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides an overview of the relationships between relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +![UML Class diagram showing relationships between various classes including ProxyClass, SupportIOC, InformationObjectClass, and ManagementNode. A note indicates that ProxyClass Any represents any managed entity with a DN (e.g. HMSFunction).](5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg) + +The diagram illustrates the following classes and their relationships: + +- «ProxyClass» Any**: A proxy class representing any managed entity with a DN (e.g. HMSFunction). It has a 1..\* relationship with **«SupportIOC» LocalGWFunction** (role: «names»). +- «SupportIOC» LocalGWFunction**: Has a 0..1 relationship with **«SupportIOC» HNB** (role: + servedNode). +- «InformationObjectClass» ManagementNode (from 28.622)**: Has a 1..\* relationship with **«InformationObjectClass» HMSFunction** (role: «names»). +- «InformationObjectClass» HMSFunction**: Has a 1..\* relationship with **«InformationObjectClass» HNBProfile** (role: «names»). +- «InformationObjectClass» ManagedElement (from 28.622)**: Has a 1..\* relationship with **«InformationObjectClass» HNBGWFunction** (role: «names»). +- «InformationObjectClass» HNBGWFunction**: Has a 1..\* relationship with **«InformationObjectClass» EP\_luh** (role: «names»). +- «InformationObjectClass» EP\_luh**: Has a 1..\* relationship with **«InformationObjectClass» IuhSignLinkTp** (role: «names»). +- «InformationObjectClass» IucsLink (from 32.632)**: Has a 0..1 relationship with **«InformationObjectClass» HNBGWFunction** (role: + connectedHNBGW). +- «InformationObjectClass» IubLink (from 32.632)**: Has a 0..1 relationship with **«InformationObjectClass» HNBGWFunction** (role: + connectedHNBGW). +- «InformationObjectClass» IupsLink (from 32.632)**: Has a 0..1 relationship with **«InformationObjectClass» HNBGWFunction** (role: + connectedHNBGW). + +UML Class diagram showing relationships between various classes including ProxyClass, SupportIOC, InformationObjectClass, and ManagementNode. A note indicates that ProxyClass Any represents any managed entity with a DN (e.g. HMSFunction). + +NOTE 1: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +Figure 4.2.1-1 Containment/Naming + +![UML Class diagram showing containment/naming relationships between InformationObjectClass and VsDataContainer for various classes like HNBGWFunction, EP_luh, IuhSignLinkTp, and HMSFunction.](731f533b0599c8e42a063f06e4332045_img.jpg) + +The diagram illustrates the following containment/naming relationships: + +- «InformationObjectClass» HNBGWFunction**: Has a 1..\* relationship with **«InformationObjectClass» VsDataContainer (from 28.622)** (role: «names»). +- «InformationObjectClass» EP\_luh**: Has a 1..\* relationship with **«InformationObjectClass» VsDataContainer (from 28.622)** (role: «names»). +- «InformationObjectClass» IuhSignLinkTp**: Has a 1..\* relationship with **«InformationObjectClass» VsDataContainer (from 28.622)** (role: «names»). +- «InformationObjectClass» HMSFunction**: Has a 1..\* relationship with **«InformationObjectClass» VsDataContainer (from 28.622)** (role: «names»). + +UML Class diagram showing containment/naming relationships between InformationObjectClass and VsDataContainer for various classes like HNBGWFunction, EP\_luh, IuhSignLinkTp, and HMSFunction. + +NOTE 1: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +NOTE 2: Each instance of the VsDataContainer shall only be contained under one IOC. The VsDataContainer can be contained under IOCs defined in other NRM. + +**Figure 4.2.1-2: VsDataContainer Containment/Naming** + +The VsDataContainer is only used for the Bulk CM IRP. + +Each IOC instance is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [11] that expresses its containment + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between classes. + +![UML Class Diagram showing inheritance hierarchy for InformationObjectClass. The diagram shows three base classes at the top: EP_RP (from 28.622), ManagedFunction (from 28.622), and ManagedFunction (from 28.622). Below EP_RP are two subclasses: EP_luh and IuhSignLinkTp. Below the first ManagedFunction is HNBProfile. Below the second ManagedFunction are HNBGWFunction and HM5Function. All classes are represented by blue boxes with a small icon in the top-left corner.](b28af4985cdef1e519e3aaf26561dcb3_img.jpg) + +``` + +classDiagram + class EP_RP["«InformationObjectClass» +EP_RP +(from 28.622)"] + class ManagedFunction_1["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + class ManagedFunction_2["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + class EP_luh["«InformationObjectClass» +EP_luh"] + class IuhSignLinkTp["«InformationObjectClass» +IuhSignLinkTp"] + class HNBProfile["«InformationObjectClass» +HNBProfile"] + class HNBGWFunction["«InformationObjectClass» +HNBGWFunction"] + class HM5Function["«InformationObjectClass» +HM5Function"] + + EP_luh --|> EP_RP + IuhSignLinkTp --|> EP_RP + HNBProfile --|> ManagedFunction_1 + HNBGWFunction --|> ManagedFunction_2 + HM5Function --|> ManagedFunction_2 + +``` + +UML Class Diagram showing inheritance hierarchy for InformationObjectClass. The diagram shows three base classes at the top: EP\_RP (from 28.622), ManagedFunction (from 28.622), and ManagedFunction (from 28.622). Below EP\_RP are two subclasses: EP\_luh and IuhSignLinkTp. Below the first ManagedFunction is HNBProfile. Below the second ManagedFunction are HNBGWFunction and HM5Function. All classes are represented by blue boxes with a small icon in the top-left corner. + +**Figure 4.2.2-1 Inheritance Hierarchy** + +NOTE: IuhSignLinkTp is a special definition for the signalling of the EP-Iuh, and these two IOC inherit from EP-RP. + +## 4.3 Class definitions + +### 4.3.1 HNBGWFunction + +#### 4.3.1.1 Definition + +This IOC represents HNB GW functionality. For more information about the HNB GW, see 3GPP TS 25.467[4]. + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|------------|-------------|--------------| +| hnbGwId | M | M | - | - | M | +| iPConfigInfo | M | M | - | - | M | +| maxNbrHNBRegistered | M | M | - | - | M | +| maxPacketCapacity | M | M | - | - | M | + +#### 4.3.1.3 Notifications + +The common notifications defined in clause 4.5 are valid for this class, without exceptions or additions. + +### 4.3.2 luhSignLinkTp + +#### 4.3.2.1 Definition + +This IOC represents a signaling link on the luh interface and inherits from EP-RP. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | is writable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|-------------|-------------|--------------| +| sctpAssocLocalAddr | M | M | - | - | M | +| sctpAssocRemoteAddr | M | M | - | - | M | + +#### 4.3.2.3 Notifications + +The common notifications defined in clause 4.5 are valid for this class, without exceptions or additions. + +### 4.3.3 EP\_luh + +#### 4.3.3.1 Definition + +This IOC represents an end point of the luh interface. It inherits from EP-RP. For more information luh interface, see 3GPP TS 25.467[4]. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| farEndNEIPAddr | O | M | CM | - | M | + +#### 4.3.3.3 Attribute constraints + +| Name | Definition | +|------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| Condition for farEndNEIPAddr's write qualifier | The EP_luh object belongs to the different Domain Manager as the NE pointed by the farEndNelpAddr attribute. | + +#### 4.3.3.4 Notifications + +The common notifications defined in clause 4.5 are valid for this class, without exceptions or additions. + +### 4.3.4 HMSFunction + +#### 4.3.4.1 Definition + +This IOC represents HMS functionality. For more information about HMS, see 3GPP TS 32.583 [16]. + +#### 4.3.4.2 Attributes + +None. + +#### 4.3.4.3 Notifications + +There are no Notifications defined. + +### 4.3.5 HNB + +#### 4.3.5.1 Definition + +This class represents HNB functionality. For more information about the HNB, see 3GPP TS 25.467 [4]. For definition of HNB, see 3GPP TS 22.220 [18]. + +The Home NodeB, represented by the <<SupportIOC>> HNB, has registered itself with one node represented by HMSFunction. + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------|-------------------|------------|------------|-------------|--------------| +| id | M | -- | - | - | - | + +#### 4.3.5.3 Notifications + +The common notifications defined in clause 4.5 are not valid for this class. The set of notifications defined in the following table is valid. + +| Name | Qualifier | Notes | +|---------------------------|---------------------------------------|-------| +| notifyAckStateChange<br>d | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | + +### 4.3.6 HNBProfile + +#### 4.3.6.1 Definition + +The HNBProfile is a representation of information that a) identifies a specific set of HNB devices and b) the related configuration parameters (and their values) that are required to be configured in those identified HNB devices during HNB registration procedure. + +It contains userLabel, an attribute inherited from ManagedFunction. This is a user friendly label assigned by operator. Examples can be “VIP configuration”, “Gold Tier configuration”, “device vendor XYZ software version 3.4”, “camel”, etc + +#### 4.3.6.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------|-------------------|------------|------------|-------------|--------------| +| configuration | M | M | - | - | M | +| criterion | O | M | - | - | M | + +### 4.3.7 LocalGWFunction + +#### 4.3.7.1 Definition + +This class represents local Gateway functionality. For more information about the local gateway, see 3GPP TS 23.060 [20] and 3GPP TS 23.401[21]. + +The Local Gateway, represented by the <<SupportIOC>> LocalGWFunction, has registered itself with one node represented by HMSFunction. + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------|-------------------|------------|------------|-------------|--------------| +| iPAddr | M | - | - | - | - | +| collocationFlag | M | - | - | - | - | +| servedNode | M | - | - | - | - | + +#### 4.3.7.3 Notifications + +The common notifications defined in clause 4.5 are not valid for this class. The set of notifications defined in the following table is valid. + +| Name | Qualifier | Notes | +|---------------------------|---------------------------------------|-------| +| notifyAckStateChange<br>d | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | + +## 4.4 Attribute definitions + +### 4.4.1 Attribute Properties + +The following table defines the attributes that are present in several Information Object Classes (IOCs) of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | <p>An attribute whose 'name+value' can be used as an RDN when naming an instance of the IOC.</p> <p>This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance.</p> <p>allowedValues: format of allowed values to be conformant with TS 32.300[11]</p> | <p>type: String</p> <p>multiplicity: 1</p> <p>isOrdered: False</p> <p>isUnique: True</p> <p>defaultValue: None</p> <p>isNullable: False</p> | +| hnbGwId | <p>Unique HNB GW ID. Ref. 3GPP TS 25.467 [4] specifies that HNB GW acts as a RNC to the existing core network using existing Iu interface.</p> <p>See "RNC-ID" in Ref. 3GPP TS 23.002 [12] and 3GPP TS 25.413 [13]</p> <p>allowedValues: see [9]</p> | <p>type: see [9]</p> <p>multiplicity: see [9]</p> <p>isOrdered: see [9]</p> <p>isUnique: see [9]</p> <p>defaultValue: see [9]</p> <p>isNullable: see [9]</p> | +| IPConfigInfo | <p>The IP address, subnetwork mask, default gateway for HNB GW (Ref. IETF RFC 4293 [14]).</p> <p>allowedValues: see [9]</p> | <p>type: see [9]</p> <p>multiplicity: see [9]</p> <p>isOrdered: see [9]</p> <p>isUnique: see [9]</p> <p>defaultValue: see [9]</p> <p>isNullable: see [9]</p> | +| maxNbrHNBRegistered | <p>Maximum number of registered HNB means maximum number of HNB allowed to be registered.</p> <p>allowedValues: see [9]</p> | <p>type: see [9]</p> <p>multiplicity: see [9]</p> <p>isOrdered: see [9]</p> <p>isUnique: see [9]</p> <p>defaultValue: see [9]</p> <p>isNullable: see [9]</p> | +| maxPacketCapability | <p>The HNB GW's ability of forwarding packets, such as maximum number of forwarded packets per second.</p> <p>allowedValues: see [9]</p> | <p>type: see [9]</p> <p>multiplicity: see [9]</p> <p>isOrdered: see [9]</p> <p>isUnique: see [9]</p> <p>defaultValue: see [9]</p> <p>isNullable: see [9]</p> | +| sCTPAssocLocalAddr | <p>The local port and IP address of SCTP association (See RFC3873 [15]).</p> <p>allowedValues: see [9]</p> | <p>type: see [9]</p> <p>multiplicity: see [9]</p> <p>isOrdered: see [9]</p> <p>isUnique: see [9]</p> <p>defaultValue: see [9]</p> <p>isNullable: see [9]</p> | +| sCTPAssocRemoteAddr | <p>The remote port and IP address of SCTP association (See RFC3873 [15]).</p> <p>allowedValues: see [9]</p> | <p>type: see [9]</p> <p>multiplicity: see [9]</p> <p>isOrdered: see [9]</p> <p>isUnique: see [9]</p> <p>defaultValue: see [9]</p> <p>isNullable: see [9]</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| <code>farEndEntity</code> | <p>The value of this attribute shall be the Distinguished Name of the far end network entity to which the reference point is related. As an example, with <code>EP_Iucs</code>, if the instance of <code>EP_Iucs</code> is contained by one <code>RncFunction</code> instance, the <code>farEndEntity</code> is the Distinguished Name of the <code>MscServerFunction</code> instance to which this <code>lucs</code> reference point is related.</p> <p>allowedValues: see [9]</p> | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | +| <code>farEndNeIpAddr</code> | <p>The IP address(s) of the far end network entity to which the reference point is related. This is an IPv4 or an IPv6 address.</p> <p>allowedValues: see [9]</p> | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | +| <code>configuration</code> | <p>It is a location of a data set. The data set is a set of HNB attributes (with values) needed to be loaded into the HNB.</p> <p>The data set does not contain all configuration data needed for a device to operate. Some configuration parameters are autonomously and dynamically calculated by the serving HMS.</p> <p>allowedValues: see [9]</p> | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | +| <code>criterion</code> | <p>It is a criterion that determines if a HNB should or should not be loaded with a particular <code>configuration</code>.</p> <p>The syntax and semantics of <code>criterion</code> is vendor-specific.</p> <p>Example 1:</p> <p>The syntax and semantics can be “If the HNB ID range is between ABC and DEF then APPLY the related <code>configuration</code>”.</p> <p>Example 2:</p> <p>The syntax is a list of strings where each string is an “attribute == value” pair. An attribute represents a TR-196 parameter. Its value is the corresponding attribute value.</p> <p>The semantics is “if all pairs found in <code>criterion</code> are also found in the home devices, then the determination is positive in that the home device should be loaded with information of the data set identified by <code>configuration</code>; else not”.</p> <p>allowedValues: see [9]</p> | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| iPAddr | The IP address(s) assigned for the Local Gateway.<br><br>allowedValues: see [9] | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | +| collocationFlag | This attribute indicates whether the local gateway is collocated with the HNB or HeNB that it serves (see ServedNode relation in 6.2.1 UML class diagram) or not.<br><br>allowedValues: see [9] | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | +| servedNode | This attribute contains the DN of a HNB or HeNB that is being served (see ServedNode relation in 6.2.1 UML class diagram).<br><br>allowedValues: see [9] | type: see [9]<br>multiplicity: see [9]<br>isOrdered: see [9]<br>isUnique: see [9]<br>defaultValue: see [9]<br>isNullable: see [9] | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This subclause presents a list of notifications, defined in [19], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [22], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|---------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyAttributeValueChange | O | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [19]) | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [19]) | | + +### 4.5.2 Configuration notifications + +None. + +# --- Annex A (informative): Change history + +| <b>Change history</b> | | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|--------------------------------------------------|------------|------------|---------------| +| <b>Date</b> | <b>TSG #</b> | <b>TSG Doc.</b> | <b>CR</b> | <b>Rev</b> | <b>Subject/Comment</b> | <b>Cat</b> | <b>Old</b> | <b>New</b> | +| 2014-06 | SA#64 | SP-140360 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2014-12 | SA#66 | SP-140797 | 003 | - | Remove Editor's note | A | 12.0.0 | <b>12.1.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.1.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28673/raw.md b/marked/Rel-16/28_series/28673/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..829aa97ac8d4adecf222bd6a6b59ca05630b4ec4 --- /dev/null +++ b/marked/Rel-16/28_series/28673/raw.md @@ -0,0 +1,573 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set Definitions ..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.2 Rules for NRM extensions ..... | 8 | +| A.2 Mapping ..... | 9 | +| A.2.1 General mappings..... | 9 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC HNBGWFunction..... | 9 | +| A.2.2.2 IOC HNBProfile ..... | 9 | +| A.2.2.3 IOC HMSFunction ..... | 9 | +| A.2.2.4 IOC IuhSignLinkTp..... | 9 | +| A.2.2.5 IOC EP_Iuh ..... | 9 | +| A.3 Solution Set definitions ..... | 10 | +| A.3.1 IDL definition structure..... | 10 | +| A.3.2 IDL specification “HnsNetworkResourcesNRMDefs.idl” ..... | 11 | +| <b>Annex B (normative): XML Definitions.....</b> | <b>13</b> | +| B.0 General..... | 13 | +| B.1 Architectural features..... | 13 | +| B.1.0 General ..... | 13 | +| B.1.1 Syntax for Distinguished Names..... | 13 | +| B.2 Mapping ..... | 13 | +| B.2.1 General mapping ..... | 13 | +| B.2.2 Information Object Class (IOC) mapping..... | 13 | +| B.3 Solution Set definitions ..... | 14 | +| B.3.1 XML definition structure ..... | 14 | +| B.3.2 Graphical Representation ..... | 14 | +| B.3.3 XML schema "hnsNrm.xsd" ..... | 15 | +| Annex C (informative): Change history..... | 18 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; Configuration Management (CM); as identified below: + +- 28.671: Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.672: Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.673: Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named HNS Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning HNS resources. The HNS NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the HNS NRM IRP. + +This specification is related to 3GPP TS 28.672 V14.0.X [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 28.672: "Telecommunication management; Home Node B (HNB) Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- [6] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [7] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [8] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [9] Void +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [12] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [13] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects" +- [14] 3GPP TS 28.623: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +For terms and definitions please refer to 3GPP TS 32.101 [2], 32.102 [3], 32.600 [4] and 32.772 [5]. + +**XML file:** See definition of [14]. + +**XML document:** See definition of [14]. + +**XML declaration:** See definition of [14]. + +**XML element:** See definition of [14]. + +**empty XML element:** See definition of [14]. + +**XML content (of an XML element):** See definition of [14]. + +**XML start-tag:** See definition of [14]. + +**XML end-tag:** See definition of [14]. + +**XML empty-element tag:** See definition of [14]. + +**XML attribute specification:** See definition of [14]. + +**DTD:** See definition of [14]. + +**XML schema:** See definition of [14]. + +**XML namespace:** See definition of [14]. + +**XML complex type:** See definition of [14]. + +**XML element type:** See definition of [14]. + +## 3.2 Abbreviations + +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]. + +| | | +|--------|-------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| HNB | Home Node B | +| HNS | Home Node B Subsystem | +| HNB-GW | Home Node B Gateway | +| IDL | Interface Definition Language | +| IRP | Integration Reference Point | +| IS | Information Service | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP HNS NRM IRP Solution Set Definitions: + +- 3GPP HNS NRM IRP CORBA SS (Annex A) +- 3GPP HNS NRM IRP XML Definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in HNS NRM IRP: Information Service (TS 32.772 [5]). + +--- + +### A.1 Architectural features + +The overall architectural feature of HNS Network Resources IRP is specified in 3GPP TS 28.672 [5]. + +This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [14] + +#### A.1.2 Rules for NRM extensions + +See clause A.1.1 of [14]. + +### A.2 Mapping + +#### A.2.1 General mappings + +See clause A.2.1 of [14]. + +#### A.2.2 Information Object Class (IOC) mapping + +This SS supports reference attributes for relations other than containment relations between objects. Reference attributes are therefore introduced in each MOC where needed. + +##### A.2.2.1 IOC HNBGWFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------------|---------------------|---------| +| id | hnbgwFunctionId | string | +| hnbgwId | hnbgwId | string | +| userLabel | userLabel | string | +| ipConfigInfo | ipConfigInfo | string | +| maxNbrHNBRegistered | maxNbrHNBRegistered | Integer | +| maxPacketCapability | maxPacketCapability | integer | + +##### A.2.2.2 IOC HNBProfile + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| Id | hnbProfileId | string | +| userLabel | userLabel | string | +| Configuration | configuration | string | +| Criterion | criterion | string | + +##### A.2.2.3 IOC HMSFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| userLabel | userLabel | string | + +##### A.2.2.4 IOC IuhSignLinkTp + +| IS Attributes | SS Attributes | SS Type | +|---------------------|---------------------|---------| +| Id | iuhsignLinkTpId | string | +| userLabel | userLabel | string | +| farEndEntity | farEndEntity | string | +| sctpAssocLocalAddr | sctpAssocLocalAddr | string | +| sctpAssocRemoteAddr | sctpAssocRemoteAddr | string | + +##### A.2.2.5 IOC EP\_luh + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|---------| +| Id | epluhId | string | +| userLabel | userLabel | string | +| farEndEntity | farEndEntity | string | +| farEndNEIPAddr | farEndNEIPAddr | string | + +## --- A.3 Solution Set definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the HNS NRM IRP. + +#### A.3.2 IDL specification “HnsNetworkResourcesNRMDefs.idl” + +``` +//File: HnsNetworkResourcesNRMDefs.idl +#ifndef _HNSNETWORKRESOURCESNRMDefs_IDL_ +#define _HNSNETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module HnsNetworkResourcesNRMDefs +{ + + /** + * Definitions for MO class HnbgwFunction + */ + interface HNBGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "HNBGWFunction"; + // Attribute Names + // + const string hnbgwFunctionId = "hnbgwFunctionId"; + const string hnbgwId = "hnbgwId"; + const string ipConfigInfo = "ipConfigInfo"; + const string maxNbrHNBRegistered = "maxNbrHNBRegistered"; + const string maxPacketCapability = "maxPacketCapability"; + }; + + /** + * Definitions for MO class IuhSignLinkTp + */ + interface IuhSignLinkTp : GenericNetworkResourcesNRMDefs::EP_RP + { + const string CLASS = "IuhSignLinkTp"; + // Attribute Names + // + const string sctpAssocLocalAddr = "sctpAssocLocalAddr"; + const string sctpAssocRemoteAddr = "sctpAssocRemoteAddr"; + }; + + /** + * Definitions for MO class EP_Iuh + */ + interface EP_Iuh : GenericNetworkResourcesNRMDefs::EP_RP + { + const string CLASS= "EP_Iuh"; + // Attribute Names + // + const string farEndNEIPAddr= "farEndNEIPAddr"; + }; + + /** + * Definitions for MO class HNBProfile + */ + interface HNBProfile : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS= "HNBProfile"; + // Attribute Names + // + const string hnbProfileId = "hnbProfileId"; + const string configuration = "configuration"; + const string criterion = "criterion"; + }; + + /** + * Definitions for MO class HMSFunction + */ + interface HMSFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS= "HMSFunction"; + // Attribute Names + // + }; +} +``` + +``` + }; +}; + +#endif // _HNSETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML Definitions + +## B.0 General + +This annex contains the XML Definitions for the HNS NRM IRP as it applies to Itf-N, in accordance with HNS NRM IRP Information Service (TS 28.672 [5]). + +The XML file formats are based on XML [8], XML Schema [10] [11] and XML Namespace [12] standards. + +## --- B.1 Architectural features + +### B.1.0 General + +The overall architectural feature of HNS Network Resources IRP is specified in 3GPP TS 28.672 [5]. This clause specifies features that are specific to the Schema definitions. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [13]. + +## --- B.2 Mapping + +### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +#### B.3.1 XML definition structure + +Annex B.3.3 of the present document defines the NRM-specific XML schema `hnsNrm.xsd` for the HNS Network Resources IRP NRM defined in 3GPP TS 28.672 [5]. + +XML schema `hnsNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [6]. + +#### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +#### B.3.3 XML schema "hnsNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.673 HNS Network Resources IRP + Bulk CM Configuration data file NRM-specific XML schema + hnsNrm.xsd +--> + +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.676#hnsNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:un= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.673#hnsNrm" + xmlns:gn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + xmlns:sm= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" +> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + schemaLocation="genericNrm.xsd"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + schemaLocation="geranNrm.xsd"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + schemaLocation="stateManagementIRP.xsd"/> + + <!-- HNS Network Resources IRP NRM attribute related XML types --> + + <!-- HNS network Resources IRP NRM class associated XML elements --> + + <element + name="HNBGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="hnbgwId" type="string"/> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="iPConfigInfo" type="string"/> + <element name="maxNbrHNBRegistered" type="integer"/> + <element name="maxPacketCapability" type="integer"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + <element ref="un:IuhSignLinkTp"/> + <element ref="un:EP_Iuh"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + + <element name="IuhSignLinkTp"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> +``` + +``` +<all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="farEndEntity" type="string" minOccurs="0"/> + <element name="sctpAssocLocalAddr" type="string"/> + <element name="sctpAssocRemoteAddr" type="string"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="EP_Iuh"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="farEndEntity" type="string" minOccurs="0"/> + <element name="farEndNEIPAddr" type="string" minOccurs="0"/> + </all> + </complexType> + </element> + + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="HNBProfile"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="configuration" type="string"/> + <element name="criterion" type="string" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="HMSFunction"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + <element ref="un:HNBProfile"/> + </choice> + </sequence> + </extension> +</complexContent> +</complexType> +</element> + +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140332 | 0001 | - | | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140360 | 0002 | - | | remove the feature support statements | 11.1.0 | +| 2014-09 | SA#65 | SP-140560 | 0003 | - | | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 2016-01 | SA#70 | | | | | Update to Rel-13 (MCC) | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 0004 | | | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0005 | - | F | Update link from IRP SS to IS | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0006 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28674/raw.md b/marked/Rel-16/28_series/28674/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7f393d01db0ac11fff6aa0b42e34ce61f5a2659c --- /dev/null +++ b/marked/Rel-16/28_series/28674/raw.md @@ -0,0 +1,135 @@ + + + + + + +# --- Contents + +- Foreword ..... 5 +- Introduction ..... 5 +- 1 Scope..... 6 +- 2 References..... 6 +- 3 Definitions, symbols and abbreviations..... 6 + - 3.1 Definitions..... 6 + - 3.1 Abbreviations ..... 7 +- 4 Concepts and background ..... 8 +- 5 Requirements ..... 8 +- Annex A (informative): Change history..... 9 + +# --- Foreword + +This Technical Report has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- 28.674: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** +- 28.675: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- 28.676: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The document describes the requirements for Home eNodeB Subsystem (HeNS), which include Home eNodeB (HeNB) and Home eNodeB gateway (HeNB GW). The HeNS NRM IRP requirements are targeted on both HeNB and HeNB GW NRM. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 25.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [6] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [7] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access (E-UTRAN); Overall description; Stage 2". +- [8] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [9] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**Integration Reference Point (IRP):** See 3GPP TS 32.150 [5]. + +**Information Service (IS):** See 3GPP TS 32.150 [5]. + +**Solution Set (SS):** See 3GPP TS 32.150 [5]. + +**IRP Solution Set:** See 3GPP TS 32.101 [1]. + +## 3.1 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|--------------------------------| +| HeNB | Home eNodeB | +| GW | Gateway | +| HeNB | Home enhanced Node B | +| HeNS | Home enhanced Node B Subsystem | +| IRP | Integration Reference Point | +| IOC | Information Object Class | +| NRM | Network Resource Model | + +# --- 4 Concepts and background + +HeNB Subsystem is defined in TS 23.401[6]. According to the definition, a HeNB Subsystem consists of a HeNB and optionally a HeNB GW. The HeNB Subsystem is connected by means of the standard S1 interface to the EPC (Evolved Packet Core), more specifically to the MME (Mobility Management Entity) by means of the S1-MME interface and to the Serving Gateway (S-GW) by means of the S1-U interface. + +Detailed functions of HeNB and HeNB GW are described in TS 36.300 [7]. To be more specific, HeNB is a Customer Premise Equipment that offers the LTE-Uu Interface to the UE. And it could discovery a suitable Serving HeNB GW over S1 interface. A HeNB GW can relay UE-associated S1 application part messages between the MME serving the UE and the HeNB serving the UE. It could terminate non-UE associated S1 application part procedures towards the HeNB and towards the MME and optionally terminate S1-U interface with the HeNB and with the S-GW. + +Based on the above characteristics, this specification defines respective HeNS NRM IRP requirements. + +# --- 5 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [2]. +- b) IRP-related requirements in 3GPP TS 32.102 [3]. +- c) IRP-related requirements in 3GPP TS 32.600 [4]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [8] and its information is derived from FNIM Umbrella Information Model (UIM) [9] + +In addition to the above, the following more specific requirements apply: + +**REQ-HeNS\_GW-CON-001** The Network Resource Model defined by this IRP shall contain HeNB GW specific IOCs and related definitions.. + +**REQ-HeNS\_GW-CON-002** The Network Resource Model defined by this IRP shall provide support for enabling consistency between HeNB GW, HeNB and related EPC nodes. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140360 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28675/raw.md b/marked/Rel-16/28_series/28675/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..61fbd40e49d2b4c5e85a6c9ca13508fb23f5a713 --- /dev/null +++ b/marked/Rel-16/28_series/28675/raw.md @@ -0,0 +1,437 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 7 | +| 4.1 Imported information entities and local labels..... | 7 | +| 4.2 Class diagram ..... | 8 | +| 4.2.1 Relationships ..... | 8 | +| 4.2.2 Inheritance ..... | 9 | +| 4.3 Class definitions ..... | 9 | +| 4.3.1 HeNBGWFunction ..... | 9 | +| 4.3.1.1 Definition ..... | 9 | +| 4.3.1.2 Attributes ..... | 10 | +| 4.3.1.3 Notifications..... | 10 | +| 4.3.2 HeMSFunction ..... | 10 | +| 4.3.2.1 Definition ..... | 10 | +| 4.3.2.2 Attributes ..... | 10 | +| 4.3.2.3 Notifications..... | 10 | +| 4.3.3 HeNBProfile ..... | 10 | +| 4.3.3.1 Definition ..... | 10 | +| 4.3.3.2 Attributes ..... | 10 | +| 4.3.3.3 Notifications..... | 10 | +| 4.3.4 HeNB..... | 10 | +| 4.3.4.1 Definition ..... | 10 | +| 4.3.4.2 Attributes ..... | 11 | +| 4.3.4.3 Notifications..... | 11 | +| 4.4 Attribute definitions ..... | 12 | +| 4.4.1 Attribute Properties ..... | 12 | +| 4.4.2 Constraints ..... | 13 | +| 4.5 Common Notifications ..... | 13 | +| 4.5.1 Alarm notifications..... | 13 | +| 4.5.2 Configuration notifications..... | 13 | +| Annex A (informative): Change history..... | 14 | + +# --- Foreword + +This Technical Report has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +28.674: Telecommunication management; Home eNode B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements. + +**28.675.: Telecommunication management; Home eNode B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS).** + +28.676: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document specifies the Home enhanced Node B (HeNB) Subsystem (HeNS) Network Resource Model (NRM) IRP that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +In order to access the information defined by this NRM, an IRP IS is needed, such as the Basic CM IRP IS (3GPP TS 32.602 [6]) or the Bulk CM IRP IS (3GPP TS 32.612 [7]). However, which IS that is applicable is outside the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [5] 3GPP TS 28.622: "Telecommunication management;; Generic Network Resource Model (NRMs) Integration Reference Point (IRP):Information Service" (IS)". +- [6] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP): Information Service (IS)". +- [7] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [8] 3GPP TS 28.702: "Telecommunication management; Core Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [9] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA), Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; stage 2". +- [10] 3GPP TS 32.593: "Home eNode B (HeNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Procedure flows for Type 1 Interface HeNB to HeNB Management System (HeMS)". +- [11] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [12] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". + +- [13] 3GPP TS 28.708: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [14] 3GPP TS 28.672: "Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [15] 3GPP TS 28.652: "UTRAN Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [16] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [17] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [18] TR-196, "Femto Access Point Device Data Model", Broadband Forum, 2009, <http://broadband-forum.org/technical/download/TR-196.pdf>. + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following definitions and abbreviations apply. For definitions and abbreviations not found here, please refer to 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TS 32.600 [5]. + +**Association:** See definition in TS 28.622 [6]. + +**Management Information Model (MIM):** also referred to as NRM - see the definition below. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|--------------------------------| +| GW | Gateway | +| HeNB | Home enhanced Node B | +| HeNS | Home enhanced Node B Subsystem | +| IOCs | Information Object Classes | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|-------------------------------------------|-----------------| +| 3GPP TS 28.622 [5], IOC, ManagedElement | ManagedElement | +| 3GPP TS 28.622 [5], IOC, ManagedFunction | ManagedFunction | +| 3GPP TS 28.622 [5], IOC, MeContext | MeContext | +| 3GPP TS 28.622 [5], IOC, SubNetwork | SubNetwork | +| 3GPP TS 28.622 [5], IOC, Top | Top | +| 3GPP TS 28.622 [5], IOC, VsDataContainer | VsDataContainer | +| 3GPP TS 28.622 [5], IOC, ManagementNode | ManagementNode | +| 3GPP TS 28.708 [13], IOC, EP_RP_EPS | EP_RP_EPS | +| 3GPP TS 28.672 [14], IOC, LocalGWFunction | LocalGWFunction | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of IOCs that encapsulate information relevant for this service. This clause provides the overview of all information object classes in UML. Subsequent clauses provide more detailed specification of various aspects of these information object classes. + +![UML Class diagram showing relationships between various Information Object Classes (IOCs) and Support IOCs. A note indicates that 'Any' represents any managed entity with a DN (e.g., HeMSFunction).](5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg) + +UML Class diagram illustrating relationships between various Information Object Classes (IOCs) and Support IOCs. A note indicates that 'Any' represents any managed entity with a DN (e.g., HeMSFunction). + +``` + +classDiagram + class Any { + <<InformationObjectClass>> + } + class ManagementNode { + <<InformationObjectClass>> + (from 28.622) + } + class ManagedElement { + <<InformationObjectClass>> + (from 28.622) + } + class LocalGWFunction { + <<SupportIOC>> + (from 28.672) + } + class HeNB { + <<SupportIOC>> + } + class HeMSFunction { + <<InformationObjectClass>> + } + class HeNBGWFunction { + <<InformationObjectClass>> + } + class HeNBProfile { + <<InformationObjectClass>> + } + + Any "1" *-- "*" LocalGWFunction : «names» + Any "1" *-- "*" HeNB : «names» + ManagementNode "1" *-- "*" HeMSFunction : «names» + ManagedElement "1" *-- "*" HeNBGWFunction : «names» + LocalGWFunction "1" *-- "*" HeMSFunction : «names» + LocalGWFunction "1" *-- "*" HeNB : «names» + HeNB "1" *-- "*" HeMSFunction : «names» + HeNB "1" *-- "*" HeNBProfile : «names» + +``` + +UML Class diagram showing relationships between various Information Object Classes (IOCs) and Support IOCs. A note indicates that 'Any' represents any managed entity with a DN (e.g., HeMSFunction). + +NOTE 1: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +Figure 4.2.1-1 HeNS NRM Containment/Naming + +![UML Class diagram showing relationships between HeNBGWFunction, EP_RP_EPS, and Proxy_FarEndNE. A note indicates that the EP_RP_EPS proxy class represents MMEFunction (From TS 32.752) or SGWFunction (from TS 32.752).](731f533b0599c8e42a063f06e4332045_img.jpg) + +UML Class diagram illustrating relationships between HeNBGWFunction, EP\_RP\_EPS, and Proxy\_FarEndNE. A note indicates that the EP\_RP\_EPS proxy class represents MMEFunction (From TS 32.752) or SGWFunction (from TS 32.752). + +``` + +classDiagram + class HeNBGWFunction { + <<InformationObjectClass>> + } + class EP_RP_EPS { + <<InformationObjectClass>> + (from 32.752) + } + class Proxy_FarEndNE { + <<ProxyClass>> + } + + HeNBGWFunction "1" -- "*" EP_RP_EPS : + eP_RP_EPS + EP_RP_EPS "1" -- "0..1" Proxy_FarEndNE : + farEnd + +``` + +UML Class diagram showing relationships between HeNBGWFunction, EP\_RP\_EPS, and Proxy\_FarEndNE. A note indicates that the EP\_RP\_EPS proxy class represents MMEFunction (From TS 32.752) or SGWFunction (from TS 32.752). + +Figure 4.2.1-2 HeNS NRM Containment/Naming + +![Figure 4.2.1-3: VsDataContainer Containment/Naming. This diagram shows three separate instances of InformationObjectClass (HeNBGWFunction, HeNBProfile, and HeMSFunction) and their relationship to VsDataContainer. Each IOC has a 1-to-many aggregation relationship with VsDataContainer (from 28.622) via the 'names' association.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +classDiagram + class HeNBGWFunction["«InformationObjectClass» +HeNBGWFunction"] + class HeNBProfile["«InformationObjectClass» +HeNBProfile"] + class HeMSFunction["«InformationObjectClass» +HeMSFunction"] + class VsDataContainer["«InformationObjectClass» +VsDataContainer +(from 28.622)"] + + HeNBGWFunction "1" *-- "*" VsDataContainer : «names» + HeNBProfile "1" *-- "*" VsDataContainer : «names» + HeMSFunction "1" *-- "*" VsDataContainer : «names» + VsDataContainer "1" *-- "*" HeNBGWFunction : «names» + VsDataContainer "1" *-- "*" HeNBProfile : «names» + VsDataContainer "1" *-- "*" HeMSFunction : «names» + +``` + +Figure 4.2.1-3: VsDataContainer Containment/Naming. This diagram shows three separate instances of InformationObjectClass (HeNBGWFunction, HeNBProfile, and HeMSFunction) and their relationship to VsDataContainer. Each IOC has a 1-to-many aggregation relationship with VsDataContainer (from 28.622) via the 'names' association. + +NOTE 1: The listed cardinality numbers, in particular the use of cardinality number zero, do not represent transient states. The transient state is considered an inherent property of all IOC instances and therefore there is no need to represent them by individual IOC cardinality numbers. + +NOTE 2: Each instance of the *VsDataContainer* shall only be contained under one IOC. The *VsDataContainer* can be contained under IOCs defined in other NRMs. + +**Figure 4.2.1-3: VsDataContainer Containment/Naming** + +The *VsDataContainer* is only used for the Bulk CM IRP. + +Each IOC is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [11] that expresses its containment + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +![Figure 4.2.2-1: HeNS NRM Inheritance Hierarchy. This diagram shows ManagedFunction (from 28.622) as the base class for HeNBProfile, HeMSFunction, and HeNBGWFunction. All three are InformationObjectClass.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +classDiagram + class ManagedFunction["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + class HeNBProfile["«InformationObjectClass» +HeNBProfile"] + class HeMSFunction["«InformationObjectClass» +HeMSFunction"] + class HeNBGWFunction["«InformationObjectClass» +HeNBGWFunction"] + + HeNBProfile --|> ManagedFunction + HeMSFunction --|> ManagedFunction + HeNBGWFunction --|> ManagedFunction + +``` + +Figure 4.2.2-1: HeNS NRM Inheritance Hierarchy. This diagram shows ManagedFunction (from 28.622) as the base class for HeNBProfile, HeMSFunction, and HeNBGWFunction. All three are InformationObjectClass. + +**Figure 4.2.2-1: HeNS NRM Inheritance Hierarchy** + +## 4.3 Class definitions + +### 4.3.1 HeNBGWFunction + +#### 4.3.1.1 Definition + +This IOC represents HeNB GW functionality. For more information about the HeNB GW, see 3GPP TS 36.300[9] + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------|-------------------|------------|------------|-------------|--------------| +| henbGwId | M | M | - | - | M | +| IPConfigInfo | M | M | - | - | M | +| maxNbrHeNBRegistered | M | M | - | - | M | +| maxPacketCapability | M | M | - | - | M | + +#### 4.3.1.3 Notifications + +The common notifications defined in clause 4.5 are valid for this class, without exceptions or additions. + +### 4.3.2 HeMSFunction + +#### 4.3.2.1 Definition + +This IOC represents HeMS functionality. For more information about HeMS, see 3GPP TS 32.593[10]. + +#### 4.3.2.2 Attributes + +None. + +#### 4.3.2.3 Notifications + +There are no Notifications defined. + +### 4.3.3 HeNBProfile + +#### 4.3.3.1 Definition + +The HeNBProfile is a representation of information that a) identifies a specific set of HeNB devices and b) the related configuration parameters (and their values) that are required to be configured in those identified HeNB devices during HeNB registration procedure [10]. + +It contains userLabel, an attribute inherited from ManagedFunction. This is a user friendly label assigned by operator. Examples can be “VIP configuration”, “Gold Tier configuration”, “device vendor XYZ software version 3.4”, “camel”, etc. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| configuration | M | M | -- | - | M | +| criterion | O | M | -- | - | M | + +#### 4.3.3.3 Notifications + +There are no Notifications defined. + +### 4.3.4 HeNB + +#### 4.3.4.1 Definition + +This class represents HeNB functionality. For more information about the HeNB, see 3GPP TS 36.300 [9]. + +The Home eNodeB, represented by the <<SupportIOC>> HeNB, has registered itself with one node represented by HeMSFunction. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| id | M | - | - | - | M | + +#### 4.3.4.3 Notifications + +The common notifications defined in clause 4.5 are not valid for this class. The set of notifications defined in the following table is valid. + +| Name | Qualifier | Notes | +|---------------------------|---------------------------------------|-------| +| notifyAckStateChange<br>d | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [12]) | | + +## 4.4 Attribute definitions + +### 4.4.1 Attribute Properties + +This table defines the attributes that are present in several Information Object Classes (IOCs) of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | <p>An attribute whose 'name+value' can be used as an RDN when naming an instance of the IOC. This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance.</p> <p>allowedValues: format of allowed values to be conformant with TS 32.300[11]</p> | <p>type: String<br/> multiplicity:1<br/> isOrdered: False<br/> isUnique: True<br/> defaultValue:None<br/> isNullable: False</p> | +| henbGwId | <p>Unique HeNB GW ID. Ref. 3GPP TS 36.300 [9] specifies that HeNB GW acts as a concentrated node to the existing EPC network using existing S1 interface.</p> <p>allowedValues: see [18]</p> | <p>type: see [18]<br/> multiplicity: see [18]<br/> isOrdered: see [18]<br/> isUnique: see [18]<br/> defaultValue: see [18]<br/> isNullable: see [18]</p> | +| iPConfigInfo | <p>The IP address, subnetwork mask, default gateway for HeNB GW.</p> <p>allowedValues: see [18]</p> | <p>type: see [18]<br/> multiplicity: see [18]<br/> isOrdered: see [18]<br/> isUnique: see [18]<br/> defaultValue: see [18]<br/> isNullable: see [18]</p> | +| maxNbrHeNBRegistered | <p>Maximum number of registered HeNB means maximum number of HeNB allowed to be registered.</p> <p>allowedValues: see [18]</p> | <p>type: see [18]<br/> multiplicity: see [18]<br/> isOrdered: see [18]<br/> isUnique: see [18]<br/> defaultValue: see [18]<br/> isNullable: see [18]</p> | +| maxPacketCapacity | <p>The HeNB GW's ability of forwarding packets, such as maximum number of forwarded packets per second.</p> <p>allowedValues: see [18]</p> | <p>type: see [18]<br/> multiplicity: see [18]<br/> isOrdered: see [18]<br/> isUnique: see [18]<br/> defaultValue: see [18]<br/> isNullable: see [18]</p> | +| farEndNeIpAddr | <p>The IP address(s) of the far end network entity to which the reference point is related. This is an IPv4 or an IPv6 address.</p> <p>allowedValues: see [18]</p> | <p>type: see [18]<br/> multiplicity: see [18]<br/> isOrdered: see [18]<br/> isUnique: see [18]<br/> defaultValue: see [18]<br/> isNullable: see [18]</p> | +| configuration | <p>It is a location of a data set. The data set is a set of HeNB attributes (with values) needed to be loaded into the HeNB.</p> <p>The data set does not contain all configuration data needed for a device to operate. Some configuration parameters are autonomously and dynamically calculated by the serving HeMS.</p> <p>allowedValues: see [18]</p> | <p>type: see [18]<br/> multiplicity: see [18]<br/> isOrdered: see [18]<br/> isUnique: see [18]<br/> defaultValue: see [18]<br/> isNullable: see [18]</p> | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <code>criterion</code> | <p>It is a criterion that determines if a HeNB should or should not be loaded with a particular configuration.</p> <p>The syntax and semantics of <code>criterion</code> is vendor-specific.</p> <p>Example 1:</p> <p>The syntax and semantics can be “If the HeNB ID range is between ABC and DEF then APPLY the related configuration”.</p> <p>Example 2:</p> <p>The syntax is a list of strings where each string is a “attribute == value” pair. An attribute represents a TR-196 parameter. Its value is the corresponding attribute value.</p> <p>The semantics is “if all pairs found in <code>criterion</code> are also found in the home devices, then the determination is positive in that the home device should be loaded with information of the data set identified by <code>configuration</code>; else not”.</p> <p><code>allowedValues</code>: see [18]</p> | <p>type: see [18]</p> <p>multiplicity: see [18]</p> <p>isOrdered: see [18]</p> <p>isUnique: see [18]</p> <p>defaultValue: see [18]</p> <p>isNullable: see [18]</p> | + +### 4.4.2 Constraints + +None. + +## 4.5 Common Notifications + +### 4.5.1 Alarm notifications + +This subclause presents a list of notifications, defined in [16], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [17], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|-----------------------------------------|---------------------------------------|-------| +| <code>notifyAckStateChanged</code> | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| <code>notifyAttributeValueChange</code> | O | | +| <code>notifyChangedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| <code>notifyClearedAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| <code>notifyNewAlarm</code> | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| <code>notifyObjectCreation</code> | O | | +| <code>notifyObjectDeletion</code> | O | | +| <code>notifyComments</code> | See Alarm IRP (3GPP TS 32.111-2 [12]) | | + +### 4.5.2 Configuration notifications + +None. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140360 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28676/raw.md b/marked/Rel-16/28_series/28676/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f54022d5ef02e10530053ae7ae2fc3132fd27843 --- /dev/null +++ b/marked/Rel-16/28_series/28676/raw.md @@ -0,0 +1,470 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set Definitions ..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.2 Rules for NRM extensions ..... | 8 | +| A.2 Mapping ..... | 8 | +| A.2.1 General mappings..... | 8 | +| A.2.2 Information Object Class (IOC) mapping..... | 8 | +| A.2.2.1 IOC HeNBGWFunction ..... | 8 | +| A.2.2.2 IOC HeNBProfile ..... | 9 | +| A.2.2.3 IOC HeMSFunction..... | 9 | +| A.3 Solution Set definitions ..... | 10 | +| A.3.1 IDL definition structure..... | 10 | +| A.3.2 IDL specification "HensNetworkResourcesNRMDefs.idl"..... | 11 | +| <b>Annex B (normative): XML Definitions.....</b> | <b>12</b> | +| B.0 General..... | 12 | +| B.1 Architectural features..... | 12 | +| B.1.1 Syntax for Distinguished Names..... | 12 | +| B.2 Mapping ..... | 12 | +| B.2.1 General mapping ..... | 12 | +| B.2.2 Information Object Class (IOC) mapping..... | 12 | +| B.3 Solution Set definitions ..... | 13 | +| B.3.1 XML definition structure ..... | 13 | +| B.3.2 Graphical Representation ..... | 13 | +| B.3.3 XML schema "hensNrm.xsd" ..... | 14 | +| Annex C (informative): Change history..... | 16 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; Configuration Management (CM); as identified below: + +- 28.674: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.675: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.676: Telecommunication management; Home enhanced Node B Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named HeNS Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning HeNS resources. The HeNS NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the HeNS NRM IRP. + +This Solution Set specification is related to 3GPP TS 28.675 V14.0.X [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.675: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [3] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [4] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [5] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [6] Void +- [7] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [8] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [9] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [10] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [11] 3GPP TS 28.623: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**XML file:** See definition of [11]. + +**XML document:** See definition of [11]. + +**XML declaration:** See definition of [11] + +**XML element:** See definition of [11]. + +**empty XML element:** See definition of [11]. + +**XML content (of an XML element):** See definition of [11] + +**XML start-tag:** See definition of [11]. + +**XML end-tag:** See definition of [11] + +**XML empty-element tag:** See definition of [11]. + +**XML attribute specification:** See definition of [11]. + +**DTD:** See definition of [11]. + +**XML schema:** See definition of [11]. + +**XML namespace:** See definition of [11]. + +**XML complex type:** See definition of [11]. + +**XML element type:** See definition of [11]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|-------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| HeNB | Home enhanced Node B | +| HeNS | Home enhanced Node B Subsystem | +| HeNB-GW | Home enhanced Node B Gateway | +| IS | Information Service | +| IDL | Interface Definition Language | +| IRP | Integration Reference Point | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP HeNS NRM IRP Solution Set Definitions: + +- 3GPP HeNS NRM IRP CORBA SS (Annex A) +- 3GPP HeNS NRM IRP XML Definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in HeNS NRM IRP: Information Service (TS 32.782 [2]). + +### --- A.1 Architectural features + +The overall architectural feature of HeNS Network Resources IRP is specified in 3GPP TS 29.675 [2]. This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [11]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.1 of [11]. + +## --- A.2 Mapping + +#### A.2.1 General mappings + +See clause A.1.1 of [11]. + +### A.2.2 Information Object Class (IOC) mapping + +This SS supports reference attributes for relations other than containment relations between objects. Reference attributes are therefore introduced in each MOC where needed. + +#### A.2.2.1 IOC HeNBGWFunction + +| IS Attributes | SS Attributes | SS Type | +|----------------------|----------------------|---------| +| id | henbgwFunctionId | string | +| henbgwId | henbgwId | long | +| userLabel | userLabel | string | +| ipConfigInfo | ipConfigInfo | string | +| maxNbrHeNBRegistered | maxNbrHeNBRegistered | Integer | +| maxPacketCapability | maxPacketCapability | integer | + +#### A.2.2.2 IOC HeNBProfile + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | henbProfileId | string | +| userLabel | userLabel | string | +| Configuration | configuration | string | +| Criterion | criterion | string | + +#### A.2.2.3 IOC HeMSFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| userLabel | userLabel | string | + +## --- A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the HeNS NRM IRP. + +### A.3.2 IDL specification “HensNetworkResourcesNRMDefs.idl” + +``` +//File: HensNetworkResourcesNRMDefs.idl +#ifndef _HENSNETWORKRESOURCESNRMDefs_IDL_ +#define _HENSNETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module HensNetworkResourcesNRMDefs +{ + + /** + * Definitions for MO class HeNBGWFunction + */ + interface HeNBGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "HeNBGWFunction"; + // Attribute Names + // + const string henbgwFunctionId = "henbgwFunctionId"; + const string henbgwId = "henbgwId"; + const string ipConfigInfo = "ipConfigInfo"; + const string maxNbrHeNBRegistered = "maxNbrHeNBRegistered"; + const string maxPacketCapability = "maxPacketCapability"; + }; + + /** + * Definitions for MO class HeNBProfile + */ + interface HeNBProfile : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS= "HeNBProfile"; + // Attribute Names + // + const string henbProfileId = "henbProfileId"; + const string configuration = "configuration"; + const string criterion = "criterion"; + }; + + /** + * Definitions for MO class HeMSFunction + */ + interface HeMSFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS= "HeMSFunction"; + // Attribute Names + // + }; + +}; + +#endif // _HENSNETWORKRESOURCESNRMDefs_IDL_ +``` + +# --- Annex B (normative): XML Definitions + +## B.0 General + +This annex contains the XML Definitions for the HeNS NRM IRP as it applies to Itf-N, in accordance with HeNS NRM IRP Information Service (TS 28.765 [2]). + +The XML file formats are based on XML [5], XML Schema [7] [8] and XML Namespace [9] standards. + +## --- B.1 Architectural features + +The overall architectural feature of HeNS Network Resources IRP is specified in 3GPP TS 28.675 [2]. This clause specifies features that are specific to the Schema definitions. + +### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [10]. + +## --- B.2 Mapping + +### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +Annex B.3.3 of the present document defines the NRM-specific XML schema hensNrm.xsd for the HeNS Network Resources IRP NRM defined in 3GPP TS 28.675 [2]. + +XML schema hensNrm.xsd explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [3]. + +### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +### B.3.3 XML schema "hensNrm.xsd" + +``` + +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.676 HeNS Network Resources IRP + Bulk CM Configuration data file NRM-specific XML schema + hensNrm.xsd +--> + +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.676#hensNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:un= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.676#hensNrm" + xmlns:gn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + xmlns:sm= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + xmlns:epc= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.709#epcNrm" +> + + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.656#genericNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.656#geranNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.709#epcNrm" + /> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" + /> + + <!-- HeNS network Resources IRP NRM class associated XML elements --> + + <element + name="HeNBGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="henbgwId" type="string"/> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="ipConfigInfo" type="string"/> + <element name="maxNbrHeNBRegistered" type="integer"/> + <element name="maxPacketCapability" type="integer"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + + <element name="HeNBProfile"> + +``` + +``` + +<complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="configuration" type="string"/> + <element name="criterion" type="string" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> +</complexType> +</element> + +<element name="HeMSFunction"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + <element ref="un:HeNBProfile"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 06-2014 | SA#64 | SP-140332 | 0001 | - | | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140360 | 0002 | - | | remove the feature support statements | 11.1.0 | +| 09-2014 | SA#65 | SP-140560 | 0003 | - | | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 01-2016 | SA#70 | | | | | Update to Rel-13(MCC) | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | <b>14.0.0</b> | +| 2017-06 | SA#76 | SP-170514 | 0005 | - | F | Update link from IRP SS to IS | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0006 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28680/raw.md b/marked/Rel-16/28_series/28680/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0e87823140aa80824703dfe78802224ed8d47dc9 --- /dev/null +++ b/marked/Rel-16/28_series/28680/raw.md @@ -0,0 +1,313 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Concepts and background ..... 6 + - 4.1 Overview ..... 6 + - 4.2 Mapping Function ..... 6 + - 4.3 WLAN alarm notification ..... 6 +- 5 Requirements ..... 10 +- Annex A (informative): Change history..... 11 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +# **TS 28.680: Telecommunication management; Wireless Local Area Network (WLAN) management; Concepts and requirements** + +TS 28.681: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. + +TS 28.682: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). + +TS 28.683: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document describes the concepts and requirements of WLAN management that focus on WLAN performance monitoring and alarm notifications. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.150: "Telecommunication management; IRP Concept and definitions". +- [4] IETF RFC 2863: "The Interfaces Group MIB". +- [5] 3GPP TS 32.111-2: "Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [6] IETF RFC 3877: "Alarm Management Information Base (MIB)", September, 2004. +- [7] 3GPP TS 32.102: "Telecommunication management; Architecture". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 32.101 [2], 3GPP TS 32.102 [7], and 3GPP TS 32.150 [3] 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]. + +## 3.2 Abbreviations + +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]. + +| | | +|------|-------------------------------| +| AC | Access Controller | +| AP | Access Point | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| NE | Network Element | +| WLAN | Wireless Local Access Network | + +# 4 Concepts and background + +## 4.1 Overview + +The architecture for management of WLAN AP is conformant to the Management reference model as defined in Figure 1 of TS 32.101 [2] where the WLAN AP is depicted as NE. The system context of the WLAN management is in compliance with the System Context A, defined in Figure 4.7.1 in TS 32.150 [3]. + +## 4.2 Mapping Function + +Figure 4.2-1 provides an example of 3GPP – WLAN mapping function. The mapping function is to map the relevant management data produced by WLAN AP in a form suitable for distribution via the Type-2 interface to IRPManager(s). The mapping function is a logical function. Its location, as well as its internal and external interfaces, if any, are out the scope of 3GPP specification. + +![Diagram showing the 3GPP – WLAN Mapping Function architecture. It consists of three layers: NM (Network Management) at the top containing IRPManager; EM (Element Management) in the middle containing IRPAgent and Mapping Function; and AC (Access Control) at the bottom connected to multiple WLAN APs. Interfaces shown are Type-2 interface between NM and EM, and AC – AP interface between AC and WLAN APs. An 'Optional' component is also indicated.](6df5629bc2fc6d82f1a1edf9d7340113_img.jpg) + +``` + +graph TD + subgraph NM [NM] + IRPManager[IRPManager] + end + subgraph EM [EM] + IRPAgent[IRPAgent] + MF((Mapping Function)) + end + subgraph AC [AC] + AC[AC] + end + subgraph WLAN [WLAN AP] + AP1[WLAN AP] + AP2[WLAN AP] + Optional[Optional] + end + + IRPManager <--> |Type-2 interface| IRPAgent + IRPAgent <--> MF + MF <--> AC + AC <--> |AC – AP interface| AP1 + AC <--> |AC – AP interface| AP2 + AC <--> |AC – AP interface| Optional + +``` + +Diagram showing the 3GPP – WLAN Mapping Function architecture. It consists of three layers: NM (Network Management) at the top containing IRPManager; EM (Element Management) in the middle containing IRPAgent and Mapping Function; and AC (Access Control) at the bottom connected to multiple WLAN APs. Interfaces shown are Type-2 interface between NM and EM, and AC – AP interface between AC and WLAN APs. An 'Optional' component is also indicated. + +Figure 4.2-1: Example of 3GPP – WLAN Mapping Function + +## 4.3 WLAN alarm notification + +WLAN AP alarms can be generated from ifOperStatus (RFC 2863 [4]) object. The following examples extracted from RFC 3877 [6] shows that the WLAN AP embeds the ifOperStatus object in the linkUp/linkDown notifications to report the WLAN AP alarms. + +``` + +"6.1. Alarms Based on linkUp/linkDown Notifications +linkDown NOTIFICATION-TYPE + OBJECTS { ifIndex, ifAdminStatus, ifOperStatus } + STATUS current + DESCRIPTION + "" + ::= { snmpTraps 3 } + +linkUp NOTIFICATION-TYPE + OBJECTS { ifIndex, ifAdminStatus, ifOperStatus } + STATUS current + DESCRIPTION + "" + ::= { snmpTraps 4 }" + +alarmModelIndex + +``` + +``` + +alarmModelState 1 +alarmModelNotificationId linkUp +alarmModelVarbindIndex 0 +alarmModelVarbindValue 0 +alarmModelDescription "linkUp" +alarmModelSpecificPointer ituAlarmEntry.3.1 +alarmModelVarbindSubtree ifIndex (1.3.6.1.2.1.2.2.1.1) +alarmModelResourcePrefix 0.0 +alarmModelRowStatus active (1) +ituAlarmEventType communicationsAlarm (2) +ituAlarmPerceivedSeverity cleared (1) +ituAlarmGenericModel alarmModelEntry.3.1 + +alarmModelIndex 3 +alarmModelState 3 +alarmModelNotificationId linkDown +alarmModelVarbindIndex 2 +alarmModelVarbindValue up (1) +alarmModelDescription "linkDown - confirmed problem" +alarmModelSpecificPointer ituAlarmEntry.3.3 +alarmModelVarbindSubtree ifIndex (1.3.6.1.2.1.2.2.1.1) +alarmModelResourcePrefix 0.0 +alarmModelRowStatus active (1) +ituAlarmEventType communicationsAlarm (2) +ituAlarmPerceivedSeverity critical (3) +ituAlarmGenericModel alarmModelEntry.3.3 + +``` + +WLAN AP will send a notification when `ifOperStatus` object changes its value. The value of `ifOperStatus` object is shown below (see RFC 2863 [4]). + +``` + +ifOperStatus OBJECT-TYPE + SYNTAX INTEGER { + up(1), -- ready to pass packets + down(2), + testing(3), -- in some test mode + unknown(4), -- status can not be determined + -- for some reason. + dormant(5), + notPresent(6), -- some component is missing + lowerLayerDown(7) -- down due to state of + -- lower-layer interface(s) + } + MAX-ACCESS read-only + STATUS current + DESCRIPTION + "The current operational state of the interface. The + testing(3) state indicates that no operational packets can + be passed. If ifAdminStatus is down(2) then ifOperStatus + should be down(2). If ifAdminStatus is changed to up(1) + then ifOperStatus should change to up(1) if the interface is + ready to transmit and receive network traffic; it should + change to dormant(5) if the interface is waiting for + external actions (such as a serial line waiting for an + incoming connection); it should remain in the down(2) state + if and only if there is a fault that prevents it from going + to the up(1) state; it should remain in the notPresent(6) + state if the interface has missing (typically, hardware) + components." + ::= { ifEntry 8 } + +``` + +The following tables show that IRPAgent, together with the mapping function will map the IETF alarm notification attributes for `down(2)` and `up(1)` to the 3GPP alarm parameters as defined in TS 32.111-2 [5]. For each table, it also includes the example of on what conditions the 3GPP alarm notification will be sent. + +#### 1) notifyNewAlarm + +| IETF alarm notification attribute | Value | 3GPP AlarmInformation Attribute | Legal Value | +|-----------------------------------|-------------------------------------------------------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | objectClass | Carry the object class name of the IOC | +| | | objectInstance | Carrying the Distinguished Name (DN) of this object instance | +| | | notificationId | Carry the identifier for the notification | +| alarmActiveDateAndTime | DateAndTime<br>(It indicates the local date and time when the alarm occurred) | eventTime | Convey the same semantic as DateAndTime | +| | | systemDN | Carry either (1) the IRPAGENT instance containing that Interface IRP instance, or (2) the DN of that particular Interface IRP instance responsible for the emission of the notification | +| alarmModelVarbindValue | down (2) | notificationType | "notifyNewAlarm" | +| | | probableCause | Communication Subsystem Failure | +| ituAlarmPerceivedSeverity | ituAlarmPerceivedSeverity<br>(It indicates the alarm severity as defined in ITU Recommendation X.733) | perceivedSeverity | Convey the same semantic as ituAlarmPerceivedSeverity | +| ituAlarmEventType | communicationsAlarm (2) | alarmType | "Communications Alarm " | +| | | specificProblem | Absent | +| | | correlatedNotifications | Absent | +| | | backedUpStatus | Absent | +| | | backUpObject | Absent | +| | | trendIndication | Absent | +| | | thresholdInfo | Absent | +| | | stateChangeDefinition | Absent | +| | | monitoredAttributes | Absent | +| | | proposedRepairActions | Absent | +| | | additionalText | Absent | +| | | additionalInformation | Absent | +| | | alarmId | Mapping function allocates the alarm ID | + +If there exists no AlarmInformation [5] in AlarmList [5] corresponding to IETF alarm notification, and the IETF alarm notification is down (2), then the IRPAGENT will send notifyNewAlarm to the IRPManager, who has a subscription with NotificationIRP. + +#### 2) notifyChangedAlarm + +| IETF alarm notification attribute | Value | 3GPP AlarmInformation Attribute | Legal Value | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | objectClass | Carry the object class name of the IOC | +| | | objectInstance | Carrying the Distinguished Name (DN) of this object instance | +| | | notificationId | Carry the identifier for the notification | +| alarmActiveDateAndTime | DateAndTime<br>(It indicates the local date and time when the alarm occurred) | eventTime | Convey the same semantic as DateAndTime | +| | | systemDN | Carry either (1) the IRPAGENT instance containing that Interface IRP instance, or (2) the DN of that particular Interface IRP instance responsible for the emission of the notification | +| alarmModelVarbindValue | down (2) | notificationType | "notifyChangedAlarm". | +| | | probableCause | Communication Subsystem Failure | +| ituAlarmPerceivedSeverity | See reference in ituAlarmPerceivedSeverity<br>(It indicates the alarm severity as defined in ITU Recommendation X.733) | perceivedSeverity | Convey the same semantic as ituAlarmPerceivedSeverity | +| ituAlarmEventType | See reference in communicationsAlarm (2) | alarmType | "Communications Alarm " | +| | | alarmId | Mapping function uses the alarm ID previously allocated | + +If there exists an AlarmInformation [5] in AlarmList [5] corresponding to IETF alarm notification, and the IETF alarm severity ituAlarmPerceivedSeverity has been changed, then the IRPAGENT will send notifyChangedAlarm to the IRPManager, who has a subscription with NotificationIRP. + +### 3) notifyClearedAlarm + +| IETF alarm notification attribute | Value | 3GPP AlarmInformation Attribute | Legal Value | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | objectClass | Carry the object class name of the IOC | +| | | objectInstance | Carrying the Distinguished Name (DN) of this object instance | +| | | notificationId | Carry the identifier for the notification | +| alarmActiveDateAndTime | DateAndTime<br>(It indicates the local date and time when the alarm occurred) | eventTime | Convey the same semantic as DateAndTime | +| | | systemDN | Carry either (1) the IRPAGENT instance containing that Interface IRP instance, or (2) the DN of that particular Interface IRP instance responsible for the emission of the notification | +| alarmModelVarbindValue | up (1) | notificationType | "notifyClearedAlarm". | +| | | probableCause | Communication Subsystem Failure | +| ituAlarmPerceivedSeverity | See reference in ituAlarmPerceivedSeverity<br>(It indicates the alarm severity as defined in ITU Recommendation X.733) | perceivedSeverity | "cleared" | +| ituAlarmEventType | See reference in communicationsAlarm (2) | alarmType | "Communications Alarm " | +| | | correlated Notifications | Absent | +| | | clearUserId | Absent | +| | | clearSystemId | Absent | +| | | alarmId | Mapping function uses the alarm ID previously allocated | + +If there exists an AlarmInformation [5] in AlarmList [5] corresponding to IETF alarm notification, and the IETF alarm notification is up (1), then the IRPAGENT will send notifyClearedAlarm to the IRPManager, who has a subscription with NotificationIRP. + +# 5 Requirements + +###### REQ-WLAN\_NRM\_CON-001 + +The NRM defined by this IRP shall contain WLAN specific classes and related definitions. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 12-2015 | SA-70 | SP-150680 | | | Presented for approval | 1.1.0 | 2.0.0 | +| | | | | | Upgrade to Rel-13 | 2.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-12 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28681/raw.md b/marked/Rel-16/28_series/28681/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..585ef3d0007f4a0593a5ff9d888b1588f8f9c111 --- /dev/null +++ b/marked/Rel-16/28_series/28681/raw.md @@ -0,0 +1,107 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Concepts and background ..... 5 +- 5 Requirements ..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication Management; as identified below: + +- TS 28.680: Telecommunication management; Wireless Local Area Network (WLAN) management; Concepts and requirements +- TS 28.681: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements** +- TS 28.682: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- TS 28.683: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document describes the NRM IRP requirements of WLAN management. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [3] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], and 3GPP TS 32.150 [4] 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]. + +## 3.2 Abbreviations + +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]. + +| | | +|------|-------------------------------| +| AP | Access Point | +| IRP | Integration Reference Point | +| NE | Network Element | +| NRM | Network Resource Model | +| WLAN | Wireless Local Access Network | + +# --- 4 Concepts and background + +The architecture for management of WLAN AP is conformant to the management reference model as defined in Figure 1 of TS 32.101 [2] where the WLAN AP is depicted as NE. The system context of the WLAN management is in compliance with the System Context A, defined in Figure 4.7.1 in TS 32.150 [4]. + +Based on the above characteristics, the present document defines respective WLAN management NRM IRP requirements. + +# --- 5 Requirements + +The following general and high-level requirements apply for the present IRP: + +- A. IRP-related requirements in 3GPP TS 32.101 [2]. +- B. IRP-related requirements in 3GPP TS 32.102 [3]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|----------------------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-12 | SA#70 | SP-150686 | | | Presented for information and approval | 0.2.0 | 1.0.0 | +| | | | | | Upgrade to Rel-13 | 1.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28682/68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg b/marked/Rel-16/28_series/28682/68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1040d6c6d2b238a4cf053c8e1c31abdf033f646b --- /dev/null +++ b/marked/Rel-16/28_series/28682/68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ad44839ac87443a9167455d64653f1603b7282c9563ba028978f0d5230f0ebe +size 22552 diff --git a/marked/Rel-16/28_series/28682/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/28_series/28682/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..48ce9ff97bc51b3499ef72a04832ae0a3ca1b8e2 --- /dev/null +++ b/marked/Rel-16/28_series/28682/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c251830363352ba7a579311b1f9d0368c8f36253626dea37597cc166d72be63 +size 23079 diff --git a/marked/Rel-16/28_series/28682/raw.md b/marked/Rel-16/28_series/28682/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..246a8e2d9950bd8894cea4aabfc154b853742e94 --- /dev/null +++ b/marked/Rel-16/28_series/28682/raw.md @@ -0,0 +1,213 @@ + + + + + + +# Contents + +- Foreword ..... 5 +- Introduction ..... 5 +- 1 Scope..... 6 +- 2 References..... 6 +- 3 Definitions abbreviations ..... 6 + - 3.1 Definitions..... 6 + - 3.2 Abbreviations ..... 7 +- 4 Model ..... 7 + - 4.1 Imported information entities and local labels..... 7 + - 4.2 Class diagram ..... 7 + - 4.2.1 Relationships ..... 7 + - 4.2.2 Inheritance ..... 8 + - 4.3 Class definitions ..... 8 + - 4.3.1 APFunction ..... 8 + - 4.3.1.1 Definition ..... 8 + - 4.3.1.2 Attributes ..... 8 + - 4.3.1.3 Notifications..... 9 +- Annex A (informative): Change history..... 10 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- TS 28.680: Telecommunication management; Wireless Local Area Network (WLAN) management; Concepts and requirements +- TS 28.681: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- TS 28.682: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)** +- TS 28.683: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Wireless Local Area Networks (WLAN) Management Network Resource Model (NRM) IRP, through which an IRP Agent can communicate management information to one or several IRP Managers concerning WLAN management. The WLAN management NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the protocol neutral WLAN management NRM IRP: Information Service (IS). + +The present document also contains stage 2 descriptions for those functionalities for the WLAN Management. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM)s Integration Reference Point (IRP): Information Service" (IS)". +- [3] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [4] IEEE 802.11™-2012: "IEEE Standard for Information technology--Telecommunications and information exchange between systems Local and metropolitan area networks--Specific requirements Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [5] 3GPP TS 28.632: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [6] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [7] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [8] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". + +# --- 3 Definitions abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 32.101 [6], 3GPP TS 32.102 [7], and 3GPP TS 32.150 [8] 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]. + +## 3.2 Abbreviations + +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]. + +| | | +|------|-----------------------------| +| AP | Access Point | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | +| PLMN | Public Land Mobile Network | +| UML | Unified Modelling Language | +| WLAN | Wireless Local Area Network | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|------------------------------------------|-----------------| +| 3GPP TS 28.622 [2], IOC, ManagedElement | ManagedElement | +| 3GPP TS 28.622 [2], IOC, ManagedFunction | ManagedFunction | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides an overview of the relationships between relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. Figure 4.2.1-1 shows the containment/naming hierarchy and the associations of the classes defined in the present document. + +![UML Class diagram showing ManagedElement (from TS 28.622) at the top and APFunction at the bottom. A containment relationship is shown with a solid diamond at the top, labeled '1' and '<<Name>>', pointing down to 'APFunction' which is labeled with '*'.](68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + ManagedElement (from TS 28.622) + } + class APFunction { + <<InformationObjectClass>> + APFunction + } + ManagedElement "1" *-- "*" APFunction : <<Name>> + +``` + +UML Class diagram showing ManagedElement (from TS 28.622) at the top and APFunction at the bottom. A containment relationship is shown with a solid diamond at the top, labeled '1' and '<>', pointing down to 'APFunction' which is labeled with '\*'. + +Figure 4.2.1-1 WLAN NRM Containment/Naming + +NOTE: WLAN NRM may need to be updated, if the WLAN access point is to be part of PLMN. + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between information object classes. Figure 4.2.2-1 shows the inheritance diagram of WLAN NRM. + +![UML Class Diagram showing the inheritance hierarchy for WLAN NRM. The top class is <<InformationObjectClass>> ManagedFunction (from TS 28.622). The bottom class is <<InformationObjectClass>> APFunction. An inheritance arrow points from APFunction to ManagedFunction.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` + +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction (from TS 28.622) + } + class APFunction { + <<InformationObjectClass>> + APFunction + } + APFunction --|> ManagedFunction + +``` + +UML Class Diagram showing the inheritance hierarchy for WLAN NRM. The top class is <> ManagedFunction (from TS 28.622). The bottom class is <> APFunction. An inheritance arrow points from APFunction to ManagedFunction. + +Figure 4.2.2-1 WLAN NRM Inheritance Hierarchy + +## 4.3 Class definitions + +### 4.3.1 APFunction + +#### 4.3.1.1 Definition + +This class represents the functionality of wireless Access Point as defined in IEEE 802.11 [4]. + +The APFunction IOC instance is not visible to Basic CM IRPManager, Bulk CM IRPManager and Kernel CM IRPManager. + +The ManagedElement IOC instance (TS 28.622 [2]) name-containing the APFunction IOC instance is not visible to Basic CM IRPManager, Bulk CM IRPManager and Kernel CM IRPManager in case all the instances directly name-contained by this ManagedElement IOC instance (TS 28.622 [2]) are of APFunction IOC. + +The InventoryUnit IOC instance (TS 28.632 [5]), name-contained by the ManagedElement IOC instance (TS 28.622 [2]) that name-contains the APFunction IOC instance, is not visible to Basic CM IRPManager, Bulk CM IRPManager and Kernel CM IRPManager in case all the instances directly name-contained by this ManagedElement IOC instance (TS 28.622 [2]) are of APFunction IOC or InventoryUnit IOC. + +The following are examples of cases describing the conditions where IOC instance(s) are not visible to Basic CM IRPManager, Bulk CM IRPManager and Kernel CM IRPManager: + +- Case 1) if ManagedElement-1 name-contains only two instances: APFunction-A and APFunction-B, the three instances are not visible. +- Case 2) if ManagedElement-1 name-contains only two instances: APFunction-A and MMEFunction-76, the APFunction-A is not visible. +- Case 3) if ManagedElement-1 name-contains only two instances: APFunction-A and InventoryUnit-7883 (TS 28.632 [5]), the three instances are not visible. + +#### 4.3.1.2 Attributes + +None + +#### 4.3.1.3 Notifications + +The set of notifications defined in the following table is valid. + +| Name | Qualifier | Notes | +|--------------------------------|--------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [3]) | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|-----------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-12 | SA-70 | SP-150687 | | | Presented for approval | 1.2.0 | 2.0.0 | +| | | | | | Upgrade to Release 13 | 2.0.0 | 13.0.0 | +| 2016-03 | SA-71 | SP-160033 | 001 | 1 | Clarification for APFunction visibility | 13.0.0 | 13.1.0 | + +| Change history | | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | | +| 2018-12 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28683/raw.md b/marked/Rel-16/28_series/28683/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7e8f88890bd5af240d267d709f070ea1b8ebc109 --- /dev/null +++ b/marked/Rel-16/28_series/28683/raw.md @@ -0,0 +1,105 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions, and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Solution Set definitions ..... 5 +- Annex <A> (normative): CORBA Solution Set..... 6** +- Annex <B> (informative): XML definitions ..... 7** +- Annex <X> (informative): Change history ..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- TS 28.680: Telecommunication management; Wireless Local Area Network (WLAN) management; Concepts and requirements +- TS 28.681: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- TS 28.682: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- TS 28.683: Telecommunication management; Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Wireless Local Area Network (WLAN) Management Network Resource Model (NRM) IRP, through which an IRP Agent can communicate management information to one or several IRP Managers concerning WLAN management. The WLAN management NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the WLAN NRM IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.682: "Wireless Local Area Network (WLAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" +- [3] 3GPP TS 32.150: "Integration Reference Point (IRP) Concept and definitions" + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and 3GPP TS 32.150 [3] 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]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 32.150 [3] 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] or 3GPP TS 32.150 [3]. + +| | | +|------|-----------------------------| +| WLAN | Wireless Local Area Network | +|------|-----------------------------| + +# --- 4 Solution Set definitions + +Since the instances of all of the IOC(s) defined in WLAN NRM IS (3GPP TS 28.682 [2]) are not visible to Basic CM IRP and Bulk CM IRP, there is no need to define solution sets in the present document. + +# --- Annex A (normative): CORBA Solution Set + +Void. + +# --- Annex B (informative): XML definitions + +Void. + +# --- Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|----------------------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-12 | SA-70 | SP-150688 | | | Presented for information and approval | 0.1.0 | 1.0.0 | +| | | | | | Upgrade to Rel-13 | 1.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28701/raw.md b/marked/Rel-16/28_series/28701/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e25cd4f762c152bbe0d1921a22c967cca997ebc1 --- /dev/null +++ b/marked/Rel-16/28_series/28701/raw.md @@ -0,0 +1,178 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Requirements ..... | 7 | +| Annex A (informative): Change history..... | 8 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; Configuration Management (CM); as identified below: + +**28.701: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".** + +28.702: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +28.703: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +Configuration Management (CM), in general, provides the operator with the ability to assure correct and effective operation of the 3GPP network as it evolves. CM actions have the objective to control and monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. + +CM actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimisation programme (e.g. modifications), and to maintain the overall Quality of Service (QoS). The CM actions are initiated either as single actions on single NEs of the 3GPP network, or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the requirements for the present IRP: Core Network Network Resource Model IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP): Information Service (IS)". +- [5] 3GPP TS 28.704: " Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [6] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [7] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [8] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Data:** is any information or set of information required to give software or equipment or combinations thereof a specific state of functionality. + +**Element Manager (EM):** provides a package of end-user functions for management of a set of closely related types of Network Elements (NEs). These functions can be divided into two main categories: + +- *Element Management Functions* for management of NEs on an individual basis. These are basically the same functions as supported by the corresponding local terminals. +- *Sub-Network Management Functions* that are related to a network model for a set of NEs constituting a clearly defined sub-network, which may include relations between the NEs. This model enables additional functions on the sub-network level (typically in the areas of network topology presentation, alarm correlation, service impact analysis and circuit provisioning). + +**Information Object Class (IOC):** See definition in TS 28.622 [8]. + +**Integration Reference Point (IRP):** See 3GPP TS 32.150 [6]. + +**Information Service (IS):** See 3GPP TS 32.150 [6]. + +**Solution Set (SS):** See 3GPP TS 32.150 [6]. + +**IRP Solution Set:** See 3GPP TS 32.101 [1]. + +**Managed Object (MO):** an abstract entity, which may be accessed through an open interface between two or more systems, and representing a Network Resource (NR) for the purpose of management. The Managed Object (MO) is an instance of a Managed Object Class (MOC) as defined in a Management Information Model (MIM). The MIM does not define how the MO or NR is implemented; only what can be seen in the interface. + +**Managed Object Class (MOC):** a description of all the common characteristics for a number of MOs, such as their attributes, operations, notifications and behaviour. + +**Management Information Model (MIM):** also referred to as NRM – see the definition below. There is a slight difference between the meaning of MIM and NRM – the term MIM is generic and can be used to denote any type of management model, while NRM denotes the model of the actual managed telecommunications Network Resources (NRs). + +**Network Element (NE):** is a discrete telecommunications entity, which can be, managed over a specific interface e.g. the RNC. + +**Network Manager (NM):** provides a package of end-user functions with the responsibility for the management of a network, mainly as supported by the EM(s) but it may also involve direct access to the NEs. All communication with the network is based on open and well-standardised interfaces supporting management of multi-vendor and multi-technology NEs. + +**Network Resource (NR):** is a component of a NE, which can be identified as a discrete separate entity and is in an object oriented environment for the purpose of management represented by an abstract entity called Managed Object (MO). + +**Network Resource Model (NRM):** See definition in TS 28.622 [8]. + +**Object Management Group (OMG):** see <http://www.omg.org>. + +**Operations System (OS):** indicates a generic management system, independent of its location level within the management hierarchy. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----|----------------------------------------| +| CM | Configuration Management | +| CN | Core Network | +| EM | Element Manager | +| FM | Fault Management | +| GSM | Global System for Mobile communication | +| IMS | IP Multimedia Subsystem | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service (see [1]) | +| MIB | Management Information Base | +| MIM | Management Information Model | +| MOC | Managed Object Class | +| MOI | Managed Object Instance | +| NE | Network Element | +| NM | Network Manager | +| NR | Network Resource | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| OS | Operations System | + +| | | +|-----|----------------------------------| +| PM | Performance Management | +| TM | Telecom Management | +| UML | Unified Modelling Language (OMG) | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [1]. +- b) IRP-related requirements in 3GPP TS 32.102 [2]. +- c) IRP-related requirements in 3GPP TS 32.600 [3]. + +In addition to the above, the following more specific requirements apply: + +- 1) The Network Resource Model defined by this IRP shall contain CN specific IOCs and related definitions, supporting Core Network entities in the current 3GPP Release, except for the IMS parts of CN (for the IMS parts, refer to the IMS NRM IRP Requirements in 3GPP TS 28.704 [5]). +- 2) The Network Resource Model defined by this IRP shall provide support for enabling consistency between UTRAN/GERAN and CN parameters, e.g. by defining relevant attributes. + +The NRM defined by this IRP: + +- a) Shall support communications for telecommunication network management purposes, including management of converged networks. +- b) Is a member of the Federated Network Information Model (FNIM) [5] and its information is derived from FNIM Umbrella Information Model (UIM) [7]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140360 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-09 | SA#81 | SP-180830 | 0006 | - | F | Align terminology | 15.1.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28702/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/28_series/28702/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..341b60878469f04fc8735db4121a0ddde64b6833 --- /dev/null +++ b/marked/Rel-16/28_series/28702/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5fb3b7734f75edf5923fb4af4eebbe56ac5e045c1f3b7a43ddb3deebb906dc1 +size 84410 diff --git a/marked/Rel-16/28_series/28702/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/28_series/28702/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfee5ef8ea06cefd01c2e80214070e5c3677f25d --- /dev/null +++ b/marked/Rel-16/28_series/28702/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90af3bed01474e943ff90060a68b70b936cf56ef87f59f05a1382531fe8f925b +size 67531 diff --git a/marked/Rel-16/28_series/28702/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/marked/Rel-16/28_series/28702/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..388f123d82de155135fc75b25af5120b0231df5e --- /dev/null +++ b/marked/Rel-16/28_series/28702/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5837af3ce7feb11252b09bc41b75a85748d1fd4422b7fd10221e0b095b484dca +size 87357 diff --git a/marked/Rel-16/28_series/28702/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/28_series/28702/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..15dd8c7504bb5a316e4fa5ac79833d9080ed63b9 --- /dev/null +++ b/marked/Rel-16/28_series/28702/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f62617278feeb1f3d06ac03186f111a37fc2aba2fd1a8f11664182642d60d36e +size 48452 diff --git a/marked/Rel-16/28_series/28702/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/28_series/28702/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0dd896e244c9a0edf3b6a0cabe16afff30bc3287 --- /dev/null +++ b/marked/Rel-16/28_series/28702/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21ca5846ed07e6b30d0b4cac9a44943eb3afacc07e657a25da0355f4f1b938bd +size 59217 diff --git a/marked/Rel-16/28_series/28702/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/28_series/28702/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d6019d4ae5b57dafda9ed53455b2cd7b180a907 --- /dev/null +++ b/marked/Rel-16/28_series/28702/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:927622c7c733c3873a91b7f4878d74182baecfa3ef9907e1a9cf2cdfb455e5f0 +size 15092 diff --git a/marked/Rel-16/28_series/28702/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/28_series/28702/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..72ae448cd391018274de2d5e874481595922cc44 --- /dev/null +++ b/marked/Rel-16/28_series/28702/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f3c04a4b3e33454c5d9a732031e7366e7ef57cf04ff0ed56a2bd39f35f826766 +size 35425 diff --git a/marked/Rel-16/28_series/28702/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/28_series/28702/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e20a1301f8fa410a3d9958dfd23d5e2ac41f4e2b --- /dev/null +++ b/marked/Rel-16/28_series/28702/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:371a508e92a7515580f3b3275d7d3fc08b42990769fae7e79982af711c5c4d0f +size 37180 diff --git a/marked/Rel-16/28_series/28702/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/marked/Rel-16/28_series/28702/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b485108969f98fee4a4bbddf52123d74df9939a7 --- /dev/null +++ b/marked/Rel-16/28_series/28702/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b60096e089dd37568af81a9328810c4a0b05afd47e25ff970573481e30dbb858 +size 22504 diff --git a/marked/Rel-16/28_series/28702/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg b/marked/Rel-16/28_series/28702/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..273ecc393e5b8c4be6592ed7748504c14d01c195 --- /dev/null +++ b/marked/Rel-16/28_series/28702/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a22b25078937a8a955d618ed35b6c8f5b0d84e4e4c94a97aa5a1e72905669386 +size 87303 diff --git a/marked/Rel-16/28_series/28702/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/marked/Rel-16/28_series/28702/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e9aaa88113d0ed6841349bd2f33fc6a6db8a84c5 --- /dev/null +++ b/marked/Rel-16/28_series/28702/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f84c2e1e3a1c45f72ac6f1e8cdad32eaff918eed7b4682731fd64bd4343cfa73 +size 40780 diff --git a/marked/Rel-16/28_series/28702/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/28_series/28702/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2b40d9ad739f28dd21d230cb745fd5e4e95239cc --- /dev/null +++ b/marked/Rel-16/28_series/28702/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21cb9fbdfbc440c5e968d094b44371d4318a482688d153313e83c348f99d5b51 +size 67553 diff --git a/marked/Rel-16/28_series/28702/raw.md b/marked/Rel-16/28_series/28702/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..adff40c762f2f5de378fa9e115750867672bb69c --- /dev/null +++ b/marked/Rel-16/28_series/28702/raw.md @@ -0,0 +1,1737 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Model ..... | 11 | +| 4.1 Imported information entities and local labels..... | 11 | +| 4.2 Class diagram..... | 11 | +| 4.2.1 Relationships ..... | 11 | +| 4.2.2 Inheritance ..... | 15 | +| 4.3 Class definitions ..... | 18 | +| 4.3.1 MscServerFunction ..... | 18 | +| 4.3.1.1 Definitions ..... | 18 | +| 4.3.1.2 Attributes ..... | 18 | +| 4.3.1.3 Attribute constraints..... | 18 | +| 4.3.1.4 Notifications..... | 18 | +| 4.3.2 HlrFunction..... | 18 | +| 4.3.2.1 Definitions ..... | 18 | +| 4.3.2.2 Attributes ..... | 18 | +| 4.3.2.3 Attribute constraints..... | 18 | +| 4.3.2.4 Notifications..... | 18 | +| 4.3.3 VlrFunction..... | 19 | +| 4.3.3.1 Definitions ..... | 19 | +| 4.3.3.2 Attributes ..... | 19 | +| 4.3.3.3 Attribute constraints..... | 19 | +| 4.3.3.4 Notifications..... | 19 | +| 4.3.4 AucFunction..... | 19 | +| 4.3.4.1 Definitions ..... | 19 | +| 4.3.4.2 Attributes ..... | 19 | +| 4.3.4.3 Attribute constraints..... | 19 | +| 4.3.4.4 Notifications..... | 19 | +| 4.3.5 EirFunction..... | 19 | +| 4.3.5.1 Definitions ..... | 19 | +| 4.3.5.2 Attributes ..... | 19 | +| 4.3.5.3 Attribute constraints..... | 19 | +| 4.3.5.4 Notifications..... | 20 | +| 4.3.6 SmsIwmscFunction..... | 20 | +| 4.3.6.1 Definitions ..... | 20 | +| 4.3.6.2 Attributes ..... | 20 | +| 4.3.6.3 Attribute constraints..... | 20 | +| 4.3.6.4 Notifications..... | 20 | +| 4.3.7 SmsGmscFunction ..... | 20 | +| 4.3.7.1 Definitions ..... | 20 | +| 4.3.7.2 Attributes ..... | 20 | +| 4.3.7.3 Attribute constraints..... | 20 | +| 4.3.7.4 Notifications..... | 20 | +| 4.3.8 GmscFunction ..... | 20 | +| 4.3.8.1 Definitions ..... | 20 | +| 4.3.8.2 Attributes ..... | 20 | +| 4.3.8.3 Attribute constraints..... | 21 | +| 4.3.8.4 Notifications..... | 21 | +| 4.3.9 SgsnFunction ..... | 21 | +| 4.3.9.1 Definitions ..... | 21 | + +| | | | +|----------|----------------------------|----| +| 4.3.9.2 | Attributes ..... | 21 | +| 4.3.9.3 | Attribute constraints..... | 21 | +| 4.3.9.4 | Notifications..... | 21 | +| 4.3.10 | GgsnFunction ..... | 21 | +| 4.3.10.1 | Definitions ..... | 21 | +| 4.3.10.2 | Attributes ..... | 22 | +| 4.3.10.3 | Attribute constraints..... | 22 | +| 4.3.10.4 | Notifications..... | 22 | +| 4.3.11 | BgFunction ..... | 23 | +| 4.3.11.1 | Definitions ..... | 23 | +| 4.3.11.2 | Attributes ..... | 23 | +| 4.3.11.3 | Attribute constraints..... | 23 | +| 4.3.11.4 | Notifications..... | 23 | +| 4.3.12 | SmlcFunction ..... | 23 | +| 4.3.12.1 | Definitions ..... | 23 | +| 4.3.12.2 | Attributes ..... | 23 | +| 4.3.12.3 | Attribute constraints..... | 23 | +| 4.3.12.4 | Notifications..... | 23 | +| 4.3.13 | GmlcFunction ..... | 23 | +| 4.3.13.1 | Definitions ..... | 23 | +| 4.3.13.2 | Attributes ..... | 23 | +| 4.3.13.3 | Attribute constraints..... | 23 | +| 4.3.13.4 | Notifications..... | 23 | +| 4.3.14 | ScfFunction..... | 24 | +| 4.3.14.1 | Definitions ..... | 24 | +| 4.3.14.2 | Attributes ..... | 24 | +| 4.3.14.3 | Attribute constraints..... | 24 | +| 4.3.14.4 | Notifications..... | 24 | +| 4.3.15 | SrfFunction..... | 24 | +| 4.3.15.1 | Definitions ..... | 24 | +| 4.3.15.2 | Attributes ..... | 24 | +| 4.3.15.3 | Attribute constraints..... | 24 | +| 4.3.15.4 | Notifications..... | 24 | +| 4.3.16 | CbcFunction..... | 24 | +| 4.3.16.1 | Definitions ..... | 24 | +| 4.3.16.2 | Attributes ..... | 24 | +| 4.3.16.3 | Attribute constraints..... | 24 | +| 4.3.16.4 | Notifications..... | 24 | +| 4.3.17 | CgffFunction..... | 25 | +| 4.3.17.1 | Definitions ..... | 25 | +| 4.3.17.2 | Attributes ..... | 25 | +| 4.3.17.3 | Attribute constraints..... | 25 | +| 4.3.17.4 | Notifications..... | 25 | +| 4.3.18 | GmscServerFunction ..... | 25 | +| 4.3.18.1 | Definitions ..... | 25 | +| 4.3.18.2 | Attributes ..... | 25 | +| 4.3.18.3 | Attribute constraints..... | 25 | +| 4.3.18.4 | Notifications..... | 25 | +| 4.3.19 | IwfFunction..... | 25 | +| 4.3.19.1 | Definitions ..... | 25 | +| 4.3.19.2 | Attributes ..... | 25 | +| 4.3.19.3 | Attribute constraints..... | 25 | +| 4.3.19.4 | Notifications..... | 25 | +| 4.3.20 | MnpSrfFunction..... | 26 | +| 4.3.20.1 | Definitions ..... | 26 | +| 4.3.20.2 | Attributes ..... | 26 | +| 4.3.20.3 | Attribute constraints..... | 26 | +| 4.3.20.4 | Notifications..... | 26 | +| 4.3.21 | NpdbFunction ..... | 26 | +| 4.3.21.1 | Definitions ..... | 26 | +| 4.3.21.2 | Attributes ..... | 26 | + +| | | | +|----------|----------------------------|----| +| 4.3.21.3 | Attribute constraints..... | 26 | +| 4.3.21.4 | Notifications..... | 26 | +| 4.3.22 | SgwFunction..... | 26 | +| 4.3.22.1 | Definitions ..... | 26 | +| 4.3.22.2 | Attributes ..... | 26 | +| 4.3.22.3 | Attribute constraints..... | 26 | +| 4.3.22.4 | Notifications..... | 26 | +| 4.3.23 | SsfFunction..... | 27 | +| 4.3.23.1 | Definitions ..... | 27 | +| 4.3.23.2 | Attributes ..... | 27 | +| 4.3.23.3 | Attribute constraints..... | 27 | +| 4.3.23.4 | Notifications..... | 27 | +| 4.3.24 | BsFunction ..... | 27 | +| 4.3.24.1 | Definitions ..... | 27 | +| 4.3.24.2 | Attributes ..... | 27 | +| 4.3.24.3 | Attribute constraints..... | 27 | +| 4.3.24.4 | Notifications..... | 27 | +| 4.3.25 | IucsLink..... | 27 | +| 4.3.25.1 | Definitions ..... | 27 | +| 4.3.25.2 | Attributes ..... | 27 | +| 4.3.25.3 | Attribute constraints..... | 28 | +| 4.3.25.4 | Notifications..... | 28 | +| 4.3.26 | IupsLink..... | 28 | +| 4.3.26.1 | Definitions ..... | 28 | +| 4.3.26.2 | Attributes ..... | 28 | +| 4.3.26.3 | Attribute constraints..... | 28 | +| 4.3.26.4 | Notifications..... | 28 | +| 4.3.27 | IubcLink..... | 28 | +| 4.3.27.1 | Definitions ..... | 28 | +| 4.3.27.2 | Attributes ..... | 28 | +| 4.3.27.3 | Attribute constraints..... | 29 | +| 4.3.27.4 | Notifications..... | 29 | +| 4.3.28 | ALink..... | 29 | +| 4.3.28.1 | Definitions ..... | 29 | +| 4.3.28.2 | Attributes ..... | 29 | +| 4.3.28.3 | Attribute constraints..... | 29 | +| 4.3.28.4 | Notifications..... | 29 | +| 4.3.29 | GbLink..... | 29 | +| 4.3.29.1 | Definitions ..... | 29 | +| 4.3.29.2 | Attributes ..... | 29 | +| 4.3.29.3 | Attribute constraints..... | 29 | +| 4.3.29.4 | Notifications..... | 29 | +| 4.3.30 | CsMgwFunction..... | 29 | +| 4.3.30.1 | Definitions ..... | 29 | +| 4.3.30.2 | Attributes ..... | 30 | +| 4.3.30.3 | Attribute constraints..... | 30 | +| 4.3.30.4 | Notifications..... | 30 | +| 4.3.31 | BmScFunction ..... | 30 | +| 4.3.31.1 | Definitions ..... | 30 | +| 4.3.31.2 | Attributes ..... | 30 | +| 4.3.31.3 | Attribute constraints..... | 30 | +| 4.3.31.4 | Notifications..... | 30 | +| 4.3.32 | Link_BmSc_Ggsn..... | 30 | +| 4.3.32.1 | Definitions ..... | 30 | +| 4.3.32.2 | Attributes ..... | 30 | +| 4.3.32.3 | Attribute constraints..... | 30 | +| 4.3.32.4 | Notifications..... | 30 | +| 4.3.33 | Link_Ggsn_Sgsn..... | 31 | +| 4.3.33.1 | Definitions ..... | 31 | +| 4.3.33.2 | Attributes ..... | 31 | +| 4.3.33.3 | Attribute constraints..... | 31 | + +| | | | +|------------------------|----------------------------------|----| +| 4.3.33.4 | Notifications..... | 31 | +| 4.3.34 | CircuitEndPointSubgroup..... | 31 | +| 4.3.34.1 | Definitions ..... | 31 | +| 4.3.34.2 | Attributes ..... | 31 | +| 4.3.34.3 | Attribute constraints..... | 31 | +| 4.3.34.4 | Notifications..... | 31 | +| 4.3.35 | MscPool ..... | 31 | +| 4.3.35.1 | Definitions ..... | 31 | +| 4.3.35.2 | Attributes ..... | 31 | +| 4.3.35.3 | Attribute constraints..... | 31 | +| 4.3.35.4 | Notifications..... | 32 | +| 4.3.36 | MscPoolArea..... | 32 | +| 4.3.36.1 | Definitions ..... | 32 | +| 4.3.36.2 | Attributes ..... | 32 | +| 4.3.36.3 | Attribute constraints..... | 32 | +| 4.3.36.4 | Notifications..... | 32 | +| 4.3.37 | SgsnPool ..... | 32 | +| 4.3.37.1 | Definitions ..... | 32 | +| 4.3.37.2 | Attributes ..... | 32 | +| 4.3.37.3 | Attribute constraints..... | 32 | +| 4.3.37.4 | Notifications..... | 32 | +| 4.3.38 | SgsnPoolArea ..... | 33 | +| 4.3.38.1 | Definitions ..... | 33 | +| 4.3.38.2 | Attributes ..... | 33 | +| 4.3.38.3 | Attribute constraints..... | 33 | +| 4.3.38.4 | Notifications..... | 33 | +| 4.4 | Attribute definitions ..... | 34 | +| 4.4.1 | Attribute properties..... | 34 | +| 4.4.2 | Constraints..... | 37 | +| 4.5 | Common notifications ..... | 38 | +| 4.5.1 | Alarm notifications..... | 38 | +| 4.5.2 | Configuration notifications..... | 38 | +| Annex A (informative): | Change history..... | 39 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +28.701: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". + +**28.702: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".** + +28.703: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +Configuration Management (CM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. CM actions have the objective to control and monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. + +CM actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimization programme (e.g. modifications), and to maintain the overall Quality of Service (QoS). The CM actions are initiated either as single actions on single NEs of the 3G network, or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named "Core Network NRM IRP", through which an 'IRPAgent' (typically an Element Manager or Network Element) can communicate Configuration Management information to one or several 'IRPManagers' (typically Network Managers) concerning CN resources. + +The present document specifies the protocol neutral Core Network NRM IRP; Information Service. It reuses relevant parts of the generic NRM in 3GPP TS 28.622 [9], either by direct reuse or sub-classing, and in addition to that defines CN specific Information Object Classes. + +Finally, in order to access the information defined by this NRM, an Interface IRP is needed, such as the Basic CM IRP 3GPP TS 32.602 [10]. However, which Interface IRP that is applicable is outside the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point; Information Service (IS)".[4] ITU-T Recommendation X.710 (1991): "Common management information service definition for CCITT applications". +- [5] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point: Information Service (IS)". +- [6] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [7] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [8] 3GPP TS 23.002: "Network architecture". +- [9] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [10] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP); Information Service (IS)". +- [11] 3GPP TS 23.060: "General Packet Radio Service (GPRS) service description; Stage 2". +- [12] 3GPP TS 23.003: "Numbering, addressing and identification". +- [13] 3GPP TS 28.625: "Telecommunication Management; State Management Data Definition Integration Reference Point (IRP): Information Service (IS)". +- [14] 3GPP TS 28.652: "Telecommunication management; UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [15] 3GPP TS 28.655: "Telecommunication management; GERAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +- [16] ITU-T Rec. M.3100: "Generic Network Information Model" (7/95). +- [17] 3GPP TS 28.672: "Telecommunication management; Home Node B Subsystem (HNS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [18] 3GPP TS 23.236: "Technical Specification Group Services and System Aspects; Intra-domain connection of Radio Access Network (RAN) nodes to multiple Core Network (CN) nodes". +- [19] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM; Information service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.600 [7] and the following apply: + +**Association:** See definition in TS 28.622 [9]. + +**Managed Element (ME):** See definition in TS 28.622 [9]. + +**Managed Object (MO):** See definition in TS 28.622 [9]. + +**Management Information Model (MIM):** also referred to as NRM - see the definition below. + +**Network Resource Model (NRM):** See definition in TS 28.622 [9]. + +**Node B:** a logical node responsible for radio transmission/reception in one or more cells to/from the User Equipment +It terminates the Iub interface towards the RNC. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------------|--------------------------------------------------| +| AUC | AUthentication Centre | +| AS | Application Server | +| BG | Border Gateway | +| BGCF | Breakout Gateway Control Function | +| BS | Billing System | +| CBC | Cell Broadcast Center | +| CGF | Charging Gateway Functionality | +| CN | Core Network | +| DN | Distinguished Name (see 3GPP TS 32.300 [6]) | +| EIR | Equipment Identity Register | +| EM | Element Manager | +| FM | Fault Management | +| FNR | Flexible Number Register | +| GDMO | Guidelines for the Definition of Managed Objects | +| GGSN | Gateway GPRS Support Node | +| GMLC | Gateway Mobile Location Center | +| GSMSC Server | Gateway MSC Server | +| GSMSC | Gateway MSC | +| GPRS | General Packet Radio System | +| HNB GW | Home NodeB Gateway | +| ICSCF | Interrogating Call Session Control Function | +| IDL | Interface Definition Language | +| IMS | IP Multimedia Subsystem | +| IOC | Information Object Class | +| IRP | Integration Reference Point | + +| | | +|------------|------------------------------------------------------| +| ISO | International Standards Organization | +| IWF | InterWorking Function | +| ME | Managed Element | +| MGCF | Media Gateway Control Function | +| MGW | Media GateWay | +| MIM | Management Information Model | +| MNP-SRF | Mobile Number Portability-Signalling Relay Function | +| MO | Managed Object | +| MOI | Managed Object Instance | +| MRFC | Multimedia Resource Function Controller | +| MRFP | Call Session Control Function Processor | +| MSC Server | Mobile Services Switching Centre Server | +| MSC | Mobile Services Switching Centre | +| NE | Network Element | +| NM | Network Manager | +| NPDB | Number Portability DataBase | +| NR | Network Resource | +| NRM | Network Resource Model | +| OSI | Open Systems Interconnection | +| PCSCF | Proxy Call Session Control Function | +| PM | Performance Management | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [6]) | +| SCF | Service Control Function | +| SCSCF | Serving Call Session Control Function | +| SGSN | Serving GPRS Support Node | +| SGW | Signalling GateWay | +| SLF | Subscription Locator Function | +| SMLC | Serving Mobile Location Center | +| SMS | Short Message Service | +| SMS-GMSC | SMS Gateway MSC | +| SMS-IWMSC | SMS InterWorking MSC | +| SRF | Specialized Resource Function | +| SSF | Service Switching Function | +| TMN | Telecommunications Management Network | +| UML | Unified Modelling Language | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| VLR | Visitor Location Register | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|---------------------------------------------------------------|---------------------| +| TS 28.622 [9], information object class, Link | Link | +| TS 28.622 [9], information object class, ManagedElement | ManagedElement | +| TS 28.622 [9], information object class, ManagedFunction | ManagedFunction | +| TS 28.622 [9], information object class, VsDataContainer | VsDataContainer | +| TS 28.652 [14], information object class, RncFunction | RncFunction | +| TS 28.655 [15], information object class, BssFunction | BssFunction | +| TS 28.655 [15], information object class, ExternalBssFunction | ExternalBssFunction | +| TS 28.655 [15], information object class, ExternalGsmCell | ExternalGsmCell | +| TS 28.655 [15], information object class, GsmCell | GsmCell | +| TS 28.625 [13], attribute, proceduralStatus | proceduralStatus | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides an overview of the relationships between relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +![UML Class diagram showing relationships between ManagedElement and various InformationObjectClasses.](5e92d9e8e9ce204e405bff2367f88176_img.jpg) + +The diagram illustrates the containment and naming relationships between a central class and several peripheral classes. The central class is **<InformationObjectClass> ManagedElement (from 28.622)**. It is connected to 14 peripheral classes, each of type **<InformationObjectClass>**. The peripheral classes are: **HlrFunction**, **VlrFunction**, **AucFunction**, **EirFunction**, **SmfFunction**, **GmlFunction**, **SrfFunction**, **CbcFunction**, **MscServerFunction**, **SmsImscFunction**, **SmsGmscFunction**, **GmscFunction**, **SgsnFunction**, **GgsnFunction**, **BgFunction**, **ScfFunction**, and **RmScFunction**. The relationships are shown as lines with multiplicity markers and role names. The central class has a 1-to-many relationship with each peripheral class, where the peripheral class is the 'name' of the central class. The multiplicity at the peripheral class end is 0..1, and at the central class end is 1. The role name 'names' is used for these relationships. Additionally, the central class has a 1-to-many relationship with **MscServerFunction**, where the role name is 'names' and the multiplicity at the central class end is 1. + +UML Class diagram showing relationships between ManagedElement and various InformationObjectClasses. + +Figure 4.2.1.1: CN NRM Containment/Naming relationships 1 + +![UML Class Diagram showing ManagedElement and its containment relationships with various InformationObjectClass functions including SsFunction, NpdbFunction, GmscServerFunction, CsMgwFunction, MnpSrFunction, CgfFunction, SgwFunction, LwfFunction, and BsFunction.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + ManagedElement + (from 28.622) + } + class SsFunction { + <<InformationObjectClass>> + SsFunction + } + class NpdbFunction { + <<InformationObjectClass>> + NpdbFunction + } + class GmscServerFunction { + <<InformationObjectClass>> + GmscServerFunction + } + class CsMgwFunction { + <<InformationObjectClass>> + CsMgwFunction + } + class MnpSrFunction { + <<InformationObjectClass>> + MnpSrFunction + } + class CgfFunction { + <<InformationObjectClass>> + CgfFunction + } + class SgwFunction { + <<InformationObjectClass>> + SgwFunction + } + class LwfFunction { + <<InformationObjectClass>> + LwfFunction + } + class BsFunction { + <<InformationObjectClass>> + BsFunction + } + + ManagedElement "1" *-- "0..1" SsFunction : «names» + ManagedElement "1" *-- "1" NpdbFunction : «names» + ManagedElement "1" *-- "0..1" GmscServerFunction : «names» + ManagedElement "1" *-- "0..1" CsMgwFunction : «names» + ManagedElement "1" *-- "0..1" MnpSrFunction : «names» + ManagedElement "1" *-- "0..1" CgfFunction : «names» + ManagedElement "1" *-- "0..1" SgwFunction : «names» + ManagedElement "1" *-- "0..1" LwfFunction : «names» + ManagedElement "1" *-- "0..1" BsFunction : «names» + +``` + +UML Class Diagram showing ManagedElement and its containment relationships with various InformationObjectClass functions including SsFunction, NpdbFunction, GmscServerFunction, CsMgwFunction, MnpSrFunction, CgfFunction, SgwFunction, LwfFunction, and BsFunction. + +**Figure 4.2.1.2: CN NRM Containment/Naming relationships 2** + +![UML Class Diagram showing the containment and association relationships between ManagedElement, CsMgwFunction, MscServerFunction, SgsnFunction, CbcFunction, and various link/RNC functions.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + ManagedElement + (from 28.622) + } + class CsMgwFunction { + <<InformationObjectClass>> + CsMgwFunction + } + class MscServerFunction { + <<InformationObjectClass>> + MscServerFunction + } + class SgsnFunction { + <<InformationObjectClass>> + SgsnFunction + } + class CbcFunction { + <<InformationObjectClass>> + CbcFunction + } + class IuCsLink { + <<InformationObjectClass>> + IuCsLink + } + class IupsLink { + <<InformationObjectClass>> + IupsLink + } + class ExternalRNCFunction { + <<InformationObjectClass>> + ExternalRNCFunction + (from 28.652) + } + class RNCFunction { + <<InformationObjectClass>> + RNCFunction + } + class IubcLink { + <<InformationObjectClass>> + IubcLink + } + + ManagedElement "1" *-- "*" CsMgwFunction : «names» + ManagedElement "1" *-- "0..1" MscServerFunction : «names» + ManagedElement "1" *-- "*" SgsnFunction : «names» + ManagedElement "1" *-- "0..1" CbcFunction : «names» + + MscServerFunction "1" -- "*" CsMgwFunction : + mscServerFunction-csMgwFunction + CsMgwFunction "1" -- "*" MscServerFunction : + csMgwFunction-MscServerFunction + + CsMgwFunction "1" -- "*" IuCsLink : + csMgwFunction-IuCsLink + IuCsLink "*" -- "0..1" RNCFunction : + connectedRnc + + MscServerFunction "1" -- "*" IupsLink : «names» + SgsnFunction "1" -- "*" IupsLink : «names» + IupsLink "*" -- "0..1" RNCFunction : + connectedRnc + IupsLink "*" -- "0..1" ExternalRNCFunction : + connectedRnc + + CbcFunction "1" -- "*" IubcLink : «names» + IubcLink "*" -- "0..1" RNCFunction : + connectedRnc + IubcLink "*" -- "0..1" ExternalRNCFunction : + connectedRnc + +``` + +UML Class Diagram showing the containment and association relationships between ManagedElement, CsMgwFunction, MscServerFunction, SgsnFunction, CbcFunction, and various link/RNC functions. + +**NOTE:** The association between `MscServerFunction` and `CsMgwFunction` is optional and is only mandatory when they belong to different `ManagedElements`. + +**Figure 4.2.1.3: CN UTRAN NRM Containment/Naming and Association** + +![UML Class Diagram for CN GERAN NRM Containment/Naming and Association.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +Detailed description of Figure 4.2.1.4: The diagram illustrates the containment and association hierarchy for CN GERAN NRM. At the top, «InformationObjectClass» ManagedElement (from 28.622) acts as a container for «InformationObjectClass» CsMgwFunction, MscServerFunction, and SgsnFunction via «names» associations with multiplicity 1. +- CsMgwFunction is associated with Alink via +csMgwFunction-ALink (multiplicity 0..1 to \*). +- MscServerFunction is associated with GsmCell (from 28.655) via +mscServerFunction-GsmCell (multiplicity 1 to 0..1), ExternalGsmCell (from 28.655) via +mscServerFunction-ExternalGsmCell (multiplicity \* to \*), and BssFunction (from 28.655) via +connectedBss (multiplicity 0..1 to 0..1). +- SgsnFunction is associated with GsmCell via +sgsnFunction-GsmCell (multiplicity 1 to 0..1), ExternalGsmCell via +sgsnFunction-ExternalGsmCell (multiplicity \* to \*), and BssFunction via +connectedBss (multiplicity 0..1 to 0..1). +- Other link objects include IucsLink, GbLink, and IupsLink, which are associated with various functions and cells via +connectedBss associations with multiplicities like 0..1 and \*." + +UML Class Diagram for CN GERAN NRM Containment/Naming and Association. + +NOTE 1: The association between MscServerFunction and CsMgwFunction is optional and is only mandatory when they belong to different ManagedElements. + +NOTE 2: The association between MscServerFunction and GsmCell, and SgsnFunction and GsmCell are optional. It may be valid if both the MscServerFunction and GsmCell, or SgsnFunction and GsmCell are managed by the same management node. + +**Figure 4.2.1.4: CN GERAN NRM Containment/Naming and Association** + +Each IOC is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [6] that expresses its containment hierarchy. As an example, the DN of an IOC representing a cell could have a format like: + +SubNetwork=Sweden, MeContext =MEC-Gbg-1, ManagedElement =MSC-Gbg-1, MscServerFunction=MSC-1. + +![UML Class Diagram for CN MBMS NRM Containment/Naming and Association.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +Detailed description of Figure 4.2.1.5: This diagram shows the CN MBMS NRM. +- «InformationObjectClass» GgsnFunction and SgsnFunction are shown on the left, with GgsnFunction at the top. +- «InformationObjectClass» BmScFunction is on the right. +- «InformationObjectClass» Link\_Ggsn\_Sgsn is an association class between GgsnFunction and SgsnFunction, with a note pointing to 'Gn and Gp ref point'. +- «InformationObjectClass» Link\_BmSc\_Ggsn is an association class between BmScFunction and GgsnFunction, with a note pointing to 'Gmb and Gi ref point'. +- Multiplicities are indicated as '\*' for these associations." + +UML Class Diagram for CN MBMS NRM Containment/Naming and Association. + +**Figure 4.2.1.5: CN MBMS NRM Containment/Naming and Association** + +![UML Class Diagram showing containment and naming relationships between ManagedElement, MscServerFunction, CircuitEndPointSubgroup, and sDataContainer.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +This UML class diagram illustrates the relationships between four classes. At the top is **«InformationObjectClass» ManagedElement (from 28.622)**. Below it is **«InformationObjectClass» MscServerFunction**. Below that is **«InformationObjectClass» CircuitEndPointSubgroup**. At the bottom is **«sDataContainer (from 28.622)»**. The relationships are as follows: +1. **ManagedElement** has a composition relationship with **MscServerFunction**. The multiplicity at the **ManagedElement** end is 1, and at the **MscServerFunction** end is \*. The association is labeled «names». +2. **MscServerFunction** has a composition relationship with **CircuitEndPointSubgroup**. The multiplicity at the **MscServerFunction** end is 1, and at the **CircuitEndPointSubgroup** end is \*. The association is labeled «names». +3. **CircuitEndPointSubgroup** has a composition relationship with **sDataContainer**. The multiplicity at the **CircuitEndPointSubgroup** end is 1, and at the **sDataContainer** end is \*. The association is labeled «names». +4. **sDataContainer** has a self-composition relationship. The multiplicity at the composition end is 1, and at the self-association end is \*. The association is labeled «names». + +UML Class Diagram showing containment and naming relationships between ManagedElement, MscServerFunction, CircuitEndPointSubgroup, and sDataContainer. + +Figure 4.2.1.6: CN CircuitEndPointSubgroup related NRM Containment/Naming and Association + +![UML Class Diagram showing relationships between SubNetwork, MscPool, MscPoolArea, and MscServerFunction.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +This UML class diagram shows the relationships between four classes. At the top center is **«InformationObjectClass» SubNetwork (from 28.622)**. To its left is **«InformationObjectClass» MscPool**, and to its right is **«InformationObjectClass» MscPoolArea**. Below **MscPool** is **«InformationObjectClass» MscServerFunction**. The relationships are: +1. **SubNetwork** has a composition relationship with **MscPool**. Multiplicity 1 at **SubNetwork**, \* at **MscPool**. Association label «names». +2. **SubNetwork** has a composition relationship with **MscPoolArea**. Multiplicity 1 at **SubNetwork**, \* at **MscPoolArea**. Association label «names». +3. **MscPool** and **MscPoolArea** have a bidirectional association. Multiplicity 0..1 at both ends. Association labels: + mscPoolArea-MscPool + mscPool-MscPoolArea. +4. **MscPool** has a composition relationship with **MscServerFunction**. Multiplicity 0..1 at **MscPool**, \* at **MscServerFunction**. Association labels: + mscServerFunction-MscPool + mscPool-MscServerFunction. + +UML Class Diagram showing relationships between SubNetwork, MscPool, MscPoolArea, and MscServerFunction. + +Figure 4.2.1.7: CN MscPool related NRM Containment/Naming and Association + +![UML Class Diagram showing relationships between SubNetwork, SgsnPool, SgsnPoolArea, and SgsnFunction classes.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +classDiagram + class SubNetwork { + <<InformationObjectClass>> + SubNetwork (from 28.622) + } + class SgsnPool { + <<InformationObjectClass>> + SgsnPool + } + class SgsnPoolArea { + <<InformationObjectClass>> + SgsnPoolArea + } + class SgsnFunction { + <<InformationObjectClass>> + SgsnFunction + } + + SubNetwork "1" *-- "*" SgsnPool : + sgsnPoolArea-SgsnPool + SubNetwork "1" *-- "*" SgsnPoolArea : + sgsnPool-SgsnPoolArea + SgsnPool "0.1" -- "0.1" SgsnPoolArea + SgsnPool "0.1" -- "*" SgsnFunction : + sgsnFunction-SgsnPool + SgsnFunction "*" -- "0.1" SgsnPool : + sgsnPool-SgsnFunction + +``` + +UML Class Diagram showing relationships between SubNetwork, SgsnPool, SgsnPoolArea, and SgsnFunction classes. + +Figure 4.2.1.8: CN SgsnPool related NRM Containment/Naming and Association + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +The figures below show the inheritance hierarchy for the CN NRM. + +![UML Class Diagram showing the inheritance hierarchy for ManagedFunction.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` + +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction (from 28.622) + } + class BmScFunction { + <<InformationObjectClass>> + BmScFunction + } + class McServerFunction { + <<InformationObjectClass>> + McServerFunction + } + class HlrFunction { + <<InformationObjectClass>> + HlrFunction + } + class VlrFunction { + <<InformationObjectClass>> + VlrFunction + } + class AucFunction { + <<InformationObjectClass>> + AucFunction + } + class EirFunction { + <<InformationObjectClass>> + EirFunction + } + class SmfFunction { + <<InformationObjectClass>> + SmfFunction + } + class GmlFunction { + <<InformationObjectClass>> + GmlFunction + } + class SrfFunction { + <<InformationObjectClass>> + SrfFunction + } + class MscPool { + <<InformationObjectClass>> + MscPool + } + class MscPoolArea { + <<InformationObjectClass>> + MscPoolArea + } + class SmIwmScFunction { + <<InformationObjectClass>> + SmIwmScFunction + } + class SmGmScFunction { + <<InformationObjectClass>> + SmGmScFunction + } + class GmScFunction { + <<InformationObjectClass>> + GmScFunction + } + class SgsnFunction { + <<InformationObjectClass>> + SgsnFunction + } + class GgsnFunction { + <<InformationObjectClass>> + GgsnFunction + } + class BgFunction { + <<InformationObjectClass>> + BgFunction + } + class ScfFunction { + <<InformationObjectClass>> + ScfFunction + } + class CbcFunction { + <<InformationObjectClass>> + CbcFunction + } + class SgsnPool { + <<InformationObjectClass>> + SgsnPool + } + class SgsnPoolArea { + <<InformationObjectClass>> + SgsnPoolArea + } + + ManagedFunction <|-- BmScFunction + ManagedFunction <|-- McServerFunction + ManagedFunction <|-- HlrFunction + ManagedFunction <|-- VlrFunction + ManagedFunction <|-- AucFunction + ManagedFunction <|-- EirFunction + ManagedFunction <|-- SmfFunction + ManagedFunction <|-- GmlFunction + ManagedFunction <|-- SrfFunction + ManagedFunction <|-- MscPool + ManagedFunction <|-- MscPoolArea + ManagedFunction <|-- SmIwmScFunction + ManagedFunction <|-- SmGmScFunction + ManagedFunction <|-- GmScFunction + ManagedFunction <|-- SgsnFunction + ManagedFunction <|-- GgsnFunction + ManagedFunction <|-- BgFunction + ManagedFunction <|-- ScfFunction + ManagedFunction <|-- CbcFunction + ManagedFunction <|-- SgsnPool + ManagedFunction <|-- SgsnPoolArea + +``` + +UML Class Diagram showing the inheritance hierarchy for ManagedFunction. + +Figure 4.2.2.1: CN NRM Inheritance Hierarchy 1 + +![UML Class Diagram showing inheritance hierarchy for ManagedFunction. The base class is <<InformationObjectClass>> ManagedFunction (from 28.622). It is inherited by NpdbFunction, SsfFunction, CgfFunction, GbLink, ALink, CsMgwFunction, IubcLink, GmscServerFunction, MnpSrFunction, BsFunction, IucsLink, IupsLink, SgwFunction, and LwfFunction.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +classDiagram + class ManagedFunction["«InformationObjectClass»\nManagedFunction\n(from 28.622)"] + class NpdbFunction["«InformationObjectClass»\nNpdbFunction"] + class SsfFunction["«InformationObjectClass»\nSsfFunction"] + class CgfFunction["«InformationObjectClass»\nCgfFunction"] + class GbLink["«InformationObjectClass»\nGbLink"] + class ALink["«InformationObjectClass»\nALink"] + class CsMgwFunction["«InformationObjectClass»\nCsMgwFunction"] + class IubcLink["«InformationObjectClass»\nIubcLink"] + class GmscServerFunction["«InformationObjectClass»\nGmscServerFunction"] + class MnpSrFunction["«InformationObjectClass»\nMnpSrFunction"] + class BsFunction["«InformationObjectClass»\nBsFunction"] + class IucsLink["«InformationObjectClass»\nIucsLink"] + class IupsLink["«InformationObjectClass»\nIupsLink"] + class SgwFunction["«InformationObjectClass»\nSgwFunction"] + class LwfFunction["«InformationObjectClass»\nLwfFunction"] + + ManagedFunction <|-- NpdbFunction + ManagedFunction <|-- SsfFunction + ManagedFunction <|-- CgfFunction + ManagedFunction <|-- GbLink + ManagedFunction <|-- ALink + ManagedFunction <|-- CsMgwFunction + ManagedFunction <|-- IubcLink + ManagedFunction <|-- GmscServerFunction + ManagedFunction <|-- MnpSrFunction + ManagedFunction <|-- BsFunction + ManagedFunction <|-- IucsLink + ManagedFunction <|-- IupsLink + ManagedFunction <|-- SgwFunction + ManagedFunction <|-- LwfFunction +``` + +UML Class Diagram showing inheritance hierarchy for ManagedFunction. The base class is <> ManagedFunction (from 28.622). It is inherited by NpdbFunction, SsfFunction, CgfFunction, GbLink, ALink, CsMgwFunction, IubcLink, GmscServerFunction, MnpSrFunction, BsFunction, IucsLink, IupsLink, SgwFunction, and LwfFunction. + +Figure 4.2.2.2: CN NRM Inheritance Hierarchy 2 + +![UML Class Diagram showing inheritance hierarchy for Link. The base class is <<InformationObjectClass>> Link (from 28.622). It is inherited by Link_Ggsn_Sgsn and Link_BmSc_Ggsn.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` +classDiagram + class Link["«InformationObjectClass»\nLink\n(from 28.622)"] + class Link_Ggsn_Sgsn["«InformationObjectClass»\nLink_Ggsn_Sgsn"] + class Link_BmSc_Ggsn["«InformationObjectClass»\nLink_BmSc_Ggsn"] + + Link <|-- Link_Ggsn_Sgsn + Link <|-- Link_BmSc_Ggsn +``` + +UML Class Diagram showing inheritance hierarchy for Link. The base class is <> Link (from 28.622). It is inherited by Link\_Ggsn\_Sgsn and Link\_BmSc\_Ggsn. + +Figure 4.2.2.3: CN NRM Inheritance Hierarchy 3 + +![UML class diagram showing inheritance hierarchy. Top class: «InformationObjectClass» Top (from 28.622). Subclass: «InformationObjectClass» CircuitEndPointSubgroup. Inheritance arrow points from subclass to superclass.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` +classDiagram + class Top["«InformationObjectClass» Top (from 28.622)"] + class CircuitEndPointSubgroup["«InformationObjectClass» CircuitEndPointSubgroup"] + CircuitEndPointSubgroup --|> Top +``` + +UML class diagram showing inheritance hierarchy. Top class: «InformationObjectClass» Top (from 28.622). Subclass: «InformationObjectClass» CircuitEndPointSubgroup. Inheritance arrow points from subclass to superclass. + +Figure 4.2.2.4: CN NRM Inheritance Hierarchy 4 + +## 4.3 Class definitions + +### 4.3.1 MscServerFunction + +#### 4.3.1.1 Definitions + +This IOC represents MSCserver functionality. For more information about the MSC, see 3GPP TS 23.002 [8]. + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------|-------------------|------------|------------|-------------|--------------| +| mcList | M | M | M | - | M | +| mncList | M | M | M | - | M | +| lacList | M | M | M | - | M | +| sacList | M | M | M | - | M | +| gcaList | O | M | M | - | M | +| mscId | M | M | M | - | M | +| nriList | M | M | - | - | M | +| defaultMsc | O | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| mscServerFunction-GsmCell | M | M | - | - | M | +| mscServerFunction-ExternalGsmCell | M | M | - | - | M | +| mscServerFunction-CsMgwFunction | M | M | - | - | M | +| mscServerFunction-MscPool | O | M | - | - | M | + +#### 4.3.1.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.2 HlrFunction + +#### 4.3.2.1 Definitions + +This IOC represents HLR functionality. For more information about the HLR, see 3GPP TS 23.002 [8]. + +#### 4.3.2.2 Attributes + +None. + +#### 4.3.2.3 Attribute constraints + +None. + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 VlrFunction + +#### 4.3.3.1 Definitions + +This IOC represents VLR functionality. For more information about the VLR, see 3GPP TS 23.002 [8]. + +#### 4.3.3.2 Attributes + +None. + +#### 4.3.3.3 Attribute constraints + +None. + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.4 AucFunction + +#### 4.3.4.1 Definitions + +This IOC represents AUC functionality. For more information about the AUC, see 3GPP TS 23.002 [8]. + +#### 4.3.4.2 Attributes + +None. + +#### 4.3.4.3 Attribute constraints + +None. + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.5 EirFunction + +#### 4.3.5.1 Definitions + +This IOC represents EIR functionality. For more information about the EIR, see 3GPP TS 23.002 [8]. + +#### 4.3.5.2 Attributes + +None. + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.6 SmsIwmscFunction + +#### 4.3.6.1 Definitions + +This IOC represents SMS-IWMSC functionality. For more information about the SMS-IWMSC, see 3GPP TS 23.002 [8]. + +#### 4.3.6.2 Attributes + +None. + +#### 4.3.6.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.7 SmsGmscFunction + +#### 4.3.7.1 Definitions + +This IOC represents SMS-GMSC functionality. For more information about the SMS-GMSC, see 3GPP TS 23.002 [8]. + +#### 4.3.7.2 Attributes + +None. + +#### 4.3.7.3 Attribute constraints + +None. + +#### 4.3.7.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.8 GmscFunction + +#### 4.3.8.1 Definitions + +This IOC represents GMSC functionality. For more information about the GMSC, see 3GPP TS 23.002 [8]. + +#### 4.3.8.2 Attributes + +None. + +#### 4.3.8.3 Attribute constraints + +None. + +#### 4.3.8.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.9 SgsnFunction + +#### 4.3.9.1 Definitions + +This IOC represents SGSN functionality. For more information about the SGSN, see 3GPP TS 23.002 [8]. + +#### 4.3.9.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|----------------| +| mccList | M | M | M | - | M | +| mncList | M | M | M | - | M | +| lacList | M | M | M | - | M | +| racList | M | M | M | - | M | +| sacList | M | M | M | - | M | +| sgsnId | M | M | M | - | M | +| proceduralStatus<br>(see Note 1) | O | - | - | - | M (see Note 2) | +| nriList | M | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| sgsnFunction-GsmCell | M | M | - | - | M | +| sgsnFunction-ExternalGsmCell | M | M | - | - | M | +| sgsnFunction-SgsnPool | O | M | - | - | M | + +Note 1: No state propagation shall be implied. +Note 2: The attribute value change is conveyed by the `notifyStateChange` notification. + +#### 4.3.9.3 Attribute constraints + +None. + +#### 4.3.9.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC. In addition, the following set of notification, defined in 3GPP TS 32.662 [19], is also valid. + +| Name | Qualifier | Notes | +|--------------------------------|-----------|-------| +| <code>notifyStateChange</code> | O | | + +### 4.3.10 GgsnFunction + +#### 4.3.10.1 Definitions + +This IOC represents GGSN functionality. For more information about the GGSN, see 3GPP TS 23.002 [8]. + +#### 4.3.10.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|----------------| +| proceduralStatus<br>(see Note 1) | O | - | - | - | M (see Note 2) | + +Note 1: No state propagation shall be implied. +Note 2: The attribute value change is conveyed by the `notifyStateChange` notification. + +#### 4.3.10.3 Attribute constraints + +None. + +#### 4.3.10.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC. In addition, the following set of notification, defined in 3GPP TS 32.662 [19], is also valid. + +| Name | Qualifier | Notes | +|-------------------|-----------|-------| +| notifyStateChange | O | | + +### 4.3.11 BgFunction + +#### 4.3.11.1 Definitions + +This IOC represents BG functionality. For more information about the BG, see 3GPP TS 23.002 [8]. + +#### 4.3.11.2 Attributes + +None. + +#### 4.3.11.3 Attribute constraints + +None. + +#### 4.3.11.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.12 SmlcFunction + +#### 4.3.12.1 Definitions + +This IOC represents SMLC functionality. For more information about the SMLC, see 3GPP TS 23.002 [8]. + +#### 4.3.12.2 Attributes + +None. + +#### 4.3.12.3 Attribute constraints + +None. + +#### 4.3.12.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.13 GmlcFunction + +#### 4.3.13.1 Definitions + +This IOC represents GMLC functionality. For more information about the GMLC, see 3GPP TS 23.002 [8]. + +#### 4.3.13.2 Attributes + +None. + +#### 4.3.13.3 Attribute constraints + +None. + +#### 4.3.13.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.14 ScfFunction + +#### 4.3.14.1 Definitions + +This IOC represents SCF functionality (also referred to as gsmSCF). For more information about the SCF, see 3GPP TS 23.002 [8]. + +#### 4.3.14.2 Attributes + +None. + +#### 4.3.14.3 Attribute constraints + +None. + +#### 4.3.14.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.15 SrfFunction + +#### 4.3.15.1 Definitions + +This IOC represents SRF functionality (also referred to as gsmSRF). For more information about the SRF, see 3GPP TS 23.002 [8]. + +#### 4.3.15.2 Attributes + +None. + +#### 4.3.15.3 Attribute constraints + +None. + +#### 4.3.15.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.16 CbcFunction + +#### 4.3.16.1 Definitions + +This IOC represents CBC functionality. For more information about the CBC, see 3GPP TS 23.002 [8]. + +#### 4.3.16.2 Attributes + +None. + +#### 4.3.16.3 Attribute constraints + +None. + +#### 4.3.16.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.17 CgfFunction + +#### 4.3.17.1 Definitions + +This IOC represents CGF functionality. For more information about the CGF, see 3GPP TS 23.060 [11]. + +#### 4.3.17.2 Attributes + +None. + +#### 4.3.17.3 Attribute constraints + +None. + +#### 4.3.17.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.18 GmscServerFunction + +#### 4.3.18.1 Definitions + +This IOC represents GMSCServer functionality. For more information about GMSCServer, see 3GPP TS 23.002 [8]. + +#### 4.3.18.2 Attributes + +None. + +#### 4.3.18.3 Attribute constraints + +None. + +#### 4.3.18.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.19 IwfFunction + +#### 4.3.19.1 Definitions + +This IOC represents IWF functionality. For more information about IWF, see 3GPP TS 23.002 [8]. + +#### 4.3.19.2 Attributes + +None. + +#### 4.3.19.3 Attribute constraints + +None. + +#### 4.3.19.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.20 MnpSrfFunction + +#### 4.3.20.1 Definitions + +This IOC represents MNP-SRF functionality (also known as FNR). For more information about MNP-SRF, see 3GPP TS 23.002 [8]. + +#### 4.3.20.2 Attributes + +None. + +#### 4.3.20.3 Attribute constraints + +None. + +#### 4.3.20.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.21 NpdbFunction + +#### 4.3.21.1 Definitions + +This IOC represents NPDB functionality. For more information about NPDB, see 3GPP TS 23.002 [8]. + +#### 4.3.21.2 Attributes + +None. + +#### 4.3.21.3 Attribute constraints + +None. + +#### 4.3.21.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.22 SgwFunction + +#### 4.3.22.1 Definitions + +This IOC represents SGW functionality. For more information about SGW, see 3GPP TS 23.002 [8]. + +#### 4.3.22.2 Attributes + +None. + +#### 4.3.22.3 Attribute constraints + +None. + +#### 4.3.22.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.23 SsfFunction + +#### 4.3.23.1 Definitions + +This IOC represents SSF functionality. For more information about SSF, see 3GPP TS 23.002 [8]. + +#### 4.3.23.2 Attributes + +None. + +#### 4.3.23.3 Attribute constraints + +None. + +#### 4.3.23.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.24 BsFunction + +#### 4.3.24.1 Definitions + +This IOC represents BS functionality. For more information about BS, see 3GPP TS 23.060 [11]. + +#### 4.3.24.2 Attributes + +None. + +#### 4.3.24.3 Attribute constraints + +None. + +#### 4.3.24.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.25 IucsLink + +#### 4.3.25.1 Definitions + +This IOC represents an Iu-cs interface link connecting an MSCserver to the RNC, BSC and HNB GW. For more information about the Iu interface, see 3GPP TS 23.002 [8]. + +#### 4.3.25.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| connectedRnc | O | M | - | - | M | +| connectedBss | O | M | - | - | M | +| connectedHNBGW | O | M | - | - | M | + +#### 4.3.25.3 Attribute constraints + +| Name | Definition | +|----------------|-------------------------------------------------------------------------------------------------| +| connectedRnc | shall be supported when the iucs interface is between the MSCServer node and an RNC node | +| connectedBss | shall be supported when the iucs interface is between the MSCServer node and a BSC node | +| connectedHNBGW | shall be supported when the iucs interface is between the MSCServer node and a HNB GW node [17] | + +Note: The attributes connectedRnc, connectedBss and connectedHNBGW are mutually exclusive. + +#### 4.3.25.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.26 IupsLink + +#### 4.3.26.1 Definitions + +This IOC represents an Iu-ps interface link connecting a SGSN to the RNC, BSC and HNB GW. For more information about the Iu interface, see 3GPP TS 23.002 [8]. + +#### 4.3.26.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| connectedRnc | O | M | - | - | M | +| connectedBss | O | M | - | - | M | +| connectedHNBGW | O | M | - | - | M | + +#### 4.3.26.3 Attribute constraints + +| Name | Definition | +|----------------|--------------------------------------------------------------------------------------------| +| connectedRnc | shall be supported when the iups interface is between the SGSN node and an RNC node | +| connectedBss | shall be supported when the iups interface is between the SGSN node and a BSC node | +| connectedHNBGW | shall be supported when the iups interface is between the SGSN node and a HNB GW node [17] | + +Note: The attributes connectedRnc, connectedBss and connectedHNBGW are mutually exclusive. + +#### 4.3.26.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.27 IubcLink + +#### 4.3.27.1 Definitions + +This IOC represents an Iu-bc interface link connecting a CBC to the RNC and HNB GW. For more information about the Iu interface, see 3GPP TS 23.002 [8]. + +#### 4.3.27.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| connectedRnc | O | M | - | - | M | +| connectedHNBGW | O | M | - | - | M | + +#### 4.3.27.3 Attribute constraints + +None. + +#### 4.3.27.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.28 ALink + +#### 4.3.28.1 Definitions + +This IOC represents the A interface link connecting a MSC to the GERAN. For more information about the GERAN, see 3GPP TS 23.002 [8]. + +#### 4.3.28.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| connectedBss | O | M | - | - | M | + +#### 4.3.28.3 Attribute constraints + +None. + +#### 4.3.28.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.29 GbLink + +#### 4.3.29.1 Definitions + +This IOC represents the Gb interface link connecting a SGSN to the GERAN. For more information about the GERAN, see 3GPP TS 23.002 [8]. + +#### 4.3.29.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| connectedBss | O | M | - | - | M | + +#### 4.3.29.3 Attribute constraints + +None. + +#### 4.3.29.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.30 CsMgwFunction + +#### 4.3.30.1 Definitions + +This IOC represents CS-MGW functionality. For more information about CS-MGW, see 3GPP TS 23.002 [8]. + +#### 4.3.30.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------------|-------------------|------------|------------|-------------|--------------| +| Attribute related to role | | | | | | +| csMgwFunction-MscServerFunction | M | M | - | - | M | +| csMgwFunction-IucsLink | M | M | - | - | M | +| csMgwFunction-ALink | M | M | - | - | M | + +#### 4.3.30.3 Attribute constraints + +None. + +#### 4.3.30.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.31 BmScFunction + +#### 4.3.31.1 Definitions + +This IOC represents BM-SC functionality. For more information about BM-SC see 3GPP TS 23.002 [8]. + +#### 4.3.31.2 Attributes + +None. + +#### 4.3.31.3 Attribute constraints + +None. + +#### 4.3.31.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.32 Link\_BmSc\_Ggsn + +#### 4.3.32.1 Definitions + +This IOC models the Gmb and Gi reference points as defined in TS 23.002 [8]. + +#### 4.3.32.2 Attributes + +None. + +#### 4.3.32.3 Attribute constraints + +None. + +#### 4.3.32.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.33 Link\_Ggsn\_Sgsn + +#### 4.3.33.1 Definitions + +This IOC models the Gn and Gp reference points as defined in TS 23.002 [8]. + +#### 4.3.33.2 Attributes + +None. + +#### 4.3.33.3 Attribute constraints + +None. + +#### 4.3.33.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.34 CircuitEndPointSubgroup + +#### 4.3.34.1 Definitions + +This IOC represents the Circuit End Point Subgroup, relating to definitions in ITU-T M.3100 (see [16]). A Circuit End Point Subgroup is a set of circuit end points that directly interconnect one network element with another (e.g. MSC, BSC). It is derived from Top. + +#### 4.3.34.2 Attributes + +None. + +#### 4.3.34.3 Attribute constraints + +None. + +#### 4.3.34.4 Notifications + +This IOC would not emit notification. + +### 4.3.35 MscPool + +#### 4.3.35.1 Definitions + +This IOC represents the MSC server pool. For more information about the MSC server pool, see 3GPP TS 23.002 [8] + +#### 4.3.35.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| Attribute related to role | | | | | | +| mscPool-MscServerFunction | M | M | - | - | M | +| mscPool-MscPoolArea | M | M | - | - | M | + +#### 4.3.35.3 Attribute constraints + +None. + +#### 4.3.35.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.36 MscPoolArea + +#### 4.3.36.1 Definitions + +concepts related to MSC Pool Area are: + +- An MSC Pool Area is defined as an area within which an UE may be served without the need to change the serving MSC. It is a collection of complete Location Areas (LAs). +- A particular LA can be a member of one or more MSC Pool Areas. In the latter case, the MSC Pool Areas involved are called "overlapping MSC Pool Areas". + +#### 4.3.36.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| lacList | M | M | - | - | M | +| pLMNIdList | O | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| mscPoolArea-MscPool | M | M | - | - | M | + +#### 4.3.36.3 Attribute constraints + +None. + +#### 4.3.36.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.37 SgsnPool + +#### 4.3.37.1 Definitions + +This IOC represents the SGSN pool. For more information about the SGSN pool, see 3GPP TS 23.002 [8] + +#### 4.3.37.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| sgsnPool-SgsnFunction | M | M | - | - | M | +| sgsnPool-SgsnPoolArea | M | M | - | - | M | + +#### 4.3.37.3 Attribute constraints + +None. + +#### 4.3.37.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.38 SgsnPoolArea + +#### 4.3.38.1 Definitions + +This IOC represents SGSN Pool Area. For more information about the SGSN Pool Area, see 3GPP TS 23.002 [8]. Key concept related to SGSN Pool Area is: + +An SGSN Pool Area is defined as an area within which an UE may be served without the need to change the serving SGSN. It is a collection of complete Routing Areas (RAs). + +#### 4.3.38.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| racList | M | M | - | - | M | +| pLMNIdList | O | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| sgsnPoolArea-SgsnPool | M | M | - | - | M | + +#### 4.3.38.3 Attribute constraints + +None. + +#### 4.3.38.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute + +### definitions + +### 4.4.1 Attribute properties + +The following table defines the properties of attributes that are specified in the present document. + +**Table 4.4.1: Attributes** + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| defaultMsc | Whether this MSC Server is default CN node in MscPool or not (Ref. 3GPP TS 23.236 [18]).<br>A value of 0 represents that this MSC Server is not default CN node and a value of 1 represents that it is default CN node.<br><br>allowedValues: 0..1 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| gcaList | List of Group Call Area (Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| lacList | List of Location Area Codes (Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| mccList | List of Mobile Country Codes, MCC (part of the PLMN Id, Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| mncList | List of Mobile Network Codes, MNC (part of the PLMN Id, Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| mscId | Unique MSC ID (Ref. 3GPP TS 23.002 [8]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| nriList | NRI shall be part of the TMSI. The NRI has a configurable length of 0 to 10 bits. (Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| plmnIdList | It is a list of PLMN-Id, PLMN-Id= Mobile Country Codes (MCC) Mobile Network Codes(MNC) (Ref. 3GPP TS 23.003[12])<br><br>The MscPoolArea.plmnIdList purpose is to identify the PLMNs (related to MscFunction) the Msc Pool is serving.<br><br>The MscEunction.plmnIdList purpose is as following. One operator may have several PLMN Ids and accordingly RAN broadcasts these Ids to enable UEs of different PLMN (i.e, UEs with different MNC in their IMSIs) to access its network. If CN node does not know this PLMN list, UEs of different PLMN than the one combined in Msc might be treated as UEs from other operators. This will affect Location Update and Inter-Msc handover procedures, and also the changing rate.<br><br>allowedValues: A list of at most six entries of PLMN Identifiers. The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC). | type: Integer<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: True | +| proceduralStatus | See definition in 3GPP TS 28.625 [13] (State Management Data Definition IRP IS).<br><br>There are two cases resulting in a status change to be reported: <ul style="list-style-type: none"> <li>Case 1: A notification may be generated to indicate that restart procedure is about to begin or has just begun but has not finished. - the value for this attribute indicates original state == "Not Initialized" and new state == "Initializing".</li> <li>Case 2: A notification shall be generated to indicate that a restart procedure has completed successfully - the value for this attribute indicates original state == "Initializing" to new state == NULL (see [13]).</li> </ul> | See 3GPP TS 28.625 [13]. | + +| <b>Attribute Name</b> | <b>Documentation and Allowed Values</b> | <b>Properties</b> | +|------------------------------------------------|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| <code>racList</code> | List of Routeing Area Codes covered by MSC (Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <code>sacList</code> | List of Service Area Codes covered by MSC (Ref. 3GPP TS 23.003 [12]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: True | +| <code>sgsnId</code> | Unique SGSN ID (Ref. 3GPP TS 23.002 [8]).<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <b>Attribute related to role</b> | | | +| <code>mscServerFunction-GsmCell</code> | This holds a set of DNs of <code>GSMCell</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>gsmCell-MscServerFunction</code> | This holds the DN of an <code>MscServerFunction</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>mscServerFunction-ExternalGsmCell</code> | This holds a set of DNs of <code>ExternalGsmCell</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>externalGsmCell-MscServerFunction</code> | This holds the DN of an <code>MscServerFunction</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>mscServerFunction-CsMgwFunction</code> | This holds a set of DNs of <code>CsMgwFunction</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>csMgwFunction-MscServerFunction</code> | This holds the DN of an <code>MscServerFunction</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>sgsnFunction-GsmCell</code> | This holds a set of DNs of <code>GSMCell</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>gsmCell-SgsnFunction</code> | This holds the DN of an <code>SgsnFunction</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>sgsnFunction-ExternalGsmCell</code> | This holds a set of DNs of <code>ExternalGsmCell</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <code>externalGsmCell-SgsnFunction</code> | This holds the DN of an <code>SgsnFunction</code> .<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|---------------------------|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| csMgwFunction-IucsLink | This holds a set of DNs of IucsLink.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| connectedRnc | This holds the DN of an RncFunction or an ExternalRncFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| csMgwFunction-ALink | This holds a set of DNs of ALink.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| connectedBss | This holds the DN of an BssFunction or an ExternalBssFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mscPool-MscServerFunction | This holds a set of DNs of MscServerFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mscServerFunction-MscPool | This holds a set of DNs of MscPool.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mscPool-MscPoolArea | This holds the DN of an MscPoolArea.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mscPoolArea-MscPool | This holds the DN of an MscPool.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sgsnPool-SgsnFunction | This holds the DN of an SgsnFunction.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sgsnFunction-SgsnPool | This holds the DN of an SgsnPool.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sgsnPool-SgsnPoolArea | This holds the DN of an SgsnPoolArea.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sgsnPoolArea-SgsnPool | This holds the DN of an SgsnPool.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This clause presents a list of notifications, defined in [5], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [3], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|--------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [5]) | | + +### 4.5.2 Configuration notifications + +This clause presents a list of notifications, defined in [19], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [3], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------------------------------------|-------| +| notifyAttributeValueChange | See Kernel CM IRP (3GPP TS 32.662 [19]) | | +| notifyObjectCreation | See Kernel CM IRP (3GPP TS 32.662 [19]) | | +| notifyObjectDeletion | See Kernel CM IRP (3GPP TS 32.662 [19]) | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------|-----|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2013-03 | SA#63 | SP-140031 | 002 | 1 | Correction of reference and attribute properties | F | 11.0.0 | 11.1.0 | +| 2014-06 | SA#64 | SP-140360 | 003 | - | remove the feature support statements | F | 11.1.0 | 11.2.0 | +| 2014-09 | SA#65 | SP-140558 | 004 | - | Correction of proceduralStatus attribute definitions | F | 11.2.0 | 11.3.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.3.0 | 12.0.0 | +| 2014-12 | SA#66 | SP-140797 | 006 | 2 | Correct proceduralStatus definition | A | 12.0.0 | 12.1.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.1.0 | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | 14.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28703/raw.md b/marked/Rel-16/28_series/28703/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..46bead43f1f41579710c5331feadb4f6abeb0ad3 --- /dev/null +++ b/marked/Rel-16/28_series/28703/raw.md @@ -0,0 +1,2190 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------|----------| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 Solution Set definitions ..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.2 Rules for NRM extensions ..... | 8 | +| A.2 Mapping ..... | 8 | +| A.2.1 General mappings..... | 8 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC MscServerFunction..... | 9 | +| A.2.2.2 IOC HlrFunction..... | 9 | +| A.2.2.3 IOC VlrFunction..... | 9 | +| A.2.2.4 IOC AucFunction ..... | 9 | +| A.2.2.5 IOC EirFunction ..... | 10 | +| A.2.2.6 IOC SmsIwmseFunction ..... | 10 | +| A.2.2.7 IOC SmsGmsecFunction ..... | 10 | +| A.2.2.8 IOC SgsnFunction ..... | 10 | +| A.2.2.9 IOC GgsnFunction..... | 11 | +| A.2.2.10 IOC BgFunction ..... | 11 | +| A.2.2.11 IOC GmsecFunction..... | 11 | +| A.2.2.12 IOC SmlcFunction..... | 11 | +| A.2.2.13 IOC GmlcFunction ..... | 11 | +| A.2.2.14 IOC ScffFunction..... | 11 | +| A.2.2.15 IOC SrfFunction ..... | 11 | +| A.2.2.16 IOC CbcFunction..... | 12 | +| A.2.2.17 IOC CgffFunction ..... | 12 | +| A.2.2.18 IOC GmsecServerFunction ..... | 12 | +| A.2.2.19 IOC IwfFunction ..... | 12 | +| A.2.2.20 IOC MnpSrfFunction..... | 12 | +| A.2.2.21 IOC NpdbFunction ..... | 12 | +| A.2.2.22 IOC SgwFunction ..... | 12 | +| A.2.2.23 IOC SsffFunction..... | 13 | +| A.2.2.24 IOC BsFunction..... | 13 | +| A.2.2.25 IOC IucsLink ..... | 13 | +| A.2.2.26 IOC IupsLink..... | 13 | +| A.2.2.27 IOC IubcLink..... | 13 | +| A.2.2.28 IOC ALink..... | 14 | +| A.2.2.29 IOC GbLink..... | 14 | +| A.2.2.30 IOC CsMgwFunction ..... | 14 | +| A.2.2.31 IOC BmScFunction ..... | 14 | +| A.2.2.32 IOC Link_BmSc_Ggsn ..... | 14 | +| A.2.2.33 IOC Link_Ggsn_Sgsn ..... | 14 | +| A.2.2.34 CircuitEndPointSubgroup..... | 15 | +| A.2.2.35 IOC MscPool..... | 15 | +| A.2.2.36 IOC MscPoolArea ..... | 15 | +| A.2.2.37 IOC SgsnPool ..... | 16 | + +| | | | +|-----------------------------|-----------------------------------------------------------|-----------| +| A.2.2.38 | IOC SgsnPoolArea ..... | 16 | +| A.3 | Solution Set definitions ..... | 17 | +| A.3.1 | IDL definition structure ..... | 17 | +| A.3.2 | IDL specification "CoreNetworkResourcesNRMDefs.idl" ..... | 17 | +| <b>Annex B (normative):</b> | <b>XML definitions.....</b> | <b>23</b> | +| B.0 | General ..... | 23 | +| B.1 | Architectural features ..... | 23 | +| B.1.1 | Syntax for Distinguished Names ..... | 23 | +| B.2 | Mapping ..... | 23 | +| B.3 | Solution Set definitions ..... | 23 | +| B.3.1 | XML definition structure ..... | 23 | +| B.3.2 | XML schema "coreNrm.xsd" ..... | 23 | +| Annex C (informative): | Change history ..... | 37 | + +# Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.701: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- 28.702: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- 28.703: "Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".** + +# --- 1 Scope + +The purpose of the present document is to define the mapping of the IRP information model (see TS 28.702 [3]) to the protocol specific details necessary for implementation of this IRP in a specific solution set environment. + +This Solution Set specification is related to 3GPP TS 28.702 V14. 0.X [3]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 28.702: "Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [4] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [5] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [6] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [7] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Information Service (IS)". +- [8] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [9] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [10] Void +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [12] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [13] 3GPP TS 28.626: "Telecommunication management; State Management Data Definition Integration Reference Point (IRP); Solution Set (SS) definitions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For terms and definitions please refer to TS 32.101 [1], TS 32.102 [2] and TS 28.702 [3]. + +For the purposes of the present document, the following terms and definitions apply: + +**XML file:** See definition in [6]. + +**XML document:** See definition in [6]. + +**XML declaration:** See definition in [6]. + +**XML element:** See definition in [6]. + +**empty XML element:** See definition in [6]. + +**XML content (of an XML element):** See definition in [6]. + +**XML start-tag:** See definition in [6]. + +**XML end-tag:** See definition in [6]. + +**XML empty-element tag:** See definition in [6]. + +**XML attribute specification:** See definition in [6]. + +**DTD:** See definition in [6]. + +**XML schema:** See definition in [6]. + +**XML namespace:** See definition in [6]. + +**XML complex type:** See definition in [6]. + +**XML element type:** See definition in [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MGW | Media GateWay | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set definitions + +This specification defines the following 3GPP Core network resources IRP Solution Set Definitions: + +- 3GPP Core network resources IRP CORBA SS (Annex A) +- 3GPP Core network resources IRP XML definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) (TS 28.702 [3]). + +--- + +## A.1 Architectural features + +The overall architectural feature of Core Network NRM IRP is specified in TS 28.702 [3]. + +This clause specifies features that are specific to the CORBA SS. + +### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [6]. + +### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [6]. + +--- + +## A.2 Mapping + +### A.2.1 General mappings + +See clause A.2.1 of [6]. + +### A.2.2 Information Object Class (IOC) mapping + +#### A.2.2.1 IOC MscServerFunction + +**Mapping from NRM IOC MscServerFunction attributes to SS equivalent MOC MscServerFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|-----------------------------------|----------------------------------|------------------------------------------------------------------| +| id | mscServerFunctionId | string | +| mccList | mccList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| mncList | mncList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| lacList | lacList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| sacList | sacList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| gcaList | gcaList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| mscId | mscId | long | +| nrilList | nrilList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| defaultMsc | defaultMsc | short | +| mscServerFunction-GsmCell | mscServerFunctionGsmCell | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | +| mscServerFunction-ExternalGsmCell | mscServerFunctionExternalGsmCell | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | +| mscServerFunction-CsMgwFunction | mscServerFunctionCsMgwFunction | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | +| mscServerFunction-MscPool | mscServerFunctionMscPool | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | + +#### A.2.2.2 IOC HlrFunction + +**Mapping from NRM IOC HlrFunction attributes to SS equivalent MOC HlrFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | hlrFunctionId | string | + +#### A.2.2.3 IOC VlrFunction + +**Mapping from NRM IOC VlrFunction attributes to SS equivalent MOC VlrFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | vlrFunctionId | string | + +#### A.2.2.4 IOC AucFunction + +**Mapping from NRM IOC AucFunction attributes to SS equivalent MOC AucFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | aucFunctionId | string | + +#### A.2.2.5 IOC EirFunction + +**Mapping from NRM IOC EirFunction attributes to SS equivalent MOC EirFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | eirFunctionId | string | + +#### A.2.2.6 IOC SmlwmscFunction + +**Mapping from NRM IOC SmlwmscFunction attributes to SS equivalent MOC SmlwmscFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|-------------------|---------| +| id | smlwmscFunctionId | string | + +#### A.2.2.7 IOC SmsGmscFunction + +**Mapping from NRM IOC SmsGmscFunction attributes to SS equivalent MOC SmsGmscFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|-------------------|---------| +| id | smsGmscFunctionId | string | + +#### A.2.2.8 IOC SgsnFunction + +**Mapping from NRM IOC SgsnFunction attributes to SS equivalent MOC SgsnFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------------------|-------------------------------------------------------------------------------|------------------------------------------------------------------| +| id | sgsnFunctionId | string | +| mccList | mccList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| mncList | mncList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| lacList | lacList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| racList | racList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| sacList | sacList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| sgsnId | sgsnId | long | +| proceduralStatus | See mapping in 3GPP TS 28.626 [13] (State Management Data Definition IRP SS). | See 3GPP TS 28.626 [13]. | +| nriList | nriList | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::LongSet | +| sgsnFunction-GsmCell | sgsnFunctionGsmCell | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | +| sgsnFunction-ExternalGsmCell | sgsnFunctionExternalGsmCell | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | +| sgsnFunction-SgsnPool | sgsnFunctionSgsnPool | GenericNetworkResourcesIRPSYSTEM::AttributeTypes::MOReferenceSet | + +#### A.2.2.9 IOC GgsnFunction + +**Mapping from NRM IOC GgsnFunction attributes to SS equivalent MOC GgsnFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------|-------------------------------------------------------------------------------|--------------------------| +| id | ggsnFunctionId | string | +| proceduralStatus | See mapping in 3GPP TS 28.626 [13] (State Management Data Definition IRP SS). | See 3GPP TS 28.626 [13]. | + +#### A.2.2.10 IOC BgFunction + +**Mapping from NRM IOC BgFunction attributes to SS equivalent MOC BgFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | bgFunctionId | string | + +#### A.2.2.11 IOC GmscFunction + +**Mapping from NRM IOC GmscFunction attributes to SS equivalent MOC GmscFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|----------------|---------| +| id | gmscFunctionId | string | + +#### A.2.2.12 IOC SmIcFunction + +**Mapping from NRM IOC SmIcFunction attributes to SS equivalent MOC SmIcFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|----------------|---------| +| id | smIcFunctionId | string | + +#### A.2.2.13 IOC GmIcFunction + +**Mapping from NRM IOC GmIcFunction attributes to SS equivalent MOC GmIcFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|----------------|---------| +| id | gmIcFunctionId | string | + +#### A.2.2.14 IOC ScfFunction + +**Mapping from NRM IOC ScfFunction attributes to SS equivalent MOC ScfFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | scfFunctionId | string | + +#### A.2.2.15 IOC SrfFunction + +**Mapping from NRM IOC SrfFunction attributes to SS equivalent MOC SrfFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | srfFunctionId | string | + +#### A.2.2.16 IOC CbcFunction + +**Mapping from NRM IOC CbcFunction attributes to SS equivalent MOC CbcFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | cbcFunctionId | string | + +#### A.2.2.17 IOC CgfFunction + +**Mapping from NRM IOC CgfFunction attributes to SS equivalent MOC CgfFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | cgfFunctionId | string | + +#### A.2.2.18 IOC GmscServerFunction + +**Mapping from NRM IOC GmscServerFunction attributes to SS equivalent MOC GmscServerFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|----------------------|---------| +| id | gmscServerFunctionId | string | + +#### A.2.2.19 IOC IwfFunction + +**Mapping from NRM IOC IwfFunction attributes to SS equivalent MOC IwfFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | iwfFunctionId | string | + +#### A.2.2.20 IOC MnpSrfFunction + +**Mapping from NRM IOC MnpSrfFunction attributes to SS equivalent MOC IwfFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|------------------|---------| +| id | mnpSrfFunctionId | string | + +#### A.2.2.21 IOC NpdbFunction + +**Mapping from NRM IOC NpdbFunction attributes to SS equivalent MOC NpdbFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|----------------|---------| +| id | npdbFunctionId | string | + +#### A.2.2.22 IOC SgwFunction + +**Mapping from NRM IOC SgwFunction attributes to SS equivalent MOC SgwFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | sgwFunctionId | string | + +#### A.2.2.23 IOC SsfFunction + +**Mapping from NRM IOC SsfFunction attributes to SS equivalent MOC SsfFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | ssfFunctionId | string | + +#### A.2.2.24 IOC BsFunction + +**Mapping from NRM IOC BsFunction attributes to SS equivalent MOC BsFunction attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | bsFunctionId | string | + +#### A.2.2.25 IOC IucsLink + +**Mapping from NRM IOC IucsLink attributes to SS equivalent MOC IucsLink attributes** + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|---------------------------------------------------------------| +| id | iucsLinkId | string | +| connectedRnc | connectedRnc | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| connectedBss | connectedBss | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| connectedHNBGW | connectedHNBGW | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.26 IOC IupsLink + +**Mapping from NRM IOC IupsLink attributes to SS equivalent MOC IupsLink attributes** + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|---------------------------------------------------------------| +| id | iupsLinkId | string | +| connectedRnc | connectedRnc | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| connectedBss | connectedBss | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| connectedHNBGW | connectedHNBGW | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.27 IOC IubcLink + +**Mapping from NRM IOC IubcLink attributes to SS equivalent MOC IubcLink attributes** + +| IS Attributes | SS Attributes | SS Type | +|----------------|----------------|---------------------------------------------------------------| +| id | iubcLinkId | string | +| connectedRnc | connectedRnc | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| connectedHNBGW | connectedHNBGW | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.28 IOC ALink + +**Mapping from NRM IOC ALink attributes to SS equivalent MOC ALink attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------------------------------------------------------------| +| id | aLinkId | string | +| connectedBss | connectedBss | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.29 IOC GbLink + +##### Mapping from NRM IOC GbLink attributes to SS equivalent MOC GbLink attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------------------------------------------------------------| +| gbLinkId | gbLinkId | string | +| connectedBss | connectedBss | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.30 IOC CsMgwFunction + +##### Mapping from NRM IOC CsMgwFunction attributes to SS equivalent MOC CsMgwFunction attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------------------------|---------------------------------|------------------------------------------------------------------| +| id | csMgwFunctionId | string | +| csMgwFunction-MscServerFunction | csMgwFunctionMscServerFunction | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| csMgwFunction-MscServerFunction | csMgwFunction-MscServerFunction | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| csMgwFunction-IucsLink | csMgwFunctionIucsLink | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| csMgwFunction-ALink | csMgwFunctionALink | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +#### A.2.2.31 IOC BmScFunction + +##### Mapping from NRM IOC BmScFunction attributes to SS equivalent MOC BmScFunction attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|----------------|---------| +| id | bmScFunctionId | string | + +#### A.2.2.32 IOC Link\_BmSc\_Ggsn + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [6]. + +#### A.2.2.33 IOC Link\_Ggsn\_Sgsn + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [6]. + +#### A.2.2.34 CircuitEndPointSubgroup + +##### Mapping from NRM IOC CircuitEndPointSubgroup attributes to SS equivalent MOC CircuitEndPointSubgroup attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------------------|---------| +| id | circuitEndPointSubgroupId | String | + +#### A.2.2.35 IOC MscPool + +##### Mapping from NRM IOC MscPool attributes to SS equivalent MOC MscPool attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------------------|--------------------------|------------------------------------------------------------------| +| id | id | string | +| mscPool-MscServerFunction | mscPoolMscServerFunction | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | + +#### A.2.2.36 IOC MscPoolArea + +**Mapping from NRM IOC MscPoolArea attributes to SS equivalent MOC MscPoolArea attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------------|--------------------|--------------------------------------------------------------------| +| id | id | string | +| lacList | lacList | GenericNetworkResourcesIRP System::AttributeTypes::Long Set | +| pLMNIdList | pLMNIdList | GenericNetworkResourcesIRP System::AttributeTypes::Long Set | +| mscPoolArea-MscPool | mscPoolAreaMscPool | GenericNetworkResourcesIRP System::AttributeTypes::MOR eferenceSet | + +#### A.2.2.37 IOC SgsnPool + +**Mapping from NRM IOC SgsnPool attributes to SS equivalent MOC SgsnPool attributes** + +| IS Attributes | SS Attributes | SS Type | +|-----------------------|----------------------|--------------------------------------------------------------------| +| Id | id | String | +| sgsnPool-SgsnFunction | sgsnPoolSgsnFunction | GenericNetworkResourcesIRP System::AttributeTypes::MOR eferenceSet | + +#### A.2.2.38 IOC SgsnPoolArea + +**Mapping from NRM IOC SgsnPoolArea attributes to SS equivalent MOC SgsnPoolArea attributes** + +| IS Attributes | SS Attributes | SS Type | +|-----------------------|----------------------|--------------------------------------------------------------------| +| id | id | String | +| racList | racList | GenericNetworkResourcesIRP System::AttributeTypes::Long Set | +| pLMNIdList | pLMNIdList | GenericNetworkResourcesIRP System::AttributeTypes::Long Set | +| sgsnPoolArea-SgsnPool | sgsnPoolAreaSgsnPool | GenericNetworkResourcesIRP System::AttributeTypes::MOR eferenceSet | + +## --- A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the Core Network NRM IRP. + +### A.3.2 IDL specification "CoreNetworkResourcesNRMDefs.idl" + +``` +// File: CoreNetworkResourcesNRMDefs.idl +#ifdef _CORENETWORKRESOURCESNRMDefs_IDL_ +#define _CORENETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module CoreNetworkResourcesNRMDefs +{ + /** + * Definitions for MO class MscServerFunction + */ + interface MscServerFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "MscServerFunction"; + // Attribute Names + // + const string mscServerFunctionId = "mscServerFunctionId"; + const string mccList = "mccList"; + const string mncList = "mncList"; + const string lacList = "lacList"; + const string sacList = "sacList"; + const string gcaList = "gcaList"; + const string mscId = "mscId"; + const string mscServerFunctionGsmCell = "mscServerFunctionGsmCell"; + const string mscServerFunctionExternalGsmCell = "mscServerFunctionExternalGsmCell"; + const string mscServerFunctionCsMgwFunction = "mscServerFunctionCsMgwFunction"; + const string mscServerFunctionMscPool = "mscServerFunctionMscPool"; + const string nriList = "nriList"; + const string defaultMsc = "defaultMsc"; + }; + /** + * Definitions for MO class HlrFunction + */ + interface HlrFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "HlrFunction"; + // Attribute Names + // + const string hlrFunctionId = "hlrFunctionId"; + }; + /** + * Definitions for MO class VlrFunction + */ + interface VlrFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "VlrFunction"; + // Attribute Names + // + const string vlrFunctionId = "vlrFunctionId"; + }; + /** + * Definitions for MO class AucFunction + */ + interface AucFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "AucFunction"; + // Attribute Names + // + const string aucFunctionId = "aucFunctionId"; + }; +}; +``` + +``` +/** + * Definitions for MO class EirFunction + */ +interface EirFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "EirFunction"; + // Attribute Names + // + const string eirFunctionId = "eirFunctionId"; +}; + +/** + * Definitions for MO class SmsIwmscFunction + */ +interface SmsIwmscFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SmsIwmscFunction"; + // Attribute Names + // + const string smsIwmscFunctionId = "smsIwmscFunctionId"; +}; + +/** + * Definitions for MO class SmsGmscFunction + */ +interface SmsGmscFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SmsGmscFunction"; + // Attribute Names + // + const string smsGmscFunctionId = "smsGmscFunctionId"; +}; + +/** + * Definitions for MO class SgsnFunction + */ +interface SgsnFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SgsnFunction"; + // Attribute Names + // + const string sgsnFunctionId = "sgsnFunctionId"; + const string mccList = "mccList"; + const string mncList = "mncList"; + const string lacList = "lacList"; + const string racList = "racList"; + const string sacList = "sacList"; + const string sgsnId = "sgsnId"; + const string sgsnFunctionGsmCell = "sgsnFunctionGsmCell"; + const string sgsnFunctionExternalGsmCell = "sgsnFunctionExternalGsmCell"; + const string sgsnFunctionSgsnPool = "sgsnFunctionSgsnPool"; + const string nriList = "nriList"; + const string proceduralStatus = "proceduralStatus"; +}; + +/** + * Definitions for MO class GgsnFunction + */ +interface GgsnFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "GgsnFunction"; + // Attribute Names + // + const string ggsnFunctionId = "ggsnFunctionId"; + const string proceduralStatus = "proceduralStatus"; +}; + +/** + * Definitions for MO class BgFunction + */ +interface BgFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "BgFunction"; + // Attribute Names + // + const string bgFunctionId = "bgFunctionId"; +}; + +/** + * Definitions for MO class GmscFunction + */ +interface GmscFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +``` + +``` +{ + const string CLASS = "GmscFunction"; + // Attribute Names + // + const string gmscFunctionId = "gmscFunctionId"; +}; +/** + * Definitions for MO class SmlcFunction + */ +interface SmlcFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SmlcFunction"; + // Attribute Names + // + const string smlcFunctionId = "smlcFunctionId"; +}; +/** + * Definitions for MO class GmlcFunction + */ +interface GmlcFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "GmlcFunction"; + // Attribute Names + // + const string gmlcFunctionId = "gmlcFunctionId"; +}; +/** + * Definitions for MO class ScfFunction + */ +interface ScfFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ScfFunction"; + // Attribute Names + // + const string scfFunctionId = "scfFunctionId"; +}; +/** + * Definitions for MO class SrfFunction + */ +interface SrfFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SrfFunction"; + // Attribute Names + // + const string srfFunctionId = "srfFunctionId"; +}; +/** + * Definitions for MO class CbcFunction + */ +interface CbcFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "CbcFunction"; + // Attribute Names + // + const string cbcFunctionId = "cbcFunctionId"; +}; +/** + * Definitions for MO class CgfFunction + */ +interface CgfFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "CgfFunction"; + // Attribute Names + // + const string cgfFunctionId = "cgfFunctionId"; +}; +/** + * Definitions for MO class GmscServerFunction + */ +interface GmscServerFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "GmscServerFunction"; + // Attribute Names + // + const string gmscServerFunctionId = "gmscServerFunctionId"; +}; +/** + * Definitions for MO class IwfFunction +``` + +``` +*/ +interface IwfFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "IwfFunction"; + // Attribute Names + // + const string iwfFunctionId = "iwfFunctionId"; +}; +/** + * Definitions for MO class MnpSrfFunction + */ +interface MnpSrfFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MnpSrfFunction"; + // Attribute Names + // + const string mnpSrfFunctionId = "mnpSrfFunctionId"; +}; +/** + * Definitions for MO class NpdbFunction + */ +interface NpdbFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "NpdbFunction"; + // Attribute Names + // + const string npdbFunctionId = "npdbFunctionId"; +}; +/** + * Definitions for MO class SgwFunction + */ +interface SgwFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SgwFunction"; + // Attribute Names + // + const string sgwFunctionId = "sgwFunctionId"; +}; +/** + * Definitions for MO class SsfFunction + */ +interface SsfFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SsfFunction"; + // Attribute Names + // + const string ssfFunctionId = "ssfFunctionId"; +}; + +/** + * Definitions for MO class BsFunction + */ +interface BsFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "BsFunction"; + // Attribute Names + // + const string bsFunctionId = "bsFunctionId"; +}; +/** + * Definitions for MO class IucsLink + */ +interface IucsLink : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "IucsLink"; + // Attribute Names + // + const string iucsLinkId = "iucsLinkId"; + const string connectedRnc = "connectedRnc"; + const string connectedBss = "connectedBss"; + const string connectedHNBGW = "connectedHNBGW"; +}; +/** + * Definitions for MO class IupsLink + */ +interface IupsLink : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "IupsLink"; +} +``` + +``` + // Attribute Names + // + const string iupsLinkId = "iupsLinkId"; + const string connectedRnc = "connectedRnc"; + const string connectedBss = "connectedBss"; + const string connectedHNBGW = "connectedHNBGW"; +}; + +/** + * Definitions for MO class IubcLink + */ +interface IubcLink : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "IubcLink"; + // Attribute Names + // + const string iubcLinkId = "iubcLinkId"; + const string connectedRnc = "connectedRnc"; + const string connectedHNBGW = "connectedHNBGW"; +}; + +/** + * Definitions for MO class ALink + */ +interface ALink : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ALink"; + // Attribute Names + // + const string aLinkId = "aLinkId"; + const string connectedBss = "connectedBss"; +}; + +/** + * Definitions for MO class GbLink + */ +interface GbLink : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "GbLink"; + // Attribute Names + // + const string gbLinkId = "gbLinkId"; + const string connectedBss = "connectedBss"; +}; + +/** + * Definitions for MO class CsMgwFunction + */ +interface CsMgwFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "CsMgwFunction"; + // Attribute Names + // + const string csMgwFunctionId = "csMgwFunctionId"; + const string csMgwFunctionMscServerFunction = "csMgwFunctionMscServerFunction"; + const string csMgwFunctionIucsLink = "csMgwFunctionIucsLink"; + const string csMgwFunctionALink = "csMgwFunctionALink"; +}; + +/** + * Definitions for MO class BmScFunction + */ +interface BmScFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "BmScFunction"; + //Attribute Names + // + const string bmScFunctionId = "bmScFunctionId"; +}; + +/** + * Definitions for MO class Link_BmSc_Ggsn + */ +interface Link_BmSc_Ggsn : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_BmSc_Ggsn"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_Ggsn_Sgsn + */ +``` + +``` +*/ +interface Link_Ggsn_Sgsn : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_Ggsn_Sgsn"; + + // All Attributes inherited from Link +}; + +/* Definitions for MO class CircuitEndPointSubgroup +*/ + +interface CircuitEndPointSubgroup: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "CircuitEndPointSubgroup"; + //Attribute Names + const string circuitEndPointSubgroupId = "circuitEndPointSubgroupId"; +}; + +/** + * Definitions for MO class MscPool + */ +interface MscPool: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MscPool"; + //Attribute Names + const string id = "id"; + const string mscPoolMscServerFunction = "mscPoolMscServerFunction"; +}; + +/** + * Definitions for MO class MscPoolArea + */ +interface MscPoolArea: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MscPoolArea"; + //Attribute Names + const string id = "id"; + const string lacList = "lacList"; + const string pLMNIdList = "pLMNIdList"; + const s + + /* Definitions for MO class SgsnPool + */ + + interface SgsnPool: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "SgsnPool"; + //Attribute Names + const string id = "id"; + const string sgsnPoolSgsnFunction = "sgsnPoolSgsnFunction"; + }; + + /* Definitions for MO class SgsnPoolArea + */ + + /* Definitions for MO class SgsnPoolArea + */ + + interface SgsnPoolArea: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "SgsnPoolArea"; + //Attribute Names + const string id = "id"; + const string racList = "racList"; + const string pLMNIdList = "pLMNIdList"; + const string sgsnPoolAreaSgsnPool = "sgsnPoolAreaSgsnPool"; + }; + +}; + +#endif // _CORENETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +This annex contains the XML definitions for the Core Network NRM IRP as it applies to Itf-N, in accordance with Core Network NRM IRP IS definitions [3]. + +The XML file formats are based on XML [9], XML Schema [11] [12] and XML Namespace [5] standards. + +## --- B.1 Architectural features + +The overall architectural feature of Core Network NRM IRP IS is specified in 3GPP TS 28.702 [3]. This clause specifies features that are specific to the XML Schema definitions. + +### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [4]. + +## --- B.2 Mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [8]. + +B.3.2 of the present document defines the NRM-specific XML schema `coreNrm.xsd` for the Core Network NRM IRP defined in 3GPP TS 28.702 [3]. + +XML schema `coreNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [8]. + +### B.3.2 XML schema "coreNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.703 Core Network NRM IRP + Bulk CM Configuration data file NRM-specific XML schema + coreNrm.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.703#coreNrm" + elementFormDefault="qualified" + attributeFormDefault="unqualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:cn="http://www.3gpp.org/ftp/specs/archive/28_series/28.703#coreNrm" + xmlns:sm="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP" +> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.626#stateManagementIRP"/> + + <!-- Core Network NRM IRP class associated XML elements --> +``` + +``` +<complexType name="longList"> + <sequence> + <element name="em" type="long" minOccurs="0" maxOccurs="unbounded"/> + </sequence> +</complexType> + +<complexType name="PLMNId"> + <sequence> + <element name="mcc" type="short"/> + <element name="mnc" type="short"/> + </sequence> +</complexType> +<complexType name="PLMNIdList"> + <sequence> + <element name="pLMNId" type="cn:PLMNId" maxOccurs="6" /> + </sequence> +</complexType> + +<element + name="MscServerFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="mccList" type="cn:longList"/> + <element name="mncList" type="cn:longList"/> + <element name="lacList" type="cn:longList"/> + <element name="sacList" type="cn:longList"/> + <element name="gcaList" type="cn:longList" minOccurs="0"/> + <element name="mscId" type="long"/> + <element name="mscServerFunctionGsmCell" type="xn:dnList"/> + <element name="mscServerFunctionExternalGsmCell" type="xn:dnList"/> + <element name="mscServerFunctionCsMgwFunction" type="xn:dnList"/> + <element name="nriList" type="cn:longList"/> + <element name="mscServerFunctionMscPool" type="xn:dnList" minOccurs="0"/> + <element name="defaultMsc" type="cn:defaultMscType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="cn:IucsLink"/> + <element ref="cn:ALink"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="HlrFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + </complexContent> + </complexType> +</element> + +<element + name="VlrFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="AucFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="EirFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` +<element + name="SmsIwmscFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="SmsGmscFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="GmscFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="SgsnFunction" +``` + +``` + + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="mccList" type="cn:longList"/> + <element name="mncList" type="cn:longList"/> + <element name="lacList" type="cn:longList"/> + <element name="racList" type="cn:longList"/> + <element name="sacList" type="cn:longList"/> + <element name="sgsnId" type="long"/> + <element name="sgsnFunctionGsmCell" type="xn:dnList"/> + <element name="sgsnFunctionExternalGsmCell" type="xn:dnList"/> + <element name="sgsnFunctionSgsnPool" type="xn:dn"/> + <element name="nriList" type="cn:longList"/> + <element name="proceduralStatus" type="sm:proceduralStatusType"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="cn:GbLink"/> + <element ref="cn:IupsLink"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="GgsnFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="proceduralStatus" type="sm:proceduralStatusType"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="BgFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> +``` + +``` +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="SmlcFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="GmlcFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ScfFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + </sequence> + </extension> +</complexContent> +</complexType> +</element> + +<element name="IucsLink"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="connectedRnc" type="xn:dn" minOccurs="0"/> + <element name="connectedBss" type="xn:dn" minOccurs="0"/> + <element name="connectedHNBGW" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="IupsLink"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="connectedRnc" type="xn:dn" minOccurs="0"/> + <element name="connectedBss" type="xn:dn" minOccurs="0"/> + <element name="connectedHNBGW" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="IubcLink"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="connectedRnc" type="xn:dn"/> + <element name="connectedHNBGW" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + +</element> + +<element name="ALink"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="connectedBss" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="GbLink"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="connectedBss" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="SrfFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="CbcFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + +``` + +``` +<complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="cn:IubcLink"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> +</complexContent> +</complexType> +</element> + +<element + name="CgfFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="GmscServerFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="IwfFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> +``` + +``` +<sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="MnpSrfFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="NpdbFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="SgwFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> +``` + +``` +<all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="SsfFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="BsFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="CsMgwFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + <element name="csMgwFunctionMscServerFunction" type="string" /> + <element name="csMgwFunctionIucsLink" type="xn:dnList"/> + <element name="csMgwFunctionALink" type="xn:dnList"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element + name="BmScFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_BmSc_Ggsn" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_Ggsn_Sgsn" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="CircuitEndPointSubgroup" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="circuitEndPointSubgroupId" type="string"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="MscPool" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="mscPoolMscServerFunction" type="xn:dnList" /> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="MscPoolArea" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="lacList" type="cn:longList"/> + <element name="pLMNIdList" type="cn:PLMNIdList" minOccurs="0"/> + <element name="mscPoolAreaMscPool" type="xn:dnList"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<simpleType name="defaultMscType"> + <restriction base="unsignedShort"> + <minInclusive value="0"/> + <maxInclusive value="1"/> + </restriction> +</simpleType> +<element name="SgsnPool" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + +``` + +``` +<complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="sgsnPoolSgsnFunction" type="xn:dnList"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer" /> + </choice> + </sequence> + </extension> + </complexContent> +</complexType> +</element> +<element name="SgsnPoolArea" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="racList" type="cn:longList "/> + <element name="pLMNIdList" type="cn:PLMNIdList" minOccurs="0"/> + <element name="sgsnPoolAreaSgsnPool" type="xn:dnList"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer" /> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +</schema> +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|--|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2014-03 | SA#63 | SP-140031 | 001 | 1 | F | Correction of proceduralStatus attribute mapping and datatype | | 11.1.0 | +| 2014-06 | SA#64 | SP-140332 | 002 | - | F | Upgrade W3C XML Schema version from 1.0 to 1.1 | | 11.2.0 | +| | | SP-140360 | 003 | - | F | remove the feature support statements | | 11.2.0 | +| 2014-09 | SA#65 | SP-140560 | 004 | - | C | Update the link from Solution Set to Information Service due to the end of Release 12 | | 12.0.0 | +| 2014-12 | SA#66 | SP-140798 | 006 | - | F | Update SS-IS version link | | 12.1.0 | +| 2016-01 | | | | | | Update to Rel-13 (MCC) | | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 0007 | - | F | Update the link from IRP Solution Set to IRP Information Service | | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0008 | - | F | Update the link from IRP Solution Set to IRP Information Service | | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0009 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28704/raw.md b/marked/Rel-16/28_series/28704/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..41bc6511ee56aee453f47110e7c240b8dea99a8c --- /dev/null +++ b/marked/Rel-16/28_series/28704/raw.md @@ -0,0 +1,118 @@ + + + + + + +# --- Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Requirements ..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- 28.704: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements.** +- 28.705: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.706: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the requirements for the present IRP: IMS Network Resource Model (NRM) IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [5] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [6] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [7] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**IRP:** See 3GPP TS 32.150 [4]. + +**Information Object Class (IOC):** See definition in TS 28.622 [7]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [7]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----|-----------------------------| +| CM | Configuration Management | +| IMS | IP Multimedia Subsystem | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [1]. +- b) IRP-related requirements in 3GPP TS 32.102 [2]. +- c) IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [5] and its information is derived from FNIM Umbrella Information Model (UIM) [6]. + +In addition to the above, the following more specific requirement applies: + +The Network Resource Model defined by this IRP shall contain IMS specific IOCs and related definitions, supporting IMS entities in the current 3GPP Release. + +# Annex A (informative): Change history + +| <b>Change history</b> | | | | | | | | | +|-----------------------|--------------|-----------------|-----------|----------|--------------------------------------------------|------------|------------|---------------| +| <b>Date</b> | <b>TSG #</b> | <b>TSG Doc.</b> | <b>CR</b> | <b>R</b> | <b>Subject/Comment</b> | <b>Cat</b> | <b>Old</b> | <b>New</b> | +| 2014-06 | SA#64 | SP-140360 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28705/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/28_series/28705/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7406a26f4a4ae1ab403477f2b45615db08dc3acf --- /dev/null +++ b/marked/Rel-16/28_series/28705/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b32e8db5d146b858d7fe14e119e8e1489a7c3f88cf6db0d744abedcbc46bf8be +size 76802 diff --git a/marked/Rel-16/28_series/28705/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/28_series/28705/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32cd987cdcbab76d58e7c8a580dfd21728beee10 --- /dev/null +++ b/marked/Rel-16/28_series/28705/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a6071dfb241a5ceb4008b12b6b6825c3f092ec0e1900a4250fa3c86358e62446 +size 130003 diff --git a/marked/Rel-16/28_series/28705/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/marked/Rel-16/28_series/28705/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dbcac11bf4f8b1817770d75d6e4cbdeecedafdb6 --- /dev/null +++ b/marked/Rel-16/28_series/28705/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ef05d573be75a0e0e2a160368b3c66c885641c4d9f70a1d01c4284405956062 +size 34967 diff --git a/marked/Rel-16/28_series/28705/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg b/marked/Rel-16/28_series/28705/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..322b0717a770c0ead50cc800ed93a514dbfeabc6 --- /dev/null +++ b/marked/Rel-16/28_series/28705/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:96fe0b518ec99663dd5b299ceb9070c07d8119913f2d1f72883fd8d15a53ffe5 +size 28471 diff --git a/marked/Rel-16/28_series/28705/410562339ce067fdc6fa41940c118658_img.jpg b/marked/Rel-16/28_series/28705/410562339ce067fdc6fa41940c118658_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9bdadb36f6ffd985d03119a034048c4e9c7bfa18 --- /dev/null +++ b/marked/Rel-16/28_series/28705/410562339ce067fdc6fa41940c118658_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:60991f31fc145d5ea783a2584e07f8f6043fde027dcac5aa58eee0b22e4f17e6 +size 37430 diff --git a/marked/Rel-16/28_series/28705/4356776ca004ecba5d599667a155d7d4_img.jpg b/marked/Rel-16/28_series/28705/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e6251c34fe9e7e75e4f421bf8659a1c116cdbe6 --- /dev/null +++ b/marked/Rel-16/28_series/28705/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1debe33563d33cb80061c3abfeca6416e22be6dc3ce67c928e07c2e26b54698e +size 31328 diff --git a/marked/Rel-16/28_series/28705/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/28_series/28705/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6614a70ebef322584f5135c1b1ec76a507d43861 --- /dev/null +++ b/marked/Rel-16/28_series/28705/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:340ce68d767f11e21d116ff4fd869576a8087ddee9fcf041f9a2ed46e6f927e1 +size 56036 diff --git a/marked/Rel-16/28_series/28705/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/28_series/28705/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..562fe3135828cacbc7b0dc0865a7cf83bb97a421 --- /dev/null +++ b/marked/Rel-16/28_series/28705/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:edeec21567bc8096ed4ba847665efd36bbce6254a3ad317c51d8921f70face6e +size 31118 diff --git a/marked/Rel-16/28_series/28705/8e14350b4b669119a3bdfca7869110ca_img.jpg b/marked/Rel-16/28_series/28705/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..51734c715e0ada7e5a2c4e178c767a34f6b382ff --- /dev/null +++ b/marked/Rel-16/28_series/28705/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38f564933f398fe7cdcf68e074cd1370148d8d9ac797077c075c656a75114773 +size 64956 diff --git a/marked/Rel-16/28_series/28705/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/28_series/28705/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6eb890eb33c8cd7ff57656d74489d7c5c6c9fd1f --- /dev/null +++ b/marked/Rel-16/28_series/28705/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:97bff8ce5c04a517fb16c0c38d2f444b7ab2866dce4ef0050a5e3a7f709b2f63 +size 54018 diff --git a/marked/Rel-16/28_series/28705/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/28_series/28705/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cbafb7611db8671a38a77cb6865916dc27272e85 --- /dev/null +++ b/marked/Rel-16/28_series/28705/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3ecb81ba043bf79eb6ec27f9a8fe9c27d464a7d72e49d818bff9b891e9591879 +size 54583 diff --git a/marked/Rel-16/28_series/28705/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/marked/Rel-16/28_series/28705/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d08e8e8c2c4c0ebb6620f493217985f27adc16a8 --- /dev/null +++ b/marked/Rel-16/28_series/28705/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9bd020dfed72e84a7a270ecfc2418463a972849c4a6e0dd5cc28fc04b344ada5 +size 45089 diff --git a/marked/Rel-16/28_series/28705/bffdddb47fced140f8d17fdc2a29f592_img.jpg b/marked/Rel-16/28_series/28705/bffdddb47fced140f8d17fdc2a29f592_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cdb3204666d43bd0c6b6cda6fb56faca53eff230 --- /dev/null +++ b/marked/Rel-16/28_series/28705/bffdddb47fced140f8d17fdc2a29f592_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c04c984eee32b14dd4e641b99e8d7f1ed25db8283e62997b504d426937c0b2d4 +size 62385 diff --git a/marked/Rel-16/28_series/28705/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/28_series/28705/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0e5aa4331f759bd8a4b699392eec00a4548c2ce --- /dev/null +++ b/marked/Rel-16/28_series/28705/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3401ba04a404ee9f45c1b5e2834417762573103fd86d45de0b47375fb69631b2 +size 36681 diff --git a/marked/Rel-16/28_series/28705/raw.md b/marked/Rel-16/28_series/28705/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2b86fc3f728a399e5076546972f2c70166dead79 --- /dev/null +++ b/marked/Rel-16/28_series/28705/raw.md @@ -0,0 +1,1454 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Model ..... | 11 | +| 4.1 Imported information entities and local labels..... | 11 | +| 4.2 Class diagram..... | 12 | +| 4.2.1 Relationships ..... | 12 | +| 4.2.2 Inheritance ..... | 16 | +| 4.3 Class definitions ..... | 20 | +| 4.3.1 ASFunction ..... | 20 | +| 4.3.1.1 Definition ..... | 20 | +| 4.3.1.2 Attributes ..... | 20 | +| 4.3.1.3 Attribute constraints..... | 20 | +| 4.3.1.4 Notifications..... | 20 | +| 4.3.2 BGCFFunction ..... | 20 | +| 4.3.2.1 Definition ..... | 20 | +| 4.3.2.2 Attributes ..... | 20 | +| 4.3.2.3 Attribute constraints..... | 20 | +| 4.3.2.4 Notifications..... | 20 | +| 4.3.3 CAMELIMSSFASFunction ..... | 21 | +| 4.3.3.1 Definition ..... | 21 | +| 4.3.3.2 Attributes ..... | 21 | +| 4.3.3.3 Attribute constraints..... | 21 | +| 4.3.3.4 Notifications..... | 21 | +| 4.3.4 CSCFFunction ..... | 21 | +| 4.3.4.1 Definition ..... | 21 | +| 4.3.4.2 Attributes ..... | 21 | +| 4.3.4.3 Attribute constraints..... | 21 | +| 4.3.4.4 Notifications..... | 21 | +| 4.3.5 HSSFunction..... | 21 | +| 4.3.5.1 Definition ..... | 21 | +| 4.3.5.2 Attributes ..... | 21 | +| 4.3.5.3 Attribute constraints..... | 22 | +| 4.3.5.4 Notifications..... | 22 | +| 4.3.6 ICSCFFunction..... | 22 | +| 4.3.6.1 Definition ..... | 22 | +| 4.3.6.2 Attributes ..... | 22 | +| 4.3.6.3 Attribute constraints..... | 22 | +| 4.3.6.4 Notifications..... | 22 | +| 4.3.7 IMSMGWFunction..... | 22 | +| 4.3.7.1 Definition ..... | 22 | +| 4.3.7.2 Attributes ..... | 22 | +| 4.3.7.3 Attribute constraints..... | 22 | +| 4.3.7.4 Notifications..... | 22 | +| 4.3.8 MGCFFunction ..... | 23 | +| 4.3.8.1 Definition ..... | 23 | +| 4.3.8.2 Attributes ..... | 23 | +| 4.3.8.3 Attribute constraints..... | 23 | +| 4.3.8.4 Notifications..... | 23 | +| 4.3.9 MRFCFunction ..... | 23 | +| 4.3.9.1 Definition ..... | 23 | + +| | | | +|----------|----------------------------|----| +| 4.3.9.2 | Attributes ..... | 23 | +| 4.3.9.3 | Attribute constraints..... | 23 | +| 4.3.9.4 | Notifications..... | 23 | +| 4.3.10 | MRFPFunction ..... | 24 | +| 4.3.10.1 | Definition ..... | 24 | +| 4.3.10.2 | Attributes ..... | 24 | +| 4.3.10.3 | Attribute constraints..... | 24 | +| 4.3.10.4 | Notifications..... | 24 | +| 4.3.11 | OSASCSASFunction..... | 24 | +| 4.3.11.1 | Definition ..... | 24 | +| 4.3.11.2 | Attributes ..... | 24 | +| 4.3.11.3 | Attribute constraints..... | 24 | +| 4.3.11.4 | Notifications..... | 24 | +| 4.3.12 | PCSCFFunction..... | 24 | +| 4.3.12.1 | Definition ..... | 24 | +| 4.3.12.2 | Attributes ..... | 24 | +| 4.3.12.3 | Attribute constraints..... | 24 | +| 4.3.12.4 | Notifications..... | 25 | +| 4.3.13 | SCSFFunction ..... | 25 | +| 4.3.13.1 | Definition ..... | 25 | +| 4.3.13.2 | Attributes ..... | 25 | +| 4.3.13.3 | Attribute constraints..... | 25 | +| 4.3.13.4 | Notifications..... | 25 | +| 4.3.14 | SIPASFunction ..... | 25 | +| 4.3.14.1 | Definition ..... | 25 | +| 4.3.14.2 | Attributes ..... | 25 | +| 4.3.14.3 | Attribute constraints..... | 25 | +| 4.3.14.4 | Notifications..... | 25 | +| 4.3.15 | SLFFunction..... | 25 | +| 4.3.15.1 | Definition ..... | 25 | +| 4.3.15.2 | Attributes ..... | 25 | +| 4.3.15.3 | Attribute constraints..... | 26 | +| 4.3.15.4 | Notifications..... | 26 | +| 4.3.16 | ECSCFFunction..... | 26 | +| 4.3.16.1 | Definition ..... | 26 | +| 4.3.16.2 | Attributes ..... | 26 | +| 4.3.16.3 | Attribute constraints..... | 26 | +| 4.3.16.4 | Notifications..... | 26 | +| 4.3.17 | Link_AS_ICSCF..... | 26 | +| 4.3.17.1 | Definition ..... | 26 | +| 4.3.17.2 | Attributes ..... | 26 | +| 4.3.17.3 | Attribute constraints..... | 26 | +| 4.3.17.4 | Notifications..... | 26 | +| 4.3.18 | Link_AS_SCSF..... | 26 | +| 4.3.18.1 | Definition ..... | 26 | +| 4.3.18.2 | Attributes ..... | 26 | +| 4.3.18.3 | Attribute constraints..... | 27 | +| 4.3.18.4 | Notifications..... | 27 | +| 4.3.19 | Link_AS_SLF..... | 27 | +| 4.3.19.1 | Definition ..... | 27 | +| 4.3.19.2 | Attributes ..... | 27 | +| 4.3.19.3 | Attribute constraints..... | 27 | +| 4.3.19.4 | Notifications..... | 27 | +| 4.3.20 | Link_BGCF_BGCF..... | 27 | +| 4.3.20.1 | Definition ..... | 27 | +| 4.3.20.2 | Attributes ..... | 27 | +| 4.3.20.3 | Attribute constraints..... | 27 | +| 4.3.20.4 | Notifications..... | 27 | +| 4.3.21 | Link_BGCF_MGCF..... | 27 | +| 4.3.21.1 | Definition ..... | 27 | +| 4.3.21.2 | Attributes ..... | 27 | + +| | | | +|----------|----------------------------|----| +| 4.3.21.3 | Attribute constraints..... | 28 | +| 4.3.21.4 | Notifications..... | 28 | +| 4.3.22 | Link_BGCF_SCSF..... | 28 | +| 4.3.22.1 | Definition..... | 28 | +| 4.3.22.2 | Attributes..... | 28 | +| 4.3.22.3 | Attribute constraints..... | 28 | +| 4.3.22.4 | Notifications..... | 28 | +| 4.3.23 | Link_HSS_ICSCF..... | 28 | +| 4.3.23.1 | Definition..... | 28 | +| 4.3.23.2 | Attributes..... | 28 | +| 4.3.23.3 | Attribute constraints..... | 28 | +| 4.3.23.4 | Notifications..... | 28 | +| 4.3.24 | Link_ICSCF_SCSF..... | 28 | +| 4.3.24.1 | Definition..... | 28 | +| 4.3.24.2 | Attributes..... | 28 | +| 4.3.24.3 | Attribute constraints..... | 29 | +| 4.3.24.4 | Notifications..... | 29 | +| 4.3.25 | Link_ICSCF_MGCF..... | 29 | +| 4.3.25.1 | Definition..... | 29 | +| 4.3.25.2 | Attributes..... | 29 | +| 4.3.25.3 | Attribute constraints..... | 29 | +| 4.3.25.4 | Notifications..... | 29 | +| 4.3.26 | Link_ICSCF_PCSF..... | 29 | +| 4.3.26.1 | Definition..... | 29 | +| 4.3.26.2 | Attributes..... | 29 | +| 4.3.26.3 | Attribute constraints..... | 29 | +| 4.3.26.4 | Notifications..... | 29 | +| 4.3.27 | Link_PCSF_SCSF..... | 29 | +| 4.3.27.1 | Definition..... | 29 | +| 4.3.27.2 | Attributes..... | 29 | +| 4.3.27.3 | Attribute constraints..... | 30 | +| 4.3.27.4 | Notifications..... | 30 | +| 4.3.28 | Link_CAMELIMSSFAS_HSS..... | 30 | +| 4.3.28.1 | Definition..... | 30 | +| 4.3.28.2 | Attributes..... | 30 | +| 4.3.28.3 | Attribute constraints..... | 30 | +| 4.3.28.4 | Notifications..... | 30 | +| 4.3.29 | Link_HSS_OSASCSAS..... | 30 | +| 4.3.29.1 | Definition..... | 30 | +| 4.3.29.2 | Attributes..... | 30 | +| 4.3.29.3 | Attribute constraints..... | 30 | +| 4.3.29.4 | Notifications..... | 30 | +| 4.3.30 | Link_HSS_SCSF..... | 30 | +| 4.3.30.1 | Definition..... | 30 | +| 4.3.30.2 | Attributes..... | 30 | +| 4.3.30.3 | Attribute constraints..... | 31 | +| 4.3.30.4 | Notifications..... | 31 | +| 4.3.31 | Link_HSS_SIPAS..... | 31 | +| 4.3.31.1 | Definition..... | 31 | +| 4.3.31.2 | Attributes..... | 31 | +| 4.3.31.3 | Attribute constraints..... | 31 | +| 4.3.31.4 | Notifications..... | 31 | +| 4.3.32 | Link_ICSCF_SLF..... | 31 | +| 4.3.32.1 | Definition..... | 31 | +| 4.3.32.2 | Attributes..... | 31 | +| 4.3.32.3 | Attribute constraints..... | 31 | +| 4.3.32.4 | Notifications..... | 31 | +| 4.3.33 | Link_IMSMGW_MGCF..... | 31 | +| 4.3.33.1 | Definition..... | 31 | +| 4.3.33.2 | Attributes..... | 31 | +| 4.3.33.3 | Attribute constraints..... | 32 | + +| | | | +|------------------------|----------------------------------|----| +| 4.3.33.4 | Notifications..... | 32 | +| 4.3.34 | Link_MGCF_SCSF ..... | 32 | +| 4.3.34.1 | Definitions ..... | 32 | +| 4.3.34.2 | Attributes ..... | 32 | +| 4.3.34.3 | Attribute constraints..... | 32 | +| 4.3.34.4 | Notifications..... | 32 | +| 4.3.35 | Link_MRFC_MRFP..... | 32 | +| 4.3.35.1 | Definition ..... | 32 | +| 4.3.35.2 | Attributes ..... | 32 | +| 4.3.35.3 | Attribute constraints..... | 32 | +| 4.3.35.4 | Notifications..... | 32 | +| 4.3.36 | Link_MRFC_SCSF ..... | 32 | +| 4.3.36.1 | Definition ..... | 32 | +| 4.3.36.2 | Attributes ..... | 32 | +| 4.3.36.3 | Attribute constraints..... | 33 | +| 4.3.36.4 | Notifications..... | 33 | +| 4.3.37 | Link_SCSF_SCSF..... | 33 | +| 4.3.37.1 | Definition ..... | 33 | +| 4.3.37.2 | Attributes ..... | 33 | +| 4.3.37.3 | Attribute constraints..... | 33 | +| 4.3.37.4 | Notifications..... | 33 | +| 4.3.38 | Link_SCSF_SLF..... | 33 | +| 4.3.38.1 | Definition ..... | 33 | +| 4.3.38.2 | Attributes ..... | 33 | +| 4.3.38.3 | Attribute constraints..... | 33 | +| 4.3.38.4 | Notifications..... | 33 | +| 4.3.39 | Link_PCSF_ECSF..... | 33 | +| 4.3.39.1 | Definition ..... | 33 | +| 4.3.39.2 | Attributes ..... | 33 | +| 4.3.39.3 | Attribute constraints..... | 34 | +| 4.3.39.4 | Notifications..... | 34 | +| 4.3.40 | Link_BGCF_ECSF ..... | 34 | +| 4.3.40.1 | Definition ..... | 34 | +| 4.3.40.2 | Attributes ..... | 34 | +| 4.3.40.3 | Attribute constraints..... | 34 | +| 4.3.40.4 | Notifications..... | 34 | +| 4.3.41 | Link_MGCF_ECSF ..... | 34 | +| 4.3.41.1 | Definition ..... | 34 | +| 4.3.41.2 | Attributes ..... | 34 | +| 4.3.41.3 | Attribute constraints..... | 34 | +| 4.3.41.4 | Notifications..... | 34 | +| 4.4 | Attribute definitions ..... | 34 | +| 4.4.1 | Attribute properties..... | 34 | +| 4.4.2 | Constraints ..... | 35 | +| 4.5 | Common notifications ..... | 35 | +| 4.5.1 | Alarm notifications ..... | 35 | +| 4.5.2 | Configuration notifications..... | 35 | +| Annex A (informative): | Change history..... | 36 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- 28.704: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements. +- 28.705: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS).** +- 28.706: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions. + +# --- 1 Scope + +The present document specifies the IP Multimedia Subsystem (IMS) network resource information that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +The IMS NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the protocol neutral IMS NRM IRP: Information Service (IS). It reuses relevant parts of the Generic NRM IRP: IS in 3GPP TS 28.622 [9], either by direct reuse or sub-classing, and in addition to that defines IMS specific Information Object Classes. + +Finally, in order to access the information defined by this NRM, an Interface IRP is needed, such as the Basic CM IRP in 3GPP TS 32.602 [10]. However, which Interface IRP that is applicable is outside the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM IRP Information Service (IS)". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [5] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point: Information Service (IS)". +- [6] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [7] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [8] 3GPP TS 23.002: "Network architecture". +- [9] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" +- [10] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP): Information Service (IS)". +- [11] 3GPP TS 28.702: "Telecommunication management; Configuration Management (CM); Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +- [12] 3GPP TS 32.156: "Telecommunication management; Fixed Mobile Convergence (FMC) Model Repertoire". +- [13] ITU-T Recommendation X.710 (1991): "Common Management Information Service Definition for CCITT Applications". +- [14] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.600 [7] and the following apply: + +**Association:** See definition in TS 28.622 [9]. + +**Managed Element (ME):** See definition in TS 28.622 [9]. + +**Managed Object (MO):** See definition in TS 28.622 [9]. + +**Management Information Model (MIM):** See definition in TS 28.622 [9]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [9]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|------------------------------------------------------| +| AS | Application Server | +| BGCF | Breakout Gateway Control Function | +| CN | Core Network | +| DN | Distinguished Name (see 3GPP TS 32.300 [6]) | +| E-CSCF | Emergency Call Session Control Function | +| I-CSCF | Interrogating Call Session Control Function | +| IM-SSF | IP Multimedia Service Switching Function | +| IMS | IP Multimedia Subsystem | +| IMS-MGW | IMS Media Gateway | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| ISO | International Standards Organization | +| ME | Managed Element | +| MGCF | Media Gateway Control Function | +| MO | Managed Object | +| MOI | Managed Object Instance | +| MRFC | Multimedia Resource Function Controller | +| MRFP | Multimedia Resource Function Processor | +| NE | Network Element | +| NM | Network Manager | +| NR | Network Resource | +| NRM | Network Resource Model | +| OSI | Open Systems Interconnection | +| P-CSCF | Proxy Call Session Control Function | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [6]) | +| S-CSCF | Serving Call Session Control Function | +| SLF | Subscription Locator Function | +| TMN | Telecommunications Management Network | +| UML | Unified Modelling Language | +| UMTS | Universal Mobile Telecommunications System | + +# --- 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|------------------------------------------------------|----------------| +| 28.622 [9], information object class, Link | Link | +| 28.622 [9], information object class, ManagedElement | ManagedElement | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides the overview of the relationships of relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. The figures below show the containment/naming hierarchy and the associations of the information object classes defined in the present document. + +NOTE: The listed cardinality numbers represent transient as well as steady-state numbers, and reflect all managed object creation and deletion scenarios in all figures. + +![UML Class diagram showing containment/naming relationships between ManagedElement and various function classes.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +The diagram illustrates a containment/naming hierarchy. At the top is the base class **«InformationObjectClass» ManagedElement (from 28.622)**. Below it are eight subclasses, each representing a function class: **«InformationObjectClass» CSCFFunction**, **«InformationObjectClass» MRFCFunction**, **«InformationObjectClass» IMSMGWFunction**, **«InformationObjectClass» HSSFunction**, **«InformationObjectClass» SLFFunction**, **«InformationObjectClass» MGCFFunction**, **«InformationObjectClass» BGCFFunction**, **«InformationObjectClass» ASFunction**, and **«InformationObjectClass» MRFFFunction**. Each subclass is connected to the base class by a directed association arrow pointing upwards, labeled with the role name «names». The cardinality at the base class end of each association is '1', and the cardinality at the subclass end is 'x'. + +UML Class diagram showing containment/naming relationships between ManagedElement and various function classes. + +Figure 4.2.1.1: IMS NRM Containment/Naming relationships + +![UML Class Diagram showing IMS NRM Link Associations 1. The diagram illustrates relationships between various Information Object Classes (IOCs) and their associated functions. Functions include ICSCFFunction, SLFFunction, ASFunction, SCSCFFunction, HSSFunction, MGCFFunction, BGCFFunction, and IMSMGWFunction. Link IOCs include Link_ICSCF_SLF, Link_AS_ICSCF, Link_AS_SLF, Link_SCSCF_SLF, Link_CSCF_CSCF, Link_HSS_SCSCF, Link_MGCF_SCSCF, Link_BGCF_SCSCF, Link_IMSMGW_MGCF, Link_BGCF_MGCF, and Link_BGCF_BGCF. Reference points are indicated by notes: Dh, Ma, Dx, Iso, Mw, Mg, Mn, Mj, Mi, and Mk.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +classDiagram + class ICSCFFunction + class SLFFunction + class ASFunction + class SCSCFFunction + class HSSFunction + class MGCFFunction + class BGCFFunction + class IMSMGWFunction + + class Link_ICSCF_SLF + class Link_AS_ICSCF + class Link_AS_SLF + class Link_SCSCF_SLF + class Link_CSCF_CSCF + class Link_HSS_SCSCF + class Link_MGCF_SCSCF + class Link_BGCF_SCSCF + class Link_IMSMGW_MGCF + class Link_BGCF_MGCF + class Link_BGCF_BGCF + + ICSCFFunction "x" -- "x" Link_ICSCF_SLF + ICSCFFunction "x" -- "x" Link_AS_ICSCF + ICSCFFunction "x" -- "x" Link_AS_SLF + SLFFunction "x" -- "x" Link_ICSCF_SLF + SLFFunction "x" -- "x" Link_AS_SLF + SLFFunction "x" -- "x" Link_SCSCF_SLF + ASFunction "x" -- "x" Link_AS_ICSCF + ASFunction "x" -- "x" Link_AS_SLF + ASFunction "x" -- "x" Link_SCSCF_SLF + SCSCFFunction "x" -- "x" Link_SCSCF_SLF + SCSCFFunction "x" -- "x" Link_CSCF_CSCF + SCSCFFunction "x" -- "x" Link_HSS_SCSCF + SCSCFFunction "x" -- "x" Link_BGCF_SCSCF + HSSFunction "x" -- "x" Link_HSS_SCSCF + MGCFFunction "x" -- "x" Link_MGCF_SCSCF + MGCFFunction "x" -- "x" Link_BGCF_MGCF + MGCFFunction "x" -- "x" Link_IMSMGW_MGCF + BGCFFunction "x" -- "x" Link_BGCF_SCSCF + BGCFFunction "x" -- "x" Link_BGCF_MGCF + BGCFFunction "x" -- "x" Link_BGCF_BGCF + IMSMGWFunction "x" -- "x" Link_IMSMGW_MGCF + + note for Link_ICSCF_SLF "Dx Ref point +Either Link_ICSCF_SLF +or Link_SCSCF_SLF" + note for Link_AS_SLF "Dh Ref point" + note for Link_AS_ICSCF "Ma Ref point" + note for Link_SCSCF_SLF "Iso Ref point" + note for Link_CSCF_CSCF "Mw Ref point" + note for Link_MGCF_SCSCF "Mg Ref point" + note for Link_IMSMGW_MGCF "Mn Ref point" + note for Link_BGCF_MGCF "Mj Ref point" + note for Link_BGCF_BGCF "Mk Ref point" + note for Link_BGCF_SCSCF "Cx Ref point" + note for Link_BGCF_SCSCF "Mi Ref point" + +``` + +UML Class Diagram showing IMS NRM Link Associations 1. The diagram illustrates relationships between various Information Object Classes (IOCs) and their associated functions. Functions include ICSCFFunction, SLFFunction, ASFunction, SCSCFFunction, HSSFunction, MGCFFunction, BGCFFunction, and IMSMGWFunction. Link IOCs include Link\_ICSCF\_SLF, Link\_AS\_ICSCF, Link\_AS\_SLF, Link\_SCSCF\_SLF, Link\_CSCF\_CSCF, Link\_HSS\_SCSCF, Link\_MGCF\_SCSCF, Link\_BGCF\_SCSCF, Link\_IMSMGW\_MGCF, Link\_BGCF\_MGCF, and Link\_BGCF\_BGCF. Reference points are indicated by notes: Dh, Ma, Dx, Iso, Mw, Mg, Mn, Mj, Mi, and Mk. + +Note: If this NRM has interfaces (Link IOCs) modelled to IOCs in other NRM(s), the Link IOC definitions may be defined in the other NRM(s) and need to be considered in implementations. + +Figure 4.2.1.2: IMS NRM Link Associations 1 + +![UML Class Diagram showing IMS NRM Link Associations 2. It features three main classes: MRFPFunction, MRFCFunction, and SCSCFunction. MRFPFunction and MRFCFunction are linked by a solid line with 'x' multiplicity at both ends. MRFCFunction and SCSCFunction are also linked by a solid line with 'x' multiplicity at both ends. Below MRFPFunction is a class 'Link_MRFC_MRFP' connected by a dashed line, which in turn is connected by a dashed line to a note labeled 'Mp Ref point'. Below SCSCFunction is a class 'Link_MRFC_SCSCF' connected by a dashed line, which is connected by a dashed line to a note labeled 'Mr Ref point'.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +UML Class Diagram showing IMS NRM Link Associations 2. It features three main classes: MRFPFunction, MRFCFunction, and SCSCFunction. MRFPFunction and MRFCFunction are linked by a solid line with 'x' multiplicity at both ends. MRFCFunction and SCSCFunction are also linked by a solid line with 'x' multiplicity at both ends. Below MRFPFunction is a class 'Link\_MRFC\_MRFP' connected by a dashed line, which in turn is connected by a dashed line to a note labeled 'Mp Ref point'. Below SCSCFunction is a class 'Link\_MRFC\_SCSCF' connected by a dashed line, which is connected by a dashed line to a note labeled 'Mr Ref point'. + +Figure 4.2.1.3: IMS NRM Link Associations 2 + +![UML Class Diagram showing IMS NRM Link Associations 3. It features three main classes: MGCFFunction, ICSCFunction, and HSSFunction. MGCFFunction and ICSCFunction are linked by a solid line with 'x' multiplicity at both ends. ICSCFunction and HSSFunction are also linked by a solid line with 'x' multiplicity at both ends. Below MGCFFunction is a class 'Link_ICSCF_MGCF' connected by a dashed line, which in turn is connected by a dashed line to a note labeled 'Mg Ref point'. Below HSSFunction is a class 'Link_HSS_ICSCF' connected by a dashed line, which is connected by a dashed line to a note labeled 'Cx Ref point'.](410562339ce067fdc6fa41940c118658_img.jpg) + +UML Class Diagram showing IMS NRM Link Associations 3. It features three main classes: MGCFFunction, ICSCFunction, and HSSFunction. MGCFFunction and ICSCFunction are linked by a solid line with 'x' multiplicity at both ends. ICSCFunction and HSSFunction are also linked by a solid line with 'x' multiplicity at both ends. Below MGCFFunction is a class 'Link\_ICSCF\_MGCF' connected by a dashed line, which in turn is connected by a dashed line to a note labeled 'Mg Ref point'. Below HSSFunction is a class 'Link\_HSS\_ICSCF' connected by a dashed line, which is connected by a dashed line to a note labeled 'Cx Ref point'. + +Figure 4.2.1.4: IMS NRM Link Associations 3 + +![UML Class Diagram showing IMS NRM Link Associations 4. It includes classes: Link_ICSCF_PSCF, ICSCFFunction, PCSCFFunction, SCSCFFunction, and Link_PSCF_SCSCF. Associations are shown between ICSCFFunction and the others, with 'Mw Ref point' notes.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +This UML class diagram illustrates the IMS NRM Link Associations 4. It features five classes: «InformationObjectClass» Link\_ICSCF\_PSCF, «InformationObjectClass» ICSCFFunction, «InformationObjectClass» PCSCFFunction, «InformationObjectClass» SCSCFFunction, and «InformationObjectClass» Link\_PSCF\_SCSCF. The diagram shows associations between ICSCFFunction and the other three classes (Link\_ICSCF\_PSCF, PCSCFFunction, and SCSCFFunction), each marked with an 'x'. PCSCFFunction is also associated with SCSCFFunction, marked with an 'x'. Link\_ICSCF\_PSCF, Link\_PSCF\_SCSCF, and SCSCFFunction are each accompanied by a note labeled 'Mw Ref point' connected by a dashed line. + +UML Class Diagram showing IMS NRM Link Associations 4. It includes classes: Link\_ICSCF\_PSCF, ICSCFFunction, PCSCFFunction, SCSCFFunction, and Link\_PSCF\_SCSCF. Associations are shown between ICSCFFunction and the others, with 'Mw Ref point' notes. + +Figure 4.2.1.5: IMS NRM Link Associations 4 + +![UML Class Diagram showing IMS NRM Link Associations 5. It includes classes: SIPASFunction, Link_HSS_SIPAS, HSSFunction, CAMELIMSSFASFunction, Link_HSS_OSASCAS, and OSASCASFunction. Associations are shown between HSSFunction and the others, with 'Sh Ref point' and 'Si Ref point' notes.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +This UML class diagram illustrates the IMS NRM Link Associations 5. It features six classes: «InformationObjectClass» SIPASFunction, «InformationObjectClass» Link\_HSS\_SIPAS, «InformationObjectClass» HSSFunction, «InformationObjectClass» CAMELIMSSFASFunction, «InformationObjectClass» Link\_HSS\_OSASCAS, and «InformationObjectClass» OSASCASFunction. The diagram shows associations between HSSFunction and SIPASFunction, CAMELIMSSFASFunction, and OSASCASFunction, each marked with an 'x'. Link\_HSS\_SIPAS and Link\_HSS\_OSASCAS are each accompanied by a note labeled 'Sh Ref point' connected by a dashed line. CAMELIMSSFASFunction is accompanied by a note labeled 'Si Ref point' connected by a dashed line. + +UML Class Diagram showing IMS NRM Link Associations 5. It includes classes: SIPASFunction, Link\_HSS\_SIPAS, HSSFunction, CAMELIMSSFASFunction, Link\_HSS\_OSASCAS, and OSASCASFunction. Associations are shown between HSSFunction and the others, with 'Sh Ref point' and 'Si Ref point' notes. + +Figure 4.2.1.6: IMS NRM Link Associations 5 + +![IMS NRM Link Associations 6 diagram](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +This diagram illustrates the link associations for the IMS NRM. It features three primary Information Object Classes (IOCs) represented by light blue boxes: «InformationObjectClass» BGCFFunction at the top, «InformationObjectClass» ECSCFunction in the center, and «InformationObjectClass» MGCFFunction at the bottom. These three are connected by a vertical solid line, with 'x' multiplicity markers at each intersection. To the left, «InformationObjectClass» Link\_PCSCF\_ECSCF (orange box) is connected to ECSCFunction and has a dashed line to a note labeled 'Mw Ref point'. «InformationObjectClass» PCSCFFunction (light blue box) is also connected to ECSCFunction with an 'x' multiplicity. To the right, «InformationObjectClass» Link\_BGCF\_ECSCF (orange box) is connected to BGCFFunction and has a dashed line to a note labeled 'Mi Ref point'. «InformationObjectClass» Link\_MGCF\_ECSCF (orange box) is connected to MGCFFunction and has a dashed line to a note labeled 'Mg Ref point'. + +IMS NRM Link Associations 6 diagram + +Figure 4.2.1.7: IMS NRM Link Associations 6 + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +![IMS NRM Inheritance Hierarchy 1 diagram](bffdddb47fced140f8d17fdc2a29f592_img.jpg) + +This diagram shows the inheritance hierarchy for the IMS NRM. At the top is the base class «InformationObjectClass» ManagedFunction (from 28.622) in a light blue box. Below it, eight other Information Object Classes (IOCs) are shown in light blue boxes, each with a solid inheritance arrow pointing up to the ManagedFunction base class. These subclasses are: CSCFFunction, MRFCFunction, IMSMGWFunction, HSSFunction, SLFFunction, MRFPFunction, ASFunction, and BGCFFunction. + +IMS NRM Inheritance Hierarchy 1 diagram + +Figure 4.2.2.1: IMS NRM Inheritance Hierarchy 1 + +![IMS NRM Inheritance Hierarchy 2 diagram](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +This diagram illustrates the inheritance hierarchy for IMS NRM. At the top is the base class: «InformationObjectClass» Link (from\_28.622). Below it, eleven subclasses inherit from this base class via inheritance arrows pointing upwards. The subclasses are: «InformationObjectClass» Link\_AS\_SLF, «InformationObjectClass» Link\_SCSCF\_SLF, «InformationObjectClass» Link\_AS\_SCSCF, «InformationObjectClass» Link\_MGCF\_SCSCF, «InformationObjectClass» Link\_BGCF\_SCSCF, «InformationObjectClass» Link\_IMSMGW\_MGCF, «InformationObjectClass» Link\_Ap\_ICSF, «InformationObjectClass» Link\_HSS\_SCSCF, «InformationObjectClass» Link\_MRFC\_SCSCF, «InformationObjectClass» Link\_SCSCF\_SCSCF, «InformationObjectClass» Link\_MRFC\_MRFP, «InformationObjectClass» Link\_BGCF\_BGCF, and «InformationObjectClass» Link\_BGCF\_MGCF. + +IMS NRM Inheritance Hierarchy 2 diagram + +Figure 4.2.2.2: IMS NRM Inheritance Hierarchy 2 + +![IMS NRM Inheritance Hierarchy 3 diagram](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +This diagram illustrates another inheritance hierarchy for IMS NRM. At the top is the base class: «InformationObjectClass» Link (from\_28.622). Below it, five subclasses inherit from this base class via inheritance arrows pointing upwards. The subclasses are: «InformationObjectClass» Link\_ICSCF\_SCSF, «InformationObjectClass» Link\_ICSCF\_SLF, «InformationObjectClass» Link\_ICSCF\_PCSF, «InformationObjectClass» Link\_HSS\_ICSCF, «InformationObjectClass» Link\_PCSF\_SCSF, and «InformationObjectClass» Link\_ICSCF\_MGCF. + +IMS NRM Inheritance Hierarchy 3 diagram + +Figure 4.2.2.3: IMS NRM Inheritance Hierarchy 3 + +![UML class diagram showing inheritance hierarchy for ASFunction. The base class is ASFunction, and it is inherited by SIPASFunction, OSASCSASFunction, and CAMELIMSSFASFunction.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` +classDiagram + class ASFunction { + <<InformationObjectClass>> + ASFunction + } + class SIPASFunction { + <<InformationObjectClass>> + SIPASFunction + } + class OSASCSASFunction { + <<InformationObjectClass>> + OSASCSASFunction + } + class CAMELIMSSFASFunction { + <<InformationObjectClass>> + CAMELIMSSFASFunction + } + SIPASFunction --|> ASFunction + OSASCSASFunction --|> ASFunction + CAMELIMSSFASFunction --|> ASFunction +``` + +UML class diagram showing inheritance hierarchy for ASFunction. The base class is ASFunction, and it is inherited by SIPASFunction, OSASCSASFunction, and CAMELIMSSFASFunction. + +Figure 4.2.2.4: IMS NRM Inheritance Hierarchy 4 + +![UML class diagram showing inheritance hierarchy for Link (from_28.622). The base class is Link (from_28.622), and it is inherited by Link_HSS_SIPAS, Link_HSS_OSASCSAS, and Link_CAMELIMSSFAS_HSS.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +``` +classDiagram + class Link { + <<InformationObjectClass>> + Link + (from_28.622) + } + class Link_HSS_SIPAS { + <<InformationObjectClass>> + Link_HSS_SIPAS + } + class Link_HSS_OSASCSAS { + <<InformationObjectClass>> + Link_HSS_OSASCSAS + } + class Link_CAMELIMSSFAS_HSS { + <<InformationObjectClass>> + Link_CAMELIMSSFAS_HSS + } + Link_HSS_SIPAS --|> Link + Link_HSS_OSASCSAS --|> Link + Link_CAMELIMSSFAS_HSS --|> Link +``` + +UML class diagram showing inheritance hierarchy for Link (from\_28.622). The base class is Link (from\_28.622), and it is inherited by Link\_HSS\_SIPAS, Link\_HSS\_OSASCSAS, and Link\_CAMELIMSSFAS\_HSS. + +Figure 4.2.2.5: IMS NRM Inheritance Hierarchy 5 + +![UML class diagram showing inheritance hierarchy for CSCFFunction. The base class is CSCFFunction, and it is inherited by PCSCFFunction, ICSCFFunction, SCSCFFunction, and ECSCFFunction.](36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg) + +``` +classDiagram + class CSCFFunction { + <<InformationObjectClass>> + CSCFFunction + } + class PCSCFFunction { + <<InformationObjectClass>> + PCSCFFunction + } + class ICSCFFunction { + <<InformationObjectClass>> + ICSCFFunction + } + class SCSCFFunction { + <<InformationObjectClass>> + SCSCFFunction + } + class ECSCFFunction { + <<InformationObjectClass>> + ECSCFFunction + } + PCSCFFunction --|> CSCFFunction + ICSCFFunction --|> CSCFFunction + SCSCFFunction --|> CSCFFunction + ECSCFFunction --|> CSCFFunction +``` + +UML class diagram showing inheritance hierarchy for CSCFFunction. The base class is CSCFFunction, and it is inherited by PCSCFFunction, ICSCFFunction, SCSCFFunction, and ECSCFFunction. + +Figure 4.2.2.6: IMS NRM Inheritance Hierarchy 6 + +![UML class diagram showing inheritance hierarchy. Base class: «InformationObjectClass» Link (from_28.622). Subclasses: «InformationObjectClass» Link_PCSCF_ECSCF, «InformationObjectClass» Link_BGCF_ECSCF, and «InformationObjectClass» Link_MGCF_ECSCF.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` +classDiagram + class Link { + <<InformationObjectClass>> + Link + (from_28.622) + } + class Link_PCSCF_ECSCF { + <<InformationObjectClass>> + Link_PCSCF_ECSCF + } + class Link_BGCF_ECSCF { + <<InformationObjectClass>> + Link_BGCF_ECSCF + } + class Link_MGCF_ECSCF { + <<InformationObjectClass>> + Link_MGCF_ECSCF + } + Link_PCSCF_ECSCF --|> Link + Link_BGCF_ECSCF --|> Link + Link_MGCF_ECSCF --|> Link +``` + +UML class diagram showing inheritance hierarchy. Base class: «InformationObjectClass» Link (from\_28.622). Subclasses: «InformationObjectClass» Link\_PCSCF\_ECSCF, «InformationObjectClass» Link\_BGCF\_ECSCF, and «InformationObjectClass» Link\_MGCF\_ECSCF. + +Figure 4.2.2.7: IMS NRM Inheritance Hierarchy 7 + +## 4.3 Class definitions + +### 4.3.1 ASFunction + +#### 4.3.1.1 Definition + +This IOC represents AS functionality. For more information about the AS, see 3GPP TS 23.002 [8]. ASFunction may be instantiated when a specific Application Server type is not already represented with an IOC subclassed from this IOC in this specification. If the Application Server type is already represented by an IOC in this specification, then it should instead be used. In the case a subclassed IOC is utilized, the ASFunction relationships (including link objects) are carried forward to the sub-classed IOC through inheritance. + +#### 4.3.1.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.1.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.2 BGCFFunction + +#### 4.3.2.1 Definition + +This IOC represents BGCF functionality. For more information about the BGCF, see 3GPP TS 23.002 [8]. + +#### 4.3.2.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.2.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.3 CAMELIMSSFASFunction + +#### 4.3.3.1 Definition + +This IOC represents CAMEL IM-SSF AS functionality. For more information about the CAMEL IM-SSF AS, see 3GPP TS 23.002 [8]. + +#### 4.3.3.2 Attributes + +None. + +#### 4.3.3.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.4 CSCFFunction + +#### 4.3.4.1 Definition + +This IOC represents CSCF functionality. For more information about the CSCF, see 3GPP TS 23.002 [8]. + +This IOC cannot be instantiated. It is defined for sub-classing purposes. + +#### 4.3.4.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.4.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.5 HSSFunction + +#### 4.3.5.1 Definition + +This IOC represents HSS functionality. For more information about the HSS, see 3GPP TS 23.002 [8]. + +#### 4.3.5.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.5.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.6 ICSCFFunction + +#### 4.3.6.1 Definition + +This IOC represents I-CSCF functionality. For more information about the I-CSCF, see 3GPP TS 23.002 [8]. + +#### 4.3.6.2 Attributes + +None. + +#### 4.3.6.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.6.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.7 IMSMGWFunction + +#### 4.3.7.1 Definition + +This IOC represents IMS-MGW functionality. For more information about IMS-MGW, see 3GPP TS 23.002 [8]. + +#### 4.3.7.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.7.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.7.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.8 MGCFFunction + +#### 4.3.8.1 Definition + +This IOC represents MGCF functionality. For more information about the MGCF, see 3GPP TS 23.002 [8]. + +#### 4.3.8.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.8.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.8.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.9 MRFCFunction + +#### 4.3.9.1 Definition + +This IOC represents MRFC functionality. For more information about the MRFC, see 3GPP TS 23.002 [8]. + +#### 4.3.9.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.9.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.9.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.10 MRFPFunction + +#### 4.3.10.1 Definition + +This IOC represents MRFP functionality. For more information about the MRFP, see 3GPP TS 23.002 [8]. + +#### 4.3.10.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.10.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.10.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.11 OSASCSASFunction + +#### 4.3.11.1 Definition + +This IOC represents OSA Application Server (Service Capability Server) functionality. For more information about the OSA Service Capability Server, see 3GPP TS 23.002 [8]. + +#### 4.3.11.2 Attributes + +None. + +#### 4.3.11.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.11.4 Notifications + +There is no notification defined. + +### 4.3.12 PCSCFFunction + +#### 4.3.12.1 Definition + +This IOC represents P-CSCF functionality. For more information about the P-CSCF, see 3GPP TS 23.002 [8]. + +#### 4.3.12.2 Attributes + +None. + +#### 4.3.12.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.12.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.13 SCSFunction + +#### 4.3.13.1 Definition + +This IOC represents S-CSCF functionality. For more information about the S-CSCF, see 3GPP TS 23.002 [8]. + +#### 4.3.13.2 Attributes + +None. + +#### 4.3.13.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.13.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.14 SIPASFunction + +#### 4.3.14.1 Definition + +This IOC represents SIP AS functionality. For more information about the SIP AS, see 3GPP TS 23.002 [8]. + +#### 4.3.14.2 Attributes + +None. + +#### 4.3.14.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.14.4 Notifications + +There is no notification defined. + +### 4.3.15 SLFFunction + +#### 4.3.15.1 Definition + +This IOC represents SLF functionality. For more information about the SLF, see 3GPP TS 23.002 [8]. + +#### 4.3.15.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| linkList | O | M | - | - | M | + +#### 4.3.15.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.15.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.16 ECSCFunction + +#### 4.3.16.1 Definition + +This IOC represents E-CSCF functionality. For more information about the E-CSCF, see 3GPP TS 23.002 [8]. + +#### 4.3.16.2 Attributes + +None. + +#### 4.3.16.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.16.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.17 Link\_AS\_ICSCF + +#### 4.3.17.1 Definition + +This IOC models the Ma reference point as defined in TS 23.002 [8]. + +#### 4.3.17.2 Attributes + +None. + +#### 4.3.17.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.17.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.18 Link\_AS\_SCSCF + +#### 4.3.18.1 Definition + +This IOC models the Isc reference point as defined in TS 23.002 [8]. + +#### 4.3.18.2 Attributes + +None. + +#### 4.3.18.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.18.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.19 Link\_AS\_SLF + +#### 4.3.19.1 Definition + +This models the Dh reference point as defined in TS 23.002 [8]. + +#### 4.3.19.2 Attributes + +None. + +#### 4.3.19.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.19.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.20 Link\_BGCF\_BGCF + +#### 4.3.20.1 Definition + +This models the Mk reference point as defined in TS 23.002 [8]. + +#### 4.3.20.2 Attributes + +None. + +#### 4.3.20.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.20.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.21 Link\_BGCF\_MGCF + +#### 4.3.21.1 Definition + +This models the Mj reference point as defined in TS 23.002 [8]. + +#### 4.3.21.2 Attributes + +None. + +#### 4.3.21.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.21.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.22 Link\_BGCF\_SCSCF + +#### 4.3.22.1 Definition + +This models the Mi reference point as defined in TS 23.002 [8]. + +#### 4.3.22.2 Attributes + +None. + +#### 4.3.22.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.22.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.23 Link\_HSS\_ICSCF + +#### 4.3.23.1 Definition + +This IOC models the Cx reference point as defined in TS 23.002 [8]. + +#### 4.3.23.2 Attributes + +None. + +#### 4.3.23.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.23.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.24 Link\_ICSCF\_SCSF + +#### 4.3.24.1 Definition + +This models the Mw reference point as defined in TS 23.002 [8]. + +#### 4.3.24.2 Attributes + +None. + +#### 4.3.24.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.24.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.25 Link\_ICSCF\_MGCF + +#### 4.3.25.1 Definition + +This IOC models the Mg reference point as defined in TS 23.002 [8]. + +#### 4.3.25.2 Attributes + +None. + +#### 4.3.25.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.25.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.26 Link\_ICSCF\_PCSF + +#### 4.3.26.1 Definition + +This models the Mw reference point as defined in TS 23.002 [8]. + +#### 4.3.26.2 Attributes + +None. + +#### 4.3.26.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.26.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.27 Link\_PCSCF\_SCSF + +#### 4.3.27.1 Definition + +This models the Mw reference point as defined in TS 23.002 [8]. + +#### 4.3.27.2 Attributes + +None. + +#### 4.3.27.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.27.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.28 Link\_CAMELIMSSFAS\_HSS + +#### 4.3.28.1 Definition + +This IOC models the Si reference point between CAMEL Application Server (IM-SSF) and HSS as defined in TS 23.002 [8]. + +#### 4.3.28.2 Attributes + +None. + +#### 4.3.28.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.28.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.29 Link\_HSS\_OSASCSAS + +#### 4.3.29.1 Definition + +This IOC models the Sh reference point between OSA Application Server (Service Capability Server) and HSS as defined in TS 23.002 [8]. + +#### 4.3.29.2 Attributes + +None. + +#### 4.3.29.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.29.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.30 Link\_HSS\_SCSF + +#### 4.3.30.1 Definition + +This IOC models the Cx reference point as defined in TS 23.002 [8]. + +#### 4.3.30.2 Attributes + +None. + +#### 4.3.30.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.30.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.31 Link\_HSS\_SIPAS + +#### 4.3.31.1 Definition + +This IOC models the Sh reference point between SIP Application Server and HSS as defined in TS 23.002 [8]. + +#### 4.3.31.2 Attributes + +None. + +#### 4.3.31.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.31.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.32 Link\_ICSCF\_SLF + +#### 4.3.32.1 Definition + +This models the Dx reference point as defined in TS 23.002 [8]. + +#### 4.3.32.2 Attributes + +None. + +#### 4.3.32.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.32.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.33 Link\_IMSMGW\_MGCF + +#### 4.3.33.1 Definition + +This models the Mn reference point as defined in TS 23.002 [8]. + +#### 4.3.33.2 Attributes + +None. + +#### 4.3.33.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.33.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.34 Link\_MGCF\_SCSCF + +#### 4.3.34.1 Definitions + +This models the Mg reference point as defined in TS 23.002 [8]. + +#### 4.3.34.2 Attributes + +None. + +#### 4.3.34.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.34.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.35 Link\_MRFC\_MRFP + +#### 4.3.35.1 Definition + +This IOC models the Mp reference point as defined in TS 23.002 [8]. + +#### 4.3.35.2 Attributes + +None. + +#### 4.3.35.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.35.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.36 Link\_MRFC\_SCSCF + +#### 4.3.36.1 Definition + +This IOC models the Mr reference point as defined in TS 23.002 [8]. + +#### 4.3.36.2 Attributes + +None. + +#### 4.3.36.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.36.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.37 Link\_SCSCF\_SCSCF + +#### 4.3.37.1 Definition + +This models the Mw reference point as defined in TS 23.002 [8]. + +#### 4.3.37.2 Attributes + +None. + +#### 4.3.37.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.37.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.38 Link\_SCSCF\_SLF + +#### 4.3.38.1 Definition + +This IOC models the Dx reference point as defined in TS 23.002 [8]. + +#### 4.3.38.2 Attributes + +None. + +#### 4.3.38.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.38.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.39 Link\_PCSCF\_ECSCF + +#### 4.3.39.1 Definition + +This IOC models the Mw reference point as defined in TS 23.002 [8]. + +#### 4.3.39.2 Attributes + +None. + +#### 4.3.39.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.39.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.40 Link\_BGCF\_ECSCF + +#### 4.3.40.1 Definition + +This IOC models the Mi reference point as defined in TS 23.002 [8]. + +#### 4.3.40.2 Attributes + +None. + +#### 4.3.40.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.40.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +### 4.3.41 Link\_MGCF\_ECSCF + +#### 4.3.41.1 Definition + +This IOC models the Mg reference point as defined in TS 23.002 [8]. + +#### 4.3.41.2 Attributes + +None. + +#### 4.3.41.3 Attribute constraints + +There is no attribute constraint defined. + +#### 4.3.41.4 Notifications + +The common notifications defined in subclause 4.6 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| linkList | An attribute containing all of the related link object Distinguished Names for the object instance, if any.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 0..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: No default value<br>isNullable: True | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This clause presents a list of notifications, defined in [5], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [14], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|--------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [5]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [5]) | | + +## 4.5.2 Configuration notifications + +This clause presents a list of notifications, defined in [3], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [14], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | + +## Annex A (informative): Change history + +| <b>Change history</b> | | | | | | | | | +|-----------------------|--------------|-----------------|-----------|----------|--------------------------------------------------|------------|------------|---------------| +| <b>Date</b> | <b>TSG #</b> | <b>TSG Doc.</b> | <b>CR</b> | <b>R</b> | <b>Subject/Comment</b> | <b>Cat</b> | <b>Old</b> | <b>New</b> | +| Jun-2013 | SA#60 | SP-130304 | 001 | 2 | Elimination of ambiguities in the TS | F | 11.0.0 | 11.1.0 | +| Jun-2014 | SA#64 | SP-140360 | 002 | - | remove the feature support statements | F | 11.1.0 | 11.2.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.2.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28706/raw.md b/marked/Rel-16/28_series/28706/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bd817ef2cd82893f5aafc5c639ad76484d1f94a9 --- /dev/null +++ b/marked/Rel-16/28_series/28706/raw.md @@ -0,0 +1,2177 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------|-----------| +| Foreword ..... | 5 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 7 | +| 4 Solution Set definitions..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural Features..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.3 Notifications..... | 8 | +| A.2 Mapping ..... | 8 | +| A.2.1 General mappings..... | 8 | +| A.2.2 Information Object Class (IOC) mapping..... | 8 | +| A.2.2.1 IOC ASFunction ..... | 8 | +| A.2.2.2 IOC BGCFFunction ..... | 9 | +| A.2.2.3 IOC CSCFFunction ..... | 9 | +| A.2.2.4 IOC HSSFunction..... | 9 | +| A.2.2.5 IOC IMSMGWFunction..... | 9 | +| A.2.2.6 IOC MGCFFunction ..... | 10 | +| A.2.2.7 IOC MRFCFunction ..... | 10 | +| A.2.2.8 IOC MRFPFunction ..... | 10 | +| A.2.2.9 IOC SLFFunction..... | 10 | +| A.2.2.10 IOC Link_CAMELIMSSFAS_HSS..... | 10 | +| A.2.2.11 IOC Link_AS_ICSCF..... | 10 | +| A.2.2.12 IOC Link_AS_SCSF..... | 11 | +| A.2.2.13 IOC Link_AS_SLF..... | 11 | +| A.2.2.14 IOC Link_BGCF_BGCF..... | 11 | +| A.2.2.15 IOC Link_BGCF_MGCF..... | 11 | +| A.2.2.17 IOC Link_HSS_ICSCF..... | 11 | +| A.2.2.29 IOC Link_SCSF_SLF..... | 12 | +| A.2.2.30 IOC Link_HSS_SIPAS..... | 12 | +| A.2.2.31 IOC Link_HSS_OSASCSAS ..... | 12 | +| A.2.2.32 IOC Link_PCSF_ECSCF..... | 12 | +| A.2.2.33 IOC Link_BGCF_ECSCF ..... | 12 | +| A.2.2.34 IOC Link_MGCF_ECSCF ..... | 12 | +| A.3 Solution Set definitions..... | 12 | +| A.3.1 IDL definition structure..... | 12 | +| A.3.2 IDL specification “IMSNRMDefs.idl” ..... | 13 | +| <b>Annex B (normative): XML definitions.....</b> | <b>19</b> | +| B.0 General..... | 19 | +| B.1 Architectural features..... | 19 | +| B.1.0 Introduction ..... | 19 | +| B.1.1 Syntax for Distinguished Names..... | 19 | +| B.2 Mapping ..... | 19 | +| B.3 Solution Set definitions ..... | 19 | +| B.3.1 XML definition structure ..... | 19 | + +B.3.2 XML Schema “imsNrm.xsd” ..... 20 + +Annex C (informative): Change history..... 35 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- 28.704: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.705: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.706: IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document specifies the Solution Sets for the IMS NRM IRP. + +The Solution Set definition is related to 3GPP TS 28.705 V14.0.X [3]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". + +- [3] 3GPP TS 28.705: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [4] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set (SS) definitions". +- [5] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". +- [6] 3GPP TS 32.300 "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [7] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [8] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [10] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [11] Void +- [12] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [13] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For terms and definitions please refer to TS 32.101 [1], TS 32.102 [2] and TS 28.705 [3]. + +For the purposes of the present document, the following XML terms and definitions apply: + +**XML file:** See definition of [5]. + +**XML document:** See definition of [5]. + +**XML declaration:** See definition of [5]. + +**XML element:** See definition of [5]. + +**empty XML element:** See definition of [5]. + +**XML content (of an XML element):** See definition of [5]. + +**XML start-tag:** See definition of [5]. + +**XML end-tag:** See definition of [5]. + +**XML empty-element tag:** See definition of [5]. + +**XML attribute specification:** See definition of [5]. + +**DTD:** See definition of [5]. + +**XML schema:** See definition of [5]. + +**XML namespace:** See definition of [5]. + +**XML complex type:** See definition of [5]. + +**XML element type:** See definition of [5]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IDL | Interface Definition Language (OMG) | +| IMS | IP Multimedia Subsystem | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MGW | Media GateWay | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set definitions + +This specification defines the following 3GPP IMS NRM IRP Solution Set definitions: + +- 3GPP IMS NRM IRP CORBA SS (Annex A) +- 3GPP IMS NRM IRP XML definitions (Annex B) + +# Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in IMS NRM IRP: Information Service (TS 28.705 [3]). + +## A.1 Architectural Features + +The overall architectural feature of IMS NRM IRP is specified in 3GPP TS 28.705[3]. + +This clause specifies features that are specific to the CORBA SS. + +### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [5]. + +A.1.2 Rules for NRM extensions. +See clause A.1.2 of [5]. + +### A.1.3 Notifications + +Notifications are sent according to the Notification IRP: CORBA SS (see 3GPP TS 32.306 [4]). + +## A.2 Mapping + +### A.2.1 General mappings + +See clause A.2.1 of [5]. + +### A.2.2 Information Object Class (IOC) mapping + +#### A.2.2.1 IOC ASFunction + +**Mapping from NRM IOC ASFunction attributes to SS equivalent MOC ASFunction** + +| Attributes of IOC ASFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|-----------------------------------------------|---------------|---------------------------------------------------------------|--------------| +| id | asFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.2 IOC BGCFFunction + +**Mapping from NRM IOC BGCFFunction attributes to SS equivalent MOC BGCFFunction** + +| Attributes of IOC BGCFFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|-------------------------------------------------|----------------|---------------------------------------------------------------|--------------| +| id | bgcfFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.3 IOC CSCFFunction + +##### Mapping from NRM IOC CSCFFunction attributes to SS equivalent MOC CSCFFunction + +| Attributes of IOC CSCFFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|-------------------------------------------------|----------------|---------------------------------------------------------------|--------------| +| id | cscfFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.4 IOC HSSFunction + +##### Mapping from NRM IOC HSSFunction attributes to SS equivalent MOC HSSFunction + +| Attributes of IOC HSSFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|------------------------------------------------|---------------|---------------------------------------------------------------|--------------| +| id | hssFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.5 IOC IMSMGWFunction + +##### Mapping from NRM IOC IMSMGWFunction attributes to SS equivalent MOC IMSMGWFunction attributes + +| Attributes of IOC IMSMGWFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|---------------------------------------------------|------------------|---------------------------------------------------------------|--------------| +| id | imsMgwFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.6 IOC MGCFFunction + +###### Mapping from NRM IOC MGCFFunction attributes to SS equivalent MOC MGCFFunction + +| Attributes of IOC MGCFFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|-------------------------------------------------|----------------|---------------------------------------------------------------|--------------| +| id | mgcfFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.7 IOC MRFCFunction + +###### Mapping from NRM IOC MRFCFunction attributes to SS equivalent MOC MRFCFunction + +| Attributes of IOC MRFCFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|-------------------------------------------------|----------------|---------------------------------------------------------------|--------------| +| id | mrfcFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.8 IOC MRFPFunction + +###### Mapping from NRM IOC MRFPFunction attributes to SS equivalent MOC MRFPFunction + +| Attributes of IOC MRFPFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|-------------------------------------------------|----------------|---------------------------------------------------------------|--------------| +| id | mrfpFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +##### A.2.2.9 IOC SLFFunction + +###### Mapping from NRM IOC SLFFunction attributes to SS equivalent MOC SLFFunction + +| Attributes of IOC SLFFunction in TS 28.705 [3] | SS Attributes | SS Type | Qualifier | +|------------------------------------------------|---------------|---------------------------------------------------------------|--------------| +| id | slfFunctionId | string | Read-Only, M | +| linkList | linkList | GenericNetworkResourcesIRPSystem::AttributeTypes::LinkListSet | Read-Only, O | + +#### A.2.2.10 IOC Link\_CAMELIMSSFAS\_HSS + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.11 IOC Link\_AS\_ICSCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.12 IOC Link\_AS\_SCSCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.13 IOC Link\_AS\_SLF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.14 IOC Link\_BGCF\_BGCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.15 IOC Link\_BGCF\_MGCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.16 IOC Link\_BGCF\_SCSCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.17 IOC Link\_HSS\_ICSCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.18 IOC Link\_ICSCF\_SCSCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.19 IOC Link\_ICSCF\_MGCF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.20 IOC Link\_ICSCF\_PCSCF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.21 IOC Link\_PCSCF\_SCSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.22 IOC Link\_HSS\_SCSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.23 IOC Link\_ICSCF\_SLF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.24 IOC Link\_IMSMGW\_MGCF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.25 IOC Link\_MGCF\_SCSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.26 IOC Link\_MRFC\_MRFP** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +##### **A.2.2.27 IOC Link\_MRFC\_SCSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +##### **A.2.2.28 IOC Link\_SCSF\_SCSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +##### **A.2.2.29 IOC Link\_SCSF\_SLF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.30 IOC Link\_HSS\_SIPAS** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.31 IOC Link\_HSS\_OSASCSAS** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.32 IOC Link\_PCSCF\_ECSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### **A.2.2.33 IOC Link\_BGCF\_ECSF** + +All attributes are inherited from **Link**. See mapping of attributes for **Link** IOC in 3GPP TS 28.623 [5]. + +#### A.2.2.34 IOC Link\_MGCF\_ECSCF + +All attributes are inherited from Link. See mapping of attributes for Link IOC in 3GPP TS 28.623 [5]. + +document may not be subclassed or extended. New interfaces may be defined with vendor-specific methods. + +--- + +## A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the IMS NRM IRP. + +### A.3.2 IDL specification “IMSNRMDefs.idl” + +``` +// File: IMSNRMDefs.idl +#ifndef _IMSNRMDEFS_IDL_ +#define _IMSNRMDEFS_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" + +#pragma prefix "3gppsa5.org" + +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module IMSNRMDefs +{ + /** + * Definitions for MO class ASFunction + */ + interface ASFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ASFunction"; + + // Attribute Names + // + const string asFunctionId = "asFunctionId"; + const string linkList = "linkList"; + }; + + /** + * Definitions for MO class SIPASFunction + */ + interface SIPASFunction : ASFunction + { + const string CLASS = "SIPASFunction"; + + // All Attributes inherited from ASFunction + }; + + /** + * Definitions for MO class OSASCSASFunction + */ + interface OSASCSASFunction : ASFunction + { + const string CLASS = "OSASCSASFunction"; + + // All Attributes inherited from ASFunction + }; + + /** + * Definitions for MO class CAMELIMSSFASFunction + */ + interface CAMELIMSSFASFunction : ASFunction + { + const string CLASS = "CAMELIMSSFASFunction"; + + // All Attributes inherited from ASFunction + }; + + /** + * Definitions for MO class BGCFFunction + */ + interface BGCFFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "BGCFFunction"; + + // Attribute Names + // + const string bgcfFunctionId = "bgcfFunctionId"; + const string linkList = "linkList"; + }; + + /** + * Definitions for MO class CSCFFunction + */ + interface CSCFFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "CSCFFunction"; + // Attribute Names + // + const string cscfFunctionId = "cscfFunctionId"; + const string linkList = "linkList"; + }; +}; +``` + +``` +/** + * Definitions for MO class ICSCFFunction + */ +interface ICSCFFunction : CSCFFunction +{ + const string CLASS = "ICSCFFunction"; + + // All Attributes inherited from CSCFFunction + // +}; + +/** + * Definitions for MO class IMSMGWFunction + */ +interface IMSMGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "IMSMGWFunction"; + + // Attribute Names + // + const string imsMgwFunctionId = "imsMgwFunctionId"; + const string linkList = "linkList"; +}; + +/** + * Definitions for MO class MGCFFunction + */ +interface MGCFFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MGCFFunction"; + + // Attribute Names + // + const string mgcfFunctionId = "mgcfFunctionId"; + const string linkList = "linkList"; +}; + +/** + * Definitions for MO class MRFCFunction + */ +interface MRFCFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MRFCFunction"; + + // Attribute Names + // + const string mrfcFunctionId = "mrfcFunctionId"; + const string linkList = "linkList"; +}; + +/** + * Definitions for MO class MRFPFunction + */ +interface MRFPFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MRFPFunction"; + + // Attribute Names + // + const string mrfpFunctionId = "mrfpFunctionId"; + const string linkList = "linkList"; +}; + +/** + * Definitions for MO class PCSCFFunction + */ +interface PCSCFFunction : CSCFFunction +{ + const string CLASS = "PCSCFFunction"; + // All Attributes inherited from CSCFFunction + // +}; + +/** + * Definitions for MO class SCSCFFunction + */ +interface SCSCFFunction : CSCFFunction +{ + const string CLASS = "SCSCFFunction"; + + // All Attributes inherited from CSCFFunction + // +}; + +/** + * Definitions for MO class SLFFunction + */ +``` + +``` +*/ +interface SLFFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "SLFFunction"; + + // Attribute Names + // + const string slfFunctionId = "slfFunctionId"; + const string linkList = "linkList"; +}; + +/** + * Definitions for MO class ECSCFFunction + */ +interface ECSCFFunction : CSCFFunction +{ + const string CLASS = "ECSCFFunction"; + // All Attributes inherited from CSCFFunction + // +}; + +/** + * Definitions for MO class Link_AS_SCSCF + */ +interface Link_AS_SCSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_AS_SCSCF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_AS_SLF + */ +interface Link_AS_SLF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_AS_SLF"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_BGCF_BGCF + */ +interface Link_BGCF_BGCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_BGCF_BGCF"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_BGCF_MGCF + */ +interface Link_BGCF_MGCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_BGCF_MGCF"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_BGCF_SCSCF + */ +interface Link_BGCF_SCSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_BGCF_SCSCF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_SCSCF_ICSCF + */ +interface Link_SCSCF_ICSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_SCSCF_ICSCF"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_ICSCF_Mgcf + */ +interface Link_ICSCF_Mgcf : GenericNetworkResourcesNRMDefs::Link +``` + +``` +{ + const string CLASS = "Link_ICSCF_Mgcf"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_ICSCF_PCSF + */ +interface Link_ICSCF_PCSF: GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_ICSCF_PCSF"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_PCSF_SCSF + */ +interface Link_PCSF_SCSF: GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_PCSF_SCSF"; + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_ICSCF_SLF + */ +interface Link_ICSCF_SLF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_ICSCF_SLF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_IMSMGW_MGCF + */ +interface Link_IMSMGW_MGCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_IMSMGW_MGCF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_MGCF_SCSF + */ +interface Link_MGCF_SCSF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MGCF_SCSF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_MRFC_MRFP + */ +interface Link_MRFC_MRFP : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MRFC_MRFP"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_MRFC_SCSF + */ +interface Link_MRFC_SCSF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MRFC_SCSF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_SCSF_SCSF + */ +interface Link_SCSF_SCSF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_SCSF_SCSF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_SCSF_SLF + */ +``` + +``` +interface Link_SCSCF_SLF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_SCSCF_SLF"; + + // All Attributes inherited from Link +}; +/** + * Definitions for MO class HSSFunction + */ +interface HSSFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "HSSFunction"; + + // Attribute Names + // + const string hssFunctionId = "hssFunctionId"; + const string linkList = "linkList"; +}; +/** + * Definitions for MO class Link_HSS_SCSCF + */ +interface Link_HSS_SCSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_HSS_SCSCF"; + + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_HSS_ICSCF + */ +interface Link_HSS_ICSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_HSS_ICSCF"; + + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_HSS_SIPAS + */ +interface Link_HSS_SIPAS : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_HSS_SIPAS"; + + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_HSS_OSASCSAS + */ +interface Link_HSS_OSASCSAS : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_HSS_OSASCSAS"; + + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_CAMELIMSSFAS_HSS + */ +interface Link_CAMELIMSSFAS_HSS : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_CAMELIMSSFAS_HSS"; + + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_AS_ICSCF + */ +interface Link_AS_ICSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_AS_ICSCF"; + + // All Attributes inherited from Link +}; + +/** + * Definitions for MO class Link_PCSCF_ECSCF + */ +interface Link_PCSCF_ECSCF : GenericNetworkResourcesNRMDefs::Link +``` + +``` +{ + const string CLASS = "Link_PCSCF_ECSCF"; + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_BGCF_ECSCF + */ +interface Link_BGCF_ECSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_BGCF_ECSCF"; + // All Attributes inherited from Link +}; +/** + * Definitions for MO class Link_MGCF_ECSCF + */ +interface Link_MGCF_ECSCF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MGCF_ECSCF"; + // All Attributes inherited from Link +}; +}; + +#endif // _IMSNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +This annex provides the NRM-specific part related to the IMS NRM IRP [3] of the XML file format definition for the Bulk Configuration Management IRP IS [8]. + +The main part of this XML file format definition is provided by 3GPP TS 32.616 [9]. + +The XML file formats are based on XML [10], XML Schema [12] [13] and XML Namespace [7] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of IMS NRM IRP is specified in 3GPP TS 28.705 [3]. + +This clause specifies features that are specific to the XML Schema definitions. + +### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [6]. + +## --- B.2 Mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [9]. + +B.3.2 of the present document defines the NRM-specific XML schema `imsNrm.xsd` for the IMS NRM IRP IS defined in 3GPP TS 28.705 [3]. + +XML schema `imsNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [9]. + +### B.3.2 XML Schema “imsNrm.xsd” + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.706 IMS NRM IRP + Bulk CM Configuration data file NRM-specific XML schema + imsNrm.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.706#imsNrm" + elementFormDefault="qualified" + attributeFormDefault="unqualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:im="http://www.3gpp.org/ftp/specs/archive/28_series/28.706#imsNrm" +> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + + <!--IMS NRM IRP IS class associated XML elements --> + + <element + name="ASFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:ASFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + + <element + name="CAMELIMSSSFASFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:ASFunctionOptionallyContainedNrmClass"/> + <element ref="im:CAMELIMSSSFASFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> +``` + +``` +</element> + +<element + name="OSASCSASFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:ASFunctionOptionallyContainedNrmClass"/> + <element ref="im:OSASCSASFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="SIPASFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:ASFunctionOptionallyContainedNrmClass"/> + <element ref="im:SIPASFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="BGCFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:BGCFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + </choice> + </sequence> + </extension> + </complexContent> +</complexType> +</element> + +<element + name="ICSCFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:ICSCFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="IMSMGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:IMSMGWFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="MGCFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> +``` + +``` +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:MGCFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="MRFCFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:MRFCFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="MRFPFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:MRFPFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="PCSCFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + </all> + </complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:PCSCFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="SCSCFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:SCSCFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ECSCFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:ECSCFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="SLFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + +``` + +``` +<element name="userLabel" type="string"/> +<element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> +<element name="linkList" type="xn:linkListType" minOccurs="0"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:SLFFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_AS_SCSCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_AS_SCSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_AS_SLF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_AS_SLFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_BGCF_BGCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> +``` + +``` + + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_BGCF_BGCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_BGCF_MGCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_BGCF_MGCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_BGCF_SCSF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_BGCF_SCSFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_ICSF_SCSF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + +``` + +``` +<complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_ICSCF_SCSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> +</complexContent> +</complexType> +</element> +<element name="Link_ICSCF_MGCF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_ICSCF_MGCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_ICSCF_PCSCF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_ICSCF_PCSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + </complexContent> + </complexType> +</element> + +<element name="Link_PCSCF_SCSCF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_PCSCF_SCSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_ICSCF_SLF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_ICSCF_SLFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_IMSMGW_MGCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_IMSMGW_MGCFOptionallyContainedNrmClass"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` +<element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_MGCF_SCSF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_MGCF_SCSFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_MRFC_MRFP" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_MRFC_MRFPOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_MRFC_SCSF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_MRFC_SCSFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_MRFC_SCSFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> +</complexType> +</element> + +<element name="Link_SCSF_SCSF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_SCSF_SCSFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_SCSF_SLF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_SCSF_SLFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element +name="HSSFunction" +substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + +``` + +``` + + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:HSSFunctionOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_HSS_SCSCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_HSS_SCSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_HSS_ICSCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_HSS_ICSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_HSS_SIPAS" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + +``` + +``` + + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_HSS_SIPASOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_HSS_OSASCSAS" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_HSS_OSASCSASOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_CAMELIMSSFAS_HSS" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_CAMELIMSSFAS_HSSOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_AS_ICSCF" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + +``` + +``` + + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_AS_ICSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> +</complexContent> +</complexType> +</element> + +<element name="Link_PCSF_ECSCF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_PCSF_ECSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_BGCF_ECSCF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_BGCF_ECSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + +<element name="Link_MGCF_ECSCF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string"/> + <element name="zEnd" type="xn:dn"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="im:Link_MGCF_ECSCFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="ASFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="SIPASFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="OSASCSASFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="CAMELIMSSFASFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> + <element name="BGCFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="ICSCFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> + <element name="IMSMGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="MGCFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="MRFCFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="MRFPFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="PCSCFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="SCSCFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="SLFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="ECSCFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_AS_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_AS_SLFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_BGCF_BGCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_BGCF_MGCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_BGCF_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_ICSCF_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_ICSCF_MGCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_ICSCF_PCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_PCSCF_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_ICSCF_SLFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_IMSMGW_MGCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_MGCF_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_MRFC_MRFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_MRFC_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_SCSCF_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_SCSCF_SLFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="HSSFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_HSS_SCSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_HSS_ICSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_HSS_SIPASOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_HSS_OSASCSAOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> + <element name="Link_CAMELIMSSFAS_HSSOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> + <element name="Link_AS_ICSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_PCSCF_ECSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_BGCF_ECSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + <element name="Link_MGCF_ECSCFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140332 | 0001 | - | | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140360 | 0002 | - | | remove the feature support statements | 11.1.0 | +| 2014-09 | SA#65 | SP-140560 | 0003 | - | | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 2016-01 | SA#70 | | | | | Update to Rel-13 (MCC) | 13.0.0 | +| 2016-03 | SA#71 | SP-160031 | 0006 | - | | Make the XML schema well formed | 13.1.0 | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.2.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0008 | - | F | Update the link from IRP Solution Set to IRP Information Service | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0009 | - | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28707/raw.md b/marked/Rel-16/28_series/28707/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..34afed38dfa5c401d50adfd55e7fa41b57197dab --- /dev/null +++ b/marked/Rel-16/28_series/28707/raw.md @@ -0,0 +1,169 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Requirements ..... | 7 | +| 4.1 General Requirement..... | 7 | +| 4.2 Business Level Requirement..... | 7 | +| Annex A (informative): Change history..... | 8 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +- 28.707: "Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".** +- 28.708: "Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- 28.709: "Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the Requirements for the EPC Network Resource Model (NRM) IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [5] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [6] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [7] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service". +- [8] 3GPP TS 37.340: "NR; Multi-connectivity; Overall description; Stage 2". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Data:** is any information or set of information required to give software or equipment or combinations thereof a specific state of functionality. + +**Element Manager (EM):** provides a package of end-user functions for management of a set of closely related types of Network Elements (NEs). These functions can be divided into two main categories: + +- *Element Management Functions* for management of NEs on an individual basis. These are basically the same functions as supported by the corresponding local terminals. +- *Sub-Network Management Functions* that are related to a network model for a set of NEs constituting a clearly defined sub-network, which may include relations between the NEs. This model enables additional functions on the sub-network level (typically in the areas of network topology presentation, alarm correlation, service impact analysis and circuit provisioning). + +**Information Object Class (IOC):** See definition in TS 28.622 [7]. + +**Integration Reference Point (IRP):** See 3GPP TS 32.150 [4]. + +**Information Service (IS):** See 3GPP TS 32.150 [4]. + +**Solution Set (SS):** See 3GPP TS 32.150 [4]. + +**IRP Solution Set:** See 3GPP TS 32.101 [1]. + +**Managed Object (MO):** an abstract entity, which may be accessed through an open interface between two or more systems, and representing a Network Resource (NR) for the purpose of management. The Managed Object (MO) is an instance of a Managed Object Class (MOC) as defined in a Management Information Model (MIM). The MIM does not define how the MO or NR is implemented; only what can be seen in the interface. + +**Managed Object Class (MOC):** a description of all the common characteristics for a number of MOs, such as their attributes, operations, notifications and behaviour. + +**Management Information Model (MIM):** also referred to as NRM – see the definition below. There is a slight difference between the meaning of MIM and NRM – the term MIM is generic and can be used to denote any type of management model, while NRM denotes the model of the actual managed telecommunications Network Resources (NRs). + +**Network Element (NE):** is a discrete telecommunications entity, which can be, managed over a specific interface e.g. the RNC. + +**Network Manager (NM):** provides a package of end-user functions with the responsibility for the management of a network, mainly as supported by the EM(s) but it may also involve direct access to the NEs. All communication with the network is based on open and well-standardised interfaces supporting management of multi-vendor and multi-technology NEs. + +**Network Resource (NR):** is a component of a NE, which can be identified as a discrete separate entity and is in an object oriented environment for the purpose of management represented by an abstract entity called Managed Object (MO). + +**Network Resource Model (NRM):** See definition in TS 28.622 [7]. + +**Object Management Group (OMG):** see <http://www.omg.org>. + +**Operations System (OS):** indicates a generic management system, independent of its location level within the management hierarchy. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|----------------------------------------------------| +| 5GS | 5G System | +| CM | Configuration Management | +| EDGE | Enhanced Data Rate for GSM Evolution | +| E-MBMS | Evolved Multimedia Broadcast Multicast Service | +| EN-DC | E-UTRA-NR Dual Connectivity | +| EPC | Evolved Packet Core | +| EPS | Evolved Packet System | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| GERAN | GSM/EDGE Radio Access Network | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service (see [1]) | +| MME | Mobility Management Entity | +| MOC | Managed Object Class | +| NE | Network Element | +| NR | New Radio | +| NRM | Network Resource Model | +| OS | Operations System | +| UTRAN | Universal Terrestrial Radio Access Network | + +# --- 4 Requirements + +## 4.1 General Requirement + +The following general requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [1]. +- b) IRP-related requirements in 3GPP TS 32.102 [2]. +- c) IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [5] and its information is derived from FNIM Umbrella Information Model (UIM) [6]. + +## 4.2 Business Level Requirement + +In addition to the general requirement, the following more specific requirements apply: + +- 1) The Network Resource Model defined by this IRP shall contain EPC specific IOCs and related definitions, supporting EPC Network entities in the 3GPP Release. +- 2) The Network Resource Model defined by this IRP shall contain MME pool management specific IOCs and related definitions. +- 3) The Network Resource Model defined by this IRP shall contain E-MBMS specific IOCs and related definitions. +- 4) The Network Resource Model defined by this IRP shall contain EPC specific IOCs and related interaction relation definition, supporting the management of communication between EPC and 3GPP access (including E-UTRAN and EN-DC (see 3GPP TS 37.340 [8])), trusted non-3GPP access and untrusted non-3GPP access. +- 5) The Network Resource Model defined by this IRP shall contain EPC specific IOCs and related interaction relation definition, supporting the EPS/5GS interworking management in EPC side. + +# --- Annex A (informative): Change history + +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +|---------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------|---------------| +| 2014-06 | SA#64 | SP-140360 | 0001 | F | | remove the feature support statements | 11.1.0 | +| 2014-10 | - | - | - | - | | Update to Rel-12 version (MCC) | 12.0.0 | +| 2016-01 | - | - | - | - | | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | SA#80 | SP-180421 | 0003 | - | B | Add requirements to support management of EN-DC and 5G interworking in EPC side | 15.0.0 | +| 2020-07 | - | - | - | - | | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28708/raw.md b/marked/Rel-16/28_series/28708/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..85296c0723216afd65cb6e3565aa2995b45bfbf4 --- /dev/null +++ b/marked/Rel-16/28_series/28708/raw.md @@ -0,0 +1,1239 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Model ..... | 9 | +| 4.1 Imported information entities and local labels..... | 9 | +| 4.2 Class diagram ..... | 9 | +| 4.2.1 Relationships ..... | 9 | +| 4.2.2 Inheritance ..... | 13 | +| 4.3 Class definitions ..... | 16 | +| 4.3.1 EPDGFunction ..... | 16 | +| 4.3.1.1 Definition ..... | 16 | +| 4.3.2 MMEFunction..... | 16 | +| 4.3.2.1 Definition ..... | 16 | +| 4.3.2.2 Attributes ..... | 16 | +| 4.3.2.3 Attribute constraints..... | 16 | +| 4.3.2.4 Notifications..... | 16 | +| 4.3.3 PCRFFunction ..... | 16 | +| 4.3.3.1 Definition ..... | 16 | +| 4.3.4 PGWFunction..... | 17 | +| 4.3.4.1 Definition ..... | 17 | +| 4.3.4.2 Attributes ..... | 17 | +| 4.3.4.3 Attribute constraints..... | 17 | +| 4.3.4.4 Notifications..... | 17 | +| 4.3.5 ServingGWFunction ..... | 17 | +| 4.3.5.1 Definition ..... | 17 | +| 4.3.5.2 Attributes ..... | 17 | +| 4.3.5.3 Attribute constraints..... | 17 | +| 4.3.5.4 Notifications..... | 17 | +| 4.3.6 MMEPool ..... | 17 | +| 4.3.6.1 Definition ..... | 17 | +| 4.3.6.2 Attributes ..... | 18 | +| 4.3.6.3 Attribute constraints..... | 18 | +| 4.3.7 MMEPoolArea..... | 18 | +| 4.3.7.1 Definition ..... | 18 | +| 4.3.7.2 Attributes ..... | 18 | +| 4.3.7.3 Attribute constraints..... | 18 | +| 4.3.8 Link_ENB_MME ..... | 18 | +| 4.3.8.1 Definition ..... | 18 | +| 4.3.9 Link_ENB_ServingGW..... | 18 | +| 4.3.9.1 Definition ..... | 18 | +| 4.3.10 Link_EPDG_PCRF..... | 18 | +| 4.3.10.1 Definition ..... | 18 | +| 4.3.11 Link_EPDG_PGW..... | 19 | +| 4.3.11.1 Definition ..... | 19 | +| 4.3.12 Link_HSS_MME ..... | 19 | +| 4.3.12.1 Definition ..... | 19 | +| 4.3.13 Link_MME_MME ..... | 19 | +| 4.3.13.1 Definition ..... | 19 | +| 4.3.14 Link_MME_SGSN..... | 19 | +| 4.3.14.1 Definition ..... | 19 | + +| | | | +|----------|---------------------------------|----| +| 4.3.15 | Link_MME_ServingGW..... | 19 | +| 4.3.15.1 | Definition..... | 19 | +| 4.3.16 | Link_PCRF_ServingGW..... | 19 | +| 4.3.16.1 | Definition..... | 19 | +| 4.3.17 | Link_PCRF_PGW..... | 19 | +| 4.3.17.1 | Definition..... | 19 | +| 4.3.18 | Link_PGW_ServingGW..... | 19 | +| 4.3.18.1 | Definition..... | 19 | +| 4.3.19 | Link_SGSN_ServingGW..... | 20 | +| 4.3.19.1 | Definition..... | 20 | +| 4.3.20 | EP_RP_EPS..... | 20 | +| 4.3.20.1 | Definition..... | 20 | +| 4.3.20.2 | Attributes ..... | 20 | +| 4.3.20.3 | Attribute constraints..... | 20 | +| 4.3.20.4 | Notifications..... | 20 | +| 4.3.21 | ExternalServingGWFunction ..... | 20 | +| 4.3.21.1 | Definition..... | 20 | +| 4.3.21.2 | Attributes ..... | 20 | +| 4.3.21.3 | Attribute constraints..... | 20 | +| 4.3.21.4 | Notifications..... | 20 | +| 4.3.22 | ExternalMMEFunction..... | 21 | +| 4.3.22.1 | Definition..... | 21 | +| 4.3.22.2 | Attributes ..... | 21 | +| 4.3.22.3 | Attribute constraints..... | 21 | +| 4.3.22.4 | Notifications..... | 21 | +| 4.3.23 | IOC_QCISet ..... | 21 | +| 4.3.23.1 | Definition..... | 21 | +| 4.3.23.2 | Attributes ..... | 21 | +| 4.3.23.3 | Attribute constraints..... | 21 | +| 4.3.23.4 | Notifications..... | 21 | +| 4.3.24 | MBMSGWFunction..... | 21 | +| 4.3.24.1 | Definition..... | 21 | +| 4.3.24.2 | Attributes ..... | 22 | +| 4.3.25 | Link_MBMSGW_ENB ..... | 22 | +| 4.3.25.1 | Definition..... | 22 | +| 4.3.26 | PGWCFunction ..... | 22 | +| 4.3.26.1 | Definition..... | 22 | +| 4.3.26.2 | Attributes ..... | 22 | +| 4.3.26.3 | Attribute constraints..... | 22 | +| 4.3.26.4 | Notifications..... | 22 | +| 4.3.27 | PGWUFunction ..... | 22 | +| 4.3.27.1 | Definition..... | 22 | +| 4.3.27.2 | Attributes ..... | 22 | +| 4.3.27.3 | Attribute constraints..... | 22 | +| 4.3.27.4 | Notifications..... | 22 | +| 4.3.28 | ServingGwCFunction..... | 23 | +| 4.3.28.1 | Definition..... | 23 | +| 4.3.28.2 | Attributes ..... | 23 | +| 4.3.28.3 | Attribute constraints..... | 23 | +| 4.3.28.4 | Notifications..... | 23 | +| 4.3.29 | ServingGwUFunction..... | 23 | +| 4.3.29.1 | Definition..... | 23 | +| 4.3.29.2 | Attributes ..... | 23 | +| 4.3.29.3 | Attribute constraints..... | 23 | +| 4.3.29.4 | Notifications..... | 23 | +| 4.3.30 | ExternalServingGwCFunction..... | 23 | +| 4.3.30.1 | Definition..... | 23 | +| 4.3.30.2 | Attributes ..... | 23 | +| 4.3.30.3 | Attribute constraints..... | 24 | +| 4.3.30.4 | Notifications..... | 24 | + +| | | | +|------------------------|----------------------------------|----| +| 4.3.31 | ExternalServingGwUFunction..... | 24 | +| 4.3.31.1 | Definition ..... | 24 | +| 4.3.31.2 | Attributes ..... | 24 | +| 4.3.31.3 | Attribute constraints..... | 24 | +| 4.3.31.4 | Notifications..... | 24 | +| 4.3.32 | ExternalPGWCFunction ..... | 24 | +| 4.3.32.1 | Definition ..... | 24 | +| 4.3.32.2 | Attributes ..... | 24 | +| 4.3.32.3 | Attribute constraints..... | 24 | +| 4.3.32.4 | Notifications..... | 24 | +| 4.3.33 | ExternalPGWUFunction ..... | 25 | +| 4.3.33.1 | Definition ..... | 25 | +| 4.3.33.2 | Attributes ..... | 25 | +| 4.3.33.3 | Attribute constraints..... | 25 | +| 4.3.33.4 | Notifications..... | 25 | +| 4.4 | Attribute definitions ..... | 25 | +| 4.4.1 | Attribute properties..... | 25 | +| 4.5 | Common notifications ..... | 27 | +| 4.5.1 | Alarm notifications ..... | 27 | +| 4.5.2 | Configuration notifications..... | 27 | +| Annex A (informative): | Change history..... | 28 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project Technical Specification Group Services and System Aspects, Telecommunication management; as identified below: + +28.707: "Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements"; + +**28.708: "Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)";** + +28.709: "Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions"; + +Configuration Management (CM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. CM actions have the objective to control and monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. + +CM actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimization programme (e.g. modifications), and to maintain the overall Quality of Service (QoS). The CM actions are initiated either as single actions on single NEs of the 3G network, or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document specifies Evolved Packet Core (EPC) network resource information that can be communicated between an IRP Agent and an IRP Manager for telecommunication network management purposes, including management of converged networks. . It reuses relevant parts of the Generic NRM in 3GPP TS 28.622 [6], either by direct reuse or sub-classing, and in addition to that defines EPC specific Information Object Classes. + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +In order to access the information defined by this NRM, an Interface IRP such as the "Basic CM IRP" is needed (3GPP TS 32.602 [7]). However, which Interface IRP is applicable is outside the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [4] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [5] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic Configuration Management Integration Reference Point (IRP): Information Service (IS)". +- [8] 3GPP TS 28.702: " Telecommunication management; Core Network (CN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [9] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [10] 3GPP TS 28.705: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [11] 3GPP TS 28.658: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [12] 3GPP TS 23.402: "Architecture Enhancements for non-3GPP accesses". +- [13] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM; Information service (IS)". + +- [14] 3GPP TS 23.003: " Technical Specification Group Core Network and Terminals; Numbering, addressing and identification". +- [15] 3GPP TR 32.816-160: "Telecommunication management; Study on management of Evolved Universal Terrestrial Radio Access Network (E-UTRAN) and Evolved Packet Core (EPC) ". +- [16] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [17] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". +- [18] 3GPP TS 36.331: " Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [19] 3GPP TS 23.203: "Policy and charging control architecture". +- [20] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [21] 3GPP TS 28.541: "Management and orchestration of networks and network slicing; NR and NG-RAN Network Resource Model (NRM); Stage 2 and stage 3". +- [22] 3GPP TS 28.543: "Management and orchestration of networks and network slicing; 5G Core Network (5GC) Network Resource Model (NRM); Stage 2 and stage 3". +- [23] 3GPP TS 23.214: "Architecture enhancements for control and user plane separation of EPC nodes". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.600 [5] and the following apply: + +**Association:** See definition in TS 28.622 [6]. + +**Managed Element (ME):** See definition in TS 28.622 [6]. + +**Managed Object (MO):** See definition in TS 28.622 [6]. + +**Management Information Model (MIM):** also referred to as NRM - see the definition below. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|----------------------------------------------------| +| CIM | Common Information Model | +| CUPS | Control and User Plane Separation | +| EM | Element Manager | +| eNodeB | evolved NodeB | +| EPC | Evolved Packet Core | +| ePDG | evolved Packet Data Gateway | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| GPRS | General Packet Radio System | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| ME | Managed Element | +| MIM | Management Information Model | + +| | | +|-------|------------------------------------------------------| +| MME | Mobility Management Entity | +| MO | Managed Object | +| NE | Network Element | +| NR | Network Resource | +| NRM | Network Resource Model | +| PCRF | Policy and Charging Rules Function | +| P-GW | PDN Gateway | +| PGW-C | PDN Gateway Control plane function | +| PGW-U | PDN Gateway User plane function | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [4]) | +| S-GW | Serving Gateway | +| SGW-C | Serving Gateway Control plane function | +| SGW-U | Serving Gateway User plane function | +| TMN | Telecom Management Network | +| UML | Unified Modelling Language | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|--------------------------------------------------------------|-----------------| +| TS 28.658 [11], information object class, ENBFunction | ENBFunction | +| TS 28.705 [10], information object class, HssFunction | HssFunction | +| TS 28.622 [6], information object class, Link | Link | +| TS 28.622 [6], information object class, ManagedElement | ManagedElement | +| TS 28.622 [6], information object class, ManagedFunction | ManagedFunction | +| TS 28.632 [8], information object class, SgsnFunction | SgsnFunction | +| TS 28.622 [6], information object class, SubNetwork | SubNetwork | +| TS 28.622 [6], information object class, EP_RP | EP_RP | +| TS 28.541 [21], information object class, ENGNNBFunction | GNBFunction | +| TS 28.541 [21], information object class, ENGNNBCUUPFunction | GNBCUUPFunction | +| TS 28.543 [22], information object class, AMFFunction | AMFFunction | +| TS 28.543 [22], information object class, EP_N26 | EP_N26 | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of IOCs that encapsulate information relevant for this service. This clause provides the overview of the relationships of relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +The figures below show the containment/naming hierarchy and the associations of the information object classes defined in the present document. + +NOTE: The listed cardinality numbers represent transient as well as steady-state numbers, and reflect all managed object creation and deletion scenarios in all figures. + +Each IOC is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [4] that expresses its containment hierarchy. As an example, the DN of an IOC representing a MME (3GPP TS 23.401 [9]) could have a format like: + +``` +SubNetwork=China, MeContext =MEC-Gbg-1, ManagedElement =MME-Gbg-1, +MMEFunction=MME-1. +``` + +![UML Class Diagram showing containment and naming relationships for EPC NRM. SubNetwork (from 28.622) is the root class, containing ExternalMMEFunction, ManagedElement, and ExternalServingGwFunction. ManagedElement contains EPDGFunction, MMFunction, PCRFFunction, and ServingGwFunction. PGWFunction is also shown at the bottom level.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +classDiagram + class SubNetwork { + <<InformationObjectClass>> + (from 28.622) + } + class ExternalMMEFunction { + <<InformationObjectClass>> + } + class ManagedElement { + <<InformationObjectClass>> + } + class ExternalServingGwFunction { + <<InformationObjectClass>> + } + class EPDGFunction { + <<InformationObjectClass>> + } + class MMFunction { + <<InformationObjectClass>> + } + class PCRFFunction { + <<InformationObjectClass>> + } + class ServingGwFunction { + <<InformationObjectClass>> + } + class PGWFunction { + <<InformationObjectClass>> + } + + SubNetwork "1" *-- "*" ExternalMMEFunction : names + SubNetwork "1" *-- "*" ManagedElement : names + SubNetwork "1" *-- "*" ExternalServingGwFunction : names + ManagedElement "1" *-- "*" EPDGFunction : names + ManagedElement "1" *-- "*" MMFunction : names + ManagedElement "1" *-- "*" PCRFFunction : names + ManagedElement "1" *-- "*" ServingGwFunction : names + PGWFunction "1" *-- "*" ExternalMMEFunction : names + PGWFunction "1" *-- "*" ExternalServingGwFunction : names + PGWFunction "1" *-- "*" EPDGFunction : names + PGWFunction "1" *-- "*" MMFunction : names + PGWFunction "1" *-- "*" PCRFFunction : names + PGWFunction "1" *-- "*" ServingGwFunction : names + +``` + +UML Class Diagram showing containment and naming relationships for EPC NRM. SubNetwork (from 28.622) is the root class, containing ExternalMMEFunction, ManagedElement, and ExternalServingGwFunction. ManagedElement contains EPDGFunction, MMFunction, PCRFFunction, and ServingGwFunction. PGWFunction is also shown at the bottom level. + +Figure 4.2.1-1: EPC NRM Containment/Naming Relationships + +![UML Class Diagram showing containment, naming, and association relationships for EPC NRM. It includes classes like HssFunction, Link_MME_Sgan, Link_HSS_MME, SganFunction, Link_SGAN_ServingGW, Link_MME_ServingGW, Link_MME_MME, Link_PGW_ServingGW, Link_PCRF_ServingGW, PGWFunction, Link_PCRF_PGW, Link_EPDG_PGW, Link_EPDG_PCRF, and PCRFFunction. Reference points S3, S6a, S10, S4, S11, S5, Gx, Gxb, and S2b are indicated by note boxes.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +``` + +classDiagram + class HssFunction { + <<InformationObjectClass>> + (from 28.705) + } + class Link_MME_Sgan { + <<InformationObjectClass>> + } + class Link_HSS_MME { + <<InformationObjectClass>> + } + class SganFunction { + <<InformationObjectClass>> + (from 28.702) + } + class Link_SGAN_ServingGW { + <<InformationObjectClass>> + } + class Link_MME_ServingGW { + <<InformationObjectClass>> + } + class Link_MME_MME { + <<InformationObjectClass>> + } + class Link_PGW_ServingGW { + <<InformationObjectClass>> + } + class Link_PCRF_ServingGW { + <<InformationObjectClass>> + } + class PGWFunction { + <<InformationObjectClass>> + } + class Link_PCRF_PGW { + <<InformationObjectClass>> + } + class Link_EPDG_PGW { + <<InformationObjectClass>> + } + class Link_EPDG_PCRF { + <<InformationObjectClass>> + } + class PCRFFunction { + <<InformationObjectClass>> + } + class EPDGFunction { + <<InformationObjectClass>> + } + class MMFunction { + <<InformationObjectClass>> + } + class ServingGwFunction { + <<InformationObjectClass>> + } + + HssFunction "1" *-- "*" Link_MME_Sgan : S3 ref point + HssFunction "1" *-- "*" Link_HSS_MME : S6a ref point + SganFunction "1" *-- "*" Link_SGAN_ServingGW + SganFunction "1" *-- "*" Link_MME_ServingGW + Link_MME_ServingGW "1" *-- "*" Link_MME_MME : S10 ref point + Link_MME_ServingGW "1" *-- "*" Link_PCRF_ServingGW : S11 ref point + Link_PGW_ServingGW "1" *-- "*" Link_PCRF_ServingGW : S5 ref point + Link_PGW_ServingGW "1" *-- "*" Link_PCRF_PGW : Gx ref point + Link_PGW_ServingGW "1" *-- "*" Link_EPDG_PGW : S2b ref point + Link_PCRF_ServingGW "1" *-- "*" Link_PCRF_PGW : Gxb ref point + Link_PCRF_ServingGW "1" *-- "*" Link_EPDG_PCRF : Gxb ref point + PGWFunction "1" *-- "*" Link_PGW_ServingGW + PGWFunction "1" *-- "*" Link_PCRF_PGW + PGWFunction "1" *-- "*" Link_EPDG_PGW + PGWFunction "1" *-- "*" Link_EPDG_PCRF + PCRFFunction "1" *-- "*" Link_PCRF_ServingGW + PCRFFunction "1" *-- "*" Link_PCRF_PGW + PCRFFunction "1" *-- "*" Link_EPDG_PCRF + EPDGFunction "1" *-- "*" Link_EPDG_PGW + EPDGFunction "1" *-- "*" Link_EPDG_PCRF + MMFunction "1" *-- "*" Link_MME_ServingGW + ServingGwFunction "1" *-- "*" Link_PGW_ServingGW + ServingGwFunction "1" *-- "*" Link_PCRF_ServingGW + +``` + +UML Class Diagram showing containment, naming, and association relationships for EPC NRM. It includes classes like HssFunction, Link\_MME\_Sgan, Link\_HSS\_MME, SganFunction, Link\_SGAN\_ServingGW, Link\_MME\_ServingGW, Link\_MME\_MME, Link\_PGW\_ServingGW, Link\_PCRF\_ServingGW, PGWFunction, Link\_PCRF\_PGW, Link\_EPDG\_PGW, Link\_EPDG\_PCRF, and PCRFFunction. Reference points S3, S6a, S10, S4, S11, S5, Gx, Gxb, and S2b are indicated by note boxes. + +Figure 4.2.1-2: EPC NRM Containment/Naming and Association\_1 + +![UML Class Diagram showing relationships between MMEFunction, ServingGwFunction, Link_ENB_MME, ENBFunction, and Link_ENB_ServingGW. MMEFunction and ServingGwFunction are at the top, connected by a horizontal line with '*' at both ends. Link_ENB_MME is on the left, connected to MMEFunction by a vertical line with '*' at the top. Link_ENB_ServingGW is on the right, connected to ServingGwFunction by a vertical line with '*' at the top. ENBFunction is at the bottom center, connected to both MMEFunction and ServingGwFunction by diagonal lines with '*' at the top. A note 'S1-MME ref point' is attached to Link_ENB_MME, and 'S1-U ref point' is attached to Link_ENB_ServingGW.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +UML Class Diagram showing relationships between MMEFunction, ServingGwFunction, Link\_ENB\_MME, ENBFunction, and Link\_ENB\_ServingGW. MMEFunction and ServingGwFunction are at the top, connected by a horizontal line with '\*' at both ends. Link\_ENB\_MME is on the left, connected to MMEFunction by a vertical line with '\*' at the top. Link\_ENB\_ServingGW is on the right, connected to ServingGwFunction by a vertical line with '\*' at the top. ENBFunction is at the bottom center, connected to both MMEFunction and ServingGwFunction by diagonal lines with '\*' at the top. A note 'S1-MME ref point' is attached to Link\_ENB\_MME, and 'S1-U ref point' is attached to Link\_ENB\_ServingGW. + +Figure 4.2.1-3: EPC NRM Containment/Naming and Association\_2 + +![UML Class Diagram showing containment and association relationships for various network functions. MMEFunction, ServingGwFunction, PGWFunction, PCRFFunction, and EPDGFunction are shown as InformationObjectClass boxes. Each has a composition relationship with EP_RP_EPS (InformationObjectClass) with a '1' at the function and '*' at EP_RP_EPS. Each EP_RP_EPS has an association with a corresponding ProxyClass (FarEnd_EPSNE1 to FarEnd_EPSNE5) with a '1' at EP_RP_EPS and '0..1' at the ProxyClass. Notes on the right explain the ProxyClasses: FarEnd_EPSNE1 (HssFunction, MMEFunction, SgsnFunction, ServingGwFunction, ExternalServingGwFunction, or ENBFunction), FarEnd_EPSNE2 (MMEFunction, SgsnFunction, PGWFunction, PCRFFunction, ENBFunction, GNBFFunction, or GNBCUUPFunction), FarEnd_EPSNE3 (ServingGwFunction, PGWFunction, or EPDGFunction), FarEnd_EPSNE4 (ServingGwFunction, PGWFunction, or EPDGFunction), and FarEnd_EPSNE5 (PGWFunction or PCRFFunction).](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +UML Class Diagram showing containment and association relationships for various network functions. MMEFunction, ServingGwFunction, PGWFunction, PCRFFunction, and EPDGFunction are shown as InformationObjectClass boxes. Each has a composition relationship with EP\_RP\_EPS (InformationObjectClass) with a '1' at the function and '\*' at EP\_RP\_EPS. Each EP\_RP\_EPS has an association with a corresponding ProxyClass (FarEnd\_EPSNE1 to FarEnd\_EPSNE5) with a '1' at EP\_RP\_EPS and '0..1' at the ProxyClass. Notes on the right explain the ProxyClasses: FarEnd\_EPSNE1 (HssFunction, MMEFunction, SgsnFunction, ServingGwFunction, ExternalServingGwFunction, or ENBFunction), FarEnd\_EPSNE2 (MMEFunction, SgsnFunction, PGWFunction, PCRFFunction, ENBFunction, GNBFFunction, or GNBCUUPFunction), FarEnd\_EPSNE3 (ServingGwFunction, PGWFunction, or EPDGFunction), FarEnd\_EPSNE4 (ServingGwFunction, PGWFunction, or EPDGFunction), and FarEnd\_EPSNE5 (PGWFunction or PCRFFunction). + +Figure 4.2.1-4: EPC NRM Containment/Naming and Association3 + +![UML Class Diagram: MME Pool Object Model of EPC NRM](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +This UML class diagram illustrates the MME Pool Object Model of EPC NRM. It features four classes: **SubNetwork** (from 28.622), **MMEPoolArea**, **MMEPool**, and **MEFunction**. **SubNetwork** is the central entity, which has a composition relationship with **MMEPool** (multiplicity 1 to \*) and a naming association with **MMEPoolArea** (multiplicity 1 to \*). **MMEPool** is associated with **MEFunction** (multiplicity 0.1 to \*) and **ExternalMEFunction** (multiplicity 0.1 to \*). Associations are labeled with role names like **+ mMEPool**, **+ mMEPoolArea**, and **+ mMEPoolMemberList**. + +UML Class Diagram: MME Pool Object Model of EPC NRM + +Figure 4.2.1-5 MME Pool Object Model of EPC NRM + +![UML Class Diagram: SubNetwork and QCISet relationship](7f17c430b9598e4d748a8041457810b3_img.jpg) + +This UML class diagram shows a relationship between **SubNetwork** (from 28.622) and **QCISet**. **SubNetwork** has a composition relationship with **QCISet** (multiplicity 1 to 0..1). The association is labeled with **«names»**. + +UML Class Diagram: SubNetwork and QCISet relationship + +NOTE: Void. + +Figure 4.2.1-6: EPC NRM Containment/Naming and Association 3 + +![UML Class Diagram: ENBFunction, ManagedElement, Link_MBMSGW_ENB, and MBMSGWFunction relationships](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +This UML class diagram depicts relationships between four classes: **ENBFunction** (from 28.658), **ManagedElement** (from 28.622), **Link\_MBMSGW\_ENB**, and **MBMSGWFunction**. **ENBFunction** is associated with **Link\_MBMSGW\_ENB** (multiplicity \* to \*) and **MBMSGWFunction** (multiplicity \* to \*). **ManagedElement** has a composition relationship with **Link\_MBMSGW\_ENB** (multiplicity 1 to \*). The association between **ManagedElement** and **Link\_MBMSGW\_ENB** is labeled with **«names»**. A note labeled **M1 ref point** is attached to **Link\_MBMSGW\_ENB**. + +UML Class Diagram: ENBFunction, ManagedElement, Link\_MBMSGW\_ENB, and MBMSGWFunction relationships + +Figure 4.2.1-7: EPC NRM Containment/Naming and Association 4 + +![UML Class Diagram for Figure 4.2.1-7 showing containment and naming associations between SubNetwork and various EPC functions.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +This UML class diagram illustrates the containment and naming relationships for EPC NRM. At the top is the **SubNetwork** class (from 28.622). It has a 1-to-many containment relationship with **ExternalPGWCFFunction** and **ExternalPGWUFunction** (both labeled with <<names>>). It also has a 1-to-many containment relationship with **ManagedElement** (labeled with <<names>>). Below **ManagedElement**, there are four classes: **PGWUFunction**, **PGWCFFunction**, **ServingGwUFunction**, and **ServingGwCFFunction**. Each of these four classes has a 1-to-many containment relationship with **ManagedElement** (labeled with <<names>>). + +UML Class Diagram for Figure 4.2.1-7 showing containment and naming associations between SubNetwork and various EPC functions. + +Figure 4.2.1-8: EPC NRM Containment/Naming and Association 4 for EPC CUPS + +![UML Class Diagram for Figure 4.2.1-8 showing associations between PGWCFFunction, PGWUFunction, and ServingGwCFFunction with EP_RP_EPS and FarEndNE proxy classes.](ddc7460821484f1ae2835c67955c554c_img.jpg) + +This UML class diagram shows associations for EPC CUPS. It consists of four horizontal associations. Each association starts with a class (**PGWCFFunction**, **PGWUFunction**, **ServingGwCFFunction**, or **ServingGwUFunction**) having a 1-to-many association with **EP\_RP\_EPS** (labeled with <<names>>). Each **EP\_RP\_EPS** class then has a 1-to-1 association with a **FarEndNE** proxy class. The proxy classes are **FarEndNE\_6**, **FarEndNE\_7**, **FarEndNE\_8**, and **FarEndNE\_9**. Each proxy class has a note indicating the functions it represents: + + +- FarEndNE\_6**: This proxy class represents ServingGwCFFunction, or PGWUFunction, or EPDGFunction, or ExternalServingGwCFFunction, or PCRFFunction +- FarEndNE\_7**: This proxy class represents ServingGwCFFunction, or PGWCFFunction, or PGWUFunction, or EPDGFunction +- FarEndNE\_8**: This proxy class represents MMFunction, SGSNFunction, ServingGwUFunction, +- FarEndNE\_9**: This proxy class represents ENBFunction, ServingGwCFFunction, or PGWUFunction, or MMFunction, or SGSNFunction + +UML Class Diagram for Figure 4.2.1-8 showing associations between PGWCFFunction, PGWUFunction, and ServingGwCFFunction with EP\_RP\_EPS and FarEndNE proxy classes. + +Figure 4.2.1-9: EPC NRM Containment/Naming and Association 5 for EPC CUPS + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +The figures below show the inheritance hierarchy for the EPC NRM. + +![UML Class Diagram showing the inheritance hierarchy for ManagedFunction. The base class is '«InformationObjectClass» ManagedFunction (from 28.622)'. Subclasses include: MMEPoolArea, ExternalMMEFunction, EPDGFunction, MMFunction, PCRFFunction, ExternalServingGwFunction, MMEPool, ServingGwFunction, and PGWFunction.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` +classDiagram + class ManagedFunction["«InformationObjectClass»\nManagedFunction\n(from 28.622)"] + class MMEPoolArea["«InformationObjectClass»\nMMEPoolArea"] + class ExternalMMEFunction["«InformationObjectClass»\nExternalMMEFunction"] + class EPDGFunction["«InformationObjectClass»\nEPDGFunction"] + class MMFunction["«InformationObjectClass»\nMMFunction"] + class PCRFFunction["«InformationObjectClass»\nPCRFFunction"] + class ExternalServingGwFunction["«InformationObjectClass»\nExternalServingGwFunction"] + class MMEPool["«InformationObjectClass»\nMMEPool"] + class ServingGwFunction["«InformationObjectClass»\nServingGwFunction"] + class PGWFunction["«InformationObjectClass»\nPGWFunction"] + + MMEPoolArea --|> ManagedFunction + ExternalMMEFunction --|> ManagedFunction + EPDGFunction --|> ManagedFunction + MMFunction --|> ManagedFunction + PCRFFunction --|> ManagedFunction + ExternalServingGwFunction --|> ManagedFunction + MMEPool --|> ManagedFunction + ServingGwFunction --|> ManagedFunction + PGWFunction --|> ManagedFunction +``` + +UML Class Diagram showing the inheritance hierarchy for ManagedFunction. The base class is '«InformationObjectClass» ManagedFunction (from 28.622)'. Subclasses include: MMEPoolArea, ExternalMMEFunction, EPDGFunction, MMFunction, PCRFFunction, ExternalServingGwFunction, MMEPool, ServingGwFunction, and PGWFunction. + +Figure 4.2.2-1: EPC NRM Inheritance Hierarchy\_1 + +![UML Class Diagram showing the inheritance hierarchy for Link. The base class is '«InformationObjectClass» Link (from 28.622)'. Subclasses include: Link_ENB_MME, Link_ENB_ServingGW, Link_EPDG_PCRF, Link_EPDG_PGW, Link_HSS_MME, Link_MME_MME, Link_MBMSGW_ENB, Link_MME_Sgsn, Link_MME_ServingGW, Link_PCRF_PGW, Link_PCRF_ServingGW, Link_PGW_ServingGW, and Link_SGSN_ServingGW.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` +classDiagram + class Link["«InformationObjectClass»\nLink\n(from 28.622)"] + class Link_ENB_MME["«InformationObjectClass»\nLink_ENB_MME"] + class Link_ENB_ServingGW["«InformationObjectClass»\nLink_ENB_ServingGW"] + class Link_EPDG_PCRF["«InformationObjectClass»\nLink_EPDG_PCRF"] + class Link_EPDG_PGW["«InformationObjectClass»\nLink_EPDG_PGW"] + class Link_HSS_MME["«InformationObjectClass»\nLink_HSS_MME"] + class Link_MME_MME["«InformationObjectClass»\nLink_MME_MME"] + class Link_MBMSGW_ENB["«InformationObjectClass»\nLink_MBMSGW_ENB"] + class Link_MME_Sgsn["«InformationObjectClass»\nLink_MME_Sgsn"] + class Link_MME_ServingGW["«InformationObjectClass»\nLink_MME_ServingGW"] + class Link_PCRF_PGW["«InformationObjectClass»\nLink_PCRF_PGW"] + class Link_PCRF_ServingGW["«InformationObjectClass»\nLink_PCRF_ServingGW"] + class Link_PGW_ServingGW["«InformationObjectClass»\nLink_PGW_ServingGW"] + class Link_SGSN_ServingGW["«InformationObjectClass»\nLink_SGSN_ServingGW"] + + Link_ENB_MME --|> Link + Link_ENB_ServingGW --|> Link + Link_EPDG_PCRF --|> Link + Link_EPDG_PGW --|> Link + Link_HSS_MME --|> Link + Link_MME_MME --|> Link + Link_MBMSGW_ENB --|> Link + Link_MME_Sgsn --|> Link + Link_MME_ServingGW --|> Link + Link_PCRF_PGW --|> Link + Link_PCRF_ServingGW --|> Link + Link_PGW_ServingGW --|> Link + Link_SGSN_ServingGW --|> Link +``` + +UML Class Diagram showing the inheritance hierarchy for Link. The base class is '«InformationObjectClass» Link (from 28.622)'. Subclasses include: Link\_ENB\_MME, Link\_ENB\_ServingGW, Link\_EPDG\_PCRF, Link\_EPDG\_PGW, Link\_HSS\_MME, Link\_MME\_MME, Link\_MBMSGW\_ENB, Link\_MME\_Sgsn, Link\_MME\_ServingGW, Link\_PCRF\_PGW, Link\_PCRF\_ServingGW, Link\_PGW\_ServingGW, and Link\_SGSN\_ServingGW. + +Figure 4.2.2-2: EPC NRM Inheritance Hierarchy\_2 + +![UML class diagram showing inheritance hierarchy for EPC NRM. The base class is <<InformationObjectClass>> EP_RP (from 28.622). The derived class is <<InformationObjectClass>> EP_RP_EPS. An inheritance arrow points from the derived class to the base class.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +classDiagram + class EP_RP { + <<InformationObjectClass>> + EP_RP + (from 28.622) + } + class EP_RP_EPS { + <<InformationObjectClass>> + EP_RP_EPS + } + EP_RP_EPS --|> EP_RP +``` + +UML class diagram showing inheritance hierarchy for EPC NRM. The base class is <> EP\_RP (from 28.622). The derived class is <> EP\_RP\_EPS. An inheritance arrow points from the derived class to the base class. + +Figure 4.2.2-3: EPC NRM Inheritance Hierarchy\_3 + +![UML class diagram showing inheritance hierarchy for EPC NRM. The base class is <<InformationObjectClass>> ManagedFunction (from 28.622). The derived class is <<InformationObjectClass>> QCISet. An inheritance arrow points from the derived class to the base class.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction + (from 28.622) + } + class QCISet { + <<InformationObjectClass>> + QCISet + } + QCISet --|> ManagedFunction +``` + +UML class diagram showing inheritance hierarchy for EPC NRM. The base class is <> ManagedFunction (from 28.622). The derived class is <> QCISet. An inheritance arrow points from the derived class to the base class. + +Figure 4.2.2-4: EPC NRM Inheritance Hierarchy\_4 + +![UML class diagram showing inheritance hierarchy for E-UTRAN NRM. The base class is <<InformationObjectClass>> ManagedFunction (from 28.622). The derived class is <<InformationObjectClass>> MBMSGWFunction. An inheritance arrow points from the derived class to the base class.](bffdddb47fced140f8d17fdc2a29f592_img.jpg) + +``` +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction + (from 28.622) + } + class MBMSGWFunction { + <<InformationObjectClass>> + MBMSGWFunction + } + MBMSGWFunction --|> ManagedFunction +``` + +UML class diagram showing inheritance hierarchy for E-UTRAN NRM. The base class is <> ManagedFunction (from 28.622). The derived class is <> MBMSGWFunction. An inheritance arrow points from the derived class to the base class. + +Figure 4.2.2-5: E-UTRAN NRM Inheritance Hierarchy\_5 + +![UML Class Diagram showing the inheritance hierarchy for EPC CUPS. The base class is <<InformationObjectClass>> ManagedFunction (from 28.622). It is inherited by six subclasses: <<InformationObjectClass>> ExternalPGWCFFunction, <<InformationObjectClass>> ExternalPGWUFunction, <<InformationObjectClass>> PGWCFFunction, <<InformationObjectClass>> PGWUFunction, <<InformationObjectClass>> ExternalServingGwCFFunction, <<InformationObjectClass>> ExternalServingGwUFunction, <<InformationObjectClass>> ServingGwCFFunction, and <<InformationObjectClass>> ServingGwUFunction.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + ManagedFunction (from 28.622) + } + class ExternalPGWCFFunction { + <<InformationObjectClass>> + ExternalPGWCFFunction + } + class ExternalPGWUFunction { + <<InformationObjectClass>> + ExternalPGWUFunction + } + class PGWCFFunction { + <<InformationObjectClass>> + PGWCFFunction + } + class PGWUFunction { + <<InformationObjectClass>> + PGWUFunction + } + class ExternalServingGwCFFunction { + <<InformationObjectClass>> + ExternalServingGwCFFunction + } + class ExternalServingGwUFunction { + <<InformationObjectClass>> + ExternalServingGwUFunction + } + class ServingGwCFFunction { + <<InformationObjectClass>> + ServingGwCFFunction + } + class ServingGwUFunction { + <<InformationObjectClass>> + ServingGwUFunction + } + ManagedFunction <|-- ExternalPGWCFFunction + ManagedFunction <|-- ExternalPGWUFunction + ManagedFunction <|-- PGWCFFunction + ManagedFunction <|-- PGWUFunction + ManagedFunction <|-- ExternalServingGwCFFunction + ManagedFunction <|-- ExternalServingGwUFunction + ManagedFunction <|-- ServingGwCFFunction + ManagedFunction <|-- ServingGwUFunction + +``` + +UML Class Diagram showing the inheritance hierarchy for EPC CUPS. The base class is <> ManagedFunction (from 28.622). It is inherited by six subclasses: <> ExternalPGWCFFunction, <> ExternalPGWUFunction, <> PGWCFFunction, <> PGWUFunction, <> ExternalServingGwCFFunction, <> ExternalServingGwUFunction, <> ServingGwCFFunction, and <> ServingGwUFunction. + +**Figure 4.2.2-6: EPC NRM Inheritance Hierarchy 6 for EPC CUPS** + +## 4.3 Class definitions + +### 4.3.1 EPDGFunction + +#### 4.3.1.1 Definition + +This IOC represents ePDG functionality. For more information about the ePDG, see 3GPP TS 23.402 [12]. + +### 4.3.2 MMEFunction + +#### 4.3.2.1 Definition + +This IOC represents MME functionality. For more information about the MME, see 3GPP TS 23.401 [9]. + +#### 4.3.2.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | M | - | - | M | +| mMEC | M | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| mMEPool | M | M | - | - | M | + +#### 4.3.2.3 Attribute constraints + +None. + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 PCRFFunction + +#### 4.3.3.1 Definition + +This IOC represents PCRF functionality. For more information about the PCRF, see 3GPP TS 23.401 [9]. + +### 4.3.4 PGWFunction + +#### 4.3.4.1 Definition + +This IOC represents PDN Gateway functionality. For more information about the PDN Gateway, see 3GPP TS 23.401 [9]. + +#### 4.3.4.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | O | T | T | F | T | + +#### 4.3.4.3 Attribute constraints + +None. + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.5 ServingGWFunction + +#### 4.3.5.1 Definition + +This IOC represents Serving Gateway functionality. For more information about the Serving Gateway, see 3GPP TS 23.401 [9]. + +#### 4.3.5.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | M | - | - | M | +| tACList | M | M | - | - | M | + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.6 MMEPool + +#### 4.3.6.1 Definition + +This IOC represents MME Pool. For more information about the MME Pool, see 3GPP TS 23.401 [9]. Key concepts related to MME Pool are: + +- An MME Pool consists of one or more MME nodes. A particular node can be a member of one and only one MME Pool. +- One MME Pool serves at most one MME Pool Area. One MME Pool Area can be served by at most one MME Pool. + +#### 4.3.6.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| mMEGI | M | M | - | - | M | +| Attribute related to role | | | | | | +| mMEPoolMemberList | M | M | M | - | M | +| mMEPoolArea | M | M | M | - | M | + +#### 4.3.6.3 Attribute constraints + +None. + +### 4.3.7 MMEPoolArea + +#### 4.3.7.1 Definition + +This IOC represents MME Pool Area. For more information about the MME Pool Area, see 3GPP TS 23.401 [9]. Key concepts related to MME Pool Area are: + +- An MME Pool Area is defined as an area within which an UE may be served without the need to change the serving MME. It is a collection of complete Tracking Areas (TAs). +- A particular TA can be a member of one or more MME Pool Areas. In the latter case, the MME Pool Areas involved are called “overlapping MME Pool Areas”. + +#### 4.3.7.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| tACList | M | M | - | - | M | +| pLMNIdList | O | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| mMEPool | M | M | M | - | M | + +#### 4.3.7.3 Attribute constraints + +None. + +### 4.3.8 Link\_ENB\_MME + +#### 4.3.8.1 Definition + +This IOC models the S1-MME reference point as defined in TS 23.401 [9]. + +### 4.3.9 Link\_ENB\_ServingGW + +#### 4.3.9.1 Definition + +This IOC models the S1-U reference point as defined in TS 23.401 [9]. + +### 4.3.10 Link\_EPDG\_PCRF + +#### 4.3.10.1 Definition + +This IOC models the Gxb reference point as defined in TS 23.402 [12]. + +### 4.3.11 Link\_EPDG\_PGW + +#### 4.3.11.1 Definition + +This IOC models the S2b reference point as defined in TS 23.402 [12]. + +### 4.3.12 Link\_HSS\_MME + +#### 4.3.12.1 Definition + +This IOC models the S6a reference point as defined in TS 23.401 [9]. + +### 4.3.13 Link\_MME\_MME + +#### 4.3.13.1 Definition + +This IOC models the S10 reference point as defined in TS 23.401 [9]. + +### 4.3.14 Link\_MME\_SGSN + +#### 4.3.14.1 Definition + +This IOC models the S3 reference point as defined in TS 23.401 [9]. + +### 4.3.15 Link\_MME\_ServingGW + +#### 4.3.15.1 Definition + +This IOC models the S11 reference point as defined in TS 23.401 [9]. + +### 4.3.16 Link\_PCRF\_ServingGW + +#### 4.3.16.1 Definition + +This IOC models the Gxc reference point as defined in TS 23.402 [12]. + +### 4.3.17 Link\_PCRF\_PGW + +#### 4.3.17.1 Definition + +This IOC models the Gx reference point as defined in TS 23.401 [9]. + +### 4.3.18 Link\_PGW\_ServingGW + +#### 4.3.18.1 Definition + +This IOC models the S5 reference point as defined in TS 23.401 [9]. + +### 4.3.19 Link\_SGSN\_ServingGW + +#### 4.3.19.1 Definition + +This IOC models the S4 reference point as defined in TS 23.401 [9]. + +### 4.3.20 EP\_RP\_EPS + +#### 4.3.20.1 Definition + +This IOC represents an end point of reference point in EPS as defined in TS 23.401 [9]. + +#### 4.3.20.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| farEndNeIPAddr | O | M | CM | - | M | + +#### 4.3.20.3 Attribute constraints + +| Name | Definition | +|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| farEndNeIPAddr's write qualifier | When the EP_RP_EPS object belongs to a different Domain Manager than the NE pointed by the farEndNeIPAddr attribute, the Write Qualifier of farEndNeIPAddr attribute is needed. | + +#### 4.3.20.4 Notifications + +The common notifications defined in subclause 4.1.6 of 3GPP TS 28.622[6] are valid for this IOC, without exceptions or additions. + +### 4.3.21 ExternalServingGWFunction + +#### 4.3.21.1 Definition + +This IOC represents SGW functionality controlled by another IRP Agent. For more information about the SGW, see 3GPP TS 23.401 [9]. + +#### 4.3.21.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | M | T | T | F | T | + +#### 4.3.21.3 Attribute constraints + +None. + +#### 4.3.21.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.22 ExternalMMEFunction + +#### 4.3.22.1 Definition + +This IOC represents MME functionality controlled by another IRP Agent. For more information about the MME, see 3GPP TS 23.401 [9]. + +#### 4.3.22.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| mMEC | M | T | T | F | T | +| <b>Attribute related to role</b> | | | | | | +| mMEPool | M | T | T | F | T | + +#### 4.3.22.3 Attribute constraints + +None. + +#### 4.3.22.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.23 IOC QCISet + +#### 4.3.23.1 Definition + +This IOC represents a set of QCI as defined in section 6.1.7.2 of TS 23.203 [19]. + +#### 4.3.23.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | - | M | +| qCIList | M | M | M | - | M | + +#### 4.3.23.3 Attribute constraints + +Null. + +#### 4.3.23.4 Notifications + +| Name | Qualifier | Notes | +|----------------------------|-----------------------------------------|-------| +| notifyAttributeValueChange | See Kernel CM IRP (3GPP TS 32.662 [13]) | | +| notifyObjectCreation | See Kernel CM IRP (3GPP TS 32.662 [13]) | | +| notifyObjectDeletion | See Kernel CM IRP (3GPP TS 32.662 [13]) | | + +### 4.3.24 MBMSGWFunction + +#### 4.3.24.1 Definition + +This IOC represents MBMS GW functionality. For more information about the MBMS GW, see 3GPP TS 36.300 [16]. + +#### 4.3.24.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| id | M | M | - | - | M | + +### 4.3.25 Link\_MBMSGW\_ENB + +#### 4.3.25.1 Definition + +This IOC represents the M1 reference point as defined in 3GPP TS 36.300 [16]. + +### 4.3.26 PGWFunction + +#### 4.3.26.1 Definition + +This IOC represents PDN Gateway control plane functionality. For more information about the PGW-C, see 3GPP TS 23.214 [23]. + +#### 4.3.26.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACLList | O | T | T | F | T | + +#### 4.3.26.3 Attribute constraints + +None. + +#### 4.3.26.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.27 PGWUFunction + +#### 4.3.27.1 Definition + +This IOC represents PDN Gateway user plane functionality. For more information about the PGW-U, see 3GPP TS 23.214 [23]. + +#### 4.3.27.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACLList | O | T | T | F | T | + +#### 4.3.27.3 Attribute constraints + +None. + +#### 4.3.27.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.28 ServingGwCFunction + +#### 4.3.28.1 Definition + +This IOC represents Serving Gateway control plane functionality. For more information about the SGW-C, see 3GPP TS 23.214 [23]. + +#### 4.3.28.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | M | T | T | F | T | + +#### 4.3.28.3 Attribute constraints + +None. + +#### 4.3.28.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.29 ServingGwUFunction + +#### 4.3.29.1 Definition + +This IOC represents Serving Gateway user plane functionality. For more information about the SGW-U, see 3GPP TS 23.214 [23]. + +#### 4.3.29.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | M | T | T | F | T | + +#### 4.3.29.3 Attribute constraints + +None. + +#### 4.3.29.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.30 ExternalServingGwCFunction + +#### 4.3.30.1 Definition + +This IOC represents SGW-C functionality controlled by another IRP Agent. For more information about the SGW-C, see 3GPP TS 23.214 [23]. + +#### 4.3.30.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | M | T | T | F | T | + +#### 4.3.30.3 Attribute constraints + +None. + +#### 4.3.30.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.31 ExternalServingGwUFunction + +#### 4.3.31.1 Definition + +This IOC represents SGW-U functionality controlled by another IRP Agent. For more information about the SGW-U, see 3GPP TS 23.214 [23]. + +#### 4.3.31.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | M | T | T | F | T | + +#### 4.3.31.3 Attribute constraints + +None. + +#### 4.3.31.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.32 ExternalPGWCFunction + +#### 4.3.32.1 Definition + +This IOC represents PDN Gateway control plane functionality controlled by another IRP Agent. For more information about the PGW-C, see 3GPP TS 23.214 [23]. + +#### 4.3.32.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACList | O | T | T | F | T | + +#### 4.3.32.3 Attribute constraints + +None. + +#### 4.3.32.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.33 ExternalPGWUFunction + +#### 4.3.33.1 Definition + +This IOC represents PDN Gateway user plane functionality controlled by another IRP Agent. For more information about the PGW-U, see 3GPP TS 23.214 [23]. + +#### 4.3.33.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| pLMNIdList | M | T | T | F | T | +| tACLList | O | T | T | F | T | + +#### 4.3.33.3 Attribute constraints + +None. + +#### 4.3.33.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table defines the attributes that are present in several Information Object Classes (IOCs) of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| farEndNeIpAddr | <p>The IP address(s) of the far end network entity to which the reference point is related.<br/>The IP address can be either IPv4 or IPv6.</p> | type: String<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: True | +| mMEC | <p>MME Identifier (MMEI) is constructed from an MME Group ID (MMEGI) and an MME Code (MMEC). The MMEC is unique within the MME pool area and, if overlapping pool areas are in use, unique within the area of overlapping MME pools. (Ref. 3GPP TS 23.003[14])</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| mMEGI | <p>MME Identifier (MMEI) is constructed from an MME Group ID (MMEGI) and an MME Code (MMEC). The MMEGI is the unique identity of MME Pool within the context of PLMN. ( Ref.3GPP TS 23.003[14]).<br/>Note:<br/>An UE, supported by a cell, can connect to one out of a group of MMEs. The group consists of the MMEs supporting the tracking area for the cell limited to those that are connected to the serving eNB. The MME is identified by the combination PLMNID-MMEGI-MMEC. The combination is called GUMMEI.</p> | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| pLMNIdList | <p>It is a list of PLMN-Id, PLMN-Id= Mobile Country Codes (MCC) Mobile Network Codes(MNC) (Ref. 3GPP TS 23.003[14])</p> <p>The <code>MMEPoolArea.pLMNIdList</code> purpose is to identify the PLMNs (related to <code>MMEFunction</code>) the MME Pool is serving.</p> <p>The <code>MMEFunction.pLMNIdList</code> purpose is as following. One operator may have several PLMN Ids and accordingly RAN broadcasts these Ids to enable UEs of different PLMN (i.e, UEs with different MNC in their IMSIs) to access its network. If CN node does not know this PLMN list, UEs of different PLMN than the one combined in MME might be treated as UEs from other operators. This will affect Location Update and Inter-MME handover procedures, and also the changing rate.</p> <p>allowedValues: A list of at most six entries of PLMN Identifiers. The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC).</p> | type: Integer<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: True | +| qCIList | <p>It is a list of QCI characteristic, which is a structure including the element QCI, Resource_Type, Priority, Packet_Delay_Budget and Packet_Error_Loss_Rate; Wherein</p> <ul style="list-style-type: none"> <li>- QCI representing the number of the QCI, is an integer;</li> <li>- Resource_Type representing the Resource Type(GBR or Non-GBR) of the QC;</li> <li>- Priority representing the Priority of QCI, is an integer;</li> <li>- Packet_Delay_Budget representing the Packet Delay Budget of the QCI, is an integer with the unit of millisecond(ms);</li> <li>- Packet_Error_Loss_Rate representing the Packet Error Loss Rate of the QCI, is a real.</li> </ul> <p>( Ref.3GPP TS 23.203[x])</p> | Refer to 3GPP TS 23.203[19] | + +| Attribute Name | Documentation and Allowed Values | Properties | +|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| tACList | It is the list of TAC of the MMEPoolArea that is used for traffic handling. Each TAC is provisioned over the S1 interface from the eNodeB, Ref 3GPP TS 36.413[18].<br>Note:<br>A cell can only broadcast one TAC. See TS 36.300 v8.4.0 [16], section 10.1.7 (PLMNID and TAC relation).<br>The Tracking Area Identity is constructed from the MCC (Mobile Country Code), MNC (Mobile Network Code) and TAC (Tracking Area Code). ( Ref.3GPP TS 23.401[9]) | type: Integer<br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>allowedValues: N/A<br>isNullable: True | +| Attribute Name related to role | Documentation and Allowed Values | Properties | +| mMepool | It is the DN of a MMEPool instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| mMEPoolArea | It is the DN of a MMEPoolArea instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| mMEPoolMemberList | It is the list of DNs of MMEFunction instances of the MMEPool.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This clause presents a list of notifications, defined in [3], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [20], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|--------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [3]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [3]) | | + +### 4.5.2 Configuration notifications + +This clause presents a list of notifications, defined in [12], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [20], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------------------------------------|-------| +| notifyAttributeValueChange | See Kernel CM IRP (3GPP TS 32.662 [13]) | | +| notifyObjectCreation | See Kernel CM IRP (3GPP TS 32.662 [13]) | | +| notifyObjectDeletion | See Kernel CM IRP (3GPP TS 32.662 [13]) | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140360 | 001 | - | | remove the feature support statements | 11.1.0 | +| 2014-10 | - | - | - | - | | Update to Rel-12 version (MCC) | 12.0.0 | +| 2016-01 | - | - | - | - | | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | - | - | - | - | | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | SA#80 | SP-180421 | 0007 | 1 | B | Update EPC NRM definitions to support management of EN-DC and 5G interworking | 15.0.0 | +| 2018-09 | SA#81 | SP-180829 | 0008 | 1 | B | NRM IOC changes for EPC CUPS | 15.1.0 | +| 2018-12 | SA#82 | SP-181050 | 0009 | 1 | F | CUPS NRM IOC error correction | 15.2.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28709/raw.md b/marked/Rel-16/28_series/28709/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7708bc80ef4863a5c5f0606dd1b36d6f6dc74b44 --- /dev/null +++ b/marked/Rel-16/28_series/28709/raw.md @@ -0,0 +1,1887 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set definitions..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.0 Introduction..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.2 Mapping ..... | 8 | +| A.2.1 General mapping ..... | 8 | +| A.2.2 Information Object Class (IOC) mapping..... | 8 | +| A.2.2.1 IOC MMEFunction ..... | 8 | +| A.2.2.2 IOC MMEPool ..... | 9 | +| A.2.2.3 IOC MMEPoolArea..... | 9 | +| A.2.2.4 IOC EP_RP_EPS ..... | 9 | +| A.2.2.5 IOC ExternalMMEFunction ..... | 9 | +| A.2.2.6 IOC ServingGWFunction ..... | 9 | +| A.2.2.7 IOC ExternalServingGWFunction ..... | 9 | +| A.2.2.8 IOC QCISet ..... | 9 | +| A.2.2.9 IOC MBMSGWFunction ..... | 10 | +| A.3 Solution Set definitions..... | 11 | +| A.3.1 IDL definition structure..... | 11 | +| A.3.2 IDL specification "EPCResourcesNRMDefs.idl"..... | 11 | +| <b>Annex B (normative): XML definitions.....</b> | <b>16</b> | +| B.0 General..... | 16 | +| B.1 Architectural features..... | 16 | +| B.1.0 Introduction..... | 16 | +| B.1.1 Syntax for Distinguished Names..... | 16 | +| B.2 Mapping ..... | 16 | +| B.2.1 General mapping ..... | 16 | +| B.2.2 Information Object Class (IOC) mapping..... | 16 | +| B.3 Solution Set definitions..... | 16 | +| B.3.1 XML definition structure ..... | 16 | +| B.3.2 XML schema "epcNrm.xsd"..... | 17 | +| Annex C (informative): Change history..... | 28 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.707: Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- 28.708: Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS) +- 28.709: Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions** + +# --- 1 Scope + +The present document specifies the Solution Sets for the EPC NRM IRP. + +The Solution Set definition is related to 3GPP TS 28.708 V15.0.X [3]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.708: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [3] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [4] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions". +- [5] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [6] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [7] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [8] Void +- [9] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [10] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [11] 3GPP TS 28.623: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definition". +- [12] 3GPP TS 28.541: "Management and orchestration of 5G networks; Network Resource Model (NRM); Stage 2 and stage 3". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**XML file:** See definition of [11]. + +**XML document:** See definition of [11]. + +**XML declaration:** See definition of [11]. + +**XML element:** See definition of [11]. + +**empty XML element:** See definition of [11]. + +**XML content (of an XML element):** See definition of [11]. + +**XML start-tag:** See definition of [11]. + +**XML end-tag:** See definition of [11]. + +**XML empty-element tag:** See definition of [11]. + +**XML attribute specification:** See definition of [11]. + +**DTD:** See definition of [11]. + +**XML schema:** See definition of [11]. + +**XML namespace:** See definition of [11]. + +**XML complex type:** See definition of [11]. + +**XML element type:** See definition of [11]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|----------------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| eNodeB | evolved NodeB | +| EPC | Evolved Packet Core | +| EPDG | Evolved Packet Data Gateway | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| GPRS | General Packet Radio System | +| IS | Information Service | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| IS | Information Service | +| MME | Mobility Management Entity | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| PCRF | Policy and Charging Rules Function | +| P-GW | PDN Gateway | + +| | | +|------|----------------------------| +| S-GW | Serving Gateway | +| SS | Solution Set | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set definitions + +This specifications defines the following 3GPP EPC NRM IRP Solution Set definitions: + +- 3GPP EPC NRM IRP CORBA SS (Annex A) +- 3GPP EPC NRM IRP XML definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in EPC Network Resource Model (NRM) IRP: Information Service (TS 28.708 [2]). + +--- + +### A.1 Architectural features + +### A.1.0 Introduction + +The overall architectural feature of EPC NRM IRP is specified in 3GPP TS 28.708 [2]. + +This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [11]. + +A.1.2 Rules for NRM extensions +See clause A.1.2 of [11]. + +--- + +### A.2 Mapping + +#### A.2.1 General mapping + +See clause A.1.2.1 of [11]. + +#### A.2.2 Information Object Class (IOC) mapping + +##### A.2.2.1 IOC MMEFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------------------------------------------------------------| +| id | id | string | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | +| mMEC | mMEC | long | +| mMEPool | mMEPool | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +##### A.2.2.2 IOC MMEPool + +| IS Attributes | SS Attributes | SS Type | +|-------------------|-------------------|------------------------------------------------------------------| +| id | id | string | +| mMEGI | mMEGI | long | +| mMEPoolMemberList | mMEPoolMemberList | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | +| mMEPoolArea | mMEPoolArea | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +##### A.2.2.3 IOC MMEPoolArea + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------------------------------------------------------------| +| id | id | string | +| mMEPool | mMEPool | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| tACList | tACList | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | + +#### A.2.2.4 IOC EP\_RP\_EPS + +| IS Attributes | SS Attributes | SS Type | +|-------------------|-------------------|---------| +| farEndNeIpAddress | farEndNeIpAddress | string | + +##### A.2.2.5 IOC ExternalMMEFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------------------------------------------------------------| +| id | id | string | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | +| mMEC | mMEC | long | +| mMEPool | mMEPool | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +#### A.2.2.6 IOC ServingGWFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|-------------------------------------------------------------| +| id | id | string | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | +| tACList | tACList | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | + +#### A.2.2.7 IOC ExternalServingGWFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|-------------------------------------------------------------| +| id | id | string | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | +| tACList | tACList | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | + +#### A.2.2.8 IOC QCISet + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|----------------------------------------------------------| +| id | id | string | +| qCIList | qCIList | genericEPCNRMAttributeTypes::AttributeTypes::qciListType | + +#### A.2.2.9 IOC MBMSGWFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|---------| +| id | id | string | + +#### A.2.2.10 IOC ServingGwCFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|-------------------------------------------------------------| +| id | id | string | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | +| tACList | tACList | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | + +#### A.2.2.11 IOC ExternalServingGwCFunction + +| IS Attributes | SS Attributes | SS Type | +|---------------|---------------|-------------------------------------------------------------| +| id | id | string | +| pLMNIdList | pLMNIdList | genericEPCNRMAttributeTypes::AttributeTypes::plmnIdListType | +| tACList | tACList | GenericNetworkResourcesIRPSystem::AttributeTypes::LongSet | + +## A.3 Solution Set definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the types and constants which are used by the EPC NRM IRP. + +#### A.3.2 IDL specification "EPCResourcesNRMDefs.idl" + +``` +//File:EPCResourcesNRMDefs.idl +#ifndef _EPCNETWORKRESOURCESNRMDefs_IDL_ +#define _EPCNETWORKRESOURCESNRMDefs_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module EPCNetworkResourcesNRMDefs +{ + + /** + * Definitions for MO class EPDGFunction + */ + interface EPDGFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "EPDGFunction"; + // No New Attribute Names + // + }; + + /** + * Definitions for MO class MMFunction + */ + interface MMFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "MMFunction"; + // Attribute Names + // + const string id = "id"; + const string pLMNIdList = "pLMNIdList"; + const string mMEC = "mMEC"; + const string mMEPool = "mMEPool"; + }; + + /** + * Definitions for MO class PCRFFunction + */ + interface PCRFFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "PCRFFunction"; + // No New Attribute Names + // + }; + + /** + * Definitions for MO class PGWFunction + */ + interface PGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "PGWFunction"; + // No New Attribute Names + // + // + }; + + /** + * Definitions for MO class PGWCFunction + */ + interface PGWCFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "PGWCFunction"; + // No New Attribute Names + // + // + }; +} +``` + +``` +}; + +/** + * Definitions for MO class PGWUFunction + */ +interface PGWUFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "PGWUFunction"; + // No New Attribute Names + // + // +}; + +/** + * Definitions for MO class ServingGWFunction + */ +interface ServingGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ServingGWFunction"; + // Attribute Names + const string id = "id"; + const string pLMNIdList = "pLMNIdList"; + const string tACLList = "tACLList"; + // +}; + +/** + * Definitions for MO class ServingGWFunction + */ +interface ServingGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ServingGWFunction"; + // Attribute Names + const string id = "id"; + const string pLMNIdList = "pLMNIdList"; + const string tACLList = "tACLList"; + // +}; + +/** + * Definitions for MO class ServingGWUFunction + */ +interface ServingGWUFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ServingGWUFunction"; + // No New Attribute Names + // + // +}; + +/** + * Definitions for MO class MMEPool + */ +interface MMEPool : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MMEPool"; + // Attribute Names + // + const string id = "id"; + const string mMEGI = "mMEGI"; + const string mMEPoolMemberList = "mMEPoolMemberList"; + const string mMEPoolArea = "mMEPoolArea"; +}; + +/** + * Definitions for MO class MMEPoolArea + */ +interface MMEPoolArea : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "MMEPoolArea"; + // Attribute Names + // + const string id = "id"; + const string mMEPool = "mMEPool"; + const string tACLList = "tACLList"; + const string sGWAddress = "sGWAddress"; + const string pLMNIdList = "pLMNIdList"; +}; +``` + +``` +/** + * Definitions for MO class EP_RP_EPS + */ +interface EP_RP_EPS : GenericNetworkResourcesNRMDefs::EP_RP +{ + const string CLASS = "EP_RP_EPS"; + // Attribute Names + const string farEndNeIpAddr = "farEndNeIpAddr"; +}; + +/** + * Definitions for MO class Link_ENB_MME + */ +interface Link_ENB_MME : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_ENB_MME"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_ENB_ServingGW + */ +interface Link_ENB_ServingGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_ENB_ServingGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_EPDG_PCRF + */ +interface Link_EPDG_PCRF : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_EPDG_PCRF"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_EPDG_PGW + */ +interface Link_EPDG_PGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_EPDG_PGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_HSS_MME + */ +interface Link_HSS_MME : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_HSS_MME"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_MME_MME + */ +interface Link_MME_MME : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MME_MME"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_MME_SGSN + */ +interface Link_MME_SGSN : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MME_SGSN"; + // No New Attribute Names + // +}; +``` + +``` + // +}; + +/** + * Definitions for MO class Link_MME_ServingGW + */ +interface Link_MME_ServingGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_MME_ServingGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_PCRF_ServingGW + */ +interface Link_PCRF_ServingGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_PCRF_ServingGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_PCRF_PGW + */ +interface Link_PCRF_PGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_PCRF_PGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_PGW_ServingGW + */ +interface Link_PGW_ServingGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_PGW_ServingGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class Link_SGSN_ServingGW + */ +interface Link_SGSN_ServingGW : GenericNetworkResourcesNRMDefs::Link +{ + const string CLASS = "Link_SGSN_ServingGW"; + // No New Attribute Names + // +}; + +/** + * Definitions for MO class ExternalMMEFunction + */ +interface ExternalMMEFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ExternalMMEFunction"; + // Attribute Names + // + const string id = "id"; + const string pLMNIdList = "pLMNIdList"; + const string mMEC = "mMEC"; + const string mMEPool = "mMEPool"; +}; + +/** + * Definitions for MO class ExternalServingGWFunction + */ +interface ExternalServingGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "ExternalServingGWFunction"; + // Attribute Names + // + const string id = "id"; + const string pLMNIdList = "pLMNIdList"; +}; +``` + +``` + const string tACList = "tACList"; + }; + + /** + * Definitions for MO class ExternalServingGWCFunction + */ + interface ExternalServingGWCFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalServingGWCFunction"; + // Attribute Names + // + const string id = "id"; + const string pLMNIdList = "pLMNIdList"; + const string tACList = "tACList"; + }; + + /** + * Definitions for MO class ExternalServingGWUFunction + */ + interface ExternalServingGWUFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalServingGWUFunction"; + // No New Attribute Names + // + // + }; + + /** + * Definitions for MO class ExternalPGWCFunction + */ + interface ExternalPGWCFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalPGWCFunction"; + // No New Attribute Names + // + // + }; + + /** + * Definitions for MO class ExternalPGWUFunction + */ + interface ExternalPGWUFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "ExternalPGWUFunction"; + // No New Attribute Names + // + // + }; + + /** + * Definitions for MO class QCISet + */ + interface QCISet: GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "QCISet"; + // Attribute Names + // + const string id = "id"; + const string qCIList = "qCIList"; + }; + + /** + * Definitions for MO class Link_MBMSGW_ENB + */ + interface Link_MBMSGW_ENB : GenericNetworkResourcesNRMDefs::Link + { + const string CLASS = "Link_MBMSGW_ENB"; + // No New Attribute Names + // + }; + + /** + * Definitions for MO class MBMSGWFunction + */ + interface MBMSGWFunction : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "MBMSGWFunction"; + }; + +``` + +``` + // Attribute Names + // + const string id = "id"; + }; +} + +module genericEPCNRMAttributeTypes +{ + /** + * Definitions for struct PlmnIdType + */ + struct PlmnIdType + { + short mcc; + short mnc; + }; + + typedef sequence<PlmnIdType> plmnIdListType; + + /** + * Definitions for struct QciType + */ + struct QciType + { + short qci; + boolean resourceType; + // True is GBR, False is Non-GBR + short priority; + short packetDelayBudget; + float packetErrorLossRate; + }; + + typedef sequence<QciType> qciListType; + +}; + +#endif // _EPCNETWORKRESOURCESNRMDEFS_IDL_ +``` + +# --- Annex B (normative): XML definitions + +## B.0 General + +This annex contains the XML definitions for the EPC NRM IRP as it applies to Itf-N, in accordance with EPC NRM IRP IS definitions [2]. + +The XML file formats are based on XML [7], XML Schema [9] [10] and XML Namespace [5] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of EPC Network Resource Model IRP is specified in 3GPP TS 28.708 [2]. This clause specifies features that are specific to the XML definitions SS. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [6]. + +## --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [3]. + +B.3.2 defines the NRM-specific XML schema `epcNrm.xsd` for the EPC NRM IRP IS defined in 3GPP TS 28.708 [2]. + +XML schema `epcNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [3]. + +## --- B.3 Solution Set definitions + +#### B.3.1 XML definition structure + +The XML definitions of this document specify the schema for configuration content. + +When using the XML definitions for a configuration file transfer with the Bulk CM IRP, using either CORBA Solution Set of 3GPP TS 32.616 [3] or SOAP Solution Set of 3GPP TS 32.616 [3], the basic part of the XML file format definition is provided by 3GPP TS 32.616 [3]. The XML definitions of this document provide the schema for the configuration content to be included in such a configuration file. + +When using the XML definitions with a SOAP solution set of any interface IRP that perform operations on managed objects, for example the Basic CM IRP SOAP SS of 3GPP TS 32.606 [4], the XML definitions of this document provides the schema for the configuration content operated on by the interface IRP. Such configuration content can be name of managed object and, if applicable, IOC attributes. + +#### B.3.2 XML schema “epcNrm.xsd” + +``` + +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.709 EPC Network Resource Model IRP + XML schema definition + epcNrm.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.709#epcNrm" + elementFormDefault="qualified" + attributeFormDefault="unqualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:epc="http://www.3gpp.org/ftp/specs/archive/28_series/28.709#epcNrm" + xmlns:ngc="http://www.3gpp.org/ftp/specs/archive/28_series/28.541#ngcNrm" +> + + <import namespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm"/> + + <!--EPC NRM IRP IS class associated XML elements --> + <complexType name="PLMNId"> + <sequence> + <element name="mcc" type="short" minOccurs="0"/> + <element name="mnc" type="short" minOccurs="0"/> + </sequence> + </complexType> + <complexType name="PLMNIdList"> + <sequence> + <element name="pPLMNId" type="epc:PLMNId" minOccurs="0" /> + </sequence> + </complexType> + <complexType name="TACList"> + <sequence> + <element name="tAC" type="long" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </complexType> + <complexType name="QCIType"> + <sequence> + <element name="qci" type="short" minOccurs="0"/> + <element name="resourceType" type="boolean" minOccurs="0"/> + <!-- True is GBR, and False is Non-GBR --> + <element name="priority" type="short" minOccurs="0"/> + <element name="packetDelayBudget" type="short" minOccurs="0"/> + <element name="packetErrorLossRate" type="decimal" minOccurs="0"/> + </sequence> + </complexType> + <complexType name="QCILISTType"> + <sequence> + <element name="qCIInfo" type="epc:QCIType" minOccurs="0"/> + </sequence> + </complexType> + + <element + name="EPDGFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:EPDGFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + +``` + +``` + </choice> + </sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="MMEFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="pLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + <element name="mMEC" type="long" minOccurs="0"/> + <element name="mMEPool" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:MMEFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="ngc:EP_N26"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="PCRFFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="linkList" type="xn:linkListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:PCRFFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="PGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + +``` + +``` +<element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:PGWFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="PGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:PGWFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="PGWUFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:PGWUFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ExternalPGWFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> +``` + +``` +<complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ExternalPGWUFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ServingGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="PLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + <element name="tACLList" type="epc:TACLList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:ServingGWFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ServingGwCFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> +``` + +``` +<sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="pLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + <element name="tACList" type="epc:TACList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:ServingGwCFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="ServingGwUFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:ServingGwUFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ExternalServingGwFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="pLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + <element name="tACList" type="epc:TACList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element +``` + +``` + name="ExternalServingGwCFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="pLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + <element name="tACLList" type="epc:TACLList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ExternalServingGwUFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="ExternalMMEFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="pLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + <element name="mMEC" type="long" minOccurs="0"/> + <element name="mMEPool" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + +<element + name="MMEPool" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="mMEGI" type="long" minOccurs="0"/> + <element name="mMEPoolMemberList" type="xn:dnList" minOccurs="0"/> + <element name="mMEPoolArea" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:MMEPoolOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="MMEPoolArea" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="mMEPool" type="xn:dn" minOccurs="0"/> + <element name="tACLList" type="epc:TACLList" minOccurs="0"/> + <element name="pLMNIdList" type="epc:PLMNIdList" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:MMEPoolAreaOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_ENB_MME" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_ENB_MMEOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_ENB_ServingGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_ENB_ServingGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_EPDG_PCRF" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_EPDG_PCRFOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_EPDG_PGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> +``` + +``` +<all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_EPDG_PGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_HSS_MME" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_HSS_MMEOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_MME_MME" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_MME_MMEOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` +<element name="Link_MME_SGSN" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_MME_SGSNOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_MME_ServingGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_MME_ServingGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_PCRF_ServingGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> +``` + +``` +<element ref="epc:Link_PCRF_ServingGWOptionallyContainedNrmClass"/> +<element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="Link_PCRF_PGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_PCRF_PGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_PGW_ServingGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_PGW_ServingGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Link_SGSN_ServingGW" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> +``` + +``` + + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_SGSN_ServingGWOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="EP_RP_EPS"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <!-- Inherited attributes from EP_RP --> + <element name="farEndEntity" type="xn:dn" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <!-- End of inherited attributes from EP_RP --> + <element name="farEndNeIpAddr" type="string" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:EP_RP_EPSOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="QCISet" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="qCIList" type="epc:QCIListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:QCISetOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="MBMSGWFunction" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + +``` + +``` + + <complexType> + <all> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:MBMSGWFunctionOptionallyContainedNrmClass"/> + <element ref="epc:EP_RP_EPS"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> +</complexContent> +</complexType> +</element> + +<element name="Link_MBMSGW_ENB" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="aEnd" type="xn:dn" minOccurs="0"/> + <element name="linkType" type="xn:linkType" minOccurs="0"/> + <element name="protocolName" type="string" minOccurs="0"/> + <element name="protocolVersion" type="string" minOccurs="0"/> + <element name="userLabel" type="string" minOccurs="0"/> + <element name="zEnd" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="epc:Link_MBMSGW_ENBOptionallyContainedNrmClass"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EPDGFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="MMEFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="PCRFFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="PGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="PGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ExternalPGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="ExternalPGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ServingGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ServingGwCFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ServingGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="ExternalServingGwCFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="ExternalServingGwUFunctionOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="MMEPoolOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="MMEPoolAreaOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_ENB_MMEOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_ENB_ServingGWOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_EPDG_PCRFOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_EPDG_PGWOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_HSS_MMEOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_MME_MMEOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_MME_SGSNOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_MME_ServingGWOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_PCRF_ServingGWOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="Link_PCRF_PGWOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_PGW_ServingGWOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + +``` + +``` + +<element name="Link_SGSN_ServingGWOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> +<element name="EP_RP_EPSOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="QCISetOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="MBMSGWFunctionOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> +<element name="Link_MBMSGW_ENBOptionallyContainedNrmClass" type="xn:NrmClass" abstract="true"/> + +</schema> + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|------------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140332 | 0001 | - | F | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140358 | 0002 | - | F | remove the feature support statements | 11.1.0 | +| 2014-09 | SA#65 | SP-140560 | 0003 | - | C | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 2016-01 | | | | | | Update to Rel-13 (MCC) | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0005 | - | F | Update the link from IRP Solution Set to IRP Information Service | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0006 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | SA#80 | SP--180424 | 0007 | 1 | B | Add EPC CUPS for CORBA SS | 15.0.0 | +| 2018-06 | SA#80 | SP--180424 | 0008 | 1 | B | Add EPC CUPS for CORBA solution set | 15.0.0 | +| 2018-09 | SA#81 | SP-180828 | 0010 | - | B | Update EPC SS definitions to support management of EN-DC and 4G/5G interworking | 15.1.0 | +| 2018-09 | SA#81 | SP-180829 | 0011 | 1 | B | Add EPC CUPS for XML solution set | 15.1.0 | +| 2018-12 | SA#82 | SP-181050 | 0012 | 1 | F | CUPS XML schema alignment | 15.2.0 | +| 2018-12 | SA#82 | SP-181050 | 0013 | 1 | F | CUPS CORBA IDL update | 15.2.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28731/raw.md b/marked/Rel-16/28_series/28731/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..447d2ce116beeb7c19edd472b1af5e46acb179f8 --- /dev/null +++ b/marked/Rel-16/28_series/28731/raw.md @@ -0,0 +1,127 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Requirements ..... 6 +- Annex B (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +###### **28.731 Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements.** + +28.732 Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). + +28.733 Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2] and [3], the requirements for the present IRP: Transport Network (TN) interface Network Resource Model (NRM). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication Management, Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [5] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". +- [6] 3GPP TS.28.622: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**IRP:** see 3GPP TS 32.101 [1] + +**Network Resource Model (NRM):** See definition in TS 32.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----|----------------------------------------| +| CM | Configuration Management | +| GSM | Global System for Mobile communication | +| IRP | Integration Reference Point | +| NRM | Network Resource Model | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [1]. + +- b) IRP-related requirements in 3GPP TS 32.102 [2]. +- c) IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- d) Shall support communications for telecommunication network management purposes, including management of converged networks. +- e) Is a member of the Federated Network Information Model (FNIM) [4] and its information is derived from FNIM Umbrella Information Model (UIM) [5] + +In addition, the following more specific requirements apply: + +**REQ-TN\_NRM-CON-001:** The NRM specified by this IRP shall allow for the configuration of the ATM Termination Points of the UTRAN inter element links (Iub-link, Iur-link, Iu-link), which are residing in a Node B or RNC. More specifically, the NRM: + +- 1) shall allow for the viewing of the physical layer used by the ATM network (e. g. E1); +- 2) shall allow for the viewing of parameters of the virtual circuits associated with each link (e.g. VPI/VCI, ATM Service Category, AAL type, Peak Cell Rate, Sustainable Cell Rate, Maximum Burst Size); +- 3) shall allow the assigning of a UTRAN interface logical channel (e.g. Iub-NBAP) to a virtual circuit and configuration of parameters of the virtual circuit (e.g. VPI/VCI, ATM Service Category, AAL type, Peak Cell Rate, Sustainable Cell Rate, Maximum Burst Size); +- 4) shall allow to relate the ATM Termination Point easily to the associated link; +- 5) shall allow to relate the ATM Termination Point easily to the network element and the type of network element it is connected to. + +**REQ-TN\_NRM-CON-002:** The NRM defined by this IRP shall be generic in the sense to allow support for multiple transport technologies (e.g. IP) in the future; + +**REQ-TN\_NRM-CON-003:** The NRM defined by this IRP shall be generic in the sense to allow support for the management of termination points of other interface links (e. g. links between network elements of the CN) in the future. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|-----|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | F | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | 12.0.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | 14.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28732/1c953f32bd34345dfd68fddf8a3736d6_img.jpg b/marked/Rel-16/28_series/28732/1c953f32bd34345dfd68fddf8a3736d6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bf72123893f56d2c5bfe462cd81212aab7c127a6 --- /dev/null +++ b/marked/Rel-16/28_series/28732/1c953f32bd34345dfd68fddf8a3736d6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:466c8c9ba135329b97d07e9b355e75cd87fc9cc9a37f2c97ec9fa8c9c089223c +size 24180 diff --git a/marked/Rel-16/28_series/28732/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/28_series/28732/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e4c68d45e4b52e0f0284c5e7ae21f6956839c596 --- /dev/null +++ b/marked/Rel-16/28_series/28732/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:36f69eb413e969e6bc3999008de47ca619385cd537e45f921dd88bba1436a070 +size 33359 diff --git a/marked/Rel-16/28_series/28732/bd671b21db63e6fdb2196e9b18502aac_img.jpg b/marked/Rel-16/28_series/28732/bd671b21db63e6fdb2196e9b18502aac_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8eee2220a6880979fc98ba81e6616469b96f9dc6 --- /dev/null +++ b/marked/Rel-16/28_series/28732/bd671b21db63e6fdb2196e9b18502aac_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f26873ec04b9a8036a7ffca264d57896e292dcada3ce9511a988fac3c0f8e40 +size 70928 diff --git a/marked/Rel-16/28_series/28732/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/28_series/28732/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1348a22aa23e67c7d7d2d46c0f138a9cbb363496 --- /dev/null +++ b/marked/Rel-16/28_series/28732/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a28b5cb39892af4ef7bd28c4c8b0262a7f177560b5443bedd4661821100a48f6 +size 26043 diff --git a/marked/Rel-16/28_series/28732/raw.md b/marked/Rel-16/28_series/28732/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c960ee9e255f073a5414db8b8f2295db84a79678 --- /dev/null +++ b/marked/Rel-16/28_series/28732/raw.md @@ -0,0 +1,447 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 4 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Model ..... | 6 | +| 4.1 Imported information entities and local labels..... | 6 | +| 4.2 Class diagram..... | 6 | +| 4.2.1 Relationships ..... | 6 | +| 4.2.2 Inheritance ..... | 7 | +| 4.3 Class definitions ..... | 8 | +| 4.3.1 TransportNetworkInterface ..... | 8 | +| 4.3.1.1 Definition ..... | 8 | +| 4.3.1.2 Attributes ..... | 8 | +| 4.3.1.3 Attribute constraints..... | 8 | +| 4.3.1.4 Notifications..... | 8 | +| 4.3.2 ATMChannelTerminationPoint..... | 8 | +| 4.3.2.1 Definition ..... | 8 | +| 4.3.2.2 Attributes ..... | 9 | +| 4.3.2.3 Attribute constraints..... | 9 | +| 4.3.2.4 Notifications..... | 9 | +| 4.3.3 ATMPathTerminationPoint ..... | 9 | +| 4.3.3.1 Definition ..... | 9 | +| 4.3.3.2 Attributes ..... | 9 | +| 4.3.3.3 Attribute constraints..... | 10 | +| 4.3.3.4 Notifications..... | 10 | +| 4.4 Attribute definitions ..... | 10 | +| 4.4.1 Attribute properties..... | 10 | +| 4.4.2 Constraints ..... | 12 | +| 4.5 Common notifications ..... | 13 | +| 4.5.1 Alarm notifications ..... | 13 | +| 4.5.2 Configuration notifications..... | 13 | +| <b>Annex A (informative): Example Configuration of ATM Transport Network in UTRAN.....</b> | <b>14</b> | +| Annex B (informative): Change history..... | 15 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.731: Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.732: Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS).** +- 28.733: Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document specifies the Transport Network (TN) interface Network Resource Model (NRM) that can be communicated between an IRP<sub>Agent</sub> and an IRP<sub>Manager</sub> for telecommunication network management purposes, including management of converged networks. + +This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding. + +The "Transport Network (TN) Interface Network Resource Model (NRM) IRP" comprises a set of specifications defining Requirements, a protocol neutral Network Resource Model (NRM) and corresponding Solution Set(s). + +The present document: + +- Specifies the protocol neutral Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). It reuses relevant parts of the generic NRM in TS 28.622 [6], either by direct reuse or sub-classing, and in addition to that defines Transport specific Managed Object Classes. + +The Configuration Management (CM) area is very large. The intention is to split the specification of the related interfaces in several IRPs - as described in the Introduction clause above. An important aspect of such a split is that the + +Network Resource Models (NRMs) defined in different IRPs containing NRMs are consistent, and that NRMs supported by an IRP Agent implementation can be accessed as one coherent model through one IRP Information Service. + +In order to access the information defined by this NRM, an IRP Information Service (IS) is needed, such as the Basic CM IRP: IS (TS 32.602 [7]) or the Bulk CM IRP: IS (TS 32.612 [8]). However, which Information Service that is applicable is outside the scope of this document. + +Finally, regarding the support of the State Management IRP: IS (TS 28.625 [16]), all NRM's of one release shall support the same State Management IRP version. + +This specification is related to 3GPP TS 28.625 [16]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TS 32.101: "Telecommunication Management, Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] Void. +- [4] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [5] ITU-T Recommendation I.361 (11/95): "B-ISDN ATM Layer Specification". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP) Information Service (IS)". +- [8] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [9] 3GPP TS 25.430: "UTRAN Iub interface: general aspects and principles". +- [10] 3GPP TS 25.431: "UTRAN Iub interface Layer 1". +- [11] 3GPP TS 25.411: "UTRAN Iu interface Layer 1". +- [12] 3GPP TS 28.652: " UTRAN Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS) ". +- [13] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)". +- [14] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)". +- [15] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)". + +- [16] 3GPP TS 28.625: "Telecommunication management; State Management Integration Reference Point (IRP): Information Service (IS)". +- [17] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) concept and definitions". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following definitions and abbreviations apply. For definitions and abbreviations not found here, please refer to 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [17] and 3GPP TS 28.622 [6]. + +**Association:** See definition in TS 28.622 [6]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [17] and the following apply: + +| | | +|-------|-----------------------------------------------------------------| +| DN | Distinguished Name (see 3GPP TS 32.300 [4]) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| ITU-T | International Telecommunication Union, Telecommunication Sector | +| Iub | Interface between RNC and Node B | +| NRM | Network Resource Model | +| RDN | Relative Distinguished Name (see 3GPP TS 32.300 [4]) | +| RNC | Radio Network Controller | +| UML | Unified Modelling Language | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|------------------------------------------|-----------------| +| 3GPP TS 28.622 [6], IOC, ManagedElement | ManagedElement | +| 3GPP TS 28.652 [12], IOC, IubLink | IubLink | +| 3GPP TS 28.622 [6], IOC, VsDataContainer | VsDataContainer | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates information relevant for this IRP. This subclause provides the overview of the relationships of relevant classes in UML. Subsequent subclasses provide more detailed specification of various aspects of these classes. + +Figure 4.2.1.1 shows the name-containment relation and other types of relations of the Transport Network NRM. + +![Transport Network NRM Containment/Naming and Association diagram](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +This diagram illustrates the containment and naming relationships between Information Object Classes (IOCs) in the Transport Network NRM. It features four main classes: **ManagedElement** (from 28.622), **TransportNetworkInterface**, **ATMPathTerminationPoint**, and **ATMChannelTerminationPoint** (from 28.652). **ManagedElement** is the root class, which contains **TransportNetworkInterface** (1 to \* relationship labeled «names»). **ATMPathTerminationPoint** and **ATMChannelTerminationPoint** both inherit from **ManagedElement**. **ATMPathTerminationPoint** contains **ATMChannelTerminationPoint** (0..1 to \* relationship labeled «names»). **TransportNetworkInterface** contains **ATMPathTerminationPoint** (1 to \* relationship labeled «names»). **ATMChannelTerminationPoint** contains **ATMPathTerminationPoint** (1 to \* relationship labeled «names»). Additionally, **ATMChannelTerminationPoint** is associated with **IubLink** (from 28.652) via a relationship labeled «iubLink» (1 to \*). The diagram also includes associations labeled «theATMPathTerminationPoint» and «theATMChannelTerminationPoint». + +Transport Network NRM Containment/Naming and Association diagram + +**Figure 4.2.1.1: Transport Network NRM Containment/Naming and Association diagram** + +Each IOC is identified with a Distinguished Name (DN) according to 3GPP TS 32.300 [4] that expresses its containment hierarchy. As an example, the DN of a IOC representing a ATMPathTerminationPoint could have a format like: + +SubNetwork=Sweden,meContext=MEC-Gbg-1,ManagedElement=RNC-Gbg-1, TransportNetworkInterface=ATM-1, ATMPathTerminationPoint=Gbg-1. + +![vsDataContainer in name-containment diagram](1c953f32bd34345dfd68fddf8a3736d6_img.jpg) + +This diagram shows the name-containment relationships for **ATMPathTerminationPoint** and **ATMChannelTerminationPoint**. Both classes inherit from **ManagedElement** (from 28.622). **ATMPathTerminationPoint** contains **vsDataContainer** (from 28.622) (1 to \* relationship labeled «names»). **ATMChannelTerminationPoint** also contains **vsDataContainer** (from 28.622) (1 to \* relationship labeled «names»). **vsDataContainer** contains **ATMPathTerminationPoint** (1 to \* relationship labeled «names»). **vsDataContainer** also contains **ATMChannelTerminationPoint** (1 to \* relationship labeled «names»). + +vsDataContainer in name-containment diagram + +**Figure 4.2.1.2: vsDataContainer in name-containment diagram** + +NOTE 1: The listed cardinality numbers represent transient as well as steady-state numbers, and reflect all managed object creation and deletion scenarios. + +### 4.2.2 Inheritance + +This subclause depicts the inheritance relationships that exist between IOCs. + +Figure 4.2.2.1 shows the inheritance hierarchy for the Transport Network NRM. + +![UML Class Diagram showing the inheritance hierarchy for Transport Network NRM. Three classes at the bottom (TransportNetworkInterface, ATMPathTerminationPoint, and ATMChannelTerminationPoint) inherit from a common base class 'InformationObjectClass' (ManagedFunction). The base class itself inherits from 'InformationObjectClass' (Top).](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +classDiagram + class InformationObjectClass_Top["«InformationObjectClass» +Top +(from 28.622)"] + class InformationObjectClass_ManagedFunction["«InformationObjectClass» +ManagedFunction +(from 28.622)"] + class TransportNetworkInterface["«InformationObjectClass» +TransportNetworkInterface"] + class ATMPathTerminationPoint["«InformationObjectClass» +ATMPathTerminationPoint"] + class ATMChannelTerminationPoint["«InformationObjectClass» +ATMChannelTerminationPoint"] + + InformationObjectClass_Top <|-- InformationObjectClass_ManagedFunction + TransportNetworkInterface <|-- InformationObjectClass_ManagedFunction + ATMPathTerminationPoint <|-- InformationObjectClass_ManagedFunction + ATMChannelTerminationPoint <|-- InformationObjectClass_ManagedFunction + +``` + +UML Class Diagram showing the inheritance hierarchy for Transport Network NRM. Three classes at the bottom (TransportNetworkInterface, ATMPathTerminationPoint, and ATMChannelTerminationPoint) inherit from a common base class 'InformationObjectClass' (ManagedFunction). The base class itself inherits from 'InformationObjectClass' (Top). + +Figure 4.2.2.1: Transport Network NRM Inheritance Hierarchy + +## 4.3 Class definitions + +### 4.3.1 TransportNetworkInterface + +#### 4.3.1.1 Definition + +This IOC represents the Transport Network Interface technology (e.g. ATM, IP). + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------|-------------------|------------|------------|-------------|--------------| +| transportNetworkType | M | M | - | - | M | + +#### 4.3.1.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.2 ATMChannelTerminationPoint + +#### 4.3.2.1 Definition + +This IOC represents a bi-directional ATM Virtual Channel Connection Termination Point. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| usageChannel | M | M | - | - | M | +| virtualPathId | M | M | O | - | M | +| virtualChannelId | M | M | O | - | M | +| physicalPortId | M | M | O | - | M | +| physicalInterfaceType | M | M | O | - | M | +| serviceCategoryIn | M | M | O | - | M | +| ServiceCategoryEg | M | M | O | - | M | +| usedAAL | M | M | O | - | M | +| peakCellRateIn | M | M | O | - | M | +| peakCellRateEg | M | M | O | - | M | +| sustainableCellRateIn | O | M | O | - | M | +| sustainableCellRateEg | O | M | O | - | M | +| maximumBurstSizeIn | M | M | O | - | M | +| maximumBurstSizeEg | M | M | O | - | M | +| minimumDesiredCellRateIn | O | M | O | - | M | +| minimumDesiredCellRateEg | O | M | O | - | M | +| minimumCellRateIn | O | M | O | - | M | +| minimumCellRateEg | O | M | O | - | M | +| <b>Attribute related to role</b> | | | | | | +| theATMPathTerminationPoint | M | M | - | | | +| theIubLink | M | M | - | | | + +#### 4.3.2.3 Attribute constraints + +| Name | Definition | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| virtualPathId, virtualChannelId, physicalPortId, physicalInterfaceType, serviceCategoryIn/Eg, usedAAL, peakCellRateIn/Eg, sustainableCellRateIn/Eg, and maximumBurstSizeIn/Eg<br>O Write qualifier | The Write Qualifier shall be supported if these attributes can be set over Itf-N. | +| sustainableCellRateIn/Eg, maximumBurstSizeIn/Eg | Only applicable for ServiceCategory values RT-VBR, NRT-VBR. | +| minimumCellRateIn/Eg | Only applicable for Service Category values ABR, GFR. | + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 ATMPathTerminationPoint + +#### 4.3.3.1 Definition + +This IOC represents a bi-directional ATM Virtual Path Connection Termination Point. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritetable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|--------------|-------------|--------------| +| virtualPathId | M | M | O | - | M | +| physicalPortIdList | M | M | O | - | M | +| peakCellRateIn | M | M | O | - | M | +| peakCellRateEg | M | M | O | | | +| <b>Attribute related to role</b> | | | | | | +| theATMChannelTerminationPoint | M | M | - | - | M | + +NOTE: The attribute peakCellRateIn, peakCellRateEg of ATM Path is the maximum Peak Cell Rate of its channels. + +#### 4.3.3.3 Attribute constraints + +| Name | Definition | +|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| for attributes virtualPathId, physicalPortIdList, peakCellRateIn, peakCellRateEg O Write qualifier | The Write Qualifier shall be supported if these attributes can be written/set over Itf-N. | + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table defines the attributes that are present in several IOCs of the present document. + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| transportNetworkType | The type of underlying transport network, i.e. ATM, IP.<br>allowedValues: ATM, IP | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| usageChannel | The logical channel using the transport network connection.<br>Ref. 3GPP TS 25.430 [9].<br><br>allowedValues: examples are "lub-NBAP", "lub-ALCAP". | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| virtualPathId | The ATM Virtual Path Identifier (VPI).<br><br>Ref. ITU-T Recommendation I.361[5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| virtualChannelId | The ATM Virtual Channel Identifier (VCI).<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| physicalPortIdList | The list of identifiers of the ATM physical port containing termination points.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: false | +| physicalPortId | The identifier of the ATM physical port containing termination points.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| physicalInterfaceType | The ATM physical interface type.<br><br>Ref. 3GPP TS 25.431[10], 3GPP TS 25.411[11].<br><br>allowedValues: Examples are 'E1', 'STM1'. | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| serviceCategoryIn | The ATM Service Category used for the virtual connection Ingress (incoming) traffic.<br><br>Ref. ITU-T Recommendation I.361[5].<br><br>allowedValues: CBR, RT-VBR, NRT-VBR, ABR, UBR, GFR | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| serviceCategoryEg | The ATM Service Category used for the virtual connection Egress (outgoing) traffic.<br>Ref. ITU-T Recommendation I.361[5]<br><br>allowedValues: CBR, RT-VBR, NRT-VBR, ABR, UBR, GFR | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| usedAAL | The ATM Adaptation Layer (AAL) used for the virtual connection.<br><br>Ref. ITU-T Recommendation I.361[5].<br><br>allowedValues: Null, AAL1,..... | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| peakCellRateIn | Peak Cell Rate (PCR) in kbits/sec for Ingress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| peakCellRateEg | Peak Cell Rate (PCR) in kbits/sec for Egress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sustainableCellRateIn | Sustainable Cell Rate (SCR) in kbits/sec for Ingress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1...n | type: Integer<br>Multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| sustainableCellRateEg | Sustainable Cell Rate (SCR) in kbits/sec for Egress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1...n | type: Integer<br>Multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| maximumBurstSizeIn | Maximum Burst Size (MBS) for VBR Service Categories for Ingress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1...n | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| maximumBurstSizeEg | Maximum Burst Size (MBS) for VBR Service Categories for Egress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1...n | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| minimumCellRateIn | Minimum Cell Rate (MCR) in kbits/sec for ABR, GFR Service Categories for Ingress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1..n | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| minimumCellRateEg | Minimum Cell Rate (MCR) in kbits/sec for ABR, GFR Service Categories for Egress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5]. | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>allowedValues: 1..n<br>isNullable: False | +| minimumDesiredCellRateIn | Minimum Desired Cell Rate (MDCR) in kbits/sec for UBR Service Category for Ingress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1..n | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| minimumDesiredCellRateEg | Minimum Desired Cell Rate (MDCR) in kbits/sec for UBR Service Category for Egress traffic.<br><br>Ref. ITU-T Recommendation I.361 [5].<br><br>allowedValues: 1..n | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: N/A<br>isNullable: False | +| | | | +| Role-Attribute Name | | | +| theATMChannelTerminationPoint | It carries zero or more DN of ATMChannelTerminationPoint.<br><br>allowedValues: N/A<br><br>Null value means no DN is carried. | type: DN<br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| theATMPathTerminationPoint | It carries zero or one DN of ATMPathTerminationPoint.<br><br>allowedValues: N/A<br><br>Null value means no DN is carried. | type: DN<br>multiplicity: 0..1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| theIubLink | It carries zero or more DN of IubLink.<br><br>allowedValues: N/A<br><br>Null value means no DN is carried. | type: DN<br>multiplicity: 0..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This subclause presents a list of notifications, defined in [13], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [14], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|---------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [13]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [13]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [13]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [13]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [13]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [13]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [13]) | | + +### 4.5.2 Configuration notifications + +This subclause presents a list of notifications, defined in [15], that IRPManager can receive. The notification header attribute `objectClass/objectInstance`, defined in [14], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | + +# Annex A (informative): Example Configuration of ATM Transport Network in UTRAN + +![Diagram showing the virtual connection of a logical Iub interface channel over an ATM network between an Rnc and a NodeB.](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +The diagram illustrates the configuration of an ATM transport network for the Iub interface. It features two main components: an Rnc (Radio Network Controller) on the left and a NodeB on the right, both connected to a central ATM Network. Above each component is a detailed configuration box for the ATM Channel Termination Point. + +**ATM Channel Termination Point xx (Rnc):** + +- UsageChannel = Iub-NBAP +- VPI = 0 +- VCI = 34 +- PhysicalPortId = 12 +- PhysicalInterfaceType = E1 +- ServiceCategoryIn = CBR +- ServiceCategoryEg = CBR +- UsedAAL = AAL5 +- PeakCellRateIn = 64 +- PeakCellRateEg = 64 +- SustainableCellRate = Null +- MaximumBurstSize = Null + +**ATM Channel Termination Point yy (NodeB):** + +- UsageChannel = Iub-NBAP +- VPI = 0 +- VCI = 12 +- PhysicalPortId = 2 +- PhysicalInterfaceType = E1 +- ServiceCategoryIn = CBR +- ServiceCategoryEg = CBR +- UsedAAL = AAL5 +- PeakCellRateIn = 64 +- PeakCellRateEg = 64 +- SustainableCellRate = Null +- MaximumBurstSize = Null + +The Rnc and NodeB are connected to the ATM Network via dashed lines. Below the ATM Network, a separate diagram shows a 'IubLink' represented by a yellow rectangle with two purple dots at its ends, connected by a dashed line. + +Diagram showing the virtual connection of a logical Iub interface channel over an ATM network between an Rnc and a NodeB. + +Figure A.1: Virtual connection of a logical Iub interface channel over ATM network + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|-----------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2013-09 | SA#61 | SP-130433 | 001 | 1 | Removal of wrong and redundant modelling statements | F | 11.0.0 | 11.1.0 | +| 2014-06 | SA#64 | SP-140358 | 002 | - | remove the feature support statements | F | 11.1.0 | 11.2.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.2.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2016-12 | SA#74 | SP-160854 | 0003 | - | F | Correct the usage of isNullable and multiplicity property | 13.1.0 | | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | | +| 2018-01 | SA#78 | SP-170962 | 0006 | 1 | A | Update erroneous references | 14.1.0 | | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28733/raw.md b/marked/Rel-16/28_series/28733/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7ea79e463c218f2fdde4526ba8a72113ac2f47a7 --- /dev/null +++ b/marked/Rel-16/28_series/28733/raw.md @@ -0,0 +1,736 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set Definitions ..... | 7 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> | +| A.0 General..... | 8 | +| A.1 Architectural features..... | 8 | +| A.1.0 Introduction ..... | 8 | +| A.1.1 Syntax for Distinguished Names..... | 8 | +| A.1.2 Rules for NRM extensions ..... | 8 | +| A.2 Mapping ..... | 8 | +| A.2.1 General mapping ..... | 8 | +| A.2.2 Information Object Class (IOC) mapping..... | 8 | +| A.2.2.1 IOC TransportNetworkInterface..... | 8 | +| A.2.2.2 IOC ATMChannelTerminationPoint..... | 9 | +| A.2.2.3 IOC ATMPathTerminationPoint ..... | 9 | +| A.3 Solution Set definitions ..... | 10 | +| A.3.1 IDL definition structure..... | 10 | +| A.3.2 IDL specification “TransportNetworkResourcesNRMDefs.idl”..... | 11 | +| <b>Annex B (normative): XML Definitions.....</b> | <b>12</b> | +| B.0 General..... | 12 | +| B.1 Architectural features..... | 12 | +| B.1.0 Introduction ..... | 12 | +| B.1.1 Syntax for Distinguished Names..... | 12 | +| B.2 Mapping ..... | 12 | +| B.2.1 General mapping ..... | 12 | +| B.2.2 Information Object Class (IOC) mapping ..... | 12 | +| B.3 Solution Set definitions ..... | 12 | +| B.3.1 XML definition structure ..... | 12 | +| B.3.2 Graphical Representation ..... | 13 | +| B.3.3 XML Schema "transportNrm.xsd"..... | 14 | +| Annex A (informative): Change history..... | 18 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.731: Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. +- 28.732: Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.733: Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions.** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Transport Network (TN) interface Network Resource Model (NRM) IRP, through which an IRP<sub>Agent</sub> can communicate configuration management information to one or several IRP<sub>Managers</sub> concerning TN resources. The TN NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the TN NRM IRP. + +This specification is related to 3GPP TS 28.732 [4] V14.0.X. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 28.732: "Telecommunication management; Transport Network (TN) Interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [5] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [6] OMG Notification Service, Version 1.0. +- [7] OMG CORBA services: Common Object Services Specification, Update: November 22, 1996. +- [8] The Common Object Request Broker: Architecture and Specification (for specification of valid version, see [1]). +- [9] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set (SS) definitions". +- [10] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [11] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions ". +- [12] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [13] Void +- [14] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [15] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [16] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". + +[17] 3GPP TS 28.623: “Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions”. + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For terms and definitions please refer to 3GPP TS 32.101 [1], TS 32.102 [2], TS 32.600 [3] and TS 32.712 [4] and the following apply. + +**XML file:** See definition of [17]. + +**XML document:** See definition of [17]. + +**XML declaration:** See definition of [17]. + +**XML element:** See definition of [17]. + +**empty XML element:** See definition of [17]. + +**XML content (of an XML element):** See definition of [17]. + +**XML start-tag:** See definition of [17]. + +**XML end-tag:** See definition of [17]. + +**XML empty-element tag:** See definition of [17]. + +**XML attribute specification:** See definition of [17]. + +**DTD:** See definition of [17]. + +**XML schema:** See definition of [17]. + +**XML namespace:** See definition of [17]. + +**XML complex type:** See definition of [17]. + +**XML element type:** See definition of [17]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| EDGE | Enhanced Data for GSM Evolution | +| GERAN | GSM/EDGE Radio Access Network | +| GSM | Global System for Mobile communication | +| IS | Information Service | +| IDL | Interface Definition Language (OMG) | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| TN | Transport Network | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP TN NRM IRP Solution Set Definitions: + +- 3GPP TN NRM IRP CORBA SS (Annex A) +- 3GPP TN NRM IRP XML Definitions (Annex B) + +# Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in TN NRM IRP: Information Service (TS 32.712 [4]). + +## A.1 Architectural features + +### A.1.0 Introduction + +The overall architectural feature of Transport Network Resources IRP is specified in 3GPP TS 28.712 [4]. This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [17]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [17]. + +## A.2 Mapping + +#### A.2.1 General mapping + +See clause A.2.1 of [17]. + +#### A.2.2 Information Object Class (IOC) mapping + +#### A.2.2.1 IOC TransportNetworkInterface + +**Table A.2.2.1: Mapping from NRM IOC TransportNetworkInterface attributes to SS equivalent MOC TransportNetworkInterface attributes** + +| NRM Attributes of IOC TransportNetworkInterface in 3GPP TS 28.732 [4] | SS Attributes | SS Type | Support Qualifier | Read | Write | +|-----------------------------------------------------------------------|-----------------------------|---------|-------------------|------|-------| +| id | transportNetworkInterfaceId | string | M | M | - | +| userLabel | userLabel | string | M | M | M | +| transportNetworkType | transportNetworkType | string | M | M | - | + +#### A.2.2.2 IOC ATMChannelTerminationPoint + +**Table A.2.2.2: Mapping from NRM IOC ATMChannelTerminationPoint attributes and associations to SS equivalent MOC ATMTerminationPoint attributes** + +| NRM Associations/Attributes of IOC ATMChannelTerminationPoint in 3GPP TS 28.732 [4] | SS Attributes | SS Type | Support Qualifier | Read | Write | +|-------------------------------------------------------------------------------------|---------------------------------------------------|------------------------------------------------------------------|-------------------|------|-------| +| id | aTMChannelTerminationPointId | string | M | M | - | +| usageChannel | usageChannel | string | M | M | - | +| virtualPathId | virtualPathId | long | M | M | O | +| virtualChannelId | virtualChannelId | long | M | M | O | +| physicalPortId | physicalPortId | string | M | M | O | +| physicalInterfaceType | physicalLinkType | string | M | M | O | +| serviceCategoryIn | serviceCategoryIn | long | M | M | O | +| serviceCategoryEg | serviceCategoryEg | long | M | M | O | +| usedAAL | usedAAL | long | M | M | O | +| peakCellRateIn | peakCellRateIn | long | M | M | O | +| peakCellRateEg | peakCellRateEg | long | M | M | O | +| sustainableCellRateIn | sustainableCellRateIn | long | O | M | O | +| sustainableCellRateEg | sustainableCellRateEg | long | O | M | O | +| maximumBurstSizeIn | maximumBurstSizeIn | long | M | M | O | +| maximumBurstSizeEg | maximumBurstSizeEg | long | M | M | O | +| minimumDesiredCellRateIn | minimumDesiredCellRateIn | long | O | M | O | +| minimumDesiredCellRateEg | minimumDesiredCellRateEg | long | O | M | O | +| minimumCellRateIn | minimumCellRateIn | long | O | M | O | +| minimumCellRateEg | minimumCellRateEg | long | O | M | O | +| aTMChannelTerminationPoint-ATMPathTerminationPoint | aTMChannelTerminationPointATMPathTerminationPoint | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | M | M | - | +| aTMChannelTerminationPoint-lubLink | aTMChannelTerminationPointlubLink | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | M | M | - | + +#### A.2.2.3 IOC ATMPathTerminationPoint + +**Table A.2.2.3: Mapping from NRM IOC ATMPathTerminationPoint attributes and associations to SS equivalent MOC ATMTerminationPoint attributes** + +| NRM Associations/Attributes of IOC ATMPathTerminationPoint in 3GPP TS 28.732 [4] | SS Attributes | SS Type | Support Qualifier | Read | Write | +|----------------------------------------------------------------------------------|---------------------------------------------------|------------------------------------------------------------------|-------------------|------|-------| +| id | aTMPathTerminationPointId | string | M | M | - | +| virtualPathId | virtualPathId | long | M | M | O | +| physicalPortIdList | physicalPortIdList | string | M | M | O | +| peakCellRateIn | peakCellRateIn | long | M | M | O | +| peakCellRateEg | peakCellRateEg | long | M | M | O | +| aTMPathTerminationPoint-ATMChannelTerminationPoint | aTMPathTerminationPointATMChannelTerminationPoint | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReferenceSet | M | M | - | + +## --- A.3 Solution Set definitions + +### A.3.1 IDL definition structure + +Clause A.3.2 defines the MO classes for the TN NRM IRP. + +### A.3.2 IDL specification + +#### "TransportNetworkResourcesNRMDefs.idl" + +``` + +//File: TransportNetworkResourcesNRMDefs.idl +#ifdef _TRANSPORT_NETWORK_RESOURCES_NRM_DEFS_IDL_ +#define _TRANSPORT_NETWORK_RESOURCES_NRM_DEFS_IDL_ +#include "GenericNetworkResourcesNRMDefs.idl" +#pragma prefix "3gppsa5.org" +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module TransportNetworkResourcesNRMDefs +{ + /** + * Definitions for MO class TransportNetworkInterface + */ + interface TransportNetworkInterface : GenericNetworkResourcesNRMDefs::ManagedFunction + { + const string CLASS = "TransportNetworkInterface"; + // Attribute Names + // + const string transportNetworkInterfaceId = "transportNetworkInterfaceId"; + const string transportNetworkType= "transportNetworkType"; + }; + /** + * Definitions for MO class ATMChannelTerminationPoint + */ + interface ATMChannelTerminationPoint + { + const string CLASS = "ATMChannelTerminationPoint"; + // Attribute Names + // + const string atmChannelTerminationPointId = "atmChannelTerminationPointId"; + const string usageChannel= "usageChannel"; + const string virtualPathId= "virtualPathId"; + const string virtualChannelId= "virtualChannelId"; + const string physicalPortId= "physicalPortId"; + const string physicalLinkType= "physicalLinkType"; + const string serviceCategoryIn= "serviceCategoryIn"; + const string serviceCategoryEg= "serviceCategoryEg"; + const string usedAAL= "usedAAL"; + const string peakCellRateIn= "peakCellRateIn"; + const string peakCellRateEg= "peakCellRateEg"; + const string sustainableCellRateIn= "sustainableCellRateIn"; + const string sustainableCellRateEg= "sustainableCellRateEg"; + const string maximumBurstSizeIn= "maximumBurstSizeIn"; + const string maximumBurstSizeEg= "maximumBurstSizeEg"; + const string minimumDesiredCellRateIn= "minimumDesiredCellRateIn"; + const string minimumDesiredCellRateEg= "minimumDesiredCellRateEg"; + const string minimumCellRateIn= "minimumCellRateIn"; + const string minimumCellRateEg= "minimumCellRateEg"; + const string atmChannelTerminationPointATMPathTerminationPoint = + "atmChannelTerminationPointATMPathTerminationPoint"; + const string atmChannelTerminationPointIubLink = "atmChannelTerminationPointIubLink"; + }; + /** + * Definitions for MO class ATMPathTerminationPoint + */ + interface ATMPathTerminationPoint + { + const string CLASS = "ATMPathTerminationPoint"; + // Attribute Names + // + const string atmPathTerminationPointId = "atmPathTerminationPointId"; + const string virtualPathId= "virtualPathId"; + const string physicalPortIdList= "physicalPortIdList"; + const string peakCellRateIn= "peakCellRateIn"; + const string peakCellRateEg= "peakCellRateEg"; + const string atmPathTerminationPointATMChannelTerminationPoint = + "atmPathTerminationPointATMChannelTerminationPoint"; + }; +}; +#endif // _TRANSPORT_NETWORK_RESOURCES_NRM_DEFS_IDL_ + +``` + +# --- Annex B (normative): XML Definitions + +## B.0 General + +This annex contains the XML Definitions for the TN NRM IRP as it applies to Itf-N, in accordance with TN NRM IRP Information Service (TS 32.712 [4]). + +The XML file formats are based on XML [12], XML Schema [14] [15] and XML Namespace [16] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of Transport Network Resources IRP is specified in 3GPP TS 32.712 [4]. This clause specifies features that are specific to the XML Definitions. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [5]. + +## --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [11]. + +Annex B.3.3 of the present document defines the NRM-specific XML schema `transportNrm.xsd` for the Transport interface Network Resources IRP NRM defined in 3GPP TS 32.712 [4]. + +XML schema `transportNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [11]. + +### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +#### B.3.3 XML Schema "transportNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.733 Transport Network Interface NRM IRP + Bulk CM Configuration data file NRM-specific XML schema + transportNrm.xsd +--> + +<schema + targetNamespace="http://www.3gpp.org/ftp/specs/archive/28_series/28.733#transportNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn="http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:tn="http://www.3gpp.org/ftp/specs/archive/28_series/28.733#transportNrm" +> + + <import + namespace= +"http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + /> + + <!--Transport Network Interface Resources IRP NRM attribute related XML types --> + + <simpleType name="transportNetworkType"> + <restriction base="string"> + <enumeration value="ATM"/> + <enumeration value="IP"/> + </restriction> + </simpleType> + + <simpleType name="serviceCategoryIn"> + <restriction base="string"> + <enumeration value="CBR"/> + <enumeration value="RT-VBR"/> + <enumeration value="NRT-VBR"/> + <enumeration value="ABR"/> + <enumeration value="UBR"/> + <enumeration value="GFR"/> + </restriction> + </simpleType> + + <simpleType name="serviceCategoryEg"> + <restriction base="string"> + <enumeration value="CBR"/> + <enumeration value="RT-VBR"/> + <enumeration value="NRT-VBR"/> + <enumeration value="ABR"/> + <enumeration value="UBR"/> + <enumeration value="GFR"/> + </restriction> + </simpleType> + + <simpleType name="usedAAL"> + <restriction base="string"> + <enumeration value="Null"/> + <enumeration value="AAL1"/> + <enumeration value="AAL2"/> + <enumeration value="AAL3"/> + <enumeration value="AAL4"/> + <enumeration value="AAL5"/> + </restriction> + </simpleType> + + <simpleType name="virtualPathId"> + <restriction base="integer"> + <minInclusive value="0"/> + </restriction> + </simpleType> + + <simpleType name="virtualChannelId"> + <restriction base="integer"> + <minInclusive value="0"/> + </restriction> + </simpleType> +``` + +``` +<complexType name="physicalPortIdList"> + <sequence> + <element name="physicalPortId" type="string" minOccurs="1" maxOccurs="unbounded"> + </element> + </sequence> +</complexType> + +<simpleType name="peakCellRateIn"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="peakCellRateEg"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="sustainableCellRateIn"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="sustainableCellRateEg"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="maximumBurstSizeIn"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="maximumBurstSizeEg"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="minimumCellRateIn"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="minimumCellRateEg"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="minimumDesiredCellRateIn"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<simpleType name="minimumDesiredCellRateEg"> + <restriction base="integer"> + <minInclusive value="1"/> + </restriction> +</simpleType> + +<!-- Transport Network Interface Resources IRP NRM class associated XML elements --> + +<element + name="TransportNetworkInterface" + substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> +``` + +``` +<complexType> + <all> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element + name="transportNetworkType" + type="tn:transportNetworkType" + /> + </all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="tn:ATMPathTerminationPoint"/> + <element ref="tn:ATMChannelTerminationPoint"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="ATMChannelTerminationPoint"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="usageChannel" type="string"/> + <element + name="virtualPathId" + type="tn:virtualPathId" + /> + <element + name="virtualChannelId" + type="tn:virtualChannelId" + /> + <element + name="physicalPortId" + type="string" + /> + <element name="physicalInterfaceType" type="string" minOccurs="0"/> + <element + name="serviceCategoryIn" + type="tn:serviceCategoryIn" + /> + <element + name="serviceCategoryEg" + type="tn:serviceCategoryEg" + /> + <element + name="usedAAL" + type="tn:usedAAL" + /> + <element + name="peakCellRateIn" + type="tn:peakCellRateIn" + /> + <element + name="peakCellRateEg" + type="tn:peakCellRateEg" + /> + <element + name="sustainableCellRateIn" + type="tn:sustainableCellRateIn" + minOccurs="0" + /> + <element + name="sustainableCellRateEg" + type="tn:sustainableCellRateEg" + minOccurs="0" + /> + <element + name="maximumBurstSizeIn" + type="tn:maximumBurstSizeIn" + /> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + <element + name="maximumBurstSizeEg" + type="tn:maximumBurstSizeEg" + /> + <element + name="minimumDesiredCellRateIn" + type="tn:minimumDesiredCellRateIn" + minOccurs="0" + /> + <element + name="minimumDesiredCellRateEg" + type="tn:minimumDesiredCellRateEg" + minOccurs="0" + /> + <element + name="minimumCellRateIn" + type="tn:minimumCellRateIn" + minOccurs="0" + /> + <element + name="minimumCellRateEg" + type="tn:minimumCellRateEg" + minOccurs="0" + /> + <element name="aTMChannelTerminationPointATMPathTerminationPoint" type="xn:dn"/> + <element name="aTMChannelTerminationPointIubLink" type="xn:dnList"/> + </all> +</complexType> +</element> +<choice> + <element ref="xn:VsDataContainer" minOccurs="0" maxOccurs="unbounded"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="ATMPathTerminationPoint"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element + name="virtualPathId" + type="tn:virtualPathId" + /> + <element + name="physicalPortIdList" + type="tn:physicalPortIdList" + /> + <element + name="peakCellRateIn" + type="tn:peakCellRateIn" + /> + <element + name="peakCellRateEg" + type="tn:peakCellRateEg" + /> + <element name="aTMPathTerminationPointATMChannelTerminationPoint" +type="xn:dnList"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +</schema> + +``` + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140358 | 001 | - | F | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140332 | 002 | - | F | remove the feature support statements | 11.1.0 | +| 2014-09 | SA#65 | SP-140560 | 003 | - | C | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 2016-01 | | | | | | Update to Rel-13 (MCC) | 13.0.0 | +| 2016-03 | SA#71 | SP-160031 | 006 | - | A | Make the XML schema well formed | 13.1.0 | +| 2016-06 | SA#72 | SP-160407 | 0007 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.2.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0008 | - | F | Update the link from IRP Solution Set to IRP Information Service | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0009 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28734/raw.md b/marked/Rel-16/28_series/28734/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6013d10092107f999285ae7ecb4f0dff4c564eb0 --- /dev/null +++ b/marked/Rel-16/28_series/28734/raw.md @@ -0,0 +1,169 @@ + + + + + + +# --- Contents + +- Foreword .....4 +- Introduction .....4 +- 1 Scope.....5 +- 2 References.....5 +- 3 Definitions and abbreviations .....5 +- 3.1 Definitions.....5 +- 3.2 Abbreviations .....6 +- 4 Requirements .....7 +- 4.1 MTP3 Configuration Management .....7 +- 4.2 M3UA Configuration Management .....7 +- 4.3 Fault Management.....7 +- 4.4 Performance Management.....8 +- 5 Issues.....8 +- Annex A (informative): Change history.....9 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.734: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements.** +- 28.735: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- 28.736: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +Configuration Management (CM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. CM actions have the objective to control and monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs. + +CM actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimisation programme (e.g. modifications), and to maintain the overall Quality of Service (QoS). The CM actions are initiated either as single actions on single NEs of the 3G network, or as part of a complex procedure involving actions on many resources/objects in one or several NEs. + +# --- 1 Scope + +The present document defines , in addition to the requirements defined in [1], [2] and [3], the requirements for the Signalling Transport Network (STN) interface NRM IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication Management, Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [4] 3GPP TS 29.202: "Signalling System No. 7 (SS7) signalling transport in core network; Stage 3". +- [5] ITU-T Recommendation Q.751.1 (10/95): "Network Element Management Information Model for The Message Transfer Part (MTP)". +- [6] ITU-T Recommendation M.3100 (07/95): "Generic Network Information Model". +- [7] ITU-T Recommendation Q.704 (07/96): "Signalling network functions and messages". +- [8] ITU-T Recommendation Q.702 (11/88): "Signalling Data Link". +- [9] 3GPP TS.28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [10] 3GPP TS 32.405: "Telecommunication management; Performance Management (PM); Performance measurements Universal Terrestrial Radio Access Network (UTRAN)". +- [11] IETF RFC 3332: "Signalling System 7 (SS7) Message Transfer Part 3 (MTP3) - User Adaptation Layer (M3UA)". +- [12] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [13] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**Integration Reference Point (IRP):** see 3GPP TS 32.150 [12]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [9]. + +**Termination Point:** see ITU-T M.3100 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|---------------------------------------------------------------------------------| +| CM | Configuration Management | +| GSM | Global System for Mobile communication | +| IP | Internet Protocol | +| IRP | Integration Reference Point | +| ITU-T | International Telecommunication Union, Telecommunication Standardisation Sector | +| MTP | Message Transfer Part | +| NE | Network Element | +| NR | Network Resource | +| NRM | Network Resource Model | +| OS | Operations System | +| QoS | Quality of Service | +| RNC | Radio Network Controller | +| STN | Signalling Transport Network | +| UMTS | Universal Mobile Telecommunications System | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- A. IRP-related requirements in 3GPP TS 32.101 [1]. +- B. IRP-related requirements in 3GPP TS 32.102 [2]. +- C. IRP-related requirements in 3GPP TS 32.600 [3]. + +The NRM defined by this IRP: + +- D. Shall support communications for telecommunication network management purposes, including management of converged networks. +- E. Is a member of the Federated Network Information Model (FNIM) [13] and its information is derived from FNIM Umbrella Information Model (UIM) [9]. + +In addition to the above, the following more specific requirements apply. + +## 4.1 MTP3 Configuration Management + +- a) It shall be possible for IRPManager to retrieve configuration information related to MTP3 signalling managed entity. +- b) When the configuration information of MTP3 signalling managed entities changes, corresponding notifications shall be generated to IRPManager. +- c) When the status of MTP3 signalling managed entities changes, corresponding notifications shall be generated to IRPManager. +- d) It shall be possible for IRPManager to identify which technology that the STN is based on (e. g. MTP3, MTP3B [4]); +- e) The interface shall allow for the viewing of parameters of the MTP3 signalling point, MTP3 signalling link set termination point, MTP3 signalling link termination point, MTP3 signalling route and MTP3 signalling route set [4], [5], [7], [8]. + +## 4.2 M3UA Configuration Management + +- a) It shall possible for IRPManager to retrieve configuration information related to M3UA signalling managed entities. +- b) When the configuration information of M3UA signalling managed entities changes, corresponding notifications shall be generated to IRPManager. +- c) When the status of M3UA signalling managed entities changes, corresponding notifications shall be generated to IRPManager. +- d) The interface shall allow for the viewing of parameters of the M3UA signalling point, M3UA signalling link set termination point, M3UA signalling link termination point, M3UA signalling route and M3UA signalling route set ([4], [11]). + +## 4.3 Fault Management + +Any fault detected by the signalling managed entity (including signalling point, signalling link set termination point, signalling link termination point, signalling route and signalling route set [4], [5], [7], [8]) shall be passed up to the IRPManager. + +## 4.4 Performance Management + +It shall be possible for IRPManager to collect and monitor performance data. The detailed measurement data to be defined in 3GPP TS 32.405 [10]. + +--- + +# 5 Issues + +The NRM shall allow to be extended to support other technologies based Signalling Transport Network in the future (e.g. IP-based; see 3GPP TS 29.202 [4]). + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------|-----|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | F | 11.0.0 | <b>11.1.0</b> | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28735/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/28_series/28735/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6e3e59dfca6d0c345b50bfe32646eb346ca5fb3 --- /dev/null +++ b/marked/Rel-16/28_series/28735/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11fda41bf54419fae83183d7ad5f3fd429b77cc70c37c8aee354aed6807eac88 +size 38743 diff --git a/marked/Rel-16/28_series/28735/2ba086df3506f81bae3a9b53725dcfea_img.jpg b/marked/Rel-16/28_series/28735/2ba086df3506f81bae3a9b53725dcfea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f3196285a3ce2340d42e96efde85560c56ad4a5 --- /dev/null +++ b/marked/Rel-16/28_series/28735/2ba086df3506f81bae3a9b53725dcfea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fad6c768fe5253c38ad93293e51adaef313e56bf754aa1d2bee55e59a69a7891 +size 18692 diff --git a/marked/Rel-16/28_series/28735/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/28_series/28735/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..13cade92b5cdab19ef888485033d5246f94c8460 --- /dev/null +++ b/marked/Rel-16/28_series/28735/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85578bf0af55d2f3590279621912d023c9056d324bd0a18a7cb49e424e51cff5 +size 66863 diff --git a/marked/Rel-16/28_series/28735/99bae07626f60f9ede10e2e387ef7051_img.jpg b/marked/Rel-16/28_series/28735/99bae07626f60f9ede10e2e387ef7051_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d5b0733deeac746bb1fc420a1bec51b5e842fa2d --- /dev/null +++ b/marked/Rel-16/28_series/28735/99bae07626f60f9ede10e2e387ef7051_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bef852754b41bdd0c384db20497d01debafc14eaba5804dcda5dd19aba6ef50a +size 47467 diff --git a/marked/Rel-16/28_series/28735/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-16/28_series/28735/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ee551c03cc9feb13533552c16df11b77d8c489f1 --- /dev/null +++ b/marked/Rel-16/28_series/28735/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c8dccbae3a366960d5573c3a3210f2aef63c7a5cbdfdd48cbc282629c2b8b997 +size 49100 diff --git a/marked/Rel-16/28_series/28735/c2fc2621e8206d24427b56bcb2398fc0_img.jpg b/marked/Rel-16/28_series/28735/c2fc2621e8206d24427b56bcb2398fc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c04be133ec94c145b7f3654eec870a5232e7a455 --- /dev/null +++ b/marked/Rel-16/28_series/28735/c2fc2621e8206d24427b56bcb2398fc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d44e074084ab8723fd93307d26df3c14136bdf4c4836d5c6b3714bb16858aa15 +size 15593 diff --git a/marked/Rel-16/28_series/28735/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/marked/Rel-16/28_series/28735/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..02b5c8a5f10855afeb0544b98c8f0274af89bc1f --- /dev/null +++ b/marked/Rel-16/28_series/28735/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:996f5d0483633f4c44bd0952f68dbf02e808e06c4c83bef908f96a70e5ccf9f1 +size 37543 diff --git a/marked/Rel-16/28_series/28735/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/28_series/28735/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..29119fcb3e283a325c07f29820e923a67c4718b6 --- /dev/null +++ b/marked/Rel-16/28_series/28735/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f397a2ab4f2ea4ef147c05cae03993be1dd8d76a8e4ee719854a10d4fc06b944 +size 67747 diff --git a/marked/Rel-16/28_series/28735/raw.md b/marked/Rel-16/28_series/28735/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..56bed4322e7f7b2965288e46a41cdf666167f038 --- /dev/null +++ b/marked/Rel-16/28_series/28735/raw.md @@ -0,0 +1,644 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 8 | +| 4 Model ..... | 9 | +| 4.1 Imported information entities and local labels..... | 9 | +| 4.2 Class diagram..... | 9 | +| 4.2.1 Relationships ..... | 9 | +| 4.2.2 Inheritance ..... | 11 | +| 4.3 Class definitions..... | 12 | +| 4.3.1 MtpSignPoint ..... | 12 | +| 4.3.1.1 Definition ..... | 12 | +| 4.3.1.2 Attributes ..... | 12 | +| 4.3.1.3 Attribute constraints..... | 12 | +| 4.3.1.4 Notifications..... | 12 | +| 4.3.2 SignLinkSetTp..... | 12 | +| 4.3.2.1 Definition ..... | 12 | +| 4.3.2.2 Attributes ..... | 13 | +| 4.3.2.3 Attribute constraints..... | 13 | +| 4.3.2.4 Notifications..... | 13 | +| 4.3.3 SignLinkTp ..... | 13 | +| 4.3.3.1 Definition ..... | 13 | +| 4.3.3.2 Attributes ..... | 13 | +| 4.3.3.3 Attribute constraints..... | 13 | +| 4.3.3.4 Notifications..... | 13 | +| 4.3.4 SignRouteSetNePart ..... | 13 | +| 4.3.4.1 Definition ..... | 13 | +| 4.3.4.2 Attributes ..... | 13 | +| 4.3.4.3 Attribute constraints..... | 14 | +| 4.3.4.4 Notifications..... | 14 | +| 4.3.5 SignRouteNePart ..... | 14 | +| 4.3.5.1 Definition ..... | 14 | +| 4.3.5.2 Attributes ..... | 14 | +| 4.3.5.3 Attribute constraints..... | 14 | +| 4.3.5.4 Notifications..... | 14 | +| 4.3.6 M3UAEntity ..... | 14 | +| 4.3.6.1 Definition ..... | 14 | +| 4.3.6.2 Attributes ..... | 14 | +| 4.3.6.3 Attribute constraints..... | 14 | +| 4.3.6.4 Notifications..... | 14 | +| 4.3.7 M3UALinkSetTp..... | 15 | +| 4.3.7.1 Definition ..... | 15 | +| 4.3.7.2 Attributes ..... | 15 | +| 4.3.7.3 Attribute constraints..... | 15 | +| 4.3.7.4 Notifications..... | 15 | +| 4.3.8 M3UALinkTp ..... | 15 | +| 4.3.8.1 Definition ..... | 15 | +| 4.3.8.2 Attributes ..... | 15 | +| 4.3.8.3 Attribute constraints..... | 15 | +| 4.3.8.4 Notifications..... | 15 | +| 4.3.9 M3UARouteSetNePart ..... | 15 | +| 4.3.9.1 Definition ..... | 15 | + +| | | | +|------------------------|----------------------------------|----| +| 4.3.9.2 | Attributes ..... | 16 | +| 4.3.9.3 | Attribute constraints..... | 16 | +| 4.3.9.4 | Notifications..... | 16 | +| 4.3.10 | M3UARouteNePart ..... | 16 | +| 4.3.10.1 | Definition ..... | 16 | +| 4.3.10.2 | Attributes ..... | 16 | +| 4.3.10.3 | Attribute constraints..... | 16 | +| 4.3.10.4 | Notifications..... | 16 | +| 4.4 | Attribute definitions ..... | 17 | +| 4.4.1 | Attribute properties..... | 17 | +| 4.4.2 | Constraints ..... | 19 | +| 4.5 | Common notifications ..... | 19 | +| 4.5.1 | Alarm notifications ..... | 19 | +| 4.5.2 | Configuration notifications..... | 19 | +| Annex A (informative): | Change history..... | 20 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.734: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements +- 28.735: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)** +- 28.736: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named "Signalling Transport Network (STN) interface NRM IRP", through which an "IRPAgent" (typically an Element Manager or Network Element) can communicate Configuration Management information to one or several "IRPManagers" (typically Network Managers) concerning Signalling Transport resources. This IRP comprises a set of specifications defining Requirements, a protocol neutral Network Resource Model (NRM) and corresponding Solution Set(s). + +The present document specifies the protocol neutral STN interface NRM IRP. It reuses relevant parts of the generic NRM in TS 28.622 [6], either by direct reuse or sub-classing, and in addition to that defines Signalling Transport specific Managed Object Classes. + +In order to access the information defined by this NRM, an IRP IS is needed, such as the Basic CM IRP: IS (TS 32.602 [7]) or the Bulk CM IRP: IS (TS 32.612 [8]). However, which IS is applicable is outside the scope of this document. + +Finally, regarding the support of the State Management IRP: IS (TS 28.625 [3]), all NRMs of one release shall support the same State Management IRP version. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication Management, Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 28.625: "Telecommunication management; State Management Integration Reference Point (IRP); Information Service (IS)". +- [4] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [5] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [6] 3GPP TS 28.622: " Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)". +- [8] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Information Service (IS)". +- [9] ITU-T Recommendation Q.700 (03/93): "Introduction to CCITT Signalling System No.7". +- [10] ITU-T Recommendation Q.751.1 (10/95): "Network Element Management Information Model for The Message Transfer Part (MTP)". +- [11] ITU-T Recommendation Q.704 (07/96): "Signalling network functions and messages". +- [12] 3GPP TS 32.111-2: "Telecommunication management; Fault Management (FM); Part 2: Alarm Integration Reference Point (IRP); Information Service (IS)". + +- [13] ITU-T Recommendation Q.702 (11/88): "Signalling Data Link". +- [14] 3GPP TS 29.202: "Signalling System No. 7 (SS7) signalling transport in core network; Stage 3". +- [15] 3GPP TS 25.410: "UTRAN Iu Interface: General Aspects and Principles". +- [16] 3GPP TS 25.420: "UTRAN I<sub>ur</sub> interface general aspects and principles". +- [17] 3GPP TS 25.430: "UTRAN Iub interface: general aspects and principles". +- [18] 3GPP TS 48.018: "Base Station System (BSS)-Serving GPRS Support Node (SGSN);BSS GPRS Protocol (BSSGP)". +- [19] 3GPP TS 48.008: "Mobile Switching Centre-Base Station System (MSC-BSS) interface;Layer 3 specification". +- [20] 3GPP TS 28.702: "Telecommunication management; Core Network Resources Integration Reference Point (IRP); Information Service (IS)". +- [21] 3GPP TS 28.652: "Telecommunication management; UTRAN Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [22] 3GPP TS 29.060: "GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". +- [23] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [24] 3GPP TS 29.018: "Serving GPRS Support Node (SGSN)-Visitors Location Register (VLR) Gs interface layer 3 specification". +- [25] 3GPP TS 28.734: "Telecommunication management; Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [26] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [27] ITU-T Recommendation E.600 (03/93): "Terms and Definitions of traffic engineering". +- [28] IETF RFC 3332: "Signaling System 7 (SS7) Message Transfer Part 3 (MTP3) - User Adaptation Layer (M3UA)". +- [29] IETF RFC 2960: "Stream Control Transmission Protocol (SCTP)". +- [30] IETF RFC 3873: "Stream Control Transmission Protocol (SCTP); Management Information Base (MIB)". +- [31] 3GPP TS 28.620: "Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions in 3GPP TS 32.101 [1], 32.102 [2], 32.600 [5], 28.734 [25] and the following apply: + +**Association:** See definition in TS 28.622 [6]. + +**Managed Element (ME):** See definition in TS 28.622 [6]. + +**Managed Object (MO):** See definition in TS 28.622 [6]. + +**Management Information Model (MIM):** See definition in TS 28.622 [6]. + +**Network Resource Model (NRM):** See definition in TS 28.622 [6]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|---------------------------------------------------------------------------------| +| CM | Configuration Management | +| DN | Distinguished Name | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| ITU-T | International Telecommunication Union, Telecommunication Standardisation Sector | +| ME | Managed Element | +| MIM | Management Information Model | +| MO | Managed Object | +| MTP | Message Transfer Part | +| NE | Network Element | +| NRM | Network Resource Model | +| RDN | Relative Distinguished Name | +| SLC | Signalling Link Code | +| SLS | Signalling Link Selection | +| SP | Signalling Point | +| STN | Signalling Transport Network | +| STP | Signalling Transfer Point | +| TP | Termination Point | +| UML | Unified Modelling Language | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|-----------------------------------------------------------------|------------------------| +| TS 28.620 [31], information object class, <i>Top_</i> | <i>Top_</i> | +| TS 28.622 [6], information object class, <i>ManagedElement</i> | <i>ManagedElement</i> | +| TS 28.622 [6], information object class, <i>ManagedFunction</i> | <i>ManagedFunction</i> | +| TS 28.622 [6], information object class, <i>VsDataContainer</i> | <i>VsDataContainer</i> | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides the overview of the relationships of relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +The figure below shows the name-containment relation and other types of relations of the STN NRM. + +![UML Class diagram showing relationships between MtpSignPoint, SignRouteSetNePart, SignLinkSetTp, and SignLinkTp classes.](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +``` + +classDiagram + class MtpSignPoint { + <<InformationObjectClass>> + } + class SignRouteSetNePart_1 { + <<InformationObjectClass>> + SignRouteSetNePart + } + class SignLinkSetTp { + <<InformationObjectClass>> + } + class SignRouteSetNePart_2 { + <<InformationObjectClass>> + SignRouteSetNePart + } + class SignLinkTp { + <<InformationObjectClass>> + } + + MtpSignPoint "1" *-- "*" SignRouteSetNePart_1 : «names» + MtpSignPoint "1" *-- "*" SignLinkSetTp : «names» + SignRouteSetNePart_1 "1" *-- "*" SignRouteSetNePart_2 : «names» + SignRouteSetNePart_2 "1" -- "1" SignLinkSetTp : + signLinkSetTpPointer + SignLinkSetTp "1" *-- "*" SignLinkTp : «names» + +``` + +UML Class diagram showing relationships between MtpSignPoint, SignRouteSetNePart, SignLinkSetTp, and SignLinkTp classes. + +Figure 4.2.1-1 : Signalling Transport Network NRM Containment/Naming and Association diagram 1 + +![UML Class diagram showing a relationship between ManagedElement and MtpSignPoint classes.](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +``` + +classDiagram + class ManagedElement { + <<InformationObjectClass>> + ManagedElement (from 28.622) + } + class MtpSignPoint { + <<InformationObjectClass>> + } + + ManagedElement "1" *-- "*" MtpSignPoint : «names» + +``` + +UML Class diagram showing a relationship between ManagedElement and MtpSignPoint classes. + +Figure 4.2.1-2 : Signalling Transport Network NRM Containment/Naming and Association diagram 2 + +![Figure 4.2.1-3: VsDataContainer Containment/Naming and Association in STN NRM diagram. This diagram shows five separate instances of a containment/naming relationship. Each instance consists of an 'InformationObjectClass' (MtpSignPoint, SignLinkSetTp, SignRouteNePart, SignLinkTp, or SignRouteSetNePart) at the top, which has a 1-to-many containment relationship with a 'VsDataContainer' (from 28.622) below it. The 'VsDataContainer' then has a 1-to-many association relationship with another 'InformationObjectClass' (the same type as the top one) to its right. All associations are labeled with the role name '«names»'.](e6df2733626a85205c1db682e6259c46_img.jpg) + +Figure 4.2.1-3: VsDataContainer Containment/Naming and Association in STN NRM diagram. This diagram shows five separate instances of a containment/naming relationship. Each instance consists of an 'InformationObjectClass' (MtpSignPoint, SignLinkSetTp, SignRouteNePart, SignLinkTp, or SignRouteSetNePart) at the top, which has a 1-to-many containment relationship with a 'VsDataContainer' (from 28.622) below it. The 'VsDataContainer' then has a 1-to-many association relationship with another 'InformationObjectClass' (the same type as the top one) to its right. All associations are labeled with the role name '«names»'. + +Figure 4.2.1-3 : VsDataContainer Containment/Naming and Association in STN NRM diagram + +![Figure 4.2.1-4: M3UA view of STN NRM Containment/Naming and Association diagram 1. This diagram shows a hierarchy of InformationObjectClasses. At the top is 'M3UAEntity'. It has a 1-to-many containment relationship with 'M3UARouteSetNePart' (labeled '«names»') and a 1-to-many association relationship with 'M3UALinkSetTp' (also labeled '«names»'). 'M3UARouteSetNePart' has a 1-to-many containment relationship with 'M3UARouteNePart' (labeled '«names»'). 'M3UALinkSetTp' has a 1-to-many containment relationship with 'M3UALinkTp' (labeled '«names»'). There is an association relationship between 'M3UARouteNePart' and 'M3UALinkTp' labeled '+ relatedM3UALinkSetTPId'.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +Figure 4.2.1-4: M3UA view of STN NRM Containment/Naming and Association diagram 1. This diagram shows a hierarchy of InformationObjectClasses. At the top is 'M3UAEntity'. It has a 1-to-many containment relationship with 'M3UARouteSetNePart' (labeled '«names»') and a 1-to-many association relationship with 'M3UALinkSetTp' (also labeled '«names»'). 'M3UARouteSetNePart' has a 1-to-many containment relationship with 'M3UARouteNePart' (labeled '«names»'). 'M3UALinkSetTp' has a 1-to-many containment relationship with 'M3UALinkTp' (labeled '«names»'). There is an association relationship between 'M3UARouteNePart' and 'M3UALinkTp' labeled '+ relatedM3UALinkSetTPId'. + +Figure 4.2.1-4: M3UA view of STN NRM Containment/Naming and Association diagram 1 + +![Figure 4.2.1-5: M3UA view of STN NRM Containment/Naming and Association diagram 2. This diagram shows a containment relationship between 'ManagedElement' (from 28.622) and 'M3UAEntity'. 'ManagedElement' is the container with a 1-to-many relationship (labeled '«names»') to 'M3UAEntity'.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +Figure 4.2.1-5: M3UA view of STN NRM Containment/Naming and Association diagram 2. This diagram shows a containment relationship between 'ManagedElement' (from 28.622) and 'M3UAEntity'. 'ManagedElement' is the container with a 1-to-many relationship (labeled '«names»') to 'M3UAEntity'. + +Figure 4.2.1-5: M3UA view of STN NRM Containment/Naming and Association diagram 2 + +![Five UML class diagrams showing containment and naming associations for M3UA classes: M3UAEntity, M3ULinkSetTp, M3URouteSetNePart, M3UAlinkTp, and M3URouteNePart. Each diagram shows a class inheriting from VsDataContainer (from 28.622) with 'names' associations.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +The diagram consists of five separate class diagrams arranged in two rows. Each diagram shows a class box at the top, a class box at the bottom labeled 'VsDataContainer (from 28.622)', and two association lines between them labeled 'names'. The top class has a multiplicity of 1 at its end, and the bottom class has a multiplicity of \* at its end. The classes shown are: +1. «InformationObjectClass» M3UAEntity +2. «InformationObjectClass» M3ULinkSetTp +3. «InformationObjectClass» M3URouteSetNePart +4. «InformationObjectClass» M3UAlinkTp +5. «InformationObjectClass» M3URouteNePart + +Five UML class diagrams showing containment and naming associations for M3UA classes: M3UAEntity, M3ULinkSetTp, M3URouteSetNePart, M3UAlinkTp, and M3URouteNePart. Each diagram shows a class inheriting from VsDataContainer (from 28.622) with 'names' associations. + +Figure 4.2.1-6: VsDataContainer Containment/Naming and Association in M3UA STN NRM diagram + +### 4.2.2 Inheritance + +This clause depicts the inheritance relationships that exist between IOCs. + +The following figure shows the inheritance hierarchy for the STN NRM. + +![UML class diagram showing the inheritance hierarchy for Signalling Transport Network NRM. Five classes (SignLinkTp, SignLinkSetTp, MtpSignPoint, SignRouteSetNePart, SignRouteNePart) inherit from Top_ (from 28.620).](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +The diagram shows a vertical list of five class boxes on the left, each with a horizontal line extending to the right that converges into a single class box on the right. The class boxes on the left are: +1. «InformationObjectClass» SignLinkTp +2. «InformationObjectClass» SignLinkSetTp +3. «InformationObjectClass» MtpSignPoint +4. «InformationObjectClass» SignRouteSetNePart +5. «InformationObjectClass» SignRouteNePart +The class box on the right is: +«InformationObjectClass» Top\_ (from 28.620) + +UML class diagram showing the inheritance hierarchy for Signalling Transport Network NRM. Five classes (SignLinkTp, SignLinkSetTp, MtpSignPoint, SignRouteSetNePart, SignRouteNePart) inherit from Top\_ (from 28.620). + +Figure 4.2.2-1 : Signalling Transport Network NRM Inheritance Hierarchy + +![UML Class Diagram showing inheritance hierarchy for M3UA classes. On the left, five boxes represent: «InformationObjectClass» M3UARouteSetNePart, «InformationObjectClass» M3UARouteNePart, «InformationObjectClass» M3UAEntity, «InformationObjectClass» M3UALinkTp, and «InformationObjectClass» M3UALinkSetTp. Arrows from each of these five boxes point to a single box on the right labeled «InformationObjectClass» ManagedFunction (from 28.622), indicating inheritance.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +UML Class Diagram showing inheritance hierarchy for M3UA classes. On the left, five boxes represent: «InformationObjectClass» M3UARouteSetNePart, «InformationObjectClass» M3UARouteNePart, «InformationObjectClass» M3UAEntity, «InformationObjectClass» M3UALinkTp, and «InformationObjectClass» M3UALinkSetTp. Arrows from each of these five boxes point to a single box on the right labeled «InformationObjectClass» ManagedFunction (from 28.622), indicating inheritance. + +Figure 4.2.2-2: M3UA view of Signalling Transport Network Resource Model Inheritance Hierarchy + +## 4.3 Class definitions + +### 4.3.1 MtpSignPoint + +#### 4.3.1.1 Definition + +This IOC represents the Signalling Point functionality. For more information about the Signalling Point, see ITU-T Q.700 [9] and ITU-T Q.751.1 [10]. + +#### 4.3.1.2 Attributes + +| Attribute Name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------|-------------------|------------|------------|-------------|--------------| +| pointCode | M | M | - | - | M | +| networkIndicator | M | M | - | - | M | +| pointCodeLength | M | M | - | - | M | +| spType | M | M | - | - | M | +| userLabel | M | M | M | - | M | + +#### 4.3.1.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.2 SignLinkSetTp + +#### 4.3.2.1 Definition + +This IOC represents a bi-directional Signalling Link Set Termination Point functionality. For more information about the Signalling Link Set Termination Point, see ITU-T Q.700 [9] and ITU-T Q.751.1 [10]. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| adjPc | M | M | - | - | M | +| userLabel | M | M | M | - | M | +| maxCapacityLS | M | M | - | - | M | + +#### 4.3.2.3 Attribute constraints + +None. + +#### 4.3.2.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.3 SignLinkTp + +#### 4.3.3.1 Definition + +This IOC represents a bi-directional Signalling Link Termination Point functionality. + +For more information about the Signalling Link Termination Point, see ITU-T Q.700 [9] and ITU-T Q.751.1 [10]. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------|-------------------|------------|------------|-------------|--------------| +| slCode | M | M | - | - | M | +| slsCodeNormalList | O | M | - | - | M | +| slsCodeCurrentList | M | M | - | - | M | +| linkTpStatus | M | M | - | - | M | +| maxCapacitySL | M | M | - | - | M | +| userLabel | M | M | M | - | M | +| signLinkType | M | M | - | - | M | + +#### 4.3.3.3 Attribute constraints + +None. + +#### 4.3.3.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.4 SignRouteSetNePart + +#### 4.3.4.1 Definition + +This IOC represents a Signalling Route Set functionality. For more information about the Signalling Route Set Network Element Part, see ITU-T Q.700 [9] and ITU-T Q.751.1 [10]. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------------------|-------------------|------------|------------|-------------|--------------| +| destinationPc | M | M | - | - | M | +| userLabel | M | M | M | - | M | +| loadsharingInformationRouteSetNePart | M | M | - | - | M | + +#### 4.3.4.3 Attribute constraints + +None. + +#### 4.3.4.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.5 SignRouteNePart + +#### 4.3.5.1 Definition + +This IOC represents a Signalling Route functionality. For more information about the Signalling Route Network Element Part, see ITU-T Q.700 [9] and ITU-T Q.751.1 [10]. + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| fixedPriority | M | M | - | - | M | +| userLabel | M | M | M | - | M | +| <b>Attribute related to role</b> | | | | | | +| signLinkSetTpPointer | M | M | - | - | M | + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.6 M3UAEntity + +#### 4.3.6.1 Definition + +This IOC represents a functionality entity which processes M3UA signalling. For more information about M3UA, see [14] and [28]. + +#### 4.3.6.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|------------|-------------|--------------| +| m3UAEntityPointCode | M | M | - | - | M | +| m3UAEntityType | M | M | - | - | M | +| networkIndicator | M | M | - | - | M | +| pointCodeLength | M | M | - | - | M | + +#### 4.3.6.3 Attribute constraints + +None. + +#### 4.3.6.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.7 M3UALinkSetTp + +#### 4.3.7.1 Definition + +This IOC represents a bi-directional termination point functionality of M3UA signalling link set which is the set of M3UA signalling links between M3UA\_AS and SG or between M3UA\_AS and M3UA\_AS. For more information about M3UA\_AS and SG, see [14] and [28]. + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| adjPc | M | M | - | - | M | +| trafficMode | M | M | - | - | M | + +#### 4.3.7.3 Attribute constraints + +None. + +#### 4.3.7.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.8 M3UALinkTp + +#### 4.3.8.1 Definition + +This IOC represents a termination point functionality of M3UA signalling link which is a bi-directional M3UA logical communication channel between the particular SCTP termination points of signalling gateway process (SGP) and application server process (ASP) or the logical communication channel between the particular SCTP termination points of two IP server processes (IPSPs). + +For more information about M3UA and SCTP signalling information, see [14] and [28]. + +#### 4.3.8.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------|-------------------|------------|------------|-------------|--------------| +| m3UALinkTPState | M | M | - | - | M | +| sCTPassocLocalAddr | M | M | - | - | M | +| sCTPassocRemoteAddr | O | M | - | - | M | + +#### 4.3.8.3 Attribute constraints + +None. + +#### 4.3.8.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.9 M3UARouteSetNePart + +#### 4.3.9.1 Definition + +This IOC represents a set of the M3UA signalling route between M3UA local entity and M3UA destination entity. For M3UA signalling information, see [14] and [28]. + +#### 4.3.9.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| destinationPc | M | M | - | - | M | + +#### 4.3.9.3 Attribute constraints + +None. + +#### 4.3.9.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +### 4.3.10 M3UARouteNePart + +#### 4.3.10.1 Definition + +This IOC represents a path between local M3UA entity and destination M3UA entity. For more information about M3UA signalling, see [14] and [28]. + +#### 4.3.10.2 Attributes + +| <b>Attribute name</b> | <b>Support Qualifier</b> | <b>isReadable</b> | <b>isWritable</b> | <b>isInvariant</b> | <b>isNotifyable</b> | +|----------------------------------|--------------------------|-------------------|-------------------|--------------------|---------------------| +| fixedPriority | M | M | - | - | M | +| <b>Attribute related to role</b> | | | | | | +| relatedM3UALinkSetTPId | M | M | - | - | M | + +#### 4.3.10.3 Attribute constraints + +None. + +#### 4.3.10.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| adjPc | The signalling point code information of the signalling point adjacent to the signalling link set. (Ref ITU-T Q.704 [11], Ref ITU-T Q.751.1 [10])<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| destinationPc | The signalling point code information of the destination signalling point of the signalling route set. (Ref ITU-T Q.704 [11], Ref ITU-T Q.751.1 [10])<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| fixedPriority | This attribute determines, if the signallingRoute is used as current route. The signallingRoute instances contained in the same signallingRouteSet are chosen in ascending order as current routes (The lower the value, the higher the priority).<br><br>The priority is defined by means of assigning priorities to all involved route segments. If from a particular SP two or more route segments are used with the same priority, loadsharing between Signalling Routes may occur (Ref ITU-T Q.751.1 [10]).<br><br>allowedValues: 0...255, maximum value is implementation dependent | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| linkTpStatus | This is a set-valued attribute. It contains the functional statuses as described in ITU-T Q.704 [11]. (Ref ITU-T Q.704 [11], Ref ITU-T Q.751.1 [10])<br><br>allowedValues:<br><ul style="list-style-type: none"> <li>localBlocked, remoteBlocked, localInhibited, remoteInhibited, failed, deactivated</li> <li>The absence of any value (i.e. Null) indicates a status of available.</li> </ul> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| loadsharingInformation<br>RouteSetNePart | This attribute contains specific information for target specific loadsharing via the current routes working on a routeset basis via the current routes. (Ref ITU-T Q.751.1 [10])<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| maxCapacityLS | The maximum capacity of a signalling linkset is the maximum load that should be placed on the linkset, when all links that could be active in the linkset are, and are working in service. Unit: Erlang (Ref ITU-T E.600 [27])<br><br>allowedValues: N/A | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| maxCapacitySL | This attribute describes the maximum capacity for the signLinkTp. The maximum capacity of a signalling link is the maximum load that should be placed on the signalling link. Unit: Erlang (Ref ITU-T E.600 [27])<br><br>allowedValues: N/A | type: Real<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| m3UAEntityPointCode | The M3UA signalling point code information of the signalling point. (Ref ITU-T Q.704[11],Ref ITU-T Q.751.1[10])<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| m3UAEntityType | It identifies the M3UA entity Type.<br><br>allowedValues:<br><ul style="list-style-type: none"> <li>M3UA Application Server (M3UA_AS), Signalling Gateway (SG)<br/>Note: M3UA_AS is defined as AS in Ref.[28]</li> </ul> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| m3UALinkTPState | This attribute represents the state of M3UA signalling link.<br><br>allowedValues: Ref. [28], Ref. [29]<br><ul style="list-style-type: none"> <li>UNESTABLISH (0): SCTP association of the m3ua link is not established.</li> <li>ESTABLISHED (1): SCTP association of the M3UA link is established, but the ASP state is down.</li> <li>INACTIVE (2): ASP state is up.</li> <li>ACTIVE (3): ASP state is active.</li> </ul> | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| networkIndicator | The network indicator information of the signalling point, (Ref ITU-T Q.704 [11], Ref ITU-T Q.751.1 [10])<br><br>allowedValues: International, Spare, National, NationalSpare | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed Values | Properties | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| pointCode | The signalling point code information of the signalling point. (Ref ITU-T Q.704 [11], Ref ITU-T Q.751.1 [10])<br><br>allowedValues: N/A | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pointCodeLength | The signalling point code length information of the signalling point. (Ref ITU-T Q.704 [11])<br><br>allowedValues: 14, 24 | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sCTPAssocLocalAddr | This attribute represents the SCTP association local port and IP address (Ref.[30]).<br><br>portId:Unique identification of port (port number, integer) ;<br>List of { AddrType(IPv4, IPv6), IPaddr (string)}.<br><br>allowedValues: N/A | type: <<datatype>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sCTPAssocRemoteAddr | This attribute represents the corresponding SCTP association port and IP address (Ref.[30]).<br><br>portId:Unique identification of port (port number, integer) ;<br>List of { AddrType(IPv4, IPv6), IPaddr (string)}.<br><br>allowedValues: N/A | type: <<datatype>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| signLinkType | This attribute represents the type of signalling link.<br><br>allowedValues: 64K, 2M | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| slCode | The Signalling Link Code (SLC) is used to distinguish signalling link in the signalling link set. It is the same value (between 0 and 15) at each end of the link, and is different from that of any other link between the same two adjacent signalling points. (Ref ITU-T Q.704 [11], Ref ITU-T Q.751.1 [10])<br><br>allowedValues: 0...15 | type: Integer<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| slsCodeCurrentList | This attribute represents the SLS-Code which is currently used on the signallingLinkTp. It may be different from the slsNormalList, in case some fault has occurred. (Ref ITU-T Q.751.1 [10])<br><br>SET SIZE (0..16) OF SIs<br>-- Each SIs value can occur at most once in a given SET<br><br>allowedValues: 0...15 | type: Integer<br>multiplicity: 0..16<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| slsCodeNormalList | This attribute indicates which SLS-Codes are initially administratively assigned to this signallingLinkTp for the normal operation. (Ref ITU-T Q.751.1 [10])<br><br>SET SIZE (0..16) OF SIs<br>-- Each SIs value can occur at most once in a given SET<br><br>allowedValues: 0...15 | type: Integer<br>multiplicity: 0..16<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: False | +| spType | The type of the signalling point. (Ref ITU-T Q.700[9], Ref ITU-T Q.751.1 [10])<br><br>allowedValues: SEP, STP, STEP | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| trafficMode | It identifies the selected mode of M3UA signalling link (Ref. [28]).<br><br>allowedValues: Override mode, Load share mode, Broadcast mode | type: <<enumeration>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| userLabel | A user-friendly name of this object.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| <b>Attribute related to role</b> | | | + +| Attribute Name | Documentation and Allowed Values | Properties | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| relatedM3UALinkSetTPId | This role attribute represents a uni-directional relation between the M3UARouteNePart and M3UALinkSetTP. This role (when present) represents M3UARouteNePart capability to identify the connected M3UALinkSetTP. When the role is present, the attribute shall carry the M3UALinkSetTP DN.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False<br>passedByld: True | +| signLinkSetTpPointer | It references the signallingLinkSetTp which is intended to be used as first segment of the succession of linksets, which form the signalling route on the network level.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False<br>passedByld: True | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +### 4.5.1 Alarm notifications + +This clause presents a list of notifications, defined in [5], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [14], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|--------------------------------|---------------------------------------|-------| +| notifyAckStateChanged | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyChangedAlarm | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyClearedAlarm | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyNewAlarm | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyComments | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyAlarmListRebuilt | See Alarm IRP (3GPP TS 32.111-2 [12]) | | +| notifyPotentialFaultyAlarmList | See Alarm IRP (3GPP TS 32.111-2 [12]) | | + +### 4.5.2 Configuration notifications + +This clause presents a list of notifications, defined in [3], that IRPManager can receive. The notification header attribute objectClass/objectInstance, defined in [14], would capture the DN of an instance of an IOC defined in this IRP specification. + +| Name | Qualifier | Notes | +|----------------------------|-----------|-------| +| notifyAttributeValueChange | O | | +| notifyObjectCreation | O | | +| notifyObjectDeletion | O | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|---------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-06 | SA#64 | SP-140358 | 001 | - | remove the feature support statements | 11.0.0 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | 12.0.0 | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | 13.0.0 | +| 2017-03 | - | - | - | - | Update to Rel-14 version (MCC) | 13.0.0 | 14.0.0 | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | 15.0.0 | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28736/raw.md b/marked/Rel-16/28_series/28736/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ecb7187a79f64f1d9efdcdd04731ba5861a369bd --- /dev/null +++ b/marked/Rel-16/28_series/28736/raw.md @@ -0,0 +1,1069 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------|-----------| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Solution Set Definitions ..... | 8 | +| <b>Annex A (normative): CORBA Solution Set.....</b> | <b>9</b> | +| A.0 General..... | 9 | +| A.1 Architectural features..... | 9 | +| A.1.0 Introduction ..... | 9 | +| A.1.1 Syntax for Distinguished Names..... | 9 | +| A.1.2 Rules for NRM extensions ..... | 9 | +| A.2 Mapping ..... | 9 | +| A.2.1 General mappings..... | 9 | +| A.2.2 Information Object Class (IOC) mapping..... | 9 | +| A.2.2.1 IOC MtpSignPoint..... | 9 | +| A.2.2.2 IOC SignLinkSetTp..... | 10 | +| A.2.2.3 IOC SignLinkTp..... | 10 | +| A.2.2.4 IOC SignRouteSetNePart ..... | 10 | +| A.2.2.5 IOC SignRouteNePart ..... | 10 | +| A.2.3 Information Object Class (IOC) Mapping ..... | 10 | +| A.2.3.1 IOC M3UAEntity ..... | 11 | +| A.2.3.2 IOC M3UALinkSetTp..... | 11 | +| A.2.3.3 IOC M3UALinkTp..... | 11 | +| A.2.3.4 IOC M3UARouteSetNePart ..... | 11 | +| A.2.3.5 IOC M3UARouteNePart ..... | 12 | +| A.3 Solution Set definitions..... | 13 | +| A.3.1 IDL definition structure..... | 13 | +| A.3.2 IDL specification "STNNetworkResourcesIRPSystem.idl" ..... | 14 | +| A.3.3 IDL specification "STNNetworkResourcesIRPDefs.idl" ..... | 16 | +| <b>Annex B (normative): XML Definitions.....</b> | <b>19</b> | +| B.0 General..... | 19 | +| B.1 Architectural features..... | 19 | +| B.1.0 Introduction ..... | 19 | +| B.1.1 Syntax for Distinguished Names..... | 19 | +| B.2 Mapping ..... | 19 | +| B.2.1 General mapping ..... | 19 | +| B.2.2 Information Object Class (IOC) mapping ..... | 19 | +| B.3 Solution Set definitions..... | 20 | +| B.3.1 XML definition structure ..... | 20 | +| B.3.2 Graphical Representation..... | 20 | +| B.3.3 XML schema "stnNrm.xsd"..... | 21 | +| Annex C (informative): Change history..... | 26 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- 28.734: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP): Requirements +- 28.735: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS) +- 28.736: Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions** + +# --- 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Signalling Transport Network (STN) interface Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning STN interface resources. The STN interface NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the STN interface NRM IRP. + +This Solution Set definition is related to 3GPP TS 28.735 [9] V14.0.X. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)". +- [3] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [4] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [5] Void +- [6] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [7] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [8] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". +- [9] 3GPP TS 28.735: "Telecommunication management; Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [10] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [11] 3GPP TS 28.623: "Telecommunication management; Generic Network Resources Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**XML file:** See definition of [11]. + +**XML document:** See definition of [11]. + +**XML declaration:** See definition of [11]. + +**XML element:** See definition of [11]. + +**empty XML element:** See definition of [11]. + +**XML content (of an XML element):** See definition of [11]. + +**XML start-tag:** See definition of [11]. + +**XML end-tag:** See definition of [11]. + +**XML empty-element tag:** See definition of [11]. + +**XML attribute specification:** See definition of [11]. + +**DTD:** See definition of [11]. + +**XML schema:** See definition of [11]. + +**XML namespace:** See definition of [11]. + +**XML complex type:** See definition of [11]. + +**XML element type:** See definition of [11]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|--------------------------------------------| +| CM | Configuration Management | +| CORBA | Common Object Request Broker Architecture | +| DN | Distinguished Name | +| DTD | Document Type Definition | +| IDL | Interface Definition Language | +| IRP | Integration Reference Point | +| IS | Information Service | +| MO | Managed Object | +| MOC | Managed Object Class | +| NRM | Network Resource Model | +| OMG | Object Management Group | +| SS | Solution Set | +| STN | Signalling Transport Network | +| UMTS | Universal Mobile Telecommunications System | +| UTRAN | Universal Terrestrial Radio Access Network | +| XML | eXtensible Markup Language | + +# --- 4 Solution Set Definitions + +This specification defines the following 3GPP STN NRM IRP Solution Set Definitions: + +- 3GPP STN NRM IRP CORBA SS (Annex A) +- 3GPP STN NRM IRP XML Definitions (Annex B) + +# --- Annex A (normative): CORBA Solution Set + +## A.0 General + +This annex contains the CORBA Solution Set for the IRP whose semantics is specified in STN NRM IRP: Information Service (TS 28.735 [9]). + +--- + +## A.1 Architectural features + +### A.1.0 Introduction + +The overall architectural feature of STN Network Resources IRP is specified in 3GPP TS 28.735 [9]. This clause specifies features that are specific to the CORBA SS. + +#### A.1.1 Syntax for Distinguished Names + +See clause A.1.1 of [11]. + +#### A.1.2 Rules for NRM extensions + +See clause A.1.2 of [11]. + +--- + +## A.2 Mapping + +#### A.2.1 General mappings + +See clause A.2.1 of [11]. + +#### A.2.2 Information Object Class (IOC) mapping + +This SS supports reference attributes for relations other than containment relations between objects. Reference attributes are therefore introduced in each MOC where needed. + +#### A.2.2.1 IOC MtpSignPoint + +**Mapping from NRM IOC MtpSignPoint attributes to SS equivalent MOC MtpSignPoint attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------|------------------|------------------------------------------------------------------------| +| id | mtpSignPointId | string | +| pointCode | pointCode | unsigned long | +| networkIndicator | networkIndicator | STNNetworkResourcesIRPSystem::AttributeType<br>s::NetworkIndicatorType | +| pointCodeLength | pointCodeLength | STNNetworkResourcesIRPSystem::AttributeType<br>s::PointCodeLengthType | +| spType | spType | STNNetworkResourcesIRPSystem::AttributeType<br>s::SPTTypeType | +| userLabel | userLabel | string | + +##### A.2.2.2 IOC SignLinkSetTp + +Mapping from NRM IOC SignLinkSetTp attributes to SS equivalent MOC SignLinkSetTp attributes + +| IS Attributes | SS Attributes | SS Type | +|---------------|-----------------|---------------| +| id | signLinkSetTpId | string | +| adjPc | adjPc | unsigned long | +| userLabel | userLabel | string | +| maxCapacityLS | maxCapacityLS | float | + +#### A.2.2.3 IOC SignLinkTp + +Mapping from NRM IOC SignLinkTp attributes to SS equivalent MOC SignLinkTp attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------|--------------------|----------------------------------------------------------------| +| id | signLinkTpId | string | +| slsCode | slsCode | unsigned long | +| slsCodeNormalList | slsCodeNormalList | STNNetworkResourcesIRPSystem::AttributeTypes::SLSLISType | +| slsCodeCurrentList | slsCodeCurrentList | STNNetworkResourcesIRPSystem::AttributeTypes::SLSLISType | +| linkTpStatus | linkTpStatus | STNNetworkResourcesIRPSystem::AttributeTypes::LinkStatusType | +| maxCapacitySL | maxCapacitySL | float | +| userLabel | userLabel | string | +| signLinkType | signLinkType | STNNetworkResourcesIRPSystem::AttributeTypes::SignLinkTypeType | + +#### A.2.2.4 IOC SignRouteSetNePart + +Mapping from NRM IOC SignRouteSetNePart attributes to SS equivalent MOC SignRouteSetNePart attributes + +| IS Attributes | SS Attributes | SS Type | +|--------------------------------------|--------------------------------------|---------------| +| id | signRouteSetNePartId | string | +| destinationPc | destinationPc | unsigned long | +| userLabel | userLabel | string | +| loadsharingInformationRouteSetNePart | loadsharingInformationRouteSetNePart | string | + +##### A.2.2.5 IOC SignRouteNePart + +Mapping from NRM IOC SignRouteNePart attributes and association roles to SS equivalent MOC SignRouteNePart attributes + +| IS Attributes | SS Attributes | SS Type | +|----------------------|----------------------|---------------------------------------------------------------| +| id | signRouteNePartId | string | +| signLinkSetTpPointer | signLinkSetTpPointer | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | +| fixedPriority | fixedPriority | unsigned long | +| userLabel | userLabel | string | + +#### A.2.3 Information Object Class (IOC) Mapping + +This SS supports reference attributes for relations other than containment relations between objects. Reference attributes are therefore introduced in each MOC where needed. + +#### A.2.3.1 IOC M3UAEEntity + +**Mapping from NRM IOC M3UAEEntity attributes to SS equivalent MOC M3UAEEntity attributes** + +| IS Attributes | SS Attributes | SS Type | +|----------------------|----------------------|--------------------------------------------------------------------| +| id | m3UAEEntityId | string | +| m3UAEEntityPointCode | m3UAEEntityPointCode | unsigned long | +| m3UAEEntityType | m3UAEEntityType | STNNetworkResourcesIRPSystem::AttributeTypes::m3UAEEntityTypeType | +| networkIndicator | networkIndicator | STNNetworkResourcesIRPSystem::AttributeTypes::networkIndicatorType | +| pointCodeLength | pointCodeLength | STNNetworkResourcesIRPSystem::AttributeTypes::PointCodeLengthType | + +##### A.2.3.2 IOC M3UALinkSetTp + +**Mapping from NRM IOC m3UALinkSetTp attributes to SS equivalent MOC m3UALinkSetTp attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------|-----------------|---------------------------------------------------------------| +| id | m3UALinkSetTPId | string | +| adjPc | adjPc | unsigned long | +| trafficMode | trafficMode | STNNetworkResourcesIRPSystem::AttributeTypes::trafficModeType | + +##### A.2.3.3 IOC M3UALinkTp + +**Mapping from NRM IOC m3UALinkTp attributes to SS equivalent MOC m3UALinkTp attributes** + +| IS Attributes | SS Attributes | SS Type | +|---------------------|---------------------|-------------------------------------------------------------------| +| id | m3UALinkTpId | string | +| m3UALinkTPState | m3UALinkTPState | STNNetworkResourcesIRPSystem::AttributeTypes::m3UALinkTPStateType | +| sCTPAssocLocalAddr | sCTPAssocLocalAddr | STNNetworkResourcesIRPSystem::AttributeTypes::sCTPAssocAddrType | +| sCTPAssocRemoteAddr | sCTPAssocRemoteAddr | STNNetworkResourcesIRPSystem::AttributeTypes::sCTPAssocAddrType | + +#### A.2.3.4 IOC M3UARouteSetNePart + +**Mapping from NRM IOC m3UARouteSetNePart attributes to SS equivalent MOC m3UARouteSetNePart attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------------------|------------------------------|---------------------------------------------------------------| +| id | m3UARouteSetNePartId | string | +| destinationPc | destinationPc | unsigned long | +| m3UARouteNePartm3UALinkSetTP | m3UARouteNePartm3UALinkSetTP | GenericNetworkResourcesIRPSystem::AttributeTypes::MOReference | + +##### A.2.3.5 IOC M3UARouteNePart + +**Mapping from NRM IOC m3UARouteNePart attributes to SS equivalent MOC m3UARouteNePart attributes** + +| IS Attributes | SS Attributes | SS Type | +|------------------------|-------------------|-----------------------------------------------------------------| +| id | m3UARouteNePartId | string | +| relatedM3UALinkSetTPId | m3UALinkSetTPId | string | +| fixedPriority | fixedPriority | STNNetworkResourcesIRPSystem::AttributeTypes::fixedPriorityType | + +## --- A.3 Solution Set definitions + +#### A.3.1 IDL definition structure + +Clause A.3.2 defines the types which are used by the STN NRM IRP. + +Clause A.3.3 defines the MO classes for the STN NRM IRP. + +#### A.3.2 IDL specification "STNNetworkResourcesIRPSystem.idl" + +``` +// File: STNNetworkResourcesIRPSystem.idl +#ifndef _STN_NETWORK_RESOURCES_IRP_SYSTEM_IDL_ +#define _STN_NETWORK_RESOURCES_IRP_SYSTEM_IDL_ +#pragma prefix "3gppsa5.org" +module STNNetworkResourcesIRPSystem +{ + /** + * This module adds datatype definitions for types + * used in the NRM which are not basic datatypes defined + * already in CORBA. + */ + module AttributeTypes + { + enum NetworkIndicatorType + { + INTERNATIONAL, + SPARE, + NATIONAL, + NATIONAL_SPARE + }; + enum PointCodeLengthType + { + BITS_24, + BITS_14 + }; + enum SPTTypeType + { + SEP, + STP, + STEP + }; + typedef unsigned long SLSType; // 0..15 + typedef sequence<SLSType,16> SLSTypeList; + enum LinkStati + { + DEACTIVATED, + FAILED, + LOCAL_BLOCKED, + REMOTE_BLOCKED, + LOCAL_INHIBITED, + REMOTE_INHIBITED + }; + typedef sequence <LinkStati,6> LinkStatusType; + enum SignLinkTypeType + { + ST_64K, + ST_2M + }; + enum m3UAEntityType + { + M3UA_AS, + SG + }; + enum m3UALinkTPStateType + { + UNESTABLISH, + ESTABLISHED, + INACTIVE, + ACTIVE + }; + enum AddrType + { + IPV4, + IPV6 + }; + struct SCTPAssocAddrType + { + unsigned long portId; + AddrType addrType; + string IPaddr; + }; + enum trafficModeType + { + OVERRIDE, + LOAD_SHARE, + }; + } +} +``` + +``` + BROADCAST + }; +}; +}; +#endif // _STN_NETWORK_RESOURCES_IRP_SYSTEM_IDL_ +``` + +#### A.3.3 IDL specification "STNNetworkResourcesIRPDefs.idl" + +``` +// File: STNNetworkResourcesIRPDefs.idl +#ifndef _STN_NETWORK_RESOURCES_IRP_DEFS_IDL_ +#define _STN_NETWORK_RESOURCES_IRP_DEFS_IDL_ + +#include "GenericNetworkResourcesNRMDefs.idl" + +#pragma prefix "3gppsa5.org" + +/** + * This module defines constants for each MO class name and + * the attribute names for each defined MO class. + */ +module STNNetworkResourcesIRPDefs +{ + + /** + * Definitions for MO class MtpSignPoint + */ + interface MtpSignPoint: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "MtpSignPoint"; + + // Attribute Names + // + const string mtpSignPointId = "mtpSignPointId"; + const string pointCode = "pointCode"; + const string networkIndicator = "networkIndicator"; + const string pointCodeLength = "pointCodeLength"; + const string spType = "spType"; + const string userLabel = "userLabel"; + }; + + /** + * Definitions for MO class SignLinkSetTp + */ + interface SignLinkSetTp: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "SignLinkSetTp"; + + // Attribute Names + // + const string signLinkSetTpId = "signLinkSetTpId"; + const string adjPc = "adjPc"; + const string userLabel = "userLabel"; + const string maxCapacityLS = "maxCapacityLS"; + }; + + /** + * Definitions for MO class SignLinkTp + */ + interface SignLinkTp: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "SignLinkTp"; + + // Attribute Names + // + const string signLinkTpId = "signLinkTpId"; + const string slCode = "slCode"; + const string slsCodeNormalList = "slsCodeNormalList"; + const string slsCodeCurrentList = "slsCodeCurrentList"; + const string linkTpStatus = "linkTpStatus"; + const string maxCapacitySL = "maxCapacitySL"; + const string userLabel = "userLabel"; + const string signLinkType = "signLinkType"; + }; + + /** + * Definitions for MO class SignRouteSetNePart + */ + interface SignRouteSetNePart: GenericNetworkResourcesNRMDefs::Top + { + const string CLASS = "SignRouteSetNePart"; + }; +} +``` + +``` + // Attribute Names + // + const string signRouteSetNePartId = "signRouteSetNePartId"; + const string destinationPc = "destinationPc"; + const string userLabel = "userLabel"; + const string loadsharingInformationRouteSetNePart = "loadsharingInformationRouteSetNePart"; +}; + +/** + * Definitions for abstract MO class SignRouteNePart + */ +interface SignRouteNePart: GenericNetworkResourcesNRMDefs::Top +{ + const string CLASS = "SignRouteNePart"; + + // Attribute Names + // + const string signRouteNePartId = "signRouteNePartId"; + const string signLinkSetTpPointer = "signLinkSetTpPointer"; + const string fixedPriority = "fixedPriority"; + const string userLabel = "userLabel"; +}; + +/** + * Definitions for MO class M3UAEntity + */ +interface M3UAEntity: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "M3UAEntity"; + // Attribute Names + // + const string m3UAEntityId = "m3UAEntityId"; + const string m3UAEntityPointCode = "m3UAEntityPointCode"; + const string m3UAEntityType = "m3UAEntityType"; + const string networkIndicator = "networkIndicator"; + const string pointCodeLength = "pointCodeLength"; +}; + +/** + * Definitions for MO class M3UALinkSetTp + */ +interface M3UALinkSetTp: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "M3UALinkSetTp"; + // Attribute Names + // + const string m3UALinkSetTPId = "m3UALinkSetTPId"; + const string adjPc = "adjPc"; + const string trafficMode = "trafficMode"; +}; + +/** + * Definitions for MO class M3UALinkTp + */ +interface M3UALinkTp: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "M3UALinkTp"; + // Attribute Names + // + const string m3UALinkTpId = "m3UALinkTpId"; + const string m3UALinkTPState = "m3UALinkTPState"; + const string SCTPAssocLocalAddr = "sCTPAssocLocalAddr"; + const string SCTPAssocRemoteAddr = "sCTPAssocRemoteAddr"; +}; + +/** + * Definitions for MO class M3UARouteSetNePart + */ +interface M3UARouteSetNePart: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "M3UARouteSetNePart"; + + // Attribute Names + const string m3UARouteSetNePartId = "m3UARouteSetNePartId"; + const string destinationPc = "destinationPc"; + const string m3UARouteNePartm3UALinkSetTP = "m3UARouteNePartm3UALinkSetTP"; +}; +``` + +``` +/** + * Definitions for abstract MO class M3UARouteNePart + * + */ +interface M3UARouteNePart: GenericNetworkResourcesNRMDefs::ManagedFunction +{ + const string CLASS = "M3UARouteNePart"; + // Attribute Names + // + const string m3UARouteNePartId = "m3UARouteNePartId"; + const string m3UALinkSetTPId = "m3UALinkSetTPId"; + const string fixedPriority = "fixedPriority"; +}; + +#endif // _STN_NETWORK_RESOURCES_IRP_DEFS_IDL_ +``` + +# --- Annex B (normative): XML Definitions + +## B.0 General + +This annex contains the XML Definitions for the Generic NRM IRP as it applies to Itf-N, in accordance with STN NRM IRP Information Service (TS 28.735 [9]). + +The XML file formats are based on XML [4], XML Schema [6] [7] and XML Namespace [8] standards. + +## --- B.1 Architectural features + +### B.1.0 Introduction + +The overall architectural feature of STN IRP is specified in 3GPP TS 28.735 [9]. +This clause specifies features that are specific to the Schema definitions. + +#### B.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [10]. + +## --- B.2 Mapping + +#### B.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +#### B.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## --- B.3 Solution Set definitions + +### B.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [3]. + +Annex B.3.3 defines the NRM-specific XML schema `stnNrm.xsd` for the STN NRM IRP defined in 3GPP TS 28.735 [9]. + +XML schema `stnNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [3]. + +### B.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +### B.3.3 XML schema "stnNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.736 STN Network Resources IRP + Bulk CM Configuration data file NRM-specific XML schema + stnNrm.xsd +--> + +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.736#stnNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:xn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + xmlns:stn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.736#stnNrm" +> + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" + /> + + <!-- STN Network Resources IRP NRM attribute related XML types --> + + <simpleType name="networkIndicator"> + <restriction base="string"> + <enumeration value="International"/> + <enumeration value="Spare"/> + <enumeration value="National"/> + <enumeration value="NationalSpare"/> + </restriction> + </simpleType> + + <simpleType name="pointCodeLength"> + <restriction base="string"> + <enumeration value="BITS_24"/> + <enumeration value="BITS_14"/> + </restriction> + </simpleType> + + <simpleType name="spType"> + <restriction base="string"> + <enumeration value="SEP"/> + <enumeration value="STP"/> + <enumeration value="STEP"/> + </restriction> + </simpleType> + + <complexType name="slsCodeList"> + <sequence> + <element name="slsCode" minOccurs="0" maxOccurs="16"> + <simpleType> + <restriction base="integer"> + <minInclusive value="0"/> + <maxInclusive value="15"/> + </restriction> + </simpleType> + </element> + </sequence> + </complexType> + + <simpleType name="linkTpStatusElementType"> + <restriction base="string"> + <enumeration value="deactivated"/> + <enumeration value="failed"/> + <enumeration value="localBlocked"/> + <enumeration value="remoteBlocked"/> + <enumeration value="localInhibited"/> + <enumeration value="remoteInhibited"/> + </restriction> + </simpleType> + + <complexType name="linkTpStatusType"> + <sequence minOccurs="0" maxOccurs="6"> + <element name="linkTpStatusElement" type="stn:linkTpStatusElementType"/> + </sequence> + </complexType> +</schema> +``` + +``` + + </sequence> + </complexType> + <simpleType name="signLinkType"> + <restriction base="string"> + <enumeration value="ST_64K"/> + <enumeration value="ST_2M"/> + </restriction> + </simpleType> + <simpleType name="m3UAEntityTypeType"> + <restriction base="string"> + <enumeration value="M3UA_AS"/> + <enumeration value="SG"/> + </restriction> + </simpleType> + <simpleType name="m3UALinkTPStateType"> + <restriction base="string"> + <enumeration value="UNESTABLISH"/> + <enumeration value="ESTABLISHED"/> + <enumeration value="INACTIVE"/> + <enumeration value="ACTIVE"/> + </restriction> + </simpleType> + <simpleType name="IPAddrTypeType"> + <restriction base="string"> + <enumeration value="IPv4"/> + <enumeration value="IPv6"/> + </restriction> + </simpleType> + <complexType name="sCTPAssocAddrType"> + <sequence minOccurs="0" maxOccurs="unbounded"> + <element name="IPAddrType" type="stn:IPAddrTypeType"/> + <element name="IPAddr" type="string"/> + </sequence> + </complexType> + <simpleType name="trafficModeType"> + <restriction base="string"> + <enumeration value="Override"/> + <enumeration value="LoadShare"/> + <enumeration value="Broadcast"/> + </restriction> + </simpleType> +<!-- STN Network Resources IRP NRM class associated XML elements --> + +<element name="MtpSignPoint" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="pointCode" type="unsignedLong"/> + <element name="networkIndicator" type="stn:networkIndicator"/> + <element name="pointCodeLength" type="stn:pointCodeLength"/> + <element name="spType" type="stn:spType"/> + <element name="userLabel" type="string"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="stn:SignLinkSetTp"/> + <element ref="stn:SignRouteSetNePart"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SignLinkSetTp"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + +``` + +``` +<element name="adjPc" type="unsignedLong"/> +<element name="userLabel" type="string"/> +<element name="maxCapacityLS" type="float"/> +</all> +</complexType> +</element> +<choice minOccurs="0" maxOccurs="unbounded"> + <element ref="stn:SignLinkTp"/> + <element ref="xn:VsDataContainer"/> +</choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="SignLinkTp"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="slCode" type="integer"/> + <element name="slsCodeNormalList" type="stn:slsCodeList" minOccurs="0"/> + <element name="slsCodeCurrentList" type="stn:slsCodeList"/> + <element name="linkTpStatus" type="stn:linkTpStatusType"/> + <element name="maxCapacitySL" type="integer"/> + <element name="userLabel" type="string"/> + <element name="signLinkType" type="stn:signLinkType"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SignRouteSetNePart"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="destinationPc" type="unsignedLong"/> + <element name="userLabel" type="string"/> + <element name="loadsharingInformationRouteSetNePart" type="string"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="stn:SignRouteNePart"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SignRouteNePart"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="signLinkSetTpPointer" type="xn:dn"/> + <element name="fixedPriority" type="unsignedLong"/> + <element name="userLabel" type="string"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<!-- M3UA Network Resources IRP NRM class associated XML elements --> +<element name="M3UAEntity" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <sequence> + <element name="m3UAEntityPointCode" type="unsignedLong"/> + <element name="m3UAEntityType" type="stn:m3UAEntityTypeType"/> + <element name="networkIndicator" type="stn:networkIndicator"/> + <element name="pointCodeLength" type="stn:pointCodeLength"/> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + </sequence> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="stn:M3UALinkSetTp"/> + <element ref="stn:M3UALinkTp"/> + <element ref="stn:M3UARouteSetNePart"/> + <element ref="stn:M3UARouteNePart"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="M3UALinkSetTp"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="adjPc" type="unsignedLong"/> + <element name="trafficMode" type="stn:trafficModeType"/> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="stn:M3UALinkTp"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="M3UALinkTp"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="m3UALinkTPState" type="stn:m3UALinkTPStateType" +/> + <element name="sCTPAssocLocalAddr" type="stn:sCTPAssocAddrType" +/> + +``` + +``` +minOccurs="0"/> + <element name="sCTPAssocRemoteAddr" type="stn:sCTPAssocAddrType" + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="M3UARouteSetNePart"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="destinationPc" type="unsignedLong"/> + <element name="m3UARouteNePartm3UALinkSetTP" type="xn:dn"/> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="stn:M3UARouteNePart"/> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +<element name="M3UARouteNePart"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="m3UALinkSetTPId" type="string"/> + <element name="fixedPriority" type="unsignedLong"/> + <element name="userLabel" type="string"/> + <element name="vnfParametersList" +type="xn:vnfParametersListType" minOccurs="0"/> + </all> + </complexType> + </element> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="xn:VsDataContainer"/> + </choice> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +</schema> +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140332 | 001 | - | F | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140358 | 002 | - | F | remove the feature support statements | 11.1.0 | +| 2014-09 | SA#65 | SP-140560 | 003 | - | C | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 2016-01 | | | | | | Update to Rel-13 (MCC) | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170514 | 0005 | - | F | Update the link from IRP Solution Set to IRP Information Service | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0006 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28751/raw.md b/marked/Rel-16/28_series/28751/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..81153b1a7c5b60d82fa8f890aa7226ac8718ae20 --- /dev/null +++ b/marked/Rel-16/28_series/28751/raw.md @@ -0,0 +1,109 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Requirements ..... 6 +- Annex A (informative): Change history..... 7 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +Subscription Management is a feature that permits Service Providers, Value Added Service Providers and Mobile Operators to provision services for a specific subscriber. Subscription Management is an area of Service Operation Management that sets a complex challenge for Service Providers and Operators in their support of new or existing subscribers during their every day network operation. + +The present document is part a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +- TS 32.140: Subscription Management (SuM) requirements. +- TS 32.141: Subscription Management (SuM) architecture. +- TS 28.751: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements.** +- TS 28.752: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS). +- TS 28.753: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions. + +# --- 1 Scope + +The present document defines, in addition to the requirements defined in [1], [2], [3] and [4], requirements for the present IRP: SuM NRM IRP. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements". +- [4] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) architecture". +- [5] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements". +- [6] 3GPP TS 32.107: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM)". +- [7] 3GPP TS 28.620: "Telecommunication management; Fixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. For terms and definitions not found here, please refer to 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.140 [3], 3GPP TS 32.141 [4] and 3GPP TS 32.600 [5]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----|-----------------------------| +| IRP | Integration Reference Point | +| NRM | Network Resource Model | +| SuM | Subscription Management | + +# --- 4 Requirements + +The following general and high-level requirements apply for the present IRP: + +- a) IRP-related requirements in 3GPP TS 32.101 [1]. + +- b) IRP-related requirements in 3GPP TS 32.102 [2]. +- c) IRP-related requirements in 3GPP TS 32.140 [3]. +- d) IRP-related requirements in 3GPP TS 32.141 [4]. + +The NRM defined by this IRP: + +- a) Shall support communications for telecommunication network management purposes, including management of converged networks. +- b) Is a member of the Federated Network Information Model (FNIM) [6] and its information is derived from the FNIM Umbrella Information Model (UIM) [7]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|----------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2013-06 | | | | | Editorial changes (MCC): removal of blank page in page 2 | 11.0.0 | 11.0.1 | +| 2014-06 | SA#64 | SP-140359 | 001 | - | remove the feature support statements | 11.0.1 | 11.1.0 | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | 11.1.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | - | - | - | - | Update to Rel-14 version (MCC) | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28752/raw.md b/marked/Rel-16/28_series/28752/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f110bc4d0c30989f36f343673f28efd2dcdc37d8 --- /dev/null +++ b/marked/Rel-16/28_series/28752/raw.md @@ -0,0 +1,2303 @@ + + + + +# Keywords --- + +Subscription Management, NRM, IRP, +Converged Management + +## **3GPP** + +## Postal address --- + +## 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + +<http://www.3gpp.org> + +--- + +# --- Contents + +| | | +|---------------------------------------------------------|----| +| Foreword..... | 7 | +| Introduction..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations..... | 9 | +| 4 Model..... | 10 | +| 4.1 Imported information entities and local labels..... | 10 | +| 4.2 Class diagram..... | 10 | +| 4.2.1 Relationships..... | 10 | +| 4.2.2 Inheritance..... | 14 | +| 4.3 Class definitions..... | 17 | +| 4.3.1 SuMService..... | 17 | +| 4.3.1.1 Definition..... | 17 | +| 4.3.1.2 Attributes..... | 17 | +| 4.3.1.3 Attribute constraints..... | 17 | +| 4.3.1.4 Notifications..... | 17 | +| 4.3.2 CSService..... | 17 | +| 4.3.2.1 Definition..... | 17 | +| 4.3.2.2 Attributes..... | 18 | +| 4.3.2.3 Attribute constraints..... | 19 | +| 4.3.2.4 Notifications..... | 19 | +| 4.3.3 GPRSService..... | 19 | +| 4.3.3.1 Definition..... | 19 | +| 4.3.3.2 Attributes..... | 20 | +| 4.3.3.3 Attribute constraints..... | 21 | +| 4.3.3.4 Notifications..... | 21 | +| 4.3.4 IMSService..... | 22 | +| 4.3.4.1 Definition..... | 22 | +| 4.3.4.2 Attributes..... | 22 | +| 4.3.4.3 Attribute constraints..... | 22 | +| 4.3.4.4 Notifications..... | 22 | +| 4.3.5 SuMSubscribedService..... | 23 | +| 4.3.5.1 Definition..... | 23 | +| 4.3.5.2 Attributes..... | 23 | +| 4.3.5.3 Attribute constraints..... | 23 | +| 4.3.5.4 Notifications..... | 23 | +| 4.3.6 CSSubscribedService..... | 23 | +| 4.3.6.1 Definition..... | 23 | +| 4.3.6.2 Attributes..... | 24 | +| 4.3.6.3 Attribute constraints..... | 25 | +| 4.3.6.4 Notifications..... | 25 | +| 4.3.7 GPRSSubscribedService..... | 25 | +| 4.3.7.1 Definition..... | 25 | +| 4.3.7.2 Attributes..... | 26 | +| 4.3.7.3 Attribute constraints..... | 27 | +| 4.3.7.4 Notifications..... | 27 | +| 4.3.8 IMSSubscribedService..... | 27 | +| 4.3.8.1 Definition..... | 27 | +| 4.3.8.2 Attributes..... | 28 | +| 4.3.8.3 Attribute constraints..... | 28 | + +| | | | +|----------|------------------------------|----| +| 4.3.8.4 | Notifications..... | 28 | +| 4.3.9 | SuMSUBscriberProfile..... | 28 | +| 4.3.9.1 | Definition..... | 28 | +| 4.3.9.2 | Attributes..... | 29 | +| 4.3.9.3 | Attribute constraints..... | 29 | +| 4.3.9.4 | Notifications..... | 29 | +| 4.3.10 | SuMSERVICEProfile..... | 29 | +| 4.3.10.1 | Definition..... | 29 | +| 4.3.10.2 | Attributes..... | 29 | +| 4.3.10.3 | Attribute constraints..... | 29 | +| 4.3.10.4 | Notifications..... | 29 | +| 4.3.11 | CSSERVICEProfile..... | 29 | +| 4.3.11.1 | Definition..... | 29 | +| 4.3.11.2 | Attributes..... | 30 | +| 4.3.11.3 | Attribute constraints..... | 32 | +| 4.3.11.4 | Notifications..... | 32 | +| 4.3.12 | GPRSSERVICEProfile..... | 32 | +| 4.3.12.1 | Definition..... | 32 | +| 4.3.12.2 | Attributes..... | 33 | +| 4.3.12.3 | Attribute constraints..... | 33 | +| 4.3.12.4 | Notifications..... | 34 | +| 4.3.13 | IMSSERVICEProfile..... | 34 | +| 4.3.13.1 | Definition..... | 34 | +| 4.3.13.2 | Attributes..... | 34 | +| 4.3.13.3 | Attribute constraints..... | 34 | +| 4.3.13.4 | Notifications..... | 35 | +| 4.3.14 | SubscriptionFunction..... | 35 | +| 4.3.14.1 | Definition..... | 35 | +| 4.3.14.2 | Attributes..... | 35 | +| 4.3.14.3 | Attribute constraints..... | 35 | +| 4.3.14.4 | Notifications..... | 35 | +| 4.3.15 | SuMCSSupplService..... | 35 | +| 4.3.15.1 | Definition..... | 35 | +| 4.3.15.2 | Attributes..... | 36 | +| 4.3.15.3 | Attribute constraints..... | 36 | +| 4.3.15.4 | Notifications..... | 36 | +| 4.3.16 | SuMGPRSSupplService..... | 37 | +| 4.3.16.1 | Definition..... | 37 | +| 4.3.16.2 | Attributes..... | 37 | +| 4.3.16.3 | Attribute constraints..... | 37 | +| 4.3.16.4 | Notifications..... | 37 | +| 4.3.17 | SuMUser..... | 37 | +| 4.3.17.1 | Definition..... | 37 | +| 4.3.17.2 | Attributes..... | 37 | +| 4.3.17.3 | Attribute constraints..... | 37 | +| 4.3.17.4 | Notifications..... | 38 | +| 4.3.18 | SuMCredentials..... | 38 | +| 4.3.18.1 | Definition..... | 38 | +| 4.3.18.2 | Attributes..... | 38 | +| 4.3.18.3 | Attribute constraints..... | 38 | +| 4.3.18.4 | Notifications..... | 38 | +| 4.3.19 | IMSPublicIdentification..... | 39 | +| 4.3.19.1 | Definition..... | 39 | +| 4.3.19.2 | Attributes..... | 39 | +| 4.3.19.3 | Attribute constraints..... | 39 | +| 4.3.19.4 | Notifications..... | 39 | +| 4.3.20 | MobileUserData..... | 39 | +| 4.3.20.1 | Definition..... | 39 | + +| | | | +|----------|-------------------------------------|----| +| 4.3.20.2 | Attributes..... | 39 | +| 4.3.20.3 | Attribute constraints..... | 39 | +| 4.3.20.4 | Notifications..... | 39 | +| 4.3.21 | SuMServiceParameter..... | 40 | +| 4.3.21.1 | Definition..... | 40 | +| 4.3.21.2 | Attributes..... | 40 | +| 4.3.21.3 | Attribute constraints..... | 40 | +| 4.3.21.4 | Notifications..... | 40 | +| 4.3.22 | SuMIdentity..... | 40 | +| 4.3.22.1 | Definition..... | 40 | +| 4.3.22.2 | Attributes..... | 40 | +| 4.3.22.3 | Attribute constraints..... | 40 | +| 4.3.22.4 | Notifications..... | 40 | +| 4.3.23 | ServerCapabilities..... | 40 | +| 4.3.23.1 | Definition..... | 40 | +| 4.3.23.2 | Attributes..... | 41 | +| 4.3.23.3 | Attribute constraints..... | 41 | +| 4.3.23.4 | Notifications..... | 41 | +| 4.3.24 | EPSService..... | 41 | +| 4.3.24.1 | Definition..... | 41 | +| 4.3.24.2 | Attributes..... | 42 | +| 4.3.24.3 | Attribute constraints..... | 43 | +| 4.3.24.4 | Notifications..... | 43 | +| 4.3.25 | EPSSubscribedService..... | 43 | +| 4.3.25.1 | Definition..... | 43 | +| 4.3.25.2 | Attributes..... | 44 | +| 4.3.25.3 | Attribute constraints..... | 44 | +| 4.3.25.4 | Notifications..... | 45 | +| 4.3.26 | EPSServiceProfile..... | 45 | +| 4.3.26.1 | Definition..... | 45 | +| 4.3.26.2 | Attributes..... | 45 | +| 4.3.26.3 | Attribute constraints..... | 45 | +| 4.3.26.4 | Notifications..... | 46 | +| 4.3.27 | PSCommonServiceProfile..... | 46 | +| 4.3.27.1 | Definition..... | 46 | +| 4.3.27.2 | Attributes..... | 46 | +| 4.3.27.3 | Attribute constraints..... | 46 | +| 4.3.27.4 | Notifications..... | 46 | +| 4.3.28 | IWANParameters..... | 47 | +| 4.3.28.1 | Definition..... | 47 | +| 4.3.28.2 | Attributes..... | 47 | +| 4.3.28.3 | Attribute constraints..... | 47 | +| 4.3.28.4 | Notifications..... | 47 | +| 4.3.29 | OptHandover3GPP2Parameters..... | 48 | +| 4.3.29.1 | Definition..... | 48 | +| 4.3.29.2 | Attributes..... | 48 | +| 4.3.29.3 | Attribute constraints..... | 48 | +| 4.3.29.4 | Notifications..... | 48 | +| 4.3.30 | Non3GPPAccessParameters..... | 48 | +| 4.3.30.1 | Definition..... | 48 | +| 4.3.30.2 | Attributes..... | 48 | +| 4.3.30.3 | Attribute constraints..... | 48 | +| 4.3.30.4 | Notifications..... | 48 | +| 4.3.31 | Common3GPPAccessServiceProfile..... | 49 | +| 4.3.31.1 | Definition..... | 49 | +| 4.3.31.2 | Attributes..... | 49 | +| 4.3.31.3 | Attribute constraints..... | 49 | +| 4.3.31.4 | Notifications..... | 49 | +| 4.4 | Attribute definitions..... | 49 | + +4.4.1 Attribute properties..... 49 +4.4.2 Constraints..... 71 +4.5 Common notifications..... 71 +Annex A (informative): Change history..... 72 + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +x the first digit: + +- 1 presented to TSG for information; +- 2 presented to TSG for approval; +- 3 or greater indicates TSG approved document under change control. + +y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. + +z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The interface Itf-N, defined in 3GPP TS 32.102 [2], is built up by a number of Integration Reference Points (IRPs) and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2]. + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management, as identified below: + +TS 32.140: Subscription Management (SuM) requirements. + +TS 32.141: Subscription Management (SuM) architecture. + +TS 28.751: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements. + +**TS 28.752: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS).** + +TS 28.753: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Sets (SS) definitions. + +# --- 1 Scope + +The present document defines the Network Resource Model (NRM) for the SuM IRP which can be communicated between an IRP Agent and IRP Managers for subscription management purposes, including in the context of converged networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [2] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [3] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) Requirements". +- [4] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) Architecture". +- [5] 3GPP TS 28.751: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements". +- [6] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [7] 3GPP TS 23.008: "Organization of subscriber data". +- [8] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. For terms and definitions not found here, please refer to 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.140 [3] and TS 32.141 [4]. + +**Subscription Profile:** see 3GPP TS 32.140 [3]. + +**Subscription Profile Component:** see 3GPP TS 32.140 [3]. + +**Subscription Profile Component Definition:** specifies a Subscription Profile Component. + +**Subscriber Profile:** see 3GPP TS 32.140 [3]. + +**User:** see 3GPP TS 32.140 [3]. + +## 3.2 Abbreviations + +For the purposes of the present document the following and the abbreviations in 32.101 [1], 32.102 [2], 32.140 [3] and 32.141 [4] apply. + +| | | +|-----|-----------------------------| +| EM | Element Manager | +| IOC | Information Object Class | +| IRP | Integration Reference Point | +| MOC | Managed Object Class | +| NE | Network Element | +| SuM | Subscription Management | + +# 4 Model + +## 4.1 Imported information entities and local labels + +| Label reference | Local label | +|-------------------------------------------------------|-----------------| +| 28.622 [6], information object class, ManagedFunction | ManagedFunction | +| 28.622 [6], information object class, SubNetwork | SubNetwork | +| 28.622 [6], information object class, Top | Top | + +## 4.2 Class diagram + +### 4.2.1 Relationships + +This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides an overview of the relationships between relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes. + +![UML Class diagram showing a relationship between SubNetwork and SuMIOProxy1. SubNetwork is an InformationObjectClass from 28.622. SuMIOProxy1 is a ProxyClass. The relationship is named '<<names>>' and has a 1-to-many multiplicity. A note indicates that SuMIOProxy1 represents various IOCs including SubscriptionFunction, SuMSUBscriberProfile, SuMUser, SuMSERVICE, SuMSUBscribedService, SuMSERVICEProfile, MobileUserData, SuMCredentials, IMSPublicIdentification, SuMCSSupplService, SuMGPRSSupplService, SuMSERVICEParameter, SuMIdentity, IWANParameters, OptHandover3GPP2Parameters, and Non3GPPAccessParameters.](1eadbbe42cfcac5c0023577110aec5e3_img.jpg) + +``` + +classDiagram + class SubNetwork { + <<InformationObjectClass>> + (from 28.622) + } + class SuMIOProxy1 { + <<ProxyClass>> + } + SubNetwork "1" *-- "*" SuMIOProxy1 : <<names>> + +``` + +This ProxyClass represents the following IOCs: + SubscriptionFunction, + SuMSUBscriberProfile, SuMUser, + SuMSERVICE, + SuMSUBscribedService, + SuMSERVICEProfile, + MobileUserData, SuMCredentials, + IMSPublicIdentification, + SuMCSSupplService, + SuMGPRSSupplService, + SuMSERVICEParameter, + SuMIdentity, IWANParameters, + OptHandover3GPP2Parameters, + Non3GPPAccessParameters. + +UML Class diagram showing a relationship between SubNetwork and SuMIOProxy1. SubNetwork is an InformationObjectClass from 28.622. SuMIOProxy1 is a ProxyClass. The relationship is named '<>' and has a 1-to-many multiplicity. A note indicates that SuMIOProxy1 represents various IOCs including SubscriptionFunction, SuMSUBscriberProfile, SuMUser, SuMSERVICE, SuMSUBscribedService, SuMSERVICEProfile, MobileUserData, SuMCredentials, IMSPublicIdentification, SuMCSSupplService, SuMGPRSSupplService, SuMSERVICEParameter, SuMIdentity, IWANParameters, OptHandover3GPP2Parameters, and Non3GPPAccessParameters. + +Figure 1a: SuM NRM naming diagram 1 + +![UML Class Diagram showing SuM NRM Containment and Association diagram 1. Classes include SuMService, SubscriptionFunction, SumSubscribedService, SuMSubscriberProfile, MobileUserData, SuMServiceProfile, SuMUser, and SuMIdentity with various associations and multiplicities.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +classDiagram + class SuMService { + <<InformationObjectClass>> + } + class SubscriptionFunction { + <<InformationObjectClass>> + } + class SumSubscribedService { + <<InformationObjectClass>> + } + class SuMSubscriberProfile { + <<InformationObjectClass>> + } + class MobileUserData { + <<InformationObjectClass>> + } + class SuMServiceProfile { + <<InformationObjectClass>> + } + class SuMUser { + <<InformationObjectClass>> + } + class SuMIdentity { + <<InformationObjectClass>> + } + + SuMService "0..1" -- "*" SumSubscribedService : + theOffer + SumSubscribedService "*" -- "1" SuMService : + theContract + SuMService "1" -- "*" SuMServiceProfile : + theSpecification + SuMServiceProfile "*" -- "1" SuMService : + theService + SubscriptionFunction "0..1" -- "*" SuMSubscriberProfile : + theSubscriberProfile + SuMSubscriberProfile "*" -- "1" SubscriptionFunction : + theSubscriber + SuMSubscriberProfile "1" -- "*" MobileUserData : + theMobileUserData + MobileUserData "*" -- "1" SuMSubscriberProfile : + theMobileUserData + SuMSubscriberProfile "*" -- "1" SuMUser : + theUser + SuMUser "*" -- "1" SuMSubscriberProfile : + theUser + SuMUser "1" -- "*" SuMIdentity : + theIdentity + SuMIdentity "*" -- "1" SuMUser : + theIdentity + SuMUser "*" -- "1" SuMServiceProfile : + theServiceProfile + SuMServiceProfile "*" -- "1" SuMUser : + theServiceProfile + +``` + +UML Class Diagram showing SuM NRM Containment and Association diagram 1. Classes include SuMService, SubscriptionFunction, SumSubscribedService, SuMSubscriberProfile, MobileUserData, SuMServiceProfile, SuMUser, and SuMIdentity with various associations and multiplicities. + +Figure 1b: SuM NRM Containment and Association diagram 1 + +![UML Class Diagram showing SuM NRM Containment and Association diagram 2. Classes include SuMUser, SuMCredentials, IMSServiceProfile, and IMSPublicIdentification with associations and multiplicities.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` + +classDiagram + class SuMUser { + <<InformationObjectClass>> + } + class SuMCredentials { + <<InformationObjectClass>> + } + class IMSServiceProfile { + <<InformationObjectClass>> + } + class IMSPublicIdentification { + <<InformationObjectClass>> + } + + SuMUser "1" -- "*" SuMCredentials : + theCredentials + SuMCredentials "*" -- "1" SuMUser : + theCredentials + SuMUser "*" -- "1" IMSServiceProfile : + theServiceProfile + IMSServiceProfile "*" -- "1" SuMUser : + theServiceProfile + SuMCredentials "*" -- "1" IMSPublicIdentification : + thePublicId + IMSPublicIdentification "*" -- "1" SuMCredentials : + thePublicId + IMSServiceProfile "1" -- "*" IMSPublicIdentification : + thePublicId + IMSPublicIdentification "*" -- "1" IMSServiceProfile : + thePublicId + +``` + +UML Class Diagram showing SuM NRM Containment and Association diagram 2. Classes include SuMUser, SuMCredentials, IMSServiceProfile, and IMSPublicIdentification with associations and multiplicities. + +Figure 1c: SuM NRM Containment and Association diagram 2 + +![UML Class Diagram showing aggregation relationships for CS and GPRS services.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +This diagram illustrates two separate aggregation relationships. On the left, a class box labeled «InformationObjectClass» CS<sub>Service</sub> is connected by a vertical line to another class box labeled «InformationObjectClass» SuM<sub>CS</sub>Suppl<sub>Service</sub>. The top class has a '1' at the aggregation end (indicated by a hollow diamond), and the bottom class has a '\*' multiplicity. The association is labeled '+ theCSSupplServiceForCS'. On the right, a similar structure exists: a class box labeled «InformationObjectClass» GPRS<sub>Service</sub> is connected to a class box labeled «InformationObjectClass» SuMGPRS<sub>Suppl</sub>Service. The top class has a '1' at the aggregation end, and the bottom class has a '\*' multiplicity. The association is labeled '+ theGPRSSupplServiceForGPRS'. + +UML Class Diagram showing aggregation relationships for CS and GPRS services. + +Figure 1d: SuM Supplementary Service NRM Aggregation diagram 1 + +![UML Class Diagram showing aggregation relationships for CS and GPRS subscribed services.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +This diagram illustrates two separate aggregation relationships. On the left, a class box labeled «InformationObjectClass» CS<sub>SubscribedService</sub> is connected by a vertical line to a class box labeled «InformationObjectClass» SuM<sub>CS</sub>Suppl<sub>Service</sub>. The top class has a '1' at the aggregation end (indicated by a hollow diamond), and the bottom class has a '\*' multiplicity. The association is labeled '+ theCSSupplServiceForCSSS'. On the right, a similar structure exists: a class box labeled «InformationObjectClass» GPRS<sub>SubscribedService</sub> is connected to a class box labeled «InformationObjectClass» SuMGPRS<sub>Suppl</sub>Service. The top class has a '1' at the aggregation end, and the bottom class has a '\*' multiplicity. The association is labeled '+ theGPRSSupplServiceForGPRSSS'. + +UML Class Diagram showing aggregation relationships for CS and GPRS subscribed services. + +Figure 1e: SuM Supplementary Service NRM Aggregation diagram 2 + +![UML Class Diagram showing aggregation relationships for Supplementary Services. On the left, CSServiceProfile (1) aggregates SuMCSupplService (*). On the right, GPRSServiceProfile (1) aggregates SuMGPRSSupplService (*).](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +classDiagram + class CSServiceProfile["«InformationObjectClass» CSServiceProfile"] + class SuMCSupplService["«InformationObjectClass» SuMCSupplService"] + class GPRSServiceProfile["«InformationObjectClass» GPRSServiceProfile"] + class SuMGPRSSupplService["«InformationObjectClass» SuMGPRSSupplService"] + + CSServiceProfile "1" *-- "*" SuMCSupplService : + theCSSupplServiceForCSSP + GPRSServiceProfile "1" *-- "*" SuMGPRSSupplService : + theGPRSSupplServiceForGPRSSP + +``` + +UML Class Diagram showing aggregation relationships for Supplementary Services. On the left, CSServiceProfile (1) aggregates SuMCSupplService (\*). On the right, GPRSServiceProfile (1) aggregates SuMGPRSSupplService (\*). + +Figure 1f: SuM Supplementary Service NRM Aggregation diagram 3 + +![UML Class Diagram showing containment and association relationships for IMS Service. IMSService, IMSServiceProfile, and IMSSubscribedService all have associations with ServerCapabilities. IMSServiceProfile has a containment relationship with ServerCapabilities.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` + +classDiagram + class IMSService["«InformationObjectClass» IMSService"] + class IMSServiceProfile["«InformationObjectClass» IMSServiceProfile"] + class IMSSubscribedService["«InformationObjectClass» IMSSubscribedService"] + class ServerCapabilities["«InformationObjectClass» ServerCapabilities"] + + IMSService "*" -- "*" ServerCapabilities : + theServerCapabilities + IMSServiceProfile "*" -- "*" ServerCapabilities : + theServerCapabilities + IMSServiceProfile "1" *-- "*" ServerCapabilities : + theServerCapabilities + IMSSubscribedService "*" -- "*" ServerCapabilities : + theServerCapabilities + +``` + +UML Class Diagram showing containment and association relationships for IMS Service. IMSService, IMSServiceProfile, and IMSSubscribedService all have associations with ServerCapabilities. IMSServiceProfile has a containment relationship with ServerCapabilities. + +Figure 1g: SuM IMS Service Containment and Association diagram 1 + +![UML Class Diagram showing associations for Service Profiles. EPSServiceProfile (1) is associated with Non3GPPAccessParameters (0..1) and OptHandover3GPP2Parameters (0..1). PSCommonServiceProfile (1) is associated with IWANParameters (0..1).](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +``` + +classDiagram + class EPSServiceProfile["«InformationObjectClass» EPSServiceProfile"] + class Non3GPPAccessParameters["«InformationObjectClass» Non3GPPAccessParameters"] + class OptHandover3GPP2Parameters["«InformationObjectClass» OptHandover3GPP2Parameters"] + class PSCommonServiceProfile["«InformationObjectClass» PSCommonServiceProfile"] + class IWANParameters["«InformationObjectClass» IWANParameters"] + + EPSServiceProfile "1" -- "0..1" Non3GPPAccessParameters : + theNon3GPPAccessPar + EPSServiceProfile "1" -- "0..1" OptHandover3GPP2Parameters : + theOptHandover3GPP2Par + PSCommonServiceProfile "1" -- "0..1" IWANParameters : + theIWANPar + +``` + +UML Class Diagram showing associations for Service Profiles. EPSServiceProfile (1) is associated with Non3GPPAccessParameters (0..1) and OptHandover3GPP2Parameters (0..1). PSCommonServiceProfile (1) is associated with IWANParameters (0..1). + +Figure 1h: Service Profile NRM Association diagram + +### 4.2.2 Inheritance + +This subclause depicts the inheritance relationships. + +![UML class diagram showing inheritance from SubscriptionFunction to ManagedFunction.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` +classDiagram + class ManagedFunction["«InformationObjectClass»\nManagedFunction\n(from 28.622)"] + class SubscriptionFunction["«InformationObjectClass»\nSubscriptionFunction"] + SubscriptionFunction --|> ManagedFunction +``` + +The diagram shows a class hierarchy. At the top is a box labeled «InformationObjectClass» ManagedFunction (from 28.622). Below it is a box labeled «InformationObjectClass» SubscriptionFunction. A vertical line with an open triangle arrowhead points from the SubscriptionFunction box up to the ManagedFunction box, indicating inheritance. + +UML class diagram showing inheritance from SubscriptionFunction to ManagedFunction. + +Figure 2a: SuM NRM Inheritance Hierarchy 1 + +![UML class diagram showing inheritance from SuMService to Top, with CSService, GPRSService, IMSService, and EPSService inheriting from SuMService.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` +classDiagram + class Top["«InformationObjectClass»\nTop\n(from 28.622)"] + class SuMService["«InformationObjectClass»\nSuMService"] + class CSService["«InformationObjectClass»\nCSService"] + class GPRSService["«InformationObjectClass»\nGPRSService"] + class IMSService["«InformationObjectClass»\nIMSService"] + class EPSService["«InformationObjectClass»\nEPSService"] + Top <|-- SuMService + SuMService <|-- CSService + SuMService <|-- GPRSService + SuMService <|-- IMSService + SuMService <|-- EPSService +``` + +The diagram shows a class hierarchy. At the top is a box labeled «InformationObjectClass» Top (from 28.622). Below it is a box labeled «InformationObjectClass» SuMService. A vertical line with an open triangle arrowhead points from the SuMService box up to the Top box. Below the SuMService box, four boxes are arranged in a row: «InformationObjectClass» CSService, «InformationObjectClass» GPRSService, «InformationObjectClass» IMSService, and «InformationObjectClass» EPSService. Each of these four boxes has a vertical line with an open triangle arrowhead pointing up to the SuMService box, indicating inheritance from SuMService. + +UML class diagram showing inheritance from SuMService to Top, with CSService, GPRSService, IMSService, and EPSService inheriting from SuMService. + +Figure 2b: SuM NRM Inheritance Hierarchy 2 + +![UML Class Diagram showing inheritance hierarchy for SumSubscribedService.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +classDiagram + class Top["«InformationObjectClass» Top (from 28.622)"] + class SumSubscribedService["«InformationObjectClass» SumSubscribedService"] + class CSSubscribedService["«InformationObjectClass» CSSubscribedService"] + class GPRSSubscribedService["«InformationObjectClass» GPRSSubscribedService"] + class IMSSubscribedService["«InformationObjectClass» IMSSubscribedService"] + class EPSSubscribedService["«InformationObjectClass» EPSSubscribedService"] + + Top <|-- SumSubscribedService + SumSubscribedService <|-- CSSubscribedService + SumSubscribedService <|-- GPRSSubscribedService + SumSubscribedService <|-- IMSSubscribedService + SumSubscribedService <|-- EPSSubscribedService +``` + +This UML class diagram illustrates the inheritance hierarchy for the *SumSubscribedService* information object class. At the top is the *Top* class (from 28.622). Below it, *SumSubscribedService* inherits from *Top*. Further down, four classes inherit from *SumSubscribedService*: *CSSubscribedService*, *GPRSSubscribedService*, *IMSSubscribedService*, and *EPSSubscribedService*. + +UML Class Diagram showing inheritance hierarchy for SumSubscribedService. + +Figure 2c: SuM NRM Inheritance Hierarchy 3 + +![UML Class Diagram showing inheritance hierarchy for SuMServiceProfile.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` +classDiagram + class Top["«InformationObjectClass» Top (from 28.622)"] + class SuMServiceProfile["«InformationObjectClass» SuMServiceProfile"] + class Common3GPPAccessServiceProfile["«InformationObjectClass» Common3GPPAccessServiceProfile"] + class PSCommonServiceProfile["«InformationObjectClass» PSCommonServiceProfile"] + class GPSServiceProfile["«InformationObjectClass» GPSServiceProfile"] + class EPSServiceProfile["«InformationObjectClass» EPSServiceProfile"] + class CSServiceProfile["«InformationObjectClass» CSServiceProfile"] + class IMSServiceProfile["«InformationObjectClass» IMSServiceProfile"] + + Top <|-- SuMServiceProfile + SuMServiceProfile <|-- Common3GPPAccessServiceProfile + Common3GPPAccessServiceProfile <|-- PSCommonServiceProfile + PSCommonServiceProfile <|-- GPSServiceProfile + PSCommonServiceProfile <|-- EPSServiceProfile + Common3GPPAccessServiceProfile <|-- CSServiceProfile + Common3GPPAccessServiceProfile <|-- IMSServiceProfile +``` + +This UML class diagram illustrates the inheritance hierarchy for the *SuMServiceProfile* information object class. At the top is the *Top* class (from 28.622). Below it, *SuMServiceProfile* inherits from *Top*. Further down, *Common3GPPAccessServiceProfile* inherits from *SuMServiceProfile*. Below that, *PSCommonServiceProfile* inherits from *Common3GPPAccessServiceProfile*. Below *PSCommonServiceProfile*, *GPSServiceProfile* and *EPSServiceProfile* inherit from it. Finally, at the bottom, *CSServiceProfile* and *IMSServiceProfile* inherit from *Common3GPPAccessServiceProfile*. + +UML Class Diagram showing inheritance hierarchy for SuMServiceProfile. + +Figure 2d: SuM NRM Inheritance Hierarchy 4 + +![UML Class Diagram showing inheritance from SuMIOCProxy2 to Top. A note indicates that SuMIOCProxy2 represents various Information Object Classes (IOCs) such as SuMSubscriberProfile, SuMUser, MobileUserData, SuMCredentials, SuMCSSupplService, SuMGPRSsupplService, SuMServiceParameter, SuMIdentity, IWANParameters, OptHandover3GPP2Parameters, and Non3GPPAccessParameters.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +classDiagram + class Top["«InformationObjectClass» +Top +(from 28.622)"] + class SuMIOCProxy2["«ProxyClass» +SuMIOCProxy2"] + SuMIOCProxy2 --|> Top +``` + +This ProxyClass represents the following IOCs: +SuMSubscriberProfile, SuMUser, MobileUserData, SuMCredentials, SuMCSSupplService, SuMGPRSsupplService, SuMServiceParameter, SuMIdentity, IWANParameters, OptHandover3GPP2Parameters, Non3GPPAccessParameters. + +UML Class Diagram showing inheritance from SuMIOCProxy2 to Top. A note indicates that SuMIOCProxy2 represents various Information Object Classes (IOCs) such as SuMSubscriberProfile, SuMUser, MobileUserData, SuMCredentials, SuMCSSupplService, SuMGPRSsupplService, SuMServiceParameter, SuMIdentity, IWANParameters, OptHandover3GPP2Parameters, and Non3GPPAccessParameters. + +Figure 2e: SuM NRM Inheritance Hierarchy 5 + +![UML Class Diagram showing inheritance from IMSPublicIdentification to SuMIdentity.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` +classDiagram + class SuMIdentity["«InformationObjectClass» +SuMIdentity"] + class IMSPublicIdentification["«InformationObjectClass» +IMSPublicIdentification"] + IMSPublicIdentification --|> SuMIdentity +``` + +UML Class Diagram showing inheritance from IMSPublicIdentification to SuMIdentity. + +Figure 2f: SuM NRM Inheritance Hierarchy 8 + +![UML Class Diagram showing inheritance from ServerCapabilities to SuMServiceParameter.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` +classDiagram + class SuMServiceParameter["«InformationObjectClass» +SuMServiceParameter"] + class ServerCapabilities["«InformationObjectClass» +ServerCapabilities"] + ServerCapabilities --|> SuMServiceParameter +``` + +UML Class Diagram showing inheritance from ServerCapabilities to SuMServiceParameter. + +Figure 2g: SuM NRM Inheritance Hierarchy 9 + +## 4.3 Class definitions + +### 4.3.1 SuMService + +#### 4.3.1.1 Definition + +This is an abstract IOC provided for sub-classing only. It provides attribute(s) that are common to Services IOCs. + +#### 4.3.1.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|---------------------------|-------------------|------------|------------|-------------|--------------| +| Attribute related to role | | | | | | +| theContract | M | M | O | - | - | + +#### 4.3.1.3 Attribute constraints + +None. + +#### 4.3.1.4 Notifications + +None. + +### 4.3.2 CSService + +#### 4.3.2.1 Definition + +This class represents a CS service (see 3GPP TS 23.008 [7]) provided by a service provider + +This class contains the valid parameters that define the CS service from subscription point of view. + +#### 4.3.2.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| networkAccessMode | M | M | M | - | - | +| basicMSISDNIndicator | O | M | M | - | - | +| mSISDNAlertIndicator | O | M | M | - | - | +| subscriptionRestriction | O | M | M | - | - | +| rSZIlists | O | M | M | - | - | +| lSAIdentity | O | M | M | - | - | +| lSAPriority | O | M | M | - | - | +| lSAPreferentialAccessIndicator | O | M | M | - | - | +| lSAActiveModeSupportIndicator | O | M | M | - | - | +| lSAOnlyAccessIndicator | O | M | M | - | - | +| lSAActiveModeIndicator | O | M | M | - | - | +| vPLMNIdentifier | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| mOLRList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| mobileStationCategory | O | M | M | - | - | +| lMUIIdentifier | O | M | M | - | - | +| subscriberStatus | O | M | M | - | - | +| gsmSCFaddresslistForODB | M | M | M | - | - | +| provisionOfBearerService | M | M | M | - | - | +| provisionOfTeleservice | M | M | M | - | - | +| bCAllocation | O | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfIncomingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| barringOfPremiumRateCalls | O | M | M | - | - | +| barringOfSupplementaryService Management | O | M | M | - | - | +| barringOfRegistrationOfCall Forwarding | O | M | M | - | - | +| barringOfInvocationOfCall Transfer | O | M | M | - | - | +| operatorDeterminedBarring PLMNs specificData | O | M | M | - | - | +| vGCSGroupMembershipList | O | M | M | - | - | +| vBSGroupMembershipList | O | M | M | - | - | +| broadcastCallInitiation AllowedList | O | M | M | - | - | +| originatingCAMELSubscription InformationOCSI | O | M | M | - | - | +| terminatingCAMELSubscription InformationTCSI | O | M | M | - | - | +| vMSCTerminatingCAMEL SubscriptionInformationVTCSI | O | M | M | - | - | +| locationInformation SubscriberStateInformation | O | M | M | - | - | +| uSSDCAMELSubscription InformationUCSI | O | M | M | - | - | +| sSInvocationNotificationSSCSI | O | M | M | - | - | +| translationInformation FlagTIFCSI | O | M | M | - | - | +| dialledServiceCAMEL SubscriptionInformationDCSI | O | M | M | - | - | +| uSSDGeneralCAMELService InformationUGCSI | O | M | M | - | - | +| shortMessageServiceCAMEL SubscriptionInformationMOSMSCS I | O | M | M | - | - | + +| | | | | | | +|-----------------------------------------------------------------|---|---|---|---|---| +| shortMessageServiceCAMEL<br>SubscriptionInformationMTSMSCS<br>I | O | M | M | - | - | +| mTSMSCSIVLRNegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| gsmSCFaddressforCSI | O | M | M | - | - | +| iSTAlertTimer | O | M | M | - | - | +| cSAllocationRetentionpriority | O | M | M | - | - | +| iCSIndicator | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theCSSupplServiceForCS | O | M | O | - | - | + +#### 4.3.2.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.2.4 Notifications + +None. + +### 4.3.3 GPRSService + +#### 4.3.3.1 Definition + +This class represents a GPRS service (see 3GPP TS 23.008 [7]) provided by a service provider. + +This class contains the valid parameters that define the GPRS service from subscription point of view. + +#### 4.3.3.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| networkAccessMode | M | M | M | - | - | +| basicMSISDNIndicator | O | M | M | - | - | +| mSISDNAlertIndicator | O | M | M | - | - | +| rSZIlists | O | M | M | - | - | +| LSAIdentity | O | M | M | - | - | +| LSAPriority | O | M | M | - | - | +| LSAPreferentialAccessIndicator | O | M | M | - | - | +| LSAActiveModeSupportIndicator | O | M | M | - | - | +| LSAOnlyAccessIndicator | O | M | M | - | - | +| LSAActiveModeIndicator | O | M | M | - | - | +| vPLMNIdentifier | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| mOLRLList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| gGSNNumber | M | M | M | - | - | +| provisionofTeleservice | O | M | M | - | - | +| transferofSMoption | M | M | M | - | - | +| subscriberStatus | M | M | M | - | - | +| barringofPacketOrientedServices | O | M | M | - | - | +| pDPType | O | M | M | - | - | +| pDPAddress | O | M | M | - | - | +| accessPointName | O | M | M | - | - | +| vPLMNAddressAllowed | O | M | M | - | - | +| qualityofServiceSubscribed | O | M | M | - | - | +| pDPContextChargingCharacteristics | O | M | M | - | - | +| gPRSCAMELSubscriptionInformation | O | M | M | - | - | +| GPRSCSI | | | | | | +| mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI | O | M | M | - | - | +| mTShortMessageServiceCAMELSubscriptionInformationMTSMSCSI | O | M | M | - | - | +| mOSMSCSISGSNNegotiatedCAMELCapabilityHandling | O | M | M | - | - | +| mTSMSCSISGSNNegotiatedCAMELCapabilityHandling | O | M | M | - | - | +| mobilityManagementforGPRSeventnotificationMGCSI | O | M | M | - | - | +| mGCsINegotiatedCAMELCapabilityHandling | O | M | M | - | - | +| gsmSCFaddressforCSI | O | M | M | - | - | +| subscribedChargingCharacteristics | O | M | M | - | - | +| closedSubscriberGroupInformation | O | M | M | - | - | +| gSMSCFaddresslistForODB | O | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| operatorDeterminedBarringPLMNspe<br>cificData | O | M | M | - | - | +| sTNSR | O | M | M | - | - | +| iCSIIndicator | O | M | M | - | - | +| listofauthorizedvisitednetworkid<br>entifiers | O | M | M | - | - | +| wLANUERemoteIPaddress | O | M | M | - | - | +| staticWLANUERemoteIPaddressList | O | M | M | - | - | +| w-APNBarringTypeList | O | M | M | - | - | +| w-APNChargingDataList | O | M | M | - | - | +| accessDependenceFlag | O | M | M | - | - | +| chargingCharacteristics | O | M | M | - | - | +| primaryOCSChargingFunctionName | O | M | M | - | - | +| secondaryOCSChargingFunctionName | O | M | M | - | - | + +| <b>Attribute name</b> | <b>Support Qualifier</b> | <b>isReadable</b> | <b>isWritable</b> | <b>isInvariant</b> | <b>isNotifyable</b> | +|-----------------------------------------|--------------------------|-------------------|-------------------|--------------------|---------------------| +| primaryChargingCollectionFunctionName | O | M | M | - | - | +| secondaryChargingCollectionFunctionName | O | M | M | - | - | +| w-APNIdentifierList | O | M | M | - | - | +| maxNumberAccessesList | O | M | M | - | - | +| maxSubscribedBandwidth | O | M | M | - | - | +| subscribed3GPPWLANQoSProfile | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theGPRSSupplServiceForGPRS | O | M | O | - | - | + +#### 4.3.3.3 Attribute constraints + +| <b>Name</b> | <b>Definition</b> | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.3.4 Notifications + +None. + +### 4.3.4 IMSService + +#### 4.3.4.1 Definition + +This class represents a IMS service (see 3GPP TS 23.008 [7]) provided by a service provider + +This class contains the valid parameters that define the IMS service from subscription point of view. + +#### 4.3.4.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------|-------------------|------------|------------|-------------|--------------| +| listofauthorizedvisitednetworkid<br>entifiers | M | M | M | - | - | +| registrationStatus | M | M | M | - | - | +| sCSCFName | O | M | - | - | - | +| diameterClientAddressofSCSCF | O | M | - | - | - | +| subscribedMediaProfileIdentifier | O | M | M | - | - | +| initialFilterCriteriaList | O | M | M | - | - | +| applicationServerInformation | O | M | M | - | - | +| serviceIndicationList | O | M | - | - | - | +| primaryEventChargingFunctionName | O | M | M | - | - | +| secondaryEventChargingFunctionNa<br>me | O | M | M | - | - | +| primaryChargingCollectionFunctio<br>nName | M | M | M | - | - | +| secondaryChargingCollectionFunct<br>ionName | O | M | M | - | - | +| gsmSCFAddressforIMCSI | O | M | M | - | - | +| oIMCSI | O | M | M | - | - | +| vTIMCSI | O | M | M | - | - | +| dIMCS | O | M | M | - | - | +| gAAServiceType | O | M | M | - | - | +| gAAServiceIdentifier | O | M | M | - | - | +| gBAUserSecuritySettings | O | M | M | - | - | +| userSecuritySetting | O | M | M | - | - | +| userPublicIdentity | O | M | M | - | - | +| gAAAuthorizationflag | O | M | M | - | - | +| keyLifetime | O | M | M | - | - | +| uICCSecurityType | O | M | M | - | - | +| nAFGroupIdentity | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theServerCapabilities | O | M | - | - | - | + +#### 4.3.4.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.4.4 Notifications + +None. + +### 4.3.5 SuMSubscribedService + +#### 4.3.5.1 Definition + +This is an abstract IOC provided for sub-classing only. It provides attribute(s) that are common to Subscribed Services IOCs. + +#### 4.3.5.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| theService | M | M | O | - | - | +| theOffer | M | M | O | - | - | + +#### 4.3.5.3 Attribute constraints + +None. + +#### 4.3.5.4 Notifications + +None. + +### 4.3.6 CSSubscribedService + +#### 4.3.6.1 Definition + +This class represents subscription to a CS service (see 3GPP TS 23.008 [7]) for a subscriber. The entire set of CS subscribed services owned by a subscriber constitutes the subscriber's Subscribed Services Profile for CS services. + +This class contains the agreed (between the Subscriber and the Service Provider) parameter settings for a CS service that a Subscriber subscribes to. + +#### 4.3.6.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| networkAccessMode | M | M | M | - | - | +| basicMSISDNIndicator | O | M | M | - | - | +| mSISDNAlertIndicator | O | M | M | - | - | +| subscriptionRestriction | O | M | M | - | - | +| rSZLists | O | M | M | - | - | +| lSAIdentity | O | M | M | - | - | +| lSAPriority | O | M | M | - | - | +| lSAPreferentialAccessIndicator | O | M | M | - | - | +| lSAActiveModeSupportIndicator | O | M | M | - | - | +| lSAOnlyAccessIndicator | O | M | M | - | - | +| lSAActiveModeIndicator | O | M | M | - | - | +| vPLMNIdentifier | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| mOLRList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| mobileStationCategory | O | M | M | - | - | +| lMUIIdentifier | O | M | M | - | - | +| subscriberStatus | O | M | M | - | - | +| gsmSCFaddresslistForODB | M | M | M | - | - | +| provisionOfBearerService | M | M | M | - | - | +| provisionOfTeleservice | M | M | M | - | - | +| bCAllocation | O | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfIncomingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| barringOfPremiumRateCalls | O | M | M | - | - | +| barringOfSupplementaryService Management | O | M | M | - | - | +| barringOfRegistrationOfCall Forwarding | O | M | M | - | - | +| barringOfInvocationOfCall Transfer | O | M | M | - | - | +| operatorDeterminedBarring | O | M | M | - | - | +| PLMNs specificData | | | | | | +| vGCSGroupMembershipList | O | M | M | - | - | +| vBSGroupMembershipList | O | M | M | - | - | +| broadcastCallInitiation AllowedList | O | M | M | - | - | +| originatingCAMELSubscription InformationOCSI | O | M | M | - | - | +| terminatingCAMELSubscription InformationTCSI | O | M | M | - | - | +| vMSCTerminatingCAMEL Subscription InformationVTCSI | O | M | M | - | - | +| locationInformation/ SubscriberStateInformation | O | M | M | - | - | +| uSSDCAMELSubscription InformationUCSI | O | M | M | - | - | +| sSInvocationNotification SSCSI | O | M | M | - | - | +| translationInformationFlag TIFCSI | O | M | M | - | - | +| dialledServiceCAMEL SubscriptionInformationDCSI | O | M | M | - | - | +| uSSDGeneralCAMELService InformationUGCSI | O | M | M | - | - | +| shortMessageServiceCAMEL SubscriptionInformationMOSMSCSI | O | M | M | - | - | +| shortMessageServiceCAMEL SubscriptionInformationMTSMSCSI | O | M | M | - | - | + +| | | | | | | +|--------------------------------------------------|---|---|---|---|---| +| mTSMSCSIVLRNegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| gsmSCFaddressforCSI | O | M | M | - | - | +| iSTAlertTimer | O | M | M | - | - | +| cSAllocationRetentionpriority | O | M | M | - | - | +| iCSIndicator | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theCSSupplServiceForCSSS | O | M | O | - | - | + +#### 4.3.6.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.6.4 Notifications + +None. + +### 4.3.7 GPRSSubscribedService + +#### 4.3.7.1 Definition + +This class represents subscription to a GPRS service (see 3GPP TS 23.008 [7]) for a subscriber. The entire set of GPRS subscribed services owned by a subscriber constitutes the subscriber's Subscribed Services Profile for GPRS services. + +#### 4.3.7.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| networkAccessMode | M | M | M | - | - | +| basicMSISDNIndicator | O | M | M | - | - | +| mSISDNAlertIndicator | O | M | M | - | - | +| rSZIlists | O | M | M | - | - | +| lSAIdentity | O | M | M | - | - | +| lSAPriority | O | M | M | - | - | +| lSAPreferentialAccessIndicator | O | M | M | - | - | +| lSAActiveModeSupportIndicator | O | M | M | - | - | +| lSAOnlyAccessIndicator | O | M | M | - | - | +| lSAActiveModeIndicator | O | M | M | - | - | +| vPLMNIdentifier | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| mOLRList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| gGSNNumber | M | M | M | - | - | +| provisionofTeleservice | O | M | M | - | - | +| transferofSMoption | M | M | M | - | - | +| subscriberStatus | M | M | M | - | - | +| barringofPacketOrientedServices | O | M | M | - | - | +| pDPType | O | M | M | - | - | +| pDPAddress | O | M | M | - | - | +| accessPointName | O | M | M | - | - | +| vPLMNAddressAllowed | O | M | M | - | - | +| qualityofServiceSubscribed | O | M | M | - | - | +| pDPContextCharging<br>Characteristics | O | M | M | - | - | +| gPRSCAMELSubscription<br>InformationGPRSCSI | O | M | M | - | - | +| mOShortMessageService<br>CAMELSubscription<br>InformationMOSMSCSI | O | M | M | - | - | +| mTShortMessageService<br>CAMELSubscription<br>InformationMTSMSCSI | O | M | M | - | - | +| mOSMSCSISGSNNegotiated<br>CAMELCapabilityHandling | O | M | M | - | - | +| mTSMSCSISGSNNegotiated<br>CAMELCapabilityHandling | O | M | M | - | - | +| mobilityManagementforGPRSevent<br>notificationMGCSI | O | M | M | - | - | +| mGCSINegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| gsmSCFaddressforCSI | O | M | M | - | - | +| subscribedCharging<br>Characteristics | O | M | M | - | - | +| closedSubscriberGroup<br>Information | O | M | M | - | - | +| gSMSCFaddresslistForODB | O | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| operatorDeterminedBarring<br>PLMNspectificData | O | M | M | - | - | +| STNSR | O | M | M | - | - | +| iCSIIndicator | O | M | M | - | - | +| listofauthorizedvisitednetwork<br>identifiers | O | M | M | - | - | +| wLANUERemoteIPaddress | O | M | M | - | - | +| staticWLANUERemoteIP<br>AddressList | O | M | M | - | - | +| w-APNBarringTypeList | O | M | M | - | - | +| w-APNChargingDataList | O | M | M | - | - | + +| | | | | | | +|---------------------------------------------|---|---|---|---|---| +| accessDependenceFlag | O | M | M | - | - | +| chargingCharacteristics | O | M | M | - | - | +| primaryOCSSCharging<br>FunctionName | O | M | M | - | - | +| secondaryOCSSCharging<br>FunctionName | O | M | M | - | - | +| primaryChargingCollection<br>FunctionName | O | M | M | - | - | +| secondaryChargingCollection<br>FunctionName | O | M | M | - | - | +| w-APNIdentifierList | O | M | M | - | - | +| maxNumberAccessesList | O | M | M | - | - | +| maxSubscribedBandwidth | O | M | M | - | - | +| subscribed3GPPWLANQoSProfile | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theGPRSSupplServiceforGPRSSS | O | M | O | - | - | + +#### 4.3.7.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.7.4 Notifications + +None. + +### 4.3.8 IMSSubscribedService + +#### 4.3.8.1 Definition + +This class represents subscription to an IMS (see 3GPP TS 23.008 [7]) service for a subscriber. The entire set of IMS subscribed services owned by a subscriber constitutes the subscriber's Subscribed Services profile for IMS services. + +This class contains the agreed (between the Subscriber and the Service Provider) parameter settings for an IMS service that a Subscriber subscribes to. + +#### 4.3.8.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------------------|-------------------|------------|------------|-------------|--------------| +| listOfAuthorizedVisitedNetworkIdentifiers | M | M | M | - | - | +| registrationStatus | M | M | M | - | - | +| sCSCFName | O | M | - | - | - | +| diameterClientAddressofSCSCF | O | M | - | - | - | +| subscribedMediaProfileIdentifier | O | M | M | - | - | +| initialFilterCriteriaList | O | M | M | - | - | +| applicationServerInformation | O | M | M | - | - | +| serviceIndicationList | O | M | - | - | - | +| primaryEventChargingFunctionName | O | M | M | - | - | +| secondaryEventChargingFunctionName | O | M | M | - | - | +| primaryChargingCollectionFunctionName | M | M | M | - | - | +| secondaryChargingCollectionFunctionName | O | M | M | - | - | +| gsmSCFaddressforIMCSI | O | M | M | - | - | +| oIMCSI | O | M | M | - | - | +| vTIMCSI | O | M | M | - | - | +| dIMCS | O | M | M | - | - | +| gAAServiceType | O | M | M | - | - | +| gAAServiceIdentifier | O | M | M | - | - | +| gBAUserSecuritySettings | O | M | M | - | - | +| userSecuritySetting | O | M | M | - | - | +| userPublicIdentity | O | M | M | - | - | +| gAAAuthorizationflag | O | M | M | - | - | +| keyLifetime | O | M | M | - | - | +| uICCSecurityType | O | M | M | - | - | +| nAFGroupIdentity | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theServerCapabilities | O | M | - | - | - | + +#### 4.3.8.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.8.4 Notifications + +None. + +### 4.3.9 SuMSubscriberProfile + +#### 4.3.9.1 Definition + +This class represents the Subscriber Profile. + +This class also contains the reference to its aggregated Subscribed Service as well as the users for a subscriber. + +#### 4.3.9.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| suMSubscriberProfileInfo | M | M | O | - | - | +| <b>Attribute related to role</b> | | | | | | +| theUser | M | M | O | - | - | +| theSubscribedService | M | M | O | - | - | +| theMobileUserData | M | M | O | - | - | + +#### 4.3.9.3 Attribute constraints + +None. + +#### 4.3.9.4 Notifications + +None. + +### 4.3.10 SuMServiceProfile + +#### 4.3.10.1 Definition + +This is an abstract IOC provided for sub-classing only. It provides attribute(s) that are common to Service Profiles IOCs. + +#### 4.3.10.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| theSpecification | M | M | O | - | - | + +#### 4.3.10.3 Attribute constraints + +None. + +#### 4.3.10.4 Notifications + +None. + +### 4.3.11 CSServiceProfile + +#### 4.3.11.1 Definition + +This class represents for a subscribed CS service (see 3GPP TS 23.008 [7]) the service preferences and settings chosen for a user. + +#### 4.3.11.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|------------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| basicMSISDNIndicator | O | M | M | - | - | +| mSISDNAlertIndicator | O | M | M | - | - | +| vLRNumber | M | M | - | - | - | +| mSCNumber | M | M | - | - | - | +| subscriptionRestriction | O | M | M | - | - | +| mSCAreaRestrictedFlag | M | M | - | - | - | +| oDBinducedBarringData | O | M | - | - | - | +| roamingRestrictionDueTo<br>UnsupportedFeature | M | M | - | - | - | +| lSAIdentity | O | M | M | - | - | +| lSAPriority | O | M | M | - | - | +| lSAPreferentialAccessIndicator | O | M | M | - | - | +| lSAActiveModeSupportIndicator | O | M | M | - | - | +| lSAOnlyAccessIndicator | O | M | M | - | - | +| lSAActiveModeIndicator | O | M | M | - | - | +| vPLMNIdentifier | O | M | M | - | - | +| ageIndicator | O | M | - | - | - | +| lMSI | M | M | - | - | - | +| mobileStationCategory | M | M | M | - | - | +| lMUIIdentifier | O | M | M | - | - | +| mNRRMSC | M | M | - | - | - | +| notificationToCSEFlagForODB | O | M | - | - | - | +| gsmSCFaddresslistForODB | O | M | M | - | - | +| messagesWaitingData | O | M | - | - | - | +| mobileStationNotReachableFlag | O | M | - | - | - | +| memoryCapacityExceededFlag | M | M | - | - | - | +| traceReference | O | M | - | - | - | +| traceType | O | M | - | - | - | +| operationsSystemsIdentity | O | M | - | - | - | +| hLRTraceType | O | M | - | - | - | +| mAPErrorOnTrace | O | M | - | - | - | +| traceActivatedInVLR | O | M | - | - | - | +| provisionOfBearerService | M | M | M | - | - | +| provisionOfTeleservice | M | M | M | - | - | +| bCAlocation | O | M | M | - | - | +| checkSSIndicator | M | M | - | - | - | +| mSPurgedForNonGPRSFlag | M | M | - | - | - | +| barringOfIncomingCalls | O | M | M | - | - | +| barringOfPremiumRateCalls | O | M | M | - | - | +| barringOfSupplementaryService<br>Management | O | M | M | - | - | +| barringOfRegistrationOfCall<br>Forwarding | O | M | M | - | - | +| barringOfInvocationOfCallTransfer | O | M | M | - | - | +| vGCSGroupMembershipList | O | M | M | - | - | +| vBSGroupMembershipList | O | M | M | - | - | +| broadcastCallInitiationAllowedList | O | M | M | - | - | +| originatingCAMELSubscription<br>InformationOCSI | O | M | M | - | - | +| terminatingCAMELSubscription<br>InformationTCSI | O | M | M | - | - | +| vMSCTerminatingCAMEL<br>SubscriptionInformationVTCSI | O | M | M | - | - | +| locationInformationSubscriber<br>StateInformation | O | M | M | - | - | +| uSSDCAMELSubscription<br>InformationUCSI | O | M | M | - | - | +| sSInvocationNotificationSSCSI | O | M | M | - | - | +| translationInformationFlagTIFCSI | O | M | M | - | - | +| dialledServiceCAMELSubscription<br>InformationDCSI | O | M | M | - | - | + +| <b>Attribute name</b> | <b>Support Qualifier</b> | <b>isReadable</b> | <b>isWritable</b> | <b>isInvariant</b> | <b>isNotifyable</b> | +|-------------------------------------------------------------|--------------------------|-------------------|-------------------|--------------------|---------------------| +| uSSDGeneralCAMELService<br>InformationUGCSI | O | M | M | - | - | +| oCSINegotiatedCAMEL<br>CapabilityHandling | O | M | - | - | - | +| sSCSINegotiatedCAMEL<br>CapabilityHandling | O | M | - | - | - | +| vTCSINegotiatedCAMEL<br>CapabilityHandling | O | M | - | - | - | +| shortMessageServiceCAMEL<br>SubscriptionInformationMOSMSCSI | O | M | M | - | - | +| shortMessageServiceCAMEL<br>SubscriptionInformationMTSMSCSI | O | M | M | - | - | +| mOSMSCSIVLRNegotiatedCAMEL<br>CapabilityHandling | O | M | - | - | - | +| mTSMSCSIVLRNegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| mCSINegotiatedCAMEL<br>CapabilityHandling | O | M | - | - | - | +| vLRSupportedCAMELPhases | O | M | - | - | - | +| gsmSCFaddressforCSI | O | M | M | - | - | +| vLROfferedCAMEL4CSIs | O | M | - | - | - | +| iSTAlertTimer | O | M | M | - | - | +| cSAllocationRetentionpriority | O | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| theCSSupplServiceForCSSP | O | M | O | - | - | + +#### 4.3.11.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.11.4 Notifications + +None. + +### 4.3.12 GPRSServiceProfile + +#### 4.3.12.1 Definition + +This class represents for a subscribed GPRS service (see 3GPP TS 23.008 [7]) the service preferences and settings chosen for a user. + +#### 4.3.12.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| basicMSISDNIndicator | O | M | M | - | - | +| mSISDNAlertIndicator | O | M | M | - | - | +| vLRNumber | M | M | - | - | - | +| lSAIdentity | O | M | M | - | - | +| lSAPriority | O | M | M | - | - | +| lSAPreferentialAccessIndicator | O | M | M | - | - | +| lSAActiveModeSupportIndicator | O | M | M | - | - | +| lSAOnlyAccessIndicator | O | M | M | - | - | +| lSAActiveModeIndicator | O | M | M | - | - | +| vPLMNIdentifier | O | M | M | - | - | +| ageIndicator | O | M | - | - | - | +| sGSNNumber | M | M | - | - | - | +| gGSNNumber | M | M | M | - | - | +| mNRG | M | M | - | - | - | +| provisionofTeleservice | O | M | M | - | - | +| transferofSMoption | M | M | M | - | - | +| mSpurgedforGPRSflag | M | M | - | - | - | +| pDPType | O | M | M | - | - | +| pDPAddress | O | M | M | - | - | +| gGSNlist | M | M | - | - | - | +| qualityofServiceSubscribed | O | M | M | - | - | +| pDPContextIdentifier | O | M | - | - | - | +| pDPContextChargingCharacteristics | O | M | M | - | - | +| gPRSCAMELSubscriptionInformation<br>GPRSCSI | O | M | M | - | - | +| mOShortMessageServiceCAMEL<br>SubscriptionInformationMOSMSCSI | O | M | M | - | - | +| mTShortMessageServiceCAMEL<br>SubscriptionInformationMTSMSCSI | O | M | M | - | - | +| mOSMSCSISGSNNegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| mTSMSCSISGSNNegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| mobilityManagementforGPRS<br>eventnotificationMGCSI | O | M | M | - | - | +| mGCSINegotiatedCAMEL<br>CapabilityHandling | O | M | M | - | - | +| gPRSCSINegotiatedCAMEL<br>CapabilityHandling | O | M | - | - | - | +| sGSNSupportedCAMELPhases | O | M | - | - | - | +| sGSNOfferedCAMEL4CSIs | O | M | - | - | - | +| gsmSCFaddressforCSI | O | M | M | - | - | +| gSMSCFaddresslistForODB | O | M | M | - | - | +| iPSMGWNNumber | O | M | - | - | - | +| mNRR-SGSN | O | M | - | - | - | +| notificationToCSEFlagForODB | O | M | - | - | - | +| Attribute related to role | | | | | | +| theGPRSSupplServiceForGPRSSP | O | M | O | - | - | + +#### 4.3.12.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.12.4 Notifications + +None. + +### 4.3.13 IMSServiceProfile + +#### 4.3.13.1 Definition + +This class represents for a subscribed IMS (see 3GPP TS 23.008 [7]) service the service preferences and settings chosen for a user. + +This class contains the reference to its aggregated IMS Public Identifications. + +#### 4.3.13.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------------------------|-------------------|------------|------------|-------------|--------------| +| listofAuthorizedvisitednetwork identifiers | M | M | M | - | - | +| registrationStatus | M | M | M | - | - | +| sSCSFName | O | M | - | - | - | +| diameterClientAddressofSCSCF | O | M | - | - | - | +| subscribedMediaProfileIdentifier | O | M | M | - | - | +| initialFilterCriteriaList | O | M | M | - | - | +| applicationServerInformation | O | M | M | - | - | +| serviceIndicationList | O | M | - | - | - | +| primaryEventChargingFunctionName | O | M | M | - | - | +| secondaryEventChargingFunctionName | O | M | M | - | - | +| primaryChargingCollectionFunctionName | M | M | M | - | - | +| secondaryChargingCollectionFunctionName | O | M | M | - | - | +| gsmSCFaddressforIMCSI | O | M | M | - | - | +| iMSSFaddressforIMCSI | O | M | - | - | - | +| oIMCSI | O | M | M | - | - | +| vTIMCSI | O | M | M | - | - | +| dIMCS | O | M | M | - | - | +| gAAServiceType | O | M | M | - | - | +| gAAServiceIdentifier | O | M | M | - | - | +| gBAUserSecuritySettings | O | M | M | - | - | +| userSecuritySetting | O | M | M | - | - | +| userPublicIdentity | O | M | M | - | - | +| gAAAuthorizationflag | O | M | M | - | - | +| keyLifetime | O | M | M | - | - | +| uICCSecurityType | O | M | M | - | - | +| nAFGroupIdentity | O | M | M | - | - | +| thePublicId | M | M | O | - | - | +| <b>Attribute related to role</b> | | | | | | +| theServerCapabilities | O | M | - | - | - | + +#### 4.3.13.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.13.4 Notifications + +None. + +### 4.3.14 SubscriptionFunction + +#### 4.3.14.1 Definition + +This class represents subscription functionality. + +All managed elements related to the subscription of services have this functionality. + +This class inherits from ManagedFunction (defined in 32.622 [6]). + +This class contains the reference to its aggregated Users. + +This class contains the reference to its aggregated Subscriber Profiles. + +#### 4.3.14.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| theUser | M | M | O | - | - | +| theSubscriberProfile | M | M | O | - | - | + +#### 4.3.14.3 Attribute constraints + +None. + +#### 4.3.14.4 Notifications + +None. + +### 4.3.15 SuMCSSupplService + +#### 4.3.15.1 Definition + +This class represents a Supplementary Service for a CS service (see 3GPP TS 23.008 [7]) provided by a service provider + +This class contains the valid parameters that define the CS supplementary service from subscription point of view. + +#### 4.3.15.2 Attributes + +| Attribute name | Support Qualifier | isReadabl<br>e | isWritabl<br>e | isInvarian<br>t | isNotifyabl<br>e | +|-------------------------|-------------------|----------------|----------------|-----------------|------------------| +| sS-Code | M | M | M | - | - | +| provisioningState | M | M | M | - | - | +| activationState | M | M | M | - | - | +| registrationState | O | M | M | - | - | +| overrideCategory | O | M | M | - | - | +| cLIRestrictionOption | O | M | M | - | - | +| forwarded-toNumber | O | M | M | - | - | +| forwarded-toSubaddress | O | M | M | - | - | +| noReplyConditionTimer | O | M | M | - | - | +| maximumEntitledPriority | O | M | M | - | - | +| defaultPriority | O | M | M | - | - | +| nbrUser | O | M | M | - | - | +| nbrSB | O | M | M | - | - | + +#### 4.3.15.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.15.4 Notifications + +None. + +### 4.3.16 SuMGPRSSupplService + +#### 4.3.16.1 Definition + +This class represents a Supplementary Service for a GPRS service (see 3GPP TS 23.008 [7]) provided by a service provider + +This class contains the valid parameters that define the GPRS supplementary service from subscription point of view. + +#### 4.3.16.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|-------------------|-------------------|------------|------------|-------------|--------------| +| sS-Code | M | M | M | - | - | +| provisioningState | M | M | M | - | - | +| activationState | M | M | M | - | - | + +#### 4.3.16.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.16.4 Notifications + +None. + +### 4.3.17 SuMUser + +#### 4.3.17.1 Definition + +This class represents a User. + +This class contains the valid parameters that define the User from subscription point of view. + +#### 4.3.17.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifiable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| <b>Attribute related to role</b> | | | | | | +| theMobileUserData | M | M | O | - | - | +| theSubscriber | O | M | O | - | - | +| theCredentials | M | M | O | - | - | +| theServiceProfile | M | M | O | - | - | +| theIdentity | O | M | O | - | - | + +#### 4.3.17.3 Attribute constraints + +None. + +#### 4.3.17.4 Notifications + +None. + +### 4.3.18 SuMCredentials + +#### 4.3.18.1 Definition + +This class represents a User's credentials. + +This class contains the valid parameters that define the credentials from subscription point of view. + +#### 4.3.18.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------------------------|-------------------|------------|------------|-------------|--------------| +| iMSPrivateUserIdentity | M | M | M | - | - | +| <b>Attribute related to role</b> | | | | | | +| thePublicId | M | M | O | - | - | +| theServiceProfile | M | M | O | - | - | + +#### 4.3.18.3 Attribute constraints + +| Name | Definition | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>theServiceProfile</b> | <p>If theServiceProfile points to at least one instance of IMSServiceProfile, thePublicId of the same object instance of SuMCredentials may not point to any instance of IMSPublicIdentification.</p> <p>All instances of this relationship from the same object instance of SuMCredentials shall be to object instances of IMSServiceProfile that are</p> <ul style="list-style-type: none"> <li>i) name-contained by the same object instance of SuMUser as name-contains the SuMCredentials object instance, and</li> <li>ii) associated (through the relationship to SuMSubscribedService name-contained by SuMSubscriberProfile) to a single object instance of SuMSubscriberProfile.</li> </ul> | +| <b>thePublicId</b> | <p>If thePublicId points to at least one instance of IMSPublicIdentification, theServiceProfile of the same object instance of SuMCredentials may not point to any instance of IMSServiceProfile.</p> <p>All instances of this relationship from the same object instance of SuMCredentials shall be to object instances of IMSPublicIdentification that are name-contained by object instances of IMSServiceProfile that are</p> <ul style="list-style-type: none"> <li>i) name-contained by the same object instance of SuMUser as name-contains the SuMCredentials object instance, and</li> <li>ii) associated (through the relationship to SuMSubscribedService name-contained by SuMSubscriberProfile) to a single object instance of SuMSubscriberProfile.</li> </ul> | + +#### 4.3.18.4 Notifications + +None. + +### 4.3.19 IMSPublicIdentification + +#### 4.3.19.1 Definition + +This class represents the IMS Public Identification (see 3GPP TS 23.008 [7] and 3GPP TS 29.228 [8]). + +This class contains the valid parameters that define the IMS Public Identification from subscription point of view. + +#### 4.3.19.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------|-------------------|------------|------------|-------------|--------------| +| publicUserIdentity | M | M | M | - | - | +| barringIndication | M | M | M | - | - | + +#### 4.3.19.3 Attribute constraints + +None. + +#### 4.3.19.4 Notifications + +None. + +### 4.3.20 MobileUserData + +#### 4.3.20.1 Definition + +This class represents user data of a mobile User Equipment. + +This class contains the valid parameters that define the user data of the mobile User Equipment from subscription point of view. + +#### 4.3.20.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------|-------------------|------------|------------|-------------|--------------| +| theServiceProfile | M | M | O | - | - | +| iMSI | M | M | M | - | - | +| mSISDN | M | M | M | - | - | +| multinumberingMSISDNs | M | M | M | - | - | +| iMEISV | O | M | - | - | - | + +#### 4.3.20.3 Attribute constraints + +None. + +#### 4.3.20.4 Notifications + +None. + +### 4.3.21 SuMServiceParameter + +#### 4.3.21.1 Definition + +This class represents a structured Service Parameter defined for a service and is an abstract class provided for subclassing only. + +This class shall be used as a base when having the requirement to provision common shared data referred to by specific SuMSubscribedService or SuMServiceProfile instances. + +#### 4.3.21.2 Attributes + +None. + +#### 4.3.21.3 Attribute constraints + +None. + +#### 4.3.21.4 Notifications + +None. + +### 4.3.22 SuMIdentity + +#### 4.3.22.1 Definition + +This class represents a user related identity, regardless of any type service to be provisioned and is an abstract class provided for sub-classing only. + +This class allows an identity to be used for multiple services. + +#### 4.3.22.2 Attributes + +None. + +#### 4.3.22.3 Attribute constraints + +None. + +#### 4.3.22.4 Notifications + +None. + +### 4.3.23 ServerCapabilities + +#### 4.3.23.1 Definition + +This class is used to provision common shared ServerCapabilities data referred by specific SuMSubscribedService or SuMServiceProfile instances. + +This class contains information to assist the I-CSCF in the selection of an S-CSCF for an IMS subscriber or a PSI user. + +#### 4.3.23.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------|-------------------|------------|------------|-------------|--------------| +| serverCapabilities | M | M | M | - | - | + +#### 4.3.23.3 Attribute constraints + +None. + +#### 4.3.23.4 Notifications + +None. + +### 4.3.24 EPSService + +#### 4.3.24.1 Definition + +This class represents an EPS service (see 3GPP TS 23.008 [7]) provided by a service provider. This class contains the valid parameters that define the EPS service from a subscription point of view. + +#### 4.3.24.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------------------|-------------------|------------|------------|-------------|--------------| +| accessPointName | O | M | M | - | - | +| access Restriction Data | O | M | M | - | - | +| aPNAMBR | M | M | M | - | - | +| barringOfPacketOrientedServices | O | M | M | - | - | +| contextIdentifier | M | M | M | - | - | +| operatorDeterminedBarringPLMNs | O | M | M | - | - | +| pecificData | | | | | | +| pDNAddress | O | M | M | - | - | +| rSZILists | O | M | M | - | - | +| sTNSR | O | M | M | - | - | +| subscribedChargingCharacteristics | O | M | M | - | - | +| subscriberStatus | O | M | M | - | - | +| networkAccessMode | M | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| mOLRList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| iCSIIndicator | O | M | M | - | - | +| aPNOIReplacement | O | M | M | - | - | +| subscribedUEAMBR | M | M | M | - | - | +| aPNConfigurationProfile | M | M | M | - | - | +| rFSP | O | M | M | - | - | +| vPLMNAddressAllowed-EPS | M | M | M | - | - | +| pDNGWIdentity | O | M | M | - | - | +| ePSPDNConnectionChargingCharacteristics | O | M | M | - | - | +| pDNGWAllocationType | M | M | M | - | - | +| aPNLevelAPNOIReplacement | O | M | M | - | - | +| closedSubscriberGroupInformation | O | M | M | - | - | +| listofauthorizedvisitednetworkidentifiers | O | M | M | - | - | +| staticWLANUERemoteIPAddressList | O | M | M | - | - | +| w-APNBarringTypeList | O | M | M | - | - | +| w-APNChargingDataList | O | M | M | - | - | +| wLANUERemoteIPAddress | O | M | M | - | - | +| accessDependenceFlag | O | M | M | - | - | +| chargingCharacteristics | O | M | M | - | - | +| primaryOCSChargingFunctionName | O | M | M | - | - | +| secondaryOCSChargingFunctionName | O | M | M | - | - | +| primaryChargingCollectionFunctionName | O | M | M | - | - | +| secondaryChargingCollectionFunctionName | O | M | M | - | - | +| w-APNIdentifierList | O | M | M | - | - | +| maxNumberAccessesList | O | M | M | - | - | +| maxSubscribedBandwidth | O | M | M | - | - | +| subscribed3GPPWLANQoSProfile | O | M | M | - | - | +| permanentUserIdentity | O | M | M | - | - | +| mIPSubscriberProfile | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | + +#### 4.3.24.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.24.4 Notifications + +None. + +### 4.3.25 EPSSubscribedService + +#### 4.3.25.1 Definition + +This class represents subscription to an EPS service (see 3GPP TS 23.008 [7]) for a subscriber. The entire set of EPS subscribed services owned by a subscriber constitutes the subscriber's Subscribed Services Profile for EPS services. + +This class contains the agreed (between the Subscriber and the Service Provider) parameter settings for an EPS service that a Subscriber subscribes to. + +#### 4.3.25.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------------------|-------------------|------------|------------|-------------|--------------| +| accessPointName | O | M | M | - | - | +| access Restriction Data | O | M | M | - | - | +| aPNAMBR | M | M | M | - | - | +| barringofPacketOrientedServices | O | M | M | - | - | +| contextIdentifier | M | M | M | - | - | +| operatorDeterminedBarringPLMNSpecificData | O | M | M | - | - | +| pDNAAddress | O | M | M | - | - | +| rSZILists | O | M | M | - | - | +| sTNSR | O | M | M | - | - | +| subscribedChargingCharacteristics | O | M | M | - | - | +| subscriberStatus | O | M | M | - | - | +| networkAccessMode | M | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| mOLRList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| iCSIndicator | O | M | M | - | - | +| aPNOIReplacement | O | M | M | - | - | +| subscribedUEAMBR | M | M | M | - | - | +| aPNConfigurationProfile | M | M | M | - | - | +| rFSP | O | M | M | - | - | +| vPLMNAddressAllowed-EPS | M | M | M | - | - | +| pDNGWIdentity | O | M | M | - | - | +| ePSPDNConnectionChargingCharacteristics | O | M | M | - | - | +| pDNGWAllocationType | M | M | M | - | - | +| aPNLevelAPNOIReplacement | O | M | M | - | - | +| closedSubscriberGroupInformation | O | M | M | - | - | +| Listofauthorizedvisitednetworkidentifiers | O | M | M | - | - | +| wLANUERemoteIPAddress | O | M | M | - | - | +| staticWLANUERemoteIPAddressList | O | M | M | - | - | +| w-APNBarringTypeList | O | M | M | - | - | +| w-APNChargingDataList | O | M | M | - | - | +| accessDependenceFlag | O | M | M | - | - | +| chargingCharacteristics | O | M | M | - | - | +| primaryOCSChargingFunctionName | O | M | M | - | - | +| secondaryOCSChargingFunctionName | O | M | M | - | - | +| primaryChargingCollectionFunctionName | O | M | M | - | - | +| secondaryChargingCollectionFunctionName | O | M | M | - | - | +| w-APNIdentifierList | O | M | M | - | - | +| maxNumberAccessesList | O | M | M | - | - | +| maxSubscribedBandwidth | O | M | M | - | - | +| subscribed3GPPWLANQoSProfile | O | M | M | - | - | +| permanentUserIdentity | O | M | M | - | - | +| mIPSSubscriberProfile | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | + +#### 4.3.25.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.25.4 Notifications + +None. + +### 4.3.26 EPSServiceProfile + +#### 4.3.26.1 Definition + +This class represents for a subscribed EPS service (see 3GPP TS 23.008 [7]) the service preferences and settings chosen for a user. + +#### 4.3.26.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------|-------------------|------------|------------|-------------|--------------| +| aPNAMBR | M | M | M | - | - | +| contextIdentifier | M | M | M | - | - | +| pDNAddress | O | M | M | - | - | +| aPNOIReplacement | O | M | M | - | - | +| subscribedUEAMBR | M | M | M | - | - | +| aPNConfigurationProfile | M | M | M | - | - | +| rFSP | O | M | M | - | - | +| pDNGWIdentity | O | M | M | - | - | +| ePSPDNConnectionChargingCharacteristics | O | M | M | - | - | +| vPLMNAddressAllowed-EPS | M | M | M | - | - | +| pDNGWAllocationType | M | M | M | - | - | +| aPNLevelAPNOIReplacement | O | M | M | - | - | +| roamingRestrictionDueToUnsupportedFeatureMME | M | M | - | - | - | +| roamingRestrictionDueToUnsupportedFeatureSGSN | M | M | - | - | - | +| mSPurgedForEPSFlag | M | M | - | - | - | +| uRRPMME | O | M | - | - | - | +| mMEName | M | M | - | - | - | +| sGSNName | M | M | - | - | - | +| iWFNumber | O | M | - | - | - | +| sGSNAreaRestrictedFlag | M | M | - | - | - | +| Attribute related to role | | | | | | +| theOptHandover3GPP2Par | M | M | O | - | - | +| theNon3GPPAccessPar | M | M | O | - | - | + +#### 4.3.26.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.26.4 Notifications + +None. + +### 4.3.27 PSCommonServiceProfile + +#### 4.3.27.1 Definition + +This is an abstract IOC provided for sub-classing only. It provides attribute(s) that are common to PS Service Profile IOCs (Regarding GPRS or EPS service, please see 3GPP TS 23.008 [7]). + +#### 4.3.27.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------------------------------|-------------------|------------|------------|-------------|--------------| +| roamingRestrictedintheSGSNduetounsupportedfeature | M | M | - | - | - | +| barringofPacketOrientedServices | O | M | M | - | - | +| iPAddressOfTraceCollectionEntity | O | M | - | - | - | +| accessPointName | O | M | M | - | - | +| subscribedChargingCharacteristics | O | M | M | - | - | +| sTNSR | O | M | M | - | - | +| closedSubscriberGroupInformation | O | M | M | - | - | +| theIWANPar | M | M | O | - | - | + +#### 4.3.27.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.27.4 Notifications + +None. + +### 4.3.28 IWANParameters + +#### 4.3.28.1 Definition + +This class represents for a subscribed GPRS or EPS service (see 3GPP TS 23.008 [7]) the service preferences and settings chosen for a user that are relevant to IWAN services. + +#### 4.3.28.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-------------------------------------------|-------------------|------------|------------|-------------|--------------| +| w-APN | O | M | - | - | - | +| listofauthorizedvisitednetworkidentifiers | O | M | M | - | - | +| 3GPPAAAServerName | O | M | - | - | - | +| 3GPPAAProxyName | O | M | - | - | - | +| wLANUERemoteIPAddress | O | M | M | - | - | +| staticWLANUERemoteIPAddressList | O | M | M | - | - | +| w-APNBarringTypeList | O | M | M | - | - | +| w-APNChargingDataList | O | M | M | - | - | +| accessDependenceFlag | O | M | M | - | - | +| i-WLANAccessType | O | M | - | - | - | +| wLANIdentifierList | O | M | M | - | - | +| maxNumberAccessesList | O | M | M | - | - | +| maxSubscribedBandwidth | O | M | M | - | - | +| subscribed3GPPWLANQoSProfile | O | M | M | - | - | +| chargingCharacteristics | M | M | M | - | - | +| primaryOCSChargingFunctionName | O | M | M | - | - | +| secondaryOCSChargingFunctionName | O | M | M | - | - | +| primaryChargingCollectionFunctionName | O | M | M | - | - | +| secondaryChargingCollectionFunctionName | O | M | M | - | - | +| userStatus | M | M | - | - | - | + +#### 4.3.28.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.28.4 Notifications + +None. + +### 4.3.29 OptHandover3GPP2Parameters + +#### 4.3.29.1 Definition + +This class represents for a subscribed EPS service (see 3GPP TS 23.008 [7]) the service preferences and settings chosen for a user that are relevant to the optimization of handover to a 3GPP2 network. + +#### 4.3.29.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|----------------|-------------------|------------|------------|-------------|--------------| +| rATType | O | M | - | - | - | + +#### 4.3.29.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.29.4 Notifications + +None. + +### 4.3.30 Non3GPPAccessParameters + +#### 4.3.30.1 Definition + +This class represents for a subscribed EPS service (see 3GPP TS 23.008 [7]) the service preferences and settings chosen for a user that are relevant to use of a non-3GPP access network. + +#### 4.3.30.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|--------------------------|-------------------|------------|------------|-------------|--------------| +| rATType | O | M | - | - | - | +| visitedNetworkIdentifier | O | M | - | - | - | +| mIPSubscriberProfile | M | M | M | - | - | +| permanentUserIdentity | M | M | M | - | - | + +#### 4.3.30.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.30.4 Notifications + +None. + +### 4.3.31 Common3GPPAccessServiceProfile + +#### 4.3.31.1 Definition + +This is an abstract IOC provided for sub-classing only. It provides attribute(s) that are common to CS/PS Service Profile IOCs (Regarding CS, GPRS or EPS service, please see 3GPP TS 23.008 [7]). + +#### 4.3.31.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|-----------------------------------------------|-------------------|------------|------------|-------------|--------------| +| rSZIlists | O | M | M | - | - | +| accessRestrictionData | O | M | M | - | - | +| subscriberStatus | O | M | M | - | - | +| barringOfOutgoingCalls | O | M | M | - | - | +| barringOfRoaming | O | M | M | - | - | +| operatorDeterminedBarringPLMNs<br>pecificData | O | M | M | - | - | +| traceReference2 | O | M | - | - | - | +| traceDepth | O | M | - | - | - | +| listOfNETypestoTrace | O | M | - | - | - | +| triggeringEvents | O | M | - | - | - | +| listOfInterfacesToTrace | O | M | - | - | - | +| privacyExceptionList | O | M | M | - | - | +| gMLCNumbers | O | M | M | - | - | +| iCSIndicator | O | M | M | - | - | +| mOLRList | O | M | M | - | - | +| serviceTypes | O | M | M | - | - | +| networkAccessMode | M | M | M | - | - | + +#### 4.3.31.3 Attribute constraints + +| Name | Definition | +|-------------------------|----------------------------------------------------| +| All optional attributes | The NE supports the parameter (see TS 23.008 [7]). | + +#### 4.3.31.4 Notifications + +None. + +## 4.4 Attribute definitions + +### 4.4.1 Attribute properties + +The following table defines the properties of attributes specified in the present document. + +| Attribute Name | Documentation and Allowed values | Properties | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| suMSubscriberProfileInfo | A description of (information for) the Subscriber Profile.<br>It is with free structure and format.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iMSI | 23.008 clause 2.1.1.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| networkAccessMode | 23.008 clause 2.1.1.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSISDN | 23.008 clause 2.1.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| multinumberingMSISDNs | 23.008 clause 2.1.3<br><br>It is a sequence of two items:<br>1) An MSISDN number (string)<br>2) A multinumberingMSISDNIndicator which can be one of two choices:<br>a) "BASIC"<br>b) "ALERT"<br><br>allowedValues: N/A | type: <<dataType>><br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| basicMSISDNIndicator | 23.008 clause 2.1.3.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSISDAlertIndicator | 23.008 clause 2.1.3.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lMSI | 23.008 clause 2.1.8<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mobileStationCategory | 23.008 clause 2.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lMUIdentifier | 23.008 clause 2.2.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-----------------------------------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| iMEISV | 23.008 clause 2.2.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| subscriptionRestriction | 23.008 clause 2.4.10<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rSZIlists | 23.008 clause 2.4.11.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSCAreaRestrictedFlag | 23.008 clause 2.4.12<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sGSNarearestrictedflag | 23.008 clause 2.4.14<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| oBInducedBarringData | 23.008 clause 2.4.15.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| roamingRestrictionDueToUn<br>supportedFeature | 23.008 clause 2.4.15.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| roamingRestrictedintheSG<br>SNduetounsupportedfeatur<br>e | 23.008 clause 2.4.15.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lSAIdentity | 23.008 clause 2.4.17.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lSAPriority | 23.008 clause 2.4.17.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|--------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| lsaPreferentialAccessIndicator | 23.008 clause 2.4.17.2A<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lsaActiveModeSupportIndicator | 23.008 clause 2.4.17.2B<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lsaOnlyAccessIndicator | 23.008 clause 2.4.17.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| lsaActiveModeIndicator | 23.008 clause 2.4.17.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vPLMNIdentifier | 23.008 clause 2.4.17.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| accessRestrictionData | 23.008 clause 2.4.18<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vLRNumber | 23.008 clause 2.4.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSCNNumber | 23.008 clause 2.4.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sGSNNumber | 23.008 clause 2.4.8.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gGSNNumber | 23.008 clause 2.4.8.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|--------------------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| provisionOfBearerService | 23.008 clause 2.5.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| provisionOfTeleservice | 23.008 clause 2.5.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| bCAllocation | 23.008 clause 2.5.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| transferOfSMoption | 23.008 clause 2.5.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mNRG | 23.008 clause 2.7.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| checkSSIndicator | 23.008 clause 2.7.4.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSPurgedForNonGPRSFlag | 23.008 clause 2.7.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSPurgedforGPRSflag | 23.008 clause 2.7.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mNRRMSC | 23.008 clause 2.7.7<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| subscriberStatus | 23.008 clause 2.8.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-------------------------------------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| barringOfOutgoingCalls | 23.008 clause 2.8.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfIncomingCalls | 23.008 clause 2.8.2.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfRoaming | 23.008 clause 2.8.2.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfPremiumRateCalls | 23.008 clause 2.8.2.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfSupplementaryServiceManagement | 23.008 clause 2.8.2.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfRegistrationOfCallForwarding | 23.008 clause 2.8.2.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfInvocationOfCallTransfer | 23.008 clause 2.8.2.7<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringOfPacketOrientedServices | 23.008 clause 2.8.2.8<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| operatorDeterminedBarringPLMNSpecificData | 23.008 clause 2.8.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| notificationToCSEFlagForODB | 23.008 clause 2.8.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-------------------------------|------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| gsmSCFaddresslistForODB | 23.008 clause 2.8.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| messagesWaitingData | 23.008 clause 2.10.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mobileStationNotReachableFlag | 23.008 clause 2.10.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| memoryCapacityExceededFlag | 23.008 clause 2.10.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| traceReference | 23.008 clause 2.11.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| traceType | 23.008 clause 2.11.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| operationsSystemsIdentity | 23.008 clause 2.11.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| hLRTraceType | 23.008 clause 2.11.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mAPErrorOnTrace | 23.008 clause 2.11.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| traceActivatedInVLR | 23.008 clause 2.11.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|------------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| traceActivatedinSGSN | 23.008 clause 2.11.7<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vGCSGroupMembershipList | 23.008 clause 2.12.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vBSGroupMembershipList | 23.008 clause 2.12.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| broadcastCallInitiationAllowedList | 23.008 clause 2.12.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDPType | 23.008 clause 2.13.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gGSNList | 23.008 clause 2.13.11<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| qualityofServiceSubscribed | 23.008 clause 2.13.12<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDPAddress | 23.008 clause 2.13.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDPContextIdentifier | 23.008 clause 2.13.24<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDPContextChargingCharacteristics | 23.008 clause 2.13.25<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|------------------------------------------------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| accessPointName | 23.008 clause 2.13.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vPLMNAddressAllowed | 23.008 clause 2.13.8<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vPLMNAddressAllowed-EPS | 23.008 clause 2.13.40<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| originatingCAMELSubscriptionInformationOCSI | 23.008 clause 2.14.1.1/3.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gPRSCAMELSubscriptionInformationGPRSCSI | 23.008 clause 2.14.1.10/2.14.4.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| dialledServiceCAMELSubscriptionInformationDCSI | 23.008 clause 2.14.1.11/3.7<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mobilityManagementforGPRS<br>SeventnotificationMGCSI | 23.008 clause 2.14.1.12/2.14.4.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| terminatingCAMELSubscriptionInformationTCSI | 23.008 clause 2.14.1.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vMSCTerminatingCAMELSubscriptionInformationVTCSI | 23.008 clause 2.14.1.2/3.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| locationInformationSubscriberStateInformation | 23.008 clause 2.14.1.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-----------------------------------------------------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| uSSDCAMELSubscriptionInformationUCSI | 23.008 clause 2.14.1.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sSInvocationNotificationSSCSI | 23.008 clause 2.14.1.5/3.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| translationInformationFlagTIFCSI | 23.008 clause 2.14.1.6/3.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| shortMessageServiceCAMELSubscriptionInformationMOSMSCSI | 23.008 clause 2.14.1.8/2.14.3.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI | 23.008 clause 2.14.1.8/2.14.4.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| shortMessageServiceCAMELSubscriptionInformationMTSMSCSI | 23.008 clause 2.14.1.9/2.14.3.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mTShortMessageServiceCAMELSubscriptionInformationMTSMSCSI | 23.008 clause 2.14.1.9/2.14.4.2.<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gPRSCSINegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mCSINegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mGCSINegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-----------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| mOSMSCSISGSNNegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mOSMSCSIVLRNegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mTSMSCSISGSNNegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mTSMSCSIVLRNegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| oCSINegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sSCSINegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vTCSINegotiatedCAMELCapabilityHandling | 23.008 clause 2.14.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| SGSNOfferedCAMEL4CSIs | 23.008 clause 2.14.2.2A<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| vLROfferedCAMEL4CSIs | 23.008 clause 2.14.2.2A<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sGSNSupportedCAMELPhases | 23.008 clause 2.14.2.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-----------------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| vLRSupportedCAMELPhases | 23.008 clause 2.14.2.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gsmSCFaddressforCSI | 23.008 clause 2.14.2.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| uSSDGeneralCAMELServiceInformationUGCSI | 23.008 clause 2.14.2.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iSTAlertTimer | 23.008 clause 2.15.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| privacyExceptionList | 23.008 clause 2.16.1.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gMLCNumbers | 23.008 clause 2.16.1.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mOLRList | 23.008 clause 2.16.1.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| serviceTypes | 23.008 clause 2.16.1.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ageIndicator | 23.008 clause 2.17.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cSAllocationRetentionpriority | 23.008 clause 2.18.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| subscribedChargingCharacteristics | 23.008 clause 2.19.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iMSPrivateUserIdentity | 23.008 clause 3.1.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| publicUserIdentity | 23.008 clause 3.1.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| barringIndication | 23.008 clause 3.1.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| listofauthorizedvisitednetworkidentifiers | 23.008 clause 3.1.4<br>23.008 clause 3B.1.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| registrationStatus | 23.008 clause 3.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sCSCFName | 23.008 clause 3.2.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| diameterClientAddressofSCSF | 23.008 clause 3.2.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| serverCapabilities | 23.008 clause 3.4.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| initialFilterCriteriaList | This attribute is a list which contains multiple items of initialFilterCriteria (Ref. 23.008 clause 3.5.2)<br><br>It is a set of initialFilterCriteria (string)<br><br>allowedValues: N/A | type: <<datatype>><br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed values | Properties | +|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| applicationServerInformation | 23.008 clause 3.5.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| serviceIndicationList | This attribute is a list which contains multiple items of serviceIndication (Ref. 23.008 clause 3.5.4)<br><br>It is a set of serviceIndication (string)<br><br>allowedValues: N/A | type: <<datatype>><br>multiplicity: 1..*<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| subscribedMediaProfileIdentifier | 23.008 clause 3.6.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| primaryEventChargingFunctionName | 23.008 clause 3.7.1<br>23.008 clause 3B.7.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| secondaryEventChargingFunctionName | 23.008 clause 3.7.2<br>23.008 clause 3B.7.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| primaryChargingCollectionFunctionName | 23.008 clause 3.7.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| secondaryChargingCollectionFunctionName | 23.008 clause 3.7.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gsmSCFaddressforIMCSI | 23.008 clause 3.8.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iMSSFaddressforIMCSI | 23.008 clause 3.8.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| oIMCSI | 23.008 clause 3.8.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| vTIMCSI | 23.008 clause 3.8.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| dIMCS | 23.008 clause 3.8.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gAAServiceType | 23.008 clause 3A.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gAAServiceIdentifier | 23.008 clause 3A.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gBAUserSecuritySettings | 23.008 clause 3A.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| userSecuritySetting | 23.008 clause 3A.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| userPublicIdentity | 23.008 clause 3A.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| gAAAuthorizationflag | 23.008 clause 3A.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| keyLifetime | 23.008 clause 3A.8<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| uICCSecuritySetting | 23.008 clause 3A.9<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|---------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| nAFGroupIdentity | 23.008 clause 3A.11<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| w-APN | 23.008 clause 3B.1.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| 3GPPAAAServerName | 23.008 clause 3B.1.6<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| wLANUERemoteIPAddress | 23.008 clause 3B.1.10<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| staticWLANUERemoteIPAddressList | 23.008 clause 3B.5.1.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| w-APNBarringTypeList | 23.008 clause 3B.5.1.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| w-APNChargingDataList | 23.008 clause 3B.5.1.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| accessDependenceFlag | 23.008 clause 3B.5.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| i-WLANAccessType | 23.008 clause 3B.5.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| chargingCharacteristics | 23.008 clause 3B.7.1.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|----------------------------------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| primaryOCSChargingFunctionName | 23.008 clause 3B.7.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| secondaryOCSChargingFunctionName | 23.008 clause 3B.7.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sS-Code | 23.008 clause 2.6<br>29.002 clause 7.6.4.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| provisioningState | 23.008 clause 2.6<br>29.002 clause 7.6.4.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| activationState | 23.008 clause 2.6<br>29.002 clause 7.6.4.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| registrationState | 23.008 clause 2.6<br>29.002 clause 7.6.4.2<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| overrideCategory | 23.008 clause 2.6<br>29.002 clause 7.6.4.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| cLIRestrictionOption | 23.008 clause 2.6<br>29.002 clause 7.6.4.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| forwarded-toNumber | 23.008 clause 2.6<br>29.002 clause 7.6.2.22<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|-------------------------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| forwarded-toSubaddress | 23.008 clause 2.6<br>29.002 clause 7.6.2.23<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| noReplyConditionTimer | 23.008 clause 2.6<br>29.002 clause 7.6.4.7<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| maximumEntitledPriority | 23.008 clause 2.6<br>29.002 clause 7.6.4.41<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| defaultPriority | 23.008 clause 2.6<br>29.002 clause 7.6.4.41<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| nbrUser | 23.008 clause 2.6<br>29.002 clause 7.6.4.47<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| nbrSB | 23.008 clause 2.6<br>29.002 clause 7.6.4.47<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| TraceReference2 | 23.008 Clause 2.11.9<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| TraceDepth | 23.008 Clause 2.11.10<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ListofNeTypestoTrace | 23.008 Clause 2.11.11<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| TriggeringEvents | 23.008 Clause 2.11.12<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ListofInterfacetoTrace | 23.008 Clause 2.11.13<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iCSIndicator | 23.008 Clause 2.20.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iCSIndicator | 23.008 Clause 2.20.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sTNSR | 23.008 Clause 2.21.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| 3GPPAAProxyName | 23.008 Clause 3B.1.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| w-APNIdentifierList | 23.008 Clause 3B.5.1.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| maxNumberAccessesList | 23.008 Clause 3B.5.1.5<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| maxSubscribedBandwidth | 23.008 Clause 3B.6.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| subscribed3GPPWLANQoSProfile | 23.008 Clause 3B.6.4<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|----------------------------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| userStatus | 23.008 Clause 3B.2.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rATType | 23.008 Clause 2.13.75<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iPAddressOfTraceCollectionEntity | 23.008 Clause 2.11.14<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| aPNConfigurationProfile | 23.008 Clause 2.13.31<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDNAddress | 23.008 Clause 2.13.39<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| permanentUserIdentity | 23.008 Clause 2.13.79<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| visitedNetworkIdentifier | 23.008 Clause 2.13.82<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mIPSSubscriberProfile | 23.008 Clause 2.13.86<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| aPNAMBR | 23.008 Clause 2.13.32<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| contextIdentifier | 23.008 Clause 2.13.38<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|----------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| aPNOIReplacement | 23.008 Clause 2.13.29<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| subscribedUEAMBR | 23.008 Clause 2.13.30<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| rFSP | 23.008 Clause 2.13.33<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDNGWIdentity | 23.008 Clause 2.13.41<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| ePSPDNConnectionCharging Characteristics | 23.008 Clause 2.13.71<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| pDNGWAllocationType | 23.008 Clause 2.13.105<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| aPNLevelAPNOIReplacement | 23.008 Clause 2.13.109<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| closedSubscriberGroupInformation | 23.008 Clause 2.4.22<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| roamingRestrictionDueToUnsupportedFeatureMME | 23.008 Clause 2.4.15.3a<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mSPurgedForEPSFlag | 23.008 Clause 2.7.6A<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| uRRPMME | 23.008 Clause 2.7.9.1<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| mMEName | 23.008 Clause 2.13.26<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| sGSNName | 23.008 Clause 2.13.100<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| iWFNumber | 23.008 Clause 2.4.8.3<br><br>allowedValues: N/A | type: String<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | +| <b>Attribute related to role</b> | | | +| theContract | Models the relationship to a subscribed service. The relationship is between a service and a subscription to the same type of service (for example between CSService and CSSubscribedService). This attribute contains a list of the DN(s) of the related SuMSubscribedService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theOffer | Models the relationship to a service. The relationship is between a service and a subscription to the same type of service (for example between CSService and CSSubscribedService). This attribute contains the DN of the related SuMService instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| theService | Models the relationship to a service profile. The relationship is between a subscribed service and a service profile of the same type of service (for example between CSSubscribedService and CSServiceProfile). This attribute contains a list of the DN(s) of the related SuMServiceProfile instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theSpecification | Models the relationship to a subscribed service. The relationship is between a subscribed service and a service profile of the same type of service (for example between CSSubscribedService and CSServiceProfile). This attribute contains the DN of the related SuMSubscribedService instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: False | + +| Attribute Name | Documentation and Allowed values | Properties | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| thePublicId | Models the relationship from a user's credentials to the IMS Public Identification. This attribute contains a list of the DN(s) of the related IMSPublicIdentification instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theMobileUserData | Models the relationship from a user to the user data of a mobile User Equipment. This attribute contains a list of the DN(s) of the related MobileUserData instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theServiceProfile | Models the relationship from the user data of a mobile User Equipment to a service profile or from a user's credentials to an IMS service profile. This attribute contains a list of the DN(s) of the related SuMServiceProfile derived instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theSubscriber | Models the relationship from a user to a subscriber. This attribute contains a list of the DN(s) of the related SuMSubscriberProfile instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theUser | Models the relationship from a subscriber profile or a Subscription Function to a user. This attribute contains a list of the DN(s) of the related SuMUser instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theCSSupplServiceForCS | Models the relationship from a CS service to a CS supplement service. This attribute contains a list of the DN(s) of the aggregated SuMCSSupplService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theGPRSSupplServiceForGPRS | Models the relationship from a GPRS service to a GPRS supplement service. This attribute contains a list of the DN(s) of the aggregated SuMGPRSSupplService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theCSSupplServiceForCSSS | Models the relationship from a CS subscribed service to a CS supplement service. This attribute contains a list of the DN(s) of the aggregated SuMCSSupplService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theGPRSSupplServiceForGPRSSS | Models the relationship from a GPRS subscribed service to a GPRS supplement service. This attribute contains a list of the DN(s) of the aggregated SuMGPRSSupplService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed values | Properties | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| theCSSupplServiceForCSSP | Models the relationship from a CS service profile to a CS supplement service. This attribute contains a list of the DN(s) of the aggregated SuMCSupplService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theGPRSSupplServiceForGPRSSP | Models the relationship from a GPRS service profile to a GPRS supplement service. This attribute contains a list of the DN(s) of the aggregated SuMGPRSSupplService instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theSubscribedService | Models the relationship from a subscriber profile to a subscribed service. This attribute contains a list of the DN(s) of the aggregated SuMSubscribedService derived instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| thePublicId | Models the relationship from an IMS service profile to a public identification. This attribute contains a list of the DN(s) of the aggregated IMSPublicIdentification instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theSubscriberProfile | Models the relationship from a Subscription Function to a subscriber profile. This attribute contains a list of the DN(s) of the <a href="#">aggregated</a> SuMSubscriberProfile instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theCredentials | Models the relationship from a user to a credential. This attribute contains a list of the DN(s) of the aggregated SuMCredentials instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theServiceProfile | Models the relationship from a user to a service profile. This attribute contains a list of the DN(s) of the aggregated SuMServiceProfile instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theIdentity | Models the relationship from a user to an identity. This attribute contains a list of DN(s) of the related SuMIdentity instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | +| theServerCapabilities | Models the relationship from a SuM IOC object instance (E.g., IMSService, IMSSubscribedService, IMSServiceProfile) to one or more Server Capabilities object instance(s).<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1..*<br>isOrdered: False<br>isUnique: True<br>defaultValue: None<br>isNullable: True | + +| Attribute Name | Documentation and Allowed values | Properties | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| theIWANPar | Models the relationship between the common packet access service parameters and the I-WAN service parameters. This attribute contains the DN of the related IWANParameters instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| theOptHandover3GPP2Par | Models the relationship between the EPS service profile when designed for optimal handover to a 3GPP2 access network. This attribute contains the DN of the related OptHandover3GPP2Parameters instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | +| theNon3GPPAccessPar | Models the relationship between the EPS service profile and another set of service parameters needed to when access is via a non 3GPP network. This attribute contains the DN of the related Non3GPPAccessParameters instance.<br><br>allowedValues: N/A | type: DN<br>multiplicity: 1<br>isOrdered: N/A<br>isUnique: N/A<br>defaultValue: None<br>isNullable: True | + +### 4.4.2 Constraints + +None. + +## 4.5 Common notifications + +None. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|---------------|-----|-----|----------------------------------------------------------|---------|------------|--------------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New | +| 2013-06 | | | | | Editorial changes (MCC): removal of blank page on page 2 | | 11.0.<br>0 | <b>11.0.<br/>1</b> | +| 2014-06 | SA#64 | SP-1403<br>59 | 001 | - | remove the feature support statements | F | 11.0.<br>1 | <b>11.1.<br/>0</b> | +| 2014-10 | - | - | - | - | Update to Rel-12 version (MCC) | | 11.1.<br>0 | <b>12.0.<br/>0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | | 12.0.<br>0 | <b>13.0.<br/>0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | | 13.0.<br>0 | <b>14.0.<br/>0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|----------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New<br>version | +| 2018-06 | | | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28753/raw.md b/marked/Rel-16/28_series/28753/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a1f5dd9f32d6193178a73b198de50db2277206ac --- /dev/null +++ b/marked/Rel-16/28_series/28753/raw.md @@ -0,0 +1,1769 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------|----------| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Solution Set Definitions ..... | 6 | +| <b>Annex A (normative): XML Definitions.....</b> | <b>7</b> | +| A.0 General..... | 7 | +| A.1 Architectural features..... | 7 | +| A.1.0 Introduction ..... | 7 | +| A.1.1 Syntax for Distinguished Names..... | 7 | +| A.2 Mapping ..... | 7 | +| A.2.1 General mapping ..... | 7 | +| A.2.2 Information Object Class (IOC) mapping ..... | 7 | +| A.3 Solution Set definitions ..... | 8 | +| A.3.1 XML definition structure ..... | 8 | +| A.3.2 Graphical Representation ..... | 8 | +| A.3.3 XML schema "sumNrm.xsd" ..... | 9 | +| Annex B (informative): Change history..... | 28 | + +# Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# Introduction + +The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: + +- TS 32.140: Subscription Management (SuM) requirements. +- TS 32.141: Subscription Management (SuM) architecture. +- TS 28.751: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements. +- TS 28.752: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS). +- TS 28.753: Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions.** + +Subscription Management (SuM) is a feature that permits Service Providers, Value Added Service Providers and Mobile Operators to provision services for a specific subscriber. The feature is necessary to allow Service Providers and Operators to provision, control, monitor, and bill the configuration of services that they offer to their subscribers. SuM focuses on the OAM processes to manage subscription information. The overall SuM requirements and architecture are detailed in 3GPP TS 32.140 [2] and 3GPP TS 32.141 [3]. + +# 1 Scope + +The present document is part of an Integration Reference Point (IRP) named Subscription Management (SuM) Network Resource Model (NRM) IRP, through which an IRPAgent can communicate configuration management information to one or several IRPManagers concerning SuM resources. The SuM NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s). + +The present document specifies the Solution Sets for the SuM NRM IRP. + +This specification is related to 3GPP TS 28.752 V14.0.X [5]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". +- [2] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements". +- [3] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) architecture". +- [4] 3GPP TS 28.751: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements". +- [5] 3GPP TS 28.752: "Telecommunication management; Subscription Management Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)". +- [6] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements". +- [7] 3GPP TS 32.102: "Telecommunication management; Architecture". +- [8] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions". +- [9] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects". +- [10] W3C REC-xml11-20060816: "Extensible Markup Language (XML) 1.1 (Second Edition)". +- [11] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures. +- [12] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes. +- [13] W3C REC-xml-names-20060816: "Namespaces in XML 1.1 (Second Edition)". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions in 3GPP TS 32.101 [6], TS 32.102 [7], TS 32.140 [2], TS 32.141 [3], TS 28.751 [4] and TS 28.752 [5] apply. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations in 3GPP TS 32.101 [6], TS 32.102 [7], TS 32.140 [2], TS 32.141 [3], TS 28.751 [4] and TS 28.752 [5] apply. + +# 4 Solution Set Definitions + +This specification defines the following 3GPP SuM NRM IRP Solution Set Definitions: + +- 3GPP SuM NRM IRP XML Definitions (Annex A) + +CORBA Solution Set is not supported. + +# Annex A (normative): XML Definitions + +## A.0 General + +This annex contains the XML Definitions for the SuM NRM IRP as it applies to Itf-N, in accordance with SuM NRM IRP Information Service (TS 28.752 [5]) . + +The XML file formats are based on XML [10], XML Schema [11] [12] and XML Namespace [13] standards. + +## A.1 Architectural features + +### A.1.0 Introduction + +The overall architectural feature of Subscription Management (SuM) NRM is specified in 3GPP TS 28.752 [5]. This clause specifies features that are specific to the Schema definitions. + +### A.1.1 Syntax for Distinguished Names + +The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [9]. + +## A.2 Mapping + +### A.2.1 General mapping + +An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS. + +### A.2.2 Information Object Class (IOC) mapping + +The mapping is not present in the current version of this specification. + +## A.3 Solution Set definitions + +### A.3.1 XML definition structure + +The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [8]. + +Annex A.3.3 of the present document defines the NRM-specific XML schema `sumNrm.xsd` for the Subscription Management IRP NRM defined in 3GPP TS 28.752 [5]. + +XML schema `sumNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM. + +The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [8]. + +### A.3.2 Graphical Representation + +The graphical representation is not present in the current version of this specification. + +### A.3.3 XML schema "sumNrm.xsd" + +``` +<?xml version="1.1" encoding="UTF-8"?> + +<!-- + 3GPP TS 28.753 SuM Network Resource Model IRP + SuM NRM-specific XML schema + sumNrm.xsd +--> + +<schema + targetNamespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.753#sumNrm" + elementFormDefault="qualified" + xmlns="http://www.w3.org/2001/XMLSchema" + xmlns:sn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.753#sumNrm" + xmlns:xn= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm" +> + + <import + namespace= + "http://www.3gpp.org/ftp/specs/archive/28_series/28.753#genericNrm" + /> + + <!-- SuM Network Resources IRP NRM class associated XML elements --> + + <element + name="SubscriptionFunction" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" + > + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="userLabel"/> + <element name="vnfParametersList" type="xn:vnfParametersListType" minOccurs="0"/> + <element name="theUser" type="xn:dnList"/> + <element name="theSubscriberProfile" type="xn:dnList"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + <element name="SuMSubscriberProfile" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="suMSubscriberProfileInfo"/> + <element name="theUser" type="xn:dnList"/> + <element name="theSubscribedService" type="xn:dnList"/> + <element name="theMobileUserData" type="xn:dnList"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> + </element> + <element name="MobileUserData" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> +``` + +``` + + <element name="theServiceProfile" type="xn:dnList"/> + <element name="iMSI" type="string"/> + <element name="mSISDN" type="string"/> + <element name="multinumberingMSISDNs" type="sn:multinumberingMSISDNList"/> + <element name="iMEISV" type="string" minOccurs="0"/> + </all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="SuMUser" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theMobileUserData" type="xn:dnList"/> + <element name="theSubscriber" type="xn:dnList" minOccurs="0"/> + <element name="theCredentials" type="xn:dnList"/> + <element name="theServiceProfile" type="xn:dnList"/> + <element name="theIdentity" type="xn:dnList" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SuMCredentials" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="thePublicId" type="xn:dnList"/> + <element name="theServiceProfile" type="xn:dnList"/> + <element name="iMSPrivateUserIdentity" type="string"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SuMService" type="xn:NrmClass" abstract="true" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"/> + +<element + name="CSService" + substitutionGroup="sn:SuMService" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theContract" minOccurs="0"/> + <element name="networkAccessMode"/> + <element name="basicMSISDNIndicator" minOccurs="0"/> + <element name="mSISDNAlertIndicator" minOccurs="0"/> + <element name="subscriptionRestriction" minOccurs="0"/> + <element name="rSZIlists" minOccurs="0"/> + <element name="lSAIdentity" minOccurs="0"/> + <element name="lSAPriority" minOccurs="0"/> + <element name="lSAPreferentialAccessIndicator" minOccurs="0"/> + +``` + +``` +<element name="LSAActiveModeSupportIndicator" minOccurs="0"/> +<element name="LSAOnlyAccessIndicator" minOccurs="0"/> +<element name="LSAActiveModeIndicator" minOccurs="0"/> +<element name="vPLMNIdentifier" minOccurs="0"/> +<element name="accessRestrictionData" minOccurs="0"/> +<element name="privacyExceptionList" minOccurs="0"/> +<element name="gMLCNumbers" minOccurs="0"/> +<element name="mOLRLList" minOccurs="0"/> +<element name="serviceTypes" minOccurs="0"/> +<element name="mobileStationCategory" minOccurs="0"/> +<element name="lMUIIdentifier" minOccurs="0"/> +<element name="subscriberStatus" minOccurs="0"/> +<element name="gsmSCFaddresslistForODB"/> +<element name="provisionOfBearerService"/> +<element name="provisionOfTeleservice"/> +<element name="bCAllocation" minOccurs="0"/> +<element name="barringOfOutgoingCalls" minOccurs="0"/> +<element name="barringOfIncomingCalls" minOccurs="0"/> +<element name="barringOfRoaming" minOccurs="0"/> +<element name="barringOfPremiumRateCalls" minOccurs="0"/> +<element + name="barringOfSupplementaryServiceManagement" + minOccurs="0" +/> +<element + name="barringOfRegistrationOfCallForwarding" + minOccurs="0" +/> +<element + name="barringOfInvocationOfCallTransfer" + minOccurs="0" +/> +<element + name="operatorDeterminedBarringPLMNSpecificData" + minOccurs="0" +/> +<element name="vGCSGroupMembershipList" minOccurs="0"/> +<element name="vBSGroupMembershipList" minOccurs="0"/> +<element + name="broadcastCallInitiationAllowedList" + minOccurs="0" +/> +<element + name="originatingCAMELSubscriptionInformationOCSI" + minOccurs="0" +/> +<element + name="terminatingCAMELSubscriptionInformationTCSI" + minOccurs="0" +/> +<element + name="vMSCTerminatingCAMELSubscriptionInformationVTCSI" + minOccurs="0" +/> +<element + name="locationInformationSubscriberStateInformation" + minOccurs="0" +/> +<element + name="uSSDCAMELSubscriptionInformationUCSI" + minOccurs="0" +/> +<element name="sSInvocationNotificationSSCSI" minOccurs="0"/> +<element + name="translationInformationFlagTIFCSI" + minOccurs="0" +/> +<element + name="dialledServiceCAMELSubscriptionInformationDCSI" + minOccurs="0" +/> +<element + name="uSSDGeneralCAMELServiceInformationUGCSI" + minOccurs="0" +/> +<element + name="shortMessageServiceCAMELSubscriptionInformationMOSMSCSI" + minOccurs="0" +/> +<element +``` + +``` + + name="shortMessageServiceCAMELSubscriptionInformationMTSMSCSI" + minOccurs="0" + /> + <element + name="mTSMSCSIVLRNegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element name="gsmSCFaddressforCSI" minOccurs="0"/> + <element name="iSTAlertTimer" minOccurs="0"/> + <element name="cSAllocationRetentionPriority" minOccurs="0"/> + <element name="iCSIIndicator" minOccurs="0"/> + <element name="theCSSupplServiceForCS" type="xn:dnList"/> + </all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="SuMCSSupplService" + substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="sS-Code"/> + <element name="provisioningState"/> + <element name="activationState"/> + <element name="registrationState" minOccurs="0"/> + <element name="overrideCategory" minOccurs="0"/> + <element name="CLIRestrictionOption" minOccurs="0"/> + <element name="forwarded-toNumber" minOccurs="0"/> + <element name="forwarded-toSubaddress" minOccurs="0"/> + <element name="noReplyConditionTimer" minOccurs="0"/> + <element name="maximumEntitledPriority" minOccurs="0"/> + <element name="defaultPriority" minOccurs="0"/> + <element name="nbrUser" minOccurs="0"/> + <element name="nbrSB" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element + name="GPRSService" + substitutionGroup="sn:SuMService" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theContract" minOccurs="0"/> + <element name="networkAccessMode" minOccurs="0"/> + <element name="basicMSISDNIndicator" minOccurs="0"/> + <element name="mSISDNAlertIndicator" minOccurs="0"/> + <element name="rSZIlists" minOccurs="0"/> + <element name="lSAIdentity" minOccurs="0"/> + <element name="lSAPriority" minOccurs="0"/> + <element name="lSAPreferentialAccessIndicator" minOccurs="0"/> + <element name="lSAActiveModeSupportIndicator" minOccurs="0"/> + <element name="lSAOnlyAccessIndicator" minOccurs="0"/> + <element name="lSAActiveModeIndicator" minOccurs="0"/> + <element name="vPLMNIdentifier" minOccurs="0"/> + <element name="accessRestrictionData" minOccurs="0"/> + <element name="privacyExceptionList" minOccurs="0"/> + <element name="gMLCNumbers" minOccurs="0"/> + <element name="mOLRList" minOccurs="0"/> + <element name="serviceTypes" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +``` + +``` +<element name="gGSNNumber" minOccurs="0"/> +<element name="provisionofTeleservice" minOccurs="0"/> +<element name="subscriberStatus" minOccurs="0"/> +<element name="transferofSMoption" minOccurs="0"/> +<element + name="barringofPacketOrientedServices" + minOccurs="0" +/> +<element name="pDPType" minOccurs="0"/> +<element name="pDPAddress" minOccurs="0"/> +<element name="accessPointName" minOccurs="0"/> +<element name="vPLMNAddressAllowed" minOccurs="0"/> +<element name="qualityofServiceSubscribed" minOccurs="0"/> +<element + name="pDPContextChargingCharacteristics" + minOccurs="0" +/> +<element + name="gPRSCAMELSubscriptionInformationGPRSCSI" + minOccurs="0" +/> +<element + name="mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI" + minOccurs="0" +/> +<element + name="mTShortMessageServiceCAMELSubscriptionInformationMTSMSCSI" + minOccurs="0" +/> +<element + name="mOSMSCSISGSNNegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="mTSMSCSISGSNNegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="mobilityManagementforGPRSeventnotificationMGCSI" + minOccurs="0" +/> +<element + name="mGCSINegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element name="gsmSCFaddressforCSI" minOccurs="0"/> +<element + name="subscribedChargingCharacteristics" + minOccurs="0" +/> +<element name="closedSubscriberGroupInformation" minOccurs="0"/> +<element name="gSMSCFaddresslistForODB" minOccurs="0"/> +<element name="barringOfOutgoingCalls" minOccurs="0"/> +<element name="barringOfRoaming" minOccurs="0"/> +<element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/> +<element name="sTNSR" minOccurs="0"/> +<element name="iCSIIndicator" minOccurs="0"/> +<element + name="listofauthorizedvisitednetworkidentifiers" + minOccurs="0" +/> +<element name="wLANUERemoteIPaddress" minOccurs="0"/> +<element name="staticWLANUERemoteIPaddressList" minOccurs="0"/> +<element name="w-APNBarringTypeList" minOccurs="0"/> +<element name="w-APNChargingDataList" minOccurs="0"/> +<element name="accessDependenceFlag" minOccurs="0"/> +<element name="chargingCharacteristics" minOccurs="0"/> +<element name="primaryOCSChargingFunctionName" minOccurs="0"/> +<element + name="secondaryOCSChargingFunctionName" + minOccurs="0" +/> +<element + name="primaryChargingCollectionFunctionName" + minOccurs="0" +/> +<element + name="secondaryChargingCollectionFunctionName" + minOccurs="0" +/> +``` + +``` + + <element name="w-APNIdentifierList" minOccurs="0"/> + <element name="maxNumberAccessesList" minOccurs="0"/> + <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/> + <element name="maxSubscribedBandwidth" minOccurs="0"/> + <element name="theGPRSSupplServiceForGPRS" type="xn:dnList"/> + </all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="SuMGPRSSupplService" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="sS-Code" minOccurs="0"/> + <element name="provisioningState" minOccurs="0"/> + <element name="activationState" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="EPSService" substitutionGroup="sn:SuMService"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theContract" minOccurs="0"/> + <element name="accessPointName" minOccurs="0"/> + <element name="accessRestrictionData" minOccurs="0"/> + <element name="aPNAMBR" minOccurs="0"/> + <element name="barringOfPacketOrientedServices" minOccurs="0"/> + <element name="contextIdentifier" minOccurs="0"/> + <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/> + <element name="pDNAddress" minOccurs="0"/> + <element name="rSZILists" minOccurs="0"/> + <element name="sTNSR" minOccurs="0"/> + <element name="subscribedChargingCharacteristics" minOccurs="0"/> + <element name="subscriberStatus" minOccurs="0"/> + <element name="networkAccessMode" minOccurs="0"/> + <element name="barringOfOutgoingCalls" minOccurs="0"/> + <element name="barringOfRoaming" minOccurs="0"/> + <element name="privacyExceptionList" minOccurs="0"/> + <element name="gMLCNumbers" minOccurs="0"/> + <element name="mOLRList" minOccurs="0"/> + <element name="serviceTypes" minOccurs="0"/> + <element name="iCSIndicator" minOccurs="0"/> + <element name="aPNOIReplacement" minOccurs="0"/> + <element name="subscribedUEAMBR" minOccurs="0"/> + <element name="aPNConfigurationProfile" minOccurs="0"/> + <element name="rFSP" minOccurs="0"/> + <element name="vPLMNAddressAllowed-EPS" minOccurs="0"/> + <element name="pDNGWIdentity" minOccurs="0"/> + <element name="ePSPDNConnectedChargingCharacteristics" minOccurs="0"/> + <element name="pDNGWAllocationType" minOccurs="0"/> + <element name="aPNLevelAPNOIReplacement" minOccurs="0"/> + <element name="closedSubscriberUserGroupInformation" minOccurs="0"/> + <element name="listofAuthorizedvisitednetowrkidentifiers" minOccurs="0"/> + <element name="staticWLANUERemoteIPAddressList" minOccurs="0"/> + <element name="w-APONBarringTypeList" minOccurs="0"/> + <element name="w-APNChargingDataList" minOccurs="0"/> + <element name="wLANUERemoteIPAddress" minOccurs="0"/> + <element name="accessDependenceFlag" minOccurs="0"/> + <element name="chargingCharacteristics" minOccurs="0"/> + <element name="primaryOCSChargingFunctionName" minOccurs="0"/> + +``` + +``` + + <element name="secondaryOCSChargingFunctionName" minOccurs="0"/> + <element name="primaryChargingCollectionFunctionName" minOccurs="0"/> + <element name="secondaryChargingCollectionFunctionName" minOccurs="0"/> + <element name="w-APNIdentifierList" minOccurs="0"/> + <element name="maxNumberAccessesList" minOccurs="0"/> + <element name="maxSubscribedBandwidth" minOccurs="0"/> + <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/> + <element name="permanentUserIdentity" minOccurs="0"/> + <element name="mIPSubscriberProfile" minOccurs="0"/> + </all> + </complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="IMSService" + substitutionGroup="sn:SuMService" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theContract" minOccurs="0"/> + <element + name="listofauthorizedvisitednetworkidentifiers"/> + <element name="registrationStatus"/> + <element name="sCSCFName" minOccurs="0"/> + <element name="diameterClientAddressofSCSCF" minOccurs="0"/> + <element name="theServerCapabilities" type="xn:dn" minOccurs="0"/> + <element + name="subscribedMediaProfileIdentifier" + minOccurs="0" + /> + <element name="initialFilterCriteriaList" minOccurs="0"> + <complexType> + <sequence> + <element name="initialFilterCriteria" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + <element name="applicationServerInformation" minOccurs="0"/> + <element name="serviceIndicationList" minOccurs="0"> + <complexType> + <sequence> + <element name="serviceIndication" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + <element + name="primaryEventChargingFunctionName" + minOccurs="0" + /> + <element + name="secondaryEventChargingFunctionName" + minOccurs="0" + /> + <element name="primaryChargingCollectionFunctionName"/> + <element + name="secondaryChargingCollectionFunctionName" + minOccurs="0" + /> + <element name="gsmSCFaddressforIMCSI" minOccurs="0"/> + <element name="oIMCSI" minOccurs="0"/> + <element name="vTIMCSI" minOccurs="0"/> + <element name="dIMCS" minOccurs="0"/> + <element name="gAAServiceType" minOccurs="0"/> + <element name="gAAServiceIdentifier" minOccurs="0"/> + <element name="gBAUserSecuritySettings" minOccurs="0"/> + <element name="userSecuritySetting" minOccurs="0"/> + <element name="userPublicIdentity" minOccurs="0"/> + <element name="gAAAuthorizationflag" minOccurs="0"/> + <element name="keyLifetime" minOccurs="0"/> + <element name="uICCSecurityType" minOccurs="0"/> + +``` + +``` +<element name="nAFGroupIdentity" minOccurs="0"/> +</all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="SuMSubscribedService" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" type="xn:NrmClass" +abstract="true"/> + +<element +name="CSSubscribedService" +substitutionGroup="sn:SuMSubscribedService" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theService" minOccurs="0"/> + <element name="theOffer" minOccurs="0"/> + <element name="networkAccessMode"/> + <element name="basicMSISDNIndicator" minOccurs="0"/> + <element name="mSISDNAlertIndicator" minOccurs="0"/> + <element name="subscriptionRestriction" minOccurs="0"/> + <element name="rSZIlists" minOccurs="0"/> + <element name="LSAIdentity" minOccurs="0"/> + <element name="LSAPriority" minOccurs="0"/> + <element name="LSAPreferentialAccessIndicator" minOccurs="0"/> + <element name="LSAActiveModeSupportIndicator" minOccurs="0"/> + <element name="LSAOnlyAccessIndicator" minOccurs="0"/> + <element name="LSAActiveModeIndicator" minOccurs="0"/> + <element name="vPLMNIdentifier" minOccurs="0"/> + <element name="accessRestrictionData" minOccurs="0"/> + <element name="privacyExceptionList" minOccurs="0"/> + <element name="gMLCNumbers" minOccurs="0"/> + <element name="mOLRList" minOccurs="0"/> + <element name="serviceTypes" minOccurs="0"/> + <element name="mobileStationCategory" minOccurs="0"/> + <element name="lMUIdentifier" minOccurs="0"/> + <element name="subscriberStatus" minOccurs="0"/> + <element name="gsmSCFaddresslistForODB"/> + <element name="provisionOfBearerService"/> + <element name="provisionOfTeleservice"/> + <element name="bCAllocation" minOccurs="0"/> + <element name="barringOfOutgoingCalls" minOccurs="0"/> + <element name="barringOfIncomingCalls" minOccurs="0"/> + <element name="barringOfRoaming" minOccurs="0"/> + <element name="barringOfPremiumRateCalls" minOccurs="0"/> + <element +name="barringOfSupplementaryServiceManagement" +minOccurs="0" +/> + <element +name="barringOfRegistrationOfCallForwarding" +minOccurs="0" +/> + <element +name="barringOfInvocationOfCallTransfer" +minOccurs="0" +/> + <element +name="operatorDeterminedBarringPLMNSpecificData" +minOccurs="0" +/> + <element name="vGCSGroupMembershipList" minOccurs="0"/> + <element name="vBSGroupMembershipList" minOccurs="0"/> + <element +name="broadcastCallInitiationAllowedList" +minOccurs="0" +/> + <element +name="originatingCAMELSubscriptionInformationOCSI" +minOccurs="0" +/> + +``` + +``` + + /> + <element + name="terminatingCAMELSubscriptionInformationTCSI" + minOccurs="0" + /> + <element + name="vMSCTerminatingCAMELSubscriptionInformationVTCSI" + minOccurs="0" + /> + <element + name="locationInformationSubscriberStateInformation" + minOccurs="0" + /> + <element + name="uSSDCAMELSubscriptionInformationUCSI" + minOccurs="0" + /> + <element name="sSInvocationNotificationSSCSI" minOccurs="0"/> + <element + name="translationInformationFlagTIFCSI" + minOccurs="0" + /> + <element + name="dialledServiceCAMELSubscriptionInformationDCSI" + minOccurs="0" + /> + <element + name="uSSDGeneralCAMELServiceInformationUGCSI" + minOccurs="0" + /> + <element + name="shortMessageServiceCAMELSubscriptionInformationMOSMSCSI" + minOccurs="0" + /> + <element + name="shortMessageServiceCAMELSubscriptionInformationMTMSCSI" + minOccurs="0" + /> + <element + name="mTSMSCSIVLRNegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element name="gsmSCFaddressforCSI" minOccurs="0"/> + <element name="iSTAlertTimer" minOccurs="0"/> + <element name="cSAllocationRetentionpriority" minOccurs="0"/> + <element name="iCSIndicator" minOccurs="0"/> + <element name="theCSSupplServiceForCSSS" type="xn:dnList"/> + </all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="GPRSSubscribedService" + substitutionGroup="sn:SuMSubscribedService" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theService" minOccurs="0"/> + <element name="theOffer" minOccurs="0"/> + <element name="networkAccessMode" minOccurs="0"/> + <element name="basicMSISDNIndicator" minOccurs="0"/> + <element name="mSISDNAlertIndicator" minOccurs="0"/> + <element name="rSZIlists" minOccurs="0"/> + <element name="lSAIdentity" minOccurs="0"/> + <element name="lSAPriority" minOccurs="0"/> + <element name="lSAPreferentialAccessIndicator" minOccurs="0"/> + <element name="lSAActiveModeSupportIndicator" minOccurs="0"/> + <element name="lSAOnlyAccessIndicator" minOccurs="0"/> + <element name="lSAActiveModeIndicator" minOccurs="0"/> + <element name="vPLMNIdentifier" minOccurs="0"/> + +``` + +``` +<element name="accessRestrictionData" minOccurs="0"/> +<element name="privacyExceptionList" minOccurs="0"/> +<element name="gMLCNumbers" minOccurs="0"/> +<element name="mOLRList" minOccurs="0"/> +<element name="serviceTypes" minOccurs="0"/> +<element name="gGSNNumber" minOccurs="0"/> +<element name="provisionofTeleservice" minOccurs="0"/> +<element name="subscriberStatus" minOccurs="0"/> +<element name="transferofSMoption" minOccurs="0"/> +<element + name="barringofPacketOrientedServices" + minOccurs="0" +/> +<element name="pDPType" minOccurs="0"/> +<element name="pDPAddress" minOccurs="0"/> +<element name="accessPointName" minOccurs="0"/> +<element name="vPLMNAddressAllowed" minOccurs="0"/> +<element name="qualityofServiceSubscribed" minOccurs="0"/> +<element + name="pDPContextChargingCharacteristics" + minOccurs="0" +/> +<element + name="gPRSCAMELSubscriptionInformationGPRSCSI" + minOccurs="0" +/> +<element + name="mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI" + minOccurs="0" +/> +<element + name="mTShortMessageServiceCAMELSubscriptionInformationMTMSCSI" + minOccurs="0" +/> +<element + name="mOSMSCSISGSNNegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="mTSMSCSISGSNNegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="mobilityManagementforGPRSeventnotificationMGCSI" + minOccurs="0" +/> +<element + name="mGCSINegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element name="gsmSCFaddressforCSI" minOccurs="0"/> +<element name="closedSubscriberGroupInformation" minOccurs="0"/> +<element name="gSMSCFaddresslistForODB" minOccurs="0"/> +<element name="barringOfOutgoingCalls" minOccurs="0"/> +<element name="barringOfRoaming" minOccurs="0"/> +<element name="operatorDeterminedBarringPLMNspectificData" minOccurs="0"/> +<element name="sTNSR" minOccurs="0"/> +<element name="iCSIndicator" minOccurs="0"/> +<element + name="subscribedChargingCharacteristics" + minOccurs="0" +/> +<element + name="listofauthorizedvisitednetworkidentifiers" + minOccurs="0" +/> +<element name="wLANUERemoteIPaddress" minOccurs="0"/> +<element name="staticWLANUERemoteIPaddressList" minOccurs="0"/> +<element name="w-APNBarringTypeList" minOccurs="0"/> +<element name="w-APNChargingDataList" minOccurs="0"/> +<element name="accessDependenceFlag" minOccurs="0"/> +<element name="chargingData" minOccurs="0"/> +<element name="chargingCharacteristics" minOccurs="0"/> +<element name="primaryOCSChargingFunctionName" minOccurs="0"/> +<element name="secondaryOCSChargingFunctionName" minOccurs="0"/> +<element name="w-APNIdentifierList" minOccurs="0"/> +<element name="maxNumberAccessesList" minOccurs="0"/> +<element name="maxSubscribedBandwidth" minOccurs="0"/> +<element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/> +<element +``` + +``` + name="primaryChargingCollectionFunctionName" + minOccurs="0" + /> + <element + name="secondaryChargingCollectionFunctionName" + minOccurs="0" + /> + <element name="theGPRSSupplServiceForGPRSSS" type="xn:dnList"/> +</all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="EPSSubscribedService" substitutionGroup="sn:SuMSubscribedService"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theService" minOccurs="0"/> + <element name="theOffer" minOccurs="0"/> + <element name="accessPointName" minOccurs="0"/> + <element name="accessRestrictionData" minOccurs="0"/> + <element name="aPNAMBR" minOccurs="0"/> + <element name="barringOfPacketOrientedServices" minOccurs="0"/> + <element name="contextIdentifier" minOccurs="0"/> + <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/> + <element name="pDNAddress" minOccurs="0"/> + <element name="rSZILists" minOccurs="0"/> + <element name="sTNSR" minOccurs="0"/> + <element name="subscribedChargingCharacteristics" minOccurs="0"/> + <element name="subscriberStatus" minOccurs="0"/> + <element name="networkAccessMode" minOccurs="0"/> + <element name="barringOfOutgoingCalls" minOccurs="0"/> + <element name="barringOfRoaming" minOccurs="0"/> + <element name="privacyExceptionList" minOccurs="0"/> + <element name="gMLCNumbers" minOccurs="0"/> + <element name="mOLRLList" minOccurs="0"/> + <element name="serviceTypes" minOccurs="0"/> + <element name="iCSIIndicator" minOccurs="0"/> + <element name="aPNOIReplacement" minOccurs="0"/> + <element name="subscribedUEAMBR" minOccurs="0"/> + <element name="aPNConfigurationProfile" minOccurs="0"/> + <element name="rFSP" minOccurs="0"/> + <element name="vPLMNAddressAllowed-EPS" minOccurs="0"/> + <element name="pDNGWIdentity" minOccurs="0"/> + <element name="ePSPDNConnectedChargingCharacteristics" minOccurs="0"/> + <element name="pDNGWAllocationType" minOccurs="0"/> + <element name="aPNLevelAPNOIReplacement" minOccurs="0"/> + <element name="closedSubscriberUserGroupInformation" minOccurs="0"/> + <element name="listOfAuthorizedvisitednetowrkidentifiers" minOccurs="0"/> + <element name="staticWLANUERemoteIPAddressList" minOccurs="0"/> + <element name="w-APONBarringTypeList" minOccurs="0"/> + <element name="w-APNChargingDataList" minOccurs="0"/> + <element name="wLANUERemoteIPAddress" minOccurs="0"/> + <element name="accessDependenceFlag" minOccurs="0"/> + <element name="chargingCharacteristics" minOccurs="0"/> + <element name="primaryOCSChargingFunctionName" minOccurs="0"/> + <element name="secondaryOCSChargingFunctionName" minOccurs="0"/> + <element name="primaryChargingCollectionFunctionName" minOccurs="0"/> + <element name="secondaryChargingCollectionFunctionName" minOccurs="0"/> + <element name="w-APNIdentifierList" minOccurs="0"/> + <element name="maxNumberAccessesList" minOccurs="0"/> + <element name="maxSubscribedBandwidth" minOccurs="0"/> + <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/> + <element name="permanentUserIdentity" minOccurs="0"/> + <element name="mIPSSubscriberProfile" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +``` + +``` +</element> + +<element + name="IMSSubscribedService" + substitutionGroup="sn:SuMSUBscribedService" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theService" minOccurs="0"/> + <element name="theOffer" minOccurs="0"/> + <element name="listofauthorizedvisitednetworkidentifiers"/> + <element name="registrationStatus"/> + <element name="sCSCFName" minOccurs="0"/> + <element name="diameterClientAddressofSCSCF" minOccurs="0"/> + <element name="theServerCapabilities" type="xn:dn" minOccurs="0"/> + <element + name="subscribedMediaProfileIdentifier" + minOccurs="0" + /> + <element name="initialFilterCriteriaList" minOccurs="0"> + <complexType> + <sequence> + <element name="initialFilterCriteria" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + <element name="applicationServerInformation" minOccurs="0"/> + <element name="serviceIndication" minOccurs="0"> + <complexType> + <sequence> + <element name="serviceIndication" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + <element + name="primaryEventChargingFunctionName" + minOccurs="0" + /> + <element + name="secondaryEventChargingFunctionName" + minOccurs="0" + /> + <element name="primaryChargingCollectionFunctionName"/> + <element + name="secondaryChargingCollectionFunctionName" + minOccurs="0" + /> + <element name="gsmSCFaddressforIMCSI" minOccurs="0"/> + <element name="oIMCSI" minOccurs="0"/> + <element name="vTIMCSI" minOccurs="0"/> + <element name="dIMCS" minOccurs="0"/> + <element name="gAAServiceType" minOccurs="0"/> + <element name="gAAServiceIdentifier" minOccurs="0"/> + <element name="gBAUserSecuritySettings" minOccurs="0"/> + <element name="userSecuritySetting" minOccurs="0"/> + <element name="userPublicIdentity" minOccurs="0"/> + <element name="gAAAuthorizationflag" minOccurs="0"/> + <element name="keyLifetime" minOccurs="0"/> + <element name="uICCSecurityType" minOccurs="0"/> + <element name="nAFGroupIdentity" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="SuMServiceProfile" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" +type="xn:NrmClass" abstract="true"/> + +<element + name="CSServiceProfile" +``` + +``` +substitutionGroup="sn:SuMServiceProfile" +> + <complexType> + <complexContent> + <extension base="sn:Common3GPPAccessServiceProfile"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theSpecification" minOccurs="0"/> + <element name="basicMSISDNIndicator" minOccurs="0"/> + <element name="mSISDNAlertIndicator" minOccurs="0"/> + <element name="vLRNumber"/> + <element name="mSCNumber"/> + <element name="subscriptionRestriction" minOccurs="0"/> + <element name="mSCAreaRestrictedFlag"/> + <element name="oDBinducedBarringData" minOccurs="0"/> + <element name="roamingRestrictionDueToUnsupportedFeature"/> + <element name="lSAIdentity" minOccurs="0"/> + <element name="lSAPriority" minOccurs="0"/> + <element name="lSAPreferentialAccessIndicator" minOccurs="0"/> + <element name="lSAActiveModeSupportIndicator" minOccurs="0"/> + <element name="lSAOnlyAccessIndicator" minOccurs="0"/> + <element name="lSAActiveModeIndicator" minOccurs="0"/> + <element name="vPLMNIdentifier" minOccurs="0"/> + <element name="ageIndicator" minOccurs="0"/> + <element name="lMSI"/> + <element name="mobileStationCategory"/> + <element name="lMUIdentifier" minOccurs="0"/> + <element name="mNRRMSC"/> + <element name="notificationToCSEFlagForODB" minOccurs="0"/> + <element name="gsmSCFaddresslistForODB" minOccurs="0"/> + <element name="messagesWaitingData" minOccurs="0"/> + <element name="mobileStationNotReachableFlag" minOccurs="0"/> + <element name="memoryCapacityExceededFlag"/> + <element name="traceReference" minOccurs="0"/> + <element name="traceType" minOccurs="0"/> + <element name="operationsSystemsIdentity" minOccurs="0"/> + <element name="hLRTraceType" minOccurs="0"/> + <element name="mAPErrorOnTrace" minOccurs="0"/> + <element name="traceActivatedInVLR" minOccurs="0"/> + <element name="provisionOfBearerService"/> + <element name="provisionOfTeleservice"/> + <element name="bCAllocation" minOccurs="0"/> + <element name="checkSSIndicator"/> + <element name="mSPurgedForNonGPRSFlag"/> + <element name="barringOfIncomingCalls" minOccurs="0"/> + <element name="barringOfPremiumRateCalls" minOccurs="0"/> + <element + name="barringOfSupplementaryServiceManagement" + minOccurs="0" + /> + <element + name="barringOfRegistrationOfCallForwarding" + minOccurs="0" + /> + <element + name="barringOfInvocationOfCallTransfer" + minOccurs="0" + /> + <element name="vGCSGroupMembershipList" minOccurs="0"/> + <element name="vBSGroupMembershipList" minOccurs="0"/> + <element + name="broadcastCallInitiationAllowedList" + minOccurs="0" + /> + <element + name="originatingCAMELSubscriptionInformationOCSI" + minOccurs="0" + /> + <element + name="terminatingCAMELSubscriptionInformationTCSI" + minOccurs="0" + /> + <element + name="vMSCTerminatingCAMELSubscriptionInformationVTCI" + minOccurs="0" + /> + <element + name="locationInformationSubscriberStateInformation" +``` + +``` + minOccurs="0" + /> + <element + name="uSSDCAMELSubscriptionInformationUCSI" + minOccurs="0" + /> + <element name="sSInvocationNotificationSSCSI" minOccurs="0"/> + <element + name="translationInformationFlagTIFCSI" + minOccurs="0" + /> + <element + name="dialledServiceCAMELSubscriptionInformationDCSI" + minOccurs="0" + /> + <element + name="uSSDGeneralCAMELServiceInformationUGCSI" + minOccurs="0" + /> + <element + name="oCSINegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element + name="sSSCINegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element + name="vTCINegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element + name="shortMessageServiceCAMELSubscriptionInformationMOSMSCSI" + minOccurs="0" + /> + <element + name="shortMessageServiceCAMELSubscriptionInformationMTSMSCSI" + minOccurs="0" + /> + <element + name="mOSMSCSIVLRNegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element + name="mTSMSCSIVLRNegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element + name="mCSINegotiatedCAMELCapabilityHandling" + minOccurs="0" + /> + <element name="vLRSupportedCAMELPhases" minOccurs="0"/> + <element name="gsmSCFaddressforCSI" minOccurs="0"/> + <element name="vLROfferedCAMEL4CSIs" minOccurs="0"/> + <element name="iSTAlertTimer" minOccurs="0"/> + <element name="cSAllocationRetentionpriority" minOccurs="0"/> + <element name="theCSSupplServiceForCSSP" type="xn:dnList"/> + </all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="GPRSServiceProfile" + substitutionGroup="sn:SuMServiceProfile" +> + <complexType> + <complexContent> + <extension base="sn:PSCommonServiceProfile"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theSpecification" minOccurs="0"/> + <element name="basicMSISDNIndicator" minOccurs="0"/> + <element name="mSISDNAlertIndicator" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> +``` + +``` + +<element name="vLRNumber" minOccurs="0"/> +<element name="lSAIdentity" minOccurs="0"/> +<element name="lSAPriority" minOccurs="0"/> +<element name="lSAPreferentialAccessIndicator" minOccurs="0"/> +<element name="lSAActiveModeSupportIndicator" minOccurs="0"/> +<element name="lSAOnlyAccessIndicator" minOccurs="0"/> +<element name="lSAActiveModeIndicator" minOccurs="0"/> +<element name="vPLMNIdentifier" minOccurs="0"/> +<element name="ageIndicator" minOccurs="0"/> +<element name="sGSNNumber" minOccurs="0"/> +<element name="gGSNNumber" minOccurs="0"/> +<element name="mNRC" minOccurs="0"/> +<element name="provisionofTeleservice" minOccurs="0"/> +<element name="transferofSMoption" minOccurs="0"/> +<element name="mSpurgedforGPRSflag" minOccurs="0"/> +<element name="pDPType" minOccurs="0"/> +<element name="pDPAddress" minOccurs="0"/> +<element name="vPLMNAddressAllowed" minOccurs="0"/> +<element name="gGSNlist" minOccurs="0"/> +<element name="qualityofServiceSubscribed" minOccurs="0"/> +<element name="pDPContextIdentifier" minOccurs="0"/> +<element + name="pDPContextChargingCharacteristics" + minOccurs="0" +/> +<element + name="gPRSCAMELSubscriptionInformationGPRSCSI" + minOccurs="0" +/> +<element + name="mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI" + minOccurs="0" +/> +<element + name="mTShortMessageServiceCAMELSubscriptionInformationMTSMSCSI" + minOccurs="0" +/> +<element + name="mOSMSCSISGSNNegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="mTSMSCSISGSNNegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="mobilityManagementforGPRSeventnotificationMGCSI" + minOccurs="0" +/> +<element + name="mGCSINegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element + name="gPRSCSINegotiatedCAMELCapabilityHandling" + minOccurs="0" +/> +<element name="sGSNSupportedCAMELPhases" minOccurs="0"/> +<element name="sGSNOfferedCAMEL4CSIs" minOccurs="0"/> +<element name="gsmSCFaddressforCSI" minOccurs="0"/> +<element name="gSMSCFaddresslistForODB" minOccurs="0"/> +<element name="iPSMGWNumber" minOccurs="0"/> +<element name="mNRR-SGSN" minOccurs="0"/> +<element name="notificationToCSEFlagForODB" minOccurs="0"/> +<element name="theGPRSSupplServiceForGPRSSP" type="xn:dnList"/> +</all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> +<element name="EPSServiceProfile" substitutionGroup="sn:SuMServiceProfile"> + <complexType> + <complexContent> + <extension base="sn:PSCommonServiceProfile"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + +``` + +``` + + <all> + <element name="theSpecification" minOccurs="0"/> + <element name="aPNAMBR" minOccurs="0"/> + <element name="contextIdentifier" minOccurs="0"/> + <element name="pDNAddress" minOccurs="0"/> + <element name="aPNOIReplacement" minOccurs="0"/> + <element name="subscribedUEAMBR" minOccurs="0"/> + <element name="aPNConfigurationProfile" minOccurs="0"/> + <element name="rFSP" minOccurs="0"/> + <element name="pDNGWIdentity" minOccurs="0"/> + <element name="ePSPDNConnectionChargingCharacteristics" minOccurs="0"/> + <element name="pDNGWAllocationType" minOccurs="0"/> + <element name="aPNLevelAPNOIReplacement" minOccurs="0"/> + <element name="roamingRestrictionsDueToUnsupportedFeatureMME" minOccurs="0"/> + <element name="roamingRestrictionsDueToUnsupportedFeatureSGSN" minOccurs="0"/> + <element name="mSPurgedForEPSFlag" minOccurs="0"/> + <element name="uRRPMME" minOccurs="0"/> + <element name="mMEName" minOccurs="0"/> + <element name="sGSNName" minOccurs="0"/> + <element name="iWFNumber" minOccurs="0"/> + <element name="sGSNAreaRestrictedFlag" minOccurs="0"/> + <element name="permanentUserIdentity" minOccurs="0"/> + <element name="vPLMNAddressAllowed-EPS" minOccurs="0"/> + <element name="theOptHandover3GPP2Par" type="xn:dn"/> + <element name="theNon3GPPAccessPar" type="xn:dn"/> + </all> + </complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="PSCommonServiceProfile" abstract="true" substitutionGroup="sn:SuMServiceProfile"> + <complexType> + <complexContent> + <extension base="sn:Common3GPPAccessServiceProfile"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="roamingRestrictedintheSGSNduetounsupportedfeature" minOccurs="0"/> + <element name="barringofPacketOrientedServices" minOccurs="0"/> + <element name="traceActivatedinSGSN" minOccurs="0"/> + <element name="iPAddressOfTraceCollectionEntity" minOccurs="0"/> + <element name="accessPointName" minOccurs="0"/> + <element name="subscribedChargingCharacteristics" minOccurs="0"/> + <element name="sTNSR" minOccurs="0"/> + <element name="closedSubscriberGroupInformation" minOccurs="0"/> + <element name="theIWANPar" type="xn:dn" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Common3GPPAccessServiceProfile" abstract="true" +substitutionGroup="sn:SuMServiceProfile"> + <complexType> + <complexContent> + <extension base="sn:SuMServiceProfile"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="rSZILists" minOccurs="0"/> + <element name="accessRestrictionData" minOccurs="0" /> + <element name="subscriberStatus" minOccurs="0"/> + <element name="barringOfOutgoingCalls" minOccurs="0"/> + <element name="barringOfRoaming" minOccurs="0"/> + <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/> + <element name="traceReference2" minOccurs="0"/> + <element name="traceDepth" minOccurs="0"/> + <element name="listOfNETypesToTrace" minOccurs="0"/> + <element name="triggeringEvents" minOccurs="0"/> + <element name="listOfInterfacesToTrace" minOccurs="0"/> + +``` + +``` +<element name="privacyExceptionList" minOccurs="0"/> +<element name="gMLCNumbers" minOccurs="0"/> +<element name="iCSIndicator" minOccurs="0"/> +<element name="mOLRList" minOccurs="0"/> +<element name="serviceTypes" minOccurs="0"/> +<element name="networkAccessMode" minOccurs="0"/> +</all> +</complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element name="IWANParameters" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="w-APN" minOccurs="0"/> + <element name="listofauthorizedvisitednetworkidentifiers" minOccurs="0"/> + <element name="threeGPPAAAServerName" minOccurs="0" /> + <element name="threeGPPAAProxyName" minOccurs="0"/> + <element name="wLANUERemoteIPAddress" minOccurs="0"/> + <element name="statisWLANUERemoteIPAddressList" minOccurs="0"/> + <element name="w-APNBarringTypeList" minOccurs="0"/> + <element name="w-APNChargingDataList" minOccurs="0"/> + <element name="accessDependenceFlag" minOccurs="0"/> + <element name="i-WLANAccessType" minOccurs="0"/> + <element name="wLANIdentifierList" minOccurs="0"/> + <element name="maxNumberAccessesList" minOccurs="0"/> + <element name="maxSubscribedBandwidth" minOccurs="0"/> + <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/> + <element name="chargingCharacteristics" minOccurs="0"/> + <element name="primaryOCSChargingFunctionName" minOccurs="0"/> + <element name="secondaryOCSChargingFunctionName" minOccurs="0"/> + <element name="primaryChargingCollectionFunctionName" minOccurs="0"/> + <element name="secondaryChargingCollectionFunctionName" minOccurs="0"/> + <element name="userStatus" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="OptHandover3GPP2Parameters" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="rATType" minOccurs="0"/> + </all> + </complexType> + </element> + </sequence> + </extension> + </complexContent> + </complexType> +</element> + +<element name="Non3GPPAccessParameters" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> +``` + +``` + + <all> + <element name="rATType" minOccurs="0"/> + <element name="visitedNetworkIdentifier" minOccurs="0"/> + <element name="mIPSubscriberProfile" minOccurs="0"/> + <element name="permanentUserIdentity" minOccurs="0"/> + </all> + </complexType> +</element> +</sequence> +</extension> +</complexContent> +</complexType> +</element> + +<element + name="IMSServiceProfile" + substitutionGroup="sn:SuMServiceProfile" +> + <complexType> + <complexContent> + <extension base="xn:NrmClass"> + <sequence> + <element name="attributes" minOccurs="0"> + <complexType> + <all> + <element name="theSpecification" minOccurs="0"/> + <element name="listofauthorizedvisitednetworkidentifiers"/> + <element name="registrationStatus"/> + <element name="sCSCFName" minOccurs="0"/> + <element name="diameterClientAddressofSCSCF" minOccurs="0"/> + <element name="theServerCapabilities" type="xn:dn" minOccurs="0"/> + <element + name="subscribedMediaProfileIdentifier" + minOccurs="0" + /> + <element name="initialFilterCriteriaList" minOccurs="0"> + <complexType> + <sequence> + <element name="initialFilterCriteria" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + <element name="applicationServerInformation" minOccurs="0"/> + <element name="serviceIndicationList" minOccurs="0"> + <complexType> + <sequence> + <element name="serviceIndication" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + <element + name="primaryEventChargingFunctionName" + minOccurs="0" + /> + <element + name="secondaryEventChargingFunctionName" + minOccurs="0" + /> + <element name="primaryChargingCollectionFunctionName"/> + <element + name="secondaryChargingCollectionFunctionName" + minOccurs="0" + /> + <element name="gsmSCFaddressforIMCSI" minOccurs="0"/> + <element name="iMSSFaddressforIMCSI" minOccurs="0"/> + <element name="oIMCSI" minOccurs="0"/> + <element name="vTIMCSI" minOccurs="0"/> + <element name="dIMCS" minOccurs="0"/> + <element name="gAAServiceType" minOccurs="0"/> + <element name="gAAServiceIdentifier" minOccurs="0"/> + <element name="gBAUserSecuritySettings" minOccurs="0"/> + <element name="userSecuritySetting" minOccurs="0"/> + <element name="userPublicIdentity" minOccurs="0"/> + <element name="gAAAuthorizationflag" minOccurs="0"/> + <element name="keyLifetime" minOccurs="0"/> + <element name="uICCSecurityType" minOccurs="0"/> + <element name="nAFGroupIdentity" minOccurs="0"/> + <element name="thePublicId" type="xn:dnList"/> + </all> + </complexType> + </element> + +``` + +``` + </element> + </sequence> + </extension> + </complexContent> +</complexType> +</element> + +<complexType name="IMSPublicIdentificationType"> + <complexContent> + <extension base="sn:SuMIdentityType"> + <all> + <element name="publicUserIdentity" type="string" minOccurs="0"/> + <element name="barringIndication" type="sn:binEnum" minOccurs="0"/> + </all> + </extension> + </complexContent> +</complexType> + +<element name="IMSPublicIdentification" type="sn:IMSPublicIdentificationType" +substitutionGroup="sn:SuMIdentity"/> + +<simpleType name="binEnum"> + <restriction base="string"> + <enumeration value="FALSE"/> + <enumeration value="TRUE"/> + </restriction> +</simpleType> + +<simpleType name="multinumberingMSISDNIndicator"> + <restriction base="string"> + <enumeration value="BASIC"/> + <enumeration value="ALERT"/> + </restriction> +</simpleType> + +<complexType name="multinumberingMSISDNList"> + <sequence minOccurs="0" maxOccurs="unbounded"> + <element name="mISDN" type="string"/> + <element name="indicator" type="sn:multinumberingMSISDNIndicator"/> + </sequence> +</complexType> + +<complexType name="ServerCapabilitiesType"> + <complexContent> + <extension base="sn:SuMServiceParameterType"> + <all> + <element name="serverCapabilities"/> + </all> + </extension> + </complexContent> +</complexType> + +<element name="ServerCapabilities" type="sn:ServerCapabilitiesType" +substitutionGroup="sn:SuMServiceParameter"/> + +<complexType name="SuMIdentityType"> + <complexContent> + <restriction base="xn:NrmClass"/> + </complexContent> +</complexType> + +<complexType name="SuMServiceParameterType"> + <complexContent> + <restriction base="xn:NrmClass"/> + </complexContent> +</complexType> + +<element name="SuMIdentity" type="sn:SuMIdentityType" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" abstract="true"/> + +<element name="SuMServiceParameter" type="sn:SuMServiceParameterType" +substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" abstract="true"/> + +</schema> +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2014-06 | SA#64 | SP-140332 | 0001 | - | F | Upgrade W3C XML Schema version from 1.0 to 1.1 | 11.1.0 | +| | | SP-140359 | 0002 | - | F | remove the feature support statements | 11.1.0 | +| 2014-09 | SA#65 | SP-140560 | 0003 | - | C | Update the link from Solution Set to Information Service due to the end of Release 12 | 12.0.0 | +| 2015-01 | | | | | | Update to Rel-13(MCC) | 13.0.0 | +| 2016-06 | SA#72 | SP-160407 | 0004 | - | F | Update the link from IRP Solution Set to IRP Information Service | 13.1.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2017-06 | SA#76 | SP-170502 | 0005 | - | F | Update the link from IRP Solution Set to IRP Information Service | 14.1.0 | +| 2017-06 | SA#76 | SP-170510 | 0006 | 1 | B | Update the XML Schema definitions to align with IS to support Configuration Management for mobile networks that include virtualized network functions | 14.1.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28803/6078636a87fbe0e699aab4a6fddd15d7_img.jpg b/marked/Rel-16/28_series/28803/6078636a87fbe0e699aab4a6fddd15d7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dd51a01c60e2360938fe6983ebdf9267fa62583b --- /dev/null +++ b/marked/Rel-16/28_series/28803/6078636a87fbe0e699aab4a6fddd15d7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18e4919a6567dc61a2891728da9908658823831923f0b710795117e30c4fcc8e +size 40586 diff --git a/marked/Rel-16/28_series/28803/99bae07626f60f9ede10e2e387ef7051_img.jpg b/marked/Rel-16/28_series/28803/99bae07626f60f9ede10e2e387ef7051_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..56b812c9a4602946999034d56a69d323c6646084 --- /dev/null +++ b/marked/Rel-16/28_series/28803/99bae07626f60f9ede10e2e387ef7051_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc30c97e5f862233a25669d20021d58fea60cb15e117291aecfbd01ef6120d22 +size 32157 diff --git a/marked/Rel-16/28_series/28803/b90144cfbb81a2d610d920240fda689d_img.jpg b/marked/Rel-16/28_series/28803/b90144cfbb81a2d610d920240fda689d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32de1b8d321ad1169d046c48e275e52ea52c76ec --- /dev/null +++ b/marked/Rel-16/28_series/28803/b90144cfbb81a2d610d920240fda689d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5214210df6a957819f6c70f7484789c907fe93fbb56f837b8e600a313784fa3 +size 41374 diff --git a/marked/Rel-16/28_series/28803/dbe553cf16dd14073b89a8263a428664_img.jpg b/marked/Rel-16/28_series/28803/dbe553cf16dd14073b89a8263a428664_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a3b3cbf8acc17eeac61db13375760ae14fe09a0 --- /dev/null +++ b/marked/Rel-16/28_series/28803/dbe553cf16dd14073b89a8263a428664_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd7821ede9b09e7286de02bb039c5556bcf8d0af214b66849ef89ef690758974 +size 63194 diff --git a/marked/Rel-16/28_series/28803/raw.md b/marked/Rel-16/28_series/28803/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d307aed9b040404f289a3d294e97081b21fa822e --- /dev/null +++ b/marked/Rel-16/28_series/28803/raw.md @@ -0,0 +1,637 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Concept and background..... | 8 | +| 4.1 Background ..... | 8 | +| 4.2 Edge computing deployment scenarios..... | 9 | +| 5 Use cases..... | 10 | +| 5.1 Deploy UPF to support edge computing ..... | 10 | +| 5.1.1 Introduction ..... | 10 | +| 5.1.2 Pre-conditions ..... | 10 | +| 5.1.3 Description ..... | 10 | +| 5.1.4 Post-conditions ..... | 10 | +| 5.2 Remove UPF not needed for edge computing ..... | 11 | +| 5.2.1 Introduction ..... | 11 | +| 5.2.2 Pre-conditions ..... | 11 | +| 5.2.3 Description ..... | 11 | +| 5.2.4 Post-conditions ..... | 11 | +| 5.3 Edge computing deployment..... | 11 | +| 5.3.1 Introduction ..... | 11 | +| 5.3.2 Pre-conditions ..... | 11 | +| 5.3.3 Description ..... | 11 | +| 5.3.4 Post-conditions ..... | 11 | +| 5.4 Available UPF to support edge computing ..... | 12 | +| 5.4.1 Introduction ..... | 12 | +| 5.4.2 Pre-conditions ..... | 12 | +| 5.4.3 Description ..... | 12 | +| 5.4.4 Post-conditions ..... | 12 | +| 5.5 Performance measurements related to end-to-end QoS ..... | 12 | +| 5.5.1 Introduction ..... | 12 | +| 5.5.2 Pre-conditions ..... | 12 | +| 5.5.3 Description ..... | 12 | +| 5.5.4 Post-conditions ..... | 13 | +| 5.6 NEF accessibility for EC..... | 13 | +| 5.6.1 Introduction ..... | 13 | +| 5.6.2 Pre-conditions ..... | 13 | +| 5.6.3 Description ..... | 13 | +| 5.6.4 Post-conditions ..... | 13 | +| 6 Potential requirements..... | 13 | +| 7 Potential solutions ..... | 14 | +| 7.1 UPF instantiation or termination to support edge computing ..... | 14 | +| 7.1.1 General ..... | 14 | +| 7.1.2 UPF instantiation ..... | 14 | +| 7.1.3 UPF termination ..... | 14 | +| 7.2 SMF configuration to support UE traffic routing..... | 15 | +| 7.2.1 General ..... | 15 | +| 7.2.2 SMF configuration for a new UPF ..... | 15 | +| 7.2.3 SMF configuration for removal from the UPF available list ..... | 15 | +| 7.3 NRF configuration to support UE traffic routing..... | 15 | +| 7.3.1 General ..... | 15 | +| 7.3.2 NRF configuration to obtain UPF information ..... | 15 | + +| | | | +|-----------------|--------------------------------------------------------------------|-----------| +| 7.3.3 | NRF receives UPF information from UPF instance ..... | 15 | +| 7.4 | UPF and edge computing VNFs deployment..... | 16 | +| 7.4.1 | General ..... | 16 | +| 7.4.2 | Deployment of UPF and edge computing VNFs in a NS..... | 16 | +| 7.4.3 | Deployment of UPF and edge computing VNFs in two separate NS ..... | 16 | +| 7.4.4 | Retrieval of the UPF information ..... | 17 | +| 7.5 | End-to-end performance assurance ..... | 18 | +| 7.5.1 | General ..... | 18 | +| 7.5.2 | Monitoring of the performance related to end-to-end QoS ..... | 18 | +| 7.6 | AF access to NEF ..... | 18 | +| 7.6.1 | General ..... | 18 | +| 7.6.2 | Provision of NEF IP address ..... | 18 | +| 8 | Conclusion ..... | 19 | +| <b>Annex A:</b> | <b>Change history .....</b> | <b>20</b> | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document studies how the 3GPP management system can support the management of edge computing management that includes the following aspects: + +- The use cases and requirements for 3GPP management system to support the deployment and management of edge computing. +- The solutions for 3GPP management system to support the deployment and management of edge computing. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] ETSI GS MEC 003 V1.1.1: "Mobile Edge Computing (MEC); Framework and Reference Architecture". +- [4] ETSI GS MEC 010-1 V1.1.1: "Mobile Edge Computing (MEC); Mobile Edge Management; Part 1: System, host and platform management". +- [5] ETSI GS MEC 010-2 V1.1.1: "Multi-access Edge Computing (MEC); MEC Management; Part 2: Application lifecycle, rules and requirements management". +- [6] 3GPP TR 23.725: "Study on enhancement of Ultra-Reliable Low-Latency Communication (URLLC) support in the 5G Core network (5GC)". +- [7] ETSI GS NFV-MAN 001 V1.1.1: "Network Function Virtualisation (NFV); Management and Orchestration". +- [8] ETSI GS NFV-IFA 013 "Network Functions Virtualisation (NFV) Release 3; Management and Orchestration; Os-Ma-Nfvo reference point - Interface and Information Model Specification" +- [9] 3GPP TS 28.531 "Management and orchestration; Provisioning". +- [10] 3GPP TS 28.541 "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [11] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [12] ETSI GR MEC 017 V1.0.0: "Mobile Edge Computing (MEC); Deployment of Mobile Edge Computing in an NFV environment". +- [13] ETSI GS NFV-IFA 014 "Network Functions Virtualisation (NFV) Release 2; Management and Orchestration; Network Service Templates Specification". +- [14] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [15] 3GPP TS 28.532: "Management and orchestration; Generic management services". + +[16] 3GPP TS 28.622: "Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +# 4 Concept and background + +## 4.1 Background + +The 5G networks are intended to support various new services such as IoT, Cloud-based services, industrial control, autonomous driving, mission critical communications, etc, based on the network slicing technology. Some services, e.g. autonomous driving, may have ultra-low latency and high data capacity requirements due to safety and performance concerns. 5GC system architecture as defined in TS 23.501 [2] supports edge computing to enable such services by applications that are hosted closer to the UE's access point of attachment in order to reduce the end-to-end latency and the load on the transport network. + +Figure 4.1-1 shows how 3GPP network elements work with non-3GPP network elements, such as AF (Application Function) and local data network to provide the services mentioned above [5], [6]. The AF may send requests to SMF (Session Management Function) via PCF (Policy Function) or NEF (Network Exposure Function) to influence UPF (User Plane Function) (re)selection and traffic routing. + +The end-to-end latency of the traffic traveling from UE to local data network includes the latency both inside and outside the 3GPP networks. The latency within the 3GPP networks is relevant to 5G QoS, as described in clause 5.7.3.1 in [2], which is the QoS a data flow receives edge-to-edge between the UE and the UPF. The latency outside the 3GPP networks is related to the geographical locations of UPF and local data network. Therefore, it is necessary to deploy the local data network and UPF in a manner that meets the end-to-end latency requirement of the services. + +![Diagram of 5G edge computing network architecture showing the flow from UE through RAN, UPF, SMF, PCF, and AF to a local data network.](6078636a87fbe0e699aab4a6fddd15d7_img.jpg) + +The diagram illustrates the 5G edge computing network architecture. It is divided into two main sections by a vertical dashed line: the **3GPP network** on the left and the **Non-3GPP access network** on the right. + +- 3GPP network components:** + - UE (User Equipment)** is connected to **RAN (Radio Access Network)**. + - RAN** is connected to **UPF (User Plane Function)** via the **N3** interface. + - UPF** is connected to **SMF (Session Management Function)** via the **N4** interface. + - SMF** is connected to **PCF (Policy Function)** via the **N7** interface. + - UPF** is also connected to **SMF** via the **N6** interface (labeled as **N9** in the diagram, likely a typo for N6). +- Non-3GPP access network components:** + - PCF** is connected to **AF (Application Function)** via the **N5** interface. + - AF** is connected to **Local data network** (represented by a cloud icon containing **Applications**) via the **N6** interface. + +A blue wavy line represents the data flow path: **UE** → **RAN** → **UPF** → **N9** → **Local data network**. + +Diagram of 5G edge computing network architecture showing the flow from UE through RAN, UPF, SMF, PCF, and AF to a local data network. + +Figure 4.1-1: 5G edge computing network + +The deployment of edge computing in 3GPP networks requires cooperation with other SDOs, as AF and AS are not 3GPP defined nodes. ETSI GS MEC 003 [3], ETSI GS MEC 010-1 [4], and ETSI GS MEC 010-2 [5] provides some information about non-3GPP edge computing management system. + +## 4.2 Edge computing deployment scenarios + +Figure 4.2-1 shows an example of edge computing deployment where gNB, 5GC and data centers, DC #1 - #4, DC #11 - #12 have been deployed. When an operator decides to deploy an edge computing application for UEs connected to gNB #1, it selects DC #2 to deploy UPF #2, and DC #11 to deploy local data network #1, based on the QoS requirements between UEs and local data network #1 that meets the end-to-end QoS requirements imposed by the application. It connects UPF#2 to local data network #1 via virtual link, as shown in Figure 4.2-1. + +![Figure 4.2-1: Edge computing network deployment example. The diagram shows two groups of gNBs. The top group is labeled 'gNB #1' and contains 8 gNB icons. One gNB is connected to a box labeled 'UPF #2' which is associated with 'DC #2'. 'UPF #2' is connected via a line to a box labeled 'Local data network #1' associated with 'DC #11'. Above 'UPF #2' is another box labeled 'UPF #1' associated with 'DC #1'. The bottom group contains 8 gNB icons. One gNB is connected to a box labeled 'UPF #3' associated with 'DC #3'. Another gNB is connected to a box labeled 'UPF #4' associated with 'DC #4'. 'UPF #3' is connected via a line to a box labeled 'Local data network #2' associated with 'DC #12'.](dbe553cf16dd14073b89a8263a428664_img.jpg) + +Figure 4.2-1: Edge computing network deployment example. The diagram shows two groups of gNBs. The top group is labeled 'gNB #1' and contains 8 gNB icons. One gNB is connected to a box labeled 'UPF #2' which is associated with 'DC #2'. 'UPF #2' is connected via a line to a box labeled 'Local data network #1' associated with 'DC #11'. Above 'UPF #2' is another box labeled 'UPF #1' associated with 'DC #1'. The bottom group contains 8 gNB icons. One gNB is connected to a box labeled 'UPF #3' associated with 'DC #3'. Another gNB is connected to a box labeled 'UPF #4' associated with 'DC #4'. 'UPF #3' is connected via a line to a box labeled 'Local data network #2' associated with 'DC #12'. + +**Figure 4.2-1: Edge computing network deployment example** + +The deployment of network functions in 3GPP networks and non-3GPP networks to support edge computing requires communication between 3GPP management system and non-3GPP management systems, such as ETSI NFV MANO [7], ETSI MEC [3]. + +Figure 4.2-2 shows a peer-to-peer edge computing management deployment scenario where the deployment of edge computing in 3GPP networks needs communication among 3GPP management system, non-3GPP management system, including edge computing management system, and ETSI NFV MANO. + +![Figure 4.2-2: Peer-to-peer edge computing management deployment scenario. The diagram shows a hierarchy of management systems. At the top is a box labeled 'Operations Support System'. Below it is a box labeled '3GPP management system'. To the right of the 'Operations Support System' is a large box labeled 'Non-3GPP management system'. Inside this box are two sub-boxes: 'ETSI NFV management and orchestration' and 'edge computing management system'. Lines connect the 'Operations Support System' to both the '3GPP management system' and the 'Non-3GPP management system'. The '3GPP management system' is also connected to the 'Non-3GPP management system'.](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +Figure 4.2-2: Peer-to-peer edge computing management deployment scenario. The diagram shows a hierarchy of management systems. At the top is a box labeled 'Operations Support System'. Below it is a box labeled '3GPP management system'. To the right of the 'Operations Support System' is a large box labeled 'Non-3GPP management system'. Inside this box are two sub-boxes: 'ETSI NFV management and orchestration' and 'edge computing management system'. Lines connect the 'Operations Support System' to both the '3GPP management system' and the 'Non-3GPP management system'. The '3GPP management system' is also connected to the 'Non-3GPP management system'. + +**Figure 4.2-2: Peer-to-peer edge computing management deployment scenario** + +3GPP management system can initiate the edge computing deployment by requesting the edge computing management system to deploy the local data network, and NFVO to connect the UPF and local data network with the QoS for N6 requirements for the connection (e.g. virtual link) between UPF and local data network. + +Edge computing management system can initiate the edge computing deployment by requesting the 3GPP management system to deploy the UPF, and NFVO to connect the UPF and local data network with the QoS requirements for the connection between UPF and local data network. + +# --- 5 Use cases + +## 5.1 Deploy UPF to support edge computing + +### 5.1.1 Introduction + +An operator decides to deploy UPFs to support edge computing applications for UEs in a specific area. The UPFs should be deployed in locations where the data transported between UE and UPF should meet the 5G QoS requirements (see clause 5.7.3.1 [2]). + +### 5.1.2 Pre-conditions + +3GPP management system is aware of the 5G QoS requirements needed to support edge computing applications. + +It is to deploy the UPF software only. + +### 5.1.3 Description + +3GPP management system requests NFVO to instantiate the UPF with conditions (e.g. location constraints). + +NFVO responds that the UPF has been instantiated successfully. + +3GPP management system configures SMF or NRF to add the newly instantiated UPF and may configure other NFs needed to support edge computing. + +### 5.1.4 Post-conditions + +The UPF is available to support the edge computing application. + +## 5.2 Remove UPF not needed for edge computing + +### 5.2.1 Introduction + +An operator decides to remove UPF that is no longer needed to support edge computing applications. + +### 5.2.2 Pre-conditions + +UPF supporting edge computing application has been instantiated. + +### 5.2.3 Description + +3GPP management system requests NFVO to terminate the UPF. + +NFVO responds that the UPF has been terminated successfully. + +3GPP management system configures SMF to remove the UPF that has been terminated. + +### 5.2.4 Post-conditions + +The UPF is not available to support the edge computing application. + +## 5.3 Edge computing deployment + +### 5.3.1 Introduction + +An operator decides to deploy the edge computing related resources in the local data network to support edge computing. The edge computing related resources should be deployed in locations where the data transported between UPF and edge computing related resources in the local data network should meet the QoS requirements for N6 interface. + +### 5.3.2 Pre-conditions + +3GPP management system has the QoS requirements for N6 interface. + +The UPF supporting the edge computing application, has been instantiated. + +### 5.3.3 Description + +3GPP management system provides to the edge computing management system the QoS requirements for N6 interface, and UPF location information that can be used to deploy the edge computing related resources in the local data network. + +Edge computing management system selects the data center to deploy the edge computing related resources in the local data network, based on the QoS requirements and UPF location. + +Edge computing management system responds to 3GPP management system indicating that the edge computing related resources in the local data network has been deployed. + +3GPP management system requests NFVO to connect the UPF to the edge computing related resources in the local data network with the QoS requirements for N6 interface. + +### 5.3.4 Post-conditions + +UEs are able to communicate with the edge computing application running in the local data network. + +## 5.4 Available UPF to support edge computing + +### 5.4.1 Introduction + +An operator has deployed the resources needed to support edge computing in the local data network. The Edge computing management system needs to know the information of the UPFs deployed in locations where the data transported between UPF and the edge computing application in the local data network can meet the QoS requirements for the N6 interface. + +### 5.4.2 Pre-conditions + +Edge computing management system is aware of the QoS requirements on the N6 interface. + +### 5.4.3 Description + +Edge computing management system sends a request with the location of local data network and the QoS requirements for the N6 interface to ask 3GPP management system to provide the information of UPFs to which the edge computing related resources in the local data network can be connected. + +3GPP management system find the available UPFs that can meet the QoS requirements for the N6 interface in the given location. + +3GPP management system deploys new UPF(s) according to the steps described in use case 5.1.1, if the existing UPFs cannot meet the requirements. + +3GPP management system provides the information of UPF(s) to the edge computing management system. + +### 5.4.4 Post-conditions + +The information of UPF(s) have been sent to the edge computing management system. + +## 5.5 Performance measurements related to end-to-end QoS + +### 5.5.1 Introduction + +3GPP networks support edge computing to enable UEs to communicate with applications hosted in the local data network that are closer to the UE's access point of attachment in order to achieve an efficient service delivery through the reduced end-to-end latency and load on the transport network (see clause 5.13 in TS 28.501 [2]). Therefore, it is + +necessary to monitor the performance measurements (e.g. latency, data volume) for connections from UE to UPF and the N6 interface to insure the end-to-end QoS requirements are met. + +### 5.5.2 Pre-conditions + +3GPP network functions supporting the edge computing have been deployed. + +Edge computing related in local data network have been deployed. + +Edge computing applications have been deployed. + +### 5.5.3 Description + +3GPP management system collects the performance measurements (e.g. latency, data volume) for connections from UE to UPF and the N6 interface. + +3GPP management system reports the performance measurements related to end-to-end QoS to the authorized consumer (e.g. edge computing management system). + +### 5.5.4 Post-conditions + +The performance measurements have been reported to the authorized consumer (e.g. edge computing management system). + +## 5.6 NEF accessibility for EC + +### 5.6.1 Introduction + +In EC, an AF may send requests to 5GC to influence SMF routing decisions for traffic of PDU Session. The AF may issue requests on behalf of applications not owned by the PLMN serving the UE. + +The AF sends the requests via the NEF (see in clause 5.6.7 and 6.3.7.2 of TS 23.501 [2]) in case: + +- the AF is not authorized to access the 5GC directly; or +- the requests target existing or future PDU Sessions of multiple UE(s) or of any UE. + +In this case, the AF may discover the NEF by using a locally configured NEF identifier/address. Therefore, edge computing management system needs to have the NEF information, so it can provide the IP address of NEF to AF via configuration. + +### 5.6.2 Pre-conditions + +5GC network functions are in operation to support edge computing. + +### 5.6.3 Description + +3GPP management system receives a request from an authorized consumer (e.g. edge computing management system) to provide the connection information (e.g. IP address) of the NEF to which the AF can communicate to influence traffic routing (see procedures described in clause 4.3.6 in TS 23.502 in [2]). + +3GPP management system provides the connection information (e.g. IP address) of the NEF to the authorized consumer. + +### 5.6.4 Post-conditions + +The connection information (e.g. IP address) of the NEF have been sent to the edge computing management system. + +# --- 6 Potential requirements + +**REQ-ECM\_CON-1** NFVO should have a capability allowing 3GPP management system to instantiate the VNF(s) with conditions (e.g. location constraints). + +**REQ-ECM\_CON-2** The 3GPP management system should have a capability to configure the SMF or NRF (e.g. to add or remove the UPF). + +**REQ-ECM\_CON-3** NFVO should have a capability allowing 3GPP management system to terminate the VNF(s). + +**REQ-ECM\_CON-4** The 3GPP management system should be able to provide the QoS requirements for the N6 interface, and the UPF location to edge computing management system. + +**REQ-ECM\_CON-5** NFVO should have a capability allowing 3GPP management system to request connection between VNFs in the same or different NS instances. + +**REQ-ECM\_CON-6** The 3GPP management system should have a capability allowing edge computing management system to request the UPF information in a given location and QoS requirements for the N6 interface. + +**REQ-ECM\_CON-7** The 3GPP management system should have a capability to collect the performance measurements (e.g. latency, data volume) for connections from UE to 3GPP UPF. + +**REQ-ECM\_CON-8** The 3GPP management system should have a capability allowing an authorized consumer (e.g. edge computing management system) to request the connection information (e.g. IP address) of NEF. + +**REQ-ECM\_CON-9** The 3GPP management system should have a capability to provide the connection information (e.g. IP address) of NEF to the authorized consumer (e.g. edge computing management system). + +# --- 7 Potential solutions + +## 7.1 UPF instantiation or termination to support edge computing + +### 7.1.1 General + +UPF instantiation or termination is needed to support the deployment of edge computing (see use cases in clauses 5.1 and 5.2). + +### 7.1.2 UPF instantiation + +3GPP management system requests NFVO to instantiate the NS identified by `nsInstanceId`, with the parameter `additionalParamForVnf` providing the information for the UPF, and parameter `locationConstraints` indicating the constraints on where the UPF will be located (see clause 7.3.3.2 in GS NFV-IFA 013 [8]). + +NFVO sends the NS LCM Operation Occurrence Notification to the 3GPP management system indicating the start of NS instantiation procedure (see clause 7.3.3.4 in GS NFV-IFA 013 [8]). + +NFVO instantiates the NS and the UPF. + +NFVO sends the NS LCM Operation Occurrence Notification to the 3GPP management system with the result of NS instantiation, including `vnfInstanceId` to indicate the UPF instance that has been instantiated (see clause 7.3.3.4 in GS NFV-IFA 013 [8]). + +NFVO sends the NS LCM Operation Occurrence Notification to the 3GPP management system with the result of NS instantiation, including `vnfInstanceId` to indicate the UPF instance that has been instantiated (see clause 7.3.3.4 in GS NFV-IFA 013 [8]). + +3GPP management system consumes Provisioning for NF service with `createMOIAttributes` operation (see clause 6.3 in TS 28.531 [10]) to create the `UPFFunction` IOC for the UPF instance. + +NOTE: `UPFFunction` in NRM (see clause 5.3.3 in TS 28.541 [10]) may contain the NRF identity to contact for registration and UPF Provisioning Information (see clause 4.17.6.2 in TS 23.502 [11]). + +### 7.1.3 UPF termination + +3GPP management system requests NFVO to update the NS with `updateType=RemoveVnf` to terminate the UPF instance (see clause 7.3.5.2 in GS NFV-IFA 013 [8]). + +NFVO sends the NS LCM Operation Occurrence Notification to the 3GPP management system indicating the start of NS update procedure (see clause 7.3.3.4 in GS NFV-IFA 013 [8]). + +NFVO removes the UPF instance from the NS. + +NFVO sends the NS LCM Operation Occurrence Notification to the 3GPP management system with the result of NS update, including *vnfInstanceId* to indicate the UPF instance that has been terminated (see clause 7.3.3.4 in GS NFV-IFA 013 [8]). + +## 7.2 SMF configuration to support UE traffic routing + +### 7.2.1 General + +SMF needs to be configured with the information about the available UPFs, when an UPF is instantiated or terminated (see clause 6.3.3.2 in TS 23.501 [2]). The information enables SMF to select UPF to route the user traffic to the local data network as described in clause 6.3.3 TS 23.501 [2]. + +### 7.2.2 SMF configuration for a new UPF + +It is assumed that UPF has been instantiated and *UPFFunction* IOC has been created. + +3GPP management system consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 6.3 in TS 28.531 [9]) to configure the SMF – *SMFFunction* with the UPF provisioning information in order to add the UPF to the available UPF list (see clause 6.3.3.2 in TS 23.501 [2]). + +### 7.2.3 SMF configuration for removal from the UPF available list + +3GPP management system consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 6.3 in TS 28.531 [9]) to configure SMF with the UPF identifier of the UPF to be removed from the available UPF list. + +## 7.3 NRF configuration to support UE traffic routing + +### 7.3.1 General + +NRF may obtain the UPF information via the following two options: + +- 3GPP management system configures NRF with the information about new UPF (see step 6 in clause 4.17.6.2 in TS 23.502 [11]). +- The UPF instance issues an *Nnrf\_NFManagement\_NFRegisterRequest* operation (see steps 4, 5 in clause 4.17.6.2 in TS 23.502 [11]). + +NRF then send the UPF information to SMF via *Nnrf\_NFManagement\_NFStatusNotify*. + +This subclause provides potential solutions from OAM aspects to support the two options mentioned above. + +### 7.3.2 NRF configuration to obtain UPF information + +It is assumed that a new UPF has been instantiated, and an *UPFFunction* IOC has been created. + +3GPP management system consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 6.3 in TS 28.531 [9]) to configure the NRF – *NRFFunction* with the available UPF (see clause 4.17.6.2 in TS 23.502 [11]). + +### 7.3.3 NRF receives UPF information from UPF instance + +It is assumed that a new UPF has been instantiated, and an *UPFFunction* IOC has been created. + +3GPP management system consumes the management service for NF provisioning with *createMOIAttributes* operation (see clause 6.3 in TS 28.531 [9]) to create an *EP\_SBI\_X* IOC contained by *UPFFunction* IOC that can be used by UPF to communicate with NRF. + +## 7.4 UPF and edge computing VNFs deployment + +### 7.4.1 General + +The following subclauses describe the solutions for the deployment of UPF and edge computing VNF instances (see use cases in clauses 5.3 and 5.4). The orchestration and lifecycle management of edge computing VNFs are realized in the NFVO and VNFM functional blocks as defined by ETSI NFV MANO (see clause 5.2 in ETSI GR MEC 017 [12]). + +### 7.4.2 Deployment of UPF and edge computing VNFs in a NS + +It is assumed that the UPF supporting the edge computing application has been instantiated in a NS identified by *nsInstanceId*, and no virtual link is available to connect the UPF VNF instance to the VNF instance supporting edge computing applications in the local data network. + +3GPP management system sends the following parameters to the edge computing management system to support the instantiation of the edge computing VNF: + +- QoS requirements, such as latency, bandwidth for N6 interface. +- UPF information related to the location of the UPF VNF that has been instantiated. +- *nsInstanceId* of the NS where the UPF VNF is contained. +- NSD that was used to instantiate the NS. + +Edge computing management system performs the following operations: + +- Update the NSD to add the VNFD for the VNF to be instantiated. +- Instantiate the VNF in the NS identified by *nsInstanceId*, based on the QoS requirements for the N6 interface and UPF information. + +Edge computing management system returns the *vnfInstanceId* and the updated NSD to 3GPP management system when the VNF has been successfully instantiated. + +3GPP management system adds a new VnfProfile or updates the existing VnfProfile (see clause 6.3.3 in GS NFV-IFA 014 [13]) with the NS virtual link information to or in the NSD. + +3GPP management system initiates the on-board NSD operation (see clause 7.2.2 in GS NFV-IFA 013 [8]) at NFVO to upload the NSD with the new or updated VnfProfile. + +3GPP management system initiates the update NS operation (see clause 7.3.5 in GS NFV-IFA 013 [8]) at NFVO with updateType=AssocNewNsdVersion to associate the NS with the on-boarded NSD. + +3GPP management system initiates the update NS operation (see clause 7.3.5 in GS NFV-IFA 013 [8]) at NFVO with updateType=AssocVnfWithVnfProfile, *nsInstanceId* and *vnfInstanceId* of the UPF VNF to connect the UPF VNF instance to the virtual link contained in the VnfProfile. + +3GPP management system initiates the update NS operation (see clause 7.3.5 in GS NFV-IFA 013 [8]) at NFVO with updateType=AssocVnfWithVnfProfile, *nsInstanceId* and *vnfInstanceId* of the edge computing VNF to connect the edge computing VNF instance to the virtual link contained in the VnfProfile. + +### 7.4.3 Deployment of UPF and edge computing VNFs in two separate NS + +It is assumed that the UPF supporting the edge computing application has been instantiated in a NS identified by *nsInstanceId #1*, based on NSD #1, and has been connected to a SAP #1. + +3GPP management system sends the following parameters to the edge computing management system to instantiate the edge computing VNF: + +- QoS requirements, such as latency, bandwidth for N6 interface +- UPF information related to the location of the UPF VNF that has been instantiated + +Edge computing management system used NSD #2 to instantiate a NS identified by *nsInstanceId #2* containing the edge computing VNF instance identified by *vnfInstanceId #2*, based on the QoS requirements for the N6 interface and UPF information, and connects the VNF instance to SAP #2. + +Edge computing management system returns the NSD #2, *vnfInstanceId #2* and *nsInstanceId #2* to 3GPP management system when the NS with the edge computing VNF has been successfully instantiated. + +3GPP management system connects the NSs identified by *nsInstanceId #1* and *nsInstanceId #2* by performing the following operations: + +- Update the NSD #3 to add the NsProfile (see clause 6.3.11 in GS NFV-IFA 014 [13]) that contain NSD #1 and NSD #2 that are associated with the nested NS instances, and a NS virtual Link of the composite NS that is to connect SAP #1 and SAP #2. +- Initiate the Create NS identifier operation (see clause 7.3.2 in GS NFV-IFA 013 [8]) at NFVO with NSD #3 to create the identifier of composite NS identified by *nsInstanceId #3*. +- Initiate the Instantiate NS operation (see clause 7.3.3 in GS NFV-IFA 013 [8]) at NFVO with *nsInstanceId #3* to instantiate the NS instance that: + - Contains two nested NS instances, identified by *nsInstanceId #1* and *nsInstanceId #2*, respectively; and + - Connects the nested NS instances via SAP #1 and SAP #2. + +Figure 7.4-1 shows the result of the operation where an UPF VNF is connected to the EC VNF via the NS virtual link in a composite NS. + +![Diagram of a Composite NS (nsInstanceId #3) containing two nested NS instances. NS (nsInstanceId #1) contains UPF VNF (vnfInstanceId #1) connected to SAP #1. NS (nsInstanceId #2) contains EC VNF (vnfInstanceId #2) connected to SAP #2. SAP #1 and SAP #2 are connected by an NS virtual link.](b90144cfbb81a2d610d920240fda689d_img.jpg) + +``` + +graph TD + subgraph Composite_NS [Composite NS (nsInstanceId #3)] + subgraph NS1 [NS (nsInstanceId #1)] + UPF_VNF1[UPF VNF (vnfInstanceId #1)] --- SAP1((SAP #1)) + end + subgraph NS2 [NS (nsInstanceId #2)] + EC_VNF2[EC VNF (vnfInstanceId #2)] --- SAP2((SAP #2)) + end + SAP1 <--> |NS virtual link| SAP2 + end + +``` + +Diagram of a Composite NS (nsInstanceId #3) containing two nested NS instances. NS (nsInstanceId #1) contains UPF VNF (vnfInstanceId #1) connected to SAP #1. NS (nsInstanceId #2) contains EC VNF (vnfInstanceId #2) connected to SAP #2. SAP #1 and SAP #2 are connected by an NS virtual link. + +**Figure 7.4-1: Connecting UPF and EC VNFs residing in two NS via NS VL** + +### 7.4.4 Retrieval of the UPF information + +It is assumed that the UPF identified by *vnfInstanceId #1* has been instantiated in a NS identified by *nsInstanceId #1*, based on NSD #1, and has been connected to SAP #1. It is assumed that the edge computing VNF identified by *vnfInstanceId #2* has been instantiated in a NS identified by *nsInstanceId #2*, based on NSD #2, and has been connected to SAP #2. + +Edge computing management system requests 3GPP management system to provide the information of UPFs to which the VNF supporting the edge computing can be instantiated by providing the location of local data network and the QoS requirements for the N6 interface. + +3GPP management system find the available UPFs that can meet the QoS requirements for the N6 interface in the given location. + +3GPP management system provides the *vnfInstanceId #1* of the UPF VNF, NSD #1, and *nsInstanceId #1* of the NS where UPF VNF has been instantiated to the edge computing management system. + +Edge computing management system connects the NSs identified by *nsInstanceId #1* and *nsInstanceId #2* by performing the following operations: + +- Update the NSD #3 to add the NsProfile (see clause 6.3.11 in GS NFV-IFA 014 [13]) that contain NSD #1 and NSD #2 that are associated with the nested NS instances, and a NS virtual Link of the composite NS NSD #1 and NSD #2 that are associated with the nested NS instances. + +- Instantiate a composite NS, based on NSD #3, which: + - Contains two nested NS instances, identified by *nsInstanceId #1* and *nsInstanceId #2*; and + - Connects the nested NS instances via SAP #1 and SAP #2. + +## 7.5 End-to-end performance assurance + +### 7.5.1 General + +This subclause provides a solution for the use case of performance measurements related to end-to-end QoS (see use cases in clause 5.5). + +### 7.5.2 Monitoring of the performance related to end-to-end QoS + +There are existing management services for performance measurement control and reporting, including: + +- Measurement job control services for NSIs (see clause 7.1 in TS 28.550 [14]) for the collection of performance measurements. +- Management services for provisioning of networks and network slicing (see clause 6 in TS 28.531 [17]) that are used to create *MeasurementControl* and *MeasurementReader* IOC (see clauses 4.3.12, 4.3.13 in TS 28.622 [16]) for the collection of performance measurements. +- Performance data file reporting service (see clause 7.2 in TS 28.550 [14]). +- Performance data streaming service (see clause 7.3 in TS 28.550 [14]). + +The measurements related to end-to-end QoS are needed. + +## 7.6 AF access to NEF + +### 7.6.1 General + +This solution supports the use case of NEF accessibility for EC (see use cases in clause 5.6 where the edge computing management system is able to obtain the NEF information, so it can configure the IP address of NEF at the AF). + +### 7.6.2 Provision of NEF IP address + +It is assumed that NEF has been instantiated. + +3GPP management system consumes the management service for NF provisioning with *getMOIAttributes* operation (see clause 6.3 in TS 28.531 [9]) to get the IP address of NEF via which the AF can send the request to SMF for controlling the traffic routing of PDU Session (see clause 6.3.3.2 in TS 23.501 [2]), if not already known. + +Upon request, 3GPP management system provides the IP address of NEF to an authorized consumer (e.g. edge computing management system). + +NOTE: The IOC representing the NEF that contains the NEF IP address should be defined. + +# --- 8 Conclusion + +The study has identified use cases, requirements and solutions for 3GPP management system to support the deployment and management of edge computing. + +It is concluded that: + +- LCM: + 1. Reuse ETSI NFV MANO to instantiate or terminate UPF needed to support edge computing. + 2. Reuse ETSI NFV MANO to connect UPF and edge computing VNF, but, may need enhancement to for the connection to meet the N6 QoS requirements. + +- Provisioning: + - 1. Require enhancements in 5G NRM to enable the configuration of SMF / NRF (see clause 7.2) to support edge computing. + - 2. Require enhancements in 5G NRM to enable the provisioning of NEF. +- Performance assurance: + - 1. Need end-to-end QoS performance measurements. + +Normative work is needed to address the LCM, provisioning, and performance assurance works aforementioned. + +# --- Annex A: Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | SA#85 | SP-190774 | | | | Presented for approval | 2.0.0 | +| 2019-09 | SA#85 | | | | | Change control version | 16.0.0 | +| 2019-09 | SA#85 | | | | | EditHelp review | 16.0.1 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28804/54fabc351eda5228d2fa28cd9ba07971_img.jpg b/marked/Rel-16/28_series/28804/54fabc351eda5228d2fa28cd9ba07971_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5cd57e9c951fd60b5aee669c11f9286f1063a870 --- /dev/null +++ b/marked/Rel-16/28_series/28804/54fabc351eda5228d2fa28cd9ba07971_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f588010cb011da828284dce91c79da4fe4f7d2fbeb94bea3868f7b88e108e3f8 +size 33735 diff --git a/marked/Rel-16/28_series/28804/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/marked/Rel-16/28_series/28804/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc5bfb82e049e17f5b9b21625d9a800da4ab3852 --- /dev/null +++ b/marked/Rel-16/28_series/28804/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b76f69f3e770ab9db37e0bb887128688134d2e4c00030f1e12613ee33fc1f97 +size 27034 diff --git a/marked/Rel-16/28_series/28804/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg b/marked/Rel-16/28_series/28804/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b7fb694eced02bf04e34616b160d78300ee5704 --- /dev/null +++ b/marked/Rel-16/28_series/28804/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:88e71a63746be8c382700dbc515bee31ef647615fed7c96e8e69a38de52d84b7 +size 23389 diff --git a/marked/Rel-16/28_series/28804/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-16/28_series/28804/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c922134fd031646f64a7a3e42249ba54d134cb2 --- /dev/null +++ b/marked/Rel-16/28_series/28804/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eab529f41f2b2601b1572c82622d1968940612b2b66a4e1d38bbdb046900bb91 +size 24292 diff --git a/marked/Rel-16/28_series/28804/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/28_series/28804/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7bdb6415a649997233fb9fe27c7af6237215caf2 --- /dev/null +++ b/marked/Rel-16/28_series/28804/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac2d52bf109e1875fb950e8f85b2799d6887448402474486552155191ecfd01d +size 28693 diff --git a/marked/Rel-16/28_series/28804/raw.md b/marked/Rel-16/28_series/28804/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cb00801149776d54c4798424fb857e7e6abfaf6a --- /dev/null +++ b/marked/Rel-16/28_series/28804/raw.md @@ -0,0 +1,365 @@ + + + + + + +# --- Contents + +| | | +|-----------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Concepts and background ..... | 7 | +| 4.1 Sharing of same MnS ..... | 7 | +| 4.2 Key issues for tenant management..... | 8 | +| 4.3 Management service consumed by tenant..... | 8 | +| 4.4 Tenant categorization based on its management capability ..... | 9 | +| 4.5 Managed resource representation for a tenant..... | 9 | +| 4.6 Management capabilities provided to a tenant in 3GPP management system..... | 9 | +| 4.7 Management function providing management capabilities for multiple tenants ..... | 10 | +| 4.8 Relation to communication service instance..... | 10 | +| 4.9 Fault supervision management for a tenant..... | 11 | +| 4.10 Performance measurement for a tenant..... | 11 | +| 5 Use cases and potential requirements ..... | 11 | +| 5.1 Management capabilities provided to tenant by network slice management..... | 11 | +| 5.1.1 Description ..... | 11 | +| 5.1.2 Potential requirements ..... | 12 | +| 5.2 Management capabilities provided to tenant by network function management service ..... | 12 | +| 5.2.1 Description ..... | 12 | +| 5.2.2 Potential requirements ..... | 12 | +| 6 Potential management enhancements to support multiple tenants environment ..... | 12 | +| 6.1 Potential management enhancements for performance measurement of network slice management ..... | 12 | +| 6.2 Potential management enhancements for fault supervision ..... | 12 | +| 6.3 Potential management enhancements for performance measurement of network function..... | 12 | +| 7 Conclusion and recommendations ..... | 12 | +| <b>Annex A: Change history .....</b> | <b>14</b> | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" shall not be used as substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document explores how 3GPP management system can provide management capabilities for fulfilling requirements derived from tenancy concepts and use cases, and it also explores how to those management capabilities are exposed to individual tenancy concepts consumers. + +The present document investigates the evolution of management features and capabilities due to the identified potential requirements and solutions for tenancy concept. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.530: "Management and orchestration; Concepts, use cases and requirements". +- [3] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [4] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [5] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [6] 3GPP TS 28.541: "Management and orchestration; Network Resource Model (NRM); Stage 2 and stage 3". +- [7] 3GPP TS 28.552: "Management and orchestration; Performance measurements". +- [8] 3GPP TS 28.554: "Management and orchestration; 5G end to end key performance indicators (KPI)". +- [9] 3GPP TR 28.805: "Telecommunication management; Study on management aspects of communication services". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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 + +**Tenant in 3GPP management system:** A group of 3GPP management system users associated with the management capabilities they are allowed to access and consume. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +# 4 Concepts and background + +## 4.1 Sharing of same MnS + +As described in Figure 4.1-1 and Figure 4.1-2, for fulfilling the tenancy concept, operators' can have different options to share their management resources between multiple tenants (e.g. operator's business customers): + +Option 1 (Figure 4.1-1) + +- Multiple tenants represented by single MnS Consumer instance +- Same management service is consumed by 3 different tenants (e.g. performance management service), from a single MnS Producer instance +- Tenancy related management data isolation is not currently provided by 3GPP management system + +NOTE 1: MnS Consumer behaviour related to tenancy related management data isolation is operator BSS scope. + +NOTE 2: MnS Producer behaviour related to tenancy management data isolation is 3GPP management system scope and it is FFS. + +![Diagram illustrating Option 1: Multiple tenants represented by single MnS Consumer, while consuming the same MnS. The diagram shows three dashed boxes at the top labeled 'Tenant 1', 'Tenant 2', and 'Tenant N'. Dashed lines connect each tenant box to a central solid box labeled 'MnS Consumer'. Below the 'MnS Consumer' box is a vertical line with a small circle at the bottom, connecting to a solid box labeled 'MnS Producer'. Inside the 'MnS Producer' box is a smaller solid box labeled 'MnS'.](78d5774278a3f4a614f8c0ae485ce8d9_img.jpg) + +Diagram illustrating Option 1: Multiple tenants represented by single MnS Consumer, while consuming the same MnS. The diagram shows three dashed boxes at the top labeled 'Tenant 1', 'Tenant 2', and 'Tenant N'. Dashed lines connect each tenant box to a central solid box labeled 'MnS Consumer'. Below the 'MnS Consumer' box is a vertical line with a small circle at the bottom, connecting to a solid box labeled 'MnS Producer'. Inside the 'MnS Producer' box is a smaller solid box labeled 'MnS'. + +**Figure 4.1-1: Multiple tenants represented by single MnS Consumer, while consuming the same MnS** + +Option 2 (Figure 4.1-2) + +- Each tenant represented by dedicated MnS Consumer +- Same management service is consumed by 3 different tenants (e.g. performance management service), from a single MnS Producer +- Tenancy related management data isolation is partially provided by 3GPP management system (e.g. by dedicated MnS Consumer) + +![Diagram showing multiple tenants (Tenant 1, Tenant 2, ..., Tenant N) connected to dedicated MnS Consumers (MnS Consumer 1, MnS Consumer 2, ..., MnS Consumer N). All MnS Consumers are connected to a single MnS Producer.](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram illustrates a network management architecture. At the top, there are multiple tenants labeled 'Tenant 1', 'Tenant 2', and 'Tenant N' (indicated by a dashed line between Tenant 2 and Tenant N). Each tenant is connected via a dashed vertical line to a corresponding 'MnS Consumer' box labeled 'MnS Consumer 1', 'MnS Consumer 2', and 'MnS Consumer N' (also indicated by a dashed line). Below these consumers, each has a solid vertical line connecting it to a common point (a small circle). From this common point, a dashed line extends downwards to a box labeled 'MnS Producer'. Inside the 'MnS Producer' box, there is a smaller box labeled 'MnS'. + +Diagram showing multiple tenants (Tenant 1, Tenant 2, ..., Tenant N) connected to dedicated MnS Consumers (MnS Consumer 1, MnS Consumer 2, ..., MnS Consumer N). All MnS Consumers are connected to a single MnS Producer. + +**Figure 4.1-2: Each tenant represented by dedicated MnS Consumer, while consuming the same MnS** + +**Editor's note:** How utilize business roles defined in TS 28.530 into tenancy concepts is FFS. + +NOTE 3: Same tenant can be represented by option 1, by option 2 or by combination of option 1 and option 2. + +## 4.2 Key issues for tenant management + +The non-exhaustive key issues for tenant management to be addressed in the present document are as following: + +### **Issue 1. Tenancy, tenant and tenant management key concepts** + +Study the key concepts of tenancy, tenant and tenant related management. + +### **Issue 2. Different exposure of network management capabilities for different tenants** + +Study scenarios, contents and behaviours of management capabilities exposure for different tenants. + +### **Issue 3. Relation of tenant management, communication service management and network management, including network slicing management** + +Study the relation of tenant management, communication service management and network management, including network slicing management. + +## 4.3 Management service consumed by tenant + +Tenant concept can be considered as a group of user in software and virtualization context. The 3<sup>rd</sup> party consumer using 3GPP management capability can represent a tenant that use communication service (e.g. an enterprise user). + +In 3GPP management system, management services are produced to offer management capabilities that provide management operation and management data access for specific management purposes. The management services are supported by 3GPP management system are as following: + +- provisioning service; +- performance management service; and +- fault management service. + +When the 3<sup>rd</sup> party consumer is represented as group of users, identified as tenants (e.g. enterprises that consume V2X service), tenants should be able to consume management services that are exposed to them. + +The typical management data exposed to tenants are performance measurement KPIs and fault alarms. When 3GPP management system exposes management data to tenants, the management data should be provided by performance management service or fault management service. + +NOTE: Only a subset of management service specified by 3GPP specification will be exposed to 3<sup>rd</sup> party management service consumer representing the tenant. + +## 4.4 Tenant categorization based on its management capability + +The following tenant types may exist in order to provide 5G communication services, the management capability for different tenant types may be different depending on the services the tenant obtains from the provider. + +- Tenant type A: an entity uses its logical network (i.e. an instance of a network) provided by NOP, and performs lifecycle management of its logical network. + +Tenant type A is categorized as below: + +- Tenant type A1: an entity uses its logical network provided by NOP to provide CSIs to its customers (e.g., verticals), and performs lifecycle management of its logical network. +- Tenant type A2: an entity uses its logical network provided by NOP to provide CSIs to end users, and performs lifecycle management of its logical network. +- Tenant type B: an entity uses its logical network provided by NOP, and does not perform lifecycle management of its logical network. Any associated management capabilities are accessed and consumed by the NOP. + +Tenant type B is categorized as below: + +- Tenant type B1: an entity uses its logical network provided by NOP to provide CSIs to its customers (e.g., verticals), and does not perform lifecycle management of its logical network. +- Tenant type B2: an entity uses its logical network provided by NOP to provide CSIs to end users, and does not perform lifecycle management of its logical network. + +## 4.5 Managed resource representation for a tenant + +3GPP management system may provide management capabilities based on agreed requirements between a tenant and the network operator (e.g. performance report, alarm notification, provisioning service, etc.). + +NRM IOC represents managed resource that can be created or deleted for multiple tenants in multiple tenant environment. For example, if NOP exposes NSI provisioning services to external MnS consumer, the IOC of `NetworkSlice` can be associated with authorized this external MnS consumer. + +**Editor's note: How to associate tenant information with NRM IOC is FFS.** + +MOI represents the managed resource that can be used by multiple tenants in multiple tenant environment. In one of the scenario, 5G Core AMF may support AMF measurement KPI reporting related to network slice instance supporting multiple tenants. In another scenario when a network slice instance supports multiple tenants, 3GPP management system may use an MOI to represent the management resource for multiple tenants. + +NOTE: Tenant information may be part of a MOI to further identify management resource for a single tenant. + +## 4.6 Management capabilities provided to a tenant in 3GPP management system + +The tenant should be capable to consume MnS that provides management capabilities. It is proposed to use MOI (component type B) to identify the managed resource of the tenant. The 3GPP management system should be capable to authorize, identify and enforce exposure of specified management capabilities related to managed resource of a tenant. + +## 4.7 Management function providing management capabilities for multiple tenants + +The network slice subnet management function can provide management services that provide management capabilities in multiple tenant environment. For example, the network management function is optionally capable of handling a management data and monitor network measurement KPIs for multiple tenant. The management function supporting multiple tenant environment may act as MnS consumer and as MnS provider for tenants as shown in Figure 4.7-1. + +![Figure 4.7-1: Example of Management Function in multiple tenant environment](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +This diagram illustrates a central 'Management Function' block. Inside this block, at the top, are two 'MnS Producer' components: 'MnS #1 Producer (for tenant A)' and 'MnS #2 Producer (for tenant B)'. At the bottom, there are three 'MnS Consumer' components: 'MnS #X Consumer (for tenant A)', 'MnS #Y Consumer (for tenant A)', and 'MnS #Z Consumer (for tenant B)'. Above the 'Management Function' block, two external entities (represented by circles) are connected to the 'MnS #1 Producer' and 'MnS #2 Producer' respectively. Below the 'Management Function' block, three external entities are connected to the 'MnS #X Consumer', 'MnS #Y Consumer', and 'MnS #Z Consumer' respectively. + +Figure 4.7-1: Example of Management Function in multiple tenant environment + +**Figure 4.7-1: Example of Management Function in multiple tenant environment** + +When tenant represents a group of CSI consumers in 3GPP management system, the tenant may consume a set of management capabilities. The exposure governance management function defined in TS 28.533 [5] may authorize the MnS consumer representing the tenant and apply exposure governance on management services. + +![Figure 4.7-2: Exposure governance in multiple tenant environment](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +This diagram shows the interaction between tenants and a management function. At the top, 'Tenant A' and 'Tenant B' (represented by dashed boxes) are connected to 'MnS#1 consumer A' and 'MnS#2 consumer B' (represented by solid boxes) respectively. These consumers are connected via double-headed arrows to an 'Exposure Governance' block. The 'Exposure Governance' block is part of a larger 'Management function' block. Inside the 'Management function' block, below the 'Exposure Governance' block, are two 'MnS Producer' components: 'MnS#1 Producer (for tenant#A)' and 'MnS#2 Producer (for tenant#B)'. These producers are also connected via double-headed arrows to the 'Exposure Governance' block. + +Figure 4.7-2: Exposure governance in multiple tenant environment + +**Figure 4.7-2: Exposure governance in multiple tenant environment** + +It is illustrated in Figure 4.7-2 that exposed management services can be consumed by MnS consumers representing tenants. The MnS consumer should provide the identity information of the tenant when it consumes services provided by MnS producer. The EGMF should authenticate the identity information of the tenant and authorize the MnS consumer representing the tenant to access MnS and consume a specified set of management capabilities. + +## 4.8 Relation to communication service instance + +According to TR 28.805 [9], the vertical customer is authorized to obtain the allowed management capability from CSI service provider according to the pre-defined agreements between the CSI service provider and the CSI service consumer. As described in Figure 4.8-1, CSI Consumer in CSMF can be mapped into a MnS consumer associated with tenant information in 3GPP management system. The MnS provider can provide management capabilities for this tenant by using tenant information as following: + +- 5G network slice NRM IOC attribute with tenant information, used to identify managed resource for the tenant +- S-NSSAI value, additionally used by 3GPP management system to associate NF performance measurement with a tenant + +![Diagram illustrating the relation between CSMF and NSMF/NSSMF tenant information. A 'Tenant' is shown as an arrow pointing to a 'CSI Consumer' box within the 'CSMF' box. A dashed arrow labeled 'Tenant information' points from the 'CSI Consumer' to the 'NSMF/NSSMF' box. From the 'NSMF/NSSMF' box, two dashed arrows point to '5G network slice IOC service profile attribute**' and 'S-NSSAI*'. Below the diagram, a legend explains: *Used to associate performance and alarm information with a tenant, **Used to identify tenant managed resource.](5e92d9e8e9ce204e405bff2367f88176_img.jpg) + +``` + +graph LR + subgraph CSMF + CSI_Consumer[CSI Consumer] + end + Tenant --> CSI_Consumer + CSI_Consumer -.-> TI[Tenant information] + subgraph NSMF_NSSMF [NSMF/NSSMF] + IOC[5G network slice IOC service profile attribute**] + S_NSSAI[S-NSSAI*] + end + TI -.-> IOC + TI -.-> S_NSSAI + +``` + +\*Used to associate performance and alarm information with a tenant +\*\*Used to identify tenant managed resource + +Diagram illustrating the relation between CSMF and NSMF/NSSMF tenant information. A 'Tenant' is shown as an arrow pointing to a 'CSI Consumer' box within the 'CSMF' box. A dashed arrow labeled 'Tenant information' points from the 'CSI Consumer' to the 'NSMF/NSSMF' box. From the 'NSMF/NSSMF' box, two dashed arrows point to '5G network slice IOC service profile attribute\*\*' and 'S-NSSAI\*'. Below the diagram, a legend explains: \*Used to associate performance and alarm information with a tenant, \*\*Used to identify tenant managed resource. + +Figure 4.8-1: NSMF/NSSMF tenant information relation with CSI Consumer in CSMF + +## 4.9 Fault supervision management for a tenant + +When the MnS consumer subscribes or queries alarm information of managed resources, the alarm information of managed resource related to the tenant may be provided to the MnS consumer. The tenant information in Serviceprofile IOC is associated with S-NSSAI in sNSSAIIList attributes or sub-attributes as defined in TS 28.541 [6]. S-NSSAI may be used for filtering the alarm information in `subscribe` or `getAlarmList` operation defined in TS 28.532 [4]. + +## 4.10 Performance measurement for a tenant + +Tenant information in NRM IOCs may be used to distinguish performance measurement for different tenants. The MnS consumer representing the tenant may get the performance measurements of the network function. If the tenant information in Network Slice IOC ServiceProfile is associated with S-NSSAI in sNSSAIIList attributes of MOI, the counter per S-NSSAI defined in TS 28.552 [7] may be set for the network function performance measurements. + +# 5 Use cases and potential requirements + +## 5.1 Management capabilities provided to tenant by network slice management + +### 5.1.1 Description + +3GPP management system supports network slice and network slice subnet management for 5G network according to TS 28.530 [2] and TS 38.531 [3]. 3GPP management system should support network slice and network slice subnet management for a tenant in multiple tenant environment. + +According to TS 28.805 [9], when 3GPP management creates a CSI, 3GPP system may create MOI and corresponding managed resource to provide management capabilities to consumer of CSI and to identify the CSI consumer as a tenant in 3GPP management system. + +Network slice management function may provide management services for a CSI consumer identified as a tenant in 3GPP management system. + +### 5.1.2 Potential requirements + +**REQ-TenM\_Slice\_MnS-01** The 3GPP management system may have capability to provide performance measurements and fault alarms for a network slice to MnS consumer associated with a tenant. + +**REQ-TenM\_Slice\_MnS-02** The 3GPP management system may have capability to provide network slice and network slice subnet lifecycle management (e.g. creation, modification and termination) to MnS consumer associated with a tenant. + +## 5.2 Management capabilities provided to tenant by network function management service + +### 5.2.1 Description + +Management service provider is capable to identify the MnS instance that provides the monitoring metrics and fault alarms for a tenant. Since the NF may be shared by multiple network slice instances, NF performance measurement and fault alarm for a tenant can be provided with the network slice instance information (e.g. S-NSSAI) by management service provider. + +### 5.2.2 Potential requirements + +**REQ-TenM\_NFM\_MnS-01** The 3GPP management system may have capability to provide NF performance measurements and NF fault alarms MnS consumer associated with a tenant. + +# --- 6 Potential management enhancements to support multiple tenants environment + +## 6.1 Potential management enhancements for performance measurement of network slice management + +It is proposed to use tenant information (e.g. tenant identifier) in NRM IOCs, for purpose of identification to managed resource for the tenant. + +## 6.2 Potential management enhancements for fault supervision + +The alarm information of MOI may be provided to the management service consumer a tenant in multiple tenant environment. The tenant information may be used for filtering the alarm information associated with a tenant. + +## 6.3 Potential management enhancements for performance measurement of network function + +The use of counter per S-NSSAI associated to tenant information may be clarified for the network function performance measurements in TS 28.552 [7]. + +# --- 7 Conclusion and recommendations + +Enhancement to management framework in TS 28.533 [5] is concluded for 3GPP management system to support multiple tenant environment in this study. When multiple tenants are consuming management capabilities, there is a need to provide management services (e.g. provisioning service, performance management service and fault management service) and managed resource for each tenant. For purpose of identification to managed resources and specified management capabilities for each tenant, tenant information should be included in Network Slice IOC ServiceProfile data type. + +Following normative work for the enhancement of 3GPP management system for tenancy concept support in multiple tenant environment are recommended: + +- Conceptual descriptions of multiple tenant environment support by management framework, added in TS 28.533 [5]. +- Provisioning service MOI creation, modification and termination in multiple tenant environment, reused from TS 28.531 [3], TS 28.532 [4]. +- Performance measurement in multiple tenant environment, reused from TS 28.552 [7] and TS 28.554 [8]. +- Network slice fault supervision in multiple tenant environment reused from TS 28.532 [4]. +- Network Slice IOC ServiceProfile data type extension with tenant information, added to TS 28.541 [6]. + +# --- Annex A: Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|----------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | SA#85 | SP-190768 | | | | Presented for information and approval | 1.0.0 | +| 2019-09 | SA#85 | | | | | Change control version | 16.0.0 | +| 2019-10 | | | | | | EditHelp review | 16.0.1 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28805/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/marked/Rel-16/28_series/28805/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de4ab186acc92cc2022f487294e4ff4289b6799c --- /dev/null +++ b/marked/Rel-16/28_series/28805/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:154bea5a8eed18ed0a23df37234e79a4a8bb798688ac97b575c7f85896bd2aa4 +size 162745 diff --git a/marked/Rel-16/28_series/28805/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/28_series/28805/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2f70a80276a3686455c42b55b1f34fc70ef0b38 --- /dev/null +++ b/marked/Rel-16/28_series/28805/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:54895d8ae54a5c96749813238e944a2aff36c211c74ea6927c554be4575459e5 +size 34113 diff --git a/marked/Rel-16/28_series/28805/1eadbbe42cfcac5c0023577110aec5e3_img.jpg b/marked/Rel-16/28_series/28805/1eadbbe42cfcac5c0023577110aec5e3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38d815d8210cf9280ef8801a588453fc8d071729 --- /dev/null +++ b/marked/Rel-16/28_series/28805/1eadbbe42cfcac5c0023577110aec5e3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7cbc7b15eb955ce86e0392c5d0e6f03faa4184ec31cb1b6135d7909e8bc11b51 +size 15961 diff --git a/marked/Rel-16/28_series/28805/5dfc130b129ace4df375839020a5700d_img.jpg b/marked/Rel-16/28_series/28805/5dfc130b129ace4df375839020a5700d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..85cf22fee46baf4eae72bdb7f4ed0aa88b95252a --- /dev/null +++ b/marked/Rel-16/28_series/28805/5dfc130b129ace4df375839020a5700d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:67899f3130691d5879824e56a2ae260eeac38a75a414058f717db868a3bae1f6 +size 42724 diff --git a/marked/Rel-16/28_series/28805/63e0c22852c26699d0bd095a2d796bab_img.jpg b/marked/Rel-16/28_series/28805/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb1669dc3ae4a2444ff0d7074fd343866a9b342f --- /dev/null +++ b/marked/Rel-16/28_series/28805/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f8f6597bf92cf3feaa90c8cd273f709af9e2f7a6443ab375029f4c413aeb369 +size 59716 diff --git a/marked/Rel-16/28_series/28805/78ffccd66df9bafd96e3e081110d09dd_img.jpg b/marked/Rel-16/28_series/28805/78ffccd66df9bafd96e3e081110d09dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58e2edab6f1931e38dc79f91b43403c63aac12f8 --- /dev/null +++ b/marked/Rel-16/28_series/28805/78ffccd66df9bafd96e3e081110d09dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06c2f6aa92a1ebce0d72687a6fa42d7b47c83d9f76304eb9a9643f8a1a4cfcab +size 52648 diff --git a/marked/Rel-16/28_series/28805/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/28_series/28805/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a923e32272730398f379645304c02d3b0656a471 --- /dev/null +++ b/marked/Rel-16/28_series/28805/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b59144f01ebbc475782983278b041ba48511e90b5c7eaa8c0c2a931d61c97534 +size 29484 diff --git a/marked/Rel-16/28_series/28805/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/28_series/28805/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ca2c9ec5680705cd33c13799ab1b17f31190625 --- /dev/null +++ b/marked/Rel-16/28_series/28805/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:162396affbcbce74a8fa6450f5c1d642a2b83aa5da22252a8d45be38c6a49b98 +size 37802 diff --git a/marked/Rel-16/28_series/28805/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/28_series/28805/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..23273381e25536b865680d71e86e1705cb202299 --- /dev/null +++ b/marked/Rel-16/28_series/28805/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bad45ee25218f648b2356094cdf8ecf9a09c9e87ff9059a5bbdb2006b210fa3e +size 134847 diff --git a/marked/Rel-16/28_series/28805/b0d4609bc46c2d88a8318706bb5321f7_img.jpg b/marked/Rel-16/28_series/28805/b0d4609bc46c2d88a8318706bb5321f7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a86cf0d5c3d6aeb32085e6fd3bf2607f886c7cb --- /dev/null +++ b/marked/Rel-16/28_series/28805/b0d4609bc46c2d88a8318706bb5321f7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f329ce2f20e71cd8dd526b00dfb8ada238153761953a16c384e36e924eb1fa82 +size 36615 diff --git a/marked/Rel-16/28_series/28805/cab0834804fb031b43865554cc8d06ab_img.jpg b/marked/Rel-16/28_series/28805/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84abf6857e1b95bedd7deda7fcc16568a2c46410 --- /dev/null +++ b/marked/Rel-16/28_series/28805/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25d77b889b29b672bb8d46e67b5daedbe5e8b20d9c4100463e766f4c61093cf7 +size 56904 diff --git a/marked/Rel-16/28_series/28805/e58a867750e4ae01604318506b79df7a_img.jpg b/marked/Rel-16/28_series/28805/e58a867750e4ae01604318506b79df7a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b4a54e804caac6c1996fac1fd5eeaec974376f14 --- /dev/null +++ b/marked/Rel-16/28_series/28805/e58a867750e4ae01604318506b79df7a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ada0c90b930183a2d513f6ca64e6c112479fa03bd54157cd1502654a580ad913 +size 15380 diff --git a/marked/Rel-16/28_series/28805/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/marked/Rel-16/28_series/28805/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a467772b8b8a98bf02a56d6f42b2bab42779b402 --- /dev/null +++ b/marked/Rel-16/28_series/28805/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe343eca1fa8f51fc674b44960b4acec121f91a97157184e81254800f3d6b2db +size 52169 diff --git a/marked/Rel-16/28_series/28805/raw.md b/marked/Rel-16/28_series/28805/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a424c660f64fcf69d662d2dc1c8b72a0cc3241c3 --- /dev/null +++ b/marked/Rel-16/28_series/28805/raw.md @@ -0,0 +1,1232 @@ + + + + +. + +# Contents + +| | | +|----------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Concepts and background..... | 9 | +| 4.1 Types of communication services..... | 9 | +| 4.2 Management aspects of communication services ..... | 10 | +| 4.2.1 Customer, service and resource views..... | 10 | +| 4.2.2 Communication service management function ..... | 10 | +| 4.2.3 Lifecycle of communication service..... | 11 | +| 4.2.4 Relation of CSI lifecycle to NSI lifecycle..... | 12 | +| 4.2.4.0 Introduction..... | 12 | +| 4.2.4.1 CSI LCM operation triggering NSI creation ..... | 12 | +| 4.2.4.2 CSI LCM operation triggering NSI modification..... | 13 | +| 4.2.4.3 CSI LCM operation triggering NSI activation and deactivation ..... | 13 | +| 4.2.5 Performance assurance of communication services ..... | 13 | +| 4.3 Management layers ..... | 14 | +| 4.4 Management model..... | 15 | +| 4.4.1 Introduction ..... | 15 | +| 4.4.2 Description ..... | 15 | +| 4.4.3 Communication services applied to network slicing..... | 16 | +| 4.5 Communication services..... | 17 | +| 4.5.1 Introduction ..... | 17 | +| 4.5.2 GSMA GST/NEST ..... | 17 | +| 4.6 SLS assurance ..... | 17 | +| 4.6.1 Description ..... | 17 | +| 4.6.2 Management cooperation with 5GC and NG-RAN ..... | 18 | +| 4.7 Service QoE..... | 18 | +| 4.7.1 Description ..... | 18 | +| 4.7.2 Service QoE collection and service quality assurance ..... | 18 | +| 5 Potential use cases and requirements..... | 19 | +| 5.1 Management data analytics and automated service assurance..... | 19 | +| 5.1.1 Service quality assurance and optimization of the services ..... | 19 | +| 5.1.1.1 Description..... | 19 | +| 5.1.1.2 Potential requirements ..... | 19 | +| 5.1.2 CSI monitoring ..... | 19 | +| 5.1.2.1 Description..... | 19 | +| 5.1.2.2 Potential requirements ..... | 20 | +| 5.1.3 SLS monitoring for network slicing ..... | 20 | +| 5.1.3.1 Description..... | 20 | +| 5.1.3.2 Potential requirements ..... | 20 | +| 5.1.4 MDA-Assisted network provisioning contributing to SLS assurance..... | 21 | +| 5.1.4.1 Description..... | 21 | +| 5.1.4.2 Potential requirements ..... | 21 | +| 5.2 Lifecycle management ..... | 21 | +| 5.2.1 Communication service instances realized in a single network slice instance..... | 21 | +| 5.2.1.1 Description..... | 21 | +| 5.2.1.2 Potential requirements ..... | 22 | +| 5.2.2 Remove a communication service instance from a network slice instance..... | 22 | +| 5.2.2.1 Description..... | 22 | +| 5.2.2.2 Potential requirements ..... | 22 | + +| | | | +|----------|------------------------------------------------------------------------------------------------|----| +| 5.2.3 | Management aspects of NSIs utilized by multiple communication services ..... | 23 | +| 5.2.3.1 | Description..... | 23 | +| 5.2.3.2 | Potential requirements ..... | 23 | +| 5.2.4 | Obtaining an NSI as an NOP Internal to provide multiple CSIs ..... | 23 | +| 5.2.4.1 | Description..... | 23 | +| 5.2.5 | Providing CSI management capability to vertical industries ..... | 23 | +| 5.2.5.1 | Description..... | 23 | +| 5.2.6 | Create a Communication Service (CSI) ..... | 24 | +| 5.2.6.1 | Description..... | 24 | +| 5.2.6.2 | Potential requirements ..... | 24 | +| 5.2.7 | Activate a Communication Service (CSI) ..... | 24 | +| 5.2.7.1 | Description..... | 24 | +| 5.2.7.2 | Potential requirements ..... | 24 | +| 5.2.8 | De-activate a Communication Service (CSI) ..... | 24 | +| 5.2.8.1 | Description..... | 24 | +| 5.2.8.2 | Potential requirements ..... | 25 | +| 5.2.9 | Modify a Communication Service (CSI) ..... | 25 | +| 5.2.9.1 | Description..... | 25 | +| 5.2.9.2 | Potential requirements ..... | 25 | +| 5.2.10 | Terminate a Communication Service (CSI) ..... | 25 | +| 5.2.10.1 | Description..... | 25 | +| 5.2.10.2 | Potential requirements ..... | 25 | +| 5.2.11 | Management of multi-party communication service..... | 25 | +| 5.2.11.1 | Description..... | 25 | +| 5.2.11.2 | Potential requirements ..... | 26 | +| 5.3 | Lifecycle management, data analytics and automated service assurance ..... | 26 | +| 5.3.1 | Service management aspects of NSaaS..... | 26 | +| 5.3.1.1 | Description..... | 26 | +| 5.3.1.2 | Potential requirements ..... | 27 | +| 6 | Potential solutions ..... | 27 | +| 6.1 | Solution for communication service instances realized in a single network slice instance ..... | 27 | +| 6.2 | Solution for translation of SLS into SLS requirements..... | 28 | +| 6.3 | Solution for communication service instance termination..... | 29 | +| 6.3.1 | Solution for the case that network slice used as resources..... | 29 | +| 6.4 | Solution for communication service instance modification..... | 29 | +| 6.4.1 | Solution for the case that network slice used as resources..... | 29 | +| 6.5 | Solution for communication service instance activation..... | 30 | +| 6.5.1 | Solution for the case that network slice used as resources..... | 30 | +| 6.6 | Solution for communication service instance de-activation ..... | 30 | +| 6.6.1 | Solution for the case that network slice used as resources..... | 30 | +| 6.7 | Solution for MDA-Assisted SLS assurance..... | 30 | +| 6.7.1 | MDA-Assisted network optimization..... | 30 | +| 6.8 | Solution for providing management capability to vertical industries ..... | 32 | +| 6.9 | Solution for management aspects of NSI utilized by multiple communication services..... | 33 | +| 6.9.1 | Assignment of communication service to an existing NSI ..... | 33 | +| 6.9.2 | Activation of CSI sharing NSI. .... | 33 | +| 6.9.3 | Termination of CSI sharing NSI..... | 33 | +| 7 | Conclusions and recommendations..... | 34 | +| 7.1 | Conclusions ..... | 34 | +| 7.1.1 | Introduction ..... | 34 | +| 7.1.2 | Lifecycle management of communication services..... | 34 | +| 7.1.3 | Management data analytics ..... | 34 | +| 7.1.4 | SLS assurance..... | 34 | +| 7.2 | Recommendations ..... | 35 | +| 7.2.1 | Lifecycle management of communication services..... | 35 | +| 7.2.2 | SLS assurance solution..... | 35 | +| 7.2.3 | Management data analytics in the SON context..... | 35 | +| 7.2.4 | Management of MDAF ..... | 35 | + +**Annex A: Comparison table between 3GPP ServiceProfile attributes and GSMA GST attributes ..... 36** + +**Annex B: Change history..... 42** + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +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. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +The constructions "can" and "cannot" shall not be used as substitutes for "may" and "need not". + +**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 + +**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 + +**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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +With the recent introduction of a service based management architecture for management of mobile networks [2], a service provider or network operator can manage 5G networks including network slicing, using management services. The next level of management is to manage the communication services provided by the network. The present document studies the use of a service based management architecture for management of communication services. + +# --- 1 Scope + +The present document specifies potential use cases, requirements and solutions (from the perspective of services based management architecture) for the management of communication services. The document provides conclusions and recommendations on the next steps in the standardization. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [3] 3GPP TS 28.530: "Management and orchestration; Concepts, use cases and requirements". +- [4] 3GPP TS 22.261: "Service requirements for next generation new services and markets". +- [5] 3GPP TR 28.801: "Study on management and orchestration of network slicing for next generation network". +- [6] 3GPP TR 23.791: "Study of Enablers for Network Automation for 5G". +- [7] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [8] 3GPP TS 28.531: "Management and orchestration; Provisioning; Stage 1". +- [9] TMN M.3010: "Principles for a telecommunications management network" M.3010 (02/00). +- [10] 3GPP TS 28.404: "Telecommunication management; Quality of Experience (QoE) measurement collection; Concepts, use cases and requirements". +- [11] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [12] GSMA Official Document NG.116 "Generic Network Slice Template Version 1.0 May 2019". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +**communication services:** subset of 3GPP defined services. Examples of 3GPP services (e.g. 5G LAN) can be found in TS 22.261. + +**communication service instance:** run-time construct of a communication service for a defined group of users + +**service level specification:** specification of the minimum acceptable standard of service + +**SLA requirements:** service and network requirements derived from SLAs. + +NOTE: A provider may add additional requirements not directly derived from SLA's, associated to provider internal [business] goals. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|-------|-------------------------------------------| +| CFCS | Customer Facing Communication Service | +| CS | Communication Service | +| CSC | Communication Service Customer | +| CSMF | Communication Service Management Function | +| CSP | Communication Service Provider | +| NMF | Network Management Function | +| NSaaS | NetworkSlice as a Service | +| NSI | Network Slice Instance | +| NSMF | Network Slice Management Function | +| RFCS | Resource Facing Communication Service | +| SLA | Service Level Agreement | +| SLS | Service Level Specification | + +# --- 4 Concepts and background + +## 4.1 Types of communication services + +Communication Service (CS) is offered by a communication service provider to its customers to fulfil their requested communication service requirements. The types of communication service customers include B2B, B2C, B2H and B2B2X, see clause 4.1.2 of TS 28.530 [3]. A communication service can be provided as an end-user service or as a business service [3]. + +Communication services offered by Communication Service Providers (CSPs) to Communication Service Customers (CSCs) are of various categories. Communication services can be classified from different dimension views according to the purpose of classification. + +To investigate different business models or different roles involved from business models perspective, using types of service consumers as the service classification criteria, communication services can be classified as business to consumer (B2C) services, business to business (B2B) services, business to household (B2H) services and business to business to everything (B2B2X) services, see clause 4.1.2 of TS 28.530 [3]. Two business models as "Network Slice as a Service (NSaaS)" and "Network Slices as NOP internals" are documented in clauses 4.1.6 and 4.1.7 of TS 28.530 [3]. + +Examples of the categories of communication services from performance requirements perspective, are eMBB, URLLC and MIoT, see clause 4.1.4 of TS 28.530 [3]. + +- EMBB service type aims at supporting performance requirements of high data rates and high traffic densities, see Table 7.1-1 "Performance requirements for high data rate and traffic density scenarios" of TS 22.261 [4]. +- URLLC service type aims at supporting performance requirements of low-latency and high-reliability, see Table 7.2.2-1 "Performance requirements for low-latency and high-reliability services" of TS 22.261 [4]. +- MIoT service type aims at supporting performance requirements of large number and high density of IoT devices, see clause 4 of TS 22.261 [4]. + +## 4.2 Management aspects of communication services + +### 4.2.1 Customer, service and resource views + +A communication service can be described from the perspective of a customer that orders and consumes the communication service and from the perspective of a CSP that offers and provides the communication service. + +A communication service can be realized by the instantiation of a communication service, based on communication service description(s) with the information applicable to the communication service instance. The communication service information is mapped to resource information to realize the communication service. + +### 4.2.2 Communication service management function + +The CSMF is described in [5] and involves provisioning and management of communication service instances. Part of his role is to request the necessary resources to realize the communication service instances. The request for the resources includes service specific instance information to be used by the resource management to realize the communication service instance. + +![Figure 4.2.2.1: Diagram showing the hierarchy of communication service management functions. At the top is 'Ordrecare'. Below it is a large box labeled 'CSMF' on the left side. Inside this box are two dashed boxes: 'CSMF Customer aspects' and 'CSMF Service and resource aspects'. Below the CSMF box is 'NSMF', and at the bottom is 'NSSMF'.](1eadbbe42cfcac5c0023577110aec5e3_img.jpg) + +Figure 4.2.2.1: Diagram showing the hierarchy of communication service management functions. At the top is 'Ordrecare'. Below it is a large box labeled 'CSMF' on the left side. Inside this box are two dashed boxes: 'CSMF Customer aspects' and 'CSMF Service and resource aspects'. Below the CSMF box is 'NSMF', and at the bottom is 'NSSMF'. + +**Figure 4.2.2.1: Customer aspects as well as, service and resource aspects regarding CSMF** + +The CSMF is split into two parts where one of them is related to customer aspects and the other is related to the service and resource aspects. Figure 4.2.2.2 depicts the CSMF functionalities. + +![Figure 4.2.2.2: Diagram showing the functional split of the CSMF. At the top is 'Ordrecare' and 'CSC'. Below them is a large box labeled 'CSMF' on the right side. Inside this box are two horizontal sections. The top section is labeled 'CFCS' and contains four boxes: 'Service Design', 'Service SLA Input/Translation', 'Service Catalogue', and 'Capability Exposure'. The bottom section is labeled 'RFCS' and contains four boxes: 'CSI Resource Inventory', 'CSI LCM', 'Fault Supervision of CSI', and 'Performance Assurance of CSI'.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +Figure 4.2.2.2: Diagram showing the functional split of the CSMF. At the top is 'Ordrecare' and 'CSC'. Below them is a large box labeled 'CSMF' on the right side. Inside this box are two horizontal sections. The top section is labeled 'CFCS' and contains four boxes: 'Service Design', 'Service SLA Input/Translation', 'Service Catalogue', and 'Capability Exposure'. The bottom section is labeled 'RFCS' and contains four boxes: 'CSI Resource Inventory', 'CSI LCM', 'Fault Supervision of CSI', and 'Performance Assurance of CSI'. + +**Figure 4.2.2.2: CSMF functionalities** + +CFCS aspect provides the following functions and services: + +- **Service Design:** It defines parameters for service provisioning, including parameter name, parameter type, allowed value and range of the service parameters and so on. +- **Service SLA Input and Translation:** It receives service SLA from CSC and translates the SLA into resource aspect related requirements, e.g. service profile for the instantiation of network slice instance. +- **Service Catalogue:** It stores the service profile information which represents the communication service type and capability. +- **Capability exposure:** It handles exposure of communication service management capability to CSC, e.g. communication service instance performance monitoring. + +RFCS aspect manages the resource aspects of the communication service instance (CSI). RFCS aspect provides the following functions and services: + +- **CSI resource inventory:** It stores the identifications of the CSI resources (e.g. CSI ID, NSI ID), including those that are currently in use, and those that are available to be allocated. It also stores the mapping relationship between the CSI and the resource e.g. NSI, as well as the real time communication service resource availability and capability information according to the feedback or notification from NSMF. CSIs are allocated, modified and deallocated, and the corresponding network resource information is updated during CSI life cycle management. It maintains the CSI resource availability status. +- **CSI LCM:** It manages CSI lifecycle e.g. through requesting NSMF to allocate/deallocate/modify network resources for the CSI. It also does the feasibility check for a new CSI request. The NSMF notifies CSMF the network resource LCM status so that the CSI can update the CSI resource inventory accordingly. +- **Fault Supervision of CSI:** It collects CSI level fault supervision information. The closed loop management should be operated through interaction between CSMF and other OAM functions e.g. NSMF, MDAF. +- **Performance Assurance of CSI:** It collects CSI level performance measurement information and supports SLS assurance. CSMF needs to collaborate with other OAM functions, e.g. NSMF, MDAF, for this purpose. + +### 4.2.3 Lifecycle of communication service + +Lifecycle of a communication service instance (CSI) includes the following phases: + +#### - **Preparation phase:** + +Providing a communication service instance (CSI) starts with preparation of CSI, which includes service design, pre-planning, feasibility check, i.e., checking the attainable service quality from both resource and service aspects, negotiation of the service attributes, preparing service and network requirements derived from SLA. + +#### - **CSI commissioning phase:** + +Once the CSI is prepared, it can be established by converting the communication service requirement for the CSI to network requirements and creation of the CSI. When the CSI is created, it is deployed on the network resources and ready to be activated. + +#### - **CSI operation phase:** + +After the commissioning phase, the CSI is activated. An activated CSI allows run-time operation of the communication service, e.g., quality assurance, data exposure, CSI modification. Optimization of CSI utilization may continue during the operation phase of the CSI. + +#### - **CSI decommissioning phase:** + +When the CSI is no longer needed, after being de-activated, lifecycle of the CSI ends with CSI termination. + +![Flowchart showing the lifecycle of a communication service instance (CSI) with four sequential steps: Preparation, CSI Commissioning, CSI Operation, and CSI Decommissioning.](e58a867750e4ae01604318506b79df7a_img.jpg) + +``` + +graph LR; + A[Preparation] --> B[CSI Commissioning]; + B --> C[CSI Operation]; + C --> D[CSI Decommissioning]; + +``` + +Flowchart showing the lifecycle of a communication service instance (CSI) with four sequential steps: Preparation, CSI Commissioning, CSI Operation, and CSI Decommissioning. + +Figure 4.2.3.1: Lifecycle of a communication service instance + +### 4.2.4 Relation of CSI lifecycle to NSI lifecycle + +#### 4.2.4.0 Introduction + +Resource facing aspects of CSI lifecycle involve interactions with NSI lifecycle. It is to be noted that except for certain situations when a CSI LCM operation triggers a NSI LCM operation, CSI-NSI lifecycles are independent. The following clauses show the cases when a CSI LCM operation triggers a NSI LCM operation. + +#### 4.2.4.1 CSI LCM operation triggering NSI creation + +During the "CSI commissioning" phase the provider of the communication service may run a trial for instance before the SLA (including SLS) is agreed. The trial period may be needed to allow the shared network slice resources to learn and adapt the resource allocation and configuration to changed traffic flows associated with the CSIs and their target KPI's. + +![Diagram showing the relationship between CSI and NSI lifecycles. The top path represents the 'Communication Service Lifecycle' with stages: Service Facing Aspects -> Prepare Service Requirements -> CSI Commissioning (Deployment to NSI) -> CSI Operation (Communication Service Update) -> CSI Decommissioning. The bottom path represents the 'Parallel functioning of associated NSI Lifecycle' with stages: NSI Commissioning (NSI Preparation -> NSI Creation) -> NSI Operation (NSI Modification) -> NSI Decommissioning. Arrows indicate that CSI Commissioning triggers NSI Commissioning, and there is a bidirectional interaction between CSI Operation and NSI Operation.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +Diagram showing the relationship between CSI and NSI lifecycles. The top path represents the 'Communication Service Lifecycle' with stages: Service Facing Aspects -> Prepare Service Requirements -> CSI Commissioning (Deployment to NSI) -> CSI Operation (Communication Service Update) -> CSI Decommissioning. The bottom path represents the 'Parallel functioning of associated NSI Lifecycle' with stages: NSI Commissioning (NSI Preparation -> NSI Creation) -> NSI Operation (NSI Modification) -> NSI Decommissioning. Arrows indicate that CSI Commissioning triggers NSI Commissioning, and there is a bidirectional interaction between CSI Operation and NSI Operation. + +Figure 4.2.4.1.1: NSI is exclusively used for CSI + +#### 4.2.4.2 CSI LCM operation triggering NSI modification + +![Diagram illustrating how CSI LCM operations trigger NSI modifications. It shows two services sharing a network slice. Service 1's lifecycle (Service Facing Aspects -> Prepare Service 1 Requirements -> CSI_1 Commissioning -> CSI_1 Operation) triggers NSI preparation. Service 2's lifecycle (Service Facing Aspects -> Prepare Service 2 Requirements -> CSI_2 Commissioning -> CSI_2 Operation -> CSI_2 Decommissioning) also interacts with the shared NSI. The shared NSI lifecycle includes NSI Commissioning, NSI Operation (NSI Supervision, NSI Reporting, Modify), and NSI Decommissioning. Arrows show that both CSI_1 and CSI_2 operations can trigger 'Modify' actions on the shared NSI. A note indicates that the modification of the NSI to provide service 2 is done here (deployment, operation and removal of the service).](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +Diagram illustrating how CSI LCM operations trigger NSI modifications. It shows two services sharing a network slice. Service 1's lifecycle (Service Facing Aspects -> Prepare Service 1 Requirements -> CSI\_1 Commissioning -> CSI\_1 Operation) triggers NSI preparation. Service 2's lifecycle (Service Facing Aspects -> Prepare Service 2 Requirements -> CSI\_2 Commissioning -> CSI\_2 Operation -> CSI\_2 Decommissioning) also interacts with the shared NSI. The shared NSI lifecycle includes NSI Commissioning, NSI Operation (NSI Supervision, NSI Reporting, Modify), and NSI Decommissioning. Arrows show that both CSI\_1 and CSI\_2 operations can trigger 'Modify' actions on the shared NSI. A note indicates that the modification of the NSI to provide service 2 is done here (deployment, operation and removal of the service). + +Figure 4.2.4.2.1: CSI LCM operation triggering modification of a NSI shared by two CSIs + +The modification step may necessitate a trial being performed to allow for learning and adapting the resource allocation and configuration to shared NSI. + +#### 4.2.4.3 CSI LCM operation triggering NSI activation and deactivation + +The LCM operation of an NSI is independent of the LCM operation of CSIs using the NSI. When CSIs share an NSI there is no constraints on the termination of the CSIs. For example, CSI\_1 is created before CSI\_2: CSI\_1 could then be + +terminated first, or CSI\_2 could be terminated first, both options are possible. Even more options are possible if CSI\_3... to CSI\_N are added. + +![Figure 4.2.4.3.1: CSI LCM operation triggering activation/deactivation of a NSI shared by two CSIs. The diagram illustrates the lifecycle of two communication services (CSI_1 and CSI_2) that share a Network Service Instance (NSI). CSI_1's lifecycle includes Service 1 Facing Aspects, Prepare Service 1 Requirements, CSI_1 Commissioning Deployment to NSI, CSI_1 Operation, and CSI_1 Decommissioning. CSI_2's lifecycle includes Service 2 Negotiation, Prepare Service 2 Requirements, CSI_2 Commissioning Deployment to NSI, CSI_2 Operation, and CSI_2 Decommissioning. The shared NSI lifecycle includes NSI Preparation, NSI Creation, NSI Commissioning, NSI Operation (with Supervision, Reporting, and Modify), NSI Decommissioning, and NSI De-activation. CSI_1's Commissioning triggers NSI preparation. CSI_2's Commissioning triggers NSI Activation. The diagram shows that CSI_1's Decommissioning leads to NSI Decommissioning, which in turn leads to NSI De-activation, which then leads to NSI Commissioning for CSI_2. CSI_2's Commissioning leads to NSI Operation, which leads to NSI Decommissioning, which then leads to NSI De-activation, which then leads to NSI Commissioning for CSI_1. A 'New service (CSI_2) trigger NSI Activation' box is also shown.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +Figure 4.2.4.3.1: CSI LCM operation triggering activation/deactivation of a NSI shared by two CSIs. The diagram illustrates the lifecycle of two communication services (CSI\_1 and CSI\_2) that share a Network Service Instance (NSI). CSI\_1's lifecycle includes Service 1 Facing Aspects, Prepare Service 1 Requirements, CSI\_1 Commissioning Deployment to NSI, CSI\_1 Operation, and CSI\_1 Decommissioning. CSI\_2's lifecycle includes Service 2 Negotiation, Prepare Service 2 Requirements, CSI\_2 Commissioning Deployment to NSI, CSI\_2 Operation, and CSI\_2 Decommissioning. The shared NSI lifecycle includes NSI Preparation, NSI Creation, NSI Commissioning, NSI Operation (with Supervision, Reporting, and Modify), NSI Decommissioning, and NSI De-activation. CSI\_1's Commissioning triggers NSI preparation. CSI\_2's Commissioning triggers NSI Activation. The diagram shows that CSI\_1's Decommissioning leads to NSI Decommissioning, which in turn leads to NSI De-activation, which then leads to NSI Commissioning for CSI\_2. CSI\_2's Commissioning leads to NSI Operation, which leads to NSI Decommissioning, which then leads to NSI De-activation, which then leads to NSI Commissioning for CSI\_1. A 'New service (CSI\_2) trigger NSI Activation' box is also shown. + +Figure 4.2.4.3.1: CSI LCM operation triggering activation/deactivation of a NSI shared by two CSIs + +### 4.2.5 Performance assurance of communication services + +Performance assurance of communication services includes the following aspects: + +- Performance monitoring of communication services; +- Performance analytics of communication services; +- Performance guarantee of communication services. + +These aspects are responsible for restoring the communication service performance for customers to a level specified in the SLS or other service KQI descriptions as soon as possible. + +## 4.3 Management layers + +The high-level view of management layers is provided by ITU-T and can be found in M.3010 [8]. Figure 4.3.1 shows the relation between the communication service model and the business, service and network management layer specified in [8]. + +![Figure 4.3.1: Management model for management of communication services. The diagram shows three management layers: Business management layer, Service management layer, and Network management layer. The Business management layer contains 'product' and 'customer' boxes, with a 'Service order' line connecting them. The Service management layer contains the 'CSMF' box, which includes 'CustomerFacingCS' and 'ResourceFacingCS' boxes, and a 'ResourceFacingCSProfile' box. The Network management layer contains the 'NMF' box, which includes the 'MobileNetworkService' box. Arrows indicate the flow of management information: from 'product' to 'CustomerFacingCS', from 'CustomerFacingCS' to 'ResourceFacingCS', from 'ResourceFacingCS' to 'ResourceFacingCSProfile', from 'ResourceFacingCS' to 'MobileNetworkService', and from 'MobileNetworkService' to 'NMF'.](5dfc130b129ace4df375839020a5700d_img.jpg) + +Figure 4.3.1: Management model for management of communication services. The diagram shows three management layers: Business management layer, Service management layer, and Network management layer. The Business management layer contains 'product' and 'customer' boxes, with a 'Service order' line connecting them. The Service management layer contains the 'CSMF' box, which includes 'CustomerFacingCS' and 'ResourceFacingCS' boxes, and a 'ResourceFacingCSProfile' box. The Network management layer contains the 'NMF' box, which includes the 'MobileNetworkService' box. Arrows indicate the flow of management information: from 'product' to 'CustomerFacingCS', from 'CustomerFacingCS' to 'ResourceFacingCS', from 'ResourceFacingCS' to 'ResourceFacingCSProfile', from 'ResourceFacingCS' to 'MobileNetworkService', and from 'MobileNetworkService' to 'NMF'. + +Figure 4.3.1: Management model for management of communication services + +The customers of a service provider (a subscriber or an enterprise) are not directly connected to the CFCSs. The customer is connected via the products in the portfolio of the service provider (a product is offered to the customers of a service provider). One of the aspects on the business management layer is the definition of the products, the product characteristics and their relation to a customer. For example, a CSP agrees on requirements and documents them in a Service Level Specification (SLS) with the customer. The SLS requirements can be part of a product definition to allow the CSP e. g. to offer same product definition to other customers. This relationship belongs to the business management layer and is not subject to standardization. + +A service order to provide a communication service comes from the business management layer to the service management layer. The order contains information about the communication service to be provided to the customer. The information includes service specific information, i.e. attributes and values that are needed to configure the communication service, and customer specific information, i.e. attributes and values that are needed to configure the service for a specific customer (for example endpoints, coverage, and QoS, QoE attributes). + +The information from a CFCS is mapped or converted to RFCS information and depending on the type of service additional attributes may be needed for the configuration of an RFCS. The RFCSProfile describes a specific RFCS type that can be instantiated with a new service order. + +The service order for provisioning of a new communication service is converted to a request to the network management layer (NMF) to allocate a network slice [8] and allocate or configure the associated network slice subnets [8]. Depending on the communication service requirements the network management layer either creates a new network slice for the request or modifies, an existing network slice and let the new communication service use the existing network slice. The procedures for network slice allocation and network slice subnet allocation and configuration are described in TS 28.531 [8]. + +### NSaaS + +Network slice as a Service is specified in TS 28.530 [8] and used in a number of use cases. The NSaaS aspects are managed on the service management layer while the resource aspects are managed on the network management layer. The request for NSaaS comes to the service management layer and will be translated into one or more resource requests on the network management layer. The associated service profile(s) [7] specifies the network attributes that need to be configured for the customer to use the network slice as a service. In this scenario the CSMF layer receives the request for NSaaS from the business management layer including the service management requirements derived from the SLS. + +## 4.4 Management model + +### 4.4.1 Introduction + +A CSP has to administrate communication services both from the view of the customer and from the view of the resource. The administration from the view of the customer is about information in relation to the business agreement for example address, SLA information, etc. The administration of a communication service from the view of the resources is about information on the relation between the communication service and the resources being used, the behaviour of the resources and how this impacts the users of the communication service. + +NOTE: The meaning of SLA information in the context of the present document is as follows: A CSP and a CSC have a business agreement of which the SLA is a part of. The service and network requirements are derived from an SLA/SLS (for example performance management metrics for eMBB on delay and latency). + +### 4.4.2 Description + +The administration of a customer facing communication service (CFCS) and the administration of a resource facing communication service (RFCS) are the responsibility of different organisations within a CSP. Administration of CFCSs includes the administration of the business aspects between the CSP and the CSC. For example, what actions the CSP is to take in case an SLA is breached. This interaction takes place northbound of the customer facing part of the CSMF which maintains the relationship between the customer and the communication service(s). Not meeting the SLS (as part of the SLA) may result in concrete actions to be performed towards the resources, this interaction takes place between the RFCS and the resources. + +The entities and the relationship are shown in Figure 4.4.2.1. a more detailed description is provided below Figure 4.4.1. + +![Diagram illustrating relationships between entities: Customer, CustomerFacingCS, ResourceFacingCS, ResourceFacingCSProfile, and Resources. The diagram shows a flow from Customer to CustomerFacingCS (labeled <orders>), then to ResourceFacingCS (labeled <uses>), which is described by ResourceFacingCSProfile (labeled <isDescribedBy>). ResourceFacingCS then uses Resources (labeled <uses>). A dashed box labeled CSMF encloses CustomerFacingCS, ResourceFacingCS, and ResourceFacingCSProfile.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +graph TD + Customer[Customer] -- "<orders>" --> CustomerFacingCS[CustomerFacingCS] + subgraph CSMF + CustomerFacingCS -- "<uses>" --> ResourceFacingCS[ResourceFacingCS] + ResourceFacingCS -- "<isDescribedBy>" --> ResourceFacingCSProfile[ResourceFacingCSProfile] + end + ResourceFacingCS -- "<uses>" --> Resources[Resources] + +``` + +Diagram illustrating relationships between entities: Customer, CustomerFacingCS, ResourceFacingCS, ResourceFacingCSProfile, and Resources. The diagram shows a flow from Customer to CustomerFacingCS (labeled ), then to ResourceFacingCS (labeled ), which is described by ResourceFacingCSProfile (labeled ). ResourceFacingCS then uses Resources (labeled ). A dashed box labeled CSMF encloses CustomerFacingCS, ResourceFacingCS, and ResourceFacingCSProfile. + +**Figure 4.4.2.1: Example of relationships shown between different entities** + +A CSP receives an order or request from a customer to provide a communication service. With the reception and acceptance of the order, the administration and management of communication services begins. The order from the customer is processed and mapped to a Customer Facing Communication Service (CFCS). + +The CSCF is what the customer will see and recognize, which is not the same as which resources are configured and used to provide the communication service to the customer. + +The CFCS uses the RFCS, the RFCS represents a communication service instance for a specific customer. A customer may have multiple RFCS (for example eMBB#1, eMBB#2 and mIoT#1). An RFCS uses resources or uses resource services. An example of a resource service is the NSaaS, an example of resources is a RAN resource, CN resources or TN resources. + +The provisioning of a RFCS can be done using a set of parameters that are applicable to each instance of an RFCS. This set of parameters is called the RFCS profile. Multiple RFCS profile can be supported depending on the different types of RFCS that can be supported by the resources. The RFCS profile holds all information that is needed to describe the capabilities of an RFCS. The management function creates a new RFCS when a request is received, the parameters from the RFCS profile are added to the new RFCS with the values of the parameters populated with information from the request. + +### 4.4.3 Communication services applied to network slicing + +In a network slicing scenario, the resources used by an RFCS are captured by the network slicing model. The CSP could have different types of RFCS where each type is described by a ResourceFacingServiceProfile consisting of a pre-defined set of attributes. A request for an RFCS involves the creation on an instance of an RFCS using the attributes of the selected ResourceFacingServiceProfile with the information from the request. + +The RFCS instance uses an NSI, the RFCS instance is bound to an NSI instance at instantiation time. The management system needs to allocate an appropriate NSI to support the RFCS. Depending on the NSI capabilities many RFCS may use a single NSI. The NSI capabilities are described by the set of ServiceProfiles it supports. A single RFCSProfile maps to a single ServiceProfile supported by the NSI. + +The communication service always uses resources from the RAN, CN and TN domain otherwise there would not be a connection for the Communication Service to use. The top-level NSSI aggregates the resources of the domain NSSI's, and through 1:1 relationship with the NSI the top-level NSSI does not require an association with any profile, this information is already captured by the ServiceProfiles supported by the NSI. + +The lower level or domain NSSI's as per slicing model in TS 28.541 [7] may be associated with one or more SliceProfiles. + +![UML Class Diagram showing relationships between CustomerFacingCS, ResourceFacingCS, ResourceFacingServiceProfile, ServiceProfile, NSI, and Top-level NSSI.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +classDiagram + class CustomerFacingCS + class ResourceFacingCS + class ResourceFacingServiceProfile + class ServiceProfile + class NSI + class Top-levelNSSI + + CustomerFacingCS -- ResourceFacingCS + ResourceFacingServiceProfile "1" -- "1" ResourceFacingCS + ResourceFacingCS "*" -- "1" NSI + NSI "1" -- "*" ServiceProfile + NSI "1" -- "1" Top-levelNSSI + +``` + +The diagram illustrates the following relationships: + +- CustomerFacingCS** is associated with **ResourceFacingCS**. +- ResourceFacingServiceProfile** (multiplicity 1) is associated with **ResourceFacingCS** (multiplicity 1). +- ResourceFacingCS** (multiplicity \*) is associated with **NSI** (multiplicity 1). +- NSI** (multiplicity 1) is associated with **ServiceProfile** (multiplicity \*). +- NSI** (multiplicity 1) is associated with **Top-level NSSI** (multiplicity 1). + +UML Class Diagram showing relationships between CustomerFacingCS, ResourceFacingCS, ResourceFacingServiceProfile, ServiceProfile, NSI, and Top-level NSSI. + +Figure 4.4.3.1: Example of relationships shown between different entities + +## 4.5 Communication services + +### 4.5.1 Introduction + +Various organizations are involved in the specification of information that is relevant for B2B customers of a CSP. The information can be used between CSP and CSC to agree on the characteristics of service using network slices. This clause captures the concept from GSMA. + +### 4.5.2 GSMA GST/NEST + +The Generic Network Slice Template (GST) is a set of attributes that can characterise a type of network slice. One or more NSIs (Network Slice Instance) can be created out of the same type based on the requirements. GST is generic and is not tied to any specific network deployment, see GST defined in GSMA [12]. Some of GST attributes are embodied as some attributes of ServiceProfile [7], for example, GST attribute "Isolation level" [12] is mapped to ServiceProfile attribute "resourceSharingLevel" [7]. + +The Network Slice Type (NEST) is a GST filled with values. Some of NEST attributes are embodied as some attributes of ServiceProfile [7] filled with values, for example, NEST attribute "Isolation level" with value = 0 [12] is mapped to ServiceProfile attribute "resourceSharingLevel" [7] with value = shared. + +Figure 4.x.2-1, as an example, shows the mapping relation of 3GPP ServiceProfile and GSMA GST/NEST in context of the network slice lifecycle. Network Slice Customer (NSC) acts as CSC (see Figure 1 of GST [12]), CSMF acts as CSP, and NSMF prepares NSIs based on attributes values of ServiceProfile [7] which is a mapping of GST/NEST. + +![Figure 4.5.1.1: Mapping of 3GPP ServiceProfile and GSMA GST/NEST in context of the network slice lifecycle. The diagram shows a flow from NSC to Use Case, then to Service Requirements and Technical Requirements. These lead to a dashed box containing GST and NEST. NEST points to Network Slice Instance Preparation and also to a ServiceProfile box (defined in TS 28.541) filled with values.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +graph LR + NSC[NSC] --> UC[Use Case] + UC --> SR[Service Requirements] + UC --> TR[Technical Requirements] + SR --> GST_NEST((GST +NEST)) + TR --> GST_NEST + GST_NEST --> NSIP(Network Slice Instance Preparation) + GST_NEST --> SP[ServiceProfile +(defined in TS 28.541) +filled with values] + +``` + +Figure 4.5.1.1: Mapping of 3GPP ServiceProfile and GSMA GST/NEST in context of the network slice lifecycle. The diagram shows a flow from NSC to Use Case, then to Service Requirements and Technical Requirements. These lead to a dashed box containing GST and NEST. NEST points to Network Slice Instance Preparation and also to a ServiceProfile box (defined in TS 28.541) filled with values. + +**Figure 4.5.1.1: Mapping of 3GPP ServiceProfile and GSMA GST/NEST in context of the network slice lifecycle** + +## 4.6 SLS assurance + +### 4.6.1 Description + +The NOP needs to take into account their customers' requirements in planning, provision and optimization phases of the network, which may include: + +- Receive the service request from the customer. +- Identify which SLS that management system could guarantee with the network management capabilities. +- Identify what other information except the management data may be needed to support management decision. + +### 4.6.2 Management cooperation with 5GC and NG-RAN + +Coordination may be needed between the management, 5GC and NG-RAN domains as shown in the figure 4.6.2.1. The management domain provides the SLS assurance from the management perspective. Core and RAN contribute to the fulfilment of network slice SLS from the control plane and user plane perspective. + +![Figure 4.6.2.1: Cooperation between management, 5GC and NG-RAN domains following Hybrid-SON. The diagram shows a central Management control loop (C-SON) with four stages: Collection, Analysis, Decision, and Execution. This loop is connected to two signaling control loops (D-SON): 5GC (Distributed analytics) and NG-RAN (Distributed analytics). The 5GC and NG-RAN loops are also connected to each other.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +``` + +graph TD + subgraph C-SON [Management control loop (C-SON)] + C1((Collection)) --> C2((Analysis)) + C2 --> C3((Decision)) + C3 --> C4((Execution)) + C4 --> C1 + M[Management +(centralized analytics)] + end + subgraph D-SON_5GC [Signaling control loop (D-SON)] + 5GC[5GC +(Distributed analytics)] + end + subgraph D-SON_NGRAN [Signaling control loop (D-SON)] + NG-RAN[NG-RAN +(Distributed analytics)] + end + C-SON <--> D-SON_5GC + C-SON <--> D-SON_NGRAN + D-SON_5GC <--> D-SON_NGRAN + +``` + +C-SON: Centralized SON +D-SON: Distributed SON + +Figure 4.6.2.1: Cooperation between management, 5GC and NG-RAN domains following Hybrid-SON. The diagram shows a central Management control loop (C-SON) with four stages: Collection, Analysis, Decision, and Execution. This loop is connected to two signaling control loops (D-SON): 5GC (Distributed analytics) and NG-RAN (Distributed analytics). The 5GC and NG-RAN loops are also connected to each other. + +**Figure 4.6.2.1: Cooperation between management, 5GC and NG-RAN domains following Hybrid-SON** + +## 4.7 Service QoE + +### 4.7.1 Description + +The QoE information is information collected by the end user application in the UE. The QoE information can be also collected by a collection centre for analysis and/or KPI calculations [10]. + +Service QoE is analytics data from QoE information of user related to CSI. How to analyse collected QoE information and calculate the result of Service QoE may be defined by NOP or CSP/CSC. For example, the Service QoE can be a weighted average experience of multiple user applications using CSI. Percentage of users satisfied in a given CSI may also be the analytics result and can be used as Service QoE for the CSI. + +Service QoE may be used for supporting SLS fulfilment. + +### 4.7.2 Service QoE collection and service quality assurance + +If there is no methodology model to map end user QoE requirements into resource aspect related requirements, the end user service QoE information cannot be deduced from performance measurements in the network. There are two types of methods for service QoE collection: + +- For DASH and MTSI user services in TS 28.404 [10], user QoE information is measured and collected by the user application in the UE. A collection centre collects user QoE information for a specified user service/user service type either from UEs in a specified area or a specific UE in UMTS and LTE. For 5G network MDAS may collect and analyse the user QoE information. Service QoE of given CSI is an analytic result of user QoE information. +- For other user services, user QoE information is measured or collected by the application server of CSC or CSP. In TS 23.288 [11] the NWDAF collects data from applications and provides analytics data services. The management system may get analytic results by consuming the analytics data services provided by NWDAF. The analytic result from NWDAF may be used as Service QoE. + +In the case of Network Slices as NOP internal, the Service QoE may help the management system to optimize the resources of CSI and guarantee the performance. + +In the case of Network Slice as a Service, the Service QoE of CSIs which is using NSI may help the management system for SLS assurance. + +# --- 5 Potential use cases and requirements + +## 5.1 Management data analytics and automated service assurance + +### 5.1.1 Service quality assurance and optimization of the services + +#### 5.1.1.1 Description + +The goal of the use case is to enable service quality assurance and optimization for the set of services provided by the network to certain group (category) of the UEs. For example, the set can include the services provided via certain NSI(s) or to IoT devices in certain area. + +It is assumed that the relevant NFs are deployed and active in NG-RAN and 5GC. The group of NG-RAN and 5GC nodes, which are essential for the set of E2E services, provide provisioning and PM management services. It is also assumed that the providers of the related NSI / NSSI provisioning and PM management services are deployed and active. + +The management system is consuming above management services either directly or through proxy nodes that re-exposure the management services; the management system is aware of the performance requirements imposed on the set of services. + +The management system is collecting the network data and monitoring the performance indicators related to the targeted services. Analytics hosted by the MDAAF may be utilized for processing of the network data to derive and analyse the performance indicators. If the service quality assurance and optimization function detects performance + +degradation or potential for improvement of the targeted performance indicators, it modifies the configuration parameters in the corresponding NG-RAN and 5GC nodes and NSI(s)/NSSI(s), using the NG-RAN, 5GC, and NSI(s)/NSSI(s) (where relevant) provisioning services, and continues monitoring the performance. + +If the network performance does not recover / improves, the management system may adjust the modifications, for example roll back to previous configuration. In any case it continues collection of the network data and monitoring of the performance indicators. + +#### 5.1.1.2 Potential requirements + +**REQ-CSM\_SAO-CON-01** The network management system shall have the capability to be configured with the target communication service performance indicators for a set of communication services supplied to a group or category of UEs. + +**REQ-CSM\_SAO-CON-02** The network management system shall have the capability to collect network data and analyse performance indicators related to the set of communication services supplied to a group or category of UEs. + +**REQ-CSM\_SAO-CON-03** The network management system shall have the capability to modify the configuration parameters in the NG-RAN and 5GC nodes and NSI(s)/NSSI(s), related to the set of communication services supplied to a group or category of UEs + +### 5.1.2 CSI monitoring + +#### 5.1.2.1 Description + +After the CSI provisioning, the 3GPP management system monitors the KPIs of CSI resource part, i.e. SLA related performance metrics. According to the KPIs of CSI resource part, the 3GPP management system can evaluate SLA fulfilment by ensuring that service requirements are fulfilled by the CSI resource part. + +The 3GPP management system may provide the KPIs of CSI resource part to the CSI to authorized CSI service provider or CSI service consumer to let them check whether the service SLA requirements are met. + +#### 5.1.2.2 Potential requirements + +**REQ-CSM\_CSI-MON-01** The 3GPP management system shall have the capability of monitoring CSI resource part and evaluating SLA fulfilment. + +**REQ-CSM\_CSI-MON-02** The 3GPP management system shall have the capability of providing KPIs of CSI resource part to authorized CSI service provider or CSI service consumer. + +### 5.1.3 SLS monitoring for network slicing + +#### 5.1.3.1 Description + +An SLS will contain information that will be broken down to service requirements that are conveyed to the CSP by the CSC. The service requirements may be used to provision a network slice instance. + +After the network slice provisioning, the CSP and /or CSC may need to monitor the SLS status of the NSI to make sure whether its service requirements are achieved. In the service based management architecture, subscribe-notify and request-response style interactions between the communication services management function and network slice management function can be utilized. Network slice management function reports the SLS related network slice level KPIs and end user traffic level QoS/QoE parameters. The reporting can be periodic, or event based. Communication services management function may also invoke the SLS monitoring related APIs provided by the network slice management function. Network slice management function collects network slice domain specific operating data from the constituent network slice subnet management functions. Aggregating, analysing and processing the data into E2E network slice level operating parameters and presents them to the communication services management function. + +A new slice may be created with dedicated 5GC resource e.g. dedicated SMF/UPF/PCF. Usually 5GC resource is enough while NG RAN is the bottleneck. In the radio access network, QoS of user traffics and cell KPIs may be degraded due to many factors such as congestion, coverage issues, interference, shortage of radio resources etc. In such cases, there is a risk to guarantee the E2E SLSs of one or more network slice instances for all the UEs from the CSC all the time. + +The networks outside of the 3GPP operators are out of control of the 3GPP operators and may be exceptional for the SLA negotiation, e.g. the outside transport networks or DCs of third parties and the applications etc. + +The number users of the network slice (customers of the CSC) is slowly increased while the network slice resources adapt to changing traffic characteristics. What slice customer care is, how many subscribers (e.g. 1 million) can be served by the slice and the Service Experience statistics per application (e.g. average Service MOS 4.0 for Application X for the slice customer) and how many percent (e.g. 90 % for Application X) UEs' service experience satisfy per application ID, see clause 6.32 of TR 23.791 [6]. Therefore, the CSPs may need to monitor the SLS status of the NSI for those aspects. + +When a performance degradation impacts the service requirements the management system reconfigures the resources to resolve the performance degradation, in case the degradation cannot be resolved the management system may restrict the total number of active users. + +During the runtime phase of network slice, as consequence of SLS monitoring the management system may adjust reserved resources for the network slice to improve service experiences and ensure SLS according to the activity prediction of users provided by NWDAF, as well as resource adjustment recommendation provided by MDAF. + +#### 5.1.3.2 Potential requirements + +**REQ-CSM\_SLS-CON-01** The 3GPP management system shall have the capability monitoring the performance metrics related to the SLA. + +**REQ-CSM\_SLS-CON-02** The 3GPP management system shall have the capability consuming the data related to QoE provided by for example an NWDAF. + +**REQ-CSM\_SLS-CON-03** The 3GPP management system shall have the capability evaluating the QoE data provided by an NWDAF to trigger actions if the network slice performance requirements are not met. + +**REQ-CSM\_SLS-CON-04** The 3GPP management system shall have the capability configuring reserved resources in RAN potentially to be used for a new network slice instance. + +**REQ-CSM\_SLS-CON-05** The 3GPP management system shall have the capability to consume activity prediction of the users from, for example, historical data in NWDAF. + +**REQ-CSM\_SLS-CON-06** The 3GPP management system shall have the capability to consume the Management Data Analytics Service for the purpose of SLS assurance. + +### 5.1.4 MDA-Assisted network provisioning contributing to SLS assurance + +#### 5.1.4.1 Description + +The 5G network can support different services with various QoS parameters. The QoS parameters are maintained by the system during the lifetime of the network. + +Utilizing MDAF to provide big data analytics in order to help the management system functions to derive suitable network topology (e.g. VNF chains, network configurations etc.) to guarantee the service assurance given by the vertical customers from the network provisioning aspect. After the network is setup with the suitable configurations, the control plane and user plane could do further adjustment (e.g. with UE session control etc.) to improve the individual user experiences. + +In this case, management system needs to identify which service requirements that are related to the network management system for the purpose of network or network slice deployment, and which type of information that could be provided to MDAF for the analytics. + +For communication service provisioning, CSMF translates customer level SLA into communication service requirements, and analyses the network capability to determine whether to map the CSI to an existing NSI or a new NSI. This operation is performed in the CSI or NSI planning phase. MDAF can be utilized to assist such planning. MDAF may get SLS requirements as input from CSMF and provide analytical information which may include network performance data and recommended network configuration settings to help the management system functions to derive the suitable configuration parameters. + +For example, communication service SLS requirements such as E2E latency, bandwidth, service area, user capacity, user QoE requirements etc. may be used as input to MDAF. . Information from 5GC and NG-RAN, such as performance measurements of 5GC NFs, performance measurements of gNBs and en-gNBs, QoE measurement etc., + +may be used as input also to MDAF. The output data provided by MDAF may include performance data and recommended configuration settings. + +#### 5.1.4.2 Potential requirements + +**REQ-CSM\_MDA-CON-01** The communication services management system shall have the capability providing the communication service requirements related to network to the management data analytics service provider. + +**REQ-CSM\_MDA-CON-02** The management data analytics service provider shall have the capability getting the network management data from network management service provider. + +**REQ-CSM\_MDA-CON-03** The management data analytics service provider shall have the capability allowing its authorized consumer to request recommendation for the purpose of network provisioning. + +**REQ-CSM\_MDA-CON-04** The management data analytics service provider shall have the capability providing information which may include performance data and recommended configuration settings for communication service planning. + +## 5.2 Lifecycle management + +### 5.2.1 Communication service instances realized in a single network slice instance + +#### 5.2.1.1 Description + +A CSP offers a portfolio of communication services to the market (CSC). CSC selects a suitable product and orders communication service by inputting some service requirements e.g. SLA requirements information. + +The CSP receives a request from a customer to realize a communication service instance: + +- The CSP checks the communication service catalogue to find communication services with the communication service description which matches the request. The CSP performs feasibility check, i.e., checking the attainable service quality from both resource and service aspects. +- The CSP translates the service SLS into parameterized E2E network slice template information. In order to achieve this purpose, interactions between the CSP and NOP or some manually network design and planning process are needed. The CSP provides the service profile to the NOP for network resources allocation. The NOP checks the network slice inventory to find a network slice instances which matches the request. +- The network slice instance to be used will be checked whether there is sufficient capacity available to support the new communication service instance. If there is enough capacity available, the communication service instance will be assigned to the network slice instance. The mapping between the communication service instance and the network slice instance will be maintained by both the CSP and NOP. + +The communication service instance has been realized. + +#### 5.2.1.2 Potential requirements + +**REQ-CSM\_LCM-CON-01** The 3GPP management system shall provide a management service, which offers the capability to receive and process a request to realize a communication service instance. + +**REQ-CSM\_LCM-CON-02** The 3GPP management system shall provide management service, which offers the capability to ensure that the list of realized communication service instances are up to date. + +**REQ-CSM\_LCM-CON-03** The 3GPP management system shall provide a management service, which offers the capability to find a communication service description based on a request. + +**REQ-CSM\_LCM-CON-04** The 3GPP management system shall provide a management service, which offers the capability to assign a communication service instance to an existing network slice instance. + +### 5.2.2 Remove a communication service instance from a network slice instance + +#### 5.2.2.1 Description + +A Communication Service Provider (CSP) is informed by a CSC that a realized communication service instance will cease to exist. + +The CSP checks the communication service inventory to find the network slice instance that is used to realize the communication service instance. The communication service instance is unassigned from the network slice instance and the network slice instance is modified or terminated to reflect the changed requirements. + +The communication service instance has been removed. + +#### 5.2.2.2 Potential requirements + +**REQ-CSM\_LCM-CON-05** The 3GPP management system shall have the capability to remove an existing instance of communication service according to the request from a CSC to remove a communication service instance. + +**REQ-CSM\_LCM\_CON-06** The 3GPP management system shall have the capability to request the network slice management function to modify or terminate the existing NSI which supports the CSI to be removed. + +### 5.2.3 Management aspects of NSIs utilized by multiple communication services + +#### 5.2.3.1 Description + +Network slices and network slice subnets can be shared by different communication services as described in clause 4.1.3 of TS 28.530 [3]. Also, same NSI can be utilized to provide communication services to different customers. In both cases, multiple CSIs may share a single NSI. In this use case, a communication service provider uses a network slice to provide multiple CSIs, i.e. network provider performs service-based sharing of the network slice among its customers. + +On the contrary to the cases where a single NSI is utilized for a single CSI, the network management system is responsible for maintaining QoS guarantees for each service or customer over the resource facing aspects of a single NSI. For service-based sharing, the customer provides service requirements. Therefore, the NSI resources are shared based on service requirements to satisfy SLS requirements. In this case, the network provider determines the policies and rules about how the network resources are utilized. In other words, the network itself is transparent to the customer of the CSI service. Therefore, the network management system can utilize a database including available services. + +While utilizing NSIs with sharing, effect of all services on that NSI and its constituent should be considered. Effects of loads of services can be evaluated using historical data and analysis provided by MDADF, as a part of feasibility check for provisioning CSIs. Similarly, for modifications on NSIs and NSSIs with sharing, effect of the modification on all services are considered. + +#### 5.2.3.2 Potential requirements + +**REQ-CSM\_LCM-CON-07** The 3GPP management system shall have the capability to assure the QoS guarantees for each service when a network slice is utilized by multiple services. + +### 5.2.4 Obtaining an NSI as an NOP Internal to provide multiple CSIs + +#### 5.2.4.1 Description + +CSI is defined in Clause 3.1 as a run-time construct of a communication service for a defined group of users. For example, what a vertical customer or an enterprise customer receives from a network operator is a CSI which can be used to provide PDU sessions to its end users. + +A consumer of an NSI as a NOP Internal may use the NSI to offer multiple CSIs to its customers. One example case is a CSP obtains an IOT network slice instance for a generic home monitoring service and offer it to multiple customers who run different kind of home monitoring services such as electric meter monitoring or alarm monitoring. Another example is that the CSP receives a NSI for a certain application and provides the same services to multiple customers using multiple CSIs. + +Depending on the CSC requirements, CSC may obtain certain service management capabilities such as session admission control or dynamic adjustment of priorities so that it can manage the CSI services it provides to its customers. + +In certain scenarios, the CSI consumers (e.g. vertical customers) may also obtain service management components such as service data handling and related actions, subscriber data handling, service and use policy establishment (user priority, user allowed services etc.) for managing the end user devices. + +### 5.2.5 Providing CSI management capability to vertical industries + +#### 5.2.5.1 Description + +When a CSI is provided to a vertical industry or enterprise, the vertical customer may want to get certain service management capabilities. + +The vertical customer is authorized to obtain the allowed management capability from CSI service provider according to the pre-defined agreements between the CSI service provider and the CSI service consumer. Level of management capability exposure has been agreed upon between the CSI service provider and the CSI service consumer. + +These management capabilities may include the ability to limit or allow the traffic originated from certain end users, the ability to limit or allow traffic related to specific applications by applying priority, policy changes configuration setting which are related to session admission control. + +### 5.2.6 Create a Communication Service (CSI) + +#### 5.2.6.1 Description + +A communication service provider (CSP) receives a request to provide a communication service to a CSC. + +Based on the request the CSP checks the list of CS profiles for a matching profile, creates a new instance of the profile, adds information from the request to this profile and stores it with a unique identity (CSI Id), this is followed by a request to an NMF (Network Management Function) to allocate resources (available and assigned) (for example an NSI) that can support the characteristics of the requested CSI. Once the NMF confirms the resources have been allocated to provide the CSI, the CSP informs the CSC that the CSI has been created. The case when no matching profile can be found is not further investigated in the present document. + +#### 5.2.6.2 Potential requirements + +**REQ-CSM\_LCM-CON-08** The 3GPP management system shall support capabilities to create a communication service instance according to the request from a CSC. + +### 5.2.7 Activate a Communication Service (CSI) + +#### 5.2.7.1 Description + +A communication service provider (CSP) receives a request to activate provided to a CSC. + +Based on the request the CSP checks the CSI inventory and locates the CSI that is requested to be activated. The resources needed for the CSI have been allocated (assigned and available) before the activation request. From the inventory the CSP will know which resources (for example which NSI) are used for the CSI and sends an activation request to the NMF (Network Management Function) to allow the CSI to use the allocated resources. A positive response to the activation request will immediately allow the CSI to use the allocated resources. Once the NMF confirms that the CSI can use the allocated resources, the CSP informs the CSC that the CSI has been activated. + +**NOTE:** In some cases when a trial is being performed to allow for learning and adapting the resource allocation and configuration to the shared NSI, in such case an activation request may allow a group of subscribers to use the communication service instead of the target number of subscribers (maximum number of subscribers allowed to use the NSI). + +#### 5.2.7.2 Potential requirements + +**REQ-CSM\_LCM-CON-09** The 3GPP management system shall support capabilities to activate a communication service instance provided to a CSC. + +### 5.2.8 De-activate a Communication Service (CSI) + +#### 5.2.8.1 Description + +A communication service provider (CSP) receives a request to de-activate a communication service provided to a CSC. + +Based on the request the CSP checks the inventory to locate the CSI that is requested to be de-activated. From the inventory the CSP will know which resources are used for the CSI and sends a de-activation request to the NMF (Network Management Function) to disallow the CSI to use the allocated (assigned and available) resources. Once the NMF confirms that the CSI cannot use the allocated resources, the CSP informs the CSC that the CSI has been de-activated. + +#### 5.2.8.2 Potential requirements + +**REQ-CSM\_LCM-CON-10** The 3GPP management system shall support capabilities to de-activate a communication service instance provided to a CSC. + +### 5.2.9 Modify a Communication Service (CSI) + +#### 5.2.9.1 Description + +A communication service provider (CSP) receives a request to modify a communication service provided to a CSC. + +Based on the request the CSP checks the inventory to find the CSI that is requested to be modified. In some cases a modification request may necessitate a trial being performed to allow for learning and adapting the resource allocation and configuration to the shared resources. From the inventory the CSP will know which resources (for example an NSI) are used for the CSI and sends a modification request to the NMF (Network Management Function) to modify the allocated resources (available and assigned) a modification can result in adding or removing resources, or changes of properties of the resources within the scope of the service definition). Once the NMF confirms that the modification has been completed, the CSP informs the CSC that the CSI has been modified. + +#### 5.2.9.2 Potential requirements + +**REQ-CSM\_LCM-CON-11** The 3GPP management system shall support capabilities to modify a communication service instance provided to a CSC. + +### 5.2.10 Terminate a Communication Service (CSI) + +#### 5.2.10.1 Description + +A communication service provider (CSP) receives a request to terminate a communication service provided to a CSC. + +Based on the requirements from the request the CSP checks the inventory to find the CSI that is requested to be terminated. If the status of the CSI is active, the CSP has to de-activate the CSI before the CSI can be terminated. When the status of the CSI is in-active the CSP can terminate the CSI. The CSP will know which resources (for example an NSI) are used for the CSI and sends a de-allocation request to the NMF (Network Management Function) to de-allocate the allocated resources. Once the NMF confirms that the resources allocated to the CSI have been de-allocated, the CSP informs the CSC that the CSI has been terminated. + +#### 5.2.10.2 Potential requirements + +**REQ-CSM\_LCM-CON-12** The 3GPP management system shall support capabilities to terminate a communication service instance provided to a CSC. + +### 5.2.11 Management of multi-party communication service + +#### 5.2.11.1 Description + +A Vertical Industry customer deploys IoT devices in a specific geographical area supported by a communication service provided by a CSP. The customer decides to venture into new geographical areas and request the CSP to extend the agreement to cover other geographical areas. The new requirement includes geographical areas where the CSP does not have mobile network coverage. The CSP makes an agreement with an Access Network (AN) provider that can provide the required additional coverage for the customer. To improve the latency the CSP decides to extend its CN resources to be located near or with the CN resources of the AN provider. The CSP provides the additional CN resources and integrates the CN resources into the CSP's existing CN as well as into the AN from the provider. The CSP offers the customer a seamless communication service spanning the coverage areas required by the enterprise + +This description identifies the following roles involved in the use case: + +- CSC is the Vertical Industry customer looking for coverage of new geographical areas for IoT devices and therefore has a request to increase the current coverage +- CSP providing communication service to CSC +- NOP#1 providing RAN, CN services to the CSP +- NOP#2 providing RAN services, for different area, to CSP +- VISP providing virtualization infrastructure (e.g. data centre) and management services to NOP#2 + +The use case involves the following steps and interactions as sketched: + +- CSP provides a communication service to an CSC. The RAN and CN resources that realize the communication services are provided by NOP#1 +- CSC wants to extend the communication service to areas that are not covered by CSP. +- CSP wants to provide the CSC with the same service agreement level when outside the current CSPs coverage area. +- CSP asks the NOP#1 to provide resources (e.g. RAN resources for additional area) that enable the CSP to extend the currently provided communication service to additional coverage areas.- NOP#1 requests to NOP#2 management exposure to enable creation and configuration of additional RAN resources. +- NOP#1 deploys its own CN resources on VISP using the management services exposed. +- NOP#1 connects CN resources to the AN of NOP#2 using the management services exposed by NOP#2. +- NOP#1 extends its CN with the CN resources connected to Access Network of NOP#2. +- The CSP extends the currently provided communication service to include the additional requested coverage areas provided by NOP#2. +- NOP#1 manages the resources, including its CN resources connected to the NOP#2 Access Network. +- CSP manages the extended communication service. + +#### 5.2.11.2 Potential requirements + +REQ-FNS\_CON-01: The 3GPP management system shall support capabilities to provide management services that allow the integration of 3GPP resources in another operator's network to allow seamless provisioning and management of communication services. + +REQ-FNS\_CON-02: The 3GPP management system should support capabilities to provide management services that allow the management of 3GPP resources in another operator's network. + +## 5.3 Lifecycle management, data analytics and automated service assurance + +### 5.3.1 Service management aspects of NSaaS + +#### 5.3.1.1 Description + +5G networks with slicing provides a variety of communication services, including NSaaS as discussed in clause 4.1.6 of TS 28.530 [3]. NSaaS consumer may provide multiple communication service instances (CSIs) using the obtained NSI. In this case, it is assumed that the NSI is provided so as to satisfy the network resource requirements provided by the NSaaS consumer. The management system of the NSaaS consumer and the NSaaS provider are responsible for maintaining QoS guarantees for each CSI using the NSI. + +In this case, the customer's CSMF should convert NSI resource capability to service provisioning capabilities. Whenever a new CSI added to the NSI, the NSaaS consumer should ensure the NSI is capable of supporting the new CSI. The NSaaS provider has to satisfy the policies and rules about how the NSaaS consumer needs to utilize the network resources. In other words, the network is exposed to the customer based on necessity. + +The MDAS of the customer may assist for the conversion of resource capability into service capability, or the customer may request services and analysis from the MDAS of the NSaaS provider. Note that in the former case, the CSMF of the NSaaS consumer needs to obtain resource information and then perform the conversion. The NSI resource capability can be evaluated using historical data and analysis provided by MDAS of the NSaaS consumer. This information can be used by the NSaaS customer for provisioning and quality assurance of CSIs utilizing the obtained NSI. + +When obtaining analysis from the MDAS of the service provider, the network management system of the service provider may prepare a database including service requirements conversion to network resource requirements and/or service capacity boundaries that can be supported by the network resources available to NSaaS consumer. When the conversion is readily available, CSMF of the NSaaS consumer do not need to make the conversion, and is used for service and customer aspects. + +#### 5.3.1.2 Potential requirements + +**REQ-CSM\_MDA-CON-05** The communication service provider, as the NSaaS provider, shall have the capability to provide data analytics to an NSaaS consumer. + +# --- 6 Potential solutions + +## 6.1 Solution for communication service instances realized in a single network slice instance + +The customer provides service requirements. The NSI resources are shared based on service requirements (in case of sharing the same slice for different services). Note that this assumes the case where the network itself is transparent to the CSI provider at this point, i.e., only service and customer facing aspects of CSMF are considered. Differently than a non-shared NSI, the mutual effects of different services, as well as different requirements and policies of several customers need to be considered while determining the feasibility of provisioning the requested service. + +Detailed explanation of steps are as follows. + +- 1) CSMF receives an intent or request for service allocation. +- 2) If CSMF is not already provided with network resource information converted to service capabilities, it may request the service capabilities from the NSI provider. + - a) If some network components are obtained by another provider, service requirements may be given to this provider and service capabilities can be obtained. + - b) CSMF receives the analysis report. +- 3) CSMF sends the list of services to MDAF and other service information that may be required for MDAF analysis, e.g. service policies and requirements. + +- a) MDAF may use historical analysis of services sharing the NSI and also collects information about the current situation of the network, e.g. by querying RAN and CN traffic load analysis and policies. + - b) CSMF obtains information from MDAF without interacting with other management functions at the lower layers, such as NSMF and NSSMF. +- 4) CSMF evaluates the feasibility of adding the requested service by using service-level analysis and predictions. + - 5) CSMF makes a decision on whether to assign the CSI, or not. + - 6) The customer receives response. + - a) If the service is feasible, the CSI is assigned for the service. The customer receives acknowledgement along with necessary information about CSI, e.g. the identifier and so on. + - b) If the service is not feasible, the response includes reasons for rejection. Rejection reasons may be provided depending on the exposure to the customer. + +## 6.2 Solution for translation of SLS into SLA requirements + +A service-level agreement (SLA) specification (SLS) is an agreement between two or more parties, where one is the customer and the others are service providers. In this case, CSC is the consumer of the communication services, CSMF is the service provider of communication services management. + +Therefore, CSMF needs to convert the received SLAs from CSC to SLA requirements, i.e. the service and network requirements derived from SLAs, see figure 6.2.1. + +![Sequence diagram showing the translation of SLA into SLA requirements. Lifelines: CSC (actor), CSMF, NFMF, NSMF, NSSMF. The process involves five steps: 1. CSMF receives SLA information from CSC; 2. CSMF requests network management info from NFMF; 3. CSMF requests network slicing info from NSMF and NSSMF; 4. CSMF translates SLA to requirements and sends them to NFMF, NSMF, and NSSMF; 5. CSMF sends response to CSC and updates database.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` +sequenceDiagram + actor CSC + participant CSMF + participant NFMF + participant NSMF + participant NSSMF + + Note left of CSMF: 1. CSMF receives SLA information from CSC + Note right of CSMF: 2. CSMF may request network management service providers, such as NFMF, to obtain network capability related information + Note right of CSMF: 3. CSMF may request network slicing and network slicing subnet management service providers, such as NSMF and NSSMF, to obtain additional slicing information regarding the resource facing aspects + Note right of CSMF: 4. Based on the information retrieved from above step 2, 3 and 4, also considering the CSP's policies and other input, CSMF completes the translation of SLA to service and network requirements and sends the translated requirements to network management service providers, such as NFMF, NSMF, NSSMF + Note left of CSMF: 5. CSMF may send a response to CSC, and may update a database with the conversion results +``` + +Sequence diagram showing the translation of SLA into SLA requirements. Lifelines: CSC (actor), CSMF, NFMF, NSMF, NSSMF. The process involves five steps: 1. CSMF receives SLA information from CSC; 2. CSMF requests network management info from NFMF; 3. CSMF requests network slicing info from NSMF and NSSMF; 4. CSMF translates SLA to requirements and sends them to NFMF, NSMF, and NSSMF; 5. CSMF sends response to CSC and updates database. + +**Figure 6.2.1: Translation of SLA into SLA requirements** + +- 1) CSMF receives SLA information from CSC. +- 2) CSMF may request network management service providers (e.g. NFMF) to obtain network capability related information. +- 3) CSMF may request network slicing and network slicing subnet management service providers (e.g. NSMF and NSSMF) to obtain additional slicing information regarding the resource facing aspects, if needed. +- 4) Based on the information retrieved from above step 2, 3 and 4, also considering the CSP's policies and other input (e.g. service profile information stored in service catalogue), CSMF completes the translation of SLA to communication service requirements and network requirements and then sends the translated requirements to network management service providers (e.g. NSMF, NSSMF, NFMF) + +- a) In case of network slicing, NSMF fills the dataType ServiceProfile which represents the properties of network slice related requirements that should be supported by the network slice instance with the translated requirements. + - 1) If the conversion between CSMF and CSC is done upon a request, CSMF may send a response to CSC, and may update a database with the conversion results. + +## 6.3 Solution for communication service instance termination + +### 6.3.1 Solution for the case that network slice used as resources + +- 1) The CSC sends a request to the CSP for service termination. +- 2) If the status of the CSI is active, the CSP has to de-activate the CSI before the CSI can be terminated. + - a) The CSP decides on whether to decommission the related NSI(s) and NSSI(s), or modify them. This decision can be based on current and prospective services to utilize these NSI(s) and NSSI(s), e.g. MDAS may provide prediction on prospective demand. + - b) If the CSC has access to management exposure interfaces, the CSC may be involved in decommissioning. The management exposure interface is disabled before the termination of the service. +- 3) CSP manages the required modifications with NSMF and NSSMF via the resource facing interface of CSMF. +- 4) An acknowledgement may be received by the CSP and CSC indicating that the CSI termination is completed, and the exposure interfaces are disabled. + - a) The CSP may decide to terminate the SLA with the CSC upon receiving the acknowledgement. + +## 6.4 Solution for communication service instance modification + +### 6.4.1 Solution for the case that network slice used as resources + +After all NSIs for a customer's CSI are prepared and provisioned, CSMF of the customer request the activation of the CSI so that CSI's runtime begins (except in Exposure E2, the customer may not need to request activation). + +- 1) The CSC sends a request to the CSP for service modification. + - a) Based on the request the CSP may check an inventory to find the CSI that is requested to be modified. + - b) CSP checks the feasibility of the modification request. The modification may necessitate a trial being performed to allow for learning and adapting the resource allocation and configuration. If the request is not feasible, CSC and CSP may negotiate to agree on a feasible modification option. + - c) Alternatively, if CSC has information about estimated service capacities as provided by CSP, CSC may directly request a feasible modification. + - d) An update on the SLA may also be negotiated. +- 2) After CSP evaluates the required changes on the CSI, CSP performs or request for the necessary operations on the related NSI(s) and NSSI(s) via the resource facing aspect of CSMF, NSMF, and NSSMF. + - a) Service and resource facing aspects of the CSMF of the CSP may be partially exposed to the CSC for monitoring and supervision. In this case, CSC may utilize these interfaces for required operations. +- 3) Once the NMF confirms that the modification has been completed, the CSP informs the CSC that the CSI has been modified. + +## 6.5 Solution for communication service instance activation + +### 6.5.1 Solution for the case that network slice used as resources + +The resources needed for the CSI have been allocated (assigned and available) before the activation request. From the inventory the CSP will know which resources (for example which NSI) are used for the CSI. + +- 1) The CSC sends a request to the CSP for service activation. + - a) Based on the request the CSP may check the CSI inventory and locate the CSI that is requested to be activated. + - b) Alternatively, the request from the CSC may include a CSI indicator. +- 2) Prepared CSIs are deployed in this stage. + - a) CSP is responsible for CSI deployment to NSI, which means that CSI is allowed to use the allocated resources. + - b) If CSC has access to management interfaces, CSC may initiate deployment. +- 3) CSI operation can begin after this stage. + - a) CSC receives acknowledgement indicating that the CSI is activated. + +## 6.6 Solution for communication service instance de-activation + +### 6.6.1 Solution for the case that network slice used as resources + +- 1) The CSC sends a request to the CSP for service de-activation. + - a) Based on the request the CSP may check the CSI inventory and locate the CSI that is requested to be de-activated. + - b) Alternatively, the request from the CSC may include a CSI indicator. +- 2) CSP makes necessary changes with the resource facing aspects of CSMF to disallow CSI from using the resources of the associated NSI(s). +- 3) CSI is de-activated and CSI cannot use the NSI resources after this stage. + - a) Further decisions on NSI lifecycle are taken by the CSP. +- 4) CSP sends an acknowledgement indicating the de-activation of the CSI to the CSC. + - a) SLA between the CSP and CSC may be re-negotiated. + +## 6.7 Solution for MDA-Assisted SLS assurance + +### 6.7.1 MDA-Assisted network optimization + +To enable SLS assurance within certain region area to UEs or certain group (category) of UEs, NSMF, NSSMF and NFMF use MDAF which provides MDAS to help network optimization, see figure 6.7.1.1. + +![Sequence diagram illustrating MDA-Assisted network optimization contributing to SLS assurance. Lifelines: CSC (actor), CSMF, MDAF, NSMF/NSSMF/NFMF, CN, RAN. The process involves monitoring, detecting degradation, sending MDAS requests, providing analytical information, reconfiguring resources, receiving alarms, and finally providing SLS assurance information to the CSC.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` +sequenceDiagram + actor CSC + participant CSMF + participant MDAF + participant NSMF/NSSMF/NFMF + participant CN + participant RAN + + Note right of NSMF/NSSMF/NFMF: 1. Network management system continually monitors network status during the runtime phase of network to make sure whether the service and network requirements are achieved + + alt When the network management system detects or predicts performance degradation which impacts the fulfilment of service or network requirements + Note right of MDAF: 2. Network management system sends MDAS request to MDAF + Note right of MDAF: 3. MDAF provides analytical information to network management system + Note right of NSMF/NSSMF/NFMF: 4. Network management system reconfigures network resources with optimized configurations + Note right of CSMF: 5. CSMF and other network management system functions (e.g., NSMF, NSSMF, NFMF) may receive alarms and react on the alarms + end + + Note right of CSMF: 6. CSMF gets SLS requirements assurance information from network management system + + Note left of CSC: 7. CSC gets SLS assurance information from CSMF +``` + +The sequence diagram illustrates the interaction between a Customer Service Controller (CSC) and various network management functions (CSMF, MDAF, NSMF/NSSMF/NFMF, CN, RAN) for MDA-Assisted network optimization. The process begins with a loop where the network management system (NSMF/NSSMF/NFMF) continually monitors network status. If performance degradation is detected or predicted, an 'alt' block titled '[When the network management system detects or predicts performance degradation which impacts the fulfilment of service or network requirements]' is entered. Inside this block, the network management system sends an MDAS request to MDAF (ref 2), MDAF provides analytical information (ref 3), the network management system reconfigures resources (ref 4), and CSMF and other functions receive alarms (ref 5). After the loop, CSMF gets SLS requirements assurance information from the network management system (ref 6). Finally, the CSC gets SLS assurance information from CSMF (ref 7). + +Sequence diagram illustrating MDA-Assisted network optimization contributing to SLS assurance. Lifelines: CSC (actor), CSMF, MDAF, NSMF/NSSMF/NFMF, CN, RAN. The process involves monitoring, detecting degradation, sending MDAS requests, providing analytical information, reconfiguring resources, receiving alarms, and finally providing SLS assurance information to the CSC. + +Figure 6.7.1.1: MDA-Assisted network optimization contributing to SLS assurance + +- 1) Before network initial setting, there is fine tuning of configurations and algorithms during a trial phase of provisioning. +- 2) After network initial setting, NSMF, NSSMF and NFMF continually monitor network status during the runtime phase of network to make sure whether the service and network requirements are achieved. Information from 5GC and NG-RAN, such as alarms or performance measurements of 5GC NFs, alarms or performance measurements of gNBs and en-gNBs, QoE measurement, high level KPIs, etc., need to be collected frequently or on demand by the NSMF, NSSMF and NFMF. +- 3) When the NSMF, NSSMF and NFMF detect performance degradation which impacts the fulfilment of service or network requirements, the NSMF, NSSMF and NFMF send MDAS request to MDAF. There may be one or several instances of MDAF depending on the actual deployment. +- 4) MDAF may use historical analysis result and also collects information (e.g. by querying NG-RAN and 5GC traffic load and policies) about the current situation of the network to provide MDAS response which may include network performance data and recommended network reconfiguration settings to the NSMF, NSSMF and NFMF to help them reconfigure the resources to resolve the performance degradation. SON function may be requested to trigger network optimization. +- 5) The NSMF, NSSMF and NFMF reconfigure network resources with optimized configurations to minimize resource consumption for goal fulfilment. +- 6) During the runtime phase of network, CSMF, NSMF, NSSMF and NFMF may receive alarms, e.g., a KPI is not satisfied, or it is predicted that a KPI may not be satisfied in the near future, or the under-utilization of service capacity. SON function may be requested to perform fault handling such as fault locating, and by the assistance of MDAS, triggers self-healing operation. + - If the alarm is related to the insufficiency of resources, CSMF requests increasing service capacity via resource-facing aspects. + - If the alarm is related to under utilization of service capacity, CSMF requests decreasing service capacity via resource facing aspects. + - If the alarm is related to unexpected and high demand from one of the services, CSMF facilitates load balancing, e.g., by updating service priorities. + - If the alarm is due to faults in the network, e.g., malfunction of network equipment, NSMF, NSSMF and NFMF request alternative resources. +- 7) CSMF gets SLS requirements assurance information from NSMF, NSSMF and NFMF, e.g., whether or not the SLS requirements are assured. +- 8) CSC gets SLS assurance information from CSMF, e.g., whether or not the SLA is assured. + +## 6.8 Solution for providing management capability to vertical industries + +When a CSI is provided to a vertical industry or enterprise, the vertical customer may want to get certain service management capabilities. + +The vertical customer is authorized to obtain the allowed management capability from CSI service provider according to the pre-defined agreements between the CSI service provider and the CSI service consumer. Level of management capability exposure has been agreed upon between the CSI service provider and the CSI service consumer. + +The management model shown in Figure 4.4.2.1 shows how a CSI has a CFCS part and a RFCS part, the RFCS part represents the CSP's internal view of a CSI, while the CFCS is the external view of a CSI towards the customer from a vertical industry. The CFCS can also expose the management capabilities required by the customer from the vertical industry without having to expose all CSP internal management capabilities. + +Management capabilities for communication services include observation of the performance of the communication services, exposure of analytics services and providing custom designed capabilities to CSC. + +## 6.9 Solution for management aspects of NSI utilized by multiple communication services. + +### 6.9.1 Assignment of communication service to an existing NSI + +- 1) The CSP receives the request, with CS requirements, from CSC and create a new CSI. +- 2) CSP using the resource facing interface of CSMF. + - a. Translates the service requirements into resource facing requirements + - b. Communicates the resource facing requirements to the NSMF for the allocation of an NSI +- 3) NSMF may create a new NSI or assign an existing NSI by performing a feasibility check including the following. + - a. An isolation requirement check will be performed to ensure that the target NSI is shareable. + - b. The target NSI should be able to satisfy the resource facing requirements received from CSMF. + - c. The total projected/expected NSI performance, maybe evaluated using MDAF and NWDAF, should meet the predefined requirements (e.g. total expected load of NSI shall not be exceeding a predefined threshold). +- 4) Depending on the feasibility check, some NSI modification procedures (e.g. scaling) may be required during the CSI Commissioning. + +### 6.9.2 Activation of CSI sharing NSI. + +On receiving a CSI activation request a feasibility check should be initiated in which the current performance (e.g. current load) of the assigned NSI should be considered to confirm if the NSI will be able to satisfy the CSI requirements. Based on the result of the feasibility check the NSI modification (e.g. scale-out/up) procedure may be initiated before activating the CSI. + +1. The CSP receives the request for a CSI activation. +2. CSP evaluates the projected/expected NSI performance (e.g. NSI load information) maybe using the network analytics function e.g. MDAF, NWDAF. +3. Considering the projected/expected NSI performance and the CS requirements, the CSP may either activate the CSI or initiate the NSI modification procedure, via the resource facing interface of CSMF, before activating the CSI. + +### 6.9.3 Termination of CSI sharing NSI. + +1. The CSC sends a request to the CSP for communication service termination. +2. CSP, via CSMF, initiate CSI Decommissioning. +3. If the status of the CSI is active, the CSP has to de-activate the CSI before the CSI can be terminated. +4. CSP, via CSMF, terminates the CSI. +5. CSMF identifies the NSI associated to the CSI and request NSMF to perform NSI related modification or termination operation. Before initiating the NSI termination, CSMF checks if there are current and prospective communication services utilizing this NSI. The analytics functions e.g. NWDAF, MDAF can be used to get this information. +6. In case there are multiple communication services utilizing the NSI, CSMF does the modification feasibility check, in collaboration with NSMF, to see the required level of scale-in/down to be performed as a consequence of the terminated CSI. This will include CSMF constructing the new set of resource facing requirements for the NSI and doing the feasibility check based on those requirements. +7. Based on the modification feasibility check, NSMF then decides whether to modify the NSI or to terminate it. If the NSI need to be scale-in/down at a percentage more than a predefined threshold (e.g. 70% virtual resource + +reduction) then the NSI may be terminated. Which will further require CSMF to relocate the current CSI(s), in collaboration with NSMF, to an existing NSI i.e. re-allocating existing NSI to active CSI(s). This is done in order to keep the number of NSI to a manageable figure and to efficiently use the capabilities of existing NSIs. + +NOTE: In order to relocate the CSI, CSMF first has to de-activate the CSI detaching it from the NSI. CSMF will then initiate CSI activation procedures to allocate an existing NSI to the CSI(s). + +8. CSMF may then execute the NSI termination with NSMF and NSSMF. + +# --- 7 Conclusions and recommendations + +## 7.1 Conclusions + +### 7.1.1 Introduction + +The study has identified use cases, requirements and solutions for management of communication services. The study has extended the existing concepts for network slicing to include management of communication services. + +The use cases and requirements address lifecycle management of communication services and management data analytics as well as automated service assurance. + +### 7.1.2 Lifecycle management of communication services + +The study has identified that a communication service includes both customer facing aspects and resource facing aspects, + +The study has identified use cases and requirements for a management object that represents all the network resources that are used by a communication service instance. In the study the name used for this representation is RFCS. + +The study has identified that an RFCS has a <uses> relationship to an NSI in case the mobile network is partitioned in network slices. + +The study has identified that the NSaaS can be considered a CFCS that maps directly to an NSI. The NSaaS (CFCS) is exposed to a B2B customer (e.g. enterprise) while the NSI is never exposed to a B2B customer. + +### 7.1.3 Management data analytics + +The study has identified use cases and requirements for the use of management data analytics to support service level specification agreed between an operator and a B2B customer (e.g. vertical). + +The study has identified that interaction between an MDAF/S, other management functions, RAN and 5GC is needed for management of communication services, to ensure that the consumers of communication services experience an optimal service. + +The study has identified that further work is needed to understand deployment, roles, responsibilities and management of MDAFs. + +The application of management data analytics in context of SON has not been evaluated + +### 7.1.4 SLS assurance + +The study has identified that a management solution is needed to address the use case "How to ensure that slice SLA is guaranteed" documented as key issue 14 in TR 23.791 [6]. + +## 7.2 Recommendations + +### 7.2.1 Lifecycle management of communication services + +It is recommended that business level information is not standardized in Rel-16 timeframe. + +### 7.2.2 SLS assurance solution + +It is recommended to start normative work on the specification of an SLS assurance solution in Rel-16. + +### 7.2.3 Management data analytics in the SON context + +It is recommended to come up with an additional study which covers the application of management data analytics in the SON context. + +### 7.2.4 Management of MDAF + +It is recommended to come up with an additional study which covers the management of MDAF in general and for example in relation to roles, responsibilities, and deployments. + +# --- Annex A: Comparison table between 3GPP ServiceProfile attributes and GSMA GST attributes + +In context of the network slice lifecycle, comparison table between 3GPP ServiceProfile attributes and GSMA GST attributes is listed in below table A-1. The table can be extended to include more information for GST/NEST mapping. + +**Table A-1: Comparison between 3GPP ServiceProfile attributes and GSMA GST attributes** + +| <b>GST attribute name<br/>in GSMA NG.116 Generic Network Slice Template v1.0</b> | <b>GST attribute definition<br/>in GSMA NG.116 Generic Network Slice Template v1.0</b> | <b>ServiceProfile attribute<br/>in 3GPP TS 28.541</b> | +|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|-------------------------------------------------------| +| Availability | Void | availability | +| NOTE: This attribute is not documented in this version of the GST [12] | | | + +| <b>GST attribute name<br/><br/>in GSMA NG.116 Generic Network Slice Template v1.0</b> | <b>GST attribute definition<br/><br/>in GSMA NG.116 Generic Network Slice Template v1.0</b> | <b>ServiceProfile attribute<br/><br/>in 3GPP TS 28.541</b> | +|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| Coverage | This attribute specifies the coverage area of the network slice - the area where the terminals can access a particular network slice. | coverageAreaTAList | +| Delay tolerance | Provide the NSC with service delivery flexibility, especially for the vertical services that are not chasing a high system performance. For instance, the service will be delivered once the mobile system has sufficient resources or during the off-peak hours. For this type of traffic, it is not too critical how long it takes to deliver the amount of data, e.g. within hours, days, weeks, etc. | FFS | +| Deterministic communication | <p>This attribute defines if the network slice supports deterministic communication for periodic user traffic. Periodic traffic refers to the type of traffic with periodic transmissions.</p> <p>Availability: This parameter describes if the network slice supports deterministic communication.</p> <p>Periodicity: This parameter provides a list of periodicities supported by the network slice.</p> | FFS | +| Downlink throughput per network slice | <p>Is the achievable data rate of the network slice in downlink that is available ubiquitously across the coverage area of the slice.</p> <p>Guaranteed downlink throughput (M)<br/>Maximum downlink throughput (C)</p> | <p>areaTrafficCapDL in Perf for eMBB of ServiceProfile</p> <p>trafficDensity in Perf for URLLC of ServiceProfile</p> | +| Downlink throughput per UE | <p>Guaranteed downlink throughput:<br/>This attribute describes the guaranteed data rate supported by the network slice per UE (User Equipment) in downlink, which is required to achieve a sufficient quality experience (dependent on the selected service type) and can be seen as a guaranteed throughput. If the value is 0, best effort traffic is expected where no minimum throughput is guaranteed.</p> | <p>expDataRateDL in Perf for eMBB of ServiceProfile</p> <p>expDataRate in Perf for URLLC of ServiceProfile</p> | +| Maximum downlink throughput | This attribute describes the maximum data rate supported by the network slice per UE in downlink. These parameters could be used to offer different contract qualities like gold, silver and bronze. | FFS | +| Energy efficiency | <p>This attribute describes the energy efficiency of the network slice, i.e. the ratio between the performance indicator, in terms of data volume (DV), and the energy consumption (EC) when assessed during the same time frame [26].</p> <p>Network slice energy efficiency<br/>Time frame of the measurement</p> | FFS | +| Group communication support | This parameter describes which type of group communication is provided by the network slice. | FFS | + +| GST attribute name<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | GST attribute definition<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | ServiceProfile attribute<br><br>in 3GPP TS 28.541 | +|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Isolation level | Isolation is one of the key expectations of network slicing. A network slice instance may be fully or partly, logically and/or physically, isolated from another network slice instance [24]. This attribute describes different types of isolation: <ul style="list-style-type: none"> <li>• Physical – network slices are physically separated (e.g. different rack, different hardware, different location, etc.)</li> <li>• Logical – network slices are logically separated.</li> </ul> | resourceSharingLevel | +| Location based message delivery | This attribute describes the delivery of information in a particular geographic region. | FFS | +| Maximum supported packet size | This attribute describes the maximum packet size supported by the network slice and may be important for URLLC (Ultra-Reliable Low Latency Communication) and MIoT (Massive IoT), or to indicate a supported maximum transmission unit (MTU). | payloadSize in Perf for URLLC of ServiceProfile | +| Mission critical support | Mission-critical (MC) leads to a priority of the network slice relative to others, for C-plane (Control Plane) and U-plane (User Plane) decisions. This is relative to a customer provider relationship and to a PLMN (Public land Mobile Network). | FFS | +| MMTel support | This attribute describes whether the network slice supports IP Multimedia Subsystem (IMS) and Multimedia Telephony Service MMTel. This parameter describes whether the GSMA PRD IR.92 [22] compliant MMTel deployment is supported in the network slice. | FFS | +| Network Slice Customer network functions | A NSC can own some Network Functions (e.g. User Plan Function (UPF), User Data Management, UDM). This attribute provides a list of network functions to be provided by the NSC. If the list is empty, the NSC is not expected to provide any network function relevant for the network slice instance. | FFS | +| Number of connections | This attribute describes the maximum number of concurrent sessions supported by the network slice. | userDensity and activityFactor in Perf for eMBB of ServiceProfile<br><br>connDensity and serviceAreaDimension in Perf for URLLC of ServiceProfile | +| Number of terminals | This attribute describes the maximum number of terminals supported by the network slice. | maxNumberOfUEs | + +| GST attribute name<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | GST attribute definition<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | ServiceProfile attribute<br><br>in 3GPP TS 28.541 | +|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------| +| Performance monitoring | <p>This attribute provides the capability for NSC and NOP to monitor Key Quality Indicators (KQIs) and Key Performance Indicators (KPIs). KQIs reflect the end-to-end service performance and quality while KPIs reflect the performance of the network.</p> <p>Availability: This parameter contains a list of KQIs and KPIs available for monitoring. If the list is empty this attribute is not available in the network slice and the other parameters might be ignored.</p> <p>Monitoring sample frequency<br/>This parameter describes how often the KQIs and KPIs are monitored.</p> | FFS | +| Performance prediction | <p>This attribute defines the capability to allow the mobile system to predict the network and service status. Predictive QoS (Quality of Service) can be done for various Key Quality Indicators (KQIs) and Key Performance Indicators (KPIs). KQIs reflect the end-to-end service performance and quality, while KPIs reflect the performance of the network. The prediction is done for a specific point of time in the future and for a specific geolocation.</p> <p>Note: Only the KQIs of communication services offered by the NSP can be predicted. For over the top services, the NSP is not able to access the KQIs.</p> <p>Availability:<br/>This parameter contains a list of KQIs and KPIs available for prediction. If the list is empty the attribute is not available in the network slice and the other parameters might be ignored.</p> <p>Prediction frequency:<br/>This parameter describes how often KQIs and KPIs prediction values are provided.</p> | FFS | +| Positioning support | <p>This attribute describes if the network slice provides geo-localization methods or supporting methods.</p> <p>Availability: This parameter describes if this attribute is provided by the network slice and contains a list of positioning methods provided by the slice.</p> <p>Prediction frequency: This parameter describes how often location information is provided. This parameter simply defines how often the customer is allowed to request location information.</p> <p>Accuracy: This parameter describes the accuracy of the location information. Accuracy depends on the respective positioning solution applied in the network slice.</p> | FFS | +| Radio spectrum | <p>Defines the radio spectrum supported by the network slice. This is important information, as some terminals might be restricted in terms of frequencies to be used.</p> | FFS | + +| <b>GST attribute name<br/><br/>in GSMA<br/>NG.116<br/>Generic<br/>Network Slice<br/>Template v1.0</b> | <b>GST attribute definition<br/><br/>in GSMA NG.116 Generic Network Slice Template<br/>v1.0</b> | <b>ServiceProfile<br/>attribute<br/><br/>in 3GPP TS 28.541</b> | +|-------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| Reliability | | FFS | +| NOTE: This attribute is not documented in this version of the GST [12] | | | + +| GST attribute name<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | GST attribute definition<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | ServiceProfile attribute<br><br>in 3GPP TS 28.541 | +|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| +| Root cause investigation | Root cause investigation is the capability provided to NSC to understand or investigate the root cause of network service performance degradation or failure. | FFS | +| Session and Service Continuity support | <p>The attribute defines the continuity of a Protocol Data Unit (PDU) session. The following three Session and Service Continuity (SSC) modes are specified [1]:</p> <ul style="list-style-type: none"> <li>• SSC mode 1 - the network preserves the connectivity service provided to the UE (the IP address is preserved)</li> <li>• SSC mode 2 - the network may release the connectivity service delivered to the UE and release the corresponding PDU Session (the network may release IP address(es) that had been allocated to the UE)</li> <li>• SSC mode 3 - changes to the user plane can be visible to the UE, while the network ensures that the UE suffers no loss of connectivity service (the IP address is not preserved in this mode when the PDU Session Anchor changes)</li> <li>• None – UE loses the connectivity service</li> </ul> | FFS | +| Simultaneous use of the network slice | This attribute describes whether a network slice can be simultaneously with other network slice and if so, which group the network slice belongs to. | FFS | +| Slice quality of service parameters | <p>This attribute defines all the QoS relevant parameters supported by the network slice. For some of these parameters 3GPP has already defined standard values [1]. By preselecting a 5G QoS Identifier (5QI) these parameters will automatically be filled out with the standardised values.</p> <p>Functional + operational</p> <ul style="list-style-type: none"> <li>- 3GPP 5QI</li> <li>- Resource Type</li> <li>- Priority level</li> <li>- Packet Delay Budget</li> <li>- Packet Error Rate</li> <li>- Jitter</li> <li>- Maximum Packet Loss Rate</li> </ul> | latency<br><br>e2eLatency and jitter in Perf for URLLC of ServiceProfile | +| Support for non-IP traffic | This attribute provides non-IP Session support (Ethernet session and forwarding support) of communication devices | FFS | +| Supported access technologies | This attribute defines which access technologies are supported by the network slice. | FFS | +| Supported device velocity | Maximum speed supported by the network slice at which a defined QoS and seamless transfer between TRxPs (Transmission Reception Point(s)), which may belong to different deployment layers and/or radio access technologies (multi-layer /-RAT), can be achieved. | uEMobilityLevel<br><br>uESpeed in Perf for eMBB of ServiceProfile | + +| GST attribute name<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | GST attribute definition<br><br>in GSMA NG.116 Generic Network Slice Template v1.0 | ServiceProfile attribute<br><br>in 3GPP TS 28.541 | +|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| Synchronicity | This attribute provides synchronicity of communication devices. Two cases are most important in this context: <ul style="list-style-type: none"> <li>• Synchronicity between a base station and a mobile device and</li> <li>• Synchronicity between mobile devices.</li> </ul> Availability<br>Accuracy | FFS | +| Terminal density | This attribute describes the maximum number of connected and/or accessible devices per unit area (per km <sup>2</sup> ) supported by the network slice. | userDensity in Perf for eMBB of ServiceProfile<br><br>connDensity in Perf for uRLLC of ServiceProfile | +| Uplink throughput per network slice | The achievable data rate of the network slice instance in uplink that is available ubiquitously across the coverage area of the network slice.<br><br>Guaranteed uplink throughput<br>Maximum uplink throughput | areaTrafficCapUL in Perf for eMBB of ServiceProfile<br><br>trafficDensity in Perf for URLLC of ServiceProfile | +| Uplink throughput per UE | Guaranteed uplink throughput<br>This attribute describes the guaranteed data rate supported by the network slice per UE in uplink, required to achieve a sufficient quality experience (dependent on the selected service type). If the value is 0, best effort traffic is expected where no minimum throughput is guaranteed.<br><br>Maximum uplink throughput<br>This attribute describes the maximum data rate supported by the network slice per UE in uplink. These parameters could be used in order to offer different contract qualities like gold, silver and bronze. | expDataRateUL in Perf for eMBB of ServiceProfile<br><br>expDataRate in Perf for URLLC of ServiceProfile | +| User management openness | This attribute describes the capability for the NSC to manage their users or groups of users' network services and corresponding requirements. For instance, if NSC Y orders a network slice which is capable to support X users of Y, then Y should be capable to decide which X users could use this network slice. Hence, Y could manage the users, in terms of add, modify or delete users to receive network services provided by the specific network slice. | FFS | +| User data access | Data access:<br>The attribute defines how the network slice (or mobile network) should handle the user data.<br><br>Tunnelling mechanism<br>The attribute defines the tunnelling mechanism; how the user data can be delivered to the external private data network. | FFS | +| V2X communication mode | This parameter describes if the V2X communication mode is supported by the network slice. | FFS | + +# --- Annex B: Change history + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|-------------------------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2019-09 | SA#85 | | | | | Change control version | 16.0.0 | +| 2019-09 | SA#86 | SP-191168 | 0005 | - | F | Correct faulty implementation of figure 4.4.3.1 | 16.0.0 | +| 2019-09 | SA#86 | SP-191168 | 0006 | - | F | Implement Edithelp comments | 16.1.0 | +| 2019-09 | SA#86 | SP-191168 | 0007 | - | F | Solutions for Editor's notes | 16.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28806/042733dc5e8e7f5f30b60adba3266cde_img.jpg b/marked/Rel-16/28_series/28806/042733dc5e8e7f5f30b60adba3266cde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd2b7051a2b14fbe9d3e3470315f0ab0a16a88cc --- /dev/null +++ b/marked/Rel-16/28_series/28806/042733dc5e8e7f5f30b60adba3266cde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:05028e823ecfc3b1a912ff48915d564da0b4361e5c8bc72e5a40265e7891188f +size 65549 diff --git a/marked/Rel-16/28_series/28806/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/marked/Rel-16/28_series/28806/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..487939c472041e12db32a04f572b077dca81870a --- /dev/null +++ b/marked/Rel-16/28_series/28806/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a67d78b1175d8f1e9318810229b9ceed4e2963f6a3b13e5d4defdfaf8c76e720 +size 75525 diff --git a/marked/Rel-16/28_series/28806/12de9b926df0384ec07702671827c9cd_img.jpg b/marked/Rel-16/28_series/28806/12de9b926df0384ec07702671827c9cd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..962d5392e0a68d1ca2f7bbff6989729a2ca69e20 --- /dev/null +++ b/marked/Rel-16/28_series/28806/12de9b926df0384ec07702671827c9cd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3ef08c3fce246100a97eb1512e2a27187d55d14a5a3a0c388542b6980f521f20 +size 18444 diff --git a/marked/Rel-16/28_series/28806/2b3a967f6ce4f23649be995a353e39f8_img.jpg b/marked/Rel-16/28_series/28806/2b3a967f6ce4f23649be995a353e39f8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7a2e65f6a2766c3ae3b4709625584b40519e636d --- /dev/null +++ b/marked/Rel-16/28_series/28806/2b3a967f6ce4f23649be995a353e39f8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b94281290f82ef1f69248c534b0e4b13c2ee5c675c71396fba488d03bbe31397 +size 27097 diff --git a/marked/Rel-16/28_series/28806/5445597cceefaca1ac89e710fe339325_img.jpg b/marked/Rel-16/28_series/28806/5445597cceefaca1ac89e710fe339325_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ebd78294cfcbe1185e3459a0ccb6cbb29a07a339 --- /dev/null +++ b/marked/Rel-16/28_series/28806/5445597cceefaca1ac89e710fe339325_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c401513fc1fb3da3e20f9f36d196ad64151625f7f1196de1db18af90aafcb0c6 +size 185340 diff --git a/marked/Rel-16/28_series/28806/552265bdbcf6d43d341fd018a9076269_img.jpg b/marked/Rel-16/28_series/28806/552265bdbcf6d43d341fd018a9076269_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..718c3c555b32e7b797e53f61b392171813546c39 --- /dev/null +++ b/marked/Rel-16/28_series/28806/552265bdbcf6d43d341fd018a9076269_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01d1de266cc84a64a1409068520e9ccdf20331a464fd468bf253fbfc9118a6dc +size 174759 diff --git a/marked/Rel-16/28_series/28806/9cd90f495b95ad2116ff780248c26d95_img.jpg b/marked/Rel-16/28_series/28806/9cd90f495b95ad2116ff780248c26d95_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..779f31e0ed153334609a1fa3b010b63f34e2185d --- /dev/null +++ b/marked/Rel-16/28_series/28806/9cd90f495b95ad2116ff780248c26d95_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ea9b86105421b570405efa0dc54299987d226fe3c3f0406711ec67990c35098 +size 25429 diff --git a/marked/Rel-16/28_series/28806/a149b400127a3e3e50b3c98d27c5935c_img.jpg b/marked/Rel-16/28_series/28806/a149b400127a3e3e50b3c98d27c5935c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e64c715bbb02fe4393cff98b9e602158899d4b6 --- /dev/null +++ b/marked/Rel-16/28_series/28806/a149b400127a3e3e50b3c98d27c5935c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3284cff76b15aa54e0751b4af2f5d1edbcfd33d6c323957ffe1845a6a8c75152 +size 100407 diff --git a/marked/Rel-16/28_series/28806/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-16/28_series/28806/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61b1e2248f26a3d9dbe9f811c64e123abbf3f7a7 --- /dev/null +++ b/marked/Rel-16/28_series/28806/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c54f41b84ba201408eb0c479e206aa8b02d1b4806ba5ff89017fb89d9434075a +size 70584 diff --git a/marked/Rel-16/28_series/28806/c5655e700cc3e9aac7e9f4f07f30264d_img.jpg b/marked/Rel-16/28_series/28806/c5655e700cc3e9aac7e9f4f07f30264d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..157787ccc21fd0842a4ca708878608b4a9ccd1df --- /dev/null +++ b/marked/Rel-16/28_series/28806/c5655e700cc3e9aac7e9f4f07f30264d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72c84b48ac30f15ff01edd33eb7886038cb87adb3ccefc1c2e81a1113639f8e8 +size 49131 diff --git a/marked/Rel-16/28_series/28806/dfe556fea00682b09a59427aaf72051c_img.jpg b/marked/Rel-16/28_series/28806/dfe556fea00682b09a59427aaf72051c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..348d074dbc10fade1b83a27139b4ecb855424156 --- /dev/null +++ b/marked/Rel-16/28_series/28806/dfe556fea00682b09a59427aaf72051c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aabf4230722d55c41bc59467674207809250204cd3892616e2164e5f109b1cdf +size 36753 diff --git a/marked/Rel-16/28_series/28806/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg b/marked/Rel-16/28_series/28806/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f1a4fcca0a7f1e1bc7dd62bd282ba5757c233a3 --- /dev/null +++ b/marked/Rel-16/28_series/28806/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e8704e1c7b06edad4c44575c127bac3b58d98e20d7ee3ca580e6141d159546d +size 162796 diff --git a/marked/Rel-16/28_series/28806/e9314c83043183351ed74908e9bf2f90_img.jpg b/marked/Rel-16/28_series/28806/e9314c83043183351ed74908e9bf2f90_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..851b99fb95cbb6a319a82ee9a49e954f6e68634b --- /dev/null +++ b/marked/Rel-16/28_series/28806/e9314c83043183351ed74908e9bf2f90_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5cea017d531c4c759efcf9b02dd4dd9debdc673f19a824e2faa9a7714b436d25 +size 59725 diff --git a/marked/Rel-16/28_series/28806/raw.md b/marked/Rel-16/28_series/28806/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1ffdbc8a3d287e9c3514bbee172b56c42bd4e0eb --- /dev/null +++ b/marked/Rel-16/28_series/28806/raw.md @@ -0,0 +1,1134 @@ + + +# 3GPP TR 28.806 V16.1.0 (2019-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Study on non-file-based trace reporting; (Release 16)** --- + +## --- **Keywords** + +Trace, management + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + +<http://www.3gpp.org> + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Concepts and Background ..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 Cell Traffic Trace..... | 7 | +| 4.3 MDT..... | 8 | +| 4.4 RLF and RCEF reports collection..... | 10 | +| 5 Use Cases ..... | 12 | +| 5.1 Collecting Cell and UE data for analytics..... | 12 | +| 5.1.1 Goal ..... | 12 | +| 5.1.2 Pre-conditions ..... | 12 | +| 5.1.3 Description/steps ..... | 13 | +| 5.1.4 Post-conditions ..... | 13 | +| 5.2 Collecting subscriber and equipment trace data for near-real-time diagnostics and troubleshooting ..... | 14 | +| 5.2.1 Goal ..... | 14 | +| 5.2.2 Pre-conditions ..... | 14 | +| 5.2.3 Description/steps ..... | 14 | +| 5.2.4 Post-conditions ..... | 15 | +| 6 Potential Requirements ..... | 15 | +| 6.1 Introduction ..... | 15 | +| 6.2 General Trace requirements ..... | 15 | +| 6.3 Requirements for Trace data ..... | 16 | +| 6.4 Requirements for Trace activation ..... | 16 | +| 6.5 Requirements for Trace deactivation ..... | 16 | +| 6.6 Requirements for Trace data reporting..... | 16 | +| 6.7 Requirements for Privacy and Security..... | 17 | +| 6.8 Requirements for managing MDT ..... | 17 | +| 6.9 Requirements for managing RLF reports..... | 17 | +| 7 Potential Solutions ..... | 17 | +| 7.1 Solution for non-file-based trace data reporting ..... | 17 | +| 7.1.1 Architectural considerations ..... | 17 | +| 7.1.2 Solution overview..... | 19 | +| 7.1.3 Solution interactions ..... | 19 | +| 7.1.4 Solution protocol definition..... | 22 | +| 7.1.5 Solution deployment examples..... | 24 | +| 7.1.5.1 Example of 3GPP deployment with NWDAF ..... | 24 | +| 7.1.5.2 Example of ONAP deployment ..... | 26 | +| 8 Conclusions and recommendations..... | 27 | +| <b>Annex A (informative): Change history.....</b> | <b>28</b> | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +Subscriber and Equipment Trace, standardized by 3GPP SA5 in the family of specifications TS 32.421 [2] / TS 32.422 [3] / TS 32.423 [4], was originally introduced for diagnostic and troubleshooting purposes. With the introduction of Self Organized Networks (SON) concepts in 3GPP Rel-8, the Trace was being considered as one of the data sources for Centralized SON (C-SON) algorithms. In addition to traditional Trace, other Trace job types such as collection of MDT measurements, Radio Link Failure (RLF) and Radio Connection Establishment Failure (RCEF) reports were added to trace specifications and used extensively for the NM centralized Coverage and Capacity Optimization (NM CCO TR 32.836 [5]). + +Traditional trace reporting is file-based and therefore implies certain time restrictions on the availability of trace data preventing it from being used in fast control loop automation processes. In addition, file-based trace reporting may cause scalability issues in scenarios involving processing the records of multiple traces delivered at high rate. + +# --- 1 Scope + +The present document investigates the opportunities for new trace reporting methods. It identifies and documents use cases and potential requirements for non-file-based trace reporting, documents and evaluates potential solutions, and provides recommendations for the normative work aligned with 5G Services Based Management Architecture (SBMA). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace; Trace concepts and requirements". +- [3] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [4] 3GPP TS 32.423: "Telecommunication management; Subscriber and equipment trace; Trace data definition and management" +- [5] 3GPP TR 32.836: "Telecommunication management; Study on Network Management (NM) centralized Coverage and Capacity Optimization (CCO) Self-Organizing Networks (SON) function". +- [6] 3GPP TS 37.320: "Universal Terrestrial Radio Access (UTRA) and Evolved Universal Terrestrial Radio Access (E-UTRA); Radio measurement collection for Minimization of Drive Tests (MDT); Overall description; Stage 2". +- [7] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [8] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [9] IETF RFC 6455: "The WebSocket Protocol". +- [10] IETF RFC 8446: "The Transport Layer Security (TLS) Protocol Version 1.3". +- [11] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [12] 3GPP TS 38.423: "NG-RAN; Xn Application Protocol (XnAP)". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1], TS 32.421 [2], TS 32.422 [3], TS 32.423 [4] 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]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], TS 32.421 [2], TS 32.422 [3], TS 32.423 [4] 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]. + +# --- 4 Concepts and Background + +## 4.1 Introduction + +The sub-clauses of clause 4 introduce relevant background information on the Cell Traffic Trace, MDT, RLF and RCEF reports collection concepts as a foundation for the use cases documented in clause 5 and for the reader's convenience. + +## 4.2 Cell Traffic Trace + +Cell Traffic Trace defined in TS 32.421 [2] as the ability to trace one or more active calls in one or more cells. + +The high-level Trace Session activation requirements (specific to Management activation) state the following: + +- In the case of a Cell Traffic Trace, Trace Session activation should be possible for all calls active in a cell or multiple cells without knowledge of the UEs' identification (IMEI or IMEISV). +- In the case of a Cell Traffic Trace, Trace Sessions should be activated for all the NEs where Cell Traffic Trace is specified. +- In the case of Cell Traffic Trace (in a shared network only), a Trace Session shall be started for UEs which are served by the Participating Operator that has made the request to the Master Operator. + +The high-level requirements for starting a Trace Recording Session (specific to Management activation) state the following: + +- In the case of a Cell Traffic Trace, the Trace Recording Session should start upon the Trace control and configuration parameters being received by the NEs in the Trace Session activation and the presence of call activity. Furthermore, the Core Network node that handles the traced session should be requested to: + - provide a trace log including Trace Reference, Trace Recording Session Reference and the identity of the UE (i.e. IMSI or IMEI(SV) to the Trace Collection Entity, or + - provide a notification including Trace Reference, Trace Recording Session Reference and the identity of the UE (i.e. IMSI or IMEI(SV)) to the Trace Collection Entity. +- In the case of a Cell Traffic Trace (in a shared network only), the Trace Recording Session shall only be started for UEs which are served by the Participating Operator that has made the request to the Master Operator. + +The concept of Cell Traffic Trace was originally introduced to address the "checking radio coverage" legacy use case (see annex A.4 in TS 32.421 [2]) where it's used to collect trace data on all of the cells active in the area of interest. + +Another legacy use case relying on Cell Traffic Trace is the "fine-tuning and optimization of algorithms/procedures" documented in the annex A.6 of TS 32.421 [2]. + +According to the TS 32.422 [3], the Cell Traffic Trace is supported for both UTRAN, E-UTRAN and NG-RAN. Using NG-RAN case as example, the Cell Traffic Trace starting mechanism is as following (see clause 4.2.2.10 of TS 32.422 [3] for additional details): + +In NG-RAN, after the Cell Traffic Trace has been activated in the monitored cell(s), the NG-RAN node shall start a Trace Recording Session for new call(s)/session(s) and for already existing call(s)/session(s) (events for existing call(s)/session(s) are not required to be recorded prior to the activation of the cell traffic trace). When the NG-RAN node starts a Trace Recording Session it shall allocate a Trace Recording Session Reference (TRS) for the given call or session. The NG-RAN node shall send the allocated Trace Recording Session Reference, and the Trace Reference and the Trace Collection Entity address in the CELL TRAFFIC TRACE message to the AMF via the NG connection. + +When AMF receives this new NG signalling message containing the Trace Recording Session Reference (TRS) and Trace Reference (TR), the AMF shall look up the SUPI/IMEI(SV) of the given call from its database and shall send the SUPI/IMEI(SV) numbers together with the Trace Recording Session Reference and Trace Reference to the Trace Collection Entity. + +The figure below illustrates the procedure. + +![Sequence diagram illustrating the NG-RAN trace starting mechanism. The diagram shows interactions between Management system, NG-RAN node, UE, AMF, and TCE. The process starts with Trace Session Activation from Management system to NG-RAN node. The NG-RAN node then sends a NAS Service Request to the UE. The UE responds with a NAS Service Request to the AMF. The AMF then sends a NG: Cell Trace Notification (TR, TRS) to the NG-RAN node. The NG-RAN node then sends a Trace Record (TR, TRS, SUPI, IMEI(SV)) to the TCE. The AMF also sends a Trace Record to the TCE. The NG-RAN node then sends a Trace Recording Session stops message to the Management system.](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +``` + +sequenceDiagram + participant MS as Management system + participant NG as NG-RAN node + participant UE as UE + participant AMF as AMF + participant TCE as TCE + + Note right of NG: ref Starting Trace Session + MS->>NG: Trace Session Activation (TR, NG-RAN Cell list) + Note right of NG: ref Starting Trace Recording Session and allocation of TRS + NG->>UE: NAS Service Request + Note right of NG: ref Call Setup + NG->>AMF: NG: Cell Trace Notification (TR, TRS) + Note right of AMF: ref Searching for SUPI, IMEI(SV) + AMF->>TCE: Trace Record (TR, TRS, SUPI, IMEI(SV)) + Note right of NG: ref Call Setup + AMF->>TCE: Trace Record + Note right of NG: ref Trace Recording Session stops + NG->>MS: Trace Recording Session stops + +``` + +Sequence diagram illustrating the NG-RAN trace starting mechanism. The diagram shows interactions between Management system, NG-RAN node, UE, AMF, and TCE. The process starts with Trace Session Activation from Management system to NG-RAN node. The NG-RAN node then sends a NAS Service Request to the UE. The UE responds with a NAS Service Request to the AMF. The AMF then sends a NG: Cell Trace Notification (TR, TRS) to the NG-RAN node. The NG-RAN node then sends a Trace Record (TR, TRS, SUPI, IMEI(SV)) to the TCE. The AMF also sends a Trace Record to the TCE. The NG-RAN node then sends a Trace Recording Session stops message to the Management system. + +Figure 4.2.1: NG-RAN trace starting mechanism (figure 4.2.2.10.1 in TS 32.422 [3]) + +## 4.3 MDT + +The collection of radio measurements for minimization of drive tests (MDT) feature has been introduced by 3GPP Rel-10 (see TS 37.320 [6] for stage 2 details) for UTRAN and E-UTRAN. The work on MDT for NG-RAN targeted for 3GPP Rel-16. + +TS 37.320 [6] defines two modes of MDT (immediate and logged) as following: + +- Immediate MDT: MDT functionality involving measurements performed by the UE in CONNECTED state and reporting of the measurements to eNB/RNC available at the time of reporting condition as well as measurements by the network for MDT purposes. +- Logged MDT: MDT functionality involving measurement logging by UE in IDLE mode, CELL\_PCH, URA\_PCH states and CELL\_FACH state when second DRX cycle is used (when UE is in UTRA) for reporting + +to eNB/RNC at a later point in time, and logging of MBSFN measurements by E-UTRA UE in IDLE and CONNECTED modes. + +The general principles and requirements guiding the definition of MDT functions include the following (see clause 4.1 in TS 37.320 [6] for additional details): + +- There are two modes for the MDT measurements: Logged MDT and Immediate MDT. There are also cases of measurement collection not specified as either immediate or logged MDT, such as Accessibility measurements. +- It is possible to configure MDT measurements for the UE logging purpose independently from the network configurations for normal RRM purposes. However, in most cases, the availability of measurement results is conditionally dependent on the UE RRM configuration. +- UE MDT measurement logs consist of multiple events and measurements taken over time. The time interval for measurement collection and reporting is decoupled in order to limit the impact on the UE battery consumption and network signalling load. +- It is possible to configure the geographical area where the defined set of measurements will be collected. +- The measurements will be linked to available location information and/or other information or measurements that can be used to derive location information. +- The measurements in measurement logs will be linked to a time stamp. +- The network may use UE capabilities to select terminals for MDT measurements. +- The solutions for MDT are able to work independently from SON support in the network. Relation between measurements/solution for MDT and UE side SON functions will be established in a way that re-use of functions is achieved where possible. +- The subscriber/cell trace functionality is reused and extended to support MDT. If the MDT is initiated toward a specific UE (e.g. based on IMSI, IMEI-SV, etc.), the signalling-based trace procedure is used, otherwise the management-based trace procedure (or cell traffic trace procedure) is used. Network signalling and overall control of MDT is described in TS 32.422 [3]. + +According to the clause 5.2 in TS 37.320 [6], the E-UTRAN Immediate MDT measurements are not limited to those performed by the UE and do include measurements performed by the eNB (per cell or per UE): + +- M1: RSRP and RSRQ measurement by UE. +- M2: Power Headroom measurement by UE. +- M3: Received Interference Power measurement by eNB. This is a cell measurement. One sample is logged each measurement collection period, where one sample corresponds to a measurement period. +- M4: Data Volume measurement separately for DL and UL, per QCI per UE, by eNB. +- M5: Scheduled IP Throughput for MDT measurement separately for DL and UL, per RAB per UE and per UE for the DL, per UE for the UL, by eNB. +- M6: Packet Delay measurement, separately for DL and UL, per QCI per UE, see UL PDCP Delay, by the UE, and Packet Delay in the DL per QCI, by the eNB. +- M7: Packet Loss rate measurement, separately for DL and UL per QCI per UE, by the eNB. +- M8: RSSI measurement by UE. +- M9: RTT measurement by UE. + +The LTE trace use cases relevant to collection of MDT data are "periodical sampling of network performance", "differentiation of area-based MDT data by terminal type", "subscriber complaint about MBMS service in the eUTRAN network" and "check MBMS service quality and performance of the eUTRAN network" (see annexes A.12, A.13, A.14 and A.15 in TS 32.421 [2]). + +TS 32.422 [3] defines several trace Job types including dedicated to MDT data collection only and combined with trace data collection (see clause 5.9a in TS 32.422 [3] for additional details). + +## 4.4 RLF and RCEF reports collection + +In addition to regular subscriber and equipment trace and MDT results collection, the trace mechanisms are used for collection of Radio Link Failure (RLF) and RRC Connection Establishment Failure (RCEF) reports. + +The Radio Link Failure report contains information related to the latest connection failure experienced by the UE. The connection failure can be Radio Link Failure (RLF) or Handover Failure (HOF). Upon RLF/HOF detection in the UE, RLF report also includes available location information on where RLF occurred (see TS 37.320 [6] for additional details). RLF reports may also include available WLAN measurement results and/or Bluetooth measurement results for calculating UE location. + +Example scenarios of RLF reporting using special Trace Session where the job type indicates RLF reporting only are illustrated on the following figures (see clause 4.3.1 in TS 32.422 [3] for additional details). + +![Sequence diagram illustrating the RLF reporting process when UE reestablishment is successful at source eNB.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` +sequenceDiagram + participant EM + participant eNB + participant UE + participant TCE + + Note right of eNB: Starting a Trace Session + Note right of eNB: Active Connection + Note right of UE: RLF happens + Note right of UE: RRC Reestablishment + + EM->>eNB: Trace Session Activation + Note left of eNB: Job type=RLF reporting only + eNB->>UE: RRC Connection Reestablishment Complete + Note right of eNB: RLF Info Available + eNB->>UE: UEInformationRequest + UE->>eNB: UEInformationResponse + Note left of eNB: Store the RLF report in a Trace Record + eNB->>TCE: Trace Record reporting +``` + +The sequence diagram illustrates the interaction between four entities: EM (Equipment Management), eNB (evolved NodeB), UE (User Equipment), and TCE (Trace Collection Entity). The process begins with the EM sending a 'Trace Session Activation' message to the eNB, specifying 'Job type=RLF reporting only'. The eNB then initiates 'Starting a Trace Session' and establishes an 'Active Connection' with the UE. A failure occurs ('RLF happens'), followed by 'RRC Reestablishment' between the UE and eNB. Upon successful reestablishment ('RRC Connection Reestablishment Complete'), the eNB identifies 'RLF Info Available'. It sends a 'UEInformationRequest' to the UE, which responds with 'UEInformationResponse'. The eNB then 'Store the RLF report in a Trace Record' and finally sends 'Trace Record reporting' to the TCE. + +Sequence diagram illustrating the RLF reporting process when UE reestablishment is successful at source eNB. + +**Figure 4.4.1: Example scenario for RLF reporting when UE reestablishment is successful at source eNB (figure 4.3.1.1 in TS 32.422 [3])** + +![Sequence diagram illustrating the RLF reporting process when UE reestablishment is successful at target eNB.](e9314c83043183351ed74908e9bf2f90_img.jpg) + +``` + +sequenceDiagram + participant EM + participant Source eNB + participant Target eNB + participant UE + participant TCE + + EM->>Source eNB: Trace Session Activation + Note over Source eNB: Job type=RLF reporting only + Note over Source eNB: Starting a Trace Session + Note over Source eNB, UE: Active Connection + Note over UE: RLF happens + Note over Target eNB, UE: RRC Reestablishment + Target eNB->>UE: RRC Connection Reestablishment Complete + Note over Target eNB: RLF Info Available + Target eNB->>UE: UEInformationRequest + UE->>Target eNB: UEInformationResponse + Target eNB->>Source eNB: RLF Indication + Note over Source eNB: Store the RLF report in a Trace Record + Source eNB->>TCE: Trace Record reporting + +``` + +The sequence diagram illustrates the process of Radio Link Failure (RLF) reporting. It involves five entities: EM (Element Manager), Source eNB, Target eNB, UE (User Equipment), and TCE (Trace Collection Entity). + 1. The EM sends a 'Trace Session Activation' message to the Source eNB with the parameter 'Job type=RLF reporting only'. + 2. The Source eNB starts a Trace Session. + 3. An 'Active Connection' exists between the Source eNB and the UE. + 4. 'RLF happens' at the UE. + 5. The UE initiates 'RRC Reestablishment' with the Target eNB. + 6. The Target eNB sends 'RRC Connection Reestablishment Complete' to the UE. + 7. The Target eNB notes 'RLF Info Available'. + 8. The Target eNB sends a 'UEInformationRequest' to the UE. + 9. The UE responds with a 'UEInformationResponse'. + 10. The Target eNB sends an 'RLF Indication' to the Source eNB. + 11. The Source eNB stores the RLF report in a Trace Record. + 12. Finally, the Source eNB performs 'Trace Record reporting' to the TCE. + +Sequence diagram illustrating the RLF reporting process when UE reestablishment is successful at target eNB. + +**Figure 4.4.2: Example scenario for RLF reporting when the UE reestablishment is successful at target eNB when there is X2 Link between target eNB and source eNB (figure 4.3.1.2 in TS 32.422 [3])** + +Example scenarios of RCEF reporting using special Trace Session where the job type indicates RCEF reporting only are illustrated on the following figure (see clause 4.8.1 in TS 32.422 [3] for additional details). + +![Sequence diagram illustrating the RCEF reporting process when the UE RRC establishment is successful to a different eNB. The diagram shows interactions between EM, eNB A, eNB B, UE, and TCE.](042733dc5e8e7f5f30b60adba3266cde_img.jpg) + +``` + +sequenceDiagram + participant EM + participant eNB_A as eNB A + participant eNB_B as eNB B + participant UE + participant TCE + + Note right of eNB_A: Starting a Trace Session + EM->>eNB_A: Trace Session Activation +Job type=RCEF reporting only + eNB_A->>eNB_B: RRC Connection Establishment Attempt + Note right of eNB_B: RRC Connection Establishment Failure + eNB_B->>UE: RRC Connection Request + UE->>eNB_A: RRC Connection Setup + eNB_A->>UE: RRC Connection Establishment Complete + Note right of eNB_A: RCEF Info Available + eNB_A->>UE: UEInformationRequest + UE->>eNB_A: UEInformationResponse + Note right of eNB_A: Store the RCEF report in a Trace Record + eNB_A->>TCE: Trace Record reporting + +``` + +Sequence diagram illustrating the RCEF reporting process when the UE RRC establishment is successful to a different eNB. The diagram shows interactions between EM, eNB A, eNB B, UE, and TCE. + +**Figure 4.4.3: Example scenario for RCEF reporting when the UE RRC establishment is successful to a different eNB (figure 4.8.1.2 in TS 32.422 [3])** + +The trace Job types "RLF reports only" and "RCEF reports only" are applicable only in management based trace activation in E-UTRAN (see clause 5.9a in TS 32.422 [3]). + +# 5 Use Cases + +## 5.1 Collecting Cell and UE data for analytics + +### 5.1.1 Goal + +Being able to analyse and optimize the mobility management and traffic handling behaviour for on-going sessions is important, as it offers an opportunity to address potential problems before it's "too late" (while something can be done to mitigate them or prevent the problem from happening). + +Cell Traffic Trace, Immediate MDT, RLF reports and RCEF reports are the examples of RAN data relevant to this goal. + +### 5.1.2 Pre-conditions + +The consumers (e.g. specific instances of MDAS producers, NWDAF) and producers (e.g. specific E-UTRAN or NG-RAN nodes) of data have been identified and are operational. + +The data to be collected (e.g. particular call processing events, relevant interfaces, signalling messages and IEs, MDT measurements, UE location information, failure reports) has been selected. + +### 5.1.3 Description/steps + +1. 3GPP Management System configures/activates the data producers with appropriate Trace measurement control and configuration parameters (e.g. those specified in sub-clauses of clause 5 in TS 32.422 [3]). + +NOTE 1: For the illustrative purposes of this use case, it is assumed that Trace Job types "Immediate MDT and Trace", "RLF reports only" and "RCEF reports only" have been selected (see clause 5.9a in TS 32.422 [3]) and the information about data consumer (e.g. address, identity) has been provided. + +2. The data producer establishes connection to the data consumer and exchanges the data collection session metadata (e.g. identity of the data producer, nature of the data being collected, Trace Reference). +3. While the Trace Session is active on the data producer, the data producer performs UE selection (see clauses 4.1.1.6a and 4.1.1.9 in TS 32.422 [3]), receives RLF and RCEF reports (see clauses 4.3 and 4.8 in TS 32.422 [3]), starts trace recording sessions (see clauses 4.2.2.5 and 4.2.2.10 in TS 32.422 [3]), enables MDT measurements (see clause 4.2.2.7 in TS 32.422 [3]). +4. Periodically, upon the data availability, the data producer sends the collected data to the data consumer. The periodicity and the amount of data in each burst sent from producer to consumer may be standardized, made configurable or left implementation-specific. But the key point here is that the data is being delivered to the consumer while it's still relevant to the analytical task performed by the consumer. + +NOTE 2: The actions described by steps 3 and 4 repeated until the Trace Session is deactivated (e.g. via explicit configuration/deactivation by the 3GPP Management System or if Trace Session requirements such as amount of data or duration have been satisfied). + +5. 3GPP Management System configures/deactivates the data producers. +6. The data producer terminates the connection to the data consumer and potentially informs it that the data collection task has been completed and no further data is expected. + +The use case ends upon successful termination of the data collection task. + +### 5.1.4 Post-conditions + +The data consumer has the necessary data to perform the analytical tasks. The data (reported per UE) may include, but is not limited to: + +- LTE MDT measurements (see TSs 37.320 [6] and 32.422 [3]) such as: + - M1: RSRP and RSRQ measurement by UE with Periodic, event A2 as reporting triggers; + - M2: Power Headroom (PH) measurement by UE; + - M3: Received Interference Power measurement by eNB; + - M4: Data Volume measurement separately for DL and UL by eNB; + - M5: Scheduled IP Throughput measurement separately for DL and UL by eNB. + +NOTE: 5G MDT measurements are FFS (pending on-going work in RAN WG). + +- Radio Link Failure reports; +- RRC Connection Establishment Failure reports; +- Raw signalling messages (see TS 32.423 clauses 4.13 and 4.29 for additional details); +- UE location information (see TS 32.423 clause 4.16.2 for additional details). + +The specific methods for analysing and/or correlating the captured data, as well as any actions that may be triggered by such analysis are out of scope of the present use case. + +## 5.2 Collecting subscriber and equipment trace data for near-real-time diagnostics and troubleshooting + +### 5.2.1 Goal + +Being able to diagnose and troubleshoot various problems reported by subscribers (e.g. as described in sub-clauses of Annex A in TS 32.421 [2]) for on-going sessions is important, as it offers an opportunity to investigate and address potential problems while they are happening, and to evaluate the corrective actions (e.g. based on subscriber's feedback or automated algorithms). + +Subscriber and equipment Trace with Signalling Based Activation performed on RAN and Core NEs are the examples of trace data relevant to this goal. + +### 5.2.2 Pre-conditions + +The consumers (e.g. management applications and/or functions) and producers (e.g. specific NG-RAN and 5GC nodes) of data have been identified and are operational. + +The subscriber or equipment to be traced has been identified. + +The data to be collected (e.g. triggering events, trace depth, relevant NE types, relevant interfaces, signalling messages and IEs, MDT measurements, UE location information, failure reports) has been selected. + +### 5.2.3 Description/steps + +NOTE 1: For the illustrative purposes of this use case, the 5GC activation mechanism with UE attached to 5GC via NG-RAN (as described in the clause 4.1.2.15.1 of TS 32.422 [3]) has been selected. Other activation mechanisms involving E-UTRAN, NG-RAN, EPC and 5GC are possible, but are not conceptually different from the perspective of this use case. + +1. Management system configures/activates the Trace Session to the UDM. UDM stores the trace control and configuration parameters. +2. As UE (to be traced) registers with the network, the AMF starts a new Trace Session according to the configuration parameters received from UDM (see steps 3-8 in clause 4.1.2.15.1 of TS 32.422 [3]). +3. AMF establishes connection to the Trace data consumer and exchanges the Trace data collection session metadata (e.g. identity of the AMF, nature of the data being collected, Trace Session Reference). +4. While the Trace Session is active on the AMF, AMF starts the Trace Recording Sessions and collects the Trace data prescribed by Trace configuration received from the UDM. +5. Periodically, upon the Trace data availability, the AMF sends the collected data to the data consumer. The periodicity and the amount of data in each burst sent from AMF to data consumer may be standardized, made configurable or left implementation-specific. But the key point here is that the data is being delivered to the consumer while it's still relevant to the diagnostic/troubleshooting task performed by the consumer. +6. In parallel to the step 5, AMF sends the Trace Start message to the NG-RAN node (see steps 9-11 in clause 4.1.2.15.1 of TS 32.422 [3] and additional details in TS 38.413 [11]). NG-RAN node starts the Trace Session and establishes connection to the Trace data consumer. NG-RAN node and Trace data consumer exchange the Trace data collection session metadata (e.g. identity of the NG-RAN node, nature of the data being collected, Trace Session Reference). +7. While the Trace Session is active on the NG-RAN node, NG-RAN node collects the Trace data prescribed by Trace configuration received from the AMF. +8. Periodically, upon the Trace data availability, the NG-RAN node sends the collected data to the data consumer. The periodicity and the amount of data in each burst sent from NG-RAN node to data consumer may be standardized, made configurable or left implementation-specific. But the key point here is that the data is being delivered to the consumer while it's still relevant to the diagnostic/troubleshooting task performed by the consumer. + +9. In parallel with steps 3-5, AMF activates the Trace sessions on PCF and SMF (see steps 12-17 in clause 4.1.2.15.1 of TS 32.422 [3]). The PCF and SMF start Trace sessions and establish connections to the Trace data consumer. PCF and SMF exchange Trace data collection session metadata (e.g. identity of PCF or SMF, nature of the data being collected, Trace Session Reference). + 10. Periodically, upon the Trace data availability, the PCF and SMF send the collected data to the data consumer. The data is being delivered to the consumer while it's still relevant to the diagnostic/troubleshooting task performed by the consumer. + 11. When traced UE hands-over from one NG-RAN node to another (e.g. Xn handover), the Trace configuration is propagated in the Trace activation IE of the HANDOVER REQUEST message (see TS 38.423 [12]). The target NG-RAN node starts the Trace Session and establishes connection to the Trace data consumer. The target NG-RAN node and Trace data consumer exchange the Trace data collection session metadata (e.g. identity of the NG-RAN node, nature of the data being collected, Trace Session Reference). + 12. While the Trace Session is active on the target NG-RAN node, target NG-RAN node collects the Trace data prescribed by Trace configuration received from the source NG-RAN node. + 13. The target NG-RAN node reports the collected trace data to the data consumer (performs the actions described in the step 8 above). +- NOTE 2: The steps 6-8 and 11-13 are repeated while the Trace session is active (Trace configuration is propagated to target NG-RAN nodes following the UE handovers). Each NG-RAN node where the Trace is active has an active connection to the Trace data consumer (establishes connection and exchanges trace session metadata upon Trace session activation, and reports trace data upon availability). +14. 3GPP Management System configures/deactivates the Trace session at the UDM. It triggers the Trace deactivation process on all NEs where the Trace session was active (see clause 4.1.4.11 in TS 32.422 [3] for additional details). + 15. Upon the Trace session deactivation, the NEs / Trace data producers terminate the connection to the Trace data consumer and potentially inform it that the data collection tasks have been completed and no further data is expected. + +The use case ends upon successful termination of the Trace session and of the data collection tasks on all NEs. + +### 5.2.4 Post-conditions + +The data consumer has the necessary data to perform the near-real-time diagnostics and troubleshooting tasks. + +The specific methods for analysing and/or correlating the captured data, as well as any actions that may be triggered by such analysis are out of scope of the present use case. + +# --- 6 Potential Requirements + +## 6.1 Introduction + +The following requirements are potential requirements to be used in the future normative work (as per recommendations clause). The usage of normative terminology should not be interpreted as mandatory in the present document. + +## 6.2 General Trace requirements + +The requirements for the Maximum Level and for the Maximum Without Vendor Specific Extension Level (as specified in TS 32.421 [2] clause 5.1) are applicable here. + +## 6.3 Requirements for Trace data + +The Trace record requirements (as specified in TS 32.421 [2] clause 5.2) for the following Network Elements and Traceable interfaces are applicable here: + +- e-NodeB: S1-MME, X2, Uu +- NG-RAN node: NG-C, Xn-C, Uu, F1-C, E1-C + +The requirement on Trace Recording Session Reference (as specified in TS 32.421 [2] clause 5.2) is applicable here. + +## 6.4 Requirements for Trace activation + +The requirements for Trace Session activation and for starting a Trace Recording Session (as specified in TS 32.421 [2] clause 5.3) are applicable here. + +Potential new requirements are: + +REQ-TA-001: It shall be possible to specify the trace reporting method (file-based vs. non-file based) during Trace Session Activation. + +REQ-TA-002: In case of non-file-based trace reporting method being selected, the data producer shall establish the connection to the data consumer upon Trace Session Activation and provide data consumer with information about Trace Session. + +## 6.5 Requirements for Trace deactivation + +The requirements for Trace Session deactivation and for stopping a Trace Recording Session (as specified in TS 32.421 [2] clause 5.4) are applicable here. + +Potential new requirements are: + +REQ-TD-001: In case of non-file-based trace reporting, upon the Trace Session deactivation and end of the currently open Trace Recording Sessions, the data producer shall terminate connection to the data consumer. + +## 6.6 Requirements for Trace data reporting + +The following requirements for Trace Data reporting (as specified in TS 32.421 [2] clause 5.5) are applicable in case of non-file-based trace reporting: + +Trace records should be generated in each NE where a Trace Session has been activated and a Trace Recording Session has been started. + +Potential new requirements are: + +- REQ-TR-001: In case of non-file-based trace reporting, the same connection shall be used for the reporting of Trace data under all Trace Recording Sessions of the same Trace Session. +- REQ-TR-002: In case of non-file-based trace reporting, a connection from the data producer to the consumer shall be established and information about Trace Session shall be provided to the data consumer. +- REQ-TR-003: In case of non-file-based trace reporting, binary encoding shall be used for the transfer of all Trace data from data producer to the data consumer. +- REQ-TR-004: In case of non-file-based trace reporting, the periodicity and amount of data in each data burst from data producer to data consumer shall maintain the data relevance while minimizing the amount of transport overhead (e.g. buffering at the data producer no longer than 5 seconds). +- REQ-TR-005: In case of non-file-based trace reporting, the data producer shall re-establish connection to the data consumer and provide the information about Trace Session upon unexpected connection termination (e.g. in cases such as re-start of data producer). + +## 6.7 Requirements for Privacy and Security + +The following requirements for Privacy and Security (as specified in TS 32.421 [2] clause 5.6) are applicable in case of non-file-based trace reporting: + +- [SET-SEC-1] Keys stored inside eNBs shall never leave a secure environment within the eNB. When security key(s) transported on control signalling messages are included in the trace file, the key value(s) shall be removed and replaced with the value "Unavailable". +- [SET-SEC-2] Keys stored inside NG-RAN node shall never leave a secure environment within the NG-RAN node. When security key(s) transported on control signalling messages are included in the trace file, the key value(s) shall be removed and replaced with the value "Unavailable". + +Potential new requirements are: + +- REQ-SEC-001: In case of non-file-based trace reporting, the connection between data producer and data consumer shall provide the data privacy. +- REQ-SEC-002: In case of non-file-based trace reporting, the connection between data producer and data consumer shall provide the data integrity. + +## 6.8 Requirements for managing MDT + +The requirements for managing MDT (as specified in TS 32.421 [2] clause 6) are applicable in case of non-file-based trace reporting. + +Potential new requirements are: + +- REQ-MDT-001: In case of non-file-based trace reporting, binary encoding shall be used for the transfer of all MDT data from data producer to the data consumer. + +## 6.9 Requirements for managing RLF reports + +The requirements for managing RLF and RCEF reports (as specified in TS 32.421 [2] clause 7) are applicable in case of non-file-based trace reporting. + +Potential new requirements are: + +- REQ-RLF-001: In case of non-file-based trace reporting, binary encoding shall be used for the transfer of all RLF and RCEF reports data from data producer to the data consumer. + +NOTE: The format and the encoding details will be specified in TS 32.423 [4]. + +# --- 7 Potential Solutions + +## 7.1 Solution for non-file-based trace data reporting + +### 7.1.1 Architectural considerations + +Existing architecture for Management Based and Signaling Based Trace Activation/Deactivation (as specified in TS 32.421 [2] clause 4.2, figures 4.2.1 and 4.2.2) is applicable in case of non-file-based trace data reporting. + +The concept of Trace Collection Entity (as specified in TS 32.421 [2] clause 4.2, figure 4.2.3) may need to be revisited to either generalize the Trace Collection Entity as supporting both – file-based and non-file-based trace reporting or to introduce a new entity – non-file-based data consumer. In case of the non-file-based trace reporting, both – direct reporting by the NE and reporting via intermediate entity (e.g. Management Function) should be possible. In such case, the figure 4.2.3 in TS 32.421 [2] may need to be revised in the following way: + +![Diagram showing the revised architecture for High-level view of Trace Reporting in System Context A. It features a 'data consumer' at the top, a 'Management Function' in the middle, and three 'Network Element' boxes at the bottom. Arrows indicate data flow from Network Elements to the Management Function and then to the data consumer. Two 'Trace Reporting' callouts point to the arrows between the Management Function and the data consumer.](dfe556fea00682b09a59427aaf72051c_img.jpg) + +``` +graph TD; NE1[Network Element] --> MF[Management Function]; NE2[Network Element] --> MF; NE3[Network Element] --> MF; MF --> DC[data consumer]; MF --> DC; TR1[Trace Reporting] -.-> MF_DC1[ ]; MF_DC2[ ] -.-> TR2[Trace Reporting]; +``` + +Diagram showing the revised architecture for High-level view of Trace Reporting in System Context A. It features a 'data consumer' at the top, a 'Management Function' in the middle, and three 'Network Element' boxes at the bottom. Arrows indicate data flow from Network Elements to the Management Function and then to the data consumer. Two 'Trace Reporting' callouts point to the arrows between the Management Function and the data consumer. + +**Figure 7.1.1.1: Revised architecture for High-level view of Trace Reporting in System Context A** + +As an option for alignment with the new Services Based Management Architecture (SBMA) introduced in TS 28.533 [8] and further specified in TS 28.532 [7], the relationship between Network Element as "non-file-based trace data reporting MnS" producer, Management Function as both producer and consumer of this MnS and data consumer as consumer of this MnS may be represented as: + +![Diagram showing interactions between producers and consumers of 'non-file-based trace reporting MnS'. It features a 'data consumer' at the top, a 'Management Function' in the middle, and three 'Network Element' boxes at the bottom. The connections are represented by lines with small circles (interfaces) at the junctions with each component.](9cd90f495b95ad2116ff780248c26d95_img.jpg) + +``` +graph TD; NE1[Network Element] --> MF[Management Function]; NE2[Network Element] --> MF; NE3[Network Element] --> DC[data consumer]; MF --> DC; +``` + +Diagram showing interactions between producers and consumers of 'non-file-based trace reporting MnS'. It features a 'data consumer' at the top, a 'Management Function' in the middle, and three 'Network Element' boxes at the bottom. The connections are represented by lines with small circles (interfaces) at the junctions with each component. + +**Figure 7.1.1.2: Example of interactions between producers and consumers of "non-file-based trace data reporting MnS"** + +Yet another option for alignment with SBMA is to represent the legacy Trace Collection Entity as a trace reporting MnS consumer supporting either file-based or non-file-based trace reporting. The following figure illustrates this option: + +![Figure 7.1.1.3: Example showing Trace Collection Entity and Management Function as consumers of 'trace data reporting MnS'](2b3a967f6ce4f23649be995a353e39f8_img.jpg) + +A hierarchical diagram showing a 'Trace Collection Entity' at the top connected to a 'Management Function' below it. The 'Management Function' is then connected to three 'Network Element' boxes at the bottom. All connections are represented by lines with small circles at the junction points. + +Figure 7.1.1.3: Example showing Trace Collection Entity and Management Function as consumers of 'trace data reporting MnS' + +**Figure 7.1.1.3: Example showing Trace Collection Entity and Management Function as consumers of "trace data reporting MnS"** + +### 7.1.2 Solution overview + +Proposed solution focuses on the details of interactions between "non-file-based trace reporting MnS" producer and consumer. What entities play the roles of MnS consumer (e.g. Management Function, control plane function such as NWDAF or management plane MDAS producer) and MnS producer (e.g. Network Element or Management Function) is irrelevant and may be illustrated as various deployment options. Additional deployment options may illustrate non-3GPP consumers of the 3GPP MnS (e.g. ONAP DCAE). + +For the non-file-based trace reporting solution it is proposed to use ASN.1 binary encoded data transmitted using WebSocket protocol [9] over TCP connection protected by TLS [10]. Figure below illustrates the proposed protocol stack: + +![Figure 7.1.2.1: Protocol stack for non-file-based trace reporting](12de9b926df0384ec07702671827c9cd_img.jpg) + +A diagram showing two identical protocol stacks side-by-side, connected by horizontal dashed double-headed arrows. The stacks, from top to bottom, are: ASN.1, WebSocket (with a nested TLS box), TCP, and IP. + +Figure 7.1.2.1: Protocol stack for non-file-based trace reporting + +**Figure 7.1.2.1: Protocol stack for non-file-based trace reporting** + +### 7.1.3 Solution interactions + +The sequence of interactions between producer and consumer of the "non-file-based trace reporting MnS" is illustrated by the following figure: + +![Sequence diagram showing interactions between Management System, non-file-based trace reporting MnS producer, and non-file-based trace reporting MnS consumer.](5445597cceefaca1ac89e710fe339325_img.jpg) + +``` + +sequenceDiagram + participant MS as Management System + participant P as non-file-based trace reporting MnS producer + participant C as non-file-based trace reporting MnS consumer + + Note left of MS: Management System + Note right of C: non-file-based trace reporting MnS consumer + + MS->>P: 1. Trace Session Activation/Configuration + P->>P: 2. Start Trace Session + Note right of P: ref + P->>C: 3. Establish Websocket Connection + P->>C: 4. StartSession() + Note right of P: loop [while Trace Session is active] + Note right of P: loop [for each "start" triggering event detected] + P->>P: 5. Start Trace Recording Session and allocate new TRSR + P->>C: 6. StartRecordingSession() + Note right of P: loop [until "stop" triggering event is detected] + Note right of P: loop [while reporting condition is not satisfied] + P->>P: 7. Capture trace record + Note right of P: alt [there are trace records to report] / [there are no trace records to report] + P->>C: 8. Report() + P->>C: 9. IsAlive() + Note right of P: loop [until "stop" triggering event is detected] + P->>P: 10. Stop Trace Recording Session + P->>C: 11. StopRecordingSession() + Note right of P: loop [for each "start" triggering event detected] + Note right of P: loop [while Trace Session is active] + MS->>P: 12. Trace Session De-activation/Configuration + P->>P: 13. Stop Trace Session + Note right of P: loop [for each on-going Trace Recording Session] + P->>P: 14. Stop Trace Recording Session + Note right of P: opt [there are outstanding trace records] + P->>C: 15. Report() + P->>C: 16. StopRecordingSession() + P->>C: 17. StopSession() + P->>C: 18. Terminate Connection + Note left of MS: Management System + Note right of P: non-file-based trace reporting MnS producer + Note right of C: non-file-based trace reporting MnS consumer + +``` + +The sequence diagram illustrates the interaction between a Management System, a non-file-based trace reporting MnS producer, and a non-file-based trace reporting MnS consumer. The process begins with the Management System sending a 'Trace Session Activation/Configuration' message to the producer. The producer responds with 'Start Trace Session'. A 'ref' block labeled 'Establish Websocket Connection' follows, where the producer sends 'StartSession()' to the consumer. A 'loop' block titled '[while Trace Session is active]' contains a nested 'loop' block titled '[for each "start" triggering event detected]'. Inside this nested loop, the producer sends 'Start Trace Recording Session and allocate new TRSR' and 'StartRecordingSession()' to the consumer. Another nested 'loop' block titled '[until "stop" triggering event is detected]' contains a 'loop' block titled '[while reporting condition is not satisfied]' where the producer sends 'Capture trace record'. An 'alt' block titled '[there are trace records to report] / [there are no trace records to report]' follows, with the producer sending 'Report()' and 'IsAlive()' to the consumer. After the nested loops, the producer sends 'Stop Trace Recording Session' and 'StopRecordingSession()' to the consumer. The outer 'loop' block '[while Trace Session is active]' continues with another nested 'loop' block titled '[for each "start" triggering event detected]'. The Management System then sends a 'Trace Session De-activation/Configuration' message to the producer, which responds with 'Stop Trace Session'. A 'loop' block titled '[for each on-going Trace Recording Session]' follows, where the producer sends 'Stop Trace Recording Session'. An 'opt' block titled '[there are outstanding trace records]' follows, with the producer sending 'Report()' and 'StopRecordingSession()' to the consumer. Finally, the producer sends 'StopSession()' and 'Terminate Connection' to the consumer. + +Sequence diagram showing interactions between Management System, non-file-based trace reporting MnS producer, and non-file-based trace reporting MnS consumer. + +Figure 7.1.3.1: Sequence of interactions between producer and consumer of the non-file-based trace reporting MnS + +![Sequence diagram showing the detailed interactions of WebSocket connection establishment between a non-file-based trace reporting MnS producer and a non-file-based trace reporting MnS consumer. The sequence consists of four steps: 3-1. HTTP POST request (SourceID, Trace Session Reference) from producer to consumer; 3-2. HTTP response (Session cookie) from consumer to producer; 3-3. HTTP GET request (Session cookie, Upgrade header) from producer to consumer; 3-4. HTTP response (Sec-WebSocket-Accept) from consumer to producer.](c5655e700cc3e9aac7e9f4f07f30264d_img.jpg) + +``` + +sequenceDiagram + participant MnS Producer as non-file-based trace reporting MnS producer + participant MnS Consumer as non-file-based trace reporting MnS consumer + Note left of MnS Producer: non-file-based trace reporting MnS producer + Note right of MnS Consumer: non-file-based trace reporting MnS consumer + MnS Producer->>MnS Consumer: 3-1. HTTP : POST request (SourceID, Trace Session Reference) + MnS Consumer-->>MnS Producer: 3-2. HTTP : response (Session cookie) + MnS Producer->>MnS Consumer: 3-3. HTTP : GET request (Session cookie, Upgrade header) + MnS Consumer-->>MnS Producer: 3-4. HTTP : response (Sec-WebSocket-Accept) + +``` + +Sequence diagram showing the detailed interactions of WebSocket connection establishment between a non-file-based trace reporting MnS producer and a non-file-based trace reporting MnS consumer. The sequence consists of four steps: 3-1. HTTP POST request (SourceID, Trace Session Reference) from producer to consumer; 3-2. HTTP response (Session cookie) from consumer to producer; 3-3. HTTP GET request (Session cookie, Upgrade header) from producer to consumer; 3-4. HTTP response (Sec-WebSocket-Accept) from consumer to producer. + +**Figure 7.1.3.2: Detailed interactions of WebSocket connection establishment** + +1. The interactions between MnS producer and consumer begin when Management System activates (configures) the MnS producer with appropriate Trace measurement control and configuration parameters (e.g. similar to those specified in sub-clauses of clause 5 in TS 32.422 [3]). The specific details of this step depend on the outcome of the on-going work on Trace Management in the context of Services Based Management Architecture and may rely either on the capabilities of a new Trace Management MnS or re-use the capabilities of the Provisioning MnS specified in TS 28.532 [7]. An important aspect of this interaction is that the MnS producer is provided with the trace reporting method ("non-file-based trace reporting") and details of the connection to the MnS consumer (e.g. IP address, port, connection credentials, URI). + 2. The MnS producer starts a new Trace Session (e.g. according to one of the sub-clauses of clause 4.1.1 in TS 32.422 [3]). + 3. Upon the Trace Session activation, the MnS producer establishes a new connection to the MnS consumer (e.g. performs IP address look-up if necessary, connects to the specified TCP port, performs TLS handshake, starts WebSocket connection). The details of the WebSocket connection establishment are illustrated on the Figure 7.1.3.2. As part of the connection establishment the MnS producer informs MnS consumer about ASN.1 version to be used via *Configure* message. The WebSocket Ping frames (see clause 5.5.1 in [9]) may be used as a keepalive or as means to verify that remote endpoint is still responsive. In case of abnormal connection termination (e.g. if either MnS consumer or MnS producer restarts) the MnS producer re-establishes the connection to the MnS consumer. + - 3-1. The MnS producer uses the HTTP POST method to provide the MnS consumer with connection meta-data such as SourceID (MnS producer identifier) and Trace Session Reference facilitating MnS consumer actions. + - 3-2. The MnS consumer uses HTTP response to indicate successful reception of connection meta-data and includes session cookie allowing the connection meta-data to be associated with the WebSocket. + - 3-3. The MnS producer uses HTTP GET method to request connection upgrade to WebSocket. In the request it includes session cookie associating the requested WebSocket with previously provided connection meta-data, Upgrade header and WebSocket-specific headers. + - 3-4. The MnS consumer uses HTTP response to indicate successful upgrade of the connection to a WebSocket. +- NOTE 1: Further communication between MnS producer and MnS consumer (steps 4, 6, 8, 9, 11, 15, 16 and 17 below) uses WebSocket protocol. +4. Upon establishment of connection between MnS producer and MnS consumer (either new connection or connection re-establishment), the MnS producer reports the Trace Session activation event via *StartSession* message including the information allowing the MnS consumer to associate the active connection to the MnS producer with the Trace Session information. + 5. While the Traces Session is active at the MnS producer, it follows the procedures specified in TS 32.422 [3] clause 4.2 and starts new recording sessions once "start" triggering event (see TS 32.422 [3] clause 5.1) is detected. For each recording session a Trace Recording Session Reference (TRSR) is allocated. + +- 6. Upon starting a new Trace Recording Session, the MnS producer reports this event to the MnS consumer via *StartRecordingSession* message. +- 7. The MnS producer captures traceable events (signalling messages, measurements, RLF reports, RCEF reports, UE location information) according the Trace Session configuration received in step 1. The captured trace records may be buffered until the reporting condition (e.g. amount of data or periodicity) is satisfied. + +NOTE 2: Whether the reporting condition needs to be standardized, made configurable or left for implementation is FFS. + +- 8. When the reporting condition is satisfied (e.g. desired amount of data is reached, buffer capacity exceeded or reporting timer expired), the MnS producer sends the captured trace records to the MnS consumer in ASN.1 binary encoding over the active WebSocket via *Report* message. The format of the ASN.1 encoded trace record follows the specification (e.g. new clauses in TS 32.423 [4]). +- 9. In cases where the reporting condition is satisfied (reporting timer expired), but there are no outstanding trace records to report, the MnS producer sends *IsAlive* message to the MnS consumer. +- 10. Once the "stop" triggering event (see TS 32.422 [3] clause 5.1) is detected by the MnS producer, it stops the Trace Recording Session following the procedures specified in TS 32.422 [3] clause 4.2. +- 11. Upon stopping a Trace Recording Session, the MnS producer reports this event to the MnS consumer via *StopRecordingSession* message. +- 12. The interaction between MnS producer and consumer ends when Management System de-activates (configures) the MnS producer. The specific details of this step depend on the outcome of the on-going work on Trace Management in the context of Services Based Management Architecture and may rely either on the capabilities of a new Trace Management MnS or re-use the capabilities of the Provisioning MnS specified in TS 28.532 [7]. +- 13. The MnS producer stops the on-going Trace Session (e.g. according to one of the sub-clauses of clause 4.1.3 in TS 32.422 [3]). +- 14. If there are any on-going Trace Recording Sessions, the MnS producer stops them all. +- 15. If there are any outstanding (buffered) trace records, MnS producer reports them to the MnS consumer via *Report* message. +- 16. Upon stopping a Trace Recording Session, the MnS producer reports this event to the MnS consumer via *StopRecordingSession* message. +- 17. Upon stopping the Trace Session, the MnS producer reports this event to the MnS consumer via *StopSession* message. +- 18. MnS producer terminates the connection to MnS consumer (closes WebSocket, closes TLS and TCP connections). + +### 7.1.4 Solution protocol definition + +An example of ASN.1 encoded non-file-based trace reporting messages (partially addressing NG-RAN node trace reporting) is included below: + +``` + +-- ***** +-- Non-file-based trace reporting protocol definition +-- Draft ver. 0.0.1 +-- Encoding: ASN1 aligned PER +-- ***** + +TraceProtocol DEFINITIONS AUTOMATIC TAGS ::= +BEGIN +TraceMessage ::= CHOICE { + configure Configure, + alive IsAlive, + startSession StartSession, + stopSession StopSession, + startRecordingSession StartRecordingSession, + stopRecordingSession StopRecordingSession, + report Report, +} + +``` + +``` + + ... + } + + -- ***** + -- Configure msg + -- Used to convey the ASN.1 protocol version + -- ***** + Configure ::= SEQUENCE { + nodeType NodeTypeId, + version Version, + futureExtension SEQUENCE {} + } + + -- ***** + -- IsAlive msg + -- Used for periodic keepalive at the protocol level + -- ***** + IsAlive ::= SEQUENCE { + nodeType NodeTypeId, + timestamp UTC-Timestamp, + futureExtension SEQUENCE {} OPTIONAL + } + + -- ***** + -- StartSession msg + -- Used for reporting the start of Trace Session event + -- ***** + StartSession ::= SEQUENCE { + seqNum SequenceNumber, + sourceId SynchronizationSourceId, + nodeType NodeTypeId, + traceReference TraceReference, + cellId NRCGI OPTIONAL, + timestamp UTC-Timestamp, + sessionConfig SessionConfig, + futureExtension SEQUENCE {} OPTIONAL + } + + -- ***** + -- StopSession msg + -- Used for reporting the stop of Trace Session event + -- ***** + StopSession ::= SEQUENCE { + seqNum SequenceNumber, + sourceId SynchronizationSourceId, + nodeType NodeTypeId, + traceReference TraceReference, + cellId NRCGI OPTIONAL, + timestamp UTC-Timestamp, + futureExtension SEQUENCE {} OPTIONAL + } + + -- ***** + -- StartRecordingSession msg + -- Used for reporting the start of Trace Recording Session event + -- ***** + StartRecordingSession ::= SEQUENCE { + seqNum SequenceNumber, + sourceId SynchronizationSourceId, + nodeType NodeTypeId, + traceReference TraceReference, + traceRecordingSessionRef TraceRecordingSessionRef, + cellId NRCGI OPTIONAL, + recordInitSeqNum SequenceNumber, + timestamp UTC-Timestamp, + futureExtension SEQUENCE {} OPTIONAL + } + + -- ***** + -- StopRecordingSession msg + -- Used for reporting the stop of Trace Recording Session event + -- ***** + StopRecordingSession ::= SEQUENCE { + seqNum SequenceNumber, + sourceId SynchronizationSourceId, + nodeType NodeTypeId, + traceReference TraceReference, + traceRecordingSessionRef TraceRecordingSessionRef, + } + +``` + +``` + + cellId NRCGI OPTIONAL, + recordEndSeqNum SequenceNumber, + timestamp UTC-Timestamp, + futureExtension SEQUENCE {} OPTIONAL +} + +-- ***** +-- Report msg +-- Used for reporting the captured Trace records +-- ***** +Report ::= SEQUENCE { + seqNum SequenceNumber, + sourceId SynchronizationSourceId, + nodeType NodeTypeId, + traceReference TraceReference, + cellId NRCGI OPTIONAL, + recordingSessionReportList RecordingSessionReportList OPTIONAL, + futureExtension SEQUENCE {} OPTIONAL +} + +-- ***** +-- Types +-- ***** + +``` + +NOTE: Further protocol details (e.g. such as type definitions) are FFS + +### 7.1.5 Solution deployment examples + +#### 7.1.5.1 Example of 3GPP deployment with NWDAF + +The following figure illustrates deployment scenario where NG-RAN node produces, and NWDAF consumes non-file-based trace reporting MnS under control of 3GPP Management System: + +![Sequence diagram showing the interaction between 3GPP Management System, NG-RAN node, and NWDAF for trace session management.](552265bdbcf6d43d341fd018a9076269_img.jpg) + +``` + +sequenceDiagram + participant 3GPP Management System + participant NG-RAN node + participant NWDAF + + Note left of 3GPP Management System: 3GPP Management System + Note right of NWDAF: NWDAF + + 3GPP Management System->>NG-RAN node: 1. Trace Session Activation/Configuration + NG-RAN node->>NG-RAN node: 2. Start Trace Session + Note right of NG-RAN node: ref + NG-RAN node->>NWDAF: 3. Establish Websocket Connection + NG-RAN node->>NWDAF: 4. StartSession() + + loop while Trace Session is active + loop for each traceable UE + NG-RAN node->>NG-RAN node: 5. Start Trace Recording Session and allocate new TRSR + NG-RAN node->>NWDAF: 6. StartRecordingSession() + + loop until UE connection termination + loop while reporting condition is not satisfied + NG-RAN node->>NG-RAN node: 7. Capture trace record + alt there are trace records to report + NG-RAN node->>NWDAF: 8. Report() + else there are no trace records to report + NG-RAN node->>NWDAF: 9. IsAlive() + end + + NG-RAN node->>NG-RAN node: 10. Stop Trace Recording Session + NG-RAN node->>NWDAF: 11. StopRecordingSession() + end + end + end + + 3GPP Management System->>NG-RAN node: 12. Trace Session De-activation/Configuration + NG-RAN node->>NG-RAN node: 13. Stop Trace Session + + loop for each on-going Trace Recording Session + NG-RAN node->>NG-RAN node: 14. Stop Trace Recording Session + + opt there are outstanding trace records + NG-RAN node->>NWDAF: 15. Report() + end + + NG-RAN node->>NWDAF: 16. StopRecordingSession() + end + + NG-RAN node->>NWDAF: 17. StopSession() + NG-RAN node->>NWDAF: 18. Terminate Connection + + Note left of 3GPP Management System: 3GPP Management System + Note right of NG-RAN node: NG-RAN node + Note right of NWDAF: NWDAF + +``` + +The sequence diagram illustrates the interaction between the 3GPP Management System, NG-RAN node, and NWDAF for trace session management. The process is divided into activation and de-activation phases. + +**Activation Phase:** + +- The 3GPP Management System sends a **Trace Session Activation/Configuration** message to the NG-RAN node. +- The NG-RAN node performs an internal **Start Trace Session** operation. +- A **ref** block indicates the start of a sequence of messages: **Establish Websocket Connection** from NG-RAN node to NWDAF, followed by **StartSession()** from NG-RAN node to NWDAF. +- A **loop** titled **[while Trace Session is active]** contains: + - A **loop** titled **[for each traceable UE]** containing: + - Internal operation: **Start Trace Recording Session and allocate new TRSR**. + - Message: **StartRecordingSession()** from NG-RAN node to NWDAF. + - A **loop** titled **[until UE connection termination]** containing: + - A **loop** titled **[while reporting condition is not satisfied]** containing internal operation: **Capture trace record**. + - An **alt** block titled **[there are trace records to report]** containing message: **Report()** from NG-RAN node to NWDAF. + - An **alt** block titled **[there are no trace records to report]** containing message: **IsAlive()** from NG-RAN node to NWDAF. + - Internal operation: **Stop Trace Recording Session**. + - Message: **StopRecordingSession()** from NG-RAN node to NWDAF. + +**De-activation Phase:** + +- The 3GPP Management System sends a **Trace Session De-activation/Configuration** message to the NG-RAN node. +- The NG-RAN node performs an internal **Stop Trace Session** operation. +- A **loop** titled **[for each on-going Trace Recording Session]** contains: + - Internal operation: **Stop Trace Recording Session**. + - An **opt** block titled **[there are outstanding trace records]** containing message: **Report()** from NG-RAN node to NWDAF. + - Message: **StopRecordingSession()** from NG-RAN node to NWDAF. +- Message: **StopSession()** from NG-RAN node to NWDAF. +- Message: **Terminate Connection** from NG-RAN node to NWDAF. + +Sequence diagram showing the interaction between 3GPP Management System, NG-RAN node, and NWDAF for trace session management. + +**Figure 7.1.5.1.1: Example deployment scenario of NG-RAN node producing and NWDAF consuming non-file-based trace reporting MnS under control of 3GPP Management System** + +#### 7.1.5.2 Example of ONAP deployment + +The following figure illustrates ONAP deployment scenario where NG-RAN node produces, and ONAP DCAE consumes non-file-based trace reporting MnS under control of ONAP Controller: + +![Sequence diagram illustrating the ONAP deployment scenario for non-file-based trace reporting. Lifelines: ONAP Controller, gNB, ONAP DCAE Collector Plugin, ONAP DCAE DMAaP, ONAP DCAE Analytical Plugin. The process involves configuration, session establishment, and data delivery loops.](e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg) + +``` + +sequenceDiagram + participant ONAP Controller + participant gNB + participant ONAP DCAE Collector Plugin + participant ONAP DCAE DMAaP + participant ONAP DCAE Analytical Plugin + + Note right of gNB: Continues on the next page + + ONAP Controller->>gNB: 1. Configure (new Trace Session parameters) + gNB->>gNB: 2. Start Trace Session + Note right of gNB: ref 3. Establish Websocket Connection + Note right of gNB: opt [new Trace Reference] + ONAP DCAE Collector Plugin->>ONAP DCAE Collector Plugin: Create new VES mapping + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Create new topic for TR + Note right of gNB: opt + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish topic creation + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Subscribe to new topic + Note right of gNB: end opt + Note right of gNB: end opt + gNB->>ONAP DCAE Collector Plugin: 4. StartSession() + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish(TR, StartSession) + Note right of gNB: loop [for each subscribed application] + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Deliver(TR, StartSession) + Note right of gNB: end loop + Note right of gNB: loop [while Trace Session is active] + Note right of gNB: loop [for each traceable UE] + gNB->>gNB: 5. Start Trace Recording Session and allocate new TRSR + gNB->>ONAP DCAE Collector Plugin: 6. StartRecordingSession() + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish(TR, StartRecordingSession) + Note right of gNB: loop [for each subscribed application] + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Deliver(TR, StartRecordingSession) + Note right of gNB: end loop + Note right of gNB: loop [until UE connection termination] + Note right of gNB: loop [while reporting condition is not satisfied] + gNB->>gNB: 7. Capture trace record + Note right of gNB: alt [there are trace records to report] + gNB->>ONAP DCAE Collector Plugin: 8. Report() + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish(TR, Report) + Note right of gNB: loop [for each subscribed application] + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Deliver(TR, Report) + Note right of gNB: end loop + Note right of gNB: alt [there are no trace records to report] + gNB->>ONAP DCAE Collector Plugin: 9. IsAlive() + Note right of gNB: end alt + Note right of gNB: end loop + gNB->>gNB: 10. Stop Trace Recording Session + gNB->>ONAP DCAE Collector Plugin: 11. StopRecordingSession() + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish(TR, Report) + Note right of gNB: loop [for each subscribed application] + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Deliver(TR, Report) + Note right of gNB: end loop + Note right of gNB: end loop + Note right of gNB: end loop + +``` + +Sequence diagram illustrating the ONAP deployment scenario for non-file-based trace reporting. Lifelines: ONAP Controller, gNB, ONAP DCAE Collector Plugin, ONAP DCAE DMAaP, ONAP DCAE Analytical Plugin. The process involves configuration, session establishment, and data delivery loops. + +**Figure 7.1.5.2.1: Example deployment scenario of NG-RAN node producing and ONAP DCAE consuming non-file-based trace reporting MnS under control of ONAP Controller (part 1)** + +![Sequence diagram showing the interaction between ONAP Controller, gNB, ONAP DCAE Collector Plugin, ONAP DCAE DMAaP, and ONAP DCAE Analytical Plugin for non-file-based trace reporting. The sequence includes steps for configuring, stopping, and reporting trace sessions, with loops for multiple sessions and applications, and optional steps for session termination and topic management.](a149b400127a3e3e50b3c98d27c5935c_img.jpg) + +Continues from the previous page + +``` + +sequenceDiagram + participant ONAP Controller + participant gNB + participant ONAP DCAE Collector Plugin + participant ONAP DCAE DMAaP + participant ONAP DCAE Analytical Plugin + + Note right of ONAP Controller: Continues from the previous page + + ONAP Controller->>gNB: 12. Configure (delete Trace Session Configuration) + gNB-->>ONAP Controller: 13. Stop Trace Session + loop for each on-going Trace Recording Session + gNB-->>ONAP Controller: 14. Stop Trace Recording Session + opt there are outstanding trace records + ONAP Controller->>ONAP DCAE Collector Plugin: 15. Report() + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish(TR, Report) + loop for each subscribed application + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Deliver(TR, Report) + end + end + gNB-->>ONAP Controller: 16. StopRecordingSession() + ONAP Controller->>ONAP DCAE Collector Plugin: Publish(TR, StopRecordingSession()) + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: Publish(TR, StopRecordingSession()) + loop for each subscribed application + ONAP DCAE DMAaP->>ONAP DCAE Analytical Plugin: Deliver(TR, StopRecordingSession()) + end + end + gNB-->>ONAP Controller: 17. StopSession() + opt last session for this Trace Reference + ONAP Controller->>ONAP DCAE Collector Plugin: Delete VES mapping + ONAP DCAE Collector Plugin-->>ONAP Controller: + ONAP Controller->>ONAP DCAE DMAaP: Delete topic for TR + end + opt + ONAP Controller->>ONAP DCAE Collector Plugin: Publish topic deletion + ONAP DCAE Collector Plugin->>ONAP DCAE DMAaP: + ONAP DCAE DMAaP-->>ONAP Controller: Un-subscribe from deleted topic + end + gNB-->>ONAP Controller: 18. Terminate Connection + +``` + +Sequence diagram showing the interaction between ONAP Controller, gNB, ONAP DCAE Collector Plugin, ONAP DCAE DMAaP, and ONAP DCAE Analytical Plugin for non-file-based trace reporting. The sequence includes steps for configuring, stopping, and reporting trace sessions, with loops for multiple sessions and applications, and optional steps for session termination and topic management. + +**Figure 7.1.5.2.2: Example deployment scenario of NG-RAN node producing and ONAP DCAE consuming non-file-based trace reporting MnS under control of ONAP Controller (part 2)** + +# 8 Conclusions and recommendations + +The study has investigated the opportunities for new trace reporting methods such as non-file-based Trace reporting, a.k.a. streaming Trace. + +The study identified and documented use cases for collecting Cell and UE data for analytics, and for Collecting subscriber and equipment trace data for near-real-time diagnostics and troubleshooting. It established that enabling the capabilities for trace data to be delivered to the consumer(s) while it's still relevant to the analytics, diagnostics and troubleshooting tasks performed by the consumer is important. + +The study derived and documented potential requirements to be considered in the normative work. + +The study documented and evaluated potential solutions in various deployment scenarios. + +It is recommended to do normative work enabling the use of non-file-based Trace reporting (a.k.a. streaming Trace) in 3GPP Rel-16 management. + +It is recommended that the normative work includes documenting new requirements and use cases in TS 32.421 [2], new Trace control and configuration management aspects in TS 32.422 [3], and new Trace data encoding format in TS 32.423 [4]. + +It is recommended to consider the use of non-file-based Trace reporting (a.k.a. streaming Trace) for 5G MDT feature in collaboration with 3GPP RAN workgroups. + +# --- Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | SA#85 | SP-190771 | | | | Presented for information and approval | 1.0.0 | +| 2019-09 | SA#85 | | | | | Change control version | 16.0.0 | +| 2019-09 | SA#85 | | | | | EditHelp review | 16.0.1 | +| 2019-12 | SA#86 | SP-191169 | 0001 | 1 | F | Implementation of fixes for issues identified by EditHelp | 16.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28807/07b17a620c75522d53916a11e12d1bff_img.jpg b/marked/Rel-16/28_series/28807/07b17a620c75522d53916a11e12d1bff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e95e0c1d4c7316a31d6ca76ccd343ce59fb57c8a --- /dev/null +++ b/marked/Rel-16/28_series/28807/07b17a620c75522d53916a11e12d1bff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ca1bf9d0d9fc50e35befdf7ea86efd6c689873fc9d82790c5ef9579db39322b +size 31237 diff --git a/marked/Rel-16/28_series/28807/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/28_series/28807/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..efb320c20206e14949174e8fc86722e5339d50a1 --- /dev/null +++ b/marked/Rel-16/28_series/28807/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99bc83de98d68216f67e55d282fce90b0e0c95da1c7803e50b2966f32e505dd9 +size 9427 diff --git a/marked/Rel-16/28_series/28807/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/28_series/28807/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54606e01e5823132920b126adea4f3ade5d1ad58 --- /dev/null +++ b/marked/Rel-16/28_series/28807/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e241c08c2df442f296ea65b2b78ab99d590fd9ea0829dbfbad76ed0f28120f31 +size 5792 diff --git a/marked/Rel-16/28_series/28807/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-16/28_series/28807/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6a6266936d8a482fe9acd856a0f29b69c763b279 --- /dev/null +++ b/marked/Rel-16/28_series/28807/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cda7e132b3a6c2d7c7fd8e2f5cdc0bcd2948bbff77260048d82da9f024c71202 +size 78719 diff --git a/marked/Rel-16/28_series/28807/raw.md b/marked/Rel-16/28_series/28807/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..22b6ae0d0a8f0841fa5f791a6fce0a40437f6a05 --- /dev/null +++ b/marked/Rel-16/28_series/28807/raw.md @@ -0,0 +1,606 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Study on management of non-public networks; (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The 5G logo consists of the text "5G" in a bold, black, sans-serif font. Above the letter "G" are three green, curved lines of increasing size, representing a signal or wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo features the letters "3GPP" in a stylized, bold, black font. The "G" has a red signal icon below it. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 7 | +| 4 Concepts and background ..... | 7 | +| 4.1 General ..... | 7 | +| 4.2 Model of roles ..... | 7 | +| 4.3 Management of Stand-alone Non-Public Networks..... | 8 | +| 4.4 Management of PNI-NPN..... | 9 | +| 4.4.1 NPN supported by network slice instance of a PLMN..... | 9 | +| 5 Use Cases ..... | 11 | +| 5.1 Use cases related to management of stand-alone NPN ..... | 11 | +| 5.1.1 Stand-alone NPN provisioning with 3GPP and non-3GPP segments..... | 11 | +| 5.1.1.1 Create a stand-alone NPN with 3GPP and non-3GPP segments ..... | 11 | +| 5.2 Use cases related to management of PNI-NPN..... | 12 | +| 5.2.1 NPN provisioning by a network slice of a PLMN ..... | 12 | +| 5.2.1.1 Create a Network Slice Instance for a NPN ..... | 12 | +| 5.2.2 Exposure of management capability of NPN ..... | 13 | +| 5.2.2.1 Providing specific management capability of configuration and monitoring to an NPN operator ..... | 13 | +| 5.2.3 UE related data issues..... | 13 | +| 5.2.3.1 Collecting UE related data and providing to authorized NPN service customer..... | 13 | +| 6 Potential requirements..... | 14 | +| 6.1 Potential common requirements for management of NPN ..... | 14 | +| 6.2 Potential requirements for management of SNPN ..... | 14 | +| 6.3 Potential requirements for management of PNI-NPN..... | 14 | +| 7 Potential solutions ..... | 15 | +| 7.1 Solutions for management of SNPN ..... | 15 | +| 7.1.1 Solution for SNPN provisioning with 3GPP and non-3GPP segments..... | 15 | +| 7.1.2 Solution for SNPN provisioning with 3GPP segments only ..... | 16 | +| 7.2 Solutions for management of PNI-NPN..... | 16 | +| 7.2.1 Solution for NPN provisioning by a network slice of a PLMN ..... | 16 | +| 7.2.2 Solution for exposure of management capability of NPN..... | 17 | +| 7.2.3 Solution for collecting UE related data and providing to authorized NPN service customer ..... | 17 | +| 8 Conclusions and recommendations..... | 18 | +| 8.1 Conclusions ..... | 18 | +| 8.1.1 Management of SNPN..... | 18 | +| 8.1.2 Management of PNI-NPN ..... | 18 | +| 8.2 Recommendations ..... | 18 | +| 8.2.1 Management of SNPN..... | 18 | +| 8.2.2 Management of PNI-NPN ..... | 19 | +| <b>Annex A (informative): Change history.....</b> | <b>20</b> | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +A non-public network is a network that is intended for non-public use. Deployments of non-public networks in private environments (e.g. factories, enterprises) to provide coverage within a specific geographic area for non-public use is a key demand of emerging 5G applications and verticals. Non-public networks may be deployed as completely standalone networks or with the support of a PLMN. The 5G system supports non-public networks. + +The present document studies the management aspects of non-public networks. + +# --- 1 Scope + +The present document describes use cases, potential requirements and solutions (from the perspective of services based management architecture) for the management aspects of non-public networks. The present document provides conclusions and recommendations on the next steps for the standardization. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.261: "Service requirements for next generation new services and markets; Stage 1". +- [3] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [4] 5G-ACIA White paper: "5G Non-Public Networks for Industrial Scenarios", July 31, 2019. +- [5] 3GPP TS 23.003: "Numbering, addressing and identification". +- [6] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [7] 3GPP TS 28.530: "Concepts, use cases and requirements". +- [8] 3GPP TR 28.805: "Study on management aspects of communication services". +- [9] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [10] 3GPP TS 28.541: "Management and Orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [11] 3GPP TS 38.331: "NR; Radio Resource Control (RRC); Protocol specification". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +**Non-Public Network:** See definition in TS 22.261 [2]. + +**Public network integrated NPN:** See definition in TS 23.501 [3]. + +**Stand-alone Non-Public Network:** See definition in TS 23.501 [3]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|---------|-------------------------------| +| MnS | Management Service | +| NPN | Non-Public Network | +| PNI-NPN | Public Network Integrated NPN | +| SNPN | Stand-alone NPN | + +# --- 4 Concepts and background + +## 4.1 General + +A Non-Public Network (NPN) is a 5GS deployed for non-public use, see TS 23.501 [3]. In contrast to public networks that offer mobile network services to the general public, non-public networks are intended for the sole use of a private entity such as a college or an enterprise. Non-public networks may be deployed on the entity's defined premises such as a campus or a factory to provide coverage within a specific geographic area. + +Non-public networks may be deployed in a variety of configurations, utilising both virtual and physical network functions, see TS 22.261 [2]. Specifically, see TS 23.501 [3], an NPN may be deployed as: + +- a Stand-alone Non-Public Network (SNPN), i.e. operated by an NPN operator and not relying on network functions provided by a PLMN; or +- a Public network integrated NPN (PNI-NPN), i.e. a non-public network deployed with the support of a PLMN. + +From the view of 5G-ACIA, non-public networks can be desirable for several reasons, see clause 4 of [4]: + +- High quality-of-service requirements +- High security requirements, met by dedicated security credentials +- Isolation from other networks, as a form of protection against malfunctions in the public mobile network. Also, isolation may be desirable for reasons of performance, security, privacy, and safety +- Accountability. A non-public network makes it easier to identify responsibility for availability, maintenance, and operation + +## 4.2 Model of roles + +In the context of NPNs, responsibilities regarding operations have to be clearly defined and assigned to roles. The roles related to NPNs include: + +- NPN operator: designs, builds and operates an NPN providing all the required network services and resources. +- NPN service provider: provides non-public communication services using an NPN. Designs, builds and operates these services, which are supported by the NPN operator provided network services. +- NPN service customer: consumes services offered by an NPN service provider. + +There is a direct mapping between these roles and the ones defined in clause 4.8 of TS 28.530 [7], when network and services under consideration are non-public. The NPN operator role is a particularization of the Network Operator (NOP) role, the NPN service provider role is a particularization of the Communication Service Provider (CSP) role and the NPN service customer role is a particularization of the Communication Service Customer (CSC) role. + +Depending on actual scenarios and the type of NPN under consideration, i.e. SNPN or PNI-NPN, different relationships can be found between NPN related roles and potential stakeholders. This means: + +- each role can be played by one or more organizations simultaneously. For example, in PNI-NPN deployments the NPN operator role can be shared between a MNO and a vertical (or a private company acting on behalf of it). In the same way, in SNPN deployments the NPN operator role can be played by either a vertical (or a private company on behalf of it) or a MNO which manages the SNPN; +- an organization can play one or several roles simultaneously. For example, a company can play both NPN operator and NPN service provider roles. + +## 4.3 Management of Stand-alone Non-Public Networks + +An SNPN is deployed as an independent, isolated network. As shown in figure 4.3-1, all SNPN network functions are located inside the logical perimeter of the defined premises (e.g. factory) and the SNPN is separate from the public network. The SNPN operator has full management control over the exclusive SNPN network functions, e.g. the non-public 5G Core Network and/or 5G Access Network part of SNPN. + +![Diagram illustrating SNPN deployment and management. It shows two separate network clouds. The top cloud is orange and labeled 'SNPN' on the left, containing a yellow box labeled 'SNPN Management'. The bottom cloud is grey and labeled 'PLMN' on the left, containing a blue box labeled 'Public Network Management'.](07b17a620c75522d53916a11e12d1bff_img.jpg) + +The diagram consists of two vertically stacked cloud shapes. The top cloud is light orange and has the label 'SNPN' to its left. Inside this cloud is a yellow rectangular box with the text 'SNPN Management'. The bottom cloud is light grey and has the label 'PLMN' to its left. Inside this cloud is a blue rectangular box with the text 'Public Network Management'. The two clouds are separate, indicating that the SNPN is an independent network from the public network (PLMN). + +Diagram illustrating SNPN deployment and management. It shows two separate network clouds. The top cloud is orange and labeled 'SNPN' on the left, containing a yellow box labeled 'SNPN Management'. The bottom cloud is grey and labeled 'PLMN' on the left, containing a blue box labeled 'Public Network Management'. + +**Figure 4.3-1: SNPN deployment and SNPN management** + +To manage a SNPN, which is based on 3GPP-defined technologies, the standalone SNPN management system needs a dedicated NPN identifier. The combination of a PLMN ID and Network identifier (NID) is used to identify an SNPN. The NID supports two assignment models, see clause 5.30.2 of TS 23.501 [3]: + +- Locally managed NIDs are assumed to be self-managed by SNPNs (i.e. chosen individually by SNPNs) at deployment time (and may therefore not be unique) but use a different numbering space than the universally managed NIDs as defined in TS 23.003 [5]. +- Universally managed NIDs are assumed to be globally unique. + +Additional considerations: + +- With respect to the management of the NG-RAN segment of the SNPN: + - The following roles are involved: + - NPN Service Provider: played by the Vertical. + - NPN Operator: played by the Vertical, for the NG-RAN segment. + +- NPN Service Customer: can be played by Vertical's employees, Vertical's applications, Vertical's customers, etc. +- The NG-RAN segment of the NPN is operated by the Vertical (see note 1, note 2 and note 3); +- The NG-RAN segment of the NPN is deployed in well-defined areas (e.g. within Vertical's premises, factory, along railroad tracks, etc.) to meet the Vertical's requirements; +- Only the Vertical's UEs are authorized to gain access to the NPN; +- The following variants may exist: + - Fully isolated SNPN (see [4] clause 5.2, Figure 1 with the optional connection not being deployed); or + - SNPN partly integrated with a PLMN (see [4] clause 5.2, Figure 1 with the optional connection being deployed from SNPN to PLMN only). In such a case, the management of the connection between the SNPN and the PLMN is shared between proponents. +- With respect to the management of the 5GC segment of the SNPN: + - The following roles are involved: + - NPN Service Provider: played by the Vertical + - NPN Operator: played by the Vertical, for the 5GC segment (see note 1) + - NPN Service Customer: can be played by Vertical's employees, Vertical's applications, Vertical's customers, etc. + - Virtualization Infrastructure Service Provider (VISP): played by a 3<sup>rd</sup>-party cloud service provider. + - The 5GC segment of the NPN is deployed in Vertical's premises. Alternatively, in case of virtualization of some 5GC network functions, the Vertical may rely on one or more VISPs (see TS 28.530 [7], clause 4.8) to host its virtualized 5GC network functions, out of the Vertical's premises; + - In the 5GC segment, the Vertical may utilize 'Network Slice as NOP Internals' model (see TS 28.530 [7], clause 4.1.7) to accommodate services to be provided to its own customers. + +NOTE 1: Whether the Vertical outsources (part of) its network management tasks to other stakeholder(s) is out of scope of the present document. + +NOTE 2: The focus is put here on which roles are involved in the operation of the NPN segments, not on which roles are involved in their deployment. Whether a NPN segment is deployed by the Vertical, or by a Network Operator or by anyone else on behalf of them, is out of scope of the present document + +NOTE 3: How dedicated licensed spectrum is obtained by the Vertical to operate its NPN is out of the scope of the present document. + +## 4.4 Management of PNI-NPN + +### 4.4.1 NPN supported by network slice instance of a PLMN + +A Public Network Integrated NPN (PNI-NPN) can be made available by PLMNs e.g. using one (or more) network slice instance(s). The existing network slicing functionalities apply as described in clause 5.15 of TS 23.501 [3]. + +A Closed Access Group identifies a group of subscribers who are permitted to access one or more CAG cells associated to the CAG. A CAG is identified by a CAG Identifier which is unique within the scope of a PLMN ID, see clause 5.30.3.2 of TS 23.501 [3]. The management system of the PNI-NPN takes charge of the management of CAG Identifiers. + +From a management viewpoint, the provision of a network slice instance can follow the Network Slice as a Service (NSaaS) principles as described in clause 4.1.6 of TS 28.530 [7]. Figure 4.4.1-1, as an example, illustrates how a PLMN operator can rely on NSaaS capabilities (e.g. OAM, exposure) for the provisioning of a PNI-NPN to a vertical. This PNI-NPN, which is deployed across one PLMN and the vertical's premises (e.g. factory), can be seen as an end-to-end network composed of two differentiated segments: one public, consisting of a (R)AN and network functions built upon public 5G network resources; and one private, consisting of network functions deployed using private 5G network resources. Using the NSaaS approach: + +- The public segment is made available by the PLMN in the form of a network slice instance, and provisioned by the PLMN operator using NSaaS. In this service provisioning, the PLMN operator and the vertical play the roles of NSaaS provider and NSaaS customer, respectively. +- The PLMN operator can offer possibilities (e.g. exposed MnS to manage the network slice instance) for the vertical to manage the provided network slice instance according to TS 28.531 [6]. +- The vertical adds the private segment to the network slice instance obtained from the PLMN operator. The resulting combination, i.e. PNI-NPN, is a new network slice instance or a new network. +- In the case of a new network slice instance, following 3GPP 5G Network Resource Model (NRM) [10], the PNI-NPN's public segment can be modelled as a network slice subnet instance whilst the private segment can be modelled as one or more network slice subnet instances according to the vertical's policy. +- In the case of a new network, the PNI-NPN's public segment can be modelled as a network slice instance (i.e. remains unchanged as the network slice instance obtained from the PLMN operator) with interaction with private segment. +- The vertical uses the PNI-NPN to provide non-public communication services to his customer(s). In this case, the vertical plays the role of NPN service provider, and his customer(s) play the role of NPN service customer(s). For more information on these NPN related roles, see clause 4.2. + +![Figure 4.4.1-1: PNI-NPN provisioning with NSaaS. The diagram illustrates the management and network views of a PNI-NPN. In the Management View, the PLMN operator acts as the NSaaS Provider, and the Vertical acts as the NSaaS Customer. The Vertical also acts as the NPN service provider for the NPN Service Customer. OAM (Operations, Administration, and Management) is shown between the PLMN operator and the Network View, and between the Vertical and the Network View. The Network View shows the Data Network connected to a RAN (Radio Access Network) and several NF (Network Functions). The RAN is part of the PLMN, and the NFs are part of the Vertical's premises. The PNI-NPN is shown as a combination of the PLMN and the Vertical's premises. The NSaaS interaction is shown between the PLMN operator and the Vertical.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +The diagram is divided into two horizontal sections: 'Management View' and 'Network View'. + In the 'Management View', on the left, a bracket labeled 'PLMN operator' encompasses a green box labeled 'NSaaS Provider'. On the right, a bracket labeled 'Vertical' encompasses two stacked boxes: 'NPN service provider' (top) and 'NSaaS Customer' (bottom). Above the 'NPN service provider' box is a blue box labeled 'NPN Service Customer'. An oval labeled 'NSaaS' is positioned between the 'NSaaS Provider' and the 'NSaaS Customer'. + In the 'Network View', a cloud labeled 'Data Network' is on the far left. A green dashed rectangle labeled 'Network slice subnet' contains three green boxes labeled 'NF'. To the right of this subnet is a green box labeled 'RAN'. Further right, a vertical dashed red line separates the 'PLMN' segment (left) from the 'Vertical's premises' segment (right). In the 'Vertical's premises', there are three black boxes labeled 'NF'. + Arrows labeled 'OAM' point from the 'NSaaS Provider' and 'NSaaS Customer' down into the 'Network View'. A long double-headed arrow at the bottom, spanning both the 'PLMN' and 'Vertical's premises' segments, is labeled 'PNI-NPN'. + +Figure 4.4.1-1: PNI-NPN provisioning with NSaaS. The diagram illustrates the management and network views of a PNI-NPN. In the Management View, the PLMN operator acts as the NSaaS Provider, and the Vertical acts as the NSaaS Customer. The Vertical also acts as the NPN service provider for the NPN Service Customer. OAM (Operations, Administration, and Management) is shown between the PLMN operator and the Network View, and between the Vertical and the Network View. The Network View shows the Data Network connected to a RAN (Radio Access Network) and several NF (Network Functions). The RAN is part of the PLMN, and the NFs are part of the Vertical's premises. The PNI-NPN is shown as a combination of the PLMN and the Vertical's premises. The NSaaS interaction is shown between the PLMN operator and the Vertical. + +Figure 4.4.1-1: PNI-NPN provisioning with NSaaS + +Additional considerations: + +- With respect to the management of the NG-RAN segment of the PNI-NPN: + - the Network Operator grants access to the Vertical to the whole Network Operator NG-RAN, or only to a part of it; + +- whatever the part of the NG-RAN of the Network Operator which access is granted to the Vertical, this part of the NPN is operated by the Network Operator; +- a roaming agreement or, alternatively, a RAN sharing agreement between the Vertical and the Network Operator may be required; +- one (or more) Closed Access Group(s) (CAG), identifying which Vertical's UEs are permitted to access Network Operator NG-RAN cells may have to be defined. Since only the Network Operator has management access to the NG-RAN, the Vertical and the Network Operator may have to interact (Vertical requests the network Operator to add, delete, modify the list of Vertical's UEs allowed to access the Network Operator cells); +- the same as above applies to CAG cells; +- there may be more than one Network Operator involved in this scenario (e.g. for coverage requirements). +- With respect to the management of the 5GC segment of the PNI-NPN: + - The 5GC segment of the NPN is operated by a Network Operator, whether the 5GC is: + - i) wholly deployed in Vertical's premises (see [4] clause 5.3.1, Figure 2); or + - ii) partly in Vertical's premises (e.g. UPFs) and partly in the Network Operator's domain (e.g. 5GC control plane network functions); or + - iii) wholly in the Network Operator's domain. + - In the 5GC segment, the Network Operator may utilize "Network Slice as a Service" model (see TS 28.530 [7], clause 4.1.7) and/or "Network Slice as NOP internals" model (see TS 28.530 [7], clause 4.1.7). + +# --- 5 Use Cases + +## 5.1 Use cases related to management of stand-alone NPN + +### 5.1.1 Stand-alone NPN provisioning with 3GPP and non-3GPP segments + +#### 5.1.1.1 Create a stand-alone NPN with 3GPP and non-3GPP segments + +A non-public network, which includes 3GPP and non-3GPP segments, needs to be created for use of a private company in the form of a stand-alone NPN. From a management viewpoint, this means that the 3GPP and non-3GPP segments of this NPN are completely independent and separated from PLMN provided network functions. + +The NPN management system in charge of operating this stand-alone NPN consists of: + +- A 3GPP management system, responsible for managing the 3GPP segment of the NPN. +- one (or more) non-3GPP-management system(s), responsible for managing the non-3GPP segment(s) of the NPN. +- An interworking management function, which makes 3GPP and non-3GPP management systems work together without the necessity to introduce modifications on their design. The interworking management function sits on top of these management systems, coordinating the execution of activities across them, by sending one management system notifications about the state of the activities carried out in other management system if necessary. The interworking function is also responsible of performing any necessary model translation when exchanging notifications across 3GPP and non-3GPP management systems. + +The main aspects of management to support the creation of a stand-alone NPN which consists of 3GPP and non-3GPP segments include: + +- The NPN management system receives the requirements of the requested stand-alone NPN from a private company, e.g. coverage requirement within a specific geographic area, isolation requirement, deterministic communication requirements, etc. +- The interworking function decomposes these requirements into 3GPP-related NPN requirements and non-3GPP-related NPN requirements. Based on the NPN requirements from the private company, the 3GPP segment of the NPN may include either only the RAN part or only the CN part or both the RAN and CN parts. This means that 3GPP-related requirements may include either only RAN part-related requirements or only CN part-related requirements or both the RAN part- and CN part-related requirements. +- To trigger the creation of the 3GPP segment for the requested NPN, the 3GPP management system takes the 3GPP-related requirements from the interworking management function. +- Based on the 3GPP-related NPN requirements, the 3GPP management system determines to reuse an existing 3GPP segment or create a new 3GPP segment for the requested NPN. If a 3GPP segment from an existing stand-alone NPN can be reused, the NPN operator may reconfigure that NPN. + +NOTE 1: Reusing the 3GPP segment from an existing NPN requires that the requested NPN and existing NPN can be shared with each other. + +- In case of creating a new 3GPP segment for the NPN: + - Based on RAN part-related requirements, the 3GPP management system determines to utilize new RAN NE(s). + - Based on CN part-related requirements, the 3GPP management system determines to utilize new CN NF(s) or CN NF service(s). +- The 3GPP management system notifies the created 3GPP segment information to the interworking management function. +- To trigger the creation of the non-3GPP segment(s), the non-3GPP management system(s) takes information about created 3GPP segment as well as non-3GPP-related NPN requirements from the interworking management function. + +NOTE 2: How the non-3GPP management system(s) proceeds with the creation of non-3GPP segment(s) is out of the scope of the present document. + +A stand-alone NPN consisting of 3GPP and non-3GPP segments is created. + +## 5.2 Use cases related to management of PNI-NPN + +### 5.2.1 NPN provisioning by a network slice of a PLMN + +#### 5.2.1.1 Create a Network Slice Instance for a NPN + +An operator decides to deploy a PLMN-integrated NPN in the local data network, for example, deploying an NSI at the enterprise's premise or in the factory. The NSI, based on the NPN requirement from the enterprise includes either only the RAN part or only the CN part or both the RAN part and the CN part. + +For the CN part, there may be some network functions/network function services locally deployed at the enterprise's premise or in the factory, and some other network functions/network function services being deployed in the PLMN network (outside of enterprise's premise or outside the factory). This CN part may be supported by two network slice subnet instances. The network slice subnet instance(s) may be dedicated for a single enterprise or may be shared by multiple enterprises. + +For the RAN part, some network functions may be deployed in the PLMN network. This RAN part may be supported by one or more network slice subnet instances. The network slice subnet instance(s) may be dedicated for a single enterprise or may be shared by multiple enterprises. + +The main aspects of management to support NSI creation for a NPN includes: + +- Based on the NPN SLA requirements from NPN customer, for example coverage requirement within a specific geographic area, slicing isolation level requirement, downlink/uplink throughput requirements, latency requirement, 3GPP management system determines the requirements for both the RAN part and the CN part. +- 3GPP management system determines to reuse an existing NSI or create a new NSI for the NPN. If an existing NSI can be reused, the operator may reconfigure the existing NSI. +- In case of creating a new NSI for the NPN: + - The 3GPP management system determines to utilize the existing RAN NE(s) or a new RAN NEs. + - The 3GPP management system determines to utilize new or existing CN NF(s) or CN NF service(s) of the CN part that are deployed in the PLMN network. + - The 3GPP management system determines to utilize new CN NF(s) or CN NF service(s) of the CN part that are deployed locally at the enterprise's premise or in the factory. + +An NSI for a NPN is created. + +### 5.2.2 Exposure of management capability of NPN + +#### 5.2.2.1 Providing specific management capability of configuration and monitoring to an NPN operator + +A PLMN operator has created an NSI, which includes either only the RAN part or only the CN part or both the RAN part and the CN part, for an enterprise. CN part is provided by the PLMN operator and the RAN part is either provided by the PLMN operator or the NPN operator. + +The service request from the NPN customer includes a requirement of a limited management capability exposure which would enable the NPN customer to dynamically change the configuration parameters and policies related to traffic controlling and performance monitoring and associated data analytics requirements. The NPN customer can then use the NPN most effectively for its traffic. As an example, an NPN network may have a partial failure and running with limited capabilities and in such a situation, only the critical traffic is allowed by means of admission control or prioritization as required by the NPN customer which may depend on the network condition and traffic demand at that time. + +The performance monitoring capabilities that may be provided to the NPN customer may include creation of certain measurement jobs and selecting the type of data analytics and performance to be monitored, e.g., performance related to various traffic types, geographical areas, different device types, for a specific group of devices, for certain traffic congestion situation and analytical KPIs related to performance predictions. + +### 5.2.3 UE related data issues + +#### 5.2.3.1 Collecting UE related data and providing to authorized NPN service customer + +UEs under service of NPN may have various forms, such as phones or PCs or IoT terminals, some of them are assets of the NPN service customer. In some cases, UE related data including UE locations, measurements, etc. is required by the NPN service customer to help their own business. Such UE related data is easier or more cost-efficient to be acquired by NPN UEs compared with being acquired by other methods e.g. by add-on devices or applications. For example, healthcare industry NPN customers require location information of their NPN UEs applied in mobile medical machines for asset management; enterprise NPN customers require location information of the NPN UEs of their employees for attendance management. + +In this case, the NPN management system may need to collect UE related data and provide to authorized NPN service customer. Such collected UE related data are generated by management services which are defined and implemented in 3GPP system, such as: + +- MDT data, including Immediate MDT, Logged MDT, RLF reports, accessibility measurements. +- Trace data, to track traffic process of UEs and locate possible causes of traffic problems for example. + +Furthermore, according to pre-defined agreements among the NPN roles (see clause 4.2), some specific UE related data can be provided to authorized NPN customer, e.g. to promote their positioning ability or evaluate QoE. Such data may be processed or masked based on collected data such as MDT or trace. For example, GNSS information can be distracted from MDT to locate assets in NPN. + +# --- 6 Potential requirements + +## 6.1 Potential common requirements for management of NPN + +**REQ-NPN-CON-01** The 3GPP management system shall have the capability to monitor the performance metrics related to an NPN. + +**REQ-NPN-CON-02** The 3GPP management system shall have the capability to provide KPIs related to an NPN to authorized NPN service provider or NPN service consumer. + +**REQ-NPN-CON-03** The 3GPP management system shall have the capability to receive SLA from authorized NPN service consumer and then translating the SLA into network resources related requirements. + +**REQ-NPN-CON-04** The 3GPP management system shall have the capability to evaluate SLS fulfilment related to an NPN. + +**REQ-NPN-CON-05** The 3GPP management system shall have the capability to manage an NPN that provide coverage within a specific geographic area. + +**REQ-NPN-CON-06** The 3GPP management system shall have the capability to manage identifiers for a large number of NPNs to minimize collision probability between assigned identifiers. + +## 6.2 Potential requirements for management of SNPN + +**REQ-SNPN-CON-01** The 3GPP management system shall have the capability to support standalone operation of an NPN without dependency on a PLMN. + +**REQ-SNPN-CON-02** The 3GPP management system shall have the capability to support management of dedicated NPN identifier which is used to identify an SNPN. + +**REQ-SNPN-CON-03** The 3GPP management system shall have the capability to interwork with one or more non-3GPP management systems to support the operation of a SNPN which includes 3GPP and non-3GPP segments. + +## 6.3 Potential requirements for management of PNI-NPN + +**REQ-PNIN-CON-01** The 3GPP management system shall have the capability to support management of CAG which identifies a group of subscribers who are permitted to access one or more CAG cells associated to the CAG. + +**REQ-PNIN-CON-02** The 3GPP management system shall have the capability to configure a CAG cell with a CAG list containing up to 12 CAG-identifiers, as defined in TS 38.331 [11]. + +**REQ-PNIN-CON-03** The 3GPP management system shall have the capability to support exposure of management services defined in clause 6.1 of TS 28.531 [6] to authorized NPN service consumer. + +**REQ-PNIN-CON-04** The 3GPP management system shall have the capability to collect NPN UE related data which may include MDT data and trace data. + +**REQ-PNIN-CON-05** The 3GPP management system shall have the capability to provide NPN UE related data to authorized NPN service customer according to pre-defined agreements. + +**REQ-PNIN-CON-06** The 3GPP management system shall have the capability to provision a PNI-NPN using Network Slice as a Service (NSaaS), with the Vertical taking the NSaaS customer role. + +# 7 Potential solutions + +## 7.1 Solutions for management of SNPN + +### 7.1.1 Solution for SNPN provisioning with 3GPP and non-3GPP segments + +An SNPN, which includes 3GPP and non-3GPP segments, needs to be created for use of a NPN service customer (e.g. a private company). From management viewpoint, this means that the 3GPP and non-3GPP segments of this NPN are completely independent and separated from PLMN provided network functions. + +- 1) NPN service provider, receives SLA information of the requested SNPN from NPN service customer. The SLA information may include coverage requirement within a specific geographic area, isolation requirement, deterministic communication requirements, etc. +- 2) The NPN service provider translates the received SLA information into SLA requirements, i.e. the service and network requirements derived from SLA. The solution for translation of SLA into SLA requirements documented in clause 6.2 of TR 28.805 [8] may be reused for the context of NPN service. +- 3) The NPN service provider decomposes these requirements into 3GPP-related NPN requirements and non-3GPP-related NPN requirements: + - a) Based on the NPN requirements from NPN service customer, the 3GPP-related NPN requirements may include either only RAN part-related requirements or only CN part-related requirements or both the RAN part- and CN part-related requirements. +- 4) The NPN service provider sends the 3GPP-related NPN requirements to NPN operator to trigger the provisioning of the 3GPP segment for the requested NPN. +- 5) Based on the 3GPP-related NPN requirements, the NPN operator determines to reuse an existing 3GPP segment or create a new 3GPP segment for the requested NPN. If a 3GPP segment from an existing stand-alone NPN can be reused, the NPN operator may reconfigure that NPN: + - a) In case of creating a new 3GPP segment for the NPN: + - Based on RAN part-related requirements, the 3GPP network management system determines to utilize new RAN NE(s). + - Based on CN part-related requirements, the 3GPP network management system determines to utilize new CN NF(s) or CN NF service(s). +- 6) The NPN operator notifies the created 3GPP segment information (e.g. a dedicated SNPN identifier which is the combination of a PLMN ID and NID, see clause 5.30.2 of TS 23.501 [3]) to the NPN service provider. +- 7) To trigger the provisioning of the non-3GPP segment(s), the non-3GPP management system(s) takes information about created 3GPP segment as well as non-3GPP-related NPN requirements from an interworking management function which makes 3GPP and non-3GPP management systems work together without the necessity to introduce modifications on their design or the 3GPP network management system. + +NOTE 1: The interworking management function sits on top of 3GPP and non-3GPP management systems, coordinating the execution of activities across them, by sending one management system notifications about the state of the activities carried out in other management system if necessary. The interworking function is also responsible of performing any necessary model translation when exchanging notifications across 3GPP and non-3GPP management systems. + +NOTE 2: How the non-3GPP management system(s) proceeds with the creation of non-3GPP segment(s) is out of the scope of the present document. + +- 8) A stand-alone NPN consisting of 3GPP and non-3GPP segments is created. + +### 7.1.2 Solution for SNPN provisioning with 3GPP segments only + +An SNPN, which includes 3GPP segment only, needs to be created for use of a NPN service customer (e.g. a private company). From management viewpoint, this means that the 3GPP segment of this NPN are completely independent and separated from PLMN provided network functions. + +- 1) NPN service provider receives SLA information of the requested SNPN from NPN service customer. The SLA information may include coverage requirement within a specific geographic area, isolation requirement, deterministic communication requirements, etc. +- 2) The NPN service provider converts the received SLA information to SLA requirements, i.e. the service and network requirements derived from SLA. The solution for translation of SLA into SLA requirements documented in clause 6.2 of TR 28.805 [8] may be reused for the context of NPN service. +- 3) Based on the NPN requirements from NPN service customer, the 3GPP-related NPN requirements may include either only RAN part-related requirements or only CN part-related requirements or both the RAN part- and CN part-related requirements. +- 4) The NPN service provider sends the 3GPP-related NPN requirements to NPN operator to trigger the provisioning of the 3GPP segment for the requested NPN. +- 5) Based on the 3GPP-related NPN requirements, the NPN operator determines to reuse an existing 3GPP segment or create a new 3GPP segment for the requested NPN. If a 3GPP segment from an existing stand-alone NPN can be reused, the NPN operator may reconfigure that NPN: + - a) In case of creating a new 3GPP segment for the NPN: + - Based on RAN part-related requirements, the 3GPP network management system determines to utilize new RAN NE(s). + - Based on CN part-related requirements, the 3GPP network management system determines to utilize new CN NF(s) or CN NF service(s). +- 6) The NPN operator notifies the created 3GPP segment information (e.g. a dedicated SNPN identifier which is the combination of a PLMN ID and NID, see clause 5.30.2 of TS 23.501 [3]) to the NPN service provider. +- 7) A stand-alone NPN consisting of 3GPP segment only is created. + +## 7.2 Solutions for management of PNI-NPN + +### 7.2.1 Solution for NPN provisioning by a network slice of a PLMN + +An NPN operator decides to deploy a PNI-NPN in the local data network, for example, by deploying an NSI at the enterprise's premise or in the factory. The NSI, based on the requirements from the NPN service customer, includes either only the RAN part or only the CN part or both the RAN part and the CN part. + +The main aspects of NPN provisioning by a network slice of a PLMN include: + +- 1) CSMF receives SLA information from NPN service customer (e.g. a private company), the SLA information may include coverage requirement within a specific geographic area, isolation requirement, downlink/uplink throughput requirements, latency requirement, etc. +- 2) The CSMF translates the received SLA information to SLA requirements, i.e. the service and network requirements derived from SLA, the solution for translation of SLA into SLA requirements documented in clause 6.2 of TR 28.805 [8] may be reused for the context of NPN service. +- 3) Based on the translated NPN SLA requirements from CSMF, NSMF determines the requirements for NG-RAN part and/or 5GC part and/or TN part: + - a) If any, the NG-RAN domain related requirements are provided to NSSMF which manages NG-RAN domain. + - b) If any, the 5GC domain related requirements are provided to NSSMF which manages 5GC domain. + +- c) If any, the TN domain related requirements are provided to the management system of TN domain. +- 4) NSMF determines to reuse an existing NSI or create a new NSI for the NPN. If an existing NSI can be reused, the NSMF may reconfigure the existing NSI. + - 5) In case of creating a new NSI for the NPN, based on the requirements from the NPN service customer (e.g. enterprise, factory) includes either only the RAN part or only the CN part or both the RAN part and the CN part: + - The NG-RAN domain NSSMF determines to utilize the existing NG-RAN NE(s) or new NG-RAN NEs that are deployed in the PLMN network or deployed locally at the enterprise's premise or in the factory. + - The 5GC domain NSSMF determines to utilize new or existing 5GC NF(s) or 5GC NF service(s) of the 5GC part that are deployed in the PLMN network or deployed locally at the enterprise's premise or in the factory. + - If any, the TN domain related requirements are provided to the management system of TN domain. + - 6) An NSI for a PNI-NPN is allocated. + +### 7.2.2 Solution for exposure of management capability of NPN + +Authorized NPN management service consumer can obtain certain management capability to manage the NPN (e.g., provisioning, monitoring) from NPN management service producer according to their pre-defined agreements. + +- Using exposure of generic provisioning management services (see clause 5 of TS 28.532 [9]) and management services for provisioning of networks and network slicing (see clause 6 of TS 28.531 [6]), NPN customers can dynamically change the configuration parameters and policies related to performance monitoring. +- Using exposure of generic fault supervision management service (see clause 6 of TS 28.532 [9]) and generic performance assurance management service (see clause 7 of TS 28.532 [9]), NPN customers can create certain measurement jobs and select the type of data analytics and performance to be monitored, e.g., performance related to various traffic types, geographical areas, different device types, for a specific group of devices, for certain traffic congestion situation and analytical KPIs related to performance predictions. + +Depending on different scenarios, an NPN role can play management service consumer or management service producer simultaneously. For example, an NPN service provider A can be management service consumer and management service producer simultaneously for the following cases: + +- NPN service provider A acts as a management service consumer who obtain the allowed management capability to manage the NPN A provided by NPN management service producer (e.g. NPN operator A). +- Another NPN service provider B acts as a management service consumer who obtain the allowed management capability to manage the NPN B provided by NPN service provider A as the NPN management service producer. + +### 7.2.3 Solution for collecting UE related data and providing to authorized NPN service customer + +UEs under service of NPN are assets of NPN service customer in some cases. UE related data including UE locations, measurements, etc. can help NPN service customer own business. + +Authorized NPN service customer can obtain the following NPN UE related data from NPN operator according to their pre-defined agreements. + +- MDT data, including Immediate MDT, Logged MDT, RLF reports, accessibility measurements. +- Trace data, to track traffic process of UEs and locate possible causes of traffic problems for example. +- Furthermore, according to pre-defined agreements among the NPN roles (see clause 4.2), some specific UE related data can be provided to authorized NPN customer, such data may be processed or masked based on collected data such as MDT or trace. For example, GNSS information can be distracted from MDT to locate assets in NPN. + +# 8 Conclusions and recommendations + +## 8.1 Conclusions + +### 8.1.1 Management of SNPN + +The study has identified use cases, potential requirements and solutions for management of SNPN. + +To manage a SNPN which is based on 3GPP-defined technologies, the study has identified that the SNPN management system needs to allocate and manage a dedicated NPN identifier for the SNPN. The combination of a PLMN ID and NID is used as a dedicated NPN identifier to identify an SNPN. + +The NPN service provider role can be played by a vertical (or a 3<sup>rd</sup> party service provider acting on behalf of it) or a MNO which provides non-public services. + +The NPN operator role can be played by either a vertical (or a private company on behalf of it) or a MNO which manages the SNPN. + +### 8.1.2 Management of PNI-NPN + +The study has identified use cases, potential requirements and solutions for management of PNI-NPN. + +The NPN service provider role can be played by a vertical (or a private company acting on behalf of it) or a MNO which provides the NPN service. + +The NPN operator role can be played by a MNO or be shared between a MNO and a vertical (or a private company acting on behalf of it). + +To manage a PNI-NPN which is made via PLMN, the study has identified that the PNI-NPN management system needs to allocate and manage CAG identifiers. + +The NPN operator can offer possibilities (e.g. exposed MnS to manage the network slice instance) for the NPN service provider to manage the NPN network slice instance according to TS 28.531 [6]. + +Authorized NPN service customer can obtain NPN UE related data (e.g. MDT and trace data) from NPN operator according to their pre-defined agreements. + +## 8.2 Recommendations + +### 8.2.1 Management of SNPN + +To manage an SNPN, which includes 3GPP and non-3GPP segments, it is recommended to manage the 3GPP and non-3GPP segments of this NPN separately, means: + +- Using 3GPP management system to manage 3GPP segments of NPN which are completely independent and separated from PLMN provided network functions. +- Using non-3GPP management system to manage non-3GPP segments. +- How the non-3GPP management system(s) cooperate with 3GPP management system, for example, an interworking management function, which makes 3GPP and non-3GPP management systems work together without the necessity to introduce modifications on their design, needs further work during the normative work on the management of SNPN in Rel-17. + +To manage a SNPN which is based on 3GPP-defined technologies, it is recommended to allocate and manage a dedicated NPN identifier for the SNPN. The combination of a PLMN ID and NID is used as a dedicated NPN identifier to identify an SNPN. For other aspects of management, it is recommended to re-use and enhance the existing 3GPP network management solutions as much as possible. + +### 8.2.2 Management of PNI-NPN + +To manage PNI-NPN, it is recommended to start further normative work focusing on the following main aspects: + +- NPN specific SLA translation, such as specific SLA information which may include coverage requirement within a specific geographic area, specific isolation requirement, specific latency requirement, etc. +- NPN specific SLA assurance. +- NPN specific KPI reporting and performance measurements. + +It is recommended to re-use and enhance the existing 3GPP network management solutions as much as possible. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|------------------------------------------------------------------------------------------------------|----|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 04-2019 | SA5#125 | S5-193146 | | | | Skeleton | | 0.0.0 | +| 04-2019 | SA5#125 | S5-193521 | | | | Editorial changes | | 0.0.1 | +| 08-2019 | SA5#126 | S5-195881<br>S5-195883<br>S5-195282<br>S5-195884 | | | | Update to implement the agreed pCRs in SA5#126:<br>1. S5-195881 pCR TR 28.807 NPN terminologies and abbreviations<br>2. S5-195883 pCR 28.807 Add scope of TR<br>3. S5-195282 pCR 28.807 Add concept of NPN<br>4. S5-195884 pCR TR 28.807 UC public network integrated NPN deployment | | 0.1.0 | +| 10-2019 | SA5#127 | S5-196713<br>S5-196734<br>S5-196710<br>S5-196709<br>S5-196711<br>S5-196712<br>S5-196737<br>S5-196736 | | | | Update to implement the agreed pCRs in SA5#127:<br>1. S5-196713 pCR TR 28.807 Roles related to NPN management<br>2. S5-196734 UC Deployment of a stand-alone NPN with 3GPP and non-3GPP segments<br>3. S5-196710 pCR 28.807 Update on general concept<br>4. S5-196709 pCR 28.807 clean-up use case of NPN provisioning by a network slice of a PLMN<br>5. S5-196711 pCR 28.807 Management of stand-alone non-public networks<br>6. S5-196712 pCR 28.807 Management of public network integrated NPN<br>7. S5-196737 pCR 28.807 Add requirements for management of public network integrated NPN<br>8. S5-196736 pCR 28.807 Add use case of providing traffic management and monitoring capability to an NPN operator | | 0.2.0 | +| 11-2019 | SA5#128 | S5-197557<br>S5-197313<br>S5-197558<br>S5-197563<br>S5-197561<br>S5-197800 | | | | Update to implement the agreed pCRs in SA5#128:<br>1. S5-197557 pCR 28.807 Clean-up for roles related to NPN management<br>2. S5-197313 pCR 28.807 Clarification on NPN use cases<br>3. S5-197558 pCR 28.807 Add potential requirements for management of NPN<br>4. S5-197563 pCR 28.807 Add clauses for solutions and conclusions<br>5. S5-197561 Add NPN management use case<br>6. S5-197800 Add potential requirement for management of NPN | | 0.3.0 | +| 03-2020 | SA5#129e | S5-201593<br>S5-201594<br>S5-201595<br>S5-201596 | | | | Update to implement the agreed pCRs in SA5#129e:<br>1. S5-201593 pCR 28.807 Add introduction<br>2. S5-201594 pCR 28.807 Solutions and conclusion for mgmt of SNPn<br>3. S5-201595 pCR 28.807 Solutions and conclusion for mgmt of PNI-NPN<br>4. S5-201596 pCR 28.807 Network Slice as a Service in the management of PNI-NPN | | 0.4.0 | +| 2020-03 | SA#87-e | SP-200199 | | | | Presented for information | | 1.0.0 | +| 04-2020 | SA5#130e | S5-202196<br>S5-202197<br>S5-202198<br>S5-202336<br>S5-202337<br>S5-202338<br>S5-202339 | | | | Update to implement the agreed pCRs in SA5#130e:<br>1. S5-202196 pCR 28.807 Use PNI-NPN terminology<br>2. S5-202197 pCR 28.807 Rapporteur clean up proposal<br>3. S5-202198 pCR 28.807 clarification on NPN supported by network slice instance of a PLMN<br>4. S5-202336 pCR 28.807 Add CAG configuration requirement<br>5. S5-202337 pCR 28.807 Add management requirement<br>6. S5-202338 pCR 28.807 Add requirements for management of SNPn and PNI-NPN<br>7. S5-202339 pCR 28.807 Additional considerations on NPN | | 1.1.0 | +| 06-2020 | SA5#131e | S5-203162<br>S5-203163 | | | | Update based on MCC EditHelp version.<br>Update to implement the agreed pCRs in SA5#131e:<br>1. S5-203162 pCR 28.807 Rapporteur clean up proposal<br>2. S5-203163 pCR 28.807 Update on recommendation for management of PNI-NPN | | 1.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28808/171115f072e42b379238ed0dd438e9d7_img.jpg b/marked/Rel-16/28_series/28808/171115f072e42b379238ed0dd438e9d7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07ddcd5a2bb94cf55eed7ee1f6e48c34322608b6 --- /dev/null +++ b/marked/Rel-16/28_series/28808/171115f072e42b379238ed0dd438e9d7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63f299f6b3ddcc4b7a338918a89412ba2fd371b4b4dfee5b42d6066df52b1678 +size 42053 diff --git a/marked/Rel-16/28_series/28808/19a59d6b53059ebd27b13c98793f88e0_img.jpg b/marked/Rel-16/28_series/28808/19a59d6b53059ebd27b13c98793f88e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57961bd8bb429bb5d9fbaa8e5ccffa62ac5b3f73 --- /dev/null +++ b/marked/Rel-16/28_series/28808/19a59d6b53059ebd27b13c98793f88e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:014b463971a4d7a2eea49ca666ad5a69e0cda830324993050e0f303f180ff622 +size 25813 diff --git a/marked/Rel-16/28_series/28808/3e0c2bf6c51c575d096c7fc95c1e8454_img.jpg b/marked/Rel-16/28_series/28808/3e0c2bf6c51c575d096c7fc95c1e8454_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..434933241411f4452a09d0c3f7fc97077297bb13 --- /dev/null +++ b/marked/Rel-16/28_series/28808/3e0c2bf6c51c575d096c7fc95c1e8454_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:589443cf6d783f80359a47ecf89d235def62f917426aacb4716caf5d76cad26f +size 48105 diff --git a/marked/Rel-16/28_series/28808/421fc75480c21e7ebb25756826652367_img.jpg b/marked/Rel-16/28_series/28808/421fc75480c21e7ebb25756826652367_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f8d1ced7fae271f0fae51bd6e2188ad64ff4c6de --- /dev/null +++ b/marked/Rel-16/28_series/28808/421fc75480c21e7ebb25756826652367_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4cdceb545dde591ec4602be62ffdfeb71c0810ac8c281ba25fa83f3fb5b142c9 +size 20166 diff --git a/marked/Rel-16/28_series/28808/5793a44ffdadd039928e2f9fe6daae06_img.jpg b/marked/Rel-16/28_series/28808/5793a44ffdadd039928e2f9fe6daae06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da204194d9963ac6869b8d0e4e5c91f6e84da0ae --- /dev/null +++ b/marked/Rel-16/28_series/28808/5793a44ffdadd039928e2f9fe6daae06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ea98efd8f67203829e705bddcc105f1be9e4085ec991e0da023c886ecaf2e55 +size 26278 diff --git a/marked/Rel-16/28_series/28808/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/28_series/28808/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d8cc62f3f0e35ede859ffad4a5ee8ef932a6cdfc --- /dev/null +++ b/marked/Rel-16/28_series/28808/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b992277ee3bc836dcad66a164335349cf0dabae7bee612f3728915f638a64a7 +size 7720 diff --git a/marked/Rel-16/28_series/28808/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/28_series/28808/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75c42d7c11c8998deabe996404ae0a9606a484dc --- /dev/null +++ b/marked/Rel-16/28_series/28808/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:468137148f5fedf1a756cb4c2414909a33dfb8c8680d5b3815b36f47bb3b91e2 +size 5780 diff --git a/marked/Rel-16/28_series/28808/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/28_series/28808/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcc4d81488eebcca29ba4c6542f269a7f6a315fb --- /dev/null +++ b/marked/Rel-16/28_series/28808/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e2a18c26e3e696fb3d138814c143ff8528a59b01c4db93972b06246cdcc7307 +size 69494 diff --git a/marked/Rel-16/28_series/28808/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/28_series/28808/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f1d0f2a53cf60dce0ab8cdb36a6f0c95f70accf0 --- /dev/null +++ b/marked/Rel-16/28_series/28808/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32e7c44a97b87700f765b55e751e3c12d9a1ecaa24dff8bbbc0fe497278fc9c1 +size 16790 diff --git a/marked/Rel-16/28_series/28808/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg b/marked/Rel-16/28_series/28808/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4fab4381ba51a9308ed105b1224d84af0274a158 --- /dev/null +++ b/marked/Rel-16/28_series/28808/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63f18452be3708a85bc0e96a9506bbf3b77938ac87009604d1bf03adb4a51d17 +size 27848 diff --git a/marked/Rel-16/28_series/28808/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/28_series/28808/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8b0c3ff3859b5c23b0b692e3256adea5b511145b --- /dev/null +++ b/marked/Rel-16/28_series/28808/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:765f35709171bb42515e145ff70f2334b76d189de984a77859a02b01579f4796 +size 41341 diff --git a/marked/Rel-16/28_series/28808/b28af4985cdef1e519e3aaf26561dcb3_img.jpg b/marked/Rel-16/28_series/28808/b28af4985cdef1e519e3aaf26561dcb3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..003c1e53b118c78e028506abb4527983577f52d4 --- /dev/null +++ b/marked/Rel-16/28_series/28808/b28af4985cdef1e519e3aaf26561dcb3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1584fb33b3b318fc68c269523bafeccd90243cbc18e0d89cf56ad9b167d090e0 +size 41369 diff --git a/marked/Rel-16/28_series/28808/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/28_series/28808/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5249c6091d0d80b77f3a5930b266c84d5ba8779d --- /dev/null +++ b/marked/Rel-16/28_series/28808/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1653d388a0c52daf4377bc8cbe20d1ee4cc644d2aac3b8a0fe118e0059cd0d75 +size 53636 diff --git a/marked/Rel-16/28_series/28808/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-16/28_series/28808/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aab30686dc3bb23a422249fc2b2e7ca41983818c --- /dev/null +++ b/marked/Rel-16/28_series/28808/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f71345a79c00de1635b93ef92c82a5623fc1fdc909d579070030ae9a0848a5c8 +size 36822 diff --git a/marked/Rel-16/28_series/28808/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg b/marked/Rel-16/28_series/28808/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6136f86992882fa3acef07d612a508722fa1bdda --- /dev/null +++ b/marked/Rel-16/28_series/28808/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29e0877894dd7957ee902a58d91fd7524e4335c5f0e85538e0ec150809e002cf +size 41776 diff --git a/marked/Rel-16/28_series/28808/cd1fc67b0180f1bff43410ac3b644c46_img.jpg b/marked/Rel-16/28_series/28808/cd1fc67b0180f1bff43410ac3b644c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95d104fedd162b86c39c73af5801de9a5b5b9ec8 --- /dev/null +++ b/marked/Rel-16/28_series/28808/cd1fc67b0180f1bff43410ac3b644c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:133e381aadca60990a957a8bb0a441e2a8f7b41f1d1975141fb1fb4040ffd5de +size 10895 diff --git a/marked/Rel-16/28_series/28808/e1a0d046fbe7f28f5e93a47091851747_img.jpg b/marked/Rel-16/28_series/28808/e1a0d046fbe7f28f5e93a47091851747_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..96b39c314202db45135dccf3cb1b7631941605ab --- /dev/null +++ b/marked/Rel-16/28_series/28808/e1a0d046fbe7f28f5e93a47091851747_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21a67097e0f63a516929e0bac1208219d365af7fbf4ceca31385f95a3b104133 +size 54537 diff --git a/marked/Rel-16/28_series/28808/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/28_series/28808/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9f5316a0748e7c697b9b9c1da9a0c249fd7514c --- /dev/null +++ b/marked/Rel-16/28_series/28808/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8af91fe7bc7f374204017c09bc34ab7f5a941b614be8823e9d1f0a7f45199436 +size 28784 diff --git a/marked/Rel-16/28_series/28808/raw.md b/marked/Rel-16/28_series/28808/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..783836af84b29f3be39107f2bcb38275c419d774 --- /dev/null +++ b/marked/Rel-16/28_series/28808/raw.md @@ -0,0 +1,901 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects Study on management and orchestration aspects with integrated satellite components in a 5G network (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, stylized font. The "3G" is larger and more prominent than the "PP". Below the "G" is a red signal wave icon. To the right of the "P" is a small "TM" symbol. + +3GPP logo + +A GLOBAL INITIATIVE + +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. + +--- + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 6 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Concepts and Background ..... | 8 | +| 4.1 Reference management architecture for integrated satellite components ..... | 8 | +| 4.1.1 Management architecture for integrated satellite NR-RAT ..... | 8 | +| 4.1.2 Management architecture for integrated non-3GPP satellite RAN ..... | 8 | +| 4.2 Architecture scenarios for 5G networks with an integrated satellite component..... | 9 | +| 4.2.1 Scenario #1: Satellite enabled 3GPP network as a roaming network for terrestrial network operators..... | 9 | +| 4.2.2 Scenario #2: A 3GPP network with a satellite access network and a terrestrial access network..... | 10 | +| 5 Use Cases ..... | 10 | +| 5.1 Use cases related to network slice management ..... | 10 | +| 5.1.1 Network slice instance(s) associated with a satellite RAN ..... | 10 | +| 5.1.1.1 Create a network slice instance associated with a satellite RAN ..... | 10 | +| 5.1.1.1.1 Pre-conditions..... | 10 | +| 5.1.1.1.2 Description ..... | 10 | +| 5.1.1.1.3 Post-conditions ..... | 11 | +| 5.1.2 RAN sharing of a 5G network with satellite components ..... | 11 | +| 5.1.2.1 Pre-conditions..... | 11 | +| 5.1.2.2 Description ..... | 11 | +| 5.1.2.3 Post-conditions ..... | 11 | +| 5.1.3 Handling of latencies associated with satellite components..... | 11 | +| 5.1.3.1 Creating and managing sliced associated with satellite components ..... | 11 | +| 5.1.3.1.1 Pre-conditions..... | 11 | +| 5.1.3.1.2 Description ..... | 11 | +| 5.1.3.1.3 Post-conditions ..... | 12 | +| 5.1.4 Network slice instance(s) associated with both a Satellite RAN and a Terrestrial RAN ..... | 12 | +| 5.1.4.1 Pre-conditions..... | 12 | +| 5.1.4.2 Description ..... | 12 | +| 5.1.4.3 Post-conditions ..... | 12 | +| 5.2 Use cases for the management of satellite components ..... | 13 | +| 5.2.1 Use case for NGSO regenerative satellite components ..... | 13 | +| 5.2.1.1 Pre-conditions ..... | 13 | +| 5.2.1.2 Description..... | 13 | +| 5.2.1.3 Post-description ..... | 13 | +| 5.2.2 Use case for NGSO transparent satellite components ..... | 13 | +| 5.2.2.1 Pre-conditions ..... | 13 | +| 5.2.2.2 Description..... | 13 | +| 5.2.2.3 Post-description ..... | 13 | +| 5.3 Use cases for monitoring of satellite components..... | 13 | +| 5.3.1 Use case for monitoring of performances of NGSO satellite components with split gNBs ..... | 13 | +| 5.3.1.1 Goal..... | 13 | +| 5.3.1.2 Pre-conditions ..... | 13 | +| 5.3.1.3 Description..... | 14 | +| 5.3.1.4 Post-description ..... | 14 | +| 5.3.2 Use case for monitoring of average delay on DL-Air Interface for MEO and GEO satellite components..... | 14 | +| 5.3.2.1 Goal..... | 14 | +| 5.3.2.2 Pre-conditions ..... | 14 | +| 5.3.2.3 Description..... | 14 | + +| | | | +|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|-----------| +| 5.3.2.4 | Post-description ..... | 14 | +| 5.3.3 | Multi-RAT load-balancing associated with both a Satellite RAN and a Terrestrial RAN..... | 14 | +| 5.3.3.1 | Pre-conditions ..... | 14 | +| 5.3.3.2 | Description ..... | 14 | +| 5.1.3.3 | Post-conditions ..... | 15 | +| 6. | Potential Requirements ..... | 16 | +| 6.1 | Network slice management..... | 16 | +| 6.1.1 | Network slice instance(s) associated with a satellite RAN ..... | 16 | +| 6.1.2 | Network slice instance(s) associated with satellite RAN sharing ..... | 16 | +| 6.1.3 | Network slice instance(s) associated with satellite component latencies..... | 16 | +| 6.1.4 | Network slice instance(s) associated with both a Satellite RAN and a Terrestrial RAN..... | 16 | +| 6.2 | Management of satellite components..... | 16 | +| 6.2.1 | Management of NGSO regenerative satellite components..... | 16 | +| 6.2.2 | Management of NGSO transparent satellite components..... | 16 | +| 6.3 | Monitoring of satellite components..... | 16 | +| 6.3.1 | Monitoring of NGSO satellite component with split gNBs ..... | 16 | +| 6.3.2 | Monitoring of average delay on DL-Air Interface with MEO or GEO satellite components ..... | 17 | +| 6.3.3 | Multi-RAT load-balancing associated with both a Satellite RAN and a Terrestrial RAN..... | 17 | +| 7 | Potential Solutions ..... | 17 | +| 7.1 | Potential solutions for the management of satellite components ..... | 17 | +| 7.1.1 | Potential solutions to allow a network slice instance to be associated with both a Satellite RAN and a Terrestrial RAN ..... | 17 | +| 7.1.1.1 | Solution #1: Extend <code>SliceProfile</code> to specify separate service requirements for Satellite RAN and Terrestrial RAN ..... | 17 | +| 8 | Conclusions and Recommendations ..... | 17 | +| 8.1 | Conclusions ..... | 17 | +| 8.2 | Recommendations ..... | 17 | +| <b>Annex A: Characteristics of satellite systems .....</b> | | <b>18</b> | +| A.1 | General ..... | 18 | +| A.2 | Class of orbit ..... | 18 | +| A.3 | Geometrical coverage of satellite and propagation delay ..... | 19 | +| A.4 | Type of satellite communication payloads..... | 20 | +| A.5 | Air interfaces..... | 21 | +| A.6 | General considerations on the use of satellite networks ..... | 21 | +| <b>Annex B: Reference Models for Satellite Components Integration in the 5G System .....</b> | | <b>22</b> | +| B.1 | Elementary satellite network architecture..... | 22 | +| B.2 | Reference architecture with satellite enabled NR-RAN ..... | 22 | +| <b>Annex C (informative): Change history.....</b> | | <b>25</b> | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: 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. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: 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. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**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 + +**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 + +**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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +Satellite access has been included in the normative requirements for 5G (see [2]). Satellite components have specific characteristics that have been identified in [3], in particular: + +- The altitude of the spacecraft(s) (several hundred to several tens of thousands of kilometres), leading to a regional (multiple countries) or worldwide coverage by the satellite access network. +- The possibility to support end-to-end overlay access network, on a global scale basis, including with the possibility to embark gNBs, or parts of gNBs on board spacecraft. + +# --- 1 Scope + +The scope of this document is: + +- to identify the main key issues associated with business roles, service and network management and orchestration of a 5G network with integrated satellite component(s) (whether as NG-RAN or non-3GPP access, or for transport), and +- to study the associated solutions. + +This study aims at minimising the impacts and complexity of satellite integration in the existing business models and in management and orchestration aspects of the current 5G networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.261: "Service requirements for next generation new services and markets." +- [3] 3GPP TR 22.822: "Study on using satellite access" +- [4] 3GPP TR 38.811: "Study on New Radio (NR) to support non-terrestrial networks" +- [5] 3GPP TR 23.737: "Study on architecture aspects for using satellite access" +- [6] 3GPP TS 28.530: "Management and orchestration; Concepts, use cases and requirements" + +- [7] 3GPP TS 28.541: “5G Management and orchestration; 5G Network Resource Model (NRM), Stage 2 and Stage 3” +- [8] 3GPP TS 28.522: “5G performance measurements” +- [9] 3GPP TR 38.821: “Solutions for NR to support non-terrestrial networks (NTN)” + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +**Geostationary (GEO) satellites:** located precisely in the plane of the Equator at an altitude of 35,786 km, these satellites rotate at the same rate as the Earth's rotation: a GEO satellite stands still with respect to Earth. Thanks to this property, a single GEO satellite is sufficient to create a continuous coverage. + +**Non-Geostationary Orbiting (NGSO) satellites:** NGSO satellites do not stand still with respect to Earth. Should service continuity be required over time, a number of satellites (a constellation) is required to meet this requirement; the lower the altitude the higher the number of satellites. + +**Low-Earth Orbiting (LEO) satellites:** with altitude ranging from 500 km to 2,000 km, and with inclination angle of the orbital plane ranging from 0 to more than 90 degrees. These constellations are placed above the International Space Station and debris, and below the first Van Allen belt. + +**Medium-Earth Orbiting (MEO) satellites:** with altitude ranging from 8,000 to 20,000 km. The inclination angle of the orbital plane ranges from 0 to more than 90 degrees. These constellations are placed above the Van Allen belts. + +**Highly-Eccentric Orbiting (HEO) satellites:** with a range of operational altitudes (the orbit of such satellites being designed for the spacecraft to be exploited when the vehicle is closer to its apogee - the higher part of the orbit -) between 7,000 km and more than 45,000 km. The inclination angle is selected so as to compensate, completely or partially, the relative motion of Earth with respect to the orbital plane, allowing the satellite to cover successively different parts of Northern land masses (e.g. Western Europe, North America, and Northern Asia). + +## 3.2 Abbreviations + +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]. + +| | | +|--------|-----------------------------------------| +| AN | Access Network | +| 5GC | 5G Core Network | +| CN | Core Network | +| GEO | Geostationary satellites | +| gNB | generic Node B | +| gNB-CU | gNB-Central Unit | +| gNB-DU | gNB-Distributed Unit | +| HEO | Highly-Eccentric Orbiting satellites | +| LEO | Low-Earth Orbiting satellites | +| MEO | Medium-Earth Orbiting satellites | +| ms | milli-second, a thousandth of a second. | +| NOP | Network Operator | +| NS | Network Slice | +| NSI | Network Slice Instance | + +| | | +|------|-------------------------------| +| NSSI | Network Slice Subnet Instance | +| QoS | Quality of Service | +| RAN | Radio Access Network | +| RAT | Radio Access Technology | +| RU | Radio Unit | +| TBD | To Be Defined | + +# 4 Concepts and Background + +## 4.1 Reference management architecture for integrated satellite components + +### 4.1.1 Management architecture for integrated satellite NR-RAT + +The reference architecture depicted in figure 4.4.1-1 considers the case of a 3GPP RAN integrating a satellite NR-RAT, possibly together with a Terrestrial RAT. The NOP operates the 5G network interfacing through API's with Communication Service Customers or Verticals on the one hand and delivering services to UEs on the other hand. The 3GPP Management system manages the 3GPP RAN. + +![Figure 4.1.1-1: Reference architecture for the management of a satellite NR-RAT. The diagram shows a UE connected to a 3GPP RAN containing Satellite NR-RAT and Terrestrial RAT. The 3GPP RAN is connected to a Management Plane (3GPP Management) and a Control / User Plane (CN Control Plane and CN User Plane). The Management Plane and Control / User Plane are connected to a Vertical / CSC.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +The diagram illustrates the reference architecture for the management of a satellite NR-RAT. On the left, a 'UE' (User Equipment) is shown. It is connected to a '3GPP RAN' box, which contains two sub-components: 'Satellite NR-RAT' and 'Terrestrial RAT'. The '3GPP RAN' is connected to a 'Management Plane' (represented by a solid line) and a 'Control / User Plane' (represented by a dashed line). The 'Management Plane' connects to a '3GPP Management' box. The 'Control / User Plane' connects to a 'CN Control Plane' box and a 'CN User Plane' box. Both the '3GPP Management' box and the 'CN Control Plane' box are connected to a 'Vertical / CSC' (Communication Service Customer) box on the right. The 'CN User Plane' box is also connected to the 'Vertical / CSC' box. + +Figure 4.1.1-1: Reference architecture for the management of a satellite NR-RAT. The diagram shows a UE connected to a 3GPP RAN containing Satellite NR-RAT and Terrestrial RAT. The 3GPP RAN is connected to a Management Plane (3GPP Management) and a Control / User Plane (CN Control Plane and CN User Plane). The Management Plane and Control / User Plane are connected to a Vertical / CSC. + +Figure 4.1.1-1: Reference architecture for the management of a satellite NR-RAT. + +### 4.1.2 Management architecture for integrated non-3GPP satellite RAN + +The reference architecture depicted in the following figure considers the case of a non-3GPP satellite RAN integrated in a 5G network. The NOP operates the 5G network interfacing through API's with Communication Service Customers or Verticals on the one hand and delivering services to UEs on the other hand. The 3GPP management system manages the 3GPP RAN and the non-3GPP RAN. + +![Figure 4.1.2-1: Reference architecture for the management of a non-3GPP satellite RAN. The diagram shows a UE connected to two RANs: a Satellite Non-3GPP RAN and a Terrestrial 3GPP RAN. The Satellite Non-3GPP RAN is connected to a 3GPP Management block, which is part of a Vertical/CSC. The Terrestrial 3GPP RAN is connected to a CN Control Plane block, which is also part of the Vertical/CSC. Both the 3GPP Management and CN Control Plane blocks are connected to a CN User Plane block. The CN User Plane block is connected to the Vertical/CSC. The legend indicates that solid lines represent the Management Plane and dashed lines represent the Control / User Plane.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 4.1.2-1: Reference architecture for the management of a non-3GPP satellite RAN. The diagram shows a UE connected to two RANs: a Satellite Non-3GPP RAN and a Terrestrial 3GPP RAN. The Satellite Non-3GPP RAN is connected to a 3GPP Management block, which is part of a Vertical/CSC. The Terrestrial 3GPP RAN is connected to a CN Control Plane block, which is also part of the Vertical/CSC. Both the 3GPP Management and CN Control Plane blocks are connected to a CN User Plane block. The CN User Plane block is connected to the Vertical/CSC. The legend indicates that solid lines represent the Management Plane and dashed lines represent the Control / User Plane. + +Figure 4.1.2-1: Reference architecture for the management of a non-3GPP satellite RAN + +## 4.2 Architecture scenarios for 5G networks with an integrated satellite component + +### 4.2.1 Scenario #1: Satellite enabled 3GPP network as a roaming network for terrestrial network operators + +Consider two separate 3GPP networks, one 3GPP network with a satellite access network and one 3GPP network with a terrestrial access network. Both networks have their own PLMN ID and have a roaming agreement in place with each other. Roaming is used by the terrestrial operator to use the 3GPP network with a satellite access. Both the satellite and terrestrial network have their own separate 3GPP management domain. + +NOTE: This scenario follows the architecture identified in the Satellite access class scenario in section 4.1.3 from 3GPP TR 23.737 [5]. + +![Figure 4.2.1-1: Architecture of satellite 3GPP network (green) as roaming network to a terrestrial 3GPP network (blue). The diagram shows two separate 3GPP networks. The top network (green) consists of a Satellite NR Access network connected to a 5G Core network, which is connected to a Data Network. The bottom network (blue) consists of a Terrestrial NR Access network connected to a 5G Core network, which is connected to a Data Network. A 'roaming' label with a double-headed arrow indicates that the satellite network is a roaming network for the terrestrial network. A 'roaming interconnect' label is placed between the two 5G Core networks.](b28af4985cdef1e519e3aaf26561dcb3_img.jpg) + +Figure 4.2.1-1: Architecture of satellite 3GPP network (green) as roaming network to a terrestrial 3GPP network (blue). The diagram shows two separate 3GPP networks. The top network (green) consists of a Satellite NR Access network connected to a 5G Core network, which is connected to a Data Network. The bottom network (blue) consists of a Terrestrial NR Access network connected to a 5G Core network, which is connected to a Data Network. A 'roaming' label with a double-headed arrow indicates that the satellite network is a roaming network for the terrestrial network. A 'roaming interconnect' label is placed between the two 5G Core networks. + +Figure 4.2.1-1: Architecture of satellite 3GPP network (green) as roaming network to a terrestrial 3GPP network (blue) + +NOTE: The green and blue networks are separate management domains. + +### 4.2.2 Scenario #2: A 3GPP network with a satellite access network and a terrestrial access network + +In this scenario a 3GPP network is composed out of a 3GPP core network, a terrestrial 3GPP access network and a satellite 3GPP access network, where the satellite component is also integrated as a 3GPP access network. The satellite network and the terrestrial network both share the same PLMN and both access networks are managed by the same 3GPP management system. This architecture scenario follows the Satellite access class scenario in section 4.1.1 from 3GPP TR 23.737 [5]. + +![Diagram illustrating the architecture of a 3GPP network with a satellite 3GPP access network and a terrestrial 3GPP access network. Two access networks (Satellite 3GPP NR access network and Terrestrial 3GPP NR access network) are connected to a central 3GPP Core network, which is further connected to a Data Network. User Equipment (Sat/UE) is shown connected to both access networks.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +The diagram shows two access networks on the left, each connected to a central '3GPP Core network' box. The top access network is labeled 'Satellite 3GPP NR access network' and contains icons of a satellite and a user equipment (UE). The bottom access network is labeled 'Terrestrial 3GPP NR access network' and contains an icon of a terrestrial base station. Both access networks are connected to the '3GPP Core network' box. The '3GPP Core network' box is connected to a 'Data Network' represented by a cloud icon on the right. On the far left, two 'Sat/UE' (Satellite/User Equipment) icons are shown, one next to each access network, indicating connectivity. + +Diagram illustrating the architecture of a 3GPP network with a satellite 3GPP access network and a terrestrial 3GPP access network. Two access networks (Satellite 3GPP NR access network and Terrestrial 3GPP NR access network) are connected to a central 3GPP Core network, which is further connected to a Data Network. User Equipment (Sat/UE) is shown connected to both access networks. + +**Figure 4.2.2-1 Architecture of 3GPP network with a satellite 3GPP access network and a terrestrial 3GPP access network** + +NOTE: Both access networks are in the same management domains + +# 5 Use Cases + +## 5.1 Use cases related to network slice management + +### 5.1.1 Network slice instance(s) associated with a satellite RAN + +#### 5.1.1.1 Create a network slice instance associated with a satellite RAN + +##### 5.1.1.1.1 Pre-conditions + +A NOP wants an NSI which includes a 5GC and a Satellite RAN. The Satellite RAN is associated with either a Satellite NR-RAT, or can be non-3GPP Satellite RAT. + +##### 5.1.1.1.2 Description + +In some cases, the satellite coverage can be as large as the whole world, or can be regional (i.e. covering several countries). In some cases, the latency of the satellite RAN can be significant, from few tens of ms (for LEO) to several hundreds of ms (see Informative Annex A). Further, the description of the Satellite RAN can vary according to its characteristics. + +The NOP wants an NSI to support a communication service and the NSI to support to the description of the satellite RAN characteristics. + +##### 5.1.1.1.3 Post-conditions + +An NSI which includes CN part and RAN part is created, taking into account the specific characteristics of the satellite RAN. + +### 5.1.2 RAN sharing of a 5G network with satellite components + +#### 5.1.2.1 Pre-conditions + +A 5G System is composed of a satellite component, that may include: + +- A number of spacecraft, each composed of RUs, possibly gNB-DUs, gNB-CUs +- A number of Earth radio stations located on ground, interconnected with the spacecrafts, each composed of RUs and possibly connected to gNB-DUs and/or gNB-CUs. + +The satellite component is interconnected with a 5GC. + +It is specified in TS 22.261 that: “a 5G satellite access network shall support NG-RAN sharing”. + +A number of NOPs want to share the 5G satellite access network and certain NOPs want to have Network Slicing enabled in the satellite components. + +#### 5.1.2.2 Description + +The satellite on-board resources are managed by a satellite NOP, to allow the distribution of the limited RF power and bandwidth resources (for a RU), as well as for the power consumption and network resources for the digital processing units. A satellite NOP can therefore act also as VISIP (and/or a Data Center Service Provider (for the spaceborne part)). A NOP that is allowed access to the satellite components will be allowed to manage slice configurations in the shared satellite RAN. + +#### 5.1.2.3 Post-conditions + +The satellite components are configured to support multiple NOPs and NSIs are created for each NOP according to their requirements (bandwidth, connectivity, coverage, etc.) and according to the capabilities of each spacecraft and of the combined capabilities of the network. + +### 5.1.3 Handling of latencies associated with satellite components + +#### 5.1.3.1 Creating and managing sliced associated with satellite components + +##### 5.1.3.1.1 Pre-conditions + +A 5G System is composed of a satellite component, that may include: + +- a Geostationary-satellite network on the Radio Access part, +- a global LEO access network on the Radio access part, creating potentially a global overlay. + +Further, satellite backhaul can be used for transport between 5G-CN functions and RAN functions. + +These conditions generate latencies between UEs and the 5G-CN that can be higher or lower than those that could be met if a terrestrial network (radio or fiber) would be used for access or transport. + +##### 5.1.3.1.2 Description + +In TS 22.261, it is specified that a 5G system with satellite access shall support different configurations where the radio access network is either a satellite NG-RAN or a non-3GPP satellite access network, or both. + +It is further required that: + +- The 5G system with satellite access shall support the use of satellite links between the radio access network and core network, by enhancing the 3GPP system to handle the latencies introduced by satellite backhaul. +- A 5G system with satellite access shall be able to support meshed connectivity between satellites interconnected with inter-satellite links. + +For a 5G system with satellite access, the following requirement also applies: + +- A 5G system with satellite access shall be able to select the communication link providing the UE with the connectivity that most closely fulfils the agreed QoS. + +Operator wants an NSI to support a communication service and the associated Network Slice that offer the best service options. + +##### 5.1.3.1.3 Post-conditions + +An NSI which includes CN part and RAN part is created, taking into account the specific characteristics of the satellite RAN and backhaul characteristics. + +The performances of the satellite components are monitored to ensure that the performances of the NSI can be delivered as planned. + +### 5.1.4 Network slice instance(s) associated with both a Satellite RAN and a Terrestrial RAN + +#### 5.1.4.1 Pre-conditions + +A NOP wants to instantiate an NSI which includes a 5GC, a 3GPP Satellite RAN and a 3GPP Terrestrial RAN. The Satellite RAN is connected to the 5GC with the use of RAN sharing. + +#### 5.1.4.2 Description + +A satellite network could be used to extend the coverage of an existing terrestrial 3GPP network. When the Satellite RAN is connected to a 5GC by using RAN sharing and therefore is connected to the same 5GC, the NOP may want to deploy a single NSI spanning the Satellite RAN, Terrestrial RAN and 5GC. + +Moreover, a NOP may want to specify different network slice service requirements (data rate, latency, etc.) for the Satellite RAN and Terrestrial RAN in the same NSI, due to the specific Satellite RAN characteristics. + +![Diagram illustrating an NSI spanning both a Satellite RAN and a Terrestrial RAN. On the left, two SaT/UE icons are shown. The top SaT/UE is connected to a 'Satellite 3GPP NR access network' box, which contains a 'Requirement x: value a' label. The bottom SaT/UE is connected to a 'Terrestrial 3GPP NR access network' box, which contains a 'Requirement x: value b' label. Both access networks are connected to a central '3GPP Core network' box via a shared 'NSI' (Network Slice Instance) label. The 3GPP Core network is connected to a 'Data Network' cloud on the right.](cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg) + +Diagram illustrating an NSI spanning both a Satellite RAN and a Terrestrial RAN. On the left, two SaT/UE icons are shown. The top SaT/UE is connected to a 'Satellite 3GPP NR access network' box, which contains a 'Requirement x: value a' label. The bottom SaT/UE is connected to a 'Terrestrial 3GPP NR access network' box, which contains a 'Requirement x: value b' label. Both access networks are connected to a central '3GPP Core network' box via a shared 'NSI' (Network Slice Instance) label. The 3GPP Core network is connected to a 'Data Network' cloud on the right. + +**Figure 5.1.4-1: An NSI spanning both a Satellite RAN and a terrestrial RAN with two examples of network slice service requirements** + +NOTE: There may be more than one network slice service requirement for the Satellite RAN, terrestrial RAN and 5GC. + +#### 5.1.4.3 Post-conditions + +An NSI is created which spans both the Satellite RAN and the terrestrial RAN, with specific network slice service requirements for Satellite RAN and Terrestrial RAN domains. + +## 5.2 Use cases for the management of satellite components + +### 5.2.1 Use case for NGSO regenerative satellite components + +#### 5.2.1.1 Pre-conditions + +A NOP operates a 5G network. + +The NOP manages the 5G network in accordance with the 5G specifications. + +#### 5.2.1.2 Description + +The NOP integrates a satellite component based on NGSO regenerative satellites. NGSO regenerative satellites embark either gNBs or gNB-DUs. + +The 5G network management is implemented in such a way that moving gNBs or gNB-DUs can be managed. + +#### 5.2.1.3 Post-description + +The NOP operates a 5G network that manages the satellite component. + +### 5.2.2 Use case for NGSO transparent satellite components + +#### 5.2.2.1 Pre-conditions + +A NOP operates a 5G network. + +The NOP manages the 5G network in accordance with the 5G specifications and wants to integrate one or multiple NGSO transparent satellites into a 5GS. + +#### 5.2.2.2 Description + +The NOP integrates a satellite component based on NGSO transparent satellites. A SaT/UE will connect to a 5GC via a NGSO regenerative satellite component. A gNB may use a special remote radio unit to connect via one or multiple regenerative satellite(s) to the SaT/UE, as illustrated in Annex B.2. + +The 5G network management is implemented in such a way that moving regenerative satellite components could be managed. + +#### 5.2.2.3 Post-description + +The NOP operates a 5G network that manages a 5GS with transparent satellite component(s). + +## 5.3 Use cases for monitoring of satellite components + +### 5.3.1 Use case for monitoring of performances of NGSO satellite components with split gNBs + +#### 5.3.1.1 Goal + +When considering an NGSO satellite component with split gNB, the goal is to allow the monitoring of average packet delays on the RAN, as delays would be varying between gNB-DUs and gNB-CUs. + +#### 5.3.1.2 Pre-conditions + +A NOP operates a 5G network. + +The NOP monitors the 5G network performances in accordance with the 5G specifications. + +The NOP integrates a satellite component. NGSO satellites embark gNB-DUs on board, gNB-CUs are located on ground (see Annex B of this document). + +As the NGSO satellites move along their orbit, the distance between the gNB-DUs embarked on the satellites and the served CUs varies significantly. + +#### 5.3.1.3 Description + +The monitoring the packet delay is implemented in a such a way so that the varying distance between the gNB-DUs and the gNB-CUs are taken into account. + +KPIs such as Average delay DL, CU-UP, Average delay on F1-U, Average delay DL in gNB-DU, are monitored. + +#### 5.3.1.4 Post-description + +The 5G network can monitor the performances of NGSO satellite components with split gNBs. + +### 5.3.2 Use case for monitoring of average delay on DL-Air Interface for MEO and GEO satellite components + +#### 5.3.2.1 Goal + +The goal is to allow the monitoring of the delay on the DL-Air Interface when a MEO or GEO satellite component for which the HARQ process has been modified with respect to a terrestrial RAN. + +#### 5.3.2.2 Pre-conditions + +A NOP operates a 5G network. + +The 5G network as operated by the NOP satellite RAN supporting NR + +#### 5.3.2.3 Description + +To cope with the effects of satellite delay and associated RTT, the HARQ operation is disabled or modified when compared to terrestrial RAN. + +The management system of the 5G network is designed to provide a measured of the average delay on DL-Air Interface for MEO and GEO satellite components without an HARQ process. + +#### 5.3.2.4 Post-description + +The management system monitors the average delay on the DL-Air Interface for MEO and GEO satellite components. + +### 5.3.3 Multi-RAT load-balancing associated with both a Satellite RAN and a Terrestrial RAN + +#### 5.3.3.1 Pre-conditions + +A NOP wants to optimize resource usage of multi-RATs by supporting load-balancing between satellite RANs and terrestrial RANs. The Satellite RAN and Terrestrial RAN are connected to the 5GC with the use of RAN sharing. + +A NOP provides the following capabilities: radio resource management and traffic flow control in RAN, multi-RAT resource control in 5GC, and multi-RAT resource management in 3GPP Management. + +#### 5.3.3.2 Description + +For efficient multi-RATs load balancing, the following capabilities and procedures are applied across different parts of 5GS. Figure 5.3.3-1 shows capabilities required for the load balancing. + +![Diagram illustrating the capabilities for Multi-RATs load-balancing for Satellite and terrestrial RANs. The diagram shows a hierarchy starting with 3GPP Management at the top, which includes Multi-RAT Resource Management. Below it, the Satellite 3GPP NR access network and Terrestrial 3GPP NR access network are shown, each containing Radio Resource Management and Traffic Flow Control. These networks are connected to the 3GPP Core network, which contains Multi-RAT Resource Control. The 3GPP Core network is connected to the Data network. On the left, two SaT/UE icons represent user equipment connected to the networks.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +graph TD + subgraph 3GPP_Management [3GPP Management] + MRM[Multi-RAT Resource Management] + end + subgraph Satellite_RAN [Satellite 3GPP NR access network] + RRM1[Radio Resource Management] + TFC1[Traffic Flow Control] + end + subgraph Terrestrial_RAN [Terrestrial 3GPP NR access network] + RRM2[Radio Resource Management] + TFC2[Traffic Flow Control] + end + subgraph Core_Network [3GPP Core network] + MRC[Multi-RAT Resource Control] + end + subgraph Data_Network [Data network] + end + SaT1[SaT/UE] --- Satellite_RAN + SaT2[SaT/UE] --- Terrestrial_RAN + Satellite_RAN --- Core_Network + Terrestrial_RAN --- Core_Network + Core_Network --- Data_Network + 3GPP_Management --- Satellite_RAN + 3GPP_Management --- Terrestrial_RAN + 3GPP_Management --- Core_Network + +``` + +Diagram illustrating the capabilities for Multi-RATs load-balancing for Satellite and terrestrial RANs. The diagram shows a hierarchy starting with 3GPP Management at the top, which includes Multi-RAT Resource Management. Below it, the Satellite 3GPP NR access network and Terrestrial 3GPP NR access network are shown, each containing Radio Resource Management and Traffic Flow Control. These networks are connected to the 3GPP Core network, which contains Multi-RAT Resource Control. The 3GPP Core network is connected to the Data network. On the left, two SaT/UE icons represent user equipment connected to the networks. + +**Figure 5.3.3-1: Capabilities for Multi-RATs load-balancing for Satellite and terrestrial RANs** + +Both satellite and terrestrial 3GPP NR RANs have capabilities of its own radio resource management (e.g., dynamic selection of the appropriate radio bearers) and traffic flow control which dynamically decides, for each in progress connection, the traffic bit rates that have to be managed by each cell of the gNB. The 5GC has multi-RATs resource control capability which performs optimal load-balancing control of multi-RATs. 3GPP Management includes multi-RAT resource management capability which coordinates with multi-RAT resource control capability in 5GC for optimal multi-RAT load-balancing. + +Multi-RAT load-balancing procedure may follow the following steps: + +1. UE connection procedure to the selected RAT is performed based on the connection profile information such as UE type, service type, and user's connection preferences, etc. +2. When a connection is setup, uplink and downlink traffic is sent from/to the UE +3. UE sends measurement report about radio link periodically during the connection to the multi-RAT resource control module +4. The multi-RAT resource control module decides load-balancing policy based on the reports, the traffic is switched from the currently active RAT to another RAT by the traffic flow control when load-balancing is required +5. At the end of the connection, each UE sends feedback about the quality of connection and the connection profile information is updated accordingly. The same information is also sent to multi-RAT resource management module in 3GPP management system + +#### 5.1.3.3 Post-conditions + +Optimal Multi-RAT load-balancing is completed across both the Satellite RAN and the terrestrial RAN, with specific multi-RAT resource usage requirements for Satellite RAN and Terrestrial RAN domains. As a result, the following improvement can be achieved: + +- Improvement of the overall data rates (throughput) to mobile UEs in 5G networks for both DL and UL. +- Improvement of the optimal exploitation of 5G network resources while meeting the 5G KPIs. +- Guarantee of service continuity (reliability) in mobile UEs + +# 6. Potential Requirements + +## 6.1 Network slice management + +### 6.1.1 Network slice instance(s) associated with a satellite RAN + +[REQ-FS\_5GSAT\_MO-1.1.01] An NSI created for the management of services of a 5G system with satellite access, shall include parameters to describe the specific characteristics of the satellite access. + +### 6.1.2 Network slice instance(s) associated with satellite RAN sharing + +[REQ-FS\_5GSAT\_MO-1.2.01] In a 5G network with satellite access, the satellite components shall have the capability to provide NSIs and NSSIs for each of the NOP sharing the satellite access network. + +[REQ-FS\_5GSAT\_MO-1.2.02] In a 5G network with satellite access, each of the NOPs sharing the satellite access shall have the capability to create, manage, monitor, activate, deactivate and terminate NSIs and NSSIs. + +### 6.1.3 Network slice instance(s) associated with satellite component latencies + +[REQ-FS\_5GSAT\_MO-1.3.01] A Network Slice created for the management of services of a 5G system with satellite access, shall include parameters to handle the latency associated with a satellite access. + +[REQ-FS\_5GSAT\_MO-1.3.02] A Network Slice created for the management of services of a 5G system with satellite transport network, shall include parameters to handle the latency associated with the corresponding satellite network. + +### 6.1.4 Network slice instance(s) associated with both a Satellite RAN and a Terrestrial RAN + +[REQ-FS\_5GSAT\_MO-1.4.01] A single NSI created with both satellite access and terrestrial access, shall have the possibility to set separate network slice service requirements for the Satellite RAN and Terrestrial RAN domains. + +## 6.2 Management of satellite components + +### 6.2.1 Management of NGSO regenerative satellite components + +[REQ-FS\_5GSAT\_MO-2.1.01] In a 5G network integrating an NGSO regenerative satellite RAT, the 5G network shall have the capability of managing moving gNBs or gNB-DUs. + +### 6.2.2 Management of NGSO transparent satellite components + +[REQ-FS\_5GSAT\_MO-2.2.01] In a 5G network integrating an NGSO transparent satellite RAT, the 5G network shall have the capability to manage one or multiple moving regenerative satellite component(s). + +## 6.3 Monitoring of satellite components + +### 6.3.1 Monitoring of NGSO satellite component with split gNBs + +[REQ-FS\_5GSAT\_MO-3.1.01] In a 5G network integrating a NGSO component with split gNBs, it shall possible to monitor the packet delay KPIs. + +### 6.3.2 Monitoring of average delay on DL-Air Interface with MEO or GEO satellite components + +[REQ-FS\_5GSAT\_MO-3.2.01] In a 5G network integrating a MEO or GEO satellite components, it shall be possible to monitor the average delay on the DL-Air Interface. + +### 6.3.3 Multi-RAT load-balancing associated with both a Satellite RAN and a Terrestrial RAN + +[REQ-FS\_5GSAT\_MO-3.3.01] Multi-RAT load-balancing shall be provided to assure optimal resource usage of the Satellite RAN and Terrestrial RAN domains. + +[REQ-FS\_5GSAT\_MO-3.3.02] Multi-RAT load-balancing shall be provided to guarantee service continuity (reliability) in mobile UEs. + +# --- 7 Potential Solutions + +## 7.1 Potential solutions for the management of satellite components + +### 7.1.1 Potential solutions to allow a network slice instance to be associated with both a Satellite RAN and a Terrestrial RAN + +#### 7.1.1.1 Solution #1: Extend `SliceProfile` to specify separate service requirements for Satellite RAN and Terrestrial RAN + +The NOP can set specific service requirements for both the Terrestrial RAN and the Satellite RAN in the `SliceProfile` [7] to instantiate an NSSI which comprises a Terrestrial AN NSSI and Satellite AN NSSI. + +To set separate performance requirements for the Terrestrial RAN and Satellite RAN the `perfReq` [7] attribute can be extended to allow distinct performance requirement entries for both RANs such as the experienced data rate, latency and coverage area. + +# --- 8 Conclusions and Recommendations + +## 8.1 Conclusions + +TBD + +## 8.2 Recommendations + +TBD + +# Annex A: Characteristics of satellite systems + +## A.1 General + +This annex describes the main characteristics of satellite systems when considering their integration with the 5G system. + +## A.2 Class of orbit + +On the one hand, our planet attracts as a main body the much smaller satellite, which motion is dictated as a consequence by the laws of Kepler. On the other hand, the environment of Earth can be also constraining: the higher density of the atmosphere, debris from launchers and former satellites in the lower altitudes, as well as higher energy particles trapped in the Van Allen belts between 2,000 and 8,000 km's altitudes are to be avoided. These two constraints contribute to defining several classes of orbits that are used for communication satellites: + +- **Geostationary (GEO)** satellites, located precisely in the plane of the Equator at an altitude of 35,786 km, these satellites rotate at the same rate as the Earth's rotation: a GEO satellite stands still with respect to Earth. Thanks to this property, a single GEO satellite is sufficient to create a continuous coverage. +- **Non-Geostationary Orbiting (NGSO)** satellites: NGSO satellites do not stand still with respect to Earth. Should service continuity be required over time, a number of satellites (a constellation) is required to meet this requirement; the lower the altitude the higher the number of satellites. + +Different classes of NGSO satellites are listed below: + +- **Low-Earth Orbiting (LEO)** satellites, with altitude ranging from 500 km to 2,000 km, and with inclination angle of the orbital plane ranging from 0 to more than 90 degrees. These constellations are placed above the International Space Station and debris, and below the first Van Allen belt. +- **Medium-Earth Orbiting (MEO)** satellites, with altitude ranging from 8,000 to 20,000 km. The inclination angle of the orbital plane ranges from 0 to more than 90 degrees. These constellations are placed above the Van Allen belts. +- **Highly-Eccentric Orbiting (HEO)** satellites, with a range of operational altitudes (the orbit of such satellites being designed for the spacecraft to be exploited when the vehicle is closer to its apogee - the higher part of the orbit -) between 7,000 km and more than 45,000 km. The inclination angle is selected so as to compensate, completely or partially, the relative motion of Earth with respect to the orbital plane, allowing the satellite to cover successively different parts of Northern land masses (e.g. Western Europe, North America, and Northern Asia). + +![Diagram illustrating the classes of orbits of satellites around planet Earth. The diagram shows a central circle representing 'planet Earth'. Concentric circles represent different orbital paths: LEO (Low-Earth Orbiting) is the innermost circle, MEO (Medium-Earth Orbiting) is the next circle out, and GEO (Geostationary) is the outermost circle. An elliptical orbit labeled HEO (Highly-Eccentric Orbiting) is shown, which is highly inclined and extends far beyond the GEO circle on one side (apogee) and stays close to Earth on the other (perigee).](cd1fc67b0180f1bff43410ac3b644c46_img.jpg) + +Diagram illustrating the classes of orbits of satellites around planet Earth. The diagram shows a central circle representing 'planet Earth'. Concentric circles represent different orbital paths: LEO (Low-Earth Orbiting) is the innermost circle, MEO (Medium-Earth Orbiting) is the next circle out, and GEO (Geostationary) is the outermost circle. An elliptical orbit labeled HEO (Highly-Eccentric Orbiting) is shown, which is highly inclined and extends far beyond the GEO circle on one side (apogee) and stays close to Earth on the other (perigee). + +Figure A.2-1: Illustration of the classes of orbits of satellites + +## A.3 Geometrical coverage of satellite and propagation delay + +As depicted in the following figure, the theoretical geometrical coverage of a satellite is associated to its altitude and the minimum elevation angle under which the satellite is seen by the UE above the horizon. + +![Diagram illustrating the geometrical coverage of a satellite. It shows a satellite at a certain altitude above Earth, with lines indicating its coverage area. Labels include 'Satellite altitude', 'Satellite Geometrical coverage', 'Elevation Angle', 'UE' (User Equipment), and 'Earth'.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +The diagram shows a satellite in orbit above Earth. A vertical line from the satellite to the Earth's surface represents the 'Satellite altitude'. A shaded circular area on the Earth's surface represents the 'Satellite Geometrical coverage'. A line of sight from a 'UE' (User Equipment) on the surface to the satellite makes an 'Elevation Angle' with the local horizon. The Earth is represented by a circle. + +Diagram illustrating the geometrical coverage of a satellite. It shows a satellite at a certain altitude above Earth, with lines indicating its coverage area. Labels include 'Satellite altitude', 'Satellite Geometrical coverage', 'Elevation Angle', 'UE' (User Equipment), and 'Earth'. + +**Figure A.3-1: Illustration of the geometrical coverage of a satellite** + +The following figure illustrates the geometrical coverage for a LEO satellite and for geostationary-satellites: + +![World map showing the geographical coverage of a LEO satellite and a GEO satellite. The LEO coverage is a small circle over North America, and the GEO coverage is a much larger circle covering a significant portion of the Earth. Labels include 'Geometrical coverage for a LEO satellite' and 'Geometrical coverage for a GEO satellite'.](3e0c2bf6c51c575d096c7fc95c1e8454_img.jpg) + +This world map displays the Earth with latitude and longitude lines. A small blue circle over North America represents the 'Geometrical coverage for a LEO satellite'. A much larger circle, centered on the equator, represents the 'Geometrical coverage for a GEO satellite', showing its much wider coverage area. + +World map showing the geographical coverage of a LEO satellite and a GEO satellite. The LEO coverage is a small circle over North America, and the GEO coverage is a much larger circle covering a significant portion of the Earth. Labels include 'Geometrical coverage for a LEO satellite' and 'Geometrical coverage for a GEO satellite'. + +**Figure A.3-2: Illustration of the geometrical coverage of a LEO satellite and of GEO satellites** + +The following tables provide elevation, distance and geometrical coverage related figures for different classes of satellites: + +| Class of orbit | Elevation angle (degrees) | | | +|----------------|-------------------------------------------------------|--------|--------| +| Altitude (km) | 0 | 10 | 90 | +| <b>LEO</b> | <b>Distance - Satellite to UE (km)</b> | | | +| 800 | 3 293 | 2 367 | 800 | +| 1400 | 4 452 | 3 480 | 1 400 | +| <b>MEO</b> | <b>Distance - Satellite to UE (km)</b> | | | +| 8000 | 12 886 | 11 826 | 8 000 | +| <b>GEO</b> | <b>Distance - Satellite to UE (km)</b> | | | +| 35786 | 41 679 | 40 586 | 35 786 | +| | | | | +| | | | | +| Class of orbit | Elevation angle (degrees) | | | +| Altitude (km) | 0 | 10 | 90 | +| <b>LEO</b> | <b>Propagation Delay - Satellite to UE (millisec)</b> | | | +| 800 | 11,0 | 7,9 | 2,7 | +| 1400 | 14,8 | 11,6 | 4,7 | +| <b>MEO</b> | <b>Propagation Delay - Satellite to UE (millisec)</b> | | | +| 8000 | 43,0 | 39,4 | 26,7 | +| <b>GEO</b> | <b>Propagation Delay - Satellite to UE (millisec)</b> | | | +| 35786 | 138,9 | 135,3 | 119,3 | +| | | | | +| | | | | +| Class of orbit | Elevation angle (degrees) | | | +| Altitude (km) | 0 | 10 | 90 | +| <b>LEO</b> | <b>Geometrical Coverage Radius - (km)</b> | | | +| 800 | 3 040 | 2 109 | - | +| 1400 | 3 887 | 2 910 | - | +| <b>MEO</b> | <b>Geometrical Coverage Radius - (km)</b> | | | +| 8000 | 7 087 | 6 022 | - | +| <b>GEO</b> | <b>Geometrical Coverage Radius - (km)</b> | | | +| 35786 | 9 050 | 7 952 | - | + +**Figure A.3-3: Geometrical coverage radius, propagation distance and delay for different orbits** + +NOTE: The above figure provides only examples, some designers may decide to select lower altitudes as this contribute lowering the propagation delay. + +The following table illustrates the number of satellites that are necessary for a constellation of satellites to provide continuous coverage for an elevation angle ranging from 5 to 10 degrees. Global coverage may not be fully achieved for MEO or GEO satellite, however in this case the vast majority of the world population is covered. + +| Class of orbit | # of satellites to cover Earth | +|----------------|--------------------------------| +| <b>LEO</b> | | +| 800 | circa 80 | +| 1400 | circa 50 | +| <b>MEO</b> | | +| 8000 | circa 10 | +| <b>GEO</b> | | +| 35786 | circa 3 | + +**Figure A.3-4: Illustration of number satellites in a constellation for continuous Earth coverage** + +## A.4 Type of satellite communication payloads + +Communication payloads embarked on-board a satellite are of two main categories, for any type of satellite (whether GEO or NGSO): + +- **Transparent payloads:** the electromagnetic waves that are transmitted from the Earth's surface are converted by a satellite receive antenna into an electric signal which is channel filtered and amplified by a low-noise amplifier (LNA). The signal is then frequency converted. A high-power amplifier (HPA) delivers finally the + +signal to a transmitting antenna generating a reconditioned electromagnetic wave towards the Earth surface where receive station are located. + +- **Regenerative payloads:** an On-Board Processor (OBP), is inserted between the LNA and the HPA. This OBP allows to convert the air interface between the uplink (from Earth to satellite) and the down link (from satellite to Earth). It allows to correct bits or packet in errors before retransmitting them, or to route packets between beams. Ultimately any network function can be implemented, at the expense of power and mass, thanks to an OBP (including gNB CU's or DU's, or any function attached to a CN). +- **Inter-Satellite Links (ISL):** can also interconnect regenerative satellite payloads. Through ISL's satellites can be interconnected through a dedicated mesh-network. + +## --- A.5 Air interfaces + +Air interfaces can include: + +- 3GPP defined air interfaces, such as the New Radio; +- Non-3GPP defined air interfaces + +Unless otherwise indicated, 3GPP NR will be assumed in this document. + +## --- A.6 General considerations on the use of satellite networks + +In relation to the coverage associated with Non-Geostationary Satellite Networks, or Geostationary-Satellite ones, the use of satellite networks is related to: + +- The complement of terrestrial networks where these terrestrial networks are not available, permanently for physically (maritime or aeronautical constraints) or economic reasons, or for temporary reasons associated to local unavailability of a terrestrial of network (drought, Earth quake) or local overload of the demand; +- Satellite networks can be used for broadcast over large areas of a same content, for multicast (with acknowledge of delivery of content), for unicast; +- Use cases are related to the actual of altitude of the satellite platforms and the associated delay of propagation. + +# Annex B: Reference Models for Satellite Components Integration in the 5G System + +## B.1 Elementary satellite network architecture + +The physical implementation of a satellite network architecture can always be sketched as displayed in the following figure: + +![Figure B.1-1: Reference Satellite Access Network Architecture. This diagram shows a 'Satellite enabled UE' (represented by a smartphone and a satellite dish) connected to a 'Satellite' via a 'Service link' (dashed double-headed arrow). The 'Satellite' is connected to a 'Hub' (represented by a satellite dish and a base station) via a 'Feeder link' (dashed double-headed arrow). The 'Hub' is connected to a 'Data Network' (represented by a cloud) via a solid double-headed arrow.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +Figure B.1-1: Reference Satellite Access Network Architecture. This diagram shows a 'Satellite enabled UE' (represented by a smartphone and a satellite dish) connected to a 'Satellite' via a 'Service link' (dashed double-headed arrow). The 'Satellite' is connected to a 'Hub' (represented by a satellite dish and a base station) via a 'Feeder link' (dashed double-headed arrow). The 'Hub' is connected to a 'Data Network' (represented by a cloud) via a solid double-headed arrow. + +**Figure B.1-1: Reference Satellite Access Network Architecture** + +A satellite network is always composed of: + +- One, or more, satellite(s), embarking a telecommunication payload. +- Satellite enabled UEs, such as IoT devices, broadband vehicular or fixed terminals. +- A Hub, including an RF Earth station, and a data centre including (co-located or not) RAN and CN related functions. The hub is also interconnected to (a) data network(s). +- UEs interconnected to the hub through the satellite. + +## B.2 Reference architecture with satellite enabled NR-RAN + +The following figure depicts a reference architecture for a direct access with a satellite enabled NR-RAN (see below): + +![Figure B.2-1: 5GS with Satellite enabled NR-RAN. This diagram shows a 'UE with Satellite access' (green box) connected to a 'Satellite enabled NR-RAN' (pink box) via N1 and NR interfaces. The 'Satellite enabled NR-RAN' is connected to a '5G CN' (green box) via N1, N2, and N3 interfaces. The '5G CN' is connected to a 'DN' (Data Network, cloud) via the N6 interface.](421fc75480c21e7ebb25756826652367_img.jpg) + +Figure B.2-1: 5GS with Satellite enabled NR-RAN. This diagram shows a 'UE with Satellite access' (green box) connected to a 'Satellite enabled NR-RAN' (pink box) via N1 and NR interfaces. The 'Satellite enabled NR-RAN' is connected to a '5G CN' (green box) via N1, N2, and N3 interfaces. The '5G CN' is connected to a 'DN' (Data Network, cloud) via the N6 interface. + +**Figure B.2-1: 5GS with Satellite enabled NR-RAN** + +Knowing the possible nature of satellite payloads (transparent or re-generative), the instantiation of this architecture can have several forms: + +In a first implementation, the satellite is transparent, the NR signals are generated from gNB's from a satellite enabled NR-RAN that are located on ground. The satellite is equivalent to a Radio Frequency (RF) Remote Unit, and is full transparent to the New Radio protocols, including the physical layer (see below). + +![Figure B.2-2: 5GS with transparent satellite enabled NR-RAN. The diagram shows a UE connected to a satellite via an NR-Uu interface. The satellite is part of a Radio Frequency Remote Unit (RFRU) and a Remote Radio Unit (RRU). The RRU is connected to a gNB, which is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +The diagram illustrates a 5GS with transparent satellite enabled NR-RAN. A User Equipment (UE) is connected to a satellite via an NR-Uu interface. The satellite is part of a Radio Frequency Remote Unit (RFRU) and a Remote Radio Unit (RRU). The RRU is connected to a gNB, which is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface. + +Figure B.2-2: 5GS with transparent satellite enabled NR-RAN. The diagram shows a UE connected to a satellite via an NR-Uu interface. The satellite is part of a Radio Frequency Remote Unit (RFRU) and a Remote Radio Unit (RRU). The RRU is connected to a gNB, which is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface. + +**Figure B.2-2: 5GS with transparent satellite enabled NR-RAN** + +In a second implementation, the satellite is regenerative. The satellite payload implements a gNB-DU as part of a satellite enabled NR-RAN. Some of the protocols of the NR are processed by the satellite. A Satellite Radio Interface (SRI) transports the F1 protocol between the on-ground CU and the on-board DU (it can be the NR (see below)). + +![Figure B.2-3: 5GS with regenerative satellite enabled NR-RAN and distributed gNB. The diagram shows a UE connected to a satellite via an NR-Uu interface. The satellite is part of a gNB-DU. The gNB-DU is connected to a Remote Radio Unit (RRU) via an F1 over SRI interface. The RRU is connected to a gNB-CU, which is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface.](ab846b81e78dbc8da2a6f9511e2f248a_img.jpg) + +The diagram illustrates a 5GS with regenerative satellite enabled NR-RAN and distributed gNB. A User Equipment (UE) is connected to a satellite via an NR-Uu interface. The satellite is part of a gNB-DU. The gNB-DU is connected to a Remote Radio Unit (RRU) via an F1 over SRI interface. The RRU is connected to a gNB-CU, which is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface. + +Figure B.2-3: 5GS with regenerative satellite enabled NR-RAN and distributed gNB. The diagram shows a UE connected to a satellite via an NR-Uu interface. The satellite is part of a gNB-DU. The gNB-DU is connected to a Remote Radio Unit (RRU) via an F1 over SRI interface. The RRU is connected to a gNB-CU, which is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface. + +**Figure B.2-3: 5GS with regenerative satellite enabled NR-RAN and distributed gNB** + +In a third implementation, the satellite is regenerative. The satellite payload implements a full gNB supporting a satellite enabled NR-RAN. A Satellite Radio Interface (SRI) transports the N1/N2/N3 interfaces between the on-ground 5G CN and the on-board gNB-CU (see below). + +![Figure B.2-4: 5GS with regenerative satellite enabled NR-RAN and on-board gNB. The diagram shows a UE connected to a satellite via an NR-Uu interface. The satellite is part of a gNB. The gNB is connected to a Remote Radio Unit (RRU) via an NG over SRI interface. The RRU is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface.](19a59d6b53059ebd27b13c98793f88e0_img.jpg) + +The diagram illustrates a 5GS with regenerative satellite enabled NR-RAN and on-board gNB. A User Equipment (UE) is connected to a satellite via an NR-Uu interface. The satellite is part of a gNB. The gNB is connected to a Remote Radio Unit (RRU) via an NG over SRI interface. The RRU is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface. + +Figure B.2-4: 5GS with regenerative satellite enabled NR-RAN and on-board gNB. The diagram shows a UE connected to a satellite via an NR-Uu interface. The satellite is part of a gNB. The gNB is connected to a Remote Radio Unit (RRU) via an NG over SRI interface. The RRU is connected to a 5G CN via an N1/2/3 interface. The 5G CN is connected to a Data Network via an N6 interface. + +**Figure B.2-4: 5GS with regenerative satellite enabled NR-RAN and on-board gNB** + +One can note that with a regenerative implementation (either with distributed gNB or not) a 5GS can have a global coverage, providing a single 5G CN with global or regional (continental or sub-continental) coverage as well. This is valid for GEO or LEO (see below): + +![Figure B.2-5: 5GS with regenerative satellite enabled NR-RAN, with ISL for regional or global coverage. The diagram shows three User Equipment (UE) units connected to three gNB-DU (Distributed Unit) units via NR-Uu interfaces. The gNB-DUs are connected to each other via F1 over SRI (Satellite Radio Interface) links. The top gNB-DU is connected to a Remote Radio Unit (RRU), which is connected to a gNB-CU (Central Unit). The gNB-CU is connected to a 5G CN (Core Network) via N1/2/3 interfaces. The 5G CN is connected to a Data Network via N6 interfaces.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +Figure B.2-5: 5GS with regenerative satellite enabled NR-RAN, with ISL for regional or global coverage. The diagram shows three User Equipment (UE) units connected to three gNB-DU (Distributed Unit) units via NR-Uu interfaces. The gNB-DUs are connected to each other via F1 over SRI (Satellite Radio Interface) links. The top gNB-DU is connected to a Remote Radio Unit (RRU), which is connected to a gNB-CU (Central Unit). The gNB-CU is connected to a 5G CN (Core Network) via N1/2/3 interfaces. The 5G CN is connected to a Data Network via N6 interfaces. + +Figure B.2-5: 5GS with regenerative satellite enabled NR-RAN, with ISL for regional or global coverage + +Another configuration (see below) may consist in satellites each embarking a gNB supporting a satellite enabled NR-RAN, and 5G CN's accessing these gNB's, as described in the following figure, where specific (or not) satellite radio interfaces are used to handle control and user planes: + +![Figure B.2-6: 5GS with regenerative satellite enabled NR-RAN, with ISL & multiple 5G CN connectivity. The diagram shows three User Equipment (UE) units connected to three gNB units via NR-Uu interfaces. The gNB units are connected to each other via Xn-C, Xn-U Over SRI links. Each gNB unit is connected to a Remote Radio Unit (RRU), which is connected to a 5G CN via NG over SRI and NG (N1/N2/N3) interfaces. Each 5G CN is connected to a Data Network via N6 interfaces.](171115f072e42b379238ed0dd438e9d7_img.jpg) + +Figure B.2-6: 5GS with regenerative satellite enabled NR-RAN, with ISL & multiple 5G CN connectivity. The diagram shows three User Equipment (UE) units connected to three gNB units via NR-Uu interfaces. The gNB units are connected to each other via Xn-C, Xn-U Over SRI links. Each gNB unit is connected to a Remote Radio Unit (RRU), which is connected to a 5G CN via NG over SRI and NG (N1/N2/N3) interfaces. Each 5G CN is connected to a Data Network via N6 interfaces. + +Figure B.2-6: 5GS with regenerative satellite enabled NR-RAN, with ISL & multiple 5G CN connectivity + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|------------|----|-----|-----|----------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-04 | SA5#125 | S5-193525 | | | | Implemented S5-193123, S5-193522, S5-193523, S5-193526, S5-193527, S5-193237, S5-193524, S5-193127 | 0.1.0 | +| 2019-08 | SA5#126 | | | | | Implemented S5-195867, S5-195867, S5-195872, S5-195873, S5-195874, S5-195874, S5-195876 | 0.2.0 | +| 2019-10 | SA5#127 | S5-196874 | | | | Implemented S5-196664, S5-196665 | 0.3.0 | +| 2019-11 | SA5#127 | S5- 197850 | | | | Implemented S5-197242, S5-197326, S5-197579 | 0.4.0 | +| 2020-06 | SA5#131E | S5-203321 | | | | Implemented S5-203018, S5-203019, S5-203020 | 0.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28809/1439cb942d9e363bbb3161b5540dd8c6_img.jpg b/marked/Rel-16/28_series/28809/1439cb942d9e363bbb3161b5540dd8c6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a54a1ee43c04d1ddd1697ed7f2522cb4a160ace1 --- /dev/null +++ b/marked/Rel-16/28_series/28809/1439cb942d9e363bbb3161b5540dd8c6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bbe62cfbd2b4fe9d9ec676659e47a0fdc2338787d85b42a17c34047370ba3f04 +size 62261 diff --git a/marked/Rel-16/28_series/28809/4636adff5682a064f0ae5f13a1d464a6_img.jpg b/marked/Rel-16/28_series/28809/4636adff5682a064f0ae5f13a1d464a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0401d4342a3aa1188b9c1760a8ee5dfa6b28f3ae --- /dev/null +++ b/marked/Rel-16/28_series/28809/4636adff5682a064f0ae5f13a1d464a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b47f37406cc0f0d3993d5e69c23253079558b9f6edd1b479e5a4ba76effb5db3 +size 60887 diff --git a/marked/Rel-16/28_series/28809/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/28_series/28809/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..617632a31e4579b10bdde92110f4cbb58b2bc1e3 --- /dev/null +++ b/marked/Rel-16/28_series/28809/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c3490ee00849821030efc0bf99748972255b5c202680ac01991cde85d74fbef +size 34645 diff --git a/marked/Rel-16/28_series/28809/5e9af8986a5845504f251d3079da8078_img.jpg b/marked/Rel-16/28_series/28809/5e9af8986a5845504f251d3079da8078_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a8287c080f00dd37f826fff07299da0fbf7f4593 --- /dev/null +++ b/marked/Rel-16/28_series/28809/5e9af8986a5845504f251d3079da8078_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:75fadc37ddd12a9d2760208923635384014065621a331059558b2d4e400211e3 +size 31719 diff --git a/marked/Rel-16/28_series/28809/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/28_series/28809/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a4fb99c0f3950b987154d3f7c42f7dff3259b36 --- /dev/null +++ b/marked/Rel-16/28_series/28809/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:60b308ce3212e114f56c9eefd20da8b81f735a245fedb074d12075c3a2752e2d +size 9472 diff --git a/marked/Rel-16/28_series/28809/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/28_series/28809/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42a4df7573bdc14a20b58c7bf911541978144cd2 --- /dev/null +++ b/marked/Rel-16/28_series/28809/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e361ecbdc859419fb670619286e7f2739363ba5291ddf608b76912c8eb1031b9 +size 5810 diff --git a/marked/Rel-16/28_series/28809/b701cd8c436a2857a615a76a868a3bb7_img.jpg b/marked/Rel-16/28_series/28809/b701cd8c436a2857a615a76a868a3bb7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..751b625de478c36c9e22f47fb2f7af81973f0f11 --- /dev/null +++ b/marked/Rel-16/28_series/28809/b701cd8c436a2857a615a76a868a3bb7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3db6bc4af2032c0dac695507938b8e608acdd3dc4bc6d38c63a47631f928a268 +size 24426 diff --git a/marked/Rel-16/28_series/28809/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/marked/Rel-16/28_series/28809/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..627e111fb6a58c45ad9c2fafdf6898de7956d731 --- /dev/null +++ b/marked/Rel-16/28_series/28809/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fe20a93be7f5a2fbc2be410cdc6b52ec70620a2172e48ff480613a47a925180 +size 49795 diff --git a/marked/Rel-16/28_series/28809/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/28_series/28809/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ba235e8ebc890496bcadc93431f79755ae292cf --- /dev/null +++ b/marked/Rel-16/28_series/28809/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48078998ca25a1c0055443cd4e21621059bb5729b93733c2c4e148958762fdc2 +size 39632 diff --git a/marked/Rel-16/28_series/28809/raw.md b/marked/Rel-16/28_series/28809/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..de48397f0c68296e784cc1aa8f4bbbca8927c5fa --- /dev/null +++ b/marked/Rel-16/28_series/28809/raw.md @@ -0,0 +1,2418 @@ + + +# 3GPP TR 28.809 V0.5.0 (2020-09) + +*Technical Report* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Management and orchestration; Study on enhancement of Management Data Analytics (MDA) (Release 17)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a small red signal icon. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions of terms, symbols and abbreviations ..... | 9 | +| 3.1 Terms..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Concepts and overview ..... | 9 | +| 4.1 Overview ..... | 9 | +| 4.2 MDA functionality ..... | 10 | +| 5 MDA process and role ..... | 10 | +| 5.1 MDA role in management loop..... | 10 | +| 5.2 Management interaction with NWDAF and gNB..... | 11 | +| 5.3 MDA process..... | 13 | +| 6 Use cases, potential requirements and possible solutions ..... | 14 | +| 6.1 Coverage related issues ..... | 14 | +| 6.1.1 Coverage issue analysis..... | 14 | +| 6.1.1.1 Use case ..... | 14 | +| 6.1.1.2 Potential requirements ..... | 15 | +| 6.1.1.3 Possible solutions..... | 15 | +| 6.1.1.3.1 Solution description..... | 15 | +| 6.1.1.3.2 Data required for coverage issue analysis..... | 15 | +| 6.1.1.3.3 Analytics report for coverage issue..... | 16 | +| 6.2 Resource related issues..... | 16 | +| 6.2.1 RAN user plane congestion analysis ..... | 16 | +| 6.2.1.1 Use case ..... | 16 | +| 6.2.1.2 Potential requirements ..... | 17 | +| 6.2.1.3 Possible Solutions ..... | 17 | +| 6.2.1.3.1 Solution description..... | 17 | +| 6.2.1.3.2 Data required for RAN user plane congestion problem..... | 17 | +| 6.2.1.3.3 Analytics report for RAN user data congestion ..... | 18 | +| 6.2.2 Resource utilization analytics..... | 19 | +| 6.2.2.1 Use case ..... | 19 | +| 6.2.2.2 Potential requirements ..... | 20 | +| 6.2.2.3 Possible solutions..... | 20 | +| 6.2.2.3.1 Solution description..... | 20 | +| 6.2.2.3.2 Required data for resource utilization analysis for RAN domain ..... | 20 | +| 6.2.2.3.3 Required data for resource utilization analysis for CN domain ..... | 21 | +| 6.2.2.3.4 Analytics report for resource utilization analysis..... | 22 | +| 6.2.3 Cross-slice resource optimization..... | 22 | +| 6.2.3.1 use case ..... | 22 | +| 6.2.3.2 Potential requirements ..... | 23 | +| 6.2.3.3 Possible Solution..... | 23 | +| 6.2.3.3.1 Solution description..... | 23 | +| 6.2.3.3.2 Required data for cross-slice resource optimization analysis ..... | 23 | +| 6.2.3.3.3 Analytics report for cross-slice resource optimization..... | 23 | +| 6.2.4 NAS level congestion control optimization ..... | 23 | +| 6.2.4.1 Use case ..... | 23 | +| 6.2.4.2 Potential requirements ..... | 24 | +| 6.2.4.3 Possible solutions..... | 24 | +| 6.2.4.3.1 Solution Description..... | 24 | +| 6.2.4.3.2 Data required for NAS level congestion control analysis..... | 24 | + +| | | | +|-----------|-----------------------------------------------------------------------------------------|----| +| 6.2.4.3.3 | Analytics report..... | 24 | +| 6.3 | SLS assurance related issues..... | 25 | +| 6.3.1 | E2E latency analysis..... | 25 | +| 6.3.1.1 | Use case ..... | 25 | +| 6.3.1.2 | Potential requirements ..... | 25 | +| 6.3.1.3 | Possible solutions..... | 26 | +| 6.3.1.3.1 | Solution description..... | 26 | +| 6.3.1.3.2 | Required data for latency analysis for RAN domain ..... | 26 | +| 6.3.1.3.3 | Required data for latency analysis for CN domain ..... | 27 | +| 6.3.1.3.4 | Required data for E2E latency analysis for cross domain..... | 27 | +| 6.3.1.3.5 | Analytics report for latency analysis..... | 28 | +| 6.3.2 | Network slice load analysis ..... | 28 | +| 6.3.2.1 | Use case ..... | 28 | +| 6.3.2.2 | Potential requirements ..... | 29 | +| 6.3.2.3 | Possible solutions..... | 30 | +| 6.3.2.3.1 | Solution description..... | 30 | +| 6.3.2.3.2 | Required data for network slice load analysis for cross domain..... | 30 | +| 6.3.2.3.3 | Required data for network slice load for RAN domain ..... | 30 | +| 6.3.2.3.4 | Required data for network slice load for CN domain ..... | 31 | +| 6.3.2.3.5 | Analytics report for network slice load analysis ..... | 32 | +| 6.3.3 | Service experience analysis ..... | 32 | +| 6.3.3.1 | Use case ..... | 32 | +| 6.3.3.2 | Potential requirements ..... | 33 | +| 6.3.6.3 | Possible solutions..... | 33 | +| 6.3.6.3.1 | Solution description..... | 33 | +| 6.3.6.3.2 | Data required for service experience analysis..... | 33 | +| 6.3.6.3.3 | Analytics report for service experience analysis..... | 34 | +| 6.3.4 | Network slice throughput analysis ..... | 34 | +| 6.3.4.1 | Use case ..... | 34 | +| 6.3.4.2 | Potential requirements ..... | 34 | +| 6.3.4.3 | Possible solutions..... | 35 | +| 6.3.4.3.1 | Solution description..... | 35 | +| 6.3.4.3.2 | Data required for network slice throughput statistics/predictions for RAN domain..... | 35 | +| 6.3.4.3.3 | Data required for network slice throughput statistics/predictions for CN domain ..... | 35 | +| 6.3.4.3.4 | Data required for network slice throughput statistics/predictions for cross domain..... | 36 | +| 6.3.4.3.5 | Analytics report for network slice throughput analysis ..... | 36 | +| 6.3.5 | Uplink/downlink throughput per UE in network slice analysis ..... | 36 | +| 6.3.5.1 | Use case ..... | 36 | +| 6.3.5.2 | Potential requirements ..... | 37 | +| 6.3.5.3 | Possible solutions..... | 37 | +| 6.3.5.3.1 | Solution description..... | 37 | +| 6.3.5.3.2 | Required data for UE uplink/downlink throughput analysis..... | 37 | +| 6.3.5.3.3 | Analytics report for UE uplink/downlink throughput analysis ..... | 38 | +| 6.3.6 | KPI anomaly analysis ..... | 39 | +| 6.3.6.1 | Use case ..... | 39 | +| 6.3.6.2 | Potential requirements ..... | 39 | +| 6.3.6.3 | Possible solutions..... | 39 | +| 6.3.6.3.1 | Solution description..... | 39 | +| 6.3.6.3.2 | Data required for KPI anomaly analysis for RAN domain ..... | 40 | +| 6.3.6.3.3 | Data required for KPI anomaly analysis for CN domain ..... | 40 | +| 6.3.6.3.4 | Data required for KPI anomaly analysis for cross domain ..... | 40 | +| 6.3.6.3.5 | Analytics report for KPI anomaly analysis ..... | 41 | +| 6.3.6.3.6 | Analytics report for network situation analysis..... | 41 | +| 6.3.7 | Jitter analysis ..... | 42 | +| 6.3.7.1 | Use case ..... | 42 | +| 6.3.7.2 | Potential requirements ..... | 42 | +| 6.4 | Fault management related issues..... | 43 | +| 6.4.1 | Alarm incident analysis ..... | 43 | +| 6.4.1.1 | Use case ..... | 43 | +| 6.4.1.2 | Potential requirements ..... | 43 | +| 6.4.1.3 | Possible Solutions ..... | 43 | +| 6.4.1.3.1 | Solution description..... | 43 | + +| | | | +|-----------|-----------------------------------------------------------------------|----| +| 6.4.1.3.2 | Data required for alarm incident analysis for RAN domain ..... | 43 | +| 6.4.1.3.3 | Data required for alarm incident analysis for CN domain ..... | 45 | +| 6.4.1.3.4 | Analytics report for alarm incident analysis ..... | 46 | +| 6.4.2 | Fault prediction analysis..... | 46 | +| 6.4.2.1 | Use case ..... | 46 | +| 6.4.2.2 | Potential requirements ..... | 47 | +| 6.4.2.3 | Possible solutions..... | 47 | +| 6.4.2.3.1 | Solution description..... | 47 | +| 6.4.2.3.2 | Data required for fault prediction analysis for RAN domain..... | 47 | +| 6.4.2.3.3 | Data required for fault prediction analysis for CN domain..... | 48 | +| 6.4.2.3.4 | Analytics report for fault prediction analysis ..... | 48 | +| 6.5 | Mobility management related issues..... | 48 | +| 6.5.1 | Handover optimization ..... | 48 | +| 6.5.1.1 | Use case ..... | 48 | +| 6.5.1.2 | Potential requirements ..... | 49 | +| 6.5.1.3 | Possible solutions..... | 49 | +| 6.5.1.3.1 | Solution description..... | 49 | +| 6.5.1.3.2 | Data required..... | 50 | +| 6.5.1.3.3 | Analytics report on gNB resource consumption ..... | 51 | +| 6.5.2 | Inter-gNB Beam Selection Optimization ..... | 52 | +| 6.5.2.1 | Use case ..... | 52 | +| 6.5.2.2 | Potential requirements ..... | 52 | +| 6.5.2.3 | Possible solutions..... | 53 | +| 6.5.2.3.1 | Solution description..... | 53 | +| 6.5.2.3.2 | Data required..... | 53 | +| 6.5.2.3.3 | Analytics report..... | 53 | +| 6.5.3 | Load Balancing optimization ..... | 53 | +| 6.5.3.1 | Use case ..... | 53 | +| 6.5.3.2 | Potential requirements ..... | 54 | +| 6.5.3.3 | Possible solutions..... | 55 | +| 6.5.4 | Mobility performance analysis ..... | 55 | +| 6.5.4.1 | Use case ..... | 55 | +| 6.5.4.2 | Potential requirements ..... | 55 | +| 6.5.4.3 | Possible solutions..... | 55 | +| 6.5.4.3.1 | Solution description..... | 55 | +| 6.5.4.3.2 | Data required for mobility performance analysis..... | 56 | +| 6.5.4.3.3 | Analytics report for mobility performance analysis..... | 56 | +| 6.5.5 | Handover optimization based on UE trajectory ..... | 57 | +| 6.5.5.1 | Use case ..... | 57 | +| 6.5.5.2 | Potential requirements ..... | 57 | +| 6.5.5.3 | Possible solutions..... | 57 | +| 6.5.5.3.1 | Solution description..... | 57 | +| 6.5.5.3.2 | Data required..... | 57 | +| 6.5.5.3.3 | Analytics report on user trajectory-based handover optimization ..... | 58 | +| 6.6 | Energy efficiency related issues..... | 58 | +| 6.6.1 | MDA assisted energy saving..... | 58 | +| 6.6.1.1 | Use case ..... | 58 | +| 6.6.1.2 | Potential requirements ..... | 59 | +| 6.6.1.3 | Possible solutions..... | 59 | +| 6.6.1.3.1 | Solution description..... | 59 | +| 6.6.1.3.2 | Data required for MDA assisted energy saving ..... | 59 | +| 6.6.1.3.3 | Analytics report for MDA assist energy saving..... | 60 | +| 6.7 | Paging performance related issues ..... | 60 | +| 6.7.1 | Paging optimization..... | 60 | +| 6.7.1.1 | Use case ..... | 60 | +| 6.7.1.2 | Potential Requirements ..... | 61 | +| 6.7.1.3 | Possible Solutions ..... | 61 | +| 6.7.1.3.1 | Solution description..... | 61 | +| 6.7.1.3.2 | Data required..... | 61 | +| 6.7.1.3.3 | Analytics report..... | 62 | +| 6.8 | Software management related issues..... | 62 | +| 6.8.1 | RAN Node Software Upgrade..... | 62 | + +| | | | +|------------------------------------------------------------|--------------------------------------------------------------|-----------| +| 6.8.1.1 | Use case ..... | 62 | +| 6.8.1.2 | Potential Requirements ..... | 62 | +| 6.8.1.3 | Possible Solutions ..... | 63 | +| 6.8.1.3.1 | Solution description..... | 63 | +| 6.8.1.3.2 | Data required..... | 63 | +| 6.8.1.3.3 | Analytics report..... | 64 | +| 6.9 | MDA assisted SON coordination..... | 64 | +| 6.9.1 | SON conflict prevention and resolution ..... | 64 | +| 6.9.1.1 | Use case ..... | 64 | +| 6.9.1.2 | Potential requirements ..... | 65 | +| 6.9.1.3 | Possible solutions ..... | 65 | +| 6.9.1.3.1 | Solution description..... | 65 | +| 6.9.1.3.2 | Data required for SON conflict analysis ..... | 65 | +| 6.9.1.3.3 | Analytics report SON conflict prevention and resolution..... | 66 | +| 6.10 | Security related issues ..... | 67 | +| 6.10.1 | Security risk assessment..... | 67 | +| 6.10.1.1 | Use case ..... | 67 | +| 6.10.1.2 | Potential requirements ..... | 67 | +| 6.10.1.3 | Possible solutions..... | 68 | +| 6.10.1.3.1 | Solution description..... | 68 | +| 6.10.1.3.2 | Data required..... | 68 | +| 6.10.1.3.3 | Analytics report..... | 68 | +| 6.11 | Traffic projection..... | 69 | +| 6.11.1 | Network slice traffic projection..... | 69 | +| 6.11.1.1 | Use case ..... | 69 | +| 6.11.1.2 | Potential Requirements ..... | 69 | +| 6.11.1.3 | Possible Solutions ..... | 70 | +| 6.11.1.3.1 | Solution description..... | 70 | +| 6.11.1.3.2 | Data required..... | 70 | +| 6.11.1.3.3 | Analytics report..... | 70 | +| 6.99 | MDA management aspects..... | 71 | +| 6.99.1 | ML model training for MDA..... | 71 | +| 6.99.1.1 | Use case ..... | 71 | +| 6.99.1.2 | Potential requirements ..... | 71 | +| 6.99.2 | Subscription to Management Data Analytics Reports..... | 71 | +| 6.99.2.1 | Use case ..... | 71 | +| 6.99.2.2 | Potential requirements ..... | 72 | +| 6.99.2.3 | Possible solutions..... | 72 | +| 6.99.3 | Request for Management Data Analytics Reports ..... | 72 | +| 6.99.3.1 | Use case ..... | 72 | +| 6.99.3.2 | Potential requirements ..... | 72 | +| 6.99.3.3 | Possible solutions..... | 72 | +| 6.99.4 | Confidence indicator in analysis results..... | 73 | +| 7 | Conclusions and recommendations..... | 73 | +| <b>Annex <X> (informative): Change history .....</b> | | <b>74</b> | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>should</b> | indicates a recommendation to do something | +| <b>should not</b> | indicates a recommendation not to do something | +| <b>may</b> | indicates permission to do something | +| <b>need not</b> | indicates permission not to do something | +| <b>can</b> | indicates that something is possible | +| <b>cannot</b> | indicates that something is impossible | +| <b>will</b> | 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 | +| <b>will not</b> | 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 | +| <b>might</b> | 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 | +| <b>might not</b> | 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 | +| <b>is</b> | (or any other verb in the indicative mood) indicates a statement of fact | +| <b>is not</b> | (or any other negative verb in the indicative mood) indicates a statement of fact | + +# --- Introduction + +# 1 Scope + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [3] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [4] 3GPP TS 28.530: "Management and orchestration; Concepts, use cases and requirements". +- [5] 3GPP TR 28.861: "Study on the Self-Organizing Networks (SON) for 5G networks". +- [6] 3GPP TR 28.805: "Study on management aspects of communication services". +- [7] 3GPP TS 28.554: "5G end to end Key Performance Indicators (KPI)". +- [8] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [9] 3GPP TS 22.101: "service aspects; service principles". +- [10] 3GPP TS 32.500: "Telecommunication management; Self-Organizing Networks (SON); Concepts and requirements". +- [11] 3GPP TS 37.816: "Study on RAN-centric data collection and utilization for LTE and NR". +- [12] 3GPP TS 37.320: "Radio measurement collection for Minimization of Drive Tests (MDT); Overall description". +- [13] 3GPP TS 23.501: "System Architecture for the 5G System (5GS); Stage 2". +- [14] 3GPP TS 28.310: "Energy efficiency of 5G". +- [15] 3GPP TR 21.866: "Study on Energy Efficiency Aspects of 3GPP Standards". +- [16] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [17] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [18] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [19] 3GPP TS 28.313: "Self-Organizing Networks (SON) for 5G networks". +- [20] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [21] 3GPP TS 38.304 NR: "User Equipment (UE) procedures in idle mode and in RRC Inactive state". + +[22] 3GPP TS 28.545: " Management and orchestration; Fault Supervision (FS) ". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +*<defined term>: <definition>.* + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------|---------------| +| <symbol> | <Explanation> | +|----------|---------------| + +## 3.3 Abbreviations + +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]. + +| | | +|------|-----------------------------------| +| AI | Artificial Intelligence | +| MDA | Management Data Analytics | +| MDAS | Management Data Analytics Service | +| ML | Machine Learning | + +# 4 Concepts and overview + +**Editor's note: this clause is to accommodate the concepts and overview of MDA/MDAS.** + +## 4.1 Overview + +The Management Data Analytics is defined in TS 28.550 [2] and has also been mentioned by various other technical specifications and reports including for example TS 28.533 [3], TS 28.530 [4], TR 28.861 [5] and TR 28.805 [6]. + +The MDA provides a capability of processing and analysing the raw data related to network and service events and status (e.g., performance measurements, Trace/MDT/RLF/RCEF reports, QoE reports, alarms, configuration data, network analytical data, and service experience data from AFs, etc.) to provide analytics report (including recommended actions) to enable the necessary actions for network and service operations. + +The MDA, in conjunction with Artificial Intelligence (AI) and Machine Learning (ML) techniques, brings intelligence and automation to the network service management & orchestration. + +MDA can help to perform management tasks in preparation, commissioning, operation as well as in the termination phases. For example, MDA can support service provisioning by preparing service catalogues, evaluating network requirements for a new service and carrying out feasibility check. During operation phase, the MDA can identify ongoing issues impacting the performance of the network and service, and discover in advance the potential issues that would cause potential failure and/or performance degradation. The MDA can also assist to predict the network and service demand to enable the timely resource provisioning and deployments which would allow fast time-to-market network and service deployment. + +The MDAS can be consumed by various consumers, for instance the MFs (i.e., MnS service producers/consumers for network and service management), NFs (e.g., NWDAF), SON functions, network and service optimization tools/functions, SLS assurance functions, human operators, and AFs, etc. + +The MDA is an enabler for the automation and cognition of the network and service management & orchestration. + +## 4.2 MDA functionality + +Figure 4.2.1 illustrates the functionality provided by MDA. Depending on the scenario, MDA may collect data for analysis by acting as an MDAS Consumer, and/or as an MnS Consumer, and/or as an NWDAF subscriber. After analysis, MDA acts as an MDAS Producer to expose the analysis results to MDAS Consumers. + +![Functional overview of MDA diagram](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +The diagram illustrates the functional overview of MDA. At the top, an 'MDAS Consumer' is connected to an 'MDAS' interface. Below this, a large box labeled 'Management Data Analytics' contains an 'MDAS Producer', an 'Analysis' block, an 'MDAS Consumer', an 'MnS Consumer', and an 'NWDAF Subscriber'. The 'MDAS Producer' is connected to the 'MDAS' interface. The 'MDAS Consumer', 'MnS Consumer', and 'NWDAF Subscriber' are connected to external entities: 'Other MDAS Producer', 'MnS Producer', and 'NWDAF' respectively, via 'MDAS', 'MnS', and 'Nnwdaf' interfaces. + +Functional overview of MDA diagram + +Figure 4.2.1: Functional overview of MDA + +# 5 MDA process and role + +*Editor's note: this clause is to accommodate the MDA process (in connection with AI/ML techniques), relation between MDA and SON, relation between MDA and NWDAF, position of MDAS producer in SBMA, etc.* + +## 5.1 MDA role in management loop + +The MDA forms a part of the management loop (which can be open loop or closed loop, see TS 32.500 [10]), and it brings intelligence and generates value by processing and analysis of management and network data, where the AI and ML techniques may be utilized. + +The MDA plays the role of Analytics in the management loop illustrated in figure 5.1-1 below. + +![Figure 5.1-1: Analytics in management loop. The diagram shows a central blue circle labeled 'Data' connected to four surrounding circles: 'Analytics' (top, green border), 'Observation' (left), 'Decision' (right), and 'Execution' (bottom). Double-headed arrows connect 'Data' to each of the four circles. Additionally, single-headed arrows form a clockwise loop: Observation to Analytics, Analytics to Decision, Decision to Execution, and Execution back to Observation. A legend at the bottom right shows a green circle icon with the text 'In scope of the present document'.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +Figure 5.1-1: Analytics in management loop. The diagram shows a central blue circle labeled 'Data' connected to four surrounding circles: 'Analytics' (top, green border), 'Observation' (left), 'Decision' (right), and 'Execution' (bottom). Double-headed arrows connect 'Data' to each of the four circles. Additionally, single-headed arrows form a clockwise loop: Observation to Analytics, Analytics to Decision, Decision to Execution, and Execution back to Observation. A legend at the bottom right shows a green circle icon with the text 'In scope of the present document'. + +**Figure 5.1-1: Analytics in management loop** + +**Observation:** The observation of the managed networks and services. The observation involves monitoring and collection of events, status and performance of the managed networks and services, and providing the observed/collected data (e.g., performance measurements, Trace/MDT/RLF/RCEF reports, network analytics reports, QoE reports, alarms, etc). + +**Analytics:** The data analytics for the managed networks and services. The MDA described in the TR plays the role of Analytics in the management loop. The MDA prepares, processes and analyzes the data related to the managed networks and services, and provides the analytics reports for root cause analysis of ongoing issues, prevention of potential issues and prediction of network or service demands. The analytics report contains the description of the issues or predictions with optionally a degree of confidence indicator, the possible causes for the issue and the recommended actions. Techniques such as AI and ML (e.g., ML model) may be utilized with the input data including not only the observed data of the managed networks and services, but also the execution reports of actions (taken by the execution step). The MDA classifies and correlates the input data (current and historical data), learn and recognize the data patterns, and makes analysis to derive inference, insight and predictions. + +**Decision:** The decision making for the management actions for the managed networks and services. The management actions are decided based on the analytics reports (provided by MDA) and other management data (e.g., historical decisions made) if necessary. The decision may be made by the consumer of MDAS (in the closed management loop), or a human operator (in the open management loop). The decision includes what actions to take, and when to take the actions. + +**Execution:** The execution of the management actions according to the decisions. During the execution step, the actions are carried out to the managed networks and services, and the reports (e.g., notifications, logs) of the executed actions are provided. + +## 5.2 Management interaction with NWDAF and gNB + +There are two types of data analytics services, one is the network data analytics service provided by NWDAF, another is the MDAS provided by 3GPP management system. The MDAS producer provides the analytics data for management purposes based on the data related to different types of NFs, e.g., data reported from gNB and other core network functions. The MDAS producer may use the analytics result of NWDAF as input. + +Figure 5.2-1 shows an example of the coordination between NWDAF, gNB and MDAS producer for data analytics purpose. + +1. The NWDAF may consume the MDAS for identified scenarios and provide analytics service for 5GC NF for control purpose. +2. The CN Domain MDAS producer may consume the service provided by NWDAF and other 5GC NFs and provide analytics data for management purpose. + +- 3. The gNB may consume the MDAS for identified scenarios for RAN control purpose. +- 4. The RAN Domain MDAS producer may consume the service provided by gNB and provide analytics data for management purpose. + +![Diagram showing the coordination between 3GPP cross domain MDAS Consumer, 3GPP cross domain MDAS Producer (Domain MDAS consumer), CN Domain MDAS Producer, RAN Domain MDAS Producer, NWDAF, Any core NF, and gNB across Core and RAN domains.](1439cb942d9e363bbb3161b5540dd8c6_img.jpg) + +The diagram illustrates the flow of MDAS (Management Data Analytics Service) data across different domains. At the top, a '3GPP cross domain MDAS Consumer' is connected to a '3GPP cross domain MDAS Producer (Domain MDAS consumer)' via an MDAS interface. Below the producer, two branches emerge: one to the 'CN Domain MDAS Producer' and another to the 'RAN Domain MDAS Producer', both via MDAS interfaces. The CN Domain MDAS Producer is connected to a 'Core domain' box containing 'NWDAF' and 'Any core NF'. It has MDAS and MnS interfaces with the producer, and Nnwdaf, Nnf, and Nnwdaf interfaces with the NWDAF. The RAN Domain MDAS Producer is connected to a 'RAN domain' box containing 'gNB'. It has MDAS and MnS interfaces with the producer, and an MDAS interface with the gNB. + +Diagram showing the coordination between 3GPP cross domain MDAS Consumer, 3GPP cross domain MDAS Producer (Domain MDAS consumer), CN Domain MDAS Producer, RAN Domain MDAS Producer, NWDAF, Any core NF, and gNB across Core and RAN domains. + +**Figure 5.2-1: Example of coordination between NWDAF, gNB and MDAS producer for data analytics** + +Figure 5.2-2 shows another example of the coordination between NWDAF and MDAS producer for data analytics purpose. + +- 1. The NWDAF may consume the MDAS for identified scenarios and provide analytics service for 5GC NF for control purpose. +- 2. The gNB may consume the MDAS for identified scenarios for RAN control purpose +- 3. The Domain MDAS producer may consume the service provided by NWDAF, other 5GC NFs and gNB, provide analytic data for management purpose. + +![Figure 5.2-2: Example of coordination between NWDAF, gNB and MDAS producer for data analytics. The diagram shows a 3GPP domain MDAS Consumer connected to a Domain MDAS Producer via an MDAS interface. The Domain MDAS Producer is connected to a 3GPP domain containing NWDAF, Any core NF, and gNB. Connections are labeled with Nnwdaf, Nnf, MnS, and MDAS interfaces.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +graph TD + Consumer[3GPP domain MDAS Consumer] -- MDAS --- Producer[Domain MDAS Producer] + subgraph "3GPP domain" + NWDAF[NWDAF] + CoreNF[Any core NF] + gNB[gNB] + end + Producer -- MDAS --- NWDAF + Producer -- MnS --- CoreNF + Producer -- MDAS --- gNB + NWDAF -- Nnwdaf --- CoreNF + CoreNF -- Nnf --- NWDAF + NWDAF -- Nnwdaf --- CoreNF + +``` + +Figure 5.2-2: Example of coordination between NWDAF, gNB and MDAS producer for data analytics. The diagram shows a 3GPP domain MDAS Consumer connected to a Domain MDAS Producer via an MDAS interface. The Domain MDAS Producer is connected to a 3GPP domain containing NWDAF, Any core NF, and gNB. Connections are labeled with Nnwdaf, Nnf, MnS, and MDAS interfaces. + +Figure 5.2-2: Example of coordination between NWDAF, gNB and MDAS producer for data analytics + +## 5.3 MDA process + +The MDA may rely on ML technologies, which may need the consumer to be involved to optimize the accuracy of the MDA results. + +The MDA process in terms of the interaction with the consumer, when utilizing ML technologies, is described in the figure below. + +![Figure 5.3-1: MDA process. The diagram illustrates the flow of data and reports between an MDAS producer and an MDAS consumer. The MDAS producer contains a Data classification module, an ML model training module, and a Management data analysis module. The MDAS consumer contains a Validation module. Green arrows represent the process for ML model training, and blue arrows represent the process for management data analysis.](4636adff5682a064f0ae5f13a1d464a6_img.jpg) + +``` + +graph LR + AI([Analytics input]) --> DC + TD([Training data]) --> DC + TD --> ML + + subgraph "MDAS producer" + DC[Data classification] + subgraph "Data analytics module" + ML[ML model training] + MDA[Management data analysis] + end + end + + DC --> ML + DC --> MDA + + ML --> TR([Training report]) + MDA --> AR([Analytics report]) + + subgraph "MDAS consumer" + V[Validation] + end + + TR --> V + AR --> V + V --> VD([Validation data]) + VD --> TD + + %% Legend and Styling + style TD fill:#76C73B + style TR fill:#76C73B + style ML fill:#76C73B + style AI fill:#3B91C7 + style AR fill:#3B91C7 + style MDA fill:#3B91C7 + style VD fill:#A680B8 + style V fill:#FFFFFF,stroke:#A680B8,stroke-width:2px + +``` + +Legend: + +- ➞ Process for ML model training +- ➞ Process for management data analysis + +Figure 5.3-1: MDA process. The diagram illustrates the flow of data and reports between an MDAS producer and an MDAS consumer. The MDAS producer contains a Data classification module, an ML model training module, and a Management data analysis module. The MDAS consumer contains a Validation module. Green arrows represent the process for ML model training, and blue arrows represent the process for management data analysis. + +Figure 5.3-1: MDA process + +There are two kinds of processes for MDA, the process for ML model training and the process for management data analysis. In the process for ML model training, the MDA producer classifies the input data for training purpose, trains the ML model and provides the ML training report. The process for ML model training may also get the consumer involved, i.e., allowing the consumer to provide input for ML model training. The ML model training may be performed on an un-trained ML model or a trained ML model. In the process for management data analysis, the MDA producer classifies the analytics input for management data analysis purpose, analyses the data by the trained ML model, and provides the analytics report to the consumer. + +**Data classification:** The data input to the MDA producer could be used for ML model training or for the actual management data analysis. The MDA producer classifies the input data into the category for ML data training and the category for management data analysis, and passes the classified data along to corresponding step for further processing. + +**ML model training:** The MDAS producer trains the ML model, i.e., to train the algorithm of the ML model to be able to provide the expected training output by analysis of the training input. The data for ML model training may be the training data (including the training input and the expected output) and/or the validation data provided by the consumer. After the ML model training, the MDAS producer provides an ML model training report. + +**Management data analysis:** The trained ML model analyses the classified data and generates the management data analytics report(s). Analytics reports were presented in Section 5.1. + +**Validation:** The consumer may validate the output data provided by the MDAS producer. The output data to be validated may be the analytics report and/or the ML model training report as described above. The consumer may provide the validation data as feedback to the MDAS producer, and the MDAS producer will use the validation data for further ML model training with the historical data that are used to generate the validated output data. + +# --- 6 Use cases, potential requirements and possible solutions + +## 6.1 Coverage related issues + +### 6.1.1 Coverage issue analysis + +#### 6.1.1.1 Use case + +The coverage issue may cause various UE and network failures and degrade the network performance offered the UEs. + +The coverage issue could be a weak coverage, a coverage hole, a pilot pollution, an overshoot coverage, or a DL and UL channel coverage mismatch as described in clause 5.1.1, 3GPP TS 37.816 [11]. The weak coverage may result in low success rate of random access, paging, RRC connection establishment and handover, low data throughput, more abnormal releases of RRC connection, DRB retainability, QoS flow and/or PDU session resources, and dissatisfied QoE. The coverage hole is a more severe problem and would further lead to the UE out of service in the area. + +The 5G related coverage issue may exist only in 5G (i.e., 5G issue only with good coverage provided by other RATs) or exist in all RATs (i.e., no RAT provides good coverage in the area). + +Coverage performance should be assured to guarantee user service experience. It is desirable that the coverage issue can be detected by MDA from the various symptoms, together with the geographical and terrain data and the configuration parameters of the RAN. + +Once the coverage issue is detected, the MDAS producer provides the analytics report that precisely describes the coverage issue, and the analytics report needs to contain sufficient information to enable the MDAS consumer (e.g., SON CCO function) to take the remedy actions. The MDAS producer may also provide the recommended actions to solve the identified coverage issue in the analytics report, so that the MDAS consumer can execute the actions accordingly or by taking the recommended actions into account. + +The MDAS producer is informed when the actions are taken by the MDAS producer consumer to solve the coverage issue described in the analytics report, so that the MDAS producer can start evaluating the result of the executed actions. + +The MDAS producer gets the execution reports describing the actions taken by the MDAS consumer, and takes the execution reports into account to fine-tune the accuracy of the future (new or updated) analytics report. + +The MDAS producer also provide update(s) of the analytics report to indicate the status change (e.g., solved, mitigated or deteriorated) of the coverage issue. + +#### 6.1.1.2 Potential requirements + +**REQ-COV\_ANA-CON-1** The MDAS producer should have a capability to provide the analytics report describing the coverage issue. + +**REQ-COV\_ANA-CON-2** The analytics report describing the coverage issue should contain the following information: + +- The identifier of the coverage issue described in the analytics report; +- Indication of whether the coverage issue is weak coverage or coverage hole, a pilot pollution, an overshoot coverage, or a DL and UL channel coverage mismatch; +- The start time and end time of the coverage issue; +- The geographical area and location where the coverage issue exists; +- Root cause of the coverage issue; +- Whether the coverage issue exists in 5G only or in all RATs; +- The cells affected by the coverage issue; +- The severity level (e.g., critical, medium, or cleared) of the coverage issue; +- The recommended actions to solve the coverage issue. + +#### 6.1.1.3 Possible solutions + +##### 6.1.1.3.1 Solution description + +The MDAS producer correlates, processes and analyzes the data described in the following subclause within a time period on a regular basis or triggered by events (e.g., the RLF reports) to identify the coverage issue, and provide the analytics reports to describe the identified coverage issues (which could be new issues or the updates of existing issues). + +##### 6.1.1.3.2 Data required for coverage issue analysis + +The following table describes the data required for coverage issue analysis: + +| Data category | Required data | +|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance measurements | <ul style="list-style-type: none"> <li>- Average/distribution of UE reported RSRPs/RSRQs/SINRs of the serving cell when the TA (Timing Advance) or UE rx-tx applied to the UEs is in a specific range;</li> <li>- Average/distribution of UE reported RSRPs/RSRQs/SINRs of each neighbour cell when the UE reported RSRPs/RSRQs of the serving cell is in a specific range, measured per NCR (neighbour cell relation), per SSB index and per CSI-RS index of each NCR;</li> <li>- Number of abnormal releases of DRBs, QoS flows, PDU sessions, and UE contexts in the serving cell measured per SSB index and per CSI-RS index</li> </ul> | +| MDT reports | MDT reports containing RSRPs and RSRQs of the serving cell and neighbour cells reported by each UE with anonymous id (e.g., C-RNTI) and location information. | +| RLF reports | RLF reports containing RSRP(s) and RSRQ(s) of the serving cell and neighbour cells reported by each UE with anonymous id (e.g., C-RNTI) and location information. | +| RECF reports | RCEF reports containing RSRP(s) and RSRQ(s) of the serving cell and neighbour cells reported by each UE with anonymous id (e.g., C-RNTI) and location information. | +| UE location reports | UE location information provided by the LCS with the anonymous id (e.g., C-RNTI) which can be used to correlate with the MDT/RLF/RCEF reports. | +| QoE reports | <b>Editor's note: the level of details of QoE reports required in this solution for FFS.</b> | +| Geographical data and terrain data of the RAN | <ul style="list-style-type: none"> <li>- The geographical information (longitude, latitude, altitude) of the deployed RAN (gNBs and eNodeBs, antennas, sector carrier equipments, etc.).</li> <li>- The terrain data for the area of the deployed RAN.</li> </ul> | + +| | | +|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Editor's note: which MnS provides this kind of data is FFS. | +| Configuration data | <ul style="list-style-type: none"> <li>- The current NRMs containing the attributes affecting the RAN coverage, such as maximum transmission power of the cell, directions and tilts of the antennas or beams, etc.</li> <li>- The NRM update reports (notifications or logs) containing the creations or changes of the MOIs (Managed Object Instance) affecting the RAN coverage.</li> </ul> | + +##### 6.1.1.3.3 Analytics report for coverage issue + +The analytics report describing the coverage issue contains the following information: + +- Coverage issue identifier: The identifier of the coverage issue; +- Coverage issue type indication: Indication that the coverage issue is weak coverage or coverage hole, pilot pollution, overshoot coverage, or DL and UL channel coverage mismatch; +- Start time: The start time of the coverage issue; +- Stop time: The stop time of the coverage issue; +- Location: The geographical area and location where the coverage issue exists; +- Root cause: Root cause of the coverage issue, e.g., weak transmission power, blocked by constructions, restricted by terrain, etc; +- RAT indication: Indication that the coverage issue exists in 5G only or in all RATs; +- Affected objects: The MOIs of the cells affected by the coverage issue; +- Severity level: The severity level (e.g., critical, medium, cleared) of the coverage issue; +- Recommended actions: The recommended actions to solve the coverage issue. The recommended action could be re-configurations of coverage related attributes, creation of new cells or beams, or manual operations to add or change the physical units. + +Editor's Note: Quantification of severity levels is FFS. + +## 6.2 Resource related issues + +### 6.2.1 RAN user plane congestion analysis + +#### 6.2.1.1 Use case + +With the development of diverse communication services and the increasing number of connections, user data volume demanded by end users grows rapidly which may not be satisfied by the current deployed 5G network. + +In clause 3.1 of TS 22.101 [9], the RAN user plane congestion is defined as the situation where the demand for RAN resources to transfer user data exceeds the available RAN capacity to deliver the user data for a significant period of time in the order of few seconds or longer. The case where a short-duration burst of user plane traffic is not identified as RAN congestion. + +Due to the complexity of 5G network and wireless environment, multiple types of performance deteriorate are related with RAN user plane congestion, e.g., high drop rate of PDCP PDU, the full PRB utilisation, inappropriate mobility parameters configuration or inefficient usage of radio resources. The root causes should be analysed and identified to help to resolve the RAN user plane congestion and improve the end users' experience, e.g., the issue of lack of physical or virtual resources or unsuitable resources allocation, unsuitable mobility parameters. The recommended actions may also be provided, e.g., recommended policies of physical and virtual resources allocation, possible means to improve the radio condition, load balancing mechanisms etc. + +The producer of MDAS is able to, from the perspective of the management aspects, provide the user plane data congestion analytics report related to a specific cell, specific network slicing instance or subnetwork. This analytics report can be considered as an input to support SLS assurance to perform further evaluation. + +**Editor's Note:** The more detailed descriptions of user plane congestion are FFS. + +#### 6.2.1.2 Potential requirements + +**REQ-CONG\_ANA-CON-1:** The MDAS producer shall be able to provide the analytics report describing the RAN user plane congestion problem. + +**REQ-CONG\_ANA-CON-2:** The analytics report describing the RAN user plane congestion problem should contain the following information: + +- The identifier of the RAN user plane congestion; +- Indication of the RAN user plane congestion type; +- The start time and end time of the RAN user plane congestion; +- The geographical area and location where the RAN user plane congestion affects; +- Root cause of the RAN user plane congestion; +- The objects affected by the RAN user plane congestion; +- The severity level of the RAN user plane congestion; +- The recommended actions to solve the RAN user plane congestion problem. + +#### 6.2.1.3 Possible Solutions + +##### 6.2.1.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to identify the RAN user plane congestion problems. As the table in 6.2.1.3.3 shows, the analytics report is able to be provided by the MDAS producer to describe the root causes and recommendations of identified RAN user plane problem. This procedure may be triggered by the request or periodically. + +##### 6.2.1.3.2 Data required for RAN user plane congestion problem + +Following table shows the potential data required to analyse the RAN user plane congestion problem. + +| Data Category | Required Data | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>UE throughput: The IP throughput of end users, see clause 5.1.1.3 of TS 28.552 [8];</p> <p>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[8];</p> <p>PDCP Data Volume: The transmitted PDCP data volume, see clause 5.1.2.1 and 5.1.3.6 of TS 28.552 [8];</p> <p>TB related measurements: The TB transmitted in a cell, see clause 5.1.1.7 of TS 28.552 [8];</p> <p>CQI related measurements: the distribution of Wideband CQI (Channel Quality Indicator) reported by UEs in the cell, see clause 5.1.1.11 of TS 28.552 [8];</p> <p>MCS related Measurements: the distribution of the MCS scheduled for PDSCH RB by NG-RAN, the distribution of the MCS scheduled for PUSCH RB by NG-RAN, see clause 5.1.1.12 in TS 28.552 [8];</p> | + +| | | +|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7];</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];</p> | +| MDT Data | UE measurements related to RSRP, RSRQ, SINR and UE location information. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration Data | The execution data including the changes or the configuration of the MOIs related with RAN user plane congestion. | + +Note: The above parameters may not be the complete list. + +##### 6.2.1.3.3 Analytics report for RAN user data congestion + +Following table shows the potential information carried in the analytics report of RAN user plane congestion. + +| <b>Analytics Report of RAN user plane congestion</b> | <b>Attribute Name</b> | <b>Description</b> | +|------------------------------------------------------|-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Resource issue identifier | The identifier of the RAN user plane congestion | +| | RAN user plane congestion type indication | Indicator of the root cause of the RAN user plane congestion, e.g., PRB resources shortage, unsuitable resource allocation, inappropriate mobility parameters configuration, inefficient usage of radio resources | +| | Start time | The start time of the RAN user plane congestion problem | +| | Stop time | The end time of the RAN user plane congestion problem | +| | Location | The geographical area or the cells where the RAN user plane congestion exists | +| | Root cause | The root cause of the UP congestion issue, e.g. poor radio condition, inappropriate radio resource allocation, bad handover parameters etc | +| | Affected objects | The MOIs of the cells or subnetworks or network slices affected by the RAN user plane congestion problem | +| | Severity level | The severity level (e.g., critical, medium, not important) of the RAN user plane congestion | +| | Recommended actions | The recommended actions to solve the RAN user plane congestion problem. The recommended actions could be to update the policies of physical and virtual resources allocation, improve the radio condition quality, or optimize load balancing mechanisms. | + +Editor's Note: Quantification of severity levels is FFS. + +### 6.2.2 Resource utilization analytics + +#### 6.2.2.1 Use case + +The network is a resource limited system, it is therefore quite imperative to ensure an optimum resource utilization for the network so that the required resources can be efficiently allocated while ensuring no wastage or under allocation of resources to cause additional CapEx and OpEx. + +The resources usage for a network, a portion of network or a network slice could be higher or lower during different time periods depending on the traffic patterns. The traffic patterns could also vary in different geographical locations (e.g., business area, entertainment area and residential area) of the network, and could vary for different network slices. It could happen that at some point in some areas or network slices the resources are in shortage status while in some other areas or network slices there are abundant resources. This may result in that the users cannot be satisfactorily served in some areas or network slices due to lack of resources even though the overall maximum capacity is sufficient. Resource shortage may affect the QoS and potentially impact user quality of service experience, e.g., lowering down the user data throughput, prolong the user data delay, raise the rejections and failures for establishment of new connections (e.g., RRC connection), sessions (e.g., PDU session) and resources (e.g., QoS flows, DRBs, etc.) and increase the drops of the existing connections, sessions and resources and deteriorates user quality of service experience. Especially in shared scenarios, it is usually that network slices may share the same RAN resources, TN resources and/or some CN network resources. When resources become limited, the suddenly high increase in resource usage by one network slice may potentially affect the performance of other network slices. If resources are not limited but one network slice is in relatively higher resource usage and the others are in lower resource usage, the proportion of resource distribution may need to be reallocated without provisioning additional spare resources in order to achieve efficient and optimum network resource usage, which can effectively reduce the CapEx and OpEx. + +Therefore, it would be desirable that the spare resource of the under-utilized usage areas or network slices can be reallocated to areas or network slices that requires more resources within the same period of time to prevent the resource shortage from happening. + +The MDA can analyze the current and historical performance data related to resource usage, network traffic and user quality of service experience for the network or network slices, and identify the ongoing issues on resource utilization and predict potential issues. + +The MDAf may provide analytical report on capacity planning, resource requirements, resource utilization, resource availability and resource reservation proposals to assist the feasibility check by network and network slice management system before the provisioning of the communication service. + +The MDAS producer provides analytics report describing the ongoing and/or potential resource utilization issues to the authorized consumers. The issues need to be described precisely, including (but not limited to) the information about which part of the network or network slice has encountered or is going to encounter the resource utilization issue, it is resource shortage or resource excess, over which time period, etc. The MDAS producer may also provide the recommendations to solve the resource utilization issues identified by the analytics report. The recommended actions may be for example to schedule the “scale-in” and “scale out” of VNFs to dynamically (re-)allocate the virtualized resources to where they are needed, or to create/update the resource allocation policy for different network slices to allow the network slices getting different percentage of resources in different time periods according the traffic patterns and user quality of service experience. In case of sharing scenario, the MDAS producer should also weighs the resource usages of the shared network resources which belong to different network slices. If reallocating the already allocated network resource can solve the resource utilization issues, no other newly allocated network resource is needed. + +The MDAS producer gets the execution reports of the actions taken by the MDAS consumer to solve the resource utilization issue, and takes the execution reports into account in the following analysis. + +The MDAS producer continue analyzing the reported issue and provides update(s) if there is any status change (e.g., solved, mitigated or deteriorated) till it is solved. + +#### 6.2.2.2 Potential requirements + +**REQ-RES-ANA-1** The MDAS producer should have a capability to provide the analytics report describing the resource utilization issue. + +**REQ-RES-ANA-2** The analytics report describing the resource utilization issue should contain the following information: + +- The identifier of the resource utilization issue; + +- Indication that it is an ongoing issue or potential issue; +- The time period(s) during which the resource utilization issue has happened or is potentially going to happen; +- Indication that resource issue is shortage or excess over each time period; +- Percentage of resource shortage or excess in each time period; +- The network entities involved in the resource utilization issue; +- The network slices involved in the resource utilization issue; +- The recommended actions to solve the resource utilization issue. + +**REQ-RES-ANA-3** The MDAS producer should have a capability to weigh the allocation of shared network resource when providing the analytics report describing the resource utilization issue. + +#### 6.2.2.3 Possible solutions + +##### 6.2.2.3.1 Solution description + +The MDAS producer correlates and analyzes the ongoing and/or potential resource utilization issues based on the the current and historical performance data related to resource usage and network traffic for the network or network slices. The required data can be from RAN domain or CN domain or both. Based on the analysis above, the MDAS producer is able to provide the domain specific or cross domain analytics report as defined in 6.2.2.3.4 related with resource utilization analytics triggered by event or periodically. + +To assist the feasibility check, the MDAS producer may consider the following information: e.g., capacity planning of the network slice instance and/or network slice subnet instance, existing active or non-active network slice instance and/or network slice subnet instance resource information, slice provisioning requirements, etc. + +##### 6.2.2.3.2 Required data for resource utilization analysis for RAN domain + +The management data required to analyze the RAN related resource utilization are defined as the following table. + +| Input data | Data type | Description | +|-------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [2]. MDAS uses this information to identify target network slices for resource utilization analytics and may derive network topology information according to S-NSSAI. | +| Performance measurement | Measurement data | <p>UE throughput: The IP throughput of end users, see clause 5.1.1.3 of TS 28.552 [3];</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [4];</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [4];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [4];</p> <p>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[3];</p> | +| MDT Data | Measurement data | UE measurements related to RSRP, RSRQ, SINR and UE location information, see TS 37.320 [12]. | + +| | | | +|-------------------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| Capacity planning data | Use case and procedures | Capacity management use case and procedure, see clause 5.4.15 of TS28.530 [5] and clause 7.15 of TS28.531[6]. | +| Network topology | Network topology data | The topology of the network for resource utilization analytics. | +| User service experience | Analysis data | User service experience relevant attributes and/or analytics analysis obtained from NWDAF or AF, see clause 6.4 of TS 23.288 [18]. | + +Note: The above parameters may not be the complete list. + +##### 6.2.2.3.3 Required data for resource utilization analysis for CN domain + +The management data required to analyze the CN related resource utilization are defined as the following table. + +| Input data | Data type | Description | +|-------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [2]. MDAS uses this information to identify target network slices for resource utilization analytics and may derive network topology information according to S-NSSAI. | +| Performance measurement | Measurement data | <p>User subscription data by performance measurement for AMF as defined in clause 5.2 of TS 28.552 [3];</p> <p>Performance measurement data for SMF as defined in clause 5.3 of TS 28.552 [3];</p> <p>Performance measurement data for UPF as defined in clause 5.4 of TS 28.552 [3];</p> <p>Performance measurement data for NF as defined in clause 5.7 of TS 28.552 [3];</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [4];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [4];</p> <p>PDU sessions for network slice instance: number of PDU sessions and PDU session establishment time of network slice instance, see clause 6.4.1 and clause 6.4.3 of TS 28.554 [4];</p> <p>Virtualised resource utilization: Virtualised resource utilization of Network Slice Instance, see clause 6.4.2 of TS 28.554 [4];</p> | +| Capacity planning data | Use case and procedures | Capacity management use case and procedure, see clause 5.4.15 of TS28.530 [5] and clause 7.15 of TS28.531[6]. | +| Network topology | Network topology data | The topology of the network for resource utilization analytics. | + +Note: The above parameters may not be the complete list. + +##### 6.2.2.3.4 Analytics report for resource utilization analysis + +Following table provides the potential contents of the domain specific or cross domain analytics report of resource utilization analysis based on the required data received as described in 6.2.2.3.2 and 6.2.2.3.3. + +| Analytics Report of resource utilization analysis | Attribute Name | Description | +|---------------------------------------------------|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------| +| | Resource utilization issue Identifier | The identifier indicates the resource utilization issue | +| | Indication of resource utilization issue type | Indicates the type of the resource utilization issue, e.g., ongoing or potential resource utilization issue | +| | Time period | Describes the time period(s) during which the resource utilization issue has happened or is going to happen | +| | Indication of resource usage demand | Indicates that resource issue is shortage or excess in each time period | +| | Percentage of resource usage demand | Describes percentage of resource shortage or excess in each time period | +| | List of network entities | Lists the network entities involved in the resource utilization issue | +| | A List of network slices | List of the network slices involved in the resource utilization issue | +| | Recommended actions | Describes the recommended actions to solve the resource utilization issue | + +### 6.2.3 Cross-slice resource optimization + +#### 6.2.3.1 use case + +In TR 28.861 [5], SON use case of cross-slice network resource optimizations described. The resource allocated for each network slice instance may vary considering the network resource utilization, traffic patterns, network bandwidth and the demand of resources for each NSI, the priorities of NSI, etc. + +The MDAS producer is expected to have the capability to provide analytics report of resource optimization for multiple network slices. Resource optimizations for multiple network slices may be dependent on each other. Resource scale out / in of one slice may impact resource allocation strategy of the other network slices considering the overall resource availability constraints. Aspects to be considered by MDAS include network slice type, priority, resource availability, traffic load, QoS requirements and QoS flow related measurements etc. The recommendations of the most optimal resource allocation for each network slice and the predictions of the resource demand for each NSI may also be provided. This analytics report can be consumed by SON function to help the optimization of cross-slice resource optimization. + +#### 6.2.3.2 Potential requirements + +**REQ-Multi-SLICE-Resource\_MDA-1:** MDAS producer shall have the capability to provide analytics report describing resource optimization across multiple network slices. + +**REQ-Multi-SLICE-Resource\_MDA-2:** The analytics report describing the resource optimization across multiple network slices should include the following information: + +- Resource optimization threshold for each network slice; +- Recommendations of resource allocation for each NSI; +- The predictions of resource demand for each NSI + +#### 6.2.3.3 Possible Solution + +##### 6.2.3.3.1 Solution description + +The MDAS producer correlates and analyzes the resource optimization strategies across multiple network slices based on the current and historical resource utilization measurements and network traffic for each network slice instances. Based on the analysis above, the MDAS producer is able to provide the analytics report as defined in 6.2.3.3.3 related with cross slice resource optimization analytics triggered by event or periodically. + +##### 6.2.3.3.2 Required data for cross-slice resource optimization analysis + +The input data in clause 6.2.2.3.2 and 6.2.2.3.3 can be reused as the required management data to analyze the resource optimization across multiple network slices. + +##### 6.2.3.3.3 Analytics report for cross-slice resource optimization + +Following table provides the potential contents of the analytics report of cross-slice resource optimization. + +| <b>Analytics Report of cross-slice resource optimization analysis</b> | <b>Attribute Name</b> | <b>Description</b> | +|-----------------------------------------------------------------------|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Cross-slice resource optimization Identifier | The identifier indicates the Cross-slice resource optimization | +| | Resource optimization threshold | Indicates the thresholds to trigger network resource optimizations for each network slice; | +| | Resource allocation recommendation | Describes the recommendations of resource allocation (e.g. increase or decrease NSI capacities like storage, computing, network bandwidth and radio resources) for each NSI; | +| | Resource demand prediction | Describes the predictions of resource demand for each NSI | + +### 6.2.4 NAS level congestion control optimization + +#### 6.2.4.1 Use case + +The current NAS level congestion control as described in TS 23.501 [13] uses back-off timer to avoid AMF receiving large amounts of NAS messages from UEs including Mobility Registration Update request. The AMF will accept or rejects the request depending on various aspects. In virtualized environment, the Mobility Registration Update request may be rejected due to inadequacy of available resources with the target AMF. The resource may include virtual resource (e.g., compute, memory and disk). If the Mobility Registration Update request is rejected by the AMF, UE will receive the reject message with a Mobility Management back off time and send a new Mobility Registration Update request after the timer. It is possible that the new Mobility Registration Update request will be rejected again because of the load of the AMF. This mechanism results in wastage of UE and network resources. It also brings inefficiency in network procedures. + +It is desirable to use MDAS (Management data analytic service) to assist congestion control in order to avoid too many rejections of NAS messages at the AMF. MDAS producer provides analytical report containing the current and future/predicted resource consumption status for the target AMF. The analytical report also provides recommended actions to optimize the target AMF for congestion control. Based on the report MDAS consumer adjusts (e.g., scale-out/up the virtual resource, set the suitable timer) the resources before continuing processing the received messages. + +#### 6.2.4.2 Potential requirements + +**REQ-NAS\_OPT\_CON-1** MDAS producer shall have the capability to provide analytics report describing the NAS level congestion issue at AMF. + +**REQ-NAS\_OPT\_CON-2** The analytics report describing the NAS level congestion issue should contain the following information: + +- The identifier of the NAS level congestion issue described in the analytics report; + +- The start time and end time of the NAS level congestion issue; +- Affected AMF; +- Root cause of the NAS level congestion issue; +- The recommended actions to solve NAS level congestion issue. + +#### 6.2.4.3 Possible solutions + +##### 6.2.4.3.1 Solution Description + +The MDAS producer correlates and analyses the management data described in the following subclause to provide AMF resource consumption statistics/predictions, identification of NAS level congestion issues and the root cause as the table in clause 6.2.4.3.3 shows. This procedure may be triggered by the request or periodically + +##### 6.2.4.3.2 Data required for NAS level congestion control analysis + +The management data required to analyze the NAS level congestion issue are defined as the following table. + +| Data category | Required data | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | Performance measurement for AMF: registration and service related measurement for AMF as defined in clause 5.2 of TS 28.552 [3].<br>Virtual resource usage measurement for AMF as defined in clause 5.7 of TS 28.552 [3]. | +| QoE Data | The details information of QoE data required by this case is FFS. | + +##### 6.2.4.3.3 Analytics report + +The NAS level congestion issue analytics report contains the following information. + +| Analytics Report of NAS level congestion issue | Attribute Name | Description | +|------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Issue identifier | The identifier of the NAS level congestion. | +| | Start Time | The start time of the issue happened. | +| | Stop Time | The end time of the issue has been solved. | +| | Affected AMF | The MOI of the AMF that affected by the NAS level congestion issue. | +| | Root cause | The root cause of the NAS level congestion issue, e.g. increased resource consumption. | +| | Recommended actions | Recommendation for AMF in order to make it optimal for NAS level congestion control e.g. scale-out AMF, Increase or adjust back-off time to avoid large amounts of UEs initiate deferred requests simultaneously. | + +## 6.3 SLS assurance related issues + +### 6.3.1 E2E latency analysis + +#### 6.3.1.1 Use case + +Latency is one of the SLA parameters for URLLC services. User data packets should be successfully delivered within certain time constraints to satisfy the end users requirements. + +Latency could be impacted by the network capability and network configurations, e.g. configuration of service priority, RAN capacity, network load, number of re-transmissions, Wireless channel environment and the processing time of the network functions, etc. These factors may be the root cause if the latency requirements cannot be achieved. Packet transmission latency may dynamically change if one or multiple of these factors change. The latency requirement should be assured even if some of the network conditions may degrade. There are some mechanisms to assure latency, e.g. to upgrade the service priority, allocate or reserve more network resource, prepare backups. + +With regard to latency analysis for URLLC services, the performance data and fault data are required to be collected, reported and analysed in near real time. Distributed MDAS deployment architecture should be applied for this scenario. The domain MDAS Providers located in the edge network provides latency analysis or predictions for local services in near real time. E.g. for latency and other related QoS evaluation or prediction for V2X application, user location and user trajectory may need to be analyzed in near-real time. The analytical report can be consumed by edge AFs to perform actions in time. The centralized MDAS Providers analyzes integrate latency performance for cross domain. It may provide more comprehensive analytical report to the centralized AF. AI/ML models or analytical data may need to be exchanged between the neighbouring domain MDAS Providers, or between domain MDAS Providers and the centralized MDAS Providers. + +From the management perspective, resource configuration and allocation algorithms or policies should support latency assurance. E2E latency is the latency across multiple domains, e.g. RAN domain, core network domain and transport network domain, each domain should ensure its own latency requirement to achieve the total E2E latency goal. The domain specific MDAS can be utilized to provide the domain specific latency analysis, and together with the cross-domain MDAS to provide E2E latency analysis to support SLS assurance. + +#### 6.3.1.2 Potential requirements + +**REQ-LATENCY\_ASS-CON-1:** MDAS producer should have the capability to provide analytics report describing the latency problem. + +**REQ-LATENCY\_ASS-CON-2:** The MDAS producer should have the capability to provide the latency analytics report in time for URLLC services according to the corresponding latency requirement. + +**REQ-LATENCY\_ASS-CON-3:** Distributed MDAS deployment and exchange of analytical data between MDAS producers should be supported. + +**REQ-LATENCY\_ASS-CON-4:** The analytics report describing the latency problem should include the following information: + +- The identifier of the latency issue; +- Indication of latency issue type; +- The start time and end time of the latency issue; +- The geographical area and location where the latency issue exists; +- Root cause of the latency issue; +- The objects affected by the latency issue; +- The severity level of the latency issue; +- The recommended actions to solve the latency issue. + +#### 6.3.1.3 Possible solutions + +##### 6.3.1.3.1 Solution description + +The performance measurements, e.g., network latency, UE throughput, network resource utilization and packet loss can be utilized for E2E latency analysis. To support E2E latency assurance in order to satisfy the latency requirements from the vertical users, MDAS producer is able to provide the analytics report as defined in 6.3.1.3.5 related with E2E latency analytics triggered by event or periodically. + +##### 6.3.1.3.2 Required data for latency analysis for RAN domain + +The management data required to analyze the latency are defined as the following table. + +| Input data | Data type | Description | +|-------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [13].<br>MDAS may derive network topology information according to S-NSSAI | +| Performance measurement | Measurement data | Packet delay: “packet delay” measurement as defined in clause 5.1.1.1, clause 5.1.3.3, TS 28.552 [8];<br><br>IP Latency measurements: “IP Latency measurements” as defined in clause 5.1.3.4, TS 28.552 [8];<br><br>UE throughput: The IP throughput of end users, see clause 5.1.1.3 of TS 28.552 [8];<br><br>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7];<br><br>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];<br><br>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[8];<br><br>CQI related measurements: the distribution of Wideband CQI (Channel Quality Indicator) reported by UEs in the cell, see clause 5.1.1.11 of TS 28.552 [8];<br><br>MCS related Measurements: the distribution of the MCS scheduled for PDSCH RB by NG-RAN, the distribution of the MCS scheduled for PUSCH RB by NG-RAN, see clause 5.1.1.12 in TS 28.552 [8]; | +| MDT Data | Measurement data | UE measurements related to RSRP, RSRQ, SINR and UE location information, see TS 37.320 [12]. | +| QoE Data | Measurement data | The details information of QoE data required by this case is FFS. | + +Note: The above parameters may not be the complete list. + +##### 6.3.1.3.3 Required data for latency analysis for CN domain + +The management data required to analyze the latency are defined as the following table. + +| Input data | Data type | Description | +|-------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [13].<br>MDAS may derive network topology information according to S-NSSAI | +| Performance measurement | Measurement data | Round-trip GTP Data Packet Delay: “Round-trip GTP Data Packet Delay” as defined in clause 5.4.1.9, TS 28.552 [8];<br><br>GTP packets delay in UPF: “GTP packets delay in UPF” as defined in clause 5.4.5, TS 28.552 [8];<br><br>Round-trip GTP Data Packet Delay on N9 interface: “Round-trip GTP Data Packet Delay on N9 interface” as defined in | + +| | | | +|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | clause 5.4.4.1, TS 28.552 [8];<br>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7]; | +|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +Note: The above parameters may not be the complete list. + +##### 6.3.1.3.4 Required data for E2E latency analysis for cross domain + +For cross domain analysis, the RAN and CN domain required data as described in 6.3.1.3.2 and 6.3.1.3.3 may be also needed, as well as the potential data described in the following table. + +| Input data | Data type | Description | +|-----------------------------------------------------------------------------------------------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [13]. MDAS may derive network topology information according to S-NSSAI | +| Performance measurement | Measurement data | End-to-end Latency of 5G Network: “End-to-end Latency of 5G Network” as defined in clause 6.3.1, TS 28.554 [7];<br>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7]; | +| QoE Data | Measurement data | The details information of QoE data required by this case is FFS. | +| “Required data for latency analysis for RAN domain” or RAN domain “Analytics report for latency analysis” | Measurement data and/or analytical data | Raw data in “6.3.1.3.2 Required data for latency analysis for RAN domain”, or analytical data of RAN domain in “6.3.1.3.5 Analytics report for latency analysis” | +| “Required data for latency analysis for CN domain” or CN domain “Analytics report for latency analysis” | Measurement data and/or analytical data | Raw data in “6.3.1.3.3 Required data for latency analysis for CN domain”, or analytical data of CN domain in “6.3.1.3.5 Analytics report for latency analysis” | + +Note: The above parameters may not be the complete list. + +##### 6.3.1.3.5 Analytics report for latency analysis + +Following table shows the potential information of the domain specific or cross domain E2E analytics report for latency analysis based on the required data received as described in 6.3.4.3.2, 6.3.4.3.3 and 6.3.4.3.4. + +| Analytics Report of E2E latency analysis | Attribute Name | Description | +|------------------------------------------|--------------------------------|----------------------------------------------------------| +| | SLS assurance issue Identifier | The identifier indicates the SLS assurance issue | +| | Indication of SLS | Indicates the type of the SLS assurance issue, e.g., RAN | + +| | | | +|--|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| | assurance issue type | latency issue, CN latency issue, TN latency issue. | +| | Location | The geographical area and location where the latency issue exists | +| | Start time | The start time of the latency issue | +| | Stop time | The stop time of the latency issue | +| | Root cause | The root cause of the E2E latency degradation, e.g. coverage issue, load issue in RAN, load issue in CN, low throughput in RAN, low throughput in CN etc. | +| | Affected objects | The MOIs of cells, subnetwork or network slices affected by the latency issue; | +| | Severity level | The severity level (e.g., critical, medium, not important) of the latency issue; | +| | Recommended actions | The recommended actions to solve the latency issue, e.g., resource radio resources re-allocation in gNB, scaling the VNF. | + +Editor's Note: Quantification of severity levels is FFS. + +### 6.3.2 Network slice load analysis + +#### 6.3.2.1 Use case + +Network slice load may vary over time. Therefore, network resources allocated initially could not always satisfy the traffic requirements, for example, the network slice may be overloaded or underutilized. Various factors may impact the network slice load, e.g. number of UEs accessing the network, number of PDU sessions, service types and the end users distribution. Overload of signalling in control plane and/or user data congestion in user plane will lead underperforming network. Besides, allocating excessive resources for network slice with light load will decrease resource efficiency. + +The analysis of network slice load should consider the load of services with different characteristics (e.g., QoS information, service priority), load distribution to derive the corresponding resource requirements. Load level and detailed load distribution analytic result may be provided, e.g. load distribution for different applications (probably coming from respective AFs), different frequency layers, different RATs, different locations and/or time periods, different NFs etc. Proportion of high loaded/light loaded cells, NSSI, NFs etc can also be provided. + +The analysis of network slice load should consider the network slice capacity, so that the number of users and the numbers of PDU sessions setup can be further supported by certain network slice could be analysed and predicted. + +"*maxNumberOfUEs*" and "*maxNumberOfConns*" are two capacity related requirements in the ServiceProfile in [20]. In addition, from end to end network slice perspective, the capacity related requirements and the actual network performance measurements also help to reflect the slice load and slice capacity headroom. + +Traffics and resources related performance measurements and UE measurements can be utilized by MDAS producer to identify degradation of the performance measurements and KPI documented in an SLS due to load issues and provide the analytic reports of load analysis. For example, the analytic report for a RAN NSSI, slice load related information may include load of DRBs and SRBs, radio resource utilization and availability, virtual resources of RAN CU, etc. MDAS may provide statistic or predictive results of the above load related information and their correlations for multiple cells in certain coverage areas and time periods. MDAS may further provide recommendations of slice RRM Policy ratio for the analysed cells. In addition, MDAS may utilize the analytical data of slice load analysis (as appropriate), NF load analysis, UE mobility statistics/predictions and UE communication statistics/predictions from NWDCAF [18] to assist its network slice load analysis. The producer of MDAS is able to, from the perspective of the management aspects, provide the network slice load analytics report related to an NSI, a specific RAN NSSI, a specific CN NSSI. This analytics report can be considered as an input to support SLA assurance to perform further evaluation. + +#### 6.3.2.2 Potential requirements + +**REQ-NS\_LOAD\_ANA-1:** MDAS producer shall have the capability to provide analytics report describing the network slice load problem. + +**REQ-NS\_LOAD\_ANA-2:** MDAS producer shall have the capability to analyse and predict the network slice load based on the slice capacity including the number of users and the numbers of PDU sessions setup supported by certain network slice. + +**REQ-NS\_LOAD\_ANA-3:** The analytics report describing the network slice load problem should include the following information: + +- The identifier of the network slice load problem; +- Indication of the network slice load problem; +- The start time and end time of the network slice load problem; +- The type of network slice load problem (overloaded or underutilized); +- The geographical area, location (UE, gNB, or UPF), domain (RAN, CN) where the network slice load problem exists; +- The cause(es) of network slice problem (e.g., number of UEs accessing the network, number of PDU sessions, service types and the end user's distribution); +- Root cause of the network slice load problem; +- The applications affected by the network slice load problem +- The severity level of the network slice load problem; +- The recommended actions to solve the network slice load problem. + +#### 6.3.2.3 Possible solutions + +##### 6.3.2.3.1 Solution description + +The MDAS producer correlates and analyzes the ongoing and/or potential network slice load problem based on the current and historical performance data related to resource usage and network traffic for the target network slice. The slice load is a comprehensive result. Various factors may impact the network slice load, e.g. number of UEs accessing the network, number of QoS flows, the resource utilizations of different NFs which is related with the network slice instance. The analysis of network slice load should consider the load of services with different characteristics (e.g., QoS information, service priority), load distribution to derive the corresponding resource requirements. To identify degradation of the KPIs documented in an SLS due to load issues, traffics and resources related performance measurements and UE measurements can be utilized. Note that this solution covers both domain specific and cross-domain load problem analysis scenarios. Based on the analysis above, the MDAS producer is able to provide the analytics report as defined in 6.3.2.3.5 related with the network slice load analytics triggered by event or periodically. + +##### 6.3.2.3.2 Required data for network slice load analysis for cross domain + +For cross domain analysis, the RAN and CN domain required data as described in 6.3.2.3.3 and 6.3.2.3.4 may be also needed, as well as the potential data described in the following table. + +| Input data | Data type | Description | +|-------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [2]. MDAS uses this information to identify target network slices for network slice load analytics and may derive network topology information according to S-NSSAI. | +| Performance measurement | Measurement data | End-to-end Latency of 5G Network: “End-to-end Latency of 5G Network” as defined in clause 6.3.1, TS 28.554 [4];<br>UE throughput: The IP throughput of end users, see clause | + +| | | | +|------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | 5.1.1.3 of TS 28.552 [3];<br><br>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [4];<br><br>Virtualised resource utilization of Network Slice Instance, see clause 6.4.2 of TS 28.554 [4] | +| MDT Data | Measurement data | UE measurements related to RSRP, RSRQ, SINR and UE location information, see TS 37.320 [12]. | +| Capacity planning data | Use case and procedures | Capacity management use case and procedure, see clause 5.4.15 of TS28.530 [5] and clause 7.15 of TS28.531[6]. | +| Network topology | Network topology data | The topology of the network for network slice load analytics. | + +Note: The above parameters may not be the complete list. + +##### 6.3.2.3.3 Required data for network slice load for RAN domain + +The management data required to analyze the network slice load for RAN domain are defined as the following table. + +| Input data | Data type | Description | +|-------------------------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [2]. MDAS uses this information to identify target network slices for network slice load analytics and may derive network topology information according to S-NSSAI. | +| Performance measurement | Measurement data | RAN domain measurement data:<br><br>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [4];<br><br>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[3];<br><br>Performance measurement data for gNB as defined in clause 5.1 of TS 28.552 [3]; | +| MDT Data | Measurement data | UE measurements related to RSRP, RSRQ, SINR and UE location information, see TS 37.320 [12]. | +| Capacity planning data | Use case and procedures | Capacity management use case and procedure, see clause 5.4.15 of TS28.530 [5] and clause 7.15 of TS28.531[6]. | +| Network topology | Network topology data | The topology of the network for network slice load analytics. | + +Note: The above parameters may not be the complete list. + +##### 6.3.2.3.4 Required data for network slice load for CN domain + +The management data required to analyze the network slice load for CN domain are defined as the following table. + +| Input data | Data type | Description | +|------------|--------------|-------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [2]. | + +| | | | +|-------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | MDAS uses this information to identify target network slices for network slice load analytics and may derive network topology information according to S-NSSAI. | +| Performance measurement | Measurement data | <p>CN domain measurement data</p> <p>User subscription data by performance measurement for AMF as defined in clause 5.2 of TS 28.552 [3];</p> <p>Performance measurement data for SMF as defined in clause 5.3 of TS 28.552 [3];</p> <p>Performance measurement data for UPF as defined in clause 5.4 of TS 28.552 [3];</p> <p>Performance measurement data for NF as defined in clause 5.7 of TS 28.552 [3];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [4];</p> | +| Capacity planning data | Use case and procedures | Capacity management use case and procedure, see clause 5.4.15 of TS28.530 [5] and clause 7.15 of TS28.531[6]. | +| Network topology | Network topology data | The topology of the network for network slice load analytics. | + +Note: The above parameters may not be the complete list. + +##### 6.3.2.3.5 Analytics report for network slice load analysis + +Following table provides the potential information of the domain specific or cross domain analytics report for network slice load analysis based on the required data received as described in 6.3.2.3.2, 6.3.2.3.3 and 6.3.2.3.4. + +| Analytics Report of resource utilization analysis | Attribute Name | Description | +|---------------------------------------------------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Network slice load problem identifier | The identifier indicates the network slice load problem | +| | Type of network slice load problem | Indicates the type of the network slice load problem, e.g., ongoing/potential or overload/underutilized network slice load problem | +| | Time period | Describes the time period(s) during which the network slice load problem has happened or is going to happen | +| | Slice load level and distribution | Describes the detailed load distribution e.g., load distribution for different applications (probably coming from respective AFs), different frequency layers, different RATs, different locations and/or time periods, different NFs etc. | +| | Slice load information | Describes the load of the following resources in the network slice: DRBs and SRBs, radio resource utilization and availability, virtual resources of RAN CU, etc | +| | Slice load statistics | Describes the load statistics of the above resources and their correlated results in terms of coverage and time periods | +| | Slice load predictive results | Describes the load predictive results of the above resources and their correlations in terms of coverage and time periods | + +| | | | +|--|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| | Indication of network slice load demand | “Indicates, for each time period, that the network slice is overutilized (load is too high) or underutilized (load is too low) | +| | Percentage of network slice load demand | Describes how much of the slice load capacity is either overloaded or underutilized in each time period | +| | List of network entities | Lists the network entities involved in the network slice load problem | +| | Recommended actions | Describes the recommended actions to solve the network slice load problem | + +### 6.3.3 Service experience analysis + +#### 6.3.3.1 Use case + +In 5G network, the variety of the services provided to the verticals is an important feature. The network requirements which support different services may vary a lot. For example, the users who require URLLC service have high requirements on the network latency and reliability, while the users who require NB-IoT service considers the maximum access UE numbers as the first priority for network requirement. The analysis of service experience of different vertical consumers is important to support the SLA assurance from the network aspect. + +The UE level's experience analysis based on the information from AF provided by NWDAF, e.g., the service MOS may be utilized by MDAS producer as one of the service performance inputs. The network performance measurements from RAN, e.g., the UE IP throughput, coverage, latency, successful handover ratio, etc. and network performance measurements from core network could also be used by MDAS producer for the analysis of service fulfilment by the network. Resource utilization efficiency may impact the user quality of service experience as described in clause 6.2.2. The analytics information from combining the user quality of service experience and, network performance and network resource utilisation analysis could be made available to operators or verticals for further action and analysis. For example, root cause for service deteriorating and recommendation actions may be provided by MDAS producer if some of the SLA requirements cannot be achieved, operators could perform the network optimization actions when needed. The MDAS producer may also coordinate with other management services producer to perform close loop SLA assurance of the network under the operator configured policies. + +#### 6.3.3.2 Potential requirements + +**REQ-Ser\_Exp\_CON-1** The MDAS producer should have a capability to provide the analytics report on service experience analysis + +**REQ- Ser\_Exp\_CON-2** The analytics report describing the service experience should contain the following information describing the service experience aspects and potentially future prediction: + +- The predictive service experience or observed service experience statistics, may split into subcounters in different levels, e.g. per S-NSSAI, per 5QI, per UE etc; +- Service experience indication and root cause analysis; + +#### 6.3.6.3 Possible solutions + +##### 6.3.6.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to provide service experience analysis and identify the root cause. As the table in 6.3.6.3.3 shows, the analytics report is able to be provided by the MDAS producer to describe the service experience issue, root causes and recommendations. This procedure may be triggered by the request or periodically. + +##### 6.3.6.3.2 Data required for service experience analysis + +Following table shows the potential data required to analyse the service experience analysis. + +| Data Category | Required Data | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>Packet delay: The average and distribution of DL/UL packet delay between UPF and UE, see clause 5.4.9 of TS 28.552[8]</p> <p>UE throughput: Average and distribution of DL/UL UE throughput in gNB, see clause 5.1.1.3 of TS 28.552[8];</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7].</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> | +| MDT Data | UE measurements related to RSRP, RSRQ, SINR, packet delay and UE location information. | +| QoE Data | <p>The details information of QoE data required by this case is FFS.</p> <p>The App data which shows the end user experience.</p> | +| Analytics Data | <p>NWDAF analytical data: Slice QoE, see clause 6.3 of TS 23.288 [18]</p> <p>NWDAF analytical data: Observed Service Experience and/or observed Service MoS, see clause 6.4 of TS 23.288 [18]</p> | + +Note: The above parameters may not be the complete list. + +##### 6.3.6.3.3 Analytics report for service experience analysis + +Following table shows the potential information of the domain specific or cross domain analytics report for service experience analysis based on the required data received as described in 6.3.6.3.2. + +| Analytics Report of service experience | Attribute Name | Description | +|----------------------------------------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Service experience identifier | The identifier indicates the analytics report is related with service experience analysis. | +| | Managed Objects of service experience | The object instances where the service experience is applicable, e.g., SubNetwork Instance, NetworkSlice Instance, S-NSSAI. | +| | Service experience level | The level of service experience, e.g. there are five levels which represented by 1, 2, 3, 4, 5 where level 1 represents the users are endures bad experience while level 5 represent the users requirements are perfectly satisfied. | +| | Info of service experience | Statistics or predictions of the service experience, may be analysed in different levels, e.g. per S-NSSAI, per network slice, per network slice subnet, per 5QI, per UE etc. | +| | Root cause | The root cause of the service experience issues, e.g., unstable handover successful rate, high latency, low QoS retainability etc. | + +### 6.3.4 Network slice throughput analysis + +#### 6.3.4.1 Use case + +Throughput is of great importance which represents the end users' experiences and also reflects the network problems, e.g., low UE throughput may be caused by the resource shortage. + +In order to satisfy the requirements of *dL/ulThptPerSlice* in the *ServiceProfile*, MDAS may be utilized for throughput related analysis/predictions for, network slice instance. The related performance measurements in 28.552 [2] and KPIs in 28.554 [3] are utilized as the input data for analysis. + +MDAS producer should have the capability to detect potential throughput issues and identify the root cause to assist throughput assurance. Network slice throughput analysis can be for a specific domain or for cross-domain. It is expected that 3GPP Cross Domain MDAS producer provides the federated throughput analytics report and Domain MDAS producer provides the domain specific throughput analysis. These two levels of MDAS producers worked in a coordinated way to assure the throughput performance. + +The CSC concerns the statistics or predictions of subscribers' DL/UL throughput for the network slice, e.g. average percentage of users, for which the required SLS throughput is met or the average percentage of time, during which the required SLS throughput is, or could be, met. The 3GPP Cross Domain MDAS producer may indicate whether the problem is caused by NG-RAN or CN. In general, NG-RAN is the bottleneck because of the limited radio resources and complicated wireless radio conditions. In this case, resource reconfigurations may be needed to resolve the throughput degradation issue. To identify the root causes, RAN Domain MDAS Producer may collect radio resource related configurations and measurements, radio condition related measurements and throughput related measurements. + +The producer of MDAS is able to, from the perspective of the management aspects, provide the network slice throughput analytics report. This analytics report can be considered as an input to support SLS assurance to perform further evaluation. + +#### 6.3.4.2 Potential requirements + +**REQ-THP\_CON-1** The MDAS producer should have a capability to provide the analytics report on network slice throughput. + +**REQ-THP\_CON-2** The analytics report of the network slice throughput should contain the following information: + +- Network slice throughput statistics/predictions; +- Root cause analysis of network slice throughput degradation; + +#### 6.3.4.3 Possible solutions + +##### 6.3.4.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to provide network slice throughput statistics/predictions, identification of throughput degradation issues and the root cause as the table in 6.3.4.3.5 shows. This procedure may be triggered by the request or periodically. + +##### 6.3.4.3.2 Data required for network slice throughput statistics/predictions for RAN domain + +Following table shows the potential data required to analyse the network slice throughput for RAN domain. + +| Data Category | Required Data | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | Packet Delay, see clause 5.1.1.1.1 in TS 28.552 [8];<br>UE throughput, see clause 5.1.1.3 of TS 28.554 [7];<br>RAN UE throughput, KPI shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7];<br>Throughput at N3 interface, Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of | + +| | | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | TS 28.554 [7];<br>Radio resource utilization, the usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[8]. | +| MDT Data | UE measurements related to RSRP, RSRQ, SINR and UE location information. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. The data comes from the provisioning MnS provider, e.g., the configured ServiceProfile. | + +Note: The above parameters may not be the complete list. + +##### 6.3.4.3.3 Data required for network slice throughput statistics/predictions for CN domain + +Following table shows the potential data required to analyse the network slice throughput for CN domain. + +| Data Category | Required Data | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | Throughput at N3 interface, Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];<br>Number of incoming/outgoing GTP data packets on the N3 interface, see clause 5.4.1.1 and 5.4.1.2 of TS 28.552 [8].<br>Number of octets of incoming/outgoing GTP data packets on the N3 interface, see clause 5.4.1.3 and 5.4.1.4 of TS 28.552 [8].<br>Virtualised resource usage measurement, see clause 6.2 of TS 28.552 [8]. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. The data comes from the provisioning MnS provider, e.g., the configured ServiceProfile. | + +Note: The above parameters may not be the complete list. + +##### 6.3.4.3.4 Data required for network slice throughput statistics/predictions for cross domain + +For cross domain analysis, the RAN and CN domain required data as described in 6.3.4.3.2 and 6.3.4.3.3 may be also needed, as well as the potential data described in the following table. + +| Data Category | Required Data | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | Latency of 5G Network, see clause 6.3.1 of TS 28.554 [7];<br>Throughput for network slice instance, see clause 6.3.2 of TS 28.554 [7];<br>Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.3 of TS 28.554 [7]. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. The data comes from the provisioning MnS provider, e.g., the configured ServiceProfile. | + +Note: The above parameters may not be the complete list. + +##### 6.3.4.3.5 Analytics report for network slice throughput analysis + +Following table shows the potential information of the domain specific or cross domain analytics report for network slice throughput analysis based on the required data received as described in 6.3.4.3.2, 6.3.4.3.3 and 6.3.4.3.4. + +| <b>Analytics Report of network slice throughput</b> | <b>Attribute Name</b> | <b>Description</b> | +|-----------------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Network slice throughput issue identifier | The identifier of the network slice throughput issues; | +| | Network slice throughput statistics/predictions | Average percentage of users, for which the required SLS throughput is, or could be, met.<br>Average percentage of time, during which the required SLS throughput is, or could be, met. | +| | Root cause | The root cause of the network slice throughput degradation issues, e.g. PRB resource shortage; | +| | Recommended actions | The recommend actions to solve the network slice throughput degradation issues. | + +### 6.3.5 Uplink/downlink throughput per UE in network slice analysis + +#### 6.3.5.1 Use case + +Uplink/downlink throughput per UE in network slice is one of the SLA parameters. Data rate in uplink and downlink should be guaranteed to assure quality experience of UE using specific network slice. + +UE uplink/downlink throughput could be impacted by the network capability and network configurations, e.g. configuration of service priority, RAN capacity, network load, number of UE in one TA, Wireless channel environment and the processing time of the network functions, etc. These factors may be the root cause if the UE uplink/downlink throughput requirements cannot be achieved. There are some mechanisms to assure UE uplink/downlink throughput, e.g. to upgrade the service priority, allocate or reserve more network resource. + +From the management perspective, resource configuration and allocation algorithms or policies should support UE uplink/downlink throughput assurance. MDAS can be utilized to provide UE uplink/downlink throughput analysis to support SLS assurance. + +#### 6.3.5.2 Potential requirements + +**REQ-UETHROUGHPUT\_ASS-CON-1:** MDAS producer shall have the capability to provide analytics report describing the UE uplink/downlink throughput problem. + +**REQ-UETHROUGHPUT\_ASS-CON-2:** The analytics report describing the UE uplink/downlink throughput problem should include the following information: + +- The identifier of the UE uplink/downlink throughput issue; +- Indication of UE uplink/downlink throughput issue type; +- The start time and end time of the UE uplink/downlink throughput issue; +- The geographical area and location where the UE uplink/downlink throughput issue exists; +- Root cause of the UE uplink/downlink throughput issue; +- The objects affected by the UE uplink/downlink throughput issue; +- The severity level of the UE uplink/downlink throughput issue; +- The recommended actions to solve the UE uplink/downlink throughput issue. + +#### 6.3.5.3 Possible solutions + +##### 6.3.5.3.1 Solution description + +The performance measurements, e.g., UE throughput, network resource utilization can be utilized for UE uplink/downlink throughput analysis. To support UE uplink/downlink throughput assurance in order to satisfy the throughput per UE requirements from the vertical users, MDAS producer is able to provide the analytics report as defined in 6.3.5.3.3 related with UE uplink/downlink throughput analytics triggered by event or periodically. + +##### 6.3.5.3.2 Required data for UE uplink/downlink throughput analysis + +The management data required to analyze the UE uplink/downlink throughput are defined as the following table. + +| Input data | Data type | Description | +|-------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-NSSAI | Service data | “S-NSSAI” as defined in clause 5.15.2, TS 23.501 [13]. MDAS may derive network topology information according to S-NSSAI | +| Performance measurement | Measurement data | <p>UE throughput: The IP throughput of end users, see clause 5.1.1.3 of TS 28.552 [8];</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7];</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];</p> <p>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[8];</p> <p>CQI related measurements: the distribution of Wideband CQI (Channel Quality Indicator) reported by UEs in the cell, see clause 5.1.1.11 of TS 28.552 [8];</p> <p>MCS related Measurements: the distribution of the MCS scheduled for PDSCH RB by NG-RAN, the distribution of the MCS scheduled for PUSCH RB by NG-RAN, see clause 5.1.1.12 in TS 28.552 [8];</p> | +| MDT Data | Measurement data | UE measurements related to RSRP, RSRQ, SINR and UE location information, see TS 37.320 [12]. | + +Note: The above parameters may not be the complete list. + +##### 6.3.5.3.3 Analytics report for UE uplink/downlink throughput analysis + +Following table provides the potential contents of the analytics report of UE uplink/downlink throughput analysis. + +| Analytics Report of UE uplink/downlink throughput analysis | Attribute Name | Description | +|------------------------------------------------------------|----------------------------------------|------------------------------------------------------| +| | SLS assurance issue Identifier | The identifier indicates the SLS assurance issue | +| | Indication of SLS assurance issue type | Indicates the type of the SLS assurance issue, e.g., | + +| | | | +|--|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Location | The geographical area and location where the UE uplink/downlink throughput issue exists | +| | Start time | The start time of the UE uplink/downlink throughput issue | +| | Stop time | The stop time of the UE uplink/downlink throughput issue | +| | Root cause | The root cause of the UE uplink/downlink throughput degradation, e.g. coverage issue, load issue in RAN, load issue in CN, low throughput in RAN, low throughput in CN etc. | +| | Affected objects | The MOIs of cells, subnetwork or network slices affected by the UE uplink/downlink throughput issue; | +| | Severity level | The severity level (e.g., critical, medium, not important) of the UE uplink/downlink throughput issue; | +| | Recommended actions | The recommended actions to solve the UE uplink/downlink throughput issue, e.g., | + +**Editor's Note:** Quantification of severity levels is FFS. + +### 6.3.6 KPI anomaly analysis + +#### 6.3.6.1 Use case + +KPI(s) are of great importance for network operators to monitor the key performance of the network. For 5G and beyond, a large amount of KPIs are defined in TS 28.554 [7]. The correlations between different KPIs are complicated and it is hard to monitor the KPI(s) manually. Also, how to assign each KPI threshold is a big challenge for network operators, since each KPI threshold should not be a fixed value considering many factors such as network capacity, service types, end user's experiences, etc. In addition, the criteria to determine whether a KPI is anomalous also depends on a variety of requirements. + +MDAS is expected to have the capability to analyze KPI(s) for both cross domain and single domain. 3GPP Cross Domain MDAS producers may coordinate with domain MDAS producer to identify the anomalous KPI(s) and the corresponding root cause(s). The KPI anomaly analysis should consider both a single KPI and KPI correlations of different domains. For cross domain KPI anomaly analysis, KPIs or KPI analytical report from each domain should be collected. The MDAS producer should also be able to identify anomalous network situations. A network situation can be characterized as a combination of KPIs with respect to a predefined context that includes time, location, amount of traffic, user characteristics, etc. + +MDAS is also expected to have the capability to detect and predict the anomalous KPI(s) and anomalous network situations in different levels e.g. per S-NSSAI, per NSI or per NSSI, etc. The detection and prediction of single KPI anomaly and in relation with multiple correlated KPIs anomaly may be involved. The detection and prediction may also involve a single or multiple KPIs in relation with a network situation. By utilizing Machine learning technology, historical KPI data and performance data may also be used as the input to perform the ML model training. Besides, along with the KPI or network situation anomaly identification and root cause analysis, MDAS may also recommend more appropriate network configurations to optimize and resolve the KPI anomaly issue and improve the slice QoE. + +The KPI anomaly analysis is also expected to have the capability to analyse the correlations between SLS and KPIs or network situations according to service model and identify the most relevant anomalous KPIs and network situations, which cause the SLS degradation, this corresponding analytics report can be considered as an input to support further SLS assurance. + +#### 6.3.6.2 Potential requirements + +**REQ-KPI\_ANOMALY\_CON-1** The MDAS producer should have a capability to provide the analytics report on KPIs anomaly analysis. + +**REQ-KPI\_ANOMALY\_CON-2** The analytics report describing the KPIs anomaly should contain the following information describing the KPI anomaly aspects and potentially future prediction: + +- The predictive anomaly KPI(s) or observed anomaly KPI(s), may split into subcounters in different levels, e.g. per S-NSSAI, per NSI, per NSSI, per 5QI, per UE etc; +- KPI anomaly indication and root cause analysis; +- Cross domain and domain KPI anomaly analysis; +- The recommendations for the configurations of network resource and KPI threshold. + +**REQ- KPI\_ANOMALY\_CON-3** The MDAS producer should have a capability to provide the analytics report that identifies a possible anomalous KPIs with respect to network situations for a particular network location and network. + +#### 6.3.6.3 Possible solutions + +##### 6.3.6.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to provide KPI anomaly analysis and identify the root cause. The required data can be from RAN domain or CN domain or both. As the table in 6.3.6.3.4 shows, the analytics report is able to be provided by the MDAS producer to describe the KPI anomaly issue, root causes and recommendations. This procedure may be triggered upon request or periodically. + +##### 6.3.6.3.2 Data required for KPI anomaly analysis for RAN domain + +Following table shows the potential data required to analyse the RAN domain KPI anomaly. + +| Data Category | Required Data | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[8];</p> <p>Performance Measurements for gNB: for example, for RRC connection related KPI anomaly analysis, see clause 5.1, TS 28.552[8], e.g., RRC connection number, RRC connection establishment, RRC connection re-establishment, RRC connection resuming;</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7].</p> | +| MDT Data | UE measurements related to RSRP, RSRQ, SINR and UE location information. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration data | The execution data including the changes or the configuration of the MOIs. | +| Context data | The information on the conditions applicable to the data considered for analytics, e.g. time of day, season or event in relation to location. | + +Note: The above parameters may not be the complete list. + +##### 6.3.6.3.3 Data required for KPI anomaly analysis for CN domain + +Following table shows the potential data required to analyse the CN domain KPI anomaly. + +| Data Category | Required Data | +|---------------|---------------| +|---------------|---------------| + +| | | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>Performance Measurements for AMF: for example, for number of registered subscribers related KPI anomaly analysis, see clause 5.2.1, TS 28.552[8];</p> <p>Performance Measurements for SMF: for example, for PDU session management related KPI anomaly analysis, see clause 5.3.1, TS 28.552[8];</p> <p>Throughput at N3 interface: KPI related to Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];</p> | +| QoE Data | The details information of QoE data required by this case is FFS. | + +Note: The above parameters may not be the complete list. + +##### 6.3.6.3.4 Data required for KPI anomaly analysis for cross domain + +For cross domain analysis, the RAN domain and CN domain required data as described in 6.3.6.3.2 and 6.3.6.3.3 may be needed, as well as the potential data described in the following table. + +| Data Category | Required Data | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> <p>NWDAF analytical data: Slice QoE, see clause 6.4 of TS 23.288 [18].</p> | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration data | The execution data including the changes or the configuration of the MOIs. | +| Context data | The information on the conditions applicable to the data considered for analytics, e.g. time of day, season or event in relation to location. | + +Note: The above parameters may not be the complete list. + +##### 6.3.6.3.5 Analytics report for KPI anomaly analysis + +Following table shows the potential information of the domain specific or cross domain analytics report for KPI anomaly analysis based on the required data received as described in 6.3.6.3.2, 6.3.6.3.3 and 6.3.6.3.4. + +| Analytics Report of network slice KPI anomaly | Attribute Name | Description | +|-----------------------------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | KPI anomaly identifier | The identifier of the KPI anomaly; | +| | Anomalous KPI Name | The name of the KPI(s) which is identified or predicted as anomalous, the KPI name refers to bullet a) in TS28.554 (7); | +| | Managed Objects of anomalous KPI | The object instances where the KPI is applicable, e.g., SubNetwork Instance, NetworkSlice Instance | +| | Info of KPI anomaly | Statistics or predictions of the anomalous KPIs, may concern single KPI or multiple correlated KPIs, and may split into subcounters at different levels, e.g. per S-NSSAI, per NSI, per NSSI, per 5QI, per UE etc. | + +| | | | +|--|------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| | Root cause | The root cause of the network slice KPI anomaly issues, e.g., unstable handover successful rate, low PRB utilization, low QoS retainability. | +|--|------------|----------------------------------------------------------------------------------------------------------------------------------------------| + +##### 6.3.6.3.6 Analytics report for network situation analysis + +Following table shows the potential information of the domain specific or cross domain analytics report based on the required data received as described in 6.3.6.3.2, 6.3.6.3.3, and 6.3.6.3.4. + +| <b>Analytics Report on network situations</b> | <b>Attribute Name</b> | <b>Description</b> | +|-----------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| <b>Analytics Report on network situations</b> | Network situation identifier | The identifier of the possible network situations-. | +| | Network situation description | The network performance, QoE and UE location and context data that describe a network situation-. | +| | Network situations anomaly status | The status of a network situation. This may be a simple binary function that indicates a normal or anomalous status. | +| | Severity level | Describes the degree of anomaly (low, medium, high). | +| | Location | Geographical location of anomalous network situations | +| | Managed Objects of network situation | The object instances, e.g., cell, carrier. | +| | Type of analytics | Statistics or predictions of the anomalous situation. | + +### 6.3.7 Jitter analysis + +#### 6.3.7.1 Use case + +In addition to E2E latency, some new network services have extra new demands for SLA parameters. In extreme business scenarios such a V2X and telemedicine, network jitter also needs to be satisfied. Jitter assurance with high certainty becomes a new dimension of end-to-end delay-sensitive service quality. + +The analysis of jitter does not cover the entire network, but the analysis should consider the whole process of data frame and also the definition of different network layers. It could be impacted by the configuration of clock synchronization, traffic forwarding, bandwidth reservation and latency etc. In some circumstances, it will also be affected by the external environment, which can only be resolved non-automatically. + +The performance measurements and measurements related to data forwarding mechanisms can be used by the MDAS producer to generate a jitter analysis report. For example, in some network node, one particular data flow can have bandwidth competition with normal data flow which causes high network jitter. The MDAS will first analyse the bandwidth resource and provide bandwidth reservation modification so that it can satisfy network performance requirement of this particular data flow. Jitter is also related to E2E latency parameter, the jitter analysis will then need to be cross-domain, e.g. RAN domain, core network domain transport network domain. The jitter analysis from the multiple domains may be combined to calculate the end-to-end jitter, which can be checked against end-to-end SLA requirements. The jitter analysis will reference the E2E analysis result to support SLS assurance. In case of excessive end-to-end jitter, the jitter analysis from each domain may be used to identify the likely source of problems. + +#### 6.3.7.2 Potential requirements + +**REQ-JITTER\_ASS-CON-1:** MDAS producer shall have the capability to provide analytics report describing the jitter problem. + +**REQ-JITTER\_ASS-CON-2:** The analytics report describing the jitter problem should include the following information: + +- The identifier of the jitter issue; +- Indication of jitter issue type; +- The start time and end time of the jitter issue; +- The geographical area and location where the jitter issue exists; +- Root cause of the jitter issue; +- The objects affected by the jitter issue; +- The severity level of the jitter issue; +- The recommended actions to solve the jitter issue. + +## 6.4 Fault management related issues + +### 6.4.1 Alarm incident analysis + +#### 6.4.1.1 Use case + +In 5G network, millions of alarms are generated due to the network complexity. Since the topological relations between different network elements and logical relations between different generated alarms, a series of alarms caused by a same root cause should be correlated with each other. In addition, the same root causes may give rise to the network performance deterioration. For example, an alarm in a lower layer of the communication protocol stack or an alarm related to virtualized resource in the virtualization deployment environment may cause multiple alarms in higher layers. Sequence of alarms may be generated in multiple domains along a communication link if one fault in the source domain occurs. + +Large amount of alarms brings difficulties in network operation and maintenance. Therefore, the alarms and deteriorated performance measurements of same root cause should be correlated and analysed. Some ML models and algorithms may be used to group or filter the correlated alarms and indicate the root cause. Also, the historical alarms, performance measurements and network topology data can be utilized as the foreknowledge. + +To improve the efficiency of network operation and maintenance, the MDAS producer is able to provide the analytics result including the root alarm or root cause by correlate and group the related alarms and performance measurements into an alarm incident. + +#### 6.4.1.2 Potential requirements + +**REQ-ALARM\_MDA-01:** The MDAS producer shall have a capability to provide the analytics report describing the alarm incident analysis. + +**REQ-ALARM\_MDA-02:** The analytics report describing the alarm incident should include the following information: + +- Alarm incident Identifier +- List of Correlated Alarms, performance measurements +- The start time and end time of the Alarm incident +- The root cause or root alarm of the Alarm incident +- Severity level +- Affected objects +- Recommended actions + +#### 6.4.1.3 Possible Solutions + +##### 6.4.1.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to identify the alarm incident. The required data can be from RAN domain or CN domain or both. As the table in 6.4.1.3.4 shows, the analytics report is able to be provided by the MDAS producer to describe the root causes and recommendations of identified alarm incident. It can be a domain specific or cross domain analytics report. This procedure may be triggered by the request or periodically. + +##### 6.4.1.3.2 Data required for alarm incident analysis for RAN domain + +Alarm data and performance measurements from correlated logical and physical resources are able to be utilized to perform the alarm incident analysis. The data listed in following table are the potential management data for RAN domain used to construct the alarm incident. + +Table 6.4.1.3.2-1: Potential data required for alarm incident analysis + +| Data Category | Required Data | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Alarm Data | <p>The alarm information, e.g., the alarm of NG-U, the alarm of radio frequency unit, the alarm of cell outage.</p> <p>The alarm information related to virtualized resource, see clause 8 of TS 28.545 [22].</p> <p>The types of alarms are FFS.</p> | +| Performance measurements | <p>The deteriorated performance or the abnormal performance measurements based on certain performance monitoring threshold. Following performance measurements may be used.</p> <p>UE throughput: The IP throughput of end users, see clause 5.1.1.3 of TS 28.552 [8];</p> <p>PDCP Data Volume: The transmitted PDCP data volume, see clause 5.1.2.1 and 5.1.3.6 of TS 28.552 [8];</p> <p>TB related measurements: The TB transmitted in a cell, see clause 5.1.1.7 of TS 28.552 [8];</p> <p>CQI related measurements: the distribution of Wideband CQI (Channel Quality Indicator) reported by UEs in the cell, see clause 5.1.1.11 of TS 28.552 [8];</p> <p>MCS related Measurements: the distribution of the MCS scheduled for PDSCH RB by NG-RAN, the distribution of the MCS scheduled for PUSCH RB by NG-RAN, see clause 5.1.1.12 in TS 28.552 [8];</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7];</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];</p> <p>Inter-gNB handovers: Number of requested/successful handover/failed handover preparations/resource</p> | + +| | | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | <p>allocations/executions, see clause 5.1.1.6.1 of TS 28.552 [8].</p> <p>Intra-gNB handovers: Number of requested/successful handover executions, see clause 5.1.1.6.2 of TS 28.552 [8].</p> <p>RRC connection establishment related measurements: Attempted/successful RRC connection establishments, see clause 5.1.1.15 of TS 28.552 [8].</p> <p>RRC connection Re-establishment and RRC connection Resuming related measurement, see clause 5.1.1.17 and 5.1.1.18 of TS 28.552 [8].</p> <p>Packet loss rate, Packet drop rate and Packet delay including the average delay and distribution of delay in CU-UP, F1-U, gNB-DU, CU-UP both of downlink and uplink.</p> <p>Virtualised resource usage measurement, see clause 6.2 of TS 28.552 [8].</p> | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. | +| Network topology | The topology of the network deployment. | + +**Editor's Notes:** The data above may not be the complete list for alarm incident detection, other types of management data may also be utilized. + +##### 6.4.1.3.3 Data required for alarm incident analysis for CN domain + +Alarm data and performance measurements from correlated logical and physical resources are able to be utilized to perform the alarm incident analysis. The data listed in following table are the potential management data for CN domain used to construct the alarm incident. + +Table 6.4.1.3.3-1: Potential data required for alarm incident analysis + +| Data Category | Required Data | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Alarm Data | <p>The alarm information, e.g., the alarm of AMF, the alarm of UPF.</p> <p>The types of alarms are FFS.</p> | +| Performance measurements | <p>The deteriorated performance or the abnormal performance measurements based on certain performance monitoring threshold. Following performance measurements may be used.</p> <p>Mobility related measurements for AMF: Number of requested/failed PDU sessions/QoS flows for inter-AMF handovers and number of attempted/successful/failed handover between 5GS and EPC, see clause 5.2.5.1, 5.2.5.3 and 5.2.5.4 of TS 28.552 [8].</p> <p>Session related measurements for SMF: Number of successful/failed PDU session creation and number of requested/successful/failed PDU session modifications, see clause 5.3.1 of TS 28.552 [8].</p> <p>QoS flow monitoring for SMF: Number of requested/successful/failed QoS flows to create/modify, see clause 5.3.2 of TS 28.552 [8].</p> <p>Session related measurements for UPF: Number of requested/failed N4 session establishments, see clause 5.4.3.1 of</p> | + +| | | +|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | <p>TS 28.552 [8].</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];</p> | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. | +| Network topology | The topology of the network deployment. | + +**Editor's Notes:** The data above may not be the complete list for alarm incident detection, other types of management data may also be utilized. + +##### 6.4.1.3.4 Analytics report for alarm incident analysis + +Following table provides the potential information of the domain specific or cross domain analytics report for alarm incident analysis based on the required data received as described in 6.4.1.3.2 and 6.4.1.3.3. + +| <b>Analytics Report of alarm incident</b> | <b>Information</b> | <b>Description</b> | +|-------------------------------------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Alarm Incident Identifier | The alarm incident id or name for correlated alarms and performance measurements, e.g., NgU transmission alarm incident, Xn transmission alarm incident. | +| | List of Correlated AlarmInfo | List of Alarm name or alarm ID, e.g., alarm of NgU setup, alarm of user plane link failure, alarm of user plane failure, alarm of cell outage. | +| | List of Correlated performance measurements info | Performance measurements and the corresponding value, e.g., NgU handover failure rate, NgU setup failure rate. | +| | Location | The geographical area or the cells where the alarm incident exists | +| | Start Time | The start time of alarm incident | +| | Stop Time | The end time of alarm incident | +| | Affected objects | The MOIs, e.g., the MOIs of cells or subnetworks or network slices affected by the alarm incident | +| | Root cause or Root alarm | Root alarm identified or predicted by root cause decision model, e.g. alarm of NgU setup, alarm of virtualized resource failure. | +| | Severity level | The severity level (e.g., critical, medium, not important) of the alarm incident | +| | Recommended actions | The recommended actions to clear the alarm incident. The recommended actions could be to replace the hardware unit, reconfigure the protocol, e.g., Xn application protocol | + +### 6.4.2 Fault prediction analysis + +#### 6.4.2.1 Use case + +In 5G network, millions of alarms are generated every day. The causes of these alarms are usually the faults or abnormal states of the network. The current treatment method is generally based on the alarm information analysis, to find out the cause of the faults or abnormal states, and then determine the fault repair method and solve the problems, so as to eliminate the alarms. Because the amount of alarms is so large, it is a big challenge to deal with these alarms in a timely and efficient manner. + +On the other hand, when we look at it the other way, if the network can be maintained very well so that it has fewer faults and abnormal states, then there will be fewer alarms. This requires the system to be able to predict the potential faults or abnormal states before they occur, and to recommend appropriate handling actions to prevent the fault or abnormal state really occur. In 5G network, MDAS is adopted, which is in conjunction with AI and ML techniques. The MDAS producer may train the ML model of the MDAS by using the historical alarms, performance measurements, configuration data and network topology information to obtain the basic health maintenance knowledges (e.g. the relationship between the faults or potential faults and the related maintenance actions). + +The MDAS producer monitors and analyses the performance measurements and KPIs continuously, and provides the analytics report which includes the predictive information of potential faults or abnormal states and corresponding recommendation of maintenance actions to prevent the fault or abnormal state really occur, so that the MDAS consumer can execute the recommended actions accordingly or by taking the recommended actions into account. + +The MDAS producer is informed when the recommended actions are taken by the MDAS consumer to maintain the network health, so that the MDAS producer can evaluate the result of the executed actions and update its basic health maintenance knowledges. + +The MDAS producer also periodically does the ML training based on the new collected alarms, performance measurements and KPIs, configuration data, and updates its basic health maintenance knowledges. + +#### 6.4.2.2 Potential requirements + +**REQ-HEALTH\_MDA-01:** The MDAS producer shall have a capability to provide the analytics report describing the fault prediction analysis results. + +**REQ-HEALTH\_MDA-02:** The analytics report describing the results from the fault prediction analysis should include the detailed advice on how to eliminate the cause of potential fault(s). + +Note: The detailed advice described in the fault prediction analytics report may include but not limited the follows: + +- List of potential faults and severity levels +- Affected objects +- Recommended actions + +#### 6.4.2.3 Possible solutions + +##### 6.4.2.3.1 Solution description + +The MDAS producer analyses the management data described in the following subclauses to identify the potential faults or abnormal states and corresponding recommended actions. The required data can be from RAN domain or CN domain or both. + +As the table in 6.4.2.3.4 shows, the analytics report is able to be provided by the MDAS producer to describe the analytics result and recommendations of network health maintenance. It can be a domain specific or cross domain analytics report. This procedure may be triggered by the request or periodically. + +##### 6.4.2.3.2 Data required for fault prediction analysis for RAN domain + +Following table shows the potential data required to perform the fault prediction analysis for RAN domain. + +| <b>Data Category</b> | <b>Required Data</b> | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | RAN related performance measurements and KPIs, see TS 28.552 [8] and TS 28.554[7];<br>The detailed types of performance measurements and KPIs are FFS | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. | +| Network topology | The topology of the network deployment. | + +Note: The above parameters may not be the complete list. + +##### 6.4.2.3.3 Data required for fault prediction analysis for CN domain + +Following table shows the potential data required to perform the fault prediction analysis for CN domain. + +| <b>Data Category</b> | <b>Required Data</b> | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | CN related performance measurements and KPIs, see TS 28.552 [8] and TS 28.554[7];<br>The detailed types of performance measurements and KPIs are FFS | +| Configuration Data | The execution data including the changes or the configuration of the MOIs. | +| Network topology | The topology of the network deployment. | + +Note: The above parameters may not be the complete list. + +##### 6.4.2.3.4 Analytics report for fault prediction analysis + +Following table shows the potential information carried in the analytics report of fault prediction analysis. + +| <b>Analytics Report of fault prediction</b> | <b>Attribute Name</b> | <b>Description</b> | +|---------------------------------------------|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Fault prediction analytics report identifier | The identifier of the fault prediction analytics report | +| | List of potential faults | List of potential faults, including:<br><ul style="list-style-type: none"> <li>- Fault type</li> <li>- Location</li> <li>- Severity level</li> <li>- Affected objects</li> </ul> | +| | Recommended actions | The recommend actions to eliminate the causes of the potential faults | + +Note: The above parameters carried in the analytics report may not be the complete list. + +## 6.5 Mobility management related issues + +### 6.5.1 Handover optimization + +#### 6.5.1.1 Use case + +Current handover procedures are mainly based on radio conditions for selecting the target gNB upon a handover. The target gNB accepts or rejects the handover (HO) request depending on various conditions. In virtualized environment, the HO may be rejected due to inadequate available resources within the target gNB. The notion of resources may include virtual resources (e.g., compute, memory) and/or radio resources (e.g., PRB, RRC connected users). If the HO request is rejected, a UE will try to connect to a different gNB until the request is successfully accepted. Several target gNBs can be tried until the request is successfully accepted. This process can result in wastage of UE and network resources, while it may also introduce service disruption due to increased latency and radio link failures (RLF). It also introduces inefficiency in the HO or other network procedures. + +To address this handover optimization issue, it is desirable to use MDAS (Management data analytic service) to provision and/or select a particular target gNB for handover in order to reduce or even avoid HO rejections. The MDAS producer provides a HO optimization analytics report containing the current and future/predicted resource consumption, resources capabilities and other KPIs' status for the available target gNB(s). The analytics report also provides recommended actions to optimize the target gNB for handover. This may include resource re-configuration or the updated selection criteria for target gNB. Based on the report, the MDAS consumer adjusts (e.g., scale-out/up the virtual resource, re-schedule/optimize radio resource) the resources before continuing with the handover and/or adjusts the selection criteria of the target gNB by also considering the overlapping coverages of inter-frequency and inter-RAT deployments. + +#### 6.5.1.2 Potential requirements + +**REQ-HO\_OPT\_CON-1** The MDAS producer should have a capability to provide the analytics report describing the resource consumption to authorized consumers based on the current and future virtual resource consumption of gNB. + +**REQ-HO\_OPT\_CON-2** The MDAS producer should have a capability to provide the analytics report describing the resource consumption to authorized consumers based on the current and future radio resource consumption of gNB. + +**REQ-HO\_OPT\_CON-3** The analytics report describing the resource consumption should contain the following information describing the current and future resource consumption: + +- Assigned virtual, radio, and transport resources for target gNB. +- Consumed virtual, radio, and transport resources for target gNB. +- Projected virtual, radio and transport resource usage in near future for target gNB. +- Indication on whether the target gNB is optimal for handover. +- Recommended action to optimize the target gNB and/or the selection of the target gNB for handover. + +**REQ-HO\_OPT\_CON-4** The MDAS producer should have a capability to provide an analytics report indicating a selection priority for the target cell, among a set of candidate inter-frequency cells. + +**REQ-HO\_OPT\_CON-5** The MDAS producer should have a capability to provide an analytics report indicating a list of target cells to spare, i.e. avoid, a handover for an indicated time period. + +**REQ-HO\_OPT\_CON-6** The analytics report describing inter-frequency target cell selection for handover may provide information for provisioning or selecting a target gNB with respect to a specific service or slice, if the same Network Slice Instance (NSI) is available in both the current and target gNB. + +**REQ-HO\_OPT\_CON-7** The analytics report describing inter-frequency target cell selection for handover should provide indication of current and expected QoE (for the UE) at the current and target gNB. + +#### 6.5.1.3 Possible solutions + +##### 6.5.1.3.1 Solution description + +The solution considers resource consumption both in terms of virtual and radio resource for the target gNB. The current resource consumption is analysed with the future/predicative resource consumption to decide if the target gNB is optimal for handover or not. + +The MDAS producer can correlate and analyze the ongoing and/or potential handover optimization issues based on the current and historical performance data related to handover performance considering intra-gNB and inter-gNB handover measurements as well as other performance measurements including network load, E2E latency, retainability and radio conditions, UE measurements including MDT, location and QoE for the network or network slices. The MDAS producer can provide the analytics report as defined in Clause 6.5.1.3.3 related with resource utilization analytics triggered by an event or periodically. + +##### 6.5.1.3.2 Data required + +The following data is required to do the required analysis. + +Table 6.5.1.3.2-1: Potential data required for handover optimization + +| Data category | Required data | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>Average/distribution of UE reported RSRPs/RSRQs/SINRs of each neighbour cell;</p> <p>Packet delay related to neighbour cells as defined in clause 5.1.1.1/5.1.3.3, TS 28.552 [8];</p> <p>IP Latency to neighbour cells as defined in clause 5.1.3.4, TS 28.552 [8];</p> <p>Round-trip GTP Data Packet Delay to neighbour cells as defined in clause 5.4.1.9, TS 28.552 [8];</p> <p>End-to-end Latency of 5G Network to neighbour cells as defined in clause 6.3.1, TS 28.554 [7];</p> <p>CQI related measurements: The distribution of Wideband CQI reported by UEs, clause 5.1.1.11 of TS 28.552 [8];</p> <p>Intra-gNB handovers: Number of failed handovers in terms of handover preparation/resource allocation/execution and the mean time of handover execution, clause 5.1.1.6 of TS 28.552 [8];</p> <p>Inter-gNB handovers: Number of failed handovers in terms of handover preparation/resource preparation clause 5.1.1.6.2, TS 28.552 [8];</p> <p>Frequency Priority Information (i.e., based on deployment) set by the MNOs: Absolute priorities for different NR frequencies or inter-RAT frequencies, clause 5.2.4.1, TS 38.304 [21];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, clause 6.3.4/6.3.5 of TS 28.554 [7];</p> <p>Data packet loss: Data volume of outgoing GTP data packets per QoS level on the N3 interface, from UPF to (R)AN and via versa clause 5.4.1.6 TS 28.552 [8]</p> | +| Allocated Virtual Resource | <p>Allocated Compute: This describes the number of vCPUs allocated to the virtual machine on which the gNB VNF is hosted.</p> <p>Allocated Memory: This describes the number of vMemory allocated to the virtual machine on which the gNB VNF is hosted.</p> <p>Allocated Storage: This describes the number of vStorage allocated to the virtual machine on</p> | + +| | | +|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | which the gNB VNF is hosted. | +| Consumed Virtual Resource | <p>Consumed Compute: This describes the number of total aggregated compute resource consumption at a particular point of time.</p> <p>Consumed Memory: This describes the number of total aggregated memory consumption at a particular point of time.</p> <p>Consumed Storage: This describes the number of total aggregated storage consumption at a particular point of time.</p> | +| Consumed Radio Resource | Radio resource utilization: The physical radio resource utilization of the target gNB, see clause 5.1.1.2 of TS 28.552[8]; | +| MDT Data | UE measurements related to RSRP, RSRQ, SINR (serving cell and neighbour cells) and UE location information, TS 37.320 [12]. | +| UE location reports | UE location information provided by the LCS with the anonymous ID, which can be used to correlate with MDT reports. | +| QoE Data | Detailed measurements are FFS. | +| S-NSSAI | S-NSSAI as defined in clause 5.15.2, TS 23.501 [13]. MDAS uses this information to identify target gNBs or inter-RAT cells associated with a network slice performing handover optimization and may derive resource utilization and network performance analytics. | +| Configuration Data | <p>Resource configuration data including RAN and virtualized NFs.</p> <p>The current policy configured in the RAN related to the handover optimization.</p> | + +##### 6.5.1.3.3 Analytics report on gNB resource consumption + +The resource analytics report contains the following information per gNB. + +| <b>Analytics Report of gNB resource consumption</b> | <b>Attribute Name</b> | <b>Description</b> | +|-----------------------------------------------------|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Allocated Virtual Resource | <p>Allocated Compute: This describes the number of vCPUs allocated to the virtual machine on which the gNB VNF is hosted.</p> <p>Allocated Memory: This describes the number of virtual vMemory allocated to the virtual machine on which the gNB VNF is hosted.</p> <p>Allocated Storage: This describes the number of vStorage allocated to the virtual machine on which the gNB VNF is hosted.</p> | +| | Consumed Virtual Resource | <p>Consumed Compute: This describes the number of total aggregated compute resource consumption at a particular point of time.</p> <p>Consumed Memory: This describes the number of total aggregated memory consumption at a particular point of time.</p> <p>Consumed Storage: This describes the number of total aggregated storage consumption at a particular point of time.</p> | +| | Projected Virtual Resource consumption | <p>Projected Compute: This describes the number of total projected compute resource consumption at a particular point of time.</p> <p>Projected Memory: This describes the number of total</p> | + +| | | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | projected memory consumption at a particular point of time.<br><br>Projected Storage: This describes the number of total projected storage consumption at a particular point of time.<br><br>Timestamp: Time for which the projection is made. | +| Assigned radio resources | The physical radio resource assignment to the target gNB. | +| Consumed radio resource | The physical radio resource utilization of the target gNB. | +| Projected radio resource | The physical radio resource projected utilization of the target gNB. | +| isOptimal | Indication on whether the target gNB is optimal for handover. This will include:<br><br>isOptimal: TRUE/FALSE indication if it is optimal.<br><br>Network slice Identifier: Indication of the target slice (or same slice type) at the target gNB. | +| isFutureOptimal | Indication on whether the target gNB is optimal for handover at a future point of time (Timestamp). This will include:<br><br>isFutureOptimal: TRUE/FALSE indication if it is optimal.<br><br>TimeStamp: Indicating the timestamp at which the target gNB will be optimal<br><br>Network slice Identifier: Indication of the target slice (or same slice type) at the target gNB. | +| Priority | Priority of the target gNB for optimal HO, in case of multiple targets. | +| Remedial Action | Recommendation for gNB modification in order to make it optimal for handover e.g., scale-out gNB, increase radio resource. | + +### 6.5.2 Inter-gNB Beam Selection Optimization + +#### 6.5.2.1 Use case + +The handover procedure specified in 5G is triggered based on UE measurements, specifically considering the cell level radio quality of the source and target cell(s). In case of beamformed access, one cell can make use of several beams for serving residing users (SSB or CSI-RS) with each user served by a single beam at a time. The cell level quality can be represented as an aggregated metric over one or more beams. So, although handover is performed between two 5G cells, the granularity of handover can be further broken down to beam level. + +The target cell provides RACH resources to the UE, which are linked with specific beams. Currently, the target cell can do this, based on beam level measurements performed and reported by the UE. Picking the wrong beam for performing RACH on the target cell could easily result in RLF for the UE and should be avoided. + +To address this beam level handover optimization issue, it is desirable to use MDAS to prioritize and/or select a beam in case of handover for a specific target cell, in order to minimize or even avoid RLF. + +The MDAS producer provides a beam level HO optimization analytics report considering information about the handover performance of different beam combinations between specific source and target cell pairs. In particular, the MDAS producer considers the beam of the current cell and the selected beam (out of several available beams) of the target cell to keep statistics regarding the handover performance in order to avoid RLF. Beams of the target cell with a successful handover are preferred in the selection. + +In other words, the analytics report also provides recommended actions to optimize the beam selection at the target gNB as a function of serving beam on the source cell side. Based on the recommended actions, the MDAS consumer adjusts the priorities for the beam selection at HO, i.e. the beam combinations that are likely to succeed are prioritized, less optimal beam combinations are down prioritized. The analytics report may also be used to aid the target cell to allocate RACH resources in a way that ensures HO success. + +#### 6.5.2.2 Potential requirements + +**REQ-HO\_BEAM\_OPT\_CON-1** The MDAS producer should have a capability to provide the analytics report describing the handover performance of beam combinations between cell pairs to authorized consumers based on previously recorded HOs. + +**REQ-HO\_BEAM\_OPT\_CON-2** The analytics report describing the performance of beam combinations between cell pairs should contain the following information: + +- Number of successful HOs between a given beam pair +- Number of failed HOs between a given beam pair +- Indication if a beam pair is to be prioritized or down prioritized + +#### 6.5.2.3 Possible solutions + +##### 6.5.2.3.1 Solution description + +The MDAS producer can analyze the ongoing and/or potential beam handover optimization based on the current and historical beam selection success/failure rate for an inter-gNB handover. The MDAS producer can provide the analytics report as defined in Clause 6.5.2.3.3 triggered by an event or periodically. + +##### 6.5.2.3.2 Data required + +The following data is required to do the required analysis. + +| Data category | Required data | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | Inter-gNB handover: Number of success/failed handovers in terms of handover preparation/resource preparation;<br>Beam level measurements: CSI-RS, SSB beam related measurements clause 5.1.1.28, TS 28.552 [8];<br>Success/failure handover rate per beam pair, i.e. serving beam Id in source gNB and selected beam Id in target gNB. | +| MDT Data | UE measurements related to radio conditions and UE location information. | +| Beam selection policy | The current policy configured in the RAN related to beam selection for inter-gNB handover optimization. | + +##### 6.5.2.3.3 Analytics report + +The gNB resource analytics report contains the following information. + +| Analytics Report of gNB resource consumption | Attribute Name | Description | +|----------------------------------------------|-------------------------------------------|-----------------------------------------------------------------------------------------------------| +| | Beam level Inter-gNB Handover performance | Handover success rate per beam ID pair. This can be quantified as high, medium or low success rate. | +| | Time period | Time period, in the future, for the handover success rate per beam ID pair | +| | List of gNBs | Objects involved: gNB(s) and cells of gNBs, | + +### 6.5.3 Load Balancing optimization + +#### 6.5.3.1 Use case + +The rapid traffic growth and multiple frequency bands utilized in a commercial network make it challenging to steer the traffic in a balanced distribution. To address the problem, load balancing had been proposed. The objective of load sharing and load balancing is to distribute cell load evenly among cells or to transfer part of the traffic from congested cell, or to offload users from one cell or carrier or RAT to improve the network resource utilization efficiency and achieve network energy saving. This can be done by means of optimization of cell reselection/handover parameters and handover actions. + +To ensure the service performance and user experience, the load balancing action based on handovers highly depends on the measurement report (MR) from the UE. For example, the inter-frequency scenarios with the deployment of multiple different frequency bands, the MR configuration and UE MR reports may cause amount of signalling overhead over Uu interface. The frequent inter-frequency measurement will cause huge UE power consumption and severely impact on running service by the data interruption for inter-frequency measurement gap, e.g. the gap time in LTE is number of frequency\*60ms per 480ms period and the gap time in NR also depends on SMTC period. The gap assisted inter-frequency measurements mechanism will bring delay of the measurement and decrease the data transmission rate. Solutions are desired to improve the effectiveness of the MR configuration and report, which may help to greatly reduce the MR signalling overhead, UE power consumption and data interruption of running service, and improve the convergence speed of the load balancing. + +The MDA can help to predict the measurement results of cell on neighboring frequencies for each UE without the GAP assisted measurement. Via analyzing the historical intra-frequency and inter-frequency measurement from both the serving cell and the neighbour cell, the MDA can construct the network “radio finger print”, which characterize the network intra-frequency and inter-frequency coverage quality. The “radio finger print” information is composed of multiple virtual grid. The grid index is to identify a specific virtual grid and this index consists of cell ID and corresponding coverage quality, e.g., RSRP, of at least three intra-frequency cells. The attributes of the grid are used to describe the wireless characteristics of the grid, such as coverage of inter-frequency neighbor cells, including RSRP, reference signal receiving quality (RSRQ), received signal strength indication (RSSI), channel quality indicator (CQI), modulation and coding scheme (MCS), beam ID, etc. + +The MDA producer provides the analytics report on “radio finger print” information to the gNB, gNB can directly predict the measurement values of cells on neighboring frequencies for each UE based on the well-constructed “radio finger print” and the real-time intra-frequency measurement. In this case, the GAP assisted inter-frequency measurement is avoided, and the gNB can make proper load balancing actions based on the predictions, which helps to reduce the data interruption of running services and improve the load balancing speed. + +The MDA producer may also provide the traffic load prediction report to the authorized consumers, e.g., gNB, to enable the proactive load balancing actions. This would help to prevent the user experience degradation in advance compared to the reactive optimizations based on the delayed load information measurement and exchange. + +#### 6.5.3.2 Potential requirements + +**REQ-MLB\_OPT\_CON-1** The MDAS producer should have a capability to provide the analytics report describing the radio measurement information to authorized consumers , e.g., gNB. + +**REQ-MLB\_OPT\_CON-2** The analytics report describing the radio measurement information should contain the following information: + +- the applied cell ID; +- the time period(s) of the original data used for deriving the analytics report; +- the serving cell and its inter-frequency/intra-frequency neighboring cell's cell ID and corresponding radio measurement information, e.g., CSI-RSRP, SS-RSRP, etc; +- Indication on whether the gNB is suitable to be selected as the target gNB for the MLB based handover based on the radio signal qualities. + +**REQ-MLB\_OPT\_CON-3** The analytics report describing the predicted resource utilization status of gNB should contain the following information: + +- predicted virtual, radio, and transport resources utilizations for potential MLB source and target gNBs in the near future; +- Indication on whether the gNB is needed to activate the MLB operation; +- Indication on whether the gNB is suitable to be selected as the target gNB for the MLB based handover. + +#### 6.5.3.3 Possible solutions + +TBD + +### 6.5.4 Mobility performance analysis + +#### 6.5.4.1 Use case + +The mobility performance related problems may be resulted from different causes, e.g., too long mobility interruption time for latency sensitive services, low handover successful rate due to poor coverage of the cell-edge, handover failure due to lack of handover resources, too-early/too-late/pingpong handovers due to inappropriate handover parameters. + +In addition, there are different handover mechanisms, e.g. Dual Active Protocol Stack (DAPS) to reduce service interruption time during handover, Conditional Handover (CHO) to improve handover robustness, RACH-less handover to reduce handover latency etc. SON MRO solutions can handle multiple handover robustness issues such as too early handover, too late handover, handover to a wrong cell etc. Furthermore, handover mechanisms are also related with NSA and SA deployment architecture. In different scenarios, handover solutions will have different impacts on the mobility performance. The analytics report to identify the most optimal handover mechanism may be provided by MDAS producer. For example, to satisfy the requirements of 0ms mobility interruption time for some URLLC services, MDAS may propose to prioritize the usage of DAPS. If handover successful rate is low due to coverage issue in the cell edge, MDAS may recommend CHO instead of gNB triggered handover mechanisms. To provide optimal handover mechanisms and the corresponding handover related parameters, MDAS may consider multiple factors, e.g. radio conditions, cell load, service requirements, handover successful rate, history performance data around handover, UE RF finger prints etc. MDAS may compare performance of different handover mechanisms and propose optimal handover mechanisms, e.g. the prioritization of different handover mechanisms in different conditions. + +MDAS can be used to analyse service experience and network performance during handover period in different mobility scenarios. It may also be able to provide the recommendations of optimal handover parameters, resource configurations and mobility related policies. Mobility performance analysis should cover the following aspects: + +- Mobility scenarios in NSA and SA deployment architectures; +- Optimal handover mechanisms, e.g. DAPS, CHO, RACH-less handover etc; +- Optimal handover parameter and resource configurations; +- Coordination with SON MRO mechanisms to improve handover robustness; +- Mechanisms for fast handover failure recovery; + +The MDAS producer is able to, from the perspective of the management aspects, provide the mobility performance analytics report. This analytics report can be considered as an input to support SLS assurance to perform further evaluation. + +#### 6.5.4.2 Potential requirements + +**REQ-MOB\_PMF\_CON-1** The MDAS producer should have a capability to provide the analytics report of mobility performance. + +**REQ-MOB\_PMF\_CON-2** The analytics report describing the mobility performance should contain the following information describing the mobility related performance aspects: + +- Optimal handover mechanism and the corresponding parameters for DAPS, CHO, RACH-less handover and NR SON MRO scenarios etc. + +#### 6.5.4.3 Possible solutions + +##### 6.5.4.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to provide optimal handover mechanisms and the corresponding configurations regarding parameters and resources. As the table in 6.5.4.3.3 shows, the analytics report is able to be provided by the MDAS producer to describe the optimal handover mechanisms. This procedure may be triggered by the request or periodically. + +##### 6.5.4.3.2 Data required for mobility performance analysis + +Following table shows the potential data required to analyse the mobility performance. + +| Data Category | Required Data | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>sNSSAIList;</p> <p>Inter-gNB handovers: see clause 5.1.1.6.1 of TS 28.552[8];</p> <p>Intra-gNB handovers: see clause 5.1.1.6.2 of TS 28.552[8];</p> <p>Handovers between 5GS and EPS: see clause 5.1.1.6.3 of TS 28.552[8];</p> <p>RRC Connection Re-establishment: see clause 5.1.1.17 of TS 28.552[8];</p> <p>Inter-AMF handovers: see clause 5.2.5.1 of TS 28.552[8];</p> <p>Handovers from 5GS to EPS: see clause 5.2.5.3 of TS 28.552[8];</p> <p>Handovers from EPS to 5GS: see clause 5.2.5.4 of TS 28.552[8];</p> <p>Number of handover events, Number of HO failures, Number of too early HO failures, Number of too late HO failures, Number of HO failures to wrong cell, Number of unnecessary HOs to another RAT: see clause 4.3.5 of TS 28.628[y];</p> <p>Radio resource utilization: The usage of physical radio resource utilization of the network, see clause 5.1.1.2 of TS 28.552[8];</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7];</p> <p>Throughput at N3 interface: Upstream/Downstream GTP data throughput at N3 interface, see clause 6.3.4 and clause 6.3.5 of TS 28.554 [7];</p> <p>NWDAF analytical data: UE mobility analytics, UE Communication Analytics; see 6.7.2 and 6.7.3 of TS 23.288 [y];</p> | +| MDT Data | UE measurements related to RSRP, RSRQ, SINR and UE location information. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration Data | The execution data including the changes or the configuration of the MOIs related with RAN user plane congestion. | + +Note: The above parameters may not be the complete list. + +##### 6.5.4.3.3 Analytics report for mobility performance analysis + +Following table shows the potential information carried in the analytics report of mobility performance analysis. + +| Analytics Report of mobility performance | Attribute Name | Description | +|------------------------------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Mobility performance issue identifier | The identifier of the mobility performance issue analysis; | +| | Root cause of mobility performance issue | The root cause of mobility performance issues, e.g., too long mobility interruption time for latency sensitive services, low handover successful rate due to poor coverage of the cell-edge, too-early/too-late/pingpong handovers due to inappropriate handover parameters | +| | Recommended handover mechanisms | Recommended handover mechanisms according to network conditions, e.g., DAPS, CHO, RACH-less handover;<br>Note: The DAPS and CHO mechanism are mutually exclusive. | +| | Recommended handover related parameters | Corresponding configurations of handover related parameters, e.g., the range of handover offset. | +| | Time duration | The time duration the identified handover mechanism or handover related parameters are recommended to apply. | +| | Location | The geographical area or the cells where the identified handover mechanism and handover related parameters are applied. | + +### 6.5.5 Handover optimization based on UE trajectory + +#### 6.5.5.1 Use case + +Handover optimization can benefit from knowledge about the trajectory on which the user may be moving. A trajectory here is a sequence of location coordinates, i.e. a vector that captures the sequences of coordinates within a certain time interval, derived from historical UE location data, that identifies the different directions which users may take starting at a given point. At a city junction, for example, the probability of a handover success for a user moving straight through the junction may be different from that for a user who is turning left or turning right. So, at that junction, the straight, left and right direction indicate three possible trajectories. The MDAS producer should be able to analyse historical handover performance data in combination with historical UE location and the radio characteristics like RSRP and SINR considering the possible user trajectories to identify the optimal handover configurations and target cell prioritization. + +#### 6.5.5.2 Potential requirements + +REQ-HO\_OPT\_TR\_CON-1 The MDAS producer should have a capability to provide an analytics report indicating the possible candidate user trajectories across the cell boundaries and provide radio configuration and target gNB selection specific to each trajectory. + +#### 6.5.5.3 Possible solutions + +##### 6.5.5.3.1 Solution description + +The solution considers UE trajectories and radio conditions for selecting the target gNB. The current resource consumption is analysed with the future/predicative resource consumption to decide if the target gNB is optimal for handover or not. + +##### 6.5.5.3.2 Data required + +The following data is required to do the required analysis. + +| Data category | Required data | +|-------------------------|----------------------------------------------------------------------------------------------------------------------------| +| Consumed Radio Resource | Radio resource utilization: The physical radio resource utilization of the target gNB, see clause 5.1.1.2 of TS 28.552[8]; | +| MDT data | UE measurements related to RSRP, RSRQ, SINR time-stamped and annotated with UE location information. | + +##### 6.5.5.3.3 Analytics report on user trajectory-based handover optimization + +The gNB trajectory-based handover optimization analytics report contains the following information. + +| Analytics Report of user trajectory-based handover | Attribute Name | Description | +|----------------------------------------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| | User trajectory | The predicted UE location that identifies a trajectory across a cell boundary. | +| | Radio characteristics on user trajectory | Radio parameters e.g. RSRP, SINR, on the predicted user trajectory across a cell boundary. | +| | Recommended actions | Recommendation for optimal gNB configuration and/or target gNB selection/prioritization based on the user trajectory information. | + +## 6.6 Energy efficiency related issues + +### 6.6.1 MDA assisted energy saving + +#### 6.6.1.1 Use case + +Energy saving is a critical issue for the 5G operators. Energy saving is achieved by activating the energy saving mode of the NR capacity booster cell or 5GC NF (e.g. UPF etc.), and the energy saving activation decision making may be based on the various information such as load information of the related cells and the energy saving policies set by operators as specified in TS 28.310 [14]. + +As the conclusion from clause 7.2 of the TR 21.866 [15], “The EE Control and Coordination Function: a self-managed automated process to control and coordinate system wide power saving operations including the access networks, core network, backhaul/fronthaul transmission networks, backbone networks and other subsystems”, the management system has the overall view of network load information and it could also take the inputs from the control plane analysis (e.g. the analytics provided by NWDAF). The management system may provide the network wide analytics and cooperate with Core and RAN domains and decide on which network element should move into energy saving mode in a coordinated manner. + +There are various information could be used as inputs for management energy saving analysis. For example, the MDAS provides the analytics report to assist energy saving based on the EE related performance measurements, (e.g. PDCP data volume, PNF temperature, and PNF power consumption etc.) from the gNBs. + +The composition of the traffic load could be also considered as inputs for energy saving analysis. (e.g., the percentage of high-value traffic in the traffic load). The variation of traffic load may be related to the network data (e.g., historical handover information of the UEs or network congestion status). Collecting and analysing the network data with machine learning tools may provide predictions related to the trends of traffic load. The composition and the trend of the traffic load may be used as references for making decision on energy saving. + +MDAS may also obtain NF location or other resource information including virtual resource consumption, while analyzing historical network information. Based on the collected information, MDAS provides analysis and give suggestions to network management in optimization suggestion for 5G Core NF deployment options in high-value traffic region (e.g. location of VNF in context of energy saving). The information from control plane data analysis from NWDAF may also be used as input for energy saving analysis and decision. + +The decision of core NF and RAN node energy saving should be coordinated by management system to guarantee the overall network and service performance are not affected as much as possible. + +To achieve an optimized balance between the energy consumed and the serviced performance provided by the network, MDAS can be used to provide an analytic report by analyzing the above information comprehensively to assist the energy saving related decision making. + +### 6.6.1.2 Potential requirements + +TBD + +### 6.6.1.3 Possible solutions + +#### 6.6.1.3.1 Solution description + +The MDAS producer correlates and analyses the management data described in the following subclause to assist the management energy saving function to make energy efficiency decisions. As the table in 6.6.1.3.3 shows, the analytics report is able to be provided by the MDAS producer to describe the analytics result and recommendations of energy saving. This procedure may be triggered by the request or periodically. + +Energy saving activation decision making may be based on the various information such as load information. The prediction result of these information can be used by operators to make energy-saving policies. There are many prediction models which may use ML algorithms for predicting these information, such as energy-saving scenarios prediction models and traffic load prediction models. + +The prediction models are trained to be able to produce the expected training output from the training input. The data for models training may include RRC connection number, PRB utilization, energy consumption, service experience, etc. After the training process, the pre-trained models for predicting information used to make energy-saving policies can be obtained. + +The more accurate the information prediction results are, the better the energy-saving policies based on the information prediction results will be. According to the result of information prediction and the energy-saving benefit, the MDA service can assist the energy saving policy decision making by recommending the optimal information prediction models which can provide more accurate information prediction results for consumers. + +For example, the MDA service may take base station energy saving scenarios prediction model and the traffic load prediction model together as input. Based on the results of energy saving scenarios prediction and traffic load prediction, the MDA service may use the ML algorithms to calculate the energy-saving benefit based on base station related information (e.g., service experience changes), the traffic load changes as well as the prediction of the energy saving scenarios. And by maximizing the expected sum of energy-saving benefits, the MDA service may provide the optimal prediction models for making recommendation of base station energy saving policies accordingly. + +#### 6.6.1.3.2 Data required for MDA assisted energy saving + +Following table shows the potential data required to analyse the energy saving issue. + +| Data Category | Required Data | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | PNF Power Consumption: Power consumed over the measurement period, see clause 5.1.1.19.2 of TS 28.552 [8];<br>PNF Energy consumption: The energy consumed, see clause 5.1.1.19.3 of TS 28.552[8];<br>PNF Energy Temperature: The temperature over the measurement period, see clause 5.1.1.19.4 of TS 28.552[8];<br>PNF Voltage: The voltage, see clause 5.1.1.19.5 of TS 28.552[8];<br>PNF Current: The current, see clause 5.1.1.19.6 of TS 28.552[8];<br>PNF humidity consumption: The percentage of humidity during the measurement period, see clause 5.1.1.19.7 of TS 28.552[8];<br>PDCP Data Volume: The transmitted PDCP data volume, see | + +| | | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | clause 5.1.2.1 and 5.1.3.6 of TS 28.552 [8];<br>Virtual resource usage of NF: The resource usage of virtual network functions, see clause 5.7.1 of TS 28.552 [8]. | +| QoE Data | The measurements that are collected are DASH [16] and MTSI [17] measurements. The detailed information of QoE data required by this case is FFS. | +| Analytics Data | The control plane analysis result from the NWDAF defined in TS 23.288 [18], e.g., observed service experience related network data analytics.<br><br>The additional required analysis result is FFS. | +| Pre-trained Prediction Models | The pre-trained models, which may be based on ML algorithms and trained to be able to produce the expected training output for consumers, e.g., pre-trained base station energy-saving scenarios prediction models, pre-trained traffic load prediction models.<br><br>The detailed information about where to obtain the pre-trained prediction models is FFS. | + +Note: The above parameters may not be the complete list. + +### 6.6.1.3.3 Analytics report for MDA assist energy saving + +Following table shows the potential information carried in the analytics report of MDA assist energy saving. + +| <b>Analytics Report of MDA assisted energy saving</b> | <b>Attribute Name</b> | <b>Description</b> | +|-------------------------------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Energy efficiency issue identifier | The identifier of the MDA assisted energy saving | +| | Location | The geographical area or the cells where the unreasonable energy consumption exists | +| | Root cause | The root cause of the part of the energy consumption that may be conserved, e.g., ultra-low traffic load area with energy consumption, excessive energy consumption | +| | Recommended prediction models | The optimal prediction models which can provide more accurate information prediction results to assist the energy saving related decision making. | + +## 6.7 Paging performance related issues + +### 6.7.1 Paging optimization + +#### 6.7.1.1 Use case + +As per the current procedures, if the UE goes out-of-coverage (OOC) the paging which was initiated by the network Access and Mobility Management Function (AMF) fails. The re-attempts continue to fail until UE comes in the coverage and reacts to the paging attempts. This repetitive paging attempts result in the wastage of network resources. As an example, the use case includes a user or a group of users getting into an area, with no cellular coverage on a regular basis for a considerably long duration, for e.g., the user gets into a shielded room for some testing purpose every day for a defined period. The Network initiated paging for such users will fail until they are back in the area with cellular coverage. This would result in in-efficient network resource usage. + +It is desirable to use MDAS (Management data analytic service) to optimize the current paging procedures in 5G networks. MDAS producer provides an analytical report containing the user(s) paging analytics indicating the time window at which the user is OOC on a regular basis at the particular location and hence will not be able to respond on a network-initiated paging. Based on the report MDAS consumer (e.g., AMF, gNB) decides on whether, when and where to initiate or not to initiate the paging procedures, thereby ensuring the efficient paging procedures and optimal network resource utilization, as paging can be initiated only when there are more chances for it to be successful. + +### 6.7.1.2 Potential Requirements + +**REQ-PA\_OPT\_CON-1:** The MDAS producer should have a capability allowing the authorized consumer to get the paging analytics report describing paging results for a particular user or a group of users. + +**REQ-PA\_OPT\_CON-2:** The MDAS producer should have a capability to provide the paging analytics report describing the paging results based on successful and un-successful paging attempts at a particular time and duration. + +**REQ-PA\_OPT\_CON-3:** The paging analytics report describing the paging results should contain the following information: + +- User Identification: Identification of the user or a group of users. +- Daily-OOC-Duration: Identifying the time window during which UE is out-of-coverage every day. +- Daily-OOC-Location: Identifying the last known location before UE going out-of-coverage every day. +- Recommended Action: The recommendation may suggest stopping paging the UE for Daily-OOC-Duration at Daily-OOC-Location. + +### 6.7.1.3 Possible Solutions + +#### 6.7.1.3.1 Solution description + +The solution requires MDAS producer to collect various data and provide the paging analytics report. Daily-OOC-Duration and Daily-OOC-Location will be included in the Paging Analytics Report mentioning the time window during which UE is out-of-coverage every day at a particular location. The paging is not initiated for the UE during the period provided as Daily-OOC-Duration if the last know UE location is the location identified by Daily-OOC-Location. + +#### 6.7.1.3.2 Data required + +The consumer (e.g. AMF) can subscribe to obtain the paging analytics report for a user or a group of the user from MDAS producer. The subscription request may include identification for the target user or a group of the user, reporting interval etc. The MDAS producer collects the following per UE per day data from various sources. + +| Data category | Required data | +|------------------------|---------------------------------------------------------------------------------------| +| UE Paging Measurements | Number of successful paging attempt. | +| | Successful Timestamp: The timestamp for each successful paging attempt. | +| | Successful Location: Last known location of UE. | +| | Number of un-successful paging attempt: Total number of un-successful paging attempt. | +| | Un-Successful Timestamp: The timestamp for each un-successful paging attempt. | +| | Un-Successful Location: Last known location of UE. | + +#### 6.7.1.3.3 Analytics report + +The paging analytics report contains the following information + +| Paging Analytics | Attribute Name | Description | +|------------------|----------------|-------------| +|------------------|----------------|-------------| + +| | | | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| <b>Report</b> | User Identification | Identification of the user or a group of users. | +| | Daily-OOC-Duration | Identifying the time window during which UE is out-of-coverage every day. This will be provided per UE. | +| | Daily-OOC-Location | Identifying the last known location before UE going out-of-coverage every day. This will be provided per UE. | +| | Recommended Action | The recommendation may suggest stopping paging the UE for Daily-OOC-Duration at Daily-OOC-Location. This will be provided per UE. | + +Based on the report and the recommendation, the consumer decides whether to change the paging strategy for a particular UE or a group of UE. If the paging policy needs to be changed, the AMF may decide whether, when and where to page the UE. The AMF may not page the UE during the period provided as Daily-OOC-Duration if the last know UE location is the location identified by Daily-OOC-Location. + +**Editor's Note:** This use may require MDAS to know UE Identifier. How that will be done is FFS. + +## 6.8 Software management related issues + +### 6.8.1 RAN Node Software Upgrade + +#### 6.8.1.1 Use case + +As per the current mechanism of software upgrade at RAN node results in service disruption or huge operational cost. Consider a scenario, when a RAN Node is required to shut down manually to undergo critical maintenance for a very short duration of time. Software upgrade can be one such critical maintenance scenario. In such cases, all the resources (bearer, security functions, mobility management) that are managed by this RAN Node need to be purged and reconfigured at another RAN Node (standby RAN Node) or if another RAN Node is not available then resources will be reconfigured again when former RAN Node comes up after software upgrade. Both the situations lead to additional operational expenses and data loss. Operational expense in terms of all the resources to be released/attached again and data loss for all GBR sessions/bearer. + +It is expected to use MDAS to optimize the procedure of software upgrade at RAN Node. The software upgrade should be automatically initiated by the OAM system, once configured, at the time when the expected impacts are minimum i.e at the Optimal Time when there would be minimum expected operational cost and data loss. The Optimal Time (current or futuristic) can be derived by collecting and analysing the data related to DRBs including GBR/non-GBR, state, modification count, ongoing handover etc. MDAS can utilize historical data and AI/ML (e.g., time series based) algorithm to derive the future optimal time for software upgrade. + +Note: RAN Node above refers to CU-CP in case of gNB split case. + +#### 6.8.1.2 Potential Requirements + +**REQ-SW\_UPG\_CON-1:** The MDAS producer should have a capability allowing the authorized consumer to get the DRB info analytics report describing the DRBs info at a particular RAN Node(s). + +**REQ-SW\_UPG\_CON-2:** The MDAS producer should have a capability to provide the DRB info analytics report describing the DRB info based on DRB characteristics including GBR/non-GBR, state, modification count, handover etc. + +**REQ-SW\_UPG\_CON-3:** The DRB info analytics report describing the DRB info should contain the following information: + +- Timestamp: Time at which the report is generated +- CurrentUpgradeOptimal: Whether RAN Node is optimal for upgrade at present +- DRB status: Total number of GBR and non-GBR DRBs at present + +- FutureUpgradeOptimal: Whether RAN Node will be optimal for upgrade at a future point of time. This will also provide a future timestamp. +- DRB status: Total number of GBR and non-GBR DRBs at future point of time. This will also provide a future timestamp. + +### 6.8.1.3 Possible Solutions + +#### 6.8.1.3.1 Solution description + +The solution requires MDAS producer to collect current DRB info as defined in clause 6.8.1.3.2 and produce the report, as defined in clause 6.8.1.3.3, providing the optimal time for software upgrade i.e. the time at which the impact is minimal. + +#### 6.8.1.3.2 Data required + +The following table shows the data required to generate the DRB info analytics report. The data is collected per DRB from gNB. + +| Data Category | Required Data | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Bearer Statistics | QCI: Indicates resource bearer type (GBR, non-GBR). | +| | Radio bearer State: Radio bearer State (Idle, Active)<br><i>The state indicates the status of bearer connection. The state will be used to deduce total number of idle/active connection. Based on the number of idle/active connections probable time for SW Upgrade can be decided.</i> | +| | Bearer Modification Count: This count indicates number of times, this bearer has gone for modification since its creation.<br><i>This count will be used to detect how frequent this session has undergone bearer modification. With history database, if this session is vulnerable to many bearer modifications, the upgrade can be differed.</i> | +| | Handover In Progress: This flag indicates whether the bearer is undergoing handover or not.<br><i>This flag will help to deduce number of sessions which are undergoing handover. MDAS may choose to defer SW upgrade based on number of sessions which are undergoing handover. The best practise is to go for SW upgrade, when active handovers are minimum.</i> | +| | GTP Error Indication: This flag indicates GTP Path has gone to error state and system is waiting for recovery.<br><i>This flag will help to deduce number of sessions which are recovering due to error in GTP Path. MDAS may choose to defer SW upgrade based on number of sessions which are in error state. The best practise is to go for SW upgrade, when number of sessions suffering from this error are minimal.</i> | +| | Timestamp: This parameter indicates timestamp during which this information has been collected | + +Editor's Note: Additional Input may be required, which are FFS. + +#### 6.8.1.3.3 Analytics report + +The DRB info analytics report shall contain the following + +| DRB info Analytics | Attribute Name | Description | +|--------------------|----------------|-------------| +|--------------------|----------------|-------------| + +| | | | +|---------------|-----------------------|------------------------------------------------------------------------------------------------------------------------| +| <b>Report</b> | Timestamp | Time at which the report is generated | +| | CurrentUpgradeOptimal | Boolean attribute indicating whether RAN Node can be upgrade at present. | +| | No. of GBR DRB | Total number of GBR bearer | +| | No. of Non-GBR DRB | Total number of non-GBR bearer | +| | FutureUpgradeOptimal | Boolean attribute indicating whether RAN Node can be upgrade in future. This will provide the time duration in future. | +| | No. of GBR DRB | Total number of GBR bearer | +| | No. of Non-GBR DRB | Total number of non-GBR bearer | + +## 6.9 MDA assisted SON coordination + +### 6.9.1 SON conflict prevention and resolution + +#### 6.9.1.1 Use case + +Some SON functions, such as the MRO function and the MLB function, may modify the same parameters of an NR cell and potentially cause conflict. For instance, the MRO function may need to modify the HO parameters causing a handover to occur later (i.e., when the signal strength of the neighbour cell become stronger). However, the MLB function may need to modify the same HO parameters causing the HO to occur sooner, in order to offload some traffic towards the same neighbour cell. Similarly, the conflict may arise between a SON function and a non-SON function (e.g., eMIMO). + +The potential SON conflict (which could be between SON functions or between a SON function and a non-SON function) should be prevented from happening as much as possible, and if the conflict happens it should be resolved as soon as possible. The SON conflict prevention and resolution can be assisted by MDA. + +The MDA could analyse the following data for identifying the potential SON conflict or detecting whether a SON conflict occurred: + +- historical and the most recent changes made by the SON functions and non-SON functions; +- the current network configurations; +- historical and current network performance data related to the SON function(s) and the relevant non-SON functions. For instance, load information of the NR cells, handover performance measurements (too early HOs, too late HOs, etc.); +- Policies and targets for the SON functions. +- historical and current MDT/RLF data. +- for a SON function or a non-SON function, considering potential affected parameters. + +If a potential SON conflict is identified, the MDAS producer provides an analytics report to describe the potential conflict and the recommended actions to prevent such conflicts from happening. + +If a SON conflict is detected, the MDAS producer provides an analytics report to describe the conflict including the recommended actions to resolve it. + +The recommended actions for SON conflict prevention and resolution may be one or more of the following: + +- modify the policies and targets for the SON function(s); +- change the priority of the SON function(s); + +- set or change the range of the attributes value that the SON function(s) are allowed to modify; +- update the attributes value to correct the conflict (if already occurred); +- temporarily switch off one or more SON function(s) ; +- undo the most recent configuration undertaken by the SON function; +- provide a report that describes how SON function(s) can potentially affect the common parameters. + +### 6.9.1.2 Potential requirements + +**REQ-MDA\_SONCO-CON-1** The MDAS producer should have a capability to provide the analytics report describing the identified potential conflict between SON functions or between a SON function and a non-SON function with recommended actions to prevent the conflict from happening. + +**REQ-MDA\_SONCO-CON-2** The MDAS producer should have a capability to provide the analytics report describing the detected conflict between SON functions or between a SON function and a non-SON function with recommended actions to resolve the conflict. + +**REQ-MDA\_SONCO-CON-3** The MDAS producer should have a capability to provide the analytics report that describes the relations (i.e. whether certain conditions trigger conflicts) between observed conflicts and observed conditions. + +### 6.9.1.3 Possible solutions 6.9.1.3.1 Solution description + +The MDAS producer correlates and analyzes the data described in the following subclause within a time period on a regular basis or triggered by events (e.g., the RLF report) to identify a potential SON conflict or a SON conflict already occurred. + +Once a potential or already occurred SON conflict is identified, the MDAS producer provides the analytics report to describe the SON conflict as shown in subclause 6.9.1.3.3. + +### 6.9.1.3.2 Data required for SON conflict analysis + +The following table describes the data required for SON conflict analysis: + +| Data Category | Required Data | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements | <p>Radio Measurements for gNB: RRC connection, see clause 5.1, TS 28.552[8], e.g., RRC connection number, RRC connection establishment, RRC connection re-establishment, RRC connection resuming;</p> <p>RAN UE throughput: A KPI that shows how NG-RAN impacts the service quality provided to an end-user, see clause 6.3.6 of TS 28.554 [7].</p> <p>Throughput for network slice instance: Upstream/Downstream throughput for network and Network Slice Instance, see clause 6.3.2 and clause 6.3.3 of TS 28.554 [7];</p> <p>Performance measurements related to the SON functions, see TS 28.313 [19].</p> | +| CM notification | <p>Notifications of the NRM updates made by SON functions and non-SON functions.</p> <p>The notification needs to include the Id (e.g., DN) of the SON function or non-SON function who made the NRM updates.</p> | +| MDT/RLF Data | UE measurements related to RLF containing RSRP, RSRQ, of the serving cell and neighbour cells, SINR with anonymous id (e.g., C- | + +| | | +|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | RNTI) and UE location information. | +| QoE Data | The details information of QoE data required by this case is FFS. | +| Configuration Data (NRM) | The execution data including the changes or the configuration of the MOIs. This should include historical UE configurations<br>The attributes of the MOIs to be analysed, see TS 28.541 [20].<br>The policy and targets of the SON functions, see TS 28.313 [19]. | +| Potential affected parameters | SON functions parameters affected including the degree of impact (low, medium, high). | + +Note: The above parameters may not be the complete list. + +### 6.9.1.3.3 Analytics report SON conflict prevention and resolution + +Following table provides the potential contents of the analytics report for SON conflict prevention and resolution: + +| <b>Analytics Report of SON conflict prevention and resolution</b> | <b>Attribute Name</b> | <b>Description</b> | +|-------------------------------------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Conflicting Functions Id | Indicates the Id of the conflicting SON functions or non-SON functions. | +| | Conflict type | Indicates the conflict is a potential conflict or an already occurred conflict. | +| | Conflicting attributes | The MOI and attributes where the conflict occurred or is potentially to occur. | +| | Conflict reason | The description of the reason for the conflict. | +| | Conflicting metrics | The performance measurements and KPI(s) over which the SON or non-SON Functions conflict. | +| | Attribute conflict status | The relative level (low, medium, high) of impact of each conflicting attribute on the SON or non-SON functions. | +| | Recommended actions | The MOI and attributes recommended to be configured/changed:<br><ul style="list-style-type: none"> <li>- The policy and targets of the SON functions, see TS 28.313 [19];</li> <li>- The range of attributes value each conflicting SON function can change;</li> <li>- The priority of each conflicting SON function;</li> <li>- Value of the attributes of the affected MOIs (e.g., NRCellCU) where the conflict already occurred;</li> <li>- Switch off the conflicting SON functions, see TS 28.313 [19].</li> </ul> | + +## 6.10 Security related issues + +### 6.10.1 Security risk assessment + +#### 6.10.1.1 Use case + +Security risk assessment can detect anomalies in managed objects, e.g. NF, identify potential security risks and propose countermeasures to mitigate them. Security risks may originate from a variety of different sources and target distinct network objects resulting in different abnormal behaviours, e.g. sudden increase in computing and storage in a virtualization environment, sudden increase of load in network links, abnormal communication patterns between NFs, excessive latency in accessing a NF, relocating a NF in an unexpected location or interrupting the relocation of a NF. + +To assess security risks, the management plane can leverage the benefits of MDAS. An MDAS producer can identify a security risk issue by correlating different performance measurements and alarms, i.e. performing a root cause analysis to locate the malicious source and the network objects affected. Such activity can be triggered when certain performance measurements and KPIs indicate an abnormal network behaviour, which is not related to another known faults. + +The MDAS producer should correlate the usage, e.g. considering the NF procedures for supporting a number of UEs or other events, with the corresponding resource usage, e.g. in terms of CPU, storage and disk. If no other fault alarms indicate another reason, an unexpected resource usage should trigger a security risk analysis to identify the issue based on a private security risk database that resides on the MDAS producer. The MDAS producer can notify the MDAS consumer, e.g. MnF or NE, and provide recommendations to mitigate the identified security risk. The MDAS consumer based on the recommendations can isolate the malicious network objects, e.g. NF, and can also provide recommendations to harden the network in order to avoid similar security risks in the future. + +#### 6.10.1.2 Potential requirements + +**REQ-SEC\_CON-1** The MDAS producer should have a capability to provide the analytics report describing the security risk to authorized consumers based on the correlation of current and predicted performance measurements and alarms. + +**REQ-SEC\_CON-2** The analytics report describing the security issue should contain the following information describing the current and future security risk issue: + +- Identify the type of security risk. +- Location and network objects affected by the security risk. +- Root cause analysis of the security risk issue. +- Recommended action to isolate and/or restrict the security risk issue and harden the network security. + +#### 6.10.1.3 Possible solutions + +##### 6.10.1.3.1 Solution description + +The solution considers security risk assessment related to network. The MDAS producer correlates and analyzes performance measurements and alarm data considering the network topology and configuration data related to statistics or predictions to identify the type of security risk. + +##### 6.10.1.3.2 Data required + +The following data is required to perform the corresponding security risk assessment analysis. + +| Data category | Required data | +|---------------|---------------------------------------------------------------------------------------------------| +| Alarm Data | Alarm information - types of alarms | +| Service Data | S-NSSAI as defined in clause 5.15.2, TS 23.501 [13]. MDAS may derive network topology information | + +| | | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>Performance Measurements</b> | <p>Failures and disruptions:</p> <ul style="list-style-type: none"> <li>- Number of abnormal releases: DRB, QoS flows, PDU sessions, UE context in serving cells as per TS 28.552 [8]</li> <li>- Disruption measurements: CQI/MCS as per TS 28.552 [8]</li> <li>- Excessive delay in accessing NFs (e.g. AMF or SMF)</li> <li>- NF abnormal and excessive communication, e.g. AMF uses a different SMF without performing the expected selection process or it overloads an SMF unexpectedly.</li> <li>- Intra/inter-gNB handover: failures - long handover time as per TS 28.552 [8]</li> </ul> <p>Virtualized resources/behaviour:</p> <ul style="list-style-type: none"> <li>- Virtual resource usage of NF: The resource usage of virtual network functions, see clause 5.7.1 of TS 28.552 [8]</li> <li>- Virtual NF Re-location: Timing/duration and success rate</li> <li>- Frequency of virtual NF Re-location: Rate of relocation</li> <li>- Virtual NF location: NF location with respect to a data network</li> </ul> <p>NF context information as per TS 28.552 [8]:</p> <ul style="list-style-type: none"> <li>- Number of UEs/periodic registration updates (AMF)</li> <li>- Number of PDU sessions/modifications, QoS flows (SMF)</li> <li>- N4/N6/N9 measurements or packet delay, traffic volume, link usage, packet loss (UPF)</li> <li>- Number of application trigger requests rejected (NEF)</li> <li>- Number of failed NF service registration/update, discoveries due to unauthorized NF/error (NRF)</li> </ul> | +| <b>Configuration Data</b> | <p>NRM attributes affecting the location and virtual NF resource allocation and configuration</p> <p>NRM update reports (notification and log) containing the creation or changes of the MOIs affecting the virtual NFs</p> | +| <b>Network Topology</b> | Topology of the network | + +### 6.10.1.3.3 Analytics report + +The MDAS producer offers a new Security Analytics service to the MDAS consumer, which supports security risk assessment related providing the following analytics results: + +| <b>Analytics Report of Security risk assessment</b> | <b>Attribute Name</b> | <b>Description</b> | +|-----------------------------------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| | <b>Security Incident Identifier</b> | Identifier that indicates the security risk (e.g. DDoS, malicious NF, etc.) | +| | <b>Type of Analytics</b> | Statistics or Prediction of security risks | +| | <b>Location</b> | Geographical location that the security risk affects | +| | <b>Affected Objects</b> | NF, PDU session, QoS Flow, Slice | +| | <b>Start/Stop Time</b> | Starts/stop time of the security risk issue | +| | <b>Root Cause</b> | The originator of security issue to isolate fast the problem. | +| | <b>Severity Level</b> | The severity level (e.g. critical, medium, not important) of the security risk issue | +| | <b>Recommended Actions</b> | Recommendation actions to resolve the security risk issue:<br>- Isolate/terminate NF, terminate PDU session, throttle | + +| | | | +|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | signalling from NF or UE, block UE, etc.<br>- Harden security on specific NF, firewall update, scaling resources, load balancing, admission control, etc. | +|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 6.11 Traffic projection + +### 6.11.1 Network slice traffic projection + +#### 6.11.1.1 Use case + +Some of the requirements captured in SliceProfile need to be translated into configurable parameter for various network entities including entities in 5G Core Network (5GC), Radio Access Network (RAN) and Transport Network. One of the example would be: the GST attribute Downlink throughput per slice (dLThptPerSlice) can be translated into maximum downlink throughput per slice (maxDlThptPerSlice) as a configuration parameter, for UPF. However, as one slice may have multiple UPF instances, dividing the total quota available among each UPF instance is critical. The given requirements can be divided among all the targeted NF instance based on the slice traffic analytics. The value for a particular configurable parameter (translated from a particular ServiceProfile attribute) for a particular NF is crucial, especially if multiple instance of that NFs is available in the network slice instance. + +It is desirable to use uses MDAS to get the network slice traffic projections including individual traffic projections on each of the constituent network functions instances present in the slice. The individual traffic projections can be used to divide total available quota among the constituent network functions instances which can then be configured for network function(s), as required. For example, MDAS can provide total number of projected terminal or subscription for each AMF instance in the slice. Based on the projections the total available quota can be divided among the multiple AMF instances in the slice. The AMF instance serving more users or require to serve more users in future will have more quota then other AMF instances in the slice. + +#### 6.11.1.2 Potential Requirements + +**REQ-TRA\_CON\_CON-1:** The MDAS producer should have a capability allowing the authorized consumer to request the slice traffic analytics report describing traffic projection of the slice including its constituent network functions. + +**REQ-TRA\_CON\_CON -2:** The MDAS producer should have a capability to provide the slice traffic analytics report describing the traffic projections for each constituent network function instance in the slice. + +**REQ-TRA\_CON\_CON -3:** The slice traffic analytics report providing traffic projection for the slice may include the following information: + +- Projected uplink and downlink throughput requirement on each User Plane Function instance (UPF) present in the slice. +- Projected number of Packet Data Unit (PDU) session for each Session Management Function (SMF) instance present in the slice. +- Projected number of UE or Registered subscriptions for each AMF instance present in the slice. +- Projected maximum packet size for each UPF instance present in the slice. +- Projected UE uplink and downlink throughput requirement per slice on each gNodeB (gNB) instance present in the slice. + +#### 6.11.1.3 Possible Solutions + +##### 6.11.1.3.1 Solution description + +The solution requires MDAS producer to produce slice traffic analytics report providing traffic projections on NFs involved in the slice. Based on the report, configuration for the NFs can be decided. + +##### 6.11.1.3.2 Data required + +The following table shows the data required to generate the traffic analytics report. + +| Data Category | Required Data | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Performance Measurements/KPIs | <p>From each UPF instance in the slice</p> <ul style="list-style-type: none"> <li>- Current Uplink throughput. See 5.4.1.3 in TS 28.552.</li> <li>- Current Downlink throughput. See 5.4.1.4 TS 28.552</li> <li>- Current Maximum packet size</li> </ul> <p>From each gNB instance in the slice</p> <ul style="list-style-type: none"> <li>- Current Uplink UE throughput. See 5.1.1.3 in TS 28.552.</li> <li>- Current Downlink UE throughput. See 5.1.1.3 in TS 28.552.</li> </ul> <p>From each SMF instance in the slice</p> <ul style="list-style-type: none"> <li>- Current Number of PDU session. See 5.2.1 in TS 28.552.</li> </ul> <p>From each AMF instance in the slice</p> <ul style="list-style-type: none"> <li>- Current Number of registered subscriptions. See 5.2.1 in TS 28.552.</li> </ul> | + +### 6.11.1.3.3 Analytics report + +The slice traffic analytics report shall contain the following: + +| Analytics Report of slice traffic projection | Attribute Name | Description | +|----------------------------------------------|---------------------------|----------------------------------------------------------------------------| +| | Slice Identifier | Identifier of the slice for which the report is provided | +| | Projection Timestamp | Provide a particular time stamp for which the projections are provided | +| | Projection Duration | Provides a time duration during which the average projections are provided | +| | For each UPF in the slice | Projected Uplink throughput | +| | | Projected Downlink throughput | +| | | Projected Maximum packet size | +| | For each gNB in the slice | Projected Uplink UE throughput. | +| | | Projected Downlink UE throughput | +| | For each SMF in the slice | Projected Number of PDU session | +| | For each AMF in the slice | Projected Number of registered subscriptions | + +## 6.99 MDA management aspects + +**Editor's Note:** This sub-clause will be put to the end of clause 6 to separate from other categories of issues. The sub-clause number will be revisited before sending the TR for approval. + +### 6.99.1 ML model training for MDA + +#### 6.99.1.1 Use case + +The MDA process may rely on ML technologies. To optimize the accuracy of MDA result, the ML model of the MDA process may need to be trained. + +For training the ML model of the MDA process, the consumer provides the training data including training input and the desired output to the MDAS producer. The MDAS producer classifies the training data and uses the training input and the desired output to train the ML model, i.e., to train the algorithm of the ML model to be able to provide the desired output by analysis of the training input. The MDAS producer provides an ML model training report as one kind of output data to the consumer. + +With a trained ML model for MDA, the MDAS producer can analyze the analytics input and generate the analytics report as output data of the analysis to the consumer. + +The consumer may validate the output data provided by the MDAS producer. The output data to be validated may be the analytics report and/or the ML model training report as described above. The consumer may provide the validation data as feedback to the MDAS producer, and the MDAS producer will use the validation data for further ML model training for MDA with the historical data that are used to generate the validated output data. + +#### 6.99.1.2 Potential requirements + +**REQ-MDA\_MGMT-CON-1** The MDAS producer should have a capability allowing the consumer to train the ML model for MDA. + +**REQ-MDA\_MGMT-CON-2** The MDAS producer should have a capability to provide ML model training report to the consumer. + +**REQ-MDA\_MGMT-CON-3** The MDAS producer should have a capability to receive the validation data from the consumer and train the ML model for MDA based on the received validation data. + +### 6.99.2 Subscription to Management Data Analytics Reports + +#### 6.99.2.1 Use case + +MDAS Producer may provide several management data analysis reports. Multiple users may wish to receive a selection of these reports. + +The user submits a request to MDAS to subscribe to an MDA report. This request may include a filter to specify which subset of management data should be analysed. MDA activates the data collection if it is not already active. + +For all reports, MDA collects data, analyses the data, and generates an analysis report. + +MDA notifies to subscribers when a new or updated analysis report is available. The notification may contain the analytics report, or the notification may contain a link to a location where the report may be retrieved. + +The user may send a request to MDAS to unsubscribe from an MDA report. If no subscribers remain for an MDA report, MDA may decide to deactivate data collection for this report. + +#### 6.99.2.2 Potential requirements + +**REQ-MDA\_SUB-1** The MDAS producer should have a capability to allow an MDAS consumer to subscribe to an analytics report. The subscription request should optionally allow the MDAS consumer to filter the scope of data in the analytics report. + +**REQ-MDA\_SUB-2** The MDAS producer should have a capability to provide the analytics report to subscribed consumers. + +**REQ-MDA\_SUB-3** The MDAS producer should have a capability to allow an MDAS consumer to unsubscribe to an analytics report. + +#### 6.99.2.3 Possible solutions + +Figure 6.99.2.3-1 shows a possible solution. + +![Sequence diagram showing MDAS Consumer and MDAS Producer interaction for subscription management.](5e9af8986a5845504f251d3079da8078_img.jpg) + +This sequence diagram illustrates the interaction between an MDAS Consumer and an MDAS Producer for subscription management. The MDAS Consumer sends a message labeled 'MDAS\_AnalyticsSubscription\_Subscribe/ MDAS\_AnalyticsSubscription\_Unsubscribe' to the MDAS Producer. The MDAS Producer responds with a message labeled '2. MDAS\_AnalyticsSubscription\_Notify'. + +Sequence diagram showing MDAS Consumer and MDAS Producer interaction for subscription management. + +Figure 6.99.2.3-1: Management data analytics subscribe/unsubscribe + +## 6.99.3 Request for Management Data Analytics Reports + +### 6.99.3.1 Use case + +MDA may provide several management data analysis reports. A user may wish to receive one of these reports. + +The user submits a request to MDAS to receive an MDA report. This request may include a filter to specify which subset of management data should be analysed. + +MDA collects data, analyses the data, and sends an analysis report to the user. + +### 6.99.3.2 Potential requirements + +**REQ-MDA\_REQ-1** The MDAS producer should have a capability to allow an MDAS consumer to request an analytics report. The request should optionally allow the MDAS consumer to filter the scope of data in the analytics report. + +**REQ-MDA\_REQ-2** The MDAS producer should have a capability to provide the analytics report to the MDAS consumer. + +### 6.99.3.3 Possible solutions + +Figure 6.99.3.3-1 shows a possible solution. + +![Sequence diagram showing MDAS Consumer and MDAS Producer interaction for data analytics request.](b701cd8c436a2857a615a76a868a3bb7_img.jpg) + +This sequence diagram illustrates the interaction between an MDAS Consumer and an MDAS Producer for a data analytics request. The MDAS Consumer sends a message labeled 'MDAS\_AnalyticsInfo\_Request' to the MDAS Producer. The MDAS Producer responds with a message labeled '2. MDAS\_AnalyticsInfo\_Request response'. + +Sequence diagram showing MDAS Consumer and MDAS Producer interaction for data analytics request. + +Figure 6.99.3.3-1: Network management data analytics request + +## 6.99.4 Confidence indicator in analysis results + +A consumer of MDAS should treat the results of Management Data Analytics with caution. A decision based on analytics should take into account the degree of confidence of the analysis result, especially in the case when multiple analysis results are based on different models or different source data. + +Therefore it is proposed that the result of Management Data Analytics should contain an attribute which indicates the degree of confidence of the analysis. + +NOTE: How to evaluate a degree of confidence and how it should be expressed as an attribute are not addressed in this study. More work is needed in this area. + +--- + +## 7 Conclusions and recommendations + +## Annex <X> (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|----|-----|-----|-------------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2019-09 | SA5#127 | n/a | - | - | - | Initial skeleton | 0.0.0 | | +| 2019-10 | SA5#127 | S5-196752 | - | - | - | pCR Add skeleton of draft TR 28.809 | 0.1.0 | | +| 2019-10 | SA5#127 | S5-196812 | - | - | - | pCR Add overview for MDA | 0.1.0 | | +| 2019-10 | SA5#127 | S5-196877 | - | - | - | pCR Add UC on coverage issue analysis | 0.1.0 | | +| 2019-10 | SA5#127 | S5-196876 | - | - | - | pCR Add use case of MDAS assisted user data congestion analysis | 0.1.0 | | +| 2019-12 | SA5#128 | S5-197807 | - | - | - | pCR on MDA role in management loop | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197710 | - | - | - | pCR on possible solution for coverage issue analysis | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197711 | - | - | - | pCR Add UC on resource utilization optimization | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197707 | - | - | - | pCR Update the overview descriptions of MDAS | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197709 | - | - | - | pCR on RAN user plane congestion | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197714 | - | - | - | pCR on E2E latency analysis as one of the SLS assurance related issues | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197808 | - | - | - | pCR on alarm incident analysis as one of the fault management related issues | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197809 | - | - | - | pCR Add UC on handover optimization | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197810 | - | - | - | pCR Add UC on MDA assisted energy saving | 0.2.0 | | +| 2019-12 | SA5#128 | S5-197832 | - | - | - | pCR Add management interaction with NWDAF | 0.2.0 | | +| 2020-03 | SA5#129e | S5-201315 | - | - | - | pCR Use case and potential solutions of MDA assisted EE | 0.3.0 | | +| 2020-03 | SA5#129e | S5-201491 | - | - | - | pCR Add gNB as the consumer of MDAS | 0.3.0 | | +| 2020-03 | SA5#129e | S5-201492 | - | - | - | pCR Add the use cases related to SLA assurance | 0.3.0 | | +| 2020-03 | SA5#129e | S5-201327 | - | - | - | pCR Addition of resource utilization analysis solution | 0.3.0 | | +| 2020-06 | SA5#131e | S5-203441 | - | - | - | pCR on MDA process | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203442 | - | - | - | pCR Add UC on MDA process training | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203443 | - | - | - | Clarify fault management use case | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203453 | - | - | - | Enhancing the Handover optimization use case in subclause 6.5 | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203206 | - | - | - | pCR solution for handover optimization | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203444 | - | - | - | Add use case and potential solutions of network slice throughput analysis | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203237 | - | - | - | Add use cases of UE uplink/downlink throughput analysis | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203148 | - | - | - | Update resource utilization use case | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203208 | - | - | - | pCR use case for paging optimization | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203209 | - | - | - | pCR use case RAN Node software upgrade | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203446 | - | - | - | pCR addition of network slice load analysis requirements and solution | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203447 | - | - | - | Add use case and potential solutions of cross-slice resource optimization analysis | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203448 | - | - | - | pCR Add UC on MDA assisted SON coordination | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203449 | - | - | - | New use case on Inter-gNB Beam Selection Optimization | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203450 | - | - | - | Add the use case for NAS level congestion control optimization | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203451 | - | - | - | Add use case and potential solutions of KPI anomaly analysis | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203445 | - | - | - | Modification of the resource utilization analysis use case | 0.4.0 | | +| 2020-06 | SA5#131e | S5-203452 | - | - | - | Add use case of jitter analysis | 0.4.0 | | +| 2020-08 | SA5#132e | S5-204559 | - | - | - | pCR Add solution on MDA assisted SON coordination | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204560 | - | - | - | pCR 28.809 Add load balancing optimization use case | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204561 | - | - | - | pCR 28.809 Add use case and potential requirements of mobility performance analysis | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204562 | - | - | - | Update of inter-gNB beam handover use case solution | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204563 | - | - | - | Update of Handover use case solution | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204564 | - | - | - | Update of Handover use case and solution considering user-trajectory info | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204565 | - | - | - | pCR 28.809 Update use case and potential solutions of resource utilization analysis | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204566 | - | - | - | pCR TR 28.809 Further clarifications relating to network resource allocation | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204567 | - | - | - | Update of KPI anomaly analysis use case and solution | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204568 | - | - | - | pCR Rel 17 Add description for analytics report | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204569 | - | - | - | pCR 28.809 Add Subscription to Management Data Analytics Reports | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204249 | - | - | - | pCR 28.809 Add Request for Management Data Analytics Reports | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204247 | - | - | - | pCR 28.809 Editorial improvements | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204570 | - | - | - | pCR 28.809 Add missing abbreviations | 0.5.0 | | +| 2020-08 | SA5#132e | S5-204571 | - | - | - | pCR 28.809 Use case and potential solutions of fault prediction analysis | 0.5.0 | | + +| | | | | | | | | +|---------|----------|-----------|---|---|---|-------------------------------------------------------------------------------------------------|-------| +| 2020-08 | SA5#132e | S5-204254 | - | - | - | pCR 28.809 updating fault analysis use case | 0.5.0 | +| 2020-08 | SA5#132e | S5-204572 | - | - | - | pCR 28.809 updating E2E latency analysis use case | 0.5.0 | +| 2020-08 | SA5#132e | S5-204573 | - | - | - | pCR 28.809 updating network slice throughput analysis use case | 0.5.0 | +| 2020-08 | SA5#132e | S5-204574 | - | - | - | pCR 28.809 Update use case and potential requirements of network slice load analysis | 0.5.0 | +| 2020-08 | SA5#132e | S5-204575 | - | - | - | pCR 28.809 Solution for Paging Optimization | 0.5.0 | +| 2020-08 | SA5#132e | S5-204576 | - | - | - | pCR 28.809 solution for RAN Node software upgrade | 0.5.0 | +| 2020-08 | SA5#132e | S5-204577 | - | - | - | pCR 28.809 MDAS Analysis confidence levels | 0.5.0 | +| 2020-08 | SA5#132e | S5-204578 | - | - | - | pCR 28.809 Add overview of MDA functionality | 0.5.0 | +| 2020-08 | SA5#132e | S5-204251 | - | - | - | pCR 28.809 Add possible solution for NAS congestion control | 0.5.0 | +| 2020-08 | SA5#132e | S5-204579 | - | - | - | pCR 28.809 Add the potential requirements and solutions for service experience related analysis | 0.5.0 | +| 2020-08 | SA5#132e | S5-204580 | - | - | - | Security risk assessment analytics use case | 0.5.0 | +| 2020-08 | SA5#132e | S5-204581 | - | - | - | MDAS assisted network slice traffic projections | 0.5.0 | +| 2020-08 | SA5#132e | S5-204587 | - | - | - | Add potential solutions for the MDA assisted energy saving analysis | 0.5.0 | +| 2020-08 | SA5#132e | S5-204505 | - | - | - | pCR 28.809 Add CN related KPI anomaly analysis | 0.5.0 | +| | | | | | | | | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28810/raw.md b/marked/Rel-16/28_series/28810/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d45aa127989b8ff68eceb053f64b7694ae61bc1a --- /dev/null +++ b/marked/Rel-16/28_series/28810/raw.md @@ -0,0 +1,751 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Study on concept, requirements and solutions for levels of autonomous network; (Release 16 )** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. The "3" and "G" are connected at the top. Below the "P" is a red signal icon consisting of three curved lines. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + +<http://www.3gpp.org> + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 8 | +| 4 Background and concepts ..... | 8 | +| 4.1 Background ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Relevant study in other SDOs or industry parties ..... | 8 | +| 4.1.2.1 Relevant study in automotive industry ..... | 8 | +| 4.1.2.2 Relevant study in GSMA..... | 8 | +| 4.1.2.3 Relevant study in TMF ..... | 8 | +| 4.1.2.4 Relevant study in ITU..... | 9 | +| 4.1.3 Benefits of having autonomous network level ..... | 9 | +| 4.2 Concept of network autonomy ..... | 9 | +| 4.3 Concept of network autonomy level ..... | 9 | +| 4.4 Potential dimensions for classification of network autonomy ..... | 10 | +| 4.4.1 Introduction ..... | 10 | +| 4.4.2 Workflow..... | 10 | +| 4.4.3 Management scope ..... | 10 | +| 4.4.4 Scenarios..... | 11 | +| 5 Use cases..... | 11 | +| 5.1 Fault recovery use case example for network autonomy level ..... | 11 | +| 5.1.1 Introduction ..... | 11 | +| 5.1.2 Entire workflow ..... | 11 | +| 5.1.3 Potential classification of network autonomy for fault recovery ..... | 12 | +| 5.2 Network optimization use case example for classification of network autonomy..... | 13 | +| 5.2.1 Coverage optimization use case example for classification of network autonomy..... | 13 | +| 5.2.1.1 Introduction ..... | 13 | +| 5.2.1.2 Entire workflow..... | 13 | +| 5.2.1.3 Potential classification of network autonomy for coverage optimization..... | 14 | +| 5.2.2 Capacity optimization use case example for classification of network autonomy..... | 15 | +| 5.2.2.1 Introduction..... | 15 | +| 5.2.2.2 Entire workflow ..... | 15 | +| 5.2.2.3 Potential classification of network autonomy for capacity optimization ..... | 16 | +| 5.3 RAN NE provisioning use case example for classification of network autonomy ..... | 17 | +| 5.3.1 Introduction ..... | 17 | +| 5.3.2 Entire workflow ..... | 17 | +| 5.3.3 Potential classification of network autonomy for RAN NE provisioning ..... | 17 | +| 5.4 Multi-domain/layer/technology management service coordination automation use case example..... | 19 | +| 6 Potential solutions ..... | 20 | +| 6.1 Potential solutions for network autonomy level..... | 20 | +| 6.1.1 Introduction ..... | 20 | +| 6.1.2 Framework approach for classification of autonomous network level ..... | 20 | +| 6.2 Potential requirements for standardized features ..... | 21 | +| 6.2.1 Introduction ..... | 21 | +| 6.2.2 Potential relation with autonomous network related standardized features and interfaces ..... | 22 | +| 6.2.3 Potential solutions for autonomous network related standardized features ..... | 23 | + +7 Conclusion and recommendation................................................................................................................................ 23 + +**Annex A: Change history 24** + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the background, concept, definition and classification of network autonomy levels, typical scenarios for managing network and service which need autonomous support, the potential requirement and solutions and recommendation for the way forward in normative work. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] SAE J3016\_201401: "Taxonomy and Definitions for Terms Related to On-Road Motor Vehicle Automated Driving Systems". +- [3] GSMA: "AI & Automation: An Overview", <https://www.gsma.com/futurenetworks/wiki/ai-automation-an-overview/>. +- [4] TMF: "A whitepaper of autonomous networks: empowering digital transformation for the telecoms industry", <https://www.tmforum.org/wp-content/uploads/2019/05/22553-Autonomous-Networks-whitepaper.pdf>. +- [5] 3GPP TR 28.812: "Telecommunication management; Study on scenarios for Intent driven management services for mobile networks". +- [6] 3GPP TS 28.313: "Self-Organizing Networks (SON) for 5G networks". +- [7] 3GPP TR 28.809: "Study on enhancement of management data analytics". +- [8] 3GPP TS 28.535: "Management services for communication service assurance; Requirements". +- [9] ITU-T Y.3173: "Framework for evaluating intelligence levels of future networks including IMT-2020". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +**Intent:** See definition in TR 28.812[5]. + +## 3.2 Symbols + +Void + +## 3.3 Abbreviations + +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]. + +<ABBREVIATION> <Expansion> + +# --- 4 Background and concepts + +## 4.1 Background + +### 4.1.1 Overview + +Autonomous network is one of the important topics in 5G network. Complexity of 5G network increases with large number of devices and diversity of services. Different autonomous mechanisms are introduced by the industry to reduce the complexity of mobile network and service management. Different autonomous mechanisms in the networks may lead to different capabilities of autonomy and different performance on network and service management, which may lead to different autonomous networks levels. + +### 4.1.2 Relevant study in other SDOs or industry parties + +#### 4.1.2.1 Relevant study in automotive industry + +In 2014, the Society of Automotive Engineers (SAE) proposed the automatic driving levels in [2], clarifying the 6-level automatic driving rating standard (L0 ~ L5). The SAE J3016 scheme determines the automatic driving level by evaluating the participation degree of the driver and the automatic driving system from four evaluation dimensions: motion control (acceleration/deceleration/steering), driving environment monitoring, fallback performance of dynamic driving task, and system capability (driving modes). The SAE J3016 has been widely accepted by the automotive industry and applied to industry analysis, product planning, and been used for guiding the automotive industry to carry out five stages of work to achieving full automatic driving. + +SAE J3016 provides a helpful reference to telecommunications industry for the study of autonomous networks levels. However, there are some fundamental differences between the automotive industry and telecommunication networks, thus the classification of network autonomy levels and automatic driving levels is different as well. + +#### 4.1.2.2 Relevant study in GSMA + +The transformation from “no intelligence” to “full intelligence” is considered to be a long term with a step-by-step process and introducing automation with AI abilities into network can bring value to operators. GSMA calls for a harmonized classification system and supporting definitions regarding intelligent network, see [3]. A harmonized classification system of intelligent network is considered to be helpful to define the concept, levels of intelligent network, describe categorical distinction and educate a broader community while a network automation system is engaged. + +GSMA is interested on this topic and encourage relevant studies. + +#### 4.1.2.3 Relevant study in TMF + +Similar with [3], a harmonized classification system and supporting definitions for autonomous networks is delivered in [4]. The following factors of autonomous networks are introduced for evaluation of autonomous networks levels: execution, awareness, analysis, decision, intent/experience, applicability. + +The following levels of autonomous networks are described as well: level 0 - manual management, level 1 - assisted management, level 2 - partial autonomous network, level 3 - conditional autonomous network, level 4 - high autonomous network, level 5 - full autonomous network. + +#### 4.1.2.4 Relevant study in ITU + +A framework for evaluating intelligence of future networks including IMT-2020 is specified in Recommendation ITU-T Y.3173 [9]. A method for evaluating intelligence level and an architecture view for evaluating network intelligence level are introduced. The following dimensions for evaluating network intelligence level are identified: demand mapping, data collection, analysis, decision, action implementation. The following network intelligence levels are specified: + +- L0: Manual network operation +- L1: Assisted network operation +- L2: Preliminary intelligence +- L3: Intermediate intelligence +- L4: Advanced intelligence +- L5: Full intelligence + +### 4.1.3 Benefits of having autonomous network level + +As described in clause 4.1.2.1, the document of SAE J3016 [2] has been widely applied to automobile industry analysis, consulting of motor vehicle products planning, and also been used for guiding the automotive industry to carry out five stages of work to achieving full automatic driving. + +Similar to what SAE J3016 means to the automotive industry, a common understanding of the levels of autonomous network will be helpful to the telecommunications industry. The operator's operational and management efforts and dedicated relevant resources will vary according to different autonomous networks levels. It would be beneficial for operators to have clear view on the expectation of the level of their network (s) to indicate the maturity of the network autonomy, so that they could first focus on the important features which should be prioritized to achieve certain level of autonomy in their networks. This approach will help operators to smoothly migrate to a higher autonomy level and a better operational efficiency. + +Having autonomous network level has the following benefits: + +- Providing evaluation basis for measuring the level of an autonomous network along with its components and workflows. +- Providing reference for gaps and priorities analysis for standardization works on network autonomy. +- Providing guidance to operators, vendors and other participants of telecommunications industry for roadmap planning. + +## 4.2 Concept of network autonomy + +Network autonomy describes the telecom system (including management system and network) capability which is able to be governed by itself with minimal to no human intervention. Some features discussed in 3GPP are related to network autonomy. Following are some examples: + +- Self-Organizing Network (SON) +- Management data analytics +- Intent driven management +- Close loop SLS assurance + +## 4.3 Concept of network autonomy level + +Network autonomy level describes the level of application of autonomy capabilities in the network management workflow. The participation of the human and telecom system in the network management workflow are important factors to evaluate the network autonomy level. For each network autonomy level, which tasks can be performed by telecom system, which tasks can be performed by human, and which tasks can be performed by cooperation of human and telecom system needs to be clarified. For example, in the highest autonomy level, all tasks are performed by telecom system. + +## 4.4 Potential dimensions for classification of network autonomy + +### 4.4.1 Introduction + +This clause describes the potential dimensions for classification of network autonomy. + +### 4.4.2 Workflow + +Workflow is used to describe the necessary steps to fulfil certain management purposes. A workflow is composed of one or more management tasks. The autonomy capabilities of the tasks in the workflow may impact the network autonomy level. + +Following are the potential categorization of the tasks in a workflow: + +- **Intent translation:** The group of tasks which translate network or service intent from operator or customer into detailed management operations which may affect one or more of the following groups of tasks, i.e. awareness, analysis, decision, execution. +- **Awareness:** The group of tasks which monitor network by collecting network information. +- **Analysis:** The group of tasks which analyse the collected information (e.g. information about network status, network issues and so on) or based on the historical data to further predict the future change trend of the above network status, and make recommendation for decision. +- **Decision:** The group of tasks which decide the necessary management operation for execution, e.g. network configuration or adjustment. +- **Execution:** The group of tasks which execute the management operations. + +Figure 4.4.2-1 illustrate the general workflow for network autonomy. + +![Figure 4.4.2-1: General workflow for network autonomy. The diagram shows a flow starting from Operator/Customer (Intent) to Intent translation, which then leads to a Workflow containing Awareness, Analysis, Decision, and Execution. The Execution step leads to Managed Entity, which then feeds back into the Awareness step.](4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg) + +``` +graph TD; OC([Operator/Customer]) -- Intent --> IT[Intent translation]; subgraph Workflow; IT --> A[Awareness]; A --> AN[Analysis]; AN --> D[Decision]; D --> E[Execution]; end; E --> ME([Managed Entity]); ME --> A; +``` + +Figure 4.4.2-1: General workflow for network autonomy. The diagram shows a flow starting from Operator/Customer (Intent) to Intent translation, which then leads to a Workflow containing Awareness, Analysis, Decision, and Execution. The Execution step leads to Managed Entity, which then feeds back into the Awareness step. + +Figure 4.4.2-1: General workflow for network autonomy + +### 4.4.3 Management scope + +The network autonomy can be implemented in different management scopes, the complexity of network autonomy depends on the management scope. For example, it will be more challenge for the telecom system to achieve the network autonomy on cross domain layer than domain layer, because more autonomy mechanism needs to be introduced for the coordination between different domains. + +Following are potential scopes of network autonomy: + +- Autonomy in NE layer, which means the autonomy mechanism is executed in the NE. +- Autonomy in domain layer, which means the autonomy mechanism is executed in the MnF(s) in domain. +- Autonomy in cross domain layer, which means the autonomy mechanism is executed in the MnF(s) in cross domain. +- Autonomy in communication service layer, how to execute the autonomy mechanism in communication service layer is FFS. + +![Figure 4.4.3-1: Autonomy for different management scope. A diagram showing four concentric circles representing different levels of network autonomy. The innermost circle is labeled 'Autonomy in NE layer'. The next circle out is labeled 'Autonomy in domain layer'. The third circle is labeled 'Autonomy in cross domain layer'. The outermost circle is labeled 'Autonomy in communication service layer'.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +The diagram consists of four concentric circles, each representing a different management scope for network autonomy. The innermost circle is the smallest and is labeled "Autonomy in NE layer". The second circle is larger and labeled "Autonomy in domain layer". The third circle is larger still and labeled "Autonomy in cross domain layer". The outermost circle is the largest and is labeled "Autonomy in communication service layer". All circles are centered on the same point, illustrating that the communication service layer encompasses all other layers. + +Figure 4.4.3-1: Autonomy for different management scope. A diagram showing four concentric circles representing different levels of network autonomy. The innermost circle is labeled 'Autonomy in NE layer'. The next circle out is labeled 'Autonomy in domain layer'. The third circle is labeled 'Autonomy in cross domain layer'. The outermost circle is labeled 'Autonomy in communication service layer'. + +Figure 4.4.3-1: Autonomy for different management scope + +### 4.4.4 Scenarios + +The network autonomy can be implemented for different scenarios, the complexity of network autonomy depends on the detailed scenarios it applied. Also it will be more challenge for the telecom system to achieve the network autonomy for full scenarios than for certain scenarios. For example, autonomy applicability of network deployment will be more challenge for outdoor combine indoor scenario than only outdoor scenario. + +# --- 5 Use cases + +## 5.1 Fault recovery use case example for network autonomy level + +### 5.1.1 Introduction + +Fault recovery use case refers to the entire workflow of network fault management, full autonomy of fault recovery can help the network operator to reduce OPEX by reducing manual involvement in such tasks and to enhance user experience by reducing the time for network fault recovery. However, full autonomy of fault recovery is a long term goal, it will be beneficial for operator to achieve this goal step by step and have clear view on which typical issues can be addressed by utilizing network autonomy mechanism in corresponding steps. + +### 5.1.2 Entire workflow + +The entire workflow of fault recovery is as following: + +- **Task A:** Fault recovery intent translation. The task which translate the fault recovery intent to the detailed fault management operations. + +NOTE: The examples of fault recovery intent are alarm compression rate increasing, fault recovery response time reducing, etc. + +- **Task B:** Fault related information collection. The task which collect the alarm information and other fault related information (e.g. performance information and configuration information etc.). +- **Task C:** Alarm filtering. The task which filter the alarms collected in Task B based on the filtering rules specified. A single network fault may generate a large number of correlative alarms over space and time, therefore it is considered advantageous to have methods filtering the redundant alarms. Reporting only effective alarms without redundant alarms would improve the efficiency of alarm management. +- **Task D:** Fault recognition. The task which recognize or predict the fault and its category based on the alarm information and other fault related information. +- **Task E:** Fault root cause analysis (RCA). The task which analyse the detailed root cause of the network fault. +- **Task F:** Fault recovery mechanism analysis. The task which analyse the possible fault recovery mechanisms and corresponding solutions for support of maintenance based on the fault root cause, thereby generate the feasible options (e.g. recovery procedures). +- **Task G:** Fault recovery action generation. The task which determine the fault recovery action. +- **Task H:** Fault recovery execution. The task which execute the fault recovery actions (e.g. reconfiguring the network), and other corresponding actions (e.g. clearing of alarms, storage and retrieval of alarms). + +### 5.1.3 Potential classification of network autonomy for fault recovery + +Each of the detailed task in clause 5.1.2 can be accomplished either manually by the operator or automatically by the telecom system. Following are the potential classifications of network autonomy for fault recovery based on the participation degree of the human operator and the telecom system: + +Level 0: + +- All the tasks in the fault recovery workflow in clause 5.1.2 are accomplished by human. + +Level 1: + +- Fault related information are collected (Task B) automatically by telecom system based on human predefined rules. Fault recovery actions (Task H) which can be executed without human intervention (e.g. system initialisations, activation of a backup or fall back software load) are triggered by human and executed by telecom system based on human defined execution rules. +- All the other tasks in the fault recovery workflow are accomplished by human. + +Level 2: + +- Compared to Level 1, telecom system additionally assist human operator to filter the alarms (Task C) based on the filtering rules predefined by human operator. Fault recovery execution (only for the actions that can be executed without human intervention) (Task H) are triggered by human and fully executed by telecom system based on human defined rules. +- All the other tasks (Task A, Task D, Task E, Task F and Task G) are accomplished by human. + +Level 3: + +- Compared to Level 2, telecom system can additionally identify the fault domain and type (Task D except for fault prediction) and analyse the root cause of the network fault (Task E). For certain network faults, telecom system can accomplish the fault recovery mechanism analysis (Task F) and action generation (Task G) based on the fault recovery policies pre-defined and specified by human. + +- Fault recovery intent translation (Task A) is accomplished by human, and all the other tasks (Task F and Task G) are accomplished by human operator for most of the faults except several conventional ones. + +#### Level 4: + +- Compared to Level 3, the fault recovery mechanism analysis (Task F) and action generation (Task G) are accomplished automatically by telecom system without human intervention. Telecom system also can predict the fault based on service performance (e.g. QoE, call drop ratio, user experience). For certain scenario, telecom system additionally assist human operator to translate the fault recovery intent to the detailed fault recovery policies (Task A) based on human predefined policies. +- Intent translation policies can be pre-defined and specified by human. + +#### Level 5: + +- The entire fault RCA and recovery workflow is accomplished automatically by telecom system without human intervention and human predefined rules or policies. +- Human can but not have to supervise the fault recovery decision generated by telecom system. + +Figure 5.1.3-1 illustrate the classification of network autonomy for fault recovery. + +| | Intent translation | Awareness | Analysis | | | Decision | Execution | | +|----|-------------------------------------------|----------------------------------------------|-------------------------|---------------------------|-------------------|-------------------------------------------|------------------------------------------|----------------------------------| +| L0 | Task A: Fault recovery intent translation | Task B: Fault related information collection | Task C: Alarm filtering | Task D: Fault recognition | Task E: Fault RCA | Task F: Fault recovery mechanism analysis | Task G: Fault recovery action generation | Task H: Fault recovery execution | +| L1 | Task A: Fault recovery intent translation | Task B: Fault related information collection | Task C: Alarm filtering | Task D: Fault recognition | Task E: Fault RCA | Task F: Fault recovery mechanism analysis | Task G: Fault recovery action generation | Task H: Fault recovery execution | +| L2 | Task A: Fault recovery intent translation | Task B: Fault related information collection | Task C: Alarm filtering | Task D: Fault recognition | Task E: Fault RCA | Task F: Fault recovery mechanism analysis | Task G: Fault recovery action generation | Task H: Fault recovery execution | +| L3 | Task A: Fault recovery intent translation | Task B: Fault related information collection | Task C: Alarm filtering | Task D: Fault recognition | Task E: Fault RCA | Task F: Fault recovery mechanism analysis | Task G: Fault recovery action generation | Task H: Fault recovery execution | +| L4 | Task A: Fault recovery intent translation | Task B: Fault related information collection | Task C: Alarm filtering | Task D: Fault recognition | Task E: Fault RCA | Task F: Fault recovery mechanism analysis | Task G: Fault recovery action generation | Task H: Fault recovery execution | +| L5 | Task A: Fault recovery intent translation | Task B: Fault related information collection | Task C: Alarm filtering | Task D: Fault recognition | Task E: Fault RCA | Task F: Fault recovery mechanism analysis | Task G: Fault recovery action generation | Task H: Fault recovery execution | + +| | | +|--|------------------------------------------------------------------------------| +| | Task accomplished by human | +| | Task accomplished by telecom system based on human defined rules or policies | +| | Task accomplished by telecom system without human intervention | + +Figure 5.1.3-1: Classification of network autonomy for fault recovery + +## 5.2 Network optimization use case example for classification of network autonomy + +### 5.2.1 Coverage optimization use case example for classification of network autonomy + +#### 5.2.1.1 Introduction + +Coverage is critical for good user experience, however, coverage optimization is complexity. Full autonomy of coverage optimization for whole network is a long term goal, it will be beneficial for operator to achieve this goal step by step and have clear view on which typical issues can be addressed by utilizing network autonomy mechanism in corresponding steps. + +#### 5.2.1.2 Entire workflow + +Following are the entire workflow for the radio network coverage optimization: + +- **Task A:** Coverage requirements determination. The tasks of determining the coverage requirements (e.g. coverage area, weak coverage ratio) based on service assurance intent specified by customer. +- **Task B:** Coverage optimization policies determination. The tasks of determining the coverage optimization related policies (e.g., weak coverage analysis policies, weak coverage optimization policies). +- **Task C:** Coverage related information collection. The tasks of collecting coverage performance data (e.g. measurement data, MDT data). +- **Task D:** Coverage issues identification. The tasks of analysing the coverage performance and identifying the coverage issues (e.g. weak coverage). +- **Task E:** Coverage adjustment solution analysis and generation. The tasks of analysing the cause of the identified coverage issues and generating the coverage adjustment actions. +- **Task F:** Coverage adjustment actions determination. The tasks of deciding the coverage adjustment actions to be executed. +- **Task G:** Coverage adjustment actions execution (e.g. selection of coverageShape, digitalTilt and digitalAzimuth). The tasks of adjusting and configuring the coverage related parameters. + +#### 5.2.1.3 Potential classification of network autonomy for coverage optimization + +##### Level 0: + +- All the tasks in the radio network coverage optimization workflow (Task A, Task B, Task C, Task D, Task E, Task F, Task G) are accomplished by human. + +##### Level 1: + +- Telecom system executes the tasks of adjusting and configuring coverage related parameters (e.g. coverageShape, digitalTilt and digitalAzimuth) based on coverage related parameters specified by human (Task G). Telecom system also can execute the tasks of collecting coverage related data (e.g. measurement data, MDT data and trace data) based on collection rule specified by human (Task C). +- All the other tasks in the radio network coverage optimization workflow (Task A, Task B, Task D, Task E, Task F) are accomplished by human. + +##### Level 2: + +- Compared to Level 1, telecom system can analyse the coverage performance and identify the coverage issue based on the coverage issue rule specified by human (Task D). +- All the other tasks in the radio network coverage optimization workflow (Task A, Task B, Task E, Task F) are accomplished by human. + +##### Level 3: + +- Compared to Level 2, telecom system additionally executes the tasks of analysing the coverage optimization solution (Task E) and determining the coverage adjustment actions (Task F) to be executed based on coverage requirements and/or optimization policies specified by human. +- All the other tasks in the radio network coverage optimization workflow (Task A, Task B) are accomplished by human. + +##### Level 4: + +- Compared to Level 3, the telecom system additionally executes the tasks of determining coverage optimization policies (e.g., weak coverage cause analysis policies, weak coverage adjustment policies) (Task B). For certain scenarios, the telecom system can determine the coverage requirements (e.g. coverage area, weak coverage ratio) based on service assurance intent. +- The intent translation policies maybe pre-defined and specified by human to assist the telecom system. + +##### Level 5: + +- Telecom system can autonomously execute the entire workflow of radio network coverage optimization for all scenarios, which means the telecom system can achieve the full autonomy for radio network coverage optimization for full scenarios. + +![Figure 5.2.1.3-1: Classification of network autonomy for radio network coverage optimization. A table showing levels L0 to L5 across five stages: Intent translation, Awareness, Analysis, Decision, and Execution. Tasks A-G are listed for each level, with color coding indicating human vs. system accomplishment.](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +| | Intent translation | | Awareness | Analysis | | Decision | Execution | +|----|---------------------------------------------|------------------------------------------------------|-------------------------------------------------|----------------------------------------|--------------------------------------------------------------|---------------------------------------------------|----------------------------------------------| +| L0 | Task A: Coverage requirements determination | Task B: Coverage optimization policies determination | Task C: Coverage related information collection | Task D: Coverage issues identification | Task E: Coverage adjustment solution analysis and generation | Task F: Coverage adjustment actions Determination | Task G: Coverage adjustment action execution | +| L1 | Task A: Coverage requirements determination | Task B: Coverage optimization policies determination | Task C: Coverage related information collection | Task D: Coverage issues identification | Task E: Coverage adjustment solution analysis and generation | Task F: Coverage adjustment actions Determination | Task G: Coverage adjustment action execution | +| L2 | Task A: Coverage requirements determination | Task B: Coverage optimization policies determination | Task C: Coverage related information collection | Task D: Coverage issues identification | Task E: Coverage adjustment solution analysis and generation | Task F: Coverage adjustment actions Determination | Task G: Coverage adjustment action execution | +| L3 | Task A: Coverage requirements determination | Task B: Coverage optimization policies determination | Task C: Coverage related information collection | Task D: Coverage issues identification | Task E: Coverage adjustment solution analysis and generation | Task F: Coverage adjustment actions Determination | Task G: Coverage adjustment action execution | +| L4 | Task A: Coverage requirements determination | Task B: Coverage optimization policies determination | Task C: Coverage related information collection | Task D: Coverage issues identification | Task E: Coverage adjustment solution analysis and generation | Task F: Coverage adjustment actions Determination | Task G: Coverage adjustment action execution | +| L5 | Task A: Coverage requirements determination | Task B: Coverage optimization policies determination | Task C: Coverage related information collection | Task D: Coverage issues identification | Task E: Coverage adjustment solution analysis and generation | Task F: Coverage adjustment actions Determination | Task G: Coverage adjustment action execution | + +Legend: + +- Task accomplished by human (White) +- Task accomplished by telecom system based on human defined rules or policies (Light Green) +- Task accomplished by telecom system without human intervention (Dark Green) + +Figure 5.2.1.3-1: Classification of network autonomy for radio network coverage optimization. A table showing levels L0 to L5 across five stages: Intent translation, Awareness, Analysis, Decision, and Execution. Tasks A-G are listed for each level, with color coding indicating human vs. system accomplishment. + +Figure 5.2.1.3-1: Classification of network autonomy for radio network coverage optimization + +*Editor's Note: The relation of above classification of network autonomy for radio network coverage optimization and Framework approach for classification of network autonomy level defined in Clause 6.1.2 is FFS.* + +### 5.2.2 Capacity optimization use case example for classification of network autonomy + +#### 5.2.2.1 Introduction + +Network resources, especially radio resources are limited. In order to utilize radio resources in the most efficient way and improve user service experience, it is important to achieve higher system capacity by distributing user traffic across the system radio resources. Currently the flow of traffic simply follows the physical topology of the network or network slice, or static radio resource management policies, and resource usage may be unreasonable. Autonomous capacity optimization can help to improve resource usage efficiency greatly by taking into account the traffic steering when scheduling the network or network slice. For example, by creating a traffic prediction model, 3GPP management system can provide precise traffic prediction and the optimal network topology and traffic distribution. + +#### 5.2.2.2 Entire workflow + +The entire workflow of capacity optimization is as following: + +- **Task A:** Capacity optimization intent translation. Translate the intent to the capacity optimization target information (e.g., capacity planning data, network topology, traffic model, etc.). +- **Task B:** Capacity information collection. Collect the current and historical performance data related to resource usage (e.g., PRB usage, RRC connection number, QoS flows, etc.) and network traffic (e.g., composite available capacity per cell (DL/UL), cell level load (DL/UL/SUL), TNL Load, etc.) for the network. +- **Task C:** Capacity data analysis. Analyse the current and historical performance data related to resource usage and network traffic for the network or network slices. +- **Task D:** Capacity issues identification and/or prediction. Identify the ongoing issues on resource utilization and predict the potential issues, and generate the capacity or resource utilization possible solutions (e.g., RRM policy adjustment, user migration, handover policy adjustment). +- **Task E:** Capacity optimization decision. Decide recommended solutions to optimize capacity and resource utilization. + +- **Task F:** Capacity optimization execution. Apply capacity optimization solutions to telecom system (e.g., configuration of parameters and/or policies). + +#### 5.2.2.3 Potential classification of network autonomy for capacity optimization + +Each of the detailed tasks in clause 5.2.2.2 can be accomplished either manually by the operator or automatically by the telecom system. Following are the potential classifications of network autonomy for capacity optimization based on the participation degree of the human operator and the telecom system: + +##### Level 0: + +All the tasks in the capacity optimization workflow are accomplished by human. + +##### Level 1: + +- Capacity related information is collected (Task B) automatically by telecom system based on human predefined rules or configurations. Capacity optimization solutions can be triggered by human and executed by telecom system based on human-defined rules (Task F). +- All the other tasks in the capacity optimization workflow are accomplished by human. + +##### Level 2: + +- Compared to Level 1, telecom system additionally assists human to execute tasks of analysing the current and historical performance data (Task C) related to resource usage and network traffic for the network or network slices, and identifying the ongoing issues on resource utilization and predict the potential issues (Task D) based on human-defined rules. Capacity optimization solutions (Task F) are executed by telecom system without human intervention. +- Task A and Task E are accomplished by human. + +##### Level 3: + +- Compared to Level 2, the telecom system can automatically collect the current and historical performance data related to resource usage and network traffic (Task B). Telecom system could additionally assist human to review the capacity optimization solutions (Task E), which will finally be decided by human (operator). +- Task A is accomplished by human. + +##### Level 4: + +- Compared to Level 3, the capacity data analysis (Task C), capacity issues identification and/or prediction (Task D), and decision making (Task E) are accomplished automatically by telecom system without human intervention. Telecom system could additionally assist human to translate the intent to capacity optimization target information (Task A). +- The intent translation policies may be pre-defined and specified by human to assist the telecom system. + +##### Level 5: + +- The entire workflow of capacity optimization is accomplished automatically by telecom system without human intervention and human-defined rules. + +Figure 5.2.2.3 -1 illustrate the classification of network autonomy for capacity optimization. + +| | Intent translation | Awareness | Analysis | | Decision | Execution | +|----|--------------------------------------------------|-----------------------------------------|--------------------------------|----------------------------------------------------------|----------------------------------------|-----------------------------------------| +| L0 | Task A: Capacity optimization intent translation | Task B: Capacity information collection | Task C: Capacity data analysis | Task D: Capacity issues identification and/or prediction | Task E: Capacity optimization decision | Task F: Capacity optimization execution | +| L1 | Task A: Capacity optimization intent translation | Task B: Capacity information collection | Task C: Capacity data analysis | Task D: Capacity issues identification and/or prediction | Task E: Capacity optimization decision | Task F: Capacity optimization execution | +| L2 | Task A: Capacity optimization intent translation | Task B: Capacity information collection | Task C: Capacity data analysis | Task D: Capacity issues identification and/or prediction | Task E: Capacity optimization decision | Task F: Capacity optimization execution | +| L3 | Task A: Capacity optimization intent translation | Task B: Capacity information collection | Task C: Capacity data analysis | Task D: Capacity issues identification and/or prediction | Task E: Capacity optimization decision | Task F: Capacity optimization execution | +| L4 | Task A: Capacity optimization intent translation | Task B: Capacity information collection | Task C: Capacity data analysis | Task D: Capacity issues identification and/or prediction | Task E: Capacity optimization decision | Task F: Capacity optimization execution | +| L5 | Task A: Capacity optimization intent translation | Task B: Capacity information collection | Task C: Capacity data analysis | Task D: Capacity issues identification and/or prediction | Task E: Capacity optimization decision | Task F: Capacity optimization execution | + +Image: Legend for network autonomy levels: White box = Task accomplished by human; Light green box = Task accomplished by telecom system based on human defined rules or policies; Dark green box = Task accomplished by telecom system without human intervention. + +Task accomplished by human +Task accomplished by telecom system based on human defined rules or policies +Task accomplished by telecom system without human intervention + +**Figure 5.2.2.3 -1: Classification of network autonomy for capacity optimization** + +*Editor's Note: The relation of above classification of network autonomy for radio network capacity optimization and framework approach for classification of network autonomy level defined in Clause 6.1.2 is FFS.* + +## 5.3 RAN NE provisioning use case example for classification of network autonomy + +### 5.3.1 Introduction + +RAN NE provisioning use case refers to the entire workflow of deploying an RAN NE, full autonomy of RAN NE provisioning can help the network operator to reduce OPEX by reducing manual involvement in such tasks. However, full autonomy of RAN NE provisioning is a long term goal, it will be beneficial for operator to achieve this goal step by step and have clear view on which typical issues can be addressed by utilizing network autonomy mechanism in corresponding steps. + +### 5.3.2 Entire workflow + +Following are the entire workflow for RAN NE provisioning: + +- **Task A:** RAN NE provisioning decision making. +- **Task B:** RAN NE planning data determination, the tasks of analysing and determining the network planning data (i.e. radio planning data, transport planning data) for the new RAN NE to be provisioned. +- **Task C:** RAN NE configuration data generation, the tasks of generating the network configuration data for the RAN NE based on the network planning data for the RAN NE and hardware information collected. +- **Task D:** RAN NE connection and hardware information collection, the tasks of connecting the RAN NE to the management system (including NE acquire its IP address and corresponding management system IP address) and collecting the RAN NE information (e.g. hardware information). +- **Task E:** RAN NE configuration data and software download and activation, the tasks of downloading and activating network configuration data and software in RAN NE. +- **Task F:** RAN NE verification, the tasks of performing the RAN NE verification (e.g. RAN NE test). + +### 5.3.3 Potential classification of network autonomy for RAN NE provisioning + +Following are the potential classification of network autonomy for RAN NE provisioning: + +#### Level 0: + +- All the tasks in the RAN NE provisioning workflow (Task A, Task B, Task C, Task D, Task E, Task F) are accomplished by human. + +#### Level 1: + +- Telecom system executes tasks of downloading and activating the available RAN NE network configuration data (i.e. transport and radio configuration data) and software prepared by human (Task E). +- Human makes the RAN NE provisioning decision and prepares the network configuration data for the RAN NE (Task A, Task B, Task C). Human connects the RAN NE to the management system and collects the RAN NE information (Task D). Human performs the RAN NE verification (Task F). + +#### Level 2: + +- Compared to Level 1, telecom system additionally executes the tasks of connecting RAN NE to the management system and collecting the RAN NE information (Task D). +- Human makes the RAN NE provisioning decision and prepares the network configuration data for the RAN NE (Task A, Task B, Task C). Human performs the RAN NE verification (Task F). + +#### Level 3: + +- Compared to Level 2, based on the network configuration data generation policies specified by human, the telecom system additionally executes tasks of analysing and determining the network configuration data for the RAN NE according to the network planning data specified by human (Task C). Telecom system also can execute tasks of performing the RAN NE verification (e.g. RAN NE test) (Task F) based on test policies specified by human. +- Human makes the RAN NE provisioning decision and prepares the network planning data (Task A and Task B). Human pre-defines the network configuration data generation policies. + +#### Level 4: + +- Compared to Level 3, for certain scenarios, the telecom system additionally execute the task of making the RAN NE provisioning decision (Task A), analysing and determining network planning data (i.e. radio planning data, transport planning data) for the RAN NE to be provisioned (Task B) based on radio network deployment intent (e.g. provisioning radio network in certain area with network characteristics or SLA specified). +- The intent translation policies maybe pre-defined and specified by human. + +#### Level 5: + +- Telecom system can autonomously execute the entire workflow of provisioning an RAN NE for all scenarios, which means the telecom system can achieve the full autonomy for RAN NE provisioning. + +![Figure 5.3.3-1: Classification of network autonomy for RAN NE provisioning. A table showing levels L0 to L5 across four categories: Intent translation, Awareness, Analysis and decision, and Execution. Tasks A-F are listed, with colors indicating human, system-based, or fully autonomous accomplishment.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +| | Intent translation | | Awareness | | Analysis and decision | | Execution | | +|----|---------------------------------------------|--------------------------------------------|---------------------------------------------------------------|----------------------------------------------|-----------------------------|------------------------------------------------------------------------|-----------|--| +| L0 | Task A: RAN NE provisioning decision making | Task B: RAN NE planning data determination | Task D: RAN NE connection and hardware information collection | Task C: RAN NE configuration data generation | Task F: RAN NE verification | Task E: RAN NE configuration data and software download and activation | | | +| L1 | Task A: RAN NE provisioning decision making | Task B: RAN NE planning data determination | Task D: RAN NE connection and hardware information collection | Task C: RAN NE configuration data generation | Task F: RAN NE verification | Task E: RAN NE configuration data and software download and activation | | | +| L2 | Task A: RAN NE provisioning decision making | Task B: RAN NE planning data determination | Task D: RAN NE connection and hardware information collection | Task C: RAN NE configuration data generation | Task F: RAN NE verification | Task E: RAN NE configuration data and software download and activation | | | +| L3 | Task A: RAN NE provisioning decision making | Task B: RAN NE planning data determination | Task D: RAN NE connection and hardware information collection | Task C: RAN NE configuration data generation | Task F: RAN NE verification | Task E: RAN NE configuration data and software download and activation | | | +| L4 | Task A: RAN NE provisioning decision making | Task B: RAN NE planning data determination | Task D: RAN NE connection and hardware information collection | Task C: RAN NE configuration data generation | Task F: RAN NE verification | Task E: RAN NE configuration data and software download and activation | | | +| L5 | Task A: RAN NE provisioning decision making | Task B: RAN NE planning data determination | Task D: RAN NE connection and hardware information collection | Task C: RAN NE configuration data generation | Task F: RAN NE verification | Task E: RAN NE configuration data and software download and activation | | | + +Legend: + +- Task accomplished by human +- Task accomplished by telecom system based on human defined rules or policies +- Task accomplished by telecom system without human intervention + +Figure 5.3.3-1: Classification of network autonomy for RAN NE provisioning. A table showing levels L0 to L5 across four categories: Intent translation, Awareness, Analysis and decision, and Execution. Tasks A-F are listed, with colors indicating human, system-based, or fully autonomous accomplishment. + +**Figure 5.3.3-1: Classification of network autonomy for RAN NE provisioning** + +*Editor's Note: The relation of above classification of network autonomy for RAN NE provisioning and Framework approach for classification of network autonomy level defined in Clause 6.1.2 is FFS.* + +## 5.4 Multi-domain/layer/technology management service coordination automation use case example + +The goal of this use case is to enable automation of end-to-end joint coordination of management services across multiple domains (e.g. AN, CN), multi-layers (packet and optical transport), and multi-technology (wireless and wireline, x-haul, mobile core, data network, physical and virtual functions). + +The following functions and services are assumed to be deployed and active: + +- NG-RAN, 5GC, NSI(s). +- The performance assurance (PM), fault supervision (FM) and provisioning (CM) services are available across multi-domain, multi-layer, and multi-technology. +- The provider of multi-domain, multi-layer, and multi-technology coordination of management services. + +The provisioning, assurance and supervision services provide information on the multi-domain, layer, and technology, the information characterized by: + +- Status details on domain/layer/technology specific network resources, e.g. NG-RAN and 5GC, packet and transport networks, physical network resources and virtual resources +- Information from one or multiple network slices and slice subnets in relation with multi-domain, layer, and technology +- For each domain, layer, and technology, information on allocated resources and their utilization, event history (e.g. recent orchestration actions taken per domain, layer, and technology), history of actions taken (e.g. recent orchestration actions taken per domain, layer, and technology) + +The provisioning, assurance and supervision services provide information on the multi-domain, layer, and technology, the information characterized by: + +- Status details on domain/layer/technology specific network resources, e.g. NG-RAN and 5GC, packet and transport networks, physical network resources and virtual resources. +- Information from one or multiple network slices and slice subnets in relation with multi-domain, layer, and technology. + +- For each domain, layer, and technology, information on allocated resources and their utilization, event history (e.g. recent orchestration actions taken per domain, layer, and technology), history of actions taken (e.g. recent orchestration actions taken per domain, layer, and technology). + +The following scopes of network autonomy is applied to meet the objectives of automation of the multi-domain, layer, and technology coordination of management services: + +- Network autonomy in NE layer +- Network autonomy in domain layer +- Network autonomy in cross domain layer + +Based on the assumptions described above, the provider of multi-domain, multi-layer, and multi-technology coordination of management services is running jointly with individual coordination providers of domain, layer, and technology to automate end-to-end vertical and horizontal management coordination processes across multiple domain, layers, and technologies. + +The provider of multi-domain, multi-layer, and multi-technology coordination of management services utilizes provisioning, assurance and supervision services to achieve optimal management coordination across multiple domains, layers, and technologies. + +The provider of multi-domain, multi-layer, and multi-technology coordination of management services may utilize AI technologies (e.g. machine learning, deep learning algorithms, etc.) to achieve an optimal coordination. + +The provider of multi-domain, multi-layer, and multi-technology coordination of management services offers management capabilities on the resource parameters configuration. + +The coordination of management services consists of different levels of network autonomy as follows: + +- Automation of coordination across multiple layer, technology, or domain individually. +- Automation of coordination across a combination of multiple-layer and technology, multiple-layer and domain, or multiple-technology and domain. +- Automation of coordination across multiple-layer, technology, and domain as a whole. + +# --- 6 Potential solutions + +## 6.1 Potential solutions for network autonomy level + +### 6.1.1 Introduction + +This clause describes the potential solutions for network autonomy level. + +### 6.1.2 Framework approach for classification of autonomous network level + +According to the potential categorization of the tasks in a general network autonomy workflow, a framework approach for classification of autonomous network level is introduced as following, which is used for evaluating the autonomy capability of telecom system. + +**Table 6.1.2-1: Framework approach for classification of autonomous network level** + +| Network autonomy level | | Task categories | | | | | +|------------------------|---------------------------------|------------------------|------------------------|------------------------|------------------------|------------------------| +| | | Execution | Awareness | Analysis | Decision | Intent translation | +| L0 | Manual operating network | Human | Human | Human | Human | Human | +| L1 | Assisted operating network | Human & Telecom system | Human & Telecom system | Human | Human | Human | +| L2 | Preliminary autonomous network | Telecom system | Human & Telecom system | Human & Telecom system | Human | Human | +| L3 | Intermediate autonomous network | Telecom system | Telecom system | Human & Telecom system | Human & Telecom system | Human | +| L4 | Advanced autonomous network | Telecom system | Telecom system | Telecom system | Telecom system | Human & Telecom system | +| L5 | Full autonomous network | Telecom system | Telecom system | Telecom system | Telecom system | Telecom system | + +Note 1: Human reviewed decision have the highest authority in each level if there is any confliction between human reviewed decision and telecom system generated decision. +Note 2: The present of above five task categories does not reflect the workflow sequence. + +**Level 0 manual operating network:** No categorization of the tasks is accomplished by telecom system itself. + +**Level 1 assisted operating network:** A part of the execution and awareness tasks are accomplished automatically by telecom system itself based on human defined rules. At this level, telecom system can assist human to improve the execution and awareness efficiency. + +**Level 2 preliminary autonomous network:** All the execution tasks are accomplished automatically by telecom system itself. A part of the awareness and analysis tasks are accomplished automatically by telecom system itself based on human defined policies. At this level, telecom system can assist human to achieve the close loop based on human defined policies. + +**Level 3 intermediate autonomous network:** All the execution and awareness tasks are accomplished automatically by telecom system itself. A part of the analysis and decision tasks are accomplished automatically by telecom system itself based on human defined policies. At this level, the telecom system can achieve the close loop automation based on the human defined close loop automation policies. + +**Level 4 advanced autonomous network:** All the execution, awareness, analysis and decision tasks are accomplished automatically by telecom system itself. And intent translation tasks can be partly accomplished automatically by telecom system itself based on human defined intent translation policies. At this level, telecom system can achieve the intent driven close loop automation based on human defined intent translation policies, which means the telecom system can translate the intent to the detailed close loop automation policies based on human defined intent translation policies. + +**Level 5 fully autonomous network:** The entire network autonomy workflow is accomplished automatically by telecom system without human intervention. At this level, telecom system can achieve the whole network autonomy. + +Note: Above framework approach for classification of autonomous network level are applicable for evaluating the autonomous network level from both management scope and scenario perspective. The overall autonomous network level of the whole telecom system is a comprehensive reflection of autonomous network level of the individual management scope and scenarios, which means in fully autonomous network level, the telecom system can achieve the whole network autonomy for all management scopes and scenarios. + +## 6.2 Potential requirements for standardized features + +### 6.2.1 Introduction + +This clause describes the relation among the autonomous network levels and existing standardized features related to autonomous network and the potential requirements for autonomous network related standardized features to enable management use cases to support the expected autonomous network levels. + +### 6.2.2 Potential relation with autonomous network related standardized features and interfaces + +According to Clause 4.4.2 and Clause 6.1, a framework approach for classification of autonomous network level is based on the potential categorization of the tasks in a general network autonomy workflow, i.e. intent translation, awareness, analysis, decision and execution. According to Clause 4.4.3, the network autonomy can be implemented in different management scopes, i.e. NE layer, domain layer, cross domain layer and communication service layer. + +Regarding this general network autonomy workflow and different management scopes, the relation among the autonomous network levels and autonomous network related standardized features is described as following: + +- Standardized features in 3GPP SA WG5 + - Work item 850030 SON\_5G “Self-Organizing Networks (SON) for 5G networks” specified the concepts, use cases, requirements, and procedures for the SON functions in 5GS. As described in Clause 4.1 in TS 28.313 [6], based on the location of the SON algorithm, SON is categorized into four different solutions, i.e. Cross Domain-Centralized SON, Domain-Centralized SON, Distributed SON and Hybrid SON. And the SON algorithm may consist of the functionalities including Monitoring, Analysis, Decision, Execution and Evaluation. The autonomy capabilities of various SON functions in 5GS may be different and therefore lead to different capabilities of autonomy on workflow and management scopes which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for the workflow and management scope capabilities of SON functions. + - Study item 850028 FS\_eMDAS “Study on enhancement of Management Data Analytics Service” studied concepts, process and role of MDAS, the use cases, potential requirements and possible solutions regarding the relation and interaction between MDAS and other NF functionalities are studied as well. It is described in Clause 5.1 in TR 28.809 [7] that the MDA plays the role of Analytics in the management loop and techniques such as AI and ML (e.g., ML model) may be utilized. The autonomy capabilities of various MDAS may be different and therefore lead to different capabilities of autonomy on analytics which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for the analysis capabilities of MDAS. + - Work item 850026 COSLA “Closed loop SLS Assurance” specified a closed loop assurance solution that helps an operator to continuously deliver the expected level of communication service quality. It is described in Clause 4.2 in TS 28.535 [8] that the management control loop for communication service assurance consists of Monitoring, Analysis, Decision and Execution, and in an open control loop, the human operator intervenes in one or more of the process steps of the loop while in a closed control loop, there is no direct involvement of a human operator or other operations system in the control loop. The process steps of the management control loop for communication service are covered by the general network autonomy workflow and the autonomy capabilities of the management control loop may be different and therefore lead to different capabilities of autonomy on awareness, analysis, decision and execution, which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for the management control loop for communication service. + - 5G MDT, Trace, PM, QoE related work items, such as work item 860021 5GMDT “Management of MDT in 5G”, work item 820036 TM\_SBMA “Trace Management in the context of Services Based Management Architecture”, work item 810031 5G\_SLICE\_ePA “Enhancement of performance assurance for 5G networks including network slicing”, work item 760058 QOED “Management of QoE measurement collection”, are relevant with the management of network and service data collection. The autonomy capabilities of these standardized features may be different and therefore lead to different capabilities of autonomy on awareness, which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for these features. + - Work item 820032 eNRM “NRM enhancements” specified the enhancement of NRM for SBA based 5G networks including NF Service Managed Object modelling, NF profile associated to a core control plane NF modelling, and NF & NF Service instance status and registration status modelling. They are relevant with the network and service configuration. The modelling of NRM and autonomy capabilities of the configuration may be different and therefore lead to different capabilities of autonomy on execution, which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for NRM normative work. + - Work item 810027 IDMS\_MN “Intent driven management services for mobile networks” studied intent driven management concept, scenarios and standard consideration for intent driven MnS. Intent translation is + +described in Clause 4.1.4 in TR 28.812 [5]. The Intent driven MnS producer is responsible for receiving intent and translate it to detailed requirements. The autonomy capabilities of various Intent driven MnS producers may be different and therefore lead to different capabilities of autonomy on intent translation, which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for the intent translation capabilities of Intent driven MnS producers. + +- Standardized features in 3GPP SA WG2 + - Work item 830047 eNA “Enablers for Network Automation for 5G” specified architecture enhancements for 5G System to support network data analytics service and framework to enable data collection and provide analytics to consumers. Extensions to NWDAF services to support the analytics that are required for e.g. QoS Profile Provisioning, Traffic Routing, Future Background Data Transfer and Slice SLA, etc. were defined as well. The autonomy capabilities of various NWDAF may be different and therefore lead to different capabilities of autonomy on data collection (i.e. awareness) and analysis which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for the data collection and analysis capabilities of NWDAF. +- Standardized features in 3GPP RAN + - Study item 801000 FS\_LTE\_NR\_data\_collect “Study on RAN-centric Data Collection and Utilization for LTE and NR” and work item 840091 “SON (Self-Organising Networks) and MDT (Minimization of Drive Tests) support for NR” specified the support of SON features, including MRO, MLB, and RACH optimization and MDT (Minimization of Drive Tests) features and L2 measurements as described in TR 37.816, TS 38.314, TS 37.320. TS 38.300, TS38.331, TS38.420, etc. These SON/MDT features are expected and specified to support network autonomy on network awareness (e.g. MDT features support automatic network data collection by measurements enhancement), decision and execution (e.g. MRO, MLB and RACH optimization support automatic UE reporting, inter-node information exchange, interface and network configuration enhancements). The autonomy capabilities of these SON/MDT features may be different and therefore lead to different capabilities of autonomy on awareness, decision and execution, which may lead to different autonomous network levels. On the other hand, different autonomous network levels may lead to different requirements for the SON/MDT features. + +Different autonomous network levels may affect standardized interfaces (i.e. MnS) as well. The higher autonomous network level may request more sufficient network or service data to improve the capability on awareness and request faster configurations to improve the capability on execution, therefore lead to the enhancement of data collection and configuration related interfaces. + +On the other hand, in a multi-vendor scenario, the higher autonomous network level may request simpler standardized interfaces (i.e. MnS) to reduce the interoperability complexity of 5G network management, and improve the network operating efficiency and automation performance. + +### 6.2.3 Potential solutions for autonomous network related standardized features + +*Editor's note: the potential requirements for autonomous network related standardized features to enable management use cases listed in Clause 5 to support the expected autonomous network levels may be added later.* + +# --- 7 Conclusion and recommendation + +*Editor's note: this clause will be used to document the conclusions and recommendation of the study.* + +# Annex A: Change history + +| Change history | | | | | | | | | +|----------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------|----|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2019-10 | SA5#127 | S5-196391 | | | | Study on concept, requirements and solutions for levels of autonomous network | | 0.0.0 | +| 2019-10 | SA5#127 | S5-196323<br>S5-196878<br>S5-196740 | | | | 1. pCR 28.810 Add skeleton<br>2. pCR 28.810 Add background<br>3. pCR 28.810 Add scope | | 0.1.0 | +| 2019-11 | SA5#128 | S5-197811<br><br>S5-197820<br>S5-197821<br>S5-197822<br><br>S5-197812<br><br>S5-197813<br><br>S5-197780<br><br>S5-197676<br>S5-197799<br>S5-197702 | | | | 1. pCR 28.810 addition of multi-domain/layer/technology orchestration automation use case and requirement<br>2. pCR 28.810 Add concept of network autonomy<br>3. pCR 28.810 Add concept of network autonomy level<br>4. pCR 28.810 pCR 28.810 Add potential dimensions for classification of network autonomy level<br>5. pCR 28.810 Add coverage optimization scenario example for classification of network autonomy levels<br>6. pCR 28.810 Add NE deployment scenario example for classification of network autonomy levels<br>7. Add background of relevant study in other SDOs or industry parties<br>8. Add significance for levels of autonomous network<br>9. Add potential solution for network autonomy level<br>10. Add fault RCA and recovery scenario example for network autonomy level | | 0.2.0 | +| 2020-03 | SA5#129e | S5-201324<br><br>S5-201493<br><br>S5-201494<br><br>S5-201495 | | | | 1. pCR 28.810 Update Clause 4.4 Potential dimension for classification of network autonomy<br>2. pCR 28.810 Add capacity optimization scenario for classification of network autonomy level<br>3. Update NE deployment scenario example for classification of network autonomy level<br>4. pCR 28.810 Update Clause 5.1 Fault RCA and recovery scenario example for network autonomy level | | 0.3.0 | +| 2020-04 | SA5#130e | S5-202390<br><br>S5-202391<br><br>S5-202392<br><br>S5-202393<br><br>S5-202394 | | | | 1. pCR 28.810 Update capacity optimization scenario example for network autonomy level<br>2. pCR 28.810 Update Clause 5.3 NE deployment scenario example for classification of network autonomy levels<br>3. pCR 28.810 Update Clause 5.2 Coverage optimization scenario example for classification of network autonomy levels<br>4. pCR 28.810 Update Clause 4.4 Potential dimensions for classification of network autonomy<br>5. pCR 28.810 Update Clause 5.1 Fault RCA and recovery scenario example for classification of network autonomy | | 0.4.0 | +| 2020-06 | SA5#131e | S5-203190<br>S5-203438<br><br>S5-203439 | | | | 1. pCR 28.810 Clean-up<br>2. pCR 28.810 Update Clause 6.1.2 Framework approach for classification of autonomous<br>3. pCR 28.810 Add Clause 6.X Relation with existing standardized features<br>4. Implement Edithelp comments | | 0.5.0 | +| 2020-06 | SA#88-e | SP-200480 | | | | Presented for information | | 1.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28861/107da2e3495b2f24352c9e3b26ec4841_img.jpg b/marked/Rel-16/28_series/28861/107da2e3495b2f24352c9e3b26ec4841_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e36ba978d59e923d50bd3c40896c236e73c8975c --- /dev/null +++ b/marked/Rel-16/28_series/28861/107da2e3495b2f24352c9e3b26ec4841_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16ab4a02f0daa453023a11faddf54a7accb0e2608c763db5088c5305be1bd689 +size 69051 diff --git a/marked/Rel-16/28_series/28861/2e399449b7f62d40167a65ca88888917_img.jpg b/marked/Rel-16/28_series/28861/2e399449b7f62d40167a65ca88888917_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..512459b8a39a1a94a11e1541e837b7bea3c78b4c --- /dev/null +++ b/marked/Rel-16/28_series/28861/2e399449b7f62d40167a65ca88888917_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:61420a494511412fe03fa52358eea1afef34b7f0451da06bba7bff7545fb5e7f +size 48974 diff --git a/marked/Rel-16/28_series/28861/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/marked/Rel-16/28_series/28861/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7041376b19e04a4780b0f884d84fc8b9e1219aa --- /dev/null +++ b/marked/Rel-16/28_series/28861/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b059a28f1d5cfdde99dc01af07ec246157b1f25967b6c7dbdc064f57b29323c2 +size 24089 diff --git a/marked/Rel-16/28_series/28861/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/28_series/28861/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..361406fae432ce5e831af7c485139df32d952f83 --- /dev/null +++ b/marked/Rel-16/28_series/28861/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9c56dd66658b4e7868704a3c972ea8819b51897e542a4967dba57dcc02727a7 +size 40300 diff --git a/marked/Rel-16/28_series/28861/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/28_series/28861/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61d4d00de3bf4647d5719a4c80de910866bb1358 --- /dev/null +++ b/marked/Rel-16/28_series/28861/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc0d627a970b036fbc40e76af588bef564bdc3adbcca053c6ca1a83f38ea6ef8 +size 39158 diff --git a/marked/Rel-16/28_series/28861/ae9b822eaafef535b7a0fbb97a7c713b_img.jpg b/marked/Rel-16/28_series/28861/ae9b822eaafef535b7a0fbb97a7c713b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..86e75166b7e661023a1bf72d3582ca75dd007b8e --- /dev/null +++ b/marked/Rel-16/28_series/28861/ae9b822eaafef535b7a0fbb97a7c713b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1b8ae0c23d732a91fbcdc05bd352628ae6ccaae428ef0eb37379cd7f2f89677 +size 32483 diff --git a/marked/Rel-16/28_series/28861/b3c108e7145f2017957569d06ea359cb_img.jpg b/marked/Rel-16/28_series/28861/b3c108e7145f2017957569d06ea359cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d3f3d502c3696ee81316aaf0e76dacc9af21e09 --- /dev/null +++ b/marked/Rel-16/28_series/28861/b3c108e7145f2017957569d06ea359cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fdc2c8bb173c63d4b9a625d7b7e3a79031f0f7529c0e4a910ec5b4c42ae5659b +size 50317 diff --git a/marked/Rel-16/28_series/28861/cab0834804fb031b43865554cc8d06ab_img.jpg b/marked/Rel-16/28_series/28861/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57a191e2e3aed5eed2a4601b1c3c3ab07b82e14a --- /dev/null +++ b/marked/Rel-16/28_series/28861/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45ca891e87b97e515310bc71c756e229b3593012ce139666f19d2546957188ef +size 48837 diff --git a/marked/Rel-16/28_series/28861/raw.md b/marked/Rel-16/28_series/28861/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3b3ed49c1036b2fe8ce70b403880f7538a20c850 --- /dev/null +++ b/marked/Rel-16/28_series/28861/raw.md @@ -0,0 +1,1732 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions of terms, symbols and abbreviations..... | 10 | +| 3.1 Terms..... | 10 | +| 3.2 Symbols..... | 10 | +| 3.3 Abbreviations ..... | 10 | +| 4 Concept and background..... | 11 | +| 4.1 SON concepts..... | 11 | +| 4.1.1 Introduction ..... | 11 | +| 4.1.2 Centralized SON..... | 11 | +| 4.1.2.1 Introduction..... | 11 | +| 4.1.2.2 Cross Domain-Centralized SON..... | 12 | +| 4.1.2.3 Domain-Centralized SON..... | 12 | +| 4.1.3 Distributed SON ..... | 13 | +| 4.1.4 Hybrid SON..... | 13 | +| 4.2 Human intervention of SON ..... | 15 | +| 4.2.1 Introduction ..... | 15 | +| 4.2.2 Open loop ..... | 15 | +| 4.2.3 Closed loop..... | 15 | +| 4.2.4 Open loop and closed loop transition..... | 15 | +| 4.3 Legacy SON Functions ..... | 15 | +| 4.3.1 Self-establishment of 3GPP NF, including automated software management..... | 15 | +| 4.3.2 Automatic Neighbour Relation (ANR) management (including automatic X2 and Xn setup)..... | 16 | +| 4.3.3 PCI Configuration ..... | 16 | +| 4.3.4 Automatic Radio Network Configuration Data Handling..... | 16 | +| 4.3.5 Load Balancing Optimization..... | 16 | +| 4.3.6 Inter-Cell Interference (Interference coordination) ..... | 16 | +| 4.3.7 RACH Optimization (Random Access Optimization) ..... | 16 | +| 4.3.8 Centralized Capacity and Coverage Optimization ..... | 17 | +| 4.3.9 Self-healing..... | 17 | +| 4.3.10 SON coordination..... | 17 | +| 4.3.11 SON for AAS-based Deployments..... | 17 | +| 4.3.12 Trace and MDT ..... | 17 | +| 4.3.13 Mobility Robustness Optimization..... | 17 | +| 4.3.14 Energy Saving Management..... | 18 | +| 4.3.14.1 General ..... | 18 | +| 4.3.14.2 Intra-5G Energy Saving in 5G networks ..... | 18 | +| 4.3.14.3 Inter-RAT Energy Saving..... | 18 | +| 4.3.15 (Distributed) Capacity and Coverage Optimization ..... | 18 | +| 5 Use cases..... | 18 | +| 5.1 NSI resource allocation optimization..... | 18 | +| 5.1.1 Goal ..... | 18 | +| 5.1.2 Pre-conditions..... | 18 | +| 5.1.3 Steps ..... | 19 | +| 5.1.4 Post-conditions ..... | 19 | +| 5.2 Self-establishment of 3GPP NF, including automated software management ..... | 19 | +| 5.2.1 Goal ..... | 19 | +| 5.2.2 Pre-conditions..... | 19 | +| 5.2.3 Steps ..... | 19 | +| 5.3 Automatic Neighbour Relation (ANR) management (including automatic X2 and Xn setup) ..... | 20 | +| 5.3.1 Introduction ..... | 20 | +| 5.3.2 Pre-conditions..... | 20 | +| 5.3.3 Description ..... | 20 | + +| | | | +|----------|-------------------------------------------------------------|----| +| 5.4 | Automatic Neighbour Relation (ANR) optimization ..... | 20 | +| 5.4.1 | Goal ..... | 20 | +| 5.4.2 | Pre-conditions ..... | 20 | +| 5.4.3 | Steps ..... | 21 | +| 5.5 | PCI Configuration ..... | 21 | +| 5.5.1 | Introduction ..... | 21 | +| 5.5.2 | Pre-conditions ..... | 21 | +| 5.5.3 | Steps ..... | 21 | +| 5.5.3.1 | Management of distributed PCI configuration ..... | 21 | +| 5.5.3.2 | Centralized PCI configuration ..... | 22 | +| 5.5.4 | Post-conditions ..... | 22 | +| 5.6 | Automatic Network Configuration Data Handling ..... | 22 | +| 5.6.0 | Introduction ..... | 22 | +| 5.6.1 | Goal ..... | 22 | +| 5.6.2 | Pre-conditions ..... | 22 | +| 5.6.3 | Steps ..... | 22 | +| 5.6.4 | Post-condition ..... | 23 | +| 5.7 | Load Balancing Optimization ..... | 23 | +| 5.7.1 | Introduction ..... | 23 | +| 5.7.2 | Pre-conditions ..... | 23 | +| 5.7.3 | Description ..... | 23 | +| 5.7.3.1 | The management of distributed LBO ..... | 23 | +| 5.7.3.2 | Centralized LBO ..... | 23 | +| 5.7.4 | Post-conditions ..... | 23 | +| 5.8 | Void ..... | 23 | +| 5.9 | RACH Optimization (Random Access Optimization) ..... | 23 | +| 5.9.1 | Introduction ..... | 23 | +| 5.9.2 | Pre-conditions ..... | 24 | +| 5.9.3 | Description ..... | 24 | +| 5.9.4 | Post-conditions ..... | 24 | +| 5.10 | Centralized Capacity and Coverage Optimization ..... | 24 | +| 5.10.1 | Goal ..... | 24 | +| 5.10.2 | Pre-conditions ..... | 24 | +| 5.10.3 | Steps ..... | 25 | +| 5.11 | Self-healing ..... | 25 | +| 5.12 | SON coordination ..... | 25 | +| 5.13 | Multi-vendor Plug and Play of NFs ..... | 25 | +| 5.13.0 | Introduction ..... | 25 | +| 5.13.1 | Multi-Vendor Plug and Connect NF to Management System ..... | 25 | +| 5.13.1.1 | Goal ..... | 25 | +| 5.13.1.2 | Pre-condition ..... | 25 | +| 5.13.1.3 | Steps ..... | 26 | +| 5.13.1.4 | Post-condition ..... | 26 | +| 5.13.2 | Self-configuration of a new NF ..... | 26 | +| 5.13.2.1 | Goal ..... | 26 | +| 5.13.2.2 | Pre-condition ..... | 26 | +| 5.13.2.3 | Steps ..... | 26 | +| 5.13.2.4 | Post-condition ..... | 27 | +| 5.14 | SON for AAS-based Deployments ..... | 27 | +| 5.15 | Trace and MDT ..... | 27 | +| 5.16 | Mobility Robustness Optimization ..... | 27 | +| 5.16.1 | Introduction ..... | 27 | +| 5.16.2 | Pre-conditions ..... | 27 | +| 5.16.3 | Description ..... | 27 | +| 5.16.4 | Post-conditions ..... | 27 | +| 5.17 | Energy Saving Management ..... | 28 | +| 5.18 | Automatic NSI creation ..... | 28 | +| 5.18.1 | Introduction ..... | 28 | +| 5.18.2 | Pre-conditions ..... | 28 | +| 5.18.3 | Description ..... | 28 | +| 5.18.4 | Post-conditions ..... | 28 | +| 5.19 | Optimization of the quality of communication services ..... | 28 | + +| | | | +|--------|-------------------------------------------------------------------------------------------|----| +| 5.19.1 | Goal ..... | 28 | +| 5.19.2 | Pre-conditions ..... | 28 | +| 5.19.3 | Steps ..... | 29 | +| 5.20 | Cross-slice network resource optimization ..... | 29 | +| 5.20.1 | Goal ..... | 29 | +| 5.20.2 | Pre-conditions ..... | 29 | +| 5.20.3 | Steps ..... | 29 | +| 5.20.4 | Post-conditions ..... | 30 | +| 5.21 | Multi-aspect / multi-domain resource optimization ..... | 30 | +| 5.21.1 | Goal ..... | 30 | +| 5.21.2 | Pre-conditions ..... | 30 | +| 5.21.3 | Description ..... | 30 | +| 5.21.4 | Steps ..... | 31 | +| 5.22 | Automatic CSI creation ..... | 32 | +| 5.22.1 | Goal ..... | 32 | +| 5.22.2 | Pre-conditions ..... | 32 | +| 5.22.3 | Description ..... | 32 | +| 5.22.4 | Post-conditions ..... | 32 | +| 6 | Potential requirements ..... | 32 | +| 6.1 | Self-Establishment of NG-RAN and 5GC nodes, including automated Software Management ..... | 32 | +| 6.2 | Automatic Neighbour Relation (ANR) management (including automatic X2 setup) ..... | 32 | +| 6.3 | Automatic Neighbour Relation (ANR) optimization ..... | 33 | +| 6.4 | PCI Configuration ..... | 33 | +| 6.5 | Void ..... | 33 | +| 6.6 | Load Balancing Optimization ..... | 33 | +| 6.7 | Void ..... | 34 | +| 6.8 | RACH Optimization (Random Access Optimization) ..... | 34 | +| 6.9 | Centralized Capacity and Coverage Optimization ..... | 34 | +| 6.10 | Void ..... | 34 | +| 6.11 | Self-healing ..... | 34 | +| 6.12 | SON coordination ..... | 34 | +| 6.13 | Multi-vendor Plug and Play of NFs ..... | 34 | +| 6.14 | SON for AAS-based Deployments ..... | 34 | +| 6.15 | Trace and MDT ..... | 34 | +| 6.16 | Mobility Robustness Optimization ..... | 35 | +| 6.17 | Energy Saving Management ..... | 35 | +| 6.18 | NSI resource allocation optimization ..... | 35 | +| 6.19 | Automatic NSI creation ..... | 35 | +| 6.20 | Requirements related to the service quality optimization ..... | 35 | +| 6.21 | Cross-slice network resource optimization ..... | 35 | +| 7 | Potential solutions ..... | 36 | +| 7.1 | Self-establishment of NFs including automated Software Management ..... | 36 | +| 7.2 | Automatic Neighbour Relation (ANR) management (including automatic X2 and Xn setup) ..... | 37 | +| 7.3 | PCI Configuration ..... | 37 | +| 7.3.1 | General ..... | 37 | +| 7.3.2 | Management of distributed PCI configuration ..... | 37 | +| 7.3.3 | Centralized PCI configuration ..... | 38 | +| 7.4 | Void ..... | 39 | +| 7.5 | Load Balancing Optimization ..... | 39 | +| 7.5.1 | General ..... | 39 | +| 7.5.2 | Management of distributed LBO ..... | 39 | +| 7.5.3 | Centralized LBO ..... | 39 | +| 7.6 | Void ..... | 40 | +| 7.7 | RACH Optimization (Random Access Optimization) ..... | 40 | +| 7.7.1 | General ..... | 40 | +| 7.7.2 | Management of RACH optimization ..... | 40 | +| 7.8 | Capacity and Coverage Optimization ..... | 41 | +| 7.8.0 | Overview of Potential solution for CCO ..... | 41 | +| 7.8.1 | Potential solution for centralized CCO ..... | 41 | +| 7.9 | Self-healing ..... | 42 | + +| | | | +|----------|-----------------------------------------------------------------------------------------|----| +| 7.10 | SON coordination..... | 42 | +| 7.11 | Multi-vendor Plug and Play eNB connection to the network ..... | 43 | +| 7.12 | SON for AAS-based Deployments ..... | 43 | +| 7.13 | Trace and MDT ..... | 43 | +| 7.14 | Mobility Robustness Optimization..... | 43 | +| 7.14.1 | General ..... | 43 | +| 7.14.2 | Management of mobility robustness optimization ..... | 43 | +| 7.15 | Energy Saving Management ..... | 44 | +| 7.16 | Automatic Neighbour Relation (ANR) optimization ..... | 44 | +| 7.16.1 | General ..... | 44 | +| 7.16.2 | ANR optimization ..... | 44 | +| 7.17 | Cross-slice network resource optimization ..... | 44 | +| 8 | Conclusion and recommendation..... | 45 | +| 8.1 | Self-establishment of non-virtualized NFs, including automated Software Management..... | 45 | +| 8.2 | Automatic Neighbour Relation (ANR) management (including automatic X2 setup)..... | 45 | +| 8.3 | PCI Configuration ..... | 45 | +| 8.4 | Void..... | 45 | +| 8.5 | Automatic Neighbour Relation (ANR) optimization ..... | 45 | +| 8.6 | Load Balancing Optimization ..... | 45 | +| 8.7 | RACH Optimization (Random Access Optimization) ..... | 45 | +| 8.8 | Centralized Capacity and Coverage Optimization ..... | 45 | +| 8.9 | Self-healing ..... | 45 | +| 8.10 | SON coordination..... | 46 | +| 8.11 | Multi-vendor Plug and Play of NFs ..... | 46 | +| 8.12 | SON for AAS-based Deployments ..... | 46 | +| 8.14 | Trace and MDT ..... | 46 | +| 8.15 | Mobility Robustness Optimization..... | 46 | +| 8.16 | Energy Saving Management ..... | 46 | +| Annex A: | Change history ..... | 47 | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +A 5G network is more complex than previous generations of mobile networks, which means that the need for automation is higher for 5G. + +This study is evaluating SON functions in previous generations of mobile networks and is studying new SON functions, both for RAN and the core network. + +# --- 1 Scope + +The present document comprises management use cases, potential requirements and potential solutions of SON for 5G mobile networks. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TR 32.500: "Telecommunication Management; Self-Organizing Networks (SON); Concepts and requirements". +- [3] 3GPP TR 32.501: "Telecommunication Management; Self-configuration of network elements; Concepts and requirements". +- [4] 3GPP TS 28.525: "Life Cycle Management (LCM) for mobile networks that include virtualized network functions; Requirements". +- [5] 3GPP TR 38.321 v0.0.0 "NR; Medium Access Control (MAC) protocol specification". +- [6] 3GPP TS 38.331: "NR; Radio Resource Control (RRC) protocol specification". +- [7] 3GPP TS 32.511: "Automatic Neighbour Relation (ANR) management; Concepts and requirements" +- [8] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2" +- [9] 3GPP TS 28.628: "Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" +- [10] 3GPP TS 28.551: "Performance Management (PM) for mobile networks that include virtualized network functions; Procedures" +- [11] 3GPP TR 38.423: "NG-RAN; Xn Application Protocol (XnAP)". +- [12] 3GPP TR 37.816: "Evolved Universal Terrestrial Radio Access (E-UTRA) and NR; Study on RAN-centric data collection and utilization for LTE and NR". +- [13] 3GPP TR 38.300: "NR; NR and NG-RAN Overall Description; Stage 2". +- [14] 3GPP TS 32.541: "Telecommunication Management; Self-Organizing Network (SON); Self-healing concepts and requirements". +- [15] 3GPP TS 28.550 v15.0.0 "Management and orchestration; Performance Assurance" +- [16] 3GPP TS 28.530 v15.1.0 "Management and orchestration; Concepts, Use cases and Requirements" +- [17] 3GPP TS 28.533 v15.1.0 "Management and orchestration; Architecture framework" +- [18] TS 28.627 "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Requirements" + +- [19] 3GPP TS 28.658 "Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" +- [20] 3GPP TS 32.297 "Telecommunication management; Charging management; Charging Data Record (CDR) file format and transfer" +- [21] 3GPP TS 37.320 Radio measurement collection for Minimization of Drive Tests (MDT); Overall description; Stage 2 +- [22] 3GPP TS 32.502: "Telecommunication Management; Self-configuration of network elements Integration Reference Point (IRP); Information Service (IS)". +- [23] 3GPP TS 32.508: "Telecommunication Management; Procedure flows for multi-vendor plug-and-play eNode B connection to the network". +- [24] 3GPP TS 28.310 "Management and orchestration; Energy Efficiency (EE) of 5G; Concepts, use cases and requirements". +- [25] 3GPP TS 38.211: "NR; Physical channels and modulation". +- [26] 3GPP TS 28.532: "Management and orchestration; Generic management services" +- [27] 3GPP TS 28.545: "Management and orchestration; Fault Supervision (FS)" +- [28] 3GPP TS 32.522: "Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)" +- [29] 3GPP TS 28.806: "Study on non-file-based trace reporting" +- [30] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace; Trace concepts and requirements" +- [31] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management" + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +## 3.2 Symbols + +Void + +## 3.3 Abbreviations + +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]. + +| | | +|------|-------------------------------------------| +| AAS | Active Antenna System | +| ANR | Automatic Neighbour Relation | +| CCO | Coverage and Capacity Optimization | +| LB | Load Balancing | +| MRO | Mobility Robustness Optimization | +| NR | NR Radio Access | +| NSI | Network Slice Instance | +| NSSI | Network Slice Subnet Instance | +| OAM | Operation, Administration and Maintenance | +| OPEX | Operating Expenditure | +| PCI | Physical Cell Identifier | + +| | | +|-----|------------------------| +| PM | Performance Management | +| RLF | Radio Link Failure | + +# 4 Concept and background + +## 4.1 SON concepts + +### 4.1.1 Introduction + +3GPP management system includes 3GPP Cross Management Domain and Management Domain. + +Based on the location of the SON algorithm, SON is categorized into centralized SON (i.e. Cross Domain-Centralized SON, Domain-Centralized SON), distributed SON and hybrid SON. + +The SON algorithm is not standardized by 3GPP. + +Following figure illustrates the overview of SON Framework. + +![Figure 4.1.1-1: SON Framework diagram showing three layers: 3GPP Cross Management Domain Layer (Cross Domain-Centralized SON), Management Domain Layer (Domain-Centralized SON), and Network Function Layer (Distributed SON).](b3c108e7145f2017957569d06ea359cb_img.jpg) + +The diagram illustrates the SON Framework across three layers, each enclosed in a dashed box. The top layer is the '3GPP Cross Management Domain Layer', containing 'Cross Domain-Centralized SON' circled in red. The middle layer is the 'Management Domain Layer', containing 'Domain-Centralized SON' circled in red. The bottom layer is the 'Network Function Layer', containing 'Distributed SON' circled in red. Double-headed vertical arrows connect the top layer to the middle layer, and the middle layer to the bottom layer, indicating bidirectional communication or interaction between adjacent layers. + +Figure 4.1.1-1: SON Framework diagram showing three layers: 3GPP Cross Management Domain Layer (Cross Domain-Centralized SON), Management Domain Layer (Domain-Centralized SON), and Network Function Layer (Distributed SON). + +Figure 4.1.1-1: SON Framework + +### 4.1.2 Centralized SON + +#### 4.1.2.1 Introduction + +3GPP management system includes 3GPP Cross Management Domain and Management Domain. + +The centralized SON (C-SON) means the SON algorithm is located in the 3GPP management system. The centralized SON concept has been defined for LTE in TS 32.500 [2]. + +For centralized SON, the 3GPP management system monitors the networks via management data (see NOTE), analyses the management data (i.e., by management data analytics), makes decisions on the SON actions, and executes the SON actions towards the networks. + +NOTE: The management data may vary for different the SON cases. For example, for automated creation of NSI, NSSI and/or NFs related cases, the management data may be SLA requirements received from service management layer; for automated optimization related cases, the management data may be performance measurements of the networks; for automated healing related cases, the management data may be alarm information of the networks. The management data is to be specified case by case. + +The monitoring, analysis, decision and execution process also applies to monitoring the result of already executed SON actions, evaluating the results (by analysing the historical and current management data), making decisions on new SON actions (which may move forward or backward of the prior actions), and the executing the new SON actions. + +As presented at the Figure 4.1.2-1, 3GPP management system is monitoring and executes SON actions in and across multiple network domains such as RAN and Core. + +![Diagram of C-SON view showing the 3GPP management system at the center, connected to NF (CN) and NF (RAN). The 3GPP management system contains a SON algorithm with four stages: Monitoring (blue), Analysis (red), Decision (yellow), and Execution (green). Arrows show the flow between these stages and to the network functions.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +The diagram illustrates the Centralized SON (C-SON) view. At the top is a large circle labeled "3GPP management system". Inside this circle is a circular flow representing the SON algorithm, with four colored arrows forming a clockwise loop: a blue arrow labeled "Monitoring", a red arrow labeled "Analysis", a yellow arrow labeled "Decision", and a green arrow labeled "Execution". In the center of this loop is a circle labeled "SON algorithm". Below the 3GPP management system are two circles: "NF (CN)" on the left and "NF (RAN)" on the right. Double-headed grey arrows connect the 3GPP management system to each of these network functions (NFs). + +Diagram of C-SON view showing the 3GPP management system at the center, connected to NF (CN) and NF (RAN). The 3GPP management system contains a SON algorithm with four stages: Monitoring (blue), Analysis (red), Decision (yellow), and Execution (green). Arrows show the flow between these stages and to the network functions. + +**Figure 4.1.2-1: C-SON view** + +Centralized SON has two variants: + +- Cross Domain-Centralized SON: SON solution where SON algorithms are executed at 3GPP Cross Management Domain Layer. +- Domain-Centralized SON: SON solution where SON algorithms are executed at Management Domain layer. + +#### 4.1.2.2 Cross Domain-Centralized SON + +The Cross Domain-Centralized SON means the SON algorithm is located in the 3GPP Cross Management Domain layer. + +For Cross Domain-Centralized SON, the 3GPP Cross Management Domain monitors the networks via management data, analyses the management data, makes decisions on the SON actions, and executes the SON actions. + +#### 4.1.2.3 Domain-Centralized SON + +The Domain-Centralized SON means the SON algorithm is located in the Management Domain layer. + +For Domain-Centralized SON, Management Domain monitors the networks via management data, analyses the management data, makes decisions on the SON actions, and executes the SON actions. + +3GPP Cross Management Domain is responsible for management and control of the Domain-Centralized SON Functions. The management and control may include switching on/off a Domain-Centralized SON function, making policies for a Domain-Centralized SON function, and/or evaluating the performance of a Domain-Centralized SON function. + +### 4.1.3 Distributed SON + +The distributed SON means the SON algorithm is located in the NFs. The distributed SON concept has been defined for LTE in TS 32.500 [2]. + +For distributed SON (D-SON), the NFs monitors the network events, analyses the network data, makes decisions on the SON actions and executes the SON actions in the network nodes. + +The 3GPP management system is responsible for management and control of the D-SON functions. The management and control may include switching on/off a D-SON function, making policies for a D-SON function, providing supplementary information (e.g. the value range of an attribute) to a D-SON function, and/or evaluating the performance of a D-SON function. + +![Figure 4.1.3-1: D-SON view diagram](cab0834804fb031b43865554cc8d06ab_img.jpg) + +The diagram illustrates the D-SON view. At the top, a large circle represents the '3GPP management system', which contains a rectangular box labeled 'SON management & control'. Below this, two circles represent network functions: 'NF (CN)' on the left and 'NF (RAN)' on the right. Each NF contains a circular flow diagram with four stages: 'Monitoring' (blue arrow), 'Analysis' (red arrow), 'Decision' (yellow arrow), and 'Execution' (green arrow), surrounding a central 'SON algorithm' label. Double-headed green arrows connect the 'SON management & control' box in the 3GPP management system to both the 'NF (CN)' and 'NF (RAN)' circles. + +Figure 4.1.3-1: D-SON view diagram + +Figure 4.1.3-1: D-SON view + +### 4.1.4 Hybrid SON + +The hybrid SON (H-SON) means the SON algorithm is partially located in the 3GPP management system and partially located in the NFs. The hybrid SON concept has been defined for LTE in TS 32.500 [2]. + +The 3GPP management system and NFs work together, in a coordinated manner, to build up a complete SON algorithm. The decisions on SON actions may be either made by 3GPP management system or NFs, depending on the specific cases. + +As presented at the Figure 4.1.4-1, the centralized SON component is monitoring and executes SON actions in and across multiple network domains such as RAN and Core. + +![Figure 4.1.4-1: H-SON view diagram](2e399449b7f62d40167a65ca88888917_img.jpg) + +The diagram illustrates the H-SON view. At the top, a large circle represents the '3GPP management system', which contains a circular flow diagram with four stages: 'Monitoring' (blue arrow), 'Analysis' (red arrow), 'Decision' (yellow arrow), and 'Execution' (green arrow), surrounding a central 'SON algorithm' label. Below this, two circles represent network functions: 'NF (CN)' on the left and 'NF (RAN)' on the right. Each NF contains a similar circular flow diagram with four stages and a central 'SON algorithm' label. Double-headed green arrows connect the 'SON algorithm' in the 3GPP management system to both the 'NF (CN)' and 'NF (RAN)' circles. + +Figure 4.1.4-1: H-SON view diagram + +Figure 4.1.4-1: H-SON view + +### 4.1.5 Management Data Analytics Service and SON functions + +Management data analytics for 5G networks have already been defined in [15] and also by other specifications including [16] and [17]. It utilizes both management and network data collected through management services and from network functions (including e.g. service, slicing and/or network functions related data) and makes the corresponding analytics based on the collected information. These analytics services (i.e., MDAS) can be made available and consumed by other management and SON functions. Figure 4.1.5-1 gives a high level illustration of potential interaction and utilization of the MDAS. + +![Diagram illustrating the Management Data Analytics Service (MDAF) and its interactions with SON Functions, Management Functions, and Network Functions.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +The diagram shows a central rectangular box labeled 'Management Data Analytics (MDAF)'. To its left is a dashed box labeled 'Management Functions' containing three overlapping blue squares, one of which is labeled 'MF'. To its top is a dashed box labeled 'SON Functions' containing three overlapping blue squares, one of which is labeled 'SON'. To its bottom is a dashed box labeled 'Network Functions' containing three overlapping blue squares, one of which is labeled 'NF'. Bidirectional arrows connect the 'MDAF' box to each of the three surrounding boxes: 'Management Functions', 'SON Functions', and 'Network Functions'. + +Diagram illustrating the Management Data Analytics Service (MDAF) and its interactions with SON Functions, Management Functions, and Network Functions. + +**Figure 4.1.5-1: Management Data Analytics Service and SON functions** + +It is therefore important that the following concept is observed and considered for the development of use cases and requirements, i.e. + +- SON functions may utilize the services provided by the management data analytics (i.e., MDAS) to conduct their functionalities and control actions. + +NOTE: Other potential interactions between the entities are not shown in the diagram in Figure 4.1.5-1 above. + +## 4.2 Human intervention of SON + +### 4.2.1 Introduction + +The full automation of SON is desirable to maximally reduce the operating expenditure (OPEX) of the networks, and to achieve the fastest reaction to the network issues. + +However, any improper SON action (e.g. modification of the networks) may cause significantly negative impact to the networks, for instance downgrade of the user experience. Therefore, the consumer (e.g. network operator) may need to build the confidence about the SON functions step by step before allowing the SON process to run fully autonomously, thus human intervention of the SON process needs to be allowed. + +Based on whether the SON process is intervened by the consumer, the SON process is categorized to open loop process and closed loop process. + +### 4.2.2 Open loop + +The SON process with human intervention is the open loop process (see TS 32.500 [2]). Therefore, the open loop SON process is semi- autonomous. + +In the open loop SON process, the consumer (e.g. network operator) may pre-define some stop points and the SON process will stop at each pre-defined stop point. Based on the status of the SON process at each stop point, the consumer may decide to resume the SON process or cancel the SON process. The consumer may also make some adjustment to the networks, besides the resumption or cancellation of the SON process. + +### 4.2.3 Closed loop + +The SON process without human intervention is the closed loop process (see TS 32.500 [2]) and thus fully autonomous. Human intervention is only possible in case of exceptions. + +### 4.2.4 Open loop and closed loop transition + +The consumer may need to transit a SON process from open loop to closed loop if sufficient confidence has been built; vice-versa, the consumer may transit a SON process from closed loop to open loop if the human intervention is required to gain more trust. + +## 4.3 Legacy SON Functions + +### 4.3.1 Self-establishment of 3GPP NF, including automated software management + +For LTE, the self-establishment SON function has been defined for eNB in TS 32.501 [3]. + +This concept may be applicable to 5G: the 3GPP NF or its components (e.g. gNB-DU) including NG-RAN and 5GC NFs, is automatically established, when it is powered up and connects to the IP network. As a part of self-establishment, the 3GPP NF or its components is also automatically connected to the network and provided with initial configurations. + +For 5G, some phases of the self-establishment (e.g. self-configuration, Multi-Vendor Plug and Play eNB connection to network) may be implemented in other types of 3GPP NFs (not only the Base Stations). + +### 4.3.2 Automatic Neighbour Relation (ANR) management (including automatic X2 and Xn setup) + +The neighbour relations, including intra-5G neighbour relations and inter-RAT neighbour relations, are automatically established by the gNB and the management system. + +The ANR management concept defined for LTE in TS 32.511 [7] may be applicable to 5G. + +For NG-RAN, the ANR functionality is specified in TR 38.300 [13], TS 38.331 [6] and TS 38.423 [11]. The ANR management concept defined for LTE in TS 32.511 [7] may be applicable to 5G. + +There is related study TR 37.816 [12]. + +### 4.3.3 PCI Configuration + +The PCI is to be automatically assigned to an NR cell by the gNB DU and the management system. + +The framework for PCI selection defined for LTE in TS 36.300 [8] (see clause 22.3.5) may be applicable to 5G. + +There is related study TR 37.816 [12]. + +### 4.3.4 Automatic Radio Network Configuration Data Handling + +The concept of automatic radio configuration data (ARCF) handling for eNB defined in TS 32.501[3], including ARCF data preparation, ARCF Data Transfer and ARCF Data Validation, may be applicable to 5G. Whether the detailed ARCF data for eNB can be applied for gNB needs to be revisited. + +### 4.3.5 Load Balancing Optimization + +The objective of LB is to automatically distribute cell load evenly among cells or to transfer part of the traffic from congested cells, by means of optimizing the intra-RAT and inter-RAT mobility parameters. + +The LB concept and mechanism defined for LTE in TS 28.628 [9] and TS 36.300 [8] may be applicable to 5G. + +There is related study TR 37.816 [12]. + +Actions undertaken through the LB mechanism may have impact on the Virtual Network Functions' and/or network slices' load and resources. The LB mechanism defined for LTE with its uni-dimensional perspective on resources needs to be enhanced in 5G to address or account for such effects. + +### 4.3.6 Inter-Cell Interference (Interference coordination) + +Inter-cell interference coordination is to optimize use of radio resources to ensure that inter-cell interference is kept under control. ICIC mechanism defined for LTE in TS 36.300 [8] includes a frequency domain component and time domain component. ICIC is inherently a multi-cell RRM function that needs to take into account information (e.g. the resource usage status and traffic load situation) from multiple cells. + +The ICIC concept defined for LTE in TS 36.300 [8] may be applicable to 5G. + +### 4.3.7 RACH Optimization (Random Access Optimization) + +The RACH parameters, for example listed in the following, are optimized automatically to achieve a better performance for UE random access: + +- RACH configuration (resource unit allocation); +- RACH preamble split; +- RACH back-off parameter value; +- RACH transmission power control parameters. + +The RACH optimization concept defined for LTE in TS 36.300 [8] may be applicable to 5G. + +There is related study TR 37.816 [12]. + +### 4.3.8 Centralized Capacity and Coverage Optimization + +The CCO is to automatically optimize the coverage and capacity for radio networks, with the consideration of trade-off between them. The CCO concept was defined for LTE in TS 28.627 [18] with the targets and parameters to be optimized specified in TS 28.628 [9] and the NRM support in the TS 28.658 [19]. + +The concept may be applicable to 5G, however the functions specific to 5G radio technology (e.g. beam management) need to be taken into account. + +### 4.3.9 Self-healing + +The concept of Self-healing for LTE NE described in TS 32.541[14] may be applicable to 5G NE (including 5GC and NG-RAN NE). + +### 4.3.10 SON coordination + +Some SON functions eventually affect the same network parameters, thus these SON functions need to be coordinated to prevent or resolve the conflicts. + +The SON coordination concept defined for LTE in TS 28.628 [9] may be also applicable to 5G, however the new 5G SON functions and the 5G specific network parameters affected by the 5G SON functions need to be taken into account. + +The SON coordination (as defined for LTE) does not account for multiple network aspects e.g. virtualization or slicing. Functionality for multi-aspect views of the network requires new services to be defined. + +### 4.3.11 SON for AAS-based Deployments + +SON for AAS-based deployments was specified for LTE and is documented in TS 28.627 [18] and TS 28.628 [9]. Its purpose was to create a framework for splitting and merging cells, as well as for changing cell configuration (cell shaping.) + +The NR beamforming will be able to take over the role of cell splitting and cell merging. Cell shape changes, in LTE SON for AAS-based deployments manifested by changing handover and similar parameters, is in NR primarily handled by the SON function CCO. + +### 4.3.12 Trace and MDT + +Trace and the reporting of Trace data as it refers to subscriber tracing and equipment tracing. Trace also includes the ability to trace all active calls in a cell or multiple cells. Trace records control signalling information for specified interfaces. + +The trace function is specified in Rel-15 for NR. + +MDT is collecting UE measurements either when the UE is in active or idle mode. Information can be collected either on individual basis or for UEs in a specified area. + +The concept of MDT, defined in the TS 37.320 [21], may be applicable to 5G. + +There is related study TR 37.816 [12]. + +### 4.3.13 Mobility Robustness Optimization + +The MRO is to automatically detect and solve the problems relate to the intra-5G and inter-RAT mobility, which include (but not limited to): + +- Too early handover; +- Too late handover; +- Handover to wrong cell; +- Unnecessary handover; +- Ping-pong handover. + +The MRO concept and mechanism defined for LTE in TS 28.628 [9] and TS 36.300 [8] may be applicable to 5G. + +There is related study TR 37.816 [12]. + +### 4.3.14 Energy Saving Management + +#### 4.3.14.1 General + +There is related study TR 37.816 [12]. + +#### 4.3.14.2 Intra-5G Energy Saving in 5G networks + +For energy saving purpose, in an off-peak-traffic situation, some functions of an NR cell or a NF are powered-off or restricted in resource usage in other ways, whereas the cell or NF is still controllable, and the coverage or capacity of the energy saving cell or NF is taken over by other NR cells or NFs. + +The intra-RAT Energy Saving scenarios defined for LTE in TS 32.551 [10] are also applicable to 5G, with the consideration that the RAT is for 5G instead of LTE. + +#### 4.3.14.3 Inter-RAT Energy Saving + +For energy saving purpose, in an off-peak-traffic situation, some functions of an NR cell or a NF are powered-off or restricted in resource usage in other ways, whereas the NR cell or NF is still controllable, and the coverage or capacity of the energy saving cell or NF is taken over by the cells or NFs of another RAT. + +The inter-RAT Energy Saving scenarios defined for LTE in TS 32.551 [10] are also applicable to 5G, with the consideration that the cell for energy saving is of 5G instead of LTE. + +### 4.3.15 (Distributed) Capacity and Coverage Optimization + +There is related study TR 37.816 [12]. + +# --- 5 Use cases + +## 5.1 NSI resource allocation optimization + +### 5.1.1 Goal + +The goal is to enable the authorized consumer to optimize resource utilization performance of NSI. + +### 5.1.2 Pre-conditions + +- The NSI(s) have been deployed. +- The NSI management service producer is in operation. + +### 5.1.3 Steps + +1. (Optional) For shared NSIs, NSI management service provider may need to check policies and resource requirements of several services sharing the NSI. +2. Unless there are policies already determining configurations, SON service provider determines thresholds to trigger NSI optimization (e.g. scale in/out, configure policy), such as network traffic loading, a network resource usage percentage, and available bandwidth, based on policies and requirements of services using the NSI. +3. SON function collects the performance data (related to the data volume, the number of registered UEs, the number of PDU sessions, UE behaviour statistics based on Charging Data Records information (TS 32.297 [20] ), QoS parameter notifications and UE mobility event notifications from the 5GC ... etc.), and utilizes the historical performance data to identify the traffic patterns for the NSIs, and predict the demand for network resources per every NSI for a given time and location. This information is analysed, for example, with assistance of the MDAS, and the information may include data from NSI constituents' data analytics entities, such as NWDAF, e.g. regarding the load of some network functions. +4. Based on analytics reports, current situation, and the performance optimization targets, the SON function adjusts the resource allocation (e.g. addition, reduction) for the NSIs. If the NSI needs to be adjusted to optimize performance, e.g. configure policies, scale in or out resources, network slice management systems checks the feasibility of the change requirements and initiates the provisioning of changes +5. SON function continues monitoring NSIs to validate the actions being taken, and may perform additional adjustments if necessary. + +### 5.1.4 Post-conditions + +The resource utilization for the NSI is optimized based on the indicated aspect. + +## 5.2 Self-establishment of 3GPP NF, including automated software management + +### 5.2.1 Goal + +The new-installed NG-RAN node or 5G Core Network node to be configured in automated manner with no or minimal manual intervention. + +### 5.2.2 Pre-conditions + +The NG-RAN or 5G Core Network node has been installed. The node has implementation of the self-configuration function. It is configured with initial OAM setup information e.g. local OAM IP address + +The producer of the self-configuration service in the network is activated. + +### 5.2.3 Steps + +1. The network node is powered up. +2. The network node may start the process of discovering self-configuration services provided in the network. +3. When proper self-configuration service producer is discovered, the network node establishes connection with the self-configuration service producer. +4. Mutual authentication and authorization is performed by the network node and the self-configuration service producer. +5. The network node requests configuration data and software from the self-configuration service producer and receives the configuration data that may include radio configuration data, connectivity data, etc. and software +6. The network node performs self-configuration and automated software management procedure based on the received configuration data and software. +7. The network node establishes external interfaces to other network nodes and becomes operational. + +## 5.3 Automatic Neighbour Relation (ANR) management (including automatic X2 and Xn setup) + +### 5.3.1 Introduction + +ANR is defined by RAN3 in clause 5.3.3 of TR 38.300 [13] and resides in the gNB. Typically, it runs continually from the deployment of the gNB. When ANR discovers a new Neighbour Cell Relation (NCR) candidate, either for an intra-NR cell or for an LTE cell, it adds the NCR to its internal list of NCRs and sets up an Xn connection to the neighbour gNB, or an Xn connection to the neighbour ng-eNB, or an X2 connection to the neighbour en-eNB. NCRs that have not been used for handovers after a certain time are removed by ANR. + +In some cases, an NCR needs to be prohibited, or enforced. + +### 5.3.2 Pre-conditions + +5G NR cells are in operation. + +The ANR function is active in gNBs. + +The NG-RAN and the provider(s) of the NG-RAN provisioning management service is deployed and active. + +### 5.3.3 Description + +The default configuration for a newly deployed gNB is for the ANR function in a gNB to be active for all its cells. As ANR might not be wanted for a cell in a gNB, the ANR function can be switched off for that cell. + +The ANR function, residing in the gNB, automatically adds NCRs to the internal list of NCRs. It also has the ability to remove an NCR, for example when the NCR has not been used for handover for a certain amount of time. The MnS producer has the possibility to send notifications when an NCR has been added. The MnS consumer, receiving this notification might find out that this NCR is not wanted. In this case, the MnS consumer can blacklist that NCR. Blacklisting consists of marking the NCR as not to be used for handover and marking it sticky, i.e. the ANR function will not time out and not remove the NCR. + +Conversely, the MnS consumer might find that the ANR function fails to add a wanted NCR. In this case the MnS consumer can whitelist that NCR. Whitelisting consists of creating the NCR from the MnS consumer, marking it to be used for handover and marking it sticky, i.e. the ANR function will not time out and not remove the NCR. + +The MnS producer also lets the MnS consumer read the list of NCRs, the whitelist and the blacklist. + +## 5.4 Automatic Neighbour Relation (ANR) optimization + +### 5.4.1 Goal + +The goal is to optimize the Neighbor Cell Relations (NCRs) configured at the NG-RAN node. + +### 5.4.2 Pre-conditions + +The NG-RAN and the provider(s) of the NG-RAN provisioning management service and NG-RAN PM service are deployed and active. + +The ANR optimization function is deployed and active. It is a consumer of NG-RAN provisioning management service and also it is subscribed to the PM measurements related to mobility management and the RLF/RCEF reports. The measurements may include such performance indicators as statistics of failed / dropped RRC connections, handover failures etc. + +### 5.4.3 Steps + +The ANR optimization function optimizes the NCRs in the following ways: + +1. The ANR optimization function gets the geographical data and terrain data of the NR cells from a data source (such as radio planning tool), and consumes the NF provisioning management service to get the configuration parameters of the NR cells. The ANR optimization function analyses the received data and determines to add or blacklist one or more NCRs. +2. The ANR optimization function monitors the performance (e.g. failed / dropped RRC connections, handover failures, RLF/RCEF reports, etc.) of the NCRs of the NR cells. Based on the performance of the NCRs, the ANR optimization function may decide to blacklist one or more NCRs. + +This Use Case ends when the NG-RAN cells are taken out of service or when the ANR optimization function is stopped. + +## 5.5 PCI Configuration + +### 5.5.1 Introduction + +Each gNB is assigned a PCI (Physical-layer Cell ID) that is broadcast in PSS (Primary Synchronization signal) and SSS (Secondary Synchronization signal). When an UE receives PSS and SSS to acquire time and frequency synchronization, it also obtains the PCI that is used to uniquely identify an NR cell. There are 1008 unique PCIs (see clause 7.4.2 in TS 38.211 [25]). Therefore, PCIs need to be reused, as massive number of NR cells and small cells operating in millimetre wave bands are deployed. Typically, operators use network planning tool to assign PCIs to cells when the network is deployed to insure all neighbouring cells have different PCIs. However, due to the addition of new cells or changes of neighbour relations from ANR functions, problems can arise, such as: + +- PCI collision: Two neighboring cells have the same PCIs; +- PCI confusion: A cell has 2 neighboring cells with the same PCI value, where Cell #A has PCI that is different from the PCIs of its two neighbors – Cell #B and Cell #C, but Cell #B and Cell #C have the same PCI. PCI confusion can impact the handover performance as UEs are confused with which cell they should handover to. + +The goal is to configure the PCIs of NR cells which are newly deployed and to re-configure the PCIs of NR cells which endure the problem of PCI confliction or PCI confusion. There are two ways to configure the PCI – centralized PCI configuration and distributed PCI configuration, as described in clause 5.2.1 in TR 37.816 [12]. + +### 5.5.2 Pre-conditions + +The NG-RAN is deployed and active, besides, the provider(s) of NG-RAN provisioning management service or NG-RAN fault management service is deployed and active. + +The PCI optimization function (located in 3GPP management system) is deployed and activated. It is a consumer of NG-RAN provisioning management service or NG-RAN fault management services related to PCI confliction or confusion. + +### 5.5.3 Steps + +#### 5.5.3.1 Management of distributed PCI configuration + +1. The PCI management and control function sets a list of PCI values to be used by a NR cell, and activates the distributed PCI configuration function. +2. The distributed PCI configuration function randomly selects a PCI value from the list of PCI values provided by PCI management and control function (see clause 5.2.1 in TR 37.816 [12]). +3. The distributed PCI configuration function reports the PCI value selected for this NR cell to the PCI management and control function. + +#### 5.5.3.2 Centralized PCI configuration + +1. The centralized PCI configuration function monitors and collects the PCI related data (e.g. the measurements related to measurement report, such as `physCellId`, `MeasQuantityResults`, which are generated from the `MeasResultNR` (see clause 6.3.2 in TS 38.331 [6])) reported by NG-RAN. +2. The centralized PCI configuration function analyses the PCI related information to detect new deployed NG-RAN or PCI confliction or confusion of the NR cells. +3. The centralized PCI configuration function consumes NG-RAN provisioning service to configure a specific PCI value or a list values for each newly deployed NR cell or re-configure a PCI value or a list values for the NG-RAN cell which is in the problem of PCI confliction or confusion. +4. NG-RAN performs PCI selection according to the configured specific PCI or list of PCIs. +5. If the newly deployed NR-RAN cell is not correctly configured or PCI confliction or confusion is not resolved, the centralized PCI configuration function reverts to Step 3. + +This Use Case ends when the new deployed NG-RAN cells are configured successfully, or the NG-RAN cells are taken out of service or when the centralized PCI configuration function is stopped. + +### 5.5.4 Post-conditions + +The PCIs for the NR cells have been configured or corrected. + +## 5.6 Automatic Network Configuration Data Handling + +### 5.6.0 Introduction + +The use case for automatic radio network configuration data handling described in clause 6.4.1.1 in TS 32.501 [3] can be applicable to 5G. + +### 5.6.1 Goal + +Transfer the automatic network configuration data to the MF providing ANCF data and ensure that it is valid when it is used during self-configuration. ANCF data are the data which are required for successful activation of NF and cannot be generated during self-configuration process. + +### 5.6.2 Pre-conditions + +Automatic network configuration data is known to the ANCF MnS Consumer. + +### 5.6.3 Steps + +1. (Optional) MF consuming the ANCF data indicates need for automatic network configuration data to the MF providing ANCF data. + +2. MF providing ANCF data transfers the automatic network configuration data to MF consuming ANCF data or indicate the MF consuming ANCF data where the automatic network configuration data is available and MF consuming ANCF data retrieve the data from there. +3. (Optional) MF providing ANCF data requests the MF consuming ANCF data to validate the received automatic network configuration data. +4. MF consuming ANCF data validates the received automatic network configuration data. + +### 5.6.4 Post-condition + +The self-configuration process can use the automatic network configuration data. + +## 5.7 Load Balancing Optimization + +### 5.7.1 Introduction + +It includes the management of distributed LBO and centralized LBO. + +### 5.7.2 Pre-conditions + +NG RAN and 5GC are in operation. + +### 5.7.3 Description + +#### 5.7.3.1 The management of distributed LBO + +The LBO management and control function sets the target of D-LBO function + +The LBO management and control function activates the D-LBO function to balance the cell load among gNB(s) automatically. + +#### 5.7.3.2 Centralized LBO + +The LBO management and control function receive the target of LBO from consumers. + +The C-LBO function collects the load performance measurements (e.g. radio resource usage, HW / VR / TNL load indicators, Composite Available Capacity PRB, TNL measurements, ...) or notifications (e.g. threshold crossing of certain measurements) from gNB-CU-CP, gNB-CU-UP(s), gNB-DU(s). + +The C-LBO function analyses the load measurements to determine the actions, if needed, including the configuration of the handover and/or reselection parameters, and the initiation of changing virtualized resources, to optimize the traffic load distributions among neighboring cells, + +The C-LBO function collects the performance measurements (e.g. the number of RRC connection establishment / release, abnormal release, handover failures, call drops, etc...) to evaluate the LBO performance, and may update the handover and/or reselection parameters of the cell or its neighbors. + +### 5.7.4 Post-conditions + +The cell load of gNB(s) have been optimized. + +## 5.8 Void + +## 5.9 RACH Optimization (Random Access Optimization) + +### 5.9.1 Introduction + +A poorly configured RACH (Random Access Channel) may increase the time it takes for an UE to access the network, and may increase the accesses failures that can impact call setup performance. RACH optimization is to automatically configure the RACH parameters in a cell in order to achieve the optimal network performance by reducing the network access time, and minimize the failures. + +### 5.9.2 Pre-conditions + +5G NR cells are in operation. + +RACH management and control function is in operation. + +RACH optimization function is active. + +### 5.9.3 Description + +RACH optimization function is running to optimize the RACH performance by adjusting RACH parameters, such as RACH-ConfigCommon properties specified in TS 38.331 [6], clause 6.3.2 automatically. + +The RACH management and control function sets the targets for RACH optimization function, and collects the following performance measurements to monitor the RACH performance: + +- Distribution of the number of preamble UEs sent to achieve synchronization, where the number of preamble sent corresponds to PREAMBLE\_TRANSMISSION\_COUNTER (see clause 5.1.1 in TS 38.321 [5]) in UE. +- Distribution of the time needed for UEs to achieve synchronization; + +NOTE: These performance measurements are reported in the most timely manner to monitor the RACH performance. + +The RACH management and control function analyses the measurements, and may perform one of the following actions, if the RACH performance does not meet the target: + +1. Update the targets for RACH optimization function; +2. Update the ranges of RACH parameters for NR cells; +3. Disable RACH optimization function, and configure the RACH parameters for the NR cells with values deemed to improve RACH performance. +The RACH management and control function should not configure the RACH parameters when the RACH optimization function is active. + +### 5.9.4 Post-conditions + +The RACH performance in NR cells is optimized. + +## 5.10 Centralized Capacity and Coverage Optimization + +### 5.10.1 Goal + +The goal is NG-RAN coverage and capacity optimization for NR cells. + +### 5.10.2 Pre-conditions + +NG-RAN in certain geographic area is active, managed by the provider(s) of the NG-RAN provisioning management service and the PM service. + +The CCO SON function is active and consumes the NG-RAN and 5GC provisioning management services and the PM services, provided by the corresponding providers. + +The measurements received by the CCO function may include indicators of network performance, which may include indications of bad coverage such as of RSRP and RSRQ statistics, RLFs, failed / dropped RRC connections, handover failures etc. Additional information sources can be taken into account, such as MDT (UE level trace) and information carried in the CDRs. + +### 5.10.3 Steps + +1. The CCO function is monitoring the performance indicators of the NG-RAN cells, certain areas or beams within the cells, and may monitor 5GC for example CDRs of such events as voice call drops, by collecting performance + +measurements, such as RSRP, RSRQ, SINR, and RLF measurements for cells and beams within the cell (see clause 6.3.2 in TS 38.331 [6]). + +2. If the CCO function detects coverage hole or capacity (performance) degradation in some cells, certain areas or beams within the cell, by analysing measurements, such as RSRP, RSRQ, SINR, and RLF measurements of DL SSB beams. + +Some examples of degradation criteria are too low signal strength, low success rate for RRC connection attempts, for random access attempts etc. + +3. The CCO function determines the actions needed to improve the coverage and/or capacity of cell and areas within the cell. +4. The CCO function modifies the configuration parameters in the cell and/or in one or several neighbor cells or configuration of the 5GC, such as PCF policies to reduce the load, and continues monitoring the PM measurements. +5. If the network performance does not recover, the CCO function adjusts the modifications made in the Step 2. +6. Return to the Step 1. + +This Use Case ends when the monitored cells are taken out of service or when the CCO function is stopped. + +## 5.11 Self-healing + +The use cases of Self Recovery of NE Software, Self-healing of board faults and Self-healing of Cell Outage described in TS 32.541 [14] can be applied for 5G NE. The description of use case needs to be revisited to align with the service based management architecture. + +## 5.12 SON coordination + +The function SON coordination has not been addressed in the present document. + +## 5.13 Multi-vendor Plug and Play of NFs + +### 5.13.0 Introduction + +Use case of multi-vendor plug and connect eNB to network defined in clause 6.4.3 in TS 32. 501[3] can be applicable for non-virtualized NF in 5G network. + +Use case of managing EM IP address provided to instantiated VNF using MVPNP defined in clause 6.4.3 in TS 28.525 [4] can be applicable for VNF in 5G network. + +### 5.13.1 Multi-Vendor Plug and Connect NF to Management System + +#### 5.13.1.1 Goal + +After NF deployed (physical installation for non-virtualized NF or instantiation for VNF), connect the NF (e.g. NG RAN Node, 5GC Node) to its management system providing support for self-configuration processes automatically as possible. + +#### 5.13.1.2 Pre-condition + +The NF is deployed (physical installation for non-virtualized NF or instantiation for VNF). + +#### 5.13.1.3 Steps + +1. If a VLAN ID is available the NF uses it. Otherwise the NF uses the native VLAN where PnP traffic is sent and received untagged. +- 2 The NF acquires its IP address through stateful or stateless IP auto-configuration. +3. The NF acquires the IP address of the CA/RA server. +4. The NF performs Certificate Enrolment. + +5. The NF acquires the IP address of the OAM SeGW. +6. The NF establishes a secure connection (tunnel) to the Security Gateway. +7. The NF acquires the IP address of the correct management system providing support for self-configuration process. +8. The NF establishes a connection to the provided management system providing support for self-configuration and acquires its configuration and software if any. + +#### 5.13.1.4 Post-condition + +One or more secure connections exist between the NF and the management system providing support for self-configuration process. + +### 5.13.2 Self-configuration of a new NF + +#### 5.13.2.1 Goal + +After NF deployed (physical installation for non-virtualized NF or instantiation for VNF), put in an automated manner the NF into a state to be ready to carry traffic. + +#### 5.13.2.2 Pre-condition + +- The NF is deployed (physical installation for non-virtualized NF or instantiation for VNF) and connect to IP network. +- One or more secure connections exist between the NF and the management system providing support for self-configuration. +- The (transport and radio) configuration data and software packages for the NF is made available in management system providing support for self-configuration. + +#### 5.13.2.3 Steps + +1. The NF provides information about its type, hardware and other relevant data about itself to the management system providing support for self-configuration. +2. Management system providing support for self-configuration take the decision of which software and (transport and radio) configuration data have to be downloaded to the NF. +3. Management system providing support for self-configuration download the software and (transport and radio) configuration data to the NF. +4. Management system providing support for self-configuration also update the dependent nodes with new configuration data as well if required. +5. NF performs a self-test. +6. Management system providing support for self-configuration inform its Consumer about the progress of the self-configuration process and important events occurring during the self-configuration process. + +#### 5.13.2.4 Post-condition + +The NF (5GC Node or NG-RAN Node) is ready to carry traffic. + +## 5.14 SON for AAS-based Deployments + +In E-UTRAN networks, SON for AAS-based Deployments uses techniques like cell splitting and cell merging. As the NG-RAN uses beamforming for sub-sector structures, these techniques are not relevant for NR-RAN. Instead, Coverage and Capacity Optimization will cover this topic. + +## 5.15 Trace and MDT + +Use cases from TS 32.421 [30], clause 5.8 apply. + +## 5.16 Mobility Robustness Optimization + +### 5.16.1 Introduction + +5G NR cells may experience issues, such as too early or too late handover, handover to wrong cell, ping-pong handover, that not only impact user experience, but also waste network resources, if handover parameters are not set properly. Mobility Robustness Optimization (MRO) is intended to automatically configure the handover parameters in cells in order to improve the handover performance. + +### 5.16.2 Pre-conditions + +5G NR cells are in operation. + +MRO management and control function is in operation. + +MRO function is active. + +### 5.16.3 Description + +MRO function is running to optimize the handover performance by adjusting handover parameters automatically. + +The MRO management and control function sets the ranges of the NR and EUTRAN handover parameters and the targets for the MRO function, and collects handover related measurements and radio link failure (see clause 5.3.10 in TS 38.331 [6]) reports to monitor the handover performance: + +The MRO management and control function analyses the measurements and radio link failure reports, and may perform one of the following actions, if the handover performance does not meet the target: + +1. Update the targets for MRO function; +2. Update the ranges of handover parameters for the NR neighbour relations and EUTRAN neighbour relations; +3. Disable MRO function, and configure the handover parameters (see clause 5.5.4 in TS 38.331 [6]) for NR neighbour relations with values deemed to improve handover performance. + +NOTE: The MRO management and control function should not configure the handover parameters when the MRO function is active. + +### 5.16.4 Post-conditions + +The handover performance in and across NR and EUTRAN neighbour relations is optimized. + +## 5.17 Energy Saving Management + +Energy saving management is addressed in TS 28.310 [24]. + +## 5.18 Automatic NSI creation + +### 5.18.1 Introduction + +Network slicing in 5G provides mobile operators opportunities and flexibility to create services tailored for various customers on demand. Automatic NSI creation enables operators to create the NSI that contains 5G CN NF, gNB CU, and gNB DU automatically, based on the requirements given by the customers. + +### 5.18.2 Pre-conditions + +NG RAN and 5GC are in operation. + +### 5.18.3 Description + +The service producer of automatic NSI creation receives the network slice related requirements to support communication services from an authorized consumer. + +The service producer of automatic NSI creation analyses requirements to determine the NSSIs, network functions and resources needed to support the requirements. + +The service producer of automatic NSI creation creates an NSI, which may include the instantiation of new network functions, configuration of existing NF, and interworking with transport management system to allocate the transport resources if needed. + +### 5.18.4 Post-conditions + +The NSI is created. + +## 5.19 Optimization of the quality of communication services + +### 5.19.1 Goal + +The goal is to enable service quality optimization. For example, the goal can be to minimize average latency on the communication services provided to the URLLC category of services. + +### 5.19.2 Pre-conditions + +A set of communication services is provided by the network to certain group (category) of the UEs. The services may be provided with relation to certain NSI(s). + +The following functions are deployed and active: + +- NG-RAN, 5GC +- The providers of the NG-RAN and 5GC provisioning and Performance assurance MnS for the NG-RAN and 5GC nodes, which are essential for the quality of the set of services. +- The providers of the NSI / NSSI provisioning and Performance assurance MnS for the relevant NSI(s) / NSSI(s) (if there are any), which are essential for the quality of the set of services received by the group (category) of the UEs; +- Network management system consuming above services; this function is aware of the performance requirements imposed on the set of services. + +For example, for the URLLC latency optimization, the latency components can be measured by the involved network nodes and processed to compute the average end-to-end latency. + +### 5.19.3 Steps + +1. The service optimization function is collecting the performance data and monitoring the performance indicators related to the targeted services. + +For example, for the URLLC latency optimization, the management system may collect the latency components contributed by the involved network nodes and communication links measured by the involved network nodes; these components are processed to compute the average end-to-end latency. + +2. If the service optimization function detects performance degradation, it modifies the configuration parameters in the corresponding NG-RAN and 5GC nodes and NSI(s)/NSSI(s), using the NG-RAN, 5GC, and NSI(s)/NSSI(s) (if relevant) provisioning services, and continues monitoring the performance. +3. If the network performance does not recover, the service optimization function adjusts the modifications made in the Step 2. +4. Return to the Step 1. + +This Use Case ends when the monitored services or network nodes or NSI(s)/NSSI(s) are taken out of service or when the service optimization is stopped. + +## 5.20 Cross-slice network resource optimization + +### 5.20.1 Goal + +The goal is to enable the authorized consumer to optimize the resource allocation across multiple NSIs of the total available physical and virtual resources. The resources associated with an NSI are those resources associated with NSSIs in 5GC and resources associated with NSSIs in NG-RAN. + +### 5.20.2 Pre-conditions + +- Multiple NSIs have been deployed. +- The NSI management service producer is in operation. + +### 5.20.3 Steps + +1. (Optional) For shared NSIs, the NSI management service provider may need to check policies, slice priorities and resource requirements of several services sharing the NSI. +2. Unless there are policies already determining configurations, the SON service provider determines thresholds to trigger network resource optimizations (e.g. increase or decrease NSI capacities like storage, computing, network bandwidth and radio resources), such as thresholds in network traffic loading, a network resource usage percentage, and available bandwidth, based on policies and requirements of services using the NSI and taking the slice priority into account. +3. The SON service provider collects the performance data (related to data volume, the number of registered UEs, the number of PDU sessions, ... etc.), as well as data indicating changes in the network resources (e.g. from the NFV-MANO system or from the TN network) available for the NSIs, and utilizes the historical performance data collected in the past days, weeks, months, and beyond to understand the traffic patterns for the NSIs, and predictions regarding the demand for each NSI for a given time and location. This information is analysed, for example, by the MDAF, and the information may include data from NSI constituents data analytics entities, such as NWDAF, e.g. regarding the load of some network functions. +4. Based on analytics reports, current situation and changes in network resource usage, and the network resource optimization targets, the SON service provider determines whether the NSIs can still be supported by the available resources. If this is not the case, the SON service provider determines how resource allocation (e.g. addition, reduction) for the NSIs needs to be adjusted. If NSI needs to be adjusted, e.g. configure policies, scale in or out resources, the SON service provider checks the feasibility of the change requirements. +5. If network resource optimization cannot fulfill the resource requirements and policies of all NSIs, the SON function will inform the CSP that resource requirements or slice priorities need to be changed to help solve NOP resource problems. +6. The CSP responds to the request with a set of adjusted resource requirements and slice priorities. +7. The SON service provider provides the (adjusted) resource requirements and slice priority data provided by the CSP to the NSI management service provider which then initiates the provisioning of changes. +8. The SON service provider continues monitoring NSIs to validate the actions being taken, and may perform additional adjustments if necessary. + +### 5.20.4 Post-conditions + +The total virtual and physical resource allocation is optimized to sustain all the NSI with their current resource utilization. + +## 5.21 Multi-aspect / multi-domain resource optimization + +### 5.21.1 Goal + +The goal is to enable joint resource optimization across multiple domains (e.g. AN, CN) among multiple network aspects including the Radio resources, virtualized network functions and network slices. + +### 5.21.2 Pre-conditions + +A set of communication services is provided by the network to certain group (category) of the UEs. The services can be provided with or without relation to certain NSI(s). + +The following functions and services are deployed and active: + +- NG-RAN, 5GC, NSI(s). +- The performance assurance (PM), fault supervision (FM) and provisioning (CM) services are available across different network aspects. +- The provider of Multi-Aspect Resource Optimization (MARO). + +The provisioning, assurance and supervision services provide information on the multiple aspects, the information characterized by: + +- Status details on network resources for different resource types, e.g. both physical radio resource and virtual resources. +- Information from one or multiple network slices and slice subnets. +- For each subnet/slice/infrastructure aspect, information on allocated resources and their utilization, event history (e.g. recent overload situations), history of actions taken (e.g. LB decisions, scaling of virtual resources). + +### 5.21.3 Description + +The provider of MARO is running to jointly optimize resource utilization among multiple network aspects. + +The provider of MARO consumes network resource-related provisioning, assurance and supervision services on the different network aspects including Radio resources and virtual resources; the deployment environments including virtual machines or cloud instances; as well as the slices and subnets utilizing these functions. + +The provider of MARO offers management capabilities on the resource parameters configuration. + +### 5.21.4 Steps + +The provider of multi-aspect resource optimization (MARO) takes network status inputs from multiple domains and derives the policies for network configuration and optimization. This may be specific to a single network slice or it may be applicable to multiple network slices. + +The provider of MARO consumes performance assurance (PM), fault supervision (FM) and provisioning (CM) services across different domains. The information retrieved may consist of network resource-related data (both physical and virtual resources), which may be characterized as, but not restricted to: + +- The information from one or multiple network slices, slice subnets and/or infrastructure domains (physical and virtual) +- For each domain/subnet/slice, information on allocated resources and their utilization, event history (e.g. recent overload situations), history of actions taken (e.g. MLB decisions, scaling of resources) + +The provider of MARO then: + +- Analyses the collected data for resource optimization across different infrastructure domains for either a single network slice or multiple network slices +- Correlates the data across network slices or slice subnets. Note that although from network planning some initial mapping on resource allocation across domains is known, correlation of performance in the different domains is + +still necessary. For example, even given CU/DU split with known resource allocation in each domain the relative performance in each domain (CU-virtual resource utilization, vs. DU physical load) needs to be correlated. + +- Calculates/generates network resource provisioning policy improvements. Non-exhaustive list of examples of policy improvements may be: + - Adjusting the policy on scaling of virtual resources based on the observation that RAN MLB (on physical resources) was performing well but the virtual resources were not adequately provisioned. + - Change the characteristics of transport links based on observed transport network performance bottleneck. + - Change in the network slice or subnet resource provisioning for inter-slice resource optimization +- Exposes obtained policy improvements as a service toward other network functions. + +The policy improvement service exposed can be either: + +- Directly applied by MDROF by utilizing the configuration management service of the related network function +- Consumed by the domain-specific control function which: + - takes into account all the existing policy improvement requests related to that particular domain/resource. + - analyses potential conflicts among policy improvements. + - resolves identified conflicts among policy improvements and derives the actual policy improvement to be applied within that specific domain. + - applies the resulting policy improvement through the configuration management of involved network function. + +## 5.22 Automatic CSI creation + +### 5.22.1 Goal + +The goal is to enable operators to properly design and initiate a new communication service. Automatic CSI creation is able to digest the SLA into service profile so that corresponding network functionalities can use the service profile. + +### 5.22.2 Pre-conditions + +A set of E2E services is provided by the network to certain group (category) of the UEs. + +The following functions and services are deployed and active: + +- NG-RAN, 5GC, CSI(s), NSI(s) + +### 5.22.3 Description + +The service producer of automatic CSI creation receives the SLA requirements from an authorized consumer. + +The service producer of automatic CSI creation analyses SLA requirements to determine the resource parameters configuration needed to support the requirements. + +The service producer of automatic CSI creation needs to analysis between the input SLA with the capability of existing network resource during feasibility check, and provide the possible negotiate the output service profile. + +### 5.22.4 Post-conditions + +The CSI is created. + +# --- 6 Potential requirements + +## 6.1 Self-Establishment of NG-RAN and 5GC nodes, including automated Software Management + +- REQ-SC-1** The self-establishment functionality at the network node should be capable of self-configuration service producer discovery, mutual authentication, authorization, and registration for the service with the producer of the self-configuration service +- REQ-SC-2** The self-establishment functionality at the network node, should be capable of receiving the configuration data, and consequent self-configuration +- REQ-SC-3** The producer of the self-configuration service should be capable of supporting the procedure of self-configuration service producer discovery, mutual authentication and authorization +- REQ-SC-4** The provider of the self-configuration service should be capable of delivery of the configuration data to the consumer that requested the data +- REQ-SC-5** The self-establishment functionality at the network node, should be capable of receiving the software, and consequently using + +## 6.2 Automatic Neighbour Relation (ANR) management (including automatic X2 setup) + +- REQ-ANR-CON-1** The MnS (i.e., MnS for ANR management) producer shall support a capability allowing the MnS consumer to switch ANR on and off for each cell. The default value for ANR is to be switched on. +- REQ-ANR-CON-2** The MnS producer shall support a capability allowing the MnS consumer to whitelist an NCR. +- REQ-ANR-CON-3** The MnS producer shall support a capability allowing the MnS consumer to blacklist an NCR. +- REQ-ANR-CON-4** The MnS producer shall support a capability allowing the MnS consumer to prohibit the setting up of Xn or X2 connections to a neighbour for a certain NCR. +- REQ-ANR-CON-5** The MnS producer shall support a capability allowing the MnS consumer to read the NCRs, the blacklist and the whitelist. +- REQ-ANR-CON-6** The MnS producer shall support a capability allowing the MnS consumer to receive notification when the ANR function adds or removes an NCR in an NR cell + +## 6.3 Automatic Neighbour Relation (ANR) optimization + +- REQ-ANRO-1** The ANR optimization function should be able to monitor the performance of the cells using by NG-RAN PM services. +- REQ-ANRO-2** The ANR optimization function should be able to set / modify the neighbour configuration parameters in the cells using the NG-RAN Provisioning services. +- REQ-ANRO-3** The ANR optimization function should be able to monitor the statistics of UE measurement results for intra-RAT neighbour relations and inter-RAT neighbour relations for NR cells. +- REQ-ANRO-4** The ANR optimization function should be able to create, modify, or delete the intra-RAT and inter-RAT neighbour relations for NR cells. + +## 6.4 PCI Configuration + +- PCI-OPT-CON-1** The MnS of performance assurance should have a capability to collect the information related to PCI collision or PCI confusion. +- PCI-OPT-CON-2** The MnS of performance assurance should have a capability to provision the PCIs of one or more NR cells. + +**PCI-CONFIG-3** The MnS of provisioning should have a capability to set the list of PCI values for a NR cell. + +**PCI-CONFIG-4** The MnS of provisioning should have a capability to activate or deactivate the distributed PCI configuration function for a NR cell. + +## 6.5 Void + +## 6.6 Load Balancing Optimization + +**REQ-LBO-1** LBO management and control function should have the capability to set and update the LBO targets and initiates the changes of virtualized resources for distributed LBO. + +**REQ-LBO-2** LBO management and control function should have the capability to activate or deactivate D-LBO function. + +**REQ-LBO-3** C-LBO function should have the capability to collect the load performance measurements and notifications needed for LBO function. + +**REQ-LBO-4** C-LBO function should have the capability to determine the actions, including the configuration of the handover and/or reselection parameters, and the initiation of changing virtualized resources, to optimize the traffic load distributions among neighbouring cells. + +**REQ-LBO-5** C-LBO function should have the capability to collect the performance measurements to evaluate the C-LBO performance. + +## 6.7 Void + +## 6.8 RACH Optimization (Random Access Optimization) + +**REQ-RACH-1** RACH management and control function should have a capability to set the targets for RACH optimization function. + +**REQ-RACH-2** RACH management and control function should have a capability to collect performance measurements, such as distribution of the number of preamble UEs sent to achieve synchronization, distribution of the time needed for UEs to achieve synchronization. + +**REQ-RACH-3** RACH management and control function should have a capability to set and update the targets of RACH optimization function, and the ranges and values of the RACH parameters for NR cells. + +**REQ-RACH-4** RACH management and control function should have a capability to enable or disable the RACH optimization function. + +## 6.9 Centralized Capacity and Coverage Optimization + +**REQ-CCO-1** The CCO function should be able to collect the performance indicators related to coverage and capacity, using PM management services + +**REQ-CCO-2** The CCO function should be able to set / modify the RAN and 5GC configuration parameters that affect coverage and capacity. + +**REQ-CCO-3** The CCO function (in 3GPP management system) should have a capability to collect measurements, such as RSRP, RSRQ, SINR, and RLF measurements for cells and DL SSB beams. + +**REQ-CCO-4** The MnS producer shall provide a capability allowing the MnS consumer to configure sectors. A sector is defined by its spatial information (pointing direction, width and shape). + +## 6.10 Void + +## 6.11 Self-healing + +The function Self-healing has not been addressed in the present document. + +## 6.12 SON coordination + +The function SON coordination has not been addressed in the present document + +## 6.13 Multi-vendor Plug and Play of NFs + +See clause 6.1. + +## 6.14 SON for AAS-based Deployments + +In E-UTRAN networks, SON for AAS-based Deployments uses techniques like cell splitting and cell merging. As the NG-RAN uses beamforming for sub-sector structures, these techniques are not relevant for NR-RAN. Instead, Coverage and Capacity Optimization will cover this topic. + +## 6.15 Trace and MDT + +Requirements from TS 32.421 [30] clause 5 apply. + +## 6.16 Mobility Robustness Optimization + +**REQ-MRO-1** MRO management and control function should have a capability to set the targets for MRO function. + +**REQ-MRO-2** MRO management and control function should have a capability to receive handover related performance measurements and radio link failure reports. + +**REQ-MRO-3** MRO management and control function should have a capability to configure the ranges of handover parameters for NR neighbour relations and EUTRAN neighbour relations. + +**REQ-MRO-4** MRO management and control function should have a capability to enable or disable the MRO function. + +## 6.17 Energy Saving Management + +Energy saving management is addressed in TS 28.310 [24]. + +## 6.18 NSI resource allocation optimization + +**REQ-NSI\_RAO-1** 3GPP management system should have a capability to collect the performance data (including data volume, the number of registered UEs, and the number of PDU sessions ... etc.) for NSIs and NSI constituents. + +**REQ-NSI\_RAO-2** NSI resource allocation optimization function should have a capability to adjust the resource allocations for the NSIs and NSI constituents. + +## 6.19 Automatic NSI creation + +**REQ-ANSIC-CON-1** The service producer of automatic NSI creation should have a capability to receive the network slice related requirements to support the communication service. + +**REQ-ANSIC-CON-2** The service producer of automatic NSI creation should have a capability to create an NSI. + +## 6.20 Requirements related to the service quality optimization + +**REQ-SQO-1** The Performance assurance MnS for NG-RAN, 5GC and slicing, should support the capabilities to provide performance data related to the quality of communication services provided to a group (category) of UEs. + +**REQ-SQO-2** The provisioning MnS for NG-RAN, 5GC and slicing, should support the capabilities allowing to set / modify the configuration parameters affecting the quality of communication services provided to a group (category) of UEs. + +## 6.21 Cross-slice network resource optimization + +**REQ-CNRO-1** 3GPP management system should have a capability to collect the performance data (including data volume, the number of registered UEs, and the number of PDU sessions ... etc.) for NSSIs and NSSI constituents. + +**REQ-CNRO-2** 3GPP management system should have a capability to collect the network resources utilization data (storage, computing, network bandwidth and radio resources) for NSSIs and NSSI constituents. + +**REQ-CNRO-3** 3GPP management system should have a capability to detect changes in the total amount of available network resources (storage, computing, network bandwidth and radio resources) for NSSIs and NSSI constituents. + +**REQ-CNRO-4** Cross-slice network resource optimization functionality should have a capability to adjust the resource allocations for the NSSIs and NSSI constituents. + +**REQ-CNRO-5** Cross-slice network resource optimization functionality should have a capability to inform a CSP if resource requirements or slice priorities need to be changed in order to continue operation of the slice. + +**REQ-CNRO-6** Cross-slice network resource optimization functionality should have a capability to receive a response from the CSP and adjust the NSI based on its contents. + +**REQ-CNRO-7** Cross-slice network resource optimization functionality should have a capability to analyse the performance data, resource utilization data and the available network resources. + +# --- 7 Potential solutions + +## 7.1 Self-establishment of NFs including automated Software Management + +The Figure 7.1-1 illustrates the major phases for self-establishment of NF (5GC Node and NG-RAN Node). + +![Flowchart showing the major phases of NF self-establishment: 1. ANCF Data Handling, 2. Multi-vendor plug and connect to management system, 3. Self-Configuration.](ae9b822eaafef535b7a0fbb97a7c713b_img.jpg) + +``` +graph TD; A[1 ANCF Data Handling] --> B[2 Multi-vendor plug and connect to management system]; B --> C[3 Self-Configuration]; +``` + +Flowchart showing the major phases of NF self-establishment: 1. ANCF Data Handling, 2. Multi-vendor plug and connect to management system, 3. Self-Configuration. + +**Figure 7.1-1: Major phases of NF self-establishment** + +Following are description for major phases of NF establishment. + +### **Pre-condition for self-establishment of NF:** + +- NF is installed. For non-virtualized NF, the NF is physically installed. For VNF, the VNF is instantiated. + +#### **Stage 1: ANCF data handling** + +This stage is to make the Automatic Network Configuration data (ANCF data) available to the management system support self-configuration process, which may include ANCF data preparation, ANCF data transfer and ANCF data Validation. + +TS 32.502 [22] defines the automation radio configuration data for eNB. For 5G, following ANCF data needs to be defined: + +For NG-RAN Node: Automatic radio configuration data and automatic transport configuration data. + +For 5GC Node: Automatic core network configuration data and automatic transport configuration data. + +TS 32.502 [22] defines IRP based operations to transfer ARCF data. For 5G, needs to consider whether these operations can be applicable and define MnS based solution for these operations if applicable. Also needs to consider whether additional operations needed. + +#### **Stage 2: Multi-vendor plug and connect to management system** + +This stage is to connect the NF to its management system provide support self-configuration process as automatically as possible. MvPnC include following functionality: initial IP Autoconfiguration service, Certificate enrolment, establish secure connection, establish connect to management system provide support self-configuration process. + +TS 32.508 [23] defines multi-vendor plug and connect to network procedure for eNB. For 5G, needs to consider whether the procedure is applicable for both NG-RAN Node and 5GC Node, and make it more generic to be applicable for both NG-RAN Node and 5GC Node which is virtualized or non-virtualized if applicable. + +#### **Stage 3: Self-Configuration** + +This stage is to put the NF into a state to be ready to carry traffic in an automated manner. Self-Configuration include following functionality: create self-configuration task, monitor self-configuration process, generate configuration data based on ANCF data, download and activate software, download and active configuration data, perform self-test and update network resource model, etc. + +TS 32.502 [22] define several IRP based operations for self-configuration management (e.g. `createScManagementProfile`, `resumeScProcess`, `notifyProcessStage`) for LTE. For 5G, needs to consider whether these operations can be applicable and define the MnS based operation if applicable. Also needs to consider whether additional operations needed. + +## **7.2 Automatic Neighbour Relation (ANR) management (including automatic X2 and Xn setup)** + +The ANR function deployed in the gNB is documented in clause 15.3.3 in TR 38.300 [13]. The ANR function is distributed, and its purpose is to add and remove NCRs. + +The solution for ANR management consists of the following items: + +- 1) When the ANR function adds a new `NRCellRelation` instance, the MnS producer notifies the MnS consumer that a new NCR has been created. +- 2) When the ANR function deletes a `NRCellRelation` instance, the MnS producer notifies the MnS consumer that an existing NCR has been deleted. +- 3) An attribute `isRemoveAllowed` of `NRCellRelation` allows the MnS producer to request the MnS consumer to prohibit the distributed ANR function to remove an existing NCR. +- 4) An attribute `isHOAllowed` of `NRCellRelation` allows the MnS producer to request the MnS consumer to prohibit handovers on this NCR. +- 5) Attributes `x2BlackList` and `xnBlackList` allow the MnS consumer to request the MnS producer to prohibit the gNB or gNB-CUCP to set up X2 respectively Xn connections for these particular NCRs. + +Attributes `x2WhiteList` and `xnWhiteList` allow the MnS consumer to request the MnS producer to configure the gNB or gNB-CUCP to set up X2 respectively Xn connections for these particular NCRs. + +## 7.3 PCI Configuration + +### 7.3.1 General + +This subclause the solutions for the use case of PCI configuration (see use case in clause 5.5). + +### 7.3.2 Management of distributed PCI configuration + +#### pCI configuration for newly deployed gNB + +The PCI management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [26]) to configure the PCI list for a given NR cell. + +The PCI management function may consume the management service for NF provisioning with *modifyMOIAttributes* operation to enable the D-PCI configuration function for a given NR cell. + +The D-PCI configuration function randomly selects a PCI value from the PCI list, (see clause 5.2.1 in TR 37.816 [12]). + +The D-PCI configuration function informs the management service producer for NF provisioning to send a notification *notifyMOIAttributeValueChange* (see clause 5.1.9 in TS 28.532 [26]), indicating the new PCI value(s) being selected. + +#### pCI configuration for already deployed gNB + +The D-PCI configuration function detects the PCI conflict among NR cells, and informs the management service producer for NF fault supervision (see clause 6.3 in TS 28.545 [27]) to send a notification *notifyNewAlarm* (see clause 6.1.1.4 in TS 28.532 [26]) to the PCI management function, indicating that the PCI conflict has been detected on NR cells. + +The PCI management function may consume the management service for NF provisioning with *modifyMOIAttributes* operation to update the PCI list for a given NR cell. + +D-PCI configuration function reassigns the new PCI value(s) from the PCI list for the affected NR cells (see clause 5.2.2 in TR 37.816 [12]), resulting in a notification *notifyMOIAttributeValueChange* (see clause 5.1.9 in TS 28.532 [26]) being sent to indicate the new PCI value(s) being reassigned to mitigate the conflict. + +D-PCI configuration function detects that the PCI conflict has been resolved, resulting in a notification *notifyClearedAlarm* (see clause 9.2.5 in TS 28.532 [26]) being sent to the PCI management function, indicating the PCI conflict has been resolved. + +NOTE 1: NRM needs enhancement to support D-PCI enable / disable, PCI list, PCI value. + +NOTE 2: NF fault supervision needs enhancement to PCI conflict alarm notification. + +### 7.3.3 Centralized PCI configuration + +It is assumed that the C-PCI configuration function has consumed the management service to collect PCI related measurements, and the MOIs related to the PCI configuration has been created. + +#### pCI configuration for newly deployed gNB + +The C-PCI configuration function determines the PCI value based on analyses of the collected data, e.g. performance measurements, historical KPIs, historical PCI configuration data. + +The C-PCI configuration function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to configure a single PCI for each cell. + +#### pCI configuration for already deployed gNB + +The C-PCI configuration function collects the PCI related measurements (e.g. performance measurements related to connections and mobility, historical PCI configuration data) reported by NG-RAN. + +The C-PCI configuration function analyses the PCI related information and detects that NR cells have experienced PCI conflict or confusion. + +NOTE 1: C-PCI configuration function may record the count of PCI conflict or confusion in performance measurements. + +The C-PCI configuration function consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [26]) to configure a specific PCI value or a list values for each newly deployed NR cell. + +gNB detects the PCI conflict among NR cells (see clause 5.2.2 in TR 37.816 [12]), resulting in a notification *notifyNewAlarm* being sent to the C- PCI configuration function, indicating the PCI conflict has been detected on NR cells. + +C-PCI configuration function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to reassign new PCI value(s) for each affected NR cell. + +gNB detects that the PCI conflict has been resolved, resulting in a notification *notifyClearedAlarm* being sent to the C-PCI configuration function, indicating the PCI conflict has been resolved. + +NOTE 2: PCI related measurements need to be defined to support centralized PCI configuration function. + +## 7.4 Void + +## 7.5 Load Balancing Optimization + +### 7.5.1 General + +This subclause the solutions for the use case of load balancing optimization (see use case in clause 5.7). + +### 7.5.2 Management of distributed LBO + +The D-LBO management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [26]) to configure the policy (e.g. threshold, target) of D-LBO function. + +The D-LBO management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to enable the D-LBO function. + +D-LBO function analyses the load related information (see clause 5.4.2 in TR 37.816 [12]) to perform load balancing by means of optimization of cell reselection/handover parameters and handover actions (e.g. offloading UEs to neighboring cells) (see clause 5.4.1 in TR 37.816 [12]), resulting in a notification *notifyMOIAttributeValueChanges* (see clause 5.1.9 in TS 28.532 [26]) being sent to notify the D-LBO management function that the reselection/handover parameters have been changed, and/or the update of virtualized resources is needed. + +The D-LBO management function collects the performance measurements (e.g. the number of RRC connection establishment / release, abnormal release, handover failures, call drops, etc...) to evaluate the D-LBO performance (see clause 4.2.5 in TS 32.522 [28]). + +The D-LBO management function analyses the measurements, and may perform one of the following actions, if the D-LBO performance does not meet the target: + +1. Consume the management service for NF provisioning with *modifyMOIAttributes* operation to update the policy; +2. Determine actions to optimize the traffic load distributions among neighboring cells, by invoking *modifyMOIAttributes* operation to disable the D-LBO function and change the parameters, such as the handover and/or reselection parameters (TR 38.300 [13]) of the cell or its neighbors. + +NOTE: NRM may need to be enhanced to support the policy and control of D-LBO function, and handover related parameters. + +### 7.5.3 Centralized LBO + +It is assumed that the C-LBO function may have received LBO target from a consumer, and has consumed the management service to collect load related measurements, and relevant IOCs have been created to support C-LBO. + +The C-LBO function collects the load performance measurements (e.g. radio resource usage, HW / VR / TNL load indicators, Composite Available Capacity PRB, TNL measurements, ...) or notifications (e.g. threshold crossing of certain measurements) from gNB-CU-CP, gNB-CU-UP(s), gNB-DU(s) (see clause 5.4.2 in TR 37.816 [12]). + +The C-LBO function analyses the measurements to determine the actions, as shown below, to optimize the traffic load distributions among neighbouring cells: + +1. Invoke *modifyMOIAttributes* operation to change the parameters, such as the handover and/or reselection parameters (TR 38.300 [13]) of the cell or its neighbours. + +The C-LBO function collects the performance measurements (e.g. the number of RRC connection establishment / release, abnormal release, handover failures, call drops, etc...). + +The C-LBO function analyses the performance measurements to evaluate the LBO performance, and may invoke *modifyMOIAttributes* operation to update the handover and/or reselection parameters if the performance does not meet the target. + +NOTE: LBO related performance measurements need to be defined to support C-LBO function. + +## 7.6 Void + +## 7.7 RACH Optimization (Random Access Optimization) + +### 7.7.1 General + +This subclause the solutions for the use case of RACH optimization (see use case in clause 5.9). + +### 7.7.2 Management of RACH optimization + +It is assumed that the RACH optimization management function has consumed the management service to collect RACH optimization related measurements. + +The RACH optimization management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [26]) to configure the targets for D-RACH optimization function, as shown below (see clause 5.5.1 in TR 37.816 [12]). + +- Minimize access delays for the UEs under the coverage of popular SSBs +- Minimize the delays for the UEs to request the other SIs +- Minimize the imbalance of UEs access delays on uplink (UL) and supplementary uplink (SUL) channel +- Minimize the beam failure recovery delays for the UEs in RRC\_Connected. +- Minimize the failed/unnecessary RACH attempts on RACH resource before success. + +The RACH optimization management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to enable the D-RACH optimization function for a given NR cell. + +The D-RACH optimization function receives the RACH information report, and analyses them to determine the actions to optimize the RACH performance if the performance does not meet the targets by updating the following RACH parameters (see clause 5.5.2 in TR 37.861 [12]): + +- RACH configuration (resource unit allocation); +- RACH preamble split (among dedicated, group A, group B); +- RACH backoff parameter value; +- RACH transmission power control parameters. + +The D-RACH optimization function informs the management service producer for NF provisioning to send a notification *notifyMOIAttributeValueChange* to the RACH optimization management function (see clause 5.1.9 in TS 28.532 [26]), indicating the RACH parameters have been changed. + +The RACH optimization management function collects the following RACH related measurements (see clause 4.6.4 in TS 32.552 [28]): + +- Distribution of the number of preambles UEs sent to achieve synchronization, where the number of preambles sent corresponds to PREAMBLE\_TRANSMISSION\_COUNTER (see clause 5.1.1 in TS 38.321 [5]) in UE. +- Distribution of the time needed for UEs to achieve synchronization, including access delay and UE request delay; +- Distribution of beam failure recovery delays. + +The RACH optimization management function analyses the measurements to evaluate the RACH performance, and may perform one of the following actions, when the RACH optimization performance does not meet the targets: + +- 1) Consume the management service for NF provisioning with *modifyMOIAttributes* operation to update the targets for the RACH optimization function; +- 2) Consume the management service for NF provisioning with *modifyMOIAttributes* operation to disable RACH optimization function, and update the RACH parameters. + +NOTE 1: NRM needs to be enhanced to support RACH optimizations related attributes, such as RACH performance targets, and RACH parameters. + +NOTE 2: RACH optimization related performance measurements need to be defined. + +## 7.8 Capacity and Coverage Optimization + +### 7.8.0 Overview of Potential solution for CCO + +There are following potential solutions to address Capacity and Coverage Optimization: + +Solution A: 3GPP management system (3GPP Cross Management Domain or Management Domain) management with RAN distributed CCO: + +- A-1: RAN Distributed CCO managed by only 3GPP Cross Management Domain +- A-2: RAN Distributed CCO managed by both 3GPP Cross Management Domain and Management Domain + +Solution B: Centralized CCO without RAN distributed CCO: + +- B-1: Domain centralized CCO managed by 3GPP Cross Management Domain +- B-2: 3GPP Cross Management Domain centralized CCO only + +### 7.8.1 Potential solution for centralized CCO + +The Figure 7.8.1-1 illustrates the framework for EM centralized CCO with NM controlled policies. The CCO Algorithm is located in MnS Producer for CCO. + +- EM as MnS Producer for CCO is responsible for coverage and/or capacity issues detection and optimization. +- NM as MnS Consumer for CCO is responsible for CCO policy control for RAN SubNetwork. +- MnS for CCO is utilized by NM to trigger CCO optimization task with specified corresponding CCO policies, and receive the notification about the coverage and/or capacity issues occurrence and corresponding recovery. + +![Figure 7.8.1-1: Framework for EM centralized CCO with NM controlled policies. The diagram shows a hierarchical structure. At the top is a box labeled 'NM(Act as MnS Consumer for CCO)' containing a sub-box 'CCO Policy Control Function for RAN SubNetwork'. Below this is a line labeled 'MnS For CCO' with a connector symbol. Below the connector is a box labeled 'EM(Act as MnS Producer for CCO)' containing two sub-boxes: 'CCO Monitor Function' and 'CCO Algorithm'. At the bottom, two boxes labeled 'RAN Node' are connected to the EM box, with an ellipsis between them.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +Figure 7.8.1-1: Framework for EM centralized CCO with NM controlled policies. The diagram shows a hierarchical structure. At the top is a box labeled 'NM(Act as MnS Consumer for CCO)' containing a sub-box 'CCO Policy Control Function for RAN SubNetwork'. Below this is a line labeled 'MnS For CCO' with a connector symbol. Below the connector is a box labeled 'EM(Act as MnS Producer for CCO)' containing two sub-boxes: 'CCO Monitor Function' and 'CCO Algorithm'. At the bottom, two boxes labeled 'RAN Node' are connected to the EM box, with an ellipsis between them. + +**Figure 7.8.1-1: Framework for EM centralized CCO with NM controlled policies** + +The Figure 7.8.1-2 illustrates the procedure for EM centralized coverage and capacity optimization. + +![Figure 7.8.1-2: Procedure for EM centralized CCO with NM controlled policies. This is a sequence diagram with three lifelines: NM (Network Manager), EM (Energy Manager), and RAN_Node. The sequence starts with NM sending a message to EM (1. Decides to start the coverage and capacity optimization task and corresponding CCO policies for RAN SubNetwork). NM then sends a message to EM (2. Triggers the optimization task). EM responds (3. Configures the CCO policies to start the optimization task). A loop labeled '[until optimization task is deleted]' contains a reference block 'ref' for step 4 (Monitor the coverage and/or capacity issues). Inside this loop, an 'opt' block labeled '[If the coverage and/or capacity issues detected]' contains steps 5.1 (Notify the NM about the coverage and/or capacity issues), a nested 'ref' block for step 5.2 (EM determines and execute the corrective actions), and step 5.3 (Notify NM about the recovery of coverage and/or capacity issues).](107da2e3495b2f24352c9e3b26ec4841_img.jpg) + +Figure 7.8.1-2: Procedure for EM centralized CCO with NM controlled policies. This is a sequence diagram with three lifelines: NM (Network Manager), EM (Energy Manager), and RAN\_Node. The sequence starts with NM sending a message to EM (1. Decides to start the coverage and capacity optimization task and corresponding CCO policies for RAN SubNetwork). NM then sends a message to EM (2. Triggers the optimization task). EM responds (3. Configures the CCO policies to start the optimization task). A loop labeled '[until optimization task is deleted]' contains a reference block 'ref' for step 4 (Monitor the coverage and/or capacity issues). Inside this loop, an 'opt' block labeled '[If the coverage and/or capacity issues detected]' contains steps 5.1 (Notify the NM about the coverage and/or capacity issues), a nested 'ref' block for step 5.2 (EM determines and execute the corrective actions), and step 5.3 (Notify NM about the recovery of coverage and/or capacity issues). + +**Figure 7.8.1-2: Procedure for EM centralized CCO with NM controlled policies** + +- 1) NM (act as MnS Consumer for CCO) decides to start the coverage and capacity optimization task and corresponding CCO policies for RAN Subnetwork, including coverage and/or capacity issue detection condition (e.g. SINR threshold for coverage hole and weak coverage) and optimization constraint condition (e.g. optimization regions, optimal coverage, minimum uplink interference). +- 2) NM triggers the optimization task to EM (act as MnS Producer for CCO) with corresponding optimization object (RAN Subnetwork) and CCO policies specified. +- 3) EM configures the CCO policies to start the optimization task. +- 4) EM monitor the coverage and/or capacity issues (i.e. Coverage hole, Weak coverage, Pilot pollution, Overshoot coverage, DL and UL channel coverage mismatch defined in TS 28.628[9]) based on CCO related performance measurements collected. +- 5.1) When EM detected the coverage and/or capacity issues, EM may notify the NM about the occurrence of coverage and/or capacity issues. + +- 5.2) EM determines the corrective actions (e.g. switch on antenna pattern) to address the coverage and/or capacity issues. +- 5.3) If the corrective actions are executed and the detected issues are addressed successfully, the EM may notify the NM about the recovery of coverage and/or capacity issues. + +## 7.9 Self-healing + +The function Self-healing has not been addressed in the present document. + +## 7.10 SON coordination + +The function SON coordination has not been addressed in the present document. + +## 7.11 Multi-vendor Plug and Play eNB connection to the network + +See clause 7.1. + +## 7.12 SON for AAS-based Deployments + +In E-UTRAN networks, SON for AAS-based Deployments uses techniques like cell splitting and cell merging. As the NG-RAN uses beamforming for sub-sector structures, these techniques are not relevant for NR-RAN. Instead, Coverage and Capacity Optimization will cover this topic. + +## 7.13 Trace and MDT + +Potential solutions from TS 32.422 [31] will be considered. + +## 7.14 Mobility Robustness Optimization + +### 7.14.1 General + +This subclause the solutions for the use case of mobility robustness optimization (see use case in clause 5.16). + +### 7.14.2 Management of mobility robustness optimization + +It is assumed that the MRO management function has consumed the management service to collect handover related measurements. + +The MRO management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation (see clause 5.1.3 in TS 28.532 [26]) to configure the ranges for the NR and EUTRAN handover parameters and the targets for the D-MRO function. + +The MRO management function consumes the management service for NF provisioning with *modifyMOIAttributes* operation to enable the D-MRO function for a given NR cell. + +The D-MRO function detects the handover issues (e.g. too late HO, too early HO and HO to a wrong cell) in intra-RAT or inter-RAT mobility by analysing the reports from UE and network side information, and then determine the actions to mitigate the HO issues by adjusting HO related parameters (see clause 5.3.1 in TR 37.861 [12]). + +The D-MRO function informs the management service producer for NF provisioning to send a notification *notifyMOIAttributeValueChange* to the MRO management function (see clause 5.1.9 in TS 28.532 [26]), indicating the HO related parameters have been changed. + +The MRO management function collects the handover related measurements and radio link failure reports to evaluate the handover performance (see clause 4.3.5 in TS 32.552 [28]). + +The MRO management function analyses the measurements and radio link failure reports, and determines to perform one of the following actions, when the handover performance does not meet the targets: + +- 1) Consume the management service for NF provisioning with *modifyMOIAttributes* operation to update the targets for the D-MRO function; + +- 2) Consume the management service for NF provisioning with *modifyMOIAttributes* operation to update the ranges of handover parameters for the NR neighbour relations and EUTRAN neighbour relations; +- 3) Consume the management service for NF provisioning with *modifyMOIAttributes* operation to update the ranges of handover parameters (see clause 5.5.4 in TS 38.331 [6]) for NR neighbour relations with values deemed to improve handover performance. + +NOTE 1: NRM needs to be enhanced to support MRO related attributes, such as MRO ranges, targets, and ranges of handover parameters. + +NOTE 2: Handover related performance measurements need to be defined. + +## 7.15 Energy Saving Management + +Energy saving management is addressed in TS 28.310 [24]. + +## 7.16 Automatic Neighbour Relation (ANR) optimization + +### 7.16.1 General + +This subclause the solutions for the use case of ANR optimization (see use case in clause 5.4). + +### 7.16.2 ANR optimization + +1. The ANR optimization function (a.k.a. MnS producer for ANR optimization) consumes the NF provisioning service to get the attributes of the NR cells with *getMOIAttributes* operation. + +The ANR optimization function gets the geographical data and terrain data of the NR cells from a data source (such as radio planning tool), see Note. + +The ANR optimization function may get the data mentioned above regularly or once being notified that the data have been changed. + +NOTE: how to get the geographical data and terrain data of NR cells is FFS. + +The ANR optimization function analyses the NR cells attributes, the geographical data and terrain data, and determines to consume the NF provisioning service add or blacklist one or more NCRs: + +- by operation *createMOI* to add a new NCR for a NR cell; +- by operation *modifyMOIAttributes* to blacklist a NCR (i.e., setting the *is HoAllowed* attribute to "no"). + +2. The ANR optimization function consumes the NF PM service to regularly collect the performance measurements related to abnormal RRC connection releases of the NR cells and the performance measurements about handover failures for the NCRs. The ANR optimization function may also consume the NF PM service to receive the *notifyThresholdCrossing* notifications for these performance measurements. + +The ANR optimization function consumes the Trace/MDT service to collect the RLF/RCEF reports related the NR cells. + +The ANR optimization function analyses the collected performance measurements and RLF/RCEF reports, and determines to consume the NF provisioning service to blacklist one or more NCRs if the performance about the NCRs does not meet the requirements: + +- by operation *modifyMOIAttributes* to blacklist a NCR. + +## 7.17 Cross-slice network resource optimization + +The following steps support cross-slice network optimization as described in clause 5.20. + +- 1) The NFV-MANO system sends information to the 3GPP management on changes in resources. + +- 2) The 3GPP management analyses whether the change in resources causes problems or when resources are not optimal utilized in the supporting the network slices. +- 3) In case of resource problems, the CSPs are notified by the 3GPP management via an API. +- 4) The CSPs decide on the action they prefer: by adjusting the priority of slices or by adjusting the current minimal resource requirements needed for the slices. +- 5) The CSPs communicate their preferences to the 3GPP management. +- 6) The 3GPP management checks whether the new modification by the CSP solves the resource problems. If not, then steps 3, 4 and 5 be executed again for affected slices, with a predetermined maximum for the number of iterations. +- 7) If the new configuration can solve the resource problems, the slice priorities and/or resource requirements will be updated by the 3GPP Management and will be propagated via the interface Os-Ma-nfvo towards the NFV-MANO. +- 8) In the case of resources that are not utilized optimal, the 3GPP management system will reallocate resources to optimize performance among NSSIs. + +# --- 8 Conclusion and recommendation + +## 8.1 Self-establishment of non-virtualized NFs, including automated Software Management + +The features and solution as described in clause 7.1 are recommended to be specified in the normative work. + +## 8.2 Automatic Neighbour Relation (ANR) management (including automatic X2 setup) + +The features and solution as described in clause 7.2 are recommended to be specified in the normative work. + +## 8.3 PCI Configuration + +The features and solution as described in clause 7.3 are recommended to be specified in the normative work. + +## 8.4 Void + +## 8.5 Automatic Neighbour Relation (ANR) optimization + +The features and solution as described in clause 7.16 are recommended to be specified in the normative work. + +## 8.6 Load Balancing Optimization + +The features and solution as described in clause 7.5 are recommended to be specified in the normative work. + +## 8.7 RACH Optimization (Random Access Optimization) + +The features and solution as described in clause 7.7 are recommended to be specified in the normative work. + +## 8.8 Centralized Capacity and Coverage Optimization + +The features and solution as described in clause 7.8 are recommended to be specified in the normative work. + +## 8.9 Self-healing + +The function Self-healing has not been addressed in the present document. + +## 8.10 SON coordination + +The function SON coordination has not been addressed in the present document. + +## 8.11 Multi-vendor Plug and Play of NFs + +See clause 8.1. + +## 8.12 SON for AAS-based Deployments + +In E-UTRAN networks, SON for AAS-based Deployments uses techniques like cell splitting and cell merging. As the NG-RAN uses beamforming for sub-sector structures, these techniques are not relevant for NR-RAN. Instead, Coverage and Capacity Optimization will cover this topic. + +## 8.14 Trace and MDT + +Trace is already supported since Rel-15. + +Support for MDT is present in RAN specifications for Rel-16, however, no support exists for management of MDT. Therefore, it is recommended to specify MDT management support in the normative work. + +## 8.15 Mobility Robustness Optimization + +The features and solution as described in clause 7.14 are recommended to be specified in the normative work. + +## 8.16 Energy Saving Management + +It's recommended to do normative work for Energy Saving Management in TS 28.310 [24]. + +# --- Annex A: Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-12 | SA#86 | SP-191210 | | | | Presented for approval | 2.0.0 | +| 2019-12 | SA#86 | | | | | EditHelp review + change control version | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/28_series/28890/124c6108c63173818afb8ed49521e22d_img.jpg b/marked/Rel-16/28_series/28890/124c6108c63173818afb8ed49521e22d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3866cfc23ade53dc2784acf53e3c1952e767003 --- /dev/null +++ b/marked/Rel-16/28_series/28890/124c6108c63173818afb8ed49521e22d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d2e5d51f8953de4ddc99d91d4a67fccb954bb29e8fa3a7a4def2e4f774a458f +size 116739 diff --git a/marked/Rel-16/28_series/28890/132cff7e872feb31f629703959beddd7_img.jpg b/marked/Rel-16/28_series/28890/132cff7e872feb31f629703959beddd7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4263a1c0aa1702e15efc8fbf8bd3041391610698 --- /dev/null +++ b/marked/Rel-16/28_series/28890/132cff7e872feb31f629703959beddd7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a67055c6263e32c89032e2b3e2b9d6da8766186c6dd7e62f9cbd3e954ce4508a +size 25254 diff --git a/marked/Rel-16/28_series/28890/1841f348dfa81a3438d4e1f8465d9ac7_img.jpg b/marked/Rel-16/28_series/28890/1841f348dfa81a3438d4e1f8465d9ac7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc12d49baabfeced8e97108f26b211c173312645 --- /dev/null +++ b/marked/Rel-16/28_series/28890/1841f348dfa81a3438d4e1f8465d9ac7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed0dc64fcf89dad55179909969618269b205b7c09a7782385f474c89af19c382 +size 52924 diff --git a/marked/Rel-16/28_series/28890/18442e4e239480f0c3c95b547aa8fde2_img.jpg b/marked/Rel-16/28_series/28890/18442e4e239480f0c3c95b547aa8fde2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39b3e756640361b06bdacf59e8b5944869412253 --- /dev/null +++ b/marked/Rel-16/28_series/28890/18442e4e239480f0c3c95b547aa8fde2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:011d3c1d3204157b37d9d8ca09cf2cf32bed2b4b42bde54c72c20a4af6b70b2e +size 27977 diff --git a/marked/Rel-16/28_series/28890/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/28_series/28890/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a21520c0aefc22465af659cc3a5afbf6e43a1dc9 --- /dev/null +++ b/marked/Rel-16/28_series/28890/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b008c07295554de891e2d53307934e2b2592e69d9a290948f1c98a44ae11da2a +size 32377 diff --git a/marked/Rel-16/28_series/28890/3621e1493d508bd789fec58ba8be9a40_img.jpg b/marked/Rel-16/28_series/28890/3621e1493d508bd789fec58ba8be9a40_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3d44771e4fe065f2b475b122bb0cabefc602edf --- /dev/null +++ b/marked/Rel-16/28_series/28890/3621e1493d508bd789fec58ba8be9a40_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c8857c003ada3d1a2d7c24c661e5909e5b8cd8dedbc1a806f4841fedd0149de +size 20926 diff --git a/marked/Rel-16/28_series/28890/54fabc351eda5228d2fa28cd9ba07971_img.jpg b/marked/Rel-16/28_series/28890/54fabc351eda5228d2fa28cd9ba07971_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7124f05c4824f3799518fed3457b3bf88586608 --- /dev/null +++ b/marked/Rel-16/28_series/28890/54fabc351eda5228d2fa28cd9ba07971_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb5aeb2362b3ce22c59b61f87757408d69020c1384f4ca216c03a8f888562607 +size 62313 diff --git a/marked/Rel-16/28_series/28890/875c6f4f441fdd3ca7e1908fd1582983_img.jpg b/marked/Rel-16/28_series/28890/875c6f4f441fdd3ca7e1908fd1582983_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b69f4bc649a34199e777297cc046f45033a3ba5a --- /dev/null +++ b/marked/Rel-16/28_series/28890/875c6f4f441fdd3ca7e1908fd1582983_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:76fd144dff0af3dc1749d8949e8cc62e4a780efabb155c4cd20c62442d5efa73 +size 100665 diff --git a/marked/Rel-16/28_series/28890/b0d4609bc46c2d88a8318706bb5321f7_img.jpg b/marked/Rel-16/28_series/28890/b0d4609bc46c2d88a8318706bb5321f7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3eb27ae107b0029232975b8f004659233544763e --- /dev/null +++ b/marked/Rel-16/28_series/28890/b0d4609bc46c2d88a8318706bb5321f7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbe6d902582f3aac7206548b67278f4544d6ac768b6aa14cbc6e22a30537241f +size 25102 diff --git a/marked/Rel-16/28_series/28890/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/28_series/28890/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c49782cf2a44373e3ff98e6f98280617b6ae71c0 --- /dev/null +++ b/marked/Rel-16/28_series/28890/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:57023fd1e0f7b15ea84719cc460daa4eddd26ad78785e824333c8804d4a62e4a +size 110287 diff --git a/marked/Rel-16/28_series/28890/b5335262987c819d7f71ce40f99cb71b_img.jpg b/marked/Rel-16/28_series/28890/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9479a1ba61ec4bae51ff56f473bfae43985337b6 --- /dev/null +++ b/marked/Rel-16/28_series/28890/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d6890ff30178ad2dca50546a805cf9e988f73946ad2bf74e43b30ca0ebf86567 +size 92066 diff --git a/marked/Rel-16/28_series/28890/e05c1a13b44ab41505609d82b00cf4df_img.jpg b/marked/Rel-16/28_series/28890/e05c1a13b44ab41505609d82b00cf4df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..665171bb570dbda005db6639ddb79aa7d00dd451 --- /dev/null +++ b/marked/Rel-16/28_series/28890/e05c1a13b44ab41505609d82b00cf4df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f685b66f2450f509591dbb23bbb5b6663e5eaa1082f60a47a3941c62ad07c634 +size 42151 diff --git a/marked/Rel-16/28_series/28890/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/28_series/28890/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4af4e662976b0083e83d9bc09fa3213ad411a49d --- /dev/null +++ b/marked/Rel-16/28_series/28890/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1afc067e4f2a532247fc923eee24a46400802b409fd876b07adb893a18b1155c +size 107452 diff --git a/marked/Rel-16/28_series/28890/raw.md b/marked/Rel-16/28_series/28890/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..98f0d65f0cb9618d54e7fa8e4f7c21ac7c430cfe --- /dev/null +++ b/marked/Rel-16/28_series/28890/raw.md @@ -0,0 +1,1399 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Introduction..... | 8 | +| 4.1 Architecture overview ..... | 8 | +| 4.1.1 3GPP 5G management framework ..... | 8 | +| 4.1.2 ONAP Architecture overview ..... | 9 | +| 5 Integration of ONAP/DCAE with 3GPP management services for FM and PM purposes..... | 9 | +| 5.1 Positioning of ONAP/DCAE wrt. 3GPP management architecture framework ..... | 9 | +| 5.1.1 ONAP/DCAE architecture ..... | 9 | +| 5.1.2 Positioning..... | 11 | +| 5.1.2.0 General..... | 11 | +| 5.1.2.1 An example of ONAP DCAE Collection Framework utilizing the management services provided by 3GPP Management Services Provider ..... | 11 | +| 5.1.2.2 An example of 3GPP MnF using information provided by ONAP DCAE ..... | 11 | +| 5.2 Comparative analysis ..... | 12 | +| 5.2.1 Communication principles..... | 12 | +| 5.2.1.1 ONAP DCAE..... | 12 | +| 5.2.1.2 3GPP 5G management framework ..... | 15 | +| 5.2.1.3 Comparison..... | 15 | +| 5.2.1.3.1 Events headers / notification parameters..... | 15 | +| 5.2.1.3.2 FM/PM data collection..... | 17 | +| 5.2.1.4 Comparison of interface technologies ..... | 18 | +| 5.2.1.5 Heartbeat..... | 18 | +| 5.2.1.5.1 ONAP..... | 18 | +| 5.2.1.5.2 3GPP..... | 19 | +| 5.2.1.5.3 Proposed way forward..... | 19 | +| 5.2.2 Handling of alarm / event notifications ..... | 19 | +| 5.2.2.1 ONAP DCAE VES Fault Field..... | 19 | +| 5.2.2.2 3GPP alarm supervision..... | 20 | +| 5.2.2.3 Comparison..... | 21 | +| 5.2.2.3.1 Fault fields..... | 21 | +| 5.2.2.3.2 Mapping 3GPP alarm notifications to ONAP R3 VES JSON API..... | 21 | +| 5.2.2.4 Alarm Life Cycle management in ONAP..... | 25 | +| 5.2.3 Handling of performance data collection ..... | 26 | +| 5.2.3.1 ONAP DCAE..... | 26 | +| 5.2.3.2 3GPP Performance Management..... | 26 | +| 5.2.3.3 Comparison..... | 27 | +| 5.2.3.3.1 PM job handling ..... | 27 | +| 5.2.3.3.2 FM/PM data reporting..... | 27 | +| 5.2.3.3.3 Reporting 3GPP Rel-15 PM data to DCAE R3 VES JSON Collector..... | 29 | +| 5.2.3.3.4 3GPP Fault Supervision operations..... | 31 | +| 5.3 Conclusions on FM/PM ..... | 31 | +| 6 Integration of ONAP with 3GPP management services for configuration management purposes ..... | 32 | +| 6.1 ONAP controllers and 3GPP provisioning service ..... | 32 | +| 6.1.1 ONAP controllers ..... | 32 | +| 6.1.1.1 Introduction..... | 32 | +| 6.1.1.2 APPC ..... | 33 | +| 6.1.1.2.1 Overview ..... | 33 | +| 6.1.1.2.2 APPC Netconf Adapter ..... | 34 | +| 6.1.1.2.3 APPC Chef Adapter ..... | 34 | +| 6.1.1.2.4 APPC Ansible Adapter..... | 34 | + +| | | | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------------|----| +| 6.1.1.3 | SDNC..... | 35 | +| 6.1.1.4 | VF-C ..... | 35 | +| 6.1.2 | 3GPP provisioning service ..... | 35 | +| 6.1.3 | Positioning..... | 39 | +| 6.1.3.1 | Introduction..... | 39 | +| 6.1.3.2 | An example of ONAP controller utilizing management services provided by 3GPP Management Services Provider ..... | 39 | +| 6.1.3.3 | An example of 3GPP MnF using interface provided by ONAP VF-C..... | 39 | +| 6.2 | Comparative analysis ..... | 40 | +| 6.2.1 | Introduction ..... | 40 | +| 6.2.2 | Management principles ..... | 40 | +| 6.2.3 | Communication protocols ..... | 40 | +| 6.2.3.1 | NETCONF ..... | 40 | +| 6.2.3.2 | Other protocol options ..... | 41 | +| 6.2.4 | Handling of configuration management notifications ..... | 41 | +| 6.2.4.1 | 3GPP configuration management notifications ..... | 41 | +| 6.2.4.2 | ONAP configuration notifications ..... | 41 | +| 6.2.4.3 | Potential solution for enabling ONAP DCAE VES JSON Collector to consume 3GPP configuration management notifications ..... | 42 | +| 6.3 | Conclusions on configuration management..... | 43 | +| Annex <A>: Change history ..... | | 44 | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document studies compatibility of the ONAP management platform architecture and functionality with that of the 5G service-based management architecture being defined in 3GPP TS 28.53x, 28.54x and 28.55x series specifications. The present document is based on ONAP releases up to and including R3 ("Casablanca") and the corresponding APIs and related interfaces. + +The scope of the present document includes: + +- analysis and comparison of 3GPP and ONAP configuration management mechanisms. +- analysis of how ONAP configuration management mechanisms can be supported in 3GPP. +- analysis and comparison of 3GPP and ONAP alarm management and performance management mechanisms, concentrating on DCAE (Data Collection, Analytics and Events) / Collection Framework event stream and batch data collection on the ONAP side. +- study how notify mechanisms are handled by ONAP DCAE and 3GPP management services. +- study if any gaps exist between the semantics and format of data collected by DCAE and the semantics and format of data produced by both alarm supervision and performance management services. +- analysis of ONAP/3GPP protocol compatibility. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [3] 3GPP TS 28.531: "Management and orchestration; Provisioning". +- [4] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2 and stage 3". +- [5] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: <https://wiki.onap.org/display/DW/Casablanca+Architecture> (v3.0.3). +- [6] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: <https://onap.readthedocs.io/en/latest/submodules/dcae-gen2.git/docs/sections/architecture.html>, accessed 10.10.2018 +- [7] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: ONAP Developer Wiki - <https://wiki.onap.org/> (v94), accessed 25.04.2018. +- [8] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: <https://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/platform/architecture.html>, accessed 18.10.2018. + +- [9] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [10] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [11] 3GPP TS 28.545: "Management and orchestration; Fault Supervision (FS)". +- [12] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: +[https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener\\_7\\_0\\_1.html?highlight=ves%20collector#datatype-commoneventheader](https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener_7_0_1.html?highlight=ves%20collector#datatype-commoneventheader), accessed 26.09.2018. +- [13] Text Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the text: +[https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener\\_7\\_0\\_1.html](https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener_7_0_1.html), accessed 10.10.2018. +- [14] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: +<http://onap.readthedocs.io/en/beijing/submodules/vnfrqts/requirements.git/docs/Chapter7.html#data-model-for-event-records>, accessed 20.06.2018. +- [15] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements ". +- [16] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: +<https://onap.readthedocs.io/en/latest/submodules/vnfrqts/requirements.git/docs/Chapter7/Monitoring-And-Management.html>, accessed 19.10.2018. +- [17] 3GPP TS 28.554: "Management and orchestration; 5G end to end Key Performance Indicators (KPI)". +- [18] Table Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the table: +[https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener\\_7\\_0\\_1.html](https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener_7_0_1.html), accessed 10.10.2018. +- [19] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: +<https://wiki.onap.org/display/DW/Controllers>, accessed 19.10.2018. +- [20] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: +<https://onap.readthedocs.io/en/latest/submodules/appc.git/docs/APPC%20User%20Guide/APPC%20User%20Guide.html>, accessed 18.10.2018. +- [21] Figure Attribution: Creator: ONAP, under Creative Commons Attribution 4.0 International License, <https://creativecommons.org/licenses/by/4.0/>, URI to access the figure: +<https://onap.readthedocs.io/en/latest/submodules/appc/deployment.git/docs/APPC%20Ansible%20Adapter/APPC%20Ansible%20Adapter.html>, accessed 18.10.2018. +- [22] 3GPP TS 28.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)". +- [23] 3GPP TS 32.352: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Information Service (IS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|--------|------------------------------------------------------------| +| APPC | Application Controller | +| CS | Communication Surveillance | +| DCAE | Data Collection, Analytics and Events | +| IRP | Integration Reference Point | +| LCM | Life Cycle Management | +| MD-SAL | Model-Driven Service Abstraction Layer | +| MDAF | Management Data Analytics Function | +| MDAS | Management Data Analytics Service | +| MnF | Management Function | +| MnS | Management Service | +| NFV | Network Function Virtualization | +| NFVO | NFV Orchestrator | +| ONAP | Open Network Automation Platform | +| PNF | Physical Network Function | +| REST | Representational State Transfer | +| VES | VNF Event Stream | +| VF-C | Virtual Function Controller | +| VNF | Virtualized Network Function | +| VNFC | VNF Component | +| xNF | Network Function (x indicating either physical or virtual) | + +# --- 4 Introduction + +## 4.1 Architecture overview + +### 4.1.1 3GPP 5G management framework + +The 3GPP 5G management framework (cf. TS 28.533 [2]) defines service-based management, where Management Services (MnSs) expose their capabilities to authorized consumers. MnSs are specified in: + +- TS 28.531 [3] for provisioning, +- TS 28.545 [11] for fault supervision, +- TS 28.550 [9] for performance management, +- TS 28.532 [10] for generic management services. + +### 4.1.2 ONAP Architecture overview + +Figure 4.1.2.1 depicts the ONAP Release 3 overall architecture (see [5] - figure 1). + +![ONAP Release 3 overall architecture diagram showing layers from External Gateways down to the Managed Environment, with Design-Time (SDC) and Run-Time components.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +The diagram illustrates the ONAP Release 3 overall architecture. At the top, external interfaces include External Gateway, OSS / BSS, ONAP CLI, U-UI, and ONAP Portal. These connect to ONAP External APIs, which are divided into DESIGN-TIME (SDC) and RUN-TIME components. The SDC includes VNF Onboarding, Service/VF/PNF Design, DCAE Design Studio, and a Catalog. The RUN-TIME includes Dashboard OA&M (VID), Policy Framework, DCAE (Correlation Engine (Holmes)), Service Orchestration Project, A&AI/ESR, and Common Services (AAF, OOF, Logging, MUSIC, Others). A vertical bar on the left lists the VNF SDK (Workflow Designer, Controller Design Studio) and CLAMP. A vertical bar on the right lists the ONAP Operations Manager (Modeling (Utilities), Integration, Benchmark / Container Images, VNF Requirements, VNF Validation Program). The central layer is MSB/DMAAP, which connects to Multi-VIM/Cloud Infrastructure Adaptation Layer, SDN-C, Application Controller (APPC), and Virtual Function Controller (VF-C) (Note 1). Below this are External Systems (3rd Party Controller, sVNFM, EMS), the Network Function Layer (VNFs, PNFs), and the Hypervisor / OS Layer (OpenStack, Commercial VIM, K8S, Public Cloud). The bottom layer shows the Managed Environment with Private Edge Cloud, MPLS, Private DC Cloud, IP, and Public Cloud. Version 3.0.3 7/31/2018 is noted in the top right. A note at the bottom left states 'Recipe/Eng Rules & Policy Distribution' and 'Note 1 - VF-C is ETSI-aligned.'. + +ONAP Release 3 overall architecture diagram showing layers from External Gateways down to the Managed Environment, with Design-Time (SDC) and Run-Time components. + +Figure 4.1.2.1: ONAP Release 3 overall architecture + +NOTE: ONAP Release 3 overall architecture Figure attribution [5]. + +Within the ONAP architecture the DCAE (Data Collection, Analytics, and Events) platform collects, processes, and distributes performance, usage, configuration, and fault data from the managed environment, and is therefore of particular importance when comparing ONAP and 3GPP fault management and performance management functionality. + +# 5 Integration of ONAP/DCAE with 3GPP management services for FM and PM purposes + +## 5.1 Positioning of ONAP/DCAE wrt. 3GPP management architecture framework + +### 5.1.1 ONAP/DCAE architecture + +Figure 5.1.1.1 (see [6] - figure 1) provides a functional view of the DCAE platform architecture. + +![Functional view of the DCAE platform architecture diagram](e6df2733626a85205c1db682e6259c46_img.jpg) + +This diagram illustrates the functional view of the DCAE platform architecture. At the base is the **Cloud Infrastructure/VM/VF Instrumentation** layer, which includes **NFV/VF Elements**. Above this is the **DCAE Platform**, which is divided into several functional blocks: **Analytic Framework** (Stream Operators, DAG Operators, DAGs, ...), **Data Movement** (Event, Message & Data Routing), **Stream Data Collection** (Events, Flows, Usage, Other), **Unstructured & Structured Data Persistence** (Baseline, Trends, Inventory, Policies, Topology, Calls, Logs, Sessions, Edge/Core, Events, Other), and **Batch Data Collection** (Counters, Files, Logs, Other). Above the platform are **DCAE Analytic Applications**, categorized into **Real-time Analytic Applications** (Scaling, Anomalies, Other), **Other Applications** (Capacity, Signatures, Testing, Other), **Customized Analytics** (applets/functions/queries ...), and **Reusable Analytic Applications / Library** (Cross-domain, domain-specific applets/functions/queries ...). To the left, **OpenECOMP Interfaces** include **Policy (rules)**, **SDC (templates)**, and **AAI (reference data)**. To the right, **DCAE OA&M** includes **Controller**, **Health**, **Start/Stop**, **Reports**, **Scaling**, and **Policy**. Below that, the **DCAE SDK** includes **Platform / Application**, **On-boarding**, **APIs**, **Library**, **Guides**, and **Certification**. + +Functional view of the DCAE platform architecture diagram + +**Figure 5.1.1.1: Functional view of the DCAE platform architecture** + +NOTE: Functional view of the DCAE platform architecture Figure attribution [6] – Figure 1. + +The Data Collection, Analytics, and Events (DCAE) subsystem, in conjunction with other ONAP components, gathers performance, usage, and configuration data from the managed environment, which includes virtual network functions and their underlying infrastructure. + +Figure 5.1.1.2 (see [6] - figure 3) shows the DCAE data flow and illustrates data flow issued by VNFs to push performance and usage data to the DCAE VES (VNF Event Stream) Collector, the DCAE Collection Framework component in charge of stream data collection. + +![DCAE data flow (data plane) diagram](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +This diagram shows the DCAE data flow (data plane). On the left, the **DCAE Orchestration** block contains the **DCAE Controller**, **DMaaP Bus Controller**, **Inventory**, **Storage (PostgreSQL)**, **Collection Framework**, and **VES Collector**. Two **VNF** blocks at the bottom send data to the **VES Collector**. The **VES Collector** sends data to the **DMaaP Bus Controller**, which in turn sends it to the **DMaaP** block. The **DMaaP** block contains a **Message Router for message data** and a **Data Router for file data**. The **Message Router for message data** sends **measurement data** to the **Message Router Subscribe/Publish** block. The **Data Router for file data** sends **event data** to the **Event handler**. The **Message Router Subscribe/Publish** block sends data to the **Threshold Crossing (TCA)** block, which then sends it to the **Analytics Framework (CDAP+ Hadoop)** block. + +DCAE data flow (data plane) diagram + +**Figure 5.1.1.2: DCAE data flow (data plane)** + +NOTE: DCAE data flow (data plane) Figure attribution [6] – Figure 3. + +### 5.1.2 Positioning + +#### 5.1.2.0 General + +If authorized, the ONAP / DCAE Collection Framework would be a consumer of PM and FM related notifications issued by 3GPP 5G management services, including, e.g.: + +- fault management related notifications (cf. clause 6 of [11] and clause 6.1 of [10]), +- performance management related notifications (cf. clause 5.2 of [9] and clause 7.1 of [10]). + +In subsequent sections, the focus is put on analysing how and to what extent various types of information produced by 3GPP 5G management services (alarm notifications, performance measurement results, configuration change notifications, etc.) can be consumed by the ONAP/DCAE Collection Framework. + +#### 5.1.2.1 An example of ONAP DCAE Collection Framework utilizing the management services provided by 3GPP Management Services Provider + +Figure 5.1.2.1.1 shows an example of ONAP DCAE Collection Framework utilizing the management services provided by 3GPP Data Report MnS provider. In this example, the ONAP DCAE Collection Framework, as part of the 3GPP MnS(s) Consumer, may utilize the management services (i.e., Performance Data Report MnS, Fault Supervision Data Report MnS) provided by 3GPP Management Service(s) Provider based on comparative analysis in the present document. + +![Diagram illustrating the ONAP DCAE Collection Framework utilizing management services from a 3GPP MnS(s) Provider.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +The diagram shows a 'Consumer of 3GPP MnS(s)' at the top, which contains a 'DCAE Collection Framework'. Below this, a '3GPP MnS(s) Provider' box contains two service boxes: 'Performance Data report MnS(s)' and 'Fault Supervision Data Report MnS(s)'. Vertical lines with circular connection points link the 'DCAE Collection Framework' to each of the two service boxes. An ellipsis '.....' is shown to the right of the second connection line. + +Diagram illustrating the ONAP DCAE Collection Framework utilizing management services from a 3GPP MnS(s) Provider. + +**Figure 5.1.2.1.1: An example of ONAP DCAE Collection Framework utilizing the management services provided by 3GPP Data Report MnS(s) Provider** + +#### 5.1.2.2 An example of 3GPP MnF using information provided by ONAP DCAE + +Figure 5.1.2.2.1 shows an example of 3GPP MnS Provider using information provided by ONAP DCAE. In this example, in order to support management data analytics, the 3GPP MDAF, which provides MDAS as an ONAP DCAE consumer, may use some information (e.g. FM data, PM data) provided by ONAP DCAE. + +![Diagram showing the interaction between a Consumer of ONAP DCAE (3GPP MnF) and a Provider of ONAP DCAE (ONAP DCAE) via DMaaP (e.g. FM data, PM data).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +The diagram illustrates a communication flow between two main components. At the top, a box labeled 'Consumer of ONAP DCAE' contains a rounded rectangle labeled '3GPP MnF'. At the bottom, a box labeled 'Provider of ONAP DCAE' contains a rounded rectangle labeled 'ONAP DCAE'. A vertical line connects the two boxes, with a horizontal line branching off to the right labeled 'DMaaP (e.g. FM data, PM data)'. + +Diagram showing the interaction between a Consumer of ONAP DCAE (3GPP MnF) and a Provider of ONAP DCAE (ONAP DCAE) via DMaaP (e.g. FM data, PM data). + +Figure 5.1.2.2.1: An example of 3GPP MnF using some information provided by ONAP DCAE + +## 5.2 Comparative analysis + +### 5.2.1 Communication principles + +#### 5.2.1.1 ONAP DCAE + +In ONAP (cf. [6]), VNFs use REST calls to push measurement data to the DCAE VES Collector. The VES Collector validates, filters, and packages the received measurement data and publishes the data to other components of the ONAP architecture. All VNF instances are provisioned with VES Collector address(es) so as to be able to send alarm notifications, event notifications, etc. to the VES Collector. ONAP does not offer a subscribe / notify mechanism between the DCAE / VES Collector and VNFs. Consequently, all possible notifications that can be issued by VNFs are to be sent out to the VES Collector. + +Regardless of the type of notification, all notifications sent to the VES Collector will have a common header, whose schema is given in table 5.2.1.1.1. + +NOTE: Table 5.2.1.1.1 is copied verbatim from ONAP (cf. [12]) and therefore the apparent normative language that appears therein does not imply a normative requirement within the context of the present document. + +Table 5.2.1.1.1: ONAP DCAE VES Collector - common event header schema + +| Field | Type | Required? | Description | +|----------------------|----------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| domain | string | Yes | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' | +| eventId | string | Yes | Event key that is unique to the event source. The key must be unique within notification life cycle similar to EventID from 3GPP. It could be a sequential number, or a composite key formed from the event fields, such as domain_sequence. The eventId should not include whitespace. For fault events, eventId is the eventId of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, eventId must be the same as the initial alarm (along with the same startEpochMicrosec but with a different sequence number). Note: see section 1.3 for eventId use case examples. | +| eventName | string | Yes | Unique event name (see section 1.2 for more information) | +| eventType | string | No | For example: 'applicationNF', 'guestOS', 'hostOS', 'platform' | +| internalHeaderFields | internalHeaderFields | No | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each service provider (e.g., AT&T) implementing the VES Event Listener. | +| lastEpochMicrosec | number | Yes | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds | +| nfCammingCode | string | No | Network function component type: 3 characters (aligned with vfc naming standards) | +| nfNamingCode | string | No | Network function type: 4 characters (aligned with vnf and pnf naming standards) | +| nfVendorName | String | No | Network function vendor name | +| Priority | string | Yes | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' | +| reportingEntityId | string | No | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. | +| reportingEntityName | string | Yes | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. | +| Sequence | integer | Yes | Ordering of events communicated by an event source instance (or 0 if not needed) | + +| | | | | +|-------------------------|--------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sourceId | string | No | UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. | +| sourceName | string | Yes | Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF level. Data for individual xNFC must not be included in the xNF sourceName event. | +| startEpochMicro sec | number | Yes | the earliest unix time aka epoch time associated with the event from any component—as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicro sec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc...). For fault events, startEpochMicro sec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicro sec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) | +| timeZoneOffset | String | No | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh.mm'; see <a href="https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations">https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations</a> for UTC offset examples | +| version | number | Yes | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. | +| vesEventListenerVersion | String | Yes | Version of the ves event listener api spec that this event is compliant with (as "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). | + +NOTE: ONAP DCAE VES Collector - Common event header schema Figure attribution [12]. + +The VES Collector is a RESTful collector for processing JSON messages; an example of a notification header, in JSON, is given in [13] and reproduced here: + +``` +{ + "event": { + "commonEventHeader": { + "version": "4.0.1", + "vesEventListenerVersion": "7.0.1", + "domain": "heartbeat", + "eventName": "Heartbeat_vIsbcMmc", + "eventId": "heartbeat0000249", + "sequence": 0, + "priority": "Normal", + "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", + "reportingEntityName": "ibcx0001vm002oam001", + "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", +``` + +``` +"sourceName": "ibcx0001vm002ssc001", +"nfVendorName": "Ericsson", +"nfNamingCode": "ibcx", +"nfcNamingCode": "ssc", +"startEpochMicrosec": 1413378172000000, +"lastEpochMicrosec": 1413378172000000, +"timeZoneOffset": "UTC-05:30" + } +} +} +``` + +NOTE: ONAP DCAE VES Collector - Common event header example in JSON Text attribution [13]. + +#### 5.2.1.2 3GPP 5G management framework + +In the 3GPP 5G management framework, as specified in TS 28.533 [2], management services may generate notifications of events occurring within the network. Different kinds of events carry different kinds of information. For instance, a new alarm (as specified in TS 28.545 [11]) is one possible kind of event; an object creation (as specified in TS 28.531 [3]) is another possible kind of event. + +Information of an event is carried in a notification. A management service producer may emit notifications. Authorized consumers receive notifications. Management service producers that are able to emit notifications offer the following capabilities: + +- Notification mechanism subscription: management service producers provide authorized consumers with the capabilities to subscribe and unsubscribe to their notifications. A consumer can specify the types of notifications that the producer should emit to the consumer during subscription, to specify filtering criteria that can be applied by the notification mechanism; +- Subscription control: the management service provider may provide a consumer with capabilities to control its subscriptions; +- Notification control: in principle, notifications are forwarded to the consumer as soon as they are available; + +#### 5.2.1.3 Comparison + +##### 5.2.1.3.1 Events headers / notification parameters + +The table below provides a high-level mapping between the ONAP common event header fields (in first column) and the 3GPP 5G management services notifications fields with similar functions (in second column). + +| <b>ONAP<br/>Fields common to all events</b> | <b>Potential mapping to notification parameters in 3GPP TS 28.532 [10])<br/>Notification parameters</b> | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>domain</b> (required): the eventing domain associated with the event. | Nothing similar in notification parameters. | +| <b>eventId</b> (required): event key that is unique to the event source. | Similar to notificationId. | +| <b>eventName</b> (required): unique event name | eventName could be mapped to notificationType.<br>Actual values of notificationType are specified on a per notification type basis. Example: in 3GPP TS 28.532 [10], the following actual notificationType values are specified: "notifyNewAlarm", "notifyChangedAlarm", "notifyFileReady", "notifyFilePreparationError", etc. | +| <b>eventType</b> (optional): for example: applicationVnf, guestOS, hostOS, platform | Nothing similar in notification parameters.<br>NFVI related event types are out of the scope of the present document. | +| <b>internalHeaderFields</b> (optional) | No definition of this field could be found. | +| <b>lastEpochMicrosec</b> (required): the latest unix time aka epoch time associated with the event from any component as microseconds elapsed since 1 Jan 1970 not including leap seconds | See eventTime, which does not distinguish the start time of the event from its end time. | +| <b>nfNamingCode</b> (optional): 4 character network function type, aligned with vnf naming standards | Nothing similar in notification parameters. | +| <b>nfcNamingCode</b> (optional): 3 character network function component type, aligned with vfc naming standards | Nothing similar in notification parameters. | +| <b>nfVendorName</b> (optional) | Similar to vendorName | +| <b>priority</b> (required): processing priority | Nothing similar in notification parameters. | +| <b>reportingEntityId</b> (optional): UUID identifying the entity reporting the event, for example an OAM VM. | Similar to systemDN. | +| <b>reportingEntityName</b> (required): Name of the entity reporting the event, for example, an EMS name. May be the same as the sourceName. | Nothing similar in notification parameters. | +| <b>sequence</b> (required): Ordering of events communicated by an event source instance (or 0 if not needed) | Nothing similar in notification parameters. | +| <b>sourceId</b> (optional): UUID identifying the entity experiencing the event issue | Similar to objectInstance. | +| <b>sourceName</b> (required): Name of the entity experiencing the event issue | Nothing similar in notification parameters. | +| <b>startEpochMicrosec</b> (required): The earliest unix time aka epoch time associated with the event from any component as microseconds elapsed since 1 Jan 1970 not including leap seconds | See eventTime, which does not distinguish the start time of the event from its end time. | +| <b>timeZoneOffset</b> (optional) | Nothing similar in notification parameters. | +| <b>version</b> (required): version of the event header | Nothing similar in notification parameters. | +| <b>vesEventInstnerVersion</b> (required) | Nothing similar in notification parameters. | + +##### 5.2.1.3.2 FM/PM data collection + +###### 5.2.1.3.2.1 Existing gap + +In ONAP, as previously described, VNF instances are provisioned with the address of the VES Collector and VNFs use REST calls to push FM and PM measurement data to the DCAE VES Collector. There is no Subscribe / Notify paradigm in place between the VES Collector and VNFs; all VNFs, by default, send out their 'performance, usage, and configuration data' to the DCAE / VES Collector as it becomes available. Therefore, it is necessary that VNFs know the address of the VES Collector (e.g. its URL or IP address) from the time of their creation, meaning that an input parameter is needed for the management operation which creates the VNFs, indicating the VES Collector address. + +Within the existing 3GPP 5G management framework there is no mechanism for providing a VES Collector address during VNF instantiation, and thus this is an interoperability gap between 3GPP and ONAP. This can be solved by modifying the 3GPP Network Resource Model to add a new IOC capturing the attribute indicating the address of the recipient to which MOIs are to send their notifications. + +###### 5.2.1.3.2.2 Proposed modifications to 3GPP specifications + +The following are proposed changes to 3GPP specification TS 28.541 (or TS 28.622 – FFS) to align the 3GPP 5G management framework with ONAP FM/PM data collection mechanisms: + +The `notificationsConsumerReference` can be defined as a new attribute, possibly multi-valued. Whether this new attribute is added to an existing IOC or in a new IOC is FFS. + +As a potential option in case a new IOC is introduced, a corresponding class diagram can be introduced. An example is given below: + +![UML Class Diagram showing ManagedFunction (0..*) associated with NotificationConsumer (0..1). The NotificationConsumer class has an attribute named notificationsConsumerReference.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +``` + +classDiagram + class ManagedFunction { + <<InformationObjectClass>> + } + class NotificationConsumer { + <<InformationObjectClass>> + notificationsConsumerReference + } + ManagedFunction "0..*" --> "0..1" NotificationConsumer + +``` + +UML Class Diagram showing ManagedFunction (0..\*) associated with NotificationConsumer (0..1). The NotificationConsumer class has an attribute named notificationsConsumerReference. + +**Figure 5.2.1.3.2.2.1: NRM for support of FM/PM data consumer** + +In case a new IOC is introduced, it needs to be defined. The following is an example: + +" + +### 4.3.x NotificationConsumer + +#### 4.3.x.1 Definition + +This IOC represents the consumer of notifications emitted by MOIs. + +#### 4.3.x.2 Attributes + +| Attribute name | Support Qualifier | isReadable | isWritable | isInvariant | isNotifyable | +|---------------------------------------------|-------------------|------------|------------|-------------|--------------| +| <code>notificationsConsumerReference</code> | M | T | T | F | T | + +#### 4.3.x.3 Attribute constraints + +None. + +#### 4.3.x.4 Notifications + +The common notifications defined in subclause 4.5 are valid for this IOC, without exceptions or additions. + +". + +#### 5.2.1.4 Comparison of interface technologies + +The table below provides a high-level mapping between 3GPP and ONAP interface technologies. + +**Table 5.2.1.4-1: Comparison of 3GPP and ONAP interface technologies** + +| | 3GPP | ONAP | +|-----------------------------------------------------------------|---------------------------------------------------------------------------|--------------------------------| +| Management-application-layer-communication method | NETCONF (allowed protocol but not used in any SS)<br>SNMP<br>SOAP<br>REST | NETCONF<br>SNMP<br>VES<br>REST | +| Management-application-layer-protocols for bulk & file transfer | ftp<br>ftps<br>sftp<br>http<br>https | sftp<br>ftps | +| Valid network layer protocols | IP | IP | +| Solution sets | SOAP (WSDL 1.1/SOAP 1.1) | JSON | +| Network Resource Model notations | UML<br>XSD | YANG<br>JSON | + +#### 5.2.1.5 Heartbeat + +##### 5.2.1.5.1 ONAP + +Clause 7.4.1 - Data Model for Event Records - of [16] describes the data model for the collection of various types of data from xNFs, as illustrated below: + +![Figure 5.2.1.5.1. Data model for event records. This diagram illustrates the ONAP data model for event records, showing a hierarchy of common headers and specific record types.](124c6108c63173818afb8ed49521e22d_img.jpg) + +The diagram illustrates the ONAP data model for event records. At the top, a **Common Header** box lists **Domain**, **Timing**, and **VNF Attribute**. To its right, an **Acronyms** list defines: KCI – Key Capacity Indicators, KPI – Key Performance Indicators, KQI – Key Quality Indicators, TCA – Threshold Crossing Alert, and VNF – Virtual Network Function. Below the Common Header, the diagram branches into two main categories of event records: + +- Technology Independent Records** (highlighted in a yellow box): + - Fault**: Severity, Source, SpecProb, Name/Value + - Heartbeat**: Name/Value + - Measurements**: KCI, KPI, VNF/PNF, Scaling, Name/Value + - Syslog**: Data, Facility, Proc....., Name/Value + - TCA Fields**: RTCP, Packet Loss, Other QoS, Name/Value + - State Change**: NewState, OldState, StateInterface, Name/Value + - Notification**: Change Type, Change ID, Change, Contact, Name/Value + - PNF Registration**: MAC Address, Model No., IP Address, Serial No., Name/Value + - Other Fields**: Name/Value +- Technology Specific Records** (highlighted in a blue box): + - Signaling**: SIP/SDP, H.323, Megaco..., Name/Value + - Voice Quality**: RTCP, Packet Loss, Other QoS, Name/Value + - MobileFlow**: RptEndPt, OthEndPt, Flow....., Name/Value + - Future Domains**: Configuration, Security, Usage, Name/Value + +Figure 5.2.1.5.1. Data model for event records. This diagram illustrates the ONAP data model for event records, showing a hierarchy of common headers and specific record types. + +**Figure 5.2.1.5.1. Data model for event records.** + +NOTE: ONAP data model of event records Figure attribution [16]. + +Clause 7.4.1 of [16] states: + +" + +*The Heartbeat Record provides an optional structure for communicating information about device health. Heartbeat records would only have the Common Event Header block. An optional heartbeat domain is available to specify information such as heartbeat interval and recommended action upon missing heartbeat interval. Heartbeat avoids the need to ping a device. A communication failure can be determined via missing heartbeat events being delivered to DCAE and appropriate action (e.g. restart VM, rebuild xNF or create ticket) can be taken by DCAE CLAMP.* + +". + +Bottom up, heartbeat messages are sent periodically by xNFs to the DCAE VES JSON Collector. These messages contain only the common header, in which the 'domain' field is equal to 'heartbeat'. + +Top-down, heartbeat commands can be sent from an event collector, e.g. the DCAE VES JSON Collector, to xNFs. + +##### 5.2.1.5.2 3GPP + +For pre-5G technologies, 3GPP Communication Surveillance (CS) IRP provides functionalities similar to ONAP Heartbeat. 3GPP TS 32.352 [23] defines the following operations: + +- getHeartbeatPeriod (), used by the CS IRPManager to obtain the current heartbeat period; +- setHeartbeatPeriod (), used by the CS IRPManager to set the heartbeat period; +- triggerHeartbeat (), used by the CS IRPManager to solicit a notifyHeartbeat notification + +and the following notification: + +- notifyHeartbeat (), used by the CS IRP Agent to notify the subscribed CS IRPManager instances that the resources supporting the communication path between the CS IRPAgent and the notification receiving CS IRPManagers are working. + +##### 5.2.1.5.3 Proposed way forward + +The concept of IRP has been replaced by the concept by Management Service (MnS) in the 5G management architecture framework [2]. However, there is no such Heartbeat or CS MnS defined in Rel-15. Consequently, it is proposed that such a MnS should be defined in Rel-16. + +### 5.2.2 Handling of alarm / event notifications + +#### 5.2.2.1 ONAP DCAE VES Fault Field + +In ONAP, VES defines the fault domain for fault (alarm) notifications. Fault domain allows expansion, users can increase their own specific fault (alarm) related information. + +VES fault fields schema is given in table 5.2.2.1.1 (cf. [18]). + +**Table 5.2.2.1-1: ONAP DCAE VES Collector - Fault fields schema** + +| Name | Required | Type | Format | Properties | Description | +|----------------------------|----------|---------|--------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| alarmAdditionalInformation | No | hashMap | | | Additional alarm information.<br>Note 1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind).<br>Note 2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditionalInformation as 'alarmId':'alarmIdValue'.<br>Could contain managed object instance as separate key:value; could add probable cause as separate key:value. | + +| Name | Required | Type | Format | Properties | Description | +|--------------------|----------|--------|--------|--------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| alarmCondition | Yes | string | | | Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInCon fig, BfdSessionDown, linkDown, etc...) | +| alarmInterfaceA | No | string | | | card, port, channel or interface name of the device generating the alarm | +| eventCategory | No | string | | | Event category, for example: license, link, routing, security, signaling | +| eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity | +| eventSourceType | Yes | string | | | type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction | +| faultFieldsVersion | Yes | number | | | version of the faultFields block | +| specificProblem | Yes | string | | | short description of the alarm or problem | +| vfStatus | Yes | string | | {'enum': ['Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting termination']} | virtual function status enumeration | + +NOTE 1: ONAP DCAE VES Collector - Common fault fields schema Table attribution [18]. + +The VES Collector is a RESTful collector for processing JSON messages; an example of a fault fields, in JSON, is given below (cf. [13]): + +``` +"faultFields": { + "faultFieldsVersion": 3.0, + "alarmCondition": "PilotNumberPoolExhaustion", + "eventSourceType": "other", + "specificProblem": "Calls cannot complete - pilot numbers are unavailable", + "eventSeverity": "CRITICAL", + "vfStatus": "Active", + "alarmAdditionalInformation": { + "PilotNumberPoolSize": "1000" + } +} +``` + +NOTE 2: ONAP DCAE VES Collector - Common fault fields example in JSON Figure attribution [13]. + +#### 5.2.2.2 3GPP alarm supervision + +The 3GPP fault supervision information model defines the AlarmInformation in TS 28.532 [10]. + +#### 5.2.2.3 Comparison + +##### 5.2.2.3.1 Fault fields + +A comparison of the ONAP fault event fields and 3GPP fault supervision AlarmInformation fields is given in Table 5.2.2.3.1-1. + +**Table 5.2.2.3.1-1: Comparison of ONAP and 3GPP fault fields** + +| <b>ONAP<br/>Fault events fields</b> | <b>Potential mapping to 3GPP TS 28.532 [10] – clause 6.2.1.3)<br/>Generic fault supervision management service<br/>AlarmInformation fields</b> | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| <b>alarmAdditionalInformation</b> (optional): additional alarm information. | Similar to additionalText and/or additionalInformation. Probable cause would be included in this field. | +| <b>alarmCondition</b> (required): alarm condition reported by the device. | Nothing similar in Generic fault supervision management service AlarmInformation fields. Similar to alarmType | +| <b>alarmInterfaceA</b> (optional): card, port, channel or interface name of the device generating the alarm. | Nothing similar in Generic fault supervision management service AlarmInformation fields. | +| <b>eventCategory</b> (optional): Event category, for example: license, link, routing, security, signaling | Similar to eventType. | +| <b>eventSeverity</b> (required): event severity: CRITICAL, MAJOR, MINOR, WARNING, NORMAL | Similar to perceivedSeverity. The legal values of perceivedSeverity include: CRITICAL, MAJOR, MINOR, WARNING, INDETERMINATE, CLEARED. | +| <b>eventSourceType</b> (required): type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction | Nothing similar in Generic fault supervision management service AlarmInformation fields. | +| <b>faultFieldsVersion</b> (required): version of the faultFields block | Nothing similar in Generic fault supervision management service AlarmInformation fields. | +| <b>specificProblem</b> (required): short description of the alarm or problem | Similar to specificProblem. | +| <b>vfStatus</b> (required): virtual function status enumeration | Nothing similar in Generic fault supervision management service AlarmInformation fields. | + +##### 5.2.2.3.2 Mapping 3GPP alarm notifications to ONAP R3 VES JSON API + +To allow mapping 3GPP alarm notifications to the ONAP R3 VES JSON API, 3GPP could request ONAP to add a new type of event to the existing types of events, i.e. a new possible value to the field 'domain', as shown in Table 5.2.2.3.2-1: + +**Table 5.2.2.3.2-1: ONAP DCAE VES common event header – domain field** + +| <b>Field</b> | <b>Type</b> | <b>Required?</b> | <b>Description</b> | +|--------------|-------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| domain | string | Yes | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' | + +NOTE: ONAP DCAE VES common event header - domain field Figure attribution [12]. + +It is proposed to add the following new possible value to the field 'domain' of ONAP VES JSON API: + +- 3GPPFault, corresponding to 3GPP alarm notifications. + +New types of fields would have to be added to the existing ones at the root level of the common event format of ONAP VES JSON API shown below: + +**Table 5.2.2.3.2-2: Existing types of headers for VES JSON Collector R3 ([12] – Datatype: event)** + +| Name | Required | Type | +|--------------------------------|----------|--------------------------------| +| commonEventHeader | Yes | commonEventHeader | +| faultFields | No | faultFields | +| heartbeatFields | No | heartbeatFields | +| measurementsForVfScalingFields | No | measurementsForVfScalingFields | +| mobileFlowFields | No | mobileFlowFields | +| otherFields | No | otherFields | +| sipSignalingFields | No | sipSignalingFields | +| stateChangeFields | No | stateChangeFields | +| syslogFields | No | syslogFields | +| thresholdCrossingAlertFields | No | thresholdCrossingAlertFields | +| voiceQualityFields | No | voiceQualityFields | + +NOTE: ONAP DCAE VES JSON - Existing types of headers Figure attribution [12]. + +The following new type of fields would thus be added to ONAP DCAE VES JSON API header fields: + +**Table 5.2.2.3.2-3: Possible new ONAP DCAE VES JSON API header field** + +| Name | Required | Type | +|----------------|----------|--------------------| +| Fault3GPPField | No | Fault3GPPFieldType | + +where Fault3GPPField could use input parameter definitions of alarm notifications defined in 3GPP TS 28.532 [10]. An example, copied verbatim from clause 6.1.1.4.2 of 28.532 [10], valid for input parameters of notifyNewAlarm (), is shown in table 5.2.2.3.2-4. + +**Table 5.2.2.3.2-4: Example definitions of alarm notification fields** + +| Name | Required | Type | Format | Properties | Description | +|--------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------|---------------------------------------------------------------------------------------------------------------| +| objectClass | M | MonitoredEntity.objectClass<br>It shall carry the MonitoredEntity class name. | | | The MonitoredEntity is identified by the relation-AlarmedObject-AlarmInformation of the new AlarmInformation. | +| objectInstance | M | MonitoredEntity.objectInstance<br>It shall carry the Distinguished Name (DN) of the instance of MonitoredEntity class. | | | The MonitoredEntity is identified by the relation-AlarmedObject-AlarmInformation of the new AlarmInformation. | +| notificationId | M | This is an identifier for the notification, which may be used to correlate notifications. The identifier of the notification shall be chosen to be unique across all notifications of a particular managed object throughout the time that correlation is significant, it uniquely identifies the notification from other notifications generated by the subject Information Object. | | | | +| eventTime | M | AlarmInformation.alarmRaisedTime | | | | +| systemDN | C | It shall carry the DN of service providers. | | | | +| notificationType | M | "notifyNewAlarm". | | | | +| probableCause | M | AlarmInformation.probableCause | | | | +| perceivedSeverity | M | AlarmInformation.perceivedSeverity | | | | +| rootCauseIndicator | O | It indicates that this AlarmInformation is the root cause of the events captured by the notifications whose identifiers are in the related CorrelatedNotification instances. | | | "Yes", "No" | + +| Name | Required | Type | Format | Properties | Description | +|-------------------------|----------|----------------------------------------------------------------------------|--------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| alarmType | M | AlarmInformation.eventType | | | The notification structure of this table is applicable if this parameter indicates "Integrity Violation", "Operational Violation", "Physical Violation", "Security Service or Mechanism Violation", "Time Domain Violation". | +| specificProblem | O | AlarmInformation.specificProblem | | | | +| correlatedNotifications | O | The set of CorrelatedNotification related to this AlarmInformation. | | | | +| backUpStatus | O | AlarmInformation.backUpStatus | | | | +| backUpObject | O | MonitoredEntity.objectInstance<br>It carries the DN of the back-up object. | | | This may contain no information if the identity of the service-user (requesting the service) is not known. | +| trendIndication | O | AlarmInformation.trendIndication | | | This shall always identify the service-provider receiving a service request, from serviceUser, that provokes the security alarm. | +| thresholdInfo | O | AlarmInformation.thresholdInfo | | | This may contain no information if the detector of the security alarm is the serviceProvider. | +| stateChangeDefinition | O | AlarmInformation.stateChangeDefinition | | | | +| monitoredAttributes | O | AlarmInformation.monitoredAttributes | | | | +| proposedRepairActions | O | AlarmInformation.proposedRepairActions | | | | +| additionalText | O | AlarmInformation.additionalText | | | | +| additionalInformation | O | AlarmInformation.additionalInformation | | | | +| alarmId | M | AlarmInformation.alarmId | | | | + +The following example in Table 5.2.2.3.2-5 illustrates the data type definition (described in clause 9.4.2.18) and JSON schema definition (described in Annex A.2) for notifyNewAlarm-NotifyType, which is valid forFault3GPPField: + +**Table 5.2.2.3.2-5: Definition of type notifyNewAlarm-NotifType (defined in clause 9.4.2.18 in TS28.532)** + +| Attribute name | Data type | Description | S<br>Q | +|---------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| header | | | | +| > href | uri-Type | URI of the resource where the event (alarm) occurred | M | +| > notificationId | notificationId-Type | Notification identifier as defined in ITU-T Rec. X. 733 [4] | M | +| > notificationType | notificationType-Type | Notification type (notifyNewAlarm, etc.) | M | +| > eventTime | dateTime-Type | Event (alarm) occurrence time | M | +| > systemDN | systemDN-Type | System DN | C | +| body | | | | +| > alarmId | alarmId-Type | Alarm identifier, see clause 6.2.1.5.1 | M | +| > alarmType | alarmType-Type | Alarm type as defined in ITU-T Rec. X. 733 [4] | M | +| > probableCause | probableCause-Type | Probable cause of an alarm as defined in ITU-T Rec. X. 733 [4] | M | +| > specificProblem | specificProblem-Type | Identifies further refinements to the Probable cause of the alarm as defined in ITU-T Rec. X. 733 [4] | O | +| > perceivedSeverity | perceivedSeverity-Type | Perceived severity of an alarm as defined in ITU-T Rec. X. 733 [4] | M | +| > backedUpStatus | backedUpStatus-Type | Indicating if the object emitting the alarm has been backed up as defined in ITU-T Recommendation X. 733 [4] | O | +| > backUpObject | backUpObject-Type | Indicating the backup object of the alarmed object as defined in ITU-T Rec. X. 733 [4] | O | +| > trendIndication | trendIndication-Type | Severity trend of the alarmed object as defined in ITU-T Rec. X. 733 [4] | O | +| > thresholdInfo | thresholdInfo-Type | Provides additional information for threshold crossing alarms as defined in ITU-T Rec. X. 733 [4] | O | +| > correlatedNotifications | array(correlatedNotification-Type) | Set of all notifications to which this notification is considered to be correlated as defined in ITU-T Rec. X. 733 [4] | O | +| > stateChangeDefinition | array(attributeValueChange-Type) | Indicates a state transition associated to an alarm as defined in ITU-T Rec. X. 733 [4] | O | +| > monitoredAttributes | array(attributeNameValuePair-Type) | Defines one or more attributes of the alarmed manged object and their corresponding values at the time of the alarm as defined in ITU-T Rec. X. 733 [4]. | O | +| > proposedRepairActions | proposedRepairActions-Type | Used if the cause is known and the system being managed can suggest one or more solutions to fix the problem causing the alarm as defined in ITU-T Rec. X. 733 [4] | O | +| > additionalText | additionalText-Type | Allows a free form text description to be reported as defined in ITU-T Rec. X. 733 [4] | O | +| > additionalInformation | array(attributeNameValuePair-Type) | Allows the inclusion of a set of additional information in the event report as defined in ITU-T Rec. X. 733 [4] | O | +| > rootCauseIndicator | rootCauseIndicator-Type | Indicates if this event is the root cause of the events captured by the notifications whose identifiers are in the related correlatedNotifications attribute, see clause 6.2.1.5.1 | O | + +The JSON schema definition (defined in Annex A.2 in TS 28.532) for "notifyNewAlarm-NotifType" is described as follows: + +``` +"notifyNewAlarm-NotifType": { + "type": "object", + "properties": { + "header": { + "$ref": "#/components/schemas/header-Type" + }, + "body": { + "type": "object", +``` + +``` + + "properties": { + "alarmId": { + "$ref": "#/components/schemas/alarmId-Type" + }, + "alarmType": { + "$ref": "#/components/schemas/alarmType-Type" + }, + "probableCause": { + "$ref": "#/components/schemas/probableCause-Type" + }, + "specificProblem": { + "$ref": "#/components/schemas/specificProblem-Type" + }, + "perceivedSeverity": { + "$ref": "#/components/schemas/perceivedSeverity-Type" + }, + "backedUpStatus": { + "$ref": "#/components/schemas/backedUpStatus-Type" + }, + "backUpObject": { + "$ref": "#/components/schemas/backUpObject-Type" + }, + "trendIndication": { + "$ref": "#/components/schemas/trendIndication-Type" + }, + "thresholdInfo": { + "$ref": "#/components/schemas/thresholdInfo-Type" + }, + "correlatedNotifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/correlatedNotification-Type" + } + }, + "stateChangeDefinition": { + "type": "array", + "items": { + "$ref": "#/components/schemas/attributeValueChange-Type" + } + }, + "monitoredAttributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/attributeNameValuePair-Type" + } + }, + "proposedRepairActions": { + "$ref": "#/components/schemas/proposedRepairActions-Type" + }, + "additionalText": { + "$ref": "#/components/schemas/additionalText-Type" + }, + "additionalInformation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/attributeNameValuePair-Type" + } + }, + "rootCauseIndicator": { + "$ref": "#/components/schemas/rootCauseIndicator-Type" + } + } + } +} +} +}, + +``` + +#### 5.2.2.4 Alarm Life Cycle management in ONAP + +The attributes of an alarm are defined in ONAP, example use cases exist, but there is no operation for acknowledgement of alarms, adding comments to alarms, or support for alarm correlation in ONAP. + +### 5.2.3 Handling of performance data collection + +#### 5.2.3.1 ONAP DCAE + +In ONAP (cf. [6]), VNFs use REST calls to push measurement data to the DCAE VES Collector. The VES Collector validates, filters, and packages the received measurement data, and publishes the data to other components of the ONAP architecture. All VNF instances are provisioned with VES Collector address(es) so as to be able to send measurement data, in the form of event records, to the VES Collector. + +The ONAP data model for event records consists of a Common Header, followed by records containing measurement data. In ONAP, measurement data may be of two kinds (cf. [14]): + +- 'Technology independent' - these include Fault, Heartbeat, State Change, Syslog, Threshold Crossing Alerts, and measurements related to VNF scaling; +- 'Technology specific' - these include records related to Mobile Flow, Signalling and Voice Quality. + +Both the Technology Independent and Technology Specific records are extensible. + +Each technology-specific measurement data specification allows additional fields (name/value pairs) for extensibility. + +In addition, technology specific measurement data can be extended to support other types of records (e.g. Network Fabric, Security records, etc.). In such cases, the VNF providers can use these VNF-specific additional fields to provide additional information that may be relevant to the managing systems. A placeholder for additional technology specific areas of interest to be defined in the future documents has been depicted. + +This placeholder potentially leaves room for 3GPP to define performance measurement data for 3GPP technologies (GERAN, UTRAN, E-UTRAN). + +![Diagram of ONAP R2 DCAE VES Collector – Technology-specific measurement data. The diagram shows four boxes representing different types of records: MobileFlow, Signaling, Voice Quality, and Future Domains. Each box has a header, a list of specific fields, and a 'Name/Value' section at the bottom. Blue arrows point to each box from above. The entire diagram is labeled 'Technology Specific Records' at the bottom.](e05c1a13b44ab41505609d82b00cf4df_img.jpg) + +| | | | | | +|-----------------------------------------------------------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------|------| +| <b>MobileFlow</b><br>RptEndPt<br>OthEndPt<br>Flow.....<br><b>Name/Value</b> | <b>Signaling</b><br>SIP/SDP<br>H.323<br>Megaco...<br><b>Name/Value</b> | <b>Voice Quality</b><br>RTCP<br>Packet Loss<br>Other QoS<br><b>Name/Value</b> | <b>Future Domains</b><br>Configuration<br>Security<br>Usage<br><b>Name/Value</b> | .... | +|-----------------------------------------------------------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------|------| + +Technology Specific Records + +Diagram of ONAP R2 DCAE VES Collector – Technology-specific measurement data. The diagram shows four boxes representing different types of records: MobileFlow, Signaling, Voice Quality, and Future Domains. Each box has a header, a list of specific fields, and a 'Name/Value' section at the bottom. Blue arrows point to each box from above. The entire diagram is labeled 'Technology Specific Records' at the bottom. + +**Figure 5.2.3.1.1: ONAP R2 DCAE VES Collector – Technology-specific measurement data** + +NOTE: ONAP R2 DCAE VES Collector – Technology-specific measurement data Figure attribution [14]. + +#### 5.2.3.2 3GPP Performance Management + +3GPP performance measurement data are specified on a per-technology basis, i.e. for GERAN, UTRAN, LTE and 5G technologies, and, for each technology, for the radio access network part and for the core network part. For 5G networks, all measurements are defined in TS 28.552 [15]. + +In 5G, performance management services (cf. 3GPP TS28.550 [9] and 28.532 [10]) enables a potential consumer to start / stop performance jobs on network functions of the 3GPP 5G network. When initiating a PM job, the consumer specifies the network functions on which the PM job is to be launched, the name of measurements to be collected, granularity period, collection period, etc. as well as threshold values, enabling the performance management service provider to issue notifications when actual performance measurement values reach or cross those threshold values. + +Performance measurement data are made available to the consumer either via files or streaming (cf. [9]). Prior to this, potential consumers willing to be informed of the existence of such files or to receive streamed measurement data have to subscribe to the relevant notifications. + +#### 5.2.3.3 Comparison + +##### 5.2.3.3.1 PM job handling + +###### 5.2.3.3.1.1 Existing gap + +In 3GPP 5G networks, performance measurement jobs are launched from an application service consumer on network functions. Performance measurement job parameters include start time, end time, identifiers of network function instances on which to collect the performance measurements, name of performance measurements to be collected, granularity period (i.e. the periodicity at which the measurements are collected), and reporting period (i.e. the periodicity at which the measurement results are made available to the consumer(s)). When measurement results are available, i.e. at the end of each reporting period, a notification ('Notify File Ready') is sent out to the consumer(s) that subscribed to such notifications, and which can then retrieve this measurement data via file transfer mechanisms. + +In ONAP, there is no concept of Performance Management (PM) job. Instead, VNFs are configured with information indicating which performance measurements are to be collected, low and high thresholds assigned to these performance measurements, recommended actions to be initiated in case thresholds are crossed, etc. Virtualized network functions and services are designed within the ONAP Design Time Framework based on information supplied by the VNF provider about parameters, metrics, and KPIs exposed for resource and application management. + +In ONAP Release 3, three collection frameworks are specified and VNF instances are configured, via configuration management, to enable them to collect specified measurements and send them to the specified DCAE collector. + +In order to bridge this existing gap in the 3GPP 5G management framework, the Network Resource Model in TS 28.541 could be extended with IOCs and their attributes so as to represent PM job control capabilities, (e.g., the granularity period, reporting period, type of reporting (streaming, file-based), low and high thresholds assigned to these performance measurements, recommended actions to be initiated in case thresholds are crossed, etc.) and PM measurements which MOIs are to collect. + +A potential integration of 3GPP 5G performance measurement data collection into ONAP/DCAE R3 would require the following: + +- some ONAP component provides, at VNF instantiation time or later, a list of parameters corresponding to performance measurements to be collected during the life time of VNF instances, with their granularity period, reporting period, etc.; +- VNF instances have the capability to send their performance measurement data to the ONAP/DCAE Collector using the specified reporting method; +- the ONAP/DCAE VES Collector API is extended with the definition of 3GPP 5G technology-specific measurement data definitions defined in [15]. + +###### 5.2.3.3.1.2 Proposed modifications to 3GPP specifications + +A potential solution for the control of PM measurements in the 3GPP management framework, in line with ONAP, is to update TS 28.541 [4] with new IOCs and attributes, configurable via the provisioning management service (cf. [3] and [10]). + +##### 5.2.3.3.2 FM/PM data reporting + +###### 5.2.3.3.2.1 Existing gap + +In ONAP, the DCAE collection framework is aimed at collecting all sorts of events from VNFs. + +In ONAP R1 and R2 architectures, the DCAE collection framework was comprised of: + +- VES (VNF Event Stream) Collector, via REST / HTTPS / JSON API; +- SNMP Trap Collector, via SNMP. + +In ONAP R3 architecture, the DCAE collection framework has been augmented with: + +- File Collector, to support Bulk PM, to support 3GPP bulk data file collection over FTPES (SFTP); +- VES-HV (High-Volume) Collector, to support Real-Time Performance Measurement (RTPM), using Google Protocol Buffer (GPB) over TLS/TCP. + +In ONAP R1 and R2, the following management requirements (still valid for R3) specified what xNFs (i.e. PNFs and VNFs) support with respect to how they deliver their alarms, performance measurements, etc.: + +" + +- *R-06924 The xNF MUST deliver asynchronous data as data becomes available, or according to the configured frequency. (cf. <https://onap.readthedocs.io/en/beijing/submodules/vnfrqts/requirements.git/docs/Chapter7.html> - section 7.4.5.7)* +- *R-98191 The xNF MUST vary the frequency that asynchronous data is delivered based on the content and how data may be aggregated or grouped together. (cf. <https://onap.readthedocs.io/en/beijing/submodules/vnfrqts/requirements.git/docs/Chapter7.html> - section 7.4.5.5)* + +Note: + +- *For example, alarms and alerts are expected to be delivered as soon as they appear. In contrast, other content, such as performance measurements, KPIs or reported network signaling may have various ways of packaging and delivering content. Some content should be streamed immediately; or content may be monitored over a time interval, then packaged as collection of records and delivered as block; or data may be collected until a package of a certain size has been collected; or content may be summarized statistically over a time interval, or computed as a KPI, with the summary or KPI being delivered.* +- *We expect the reporting frequency to be configurable depending on the virtual network function's needs for management. For example, Service Provider may choose to vary the frequency of collection between normal and trouble-shooting scenarios.* +- *Decisions about the frequency of data reporting will affect the size of delivered data sets, recommended delivery method, and how the data will be interpreted by ONAP. These considerations should not affect deserialization and decoding of the data, which will be guided by the accompanying JSON schema or GPB definition files.* + +". + +In ONAP R3, requirements for 'bulk performance measurement' have been introduced (cf. <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/requirements.git/docs/Chapter9/index.html?highlight=ves>): + +" + +- *R-841740 - The xNF SHOULD support FileReady VES event for event-driven bulk transfer of monitoring data.* +- *R-440220 - The xNF SHOULD support File transferring protocol, such as FTPES or SFTP, when supporting the event-driven bulk transfer of monitoring data* +- *R-75943 - The xNF SHOULD support the data schema defined in 3GPP TS 32.435, when supporting the event-driven bulk transfer of monitoring data.* + +". + +In the 3GPP 5G management framework, the `createMeasurementJob()` operation (cf. draft TS 28.550 [1] – clause 6.1.1) supports, amongst others, the three following input parameters: + +``` +# reportingMethod + +# granularityPeriod + +# reportingPeriod +``` + +Note that, in draft TS 28.550 [1] – clause 6.1.1, it is stated that: + +" + +If the `reportingMethod` is performance data streaming: + +- The value of `granularityPeriod` is an integer value in seconds (see Note 1 below). + +NOTE 1: The `granularityPeriod` defines the measurement data production rate. The supported rates are dependent on the capacity of the producer involved (e.g. the processing power of the producer, number of measurements being measured by the producer at the time, the complexity of the measurement type involved etc) and therefore, it cannot be standardized for all producers involved. The supported rates can only reflect the negotiated agreement between producer and the consumer involved. + +". + +Table 5.2.3.3.2.1-1 gives an overview of reporting methods in 3GPP 5G management framework, supported values of Reporting Period, candidate collectors in DCAE (ONAP R3) and candidate solution sets in 3GPP Rel-16: + +**Table 5.2.3.3.2.1-1: Comparison of 3GPP and ONAP PM data reporting** + +| 3GPP performance data reporting method | Supported values of Reporting Period | Candidate collectors in ONAP R3 | Candidate 3GPP Rel-16 solution sets | +|----------------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------| +| Data file | 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours and 24 hours | VES JSON Collector (for FileReady notification) | Protocol: REST / HTTPS<br>Payload: JSON | +| | | File Collector (for PM file upload) | Protocol: FTPES or SFTP<br>File content: XML | +| Data stream | No values defined in TS 28.550 2.0.0) | VES JSON Collector for low-medium volume PM | Protocol: REST / HTTPS<br>Payload: JSON | +| | | VES-HV Collector for real-time (less than 1 minute) high volume PM | Protocol: REST/HTTPS<br>Payload: ASN.1 Binary | + +Table 5.2.3.3.2.1-2 applies for alarm notifications: + +**Table 5.2.3.3.2.1-2: Comparison of 3GPP and ONAP alarm event reporting** + +| 3GPP alarm reporting method | Number / Periodicity / Volume | Candidate collectors in ONAP R3 | Candidate 3GPP Rel-16 solution sets | +|-----------------------------|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|-------------------------------------------------| +| Notification | Number: High (potentially)<br>Periodicity: unknown<br>Volume (of each notification): low | VES JSON Collector for alarm notifications under normal conditions | Protocol: REST / HTTPS<br>Payload: JSON | +| | | VES-HV Collector for alarm notifications under alarm flooding conditions | Protocol: REST / HTTPS<br>Payload: ASN.1 Binary | + +###### 5.2.3.3.2.2 Proposed modifications to 3GPP specifications + +The following are proposed changes to 3GPP specifications TS 28.550 and TS 28.532 to align the 3GPP 5G management framework with ONAP for the reporting of FM/PM data: + +- Specify in TS 28.550 (and in TS 28.532), in addition to existing file-based PM data reporting, how PM measurement data can be reported to a PM data consumer (e.g. ONAP DCAE Collection Framework), via: + +- # REST / HTTP and JSON for low-medium non-real-time reporting + +- # REST/HTTPS and ASN.1 Binary for high volume real-time reporting. + +##### 5.2.3.3.3 Reporting 3GPP Rel-15 PM data to DCAE R3 VES JSON Collector + +In [12] – clause 'Datatype: commonEventHeader', the 'domain' field indicates all types of events that can be received by the DCAE R3 VES JSON Collector: + +**Table 5.2.3.3.3-1: ONAP DCAE VES common event header domain field** + +| Field | Type | Required? | Description | +|--------|--------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| domain | string | Yes | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' | + +NOTE: ONAP DCAE VES common event header - domain field Figure attribution [12]. + +As a potential solution for enabling the DCAE R3 VES JSON Collector to consume 3GPP Rel-15 PM data, 3GPP could collaborate with ONAP to add new possible values to the field 'domain' of ONAP VES JSON API: + +- 3GPPNGRANMeasurement, corresponding to 3GPP TS 28.552 [15] – clause 5.1 (Performance measurements for gNB); +- 3GPP5GCMeasurement, corresponding to 3GPP TS 28.552 [15] – clauses 5.2 to 5.6; +- 3GPPNSMeasurement, corresponding to measurements for network slices defined 3GPP TS 28.552 [15] – clause 6; +- 3GPPE2EMeasurement, corresponding to measurements for networks defined 3GPP TS 28.552 [15] – clause 6. + +New types of fields would have to be added to the existing ones at the root level of the common event format of ONAP VES JSON API shown in Table 5.2.3.3.3-2 below: + +**Table 5.2.3.3.3-2: Existing types of headers for VES JSON Collector R3 ([12] – Datatype: event)** + +| Name | Required | Type | +|--------------------------------|----------|--------------------------------| +| commonEventHeader | Yes | commonEventHeader | +| faultFields | No | faultFields | +| heartbeatFields | No | heartbeatFields | +| measurementsForVfScalingFields | No | measurementsForVfScalingFields | +| mobileFlowFields | No | mobileFlowFields | +| otherFields | No | otherFields | +| sipSignalingFields | No | sipSignalingFields | +| stateChangeFields | No | stateChangeFields | +| syslogFields | No | syslogFields | +| thresholdCrossingAlertFields | No | thresholdCrossingAlertFields | +| voiceQualityFields | No | voiceQualityFields | + +NOTE: ONAP DCAE VES JSON - Existing types of headers Figure attribution [12]. + +The following new types of events would thus be added to ONAP DCAE VES JSON API header fields: + +**Table 5.2.3.3.3-3: Possible new types of headers for VES JSON Collector – Datatype: event** + +| Name | Required | Type | +|----------------------------|----------|----------------------------| +| 3GPPNGRANMeasurementFields | No | 3GPPNGRANMeasurementFields | +| 3GPP5GCMeasurementFields | No | 3GPP5GCMeasurementFields | +| 3GPPNSMeasurementFields | No | 3GPPNSMeasurementFields | +| 3GPPE2EMeasurementFields | No | 3GPPE2EMeasurementFields | + +where 3GPPNGRANMeasurementFields, 3GPP5GCMeasurementFields, 3GPPNSMeasurementFields and 3GPPE2EMeasurementFields could use the input parameter definitions for performance data file content defined in 3GPP TS 28.532 [10] and names of measurements defined in TS 28.552[15] and TS 28.554[17]. + +##### 5.2.3.3.4 3GPP Fault Supervision operations + +3GPP alarm notifications can be mapped to HTTP messages from xNFs to DCAE Collectors. + +3GPP fault supervision data report management service for NF is also made up of the following operation (cf. [10] clause 6.1.1): + +- `getAlarmList ()`. + +`getAlarmList ()` may be used by a fault supervision data report management service consumer to deal with alarm loss. 3GPP TS 28.545 [11] does not specify conditions under which a management service consumer should invoke this operation. In the ONAP architecture, the fault supervision data report service consumer receiving alarm notifications from xNFs would typically be a DCAE Collector (VES/JSON or VES-HV), whereas the fault supervision data report service consumer issuing `getAlarmList ()` operation requests to xNFs would be the APP-C. + +3GPP fault supervision data control management service for NF is made up of the following operations (cf. [10] clause 6.1.2): + +- `acknowledgeAlarms ()`; +- `unacknowledgeAlarms ()`; +- `clearAlarms ()`. + +The fault supervision data control management service consumer issuing `acknowledgeAlarms ()`, `unacknowledgeAlarms ()`, `clearAlarms ()` operation requests to xNFs would be the ONAP APP-C. + +## 5.3 Conclusions on FM/PM + +The clause 5 of the present document studies the positioning of ONAP DCAE Collectors with regard to 3GPP management services for fault and performance management purposes. It also analyzes how ONAP DCAE Collectors can consume 3GPP management services, from various perspectives: + +- General communication principles for all sorts of messages (FM and PM), based on ONAP DCAE common event header. It identifies a gap between ONAP DCAE Collectors which addresses, as recipient of notifications from 3GPP management service producers, are known by 3GPP management service producers (e.g. VNFs / PNFs), and 3GPP management framework which relies on the subscribe / notify paradigm; +- Fault management: possible mapping of 3GPP fault supervision alarm notification parameters to ONAP DCAE Collectors' API, either by using existing technology-independent records or by defining a new 3GPP-specific fault management technology-specific record; +- Fault management operations, specified in 3GPP fault supervision management services, and not addressed by ONAP; +- Performance management: possible mapping of 3GPP performance measurement data reporting to ONAP DCAE Collectors' API, both data file based and stream based. For the latter one, the study illustrates how the mapping can be done, either by using existing technology-independent records or by defining a new 3GPP-specific performance management technology-specific record. It also shows that 3GPP PM job control can be supported via configuration management in ONAP; +- Heartbeat mechanism, enabling DCAE Collectors to stay informed that VNFs / PNFs are alive. + +The group recommends starting normative work on the following aspects: + +- General communication aspects: + - Specifying a mapping between 3GPP notification mandatory input parameters and ONAP DCAE common event header required fields, + - Specifying a corresponding JSON schema, + - Specifying a solution for capturing the 3GPP notification recipients addresses when subscribing to notifications is not supported; + +- Fault supervision: + - Definition of new use cases and requirements for fault supervision management services, + - Specifying a mapping from existing 3GPP alarm notification input parameters (except those addressed above) to a new ONAP VES JSON schema, + - Specifying JSON solution set definitions for fault supervision data report; +- Performance management: + - Definition of new use cases and requirements for performance management services, + - Specifying a mapping from existing 3GPP performance measurement data streaming parameters (except those addressed above) to a new ONAP VES JSON schema + - Specifying an alternative to existing 3GPP performance management job control via configuration management based control of performance management, + - Specifying JSON and ASN.1 solution set definitions for performance measurement data streaming; +- Heartbeat: + - Definition of use cases and requirements for heartbeat, + - Specifying solutions for heartbeat, in case of 3GPP network functions. + +# --- 6 Integration of ONAP with 3GPP management services for configuration management purposes + +## 6.1 ONAP controllers and 3GPP provisioning service + +### 6.1.1 ONAP controllers + +#### 6.1.1.1 Introduction + +The southbound interface of the ONAP platform for LCM and CM operations is based on a layer of controllers. Controllers are components in the ONAP platform that connect to cloud and network services, execute configuration and real-time policies, and control the state of distributed components and services. Rather than using a single monolithic control layer, operators may choose to use multiple distinct controller types to manage different resources in the execution environment, each corresponding to a distinct domain. + +ONAP controllers expose a northbound API to other ONAP components that allow them to initiate activities (effectively commands) on VNFs and/or PNFs. ONAP controllers interact southbound with xNFs through network and application adapters to perform configuration and other lifecycle management activities towards xNFs. + +In ONAP R3, the following controllers are available: + +- Application Controller (APPC) +- Software Defined Networking Controller (SDNC) +- Virtual Function Controller (VF-C). + +These controllers are further described in the following sections. + +#### 6.1.1.2 APPC + +##### 6.1.1.2.1 Overview + +The Application Controller (APPC) is one of the components in the ONAP platform. Its main function is to control the lifecycle of VNFs and VNFCs (but not PNFs). APPC can use one of several adapters to connect to a VNF. + +![Figure 6.1.1.2.1-1: APPC High Level Architecture. The diagram shows the APPC architecture within the ONAP framework. At the top, ONAP components (SDC, DCAE, SO, Portal, TechOps) interact with the APPC. SDC provides VNF artifacts to the DMAAP. DCAE, SO, and Portal interact with the DMAAP via LCM Commands, events, and logs. TechOps interacts with the APPC via an OAM API. The APPC itself is composed of several layers: Northbound REST Layer (DMAAP Adapter, DMAAP Listener), APP-C Provider (Request Handler, Dispatcher), Service Logic Interpreter (DG's and Execute Nodes) containing a TOSCA Parser, DGOrchestrator, Sequence Generator, and VNF Template Generator, and a Southbound Layer with adapters for Chef, Ansible, Netconf, and IaaS (Openstack). The Service Logic Interpreter also connects to a Webbound Layer (SDC Adapter, A&AI Adapter) and Cross Cutting Components (Configuration, Operations, Reporting, KPIs, Security, Logging, Data Access). The APPC Database is also shown. All Southbound adapters connect to Application VFs in the Cloud.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +Figure 6.1.1.2.1-1: APPC High Level Architecture. The diagram shows the APPC architecture within the ONAP framework. At the top, ONAP components (SDC, DCAE, SO, Portal, TechOps) interact with the APPC. SDC provides VNF artifacts to the DMAAP. DCAE, SO, and Portal interact with the DMAAP via LCM Commands, events, and logs. TechOps interacts with the APPC via an OAM API. The APPC itself is composed of several layers: Northbound REST Layer (DMAAP Adapter, DMAAP Listener), APP-C Provider (Request Handler, Dispatcher), Service Logic Interpreter (DG's and Execute Nodes) containing a TOSCA Parser, DGOrchestrator, Sequence Generator, and VNF Template Generator, and a Southbound Layer with adapters for Chef, Ansible, Netconf, and IaaS (Openstack). The Service Logic Interpreter also connects to a Webbound Layer (SDC Adapter, A&AI Adapter) and Cross Cutting Components (Configuration, Operations, Reporting, KPIs, Security, Logging, Data Access). The APPC Database is also shown. All Southbound adapters connect to Application VFs in the Cloud. + +**Figure 6.1.1.2.1-1: APPC High Level Architecture** + +NOTE: APPC High Level Architecture Figure attribution [20]. + +In ONAP R3, APPC contains adapters towards the following interface protocols: + +- Netconf with uploadable Yang model (requires a Netconf server running on the VNF) +- Chef (requires a Chef client running on the VNF) +- Ansible (no requirements on the VNF software) + +APPC interacts with VNFs through its Network and Application Adapters to perform configuration activities within NFV environment. These activities include service and resource configuration/reconfiguration, automated scaling of resources, service and resource removal to support runtime lifecycle management of VNFs and services. The Adapters employ a model driven approach along with standardized APIs provided by the VNF developers to configure resources and manage their runtime lifecycle. + +The APPC architecture is designed to allow a VNF owner or vendor to enable a new VNF to support a set of LCM API actions that are designated as self-service. This procedure is known as VNF self-service onboarding. The VNF owner/vendor needs to create a template and parameter definitions for LCM actions that use the Netconf, Chef, or Ansible protocols. + +The template is a text block in XML (if the protocol is Netconf) or JSON (for Chef or Ansible) format that defines the "payload" to be included in the request. This file contains the desired configuration parameter values to execute the LCM action and is sent, either directly to the VNF (for Netconf), or to the Chef/Ansible server that in turn uses these values to configure the VNF. + +##### 6.1.1.2.2 APPC Netconf Adapter + +The APPC Netconf Adapter is responsible for sending configuration tasks in XML format to VNFs that support the Netconf protocol. APPC includes a deployment of OpenDaylight and thus can consume NRMs expressed in the YANG modelling language. + +##### 6.1.1.2.3 APPC Chef Adapter + +Chef is an open-source VNF management framework. The APPC Chef adapter enables APPC to operate cookbooks that perform various LCM operations towards VNFs connected to an external Chef server. This server acts as a hub for configuration data and stores cookbooks, the policies that are applied to VNFs, and metadata that describes each + +registered VNF that is being managed by Chef. A Chef client is required on the VNFs that will be directly managed by the Chef server. The client exposes REST APIs used to manage the VNF. + +A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains recipes that specify the resources to use and the order in which they are to be applied. A recipe is expressed in the Ruby language and consists mainly of a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). Each recipe is required to be stored in a cookbook and may be included in another recipe or have a dependency on one (or more) recipes. + +A cookbook also contains: + +- Attribute values +- File distributions +- Templates +- Extensions to Chef, such as custom resources and libraries + +##### 6.1.1.2.4 APPC Ansible Adapter + +Ansible is an open-source VNF management framework. The APPC Ansible adapter enables APPC to operate playbooks that perform various LCM operations towards VNFs connected to an external Ansible server. This server can execute Ansible playbooks southbound towards the VNF and exposes a REST interface northbound towards APPC that is compliant with its requirements. The exact implementation of the Ansible Server is left open. Any action (e.g., configure, restart, health check) can be executed on the VNF by constructing a playbook or set of playbooks that is executed by an Ansible agent on the VNF via SSH. + +![Sequence diagram illustrating the Ansible workflow when APPC receives an event. The diagram shows four lifelines: CLIENT, ONAP, Ansible Server, and VNF. The sequence of messages is: 1. CLIENT sends a 'Client requests Action' to ONAP. 2. ONAP creates a request and sends a 'ONAP makes request against Ansible Server' to the Ansible Server. 3. The Ansible Server responds with 'PENDING' to ONAP. 4. The Ansible Server then sends 'Ansible Server begins playbook execution' to the VNF. 5. The VNF finishes the playbook execution and sends 'Ansible Server replies with playbook result' back to the Ansible Server. 6. Finally, the Ansible Server sends 'ONAP returns status to client' back to the CLIENT.](1841f348dfa81a3438d4e1f8465d9ac7_img.jpg) + +``` + +sequenceDiagram + participant CLIENT + participant ONAP + participant Ansible Server + participant VNF + Note right of CLIENT: Client requests Action + CLIENT->>ONAP: Client requests Action + ONAP->>Ansible Server: ONAP makes request against Ansible Server + Ansible Server-->>ONAP: Ansible Server responds with PENDING + Ansible Server->>VNF: Ansible Server begins playbook execution + VNF-->>Ansible Server: Ansible Server replies with playbook result + Note right of VNF: VNF finishes Playbook execution + Ansible Server-->>ONAP: ONAP returns status to client + ONAP-->>CLIENT: ONAP returns status to client + +``` + +Sequence diagram illustrating the Ansible workflow when APPC receives an event. The diagram shows four lifelines: CLIENT, ONAP, Ansible Server, and VNF. The sequence of messages is: 1. CLIENT sends a 'Client requests Action' to ONAP. 2. ONAP creates a request and sends a 'ONAP makes request against Ansible Server' to the Ansible Server. 3. The Ansible Server responds with 'PENDING' to ONAP. 4. The Ansible Server then sends 'Ansible Server begins playbook execution' to the VNF. 5. The VNF finishes the playbook execution and sends 'Ansible Server replies with playbook result' back to the Ansible Server. 6. Finally, the Ansible Server sends 'ONAP returns status to client' back to the CLIENT. + +**Figure 6.1.1.2.4-1: Ansible workflow envisioned when APPC receives an event** + +NOTE: Ansible workflow envisioned when APPC receives an event Figure attribution [21]. + +Playbooks are expressed in YAML format and model a configuration or process. Each playbook is composed of one or more 'plays' in a list. Each play contains of a list of tasks and indicates a set of host machines to target and a remote user for authentication. Tasks are executed in order, one at a time, against all machines matched by the host pattern, before moving on to the next task. Within a play, all hosts receive the same task directives. It is the purpose of a play to map a selection of hosts to tasks. + +The goal of each task is to execute a single Ansible module with specific arguments. Ansible modules are reusable, standalone scripts that execute within an Ansible server and return information in JSON format. Variables can be used in arguments to modules. Each module has a dedicated use, such as administering users on a specific type of database or managing VLAN interfaces on a specific type of network device. Modules are for the most part vendor-specific. + +#### 6.1.1.3 SDNC + +The Software Defined Networking Controller supports management of transport network resources. Before ONAP R3, the ONAP controllers (APPC and SDNC) were classified as L4-L7 (APPC) and L0-L3 (SDNC) controllers. But this classification was removed in R3, which would mean that the scope of each controller becomes wider and potentially overlapping. Configuration management is not supported by SDNC in ONAP Rel-3. + +#### 6.1.1.4 VF-C + +The Virtual Function Controller (VF-C) is an implementation of an ETSI NFV-MANO stack and provides an LCM interface towards ETSI-compliant VNFs. VF-C also provides a GVNFM capability and can integrate with external VNFM and VIMs as part of an NFV MANO stack. + +![Figure 6.1.1.4-1: VF-C High Level Architecture diagram showing the layers and components of the VF-C stack.](875c6f4f441fdd3ca7e1908fd1582983_img.jpg) + +The diagram illustrates the VF-C High Level Architecture. At the top, a dashed box contains several components: SDC, Common Services, A&AI (with an Inventory sub-component), and DCAE. These are connected to a central 'Adaptor' layer. To the right, Policy, SO, and Portal (each with an 'Adaptor' sub-component) are also connected to this layer. Below the Adaptor layer is the 'NFVO' (Network Functions Virtualisation Orchestrator) layer, which is part of the 'VF-C' (Virtualisation Function Controller) stack. The NFVO layer connects to a 'Multi-VIM' (Virtualisation Infrastructure Manager) layer via an 'NS/VNF LCM' (Lifecycle Management) interface. The VF-C layer itself contains several 'Adaptor' components and a 'GVNFM' (Generic VNF Manager) component. Below the VF-C layer, there are three main management entities: 'EMs' (Element Managers), 'SFC Controllers' (Service Function Chain Controllers), and 'VNF Vendor's VNFM' (VNF Vendor's VNF Manager). These entities are connected to the VF-C layer via specific interfaces: 'Collect Alarms&KPI', 'Create/Del... SFC', and 'Create/Del... VNF'. At the bottom, a cloud-like area represents the network environment, containing multiple 'VNF' (Virtual Network Function) blocks and 'VIMs' (Virtualisation Infrastructure Managers). Arrows indicate the flow of management and data between the layers and components. A legend at the bottom right indicates that red boxes represent 'Extension' components. + +Figure 6.1.1.4-1: VF-C High Level Architecture diagram showing the layers and components of the VF-C stack. + +Figure 6.1.1.4-1: VF-C High Level Architecture + +NOTE: VF-C High Level Architecture Figure attribution [8]. + +### 6.1.2 3GPP provisioning service + +Management services for provisioning of networks and network slicing are defined in [3]. The management services for /NS/NSS/NF/network and subnetwork provisioning are listed in the following tables. + +**Table 6.1.2-1: Management services for network slice provisioning** + +| MnS Name | MnS Component Type A<br>(operations and notifications) | MnS Component Type B<br>(information model) | Note | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Provisioning for NSI | Operations defined in clause 5 of TS 28.532 [10]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- deleteMOI operation</li> <li>- getMOIAttributes operation</li> <li>- modifyMOIAttributes operation</li> </ul> Operations defined in clause 6.5: <ul style="list-style-type: none"> <li>- allocateNsi operation</li> <li>- deallocateNsi operation</li> </ul> | NSI information model defined in clause 6.3 of TS 28.541 [4] | <p>This management service enables its consumer to request allocating, deallocating, or modifying an NSI.</p> <p>The typical scenario is "Network Slices as NOP internals" model where this MnS is consumed by operators.</p> | +| Provisioning data report for NSI | Notification defined in clause 5 of TS 28.532 [10]: <p>notifyProvisioning notification</p> | NSI information model defined in clause 6.3 of TS 28.541 [4] | <p>This management service enables its consumer to obtain notifications about NSI Information model data.</p> <p>The typical scenario is "Network Slices as NOP internals" model where this MnS is consumed by operators</p> | +| Provisioning exposure for NSI | Operations defined in clause 5 of TS 28.532 [10]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- deleteMOI operation</li> <li>- getMOIAttributes operation</li> <li>- modifyMOIAttributes operation</li> </ul> Operations defined in clause 6.5: <ul style="list-style-type: none"> <li>- allocateNsi operation</li> <li>- deallocateNsi operation</li> </ul> | NSI information model defined in clause 6.3 of TS 28.541 [4] | <p>This management service enables its consumer to request allocating, deallocating or modifying an NSI.</p> <p>The typical scenario is NSaaS model where this MnS is consumed by vertical industry.</p> | + +| | | | | +|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Provisioning data report exposure for NSI | Notifications defined in clause 5 of TS 28.532 [10]: <ul style="list-style-type: none"> <li>- notifyProvisioning notification</li> </ul> | NSI information model defined in clause 6.3 of TS 28.541 [4] | <p>This management service enables its consumer to obtain notifications about NSI Information model data.</p> <p>The typical scenario is NSaaS model where this MnS is consumed by vertical industry.</p> | +|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Table 6.1.2-2: Management services for NSS provisioning** + +| <b>MnS Name</b> | <b>MnS Component of type A<br/>(Operations and notifications)</b> | <b>MnS Component of type B<br/>(information model)</b> | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| +| Provisioning for NSSI | <p>Operations defined in clause 5 of TS 28.532 [10]:</p> <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- modifyMOIAttributes operation</li> <li>- getMOIAttributes operation</li> <li>- deleteMOI operation</li> </ul> <p>Operations defined in clause 6.5:</p> <ul style="list-style-type: none"> <li>- allocateNssi operation</li> <li>- deallocateNssi operation</li> </ul> | NSSI information model defined in clause 6.3 of TS 28.541 [4] | +| Provisioning data report for NSSI | <p>Notifications defined in clause 5 of TS 28.532 [10]:</p> <p>notifyProvisioning notification</p> | NSSI information model defined in clause 6.3 of TS 28.541 [4] | + +**Table 6.1.2-3: Management services for NF provisioning** + +| <b>MnS Name</b> | <b>MnS Component of type A<br/>(Operations and notifications)</b> | <b>MnS Component of type B<br/>(information model)</b> | +|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| Provisioning for NF | Operations defined in clause 5 of TS 28.532 [10]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- modifyMOIAttributes operation</li> <li>- getMOIAttributes operation</li> <li>- deleteMOI operation</li> </ul> | NF(s)/ME(s) information model defined in TS 28.541 [4] | +| Provisioning data report for NF | Notifications defined in clause 5 of TS 28.532 [10]:<br>notifyProvisioning notification | NF(s)/ME(s) information model defined in TS 28.541 [4] | + +**Table 6.1.2-4: Management services for network and sub-network provisioning** + +| <b>MnS name</b> | <b>MnS Component of type A<br/>(Operations and notifications)</b> | <b>MnS Component of type B<br/>(information model)</b> | +|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| Provisioning for network and sub-networks | Operations defined in clause 5 of TS 28.532 [10]: <ul style="list-style-type: none"> <li>- createMOI operation</li> <li>- modifyMOIAttributes operation</li> <li>- getMOIAttributes operation</li> <li>- deleteMOI operation</li> </ul> Operation defined in clause 6.5: <ul style="list-style-type: none"> <li>- AllocateNetwork operation</li> </ul> | IOC(s) of sub-network, as defined in TS 28.541 [4] | +| Provisioning data report for sub-networks | Notifications defined in clause 5 of TS 28.532 [10]:<br>notifyProvisioning notification | IOC(s) of sub-network, as defined in TS 28.541 [4] | + +### 6.1.3 Positioning + +#### 6.1.3.1 Introduction + +If authorized, the ONAP controller plays the role of the consumer of the provisioning management services produced by a 3GPP management service producer. If authorized, the 3GPP management function can play the role of the consumer of the LCM and CM interface produced by ONAP controller. + +#### 6.1.3.2 An example of ONAP controller utilizing management services provided by 3GPP Management Services Provider + +Figure 6.1.3.2-1 shows an example of ONAP Controller (e.g. APPC) utilizing part of provisioning management services provided by 3GPP Management Service Provider. In this example, the ONAP Controller as part of 3GPP MnS(s) Consumer may utilize part of provisioning management services (e.g. configuration related provisioning management service components) as follows provided by 3GPP Management Service Provider based on comparative analysis in the present document: + +![Diagram of ONAP controller utilizing 3GPP MnS(s) Provider](132cff7e872feb31f629703959beddd7_img.jpg) + +The diagram illustrates a 'Consumer of 3GPP MnS(s)' at the top, which contains an 'ONAP controller' box. A vertical line descends from the ONAP controller to a '3GPP MnS(s) Provider' at the bottom. This line features a small circle with a dot, representing an interface, and is accompanied by a series of six dots (.....). The '3GPP MnS(s) Provider' box contains a 'Provisioning MnS(s)' component. + +Diagram of ONAP controller utilizing 3GPP MnS(s) Provider + +**Figure 6.1.3.2-1: An example of ONAP Controller utilizing the management services provided by 3GPP MnS(s) Provider** + +#### 6.1.3.3 An example of 3GPP MnF using interface provided by ONAP VF-C + +Figure 6.1.3.3-1 shows an example of 3GPP MnF using interfaces provided by ONAP VF-C. In this example, in order to support provisioning MnS in the virtualization environment, the 3GPP MnF which provide provisioning MnS as ONAP VF-C consumer may use some interfaces (e.g. Network Service lifecycle management interface and VNF lifecycle management interface) provided by ONAP VF-C for the lifecycle management of Network Service(s) and VNF(s). + +![Diagram of 3GPP MnF using ONAP VF-C interfaces](3621e1493d508bd789fec58ba8be9a40_img.jpg) + +The diagram shows a 'Consumer of ONAP VF-C Interfaces' on the left, containing a '3GPP MnF' box, connected by a horizontal line to a 'Provider of ONAP VF-C Interfaces' on the right, which contains a 'Virtual Function Controller(VF-C)' box. + +Diagram of 3GPP MnF using ONAP VF-C interfaces + +**Figure 6.1.3.3-1: An example of 3GPP MnF using some interfaces provided by ONAP VF-C** + +NOTE: In this example, the 3GPP MnF is used to provide the provisioning MnS. + +## 6.2 Comparative analysis + +### 6.2.1 Introduction + +This clause provides a comparison of configuration management capabilities between ONAP controllers and 3GPP 5G management services for provisioning based on the assumed positioning (cf. clause 6.1). + +### 6.2.2 Management principles + +APPC is designed to perform LCM and CM operations on VNFs. In ONAP R3, APPC does not officially support any operations towards PNFs. + +VF-C is an implementation of an ETSI NFV-MANO stack and provides an LCM interface towards ETSI-compliant VNFs via the Os-Ma-nfvo, Ve-Vnfm-em and Ve-Vnfm-vnf reference points (cf. clause 5.2 of [2]). These reference points are outside of the domain of the 3GPP 5G management services. VF-C is not designed to perform application CM operations on VNFs. + +A 3GPP 5G management service producer provides provisioning management services to perform LCM and CM operations and related notifications on a 5G network. The 5G network is modelled in the 5G NRM (model is specified in YANG, JSON and XML solution sets) and allows the consumer of the provisioning management service to create, delete, modify and get attributes of any object instances in the model (NRM). The consumer may additionally subscribe to receive notifications on creation and deletion of an object instance or an attributeValueChange of an object instance. The NRM fragments includes Subnetwork, NR, 5GC, NetworkSlice, NetworkSliceSubnet, ME, MF, VNF and PNF (VNF and PNF models are imported from ETSI NFV). For provisioning management of Subnetwork, NetworkSlice and NetworkSliceSubnet the 3GPP provisioning management service producer can in addition perform allocate and deallocate operations. + +### 6.2.3 Communication protocols + +#### 6.2.3.1 NETCONF + +APPC allow the use of the NETCONF protocol towards the xNF. (As noted above, APPC does not officially have support for PNFs in ONAP R3). APPC and their Adapters utilize device YANG model and NETCONF APIs to make the required changes in the VNF state and configuration. APPC support the following operations which act directly upon the VNF. Most of these utilize the NETCONF interface. + +The Table below is an example mapping between APPC configuration management action and NETCONF commands. + +**Table 6.2.3.1.1: Example mapping table between APPC configuration management action and NETCONF commands** + +| Action | Description | VNF Action | NETCONF COMMANDs | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Audit | Compare active configuration against a configuration stored in ONAP's configuration store. | Retrieve running configuration and device state information. Get-config updates the config tree which can then be compared to the stored current config in the ONAP database. | get-config | +| Configure | Configures the target VNF or VNFC. | The <edit-config> operation loads all or part of a specified configuration data set to the specified target VNF. | edit-config, commit | +| ConfigModify | The ConfigModify LCM action affects only a subset of the total configuration data of a VNF. It can be used to change specific parameters across a number of separate instances for the same VnfcType without changing instance specific values of each. It can also be used to make successive changes to a number of parameters | The <edit-config> operation loads only a part of the full set of configuration parameters to the specified target configuration without | edit-config, commit | + +| | | | | +|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| | where those changes are considered cumulative. Thus each ConfigModify invocation leaves previous values untouched and only edits the parameters which are sent to ONAP. | changing any existing parameters. | | +| ConfigSave | Saves a VNF's running configuration into the configuration store in ONAP, for later retrieval. | (optional) If copy-config to a local file is supported by the VNFC this command is used to store the running config locally in order to save time on any subsequent Reconfigure. To support this action, the VNF must allow <copy-config> to save to a local file and must support subsequent retrieval of the copied configuration back to the running configuration. If this capability is not supported, ONAP will still function, but updates will take longer. | copy-config, delete-config | +| ConfigRestore | Reconfigure a VNF to some previously stored baseline configuration stored by a previous ConfigSetBaseline. | If a previous config has been saved locally use quick restore (<copy-config> from file). If the restore fails, fallback to a process of changing the configuration value by value using <edit-config>. | edit-config or copy-config | + +In 3GPP release 15, a YANG model of the 5G NRM is specified in TS 28.541. 3GPP SA5 has yet to decide if the required NETCONF solution should be introduced as Rel-16 new feature. + +#### 6.2.3.2 Other protocol options + +The Chef and Ansible protocols supported by ONAP controllers are primarily intended for LCM operations rather than CM operations. Furthermore, both protocols require the use of an open-source-based server external to ONAP. For these reasons, these protocols are not applicable to, or appropriate for, CM operations on the 5G NRM. + +### 6.2.4 Handling of configuration management notifications + +#### 6.2.4.1 3GPP configuration management notifications + +3GPP configuration management notifications (i.e. notifyMOICreation, notifyMOIDeletion and notifyMOIAttributesValueChange) are described in clauses 5.1.5, 5.1.6 and 5.1.7 of TS 28.532 [10]. + +#### 6.2.4.2 ONAP configuration notifications + +Currently, there is no existing domain field of the ONAP R3 VES JSON API that can be used to support or map to 3GPP configuration management notifications. + +#### 6.2.4.3 Potential solution for enabling ONAP DCAE VES JSON Collector to consume 3GPP configuration management notifications + +As a potential solution for enabling the DCAE VES JSON Collector to consume 3GPP configuration management notifications, 3GPP could collaborate with ONAP to add new possible values to the field 'domain' of ONAP VES JSON API: + +- Prov3GPP, corresponding to 3GPP provisioning notifications. + +The following new type of fields would thus be added to ONAP DCAE VES JSON API header fields: + +**Table 6.2.4.3-1: New domain 'Prov3GPPFields'** + +| Name | Required | Type | +|----------------|----------|----------------| +| Prov3GPPFields | No | Prov3GPPFields | + +whereProv3GPPFields could use input parameters definitions of provisioning related notifications defined in 3GPP TS 28.532 [10]. Following example illustrates the data type definition (described in clause 8.3.2.15 of TS 28.532 [10]) and JSON schema definition (described in Annex A.1) for notifyMOICreation-NotifyType, which is valid for Prov3GPPFields. + +**Table 6.2.4.3-2: Definition of type notifyMOICreation-NotifType (defined in clause 8.3.2.15 of TS 28.532 [10])** + +| Attribute name | Data type | Description | SQ | +|---------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------|----| +| header | | | | +| > href | uri-Type | URI of the resource where the event (alarm) occurred | M | +| > notificationId | notificationId-Type | Notification identifier as defined in ITU-T Rec. X. 733 [4] | M | +| > notificationType | notificationType-Type | Notification type (notifyMOICreation) | M | +| > eventTime | dateTime-Type | Event (MOI creation) occurrence time | M | +| > systemDN | systemDN-Type | System DN | M | +| body | | | | +| > correlatedNotifications | array(correlatedNotification-Type) | Set of all notifications to which this notification is considered to be correlated as defined in ITU-T Rec. X. 733 [4] | O | +| > additionalText | additionalText-Type | Allows a free form text description to be reported as defined in ITU-T Rec. X. 733 [4] | O | +| > sourceIndicator | sourceIndicator-Type | Indicates the source of the operation that led to the generation of this notification. | O | +| > attributeList | array(attributeNameValuePair-Type) | The attributes (name/value pairs) of the created MOI. | O | + +The JSON schema definition (defined in Annex A.1 of TS 28.532 [10]) for "notifyMOICreation-NotifType" is described as follows: + +``` + +"notifyMOICreation-NotifType": { + "type": "object", + "properties": { + "header": { + "$ref": "#/components/schemas/header-Type" + }, + "body": { + "type": "object", + "properties": { + "correlatedNotifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/correlatedNotification-Type" + } + }, + "additionalText": { + "$ref": "#/components/schemas/additionalText-Type" + }, + "sourceIndicator": { + "$ref": "#/components/schemas/sourceIndicator-Type" + }, + "attributeList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/attributeNameValuePair-Type" + } + } + } + } + } +} + +``` + +## 6.3 Conclusions on configuration management + +The clause 6 of the present document studies the positioning of ONAP Controllers with regard to 3GPP management services for configuration management purposes. It also analyzes configuration management mechanisms in both ONAP Controllers (APPC) and 3GPP provisioning management services, from following perspectives: + +- Configuration management: NETCONF protocol should be used for configuration management purposes. The Chef and Ansible protocols supported by ONAP controllers are primarily intended for LCM operations rather than CM operations and are not appropriate for configuration management on 5G network; +- Configuration management notification: is specified in 3GPP provisioning management services, but there is no existing domain field of the ONAP R3 VES JSON API that can be used to support or map to 3GPP configuration management notifications. One potential solution is enabling the DCAE R3 VES JSON Collector to consume 3GPP configuration management notifications. + +It is recommended to start normative work on configuration management on the following aspects: + +- Specifying NETCONF solution set support for configuration management purpose, +- Investigating potential solution for CM notification. + +# --- Annex <A>: Change history + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2017-12 | SA5#116 | S5-176534<br>S5-176535 | | | | Skeleton<br>Clause headers | 0.1.0 | +| 2018-01 | | | | | | Editorial fixes (MCC) | 0.1.1 | +| 2018-02 | SA5#117 | S5-181518<br><br>S5-181519 | | | | Positioning of ONAP/DCAE wrt. 3GPP reference management architecture<br>Communication principles for notifications | 0.2.0 | +| 2018-04 | SA5#118 | S5-182569 | | | | Handling of performance data collection | 0.3.0 | +| 2018-05 | SA5#119 | S5-183175<br>S5-183598 | | | | Re-introducing ONAP diagrams<br>Handling of alarm notifications | 0.4.0 | +| 2018-08 | SA5#120 | S5-185067<br>S5-185569<br>S5-185070<br>S5-185071<br>S5-185571<br>S5-185572<br><br>S5-185573<br>S5-185574<br>S5-185575<br>S5-185576<br>S5-185577 | | | | Restructuring the TR to include CM aspects<br>Update clause 5 with 5G network management principles<br>Update clause 6.2 with 5G network management principles<br>Update clause 6.3 with 5G network management principles<br>Update clause 6.4 with 5G network management principles<br>Potential positioning of ONAP/DCAE wrt. for 3GPP management service<br>Correct ONAP architecture overview<br>Scope input<br>Update list of abbreviations<br>Add comparison of used technologies<br>Potential positioning of APPC wrt. for 3GPP management services | 0.5.0 | +| 2018-10 | SA5#121 | S5-186494<br>S5-186479<br>S5-186438<br>S5-186148<br><br>S5-186440<br>S5-186441<br>S5-186442<br>S5-186443<br>S5-186444 | | | | pCR TR 28.900 No subscribe in ONAP<br>pCR TR 28.900 No PM job control in ONAP<br>pCR TR 28.900 FM-PM Data Reporting Methods<br>pCR TR 28.900 Correct the reference to configuration management related notifications<br>pCR 28.900 3GPP vs ONAP Interface technologies<br>pCR 28.900 Updated references<br>pCR 28.900 Updated architecture overview<br>pCR 28.900 ONAP DCAE VES Collector updates<br>pCR 28.900 Handling of alarm / event notifications | 0.6.0 | +| 2018-11 | SA5#122 | S5-187467<br><br>S5-187236<br>S5-187469<br><br>S5-187470<br><br>S5-187259<br>S5-187261<br>S5-187472<br><br>S5-187473<br>S5-187214<br>S5-187478<br>S5-187479 | | | | Add example of 3GPP MnS Provider using interfaces provided by ONAP DCAE<br>Example of a notification header<br>Option for mapping 3GPP 5G alarm notifications on ONAP VES JSON Collector API<br>Mapping 3GPP 5G PM data reporting on ONAP VES JSON Collector API<br>ONAP Heartbeat and Event Throttling<br>3GPP Fault Supervision operations<br>Add example of 3GPP MnS Provider using interfaces provided by ONAP VF-C<br>ONAP controllers and 3GPP provisioning service for CM purposes<br>Update References for CM purposes<br>Add description for positioning<br>Comparative analysis for CM purposes | 0.7.0 | +| 2018-12 | SA#82 | SP-181062 | | | | Presented for information | 1.0.0 | +| 2018-12 | SA#82 | | | | | EditHelp review | 1.0.1 | +| 2019-01 | SA#82 | | | | | Change of TR number (28.900 -> 28.890)<br>Change of TR title ("Telecommunication management; Study on integration of ONAP and 3GPP management for 5G networks" -> "Management and Orchestration; Study on integration of Open Network Automation Platform (ONAP) and 3GPP management for 5G networks") | 1.0.2 | +| 2019-01 | SA5#123 | S5-191486<br>S5-191436<br>S5-191125<br>S5-191433<br><br>S5-191434<br>S5-191129 | | | | Editorial and Minor Technical Corrections<br>Conclusions on FM and PM<br>Align the term MnS and MnF<br>Update clause 5.2.3.3 Reporting 3GPP Rel-15 PM data to DCAE R3 VES JSON Collector<br>Alarm Life Cycle management in ONAP<br>Replace 3GPP management system with 3GPP MnF | 1.1.0 | +| 2019-03 | SA5#124 | S5-192073<br>S5-192135<br>S5-192391<br>S5-192392<br>S5-192393<br>S5-192394<br>S5-192395<br>S5-192443 | | | | Heartbeat and Communication Surveillance<br>Update clause 6.2.2 management principles<br>Add Handling of configuration notification<br>Minor Technical Corrections<br>Add the description of 3GPP provisioning management service<br>Add the description of SDNC<br>Configuration Management handling<br>Conclusion on CM | 1.2.0 | +| 2019-03 | SA#83 | SP-190136 | | | | Presented for approval | 2.0.0 | +| 2019-03 | SA#83 | | | | | Upgrade to change control version | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/36_series/36305/raw.md b/marked/Rel-16/36_series/36305/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e2bada1a18475803b9eedb3e041fdb23931bc0a0 --- /dev/null +++ b/marked/Rel-16/36_series/36305/raw.md @@ -0,0 +1,3784 @@ + + +# 3GPP TS 36.305 V16.5.0 (2023-06) --- + +*Technical Specification* + +## **3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Radio Access Network; Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Stage 2 functional specification of User Equipment (UE) positioning in E-UTRAN (Release 16)** --- + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, sans-serif font. The "3" and "G" are stylized and connected at the bottom by a red curved line. A small "TM" trademark symbol is located to the top right of the "P". + +3GPP logo + +## --- **Keywords** + +LTE, location, stage 2 + +## **3GPP** + +## --- **Postal address** + +### --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + +<http://www.3gpp.org> + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association +Bluetooth® is a Trade Mark of the Bluetooth SIG registered for the benefit of its members + +## Contents + +| | | +|-----------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Abbreviations ..... | 11 | +| 4 Main concepts and requirements..... | 12 | +| 4.1 Assumptions and Generalities..... | 12 | +| 4.2 Role of UE Positioning Methods ..... | 13 | +| 4.3 Standard UE Positioning Methods ..... | 14 | +| 4.3.1 Network-assisted GNSS Methods ..... | 15 | +| 4.3.2 Downlink positioning ..... | 15 | +| 4.3.3 Enhanced Cell ID Methods ..... | 15 | +| 4.3.4 Uplink positioning ..... | 16 | +| 4.3.5 Barometric pressure sensor positioning..... | 16 | +| 4.3.6 WLAN positioning ..... | 16 | +| 4.3.7 Bluetooth positioning ..... | 16 | +| 4.3.8 TBS positioning..... | 16 | +| 4.3.9 Motion sensor positioning ..... | 17 | +| 5 E-UTRAN UE Positioning Architecture..... | 17 | +| 5.1 UE Positioning Operations ..... | 17 | +| 5.2 E-UTRAN Positioning Operations..... | 19 | +| 5.2.1 Downlink Position Method Support..... | 19 | +| 5.2.2 Uplink Position Method Support..... | 19 | +| 5.2.3 Assistance Information Broadcast Support ..... | 19 | +| 5.3 Functional Description of Elements Related to UE Positioning in E-UTRAN ..... | 19 | +| 5.3.1 User Equipment (UE) ..... | 19 | +| 5.3.2 eNode B ..... | 20 | +| 5.3.3 Evolved Serving Mobile Location Centre (E-SMLC)..... | 20 | +| 5.3.4 Location Measurement Unit (LMU) ..... | 20 | +| 6 Signalling protocols and interfaces ..... | 21 | +| 6.1 Network interfaces supporting positioning operations..... | 21 | +| 6.1.1 General LCS control plane architecture ..... | 21 | +| 6.1.2 LTE-Uu interface..... | 21 | +| 6.1.3 S1-MME interface ..... | 21 | +| 6.1.4 SLs interface ..... | 21 | +| 6.1.5 SLm interface ..... | 21 | +| 6.2 UE-terminated protocols ..... | 21 | +| 6.2.1 LTE Positioning Protocol (LPP) ..... | 21 | +| 6.2.2 Radio Resource Control (RRC)..... | 22 | +| 6.3 eNB-terminated protocols ..... | 23 | +| 6.3.1 LTE Positioning Protocol Annex (LPPa) ..... | 23 | +| 6.3.2 S1 Application Protocol (S1-AP) ..... | 23 | +| 6.4 Signalling between an E-SMLC and UE..... | 23 | +| 6.4.1 Protocol Layering ..... | 23 | +| 6.4.2 LPP PDU Transfer..... | 23 | +| 6.5 Signalling between an E-SMLC and eNode B..... | 24 | +| 6.5.1 Protocol Layering ..... | 24 | +| 6.5.2 LPPa PDU Transfer for UE Positioning..... | 25 | +| 6.5.3 LPPa PDU Transfer for Positioning Support ..... | 26 | +| 6.5.4 LPPa PDU Transfer for Assistance Information Broadcast..... | 26 | +| 6.6 LMU-terminated protocols..... | 28 | +| 6.6.1 SLm Application Protocol (SLmAP) ..... | 28 | + +| | | | +|------------|----------------------------------------------------------------------|----| +| 6.7 | Signalling between an E-SMLC and LMU ..... | 28 | +| 6.7.1 | Protocol Layering ..... | 28 | +| 7 | General E-UTRAN UE Positioning procedures ..... | 28 | +| 7.1 | General LPP procedures for UE Positioning..... | 28 | +| 7.1.1 | LPP Procedures ..... | 28 | +| 7.1.2 | Positioning procedures ..... | 29 | +| 7.1.2.1 | Capability transfer..... | 29 | +| 7.1.2.2 | Assistance data transfer ..... | 30 | +| 7.1.2.3 | Location information transfer ..... | 30 | +| 7.1.2.4 | Multiple transactions..... | 31 | +| 7.1.2.5 | Sequence of Procedures ..... | 32 | +| 7.1.2.6 | Error handling ..... | 32 | +| 7.1.2.7 | Abort ..... | 33 | +| 7.1.3 | UE positioning measurements in idle state for NB-IoT ..... | 33 | +| 7.2 | General LPPa Procedures for UE Positioning..... | 35 | +| 7.2.1 | LPPa Procedures..... | 35 | +| 7.2.2 | LPPa transaction types ..... | 35 | +| 7.2.2.1 | Location information transfer ..... | 35 | +| 7.3 | Service Layer Support using combined LPP and LPPa Procedures ..... | 36 | +| 7.3.1 | NI-LR and MT-LR Service Support..... | 36 | +| 7.3.2 | MO-LR Service Support..... | 37 | +| 7.4 | General SLmAP Procedures for UE Positioning ..... | 38 | +| 7.4.1 | SLmAP Procedures ..... | 38 | +| 7.4.1.1 | Measurement request ..... | 38 | +| 7.4.1.2 | Measurement Update ..... | 38 | +| 7.4.1.3 | Measurement Abort ..... | 39 | +| 7.5 | Service Layer Support using combined SLmAP and LPPa Procedures ..... | 40 | +| 7.5.1 | NI-LR and MT-LR Service Support..... | 40 | +| 7.5.2 | MO-LR Service Support..... | 40 | +| 7.6 | Procedures for Broadcast of Assistance Data ..... | 41 | +| 7.6.1 | General ..... | 41 | +| 7.6.2 | Broadcast Procedures ..... | 41 | +| 8 | Positioning methods and Supporting Procedures..... | 43 | +| 8.1 | GNSS positioning methods ..... | 43 | +| 8.1.1 | General ..... | 43 | +| 8.1.2 | Information to be transferred between E-UTRAN Elements ..... | 44 | +| 8.1.2.1 | Information that may be transferred from the E-SMLC to UE..... | 44 | +| 8.1.2.1.1 | Reference Time ..... | 45 | +| 8.1.2.1.2 | Reference Location ..... | 45 | +| 8.1.2.1.3 | Ionospheric Models..... | 45 | +| 8.1.2.1.4 | Earth Orientation Parameters ..... | 45 | +| 8.1.2.1.5 | GNSS-GNSS Time Offsets ..... | 46 | +| 8.1.2.1.6 | Differential GNSS Corrections ..... | 46 | +| 8.1.2.1.7 | Ephemeris and Clock Models ..... | 46 | +| 8.1.2.1.8 | Real-Time Integrity ..... | 46 | +| 8.1.2.1.9 | Data Bit Assistance ..... | 46 | +| 8.1.2.1.10 | Acquisition Assistance ..... | 46 | +| 8.1.2.1.11 | Almanac ..... | 46 | +| 8.1.2.1.12 | UTC Models..... | 46 | +| 8.1.2.1.13 | RTK Reference Station Information ..... | 46 | +| 8.1.2.1.14 | RTK Auxiliary Station Data..... | 47 | +| 8.1.2.1.15 | RTK Observations..... | 47 | +| 8.1.2.1.16 | RTK Common Observation Information ..... | 47 | +| 8.1.2.1.17 | GLONASS RTK Bias Information ..... | 47 | +| 8.1.2.1.18 | RTK MAC Correction Differences..... | 47 | +| 8.1.2.1.19 | RTK Residuals ..... | 47 | +| 8.1.2.1.20 | RTK FKP Gradients ..... | 48 | +| 8.1.2.1.21 | SSR Orbit Corrections..... | 48 | +| 8.1.2.1.22 | SSR Clock Corrections..... | 48 | +| 8.1.2.1.23 | SSR Code Bias ..... | 48 | + +| | | | +|-------------|-----------------------------------------------------------------------------------------------|----| +| 8.1.2.1.24 | SSR Phase Bias ..... | 48 | +| 8.1.2.1.25 | SSR STEC Corrections ..... | 48 | +| 8.1.2.1.26 | SSR Gridded Correction..... | 49 | +| 8.1.2.1.27 | SSR URA ..... | 49 | +| 8.1.2.1.28 | SSR Correction Points..... | 49 | +| 8.1.2.1a | Recommendations for grouping of assistance data to support different RTK service levels ..... | 49 | +| 8.1.2.2 | Information that may be transferred from the UE to the E-SMLC..... | 51 | +| 8.1.2.2.1 | GNSS Measurement Information..... | 52 | +| 8.1.2.2.1.1 | UE-based mode ..... | 52 | +| 8.1.2.2.1.2 | UE-assisted mode ..... | 52 | +| 8.1.2.2.2 | Additional Non-GNSS Related Information ..... | 52 | +| 8.1.3 | Assisted-GNSS Positioning Procedures ..... | 53 | +| 8.1.3.1 | Capability Transfer Procedure ..... | 53 | +| 8.1.3.1.1 | Void..... | 53 | +| 8.1.3.2 | Assistance Data Transfer Procedure ..... | 53 | +| 8.1.3.2.1 | E-SMLC initiated Assistance Data Delivery ..... | 53 | +| 8.1.3.2.1a | E-SMLC initiated Periodic Assistance Data Delivery ..... | 53 | +| 8.1.3.2.2 | UE initiated Assistance Data Transfer ..... | 54 | +| 8.1.3.2.2a | UE initiated Periodic Assistance Data Transfer..... | 55 | +| 8.1.3.3 | Location Information Transfer Procedure ..... | 56 | +| 8.1.3.3.1 | E-SMLC initiated Location Information Transfer Procedure ..... | 56 | +| 8.1.3.3.2 | UE-initiated Location Information Delivery Procedure..... | 56 | +| 8.2 | Downlink positioning method..... | 57 | +| 8.2.1 | General ..... | 57 | +| 8.2.2 | Transferred information..... | 57 | +| 8.2.2.1 | Assistance Data that may be transferred from the E-SMLC to UE..... | 57 | +| 8.2.2.2 | Assistance Data that may be transferred from the eNodeB to E-SMLC ..... | 57 | +| 8.2.2.3 | Location Information that may be transferred from the UE to E-SMLC ..... | 58 | +| 8.2.3 | Downlink Positioning Procedures ..... | 58 | +| 8.2.3.1 | Capability Transfer Procedure ..... | 58 | +| 8.2.3.1.1 | Void..... | 58 | +| 8.2.3.2 | Assistance Data Transfer Procedure ..... | 58 | +| 8.2.3.2.1 | Assistance Data Transfer between E-SMLC and UE..... | 58 | +| 8.2.3.2.1.1 | E-SMLC-initiated assistance data delivery ..... | 58 | +| 8.2.3.2.1.2 | UE-initiated assistance data transfer ..... | 59 | +| 8.2.3.2.2 | Assistance Data Delivery between E-SMLC and eNodeB ..... | 59 | +| 8.2.3.2.2.1 | Void..... | 59 | +| 8.2.3.2.2.2 | E-SMLC-initiated assistance data delivery to the E-SMLC ..... | 59 | +| 8.2.3.3 | Location Information Transfer Procedure ..... | 60 | +| 8.2.3.3.1 | E-SMLC-initiated Location Information Transfer ..... | 60 | +| 8.2.3.3.2 | UE-initiated Location Information Delivery procedure..... | 60 | +| 8.3 | Enhanced cell ID positioning methods..... | 61 | +| 8.3.1 | General ..... | 61 | +| 8.3.2 | Information to be transferred between E-UTRAN Elements ..... | 61 | +| 8.3.2.1 | Information that may be transferred from the E-SMLC to UE..... | 61 | +| 8.3.2.2 | Information that may be transferred from the UE to E-SMLC..... | 62 | +| 8.3.2.3 | Information that may be transferred from the eNodeB to E-SMLC..... | 62 | +| 8.3.3 | Downlink E-CID Positioning Procedures ..... | 62 | +| 8.3.3.1 | Capability Transfer Procedure ..... | 62 | +| 8.3.3.1.1 | Void..... | 63 | +| 8.3.3.2 | Assistance Data Delivery Procedure..... | 63 | +| 8.3.3.3 | Location Information Transfer Procedure ..... | 63 | +| 8.3.3.3.1 | E-SMLC-initiated Location Information Transfer ..... | 63 | +| 8.3.3.3.2 | UE-initiated Location Information Delivery procedure..... | 63 | +| 8.3.4 | Uplink E-CID Positioning Procedures ..... | 64 | +| 8.3.4.1 | Position Capability Transfer Procedure ..... | 64 | +| 8.3.4.2 | Assistance Data Delivery Procedure..... | 64 | +| 8.3.4.3 | Position Measurement Procedure ..... | 64 | +| 8.3.4.3.1 | E-SMLC-initiated Position Measurement..... | 64 | +| 8.4 | Downlink Supporting Procedures ..... | 65 | +| 8.4.1 | General ..... | 65 | +| 8.4.2 | Location Related Information..... | 65 | + +| | | | +|-----------|--------------------------------------------------------------------------------|----| +| 8.4.3 | Location Related Information Acquisition Procedure..... | 66 | +| 8.4.3.1 | On Demand Procedure ..... | 66 | +| 8.4.3.2 | Triggered Procedure..... | 66 | +| 8.5 | Uplink positioning method..... | 67 | +| 8.5.1 | General ..... | 67 | +| 8.5.2 | Transferred information..... | 67 | +| 8.5.2.1 | Configuration Data that may be transferred from the eNodeB to the E-SMLC ..... | 67 | +| 8.5.2.2 | Configuration Data that may be transferred from the E-SMLC to LMU ..... | 68 | +| 8.5.2.3 | Location Information that may be transferred from the LMU to E-SMLC..... | 69 | +| 8.5.3 | Uplink Positioning Procedures ..... | 69 | +| 8.5.3.1 | Uplink Information Request and Delivery Procedure ..... | 69 | +| 8.5.3.2 | Uplink Positioning Information Update Procedure ..... | 70 | +| 8.6 | Barometric pressure sensor positioning methods..... | 70 | +| 8.6.1 | General ..... | 70 | +| 8.6.2 | Information to be transferred between E-UTRAN Elements ..... | 71 | +| 8.6.2.1 | Information that may be transferred from the UE to E-SMLC..... | 71 | +| 8.6.2.1.1 | Standalone mode ..... | 71 | +| 8.6.2.1.2 | UE-assisted mode..... | 71 | +| 8.6.2.1.3 | UE-based mode ..... | 71 | +| 8.6.2.2 | Information that may be transferred from the E-SMLC to UE..... | 71 | +| 8.6.2.2.1 | Barometric pressure sensor assistance data..... | 72 | +| 8.6.3 | Barometric Pressure Sensor Location Information Transfer Procedures ..... | 72 | +| 8.6.3.1 | E-SMLC initiated Location Information Transfer Procedure..... | 72 | +| 8.6.3.2 | UE-initiated Location Information Delivery Procedure ..... | 72 | +| 8.6.3.3 | Assistance Data Transfer Procedure..... | 73 | +| 8.6.3.3.1 | E-SMLC initiated Assistance Data Delivery ..... | 73 | +| 8.6.3.3.2 | UE initiated Assistance Data Transfer ..... | 73 | +| 8.7 | WLAN positioning methods ..... | 74 | +| 8.7.1 | General ..... | 74 | +| 8.7.2 | Information to be transferred between E-UTRAN Elements ..... | 74 | +| 8.7.2.1 | Information that may be transferred from the UE to E-SMLC..... | 74 | +| 8.7.2.1.1 | Standalone mode ..... | 75 | +| 8.7.2.1.2 | UE-assisted mode..... | 75 | +| 8.7.2.1.3 | UE-based mode ..... | 75 | +| 8.7.2.2 | Information that may be transferred from the E-SMLC to UE..... | 75 | +| 8.7.2.2.1 | WLAN AP BSSID ..... | 76 | +| 8.7.2.2.2 | WLAN AP SSID ..... | 76 | +| 8.7.2.2.3 | WLAN AP Type Data..... | 76 | +| 8.7.2.2.4 | WLAN AP Location..... | 76 | +| 8.7.3 | WLAN Positioning Procedures ..... | 76 | +| 8.7.3.1 | Location Information Transfer Procedure ..... | 76 | +| 8.7.3.1.1 | E-SMLC initiated Location Information Transfer Procedure ..... | 76 | +| 8.7.3.1.2 | UE-initiated Location Information Delivery Procedure..... | 77 | +| 8.7.3.2 | Assistance Data Transfer Procedure ..... | 77 | +| 8.7.3.2.1 | UE initiated Assistance Data Transfer ..... | 77 | +| 8.8 | Bluetooth positioning methods..... | 78 | +| 8.8.1 | General ..... | 78 | +| 8.8.2 | Information to be transferred between E-UTRAN Elements ..... | 78 | +| 8.8.2.1 | Information that may be transferred from the UE to E-SMLC..... | 78 | +| 8.8.2.1.1 | Standalone mode ..... | 78 | +| 8.8.2.1.2 | UE-assisted mode..... | 78 | +| 8.8.3 | Bluetooth Positioning Procedures ..... | 79 | +| 8.8.3.1 | Location Information Transfer Procedure ..... | 79 | +| 8.8.3.1.1 | E-SMLC initiated Location Information Transfer Procedure ..... | 79 | +| 8.8.3.1.2 | UE-initiated Location Information Delivery Procedure..... | 79 | +| 8.9 | TBS positioning methods..... | 80 | +| 8.9.1 | General ..... | 80 | +| 8.9.2 | Information to be transferred between E-UTRAN Elements ..... | 80 | +| 8.9.2.1 | Information that may be transferred from the UE to E-SMLC..... | 80 | +| 8.9.2.1.1 | Standalone mode ..... | 80 | +| 8.9.2.1.2 | UE-assisted mode..... | 80 | +| 8.9.2.1.3 | UE-based mode ..... | 81 | + +| | | | +|----------------------------------------------------------|--------------------------------------------------------------------|-----------| +| 8.9.2.2 | Information that may be transferred from the E-SMLC to UE..... | 81 | +| 8.9.2.2.1 | Acquisition Assistance ..... | 81 | +| 8.9.2.2.2 | Almanac ..... | 81 | +| 8.9.3 | TBS Positioning Procedures..... | 81 | +| 8.9.3.1 | Location Information Transfer Procedure ..... | 81 | +| 8.9.3.1.1 | E-SMLC initiated Location Information Transfer Procedure ..... | 81 | +| 8.9.3.1.2 | UE-initiated Location Information Delivery Procedure..... | 82 | +| 8.9.3.2 | Assistance Data Transfer Procedure ..... | 82 | +| 8.9.3.2.1 | E-SMLC initiated Assistance Data Delivery ..... | 82 | +| 8.9.3.2.2 | UE initiated Assistance Data Transfer ..... | 83 | +| 8.10 | Motion sensor positioning method..... | 83 | +| 8.10.1 | General ..... | 83 | +| 8.10.2 | Information to be transferred between E-UTRAN Elements ..... | 84 | +| 8.10.2.1 | Information that may be transferred from the UE to E-SMLC..... | 84 | +| 8.10.2.1.1 | UE-assisted, UE-based, Standalone mode ..... | 84 | +| 8.10.2.1.2 | UE Displacement and Movement Information ..... | 84 | +| 8.10.2.2 | Information that may be transferred from the E-SMLC to the UE..... | 84 | +| 8.10.3 | Motion Sensors Location Information Transfer Procedure ..... | 84 | +| 8.10.3.1 | E-SMLC initiated Location Information Transfer Procedure..... | 84 | +| 8.10.3.2 | UE-initiated Location Information Delivery Procedure ..... | 85 | +| <b>Annex A (informative): Definitions and Terms.....</b> | | <b>86</b> | +| <b>Annex B (informative): Use of LPP with SUPL .....</b> | | <b>87</b> | +| B.1 | SUPL 2.0 Positioning Methods and Positioning Protocols..... | 87 | +| B.2 | SUPL 2.0 and LTE Architecture..... | 88 | +| B.3 | LPP session procedures using SUPL ..... | 89 | +| B.4 | Procedures combining C-plane and U-plane operations..... | 90 | +| <b>Annex C (informative): Change history.....</b> | | <b>92</b> | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the stage 2 of the UE Positioning function of E-UTRAN, which provides the mechanisms to support or assist the calculation of the geographical position of a UE. UE position knowledge can be used, for example, in support of Radio Resource Management functions, as well as location-based services for operators, subscribers, and third-party service providers. The purpose of this stage 2 specification is to define the E-UTRAN UE Positioning architecture, functional entities and operations to support positioning methods. This description is confined to the E-UTRAN Access Stratum. It does not define or describe how the results of the UE position calculation can be utilised in the Core Network (e.g., LCS) or in E-UTRAN (e.g., RRM). + +UE Positioning may be considered as a network-provided enabling technology consisting of standardised service capabilities that enable the provision of location applications. The application(s) may be service provider specific. The description of the numerous and varied possible location applications which are enabled by this technology is outside the scope of the present document. However, clarifying examples of how the functionality being described may be used to provide specific location services may be included. + +This stage 2 specification covers the E-UTRAN positioning methods, state descriptions, and message flows to support UE Positioning. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.271: "Functional stage 2 description of Location Services (LCS)" +- [3] 3GPP TS 22.071: "Location Services (LCS); Service description, Stage 1". +- [4] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [5] 3GPP TS 36.306: "Evolved Universal Terrestrial Radio Access (E-UTRA); "User Equipment (UE) radio access capabilities". +- [6] IS-GPS-200, Revision D, Navstar GPS Space Segment/Navigation User Interfaces, March 7<sup>th</sup>, 2006. +- [7] IS-GPS-705, Navstar GPS Space Segment/User Segment L5 Interfaces, September 22, 2005. +- [8] IS-GPS-800, Navstar GPS Space Segment/User Segment L1C Interfaces, September 4, 2008. +- [9] Galileo OS Signal in Space ICD (OS SIS ICD), Draft 0, Galileo Joint Undertaking, May 23<sup>rd</sup>, 2006. +- [10] Global Navigation Satellite System GLONASS Interface Control Document, Version 5, 2002. +- [11] IS-QZSS, Quasi Zenith Satellite System Navigation Service Interface Specifications for QZSS, Ver.1.0, June 17, 2008. +- [12] Specification for the Wide Area Augmentation System (WAAS), US Department of Transportation, Federal Aviation Administration, DTFA01-96-C-00025, 2001. + +- [13] RTCM 10402.3, RTCM Recommended Standards for Differential GNSS Service (v.2.3), August 20, 2001. +- [14] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); "Radio Resource Control (RRC); Protocol specification". +- [15] 3GPP TS 25.331: " Radio Resource Control (RRC); Protocol Specification". +- [16] 3GPP TS 44.031: "Location Services (LCS); Mobile Station (MS) - Serving Mobile Location Centre (SMLC) Radio Resource LCS Protocol (RRLP)". +- [17] OMA-AD-SUPL-V2\_0: "Secure User Plane Location Architecture Approved Version 2.0". +- [18] OMA-TS-ULP-V2\_0\_6: "UserPlane Location Protocol Approved Version 2.0.6". +- [19] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [20] 3GPP TS 36.214: "Evolved Universal Terrestrial Radio Access (E-UTRA); "Physical layer – Measurements". +- [21] 3GPP TS 36.302: "Evolved Universal Terrestrial Radio Access (E-UTRA); "Services provided by the physical layer ". +- [22] 3GPP TS 25.305: "Stage 2 functional specification of User Equipment (UE) positioning in UTRAN". +- [23] 3GPP TS 43.059: "Functional stage 2 description of Location Services in GERAN". +- [24] 3GPP TR 23.891: "Evaluation of LCS Control Plane Solutions for EPS". +- [25] 3GPP TS 36.355: "Evolved Universal Terrestrial Radio Access (E-UTRA); LTE Positioning Protocol (LPP)". +- [26] 3GPP TS 24.171: "Control Plane Location Services (LCS) procedures in the Evolved Packet System (EPS)". +- [27] 3GPP TS 29.171: "Location Services (LCS); LCS Application Protocol (LCS-AP) between the Mobile Management Entity (MME) and Evolved Serving Mobile Location Centre (E-SMLC); SLs interface". +- [28] BDS-SIS-ICD-B1I-3.0: "BeiDou Navigation Satellite System Signal In Space Interface Control Document Open Service Signal B1I (Version 3.0)", February, 2019. +- [29] IEEE 802.11: "Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [30] Bluetooth Special Interest Group: "Bluetooth Core Specification v4.2", December 2014. +- [31] ATIS-0500027: "Recommendations for Establishing Wide Scale Indoor Location Performance", May 2015. +- [32] 3GPP TS 36.211: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical channels and modulation". +- [33] RTCM 10403.3, RTCM Recommended Standards for Differential GNSS Services (v.3.3), October 7, 2016. +- [34] BDS-SIS-ICD-B1C-1.0: "BeiDou Navigation Satellite System Signal In Space Interface Control Document Open Service Signal B1C (Version 1.0)", December, 2017. +- [35] IRNSS Signal-In-Space (SPS) Interface Control Document (ICD) for standard positioning service version 1.1, August 2017. +- [36] IS-QZSS-L6-001, Quasi-Zenith Satellite System Interface Specification – Centimetre Level Augmentation Service, Cabinet Office, November 5, 2018. + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] apply. + +As used in this document, the suffixes "-based" and "-assisted" refer respectively to the node that is responsible for making the positioning calculation (and which may also provide measurements) and a node that provides measurements (but which does not make the positioning calculation). Thus, an operation in which measurements are provided by the UE to the E-SMLC to be used in the computation of a position estimate is described as "UE-assisted" (and could also be called "E-SMLC-based"), while one in which the UE computes its own position is described as "UE-based". + +Both standalone LMU and LMU integrated into an eNB are supported. As used in this document, LMU refers to both cases of a standalone LMU and an LMU integrated into an eNodeB unless explicitly mentioned otherwise. + +**State Space Representation (SSR):** The state space representation provides information on the status of individual GNSS error sources. State parameter values are transmitted to UE. The user corrects his own observations of a single GNSS receiver with SSR corrections computed from these state parameters for his individual position, and performs RTK positioning with corrected observations. This contrasts with Observation Space Representation (OSR) which uses a lump-sum of distance-dependent GNSS errors instead of individual GNSS error sources. For OSR the representation of RTK network corrections in the observation space always uses GNSS observation of an actual reference station, which are then applied by the user to the conventional RTK algorithm. + +**Transmission Point (TP):** A set of geographically co-located transmit antennas for one cell, part of one cell or one PRS-only TP. Transmission Points can include base station (eNode B) antennas, remote radio heads, a remote antenna of a base station, an antenna of a PRS-only TP, etc. One cell can be formed by one or multiple transmission points. For a homogeneous deployment, each transmission point may correspond to one cell. + +**PRS-only TP:** A TP which only transmits PRS signals for PRS-based TBS positioning and is not associated with a cell. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply. + +| | | +|---------|----------------------------------------------------------------------------------------------| +| ADR | Accumulated Delta Range | +| AoA | Angle of Arrival | +| AP | Access Point | +| ARP | Antenna Reference Point | +| BDS | BeiDou Navigation Satellite System | +| BSSID | Basic Service Set Identifier | +| CID | Cell-ID (positioning method) | +| CIoT | Cellular IoT | +| CLAS | Centimeter Level Augmentation Service | +| E-SMLC | Enhanced Serving Mobile Location Centre | +| E-CID | Enhanced Cell-ID (positioning method) | +| ECEF | Earth-Centered, Earth-Fixed | +| ECI | Earth-Centered-Inertial | +| EGNOS | European Geostationary Navigation Overlay Service | +| E-UTRAN | Evolved Universal Terrestrial Radio Access Network | +| FDMA | Frequency Division Multiple Access | +| FKP | Flächenkorrekturparameter (Engl.: Area Correction Parameters) | +| GAGAN | GPS Aided Geo Augmented Navigation | +| GLONASS | Global'naya NAVigatsionnaya Sputnikovaya Sistema (Engl.: Global Navigation Satellite System) | +| GMLC | Gateway Mobile Location Center | +| GNSS | Global Navigation Satellite System | +| GPS | Global Positioning System | +| GRS80 | Geodetic Reference System 1980 | +| HESSID | Homogeneous Extended Service Set Identifier | +| IoT | Internet of Things | +| LCS | LoCation Services | + +| | | +|------------------|-------------------------------------------------| +| LCS-AP | LCS Application Protocol | +| LMU | Location Measurement Unit | +| LPP | LTE Positioning Protocol | +| LPPa | LTE Positioning Protocol Annex | +| MAC | Master Auxiliary Concept | +| MBS | Metropolitan Beacon System | +| MO-LR | Mobile Originated Location Request | +| MT-LR | Mobile Terminated Location Request | +| NavIC | NAVigation with Indian Constellation | +| NB-IoT | NarrowBand Internet of Things | +| NI-LR | Network Induced Location Request | +| N-RTK | Network – Real-Time Kinematic | +| OTDOA | Observed Time Difference Of Arrival | +| PDU | Protocol Data Unit | +| posSIB | Positioning SIB | +| PPP | Precise Point Positioning | +| PPP-RTK | Precise Point Positioning – Real-Time Kinematic | +| PRS | Positioning Reference Signal | +| QZSS | Quasi-Zenith Satellite System | +| RRM | Radio Resource Management | +| RSSI | Received Signal Strength Indicator | +| RTK | Real-Time Kinematic | +| SBAS | Space Based Augmentation System | +| SET | SUPL Enabled Terminal | +| SIB | System Information Block | +| SLP | SUPL Location Platform | +| SSID | Service Set Identifier | +| SSR | State Space Representation | +| STEC | Slant TEC | +| SUPL | Secure User Plane Location | +| T <sub>ADV</sub> | Timing Advance | +| TBS | Terrestrial Beacon System | +| TEC | Total Electron Content | +| TP | Transmission Point | +| UE | User Equipment | +| URA | User Range Accuracy | +| UTDOA | Uplink Time Difference of Arrival | +| WAAS | Wide Area Augmentation System | +| WGS-84 | World Geodetic System 1984 | +| WLAN | Wireless Local Area Network | + +# --- 4 Main concepts and requirements + +## 4.1 Assumptions and Generalities + +The stage 1 description of LCS at the service level is provided in TS 22.071 [3]; the stage 2 LCS functional description, including the LCS system architecture and message flows, is provided in TS 23.271 [2]. + +Positioning functionality provides a means to determine the geographic position and/or velocity of the UE based on measuring radio signals. The position information may be requested by and reported to a client (e.g., an application) associated with the UE, or by a client within or attached to the core network. The position information shall be reported in standard formats, such as those for cell-based or geographical co-ordinates, together with the estimated errors (uncertainty) of the position and velocity of the UE and, if available, the positioning method (or the list of the methods) used to obtain the position estimate. + +Restrictions on the geographic shape encoded within the 'position information' parameter may exist for certain LCS client types. The EPS, including E-UTRAN, shall comply with any shape restrictions defined in LTE and, in a particular country, with any shape restrictions defined for a specific LCS client type in relevant national standards. For example, in the US, national standard J-STD-036-B restricts the geographic shape for an emergency services LCS client + +to minimally either an "ellipsoid point" or an "ellipsoid point with uncertainty circle and confidence" as defined in TS 23.032 [4]. + +It shall be possible for the majority of the UEs (active or inactive) within a network to use the LCS feature without compromising the radio transmission or signalling capabilities of the E-UTRAN. + +The uncertainty of the position measurement shall be network-implementation-dependent, at the choice of the network operator. The uncertainty may vary between networks as well as from one area within a network to another. The uncertainty may be hundreds of metres in some areas and only a few metres in others. In the event that a particular position measurement is provided through a UE-assisted process, the uncertainty may also depend on the capabilities of the UE. In some jurisdictions, there is a regulatory requirement for location service accuracy that is part of an emergency service. Further details of the accuracy requirements can be found in TS 22.071 [3]. + +The uncertainty of the position information is dependent on the method used, the position of the UE within the coverage area and the activity of the UE. Several design options of the E-UTRAN system (e.g., size of cell, adaptive antenna technique, pathloss estimation, timing accuracy, eNode B surveys) shall allow the network operator to choose a suitable and cost-effective UE positioning method for their market. + +There are many different possible uses for the positioning information. The positioning functions may be used internally by the EPS, by value-added network services, by the UE itself or through the network, and by "third party" services. The feature may also be used by an emergency service (which may be mandated or "value-added"), but the location service is not exclusively for emergencies. + +The E-UTRAN is a new radio system design without a pre-existing deployment of "legacy" UEs operating according to the radio interface. This freedom from legacy equipment enables the location service feature design to make use of appropriate techniques to provide the most accurate results. The technique must also be a cost-effective total solution, must allow evolution to meet evolving service requirements, and must be able to take advantage of advances in technology over the lifetime of E-UTRAN deployments. + +Design of the E-UTRAN positioning capability as documented in this specification includes position methods, protocols and procedures that are either adapted from capabilities already supported for UTRAN and GERAN, or created separately from first principles. The proportion of the latter is higher than if the UTRAN and GERAN capabilities had been designed to provide forward compatibility to other access types. In contrast to GERAN and UTRAN, the E-UTRAN positioning capabilities are intended to be forward compatible to other access types and other position methods, in an effort to reduce the amount of additional positioning support needed in the future. This goal also extends to user plane location solutions such as OMA SUPL ([17], [18]), for which E-UTRAN positioning capabilities are intended to be compatible where appropriate. + +As a basis for the operation of UE Positioning in E-UTRAN, the following assumptions apply: + +- both TDD and FDD will be supported; +- the provision of the UE Positioning function in E-UTRAN and EPC is optional through support of the specified method(s) in the eNode B and the E-SMLC; +- UE Positioning is applicable to any target UE, whether or not the UE supports LCS, but with restrictions on the use of certain positioning methods depending on UE capability (as defined within the LPP protocol); +- the positioning information may be used for internal system operations to improve system performance; +- the UE Positioning architecture and functions shall include the option to accommodate several techniques of measurement and processing to ensure evolution to follow changing service requirements and to take advantage of advancing technology; +- LMU aspects are left for implementation and are not standardized in this release. + +## 4.2 Role of UE Positioning Methods + +The E-UTRAN may utilise one or more positioning methods in order to determine the position of an UE. + +Positioning the UE involves two main steps: + +- signal measurements; and + +- Position estimate and optional velocity computation based on the measurements. + +The signal measurements may be made by the UE or the eNode B. The basic signals measured for terrestrial position methods are typically the E-UTRA radio transmissions; however, other methods may make use of other transmissions such as general radio navigation signals including those from Global Navigation Satellites Systems (GNSSs). + +The positioning function should not be limited to a single method or measurement. That is, it should be capable of utilising other standard methods and measurements, as such methods and measurements are available and appropriate, to meet the required service needs of the location service client. This additional information could consist of readily available E-UTRAN measurements. + +The position estimate computation may be made by the UE or by the E-SMLC. + +## 4.3 Standard UE Positioning Methods + +The standard positioning methods supported for E-UTRAN access are: + +- network-assisted GNSS methods; +- downlink positioning; +- enhanced cell ID method; +- uplink positioning; +- WLAN method; +- Bluetooth method; +- Terrestrial Beacon System method; +- Sensor based methods: + - Barometric Pressure Sensor; + - Motion sensor. + +Hybrid positioning using multiple methods from the list of positioning methods above is also supported. + +Standalone mode (e.g. autonomous, without network assistance) using one or more methods from the list of positioning methods above is also supported. + +These positioning methods may be supported in UE-based, UE-assisted/E-SMLC-based, eNB-assisted, and LMU-assisted/E-SMLC-based versions. Table 4.3-1 indicates which of these versions are supported in this version of the specification for the standardised positioning methods. + +**Table 4.3-1: Supported versions of UE positioning methods** + +| Method | UE-based | UE-assisted, E-SMLC-based | eNB-assisted | LMU-assisted/ E-SMLC-based | SUPL <sup>Note 3</sup> | +|---------------------------------------------------------------------------------------------|----------|---------------------------|--------------|----------------------------|--------------------------------| +| A-GNSS | Yes | Yes | No | No | Yes (UE-based and UE-assisted) | +| Downlink <sup>Note 1</sup> | No | Yes | No | No | Yes (UE-assisted) | +| E-CID | No | Yes | Yes | No | Yes (UE-assisted) | +| Uplink | No | No | No | Yes | No | +| Sensor | Yes | Yes | No | No | No | +| WLAN | Yes | Yes | No | No | Yes | +| Bluetooth | No | Yes | No | No | No | +| TBS <sup>Note 2</sup> | Yes | Yes | No | No | Yes (MBS) | +| NOTE 1: This includes TBS positioning based on PRS signals. | | | | | | +| NOTE 2: In this version of the specification only for TBS positioning based on MBS signals. | | | | | | +| NOTE 3: This shows whether the positioning method is supported by SUPL ULP [18]. | | | | | | + +Sensor, WLAN, Bluetooth, and TBS positioning methods based on MBS signals are also supported in standalone mode, as described in the corresponding clauses. + +### 4.3.1 Network-assisted GNSS Methods + +These methods make use of UEs that are equipped with radio receivers capable of receiving GNSS signals. In 3GPP specifications the term GNSS encompasses both global and regional/augmentation navigation satellite systems. + +Examples of global navigation satellite systems include GPS, Modernized GPS, Galileo, GLONASS, and BeiDou Navigation Satellite System (BDS). Regional navigation satellite systems include Quasi Zenith Satellite System (QZSS), and NAVigation with Indian Constellation (NavIC), while the many augmentation systems, listed in 8.1.1, are classified under the generic term of Space Based Augmentation Systems (SBAS) and provide regional augmentation services. + +In this concept, different GNSSs (e.g. GPS, Galileo, etc.) can be used separately or in combination to determine the location of a UE. + +The operation of the network-assisted GNSS methods is described in clause 8.1. + +### 4.3.2 Downlink positioning + +The downlink (OTDOA) positioning method makes use of the measured timing of downlink signals received from multiple TPs at the UE. The UE measures the timing of the received signals using assistance data received from the positioning server, and the resulting measurements are used to locate the UE in relation to the neighbouring TPs. + +The operation of the downlink positioning method is described in clause 8.2. + +### 4.3.3 Enhanced Cell ID Methods + +In the Cell ID (CID) positioning method, the position of an UE is estimated with the knowledge of its serving eNode B and cell. The information about the serving eNode B and cell may be obtained by paging, tracking area update, or other methods. Enhanced Cell ID (E-CID) positioning refers to techniques which use additional UE and/or E-UTRAN radio resource and other measurements to improve the UE location estimate. + +Although E-CID positioning may utilise some of the same measurements as the measurement control system in the RRC protocol, the UE generally is not expected to make additional measurements for the sole purpose of positioning; i.e., the positioning procedures do not supply a measurement configuration or measurement control message, and the UE reports the measurements that it has available rather than being required to take additional measurement actions. For + +NB-IoT, when the UE goes to Idle state to perform positioning measurements, the UE may be required to take additional measurement actions, as specified in clause 7.1.3. + +In cases with a requirement for close time coupling between UE and eNode B measurements (e.g., TADV type 1 and UE Tx-Rx time difference), the eNode B configures the appropriate RRC measurements and is responsible for maintaining the required coupling between the measurements. The operation of the Enhanced Cell ID method is described in clause 8.3. + +### 4.3.4 Uplink positioning + +The uplink (e.g., UTDOA) positioning method makes use of the measured timing at multiple LMUs of uplink signals transmitted from UE. The LMU measures the timing of the received signals using assistance data received from the positioning server, and the resulting measurements are used to estimate the location of the UE. + +The operation of the Uplink positioning method is described in clause 8.5. + +### 4.3.5 Barometric pressure sensor positioning + +The barometric pressure sensor method makes use of barometric sensors to determine the vertical component of the position of the UE. The UE measures barometric pressure, optionally aided by assistance data, to calculate the vertical component of its location or to send measurements to the positioning server for position calculation. + +This method should be combined with other positioning methods to determine the 3D position of the UE. + +The operation of the Barometric pressure sensor positioning method is described in clause 8.6. + +### 4.3.6 WLAN positioning + +The WLAN positioning method makes use of the WLAN measurements (AP identifiers and optionally other measurements) and databases to determine the location of the UE. The UE measures received signals from WLAN [29] access points, optionally aided by assistance data, to send measurements to the positioning server for position calculation. Using the measurement results and a references database, the location of the UE is calculated. + +Alternatively, the UE makes use of WLAN measurements and optionally WLAN AP assistance data provided by the positioning server, to determine its location. + +The operation of the WLAN positioning method is described in clause 8.7. + +### 4.3.7 Bluetooth positioning + +The Bluetooth positioning method makes use of Bluetooth measurements (beacon identifiers and optionally other measurements) to determine the location of the UE. The UE measures received signals from Bluetooth [30] beacons. Using the measurement results and a references database, the location of the UE is calculated. The Bluetooth methods may be combined with other positioning methods (e.g. WLAN) to improve positioning accuracy of the UE. + +The operation of the Bluetooth positioning method is described in clause 8.8. + +### 4.3.8 TBS positioning + +A Terrestrial Beacon System (TBS) consists of a network of ground-based transmitters, broadcasting signals only for positioning purposes. The current type of TBS positioning signals are the MBS (Metropolitan Beacon System) signals [31] and Positioning Reference Signals (PRS) (TS 36.211 [32]). The UE measures received TBS signals, optionally aided by assistance data, to calculate its location or to send measurements to the positioning server for position calculation. + +The operation of the TBS positioning method based on MBS signals is described in clause 8.9. + +TBS positioning based on PRS signals is part of downlink (OTDOA) positioning and described in clause 8.2. + +### 4.3.9 Motion sensor positioning + +The motion sensor method makes use of different sensors such as accelerometers, gyros, magnetometers, to calculate the displacement of UE. The UE estimates a relative displacement based upon a reference position and/or reference time. UE sends a report comprising the determined relative displacement which can be used to determine the absolute position. + +This method should be used with other positioning methods for hybrid positioning. + +The operation of the sensor positioning method is described in clause 8.10. + +# 5 E-UTRAN UE Positioning Architecture + +Figure 5-1 shows the architecture in EPS applicable to positioning of a UE with E-UTRAN access. + +The MME receives a request for some location service associated with a particular target UE from another entity (e.g., GMLC or UE) or the MME itself decides to initiate some location service on behalf of a particular target UE (e.g., for an IMS emergency call from the UE) as described in TS 23.271 [2]. The MME then sends a location services request to an E-SMLC. The E-SMLC processes the location services request which may include transferring assistance data to the target UE to assist with UE-based and/or UE-assisted positioning and/or may include positioning of the target UE. For the Uplink method, the E-SMLC processes the location services request which includes transferring configuration data to the selected LMU(s). The E-SMLC then returns the result of the location service back to the MME (e.g., a position estimate for the UE and/or an indication of any assistance data transferred to the UE). In the case of a location service requested by an entity other than the MME (e.g., UE or E-SMLC), the MME returns the location service result to this entity. + +The SLP is the SUPL entity responsible for positioning over the user plane. Further details of the relationship of the user-plane positioning entities to the E-UTRAN control-plane positioning architecture are described in Annex B. + +An eNodeB may control several TPs, such as remote radio heads, or PRS-only TPs for support of PRS-based TBS. + +![Figure 5-1: UE Positioning Architecture applicable to E-UTRAN. The diagram shows the following components and connections: UE (User Equipment) connected to SET (SUPL Endpoint) via a SUPL bearer; SET connected to SLP (SUPL Location Platform) via a SUPL bearer; SLP connected to E-SMLC (Evolved-SMLC) via a Proprietary interface (possible); E-SMLC connected to LMU (LMU) via an SLm interface; E-SMLC connected to MME (Mobility Management Entity) via an SLs interface; MME connected to eNode B via an S1 interface; eNode B connected to UE via an LTE-Uu interface; eNode B contains an LMU and three TPs (TP, TP, TP).](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +``` + +graph TD + UE[UE] --- SET[SET] + SET --- SLP[SLP] + SLP -.-> E-SMLC[E-SMLC] + E-SMLC --- LMU1[LMU] + E-SMLC --- SLs[SLs] + SLs --- MME[MME] + MME --- S1[S1] + S1 --- eNodeB[eNode B] + eNodeB --- LTE-Uu[LTE-Uu] + LTE-Uu --- UE + eNodeB --- LMU2[LMU] + eNodeB --- TP1[TP] + eNodeB --- TP2[TP] + eNodeB --- TP3[TP] + +``` + +Figure 5-1: UE Positioning Architecture applicable to E-UTRAN. The diagram shows the following components and connections: UE (User Equipment) connected to SET (SUPL Endpoint) via a SUPL bearer; SET connected to SLP (SUPL Location Platform) via a SUPL bearer; SLP connected to E-SMLC (Evolved-SMLC) via a Proprietary interface (possible); E-SMLC connected to LMU (LMU) via an SLm interface; E-SMLC connected to MME (Mobility Management Entity) via an SLs interface; MME connected to eNode B via an S1 interface; eNode B connected to UE via an LTE-Uu interface; eNode B contains an LMU and three TPs (TP, TP, TP). + +Figure 5-1: UE Positioning Architecture applicable to E-UTRAN + +## 5.1 UE Positioning Operations + +To support positioning of a target UE and delivery of location assistance data to a UE with E-UTRAN access in EPS, location related functions are distributed as shown in the architecture in Figure 5-1 and as clarified in greater detail in TS 23.271 [2]. The overall sequence of events applicable to the UE, E-UTRAN and E-SMLC for any location service is shown in Figure 5.1-1. + +Note that when the MME receives Location Service Request in case of the UE is in ECM-IDLE state, the MME performs a network triggered service request as defined in TS 23.401 [19] in order to establish a signalling connection + +with the UE and assign a specific eNodeB. The UE is assumed to be in connected mode before the beginning of the flow shown in the Figure 5.1-1; that is, any signalling that might be required to bring the UE to connected mode prior to step 1a is not shown. The signaling connection may, however, be later released (e.g. by the eNode B as a result of signaling and data inactivity) while positioning is still ongoing. + +![Sequence diagram Figure 5.1-1: Location Service Support by E-UTRAN. The diagram shows vertical lifelines for UE, eNB, MME, E-SMLC, LMU, and EPC LCS Entities. Arrows and boxes indicate the flow of messages: 1a. Location Service Request (UE to MME), 1b. Location Service Request (EPC LCS Entities to MME), 1c. Location Service Request (box on MME lifeline), 2. Location Services Request (MME to E-SMLC), 3a. eNode B Procedures (box spanning eNB to E-SMLC), 3b. UE Procedures (box spanning UE to E-SMLC), 3c. LMU Procedures (box spanning eNB to LMU), 4. Location Service Response (E-SMLC to MME), 5a. Location Service Response (MME to UE), 5b. Location Service Response (MME to EPC LCS Entities), 5c. Location Service Response (box on MME lifeline).](9b9d2abd741ed4bafe7f78f89961c663_img.jpg) + +``` + +sequenceDiagram + participant UE + participant eNB + participant MME + participant E-SMLC + participant LMU + participant EPC as EPC LCS Entities + + UE->>MME: 1a. Location Service Request + EPC->>MME: 1b. Location Service Request + Note over MME: 1c. Location Service Request + MME->>E-SMLC: 2. Location Services Request + Note over eNB, E-SMLC: 3a. eNode B Procedures + Note over UE, E-SMLC: 3b. UE Procedures + Note over eNB, LMU: 3c. LMU Procedures + E-SMLC->>MME: 4. Location Service Response + MME->>UE: 5a. Location Service Response + MME->>EPC: 5b. Location Service Response + Note over MME: 5c. Location Service Response + +``` + +Sequence diagram Figure 5.1-1: Location Service Support by E-UTRAN. The diagram shows vertical lifelines for UE, eNB, MME, E-SMLC, LMU, and EPC LCS Entities. Arrows and boxes indicate the flow of messages: 1a. Location Service Request (UE to MME), 1b. Location Service Request (EPC LCS Entities to MME), 1c. Location Service Request (box on MME lifeline), 2. Location Services Request (MME to E-SMLC), 3a. eNode B Procedures (box spanning eNB to E-SMLC), 3b. UE Procedures (box spanning UE to E-SMLC), 3c. LMU Procedures (box spanning eNB to LMU), 4. Location Service Response (E-SMLC to MME), 5a. Location Service Response (MME to UE), 5b. Location Service Response (MME to EPC LCS Entities), 5c. Location Service Response (box on MME lifeline). + +**Figure 5.1-1: Location Service Support by E-UTRAN** + +- 1a. Either: the UE requests some location service (e.g. positioning or delivery of assistance data) to the serving MME at the NAS level. +- 1b. Or: some entity in the EPC (e.g. GMLC) requests some location service (e.g. positioning) for a target UE to the serving MME . +- 1c. Or: the serving MME for a target UE determines the need for some location service (e.g. to locate the UE for an emergency call). +- 2. The MME transfers the location service request to an E-SMLC. +- 3a. The E-SMLC instigates location procedures with the serving eNode B for the UE – e.g. to obtain positioning measurements or assistance data. +- 3b. In addition to step 3a or instead of step 3a, for downlink positioning the E-SMLC instigates location procedures with the UE – e.g. to obtain a location estimate or positioning measurements or to transfer location assistance data to the UE. +- 3c. For uplink positioning (e.g., UTDOA), in addition to performing step 3a, the E-SMLC instigates location procedures with multiple LMUs for the target UE – e.g. to obtain positioning measurements. +- 4. The E-SMLC provides a location service response to the MME and includes any needed results – e.g. success or failure indication and, if requested and obtained, a location estimate for the UE. +- 5a. If step 1a was performed, the MME returns a location service response to the UE and includes any needed results – e.g. a location estimate for the UE. +- 5b. If step 1b was performed, the MME returns a location service response to the EPC entity in step 1b and includes any needed results – e.g. a location estimate for the UE. + +5c. If step 1c occurred, the MME uses the location service response received in step 4 to assist the service that triggered this in step 1c (e.g. may provide a location estimate associated with an emergency call to a GMLC). + +Location procedures applicable to E-UTRAN occur in steps 3a, 3b and 3c in Figure 5.1-2 and are defined in greater detail in this specification. Steps 1a and 5a are also applicable to E-UTRAN support because of a capability to tunnel signalling applicable to steps 3a and 3b. Other steps in Figure 5.1-2 are applicable only to the EPC and are described in greater detail and in TS 23.271 [2]. + +Steps 3a and 3b can involve the use of different position methods to obtain location related measurements for a target UE and from these compute a location estimate and possibly additional information like velocity. Positioning methods supported in this release are summarized in clause 4.3 and described in detail in clause 8. + +The case that the eNode B functions as an LCS client is not supported in this version of the specification. + +## 5.2 E-UTRAN Positioning Operations + +Separately from location service support for particular UEs, an E-SMLC may interact with elements in the E-UTRAN in order to obtain measurement information to help assist one or more position methods for all UEs. An E-SMLC may also interact with elements in E-UTRAN to provide location assistance data information for broadcasting. + +### 5.2.1 Downlink Position Method Support + +An E-SMLC can interact with any eNodeB reachable from any of the MMEs with signaling access to the E-SMLC in order to obtain location related information to support the downlink position method, including PRS-based TBS. The information can include timing information for the TP in relation to either absolute GNSS time or timing of other TPs and information about the supported cells and TPs including PRS schedule. + +Signalling access between the E-SMLC and eNodeB is via any MME with signalling access to both the E-SMLC and eNodeB. + +### 5.2.2 Uplink Position Method Support + +An E-SMLC can interact with the Serving eNodeB for the UE in order to retrieve target UE configuration information to support the uplink positioning method. The configuration information may include information required by the LMUs in order to obtain uplink time measurements; see clause 8.5.2. The E-SMLC can indicate to the serving eNodeB the need to direct the UE to transmit SRS signals (up to the maximum SRS bandwidth applicable for the carrier frequency) for uplink positioning. If the requested resources are not available, the eNB may assign other resources (or no resources e.g. if none are available) and report the resource allocation to the E-SMLC. + +The E-SMLC can also request multiple LMUs to perform uplink time measurements and report the results. + +### 5.2.3 Assistance Information Broadcast Support + +An E-SMLC can interact with any eNodeB reachable from any of the MMEs with signalling access to the E-SMLC in order to provide location assistance data information for broadcasting. The information can include positioning System Information Blocks (posSIBs) together with assistance information meta data and broadcast periodicity. + +Signalling access between the E-SMLC and eNodeB is via any MME with signalling access to both the E-SMLC and eNodeB. + +## 5.3 Functional Description of Elements Related to UE Positioning in E-UTRAN + +### 5.3.1 User Equipment (UE) + +The UE may transmit the needed signals for uplink-based UE Positioning measurements and may make measurements of downlink signals from E-UTRAN and other sources such as different GNSS and TBS systems, WLAN access points, + +Bluetooth beacons, UE barometric pressure and motion sensors. The measurements to be made will be determined by the chosen positioning method. + +The UE may also contain LCS applications, or access an LCS application either through communication with a network accessed by the UE or through another application residing in the UE. This LCS application may include the needed measurement and calculation functions to determine the UE's position with or without network assistance. This is outside of the scope of this specification. + +The UE may also, for example, contain an independent positioning function (e.g., GPS) and thus be able to report its position, independent of the E-UTRAN transmissions. The UE with an independent positioning function may also make use of assistance information obtained from the network. + +### 5.3.2 eNode B + +The eNode B is a network element of E-UTRAN that may provide measurement results for position estimation and makes measurements of radio signals for a target UE and communicates these measurements to an E-SMLC. + +The eNode B makes its measurements in response to requests from the E-SMLC (on demand or periodically). + +The eNode B may configure the target UE to transmit periodic SRS with multiple transmissions (see 5.2.2) during uplink positioning. + +An eNode B may serve several TPs, including for example remote radio heads and PRS-only TPs for PRS-based TBS positioning. + +An eNode B may broadcast location assistance data information, received from an E-SMLC, in positioning System Information messages. + +### 5.3.3 Evolved Serving Mobile Location Centre (E-SMLC) + +The E-SMLC manages the support of different location services for target UEs, including positioning of UEs and delivery of assistance data to UEs. The E-SMLC may interact with the serving eNode B for a target UE in order to obtain position measurements for the UE, including uplink measurements made by the eNode B and downlink measurements made by the UE that were provided to the eNode B as part of other functions such as for support of handover. The E-SMLC may also interact with the serving eNode B to indicate to the serving eNode B the need to direct the UE to transmit SRS (see 5.2.2) signals to enable the uplink positioning method and to acquire the target UE configuration data needed by the LMUs to calculate the timing of these signals. + +The E-SMLC will select a set of LMUs to be used for the UTDOA positioning. The E-SMLC interacts with the selected LMUs to request timing measurements. + +The E-SMLC may interact with a target UE in order to deliver assistance data if requested for a particular location service, or to obtain a location estimate if that was requested. + +The E-SMLC may interact with multiple eNode B's to provide location assistance data information for broadcasting. The assistance data information for broadcast may optionally be segmented and/or ciphered by the E-SMLC. The E-SMLC may also interact with MMEs to provide ciphering key data information to the MME as described in greater detail in TS 23.271 [2]. + +For positioning of a target UE, the E-SMLC decides on the position methods to be used, based on factors that may include the LCS Client type, the required QoS, UE positioning capabilities, and eNode B positioning capabilities. The E-SMLC then invokes these positioning methods in the UE and/or serving eNode B. The positioning methods may yield a location estimate for UE-based position methods and/or positioning measurements for UE-assisted and network-based position methods. The E-SMLC may combine all the received results and determine a single location estimate for the target UE (hybrid positioning). Additional information like accuracy of the location estimate and velocity may also be determined. + +### 5.3.4 Location Measurement Unit (LMU) + +The Location Measurement Unit (LMU) makes measurements and communicates these measurements to an E-SMLC. All positioning measurements obtained by an LMU are supplied to the E-SMLC that made the request. + +A UE Positioning request may involve measurements by multiple LMUs. + +# 6 Signalling protocols and interfaces + +## 6.1 Network interfaces supporting positioning operations + +### 6.1.1 General LCS control plane architecture + +The general LCS control plane architecture in the EPS applicable to a target UE with E-UTRAN access is defined in TS 23.271 [2]. + +### 6.1.2 LTE-Uu interface + +The LTE-Uu interface, connecting the UE to the eNode B over the air, is used as one of several transport links for the LTE Positioning Protocol. + +### 6.1.3 S1-MME interface + +The S1-MME interface between the eNode B and the MME is transparent to all UE-positioning-related procedures. It is involved in these procedures only as a transport link for the LTE Positioning Protocol. + +For eNode B related positioning procedures, the S1-MME interface transparently transports both positioning requests from the E-SMLC to the eNode B and positioning results from the eNode B to the E-SMLC. + +For delivery of broadcast location assistance data information, the S1-MME interface transparently transports the assistance data information from the E-SMLC to the eNode B for broadcasting and feedback information from the eNode B to the E-SMLC. The S1-MME interface is also used by an MME to provide ciphering keys to UEs for use in deciphering broadcast location assistance data information which was ciphered by an E-SMLC. + +### 6.1.4 SLs interface + +The SLs interface, between the E-SMLC and the MME, is transparent to all UE related and eNode B related positioning procedures. It is then used only as a transport link for the LTE Positioning Protocols LPP and LPPa. + +The SLs interface supports location sessions instigated by the MME as defined in TS 23.271 [2]. LPP and LPPa transport are then supported as part of any location session. + +### 6.1.5 SLm interface + +The SLm interface between the E-SMLC and an LMU is used for uplink positioning. It is used to transport SLmAP protocol messages over the E-SMLC-LMU interface. + +Network sharing should be supported. (Details FFS). + +## 6.2 UE-terminated protocols + +### 6.2.1 LTE Positioning Protocol (LPP) + +The LTE Positioning Protocol (LPP) is terminated between a target device (the UE in the control-plane case or SET in the user-plane case) and a positioning server (the E-SMLC in the control-plane case or SLP in the user-plane case). It may use either the control- or user-plane protocols as underlying transport. In this specification, only control plane use of LPP is defined. User plane support of LPP is defined in [17] and [18]. + +LPP is a point to point positioning protocol with capabilities similar to those in UMTS RRC (TS 25.331 [15]) and GERAN RRLP (TS 44.031 [16]). Whereas RRLP supports positioning of a target MS accessing GERAN and RRC supports positioning of a target UE accessing UTRAN, LPP supports positioning and location related services (e.g. transfer of assistance data) for a target UE accessing E-UTRAN. To avoid creating new positioning protocols for future access types developed by 3GPP, and to enable positioning measurements for terrestrial access types other than + +E-UTRAN, LPP is in principle forward-compatible with other access types, even though restricted to E-UTRAN access in this specification. + +LPP further supports the OMA user plane location solution SUPL 2.0, as defined in the OMA SUPL 2.0 standards ([17], [18]), and is intended to be compatible with the successor protocols of SUPL 2.0 as well. + +LPP messages are carried as transparent PDUs across intermediate network interfaces using the appropriate protocols (e.g., S1-AP over the S1-MME interface, NAS/RRC over the Uu interface). The LPP protocol is intended to enable positioning for LTE using a multiplicity of different position methods, while isolating the details of any particular positioning method and the specifics of the underlying transport from one another. + +The protocol operates on a transaction basis between a target device and a server, with each transaction taking place as an independent procedure. More than one such procedure may be in progress at any given moment. An LPP procedure may involve a request/response pairing of messages or one or more "unsolicited" messages. Each procedure has a single objective (e.g., transfer of assistance data, exchange of LPP related capabilities, or positioning of a target device according to some QoS and use of one or more positioning methods). Multiple procedures, in series and/or in parallel, can be used to achieve more complex objectives (e.g., positioning of a target device in association with transfer of assistance data and exchange of LPP related capabilities). Multiple procedures also enable more than one positioning attempt to be ongoing at the same time (e.g., to obtain a coarse location estimate with low delay while a more accurate location estimate is being obtained with higher delay). + +An LPP session is defined between a positioning server and the target device, the details of its relation with transactions are described in clause 4.1.2 of TS 36.355 [25]. + +A single LPP transaction may be realised as multiple procedures; e.g., a single transaction for provision of assistance data might comprise several Provide Assistance Data messages, with each such message constituting a separate procedure (since there is no "multiple unsolicited messages" procedure type). + +For the 3GPP EPS Control Plane solution defined in TS 23.271 [2], the UE is the target device and the E-SMLC is the server. For SUPL 2.0 support, the SUPL Enabled Terminal (SET) is the target device and the SUPL Location Platform (SLP) is the server. The protocol does not preclude the possibility of future developments in control plane and user plane solutions (e.g., possible successors of SUPL 2.0, as well as possible future 3GPP control plane solutions). + +All LPP operations and procedures are defined with respect to the target and server, and thus the LPP operations and procedures defined here with respect to a UE and an E-SMLC can also be viewed in this more generic context by substituting any target for the UE and any server for the E-SMLC. + +LPP further supports multiple positioning methods as defined in clause 4.3. + +LPP supports hybrid positioning, in which two or more position methods are used concurrently to provide measurements and/or a location estimate or estimates to the server. LPP is forward compatible with the later addition of other position methods in later releases (e.g., position methods associated with other types of terrestrial access). + +LPP also supports RRC broadcast of location assistance data information using data types defined in relation to LPP which are embedded in positioning SIBs. This enables an E-SMLC and a UE to support broadcast location assistance data using the same data structures which are used for point to point location. + +The operations controlled through LPP are described further in clause 7.1. + +### 6.2.2 Radio Resource Control (RRC) + +The RRC protocol is terminated between the eNode B and the UE. In addition to providing transport for LPP messages over the Uu interface, it supports transfer of measurements that may be used for positioning purposes through the existing measurement systems specified in TS 36.331 [14]. + +The RRC protocol also supports broadcasting of location assistance data via positioning System Information messages. + +## 6.3 eNB-terminated protocols + +### 6.3.1 LTE Positioning Protocol Annex (LPPa) + +The LTE Positioning Protocol Annex (LPPa) carries information between the eNode B and the E-SMLC. It is used to support the following positioning functions: + +- E-CID cases where assistance data or measurements are transferred from the eNode B to the E-SMLC; +- data collection from eNodeBs for support of downlink OTDOA positioning; +- retrieval of UE configuration data from the eNodeBs for support of uplink (e.g., UTDOA) positioning; +- exchange of information between E-SMLC and eNodeBs for the purpose of assistance data broadcasting. + +The LPPa protocol is transparent to the MME. The MME routes the LPPa PDUs transparently based on a short Routing ID corresponding to the involved E-SMLC node over S1 interface without knowledge of the involved LPPa transaction. It carries the LPPa PDUs over S1 interface either in UE associated mode or non-UE associated mode. + +### 6.3.2 S1 Application Protocol (S1-AP) + +The S1-AP protocol, terminated between the MME and the eNode B, is used as transport for LPP and LPPa messages over the S1-MME interface. The S1-AP protocol is also used to instigate and terminate eNode B related positioning procedures. + +## 6.4 Signalling between an E-SMLC and UE + +### 6.4.1 Protocol Layering + +Figure 6.4.1-1 shows the protocol layering used to support transfer of LPP messages between an E-SMLC and UE. The LPP PDU is carried in NAS PDU between the MME and the UE. + +![Figure 6.4.1-1: Protocol Layering for E-SMLC to UE Signalling. The diagram illustrates the protocol stack across four entities: UE, eNode B, MME, and E-SMLC. The UE stack includes LPP, NAS, RRC, PDCP, RLC, MAC, and L1. The eNode B stack includes a Relay section (RRC, S1-AP), PDCP, SCTP, RLC, IP, MAC, L2, L1, and L1. The MME stack includes a Relay section (NAS, LCS-AP), S1-AP, SCTP, SCTP, IP, IP, L2, L2, L1, and L1. The E-SMLC stack includes LPP, LCS-AP, SCTP, IP, L2, and L1. Interfaces are labeled: LTE Uu between UE and eNode B, S1-MME between eNode B and MME, and SLs between MME and E-SMLC.](bd57a547bec253d4179e5c4491c53dbb_img.jpg) + +Figure 6.4.1-1: Protocol Layering for E-SMLC to UE Signalling. The diagram illustrates the protocol stack across four entities: UE, eNode B, MME, and E-SMLC. The UE stack includes LPP, NAS, RRC, PDCP, RLC, MAC, and L1. The eNode B stack includes a Relay section (RRC, S1-AP), PDCP, SCTP, RLC, IP, MAC, L2, L1, and L1. The MME stack includes a Relay section (NAS, LCS-AP), S1-AP, SCTP, SCTP, IP, IP, L2, L2, L1, and L1. The E-SMLC stack includes LPP, LCS-AP, SCTP, IP, L2, and L1. Interfaces are labeled: LTE Uu between UE and eNode B, S1-MME between eNode B and MME, and SLs between MME and E-SMLC. + +Figure 6.4.1-1: Protocol Layering for E-SMLC to UE Signalling + +### 6.4.2 LPP PDU Transfer + +Figure 6.4.2-1 shows the transfer of an LPP PDU between an E-SMLC and UE, in the network- and UE-triggered cases. These two cases may occur separately or as parts of a single more complex operation. + +![Figure 6.4.2-1: LPP PDU transfer between E-SMLC and UE (network- and UE-triggered cases). The diagram shows two sequence diagrams. The top diagram illustrates the network-triggered case (steps 1-4): E-SMLC sends an LCS-AP PDU (LPP PDU) to the MME; the MME initiates a Network Triggered Service Request to the UE; the MME sends an S1AP DL NAS Transport (LPP PDU) to the eNB; the eNB sends an RRC DL Info Transfer (LPP PDU) to the UE. The bottom diagram illustrates the UE-triggered case (steps 5-8): the UE initiates a UE Triggered Service Request to the eNB; the UE sends an RRC UL Info Transfer (LPP PDU) to the eNB; the eNB sends an S1AP UL NAS Transport (LPP PDU) to the MME; the MME sends an LCS-AP PDU (LPP PDU) to the E-SMLC.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +Figure 6.4.2-1: LPP PDU transfer between E-SMLC and UE (network- and UE-triggered cases). The diagram shows two sequence diagrams. The top diagram illustrates the network-triggered case (steps 1-4): E-SMLC sends an LCS-AP PDU (LPP PDU) to the MME; the MME initiates a Network Triggered Service Request to the UE; the MME sends an S1AP DL NAS Transport (LPP PDU) to the eNB; the eNB sends an RRC DL Info Transfer (LPP PDU) to the UE. The bottom diagram illustrates the UE-triggered case (steps 5-8): the UE initiates a UE Triggered Service Request to the eNB; the UE sends an RRC UL Info Transfer (LPP PDU) to the eNB; the eNB sends an S1AP UL NAS Transport (LPP PDU) to the MME; the MME sends an LCS-AP PDU (LPP PDU) to the E-SMLC. + +**Figure 6.4.2-1: LPP PDU transfer between E-SMLC and UE (network- and UE-triggered cases)** + +1. Steps 1 to 4 may occur before, after, or at the same time as steps 5 to 8. Steps 1 to 4 and steps 5 to 8 may also be repeated. Steps 1 to 4 are triggered when the E-SMLC needs to send an LPP message to the UE as part of some LPP positioning activity. The E-SMLC then sends an LCS-AP PDU to the MME carrying an LPP PDU comprising the message. +2. If the UE is in ECM-IDLE state (e.g. if the S1 connection was previously released due to data and signalling inactivity), the MME performs a network triggered service request as defined in TS 23.401 [19] in order to establish a signalling connection with the UE and assign a serving eNode B. +3. The MME includes a session identifier (a.k.a Routing identifier defined in TS 24.171 [26]), which is associated with the positioning session between the MME and E-SMLC, and the LPP PDU in the NAS Transport Message and then forwards the NAS Transport Message to the serving eNode B in an S1AP Downlink NAS Transport message. The MME need not retain state information for this transfer; it can treat any response in step 7 as a separate non-associated transfer. +4. The eNode B forwards the NAS Transport Message to the UE in an RRC DL Information Transfer message. +5. Steps 5 to 8 are triggered when the UE needs to send an LPP PDU to the E-SMLC as part of some LPP positioning activity. If the UE is in ECM-IDLE state, the UE instigates a UE triggered service request as defined in TS 23.401 [19] in order to establish a signalling connection with the MME and assign a serving eNode B. +6. The UE includes the session identifier (a.k.a Routing identifier defined in TS 24.171 [26]), which has been received in step 4, and an LPP PDU to the serving eNode B in an RRC UL Information Transfer message. +7. The eNode B forwards the NAS Transport Message to the MME in an S1AP Uplink NAS Transport message. +8. The MME forwards the LPP PDU to the E-SMLC in an LCS-AP PDU. + +## 6.5 Signalling between an E-SMLC and eNode B + +### 6.5.1 Protocol Layering + +Figure 6.5.1-1 shows the protocol layering used to support transfer of LPPa PDUs between an E-SMLC and eNode B. + +The LPPa protocol is transparent to the MME. The MME routes the LPPa PDUs transparently based on a short Routing ID which corresponds to the involved E-SMLC node over the S1 interface without knowledge of the involved LPPa transaction. It carries the LPPa PDUs over S1 interface either in UE associated mode or non-UE associated mode. + +![Figure 6.5.1-1: Protocol Layering for E-SMLC to eNode B Signalling. This diagram shows the protocol stack for three entities: eNode B, MME, and E-SMLC. The layers from top to bottom are LPPa, S1-AP (or LCS-AP), SCTP, IP, L2, and L1. The eNode B and E-SMLC have identical stacks. The MME has two parallel stacks: one for S1-AP and one for LCS-AP. The S1-AP stack is connected to the eNode B via the S1-MME interface, and the LCS-AP stack is connected to the E-SMLC via the SLs interface. Dashed lines indicate the alignment of protocol layers across the interfaces.](e354b57563dae469c00b412b2abdf765_img.jpg) + +Figure 6.5.1-1: Protocol Layering for E-SMLC to eNode B Signalling. This diagram shows the protocol stack for three entities: eNode B, MME, and E-SMLC. The layers from top to bottom are LPPa, S1-AP (or LCS-AP), SCTP, IP, L2, and L1. The eNode B and E-SMLC have identical stacks. The MME has two parallel stacks: one for S1-AP and one for LCS-AP. The S1-AP stack is connected to the eNode B via the S1-MME interface, and the LCS-AP stack is connected to the E-SMLC via the SLs interface. Dashed lines indicate the alignment of protocol layers across the interfaces. + +Figure 6.5.1-1: Protocol Layering for E-SMLC to eNode B Signalling + +### 6.5.2 LPPa PDU Transfer for UE Positioning + +Figure 6.5.2-1 shows LPPa PDU transfer between an E-SMLC and eNode B to support positioning of a particular UE. + +![Figure 6.5.2-1: LPPa PDU Transfer between an E-SMLC and eNode B for UE Positioning. This sequence diagram shows the interaction between four entities: UE, eNB, MME, and E-SMLC. The sequence of messages is: 1. LCS-AP PDU (LPPa PDU) from E-SMLC to MME; 2. Network Triggered Service Request from MME to eNB; 3. S1AP Downlink LPPa UE Associated Transfer (LPPa PDU) from eNB to MME; 4. S1AP Uplink LPPa UE Associated Transfer (LPPa PDU) from MME to eNB; 5. LCS-AP PDU (LPPa PDU) from eNB to E-SMLC.](e7c6a6e4c3047dac05a3b92e396e9794_img.jpg) + +Figure 6.5.2-1: LPPa PDU Transfer between an E-SMLC and eNode B for UE Positioning. This sequence diagram shows the interaction between four entities: UE, eNB, MME, and E-SMLC. The sequence of messages is: 1. LCS-AP PDU (LPPa PDU) from E-SMLC to MME; 2. Network Triggered Service Request from MME to eNB; 3. S1AP Downlink LPPa UE Associated Transfer (LPPa PDU) from eNB to MME; 4. S1AP Uplink LPPa UE Associated Transfer (LPPa PDU) from MME to eNB; 5. LCS-AP PDU (LPPa PDU) from eNB to E-SMLC. + +Figure 6.5.2-1: LPPa PDU Transfer between an E-SMLC and eNode B for UE Positioning + +1. Steps 1 to 3 are triggered when the E-SMLC needs to send an LPPa message to the serving eNode B for a target UE as part of an LPPa positioning activity. The E-SMLC then sends an LCS-AP PDU (as specified in TS 29.171 [27]) to the MME including the Correlation ID corresponding to the UE and carrying an LPPa PDU comprising the message. +2. If the UE is in ECM-IDLE state (e.g. if the S1 connection was previously released due to data and signalling inactivity), the MME performs a network triggered service request as defined in TS 23.401 [19] in order to establish a signalling connection with the UE and assign a serving eNode B. +3. The MME forwards the LPPa PDU to the serving eNode B in an S1AP Downlink UE Associated LPPa Transport message over the S1 signalling connection corresponding to the UE and includes the Routing ID related to the E-SMLC. The MME need not retain state information for this transfer – e.g. can treat any response in step 4 as a separate non-associated transfer. + +4. Steps 4 and 5 are triggered when a serving eNode B needs to send an LPPa message to the E-SMLC for a target UE as part of an LPPa positioning activity. The eNode B then sends an LPPa PDU to the MME in an SIAP Uplink UE Associated LPPa Transport message and includes the Routing ID received in step 3. +5. The MME forwards the LPPa PDU to the E-SMLC associated with the Routing ID received in step 4 in an LCS-AP PDU (as specified in TS 29.171 [27]) including the Correlation ID corresponding to the UE. Steps 1 to 5 may be repeated. + +### 6.5.3 LPPa PDU Transfer for Positioning Support + +Figure 6.5.3-1 shows LPPa PDU transfer between an E-SMLC and eNodeB when related to gathering data from the eNodeB for positioning support for all UEs. + +![Sequence diagram showing LPPa PDU transfer between TP, eNB, MME, and E-SMLC. The diagram illustrates four steps: 0. eNB-TP signalling/configuration (dashed arrows between TP and eNB); 1. LCS-AP PDU (LPPa PDU) from E-SMLC to MME; 2. S1AP Downlink LPPa Non UE Associated Transfer (LPPa PDU) from MME to eNB; 3. S1AP Uplink LPPa Non UE Associated Transfer (LPPa PDU) from eNB to MME; 4. LCS-AP PDU (LPPa PDU) from MME to E-SMLC.](392a79ccd95e682ccd08f35ab2e64144_img.jpg) + +``` + +sequenceDiagram + participant TP1 as TP + participant TP2 as TP + participant eNB + participant MME + participant E-SMLC + + Note left of TP1: 0. eNB-TP signalling/ +configuration + TP1-->>eNB: + eNB-->>TP2: + E-SMLC->>MME: 1. LCS-AP PDU (LPPa PDU) + MME->>eNB: 2. S1AP Downlink LPPa Non UE +Associated Transfer (LPPa PDU) + eNB->>MME: 3. S1AP Uplink LPPa Non UE +Associated Transfer (LPPa PDU) + MME->>E-SMLC: 4. LCS-AP PDU (LPPa PDU) + +``` + +Sequence diagram showing LPPa PDU transfer between TP, eNB, MME, and E-SMLC. The diagram illustrates four steps: 0. eNB-TP signalling/configuration (dashed arrows between TP and eNB); 1. LCS-AP PDU (LPPa PDU) from E-SMLC to MME; 2. S1AP Downlink LPPa Non UE Associated Transfer (LPPa PDU) from MME to eNB; 3. S1AP Uplink LPPa Non UE Associated Transfer (LPPa PDU) from eNB to MME; 4. LCS-AP PDU (LPPa PDU) from MME to E-SMLC. + +**Figure 6.5.3-1: LPPa PDU Transfer between an E-SMLC and eNodeB for obtaining eNodeB Data** + +0. An eNodeB may communicate with several TPs (including PRS-only TPs in case of PRS-based TBS is supported) to configure TPs, obtain TP configuration information, etc. +NOTE: eNodeB-TP signalling and configuration is outside the scope of this specification. +1. Steps 1 and 2 are triggered when the E-SMLC needs to send an LPPa message to an eNodeB to obtain data related to the eNodeB, and possibly associated TPs. The E-SMLC determines an MME with access to the eNodeB and then sends an LCS-AP PDU (as specified in TS 29.171 [27]) to the MME carrying an LPPa PDU, the global identity of the eNodeB and the identity of the E-SMLC. +2. The MME forwards the LPPa PDU to the identified eNode B in an SIAP Downlink Non UE Associated LPPa Transport message and includes the Routing ID related to the E-SMLC. The MME need not retain state information for this transfer – e.g. can treat any response in step 3 as a separate non-associated transfer. +3. Steps 3 and 4 are triggered when an eNode B needs to send an LPPa PDU to an E-SMLC containing data applicable to the eNodeB, and possibly associated TPs. The eNodeB determines an MME with access to the E-SMLC and then sends an LPPa PDU to the MME in an SIAP Uplink Non UE Associated LPPa Transport message. The eNodeB includes the Routing ID related to the E-SMLC received at step 2. +4. The MME forwards the LPPa PDU to the E-SMLC associated to the Routing ID indicated in step 3 and includes the global identity of the eNodeB and the identity of the E-SMLC in an LCS-AP PDU (as specified in TS 29.171 [27]). Steps 1 to 4 may be repeated. + +### 6.5.4 LPPa PDU Transfer for Assistance Information Broadcast + +Figure 6.5.4-1 shows LPPa PDU transfer between an E-SMLC and eNode B to support broadcast of assistance data. + +![Sequence diagram showing LPPa PDU transfer from E-SMLC to eNB via MME.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant MME + participant eNB + Note right of E-SMLC: 1. LCS-AP PDU (LPPa PDU) + E-SMLC->>MME: 1. LCS-AP PDU (LPPa PDU) + Note left of MME: 2. S1AP Downlink LPPa Non UE Associated Transfer (LPPa PDU) + MME->>eNB: 2. S1AP Downlink LPPa Non UE Associated Transfer (LPPa PDU) +``` + +The diagram illustrates a sequence of messages between three entities: eNB, MME, and E-SMLC. The sequence starts with the E-SMLC sending a message labeled '1. LCS-AP PDU (LPPa PDU)' to the MME. The MME then forwards this message to the eNB via a message labeled '2. S1AP Downlink LPPa Non UE Associated Transfer (LPPa PDU)'. + +Sequence diagram showing LPPa PDU transfer from E-SMLC to eNB via MME. + +**Figure 6.5.4-1: LPPa PDU Transfer between an E-SMLC and eNodeB for providing assistance information for broadcasting.** + +1. Step 1 is triggered when the E-SMLC needs to send new or updated assistance information to an eNodeB for broadcasting in positioning system information messages. The E-SMLC determines an MME with access to the eNodeB and then sends an LCS-AP PDU (as specified in TS 29.171 [27]) to the MME carrying an LPPa PDU, the global identity of the eNodeB and the identity of the E-SMLC. +2. The MME forwards the LPPa PDU to the identified eNode B in an S1AP Downlink Non UE Associated LPPa Transport message and includes the Routing ID related to the E-SMLC. The MME need not retain state information for this transfer. + +Figure 6.5.4-2 shows LPPa PDU transfer between an eNode B and E-SMLC for providing feedback to the E-SMLC on assistance data broadcasting. + +![Sequence diagram showing LPPa PDU transfer from eNB to E-SMLC via MME.](e29665b8abcea967ef289c6aff07ae4c_img.jpg) + +``` +sequenceDiagram + participant eNB + participant MME + participant E-SMLC + Note left of MME: 1. S1AP Uplink LPPa Non UE Associated Transfer (LPPa PDU) + eNB->>MME: 1. S1AP Uplink LPPa Non UE Associated Transfer (LPPa PDU) + Note right of MME: 2. LCS-AP PDU (LPPa PDU) + MME->>E-SMLC: 2. LCS-AP PDU (LPPa PDU) +``` + +The diagram illustrates a sequence of messages between three entities: eNB, MME, and E-SMLC. The sequence starts with the eNB sending a message labeled '1. S1AP Uplink LPPa Non UE Associated Transfer (LPPa PDU)' to the MME. The MME then forwards this message to the E-SMLC via a message labeled '2. LCS-AP PDU (LPPa PDU)'. + +Sequence diagram showing LPPa PDU transfer from eNB to E-SMLC via MME. + +**Figure 6.5.4-2: LPPa PDU Transfer between an eNodeB and E-SMLC for providing feedback on assistance data broadcasting.** + +1. Step 1 is triggered when an eNode B needs to send an LPPa PDU to an E-SMLC for providing feedback on assistance data broadcasting. Step 1 may only be triggered if the procedure in Figure 6.5.4-1 has already been performed. The eNodeB determines an MME with access to the E-SMLC and then sends an LPPa PDU to the MME in an S1AP Uplink Non UE Associated LPPa Transport message. The eNodeB includes the previously received Routing ID related to the E-SMLC (Figure 6.5.4-1). +2. The MME forwards the LPPa PDU to the E-SMLC associated to the Routing ID indicated in step 1 and includes the global identity of the eNodeB and the identity of the E-SMLC in an LCS-AP PDU (as specified in TS 29.171 [27]). + +## 6.6 LMU-terminated protocols + +### 6.6.1 SLm Application Protocol (SLmAP) + +The SLmAP protocol, terminated between the E-SMLC and the LMU is used to support the following functions: + +- delivery of target UE configuration data from the E-SMLC to the LMU +- request positioning measurements from the LMU and delivery of positioning measurements to the E-SMLC. + +The SLmAP protocol is directly between the E-SMLC and the LMU. + +## 6.7 Signalling between an E-SMLC and LMU + +### 6.7.1 Protocol Layering + +Figure 6.Y.1-1 shows the protocol layering used to support transfer of SLmAP messages between an E-SMLC and LMU. + +![Diagram showing the protocol layering for direct E-SMLC to LMU Signalling. The diagram consists of two vertical stacks of protocol layers separated by a dashed vertical line labeled 'SLm'. The left stack is labeled 'LMU' and the right stack is labeled 'E-SMLC'. Both stacks have five layers: SLmAP (top), SCTP, IP, L2, and L1 (bottom). Horizontal dashed lines connect corresponding layers between the LMU and E-SMLC stacks.](68ea9310fb829dd6007635a6cd4ea2ad_img.jpg) + +| | | | +|-------|-----|--------| +| SLmAP | | SLmAP | +| SCTP | | SCTP | +| IP | | IP | +| L2 | | L2 | +| L1 | | L1 | +| LMU | SLm | E-SMLC | + +Diagram showing the protocol layering for direct E-SMLC to LMU Signalling. The diagram consists of two vertical stacks of protocol layers separated by a dashed vertical line labeled 'SLm'. The left stack is labeled 'LMU' and the right stack is labeled 'E-SMLC'. Both stacks have five layers: SLmAP (top), SCTP, IP, L2, and L1 (bottom). Horizontal dashed lines connect corresponding layers between the LMU and E-SMLC stacks. + +Figure 6.7.1-1: Protocol Layering for direct E-SMLC to LMU Signalling + +# 7 General E-UTRAN UE Positioning procedures + +## 7.1 General LPP procedures for UE Positioning + +### 7.1.1 LPP Procedures + +Positioning procedures in the E-UTRAN are modelled as transactions of the LPP protocol using the procedures defined in this specification. A procedure consists of a single operation of one of the following types: + +- Exchange of positioning capabilities; +- Transfer of assistance data; +- Transfer of location information (positioning measurements and/or position estimate); +- Error handling; +- Abort. + +Parallel transactions are permitted (i.e. a new LPP transaction may be initiated, while another one is outstanding). + +As described in clause 6.2.1, the protocol operates between a "target" and a "server". In the control-plane context, these entities are the UE and E-SMLC respectively; in the SUPL context they are the SET and the SLP. The terms "target" and "server" are used in the flows in this clause to avoid redundancy between the two versions of the positioning operations. A procedure may be initiated by either the target or the server. Both target initiated and server initiated procedures are supported. + +### 7.1.2 Positioning procedures + +#### 7.1.2.1 Capability transfer + +A UE request for capability from E-SMLC or delivery of the E-SMLC capability to the UE is not supported in this version of the specification. + +Capabilities in an LPP context refer to the ability of a target or server to support different position methods defined for LPP, different aspects of a particular position method (e.g. different types of assistance data for A-GNSS) and common features not specific to only one position method (e.g. ability to handle multiple LPP transactions). These capabilities are defined within the LPP protocol and transferred between the target and the server using LPP transport. + +The exchange of capabilities between a target and a server may be initiated by a request or sent as "unsolicited" information. If a request is used, the server sends an LPP Request Capabilities message to the target device with a request for capability information. The target sends an LPP Provide Capabilities message. + +![Sequence diagram of the LPP Capability Transfer procedure. A Server sends an '1. LPP Request Capabilities' message to a Target. The Target responds with '2. LPP Provide Capabilities'.](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` +sequenceDiagram + participant Server + participant Target + Note left of Server: 1. LPP Request Capabilities + Server->>Target: 1. LPP Request Capabilities + Note right of Target: 2. LPP Provide Capabilities + Target->>Server: 2. LPP Provide Capabilities +``` + +Sequence diagram of the LPP Capability Transfer procedure. A Server sends an '1. LPP Request Capabilities' message to a Target. The Target responds with '2. LPP Provide Capabilities'. + +Figure 7.1.2.1-1: LPP Capability Transfer procedure + +1. The server may send a request for the LPP related capabilities of the target. +2. The target transfers its LPP-related capabilities to the server. The capabilities may refer to particular position methods or may be common to multiple position methods. + +LPP Capability Indication procedure is used for unsolicited capability transfer. + +![Sequence diagram of the LPP Capability Indication procedure. A Target sends an '1. LPP Provide Capabilities' message to a Server.](7728e2dd44c95d109debb1eb59e9b411_img.jpg) + +``` +sequenceDiagram + participant Target + participant Server + Note left of Target: 1. LPP Provide Capabilities + Target->>Server: 1. LPP Provide Capabilities +``` + +Sequence diagram of the LPP Capability Indication procedure. A Target sends an '1. LPP Provide Capabilities' message to a Server. + +Figure 7.1.2.1-2: LPP Capability Indication procedure + +#### 7.1.2.2 Assistance data transfer + +Assistance data may be transferred either by request or unsolicited. In this version of the specification, assistance data delivery is supported only via unicast transport from server to target. + +![Sequence diagram for LPP Assistance Data Transfer procedure](7d2d1d3870cd224c4430d19334557716_img.jpg) + +``` +sequenceDiagram + participant Target + participant Server + Note right of Target: 1. LPP Request Assistance Data + Target->>Server: 1. LPP Request Assistance Data + Note left of Server: 2. LPP Provide Assistance Data + Server-->>Target: 2. LPP Provide Assistance Data + Note left of Server: 3. LPP Provide Assistance Data + Server-->>Target: 3. LPP Provide Assistance Data +``` + +The diagram illustrates the LPP Assistance Data Transfer procedure between a Target and a Server. The sequence of messages is as follows: 1. The Target sends an 'LPP Request Assistance Data' message to the Server. 2. The Server responds with an 'LPP Provide Assistance Data' message. 3. Optionally, the Server may send additional 'LPP Provide Assistance Data' messages, indicated by a dashed line. + +Sequence diagram for LPP Assistance Data Transfer procedure + +**Figure 7.1.2.2-1: LPP Assistance Data Transfer procedure** + +1. The target may send a request to the server for assistance data and may indicate the particular assistance data needed. +2. The server transfers assistance data to the target. The transferred assistance data should match any assistance data requested in step 1. +3. Optionally, the server may transfer additional assistance data to the target in one or more additional LPP messages. + +LPP Assistance Data Delivery procedure is used for unilateral assistance data transfer. + +![Sequence diagram for LPP Assistance Data Delivery procedure](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` +sequenceDiagram + participant Target + participant Server + Note right of Server: 1. LPP Provide Assistance Data + Server-->>Target: 1. LPP Provide Assistance Data +``` + +The diagram illustrates the LPP Assistance Data Delivery procedure, which is a unilateral transfer from the Server to the Target. The sequence of messages is as follows: 1. The Server sends an 'LPP Provide Assistance Data' message to the Target. + +Sequence diagram for LPP Assistance Data Delivery procedure + +**Figure 7.1.2.2-2: LPP Assistance Data Delivery procedure** + +This procedure is unidirectional; assistance data are always delivered from the server to the target. + +#### 7.1.2.3 Location information transfer + +The term "location information" applies both to an actual position estimate and to values used in computing position (e.g., radio measurements or positioning measurements). It is delivered either in response to a request or unsolicited. + +![Sequence diagram for LPP Location Information Transfer procedure between Target and Server.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` +sequenceDiagram + participant Target + participant Server + Note left of Target: + Server->>Target: 1. LPP Request Location Information + Target-->>Server: 2. LPP Provide Location Information + Note right of Server: + Target-->>Server: 3. LPP Provide Location Information +``` + +The diagram shows a sequence of three messages between a Target and a Server. The first message is a solid arrow from Server to Target labeled '1. LPP Request Location Information'. The second message is a solid arrow from Target to Server labeled '2. LPP Provide Location Information'. The third message is a dashed arrow from Target to Server labeled '3. LPP Provide Location Information'. + +Sequence diagram for LPP Location Information Transfer procedure between Target and Server. + +**Figure 7.1.2.3-1: LPP Location Information Transfer procedure** + +1. The server may send a request for location information to the target, and may indicate the type of location information needed and associated QoS. +2. In response to step 1, the target transfers location information to the server. The location information transferred should match the location information requested in step 1. +3. Optionally (e.g., if requested in step 1), the target in step 2 may transfer additional location information to the server in one or more additional LPP messages. + +LPP Location Information Delivery procedure is used for unilateral location information transfer. + +NOTE: the LPP Location Information Delivery procedure can only be piggybacked in the MO-LR request. + +![Sequence diagram for LPP Location Information Delivery procedure between Target and Server.](dc1f232cfd39be5c20b21374ad4c04c0_img.jpg) + +``` +sequenceDiagram + participant Target + participant Server + Note left of Target: + Target-->>Server: 1. LPP Provide Location Information +``` + +The diagram shows a single message flow from Target to Server. The message is a solid arrow labeled '1. LPP Provide Location Information'. + +Sequence diagram for LPP Location Information Delivery procedure between Target and Server. + +**Figure 7.1.2.3-2: LPP Location Information Delivery procedure** + +#### 7.1.2.4 Multiple transactions + +Multiple LPP transactions may be in progress simultaneously between the same target and server nodes, to improve flexibility and efficiency. However, no more than one LPP procedure between a particular pair of target and server nodes to obtain location information shall be in progress at any time for the same position method. + +In this example, the objective is to request location measurements from the target, and the server does not provide assistance data in advance, leaving the target to request any needed assistance data. A message flow is shown in Figure 7.1.2.4-1. + +![Sequence diagram showing four LPP messages between a Target and a Server.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +sequenceDiagram + participant Target + participant Server + Server->>Target: 1. LPP Message: Request Location Information [transaction A] + Target->>Server: 2. LPP Message: Assistance data request [transaction B] + Server->>Target: 3. LPP Message: Assistance data delivery [transaction B] + Target->>Server: 4. LPP Message: Location information [measurements, transaction A] + +``` + +The diagram illustrates a sequence of four LPP messages between a Target and a Server. The sequence is as follows: 1. The Server sends an LPP Message: Request Location Information [transaction A] to the Target. 2. The Target responds with an LPP Message: Assistance data request [transaction B] to the Server. 3. The Server returns the LPP Message: Assistance data delivery [transaction B] to the Target. 4. Finally, the Target sends the LPP Message: Location information [measurements, transaction A] to the Server. + +Sequence diagram showing four LPP messages between a Target and a Server. + +**Figure 7.1.2.4-1: Example of multiple LPP procedures** + +1. The server sends a request to the target for positioning measurements. +2. The target sends a request for particular assistance data. +3. The server returns the assistance data requested in step 2. +4. The target obtains and returns the location information (e.g., positioning method measurements) requested in step 1. + +#### 7.1.2.5 Sequence of Procedures + +LPP procedures are not required to occur in any fixed order, in order to provide greater flexibility in positioning. Thus, a UE may request assistance data at any time in order to comply with a previous request for location measurements from the E-SMLC; an E-SMLC may instigate more than one request for location information (e.g., measurements or a location estimate) in case location results from a previous request were not adequate for the requested QoS; and the target device may transfer capability information to the server at any time if not already performed. + +Despite the flexibility allowed by LPP, it is expected that procedures will normally occur in the following order: + +1. Capability Transfer; +2. Assistance Data Transfer; +3. Location Information Transfer (measurements and/or location estimate). + +Specific examples for each positioning method are shown in clause 8. + +#### 7.1.2.6 Error handling + +The procedure is used to notify the sending endpoint by the receiving endpoint that the receiving LPP message is erroneous or unexpected. This procedure is bidirectional at the LPP level; either the target or the server may take the role of either endpoint in Figure 7.1.2.6-1. + +![Sequence diagram for Error handling](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` +sequenceDiagram + participant Target/Server + participant Server/Target + Note left of Target/Server: + Target/Server->>Server/Target: 1. LPP Message + Note right of Server/Target: + Server/Target-->>Target/Server: 2. LPP Message: Error +``` + +The diagram shows a sequence of two messages between two entities: "Target/Server" and "Server/Target". The "Target/Server" sends a message labeled "1. LPP Message" to the "Server/Target". The "Server/Target" responds with a message labeled "2. LPP Message: Error" back to the "Target/Server". + +Sequence diagram for Error handling + +**Figure 7.1.2.6-1: Error handling** + +1. The target or server (indicated as "Target/Server" in Figure 7.1.2.6-1) sends a LPP message to the other endpoint (indicated as "Server/Target"). +2. If the server or target ("Server/Target") detects that the receiving LPP message is erroneous or unexpected, the server or target transfers error indication information to the other endpoint ("Target/Server"). + +#### 7.1.2.7 Abort + +The procedure is used to notify the other endpoint by one endpoint to abort an ongoing procedure between the two endpoints. This procedure is bidirectional at the LPP level; either the target or the server may take the role of either endpoint in Figure 7.1.2.7-1. + +![Sequence diagram for Abort](1b893df61c2b73b7a85e65fc1f58e203_img.jpg) + +``` +sequenceDiagram + participant Target/Server + participant Server/Target + Note right of Target/Server: 1. Ongoing LPP Procedure + Note left of Server/Target: + Server/Target-->>Target/Server: 2. LPP Message: Abort +``` + +The diagram shows an ongoing LPP procedure between "Target/Server" and "Server/Target". A horizontal bar labeled "1. Ongoing LPP Procedure" spans across both entities. Then, the "Server/Target" sends a message labeled "2. LPP Message: Abort" to the "Target/Server". + +Sequence diagram for Abort + +**Figure 7.1.2.7-1: Abort** + +1. A LPP procedure is ongoing between target and server. +2. If the server or target ("Server/Target") determines that the procedure must be aborted, and then the server or target sends an LPP Abort message to the other endpoint ("Target/Server") carrying the transaction ID for the procedure. + +### 7.1.3 UE positioning measurements in idle state for NB-IoT + +NB-IoT UEs may perform measurements for some positioning methods only when in idle state. + +Figure 7.1.3-1 shows the general positioning procedure where the UE performs positioning measurements in idle state. + +![Sequence diagram illustrating UE positioning measurements in idle state. The diagram shows interactions between UE, eNB, MME, and E-SMLC. Steps include LPP Capability Transfer, LPP Assistance Data Delivery, LPP Request Location Information, Inactivity Timer Expires, RRC Connection Release, UE Context Release, Location Measurements, UE Triggered Service Request or Connection Resume, and LPP Provide Location Information. A vertical double-headed arrow on the left indicates the LPP Response Time from step 4 to step 9.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` + +sequenceDiagram + participant UE + participant eNB + participant MME + participant E-SMLC + + Note left of UE: LPP Response Time + UE->>E-SMLC: 1./2. LPP Capability Transfer + E-SMLC->>MME: 3. LPP Assistance Data Delivery + MME->>UE: 4./5. LPP Request Location Information + Note right of eNB: Inactivity Timer Expires + eNB->>UE: RRC Connection Release + eNB->>MME: UE Context Release + Note left of UE: 7. Location Measurements + UE->>MME: 8. UE Triggered Service Request or Connection Resume + MME->>E-SMLC: 9. LPP Provide Location Information + +``` + +Sequence diagram illustrating UE positioning measurements in idle state. The diagram shows interactions between UE, eNB, MME, and E-SMLC. Steps include LPP Capability Transfer, LPP Assistance Data Delivery, LPP Request Location Information, Inactivity Timer Expires, RRC Connection Release, UE Context Release, Location Measurements, UE Triggered Service Request or Connection Resume, and LPP Provide Location Information. A vertical double-headed arrow on the left indicates the LPP Response Time from step 4 to step 9. + +**Figure 7.1.3-1: UE positioning measurements in idle state.** + +1. The E-SMLC is aware of the UE access type and/or coverage level if applicable from the Location Service Request message received from the MME. The E-SMLC may send a LPP Request Capabilities message to the UE to obtain the UE positioning method capabilities from the UE, as described in clause 7.1.2.1. +2. The UE sends its positioning method capabilities to the E-SMLC in a LPP Provide Capabilities message, including an indication of position methods for which the UE needs to make measurements in idle state. +3. The E-SMLC may determine the assistance data required for the selected position method or methods, and sends them in one or more LPP Provide Assistance data messages to the UE, as described in clause 7.1.2.2. If an LPP acknowledgement was requested, the UE sends an LPP acknowledgement for each received LPP Provide Assistance data message to the E-SMLC. +4. If the UE capabilities from step 2 indicate that idle state is required for positioning measurements, the E-SMLC may allow additional response time to the UE to obtain the location measurements, and sends one or more LPP Request Location Information messages to the UE requesting positioning measurements or a location estimate, and including the required response time, as described in clause 7.1.2.3. For E-CID positioning method, when NRSRP/NRSRQ measurements are requested the UE is requested to provide NRSRP/NRSRQ measurements for intra-frequency neighbour cells and for inter-frequency neighbour cells. The UE may use inter-frequency information in system information of the serving cell specified in TS 36.331 [14] to decide on which inter-frequency cells to measure. +5. The UE sends an LPP acknowledgement for each received LPP Request Location Information message to the E-SMLC, if an LPP acknowledgement was requested at step 4 but does not perform the requested measurements. +6. The UE may finish any other activities in progress (e.g., SMS or data transfer), and waits until the network releases or suspends the connection (after a certain period of inactivity). The UE will then receive an RRC connection release or suspend from the eNodeB due to the expiration of the inactivity timer. +7. When the UE has entered idle state, the UE performs the measurements requested in step 4. +8. Before the location measurements are to be sent to the E-SMLC, the UE instigates a UE triggered service request or, when User Plane CIoT EPS optimization applies, the Connection Resume procedure as defined in TS 23.401 + +[19], if the UE is not using Control Plane CIoT EPS Optimisation, in order to establish a signalling connection with the MME. If the UE is using Control Plane CIoT EPS Optimisation, procedures for Mobile Originated Data Transport in Control Plane CIoT EPS optimisation as defined in TS 23.401 [19] are performed by the UE to establish a signalling connection with the MME. + +9. When the LPP response time received in step 4 expires (or when location measurements are available before expiry), the UE sends one or more LPP Provide Location Information messages containing the requested location measurements or location estimate obtained in step 7 to the E-SMLC. + +## 7.2 General LPPa Procedures for UE Positioning + +### 7.2.1 LPPa Procedures + +Positioning and data acquisition transactions between an E-SMLC and eNodeB are modelled by using procedures of the LPPa protocol. There are two types of LPPa procedures: + +- UE associated procedure, i.e. transfer of information for a particular UE (e.g. positioning measurements) +- Non UE associated procedure, i.e. transfer of information applicable to the eNodeB and associated TPs (e.g. eNB/TP timing differences) + +Parallel transactions between the same E-SMLC and eNodeB are supported; i.e. a pair of E-SMLC and eNodeB may have more than one instance of an LPPa procedure in execution at the same time. + +For possible extensibility, the protocol is considered to operate between a generic "access node" (e.g. eNodeB) and a "server" (e.g. E-SMLC). A procedure is only initiated by the server. + +![Sequence diagram showing a single LPPa transaction between an Access Node and a Server.](05d8710f69c476939295486ab1440350_img.jpg) + +``` + +sequenceDiagram + participant Access Node + participant Server + Server->>Access Node: 1. LPPa Procedural Request + Access Node->>Server: 2. LPPa Procedural Response + Access Node-->>Server: N. LPPa Procedural Response (end transaction) + +``` + +The diagram shows a sequence of messages between an Access Node (left) and a Server (right). + 1. A solid arrow from Server to Access Node labeled "1. LPPa Procedural Request". + 2. A solid arrow from Access Node to Server labeled "2. LPPa Procedural Response". + 3. A dashed arrow from Access Node to Server labeled "N. LPPa Procedural Response (end transaction)". + +Sequence diagram showing a single LPPa transaction between an Access Node and a Server. + +Figure 7.2.1-1: A single LPPa transaction + +Figure 7.2.1.1-1 shows a single LPPa transaction. The transaction is terminated in step 2 in the case of a non UE associated procedure. For a UE associated procedure to gather information concerning the access node, additional responses may be allowed (e.g. sending of updated information periodically and/or whenever there is some significant change). In this case, the transaction may be ended after some additional responses. In the LPPa protocol, the described transaction may be realized by the execution of one procedure defined as a request and a response, followed by one or several procedures initiated by the eNB (each procedure defined as a single message) to realize the additional responses. The Correlation ID provided by the MME in the LCS-AP PDU encapsulating the LPPa PDU may be used by the E-SMLC to identify the target UE positioning session. + +### 7.2.2 LPPa transaction types + +#### 7.2.2.1 Location information transfer + +The term "location information" applies both to an actual position estimate and to values used in computing position (e.g., radio measurements or positioning measurements). It is delivered in response to a request. + +![Sequence diagram showing location information transfer between an eNode B and a Server. The sequence consists of three steps: 1. A dashed arrow from the Server to the eNode B labeled '1. LPPa Message: Location information request'. 2. A solid arrow from the eNode B to the Server labeled '2. LPPa Message: Location information'. 3. A dashed arrow from the eNode B to the Server labeled '3. LPPa Message: Location information'.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +Sequence diagram showing location information transfer between an eNode B and a Server. The sequence consists of three steps: 1. A dashed arrow from the Server to the eNode B labeled '1. LPPa Message: Location information request'. 2. A solid arrow from the eNode B to the Server labeled '2. LPPa Message: Location information'. 3. A dashed arrow from the eNode B to the Server labeled '3. LPPa Message: Location information'. + +Figure 7.2.2-1: Location information transfer + +1. The server sends a request for location related information to the eNodeB, and indicates the type of location information needed and associated QoS. The request may refer to a particular UE. +2. In response to step 1, the eNodeB transfers location related information to the server. The location related information transferred should match the location related information requested in step 1. +3. If requested in step 1, the eNodeB may transfer additional location related information to the server in one or more additional LPPa messages when the positioning method is E-CID. + +## 7.3 Service Layer Support using combined LPP and LPPa Procedures + +As described in TS 23.271 [2], UE-positioning-related services can be instigated from the EPC in the case of an NI-LR or MT-LR location service, or from the UE in the case of an MO-LR location service. The complete sequence of operations in the EPC is defined in TS 23.271 [2]. This clause defines the overall sequences of operations that occur in the E-SMLC, E-UTRAN and UE as a result of the EPC operations. + +Some flows in this scenario apply only in particular situations (e.g., only when the UE is in connected mode). The lower-layer details of such cases are not shown in the diagrams; for instance, the process of paging a UE to bring it to connected mode from idle is not explicitly indicated in these diagrams. + +### 7.3.1 NI-LR and MT-LR Service Support + +Figure 7.3.1-1 shows the sequence of operations for an NI-LR or MT-LR location service, starting at the point where the MME initiates the service in the E-SMLC. + +![Sequence diagram showing UE positioning operations to support an MT-LR or NI-LR. The diagram involves four lifelines: UE, eNB, MME, and E-SMLC. The sequence is: 1. A solid arrow from the MME to the E-SMLC labeled '1. Location Request (QoS)'. 2. A horizontal bar spanning the UE, eNB, and MME lifelines labeled '2. LPP Transactions(s)'. 3. A horizontal bar spanning the eNB and MME lifelines labeled '3. LPPa Transactions(s)'. 4. A solid arrow from the E-SMLC to the MME labeled '4. Location Response (Location Estimate)'.](f1cbfa3fc27f58581615654fec4335d8_img.jpg) + +Sequence diagram showing UE positioning operations to support an MT-LR or NI-LR. The diagram involves four lifelines: UE, eNB, MME, and E-SMLC. The sequence is: 1. A solid arrow from the MME to the E-SMLC labeled '1. Location Request (QoS)'. 2. A horizontal bar spanning the UE, eNB, and MME lifelines labeled '2. LPP Transactions(s)'. 3. A horizontal bar spanning the eNB and MME lifelines labeled '3. LPPa Transactions(s)'. 4. A solid arrow from the E-SMLC to the MME labeled '4. Location Response (Location Estimate)'. + +Figure 7.3.1-1: UE Positioning Operations to support an MT-LR or NI-LR + +1. The MME sends a location request to the E-SMLC for a target UE and may include associated QoS. +2. The E-SMLC may obtain location related information from the UE and/or from the serving eNode B. In the former case, the E-SMLC instigates one or more LPP procedures to transfer UE positioning capabilities, provide assistance data to the UE and/or obtain location information from the UE. The UE may also instigate one or + +more LPP procedures after the first LPP message is received from the E-SMLC (e.g., to request assistance data from the E-SMLC). + +3. If the E-SMLC needs location related information for the UE from the eNode B, the E-SMLC instigates one or more LPPa procedures. Step 3 is not necessarily serialised with step 2; if the E-SMLC and eNode B have the information to determine what procedures need to take place for the location service, step 3 could precede or overlap with step 2. +4. The E-SMLC returns a location response to the MME with any location estimate obtained as a result of steps 2 and 3. + +### 7.3.2 MO-LR Service Support + +Figure 7.3.2-1 shows the sequence of operations for an MO-LR service, starting at the point where an LCS Client in the UE or the user has requested some location service (e.g., retrieval of the UE's location or transfer of the UE's location to a third party). + +![Sequence diagram for UE Positioning Operations to support an MO-LR. The diagram shows interactions between UE, eNB, MME, and E-SMLC. Step 1: UE sends MO-LR Request (LPP PDU) to MME. Step 2: MME sends Location Request (LPP PDU) to E-SMLC. Step 3: LPP Procedure(s) between UE and E-SMLC. Step 4: LPPa Procedure(s) between eNB and E-SMLC. Step 5: E-SMLC sends Location Response to MME. Step 6: Transfer to Third Party (dashed box). Step 7: MME sends MO-LR Response to UE.](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +``` + +sequenceDiagram + participant UE + participant eNB + participant MME + participant E-SMLC + Note left of UE: LCS Client / User Request + UE->>MME: 1. MO-LR Request (LPP PDU) + MME->>E-SMLC: 2. Location Request (LPP PDU) + Note right of E-SMLC: 3. LPP Procedure(s) + Note right of E-SMLC: 4. LPPa Procedure(s) + E-SMLC->>MME: 5. Location Response + Note right of MME: 6. Transfer to Third Party + MME->>UE: 7. MO-LR Response + +``` + +Sequence diagram for UE Positioning Operations to support an MO-LR. The diagram shows interactions between UE, eNB, MME, and E-SMLC. Step 1: UE sends MO-LR Request (LPP PDU) to MME. Step 2: MME sends Location Request (LPP PDU) to E-SMLC. Step 3: LPP Procedure(s) between UE and E-SMLC. Step 4: LPPa Procedure(s) between eNB and E-SMLC. Step 5: E-SMLC sends Location Response to MME. Step 6: Transfer to Third Party (dashed box). Step 7: MME sends MO-LR Response to UE. + +Figure 7.3.2-1: UE Positioning Operations to support an MO-LR + +1. The UE sends a NAS level MO-LR location service request message to the MME. The MO-LR location service request message may carry an LPP PDU to instigate one or more LPP procedures to transfer capabilities, request assistance data and/or transfer location information (e.g. location measurements). +2. The MME sends a location request to the E-SMLC and includes any LPP PDU received in step 1. +3. The E-SMLC may obtain location related information from the UE and/or from the serving eNode B. In the former case or if an immediate response is needed to any LPP procedure instigated by the UE in step 1 (e.g., a request for assistance data), the E-SMLC instigates one or more LPP procedures to transfer UE positioning capabilities, provide assistance data to the UE and/or obtain location information from the UE. The UE may also instigate further LPP procedures after the first LPP message is received from the E-SMLC (e.g., to request assistance data or to request further assistance data). +4. If the E-SMLC needs location related information for the UE from the eNode B, the E-SMLC instigates one or more LPPa procedures. Step 4 may also precede step 3 or occur in parallel with it. +5. The E-SMLC returns a location response to the MME with any location estimate obtained as a result of steps 3 and 4. + +6. If the UE requested location transfer to a third party the MME transfers the location received from the E-SMLC in step 5 to the third party as defined in TS 23.271 [2]. +7. The MME sends a NAS level MO-LR location service response message to the UE. + +## 7.4 General SLmAP Procedures for UE Positioning + +### 7.4.1 SLmAP Procedures + +SLmAP includes positioning procedures, such as: + +- Measurement request +- Measurement Update +- Measurement Abort + +#### 7.4.1.1 Measurement request + +The measurement request procedure is used by the E-SMLC to obtain timing measurement for a particular target UE from an LMU. + +![Sequence diagram for the Measurement request procedure. It shows two participants: E-SMLC and LMU. Step 1: E-SMLC sends an SLmAP Measurement Request to the LMU. Step 2: LMU sends an SLmAP Measurement Response (measurements) back to the E-SMLC.](257c8341b41f1f4a287f27d33227974c_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant LMU + Note left of E-SMLC: E-SMLC + Note right of LMU: LMU + E-SMLC->>LMU: 1. SLmAP Measurement Request + LMU-->>E-SMLC: 2. SLmAP Measurement Response (measurements) +``` + +Sequence diagram for the Measurement request procedure. It shows two participants: E-SMLC and LMU. Step 1: E-SMLC sends an SLmAP Measurement Request to the LMU. Step 2: LMU sends an SLmAP Measurement Response (measurements) back to the E-SMLC. + +Figure 7.4.1-1: Measurement request + +1. The E-SMLC sends a measurement request to the LMU. The measurement request identifies the UE to be positioned and contains the data (including SRS transmission configuration) needed to obtain the measurements. +2. In response to step 1, the LMU transfers UL RTOA measurements to the E-SMLC. + +#### 7.4.1.2 Measurement Update + +The Measurement Update procedure is used by the E-SMLC to inform the LMU of a change in the UE SRS transmission configuration during an ongoing SLmAP measurement reporting transaction. + +![Sequence diagram for Figure 7.4.1.2-1: Measurement update. The diagram shows two lifelines: E-SMLC and LMU. A dashed box labeled '1. Ongoing SLmAP Measurement Request Procedure' spans the top. A solid arrow labeled '2. SLmAP Measurement Update' points from E-SMLC to LMU. A dashed box labeled '3. SLmAP Measurement Request Procedure continues' spans the bottom.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant LMU + Note over E-SMLC, LMU: 1. Ongoing SLmAP Measurement Request Procedure + E-SMLC->>LMU: 2. SLmAP Measurement Update + Note over E-SMLC, LMU: 3. SLmAP Measurement Request Procedure continues +``` + +Sequence diagram for Figure 7.4.1.2-1: Measurement update. The diagram shows two lifelines: E-SMLC and LMU. A dashed box labeled '1. Ongoing SLmAP Measurement Request Procedure' spans the top. A solid arrow labeled '2. SLmAP Measurement Update' points from E-SMLC to LMU. A dashed box labeled '3. SLmAP Measurement Request Procedure continues' spans the bottom. + +**Figure 7.4.1.2-1: Measurement update** + +1. An SLmAP Measurement reporting transaction is ongoing between the E-SMLC and LMU. +2. The E-SMLC determines that the SRS transmission configuration data previously sent to the LMU is no longer valid. The E-SMLC sends a Measurement Update to the LMU containing the new SRS transmission configuration data. The E-SMLC shall not send a Measurement Update after receiving a Measurement Response from the LMU. +3. The LMU continues UL RTOA measurements using the updated SRS configuration. + +#### 7.4.1.3 Measurement Abort + +The measurement abort procedure is used by the E-SMLC to abort an ongoing SLmAP measurement reporting transaction. + +![Sequence diagram for Figure 7.4.1.3-1: Measurement abort. The diagram shows two lifelines: E-SMLC and LMU. A dashed box labeled '1. Ongoing SLmAP Measurement Request Procedure' spans the top. A solid arrow labeled '2. SLmAP Measurement abort' points from E-SMLC to LMU.](f1091147d93cee4dfa88498610e395a7_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant LMU + Note over E-SMLC, LMU: 1. Ongoing SLmAP Measurement Request Procedure + E-SMLC->>LMU: 2. SLmAP Measurement abort +``` + +Sequence diagram for Figure 7.4.1.3-1: Measurement abort. The diagram shows two lifelines: E-SMLC and LMU. A dashed box labeled '1. Ongoing SLmAP Measurement Request Procedure' spans the top. A solid arrow labeled '2. SLmAP Measurement abort' points from E-SMLC to LMU. + +**Figure 7.4.1.3-1: Measurement abort** + +1. An SLmAP Measurement reporting transaction is ongoing between the E-SMLC and LMU. +2. The E-SMLC determines that the transaction should be aborted (e.g. due to UE detach or inter-MME handover). The E-SMLC sends a measurement abort to the LMU and the ongoing SLmAP Measurement reporting transaction is abandoned. The E-SMLC shall not send a Measurement Abort after receiving a Measurement response from the LMU. + +## 7.5 Service Layer Support using combined SLmAP and LPPa Procedures + +### 7.5.1 NI-LR and MT-LR Service Support + +Figure 7.5.1-1 shows the sequence of operations for an NI-LR and MT-LR, starting at the point where the MME initiates the service in the E-SMLC. + +![Sequence diagram showing UE Positioning Operations to support NI-LR or MT-LR. The diagram involves four lifelines: eNB, LMU, MME, and E-SMLC. The sequence is: 1. MME sends a Location Request (QoS) to E-SMLC. 2. E-SMLC sends LPPa Transactions(s) to eNB. 3. E-SMLC sends SLmAP Procedure(s) to LMU. 4. E-SMLC sends a Location Response (Location Estimate) to MME.](107da2e3495b2f24352c9e3b26ec4841_img.jpg) + +``` +sequenceDiagram + participant eNB + participant LMU + participant MME + participant E-SMLC + Note right of MME: 1. Location Request (QoS) + MME->>E-SMLC: 1. Location Request (QoS) + Note over eNB, E-SMLC: 2. LPPa Transactions(s) + eNB->>E-SMLC: 2. LPPa Transactions(s) + Note over LMU, E-SMLC: 3. SLmAP Procedure(s) + LMU->>E-SMLC: 3. SLmAP Procedure(s) + Note right of E-SMLC: 4. Location Response (Location Estimate) + E-SMLC->>MME: 4. Location Response (Location Estimate) +``` + +Sequence diagram showing UE Positioning Operations to support NI-LR or MT-LR. The diagram involves four lifelines: eNB, LMU, MME, and E-SMLC. The sequence is: 1. MME sends a Location Request (QoS) to E-SMLC. 2. E-SMLC sends LPPa Transactions(s) to eNB. 3. E-SMLC sends SLmAP Procedure(s) to LMU. 4. E-SMLC sends a Location Response (Location Estimate) to MME. + +**Figure 7.5.1-1: UE Positioning Operations to support NI-LR or MT-LR** + +1. The MME sends a location request to the E-SMLC for a target UE and may include associated QoS. +2. The E-SMLC obtains target UE configuration information from the serving eNode B. +3. If the E-SMLC needs measurement results for the UE from multiple LMUs, the E-SMLC instigates SLmAP procedures to each LMU. +4. The E-SMLC returns a location response to the MME with any location estimate obtained as a result of steps 2 and 3. + +### 7.5.2 MO-LR Service Support + +Figure 7.5.2-1 shows the sequence of operations for an MO-LR service, starting at the point where an LCS Client in the UE or the user has requested some location service (e.g., retrieval of the UE's location or transfer of the UE's location to a third party). + +![Sequence diagram showing UE Positioning Operations to support an MO-LR. The diagram involves five entities: UE, LMU, eNB, MME, and E-SMLC. The sequence of messages is: 1. MO-LR Request from UE to MME; 2. Location Request from MME to E-SMLC; 3. LPPa Procedure(s) between E-SMLC and eNB; 4. SLmAP Procedure(s) between E-SMLC and LMU; 5. Location Response from E-SMLC to MME; 6. Transfer to Third Party (dashed box) from MME; 7. MO-LR Response from MME to UE.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +``` + +sequenceDiagram + participant UE + participant LMU + participant eNB + participant MME + participant E-SMLC + Note right of eNB: 3. LPPa Procedure(s) + Note right of LMU: 4. SLmAP Procedure(s) + Note right of MME: 6. Transfer to Third Party + UE->>MME: 1. MO-LR Request + MME->>E-SMLC: 2. Location Request + E-SMLC->>eNB: 3. LPPa Procedure(s) + E-SMLC->>LMU: 4. SLmAP Procedure(s) + E-SMLC->>MME: 5. Location Response + MME-->>MME: 6. Transfer to Third Party + MME->>UE: 7. MO-LR Response + +``` + +Sequence diagram showing UE Positioning Operations to support an MO-LR. The diagram involves five entities: UE, LMU, eNB, MME, and E-SMLC. The sequence of messages is: 1. MO-LR Request from UE to MME; 2. Location Request from MME to E-SMLC; 3. LPPa Procedure(s) between E-SMLC and eNB; 4. SLmAP Procedure(s) between E-SMLC and LMU; 5. Location Response from E-SMLC to MME; 6. Transfer to Third Party (dashed box) from MME; 7. MO-LR Response from MME to UE. + +**Figure 7.5.2-1: UE Positioning Operations to support an MO-LR** + +1. The UE sends a NAS level MO-LR request to the MME. +2. The MME sends a location request to the E-SMLC. +3. The E-SMLC obtains target UE configuration information from the serving eNode B. +4. If the E-SMLC needs measurement results for the UE from multiple LMUs, the E-SMLC instigates SLmAP procedures to each LMU. +5. The E-SMLC returns a location response to the MME with any location estimate obtained as a result of steps 2 and 3. +6. If the UE requested location transfer to a third party LCS Client, the MME transfers the location received from the E-SMLC in step 5 to the third party as defined in TS 23.271 [2]. +7. The MME sends a NAS level MO-LR response to the UE carrying any location estimate. + +## 7.6 Procedures for Broadcast of Assistance Data + +### 7.6.1 General + +Positioning assistance data can be included in positioning System Information Blocks (posSIBs) as described in TS 36.331 [14] and TS 36.355 [25]. The posSIBs are carried in RRC System Information (SI) messages. The mapping of posSIBs (assistance data) to SI messages is flexibly configurable and provided to the UE in SIB1 (TS 36.331 [14]). + +For each assistance data element, a separate posSIB-type is defined in TS 36.355 [25]. Each posSIB may be ciphered by the E-SMLC using the 128-bit Advanced Encryption Standard (AES) algorithm (with counter mode) as described in TS 36.355 [25], either with the same or different ciphering key. The posSIBs which exceed the maximum size limit defined in TS 36.331 [14] shall be segmented by the E-SMLC. + +### 7.6.2 Broadcast Procedures + +The general procedures for broadcast of positioning assistance data and delivery of ciphering keys to UEs is described in TS 23.271 [2]. This clause defines the overall sequences of operations that occur in the E-SMLC, E-UTRAN and UE. + +![Sequence diagram showing procedures to support broadcast of assistance data between UE, eNB, MME, and E-SMLC.](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` + +sequenceDiagram + participant UE + participant eNB + participant MME + participant E-SMLC + + Note right of E-SMLC: 1. LPPa Assistance Information Control + E-SMLC->>eNB: 1. LPPa Assistance Information Control + Note left of eNB: 2. RRC System Information + eNB->>UE: 2. RRC System Information + Note left of eNB: ... + eNB->>UE: ... + Note right of MME: 3. LCS-AP Ciphering Key Data + MME->>E-SMLC: 3. LCS-AP Ciphering Key Data + Note right of E-SMLC: 3a. LCS-AP Ciphering Key Data Result + E-SMLC->>MME: 3a. LCS-AP Ciphering Key Data Result + Note right of eNB: 4. LPPa Assistance Information Feedback + eNB-->>E-SMLC: 4. LPPa Assistance Information Feedback + Note right of E-SMLC: 5. LPPa Assistance Information Control + E-SMLC->>eNB: 5. LPPa Assistance Information Control + Note left of eNB: 6. RRC System Information + eNB->>UE: 6. RRC System Information + Note left of eNB: ... + eNB->>UE: ... + Note right of MME: ... + Note right of E-SMLC: 7. LPPa Assistance Information Control + E-SMLC->>eNB: 7. LPPa Assistance Information Control + +``` + +Sequence diagram showing procedures to support broadcast of assistance data between UE, eNB, MME, and E-SMLC. + +**Figure 7.6.2-1: Procedures to support broadcast of assistance data.** + +1. The E-SMLC sends an LPPa Assistance Data Information Control message to the eNB with an indication to start broadcasting assistance information. The message includes one or more System Information groups, where each group contains the broadcast periodicity and one or more posSIB types together with meta data. Each posSIB type may be ciphered and/or segmented at the E-SMLC. The meta data may include an indication whether the posSIB type in the System Information group is ciphered or not, as well as an indication of an applicable GNSS type. +2. The eNB includes the received System Information groups in RRC System Information Messages and corresponding scheduling information in SIB1 as described in [12]. The UE applies the system information acquisition procedure according to [12] for acquiring the assistance data information that is broadcasted. +3. If the posSIB types were ciphered by the E-SMLC, the E-SMLC provides the used ciphering keys, together with a validity time and validity area for each key, to the MME using an LCS-AP Ciphering Key Data message described in TS 29.171 [27]. The MME returns a LCS-AP Ciphering Key Data Result message back to the E-SMLC indicating whether the MME was able to successfully store the ciphering data sets. The MME may then distribute successfully stored ciphering keys and their validity times and validity areas to suitably subscribed UEs using a mobility management message as described in TS 23.271 [2]. The E-SMLC repeats this procedure whenever a ciphering key changes. +4. At any time after Step 1, the eNB may send a LPPa Assistance Information Feedback message to the E-SMLC providing feedback on assistance information broadcasting. The message may include an assistance information failure list indicating that certain posSIB types could not be configured for broadcasting by the eNB. +5. If the assistance information in a System Information group changes, the E-SMLC provides updated information in a LPPa Assistance Information Control message. +6. The eNB replaces the previously stored System Information groups with the new information received at Step 5 and includes the new System Information groups in RRC System Information Messages. + +7. If the E-SMLC wants to abort the broadcast of a System Information Group, it sends a LPPa Assistance Information Control message to the eNB including an indication to stop broadcasting the assistance information. + +--- + +## 8 Positioning methods and Supporting Procedures + +### 8.1 GNSS positioning methods + +#### 8.1.1 General + +A navigation satellite system provides autonomous geo-spatial positioning with either global or regional coverage. Augmentation systems, such as SBAS, are navigation satellite systems that provide regional coverage to augment the navigation systems with global coverage. + +By definition, GNSS refers to satellite constellations that achieve global coverage, however, in 3GPP specifications the term GNSS is used to encompass global, regional, and augmentation satellite systems. The following GNSSs are supported in this version of the specification: + +- GPS and its modernization [6], [7], [8]; (global coverage) +- Galileo [9]; (global coverage) +- GLONASS [10]; (global coverage) +- Satellite Based Augmentation Systems (SBAS), including WAAS, EGNOS, MSAS, and GAGAN [12]; (regional coverage) +- Quasi-Zenith Satellite System (QZSS) [11]; (regional coverage) +- BeiDou Navigation Satellite System (BDS) [28], [34]; (global coverage) +- NAVigation with Indian Constellation (NavIC) [35]. (regional coverage) + +Each global GNSS can be used individually or in combination with others, including regional navigation systems and augmentation systems. When used in combination, the effective number of navigation satellite signals would be increased: + +- extra satellites can improve availability (of satellites at a particular location) and results in an improved ability to work in areas where satellite signals can be obscured, such as in urban canyons; +- extra satellites and signals can improve reliability, i.e., with extra measurements the data redundancy is increased, which helps identify any measurement outlier problems; +- extra satellites and signals can improve accuracy due to improved measurement geometry and improved ranging signals from modernized satellites. + +When GNSS is designed to inter-work with the E-UTRAN, the network assists the UE GNSS receiver to improve the performance in several respects. These performance improvements will: + +- reduce the UE GNSS start-up and acquisition times; the search window can be limited and the measurements speed up significantly; +- increase the UE GNSS sensitivity; positioning assistance messages are obtained via E-UTRAN so the UE GNSS receiver can operate also in low SNR situations when it is unable to demodulate GNSS satellite signals; +- allow the UE to consume less handset power than with stand-alone GNSS; this is due to rapid start-up times as the GNSS receiver can be in idle mode when it is not needed; +- allow the UE to compute its position with a better accuracy; RTK corrections (for N-RTK) and GNSS physical models (for SSR/PPP) are obtained via E-UTRAN so the UE can use these assistance data, together with its own measurements, i.e., code and carrier phase measurements, to enable computation of a position with a high accuracy. + +The network-assisted GNSS methods rely on signalling between UE GNSS receivers (possibly with reduced complexity) and a continuously operating GNSS reference receiver network, which has clear sky visibility of the same GNSS constellation as the assisted UEs. Two assisted modes are supported: + +- *UE-Assisted*: The UE performs GNSS measurements (pseudo-ranges, pseudo Doppler, carrier phase ranges, etc.) and sends these measurements to the E-SMLC where the position calculation takes place, possibly using additional measurements from other (non GNSS) sources; +- *UE-Based*: The UE performs GNSS measurements and calculates its own position location, possibly using additional measurements from other (non GNSS) sources and assistance data from the E-SMLC. + +The assistance data content may vary depending on whether the UE operates in UE-Assisted or UE-Based mode. + +The assistance data signalled to the UE can be broadly classified into: + +- *data assisting the measurements*: e.g. reference time, visible satellite list, satellite signal Doppler, code phase, Doppler and code phase search windows; +- *data providing means for position calculation*: e.g. reference time, reference position, satellite ephemeris, code and carrier phase measurements from a GNSS reference receiver or network of receivers; +- *data increasing the position accuracy*: e.g. satellite code biases, satellite orbit corrections, satellite clock corrections, atmospheric models. RTK residuals, gradients. + +A UE with GNSS measurement capability may also operate in an autonomous (standalone) mode. In autonomous mode the UE determines its position based on signals received from GNSS without assistance from the network. + +## 8.1.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., assistance data, measurement data) that may be transferred between E-UTRAN elements. + +### 8.1.2.1 Information that may be transferred from the E-SMLC to UE + +Table 8.1.2.1-1 lists assistance data for both UE-assisted and UE-based modes that may be sent from the E-SMLC to the UE. + +NOTE: The provision of these assistance data elements and the usage of these elements by the UE depend on the E-UTRAN and UE capabilities, respectively. + +**Table 8.1.2.1-1: Information that may be transferred from the E-SMLC to UE** + +| <b>Assistance Data</b> | +|------------------------------------| +| Reference Time | +| Reference Location | +| Ionospheric Models | +| Earth Orientation Parameters | +| GNSS-GNSS Time Offsets | +| Differential GNSS Corrections | +| Ephemeris and Clock Models | +| Real-Time Integrity | +| Data Bit Assistance | +| Acquisition Assistance | +| Almanac | +| UTC Models | +| RTK Reference Station Information | +| RTK Auxiliary Station Data | +| RTK Observations | +| RTK Common Observation Information | +| GLONASS RTK Bias Information | +| RTK MAC Correction Differences | +| RTK Residuals | +| RTK FKP Gradients | +| SSR Orbit Corrections | +| SSR Clock Corrections | +| SSR Code Bias | +| SSR Phase Bias | +| SSR STEC Corrections | +| SSR Gridded Correction | +| SSR URA | +| SSR Correction Points | + +#### 8.1.2.1.1 Reference Time + +Reference Time assistance provides the GNSS receiver with coarse or fine GNSS time information. The specific GNSS system times (e.g., GPS, Galileo, GLONASS, BDS system time) shall be indicated with a GNSS ID. + +In case of coarse time assistance only, the Reference Time provides an estimate of the current GNSS system time (where the specific GNSS is indicated by a GNSS ID). The E-SMLC should achieve an accuracy of +/- 3 seconds for this time including allowing for the transmission delay between E-SMLC and UE. + +In case of fine time assistance, the Reference Time provides the relation between GNSS system time (where the specific GNSS is indicated by a GNSS ID) and E-UTRAN air-interface timing. + +#### 8.1.2.1.2 Reference Location + +Reference Location assistance provides the GNSS receiver with an a priori estimate of its location (e.g., obtained via Cell-ID, downlink positioning, etc.) together with its uncertainty. + +The geodetic reference frame shall be WGS-84, as specified in TS 23.032 [4]. + +#### 8.1.2.1.3 Ionospheric Models + +Ionospheric Model assistance provides the GNSS receiver with parameters to model the propagation delay of the GNSS signals through the ionosphere. Ionospheric Model parameters as specified by GPS [6], Galileo [9], QZSS [11], BDS [28], [34], and NavIC [35] may be provided. + +#### 8.1.2.1.4 Earth Orientation Parameters + +Earth Orientation Parameters (EOP) assistance provides the GNSS receiver with parameters needed to construct the ECEF-to-ECI coordinate transformation as specified by GPS [6]. + +#### 8.1.2.1.5 GNSS-GNSS Time Offsets + +GNSS-GNSS Time Offsets assistance provides the GNSS receiver with parameters to correlate GNSS time (where the specific GNSS is indicated by a GNSS-1 ID) of one GNSS with other GNSS time (where the specific GNSS is indicated by a GNSS-2 ID). GNSS-GNSS Time Offsets parameters as specified by GPS [6], Galileo [9], GLONASS [10], QZSS [11], BDS [28], [34], and NavIC [35] may be provided. + +#### 8.1.2.1.6 Differential GNSS Corrections + +Differential GNSS Corrections assistance provides the GNSS receiver with pseudo-range and pseudo-range-rate corrections to reduce biases in GNSS receiver measurements as specified in [13]. The specific GNSS for which the corrections are valid is indicated by a GNSS-ID. + +#### 8.1.2.1.7 Ephemeris and Clock Models + +Ephemeris and Clock Models assistance provides the GNSS receiver with parameters to calculate the GNSS satellite position and clock offsets. The various GNSSs use different model parameters and formats, and all parameter formats as defined by the individual GNSSs are supported by the signalling. + +#### 8.1.2.1.8 Real-Time Integrity + +Real-Time Integrity assistance provides the GNSS receiver with information about the health status of a GNSS constellation (where the specific GNSS is indicated by a GNSS ID). + +#### 8.1.2.1.9 Data Bit Assistance + +Data Bit Assistance provides the GNSS receiver with information about data bits or symbols transmitted by a GNSS satellite at a certain time (where the specific GNSS is indicated by a GNSS ID). This information may be used by the UE for sensitivity assistance (data wipe-off) and time recovery. + +#### 8.1.2.1.10 Acquisition Assistance + +Acquisition Assistance provides the GNSS receiver with information about visible satellites, reference time, expected code-phase, expected Doppler, search windows (i.e., code and Doppler uncertainty) and other information of the GNSS signals (where the specific GNSS is indicated by a GNSS ID) to enable a fast acquisition of the GNSS signals. + +#### 8.1.2.1.11 Almanac + +Almanac assistance provides the GNSS receiver with parameters to calculate the coarse (long-term) GNSS satellite position and clock offsets. The various GNSSs use different model parameters and formats, and all parameter formats as defined by the individual GNSSs are supported by the signalling. + +#### 8.1.2.1.12 UTC Models + +UTC Models assistance provides the GNSS receiver with parameters needed to relate GNSS system time (where the specific GNSS is indicated by a GNSS ID) to Universal Coordinated Time. The various GNSSs use different model parameters and formats, and all parameter formats as defined by the individual GNSSs are supported by the signalling. + +#### 8.1.2.1.13 RTK Reference Station Information + +RTK Reference Station Information provides the GNSS receiver with the Earth-Centered, Earth-Fixed (ECEF) coordinates of the Reference Station's installed antenna's ARP, and the height of the ARP above the survey monument. Additionally, this assistance data provides information about the antenna type installed at the reference site. + +NOTE: With the MAC N-RTK technique this assistance data is used to provide information regarding the Master Reference Station (see clause 8.1.2.1a). + +#### 8.1.2.1.14 RTK Auxiliary Station Data + +RTK Auxiliary Station Data provides the GNSS receiver with the location for all Auxiliary Reference Stations (see clause 8.1.2.1a) within the assistance data. These values are expressed as relative geodetic coordinates (latitude, longitude, and height) with respect to a Master Reference Station (see subclause 8.1.2.1a) and based on the GRS80 ellipsoid. This type of assistance data is relevant only with the MAC N-RTK technique [33]. + +#### 8.1.2.1.15 RTK Observations + +RTK Observations provides the GNSS receiver with all primary observables (pseudo-range, phase-range, phase-range rate (Doppler), and carrier-to-noise ratio) generated at the Reference Station for each GNSS signal. The signal generation from the reference station is in compliance with [33]: as an example, the phase measurements of different signals in the same band must be phased aligned. More examples can be found in [33]. + +The pseudo-range is the distance between the satellite and GNSS receiver antennas, expressed in metres, equivalent to the difference of the time of reception (expressed in the time frame of the GNSS receiver) and the time of transmission (expressed in the time frame of the satellite) of a distinct satellite signal. + +The phase-range measurement is a measurement of the range between a satellite and receiver expressed in units of cycles of the carrier frequency. This measurement is more precise than the pseudo-range (of the order of millimetres), but it is ambiguous by an unknown integer number of wavelengths. + +The phase-range rate is the rate at which the phase-range between a satellite and a GNSS receiver changes over a particular period of time. + +The carrier-to-noise ratio is the ratio of the received modulated carrier signal power to the noise power after the GNSS receiver filters. + +NOTE: With the MAC N-RTK technique this assistance data is used to provide raw observables recorded at the Master Reference Station (see clause 8.1.2.1a). + +#### 8.1.2.1.16 RTK Common Observation Information + +RTK Common Observation Information provides the GNSS receiver with common information applicable to any GNSS, e.g. clock steering indicator. This assistance data is always used together GNSS RTK Observations (see clause 8.1.2.1.15). + +#### 8.1.2.1.17 GLONASS RTK Bias Information + +RTK Bias Information provides the GNSS receiver with information which is intended to compensate for the first-order inter-frequency phase-range biases introduced by the reference receiver code-phase biases. This information is applicable only for GLONASS FDMA signals. In the case that the MAC Network RTK method is used, GLONASS RTK Bias Information defines the code-phase biases related to the Master Reference Station [33]. + +#### 8.1.2.1.18 RTK MAC Correction Differences + +RTK MAC Correction Differences provides the GNSS receiver with information about ionospheric (dispersive) and geometric (non-dispersive) corrections generated between a Master Reference Station and its Auxiliary Reference Stations [33]. + +#### 8.1.2.1.19 RTK Residuals + +RTK Residuals provides the GNSS receiver with network error models generated for the interpolated corrections disseminated in Network RTK techniques. With sufficient redundancy in the RTK network, the location server process can provide an estimate for residual interpolation errors. Such quality estimates may be used by the target UE to optimize the performance of RTK solutions. The values may be considered by the target UE as a priori estimates only, with sufficient tracking data available the target UE might be able to judge residual geometric and ionospheric errors itself. According to [33], RTK Residual error information should be transmitted every 10-60 seconds. + +#### 8.1.2.1.20 RTK FKP Gradients + +RTK FKP Gradients provides the GNSS receiver with horizontal gradients for the geometric (troposphere and satellite orbits) and ionospheric signal components in the observation space. According to [33], RTK FKP gradient information should be typically transmitted every 10-60 seconds. + +#### 8.1.2.1.21 SSR Orbit Corrections + +SSR Orbit Corrections provides the GNSS receiver with parameters for orbit corrections in radial, along – track and cross – track components. These orbit corrections are used to compute a satellite position correction, to be combined with satellite position calculated from broadcast ephemeris (see clause 8.1.2.1.7). + +NOTE 1: The orbit corrections define an offset between the broadcast ephemeris orbit and a satellite antenna reference point (ARP) to which the other corrections refer. The exact definition of the reference point along the satellite antenna is implementation-defined by the Network and use of all corrections together shall yield a consistent solution. + +NOTE 2: The UE should not apply any additional corrections for the Satellite Antenna Phase Center (APC) such as Phase Center Offset (PCO) or Phase Center Variation (PCV) corrections. The Network may form the SSR corrections to minimise the impact of Satellite APC effects on the UE. + +#### 8.1.2.1.22 SSR Clock Corrections + +SSR Clock Corrections provides the GNSS receiver with parameters to compute the GNSS satellite clock correction applied to the broadcast satellite clock (see clause 8.1.2.1.7). A polynomial of order 2 describes the clock differences for a certain time period: clock offset, drift, and drift rate. + +#### 8.1.2.1.23 SSR Code Bias + +SSR Code Bias provides the GNSS receiver with the Code Biases that must be added to the pseudo range measurements of the corresponding code signal to get corrected pseudo ranges. SSR Code Bias contains absolute values, but also enables the alternative use of Differential Code Biases by setting one of the biases to zero. A UE can consistently use signals for which a code bias is transmitted. It is not reliable for a UE to use a signal without retrieving a corresponding code bias from the assistance data message. + +#### 8.1.2.1.24 SSR Phase Bias + +SSR Phase Bias provides the GNSS receiver with the GNSS signal phase bias that are added to the carrier phase measurements of the corresponding signal to get corrected phase ranges. An indicator used to count events when phase bias is discontinuous is provided. An optional indicator is also provided to indicate whether fixed, widelane fixed or float PPP-RTK positioning modes are supported on a per signal basis. + +NOTE 1: On the UE side, phase bias corrections of appropriate type are needed to restore the integer nature of the phase ambiguities in PPP-RTK. Their absence will affect the quality of the positioning solution and prevent a fast convergence time. + +NOTE 2: PPP-RTK Fixed position mode corresponds to the UE fixing the carrier phase ambiguity to an integer value. The PPP-RTK Widelane Fixed positioning mode corresponds to forming the widelane combination of carrier phase measurements and fixing the resulting ambiguity as an integer value. In PPP-RTK Float positioning mode the carrier phase ambiguity is not treated as an integer value. + +NOTE 3: The SSR Phase Bias values must be consistent with a satellite yaw angle of zero as per [36]. + +#### 8.1.2.1.25 SSR STEC Corrections + +SSR STEC Corrections provides the GNSS receiver with the parameters to compute the ionosphere slant delay correction based on a variable order polynomial on a per satellite basis and applied to the code and phase measurements. + +#### 8.1.2.1.26 SSR Gridded Correction + +SSR Gridded Corrections provides the GNSS receiver with STEC residuals and Troposphere delays at a series of correction points and expressed as hydrostatic and wet vertical delays. + +NOTE: The final ionosphere slant delay (STEC) consists of the polynomial part provided in SSR STEC Correction and the residual part provided in SSR Gridded Corrections. + +#### 8.1.2.1.27 SSR URA + +SSR URA provides the receiver with information about the estimated accuracy of the corrections for each satellite. + +#### 8.1.2.1.28 SSR Correction Points + +The SSR Correction Points provides a list of correction point coordinates or an array of correction points ("grid") for which the SSR Gridded Corrections are valid. + +#### 8.1.2.1a Recommendations for grouping of assistance data to support different RTK service levels + +This clause provides recommendations for the different high-accuracy GNSS service levels: RTK, N-RTK, PPP and PPP-RTK. + +The high-accuracy GNSS methods can be classified as: + +- *Single base RTK service*: RTK is a technique that uses carrier-based ranging measurements i.e., phase-range to improve the positioning accuracy in a differential approach. The basic concept is to reduce and remove errors common to a Reference Station, with known position, and UE pair. When only pseudo ranges (code-based measurements) are used to compute the UE location, this method is known as DGNSS (Differential GNSS). + +**Table 8.1.2.1a-1: Single base RTK service: Specific information that may be transferred from the E-SMLC to the UE** + +| Assistance Data | +|--------------------------------------------------------------------| +| RTK Reference Station Information | +| RTK Observations | +| RTK Common Observation Information | +| GLONASS RTK Bias Information (if GLONASS data is transmitted) | +| Ephemeris and Clock (if UE did not acquire the navigation message) | + +- *Non-Physical Reference Station Network RTK service*: In this approach the target UE receives synthetic observations from a fictitious Reference Station. The Network RTK software at the location server is performing the error estimation and creates a virtual Reference Station close to the initial location of the target device (provided a priori to the location server). The target UE interprets and uses the data just as if it had come from a single, real Reference Station. Additionally, the target UE can also receive network information such as RTK Network Residuals (see clause 8.1.2.1.19) or even FKP gradients (see clause 8.1.2.1.20). + +**Table 8.1.2.1a-2: Non-Physical Reference Station Network RTK service: Specific information that may be transferred from the E-SMLC to the UE** + +| <b>Assistance Data</b> | +|--------------------------------------------------------------------| +| RTK Reference Station Information | +| RTK Observations | +| RTK Common Observation Information | +| GLONASS RTK Bias Information (if GLONASS data is transmitted) | +| RTK Residuals | +| RTK FKP Gradients | +| Ephemeris and Clock (if UE did not acquire the navigation message) | + +- *MAC Network RTK service:* In MAC network RTK, a group of Reference Stations are used and one of them is chosen as a Master station. The other stations are then called Auxiliary stations. In this service, the location server sends full raw observations and coordinate information for a single Reference Station, the Master Station. For all Auxiliary stations in the network (or a suitable subset of stations) the information is provided to the UE in a highly compact form: their reduced ambiguity-levelled observations, coordinate differences (to the Master Station observations and coordinates), and network residuals. Two Reference Stations are said to be on a common ambiguity level if the integer ambiguities for each phase range (satellite-receiver pair) have been removed (or adjusted) so that the integer ambiguities cancel when double-differences (involving two receivers and two satellites) are formed during processing. The maintenance of a common ambiguity level at a specific set of stations rather than across the whole GNSS network will lead to a grouping in network clusters or subnetworks of all ambiguity-levelled Reference Stations. If one network has only one subnetwork, this indicates that an ambiguity level throughout the whole network is established. When subnetworks are predefined, the assistance data can be broadcast to all UEs located in the assigned sub-network. More details on the usage of subnetworks can be found in [33]. + +**Table 8.1.2.1a-3: MAC Network RTK service: Specific Information that may be transferred from the E-SMLC to the UE** + +| <b>Assistance Data</b> | +|--------------------------------------------------------------------| +| RTK Reference Station Information | +| RTK Auxiliary Station Data | +| RTK Observations | +| RTK Common Observation Information | +| GLONASS RTK Bias Information (if GLONASS data is transmitted) | +| RTK MAC Correction Differences | +| RTK Residuals | +| Ephemeris and Clock (if UE did not acquire the navigation message) | + +- *FKP Network RTK service:* With the concept of FKP, horizontal gradients of distance-dependent errors like ionosphere, troposphere and orbits are derived from a network of GNSS Reference Stations and transmitted to a target device together with raw or correction data of a corresponding Reference Station (physical or non-physical). The target UE may use the gradients to compute the effect of the distance-dependent errors for its own position. + +**Table 8.1.2.1a-4: FKP Network RTK service: Information that may be transferred from the E-SMLC to the UE** + +| <b>Assistance Data</b> | +|--------------------------------------------------------------------| +| RTK Reference Station Information | +| RTK Observations | +| RTK Common Observation Information | +| GLONASS RTK Bias Information (if GLONASS data is transmitted) | +| RTK Residuals | +| RTK FKP Gradients | +| Ephemeris and Clock (if UE did not acquire the navigation message) | + +- *PPP service*: This concept uses precise satellite orbit and clock parameters derived from global networks of Reference Stations as well as atmospheric models to perform single station positioning [33]. Compared to RTK and Network RTK, PPP is not a differential technique as there is no baseline limitation. When the orbits and clocks assistance data elements are provided in real-time, with no latency, the method is called Real-Time PPP. + +**Table 8.1.2.1a-5: SSR PPP service: Information that may be transferred from the E-SMLC to the UE** + +| <b>Assistance Data</b> | +|--------------------------------------------------------------------| +| SSR Orbit Corrections | +| SSR Clock corrections | +| SSR Code Bias | +| Ephemeris and Clock (if UE did not acquire the navigation message) | + +- *PPP-RTK service*: This concept uses precise satellite orbits and clock parameters, the satellite signal biases derived from global networks of Reference Stations as well as ionosphere and troposphere corrections to perform single station positioning [36]. Therefore, PPP-RTK services compensate the global and local corrections for a more accurate location information. Compared to PPP, PPP-RTK requires the UE to be located within the region covered by the ionosphere and troposphere corrections. + +**Table 8.1.2.1a-6: SSR PPP-RTK service: Information that may be transferred from the E-SMLC to the UE** + +| <b>Assistance Data</b> | +|--------------------------------------------------------------------| +| SSR Orbit Corrections | +| SSR Clock corrections | +| SSR Code Bias | +| Ephemeris and Clock (if UE did not acquire the navigation message) | +| SSR Phase Bias | +| SSR STEC Corrections | +| SSR Gridded Correction | +| SSR URA | +| SSR Correction Points | + +## 8.1.2.2 Information that may be transferred from the UE to the E-SMLC + +The information that may be signalled from the UE to the E-SMLC is listed in table 8.1.2.2-1. + +**Table 8.1.2.2-1: Information that may be transferred from the UE to the E-SMLC** + +| Information | UE-assisted | UE-based/<br>standalone | +|--------------------------------------------------------------------------------------|-------------|-------------------------| +| Latitude/Longitude/Altitude, together with uncertainty shape | No | Yes | +| Velocity, together with uncertainty shape | No | Yes | +| Reference Time, possibly together with GNSS-E-UTRAN time association and uncertainty | Yes | Yes | +| Indication of used positioning methods in the fix | No | Yes | +| Code phase measurements, also called pseudorange | Yes | No | +| Doppler measurements | Yes | No | +| Carrier phase measurements, also called Accumulated Delta Range (ADR) | Yes | No | +| Carrier-to-noise ratio of the received signal | Yes | No | +| Measurement quality parameters for each measurement | Yes | No | +| Additional, non-GNSS related measurement information | Yes | No | + +#### 8.1.2.2.1 GNSS Measurement Information + +The GNSS measurement information reported from the UE to the E-SMLC depends on the GNSS mode (i.e., UE-based, autonomous (standalone), or UE-assisted). + +##### 8.1.2.2.1.1 UE-based mode + +In UE-based or standalone mode, the GNSS receiver reports the latitude, longitude and possibly altitude, together with an estimate of the location uncertainty, if available. + +If requested by the E-SMLC and supported by the UE, the GNSS receiver may report its velocity, possibly together with an estimate of the uncertainty, if available. + +If requested by the E-SMLC and supported by the UE, the GNSS receiver may report the relation between GNSS system time (where the specific GNSS is indicated by a GNSS ID; the specific GNSS system time may be selected by the UE) and E-UTRAN air-interface timing. This information may be used by the E-SMLC to assist other UEs in the network. + +The UE should also report an indication of which GNSSs and possibly other location methods have been used to calculate a fix. + +##### 8.1.2.2.1.2 UE-assisted mode + +In UE-assisted mode, the GNSS receiver reports the Code Phase and Doppler measurements together with associated quality estimates. These measurements enable the E-SMLC to calculate the location of the UE, possibly using other measurements and data. + +If requested by the E-SMLC and supported by the UE, the GNSS receiver may report Carrier Phase measurements (also called Accumulated Delta Range), together with associated quality measurements, if available. + +If requested by the E-SMLC and supported by the UE, the GNSS receiver may report the relation between GNSS system time (where the specific GNSS is indicated by a GNSS ID; the specific GNSS system time may be selected by the UE) and E-UTRAN air-interface timing. This information may be used by the E-SMLC to assist other UEs in the network. + +#### 8.1.2.2.2 Additional Non-GNSS Related Information + +Additional non-GNSS measurements performed by E-UTRAN or UE may be used by the E-SMLC or UE to calculate or verify a location estimate. This information may include downlink positioning measurements, path loss and signal strength related measurements, etc. + +### 8.1.3 Assisted-GNSS Positioning Procedures + +#### 8.1.3.1 Capability Transfer Procedure + +The Capability Transfer procedure for Assisted-GNSS positioning is described in clause 7.1.2.1. + +##### 8.1.3.1.1 Void + +#### 8.1.3.2 Assistance Data Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to provide assistance data to the UE (e.g., as part of a positioning procedure) and the UE to request assistance data from the E-SMLC (e.g., as part of a positioning procedure or for autonomous self location (i.e., UE determines its own location)). In the case of high-accuracy GNSS positioning techniques (e.g., RTK), the E-SMLC can provide unsolicited periodic assistance data to the UE and the UE can request periodic assistance data from the E-SMLC. + +##### 8.1.3.2.1 E-SMLC initiated Assistance Data Delivery + +Figure 8.1.3.2.1-1 shows the Assistance Data Delivery operations for the network-assisted GNSS method when the procedure is initiated by the E-SMLC. + +![Sequence diagram showing E-SMLC initiated Assistance Data Delivery. The diagram features two vertical lifelines: UE on the left and E-SMLC on the right. A single message arrow points from the E-SMLC lifeline to the UE lifeline, labeled '1. LPP Provide Assistance Data'.](f5d2a88925807080157c7cfb1d41cf0b_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note right of E-SMLC: 1. LPP Provide Assistance Data + E-SMLC->>UE: 1. LPP Provide Assistance Data +``` + +Sequence diagram showing E-SMLC initiated Assistance Data Delivery. The diagram features two vertical lifelines: UE on the left and E-SMLC on the right. A single message arrow points from the E-SMLC lifeline to the UE lifeline, labeled '1. LPP Provide Assistance Data'. + +**Figure 8.1.3.2.1-1: E-SMLC-initiated Assistance Data Delivery Procedure** + +- (1) The E-SMLC determines that assistance data needs to be provided to the UE (e.g., as part of a positioning procedure) and sends an LPP Provide Assistance Data message to the UE. This message may include any of the GNSS assistance data defined in clause 8.1.2.1. + +##### 8.1.3.2.1a E-SMLC initiated Periodic Assistance Data Delivery + +The Periodic Assistance Data Delivery procedure allows the server to provide unsolicited periodic assistance data to the target and is shown in Figure 8.1.3.2.1a-1. + +NOTE: In this version of the specification, periodic assistance data delivery is supported for HA GNSS (e.g., RTK) positioning only. + +![Sequence diagram for LPP Periodic Assistance data delivery procedure. The diagram shows two lifelines: UE and E-SMLC. The E-SMLC sends three messages to the UE: 1. LPP Provide Assistance Data (Control Transaction), 2. LPP Provide Assistance Data (Data Transaction), and 3. LPP Provide Assistance Data (Data Transaction). The first message is a solid line, while the second and third are dashed lines. Brackets on the right side of the E-SMLC lifeline group the first message as 'Control Transaction' and the second and third as 'Data Transaction'.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +Sequence diagram for LPP Periodic Assistance data delivery procedure. The diagram shows two lifelines: UE and E-SMLC. The E-SMLC sends three messages to the UE: 1. LPP Provide Assistance Data (Control Transaction), 2. LPP Provide Assistance Data (Data Transaction), and 3. LPP Provide Assistance Data (Data Transaction). The first message is a solid line, while the second and third are dashed lines. Brackets on the right side of the E-SMLC lifeline group the first message as 'Control Transaction' and the second and third as 'Data Transaction'. + +**Figure 8.1.3.2.1a-1: LPP Periodic Assistance data delivery procedure** + +- (1) The E-SMLC determines that assistance data needs to be provided to the UE and sends an LPP Provide Assistance Data message to the UE. This message includes information to identify the type of periodic assistance data and a duration for ending the assistance data delivery. +- (2) When the first periodic message is available, the E-SMLC sends an unsolicited LPP Provide Assistance Data message to the UE containing the periodic assistance data announced in step (1). +- (3) The server may continue to send further LPP Provide Assistance Data messages to the target containing the periodic assistance data announced in step (1) when each additional periodicity condition occurs. When the duration for ending the periodic assistance data transfer occurs, the last LPP Provide Assistance Data message transferred indicates the end of transaction. Additionally, the session can be ended on request by the UE or by the E-SMLC with the help of an Abort message. + +#### 8.1.3.2.2 UE initiated Assistance Data Transfer + +Figure 8.1.3.2.2-1 shows the Assistance Data Transfer operations for the network-assisted GNSS method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Assistance Data Transfer Procedure. The diagram shows two lifelines: UE and E-SMLC. The UE sends a message '1. LPP Request Assistance Data' to the E-SMLC. The E-SMLC responds with '2. LPP Provide Assistance Data' to the UE. Both messages are represented by solid lines.](605ad256780bc1b6022dfb65a6e24a3b_img.jpg) + +Sequence diagram for UE-initiated Assistance Data Transfer Procedure. The diagram shows two lifelines: UE and E-SMLC. The UE sends a message '1. LPP Request Assistance Data' to the E-SMLC. The E-SMLC responds with '2. LPP Provide Assistance Data' to the UE. Both messages are represented by solid lines. + +**Figure 8.1.3.2.2-1: UE-initiated Assistance Data Transfer Procedure** + +- (1) The UE determines that certain A-GNSS assistance data are desired (e.g., in case the UE requires its own location with autonomous self location or as part of a positioning procedure when the E-SMLC provided assistance data are not sufficient for the UE to fulfill the request) and sends a LPP Request Assistance Data message to the E-SMLC. This request includes an indication of which specific A-GNSS assistance data are requested for each GNSS, possibly together with additional information (e.g., for which GNSS signal types, or + +satellites, or times the assistance is requested, etc.). Additional information concerning the UE's approximate location and serving and neighbour cells may also be provided in the Request Assistance Data message and/or in an accompanying Provide Location Information message to help the E-SMLC provide appropriate assistance data. This additional data may include the UE's last known location if available, the cell IDs of the UE serving eNodeB and possibly neighbour eNodeBs, as well as E-CID measurements. + +- (2) The E-SMLC provides the requested assistance data in a LPP Provide Assistance Data message, if available at the E-SMLC. The entire set of assistance data may be delivered in one or several LPP messages, e.g., one message per GNSS. In this case, this step may be repeated by the E-SMLC several times. If any of the UE requested assistance data in step (1) are not provided in step 2, the UE shall assume that the requested assistance data are not supported, or currently not available at the E-SMLC. If none of the UE requested assistance data in step (1) can be provided by the E-SMLC, return any information that can be provided in an LPP message of type Provide Assistance Data which includes a cause indication for the not provided assistance data. + +#### 8.1.3.2.2a UE initiated Periodic Assistance Data Transfer + +Figure 8.1.3.2.2a-1 shows the Periodic Assistance Data Transfer operations for the high-accuracy GNSS methods (e.g., RTK) when the procedure is initiated by the UE. + +NOTE: In this version of the specification, periodic assistance data transfer is supported for HA GNSS (e.g., RTK) positioning only. + +![Sequence diagram of UE-initiated Periodic Assistance Data Transfer Procedure](71b0a68b4dd64961465d2b0e790538de_img.jpg) + +The diagram illustrates the interaction between a User Equipment (UE) and an E-SMLC. The sequence of messages is as follows: + +1. The UE sends an **LPP Request Assistance Data** message to the E-SMLC. This message is part of the **Control Transaction**. +2. The E-SMLC responds with an **LPP Provide Assistance Data** message to the UE. This message is also part of the **Control Transaction**. +3. The E-SMLC provides unsolicited assistance data in an **LPP Provide Assistance Data** message to the UE. This message is part of the **Data Transaction**. +4. The E-SMLC may transmit one or more additional **LPP Provide Assistance Data** messages to the UE. These messages are part of the **Data Transaction** and are shown with dashed arrows. + +Sequence diagram of UE-initiated Periodic Assistance Data Transfer Procedure + +**Figure 8.1.3.2.2a-1: UE-initiated Periodic Assistance Data Transfer Procedure** + +- (1) The UE determines that certain periodic A-GNSS assistance data, specific to one or more RTK-service levels, are desired and sends a LPP Request Assistance Data message to the E-SMLC. This request includes an indication of which specific A-GNSS assistance data are requested for each GNSS. Additional information like desired periodicity for sending the assistance data and a duration for ending the periodic session shall also be provided in the LPP Request Assistance Data message. +- (2) The E-SMLC responds with a LPP Provide Assistance Data message to the UE. If the UE request can be supported, the message contains information which may confirm or redefine the type of assistance data or periodicity parameters requested at step (1). This response indicates the end of the control transaction. +- (3) When available, the E-SMLC provides unsolicited the requested assistance data in a LPP Provide Assistance Data message to the UE. If any of the requested assistance data in step (1) or redefined in step (2) are not provided in step (3), the UE shall assume that the requested assistance data are not supported, or currently not available at the E-SMLC. +- (4) The E-SMLC may transmit one or more additional LPP Provide Assistance Data messages to the UE containing further periodic assistance data confirmed or redefined in step (2). When the duration for ending the periodic assistance data transfer occur, the last LPP Provide Assistance Data message transferred indicates the end of the + +transaction. Additionally, the session can be ended on request by the UE or by the E-SMLC with the help of an Abort message. + +### 8.1.3.3 Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements or location estimate from the UE, or to enable the UE to provide location measurements to the E-SMLC for position calculation (e.g., in case of basic self location where the UE requests its own location). + +#### 8.1.3.3.1 E-SMLC initiated Location Information Transfer Procedure + +Figure 8.1.3.3.1-1 shows the Location Information Transfer operations for the network-assisted GNSS method when the procedure is initiated by the E-SMLC. + +![Sequence diagram showing the E-SMLC-initiated Location Information Transfer Procedure. The diagram consists of two vertical lifelines: UE on the left and E-SMLC on the right. Step 1: A horizontal arrow points from the E-SMLC lifeline to the UE lifeline, labeled '1. LPP Request Location Information'. Step 2: A horizontal arrow points from the UE lifeline to the E-SMLC lifeline, labeled '2. LPP Provide Location Information'.](65d47e1d0e5982c00e9bd116b89e2b6a_img.jpg) + +Sequence diagram showing the E-SMLC-initiated Location Information Transfer Procedure. The diagram consists of two vertical lifelines: UE on the left and E-SMLC on the right. Step 1: A horizontal arrow points from the E-SMLC lifeline to the UE lifeline, labeled '1. LPP Request Location Information'. Step 2: A horizontal arrow points from the UE lifeline to the E-SMLC lifeline, labeled '2. LPP Provide Location Information'. + +**Figure 8.1.3.3.1-1: E-SMLC-initiated Location Information Transfer Procedure** + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of A-GNSS positioning. This request includes positioning instructions such as the GNSS mode (UE-assisted, UE-based, UE-based preferred but UE-assisted allowed, UE-assisted preferred, but UE-based allowed, standalone), positioning methods (GPS, Galileo, GLONASS, BDS, NavIC, etc. and possibly non-GNSS methods, such as downlink positioning or E-CID), specific UE measurements requested if any, such as fine time assistance measurements, velocity, carrier phase, multi-frequency measurements, and quality of service parameters (accuracy, response time). +- (2) The UE performs the requested measurements and possibly calculates its own location. The UE sends an LPP Provide Location Information message to the E-SMLC before the Response Time provided in step (1) elapsed. If the UE is unable to perform the requested measurements, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +#### 8.1.3.3.2 UE-initiated Location Information Delivery Procedure + +Figure 8.1.3.3.2-1 shows the Location Information delivery operations for the UE-assisted GNSS method when the procedure is initiated by the UE. + +![Sequence diagram showing the UE-initiated Location Information Delivery Procedure. A UE box on the left sends a message labeled '1. LPP Provide Location Information' to an E-SMLC box on the right.](7ed5d5770331f31ade15439a21c31425_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + UE->>E-SMLC: 1. LPP Provide Location Information + Note right of E-SMLC: +``` + +Sequence diagram showing the UE-initiated Location Information Delivery Procedure. A UE box on the left sends a message labeled '1. LPP Provide Location Information' to an E-SMLC box on the right. + +**Figure 8.1.3.3.2-1: UE-initiated Location Information Delivery Procedure** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include any UE measurements (GNSS pseudo-ranges, carrier phase-ranges, and other measurements) already available at the UE. + +## 8.2 Downlink positioning method + +### 8.2.1 General + +In the downlink positioning method, the UE position is estimated based on measurements taken at the UE of downlink radio signals from multiple TPs (possibly including PRS-only TPs from a PRS-based TBS), along with knowledge of the geographical coordinates of the measured TPs and their relative downlink timing. + +The specific positioning techniques used to estimate the UE's location from this information are beyond the scope of this specification. + +### 8.2.2 Transferred information + +This clause defines the information that may be transferred between E-SMLC and UE/eNodeB. + +#### 8.2.2.1 Assistance Data that may be transferred from the E-SMLC to UE + +The following assistance data may be transferred from the E-SMLC to the UE: + +- Physical cell IDs (PCIs), global cell IDs (GCIs), and TP IDs of candidate TPs for measurement; +- Timing relative to the serving (reference) TP of candidate TPs; +- PRS configuration of candidate TPs. + +#### 8.2.2.2 Assistance Data that may be transferred from the eNodeB to E-SMLC + +The following assistance data may be transferred from the eNodeB to the E-SMLC: + +- PCI, GCI, and TP IDs of the TPs served by the eNodeB; +- Timing information of TPs served by the eNodeB; +- PRS configuration of the TPs served by the eNodeB; +- Geographical coordinates of the TPs served by the eNodeB. + +An eNodeB may provide assistance data relating only to itself and served TPs via LPPa signalling, although assistance data from several eNodeBs and served TPs may be acquired through other mechanisms, see NOTE below. + +**NOTE:** The assistance data described in this clause are not necessarily transferred only from the eNodeB, and in some deployment options may not be delivered from the eNodeB at all; they may also be delivered to the E-SMLC through OA&M or other mechanisms external to the E-UTRAN. In addition, in cases where assistance data are delivered from the eNodeB, how the eNodeB acquires the data is outside the scope of this specification. + +### 8.2.2.3 Location Information that may be transferred from the UE to E-SMLC + +The information that may be signalled from UE to the E-SMLC is listed in Table 8.2.2.3-1. The individual UE measurements are defined in TS 36.214 [20]. + +**Table 8.2.2.3-1: Information that may be transferred from UE to the E-SMLC** + +| Information | Measurements | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| Downlink Measurement Results List for EUTRA | Physical cell IDs | +| | Global cell IDs | +| | TP IDs | +| | Downlink timing measurements | +| Information used to compute a reference time corresponding to the downlink timing measurements to allow correlation of downlink timing measurements with motion information independently obtained from motion sensors | Delta SFN for each neighbour cell | + +## 8.2.3 Downlink Positioning Procedures + +The procedures described in this clause support downlink positioning measurements obtained by the UE and provided to the E-SMLC using LPP, or obtained by the eNode B and provided to the E-SMLC using LPPa. + +In this version of the specification only the UE-assisted downlink positioning is supported. + +### 8.2.3.1 Capability Transfer Procedure + +The Capability Transfer procedure for Downlink positioning is described in clause 7.1.2.1. + +#### 8.2.3.1.1 Void + +### 8.2.3.2 Assistance Data Transfer Procedure + +#### 8.2.3.2.1 Assistance Data Transfer between E-SMLC and UE + +The purpose of this procedure is to enable the E-SMLC to provide assistance data to the UE (e.g., as part of a positioning procedure) and the UE to request assistance data from the E-SMLC (e.g., as part of a positioning procedure or for autonomous self location (i.e., UE determines its own location)). + +##### 8.2.3.2.1.1 E-SMLC-initiated assistance data delivery + +Figure 8.2.3.2.1.1-1 shows the Assistance Data Delivery operations for the downlink positioning method when the procedure is initiated by the E-SMLC. + +![Sequence diagram showing E-SMLC-initiated Assistance Data Delivery Procedure. The diagram shows two vertical lifelines: UE on the left and E-SMLC on the right. A horizontal arrow labeled '1. LPP Provide Assistance Data' points from the E-SMLC lifeline to the UE lifeline.](b747a2f65746d5a5fb6c0a4da10a5f3d_img.jpg) + +``` + +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + Note right of E-SMLC: + E-SMLC->>UE: 1. LPP Provide Assistance Data + +``` + +Sequence diagram showing E-SMLC-initiated Assistance Data Delivery Procedure. The diagram shows two vertical lifelines: UE on the left and E-SMLC on the right. A horizontal arrow labeled '1. LPP Provide Assistance Data' points from the E-SMLC lifeline to the UE lifeline. + +**Figure 8.2.3.2.1.1-1: E-SMLC-initiated Assistance Data Delivery Procedure** + +- (1) The E-SMLC determines that assistance data needs to be provided to the UE (e.g., as part of a positioning procedure) and sends an LPP Provide Assistance Data message to the UE. This message may include any of the downlink positioning assistance data defined in clause 8.2.2.1. + +#### 8.2.3.2.1.2 UE-initiated assistance data transfer + +Figure 8.2.3.2.1.2-1 shows the Assistance Data Transfer operations for the downlink positioning method when the procedure is initiated by the UE. + +![Sequence diagram showing UE-initiated Assistance Data Transfer Procedure. The diagram illustrates two steps: 1. LPP Request Assistance Data from UE to E-SMLC, and 2. LPP Provide Assistance Data from E-SMLC to UE.](4842f073775fb1e84d101c02fd74e59e_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: UE determines assistance data is desired + UE->>E-SMLC: 1. LPP Request Assistance Data + Note right of E-SMLC: E-SMLC provides requested assistance + E-SMLC-->>UE: 2. LPP Provide Assistance Data +``` + +Sequence diagram showing UE-initiated Assistance Data Transfer Procedure. The diagram illustrates two steps: 1. LPP Request Assistance Data from UE to E-SMLC, and 2. LPP Provide Assistance Data from E-SMLC to UE. + +**Figure 8.2.3.2.1.2-1: UE-initiated Assistance Data Transfer Procedure** + +- (1) The UE determines that certain downlink positioning assistance data are desired (e.g., in case the UE requires its own location with autonomous self location, or as part of a positioning procedure when the E-SMLC-provided assistance data are not sufficient for the UE to fulfill the request) and sends an LPP Request Assistance Data message to the E-SMLC. This request includes an indication of which specific downlink assistance data are requested. Additional information concerning the UE's approximate location and serving and neighbour cells may also be provided in the Request Assistance Data message and/or in an accompanying Provide Location Information message to help the E-SMLC provide appropriate assistance data. This additional data may include the UE's last known location if available, the cell IDs of the UE serving eNodeB and possibly neighbour eNodeBs, as well as E-CID measurements. +- (2) The E-SMLC provides the requested assistance in an LPP Provide Assistance Data message, if available at the E-SMLC. If any of the UE requested assistance data in step (1) are not provided in step 2, the UE shall assume that the requested assistance data are not supported, or currently not available at the E-SMLC. If none of the UE requested assistance data in step (1) can be provided by the E-SMLC, return any information that can be provided in an LPP message of type Provide Assistance Data which includes a cause indication for the not provided assistance data. + +#### 8.2.3.2.2 Assistance Data Delivery between E-SMLC and eNodeB + +The purpose of this procedure is to enable the eNodeB to provide assistance data to the E-SMLC, for subsequent delivery to the UE using the procedures of clause 8.2.3.2.1 or for use in the calculation of positioning estimates at the E-SMLC. + +##### 8.2.3.2.2.1 Void + +##### 8.2.3.2.2.2 E-SMLC-initiated assistance data delivery to the E-SMLC + +Figure 8.2.3.2.2.2-1 shows the Assistance Data Delivery operation from the eNodeB to the E-SMLC for the downlink positioning method, in the case that the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Assistance Data Delivery Procedure. It shows two steps: (1) E-SMLC sends an LPPa Message (Type: OTDOA INFORMATION REQUEST) to eNode B; (2) eNode B sends an LPPa Message (Type: OTDOA INFORMATION RESPONSE/FAILURE) back to E-SMLC.](b34c69e1ec326b01c3a485b27b1df5f6_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant eNode B + Note left of eNode B: (1) + E-SMLC->>eNode B: LPPa Message(Type: OTDOA INFORMATION REQUEST) + Note left of eNode B: (2) + eNode B->>E-SMLC: LPPa Message(Type: OTDOA INFORMATION RESPONSE/FAILURE) +``` + +Sequence diagram for E-SMLC-initiated Assistance Data Delivery Procedure. It shows two steps: (1) E-SMLC sends an LPPa Message (Type: OTDOA INFORMATION REQUEST) to eNode B; (2) eNode B sends an LPPa Message (Type: OTDOA INFORMATION RESPONSE/FAILURE) back to E-SMLC. + +**Figure 8.2.3.2.2.2-1: E-SMLC-initiated Assistance Data Delivery Procedure** + +- (1) The E-SMLC determines that certain downlink positioning assistance data are desired (e.g., as part of a periodic update or as triggered by OAM) and sends an LPPa OTDOA INFORMATION REQUEST message to the eNode B. This request includes an indication of which specific downlink assistance data are requested. +- (2) The eNode B provides the requested assistance in an LPPa OTDOA INFORMATION RESPONSE message, if available at the eNode B. If the eNode B is not able to provide any information, it returns an OTDOA INFORMATION FAILURE message indicating the cause of the failure. + +### 8.2.3.3 Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements from the UE, or to enable the UE to provide location measurements to the E-SMLC for position calculation (e.g., in case of basic self location where the UE requests its own location). + +#### 8.2.3.3.1 E-SMLC-initiated Location Information Transfer + +Figure 8.2.3.3.1-1 shows the Location Information Transfer operations for the downlink positioning method when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure. It shows two steps: (1) E-SMLC sends an LPP Request Location Information message to UE; (2) UE sends an LPP Provide Location Information message back to E-SMLC.](87b70d2e8951032d28b4412d82cf1413_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note right of E-SMLC: 1. LPP Request Location Information + E-SMLC->>UE: 1. LPP Request Location Information + Note right of UE: 2. LPP Provide Location Information + UE->>E-SMLC: 2. LPP Provide Location Information +``` + +Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure. It shows two steps: (1) E-SMLC sends an LPP Request Location Information message to UE; (2) UE sends an LPP Provide Location Information message back to E-SMLC. + +**Figure 8.2.3.3.1-1: E-SMLC-initiated Location Information Transfer Procedure** + +- (1) The E-SMLC sends an LPP Request Location Information message to the UE. This request includes indication of downlink measurements requested, including any needed measurement configuration information, and required response time. +- (2) The UE obtains downlink measurements as requested in step 1. The UE then sends an LPP Provide Location Information message to the E-SMLC, before the Response Time provided in step (1) elapsed, and includes the obtained downlink measurements. If the UE is unable to perform the requested measurements, or the Response Time elapsed before any of the requested measurements were obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +#### 8.2.3.3.2 UE-initiated Location Information Delivery procedure + +Figure 8.2.3.3.2-1 shows the Location Information Delivery procedure operations for the downlink positioning method when the procedure is initiated by the UE. + +![Diagram of UE-initiated Location Information Delivery Procedure. A box labeled 'UE' on the left has a vertical line extending downwards. A box labeled 'E-SMLC' on the right has a vertical line extending downwards. A horizontal arrow points from the vertical line of the UE to the vertical line of the E-SMLC, labeled '1. LPP Provide Location Information'.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +Diagram of UE-initiated Location Information Delivery Procedure. A box labeled 'UE' on the left has a vertical line extending downwards. A box labeled 'E-SMLC' on the right has a vertical line extending downwards. A horizontal arrow points from the vertical line of the UE to the vertical line of the E-SMLC, labeled '1. LPP Provide Location Information'. + +**Figure 8.2.3.3.2-1: UE-initiated Location Information Delivery Procedure.** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include any UE downlink measurements already available at the UE. + +## 8.3 Enhanced cell ID positioning methods + +### 8.3.1 General + +In the Cell ID (CID)-based method, the UE position is estimated with the knowledge of the geographical coordinates of its serving eNodeB. Enhanced Cell ID (E-CID) positioning refers to techniques which use additional UE and/or E-UTRAN radio resource related measurements to improve the UE location estimate. For E-UTRAN access, these measurements may include [20, 21]: + +UE measurements (TS 36.214 [20], TS 36.302 [21]): + +- Reference signal received power (RSRP); +- Reference Signal Received Quality (RSRQ); +- UE Rx – Tx time difference; +- GERAN RSSI; +- UTRAN CPICH RSCP; +- UTRAN CPICH Ec/Io; +- WLAN RSSI. + +E-UTRAN measurements (TS 36.214 [20], TS 36.302 [21]): + +- eNB Rx – Tx time difference +- Timing Advance ( $T_{ADV}$ ): + - Type1: $T_{ADV} = (\text{eNB Rx – Tx time difference}) + (\text{UE Rx – Tx time difference})$ + - Type2: $T_{ADV} = \text{eNB Rx – Tx time difference}$ ; +- Angle of Arrival (AoA). + +Various techniques exist to use these measurements to estimate the location of the UE. The specific techniques are beyond the scope of this specification. + +### 8.3.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., measurement data) that may be transferred between E-UTRAN elements. + +#### 8.3.2.1 Information that may be transferred from the E-SMLC to UE + +UE-assisted Enhanced Cell-ID location does not require any assistance data to be transferred from the E-SMLC to the UE. + +UE-Based Enhanced Cell-ID location is not supported in this version of the specification. + +### 8.3.2.2 Information that may be transferred from the UE to E-SMLC + +The information that may be signalled from UE to the E-SMLC is listed in table 8.3.2.2-1. + +**Table 8.3.2.2-1: Information that may be transferred from UE to the E-SMLC** + +| Information | UE-assisted | +|--------------------------------------------------------|-------------| +| Evolved Cell Global Identifier (ECGI)/Physical Cell ID | Yes | +| Reference signal received power (RSRP) | Yes | +| Reference Signal Received Quality (RSRQ) | Yes | +| UE Rx – Tx time difference | Yes | + +### 8.3.2.3 Information that may be transferred from the eNodeB to E-SMLC + +The information that may be signalled from eNodeB to the E-SMLC is listed in table 8.3.2.3-1. + +**Table 8.3.2.3-1: Information that may be transferred from eNB to the E-SMLC** + +| Information | +|----------------------------------------------------------| +| Timing Advance (T <sub>ADV</sub> ) | +| Angle of Arrival (AoA) | +| E-UTRA Measurement Results List: | +| - Evolved Cell Global Identifier (ECGI)/Physical Cell ID | +| - Reference signal received power (RSRP) | +| - Reference Signal Received Quality (RSRQ) | +| GERAN Measurement Results List: | +| - Base Station Identity Code (BSIC) | +| - ARFCN of Base Station Control Channel (BCCH) | +| - Received Signal Strength Indicator (RSSI) | +| UTRA Measurement Results List: | +| - UTRAN Physical ID | +| - Common Pilot Channel Received Signal Code Power (RSCP) | +| - Common Pilot Channel Ec/Io | +| WLAN Measurement Results List: | +| - WLAN Received Signal Strength Indicator (RSSI) | +| - SSID | +| - BSSID | +| - HESSID | +| - Operating Class | +| - Country Code | +| - WLAN Channel(s) | +| - WLAN Band | + +## 8.3.3 Downlink E-CID Positioning Procedures + +The procedures described in this clause support E-CID related measurements obtained by the UE and provided to the E-SMLC using LPP. The term "downlink" is intended to indicate that from the E-SMLC perspective the involved measurements are provided by the UE; this set of procedures might also be considered as "UE-assisted, E-SMLC-based E-CID". + +### 8.3.3.1 Capability Transfer Procedure + +The Capability Transfer procedure for E-CID positioning is described in clause 7.1.2.1. + +#### 8.3.3.1.1 Void + +### 8.3.3.2 Assistance Data Delivery Procedure + +Assistance data delivery is not required for UE- or eNB-assisted forms of E-CID positioning. + +### 8.3.3.3 Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements from the UE, or to enable the UE to provide location measurements to the E-SMLC for position calculation (e.g., in case of basic self location where the UE requests its own location). + +#### 8.3.3.3.1 E-SMLC-initiated Location Information Transfer + +Figure 8.3.3.3.1-1 shows the Location Information Transfer operations for the E-CID method when the procedure is initiated by the E-SMLC. + +![Sequence diagram showing E-SMLC-initiated Location Information Transfer. The diagram has two lifelines: UE and E-SMLC. Step 1: E-SMLC sends '1. LPP Request Location Information' to UE. Step 2: UE sends '2. LPP Provide Location Information' to E-SMLC.](a97f7c055c1fd8d79037d02b3fc38496_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant UE + Note right of E-SMLC: 1. LPP Request Location Information + E-SMLC->>UE: 1. LPP Request Location Information + Note left of UE: 2. LPP Provide Location Information + UE->>E-SMLC: 2. LPP Provide Location Information +``` + +Sequence diagram showing E-SMLC-initiated Location Information Transfer. The diagram has two lifelines: UE and E-SMLC. Step 1: E-SMLC sends '1. LPP Request Location Information' to UE. Step 2: UE sends '2. LPP Provide Location Information' to E-SMLC. + +**Figure 8.3.3.3.1-1: E-SMLC-initiated Location Information Transfer Procedure.** + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of E-CID positioning. This request includes the E-CID measurements requested by the E-SMLC and supported by the UE as listed in Table 8.3.2.2-1 together with a required response time. +- (2) The UE sends an LPP Provide Location Information message to the E-SMLC and reports the requested measurements that are available in the UE before the Response Time provided in step (1) elapsed. If the requested measurements are not available, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +#### 8.3.3.3.2 UE-initiated Location Information Delivery procedure + +Figure 8.3.3.3.2-1 shows the Location Information Delivery procedure operations for the E-CID method when the procedure is initiated by the UE. + +![Sequence diagram showing the UE-initiated Location Information Delivery Procedure. A UE box is on the left and an E-SMLC box is on the right. A horizontal arrow points from the UE to the E-SMLC, labeled '1. LPP Provide Location Information'.](575d7d345b3ec04393bb2ec720ebabca_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + UE->>E-SMLC: 1. LPP Provide Location Information + Note right of E-SMLC: +``` + +Sequence diagram showing the UE-initiated Location Information Delivery Procedure. A UE box is on the left and an E-SMLC box is on the right. A horizontal arrow points from the UE to the E-SMLC, labeled '1. LPP Provide Location Information'. + +**Figure 8.3.3.3.2-1: UE-initiated Location Information Delivery Procedure.** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include any UE measurements already available at the UE. + +## 8.3.4 Uplink E-CID Positioning Procedures + +The procedures described in this clause support E-CID related measurements obtained by the eNodeB and provided to the E-SMLC using LPPa. The term "uplink" is intended to indicate that from the E-SMLC point of view, the involved measurements are provided by the eNodeB; this set of procedures might also be considered as "eNB-assisted E-CID". An example of this uplink E-CID positioning method is AoA+T<sub>ADV</sub>. + +**NOTE:** Uplink E-CID positioning not using T<sub>ADV</sub> type 1 does not require LCS support in the UE and therefore, works also with legacy UEs (assuming that any involved measurements delivered in RRC are supported by the legacy UEs). + +### 8.3.4.1 Position Capability Transfer Procedure + +The position capability transfer procedure is not applicable to uplink E-CID positioning not using T<sub>ADV</sub> type 1. For uplink E-CID positioning using T<sub>ADV</sub> type 1, the Capability Transfer procedure for E-CID positioning is described in clause 7.1.2.1. + +### 8.3.4.2 Assistance Data Delivery Procedure + +The assistance data delivery procedure is not applicable to uplink E-CID positioning. + +### 8.3.4.3 Position Measurement Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements from the eNodeB. + +#### 8.3.4.3.1 E-SMLC-initiated Position Measurement + +Figure 8.3.4.3.1-1 shows the Position Measurement operations for the uplink E-CID method when the procedure is initiated by the E-SMLC. + +![Sequence diagram of E-SMLC-initiated Position Measurement Procedure. The diagram shows three steps: (1) E-SMLC sends an LPPa Message (Type: E-CID MEASUREMENT INITIATION REQUEST) to eNB; (2) eNB initiates RRC Measurement Procedure with UE; (3) eNB sends an LPPa Message (Type: E-CID MEASUREMENT INITIATION RESPONSE/FAILURE) back to E-SMLC.](61a7f401eb46fe99a71f27bc37493f04_img.jpg) + +``` + +sequenceDiagram + participant E-SMLC + participant eNB + participant UE + Note left of E-SMLC: (1) + E-SMLC->>eNB: LPPa Message (Type: E-CID MEASUREMENT INITIATION REQUEST) + Note right of eNB: (2) RRC Measurement Procedure + eNB->>UE: RRC Measurement Request + Note right of UE: + UE->>eNB: RRC Measurement Response + Note right of eNB: (3) + eNB->>E-SMLC: LPPa Message (Type: E-CID MEASUREMENT INITIATION RESPONSE/FAILURE) + +``` + +Sequence diagram of E-SMLC-initiated Position Measurement Procedure. The diagram shows three steps: (1) E-SMLC sends an LPPa Message (Type: E-CID MEASUREMENT INITIATION REQUEST) to eNB; (2) eNB initiates RRC Measurement Procedure with UE; (3) eNB sends an LPPa Message (Type: E-CID MEASUREMENT INITIATION RESPONSE/FAILURE) back to E-SMLC. + +**Figure 8.3.4.3.1-1: E-SMLC-initiated Position Measurement Procedure** + +- (1) The E-SMLC sends an LPPa E-CID MEASUREMENT INITIATION REQUEST message to the eNodeB. This request includes indication of E-CID measurements requested and whether the result is expected only once or periodically. +- (2) If the E-SMLC in step (1) requested UE measurements (i.e., RSRP, RSRQ measurements), or if the eNodeB requires UE measurements associated with the measurements requested by the E-SMLC (e.g., $T_{ADV}$ type 1, which requires a UE Tx-Rx time difference measurement to be delivered from the UE to the eNodeB), the eNodeB may configure the UE to report the measurement information requested as specified in TS 36.331 [14]. +- (3) If the result is expected only once and the eNodeB initiates at least one of the E-CID measurements as requested, the eNodeB sends an LPPa E-CID MEASUREMENT INITIATION RESPONSE to the E-SMLC, which includes the obtained E-CID measurements. If the result is expected periodically and the eNodeB is able to initiate at least one of the E-CID measurements as requested, the eNodeB sends an LPPa E-CID MEASUREMENT INITIATION RESPONSE to the E-SMLC, which does not include any result. The eNodeB reports then the obtained measurements by initiating the E-CID Measurement Report procedure, with the requested periodicity. If the eNodeB is unable to initiate any of the requested measurements as requested from the E-SMLC, or is unable to instigate any of the required RRC procedures to obtain the requested measurements from the UE, the eNodeB sends an LPPa E-CID MEASUREMENT INITIATION FAILURE message providing the error reason. If the failure occurs during a periodic reporting, the eNodeB sends an LPPa E-CID MEASUREMENT FAILURE INDICATION message. + +## 8.4 Downlink Supporting Procedures + +### 8.4.1 General + +An E-SMLC is enabled to request downlink location related information from the E-UTRAN in order to support downlink positioning. LPPa is employed for this between the E-SMLC and each eNodeB reachable from the E-SMLC via any of the MMEs with signalling access to the E-SMLC. + +### 8.4.2 Location Related Information + +The information that may be transferred from an eNodeB to the E-SMLC to support downlink positioning is listed in table 8.4.2-1. + +**Table 8.4.2-1: Information that may be transferred from an eNodeB to the E-SMLC for the Downlink Position Method Support** + +| Information | UE-assisted | +|---------------------------------------------------------------------------|-------------| +| Global cell IDs (ECGIs) of eNodeB | Yes | +| Physical cell IDs (PCIs) of eNodeB | Yes | +| TP IDs | Yes | +| PRS Scheduling | Yes | +| If synchronized: SFN initialization time of TP relative to time reference | Yes | + +### 8.4.3 Location Related Information Acquisition Procedure + +The purpose of this procedure is to enable an E-SMLC to request downlink location related information from an eNodeB. + +#### 8.4.3.1 On Demand Procedure + +Figure 8.4.3.1-1 shows the location information acquisition operation for the downlink positioning method when information is needed on demand in real time. + +![Sequence diagram for Figure 8.4.3.1-1: E-SMLC-initiated On Demand Procedure for Location Information Applicable to Downlink. The diagram shows two lifelines: eNB and E-SMLC. Step 1: E-SMLC sends an LPPa Message (Type: Request Location Information) to eNB. Step 2: eNB sends an LPPa Message (Type: Provide Location Information) to E-SMLC.](83c2ebae8819e9cdca7eb157a13ee26a_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant eNB + Note left of E-SMLC: 1. LPPa Message (Type: Request Location Information) + E-SMLC->>eNB: 1. LPPa Message (Type: Request Location Information) + Note right of eNB: 2. LPPa Message (Type: Provide Location Information) + eNB->>E-SMLC: 2. LPPa Message (Type: Provide Location Information) +``` + +Sequence diagram for Figure 8.4.3.1-1: E-SMLC-initiated On Demand Procedure for Location Information Applicable to Downlink. The diagram shows two lifelines: eNB and E-SMLC. Step 1: E-SMLC sends an LPPa Message (Type: Request Location Information) to eNB. Step 2: eNB sends an LPPa Message (Type: Provide Location Information) to E-SMLC. + +**Figure 8.4.3.1-1: E-SMLC-initiated On Demand Procedure for Location Information Applicable to Downlink** + +- (1) The E-SMLC sends an LPPa message of type Request Location Information to the eNodeB. This request includes an indication of the downlink related information requested. +- (2) The eNodeB obtains the information requested in step 1 using previously configured or stored information and/or real time measurements in the case of a request for timing information where recent timing information is not already available. The eNodeB then sends an LPPa message of type Provide Location Information to the E-SMLC. If the eNodeB is unable to obtain any of the requested information, the eNodeB sends an LPPa failure message, providing the error reason. + +#### 8.4.3.2 Triggered Procedure + +Figure 8.4.3.2-1 shows the location information acquisition operation for the downlink positioning method when information is needed on a triggered basis. + +![Sequence diagram for Figure 8.4.3.2-1: E-SMLC-initiated Triggered Procedure for Location Information Applicable to Downlink. The diagram shows two lifelines: eNB and E-SMLC. Step 1: E-SMLC sends an LPPa Message (Type: Request Location Information) to eNB. Step 2: eNB sends an LPPa Message (Type: Provide Location Information) to E-SMLC. Step 3: eNB sends another LPPa Message (Type: Provide Location Information) to E-SMLC.](7355f66b8620d44cf566215621addb74_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant eNB + Note left of E-SMLC: 1. LPPa Message (Type: Request Location Information) + E-SMLC->>eNB: 1. LPPa Message (Type: Request Location Information) + Note right of eNB: 2. LPPa Message (Type: Provide Location Information) + eNB->>E-SMLC: 2. LPPa Message (Type: Provide Location Information) + Note right of eNB: 3. LPPa Message (Type: Provide Location Information) + eNB->>E-SMLC: 3. LPPa Message (Type: Provide Location Information) +``` + +Sequence diagram for Figure 8.4.3.2-1: E-SMLC-initiated Triggered Procedure for Location Information Applicable to Downlink. The diagram shows two lifelines: eNB and E-SMLC. Step 1: E-SMLC sends an LPPa Message (Type: Request Location Information) to eNB. Step 2: eNB sends an LPPa Message (Type: Provide Location Information) to E-SMLC. Step 3: eNB sends another LPPa Message (Type: Provide Location Information) to E-SMLC. + +**Figure 8.4.3.2-1: E-SMLC-initiated Triggered Procedure for Location Information Applicable to Downlink** + +- (1) The E-SMLC sends an LPPa message of type Request Location Information to the eNodeB. This request includes an indication of the downlink related information requested, triggering criteria for responses (e.g. periodic time interval). +- (2) In response to step 1, the eNodeB obtains the information requested using already available information and/or real time measurements. The eNodeB then sends an LPPa message of type Provide Location Information to the E-SMLC carrying this information. If the eNodeB is unable to obtain the requested information partly or completely, the eNodeB sends an LPPa failure message. + +- (3) When the trigger criteria provided in step 1 indicate the need for a new report the eNodeB obtains the latest information. The eNodeB then sends a further LPPa message of type Provide Location Information to the E-SMLC containing this information If the eNodeB is unable to obtain the requested information, partly or completely, the eNodeB sends an LPPa failure message. + +## 8.5 Uplink positioning method + +### 8.5.1 General + +In the uplink positioning method, the UE position is estimated based on timing measurements of uplink radio signals taken at different LMUs , along with knowledge of the geographical coordinates of the LMUs. The time required for a signal transmitted by a UE to reach a LMU is proportional to the length of the transmission path between the UE and the LMU. A set of LMUs is tasked to sample the UE signal at the same time. + +The specific of any uplink positioning methods or techniques used to estimate the UE's location from these measurements are beyond the scope of this specification. + +In order to obtain uplink measurements, the LMUs need to know the characteristics of the SRS signal transmitted by the UE for the time period required to calculate uplink measurement. These characteristics should be static over the periodic transmission of SRS during the uplink measurements. Hence, the E-SMLC will indicate to the serving eNodeB the need to direct the UE to transmit SRS (see 5.2.2) signals for uplink positioning. It is up to the eNodeB to make the final decision on resources to be assigned and to communicate this configuration information back to the E-SMLC so that E-SMLC can configure the LMUs. The eNB may decide (e.g., in case no resources are available) to configure no resources for the UE and report the empty resource configuration to the E-SMLC. + +### 8.5.2 Transferred information + +This clause defines the information that may be transferred between E-SMLC and eNodeB/LMU. + +UTDOA measurements are performed on Sounding Reference Signals (SRS), configured as periodic SRS involving multiple SRS transmissions. + +NOTE: The tables in clauses 8.5.2.1, 8.5.2.2, and 8.5.2.3 will be updated if needed. + +#### 8.5.2.1 Configuration Data that may be transferred from the eNodeB to the E-SMLC + +The following configuration data may be transferred from the eNodeB to the E-SMLC: + +| Parameter Category | Parameters | +|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| General | PCI of PCell <sup>Note 1</sup><br>UL-EARFCN of PCell<br>Timing advance measurement for the UE in PCell [36.214] <sup>Note 3</sup> | +| SRS | For each serving cell in which SRS is configured <sup>Note2</sup> :<br>- PCI<br>- UL-EARFCN<br>- UL cyclic prefix<br>- UL system bandwidth of the cell<br>- Cell-specific SRS bandwidth configuration <i>srs-BandwidthConfig</i> [36.211]<br>- UE-specific SRS bandwidth configuration <i>srs-Bandwidth</i> [36.211]<br>- number of antenna ports for SRS transmission <i>srs-AntennaPort</i> [36.211]<br>- frequency domain position [36.211]<br>- SRS frequency hopping bandwidth configuration [36.211]<br>- SRS-Cyclic shift [36.211]<br>- Transmission comb [36.211]<br>- SRS configuration index [36.213]<br>- <i>MaxUpPt</i> , used for TDD only [36.211]<br>- <i>Group-hopping-enabled</i> [36.211]<br>- <i>deltaSS</i> , parameter $\Delta_{ss}$ [36.211, 5.5.1.3], included when SRS sequence hopping is used [36.211, 5.5.1.4] and not included otherwise | +| Note 1: Indicating PCell should not imply configuring SRS on the PCell | | +| Note 2: Multiple serving cells are possible for a UE configured with CA | | +| Note 3: Used for search window calculation | | + +## 8.5.2.2 Configuration Data that may be transferred from the E-SMLC to LMU + +The following configuration data may be transferred from the E-SMLC to LMU: + +| Parameter Category | Parameters | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| General | Search window parameters <sup>Note 2</sup> :<br>- expected propagation delay, T, corresponding to distance between LMU and PCell,<br>- delay uncertainty $\Delta$ | +| SRS | For each serving cell in which SRS is configured and to be measured by LMU <sup>Note1</sup> :<br>- PCI<br>- UL-EARFCN<br>- UL cyclic prefix<br>- UL system bandwidth of the cell<br>- Cell-specific SRS bandwidth configuration <i>srs-BandwidthConfig</i> [36.211]<br>- UE-specific SRS bandwidth configuration <i>srs-Bandwidth</i> [36.211]<br>- number of antenna ports for SRS transmission <i>srs-AntennaPort</i> [36.211]<br>- frequency domain position [36.211]<br>- SRS frequency hopping bandwidth configuration [36.211]<br>- SRS-Cyclic shift [36.211]<br>- Transmission comb [36.211]<br>- SRS configuration index [36.213]<br>- <i>MaxUpPt</i> , used for TDD only [36.211]<br>- <i>Group-hopping-enabled</i> [36.211]<br>- <i>deltaSS</i> , parameter $\Delta_{ss}$ [36.211, 5.5.1.3], included when SRS sequence hopping is used [36.211, 5.5.1.4] and not included otherwise | +| Note 1: Multiple serving cells are possible for a UE configured with CA; SRS may be transmitted on the PCell and/or SCell(s). | | +| Note 2: Search window is calculated by the LMU as $[T-\Delta, T+\Delta]$ , where $\Delta$ may be e.g. the timing advance measurement provided by eNodeB. | | + +### 8.5.2.3 Location Information that may be transferred from the LMU to E-SMLC + +The information that may be transferred from LMU to the E-SMLC is listed in Table 8.5.2.3-1. The individual measurements will be defined in TS 36.214 [20]. + +**Table 8.5.2.3-1: Information that may be transferred from LMU to the E-SMLC** + +| Information | Measurements | +|-------------------------------------------|--------------------------------------------------| +| Uplink Measurement Results List for EUTRA | UL Relative Time of Arrival<br>Physical cell IDs | + +## 8.5.3 Uplink Positioning Procedures + +The procedures described in this clause support the uplink positioning method. + +### 8.5.3.1 Uplink Information Request and Delivery Procedure + +The Information Request procedure for Uplink positioning is used by the E-SMLC to obtain measurement results from the LMU which it uses to calculate a position for the UE. To do this, it needs to first indicate to the serving eNB the need to configure the UE to transmit SRS (see 5.2.2) signals and retrieve target UE configuration data from the eNodeB. + +Figure 8.5.3.1-1 shows the messaging between the E-SMLC, the LMU and the serving eNodeB to perform this procedure. + +![Sequence diagram of the Uplink information request procedure. The diagram shows interactions between E-SMLC, Serving eNB1, and LMU. The steps are: (1) E-SMLC sends LPPa PDU (Information Request) to Serving eNB1; (2) Serving eNB1 sends LPPa PDU (Information Response) to E-SMLC; (3) E-SMLC selects list of LMU sites and Serving eNB1 configures UE with SRS resources (RRC); (4) E-SMLC sends SLm (Type: Measurement Request) to LMU; (5) LMU sends SLm (Type: Measurement Report) to E-SMLC.](1e56c223f51992d193febf7a161af7be_img.jpg) + +``` + +sequenceDiagram + participant E-SMLC + participant Serving eNB1 + participant LMU + + Note right of Serving eNB1: eNB determines UE SRS resources + Note left of E-SMLC: E-SMLC selects list of LMU sites + Note right of Serving eNB1: eNB configures UE with SRS resources (RRC) + + E-SMLC->>Serving eNB1: (1) LPPa PDU ( Information Request) + Serving eNB1-->>E-SMLC: (2) LPPa PDU ( Information Response) + E-SMLC->>LMU: (3) SLm (Type: Measurement Request) + LMU-->>E-SMLC: (5) SLm ( Type: Measurement Report) + +``` + +Sequence diagram of the Uplink information request procedure. The diagram shows interactions between E-SMLC, Serving eNB1, and LMU. The steps are: (1) E-SMLC sends LPPa PDU (Information Request) to Serving eNB1; (2) Serving eNB1 sends LPPa PDU (Information Response) to E-SMLC; (3) E-SMLC selects list of LMU sites and Serving eNB1 configures UE with SRS resources (RRC); (4) E-SMLC sends SLm (Type: Measurement Request) to LMU; (5) LMU sends SLm (Type: Measurement Report) to E-SMLC. + +**Figure 8.5.3.1-1: Uplink information request procedure** + +1. The E-SMLC sends an Information Request message indicating to the eNodeB the need to invoke periodic SRS (see 5.2.2) for target UE. The E-SMLC may provide the eNB with a number of SRS transmissions. The final decision of SRS transmissions to be performed and whether to take into account this information is entirely up to the eNB implementation. + +2. The eNodeB determines the resources to be allocated for the UE and sends an Information Response to the E-SMLC that includes the allocated resources and the associated parameters. The eNB may decide (e.g., in case no resources are available) to configure no resources for the UE and report the empty resource configuration to the E-SMLC. +3. If in step 2 the eNodeB determines that resources will be allocated, the eNodeB then allocates the resources to the target UE. +4. The E-SMLC selects a set of LMUs to be used for the UTDOA positioning and sends a measurement request with the SRS configuration to each one of them (via SLm). +5. LMUs report back to E-SMLC the uplink measurement reports. + +### 8.5.3.2 Uplink Positioning Information Update Procedure + +This procedure is used to notify the E-SMLC of a change to the UE SRS transmission configuration for one or more cells with respect to a previously sent UTDOA INFORMATION RESPONSE message. If the configured SRS transmission for the target UE has been modified, or if a handover of the target UE has been triggered, the eNB uses the Uplink Positioning Information Update procedure to inform the E-SMLC. + +![Sequence diagram of the Uplink Positioning Information Update Procedure between eNode B and E-SMLC.](6707cae4df136f92a0c9f3a4676f91a6_img.jpg) + +``` + +sequenceDiagram + participant eNode B + participant E-SMLC + Note left of eNode B: (Internal logic) + eNode B->>E-SMLC: 1. LPPa Message: Information Request + Note right of E-SMLC: (Internal logic) + E-SMLC-->>eNode B: LPPa Message: Information Response + Note left of eNode B: (Internal logic) + eNode B->>E-SMLC: 2. LPPa Message: Uplink Positioning Information Update + +``` + +The diagram illustrates the interaction between the eNode B and the E-SMLC. It starts with the eNode B sending a dashed arrow labeled "1. LPPa Message: Information Request" to the E-SMLC. The E-SMLC responds with a dashed arrow labeled "LPPa Message: Information Response" back to the eNode B. Finally, the eNode B sends a dashed arrow labeled "2. LPPa Message: Uplink Positioning Information Update" to the E-SMLC. Vertical dashed lines extend from the boxes to indicate the timeline of the sequence. + +Sequence diagram of the Uplink Positioning Information Update Procedure between eNode B and E-SMLC. + +**Figure 8.5.3.2-1: Uplink Positioning Information Update Procedure** + +1. If the SRS configuration changes or if a handover of the target UE has been triggered prior to the expected completion time of the previously communicated SRS configuration, the eNB initiates the Uplink Positioning Information Update Procedure. In the case of handover, the source eNB sends the update message after deciding to perform handover execution for the UE. +2. If the UE SRS transmission configuration has changed for one or more cells, the eNB sends an Uplink Positioning Information Update message to the E-SMLC carrying the UE SRS transmission configuration information for all cells with SRS configured. + +## 8.6 Barometric pressure sensor positioning methods + +### 8.6.1 General + +In the barometric pressure sensor positioning method, the UE vertical component of the position is estimated by combining the measured atmospheric pressure and a reference atmospheric pressure. This is accomplished through barometric sensors measuring atmospheric pressure at the UE, and applying a height determination algorithm using the reference atmospheric pressure. + +Three positioning modes are supported: + +- *UE-Assisted*: The UE performs barometric pressure sensor measurements with or without assistance from the network and sends these measurements to the E-SMLC where the vertical component of the position calculation may take place, possibly using additional measurements from other sources; +- *UE-Based*: The UE performs barometric pressure sensor measurements and calculates its own vertical component of the position, possibly using additional measurements from other sources. + +- *Standalone*: The UE performs barometric pressure sensor measurements and calculates its own vertical component of the position, possibly using additional measurements from other sources, without network assistance. + +## 8.6.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., assistance data, vertical position and/or measurement data) that may be transferred between E-UTRAN elements. + +### 8.6.2.1 Information that may be transferred from the UE to E-SMLC + +The information transferred from the UE to the E-SMLC consists of capability information and location measurements or UE position. The information that may be signalled from the UE to the E-SMLC is summarized in Table 8.6.2.1-1. + +**Table 8.6.2.1-1: Information that may be transferred from UE to the E-SMLC** + +| Information | UE-assisted | UE-based/<br>Standalone | +|---------------------------------------------------|-------------|-------------------------| +| UE position estimate with uncertainty shape | No | Yes | +| Indication of used positioning methods in the fix | No | Yes | +| Timestamp | Yes | Yes | +| Barometric pressure sensor measurements | Yes | No | + +#### 8.6.2.1.1 Standalone mode + +In Standalone mode, the UE reports the vertical component of the position, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication of which positioning method(s) have been used to calculate a fix. + +#### 8.6.2.1.2 UE-assisted mode + +In UE-assisted mode, the UE reports the barometric pressure sensor measurements together with associated quality estimates. These measurements enable the E-SMLC to calculate the vertical component of the location of the UE, possibly using other measurements and data. + +If requested by the E-SMLC and supported by the UE, the UE may report barometric pressure sensor measurements together with associated quality measurements, if available. + +#### 8.6.2.1.3 UE-based mode + +In UE-based mode, the UE reports the vertical component of the position, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication of which positioning method(s) have been used to calculate a fix. + +### 8.6.2.2 Information that may be transferred from the E-SMLC to UE + +Table 8.6.2.2-1 lists assistance data for both UE-assisted and UE-based modes that may be sent from the E-SMLC to the UE. + +NOTE: The provision of these assistance data elements and the usage of these elements by the UE depend on the E-UTRAN and UE capabilities, respectively. + +**Table 8.6.2.2-1: Information that may be transferred from the E-SMLC to UE** + +| Assistance Data | +|---------------------------| +| Reference pressure | +| Additional reference data | + +#### 8.6.2.2.1 Barometric pressure sensor assistance data + +The barometric pressure sensor assistance data may include reference pressure, along with other reference data, such as the reference point where the reference barometric pressure is valid and reference temperature at the reference point. + +### 8.6.3 Barometric Pressure Sensor Location Information Transfer Procedures + +The purpose of this procedure is to enable the E-SMLC to request barometric pressure sensor measurements or position estimate from the UE, or to enable the UE to provide barometric pressure sensor measurements to the E-SMLC for position calculation (e.g., in case of basic self-location where the UE requests its own location). + +#### 8.6.3.1 E-SMLC initiated Location Information Transfer Procedure + +Figure 8.6.3.1-1 shows the Location Information Transfer operations when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure](854cb86f664ff62fd23e7607cfeb5727_img.jpg) + +``` + +sequenceDiagram + participant UE + participant E-SMLC + E-SMLC->>UE: 1. LPP Request Location Information + UE->>E-SMLC: 2. LPP Provide Location Information + +``` + +The diagram illustrates the interaction between a User Equipment (UE) and an E-SMLC. The E-SMLC initiates the procedure by sending a message labeled '1. LPP Request Location Information' to the UE. The UE responds with a message labeled '2. LPP Provide Location Information' back to the E-SMLC. + +Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure + +**Figure 8.6.3.1-1: E-SMLC-initiated Location Information Transfer Procedure** + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of barometric pressure sensor positioning. This request includes positioning instructions such as the positioning mode (UE-assisted, UE-based, standalone), specific requested UE measurements if any, and quality of service parameters (accuracy, response time). +- (2) The UE performs the requested measurements and possibly calculates its own position. The UE sends an LPP Provide Location Information message to the E-SMLC before the Response Time provided in step (1) elapsed. If the UE is unable to perform the requested measurements, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +#### 8.6.3.2 UE-initiated Location Information Delivery Procedure + +Figure 8.6.3.2-1 shows the Location Information delivery operations for the barometric pressure sensor method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Location Information Delivery Procedure](1f5279ac241813966be03158ad92142b_img.jpg) + +``` + +sequenceDiagram + participant UE + participant E-SMLC + UE->>E-SMLC: 1. LPP Provide Location Information + +``` + +The diagram illustrates the interaction between a User Equipment (UE) and an E-SMLC. The UE initiates the procedure by sending a message labeled '1. LPP Provide Location Information' to the E-SMLC. + +Sequence diagram for UE-initiated Location Information Delivery Procedure + +**Figure 8.6.3.2-1: UE-initiated Location Information Delivery Procedure** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include UE barometric pressure sensor measurements or location estimate already available at the UE. + +### 8.6.3.3 Assistance Data Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to provide assistance data to the UE (e.g., as part of a positioning procedure) and the UE to request assistance data from the E-SMLC (e.g., as part of a positioning procedure or for autonomous self location (i.e., UE determines its own location)). + +#### 8.6.3.3.1 E-SMLC initiated Assistance Data Delivery + +Figure 8.6.3.3.1-1 shows the Assistance Data Delivery operations for the network-assisted barometric pressure sensor method when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Assistance Data Delivery Procedure](007fefafb4fcbdb7d388209f63a0ba5d_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note right of E-SMLC: 1. LPP Provide Assistance Data + E-SMLC->>UE: 1. LPP Provide Assistance Data +``` + +The diagram shows a sequence of interactions between a User Equipment (UE) and an E-SMLC. The UE is represented by a box on the left and the E-SMLC by a box on the right. A single message, '1. LPP Provide Assistance Data', is shown as an arrow pointing from the E-SMLC to the UE. + +Sequence diagram for E-SMLC-initiated Assistance Data Delivery Procedure + +Figure 8.6.3.3.1-1: E-SMLC-initiated Assistance Data Delivery Procedure + +- (1) The E-SMLC determines that assistance data needs to be provided to the UE (e.g., as part of a positioning procedure) and sends an LPP Provide Assistance Data message to the UE. This message may include any of the barometric pressure sensor assistance data defined in clause 8.6.2.2. + +#### 8.6.3.3.2 UE initiated Assistance Data Transfer + +Figure 8.6.3.3.2-1 shows the Assistance Data Transfer operations for the network-assisted Barometric pressure sensor method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Assistance Data Transfer Procedure](df94f7807f02e218ee3c66b9cbd829e5_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: 1. LPP Request Assistance Data + UE->>E-SMLC: 1. LPP Request Assistance Data + Note right of E-SMLC: 2. LPP Provide Assistance Data + E-SMLC->>UE: 2. LPP Provide Assistance Data +``` + +The diagram shows a sequence of interactions between a User Equipment (UE) and an E-SMLC. The UE is represented by a box on the left and the E-SMLC by a box on the right. Two messages are shown: '1. LPP Request Assistance Data' as an arrow pointing from the UE to the E-SMLC, and '2. LPP Provide Assistance Data' as an arrow pointing from the E-SMLC to the UE. + +Sequence diagram for UE-initiated Assistance Data Transfer Procedure + +Figure 8.6.3.3.2-1: UE-initiated Assistance Data Transfer Procedure + +- (1) The UE determines that certain barometric pressure sensor assistance data is desired (e.g., in case the UE requires its own location with autonomous self location or as part of a positioning procedure when the E-SMLC provided assistance data are not sufficient for the UE to fulfil the request) and sends a LPP Request Assistance Data message to the E-SMLC. This request includes an indication of which specific barometric pressure sensor assistance data is requested. + +- (2) The E-SMLC provides the requested assistance data in a LPP Provide Assistance Data message, if available at the E-SMLC. The entire set of assistance data may be delivered in one or several LPP messages. In this case, this step may be repeated by the E-SMLC several times. If any of the UE requested assistance data in step (1) are not provided in step 2, the UE shall assume that the requested assistance data are not supported, or currently not available at the E-SMLC. If none of the UE requested assistance data in step (1) can be provided by the E-SMLC, return any information that can be provided in an LPP message of type Provide Assistance Data which includes a cause indication for the not provided assistance data. + +## 8.7 WLAN positioning methods + +### 8.7.1 General + +In the WLAN positioning method, the UE position is estimated with the knowledge of geographical coordinate of reference WLAN access points. This is accomplished by collecting a certain amount of measurements from UE's WLAN receivers, and applying a location determination algorithm using databases of the estimated position's references points. + +The UE WLAN measurements may include: + +- WLAN Received Signal Strength (RSSI) +- Round Trip Time (RTT) between WLAN Access Point and the UE + +Three positioning modes are supported: + +- *Standalone:* +The UE performs WLAN position measurements and location computation, without network assistance. +- *UE-assisted:* +The UE provides WLAN position measurements with or without assistance from the network to the E-SMLC for computation of a location estimate by the network. +- *UE-based:* +The UE performs WLAN position measurements and computation of a location estimate with network assistance. + +### 8.7.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., assistance data, position, measurement data) that may be transferred between E-UTRAN elements. + +#### 8.7.2.1 Information that may be transferred from the UE to E-SMLC + +The information transferred from the UE to the E-SMLC consists of capability information and location measurements or UE position. The information that may be signalled from the UE to the E-SMLC is summarized in Table 8.7.2.1-1. + +**Table 8.7.2.1-1: Information that may be transferred from the UE to the E-SMLC** + +| Information | UE-Assisted | UE-based/<br>Standalone | +|------------------------------------------------------|-------------|-------------------------| +| <b>WLAN Location Information</b> | | | +| BSSID | Yes | No | +| SSID | Yes | No | +| Received Signal Strength (RSSI) | Yes | No | +| Round Trip Time (RTT) | Yes | No | +| Time Stamp | Yes | No | +| Measurement characteristics | Yes | No | +| <b>UE Location Information</b> | | | +| UE position estimate with uncertainty shape | No | Yes | +| Position Time Stamp | No | Yes | +| Location Source (method(s) used to compute location) | No | Yes | + +#### 8.7.2.1.1 Standalone mode + +In Standalone mode, the UE reports the latitude, longitude and possibly altitude, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication of WLAN method and possibly other positioning methods used to calculate a fix. + +#### 8.7.2.1.2 UE-assisted mode + +In UE-assisted mode, the UE should report: + +- The BSSID/SSID of the measured WLAN access points, and associated RSSI or RTT. + +#### 8.7.2.1.3 UE-based mode + +In UE-based mode, the UE reports the latitude, longitude, and possibly altitude, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication that WLAN method is used and possibly other positioning methods used to calculate the fix. + +#### 8.7.2.2 Information that may be transferred from the E-SMLC to UE + +Table 8.7.2.2-1 lists assistance data for both UE-assisted and UE-based modes that may be sent from the E-SMLC to the UE. + +NOTE: The provision of these assistance data elements and the usage of these elements by the UE depend on the E-UTRAN and UE capabilities, respectively. + +**Table 8.7.2.2-1: Information that may be transferred from the E-SMLC to UE** + +| Assistance Data | +|--------------------------------------------------------------------------------------------------------------------------------------| +| WLAN AP List | +| - BSSID | +| - SSID | +| - AP Type Data <sup>(1)</sup> | +| - AP Location | +| NOTE 1: WLAN AP Type Data may include WLAN Type (e.g., 802.11a/b/g/n/ac/ad, etc.), transmit power, antenna gain, coverage area, etc. | + +#### 8.7.2.2.1 WLAN AP BSSID + +This assistance data provides the BSSID of the WLAN access point [29]. + +#### 8.7.2.2.2 WLAN AP SSID + +This assistance data provides the SSID of the WLAN access point [29]. + +#### 8.7.2.2.3 WLAN AP Type Data + +This assistance data provides additional information about the access point and may include WLAN Type (e.g., 802.11a/b/g/n/ac/ad, etc.), transmit power, antenna gain, coverage area, etc. [29] + +#### 8.7.2.2.4 WLAN AP Location + +This assistance data provides the location (possibly including altitude information) of the access point [29]. + +### 8.7.3 WLAN Positioning Procedures + +#### 8.7.3.1 Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements or location estimate from the UE, or to enable the UE to provide location measurements to the E-SMLC for position calculation (e.g., in case of basic self-location where the UE requests its own location). + +##### 8.7.3.1.1 E-SMLC initiated Location Information Transfer Procedure + +Figure 8.7.3.1.1-1 shows the Location Information Transfer operations for the WLAN method when the procedure is initiated by the E-SMLC. + +![Sequence diagram showing the E-SMLC-initiated Location Information Transfer Procedure. The diagram features two vertical lifelines: UE on the left and E-SMLC on the right. Step 1 shows a message '1. LPP Request Location Information' sent from the E-SMLC to the UE. Step 2 shows a message '2. LPP Provide Location Information' sent from the UE to the E-SMLC.](a623046e0b145f14b961518396f7c43e_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note right of E-SMLC: 1. LPP Request Location Information + E-SMLC->>UE: 1. LPP Request Location Information + Note left of UE: 2. LPP Provide Location Information + UE->>E-SMLC: 2. LPP Provide Location Information +``` + +Sequence diagram showing the E-SMLC-initiated Location Information Transfer Procedure. The diagram features two vertical lifelines: UE on the left and E-SMLC on the right. Step 1 shows a message '1. LPP Request Location Information' sent from the E-SMLC to the UE. Step 2 shows a message '2. LPP Provide Location Information' sent from the UE to the E-SMLC. + +**Figure 8.7.3.1.1-1: E-SMLC-initiated Location Information Transfer Procedure** + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of WLAN positioning. This request includes positioning instructions such as the positioning mode (UE-assisted, UE-based, Standalone), specific requested UE measurements if any, and quality of service parameters (accuracy, response time). +- (2) The UE performs the requested measurements and possibly calculates its own location. The UE sends an LPP Provide Location Information message to the E-SMLC before the Response Time provided in step (1) elapsed. If the UE is unable to perform the requested measurements, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +### 8.7.3.1.2 UE-initiated Location Information Delivery Procedure + +Figure 8.7.3.1.2-1 shows the Location Information delivery operations for the WLAN method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Location Information Delivery Procedure](17f0cf80b9c38adb460d4ca836960da7_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + UE->>E-SMLC: 1. LPP Provide Location Information + Note right of E-SMLC: + deactivate UE + deactivate E-SMLC +``` + +The diagram shows a sequence of operations between a User Equipment (UE) and an E-SMLC. The UE sends a message labeled '1. LPP Provide Location Information' to the E-SMLC. The UE and E-SMLC are represented by rectangular boxes with vertical lifelines extending downwards. The message is indicated by a horizontal arrow pointing from the UE's lifeline to the E-SMLC's lifeline. + +Sequence diagram for UE-initiated Location Information Delivery Procedure + +**Figure 8.7.3.1.2-1: UE-initiated Location Information Delivery Procedure** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include UE WLAN information or location estimate already available at the UE. + +### 8.7.3.2 Assistance Data Transfer Procedure + +The purpose of this procedure is to enable the UE to request assistance data from the E-SMLC (e.g., as part of a positioning procedure or for autonomous self location (i.e., UE determines its own location)) and the E-SMLC to provide assistance data to the UE (e.g., as part of a positioning procedure). + +#### 8.7.3.2.1 UE initiated Assistance Data Transfer + +Figure 8.7.3.2.1-1 shows the Assistance Data Transfer operations for the network-assisted WLAN method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Assistance Data Transfer Procedure](1018d0db7bb02c169f646cb9cc244dc6_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + UE->>E-SMLC: 1. LPP Request Assistance Data + Note right of E-SMLC: + E-SMLC-->>UE: 2. LPP Provide Assistance Data + Note left of UE: + deactivate UE + deactivate E-SMLC +``` + +The diagram shows a sequence of operations between a User Equipment (UE) and an E-SMLC. The UE sends a message labeled '1. LPP Request Assistance Data' to the E-SMLC. The E-SMLC responds with a message labeled '2. LPP Provide Assistance Data' back to the UE. The UE and E-SMLC are represented by rectangular boxes with vertical lifelines extending downwards. The first message is indicated by a horizontal arrow pointing from the UE's lifeline to the E-SMLC's lifeline. The second message is indicated by a horizontal arrow pointing from the E-SMLC's lifeline back to the UE's lifeline. + +Sequence diagram for UE-initiated Assistance Data Transfer Procedure + +**Figure 8.7.3.2.1-1: UE-initiated Assistance Data Transfer Procedure** + +- (1) The UE determines that certain WLAN assistance data is desired (e.g., in case the UE requires its own location with autonomous self location or as part of a positioning procedure when the E-SMLC provided assistance data are not sufficient for the UE to fulfil the request) and sends a LPP Request Assistance Data message to the E-SMLC. This request includes an indication of which specific WLAN assistance data is requested. +- (2) The E-SMLC provides the requested assistance data in a LPP Provide Assistance Data message, if available at the E-SMLC. The entire set of assistance data may be delivered in one or several LPP messages. In this case, this step may be repeated by the E-SMLC several times. If any of the UE requested assistance data in step (1) are not provided in step 2, the UE shall assume that the requested assistance data are not supported, or currently not available at the E-SMLC. If none of the UE requested assistance data in step (1) can be provided by the E-SMLC, return any information that can be provided in an LPP message of type Provide Assistance Data which includes a cause indication for the not provided assistance data. + +## 8.8 Bluetooth positioning methods + +### 8.8.1 General + +In the Bluetooth positioning method, the UE position is estimated with the knowledge of geographical coordinate of reference Bluetooth beacons. This is accomplished by collecting a certain amount of measurements from UE's Bluetooth receiver, and applying a location determination algorithm using databases of the estimated position's references points. + +The UE Bluetooth measurements may include: + +- Bluetooth beacon's Received Signal Strength (RSSI) + +Two positioning modes are supported: + +- *Standalone:* +The UE performs Bluetooth position measurements and location computation. +- *UE-assisted:* +The UE provides Bluetooth position measurements without assistance from the network to the E-SMLC for computation of a location estimate by the network. + +### 8.8.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., position, measurement data) that may be transferred between E-UTRAN elements. + +#### 8.8.2.1 Information that may be transferred from the UE to E-SMLC + +The information transferred from the UE to the E-SMLC consists of capability information and location measurements or UE position. The information that may be signalled from the UE to the SMLC is summarized in Table 8.8.2.1-1. + +**Table 8.8.2.1-1: Information that may be transferred from the UE to the E-SMLC** + +| Information | UE-Assisted | Standalone | +|------------------------------------------------------|-------------|------------| +| <b>Bluetooth Location Information</b> | | | +| MAC Address | Yes | No | +| Received Signal Strength (RSSI) | Yes | No | +| Time Stamp | Yes | No | +| Measurement characteristics | Yes | No | +| <b>UE Location Information</b> | | | +| UE position estimate with uncertainty shape | No | Yes | +| Position Time Stamp | No | Yes | +| Location Source (method(s) used to compute location) | No | Yes | + +#### 8.8.2.1.1 Standalone mode + +In Standalone mode, the UE reports the latitude, longitude and possibly altitude, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication of Bluetooth method and possibly other location methods have been used to calculate a fix. + +#### 8.8.2.1.2 UE-assisted mode + +In UE-assisted mode, the UE should report: + +- The MAC addresses of the measured Bluetooth beacons and associated RSSI. + +## 8.8.3 Bluetooth Positioning Procedures + +### 8.8.3.1 Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements or location estimate from the UE, or to enable the UE to provide location measurements to the E-SMLC for position calculation (e.g., in case of basic self-location where the UE requests its own location). + +#### 8.8.3.1.1 E-SMLC initiated Location Information Transfer Procedure + +Figure 8.8.3.1.1-1 shows the Location Information Transfer operations for the Bluetooth method when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure](d04f4b76a3f7aa0ff51714fb1f71d9d3_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + Note right of E-SMLC: + E-SMLC->>UE: 1. LPP Request Location Information + UE-->>E-SMLC: 2. LPP Provide Location Information +``` + +The diagram shows a sequence of two messages between a UE and an E-SMLC. The UE is on the left and the E-SMLC is on the right. Step 1 shows the E-SMLC sending an 'LPP Request Location Information' message to the UE. Step 2 shows the UE sending an 'LPP Provide Location Information' message back to the E-SMLC. + +Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure + +Figure 8.8.3.1.1-1: E-SMLC-initiated Location Information Transfer Procedure + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of Bluetooth positioning. This request includes positioning instructions such as the positioning mode (UE-assisted, Standalone), specific requested UE measurements if any, and quality of service parameters (accuracy, response time). +- (2) The UE performs the requested measurements and possibly calculates its own location. The UE sends an LPP Provide Location Information message to the E-SMLC before the Response Time provided in step (1) elapsed. If the UE is unable to perform the requested measurements, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +#### 8.8.3.1.2 UE-initiated Location Information Delivery Procedure + +Figure 8.8.3.1.2-1 shows the Location Information delivery operations for the Bluetooth method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Location Information Delivery Procedure](c64555b7f91435b01997807dbb4bcc4c_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: + Note right of E-SMLC: + UE-->>E-SMLC: 1. LPP Provide Location Information +``` + +The diagram shows a single message from the UE to the E-SMLC. The UE is on the left and the E-SMLC is on the right. Step 1 shows the UE sending an 'LPP Provide Location Information' message to the E-SMLC. + +Sequence diagram for UE-initiated Location Information Delivery Procedure + +Figure 8.8.3.1.2-1: UE-initiated Location Information Delivery Procedure + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include UE Bluetooth information or location estimate already available at the UE. + +## 8.9 TBS positioning methods + +### 8.9.1 General + +Terrestrial Beacon Systems (TBS) is the standard generic term for a network of ground-based transmitters broadcasting signals for geo-spatial positioning with wide-area or regional coverage. The following TBSs are supported in this version of the specification: + +- Metropolitan Beacon Systems (MBS). + +NOTE: PRS-based TBS is part of downlink (OTDOA) positioning and described in clause 8.2. + +Three positioning modes are supported: + +- *UE-Assisted*: The UE performs TBS measurements with or without assistance from the network, and sends these measurements to the E-SMLC where the position calculation takes place, possibly using additional measurements from other (non-TBS) sources; +- *UE-Based*: The UE performs TBS measurements and calculates its own location, possibly using additional measurements from other (non-TBS) sources. +- *Standalone*: The UE performs TBS measurements and calculates its own location, possibly using additional measurements from other (non-TBS) sources, without network assistance. + +### 8.9.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., assistance data, position, measurement data) that may be transferred between E-UTRAN elements. + +#### 8.9.2.1 Information that may be transferred from the UE to E-SMLC + +The information transferred from the UE to the E-SMLC consists of capability information and location measurements or UE position. The information that may be signalled from the UE to the E-SMLC is summarized in Table 8.9.2.1-1. + +**Table 8.9.2.1-1: Information that may be transferred from UE to the E-SMLC** + +| Information | UE-assisted | UE-based/<br>Standalone | +|-----------------------------------------------------|-------------|-------------------------| +| UE position estimate with uncertainty shape | No | Yes | +| Timestamp | Yes | Yes | +| Indication of used positioning methods in the fix | No | Yes | +| TBS measurements (code phase (MBS)) | Yes | No | +| Measurement quality parameters for each measurement | Yes | No | + +##### 8.9.2.1.1 Standalone mode + +In Standalone mode, the UE reports the latitude, longitude and possibly altitude, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication that TBS method is used and possibly other positioning methods used to calculate the fix. + +##### 8.9.2.1.2 UE-assisted mode + +In UE-assisted mode, the UE reports the TBS associated measurements, together with associated quality estimates. These measurements enable the E-SMLC to calculate the location of the UE, possibly using other measurements and data. + +#### 8.9.2.1.3 UE-based mode + +In UE-based mode, the UE reports the latitude and longitude, together with an estimate of the location uncertainty, if available. + +The UE should also report an indication that TBS method is used and possibly other positioning methods used to calculate the fix. + +#### 8.9.2.2 Information that may be transferred from the E-SMLC to UE + +Table 8.9.2.2-1 lists assistance data for both UE-assisted and UE-based modes that may be sent from the E-SMLC to the UE. + +NOTE: The provision of these assistance data elements and the usage of these elements by the UE depend on the E-UTRAN and UE capabilities, respectively. + +**Table 8.9.2.2-1: Information that may be transferred from the E-SMLC to UE** + +| <b>Assistance Data</b> | +|------------------------| +| Acquisition assistance | +| Almanac | + +##### 8.9.2.2.1 Acquisition Assistance + +Acquisition assistance provides the MBS receiver with information about visible beacons, PN Codes, and other information of the MBS signals to enable a fast acquisition of the MBS signals. + +##### 8.9.2.2.2 Almanac + +Almanac assistance provides the MBS receiver with MBS beacon parameters that can be used to determine the UE position. + +### 8.9.3 TBS Positioning Procedures + +#### 8.9.3.1 Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request position measurements or location estimate from the UE, or to enable the UE to provide location measurements to the E-SMLC for position calculation (e.g., in case of basic self-location where the UE requests its own location). + +##### 8.9.3.1.1 E-SMLC initiated Location Information Transfer Procedure + +Figure 8.9.3.1.1-1 shows the Location Information Transfer operations for the TBS method when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure. The diagram shows two lifelines: UE and E-SMLC. Step 1: E-SMLC sends '1. LPP Request Location Information' to UE. Step 2: UE sends '2. LPP Provide Location Information' to E-SMLC.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` +sequenceDiagram + participant E-SMLC + participant UE + Note left of E-SMLC: 1. LPP Request Location Information + E-SMLC->>UE: 1. LPP Request Location Information + Note right of UE: 2. LPP Provide Location Information + UE->>E-SMLC: 2. LPP Provide Location Information +``` + +Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure. The diagram shows two lifelines: UE and E-SMLC. Step 1: E-SMLC sends '1. LPP Request Location Information' to UE. Step 2: UE sends '2. LPP Provide Location Information' to E-SMLC. + +**Figure 8.9.3.1.1-1: E-SMLC-initiated Location Information Transfer Procedure** + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of TBS positioning. This request includes positioning instructions such as the positioning mode (UE-assisted, UE-based, Standalone), specific requested UE measurements if any, and quality of service parameters (accuracy, response time). +- (2) The UE performs the requested measurements and possibly calculates its own location. The UE sends an LPP Provide Location Information message to the E-SMLC before the Response Time provided in step (1) elapsed. If the UE is unable to perform the requested measurements, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +#### 8.9.3.1.2 UE-initiated Location Information Delivery Procedure + +Figure 8.9.3.1.2-1 shows the Location Information delivery operations for the TBS method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Location Information Delivery Procedure. The diagram shows two lifelines: UE and E-SMLC. Step 1: UE sends '1. LPP Provide Location Information' to E-SMLC.](6334c962f5e106e3331e59946e4d166e_img.jpg) + +``` +sequenceDiagram + participant UE + participant E-SMLC + Note left of UE: 1. LPP Provide Location Information + UE->>E-SMLC: 1. LPP Provide Location Information +``` + +Sequence diagram for UE-initiated Location Information Delivery Procedure. The diagram shows two lifelines: UE and E-SMLC. Step 1: UE sends '1. LPP Provide Location Information' to E-SMLC. + +**Figure 8.9.3.1.2-1: UE-initiated Location Information Delivery Procedure** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include UE TBS measurements or location estimate already available at the UE. + +#### 8.9.3.2 Assistance Data Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to provide assistance data to the UE (e.g., as part of a positioning procedure) and the UE to request assistance data from the E-SMLC (e.g., as part of a positioning procedure or for autonomous self location (i.e., UE determines its own location)). + +##### 8.9.3.2.1 E-SMLC initiated Assistance Data Delivery + +Figure 8.9.3.2.1-1 shows the Assistance Data Delivery operations for the network-assisted TBS method when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Assistance Data Delivery Procedure](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +A sequence diagram showing the interaction between a UE (User Equipment) and an E-SMLC (Evolved-SMLC). The UE is on the left and the E-SMLC is on the right. A single message arrow points from the E-SMLC to the UE, labeled '1. LPP Provide Assistance Data'. + +Sequence diagram for E-SMLC-initiated Assistance Data Delivery Procedure + +**Figure 8.9.3.2.1-1: E-SMLC-initiated Assistance Data Delivery Procedure** + +- (1) The E-SMLC determines that assistance data needs to be provided to the UE (e.g., as part of a positioning procedure) and sends an LPP Provide Assistance Data message to the UE. This message may include any of the TBS assistance data defined in clause 8.9.2.2. + +#### 8.9.3.2.2 UE initiated Assistance Data Transfer + +Figure 8.9.3.2.2-1 shows the Assistance Data Transfer operations for the network-assisted TBS method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Assistance Data Transfer Procedure](8a94796989f4fcba2688c4faa7991538_img.jpg) + +A sequence diagram showing the interaction between a UE (User Equipment) and an E-SMLC (Evolved-SMLC). The UE is on the left and the E-SMLC is on the right. Two message arrows are shown: '1. LPP Request Assistance Data' from the UE to the E-SMLC, and '2. LPP Provide Assistance Data' from the E-SMLC back to the UE. + +Sequence diagram for UE-initiated Assistance Data Transfer Procedure + +**Figure 8.9.3.2.2-1: UE-initiated Assistance Data Transfer Procedure** + +- (1) The UE determines that certain TBS assistance data is desired (e.g., in case the UE requires its own location with autonomous self location or as part of a positioning procedure when the E-SMLC provided assistance data are not sufficient for the UE to fulfil the request) and sends a LPP Request Assistance Data message to the E-SMLC. This request includes an indication of which specific TBS assistance data is requested. +- (2) The E-SMLC provides the requested assistance data in a LPP Provide Assistance Data message, if available at the E-SMLC. The entire set of assistance data may be delivered in one or several LPP messages. In this case, this step may be repeated by the E-SMLC several times. If any of the UE requested assistance data in step (1) are not provided in step 2, the UE shall assume that the requested assistance data are not supported, or currently not available at the E-SMLC. If none of the UE requested assistance data in step (1) can be provided by the E-SMLC, return any information that can be provided in an LPP message of type Provide Assistance Data which includes a cause indication for the not provided assistance data. + +## 8.10 Motion sensor positioning method + +### 8.10.1 General + +Motion sensors can be used to estimate the location of the UE. With the combination of other positioning methods (hybrid) a more accurate position of the UE can be computed. UE using one or more motion sensors provides the + +movement information. The movement information comprises displacement results estimated at an ordered series of points. + +The positioning modes supported are UE-Assisted, UE-Based, and Standalone. + +## 8.10.2 Information to be transferred between E-UTRAN Elements + +This clause defines the information (e.g., assistance data, position and/or measurement data) that may be transferred between E-UTRAN elements. + +### 8.10.2.1 Information that may be transferred from the UE to E-SMLC + +The information transferred from the UE to the E-SMLC consists of capability information and location measurements or UE position. The supported information elements are given in Table 8.10.2.1-1. + +**Table 8.10.2.1-1: Sensor Measurement Information that may be transferred from UE to the E-SMLC** + +| Information | UE-assisted | UE-based/<br>Standalone | +|--------------------------|-------------|-------------------------| +| Displacement Timestamp | Yes | Yes | +| Displacement Information | Yes | Yes | +| Reference Position | Yes | Yes | +| Reference Time | Yes | Yes | + +#### 8.10.2.1.1 UE-assisted, UE-based, Standalone mode + +In the UE-assisted, UE-Based, and Standalone mode, the UE reports, displacement information, displacement timestamp, reference position and reference time stamp. + +#### 8.10.2.1.2 UE Displacement and Movement Information + +The UE may report movement and displacement information which comprises an ordered series of direction and distance travelled by the target device and the time intervals when these measurements are taken. + +### 8.10.2.2 Information that may be transferred from the E-SMLC to the UE + +In this release, no information, e.g. assistance data is transferred to the UE. + +## 8.10.3 Motion Sensors Location Information Transfer Procedure + +The purpose of this procedure is to enable the E-SMLC to request additional sensor measurements or to enable the UE to provide sensor measurements to the E-SMLC for position calculation. + +### 8.10.3.1 E-SMLC initiated Location Information Transfer Procedure + +Figure 8.10.3.1-1 shows the Location Information Transfer operations when the procedure is initiated by the E-SMLC. + +![Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure](c07e21a8d65991db04263322f859c94f_img.jpg) + +``` + +sequenceDiagram + participant UE + participant E-SMLC + E-SMLC->>UE: 1. LPP Request Location Information + UE->>E-SMLC: 2. LPP Provide Location Information + +``` + +The diagram illustrates the E-SMLC-initiated Location Information Transfer Procedure. It features two vertical lifelines: UE on the left and E-SMLC on the right. Step 1 shows a message arrow labeled '1. LPP Request Location Information' pointing from the E-SMLC to the UE. Step 2 shows a message arrow labeled '2. LPP Provide Location Information' pointing from the UE to the E-SMLC. + +Sequence diagram for E-SMLC-initiated Location Information Transfer Procedure + +**Figure 8.10.3.1-1: E-SMLC-initiated Location Information Transfer Procedure** + +- (1) The E-SMLC sends a LPP Request Location Information message to the UE for invocation of motion sensor positioning. This request includes positioning instructions such as the positioning mode, specific requested UE measurements if any, and quality of service parameters (accuracy, response time). +- (2) The UE performs the requested measurements. The UE sends an LPP Provide Location Information message to the E-SMLC before the Response Time provided in step (1) elapsed. If the UE is unable to perform the requested measurements, or if the Response Time provided in step 1 elapsed before any of the requested measurements have been obtained, the UE returns any information that can be provided in an LPP message of type Provide Location Information which includes a cause indication for the not provided location information. + +### 8.10.3.2 UE-initiated Location Information Delivery Procedure + +Figure 8.10.3.2-1 shows the Location Information delivery operations for motion sensor method when the procedure is initiated by the UE. + +![Sequence diagram for UE-initiated Location Information Delivery Procedure](4224f170b677d60f6f86ce95d8dc725a_img.jpg) + +``` + +sequenceDiagram + participant UE + participant E-SMLC + UE->>E-SMLC: 1. LPP Provide Location Information + +``` + +The diagram illustrates the UE-initiated Location Information Delivery Procedure. It features two vertical lifelines: UE on the left and E-SMLC on the right. Step 1 shows a message arrow labeled '1. LPP Provide Location Information' pointing from the UE to the E-SMLC. + +Sequence diagram for UE-initiated Location Information Delivery Procedure + +**Figure 8.10.3.2-1: UE-initiated Location Information Delivery Procedure** + +- (1) The UE sends an LPP Provide Location Information message to the E-SMLC. The Provide Location Information message may include UE sensor measurements or location estimate already available at the UE. + +--- + +## Annex A (informative): Definitions and Terms + +No further definitions and terms are currently described beyond those defined in clause 3. + +## Annex B (informative): Use of LPP with SUPL + +The design goal of LPP is to enable it to be used in user plane location solutions such as OMA SUPL ([17], [18]) and this informative annex shows how LPP can be used in SUPL 2.0. + +### B.1 SUPL 2.0 Positioning Methods and Positioning Protocols + +The following table shows how the 3GPP positioning protocols are supported in SUPL 2.0. + +**Table B.1-1: SUPL support of positioning methods** + +| Positioning Protocol: | RRLP<br>(GSM/GPRS/WCDMA/<br>LTE/WLAN/WiMAX) | RRC<br>(WCDMA) | LPP<br>(LTE) | +|---------------------------------------------------------------|---------------------------------------------|---------------------|--------------| +| Positioning Method: | | | | +| A-GPS (A-GANSS) SET Assisted | ✓ | ✓ | ✓ | +| A-GPS (A-GANSS) SET Based | ✓ | ✓ | ✓ | +| Autonomous GPS/GANSS | ✓ | ✓ | ✓ | +| Enhanced Cell ID | ✓ | ✓ | ✓ | +| Enhanced Observed Time Difference (E-OTD) | ✓ (GSM only) | NA | NA | +| Observed Time Difference of Arrival (OTDOA) <sup>NOTE 1</sup> | NA | ✓ | ✓ | +| Sensor | NA | ✓ <sup>NOTE 3</sup> | ✓ | +| WLAN | NA | ✓ | ✓ | +| Bluetooth | NA | ✓ | ✓ | +| TBS <sup>NOTE 2</sup> | NA | ✓ | ✓ | + +NOTE 1: This includes TBS positioning based on PRS signals, which is only supported in LPP (LTE). +NOTE 2: TBS positioning based on MBS signals. +NOTE 3: Only barometric pressure sensor is supported. + +Note: What is referred to in the SUPL specifications as "Enhanced Cell ID" is a UE-Assisted positioning mode where the neighbouring cell measurements are carried at the SUPL layer (in the SUPL\_POS\_INIT for example). For LTE, the ASN.1 container for this mode is defined as follows: + +``` +LteCellInformation ::= SEQUENCE { + cellGlobalIdEUTRA CellGlobalIdEUTRA, + physCellId PhysCellId, + trackingAreaCode TrackingAreaCode, + rsrpResult RSRP-Range OPTIONAL, + rsrqResult RSQ-Range OPTIONAL, + ta INTEGER(0..1282) OPTIONAL, -- Currently used Timing Advance value + (N_TA/16 as per [3GPP 36.213]) + measResultListEUTRA MeasResultListEUTRA OPTIONAL, --Neighbour measurements + ... + earfcn INTEGER(0..65535) OPTIONAL, -- see Table 37 + earfcn-ext INTEGER (65536..262143) OPTIONAL, -- see Table 37 + rsrpResult-ext RSRP-Range-Ext OPTIONAL, + rsrqResult-ext RSQ-Range-Ext OPTIONAL, + rs-sinrResult RS-SINR-Range OPTIONAL, + servingInformation5G ServingInformation5G OPTIONAL +} +``` + +``` +MeasResultListEUTRA ::= SEQUENCE (SIZE (1..maxCellReport)) OF MeasResultEUTRA +``` + +``` + +MeasResultEUTRA ::= SEQUENCE { + physCellId PhysCellId, + cgi-Info SEQUENCE { + cellGlobalId CellGlobalIdEUTRA, + trackingAreaCode TrackingAreaCode + } OPTIONAL, + measResult SEQUENCE { + rsrpResult RSRP-Range OPTIONAL, -- Mapping to measured values + rsrqResult RSRQ-Range OPTIONAL, -- in 3GPP TS 36.133 + ... + earfcn INTEGER(0..65535) OPTIONAL, -- see Table 37 + earfcn-ext INTEGER (65536..262143) OPTIONAL, -- see Table 37 + rsrpResult-ext RSRP-Range-Ext OPTIONAL, + rsrqResult-ext RSRQ-Range-Ext OPTIONAL, + rs-sinrResult RS-SINR-Range OPTIONAL, + neighbourInformation5G NeighbourInformation5G OPTIONAL + } +} + +``` + +It should be noted that in addition to the container provided by SUPL itself, any E-CID positioning methods defined within LPP proper can be supported in SUPL, via tunneling LPP as shown in this annex (in the same manner that A-GNSS and OTDOA are supported). + +## B.2 SUPL 2.0 and LTE Architecture + +This clause describes interworking between the control-plane LCS architecture, as defined in the main body of this specification, and SUPL 2.0. The E-SMLC either includes or has an interface to an SPC function as defined in OMA SUPL V2.0 ([17], [18]). It can thus provide a consistent set of positioning methods for deployments utilizing both control-plane and user-plane. + +The interworking does not enable use of user-plane signalling for part of a control-plane positioning session. The user plane in the interworking here is not intended as an alternative path for control-plane signalling that would be needed between UE and eNodeB for mechanisms such as A-GPS in a standalone C-plane solution. + +This interworking does enable the SPC to retrieve measurements (e.g., GNSS-to-RAN time relations) from eNodeB. + +The underlying architecture is shown in Figure B.2-1. Note that, for interworking between user-plane and control-plane positioning, no new interfaces need to be defined as compared to those in the figure, assuming the SPC is either integrated in the E-SMLC or attached to it with a proprietary interface. + +![System architecture underlying positioning diagram showing the flow of signaling and data between UE, eNB, MME, HSS, GMLC, E-SMLC, SPC, SLC, LCS Client, Serving Gateway, and PDN Gateway.](7fb9ad30fcd499d82f0047335bb21b4a_img.jpg) + +The diagram illustrates the system architecture for positioning. It shows the following components and interfaces: + +- UE** (User Equipment) connected to **eNB** via **LTE-Uu** (Modified interface). +- eNB** connected to **MME** via **S1-MME** (Signaling) and **S1-U** (Data). +- MME** connected to **HSS** via **S6a** (Signaling) and to **GMLC** via **SLg** (Signaling). +- HSS** connected to **GMLC** via **SLh** (Signaling). +- MME** connected to **Serving Gateway** via **S5** (Data). +- Serving Gateway** connected to **PDN Gateway** via **SGi** (Data). +- MME** connected to **E-SMLC** via **SLs** (Signaling). +- E-SMLC** contains an integrated **SPC** (SUPL Positioning Center). +- SPC** connected to **SLC** via **Llp** (Signaling). +- SLC** connected to **LCS Client** via **Le** (Signaling). +- PDN Gateway** connected to **SLC** via **Lup** (Data). + +**Legend:** + +- Red solid line: Signaling +- Blue solid line: Data +- Red dashed line: Connection via intermediate entities +- Yellow box: Modified interface +- Orange box: New interface +- Grey box: Non-LCS Entity + +System architecture underlying positioning diagram showing the flow of signaling and data between UE, eNB, MME, HSS, GMLC, E-SMLC, SPC, SLC, LCS Client, Serving Gateway, and PDN Gateway. + +Figure B.2-1: System architecture underlying positioning + +The Lup and Llp interfaces shown in this architecture are part of the user-plane solution only and are not required for control-plane positioning. The SLs interface is required for both control-plane and user-plane positioning, and needs to be capable of querying eNode Bs for information not related to a UE connection. + +SUPL, including the use of LPP over SUPL, takes place as part of the general user-plane protocol stack shown in Figure B.2-2. SUPL occupies the application layer in the stack, with LPP (or another positioning protocol) transported as another layer above SUPL. + +![Figure B.2-2: User-plane protocol stack diagram showing the protocol layers for UE, eNodeB, Serving GW, and PDN GW.](dcf83796ccf494110638fbd4677b931d_img.jpg) + +The diagram illustrates the user-plane protocol stack across four entities: UE, eNodeB, Serving GW, and PDN GW, connected via LTE-Uu, S1-U, S5/S8, and SGi interfaces respectively. The protocol layers are shown as follows: + +- UE:** Application, IP, PDCP, RLC, MAC, L1. +- eNodeB:** Contains a 'Relay' block. The left side (facing UE) has PDCP, RLC, MAC, L1. The right side (facing Serving GW) has GTP-U, UDP/IP, L2, L1. +- Serving GW:** Contains a 'Relay' block. The left side (facing eNodeB) has GTP-U, UDP/IP, L2, L1. The right side (facing PDN GW) has GTP-U, UDP/IP, L2, L1. +- PDN GW:** IP, GTP-U, UDP/IP, L2, L1. + +Figure B.2-2: User-plane protocol stack diagram showing the protocol layers for UE, eNodeB, Serving GW, and PDN GW. + +Figure B.2-2: User-plane protocol stack + +## B.3 LPP session procedures using SUPL + +This clause indicates how an LPP session relates to the SUPL structure. Figure B.3-1 shows how SUPL and LPP can be combined within a SUPL positioning session. Step 4 here is repeated to exchange multiple LPP messages between the SLP and SET. + +![Figure B.3-1: LPP session over SUPL sequence diagram showing the interaction between SLP and SET.](0779125369ae9c0108101b54fe2428bf_img.jpg) + +The sequence diagram shows the interaction between an SLP (SUPL Location Platform) and a SET (SUPL Enabled Terminal). The steps are: + +- SLP sends a **1. SUPL INIT** message to SET. +- SET responds with **2. Establish secure TCP/IP Connection**. +- SLP sends **3. SUPL POS INIT (E-CID measurements)**. +- SET responds with **4. SUPL POS (LPP PDU)**. +- SLP concludes the session with **5. SUPL END**. + +Figure B.3-1: LPP session over SUPL sequence diagram showing the interaction between SLP and SET. + +Figure B.3-1: LPP session over SUPL + +For positioning operations which take place entirely within an LPP session (step 4 in Figure B.3-1), the flow of LPP messages can be the same as in the control-plane version of LPP; the role of the (LPP) target is taken by the target SET, + +and that of the (LPP) server by the SLP. An example LPP flow, including exchange of capabilities, request and delivery of assistance data, and request and delivery of positioning information, is shown in Figure B.3-2. + +![Sequence diagram of an LPP session over SUPL between an LPP Target (Target SET) and an LPP Server (SLP).](145fb9b19dc6513e7bf84c9ba7f083f2_img.jpg) + +``` +sequenceDiagram + participant Target SET as LPP Target (Target SET) + participant SLP as LPP Server (SLP) + Note left of Target SET: 1. LPP PDU: Location information request [position estimate, transaction A] + Target SET->>SLP: 1. LPP PDU: Location information request [position estimate, transaction A] + Note right of SLP: 2. LPP PDU: Capability request [transaction B] + SLP->>Target SET: 2. LPP PDU: Capability request [transaction B] + Note left of Target SET: 3. LPP PDU: Capability indication [transaction B] + Target SET->>SLP: 3. LPP PDU: Capability indication [transaction B] + Note left of Target SET: 4. LPP PDU: Assistance data request [transaction C] + Target SET->>SLP: 4. LPP PDU: Assistance data request [transaction C] + Note right of SLP: 5. LPP PDU: Assistance data delivery [transaction C] + SLP->>Target SET: 5. LPP PDU: Assistance data delivery [transaction C] + Note left of Target SET: 6. LPP PDU: Location information request [measurements, transaction D] + Target SET->>SLP: 6. LPP PDU: Location information request [measurements, transaction D] + Note right of SLP: 7. LPP PDU: Location information [measurements, transaction D] + SLP->>Target SET: 7. LPP PDU: Location information [measurements, transaction D] + Note left of Target SET: 8. LPP PDU: Location information [position estimate, transaction A] + SLP->>Target SET: 8. LPP PDU: Location information [position estimate, transaction A] +``` + +Sequence diagram of an LPP session over SUPL between an LPP Target (Target SET) and an LPP Server (SLP). + +Figure B.3-2: LPP session over SUPL + +## B.4 Procedures combining C-plane and U-plane operations + +Since SUPL is by definition carried over the user plane, it is not really applicable to operations terminating at the eNode B. Thus, in some cases where information from the eNode B and UE needs to be merged for a positioning operation, SUPL operations must take place in combination with control-plane procedures over LPPa. + +This situation could arise in the case of UE-assisted OTDOA, for example, in which the SLP needs to provide the UE (in a SUPL session) with assistance data supplied by various eNode Bs. This clause uses a UE-assisted OTDOA positioning operation as a running example. + +Although the positioning server in this operation is of course the SLP, the existence of the Llp interface means that the SLP can communicate freely with the E-SMLC via the SPC. In particular, this means that assistance data that were delivered to the E-SMLC via LPPa can be transferred over to the SLP for delivery to the UE via LPP over SUPL. + +Several ways to realise this general behaviour are possible. In the simplest case, the E-SMLC could be supplied with the necessary assistance data in advance, so that they can be supplied to the SLP without any actual LPPa procedures taking place in real time (and possibly even before the positioning transaction begins). + +![Sequence diagram showing the transfer of OTDOA assistance data to UE via SUPL when data is already available at the E-SMLC.](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +``` + +sequenceDiagram + participant UE (SET) + participant eNode B + participant E-SMLC + participant SLP + eNode B->>E-SMLC: Assistance data (via LPPa) + UE<->SLP: SUPL session establishment + E-SMLC<->SLP: Assistance data (via Llp) + E-SMLC->>UE: Assistance data (via LPP/SUPL) + +``` + +This sequence diagram illustrates the transfer of OTDOA assistance data to a UE (SET) via SUPL when the data is already available at the E-SMLC. The process begins with the eNode B sending 'Assistance data (via LPPa)' to the E-SMLC. A 'SUPL session establishment' occurs between the UE and the SLP. The E-SMLC then exchanges 'Assistance data (via Llp)' with the SLP. Finally, the E-SMLC sends the 'Assistance data (via LPP/SUPL)' to the UE. + +Sequence diagram showing the transfer of OTDOA assistance data to UE via SUPL when data is already available at the E-SMLC. + +**Figure B.4-1: Transfer of OTDOA assistance data to UE via SUPL** + +In the event that the E-SMLC does not have the required assistance data available, however, it would need to retrieve them from appropriate eNode Bs once it was made aware that they were needed. + +![Sequence diagram showing the transfer of OTDOA assistance data to UE via SUPL when data is not already available at the E-SMLC.](a2bbc82e5c6132b0870bd70f6657f919_img.jpg) + +``` + +sequenceDiagram + participant UE (SET) + participant eNode B + participant E-SMLC + participant SLP + UE<->SLP: SUPL session establishment + UE->>SLP: Assistance data request (via LPP/SUPL) + SLP->>E-SMLC: Assistance data request (via Llp) + E-SMLC->>eNode B: Assistance data request (via LPPa) + eNode B->>E-SMLC: Assistance data (via LPPa) + E-SMLC->>SLP: Assistance data (via Llp) + E-SMLC->>UE: Assistance data (via LPP/SUPL) + +``` + +This sequence diagram illustrates the transfer of OTDOA assistance data to a UE (SET) via SUPL when the data is not already available at the E-SMLC. The process begins with a 'SUPL session establishment' between the UE and the SLP. The UE sends an 'Assistance data request (via LPP/SUPL)' to the SLP, which in turn sends an 'Assistance data request (via Llp)' to the E-SMLC. The E-SMLC then sends an 'Assistance data request (via LPPa)' to the eNode B. The eNode B responds with 'Assistance data (via LPPa)' to the E-SMLC. The E-SMLC then sends the 'Assistance data (via Llp)' to the SLP, and finally the 'Assistance data (via LPP/SUPL)' is delivered to the UE. + +Sequence diagram showing the transfer of OTDOA assistance data to UE via SUPL when data is not already available at the E-SMLC. + +**Figure B.4-2: Transfer to the UE via SUPL of OTDOA assistance data not already available at the E-SMLC** + +In both cases, it should be noted that the retrieval of the assistance data is transparent to the UE and to the actual SUPL session. This model is parallel to the approach used with A-GNSS, in which assistance data such as satellite ephemerides are retrieved from sources entirely external to the cellular network. For purposes of LPP over SUPL, the delivery of assistance data *to the SLP* can be looked on as an independent external process. + +The delivery of assistance data to the UE, however, takes place through the same mechanisms as control-plane LPP, transported through SUPL. + +## Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|-------------|--| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New version | | +| 2009-05 | RAN2#66 | R2-092922 | - | - | | Skeleton TS v0.0.0 | | | +| 2009-05 | RAN2#66 | R2-093522 | - | - | | RAN2 agreed skeleton TS v0.1.0 | | | +| 2009-05 | RAN2#66 | R2-093589 | - | - | | RAN2 agreed TS v0.2.0 | | | +| 2009-09 | RAN2#67 | R2-095377 | - | - | | RAN2 agreed TS v1.2.0 | | | +| 2009-09 | RAN #45 | RP-090977 | - | - | | RAN approved TS 36.305 | 9.0.0 | | +| 2009-12 | RP-46 | RP-091340 | 0001 | 1 | | Removal of UE-based OTDOA and ECID from LPP stage 2 | 9.1.0 | | +| | RP-46 | RP-091340 | 0004 | - | | Removal of capability storage at MME | 9.1.0 | | +| | RP-46 | RP-091340 | 0005 | - | | Transfer of LPPa PDU over S1 | 9.1.0 | | +| 2010-03 | RP-47 | RP-100304 | 0006 | - | | Clarification on E-CID parameters | 9.2.0 | | +| | RP-47 | RP-100304 | 0007 | - | | Clarification on positioning procedure | 9.2.0 | | +| | RP-47 | RP-100304 | 0008 | 1 | | Stage 2 updates to align with stage 3 | 9.2.0 | | +| | RP-47 | RP-100304 | 0009 | - | | Updates to LPP material in stage 2 | 9.2.0 | | +| | RP-47 | RP-100304 | 0010 | - | | Updates to LPPa material in stage 2 | 9.2.0 | | +| | RP-47 | RP-100304 | 0011 | - | | clarification on routing id | 9.2.0 | | +| | RP-47 | RP-100304 | 0012 | - | | Clarification of information transfer for OTDOA | 9.2.0 | | +| | RP-47 | RP-100304 | 0013 | - | | Add LPP procedures to align with 36.355 | 9.2.0 | | +| | RP-47 | RP-100304 | 0014 | - | | Clarification on Error Case Handling | 9.2.0 | | +| | RP-47 | RP-100304 | 0015 | - | | Transfer of LPPa PDUs over S1 | 9.2.0 | | +| 2010-06 | RP-48 | RP-100558 | 0016 | - | | Miscellaneous corrections to LPP stage 2 | 9.3.0 | | +| | RP-48 | RP-100558 | 0017 | - | | Correction on LPP session definition in LPP stage 2 | 9.3.0 | | +| 2010-09 | RP-49 | RP-100852 | 0018 | - | | Corrections on LPP session identifier in Stage 2 | 9.4.0 | | +| | RP-49 | RP-100852 | 0019 | - | | Clarifications to LPP transferred information | 9.4.0 | | +| 2010-12 | RP-50 | RP-101207 | 0022 | - | | Alignment of LPPa descriptions to stage 3 | 9.5.0 | | +| 2010-12 | RP-50 | - | - | - | | Upgrade to Release 10 - no technical change | 10.0.0 | | +| 2011-03 | RP-51 | RP-110269 | 0024 | - | | Alignment of LPPa descriptions to Stage 3 | 10.1.0 | | +| 2011-06 | RP-52 | RP-110830 | 0026 | - | | Corrections to Align Stage2 with Stage3 | 10.2.0 | | +| | RP-52 | RP-110830 | 0028 | - | | Corrections to the LPP protocol layering | 10.2.0 | | +| 2011-09 | RP-53 | RP-111279 | 0030 | - | | Clarification on E-CID method | 10.3.0 | | +| 2012-06 | RP-56 | RP-120820 | 0034 | 1 | | CR for 36.305 NBPS Support in LTE | 11.0.0 | | +| 2012-09 | RP-57 | RP-121374 | 0035 | 1 | | Number of SRS transmissions | 11.1.0 | | +| | RP-57 | RP-121394 | 0041 | - | | Clarification on the case that the eNB functions as an LCS client | 11.1.0 | | +| | RP-57 | RP-121374 | 0042 | - | | Correction to SRS configuration for UTDOA | 11.1.0 | | +| | RP-57 | RP-121374 | 0043 | 1 | | Network Based Positioning Support | 11.1.0 | | +| 2012-12 | RP-58 | RP-121931 | 0046 | - | | Cleanup of TS36.305 | 11.2.0 | | +| | RP-58 | RP-121931 | 0049 | - | | Addition of Network Triggered Service Request for LPP and LPPa Positioning | 11.2.0 | | +| | RP-58 | RP-121931 | 0050 | - | | Correction of E-CID Measurement Initiation | 11.2.0 | | +| | RP-58 | RP-121931 | 0052 | - | | Correlation of LPPa class 2 procedures involved in an LPPa transaction | 11.2.0 | | +| | RP-58 | RP-121949 | 0053 | - | | Network Based Positioning Support SRS Update | 11.2.0 | | +| | RP-58 | RP-121949 | 0055 | - | | SLmAP Stage 2 Clarification | 11.2.0 | | +| 2013-03 | RP-59 | RP-130244 | 0056 | - | | Network Based Positioning Support SRS Update for intra-MME handover | 11.3.0 | | +| 2013-12 | RP-62 | RP-132000 | 0058 | - | | Introduction of BDS in LTE | 12.0.0 | | +| 2014-06 | RP-64 | RP-140890 | 0059 | - | | Addition of Inter-RAT Measurements to Stage 2 Location Specification | 12.1.0 | | +| 2014-12 | RP-66 | RP-142120 | 0060 | - | | BDS update to version 2.0 | 12.2.0 | | +| 2015-12 | RP-70 | RP-152068 | 0061 | 2 | | RAT-Independent positioning enhancements | 13.0.0 | | +| 2016-12 | RP-74 | RP-162326 | 0063 | 1 | | CR for 36.305 Further Indoor positioning enhancements | 14.0.0 | | +| | RP-74 | RP-162326 | 0065 | - | | Reusing Available WLAN Measurements as E-CID Assistance Data | 14.0.0 | | +| 2017-03 | RP-75 | RP-170637 | 0066 | 2 | B | Support of UE positioning measurements in Idle State | 14.1.0 | | +| | RP-75 | RP-170647 | 0067 | - | F | Further Indoor positioning enhancements corrections | 14.1.0 | | +| 2017-06 | RP-76 | RP-171224 | 0069 | 1 | F | Clarification to positioning measurement in idle state | 14.2.0 | | +| 2017-09 | RP-77 | RP-171915 | 0070 | 2 | F | Clarification to positioning measurement in idle state | 14.3.0 | | +| 2018-07 | RP-80 | RP-181219 | 0074 | 1 | B | RTK Stage 2 CR for 36.305 | 15.0.0 | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------|--------| +| 2018-09 | RP-81 | RP-181952 | 0076 | 1 | F | Broadcast of assistance data | 15.1.0 | +| 2018-12 | RP-82 | RP-182674 | 0077 | 2 | F | Capture use of motion information from motion sensors | 15.2.0 | +| 2019-03 | RP-83 | RP-190550 | 0080 | 3 | F | Support of additional sensor methods (IMU) | 15.3.0 | +| 2019-06 | RP-84 | RP-191384 | 0082 | 1 | F | Minor updates for motion sensors | 15.4.0 | +| 2020-03 | RP-87 | RP-200357 | 0083 | 1 | B | Introduction of B1C signal in BDS system in A-GNSS | 16.0.0 | +| | RP-87 | RP-200365 | 0084 | 5 | B | CR of TS 36.305 for introducing NavIC in LTE – core part | 16.0.0 | +| | RP-87 | RP-200345 | 0085 | 1 | B | CR for the introduction of SSR positioning support into LTE | 16.0.0 | +| 2020-07 | RP-88 | RP-201175 | 0087 | 1 | A | CR to clarify the meaning of GNSS term in 36.305 Rel-16 | 16.1.0 | +| | RP-88 | RP-201190 | 0088 | 1 | F | Update B1I signal ICD file to v3.0 in BDS system in A-GNSS | 16.1.0 | +| 2020-09 | RP-89 | RP-201934 | 0092 | - | F | UE E-CID measurement reporting | 16.2.0 | +| 2021-06 | RP-92 | RP-211476 | 0104 | 2 | F | Correction to LTE stage2 spec for MO-LR | 16.3.0 | +| 2021-09 | RP-93 | RP-212441 | 0105 | - | F | Correction on user-plane positioning support by SUPL | 16.4.0 | +| 2023-06 | RP-100 | RP-231409 | 0114 | 1 | A | APC clarification for SSR positioning | 16.5.0 | +| | RP-100 | RP-231411 | 0116 | 1 | F | Zero Yaw clarification for SSR positioning | 16.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55205/raw.md b/marked/Rel-16/55_series/55205/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9259011602cdf506246c1cf99a76f1f27882b7e8 --- /dev/null +++ b/marked/Rel-16/55_series/55205/raw.md @@ -0,0 +1,463 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Introductory information (normative)..... | 5 | +| 3.1 Introduction ..... | 5 | +| 3.2 Algorithm Inputs and Outputs..... | 6 | +| 3.3 Notation..... | 6 | +| 3.3.1 Bit/Byte ordering..... | 6 | +| 3.3.2 List of Symbols..... | 6 | +| 4 The GSM-MILENAGE algorithms (normative)..... | 6 | +| 5 An alternative algorithm (informative)..... | 7 | +| 6 Test data for GSM-MILENAGE (informative) ..... | 8 | +| 6.1 Introduction ..... | 8 | +| 6.2 Format ..... | 8 | +| 6.3 Test Sets ..... | 9 | +| Annex A (informative): Change history..... | 15 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +This document has been prepared by the 3GPP Task Force, and contains an example set of algorithms which may be used as the GSM authentication and key generation functions A3 and A8. (It is not mandatory that the particular algorithms specified in this document are used - the A3 and A8 functions are operator-specifiable rather than being fully standardised). + +# --- 1 Scope + +The present document contains an example set of algorithms which may be used as the GSM authentication and key generation functions A3 and A8. (It is not mandatory that the particular algorithms specified in this document are used - the A3 and A8 functions are operator-specifiable rather than being fully standardised). + +Section 3 (normative) introduces the algorithms and describes their input and output parameters. Section 4 (normative) defines the algorithms. Section 5 (informative) describes an alternative algorithm that some operators may prefer. Section 6 (informative) provides test data. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 35.206: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3G Security; Specification of the MILENAGE Algorithm Set: An example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 2: Algorithm specification". +- [2] 3GPP TS 35.207: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3G Security; Specification of the MILENAGE Algorithm Set: An example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 3: Implementors' test data". +- [3] 3GPP TS 35.208: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3G Security; Specification of the MILENAGE Algorithm Set: An example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 4: Design conformance test data". +- [4] 3GPP TS 33.102 version 3.10.0: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3G Security; Security architecture (Release 1999)". +- [5] 3GPP TS 03.20 version 8.1.0: "3rd Generation Partnership Project; Digital cellular telecommunications system (Phase 2+); Security related network functions (Release 1999)". + +# --- 3 Introductory information (normative) + +## 3.1 Introduction + +Within the security architecture of the GSM system there are security functions A3 and A8. The operation of these functions falls completely within the domain of an individual operator, and the functions are therefore to be specified by each operator rather than being fully standardised. The algorithms specified in this document are examples that may be used by an operator who does not wish to design his own. + +The inputs and outputs of the two functions are defined in section 3.2. + +## 3.2 Algorithm Inputs and Outputs + +The inputs to the algorithms are given in table 1, the outputs in tables 2 and 3 below. + +**Table 1: Inputs to A3 and A8** + +| Parameter | Size (bits) | Comment | +|----------------|-------------|----------------------------------------------------------| +| K <sub>i</sub> | 128 | Subscriber key K <sub>i</sub> [0]...K <sub>i</sub> [127] | +| RAND | 128 | Random challenge RAND[0]...RAND[127] | + +**Table 2: A3 output** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|------------------------------------| +| SRES | 32 | Signed response SRES[0]...SRES[31] | + +**Table 3: A8 output** + +| Parameter | Size (bits) | Comment | +|----------------|-------------|-----------------------------------------------------| +| K <sub>c</sub> | 64 | Cipher key K <sub>c</sub> [0]...K <sub>c</sub> [63] | + +## 3.3 Notation + +### 3.3.1 Bit/Byte ordering + +All data variables in this specification are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of substrings, the leftmost (most significant) substring is numbered 0, the next most significant is numbered 1, and so on through to the least significant. When a variable, with bit length L, is shown in hexadecimal format, bit 0 is the most significant bit of the leftmost hexadecimal digit, and bit L-1 is the least significant bit of the rightmost hexadecimal digit. + +### 3.3.2 List of Symbols + +| | | +|------|----------------------------------------------------------------------------------| +| = | The assignment operator. | +| | The concatenation of the two operands. | +| ⊕ | The bitwise exclusive-OR operation. | +| X[i] | The i <sup>th</sup> bit of the variable X. (X = X[0] X[1] X[2] ..... ). | + +# 4 The GSM-MILENAGE algorithms (normative) + +An example algorithm set for UMTS, called MILENAGE (note 1), is specified in [1]. GSM-MILENAGE makes use of MILENAGE. + +Specifically, the functions from the UMTS MILENAGE which we make use of are the following (we prefix all input and output names by "MIL3G-" to distinguish them clearly from the inputs and outputs of A3 and A8): + +| Function | Inputs | Output | +|----------|---------------------------------|------------------------------| +| f2 | MIL3G-K[0]...MIL3G-K[127] | MIL3G-RES[0]...MIL3G-RES[63] | +| f3 | | MIL3G-CK[0]...MIL3G-CK[127] | +| f4 | MIL3G-RAND[0]...MIL3G-RAND[127] | MIL3G-IK[0]...MIL3G-IK[127] | + +The GSM-MILENAGE functions are defined as follows: + +- Let (MIL3G-K[0]...MIL3G-K[127]) = (K<sub>i</sub>[0]...K<sub>i</sub>[127]) +- Let (MIL3G-RAND[0]...MIL3G-RAND[127]) = (RAND[0]...RAND[127]) + +- Compute MIL3G-RES, MIL3G-CK and MIL3G-IK from MIL3G-K and MIL3G-RAND, using the MILENAGE functions $f2$ , $f3$ , and $f4$ respectively +- Set $(K_c[0] \dots K_c[63]) = (MIL3G-CK[0] \dots MIL3G-CK[63]) \oplus (MIL3G-CK[64] \dots MIL3G-CK[127]) \oplus (MIL3G-IK[0] \dots MIL3G-IK[63]) \oplus (MIL3G-IK[64] \dots MIL3G-IK[127])$ +- Derive SRES from MIL3G-RES using an operator-selected **SRES Derivation Function**. This function must be precisely specified for the GSM-MILENAGE A3 algorithm to be fully defined. The two main recommended options are as follows (note 2): + - Recommended SRES Derivation Function #1: + $(SRES[0] \dots SRES[31]) = (MIL3G-RES[0] \dots MIL3G-RES[31]) \oplus (MIL3G-RES[32] \dots MIL3G-RES[63])$ . + - Recommended SRES Derivation Function #2: + $(SRES[0] \dots SRES[31]) = (MIL3G-RES[0] \dots MIL3G-RES[31])$ . + +Alternative SRES Derivation Functions may be specified. + +NOTE 1: MILENAGE uses a 128-bit operator-specific constant **OP**; a value has to be assigned to this constant for MILENAGE to be fully specified. + +NOTE 2: The 3GPP standard conversion function to derive a GSM SRES of 32 bits from a UMTS XRES of up to 128 bits is as follows [4]: + $SRES = XRES*1 \oplus XRES*2 \oplus XRES*3 \oplus XRES*4$ , where $XRES*i$ is 16 octets long and $XRES*i = XRES$ if $XRES$ is 16 octets long and $XRES*i = XRES \parallel 0 \dots 0$ if $XRES$ is shorter than 16 octets, $XRES*i$ are all 4 octets long and $XRES*i = XRES*1 \parallel XRES*2 \parallel XRES*3 \parallel XRES*4$ + +Recommended SRES Derivation Function #1 is the result of applying this standard conversion function to a 64-bit XRES equal to $MIL3G-RES[0] \dots MIL3G-RES[63]$ from MILENAGE. Recommended SRES Derivation Function #2 is the result of applying this standard conversion function to a 32-bit XRES equal to $MIL3G-RES[0] \dots MIL3G-RES[31]$ from MILENAGE. + +# --- 5 An alternative algorithm (informative) + +The GSM-MILENAGE algorithms defined in section 3 are obtained by applying standard 3G-to-2G conversion functions defined in [4] to the outputs of the UMTS MILENAGE algorithms. + +If there is no desire to retain this compatibility with UMTS MILENAGE used in its 2G mode, a much simpler and more efficient algorithm would be to set $TEMP = E_{K_i}(RAND)$ , where $E$ is the 128-bit block cipher used as a basic building block in MILENAGE, i.e. $TEMP =$ the result of encrypting $RAND$ using the key $K_i$ ; then choose non-overlapping substrings of $TEMP$ to be $SRES$ and $K_c$ , e.g. $SRES = TEMP[0] \dots TEMP[31]$ and $K_c = TEMP[64] \dots TEMP[127]$ . + +This alternative does *not* form any part of the GSM-MILENAGE algorithms; it is included just for information. + +# 6 Test data for GSM-MILENAGE (informative) + +## 6.1 Introduction + +The test data sets presented here are derived directly from the MILENAGE test sets in [3]. + +## 6.2 Format + +The format of each test data set is as follows: + +| Test Set <i>n</i> | | +|-------------------|--------------------------------------------------------------------------------------------| +| Ki | subscriber secret key | +| RAND | random challenge | +| OP | operator-specific MILENAGE constant | +| OPc | derived from OP and Ki — see [1] | +| MIL3G-RES | MILENAGE <i>f2</i> output, included for information only | +| SRES#1 | A3 output SRES, if Recommended SRES Derivation Function #1 is used — see section 4, page 7 | +| SRES#2 | A3 output SRES, if Recommended SRES Derivation Function #2 is used — see section 4, page 7 | +| MIL3G-CK | MILENAGE <i>f3</i> output, included for information only | +| MIL3G-IK | MILENAGE <i>f4</i> output, included for information only | +| Kc | A8 output (cipher key) | + +All test data in this tabular format is shown in hexadecimal representation. The first test set is also shown in binary, to show explicitly the relationship between the binary data and the hexadecimal representation. + +## 6.3 Test Sets + +| Test Set 1 in binary format | | +|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ki | 01000110 01011011 01011100 11101000 10110001 10011001 10110100<br>10011111 10101010 01011111 00001010 00101110 11100010 00111000<br>10100110 10111100 | +| RAND | 00100011 01010101 00111100 10111110 10010110 00110111 10101000<br>10011101 00100001 10001010 11100110 01001101 10101110 01000111<br>10111111 00110101 | +| OP | 11001101 11000010 00000010 11010101 00010010 00111110 00100000<br>11110110 00101011 01101101 01100111 01101010 11000111 00101100<br>10110011 00011000 | +| OPc | 11001101 01100011 11001011 01110001 10010101 01001010 10011111<br>01001110 01001000 10100101 10011001 01001110 00110111 10100000<br>00101011 10101111 | +| MIL3G-RES | 10100101 01000010 00010001 11010101 11100011 10111010 01010000<br>10111111 | +| SRES#1 | 01000110 11111000 01000001 01101010 | +| SRES#2 | 10100101 01000010 00010001 11010101 | +| MIL3G-CK | 10110100 00001011 10101001 10100011 11000101 10001011 00101010<br>00000101 10111011 11110000 11011001 10000111 10110010 00011011<br>11111000 11001011 | +| MIL3G-IK | 11110111 01101001 10111100 11010111 01010001 00000100 01000110<br>00000100 00010010 01110110 01110010 01110001 00011100 01101101<br>00110100 01000001 | +| Kc | 11101010 11100100 10111110 10000010 00111010 11111001 10100000<br>10001011 | + +| Test Set 1 | | | | | +|------------|----------|----------|----------|----------| +| Ki | 465b5ce8 | b199b49f | aa5f0a2e | e238a6bc | +| RAND | 23553cbe | 9637a89d | 218ae64d | ae47bf35 | +| OP | cdc202d5 | 123e20f6 | 2b6d676a | c72cb318 | +| OPc | cd63cb71 | 954a9f4e | 48a5994e | 37a02baf | +| MIL3G-RES | a54211d5 | e3ba50bf | | | +| SRES#1 | 46f8416a | | | | +| SRES#2 | a54211d5 | | | | +| MIL3G-CK | b40ba9a3 | c58b2a05 | bbf0d987 | b21bf8cb | +| MIL3G-IK | f769bcd7 | 51044604 | 12767271 | 1c6d3441 | +| Kc | eae4be82 | 3af9a08b | | | + +| Test Set 2 | | | | | +|------------|----------|----------|----------|----------| +| Ki | fec86ba6 | eb707ed0 | 8905757b | 1bb44b8f | +| RAND | 9f7c8d02 | 1accf4db | 213ccff0 | c7f71a6a | +| OP | dbc59adc | b6f9a0ef | 735477b7 | fadf8374 | +| OPc | 1006020f | 0a478bf6 | b699f15c | 062e42b3 | +| MIL3G-RES | 8011c48c | 0c214ed2 | | | +| SRES#1 | 8c308a5e | | | | +| SRES#2 | 8011c48c | | | | +| MIL3G-CK | 5dbdbb29 | 54e8f3cd | e665b046 | 179a5098 | +| MIL3G-IK | 59a92d3b | 476a0443 | 487055cf | 88b2307b | +| Kc | aa01739b | 8caa976d | | | + +| Test Set 3 | | | | | +|------------|----------|----------|----------|----------| +| Ki | 9e5944ae | a94b8116 | 5c82fbf9 | f32db751 | +| RAND | ce83dbc5 | 4ac0274a | 157c17f8 | 0d017bd6 | +| OP | 223014c5 | 806694c0 | 07ca1eee | f57f004f | +| OPc | a64a507a | e1a2a98b | b88eb421 | 0135dc87 | +| MIL3G-RES | f365cd68 | 3cd92e96 | | | +| SRES#1 | cfbce3fe | | | | +| SRES#2 | f365cd68 | | | | +| MIL3G-CK | e203edb3 | 971574f5 | a94b0d61 | b816345d | +| MIL3G-IK | 0c4524ad | eac041c4 | dd830d20 | 854fc46b | +| Kc | 9a8ec95f | 408cc507 | | | + +| Test Set 4 | | | | | +|------------|----------|----------|----------|----------| +| Ki | 4ab1deb0 | 5ca6ceb0 | 51fc98e7 | 7d026a84 | +| RAND | 74b0cd60 | 31a1c833 | 9b2b6ce2 | b8c4a186 | +| OP | 2d16c5cd | 1fdf6b22 | 383584e3 | bef2a8d8 | +| OPc | dcf07cbd | 51855290 | b92a07a9 | 891e523e | +| MIL3G-RES | 5860fc1b | ce351e7e | | | +| SRES#1 | 9655e265 | | | | +| SRES#2 | 5860fc1b | | | | +| MIL3G-CK | 7657766b | 373d1c21 | 38f307e3 | de9242f9 | +| MIL3G-IK | 1c42e960 | d89b8fa9 | 9f2744e0 | 708ccb53 | +| Kc | cdc1dc08 | 41b81a22 | | | + +| Test Set 5 | | | | | +|------------|----------|----------|----------|----------| +| Ki | 6c38a116 | ac280c45 | 4f59332e | e35c8c4f | +| RAND | ee6466bc | 96202c5a | 557abbef | f8babf63 | +| OP | 1ba00a1a | 7c6700ac | 8c3ff3e9 | 6ad08725 | +| OPc | 3803ef53 | 63b947c6 | aaa225e5 | 8fae3934 | +| MIL3G-RES | 16c8233f | 05a0ac28 | | | +| SRES#1 | 13688f17 | | | | +| SRES#2 | 16c8233f | | | | +| MIL3G-CK | 3f8c7587 | fe8e4b23 | 3af676ae | de30ba3b | +| MIL3G-IK | a7466cc1 | e6b2a133 | 7d49d3b6 | 6e95d7b4 | +| Kc | df75bc5e | a899879f | | | + +| Test Set 6 | | | | | +|------------|----------|----------|----------|----------| +| Ki | 2d609d4d | b0ac5bf0 | d2c0de26 | 7014de0d | +| RAND | 194aa756 | 013896b7 | 4b4a2a3b | 0af4539e | +| OP | 460a4838 | 5427aa39 | 264aac8e | fc9e73e8 | +| OPc | c35a0ab0 | bcbfc925 | 2caff15f | 24efbde0 | +| MIL3G-RES | 8c25a16c | d918a1df | | | +| SRES#1 | 553d00b3 | | | | +| SRES#2 | 8c25a16c | | | | +| MIL3G-CK | 4cd08460 | 20f8fa07 | 31dd47cb | dc6be411 | +| MIL3G-IK | 88ab80a4 | 15f15c73 | 711254a1 | d388f696 | +| Kc | 84b417ae | 3aeab4f3 | | | + +| Test Set 7 | | | | | +|------------|----------|----------|----------|----------| +| Ki | a530a7fe | 428fad10 | 82c45edd | fce13884 | +| RAND | 3a4c2b32 | 45c50eb5 | c71d0863 | 9395764d | +| OP | 511c6c4e | 83e38c89 | b1c5d8dd | e62426fa | +| OPc | 27953e49 | bc8af6dc | c6e730eb | 80286be3 | +| MIL3G-RES | a63241e1 | ffc3e5ab | | | +| SRES#1 | 59f1a44a | | | | +| SRES#2 | a63241e1 | | | | +| MIL3G-CK | 10f05bab | 75a99a5f | bb98a9c2 | 87679c3b | +| MIL3G-IK | f9ec0865 | eb32f223 | 69cade40 | c59c3a44 | +| Kc | 3b4e244c | dc60ce03 | | | + +| Test Set 8 | | | | | +|------------|----------|----------|----------|----------| +| Ki | d9151cf0 | 4896e258 | 30bf2e08 | 267b8360 | +| RAND | f761e5e9 | 3d603feb | 730e2755 | 6cb8a2ca | +| OP | 75fc2233 | a44294ee | 8e6de25c | 4353d26b | +| OPc | c4c93eff | e8a08138 | c203d4c2 | 7ce4e3d9 | +| MIL3G-RES | 4a90b217 | 1ac83a76 | | | +| SRES#1 | 50588861 | | | | +| SRES#2 | 4a90b217 | | | | +| MIL3G-CK | 71236b71 | 29f9b22a | b77ea7a5 | 4c96da22 | +| MIL3G-IK | 90527eba | a5588968 | db417273 | 25a04d9e | +| Kc | 8d4ec01d | e597acfe | | | + +| Test Set 9 | | | | | +|------------|----------|----------|----------|----------| +| Ki | a0e2971b | 6822e8d3 | 54a18cc2 | 35624ecb | +| RAND | 08eff828 | b13fdb56 | 2722c65c | 7f30a9b2 | +| OP | 323792fa | ca21fb4d | 5d6f13c1 | 45a9d2c1 | +| OPc | 82a26f22 | bba9e948 | 8f949a10 | d98e9cc4 | +| MIL3G-RES | 4bc2212d | 8624910a | | | +| SRES#1 | cde6b027 | | | | +| SRES#2 | 4bc2212d | | | | +| MIL3G-CK | 08cef6d0 | 04ec6147 | 1a3c3cda | 048137fa | +| MIL3G-IK | ed0318ca | 5deb9206 | 272f6e8f | a64ba411 | +| Kc | d8debc4f | fbcd60aa | | | + +| Test Set 10 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 0da6f7ba | 86d5eac8 | a19cf563 | ac58642d | +| RAND | 679ac4db | acd7d233 | ff9d6806 | f4149ce3 | +| OP | 4b9a26fa | 459e3acb | ff36f401 | 5de3bdc1 | +| OPc | 0db1071f | 8767562c | a43a0a64 | c41e8d08 | +| MIL3G-RES | 6fc30fee | 6d123523 | | | +| SRES#1 | 02d13acd | | | | +| SRES#2 | 6fc30fee | | | | +| MIL3G-CK | 69b1cae7 | c7429d97 | 5e245cac | b05a517c | +| MIL3G-IK | 74f24e8c | 26df58e1 | b38d7dcd | 4f1b7fbd | +| Kc | f0eaa50a | 1edcebb7 | | | + +| Test Set 11 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 77b45843 | c88e58c1 | 0d202684 | 515ed430 | +| RAND | 4c47eb30 | 76dc55fe | 5106cb20 | 34b8cd78 | +| OP | bf3286c7 | a51409ce | 95724d50 | 3bfe6e70 | +| OPc | d483afae | 562409a3 | 26b5bb0b | 20c4d762 | +| MIL3G-RES | aefa357b | eac2a87a | | | +| SRES#1 | 44389d01 | | | | +| SRES#2 | aefa357b | | | | +| MIL3G-CK | 908c43f0 | 569cb8f7 | 4bc971e7 | 06c36c5f | +| MIL3G-IK | c251df0d | 888dd932 | 9bcf4665 | 5b226e40 | +| Kc | 82dbab7f | 83f063da | | | + +| Test Set 12 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 729b1772 | 9270dd87 | ccdf1bfe | 29b4e9bb | +| RAND | 311c4c92 | 9744d675 | b720f3b7 | e9b1cbd0 | +| OP | d04c9c35 | bd2262fa | 810d2924 | d036fd13 | +| OPc | 228c2f2f | 06ac3268 | a9e616ee | 16db4ba1 | +| MIL3G-RES | 98dbbd09 | 9b3b408d | | | +| SRES#1 | 03e0fd84 | | | | +| SRES#2 | 98dbbd09 | | | | +| MIL3G-CK | 44c0f23c | 5493cfd2 | 41e48f19 | 7e1d1012 | +| MIL3G-IK | 0c9fb816 | 13884c25 | 35dd0eab | f3b440d8 | +| Kc | 3c66cb98 | cab2d33d | | | + +| Test Set 13 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | d32dd23e | 89dc6623 | 54ca12eb | 79dd32fa | +| RAND | cf7d0ab1 | d9430695 | 0bf12018 | fbd46887 | +| OP | fe75905b | 9da47d35 | 6236d031 | 4e09c32e | +| OPc | d22a4b41 | 80a53257 | 08a5ff70 | d9f67ec7 | +| MIL3G-RES | af4a411e | 1139f2c2 | | | +| SRES#1 | be73b3dc | | | | +| SRES#2 | af4a411e | | | | +| MIL3G-CK | 5af86b80 | edb70df5 | 292cc112 | 1cbad50c | +| MIL3G-IK | 7f4d6ae7 | 440e1878 | 9a8b75ad | 3f42f03a | +| Kc | 9612b5d8 | 8a4130bb | | | + +| Test Set 14 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | af7c65e1 | 927221de | 591187a2 | c5987a53 | +| RAND | 1f0f8578 | 464fd59b | 64bed2d0 | 9436b57a | +| OP | 0c7acb8d | 95b7d4a3 | 1c5aca6d | 26345a88 | +| OPc | a4cf5c81 | 55c08a7e | ff418e54 | 43b98e55 | +| MIL3G-RES | 7bffa5c2 | f41fbc05 | | | +| SRES#1 | 8fe019c7 | | | | +| SRES#2 | 7bffa5c2 | | | | +| MIL3G-CK | 3f8c3f3c | cf7625bf | 77fc94bc | fd22fd26 | +| MIL3G-IK | abcbae8f | d46115e9 | 961a55d0 | da5f2078 | +| Kc | 75a150df | 3c6aed08 | | | + +| Test Set 15 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 5bd7ecd3 | d3127a41 | d12539be | d4e7cf71 | +| RAND | 59b75f14 | 251c7503 | 1d0bcbac | 1c2c04c7 | +| OP | f967f760 | 38b920a9 | cd25e10c | 08b49924 | +| OPc | 76089d3c | 0ff3efdc | 6e36721d | 4fceb747 | +| MIL3G-RES | 7e3f44c7 | 591f6f45 | | | +| SRES#1 | 27202b82 | | | | +| SRES#2 | 7e3f44c7 | | | | +| MIL3G-CK | d42b2d61 | 5e49a03a | c275a5ae | f97af892 | +| MIL3G-IK | 0b3f8d02 | 4fe6bfaf | aa982b8f | 82e319c2 | +| Kc | b7f92e42 | 6a36fec5 | | | + +| Test Set 16 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 6cd1c6ce | b1e01e14 | f1b82316 | a90b7f3d | +| RAND | f69b78f3 | 00a0568b | ce9f0cb9 | 3c4be4c9 | +| OP | 078bfca9 | 564659ec | d8851e84 | e6c59b48 | +| OPc | a219dc37 | f1dc7d66 | 738b5843 | c799f206 | +| MIL3G-RES | 70f6bdb9 | ad21525f | | | +| SRES#1 | ddd7efe6 | | | | +| SRES#2 | 70f6bdb9 | | | | +| MIL3G-CK | 6edaf99e | 5bd9f85d | 5f36d91c | 1272fb4b | +| MIL3G-IK | d61c853c | 280dd9c4 | 6f297bae | c386de17 | +| Kc | 88d9de10 | a22004c5 | | | + +| Test Set 17 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | b73a90cb | cf3afb62 | 2dba83c5 | 8a8415df | +| RAND | b120f1c1 | a0102a2f | 507dd543 | de68281f | +| OP | b672047e | 003bb952 | dca6cb8a | f0e5b779 | +| OPc | df0c6786 | 8fa25f74 | 8b7044c6 | e7c245b8 | +| MIL3G-RES | 479dd25c | 20792d63 | | | +| SRES#1 | 67e4ff3f | | | | +| SRES#2 | 479dd25c | | | | +| MIL3G-CK | 66195dbe | d0313274 | c5ca7766 | 615fa25e | +| MIL3G-IK | 66bec707 | eb2afc47 | 6d7408a8 | f2927b36 | +| Kc | a819e577 | a8d6175b | | | + +| Test Set 18 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 51222502 | 14c33e72 | 3a5dd523 | fc145fc0 | +| RAND | 81e92b6c | 0ee0e12e | bceba8d9 | 2a99dfa5 | +| OP | c9e87632 | 86b5b9ff | bdf56e12 | 97d0887b | +| OPc | 981d464c | 7c52eb6e | 50362349 | 84ad0bcf | +| MIL3G-RES | 28d7b0f2 | a2ec3de5 | | | +| SRES#1 | 8a3b8d17 | | | | +| SRES#2 | 28d7b0f2 | | | | +| MIL3G-CK | 5349fbe0 | 98649f94 | 8f5d2e97 | 3a81c00f | +| MIL3G-IK | 9744871a | d32bf9bb | d1dd5ce5 | 4e3e2e5a | +| Kc | 9a8d0e88 | 3ff0887a | | | + +| Test Set 19 | | | | | +|-------------|----------|----------|----------|----------| +| Ki | 90dca4ed | a45b53cf | 0f12d7c9 | c3bc6a89 | +| RAND | 9fddc720 | 92c6ad03 | 6b6e4647 | 89315b78 | +| OP | 3ffcfe5b | 7b111158 | 9920d352 | 8e84e655 | +| OPc | cb9cccc4 | b9258e6d | ca476037 | 9fb82581 | +| MIL3G-RES | a95100e2 | 760952cd | | | +| SRES#1 | df58522f | | | | +| SRES#2 | a95100e2 | | | | +| MIL3G-CK | b5f2da03 | 883b69f9 | 6bf52e02 | 9ed9ac45 | +| MIL3G-IK | b4721368 | bc16ea67 | 875c5598 | 688bb0ef | +| Kc | ed29b2f1 | c27f9f34 | | | + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|-------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | Old | New | +| 2002-05 | - | - | - | - | - | ETSI SAGE version 1.0 produced and forwarded to SA WG3 for approval. | | SAGE 1.0 | +| 2002-12 | SP-18 | SP-020724 | - | - | - | Approved by SA WG3 meeting #26 (S3-020675). Editorial update to change MILENAGE-2G to GSM-MILENAGE and correction to references. Updated to 3GPP TS format (Technically equivalent to ETSI SAGE version 1.0). Presentation to TSG SA#18 for approval (Release 6). | SAGE 1.0 | 1.0.0 | +| 2002-12 | SP-18 | - | - | - | - | Approved at TSG SA#18. Updated to Version 6.0.0 for publication (Rel-6) | 1.0.0 | 6.0.0 | +| 2003-12 | SP-22 | SP-030606 | 0001 | - | D | Correction of reference | 6.0.0 | 6.1.0 | +| 2006-03 | SP-31 | SP-060057 | 0002 | - | F | Clarifying the Bit/Byte ordering and symbols for GSM-MILENAGE example algorithm | 6.1.0 | 6.2.0 | +| 2007-06 | SP-36 | - | - | - | - | Update to Rel-7 version (MCC) | 6.2.0 | 7.0.0 | +| 2008-12 | SP-42 | - | - | - | - | Update to Rel-8 version (MCC) | 7.0.0 | 8.0.0 | +| 2009-12 | - | - | - | - | - | Update to Rel-9 version (MCC) | 8.0.0 | 9.0.0 | +| 2011-03 | - | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-10 | - | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55216/raw.md b/marked/Rel-16/55_series/55216/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..407d2e00ea86174d57bde37468a33455a52c4d10 --- /dev/null +++ b/marked/Rel-16/55_series/55216/raw.md @@ -0,0 +1,93 @@ + + + + + + +# --- Contents + +| | | +|-------------------------------------------------|---| +| Foreword ..... | 4 | +| 0 Scope..... | 5 | +| 0A References..... | 5 | +| 0B Definitions, symbols and abbreviations ..... | 5 | +| 0B.1 Definitions..... | 5 | +| 0B.2 Symbols..... | 5 | +| 0B.3 Abbreviations ..... | 5 | +| 0C Technical provisions ..... | 5 | +| Annex D (informative): Change history..... | 6 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 0 Scope + +The present document specifies the A5/3 and GEA3 specification. + +# --- 0A References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP Task Force Specification: "Specification of the A5/3 encryption algorithms for GSM and ECSD, and the GEA3 encryption algorithm for GPRS; Document 1: A5/3 and GEA3 specification" version 1.1, 2002-05-30 + +Note: Reference [2] is available via <http://portal.etsi.org/dvbandca/home.asp> and is subject to licensing conditions described at this site. + +# --- 0B Definitions, symbols and abbreviations + +## 0B.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and in the 3GPP Task Force Specification [2] apply. A term defined in the latter document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 0B.2 Symbols + +For the purposes of the present document, the symbols defined in the 3GPP Task Force Specification [2] apply. + +## 0B.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [2] and in the 3GPP Task Force Specification [2] apply. An abbreviation defined in the latter document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +# --- 0C Technical provisions + +The technical provisions of the current document are contained in the 3GPP Task Force Specification [2]. + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2002-05 | - | - | - | - | ETSI SAGE first publication | | SAGE V1.0 | +| 2002-07 | - | - | - | - | Agreed at SA WG3 #24 for presentation to TSG SA #17 for approval. Converted into 3GPP TS format as TS 55.216 (Technically equivalent to SAGE V1.0) | SAGE V1.0 | 1.0.0 | +| 2002-09 | SP-17 | SP-020506 | - | - | Approved for Release 6 - version 6.0.0 | 1.0.0 | 6.0.0 | +| 2002-12 | SP-18 | SP-020721 | 001 | - | EGPRS algorithm | 6.0.0 | 6.1.0 | +| 2003-09 | SP-19 | SP-030490 | 002 | - | Clarification on the usage of the Key length | 6.1.0 | 6.2.0 | +| 2007-12 | SP-38 | SP-070776 | 003 | - | Conversion to pointer to export controlled document<br>Note: Version 7.0.0 is a "readme" file placeholder with no technical content. | 6.2.0 | 7.1.0 | +| 2008-12 | SP-42 | - | - | - | Upgrade to Release 8 | 7.1.0 | 8.0.0 | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 8.0.0 | 9.0.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55217/raw.md b/marked/Rel-16/55_series/55217/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a17c62aa7d7e2a5444277fcda97f3711ba75b63a --- /dev/null +++ b/marked/Rel-16/55_series/55217/raw.md @@ -0,0 +1,93 @@ + + + + + + +# --- Contents + +| | | +|-------------------------------------------------|---| +| Foreword ..... | 4 | +| 0 Scope..... | 5 | +| 0A References..... | 5 | +| 0B Definitions, symbols and abbreviations ..... | 5 | +| 0B.1 Definitions..... | 5 | +| 0B.2 Symbols..... | 5 | +| 0B.3 Abbreviations ..... | 5 | +| 0C Technical provisions ..... | 5 | +| Annex A: Change history..... | 6 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 0 Scope + +The present document specifies implementors' test data for the A5/3 and GEA3 specification. + +# --- 0A References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP Task Force Specification: "Specification of the A5/3 encryption algorithms for GSM and EDGE, and the GEA3 encryption algorithm for GPRS; Document 2: Implementors' test data". + +Note: Reference [2] is available via <http://portal.etsi.org/dvbandca/home.asp> and is subject to licensing conditions described at this site. + +# --- 0B Definitions, symbols and abbreviations + +## 0B.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and in the 3GPP Task Force Specification [2] apply. A term defined in the latter document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 0B.2 Symbols + +For the purposes of the present document, the symbols defined in the 3GPP Task Force Specification [2] apply. + +## 0B.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [2] and in the 3GPP Task Force Specification [2] apply. An abbreviation defined in the latter document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +# --- 0C Technical provisions + +The technical provisions of the current document are contained in the 3GPP Task Force Specification [2]. + +# Annex A: Change history + +| Change history | | | | | | | | +|-------------------------------------------------------------------------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2002-05 | - | - | - | - | ETSI SAGE first publication | | SAGE V1.0 | +| 2002-07 | - | - | - | - | Agreed at SA WG3 #24 for presentation to TSG SA #17 for approval. Converted into 3GPP TS format (TS 55.217) (Technically equivalent to SAGE V1.0) | SAGE V1.0 | 1.0.0 | +| 2002-09 | SP-17 | SP-020506 | - | - | Approved for Release 6 - version 6.0.0 | 1.0.0 | 6.0.0 | +| 2002-12 | SP-18 | SP-020721 | 001 | - | EGPRS algorithm | 6.0.0 | 6.1.0 | +| 2007-12 | SP-38 | SP-070776 | 002 | - | Conversion to pointer to export controlled document | 6.1.0 | 7.1.0 | +| 2008-12 | SP-42 | - | - | - | Upgrade to Release 8 | 7.1.0 | 8.0.0 | +| 2009-12 | SP-46 | - | - | - | Upgrade to Release 9 | 8.0.0 | 9.0.0 | +| Note: Version 7.0.0 is a "readme" file placeholder with no technical content. | | | | | | | | +| 2011-03 | SP-51 | -- | -- | -- | Upgrade to Release 10 | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55218/raw.md b/marked/Rel-16/55_series/55218/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f6040cfa5ce56f3d385a6e8f4996f010c43bf51f --- /dev/null +++ b/marked/Rel-16/55_series/55218/raw.md @@ -0,0 +1,93 @@ + + + + + + +# --- Contents + +| | | +|-------------------------------------------------|---| +| Foreword ..... | 4 | +| 0 Scope..... | 5 | +| 0A References..... | 5 | +| 0B Definitions, symbols and abbreviations ..... | 5 | +| 0B.1 Definitions..... | 5 | +| 0B.2 Symbols..... | 5 | +| 0B.3 Abbreviations ..... | 5 | +| 0C Technical provisions ..... | 5 | +| Annex A: (informative) Change history ..... | 6 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 0 Scope + +The present document specifies the A5/3 and GEA3 specification. + +# --- 0A References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP Task Force Specification: "Specification of the A5/3 encryption algorithms for GSM and ECSD, and the GEA3 encryption algorithm for GPRS; Document 3: Design and conformance test data". + +Note: Reference [2] is available via <http://portal.etsi.org/dvbandca/home.asp> and is subject to licensing conditions described at this site. + +# --- 0B Definitions, symbols and abbreviations + +## 0B.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and in the 3GPP Task Force Specification [2] apply. A term defined in the latter document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 0B.2 Symbols + +For the purposes of the present document, the symbols defined in the 3GPP Task Force Specification [2] apply. + +## 0B.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and in the 3GPP Task Force Specification [2] apply. An abbreviation defined in the latter document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +# --- 0C Technical provisions + +The technical provisions of the current document are contained in the 3GPP Task Force Specification [2]. + +# Annex A: (informative) Change history + +| Change history | | | | | | | | +|-------------------------------------------------------------------------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2002-05 | - | - | - | - | ETSI SAGE first publication | | SAGE V1.0 | +| 2002-07 | - | - | - | - | Agreed at SA WG3 #24 for presentation to TSG SA #17 for approval. Converted into 3GPP TS format (TS 55.218) (Technically equivalent to SAGE V1.0) | SAGE V1.0 | 1.0.0 | +| 2002-09 | SP-17 | SP-020506 | - | - | Approved for Release 6 - version 6.0.0 | 1.0.0 | 6.0.0 | +| 2002-12 | SP-18 | SP-020721 | 001 | - | EGPRS algorithm | 6.0.0 | 6.1.0 | +| 2007-12 | SP-38 | SP-070776 | 002 | - | Conversion to pointer to export controlled document | 6.1.0 | 7.1.0 | +| 2008-12 | SP-42 | - | - | - | Upgrade to Release 8 | 7.1.0 | 8.0.0 | +| 2009-12 | SP-46 | - | - | - | Upgrade to Release 9 | 8.0.0 | 9.0.0 | +| Note: Version 7.0.0 is a "readme" file placeholder with no technical content. | | | | | | | | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55226/raw.md b/marked/Rel-16/55_series/55226/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..08d8a0847ac96cedd9459af229279bf4b9328d7a --- /dev/null +++ b/marked/Rel-16/55_series/55226/raw.md @@ -0,0 +1,90 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Technical provisions ..... | 5 | +| Annex F (informative): Change history..... | 6 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +In this document are specified three ciphering algorithms: A5/4 for GSM, A5/4 for ECSD, and GEA4 for GPRS (including EGPRS). The algorithms are stream ciphers that are used to encrypt/decrypt blocks of data under a confidentiality key KC. Each of these algorithms is based on the KASUMI algorithm that is specified in TS 35.202 [5]. The three algorithms are all very similar. We first define a core keystream generator function KGCORE (clause 4); we then specify each of the three algorithms in turn (clauses 5, 6 and 7) in terms of this core function. + +Note that: + +- GSM A5/4 is the same algorithms as GSM A5/3 but with KLEN changed from 64 to 128 bits. +- and ECSD A5/4 is the same algorithms as ECSD A5/3 but with KLEN changed from 64 to 128 bits. +- and GEA 4 is the same algorithms as GEA3 but with KLEN changed from 64 to 128 bits. + +# --- 1 Scope + +This specification of the **A5/4** encryption algorithms for GSM and ECSD, and of the **GEA4** encryption algorithm for GPRS has been derived from TS 55.516 [1]: Specification of the A5/3 Encryption Algorithms for GSM and ECSD, and the **GEA3** Encryption Algorithm for GPRS. The only essential change is the change of external key length input from 64 bits to 128 bits. + +This document should be read in conjunction with the entire specification of the **A5/3** and **GEA3** algorithms: + +- Specification of the A5/3 Encryption Algorithms for GSM and ECSD, and the GEA3 Encryption Algorithm for GPRS. Document 1: A5/3 and GEA3 Specifications. +- Specification of the A5/3 Encryption Algorithms for GSM and ECSD, and the GEA3 Encryption Algorithm for GPRS. Document 2: Implementors' Test Data. +- Specification of the A5/3 Encryption Algorithms for GSM and ECSD, and the GEA3 Encryption Algorithm for GPRS. Document 3: Design Conformance Test Data. + +The normative part of the specification of the block cipher (**KASUMI**) on which the **A5/3**, **A5/4**, **GEA3** and **GEA4** algorithms are based can be found in TS 35.202 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] to [5] (void) + +[6] 3GPP Task Force Specification: "3G Security; Specification of the A5/4 Encryption Algorithms for GSM and ECSD, and the GEA4 Encryption Algorithm for GPRS", version 9.0.0. + +Note: Reference [6] is available via <http://www.etsi.org/WebSite/OurServices/Algorithms/algorithms.aspx> and is subject to licensing conditions described at this site. + +# --- 3 Technical provisions + +The technical provisions of the current document are contained in the 3GPP Task Force Specification [6]. + +# Annex F (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|--------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 02-2004 | - | - | - | - | Draft presented to SA WG3 for agreement | --- | 0.1.0 | +| 03-2004 | SA 23 | SP-040170 | - | - | Draft provided to TSG SA for information | 0.1.0 | 1.0.0 | +| 09-2009 | SA 45 | SP-090647 | - | - | Draft provided to TSG SA for approval | 1.0.0 | 2.0.0 | +| 09-2009 | SA 45 | SP-090647 | - | - | Approval at SA#45 and placement under CR control | 2.0.0 | 9.0.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-10 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55236/raw.md b/marked/Rel-16/55_series/55236/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..42cd35119850a440a4cd8add222bfc5ba91e9f73 --- /dev/null +++ b/marked/Rel-16/55_series/55236/raw.md @@ -0,0 +1,386 @@ + + + + + + +# --- Contents + +| | | +|------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Symbols..... | 5 | +| 3.3 Abbreviations ..... | 6 | +| 4 Introductory information..... | 6 | +| 4.1 Introduction ..... | 6 | +| 4.2 Notation..... | 6 | +| 4.2.1 Bit/byte ordering..... | 6 | +| 4.2.2 List of symbols ..... | 6 | +| 4.3 List of variables..... | 6 | +| 4.4 Algorithm inputs and outputs..... | 6 | +| 5 The A8_V MILENAGE algorithm ..... | 7 | +| 6 Test data for A8_V MILENAGE..... | 7 | +| 6.1 Introduction ..... | 7 | +| 6.2 Format ..... | 7 | +| 6.3 Test Sets ..... | 8 | +| Annex A (informative): Change history..... | 12 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document contains an example algorithm which may be used as the VSTK key generation function A8\_V as described in TS 43.020 [4]. (It is not mandatory that the particular algorithm specified in this document is used - the A8\_V function is operator-specifiable rather than being fully standardised.) + +Clause 4 introduces the algorithm and describes the input and output parameters. Clause 5 defines the algorithm. Clause 6 provides test data. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - 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*. +- [1] 3GPP TS 35.206: "3G Security; Specification of the MILENAGE algorithm set: An example algorithm Set for the 3GPP Authentication and Key Generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 2: Algorithm specification". +- [2] 3GPP TS 35.207: "3G Security; Specification of the MILENAGE Algorithm Set: An example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 3: Implementors' test data". +- [3] 3GPP TS 35.208: "3G Security; Specification of the MILENAGE Algorithm Set: An example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 4: Design conformance test data". +- [4] 3GPP TS 43.020: " Security related network functions". +- [5] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [5], TS 35.206 [1] and TS 43.020 [4], 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 [5], TS 35.206 [1] or TS 43.020 [4]. + +## 3.2 Symbols + +- | | | +|------|----------------------------------------------------------------------------------| +| = | The assignment operator. | +| | The concatenation of the two operands. | +| X[i] | The i <sup>th</sup> bit of the variable X. (X = X[0] X[1] X[2] ..... ). | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [5], TS 35.206 [1] and TS 43.020 [4], 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 [5], TS 35.206 [1] or TS 43.020 [4]. + +- | | | +|-----|-------------------------| +| VBS | Voice Broadcast Service | +|-----|-------------------------| + +# 4 Introductory information + +## 4.1 Introduction + +For VGCS and VBS ciphering in the GSM system the security function A8\_V has been specified. The operation of this function falls completely within the domain of an individual operator, and the function is therefore to be specified by each operator rather than being fully standardized. The algorithm specified in this document is an example that may be used by an operator which does not wish to design its own. + +The inputs and outputs of the function A8\_V is defined in clause 4.4. + +## 4.2 Notation + +### 4.2.1 Bit/byte ordering + +All data variables in this specification are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of substrings, the leftmost (most significant) substring is numbered 0, the next most significant is numbered 1, and so on through to the least significant. When a variable, with bit length L, is shown in hexadecimal format, bit 0 is the most significant bit of the leftmost hexadecimal digit, and bit L-1 is the least significant bit of the rightmost hexadecimal digit. + +### 4.2.2 List of symbols + +See clause 3.2 + +## 4.3 List of variables + +For V\_Ki, VSTK RAND and VSTK see TS 43.020 [4] + +For all f3-function related variables see TS 35.206 [1] + +## 4.4 Algorithm inputs and outputs + +The inputs to the algorithm are given in table 1, the output in table 2 below. + +**Table 1: Inputs to A8\_V** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|-----------------------------------------------| +| V_Ki | 128 | Group key V_Ki[0]...V_Ki[127] | +| VSTK RAND | 36 | Random challenge VSTK RAND[0]...VSTK RAND[35] | + +**Table 2: Outputs from A8\_V** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|--------------------------------| +| VSTK | 128 | Cipher key VSTK[0]...VSTK[127] | + +# 5 The A8\_V MILENAGE algorithm + +An example algorithm set for UMTS, called MILENAGE (see Note 1), is specified in TS 35.206 [1]. A8\_V MILENAGE makes use of MILENAGE. + +Specifically, the function f3 from the UMTS MILENAGE is making use of (all input and output names are prefixed by "MIL3G-" to distinguish them clearly from the inputs and outputs of A8\_V MILENAGE): + +| Function | Inputs | Output | +|-----------|--------------------------------------------------------------|-----------------------------| +| <b>f3</b> | MIL3G-K[0]...MIL3G-K[127]<br>MIL3G-RAND[0]...MIL3G-RAND[127] | MIL3G-CK[0]...MIL3G-CK[127] | + +The A8\_V MILENAGE functions are defined as follows: + +- Let (MIL3G-K[0]...MIL3G-K[127]) = (V\_Ki[0]...V\_Ki[127]) +- Let (MIL3G-RAND[0]...MIL3G-RAND[127]) = (EXP RAND[0]...EXP RAND[127]) + +Whereby + +**EXP RAND**[bits 0,1, . . .126,127] = **EXPAND**[bits 0,1, . . .39] || **EXPAND**[bits 0,1, . . .39] || **EXPAND**[bits 0,1, . . .39] || '11111111' + +**EXPAND** [bits 0,1, . . .39] = '1111' || **VSTK RAND**[bits 0,1, . . .35] + +- Compute MIL3G-CK from MIL3G-K and MIL3G-RAND, using the MILENAGE function **f3** +- Set (VSTK[0]...VSTK[127]) = (MIL3G-CK[0]...MIL3G-CK[127]) + +NOTE 1: MILENAGE uses a 128-bit operator-specific constant **OP**; a value has to be assigned to this constant for MILENAGE to be fully specified. + +# 6 Test data for A8\_V MILENAGE + +## 6.1 Introduction + +The test data sets presented here have been derived from the MILENAGE test sets in [3]. + +## 6.2 Format + +The format of each test data set is as follows: + +| Test Set <i>n</i> | | +|-------------------|---------------------------------------------------------------------------------------------| +| V_Ki | secret group key | +| VSTK RAND | 36-bit random challenge | +| MIL3G-RAND | 128-bit expansion of VSTK RAND according to clause 4 | +| OP | operator-specific MILENAGE constant | +| OPc | derived from OP and V_Ki — see [1] | +| MIL3G-CK (VSTK) | MILENAGE <b>f3</b> output, that equals the Short Term Key for use in VGCS and VBS ciphering | + +All test data in this tabular format is shown in hexadecimal representation. The first test set is also shown in binary, to show explicitly the relationship between the binary data and the hexadecimal representation. + +## 6.3 Test Sets + +| Test Set 1 in binary format | | +|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| V_Ki | 01000110 01011011 01011100 11101000 10110001 10011001 10110100<br>10011111 10101010 01011111 00001010 00101110 11100010 00111000<br>10100110 10111100 | +| VSTK RAND | 00100011 01010101 00111100 10111110 1001 | +| MIL3G-RAND | 11110010 00110101 01010011 11001011 11101001 11110010 00110101<br>01010011 11001011 11101001 11110010 00110101 01010011 11001011<br>11101001 11111111 | +| OP | 11001101 11000010 00000010 11010101 00010010 00111110 00100000<br>11110110 00101011 01101101 01100111 01101010 11000111 00101100<br>10110011 00011000 | +| OPc | 11001101 01100011 11001011 01110001 10010101 01001010 10011111<br>01001110 01001000 10100101 10011001 01001110 00110111 10100000<br>00101011 10101111 | +| MIL3G-CK (VSTK) | 11010111 01110011 11000111 11111111 11000110 01000000 11001101<br>00100100 10000001 11110101 00010010 11011100 10111101 01011100<br>11000000 11110110 | + +| Test Set 1 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 465b5ce8 | b199b49f | aa5f0a2e | e238a6bc | +| VSTK RAND | 23553cbe | 9 | | | +| MIL3G-RAND | f23553cb | e9f23553 | cbe9f235 | 53cbe9ff | +| OP | cdc202d5 | 123e20f6 | 2b6d676a | c72cb318 | +| OPc | cd63cb71 | 954a9f4e | 48a5994e | 37a02baf | +| MIL3G-CK (VSTK) | d773c7ff | c640cd24 | 81f512dc | bd5cc0f6 | + +| Test Set 2 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | fec86ba6 | eb707ed0 | 8905757b | 1bb44b8f | +| VSTK RAND | 9f7c8d02 | 1 | | | +| MIL3G-RAND | f9f7c8d0 | 21f9f7c8 | d021f9f7 | c8d021ff | +| OP | dbc59adc | b6f9a0ef | 735477b7 | fadf8374 | +| OPc | 1006020f | 0a478bf6 | b699f15c | 062e42b3 | +| MIL3G-CK (VSTK) | a0b28afe | ca802828 | c324eb86 | a7b06903 | + +| Test Set 3 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 9e5944ae | a94b8116 | 5c82fbf9 | f32db751 | +| VSTK RAND | ce83dbc5 | 4 | | | +| MIL3G-RAND | fce83dbc | 54fce83d | bc54fce8 | 3dbc54ff | +| OP | 223014c5 | 806694c0 | 07ca1eee | f57f004f | +| OPc | a64a507a | e1a2a98b | b88eb421 | 0135dc87 | +| MIL3G-CK (VSTK) | f2abba4c | 9d52cf6b | 99b43d2a | 799e9470 | + +| Test Set 4 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 4ab1deb0 | 5ca6ceb0 | 51fc98e7 | 7d026a84 | +| VSTK RAND | 74b0cd60 | 3 | | | +| MIL3G-RAND | f74b0cd6 | 03f74b0c | d603f74b | 0cd603ff | +| OP | 2d16c5cd | 1fdf6b22 | 383584e3 | bef2a8d8 | +| OPc | dcf07cbd | 51855290 | b92a07a9 | 891e523e | +| MIL3G-CK (VSTK) | d4500866 | a11b5b7d | 3d89d485 | d25e14da | + +| Test Set 5 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 6c38a116 | ac280c45 | 4f59332e | e35c8c4f | +| VSTK RAND | ee6466bc | 9 | | | +| MIL3G-RAND | fee6466b | c9fee646 | 6bc9fee6 | 466bc9ff | +| OP | 1ba00a1a | 7c6700ac | 8c3ff3e9 | 6ad08725 | +| OPc | 3803ef53 | 63b947c6 | aaa225e5 | 8fae3934 | +| MIL3G-CK (VSTK) | bafd96fb | 7c417cce | 58597e0f | 118b6a02 | + +| Test Set 6 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 2d609d4d | b0ac5bf0 | d2c0de26 | 7014de0d | +| VSTK RAND | 194aa756 | 0 | | | +| MIL3G-RAND | f194aa75 | 60f194aa | 7560f194 | aa7560ff | +| OP | 460a4838 | 5427aa39 | 264aac8e | fc9e73e8 | +| OPc | c35a0ab0 | bcbfc925 | 2caff15f | 24efbde0 | +| MIL3G-CK (VSTK) | b4d5f9b7 | 94d269c5 | 706ee6e3 | 1453a426 | + +| Test Set 7 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | a530a7fe | 428fad10 | 82c45edd | fce13884 | +| VSTK RAND | 3a4c2b32 | 4 | | | +| MIL3G-RAND | f3a4c2b3 | 24f3a4c2 | b324f3a4 | c2b324ff | +| OP | 511c6c4e | 83e38c89 | b1c5d8dd | e62426fa | +| OPc | 27953e49 | bc8af6dc | c6e730eb | 80286be3 | +| MIL3G-CK (VSTK) | b8b143ae | 303bbdd6 | 8539ee34 | a69c530e | + +| Test Set 8 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | d9151cf0 | 4896e258 | 30bf2e08 | 267b8360 | +| VSTK RAND | f761e5e9 | 3 | | | +| MIL3G-RAND | ff761e5e | 93ff761e | 5e93ff76 | 1e5e93ff | +| OP | 75fc2233 | a44294ee | 8e6de25c | 4353d26b | +| OPc | c4c93eff | e8a08138 | c203d4c2 | 7ce4e3d9 | +| MIL3G-CK (VSTK) | 6e6aa729 | 1a54c264 | 6188e2e0 | 2002fda5 | + +| Test Set 9 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | a0e2971b | 6822e8d3 | 54a18cc2 | 35624ecb | +| VSTK RAND | 08eff828 | b | | | +| MIL3G-RAND | f08eff82 | 8bf08eff | 828bf08e | ff828bff | +| OP | 323792fa | ca21fb4d | 5d6f13c1 | 45a9d2c1 | +| OPc | 82a26f22 | bba9e948 | 8f949a10 | d98e9cc4 | +| MIL3G-CK (VSTK) | e360f5fe | 8a5b1602 | 5fb8acbf | f3b9cbb2 | + +| Test Set 10 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 0da6f7ba | 86d5eac8 | a19cf563 | ac58642d | +| VSTK RAND | 679ac4db | a | | | +| MIL3G-RAND | f679ac4d | baf679ac | 4dbaf679 | ac4dbaff | +| OP | 4b9a26fa | 459e3acb | ff36f401 | 5de3bdc1 | +| OPc | 0db1071f | 8767562c | a43a0a64 | c41e8d08 | +| MIL3G-CK (VSTK) | 805879c0 | 53864ea5 | a8c41c18 | 95976d41 | + +| Test Set 11 | | | | | +|-----------------|----------|----------|----------|----------| +| V Ki | 77b45843 | c88e58c1 | 0d202684 | 515ed430 | +| VSTK RAND | 4c47eb30 | 7 | | | +| MIL3G-RAND | f4c47eb3 | 07f4c47e | b307f4c4 | 7eb307ff | +| OP | bf3286c7 | a51409ce | 95724d50 | 3bfe6e70 | +| OPc | d483afae | 562409a3 | 26b5bb0b | 20c4d762 | +| MIL3G-CK (VSTK) | 74909b16 | e577b2d4 | cf1ff01a | 213cfc54 | + +| Test Set 12 | | | | | +|-----------------|----------|----------|----------|----------| +| V Ki | 729b1772 | 9270dd87 | ccdf1bfe | 29b4e9bb | +| VSTK RAND | 311c4c92 | 9 | | | +| MIL3G-RAND | f311c4c9 | 29f311c4 | c929f311 | c4c929ff | +| OP | d04c9c35 | bd2262fa | 810d2924 | d036fd13 | +| OPc | 228c2f2f | 06ac3268 | a9e616ee | 16db4ba1 | +| MIL3G-CK (VSTK) | b102a313 | d2692e01 | 1b7301c2 | ad188adc | + +| Test Set 13 | | | | | +|-----------------|----------|----------|----------|----------| +| V Ki | d32dd23e | 89dc6623 | 54ca12eb | 79dd32fa | +| VSTK RAND | cf7d0ab1 | d | | | +| MIL3G-RAND | fcf7d0ab | 1dfcf7d0 | ab1dfcf7 | d0ab1dff | +| OP | fe75905b | 9da47d35 | 6236d031 | 4e09c32e | +| OPc | d22a4b41 | 80a53257 | 08a5ff70 | d9f67ec7 | +| MIL3G-CK (VSTK) | 995729ba | d5e7c84d | 46d0980a | 4729351f | + +| Test Set 14 | | | | | +|-----------------|----------|----------|----------|----------| +| V Ki | af7c65e1 | 927221de | 591187a2 | c5987a53 | +| VSTK RAND | 1f0f8578 | 4 | | | +| MIL3G-RAND | f1f0f857 | 84f1f0f8 | 5784f1f0 | f85784ff | +| OP | 0c7acb8d | 95b7d4a3 | 1c5aca6d | 26345a88 | +| OPc | a4cf5c81 | 55c08a7e | ff418e54 | 43b98e55 | +| MIL3G-CK (VSTK) | 485e7bfd | 24492467 | 420b93ad | 3fce8ac2 | + +| Test Set 15 | | | | | +|-----------------|----------|----------|----------|----------| +| V Ki | 5bd7ecd3 | d3127a41 | d12539be | d4e7cf71 | +| VSTK RAND | 59b75f14 | 2 | | | +| MIL3G-RAND | f59b75f1 | 42f59b75 | f142f59b | 75f142ff | +| OP | f967f760 | 38b920a9 | cd25e10c | 08b49924 | +| OPc | 76089d3c | 0ff3efdc | 6e36721d | 4fceb747 | +| MIL3G-CK (VSTK) | 1b32d440 | 99fb51f5 | 0505149d | a25e7760 | + +| Test Set 16 | | | | | +|-----------------|----------|----------|----------|----------| +| V Ki | 6cd1c6ce | b1e01e14 | f1b82316 | a90b7f3d | +| VSTK RAND | f69b78f3 | 0 | | | +| MIL3G-RAND | ff69b78f | 30ff69b7 | 8f30ff69 | b78f30ff | +| OP | 078bfca9 | 564659ec | d8851e84 | e6c59b48 | +| OPc | a219dc37 | f1dc7d66 | 738b5843 | c799f206 | +| MIL3G-CK (VSTK) | c7ada658 | f4bf89dc | 184b1d31 | 9df554d9 | + +| Test Set 17 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | b73a90cb | cf3afb62 | 2dba83c5 | 8a8415df | +| VSTK RAND | b120f1c1 | a | | | +| MIL3G-RAND | fb120f1c | 1afb120f | 1c1afb12 | 0f1c1aff | +| OP | b672047e | 003bb952 | dca6cb8a | f0e5b779 | +| OPc | df0c6786 | 8fa25f74 | 8b7044c6 | e7c245b8 | +| MIL3G-CK (VSTK) | ca8cf524 | d78c8c55 | aa5aba14 | 22737909 | + +| Test Set 18 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 51222502 | 14c33e72 | 3a5dd523 | fc145fc0 | +| VSTK RAND | 81e92b6c | 0 | | | +| MIL3G-RAND | f81e92b6 | c0f81e92 | b6c0f81e | 92b6c0ff | +| OP | c9e87632 | 86b5b9ff | bdf56e12 | 97d0887b | +| OPc | 981d464c | 7c52eb6e | 50362349 | 84ad0bcf | +| MIL3G-CK (VSTK) | a8d5cdb6 | 47335bf5 | 8e2c884d | a5efcdd5 | + +| Test Set 19 | | | | | +|-----------------|----------|----------|----------|----------| +| V_Ki | 90dca4ed | a45b53cf | 0f12d7c9 | c3bc6a89 | +| VSTK RAND | 9fddc720 | 9 | | | +| MIL3G-RAND | f9fddc72 | 09f9fddc | 7209f9fd | dc7209ff | +| OP | 3ffcf5b | 7b111158 | 9920d352 | 8e84e655 | +| OPc | cb9cccc4 | b9258e6d | ca476037 | 9fb82581 | +| MIL3G-CK (VSTK) | c699833a | 2c22bf44 | b6473390 | 8a7142c3 | + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------|-----------|------|-----|-----|----------------------------------------------------------------------------|--------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | Old | New | +| 2005-11 | SA3#41 | - | - | - | - | Draft version presented at SA3#41 | | 0.1.0 | +| 2006-02 | SA3#42 | - | - | - | - | Inclusion of Test Sets generated by ETSI SAGE | 0.1.0 | 1.0.0 | +| 2006-02 | | | | | | Editorial clean up by MCC to conform to 21.801. | 1.0.0 | 1.0.1 | +| 2006-02 | | | | | | Raised to 1.0.2 to accept changes for presentation to SA #31 | 1.0.1 | 1.0.2 | +| 2006-03 | - | - | - | - | - | Editorial update to stylesheet and removal of comment | 1.0.2 | 1.0.3 | +| 2006-03 | SP-31 | SP-060059 | - | - | - | Approved at SA #31 | 1.0.3 | 6.0.0 | +| 2006-06 | SP-32 | SP-060378 | 0001 | - | F | Missing bit in MIL3G RAND test set 1 example and correcting used functions | 6.0.0 | 6.1.0 | +| 2007-06 | SP-36 | - | - | - | - | <a href="#">Update to Rel-7 version (MCC)</a> | 6.1.0 | 7.0.0 | +| 2008-12 | SP-42 | - | - | - | - | <a href="#">Update to Rel-8 version (MCC)</a> | 7.1.0 | 8.0.0 | +| 2009-12 | - | - | - | - | - | <a href="#">Update to Rel-9 version (MCC)</a> | 8.0.0 | 9.0.0 | +| 2011-03 | - | - | - | - | - | <a href="#">Update to Rel-10 version (MCC)</a> | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | - | <a href="#">Update to Rel-11 version (MCC)</a> | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | - | <a href="#">Update to Rel-12 version (MCC)</a> | 11.0.0 | <b>12.0.0</b> | +| 2016-01 | - | - | - | - | - | <a href="#">Update to Rel-13 version (MCC)</a> | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55241/raw.md b/marked/Rel-16/55_series/55241/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..452abe11e1bc2fb0bdb2d500c3e8be1d220ba45f --- /dev/null +++ b/marked/Rel-16/55_series/55241/raw.md @@ -0,0 +1,273 @@ + + + + + + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 5 + +2 References..... 5 + +3 Definitions, symbols and abbreviations..... 5 + +3.1 Definitions..... 5 + +3.2 Symbols..... 5 + +3.3 Abbreviations ..... 6 + +4 Introductory information..... 6 + +4.1 Introduction ..... 6 + +4.2 Notation..... 6 + +4.2.1 Radix..... 6 + +4.2.2 Conventions..... 6 + +4.2.3 Bit/byte ordering..... 6 + +4.3 List of variables..... 7 + +5 Integrity algorithm GIA4 ..... 7 + +5.1 Introduction ..... 7 + +5.2 Inputs and outputs ..... 7 + +5.3 Components and architecture..... 8 + +5.4 Initialisation..... 8 + +5.5 Calculation ..... 8 + +**Annex A (informative): Components and architecture of the GIA4 algorithm..... 9** + +**Annex B (informative): Simulation program listing..... 10** + +**Annex C (informative): Change history..... 11** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +This specification has been prepared by the 3GPP Task Force, and gives a detailed specification of the 3GPP integrity algorithm GIA4. + +This document is the first of three, which between them form the entire specification of the 3GPP Integrity Algorithm GIA4: + +- **3GPP TS 55.241: "Specification of the GIA4 encryption algorithms for GPRS; GIA4 specification".** +- 3GPP TS 55.242: "Specification of the GIA4 encryption algorithms for GPRS; Implementers' test data". +- 3GPP TS 55.243: "Specification of the GIA4 encryption algorithms for GPRS; Design conformance test data". + +# 1 Scope + +The present document defines the technical details of the 3GPP integrity algorithm GIA4. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 35.202: "3G Security; Specification of the 3GPP Confidentiality and Integrity Algorithms; Document 2: KASUMI Specification". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +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]. + +(none) + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|------------------------|-----------------------------------------------------------------------------------------------------------------| +| = | The assignment operator. | +| ⊕ | The bitwise exclusive-OR operation. | +| | The concatenation of the two operands. | +| KASUMI[x] <sub>k</sub> | The output of the KASUMI algorithm [2] applied to input value x using the key k. | +| X[i] | The i <sup>th</sup> bit of the variable X. (X = X[0] X[1] X[2] ..... ). | +| Y <sub>i</sub> | The i <sup>th</sup> block of the variable Y. (Y = Y <sub>0</sub> Y <sub>1</sub> Y <sub>2</sub> .... ). | + +## 3.3 Abbreviations + +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]. + +| | | +|---------|---------------------------------------------------| +| CBC-MAC | Cipher Block Chaining Message Authentication Code | +| MAC | Message Authentication Code | + +# 4 Introductory information + +## 4.1 Introduction + +The integrity algorithm GIA4 computes a 32-bit MAC (Message Authentication Code) of a given input message using integrity key KI128. The approach adopted uses KASUMI [2] in a form of CBC-MAC mode. + +## 4.2 Notation + +### 4.2.1 Radix + +The prefix "0x" indicates hexadecimal numbers. + +### 4.2.2 Conventions + +The assignment operator "=", as used in several programming languages. + +`<variable> = <expression>` + +means that *<variable>* assumes the value that *<expression>* had before the assignment took place. For instance, + +$$x = x + y + 3$$ + +means + +(new value of $x$ ) becomes (old value of $x$ ) + (old value of $y$ ) + 3. + +### 4.2.3 Bit/byte ordering + +All data variables in this specification are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of sub-strings, the left most (most significant) sub-string is numbered 0, the next most significant is numbered 1 and so on through to the least significant. + +For example an n-bit MESSAGE is subdivided into 64-bit substrings $MB_0, MB_1 \dots MB_i$ so if the message is: + +0x0123456789ABCDEFEDCBA987654321086545381AB594FC28786404C50A37... + +then: + +MB<sub>0</sub> = 0x0123456789ABCDEF +MB<sub>1</sub> = 0xFEDCBA9876543210 +MB<sub>2</sub> = 0x86545381AB594FC2 +MB<sub>3</sub> = 0x8786404C50A37... + +In binary this would be: + +00000001001000110100010101100111100010011010101111001101111011110... + +with + +$$\begin{aligned} \text{MB}_0 &= 0000000100100011010001010110011110001001101010111100110111101111 \\ \text{MB}_1 &= 1111111011011100101110101001100001110110010101000011001000010000 \\ \text{MB}_2 &= 1000011001010100010100111000000110101011010110010100111111000010 \\ \text{MB}_3 &= 10000111100001100100000001001100010100001010001101111\dots \end{aligned}$$ + +## 4.3 List of variables + +- A, B are 64-bit registers that are used within the function to hold intermediate values. +- BLOCKS** an integer variable indicating the number of successive applications of KASUMI that need to be performed. +- CONSTANT-F** a 32-bit parameter which is constant for any given FRAMETYPE input. + +| | | +|-----------|-------------------------------------------------------------------------------------------------| +| DIRECTION | a 1-bit input indicating the direction of transmission (uplink or downlink). | +| FRAMETYPE | an 8-bit input to the function indicating the type of frame to be protected. | +| INPUT-I | a 32-bit time variant input to the function. | +| KI128 | the 128-bit integrity key. | +| KM | a 128-bit constant that is used to modify a key. | +| M | an input to the function which specifies the number of octets of message to be MAC'd (1-65536). | +| MAC | the 32-bit message authentication code (MAC) produced by the function. | +| MESSAGE | the input octet stream of length M octets that is to be processed by the function. | +| PS | is the input padded string processed by the function. | + +# 5 Integrity algorithm GIA4 + +## 5.1 Introduction + +The integrity algorithm GIA4 computes a Message Authentication Code (MAC) on an input message under an integrity key IK128. The input message may be between 1 and 65536 octets long. + +For ease of implementation the algorithm is based on the same block cipher (KASUMI) as is used by the confidentiality algorithm GEA4. + +## 5.2 Inputs and outputs + +The inputs to the algorithm are given in table 5.2.1, the output in table 5.2.2: + +**Table 5.2.1: GIA4 inputs** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|----------------------------------------------------------| +| INPUT-I | 32 | Frame dependent input INPUT-I[0]...INPUT-I[31] | +| M | | The length of MESSAGE in octets (1-65536) | +| MESSAGE | 8M | Input octet stream MESSAGE{0}...MESSAGE{M-1} | +| DIRECTION | 1 | Direction of transmission DIRECTION[0] | +| FRAMETYPE | 8 | Input value signifying the type of frame to be protected | +| KI128 | 128 | Integrity key KI128[0]...KI128[127] | + +**Table 5.2.2: GIA4 output** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|----------------------------------------------| +| MAC | 32 | Message authentication code MAC[0]...MAC[31] | + +## 5.3 Components and architecture + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 5.4 Initialisation + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 5.5 Calculation + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# --- Annex A (informative): Components and architecture of the GIA4 algorithm + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# --- Annex B (informative): Simulation program listing + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|-------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-04 | SA3#83 | | - | - | - | First Draft | 0.1.0 | +| 2016-04 | SA3#83 | | - | - | - | Updated and Shared with French Government | 0.2.0 | +| 2016-05 | SA3#83 | | - | - | - | Algorithm redacted | 0.2.2 | +| 2016-04 | SA3#85 | | - | - | - | Full Specification with Example Code | 0.3.0 | +| 2016-06 | SA#72 | SP-160377 | | | | EditHelp editorial fix and presented for information | 1.0.0 | +| 2016-11 | SA3#85 | | | | | Sent for Approval with only version changes | 1.1.0 | +| 2016-11 | SA3#85 | | | | | Changed editors note to reflect availability of the content | 1.1.1 | +| 2016-11 | SA#74 | SP-160791 | | | | MCC clean up, redacted version for TSG SA approval | 2.0.0 | +| 2016-12 | SA#74 | | | | | Approved by TSG SA | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2018-06 | | | | | | Change to GSM logo | <b>15.0.1</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55242/raw.md b/marked/Rel-16/55_series/55242/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..594e410983927235b4e9a2fa018db3856cf50c13 --- /dev/null +++ b/marked/Rel-16/55_series/55242/raw.md @@ -0,0 +1,187 @@ + + + + + + +# Contents + +Foreword ..... 4 + +Introduction ..... 4 + +1 Scope..... 5 + +2 References..... 5 + +3 Definitions and abbreviations ..... 5 + +3.1 Definitions..... 5 + +3.2 Abbreviations ..... 5 + +4 Introductory information..... 5 + +4.1 Introduction ..... 5 + +4.2 Notation..... 5 + +4.2.1 Radix..... 5 + +4.2.2 Conventions..... 6 + +4.2.3 Bit/Byte ordering..... 6 + +4.3 List of variables..... 6 + +5 Test data ..... 7 + +Annex A (informative): Change history..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document has been prepared by the 3GPP Task Force, and gives a detailed specification of the 3GPP integrity algorithm GIA4. + +The present document is the second of three, which between them form the entire specification of the 3GPP Integrity Algorithm GIA4: + +- 3GPP TS 55.241: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GIA4 integrity algorithms for GPRS; GIA4 specification". +- **3GPP TS 55.242: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GIA4 integrity algorithms for GPRS; Implementers' test data".** +- 3GPP TS 55.243: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GIA4 integrity algorithms for GPRS; Design conformance test data". + +# --- 1 Scope + +The present document defines the implementers test data of the 3GPP integrity algorithm GIA4. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 55.241: "Specification of the GIA4 encryption algorithms for GPRS; GIA4 specification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +# --- 4 Introductory information + +## 4.1 Introduction + +The integrity algorithm GIA4 computes a 32-bit MAC (Message Authentication Code) of a given input message using integrity key KI128. The approach adopted uses KASUMI [2] in a form of CBC-MAC mode. + +## 4.2 Notation + +### 4.2.1 Radix + +"0x" is used to indicate hexadecimal numbers. + +### 4.2.2 Conventions + +The assignment operator "=", is used as in several programming languages. The following: + +$$\langle \text{variable} \rangle = \langle \text{expression} \rangle$$ + +means that *<variable>* assumes the value that *<expression>* had before the assignment took place. For instance, + +$$x = x + y + 3$$ + +means + +(new value of $x$ ) becomes (old value of $x$ ) + (old value of $y$ ) + 3. + +### 4.2.3 Bit/Byte ordering + +All data variables in this specification are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of sub-strings, the left most (most significant) sub-string is numbered 0, the next most significant is numbered 1 and so on through to the least significant. + +For example an n-bit MESSAGE is subdivided into 64-bit substrings $MB_0, MB_1 \dots MB_i$ so for a message: + +0x0123456789ABCDEFEDCBA987654321086545381AB594FC28786404C50A37... + +The resulting notation is: + +MB<sub>0</sub> = 0x0123456789ABCDEF +MB<sub>1</sub> = 0xFEDCBA9876543210 +MB<sub>2</sub> = 0x86545381AB594FC2 +MB<sub>3</sub> = 0x8786404C50A37... + +In binary this would be: + +000000010010001101000101011001111000100110101011110011011110111110... + +with + +**MB**<sub>0</sub> = 00000001001000110100010101100111100010011010101111001101111011111 +**MB**<sub>1</sub> = 1111111011011100101110101001100001110110010101000011001000010000 +**MB**<sub>2</sub> = 10000110010101000101001110000001101010110101100101001111111000010 +**MB**<sub>3</sub> = 1000011110000110010000000100110001010000101000110111... + +## 4.3 List of variables + +A, B are 64-bit registers that are used within the function to hold intermediate values. + +BLOCKS an integer variable indicating the number of successive applications of KASUMI that need to be performed. + +CONSTANT-F a 32-bit parameter which is constant for any given FRAMETYPE input. + +DIRECTION a 1-bit input indicating the direction of transmission (uplink or downlink). + +FRAMETYPE an 8-bit input to the function indicating the type of frame to be protected. + +INPUT-I a 32-bit time variant input to the function. + +KI128 the 128-bit integrity key. + +KM a 128-bit constant that is used to modify a key. + +M an input to the function which specifies the number of octets of message to be MAC'd (1-65536). + +MAC the 32-bit message authentication code (MAC) produced by the function. + +MESSAGE the input octet stream of length M octets that is to be processed by the function. + +PS is the input padded string processed by the function. + +# --- 5 Test data + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# Annex A (informative): Change history + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2017-03 | SA#75 | SP-170088 | | | | Presented for approval | 2.0.0 | +| 2017-03 | SA#75 | | | | | Upgrade to change control version | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55243/raw.md b/marked/Rel-16/55_series/55243/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..065a5d6c41f1e6ffef702c85c6aed8817d27d867 --- /dev/null +++ b/marked/Rel-16/55_series/55243/raw.md @@ -0,0 +1,170 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Introductory information..... 5 + - 4.1 Introduction ..... 5 + - 4.2 Notation..... 5 + - 4.2.1 Radix..... 5 + - 4.2.2 Conventions..... 6 + - 4.2.3 Bit/Byte ordering..... 6 + - 4.3 List of variables..... 6 +- 5 Conformance data ..... 7 +- Annex A (informative): Change history..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document has been prepared by the 3GPP Task Force, and gives a detailed specification of the 3GPP integrity algorithm GIA4. + +The present document is the third of three, which between them form the entire specification of the 3GPP Integrity Algorithm GIA4: + +- 3GPP TS 55.241: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GIA4 integrity algorithms for GPRS; GIA4 specification". +- 3GPP TS 55.242: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GIA4 integrity algorithms for GPRS; Implementers' test data". +- **3GPP TS 55.243: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GIA4 integrity algorithms for GPRS; Design conformance test data".** + +# --- 1 Scope + +The present document defines the Design conformance test data for the 3GPP integrity algorithm GIA4. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 55.241: "Specification of the GIA4 encryption algorithms for GPRS; GIA4 specification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +# --- 4 Introductory information + +## 4.1 Introduction + +The integrity algorithm GIA4 computes a 32-bit MAC (Message Authentication Code) of a given input message using integrity key KI128. The approach adopted uses KASUMI [2] in a form of CBC-MAC mode. + +## 4.2 Notation + +### 4.2.1 Radix + +The prefix "0x" is used to indicate hexadecimal numbers. + +### 4.2.2 Conventions + +The assignment operator "=", is used as in several programming languages. So the following: + +$$\langle \text{variable} \rangle = \langle \text{expression} \rangle$$ + +means that *<variable>* assumes the value that *<expression>* had before the assignment took place. For instance: + +$$x = x + y + 3$$ + +means: + +(new value of $x$ ) becomes (old value of $x$ ) + (old value of $y$ ) + 3. + +### 4.2.3 Bit/Byte ordering + +All data variables in the present document are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of sub-strings, the left most (most significant) sub-string is numbered 0, the next most significant is numbered 1 and so on through to the least significant. + +For example an n-bit MESSAGE is subdivided into 64-bit substrings $MB_0, MB_1, \dots, MB_i$ so for the following message: + +0x0123456789ABCDEFEDCBA987654321086545381AB594FC28786404C50A37... + +MB<sub>0</sub> = 0x0123456789ABCDEF +MB<sub>1</sub> = 0xFEDCBA9876543210 +MB<sub>2</sub> = 0x86545381AB594FC2 +MB<sub>3</sub> = 0x8786404C50A37... + +In binary this would be: + +000000010010001101000101011001111000100110101011110011011110111111111110... + +with + +$MB_0 = 0000000100100011010001010110011110001001101010111100110111101111$ + $MB_1 = 1111111011011100101110101001100001110110010101000011001000010000$ + $MB_2 = 1000011001010100010100111000000110101011010110010100111111100010$ + $MB_3 = 10000111100001100100000001001100010100001010001101111\dots$ + +## 4.3 List of variables + +A, B are 64-bit registers that are used within the function to hold intermediate values. + +BLOCKS an integer variable indicating the number of successive applications of KASUMI that need to be performed. + +**CONSTANT-F** a 32-bit parameter which is constant for any given **FRAMETYPE** input. + +DIRECTION a 1-bit input indicating the direction of transmission (uplink or downlink). + +**FRAMETYPE** an 8-bit input to the function indicating the type of frame to be protected. + +INPUT-I a 32-bit time variant input to the function. + +KI128 the 128-bit integrity key. + +KM a 128-bit constant that is used to modify a key. + +M an input to the function which specifies the number of octets of message to be MAC'd (1-65536). + +MAC the 32-bit message authentication code (MAC) produced by the function. + +**MESSAGE** the input octet stream of length M octets that is to be processed by the function. + +PS is the input padded string processed by the function. + +# --- 5 Conformance data + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# Annex A (informative): Change history + +| <b>Change history</b> | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|--------------------------------------------------|--------------------| +| <b>Date</b> | <b>Meeting</b> | <b>TDoc</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New version</b> | +| 2017-03 | SA#75 | SP-170089 | | | | Presented for approval | 2.0.0 | +| 2017-03 | SA#75 | | | | | Upgrade to change control version | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55251/raw.md b/marked/Rel-16/55_series/55251/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..876b3ebf32457d1a823e6d49c14b72f3db9398cb --- /dev/null +++ b/marked/Rel-16/55_series/55251/raw.md @@ -0,0 +1,395 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 7 | +| 4 Introductory information..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 Notation..... | 7 | +| 4.2.1 Radix..... | 7 | +| 4.2.2 Conventions..... | 7 | +| 4.2.3 Bit/byte ordering..... | 7 | +| 4.3 List of variables..... | 8 | +| 5 Confidentiality algorithm GEA5..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Inputs and outputs ..... | 9 | +| 5.3 Components and architecture..... | 9 | +| 5.4 Initialisation..... | 9 | +| 5.5 Keystream generation..... | 9 | +| 5.6 Output octets ..... | 9 | +| 6 Integrity algorithm GIA5 ..... | 10 | +| 6.1 Introduction ..... | 10 | +| 6.2 Inputs and outputs ..... | 10 | +| 6.3 Components and architecture..... | 10 | +| 6.3.1 SNOW 3G ..... | 10 | +| 6.3.2 MULx ..... | 10 | +| 6.3.3 MULxPOW ..... | 10 | +| 6.3.4 MUL ..... | 10 | +| 6.4 Initialization ..... | 11 | +| 6.5 Calculation ..... | 11 | +| <b>Annex A (informative): Mathematical background of some operations of the GIA5 Algorithm ..</b> | <b>12</b> | +| A.1 The function EVAL_S ..... | 12 | +| A.2 The function MUL(V, P, c)..... | 12 | +| <b>Annex B (informative): Implementation options for some operations of the GIA5 algorithm .....</b> | <b>13</b> | +| B.1 Overview..... | 13 | +| B.2 Procedure Pre_Mul_P ..... | 13 | +| B.3 Function Mul_P..... | 13 | +| <b>Annex C (informative): Figures of the GEA5 and GIA5 algorithms .....</b> | <b>14</b> | +| <b>Annex D (informative): Simulation program listing.....</b> | <b>15</b> | +| D.1 GEA5 ..... | 15 | +| D.2 GIA5..... | 15 | +| Annex E (informative): Change history..... | 16 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +This specification has been prepared by the 3GPP Task Force, and gives a detailed specification of the 3GPP confidentiality algorithm GEA5 and the 3GPP integrity algorithm GIA5. + +This document is the first of three, which between them form the entire specification of the 3GPP confidentiality algorithm GEA5 and the 3GPP integrity algorithm GIA5: + +- **3GPP TS 55.251: "Specification of the GEA5 and GIA5 encryption algorithms for GPRS; GEA5 and GIA4 algorithm specification".** +- 3GPP TS 55.252: "Specification of the GEA5 and GIA5 encryption algorithms for GPRS; Implementers' test data". +- 3GPP TS 55.253: "Specification of the GEA5 and GIA5 encryption algorithms for GPRS; Design conformance test data". + +# 1 Scope + +The present document defines the technical details of the 3GPP confidential algorithm GEA5 and the 3GPP integrity algorithm GIA5. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 33.216: "Specification of the 3GPP Confidentiality and Integrity Algorithms UEA2 & UIA2; Document 2: SNOW 3G specification". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +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]. + +(none) + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------------------|----------------------------------------------------------------------------------------------------------| +| = | The assignment operator. | +| $\oplus$ | The bitwise exclusive-OR operation. | +| $\parallel$ | The concatenation of the two operands. | +| $\text{KASUMI}[x]_k$ | The output of the KASUMI algorithm applied to input value <b>x</b> using the key <b>k</b> . | +| $X[i]$ | The i <sup>th</sup> bit of the variable X. ( $X = X[0] \parallel X[1] \parallel X[2] \parallel \dots$ ). | +| $Y_i$ | The i <sup>th</sup> block of the variable Y. ( $Y = Y_0 \parallel Y_1 \parallel Y_2 \parallel \dots$ ). | +| $\text{ceiling}(x)$ | The smallest integer greater than or equal to the real number x. | +| $\&_n$ | The bitwise AND operation in an n-bit register. | +| $\ll_n t$ | t-bit left shift in an n-bit register. | +| $\gg_n t$ | t-bit right shift in an n-bit register. | + +## 3.3 Abbreviations + +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]. + +| | | +|---------|---------------------------------------------------| +| CBC-MAC | Cipher Block Chaining Message Authentication Code | +| MAC | Message Authentication Code | + +# 4 Introductory information + +## 4.1 Introduction + +The confidentiality algorithm GEA5 is a stream cipher that is used to encrypt/decrypt blocks of data under a confidentiality key KC128. The block of data may be between 1 and 65536 octets long. The algorithm uses SNOW 3G [2] as a keystream generator. + +The integrity algorithm GIA5 computes a 32-bit MAC (Message Authentication Code) of a given input message using an integrity key KI128. The approach adopted uses SNOW 3G. + +## 4.2 Notation + +### 4.2.1 Radix + +The prefix "0x" indicates hexadecimal numbers. + +### 4.2.2 Conventions + +The assignment operator "=", as used in several programming languages. + +<variable> = <expression> + +means that *<variable>* assumes the value that *<expression>* had before the assignment took place. For instance, + +$$x = x + y + 3$$ + +means + +(new value of $x$ ) becomes (old value of $x$ ) + (old value of $y$ ) + 3. + +### 4.2.3 Bit/byte ordering + +All data variables in this specification are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of sub-strings, the left most (most significant) sub-string is numbered 0, the next most significant is numbered 1 and so on through to the least significant. + +For example an n-bit MESSAGE is subdivided into 64-bit substrings $MB_0, MB_1 \dots MB_i$ so if the message is: + +0x0123456789ABCDEFEDCBA987654321086545381AB594FC28786404C50A37... + +then: + +MB<sub>0</sub> = 0x0123456789ABCDEF +MB<sub>1</sub> = 0xFEDCBA9876543210 +MB<sub>2</sub> = 0x86545381AB594FC2 +MB<sub>3</sub> = 0x8786404C50A37... + +In binary this is: + +000000010010001101000101011001111000100110101011111001101111011111... + +with + +$$\begin{aligned} \text{MB}_0 &= 000000010010001101000101011001111000100110101011111001101111011111 \\ \text{MB}_1 &= 1111111011011100101110101001100001110110010101000011001000010000 \\ \text{MB}_2 &= 1000011001010100010100111000000110101011010110010100111111000010 \\ \text{MB}_3 &= 10000111100001100100000001001100010100001010001101111\dots \end{aligned}$$ + +## 4.3 List of variables + +CONSTANT-F a 32-bit parameter which is constant for any given FRAMETYPE input. + +| | | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DIRECTION | the 1-bit input to both the GEA5 and GIA5 functions indicating the direction of transmission (uplink or downlink). | +| FRAMETYPE | an 8-bit input to the GEA5 and GIA5 functions indicating the type of frame to be protected. | +| INPUT | the 32-bit time variant input to the GEA5 function | +| INPUT-I | the 32-bit time variant input to the GIA5 function | +| KC128 | the 128-bit confidentiality key. | +| KI128 | the 128-bit integrity key. | +| KS[i] | the i <sup>th</sup> bit of keystream produced by the keystream generator. | +| L | the number of 32-bit words of SNOW 3G keystream that are generated by GEA5 (equal to $\lceil M/4 \rceil$ ). | +| LENGTH | a 64 bit parameter defined within GIA5 which specifies the number of bits of message to be MAC'd (equal to 8 times M). | +| M | the input to the GEA5 function which specifies the number of octets of output required (1-65536); also the input to the GIA5 function which specifies the number of octets of message to be MAC'd (1-65536). | +| MAC | the 32-bit message authentication code (MAC) produced by the integrity function GIA5. | +| MESSAGE | the input bitstream of LENGTH bits that is to be processed by the GIA5 function. | +| OUTPUT | the output octets from the GEA5 function. | +| S <sub>1</sub> , S <sub>2</sub> , ... | a sequence of 64-bit words derived from MESSAGE and LENGTH which is used within GIA5 to construct the MAC | +| z <sub>1</sub> , z <sub>2</sub> , ... | the 32-bit words forming the keystream sequence of SNOW 3G. The word produced first is z <sub>1</sub> , the next word z <sub>2</sub> and so on. | + +# --- 5 Confidentiality algorithm GEA5 + +## 5.1 Introduction + +The confidentiality algorithm GEA5 is a stream cipher that encrypts/decrypts blocks of data between 1 and 65536 octets in length. + +## 5.2 Inputs and outputs + +The inputs to the algorithm are given in Table 5.2.1, the output in Table 5.2.2: + +**Table 5.2.1: GEA5 inputs** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|---------------------------------------------------------------------------| +| INPUT | 32 | Frame dependent input INPUT[0]...INPUT[31] | +| DIRECTION | 1 | Direction of transmission DIRECTION[0] | +| FRAMETYPE | 8 | Input value signifying the type of frame to be protected | +| KC128 | 128 | Confidentiality key KC128[0]...KC128[127] | +| M | | The number of octets of output required in the range 1 to 65536 inclusive | + +**Table 5.2.2: GEA5 output** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|------------------------------------------| +| OUTPUT | 8M | Keystream octets OUTPUT{0}...OUTPUT{M-1} | + +## 5.3 Components and architecture + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 5.4 Initialisation + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 5.5 Keystream generation + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 5.6 Output octets + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# 6 Integrity algorithm GIA5 + +## 6.1 Introduction + +The integrity algorithm GIA5 computes a Message Authentication Code (MAC) on an input message under an integrity key KI128. The message may be between 1 and 65536 octets long. + +For ease of implementation the algorithm is based on the same stream cipher (SNOW 3G) [2] as is used by the confidentiality algorithm GEA5. + +## 6.2 Inputs and outputs + +The inputs to the algorithm are given in table 6.2.1, the output in table 6.2.2: + +**Table 6.2.1: GIA5 inputs** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|----------------------------------------------------------| +| INPUT-I | 32 | Frame dependent input INPUT-I[0]...INPUT-I[31] | +| M | | The length of MESSAGE in octets (1-65536) | +| MESSAGE | 8M | Input octet stream MESSAGE{0}....MESSAGE{M-1} | +| DIRECTION | 1 | Direction of transmission DIRECTION[0] | +| FRAMETYPE | 8 | Input value signifying the type of frame to be protected | +| KI128 | 128 | Integrity key KI128[0]...KI128[127] | + +**Table 6.2.2: GIA5 output** + +| Parameter | Size (bits) | Comment | +|-----------|-------------|----------------------------------------------| +| MAC | 32 | Message authentication code MAC[0]...MAC[31] | + +## 6.3 Components and architecture + +### 6.3.1 SNOW 3G + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +### 6.3.2 MULx + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +### 6.3.3 MULxPOW + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +### 6.3.4 MUL + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 6.4 Initialization + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## 6.5 Calculation + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# --- Annex A (informative): Mathematical background of some operations of the GIA5 Algorithm + +## A.1 The function EVAL\_S + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## --- A.2 The function MUL(V, P, c) + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# --- Annex B (informative): Implementation options for some operations of the GIA5 algorithm + +## B.1 Overview + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## --- B.2. Procedure Pre\_Mul\_P + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## --- B.3 Function Mul\_P + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# --- Annex C (informative): Figures of the GEA5 and GIA5 algorithms + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# --- Annex D (informative): Simulation program listing + +## D.1 GEA5 + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +## --- D.2 GIA5 + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# Annex E (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|----|-----|-----|-------------------------------------------------------------------------------------------|--|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2016-04 | SA3#83 | | - | - | - | First Draft | | 0.1.0 | +| 2016-04 | SA3#83 | | - | - | - | Removed algorithm details until permission to publish is received from French Government. | | 0.0.2 | +| 2016-04 | SA3#83 | | - | - | - | Updated version sent to French Government for permission to publish | | 0.2.0 | +| 2016-05 | SA3#83 | | - | - | - | Updated titles after comments in SA3 #83 | | 0.2.1 | +| 2016-05 | SA3#83 | | - | - | - | Removed algorithm details until permission to publish is received from French Government. | | 0.2.2 | +| 2016-11 | SA3#85 | | - | - | - | Full Specification with Example Code | | 0.3.0 | +| 2016-06 | SA#72 | SP-160380 | | | | EditHelp editorial fix and presented for information | | 1.0.0 | +| 2016-11 | SA3#85 | | | | | Updated version only | | 1.1.0 | +| 2016-11 | SA3#85 | | | | | Updated the editors note to reflect the need for a licence to see the content | | 1.1.1 | +| 2016-11 | SA#74 | SP-160792 | | | | MCC clean up, redacted version for TSG SA approval | | 2.0.0 | +| 2016-12 | SA#74 | | | | | Approved by TSG SA | | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55252/raw.md b/marked/Rel-16/55_series/55252/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1a8b77bfe627a3002f62ded58b117438560af712 --- /dev/null +++ b/marked/Rel-16/55_series/55252/raw.md @@ -0,0 +1,182 @@ + + + + + + +# Contents + +- Foreword ..... 4 +- Introduction ..... 4 +- 1 Scope..... 5 +- 2 References..... 5 +- 3 Definitions and abbreviations ..... 5 + - 3.1 Definitions..... 5 + - 3.2 Abbreviations ..... 5 +- 4 Introductory information..... 5 + - 4.1 Introduction ..... 5 + - 4.2 Notation..... 6 + - 4.2.1 Radix..... 6 + - 4.2.2 Conventions..... 6 + - 4.2.3 Bit/Byte ordering..... 6 + - 4.3 List of variables..... 6 +- 5 Test data ..... 7 +- Annex A (informative): Change history..... 8 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document has been prepared by the 3GPP Task Force, and gives a detailed specification of the 3GPP encryption algorithm GEA5 and integrity algorithm GIA5. + +This document is the second of three, which between them form the entire specification of the 3GPP encryption algorithm GEA5 and integrity algorithm GIA5: + +- 3GPP TS 55.251: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GEA5 encryption and GIA5 integrity algorithms for GPRS; GEA5 and GIA5 specification". +- **3GPP TS 55.252: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GEA5 encryption and GIA5 integrity algorithms for GPRS; Implementers' test data".** +- 3GPP TS 55.253: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GEA5 encryption and GIA5 integrity algorithms for GPRS; Design conformance test data". + +# --- 1 Scope + +The present document defines the implementers test data of the 3 GPP encryption algorithm GEA5 and integrity algorithm GIA5. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 55.251: "Specification of the GEA5 and GIA5 encryption algorithms for GPRS; GEA5 and GIA5 specification" + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +# --- 4 Introductory information + +## 4.1 Introduction + +The confidentiality algorithm GEA5 is a stream cipher that is used to encrypt/decrypt blocks of data under a confidentiality key KC128. The block of data may be between 1 and 65536 octets long. The algorithm uses SNOW 3G [2] as a keystream generator. + +The integrity algorithm GIA5 computes a 32-bit MAC (Message Authentication Code) of a given input message using an integrity key KI128. The approach adopted uses SNOW 3G. + +## 4.2 Notation + +### 4.2.1 Radix + +The prefix "0x" is used to indicate hexadecimal numbers. + +### 4.2.2 Conventions + +The assignment operator "=", is used as in several programming languages. for instance: + +*<variable>* = *<expression>* + +means that *<variable>* assumes the value that *<expression>* had before the assignment took place. For instance: + +$$x = x + y + 3$$ + +means: + +(new value of $x$ ) becomes (old value of $x$ ) + (old value of $y$ ) + 3. + +### 4.2.3 Bit/Byte ordering + +All data variables in the present document are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of sub-strings, the left most (most significant) sub-string is numbered 0, the next most significant is numbered 1 and so on through to the least significant. + +For example an n-bit MESSAGE is subdivided into 64-bit substrings $MB_0, MB_1, \dots, MB_i$ so a message: + +0x0123456789ABCDEFEDCBA987654321086545381AB594FC28786404C50A37... + +is: + +MB<sub>0</sub> = 0x0123456789ABCDEF +MB<sub>1</sub> = 0xFEDCBA9876543210 +MB<sub>2</sub> = 0x86545381AB594FC2 +MB<sub>3</sub> = 0x8786404C50A37... + +In binary this would be: + +000000010010001101000101011001111000100110101011110011011110111110... + +with + +**MB**<sub>0</sub> = 00000001001000110100010101100111100010011010101111001101111011111 +**MB**<sub>1</sub> = 1111111011011100101110101001100001110110010101000011001000010000 +**MB**<sub>2</sub> = 10000110010101000101001110000001101010110101100101001111111000010 +**MB**<sub>3</sub> = 100001111100001100100000001001100010100001010001101111... + +## 4.3 List of variables + +CONSTANT-F a 32-bit parameter which is constant for any given FRAMETYPE input. + +**DIRECTION** the 1-bit input to both the GEA5 and GIA5 functions indicating the direction of transmission (uplink or downlink). + +**FRAMETYPE** an 8-bit input to the GEA5 and GIA5 functions indicating the type of frame to be protected. + +**INPUT** the 32-bit time variant input to the GEA5 function. + +INPUT-I the 32-bit time variant input to the GIA5 function. + +KC128 the 128-bit confidentiality key. + +KI128 the 128-bit integrity key. + +KS[i] the $i$ th bit of keystream produced by the keystream generator. + +L the number of 32-bit words of SNOW 3G keystream that are generated by GEA5 (equal to $\lceil M / 4 \rceil$ ). + +LENGTH a 64 bit parameter defined within GIA5 which specifies the number of bits of message to be MAC'd (equal to 8 times M). + +M the input to the GEA5 function which specifies the number of octets of output required (1-65536); also the input to the GIA5 function which specifies the number of octets of message to be MAC'd (1-65536). + +MAC the 32-bit message authentication code (MAC) produced by the integrity function GIA5. + +MESSAGE the input bitstream of LENGTH bits that is to be processed by the GIA5 function. + +OUTPUT the output octets from the GEA5 function. + +S1, S2, ... a sequence of 64-bit words derived from MESSAGE and LENGTH which is used within GIA5 to construct the MAC. + +z1, z2, ... the 32-bit words forming the keystream sequence of SNOW 3G. The word produced first is z1, the next word z2 and so on. + +# --- 5 Test data + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|--------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | SP-170090 | | | | Presented for approval | 2.0.0 | +| 2017-03 | SA#75 | | | | | Upgrade to change control version | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55253/raw.md b/marked/Rel-16/55_series/55253/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e1b3a288cc98d1a954c8dcbdd44abba74b8d90a6 --- /dev/null +++ b/marked/Rel-16/55_series/55253/raw.md @@ -0,0 +1,184 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Introductory information..... | 5 | +| 4.1 Introduction ..... | 5 | +| 4.2 Notation..... | 6 | +| 4.2.1 Radix..... | 6 | +| 4.2.2 Conventions..... | 6 | +| 4.2.3 Bit/Byte ordering..... | 6 | +| 4.3 List of Variables ..... | 6 | +| 5 Design conformance test data ..... | 7 | +| Annex A (informative): Change history..... | 7 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document has been prepared by the 3GPP Task Force, and gives a detailed specification of the 3GPP encryption algorithm GEA5 and integrity algorithm GIA5. + +The present document is the second of three, which between them form the entire specification of the 3GPP encryption algorithm GEA5 and integrity algorithm GIA5: + +- 3GPP TS 55.251: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GEA5 encryption and GIA5 integrity algorithms for GPRS; GEA5 and GIA5 specification". +- 3GPP TS 55.252: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GEA5 encryption and GIA5 integrity algorithms for GPRS; Implementers' test data". +- **3GPP TS 55.253: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification of the GEA5 encryption and GIA5 integrity algorithms for GPRS; Design conformance test data".** + +# --- 1 Scope + +The present document defines the design conformance test data of the 3GPP encryption algorithm GEA5 and integrity algorithm GIA5. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 55.251: "Specification of the GEA5 and GIA5 encryption algorithms for GPRS; GEA5 and GIA5 specification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +# --- 4 Introductory information + +## 4.1 Introduction + +The confidentiality algorithm GEA5 is a stream cipher that is used to encrypt/decrypt blocks of data under a confidentiality key KC128. The block of data may be between 1 and 65536 octets long. The algorithm uses SNOW 3G [2] as a keystream generator + +The integrity algorithm GIA5 computes a 32-bit MAC (Message Authentication Code) of a given input message using an integrity key KI128. The approach adopted uses SNOW 3G. + +## 4.2 Notation + +### 4.2.1 Radix + +The prefix "0x" is used to indicate hexadecimal numbers. + +### 4.2.2 Conventions + +The assignment operator "=", is used as in several programming languages. So: + +`<variable> = <expression>` + +means that *<variable>* assumes the value that *<expression>* had before the assignment took place. For instance: + +$$x = x + y + 3$$ + +means: + +(new value of $x$ ) becomes (old value of $x$ ) + (old value of $y$ ) + 3. + +### 4.2.3 Bit/Byte ordering + +All data variables in the present document are presented with the most significant bit (or byte) on the left hand side and the least significant bit (or byte) on the right hand side. Where a variable is broken down into a number of sub-strings, the left most (most significant) sub-string is numbered 0, the next most significant is numbered 1 and so on through to the least significant. + +For example an n-bit MESSAGE is subdivided into 64-bit substrings MB<sub>0</sub>,MB<sub>1</sub>...MB<sub>i</sub> so for a message: + +0x0123456789ABCDEFEDCBA987654321086545381AB594FC28786404C50A37... + +is: + +MB<sub>0</sub> = 0x0123456789ABCDEF +MB<sub>1</sub> = 0xFEDCBA9876543210 +MB<sub>2</sub> = 0x86545381AB594FC2 +MB<sub>3</sub> = 0x8786404C50A37... + +In binary this would be: + +00000000010010001101000101011001111000100110101011110011011110111111111110... + +with + +**MB<sub>0</sub>** = 0000000100100011010001010110011110001001101010111100110111101111 +**MB<sub>1</sub>** = 1111111011011100101110101001100001110110010101000011001000010000 +**MB<sub>2</sub>** = 1000011001010100010100111000000110101011010110010100111111100010 +**MB<sub>3</sub>** = 100001111100001100100000001001100010100001010001101111... + +## 4.3 List of Variables + +CONSTANT-F a 32-bit parameter which is constant for any given FRAMETYPE input. + +**DIRECTION** the 1-bit input to both the GEA5 and GIA5 functions indicating the direction of transmission (uplink or downlink). + +**FRAMETYPE** an 8-bit input to the GEA5 and GIA5 functions indicating the type of frame to be protected. + +**INPUT** the 32-bit time variant input to the GEA5 function. + +INPUT-I the 32-bit time variant input to the GIA5 function. + +KC128 the 128-bit confidentiality key. + +KI128 the 128-bit integrity key. + +KS[i] the $i$ th bit of keystream produced by the keystream generator. + +L the number of 32-bit words of SNOW 3G keystream that are generated by GEA5 (equal to $\lceil M / 4 \rceil$ ). + +LENGTH a 64 bit parameter defined within GIA5 which specifies the number of bits of message to be MAC'd (equal to 8 times M). + +M the input to the GEA5 function which specifies the number of octets of output required (1-65536); also the input to the GIA5 function which specifies the number of octets of message to be MAC' (1-65536). + +MAC the 32-bit message authentication code (MAC) produced by the integrity function GIA5. + +MESSAGE the input bitstream of LENGTH bits that is to be processed by the GIA5 function. + +OUTPUT the output octets from the GEA5 function. + +S1, S2, ... a sequence of 64-bit words derived from MESSAGE and LENGTH which is used within GIA5 to construct the MAC. + +z1, z2, ... the 32-bit words forming the keystream sequence of SNOW 3G. The word produced first is z1, the next word z2 and so on. + +# 5 Design conformance test data + +This clause only available under licence. + +See <http://www.etsi.org/about/what-we-do/security-algorithms-and-codes/cellular-algorithm-licences>. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|-----|-----|--------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | SP-170091 | | | | Presented for approval | 2.0.0 | +| 2017-03 | SA#75 | | | | | Upgrade to change control version | 13.0.0 | +| 2017-03 | SA#75 | - | - | - | | Promotion to Release 14 without technical change | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | - | Update to Rel-15 version (MCC) | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | <b>16.0.0</b> | \ No newline at end of file diff --git a/marked/Rel-16/55_series/55919/raw.md b/marked/Rel-16/55_series/55919/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..36d82a8b88395746cf5394e117420297af6968c4 --- /dev/null +++ b/marked/Rel-16/55_series/55919/raw.md @@ -0,0 +1,109 @@ + + + + + + +# --- Contents + +| | | +|-----------------------------------------------|---| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 Technical provisions ..... | 6 | +| Annex B: Change history..... | 7 | + +# --- Foreword + +This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +This Report has been produced by ETSI SAGE Task Force for the design of the GSM A5/3 and GEA3 encryption algorithms. + +The work described in this report was undertaken in response to a request made by Security Group GSM Association. The work was done under supervision of the ETSI Mobile Competence Centre (MCC) and the GSM Association. + +# --- 1 Scope + +This Technical Report has been prepared by the ETSI SAGE GSM A5/3 Task Force, and gives a detailed report on the design and evaluation of the A5/3 encryption algorithms for GSM and ECSD, and of the GEA3 encryption algorithm for GPRS (including EGPRS). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] Void +- [2] Void +- [3] Void +- [4] Void +- [5] Void +- [6] Void +- [7] Void +- [8] Void +- [9] Void +- [10] Void +- [11] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [12] 3GPP Task Force Report: "Specification of the A5/3 encryption algorithms for GSM and ECSD, and the GEA3 encryption algorithm for GPRS; Document 4: Design and evaluation report". + +Note: Reference [2] is available via <http://portal.etsi.org/dvbandca/home.asp> and is subject to licensing conditions described at this site. + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [11] and in the 3GPP Task Force Report [12] apply. A term defined in the latter document takes precedence over the definition of the same term, if any, in TR 21.905 [11]. + +## 3.2 Symbols + +For the purposes of the present document, the symbols defined in the 3GPP Task Force Report [12] apply. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [11] and in the 3GPP Task Force Report [12] apply. An abbreviation defined in the latter document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [11]. + +# --- 4 Technical provisions + +The technical provisions of the current document are contained in the 3GPP Task Force Report [2]. + +# Annex B: Change history + +| Change history | | | | | | | | +|-------------------------------------------------------------------------------|-------|-----------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2002-05 | - | - | - | - | ETSI SAGE first publication | | SAGE V1.0 | +| 2002-07 | - | - | - | - | Agreed at SA WG3 #24 for presentation to TSG SA #17 for approval. Converted into 3GPP TR format (TR 55.919) (Technically equivalent to SAGE V1.0) | SAGE V1.0 | 1.0.0 | +| 2002-09 | SP-17 | SP-020506 | - | - | Approved for Release 6 - version 6.0.0 | 1.0.0 | 6.0.0 | +| 2002-12 | SP-18 | SP-020721 | 001 | - | EGPRS algorithm | 6.0.0 | 6.1.0 | +| 2007-12 | SP-38 | SP-070776 | 002 | - | Conversion to pointer to export controlled document | 6.1.0 | 7.1.0 | +| 2008-12 | SP-42 | - | - | - | Upgrade to Release 8 | 7.1.0 | 8.0.0 | +| 2009-12 | SP-46 | - | - | - | Upgrade to Release 9 | 8.0.0 | 9.0.0 | +| Note: Version 7.0.0 is a "readme" file placeholder with no technical content. | | | | | | | | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 10.0.0 | <b>11.0.0</b> | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | <b>12.0.0</b> | +| 2017-03 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | <b>13.0.0</b> | +| 2017-03 | SA#75 | - | - | - | Promotion to Release 14 without technical change | 13.0.0 | <b>14.0.0</b> | +| 2018-06 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | <b>15.0.0</b> | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | <b>16.0.0</b> | \ No newline at end of file